diff --git a/azps-10.1.0/Az.ADDomainServices/Az.ADDomainServices.md b/azps-10.1.0/Az.ADDomainServices/Az.ADDomainServices.md new file mode 100644 index 0000000000..81d0051e33 --- /dev/null +++ b/azps-10.1.0/Az.ADDomainServices/Az.ADDomainServices.md @@ -0,0 +1,35 @@ +--- +Module Name: Az.ADDomainServices +Module Guid: bba49006-4c09-406e-8fad-dd48d1b381e7 +Download Help Link: https://learn.microsoft.com/powershell/module/az.addomainservices +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/Az.ADDomainServices.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/Az.ADDomainServices.md +--- + +# Az.ADDomainServices Module +## Description +Microsoft Azure PowerShell: AdDomainServices cmdlets + +## Az.ADDomainServices Cmdlets +### [Get-AzADDomainService](Get-AzADDomainService.md) +The Get Domain Service operation retrieves a json representation of the Domain Service. + +### [New-AzADDomainService](New-AzADDomainService.md) +The Create Domain Service operation creates a new domain service with the specified parameters. +If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged. + +### [New-AzADDomainServiceForestTrustObject](New-AzADDomainServiceForestTrustObject.md) +Create an in-memory object for ForestTrust. + +### [New-AzADDomainServiceReplicaSetObject](New-AzADDomainServiceReplicaSetObject.md) +Create an in-memory object for ReplicaSet. + +### [Remove-AzADDomainService](Remove-AzADDomainService.md) +The Delete Domain Service operation deletes an existing Domain Service. + +### [Update-AzADDomainService](Update-AzADDomainService.md) +The Update Domain Service operation can be used to update the existing deployment. +The update call only supports the properties listed in the PATCH body. + diff --git a/azps-10.1.0/Az.ADDomainServices/Get-AzADDomainService.md b/azps-10.1.0/Az.ADDomainServices/Get-AzADDomainService.md new file mode 100644 index 0000000000..84a04bf5c5 --- /dev/null +++ b/azps-10.1.0/Az.ADDomainServices/Get-AzADDomainService.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.ADDomainServices +online version: https://learn.microsoft.com/powershell/module/az.addomainservices/get-azaddomainservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/Get-AzADDomainService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/Get-AzADDomainService.md +--- + +# Get-AzADDomainService + +## SYNOPSIS +The Get Domain Service operation retrieves a json representation of the Domain Service. + +## SYNTAX + +### List (Default) +``` +Get-AzADDomainService [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzADDomainService -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzADDomainService -InputObject [-DefaultProfile ] + [] +``` + +### List1 +``` +Get-AzADDomainService -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The Get Domain Service operation retrieves a json representation of the Domain Service. + +## EXAMPLES + +### Example 1: Get All ADDomainService By default +```powershell +Get-AzADDomainService +``` + +```output +Name Domain Name Location Sku +---- ----------- -------- --- +youriADdomain youriAddomain.com westus Enterprise +``` + +Get All ADDomainService By default + +### Example 2: Get ADDomainService By ResourceGroup and name +```powershell +Get-AzADDomainService -Name youriADdomain -ResourceGroupName youriADdomain +``` + +```output +Name Domain Name Location Sku +---- ----------- -------- --- +youriADdomain youriAddomain.com westus Enterprise +``` + +Get ADDomainService By ResourceGroup and name + +### Example 3: Get all ADDomainService By ResourceGroup +```powershell +Get-AzADDomainService -ResourceGroupName youriADdomain +``` + +```output +Name Domain Name Location Sku +---- ----------- -------- --- +youriADdomain youriAddomain.com westus Enterprise +``` + +Get all ADDomainService By ResourceGroup + +### Example 4: Get ADDomainService By InputObject +```powershell +$getAzAddomain = Get-AzADDomainService -Name youriADdomain -ResourceGroupName youriADdomain +Get-AzADDomainService -InputObject $getAzAddomain +``` + +```output +Name Domain Name Location Sku +---- ----------- -------- --- +youriADdomain youriAddomain.com westus Enterprise +``` + +Get ADDomainService By InputObject + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.IAdDomainServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the domain service. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DomainServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group within the user's subscription. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.IAdDomainServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.Api202001.IDomainService + +## 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 + - `[DomainServiceName ]`: The name of the domain service. + - `[Id ]`: Resource identity path + - `[ResourceGroupName ]`: The name of the resource group within the user's subscription. The name is case insensitive. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ADDomainServices/New-AzADDomainService.md b/azps-10.1.0/Az.ADDomainServices/New-AzADDomainService.md new file mode 100644 index 0000000000..4e4357dc5b --- /dev/null +++ b/azps-10.1.0/Az.ADDomainServices/New-AzADDomainService.md @@ -0,0 +1,560 @@ +--- +external help file: +Module Name: Az.ADDomainServices +online version: https://learn.microsoft.com/powershell/module/az.addomainservices/new-azaddomainservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/New-AzADDomainService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/New-AzADDomainService.md +--- + +# New-AzADDomainService + +## SYNOPSIS +The Create Domain Service operation creates a new domain service with the specified parameters. +If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged. + +## SYNTAX + +``` +New-AzADDomainService -Name -ResourceGroupName -DomainName + -ReplicaSet [-SubscriptionId ] [-DomainConfigurationType ] + [-DomainSecuritySettingNtlmV1 ] [-DomainSecuritySettingSyncKerberosPassword ] + [-DomainSecuritySettingSyncNtlmPassword ] + [-DomainSecuritySettingSyncOnPremPassword ] [-DomainSecuritySettingTlsV1 ] + [-Etag ] [-FilteredSync ] [-ForestTrust ] + [-LdapSettingExternalAccess ] [-LdapSettingLdaps ] + [-LdapSettingPfxCertificateInputFile ] [-LdapSettingPfxCertificatePassword ] + [-Location ] [-NotificationSettingAdditionalRecipient ] + [-NotificationSettingNotifyDcAdmin ] + [-NotificationSettingNotifyGlobalAdmin ] [-ResourceForest ] [-Sku ] + [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The Create Domain Service operation creates a new domain service with the specified parameters. +If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged. + +## EXAMPLES + +### Example 1: Create a new ADDomainService +```powershell +$replicaSet = New-AzADDomainServiceReplicaSetObject -Location westus -SubnetId /subscriptions/********-****-****-****-**********/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default +New-AzADDomainService -Name youriADdomain -ResourceGroupName youriAddomain -DomainName youriAddomain.com -ReplicaSet $replicaSet +``` + +```output +Name Domain Name Location Sku +---- ----------- -------- --- +youriADdomain youriAddomain.com westus Enterprise +``` + +Create a new ADDomainService + +### Example 2: Create new ADDomainService with certificate +```powershell +# Variables +$replicaSet = New-AzADDomainServiceReplicaSet -Location westus -SubnetId /subscriptions/********-****-****-****-**********/resourceGroups/yishitest/providers/Microsoft.Network/virtualNetworks/aadds-vnet/subnets/default\ +$certificateBytes = Get-Content "certificate.pfx" -AsByteStream +$base64String = [System.Convert]::ToBase64String($certificateBytes) +$ldaps_pfx_pass = "MyStrongPassword" + +New-AzADDomainService -Name youriADdomain -ResourceGroupName youriAddomain -DomainName youriAddomain.com -ReplicaSet $replicaSet -LdapSettingLdaps Enabled -LdapSettingPfxCertificate $base64String -LdapSettingPfxCertificatePassword $($ldaps_pfx_pass | ConvertTo-SecureString -Force -AsPlainText) +``` + +```output +Name Domain Name Location Sku +---- ----------- -------- --- +youriADdomain youriAddomain.com westus Enterprise +``` + +Create new ADDomainService with certificate + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainConfigurationType +Domain Configuration Type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +The name of the Azure domain that the user would like to deploy Domain Services to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainSecuritySettingNtlmV1 +A flag to determine whether or not NtlmV1 is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.NtlmV1 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainSecuritySettingSyncKerberosPassword +A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.SyncKerberosPasswords +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainSecuritySettingSyncNtlmPassword +A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.SyncNtlmPasswords +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainSecuritySettingSyncOnPremPassword +A flag to determine whether or not SyncOnPremPasswords is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.SyncOnPremPasswords +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainSecuritySettingTlsV1 +A flag to determine whether or not TlsV1 is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.TlsV1 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Resource etag + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilteredSync +Enabled or Disabled flag to turn on Group-based filtered sync + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.FilteredSync +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForestTrust +List of settings for Resource Forest +To construct, see NOTES section for FORESTTRUST properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.Api202001.IForestTrust[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapSettingExternalAccess +A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.ExternalAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapSettingLdaps +A flag to determine whether or not Secure LDAP is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.Ldaps +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapSettingPfxCertificateInputFile +Input File for LdapSettingPfxCertificate (The certificate required to configure Secure LDAP. +The parameter passed here should be a base64encoded representation of the certificate pfx file.) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapSettingPfxCertificatePassword +The password to decrypt the provided Secure LDAP certificate pfx file. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $ReplicaSet[0].Location +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the domain service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DomainServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSettingAdditionalRecipient +The list of additional recipients + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSettingNotifyDcAdmin +Should domain controller admins be notified + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.NotifyDcAdmins +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSettingNotifyGlobalAdmin +Should global admins be notified + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.NotifyGlobalAdmins +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaSet +List of ReplicaSets +To construct, see NOTES section for REPLICASET properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.Api202001.IReplicaSet[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceForest +Resource Forest + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group within the user's subscription. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +Sku Type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.Api202001.IDomainService + +## 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. + + +FORESTTRUST : List of settings for Resource Forest + - `[FriendlyName ]`: Friendly Name + - `[RemoteDnsIP ]`: Remote Dns ips + - `[TrustDirection ]`: Trust Direction + - `[TrustPassword ]`: Trust Password + - `[TrustedDomainFqdn ]`: Trusted Domain FQDN + +REPLICASET : List of ReplicaSets + - `[Location ]`: Virtual network location + - `[SubnetId ]`: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ADDomainServices/New-AzADDomainServiceForestTrustObject.md b/azps-10.1.0/Az.ADDomainServices/New-AzADDomainServiceForestTrustObject.md new file mode 100644 index 0000000000..f5d5bd7bd4 --- /dev/null +++ b/azps-10.1.0/Az.ADDomainServices/New-AzADDomainServiceForestTrustObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.ADDomainServices +online version: https://learn.microsoft.com/powershell/module/az.addomainservices/new-azaddomainserviceforesttrustobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/New-AzADDomainServiceForestTrustObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/New-AzADDomainServiceForestTrustObject.md +--- + +# New-AzADDomainServiceForestTrustObject + +## SYNOPSIS +Create an in-memory object for ForestTrust. + +## SYNTAX + +``` +New-AzADDomainServiceForestTrustObject [-FriendlyName ] [-RemoteDnsIP ] + [-TrustDirection ] [-TrustedDomainFqdn ] [-TrustPassword ] [] +``` + +## DESCRIPTION +Create an in-memory object for ForestTrust. + +## EXAMPLES + +### Example 1: Create ServiceForestTrust for ADDomain +```powershell +New-AzADDomainServiceForestTrustObject -FriendlyName FriendlyNameTest +``` + +```output +FriendlyName RemoteDnsIP TrustDirection TrustPassword TrustedDomainFqdn +------------ ----------- -------------- ------------- ----------------- +FriendlyNameTest +``` + +Create an in-memory object for ForestTrust. +This object can be used to create or update a domain service. + +## PARAMETERS + +### -FriendlyName +Friendly Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteDnsIP +Remote Dns ips. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustDirection +Trust Direction. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedDomainFqdn +Trusted Domain FQDN. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustPassword +Trust Password. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.Api202001.ForestTrust + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ADDomainServices/New-AzADDomainServiceReplicaSetObject.md b/azps-10.1.0/Az.ADDomainServices/New-AzADDomainServiceReplicaSetObject.md new file mode 100644 index 0000000000..9b21e63739 --- /dev/null +++ b/azps-10.1.0/Az.ADDomainServices/New-AzADDomainServiceReplicaSetObject.md @@ -0,0 +1,88 @@ +--- +external help file: +Module Name: Az.ADDomainServices +online version: https://learn.microsoft.com/powershell/module/az.addomainservices/new-azaddomainservicereplicasetobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/New-AzADDomainServiceReplicaSetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/New-AzADDomainServiceReplicaSetObject.md +--- + +# New-AzADDomainServiceReplicaSetObject + +## SYNOPSIS +Create an in-memory object for ReplicaSet. + +## SYNTAX + +``` +New-AzADDomainServiceReplicaSetObject [-Location ] [-SubnetId ] [] +``` + +## DESCRIPTION +Create an in-memory object for ReplicaSet. + +## EXAMPLES + +### Example 1: Create ReplicaSet for AdDomain +```powershell +New-AzADDomainServiceReplicaSetObject -Location westus -SubnetId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vm/subnets/test-subnets +``` + +```output +DomainControllerIPAddress ExternalAccessIPAddress HealthLastEvaluated Location ServiceStatus SubnetId +------------------------- ----------------------- ------------------- -------- ------------- -------- + westus /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resource… +``` + +Create an in-memory object for ReplicaSet. +This object can be used to create or update a domain service. + +## PARAMETERS + +### -Location +Virtual network location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The name of the virtual network that Domain Services will be deployed on. +The id of the subnet that Domain Services will be deployed on. +/virtualNetwork/vnetName/subnets/subnetName. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.Api202001.ReplicaSet + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ADDomainServices/Remove-AzADDomainService.md b/azps-10.1.0/Az.ADDomainServices/Remove-AzADDomainService.md new file mode 100644 index 0000000000..7fa15731bd --- /dev/null +++ b/azps-10.1.0/Az.ADDomainServices/Remove-AzADDomainService.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.ADDomainServices +online version: https://learn.microsoft.com/powershell/module/az.addomainservices/remove-azaddomainservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/Remove-AzADDomainService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/Remove-AzADDomainService.md +--- + +# Remove-AzADDomainService + +## SYNOPSIS +The Delete Domain Service operation deletes an existing Domain Service. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzADDomainService -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzADDomainService -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The Delete Domain Service operation deletes an existing Domain Service. + +## EXAMPLES + +### Example 1: Delete the AzADDomain by ResourceGroupName and Name +```powershell +Remove-AzADDomainService -ResourceGroupName $env.ResourceGroupName -Name $env.ADdomainName +``` + +Delete the AzADDomain by ResourceGroupName and Name + +### Example 2: Delete the AzADDomain by InputObject +```powershell +$GetADDomainExample = Get-AzADDomainService -ResourceGroupName $env.ResourceGroupName -Name $env.ADdomainName +Remove-AzADDomainService -InputObject $GetADDomainExample +``` + +Delete the AzADDomain by InputObject + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.IAdDomainServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the domain service. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DomainServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group within the user's subscription. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.IAdDomainServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT ``: Identity Parameter + - `[DomainServiceName ]`: The name of the domain service. + - `[Id ]`: Resource identity path + - `[ResourceGroupName ]`: The name of the resource group within the user's subscription. The name is case insensitive. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ADDomainServices/Update-AzADDomainService.md b/azps-10.1.0/Az.ADDomainServices/Update-AzADDomainService.md new file mode 100644 index 0000000000..712da9425c --- /dev/null +++ b/azps-10.1.0/Az.ADDomainServices/Update-AzADDomainService.md @@ -0,0 +1,597 @@ +--- +external help file: +Module Name: Az.ADDomainServices +online version: https://learn.microsoft.com/powershell/module/az.addomainservices/update-azaddomainservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/Update-AzADDomainService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/Update-AzADDomainService.md +--- + +# Update-AzADDomainService + +## SYNOPSIS +The Update Domain Service operation can be used to update the existing deployment. +The update call only supports the properties listed in the PATCH body. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzADDomainService -Name -ResourceGroupName [-SubscriptionId ] + [-DomainConfigurationType ] [-DomainName ] [-DomainSecuritySettingNtlmV1 ] + [-DomainSecuritySettingSyncKerberosPassword ] + [-DomainSecuritySettingSyncNtlmPassword ] + [-DomainSecuritySettingSyncOnPremPassword ] [-DomainSecuritySettingTlsV1 ] + [-Etag ] [-FilteredSync ] [-ForestTrust ] + [-LdapSettingExternalAccess ] [-LdapSettingLdaps ] + [-LdapSettingPfxCertificateInputFile ] [-LdapSettingPfxCertificatePassword ] + [-Location ] [-NotificationSettingAdditionalRecipient ] + [-NotificationSettingNotifyDcAdmin ] + [-NotificationSettingNotifyGlobalAdmin ] [-ReplicaSet ] + [-ResourceForest ] [-Sku ] [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzADDomainService -InputObject [-DomainConfigurationType ] + [-DomainName ] [-DomainSecuritySettingNtlmV1 ] + [-DomainSecuritySettingSyncKerberosPassword ] + [-DomainSecuritySettingSyncNtlmPassword ] + [-DomainSecuritySettingSyncOnPremPassword ] [-DomainSecuritySettingTlsV1 ] + [-Etag ] [-FilteredSync ] [-ForestTrust ] + [-LdapSettingExternalAccess ] [-LdapSettingLdaps ] + [-LdapSettingPfxCertificateInputFile ] [-LdapSettingPfxCertificatePassword ] + [-Location ] [-NotificationSettingAdditionalRecipient ] + [-NotificationSettingNotifyDcAdmin ] + [-NotificationSettingNotifyGlobalAdmin ] [-ReplicaSet ] + [-ResourceForest ] [-Sku ] [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The Update Domain Service operation can be used to update the existing deployment. +The update call only supports the properties listed in the PATCH body. + +## EXAMPLES + +### Example 1: Update AzADDomainService By ResourceGroupName and Name +```powershell +Update-AzADDomainService -Name youriADdomain -ResourceGroupName youriADdomain -DomainSecuritySettingTlsV1 Disabled +``` + +```output +Name Domain Name Location Sku +---- ----------- -------- --- +youriADdomain youriAddomain.com westus Enterprise +``` + +Update AzADDomainService By ResourceGroupName and Name + +### Example 2: Update AzADDomainService By InputObject +```powershell +$getAzAddomain = Get-AzADDomainService -Name youriADdomain -ResourceGroupName youriADdomain +Update-AzADDomainService -InputObject $getAzAddomain -DomainSecuritySettingTlsV1 Disabled +``` + +```output +Name Domain Name Location Sku +---- ----------- -------- --- +youriADdomain youriAddomain.com westus Enterprise +``` + +Update AzADDomainService By InputObject + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainConfigurationType +Domain Configuration Type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +The name of the Azure domain that the user would like to deploy Domain Services to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainSecuritySettingNtlmV1 +A flag to determine whether or not NtlmV1 is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.NtlmV1 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainSecuritySettingSyncKerberosPassword +A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.SyncKerberosPasswords +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainSecuritySettingSyncNtlmPassword +A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.SyncNtlmPasswords +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainSecuritySettingSyncOnPremPassword +A flag to determine whether or not SyncOnPremPasswords is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.SyncOnPremPasswords +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainSecuritySettingTlsV1 +A flag to determine whether or not TlsV1 is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.TlsV1 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Resource etag + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilteredSync +Enabled or Disabled flag to turn on Group-based filtered sync + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.FilteredSync +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForestTrust +List of settings for Resource Forest +To construct, see NOTES section for FORESTTRUST properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.Api202001.IForestTrust[] +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.ADDomainServices.Models.IAdDomainServicesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LdapSettingExternalAccess +A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.ExternalAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapSettingLdaps +A flag to determine whether or not Secure LDAP is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.Ldaps +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapSettingPfxCertificateInputFile +Input File for LdapSettingPfxCertificate (The certificate required to configure Secure LDAP. +The parameter passed here should be a base64encoded representation of the certificate pfx file.) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapSettingPfxCertificatePassword +The password to decrypt the provided Secure LDAP certificate pfx file. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the domain service. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: DomainServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSettingAdditionalRecipient +The list of additional recipients + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSettingNotifyDcAdmin +Should domain controller admins be notified + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.NotifyDcAdmins +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSettingNotifyGlobalAdmin +Should global admins be notified + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Support.NotifyGlobalAdmins +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaSet +List of ReplicaSets +To construct, see NOTES section for REPLICASET properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.Api202001.IReplicaSet[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceForest +Resource Forest + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group within the user's subscription. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +Sku Type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.IAdDomainServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.Api202001.IDomainService + +## 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. + + +FORESTTRUST : List of settings for Resource Forest + - `[FriendlyName ]`: Friendly Name + - `[RemoteDnsIP ]`: Remote Dns ips + - `[TrustDirection ]`: Trust Direction + - `[TrustPassword ]`: Trust Password + - `[TrustedDomainFqdn ]`: Trusted Domain FQDN + +INPUTOBJECT ``: Identity Parameter + - `[DomainServiceName ]`: The name of the domain service. + - `[Id ]`: Resource identity path + - `[ResourceGroupName ]`: The name of the resource group within the user's subscription. The name is case insensitive. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +REPLICASET : List of ReplicaSets + - `[Location ]`: Virtual network location + - `[SubnetId ]`: The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Accounts/Add-AzEnvironment.md b/azps-10.1.0/Az.Accounts/Add-AzEnvironment.md new file mode 100644 index 0000000000..5717babd82 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Add-AzEnvironment.md @@ -0,0 +1,776 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/add-azenvironment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Add-AzEnvironment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Add-AzEnvironment.md +--- + +# Add-AzEnvironment + +## SYNOPSIS +Adds endpoints and metadata for an instance of Azure Resource Manager. + +## SYNTAX + +### Name (Default) +``` +Add-AzEnvironment [-Name] [[-PublishSettingsFileUrl] ] [[-ServiceEndpoint] ] + [[-ManagementPortalUrl] ] [[-StorageEndpoint] ] [[-ActiveDirectoryEndpoint] ] + [[-ResourceManagerEndpoint] ] [[-GalleryEndpoint] ] + [[-ActiveDirectoryServiceEndpointResourceId] ] [[-GraphEndpoint] ] + [[-AzureKeyVaultDnsSuffix] ] [[-AzureKeyVaultServiceEndpointResourceId] ] + [[-TrafficManagerDnsSuffix] ] [[-SqlDatabaseDnsSuffix] ] + [[-AzureDataLakeStoreFileSystemEndpointSuffix] ] + [[-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix] ] [-EnableAdfsAuthentication] + [[-AdTenant] ] [[-GraphAudience] ] [[-DataLakeAudience] ] + [[-BatchEndpointResourceId] ] [[-AzureOperationalInsightsEndpointResourceId] ] + [[-AzureOperationalInsightsEndpoint] ] [-AzureAnalysisServicesEndpointSuffix ] + [-AzureAnalysisServicesEndpointResourceId ] [-AzureAttestationServiceEndpointSuffix ] + [-AzureAttestationServiceEndpointResourceId ] [-AzureSynapseAnalyticsEndpointSuffix ] + [-ContainerRegistryEndpointSuffix ] [-AzureSynapseAnalyticsEndpointResourceId ] + [-MicrosoftGraphEndpointResourceId ] [-MicrosoftGraphUrl ] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ARMEndpoint +``` +Add-AzEnvironment [-Name] [[-StorageEndpoint] ] [-ARMEndpoint] + [[-AzureKeyVaultDnsSuffix] ] [[-AzureKeyVaultServiceEndpointResourceId] ] + [[-DataLakeAudience] ] [[-BatchEndpointResourceId] ] + [[-AzureOperationalInsightsEndpointResourceId] ] [[-AzureOperationalInsightsEndpoint] ] + [-AzureAnalysisServicesEndpointSuffix ] [-AzureAnalysisServicesEndpointResourceId ] + [-AzureAttestationServiceEndpointSuffix ] [-AzureAttestationServiceEndpointResourceId ] + [-AzureSynapseAnalyticsEndpointSuffix ] [-ContainerRegistryEndpointSuffix ] + [-AzureSynapseAnalyticsEndpointResourceId ] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### Discovery +``` +Add-AzEnvironment [-AutoDiscover] [-Uri ] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Add-AzEnvironment cmdlet adds endpoints and metadata to enable Azure Resource Manager cmdlets to connect with a new instance of Azure Resource Manager. +The built-in environments AzureCloud and AzureChinaCloud target existing public instances of Azure Resource Manager. + +## EXAMPLES + +### Example 1: Creating and modifying a new environment + +```powershell +Add-AzEnvironment -Name TestEnvironment ` + -ActiveDirectoryEndpoint TestADEndpoint ` + -ActiveDirectoryServiceEndpointResourceId TestADApplicationId ` + -ResourceManagerEndpoint TestRMEndpoint ` + -GalleryEndpoint TestGalleryEndpoint ` + -GraphEndpoint TestGraphEndpoint + +Name Resource Manager Url ActiveDirectory Authority +---- -------------------- ------------------------- +TestEnvironment TestRMEndpoint TestADEndpoint/ + +Set-AzEnvironment -Name TestEnvironment ` + -ActiveDirectoryEndpoint NewTestADEndpoint ` + -GraphEndpoint NewTestGraphEndpoint | Format-List + +Name : TestEnvironment +EnableAdfsAuthentication : False +OnPremise : False +ActiveDirectoryServiceEndpointResourceId : TestADApplicationId +AdTenant : +GalleryUrl : TestGalleryEndpoint +ManagementPortalUrl : +ServiceManagementUrl : +PublishSettingsFileUrl : +ResourceManagerUrl : TestRMEndpoint +SqlDatabaseDnsSuffix : +StorageEndpointSuffix : +ActiveDirectoryAuthority : NewTestADEndpoint +GraphUrl : NewTestGraphEndpoint +GraphEndpointResourceId : +TrafficManagerDnsSuffix : +AzureKeyVaultDnsSuffix : +DataLakeEndpointResourceId : +AzureDataLakeStoreFileSystemEndpointSuffix : +AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : +AzureKeyVaultServiceEndpointResourceId : +AzureOperationalInsightsEndpointResourceId : +AzureOperationalInsightsEndpoint : +AzureAnalysisServicesEndpointSuffix : +AzureAttestationServiceEndpointSuffix : +AzureAttestationServiceEndpointResourceId : +AzureSynapseAnalyticsEndpointSuffix : +AzureSynapseAnalyticsEndpointResourceId : +VersionProfiles : {} +ExtendedProperties : {} +BatchEndpointResourceId : +``` + +In this example we are creating a new Azure environment with sample endpoints using Add-AzEnvironment, and then we are changing the value of the ActiveDirectoryEndpoint and GraphEndpoint attributes of the created environment using the cmdlet Set-AzEnvironment. + +### Example 2: Discovering a new environment via Uri +```powershell +<# +Uri https://configuredmetadata.net returns an array of environment metadata. The following example contains a payload for the AzureCloud default environment. + +[ + { + "portal": "https://portal.azure.com", + "authentication": { + "loginEndpoint": "https://login.microsoftonline.com/", + "audiences": [ + "https://management.core.windows.net/" + ], + "tenant": "common", + "identityProvider": "AAD" + }, + "media": "https://rest.media.azure.net", + "graphAudience": "https://graph.windows.net/", + "graph": "https://graph.windows.net/", + "name": "AzureCloud", + "suffixes": { + "azureDataLakeStoreFileSystem": "azuredatalakestore.net", + "acrLoginServer": "azurecr.io", + "sqlServerHostname": ".database.windows.net", + "azureDataLakeAnalyticsCatalogAndJob": "azuredatalakeanalytics.net", + "keyVaultDns": "vault.azure.net", + "storage": "core.windows.net", + "azureFrontDoorEndpointSuffix": "azurefd.net" + }, + "batch": "https://batch.core.windows.net/", + "resourceManager": "https://management.azure.com/", + "vmImageAliasDoc": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/arm-compute/quickstart-templates/aliases.json", + "activeDirectoryDataLake": "https://datalake.azure.net/", + "sqlManagement": "https://management.core.windows.net:8443/", + "gallery": "https://gallery.azure.com/" + }, +…… +] +#> + +Add-AzEnvironment -AutoDiscover -Uri https://configuredmetadata.net +``` + +```Output +Name Resource Manager Url ActiveDirectory Authority +---- -------------------- ------------------------- +TestEnvironment TestRMEndpoint TestADEndpoint/ +``` + +In this example, we are discovering a new Azure environment from the `https://configuredmetadata.net` Uri. + +## PARAMETERS + +### -ActiveDirectoryEndpoint +Specifies the base authority for Azure Active Directory authentication. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ActiveDirectoryServiceEndpointResourceId +Specifies the audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AdTenant +Specifies the default Active Directory tenant. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 17 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ARMEndpoint +The Azure Resource Manager endpoint + +```yaml +Type: System.String +Parameter Sets: ARMEndpoint +Aliases: ArmUrl + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutoDiscover +Discovers environments via default or configured endpoint. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Discovery +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureAnalysisServicesEndpointResourceId +The resource identifier of the Azure Analysis Services resource. + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureAnalysisServicesEndpointSuffix +The endpoint to use when communicating with the Azure Log Analytics API. + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureAttestationServiceEndpointResourceId +The The resource identifier of the Azure Attestation service that is the recipient of the requested token. + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureAttestationServiceEndpointSuffix +Dns suffix of Azure Attestation service. + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix +Dns Suffix of Azure Data Lake Analytics job and catalog services + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 15 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureDataLakeStoreFileSystemEndpointSuffix +Dns Suffix of Azure Data Lake Store FileSystem. Example: azuredatalake.net + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 14 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureKeyVaultDnsSuffix +Dns suffix of Azure Key Vault service. Example is vault-int.azure-int.net + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureKeyVaultServiceEndpointResourceId +Resource identifier of Azure Key Vault data service that is the recipient of the requested token. + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureOperationalInsightsEndpoint +The endpoint to use when communicating with the Azure Log Analytics API. + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: + +Required: False +Position: 22 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureOperationalInsightsEndpointResourceId +The audience for tokens authenticating with the Azure Log Analytics API. + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: + +Required: False +Position: 21 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureSynapseAnalyticsEndpointResourceId +The The resource identifier of the Azure Synapse Analytics that is the recipient of the requested token. + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureSynapseAnalyticsEndpointSuffix +Dns suffix of Azure Synapse Analytics. + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BatchEndpointResourceId +The resource identifier of the Azure Batch service that is the recipient of the requested token + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: BatchResourceId, BatchAudience + +Required: False +Position: 20 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContainerRegistryEndpointSuffix +Suffix of Azure Container Registry. + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataLakeAudience +The audience for tokens authenticating with the AD Data Lake services Endpoint. + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: DataLakeEndpointResourceId, DataLakeResourceId + +Required: False +Position: 19 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, tenant and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAdfsAuthentication +Indicates that Active Directory Federation Services (ADFS) on-premise authentication is allowed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Name +Aliases: OnPremise + +Required: False +Position: 16 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryEndpoint +Specifies the endpoint for the Azure Resource Manager gallery of deployment templates. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: Gallery, GalleryUrl + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GraphAudience +The audience for tokens authenticating with the AD Graph Endpoint. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: GraphEndpointResourceId, GraphResourceId + +Required: False +Position: 18 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GraphEndpoint +Specifies the URL for Graph (Active Directory metadata) requests. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: Graph, GraphUrl + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagementPortalUrl +Specifies the URL for the Management Portal. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MicrosoftGraphEndpointResourceId +The resource identifier of Microsoft Graph + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MicrosoftGraphUrl +Microsoft Graph Url + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the environment to add. + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublishSettingsFileUrl +Specifies the URL from which .publishsettings files can be downloaded. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceManagerEndpoint +Specifies the URL for Azure Resource Manager requests. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: ResourceManager, ResourceManagerUrl + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceEndpoint +Specifies the endpoint for Service Management (RDFE) requests. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: ServiceManagement, ServiceManagementUrl + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlDatabaseDnsSuffix +Specifies the domain-name suffix for Azure SQL Database servers. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 13 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageEndpoint +Specifies the endpoint for storage (blob, table, queue, and file) access. + +```yaml +Type: System.String +Parameter Sets: Name, ARMEndpoint +Aliases: StorageEndpointSuffix + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerDnsSuffix +Specifies the domain-name suffix for Azure Traffic Manager services. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 12 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Uri +Specifies URI of the internet resource to fetch environments. + +```yaml +Type: System.Uri +Parameter Sets: Discovery +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSAzureEnvironment + +## NOTES + +## RELATED LINKS + +[Get-AzEnvironment](./Get-AzEnvironment.md) + +[Remove-AzEnvironment](./Remove-AzEnvironment.md) + +[Set-AzEnvironment](./Set-AzEnvironment.md) + diff --git a/azps-10.1.0/Az.Accounts/Az.Accounts.md b/azps-10.1.0/Az.Accounts/Az.Accounts.md new file mode 100644 index 0000000000..b64b487edb --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Az.Accounts.md @@ -0,0 +1,139 @@ +--- +Module Name: Az.Accounts +Module Guid: 342714fc-4009-4863-8afb-a9067e3db04b +Download Help Link: https://learn.microsoft.com/powershell/module/az.accounts +Help Version: 4.6.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Az.Accounts.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Az.Accounts.md +--- + +# Az.Accounts Module +## Description +Manages credentials and common configuration for all Azure modules. + +## Az.Accounts Cmdlets +### [Add-AzEnvironment](Add-AzEnvironment.md) +Adds endpoints and metadata for an instance of Azure Resource Manager. + +### [Clear-AzConfig](Clear-AzConfig.md) +Clears the values of configs that are set by the user. + +### [Clear-AzContext](Clear-AzContext.md) +Remove all Azure credentials, account, and subscription information. + +### [Clear-AzDefault](Clear-AzDefault.md) +Clears the defaults set by the user in the current context. + +### [Connect-AzAccount](Connect-AzAccount.md) +Connect to Azure with an authenticated account for use with cmdlets from the Az PowerShell modules. + +### [Disable-AzContextAutosave](Disable-AzContextAutosave.md) +Turn off autosaving Azure credentials. Your login information will be forgotten the next time you open a PowerShell window + +### [Disable-AzDataCollection](Disable-AzDataCollection.md) +Opts out of collecting data to improve the Azure PowerShell cmdlets. Data is collected by default +unless you explicitly opt out. + +### [Disable-AzureRmAlias](Disable-AzureRmAlias.md) +Disables AzureRm prefix aliases for Az modules. + +### [Disconnect-AzAccount](Disconnect-AzAccount.md) +Disconnects a connected Azure account and removes all credentials and contexts associated with that account. + +### [Enable-AzContextAutosave](Enable-AzContextAutosave.md) +Azure contexts are PowerShell objects representing your active subscription to run commands against, +and the authentication information needed to connect to an Azure cloud. With Azure contexts, Azure +PowerShell doesn't need to reauthenticate your account each time you switch subscriptions. For more +information, see [Azure PowerShell context objects](https://learn.microsoft.com/powershell/azure/context-persistence). + +This cmdlet allows the Azure context information to be saved and automatically loaded when you start +a PowerShell process. For example, when opening a new window. + +### [Enable-AzDataCollection](Enable-AzDataCollection.md) +Enables Azure PowerShell to collect data to improve the user experience with the Azure PowerShell +cmdlets. Executing this cmdlet opts in to data collection for the current user on the current +machine. Data is collected by default unless you explicitly opt out. + +### [Enable-AzureRmAlias](Enable-AzureRmAlias.md) +Enables AzureRm prefix aliases for Az modules. + +### [Export-AzConfig](Export-AzConfig.md) +Exports all the configs into a file so that it can be imported on another machine. + +### [Get-AzAccessToken](Get-AzAccessToken.md) +Get raw access token. When using -ResourceUrl, please make sure the value does match current Azure environment. You may refer to the value of `(Get-AzContext).Environment`. + +### [Get-AzConfig](Get-AzConfig.md) +Gets the configs of Azure PowerShell. + +### [Get-AzContext](Get-AzContext.md) +Gets the metadata used to authenticate Azure Resource Manager requests. + +### [Get-AzContextAutosaveSetting](Get-AzContextAutosaveSetting.md) +Display metadata about the context autosave feature, including whether the context is +automatically saved, and where saved context and credential information can be found. + +### [Get-AzDefault](Get-AzDefault.md) +Get the defaults set by the user in the current context. + +### [Get-AzEnvironment](Get-AzEnvironment.md) +Get endpoints and metadata for an instance of Azure services. + +### [Get-AzSubscription](Get-AzSubscription.md) +Get subscriptions that the current account can access. + +### [Get-AzTenant](Get-AzTenant.md) +Gets tenants that are authorized for the current user. + +### [Import-AzConfig](Import-AzConfig.md) +Imports configs from a file that was previously exported by `Export-AzConfig`. + +### [Import-AzContext](Import-AzContext.md) +Loads Azure authentication information from a file. + +### [Invoke-AzRestMethod](Invoke-AzRestMethod.md) +Construct and perform HTTP request to Azure resource management endpoint only + +### [Open-AzSurveyLink](Open-AzSurveyLink.md) +Open survey link in default browser. + +### [Register-AzModule](Register-AzModule.md) +FOR INTERNAL USE ONLY - Provide Runtime Support for AutoRest Generated cmdlets + +### [Remove-AzContext](Remove-AzContext.md) +Remove a context from the set of available contexts + +### [Remove-AzEnvironment](Remove-AzEnvironment.md) +Removes endpoints and metadata for connecting to a given Azure instance. + +### [Rename-AzContext](Rename-AzContext.md) +Rename an Azure context. By default contexts are named by user account and subscription. + +### [Resolve-AzError](Resolve-AzError.md) +Display detailed information about PowerShell errors, with extended details for Azure PowerShell errors. + +### [Save-AzContext](Save-AzContext.md) +Saves the current authentication information for use in other PowerShell sessions. + +### [Select-AzContext](Select-AzContext.md) +Select a subscription and account to target in Azure PowerShell cmdlets + +### [Send-Feedback](Send-Feedback.md) +Sends feedback to the Azure PowerShell team via a set of guided prompts. + +### [Set-AzContext](Set-AzContext.md) +Sets the tenant, subscription, and environment for cmdlets to use in the current session. + +### [Set-AzDefault](Set-AzDefault.md) +Sets a default in the current context + +### [Set-AzEnvironment](Set-AzEnvironment.md) +Sets properties for an Azure environment. + +### [Uninstall-AzureRm](Uninstall-AzureRm.md) +Removes all AzureRm modules from a machine. + +### [Update-AzConfig](Update-AzConfig.md) +Updates the configs of Azure PowerShell. + diff --git a/azps-10.1.0/Az.Accounts/Clear-AzConfig.md b/azps-10.1.0/Az.Accounts/Clear-AzConfig.md new file mode 100644 index 0000000000..7fb6e1fa27 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Clear-AzConfig.md @@ -0,0 +1,260 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/clear-azconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Clear-AzConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Clear-AzConfig.md +--- + +# Clear-AzConfig + +## SYNOPSIS +Clears the values of configs that are set by the user. + +## SYNTAX + +### ClearAll (Default) +``` +Clear-AzConfig [-Force] [-PassThru] [-AppliesTo ] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ClearByKey +``` +Clear-AzConfig [-PassThru] [-AppliesTo ] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-DefaultSubscriptionForLogin] + [-DisplayBreakingChangeWarning] [-DisplaySurveyMessage] [-EnableDataCollection] [-EnableLoginByWam] + [] +``` + +## DESCRIPTION +Clears the values of configs that are set by the user. By default all the configs will be cleared. You can also specify keys of configs to clear. + +## EXAMPLES + +### Example 1 +```powershell +Clear-AzConfig -Force +``` + +Clear all the configs. `-Force` suppresses the prompt for confirmation. + +### Example 2 +```powershell +Clear-AzConfig -EnableDataCollection +``` + +Clear the "EnableDataCollection" config. + +## PARAMETERS + +### -AppliesTo +Specifies what part of Azure PowerShell the config applies to. +Possible values are: +- "Az": the config applies to all modules and cmdlets of Azure PowerShell. +- Module name: the config applies to a certain module of Azure PowerShell. +For example, "Az.Storage". +- Cmdlet name: the config applies to a certain cmdlet of Azure PowerShell. +For example, "Get-AzKeyVault". +If not specified, when getting or clearing configs, it defaults to all the above; when updating, it defaults to "Az". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSubscriptionForLogin +Subscription name or GUID. +Sets the default context for Azure PowerShell when logging in without specifying a subscription. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ClearByKey +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayBreakingChangeWarning +Controls if warning messages for breaking changes are displayed or suppressed. When enabled, a breaking change warning is displayed when executing cmdlets with breaking changes in a future release. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ClearByKey +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplaySurveyMessage +When enabled, you are prompted infrequently to participate in user experience surveys for Azure PowerShell. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ClearByKey +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDataCollection +When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experience. +For more information, see our privacy statement: https://aka.ms/privacy + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ClearByKey +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLoginByWam +\[Preview\] When enabled, Web Account Manager (WAM) will be the default interactive login experience. +It will fall back to using the browser if the platform does not support WAM. +Note that this feature is under preview. Microsoft Account (MSA) is currently not supported. +Feel free to reach out to Azure PowerShell team if you have any feedbacks: https://aka.ms/azpsissue + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ClearByKey +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation when clearing all configs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ClearAll +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true if cmdlet executes correctly. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of config changes, for example, whether changes apply only to the current process, or to all sessions started by this user. +By default it is CurrentUser. + +```yaml +Type: Microsoft.Azure.PowerShell.Common.Config.ConfigScope +Parameter Sets: (All) +Aliases: +Accepted values: CurrentUser, Process, Default, Environment + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Clear-AzContext.md b/azps-10.1.0/Az.Accounts/Clear-AzContext.md new file mode 100644 index 0000000000..bd726e85b2 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Clear-AzContext.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/clear-azcontext +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Clear-AzContext.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Clear-AzContext.md +--- + +# Clear-AzContext + +## SYNOPSIS +Remove all Azure credentials, account, and subscription information. + +## SYNTAX + +``` +Clear-AzContext [-PassThru] [-Force] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Remove all Azure Credentials, account, and subscription information. + +## EXAMPLES + +### Example 1: Clear global context +```powershell +Clear-AzContext -Scope CurrentUser +``` + +Remove all account, subscription, and credential information for any powershell session. + +## PARAMETERS + +### -DefaultProfile +The credentials, tenant and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Delete all users and groups from the global scope without prompting + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return a value indicating success or failure + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Clear the context only for the current PowerShell session, or for all sessions. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Clear-AzDefault.md b/azps-10.1.0/Az.Accounts/Clear-AzDefault.md new file mode 100644 index 0000000000..73bec1acaf --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Clear-AzDefault.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/clear-azdefault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Clear-AzDefault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Clear-AzDefault.md +--- + +# Clear-AzDefault + +## SYNOPSIS +Clears the defaults set by the user in the current context. + +## SYNTAX + +``` +Clear-AzDefault [-ResourceGroup] [-PassThru] [-Force] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Clear-AzDefault cmdlet removes the defaults set by +the user depending on the switch parameters specified by the user. + +## EXAMPLES + +### Example 1 +```powershell +Clear-AzDefault +``` + +This command removes all the defaults set by the user in the current context. + +### Example 2 +```powershell +Clear-AzDefault -ResourceGroup +``` + +This command removes the default resource group set by the user in the current context. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove all defaults if no default is specified + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +Clear Default Resource Group + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Connect-AzAccount.md b/azps-10.1.0/Az.Accounts/Connect-AzAccount.md new file mode 100644 index 0000000000..ac911f7003 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Connect-AzAccount.md @@ -0,0 +1,786 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/connect-azaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Connect-AzAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Connect-AzAccount.md +--- + +# Connect-AzAccount + +## SYNOPSIS +Connect to Azure with an authenticated account for use with cmdlets from the Az PowerShell modules. + +## SYNTAX + +### UserWithSubscriptionId (Default) +``` +Connect-AzAccount [-Environment ] [-Tenant ] [-AccountId ] [-Subscription ] + [-AuthScope ] [-ContextName ] [-SkipContextPopulation] [-MaxContextPopulation ] + [-UseDeviceAuthentication] [-Force] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ServicePrincipalWithSubscriptionId +``` +Connect-AzAccount [-Environment ] -Credential [-ServicePrincipal] -Tenant + [-Subscription ] [-AuthScope ] [-ContextName ] [-SkipContextPopulation] + [-MaxContextPopulation ] [-Force] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### UserWithCredential +``` +Connect-AzAccount [-Environment ] -Credential [-Tenant ] + [-Subscription ] [-AuthScope ] [-ContextName ] [-SkipContextPopulation] + [-MaxContextPopulation ] [-Force] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ServicePrincipalCertificateWithSubscriptionId +``` +Connect-AzAccount [-Environment ] -CertificateThumbprint -ApplicationId + [-ServicePrincipal] -Tenant [-Subscription ] [-AuthScope ] [-ContextName ] + [-SkipContextPopulation] [-MaxContextPopulation ] [-Force] [-SendCertificateChain] + [-Scope ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### ClientAssertionParameterSet +``` +Connect-AzAccount [-Environment ] -ApplicationId [-ServicePrincipal] -Tenant + [-Subscription ] [-ContextName ] [-SkipContextPopulation] [-MaxContextPopulation ] + [-Force] -FederatedToken [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ServicePrincipalCertificateFileWithSubscriptionId +``` +Connect-AzAccount [-Environment ] -ApplicationId [-ServicePrincipal] -Tenant + [-Subscription ] [-ContextName ] [-SkipContextPopulation] [-MaxContextPopulation ] + [-Force] [-SendCertificateChain] -CertificatePath [-CertificatePassword ] + [-Scope ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### AccessTokenWithSubscriptionId +``` +Connect-AzAccount [-Environment ] [-Tenant ] -AccessToken [-GraphAccessToken ] + [-MicrosoftGraphAccessToken ] [-KeyVaultAccessToken ] -AccountId + [-Subscription ] [-ContextName ] [-SkipValidation] [-SkipContextPopulation] + [-MaxContextPopulation ] [-Force] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ManagedServiceLogin +``` +Connect-AzAccount [-Environment ] [-Tenant ] [-AccountId ] [-Identity] + [-Subscription ] [-AuthScope ] [-ContextName ] [-SkipContextPopulation] + [-MaxContextPopulation ] [-Force] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The `Connect-AzAccount` cmdlet connects to Azure with an authenticated account for use with cmdlets +from the Az PowerShell modules. You can use this authenticated account only with Azure Resource +Manager requests. To add an authenticated account for use with Service Management, use the +`Add-AzureAccount` cmdlet from the Azure PowerShell module. If no context is found for the current +user, the user's context list is populated with a context for each of their first 25 subscriptions. +The list of contexts created for the user can be found by running `Get-AzContext -ListAvailable`. To +skip this context population, specify the **SkipContextPopulation** switch parameter. After +executing this cmdlet, you can disconnect from an Azure account using `Disconnect-AzAccount`. + +## EXAMPLES + +### Example 1: Connect to an Azure account + +This example connects to an Azure account. You must provide a Microsoft account or organizational ID +credentials. If multi-factor authentication is enabled for your credentials, you must log in using +the interactive option or use service principal authentication. + +```powershell +Connect-AzAccount +``` + +```Output +Account SubscriptionName TenantId Environment +------- ---------------- -------- ----------- +azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud +``` + +### Example 2: Connect to Azure using organizational ID credentials + +This scenario works only when the user does not have multi-factor auth turned on. The first command +prompts for user credentials and stores them in the `$Credential` variable. The second command +connects to an Azure account using the credentials stored in `$Credential`. This account +authenticates with Azure using organizational ID credentials. + +```powershell +$Credential = Get-Credential +Connect-AzAccount -Credential $Credential +``` + +```Output +Account SubscriptionName TenantId Environment +------- ---------------- -------- ----------- +azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud +``` + +### Example 3: Connect to Azure using a service principal account + +The first command stores the service principal credentials in the `$Credential` variable. The second +command connects the specified Azure tenant using the service principal credentials stored in the +`$Credential` variable. The **ServicePrincipal** switch parameter indicates that the account +authenticates as a service principal. + +```powershell +$SecurePassword = ConvertTo-SecureString -String "Password123!" -AsPlainText -Force +$TenantId = 'yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy' +$ApplicationId = 'zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzz' +$Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $ApplicationId, $SecuredPassword +Connect-AzAccount -ServicePrincipal -TenantId $TenantId -Credential $Credential +``` + +```Output +Account SubscriptionName TenantId Environment +------- ---------------- -------- ----------- +xxxx-xxxx-xxxx-xxxx Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud +``` + +### Example 4: Use an interactive login to connect to a specific tenant and subscription + +This example connects to an Azure account with the specified tenant and subscription. + +```powershell +Connect-AzAccount -Tenant 'xxxx-xxxx-xxxx-xxxx' -SubscriptionId 'yyyy-yyyy-yyyy-yyyy' +``` + +```Output +Account SubscriptionName TenantId Environment +------- ---------------- -------- ----------- +azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud +``` + +### Example 5: Connect using a Managed Service Identity + +This example connects using the Managed Service Identity (MSI) of the host environment. For example, +you sign into Azure from a virtual machine that has an assigned MSI. + +```powershell +Connect-AzAccount -Identity +Set-AzContext -Subscription Subscription1 +``` + +```Output +Account SubscriptionName TenantId Environment +------- ---------------- -------- ----------- +MSI@50342 Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud +``` + +### Example 6: Connect using Managed Service Identity login and ClientId + +This example connects using the Managed Service Identity of **myUserAssignedIdentity**. It adds the +user assigned identity to the virtual machine, then connects using the ClientId of the user assigned +identity. For more information, see +[Configure managed identities for Azure resources on an Azure VM](/azure/active-directory/managed-identities-azure-resources/qs-configure-powershell-windows-vm). + +```powershell +$identity = Get-AzUserAssignedIdentity -ResourceGroupName 'myResourceGroup' -Name 'myUserAssignedIdentity' +Get-AzVM -ResourceGroupName contoso -Name testvm | Update-AzVM -IdentityType UserAssigned -IdentityId $identity.Id +Connect-AzAccount -Identity -AccountId $identity.ClientId # Run on the virtual machine +``` + +```Output +Account SubscriptionName TenantId Environment +------- ---------------- -------- ----------- +yyyy-yyyy-yyyy-yyyy Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud +``` + +### Example 7: Connect using certificates + +This example connects to an Azure account using certificate-based service principal authentication. +The service principal used for authentication must be created with the specified certificate. For +more information on creating a self-signed certificates and assigning them permissions, see +[Use Azure PowerShell to create a service principal with a certificate](/azure/active-directory/develop/howto-authenticate-service-principal-powershell) + +```powershell +$Thumbprint = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' +$TenantId = 'yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy' +$ApplicationId = '00000000-0000-0000-0000-00000000' +Connect-AzAccount -CertificateThumbprint $Thumbprint -ApplicationId $ApplicationId -Tenant $TenantId -ServicePrincipal +``` + +```Output +Account SubscriptionName TenantId Environment +------- ---------------- -------- ----------- +xxxxxxxx-xxxx-xxxx-xxxxxxxxx Subscription1 yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy AzureCloud + +Account : xxxxxxxx-xxxx-xxxx-xxxxxxxx +SubscriptionName : MyTestSubscription +SubscriptionId : zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzz +TenantId : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy +Environment : AzureCloud +``` + +### Example 8: Connect with AuthScope +AuthScope is used to support scenario that data plane resources have enhanced authentication than ARM resources, e.g. storage needs MFA but ARM does not. +Once AuthScope is specified, e.g. Storage, Connect-AzAccount will first login with storage scope `https://storage.azure.com/`, then silently require token for ARM. + +```powershell +Connect-AzAccount -AuthScope Storage +``` + +```Output +Account SubscriptionName TenantId Environment +------- ---------------- -------- ----------- +yyyy-yyyy-yyyy-yyyy Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud +``` + +### Example 9: Connect using certificate file + +This example connects to an Azure account using certificate-based service principal authentication. +The certificate file, which is specified by `CertficatePath`, should contains both certificate and private key as the input. + +```powershell +$SecurePassword = ConvertTo-SecureString -String "Password123!" -AsPlainText -Force +$TenantId = 'yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy' +$ApplicationId = 'zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzz' +Connect-AzAccount -ServicePrincipal -ApplicationId $ApplicationId -TenantId $TenantId -CertificatePath './certificatefortest.pfx' -CertificatePassword $securePassword +``` + +```Output +Account SubscriptionName TenantId Environment +------- ---------------- -------- ----------- +xxxxxxxx-xxxx-xxxx-xxxxxxxx Subscription1 yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy AzureCloud +``` + +### Example 10: Connect interactively using WAM + +This example demonstrates how to enable the config for WAM (Web Account Manager) and use it to connect to Azure. + +```powershell +Update-AzConfig -EnableLoginByWam $true +Connect-AzAccount +``` + +```Output +Account SubscriptionName TenantId Environment +------- ---------------- -------- ----------- +xxxxxxxx-xxxx-xxxx-xxxxxxxx Subscription1 yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy AzureCloud +``` + +## PARAMETERS + +### -AccessToken + +Specifies an access token. + +> [!CAUTION] +> Access tokens are a type of credential. You should take the appropriate security precautions to +> keep them confidential. Access tokens also timeout and may prevent long running tasks from +> completing. + +```yaml +Type: System.String +Parameter Sets: AccessTokenWithSubscriptionId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountId + +Account Id / User Id / User Name to login with in **Default (UserWithSubscriptionId)** parameter set; Account ID for access token in **AccessToken** parameter set; Account ID for managed service in +**ManagedService** parameter set. Can be a managed service resource ID, or the associated client ID. +To use the system assigned identity, leave this field blank. + +```yaml +Type: System.String +Parameter Sets: UserWithSubscriptionId, ManagedServiceLogin +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: AccessTokenWithSubscriptionId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId + +Application ID of the service principal. + +```yaml +Type: System.String +Parameter Sets: ServicePrincipalCertificateWithSubscriptionId, ClientAssertionParameterSet, ServicePrincipalCertificateFileWithSubscriptionId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthScope +Optional OAuth scope for login, supported pre-defined values: AadGraph, AnalysisServices, Attestation, Batch, DataLake, KeyVault, OperationalInsights, Storage, Synapse. It also supports resource id like `https://storage.azure.com/`. + +```yaml +Type: System.String +Parameter Sets: UserWithSubscriptionId, ServicePrincipalWithSubscriptionId, UserWithCredential, ServicePrincipalCertificateWithSubscriptionId, ManagedServiceLogin +Aliases: AuthScopeTypeName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificatePassword +The password required to access the pkcs#12 certificate file. + +```yaml +Type: System.Security.SecureString +Parameter Sets: ServicePrincipalCertificateFileWithSubscriptionId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificatePath +The path of certficate file in pkcs#12 format. + +```yaml +Type: System.String +Parameter Sets: ServicePrincipalCertificateFileWithSubscriptionId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateThumbprint + +Certificate Hash or Thumbprint. + +```yaml +Type: System.String +Parameter Sets: ServicePrincipalCertificateWithSubscriptionId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContextName + +Name of the default Azure context for this login. For more information about Azure contexts, see +[Azure PowerShell context objects](/powershell/azure/context-persistence). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies a **PSCredential** object. For more information about the **PSCredential** object, type +`Get-Help Get-Credential`. The **PSCredential** object provides the user ID and password for +organizational ID credentials, or the application ID and secret for service principal credentials. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: ServicePrincipalWithSubscriptionId, UserWithCredential +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Environment + +Environment containing the Azure account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: EnvironmentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedToken +Specifies a token provided by another identity provider. The issuer and subject in this token must be first configured to be trusted by the ApplicationId. + +> [!CAUTION] +> Federated tokens are a type of credential. You should take the appropriate security precautions to keep them confidential. Federated tokens also timeout and may prevent long running tasks from completing. + +```yaml +Type: System.String +Parameter Sets: ClientAssertionParameterSet +Aliases: ClientAssertion + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Overwrite the existing context with the same name without prompting. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GraphAccessToken + +AccessToken for Graph Service. + +```yaml +Type: System.String +Parameter Sets: AccessTokenWithSubscriptionId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Login using a Managed Service Identity. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ManagedServiceLogin +Aliases: MSI, ManagedService + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultAccessToken + +AccessToken for KeyVault Service. + +```yaml +Type: System.String +Parameter Sets: AccessTokenWithSubscriptionId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxContextPopulation + +Max subscription number to populate contexts after login. Default is 25. To populate all subscriptions to contexts, set to -1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftGraphAccessToken +Access token to Microsoft Graph + +```yaml +Type: System.String +Parameter Sets: AccessTokenWithSubscriptionId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope + +Determines the scope of context changes, for example, whether changes apply only to the current +process, or to all sessions started by this user. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendCertificateChain +Specifies if the x5c claim (public key of the certificate) should be sent to the STS to achieve easy certificate rollover in Azure AD. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ServicePrincipalCertificateWithSubscriptionId, ServicePrincipalCertificateFileWithSubscriptionId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipal + +Indicates that this account authenticates by providing service principal credentials. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ServicePrincipalWithSubscriptionId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ServicePrincipalCertificateWithSubscriptionId, ClientAssertionParameterSet, ServicePrincipalCertificateFileWithSubscriptionId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipContextPopulation + +Skips context population if no contexts are found. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipValidation + +Skip validation for access token. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AccessTokenWithSubscriptionId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subscription + +Subscription Name or ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SubscriptionName, SubscriptionId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Tenant + +Optional tenant name or ID. + +> [!NOTE] +> Due to limitations of the current API, you must use a tenant ID instead of a tenant name when +> connecting with a business-to-business (B2B) account. + +```yaml +Type: System.String +Parameter Sets: UserWithSubscriptionId, UserWithCredential, AccessTokenWithSubscriptionId, ManagedServiceLogin +Aliases: Domain, TenantId + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ServicePrincipalWithSubscriptionId, ServicePrincipalCertificateWithSubscriptionId, ClientAssertionParameterSet, ServicePrincipalCertificateFileWithSubscriptionId +Aliases: Domain, TenantId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDeviceAuthentication + +Use device code authentication instead of a browser control. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UserWithSubscriptionId +Aliases: DeviceCode, DeviceAuth, Device + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.Core.PSAzureProfile + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Disable-AzContextAutosave.md b/azps-10.1.0/Az.Accounts/Disable-AzContextAutosave.md new file mode 100644 index 0000000000..9fce4c46d2 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Disable-AzContextAutosave.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/disable-azcontextautosave +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Disable-AzContextAutosave.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Disable-AzContextAutosave.md +--- + +# Disable-AzContextAutosave + +## SYNOPSIS +Turn off autosaving Azure credentials. Your login information will be forgotten the next time you open a PowerShell window + +## SYNTAX + +``` +Disable-AzContextAutosave [-Scope ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Turn off autosaving Azure credentials. Your login information will be forgotten the next time you open a PowerShell window + +## EXAMPLES + +### Example 1: Disable autosaving the context +```powershell +Disable-AzContextAutosave +``` + +Disable autosave for the current user. + +### Example 2 + +Turn off autosaving Azure credentials in this powershell session. (autogenerated) + + +```powershell +Disable-AzContextAutosave -Scope Process +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, tenant and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Common.Authentication.ContextAutosaveSettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Disable-AzDataCollection.md b/azps-10.1.0/Az.Accounts/Disable-AzDataCollection.md new file mode 100644 index 0000000000..06883ac000 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Disable-AzDataCollection.md @@ -0,0 +1,107 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/disable-azdatacollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Disable-AzDataCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Disable-AzDataCollection.md +--- + +# Disable-AzDataCollection + +## SYNOPSIS +Opts out of collecting data to improve the Azure PowerShell cmdlets. Data is collected by default +unless you explicitly opt out. + +## SYNTAX + +``` +Disable-AzDataCollection [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The `Disable-AzDataCollection` cmdlet is used to opt out of data collection. Azure PowerShell +automatically collects telemetry data by default. To disable data collection, you must explicitly +opt-out. Microsoft aggregates collected data to identify patterns of usage, to identify common +issues, and to improve the experience of Azure PowerShell. Microsoft Azure PowerShell doesn't +collect any private or personal data. If you've previously opted out, run the +`Enable-AzDataCollection` cmdlet to re-enable data collection for the current user on the current +machine. + +## EXAMPLES + +### Example 1: Disabling data collection for the current user + +The following example shows how to disable data collection for the current user. + +```powershell +Disable-AzDataCollection +``` + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Enable-AzDataCollection](./Enable-AzDataCollection.md) diff --git a/azps-10.1.0/Az.Accounts/Disable-AzureRmAlias.md b/azps-10.1.0/Az.Accounts/Disable-AzureRmAlias.md new file mode 100644 index 0000000000..8c7f3df780 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Disable-AzureRmAlias.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/disable-azurermalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Disable-AzureRmAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Disable-AzureRmAlias.md +--- + +# Disable-AzureRmAlias + +## SYNOPSIS +Disables AzureRm prefix aliases for Az modules. + +## SYNTAX + +``` +Disable-AzureRmAlias [-Scope ] [-Module ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Disables AzureRm prefix aliases for Az modules. If -Module is specified, only modules listed will have aliases disabled. Otherwise all AzureRm aliases are disabled. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzureRmAlias +``` + +Disables all AzureRm prefixes for the current PowerShell session. + +### Example 2 +```powershell +Disable-AzureRmAlias -Module Az.Accounts -Scope CurrentUser +``` + +Disables AzureRm aliases for the Az.Accounts module for both the current process and for the current user. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Module +Indicates which modules to disable aliases for. +If none are specified, default is all enabled modules. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +If specified, cmdlet will return all disabled aliases + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Indicates what scope aliases should be disabled for. +Default is 'Process' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser, LocalMachine + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Disconnect-AzAccount.md b/azps-10.1.0/Az.Accounts/Disconnect-AzAccount.md new file mode 100644 index 0000000000..f796e50f8e --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Disconnect-AzAccount.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/disconnect-azaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Disconnect-AzAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Disconnect-AzAccount.md +--- + +# Disconnect-AzAccount + +## SYNOPSIS +Disconnects a connected Azure account and removes all credentials and contexts associated with that account. + +## SYNTAX + +### ContextName (Default) +``` +Disconnect-AzAccount [-ContextName ] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### UserId +``` +Disconnect-AzAccount [-Username] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ServicePrincipal +``` +Disconnect-AzAccount -ApplicationId -TenantId [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### AccountObject +``` +Disconnect-AzAccount [-InputObject] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ContextObject +``` +Disconnect-AzAccount [-AzureContext] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Disconnect-AzAccount cmdlet disconnects a connected Azure account and removes all credentials and contexts (subscription and tenant information) associated with that account. +After executing this cmdlet, you will need to login again using Connect-AzAccount. + +## EXAMPLES + +### Example 1: Logout of the current account +```powershell +Disconnect-AzAccount +``` + +Logs out of the Azure account associated with the current context. + +### Example 2: Logout of the account associated with a particular context +```powershell +Get-AzContext "Work" | Disconnect-AzAccount -Scope CurrentUser +``` + +Logs out the account associated with the given context (named 'Work'). Because this uses the 'CurrentUser' scope, all credentials and contexts will be permanently deleted. + +### Example 3: Log out a particular user +```powershell +Disconnect-AzAccount -Username 'user1@contoso.org' +``` + +Logs out the 'user1@contoso.org' user - all credentials and all contexts associated with this user will be removed. + +## PARAMETERS + +### -ApplicationId +ServicePrincipal id (globally unique id) + +```yaml +Type: System.String +Parameter Sets: ServicePrincipal +Aliases: SPN, ServicePrincipal + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureContext +Context + +```yaml +Type: Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext +Parameter Sets: ContextObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ContextName +Name of the context to log out of + +```yaml +Type: System.String +Parameter Sets: ContextName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, tenant and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The account object to remove + +```yaml +Type: Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +Tenant id (globally unique id) + +```yaml +Type: System.String +Parameter Sets: ServicePrincipal +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Username +User name of the form 'user@contoso.org' + +```yaml +Type: System.String +Parameter Sets: UserId +Aliases: Id, UserId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not executed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount + +### Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Enable-AzContextAutosave.md b/azps-10.1.0/Az.Accounts/Enable-AzContextAutosave.md new file mode 100644 index 0000000000..d8d255e478 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Enable-AzContextAutosave.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/enable-azcontextautosave +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Enable-AzContextAutosave.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Enable-AzContextAutosave.md +--- + +# Enable-AzContextAutosave + +## SYNOPSIS +Azure contexts are PowerShell objects representing your active subscription to run commands against, +and the authentication information needed to connect to an Azure cloud. With Azure contexts, Azure +PowerShell doesn't need to reauthenticate your account each time you switch subscriptions. For more +information, see [Azure PowerShell context objects](https://learn.microsoft.com/powershell/azure/context-persistence). + +This cmdlet allows the Azure context information to be saved and automatically loaded when you start +a PowerShell process. For example, when opening a new window. + +## SYNTAX + +``` +Enable-AzContextAutosave [-Scope ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +Allows the Azure context information to be saved and automatically loaded when a PowerShell process +starts. The context is saved at the end of the execution of any cmdlet that affects the context. For +example, any profile cmdlet. If you're using user authentication, then tokens can be updated during +the course of running any cmdlet. + +## EXAMPLES + +### Example 1: Enable autosaving credentials for the current user + +Turn on credential autosave for the current user. Whenever a PowerShell window is opened, your +current context is remembered without logging in. + +```powershell +Enable-AzContextAutosave +``` + +### Example 2 + +Allow the Azure credential, account, and subscription information, to be saved and automatically +loaded when you open a PowerShell window in this PowerShell session. (autogenerated) + + +```powershell +Enable-AzContextAutosave -Scope Process +``` + +## PARAMETERS + +### -DefaultProfile + +The credentials, tenant, and subscription used for communication with Azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope + +Determines the scope of context changes. For example, whether changes apply only to the current +process, or to all sessions started by this user. Changes made with the scope `CurrentUser` will +affect all PowerShell sessions started by the user. If a particular session needs to have different +settings, use the scope `Process`. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: CurrentUser +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet isn't run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Common.Authentication.ContextAutosaveSettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Enable-AzDataCollection.md b/azps-10.1.0/Az.Accounts/Enable-AzDataCollection.md new file mode 100644 index 0000000000..f00083f975 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Enable-AzDataCollection.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/enable-azdatacollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Enable-AzDataCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Enable-AzDataCollection.md +--- + +# Enable-AzDataCollection + +## SYNOPSIS +Enables Azure PowerShell to collect data to improve the user experience with the Azure PowerShell +cmdlets. Executing this cmdlet opts in to data collection for the current user on the current +machine. Data is collected by default unless you explicitly opt out. + +## SYNTAX + +``` +Enable-AzDataCollection [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The `Enable-AzDataCollection` cmdlet is used to opt in to data collection. Azure PowerShell +automatically collects telemetry data by default. Microsoft aggregates collected data to identify +patterns of usage, to identify common issues, and to improve the experience of Azure PowerShell. +Microsoft Azure PowerShell doesn't collect any private or personal data. To disable data collection, +you must explicitly opt out by executing `Disable-AzDataCollection`. + +## EXAMPLES + +### Example 1: Enabling data collection for the current user + +The following example shows how to enable data collection for the current user. + +```powershell +Enable-AzDataCollection +``` + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Disable-AzDataCollection](./Disable-AzDataCollection.md) diff --git a/azps-10.1.0/Az.Accounts/Enable-AzureRmAlias.md b/azps-10.1.0/Az.Accounts/Enable-AzureRmAlias.md new file mode 100644 index 0000000000..6f43f336e5 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Enable-AzureRmAlias.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/enable-azurermalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Enable-AzureRmAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Enable-AzureRmAlias.md +--- + +# Enable-AzureRmAlias + +## SYNOPSIS +Enables AzureRm prefix aliases for Az modules. + +## SYNTAX + +``` +Enable-AzureRmAlias [-Scope ] [-Module ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Enables AzureRm prefix aliases for Az modules. If -Module is specified, only modules listed will have aliases enabled. Otherwise all AzureRm aliases are enabled. + +## EXAMPLES + +### Example 1 +```powershell +Enable-AzureRmAlias +``` + +Enables all AzureRm prefixes for the current PowerShell session. + +### Example 2 +```powershell +Enable-AzureRmAlias -Module Az.Accounts -Scope CurrentUser +``` + +Enables AzureRm aliases for the Az.Accounts module for both the current process and for the current user. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Module +Indicates which modules to enable aliases for. +If none are specified, default is all modules. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +If specified, cmdlet will return all aliases enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Indicates what scope aliases should be enabled for. +Default is 'Local' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Local, Process, CurrentUser, LocalMachine + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Export-AzConfig.md b/azps-10.1.0/Az.Accounts/Export-AzConfig.md new file mode 100644 index 0000000000..827db44ba4 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Export-AzConfig.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/export-azconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Export-AzConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Export-AzConfig.md +--- + +# Export-AzConfig + +## SYNOPSIS +Exports all the configs into a file so that it can be imported on another machine. + +## SYNTAX + +``` +Export-AzConfig [-Path] [-Force] [-PassThru] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The `Export-AzConfig` cmdlet exports all the configs that are set at the "CurrentUser" scope into a file at given path in JSON format. The file can then be imported by `Import-AzConfig` for example on another machine. + +## EXAMPLES + +### Example 1 +```powershell +Export-AzConfig -Path ./config.json +``` + +This example exports the configs to `./config.json` file which can later be imported via `Import-AzConfig`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrites the given file if it exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns a boolean value indicating success or failure. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the path of the file to which to save the configs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Import-AzConfig](./Import-AzConfig.md) diff --git a/azps-10.1.0/Az.Accounts/Get-AzAccessToken.md b/azps-10.1.0/Az.Accounts/Get-AzAccessToken.md new file mode 100644 index 0000000000..360855db4a --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Get-AzAccessToken.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/get-azaccesstoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzAccessToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzAccessToken.md +--- + +# Get-AzAccessToken + +## SYNOPSIS +Get raw access token. When using -ResourceUrl, please make sure the value does match current Azure environment. You may refer to the value of `(Get-AzContext).Environment`. + +## SYNTAX + +### KnownResourceTypeName (Default) +``` +Get-AzAccessToken [-ResourceTypeName ] [-TenantId ] [-DefaultProfile ] + [] +``` + +### ResourceUrl +``` +Get-AzAccessToken -ResourceUrl [-TenantId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get access token + +## EXAMPLES + +### Example 1 Get the access token for ARM endpoint +```powershell +Get-AzAccessToken +``` + +Get access token of current account for ResourceManager endpoint + +### Example 2 Get the access token for Microsoft Graph endpoint +```powershell +Get-AzAccessToken -ResourceTypeName MSGraph +``` + +Get access token of Microsoft Graph endpoint for current account + +### Example 3 Get the access token for Microsoft Graph endpoint +```powershell +Get-AzAccessToken -ResourceUrl "https://graph.microsoft.com/" +``` + +Get access token of Microsoft Graph endpoint for current account + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceTypeName +Optional resource type name, supported values: AadGraph, AnalysisServices, AppConfiguration, Arm, Attestation, Batch, DataLake, KeyVault, MSGraph, OperationalInsights, ResourceManager, Storage, Synapse. Default value is Arm if not specified. + +```yaml +Type: String +Parameter Sets: KnownResourceTypeName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUrl +Resource url for that you're requesting token, e.g. 'https://graph.microsoft.com/'. + +```yaml +Type: String +Parameter Sets: ResourceUrl +Aliases: Resource, ResourceUri + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +Optional Tenant Id. Use tenant id of default context if not specified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSAccessToken + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Get-AzConfig.md b/azps-10.1.0/Az.Accounts/Get-AzConfig.md new file mode 100644 index 0000000000..ab4c23d923 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Get-AzConfig.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/get-azconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzConfig.md +--- + +# Get-AzConfig + +## SYNOPSIS +Gets the configs of Azure PowerShell. + +## SYNTAX + +``` +Get-AzConfig [-AppliesTo ] [-Scope ] [-DefaultProfile ] + [-DefaultSubscriptionForLogin] [-DisplayBreakingChangeWarning] [-DisplaySurveyMessage] [-EnableDataCollection] + [-EnableLoginByWam] [] +``` + +## DESCRIPTION +Gets the configs of Azure PowerShell. +By default it lists all the configs. You can filter the result using various parameters. + +> [!NOTE] +> Configs have priorities. Generally speaking, Process scope has higher priority than CurrentUser scope; a config that applies to a certain cmdlet has higher priority than that applies to a module, again higher than Az. +> To reduce confusion, the result of `Get-AzConfig` shows those configs that are taking effect. It is a combination of all the configs, but not literally all the configs. However, you could always view them by applying different filter parameters, such as `-Scope`. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzConfig +``` + +```output +Key Value Applies To Scope Help Message +--- ----- ---------- ----- ------------ +EnableDataCollection False Az CurrentUser When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the custom… +DefaultSubscriptionForLogin Az Default Subscription name or GUID. Sets the default context for Azure PowerShell when logging in with… +DisplayBreakingChangeWarning True Az Default Controls if warning messages for breaking changes are displayed or suppressed. When enabled, … +``` + +Gets all the configs. + +### Example 2 +```powershell +Get-AzConfig -EnableDataCollection +``` + +```output +Key Value Applies To Scope Help Message +--- ----- ---------- ----- ------------ +EnableDataCollection False Az CurrentUser When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the custom… +``` + +Gets the "EnableDataCollection" config. + +## PARAMETERS + +### -AppliesTo +Specifies what part of Azure PowerShell the config applies to. +Possible values are: +- "Az": the config applies to all modules and cmdlets of Azure PowerShell. +- Module name: the config applies to a certain module of Azure PowerShell. +For example, "Az.Storage". +- Cmdlet name: the config applies to a certain cmdlet of Azure PowerShell. +For example, "Get-AzKeyVault". +If not specified, when getting or clearing configs, it defaults to all the above; when updating, it defaults to "Az". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSubscriptionForLogin +Subscription name or GUID. +Sets the default context for Azure PowerShell when logging in without specifying a subscription. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayBreakingChangeWarning +Controls if warning messages for breaking changes are displayed or suppressed. When enabled, a breaking change warning is displayed when executing cmdlets with breaking changes in a future release. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplaySurveyMessage +When enabled, you are prompted infrequently to participate in user experience surveys for Azure PowerShell. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDataCollection +When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experience. +For more information, see our privacy statement: https://aka.ms/privacy + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLoginByWam +\[Preview\] When enabled, Web Account Manager (WAM) will be the default interactive login experience. +It will fall back to using the browser if the platform does not support WAM. +Note that this feature is under preview. Microsoft Account (MSA) is currently not supported. +Feel free to reach out to Azure PowerShell team if you have any feedbacks: https://aka.ms/azpsissue + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of config changes, for example, whether changes apply only to the current process, or to all sessions started by this user. +By default it is CurrentUser. + +```yaml +Type: Microsoft.Azure.PowerShell.Common.Config.ConfigScope +Parameter Sets: (All) +Aliases: +Accepted values: CurrentUser, Process, Default, Environment + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSConfig + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Get-AzContext.md b/azps-10.1.0/Az.Accounts/Get-AzContext.md new file mode 100644 index 0000000000..73509b9628 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Get-AzContext.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/get-azcontext +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzContext.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzContext.md +--- + +# Get-AzContext + +## SYNOPSIS +Gets the metadata used to authenticate Azure Resource Manager requests. + +## SYNTAX + +### GetSingleContext (Default) +``` +Get-AzContext [-DefaultProfile ] [[-Name] ] [] +``` + +### ListAllContexts +``` +Get-AzContext [-ListAvailable] [-RefreshContextFromTokenCache] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The Get-AzContext cmdlet gets the current metadata used to authenticate Azure Resource Manager requests. +This cmdlet gets the Active Directory account, Active Directory tenant, Azure subscription, and the targeted Azure environment. +Azure Resource Manager cmdlets use these settings by default when making Azure Resource Manager requests. When the available amount of subscription exceeds the default limit of 25, some subscriptions may not show up in the results of `Get-AzContext -ListAvailable`. Please run `Connect-AzAccount -MaxContextPopulation ` to get more contexts. + +## EXAMPLES + +### Example 1: Getting the current context +```powershell +Connect-AzAccount +Get-AzContext +``` + +```Output +Name Account SubscriptionName Environment TenantId +---- ------- ---------------- ----------- -------- +Subscription1 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com Subscription1 AzureCloud xxxxxxxx-x... +``` + +In this example we are logging into our account with an Azure subscription using Connect-AzAccount, and then we are getting the context of the current session by calling Get-AzContext. + +### Example 2: Listing all available contexts +```powershell +Get-AzContext -ListAvailable +``` + +```Output +Name Account SubscriptionName Environment TenantId +---- ------- ---------------- ----------- -------- +Subscription1 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com Subscription1 AzureCloud xxxxxxxx-x... +Subscription2 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com Subscription2 AzureCloud xxxxxxxx-x... +Subscription3 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com Subscription3 AzureCloud xxxxxxxx-x... +``` + +In this example, all currently available contexts are displayed. The user may select one of these contexts using Select-AzContext. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListAvailable +List all available contexts in the current session. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ListAllContexts +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the context + +```yaml +Type: System.String +Parameter Sets: GetSingleContext +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RefreshContextFromTokenCache +Refresh contexts from token cache + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ListAllContexts +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext + +## NOTES + +## RELATED LINKS + +[Set-AzContext](./Set-AzContext.md) + +[Connect-AzAccount](./Connect-AzAccount.md) diff --git a/azps-10.1.0/Az.Accounts/Get-AzContextAutosaveSetting.md b/azps-10.1.0/Az.Accounts/Get-AzContextAutosaveSetting.md new file mode 100644 index 0000000000..3f0d7418bc --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Get-AzContextAutosaveSetting.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/get-azcontextautosavesetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzContextAutosaveSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzContextAutosaveSetting.md +--- + +# Get-AzContextAutosaveSetting + +## SYNOPSIS +Display metadata about the context autosave feature, including whether the context is +automatically saved, and where saved context and credential information can be found. + +## SYNTAX + +``` +Get-AzContextAutosaveSetting [-Scope ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Display metadata about the context autosave feature, including whether the context is +automatically saved, and where saved context and credential information can be found. + +## EXAMPLES + +### Get context save metadata for the current session +```powershell +Get-AzContextAutosaveSetting +``` + +```Output +Mode : Process +ContextDirectory : None +ContextFile : None +CacheDirectory : None +CacheFile : None +Settings : {} +``` + +Get details about whether and where the context is saved. In the above example, the autosave feature has been disabled. + +### Get context save metadata for the current user +```powershell +Get-AzContextAutosaveSetting -Scope CurrentUser +``` + +```Output +Mode : CurrentUser +ContextDirectory : C:\Users\contoso\AppData\Roaming\Windows Azure Powershell +ContextFile : AzureRmContext.json +CacheDirectory : C:\Users\contoso\AppData\Roaming\Windows Azure Powershell +CacheFile : TokenCache.dat +Settings : {} +``` + +Get details about whether and where the context is saved by default for the current user. Note that this may be different than +the settings that are active in the current session. In the above example, the autosave feature has been enabled, and data is saved +to the default location. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Common.Authentication.ContextAutosaveSettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Get-AzDefault.md b/azps-10.1.0/Az.Accounts/Get-AzDefault.md new file mode 100644 index 0000000000..424ad7bccf --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Get-AzDefault.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/get-azdefault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzDefault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzDefault.md +--- + +# Get-AzDefault + +## SYNOPSIS +Get the defaults set by the user in the current context. + +## SYNTAX + +``` +Get-AzDefault [-ResourceGroup] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzDefault cmdlet gets the Resource Group that the +user has set as default in the current context. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDefault +``` + +```Output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup +Name : myResourceGroup +Properties : Microsoft.Azure.Management.Internal.Resources.Models.ResourceGroupProperties +Location : eastus +ManagedBy : +Tags : +``` + +This command returns the current defaults if there are defaults set, or returns nothing if no default is set. + +### Example 2 +```powershell +Get-AzDefault -ResourceGroup +``` + +```Output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup +Name : myResourceGroup +Properties : Microsoft.Azure.Management.Internal.Resources.Models.ResourceGroupProperties +Location : eastus +ManagedBy : +Tags : +``` + +This command returns the current default Resource Group if there is a default set, or returns nothing if no default is set. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +Display Default Resource Group + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSResourceGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Get-AzEnvironment.md b/azps-10.1.0/Az.Accounts/Get-AzEnvironment.md new file mode 100644 index 0000000000..3d6c2d06ab --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Get-AzEnvironment.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/get-azenvironment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzEnvironment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzEnvironment.md +--- + +# Get-AzEnvironment + +## SYNOPSIS +Get endpoints and metadata for an instance of Azure services. + +## SYNTAX + +``` +Get-AzEnvironment [[-Name] ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzEnvironment cmdlet gets endpoints and metadata for an instance of Azure services. + +## EXAMPLES + +### Example 1: Getting all Azure environments +```powershell +Get-AzEnvironment +``` + +```Output +Name Resource Manager Url ActiveDirectory Authority Type +---- -------------------- ------------------------- ---- +AzureUSGovernment https://management.usgovcloudapi.net/ https://login.microsoftonline.us/ Built-in +AzureCloud https://management.azure.com/ https://login.microsoftonline.com/ Built-in +AzureChinaCloud https://management.chinacloudapi.cn/ https://login.chinacloudapi.cn/ Built-in +``` + +This example shows how to get the endpoints and metadata for the AzureCloud (default) environment. + +### Example 2: Getting the AzureCloud environment +```powershell +Get-AzEnvironment -Name AzureCloud +``` + +```Output +Name Resource Manager Url ActiveDirectory Authority Type +---- -------------------- ------------------------- ---- +AzureCloud https://management.azure.com/ https://login.microsoftonline.com/ Built-in +``` + +This example shows how to get the endpoints and metadata for the AzureCloud (default) environment. + +### Example 3: Getting the AzureChinaCloud environment +```powershell +Get-AzEnvironment -Name AzureChinaCloud | Format-List +``` + +```Output +Name : AzureChinaCloud +Type : Built-in +EnableAdfsAuthentication : False +OnPremise : False +ActiveDirectoryServiceEndpointResourceId : https://management.core.chinacloudapi.cn/ +AdTenant : Common +GalleryUrl : https://gallery.azure.com/ +ManagementPortalUrl : https://go.microsoft.com/fwlink/?LinkId=301902 +ServiceManagementUrl : https://management.core.chinacloudapi.cn/ +PublishSettingsFileUrl : https://go.microsoft.com/fwlink/?LinkID=301776 +ResourceManagerUrl : https://management.chinacloudapi.cn/ +SqlDatabaseDnsSuffix : .database.chinacloudapi.cn +StorageEndpointSuffix : core.chinacloudapi.cn +ActiveDirectoryAuthority : https://login.chinacloudapi.cn/ +GraphUrl : https://graph.chinacloudapi.cn/ +GraphEndpointResourceId : https://graph.chinacloudapi.cn/ +TrafficManagerDnsSuffix : trafficmanager.cn +AzureKeyVaultDnsSuffix : vault.azure.cn +DataLakeEndpointResourceId : +AzureDataLakeStoreFileSystemEndpointSuffix : +AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : +AzureKeyVaultServiceEndpointResourceId : https://vault.azure.cn +ContainerRegistryEndpointSuffix : azurecr.cn +AzureOperationalInsightsEndpointResourceId : +AzureOperationalInsightsEndpoint : +AzureAnalysisServicesEndpointSuffix : asazure.chinacloudapi.cn +AnalysisServicesEndpointResourceId : https://region.asazure.chinacloudapi.cn +AzureAttestationServiceEndpointSuffix : +AzureAttestationServiceEndpointResourceId : +AzureSynapseAnalyticsEndpointSuffix : dev.azuresynapse.azure.cn +AzureSynapseAnalyticsEndpointResourceId : https://dev.azuresynapse.azure.cn +``` + +This example shows how to get the endpoints and metadata for the AzureChinaCloud environment. + +### Example 4: Getting the AzureUSGovernment environment +```powershell +Get-AzEnvironment -Name AzureUSGovernment +``` + +```Output +Name Resource Manager Url ActiveDirectory Authority Type +---- -------------------- ------------------------- ---- +AzureUSGovernment https://management.usgovcloudapi.net/ https://login.microsoftonline.us/ Built-in +``` + +This example shows how to get the endpoints and metadata for the AzureUSGovernment environment. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Azure instance to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSAzureEnvironment + +## NOTES + +## RELATED LINKS + +[Add-AzEnvironment](./Add-AzEnvironment.md) + +[Remove-AzEnvironment](./Remove-AzEnvironment.md) + +[Set-AzEnvironment](./Set-AzEnvironment.md) + diff --git a/azps-10.1.0/Az.Accounts/Get-AzSubscription.md b/azps-10.1.0/Az.Accounts/Get-AzSubscription.md new file mode 100644 index 0000000000..98a91ee18b --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Get-AzSubscription.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/get-azsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzSubscription.md +--- + +# Get-AzSubscription + +## SYNOPSIS +Get subscriptions that the current account can access. + +## SYNTAX + +### ListByIdInTenant (Default) +``` +Get-AzSubscription [-SubscriptionId ] [-TenantId ] [-AsJob] + [-DefaultProfile ] [] +``` + +### ListByNameInTenant +``` +Get-AzSubscription [-SubscriptionName ] [-TenantId ] [-AsJob] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzSubscription cmdlet gets the subscription ID, subscription +name, and home tenant for subscriptions that the current account can +access. + +## EXAMPLES + +### Example 1: Get all subscriptions in all tenants +```powershell +Get-AzSubscription +``` + +```Output +Name Id TenantId State +---- -- -------- ----- +Subscription1 yyyy-yyyy-yyyy-yyyy aaaa-aaaa-aaaa-aaaa Enabled +Subscription2 xxxx-xxxx-xxxx-xxxx aaaa-aaaa-aaaa-aaaa Enabled +Subscription3 zzzz-zzzz-zzzz-zzzz bbbb-bbbb-bbbb-bbbb Enabled +``` + +This command gets all subscriptions in all tenants that are authorized for +the current account. + +### Example 2: Get all subscriptions for a specific tenant +```powershell +Get-AzSubscription -TenantId "aaaa-aaaa-aaaa-aaaa" +``` + +```Output +Name Id TenantId State +---- -- -------- ----- +Subscription1 yyyy-yyyy-yyyy-yyyy aaaa-aaaa-aaaa-aaaa Enabled +Subscription2 xxxx-xxxx-xxxx-xxxx aaaa-aaaa-aaaa-aaaa Enabled +``` + +List all subscriptions in the given tenant that are authorized for the +current account. + +### Example 3: Get all subscriptions in the current tenant +```powershell +Get-AzSubscription -TenantId (Get-AzContext).Tenant +``` + +```Output +Name Id TenantId State +---- -- -------- ----- +Subscription1 yyyy-yyyy-yyyy-yyyy aaaa-aaaa-aaaa-aaaa Enabled +Subscription2 xxxx-xxxx-xxxx-xxxx aaaa-aaaa-aaaa-aaaa Enabled +``` + +This command gets all subscriptions in the current tenant that are +authorized for the current user. + +### Example 4: Change the current context to use a specific subscription +```powershell +Get-AzSubscription -SubscriptionId "xxxx-xxxx-xxxx-xxxx" -TenantId "yyyy-yyyy-yyyy-yyyy" | Set-AzContext +``` + +```Output +Name Account SubscriptionName Environment TenantId +---- ------- ---------------- ----------- -------- +Subscription1 (xxxx-xxxx-xxxx-xxxx) azureuser@micros... Subscription1 AzureCloud yyyy-yyyy-yyyy-yyyy +``` + +This command gets the specified subscription, and then sets the current +context to use it. All subsequent cmdlets in this session use the new +subscription (Contoso Subscription 1) by default. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, tenant and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Specifies the ID of the subscription to get. + +```yaml +Type: System.String +Parameter Sets: ListByIdInTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionName +Specifies the name of the subscription to get. + +```yaml +Type: System.String +Parameter Sets: ListByNameInTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantId +Specifies the ID of the tenant that contains subscriptions to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSAzureSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Get-AzTenant.md b/azps-10.1.0/Az.Accounts/Get-AzTenant.md new file mode 100644 index 0000000000..683c3267dd --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Get-AzTenant.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/get-aztenant +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzTenant.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Get-AzTenant.md +--- + +# Get-AzTenant + +## SYNOPSIS +Gets tenants that are authorized for the current user. + +## SYNTAX + +``` +Get-AzTenant [[-TenantId] ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzTenant cmdlet gets tenants authorized for the current user. + +## EXAMPLES + +### Example 1: Getting all tenants +```powershell +Connect-AzAccount +Get-AzTenant +``` + +```Output +Id Name Category Domains +-- ----------- -------- ------- +xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft Home {test0.com, test1.com, test2.microsoft.com, test3.microsoft.com...} +yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy Testhost Home testhost.onmicrosoft.com +``` + +This example shows how to get all of the authorized tenants of an Azure account. + +### Example 2: Getting a specific tenant +```powershell +Connect-AzAccount +Get-AzTenant -TenantId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +``` + +```Output +Id Name Category Domains +-- ----------- -------- ------- +xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft Home {test0.com, test1.com, test2.microsoft.com, test3.microsoft.com...} +``` + +This example shows how to get a specific authorized tenant of an Azure account. + +## PARAMETERS + +### -DefaultProfile +The credentials, tenant and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +Specifies the ID of the tenant that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Domain, Tenant + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSAzureTenant + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Import-AzConfig.md b/azps-10.1.0/Az.Accounts/Import-AzConfig.md new file mode 100644 index 0000000000..202ed16a93 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Import-AzConfig.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/import-azconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Import-AzConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Import-AzConfig.md +--- + +# Import-AzConfig + +## SYNOPSIS +Imports configs from a file that was previously exported by `Export-AzConfig`. + +## SYNTAX + +``` +Import-AzConfig [-Path] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The `Import-AzConfig` cmdlet imports all the configs from a file that was previously exported by `Export-AzConfig`. The imported configs will be set at the "CurrentUser" scope, so they are consistent across PowerShell sessions. + +During importing, if a config that is to be imported has already been set, its value will be overwritten. + +## EXAMPLES + +### Example 1 +```powershell +Import-AzConfig -Path ./config.json +``` + +This example imports configs from file `./config.json`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns a boolean value indicating success or failure. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the path to configuration saved by using Export-AzConfig. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Export-AzConfig](./Export-AzConfig.md) diff --git a/azps-10.1.0/Az.Accounts/Import-AzContext.md b/azps-10.1.0/Az.Accounts/Import-AzContext.md new file mode 100644 index 0000000000..39fd01ee2b --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Import-AzContext.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/import-azcontext +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Import-AzContext.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Import-AzContext.md +--- + +# Import-AzContext + +## SYNOPSIS +Loads Azure authentication information from a file. + +## SYNTAX + +### ProfileFromDisk (Default) +``` +Import-AzContext [-Path] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### InMemoryProfile +``` +Import-AzContext [-AzureContext] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Import-AzContext cmdlet loads authentication information from a file to set the Azure environment and context. +Cmdlets that you run in the current session use this information to authenticate requests to Azure Resource Manager. + +## EXAMPLES + +### Example 1: Importing a context from a AzureRmProfile +```powershell +Import-AzContext -AzContext (Connect-AzAccount) +``` + +```Output +Account SubscriptionName TenantId Environment +------- ---------------- -------- ----------- +azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud +``` + +This example imports a context from a PSAzureProfile that is passed through to the cmdlet. + +### Example 2: Importing a context from a JSON file +```powershell +Import-AzContext -Path C:\test.json +``` + +```Output +Account SubscriptionName TenantId Environment +------- ---------------- -------- ----------- +azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud +``` + +This example selects a context from a JSON file that is passed through to the cmdlet. This JSON file can be created from Save-AzContext. + +## PARAMETERS + +### -AzureContext +{{Fill AzureContext Description}} + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Models.AzureRmProfile +Parameter Sets: InMemoryProfile +Aliases: Profile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the path to context information saved by using Save-AzContext. + +```yaml +Type: System.String +Parameter Sets: ProfileFromDisk +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Models.AzureRmProfile + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.Core.PSAzureProfile + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Invoke-AzRestMethod.md b/azps-10.1.0/Az.Accounts/Invoke-AzRestMethod.md new file mode 100644 index 0000000000..f94d451b78 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Invoke-AzRestMethod.md @@ -0,0 +1,394 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/invoke-azrestmethod +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Invoke-AzRestMethod.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Invoke-AzRestMethod.md +--- + +# Invoke-AzRestMethod + +## SYNOPSIS +Construct and perform HTTP request to Azure resource management endpoint only + +## SYNTAX + +### ByPath (Default) +``` +Invoke-AzRestMethod -Path [-Method ] [-Payload ] [-AsJob] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByParameters +``` +Invoke-AzRestMethod [-SubscriptionId ] [-ResourceGroupName ] [-ResourceProviderName ] + [-ResourceType ] [-Name ] -ApiVersion [-Method ] [-Payload ] + [-AsJob] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByURI +``` +Invoke-AzRestMethod [-Uri] [-ResourceId ] [-Method ] [-Payload ] [-AsJob] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Construct and perform HTTP request to Azure resource management endpoint only + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzRestMethod -Path "/subscriptions/{subscription}/resourcegroups/{resourcegroup}/providers/microsoft.operationalinsights/workspaces/{workspace}?api-version={API}" -Method GET +``` + +```Output +Headers : {[Cache-Control, System.String[]], [Pragma, System.String[]], [x-ms-request-id, System.String[]], [Strict-Transport-Security, System.String[]]…} +Version : 1.1 +StatusCode : 200 +Method : GET +Content : { + "properties": { + "source": "Azure", + "customerId": "{customerId}", + "provisioningState": "Succeeded", + "sku": { + "name": "pergb2018", + "maxCapacityReservationLevel": 3000, + "lastSkuUpdate": "Mon, 25 May 2020 11:10:01 GMT" + }, + "retentionInDays": 30, + "features": { + "legacy": 0, + "searchVersion": 1, + "enableLogAccessUsingOnlyResourcePermissions": true + }, + "workspaceCapping": { + "dailyQuotaGb": -1.0, + "quotaNextResetTime": "Thu, 18 Jun 2020 05:00:00 GMT", + "dataIngestionStatus": "RespectQuota" + }, + "enableFailover": false, + "publicNetworkAccessForIngestion": "Enabled", + "publicNetworkAccessForQuery": "Enabled", + "createdDate": "Mon, 25 May 2020 11:10:01 GMT", + "modifiedDate": "Mon, 25 May 2020 11:10:02 GMT" + }, + "id": "/subscriptions/{subscription}/resourcegroups/{resourcegroup}/providers/microsoft.operationalinsights/workspaces/{workspace}", + "name": "{workspace}", + "type": "Microsoft.OperationalInsights/workspaces", + "location": "eastasia", + "tags": {} + } +``` + +Get log analytics workspace by path. It only supports management plane API and Hostname of Azure Resource Manager is added according to Azure environment setting. + +### Example 2 +```powershell +Invoke-AzRestMethod https://graph.microsoft.com/v1.0/me +``` + +```output +Headers : {[Date, System.String[]], [Cache-Control, System.String[]], [Transfer-Encoding, System.String[]], [Strict-Transport-Security, System.String[]]…} +Version : 1.1 +StatusCode : 200 +Method : GET +Content : {"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users/$entity","businessPhones":["......} +``` + +Get current signed in user via MicrosoftGraph API. This example is equivalent to `Get-AzADUser -SignedIn`. + +### Example 3 +```powershell +$subscriptionId = (Get-AzContext).Subscription.ID +Invoke-AzRestMethod -SubscriptionId $subscriptionId -ResourceGroupName "test-group" -ResourceProviderName Microsoft.AppPlatform -ResourceType Spring,apps -Name "test-spring-service" -ApiVersion 2020-07-01 -Method GET +``` + +```output +Headers : {[Cache-Control, System.String[]], [Pragma, System.String[]], [Vary, System.String[]], [x-ms-request-id, + System.String[]]…} +Version : 1.1 +StatusCode : 200 +Method : GET +Content : {"value":[{"properties":{"public":true,"url":"https://test-spring-service-demo.azuremicroservices.io","provisioni + ngState":"Succeeded","activeDeploymentName":"default","fqdn":"test-spring-service.azuremicroservices.io","httpsOn + ly":false,"createdTime":"2022-06-22T02:57:13.272Z","temporaryDisk":{"sizeInGB":5,"mountPath":"/tmp"},"pers + istentDisk":{"sizeInGB":0,"mountPath":"/persistent"}},"type":"Microsoft.AppPlatform/Spring/apps","identity + ":null,"location":"eastus","id":"/subscriptions/$subscriptionId/resourceGroups/test-group/providers/Microsoft.AppPlatform/Spring/test-spring-service/apps/demo","name":"demo"},{"properties":{"publ + ic":false,"provisioningState":"Succeeded","activeDeploymentName":"deploy01","fqdn":"test-spring-service.azuremicr + oservices.io","httpsOnly":false,"createdTime":"2022-06-22T07:46:54.9Z","temporaryDisk":{"sizeInGB":5,"moun + tPath":"/tmp"},"persistentDisk":{"sizeInGB":0,"mountPath":"/persistent"}},"type":"Microsoft.AppPlatform/Sp + ring/apps","identity":null,"location":"eastus","id":"/subscriptions/$subscriptionId/r + esourceGroups/test-group/providers/Microsoft.AppPlatform/Spring/test-spring-service/apps/pwsh01","name":"pwsh0 + 1"}]} +``` + +List apps under spring service "test-spring-service" + +### Example 4 +```powershell +$subscriptionId = (Get-AzContext).Subscription.ID +Invoke-AzRestMethod -SubscriptionId $subscriptionId -ResourceGroupName "test-group" -ResourceProviderName Microsoft.AppPlatform -ResourceType Spring -Name "test-spring-service","demo" -ApiVersion 2020-07-01 -Method GET +``` + +```output +Headers : {[Cache-Control, System.String[]], [Pragma, System.String[]], [Vary, System.String[]], [x-ms-request-id, + System.String[]]…} +Version : 1.1 +StatusCode : 200 +Method : GET +Content : {"properties":{"public":true,"url":"https://test-spring-service-demo.azuremicroservices.io","provisioningState":" + Succeeded","activeDeploymentName":"default","fqdn":"test-spring-service.azuremicroservices.io","httpsOnly":false, + "createdTime":"2022-06-22T02:57:13.272Z","temporaryDisk":{"sizeInGB":5,"mountPath":"/tmp"},"persistentDisk + ":{"sizeInGB":0,"mountPath":"/persistent"}},"type":"Microsoft.AppPlatform/Spring/apps","identity":null,"lo + cation":"eastus","id":"/subscriptions/$subscriptionId/resourceGroups/test-group/pr + oviders/Microsoft.AppPlatform/Spring/test-spring-service/apps/demo","name":"demo"} +``` + +Get app "demo" under Spring cloud service "test-spring-service" + +## PARAMETERS + +### -ApiVersion +Api Version + +```yaml +Type: System.String +Parameter Sets: ByParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Method +Http Method + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: GET, POST, PUT, PATCH, DELETE + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +list of Target Resource Name + +```yaml +Type: System.String[] +Parameter Sets: ByParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Path of target resource URL. Hostname of Resource Manager should not be added. + +```yaml +Type: System.String +Parameter Sets: ByPath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Payload +JSON format payload + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Target Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ByParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Identifier URI specified by the REST API you are calling. It shouldn't be the resource id of Azure Resource Manager. + +```yaml +Type: System.Uri +Parameter Sets: ByURI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceProviderName +Target Resource Provider Name + +```yaml +Type: System.String +Parameter Sets: ByParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +List of Target Resource Type + +```yaml +Type: System.String[] +Parameter Sets: ByParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Target Subscription Id + +```yaml +Type: System.String +Parameter Sets: ByParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +Uniform Resource Identifier of the Azure resources. The target resource needs to support Azure AD authentication and the access token is derived according to resource id. If resource id is not set, its value is derived according to built-in service suffixes in current Azure Environment. + +```yaml +Type: System.Uri +Parameter Sets: ByURI +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.string + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSHttpResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Open-AzSurveyLink.md b/azps-10.1.0/Az.Accounts/Open-AzSurveyLink.md new file mode 100644 index 0000000000..500bb133d2 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Open-AzSurveyLink.md @@ -0,0 +1,48 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/open-azsurveylink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Open-AzSurveyLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Open-AzSurveyLink.md +--- + +# Open-AzSurveyLink + +## SYNOPSIS +Open survey link in default browser. + +## SYNTAX + +``` +Open-AzSurveyLink [] +``` + +## DESCRIPTION +Open survey link in default browser. + +## EXAMPLES + +### Example 1 +```powershell +Open-AzSurveyLink +``` + +```Output +Opening the default browser to https://aka.ms/azpssurvey?Q_CHL=INTERCEPT +``` + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Register-AzModule.md b/azps-10.1.0/Az.Accounts/Register-AzModule.md new file mode 100644 index 0000000000..7cede74bb4 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Register-AzModule.md @@ -0,0 +1,77 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/register-azmodule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Register-AzModule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Register-AzModule.md +--- + +# Register-AzModule + +## SYNOPSIS +FOR INTERNAL USE ONLY - Provide Runtime Support for AutoRest Generated cmdlets + +## SYNTAX + +``` +Register-AzModule [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +FOR INTERNAL USE ONLY - Provide Runtime Support for AutoRest Generated cmdlets + +## EXAMPLES + +### Example 1 +```powershell +Register-AzModule +``` + +Used Internally by AutoRest-generated cmdlets + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Remove-AzContext.md b/azps-10.1.0/Az.Accounts/Remove-AzContext.md new file mode 100644 index 0000000000..7335598803 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Remove-AzContext.md @@ -0,0 +1,178 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/remove-azcontext +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Remove-AzContext.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Remove-AzContext.md +--- + +# Remove-AzContext + +## SYNOPSIS +Remove a context from the set of available contexts + +## SYNTAX + +### RemoveByInputObject (Default) +``` +Remove-AzContext -InputObject [-Force] [-PassThru] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### RemoveByName +``` +Remove-AzContext [-Force] [-PassThru] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-Name] [] +``` + +## DESCRIPTION +Remove an azure context from the set of contexts + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzContext -Name Default +``` + +Remove the context named default + +## PARAMETERS + +### -DefaultProfile +The credentials, tenant and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove context even if it is the default + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +A context object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the context + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the removed context + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Remove-AzEnvironment.md b/azps-10.1.0/Az.Accounts/Remove-AzEnvironment.md new file mode 100644 index 0000000000..5a0f607b2c --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Remove-AzEnvironment.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/remove-azenvironment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Remove-AzEnvironment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Remove-AzEnvironment.md +--- + +# Remove-AzEnvironment + +## SYNOPSIS +Removes endpoints and metadata for connecting to a given Azure instance. + +## SYNTAX + +``` +Remove-AzEnvironment [-Name] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Remove-AzEnvironment cmdlet removes endpoints and metadata information for connecting to a given Azure instance. + +## EXAMPLES + +### Example 1: Creating and removing a test environment + +```powershell +Add-AzEnvironment -Name TestEnvironment ` + -ActiveDirectoryEndpoint TestADEndpoint ` + -ActiveDirectoryServiceEndpointResourceId TestADApplicationId ` + -ResourceManagerEndpoint TestRMEndpoint ` + -GalleryEndpoint TestGalleryEndpoint ` + -GraphEndpoint TestGraphEndpoint + +Name Resource Manager Url ActiveDirectory Authority +---- -------------------- ------------------------- +TestEnvironment TestRMEndpoint TestADEndpoint/ + +Remove-AzEnvironment -Name TestEnvironment + +Name Resource Manager Url ActiveDirectory Authority +---- -------------------- ------------------------- +TestEnvironment TestRMEndpoint TestADEndpoint/ +``` + +This example shows how to create an environment using Add-AzEnvironment, and then how to delete the environment using Remove-AzEnvironment. + +## PARAMETERS + +### -DefaultProfile +The credentials, tenant and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the environment to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSAzureEnvironment + +## NOTES + +## RELATED LINKS + +[Add-AzEnvironment](./Add-AzEnvironment.md) + +[Get-AzEnvironment](./Get-AzEnvironment.md) + +[Set-AzEnvironment](./Set-AzEnvironment.md) + diff --git a/azps-10.1.0/Az.Accounts/Rename-AzContext.md b/azps-10.1.0/Az.Accounts/Rename-AzContext.md new file mode 100644 index 0000000000..bcac5376ef --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Rename-AzContext.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/rename-azcontext +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Rename-AzContext.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Rename-AzContext.md +--- + +# Rename-AzContext + +## SYNOPSIS +Rename an Azure context. By default contexts are named by user account and subscription. + +## SYNTAX + +### RenameByInputObject (Default) +``` +Rename-AzContext -InputObject [-Force] [-PassThru] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-TargetName] [] +``` + +### RenameByName +``` +Rename-AzContext [-Force] [-PassThru] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-SourceName] [-TargetName] + [] +``` + +## DESCRIPTION +Rename an Azure context. By default contexts are named by user account and subscription. + +## EXAMPLES + +### Example 1: Rename a context using named parameters +```powershell +Rename-AzContext -SourceName "[user1@contoso.org; 12345-6789-2345-3567890]" -TargetName "Work" +``` + +Rename the context for 'user1@contoso.org' with subscription '12345-6789-2345-3567890' to 'Work'. After this command, you will be able to target the context using +'Select-AzContext Work'. Note that you can tab through the values for 'SourceName' using tab completion. + +### Example 2: Rename a context using positional parameters +```powershell +Rename-AzContext "My context" "Work" +``` + +Rename the context named "My context" to "Work". After this command, you will be able to target the context using +Select-AzContext Work + +## PARAMETERS + +### -DefaultProfile +The credentials, tenant and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Rename the context even if the target context already exists + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +A context object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext +Parameter Sets: RenameByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Return the renamed context. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceName +The name of the context + +```yaml +Type: System.String +Parameter Sets: RenameByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetName +The new name of the context + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Resolve-AzError.md b/azps-10.1.0/Az.Accounts/Resolve-AzError.md new file mode 100644 index 0000000000..b2016383d1 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Resolve-AzError.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/resolve-azerror +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Resolve-AzError.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Resolve-AzError.md +--- + +# Resolve-AzError + +## SYNOPSIS +Display detailed information about PowerShell errors, with extended details for Azure PowerShell errors. + +## SYNTAX + +### AnyErrorParameterSet (Default) +``` +Resolve-AzError [[-Error] ] [-DefaultProfile ] [] +``` + +### LastErrorParameterSet +``` +Resolve-AzError [-Last] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Resolves and displays detailed information about errors in the current PowerShell session, including where the error +occurred in script, stack trace, and all inner and aggregate exceptions. For Azure PowerShell errors provides +additional detail in debugging service issues, including complete detail about the request and server response +that caused the error. + +## EXAMPLES + +### Example 1: Resolve the Last Error +```powershell +Resolve-AzError -Last +``` + +```Output + HistoryId: 3 + + +Message : Run Connect-AzAccount to login. +StackTrace : at Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet.get_DefaultContext() in AzureRmCmdlet.cs:line 85 + at Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet.LogCmdletStartInvocationInfo() in AzureRmCmdlet.cs:line 269 + at Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet.BeginProcessing() inAzurePSCmdlet.cs:line 299 + at Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet.BeginProcessing() in AzureRmCmdlet.cs:line 320 + at Microsoft.Azure.Commands.Profile.GetAzureRMSubscriptionCommand.BeginProcessing() in GetAzureRMSubscription.cs:line 49 + at System.Management.Automation.Cmdlet.DoBeginProcessing() + at System.Management.Automation.CommandProcessorBase.DoBegin() +Exception : System.Management.Automation.PSInvalidOperationException +InvocationInfo : {Get-AzSubscription} +Line : Get-AzSubscription +Position : At line:1 char:1 + + Get-AzSubscription + + ~~~~~~~~~~~~~~~~~~~~~~~ +HistoryId : 3 +``` + +Get details of the last error. + +### Example 2: Resolve all Errors in the Session +```powershell +Resolve-AzError +``` + +```Output + HistoryId: 8 + + +RequestId : b61309e8-09c9-4f0d-ba56-08a6b28c731d +Message : Resource group 'contoso' could not be found. +ServerMessage : ResourceGroupNotFound: Resource group 'contoso' could not be found. + (System.Collections.Generic.List`1[Microsoft.Rest.Azure.CloudError]) +ServerResponse : {NotFound} +RequestMessage : {GET https://management.azure.com/subscriptions/00977cdb-163f-435f-9c32-39ec8ae61f4d/resourceGroups/co + ntoso/providers/Microsoft.Storage/storageAccounts/contoso?api-version=2016-12-01} +InvocationInfo : {Get-AzStorageAccount} +Line : Get-AzStorageAccount -ResourceGroupName contoso -Name contoso +Position : At line:1 char:1 + + Get-AzStorageAccount -ResourceGroupName contoso -Name contoso + + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +StackTrace : at Microsoft.Azure.Management.Storage.StorageAccountsOperations.d__8.MoveNext() + --- End of stack trace from previous location where exception was thrown --- + at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() + at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task) + at Microsoft.Azure.Management.Storage.StorageAccountsOperationsExtensions.d__7. + MoveNext() + --- End of stack trace from previous location where exception was thrown --- + at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() + at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task) + at Microsoft.Azure.Management.Storage.StorageAccountsOperationsExtensions.GetProperties(IStorageAcc + ountsOperations operations, String resourceGroupName, String accountName) + at Microsoft.Azure.Commands.Management.Storage.GetAzureStorageAccountCommand.ExecuteCmdlet() in C:\ + zd\azure-powershell\src\ResourceManager\Storage\Commands.Management.Storage\StorageAccount\GetAzureSto + rageAccount.cs:line 70 + at Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet.ProcessRecord() in + C:\zd\azure-powershell\src\Common\Commands.Common\AzurePSCmdlet.cs:line 642 +HistoryId : 8 + + + HistoryId: 5 + + +Message : Run Connect-AzAccount to login. +StackTrace : at Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet.get_DefaultContext() in C:\zd\azur + e-powershell\src\ResourceManager\Common\Commands.ResourceManager.Common\AzureRmCmdlet.cs:line 85 + at Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet.LogCmdletStartInvocationInfo() in + C:\zd\azure-powershell\src\ResourceManager\Common\Commands.ResourceManager.Common\AzureRmCmdlet.cs:lin + e 269 + at Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet.BeginProcessing() in + C:\zd\azure-powershell\src\Common\Commands.Common\AzurePSCmdlet.cs:line 299 + at Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet.BeginProcessing() in C:\zd\azure-p + owershell\src\ResourceManager\Common\Commands.ResourceManager.Common\AzureRmCmdlet.cs:line 320 + at Microsoft.Azure.Commands.Profile.GetAzureRMSubscriptionCommand.BeginProcessing() in C:\zd\azure- + powershell\src\ResourceManager\Profile\Commands.Profile\Subscription\GetAzureRMSubscription.cs:line 49 + at System.Management.Automation.Cmdlet.DoBeginProcessing() + at System.Management.Automation.CommandProcessorBase.DoBegin() +Exception : System.Management.Automation.PSInvalidOperationException +InvocationInfo : {Get-AzSubscription} +Line : Get-AzSubscription +Position : At line:1 char:1 + + Get-AzSubscription + + ~~~~~~~~~~~~~~~~~~~~~~~ +HistoryId : 5 +``` + +Get details of all errors that have occurred in the current session. + +### Example 3: Resolve a Specific Error +```powershell +Resolve-AzError $Error[0] +``` + +```Output + HistoryId: 8 + + +RequestId : b61309e8-09c9-4f0d-ba56-08a6b28c731d +Message : Resource group 'contoso' could not be found. +ServerMessage : ResourceGroupNotFound: Resource group 'contoso' could not be found. + (System.Collections.Generic.List`1[Microsoft.Rest.Azure.CloudError]) +ServerResponse : {NotFound} +RequestMessage : {GET https://management.azure.com/subscriptions/00977cdb-163f-435f-9c32-39ec8ae61f4d/resourceGroups/co + ntoso/providers/Microsoft.Storage/storageAccounts/contoso?api-version=2016-12-01} +InvocationInfo : {Get-AzStorageAccount} +Line : Get-AzStorageAccount -ResourceGroupName contoso -Name contoso +Position : At line:1 char:1 + + Get-AzStorageAccount -ResourceGroupName contoso -Name contoso + + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +StackTrace : at Microsoft.Azure.Management.Storage.StorageAccountsOperations.d__8.MoveNext() + --- End of stack trace from previous location where exception was thrown --- + at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() + at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task) + at Microsoft.Azure.Management.Storage.StorageAccountsOperationsExtensions.d__7. + MoveNext() + --- End of stack trace from previous location where exception was thrown --- + at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() + at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task) + at Microsoft.Azure.Management.Storage.StorageAccountsOperationsExtensions.GetProperties(IStorageAcc + ountsOperations operations, String resourceGroupName, String accountName) + at Microsoft.Azure.Commands.Management.Storage.GetAzureStorageAccountCommand.ExecuteCmdlet() in C:\ + zd\azure-powershell\src\ResourceManager\Storage\Commands.Management.Storage\StorageAccount\GetAzureSto + rageAccount.cs:line 70 + at Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet.ProcessRecord() in + C:\zd\azure-powershell\src\Common\Commands.Common\AzurePSCmdlet.cs:line 642 +HistoryId : 8 +``` + +Get details of the specified error. + +## PARAMETERS + +### -DefaultProfile +The credentials, tenant and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Error +One or more error records to resolve. If no parameters are specified, all errors in the session are resolved. + +```yaml +Type: System.Management.Automation.ErrorRecord[] +Parameter Sets: AnyErrorParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Last +Resolve only the last error that occurred in the session. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: LastErrorParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.ErrorRecord[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Errors.AzureErrorRecord + +### Microsoft.Azure.Commands.Profile.Errors.AzureExceptionRecord + +### Microsoft.Azure.Commands.Profile.Errors.AzureRestExceptionRecord + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Save-AzContext.md b/azps-10.1.0/Az.Accounts/Save-AzContext.md new file mode 100644 index 0000000000..6988355079 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Save-AzContext.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/save-azcontext +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Save-AzContext.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Save-AzContext.md +--- + +# Save-AzContext + +## SYNOPSIS +Saves the current authentication information for use in other PowerShell sessions. + +## SYNTAX + +``` +Save-AzContext [[-Profile] ] [-Path] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Save-AzContext cmdlet saves the current authentication information for use in other PowerShell sessions. + +## EXAMPLES + +### Example 1: Saving the current session's context +```powershell +Connect-AzAccount +Save-AzContext -Path C:\test.json +``` + +This example saves the current session's Azure context to the JSON file provided. + +### Example 2: Saving a given context +```powershell +Save-AzContext -Profile (Connect-AzAccount) -Path C:\test.json +``` + +This example saves the Azure context that is passed through to the cmdlet to the JSON file provided. + +## PARAMETERS + +### -DefaultProfile +The credentials, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrite the given file if it exists + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the path of the file to which to save authentication information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Profile +Specifies the Azure context from which this cmdlet reads. +If you do not specify a context, this cmdlet reads from the local default context. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Models.AzureRmProfile +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Models.AzureRmProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.Core.PSAzureProfile + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Select-AzContext.md b/azps-10.1.0/Az.Accounts/Select-AzContext.md new file mode 100644 index 0000000000..a1e23a0687 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Select-AzContext.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/select-azcontext +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Select-AzContext.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Select-AzContext.md +--- + +# Select-AzContext + +## SYNOPSIS +Select a subscription and account to target in Azure PowerShell cmdlets + +## SYNTAX + +### SelectByInputObject (Default) +``` +Select-AzContext -InputObject [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### SelectByName +``` +Select-AzContext [-Scope ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [-Name] [] +``` + +## DESCRIPTION +Select a subscription to target (or account or tenant) in Azure PowerShell cmdlets. After this cmdlet, future cmdlets will target the +selected context. + +## EXAMPLES + +### Example 1: Target a named context +```powershell +Select-AzContext "Work" +``` + +```Output +Name Account SubscriptionName Environment TenantId +---- ------- ---------------- ----------- -------- +Work test@outlook.com Subscription1 AzureCloud xxxxxxxx-x... +``` + +Target future Azure PowerShell cmdlets at the account, tenant, and subscription in the 'Work' context. + +### Example 2 + +Select a subscription and account to target in Azure PowerShell cmdlets in this powershell session. (autogenerated) + + +```powershell +Select-AzContext -Name TestEnvironment -Scope Process +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, tenant and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +A context object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext +Parameter Sets: SelectByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the context + +```yaml +Type: System.String +Parameter Sets: SelectByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Send-Feedback.md b/azps-10.1.0/Az.Accounts/Send-Feedback.md new file mode 100644 index 0000000000..a12540661b --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Send-Feedback.md @@ -0,0 +1,79 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/send-feedback +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Send-Feedback.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Send-Feedback.md +--- + +# Send-Feedback + +## SYNOPSIS +Sends feedback to the Azure PowerShell team via a set of guided prompts. + +## SYNTAX + +``` +Send-Feedback [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Send-Feedback cmdlet sends feedback to the Azure PowerShell team. + +## EXAMPLES + +### Example 1: +```powershell +Send-Feedback +``` + +```Output +With zero (0) being the least and ten (10) being the most, how likely are you to recommend Azure PowerShell to a friend or colleague? + +10 + +What does Azure PowerShell do well? + +Response. + +Upon what could Azure PowerShell improve? + +Response. + +Please enter your email if you are interested in providing follow up information: + +your@email.com +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Set-AzContext.md b/azps-10.1.0/Az.Accounts/Set-AzContext.md new file mode 100644 index 0000000000..8432a3be9c --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Set-AzContext.md @@ -0,0 +1,291 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/set-azcontext +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Set-AzContext.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Set-AzContext.md +--- + +# Set-AzContext + +## SYNOPSIS +Sets the tenant, subscription, and environment for cmdlets to use in the current session. + +## SYNTAX + +### Context (Default) +``` +Set-AzContext [-Context] + [-ExtendedProperty ] [-Name ] + [-Force] [-Scope ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### TenantObject +``` +Set-AzContext [-TenantObject] + [-ExtendedProperty ] [-Name ] + [-Force] [-Scope ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### SubscriptionObject +``` +Set-AzContext [-SubscriptionObject] + [-ExtendedProperty ] [-Name ] + [-Force] [-Scope ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### Subscription +``` +Set-AzContext [-Tenant ] [-Subscription] + [-ExtendedProperty ] [-Name ] + [-Force] [-Scope ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### TenantNameOnly +``` +Set-AzContext -Tenant + [-ExtendedProperty ] [-Name ] + [-Force] [-Scope ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The Set-AzContext cmdlet sets authentication information for cmdlets that you run in the current session. +The context includes tenant, subscription, and environment information. + +## EXAMPLES + +### Example 1: Set the subscription context +```powershell +Set-AzContext -Subscription "xxxx-xxxx-xxxx-xxxx" +``` + +```Output +Name Account SubscriptionName Environment TenantId +---- ------- ---------------- ----------- -------- +Work test@outlook.com Subscription1 AzureCloud xxxxxxxx-x... +``` + +This command sets the context to use the specified subscription. + +## PARAMETERS + +### -Context +Specifies the context for the current session. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext +Parameter Sets: Context +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProperty +Additional context properties + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrite the existing context with the same name, if any. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the context + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subscription +The name or id of the subscription that the context should be set to. This parameter has aliases to -SubscriptionName and -SubscriptionId, so, for clarity, either of these can be used instead of -Subscription when specifying name and id, respectively. + +```yaml +Type: System.String +Parameter Sets: Subscription +Aliases: SubscriptionId, SubscriptionName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionObject +A subscription object + +```yaml +Type: Microsoft.Azure.Commands.Profile.Models.PSAzureSubscription +Parameter Sets: SubscriptionObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Tenant +Tenant domain name or ID + +```yaml +Type: System.String +Parameter Sets: Subscription +Aliases: Domain, TenantId + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: TenantNameOnly +Aliases: Domain, TenantId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantObject +A Tenant Object + +```yaml +Type: Microsoft.Azure.Commands.Profile.Models.PSAzureTenant +Parameter Sets: TenantObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext + +### Microsoft.Azure.Commands.Profile.Models.PSAzureTenant + +### Microsoft.Azure.Commands.Profile.Models.PSAzureSubscription + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext + +## NOTES + +## RELATED LINKS + +[Get-AzContext](./Get-AzContext.md) + diff --git a/azps-10.1.0/Az.Accounts/Set-AzDefault.md b/azps-10.1.0/Az.Accounts/Set-AzDefault.md new file mode 100644 index 0000000000..e20a1604f0 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Set-AzDefault.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/set-azdefault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Set-AzDefault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Set-AzDefault.md +--- + +# Set-AzDefault + +## SYNOPSIS +Sets a default in the current context + +## SYNTAX + +``` +Set-AzDefault [-ResourceGroupName ] [-Force] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Set-AzDefault cmdlet adds or changes the defaults in the current context. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDefault -ResourceGroupName myResourceGroup +``` + +```Output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup +Name : myResourceGroup +Properties : Microsoft.Azure.Management.Internal.Resources.Models.ResourceGroupProperties +Location : eastus +ManagedBy : +Tags : +``` + +This command sets the default resource group to the resource group specified by the user. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Create a new resource group if specified default does not exist + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group being set as default + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSResourceGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Set-AzEnvironment.md b/azps-10.1.0/Az.Accounts/Set-AzEnvironment.md new file mode 100644 index 0000000000..5c77ac983e --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Set-AzEnvironment.md @@ -0,0 +1,683 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/set-azenvironment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Set-AzEnvironment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Set-AzEnvironment.md +--- + +# Set-AzEnvironment + +## SYNOPSIS +Sets properties for an Azure environment. + +## SYNTAX + +### Name (Default) +``` +Set-AzEnvironment [-Name] [[-PublishSettingsFileUrl] ] [[-ServiceEndpoint] ] + [[-ManagementPortalUrl] ] [[-StorageEndpoint] ] [[-ActiveDirectoryEndpoint] ] + [[-ResourceManagerEndpoint] ] [[-GalleryEndpoint] ] + [[-ActiveDirectoryServiceEndpointResourceId] ] [[-GraphEndpoint] ] + [[-AzureKeyVaultDnsSuffix] ] [[-AzureKeyVaultServiceEndpointResourceId] ] + [[-TrafficManagerDnsSuffix] ] [[-SqlDatabaseDnsSuffix] ] + [[-AzureDataLakeStoreFileSystemEndpointSuffix] ] + [[-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix] ] [-EnableAdfsAuthentication] + [[-AdTenant] ] [[-GraphAudience] ] [[-DataLakeAudience] ] + [[-BatchEndpointResourceId] ] [[-AzureOperationalInsightsEndpointResourceId] ] + [[-AzureOperationalInsightsEndpoint] ] [-AzureAnalysisServicesEndpointSuffix ] + [-AzureAnalysisServicesEndpointResourceId ] [-AzureAttestationServiceEndpointSuffix ] + [-AzureAttestationServiceEndpointResourceId ] [-AzureSynapseAnalyticsEndpointSuffix ] + [-ContainerRegistryEndpointSuffix ] [-AzureSynapseAnalyticsEndpointResourceId ] + [-MicrosoftGraphEndpointResourceId ] [-MicrosoftGraphUrl ] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ARMEndpoint +``` +Set-AzEnvironment [-Name] [[-StorageEndpoint] ] [-ARMEndpoint] + [[-AzureKeyVaultDnsSuffix] ] [[-AzureKeyVaultServiceEndpointResourceId] ] + [[-DataLakeAudience] ] [[-BatchEndpointResourceId] ] + [[-AzureOperationalInsightsEndpointResourceId] ] [[-AzureOperationalInsightsEndpoint] ] + [-AzureAnalysisServicesEndpointSuffix ] [-AzureAnalysisServicesEndpointResourceId ] + [-AzureAttestationServiceEndpointSuffix ] [-AzureAttestationServiceEndpointResourceId ] + [-AzureSynapseAnalyticsEndpointSuffix ] [-ContainerRegistryEndpointSuffix ] + [-AzureSynapseAnalyticsEndpointResourceId ] [-Scope ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Set-AzEnvironment cmdlet sets endpoints and metadata for connecting to an instance of Azure. + +## EXAMPLES + +### Example 1: Creating and modifying a new environment + +```powershell +Add-AzEnvironment -Name TestEnvironment ` + -ActiveDirectoryEndpoint TestADEndpoint ` + -ActiveDirectoryServiceEndpointResourceId TestADApplicationId ` + -ResourceManagerEndpoint TestRMEndpoint ` + -GalleryEndpoint TestGalleryEndpoint ` + -GraphEndpoint TestGraphEndpoint + +Name Resource Manager Url ActiveDirectory Authority +---- -------------------- ------------------------- +TestEnvironment TestRMEndpoint TestADEndpoint/ + +Set-AzEnvironment -Name TestEnvironment ` + -ActiveDirectoryEndpoint NewTestADEndpoint ` + -GraphEndpoint NewTestGraphEndpoint | Format-List + +Name : TestEnvironment +EnableAdfsAuthentication : False +ActiveDirectoryServiceEndpointResourceId : TestADApplicationId +AdTenant : +GalleryUrl : TestGalleryEndpoint +ManagementPortalUrl : +ServiceManagementUrl : +PublishSettingsFileUrl : +ResourceManagerUrl : TestRMEndpoint +SqlDatabaseDnsSuffix : +StorageEndpointSuffix : +ActiveDirectoryAuthority : NewTestADEndpoint +GraphUrl : NewTestGraphEndpoint +GraphEndpointResourceId : +TrafficManagerDnsSuffix : +AzureKeyVaultDnsSuffix : +AzureDataLakeStoreFileSystemEndpointSuffix : +AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : +AzureKeyVaultServiceEndpointResourceId : +BatchEndpointResourceId : +AzureOperationalInsightsEndpoint : +AzureOperationalInsightsEndpointResourceId : +AzureAttestationServiceEndpointSuffix : +AzureAttestationServiceEndpointResourceId : +AzureSynapseAnalyticsEndpointSuffix : +AzureSynapseAnalyticsEndpointResourceId : +``` + +In this example we are creating a new Azure environment with sample endpoints using Add-AzEnvironment, and then we are changing the value of the ActiveDirectoryEndpoint and GraphEndpoint attributes of the created environment using the cmdlet Set-AzEnvironment. + +## PARAMETERS + +### -ActiveDirectoryEndpoint +Specifies the base authority for Azure Active Directory authentication. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ActiveDirectoryServiceEndpointResourceId +Specifies the audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AdTenant +Specifies the default Active Directory tenant. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 17 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ARMEndpoint +The Azure Resource Manager endpoint. + +```yaml +Type: System.String +Parameter Sets: ARMEndpoint +Aliases: ArmUrl + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureAnalysisServicesEndpointResourceId +The resource identifier of the Azure Analysis Services resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureAnalysisServicesEndpointSuffix +The endpoint to use when communicating with the Azure Log Analytics API. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureAttestationServiceEndpointResourceId +The The resource identifier of the Azure Attestation service that is the recipient of the requested token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureAttestationServiceEndpointSuffix +Dns suffix of Azure Attestation service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix +Dns Suffix of Azure Data Lake Analytics job and catalog services + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 15 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureDataLakeStoreFileSystemEndpointSuffix +Dns Suffix of Azure Data Lake Store FileSystem. Example: azuredatalake.net + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 14 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureKeyVaultDnsSuffix +Dns suffix of Azure Key Vault service. Example is vault-int.azure-int.net + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureKeyVaultServiceEndpointResourceId +Resource identifier of Azure Key Vault data service that is the recipient of the requested token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureOperationalInsightsEndpoint +The endpoint to use when communicating with the Azure Log Analytics API. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 22 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureOperationalInsightsEndpointResourceId +The audience for tokens authenticating with the Azure Log Analytics API. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 21 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureSynapseAnalyticsEndpointResourceId +The The resource identifier of the Azure Synapse Analytics that is the recipient of the requested token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureSynapseAnalyticsEndpointSuffix +Dns suffix of Azure Synapse Analytics. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BatchEndpointResourceId +The resource identifier of the Azure Batch service that is the recipient of the requested token + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BatchResourceId, BatchAudience + +Required: False +Position: 20 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContainerRegistryEndpointSuffix +Suffix of Azure Container Registry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataLakeAudience +The audience for tokens authenticating with the AD Data Lake services Endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DataLakeEndpointResourceId, DataLakeResourceId + +Required: False +Position: 19 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAdfsAuthentication +Indicates that Active Directory Federation Services (ADFS) on-premise authentication is allowed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Name +Aliases: OnPremise + +Required: False +Position: 16 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryEndpoint +Specifies the endpoint for the Azure Resource Manager gallery of deployment templates. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: Gallery, GalleryUrl + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GraphAudience +The audience for tokens authenticating with the AD Graph Endpoint. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: GraphEndpointResourceId, GraphResourceId + +Required: False +Position: 18 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GraphEndpoint +Specifies the URL for Graph (Active Directory metadata) requests. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: Graph, GraphUrl + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagementPortalUrl +Specifies the URL for the Management Portal. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MicrosoftGraphEndpointResourceId +The resource identifier of Microsoft Graph + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MicrosoftGraphUrl +Microsoft Graph Url + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the environment to modify. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublishSettingsFileUrl +Specifies the URL from which .publishsettings files can be downloaded. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceManagerEndpoint +Specifies the URL for Azure Resource Manager requests. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: ResourceManager, ResourceManagerUrl + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. + +```yaml +Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope +Parameter Sets: (All) +Aliases: +Accepted values: Process, CurrentUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceEndpoint +Specifies the endpoint for Service Management (RDFE) requests. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: ServiceManagement, ServiceManagementUrl + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlDatabaseDnsSuffix +Specifies the domain-name suffix for Azure SQL Database servers. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 13 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageEndpoint +Specifies the endpoint for storage (blob, table, queue, and file) access. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageEndpointSuffix + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerDnsSuffix +Specifies the domain-name suffix for Azure Traffic Manager services. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: False +Position: 12 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSAzureEnvironment + +## NOTES + +## RELATED LINKS + +[Add-AzEnvironment](./Add-AzEnvironment.md) + +[Get-AzEnvironment](./Get-AzEnvironment.md) + +[Remove-AzEnvironment](./Remove-AzEnvironment.md) + diff --git a/azps-10.1.0/Az.Accounts/Uninstall-AzureRm.md b/azps-10.1.0/Az.Accounts/Uninstall-AzureRm.md new file mode 100644 index 0000000000..d9ba7dd0b2 --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Uninstall-AzureRm.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/uninstall-azurerm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Uninstall-AzureRm.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Uninstall-AzureRm.md +--- + +# Uninstall-AzureRm + +## SYNOPSIS +Removes all AzureRm modules from a machine. + +## SYNTAX + +``` +Uninstall-AzureRm [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Removes all AzureRm modules from a machine. + +## EXAMPLES + +### Example 1 +```powershell +Uninstall-AzureRm +``` + +Running this command will remove all AzureRm modules from the machine for the version of PowerShell in which the cmdlet is run. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return list of Modules removed if specified. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Accounts/Update-AzConfig.md b/azps-10.1.0/Az.Accounts/Update-AzConfig.md new file mode 100644 index 0000000000..6337fea7ff --- /dev/null +++ b/azps-10.1.0/Az.Accounts/Update-AzConfig.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +Module Name: Az.Accounts +online version: https://learn.microsoft.com/powershell/module/az.accounts/update-azconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Update-AzConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Update-AzConfig.md +--- + +# Update-AzConfig + +## SYNOPSIS +Updates the configs of Azure PowerShell. + +## SYNTAX + +``` +Update-AzConfig [-AppliesTo ] [-Scope ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [-DefaultSubscriptionForLogin ] [-DisplayBreakingChangeWarning ] + [-DisplaySurveyMessage ] [-EnableDataCollection ] [-EnableLoginByWam ] + [] +``` + +## DESCRIPTION +Updates the configs of Azure PowerShell. +Depending on which config to update, you may specify the scope where the config is persisted and to which module or cmdlet it applies to. + +> [!NOTE] +> It is discouraged to update configs in multiple PowerShell processes. Either do it in one process, or make sure the updates are at Process scope (`-Scope Process`) to avoid unexpected side-effects. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzConfig -DefaultSubscriptionForLogin "Name of subscription" +``` + +```output +Key Value Applies To Scope Help Message +--- ----- ---------- ----- ------------ +DefaultSubscriptionForLogin Name of subscription Az CurrentUser Subscription name or GUID. Sets the default context for Azure PowerShell when lo… +``` + +Sets the "DefaultSubscriptionForLogin" config as "Name of subscription". When `Connect-AzAccount` the specified subscription will be selected as the default subscription. + +### Example 2 +```powershell +Update-AzConfig -DisplayBreakingChangeWarning $false -AppliesTo "Az.KeyVault" +``` + +```output +Key Value Applies To Scope Help Message +--- ----- ---------- ----- ------------ +DisplayBreakingChangeWarning False Az.KeyVault CurrentUser Controls if warning messages for breaking changes are displayed or suppressed. When enabled,… +``` + +Sets the "DisplayBreakingChangeWarnings" config as "$false" for "Az.KeyVault" module. This prevents all the warning messages for upcoming breaking changes in Az.KeyVault module from prompting. + +### Example 3 +```powershell +Update-AzConfig -EnableDataCollection $true +``` + +```output +Key Value Applies To Scope Help Message +--- ----- ---------- ----- ------------ +EnableDataCollection True Az CurrentUser When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experi… +``` + +Sets the "EnableDataCollection" config as "$true". This enables sending the telemetry data. +Setting this config is equivalent to `Enable-AzDataCollection` and `Disable-AzDataCollection`. + +## PARAMETERS + +### -AppliesTo +Specifies what part of Azure PowerShell the config applies to. +Possible values are: +- "Az": the config applies to all modules and cmdlets of Azure PowerShell. +- Module name: the config applies to a certain module of Azure PowerShell. +For example, "Az.Storage". +- Cmdlet name: the config applies to a certain cmdlet of Azure PowerShell. +For example, "Get-AzKeyVault". +If not specified, when getting or clearing configs, it defaults to all the above; when updating, it defaults to "Az". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSubscriptionForLogin +Subscription name or GUID. +Sets the default context for Azure PowerShell when logging in without specifying a subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayBreakingChangeWarning +Controls if warning messages for breaking changes are displayed or suppressed. When enabled, a breaking change warning is displayed when executing cmdlets with breaking changes in a future release. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplaySurveyMessage +When enabled, you are prompted infrequently to participate in user experience surveys for Azure PowerShell. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableDataCollection +When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experience. +For more information, see our privacy statement: https://aka.ms/privacy + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableLoginByWam +\[Preview\] When enabled, Web Account Manager (WAM) will be the default interactive login experience. +It will fall back to using the browser if the platform does not support WAM. +Note that this feature is under preview. Microsoft Account (MSA) is currently not supported. +Feel free to reach out to Azure PowerShell team if you have any feedbacks: https://aka.ms/azpsissue + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Determines the scope of config changes, for example, whether changes apply only to the current process, or to all sessions started by this user. +By default it is CurrentUser. + +```yaml +Type: Microsoft.Azure.PowerShell.Common.Config.ConfigScope +Parameter Sets: (All) +Aliases: +Accepted values: CurrentUser, Process, Default, Environment + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Profile.Models.PSConfig + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Advisor/Az.Advisor.md b/azps-10.1.0/Az.Advisor/Az.Advisor.md new file mode 100644 index 0000000000..a272b6383f --- /dev/null +++ b/azps-10.1.0/Az.Advisor/Az.Advisor.md @@ -0,0 +1,30 @@ +--- +Module Name: Az.Advisor +Module Guid: 860b550a-20ce-4fb1-bae7-ef10e9221bce +Download Help Link: https://learn.microsoft.com/powershell/module/az.advisor +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Advisor/help/Az.Advisor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Advisor/help/Az.Advisor.md +--- + +# Az.Advisor Module +## Description +Microsoft Azure PowerShell: Advisor cmdlets + +## Az.Advisor Cmdlets +### [Disable-AzAdvisorRecommendation](Disable-AzAdvisorRecommendation.md) +Disable an Azure Advisor recommendation. + +### [Enable-AzAdvisorRecommendation](Enable-AzAdvisorRecommendation.md) +Enables Azure Advisor recommendation(s). + +### [Get-AzAdvisorConfiguration](Get-AzAdvisorConfiguration.md) +Retrieve Azure Advisor configurations and also retrieve configurations of contained resource groups. + +### [Get-AzAdvisorRecommendation](Get-AzAdvisorRecommendation.md) +Obtains details of a cached recommendation. + +### [Set-AzAdvisorConfiguration](Set-AzAdvisorConfiguration.md) +Updates or creates the Azure Advisor Configuration. + diff --git a/azps-10.1.0/Az.Advisor/Disable-AzAdvisorRecommendation.md b/azps-10.1.0/Az.Advisor/Disable-AzAdvisorRecommendation.md new file mode 100644 index 0000000000..309b58be72 --- /dev/null +++ b/azps-10.1.0/Az.Advisor/Disable-AzAdvisorRecommendation.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.Advisor +online version: https://learn.microsoft.com/powershell/module/az.advisor/Disable-AzAdvisorRecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Advisor/help/Disable-AzAdvisorRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Advisor/help/Disable-AzAdvisorRecommendation.md +--- + +# Disable-AzAdvisorRecommendation + +## SYNOPSIS +Disable an Azure Advisor recommendation. + +## SYNTAX + +### IdParameterSet (Default) +``` +Disable-AzAdvisorRecommendation -ResourceId [-SubscriptionId ] [-Day ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### InputObjectParameterSet +``` +Disable-AzAdvisorRecommendation -InputObject [-SubscriptionId ] [-Day ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### NameParameterSet +``` +Disable-AzAdvisorRecommendation -RecommendationName [-SubscriptionId ] [-Day ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Disable an Azure Advisor recommendation. + +## EXAMPLES + +### Example 1: Disable recommendation by recommendation name +```powershell +Disable-AzAdvisorRecommendation -RecommendationName 42963553-61de-5334-2d2e-47f3a0099d41 -Day 1 +``` + +```output +SuppressionId Name Resource Group Ttl +------------- ---- -------------- --- +5b931ff3-42a3-5f80-797f-8e018a6dfaf5 HardcodedSuppressionName automanagehcrprg 1.00:00:00 +``` + +Disable recommendation by recommendation name + +### Example 2: Disable recommendation by recommendation resource id +```powershell +Disable-AzAdvisorRecommendation -ResourceId /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/automanagehcrprg/providers/microsoft.compute/virtualmachines/arcbox-capi-mgmt/providers/Microsoft.Advisor/recommendations/42963553-61de-5334-2d2e-47f3a0099d41 -Day 1 +``` + +```output +SuppressionId Name Resource Group Ttl +------------- ---- -------------- --- +5b931ff3-42a3-5f80-797f-8e018a6dfaf5 HardcodedSuppressionName automanagehcrprg 1.00:00:00 +``` + +Disable recommendation by recommendation resource id + +## PARAMETERS + +### -Day +Days to disable. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The powershell object type PsAzureAdvisorResourceRecommendationBase returned by Get-AzAdvisorRecommendation call. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IAdvisorIdentity +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RecommendationName +ResourceName of the recommendation. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Id of the recommendation to be suppressed. + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IAdvisorIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase + +## 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 `: The powershell object type PsAzureAdvisorResourceRecommendationBase returned by Get-AzAdvisorRecommendation call. + - `[ConfigurationName ]`: Advisor configuration name. Value must be 'default' + - `[Id ]`: Resource identity path + - `[Name ]`: Name of metadata entity. + - `[OperationId ]`: The operation ID, which can be found from the Location field in the generate recommendation response header. + - `[RecommendationId ]`: The recommendation ID. + - `[ResourceGroup ]`: The name of the Azure resource group. + - `[ResourceUri ]`: The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. + - `[SubscriptionId ]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Advisor/Enable-AzAdvisorRecommendation.md b/azps-10.1.0/Az.Advisor/Enable-AzAdvisorRecommendation.md new file mode 100644 index 0000000000..90008eda86 --- /dev/null +++ b/azps-10.1.0/Az.Advisor/Enable-AzAdvisorRecommendation.md @@ -0,0 +1,206 @@ +--- +external help file: +Module Name: Az.Advisor +online version: https://learn.microsoft.com/powershell/module/az.advisor/Enable-AzAdvisorRecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Advisor/help/Enable-AzAdvisorRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Advisor/help/Enable-AzAdvisorRecommendation.md +--- + +# Enable-AzAdvisorRecommendation + +## SYNOPSIS +Enables Azure Advisor recommendation(s). + +## SYNTAX + +### IdParameterSet (Default) +``` +Enable-AzAdvisorRecommendation -ResourceId [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### InputObjectParameterSet +``` +Enable-AzAdvisorRecommendation -InputObject [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### NameParameterSet +``` +Enable-AzAdvisorRecommendation -RecommendationName [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Enables Azure Advisor recommendation(s). + +## EXAMPLES + +### Example 1: Enable recommendation by resource Id +```powershell +Enable-AzAdvisorRecommendation -ResourceId /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/automanagehcrprg/providers/microsoft.compute/virtualmachines/arcbox-capi-mgmt/providers/Microsoft.Advisor/recommendations/42963553-61de-5334-2d2e-47f3a0099d41 +``` + +```output +Name Category Resource Group Impact ImpactedField +---- -------- -------------- ------ ------------- +42963553-61de-5334-2d2e-47f3a0099d41 Security automanagehcrprg High Microsoft.Compute/virtualMachines +``` + +Enable recommendation by resource Id + +### Example 2: Enable recommendation byrecommendation name +```powershell +Enable-AzAdvisorRecommendation -RecommendationName 42963553-61de-5334-2d2e-47f3a0099d41 +``` + +```output +Name Category Resource Group Impact ImpactedField +---- -------- -------------- ------ ------------- +42963553-61de-5334-2d2e-47f3a0099d41 Security automanagehcrprg High Microsoft.Compute/virtualMachines +``` + +Enable recommendation byrecommendation name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The powershell object type PsAzureAdvisorResourceRecommendationBase returned by Get-AzAdvisorRecommendation call. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IAdvisorIdentity +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RecommendationName +ResourceName of the recommendation. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Id of the recommendation to be suppressed. + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IAdvisorIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase + +## 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 `: The powershell object type PsAzureAdvisorResourceRecommendationBase returned by Get-AzAdvisorRecommendation call. + - `[ConfigurationName ]`: Advisor configuration name. Value must be 'default' + - `[Id ]`: Resource identity path + - `[Name ]`: Name of metadata entity. + - `[OperationId ]`: The operation ID, which can be found from the Location field in the generate recommendation response header. + - `[RecommendationId ]`: The recommendation ID. + - `[ResourceGroup ]`: The name of the Azure resource group. + - `[ResourceUri ]`: The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. + - `[SubscriptionId ]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Advisor/Get-AzAdvisorConfiguration.md b/azps-10.1.0/Az.Advisor/Get-AzAdvisorConfiguration.md new file mode 100644 index 0000000000..2bc9c8a9e9 --- /dev/null +++ b/azps-10.1.0/Az.Advisor/Get-AzAdvisorConfiguration.md @@ -0,0 +1,120 @@ +--- +external help file: +Module Name: Az.Advisor +online version: https://learn.microsoft.com/powershell/module/az.advisor/get-azadvisorconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Advisor/help/Get-AzAdvisorConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Advisor/help/Get-AzAdvisorConfiguration.md +--- + +# Get-AzAdvisorConfiguration + +## SYNOPSIS +Retrieve Azure Advisor configurations and also retrieve configurations of contained resource groups. + +## SYNTAX + +### List (Default) +``` +Get-AzAdvisorConfiguration [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzAdvisorConfiguration -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve Azure Advisor configurations and also retrieve configurations of contained resource groups. + +## EXAMPLES + +### Example 1: Get Configuration by SubscriptionId +```powershell +Get-AzAdvisorConfiguration +``` + +```output +Name Exclude LowCpuThreshold +---- ------- --------------- +default False 10 +``` + +Get Configuration by SubscriptionId + +### Example 2: Get Configuration by ResourceGroupName +```powershell +Get-AzAdvisorConfiguration -ResourceGroupName lnxtest +``` + +```output +Name Exclude LowCpuThreshold +---- ------- --------------- +9e223dbe-3399-4e19-88eb-0975f02ac87f-lnxtest False +``` + +Get Configuration by ResourceGroupName + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Azure resource group. + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IConfigData + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Advisor/Get-AzAdvisorRecommendation.md b/azps-10.1.0/Az.Advisor/Get-AzAdvisorRecommendation.md new file mode 100644 index 0000000000..71df81f7c9 --- /dev/null +++ b/azps-10.1.0/Az.Advisor/Get-AzAdvisorRecommendation.md @@ -0,0 +1,266 @@ +--- +external help file: +Module Name: Az.Advisor +online version: https://learn.microsoft.com/powershell/module/az.advisor/Get-AzAdvisorRecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Advisor/help/Get-AzAdvisorRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Advisor/help/Get-AzAdvisorRecommendation.md +--- + +# Get-AzAdvisorRecommendation + +## SYNOPSIS +Obtains details of a cached recommendation. + +## SYNTAX + +### ListByFilter (Default) +``` +Get-AzAdvisorRecommendation [-SubscriptionId ] [-Filter ] [-DefaultProfile ] + [] +``` + +### GetById +``` +Get-AzAdvisorRecommendation -Id -ResourceUri [-DefaultProfile ] + [] +``` + +### GetViaIdentity1 +``` +Get-AzAdvisorRecommendation -InputObject [-DefaultProfile ] [] +``` + +### ListById +``` +Get-AzAdvisorRecommendation -ResourceId [-Category ] [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### ListByName +``` +Get-AzAdvisorRecommendation -ResourceGroupName [-Category ] [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Obtains details of a cached recommendation. + +## EXAMPLES + +### Example 1: List Recommendation by subscriptionId and resource group name +```powershell + Get-AzAdvisorRecommendation -ResourceGroupName lnxtest -Category HighAvailability +``` + +```output +Name Category Resource Group Impact ImpactedValue ImpactedField +---- -------- -------------- ------ ------------- ------------- +71411b72-e7de-9dc2-308b-5c60252e1456 HighAvailability lnxtest Medium lnxtest-vnet MICROSOFT.NETWORK/VIRTUALNETWORKS +bf8ebdfd-6caa-9f55-53ae-ffafefbf3a7c HighAvailability lnxtest Medium advisortest MICROSOFT.NETWORK/VIRTUALNETWORKS +339071fa-d66a-be4f-9cf8-22b67552b287 HighAvailability lnxtest Medium advisor-test MICROSOFT.NETWORK/VIRTUALNETWORKS +``` + +List Recommendation by subscriptionId + +### Example 2: List Recommendation by subscriptionId and filter +```powershell +Get-AzAdvisorRecommendation -filter "Category eq 'HighAvailability' and ResourceGroup eq 'lnxtest'" +``` + +```output +Name Category Resource Group Impact ImpactedValue ImpactedField +---- -------- -------------- ------ ------------- ------------- +71411b72-e7de-9dc2-308b-5c60252e1456 HighAvailability lnxtest Medium lnxtest-vnet MICROSOFT.NETWORK/VIRTUALNETWORKS +bf8ebdfd-6caa-9f55-53ae-ffafefbf3a7c HighAvailability lnxtest Medium advisortest MICROSOFT.NETWORK/VIRTUALNETWORKS +339071fa-d66a-be4f-9cf8-22b67552b287 HighAvailability lnxtest Medium advisor-test MICROSOFT.NETWORK/VIRTUALNETWORKS +``` + +List Recommendation by subscriptionId and filter + +### Example 3: Get Recommendation by Id and resource Id +```powershell +Get-AzAdvisorRecommendation -Id 42963553-61de-5334-2d2e-47f3a0099d41 -ResourceUri /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f +``` + +```output +Name Category Resource Group Impact ImpactedValue ImpactedField +---- -------- -------------- ------ ------------- ------------- +42963553-61de-5334-2d2e-47f3a0099d41 Security automanagehcrprg High arcbox-capi-mgmt Microsoft.Compute/virtualMachines +``` + +Get Recommendation by Id and resource Id + +## PARAMETERS + +### -Category +The category of recommendation. + +```yaml +Type: System.String +Parameter Sets: ListById, ListByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply to the recommendations. +Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', 'Category' with operators ['eq', 'and', 'or']. +Example: +- $filter=Category eq 'Cost' and ResourceGroup eq 'MyResourceGroup' + +```yaml +Type: System.String +Parameter Sets: ListByFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The recommendation ID. + +```yaml +Type: System.String +Parameter Sets: GetById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IAdvisorIdentity +Parameter Sets: GetViaIdentity1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id. + +```yaml +Type: System.String +Parameter Sets: ListById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. + +```yaml +Type: System.String +Parameter Sets: GetById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: ListByFilter, ListById, ListByName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IAdvisorIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase + +## 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 + - `[ConfigurationName ]`: Advisor configuration name. Value must be 'default' + - `[Id ]`: Resource identity path + - `[Name ]`: Name of metadata entity. + - `[OperationId ]`: The operation ID, which can be found from the Location field in the generate recommendation response header. + - `[RecommendationId ]`: The recommendation ID. + - `[ResourceGroup ]`: The name of the Azure resource group. + - `[ResourceUri ]`: The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. + - `[SubscriptionId ]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Advisor/Set-AzAdvisorConfiguration.md b/azps-10.1.0/Az.Advisor/Set-AzAdvisorConfiguration.md new file mode 100644 index 0000000000..22f669137f --- /dev/null +++ b/azps-10.1.0/Az.Advisor/Set-AzAdvisorConfiguration.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Advisor +online version: https://learn.microsoft.com/powershell/module/az.advisor/Set-AzAdvisorConfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Advisor/help/Set-AzAdvisorConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Advisor/help/Set-AzAdvisorConfiguration.md +--- + +# Set-AzAdvisorConfiguration + +## SYNOPSIS +Updates or creates the Azure Advisor Configuration. + +## SYNTAX + +### CreateByLCT (Default) +``` +Set-AzAdvisorConfiguration [-SubscriptionId ] [-Exclude] [-LowCpuThreshold ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateByInputObject +``` +Set-AzAdvisorConfiguration -InputObject [-Exclude] [-LowCpuThreshold ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateByRG +``` +Set-AzAdvisorConfiguration -ResourceGroupName [-SubscriptionId ] [-Exclude] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates or creates the Azure Advisor Configuration. + +## EXAMPLES + +### Example 1: Set advisor configuration by subscription id +```powershell +Set-AzAdvisorConfiguration -Exclude -LowCpuThreshold 20 +``` + +```output +Name Exclude LowCpuThreshold +---- ------- --------------- +default True 20 +``` + +Set advisor configuration by subscription id + +### Example 2: Set advisor configuration by resource group name +```powershell +Set-AzAdvisorConfiguration -Exclude +``` + +```output +Name Exclude LowCpuThreshold +---- ------- --------------- +default True +``` + +Set advisor configuration by resource group name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exclude +Exclude the resource from Advisor evaluations. +Valid values: False (default) or True. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IAdvisorIdentity +Parameter Sets: CreateByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LowCpuThreshold +Minimum percentage threshold for Advisor low CPU utilization evaluation. +Valid only for subscriptions. +Valid values: 5 (default), 10, 15 or 20. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Advisor.Support.CpuThreshold +Parameter Sets: CreateByInputObject, CreateByLCT +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Azure resource group. + +```yaml +Type: System.String +Parameter Sets: CreateByRG +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: CreateByLCT, CreateByRG +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IAdvisorIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IConfigData + +## 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 + - `[ConfigurationName ]`: Advisor configuration name. Value must be 'default' + - `[Id ]`: Resource identity path + - `[Name ]`: Name of metadata entity. + - `[OperationId ]`: The operation ID, which can be found from the Location field in the generate recommendation response header. + - `[RecommendationId ]`: The recommendation ID. + - `[ResourceGroup ]`: The name of the Azure resource group. + - `[ResourceUri ]`: The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. + - `[SubscriptionId ]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Aks/Az.Aks.md b/azps-10.1.0/Az.Aks/Az.Aks.md new file mode 100644 index 0000000000..9a09d8288f --- /dev/null +++ b/azps-10.1.0/Az.Aks/Az.Aks.md @@ -0,0 +1,138 @@ +--- +Module Name: Az.Aks +Module Guid: a97e0c3e-e389-46a6-b73d-2b9bd6909bdb +Download Help Link: https://learn.microsoft.com/powershell/module/az.aks +Help Version: 0.0.1.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Az.Aks.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Az.Aks.md +--- + +# Az.Aks Module +## Description +Commands to interact with Azure managed Kubernetes clusters. + +## Az.Aks Cmdlets +### [Disable-AzAksAddOn](Disable-AzAksAddOn.md) +Disable the addons for aks. + +### [Enable-AzAksAddOn](Enable-AzAksAddOn.md) +Enable the addons for aks. + +### [Get-AzAksCluster](Get-AzAksCluster.md) +List Kubernetes managed clusters. + +### [Get-AzAksMaintenanceConfiguration](Get-AzAksMaintenanceConfiguration.md) +Gets the specified maintenance configuration of a managed cluster. + +### [Get-AzAksManagedClusterCommandResult](Get-AzAksManagedClusterCommandResult.md) +Gets the results of a command which has been run on the Managed Cluster. + +### [Get-AzAksManagedClusterOSOption](Get-AzAksManagedClusterOSOption.md) +Gets supported OS options in the specified subscription. + +### [Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint](Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint.md) +Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. +The operation returns properties of each egress endpoint. + +### [Get-AzAksNodePool](Get-AzAksNodePool.md) +List node pools in specified cluster. + +### [Get-AzAksNodePoolUpgradeProfile](Get-AzAksNodePoolUpgradeProfile.md) +Gets the upgrade profile for an agent pool. + +### [Get-AzAksSnapshot](Get-AzAksSnapshot.md) +Gets a snapshot. + +### [Get-AzAksUpgradeProfile](Get-AzAksUpgradeProfile.md) +Gets the upgrade profile of a managed cluster. + +### [Get-AzAksVersion](Get-AzAksVersion.md) +List available version for creating managed Kubernetes cluster. +The operation returns properties of each orchestrator including version, available upgrades and whether that version or upgrades are in preview. + +### [Import-AzAksCredential](Import-AzAksCredential.md) +Import and merge Kubectl config for a managed Kubernetes Cluster. + +### [Install-AzAksCliTool](Install-AzAksCliTool.md) +Download and install kubectl and kubelogin. + +### [Invoke-AzAksAbortAgentPoolLatestOperation](Invoke-AzAksAbortAgentPoolLatestOperation.md) +Aborts the currently running operation on the agent pool. +The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. +If the operation completes before cancellation can take place, a 409 error code is returned. + +### [Invoke-AzAksAbortManagedClusterLatestOperation](Invoke-AzAksAbortManagedClusterLatestOperation.md) +Aborts the currently running operation on the managed cluster. +The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. +If the operation completes before cancellation can take place, a 409 error code is returned. + +### [Invoke-AzAksRotateManagedClusterServiceAccountSigningKey](Invoke-AzAksRotateManagedClusterServiceAccountSigningKey.md) +Rotates the service account signing keys of a managed cluster. + +### [Invoke-AzAksRunCommand](Invoke-AzAksRunCommand.md) +Run a shell command (with kubectl, helm) on your aks cluster, support attaching files as well. + +### [New-AzAksCluster](New-AzAksCluster.md) +Create a new managed Kubernetes cluster. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- POST /servicePrincipals + +### [New-AzAksMaintenanceConfiguration](New-AzAksMaintenanceConfiguration.md) +Creates or updates a maintenance configuration in the specified managed cluster. + +### [New-AzAksNodePool](New-AzAksNodePool.md) +Create a new node pool in specified cluster. + +### [New-AzAksSnapshot](New-AzAksSnapshot.md) +Creates or updates a snapshot. + +### [New-AzAksTimeInWeekObject](New-AzAksTimeInWeekObject.md) +Create an in-memory object for TimeInWeek. + +### [New-AzAksTimeSpanObject](New-AzAksTimeSpanObject.md) +Create an in-memory object for TimeSpan. + +### [Remove-AzAksCluster](Remove-AzAksCluster.md) +Delete a managed Kubernetes cluster. + +### [Remove-AzAksMaintenanceConfiguration](Remove-AzAksMaintenanceConfiguration.md) +Deletes a maintenance configuration. + +### [Remove-AzAksNodePool](Remove-AzAksNodePool.md) +Delete node pool from managed cluster. + +### [Remove-AzAksSnapshot](Remove-AzAksSnapshot.md) +Deletes a snapshot. + +### [Set-AzAksCluster](Set-AzAksCluster.md) +Update or create a managed Kubernetes cluster. + +### [Set-AzAksClusterCredential](Set-AzAksClusterCredential.md) +Reset the ServicePrincipal of an existing AKS cluster. + +### [Start-AzAksCluster](Start-AzAksCluster.md) +See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster. + +### [Start-AzAksDashboard](Start-AzAksDashboard.md) +Create a Kubectl SSH tunnel to the managed cluster's dashboard. + +### [Start-AzAksManagedClusterCommand](Start-AzAksManagedClusterCommand.md) +AKS will create a pod to run the command. +This is primarily useful for private clusters. +For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview). + +### [Stop-AzAksCluster](Stop-AzAksCluster.md) +This can only be performed on Azure Virtual Machine Scale set backed clusters. +Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. +A cluster does not accrue charges while it is stopped. +See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster. + +### [Stop-AzAksDashboard](Stop-AzAksDashboard.md) +Stop the Kubectl SSH tunnel created in Start-AzKubernetesDashboard. + +### [Update-AzAksNodePool](Update-AzAksNodePool.md) +Update node pool in a managed cluster. + diff --git a/azps-10.1.0/Az.Aks/Disable-AzAksAddOn.md b/azps-10.1.0/Az.Aks/Disable-AzAksAddOn.md new file mode 100644 index 0000000000..a41f3632ea --- /dev/null +++ b/azps-10.1.0/Az.Aks/Disable-AzAksAddOn.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/disable-azaksaddon +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Disable-AzAksAddOn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Disable-AzAksAddOn.md +--- + +# Disable-AzAksAddOn + +## SYNOPSIS +Disable the addons for aks. + +## SYNTAX + +### defaultParameterSet (Default) +``` +Disable-AzAksAddOn [-ResourceGroupName] [-ClusterName] [-Name ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +### InputObjectParameterSet +``` +Disable-AzAksAddOn -ClusterObject [-Name ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +## DESCRIPTION +Disable the addons for aks. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAksCluster -ResourceGroupName group -Name myCluster | Disable-AzAksAddon -Name HttpApplicationRouting,Monitoring,AzurePolicy,VirtualNode,KubeDashboard +``` + +Disable the addons `HttpApplicationRouting`, `Monitoring`, `AzurePolicy`, `VirtualNode` and `KubeDashboard` for aks. + +## PARAMETERS + +### -ClusterName +Kubernetes managed cluster Name. + +```yaml +Type: System.String +Parameter Sets: defaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterObject +A PSKubernetesCluster object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Kubernetes managed cluster Name. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: defaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Enable-AzAksAddOn.md b/azps-10.1.0/Az.Aks/Enable-AzAksAddOn.md new file mode 100644 index 0000000000..1ad0c94729 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Enable-AzAksAddOn.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/enable-azaksaddon +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Enable-AzAksAddOn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Enable-AzAksAddOn.md +--- + +# Enable-AzAksAddOn + +## SYNOPSIS +Enable the addons for aks. + +## SYNTAX + +### defaultParameterSet (Default) +``` +Enable-AzAksAddOn [-WorkspaceResourceId ] [-SubnetName ] [-ResourceGroupName] + [-ClusterName] [-Name ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [-SubscriptionId ] [] +``` + +### InputObjectParameterSet +``` +Enable-AzAksAddOn [-WorkspaceResourceId ] [-SubnetName ] -ClusterObject + [-Name ] [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +## DESCRIPTION +Enable the addons for aks. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAksCluster -ResourceGroupName group -Name myCluster | Enable-AzAksAddon -Name HttpApplicationRouting,Monitoring,AzurePolicy,VirtualNode,KubeDashboard -WorkspaceResourceId xxxxx/xxxx -SubnetName subnet +``` + +Enable the addons `HttpApplicationRouting`, `Monitoring`, `AzurePolicy`, `VirtualNode` and `KubeDashboard` for aks. + +## PARAMETERS + +### -ClusterName +Kubernetes managed cluster Name. + +```yaml +Type: System.String +Parameter Sets: defaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterObject +A PSKubernetesCluster object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Kubernetes managed cluster Name. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: defaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetName +Subnet name of VirtualNode. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +Resource Id of the workspace of Monitoring. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +## OUTPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Get-AzAksCluster.md b/azps-10.1.0/Az.Aks/Get-AzAksCluster.md new file mode 100644 index 0000000000..7e4693bcae --- /dev/null +++ b/azps-10.1.0/Az.Aks/Get-AzAksCluster.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azakscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksCluster.md +--- + +# Get-AzAksCluster + +## SYNOPSIS +List Kubernetes managed clusters. + +## SYNTAX + +### ResourceGroupParameterSet (Default) +``` +Get-AzAksCluster [[-ResourceGroupName] ] [-DefaultProfile ] + [-SubscriptionId ] [] +``` + +### IdParameterSet +``` +Get-AzAksCluster [-Id] [-DefaultProfile ] [-SubscriptionId ] + [] +``` + +### NameParameterSet +``` +Get-AzAksCluster [-ResourceGroupName] [-Name] [-DefaultProfile ] + [-SubscriptionId ] [] +``` + +## DESCRIPTION +List Kubernetes managed clusters. + +## EXAMPLES + +### List all Kubernetes clusters +```powershell +Get-AzAksCluster +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of a managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of your managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Get-AzAksMaintenanceConfiguration.md b/azps-10.1.0/Az.Aks/Get-AzAksMaintenanceConfiguration.md new file mode 100644 index 0000000000..3dd61ed762 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Get-AzAksMaintenanceConfiguration.md @@ -0,0 +1,209 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azaksmaintenanceconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksMaintenanceConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksMaintenanceConfiguration.md +--- + +# Get-AzAksMaintenanceConfiguration + +## SYNOPSIS +Gets the specified maintenance configuration of a managed cluster. + +## SYNTAX + +### List (Default) +``` +Get-AzAksMaintenanceConfiguration -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAksMaintenanceConfiguration -ConfigName -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAksMaintenanceConfiguration -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the specified maintenance configuration of a managed cluster. + +## EXAMPLES + +### Example 1: List all maintenance configurations for a managed cluster +```powershell +Get-AzAksMaintenanceConfiguration -ResourceGroupName mygroup -ResourceName myCluster +``` + +```output +Name +---- +aks_maintenance_config1 +aks_maintenance_config2 +``` + +List all maintenance configurations for a managed cluster "myCluster". + +### Example 2: Get a maintenance configuration with its config name +```powershell +Get-AzAksMaintenanceConfiguration -ResourceGroupName mygroup -ResourceName myCluster -ConfigName 'aks_maintenance_config' +``` + +```output +Name +---- +aks_maintenance_config1 +``` + +Get a maintenance configuration with name "aks_maintenance_config" for a managed cluster "myCluster". + +### Example 3: Get a maintenance configuration via identity +```powershell +$TimeSpan = New-AzAksTimeSpanObject -Start (Get-Date -Year 2023 -Month 3 -Day 1) -End (Get-Date -Year 2023 -Month 3 -Day 2) +$TimeInWeek = New-AzAksTimeInWeekObject -Day 'Sunday' -HourSlot 1,2 +$MaintenanceConfig = New-AzAksMaintenanceConfiguration -ResourceGroupName mygroup -ResourceName myCluster -ConfigName 'aks_maintenance_config' -TimeInWeek $TimeInWeek -NotAllowedTime $TimeSpan +$MaintenanceConfig | Get-AzAksMaintenanceConfiguration +``` + +```output +Name +---- +aks_maintenance_config +``` + +Get a maintenance configuration via identity for a managed cluster "myCluster". + +## PARAMETERS + +### -ConfigName +The name of the maintenance configuration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.IMaintenanceConfiguration + +## 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 + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Get-AzAksManagedClusterCommandResult.md b/azps-10.1.0/Az.Aks/Get-AzAksManagedClusterCommandResult.md new file mode 100644 index 0000000000..9983f06538 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Get-AzAksManagedClusterCommandResult.md @@ -0,0 +1,194 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azaksmanagedclustercommandresult +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksManagedClusterCommandResult.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksManagedClusterCommandResult.md +--- + +# Get-AzAksManagedClusterCommandResult + +## SYNOPSIS +Gets the results of a command which has been run on the Managed Cluster. + +## SYNTAX + +### Get (Default) +``` +Get-AzAksManagedClusterCommandResult -CommandId -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [] +``` + +### GetViaIdentity +``` +Get-AzAksManagedClusterCommandResult -InputObject [-DefaultProfile ] [-PassThru] + [] +``` + +## DESCRIPTION +Gets the results of a command which has been run on the Managed Cluster. + +## EXAMPLES + +### Example 1: Get the results of a command which has been run on the Managed Cluster. +```powershell +Get-AzAksManagedClusterCommandResult -ResourceGroupName mygroup -ResourceName mycluster -CommandId '706de66629b14267b4962cf015122c12' +``` + +```output +ExitCode : 0 +FinishedAt : 3/31/2023 9:14:40 AM +Id : 706de66629b14267b4962cf015122c12 +Log : NAME STATUS ROLES AGE VERSION + aks-default-40136599-vmss000000 Ready agent 68m v1.24.9 + aks-pool2-22198594-vmss000000 Ready agent 65m v1.24.9 + +ProvisioningState : Succeeded +Reason : +StartedAt : 3/31/2023 9:14:38 AM +``` + +## PARAMETERS + +### -CommandId +Id of the command. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.IRunCommandResult + +## 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 + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Get-AzAksManagedClusterOSOption.md b/azps-10.1.0/Az.Aks/Get-AzAksManagedClusterOSOption.md new file mode 100644 index 0000000000..5bd036e3cb --- /dev/null +++ b/azps-10.1.0/Az.Aks/Get-AzAksManagedClusterOSOption.md @@ -0,0 +1,156 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azaksmanagedclusterosoption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksManagedClusterOSOption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksManagedClusterOSOption.md +--- + +# Get-AzAksManagedClusterOSOption + +## SYNOPSIS +Gets supported OS options in the specified subscription. + +## SYNTAX + +### Get (Default) +``` +Get-AzAksManagedClusterOSOption -Location [-SubscriptionId ] [-ResourceType ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAksManagedClusterOSOption -InputObject [-ResourceType ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets supported OS options in the specified subscription. + +## EXAMPLES + +### Example 1: Get supported OS options +```powershell +Get-AzAksManagedClusterOSOption -Location eastus +``` + +```output +Name +---- +default +``` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The name of Azure region. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +The resource type for which the OS options needs to be returned + +```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. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.IOSOptionProfile + +## 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 + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint.md b/azps-10.1.0/Az.Aks/Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint.md new file mode 100644 index 0000000000..53002e1b2b --- /dev/null +++ b/azps-10.1.0/Az.Aks/Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint.md @@ -0,0 +1,123 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azaksmanagedclusteroutboundnetworkdependencyendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint.md +--- + +# Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint + +## SYNOPSIS +Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. +The operation returns properties of each egress endpoint. + +## SYNTAX + +``` +Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. +The operation returns properties of each egress endpoint. + +## EXAMPLES + +### Example 1: List egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster +```powershell +$result = Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint -ResourceGroupName mygroup -ResourceName mycluster +$result | select Category,Endpoint +``` + +```output +Category Endpoint +-------- -------- +azure-resource-management {management.azure.com, login.microsoftonline.com} +images {mcr.microsoft.com, *.data.mcr.microsoft.com} +artifacts {packages.microsoft.com, acs-mirror.azureedge.net} +time-sync {ntp.ubuntu.com} +ubuntu-optional {security.ubuntu.com, azure.archive.ubuntu.com, changelogs.ubuntu.com} +apiserver {aks0b1f-idb7vuoi.hcp.eastus.azmk8s.io} +``` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.IOutboundEnvironmentEndpoint + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Get-AzAksNodePool.md b/azps-10.1.0/Az.Aks/Get-AzAksNodePool.md new file mode 100644 index 0000000000..f083141c85 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Get-AzAksNodePool.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azaksnodepool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksNodePool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksNodePool.md +--- + +# Get-AzAksNodePool + +## SYNOPSIS +List node pools in specified cluster. + +## SYNTAX + +### NameParameterSet (Default) +``` +Get-AzAksNodePool -ResourceGroupName -ClusterName [-Name ] + [-DefaultProfile ] [-SubscriptionId ] [] +``` + +### IdParameterSet +``` +Get-AzAksNodePool -Id [-DefaultProfile ] [-SubscriptionId ] + [] +``` + +### ParentObjectParameterSet +``` +Get-AzAksNodePool -ClusterObject [-Name ] + [-DefaultProfile ] [-SubscriptionId ] [] +``` + +## DESCRIPTION +List node pools in specified cluster. + +## EXAMPLES + +### Get all node pools within specified cluster +```powershell +Get-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myCluster +``` + +## PARAMETERS + +### -ClusterName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterObject +The cluster object. + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of an node pool in managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the node pool. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet, ParentObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSNodePool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Get-AzAksNodePoolUpgradeProfile.md b/azps-10.1.0/Az.Aks/Get-AzAksNodePoolUpgradeProfile.md new file mode 100644 index 0000000000..af6e6b6b2e --- /dev/null +++ b/azps-10.1.0/Az.Aks/Get-AzAksNodePoolUpgradeProfile.md @@ -0,0 +1,173 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azaksnodepoolupgradeprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksNodePoolUpgradeProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksNodePoolUpgradeProfile.md +--- + +# Get-AzAksNodePoolUpgradeProfile + +## SYNOPSIS +Gets the upgrade profile for an agent pool. + +## SYNTAX + +### Get (Default) +``` +Get-AzAksNodePoolUpgradeProfile -ClusterName -NodePoolName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAksNodePoolUpgradeProfile -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the upgrade profile for an agent pool. + +## EXAMPLES + +### Example 1: Get Aks node pool upgrade profile with resource group name and cluster name +```powershell +Get-AzAksNodePoolUpgradeProfile -ResourceGroupName group -ClusterName myCluster -AgentPoolName default +``` + +```output +Name Type +---- ---- +default Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles +``` + +Get Aks node pool upgrade profile with resource group name and cluster name. + +## PARAMETERS + +### -ClusterName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NodePoolName +The name of the agent pool. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AgentPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.IAgentPoolUpgradeProfile + +## 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 + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Get-AzAksSnapshot.md b/azps-10.1.0/Az.Aks/Get-AzAksSnapshot.md new file mode 100644 index 0000000000..3289fc67d9 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Get-AzAksSnapshot.md @@ -0,0 +1,205 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azakssnapshot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksSnapshot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksSnapshot.md +--- + +# Get-AzAksSnapshot + +## SYNOPSIS +Gets a snapshot. + +## SYNTAX + +### List (Default) +``` +Get-AzAksSnapshot [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzAksSnapshot -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzAksSnapshot -ResourceGroupName -ResourceName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAksSnapshot -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets a snapshot. + +## EXAMPLES + +### Example 1: List all AKS snapshots +```powershell +Get-AzAksSnapshot +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +eastus snapshot1 3/30/2023 10:09:35 AM user1@microsoft.com User 3/30/2023 10:09:35 AM user1@microsoft.com User +eastus snapshot2 3/30/2023 10:09:38 AM user1@microsoft.com User 3/30/2023 10:09:38 AM user1@microsoft.com User +eastus snapshot3 3/30/2023 10:11:24 AM user1@microsoft.com User 3/30/2023 10:11:24 AM user1@microsoft.com User +``` + +### Example 2: List all AKS snapshots in a resource group +```powershell +Get-AzAksSnapshot -ResourceGroupName mygroup +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +eastus snapshot1 3/30/2023 10:09:35 AM user1@microsoft.com User 3/30/2023 10:09:35 AM user1@microsoft.com User +eastus snapshot2 3/30/2023 10:09:38 AM user1@microsoft.com User 3/30/2023 10:09:38 AM user1@microsoft.com User +``` + +### Example 3: Get an AKS snapshot +```powershell +Get-AzAksSnapshot -ResourceGroupName mygroup -ResourceName 'snapshot1' +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +eastus snapshot1 3/30/2023 10:09:35 AM user1@microsoft.com User 3/30/2023 10:09:35 AM user1@microsoft.com User +``` + +### Example 4: Get an AKS snapshot via identity +```powershell +$pool = Get-AzAksNodePool -ResourceGroupName mygroup -ClusterName mycluster -Name default +$Snapshot = New-AzAksSnapshot -ResourceGroupName mygroup -ResourceName 'snapshot1' -Location eastus -SnapshotType 'NodePool' -CreationDataSourceResourceId $pool.Id +$Snapshot | Get-AzAksSnapshot +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +eastus snapshot1 3/30/2023 10:09:35 AM user1@microsoft.com User 3/30/2023 10:09:35 AM user1@microsoft.com User +``` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List1, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: List, List1, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.ISnapshot + +## 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 + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Get-AzAksUpgradeProfile.md b/azps-10.1.0/Az.Aks/Get-AzAksUpgradeProfile.md new file mode 100644 index 0000000000..b29b298bc8 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Get-AzAksUpgradeProfile.md @@ -0,0 +1,160 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azaksupgradeprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksUpgradeProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksUpgradeProfile.md +--- + +# Get-AzAksUpgradeProfile + +## SYNOPSIS +Gets the upgrade profile of a managed cluster. + +## SYNTAX + +### Get (Default) +``` +Get-AzAksUpgradeProfile -ClusterName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAksUpgradeProfile -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the upgrade profile of a managed cluster. + +## EXAMPLES + +### Example 1: Get Aks upgrade profile with resource group name and cluster name +```powershell +Get-AzAksUpgradeProfile -ResourceGroupName group -Name myCluster +``` + +```output +Name Type +---- ---- +default Microsoft.ContainerService/managedClusters/upgradeprofiles +``` + +Get Aks upgrade profile with resource group name and cluster name. + +## PARAMETERS + +### -ClusterName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.IManagedClusterUpgradeProfile + +## NOTES + +ALIASES + +Get-AzAksClusterUpgradeProfile + +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 + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Get-AzAksVersion.md b/azps-10.1.0/Az.Aks/Get-AzAksVersion.md new file mode 100644 index 0000000000..8d562a8f8f --- /dev/null +++ b/azps-10.1.0/Az.Aks/Get-AzAksVersion.md @@ -0,0 +1,110 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azaksversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Get-AzAksVersion.md +--- + +# Get-AzAksVersion + +## SYNOPSIS +List available version for creating managed Kubernetes cluster. +The operation returns properties of each orchestrator including version, available upgrades and whether that version or upgrades are in preview. + +## SYNTAX + +``` +Get-AzAksVersion -Location [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +List available version for creating managed Kubernetes cluster. +The operation returns properties of each orchestrator including version, available upgrades and whether that version or upgrades are in preview. + +## EXAMPLES + +### Example 1: List available version for creating managed Kubernetes cluster +```powershell +Get-AzAksVersion -location eastus +``` + +```output +Default IsPreview OrchestratorType OrchestratorVersion +------- --------- ---------------- ------------------- + Kubernetes 1.19.11 + Kubernetes 1.19.13 + Kubernetes 1.20.7 +True Kubernetes 1.20.9 + Kubernetes 1.21.1 + Kubernetes 1.21.2 + True Kubernetes 1.22.1 + True Kubernetes 1.22.2 +``` + +List available version for creating managed Kubernetes cluster. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The name of a supported Azure region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20190801.IOrchestratorVersionProfileListResult + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Import-AzAksCredential.md b/azps-10.1.0/Az.Aks/Import-AzAksCredential.md new file mode 100644 index 0000000000..8da5f7732b --- /dev/null +++ b/azps-10.1.0/Az.Aks/Import-AzAksCredential.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/import-azakscredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Import-AzAksCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Import-AzAksCredential.md +--- + +# Import-AzAksCredential + +## SYNOPSIS +Import and merge Kubectl config for a managed Kubernetes Cluster. + +## SYNTAX + +### GroupNameParameterSet (Default) +``` +Import-AzAksCredential [-ResourceGroupName] [-Name] [-Admin] [-ConfigPath ] + [-PublicFqdn] [-Force] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [-SubscriptionId ] [] +``` + +### InputObjectParameterSet +``` +Import-AzAksCredential -InputObject [-Admin] [-ConfigPath ] [-PublicFqdn] + [-Force] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [-SubscriptionId ] [] +``` + +### IdParameterSet +``` +Import-AzAksCredential [-Id] [-Admin] [-ConfigPath ] [-PublicFqdn] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +## DESCRIPTION +Import and merge Kubectl config for a managed Kubernetes Cluster. + +## EXAMPLES + +### Import and merge Kubectl config +```powershell +Import-AzAksCredential -ResourceGroupName group -Name myCluster +``` + +## PARAMETERS + +### -Admin +Get the 'clusterAdmin' kubectl config instead of the default 'clusterUser'. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigPath +A kubectl config file to create or update. +Use '-' to print YAML to stdout instead. +Default: %Home%/.kube/config. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Import Kubernetes config even if it is the default + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of a managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +A PSKubernetesCluster object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of your managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: GroupNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true if import is successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicFqdn +Get private cluster credential with server address to be public fqdn. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: GroupNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Install-AzAksCliTool.md b/azps-10.1.0/Az.Aks/Install-AzAksCliTool.md new file mode 100644 index 0000000000..e63dc889de --- /dev/null +++ b/azps-10.1.0/Az.Aks/Install-AzAksCliTool.md @@ -0,0 +1,225 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/install-azaksclitool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Install-AzAksCliTool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Install-AzAksCliTool.md +--- + +# Install-AzAksCliTool + +## SYNOPSIS +Download and install kubectl and kubelogin. + +## SYNTAX + +``` +Install-AzAksCliTool [-Destination ] [-Version ] [-DownloadFromMirror] + [-KubeloginInstallDestination ] [-KubeloginInstallVersion ] [-KubeloginDownloadFromMirror] + [-PassThru] [-AsJob] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Download and install kubectl and kubelogin. + +## EXAMPLES + +### Example 1: Install the lateset version of kubectl and kubelogin +```powershell +Install-AzAksCliTool +``` + +### Example 2: Install the special version of kubectl and kubelogin into custom folder +```powershell +Install-AzAksCliTool -KubectlInstallVersion "v1.25.0" -KubectlInstallDestination "~/bin/" -KubeloginInstallVersion "v0.0.20" -KubeloginInstallDestination "~/bin" +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +Path at which to install kubectl. +Default to install into ~/.azure-kubectl/ + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: KubectlInstallDestination + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DownloadFromMirror +Download from mirror site : https://mirror.azure.cn/kubernetes/kubectl/ + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: KubectlDownloadFromMirror + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrite existing kubectl and kubelogin without prompt + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KubeloginDownloadFromMirror +Download from mirror site : https://mirror.azure.cn/kubernetes/kubelogin + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KubeloginInstallDestination +Path at which to install kubectl. +Default to install into ~/.azure-kubelogin/ + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KubeloginInstallVersion +Version of kubectl to install, e.g. +'v0.0.20'. +Default value: Latest + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Wait for .NET debugger to attach + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version of kubectl to install, e.g. +'v1.17.2'. +Default value: Latest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: KubectlInstallVersion + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Invoke-AzAksAbortAgentPoolLatestOperation.md b/azps-10.1.0/Az.Aks/Invoke-AzAksAbortAgentPoolLatestOperation.md new file mode 100644 index 0000000000..ad1c5bba03 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Invoke-AzAksAbortAgentPoolLatestOperation.md @@ -0,0 +1,251 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/invoke-azaksabortagentpoollatestoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Invoke-AzAksAbortAgentPoolLatestOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Invoke-AzAksAbortAgentPoolLatestOperation.md +--- + +# Invoke-AzAksAbortAgentPoolLatestOperation + +## SYNOPSIS +Aborts the currently running operation on the agent pool. +The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. +If the operation completes before cancellation can take place, a 409 error code is returned. + +## SYNTAX + +### Abort (Default) +``` +Invoke-AzAksAbortAgentPoolLatestOperation -AgentPoolName -ResourceGroupName + -ResourceName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### AbortViaIdentity +``` +Invoke-AzAksAbortAgentPoolLatestOperation -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Aborts the currently running operation on the agent pool. +The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. +If the operation completes before cancellation can take place, a 409 error code is returned. + +## EXAMPLES + +### Example 1: Abort the currently running operation on the agent pool +```powershell +Invoke-AzAksAbortAgentPoolLatestOperation -ResourceGroupName mygroup -ResourceName mycluster -AgentPoolName 'pool1' +``` + +Abort the currently running operation on the agent pool "pool1". +The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. +If the operation completes before cancellation can take place, a 409 error code is returned. + +## PARAMETERS + +### -AgentPoolName +The name of the agent pool. + +```yaml +Type: System.String +Parameter Sets: Abort +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: AbortViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Abort +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: Abort +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Abort +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Invoke-AzAksAbortManagedClusterLatestOperation.md b/azps-10.1.0/Az.Aks/Invoke-AzAksAbortManagedClusterLatestOperation.md new file mode 100644 index 0000000000..a9de146a37 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Invoke-AzAksAbortManagedClusterLatestOperation.md @@ -0,0 +1,236 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/invoke-azaksabortmanagedclusterlatestoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Invoke-AzAksAbortManagedClusterLatestOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Invoke-AzAksAbortManagedClusterLatestOperation.md +--- + +# Invoke-AzAksAbortManagedClusterLatestOperation + +## SYNOPSIS +Aborts the currently running operation on the managed cluster. +The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. +If the operation completes before cancellation can take place, a 409 error code is returned. + +## SYNTAX + +### Abort (Default) +``` +Invoke-AzAksAbortManagedClusterLatestOperation -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### AbortViaIdentity +``` +Invoke-AzAksAbortManagedClusterLatestOperation -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Aborts the currently running operation on the managed cluster. +The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. +If the operation completes before cancellation can take place, a 409 error code is returned. + +## EXAMPLES + +### Example 1: Abort the currently running operation on the managed cluster. +```powershell +Invoke-AzAksAbortManagedClusterLatestOperation -ResourceGroupName mygroup -ResourceName mycluster +``` + +Abort the currently running operation on the managed cluster "mycluster". +The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. +If the operation completes before cancellation can take place, a 409 error code is returned. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: AbortViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Abort +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: Abort +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Abort +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Invoke-AzAksRotateManagedClusterServiceAccountSigningKey.md b/azps-10.1.0/Az.Aks/Invoke-AzAksRotateManagedClusterServiceAccountSigningKey.md new file mode 100644 index 0000000000..5b17b8113d --- /dev/null +++ b/azps-10.1.0/Az.Aks/Invoke-AzAksRotateManagedClusterServiceAccountSigningKey.md @@ -0,0 +1,228 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/invoke-azaksrotatemanagedclusterserviceaccountsigningkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Invoke-AzAksRotateManagedClusterServiceAccountSigningKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Invoke-AzAksRotateManagedClusterServiceAccountSigningKey.md +--- + +# Invoke-AzAksRotateManagedClusterServiceAccountSigningKey + +## SYNOPSIS +Rotates the service account signing keys of a managed cluster. + +## SYNTAX + +### Rotate (Default) +``` +Invoke-AzAksRotateManagedClusterServiceAccountSigningKey -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### RotateViaIdentity +``` +Invoke-AzAksRotateManagedClusterServiceAccountSigningKey -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Rotates the service account signing keys of a managed cluster. + +## EXAMPLES + +### Example 1: Rotates the service account signing keys of a managed cluster +```powershell +Invoke-AzAksRotateManagedClusterServiceAccountSigningKey -ResourceGroupName mygroup -ResourceName mycluster +``` + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: RotateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Rotate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: Rotate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Rotate +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Invoke-AzAksRunCommand.md b/azps-10.1.0/Az.Aks/Invoke-AzAksRunCommand.md new file mode 100644 index 0000000000..f849c52098 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Invoke-AzAksRunCommand.md @@ -0,0 +1,282 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/invoke-azaksruncommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Invoke-AzAksRunCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Invoke-AzAksRunCommand.md +--- + +# Invoke-AzAksRunCommand + +## SYNOPSIS +Run a shell command (with kubectl, helm) on your aks cluster, support attaching files as well. + +## SYNTAX + +### GroupNameParameterSet (Default) +``` +Invoke-AzAksRunCommand [-ResourceGroupName] [-Name] -Command + [-CommandContextAttachment ] [-CommandContextAttachmentZip ] [-AsJob] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +### InputObjectParameterSet +``` +Invoke-AzAksRunCommand -InputObject -Command + [-CommandContextAttachment ] [-CommandContextAttachmentZip ] [-AsJob] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +### IdParameterSet +``` +Invoke-AzAksRunCommand [-Id] -Command [-CommandContextAttachment ] + [-CommandContextAttachmentZip ] [-AsJob] [-Force] [-DefaultProfile ] [-WhatIf] + [-Confirm] [-SubscriptionId ] [] +``` + +## DESCRIPTION +Run a shell command (with kubectl, helm) on your aks cluster, support attaching files as well. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzAksRunCommand -ResourceGroupName $resourceGroup -Name $clusterName -Command "kubectl get pods" +``` + +```output +Id : a887ecf432ad4e22a517cf4b5fb4e194 +ProvisioningState : Succeeded +ExitCode : 0 +StartedAt : 11/24/2021 04:43:28 +FinishedAt : 11/24/2021 04:43:30 +Logs : No resources found in default namespace. + +Reason : +``` + +Get the pods in Aks cluster. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Command +Gets or sets the command to run. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandContextAttachment +Gets or sets a base64 encoded zip file containing the files required by the command. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandContextAttachmentZip +Path of the zip file containing the files required by the command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Execute the command without confirm + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of a managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +A PSKubernetesCluster object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of your managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: GroupNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: GroupNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. + +By default, cmdlets are executed in the subscription that is set in the current context. +If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. + +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. +It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSRunCommandResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/New-AzAksCluster.md b/azps-10.1.0/Az.Aks/New-AzAksCluster.md new file mode 100644 index 0000000000..d9c2a1f9c8 --- /dev/null +++ b/azps-10.1.0/Az.Aks/New-AzAksCluster.md @@ -0,0 +1,1454 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/new-azakscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/New-AzAksCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/New-AzAksCluster.md +--- + +# New-AzAksCluster + +## SYNOPSIS +Create a new managed Kubernetes cluster. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- POST /servicePrincipals + +## SYNTAX + +``` +New-AzAksCluster [-NodeVmSetType ] [-NodeVnetSubnetID ] [-NodeMaxPodCount ] + [-NodeSetPriority ] [-NodePoolMode ] [-NodeOsSKU ] + [-NodeScaleSetEvictionPolicy ] [-AddOnNameToBeEnabled ] [-WorkspaceResourceId ] + [-SubnetName ] [-EnableRbac] [-WindowsProfileAdminUserName ] [-NetworkPlugin ] + [-NetworkPolicy ] [-PodCidr ] [-ServiceCidr ] [-DnsServiceIP ] + [-DockerBridgeCidr ] [-OutboundType ] [-LoadBalancerSku ] [-Force] [-GenerateSshKey] + [-EnableNodePublicIp] [-NodePublicIPPrefixID ] [-AvailabilityZone ] + [-NodeResourceGroup ] [-EnableEncryptionAtHost] [-EnableUltraSSD] [-NodeLinuxOSConfig ] + [-NodeKubeletConfig ] [-NodeMaxSurge ] [-PPG ] [-EnableFIPS] + [-AutoScalerProfile ] [-GpuInstanceProfile ] + [-EnableUptimeSLA] [-EdgeZone ] [-NodeHostGroupID ] [-NodePodSubnetID ] + [-EnableOidcIssuer] [-ResourceGroupName] [-Name] + [[-ServicePrincipalIdAndSecret] ] [-Location ] [-LinuxProfileAdminUserName ] + [-DnsNamePrefix ] [-KubernetesVersion ] [-NodeName ] [-NodeMinCount ] + [-NodeMaxCount ] [-EnableNodeAutoScaling] [-NodeCount ] [-NodeOsDiskSize ] + [-NodeVmSize ] [-NodePoolLabel ] [-NodePoolTag ] [-SshKeyValue ] + [-AcrNameToAttach ] [-AsJob] [-Tag ] [-LoadBalancerAllocatedOutboundPort ] + [-LoadBalancerManagedOutboundIpCount ] [-LoadBalancerOutboundIp ] + [-LoadBalancerOutboundIpPrefix ] [-LoadBalancerIdleTimeoutInMinute ] + [-ApiServerAccessAuthorizedIpRange ] [-EnableApiServerAccessPrivateCluster] + [-ApiServerAccessPrivateDnsZone ] [-EnableApiServerAccessPrivateClusterPublicFQDN] + [-FqdnSubdomain ] [-EnableManagedIdentity] [-AssignIdentity ] [-AutoUpgradeChannel ] + [-DiskEncryptionSetID ] [-DisableLocalAccount] [-HttpProxy ] [-HttpsProxy ] + [-HttpProxyConfigNoProxyEndpoint ] [-HttpProxyConfigTrustedCa ] + [-AksCustomHeader ] [-AadProfile ] + [-WindowsProfileAdminUserPassword ] [-EnableAHUB] [-DefaultProfile ] + [-WhatIf] [-Confirm] [-SubscriptionId ] [] +``` + +## DESCRIPTION + +Create a new Azure Kubernetes Service(AKS) cluster. + +## EXAMPLES + +### Create an AKS with default params. + +```powershell +New-AzAksCluster -ResourceGroupName myResourceGroup -Name myCluster +``` + +### Create Windows Server container on an AKS. +To create Windows Server container on an AKS, you must specify at least four following parameters when creating the AKS, and the value for `NetworkPlugin` and `NodeVmSetType` must be `azure` and `VirtualMachineScaleSets` respectively. +`-WindowsProfileAdminUserName *** -WindowsProfileAdminUserPassword *** -NetworkPlugin azure -NodeVmSetType VirtualMachineScaleSets` + +```powershell +$cred = ConvertTo-SecureString -AsPlainText "Password!!123" -Force +New-AzAksCluster -ResourceGroupName myResourceGroup -Name myCluster -WindowsProfileAdminUserName azureuser -WindowsProfileAdminUserPassword $cred -NetworkPlugin azure -NodeVmSetType VirtualMachineScaleSets +New-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myCluster -Name win1 -OsType Windows -VmSetType VirtualMachineScaleSets +``` + +### Create an AKS cluster with LinuxOSConfig and KubeletConfig. +When you create an AKS cluster, you can specify the kubelet and OS configurations. The type of `NodeLinuxOSConfig` and `NodeKubeletConfig` must be `Microsoft.Azure.Management.ContainerService.Models.LinuxOSConfig` and `Microsoft.Azure.Management.ContainerService.Models.KubeletConfig` respectively. + + +```powershell +$linuxOsConfigJsonStr = @' + { + "transparentHugePageEnabled": "madvise", + "transparentHugePageDefrag": "defer+madvise", + "swapFileSizeMB": 1500, + "sysctls": { + "netCoreSomaxconn": 163849, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "32000 60000" + } + } +'@ +$linuxOsConfig = [Microsoft.Azure.Management.ContainerService.Models.LinuxOSConfig] ($linuxOsConfigJsonStr | ConvertFrom-Json) +$kubeletConfigStr = @' + { + "failSwapOn": false + } +'@ +$kubeletConfig = [Microsoft.Azure.Management.ContainerService.Models.KubeletConfig] ($kubeletConfigStr | ConvertFrom-Json) + +New-AzAksCluster -ResourceGroupName myResourceGroup -Name myAKSCluster -NodeLinuxOSConfig $linuxOsConfig -NodeKubeletConfig $kubeletConfig +``` + +### Create an AKS cluster with AutoScalerProfile. +When you create an AKS cluster, you can configure granular details of the cluster autoscaler by changing the default values in the cluster-wide autoscaler profile. + +```powershell +$AutoScalerProfile=@{ + ScanInterval="30s" + Expander="least-waste" +} +$AutoScalerProfile=[Microsoft.Azure.Management.ContainerService.Models.ManagedClusterPropertiesAutoScalerProfile]$AutoScalerProfile + +New-AzAksCluster -ResourceGroupName myResourceGroup -Name myAKSCluster -AutoScalerProfile $AutoScalerProfile +``` + +### Create an AKS cluster with AadProfile. +When you create an AKS cluster, you can configure the AAD profile. + +```powershell +$AKSAdminGroup=New-AzADGroup -DisplayName myAKSAdminGroup -MailNickname myAKSAdminGroup +$AadProfile=@{ + managed=$true + enableAzureRBAC=$false + adminGroupObjectIDs=[System.Collections.Generic.List[string]]@($AKSAdminGroup.Id) +} +$AadProfile=[Microsoft.Azure.Management.ContainerService.Models.ManagedClusterAADProfile]$AadProfile + +New-AzAksCluster -ResourceGroupName myResourceGroup -Name myAKSCluster -AadProfile $AadProfile +``` + +## PARAMETERS + +### -AadProfile +The Azure Active Directory configuration. + +```yaml +Type: Microsoft.Azure.Management.ContainerService.Models.ManagedClusterAADProfile +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcrNameToAttach +Grant the 'acrpull' role of the specified ACR to AKS Service Principal, e.g. myacr + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddOnNameToBeEnabled +Add-on names to be enabled when cluster 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 +``` + +### -AksCustomHeader +Aks custom headers used for building Kubernetes network. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiServerAccessAuthorizedIpRange +The IP ranges authorized to access the Kubernetes API server. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiServerAccessPrivateDnsZone +The private DNS zone mode for the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +ResourceId of user assign managed identity for cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoScalerProfile +The parameters to be applied to the cluster-autoscaler. + +```yaml +Type: Microsoft.Azure.Management.ContainerService.Models.ManagedClusterPropertiesAutoScalerProfile +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoUpgradeChannel +The upgrade channel for auto upgrade. For more information see https://learn.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityZone +Availability zones for cluster. Must use VirtualMachineScaleSets AgentPoolType. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAccount +Local accounts should be disabled on the Managed Cluster. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetID +The resource ID of the disk encryption set to use for enabling encryption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsNamePrefix +The DNS name prefix for the cluster. The length must be <= 9 if users plan to add windows container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsServiceIP +DNS service IP used for building Kubernetes network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DockerBridgeCidr +Docker bridge cidr used for building Kubernetes network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +The name of the Edge Zone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAHUB +Whether to enable Azure Hybrid User Benefits (AHUB) for Windows VMs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableApiServerAccessPrivateCluster +Whether to create the cluster as a private cluster or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableApiServerAccessPrivateClusterPublicFQDN +Whether to create additional public FQDN for private cluster or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableEncryptionAtHost +Whether to enable host based OS and data drive + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFIPS +Whether to use a FIPS-enabled OS + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableManagedIdentity +Using a managed identity to manage cluster resource group. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNodeAutoScaling +Whether to enable auto-scaler + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNodePublicIp +Whether to enable public IP for nodes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOidcIssuer +Whether to enalbe OIDC issuer feature. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableRbac +Whether to enable Kubernetes Role-Based Access + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUltraSSD +whether to enable UltraSSD + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUptimeSLA +Whether to use use Uptime SLA. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Create cluster even if it already exists + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FqdnSubdomain +The FQDN subdomain of the private cluster with custom private dns zone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GenerateSshKey +Generate ssh key file to {HOME}/.ssh/id_rsa. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GpuInstanceProfile +The GpuInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpProxy +The HTTP proxy server endpoint to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpProxyConfigNoProxyEndpoint +The endpoints that should not go through proxy. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpProxyConfigTrustedCa +Alternative CA cert to use for connecting to proxy servers. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsProxy +The HTTPS proxy server endpoint to use + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KubernetesVersion +The version of Kubernetes to use for creating the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinuxProfileAdminUserName +User name for the Linux Virtual Machines. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AdminUserName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerAllocatedOutboundPort +The desired number of allocated SNAT ports per VM. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerIdleTimeoutInMinute +Desired outbound flow idle timeout in minutes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerManagedOutboundIpCount +Desired managed outbound IPs count for the cluster load balancer. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerOutboundIp +Desired outbound IP resources for the cluster load balancer. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerOutboundIpPrefix +Desired outbound IP Prefix resources for the cluster load balancer. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerSku +The load balancer sku for the managed cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Azure location for the cluster. +Defaults to the location of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Kubernetes managed cluster Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkPlugin +Network plugin used for building Kubernetes network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: azure +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkPolicy +Network policy used for building Kubernetes network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeCount +The default number of nodes for the node pools. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeHostGroupID +The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeKubeletConfig +The Kubelet configuration on the agent pool nodes. + +```yaml +Type: Microsoft.Azure.Management.ContainerService.Models.KubeletConfig +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeLinuxOSConfig +The OS configuration of Linux agent nodes. + +```yaml +Type: Microsoft.Azure.Management.ContainerService.Models.LinuxOSConfig +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeMaxCount +Maximum number of nodes for auto-scaling + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeMaxPodCount +Maximum number of pods that can run on node. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeMaxSurge +The maximum number or percentage of nodes that ar surged during upgrade. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeMinCount +Minimum number of nodes for auto-scaling. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeName +Unique name of the agent pool profile in the context of the subscription and resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeOsDiskSize +Size in GB of the OS disk for each node in the node pool. Minimum 30 GB. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeOsSKU +The default OS sku for the node pools. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodePodSubnetID +The ID of the subnet which pods will join when launched. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodePoolLabel +Node pool labels used for building Kubernetes network. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodePoolMode +NodePoolMode represents mode of an node pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodePoolTag +The tags to be persisted on the agent pool virtual machine scale set. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodePublicIPPrefixID +The resource Id of public IP prefix for node pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeResourceGroup +The resource group containing agent pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeScaleSetEvictionPolicy +ScaleSetEvictionPolicy to be used to specify eviction policy for low priority virtual machine scale set. Default to Delete. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeSetPriority +ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeVmSetType +AgentPoolType represents types of an agent pool. Possible values include: 'VirtualMachineScaleSets', 'AvailabilitySet' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: VirtualMachineScaleSets +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeVmSize +The size of the Virtual Machine. Default value is Standard_D2_v2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeVnetSubnetID +VNet SubnetID specifies the VNet's subnet identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutboundType +The outbound (egress) routing method. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PodCidr +Pod cidr used for building Kubernetes network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PPG +The ID for Proximity Placement Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceCidr +Service cidr used for building Kubernetes network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalIdAndSecret +The client id and client secret associated with the AAD application / service principal. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshKeyValue +SSH key file value or key file path. +Defaults to {HOME}/.ssh/id_rsa.pub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SshKeyPath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetName +Subnet name of VirtualNode addon. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Tags to be applied to the resource + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsProfileAdminUserName +The administrator username to use for Windows VMs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsProfileAdminUserPassword +The administrator password to use for Windows VMs, its length must be at least 12, containing at least one lower case character, i.e. `[a-z]`, one `[A-Z]` and one special character `[!@#$%^&*()]`. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +Resource Id of the workspace of Monitoring addon. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/New-AzAksMaintenanceConfiguration.md b/azps-10.1.0/Az.Aks/New-AzAksMaintenanceConfiguration.md new file mode 100644 index 0000000000..8f7773f816 --- /dev/null +++ b/azps-10.1.0/Az.Aks/New-AzAksMaintenanceConfiguration.md @@ -0,0 +1,211 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/new-azaksmaintenanceconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/New-AzAksMaintenanceConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/New-AzAksMaintenanceConfiguration.md +--- + +# New-AzAksMaintenanceConfiguration + +## SYNOPSIS +Creates or updates a maintenance configuration in the specified managed cluster. + +## SYNTAX + +``` +New-AzAksMaintenanceConfiguration -ConfigName -ResourceGroupName -ResourceName + [-SubscriptionId ] [-NotAllowedTime ] [-TimeInWeek ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates or updates a maintenance configuration in the specified managed cluster. + +## EXAMPLES + +### Example 1: Creates or updates a maintenance configuration in the specified managed cluster +```powershell +$TimeSpan = New-AzAksTimeSpanObject -Start (Get-Date -Year 2023 -Month 3 -Day 1) -End (Get-Date -Year 2023 -Month 3 -Day 2) +$TimeInWeek = New-AzAksTimeInWeekObject -Day 'Sunday' -HourSlot 1,2 +$MaintenanceConfig = New-AzAksMaintenanceConfiguration -ResourceGroupName mygroup -ResourceName myCluster -ConfigName 'aks_maintenance_config' -TimeInWeek $TimeInWeek -NotAllowedTime $TimeSpan +``` + +```output +Name +---- +aks_maintenance_config +``` + +Create a maintenance configuration "aks_maintenance_config" in a managed cluster "myCluster" with a time in week and a not allowed time span. + +## PARAMETERS + +### -ConfigName +The name of the maintenance configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotAllowedTime +Time slots on which upgrade is not allowed. +To construct, see NOTES section for NOTALLOWEDTIME properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.ITimeSpan[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeInWeek +If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. +To construct, see NOTES section for TIMEINWEEK properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.ITimeInWeek[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.IMaintenanceConfiguration + +## 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. + + +`NOTALLOWEDTIME `: Time slots on which upgrade is not allowed. + - `[End ]`: The end of a time span + - `[Start ]`: The start of a time span + +`TIMEINWEEK `: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. + - `[Day ]`: The day of the week. + - `[HourSlot ]`: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/New-AzAksNodePool.md b/azps-10.1.0/Az.Aks/New-AzAksNodePool.md new file mode 100644 index 0000000000..089f92718a --- /dev/null +++ b/azps-10.1.0/Az.Aks/New-AzAksNodePool.md @@ -0,0 +1,743 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/new-azaksnodepool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/New-AzAksNodePool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/New-AzAksNodePool.md +--- + +# New-AzAksNodePool + +## SYNOPSIS +Create a new node pool in specified cluster. + +## SYNTAX + +### defaultParameterSet +``` +New-AzAksNodePool -ResourceGroupName -ClusterName -Name [-Count ] + [-OsDiskSize ] [-VmSize ] [-VnetSubnetID ] [-MaxPodCount ] [-OsType ] + [-OsSKU ] [-EnableNodePublicIp] [-NodePublicIPPrefixID ] [-ScaleSetPriority ] + [-ScaleSetEvictionPolicy ] [-VmSetType ] [-AvailabilityZone ] [-Force] + [-EnableEncryptionAtHost] [-EnableUltraSSD] [-LinuxOSConfig ] [-KubeletConfig ] + [-MaxSurge ] [-PPG ] [-SpotMaxPrice ] [-EnableFIPS] [-GpuInstanceProfile ] + [-HostGroupID ] [-PodSubnetID ] [-KubernetesVersion ] [-MinCount ] + [-MaxCount ] [-EnableAutoScaling] [-Mode ] [-NodeLabel ] [-Tag ] + [-NodeTaint ] [-AksCustomHeader ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [-SubscriptionId ] [] +``` + +### ParentObjectParameterSet +``` +New-AzAksNodePool -Name -ClusterObject [-Count ] [-OsDiskSize ] + [-VmSize ] [-VnetSubnetID ] [-MaxPodCount ] [-OsType ] [-OsSKU ] + [-EnableNodePublicIp] [-NodePublicIPPrefixID ] [-ScaleSetPriority ] + [-ScaleSetEvictionPolicy ] [-VmSetType ] [-AvailabilityZone ] [-Force] + [-EnableEncryptionAtHost] [-EnableUltraSSD] [-LinuxOSConfig ] [-KubeletConfig ] + [-MaxSurge ] [-PPG ] [-SpotMaxPrice ] [-EnableFIPS] [-GpuInstanceProfile ] + [-HostGroupID ] [-PodSubnetID ] [-KubernetesVersion ] [-MinCount ] + [-MaxCount ] [-EnableAutoScaling] [-Mode ] [-NodeLabel ] [-Tag ] + [-NodeTaint ] [-AksCustomHeader ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [-SubscriptionId ] [] +``` + +## DESCRIPTION +Create a new node pool in specified cluster. + +## EXAMPLES + +### Create a node pool with default parameters +```powershell +New-AzAksNodePool -ResourceGroupName myResouceGroup -ClusterName myCluster -Name mydefault +``` + +### Create Windows Server container on an AKS +```powershell +$cred = ConvertTo-SecureString -AsPlainText "Password!!123" -Force +New-AzAksCluster -ResourceGroupName myResourceGroup -Name myCluster -WindowsProfileAdminUserName azureuser -WindowsProfileAdminUserPassword $cred -NetworkPlugin azure -NodeVmSetType VirtualMachineScaleSets +New-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myCluster -Name win1 -OsType Windows -VmSetType VirtualMachineScaleSets +``` + +### Create a node pool with LinuxOSConfig and KubeletConfig. +When you create an AKS node pool, you can specify the kubelet and OS configurations. The type of `LinuxOSConfig` and `KubeletConfig` must be `Microsoft.Azure.Management.ContainerService.Models.LinuxOSConfig` and `Microsoft.Azure.Management.ContainerService.Models.KubeletConfig` respectively. + + +```powershell +$linuxOsConfigJsonStr = @' + { + "transparentHugePageEnabled": "madvise", + "transparentHugePageDefrag": "defer+madvise", + "swapFileSizeMB": 1500, + "sysctls": { + "netCoreSomaxconn": 163849, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "32000 60000" + } + } +'@ +$linuxOsConfig = [Microsoft.Azure.Management.ContainerService.Models.LinuxOSConfig] ($linuxOsConfigJsonStr | ConvertFrom-Json) +$kubeletConfigStr = @' + { + "failSwapOn": false + } +'@ +$kubeletConfig = [Microsoft.Azure.Management.ContainerService.Models.KubeletConfig] ($kubeletConfigStr | ConvertFrom-Json) + +New-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myAKSCluster -Name mypool -LinuxOSConfig $linuxOsConfig -KubeletConfig $kubeletConfig +``` + +## PARAMETERS + +### -AksCustomHeader +Aks custom headers + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityZone +Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: defaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterObject +Specify cluster object in which to create node pool. + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Count +The default number of nodes for the node pools. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoScaling +Whether to enable auto-scaler + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableEncryptionAtHost +Whether to enable host based OS and data drive + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFIPS +Whether to use a FIPS-enabled OS + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNodePublicIp +Whether to enable public IP for nodes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUltraSSD +whether to enable UltraSSD + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Create node pool even if it already exists + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GpuInstanceProfile +The GpuInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostGroupID +The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KubeletConfig +The Kubelet configuration on the agent pool nodes. + +```yaml +Type: Microsoft.Azure.Management.ContainerService.Models.KubeletConfig +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KubernetesVersion +The version of Kubernetes to use for creating the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinuxOSConfig +The OS configuration of Linux agent nodes. + +```yaml +Type: Microsoft.Azure.Management.ContainerService.Models.LinuxOSConfig +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCount +Maximum number of nodes for auto-scaling + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPodCount +Maximum number of pods that can run on node. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSurge +The maximum number or percentage of nodes that ar surged during upgrade. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinCount +Minimum number of nodes for auto-scaling. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The pool mode + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the node pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeLabel +Node pool labels used for building Kubernetes network. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodePublicIPPrefixID +The resource Id of public IP prefix for node pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeTaint +The node taints added to new nodes during node pool create and scale + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsDiskSize +The default number of nodes for the node pools. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsSKU +OsSKU to be used to specify OS SKU. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsType +OsType to be used to specify os type. +Choose from Linux and Windows. +Default to Linux. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PodSubnetID +The ID of the subnet which pods will join when launched. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PPG +The ID for Proximity Placement Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: defaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleSetEvictionPolicy +ScaleSetEvictionPolicy to be used to specify eviction policy for low priority virtual machine scale set. +Default to Delete. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleSetPriority +ScaleSetPriority to be used to specify virtual machine scale set priority. +Default to regular. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpotMaxPrice +The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The tags to be persisted on the agent pool virtual machine scale set. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmSetType +Represents types of an node pool. +Possible values include: 'VirtualMachineScaleSets', 'AvailabilitySet' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmSize +The size of the Virtual Machine. Default value is Standard_D2_v2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetSubnetID +VNet SubnetID specifies the VNet's subnet identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +## OUTPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSNodePool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/New-AzAksSnapshot.md b/azps-10.1.0/Az.Aks/New-AzAksSnapshot.md new file mode 100644 index 0000000000..2989b473d2 --- /dev/null +++ b/azps-10.1.0/Az.Aks/New-AzAksSnapshot.md @@ -0,0 +1,211 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/new-azakssnapshot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/New-AzAksSnapshot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/New-AzAksSnapshot.md +--- + +# New-AzAksSnapshot + +## SYNOPSIS +Creates or updates a snapshot. + +## SYNTAX + +``` +New-AzAksSnapshot -ResourceGroupName -ResourceName [-SubscriptionId ] + -Location [-CreationDataSourceResourceId ] [-SnapshotType ] [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates or updates a snapshot. + +## EXAMPLES + +### Example 1: Creates or updates a snapshot +```powershell +$pool = Get-AzAksNodePool -ResourceGroupName mygroup -ClusterName mycluster -Name default +New-AzAksSnapshot -ResourceGroupName mygroup -ResourceName 'snapshot1' -Location eastus -SnapshotType 'NodePool' -CreationDataSourceResourceId $pool.Id +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +eastus snapshot1 3/30/2023 10:24:43 AM user1@microsoft.com User 3/30/2023 10:24:43 AM user1@microsoft.com User +``` + +Creates or updates a snapshot for a nodepool "default" of a managed cluster "mycluster". + +## PARAMETERS + +### -CreationDataSourceResourceId +This is the ARM ID of the source object to be used to create the target object. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnapshotType +The type of a snapshot. +The default is NodePool. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Support.SnapshotType +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.ISnapshot + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/New-AzAksTimeInWeekObject.md b/azps-10.1.0/Az.Aks/New-AzAksTimeInWeekObject.md new file mode 100644 index 0000000000..a936bbd09f --- /dev/null +++ b/azps-10.1.0/Az.Aks/New-AzAksTimeInWeekObject.md @@ -0,0 +1,88 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/Az.Aks/new-AzAksTimeInWeekObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/New-AzAksTimeInWeekObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/New-AzAksTimeInWeekObject.md +--- + +# New-AzAksTimeInWeekObject + +## SYNOPSIS +Create an in-memory object for TimeInWeek. + +## SYNTAX + +``` +New-AzAksTimeInWeekObject [-Day ] [-HourSlot ] [] +``` + +## DESCRIPTION +Create an in-memory object for TimeInWeek. + +## EXAMPLES + +### Example 1: Create an in-memory object for time in a week +```powershell +New-AzAksTimeInWeekObject -Day 'Sunday' -HourSlot 1,2 +``` + +```output +Day HourSlot +--- -------- +Sunday {1, 2} +``` + +*New-AzAksTimeInWeekObject* creates an in-memory object of type *TimeInWeek*. +This object represents time in a week. +and will be used for parameter *TimeInWeek* in cmdlet *New-AzAksMaintenanceConfiguration*. + +## PARAMETERS + +### -Day +The day of the week. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Support.WeekDay +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HourSlot +Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). +0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. +Specifying [0, 1] means the 00:00 - 02:00 UTC time range. + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.TimeInWeek + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/New-AzAksTimeSpanObject.md b/azps-10.1.0/Az.Aks/New-AzAksTimeSpanObject.md new file mode 100644 index 0000000000..e56922ae4b --- /dev/null +++ b/azps-10.1.0/Az.Aks/New-AzAksTimeSpanObject.md @@ -0,0 +1,87 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/Az.Aks/new-AzAksTimeSpanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/New-AzAksTimeSpanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/New-AzAksTimeSpanObject.md +--- + +# New-AzAksTimeSpanObject + +## SYNOPSIS +Create an in-memory object for TimeSpan. + +## SYNTAX + +``` +New-AzAksTimeSpanObject [-End ] [-Start ] [] +``` + +## DESCRIPTION +Create an in-memory object for TimeSpan. + +## EXAMPLES + +### Example 1: Create Create an in-memory object for a time span +```powershell +$startDate = Get-Date -Year 2023 -Month 3 -Day 1 +$endDate = Get-Date -Year 2023 -Month 3 -Day 2 +New-AzAksTimeSpanObject -Start $startDate -End $endDate +``` + +```output +End Start +--- ----- +3/2/2023 1:53:53 PM 3/1/2023 1:53:45 PM +``` + +*New-AzAksTimeSpanObject* creates an in-memory object of type *TimeSpan*. +This object represents a time span and will be used for parameter *NotAllowedTime* in cmdlet *New-AzAksMaintenanceConfiguration*. + +## PARAMETERS + +### -End +The end of a time span. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Start +The start of a time span. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.TimeSpan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Remove-AzAksCluster.md b/azps-10.1.0/Az.Aks/Remove-AzAksCluster.md new file mode 100644 index 0000000000..9323270159 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Remove-AzAksCluster.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/remove-azakscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Remove-AzAksCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Remove-AzAksCluster.md +--- + +# Remove-AzAksCluster + +## SYNOPSIS +Delete a managed Kubernetes cluster. + +## SYNTAX + +### GroupNameParameterSet (Default) +``` +Remove-AzAksCluster [-ResourceGroupName] [-Name] [-PassThru] [-AsJob] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +### InputObjectParameterSet +``` +Remove-AzAksCluster -InputObject [-PassThru] [-AsJob] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +### IdParameterSet +``` +Remove-AzAksCluster [-Id] [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [-SubscriptionId ] [] +``` + +## DESCRIPTION +Delete a managed Kubernetes cluster. + +## EXAMPLES + +### Delete an existing managed Kubernetes cluster +```powershell +Remove-AzAksCluster -ResourceGroupName group -Name myCluster +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove managed Kubernetes cluster without prompt + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of a managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +A PSKubernetesCluster object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of your managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: GroupNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true if deletion is successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: GroupNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Remove-AzAksMaintenanceConfiguration.md b/azps-10.1.0/Az.Aks/Remove-AzAksMaintenanceConfiguration.md new file mode 100644 index 0000000000..0662636db2 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Remove-AzAksMaintenanceConfiguration.md @@ -0,0 +1,218 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/remove-azaksmaintenanceconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Remove-AzAksMaintenanceConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Remove-AzAksMaintenanceConfiguration.md +--- + +# Remove-AzAksMaintenanceConfiguration + +## SYNOPSIS +Deletes a maintenance configuration. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAksMaintenanceConfiguration -ConfigName -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAksMaintenanceConfiguration -InputObject [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a maintenance configuration. + +## EXAMPLES + +### Example 1: Remove a maintenance configuration +```powershell +Remove-AzAksMaintenanceConfiguration -ResourceGroupName mygroup -ResourceName mycluster -ConfigName 'aks_maintenance_config' +``` + +### Example 2: Remove a maintenance configuration via identity +```powershell +$MaintenanceConfig = Get-AzAksMaintenanceConfiguration -ResourceGroupName mygroup -ResourceName myCluster -ConfigName 'aks_maintenance_config' +$MaintenanceConfig | Remove-AzAksMaintenanceConfiguration +``` + +## PARAMETERS + +### -ConfigName +The name of the maintenance configuration. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Remove-AzAksNodePool.md b/azps-10.1.0/Az.Aks/Remove-AzAksNodePool.md new file mode 100644 index 0000000000..5cb646d659 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Remove-AzAksNodePool.md @@ -0,0 +1,269 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/remove-azaksnodepool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Remove-AzAksNodePool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Remove-AzAksNodePool.md +--- + +# Remove-AzAksNodePool + +## SYNOPSIS +Delete node pool from managed cluster. + +## SYNTAX + +### GroupNameParameterSet (Default) +``` +Remove-AzAksNodePool [-ResourceGroupName] [-ClusterName] [-Name] [-PassThru] + [-AsJob] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +### InputObjectParameterSet +``` +Remove-AzAksNodePool -InputObject [-PassThru] [-AsJob] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +### IdParameterSet +``` +Remove-AzAksNodePool [-Id] [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [-SubscriptionId ] [] +``` + +### ParentObjectParameterSet +``` +Remove-AzAksNodePool [-Name] -ClusterObject [-PassThru] [-AsJob] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +## DESCRIPTION +Delete node pool from managed cluster. + +## EXAMPLES + +### Delete specified node pool +```powershell +Remove-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myCluster -Name winpool +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Name of your managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: GroupNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterObject +The cluster object. + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove node pool without prompt + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of an node pool in managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +A PSAgentPool object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSNodePool +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of your node pool + +```yaml +Type: System.String +Parameter Sets: GroupNameParameterSet, ParentObjectParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: GroupNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSNodePool + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Remove-AzAksSnapshot.md b/azps-10.1.0/Az.Aks/Remove-AzAksSnapshot.md new file mode 100644 index 0000000000..7f8a02e76d --- /dev/null +++ b/azps-10.1.0/Az.Aks/Remove-AzAksSnapshot.md @@ -0,0 +1,203 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/remove-azakssnapshot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Remove-AzAksSnapshot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Remove-AzAksSnapshot.md +--- + +# Remove-AzAksSnapshot + +## SYNOPSIS +Deletes a snapshot. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAksSnapshot -ResourceGroupName -ResourceName [-SubscriptionId ] + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAksSnapshot -InputObject [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Deletes a snapshot. + +## EXAMPLES + +### Example 1: Remove an AKS snapshot +```powershell +Remove-AzAksSnapshot -ResourceGroupName mygroup -ResourceName 'snapshot1' +``` + +### Example 2: Remove an AKS snapshot via identity +```powershell +$Snapshot = Get-AzAksSnapshot -ResourceGroupName mygroup -ResourceName 'snapshot1' +$Snapshot | Remove-AzAksSnapshot +``` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Set-AzAksCluster.md b/azps-10.1.0/Az.Aks/Set-AzAksCluster.md new file mode 100644 index 0000000000..5985af4cf1 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Set-AzAksCluster.md @@ -0,0 +1,983 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/set-azakscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Set-AzAksCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Set-AzAksCluster.md +--- + +# Set-AzAksCluster + +## SYNOPSIS +Update or create a managed Kubernetes cluster. + +## SYNTAX + +### defaultParameterSet (Default) +``` +Set-AzAksCluster [-NodePoolMode ] [-AcrNameToDetach ] [-NodeImageOnly] [-ControlPlaneOnly] + [-AutoScalerProfile ] [-EnableUptimeSLA] [-EnableOidcIssuer] + [-ResourceGroupName] [-Name] [[-ServicePrincipalIdAndSecret] ] + [-Location ] [-LinuxProfileAdminUserName ] [-DnsNamePrefix ] + [-KubernetesVersion ] [-NodeName ] [-NodeMinCount ] [-NodeMaxCount ] + [-EnableNodeAutoScaling] [-NodeCount ] [-NodeOsDiskSize ] [-NodeVmSize ] + [-NodePoolLabel ] [-NodePoolTag ] [-SshKeyValue ] [-AcrNameToAttach ] + [-AsJob] [-Tag ] [-LoadBalancerAllocatedOutboundPort ] + [-LoadBalancerManagedOutboundIpCount ] [-LoadBalancerOutboundIp ] + [-LoadBalancerOutboundIpPrefix ] [-LoadBalancerIdleTimeoutInMinute ] + [-ApiServerAccessAuthorizedIpRange ] [-EnableApiServerAccessPrivateCluster] + [-ApiServerAccessPrivateDnsZone ] [-EnableApiServerAccessPrivateClusterPublicFQDN] + [-FqdnSubdomain ] [-EnableManagedIdentity] [-AssignIdentity ] [-AutoUpgradeChannel ] + [-DiskEncryptionSetID ] [-DisableLocalAccount] [-HttpProxy ] [-HttpsProxy ] + [-HttpProxyConfigNoProxyEndpoint ] [-HttpProxyConfigTrustedCa ] + [-AksCustomHeader ] [-AadProfile ] + [-WindowsProfileAdminUserPassword ] [-EnableAHUB] [-DefaultProfile ] + [-WhatIf] [-Confirm] [-SubscriptionId ] [] +``` + +### InputObjectParameterSet +``` +Set-AzAksCluster -InputObject [-NodePoolMode ] [-AcrNameToDetach ] + [-NodeImageOnly] [-ControlPlaneOnly] [-AutoScalerProfile ] + [-EnableUptimeSLA] [-EnableOidcIssuer] [-Location ] [-LinuxProfileAdminUserName ] + [-DnsNamePrefix ] [-KubernetesVersion ] [-NodeName ] [-NodeMinCount ] + [-NodeMaxCount ] [-EnableNodeAutoScaling] [-NodeCount ] [-NodeOsDiskSize ] + [-NodeVmSize ] [-NodePoolLabel ] [-NodePoolTag ] [-SshKeyValue ] + [-AcrNameToAttach ] [-AsJob] [-Tag ] [-LoadBalancerAllocatedOutboundPort ] + [-LoadBalancerManagedOutboundIpCount ] [-LoadBalancerOutboundIp ] + [-LoadBalancerOutboundIpPrefix ] [-LoadBalancerIdleTimeoutInMinute ] + [-ApiServerAccessAuthorizedIpRange ] [-EnableApiServerAccessPrivateCluster] + [-ApiServerAccessPrivateDnsZone ] [-EnableApiServerAccessPrivateClusterPublicFQDN] + [-FqdnSubdomain ] [-EnableManagedIdentity] [-AssignIdentity ] [-AutoUpgradeChannel ] + [-DiskEncryptionSetID ] [-DisableLocalAccount] [-HttpProxy ] [-HttpsProxy ] + [-HttpProxyConfigNoProxyEndpoint ] [-HttpProxyConfigTrustedCa ] + [-AksCustomHeader ] [-AadProfile ] + [-WindowsProfileAdminUserPassword ] [-EnableAHUB] [-DefaultProfile ] + [-WhatIf] [-Confirm] [-SubscriptionId ] [] +``` + +### IdParameterSet +``` +Set-AzAksCluster [-NodePoolMode ] [-AcrNameToDetach ] [-NodeImageOnly] [-ControlPlaneOnly] + [-Id] [-AutoScalerProfile ] [-EnableUptimeSLA] + [-EnableOidcIssuer] [-Location ] [-LinuxProfileAdminUserName ] [-DnsNamePrefix ] + [-KubernetesVersion ] [-NodeName ] [-NodeMinCount ] [-NodeMaxCount ] + [-EnableNodeAutoScaling] [-NodeCount ] [-NodeOsDiskSize ] [-NodeVmSize ] + [-NodePoolLabel ] [-NodePoolTag ] [-SshKeyValue ] [-AcrNameToAttach ] + [-AsJob] [-Tag ] [-LoadBalancerAllocatedOutboundPort ] + [-LoadBalancerManagedOutboundIpCount ] [-LoadBalancerOutboundIp ] + [-LoadBalancerOutboundIpPrefix ] [-LoadBalancerIdleTimeoutInMinute ] + [-ApiServerAccessAuthorizedIpRange ] [-EnableApiServerAccessPrivateCluster] + [-ApiServerAccessPrivateDnsZone ] [-EnableApiServerAccessPrivateClusterPublicFQDN] + [-FqdnSubdomain ] [-EnableManagedIdentity] [-AssignIdentity ] [-AutoUpgradeChannel ] + [-DiskEncryptionSetID ] [-DisableLocalAccount] [-HttpProxy ] [-HttpsProxy ] + [-HttpProxyConfigNoProxyEndpoint ] [-HttpProxyConfigTrustedCa ] + [-AksCustomHeader ] [-AadProfile ] + [-WindowsProfileAdminUserPassword ] [-EnableAHUB] [-DefaultProfile ] + [-WhatIf] [-Confirm] [-SubscriptionId ] [] +``` + +## DESCRIPTION +Update or create a managed Kubernetes cluster. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAksCluster -ResourceGroupName group -Name myCluster | Set-AzAksCluster -NodeCount 5 +``` + +Set the number of nodes in the Kubernetes cluster to 5. + +### Update an AKS cluster with AutoScalerProfile. +When you update an AKS cluster, you can configure granular details of the cluster autoscaler by changing the default values in the cluster-wide autoscaler profile. + +```powershell +$AutoScalerProfile=@{ + ScanInterval="40s" + Expander="priority" +} +$AutoScalerProfile=[Microsoft.Azure.Management.ContainerService.Models.ManagedClusterPropertiesAutoScalerProfile]$AutoScalerProfile + +Get-AzAksCluster -ResourceGroupName group -Name myCluster | Set-AzAksCluster -AutoScalerProfile $AutoScalerProfile +``` + +### Update an AKS cluster with AadProfile. +When you update an AKS cluster, you can configure the AAD profile. + +```powershell +$AKSAdminGroup=New-AzADGroup -DisplayName myAKSAdminGroup -MailNickname myAKSAdminGroup +$AadProfile=@{ + managed=$true + enableAzureRBAC=$false + adminGroupObjectIDs=[System.Collections.Generic.List[string]]@($AKSAdminGroup.Id) +} +$AadProfile=[Microsoft.Azure.Management.ContainerService.Models.ManagedClusterAADProfile]$AadProfile + +Set-AzAksCluster -ResourceGroupName myResourceGroup -Name myAKSCluster -AadProfile $AadProfile +``` + +## PARAMETERS + +### -AadProfile +The Azure Active Directory configuration. + +```yaml +Type: Microsoft.Azure.Management.ContainerService.Models.ManagedClusterAADProfile +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcrNameToAttach +Grant the 'acrpull' role of the specified ACR to AKS Service Principal, e.g. myacr + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcrNameToDetach +Disable the 'acrpull' role assignment to the ACR specified by name or resource ID, e.g. myacr + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AksCustomHeader +Aks custom headers used for building Kubernetes network. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiServerAccessAuthorizedIpRange +The IP ranges authorized to access the Kubernetes API server. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiServerAccessPrivateDnsZone +The private DNS zone mode for the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +ResourceId of user assign managed identity for cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoScalerProfile +The parameters to be applied to the cluster-autoscaler. + +```yaml +Type: Microsoft.Azure.Management.ContainerService.Models.ManagedClusterPropertiesAutoScalerProfile +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoUpgradeChannel +The upgrade channel for auto upgrade. For more information see https://learn.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlPlaneOnly +Will only upgrade control plane to target version. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAccount +Local accounts should be disabled on the Managed Cluster. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetID +The resource ID of the disk encryption set to use for enabling encryption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsNamePrefix +The DNS name prefix for the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAHUB +Whether to enable Azure Hybrid User Benefits (AHUB) for Windows VMs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableApiServerAccessPrivateCluster +Whether to create the cluster as a private cluster or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableApiServerAccessPrivateClusterPublicFQDN +Whether to create additional public FQDN for private cluster or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableManagedIdentity +Using a managed identity to manage cluster resource group. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNodeAutoScaling +Whether to enable auto-scaler + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOidcIssuer +Whether to enalbe OIDC issuer feature. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUptimeSLA +Whether to use use Uptime SLA. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FqdnSubdomain +The FQDN subdomain of the private cluster with custom private dns zone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpProxy +The HTTP proxy server endpoint to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpProxyConfigNoProxyEndpoint +The endpoints that should not go through proxy. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpProxyConfigTrustedCa +Alternative CA cert to use for connecting to proxy servers. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsProxy +The HTTPS proxy server endpoint to use + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of a managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +A PSKubernetesCluster object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KubernetesVersion +The version of Kubernetes to use for creating the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinuxProfileAdminUserName +User name for the Linux Virtual Machines. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AdminUserName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerAllocatedOutboundPort +The desired number of allocated SNAT ports per VM. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerIdleTimeoutInMinute +Desired outbound flow idle timeout in minutes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerManagedOutboundIpCount +Desired managed outbound IPs count for the cluster load balancer. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerOutboundIp +Desired outbound IP resources for the cluster load balancer. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerOutboundIpPrefix +Desired outbound IP Prefix resources for the cluster load balancer. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Azure location for the cluster. +Defaults to the location of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Kubernetes managed cluster Name. + +```yaml +Type: System.String +Parameter Sets: defaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeCount +The default number of nodes for the node pools. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeImageOnly +Will only upgrade the node image of agent pools. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeMaxCount +Maximum number of nodes for auto-scaling + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeMinCount +Minimum number of nodes for auto-scaling. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeName +Unique name of the agent pool profile in the context of the subscription and resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeOsDiskSize +Specifies the size, in GB, of the operating system disk. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodePoolLabel +Node pool labels used for building Kubernetes network. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodePoolMode +NodePoolMode represents mode of an node pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodePoolTag +The tags to be persisted on the agent pool virtual machine scale set. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeVmSize +The size of the Virtual Machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: defaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalIdAndSecret +The client id and client secret associated with the AAD application / service principal. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: defaultParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshKeyValue +SSH key file value or key file path. +Defaults to {HOME}/.ssh/id_rsa.pub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SshKeyPath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Tags to be applied to the resource + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsProfileAdminUserPassword +The administrator password to use for Windows VMs. Password requirement:At least one lower case, one upper case, one special character !@#$%^&*(), the minimum lenth is 12. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Set-AzAksClusterCredential.md b/azps-10.1.0/Az.Aks/Set-AzAksClusterCredential.md new file mode 100644 index 0000000000..9033ba3b19 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Set-AzAksClusterCredential.md @@ -0,0 +1,253 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/set-azaksclustercredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Set-AzAksClusterCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Set-AzAksClusterCredential.md +--- + +# Set-AzAksClusterCredential + +## SYNOPSIS +Reset the ServicePrincipal of an existing AKS cluster. + +## SYNTAX + +### GroupNameParameterSet (Default) +``` +Set-AzAksClusterCredential [-ResourceGroupName] [-Name] + -ServicePrincipalIdAndSecret [-PassThru] [-AsJob] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +### InputObjectParameterSet +``` +Set-AzAksClusterCredential -InputObject -ServicePrincipalIdAndSecret + [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [-SubscriptionId ] [] +``` + +### IdParameterSet +``` +Set-AzAksClusterCredential [-Id] -ServicePrincipalIdAndSecret [-PassThru] [-AsJob] + [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +## DESCRIPTION +Reset the ServicePrincipal of an existing AKS cluster. + +## EXAMPLES + +### Example 1 +```powershell +$SecPasswd = ConvertTo-SecureString $password -AsPlainText -Force +$Credential = $(New-Object System.Management.Automation.PSCredential ('6f277dd3-e481-4518-8aab-35c31662bad9', $SecPasswd)) +Set-AzAksClusterCredential -ResourceGroupName $ResourceGroupName -Name $Name -ServicePrincipalIdAndSecret $Credential -force +``` + +Set the service principal of a existing kubernetes cluster with resource group name and cluster name. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove managed Kubernetes cluster without prompt + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of a managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +A PSKubernetesCluster object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of your managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: GroupNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true if reset is successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: GroupNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalIdAndSecret +The client id and client secret associated with the service principal. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Start-AzAksCluster.md b/azps-10.1.0/Az.Aks/Start-AzAksCluster.md new file mode 100644 index 0000000000..5f7e43904e --- /dev/null +++ b/azps-10.1.0/Az.Aks/Start-AzAksCluster.md @@ -0,0 +1,236 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/start-azakscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Start-AzAksCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Start-AzAksCluster.md +--- + +# Start-AzAksCluster + +## SYNOPSIS +See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster. + +## SYNTAX + +### Start (Default) +``` +Start-AzAksCluster -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### StartViaIdentity +``` +Start-AzAksCluster -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster. + +## EXAMPLES + +### Example 1: Start Aks cluster with resource group name and cluster name +```powershell +Start-AzAksCluster -ResourceGroupName group -Name myCluster +``` + +Start Aks cluster with resource group name and cluster name. + +### Example 2: Start Aks cluster with pipeline +```powershell +Get-AzAksCluster -ResourceGroupName group -Name myCluster | Start-AzAksCluster +``` + +Start Aks cluster with pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Start-AzAksDashboard.md b/azps-10.1.0/Az.Aks/Start-AzAksDashboard.md new file mode 100644 index 0000000000..573b99084c --- /dev/null +++ b/azps-10.1.0/Az.Aks/Start-AzAksDashboard.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/start-azaksdashboard +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Start-AzAksDashboard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Start-AzAksDashboard.md +--- + +# Start-AzAksDashboard + +## SYNOPSIS +Create a Kubectl SSH tunnel to the managed cluster's dashboard. + +## SYNTAX + +### GroupNameParameterSet (Default) +``` +Start-AzAksDashboard [-ResourceGroupName] [-Name] [-DisableBrowser] [-ListenPort ] + [-PassThru] [-DefaultProfile ] [-SubscriptionId ] [] +``` + +### InputObjectParameterSet +``` +Start-AzAksDashboard [-InputObject] [-DisableBrowser] [-ListenPort ] [-PassThru] + [-DefaultProfile ] [-SubscriptionId ] [] +``` + +### IdParameterSet +``` +Start-AzAksDashboard [-Id] [-DisableBrowser] [-ListenPort ] [-PassThru] + [-DefaultProfile ] [-SubscriptionId ] [] +``` + +## DESCRIPTION +Create a Kubectl SSH tunnel to the managed cluster's dashboard. The SSH tunnel is setup in a PowerShell job called Kubectl-Tunnel and can be found by running `Get-Job`. The tunnel should be accessible via [http://127.0.0.1:8001](http://127.0.0.1:8001). + +## EXAMPLES + +### Start an SSH tunnel and open a browser to the Kubernetes dashboard +```powershell +Start-AzAksDashboard -ResourceGroupName group -Name myCluster +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableBrowser +Do not pop open a browser after establishing the kubectl port-forward. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of a managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +A PSKubernetesCluster object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ListenPort +The listening port for the dashboard. Default value is 8003. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of your managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: GroupNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Cmdlet returns the KubeTunnelJob if passed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: GroupNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Aks.KubeTunnelJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Start-AzAksManagedClusterCommand.md b/azps-10.1.0/Az.Aks/Start-AzAksManagedClusterCommand.md new file mode 100644 index 0000000000..835d233013 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Start-AzAksManagedClusterCommand.md @@ -0,0 +1,297 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/start-azaksmanagedclustercommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Start-AzAksManagedClusterCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Start-AzAksManagedClusterCommand.md +--- + +# Start-AzAksManagedClusterCommand + +## SYNOPSIS +AKS will create a pod to run the command. +This is primarily useful for private clusters. +For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview). + +## SYNTAX + +### RunExpanded (Default) +``` +Start-AzAksManagedClusterCommand -ResourceGroupName -ResourceName [-SubscriptionId ] + -Command [-ClusterToken ] [-Context ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### RunViaIdentityExpanded +``` +Start-AzAksManagedClusterCommand -InputObject -Command [-ClusterToken ] + [-Context ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +AKS will create a pod to run the command. +This is primarily useful for private clusters. +For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview). + +## EXAMPLES + +### Example 1: Run AKS command +```powershell +Start-AzAksManagedClusterCommand -ResourceGroupName mygroup -ResourceName mycluster -Command "kubectl get nodes" +``` + +```output +ExitCode : 0 +FinishedAt : 3/31/2023 8:52:17 AM +Id : 0a3991475d9744fcbfdc2595b40e517f +Log : NAME STATUS ROLES AGE VERSION + aks-default-40136599-vmss000000 Ready agent 46m v1.24.9 + aks-pool2-22198594-vmss000000 Ready agent 43m v1.24.9 + +ProvisioningState : Succeeded +Reason : +StartedAt : 3/31/2023 8:52:16 AM +``` + +AKS will create a pod to run the command. +This is primarily useful for private clusters. + +### Example 2: Run AKS command via identity +```powershell +$cluster = Get-AzAksCluster -ResourceGroupName mygroup -Name mycluster +$cluster | Start-AzAksManagedClusterCommand -Command "kubectl get nodes" +``` + +```output +ExitCode : 0 +FinishedAt : 3/31/2023 8:54:17 AM +Id : 0a3991475d9744fcbfdc2595b40e517f +Log : NAME STATUS ROLES AGE VERSION + aks-default-40136599-vmss000000 Ready agent 46m v1.24.9 + aks-pool2-22198594-vmss000000 Ready agent 43m v1.24.9 + +ProvisioningState : Succeeded +Reason : +StartedAt : 3/31/2023 8:54:16 AM +``` + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterToken +AuthToken issued for AKS AAD Server App. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Command +The command to run. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +A base64 encoded zip file containing the files required by the command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: RunViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: RunExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: RunExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: RunExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.IRunCommandResult + +## 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 + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Stop-AzAksCluster.md b/azps-10.1.0/Az.Aks/Stop-AzAksCluster.md new file mode 100644 index 0000000000..cdc6dda5c5 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Stop-AzAksCluster.md @@ -0,0 +1,242 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/stop-azakscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Stop-AzAksCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Stop-AzAksCluster.md +--- + +# Stop-AzAksCluster + +## SYNOPSIS +This can only be performed on Azure Virtual Machine Scale set backed clusters. +Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. +A cluster does not accrue charges while it is stopped. +See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzAksCluster -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### StopViaIdentity +``` +Stop-AzAksCluster -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This can only be performed on Azure Virtual Machine Scale set backed clusters. +Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. +A cluster does not accrue charges while it is stopped. +See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster. + +## EXAMPLES + +### Example 1: Stop Aks cluster with resource group name and cluster name +```powershell +Stop-AzAksCluster -ResourceGroupName group -Name myCluster +``` + +Stop Aks cluster with resource group name and cluster name. + +### Example 2: Stop Aks cluster with pipeline +```powershell +Get-AzAksCluster -ResourceGroupName group -Name myCluster | Stop-AzAksCluster +``` + +Stop Aks cluster with pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AgentPoolName ]`: The name of the agent pool. + - `[CommandId ]`: Id of the command. + - `[ConfigName ]`: The name of the maintenance configuration. + - `[Id ]`: Resource identity path + - `[Location ]`: The name of Azure region. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the managed cluster resource. + - `[RoleName ]`: The name of the role for managed cluster accessProfile resource. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Stop-AzAksDashboard.md b/azps-10.1.0/Az.Aks/Stop-AzAksDashboard.md new file mode 100644 index 0000000000..24d6e68bf2 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Stop-AzAksDashboard.md @@ -0,0 +1,96 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/stop-azaksdashboard +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Stop-AzAksDashboard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Stop-AzAksDashboard.md +--- + +# Stop-AzAksDashboard + +## SYNOPSIS +Stop the Kubectl SSH tunnel created in Start-AzKubernetesDashboard. + +## SYNTAX + +``` +Stop-AzAksDashboard [-PassThru] [-DefaultProfile ] [-SubscriptionId ] + [] +``` + +## DESCRIPTION +Stop the Kubectl SSH tunnel created in Start-AzKubernetesDashboard. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzAksDashboard +``` + +Stops the existing SSH tunnel setup by executing Start-AzKubernetesDashboard. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true if SSH tunnel is closed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Aks/Update-AzAksNodePool.md b/azps-10.1.0/Az.Aks/Update-AzAksNodePool.md new file mode 100644 index 0000000000..f8b56ada24 --- /dev/null +++ b/azps-10.1.0/Az.Aks/Update-AzAksNodePool.md @@ -0,0 +1,443 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Aks.dll-Help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/update-azaksnodepool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Update-AzAksNodePool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Aks/Aks/help/Update-AzAksNodePool.md +--- + +# Update-AzAksNodePool + +## SYNOPSIS +Update node pool in a managed cluster. + +## SYNTAX + +### defaultParameterSet (Default) +``` +Update-AzAksNodePool -ResourceGroupName -ClusterName -Name [-NodeCount ] + [-NodeImageOnly] [-AsJob] [-Force] [-MaxSurge ] [-KubernetesVersion ] [-MinCount ] + [-MaxCount ] [-EnableAutoScaling] [-Mode ] [-NodeLabel ] [-Tag ] + [-NodeTaint ] [-AksCustomHeader ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [-SubscriptionId ] [] +``` + +### ParentObjectParameterSet +``` +Update-AzAksNodePool -Name -ClusterObject [-NodeCount ] [-NodeImageOnly] + [-AsJob] [-Force] [-MaxSurge ] [-KubernetesVersion ] [-MinCount ] [-MaxCount ] + [-EnableAutoScaling] [-Mode ] [-NodeLabel ] [-Tag ] [-NodeTaint ] + [-AksCustomHeader ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [-SubscriptionId ] [] +``` + +### InputObjectParameterSet +``` +Update-AzAksNodePool -InputObject [-NodeCount ] [-NodeImageOnly] [-AsJob] [-Force] + [-MaxSurge ] [-KubernetesVersion ] [-MinCount ] [-MaxCount ] + [-EnableAutoScaling] [-Mode ] [-NodeLabel ] [-Tag ] [-NodeTaint ] + [-AksCustomHeader ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [-SubscriptionId ] [] +``` + +### IdParameterSet +``` +Update-AzAksNodePool -Id [-NodeCount ] [-NodeImageOnly] [-AsJob] [-Force] [-MaxSurge ] + [-KubernetesVersion ] [-MinCount ] [-MaxCount ] [-EnableAutoScaling] [-Mode ] + [-NodeLabel ] [-Tag ] [-NodeTaint ] [-AksCustomHeader ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [-SubscriptionId ] + [] +``` + +## DESCRIPTION +Update node pool in a managed cluster. + +## EXAMPLES + +### Change minimun count to 5 for specified node pool +```powershell +Update-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myCluster -Name linuxpool -MinCount 5 +``` + +## PARAMETERS + +### -AksCustomHeader +Aks custom headers + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: defaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterObject +The cluster object + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoScaling +Whether to enable auto-scaler + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Update node pool without prompt + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of an node pool in managed Kubernetes cluster + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +A PSAgentPool object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Aks.Models.PSNodePool +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KubernetesVersion +The version of Kubernetes to use for creating the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCount +Maximum number of nodes for auto-scaling + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSurge +The maximum number or percentage of nodes that ar surged during upgrade. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinCount +Minimum number of nodes for auto-scaling. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The pool mode + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the node pool. + +```yaml +Type: System.String +Parameter Sets: defaultParameterSet, ParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeCount +The number of nodes for the node pools. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeImageOnly +Will only upgrade the node image of agent pools. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeLabel +Node pool labels used for building Kubernetes network. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeTaint +The node taints added to new nodes during node pool create and scale + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: defaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The tags to be persisted on the agent pool virtual machine scale set. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSNodePool + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Aks.Models.PSNodePool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Az.AlertsManagement.md b/azps-10.1.0/Az.AlertsManagement/Az.AlertsManagement.md new file mode 100644 index 0000000000..06db18c95f --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Az.AlertsManagement.md @@ -0,0 +1,66 @@ +--- +Module Name: Az.AlertsManagement +Module Guid: ab73cb67-5713-4179-b6d7-f76ab3ad148f +Download Help Link: https://learn.microsoft.com/powershell/module/az.alertsmanagement +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Az.AlertsManagement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Az.AlertsManagement.md +--- + +# Az.AlertsManagement Module +## Description +Manages alerts, smart groups and action rule configuration for Alerts Management Platform. + +## Az.AlertsManagement Cmdlets +### [Get-AzAlert](Get-AzAlert.md) +Get Alerts Information + +### [Get-AzAlertObjectHistory](Get-AzAlertObjectHistory.md) +Gets Alert History information + +### [Get-AzAlertProcessingRule](Get-AzAlertProcessingRule.md) +Get AlertProcessing Rules Information + +### [Get-AzPrometheusRuleGroup](Get-AzPrometheusRuleGroup.md) +Retrieve a Prometheus rule group definition. + +### [Get-AzSmartGroup](Get-AzSmartGroup.md) +Gets Smart Groups information + +### [Get-AzSmartGroupHistory](Get-AzSmartGroupHistory.md) +Gets smart group history + +### [Measure-AzAlertStatistic](Measure-AzAlertStatistic.md) +Gets Alert Summary Information + +### [New-AzPrometheusRuleGroup](New-AzPrometheusRuleGroup.md) +Create or update a Prometheus rule group definition. + +### [New-AzPrometheusRuleGroupActionObject](New-AzPrometheusRuleGroupActionObject.md) +Create an in-memory object for PrometheusRuleGroupAction. + +### [New-AzPrometheusRuleObject](New-AzPrometheusRuleObject.md) +Create an in-memory object for PrometheusRule. + +### [Remove-AzAlertProcessingRule](Remove-AzAlertProcessingRule.md) +Deletes an alert processing rule + +### [Remove-AzPrometheusRuleGroup](Remove-AzPrometheusRuleGroup.md) +Delete a Prometheus rule group definition. + +### [Set-AzAlertProcessingRule](Set-AzAlertProcessingRule.md) +Create or update an alert processing rule. + +### [Update-AzAlertProcessingRule](Update-AzAlertProcessingRule.md) +Updates alert processing rule properties. + +### [Update-AzAlertState](Update-AzAlertState.md) +Updates alert state + +### [Update-AzPrometheusRuleGroup](Update-AzPrometheusRuleGroup.md) +Update an Prometheus rule group definition. + +### [Update-AzSmartGroupState](Update-AzSmartGroupState.md) +Updates smart group state + diff --git a/azps-10.1.0/Az.AlertsManagement/Get-AzAlert.md b/azps-10.1.0/Az.AlertsManagement/Get-AzAlert.md new file mode 100644 index 0000000000..5ef272c280 --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Get-AzAlert.md @@ -0,0 +1,372 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AlertsManagement.dll-Help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/get-azalert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Get-AzAlert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Get-AzAlert.md +--- + +# Get-AzAlert + +## SYNOPSIS +Get Alerts Information + +## SYNTAX + +### AlertsListByFilter (Default) +``` +Get-AzAlert [-TargetResourceType ] [-TargetResourceGroup ] [-MonitorService ] + [-MonitorCondition ] [-Severity ] [-State ] [-AlertRuleId ] + [-SmartGroupId ] [-IncludeContext ] [-IncludeEgressConfig ] [-PageCount ] + [-SortBy ] [-SortOrder ] [-TimeRange ] [-CustomTimeRange ] [-Select ] + [-DefaultProfile ] [] +``` + +### AlertById +``` +Get-AzAlert -AlertId [-DefaultProfile ] [] +``` + +### AlertsListByTargetResourceIdFilter +``` +Get-AzAlert [-TargetResourceId ] [-MonitorService ] [-MonitorCondition ] + [-Severity ] [-State ] [-AlertRuleId ] [-SmartGroupId ] + [-IncludeContext ] [-IncludeEgressConfig ] [-PageCount ] [-SortBy ] + [-SortOrder ] [-TimeRange ] [-CustomTimeRange ] [-Select ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +**Get-AzAlert** cmdlet gets fired alert instances. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAlert -Severity "Sev2" -MonitorCondition "Fired" -IncludeContext $true +``` + +List all alerts with Sev2 severity and Fired monitor condition. Setting IncludeContext to true, include custom payload of alert. +Use Format-List to get the complete details of each alert in list. + +### Example 2 +```powershell +Get-AzAlert -AlertId "afbf1b3a-0a6c-4f19-9c9b-644ccd7b1529" | Format-List +``` + +Get Alert details by Id (GUID) or Resource Id (Complete ARM Id) + +### Example 3 + +Get Alerts Information. (autogenerated) + + + + +```powershell +Get-AzAlert -IncludeContext $true -TimeRange '1h' +``` + +## PARAMETERS + +### -AlertId +Unique Identifier of Alert / ResourceId of alert. + +```yaml +Type: System.String +Parameter Sets: AlertById +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertRuleId +Filter on Alert Rule Id + +```yaml +Type: System.String +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomTimeRange +Supported format - \/\ where time is in ISO-8601 format + +```yaml +Type: System.String +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeContext +Include context (custom payload) of alert + +```yaml +Type: System.Boolean +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeEgressConfig +Include EgressConfig + +```yaml +Type: System.Boolean +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorCondition +Filter on Monitor Condition + +```yaml +Type: System.String +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorService +Filter on Monitor Service + +```yaml +Type: System.String +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageCount +Number of alerts to be fetched in a page. + +```yaml +Type: System.Int32 +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Project the required fields out of essentials. +Expected input is comma-separated. + +```yaml +Type: System.String +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity +Filter on Severity of alert + +```yaml +Type: System.String +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmartGroupId +Filter all the alerts having the Smart Group Id + +```yaml +Type: System.String +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +Alert property to use while sorting + +```yaml +Type: System.String +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortOrder +Sort Order + +```yaml +Type: System.String +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Filter on State of alert + +```yaml +Type: System.String +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroup +Filter on Resource group name of the target resource of alert. + +```yaml +Type: System.String +Parameter Sets: AlertsListByFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceId +Filter on Resource Id of the target resource of alert. + +```yaml +Type: System.String +Parameter Sets: AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceType +Filter on Resource type of the target resource of alert. + +```yaml +Type: System.String +Parameter Sets: AlertsListByFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeRange +Supported time range values - 1h, 1d, 7d, 30d (Default is 1d) + +```yaml +Type: System.String +Parameter Sets: AlertsListByFilter, AlertsListByTargetResourceIdFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSAlert + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Get-AzAlertObjectHistory.md b/azps-10.1.0/Az.AlertsManagement/Get-AzAlertObjectHistory.md new file mode 100644 index 0000000000..041de5ff84 --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Get-AzAlertObjectHistory.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AlertsManagement.dll-Help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/get-azalertobjecthistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Get-AzAlertObjectHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Get-AzAlertObjectHistory.md +--- + +# Get-AzAlertObjectHistory + +## SYNOPSIS +Gets Alert History information + +## SYNTAX + +### ByAlertId (Default) +``` +Get-AzAlertObjectHistory -AlertId [-DefaultProfile ] [] +``` + +### ByInputObject +``` +Get-AzAlertObjectHistory -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +**Get-AzAlertObjectHistory** cmdlet gets history of alert. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAlertObjectHistory -AlertId "afbf1b3a-0a6c-4f19-9c9b-644ccd7b1529" +``` + +Gets alert history details. + +## PARAMETERS + +### -AlertId +Unique Identifier of Alert / ResourceId of alert. + +```yaml +Type: System.String +Parameter Sets: ByAlertId +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input object from pipeline. + +```yaml +Type: Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSSmartGroup +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSAlertModification + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Get-AzAlertProcessingRule.md b/azps-10.1.0/Az.AlertsManagement/Get-AzAlertProcessingRule.md new file mode 100644 index 0000000000..63d05b1564 --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Get-AzAlertProcessingRule.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AlertsManagement.dll-Help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/get-azalertprocessingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Get-AzAlertProcessingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Get-AzAlertProcessingRule.md +--- + +# Get-AzAlertProcessingRule + +## SYNOPSIS +Get AlertProcessing Rules Information + +## SYNTAX + +### ListAlertProcessingRules (Default) +``` +Get-AzAlertProcessingRule [-DefaultProfile ] [] +``` + +### AlertProcessingRuleByName +``` +Get-AzAlertProcessingRule -Name -ResourceGroupName [-DefaultProfile ] + [] +``` + +### ListAlertProcessingRulesByResourceGroupName +``` +Get-AzAlertProcessingRule -ResourceGroupName [-DefaultProfile ] + [] +``` + +### ResourceId +``` +Get-AzAlertProcessingRule -ResourceId [-DefaultProfile ] [] +``` + +## DESCRIPTION +**Get-AzAlertProcessingRule** cmdlet gets alert processing rules configured. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAlertProcessingRule +``` + +List all alert processing rules configured in subscription. + +### Example 2 +```powershell +Get-AzAlertProcessingRule -ResourceGroupName "test-rg" +``` + +List all alert processing rules configured in resource group test-rg. + +### Example 3 +```powershell +Get-AzAlertProcessingRule -ResourceGroupName "test-rg" -Name "Test-AlertProcessing-Rule" | Format-List +``` + +Get the alert processing rule with name Test-AlertProcessing-Rule in test-rg resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of alert processing rule. + +```yaml +Type: System.String +Parameter Sets: AlertProcessingRuleByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name in which alert processing rule resides. + +```yaml +Type: System.String +Parameter Sets: AlertProcessingRuleByName, ListAlertProcessingRulesByResourceGroupName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Get Alert Processing rule by resource id. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSAlertProcessingRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Get-AzPrometheusRuleGroup.md b/azps-10.1.0/Az.AlertsManagement/Get-AzPrometheusRuleGroup.md new file mode 100644 index 0000000000..0216b4df5d --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Get-AzPrometheusRuleGroup.md @@ -0,0 +1,178 @@ +--- +external help file: Az.PrometheusRuleGroups.psm1-help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/get-azprometheusrulegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Get-AzPrometheusRuleGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Get-AzPrometheusRuleGroup.md +--- + +# Get-AzPrometheusRuleGroup + +## SYNOPSIS +Retrieve a Prometheus rule group definition. + +## SYNTAX + +### List (Default) +``` +Get-AzPrometheusRuleGroup [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzPrometheusRuleGroup -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPrometheusRuleGroup -ResourceGroupName -RuleGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPrometheusRuleGroup -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve a Prometheus rule group definition. + +## EXAMPLES + +### Example 1: Retrieve a Prometheus rule group definition from subscription. +```powershell +Get-AzPrometheusRuleGroup +``` + +```output +Name Location ClusterName Enabled +---- -------- ----------- ------- +newrule eastus True +newrule2 eastus False +``` + +Retrieve a Prometheus rule group definition from subscription. + +### Example 2: Retrieve a certain Prometheus rule group definition. +```powershell +Get-AzPrometheusRuleGroup -RuleGroupName newrule -ResourceGroupName MyGroupName +``` + +```output +Name Location ClusterName Enabled +---- -------- ----------- ------- +newrule eastus True +``` + +Retrieve a certain Prometheus rule group definition from ResourceGroup. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.IPrometheusRuleGroupsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List1, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleGroupName +The name of the rule group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: List, List1, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.IPrometheusRuleGroupsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.Api20230301.IPrometheusRuleGroupResource + +## 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. + - `[RuleGroupName ]`: The name of the rule group. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Get-AzSmartGroup.md b/azps-10.1.0/Az.AlertsManagement/Get-AzSmartGroup.md new file mode 100644 index 0000000000..496ec56fdf --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Get-AzSmartGroup.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AlertsManagement.dll-Help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/get-azsmartgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Get-AzSmartGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Get-AzSmartGroup.md +--- + +# Get-AzSmartGroup + +## SYNOPSIS +Gets Smart Groups information + +## SYNTAX + +### SmartGroupsListByFilter (Default) +``` +Get-AzSmartGroup [-SortBy ] [-SortOrder ] [-TimeRange ] + [-DefaultProfile ] [] +``` + +### SmartGroupById +``` +Get-AzSmartGroup -SmartGroupId [-DefaultProfile ] [] +``` + +## DESCRIPTION +**Get-AzSmartGroup** cmdlet gets smart groups information. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSmartGroup -TimeRange "1h" +``` + +List all smart groups formed in last 1 hour. Use Format-List to get the complete details of each smart group in list. + +### Example 2 +```powershell +Get-AzSmartGroup -SmartGroupId "afbf1b3a-0a6c-4f19-9c9b-644ccd7b1529" | Format-List +``` + +Get Smart Group details by Id (GUID) or Resource Id (Complete ARM Id) + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmartGroupId +Unique Identifier of SmartGroup / ResourceId of SmartGroup. + +```yaml +Type: System.String +Parameter Sets: SmartGroupById +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +Alert property to use while sorting + +```yaml +Type: System.String +Parameter Sets: SmartGroupsListByFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortOrder +Sort Order + +```yaml +Type: System.String +Parameter Sets: SmartGroupsListByFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeRange +Supported time range values - 1h, 1d, 7d, 30d (Default is 1d) + +```yaml +Type: System.String +Parameter Sets: SmartGroupsListByFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSSmartGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Get-AzSmartGroupHistory.md b/azps-10.1.0/Az.AlertsManagement/Get-AzSmartGroupHistory.md new file mode 100644 index 0000000000..1ce1e66139 --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Get-AzSmartGroupHistory.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AlertsManagement.dll-Help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/get-azsmartgrouphistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Get-AzSmartGroupHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Get-AzSmartGroupHistory.md +--- + +# Get-AzSmartGroupHistory + +## SYNOPSIS +Gets smart group history + +## SYNTAX + +### BySmartGroupId (Default) +``` +Get-AzSmartGroupHistory -SmartGroupId [-DefaultProfile ] [] +``` + +### ByInputObject +``` +Get-AzSmartGroupHistory -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +**Get-AzSmartGroupHistory** cmdlet gets smart group history. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSmartGroupHistory -SmartGroupId "afbf1b3a-0a6c-4f19-9c9b-644ccd7b1529" +``` + +Gets smart group history details. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input object from pipeline. + +```yaml +Type: Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSSmartGroup +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SmartGroupId +Unique Identifier of SmartGroup / ResourceId of alert. + +```yaml +Type: System.String +Parameter Sets: BySmartGroupId +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSSmartGroupModification + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Measure-AzAlertStatistic.md b/azps-10.1.0/Az.AlertsManagement/Measure-AzAlertStatistic.md new file mode 100644 index 0000000000..518be75e9a --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Measure-AzAlertStatistic.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AlertsManagement.dll-Help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/measure-azalertstatistic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Measure-AzAlertStatistic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Measure-AzAlertStatistic.md +--- + +# Measure-AzAlertStatistic + +## SYNOPSIS +Gets Alert Summary Information + +## SYNTAX + +### SummaryFilter (Default) +``` +Measure-AzAlertStatistic -GroupBy [-TargetResourceType ] [-TargetResourceGroup ] + [-MonitorService ] [-MonitorCondition ] [-Severity ] [-State ] + [-AlertRuleId ] [-TimeRange ] [-CustomTimeRange ] [-IncludeSmartGroupsCount ] + [-DefaultProfile ] [] +``` + +### SummaryTargetResourceIdFilter +``` +Measure-AzAlertStatistic -GroupBy -TargetResourceId [-MonitorService ] + [-MonitorCondition ] [-Severity ] [-State ] [-AlertRuleId ] + [-TimeRange ] [-CustomTimeRange ] [-IncludeSmartGroupsCount ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +**Measure-AzAlertStatistic** cmdlet gets alert summary details. + +## EXAMPLES + +### Example 1 +```powershell +Measure-AzAlertStatistic -GroupBy "severity,alertstate" -State "Active" +``` + +Summarize alerts count grouped by severity and state filtered by Active state. + +## PARAMETERS + +### -AlertRuleId +Filter on Alert Rule Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomTimeRange +Supported format - \/\ where time is in ISO-8601 format + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupBy +Summarize by property + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSmartGroupsCount +Include SmartGroups Count + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorCondition +Filter on Monitor Condition + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorService +Filter on Moniter Service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity +Filter on Severity of alert + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Filter on State of alert + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroup +Filter on Resource group name of the target resource of alert. + +```yaml +Type: System.String +Parameter Sets: SummaryFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceId +Filter on Resource Id of the target resource of alert. + +```yaml +Type: System.String +Parameter Sets: SummaryTargetResourceIdFilter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceType +Filter on Resource type of the target resource of alert. + +```yaml +Type: System.String +Parameter Sets: SummaryFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeRange +Supported time range values - 1h, 1d, 7d, 30d (Default is 1d) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSAlertsSummary + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/New-AzPrometheusRuleGroup.md b/azps-10.1.0/Az.AlertsManagement/New-AzPrometheusRuleGroup.md new file mode 100644 index 0000000000..ab4b8300ef --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/New-AzPrometheusRuleGroup.md @@ -0,0 +1,318 @@ +--- +external help file: Az.PrometheusRuleGroups.psm1-help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/new-azprometheusrulegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/New-AzPrometheusRuleGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/New-AzPrometheusRuleGroup.md +--- + +# New-AzPrometheusRuleGroup + +## SYNOPSIS +Create or update a Prometheus rule group definition. + +## SYNTAX + +``` +New-AzPrometheusRuleGroup -ResourceGroupName -RuleGroupName [-SubscriptionId ] + -Location -Rule -Scope [-ClusterName ] [-Description ] + [-Enabled] [-Interval ] [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Create or update a Prometheus rule group definition. + +## EXAMPLES + +### Example 1: Create Prometheus rule group definition with one rule. +```powershell +$rule1 = New-AzPrometheusRuleObject -Record "job_type:billing_jobs_duration_seconds:99p5m" +$scope = "/subscriptions/fffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/MyresourceGroup/providers/microsoft.monitor/accounts/MyAccounts" +New-AzPrometheusRuleGroup -ResourceGroupName MyresourceGroup -RuleGroupName MyRuleGroup -Location eastus -Rule $rule1 -Scope $scope -Enabled +``` + +```output +Name Location ClusterName Enabled +---- -------- ----------- ------- +MyRuleGroup eastus True +``` + +Create Prometheus rule group definition with one rule. + +### Example 2: Create Prometheus rule group definition with rules. +```powershell +$rule1 = New-AzPrometheusRuleObject -Record "job_type:billing_jobs_duration_seconds:99p5m" +$action = New-AzPrometheusRuleGroupActionObject -ActionGroupId /subscriptions/fffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/MyresourceGroup/providers/microsoft.insights/actiongroups/MyActionGroup -ActionProperty @{"key1" = "value1"} +$Timespan = New-TimeSpan -Minutes 15 +$rule2 = New-AzPrometheusRuleObject -Alert Billing_Processing_Very_Slow -Expression "job_type:billing_jobs_duration_seconds:99p5m > 30" -Enabled $false -Severity 3 -For $Timespan -Label @{"team"="prod"} -Annotation @{"annotation" = "value"} -ResolveConfigurationAutoResolved $true -ResolveConfigurationTimeToResolve $Timespan -Action $action +$rules = @($rule1, $rule2) +$scope = "/subscriptions/fffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/MyresourceGroup/providers/microsoft.monitor/accounts/MyAccounts" +New-AzPrometheusRuleGroup -ResourceGroupName MyresourceGroup -RuleGroupName MyRuleGroup -Location eastus -Rule $rule1 -Scope $scope -Enabled +``` + +```output +Name Location ClusterName Enabled +---- -------- ----------- ------- +MyRuleGroup eastus True +``` + +Create Prometheus rule group definition with rules. + +## PARAMETERS + +### -ClusterName +Apply rule to data from a specific cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Rule group description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Enable/disable rule group. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Interval +The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. +Should be between 1 and 15 minutes + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +Defines the rules in the Prometheus rule group. +To construct, see NOTES section for RULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.Api20230301.IPrometheusRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleGroupName +The name of the rule group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Target Azure Monitor workspaces resource ids. +This api-version is currently limited to creating with one scope. +This may change in future. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.Api20230301.IPrometheusRuleGroupResource + +## 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. + + +`RULE `: Defines the rules in the Prometheus rule group. + - `Expression `: The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by 'interval', and the result recorded as a new set of time series with the metric name as given by 'record'. + - `[Action ]`: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. + - `[ActionGroupId ]`: The resource id of the action group to use. + - `[ActionProperty ]`: The properties of an action group object. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[Alert ]`: Alert rule name. + - `[Annotation ]`: The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[Enabled ]`: Enable/disable rule. + - `[For ]`: The amount of time alert must be active before firing. + - `[Label ]`: Labels to add or overwrite before storing the result. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[Record ]`: Recorded metrics name. + - `[ResolveConfigurationAutoResolved ]`: Enable alert auto-resolution. + - `[ResolveConfigurationTimeToResolve ]`: Alert auto-resolution timeout. + - `[Severity ]`: The severity of the alerts fired by the rule. Must be between 0 and 4. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/New-AzPrometheusRuleGroupActionObject.md b/azps-10.1.0/Az.AlertsManagement/New-AzPrometheusRuleGroupActionObject.md new file mode 100644 index 0000000000..7db39a9aa2 --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/New-AzPrometheusRuleGroupActionObject.md @@ -0,0 +1,94 @@ +--- +external help file: Az.PrometheusRuleGroups.psm1-help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/Az.AlertsManagement/new-AzPrometheusRuleGroupActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/New-AzPrometheusRuleGroupActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/New-AzPrometheusRuleGroupActionObject.md +--- + +# New-AzPrometheusRuleGroupActionObject + +## SYNOPSIS +Create an in-memory object for PrometheusRuleGroupAction. + +## SYNTAX + +``` +New-AzPrometheusRuleGroupActionObject [-ActionGroupId ] + [-ActionProperty ] [] +``` + +## DESCRIPTION +Create an in-memory object for PrometheusRuleGroupAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for PrometheusRuleGroupAction. +```powershell +New-AzPrometheusRuleGroupActionObject -ActionGroupId /subscriptions/fffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/MyresourceGroup/providers/microsoft.insights/actiongroups/MyActionGroup -ActionProperty @{"key1" = "value1"} +``` + +```output +ActionGroupId +------------- +/subscriptions/fffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/MyresourceGroup/providers/microsoft.insights/acti… +``` + +Create an in-memory object for PrometheusRuleGroupAction. + +## PARAMETERS + +### -ActionGroupId +The resource id of the action group to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActionProperty +The properties of an action group object. +To construct, see NOTES section for ACTIONPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.Api20230301.IPrometheusRuleGroupActionProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.Api20230301.PrometheusRuleGroupAction + +## 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. + + +`ACTIONPROPERTY `: The properties of an action group object. + - `[(Any) ]`: This indicates any property can be added to this object. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/New-AzPrometheusRuleObject.md b/azps-10.1.0/Az.AlertsManagement/New-AzPrometheusRuleObject.md new file mode 100644 index 0000000000..17381d0b5f --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/New-AzPrometheusRuleObject.md @@ -0,0 +1,245 @@ +--- +external help file: Az.PrometheusRuleGroups.psm1-help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/Az.AlertsManagement/new-AzPrometheusRuleObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/New-AzPrometheusRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/New-AzPrometheusRuleObject.md +--- + +# New-AzPrometheusRuleObject + +## SYNOPSIS +Create an in-memory object for PrometheusRule. + +## SYNTAX + +``` +New-AzPrometheusRuleObject -Expression [-Action ] [-Alert ] + [-Annotation ] [-Enabled ] [-For ] + [-Label ] [-Record ] [-ResolveConfigurationAutoResolved ] + [-ResolveConfigurationTimeToResolve ] [-Severity ] [] +``` + +## DESCRIPTION +Create an in-memory object for PrometheusRule. + +## EXAMPLES + +### Example 1: Create an in-memory object for PrometheusRule. +```powershell +New-AzPrometheusRuleObject -Record "job_type:billing_jobs_duration_seconds:99p5m" -Expression 'histogram_quantile(0.99, sum(rate(jobs_duration_seconds_bucket{service="billing-processing"}[5m])) by (job_type))' +``` + +```output +Alert Enabled Expression +----- ------- ---------- + histogram_quantile(0.99, sum(rate(jobs_duration_seconds_bucket{service="billing-processing"}[5m])) by (job_type))' +``` + +Create an in-memory object for PrometheusRule. + +## PARAMETERS + +### -Action +Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. +To construct, see NOTES section for ACTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.Api20230301.IPrometheusRuleGroupAction[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Alert +Alert rule name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Annotation +The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. +The annotation values can be templated. +To construct, see NOTES section for ANNOTATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.Api20230301.IPrometheusRuleAnnotations +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Enable/disable rule. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expression +The PromQL expression to evaluate. +https://prometheus.io/docs/prometheus/latest/querying/basics/. +Evaluated periodically as given by 'interval', and the result recorded as a new set of time series with the metric name as given by 'record'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -For +The amount of time alert must be active before firing. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +Labels to add or overwrite before storing the result. +To construct, see NOTES section for LABEL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.Api20230301.IPrometheusRuleLabels +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Record +Recorded metrics name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResolveConfigurationAutoResolved +Enable alert auto-resolution. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResolveConfigurationTimeToResolve +Alert auto-resolution timeout. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity +The severity of the alerts fired by the rule. +Must be between 0 and 4. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.Api20230301.PrometheusRule + +## 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. + + +`ACTION `: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. + - `[ActionGroupId ]`: The resource id of the action group to use. + - `[ActionProperty ]`: The properties of an action group object. + - `[(Any) ]`: This indicates any property can be added to this object. + +`ANNOTATION `: The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated. + - `[(Any) ]`: This indicates any property can be added to this object. + +`LABEL `: Labels to add or overwrite before storing the result. + - `[(Any) ]`: This indicates any property can be added to this object. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Remove-AzAlertProcessingRule.md b/azps-10.1.0/Az.AlertsManagement/Remove-AzAlertProcessingRule.md new file mode 100644 index 0000000000..94fa771a01 --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Remove-AzAlertProcessingRule.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AlertsManagement.dll-Help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/remove-azalertprocessingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Remove-AzAlertProcessingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Remove-AzAlertProcessingRule.md +--- + +# Remove-AzAlertProcessingRule + +## SYNOPSIS +Deletes an alert processing rule + +## SYNTAX + +### ByName (Default) +``` +Remove-AzAlertProcessingRule -ResourceGroupName -Name + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### ByResourceId +``` +Remove-AzAlertProcessingRule -ResourceId [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Remove-AzAlertProcessingRule -InputObject [-DefaultProfile ] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +**Remove-AzAlertProcessingRule** cmdlet deletes an alert processing rule. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzAlertProcessingRule -ResourceGroupName "test-rg" -Name "AlertProcessingRuleName" +``` + +This cmdlet deletes the alert processing rule with name AlertProcessingRuleName in resource group test-rg + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The alert processing rule resource + +```yaml +Type: Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSAlertProcessingRule +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of alert processing rule + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +PassThru returns True if the remove alertProcessing rule succeeded. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Get Alert Processing rule by resource id. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSAlertProcessingRule + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Remove-AzPrometheusRuleGroup.md b/azps-10.1.0/Az.AlertsManagement/Remove-AzPrometheusRuleGroup.md new file mode 100644 index 0000000000..29a04cdff4 --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Remove-AzPrometheusRuleGroup.md @@ -0,0 +1,193 @@ +--- +external help file: Az.PrometheusRuleGroups.psm1-help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/remove-azprometheusrulegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Remove-AzPrometheusRuleGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Remove-AzPrometheusRuleGroup.md +--- + +# Remove-AzPrometheusRuleGroup + +## SYNOPSIS +Delete a Prometheus rule group definition. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPrometheusRuleGroup -ResourceGroupName -RuleGroupName [-SubscriptionId ] + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPrometheusRuleGroup -InputObject [-DefaultProfile ] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete a Prometheus rule group definition. + +## EXAMPLES + +### Example 1: Delete a Prometheus rule group definition. +```powershell +Remove-AzPrometheusRuleGroup -RuleGroupName MyRuleGroup -ResourceGroupName lnxtest +``` + +Delete a Prometheus rule group definition. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.IPrometheusRuleGroupsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleGroupName +The name of the rule group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.IPrometheusRuleGroupsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[Id ]`: Resource identity path + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RuleGroupName ]`: The name of the rule group. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Set-AzAlertProcessingRule.md b/azps-10.1.0/Az.AlertsManagement/Set-AzAlertProcessingRule.md new file mode 100644 index 0000000000..7b3e12b187 --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Set-AzAlertProcessingRule.md @@ -0,0 +1,672 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AlertsManagement.dll-Help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/set-azalertprocessingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Set-AzAlertProcessingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Set-AzAlertProcessingRule.md +--- + +# Set-AzAlertProcessingRule + +## SYNOPSIS +Create or update an alert processing rule. + +## SYNTAX + +### BySimplifiedFormatSuppressionActionRule (Default) +``` +Set-AzAlertProcessingRule -ResourceGroupName -Name [-Description ] + [-Enabled ] -Scope [-Tag ] + [-FilterSeverity ] [-FilterMonitorService ] [-FilterMonitorCondition ] + [-FilterTargetResource ] [-FilterTargetResourceType ] [-FilterTargetResourceGroup ] + [-FilterAlertRuleId ] [-FilterAlertRuleName ] [-FilterDescription ] + [-FilterAlertContext ] [-FilterSignalType ] -AlertProcessingRuleType + [-ScheduleStartDateTime ] [-ScheduleEndDateTime ] [-ScheduleTimeZone ] + [-ScheduleReccurenceType ] [-ScheduleReccurence2Type ] + [-ScheduleReccurenceDaysOfWeek ] [-ScheduleReccurence2DaysOfWeek ] + [-ScheduleReccurenceDaysOfMonth ] [-ScheduleReccurence2DaysOfMonth ] + [-ScheduleReccurenceStartTime ] [-ScheduleReccurence2StartTime ] + [-ScheduleReccurenceEndTime ] [-ScheduleReccurence2EndTime ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Set-AzAlertProcessingRule -InputObject [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### BySimplifiedFormatActionGroupActionRule +``` +Set-AzAlertProcessingRule -ResourceGroupName -Name [-Description ] + [-Enabled ] -Scope [-Tag ] + [-FilterSeverity ] [-FilterMonitorService ] [-FilterMonitorCondition ] + [-FilterTargetResource ] [-FilterTargetResourceType ] [-FilterTargetResourceGroup ] + [-FilterAlertRuleId ] [-FilterAlertRuleName ] [-FilterDescription ] + [-FilterAlertContext ] [-FilterSignalType ] -AlertProcessingRuleType + [-ScheduleStartDateTime ] [-ScheduleEndDateTime ] [-ScheduleTimeZone ] + [-ScheduleReccurenceType ] [-ScheduleReccurence2Type ] + [-ScheduleReccurenceDaysOfWeek ] [-ScheduleReccurence2DaysOfWeek ] + [-ScheduleReccurenceDaysOfMonth ] [-ScheduleReccurence2DaysOfMonth ] + [-ScheduleReccurenceStartTime ] [-ScheduleReccurence2StartTime ] + [-ScheduleReccurenceEndTime ] [-ScheduleReccurence2EndTime ] -ActionGroupId + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +**Set-AzAlertProcessingRule** creates or updates an alert processing rule. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzAlertProcessingRule -ResourceGroupName "test-rg" -Name "AddActionGroupToSubscription" -Scope "/subscriptions/MySubscriptionId" -Description "Add ActionGroup1 to all alerts in the subscription" -Enabled "True" -AlertProcessingRuleType "AddActionGroups" -ActionGroupId "/subscriptions/MySubscriptionId/resourcegroups/MyResourceGroup1/providers/microsoft.insights/actiongroups/ActionGroup1" +``` + +This cmdlet creates an alert processing rule that adds an action group to all alerts in a resource group. + +### Example 2 +```powershell +Set-AzAlertProcessingRule -ResourceGroupName "test-rg" -Name "AddActionGroupsBySeverity" -Scope "/subscriptions/MySubscriptionId" -Description "Add AGId1 and AGId2 to all Sev0 and Sev1 alerts in these resourceGroups" -Enabled "True" -AlertProcessingRuleType "AddActionGroups" -ActionGroupId "/subscriptions/MySubscriptionId/resourcegroups/MyResourceGroup1/providers/microsoft.insights/actiongroups/ActionGroup1,/subscriptions/MySubscriptionId/resourceGroups/MyResourceGroup2/providers/microsoft.insights/actionGroups/MyActionGroup2" -FilterMonitorCondition "Equals:Sev0,Sev1" +``` + +This cmdlet creates a rule that adds two action groups to all Sev0 and Sev1 alerts + +## PARAMETERS + +### -ActionGroupId +Action Group Ids which are to be notified, Comma separated list of values +Required only if alert processing rule type is AddActionGroups. + + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertProcessingRuleType +Alert Processing rule Type. Allowed values: AddActionGroups, RemoveAllActionGroups. + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of Alert Processing Rule + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Indicate if the given alert processing rule is enabled or disabled (default is enabled). Allowed values: False, True. + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterAlertContext +Expected format - {\:\} operation: one of +For eg. +Contains:smartgroups + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterAlertRuleId +Expected format - {\:\} operation: one of +For eg. +Equals:/subscriptions/MySubscriptionId/resourceGroups/abvarma/providers/microsoft.insights/metricAlerts/test-mrmc-vm-abvarma + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterAlertRuleName +Expected format - {\:\} operation: one of +For eg. +Equals:ARM Name Test1,ARM Name Test2 + + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterDescription +Expected format - {\:\} operation: one of +For eg. +Contains:Test Alert + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterMonitorCondition +Expected format - {\:\} operation: one of +For eg. +NotEquals:Resolved + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterMonitorService +Expected format - {\:\} operation: one of +For eg. +Equals:Platform,Log Analytics + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterSeverity +Expected format - {\:\} severity: one of . +For eg. +Equals:Sev0,Sev1 + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterSignalType +Expected format - {\:\} operation: one of +For eg. +Equals:Metric + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterTargetResource +Expected format - {\:\} operation: one of +For eg. +Equals:mySQLDataBaseName + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterTargetResourceGroup +Expected format - {\:\} operation: one of +For eg. +NotEquals:/subscriptions/\/resourceGroups/test + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterTargetResourceType +Expected format - {\:\} operation: one of +For eg. +Contains:Virtual Machines,Storage Account + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The alert processing rule resource + +```yaml +Type: Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSAlertProcessingRule +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Alert Processing Rule Name + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleEndDateTime +End Date Time. Format 2022-09-21 06:00:00 +Should be mentioned in case of Reccurent Schedule - Daily, Weekly or Monthly. + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleReccurence2DaysOfMonth +List of recurrence pattern values Expected format For a monthly recurrence type. +comma separated list of values For eg. 1,3,12 + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleReccurence2DaysOfWeek +List of recurrence pattern values Expected format For a weekly recurrence type. +comma separated list of values For eg. Monday,Saturday + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleReccurence2EndTime +Reccurence Start Time in the timezone of ScheduleTimeZone parameter. Format 06:00:00 +Should be mentioned in case of Reccurent Schedule - Daily, Weekly or Monthly. + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleReccurence2StartTime +Reccurence Start Time in the timezone of ScheduleTimeZone parameter. Format 06:00:00 +Should be mentioned in case of Reccurent Schedule - Daily, Weekly or Monthly. + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleReccurence2Type +Specifies when the processing rule should be applied. +Allowed values: Daily, Monthly, Weekly. + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleReccurenceDaysOfMonth +List of recurrence pattern values Expected format For a monthly recurrence type. +comma separated list of values For eg. 1,3,12 + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleReccurenceDaysOfWeek +List of recurrence pattern values Expected format For a weekly recurrence type. +comma separated list of values For eg. Monday,Saturday + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleReccurenceEndTime +Reccurence Start Time in the timezone of ScheduleTimeZone parameter. Format 06:00:00 +Should be mentioned in case of Reccurent Schedule - Daily, Weekly or Monthly. + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleReccurenceStartTime +Reccurence Start Time in the timezone of ScheduleTimeZone parameter. Format 06:00:00 +Should be mentioned in case of Reccurent Schedule - Daily, Weekly or Monthly. + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleReccurenceType +Specifies when the processing rule should be applied. +Allowed values: Daily, Monthly, Weekly. + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleStartDateTime +Start Date Time. Format 2022-09-21 06:00:00 +Should be mentioned in case of Reccurent Schedule - Daily, Weekly or Monthly. + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleTimeZone +Schedule time zone. Default: UTC. + +```yaml +Type: System.String +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +List of resource IDs, Comma separated list of values +The rule will apply to alerts that fired on resources within that scope + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Alert Processing rule tags. +For eg. +@{"tag1" = "key1";"tag2" = "key2"} +Use {} to clear existing tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: BySimplifiedFormatSuppressionActionRule, BySimplifiedFormatActionGroupActionRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSActionRule + +## OUTPUTS + +### Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSActionRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Update-AzAlertProcessingRule.md b/azps-10.1.0/Az.AlertsManagement/Update-AzAlertProcessingRule.md new file mode 100644 index 0000000000..449c9c9340 --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Update-AzAlertProcessingRule.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AlertsManagement.dll-Help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/update-azalertprocessingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Update-AzAlertProcessingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Update-AzAlertProcessingRule.md +--- + +# Update-AzAlertProcessingRule + +## SYNOPSIS +Updates alert processing rule properties. + +## SYNTAX + +### ByNameSimplifiedPatch (Default) +``` +Update-AzAlertProcessingRule -Name -ResourceGroupName [-Enabled ] [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByResourceId +``` +Update-AzAlertProcessingRule -ResourceId [-Enabled ] [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Update-AzAlertProcessingRule -InputObject [-Enabled ] [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +**Update-AzAlertProcessingRule** cmdlet updates alert processing rule properties - enabled status and tags. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzAlertProcessingRule -ResourceGroupName "test-rg" -Name "Test-AlertProcessingRule" -Enabled "False" +``` + +This cmdlet disables the alert processing rule. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Alert Processing rule status + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The action rule resource + +```yaml +Type: Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSAlertProcessingRule +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Alert Processing rule name + +```yaml +Type: System.String +Parameter Sets: ByNameSimplifiedPatch +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Alert Processing rule name + +```yaml +Type: System.String +Parameter Sets: ByNameSimplifiedPatch +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of action rule + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Alert Processing rule tags +For eg. +@{"tag1" = "key1";"tag2" = "key2"} +Use {} to clear existing tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSAlertProcessingRule + +## OUTPUTS + +### Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSAlertProcessingRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Update-AzAlertState.md b/azps-10.1.0/Az.AlertsManagement/Update-AzAlertState.md new file mode 100644 index 0000000000..130473f368 --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Update-AzAlertState.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AlertsManagement.dll-Help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/update-azalertstate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Update-AzAlertState.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Update-AzAlertState.md +--- + +# Update-AzAlertState + +## SYNOPSIS +Updates alert state + +## SYNTAX + +### ByAlertId (Default) +``` +Update-AzAlertState -AlertId -State [-Comment ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Update-AzAlertState -State [-Comment ] -InputObject + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +**Update-AzAlertState** cmdlet updates alert state. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzAlertState -AlertId "afbf1b3a-0a6c-4f19-9c9b-644ccd7b1529" -State "Closed" +``` + +This cmdlet updates the alert state to Closed. + +## PARAMETERS + +### -AlertId +Unique Identifier of Alert / ResourceId of alert. + +```yaml +Type: System.String +Parameter Sets: ByAlertId +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +Reason why to change alert state + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input object from pipeline. + +```yaml +Type: Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSAlert +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -State +Updated Alert State + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSAlert + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Update-AzPrometheusRuleGroup.md b/azps-10.1.0/Az.AlertsManagement/Update-AzPrometheusRuleGroup.md new file mode 100644 index 0000000000..e156e0014b --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Update-AzPrometheusRuleGroup.md @@ -0,0 +1,214 @@ +--- +external help file: Az.PrometheusRuleGroups.psm1-help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/update-azprometheusrulegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Update-AzPrometheusRuleGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Update-AzPrometheusRuleGroup.md +--- + +# Update-AzPrometheusRuleGroup + +## SYNOPSIS +Update an Prometheus rule group definition. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPrometheusRuleGroup -ResourceGroupName -RuleGroupName [-SubscriptionId ] + [-Enabled] [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPrometheusRuleGroup -InputObject [-Enabled] [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update an Prometheus rule group definition. + +## EXAMPLES + +### Example 1: Update an Prometheus rule group definition. +```powershell +Update-AzPrometheusRuleGroup -RuleGroupName MyRuleGroup -ResourceGroupName MyResourceGroup -Enabled:$false +``` + +```output +Name Location ClusterName Enabled +---- -------- ----------- ------- +MyRuleGroup eastus False +``` + +Disable certain rule group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +the flag that indicates whether the Prometheus rule group is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.IPrometheusRuleGroupsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleGroupName +The name of the rule group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.IPrometheusRuleGroupsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PrometheusRuleGroups.Models.Api20230301.IPrometheusRuleGroupResource + +## 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. + - `[RuleGroupName ]`: The name of the rule group. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AlertsManagement/Update-AzSmartGroupState.md b/azps-10.1.0/Az.AlertsManagement/Update-AzSmartGroupState.md new file mode 100644 index 0000000000..f6e80a3f63 --- /dev/null +++ b/azps-10.1.0/Az.AlertsManagement/Update-AzSmartGroupState.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AlertsManagement.dll-Help.xml +Module Name: Az.AlertsManagement +online version: https://learn.microsoft.com/powershell/module/az.alertsmanagement/update-azsmartgroupstate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Update-AzSmartGroupState.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AlertsManagement/AlertsManagement/help/Update-AzSmartGroupState.md +--- + +# Update-AzSmartGroupState + +## SYNOPSIS +Updates smart group state + +## SYNTAX + +### BySmartGroupId (Default) +``` +Update-AzSmartGroupState -SmartGroupId -State [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Update-AzSmartGroupState -State -InputObject [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +**Update-AzSmartGroupState** cmdlet updates smart group state. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSmartGroupState -SmartGroupId "afbf1b3a-0a6c-4f19-9c9b-644ccd7b1529" -State "Acknowledged" +``` + +This cmdlet updates the smart group state to Acknowleged. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input object from pipeline. + +```yaml +Type: Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSSmartGroup +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SmartGroupId +Unique Identifier of Smart Group / ResourceId of smart group. + +```yaml +Type: System.String +Parameter Sets: BySmartGroupId +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Updated Smart group State + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSSmartGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AnalysisServices/Add-AzAnalysisServicesAccount.md b/azps-10.1.0/Az.AnalysisServices/Add-AzAnalysisServicesAccount.md new file mode 100644 index 0000000000..6a4a9e6997 --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/Add-AzAnalysisServicesAccount.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices.Dataplane.dll-Help.xml +Module Name: Az.AnalysisServices +online version: https://learn.microsoft.com/powershell/module/az.analysisservices/add-azanalysisservicesaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Add-AzAnalysisServicesAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Add-AzAnalysisServicesAccount.md +--- + +# Add-AzAnalysisServicesAccount + +## SYNOPSIS +Adds an authenticated account to use for Azure Analysis Services server cmdlet requests. + +## SYNTAX + +### UserParameterSetName (Default) +``` +Add-AzAnalysisServicesAccount [[-RolloutEnvironment] ] [[-Credential] ] [-WhatIf] + [-Confirm] [] +``` + +### ServicePrincipalWithPasswordParameterSetName +``` +Add-AzAnalysisServicesAccount [-RolloutEnvironment] [-Credential] [-ServicePrincipal] + -TenantId [-WhatIf] [-Confirm] [] +``` + +### ServicePrincipalWithCertificateParameterSetName +``` +Add-AzAnalysisServicesAccount [-RolloutEnvironment] [-ServicePrincipal] -TenantId + -ApplicationId -CertificateThumbprint [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Add-AzAnalysisServicesAccount cmdlet is used to login to an instance of Azure Analysis Services server + +## EXAMPLES + +### Example 1 +```powershell +Add-AzAnalysisServicesAccount +``` + +```output +RolloutEnvironment: westcentralus.asazure.windows.net +Credential: $UserCredential +``` + +This example will add the account specified by the $UserCredential variable to the westcentralus.asazure.windows.net Analysis Services environment. + +### Example 2 +```powershell +$ApplicationCredential = Get-Credential +Add-AzAnalysisServicesAccount -RolloutEnvironment 'westcentralus.asazure.windows.net' -ServicePrincipal -Credential $ApplicationCredential -TenantId "xxxx-xxxx-xxxx-xxxx" +``` + +The first command gets the application service principal credentials, and then stores them in the $ApplicationCredential variable. +The second command add the application service principal account specified by the $ApplicationCredential variable and TenantId to the westcentralus.asazure.windows.net Analysis Services environment. + +### Example 3 +```powershell +Add-AzAnalysisServicesAccount -RolloutEnvironment 'westcentralus.asazure.windows.net' -ServicePrincipal -ApplicationId "yyyy-yyyy-yyyy-yyyy" -CertificateThumbprint 'zzzzzzzzzzzzzzzz' -TenantId "xxxx-xxxx-xxxx-xxxx" +``` + +This example will add the application service principal account specified by the ApplicationId, TenantId and CertificateThumbprint to the westcentralus.asazure.windows.net Analysis Services environment. + +## PARAMETERS + +### -ApplicationId +The application ID. + +```yaml +Type: System.String +Parameter Sets: ServicePrincipalWithCertificateParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateThumbprint +Certificate Hash (Thumbprint) + +```yaml +Type: System.String +Parameter Sets: ServicePrincipalWithCertificateParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Login credentials + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: UserParameterSetName +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: ServicePrincipalWithPasswordParameterSetName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RolloutEnvironment +Name of the Azure Analysis Services environment to which to logon to. Given the full name of the server for example asazure://westcentralus.asazure.windows.net/testserver , the correct value for this variable will be westcentralus.asazure.windows.net + +```yaml +Type: System.String +Parameter Sets: UserParameterSetName +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ServicePrincipalWithPasswordParameterSetName, ServicePrincipalWithCertificateParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipal +Indicates that this account authenticates by providing service principal credentials. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ServicePrincipalWithPasswordParameterSetName, ServicePrincipalWithCertificateParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +Tenant name or ID + +```yaml +Type: System.String +Parameter Sets: ServicePrincipalWithPasswordParameterSetName, ServicePrincipalWithCertificateParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.AnalysisServices.Dataplane.AsAzureProfile + +## NOTES +Alias: Login-AzAsAccount + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AnalysisServices/Az.AnalysisServices.md b/azps-10.1.0/Az.AnalysisServices/Az.AnalysisServices.md new file mode 100644 index 0000000000..b042aa186e --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/Az.AnalysisServices.md @@ -0,0 +1,54 @@ +--- +Module Name: Az.AnalysisServices +Module Guid: acace26c-1775-4100-85c0-20c4d71eaa21 +Download Help Link: https://learn.microsoft.com/powershell/module/az.analysisservices +Help Version: 0.0.1.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Az.AnalysisServices.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Az.AnalysisServices.md +--- + +# Az.AnalysisServices Module +## Description +This topic displays help topics for the Azure AnalysisServices cmdlets. + +## Az.AnalysisServices Cmdlets +### [Add-AzAnalysisServicesAccount](Add-AzAnalysisServicesAccount.md) +Adds an authenticated account to use for Azure Analysis Services server cmdlet requests. + +### [Export-AzAnalysisServicesInstanceLog](Export-AzAnalysisServicesInstanceLog.md) +Exports a log from an instance of Analysis Services server in the currently logged in Environment as specified in Add-AzAnalysisServicesAccount command + +### [Get-AzAnalysisServicesServer](Get-AzAnalysisServicesServer.md) +Gets the details of an Analysis Services server. + +### [New-AzAnalysisServicesFirewallConfig](New-AzAnalysisServicesFirewallConfig.md) +Creates a new Analysis Services firewall config + +### [New-AzAnalysisServicesFirewallRule](New-AzAnalysisServicesFirewallRule.md) +Creates a new Analysis Services firewall rule + +### [New-AzAnalysisServicesServer](New-AzAnalysisServicesServer.md) +Creates a new Analysis Services server + +### [Remove-AzAnalysisServicesServer](Remove-AzAnalysisServicesServer.md) +Deletes an instance of Analysis Services server + +### [Restart-AzAnalysisServicesInstance](Restart-AzAnalysisServicesInstance.md) +Restarts an instance of Analysis Services server in the currently logged in Environment as specified in Add-AzAnalysisServicesAccount command + +### [Resume-AzAnalysisServicesServer](Resume-AzAnalysisServicesServer.md) +Resumes an instance of Analysis Services server + +### [Set-AzAnalysisServicesServer](Set-AzAnalysisServicesServer.md) +Modifies an instance of Analysis Services server + +### [Suspend-AzAnalysisServicesServer](Suspend-AzAnalysisServicesServer.md) +Suspends an instance of Analysis Services server + +### [Sync-AzAnalysisServicesInstance](Sync-AzAnalysisServicesInstance.md) +Synchronizes a specified database on the specified instance of Analysis Services server to all the query scaleout instances in the currently logged in Environment as specified in Add-AzAnalysisServicesAccount command + +### [Test-AzAnalysisServicesServer](Test-AzAnalysisServicesServer.md) +Tests the existence of an instance of Analysis Services server + diff --git a/azps-10.1.0/Az.AnalysisServices/Export-AzAnalysisServicesInstanceLog.md b/azps-10.1.0/Az.AnalysisServices/Export-AzAnalysisServicesInstanceLog.md new file mode 100644 index 0000000000..39df09c67a --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/Export-AzAnalysisServicesInstanceLog.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices.Dataplane.dll-Help.xml +Module Name: Az.AnalysisServices +online version: https://learn.microsoft.com/powershell/module/az.analysisservices/export-azanalysisservicesinstancelog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Export-AzAnalysisServicesInstanceLog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Export-AzAnalysisServicesInstanceLog.md +--- + +# Export-AzAnalysisServicesInstanceLog + +## SYNOPSIS +Exports a log from an instance of Analysis Services server in the currently logged in Environment as specified in Add-AzAnalysisServicesAccount command + +## SYNTAX + +``` +Export-AzAnalysisServicesInstanceLog -OutputPath [-Force] [-Instance] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The Export-AzAnalysisServicesInstance cmdlet exports log from an instance of Azure Analysis Services server to file + +## EXAMPLES + +### Example 1 +```powershell +Export-AzAnalysisServicesInstanceLog -Instance testserver -OutputPath C:\path\to\log\testserver.log +``` + +This command will export log from the server 'testserver' in the environment specified in the Add-AzAnalysisServicesAccount command +and save it to file specified in OutputPath 'C:\path\to\log\testserver.log' + +## PARAMETERS + +### -Force +Overwrite file if exists without asking + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Name of the Analysis Services server instance + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OutputPath +Output path to file to export log + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES +Alias: Export-AzAsInstanceLog + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AnalysisServices/Get-AzAnalysisServicesServer.md b/azps-10.1.0/Az.AnalysisServices/Get-AzAnalysisServicesServer.md new file mode 100644 index 0000000000..4eeb26d547 --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/Get-AzAnalysisServicesServer.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices.dll-Help.xml +Module Name: Az.AnalysisServices +online version: https://learn.microsoft.com/powershell/module/az.analysisservices/get-azanalysisservicesserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Get-AzAnalysisServicesServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Get-AzAnalysisServicesServer.md +--- + +# Get-AzAnalysisServicesServer + +## SYNOPSIS +Gets the details of an Analysis Services server. + +## SYNTAX + +``` +Get-AzAnalysisServicesServer [[-ResourceGroupName] ] [[-Name] ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzAnalysisServicesServer cmdlet gets the details of an Analysis Services server. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAnalysisServicesServer -ResourceGroupName "ResourceGroup03" +``` + +This command gets all Azure Analysis Services servers in the resource group named ResourceGroup03. + +### Example 2: Get a server +```powershell +Get-AzAnalysisServicesServer -ResourceGroupName "ResourceGroup03" -Name "testserver" +``` + +This command gets the Azure Analysis Services server named testserver in the resource group named ResourceGroup03. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Analysis Services server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure resource group to which the server belongs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesServer + +## NOTES +Alias: Get-AzAs + +## RELATED LINKS + +[New-AzAnalysisServicesServer ](./New-AzAnalysisServicesServer .md) + +[Remove-AzAnalysisServicesServer ](./Remove-AzAnalysisServicesServer .md) diff --git a/azps-10.1.0/Az.AnalysisServices/New-AzAnalysisServicesFirewallConfig.md b/azps-10.1.0/Az.AnalysisServices/New-AzAnalysisServicesFirewallConfig.md new file mode 100644 index 0000000000..0d911a494a --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/New-AzAnalysisServicesFirewallConfig.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices.dll-Help.xml +Module Name: Az.AnalysisServices +online version: https://learn.microsoft.com/powershell/module/az.analysisservices/new-azanalysisservicesfirewallconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/New-AzAnalysisServicesFirewallConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/New-AzAnalysisServicesFirewallConfig.md +--- + +# New-AzAnalysisServicesFirewallConfig + +## SYNOPSIS +Creates a new Analysis Services firewall config + +## SYNTAX + +``` +New-AzAnalysisServicesFirewallConfig [-EnablePowerBIService] + [-FirewallRule ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The New-AzAnalysisServicesFirewallConfig creates a new firewall config object + +## EXAMPLES + +### Example 1 +```powershell +$rule1 = New-AzAnalysisServicesFirewallRule -FirewallRuleName rule1 -RangeStart 0.0.0.0 -RangeEnd 255.255.255.255 +$rule2 = New-AzAnalysisServicesFirewallRule -FirewallRuleName rule2 -RangeStart 6.6.6.6 -RangeEnd 7.7.7.7 +$config = New-AzAnalysisServicesFirewallConfig -EnablePowerBIService -FirewallRule $rule1,$rule2 +``` + +Creates a firewall config object with two rules while also enabling access from Power BI service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePowerBIService +A flag to indicate if the firewall is allowing access from Power BI + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRule +A list of firewall rules + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallRule] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallRule, Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallConfig + +## NOTES + +## RELATED LINKS + +[New-AzAnalysisServicesFirewallRule](./New-AzAnalysisServicesFirewallRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.AnalysisServices/New-AzAnalysisServicesFirewallRule.md b/azps-10.1.0/Az.AnalysisServices/New-AzAnalysisServicesFirewallRule.md new file mode 100644 index 0000000000..1ae4186c72 --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/New-AzAnalysisServicesFirewallRule.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices.dll-Help.xml +Module Name: Az.AnalysisServices +online version: https://learn.microsoft.com/powershell/module/az.analysisservices/new-azanalysisservicesfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/New-AzAnalysisServicesFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/New-AzAnalysisServicesFirewallRule.md +--- + +# New-AzAnalysisServicesFirewallRule + +## SYNOPSIS +Creates a new Analysis Services firewall rule + +## SYNTAX + +``` +New-AzAnalysisServicesFirewallRule [-FirewallRuleName] [-RangeStart] [-RangeEnd] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The New-AzAnalysisServicesFirewallRule creates a new firewall rule object. + +## EXAMPLES + +### Example 1 +```powershell +New-AzAnalysisServicesFirewallRule -FirewallRuleName rule1 -RangeStart 0.0.0.0 -RangeEnd 255.255.255.255 +``` + +Creates a firewall rule named rule1 with start range 0.0.0.0 and end range 255.255.255.255 + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleName +Name of firewall rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RangeEnd +The range end of a firewall rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RangeStart +The range start of a firewall rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallRule + +## NOTES + +## RELATED LINKS + +[New-AzAnalysisServicesFirewallConfig](./New-AzAnalysisServicesFirewallConfig.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.AnalysisServices/New-AzAnalysisServicesServer.md b/azps-10.1.0/Az.AnalysisServices/New-AzAnalysisServicesServer.md new file mode 100644 index 0000000000..cf49d1867d --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/New-AzAnalysisServicesServer.md @@ -0,0 +1,287 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices.dll-Help.xml +Module Name: Az.AnalysisServices +online version: https://learn.microsoft.com/powershell/module/az.analysisservices/new-azanalysisservicesserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/New-AzAnalysisServicesServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/New-AzAnalysisServicesServer.md +--- + +# New-AzAnalysisServicesServer + +## SYNOPSIS +Creates a new Analysis Services server + +## SYNTAX + +``` +New-AzAnalysisServicesServer [-ResourceGroupName] [-Name] [-Location] + [-Sku] [[-Tag] ] [[-Administrator] ] [[-BackupBlobContainerUri] ] + [-ReadonlyReplicaCount ] [-DefaultConnectionMode ] + [-FirewallConfig ] [-GatewayResourceId ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The New-AzAnalysisServicesServer cmdlet creates a new Analysis Services server + +## EXAMPLES + +### Example 1 +```powershell +New-AzAnalysisServicesServer -ResourceGroupName "testresourcegroup" -Name "testserver" -Location "West-US" -Sku "S1" +``` + +Creates a server named testserver in the Azure region West-US and in resource group testresourcegroup. The sku level for the server will be S1. + +### Example 2 + +Creates a new Analysis Services server. (autogenerated) + + +```powershell +$rule1 = New-AzAnalysisServicesFirewallRule -FirewallRuleName rule1 -RangeStart 0.0.0.0 -RangeEnd 255.255.255.255 +$rule2 = New-AzAnalysisServicesFirewallRule -FirewallRuleName rule2 -RangeStart 6.6.6.6 -RangeEnd 7.7.7.7 +$config = New-AzAnalysisServicesFirewallConfig -EnablePowerBIService -FirewallRule $rule1,$rule2 +New-AzAnalysisServicesServer -Administrator 'testuser1@contoso.com' -FirewallConfig $config -Location 'West-US' -Name 'testserver' -ResourceGroupName 'testresourcegroup' -Sku 'S1' +``` + +## PARAMETERS + +### -Administrator +A string representing a comma separated list of users or groups to be set as administrators on the server. The users or groups need to be specified UPN format e.g. user@contoso.com or groups@contoso.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackupBlobContainerUri +The blob container Uri for backup the Analysis Services server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultConnectionMode +Default connection mode of an Analysis service server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: All, Readonly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallConfig +Firewall config of an Analysis server + +```yaml +Type: Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallConfig +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GatewayResourceId +Gateway resource Id to associate to an Analysis server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +The Azure region where the Analysis Services server is hosted + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the Analysis Services server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReadonlyReplicaCount +Read only replica count of an Analysis service server + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure resource group to which the server belongs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +The name of the Sku for the server. +The supported values are 'S0', 'S1', 'S2', 'S4', 'S8', 'S9', 'S8v2', 'S9v2' for the Standard tier; 'B1', 'B2' for the Basic tier and 'D1' for Development tier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table set as tags on the server. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts user to confirm whether to perform the operation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes the actions the current operation will perform without actually performing them + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Int32 + +### Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallConfig + +## OUTPUTS + +### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesServer + +## NOTES +Alias: New-AzAs + +## RELATED LINKS + +[Get-AzAnalysisServicesServer](./Get-AzAnalysisServicesServer.md) + +[Remove-AzAnalysisServicesServer](./Remove-AzAnalysisServicesServer.md) diff --git a/azps-10.1.0/Az.AnalysisServices/Remove-AzAnalysisServicesServer.md b/azps-10.1.0/Az.AnalysisServices/Remove-AzAnalysisServicesServer.md new file mode 100644 index 0000000000..e070f72a42 --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/Remove-AzAnalysisServicesServer.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices.dll-Help.xml +Module Name: Az.AnalysisServices +online version: https://learn.microsoft.com/powershell/module/az.analysisservices/remove-azanalysisservicesserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Remove-AzAnalysisServicesServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Remove-AzAnalysisServicesServer.md +--- + +# Remove-AzAnalysisServicesServer + +## SYNOPSIS +Deletes an instance of Analysis Services server + +## SYNTAX + +``` +Remove-AzAnalysisServicesServer [-Name] [[-ResourceGroupName] ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Remove-AzAnalysisServicesServer cmdlet deletes an instance of Analysis Services server + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzAnalysisServicesServer -Name "testserver" -ResourceGroupName "testgroup" +``` + +This command will remove the server named testserver in the resourcegroup testgroup + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Analysis Services server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Will return the deleted server details if the operation completes successfully + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure resource group to which the server belongs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts user to confirm whether to perform the operation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes the actions the current operation will perform without actually performing them + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesServer + +## NOTES +Alias: Remove-AzAs + +## RELATED LINKS + +[Get-AzAnalysisServicesServer](./Get-AzAnalysisServicesServer.md) + +[New-AzAnalysisServicesServer](./New-AzAnalysisServicesServer.md) diff --git a/azps-10.1.0/Az.AnalysisServices/Restart-AzAnalysisServicesInstance.md b/azps-10.1.0/Az.AnalysisServices/Restart-AzAnalysisServicesInstance.md new file mode 100644 index 0000000000..10adfb220b --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/Restart-AzAnalysisServicesInstance.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices.Dataplane.dll-Help.xml +Module Name: Az.AnalysisServices +online version: https://learn.microsoft.com/powershell/module/az.analysisservices/restart-azanalysisservicesinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Restart-AzAnalysisServicesInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Restart-AzAnalysisServicesInstance.md +--- + +# Restart-AzAnalysisServicesInstance + +## SYNOPSIS +Restarts an instance of Analysis Services server in the currently logged in Environment as specified in Add-AzAnalysisServicesAccount command + +## SYNTAX + +``` +Restart-AzAnalysisServicesInstance [-Instance] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Restart-AzAnalysisServicesInstance cmdlet restarts an instance of Azure Analysis Services server + +## EXAMPLES + +### Example 1 +```powershell +Restart-AzAnalysisServicesInstance +``` + +```output +Instance: testserver +``` + +This command will restart the server 'testserver' in the environment specified in the Add-AzAnalysisServicesAccount command + +## PARAMETERS + +### -Instance +Name of the Analysis Services server instance to restart + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Specifying this will return true if the command was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES +Alias: Restart-AzAsInstance + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AnalysisServices/Resume-AzAnalysisServicesServer.md b/azps-10.1.0/Az.AnalysisServices/Resume-AzAnalysisServicesServer.md new file mode 100644 index 0000000000..e888877072 --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/Resume-AzAnalysisServicesServer.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices.dll-Help.xml +Module Name: Az.AnalysisServices +online version: https://learn.microsoft.com/powershell/module/az.analysisservices/resume-azanalysisservicesserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Resume-AzAnalysisServicesServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Resume-AzAnalysisServicesServer.md +--- + +# Resume-AzAnalysisServicesServer + +## SYNOPSIS +Resumes an instance of Analysis Services server + +## SYNTAX + +``` +Resume-AzAnalysisServicesServer [[-ResourceGroupName] ] [-Name] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Resume-AzAnalysisServicesServer cmdlet resumes an instance of Analysis Services server + +## EXAMPLES + +### Example 1 +```powershell +Resume-AzAnalysisServicesServer -Name "testserver" -ResourceGroupName "testgroup" +``` + +This command will resume a paused server named testserver in the resourcegroup testgroup + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Analysis Services server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Will return the deleted server details if the operation completes successfully + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure resource group to which the server belongs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts user to confirm whether to perform the operation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes the actions the current operation will perform without actually performing them + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesServer + +## NOTES +Alias: Resume-AzAs + +## RELATED LINKS + +[Get-AzAnalysisServicesServer](./Get-AzAnalysisServicesServer.md) + +[Suspend-AzAnalysisServicesServer](./Suspend-AzAnalysisServicesServer.md) diff --git a/azps-10.1.0/Az.AnalysisServices/Set-AzAnalysisServicesServer.md b/azps-10.1.0/Az.AnalysisServices/Set-AzAnalysisServicesServer.md new file mode 100644 index 0000000000..3e1bb3fad4 --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/Set-AzAnalysisServicesServer.md @@ -0,0 +1,327 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices.dll-Help.xml +Module Name: Az.AnalysisServices +online version: https://learn.microsoft.com/powershell/module/az.analysisservices/set-azanalysisservicesserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Set-AzAnalysisServicesServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Set-AzAnalysisServicesServer.md +--- + +# Set-AzAnalysisServicesServer + +## SYNOPSIS +Modifies an instance of Analysis Services server + +## SYNTAX + +### Default (Default) +``` +Set-AzAnalysisServicesServer [-Name] [[-ResourceGroupName] ] [[-Sku] ] + [[-Tag] ] [[-Administrator] ] [[-BackupBlobContainerUri] ] [-PassThru] + [-ReadonlyReplicaCount ] [-DefaultConnectionMode ] + [-FirewallConfig ] [-GatewayResourceId ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### DisableBackup +``` +Set-AzAnalysisServicesServer [-Name] [[-ResourceGroupName] ] [[-Sku] ] + [[-Tag] ] [[-Administrator] ] [-PassThru] [-DisableBackup] [-ReadonlyReplicaCount ] + [-DefaultConnectionMode ] [-FirewallConfig ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### DisassociateGateway +``` +Set-AzAnalysisServicesServer [-Name] [[-ResourceGroupName] ] [[-Sku] ] + [[-Tag] ] [[-Administrator] ] [-PassThru] [-ReadonlyReplicaCount ] + [-DefaultConnectionMode ] [-FirewallConfig ] + [-DisassociateGateway] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Set-AzAnalysisServicesServer cmdlet modifies an instance of Analysis Services server + +## EXAMPLES + +### Example 1 +```powershell +Set-AzAnalysisServicesServer -Name "testserver" -ResourceGroupName "testgroup" -Tag @{key1 = "value1"; key2 ="value2"} -Administrator "testuser1@contoso.com" +``` + +Modifies the server named testserver in resourcegroup testgroup to set the tags as key1:value1 and key2:value2 and administrator to testuser1@contoso.com + +## PARAMETERS + +### -Administrator +A string representing a comma separated list of users or groups to be set as administrators on the server. +The users or groups need to be specified UPN format e.g. +user@contoso.com or groups@contoso.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackupBlobContainerUri +The blob container Uri for backup the Analysis Services server + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultConnectionMode +Default connection mode of an Analysis service server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: All, Readonly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableBackup +The switch to disable backup blob container. +To re-enable the backup blob container, please provide the backup blob container Uri as -BackupBlobContainerUri. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DisableBackup +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisassociateGateway +Disassociate Gateway resource from an Analysis server + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DisassociateGateway +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FirewallConfig +Firewall config of an Analysis server + +```yaml +Type: Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallConfig +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GatewayResourceId +Gateway resource Id to associate to an Analysis server + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the Analysis Services server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Will return the deleted server details if the operation completes successfully + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadonlyReplicaCount +Read only replica count of an Analysis service server + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure resource group to which the server belongs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +The name of the Sku for the server. +The supported values are 'S0', 'S1', 'S2', 'S4', 'S8', 'S9', 'S8v2', 'S9v2' for the Standard tier; 'B1', 'B2' for the Basic tier and 'D1' for Development tier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table set as tags on the server. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts user to confirm whether to perform the operation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes the actions the current operation will perform without actually performing them + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Management.Automation.SwitchParameter + +### System.Int32 + +### Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallConfig + +## OUTPUTS + +### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesServer + +## NOTES +Alias: Set-AzAs + +## RELATED LINKS + +[Get-AzAnalysisServicesServer](./Get-AzAnalysisServicesServer.md) + +[Remove-AzAnalysisServicesServer](./Remove-AzAnalysisServicesServer.md) diff --git a/azps-10.1.0/Az.AnalysisServices/Suspend-AzAnalysisServicesServer.md b/azps-10.1.0/Az.AnalysisServices/Suspend-AzAnalysisServicesServer.md new file mode 100644 index 0000000000..0be94c557b --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/Suspend-AzAnalysisServicesServer.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices.dll-Help.xml +Module Name: Az.AnalysisServices +online version: https://learn.microsoft.com/powershell/module/az.analysisservices/suspend-azanalysisservicesserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Suspend-AzAnalysisServicesServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Suspend-AzAnalysisServicesServer.md +--- + +# Suspend-AzAnalysisServicesServer + +## SYNOPSIS +Suspends an instance of Analysis Services server + +## SYNTAX + +``` +Suspend-AzAnalysisServicesServer [[-ResourceGroupName] ] [-Name] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Suspend-AzAnalysisServicesServer cmdlet suspends an instance of Analysis Services server + +## EXAMPLES + +### Example 1 +```powershell +Suspend-AzAnalysisServicesServer -Name "testserver" -ResourceGroupName "testgroup" +``` + +This command will suspend an active server named testserver in the resourcegroup testgroup + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Analysis Services server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Will return the deleted server details if the operation completes successfully + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure resource group to which the server belongs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts user to confirm whether to perform the operation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes the actions the current operation will perform without actually performing them + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesServer + +## NOTES +Alias: Suspend-AzAs + +## RELATED LINKS + +[Get-AzAnalysisServicesServer](./Get-AzAnalysisServicesServer.md) + +[Resume-AzAnalysisServicesServer](./Resume-AzAnalysisServicesServer.md) + diff --git a/azps-10.1.0/Az.AnalysisServices/Sync-AzAnalysisServicesInstance.md b/azps-10.1.0/Az.AnalysisServices/Sync-AzAnalysisServicesInstance.md new file mode 100644 index 0000000000..3dcdd933a5 --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/Sync-AzAnalysisServicesInstance.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices.Dataplane.dll-Help.xml +Module Name: Az.AnalysisServices +online version: https://learn.microsoft.com/powershell/module/az.analysisservices/sync-azanalysisservicesinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Sync-AzAnalysisServicesInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Sync-AzAnalysisServicesInstance.md +--- + +# Sync-AzAnalysisServicesInstance + +## SYNOPSIS + +Synchronizes a specified database on the specified instance of Analysis Services server to all the query scaleout instances in the currently logged in Environment as specified in Add-AzAnalysisServicesAccount command + +## SYNTAX + +``` +Sync-AzAnalysisServicesInstance [-Database] [-Instance] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The Sync-AzAnalysisServicesInstance cmdlet synchronizes a specified database on the specified instance of Analysis Services server to all the query scaleout instances in the currently logged in Environment as specified in Add-AzAnalysisServicesAccount command + +## EXAMPLES + +### Example 1 + +```powershell +Sync-AzAnalysisServicesInstance -Instance asazure://westus.asazure.windows.net/contoso -Database SalesOrders +``` + +This command will synchronize the database named SalesOrders in the server named 'contoso' in the environment westus.asazure.windows.net provided the user has logged-in to this environment using Add-AzAnalysisServicesAccount command. + +## PARAMETERS + +### -Database + +Identity of the database to be synchronized + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Instance + +Name of the Analysis Services server instance to restart + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +Specifying this will return true if the command was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.AnalysisServices.Dataplane.Models.ScaleOutServerDatabaseSyncDetails + +## NOTES + +Alias: Sync-AzAsInstance + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AnalysisServices/Test-AzAnalysisServicesServer.md b/azps-10.1.0/Az.AnalysisServices/Test-AzAnalysisServicesServer.md new file mode 100644 index 0000000000..488a056eee --- /dev/null +++ b/azps-10.1.0/Az.AnalysisServices/Test-AzAnalysisServicesServer.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.AnalysisServices.dll-Help.xml +Module Name: Az.AnalysisServices +online version: https://learn.microsoft.com/powershell/module/az.analysisservices/test-azanalysisservicesserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Test-AzAnalysisServicesServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AnalysisServices/AnalysisServices/help/Test-AzAnalysisServicesServer.md +--- + +# Test-AzAnalysisServicesServer + +## SYNOPSIS +Tests the existence of an instance of Analysis Services server + +## SYNTAX + +``` +Test-AzAnalysisServicesServer [-Name] [[-ResourceGroupName] ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Test-AzAnalysisServicesServer cmdlet tests the existence of an instance of Analysis Services server + +## EXAMPLES + +### Example 1 +```powershell +Test-AzAnalysisServicesServer -Name "testserver" -ResourceGroupName "testgroup" +``` + +This command will test if there is a server named testserver in the resourcegroup testgroup + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Analysis Services server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure resource group to which the server belongs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES +Alias: Test-AzAs + +## RELATED LINKS + +[Get-AzAnalysisServicesServer](./Get-AzAnalysisServicesServer.md) + +[Remove-AzAnalysisServicesServer](./Remove-AzAnalysisServicesServer.md) diff --git a/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementApiToGateway.md b/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementApiToGateway.md new file mode 100644 index 0000000000..a9e84153d8 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementApiToGateway.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/add-azapimanagementapitogateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Add-AzApiManagementApiToGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Add-AzApiManagementApiToGateway.md +--- + +# Add-AzApiManagementApiToGateway + +## SYNOPSIS +Attaches an API to a gateway. + +## SYNTAX + +``` +Add-AzApiManagementApiToGateway -Context -GatewayId -ApiId + [-ProvisioningState ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Add-AzApiManagementApiToGateway** cmdlet adds an Azure API Management API to a Gateway. + +## EXAMPLES + +### Example 1 +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Add-AzApiManagementApiToGateway -Context $ApiMgmtContext -GatewayId "0123456789" -ApiId "0001" +``` + +This command adds the specified API to the specified Gateway. + +## PARAMETERS + +### -ApiId +Identifier of existing API. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayId +Identifier of existing gateway. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. +This parameter is optional. +Default value is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProvisioningState +Provisioning State (Created). +This parameter is optional. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGatewayApiProvisioningState] +Parameter Sets: (All) +Aliases: +Accepted values: Created + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGatewayApiProvisioningState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=2.0.1.0, Culture=neutral, PublicKeyToken=null]] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Remove-AzApiManagementApiFromGateway](./Remove-AzApiManagementApiFromGateway.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementApiToProduct.md b/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementApiToProduct.md new file mode 100644 index 0000000000..40cc3b19b0 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementApiToProduct.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 7C86B385-D784-45FD-9B57-31C895115A2C +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/add-azapimanagementapitoproduct +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Add-AzApiManagementApiToProduct.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Add-AzApiManagementApiToProduct.md +--- + +# Add-AzApiManagementApiToProduct + +## SYNOPSIS +Adds an API to a product. + +## SYNTAX + +``` +Add-AzApiManagementApiToProduct -Context -ProductId -ApiId + [-PassThru] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Add-AzApiManagementApiToProduct** cmdlet adds an Azure API Management API to a product. + +## EXAMPLES + +### Example 1: Add an API to a product +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Add-AzApiManagementApiToProduct -Context $ApiMgmtContext -ProductId "0123456789" -ApiId "0001" +``` + +This command adds the specified API to the specified product. + +## PARAMETERS + +### -ApiId +Specifies the ID of an API to add to a product. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductId +Specifies the ID of the product to which to add the API. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Remove-AzApiManagementApiFromProduct](./Remove-AzApiManagementApiFromProduct.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementProductToGroup.md b/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementProductToGroup.md new file mode 100644 index 0000000000..c153fdca17 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementProductToGroup.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 1058BA4E-CD79-429D-BB05-422AE39230C4 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/add-azapimanagementproducttogroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Add-AzApiManagementProductToGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Add-AzApiManagementProductToGroup.md +--- + +# Add-AzApiManagementProductToGroup + +## SYNOPSIS +Adds a product to a group. + +## SYNTAX + +``` +Add-AzApiManagementProductToGroup -Context -GroupId -ProductId + [-PassThru] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Add-AzApiManagementProductToGroup** cmdlet adds a product to an existing group. +In other words, this cmdlet assigns a group to a product. + +## EXAMPLES + +### Example 1: Add a product to a group +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Add-AzApiManagementProductToGroup -Context $apimContext -GroupId "0001" -ProductId "0123456789" +``` + +This command adds a product to an existing group. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +Specifies the group ID. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductId +Specifies the product ID. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Remove-AzApiManagementProductFromGroup](./Remove-AzApiManagementProductFromGroup.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementRegion.md b/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementRegion.md new file mode 100644 index 0000000000..77f74ed602 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementRegion.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 9D4A68A8-0A39-4C9A-8EA6-391A5E7A0E25 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/add-azapimanagementregion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Add-AzApiManagementRegion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Add-AzApiManagementRegion.md +--- + +# Add-AzApiManagementRegion + +## SYNOPSIS +Adds new deployment regions to a PsApiManagement instance. + +## SYNTAX + +``` +Add-AzApiManagementRegion -ApiManagement -Location [-Sku ] + [-Capacity ] [-VirtualNetwork ] [-Zone ] + [-DisableGateway ] [-PublicIpAddressId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Add-AzApiManagementRegion** cmdlet adds new instance of type **PsApiManagementRegion** to the collection of **AdditionalRegions** of provided instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement**. +This cmdlet does not deploy anything by itself but updates instance of **PsApiManagement** in-memory. +To update a deployment of an API Management pass the modified **PsApiManagement** Instance to Set-AzApiManagement. + +## EXAMPLES + +### Example 1: Add new deployment regions to a PsApiManagement instance +```powershell +Add-AzApiManagementRegion -ApiManagement $ApiManagement -Location "East US" -Sku "Premium" -Capacity 2 +``` + +This command adds two premium SKU units and the region named East US to the **PsApiManagement** instance. + +### Example 2: Add new deployment regions to a PsApiManagement instance and then update deployment +```powershell +$service = Get-AzApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi" +$service = Add-AzApiManagementRegion -ApiManagement $service -Location $secondarylocation -VirtualNetwork $additionalRegionVirtualNetwork +$service = Set-AzApiManagement -InputObject $service -PassThru +``` + +This command gets a **PsApiManagement** object, adds two premium SKU units for the region named East US, and then updates deployment. + +## PARAMETERS + +### -ApiManagement +Specifies the **PsApiManagement** instance that this cmdlet adds additional deployment regions to. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Capacity +Specifies the SKU capacity of the deployment region. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableGateway +Flag only meant to be used for Premium SKU ApiManagement Service and Non Internal VNET deployments. This is useful in case we want to take a gateway region out of rotation. This can also be used to standup a new region in Passive mode, test it and then make it Live later. + Default behavior is to make the region live immediately. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the new deployment region amongst the supported region for Api Management service. +To obtain valid locations, use the cmdlet +Get-AzResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddressId +Standard SKU PublicIpAddress ResoureId for integration into stv2 Virtual Network Deployments + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +Specifies the tier of the deployment region. +Valid values are: +- Developer +- Standard +- Premium + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku] +Parameter Sets: (All) +Aliases: +Accepted values: Developer, Standard, Premium, Basic, Consumption, Isolated + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetwork +Specifies a virtual network configuration. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +A list of availability zones denoting where the api management service is deployed into. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement + +## NOTES +* The cmdlet writes updated **PsApiManagement** instance to pipeline. + +## RELATED LINKS + +[Remove-AzApiManagementRegion](./Remove-AzApiManagementRegion.md) + +[Update-AzApiManagementRegion](./Update-AzApiManagementRegion.md) + +[Set-AzApiManagement](./Set-AzApiManagement.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementUserToGroup.md b/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementUserToGroup.md new file mode 100644 index 0000000000..75a640ff84 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Add-AzApiManagementUserToGroup.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 8C014335-9622-4F2E-A163-4B0C84531506 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/add-azapimanagementusertogroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Add-AzApiManagementUserToGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Add-AzApiManagementUserToGroup.md +--- + +# Add-AzApiManagementUserToGroup + +## SYNOPSIS +Adds a user to a group. + +## SYNTAX + +``` +Add-AzApiManagementUserToGroup -Context -GroupId -UserId [-PassThru] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Add-AzApiManagementUserToGroup** cmdlet adds a user to a group. + +## EXAMPLES + +### Example 1: Add a user to a group +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Add-AzApiManagementUserToGroup -Context $apimContext -GroupId "0001" -UserId "0123456789" +``` + +This command adds an existing user to an existing group. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +Specifies the group ID. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserId +Specifies the user ID. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementUser](./Get-AzApiManagementUser.md) + +[Remove-AzApiManagementUserFromGroup](./Remove-AzApiManagementUserFromGroup.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Az.ApiManagement.md b/azps-10.1.0/Az.ApiManagement/Az.ApiManagement.md new file mode 100644 index 0000000000..6b53749d7b --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Az.ApiManagement.md @@ -0,0 +1,429 @@ +--- +Module Name: Az.ApiManagement +Module Guid: f875725d-8ce4-423f-a6af-ea880bc63f13 +Download Help Link: https://learn.microsoft.com/powershell/module/az.apimanagement +Help Version: 4.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Az.ApiManagement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Az.ApiManagement.md +--- + +# Az.ApiManagement Module +## Description +This topic displays help topics for the Azure API Management Cmdlets. + +## Az.ApiManagement Cmdlets +### [Add-AzApiManagementApiToGateway](Add-AzApiManagementApiToGateway.md) +Attaches an API to a gateway. + +### [Add-AzApiManagementApiToProduct](Add-AzApiManagementApiToProduct.md) +Adds an API to a product. + +### [Add-AzApiManagementProductToGroup](Add-AzApiManagementProductToGroup.md) +Adds a product to a group. + +### [Add-AzApiManagementRegion](Add-AzApiManagementRegion.md) +Adds new deployment regions to a PsApiManagement instance. + +### [Add-AzApiManagementUserToGroup](Add-AzApiManagementUserToGroup.md) +Adds a user to a group. + +### [Backup-AzApiManagement](Backup-AzApiManagement.md) +Backs up an API Management service. + +### [Export-AzApiManagementApi](Export-AzApiManagementApi.md) +Exports an API to a file. + +### [Get-AzApiManagement](Get-AzApiManagement.md) +Gets a list or a particular API Management Service description. + +### [Get-AzApiManagementApi](Get-AzApiManagementApi.md) +Gets an API. + +### [Get-AzApiManagementApiRelease](Get-AzApiManagementApiRelease.md) +Get the API Release. + +### [Get-AzApiManagementApiRevision](Get-AzApiManagementApiRevision.md) +Gets details of all the API Revisions of an API + +### [Get-AzApiManagementApiSchema](Get-AzApiManagementApiSchema.md) +Get the details of the API Schema + +### [Get-AzApiManagementApiVersionSet](Get-AzApiManagementApiVersionSet.md) +Get the details of the API Version Sets + +### [Get-AzApiManagementAuthorizationServer](Get-AzApiManagementAuthorizationServer.md) +Gets an API Management authorization server. + +### [Get-AzApiManagementAuthorizationServerClientSecret](Get-AzApiManagementAuthorizationServerClientSecret.md) +Gets an API Management authorization server client secret. + +### [Get-AzApiManagementBackend](Get-AzApiManagementBackend.md) +Get the details of the Backend. + +### [Get-AzApiManagementCache](Get-AzApiManagementCache.md) +Get the details of the Cache. + +### [Get-AzApiManagementCertificate](Get-AzApiManagementCertificate.md) +Gets API Management certificates configured for Mutual Authentication with Backend in the service. + +### [Get-AzApiManagementDiagnostic](Get-AzApiManagementDiagnostic.md) +Get details of the Diagnostic configured at the service level or the Api Level. Diagnostics are used to log requests/responses from Api Management gateway. + +### [Get-AzApiManagementGateway](Get-AzApiManagementGateway.md) +Gets all or specific API management Gateway. + +### [Get-AzApiManagementGatewayHostnameConfiguration](Get-AzApiManagementGatewayHostnameConfiguration.md) +Gets all or specific hostname configuration for the existing Gateway. + +### [Get-AzApiManagementGatewayKey](Get-AzApiManagementGatewayKey.md) +Gets keys of the existing Gateway + +### [Get-AzApiManagementGroup](Get-AzApiManagementGroup.md) +Gets all or specific API management groups. + +### [Get-AzApiManagementIdentityProvider](Get-AzApiManagementIdentityProvider.md) +Get the identity provider configuration details. + +### [Get-AzApiManagementIdentityProviderClientSecret](Get-AzApiManagementIdentityProviderClientSecret.md) +Get the identity provider client secret. + +### [Get-AzApiManagementLogger](Get-AzApiManagementLogger.md) +Gets API Management Logger objects. + +### [Get-AzApiManagementNamedValue](Get-AzApiManagementNamedValue.md) +Gets a list or a particular Named Value. + +### [Get-AzApiManagementNamedValueSecretValue](Get-AzApiManagementNamedValueSecretValue.md) +Gets a secret value of the particular Named Value. + +### [Get-AzApiManagementNetworkStatus](Get-AzApiManagementNetworkStatus.md) +Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService. + +### [Get-AzApiManagementOpenIdConnectProvider](Get-AzApiManagementOpenIdConnectProvider.md) +Gets OpenID Connect providers. + +### [Get-AzApiManagementOpenIdConnectProviderClientSecret](Get-AzApiManagementOpenIdConnectProviderClientSecret.md) +Gets OpenID Connect provider client secret. + +### [Get-AzApiManagementOperation](Get-AzApiManagementOperation.md) +Gets a list or a specified API Operation. + +### [Get-AzApiManagementPolicy](Get-AzApiManagementPolicy.md) +Gets the specified scope policy. + +### [Get-AzApiManagementProduct](Get-AzApiManagementProduct.md) +Gets a list or a particular product. + +### [Get-AzApiManagementSsoToken](Get-AzApiManagementSsoToken.md) +Gets a link with an SSO token to a deployed management portal of an API Management service. + +### [Get-AzApiManagementSubscription](Get-AzApiManagementSubscription.md) +Gets subscriptions. + +### [Get-AzApiManagementSubscriptionKey](Get-AzApiManagementSubscriptionKey.md) +Gets subscription keys. + +### [Get-AzApiManagementTenantAccess](Get-AzApiManagementTenantAccess.md) +Gets the access configuration for a tenant. + +### [Get-AzApiManagementTenantAccessSecret](Get-AzApiManagementTenantAccessSecret.md) +Gets the access configuration keys for a tenant. + +### [Get-AzApiManagementTenantGitAccess](Get-AzApiManagementTenantGitAccess.md) +Gets the Git access configuration for a tenant. + +### [Get-AzApiManagementTenantGitAccessSecret](Get-AzApiManagementTenantGitAccessSecret.md) +Gets the Git access configuration keys for a tenant. + +### [Get-AzApiManagementTenantSyncState](Get-AzApiManagementTenantSyncState.md) +Gets the status of the most recent synchronization between the configuration database and the Git repository. + +### [Get-AzApiManagementUser](Get-AzApiManagementUser.md) +Gets a user or users. + +### [Get-AzApiManagementUserSsoUrl](Get-AzApiManagementUserSsoUrl.md) +Generates an SSO URL for a user. + +### [Import-AzApiManagementApi](Import-AzApiManagementApi.md) +Imports an API from a file or a URL. + +### [New-AzApiManagement](New-AzApiManagement.md) +Creates an API Management deployment. + +### [New-AzApiManagementApi](New-AzApiManagementApi.md) +Creates an API. + +### [New-AzApiManagementApiRelease](New-AzApiManagementApiRelease.md) +Creates an API Release of an API Revision + +### [New-AzApiManagementApiRevision](New-AzApiManagementApiRevision.md) +Creates a new Revision of an Existing API. + +### [New-AzApiManagementApiSchema](New-AzApiManagementApiSchema.md) +Creates the new API Schema in the ApiManagement service + +### [New-AzApiManagementApiVersionSet](New-AzApiManagementApiVersionSet.md) +Creates an API Version Set. + +### [New-AzApiManagementAuthorizationServer](New-AzApiManagementAuthorizationServer.md) +Creates an authorization server. + +### [New-AzApiManagementBackend](New-AzApiManagementBackend.md) +Creates a new backend entity. + +### [New-AzApiManagementBackendCredential](New-AzApiManagementBackendCredential.md) +Creates a new Backend Credential contract. + +### [New-AzApiManagementBackendProxy](New-AzApiManagementBackendProxy.md) +Creates a new Backend Proxy Object. + +### [New-AzApiManagementBackendServiceFabric](New-AzApiManagementBackendServiceFabric.md) +Creates an object of `PsApiManagementServiceFabric` + +### [New-AzApiManagementCache](New-AzApiManagementCache.md) +Creates a new Cache entity + +### [New-AzApiManagementCertificate](New-AzApiManagementCertificate.md) +Creates an API Management certificate to be used during Authentication with Backend. + +### [New-AzApiManagementContext](New-AzApiManagementContext.md) +Creates an instance of PsAzureApiManagementContext. + +### [New-AzApiManagementCustomHostnameConfiguration](New-AzApiManagementCustomHostnameConfiguration.md) +Creates an instance of `PsApiManagementCustomHostNameConfiguration`. + +### [New-AzApiManagementDiagnostic](New-AzApiManagementDiagnostic.md) +Creates a new diagnostics at the Global scope or Api Scope. + +### [New-AzApiManagementGateway](New-AzApiManagementGateway.md) +Creates new Gateway entity. + +### [New-AzApiManagementGatewayHostnameConfiguration](New-AzApiManagementGatewayHostnameConfiguration.md) +Creates a hostname configuratin for the existing Gateway. + +### [New-AzApiManagementGroup](New-AzApiManagementGroup.md) +Creates an API management group. + +### [New-AzApiManagementHttpMessageDiagnostic](New-AzApiManagementHttpMessageDiagnostic.md) +Creates an instance of **PsApiManagementHttpMessageDiagnostic** which is an Http Message diagnostic setting of the Diagnostic + +### [New-AzApiManagementIdentityProvider](New-AzApiManagementIdentityProvider.md) +Creates a new Identity Provider configuration. + +### [New-AzApiManagementKeyVaultObject](New-AzApiManagementKeyVaultObject.md) +Creates an instance of PsApiManagementKeyVaultObject. + +### [New-AzApiManagementLogger](New-AzApiManagementLogger.md) +Creates an API Management Logger. + +### [New-AzApiManagementNamedValue](New-AzApiManagementNamedValue.md) +Creates new Named Value. + +### [New-AzApiManagementOpenIdConnectProvider](New-AzApiManagementOpenIdConnectProvider.md) +Creates an OpenID Connect provider. + +### [New-AzApiManagementOperation](New-AzApiManagementOperation.md) +Creates an API management operation. + +### [New-AzApiManagementPipelineDiagnosticSetting](New-AzApiManagementPipelineDiagnosticSetting.md) +Create Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. + +### [New-AzApiManagementProduct](New-AzApiManagementProduct.md) +Creates an API Management product. + +### [New-AzApiManagementRegion](New-AzApiManagementRegion.md) +Creates an instance of PsApiManagementRegion. + +### [New-AzApiManagementResourceLocationObject](New-AzApiManagementResourceLocationObject.md) +Create a new resource location contract (used in Gateways). + +### [New-AzApiManagementSamplingSetting](New-AzApiManagementSamplingSetting.md) +Create a new sampling setting for the Diagnostic + +### [New-AzApiManagementSslSetting](New-AzApiManagementSslSetting.md) +Creates an instance of PsApiManagementSslSetting + +### [New-AzApiManagementSubscription](New-AzApiManagementSubscription.md) +Creates a subscription. + +### [New-AzApiManagementSystemCertificate](New-AzApiManagementSystemCertificate.md) +Creates an instance of `PsApiManagementSystemCertificate`. The certificate can be issued by private CA's and will be installed on the API Management service into `CertificateAuthority` or `Root` store. + +### [New-AzApiManagementUser](New-AzApiManagementUser.md) +Registers a new user. + +### [New-AzApiManagementUserToken](New-AzApiManagementUserToken.md) +Generates a Shared Access Token for the User. + +### [New-AzApiManagementVirtualNetwork](New-AzApiManagementVirtualNetwork.md) +Creates an instance of PsApiManagementVirtualNetwork. + +### [Publish-AzApiManagementTenantGitConfiguration](Publish-AzApiManagementTenantGitConfiguration.md) +Publishes changes from a Git branch to the configuration database. + +### [Remove-AzApiManagement](Remove-AzApiManagement.md) +Removes an API Management service. + +### [Remove-AzApiManagementApi](Remove-AzApiManagementApi.md) +Removes an API. + +### [Remove-AzApiManagementApiFromGateway](Remove-AzApiManagementApiFromGateway.md) +Attaches an API to a gateway. + +### [Remove-AzApiManagementApiFromProduct](Remove-AzApiManagementApiFromProduct.md) +Removes an API from a product. + +### [Remove-AzApiManagementApiRelease](Remove-AzApiManagementApiRelease.md) +Removes a particular API Release + +### [Remove-AzApiManagementApiRevision](Remove-AzApiManagementApiRevision.md) +Removed a particular API Revision + +### [Remove-AzApiManagementApiSchema](Remove-AzApiManagementApiSchema.md) +Removes the API Schema from the API. + +### [Remove-AzApiManagementApiVersionSet](Remove-AzApiManagementApiVersionSet.md) +Removes a particular Api Version Set + +### [Remove-AzApiManagementAuthorizationServer](Remove-AzApiManagementAuthorizationServer.md) +Removes an authorization server. + +### [Remove-AzApiManagementBackend](Remove-AzApiManagementBackend.md) +Removes a Backend. + +### [Remove-AzApiManagementCache](Remove-AzApiManagementCache.md) +Removes the cache entity. + +### [Remove-AzApiManagementCertificate](Remove-AzApiManagementCertificate.md) +Removes an API Management certificate. + +### [Remove-AzApiManagementDiagnostic](Remove-AzApiManagementDiagnostic.md) +Remove the Diagnostic entity from Global or API level scope. + +### [Remove-AzApiManagementGateway](Remove-AzApiManagementGateway.md) +Detaches an API from a Gateway. + +### [Remove-AzApiManagementGatewayHostnameConfiguration](Remove-AzApiManagementGatewayHostnameConfiguration.md) +Removes a hostname configuration from the existing Gateway. + +### [Remove-AzApiManagementGroup](Remove-AzApiManagementGroup.md) +Removes an existing API management group. + +### [Remove-AzApiManagementIdentityProvider](Remove-AzApiManagementIdentityProvider.md) +Removes an existing Identity Provider Configuration. + +### [Remove-AzApiManagementLogger](Remove-AzApiManagementLogger.md) +Removes an API Management Logger. + +### [Remove-AzApiManagementNamedValue](Remove-AzApiManagementNamedValue.md) +Removes an API Management Named Value. + +### [Remove-AzApiManagementOpenIdConnectProvider](Remove-AzApiManagementOpenIdConnectProvider.md) +Removes an OpenID Connect provider. + +### [Remove-AzApiManagementOperation](Remove-AzApiManagementOperation.md) +Removes an existing operation. + +### [Remove-AzApiManagementPolicy](Remove-AzApiManagementPolicy.md) +Removes the API Management policy from a specified scope. + +### [Remove-AzApiManagementProduct](Remove-AzApiManagementProduct.md) +Removes an existing API Management product. + +### [Remove-AzApiManagementProductFromGroup](Remove-AzApiManagementProductFromGroup.md) +Removes a product from a group. + +### [Remove-AzApiManagementRegion](Remove-AzApiManagementRegion.md) +Removes an existing deployment region from PsApiManagement instance. + +### [Remove-AzApiManagementSubscription](Remove-AzApiManagementSubscription.md) +Deletes an existing subscription. + +### [Remove-AzApiManagementUser](Remove-AzApiManagementUser.md) +Deletes an existing user. + +### [Remove-AzApiManagementUserFromGroup](Remove-AzApiManagementUserFromGroup.md) +Removes a user from a group. + +### [Restore-AzApiManagement](Restore-AzApiManagement.md) +Restores an API Management Service from the specified Azure Storage blob. + +### [Save-AzApiManagementTenantGitConfiguration](Save-AzApiManagementTenantGitConfiguration.md) +Saves changes by creating a commit for current configuration. + +### [Set-AzApiManagement](Set-AzApiManagement.md) +Updates an Azure Api Management service + +### [Set-AzApiManagementApi](Set-AzApiManagementApi.md) +Modifies an API. + +### [Set-AzApiManagementApiRevision](Set-AzApiManagementApiRevision.md) +Modifies an API Revision + +### [Set-AzApiManagementApiSchema](Set-AzApiManagementApiSchema.md) +Modifies an API Schema + +### [Set-AzApiManagementApiVersionSet](Set-AzApiManagementApiVersionSet.md) +Updates an API Version Set in the API Management Context. + +### [Set-AzApiManagementAuthorizationServer](Set-AzApiManagementAuthorizationServer.md) +Modifies an authorization server. + +### [Set-AzApiManagementBackend](Set-AzApiManagementBackend.md) +Updates a Backend. + +### [Set-AzApiManagementCertificate](Set-AzApiManagementCertificate.md) +Modifies an API Management certificate which is configured for mutual authentication with backend. + +### [Set-AzApiManagementDiagnostic](Set-AzApiManagementDiagnostic.md) +Modifies an API Management diagnostic at the Global or Api scope. + +### [Set-AzApiManagementGroup](Set-AzApiManagementGroup.md) +Configures an API management group. + +### [Set-AzApiManagementIdentityProvider](Set-AzApiManagementIdentityProvider.md) +Updates the Configuration of an existing Identity Provider. + +### [Set-AzApiManagementLogger](Set-AzApiManagementLogger.md) +Modifies an API Management Logger. + +### [Set-AzApiManagementNamedValue](Set-AzApiManagementNamedValue.md) +Modifies an API Management Named Value. + +### [Set-AzApiManagementOpenIdConnectProvider](Set-AzApiManagementOpenIdConnectProvider.md) +Modifies an OpenID Connect provider. + +### [Set-AzApiManagementOperation](Set-AzApiManagementOperation.md) +Sets API operation details. + +### [Set-AzApiManagementPolicy](Set-AzApiManagementPolicy.md) +Sets the specified scope policy for API Management. + +### [Set-AzApiManagementProduct](Set-AzApiManagementProduct.md) +Sets the API Management product details. + +### [Set-AzApiManagementSubscription](Set-AzApiManagementSubscription.md) +Sets existing subscription details. + +### [Set-AzApiManagementTenantAccess](Set-AzApiManagementTenantAccess.md) +Enables or disables tenant access. + +### [Set-AzApiManagementUser](Set-AzApiManagementUser.md) +Sets user details. + +### [Sync-AzApiManagementKeyVaultSecret](Sync-AzApiManagementKeyVaultSecret.md) +Refreshes NamedValue or Certificate created by KeyVault. + +### [Update-AzApiManagementApiRelease](Update-AzApiManagementApiRelease.md) +Updates a particular Api Release. + +### [Update-AzApiManagementCache](Update-AzApiManagementCache.md) +updates a cache in Api Management service. + +### [Update-AzApiManagementGateway](Update-AzApiManagementGateway.md) +Configures an API management Gateway. + +### [Update-AzApiManagementRegion](Update-AzApiManagementRegion.md) +Updates existing deployment region in PsApiManagement instance. + diff --git a/azps-10.1.0/Az.ApiManagement/Backup-AzApiManagement.md b/azps-10.1.0/Az.ApiManagement/Backup-AzApiManagement.md new file mode 100644 index 0000000000..7d5ed9ae6d --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Backup-AzApiManagement.md @@ -0,0 +1,271 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 5846BBB7-DA8E-41B5-A894-BA2B61C2212C +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/backup-azapimanagement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Backup-AzApiManagement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Backup-AzApiManagement.md +--- + +# Backup-AzApiManagement + +## SYNOPSIS + +Backs up an API Management service. + +## SYNTAX + +``` +Backup-AzApiManagement -ResourceGroupName -Name -StorageContext + -TargetContainerName [-TargetBlobName ] [-AccessType ] [-IdentityClientId ] + [-PassThru] [-DefaultProfile ] [] +``` + +## DESCRIPTION + +The **Backup-AzApiManagement** cmdlet backs up an instance of an Azure API Management service. +This cmdlet stores the backup as an Azure Storage blob. + +## EXAMPLES + +### Example 1: Back up an API Management service + +```powershell +New-AzStorageAccount -StorageAccountName "ContosoStorage" -Location $location -ResourceGroupName "ContosoGroup02" -Type Standard_LRS +$storageKey = (Get-AzStorageAccountKey -ResourceGroupName "ContosoGroup02" -StorageAccountName "ContosoStorage")[0].Value +$storageContext = New-AzStorageContext -StorageAccountName "ContosoStorage" -StorageAccountKey $storageKey +Backup-AzApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" -StorageContext $StorageContext -TargetContainerName "contosobackups" -TargetBlobName "contosobackups.apimbackup" +``` + +### Example 2: Back up using Managed Identity + +```powershell +$storageContext=New-AzStorageContext -StorageAccountName apimbackupmsi +$resourceGroupName="contosogroup2"; +$apiManagementName="contosoapi"; +$containerName="apimbackupcontainer"; +$backupName="test-sdk-backup-1"; +$msiClientId="a6270d0c-7d86-478b-8cbe-dc9047ba54f7" +Backup-AzApiManagement -ResourceGroupName $resourceGroupName -Name $apiManagementName -StorageContext $storageContext -TargetContainerName $containerName -TargetBlobName $backupName -AccessType "UserAssignedManagedIdentity" -IdentityClientId $msiClientId -PassThru +``` + +```output +PublicIPAddresses : {52.143.79.150} +PrivateIPAddresses : +Id : /subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup2/providers/Microsoft.ApiManagement/service/contosoapi +Name : contosoapi +Location : West US 2 +Sku : Premium +Capacity : 1 +CreatedTimeUtc : 10/13/2021 5:49:32 PM +ProvisioningState : Succeeded +RuntimeUrl : https://contosoapi.azure-api.net +RuntimeRegionalUrl : https://contosoapi-westus2-01.regional.azure-api.net +PortalUrl : https://contosoapi.portal.azure-api.net +DeveloperPortalUrl : https://contosoapi.developer.azure-api.net +ManagementApiUrl : https://contosoapi.management.azure-api.net +ScmUrl : https://contosoapi.scm.azure-api.net +PublisherEmail : foobar@microsoft.com +OrganizationName : fsdfsdfs +NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com +VirtualNetwork : +VpnType : None +PortalCustomHostnameConfiguration : +ProxyCustomHostnameConfiguration : {contosoapi.azure-api.net} +ManagementCustomHostnameConfiguration : +ScmCustomHostnameConfiguration : +DeveloperPortalHostnameConfiguration : +SystemCertificates : +Tags : {} +AdditionalRegions : {} +SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting +Identity : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementServiceIdentity +EnableClientCertificate : +Zone : +DisableGateway : False +MinimalControlPlaneApiVersion : +PublicIpAddressId : +PlatformVersion : stv2 +PublicNetworkAccess : Enabled +PrivateEndpointConnections : +ResourceGroupName : contosogroup2 +``` + +This command backs up an API Management service to a Storage blob using UserAssigned Managed Identity + +## PARAMETERS + +### -AccessType + +The type of access to be used for the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityClientId + +The Client ID of user assigned managed identity. Required only if accessType is set to UserAssignedManagedIdentity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +Specifies the name of the API Management deployment that this cmdlet backs up. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru + +Indicates that this cmdlet returns the backed up **PsApiManagement** object, if the operation succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specifies the name of the of resource group under which the API Management deployment exists. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageContext + +Specifies a storage connection context. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetBlobName + +Specifies the name of the blob for the backup. +If the blob does not exist, this cmdlet creates it. +This cmdlet generates a default value based on the following pattern: +{Name}-{yyyy-MM-dd-HH-mm}.apimbackup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetContainerName + +Specifies the name of the container of the blob for the backup. +If the container does not exist, this cmdlet creates it. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagement](./Get-AzApiManagement.md) + +[New-AzApiManagement](./New-AzApiManagement.md) + +[Remove-AzApiManagement](./Remove-AzApiManagement.md) + +[Restore-AzApiManagement](./Restore-AzApiManagement.md) diff --git a/azps-10.1.0/Az.ApiManagement/Export-AzApiManagementApi.md b/azps-10.1.0/Az.ApiManagement/Export-AzApiManagementApi.md new file mode 100644 index 0000000000..ace0eee667 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Export-AzApiManagementApi.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 2BA76B02-B786-4A77-86E0-E7D4191120B5 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/export-azapimanagementapi +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Export-AzApiManagementApi.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Export-AzApiManagementApi.md +--- + +# Export-AzApiManagementApi + +## SYNOPSIS +Exports an API to a file. + +## SYNTAX + +### ExportToPipeline (Default) +``` +Export-AzApiManagementApi -Context -ApiId [-ApiRevision ] + -SpecificationFormat [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### ExportToFile +``` +Export-AzApiManagementApi -Context -ApiId [-ApiRevision ] + -SpecificationFormat -SaveAs [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Export-AzApiManagementApi** cmdlet exports an Azure API Management API to a file in one of the supported formats. + +## EXAMPLES + +### Example 1: Export an API in Web Application Description Language (WADL) format +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Export-AzApiManagementApi -Context $ApiMgmtContext -ApiId "0123456789" -SpecificationFormat "Wadl" -SaveAs "C:\contoso\specifications\0123456789.wadl" +``` + +This command exports an API to a WADL file. + +### Example 2: Export an API in OpenApi 3.0 Specification Format as Json Document +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Export-AzApiManagementApi -Context $ApiMgmtContext -ApiId swagger-petstore -SpecificationFormat OpenApiJson -SaveAs D:\github\petstore.json +``` + +This command exports an API definitions in Open Api format as Json document + +## PARAMETERS + +### -ApiId +Specifies the ID of the API to export. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Identifier of API Revision. This parameter is optional. If not specified, the export will be done for the currently active api revision. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this operation overwrites the file of the same name if it already exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ExportToFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this operation returns $True if the API is exported successfully, or $False otherwise. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ExportToFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SaveAs +Specifies the file path to which to save the exported API. + +```yaml +Type: System.String +Parameter Sets: ExportToFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SpecificationFormat +Specifies the API format. +psdx_paramvalues Wadl, Wsdl, Swagger, OpenApi and OpenApiJson + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiFormat +Parameter Sets: (All) +Aliases: +Accepted values: Wadl, Swagger, Wsdl, OpenApi, OpenApiJson + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiFormat + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementApi](./Get-AzApiManagementApi.md) + +[Import-AzApiManagementApi](./Import-AzApiManagementApi.md) + +[New-AzApiManagementApi](./New-AzApiManagementApi.md) + +[Remove-AzApiManagementApi](./Remove-AzApiManagementApi.md) + +[Set-AzApiManagementApi](./Set-AzApiManagementApi.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagement.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagement.md new file mode 100644 index 0000000000..05bef5b0ff --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagement.md @@ -0,0 +1,197 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: DBA7AD5F-CC13-417A-B753-F998942530BB +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagement.md +--- + +# Get-AzApiManagement + +## SYNOPSIS + +Gets a list or a particular API Management Service description. + +## SYNTAX + +### GetBySubscription (Default) + +```powershell +Get-AzApiManagement [-DefaultProfile ] [] +``` + +### GetByResourceGroup + +```powershell +Get-AzApiManagement -ResourceGroupName [-DefaultProfile ] [] +``` + +### GetByResource + +```powershell +Get-AzApiManagement -ResourceGroupName -Name [-DefaultProfile ] + [] +``` + +### ByResourceId + +``` +Get-AzApiManagement -ResourceId [-DefaultProfile ] [] +``` + +## DESCRIPTION + +The **Get-AzApiManagement** cmdlet gets a list of all API Management services under subscription or specified resource group or a particular API Management. + +## EXAMPLES + +### Example 1: Get all API Management services + +```powershell +Get-AzApiManagement +``` + +This command gets all API Management services within a subscription. + +### Example 2: Get an API Management services by a specific name + +```powershell +Get-AzApiManagement -ResourceGroupName "contosogroup" -Name "contoso" +``` + +```output +PublicIPAddresses : {52.143.79.150} +PrivateIPAddresses : +Id : /subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.ApiManagement/service/contoso +Name : contoso +Location : West US 2 +Sku : Premium +Capacity : 1 +CreatedTimeUtc : 10/13/2021 5:49:32 PM +ProvisioningState : Succeeded +RuntimeUrl : https://contoso.azure-api.net +RuntimeRegionalUrl : https://contoso-westus2-01.regional.azure-api.net +PortalUrl : https://contoso.portal.azure-api.net +DeveloperPortalUrl : https://contoso.developer.azure-api.net +ManagementApiUrl : https://contoso.management.azure-api.net +ScmUrl : https://contoso.scm.azure-api.net +PublisherEmail : glfeokti@microsoft.com +OrganizationName : fsdfsdfs +NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com +VirtualNetwork : +VpnType : None +PortalCustomHostnameConfiguration : +ProxyCustomHostnameConfiguration : {contoso.azure-api.net} +ManagementCustomHostnameConfiguration : +ScmCustomHostnameConfiguration : +DeveloperPortalHostnameConfiguration : +SystemCertificates : +Tags : {} +AdditionalRegions : {} +SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting +Identity : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementServiceIdentity +EnableClientCertificate : +Zone : +DisableGateway : False +MinimalControlPlaneApiVersion : +PublicIpAddressId : +PlatformVersion : stv2 +PublicNetworkAccess : Enabled +PrivateEndpointConnections : {kjoshipeconnection, kjoshipeeus} +ResourceGroupName : contosogroup +``` + +This command gets all API Management service by name. + + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +Specifies the name of API Management service. + +```yaml +Type: System.String +Parameter Sets: GetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specifies the name of the resource group under in which this cmdlet gets the API Management service. + +```yaml +Type: System.String +Parameter Sets: GetByResourceGroup, GetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId + +Arm ResourceId of the API Management service. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement + +## NOTES + +## RELATED LINKS + +[Backup-AzApiManagement](./Backup-AzApiManagement.md) + +[New-AzApiManagement](./New-AzApiManagement.md) + +[Remove-AzApiManagement](./Remove-AzApiManagement.md) + +[Restore-AzApiManagement](./Restore-AzApiManagement.md) diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementApi.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementApi.md new file mode 100644 index 0000000000..0756659043 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementApi.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: B80389B9-E143-4E24-A222-E95F691DA2E9 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementapi +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementApi.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementApi.md +--- + +# Get-AzApiManagementApi + +## SYNOPSIS +Gets an API. + +## SYNTAX + +### GetAllApis (Default) +``` +Get-AzApiManagementApi -Context [-DefaultProfile ] + [] +``` + +### GetByApiId +``` +Get-AzApiManagementApi -Context -ApiId [-ApiRevision ] + [-DefaultProfile ] [] +``` + +### GetByName +``` +Get-AzApiManagementApi -Context -Name + [-DefaultProfile ] [] +``` + +### GetByProductId +``` +Get-AzApiManagementApi -Context -ProductId + [-DefaultProfile ] [] +``` + +### GetByGatewayId +``` +Get-AzApiManagementApi -Context -GatewayId + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementApi** cmdlet gets one or more Azure API Management APIs. + +## EXAMPLES + +### Example 1: Get all management APIs +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementApi -Context $ApiMgmtContext +``` + +This command gets all of the APIs for the specified context. + +### Example 2: Get a management API by ID +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementApi -Context $ApiMgmtContext -ApiId $ApiId +``` + +This command gets the API with the specified ID. + +### Example 3: Get a management API by name +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" +``` + +This command gets the API with the specified name. + +### Example 4: Get a management API by GatewayId +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementApi -Context $ApiMgmtContext -GatewayId "g01" +``` + +This command gets the API for the specified GatewayId. + +## PARAMETERS + +### -ApiId +Specifies the ID of the API to get. + +```yaml +Type: System.String +Parameter Sets: GetByApiId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Revision Identifier of the particular Api revision. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: GetByApiId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayId +If specified will try to get all Gateway APIs. + +```yaml +Type: System.String +Parameter Sets: GetByGatewayId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the API to get. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductId +Specifies the ID of the product for which to get the API. + +```yaml +Type: System.String +Parameter Sets: GetByProductId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi + +## NOTES + +## RELATED LINKS + +[Export-AzApiManagementApi](./Export-AzApiManagementApi.md) + +[Import-AzApiManagementApi](./Import-AzApiManagementApi.md) + +[New-AzApiManagementApi](./New-AzApiManagementApi.md) + +[Remove-AzApiManagementApi](./Remove-AzApiManagementApi.md) + +[Set-AzApiManagementApi](./Set-AzApiManagementApi.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementApiRelease.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementApiRelease.md new file mode 100644 index 0000000000..ef7b8a3326 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementApiRelease.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementapirelease +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementApiRelease.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementApiRelease.md +--- + +# Get-AzApiManagementApiRelease + +## SYNOPSIS +Get the API Release. + +## SYNTAX + +### ContextParameterSet (Default) +``` +Get-AzApiManagementApiRelease -Context -ApiId [-ReleaseId ] + [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzApiManagementApiRelease -ResourceId [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzApiManagementApiRelease** cmdlet gets one or more releases of the Azure API Management API. + +## EXAMPLES + +### Example 1: Get all releases of the API +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementApiRelease -Context $ApiMgmtContext -ApiId 5adf6fbf0faadf3ad8558065 +``` + +```output +ReleaseId : 5afccaf6b89fd067426d402e +ApiId : 5adf6fbf0faadf3ad8558065 +CreatedDateTime : 5/17/2018 12:21:12 AM +UpdatedDateTime : 5/17/2018 12:21:12 AM +Notes : creating a new release +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/apis/5adf6fbf0faadf3ad8558065/releases/5afccaf6b89fd067426d402e +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso +``` + +This command gets all of the releases of the `echo-api` API for the specified context. + +### Example 2: Get the release information of the particular API release +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementApiRelease -Context $ApiMgmtContext -ApiId 5adf6fbf0faadf3ad8558065 -ReleaseId 5afccaf6b89fd067426d402e +``` + +```output +ReleaseId : 5afccaf6b89fd067426d402e +ApiId : 5adf6fbf0faadf3ad8558065 +CreatedDateTime : 5/17/2018 12:21:12 AM +UpdatedDateTime : 5/17/2018 12:21:12 AM +Notes : creating a new release +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Mi + crosoft.ApiManagement/service/contoso/apis/5adf6fbf0faadf3ad8558065/releases/5afccaf6b89fd067426d402 + e +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso +``` + +This command gets the releases information of a particular API with the specified releaseId. + +## PARAMETERS + +### -ApiId +API identifier to look for. +If specified will try to get the API by the Id. + +```yaml +Type: System.String +Parameter Sets: ContextParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ContextParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReleaseId +The identifier of the Release. + +```yaml +Type: System.String +Parameter Sets: ContextParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm Resource Identifier of a Api Release. If specified will try to find api release by the identifier. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementApiRelease](./Get-AzApiManagementApiRelease.md) + +[Remove-AzApiManagementApiRelease](./Remove-AzApiManagementApiRelease.md) + +[Update-AzApiManagementApiRelease](./Update-AzApiManagementApiRelease.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementApiRevision.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementApiRevision.md new file mode 100644 index 0000000000..449aed0439 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementApiRevision.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementapirevision +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementApiRevision.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementApiRevision.md +--- + +# Get-AzApiManagementApiRevision + +## SYNOPSIS +Gets details of all the API Revisions of an API + +## SYNTAX + +``` +Get-AzApiManagementApiRevision -Context -ApiId [-ApiRevision ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementApiRevision** cmdlet gets the details of all revisions of an API + +## EXAMPLES + +### Example 1: Get all API Revisions of an API +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementApiRevision -Context $ApiMgmtContext -ApiId "5adf6fbf0faadf3ad8558065" +``` + +```output +ApiId : /apis/5adf6fbf0faadf3ad8558065;rev=3 +ApiRevision : 3 +CreatedDateTime : 4/26/2018 10:57:42 PM +UpdatedDateTime : 4/26/2018 10:57:42 PM +Description : ddsds +PrivateUrl : /httpbin/v1;rev=3 +IsOnline : True +IsCurrent : False + +ApiId : /apis/5adf6fbf0faadf3ad8558065;rev=2 +ApiRevision : 2 +CreatedDateTime : 4/26/2018 10:57:33 PM +UpdatedDateTime : 4/26/2018 10:57:33 PM +Description : AA +PrivateUrl : /httpbin/v1 +IsOnline : True +IsCurrent : True + +ApiId : /apis/5adf6fbf0faadf3ad8558065;rev=1 +ApiRevision : 1 +CreatedDateTime : 4/24/2018 5:56:17 PM +UpdatedDateTime : 5/9/2018 9:29:06 PM +Description : +PrivateUrl : /httpbin/v1;rev=1 +IsOnline : True +IsCurrent : False +``` + +This command gets all of the API revision of specified API for particular ApiManagement Context. + +## PARAMETERS + +### -ApiId +API identifier whose revisions we want to list. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Revision Identifier of the particular Api revision. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRevision + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementApiSchema.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementApiSchema.md new file mode 100644 index 0000000000..2ae9cb9e89 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementApiSchema.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementapischema +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementApiSchema.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementApiSchema.md +--- + +# Get-AzApiManagementApiSchema + +## SYNOPSIS +Get the details of the API Schema + +## SYNTAX + +### ContextParameterSet (Default) +``` +Get-AzApiManagementApiSchema -Context -ApiId [-SchemaId ] + [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzApiManagementApiSchema -ResourceId [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzApiManagementApiSchema** cmdlet gets the details of the API Schema + +## EXAMPLES + +### Example 1: Get the details of all the Api Schema of an Api +```powershell +$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.ApiManagement/service/sdktestapim4163 +Get-AzApiManagementApiSchema -Context $context -ApiId wsdlapitest +``` + +```output +SchemaId : 2a03e1b4-1826-4e59-b372-4711f575db28 +Api Id : wsdlapitest +Schema ContentType : xsdschema +Schema Document : [-ApiVersionSetId ] + [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzApiManagementApiVersionSet -Context [-ApiVersionSetId ] + -ResourceId [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementApiVersionSet** cmdlet gets the details of the API Version Sets configured in an API Management context. + +## EXAMPLES + +### Example 1: Get all API Version Sets +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementApiVersionSet -Context $ApiMgmtContext +``` + +```output +ApiVersionSetId : a93316c8-8b88-46cc-8260-380789a5d598 +Description : +VersionQueryName : +VersionHeaderName : +DisplayName : Echo API +VersioningScheme : Segment +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/api-version-sets/a916c8-8b88-46cc-8260-380789a5d598 +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso + +ApiVersionSetId : 4cbdfa34-25f3-4a93-a9b6-76b6eade7562 +Description : +VersionQueryName : api-version +VersionHeaderName : +DisplayName : getproduct old +VersioningScheme : Query +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/api-version-sets/4cbdfa34-25f3-4a93-a9b6-76b6eade7562 +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso + + +ApiVersionSetId : 8c441e0e-a0cd-47d8-8d88-f944a83b41bd +Description : +VersionQueryName : +VersionHeaderName : Api-Version +DisplayName : ordersapi +VersioningScheme : Header +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/api-version-sets/8c441e0e-a0cd-47d8-8d88-f944a83b41bd +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso +``` + +This command gets all of the API Version sets for the specified context. + +### Example 2: Get a API Version Set by ID +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementApiVersionSet -Context $ApiMgmtContext -ApiVersionSetId $ApiVersionSetId +``` + +```output +ApiVersionSetId : 8c441e0e-a0cd-47d8-8d88-f944a83b41bd +Description : +VersionQueryName : +VersionHeaderName : Api-Version +DisplayName : ordersapi +VersioningScheme : Header +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/api-version-sets/8c441e0e-a0cd-47d8-8d88-f944a83b41bd +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso +``` + +This command gets the API Version Set with the specified ID. + +## PARAMETERS + +### -ApiVersionSetId +API identifier to look for. +If specified will try to get the API by the Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Arm Resource Identifier of the ApiVersionSet. If specified will try to find apiVersionSet by the identifier. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementApiVersionSet](./New-AzApiManagementApiVersionSet.md) + +[Remove-AzApiManagementApiSet](./Remove-AzApiManagementApiVersionSet.md) + +[Set-AzApiManagementApiVersionSet](./Set-AzApiManagementApiVersionSet.md) diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementAuthorizationServer.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementAuthorizationServer.md new file mode 100644 index 0000000000..1468939eac --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementAuthorizationServer.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 8B0116E5-0AED-4050-BF11-1BFE65DB9436 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementauthorizationserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementAuthorizationServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementAuthorizationServer.md +--- + +# Get-AzApiManagementAuthorizationServer + +## SYNOPSIS +Gets an API Management authorization server. + +## SYNTAX + +### ContextParameterSet (Default) +``` +Get-AzApiManagementAuthorizationServer -Context [-ServerId ] + [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzApiManagementAuthorizationServer [-ServerId ] -ResourceId + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementAuthorizationServer** cmdlet gets all Azure API Management authorization servers or specified authorization server. +ClientSecret will not be included into result details. To get client secret, use **Get-AzApiManagementAuthorizationServerClientSecret**. + +## EXAMPLES + +### Example 1: Get all authorization servers +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementAuthorizationServer -Context $ApiMgmtContext +``` + +This command gets all API Management authorization servers. + +### Example 2: Get a specified authorization server +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementAuthorizationServer -Context $ApiMgmtContext -ServerId "0123456789" +``` + +This command gets the specified authorization server. + +## PARAMETERS + +### -Context + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ContextParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Arm Resource Identifier of the authorization server. If specified will try to find authorization server by the identifier. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerId +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthorizationServer + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementAuthorizationServer](./New-AzApiManagementAuthorizationServer.md) + +[Remove-AzApiManagementAuthorizationServer](./Remove-AzApiManagementAuthorizationServer.md) + +[Set-AzApiManagementAuthorizationServer](./Set-AzApiManagementAuthorizationServer.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementAuthorizationServerClientSecret.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementAuthorizationServerClientSecret.md new file mode 100644 index 0000000000..5a1bbbfff1 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementAuthorizationServerClientSecret.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementauthorizationserverclientsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementAuthorizationServerClientSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementAuthorizationServerClientSecret.md +--- + +# Get-AzApiManagementAuthorizationServerClientSecret + +## SYNOPSIS +Gets an API Management authorization server client secret. + +## SYNTAX + +### ContextParameterSet (Default) +``` +Get-AzApiManagementAuthorizationServerClientSecret -Context [-ServerId ] + [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzApiManagementAuthorizationServerClientSecret [-ServerId ] -ResourceId + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementAuthorizationServerClientSecret** cmdlet gets the client secret of the Azure API Management authorization server. + +## EXAMPLES + +### Example 1: Get a specified authorization server client secret by id +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementAuthorizationServerClientSecret -Context $ApiMgmtContext -ServerId "0123456789" +``` + +This command gets the specified authorization server client secret. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ContextParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Arm Resource Identifier of the authorization server. +If specified will try to find authorization server by the identifier. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerId +Identifier of the authorization server. +If specified will find authorization server by the identifier. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementClientSecret + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementBackend.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementBackend.md new file mode 100644 index 0000000000..e15da45800 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementBackend.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementbackend +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementBackend.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementBackend.md +--- + +# Get-AzApiManagementBackend + +## SYNOPSIS +Get the details of the Backend. + +## SYNTAX + +### ContextParameterSet (Default) +``` +Get-AzApiManagementBackend -Context [-BackendId ] + [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzApiManagementBackend [-BackendId ] -ResourceId + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get the details of the Backend. + +## EXAMPLES + +### Example 1: Get all Backends +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementBackend -Context $apimContext +``` + +Gets a list of all the Backends configured in the Api Management service. + +### Example 2: Get the Backend specified by the Identifier 123 +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementBackend -Context $apimContext -backendId 123 +``` + +Get the details of the specified Backend identified by the Identifier '123' + +## PARAMETERS + +### -BackendId +Identifier of a backend. +If specified will try to find backend by the identifier. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ContextParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Arm Resource Identifier of the backend. If specified will try to find backend by the identifier. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementBackend](./New-AzApiManagementBackend.md) + +[New-AzApiManagementBackendCredential](./New-AzApiManagementBackendCredential.md) + +[New-AzApiManagementBackendProxy](./New-AzApiManagementBackendProxy.md) + +[Set-AzApiManagementBackend](./Set-AzApiManagementBackend.md) + +[Remove-AzApiManagementBackend](./Remove-AzApiManagementBackend.md) diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementCache.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementCache.md new file mode 100644 index 0000000000..5b5bc27778 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementCache.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementcache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementCache.md +--- + +# Get-AzApiManagementCache + +## SYNOPSIS +Get the details of the Cache. + +## SYNTAX + +### ContextParameterSet (Default) +``` +Get-AzApiManagementCache -Context [-CacheId ] + [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzApiManagementCache -ResourceId [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get the details of the Cache configured in Api Management service. + +## EXAMPLES + +### Example 1: Get all Caches +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementCache -Context $apimContext +``` + +```output +CacheId : westus +Description : apim.redis.cache.windows.net +ConnectionString : {{5cc1848125a3f724dcf9a928}} +ResourceId : https://management.azure.com/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/Api-Default-West-US/providers/Microsoft.Cache/Redis/apim +Id : /subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/caches/westus +ResourceGroupName : Api-Default-West-US +ServiceName : contoso +``` + +Gets a list of all the Caches configured in the Api Management service. + +### Example 2: Get the Cache specified by the Identifier westus +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementCache -Context $apimContext -cacheId westus +``` + +```output +CacheId : westus +Description : apim.redis.cache.windows.net +ConnectionString : {{5cc1848125a3f724dcf9a928}} +ResourceId : https://management.azure.com/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/Api-Default-West-US/providers/Microsoft.Cache/Redis/apim +Id : /subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/caches/westus +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso +``` + +Get the details of the specified Cache configured for westus + +## PARAMETERS + +### -CacheId +Identifier of a cache. +If specified will try to find cache by the identifier. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: ContextParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ContextParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Arm Resource Identifier of a cache. If specified will try to find cache by the identifier. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCache + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementCache](./New-AzApiManagementCache.md) + +[Remove-AzApiManagementCache](./Remove-AzApiManagementCache.md) + +[Update-AzApiManagementCache](./Update-AzApiManagementCache.md) diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementCertificate.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementCertificate.md new file mode 100644 index 0000000000..7bb25a706e --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementCertificate.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 6F7C6611-5C56-4F1D-AB98-CDD92D88821C +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementCertificate.md +--- + +# Get-AzApiManagementCertificate + +## SYNOPSIS +Gets API Management certificates configured for Mutual Authentication with Backend in the service. + +## SYNTAX + +### ContextParameterSet (Default) +``` +Get-AzApiManagementCertificate -Context [-CertificateId ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ResourceIdParameterSet +``` +Get-AzApiManagementCertificate [-CertificateId ] -ResourceId + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementCertificate** cmdlet gets all Azure API Management certificates or certificates that you specify. + +## EXAMPLES + +### Example 1: Get all certificates +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementCertificate -Context $ApiMgmtContext +``` + +This command gets all API Management certificates. + +### Example 2: Get a certificate by its ID +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementCertificate -Context $ApiMgmtContext -CertificateId "0123456789" +``` + +This command gets the API Management certificate with the specified ID. + +## PARAMETERS + +### -CertificateId +Specifies the ID of the certificate to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ContextParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Arm Resource Identifier of the Certificate. If specified will try to find certificate by the identifier. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementCertificate](./New-AzApiManagementCertificate.md) + +[Remove-AzApiManagementCertificate](./Remove-AzApiManagementCertificate.md) + +[Set-AzApiManagementCertificate](./Set-AzApiManagementCertificate.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementDiagnostic.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementDiagnostic.md new file mode 100644 index 0000000000..c18b6f1a89 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementDiagnostic.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementdiagnostic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementDiagnostic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementDiagnostic.md +--- + +# Get-AzApiManagementDiagnostic + +## SYNOPSIS +Get details of the Diagnostic configured at the service level or the Api Level. Diagnostics are used to log requests/responses from Api Management gateway. + +## SYNTAX + +### ContextParameterSet (Default) +``` +Get-AzApiManagementDiagnostic -Context [-DiagnosticId ] [-ApiId ] + [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzApiManagementDiagnostic -ResourceId [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzApiManagementDiagnostic** gets details of the diagnostics configured in the Api management service at a given scope. + +## EXAMPLES + +### Example 1: Get all the diagnostic configured at the tenant scope. +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementDiagnostic -Context $apimContext +``` + +```output +DiagnosticId : applicationinsights +ApiId : +AlwaysLog : allErrors +LoggerId : backendapisachinc +EnableHttpCorrelationHeaders : True +SamplingSetting : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting +FrontendSetting : +BackendSetting : +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/diagnostics/applicationinsights +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso + +DiagnosticId : azuremonitor +ApiId : +AlwaysLog : +LoggerId : azuremonitor +EnableHttpCorrelationHeaders : +SamplingSetting : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting +FrontendSetting : +BackendSetting : +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/diagnostics/azuremonitor +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso +``` + +This command gets all the diagnostics configured in the Api Management service. + +### Example 2: Get all the diagnostics configured at the Api scope +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementDiagnostic -Context $apimContext -ApiId "echo-api" +``` + +```output +DiagnosticId : applicationinsights +ApiId : echo-api +AlwaysLog : allErrors +LoggerId : backendapisachinc +EnableHttpCorrelationHeaders : True +SamplingSetting : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting +FrontendSetting : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementPipelineDiagnosticSetting +BackendSetting : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementPipelineDiagnosticSetting +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/apis/echo-api/diagnostics/applicationinsights +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso +``` + +This command gets all the diagnostics configured at the `echo-api` Api scope + +### Example 3: Get the API-scope diagnostic specified by an Id +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementDiagnostic -Context $apimContext -ApiId "echo-api" -DiagnosticId "applicationinsights" +``` + +```output +DiagnosticId : applicationinsights +ApiId : echo-api +AlwaysLog : allErrors +LoggerId : backendapisachinc +EnableHttpCorrelationHeaders : True +SamplingSetting : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting +FrontendSetting : +BackendSetting : +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/diagnostics/applicationinsights +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso +``` + +This command gets the `applicationinsights` diagnostics configured in api `echo-api`. + +## PARAMETERS + +### -ApiId +Identifier of existing API. +If specified will return API-scope diagnostic. +This parameters is required. + +```yaml +Type: System.String +Parameter Sets: ContextParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ContextParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticId +Identifier of existing diagnostic. +If specified will return product-scope policy. +This parameters is optional. + +```yaml +Type: System.String +Parameter Sets: ContextParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Arm Resource Identifier of a Diagnostic or Api Diagnostic. If specified will try to find diagnostic by the identifier. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementDiagnostic + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementGateway.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementGateway.md new file mode 100644 index 0000000000..19fcc087b4 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementGateway.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementGateway.md +--- + +# Get-AzApiManagementGateway + +## SYNOPSIS +Gets all or specific API management Gateway. + +## SYNTAX + +### GetAllGateways (Default) +``` +Get-AzApiManagementGateway -Context [-DefaultProfile ] + [] +``` + +### GetByGatewayId +``` +Get-AzApiManagementGateway -Context -GatewayId + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementGateway** cmdlet gets all or specific API management Gateway. + +## EXAMPLES + +### Example 1: Get all gateways +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementGateway -Context $apimContext +``` + +This command gets all gateways. + +### Example 2: Get a gateway by ID +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementGateway -Context $apimContext -GatewayId "0123456789" +``` + +This command gets the gateway 0123456789. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayId +Identifier of a gateway. +If specified will try to find gateway by the identifier. + +```yaml +Type: System.String +Parameter Sets: GetByGatewayId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementGatewayHostnameConfiguration.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementGatewayHostnameConfiguration.md new file mode 100644 index 0000000000..4073cf04e9 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementGatewayHostnameConfiguration.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementgatewayhostnameconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementGatewayHostnameConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementGatewayHostnameConfiguration.md +--- + +# Get-AzApiManagementGatewayHostnameConfiguration + +## SYNOPSIS +Gets all or specific hostname configuration for the existing Gateway. + +## SYNTAX + +### GetByGatewayId (Default) +``` +Get-AzApiManagementGatewayHostnameConfiguration -Context -GatewayId + [-DefaultProfile ] [] +``` + +### GetByGatewayHostnameId +``` +Get-AzApiManagementGatewayHostnameConfiguration -Context -GatewayId + -GatewayHostnameConfigurationId [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementGatewayHostnameConfiguration** cmdlet gets all or specific hostname configuration for the existing Gateway. + +## EXAMPLES + +### Example 1: Get all hostname configurations for the gateway +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementGatewayHostnameConfiguration -Context $apimContext -GatewayId "0123456789" +``` + +This command gets all hostname configurations for a "0123456789" gateway. + +### Example 2: Get a hostname configuration for the gateway +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementGatewayHostnameConfiguration -Context $apimContext -GatewayId "0123456789" -GatewayHostnameConfigurationId "123" +``` + +This command gets "123" hostname configuration for a "0123456789" gateway. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayHostnameConfigurationId +Hostname Configuration identifier. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: GetByGatewayHostnameId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GatewayId +Gateway identifier. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGatewayHostnameConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementGatewayKey.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementGatewayKey.md new file mode 100644 index 0000000000..965ac81366 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementGatewayKey.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementgatewaykey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementGatewayKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementGatewayKey.md +--- + +# Get-AzApiManagementGatewayKey + +## SYNOPSIS +Gets keys of the existing Gateway + +## SYNTAX + +``` +Get-AzApiManagementGatewayKey -Context -GatewayId + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementGatewayKey** cmdlet gets keys of the existing Gateway + +## EXAMPLES + +### Example 1: Get a gateway by ID +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementGatewayKey -Context $apimContext -GatewayId "0123456789" +``` + +This command gets the keys for a "0123456789" gateway. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayId +Gateway identifier. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGatewayKey + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementGroup.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementGroup.md new file mode 100644 index 0000000000..2e3e63a22d --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementGroup.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: EEB52CCA-F5D6-4ACB-A6C9-D07C510A5878 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementGroup.md +--- + +# Get-AzApiManagementGroup + +## SYNOPSIS +Gets all or specific API management groups. + +## SYNTAX + +### GetAllGroups (Default) +``` +Get-AzApiManagementGroup -Context [-Name ] + [-DefaultProfile ] [] +``` + +### GetByGroupId +``` +Get-AzApiManagementGroup -Context [-GroupId ] [-Name ] + [-DefaultProfile ] [] +``` + +### GetByUserId +``` +Get-AzApiManagementGroup -Context [-Name ] [-UserId ] + [-DefaultProfile ] [] +``` + +### GetByProductId +``` +Get-AzApiManagementGroup -Context [-Name ] [-ProductId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementGroup** cmdlet gets all or specific API management groups. + +## EXAMPLES + +### Example 1: Get all groups +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementGroup -Context $apimContext +``` + +This command gets all groups. + +### Example 2: Get a group by ID +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementGroup -Context $apimContext -GroupId "0123456789" +``` + +This command gets the group ID named 0123456789. + +### Example 3: Get a group by name +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementGroup -Context $apimContext -Name "Group0002" +``` + +This command gets the group named Group0002. + +### Example 4: Get all user groups +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementGroup -Context $apimContext -UserId "0123456789" +``` + +This command gets all user groups with the user ID named 0123456789. + +## PARAMETERS + +### -Context +Specifies an instance of PsApiManagementContext. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +Specifies the group ID. +If specified, the cmdlet attempts to find the group by the identifier. + +```yaml +Type: System.String +Parameter Sets: GetByGroupId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the management group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductId +Identifier of existing product. +If specified will return all groups the product assigned to. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: GetByProductId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserId +Specifies the identifier of existing product. +If specified the cmdlet will return all groups the product assigned to. + +```yaml +Type: System.String +Parameter Sets: GetByUserId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementGroup](./New-AzApiManagementGroup.md) + +[Remove-AzApiManagementGroup](./Remove-AzApiManagementGroup.md) + +[Set-AzApiManagementGroup](./Set-AzApiManagementGroup.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementIdentityProvider.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementIdentityProvider.md new file mode 100644 index 0000000000..3438006dda --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementIdentityProvider.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementidentityprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementIdentityProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementIdentityProvider.md +--- + +# Get-AzApiManagementIdentityProvider + +## SYNOPSIS +Get the identity provider configuration details. + +## SYNTAX + +### AllIdentityProviders (Default) +``` +Get-AzApiManagementIdentityProvider -Context + [-DefaultProfile ] [] +``` + +### IdentityProviderByType +``` +Get-AzApiManagementIdentityProvider -Context + -Type [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get the identity provider configuration details. +ClientSecret will not be included into result details. To get client secret, use **Get-AzApiManagementIdentityProviderClientSecret**. + +## EXAMPLES + +### Example 1: Get all Identity Providers + +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementIdentityProvider -Context $apimContext +``` + +Get all the identity provider Configuration on the service. + +### Example 2: Get the AAD Type Identity Provider +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementIdentityProvider -Context $apimContext -Type Aad +``` + +```output +Type : Aad +ClientId : aaa +ClientSecret : xxxxx +AllowedTenants : {contosotest.onmicrosoft.com} +Authority : login.microsoftonline.com +SignupPolicyName : +SigninPolicyName : +ProfileEditingPolicyName : +PasswordResetPolicyName : +SigninTenant : +Id : /subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/identityProviders/Aad +ResourceGroupName : Api-Default-West-US +ServiceName : contoso +``` + +Gets the Identity Provider Configuration of Azure Active Directory. + +### Example 3: Get the AAD B2C Type Identity Provider +```powershell +$context = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementIdentityProvider -Context $context -Type AadB2C +``` + +```output +Type : AadB2C +ClientId : f02dafe2-b8b8-48ec-a38e-27e5c16c51e5 +ClientSecret : xxxxxx +AllowedTenants : {contosoaadb2c.onmicrosoft.com} +Authority : login.microsoftonline.com +SignupPolicyName : B2C_1_policy-signup +SigninPolicyName : B2C_1_policy-signin +ProfileEditingPolicyName : +PasswordResetPolicyName : +SigninTenant : contosoaadb2c.onmicrosoft.com +Id : /subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/identityProviders/AadB2C +ResourceGroupName : Api-Default-West-US +ServiceName : contoso +``` + +Gets the Identity Provider Configuration of Azure Active Directory. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Identifier of a Identity Provider. +If specified will try to find identity provider configuration by the identifier. +This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType +Parameter Sets: IdentityProviderByType +Aliases: +Accepted values: Facebook, Google, Microsoft, Twitter, Aad, AadB2C + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementIdentityProviderClientSecret.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementIdentityProviderClientSecret.md new file mode 100644 index 0000000000..bf0b149004 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementIdentityProviderClientSecret.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementidentityproviderclientsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementIdentityProviderClientSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementIdentityProviderClientSecret.md +--- + +# Get-AzApiManagementIdentityProviderClientSecret + +## SYNOPSIS +Get the identity provider client secret. + +## SYNTAX + +``` +Get-AzApiManagementIdentityProviderClientSecret -Context + -Type [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get the identity provider client secret. + +## EXAMPLES + +### Example 1: Get the client secret of AAD Type Identity Provider +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementIdentityProviderClientSecret -Context $apimContext -Type Aad +``` + +Gets the client secret of the Identity Provider Configuration of Azure Active Directory. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Identifier of a Identity Provider. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType +Parameter Sets: (All) +Aliases: +Accepted values: Facebook, Google, Microsoft, Twitter, Aad, AadB2C + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementClientSecret + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementLogger.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementLogger.md new file mode 100644 index 0000000000..92837d15d0 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementLogger.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: A935ABAC-6C60-4AE3-9434-B9BCC1182A34 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementlogger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementLogger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementLogger.md +--- + +# Get-AzApiManagementLogger + +## SYNOPSIS +Gets API Management Logger objects. + +## SYNTAX + +### GetAllLoggers (Default) +``` +Get-AzApiManagementLogger -Context [-DefaultProfile ] + [] +``` + +### GetByLoggerId +``` +Get-AzApiManagementLogger -Context -LoggerId + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementLogger** cmdlet gets an Azure API Management **Logger** or all the loggers. + +## EXAMPLES + +### Example 1: Get all loggers +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementLogger -Context $apimContext +``` + +This command gets all the loggers for the specified context. + +### Example 2: Get a specific logger +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementLogger -Context $apimContext -LoggerId "Logger123" +``` + +This command removes a logger that has the ID Logger123. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoggerId +Specifies the ID of the specific logger to get. + +```yaml +Type: System.String +Parameter Sets: GetByLoggerId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementLogger + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementLogger](./New-AzApiManagementLogger.md) + +[Remove-AzApiManagementLogger](./Remove-AzApiManagementLogger.md) + +[Set-AzApiManagementLogger](./Set-AzApiManagementLogger.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementNamedValue.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementNamedValue.md new file mode 100644 index 0000000000..b0b9412db9 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementNamedValue.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementnamedvalue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementNamedValue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementNamedValue.md +--- + +# Get-AzApiManagementNamedValue + +## SYNOPSIS +Gets a list or a particular Named Value. + +## SYNTAX + +### GetAllNamedValues (Default) +``` +Get-AzApiManagementNamedValue -Context [-DefaultProfile ] + [] +``` + +### GetByNamedValueId +``` +Get-AzApiManagementNamedValue -Context [-NamedValueId ] + [-DefaultProfile ] [] +``` + +### GetByName +``` +Get-AzApiManagementNamedValue -Context [-Name ] + [-DefaultProfile ] [] +``` + +### GetByTag +``` +Get-AzApiManagementNamedValue -Context [-Tag ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementNamedValue** cmdlet gets a list or a particular named value. +Value will not be included into result details if the named value marked as a secret. To get secret value, use **Get-AzApiManagementNamedValueSecretValue**. + +## EXAMPLES + +### Example 1: Get Named Value by name +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementNamedValue -Context $apimContext -Name "sql-connectionstring" +``` + +This command gets the named value details given the named value name. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Finds named values with names containing the string Name. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NamedValueId +Identifier of the named value. +If specified will try to find named value by the identifier. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: GetByNamedValueId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Finds named values associated with a Tag. +If specified will return all properties associated with a tag. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: GetByTag +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementNamedValue + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementNamedValueSecretValue.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementNamedValueSecretValue.md new file mode 100644 index 0000000000..75ac38258d --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementNamedValueSecretValue.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementnamedvaluesecretvalue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementNamedValueSecretValue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementNamedValueSecretValue.md +--- + +# Get-AzApiManagementNamedValueSecretValue + +## SYNOPSIS +Gets a secret value of the particular Named Value. + +## SYNTAX + +### Default (Default) +``` +Get-AzApiManagementNamedValueSecretValue -Context + [-DefaultProfile ] [] +``` + +### GetByNamedValueId +``` +Get-AzApiManagementNamedValueSecretValue -Context -NamedValueId + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets a secret value of the particular Named Value. + +## EXAMPLES + +### Example 1: Get named value by name +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementNamedValueSecretValue -Context $apimContext -NamedValueId "sql-connectionstring" +``` + +This command gets the named value details given the named value name. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamedValueId +Identifier of a the named value. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: GetByNamedValueId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementNamedValueSecretValue + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementNetworkStatus.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementNetworkStatus.md new file mode 100644 index 0000000000..136e6fff82 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementNetworkStatus.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementnetworkstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementNetworkStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementNetworkStatus.md +--- + +# Get-AzApiManagementNetworkStatus + +## SYNOPSIS +Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService. + +## SYNTAX + +### ByInputObject (Default) +``` +Get-AzApiManagementNetworkStatus -ApiManagementObject [-Location ] + [-DefaultProfile ] [] +``` + +### ExpandedParameter +``` +Get-AzApiManagementNetworkStatus -ResourceGroupName -Name [-Location ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the Network status of their Api Management service + +## EXAMPLES + +### Example 1 + +```powershell +Get-AzApiManagementNetworkStatus -ResourceGroupName powershelltest -Name powershellsdkservice + +Location DnsServers ConnectivityStatus +-------- ---------- ------------------ +West US {168.63.129.16} {apimgmtstaoonqs7wwzjosky.blob.core.windows.net, apimgmtstaoonqs7wwzjosky.file.core.windows.net, apimgmtstaoonqs7wwzjosky.queue.core.windows.net, apimgmtstaoonqs7wwzjosk... + + +$networkStatus = Get-AzApiManagementNetworkStatus -ResourceGroupName powershelltest -Name powershellsdkservice +$networkStatus.ConnectivityStatus + + +Name : apimgmtstaoonqs7wwzjosky.blob.core.windows.net +Status : success +Error : +LastUpdated : 5/2/2019 5:06:38 PM +LastStatusChange : 1/30/2019 5:31:38 PM + +Name : apimgmtstaoonqs7wwzjosky.file.core.windows.net +Status : success +Error : +LastUpdated : 5/2/2019 5:06:38 PM +LastStatusChange : 1/30/2019 5:31:39 PM + +Name : apimgmtstaoonqs7wwzjosky.queue.core.windows.net +Status : success +Error : +LastUpdated : 5/2/2019 5:06:38 PM +LastStatusChange : 1/30/2019 5:31:39 PM + +Name : apimgmtstaoonqs7wwzjosky.table.core.windows.net +Status : success +Error : +LastUpdated : 5/2/2019 5:06:38 PM +LastStatusChange : 1/30/2019 5:31:38 PM + +Name : bx9gltecfv.database.windows.net +Status : success +Error : +LastUpdated : 5/2/2019 5:06:41 PM +LastStatusChange : 1/30/2019 5:31:39 PM + +Name : https://prod3.metrics.nsatc.net:1886/RecoveryService +Status : success +Error : +LastUpdated : 5/2/2019 5:07:11 PM +LastStatusChange : 4/29/2019 1:31:30 PM + +Name : prod.warmpath.msftcloudes.com +Status : success +Error : +LastUpdated : 5/2/2019 5:06:38 PM +LastStatusChange : 1/30/2019 5:31:38 PM + +Name : Scm +Status : success +Error : +LastUpdated : 5/2/2019 5:04:27 PM +LastStatusChange : 4/30/2019 11:16:20 PM +``` + +Gets the connectivity status of the different resources on which ApiManagement service depends upon. + +## PARAMETERS + +### -ApiManagementObject +Instance of PsApiManagement. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the API Management Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of API Management. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which API Management exists. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementNetworkStatus + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementOpenIdConnectProvider.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementOpenIdConnectProvider.md new file mode 100644 index 0000000000..e26c8b7278 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementOpenIdConnectProvider.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 15B6EAE2-56ED-4A01-B8EA-52B9FCDC1F66 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementopenidconnectprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementOpenIdConnectProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementOpenIdConnectProvider.md +--- + +# Get-AzApiManagementOpenIdConnectProvider + +## SYNOPSIS +Gets OpenID Connect providers. + +## SYNTAX + +### GetAllOpenIdConnectProviders (Default) +``` +Get-AzApiManagementOpenIdConnectProvider -Context + [-DefaultProfile ] [] +``` + +### GetByOpenIdConnectProviderId +``` +Get-AzApiManagementOpenIdConnectProvider -Context [-OpenIdConnectProviderId ] + [-DefaultProfile ] [] +``` + +### GetByName +``` +Get-AzApiManagementOpenIdConnectProvider -Context [-Name ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementOpenIdConnectProvider** cmdlet gets OpenID Connect providers in Azure API Management. +ClientSecret will not be included into result details. To get client secret, use **Get-AzApiManagementOpenIdConnectProviderClientSecret**. + +## EXAMPLES + +### Example 1: Get all providers +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementOpenIdConnectProvider -Context $apimContext +``` + +This command gets all OpenID Connect providers for the specified context. + +### Example 2: Get a provider by using an ID +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvider01" +``` + +This command gets the provider that has the ID OICProvider01. + +### Example 3: Get a provider by using a name +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementOpenIdConnectProvider -Context $apimContext -Name "Contoso OpenID Connect Provider" +``` + +This command gets the provider named Contoso OpenID Connect Provider. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a friendly name of a provider. +If you specify a name, this cmdlet gets that provider. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OpenIdConnectProviderId +Specifies an ID of the provider that this cmdlet removes. +If you specify an ID, this cmdlet gets that provider. + +```yaml +Type: System.String +Parameter Sets: GetByOpenIdConnectProviderId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOpenIdConnectProvider + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementOpenIdConnectProvider](./New-AzApiManagementOpenIdConnectProvider.md) + +[Remove-AzApiManagementOpenIdConnectProvider](./Remove-AzApiManagementOpenIdConnectProvider.md) + +[Set-AzApiManagementOpenIdConnectProvider](./Set-AzApiManagementOpenIdConnectProvider.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementOpenIdConnectProviderClientSecret.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementOpenIdConnectProviderClientSecret.md new file mode 100644 index 0000000000..469e9313e0 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementOpenIdConnectProviderClientSecret.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementopenidconnectproviderclientsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementOpenIdConnectProviderClientSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementOpenIdConnectProviderClientSecret.md +--- + +# Get-AzApiManagementOpenIdConnectProviderClientSecret + +## SYNOPSIS +Gets OpenID Connect provider client secret. + +## SYNTAX + +``` +Get-AzApiManagementOpenIdConnectProviderClientSecret -Context + -OpenIdConnectProviderId [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets OpenID Connect provider client secret. + +## EXAMPLES + +### Example 1: Get a provider client secret by using an ID +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementOpenIdConnectProviderClientSecret -Context $apimContext -OpenIdConnectProviderId "OICProvider01" +``` + +This command gets a client secret of the provider that has the ID OICProvider01. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OpenIdConnectProviderId +Identifier of a OpenID Connect Provider. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementClientSecret + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementOperation.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementOperation.md new file mode 100644 index 0000000000..7f09fe6278 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementOperation.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: D5EB9AFA-B56C-45E2-838B-4555ED1EF8F8 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementOperation.md +--- + +# Get-AzApiManagementOperation + +## SYNOPSIS +Gets a list or a specified API Operation. + +## SYNTAX + +### GetAllApiOperations (Default) +``` +Get-AzApiManagementOperation -Context -ApiId [-ApiRevision ] + [-DefaultProfile ] [] +``` + +### GetById +``` +Get-AzApiManagementOperation -Context -ApiId [-ApiRevision ] + -OperationId [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementOperation** gets a list or a specified API Operation. + +## EXAMPLES + +### Example 1: Get all API management operations +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementOperation -Context $apimContext -ApiId $APIId +``` + +This command gets all API management operations. + +### Example 2: Get an API Management operation by operation ID +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementOperation -Context $apimContext -ApiId $APIId -OperationId "Operation003" +``` + +This command gets an API management operation by operation ID named Operation0003. + +## PARAMETERS + +### -ApiId +Specifies the identifier of the API Operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Identifier of API Revision. This parameter is optional. If not specified, the operation will be retrieved from the currently active api revision. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies the instance of the **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationId +Specifies the operation identifier. + +```yaml +Type: System.String +Parameter Sets: GetById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementOperation](./New-AzApiManagementOperation.md) + +[Remove-AzApiManagementOperation](./Remove-AzApiManagementOperation.md) + +[Set-AzApiManagementOperation](./Set-AzApiManagementOperation.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementPolicy.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementPolicy.md new file mode 100644 index 0000000000..72eef56f8f --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementPolicy.md @@ -0,0 +1,317 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 7BCEB0EF-1A09-4CED-9F34-CE3AB03181A7 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementPolicy.md +--- + +# Get-AzApiManagementPolicy + +## SYNOPSIS +Gets the specified scope policy. + +## SYNTAX + +### GetTenantLevel (Default) +``` +Get-AzApiManagementPolicy -Context [-Format ] [-SaveAs ] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### GetProductLevel +``` +Get-AzApiManagementPolicy -Context [-Format ] [-SaveAs ] + -ProductId [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### GetApiLevel +``` +Get-AzApiManagementPolicy -Context [-Format ] [-SaveAs ] + -ApiId [-ApiRevision ] [-Force] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### GetOperationLevel +``` +Get-AzApiManagementPolicy -Context [-Format ] [-SaveAs ] + -ApiId [-ApiRevision ] -OperationId [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementPolicy** cmdlet gets the specified scope policy. + +## EXAMPLES + +### Example 1: Get the tenant level policy +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementPolicy -Context $apimContext -SaveAs "C:\contoso\policies\tenantpolicy.xml" +``` + +This command gets tenant level policy and saves it to a file named tenantpolicy.xml. + +### Example 2: Get the product-scope policy +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementPolicy -Context $apimContext -ProductId "0123456789" +``` + +This command gets product-scope policy + +### Example 3: Get the API-scope policy +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" +``` + +This command gets API-scope policy. + +### Example 4: Get the operation-scope policy +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777" +``` + +This command gets the operation-scope policy. + +### Example 5: Get the Tenant scope policy in RawXml format +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementPolicy -Context $apimContext -Format rawxml +``` + +```output + + + + @{ + var guidBinary = new byte[16]; + Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10); + long time = DateTime.Now.Ticks; + byte[] bytes = new byte[6]; + unchecked + { + bytes[5] = (byte)(time >> 40); + bytes[4] = (byte)(time >> 32); + bytes[3] = (byte)(time >> 24); + bytes[2] = (byte)(time >> 16); + bytes[1] = (byte)(time >> 8); + bytes[0] = (byte)(time); + } + Array.Copy(bytes, 0, guidBinary, 10, 6); + return new Guid(guidBinary).ToString(); + } + + + + + + + + + +``` + +This command gets the tenant-scope policy in Non-Xml escaped format. + +## PARAMETERS + +### -ApiId +Specifies the identifier of the existing API. +If you specify this parameter the cmdlet returns the API-scope policy. + +```yaml +Type: System.String +Parameter Sets: GetApiLevel, GetOperationLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Identifier of API Revision. This parameter is optional. If not specified, the policy will be retrieved from the currently active api revision. + +```yaml +Type: System.String +Parameter Sets: GetApiLevel, GetOperationLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies an instance of **PsApiManagementContext**. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Format +Specifies the format of the API management policy. +The default value for this parameter is "xml". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OperationId +Specifies the identifier of the existing API operation. +If you specify this parameter with *ApiId* the cmdlet returns operation-scope policy. + +```yaml +Type: System.String +Parameter Sets: GetOperationLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductId +Specifies the identifier of an existing product. +If you specify this parameter the cmdlet returns the product-scope policy. + +```yaml +Type: System.String +Parameter Sets: GetProductLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SaveAs +Specifies the file path to save the result to. +If you do not specify this parameter the result is pipelined as a sting. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Remove-AzApiManagementPolicy](./Remove-AzApiManagementPolicy.md) + +[Set-AzApiManagementPolicy](./Set-AzApiManagementPolicy.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementProduct.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementProduct.md new file mode 100644 index 0000000000..1669c4fd6e --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementProduct.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: B64E9C13-97A6-4E8B-92DB-EFAF8A48C5B8 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementproduct +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementProduct.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementProduct.md +--- + +# Get-AzApiManagementProduct + +## SYNOPSIS +Gets a list or a particular product. + +## SYNTAX + +### GetAllProducts (Default) +``` +Get-AzApiManagementProduct -Context [-DefaultProfile ] + [] +``` + +### GetByProductId +``` +Get-AzApiManagementProduct -Context -ProductId + [-DefaultProfile ] [] +``` + +### GetByTitle +``` +Get-AzApiManagementProduct -Context [-Title ] + [-DefaultProfile ] [] +``` + +### GetByApiId +``` +Get-AzApiManagementProduct -Context -ApiId + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementProduct** cmdlet gets a list or a particular product. + +## EXAMPLES + +### Example 1: Get all products +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementProduct -Context $apimContext +``` + +This command get all API Management products. + +### Example 2: Get a product by ID +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementProduct -Context $apimContext -ProductId "0123456789" +``` + +This command get an API Management product by ID. + +### Example 2: Get a product by Title +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$product = Get-AzApiManagementProduct -Context $apimContext -Title 'Starter' +$product | Select-Object -First 1 +``` + +This command selects the first API Management product by Title. + +## PARAMETERS + +### -ApiId +ApiId of the Api to find the correlated products. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: GetByApiId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies an instance of a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProductId +Specifies the identifier of the product to search for. + +```yaml +Type: System.String +Parameter Sets: GetByProductId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Title +Specifies the title of the product to look for. +If specified, the cmdlet attempts to get the product by title. + +```yaml +Type: System.String +Parameter Sets: GetByTitle +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementProduct](./New-AzApiManagementProduct.md) + +[Remove-AzApiManagementProduct](./Remove-AzApiManagementProduct.md) + +[Set-AzApiManagementProduct](./Set-AzApiManagementProduct.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementSsoToken.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementSsoToken.md new file mode 100644 index 0000000000..5d399b4506 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementSsoToken.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: A7CABC63-2E9C-474B-A4F0-69F13A16F65A +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementssotoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementSsoToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementSsoToken.md +--- + +# Get-AzApiManagementSsoToken + +## SYNOPSIS +Gets a link with an SSO token to a deployed management portal of an API Management service. + +## SYNTAX + +### ExpandedParameter (Default) +``` +Get-AzApiManagementSsoToken -ResourceGroupName -Name + [-DefaultProfile ] [] +``` + +### ByInputObject +``` +Get-AzApiManagementSsoToken -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzApiManagementSsoToken** cmdlet returns a link (URL) containing a single sign-on (SSO) token to a deployed management portal of an API Management service. + +## EXAMPLES + +### Example 1: Get the SSO token of an API Management service +```powershell +Get-AzApiManagementSsoToken -ResourceGroupName "Contoso" -Name "ContosoApi" +``` + +This command gets the SSO token of an API Management service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagement. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the API Management instance. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of resource group under which API Management exists. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagement](./Get-AzApiManagement.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementSubscription.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementSubscription.md new file mode 100644 index 0000000000..c3dc3f48be --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementSubscription.md @@ -0,0 +1,294 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 227EF8A2-E04A-4F6B-B66E-E77F1276A7E4 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementSubscription.md +--- + +# Get-AzApiManagementSubscription + +## SYNOPSIS +Gets subscriptions. + +## SYNTAX + +### GetAllSubscriptions (Default) +``` +Get-AzApiManagementSubscription -Context [-DefaultProfile ] + [] +``` + +### GetBySubscriptionId +``` +Get-AzApiManagementSubscription -Context [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetByProductIdAndUser +``` +Get-AzApiManagementSubscription -Context -UserId -ProductId + [-DefaultProfile ] [] +``` + +### GetByUserId +``` +Get-AzApiManagementSubscription -Context [-UserId ] + [-DefaultProfile ] [] +``` + +### GetByProductId +``` +Get-AzApiManagementSubscription -Context [-ProductId ] + [-DefaultProfile ] [] +``` + +### GetByScope +``` +Get-AzApiManagementSubscription -Context -Scope + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementSubscription** cmdlet gets a specified subscription, or all subscriptions, if no subscription is specified. +Keys will not be included into result details. To get keys, use **Get-AzApiManagementSubscriptionKey**. + +## EXAMPLES + +### Example 1: Get all subscriptions +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-East-US" -ServiceName "contoso" +Get-AzApiManagementSubscription -Context $apimContext +``` + +This command gets all subscriptions. + +### Example 2: Get a subscription with a specified ID +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-East-US" -ServiceName "contoso" +Get-AzApiManagementSubscription -Context $apimContext -SubscriptionId "0123456789" +``` + +This command gets a subscription by ID. + +### Example 3: Get all subscriptions for a user +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-East-US" -ServiceName "contoso" +Get-AzApiManagementSubscription -Context $apimContext -UserId "777" +``` + +This command gets a user's subscriptions. + +### Example 4: Get all subscriptions for a product +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-East-US" -ServiceName "contoso" +Get-AzApiManagementSubscription -Context $apimContext -ProductId "999" +``` + +This command gets all subscriptions for the product. + +### Example 5: Get all subscriptions for a Scope +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-East-US" -ServiceName "contoso" +Get-AzApiManagementSubscription -Context $apimContext -Scope "/apis" +``` + +```output +SubscriptionId : allApScope +UserId : +OwnerId : +ProductId : +Scope : /subscriptions/subid/resourceGroups/Api-Default-East-US/providers/Microsoft.ApiManagement/service/contoso/apis +Name : All Api Scope +State : Active +CreatedDate : 6/18/2019 5:53:49 PM +StartDate : +ExpirationDate : +EndDate : +NotificationDate : +PrimaryKey : +SecondaryKey : +StateComment : +AllowTracing : False +Id : /subscriptions/subid/resourceGroups/Api-Default-East-US/providers/Microsoft.ApiManagement/service/contoso/subscriptions/allApScope +ResourceGroupName : Api-Default-East-US +ServiceName : contoso +``` + +This command gets all subscriptions which are configured for global api scope + +### Example 6: Get all subscriptions for a product and user scope +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-East-US" -ServiceName "contoso" +Get-AzApiManagementSubscription -Context $apimContext -ProductId 59b872f28a82740f547e6270 -UserId 1 +``` + +```output +SubscriptionId : 59b872f38a82741750c8da56 +UserId : 1 +OwnerId : /subscriptions/subid/resourceGroups/Api-Default-East-US/providers/Microsoft.ApiManagement/service/contoso/users/1 +ProductId : 59b872f28a82740f547e6270 +Scope : /subscriptions/subid/resourceGroups/Api-Default-East-US/providers/Microsoft.ApiManagement/service/contoso/products/59b872f28a82740f547e6270 +Name : +State : Active +CreatedDate : 9/12/2017 11:51:15 PM +StartDate : 9/12/2017 12:00:00 AM +ExpirationDate : +EndDate : +NotificationDate : +PrimaryKey : +SecondaryKey : +StateComment : +AllowTracing : True +Id : /subscriptions/subid/resourceGroups/Api-Default-East-US/providers/Microsoft.ApiManagement/service/contoso/subscriptions/59b872f38a82741750c8da56 +ResourceGroupName : Api-Default-East-US +ServiceName : contoso +``` + +This command gets all subscriptions which are configured for global api scope + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProductId +Specifies a product identifier. +If specified, this cmdlet finds all subscriptions by the product identifier. + +```yaml +Type: System.String +Parameter Sets: GetByProductIdAndUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByProductId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Scope identifier. The Scope of the Subscription, whether it is Api Scope /apis/{apiId} or Product Scope /products/{productId} or Global API Scope /apis or Global scope /. + +```yaml +Type: System.String +Parameter Sets: GetByScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +Specifies a subscription identifier. +If specified, this cmdlet finds subscription by the identifier. + +```yaml +Type: System.String +Parameter Sets: GetBySubscriptionId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserId +Specifies a user identifier. +If specified, this cmdlet finds all subscriptions by the user identifier. + +```yaml +Type: System.String +Parameter Sets: GetByProductIdAndUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByUserId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscription + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementSubscription](./New-AzApiManagementSubscription.md) + +[Remove-AzApiManagementSubscription](./Remove-AzApiManagementSubscription.md) + +[Set-AzApiManagementSubscription](./Set-AzApiManagementSubscription.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementSubscriptionKey.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementSubscriptionKey.md new file mode 100644 index 0000000000..e9eccabbb0 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementSubscriptionKey.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 227EF8A2-E04A-4F6B-B66E-E77F1276A7E4 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementsubscriptionkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementSubscriptionKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementSubscriptionKey.md +--- + +# Get-AzApiManagementSubscriptionKey + +## SYNOPSIS +Gets subscription keys. + +## SYNTAX + +``` +Get-AzApiManagementSubscriptionKey -Context -SubscriptionId + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementSubscriptionKey** cmdlet gets a keys of a specified subscription. + +## EXAMPLES + +### Example 1: Get a subscription keys with a specified ID +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-East-US" -ServiceName "contoso" +Get-AzApiManagementSubscriptionKey -Context $apimContext -SubscriptionId "0123456789" +``` + +```output +PrimaryKey : 5e48532634114fe999a6979ce0d63a64 +SecondaryKey : 0a8efaf85a664aa0a412241015c7c8f6 +``` + +This command gets a subscription by ID. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Specifies a subscription identifier. +If specified, this cmdlet finds subscription by the identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionKey + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementSubscription](./Get-AzApiManagementSubscription.md) + +[New-AzApiManagementSubscription](./New-AzApiManagementSubscription.md) + +[Remove-AzApiManagementSubscription](./Remove-AzApiManagementSubscription.md) + +[Set-AzApiManagementSubscription](./Set-AzApiManagementSubscription.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantAccess.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantAccess.md new file mode 100644 index 0000000000..1ee88dcebc --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantAccess.md @@ -0,0 +1,86 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 236B4436-E8AD-42B4-922C-E2E1406CAFC2 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementtenantaccess +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementTenantAccess.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementTenantAccess.md +--- + +# Get-AzApiManagementTenantAccess + +## SYNOPSIS +Gets the access configuration for a tenant. + +## SYNTAX + +``` +Get-AzApiManagementTenantAccess -Context [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzApiManagementTenantAccess** cmdlet gets the tenant access configuration for a tenant. +Keys will not be included into result details. To get client secret, use **Get-AzApiManagementTenantAccessSecret**. + +## EXAMPLES + +### Example 1: Get tenant access configuration +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementTenantAccess -Context $apimContext +``` + +This command gets the tenant access configuration for the specified context. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation + +## NOTES + +## RELATED LINKS + +[Set-AzApiManagementTenantAccess](./Set-AzApiManagementTenantAccess.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantAccessSecret.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantAccessSecret.md new file mode 100644 index 0000000000..34a83a9020 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantAccessSecret.md @@ -0,0 +1,81 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementtenantaccesssecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementTenantAccessSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementTenantAccessSecret.md +--- + +# Get-AzApiManagementTenantAccessSecret + +## SYNOPSIS +Gets the access configuration keys for a tenant. + +## SYNTAX + +``` +Get-AzApiManagementTenantAccessSecret -Context + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the access configuration keys for a tenant. + +## EXAMPLES + +### Example 1: Get tenant access configuration keys +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementTenantAccessSecret -Context $apimContext +``` + +This command gets the tenant access configuration keys for the specified context. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantGitAccess.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantGitAccess.md new file mode 100644 index 0000000000..b9f79e5a2a --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantGitAccess.md @@ -0,0 +1,88 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 6F01F494-CD1D-483A-9E57-BF693B1F2FC1 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementtenantgitaccess +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementTenantGitAccess.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementTenantGitAccess.md +--- + +# Get-AzApiManagementTenantGitAccess + +## SYNOPSIS +Gets the Git access configuration for a tenant. + +## SYNTAX + +``` +Get-AzApiManagementTenantGitAccess -Context [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzApiManagementTenantGitAccess** cmdlet gets the Git access configuration for a tenant. +Keys will not be included into result details. To get client secret, use **Get-AzApiManagementTenantGitAccessSecret**. + +## EXAMPLES + +### Example 1: Get tenant access configuration +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementTenantGitAccess -Context $apimContext +``` + +```output +Enabled Id PrimaryKey SecondaryKey +------- -- ---------- ------------ + True git GrPksEiunqn1BgprRvWIZZxUuaRl9vdz0ZFjVBxxx== OR4wVD//HzaE4Okb6aSdG9zy0O6kHhmfIJBaL9Zwu+Mxxxf9R2ydOslIw== +``` + +This command gets the Git access configuration for the specified context. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantGitAccessSecret.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantGitAccessSecret.md new file mode 100644 index 0000000000..e8cefd1fb0 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantGitAccessSecret.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementtenantgitaccesssecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementTenantGitAccessSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementTenantGitAccessSecret.md +--- + +# Get-AzApiManagementTenantGitAccessSecret + +## SYNOPSIS +Gets the Git access configuration keys for a tenant. + +## SYNTAX + +``` +Get-AzApiManagementTenantGitAccessSecret -Context + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the Git access configuration keys for a tenant. + +## EXAMPLES + +### Example 1: Get tenant access configuration +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementTenantGitAccessSecret -Context $apimContext +``` + +```output +Enabled Id PrimaryKey SecondaryKey +------- -- ---------- ------------ + True git GrPksEiunqn1BgprRvWIZZxUuaRl9vdz0ZFjVBxxx== OR4wVD//HzaE4Okb6aSdG9zy0O6kHhmfIJBaL9Zwu+Mxxxf9R2ydOslIw== +``` + +This command gets the Git access configuration keys for the specified context. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantSyncState.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantSyncState.md new file mode 100644 index 0000000000..22a273744a --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementTenantSyncState.md @@ -0,0 +1,81 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 288EF15B-FE5C-44AE-ABD5-2B92F408B9EB +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementtenantsyncstate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementTenantSyncState.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementTenantSyncState.md +--- + +# Get-AzApiManagementTenantSyncState + +## SYNOPSIS +Gets the status of the most recent synchronization between the configuration database and the Git repository. + +## SYNTAX + +``` +Get-AzApiManagementTenantSyncState -Context [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzApiManagementTenantSyncState** cmdlet gets the status of the most recent synchronization between the configuration database and the Git repository. + +## EXAMPLES + +### Example 1: Get the status of the most recent synchronization +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementTenantSyncState -Context $apimContext +``` + +This command gets the status of the most recent synchronization between the configuration database and the Git repository. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementTenantConfigurationSyncState + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementUser.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementUser.md new file mode 100644 index 0000000000..ae962e9f02 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementUser.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 638B2BF6-23F8-4038-B20B-1CFABFDBF5D3 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementUser.md +--- + +# Get-AzApiManagementUser + +## SYNOPSIS +Gets a user or users. + +## SYNTAX + +### GeAllUsers (Default) +``` +Get-AzApiManagementUser -Context [-DefaultProfile ] + [] +``` + +### GetByUserId +``` +Get-AzApiManagementUser -Context [-UserId ] + [-DefaultProfile ] [] +``` + +### GetByUser +``` +Get-AzApiManagementUser -Context [-FirstName ] [-LastName ] + [-State ] [-Email ] [-GroupId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementUser** cmdlet gets a specified user, or all users, if no user is specified. + +## EXAMPLES + +### Example 1: Get all users +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementUser -Context $apimContext +``` + +This command gets all users. + +### Example 2: Get a user by ID +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementUser -Context $apimContext -UserId "0123456789" +``` + +This command gets a user by ID. + +### Example 3: Get users by last name +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementUser -Context $apimContext -LastName "Fuller" +``` + +This command gets users that have a specified last name, Fuller. + +### Example 4: Get a user by email address +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementUser -Context $apimContext -Email "user@contoso.com" +``` + +This command gets the user that has the specified email address. + +### Example 5: Get all users within a group +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementUser -Context $apimContext -GroupId "0001" +``` + +This command gets all users within the specified group. + +## PARAMETERS + +### -Context +Specifies an instance of **PsApiManagementContext**. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +Specifies the email address of the user. +If this parameter is specified, this cmdlet finds a user by email. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: GetByUser +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FirstName +Specifies the first name of the user. +If this parameter is specified, this cmdlet finds a user by first name. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: GetByUser +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GroupId +Specifies the group identifier. +If specified, this cmdlet finds all users within the specified group. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: GetByUser +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LastName +Specifies the last name of a user. +If specified, this cmdlet finds users by last name. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: GetByUser +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the user state. +If specified, this cmdlet finds users in this state. +This parameter is optional. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState] +Parameter Sets: GetByUser +Aliases: +Accepted values: Active, Blocked, Deleted, Pending + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserId +Specifies a user ID. +If specified, this cmdlet finds the user by this identifier. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: GetByUserId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementUser](./New-AzApiManagementUser.md) + +[Remove-AzApiManagementUser](./Remove-AzApiManagementUser.md) + +[Set-AzApiManagementUser](./Set-AzApiManagementUser.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementUserSsoUrl.md b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementUserSsoUrl.md new file mode 100644 index 0000000000..897bb1c060 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Get-AzApiManagementUserSsoUrl.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 27FF1B7D-E103-4504-AD09-8D3A8BCA8B75 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/get-azapimanagementuserssourl +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementUserSsoUrl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Get-AzApiManagementUserSsoUrl.md +--- + +# Get-AzApiManagementUserSsoUrl + +## SYNOPSIS +Generates an SSO URL for a user. + +## SYNTAX + +``` +Get-AzApiManagementUserSsoUrl -Context -UserId + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzApiManagementUserSsoUrl** cmdlet generates a single sign-on (SSO) URL for a user. + +## EXAMPLES + +### Example 1: Get a user's SSO URL +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementUserSsoUrl -Context $apimContext -UserId "0123456789" +``` + +This command gets a user's SSO URL. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +Specifies a user ID. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementUser](./Get-AzApiManagementUser.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Import-AzApiManagementApi.md b/azps-10.1.0/Az.ApiManagement/Import-AzApiManagementApi.md new file mode 100644 index 0000000000..f642c77900 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Import-AzApiManagementApi.md @@ -0,0 +1,448 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 48C143BE-3BF6-43E3-99B0-1A1D12A0A3F3 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/import-azapimanagementapi +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Import-AzApiManagementApi.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Import-AzApiManagementApi.md +--- + +# Import-AzApiManagementApi + +## SYNOPSIS +Imports an API from a file or a URL. + +## SYNTAX + +### ImportFromLocalFile (Default) +``` +Import-AzApiManagementApi -Context [-ApiId ] [-ApiRevision ] + -SpecificationFormat -SpecificationPath [-Path ] + [-WsdlServiceName ] [-WsdlEndpointName ] [-ApiType ] + [-Protocol ] [-ServiceUrl ] [-ApiVersionSetId ] + [-ApiVersion ] [-DefaultProfile ] [] +``` + +### ImportFromUrl +``` +Import-AzApiManagementApi -Context [-ApiId ] [-ApiRevision ] + -SpecificationFormat -SpecificationUrl [-Path ] + [-WsdlServiceName ] [-WsdlEndpointName ] [-ApiType ] + [-Protocol ] [-ServiceUrl ] [-ApiVersionSetId ] + [-ApiVersion ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Import-AzApiManagementApi** cmdlet imports an Azure API Management API from a file or a URL in Web Application Description Language (WADL), Web Services Description Language (WSDL), or Swagger format. + +## EXAMPLES + +### Example 1: Import an API from a WADL file +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationPath "C:\contoso\specifications\echoapi.wadl" -Path "apis" +``` + +This command imports an API from the specified WADL file. + +### Example 2: Import an API from a Swagger file +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Swagger" -SpecificationPath "C:\contoso\specifications\echoapi.swagger" -Path "apis" +``` + +This command imports an API from the specified Swagger file. + +### Example 3: Import an API from a Swagger file and update an existing API +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Import-AzApiManagementApi -Context $ApiMgmtContext -ApiId "26591405e27d4ff3a8d8478d7e60c7b0" -SpecificationFormat "Swagger" -SpecificationPath "C:\contoso\specifications\echoapi.swagger" -Path "apis" +``` + +This command imports an API from the specified Swagger file and updates an existing API. + +### Example 4: Import an API from a WADL link +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationUrl "http://contoso.com/specifications/wadl/echoapi" -Path "apis" +``` + +This command imports an API from the specified WADL link. + +### Example 5: Import an API from a Open Api Link +```powershell +$context = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Import-AzApiManagementApi -Context $context -SpecificationFormat OpenApi -SpecificationUrl https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml -Path "petstore30" +``` + +```output +ApiId : af3f57bab399455aa875d7050654e9d1 +Name : Swagger Petstore +Description : +ServiceUrl : http://petstore.swagger.io/v1 +Path : petstore30 +ApiType : http +Protocols : {Https} +AuthorizationServerId : +AuthorizationScope : +OpenidProviderId : +BearerTokenSendingMethod : {} +SubscriptionKeyHeaderName : Ocp-Apim-Subscription-Key +SubscriptionKeyQueryParamName : subscription-key +ApiRevision : 1 +ApiVersion : +IsCurrent : True +IsOnline : False +SubscriptionRequired : +ApiRevisionDescription : +ApiVersionSetDescription : +ApiVersionSetId : +Id : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apis/af3f57bab399455aa875d7050654e9d1 +ResourceGroupName : Api-Default-West-US +ServiceName : contoso +``` + +This command imports an API from the specified Open 3.0 specification link. + +### Example 6: Import an API from a Open Api Link into a ApiVersion Set + +```powershell +$context = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Import-AzApiManagementApi -Context $context -SpecificationPath "C:\contoso\specifications\uspto.yml" -SpecificationFormat OpenApi -Path uspostal -ApiVersionSetId 0d50e2cf-aaeb-4ea3-8a58-db9ec079c6cd -ApiVersion v2 +``` + +```output +ApiId : 6c3f20c66e5745b19229d06cd865948f +Name : USPTO Data Set API +Description : The Data Set API (DSAPI) allows the public users to discover and search USPTO exported data sets. This is a generic API that allows USPTO users to make any CSV based data files + searchable through API. With the help of GET call, it returns the list of data fields that are searchable. With the help of POST call, data can be fetched based on the filters on the + field names. Please note that POST call is used to search the actual data. The reason for the POST call is that it allows users to specify any complex search criteria without worry + about the GET size limitations as well as encoding of the input parameters. +ServiceUrl : https://developer.uspto.gov/ds-api +Path : uspostal +ApiType : http +Protocols : {Https} +AuthorizationServerId : +AuthorizationScope : +OpenidProviderId : +BearerTokenSendingMethod : {} +SubscriptionKeyHeaderName : Ocp-Apim-Subscription-Key +SubscriptionKeyQueryParamName : subscription-key +ApiRevision : 1 +ApiVersion : v2 +IsCurrent : True +IsOnline : False +SubscriptionRequired : +ApiRevisionDescription : +ApiVersionSetDescription : +ApiVersionSetId : /subscriptions/subid/resourceGroups/Api-Default-East-US/providers/Microsoft.ApiManagement/service/contoso/apiVersionSets/0d50e2cf-aaeb-4ea3-8a58-db9ec079c6cd +Id : /subscriptions/subid/resourceGroups/Api-Default-East-US/providers/Microsoft.ApiManagement/service/contoso/apis/6c3f20c66e5745b19229d06cd865948f +ResourceGroupName : Api-Default-East-US +ServiceName : contoso +``` + +This command imports an API from the specified Open 3.0 specification document and create a new ApiVersion. + +### Example 7: Import an API from a GraphQL link +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "GraphQL" -SpecificationUrl "http://contoso.com/graphql" -Path "graphqlapi" +``` + +```output +ApiId : bg4g23csd067432zz853f0942341g3z1 +Name : GraphQL Api +Description : +ServiceUrl : http://contoso.com/graphql +Path : graphqlapi +ApiType : graphql +Protocols : {Https} +AuthorizationServerId : +AuthorizationScope : +OpenidProviderId : +BearerTokenSendingMethod : {} +SubscriptionKeyHeaderName : Ocp-Apim-Subscription-Key +SubscriptionKeyQueryParamName : subscription-key +ApiRevision : 1 +ApiVersion : +IsCurrent : True +IsOnline : False +SubscriptionRequired : +ApiRevisionDescription : +ApiVersionSetDescription : +ApiVersionSetId : +Id : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apis/bg4g23csd067432zz853f0942341g3z1 +ResourceGroupName : Api-Default-West-US +ServiceName : contoso +``` + +This command imports an API from the GraphQL link. + +## PARAMETERS + +### -ApiId +Specifies an ID for the API to import. +If you do not specify this parameter, an ID is generated for you. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Identifier of API Revision. This parameter is optional. If not specified, the import will be done onto the currently active revision or a new api. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiType +This parameter is optional with a default value of Http. The Soap option is only applicable when importing WSDL and will create a SOAP Passthrough API. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiType] +Parameter Sets: (All) +Aliases: +Accepted values: Http, Soap, WebSocket, GraphQL + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiVersion +Api Version of the Api to create. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiVersionSetId +A resource identifier for the related Api Version Set. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies a web API path as the last part of the API's public URL. +This URL is used by API consumers for sending requests to the web service. +Must be 1 to 400 characters long. +The default value is $Null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocol +Web API protocols (http, https). Protocols over which API is made available. This parameter is optional. If provided it will override the protocols specified in the specifications document. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[] +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https, Ws, Wss + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceUrl +A URL of the web service exposing the API. This URL will be used by Azure API Management only, and will not be made public. This parameter is optional. If provided it will override the ServiceUrl specified in the Specifications document. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SpecificationFormat +Specifies the specification format. +psdx_paramvalues Wadl, Wsdl, and Swagger. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiFormat +Parameter Sets: (All) +Aliases: +Accepted values: Wadl, Swagger, Wsdl, OpenApi, OpenApiJson, GraphQL + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SpecificationPath +Specifies the specification file path. + +```yaml +Type: System.String +Parameter Sets: ImportFromLocalFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SpecificationUrl +Specifies the specification URL. + +```yaml +Type: System.String +Parameter Sets: ImportFromUrl +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WsdlEndpointName +Local name of WSDL Endpoint (port) to be imported. Must be 1 to 400 characters long. This parameter is optional and only required for importing Wsdl. Default value is $null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WsdlServiceName +Local name of WSDL Service to be imported. Must be 1 to 400 characters long. This parameter is optional and only required for importing Wsdl . Default value is $null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiFormat + +### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiType, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi + +## NOTES + +## RELATED LINKS + +[Export-AzApiManagementApi](./Export-AzApiManagementApi.md) + +[Get-AzApiManagementApi](./Get-AzApiManagementApi.md) + +[New-AzApiManagementApi](./New-AzApiManagementApi.md) + +[Remove-AzApiManagementApi](./Remove-AzApiManagementApi.md) + +[Set-AzApiManagementApi](./Set-AzApiManagementApi.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagement.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagement.md new file mode 100644 index 0000000000..e3acdae86a --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagement.md @@ -0,0 +1,697 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 164C5205-01BA-47BB-B780-D0B9AE614A4B +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagement.md +--- + +# New-AzApiManagement + +## SYNOPSIS + +Creates an API Management deployment. + +## SYNTAX + +``` +New-AzApiManagement -ResourceGroupName -Name -Location -Organization + -AdminEmail [-Sku ] [-Capacity ] [-VpnType ] + [-VirtualNetwork ] + [-Tag ] + [-AdditionalRegions ] + [-CustomHostnameConfiguration ] + [-SystemCertificateConfiguration ] + [-SslSetting ] [-SystemAssignedIdentity] [-UserAssignedIdentity ] + [-EnableClientCertificate] [-Zone ] [-DisableGateway ] + [-MinimalControlPlaneApiVersion ] [-PublicNetworkAccess ] [-PublicIpAddressId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION + +The **New-AzApiManagement** cmdlet creates an API Management deployment in Azure API Management. + +## EXAMPLES + +### Example 1: Create a Developer tier API Management service + +```powershell +New-AzApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi2" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com" +``` + +```output +PublicIPAddresses : {104.43.240.65} +PrivateIPAddresses : +Id : /subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/ContosoGroup02/providers/Microsoft.ApiManagement/service/ContosoApi2 +Name : ContosoApi2 +Location : Central US +Sku : Developer +Capacity : 1 +CreatedTimeUtc : 2/24/2020 10:34:12 PM +ProvisioningState : Succeeded +RuntimeUrl : https://contosoapi2.azure-api.net +RuntimeRegionalUrl : https://contosoapi2-centralus-01.regional.azure-api.net +PortalUrl : https://contosoapi2.portal.azure-api.net +DeveloperPortalUrl : https://contosoapi2.developer.azure-api.net +ManagementApiUrl : https://contosoapi2.management.azure-api.net +ScmUrl : https://contosoapi2.scm.azure-api.net +PublisherEmail : admin@contoso.com +OrganizationName : Contoso +NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com +VirtualNetwork : +VpnType : None +PortalCustomHostnameConfiguration : +ProxyCustomHostnameConfiguration : {contosoapi2.azure-api.net} +ManagementCustomHostnameConfiguration : +ScmCustomHostnameConfiguration : +DeveloperPortalHostnameConfiguration : +SystemCertificates : +Tags : {} +AdditionalRegions : {} +SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting +Identity : +EnableClientCertificate : +ResourceGroupName : ContosoGroup02 +``` + +This command creates a Developer tier API Management service. +The command specifies the organization and the administrator address. +The command does not specify the *SKU* parameter. +Therefore, the cmdlet uses the default value of Developer. + +### Example 2: Create a Standard tier service that has three units + +```powershell +New-AzApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com" -Sku Standard -Capacity 3 +``` + +This command creates a Standard tier API Management service that has three units. + +### Example 3: Create a Consumption tier service + +```powershell +New-AzApiManagement -ResourceGroupName Api-Default-North-Europe -Name consumptionskuservice -Location 'West Europe' -Sku Consumption -Organization microsoft -AdminEmail contoso@contoso.com -SystemAssignedIdentity -EnableClientCertificate +``` + +```output +PublicIPAddresses : +PrivateIPAddresses : +Id : /subscriptions/subid/resourceGroups/Api-Default-North-Europe/providers/Microsoft.ApiManagement/service/consumptionskuservice +Name : consumptionskuservice +Location : West Europe +Sku : Consumption +Capacity : 0 +ProvisioningState : Succeeded +RuntimeUrl : https://consumptionskuservice.azure-api.net +PortalCustomHostnameConfiguration : +ProxyCustomHostnameConfiguration : {consumptionskuservice.azure-api.net} +ManagementCustomHostnameConfiguration : +ScmCustomHostnameConfiguration : +DeveloperPortalHostnameConfiguration : +SystemCertificates : +Tags : {} +AdditionalRegions : {} +SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting +Identity : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementServiceIdentity +EnableClientCertificate : True +ResourceGroupName : Api-Default-North-Europe +``` + +This command creates a consumption tier API Management service with Client Certificate enabled in west Europe. + +### Example 4: Create an API Management service and Enable TLS 1.0 protocol + +```powershell +$enableTls=@{"Tls10" = "True"} +$sslSetting = New-AzApiManagementSslSetting -FrontendProtocol $enableTls -BackendProtocol $enableTls +New-AzApiManagement -ResourceGroupName Api-Default-CentralUS -Name "testtlspowershell" -Sku Standard -Location "CentralUS" -Organization "Microsoft" -AdminEmail "bar@contoso.com" -SslSetting $sslSetting +``` + +```output +PublicIPAddresses : {23.99.140.18} +PrivateIPAddresses : +Id : /subscriptions/subid/resourceGroups/Api-Default-CentralUS/providers/Microsoft.ApiManagement/service/testtlspowershell +Name : testtlspowershell +Location : Central US +Sku : Standard +Capacity : 1 +ProvisioningState : Succeeded +RuntimeUrl : https://testtlspowershell.azure-api.net +RuntimeRegionalUrl : https://testtlspowershell-centralus-01.regional.azure-api.net +PortalUrl : https://testtlspowershell.portal.azure-api.net +ManagementApiUrl : https://testtlspowershell.management.azure-api.net +ScmUrl : https://testtlspowershell.scm.azure-api.net +PublisherEmail : bar@contoso.com +OrganizationName : Microsoft +NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com +VirtualNetwork : +VpnType : None +PortalCustomHostnameConfiguration : +ProxyCustomHostnameConfiguration : {testtlspowershell.azure-api.net} +ManagementCustomHostnameConfiguration : +ScmCustomHostnameConfiguration : +DeveloperPortalHostnameConfiguration : +SystemCertificates : +Tags : {} +AdditionalRegions : {} +SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting +Identity : +EnableClientCertificate : +ResourceGroupName : Api-Default-CentralUS +``` + +This command creates a Standard SKU Api Management service and Enable TLS 1.0 on Frontend client to ApiManagement Gateway and Backend client between ApiManagement Gateway and Backend. + +### Example 5: Create an API Management service in Availability Zones + +```powershell +New-AzApiManagement -ResourceGroupName "contoso-rg" -Name "apim-test-pshell-azs" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com" -Sku Premium -Capacity 3 -Zone @("1","2","3") +``` + +```output +PublicIPAddresses : {52.238.252.170} +PrivateIPAddresses : +Id : /subscriptions/aa7def4e-6bcd-4b28-b8d5-7613a618e753/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/apim-test-pshell-azs +Name : apim-test-pshell-azs +Location : Central US +Sku : Premium +Capacity : 3 +CreatedTimeUtc : 7/30/2021 7:47:12 PM +ProvisioningState : Succeeded +RuntimeUrl : https://apim-test-pshell-azs.azure-api.net +RuntimeRegionalUrl : https://apim-test-pshell-azs-centralus-01.regional.azure-api.net +PortalUrl : https://apim-test-pshell-azs.portal.azure-api.net +DeveloperPortalUrl : https://apim-test-pshell-azs.developer.azure-api.net +ManagementApiUrl : https://apim-test-pshell-azs.management.azure-api.net +ScmUrl : https://apim-test-pshell-azs.scm.azure-api.net +PublisherEmail : admin@contoso.com +OrganizationName : Contoso +NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com +VirtualNetwork : +VpnType : None +PortalCustomHostnameConfiguration : +ProxyCustomHostnameConfiguration : {apim-test-pshell-azs.azure-api.net} +ManagementCustomHostnameConfiguration : +ScmCustomHostnameConfiguration : +DeveloperPortalHostnameConfiguration : +SystemCertificates : +Tags : {} +AdditionalRegions : {} +SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting +Identity : +EnableClientCertificate : +Zone : {1, 2, 3} +DisableGateway : False +MinimalControlPlaneApiVersion : +ResourceGroupName : contoso-rg +``` + +This command creates a Premium SKU Api Management service in Zones + +### Example 6: Create an API Management service in Internal Mode into Virtual Network with Stv2 + +```powershell +$virtualNetwork = New-AzApiManagementVirtualNetwork -SubnetResourceId "/subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.Network/virtualNetworks/apimvnet/subnets/ps" +$publicIpAddressId = "/subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.Network/publicIPAddresses/apim-external-vnet-ipv4" +New-AzApiManagement -ResourceGroupName "contosogroup" -Location "West US2" -Name "pstestinternalvnet2" -Organization "Contoso" -AdminEmail "admin@contoso.com" -VirtualNetwork $virtualNetwork -VpnType "Internal" -Sku "Premium" -PublicIpAddressId $publicIpAddressId +``` + +```output +PublicIPAddresses : {20.99.249.73} +PrivateIPAddresses : {10.0.2.4} +Id : /subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.ApiManagement/service/pstestinternalvnet2 +Name : pstestinternalvnet2 +Location : West US 2 +Sku : Premium +Capacity : 1 +CreatedTimeUtc : 3/24/2022 11:09:57 PM +ProvisioningState : Succeeded +RuntimeUrl : https://pstestinternalvnet2.azure-api.net +RuntimeRegionalUrl : https://pstestinternalvnet2-westus2-01.regional.azure-api.net +PortalUrl : https://pstestinternalvnet2.portal.azure-api.net +DeveloperPortalUrl : https://pstestinternalvnet2.developer.azure-api.net +ManagementApiUrl : https://pstestinternalvnet2.management.azure-api.net +ScmUrl : https://pstestinternalvnet2.scm.azure-api.net +PublisherEmail : admin@contoso.com +OrganizationName : Contoso +NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com +VirtualNetwork : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork +VpnType : Internal +PortalCustomHostnameConfiguration : +ProxyCustomHostnameConfiguration : {pstestinternalvnet2.azure-api.net} +ManagementCustomHostnameConfiguration : +ScmCustomHostnameConfiguration : +DeveloperPortalHostnameConfiguration : +SystemCertificates : +Tags : {} +AdditionalRegions : {} +SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting +Identity : +EnableClientCertificate : +Zone : +DisableGateway : +MinimalControlPlaneApiVersion : +PublicIpAddressId : /subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.Network/publicIPAddresses/apim-external-vnet-ipv4 +PlatformVersion : stv2 +PublicNetworkAccess : Enabled +PrivateEndpointConnections : +ResourceGroupName : contosogroup +``` + +The cmdlet deploys the API Management service into Virtual Network using stv2 platform version. + + +### Example 7: Create an API Management service for an external virtual network for Stv1 + +```powershell +$virtualNetwork = New-AzApiManagementVirtualNetwork -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-b1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet" +New-AzApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -VirtualNetwork $virtualNetwork -VpnType "External" -Sku "Premium" +``` + +This command creates a Premium-tier API Management service in an Azure virtual network subnet having an external-facing gateway endpoint with a master region in the West US in stv1 model + + +## PARAMETERS + +### -AdditionalRegions + +Additional deployment regions of Azure API Management. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AdminEmail + +Specifies the originating email address for all notifications that the API Management system sends. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Capacity + +Specifies the SKU capacity of the Azure API Management service. +The default is one (1). + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CustomHostnameConfiguration + +Custom hostname configurations. Default value is $null. Passing $null will set the default hostname. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementCustomHostNameConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableGateway + +Flag only meant to be used for Premium SKU ApiManagement Service and Non Internal VNET deployments. This is useful in case we want to take a gateway region out of rotation. This can also be used to standup a new region in Passive mode, test it and then make it Live later. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableClientCertificate + +Flag only meant to be used for Consumption SKU ApiManagement Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +Specifies the location to create the Api Management service. +To obtain valid locations, use the cmdlet +Get-AzResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MinimalControlPlaneApiVersion + +Minimal Control Plane Apis version to allow for managing the API Management service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +Specifies a name for the API Management deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Organization + +Specifies the name of an organization. +API Management uses this address in the developer portal in email notifications. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddressId + +Standard SKU PublicIpAddress ResoureId for integration into stv2 Virtual Network Deployments + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess + +Whether or not public endpoint access is allowed for this service.Possible values include: 'Enabled', 'Disabled' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specifies the name of the of resource group under which this cmdlet creates an API Management deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku + +The tier of the Azure API Management service. +Valid values are Developer, Basic, Standard, Premium and Consumption. +The default value is Developer. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku] +Parameter Sets: (All) +Aliases: +Accepted values: Developer, Basic, Standard, Premium, Consumption + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SslSetting + +The Ssl Setting of the ApiManagement Service. Default value is $null + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SystemAssignedIdentity + +Generate and assign an Azure Active Directory Identity for this server for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemCertificateConfiguration + +Certificates issued by Internal CA to be installed on the service. Default value is $null. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSystemCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag + +Tags dictionary. + +```yaml +Type: System.Collections.Generic.Dictionary`2[System.String,System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserAssignedIdentity + +Assign User Identities to this server for use with key management services like Azure KeyVault. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetwork + +Virtual Network Configuration of master Azure API Management deployment region. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnType + +Virtual Network Type of the ApiManagement Deployment. Valid Values are + +- "None" (Default Value. ApiManagement is not part of any Virtual Network") +- "External" (ApiManagement Deployment is setup inside a Virtual Network having an Internet Facing Endpoint) +- "Internal" (ApiManagement Deployment is setup inside a Virtual Network having an Intranet Facing Endpoint) + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVpnType +Parameter Sets: (All) +Aliases: +Accepted values: None, External, Internal + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone + +A list of availability zones denoting where the api management service is deployed into. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork + +### System.Collections.Generic.Dictionary`2[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion[] + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementCustomHostNameConfiguration[] + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSystemCertificate[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement + +## NOTES + +## RELATED LINKS + +[Backup-AzApiManagement](./Backup-AzApiManagement.md) + +[Get-AzApiManagement](./Get-AzApiManagement.md) + +[Set-AzApiManagement](./Set-AzApiManagement.md) + +[Remove-AzApiManagement](./Remove-AzApiManagement.md) + +[Restore-AzApiManagement](./Restore-AzApiManagement.md) diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApi.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApi.md new file mode 100644 index 0000000000..9dcf24291a --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApi.md @@ -0,0 +1,557 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 664CF009-FC52-4F1B-933B-3DEBD05AC8C5 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementapi +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementApi.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementApi.md +--- + +# New-AzApiManagementApi + +## SYNOPSIS +Creates an API. + +## SYNTAX + +``` +New-AzApiManagementApi -Context [-ApiId ] -Name + [-Description ] -ServiceUrl -Path -Protocols + [-AuthorizationServerId ] [-AuthorizationScope ] [-OpenIdProviderId ] + [-BearerTokenSendingMethod ] [-SubscriptionKeyHeaderName ] + [-SubscriptionKeyQueryParamName ] [-ProductIds ] [-SubscriptionRequired] + [-ApiVersionDescription ] [-ApiVersionSetId ] [-ApiVersion ] [-SourceApiId ] + [-SourceApiRevision ] [-ApiType ] [-TermsOfServiceUrl ] + [-ContactName ] [-ContactUrl ] [-ContactEmail ] [-LicenseName ] + [-LicenseUrl ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementApi** cmdlet creates an Azure API Management API. + +## EXAMPLES + +### Example 1: Create an API +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementApi -Context $ApiMgmtContext -Name "Echo api" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @("http", "https") -Path "testapi" +``` + +This command creates an API named EchoApi with the specified URL. + +### Example 2: Create an API by copying all operation, Tags, Products and Policies from echo-api and into an ApiVersionSet +```powershell +$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso +$versionSet = Get-AzApiManagementApiVersionSet -Context $context -ApiVersionSetId "xmsVersionSet" +New-AzApiManagementApi -Context $context -Name "echoapiv4" -Description "Create Echo Api V4" -SubscriptionRequired -ServiceUrl "https://echoapi.cloudapp.net/v4" -Path "echov3" -Protocols @("http", "https") -ApiVersionSetId $versionSet.ApiVersionSetId -SourceApiId "echo-api" -ApiVersion "v4" +``` + +```output +ApiId : 691b7d410125414a929c108541c60e06 +Name : echoapiv4 +Description : Create Echo Api V4 +ServiceUrl : https://echoapi.cloudapp.net/v4 +Path : echov3 +ApiType : http +Protocols : {Http, Https} +AuthorizationServerId : +AuthorizationScope : +OpenidProviderId : +BearerTokenSendingMethod : {} +SubscriptionKeyHeaderName : Ocp-Apim-Subscription-Key +SubscriptionKeyQueryParamName : subscription-key +ApiRevision : 1 +ApiVersion : v4 +IsCurrent : True +IsOnline : False +SubscriptionRequired : True +ApiRevisionDescription : +ApiVersionSetDescription : +ApiVersionSetId : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apiVersionSets/xmsVersionSet +Id : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apis/691b7d410125414a929c108541c60e06 +ResourceGroupName : Api-Default-West-US +ServiceName : contoso +``` + +This command creates an API `echoapiv3` in ApiVersionSet `xmsVersionSet` and copies all operation, Tags and Policies from source Api `echo-api`. It overrides the SubscriptionRequired, ServiceUrl, Path, Protocols + +### Example 3 + +Creates an API. (autogenerated) + + +```powershell +New-AzApiManagementApi -ApiId '0001' -Context -Name 'Echo api' -Path 'echov3' -Protocols Http -ServiceUrl 'https://contoso.com/apis/echo' +``` + +## PARAMETERS + +### -ApiId +Specifies the ID of the API to create. +If you do not specify this parameter, this cmdlet generates an ID for you. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiType +Type of API to create (http, soap, websocket, graphql). This parameter is optional. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiType] +Parameter Sets: (All) +Aliases: +Accepted values: Http, Soap, WebSocket, GraphQL + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiVersion +Api Version of the Api to create. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiVersionDescription +Api Version Description. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiVersionSetId +A resource identifier for the related Api Version Set. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuthorizationScope +Specifies the OAuth operations scope. +The default value is $Null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuthorizationServerId +Specifies the OAuth authorization server ID. +The default value is $Null. +You must specify this parameter if *AuthorizationScope* is specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BearerTokenSendingMethod +OpenId authorization server mechanism by which access token is passed to the API. Refer to https://datatracker.ietf.org/doc/html/rfc6749#section-4. This parameter is optional. Default value is $null. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContactEmail +The email address of the contact person/organization. MUST be in the format of an email address. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContactName +The identifying name of the contact person/organization. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContactUrl +The URL pointing to the contact information. MUST be in the format of a URL. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the web API. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LicenseName +The license name used for the API. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LicenseUrl +A URL to the Terms of Service for the API. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the web API. +This is the public name of the API as it appears on the developer and admin portals. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OpenIdProviderId +OpenId authorization server identifier. This parameter is optional. Default value is $null. Must be specified if BearerTokenSendingMethods is specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the web API path, which is the last part of the API's public URL and corresponds to the Web API URL suffix field in the admin portal. +This URL is used by API consumers to send requests to the web service, and must be one to 400 characters long. +The default value is $Null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductIds +Specifies an array of product IDs to which to add the new API. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocols +Specifies an array of web API protocols. +Valid values are http, https. +These are the web protocols over which the API is made available. +The default value is $Null. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[] +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https, Ws, Wss + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceUrl +Specifies the URL of the web service that exposes the API. +This URL is used only by Azure API Management, and is not made public. +The URL must be one to 2000 characters long. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceApiId +Api identifier of the source API. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceApiRevision +Api Revision of the source API. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionKeyHeaderName +Specifies the subscription key header name. +The default value is $Null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionKeyQueryParamName +Specifies the subscription key query string parameter name. +The default value is $Null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionRequired +Flag to enforce SubscriptionRequired for requests to the Api. This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TermsOfServiceUrl +A URL to the Terms of Service for the API. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[] + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi + +## NOTES + +## RELATED LINKS + +[Export-AzApiManagementApi](./Export-AzApiManagementApi.md) + +[Get-AzApiManagementApi](./Get-AzApiManagementApi.md) + +[Import-AzApiManagementApi](./Import-AzApiManagementApi.md) + +[Remove-AzApiManagementApi](./Remove-AzApiManagementApi.md) + +[Set-AzApiManagementApi](./Set-AzApiManagementApi.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApiRelease.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApiRelease.md new file mode 100644 index 0000000000..b346897193 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApiRelease.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementapirelease +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementApiRelease.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementApiRelease.md +--- + +# New-AzApiManagementApiRelease + +## SYNOPSIS +Creates an API Release of an API Revision + +## SYNTAX + +``` +New-AzApiManagementApiRelease -Context -ApiId -ApiRevision + [-ReleaseId ] [-Note ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The **New-AzApiManagementApiRelease** cmdlet creates an API Release for an API Revision in API Management context. A Release is used to make the Api Revision as Current Revision. + +## EXAMPLES + +### Example 1: Create an API Release for an API Revision +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementApiRelease -Context $context -ApiId 5adf6fbf0faadf3ad8558065 -ApiRevision 6 -Note "Releasing version 6" +``` + +```output +ReleaseId : 7e4d3fbb43c146c4bf406499ef9411f4 +ApiId : 5adf6fbf0faadf3ad8558065 +CreatedDateTime : 5/17/2018 1:16:29 AM +UpdatedDateTime : 5/17/2018 1:16:29 AM +Notes : Releasing version 6 +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Mi + crosoft.ApiManagement/service/contoso/apis/5adf6fbf0faadf3ad8558065/releases/7e4d3fbb43c146c4bf40649 + 9ef9411f4 +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso +``` + +This command creates an API Release of Revision `2` of the `echo-api`. + +## PARAMETERS + +### -ApiId +Identifier for new API. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Identifier for the Api Revision. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +Api Release Notes. This parameter is optional + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReleaseId +Identifier for the Api Release. +This parameter is optional. +If not specified identifier will be generated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementApiRelease](./Get-AzApiManagementApiRelease.md) + +[Remove-AzApiManagementApiRelease](./Remove-AzApiManagementApiRelease.md) + +[Update-AzApiManagementApiRelease](./Update-AzApiManagementApiRelease.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApiRevision.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApiRevision.md new file mode 100644 index 0000000000..1141ed0a37 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApiRevision.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementapirevision +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementApiRevision.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementApiRevision.md +--- + +# New-AzApiManagementApiRevision + +## SYNOPSIS +Creates a new Revision of an Existing API. + +## SYNTAX + +``` +New-AzApiManagementApiRevision -Context -ApiId -ApiRevision + [-ApiRevisionDescription ] [-SourceApiRevision ] [-ServiceUrl ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The **New-AzApiManagementApiRevision** cmdlet creates an API Revision for an existing an API in API Management context. + +## EXAMPLES + +### Example 1: Create an empty API Revision for an API +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementApiRevision -Context $context -ApiId "echo-api" -ApiRevision "5" + + +New-AzApiManagementApiRevision -Context $context -ApiId "echo-api" -ApiRevision "5" +``` + +This command creates an API Revision `5` of the `echo-api` API. + +### Example 2: Create an API Revision from an Existing Api and copy All operations, tags and Policies +```powershell +$context = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementApiRevision -Context $context -ApiId "echo-api" -ApiRevision "5" -SourceApiRevision "1" -ServiceUrl "https://echoapi.cloudapp.net/rev4" +``` + +```output +ApiId : echo-api;rev=5 +Name : Echo API +Description : +ServiceUrl : http://echoapi.cloudapp.net/api +Path : echo +ApiType : http +Protocols : {Https} +AuthorizationServerId : +AuthorizationScope : +SubscriptionKeyHeaderName : Ocp-Apim-Subscription-Key +SubscriptionKeyQueryParamName : subscription-key +ApiRevision : 5 +ApiVersion : +IsCurrent : False +IsOnline : False +SubscriptionRequired : True +ApiRevisionDescription : +ApiVersionSetDescription : +ApiVersionSetId : +Id : /subscriptions/subid/resourceGroups/apimService1/providers/Microsoft.ApiManagement/service/sdktestapim4163/apis/echo-api;rev=5 +ResourceGroupName : apimService1 +ServiceName : sdktestapim4163 +``` + +This command creates an API Revision `5` of the `echo-api` API. + +## PARAMETERS + +### -ApiId +Identifier for API whose Revision is to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Revision Identifier of the Api. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevisionDescription +Api Revision Description. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceUrl +A URL of the web service exposing the API in the Backend service. This URL will be used by Azure API Management only, and will not be made public. Must be 1 to 2000 characters long. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceApiRevision +Api Revision identifier of the source API. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementApi](./Get-AzApiManagementApi.md) + +[Remove-AzApiManagementApi](./Remove-AzApiManagementApi.md) + +[Set-AzApiManagementApi](./Set-AzApiManagementApi.md) diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApiSchema.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApiSchema.md new file mode 100644 index 0000000000..37bfa03960 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApiSchema.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementapischema +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementApiSchema.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementApiSchema.md +--- + +# New-AzApiManagementApiSchema + +## SYNOPSIS +Creates the new API Schema in the ApiManagement service + +## SYNTAX + +### SchemaDocumentInline (Default) +``` +New-AzApiManagementApiSchema -Context -ApiId [-SchemaId ] + -SchemaDocumentContentType -SchemaDocument [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### SchemaDocumentFromFile +``` +New-AzApiManagementApiSchema -Context -ApiId [-SchemaId ] + -SchemaDocumentContentType -SchemaDocumentFilePath + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates the new API Schema of the API. + +## EXAMPLES + +### Example 1: Create new Schema for Swagger Petstore Extensive API +```powershell +$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.ApiManagement/service/sdktestapim4163 +New-AzApiManagementApiSchema -Context $context -ApiId swagger-petstore-extensive -SchemaDocumentContentType swaggerdefinition -SchemaDocumentFilePath C:\Users\sasolank\Downloads\petstoreschema.json +``` + +```output +Schema Id Api Id Schema ContentType +--------- ------ ------------------ +3e8892eb-98e4-408d-b77a-f424185c1044 swagger-petstore-extensive swaggerdefinition +``` + +The cmdlet **New-AzApiManagementApiSchema** creates or updates the schema of the `swagger-petstore-extensive` aPI. + +## PARAMETERS + +### -ApiId +Identifier of api. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchemaDocument +Api schema document as a string. This parameter is required is -SchemaDocumentFile is not specified. + +```yaml +Type: System.String +Parameter Sets: SchemaDocumentInline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaDocumentContentType +ContentType of the api Schema. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaDocumentFilePath +Api schema document file path. This parameter is required is -SchemaDocument is not specified. + +```yaml +Type: System.String +Parameter Sets: SchemaDocumentFromFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaId +Identifier of new schema. +This parameter is optional. +If not specified will be generated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiSchema + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementApiSchema](./Get-AzApiManagementApiSchema.md) + +[Remove-AzApiManagementApiSchema](./Remove-AzApiManagementApiSchema.md) + +[Set-AzApiManagementApiSchema](./Set-AzApiManagementApiSchema.md) diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApiVersionSet.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApiVersionSet.md new file mode 100644 index 0000000000..7bdb95b744 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementApiVersionSet.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementapiversionset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementApiVersionSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementApiVersionSet.md +--- + +# New-AzApiManagementApiVersionSet + +## SYNOPSIS +Creates an API Version Set. + +## SYNTAX + +``` +New-AzApiManagementApiVersionSet -Context [-ApiVersionSetId ] -Name + -Scheme [-HeaderName ] [-QueryName ] [-Description ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **New-AzApiManagementApiVersionSet** cmdlet creates an API Version set entity in the Azure API Management context. + +## EXAMPLES + +### Example 1 +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementApiVersionSet -Context $ApiMgmtContext -Name "newversion" -Scheme Header -HeaderName "x-ms-version" -Description "version by xmsversion" +``` + +```output +ApiVersionSetId : ea9a87cd-a699-4a75-bf7d-909846b91268 +Description : version by xmsversion +VersionQueryName : +VersionHeaderName : x-ms-version +DisplayName : newversion +VersioningScheme : Header +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/api-version-sets/ea9a87cd-a699-4a75-bf7d-909846b91268 +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso +``` + +This command creates an API Version Set which versioning scheme `Query` and Query parameter `api-version`. + +## PARAMETERS + +### -ApiVersionSetId +Identifier for new API Version Set. +This parameter is optional. +If not specified an identifier will be generated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the Api Version set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HeaderName +The Header value which will contain the versioning information. +If versioning Scheme HEADER is chosen, then this value must be specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the ApiVersion Set. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -QueryName +The Query value which will contain the versioning information. +If versioning Scheme Query is chosen, then this value must be specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scheme +Versioning Scheme to select for the Api Versioning Set. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementVersioningScheme +Parameter Sets: (All) +Aliases: +Accepted values: Segment, Query, Header + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementVersioningScheme + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementApiVersionSet](./Get-AzApiManagementApiVersionSet.md) + +[Remove-AzApiManagementApiVersionSet](./Remove-AzApiManagementApiVersionSet.md) + +[Set-AzApiManagementApiVersionSet](./Set-AzApiManagementApiVersionSet.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementAuthorizationServer.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementAuthorizationServer.md new file mode 100644 index 0000000000..e625d772c4 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementAuthorizationServer.md @@ -0,0 +1,381 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 45B96AB0-ACE3-4754-B162-88027AC8CA41 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementauthorizationserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementAuthorizationServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementAuthorizationServer.md +--- + +# New-AzApiManagementAuthorizationServer + +## SYNOPSIS +Creates an authorization server. + +## SYNTAX + +``` +New-AzApiManagementAuthorizationServer -Context [-ServerId ] -Name + [-Description ] -ClientRegistrationPageUrl -AuthorizationEndpointUrl + -TokenEndpointUrl -ClientId [-ClientSecret ] + [-AuthorizationRequestMethods ] + -GrantTypes + -ClientAuthenticationMethods [-TokenBodyParameters ] + [-SupportState ] [-DefaultScope ] + -AccessTokenSendingMethods [-ResourceOwnerUsername ] + [-ResourceOwnerPassword ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementAuthorizationServer** cmdlet creates an Azure API Management authorization server. + +## EXAMPLES + +### Example 1: Create an authorization server +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementAuthorizationServer -Context $ApiMgmtContext -Name "Contoso OAuth2 server" -ClientRegistrationPageUrl "https://contoso/signup" -AuthorizationEndpointUrl "https://contoso/auth" -TokenEndpointUrl "https://contoso/token" -ClientId "clientid" -ClientSecret "e041ed1b660b4eadbad5a29d066e6e88" -AuthorizationRequestMethods @('Get', 'Post') -GrantTypes @( 'AuthorizationCode', 'Implicit', 'ResourceOwnerPassword', 'ClientCredentials') -ClientAuthenticationMethods @('Basic') -TokenBodyParameters @{'par1'='val1'; 'par2'='val2'} -AccessTokenSendingMethods @('AuthorizationHeader', 'Query') -ResourceOwnerUsername "ivan" -ResourceOwnerPassword "qwerty" +``` + +This command creates an authorization server. + +### Example 2 + +Creates an authorization server. (autogenerated) + + +```powershell +New-AzApiManagementAuthorizationServer -AccessTokenSendingMethods AuthorizationHeader -AuthorizationEndpointUrl 'https://contoso/auth' -AuthorizationRequestMethods Get -ClientAuthenticationMethods Basic -ClientId 'clientid' -ClientRegistrationPageUrl 'https://contoso/signup' -ClientSecret '0000000000000000000000000000000000000' -Context -GrantTypes AuthorizationCode -Name 'Contoso OAuth2 server' -ServerId '0123456789' -TokenBodyParameters @{'par1'='val1'} -TokenEndpointUrl 'https://contoso/token' +``` + +## PARAMETERS + +### -AccessTokenSendingMethods +Specifies an array of methods to send an access token. +psdx_paramvalues AuthorizationHeader and Query. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessTokenSendingMethod[] +Parameter Sets: (All) +Aliases: +Accepted values: AuthorizationHeader, Query + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuthorizationEndpointUrl +Specifies the authorization endpoint to authenticate resource owners and obtain authorization grants. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuthorizationRequestMethods +Specifies an array of authorization request methods. +Valid values are: GET, POST. +The default value is GET. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAuthorizationRequestMethod[] +Parameter Sets: (All) +Aliases: +Accepted values: Get, Post, Head, Options, Trace, Put, Patch, Delete + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientAuthenticationMethods +Specifies an array of client authentication methods. +psdx_paramvalues Basic and Body. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementClientAuthenticationMethod[] +Parameter Sets: (All) +Aliases: +Accepted values: Basic, Body + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientId +Specifies the client ID of the developer console that is the client application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientRegistrationPageUrl +Specifies the client registration endpoint to register clients with the authorization server and obtain client credentials. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientSecret +Specifies the client secret of developer console that is the client application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultScope +Specifies the default scope for the authorization server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +Specifies a description for an authorization server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GrantTypes +Specifies an array of grant types. +psdx_paramvalues +- AuthorizationCode +- ClientCredentials +- Implicit +- ResourceOwnerPassword + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGrantType[] +Parameter Sets: (All) +Aliases: +Accepted values: AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the authorization server to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceOwnerPassword +Specifies the resource owner password. +You must specify this parameter is required if ResourceOwnerPassword is specified by the *GrantTypes* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceOwnerUsername +Specifies the resource owner user name. +You must specify this parameter if ResourceOwnerPassword is specified by the *GrantTypes* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerId +Specifies the ID of the authorization server to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SupportState +Indicates whether to support the *State* parameter. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TokenBodyParameters +Specifies additional body parameters using **application/x-www-form-urlencoded** format. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TokenEndpointUrl +Specifies the token endpoint URL that is used by clients to obtain access tokens in exchange for presenting authorization grants or refresh tokens. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAuthorizationRequestMethod[] + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGrantType[] + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementClientAuthenticationMethod[] + +### System.Collections.Hashtable + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessTokenSendingMethod[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthorizationServer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementBackend.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementBackend.md new file mode 100644 index 0000000000..9bb4c93aa5 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementBackend.md @@ -0,0 +1,316 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementbackend +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementBackend.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementBackend.md +--- + +# New-AzApiManagementBackend + +## SYNOPSIS +Creates a new backend entity. + +## SYNTAX + +``` +New-AzApiManagementBackend -Context [-BackendId ] -Protocol + -Url [-ResourceId ] [-Title ] [-Description ] + [-SkipCertificateChainValidation ] [-SkipCertificateNameValidation ] + [-Credential ] [-Proxy ] + [-ServiceFabricCluster ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Creates a new backend entity in Api Management. + +## EXAMPLES + +### Example 1: Create Backend 123 with a Basic Authorization Scheme +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$credential = New-AzApiManagementBackendCredential -AuthorizationHeaderScheme basic -AuthorizationHeaderParameter opensesame -Query @{"sv" = @('xx', 'bb'); "sr" = @('cc')} -Header @{"x-my-1" = @('val1', 'val2')} + +$backend = New-AzApiManagementBackend -Context $apimContext -BackendId 123 -Url 'https://contoso.com/awesomeapi' -Protocol http -Title "first backend" -SkipCertificateChainValidation $true -Credential $credential -Description "my backend" +``` + +Creates a new Backend + +## PARAMETERS + +### -BackendId +Identifier of new backend. +This parameter is optional. +If not specified will be generated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Credential +Credential details which should be used when talking to the Backend. +This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Backend Description. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocol +Backend Communication protocol. +This parameter is required. +Valid values are 'http' and 'soap'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: http, soap + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Proxy +Proxy Server details to be used while sending request to the Backend. +This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendProxy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Management Uri of the Resource in External System. +The absolute http URL of the Azure Resource. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceFabricCluster +Service Fabric Cluster Backend details. This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementServiceFabric +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipCertificateChainValidation +Whether to Skip Certificate Chain Validation when talking to the Backend. +This parameter is optional. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipCertificateNameValidation +Whether to skip Certificate Name Validation when talking to the Backend. +This parameter is optional. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Title +Backend Title. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Url +Runtime Url for the Backend. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendCredential + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendProxy + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementServiceFabric + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementBackend](./Get-AzApiManagementBackend.md) + +[New-AzApiManagementBackendCredential](./New-AzApiManagementBackendCredential.md) + +[New-AzApiManagementBackendProxy](./New-AzApiManagementBackendProxy.md) + +[Set-AzApiManagementBackend](./Set-AzApiManagementBackend.md) + +[Remove-AzApiManagementBackend](./Remove-AzApiManagementBackend.md) + diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementBackendCredential.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementBackendCredential.md new file mode 100644 index 0000000000..21317d6368 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementBackendCredential.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementbackendcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementBackendCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementBackendCredential.md +--- + +# New-AzApiManagementBackendCredential + +## SYNOPSIS +Creates a new Backend Credential contract. + +## SYNTAX + +``` +New-AzApiManagementBackendCredential [-CertificateThumbprint ] [-CertificateId ] + [-Query ] [-Header ] [-AuthorizationHeaderScheme ] + [-AuthorizationHeaderParameter ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Creates a new Backend Credential contract. + +## EXAMPLES + +### Example 1: Create a Backend Credentials In-Memory Object +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$credential = New-AzApiManagementBackendCredential -AuthorizationHeaderScheme basic -AuthorizationHeaderParameter opensesame -Query @{"sv" = @('xx', 'bb'); "sr" = @('cc')} -Header @{"x-my-1" = @('val1', 'val2')} + +$backend = New-AzApiManagementBackend -Context $apimContext -BackendId 123 -Url 'https://contoso.com/awesomeapi' -Protocol http -Title "first backend" -SkipCertificateChainValidation $true -Credential $credential -Description "my backend" +``` + +Creates a Backend Credentials Contract + +## PARAMETERS + +### -AuthorizationHeaderParameter +Authorization Header used for the Backend. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizationHeaderScheme +Authorization Scheme used for the Backend. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateId +Client Certificate Id. This parameter is optional. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateThumbprint +Client Certificate Thumbprints. +This parameter is optional. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Header +Header Parameter Values accepted by Backend. +This parameter is optional. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Query Parameter Values accepted by Backend. +This parameter is optional. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendCredential + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementBackend](./Get-AzApiManagementBackend.md) + +[New-AzApiManagementBackend](./New-AzApiManagementBackend.md) + +[New-AzApiManagementBackendProxy](./New-AzApiManagementBackendProxy.md) + +[Set-AzApiManagementBackend](./Set-AzApiManagementBackend.md) + +[Remove-AzApiManagementBackend](./Remove-AzApiManagementBackend.md) diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementBackendProxy.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementBackendProxy.md new file mode 100644 index 0000000000..212bd85cab --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementBackendProxy.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementbackendproxy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementBackendProxy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementBackendProxy.md +--- + +# New-AzApiManagementBackendProxy + +## SYNOPSIS +Creates a new Backend Proxy Object. + +## SYNTAX + +``` +New-AzApiManagementBackendProxy -Url [-ProxyCredential ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Creates a new Backend Proxy Object which can be piped when creating a new Backend entity. + +## EXAMPLES + +### Example 1: Create a Backend Proxy In-Memory Object +```powershell +$secpassword = ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force +$proxyCreds = New-Object System.Management.Automation.PSCredential ("foo", $secpassword) +$credential = New-AzApiManagementBackendProxy -Url "http://12.168.1.1:8080" -ProxyCredential $proxyCreds + +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" + +$backend = New-AzApiManagementBackend -Context $apimContext -BackendId 123 -Url 'https://contoso.com/awesomeapi' -Protocol http -Title "first backend" -SkipCertificateChainValidation $true -Proxy $credential -Description "backend with proxy server" +``` + +Creates a Backend Proxy Object and sets up Backend + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials used to connect to Backend Proxy. This parameter is optional. + +```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 +``` + +### -Url +Url of the Proxy server to be used when forwarding calls to Backend. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendProxy + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementBackend](./Get-AzApiManagementBackend.md) + +[New-AzApiManagementBackend](./New-AzApiManagementBackend.md) + +[New-AzApiManagementBackendCredential](./New-AzApiManagementBackendCredential.md) + +[Set-AzApiManagementBackend](./Set-AzApiManagementBackend.md) + +[Remove-AzApiManagementBackend](./Remove-AzApiManagementBackend.md) diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementBackendServiceFabric.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementBackendServiceFabric.md new file mode 100644 index 0000000000..b434b16ae1 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementBackendServiceFabric.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementbackendservicefabric +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementBackendServiceFabric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementBackendServiceFabric.md +--- + +# New-AzApiManagementBackendServiceFabric + +## SYNOPSIS +Creates an object of `PsApiManagementServiceFabric` + +## SYNTAX + +``` +New-AzApiManagementBackendServiceFabric -ManagementEndpoint [-ClientCertificateThumbprint ] + [-ClientCertificateId ] [-MaxPartitionResolutionRetry ] [-ServerX509Name ] + [-ServerCertificateThumbprint ] [-DefaultProfile ] [] +``` + +## DESCRIPTION + +The **New-AzApiManagementBackendServiceFabric** cmdlet creates an object of `PsApiManagementServiceFabric` to be used in cmdlet +**New-AzApiManagementBackend** and **Set-AzApiManagementBackend**. + +## EXAMPLES + +### Example 1: Create a Backend Service Fabric In-Memory Object +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$ManagementEndpoints = 'https://sfbackend-01.net:443', 'https://sfbackend-02.net:443' +$ServerCertificateThumbprints = '33CC47C6FCA848DC9B14A6F071C1EF7C' +$serviceFabric = New-AzApiManagementBackendServiceFabric -ManagementEndpoint $ManagementEndpoints -ClientCertificateThumbprint "33CC47C6FCA848DC9B14A6F071C1EF7C" -ServerX509Name @{"CN=foobar.net" = @('33CC47C6FCA848DC9B14A6F071C1EF7C'); } -ServerCertificateThumbprint $ServerCertificateThumbprints + +$backend = New-AzApiManagementBackend -Context $apimContext -BackendId 123 -Url 'https://contoso.com/awesomeapi' -Protocol http -ServiceFabricCluster $serviceFabric -Description "service fabric backend" +``` + +Creates a Backend Service Fabric Contract + +## PARAMETERS + +### -ClientCertificateId +Client Certificate Id for the management endpoint. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientCertificateThumbprint +Client Certificate Thumbprint for the management endpoint. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementEndpoint +Service Fabric Cluster management Endpoints. +This parameter is required. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPartitionResolutionRetry +Maximum number of retries when resolving a Service Fabric partition. +This parameter is optional and default value is 5. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerCertificateThumbprint +Thumbprint of certificates cluster management service uses for tls communication.This parameter is optional. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerX509Name +Server X509 Certificate Names Collection. +This parameter is optional. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementServiceFabric + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementBackend](./Get-AzApiManagementBackend.md) + +[New-AzApiManagementBackend](./New-AzApiManagementBackend.md) + +[New-AzApiManagementBackendProxy](./New-AzApiManagementBackendProxy.md) + +[Set-AzApiManagementBackend](./Set-AzApiManagementBackend.md) + +[Remove-AzApiManagementBackend](./Remove-AzApiManagementBackend.md) diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementCache.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementCache.md new file mode 100644 index 0000000000..a19aa8b7dd --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementCache.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementcache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementCache.md +--- + +# New-AzApiManagementCache + +## SYNOPSIS +Creates a new Cache entity + +## SYNTAX + +``` +New-AzApiManagementCache -Context [-CacheId ] -ConnectionString + [-AzureRedisResourceId ] [-Description ] [-UseFromLocation ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The cmdlet **New-AzApiManagementCache** creates a new cache entity in Api Management service. + +## EXAMPLES + +### Example 1 : Create a new Cache entity +```powershell +New-AzApiManagementCache -Context $context -ConnectionString "teamdemo.redis.cache.windows.net:6380,password=xxxxxx+xxxxx=,ssl=True,abortConnect=False" -Description "Team Cache" +``` + +```output +CacheId : centralus +Description : Team Cache +ConnectionString : {{5cc19889e6ed3b0524c3f7d3}} +ResourceId : +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsof + t.ApiManagement/service/contoso/caches/centralus +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso +``` + +The cmdlets creates a new cache entity in the master location of the Api Management service. + +## PARAMETERS + +### -AzureRedisResourceId +Arm ResourceId of the Azure Redis Cache instance. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CacheId +Identifier of new cache. +This parameter is optional. +If not specified will be generated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConnectionString +Redis Connection String. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Cache Description. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UseFromLocation +Cache UseFromLocation. This parameter is optional, default value 'default'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCache + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementCache](./Get-AzApiManagementCache.md) + +[Remove-AzApiManagementCache](./Remove-AzApiManagementCache.md) + +[Update-AzApiManagementCache](./Update-AzApiManagementCache.md) diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementCertificate.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementCertificate.md new file mode 100644 index 0000000000..3f20d65b03 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementCertificate.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 5CBEDFF8-C441-44CC-B011-5F5AAFA2E5C6 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementCertificate.md +--- + +# New-AzApiManagementCertificate + +## SYNOPSIS +Creates an API Management certificate to be used during Authentication with Backend. + +## SYNTAX + +### LoadFromFile (Default) +``` +New-AzApiManagementCertificate -Context [-CertificateId ] + [-PfxFilePath ] [-PfxPassword ] [-KeyVault ] + [-DefaultProfile ] [] +``` + +### Raw +``` +New-AzApiManagementCertificate -Context [-CertificateId ] [-PfxBytes ] + [-PfxPassword ] [-KeyVault ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **New-AzApiManagementCertificate** cmdlet creates an Azure API Management certificate. + +## EXAMPLES + +### Example 1: Create and upload a certificate +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementCertificate -Context $ApiMgmtContext -PfxFilePath "C:\contoso\certificates\apimanagement.pfx" -PfxPassword "1111" +``` + +This command uploads a certificate to Api Management. This certificate can be used for mutual authentication with backend using policies. + +### Example 2 + +Creates an API Management certificate to be used during Authentication with Backend. (autogenerated) + + +```powershell +New-AzApiManagementCertificate -CertificateId '0123456789' -Context -PfxFilePath 'C:\contoso\certificates\apimanagement.pfx' -PfxPassword '1111' +``` + +### Example 3 : Create a keyVault Certificate +```powershell +$secretIdentifier = 'https://contoso.vault.azure.net/secrets/xxxx' +$keyvault = New-AzApiManagementKeyVaultObject -SecretIdentifier $secretIdentifier +$keyVaultcert = New-AzApiManagementCertificate -Context $context -CertificateId $kvcertId -KeyVault $keyvault +``` + +The first command creates a keyvault. +The second command creates a certificate using secret from this keyvault. + +## PARAMETERS + +### -CertificateId +Specifies the ID of the certificate to create. +If you do not specify this parameter, an ID is generated for you. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVault +KeyVault used to fetch certificate data.This parameter is required if -PfxFilePath not specified. +See New-AzApiManagementKeyVaultObject for details. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementKeyVaultEntity +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PfxBytes +Specifies an array of bytes of the certificate file in .pfx format. +This parameter is required if you do not specify the *PfxFilePath* parameter. + +```yaml +Type: System.Byte[] +Parameter Sets: Raw +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PfxFilePath +Specifies the path to the certificate file in .pfx format to create and upload. +This parameter is required if you do not specify the *PfxBytes* parameter. + +```yaml +Type: System.String +Parameter Sets: LoadFromFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PfxPassword +Specifies the password for the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Byte[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementCertificate](./Get-AzApiManagementCertificate.md) + +[Remove-AzApiManagementCertificate](./Remove-AzApiManagementCertificate.md) + +[Set-AzApiManagementCertificate](./Set-AzApiManagementCertificate.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementContext.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementContext.md new file mode 100644 index 0000000000..1972f5bb3a --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementContext.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 15634C76-6B34-4E2B-9354-86155827F200 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementcontext +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementContext.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementContext.md +--- + +# New-AzApiManagementContext + +## SYNOPSIS +Creates an instance of PsAzureApiManagementContext. + +## SYNTAX + +### ContextParameterSet (Default) +``` +New-AzApiManagementContext -ResourceGroupName -ServiceName + [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +New-AzApiManagementContext -ResourceId [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementContext** cmdlet creates an instance of **PsAzureApiManagementContext**. +The context is used for all of the API Management service cmdlets. + +## EXAMPLES + +### Example 1: Create a PsApiManagementContext instance +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "ContosoResources" -ServiceName "Contoso" +``` + +This command creates an instance of **PsApiManagementContext**. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group under which an API Management service is deployed. + +```yaml +Type: System.String +Parameter Sets: ContextParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm Resource Identifier of a ApiManagement service. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +Specifies the name of the deployed API Management service. + +```yaml +Type: System.String +Parameter Sets: ContextParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementCustomHostnameConfiguration.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementCustomHostnameConfiguration.md new file mode 100644 index 0000000000..35f0e6a35d --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementCustomHostnameConfiguration.md @@ -0,0 +1,259 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementcustomhostnameconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementCustomHostnameConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementCustomHostnameConfiguration.md +--- + +# New-AzApiManagementCustomHostnameConfiguration + +## SYNOPSIS +Creates an instance of `PsApiManagementCustomHostNameConfiguration`. + +## SYNTAX + +### NoChangeCertificate (Default) +``` +New-AzApiManagementCustomHostnameConfiguration -Hostname -HostnameType + -HostNameCertificateInformation [-DefaultSslBinding] + [-NegotiateClientCertificate] [-DefaultProfile ] [] +``` + +### SslCertificateFromFile +``` +New-AzApiManagementCustomHostnameConfiguration -Hostname -HostnameType + -PfxPath [-PfxPassword ] [-DefaultSslBinding] [-NegotiateClientCertificate] + [-DefaultProfile ] [] +``` + +### SslCertificateFromKeyVault +``` +New-AzApiManagementCustomHostnameConfiguration -Hostname -HostnameType + -KeyVaultId [-IdentityClientId ] [-DefaultSslBinding] [-NegotiateClientCertificate] + [-DefaultProfile ] [] +``` + +### SslCertificateManaged +``` +New-AzApiManagementCustomHostnameConfiguration -Hostname -HostnameType + [-DefaultSslBinding] [-NegotiateClientCertificate] [-ManagedCertificate] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementCustomHostnameConfiguration** cmdlet is a helper command that creates an instance of **PsApiManagementCustomHostNameConfiguration**. +This command is used with the New-AzApiManagement and Set-AzApiManagement cmdlet. + +## EXAMPLES + +### Example 1: Create and initialize an instance of PsApiManagementCustomHostNameConfiguration using an Ssl Certificate from file +```powershell +$portal = New-AzApiManagementCustomHostnameConfiguration -Hostname "portal.contoso.com" -HostnameType Portal -PfxPath "C:\contoso\certificates\apimanagement.pfx" -PfxPassword "1111" -DefaultSslBinding +$customConfig = @($portal) +New-AzApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -CustomHostnameConfiguration $customConfig +``` + +This command creates and initializes an instance of **PsApiManagementCustomHostNameConfiguration** for Portal. Then it creates a new ApiManagement service with custom hostname configuration. + +### Example 2: Create and initialize an instance of PsApiManagementCustomHostNameConfiguration using an Secret from KeyVault Resource +```powershell +$portal = New-AzApiManagementCustomHostnameConfiguration -Hostname "portal.contoso.com" -HostnameType Portal -KeyVaultId "https://apim-test-keyvault.vault.azure.net/secrets/api-portal-custom-ssl.pfx" + +$customConfig = @($portal) +New-AzApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -CustomHostnameConfiguration $customConfig -SystemAssignedIdentity +``` + +This command creates and initializes an instance of **PsApiManagementCustomHostNameConfiguration**. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSslBinding +Determines whether the value is a secret and should be encrypted or not. +This parameter is optional. +Default Value is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Hostname +Custom Hostname + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostNameCertificateInformation +Existing Certificate Configuration. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementCertificateInformation +Parameter Sets: NoChangeCertificate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HostnameType +Hostname Type + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementHostnameType +Parameter Sets: (All) +Aliases: +Accepted values: Proxy, Portal, Management, Scm, DeveloperPortal, Configuration, Data + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityClientId +User-Assigned Managed Identity ClientId used to authenticate to KeyVault to fetch Custom SSL Certificate. + +```yaml +Type: System.String +Parameter Sets: SslCertificateFromKeyVault +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultId +KeyVaultId to the secret storing the Custom SSL Certificate. + +```yaml +Type: System.String +Parameter Sets: SslCertificateFromKeyVault +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedCertificate +Determines whether we want to provision a managed certificate whose rotation is managed by the platform + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SslCertificateManaged +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NegotiateClientCertificate +Determines whether the value is a secret and should be encrypted or not. +This parameter is optional. +Default Value is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PfxPassword +Password for the .pfx certificate file. + +```yaml +Type: System.Security.SecureString +Parameter Sets: SslCertificateFromFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PfxPath +Path to a .pfx certificate file. + +```yaml +Type: System.String +Parameter Sets: SslCertificateFromFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementCertificateInformation + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementCustomHostNameConfiguration + +## NOTES + +## RELATED LINKS + +[New-AzApiManagement](./New-AzApiManagement.md) + +[Set-AzApiManagement](./Set-AzApiManagement.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementDiagnostic.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementDiagnostic.md new file mode 100644 index 0000000000..c8be282c39 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementDiagnostic.md @@ -0,0 +1,284 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementdiagnostic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementDiagnostic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementDiagnostic.md +--- + +# New-AzApiManagementDiagnostic + +## SYNOPSIS +Creates a new diagnostics at the Global scope or Api Scope. + +## SYNTAX + +``` +New-AzApiManagementDiagnostic -Context -LoggerId [-DiagnosticId ] + [-AlwaysLog ] [-ApiId ] [-SamplingSetting ] + [-FrontEndSetting ] + [-BackendSetting ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The cmdlet **New-AzApiManagementDiagnostic** creates a diagnostic entity either at Global scope or specific Api scope. + +## EXAMPLES + +### Example 1: Create a new Global scope Diagnostic +```powershell +$context = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$logger = Get-AzApiManagementLogger -Context $context -LoggerId "backendapisachinc" +$samplingsetting = New-AzApiManagementSamplingSetting -SamplingType fixed -SamplingPercentage 100 +New-AzApiManagementDiagnostic -LoggerId $logger.LoggerId -Context $context -AlwaysLog allErrors -SamplingSetting $samplingSetting -DiagnosticId "applicationinsights" +``` + +```output +DiagnosticId : applicationinsights +ApiId : +AlwaysLog : allErrors +LoggerId : backendapisachinc +EnableHttpCorrelationHeaders : True +SamplingSetting : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting +FrontendSetting : +BackendSetting : +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUs/providers/Microsoft.ApiManagement/service/contoso/diagnostics/applicationinsights +ResourceGroupName : Api-Default-WestUs +ServiceName : contoso +``` + +This example create a diagnostic entity at the Global Scope. + +### Example 2: Create a diagnostic at Api scope +```powershell +$context = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$logger = Get-AzApiManagementLogger -Context $context -LoggerId azuremonitor +$samplingsetting = New-AzApiManagementSamplingSetting -SamplingType fixed -SamplingPercentage 100 +$httpMessageDiagnostic = New-AzApiManagementHttpMessageDiagnostic -HeadersToLog 'Content-Type', 'User-Agent' -BodyBytesToLog 100 +$pipelineDiagnostic = New-AzApiManagementPipelineDiagnosticSetting -Request $httpMessageDiagnostic -Response $httpMessageDiagnostic +New-AzApiManagementDiagnostic -LoggerId $logger.LoggerId -Context $context -ApiId httpbin -AlwaysLog allErrors -SamplingSetting $samplingsetting -FrontEndSetting $pipelineDiagnostic -BackendSetting $pipelineDiagnostic -DiagnosticId azuremonitor +``` + +```output +DiagnosticId : azuremonitor +ApiId : httpbin +AlwaysLog : allErrors +LoggerId : azuremonitor +EnableHttpCorrelationHeaders : +SamplingSetting : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting +FrontendSetting : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementPipelineDiagnosticSetting +BackendSetting : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementPipelineDiagnosticSetting +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/apis/httpbin/diagnostics/azuremonitor +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso +``` + +The example above create a diagnostic for the API `httpbin` to log the Header and 100 Bytes of Body to `azuremonitor` logger. + +## PARAMETERS + +### -AlwaysLog +Specifies for what type of messages sampling settings should not apply. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiId +Identifier of existing API. +If specified will set API-scope policy. +This parameters is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendSetting +Diagnostic setting for incoming/outgoing Http Messages to the Backend. This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementPipelineDiagnosticSetting +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticId +Identifier of the diagnostics entity. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontEndSetting +Diagnostic setting for incoming/outgoing Http Messages to the Gateway. This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementPipelineDiagnosticSetting +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoggerId +Identifier of the logger to push diagnostics to. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SamplingSetting +Sampling Setting of the Diagnostic. +This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementPipelineDiagnosticSetting + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementDiagnostic + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementDiagnostic](./Get-AzApiManagementDiagnostic.md) + +[Remove-AzApiManagementDiagnostic](./Remove-AzApiManagementDiagnostic.md) + +[Set-AzApiManagementDiagnostic](./Set-AzApiManagementDiagnostic.md) + +[New-AzApiManagementHttpMessageDiagnostic](./New-AzApiManagementHttpMessageDiagnostic.md) + +[New-AzApiManagementSamplingSetting](./New-AzApiManagementHttpMessageDiagnostic.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementGateway.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementGateway.md new file mode 100644 index 0000000000..d2c8b3e8c9 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementGateway.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementGateway.md +--- + +# New-AzApiManagementGateway + +## SYNOPSIS +Creates new Gateway entity. + +## SYNTAX + +``` +New-AzApiManagementGateway -Context [-GatewayId ] [-Description ] + -LocationData [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The **New-AzApiManagementGateway** cmdlet creates new Gateway entity. + +## EXAMPLES + +### Example 1: Create a gateway +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$location = New-AzApiManagementResourceLocationObject -Name "n1" -City "c1" -District "d1" -CountryOrRegion "r1" +New-AzApiManagementGateway -Context $apimContext -GatewayId "123" -Description "desc" -LocationData $location +``` + +This command creates a gateway. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Gateway description. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GatewayId +Identifier of new gateway. +This parameter is optional. +If not specified will be generated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LocationData +Gateway location. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResourceLocation +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResourceLocation + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementGatewayHostnameConfiguration.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementGatewayHostnameConfiguration.md new file mode 100644 index 0000000000..08ccd02965 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementGatewayHostnameConfiguration.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementgatewayhostnameconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementGatewayHostnameConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementGatewayHostnameConfiguration.md +--- + +# New-AzApiManagementGatewayHostnameConfiguration + +## SYNOPSIS +Creates a hostname configuratin for the existing Gateway. + +## SYNTAX + +``` +New-AzApiManagementGatewayHostnameConfiguration -Context -GatewayId + [-GatewayHostnameConfigurationId ] -Hostname -CertificateResourceId + [-NegotiateClientCertificate] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **New-AzApiManagementGatewayHostnameConfiguration** cmdlet creates a hostname configuratin for the existing Gateway. + +## EXAMPLES + +### Example 1: Create a hostname configuration for the existing gateway +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$cert = Get-AzApiManagementCertificate -Context $apimContext -CertificateId "333" +New-AzApiManagementGatewayHostnameConfiguration -Context $apimContext -GatewayId "g01" -GatewayHostnameConfigurationId "h01" -Hostname "www.contoso.com" -CertificateResourceId $cert.Id +``` + +This command creates a "h01" hostname configuration for a "g01" gateway. + +## PARAMETERS + +### -CertificateResourceId +A resource identifier for the existing certificate id. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayHostnameConfigurationId +Identifier of new gateway hostname confiuration. +This parameter is optional. +If not specified will be generated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GatewayId +Identifier of existing gateway. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Hostname +Hostname. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NegotiateClientCertificate +Flag to enforce NegotiateClientCertificate. +This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGatewayHostnameConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementGroup.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementGroup.md new file mode 100644 index 0000000000..89aeb0395a --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementGroup.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: EE2BC1F7-E6F3-477D-8416-8E61893534E2 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementGroup.md +--- + +# New-AzApiManagementGroup + +## SYNOPSIS +Creates an API management group. + +## SYNTAX + +``` +New-AzApiManagementGroup -Context [-GroupId ] -Name + [-Description ] [-Type ] [-ExternalId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementGroup** cmdlet creates an API management group. + +## EXAMPLES + +### Example 1: Create a management group +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementGroup -Context $apimContext -Name "Group0001" +``` + +This command creates a management group. + +### Example 2 + +Creates an API management group. (autogenerated) + + +```powershell +New-AzApiManagementGroup -Context -Description 'Create Echo Api V4' -GroupId '0001' -Name 'Group0001' -Type Custom +``` + +## PARAMETERS + +### -Context +Specifies the instance of the **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies the description of the management group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExternalId +For external groups, this property contains the id of the group from the external identity provider, e.g. Azure Active Directory aad://contoso5api.onmicrosoft.com/groups/12ad42b1-592f-4664-a77b4250-2f2e82579f4c; otherwise the value is null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +Specifies the identifier of the new management group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the management group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Group Type. Custom Group is User defined Group. System Group includes Administrator, Developers and Guests. You cannot create or update a System Group. External Group is groups from External Identity Provider like Azure Active Directory. This parameter is optional and by default assumed to be a Custom Group. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroupType] +Parameter Sets: (All) +Aliases: +Accepted values: Custom, System, External + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroupType, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementGroup](./Get-AzApiManagementGroup.md) + +[Remove-AzApiManagementGroup](./Remove-AzApiManagementGroup.md) + +[Set-AzApiManagementGroup](./Set-AzApiManagementGroup.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementHttpMessageDiagnostic.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementHttpMessageDiagnostic.md new file mode 100644 index 0000000000..f0483e776f --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementHttpMessageDiagnostic.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementhttpmessagediagnostic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementHttpMessageDiagnostic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementHttpMessageDiagnostic.md +--- + +# New-AzApiManagementHttpMessageDiagnostic + +## SYNOPSIS +Creates an instance of **PsApiManagementHttpMessageDiagnostic** which is an Http Message diagnostic setting of the Diagnostic + +## SYNTAX + +``` +New-AzApiManagementHttpMessageDiagnostic [-HeadersToLog ] [-BodyBytesToLog ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The cmdlet **New-AzApiManagementHttpMessageDiagnostic** creates the Http Message diagnostic setting. + +## EXAMPLES + +### Example 1: Create a Basic Http Message diagnostic Setting +```powershell +New-AzApiManagementHttpMessageDiagnostic -HeadersToLog 'Content-Type', 'UserAgent' -BodyBytesToLog 100 +``` + +```output +Headers Body +------- ---- +{Content-Type, UserAgent} Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBodyDiagnosticSetting +``` + +Create a http message diagnostic setting to log `Content-Type` and `User-Agent` headers along with 100 bytes of `body` + +## PARAMETERS + +### -BodyBytesToLog +Number of request body bytes to log. This parameter is optional. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeadersToLog +The array of headers to log. This parameter is optional. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementHttpMessageDiagnostic + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementDiagnostic](./New-AzApiManagementDiagnostic.md) + +[New-AzApiManagementSamplingSetting](./New-AzApiManagementHttpMessageDiagnostic.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementIdentityProvider.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementIdentityProvider.md new file mode 100644 index 0000000000..18513ba4de --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementIdentityProvider.md @@ -0,0 +1,306 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementidentityprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementIdentityProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementIdentityProvider.md +--- + +# New-AzApiManagementIdentityProvider + +## SYNOPSIS +Creates a new Identity Provider configuration. + +## SYNTAX + +``` +New-AzApiManagementIdentityProvider -Context + -Type -ClientId -ClientSecret + [-AllowedTenants ] [-Authority ] [-SignupPolicyName ] [-SigninPolicyName ] + [-ProfileEditingPolicyName ] [-PasswordResetPolicyName ] [-SigninTenant ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates a new Identity Provider configuration. + +## EXAMPLES + +### Example 1: Configures Facebook as an identity Provider for Developer Portal Logins +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementIdentityProvider -Context $apimContext -Type 'Facebook' -ClientId 'sdfsfwerwerw' -ClientSecret 'sdgsdfgfst43tewfewrf' +``` + +This command configures Facebook Identity as a accepted Identity Provider on the Developer Portal of the ApiManagement service. +This takes as input the ClientId and ClientSecret of the Facebook app. + +### Example 2: Configures adB2C as an identity Provider for Developer Portal Logins +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementIdentityProvider -Context $context -Type AadB2C -ClientId 6b1fc750-9e68-450c-97d2-ba6acd0fbc20 -ClientSecret "foobar" -AllowedTenants 'samirtestbc.onmicrosoft.com' -SignupPolicyName B2C_1_signup-policy +``` + +```output +Type : AadB2C +ClientId : 6b1fc750-9e68-450c-97d2-ba6acd0fbc20 +ClientSecret : foobar +AllowedTenants : {samirtestbc.onmicrosoft.com} +Authority : login.microsoftonline.com +SignupPolicyName : B2C_1_signup-policy +SigninPolicyName : +ProfileEditingPolicyName : +PasswordResetPolicyName : +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/identityProviders/AadB2C +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso +``` + +This command configures Facebook Identity as a accepted Identity Provider on the Developer Portal of the ApiManagement service. +This takes as input the ClientId and ClientSecret of the Facebook app. + +## PARAMETERS + +### -AllowedTenants +List of allowed Azure Active Directory Tenants + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Authority +OpenID Connect discovery endpoint hostname for AAD or AAD B2C. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientId +Client Id of the Application in the external Identity Provider. +It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientSecret +Client secret of the Application in external Identity Provider, used to authenticate login request. +For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordResetPolicyName +Password Reset Policy Name. Only applies to AAD B2C Identity Provider. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProfileEditingPolicyName +Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SigninPolicyName +Signin Policy Name. Only applies to AAD B2C Identity Provider. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SigninTenant +Signin Tenant to override in AAD B2C instead of the `common` Tenant + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SignupPolicyName +Signup Policy Name. Only applies to AAD B2C Identity Provider. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Identifier of a Identity Provider. +If specified will try to find identity provider configuration by the identifier. +This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType +Parameter Sets: (All) +Aliases: +Accepted values: Facebook, Google, Microsoft, Twitter, Aad, AadB2C + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementIdentityProvider](./Get-AzApiManagementIdentityProvider.md) + +[Remove-AzApiManagementIdentityProvider](./Remove-AzApiManagementIdentityProvider.md) + +[Set-AzApiManagementIdentityProvider](./Set-AzApiManagementIdentityProvider.md) diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementKeyVaultObject.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementKeyVaultObject.md new file mode 100644 index 0000000000..dc6cb8759c --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementKeyVaultObject.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementkeyvaultobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementKeyVaultObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementKeyVaultObject.md +--- + +# New-AzApiManagementKeyVaultObject + +## SYNOPSIS +Creates an instance of PsApiManagementKeyVaultObject. + +## SYNTAX + +``` +New-AzApiManagementKeyVaultObject -SecretIdentifier [-IdentityClientId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementKeyVaultObject** cmdlet creates an instance of PsApiManagementKeyVaultObjecte. + +## EXAMPLES + +### Example 1 : Create a keyVault Namedvalue +```powershell +$secretIdentifier = 'https://contoso.vault.azure.net/secrets/xxxx' +$keyvault = New-AzApiManagementKeyVaultObject -SecretIdentifier $secretIdentifier +$keyVaultNamedValue = New-AzApiManagementNamedValue -Context $context -NamedValueId $keyVaultNamedValueId -Name $keyVaultNamedValueName -keyVault $keyvault -Secret +``` + +The first command creates a keyvault. +The second command creates a named value using secret from this keyvault. + +### Example 2 : Create a keyVault Certificate +```powershell +$secretIdentifier = 'https://contoso.vault.azure.net/secrets/xxxx' +$keyvault = New-AzApiManagementKeyVaultObject -SecretIdentifier $secretIdentifier +$keyVaultcert = New-AzApiManagementCertificate -Context $context -CertificateId $kvcertId -KeyVault $keyvault +``` + +The first command creates a keyvault. +The second command creates a certificate using secret from this keyvault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityClientId +Identity Client Id of the user-assigned Managed Identity. +Will default system-assigned if leave empty. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretIdentifier +Secret Identifier of this Key Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementKeyVaultEntity + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementLogger.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementLogger.md new file mode 100644 index 0000000000..44c3adcfeb --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementLogger.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 17D53F56-6E3B-491E-8776-5EBE109FBE3C +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementlogger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementLogger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementLogger.md +--- + +# New-AzApiManagementLogger + +## SYNOPSIS +Creates an API Management Logger. + +## SYNTAX + +### EventHubLoggerSet (Default) +``` +New-AzApiManagementLogger -Context [-LoggerId ] -Name + -ConnectionString [-Description ] [-IsBuffered ] + [-DefaultProfile ] [] +``` + +### ApplicationInsightsLoggerSet +``` +New-AzApiManagementLogger -Context [-LoggerId ] -InstrumentationKey + [-Description ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementLogger** cmdlet creates an Azure API Management **Logger**. + +## EXAMPLES + +### Example 1: Create a logger +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementLogger -Context $apimContext -LoggerId "Logger123" -Name "ContosoSdkEventHub" -ConnectionString "Endpoint=sb://ContosoSdkEventHubs.servicebus.windows.net/;SharedAccessKeyName=SendKey;SharedAccessKey=" -Description "SDK event hub logger" +``` + +This command creates a logger named ContosoSdkEventHub by using the specified connection string. + +### Example 2 + +Creates an API Management Logger. (autogenerated) + + +```powershell +New-AzApiManagementLogger -Context -InstrumentationKey -LoggerId 'Logger123' +``` + +## PARAMETERS + +### -ConnectionString +Specifies an Azure Event Hubs connection string that starts with the following: +`Endpoint=endpoint and key from Azure classic portal` +The Key with Send Rights in the connection string must be configured. + +```yaml +Type: System.String +Parameter Sets: EventHubLoggerSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstrumentationKey +Instrumentation Key of the application Insights. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: ApplicationInsightsLoggerSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IsBuffered +Specifies whether the records in the logger are buffered before publishing. +The default value is $True. +When records are buffered, they are sent to Event Hubs every 15 seconds, or whenever the buffer receives 256 KB of messages. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: EventHubLoggerSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoggerId +Specifies an ID for the logger. +If you do not specify an ID, this cmdlet generates one. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the entity name of an event hub from Azure classic portal. + +```yaml +Type: System.String +Parameter Sets: EventHubLoggerSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementLogger + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementLogger](./Get-AzApiManagementLogger.md) + +[Remove-AzApiManagementLogger](./Remove-AzApiManagementLogger.md) + +[Set-AzApiManagementLogger](./Set-AzApiManagementLogger.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementNamedValue.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementNamedValue.md new file mode 100644 index 0000000000..a62a5f99f1 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementNamedValue.md @@ -0,0 +1,241 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementnamedvalue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementNamedValue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementNamedValue.md +--- + +# New-AzApiManagementNamedValue + +## SYNOPSIS +Creates new Named Value. + +## SYNTAX + +``` +New-AzApiManagementNamedValue -Context [-NamedValueId ] [-Name ] + [-Value ] [-Secret] [-Tag ] [-KeyVault ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **New-AzApiManagementNamedValue** cmdlet creates an Azure API Management **Named Value**. + +## EXAMPLES + +### Example 1: Create a named value that includes tags +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$Tags = 'sdk', 'powershell' +New-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property11" -Name "Property Name" -Value "Property Value" -Tag $Tags +``` + +The first command assigns two values to the $Tags variable. +The second command creates a named value and assigns the strings in $Tags as tags on the property. + +### Example 2: Create a named value that has a secret value +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property12" -Name "Secret Property" -Value "Secret Property Value" -Secret +``` + +This command creates a **Named Value** that has a value that is encrypted. + +### Example 3 : Create a keyVault Namedvalue +```powershell +$secretIdentifier = 'https://contoso.vault.azure.net/secrets/xxxx' +$keyvault = New-AzApiManagementKeyVaultObject -SecretIdentifier $secretIdentifier +$keyVaultNamedValue = New-AzApiManagementNamedValue -Context $context -NamedValueId $keyVaultNamedValueId -Name $keyVaultNamedValueName -keyVault $keyvault -Secret +``` + +The first command creates a keyvault. +The second command creates a named value using secret from this keyvault. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVault +KeyVault used to fetch Namedvalue data.This parameter is required if Value not specified. +See New-AzApiManagementKeyVaultObject for details. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementKeyVaultEntity +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the named value. +Maximum length is 100 characters. +It may contain only letters, digits, period, dash, and underscore characters. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NamedValueId +Identifier of new named value. +This parameter is optional. +If not specified will be generated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Secret +Determines whether the value is a secret and should be encrypted or not. +This parameter is optional. +Default Value is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Tags to be associated with named value. +This parameter is optional. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Value of the named value. +Can contain policy expressions. +Maximum length is 1000 characters. +It may not be empty or consist only of whitespace. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementNamedValue + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementOpenIdConnectProvider.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementOpenIdConnectProvider.md new file mode 100644 index 0000000000..8832c671e9 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementOpenIdConnectProvider.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: D5B18FF4-3294-4561-A4CD-CF0FA5E4A59B +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementopenidconnectprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementOpenIdConnectProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementOpenIdConnectProvider.md +--- + +# New-AzApiManagementOpenIdConnectProvider + +## SYNOPSIS +Creates an OpenID Connect provider. + +## SYNTAX + +``` +New-AzApiManagementOpenIdConnectProvider -Context [-OpenIdConnectProviderId ] + -Name -MetadataEndpointUri -ClientId [-ClientSecret ] + [-Description ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementOpenIdConnectProvider** cmdlet creates an OpenID Connect provider in Azure API Management. + +## EXAMPLES + +### Example 1: Create a provider +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvider01" -Name "Contoso OpenID Connect Provider" -MetadataEndpointUri "https://openid.provider/configuration" -ClientId "12432143" -Description "OpenID Connect provider description" +``` + +This command creates an OpenID Connect **Provider** named Contoso OpenID Connect Provider + +### Example 2 + +Creates an OpenID Connect provider. (autogenerated) + + +```powershell +New-AzApiManagementOpenIdConnectProvider -ClientId '12432143' -ClientSecret '000000000000000000000000000000000000000000' -Context -Description 'OpenID Connect provider description' -MetadataEndpointUri 'https://openid.provider/configuration' -Name 'Contoso OpenID Connect Provider' -OpenIdConnectProviderId 'OICProvider01' +``` + +## PARAMETERS + +### -ClientId +Specifies the client ID of the developer console. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientSecret +Specifies the client secret of the developer console. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MetadataEndpointUri +Specifies a metadata endpoint URI of the provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a friendly name for the provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OpenIdConnectProviderId +Specifies an ID for the provider. +If you do not specify an ID, this cmdlet generates one. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOpenIdConnectProvider + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementOpenIdConnectProvider](./Get-AzApiManagementOpenIdConnectProvider.md) + +[Remove-AzApiManagementOpenIdConnectProvider](./Remove-AzApiManagementOpenIdConnectProvider.md) + +[Set-AzApiManagementOpenIdConnectProvider](./Set-AzApiManagementOpenIdConnectProvider.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementOperation.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementOperation.md new file mode 100644 index 0000000000..a776a60108 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementOperation.md @@ -0,0 +1,288 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 0BC53178-8463-4EF5-8268-FBEC4753AD97 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementOperation.md +--- + +# New-AzApiManagementOperation + +## SYNOPSIS +Creates an API management operation. + +## SYNTAX + +``` +New-AzApiManagementOperation -Context -ApiId [-ApiRevision ] + [-OperationId ] -Name -Method -UrlTemplate [-Description ] + [-TemplateParameters ] [-Request ] + [-Responses ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementOperation** cmdlet create an API operation. + +## EXAMPLES + +### Example 1: Create an API management operation +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementOperation -Context $apimContext -ApiId $APIId -OperationId "Operation001" -Name "Operation" -Method "GET" -UrlTemplate "/resource" -Description "Use this operation to get resource" +``` + +This command creates an API management operation. + +### Example 2: Create an API management operation with request and response details +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$RID = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter +$RID.Name = "RID" +$RID.Description = "Resource identifier" +$RID.Type = "string" +$Query = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter +$Query.Name = "query" +$Query.Description = "Query string" +$Query.Type = 'string' +$Request = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRequest +$Request.Description = "Create/update resource request" +$DummyQp = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter +$DummyQp.Name = 'dummy' +$DummyQp.Type = 'string' +$DummyQp.Required = $FALSE +$Request.QueryParameters = @($DummyQp) +$Header = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter +$Header.Name = 'x-custom-header' +$Header.Type = 'string' +$Request.Headers = @($Header) +$RequestRepresentation = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRepresentation +$RequestRepresentation.ContentType = 'application/json' +$exp = New-Object –TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameterExample +$exp.Value = "default" +$exp.Description = "My default request example" +$exp.ExternalValue = "https://contoso.com" +$exp.Summary = "default" +$RequestRepresentation.Examples = @($exp) +$Request.Representations = @($requestRepresentation) +$Response = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse +$Response.StatusCode = 204 +New-AzApiManagementOperation -Context $apimContext -ApiId $APIId -OperationId "01234567890" -Name 'Create/update resource' -Method 'PUT' -UrlTemplate '/resource/{rid}?q={query}' -Description "Use this operation to create new or update existing resource" -TemplateParameters @($rid, $query) -Request $Request -Responses @($response) +``` + +This example creates an API management operation with request and response details. + +## PARAMETERS + +### -ApiId +Specifies the identifier of the API management operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Identifier of API Revision. This parameter is optional. If not specified, the operation will be attached to the currently active api revision. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies the instance of the **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies the description of new API operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Method +Specifies the HTTP method of the new API management operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the display name of new API management operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OperationId +Specifies the identifier of the API management operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Request +Specifies the details of the API management operation. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRequest +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Responses +Specifies an array of possible API management operation responses. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameters +Specifies an array of parameters defined in parameter *UrlTemplate*. +If you do not specify this parameter, a default value will be generated based on the *UrlTemplate*. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UrlTemplate +Specifies the URL template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter[] + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRequest + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementOperation](./Get-AzApiManagementOperation.md) + +[Remove-AzApiManagementOperation](./Remove-AzApiManagementOperation.md) + +[Set-AzApiManagementOperation](./Set-AzApiManagementOperation.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementPipelineDiagnosticSetting.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementPipelineDiagnosticSetting.md new file mode 100644 index 0000000000..fd9307d608 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementPipelineDiagnosticSetting.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementpipelinediagnosticsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementPipelineDiagnosticSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementPipelineDiagnosticSetting.md +--- + +# New-AzApiManagementPipelineDiagnosticSetting + +## SYNOPSIS +Create Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. + +## SYNTAX + +``` +New-AzApiManagementPipelineDiagnosticSetting [-Request ] + [-Response ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The cmdlet **New-AzApiManagementPipelineDiagnosticSetting** creates the Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. + +## EXAMPLES + +### Example 1 +```powershell +$httpMessageDiagnostic = New-AzApiManagementHttpMessageDiagnostic -HeadersToLog 'Content-Type', 'UserAgent' -BodyBytesToLog 100 +New-AzApiManagementPipelineDiagnosticSetting -Request $httpMessageDiagnostic -Response $httpMessageDiagnostic +``` + +```output +Request Response +------- -------- +Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementHttpMessageDiagnostic Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementHttpMessageDiagnostic +``` + +Create a pipeline diagnostic to be used in either FrontEnd or Backend in the Diagnostic Entity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +Diagnostic setting for Request. +This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementHttpMessageDiagnostic +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Response +Diagnostic setting for Response. +This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementHttpMessageDiagnostic +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementPipelineDiagnosticSetting + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementDiagnostic](./Get-AzApiManagementDiagnostic.md) + +[Remove-AzApiManagementDiagnostic](./Remove-AzApiManagementDiagnostic.md) + +[Set-AzApiManagementDiagnostic](./Set-AzApiManagementDiagnostic.md) + +[New-AzApiManagementHttpMessageDiagnostic](./New-AzApiManagementHttpMessageDiagnostic.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementProduct.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementProduct.md new file mode 100644 index 0000000000..00ffb9b313 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementProduct.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: E94B88AA-B8B0-49F0-AD36-6707E17B40AD +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementproduct +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementProduct.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementProduct.md +--- + +# New-AzApiManagementProduct + +## SYNOPSIS +Creates an API Management product. + +## SYNTAX + +``` +New-AzApiManagementProduct -Context [-ProductId ] -Title + [-Description ] [-LegalTerms ] [-SubscriptionRequired ] [-ApprovalRequired ] + [-SubscriptionsLimit ] [-State ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementProduct** cmdlet creates an API Management product. + +## EXAMPLES + +### Example 1: Create a product that does not require a subscription +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementProduct -Context $apimContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms "Free for all" -SubscriptionRequired $False -State "Published" +``` + +This command creates an API Management product. +No subscription is required. + +### Example 2: Create a product that requires a subscription and approval +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementProduct -Context $apimContext -ProductId "9876543210" -Title "Unlimited" -Description "Subscribers have completely unlimited access to the API. Administrator approval is required." -LegalTerms "Free for all" -ApprovalRequired $True -State "Published" +``` + +This command creates a product. +A subscription and approval are required. + +## PARAMETERS + +### -ApprovalRequired +Indicates whether the subscription to the product requires approval or not. +By default, this parameter is **$False**. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies an instance of a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies the product description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LegalTerms +Specifies the legal terms of use of the product. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductId +Specifies the identifier of new product. +If you do not specify this parameter, a new product is generated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the product state. +psdx_paramvalues +- NotPublished +- Published +The default value is NotPublished. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProductState] +Parameter Sets: (All) +Aliases: +Accepted values: NotPublished, Published + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionRequired +Indicates whether the product requires a subscription. +The default value is **$True**. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionsLimit +Specifies the maximum number of simultaneous subscriptions. +The default value is None. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Title +Specifies the product title. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProductState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementProduct](./Get-AzApiManagementProduct.md) + +[Remove-AzApiManagementProduct](./Remove-AzApiManagementProduct.md) + +[Set-AzApiManagementProduct](./Set-AzApiManagementProduct.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementRegion.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementRegion.md new file mode 100644 index 0000000000..fba25f76aa --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementRegion.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: A4226BFB-AB3B-4883-9D52-5EB7F29D8A71 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementregion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementRegion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementRegion.md +--- + +# New-AzApiManagementRegion + +## SYNOPSIS +Creates an instance of PsApiManagementRegion. + +## SYNTAX + +``` +New-AzApiManagementRegion -Location [-Capacity ] + [-VirtualNetwork ] [-Zone ] [-DisableGateway ] + [-PublicIpAddressId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Helper command to create an instance of PsApiManagementRegion. +This command is to be used with New-AzApiManagement command. + +## EXAMPLES + +### Example 1 +```powershell +$apimRegion = New-AzApiManagementRegion -Location "Central US" + +$additionalRegions = @($apimRegion) + +New-AzApiManagement -ResourceGroupName ContosoGroup -Location "West US" -Name ContosoApi -Organization Contoso -AdminEmail admin@contoso.com -AdditionalRegions $additionalRegions -Sku "Premium" +``` + +### Example 2 +```powershell +$apimRegionVirtualNetwork = New-AzApiManagementVirtualNetwork -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/centralusvirtualNetwork/subnets/backendSubnet" + +$apimRegion = New-AzApiManagementRegion -Location "Central US" -VirtualNetwork $apimRegionVirtualNetwork + +$additionalRegions = @($apimRegion) + +$virtualNetwork = New-AzApiManagementVirtualNetwork -SubnetResourceId "/subscriptions/a8ff56dc-3bc2-4174-a1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet" + +New-AzApiManagement -ResourceGroupName ContosoGroup -Location "West US" -Name ContosoApi -Organization Contoso -AdminEmail admin@contoso.com -AdditionalRegions $additionalRegions -VirtualNetwork $virtualNetwork -VpnType "External" -Sku "Premium" +``` + +Creates an ApiManagement service of External VpnType in West US Region, with an Additional Region in Central US. + +## PARAMETERS + +### -Capacity +Sku capacity of the Azure API Management service additional region. +Default value is 1. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableGateway +Flag only meant to be used for Premium SKU ApiManagement Service and Non Internal VNET deployments. This is useful in case we want to take a gateway region out of rotation. This can also be used to standup a new region in Passive mode, test it and then make it Live later. + Default behavior is to make the region live immediately. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the new deployment region amongst the supported region for Api Management service. +To obtain valid locations, use the cmdlet +Get-AzResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddressId +Standard SKU PublicIpAddress ResoureId for integration into stv2 Virtual Network Deployments. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetwork +Virtual Network Configuration of Azure API Management deployment region. +Default value is $null. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +A list of availability zones denoting where the api management service is deployed into. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementResourceLocationObject.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementResourceLocationObject.md new file mode 100644 index 0000000000..731b031fd9 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementResourceLocationObject.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementresourcelocationobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementResourceLocationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementResourceLocationObject.md +--- + +# New-AzApiManagementResourceLocationObject + +## SYNOPSIS +Create a new resource location contract (used in Gateways). + +## SYNTAX + +``` +New-AzApiManagementResourceLocationObject -Name [-City ] [-District ] + [-CountryOrRegion ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementResourceLocationObject** cmdlet create a new resource location contract (used in Gateways). + +## EXAMPLES + +### Example 1: Create a resource location contract +```powershell +$location = New-AzApiManagementResourceLocationObject -Name "n1" -City "c1" -District "d1" -CountryOrRegion "r1" +``` + +This command creates a resource location. + +## PARAMETERS + +### -City +Location City. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountryOrRegion +Location Country or Region. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -District +Location District. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Location Name. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResourceLocation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementSamplingSetting.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementSamplingSetting.md new file mode 100644 index 0000000000..7d92858363 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementSamplingSetting.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementsamplingsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementSamplingSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementSamplingSetting.md +--- + +# New-AzApiManagementSamplingSetting + +## SYNOPSIS +Create a new sampling setting for the Diagnostic + +## SYNTAX + +``` +New-AzApiManagementSamplingSetting [-SamplingType ] [-SamplingPercentage ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The cmdlet **New-AzApiManagementSamplingSetting** creates a new sampling setting for the Diagnostic + +## EXAMPLES + +### Example 1: Create a basic Sampling setting +```powershell +New-AzApiManagementSamplingSetting -SamplingType fixed -SamplingPercentage 100 +``` + +```output +SamplingType Percentage +------------ ---------- +fixed 100 +``` + +Creates a sampling setting of `Fixed` type with logging for 100% of the requests / responses + +### Example 2 + +Create a new sampling setting for the Diagnostic. (autogenerated) + + +```powershell +New-AzApiManagementSamplingSetting -SamplingPercentage 100 -SamplingType fixed +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamplingPercentage +Rate of Sampling for Fixed Rate Sampling. This parameter is optional. + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamplingType +The Type of Sampling. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementDiagnostic](./Get-AzApiManagementDiagnostic.md) + +[Remove-AzApiManagementDiagnostic](./Remove-AzApiManagementDiagnostic.md) + +[Set-AzApiManagementDiagnostic](./Set-AzApiManagementDiagnostic.md) + +[New-AzApiManagementSamplingSetting](./New-AzApiManagementHttpMessageDiagnostic.md) diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementSslSetting.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementSslSetting.md new file mode 100644 index 0000000000..6b0b8de1df --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementSslSetting.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementsslsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementSslSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementSslSetting.md +--- + +# New-AzApiManagementSslSetting + +## SYNOPSIS +Creates an instance of PsApiManagementSslSetting + +## SYNTAX + +``` +New-AzApiManagementSslSetting [-FrontendProtocol ] [-BackendProtocol ] + [-CipherSuite ] [-ServerProtocol ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Helper command to create an instance of PsApiManagementSslSetting. +This command is to be used with New-AzApiManagement command. + +## EXAMPLES + +### Example 1: Create an SSL Setting to enable TLS 1.0 on both Backend and Frontend +```powershell +$enableTls=@{"Tls10" = "True"} +New-AzApiManagementSslSetting -FrontendProtocol $enableTls -BackendProtocol $enableTls +``` + +```output +FrontendProtocols BackendProtocols CipherSuites ServerProtocols +----------------- ---------------- ------------ --------------- +{Tls10} {Tls10} +``` + +Create an new instance of PsApiManagementSslSetting to Enable TLSv 1.0 in both Frontend (between client and APIM) and Backend (between APIM and Backend) of ApiManagement Gateway. + +## PARAMETERS + +### -BackendProtocol +Backend Security protocol settings. This parameter is optional. +The valid Protocol Settings are +`Tls11` - Tls 1.1 +`Tls10` - Tls 1.0 +`Ssl30` - SSL 3.0 + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CipherSuite +Ssl cipher suites settings in the specified order. This parameter is optional. +The valid Settings are +`TripleDes168` - Enable / Disable Tripe Des 168 + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendProtocol +Frontend Security protocols settings. This parameter is optional. +The valid Protocol Settings are +`Tls11` - Tls 1.1 +`Tls10` - Tls 1.0 +`Ssl30` - SSL 3.0 + + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerProtocol +Server protocol settings like Http2. This parameter is optional. +The valid Settings are +`Http2` - Enable Http 2.0 + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSettings + +## NOTES + +## RELATED LINKS + +[New-AzApiManagement](./New-AzApiManagement.md) + diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementSubscription.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementSubscription.md new file mode 100644 index 0000000000..9c48d328d6 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementSubscription.md @@ -0,0 +1,268 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: B85BF332-503D-41CB-A3B7-221B85B9BE30 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementSubscription.md +--- + +# New-AzApiManagementSubscription + +## SYNOPSIS +Creates a subscription. + +## SYNTAX + +### OldSubscriptionModel (Default) +``` +New-AzApiManagementSubscription -Context [-SubscriptionId ] -Name + -UserId -ProductId [-PrimaryKey ] [-SecondaryKey ] [-AllowTracing] + [-State ] [-DefaultProfile ] [] +``` + +### NewSubscriptionModel +``` +New-AzApiManagementSubscription -Context [-SubscriptionId ] -Name + [-UserId ] -Scope [-PrimaryKey ] [-SecondaryKey ] [-AllowTracing] + [-State ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementSubscription** cmdlet creates a subscription. + +## EXAMPLES + +### Example 1: Subscribe a user to a product +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementSubscription -Context $apimContext -UserId "777" -ProductId "999" +``` + +This command subscribes an existing user to a product. + +### Example 2: Create a subscription for all Api Scope +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementSubscription -Context $apimContext -Scope "/apis" -Name "GlobalApiScope" +``` + +### Example 3: Create a subscription for Product Scope +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementSubscription -Context $apimContext -Scope "/products/starter" -Name "UnlimitedProductSub" +``` + +## PARAMETERS + +### -AllowTracing +Flag which determines whether Tracing can be enabled at the Subscription Level. This is optional parameter and default is $null. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the subscription name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrimaryKey +Specifies the subscription primary key. +If this parameter is not specified the key is generated automatically. +This parameter must be 1 to 256 characters long. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductId +Specifies the ID of the product to which to subscribe. + +```yaml +Type: System.String +Parameter Sets: OldSubscriptionModel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +The Scope of the Subscription, whether it is Api Scope /apis/{apiId} or Product Scope /products/{productId} or Global API Scope /apis or Global scope /. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: NewSubscriptionModel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryKey +Specifies the subscription secondary key. +This parameter is generated automatically if it is not specified. +This parameter must be 1 to 256 characters long. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the subscription state. +The default value is $Null. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState] +Parameter Sets: (All) +Aliases: +Accepted values: Suspended, Active, Expired, Submitted, Rejected, Cancelled + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +Specifies the subscription ID. +This parameter is generated if not specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserId +Specifies the subscriber ID. + +```yaml +Type: System.String +Parameter Sets: OldSubscriptionModel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: NewSubscriptionModel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscription + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementSubscription](./Get-AzApiManagementSubscription.md) + +[Remove-AzApiManagementSubscription](./Remove-AzApiManagementSubscription.md) + +[Set-AzApiManagementSubscription](./Set-AzApiManagementSubscription.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementSystemCertificate.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementSystemCertificate.md new file mode 100644 index 0000000000..85829fdfa2 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementSystemCertificate.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementsystemcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementSystemCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementSystemCertificate.md +--- + +# New-AzApiManagementSystemCertificate + +## SYNOPSIS +Creates an instance of `PsApiManagementSystemCertificate`. The certificate can be issued by private CA's and will be installed on the API Management service into `CertificateAuthority` or `Root` store. + +## SYNTAX + +``` +New-AzApiManagementSystemCertificate -StoreName -PfxPath [-PfxPassword ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementSystemCertificate** cmdlet is a helper command that creates an instance of **PsApiManagementSystemCertificate**. +This command is used with the New-AzApiManagement and Set-AzApiManagement cmdlet. + +## EXAMPLES + +### Example 1: Create and initialize an instance of PsApiManagementSystemCertificate using an Ssl Certificate from file +```powershell +$rootCa = New-AzApiManagementSystemCertificate -StoreName "Root" -PfxPath "C:\contoso\certificates\privateCa.cer" +$systemCert = @($rootCa) +New-AzApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -SystemCertificateConfiguration $systemCert +``` + +This command creates and initializes an instance of **PsApiManagementSystemCertificate** with a root CA certificate. It then creates and API Management service which installs the CA cert to the Root store. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PfxPassword +Password for the .pfx certificate file. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PfxPath +Path to a .pfx certificate file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StoreName +Certificate StoreName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: CertificateAuthority, Root + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Security.SecureString + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSystemCertificate + +## NOTES + +## RELATED LINKS + +[New-AzApiManagement](./New-AzApiManagement.md) + +[Set-AzApiManagement](./Set-AzApiManagement.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementUser.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementUser.md new file mode 100644 index 0000000000..68b779c287 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementUser.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 3C467F64-7525-4420-9AFE-DCB98EF6D203 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementUser.md +--- + +# New-AzApiManagementUser + +## SYNOPSIS +Registers a new user. + +## SYNTAX + +``` +New-AzApiManagementUser -Context [-UserId ] -FirstName + -LastName -Email -Password [-State ] + [-Note ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzApiManagementUser** cmdlet registers a new user. + +## EXAMPLES + +### Example 1: Register a new user +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$securePassword = ConvertTo-SecureString "qwerty" -AsPlainText -Force +New-AzApiManagementUser -Context $apimContext -FirstName "Patti" -LastName "Fuller" -Email "Patti.Fuller@contoso.com" -Password $securePassword +``` + +This command registers a new user named Patti Fuller. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +Specifies the email address of the user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FirstName +Specifies the first name of the user. +This parameter must be 1 to 100 characters long. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LastName +Specifies the last name of the user. +This parameter must be 1 to 100 characters long. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Note +Specifies a note about the user. +This parameter is optional. +The default value is $Null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Password +Specifies the user password. +This parameter is required. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the user state. +This parameter is optional. +The default value of this parameter is $Null. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState] +Parameter Sets: (All) +Aliases: +Accepted values: Active, Blocked, Deleted, Pending + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserId +Specifies the user ID. +This parameter is optional. +If this parameter is not specified, this cmdlet generates a user ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Security.SecureString + +### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementUser](./Get-AzApiManagementUser.md) + +[Set-AzApiManagementUser](./Set-AzApiManagementUser.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementUserToken.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementUserToken.md new file mode 100644 index 0000000000..4a886815fa --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementUserToken.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementusertoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementUserToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementUserToken.md +--- + +# New-AzApiManagementUserToken + +## SYNOPSIS +Generates a Shared Access Token for the User. + +## SYNTAX + +``` +New-AzApiManagementUserToken -Context -UserId + [-KeyType ] [-Expiry ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The cmdlet **New-AzApiManagementUserToken** generates a Shared Access Token for a specified User + +## EXAMPLES + +### Example 1: Generate a Shared Access Token for Git User +```powershell +$context = New-AzApiManagementContext -ResourceGroupName powershelltest -ServiceName powershellsdkservice +$gitAccess=Get-AzApiManagementTenantAccess -Context $context +New-AzApiManagementUserToken -Context $context -UserId $gitAccess.Id +``` + +```output +UserId TokenExpiry KeyType UserToken +------ ----------- ------- --------- +integration 5/3/2019 2:02:34 PM Primary integration&201905031402&zOwopJChWAA6oaqGHMyf7Ol9wUCPcrtdmBmff8c2lcmZk9Y... +``` + +This script get the Git user configured in ApiManagement service and generates a Shared Access Token using the Primary Key valid for 8 hours. + +### Example 2 + +Generates a Shared Access Token for the User. (autogenerated) + + +```powershell +New-AzApiManagementUserToken -Context -Expiry -UserId +``` + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expiry +Expiry of the Token. +If not specified, the token is created to expire after 8 hours. +This parameter is optional. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyType +User Key to use when generating the Token. +This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserKeyType +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserId +Identifier of existing user. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserKeyType + +### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserToken + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/New-AzApiManagementVirtualNetwork.md b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementVirtualNetwork.md new file mode 100644 index 0000000000..fb97597c4c --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/New-AzApiManagementVirtualNetwork.md @@ -0,0 +1,97 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: FB5E4ED2-8EF3-462F-A053-7EC82C767E8D +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/new-azapimanagementvirtualnetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementVirtualNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/New-AzApiManagementVirtualNetwork.md +--- + +# New-AzApiManagementVirtualNetwork + +## SYNOPSIS +Creates an instance of PsApiManagementVirtualNetwork. + +## SYNTAX + +``` +New-AzApiManagementVirtualNetwork -SubnetResourceId [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **New-AzApiManagementVirtualNetwork** cmdlet is a helper command to create an instance of **PsApiManagementVirtualNetwork**. +This command is used with **Set-AzApiManagement** and **New-AzApiManagement** cmdlet. + +## EXAMPLES + +### Example 1: Create a virtual network and Update an existing APIM service into the VNET +```powershell +$virtualNetwork = New-AzApiManagementVirtualNetwork -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-WestUS/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet" +$apim = Get-AzApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi" +$apim.VpnType = "External" +$apim.VirtualNetwork = $virtualNetwork +Set-AzApiManagement -InputObject $apim +``` + +This example creates a virtual network and then calls the **Set-AzApiManagement** cmdlet. + +### Example 2: Create an API Management service for an external virtual network +```powershell +$virtualNetwork = New-AzApiManagementVirtualNetwork -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-b1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet" +New-AzApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -VirtualNetwork $virtualNetwork -VpnType "External" -Sku "Premium" +``` + +This example creates a new APIM service into a Virtual Network in `External` mode + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetResourceId +Specifies the subnet resource ID of the virtual network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork + +## NOTES + +## RELATED LINKS + +[Set-AzApiManagement](./Set-AzApiManagement.md) +[New-AzApiManagement](./New-AzApiManagement.md) + diff --git a/azps-10.1.0/Az.ApiManagement/Publish-AzApiManagementTenantGitConfiguration.md b/azps-10.1.0/Az.ApiManagement/Publish-AzApiManagementTenantGitConfiguration.md new file mode 100644 index 0000000000..68708c2673 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Publish-AzApiManagementTenantGitConfiguration.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 4783305F-5619-446A-A6DF-BD1E56739A2F +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/publish-azapimanagementtenantgitconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Publish-AzApiManagementTenantGitConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Publish-AzApiManagementTenantGitConfiguration.md +--- + +# Publish-AzApiManagementTenantGitConfiguration + +## SYNOPSIS +Publishes changes from a Git branch to the configuration database. + +## SYNTAX + +``` +Publish-AzApiManagementTenantGitConfiguration -Context -Branch [-Force] + [-ValidateOnly] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Publish-AzApiManagementTenantGitConfiguration** cmdlet publishes the changes from a Git branch to the configuration database. +You can alternatively validate the changes in a Git branch without publishing. + +## EXAMPLES + +### Example 1: Deploy Git changes +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Publish-AzApiManagementTenantGitConfiguration -Context $apimContext -Branch 'master' -PassThru +``` + +This command publishes the changes from the specified branch to the configuration database. + +### Example 2: Validate Git changes +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Publish-AzApiManagementTenantGitConfiguration -Context $apimContext -Branch 'master' -ValidateOnly -PassThru +``` + +This command validates the changes in the Git branch against the configuration database. +It does not publish changes. + +## PARAMETERS + +### -Branch +Specifies the name of the Git branch from which this cmdlet deploys the configuration to the configuration database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet deletes subscriptions to products that are deleted in this update. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **PsApiManagementOperationResult** object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ValidateOnly +Indicates that this cmdlet validates the changes in the specified Git branch. +It does not publish to the configuration database. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperationResult + +## NOTES + +## RELATED LINKS + +[Save-AzApiManagementTenantGitConfiguration](./Save-AzApiManagementTenantGitConfiguration.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagement.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagement.md new file mode 100644 index 0000000000..4c34234244 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagement.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: CD582654-1B0C-4960-9E18-454F857B56E7 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagement.md +--- + +# Remove-AzApiManagement + +## SYNOPSIS +Removes an API Management service. + +## SYNTAX + +``` +Remove-AzApiManagement -ResourceGroupName -Name [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagement** cmdlet removes an Azure API Management service. + +## EXAMPLES + +### Example 1: Remove an API Management service +```powershell +Remove-AzApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" +``` + +This command removes the API Management service named ContosoApi. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the API Management deployment that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a value of $True if the operation succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the of resource group under which the API Management deployment exists. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Backup-AzApiManagement](./Backup-AzApiManagement.md) + +[Get-AzApiManagement](./Get-AzApiManagement.md) + +[New-AzApiManagement](./New-AzApiManagement.md) + +[Restore-AzApiManagement](./Restore-AzApiManagement.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApi.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApi.md new file mode 100644 index 0000000000..4bbd2e90de --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApi.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: F23D9274-63B9-4654-897B-6E84757774D2 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementapi +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApi.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApi.md +--- + +# Remove-AzApiManagementApi + +## SYNOPSIS +Removes an API. + +## SYNTAX + +``` +Remove-AzApiManagementApi -Context -ApiId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementApi** cmdlet removes an existing API. + +## EXAMPLES + +### Example 1: Remove an API +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementApi -Context $apimContext -ApiId "0123456789" +``` + +This command removes the API with the specified ID. + +## PARAMETERS + +### -ApiId +Specifies the ID of the API remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Export-AzApiManagementApi](./Export-AzApiManagementApi.md) + +[Get-AzApiManagementApi](./Get-AzApiManagementApi.md) + +[Import-AzApiManagementApi](./Import-AzApiManagementApi.md) + +[New-AzApiManagementApi](./New-AzApiManagementApi.md) + +[Set-AzApiManagementApi](./Set-AzApiManagementApi.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiFromGateway.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiFromGateway.md new file mode 100644 index 0000000000..7f0f6fc9f2 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiFromGateway.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementapifromgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApiFromGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApiFromGateway.md +--- + +# Remove-AzApiManagementApiFromGateway + +## SYNOPSIS +Attaches an API to a gateway. + +## SYNTAX + +``` +Remove-AzApiManagementApiFromGateway -Context -GatewayId -ApiId + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementApiFromGateway** cmdlet attaches an API to a gateway. + +## EXAMPLES + +### Example 1: Remove an API from a gateway +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementApiFromGateway -Context $ApiMgmtContext -GatewayId "0123456789" -ApiId "0001" -PassThru +``` + +This command removes the specified API from a gateway. + +## PARAMETERS + +### -ApiId +Identifier of existing APIs to remove from the Gateway. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayId +Identifier of existing Gateway to remove API from. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. +This parameter is optional. +Default value is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiFromProduct.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiFromProduct.md new file mode 100644 index 0000000000..0f972dc152 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiFromProduct.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 2457C7F5-7FB9-4712-AD7C-438E88F591A8 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementapifromproduct +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApiFromProduct.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApiFromProduct.md +--- + +# Remove-AzApiManagementApiFromProduct + +## SYNOPSIS +Removes an API from a product. + +## SYNTAX + +``` +Remove-AzApiManagementApiFromProduct -Context -ProductId -ApiId + [-PassThru] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementApiFromProduct** cmdlet removes an Azure API Management API from a product. + +## EXAMPLES + +### Example 1: Remove an API from a product +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementApiFromProduct -Context $ApiMgmtContext -ProductId "0123456789" -ApiId "0001" -PassThru +``` + +This command removes the specified API from a product. + +## PARAMETERS + +### -ApiId +Specifies the ID of the API to remove from the product. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext**. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a value of $True if it succeeds, or $False, otherwise. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductId +Specifies the ID of the product from which to remove the API. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Add-AzApiManagementApiToProduct](./Add-AzApiManagementApiToProduct.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiRelease.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiRelease.md new file mode 100644 index 0000000000..dfccd5451e --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiRelease.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementapirelease +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApiRelease.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApiRelease.md +--- + +# Remove-AzApiManagementApiRelease + +## SYNOPSIS +Removes a particular API Release + +## SYNTAX + +### ByApiReleaseId (Default) +``` +Remove-AzApiManagementApiRelease -Context -ApiId -ReleaseId + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Remove-AzApiManagementApiRelease -InputObject [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The **Remove-AzApiManagementApiRelease** cmdlet removes an existing API Release. + +## EXAMPLES + +### Example 1: Remove an API Release +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementApiRelease -Context $apimContext -ApiId "echo-api" -ReleaseId "2" +``` + +This command removes the API Release with the specified ApiId and ReleaseId. + +## PARAMETERS + +### -ApiId +Identifier of the API. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByApiReleaseId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ByApiReleaseId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementApiRelease. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. +This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReleaseId +Identifier of the API Release. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByApiReleaseId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementApiRelease](./Get-AzApiManagementApiRelease.md) + +[New-AzApiManagementApiRelease](./New-AzApiManagementApiRelease.md) + +[Update-AzApiManagementApiRelease](./Update-AzApiManagementApiRelease.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiRevision.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiRevision.md new file mode 100644 index 0000000000..db797e2fc4 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiRevision.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementapirevision +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApiRevision.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApiRevision.md +--- + +# Remove-AzApiManagementApiRevision + +## SYNOPSIS +Removed a particular API Revision + +## SYNTAX + +### ByApiId (Default) +``` +Remove-AzApiManagementApiRevision -Context -ApiId -ApiRevision + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Remove-AzApiManagementApiRevision -InputObject [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The cmdlet **Remove-AzApiManagementApiRevision** removes a particular API revision. + +## EXAMPLES + +### Example 1: Remove an API Revision +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementApiRevision -Context $apimContext -ApiId "echo-api" -ApiRevision "2" +``` + +This command removes the `2` revision of the API `echo-api` from API Management service. + +### Example 2 + +This command removes the 2 revision of the API echo-api from API Management service. (autogenerated) + + +```powershell +Remove-AzApiManagementApiRevision -ApiId '0001' -ApiRevision 6 -Context +``` + +## PARAMETERS + +### -ApiId +Identifier of the API. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByApiId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Identifier of the API Revision. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByApiId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ByApiId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementApiRelease. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. +This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementApiRevision](./Get-AzApiManagementApiRevision.md) + +[New-AzApiManagementApiRevision](./New-AzApiManagementApiRevision.md) + +[Set-AzApiManagementApiRevision](./Set-AzApiManagementApiRevision.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiSchema.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiSchema.md new file mode 100644 index 0000000000..8aebb4a4d4 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiSchema.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementapischema +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApiSchema.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApiSchema.md +--- + +# Remove-AzApiManagementApiSchema + +## SYNOPSIS +Removes the API Schema from the API. + +## SYNTAX + +### ByApiSchemaId (Default) +``` +Remove-AzApiManagementApiSchema -Context -ApiId -SchemaId + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Remove-AzApiManagementApiSchema -InputObject [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByResourceIdParameterSet +``` +Remove-AzApiManagementApiSchema -ResourceId [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The cmdlet **Remove-AzApiManagementSchema** from the Api. + +## EXAMPLES + +### Example 1: Removes the Api Schema from the API +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementApiSchema -Context $apimContext -ApiId "echo-api" -SchemaId "2" +``` + +The script removes the Schema `2` from the Api `echo-api` if it is not referenced. + +### Example 2 + +The script removes the Schema 2 from the Api echo-api if it is not referenced. (autogenerated) + + +```powershell +Remove-AzApiManagementApiSchema -ApiId '0001' -Context -SchemaId 5cc9cf67e6ed3b1154e638bd +``` + +## PARAMETERS + +### -ApiId +Identifier of the API. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByApiSchemaId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ByApiSchemaId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementApiSchema. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiSchema +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. +This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of ApiSchema. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaId +Identifier of the API Schema. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByApiSchemaId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiSchema + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementApiSchema](./Get-AzApiManagementApiSchema.md) + +[New-AzApiManagementApiSchema](./New-AzApiManagementApiSchema.md) + +[Set-AzApiManagementApiSchema](./Set-AzApiManagementApiSchema.md) diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiVersionSet.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiVersionSet.md new file mode 100644 index 0000000000..15bea004ee --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementApiVersionSet.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementapiversionset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApiVersionSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementApiVersionSet.md +--- + +# Remove-AzApiManagementApiVersionSet + +## SYNOPSIS +Removes a particular Api Version Set + +## SYNTAX + +### ExpandedParameter (Default) +``` +Remove-AzApiManagementApiVersionSet -Context -ApiVersionSetId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Remove-AzApiManagementApiVersionSet -InputObject [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByResourceId +``` +Remove-AzApiManagementApiVersionSet -ResourceId [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The **Remove-AzAzureRmApiManagementApiVersionSet** cmdlet removes an existing API Version Set. + +## EXAMPLES + +### Example 1: Remove an API Version set +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementApiVersionSet -Context $apimContext -ApiVersionSetId "query-param-set" +``` + +This command removes the API Version Set with the specified ApiVersionSetId. + +## PARAMETERS + +### -ApiVersionSetId +Identifier of the API Version Set. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementApiVersionSet. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. +This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of ApiVersionSet. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementApiVersionSet](./Get-AzApiManagementApiVersionSet.md) + +[New-AzApiManagementApiVersionSet](./New-AzApiManagementApiVersionSet.md) + +[Set-AzApiManagementApiVersionSet](./Set-AzApiManagementApiVersionSet.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementAuthorizationServer.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementAuthorizationServer.md new file mode 100644 index 0000000000..7dcd5308d3 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementAuthorizationServer.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: C2CC10DE-1D36-4937-8A3E-9776BE80DF9A +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementauthorizationserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementAuthorizationServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementAuthorizationServer.md +--- + +# Remove-AzApiManagementAuthorizationServer + +## SYNOPSIS +Removes an authorization server. + +## SYNTAX + +``` +Remove-AzApiManagementAuthorizationServer -Context -ServerId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementAuthorizationServer** cmdlet removes an Azure API Management authorization server. + +## EXAMPLES + +### Example 1: Remove an authorization server +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementAuthorizationServer -Context $ApiMgmtContext -ServerId "authserverid" +``` + +This command removes the specified API Management Authorization Server. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerId +Specifies the ID of the authorization server to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementAuthorizationServer](./Get-AzApiManagementAuthorizationServer.md) + +[New-AzApiManagementAuthorizationServer](./New-AzApiManagementAuthorizationServer.md) + +[Set-AzApiManagementAuthorizationServer](./Set-AzApiManagementAuthorizationServer.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementBackend.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementBackend.md new file mode 100644 index 0000000000..9b50939cc7 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementBackend.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementbackend +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementBackend.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementBackend.md +--- + +# Remove-AzApiManagementBackend + +## SYNOPSIS +Removes a Backend. + +## SYNTAX + +``` +Remove-AzApiManagementBackend -Context -BackendId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Removes a backend specified by the Identifier from the Api Management. + +## EXAMPLES + +### Example 1: Remove the Backend 123 +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementBackend -Context $apimContext -BackendId 123 -PassThru +``` + +## PARAMETERS + +### -BackendId +Identifier of existing backend. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. +This parameter is optional. +Default value is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementBackend](./Get-AzApiManagementBackend.md) + +[New-AzApiManagementBackend](./New-AzApiManagementBackend.md) + +[New-AzApiManagementBackendCredential](./New-AzApiManagementBackendCredential.md) + +[New-AzApiManagementBackendProxy](./New-AzApiManagementBackendProxy.md) + +[Set-AzApiManagementBackend](./Set-AzApiManagementBackend.md) diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementCache.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementCache.md new file mode 100644 index 0000000000..658ef40a65 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementCache.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementcache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementCache.md +--- + +# Remove-AzApiManagementCache + +## SYNOPSIS +Removes the cache entity. + +## SYNTAX + +### ContextParameterSetName (Default) +``` +Remove-AzApiManagementCache -Context -CacheId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObjectParameterSet +``` +Remove-AzApiManagementCache -InputObject [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByResourceIdParameterSet +``` +Remove-AzApiManagementCache -ResourceId [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The cmdlet **Remove-AzApiManagementCache** removes the cache entity. + +## EXAMPLES + +### Example 1 : Remove the Cache entity +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementCache -Context $apimContext -CacheId "centralus" +``` + +This cmdlet remove the cache `centralus` from Api Management service. + +## PARAMETERS + +### -CacheId +Identifier of existing cacheId. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ContextParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ContextParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementCache. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCache +Parameter Sets: ByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. +This parameter is optional. +Default value is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of Cache. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementCache](./New-AzApiManagementCache.md) + +[Get-AzApiManagementCache](./Get-AzApiManagementCache.md) + +[Update-AzApiManagementCache](./Update-AzApiManagementCache.md) diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementCertificate.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementCertificate.md new file mode 100644 index 0000000000..dc4c667a3f --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementCertificate.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 9B261CD8-5209-4C14-A6F8-97D61B641642 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementCertificate.md +--- + +# Remove-AzApiManagementCertificate + +## SYNOPSIS +Removes an API Management certificate. + +## SYNTAX + +``` +Remove-AzApiManagementCertificate -Context -CertificateId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementCertificate** cmdlet removes an Azure API Management certificate. + +## EXAMPLES + +### Example 1: Remove a certificate +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementCertificate -Context $ApiMgmtContext -CertificateId "0123456789" +``` + +This command removes the specified API Management certificate. + +## PARAMETERS + +### -CertificateId +Specifies the ID of the certificate to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementCertificate](./Get-AzApiManagementCertificate.md) + +[New-AzApiManagementCertificate](./New-AzApiManagementCertificate.md) + +[Set-AzApiManagementCertificate](./Set-AzApiManagementCertificate.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementDiagnostic.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementDiagnostic.md new file mode 100644 index 0000000000..49dbfd0d51 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementDiagnostic.md @@ -0,0 +1,214 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementdiagnostic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementDiagnostic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementDiagnostic.md +--- + +# Remove-AzApiManagementDiagnostic + +## SYNOPSIS +Remove the Diagnostic entity from Global or API level scope. + +## SYNTAX + +### ByResourceIdParameterSet (Default) +``` +Remove-AzApiManagementDiagnostic -ResourceId [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### ExpandParameterSetName +``` +Remove-AzApiManagementDiagnostic -Context [-ApiId ] -DiagnosticId + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObjectParameterSet +``` +Remove-AzApiManagementDiagnostic -InputObject [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The cmdlet **Remove-AzApiManagementDiagnostic** removes the diagnostic entity specified by `DiagnosticId` from global scope or an `ApiId` scope + +## EXAMPLES + +### Example 1: Remove the Diagnostic entity +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementDiagnostic -Context $apimContext -DiagnosticId "applicationinsights" +``` + +This example remove the diagnostic `applicationinsights` from the Api Management service. + +## PARAMETERS + +### -ApiId +Identifier of the API. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ExpandParameterSetName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ExpandParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticId +Identifier of existing product. +If specified will return product-scope policy. +This parameters is optional. + +```yaml +Type: System.String +Parameter Sets: ExpandParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementDiagnostic. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementDiagnostic +Parameter Sets: ByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. +This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of Diagnostic. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementDiagnostic](./Get-AzApiManagementDiagnostic.md) + +[New-AzApiManagementDiagnostic](./New-AzApiManagementDiagnostic.md) + +[Set-AzApiManagementDiagnostic](./Set-AzApiManagementDiagnostic.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementGateway.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementGateway.md new file mode 100644 index 0000000000..265095334e --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementGateway.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementGateway.md +--- + +# Remove-AzApiManagementGateway + +## SYNOPSIS +Detaches an API from a Gateway. + +## SYNTAX + +### ContextParameterSetName (Default) +``` +Remove-AzApiManagementGateway -Context -GatewayId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObjectParameterSet +``` +Remove-AzApiManagementGateway -InputObject [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByResourceIdParameterSet +``` +Remove-AzApiManagementGateway -ResourceId [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementGateway** cmdlet detaches an API from a Gateway. + +## EXAMPLES + +### Example 1: Remove an existing gateway +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementGateway -Context $apimContext -GatewayId "g0001" +``` + +This command removes an existing gateway and does not prompt the user for confirmation. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ContextParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayId +Identifier of existing gateway. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ContextParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementGateway. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGateway +Parameter Sets: ByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. +This parameter is optional. +Default value is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the Gateway. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementGatewayHostnameConfiguration.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementGatewayHostnameConfiguration.md new file mode 100644 index 0000000000..50d655af98 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementGatewayHostnameConfiguration.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementgatewayhostnameconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementGatewayHostnameConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementGatewayHostnameConfiguration.md +--- + +# Remove-AzApiManagementGatewayHostnameConfiguration + +## SYNOPSIS +Removes a hostname configuration from the existing Gateway. + +## SYNTAX + +### ContextParameterSetName (Default) +``` +Remove-AzApiManagementGatewayHostnameConfiguration -Context -GatewayId + -GatewayHostnameConfigurationId [-PassThru] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### ByInputObjectParameterSet +``` +Remove-AzApiManagementGatewayHostnameConfiguration -InputObject + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByResourceIdParameterSet +``` +Remove-AzApiManagementGatewayHostnameConfiguration -ResourceId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementGatewayHostnameConfiguration** cmdlet removes a hostname configuration from the existing Gateway. + +## EXAMPLES + +### Example 1: Remove an existing gateway hostname configuration +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementGatewayHostnameConfiguration -Context $apimContext -GatewayId "g0001" -GatewayHostnameConfigurationId "h0001" +``` + +This command removes an existing gateway hostname configuration and does not prompt the user for confirmation. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ContextParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayHostnameConfigurationId +Identifier of existing gateway hostname configuration. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ContextParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GatewayId +Identifier of existing gateway. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ContextParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementGatewayHostnameConfiguration. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGatewayHostnameConfiguration +Parameter Sets: ByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. +This parameter is optional. +Default value is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the GatewayHostnameConfiguration. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementGroup.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementGroup.md new file mode 100644 index 0000000000..71efc9c034 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementGroup.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: B88EC6DB-84AC-4F1D-AD79-0D243E0DC88A +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementGroup.md +--- + +# Remove-AzApiManagementGroup + +## SYNOPSIS +Removes an existing API management group. + +## SYNTAX + +``` +Remove-AzApiManagementGroup -Context -GroupId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementGroup** cmdlet removes an existing API management group. + +## EXAMPLES + +### Example 1: Remove an existing management group +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementGroup -Context $apimContext -GroupId "Group0001" +``` + +This command removes an existing management group named Group0001. + +## PARAMETERS + +### -Context +Specifies the instance of a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +Specifies the identifier of a management group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a value of $True if it succeeds, or a value of $False, otherwise. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementGroup](./Get-AzApiManagementGroup.md) + +[New-AzApiManagementGroup](./New-AzApiManagementGroup.md) + +[Set-AzApiManagementGroup](./Set-AzApiManagementGroup.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementIdentityProvider.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementIdentityProvider.md new file mode 100644 index 0000000000..63f6fc62d9 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementIdentityProvider.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementidentityprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementIdentityProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementIdentityProvider.md +--- + +# Remove-AzApiManagementIdentityProvider + +## SYNOPSIS +Removes an existing Identity Provider Configuration. + +## SYNTAX + +``` +Remove-AzApiManagementIdentityProvider -Context + -Type [-PassThru] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Removes an existing Identity Provider Configuration. + +## EXAMPLES + +### Example 1: Removes the Facebook identity provider settings from ApiManagement service +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementIdentityProvider -Context $apimContext -Type 'Facebook' -PassThru +``` + +Deletes configuration related to Facebook Identity provider configuration. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Identifier of an existing Identity Provider. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType +Parameter Sets: (All) +Aliases: +Accepted values: Facebook, Google, Microsoft, Twitter, Aad, AadB2C + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementIdentityProvider](./New-AzApiManagementIdentityProvider.md) + +[Get-AzApiManagementIdentityProvider](./Get-AzApiManagementIdentityProvider.md) + +[Set-AzApiManagementIdentityProvider](./Set-AzApiManagementIdentityProvider.md) + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementLogger.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementLogger.md new file mode 100644 index 0000000000..e17d2371e6 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementLogger.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 98AD1C84-B147-48EB-94B5-8D77B531F6F8 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementlogger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementLogger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementLogger.md +--- + +# Remove-AzApiManagementLogger + +## SYNOPSIS +Removes an API Management Logger. + +## SYNTAX + +``` +Remove-AzApiManagementLogger -Context -LoggerId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementLogger** cmdlet removes an Azure API Management **Logger**. + +## EXAMPLES + +### Example 1: Remove a logger +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementLogger -Context $apimContext -LoggerId "Logger123" +``` + +This command removes a logger that has the ID Logger123. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoggerId +Specifies the ID of the logger to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementLogger](./Get-AzApiManagementLogger.md) + +[New-AzApiManagementLogger](./New-AzApiManagementLogger.md) + +[Set-AzApiManagementLogger](./Set-AzApiManagementLogger.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementNamedValue.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementNamedValue.md new file mode 100644 index 0000000000..066c128781 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementNamedValue.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementnamedvalue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementNamedValue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementNamedValue.md +--- + +# Remove-AzApiManagementNamedValue + +## SYNOPSIS +Removes an API Management Named Value. + +## SYNTAX + +``` +Remove-AzApiManagementNamedValue -Context -NamedValueId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementNamedValue** cmdlet removes an Azure API Management **Named Value**. + +## EXAMPLES + +### Example 1: Remove the named value +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property11" -PassThru +``` + +This command removes the named value that has the ID Property11. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamedValueId +Identifier of existing named value. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. +This parameter is optional. +Default value is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementOpenIdConnectProvider.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementOpenIdConnectProvider.md new file mode 100644 index 0000000000..b82a30cb32 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementOpenIdConnectProvider.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 80B61E7D-14DC-422A-8EE3-CAC49EF1BE8B +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementopenidconnectprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementOpenIdConnectProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementOpenIdConnectProvider.md +--- + +# Remove-AzApiManagementOpenIdConnectProvider + +## SYNOPSIS +Removes an OpenID Connect provider. + +## SYNTAX + +``` +Remove-AzApiManagementOpenIdConnectProvider -Context -OpenIdConnectProviderId + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementOpenIdConnectProvider** cmdlet removes an OpenID Connect provider for Azure API Management. + +## EXAMPLES + +### Example 1: Remove a provider +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvider01" -PassThru +``` + +This command removes a provider that has the ID OICProvider01. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OpenIdConnectProviderId +Specifies an ID of the provider that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementOpenIdConnectProvider](./Get-AzApiManagementOpenIdConnectProvider.md) + +[New-AzApiManagementOpenIdConnectProvider](./New-AzApiManagementOpenIdConnectProvider.md) + +[Set-AzApiManagementOpenIdConnectProvider](./Set-AzApiManagementOpenIdConnectProvider.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementOperation.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementOperation.md new file mode 100644 index 0000000000..a6d496918c --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementOperation.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: A4A8D996-72A2-4154-98DA-5F84CAA010B9 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementOperation.md +--- + +# Remove-AzApiManagementOperation + +## SYNOPSIS +Removes an existing operation. + +## SYNTAX + +``` +Remove-AzApiManagementOperation -Context -ApiId [-ApiRevision ] + -OperationId [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementOperation** cmdlet removes an existing operation. + +## EXAMPLES + +### Example 1: Remove an existing API Operation +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementOperation -Context $apimContext -ApiId "0123456789" -OperationId "9876543210" +``` + +This command removes an existing API Operation. + +## PARAMETERS + +### -ApiId +Specifies the identifier of the API. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Identifier of API Revision. This parameter is optional. If not specified, the operation will be removed from the currently active api revision. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies an instance of **PsApiManagementContext**. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationId +Specifies the identifier of the API operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a value of $True if it succeeds, or a value of $False, otherwise. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementOperation](./Get-AzApiManagementOperation.md) + +[New-AzApiManagementOperation](./New-AzApiManagementOperation.md) + +[Set-AzApiManagementOperation](./Set-AzApiManagementOperation.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementPolicy.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementPolicy.md new file mode 100644 index 0000000000..6d46d30ede --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementPolicy.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 466AFB8C-C272-4A4F-8E13-A4DBD6EE3A85 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementPolicy.md +--- + +# Remove-AzApiManagementPolicy + +## SYNOPSIS +Removes the API Management policy from a specified scope. + +## SYNTAX + +### RemoveTenantLevel (Default) +``` +Remove-AzApiManagementPolicy -Context [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### RemoveProductLevel +``` +Remove-AzApiManagementPolicy -Context -ProductId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### RemoveApiLevel +``` +Remove-AzApiManagementPolicy -Context -ApiId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### RemoveOperationLevel +``` +Remove-AzApiManagementPolicy -Context -ApiId -OperationId + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementPolicy** cmdlet removes the API Management policy from specified scope. + +## EXAMPLES + +### Example 1: Remove the tenant level policy +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementPolicy -Context $apimContext +``` + +This command removes tenant level policy from API Management. + +### Example 2: Remove the product-scope policy +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementPolicy -Context $apimContext -ProductId "0123456789" +``` + +This command removes product-scope policy from API Management. + +### Example 3: Remove the API-scope policy +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" +``` + +This command removes API-scope policy from API Management. + +### Example 4: Remove the operation-scope policy +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777" +``` + +This command removes operation-scope policy from API Management. + +## PARAMETERS + +### -ApiId +Specifies the identifier of an existing API. +If you specify this parameter, the cmdlet removes the API-scope policy. + +```yaml +Type: System.String +Parameter Sets: RemoveApiLevel, RemoveOperationLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies the instance of the **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationId +Specifies the identifier of an existing operation. +If you specify this parameter with the *ApiId* parameter, this cmdlet removes the operation-scope policy. + +```yaml +Type: System.String +Parameter Sets: RemoveOperationLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, otherwise. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductId +Specifies the identifier of the existing product. +If you specify this parameter, the cmdlet removes the product-scope policy. + +```yaml +Type: System.String +Parameter Sets: RemoveProductLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementPolicy](./Get-AzApiManagementPolicy.md) + +[Set-AzApiManagementPolicy](./Set-AzApiManagementPolicy.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementProduct.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementProduct.md new file mode 100644 index 0000000000..b770c81481 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementProduct.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: D6B7F253-03CD-40BE-87D6-E4AE300A29D5 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementproduct +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementProduct.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementProduct.md +--- + +# Remove-AzApiManagementProduct + +## SYNOPSIS +Removes an existing API Management product. + +## SYNTAX + +``` +Remove-AzApiManagementProduct -Context -ProductId [-DeleteSubscriptions] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementProduct** cmdlet removes an existing API Management product. + +## EXAMPLES + +### Example 1: Remove an existing product and all subscriptions +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementProduct -Context $apimContext -ProductId "0123456789" -DeleteSubscriptions +``` + +This command removes an existing product and all subscriptions. + +## PARAMETERS + +### -Context +Specifies an instance of the **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteSubscriptions +Indicates whether to delete subscriptions to the product. +If you do not set this parameter and subscriptions exists, an exception is thrown. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, if it fails. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductId +Specifies the identifier of the existing product. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementProduct](./Get-AzApiManagementProduct.md) + +[New-AzApiManagementProduct](./New-AzApiManagementProduct.md) + +[Set-AzApiManagementProduct](./Set-AzApiManagementProduct.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementProductFromGroup.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementProductFromGroup.md new file mode 100644 index 0000000000..e151e8d50c --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementProductFromGroup.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 2FD2C5C0-5A5A-4CF0-9260-21B9E3DE52B9 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementproductfromgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementProductFromGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementProductFromGroup.md +--- + +# Remove-AzApiManagementProductFromGroup + +## SYNOPSIS +Removes a product from a group. + +## SYNTAX + +``` +Remove-AzApiManagementProductFromGroup -Context -GroupId -ProductId + [-PassThru] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementProductFromGroup** cmdlet removes a product from an existing group. +In other words, this cmdlet removes the group assignment from a product. + +## EXAMPLES + +### Example 1: Remove a product from a group +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementProductFromGroup -Context $apimContext -GroupId "0001" -ProductId "0123456789" +``` + +This command removes a product from an existing group. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +Specifies the group ID. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a value of $True, if it succeeds, or $False, otherwise. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductId +Specifies the product ID. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Add-AzApiManagementProductToGroup](./Add-AzApiManagementProductToGroup.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementRegion.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementRegion.md new file mode 100644 index 0000000000..e18a744fa0 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementRegion.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 17D7EBD2-FE3F-4D24-A1AA-8C45B9B1FEF5 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementregion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementRegion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementRegion.md +--- + +# Remove-AzApiManagementRegion + +## SYNOPSIS +Removes an existing deployment region from PsApiManagement instance. + +## SYNTAX + +``` +Remove-AzApiManagementRegion -ApiManagement -Location + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementRegion** cmdlet removes instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion** from a collection of **AdditionalRegions** of provided the instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement**. +This cmdlet does not modify deployment by itself but updates the instance of **PsApiManagement** in-memory. +To update a deployment of an API Management, pass the modified **PsApiManagementInstance** to **Set-AzApiManagement**. + +## EXAMPLES + +### Example 1: Remove a region from a PsApiManagement instance +```powershell +Remove-AzApiManagementRegion -ApiManagement $ApiManagement -Location "East US" +``` + +This command removes the region named East US from the **PsApiManagement** instance. + +### Example 2: Remove a region from a PsApiManagement instance using a series of commands +```powershell +Get-AzApiManagement -ResourceGroupName "Contoso" -Name ContosoApi | Remove-AzApiManagementRegion -Location "East US" | Set-AzApiManagement +``` + +This first command gets an instance of **PsApiManagement** from the resource group named Contoso named ContosoApi. +The final command then removes the region named East US from that instance then updates the deployment. + +## PARAMETERS + +### -ApiManagement +Specifies the **PsApiManagement** instance that this cmdlet removes the additional deployment region from. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the region that this cmdlet removes. +Specifies the location of the new deployment region amongst the supported region for Api Management service. +To obtain valid locations, use the cmdlet +Get-AzResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement + +## NOTES + +## RELATED LINKS + +[Add-AzApiManagementRegion](./Add-AzApiManagementRegion.md) + +[Update-AzApiManagementRegion](./Update-AzApiManagementRegion.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementSubscription.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementSubscription.md new file mode 100644 index 0000000000..81aca67780 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementSubscription.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 329EF130-5CC9-4BFF-8561-DE5274018B09 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementSubscription.md +--- + +# Remove-AzApiManagementSubscription + +## SYNOPSIS +Deletes an existing subscription. + +## SYNTAX + +### ExpandedParameter (Default) +``` +Remove-AzApiManagementSubscription -Context -SubscriptionId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Remove-AzApiManagementSubscription -Context -SubscriptionId + -InputObject [-PassThru] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### ByResourceId +``` +Remove-AzApiManagementSubscription -Context -SubscriptionId + -ResourceId [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementSubscription** cmdlet deletes an existing subscription. + +## EXAMPLES + +### Example 1: Delete a subscription +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementSubscription -Context $apimContext -SubscriptionId "0123456789" +``` + +This command deletes an existing subscription. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementSubscription. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscription +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $false, otherwise. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of Subscription. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +Specifies the subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementSubscription](./Get-AzApiManagementSubscription.md) + +[New-AzApiManagementSubscription](./New-AzApiManagementSubscription.md) + +[Set-AzApiManagementSubscription](./Set-AzApiManagementSubscription.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementUser.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementUser.md new file mode 100644 index 0000000000..9d5d190ef1 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementUser.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 441BC2EE-DBB7-4579-BA64-9D3042B7EBD8 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementUser.md +--- + +# Remove-AzApiManagementUser + +## SYNOPSIS +Deletes an existing user. + +## SYNTAX + +``` +Remove-AzApiManagementUser -Context -UserId [-DeleteSubscriptions] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementUser** cmdlet deletes an existing user. + +## EXAMPLES + +### Example 1: Delete a user +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementUser -Context $apimContext -UserId "0123456789" +``` + +This command deletes an existing user. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteSubscriptions +Indicates whether to delete subscriptions to the product. +If this parameter is not specified and a subscription exists, this cmdlet throws an exception. +This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a value of $Ture, if it succeeds, or a value of $False, otherwise. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserId +Specifies the ID of the user to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementUser](./Get-AzApiManagementUser.md) + +[New-AzApiManagementUser](./New-AzApiManagementUser.md) + +[Set-AzApiManagementUser](./Set-AzApiManagementUser.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementUserFromGroup.md b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementUserFromGroup.md new file mode 100644 index 0000000000..e384425430 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Remove-AzApiManagementUserFromGroup.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: F0BDB0EE-1F26-450D-9C68-34C79CE8F778 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/remove-azapimanagementuserfromgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementUserFromGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Remove-AzApiManagementUserFromGroup.md +--- + +# Remove-AzApiManagementUserFromGroup + +## SYNOPSIS +Removes a user from a group. + +## SYNTAX + +``` +Remove-AzApiManagementUserFromGroup -Context -GroupId -UserId + [-PassThru] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Remove-AzApiManagementUserFromGroup** cmdlet removes a user from an existing group. + +## EXAMPLES + +### Example 1: Remove a user from a group +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Remove-AzApiManagementUserFromGroup -Context $apimContext -GroupId "0001" -UserId "0123456789" +``` + +This command removes a user from a group. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +Specifies the ID of the group from which to remove a user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, otherwise. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserId +Specifies the ID of the user to remove from the group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Add-AzApiManagementUserToGroup](./Add-AzApiManagementUserToGroup.md) + +[Get-AzApiManagementUser](./Get-AzApiManagementUser.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Restore-AzApiManagement.md b/azps-10.1.0/Az.ApiManagement/Restore-AzApiManagement.md new file mode 100644 index 0000000000..0c54d825ca --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Restore-AzApiManagement.md @@ -0,0 +1,266 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 022BBF5F-AFF1-45D5-9153-872779FFBAF4 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/restore-azapimanagement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Restore-AzApiManagement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Restore-AzApiManagement.md +--- + +# Restore-AzApiManagement + +## SYNOPSIS + +Restores an API Management Service from the specified Azure Storage blob. + +## SYNTAX + +``` +Restore-AzApiManagement -ResourceGroupName -Name [-StorageContext] + -SourceContainerName -SourceBlobName [-AccessType ] [-IdentityClientId ] + [-PassThru] [-DefaultProfile ] [] +``` + +## DESCRIPTION + +The **Restore-AzApiManagement** cmdlet restores an API Management Service from the specified backup residing in an Azure Storage blob. + +## EXAMPLES + +### Example 1: Restore an API Management service + +```powershell +New-AzStorageAccount -StorageAccountName "ContosoStorage" -Location $location -ResourceGroupName "ContosoGroup02" -Type Standard_LRS +$storageKey = (Get-AzStorageAccountKey -ResourceGroupName "ContosoGroup02" -StorageAccountName "ContosoStorage")[0].Value +$storageContext = New-AzStorageContext -StorageAccountName "ContosoStorage" -StorageAccountKey $storageKey +Restore-AzApiManagement -ResourceGroupName "ContosoGroup" -Name "RestoredContosoApi" -StorageContext $StorageContext -SourceContainerName "ContosoBackups" -SourceBlobName "ContosoBackup.apimbackup" +``` + +This command restores an API Management service from Azure storage blob. + +### Example 2: Restore an API Management service using Managed Identity Credentials +```powershell +$storageContext=New-AzStorageContext -StorageAccountName apimbackupmsi +$resourceGroupName="ContosoGroup02"; +$apiManagementName="contosoapi"; +$containerName="apimbackupcontainer"; +$backupName="test-sdk-backup-1"; +$msiClientId="a6270d0c-7d86-478b-8cbe-dc9047ba54f7" +Restore-AzApiManagement -ResourceGroupName $resourceGroupName -Name $apiManagementName -StorageContext $storageContext -SourceContainerName $containerName -SourceBlobName $backupName -AccessType "UserAssignedManagedIdentity" -IdentityClientId $msiClientId -PassThru +``` + +```output +PublicIPAddresses : {52.143.79.150} +PrivateIPAddresses : +Id : /subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/ContosoGroup02/providers/Microsoft.ApiManagement/service/contosoapi +Name : contosoapi +Location : West US 2 +Sku : Premium +Capacity : 1 +CreatedTimeUtc : 10/13/2021 5:49:32 PM +ProvisioningState : Succeeded +RuntimeUrl : https://contosoapi.azure-api.net +RuntimeRegionalUrl : https://contosoapi-westus2-01.regional.azure-api.net +PortalUrl : https://contosoapi.portal.azure-api.net +DeveloperPortalUrl : https://contosoapi.developer.azure-api.net +ManagementApiUrl : https://contosoapi.management.azure-api.net +ScmUrl : https://contosoapi.scm.azure-api.net +PublisherEmail : foobar@microsoft.com +OrganizationName : fsdfsdfs +NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com +VirtualNetwork : +VpnType : None +PortalCustomHostnameConfiguration : +ProxyCustomHostnameConfiguration : {contosoapi.azure-api.net} +ManagementCustomHostnameConfiguration : +ScmCustomHostnameConfiguration : +DeveloperPortalHostnameConfiguration : +SystemCertificates : +Tags : {} +AdditionalRegions : {} +SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting +Identity : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementServiceIdentity +EnableClientCertificate : +Zone : +DisableGateway : False +MinimalControlPlaneApiVersion : +PublicIpAddressId : +PlatformVersion : stv2 +PublicNetworkAccess : Enabled +PrivateEndpointConnections : +ResourceGroupName : ContosoGroup02 +``` + +This command restores the API Management service using the Managed Identity credentials of APIM which are whitelisted as StorageBlobContributor on the Azure Storage Account `apimbackupmsi` + +## PARAMETERS + +### -AccessType + +The type of access to be used for the storage account. The default value is AccessKey. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityClientId + +The Client ID of user assigned managed identity. Required only if accessType is set to UserAssignedManagedIdentity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +Specifies the name of the API Management instance that will be restored with the backup. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru + +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specifies the name of resource group under which API Management exists. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceBlobName + +Specifies the name of the Azure storage backup source blob. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceContainerName + +Specifies the name of the Azure storage backup source container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageContext + +Specifies the storage connection context. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement + +## NOTES + +## RELATED LINKS + +[Backup-AzApiManagement](./Backup-AzApiManagement.md) + +[Get-AzApiManagement](./Get-AzApiManagement.md) + +[New-AzApiManagement](./New-AzApiManagement.md) + +[Remove-AzApiManagement](./Remove-AzApiManagement.md) diff --git a/azps-10.1.0/Az.ApiManagement/Save-AzApiManagementTenantGitConfiguration.md b/azps-10.1.0/Az.ApiManagement/Save-AzApiManagementTenantGitConfiguration.md new file mode 100644 index 0000000000..3f075cf26b --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Save-AzApiManagementTenantGitConfiguration.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 6221C40F-63FC-4D66-B6BD-01024AFF3B65 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/save-azapimanagementtenantgitconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Save-AzApiManagementTenantGitConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Save-AzApiManagementTenantGitConfiguration.md +--- + +# Save-AzApiManagementTenantGitConfiguration + +## SYNOPSIS +Saves changes by creating a commit for current configuration. + +## SYNTAX + +``` +Save-AzApiManagementTenantGitConfiguration -Context -Branch [-Force] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Save-AzApiManagementTenantGitConfiguration** cmdlet saves the changes by creating a commit that contains the current configuration snapshot to a branch in the repository. + +## EXAMPLES + +### Example 1: Save changes to configuration +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Save-AzApiManagementTenantGitConfiguration -Context $apimContext -Branch 'master' -PassThru +``` + +This command saves the changes by creating a commit with the current configuration snapshot to the specified branch in the repository. + +## PARAMETERS + +### -Branch +Specifies the name of the Git branch in which to commit the current configuration snapshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies that this cmdlet commits the current configuration database to the Git repository, even if the Git repository has newer changes that are overwritten. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **PsApiManagementOperationResult** object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperationResult + +## NOTES + +## RELATED LINKS + +[Publish-AzApiManagementTenantGitConfiguration](./Publish-AzApiManagementTenantGitConfiguration.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagement.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagement.md new file mode 100644 index 0000000000..20c5edafe0 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagement.md @@ -0,0 +1,308 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagement.md +--- + +# Set-AzApiManagement + +## SYNOPSIS + +Updates an Azure Api Management service + +## SYNTAX + +``` +Set-AzApiManagement -InputObject [-SystemAssignedIdentity] [-UserAssignedIdentity ] + [-AsJob] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The **Set-AzApiManagement** cmdlet updates an Azure API Management service. + +## EXAMPLES + +### Example 1: Get an API Management service and scale it to Premium and Add a region + +```powershell +$apim = Get-AzApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi" +$apim.Sku = "Premium" +$apim.Capacity = 5 +$apim.AddRegion("Central US", "Premium", 3) +Set-AzApiManagement -InputObject $apim +``` + +This example gets an Api Management instance, scales it to five premium units and then adds an additional three units to the premium region. + +### Example 2: Update deployment (external VNET) + +```powershell +$virtualNetwork = New-AzApiManagementVirtualNetwork -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-WestUS/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet" +$apim = Get-AzApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi" +$apim.VpnType = "External" +$apim.VirtualNetwork = $virtualNetwork +Set-AzApiManagement -InputObject $apim +``` + +This command updates an existing API Management deployment and joins to an external *VpnType*. + +### Example 3: Create and initialize an instance of PsApiManagementCustomHostNameConfiguration using an Secret from KeyVault Resource + +```powershell +$portal = New-AzApiManagementCustomHostnameConfiguration -Hostname "portal.contoso.com" -HostnameType Portal -KeyVaultId "https://apim-test-keyvault.vault.azure.net/secrets/api-portal-custom-ssl.pfx" +$proxy1 = New-AzApiManagementCustomHostnameConfiguration -Hostname "gatewayl.contoso.com" -HostnameType Proxy -KeyVaultId "https://apim-test-keyvault.vault.azure.net/secrets/contoso-proxy-custom-ssl.pfx" +$proxy2 = New-AzApiManagementCustomHostnameConfiguration -Hostname "gatewayl.foobar.com" -HostnameType Proxy -KeyVaultId "https://apim-test-keyvault.vault.azure.net/secrets/foobar-proxy-custom-ssl.pfx" +$proxyCustomConfig = @($proxy1,$proxy2) +$apim = Get-AzApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi" +$apim.PortalCustomHostnameConfiguration = $portal +$apim.ProxyCustomHostnameConfiguration = $proxyCustomConfig +Set-AzApiManagement -InputObject $apim -SystemAssignedIdentity +``` + +### Example 4: Update Publisher Email, NotificationSender Email and Organization Name + +```powershell +$apim = Get-AzApiManagement -ResourceGroupName "api-Default-West-US" -Name "Contoso" +$apim.PublisherEmail = "foobar@contoso.com" +$apim.NotificationSenderEmail = "notification@contoso.com" +$apim.OrganizationName = "Contoso" +Set-AzApiManagement -InputObject $apim -PassThru +``` + +### Example 5: Add Managed Certificate to an APIM Service + + +```powershell +$gateway=New-AzApiManagementCustomHostnameConfiguration -Hostname freecertCanary.contoso.api -HostnameType Proxy -ManagedCertificate +$customConfig= @($gateway) +$apim=Get-AzApiManagement -ResourceGroupName contosogroup -Name contosoapim +$apim.ProxyCustomHostnameConfiguration = $customConfig +Set-AzApiManagement -InputObject $apim -PassThru + + +PublicIPAddresses : {20.45.236.81} +PrivateIPAddresses : +Id : /subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/Api-Default- + Central-US-EUAP/providers/Microsoft.ApiManagement/service/contosoapim +Name : contosoapim +Location : Central US EUAP +Sku : Developer +Capacity : 1 +CreatedTimeUtc : 8/24/2021 10:40:21 PM +ProvisioningState : Succeeded +RuntimeUrl : https://contosoapim.azure-api.net +RuntimeRegionalUrl : https://contosoapim-centraluseuap-01.regional.azure-api.net +PortalUrl : https://contosoapim.portal.azure-api.net +DeveloperPortalUrl : https://contosoapim.developer.azure-api.net +ManagementApiUrl : https://contosoapim.management.azure-api.net +ScmUrl : https://contosoapim.scm.azure-api.net +PublisherEmail : zhonren@microsoft.com +OrganizationName : Microsoft +NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com +VirtualNetwork : +VpnType : None +PortalCustomHostnameConfiguration : +ProxyCustomHostnameConfiguration : {contosoapim.azure-api.net, freecertCanary..contoso.api} +ManagementCustomHostnameConfiguration : +ScmCustomHostnameConfiguration : +DeveloperPortalHostnameConfiguration : +SystemCertificates : +Tags : {} +AdditionalRegions : {} +SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting +Identity : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementServiceIdentity +EnableClientCertificate : +Zone : +DisableGateway : False +MinimalControlPlaneApiVersion : +PublicIpAddressId : +PlatformVersion : stv2 +PublicNetworkAccess : Enabled +PrivateEndpointConnections : +ResourceGroupName : contosogroup + +$apim.ProxyCustomHostnameConfiguration + +CertificateInformation : +EncodedCertificate : +HostnameType : Proxy +CertificatePassword : +Hostname : contosoapim.azure-api.net +KeyVaultId : +DefaultSslBinding : False +NegotiateClientCertificate : False +IdentityClientId : +CertificateStatus : +CertificateSource : BuiltIn + +CertificateInformation : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementCertificateInformation +EncodedCertificate : +HostnameType : Proxy +CertificatePassword : +Hostname : freecertCanary.contoso.api +KeyVaultId : +DefaultSslBinding : True +NegotiateClientCertificate : False +IdentityClientId : +CertificateStatus : +CertificateSource : Managed + +``` + +This sample adds a Managed Certificates to an API Management service. + +## PARAMETERS + +### -AsJob + +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +The ApiManagement instance. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +Sends updated PsApiManagement to pipeline if operation succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemAssignedIdentity + +Generate and assign an Azure Active Directory Identity for this server for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity + +Assign User Identities to this server for use with key management services like Azure KeyVault. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagement](./Get-AzApiManagement.md) + +[New-AzApiManagement](./New-AzApiManagement.md) + +[Remove-AzApiManagement](./Remove-AzApiManagement.md) diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementApi.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementApi.md new file mode 100644 index 0000000000..26320ae9c7 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementApi.md @@ -0,0 +1,484 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 29CCF141-CC2F-4E11-8235-64025CFB5782 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementapi +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementApi.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementApi.md +--- + +# Set-AzApiManagementApi + +## SYNOPSIS +Modifies an API. + +## SYNTAX + +### ExpandedParameter (Default) +``` +Set-AzApiManagementApi -Context -ApiId [-Name ] + [-Description ] [-ServiceUrl ] [-Path ] [-Protocols ] + [-AuthorizationServerId ] [-AuthorizationScope ] [-OpenIdProviderId ] + [-BearerTokenSendingMethod ] [-SubscriptionKeyHeaderName ] + [-SubscriptionKeyQueryParamName ] [-SubscriptionRequired] [-PassThru] + [-ApiType ] [-TermsOfServiceUrl ] [-ContactName ] + [-ContactUrl ] [-ContactEmail ] [-LicenseName ] [-LicenseUrl ] + [-DefaultProfile ] [] +``` + +### ByInputObject +``` +Set-AzApiManagementApi -InputObject [-Name ] [-Description ] + [-ServiceUrl ] [-Path ] [-Protocols ] + [-AuthorizationServerId ] [-AuthorizationScope ] [-OpenIdProviderId ] + [-BearerTokenSendingMethod ] [-SubscriptionKeyHeaderName ] + [-SubscriptionKeyQueryParamName ] [-SubscriptionRequired] [-PassThru] + [-ApiType ] [-TermsOfServiceUrl ] [-ContactName ] + [-ContactUrl ] [-ContactEmail ] [-LicenseName ] [-LicenseUrl ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzApiManagementApi** cmdlet modifies an Azure API Management API. + +## EXAMPLES + +### Example 1: Modify an API +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo" +``` + +### Example 2: Add an API to an existing ApiVersionSet +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$versionSet = New-AzApiManagementApiVersionSet -Context $context -Name "Echo API Version Set" -Scheme Segment -Description "version set sample" +$api = Get-AzApiManagementApi -Context $ApiMgmtContext -ApiId "echo-api" +$api.ApiVersionSetId = $versionSet.Id +$api.ApiVersion = "v1" +$api.ApiVersionSetDescription = $versionSet.Description +Set-AzApiManagementApi -InputObject $api -PassThru +``` + +This example adds an API to an existing API Version Set + +### Example 3: Change the Backend ServiceUrl where the API is pointing to +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$updatedApiServiceUrl = "http://newechoapi.cloudapp.net/updateapi" +$updatedApi = Set-AzApiManagementApi -Context $ApiMgmtContext -ApiId $echoApiId -ServiceUrl $updatedApiServiceUrl +``` + +This example updates the ServiceUrl the `echo-api` is pointing to. + +## PARAMETERS + +### -ApiId +Specifies the ID of the API to modify. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiType +Type of API to create (http, soap, websocket, graphql). This parameter is optional. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiType] +Parameter Sets: (All) +Aliases: +Accepted values: Http, Soap, WebSocket, GraphQL + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuthorizationScope +Specifies the OAuth operations scope. +The default value is $Null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuthorizationServerId +Specifies the OAuth authorization server identifier. +The default value is $Null. +You must specify this parameter if *AuthorizationScope* is specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BearerTokenSendingMethod +OpenId authorization server mechanism by which access token is passed to the API. Refer to https://datatracker.ietf.org/doc/html/rfc6749#section-4. This parameter is optional. Default value is $null. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContactEmail +The email address of the contact person/organization. MUST be in the format of an email address. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContactName +The identifying name of the contact person/organization. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContactUrl +The URL pointing to the contact information. MUST be in the format of a URL. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the web API. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementApi. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LicenseName +The license name used for the API. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LicenseUrl +A URL to the Terms of Service for the API. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the web API. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OpenIdProviderId +OpenId authorization server identifier. This parameter is optional. Default value is $null. Must be specified if BearerTokenSendingMethods is specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the web API path, which is the last part of the API's public URL. +This URL is used by API consumers to send requests to the web service, and must be one to 400 characters long. +The default value is $Null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocols +Specifies an array of web API protocols. +psdx_paramvalues http and https. +These are the web protocols over which the API is made available. +The default value is $Null. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[] +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https, Ws, Wss + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceUrl +Specifies the URL of the web service that exposes the API. +This URL is used only by Azure API Management, and is not made public. +The URL must be one to 2000 characters long. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionKeyHeaderName +Specifies the name of the subscription key header. +The default value is $Null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionKeyQueryParamName +Specifies the name of the subscription key query string parameter. +The default value is $Null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionRequired +Flag to enforce SubscriptionRequired for requests to the Api. This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TermsOfServiceUrl +A URL to the Terms of Service for the API. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi + +## NOTES + +## RELATED LINKS + +[Export-AzApiManagementApi](./Export-AzApiManagementApi.md) + +[Get-AzApiManagementApi](./Get-AzApiManagementApi.md) + +[Import-AzApiManagementApi](./Import-AzApiManagementApi.md) + +[New-AzApiManagementApi](./New-AzApiManagementApi.md) + +[Remove-AzApiManagementApi](./Remove-AzApiManagementApi.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementApiRevision.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementApiRevision.md new file mode 100644 index 0000000000..8e9bf552c4 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementApiRevision.md @@ -0,0 +1,406 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementapirevision +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementApiRevision.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementApiRevision.md +--- + +# Set-AzApiManagementApiRevision + +## SYNOPSIS +Modifies an API Revision + +## SYNTAX + +### ExpandedParameter (Default) +``` +Set-AzApiManagementApiRevision -ApiRevision -Context -ApiId + [-Name ] [-Description ] [-ServiceUrl ] [-Path ] + [-Protocols ] [-AuthorizationServerId ] [-AuthorizationScope ] + [-OpenIdProviderId ] [-BearerTokenSendingMethod ] [-SubscriptionKeyHeaderName ] + [-SubscriptionKeyQueryParamName ] [-SubscriptionRequired] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Set-AzApiManagementApiRevision -InputObject [-Name ] [-Description ] + [-ServiceUrl ] [-Path ] [-Protocols ] + [-AuthorizationServerId ] [-AuthorizationScope ] [-OpenIdProviderId ] + [-BearerTokenSendingMethod ] [-SubscriptionKeyHeaderName ] + [-SubscriptionKeyQueryParamName ] [-SubscriptionRequired] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Set-AzApiManagementApiRevision** cmdlet modifies an Azure API Management API Revision. + +## EXAMPLES + +### Example 1: Modify an API Revision +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementApiRevision -Context $ApiMgmtContext -ApiId "echo-api" -ApiRevision "2" -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo" +``` + +The cmdlet updates the `2` revision of the API `echo-api` with a new description, protocol and path. + +## PARAMETERS + +### -ApiId +Identifier of existing API. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Identifier of existing API Revision. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuthorizationScope +OAuth operations scope. +This parameter is optional. +Default value is $null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuthorizationServerId +OAuth authorization server identifier. +This parameter is optional. +Default value is $null. +Must be specified if AuthorizationScope specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BearerTokenSendingMethod +OpenId authorization server mechanism by which access token is passed to the API. Refer to https://datatracker.ietf.org/doc/html/rfc6749#section-4. This parameter is optional. Default value is $null. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Web API description. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementApi. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Web API name. +Public name of the API as it would appear on the developer and admin portals. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OpenIdProviderId +OpenId authorization server identifier. This parameter is optional. Default value is $null. Must be specified if BearerTokenSendingMethods is specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi type representing the set API. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Web API Path. +Last part of the API's public URL. +This URL will be used by API consumers for sending requests to the web service. +Must be 1 to 400 characters long. +This parameter is optional. +Default value is $null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocols +Web API protocols (http, https). +Protocols over which API is made available. +This parameter is required. +Default value is $null. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[] +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceUrl +A URL of the web service exposing the API. +This URL will be used by Azure API Management only, and will not be made public. +Must be 1 to 2000 characters long. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionKeyHeaderName +Subscription key header name. +This parameter is optional. +Default value is $null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionKeyQueryParamName +Subscription key query string parameter name. +This parameter is optional. +Default value is $null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionRequired +Flag to enforce SubscriptionRequired for requests to the Api. This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementApiRevision](./Get-AzApiManagementApiRevision.md) + +[New-AzApiManagementApiRevision](./New-AzApiManagementApiRevision.md) + +[Remove-AzApiManagementApiRevision](./Remove-AzApiManagementApiRevision.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementApiSchema.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementApiSchema.md new file mode 100644 index 0000000000..6dc446798f --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementApiSchema.md @@ -0,0 +1,272 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementapischema +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementApiSchema.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementApiSchema.md +--- + +# Set-AzApiManagementApiSchema + +## SYNOPSIS +Modifies an API Schema + +## SYNTAX + +### ExpandedParameter (Default) +``` +Set-AzApiManagementApiSchema -Context -ApiId -SchemaId + [-SchemaDocumentContentType ] [-SchemaDocument ] [-SchemaDocumentFilePath ] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Set-AzApiManagementApiSchema -InputObject [-SchemaDocumentContentType ] + [-SchemaDocument ] [-SchemaDocumentFilePath ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByResourceId +``` +Set-AzApiManagementApiSchema -ResourceId [-SchemaDocumentContentType ] + [-SchemaDocument ] [-SchemaDocumentFilePath ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Set-AzApiManagementApiSchema** cmdlet modifies an Azure API Management API Schema. + +## EXAMPLES + +### Example 1: Modifies an API Schema +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementApiSchema -Context $ApiMgmtContext -ApiId "echo-api" -SchemaId "2" +``` + +The example updates the Api Schema + +### Example 2 + +Modifies an API Schema. (autogenerated) + + +```powershell +Set-AzApiManagementApiSchema -ApiId 'echo-api' -Context -SchemaDocumentContentType swaggerdefinition -SchemaDocumentFilePath C:\Users\sasolank\Downloads\petstoreschema.json -SchemaId '2' +``` + +## PARAMETERS + +### -ApiId +Identifier of existing API. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementApiSchema. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiSchema +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi type representing the set API. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of Diagnostic or Api Schema. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaDocument +Api schema document as a string. This parameter is required is -SchemaDocumentFile is not specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchemaDocumentContentType +ContentType of the api Schema. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchemaDocumentFilePath +Api schema document file path. This parameter is required is -SchemaDocument is not specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchemaId +Identifier of existing Schema. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiSchema + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementApiSchema](./Get-AzApiManagementApiSchema.md) + +[New-AzApiManagementApiSchema](./New-AzApiManagementApiSchema.md) + +[Remove-AzApiManagementApiSchema](./Remove-AzApiManagementApiSchema.md) + diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementApiVersionSet.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementApiVersionSet.md new file mode 100644 index 0000000000..f84bf24b5a --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementApiVersionSet.md @@ -0,0 +1,260 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementapiversionset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementApiVersionSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementApiVersionSet.md +--- + +# Set-AzApiManagementApiVersionSet + +## SYNOPSIS +Updates an API Version Set in the API Management Context. + +## SYNTAX + +### ExpandedParameter (Default) +``` +Set-AzApiManagementApiVersionSet -Context -ApiVersionSetId [-Name ] + [-Scheme ] [-HeaderName ] [-QueryName ] + [-Description ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### ByInputObject +``` +Set-AzApiManagementApiVersionSet -InputObject [-Name ] + [-Scheme ] [-HeaderName ] [-QueryName ] + [-Description ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The **Set-AzApiManagementApiVersionSet** cmdlet modifies an Azure API Management API Version Set. + +## EXAMPLES + +### Example 1 +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementApiVersionSet -Context $ApiMgmtContext -ApiVersionSetId "query-verion-set" -Scheme Header -HeaderName "api-version" -Description "Azure version header string" +``` + +This command updates an existing API Version Set with versioning scheme `Header` and Header parameter `api-version`. + +## PARAMETERS + +### -ApiVersionSetId +Identifier for new API Version Set. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the Api Version set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HeaderName +The Header value which will contain the versioning information. +If versioning Scheme HEADER is chosen, then this value must be specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementApiVersionSet. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ApiVersion Set. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet type representing the modified apiVersionSet will be written to output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryName +The Query value which will contain the versioning information. +If versioning Scheme Query is chosen, then this value must be specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scheme +Versioning Scheme to select for the Api Versioning Set. +This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementVersioningScheme +Parameter Sets: (All) +Aliases: +Accepted values: Segment, Query, Header + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementVersioningScheme + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementApiVersionSet](./Get-AzApiManagementApiVersionSet.md) + +[New-AzApiManagementApiVersionSet](./New-AzApiManagementApiVersionSet.md) + +[Set-AzApiManagementApiVersionSet](./Set-AzApiManagementApiVersionSet.md) diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementAuthorizationServer.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementAuthorizationServer.md new file mode 100644 index 0000000000..8741db05b8 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementAuthorizationServer.md @@ -0,0 +1,406 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 93005775-3AB9-43C5-B353-45B82124ADB7 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementauthorizationserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementAuthorizationServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementAuthorizationServer.md +--- + +# Set-AzApiManagementAuthorizationServer + +## SYNOPSIS +Modifies an authorization server. + +## SYNTAX + +``` +Set-AzApiManagementAuthorizationServer -Context -ServerId -Name + [-Description ] -ClientRegistrationPageUrl -AuthorizationEndpointUrl + -TokenEndpointUrl -ClientId [-ClientSecret ] + [-AuthorizationRequestMethods ] + -GrantTypes + -ClientAuthenticationMethods [-TokenBodyParameters ] + [-SupportState ] [-DefaultScope ] + -AccessTokenSendingMethods [-ResourceOwnerUsername ] + [-ResourceOwnerPassword ] [-PassThru] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzApiManagementAuthorizationServer** cmdlet modifies Azure API Management authorization server details. + +## EXAMPLES + +### Example 1: Modify an authorization server +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementAuthorizationServer -Context $ApiMgmtContext -ServerId 0123456789 -Name "Contoso OAuth2 server" -ClientRegistrationPageUrl "https://contoso/signupv2" -AuthorizationEndpointUrl "https://contoso/authv2" -TokenEndpointUrl "https://contoso/tokenv2" -ClientId "clientid" -ClientSecret "e041ed1b660b4eadbad5a29d066e6e88" -AuthorizationRequestMethods @('Get') -GrantTypes @( 'AuthorizationCode', 'Implicit', 'ClientCredentials') -ClientAuthenticationMethods @('Basic') -TokenBodyParameters @{'par1'='val1'} -AccessTokenSendingMethods @('AuthorizationHeader') +``` + +This command modifies the specified API Management authorization server. + +### Example 2 + +Modifies an authorization server. (autogenerated) + + +```powershell +Set-AzApiManagementAuthorizationServer -AccessTokenSendingMethods AuthorizationHeader -AuthorizationEndpointUrl 'https://contoso/authv2' -AuthorizationRequestMethods Get -ClientAuthenticationMethods Basic -ClientId 'clientid' -ClientRegistrationPageUrl 'https://contoso/signupv2' -ClientSecret '0000000000000000000000000000000000000' -Context -DefaultScope -GrantTypes AuthorizationCode -Name 'Contoso OAuth2 server' -ServerId 0123456789 -TokenEndpointUrl 'https://contoso/tokenv2' +``` + +## PARAMETERS + +### -AccessTokenSendingMethods +Specifies an array of methods to send an access token. +psdx_paramvalues AuthorizationHeader and Query. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessTokenSendingMethod[] +Parameter Sets: (All) +Aliases: +Accepted values: AuthorizationHeader, Query + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuthorizationEndpointUrl +Specifies the authorization endpoint to authenticate resource owners and obtain authorization grants. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuthorizationRequestMethods +Specifies an array of authorization request methods. +psdx_paramvalues GET and POST. +The default value is GET. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAuthorizationRequestMethod[] +Parameter Sets: (All) +Aliases: +Accepted values: Get, Post, Head, Options, Trace, Put, Patch, Delete + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientAuthenticationMethods +Specifies an array of client authentication methods. +psdx_paramvalues Basic and Body. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementClientAuthenticationMethod[] +Parameter Sets: (All) +Aliases: +Accepted values: Basic, Body + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientId +Specifies the client ID of the developer console that is the client application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientRegistrationPageUrl +Specifies the client registration endpoint to register clients with the authorization server and obtain client credentials. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientSecret +Specifies the client secret of the developer console that is the client application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultScope +Specifies the default scope for the authorization server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +Specifies a description for an authorization server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GrantTypes +Specifies an array of grant types. +psdx_paramvalues +- AuthorizationCode +- ClientCredentials +- Implicit +- ResourceOwnerPassword + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGrantType[] +Parameter Sets: (All) +Aliases: +Accepted values: AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the authorization server to modify. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceOwnerPassword +Specifies the resource owner password. +You must specify this parameter if ResourceOwnerPassword is specified by the *GrantTypes* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceOwnerUsername +Specifies the resource owner user name. +You must specify this parameter if ResourceOwnerPassword is specified by the *GrantTypes* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerId +Specifies the ID of the authorization server to modify. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SupportState +Indicates whether to support the *State* parameter. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TokenBodyParameters +Specifies additional body parameters using application/x-www-form-urlencoded format. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TokenEndpointUrl +Specifies the token endpoint for clients to obtain access tokens in exchange for presenting authorization grants or refresh tokens. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAuthorizationRequestMethod[] + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGrantType[] + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementClientAuthenticationMethod[] + +### System.Collections.Hashtable + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessTokenSendingMethod[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthorizationServer + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementAuthorizationServer](./Get-AzApiManagementAuthorizationServer.md) + +[New-AzApiManagementAuthorizationServer](./New-AzApiManagementAuthorizationServer.md) + +[Remove-AzApiManagementAuthorizationServer](./Remove-AzApiManagementAuthorizationServer.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementBackend.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementBackend.md new file mode 100644 index 0000000000..6d2c40093d --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementBackend.md @@ -0,0 +1,360 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementbackend +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementBackend.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementBackend.md +--- + +# Set-AzApiManagementBackend + +## SYNOPSIS +Updates a Backend. + +## SYNTAX + +### ContextParameterSet (Default) +``` +Set-AzApiManagementBackend -Context -BackendId [-Protocol ] + [-Url ] [-ResourceId ] [-Title ] [-Description ] + [-SkipCertificateChainValidation ] [-SkipCertificateNameValidation ] + [-Credential ] [-Proxy ] + [-ServiceFabricCluster ] [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Set-AzApiManagementBackend -InputObject [-Protocol ] [-Url ] + [-ResourceId ] [-Title ] [-Description ] [-SkipCertificateChainValidation ] + [-SkipCertificateNameValidation ] [-Credential ] + [-Proxy ] [-ServiceFabricCluster ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Updates an existing backend in the Api Management. + +## EXAMPLES + +### Example 1: Updates the Description of the Backend 123 +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementBackend -Context $apimContext -BackendId 123 -Description "updated description" -PassThru +``` + +### Example 2 + +Updates a Backend. (autogenerated) + + +```powershell +Set-AzApiManagementBackend -BackendId 123 -Context -Credential -Protocol http -ResourceId /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso -Url 'https://contoso.com/awesomeapi' +``` + +## PARAMETERS + +### -BackendId +Identifier of new backend. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ContextParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ContextParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Credential +Credential details which should be used when talking to the Backend. +This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Backend Description. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementBackend. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns the **PsApiManagementBackend** that this cmdlet modifies. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocol +Backend Communication protocol (http or soap). +This parameter is optional + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: http, soap + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Proxy +Proxy Server details to be used while sending request to the Backend. +This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendProxy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Management Uri of the Resource in External System. +The absolute http URL of the Azure Resource. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceFabricCluster +Service Fabric Cluster Backend details. This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementServiceFabric +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipCertificateChainValidation +Whether to Skip Certificate Chain Validation when talking to the Backend. +This parameter is optional. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipCertificateNameValidation +Whether to skip Certificate Name Validation when talking to the Backend. +This parameter is optional. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Title +Backend Title. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Url +Runtime Url for the Backend. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendCredential + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendProxy + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementServiceFabric + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementBackend](./Get-AzApiManagementBackend.md) + +[New-AzApiManagementBackend](./New-AzApiManagementBackend.md) + +[New-AzApiManagementBackendCredential](./New-AzApiManagementBackendCredential.md) + +[New-AzApiManagementBackendProxy](./New-AzApiManagementBackendProxy.md) + +[Remove-AzApiManagementBackend](./Remove-AzApiManagementBackend.md) diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementCertificate.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementCertificate.md new file mode 100644 index 0000000000..50b30423e0 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementCertificate.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 12FC21EB-0B4E-4275-88FB-7FF42730A6A0 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementCertificate.md +--- + +# Set-AzApiManagementCertificate + +## SYNOPSIS +Modifies an API Management certificate which is configured for mutual authentication with backend. + +## SYNTAX + +### LoadFromFile (Default) +``` +Set-AzApiManagementCertificate -Context -CertificateId + [-PfxFilePath ] [-PfxPassword ] [-PassThru] [-KeyVault ] + [-DefaultProfile ] [] +``` + +### Raw +``` +Set-AzApiManagementCertificate -Context -CertificateId [-PfxBytes ] + [-PfxPassword ] [-PassThru] [-KeyVault ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzApiManagementCertificate** cmdlet modifies an Azure API Management certificate. + +## EXAMPLES + +### Example 1: Modify a certificate +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementCertificate -Context $ApiMgmtContext -CertificateId "0123456789" -PfxFilePath "C:\contoso\certificates\apimanagementnew.pfx" -PfxPassword "2222" +``` + +This command modifies the specified API Management certificate. + +## PARAMETERS + +### -CertificateId +Specifies the ID of the certificate to modify. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVault +KeyVault used to fetch certificate data.This parameter is required if -PfxFilePath not specified. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementKeyVaultEntity +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PfxBytes +Specifies an array of bytes of the certificate file in .pfx format. +This parameter is required if you do not specify the *PfxFilePath* parameter. + +```yaml +Type: System.Byte[] +Parameter Sets: Raw +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PfxFilePath +Specifies the path to the certificate file in .pfx format to create and upload. +This parameter is required if you do not specify the *PfxBytes* parameter. + +```yaml +Type: System.String +Parameter Sets: LoadFromFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PfxPassword +Specifies the password for the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Byte[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementCertificate](./Get-AzApiManagementCertificate.md) + +[New-AzApiManagementCertificate](./New-AzApiManagementCertificate.md) + +[Remove-AzApiManagementCertificate](./Remove-AzApiManagementCertificate.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementDiagnostic.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementDiagnostic.md new file mode 100644 index 0000000000..a60bad4da9 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementDiagnostic.md @@ -0,0 +1,336 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementdiagnostic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementDiagnostic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementDiagnostic.md +--- + +# Set-AzApiManagementDiagnostic + +## SYNOPSIS +Modifies an API Management diagnostic at the Global or Api scope. + +## SYNTAX + +### ExpandedParameter (Default) +``` +Set-AzApiManagementDiagnostic -Context -DiagnosticId [-ApiId ] + [-LoggerId ] [-AlwaysLog ] [-SamplingSetting ] + [-FrontEndSetting ] + [-BackendSetting ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Set-AzApiManagementDiagnostic -InputObject [-LoggerId ] + [-AlwaysLog ] [-SamplingSetting ] + [-FrontEndSetting ] + [-BackendSetting ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByResourceId +``` +Set-AzApiManagementDiagnostic -ResourceId [-LoggerId ] [-AlwaysLog ] + [-SamplingSetting ] + [-FrontEndSetting ] + [-BackendSetting ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The cmdlet **Set-AzApiManagementDiagnostic** updates the diagnostics which is configured at the Global or Api Scope. + +## EXAMPLES + +### Example 1: Modify a diagnostic at the Global scope + +```powershell +$context =New-AzApiManagementContext -ResourceGroupName Api-Default-WestUS -ServiceName contoso +$diagnostic=Get-AzApiManagementDiagnostic -Context $context -DiagnosticId "applicationinsights" +$diagnostic + +DiagnosticId : applicationinsights +AlwaysLog : allErrors +LoggerId : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/loggers/backendapisachinc +Sampling : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting +Frontend : +Backend : +Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/diagnostics/applicationinsights +ResourceGroupName : Api-Default-WestUS +ServiceName : contoso + + +$diagnostic.Sampling + +SamplingType Percentage +------------ ---------- +fixed 100 + +$diagnostic.Sampling.Percentage = 50 +$diagnostic.Sampling + +SamplingType Percentage +------------ ---------- +fixed 50 + +Set-AzApiManagementDiagnostic -InputObject $diagnostic +``` + +This command modifies the specified diagnostic Sampling Percentage from 100 to 50% + +### Example 2 + +Modifies an API Management diagnostic at the Global or Api scope. (autogenerated) + + +```powershell +Set-AzApiManagementDiagnostic -AlwaysLog allErrors -ApiId '0001' -Context -DiagnosticId 'applicationinsights' -LoggerId 'Logger123' -SamplingSetting +``` + +## PARAMETERS + +### -AlwaysLog +Specifies for what type of messages sampling settings should not apply. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiId +Identifier of existing API. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendSetting +Diagnostic setting for incoming/outgoing Http Messages to the Backend. This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementPipelineDiagnosticSetting +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticId +Identifier of existing Diagnostic. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontEndSetting +Diagnostic setting for incoming/outgoing Http Messages to the Gateway. This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementPipelineDiagnosticSetting +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementDiagnostic. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementDiagnostic +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LoggerId +Identifier of the logger to push diagnostics to. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementDiagnostic type representing the set Diagnostic. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of Diagnostic or Api Diagnostic. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SamplingSetting +Sampling Setting of the Diagnostic. +This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementDiagnostic + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementPipelineDiagnosticSetting + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementDiagnostic + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementGroup.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementGroup.md new file mode 100644 index 0000000000..fd97e89831 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementGroup.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 66D543C0-34F0-47B1-943A-415DECF2155C +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementGroup.md +--- + +# Set-AzApiManagementGroup + +## SYNOPSIS +Configures an API management group. + +## SYNTAX + +``` +Set-AzApiManagementGroup -Context -GroupId [-Name ] + [-Description ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Set-AzApiManagementGroup** cmdlet configures an API management group. + +## EXAMPLES + +### Example 1: Configure a management group +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementGroup -Context $apimContext -GroupId "0001" -Description "Updated Management Group" -Name "Group0001" +``` + +This command configures a management group named Group0001. + +## PARAMETERS + +### -Context +Specifies an instance of a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies the description of the management group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GroupId +Specifies the identifier of the management group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the management group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementGroup](./Get-AzApiManagementGroup.md) + +[New-AzApiManagementGroup](./New-AzApiManagementGroup.md) + +[Remove-AzApiManagementGroup](./Remove-AzApiManagementGroup.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementIdentityProvider.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementIdentityProvider.md new file mode 100644 index 0000000000..e02e196bb2 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementIdentityProvider.md @@ -0,0 +1,331 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementidentityprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementIdentityProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementIdentityProvider.md +--- + +# Set-AzApiManagementIdentityProvider + +## SYNOPSIS +Updates the Configuration of an existing Identity Provider. + +## SYNTAX + +### ExpandedParameter (Default) +``` +Set-AzApiManagementIdentityProvider -Context + -Type [-ClientId ] [-ClientSecret ] + [-AllowedTenants ] [-Authority ] [-SignupPolicyName ] [-SigninPolicyName ] + [-ProfileEditingPolicyName ] [-PasswordResetPolicyName ] [-SigninTenant ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Set-AzApiManagementIdentityProvider -InputObject [-ClientId ] + [-ClientSecret ] [-AllowedTenants ] [-Authority ] [-SignupPolicyName ] + [-SigninPolicyName ] [-ProfileEditingPolicyName ] [-PasswordResetPolicyName ] + [-SigninTenant ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Updates the Configuration of an existing Identity Provider. + +## EXAMPLES + +### Example 1: Update the facebook Identity Provider +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementIdentityProvider -Context $apimContext -Type Facebook -ClientSecret "updatedSecret" -PassThru +``` + +The cmdlet updates the Client Secret of the Facebook Identity Provider; + +### Example 2 + +Updates the Configuration of an existing Identity Provider. (autogenerated) + + +```powershell +Set-AzApiManagementIdentityProvider -AllowedTenants 'samirtestbc.onmicrosoft.com' -Authority -ClientId 'clientid' -ClientSecret 'updatedSecret' -Context -PasswordResetPolicyName -ProfileEditingPolicyName -SigninPolicyName -SignupPolicyName B2C_1_signup-policy -Type Facebook +``` + +## PARAMETERS + +### -AllowedTenants +List of allowed Azure Active Directory Tenants. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Authority +OpenID Connect discovery endpoint hostname for AAD or AAD B2C. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientId +Client Id of the Application in the external Identity Provider. +It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientSecret +Client secret of the Application in external Identity Provider, used to authenticate login request. +For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementIdentityProvider. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns the **PsApiManagementIdentityProvider** that this cmdlet modifies. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PasswordResetPolicyName +Password Reset Policy Name. Only applies to AAD B2C Identity Provider. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProfileEditingPolicyName +Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SigninPolicyName +Signin Policy Name. Only applies to AAD B2C Identity Provider. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SigninTenant +Signin Tenant to override in AAD B2C instead of the `common` Tenant + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SignupPolicyName +Signup Policy Name. Only applies to AAD B2C Identity Provider. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Identifier of an existing Identity Provider. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType +Parameter Sets: ExpandedParameter +Aliases: +Accepted values: Facebook, Google, Microsoft, Twitter, Aad, AadB2C + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType + +### System.String + +### System.String[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementIdentityProvider](./New-AzApiManagementIdentityProvider.md) + +[Get-AzApiManagementIdentityProvider](./Get-AzApiManagementIdentityProvider.md) + +[Remove-AzApiManagementIdentityProvider](./Remove-AzApiManagementIdentityProvider.md) diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementLogger.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementLogger.md new file mode 100644 index 0000000000..110be99380 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementLogger.md @@ -0,0 +1,247 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 5B4ADD38-FA22-4C25-9B9C-FD7861883811 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementlogger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementLogger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementLogger.md +--- + +# Set-AzApiManagementLogger + +## SYNOPSIS +Modifies an API Management Logger. + +## SYNTAX + +### EventHubLoggerSet (Default) +``` +Set-AzApiManagementLogger -Context -LoggerId [-Name ] + [-ConnectionString ] [-Description ] [-IsBuffered] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ApplicationInsightsLoggerSet +``` +Set-AzApiManagementLogger -Context -LoggerId [-InstrumentationKey ] + [-Description ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Set-AzApiManagementLogger** cmdlet modifies settings of an Azure API Management **Logger**. + +## EXAMPLES + +### Example 1: Modify EventHub logger +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementLogger -Context $apimContext -LoggerId "Logger123" -Name "ContosoSdkEventHub" -ConnectionString "Endpoint=sb://ContosoSdkEventHubs.servicebus.windows.net/;SharedAccessKeyName=SendKey;SharedAccessKey=" -Description "updated SDK event hub logger" -PassThru +``` + +This command modifies a logger that has the ID Logger123. + +### Example 2 + +Modifies an API Management Logger. (autogenerated) + + +```powershell +Set-AzApiManagementLogger -Confirm -Context -InstrumentationKey -LoggerId 'Logger123' +``` + +## PARAMETERS + +### -ConnectionString +Specifies an Azure Event Hubs connection string that includes Send policy rights. + +```yaml +Type: System.String +Parameter Sets: EventHubLoggerSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstrumentationKey +Instrumentation Key of the application Insights. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: ApplicationInsightsLoggerSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IsBuffered +Specifies that the records in the logger are buffered before publishing. +When records are buffered, they are sent to Event Hubs every 15 seconds, or whenever the buffer receives 256 KB of messages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EventHubLoggerSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoggerId +Specifies the ID of the logger to update. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the entity name of an event hub from Azure classic portal. + +```yaml +Type: System.String +Parameter Sets: EventHubLoggerSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns the **PsApiManagementLogger** that this cmdlet modifies. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementLogger + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementLogger](./Get-AzApiManagementLogger.md) + +[New-AzApiManagementLogger](./New-AzApiManagementLogger.md) + +[Remove-AzApiManagementLogger](./Remove-AzApiManagementLogger.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementNamedValue.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementNamedValue.md new file mode 100644 index 0000000000..80c3b95256 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementNamedValue.md @@ -0,0 +1,241 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementnamedvalue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementNamedValue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementNamedValue.md +--- + +# Set-AzApiManagementNamedValue + +## SYNOPSIS +Modifies an API Management Named Value. + +## SYNTAX + +``` +Set-AzApiManagementNamedValue -Context -NamedValueId [-Name ] + [-Value ] [-Secret ] [-Tag ] [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Set-AzApiManagementNamedValue** cmdlet modifies an Azure API Management Named Value. + +## EXAMPLES + +### Example 1: Change the tags on the named value +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$Tags = 'sdk', 'powershell' +Set-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property11" -Tag $Tags -PassThru +``` + +The first command assigns two values to the $Tags variable. +The second command modifies the named value that has the ID Property11. +The command assigns the strings in $Tags as tags on the named value. + +### Example 2: Modify the named value to have a secret value +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property12" -Secret $True -PassThru +``` + +This command changes the named value to be Encrypted. + +### Example 3 + +Modifies an API Management Named Value. (autogenerated) + + +```powershell +Set-AzApiManagementNamedValue -Context -Name 'ContosoApi' -NamedValueId 'Property11' -Secret $true -Tag -Value 'Property Value' +``` + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the named value. +Maximum length is 100 characters. +It may contain only letters, digits, period, dash, and underscore characters. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NamedValueId +Identifier of named value to update. +This parameter is mandatory. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProperty type representing the modified property will be written to output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Secret +Whether the named value is a secret and its value should be encrypted. +This parameter is optional. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Tags associated with the named value. +This parameter is optional. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Value of the named value. +Can contain policy expressions. +Maximum length is 1000 characters. +It may not be empty or consist only of whitespace. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementNamedValue + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementOpenIdConnectProvider.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementOpenIdConnectProvider.md new file mode 100644 index 0000000000..26620c7427 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementOpenIdConnectProvider.md @@ -0,0 +1,241 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: F3F21304-CED1-4742-B8BD-2841C4107DCC +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementopenidconnectprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementOpenIdConnectProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementOpenIdConnectProvider.md +--- + +# Set-AzApiManagementOpenIdConnectProvider + +## SYNOPSIS +Modifies an OpenID Connect provider. + +## SYNTAX + +``` +Set-AzApiManagementOpenIdConnectProvider -Context -OpenIdConnectProviderId + [-Name ] [-MetadataEndpointUri ] [-ClientId ] [-ClientSecret ] + [-Description ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Set-AzApiManagementOpenIdConnectProvider** cmdlet modifies an OpenID Connect provider in Azure API Management. + +## EXAMPLES + +### Example 1: Change the client secret for a provider +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvider01" -ClientSecret "q2w3e43r45" -PassThru +``` + +This command modifies the provider that has the ID OICProvider01. +The command specifies a client secret for the provider. + +### Example 2 + +Modifies an OpenID Connect provider. (autogenerated) + + +```powershell +Set-AzApiManagementOpenIdConnectProvider -ClientId 'clientid' -ClientSecret 'q2w3e43r45' -Context -OpenIdConnectProviderId 'OICProvider01' -PassThru +``` + +## PARAMETERS + +### -ClientId +Specifies the client ID of the developer console. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientSecret +Specifies the client secret of the developer console. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MetadataEndpointUri +Specifies a metadata endpoint URI of the provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a friendly name for the provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OpenIdConnectProviderId +Specifies an ID for the provider that this cmdlet modifies. +If you do not specify an ID, this cmdlet generates one. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns the **PsApiManagementOpenIdConnectProvider** that this cmdlet modifies. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOpenIdConnectProvider + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementOpenIdConnectProvider](./Get-AzApiManagementOpenIdConnectProvider.md) + +[New-AzApiManagementOpenIdConnectProvider](./New-AzApiManagementOpenIdConnectProvider.md) + +[Remove-AzApiManagementOpenIdConnectProvider](./Remove-AzApiManagementOpenIdConnectProvider.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementOperation.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementOperation.md new file mode 100644 index 0000000000..1716a8ace8 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementOperation.md @@ -0,0 +1,309 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 67EE6EFB-3297-4D21-A6EC-B03F5FE82F84 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementOperation.md +--- + +# Set-AzApiManagementOperation + +## SYNOPSIS +Sets API operation details. + +## SYNTAX + +``` +Set-AzApiManagementOperation -Context -ApiId [-ApiRevision ] + -OperationId -Name -Method -UrlTemplate [-Description ] + [-TemplateParameters ] [-Request ] + [-Responses ] [-PassThru] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The **Set-AzApiManagementOperation** cmdlet sets API operation details. + +## EXAMPLES + +### Example 1: Set the operation details +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +New-AzApiManagementOperation -Context $apimContext -ApiId $APIID -OperationId $OperationId -Name "Get Resource" -Method GET -UrlTemplate "/newresource" -Description "Use this operation to get newresource" +``` + +This command sets the operation details for API management. + +### Example 2 + +Sets API operation details. (autogenerated) + + +```powershell +Set-AzApiManagementOperation -ApiId '0001' -Context -Method 'GET' -Name 'ContosoApi' -OperationId 'Operation003' -UrlTemplate '/newresource' +``` + +## PARAMETERS + +### -ApiId +Specifies the identifier of the API. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Identifier of API Revision. This parameter is optional. If not specified, the operation will be updated in the currently active api revision. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies an instance of **PsApiManagementContext**. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies the description of the new operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Method +Specifies the HTTP method of the new operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the display name of the new operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OperationId +Specifies the identifier of the existing operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Request +Specifies the operation request details. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRequest +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Responses +Specifies an array of possible operation responses. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameters +Specifies an array or parameters defined in parameter *UrlTemplate*. +If you do not specify a value, a default value will be generated based on the UrlTemplate. +Use the parameter to give more details on parameters such as description, type, and other possible values. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UrlTemplate +Specifies the URL template. +For instance: customers/{cid}/orders/{oid}/?date={date}. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter[] + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRequest + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementOperation](./Get-AzApiManagementOperation.md) + +[New-AzApiManagementOperation](./New-AzApiManagementOperation.md) + +[Remove-AzApiManagementOperation](./Remove-AzApiManagementOperation.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementPolicy.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementPolicy.md new file mode 100644 index 0000000000..c634460f82 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementPolicy.md @@ -0,0 +1,283 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 6CD1C2B8-0416-4FF3-81B0-0C9E59AE6CF9 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementPolicy.md +--- + +# Set-AzApiManagementPolicy + +## SYNOPSIS +Sets the specified scope policy for API Management. + +## SYNTAX + +### SetTenantLevel (Default) +``` +Set-AzApiManagementPolicy -Context [-Format ] [-Policy ] + [-PolicyFilePath ] [-PolicyUrl ] [-PassThru] [-DefaultProfile ] + [] +``` + +### SetProductLevel +``` +Set-AzApiManagementPolicy -Context [-Format ] -ProductId + [-Policy ] [-PolicyFilePath ] [-PolicyUrl ] [-PassThru] + [-DefaultProfile ] [] +``` + +### SetApiLevel +``` +Set-AzApiManagementPolicy -Context [-Format ] -ApiId + [-ApiRevision ] [-Policy ] [-PolicyFilePath ] [-PolicyUrl ] [-PassThru] + [-DefaultProfile ] [] +``` + +### SetOperationLevel +``` +Set-AzApiManagementPolicy -Context [-Format ] -ApiId + [-ApiRevision ] -OperationId [-Policy ] [-PolicyFilePath ] + [-PolicyUrl ] [-PassThru] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzApiManagementPolicy** cmdlet sets the specified scope policy for API Management. + +## EXAMPLES + +### Example 1: Set the tenant level policy +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementPolicy -Context $apimContext -PolicyFilePath "C:\contoso\policies\tenantpolicy.xml" +``` + +This command sets the tenant level policy from a file named tenantpolicy.xml. + +### Example 2: Set a product-scope policy +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementPolicy -Context $apimContext -ProductId "0123456789" -Policy $PolicyString +``` + +This command sets the product-scope policy for API Management. + +### Example 3: Set API-scope policy +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -Policy $PolicyString +``` + +This command sets API-scope policy for API Management. + +### Example 4: Set operation-scope policy +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777" -Policy $PolicyString +``` + +This command sets operation-scope policy for API Management. + +## PARAMETERS + +### -ApiId +Specifies the identifier of the existing API. +If you specify this parameter, the cmdlet sets the API-scope policy. + +```yaml +Type: System.String +Parameter Sets: SetApiLevel, SetOperationLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApiRevision +Identifier of API Revision. This parameter is optional. If not specified, the policy will be updated in the currently active api revision. + +```yaml +Type: System.String +Parameter Sets: SetApiLevel, SetOperationLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies the instance of **PsApiManagementContext**. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +Specifies the format of the policy. When using `application/vnd.ms-azure-apim.policy+xml`, +expressions contained within the policy must be XML-escaped. When using `application/vnd.ms-azure-apim.policy.raw+xml` it +is **not** necessary for the policy to be XML-escaped. +The default value is `application/vnd.ms-azure-apim.policy+xml`. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OperationId +Specifies the identifier of the existing operation. +If specified with ApiId will set operation-scope policy. +This parameters is required. + +```yaml +Type: System.String +Parameter Sets: SetOperationLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Policy +Specifies the policy document as a string. +This parameter is required if the -*PolicyFilePath* is not specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyFilePath +Specifies the policy document file path. +This parameter is required if the *Policy* parameter is not specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyUrl +The Url where the Policy document is hosted. This parameter is required if -Policy or -PolicyFilePath is not specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductId +Specifies the identifier of the existing product. +If this parameter is specified, the cmdlet sets the product-scope policy. + +```yaml +Type: System.String +Parameter Sets: SetProductLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementPolicy](./Get-AzApiManagementPolicy.md) + +[Remove-AzApiManagementPolicy](./Remove-AzApiManagementPolicy.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementProduct.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementProduct.md new file mode 100644 index 0000000000..bb99dc08f0 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementProduct.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 223FBBA6-4405-4B7A-BA63-5F2434A2A50D +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementproduct +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementProduct.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementProduct.md +--- + +# Set-AzApiManagementProduct + +## SYNOPSIS +Sets the API Management product details. + +## SYNTAX + +``` +Set-AzApiManagementProduct -Context -ProductId [-Title ] + [-Description ] [-LegalTerms ] [-SubscriptionRequired ] [-ApprovalRequired ] + [-SubscriptionsLimit ] [-State ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Set-AzApiManagementProduct** cmdlet sets the API Management product details. + +## EXAMPLES + +### Example 1: Update the product details +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementProduct -Context $apimContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms "Free for all" -SubscriptionRequired $True -State "NotPublished" +``` + +This command updates the API Management product details, requires a subscription, and then unpublishes. + +## PARAMETERS + +### -ApprovalRequired +Indicates whether the subscription to the product requires approval. +The default value is **$False**. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies an instance of the **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies the product description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LegalTerms +Specifies the legal terms of use of the product. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProductId +Specifies the identifier of the existing product. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the product state. +psdx_paramvalues +- NotPublished +- Published + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProductState] +Parameter Sets: (All) +Aliases: +Accepted values: NotPublished, Published + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionRequired +Indicates whether the product requires a subscription. +The default value for this parameter is **$True**. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionsLimit +Specifies the maximum number of simultaneous subscriptions. +The default value for this parameter is None. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Title +Specifies the product title this cmdlet sets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProductState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementProduct](./Get-AzApiManagementProduct.md) + +[New-AzApiManagementProduct](./New-AzApiManagementProduct.md) + +[Remove-AzApiManagementProduct](./Remove-AzApiManagementProduct.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementSubscription.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementSubscription.md new file mode 100644 index 0000000000..6df80879f6 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementSubscription.md @@ -0,0 +1,311 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 52115C49-0229-4F2C-B7B0-02FC52C1D32D +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementSubscription.md +--- + +# Set-AzApiManagementSubscription + +## SYNOPSIS +Sets existing subscription details. + +## SYNTAX + +### ByInputObject (Default) +``` +Set-AzApiManagementSubscription -InputObject [-Scope ] [-UserId ] + [-Name ] [-PrimaryKey ] [-SecondaryKey ] [-State ] + [-ExpiresOn ] [-StateComment ] [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### ExpandedParameter +``` +Set-AzApiManagementSubscription -Context -SubscriptionId [-Scope ] + [-UserId ] [-Name ] [-PrimaryKey ] [-SecondaryKey ] + [-State ] [-ExpiresOn ] [-StateComment ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Set-AzApiManagementSubscription** cmdlet sets existing subscription details. + +## EXAMPLES + +### Example 1: Set the state and primary and secondary keys for a subscription +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementSubscription -Context $apimContext -SubscriptionId -0123456789 -PrimaryKey "80450f7d0b6d481382113073f67822c1" -SecondaryKey "97d6112c3a8f48d5bf0266b7a09a761c" -State "Active" +``` + +This command sets the primary and secondary keys for a subscription and activates it. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiresOn +Specifies a subscription expiration date. +The default value of this parameter is $Null. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementSubscription. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscription +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies a subscription name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrimaryKey +Specifies the subscription primary key. +This parameter is generated automatically if not specified. +This parameter must be 1 to 300 characters long. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +The Scope of the Subscription, whether it is Api Scope /apis/{apiId} or Product Scope /products/{productId} or Global API Scope /apis or Global scope /. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryKey +Specifies the subscription secondary key. +This parameter is generated automatically if not specified. +This parameter must be 1 to 300 characters long. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the subscription state. +The default value of this parameter is $Null. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState] +Parameter Sets: (All) +Aliases: +Accepted values: Suspended, Active, Expired, Submitted, Rejected, Cancelled + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StateComment +Specifies the subscription state comment. +The default value of this parameter is $Null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +Specifies the subscription ID. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserId +The owner of the subscription. This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscription + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementSubscription](./Get-AzApiManagementSubscription.md) + +[New-AzApiManagementSubscription](./New-AzApiManagementSubscription.md) + +[Remove-AzApiManagementSubscription](./Remove-AzApiManagementSubscription.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementTenantAccess.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementTenantAccess.md new file mode 100644 index 0000000000..81c7611747 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementTenantAccess.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 3B5FC8E3-5A02-4F3B-81F0-51DFE47A201B +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementtenantaccess +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementTenantAccess.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementTenantAccess.md +--- + +# Set-AzApiManagementTenantAccess + +## SYNOPSIS +Enables or disables tenant access. + +## SYNTAX + +``` +Set-AzApiManagementTenantAccess -Context -Enabled [-PassThru] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzApiManagementTenantAccess** cmdlet enables or disables tenant access. + +## EXAMPLES + +### Example 1: Enable tenant access +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Set-AzApiManagementTenantAccess -Context $apimContext -Enabled $True +``` + +This command enables tenant access in the specified context. + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Specifies whether this cmdlet enables or disables tenant access. +Specify a value of $True to enable or $False to disable. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns the **PsApiManagementAccessInformation** that this cmdlet modifies. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementTenantAccess](./Get-AzApiManagementTenantAccess.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementUser.md b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementUser.md new file mode 100644 index 0000000000..7824b7e4d5 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Set-AzApiManagementUser.md @@ -0,0 +1,270 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 562DE7FA-F2A7-49E9-9273-3C4E2BF8D4B5 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/set-azapimanagementuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Set-AzApiManagementUser.md +--- + +# Set-AzApiManagementUser + +## SYNOPSIS +Sets user details. + +## SYNTAX + +``` +Set-AzApiManagementUser -Context -UserId [-FirstName ] + [-LastName ] [-Email ] [-Password ] [-State ] + [-Note ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Set-AzApiManagementUser** cmdlet sets user details. + +## EXAMPLES + +### Example 1: Change a user's password, email address and state +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +$securePassword = ConvertTo-SecureString "qwerty" -AsPlainText -Force +Set-AzApiManagementUser -Context $apimContext -UserId "0123456789" -Email "patti.fuller@contoso.com" -Password $securePassword -State "Blocked" +``` + +This command sets a new user password and email address and blocks the user. + +### Example 2 + +Sets user details. (autogenerated) + + +```powershell +Set-AzApiManagementUser -Context -Email 'patti.fuller@contoso.com' -FirstName 'Patti' -LastName 'Fuller' -Password -State Active -UserId '0123456789' +``` + +## PARAMETERS + +### -Context +Specifies a **PsApiManagementContext** object. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +Specifies the email address of the user. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FirstName +Specifies the first name of the user. +This parameter must be 1 to 100 characters long. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LastName +Specifies the last name of the user. +This parameter is must be 1 to 100 characters long. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Note +Specifies a note about the user. +This parameter is optional. +The default value of this parameter is $null. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Password +Specifies the user password. +This parameter is optional. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the user state. +This parameter is optional. +The default value is Active. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState +Parameter Sets: (All) +Aliases: +Accepted values: Active, Blocked, Deleted, Pending + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserId +Specifies the user ID. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### System.Security.SecureString + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementUser](./Get-AzApiManagementUser.md) + +[New-AzApiManagementUser](./New-AzApiManagementUser.md) + +[Remove-AzApiManagementUser](./Remove-AzApiManagementUser.md) + + diff --git a/azps-10.1.0/Az.ApiManagement/Sync-AzApiManagementKeyVaultSecret.md b/azps-10.1.0/Az.ApiManagement/Sync-AzApiManagementKeyVaultSecret.md new file mode 100644 index 0000000000..cf9a5f57c9 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Sync-AzApiManagementKeyVaultSecret.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/sync-azapimanagementkeyvaultsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Sync-AzApiManagementKeyVaultSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Sync-AzApiManagementKeyVaultSecret.md +--- + +# Sync-AzApiManagementKeyVaultSecret + +## SYNOPSIS +Refreshes NamedValue or Certificate created by KeyVault. + +## SYNTAX + +### ResourceIdParameterSet (Default) +``` +Sync-AzApiManagementKeyVaultSecret -ResourceId [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### ByInputObject +``` +Sync-AzApiManagementKeyVaultSecret [-InputObjectCert ] + [-InputObjectNamedvalue ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Refreshes NamedValue or Certificate created by KeyVault. + +## EXAMPLES + +### Example 1 +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Get-AzApiManagementCertificate -ResourceId $kvcert.Id | Sync-AzApiManagementKeyVaultSecret +``` + +This command refreshes NamedValue or Certificate created by KeyVault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObjectCert +Instance of PsApiManagementCert. +This parameter or NameValue is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate +Parameter Sets: ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObjectNamedvalue +Instance of PsApiManagementNamedvalue. +This parameter or Certificate is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementNamedValue +Parameter Sets: ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the Keyvault Based object. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementNamedValue + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementKeyVaultEntity + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Update-AzApiManagementApiRelease.md b/azps-10.1.0/Az.ApiManagement/Update-AzApiManagementApiRelease.md new file mode 100644 index 0000000000..a1a74f887f --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Update-AzApiManagementApiRelease.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/update-azapimanagementapirelease +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Update-AzApiManagementApiRelease.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Update-AzApiManagementApiRelease.md +--- + +# Update-AzApiManagementApiRelease + +## SYNOPSIS +Updates a particular Api Release. + +## SYNTAX + +### ExpandedParameter (Default) +``` +Update-AzApiManagementApiRelease -Context -ReleaseId -ApiId + [-Note ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### ByInputObject +``` +Update-AzApiManagementApiRelease [-Note ] -InputObject [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Update-AzApiManagementApiRelease** cmdlet modifies an Azure API Management API Release. + +## EXAMPLES + +### Example 1: Updates an API Release for an API Revision +```powershell +$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Update-AzApiManagementApiRelease -Context $ApiMgmtContext -ApiId "echo-api" -ReleaseId "echo-api-release" -Note "Releasing version 2 of the echo-api to public" +``` + +This command updates the `echo-api-release` API Release of the Api `echo-api` with new note. + +## PARAMETERS + +### -ApiId +Identifier of existing API. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Instance of type Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Note +Api Release Notes. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease type representing the set API Release. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReleaseId +Identifier for the Api Revision ReleaseId. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease + +## NOTES + +## RELATED LINKS + +[Get-AzApiManagementApiRelease](./Get-AzApiManagementApiRelease.md) + +[New-AzApiManagementApiRelease](./New-AzApiManagementApiRelease.md) diff --git a/azps-10.1.0/Az.ApiManagement/Update-AzApiManagementCache.md b/azps-10.1.0/Az.ApiManagement/Update-AzApiManagementCache.md new file mode 100644 index 0000000000..e5c1150464 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Update-AzApiManagementCache.md @@ -0,0 +1,277 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/update-azapimanagementcache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Update-AzApiManagementCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Update-AzApiManagementCache.md +--- + +# Update-AzApiManagementCache + +## SYNOPSIS +updates a cache in Api Management service. + +## SYNTAX + +### ExpandedParameter (Default) +``` +Update-AzApiManagementCache -Context -CacheId [-ConnectionString ] + [-AzureRedisResourceId ] [-Description ] [-UseFromLocation ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Update-AzApiManagementCache -InputObject [-ConnectionString ] + [-AzureRedisResourceId ] [-Description ] [-UseFromLocation ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByResourceId +``` +Update-AzApiManagementCache -ResourceId [-ConnectionString ] [-AzureRedisResourceId ] + [-Description ] [-UseFromLocation ] [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The cmdlet **Update-AzApiManagementCache** updates a cache in the ApiManagement service. + +## EXAMPLES + +### Example 1 : Updates the Description of the Cache in centralus +```powershell +$context=New-AzApiManagementContext -ResourceGroupName Api-Default-Central-US -ServiceName contoso +Update-AzApiManagementCache -Context $context -CacheId centralus -Description "Team new cache" -PassThru +``` + +```output +CacheId : centralus +Description : Team new cache +ConnectionString : {{5cc19889e6ed3b0524c3f7d3}} +AzureRedisResourceId : +Id : /subscriptions/subid/resourceGroups/Api-Default-Central-US/providers/M + icrosoft.ApiManagement/service/contoso/caches/centralus +ResourceGroupName : Api-Default-Central-US +ServiceName : contoso +``` + +Updates the description of the Cache in Central US. + +## PARAMETERS + +### -AzureRedisResourceId +Arm ResourceId of the Azure Redis Cache instance. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CacheId +Identifier of new cache. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConnectionString +Redis Connection String. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Cache Description. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementCache. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCache +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCache type representing the modified cache will be written to output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of Cache. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UseFromLocation +Cache UseFromLocation. This parameter is optional, default value 'default'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCache + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCache + +## NOTES + +## RELATED LINKS + +[New-AzApiManagementCache](./New-AzApiManagementCache.md) + +[Get-AzApiManagementCache](./Get-AzApiManagementCache.md) + +[Remove-AzApiManagementCache](./Remove-AzApiManagementCache.md) diff --git a/azps-10.1.0/Az.ApiManagement/Update-AzApiManagementGateway.md b/azps-10.1.0/Az.ApiManagement/Update-AzApiManagementGateway.md new file mode 100644 index 0000000000..6ce9b86b8f --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Update-AzApiManagementGateway.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml +Module Name: Az.ApiManagement +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/Update-AzApiManagementGateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Update-AzApiManagementGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Update-AzApiManagementGateway.md +--- + +# Update-AzApiManagementGateway + +## SYNOPSIS +Configures an API management Gateway. + +## SYNTAX + +### ExpandedParameter (Default) +``` +Update-AzApiManagementGateway -Context -GatewayId [-Description ] + [-LocationData ] [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Update-AzApiManagementGateway -InputObject [-Description ] + [-LocationData ] [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### ByResourceId +``` +Update-AzApiManagementGateway -ResourceId [-Description ] + [-LocationData ] [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Update-AzApiManagementGateway** cmdlet configures an API management Gateway. + +## EXAMPLES + +### Example 1: Configure a management group +```powershell +$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" +Update-AzApiManagementGateway -Context $apimContext -GatewayId "0001" -Description "Updated Gateway" +``` + +This command configures a gateway. + +## PARAMETERS + +### -Context +Instance of PsApiManagementContext. +This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Gateway description. +This parameter is optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GatewayId +Identifier of existing gateway. +This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ExpandedParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Instance of PsApiManagementGateway. This parameter is required. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGateway +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LocationData +Gateway location. +This parameter is optional. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResourceLocation +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGateway type representing the modified gateway. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the Gateway. This parameter is required. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResourceLocation + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApiManagement/Update-AzApiManagementRegion.md b/azps-10.1.0/Az.ApiManagement/Update-AzApiManagementRegion.md new file mode 100644 index 0000000000..42589d12c1 --- /dev/null +++ b/azps-10.1.0/Az.ApiManagement/Update-AzApiManagementRegion.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.dll-Help.xml +Module Name: Az.ApiManagement +ms.assetid: 5B7B285A-6418-44D7-BD78-E14AFFAA7765 +online version: https://learn.microsoft.com/powershell/module/az.apimanagement/update-azapimanagementregion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Update-AzApiManagementRegion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApiManagement/ApiManagement/help/Update-AzApiManagementRegion.md +--- + +# Update-AzApiManagementRegion + +## SYNOPSIS +Updates existing deployment region in PsApiManagement instance. + +## SYNTAX + +``` +Update-AzApiManagementRegion -ApiManagement -Location -Sku + -Capacity [-VirtualNetwork ] [-Zone ] + [-DisableGateway ] [-PublicIpAddressId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Update-AzApiManagementRegion** cmdlet updates an existing instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion** in a collection of **AdditionalRegions** objects of a provided instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement**. +This cmdlet does not deploy anything but updates an instance of **PsApiManagement** in-memory. +To update a deployment of an API Management use the modified **PsApiManagementInstance** to the Set-AzApiManagement cmdlet. + +## EXAMPLES + +### Example 1: Increases capacity of Additional Region in a PsApiManagement instance +```powershell +$apimService = Get-AzApiManagement -ResourceGroupName $resourceGroupName -Name $apiManagementName +$apimService = Update-AzApiManagementRegion -ApiManagement $apimService -Location "North Central US" -Capacity 2 -Sku Premium +$apimService = Set-AzApiManagement -InputObject $apimService -PassThru +``` + +This command gets the API Management Premium SKU service, having regions in South Central US and North Central US. It then increases the Capacity of the North Central US region to 2 using the **Set-AzApiManagement**. The next cmdlet **Set-AzApiManagement** applies the configuration change to the Api Management service. + +### Example 2 + +Updates existing deployment region in PsApiManagement instance. (autogenerated) + + +```powershell +Update-AzApiManagementRegion -ApiManagement -Capacity 2 -Location 'North Central US' -Sku Developer -VirtualNetwork +``` + +## PARAMETERS + +### -ApiManagement +Specifies the **PsApiManagement** instance to update an existing deployment region in. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Capacity +Specifies the new SKU capacity value for the deployment region. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableGateway +Flag only meant to be used for Premium SKU ApiManagement Service and Non Internal VNET deployments. This is useful in case we want to take a gateway region out of rotation. This can also be used to standup a new region in Passive mode, test it and then make it Live later. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the deployment region to update. +Specifies the location of the new deployment region amongst the supported region for Api Management service. +To obtain valid locations, use the cmdlet +Get-AzResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddressId +Standard SKU PublicIpAddress ResoureId for integration into stv2 Virtual Network Deployments + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +Specifies the new tier value for the deployment region. +Valid values are: +- Developer +- Standard +- Premium + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku +Parameter Sets: (All) +Aliases: +Accepted values: Developer, Standard, Premium, Basic, Consumption, Isolated + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetwork +Specifies a virtual network configuration for the deployment region. +Passing $null will remove virtual network configuration for the region. + +```yaml +Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +A list of availability zones denoting where the api management service is deployed into. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement + +### System.String + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku + +### System.Int32 + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork + +## OUTPUTS + +### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement + +## NOTES + +## RELATED LINKS + +[Add-AzApiManagementRegion](./Add-AzApiManagementRegion.md) + +[Remove-AzApiManagementRegion](./Remove-AzApiManagementRegion.md) + +[Set-AzApiManagement](./Set-AzApiManagement.md) diff --git a/azps-10.1.0/Az.App/Az.App.md b/azps-10.1.0/Az.App/Az.App.md new file mode 100644 index 0000000000..5559b6c984 --- /dev/null +++ b/azps-10.1.0/Az.App/Az.App.md @@ -0,0 +1,136 @@ +--- +Module Name: Az.App +Module Guid: d26b4cc7-1502-410b-9c3d-a553c0d2d624 +Download Help Link: https://learn.microsoft.com/powershell/module/az.app +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Az.App.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Az.App.md +--- + +# Az.App Module +## Description +Microsoft Azure PowerShell: App cmdlets + +## Az.App Cmdlets +### [Disable-AzContainerAppRevision](Disable-AzContainerAppRevision.md) +Deactivates a revision for a Container App + +### [Enable-AzContainerAppRevision](Enable-AzContainerAppRevision.md) +Activates a revision for a Container App + +### [Get-AzContainerApp](Get-AzContainerApp.md) +Get the properties of a Container App. + +### [Get-AzContainerAppAuthConfig](Get-AzContainerAppAuthConfig.md) +Get a AuthConfig of a Container App. + +### [Get-AzContainerAppManagedEnv](Get-AzContainerAppManagedEnv.md) +Get the properties of a Managed Environment used to host container apps. + +### [Get-AzContainerAppManagedEnvCert](Get-AzContainerAppManagedEnvCert.md) +Get the specified Certificate. + +### [Get-AzContainerAppManagedEnvDapr](Get-AzContainerAppManagedEnvDapr.md) +Get a dapr component. + +### [Get-AzContainerAppManagedEnvDaprSecret](Get-AzContainerAppManagedEnvDaprSecret.md) +List secrets for a dapr component + +### [Get-AzContainerAppManagedEnvStorage](Get-AzContainerAppManagedEnvStorage.md) +Get storage for a managedEnvironment. + +### [Get-AzContainerAppRevision](Get-AzContainerAppRevision.md) +Get a revision of a Container App. + +### [Get-AzContainerAppSecret](Get-AzContainerAppSecret.md) +List secrets for a container app + +### [New-AzContainerApp](New-AzContainerApp.md) +Create or update a Container App. + +### [New-AzContainerAppAuthConfig](New-AzContainerAppAuthConfig.md) +Create or update the AuthConfig for a Container App. + +### [New-AzContainerAppCustomDomainObject](New-AzContainerAppCustomDomainObject.md) +Create an in-memory object for CustomDomain. + +### [New-AzContainerAppDaprMetadataObject](New-AzContainerAppDaprMetadataObject.md) +Create an in-memory object for DaprMetadata. + +### [New-AzContainerAppEnvironmentVarObject](New-AzContainerAppEnvironmentVarObject.md) +Create an in-memory object for EnvironmentVar. + +### [New-AzContainerAppIdentityProviderObject](New-AzContainerAppIdentityProviderObject.md) +Create an in-memory object for IdentityProviders. + +### [New-AzContainerAppManagedEnv](New-AzContainerAppManagedEnv.md) +Creates or updates a Managed Environment used to host container apps. + +### [New-AzContainerAppManagedEnvCert](New-AzContainerAppManagedEnvCert.md) +Create or Update a Certificate. + +### [New-AzContainerAppManagedEnvDapr](New-AzContainerAppManagedEnvDapr.md) +Creates or updates a Dapr Component in a Managed Environment. + +### [New-AzContainerAppManagedEnvStorage](New-AzContainerAppManagedEnvStorage.md) +Create or update storage for a managedEnvironment. + +### [New-AzContainerAppProbeHeaderObject](New-AzContainerAppProbeHeaderObject.md) +Create an in-memory object for ContainerAppProbeHttpGetHttpHeadersItem. + +### [New-AzContainerAppProbeObject](New-AzContainerAppProbeObject.md) +Create an in-memory object for ContainerAppProbe. + +### [New-AzContainerAppRegistryCredentialObject](New-AzContainerAppRegistryCredentialObject.md) +Create an in-memory object for RegistryCredentials. + +### [New-AzContainerAppScaleRuleAuthObject](New-AzContainerAppScaleRuleAuthObject.md) +Create an in-memory object for ScaleRuleAuth. + +### [New-AzContainerAppScaleRuleObject](New-AzContainerAppScaleRuleObject.md) +Create an in-memory object for ScaleRule. + +### [New-AzContainerAppSecretObject](New-AzContainerAppSecretObject.md) +Create an in-memory object for Secret. + +### [New-AzContainerAppTemplateObject](New-AzContainerAppTemplateObject.md) +Create an in-memory object for Container. + +### [New-AzContainerAppTrafficWeightObject](New-AzContainerAppTrafficWeightObject.md) +Create an in-memory object for TrafficWeight. + +### [New-AzContainerAppVolumeMountObject](New-AzContainerAppVolumeMountObject.md) +Create an in-memory object for VolumeMount. + +### [New-AzContainerAppVolumeObject](New-AzContainerAppVolumeObject.md) +Create an in-memory object for Volume. + +### [Remove-AzContainerApp](Remove-AzContainerApp.md) +Delete a Container App. + +### [Remove-AzContainerAppAuthConfig](Remove-AzContainerAppAuthConfig.md) +Delete a Container App AuthConfig. + +### [Remove-AzContainerAppManagedEnv](Remove-AzContainerAppManagedEnv.md) +Delete a Managed Environment if it does not have any container apps. + +### [Remove-AzContainerAppManagedEnvCert](Remove-AzContainerAppManagedEnvCert.md) +Deletes the specified Certificate. + +### [Remove-AzContainerAppManagedEnvDapr](Remove-AzContainerAppManagedEnvDapr.md) +Delete a Dapr Component from a Managed Environment. + +### [Remove-AzContainerAppManagedEnvStorage](Remove-AzContainerAppManagedEnvStorage.md) +Delete storage for a managedEnvironment. + +### [Restart-AzContainerAppRevision](Restart-AzContainerAppRevision.md) +Restarts a revision for a Container App + +### [Update-AzContainerApp](Update-AzContainerApp.md) +Patches a Container App using JSON Merge Patch + +### [Update-AzContainerAppManagedEnvCert](Update-AzContainerAppManagedEnvCert.md) +Patches a certificate. +Currently only patching of tags is supported + diff --git a/azps-10.1.0/Az.App/Disable-AzContainerAppRevision.md b/azps-10.1.0/Az.App/Disable-AzContainerAppRevision.md new file mode 100644 index 0000000000..35b2b9d4bd --- /dev/null +++ b/azps-10.1.0/Az.App/Disable-AzContainerAppRevision.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/disable-azcontainerapprevision +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Disable-AzContainerAppRevision.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Disable-AzContainerAppRevision.md +--- + +# Disable-AzContainerAppRevision + +## SYNOPSIS +Deactivates a revision for a Container App + +## SYNTAX + +### Deactivate (Default) +``` +Disable-AzContainerAppRevision -ContainerAppName -ResourceGroupName -RevisionName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeactivateViaIdentity +``` +Disable-AzContainerAppRevision -InputObject [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Deactivates a revision for a Container App + +## EXAMPLES + +### Example 1: Deactivates a revision for a Container App +```powershell +Disable-AzContainerAppRevision -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp -RevisionName azps-containerapp--ksjb6f1 + +Get-AzContainerAppRevision -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp +``` + +```output +Name Active TrafficWeight ProvisioningState ResourceGroupName +---- ------ ------------- ----------------- ----------------- +azps-containerapp--ksjb6f1 False 100 Provisioned azpstest_gp +``` + +Deactivates a revision for a Container App + +## PARAMETERS + +### -ContainerAppName +Name of the Container App. + +```yaml +Type: System.String +Parameter Sets: Deactivate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: DeactivateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Deactivate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RevisionName +Name of the Container App Revision. + +```yaml +Type: System.String +Parameter Sets: Deactivate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Deactivate +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Enable-AzContainerAppRevision.md b/azps-10.1.0/Az.App/Enable-AzContainerAppRevision.md new file mode 100644 index 0000000000..09fc3b4ce4 --- /dev/null +++ b/azps-10.1.0/Az.App/Enable-AzContainerAppRevision.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/enable-azcontainerapprevision +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Enable-AzContainerAppRevision.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Enable-AzContainerAppRevision.md +--- + +# Enable-AzContainerAppRevision + +## SYNOPSIS +Activates a revision for a Container App + +## SYNTAX + +### Activate (Default) +``` +Enable-AzContainerAppRevision -ContainerAppName -ResourceGroupName -RevisionName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ActivateViaIdentity +``` +Enable-AzContainerAppRevision -InputObject [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Activates a revision for a Container App + +## EXAMPLES + +### Example 1: Activates a revision for a Container App +```powershell +Enable-AzContainerAppRevision -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp -RevisionName azps-containerapp--ksjb6f1 + +Get-AzContainerAppRevision -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp +``` + +```output +Name Active TrafficWeight ProvisioningState ResourceGroupName +---- ------ ------------- ----------------- ----------------- +azps-containerapp--ksjb6f1 True 100 Provisioned azpstest_gp +``` + +Activates a revision for a Container App + +## PARAMETERS + +### -ContainerAppName +Name of the Container App. + +```yaml +Type: System.String +Parameter Sets: Activate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: ActivateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Activate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RevisionName +Name of the Container App Revision. + +```yaml +Type: System.String +Parameter Sets: Activate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Activate +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Get-AzContainerApp.md b/azps-10.1.0/Az.App/Get-AzContainerApp.md new file mode 100644 index 0000000000..7b82262d8d --- /dev/null +++ b/azps-10.1.0/Az.App/Get-AzContainerApp.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/get-azcontainerapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerApp.md +--- + +# Get-AzContainerApp + +## SYNOPSIS +Get the properties of a Container App. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerApp [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzContainerApp -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-PassThru] [] +``` + +### GetViaIdentity +``` +Get-AzContainerApp -InputObject [-DefaultProfile ] [-PassThru] [] +``` + +### List1 +``` +Get-AzContainerApp -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get the properties of a Container App. + +## EXAMPLES + +### Example 1: List the properties of a Container App. +```powershell +Get-AzContainerApp +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +Canada Central azcli-containerapp azcli_gp +Canada Central azps-containerapp azpstest_gp +``` + +List the properties of a Container App. + +### Example 2: Get the properties of a Container App by Resource Group. +```powershell +Get-AzContainerApp -ResourceGroupName azpstest_gp +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +Canada Central azps-containerapp azpstest_gp +``` + +Get the properties of a Container App by Resource Group. + +### Example 3: Get the properties of a Container App by name. +```powershell +Get-AzContainerApp -ResourceGroupName azpstest_gp -Name azps-containerapp +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +Canada Central azps-containerapp azpstest_gp +``` + +Get the properties of a Container App by name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Container App. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ContainerAppName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IContainerApp + +## 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 + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Get-AzContainerAppAuthConfig.md b/azps-10.1.0/Az.App/Get-AzContainerAppAuthConfig.md new file mode 100644 index 0000000000..0a11868a24 --- /dev/null +++ b/azps-10.1.0/Az.App/Get-AzContainerAppAuthConfig.md @@ -0,0 +1,176 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/get-azcontainerappauthconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppAuthConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppAuthConfig.md +--- + +# Get-AzContainerAppAuthConfig + +## SYNOPSIS +Get a AuthConfig of a Container App. + +## SYNTAX + +### Get (Default) +``` +Get-AzContainerAppAuthConfig -AuthConfigName -ContainerAppName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzContainerAppAuthConfig -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a AuthConfig of a Container App. + +## EXAMPLES + +### Example 1: Get the Container App AuthConfigs in a given resource group. +```powershell +Get-AzContainerAppAuthConfig -AuthConfigName current -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp +``` + +```output +Name PlatformEnabled ResourceGroupName +---- --------------- ----------------- +current True azpstest_gp +``` + +Get the Container App AuthConfigs in a given resource group. + +## PARAMETERS + +### -AuthConfigName +Name of the Container App AuthConfig. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerAppName +Name of the Container App. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IAuthConfig + +## 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 + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnv.md b/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnv.md new file mode 100644 index 0000000000..4f062463c6 --- /dev/null +++ b/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnv.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/get-azcontainerappmanagedenv +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppManagedEnv.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppManagedEnv.md +--- + +# Get-AzContainerAppManagedEnv + +## SYNOPSIS +Get the properties of a Managed Environment used to host container apps. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerAppManagedEnv [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzContainerAppManagedEnv -EnvName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzContainerAppManagedEnv -InputObject [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzContainerAppManagedEnv -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get the properties of a Managed Environment used to host container apps. + +## EXAMPLES + +### Example 1: List the properties of ManagedEnvironments. +```powershell +Get-AzContainerAppManagedEnv +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +canadacentral azcli-env azcli_gp +canadacentral azps-env azpstest_gp +``` + +List the properties of ManagedEnvironments. + +### Example 2: Get the properties of ManagedEnvironments by Resource Group. +```powershell +Get-AzContainerAppManagedEnv -ResourceGroupName azpstest_gp +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +canadacentral azps-env azpstest_gp +``` + +Get the properties of ManagedEnvironments by Resource Group. + +### Example 3: Get the properties of a ManagedEnvironment by name. +```powershell +Get-AzContainerAppManagedEnv -ResourceGroupName azpstest_gp -EnvName azps-env +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +canadacentral azps-env azpstest_gp +``` + +Get the properties of a ManagedEnvironment by name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Environment. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IManagedEnvironment + +## 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 + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnvCert.md b/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnvCert.md new file mode 100644 index 0000000000..95f18aa387 --- /dev/null +++ b/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnvCert.md @@ -0,0 +1,196 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/get-azcontainerappmanagedenvcert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppManagedEnvCert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppManagedEnvCert.md +--- + +# Get-AzContainerAppManagedEnvCert + +## SYNOPSIS +Get the specified Certificate. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerAppManagedEnvCert -EnvName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzContainerAppManagedEnvCert -EnvName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzContainerAppManagedEnvCert -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get the specified Certificate. + +## EXAMPLES + +### Example 1: List the specified Certificate. +```powershell +Get-AzContainerAppManagedEnvCert -EnvName azps-env -ResourceGroupName azpstest_gp +``` + +```output +Name Location Issuer ProvisioningState SubjectName Thumbprint ResourceGroupName +---- -------- ------ ----------------- ----------- ---------- ----------------- +azps-env-cert canadacentral CN=www.fabrikam.com Succeeded CN=www.fabrikam.com 684DFA8457230B8A04675FBCB7251FA88AE10D80 azpstest_gp +azps-env-cert-02 canadacentral CN=www.fabrikam.com Succeeded CN=www.fabrikam.com 684DFA8457230B8A04675FBCB7251FA88AE10D80 azpstest_gp +``` + +List the specified Certificate. + +### Example 2: Get the specified Certificate. +```powershell +Get-AzContainerAppManagedEnvCert -EnvName azps-env -ResourceGroupName azpstest_gp -Name azps-env-cert +``` + +```output +Name Location Issuer ProvisioningState SubjectName Thumbprint ResourceGroupName +---- -------- ------ ----------------- ----------- ---------- ----------------- +azps-env-cert canadacentral CN=www.fabrikam.com Succeeded CN=www.fabrikam.com 684DFA8457230B8A04675FBCB7251FA88AE10D80 azpstest_gp +``` + +Get the specified Certificate. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Managed Environment. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Certificate. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ICertificate + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnvDapr.md b/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnvDapr.md new file mode 100644 index 0000000000..7e9b73c18d --- /dev/null +++ b/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnvDapr.md @@ -0,0 +1,196 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/get-azcontainerappmanagedenvdapr +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppManagedEnvDapr.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppManagedEnvDapr.md +--- + +# Get-AzContainerAppManagedEnvDapr + +## SYNOPSIS +Get a dapr component. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerAppManagedEnvDapr -EnvName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzContainerAppManagedEnvDapr -DaprName -EnvName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzContainerAppManagedEnvDapr -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a dapr component. + +## EXAMPLES + +### Example 1: List dapr component. +```powershell +Get-AzContainerAppManagedEnvDapr -EnvName azps-env -ResourceGroupName azpstest_gp +``` + +```output +Name ComponentType IgnoreError InitTimeout ResourceGroupName Version +---- ------------- ----------- ----------- ----------------- ------- +azps-dapr state.azure.cosmosdb False 50s azpstest_gp v1 +azps-dapr1 state.azure.cosmosdb True 50s azpstest_gp v1 +``` + +List dapr component. + +### Example 2: Get a dapr component. +```powershell +Get-AzContainerAppManagedEnvDapr -EnvName azps-env -ResourceGroupName azpstest_gp -DaprName azps-dapr1 +``` + +```output +Name ComponentType IgnoreError InitTimeout ResourceGroupName Version +---- ------------- ----------- ----------- ----------------- ------- +azps-dapr1 state.azure.cosmosdb True 50s azpstest_gp v1 +``` + +Get a dapr component. + +## PARAMETERS + +### -DaprName +Name of the Dapr Component. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Managed Environment. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IDaprComponent + +## 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 + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnvDaprSecret.md b/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnvDaprSecret.md new file mode 100644 index 0000000000..5a13709716 --- /dev/null +++ b/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnvDaprSecret.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/get-azcontainerappmanagedenvdaprsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppManagedEnvDaprSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppManagedEnvDaprSecret.md +--- + +# Get-AzContainerAppManagedEnvDaprSecret + +## SYNOPSIS +List secrets for a dapr component + +## SYNTAX + +``` +Get-AzContainerAppManagedEnvDaprSecret -DaprName -EnvName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +List secrets for a dapr component + +## EXAMPLES + +### Example 1: Get secrets for a dapr component. +```powershell +Get-AzContainerAppManagedEnvDaprSecret -EnvName azps-env -ResourceGroupName azpstest_gp -DaprName azps-dapr +``` + +```output +Name Value +---- ----- +masterkey keyvalue +``` + +Get secrets for a dapr component. + +## PARAMETERS + +### -DaprName +Name of the Dapr Component. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Managed Environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ISecret + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnvStorage.md b/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnvStorage.md new file mode 100644 index 0000000000..630d198422 --- /dev/null +++ b/azps-10.1.0/Az.App/Get-AzContainerAppManagedEnvStorage.md @@ -0,0 +1,196 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/get-azcontainerappmanagedenvstorage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppManagedEnvStorage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppManagedEnvStorage.md +--- + +# Get-AzContainerAppManagedEnvStorage + +## SYNOPSIS +Get storage for a managedEnvironment. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerAppManagedEnvStorage -EnvName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzContainerAppManagedEnvStorage -EnvName -ResourceGroupName -StorageName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzContainerAppManagedEnvStorage -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get storage for a managedEnvironment. + +## EXAMPLES + +### Example 1: Get storage for a managedEnvironment. +```powershell +Get-AzContainerAppManagedEnvStorage -EnvName azps-env -ResourceGroupName azpstest_gp +``` + +```output +Name AzureFileAccessMode AzureFileAccountName AzureFileShareName ResourceGroupName +---- ------------------- -------------------- ------------------ ----------------- +azpstestsa ReadWrite azpstestsa azps-rw-sharename azpstest_gp +``` + +Get storage for a managedEnvironment. + +### Example 2: Get storage for a managedEnvironment by StorageName. +```powershell +Get-AzContainerAppManagedEnvStorage -EnvName azps-env -ResourceGroupName azpstest_gp -StorageName azpstestsa +``` + +```output +Name AzureFileAccessMode AzureFileAccountName AzureFileShareName ResourceGroupName +---- ------------------- -------------------- ------------------ ----------------- +azpstestsa ReadWrite azpstestsa azps-rw-sharename azpstest_gp +``` + +Get storage for a managedEnvironment by StorageName. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Environment. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageName +Name of the storage. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IManagedEnvironmentStorage + +## 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 + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Get-AzContainerAppRevision.md b/azps-10.1.0/Az.App/Get-AzContainerAppRevision.md new file mode 100644 index 0000000000..7177e4cff8 --- /dev/null +++ b/azps-10.1.0/Az.App/Get-AzContainerAppRevision.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/get-azcontainerapprevision +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppRevision.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppRevision.md +--- + +# Get-AzContainerAppRevision + +## SYNOPSIS +Get a revision of a Container App. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerAppRevision -ContainerAppName -ResourceGroupName [-SubscriptionId ] + [-Filter ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzContainerAppRevision -ContainerAppName -ResourceGroupName -RevisionName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzContainerAppRevision -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a revision of a Container App. + +## EXAMPLES + +### Example 1: List revisions by Resource Group. +```powershell +Get-AzContainerAppRevision -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp +``` + +```output +Name Active TrafficWeight ProvisioningState ResourceGroupName +---- ------ ------------- ----------------- ----------------- +azps-containerapp--ksjb6f1 True 100 Provisioned azpstest_gp +``` + +List revisions by Resource Group. + +### Example 2: Get a revision of a Container App. +```powershell +Get-AzContainerAppRevision -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp -RevisionName azps-containerapp--ksjb6f1 +``` + +```output +Name Active TrafficWeight ProvisioningState ResourceGroupName +---- ------ ------------- ----------------- ----------------- +azps-containerapp--ksjb6f1 True 100 Provisioned azpstest_gp +``` + +Get a revision of a Container App. + +## PARAMETERS + +### -ContainerAppName +Name of the Container App. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RevisionName +Name of the Container App Revision. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IRevision + +## 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 + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Get-AzContainerAppSecret.md b/azps-10.1.0/Az.App/Get-AzContainerAppSecret.md new file mode 100644 index 0000000000..9a20fa4d41 --- /dev/null +++ b/azps-10.1.0/Az.App/Get-AzContainerAppSecret.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/get-azcontainerappsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Get-AzContainerAppSecret.md +--- + +# Get-AzContainerAppSecret + +## SYNOPSIS +List secrets for a container app + +## SYNTAX + +``` +Get-AzContainerAppSecret -ContainerAppName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +List secrets for a container app + +## EXAMPLES + +### Example 1: List secrets for a container app +```powershell +Get-AzContainerAppSecret -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp +``` + +```output +Name Value +---- ----- +key1 value1 +``` + +List secrets for a container app + +## PARAMETERS + +### -ContainerAppName +Name of the Container App. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IContainerAppSecret + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerApp.md b/azps-10.1.0/Az.App/New-AzContainerApp.md new file mode 100644 index 0000000000..5c595d4737 --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerApp.md @@ -0,0 +1,655 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerApp.md +--- + +# New-AzContainerApp + +## SYNOPSIS +Create or update a Container App. + +## SYNTAX + +``` +New-AzContainerApp -Name -ResourceGroupName -Location [-SubscriptionId ] + [-ConfigurationActiveRevisionsMode ] [-ConfigurationRegistry ] + [-ConfigurationSecret ] [-DaprAppId ] [-DaprAppPort ] + [-DaprAppProtocol ] [-DaprEnabled] [-IdentityType ] + [-IdentityUserAssignedIdentity ] [-IngressAllowInsecure] [-IngressCustomDomain ] + [-IngressExternal] [-IngressTargetPort ] [-IngressTraffic ] + [-IngressTransport ] [-ManagedEnvironmentId ] [-ScaleMaxReplica ] + [-ScaleMinReplica ] [-ScaleRule ] [-Tag ] [-TemplateContainer ] + [-TemplateRevisionSuffix ] [-TemplateVolume ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create or update a Container App. + +## EXAMPLES + +### Example 1: Create or update a Container App. +```powershell +$trafficWeight = New-AzContainerAppTrafficWeightObject -Label production -LatestRevision $True -Weight 100 +$secretObject = New-AzContainerAppSecretObject -Name "facebook-secret" -Value "facebook-password" + +$containerAppHttpHeader = New-AzContainerAppProbeHeaderObject -Name Custom-Header -Value Awesome +$probe = New-AzContainerAppProbeObject -HttpGetPath "/health" -HttpGetPort 8080 -InitialDelaySecond 3 -PeriodSecond 3 -Type Liveness -HttpGetHttpHeader $containerAppHttpHeader +$image = New-AzContainerAppTemplateObject -Name azps-containerapp -Image mcr.microsoft.com/azuredocs/containerapps-helloworld:latest -Probe $probe -ResourceCpu 2.0 -ResourceMemory 4.0Gi + +$EnvId = (Get-AzContainerAppManagedEnv -ResourceGroupName azpstest_gp -EnvName azps-env).Id + +$scaleRule = @() +$scaleRule += New-AzContainerAppScaleRuleObject -Name scaleRuleName1 -AzureQueueLength 30 -AzureQueueName azps_containerapp -CustomType "azure-servicebus" +$scaleRule += New-AzContainerAppScaleRuleObject -Name scaleRuleName2 -AzureQueueLength 30 -AzureQueueName azps_containerapp -CustomType "azure-servicebus" + +New-AzContainerApp -Name azps-containerapp -ResourceGroupName azpstest_gp -Location canadacentral -ConfigurationActiveRevisionsMode 'Single' -ManagedEnvironmentId $EnvId -IngressExternal -IngressTransport 'auto' -IngressTargetPort 80 -TemplateContainer $image -ConfigurationSecret $secretObject -IngressTraffic $trafficWeight -DaprEnabled -DaprAppProtocol 'http' -DaprAppId "container-app-1" -DaprAppPort 8080 -ScaleRule $scaleRule +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +Canada Central azps-containerapp azpstest_gp +``` + +Create or update a Container App. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationActiveRevisionsMode +ActiveRevisionsMode controls how active revisions are handled for the Container app:\\Multiple: multiple revisions can be active.\\Single: Only one revision can be active at a time. +Revision weights can not be used in this mode. +If no value if provided, this is the default.\\ + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.ActiveRevisionsMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationRegistry +Collection of private container registry credentials for containers used by the Container app +To construct, see NOTES section for CONFIGURATIONREGISTRY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IRegistryCredentials[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationSecret +Collection of secrets used by a Container app +To construct, see NOTES section for CONFIGURATIONSECRET properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ISecret[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaprAppId +Dapr application identifier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaprAppPort +Tells Dapr which port your application is listening on + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaprAppProtocol +Tells Dapr which protocol your application is using. +Valid options are http and grpc. +Default is http + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.AppProtocol +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaprEnabled +Boolean indicating if the Dapr side car is enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngressAllowInsecure +Bool indicating if HTTP connections to is allowed. +If set to false HTTP connections are automatically redirected to HTTPS connections + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngressCustomDomain +custom domain bindings for Container Apps' hostnames. +To construct, see NOTES section for INGRESSCUSTOMDOMAIN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ICustomDomain[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngressExternal +Bool indicating if app exposes an external http endpoint + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngressTargetPort +Target Port in containers for traffic from ingress + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngressTraffic +Traffic weights for app's revisions +To construct, see NOTES section for INGRESSTRAFFIC properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ITrafficWeight[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngressTransport +Ingress transport protocol + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.IngressTransportMethod +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedEnvironmentId +Resource ID of the Container App's environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Container App. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ContainerAppName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleMaxReplica +Optional. +Maximum number of container replicas. +Defaults to 10 if not set. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleMinReplica +Optional. +Minimum number of container replicas. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleRule +Scaling rules. +To construct, see NOTES section for SCALERULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IScaleRule[] +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateContainer +List of container definitions for the Container App. +To construct, see NOTES section for TEMPLATECONTAINER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IContainer[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateRevisionSuffix +User friendly suffix that is appended to the revision name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateVolume +List of volume definitions for the Container App. +To construct, see NOTES section for TEMPLATEVOLUME properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IVolume[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IContainerApp + +## 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. + + +`CONFIGURATIONREGISTRY `: Collection of private container registry credentials for containers used by the Container app + - `[Identity ]`: A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system' + - `[PasswordSecretRef ]`: The name of the Secret that contains the registry login password + - `[Server ]`: Container Registry Server + - `[Username ]`: Container Registry Username + +`CONFIGURATIONSECRET `: Collection of secrets used by a Container app + - `[Name ]`: Secret Name. + - `[Value ]`: Secret Value. + +`INGRESSCUSTOMDOMAIN `: custom domain bindings for Container Apps' hostnames. + - `CertificateId `: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. + - `Name `: Hostname. + - `[BindingType ]`: Custom Domain binding type. + +`INGRESSTRAFFIC `: Traffic weights for app's revisions + - `[Label ]`: Associates a traffic label with a revision + - `[LatestRevision ]`: Indicates that the traffic weight belongs to a latest stable revision + - `[RevisionName ]`: Name of a revision + - `[Weight ]`: Traffic weight assigned to a revision + +`SCALERULE `: Scaling rules. + - `[AzureQueueAuth ]`: Authentication secrets for the queue scale rule. + - `[SecretRef ]`: Name of the Container App secret from which to pull the auth params. + - `[TriggerParameter ]`: Trigger Parameter that uses the secret + - `[AzureQueueLength ]`: Queue length. + - `[AzureQueueName ]`: Queue name. + - `[CustomAuth ]`: Authentication secrets for the custom scale rule. + - `[CustomMetadata ]`: Metadata properties to describe custom scale rule. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[CustomType ]`: Type of the custom scale rule eg: azure-servicebus, redis etc. + - `[HttpAuth ]`: Authentication secrets for the custom scale rule. + - `[HttpMetadata ]`: Metadata properties to describe http scale rule. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[Name ]`: Scale Rule Name + +`TEMPLATECONTAINER `: List of container definitions for the Container App. + - `[Arg ]`: Container start command arguments. + - `[Command ]`: Container start command. + - `[Env ]`: Container environment variables. + - `[Name ]`: Environment variable name. + - `[SecretRef ]`: Name of the Container App secret from which to pull the environment variable value. + - `[Value ]`: Non-secret environment variable value. + - `[Image ]`: Container image tag. + - `[Name ]`: Custom container name. + - `[Probe ]`: List of probes for the container. + - `[FailureThreshold ]`: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10. + - `[HttpGetHost ]`: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + - `[HttpGetHttpHeader ]`: Custom headers to set in the request. HTTP allows repeated headers. + - `Name `: The header field name + - `Value `: The header field value + - `[HttpGetPath ]`: Path to access on the HTTP server. + - `[HttpGetPort ]`: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + - `[HttpGetScheme ]`: Scheme to use for connecting to the host. Defaults to HTTP. + - `[InitialDelaySecond ]`: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. + - `[PeriodSecond ]`: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. + - `[SuccessThreshold ]`: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10. + - `[TcpSocketHost ]`: Optional: Host name to connect to, defaults to the pod IP. + - `[TcpSocketPort ]`: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + - `[TerminationGracePeriodSecond ]`: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour) + - `[TimeoutSecond ]`: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. + - `[Type ]`: The type of probe. + - `[ResourceCpu ]`: Required CPU in cores, e.g. 0.5 + - `[ResourceMemory ]`: Required memory, e.g. "250Mb" + - `[VolumeMount ]`: Container volume mounts. + - `[MountPath ]`: Path within the container at which the volume should be mounted.Must not contain ':'. + - `[VolumeName ]`: This must match the Name of a Volume. + +`TEMPLATEVOLUME `: List of volume definitions for the Container App. + - `[Name ]`: Volume name. + - `[StorageName ]`: Name of storage resource. No need to provide for EmptyDir. + - `[StorageType ]`: Storage type for the volume. If not provided, use EmptyDir. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppAuthConfig.md b/azps-10.1.0/Az.App/New-AzContainerAppAuthConfig.md new file mode 100644 index 0000000000..461324df6c --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppAuthConfig.md @@ -0,0 +1,494 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappauthconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppAuthConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppAuthConfig.md +--- + +# New-AzContainerAppAuthConfig + +## SYNOPSIS +Create or update the AuthConfig for a Container App. + +## SYNTAX + +``` +New-AzContainerAppAuthConfig -AuthConfigName -ContainerAppName -ResourceGroupName + [-SubscriptionId ] [-CookieExpirationConvention ] + [-CookieExpirationTimeToExpiration ] [-ForwardProxyConvention ] + [-ForwardProxyCustomHostHeaderName ] [-ForwardProxyCustomProtoHeaderName ] + [-GlobalValidationExcludedPath ] [-GlobalValidationRedirectToProvider ] + [-GlobalValidationUnauthenticatedClientAction ] [-HttpSettingRequireHttps] + [-IdentityProvider ] [-LoginAllowedExternalRedirectUrl ] + [-LoginPreserveUrlFragmentsForLogin] [-NonceExpirationInterval ] [-NonceValidateNonce] + [-PlatformEnabled] [-PlatformRuntimeVersion ] [-RouteApiPrefix ] + [-RouteLogoutEndpoint ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create or update the AuthConfig for a Container App. + +## EXAMPLES + +### Example 1: Create or update the AuthConfig for a Container App. +```powershell +$identity = New-AzContainerAppIdentityProviderObject -RegistrationAppId xxxxxx@xxx.com -RegistrationAppSecretSettingName facebook-secret + +New-AzContainerAppAuthConfig -AuthConfigName current -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp -PlatformEnabled -GlobalValidationUnauthenticatedClientAction 'AllowAnonymous' -IdentityProvider $identity +``` + +```output +Name PlatformEnabled ResourceGroupName +---- --------------- ----------------- +current True azpstest_gp +``` + +Create or update the AuthConfig for a Container App. + +## PARAMETERS + +### -AuthConfigName +Name of the Container App AuthConfig. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerAppName +Name of the Container App. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CookieExpirationConvention +The convention used when determining the session cookie's expiration. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.CookieExpirationConvention +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CookieExpirationTimeToExpiration +The time after the request is made when the session cookie should expire. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardProxyConvention +The convention used to determine the url of the request made. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.ForwardProxyConvention +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardProxyCustomHostHeaderName +The name of the header containing the host of the request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardProxyCustomProtoHeaderName +The name of the header containing the scheme of the request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalValidationExcludedPath +The paths for which unauthenticated flow would not be redirected to the login page. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalValidationRedirectToProvider +The default authentication provider to use when multiple providers are configured.This setting is only needed if multiple providers are configured and the unauthenticated clientaction is set to "RedirectToLoginPage". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalValidationUnauthenticatedClientAction +The action to take when an unauthenticated client attempts to access the app. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.UnauthenticatedClientActionV2 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpSettingRequireHttps +\false\ if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, \true\. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityProvider +The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. +To construct, see NOTES section for IDENTITYPROVIDER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IIdentityProviders +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoginAllowedExternalRedirectUrl +External URLs that can be redirected to as part of logging in or logging out of the app. +Note that the query string part of the URL is ignored.This is an advanced setting typically only needed by Windows Store application backends.Note that URLs within the current domain are always implicitly allowed. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoginPreserveUrlFragmentsForLogin +\true\ if the fragments from the request are preserved after the login request is made; otherwise, \false\. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NonceExpirationInterval +The time after the request is made when the nonce should expire. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NonceValidateNonce +\false\ if the nonce should not be validated while completing the login flow; otherwise, \true\. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlatformEnabled +\true\ if the Authentication / Authorization feature is enabled for the current app; otherwise, \false\. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlatformRuntimeVersion +The RuntimeVersion of the Authentication / Authorization feature in use for the current app.The setting in this value can control the behavior of certain features in the Authentication / Authorization module. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteApiPrefix +The prefix that should precede all the authentication/authorization paths. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteLogoutEndpoint +The endpoint at which a logout request should be made. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IAuthConfig + +## 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. + + +`IDENTITYPROVIDER `: The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. + - `[AllowedPrincipalGroup ]`: The list of the allowed groups. + - `[AllowedPrincipalIdentity ]`: The list of the allowed identities. + - `[AppleEnabled ]`: false if the Apple provider should not be enabled despite the set registration; otherwise, true. + - `[AppleLoginScope ]`: A list of the scopes that should be requested while authenticating. + - `[AppleRegistrationClientId ]`: The Client ID of the app used for login. + - `[AppleRegistrationClientSecretSettingName ]`: The app setting name that contains the client secret. + - `[AzureActiveDirectoryEnabled ]`: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. + - `[AzureActiveDirectoryIsAutoProvisioned ]`: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. + - `[AzureActiveDirectoryRegistrationClientId ]`: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html + - `[AzureActiveDirectoryRegistrationClientSecretSettingName ]`: The app setting name that contains the client secret of the relying party application. + - `[AzureActiveDirectoryValidationAllowedAudience ]`: The list of audiences that can make successful authentication/authorization requests. + - `[AzureStaticWebAppEnabled ]`: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. + - `[AzureStaticWebAppsRegistrationClientId ]`: The Client ID of the app used for login. + - `[CustomOpenIdConnectProvider ]`: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[DefaultAuthorizationPolicyAllowedApplication ]`: The configuration settings of the Azure Active Directory allowed applications. + - `[FacebookEnabled ]`: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. + - `[FacebookGraphApiVersion ]`: The version of the Facebook api to be used while logging in. + - `[FacebookLoginScope ]`: A list of the scopes that should be requested while authenticating. + - `[GitHubEnabled ]`: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. + - `[GitHubLoginScope ]`: A list of the scopes that should be requested while authenticating. + - `[GitHubRegistrationClientId ]`: The Client ID of the app used for login. + - `[GitHubRegistrationClientSecretSettingName ]`: The app setting name that contains the client secret. + - `[GoogleEnabled ]`: false if the Google provider should not be enabled despite the set registration; otherwise, true. + - `[GoogleLoginScope ]`: A list of the scopes that should be requested while authenticating. + - `[GoogleRegistrationClientId ]`: The Client ID of the app used for login. + - `[GoogleRegistrationClientSecretSettingName ]`: The app setting name that contains the client secret. + - `[GoogleValidationAllowedAudience ]`: The configuration settings of the allowed list of audiences from which to validate the JWT token. + - `[JwtClaimCheckAllowedClientApplication ]`: The list of the allowed client applications. + - `[JwtClaimCheckAllowedGroup ]`: The list of the allowed groups. + - `[LoginDisableWwwAuthenticate ]`: true if the www-authenticate provider should be omitted from the request; otherwise, false. + - `[LoginParameter ]`: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". + - `[RegistrationAppId ]`: The App ID of the app used for login. + - `[RegistrationAppSecretSettingName ]`: The app setting name that contains the app secret. + - `[RegistrationClientSecretCertificateIssuer ]`: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. + - `[RegistrationClientSecretCertificateSubjectAlternativeName ]`: An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. + - `[RegistrationClientSecretCertificateThumbprint ]`: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. + - `[RegistrationConsumerKey ]`: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in + - `[RegistrationConsumerSecretSettingName ]`: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. + - `[RegistrationOpenIdIssuer ]`: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html + - `[TwitterEnabled ]`: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppCustomDomainObject.md b/azps-10.1.0/Az.App/New-AzContainerAppCustomDomainObject.md new file mode 100644 index 0000000000..cf80c557cc --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppCustomDomainObject.md @@ -0,0 +1,104 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappcustomdomainobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppCustomDomainObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppCustomDomainObject.md +--- + +# New-AzContainerAppCustomDomainObject + +## SYNOPSIS +Create an in-memory object for CustomDomain. + +## SYNTAX + +``` +New-AzContainerAppCustomDomainObject -CertificateId -Name [-BindingType ] + [] +``` + +## DESCRIPTION +Create an in-memory object for CustomDomain. + +## EXAMPLES + +### Example 1: Create a CustomDomain object for ContainerApp. +```powershell +$certificateId = (Get-AzContainerAppManagedEnvCert -EnvName azps-env -ResourceGroupName azpstest_gp -Name azps-env-cert).Id + +$customDomain = New-AzContainerAppCustomDomainObject -CertificateId $certificateId -Name www.fabrikam.com -BindingType SniEnabled +``` + +```output +BindingType CertificateId Name +----------- ------------- ---- +SniEnabled /subscriptions/{subscriptionid}/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com www.my-name.com +``` + +Create a CustomDomain object for ContainerApp. + +## PARAMETERS + +### -BindingType +Custom Domain binding type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.BindingType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateId +Resource Id of the Certificate to be bound to this hostname. +Must exist in the Managed Environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Hostname. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.CustomDomain + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppDaprMetadataObject.md b/azps-10.1.0/Az.App/New-AzContainerAppDaprMetadataObject.md new file mode 100644 index 0000000000..0a267b3d2d --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppDaprMetadataObject.md @@ -0,0 +1,101 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappdaprmetadataobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppDaprMetadataObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppDaprMetadataObject.md +--- + +# New-AzContainerAppDaprMetadataObject + +## SYNOPSIS +Create an in-memory object for DaprMetadata. + +## SYNTAX + +``` +New-AzContainerAppDaprMetadataObject [-Name ] [-SecretRef ] [-Value ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DaprMetadata. + +## EXAMPLES + +### Example 1: Create a DaprMetaData object for ManagedEnvDaprMetadata. +```powershell +New-AzContainerAppDaprMetadataObject -Name "masterkey" -Value "masterkey" +``` + +```output +Name SecretRef Value +---- --------- ----- +masterkey masterkey +``` + +Create a DaprMetaData object for ManagedEnvDaprMetadata. + +## PARAMETERS + +### -Name +Metadata property name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretRef +Name of the Dapr Component secret from which to pull the metadata property value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Metadata property value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.DaprMetadata + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppEnvironmentVarObject.md b/azps-10.1.0/Az.App/New-AzContainerAppEnvironmentVarObject.md new file mode 100644 index 0000000000..0835c81eb1 --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppEnvironmentVarObject.md @@ -0,0 +1,101 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappenvironmentvarobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppEnvironmentVarObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppEnvironmentVarObject.md +--- + +# New-AzContainerAppEnvironmentVarObject + +## SYNOPSIS +Create an in-memory object for EnvironmentVar. + +## SYNTAX + +``` +New-AzContainerAppEnvironmentVarObject [-Name ] [-SecretRef ] [-Value ] + [] +``` + +## DESCRIPTION +Create an in-memory object for EnvironmentVar. + +## EXAMPLES + +### Example 1: Create an EnvironmentVar object for Env. +```powershell +New-AzContainerAppEnvironmentVarObject -Name "envVarName" -SecretRef "facebook-secret" -Value "value" +``` + +```output +Name SecretRef Value +---- --------- ----- +envVarName facebook-secret value +``` + +Create an EnvironmentVar object for Env. + +## PARAMETERS + +### -Name +Environment variable name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretRef +Name of the Container App secret from which to pull the environment variable value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Non-secret environment variable value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.EnvironmentVar + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppIdentityProviderObject.md b/azps-10.1.0/Az.App/New-AzContainerAppIdentityProviderObject.md new file mode 100644 index 0000000000..1449a9726d --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppIdentityProviderObject.md @@ -0,0 +1,711 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappidentityproviderobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppIdentityProviderObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppIdentityProviderObject.md +--- + +# New-AzContainerAppIdentityProviderObject + +## SYNOPSIS +Create an in-memory object for IdentityProviders. + +## SYNTAX + +``` +New-AzContainerAppIdentityProviderObject [-AllowedPrincipalGroup ] + [-AllowedPrincipalIdentity ] [-AppleEnabled ] [-AppleLoginScope ] + [-AppleRegistrationClientId ] [-AppleRegistrationClientSecretSettingName ] + [-AzureActiveDirectoryEnabled ] [-AzureActiveDirectoryIsAutoProvisioned ] + [-AzureActiveDirectoryRegistrationClientId ] + [-AzureActiveDirectoryRegistrationClientSecretSettingName ] + [-AzureActiveDirectoryValidationAllowedAudience ] [-AzureStaticWebAppEnabled ] + [-AzureStaticWebAppsRegistrationClientId ] + [-CustomOpenIdConnectProvider ] + [-DefaultAuthorizationPolicyAllowedApplication ] [-FacebookEnabled ] + [-FacebookGraphApiVersion ] [-FacebookLoginScope ] [-GitHubEnabled ] + [-GitHubLoginScope ] [-GitHubRegistrationClientId ] + [-GitHubRegistrationClientSecretSettingName ] [-GoogleEnabled ] + [-GoogleLoginScope ] [-GoogleRegistrationClientId ] + [-GoogleRegistrationClientSecretSettingName ] [-GoogleValidationAllowedAudience ] + [-JwtClaimCheckAllowedClientApplication ] [-JwtClaimCheckAllowedGroup ] + [-LoginDisableWwwAuthenticate ] [-LoginParameter ] [-RegistrationAppId ] + [-RegistrationAppSecretSettingName ] [-RegistrationClientSecretCertificateIssuer ] + [-RegistrationClientSecretCertificateSubjectAlternativeName ] + [-RegistrationClientSecretCertificateThumbprint ] [-RegistrationConsumerKey ] + [-RegistrationConsumerSecretSettingName ] [-RegistrationOpenIdIssuer ] + [-TwitterEnabled ] [] +``` + +## DESCRIPTION +Create an in-memory object for IdentityProviders. + +## EXAMPLES + +### Example 1: Create an IdentityProviders object for AuthConfig. +```powershell +New-AzContainerAppIdentityProviderObject -RegistrationAppId xxxxxx@xxx.com -RegistrationAppSecretSettingName facebook-secret +``` + +```output +... : ... +RegistrationAppId : xxxxxx@xxx.com +RegistrationAppSecretSettingName : facebook-secret +... : ... +``` + +Create an IdentityProviders object for AuthConfig. + +## PARAMETERS + +### -AllowedPrincipalGroup +The list of the allowed groups. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedPrincipalIdentity +The list of the allowed identities. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppleEnabled +\false\ if the Apple provider should not be enabled despite the set registration; otherwise, \true\. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppleLoginScope +A list of the scopes that should be requested while authenticating. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppleRegistrationClientId +The Client ID of the app used for login. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppleRegistrationClientSecretSettingName +The app setting name that contains the client secret. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureActiveDirectoryEnabled +\false\ if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, \true\. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureActiveDirectoryIsAutoProvisioned +Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. + This is an internal flag primarily intended to support the Azure Management Portal. +Users should not + read or write to this property. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureActiveDirectoryRegistrationClientId +The Client ID of this relying party application, known as the client_id. + This setting is required for enabling OpenID Connection authentication with Azure Active Directory or + other 3rd party OpenID Connect providers. + More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureActiveDirectoryRegistrationClientSecretSettingName +The app setting name that contains the client secret of the relying party application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureActiveDirectoryValidationAllowedAudience +The list of audiences that can make successful authentication/authorization requests. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureStaticWebAppEnabled +\false\ if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, \true\. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureStaticWebAppsRegistrationClientId +The Client ID of the app used for login. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomOpenIdConnectProvider +The map of the name of the alias of each custom Open ID Connect provider to the + configuration settings of the custom Open ID Connect provider. +To construct, see NOTES section for CUSTOMOPENIDCONNECTPROVIDER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IIdentityProvidersCustomOpenIdConnectProviders +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAuthorizationPolicyAllowedApplication +The configuration settings of the Azure Active Directory allowed applications. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FacebookEnabled +\false\ if the Facebook provider should not be enabled despite the set registration; otherwise, \true\. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FacebookGraphApiVersion +The version of the Facebook api to be used while logging in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FacebookLoginScope +A list of the scopes that should be requested while authenticating. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitHubEnabled +\false\ if the GitHub provider should not be enabled despite the set registration; otherwise, \true\. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitHubLoginScope +A list of the scopes that should be requested while authenticating. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitHubRegistrationClientId +The Client ID of the app used for login. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitHubRegistrationClientSecretSettingName +The app setting name that contains the client secret. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GoogleEnabled +\false\ if the Google provider should not be enabled despite the set registration; otherwise, \true\. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GoogleLoginScope +A list of the scopes that should be requested while authenticating. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GoogleRegistrationClientId +The Client ID of the app used for login. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GoogleRegistrationClientSecretSettingName +The app setting name that contains the client secret. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GoogleValidationAllowedAudience +The configuration settings of the allowed list of audiences from which to validate the JWT token. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JwtClaimCheckAllowedClientApplication +The list of the allowed client applications. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JwtClaimCheckAllowedGroup +The list of the allowed groups. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoginDisableWwwAuthenticate +\true\ if the www-authenticate provider should be omitted from the request; otherwise, \false\. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoginParameter +Login parameters to send to the OpenID Connect authorization endpoint when + a user logs in. +Each parameter must be in the form "key=value". + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationAppId +The App ID of the app used for login. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationAppSecretSettingName +The app setting name that contains the app secret. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationClientSecretCertificateIssuer +An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. +This property acts as + a replacement for the Client Secret Certificate Thumbprint. +It is also optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationClientSecretCertificateSubjectAlternativeName +An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. +This property acts as + a replacement for the Client Secret Certificate Thumbprint. +It is also optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationClientSecretCertificateThumbprint +An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. +This property acts as + a replacement for the Client Secret. +It is also optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationConsumerKey +The OAuth 1.0a consumer key of the Twitter application used for sign-in. + This setting is required for enabling Twitter Sign-In. + Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationConsumerSecretSettingName +The app setting name that contains the OAuth 1.0a consumer secret of the Twitter + application used for sign-in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationOpenIdIssuer +The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. + When using Azure Active Directory, this value is the URI of the directory tenant, e.g. +https://login.microsoftonline.com/v2.0/{tenant-guid}/. + This URI is a case-sensitive identifier for the token issuer. + More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TwitterEnabled +\false\ if the Twitter provider should not be enabled despite the set registration; otherwise, \true\. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IdentityProviders + +## 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. + + +`CUSTOMOPENIDCONNECTPROVIDER `: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. + - `[(Any) ]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppManagedEnv.md b/azps-10.1.0/Az.App/New-AzContainerAppManagedEnv.md new file mode 100644 index 0000000000..013e54ada3 --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppManagedEnv.md @@ -0,0 +1,406 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappmanagedenv +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppManagedEnv.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppManagedEnv.md +--- + +# New-AzContainerAppManagedEnv + +## SYNOPSIS +Creates or updates a Managed Environment used to host container apps. + +## SYNTAX + +``` +New-AzContainerAppManagedEnv -EnvName -ResourceGroupName -Location + [-SubscriptionId ] [-AppLogConfigurationDestination ] [-DaprAiConnectionString ] + [-DaprAiInstrumentationKey ] [-LogAnalyticConfigurationCustomerId ] + [-LogAnalyticConfigurationSharedKey ] [-Tag ] + [-VnetConfigurationDockerBridgeCidr ] [-VnetConfigurationInfrastructureSubnetId ] + [-VnetConfigurationInternal] [-VnetConfigurationPlatformReservedCidr ] + [-VnetConfigurationPlatformReservedDnsIP ] [-VnetConfigurationRuntimeSubnetId ] + [-ZoneRedundant] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates or updates a Managed Environment used to host container apps. + +## EXAMPLES + +### Example 1: Creates or updates a Managed Environment used to host container apps. +```powershell +New-AzOperationalInsightsWorkspace -ResourceGroupName azpstest_gp -Name workspace-azpstestgp -Sku PerGB2018 -Location canadacentral -PublicNetworkAccessForIngestion "Enabled" -PublicNetworkAccessForQuery "Enabled" +$CustomId = (Get-AzOperationalInsightsWorkspace -ResourceGroupName azpstest_gp -Name workspace-azpstestgp).CustomerId +$SharedKey = (Get-AzOperationalInsightsWorkspaceSharedKey -ResourceGroupName azpstest_gp -Name workspace-azpstestgp).PrimarySharedKey + +New-AzContainerAppManagedEnv -EnvName azps-env -ResourceGroupName azpstest_gp -Location canadacentral -AppLogConfigurationDestination "log-analytics" -LogAnalyticConfigurationCustomerId $CustomId -LogAnalyticConfigurationSharedKey $SharedKey -VnetConfigurationInternal:$false +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +canadacentral azps-env azpstest_gp +``` + +Creates or updates a Managed Environment used to host container apps. + +## PARAMETERS + +### -AppLogConfigurationDestination +Logs destination + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaprAiConnectionString +Application Insights connection string used by Dapr to export Service to Service communication telemetry + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaprAiInstrumentationKey +Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticConfigurationCustomerId +Log analytics customer id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticConfigurationSharedKey +Log analytics customer key + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetConfigurationDockerBridgeCidr +CIDR notation IP range assigned to the Docker bridge, network. +Must not overlap with any other provided IP ranges. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetConfigurationInfrastructureSubnetId +Resource ID of a subnet for infrastructure components. +This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. +Must not overlap with any other provided IP ranges. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetConfigurationInternal +Boolean indicating the environment only has an internal load balancer. +These environments do not have a public static IP resource, must provide ControlPlaneSubnetResourceId and AppSubnetResourceId if enabling this property + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetConfigurationPlatformReservedCidr +IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. +Must not overlap with any other provided IP ranges. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetConfigurationPlatformReservedDnsIP +An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetConfigurationRuntimeSubnetId +Resource ID of a subnet that Container App containers are injected into. +This subnet must be in the same VNET as the subnet defined in infrastructureSubnetId. +Must not overlap with any other provided IP ranges. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +Whether or not this Managed Environment is zone-redundant. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IManagedEnvironment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppManagedEnvCert.md b/azps-10.1.0/Az.App/New-AzContainerAppManagedEnvCert.md new file mode 100644 index 0000000000..750314913d --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppManagedEnvCert.md @@ -0,0 +1,230 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappmanagedenvcert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppManagedEnvCert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppManagedEnvCert.md +--- + +# New-AzContainerAppManagedEnvCert + +## SYNOPSIS +Create or Update a Certificate. + +## SYNTAX + +``` +New-AzContainerAppManagedEnvCert -EnvName -Name -ResourceGroupName + -Location [-SubscriptionId ] [-InputFile ] [-Password ] + [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create or Update a Certificate. + +## EXAMPLES + +### Example 1: Create or Update a Certificate. +```powershell +New-SelfSignedCertificate -DnsName "www.fabrikam.com", "www.contoso.com" -CertStoreLocation "cert:\LocalMachine\My" +Get-ChildItem -Path cert:\LocalMachine\My +$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText +Get-ChildItem -Path cert:\localMachine\my\5F98EBBFE735CDDAE00E33E0FD69050EF9220254 | Export-PfxCertificate -FilePath C:\mypfx.pfx -Password $mypwd + +New-AzContainerAppManagedEnvCert -EnvName azps-env -Name azps-env-cert -ResourceGroupName azpstest_gp -Location canadacentral -InputFile "C:\mypfx.pfx" -Password $mypwd +``` + +```output +Name Location Issuer ProvisioningState SubjectName Thumbprint ResourceGroupName +---- -------- ------ ----------------- ----------- ---------- ----------------- +azps-env-cert canadacentral CN=www.fabrikam.com Succeeded CN=www.fabrikam.com 684DFA8457230B8A04675FBCB7251FA88AE10D80 azpstest_gp +``` + +Create or Update a Certificate. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Managed Environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +Input File for Value (PFX or PEM blob) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Certificate password. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ICertificate + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppManagedEnvDapr.md b/azps-10.1.0/Az.App/New-AzContainerAppManagedEnvDapr.md new file mode 100644 index 0000000000..4694f7ceac --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppManagedEnvDapr.md @@ -0,0 +1,291 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappmanagedenvdapr +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppManagedEnvDapr.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppManagedEnvDapr.md +--- + +# New-AzContainerAppManagedEnvDapr + +## SYNOPSIS +Creates or updates a Dapr Component in a Managed Environment. + +## SYNTAX + +``` +New-AzContainerAppManagedEnvDapr -DaprName -EnvName -ResourceGroupName + [-SubscriptionId ] [-ComponentType ] [-IgnoreError] [-InitTimeout ] + [-Metadata ] [-Scope ] [-Secret ] [-Version ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates or updates a Dapr Component in a Managed Environment. + +## EXAMPLES + +### Example 1: Creates or updates a Dapr Component in a Managed Environment. +```powershell +$scope = @("container-app-1","container-app-2") +$secretObject = New-AzContainerAppSecretObject -Name "masterkey" -Value "keyvalue" +$daprMetaData = New-AzContainerAppDaprMetadataObject -Name "masterkey" -Value "masterkey" + +New-AzContainerAppManagedEnvDapr -DaprName azps-dapr -EnvName azps-env -ResourceGroupName azpstest_gp -componentType state.azure.cosmosdb -Version v1 -IgnoreError:$false -InitTimeout 50s -Scope $scope -Secret $secretObject -Metadata $daprMetaData +``` + +```output +Name ComponentType IgnoreError InitTimeout ResourceGroupName Version +---- ------------- ----------- ----------- ----------------- ------- +azps-dapr state.azure.cosmosdb False 50s azpstest_gp v1 +``` + +Creates or updates a Dapr Component in a Managed Environment. + +## PARAMETERS + +### -ComponentType +Component type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaprName +Name of the Dapr Component. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Managed Environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreError +Boolean describing if the component errors are ignores + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitTimeout +Initialization timeout + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Component metadata +To construct, see NOTES section for METADATA properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IDaprMetadata[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Names of container apps that can use this Dapr component + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Secret +Collection of secrets used by a Dapr component +To construct, see NOTES section for SECRET properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ISecret[] +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Component version + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IDaprComponent + +## 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. + + +`METADATA `: Component metadata + - `[Name ]`: Metadata property name. + - `[SecretRef ]`: Name of the Dapr Component secret from which to pull the metadata property value. + - `[Value ]`: Metadata property value. + +`SECRET `: Collection of secrets used by a Dapr component + - `[Name ]`: Secret Name. + - `[Value ]`: Secret Value. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppManagedEnvStorage.md b/azps-10.1.0/Az.App/New-AzContainerAppManagedEnvStorage.md new file mode 100644 index 0000000000..71a10ca179 --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppManagedEnvStorage.md @@ -0,0 +1,229 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappmanagedenvstorage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppManagedEnvStorage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppManagedEnvStorage.md +--- + +# New-AzContainerAppManagedEnvStorage + +## SYNOPSIS +Create or update storage for a managedEnvironment. + +## SYNTAX + +``` +New-AzContainerAppManagedEnvStorage -EnvName -ResourceGroupName -StorageName + [-SubscriptionId ] [-AzureFileAccessMode ] [-AzureFileAccountKey ] + [-AzureFileAccountName ] [-AzureFileShareName ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Create or update storage for a managedEnvironment. + +## EXAMPLES + +### Example 1: Create or update storage for a managedEnvironment. +```powershell +New-AzStorageAccount -ResourceGroupName azpstest_gp -AccountName azpstestsa -Location canadacentral -SkuName Standard_GRS +$storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName azpstest_gp -AccountName azpstestsa).Value[0] + +New-AzContainerAppManagedEnvStorage -EnvName azps-env -ResourceGroupName azpstest_gp -StorageName azpstestsa -AzureFileAccessMode 'ReadWrite' -AzureFileAccountKey $storageAccountKey -AzureFileAccountName azpstestsa -AzureFileShareName azps-rw-sharename +``` + +```output +Name AzureFileAccessMode AzureFileAccountName AzureFileShareName ResourceGroupName +---- ------------------- -------------------- ------------------ ----------------- +azpstestsa ReadWrite azpstestsa azps-rw-sharename azpstest_gp +``` + +Create or update storage for a managedEnvironment. + +## PARAMETERS + +### -AzureFileAccessMode +Access mode for storage + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.AccessMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureFileAccountKey +Storage account key for azure file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureFileAccountName +Storage account name for azure file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureFileShareName +Azure file share name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageName +Name of the storage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IManagedEnvironmentStorage + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppProbeHeaderObject.md b/azps-10.1.0/Az.App/New-AzContainerAppProbeHeaderObject.md new file mode 100644 index 0000000000..7f8396d109 --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppProbeHeaderObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappprobeheaderobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppProbeHeaderObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppProbeHeaderObject.md +--- + +# New-AzContainerAppProbeHeaderObject + +## SYNOPSIS +Create an in-memory object for ContainerAppProbeHttpGetHttpHeadersItem. + +## SYNTAX + +``` +New-AzContainerAppProbeHeaderObject -Name -Value [] +``` + +## DESCRIPTION +Create an in-memory object for ContainerAppProbeHttpGetHttpHeadersItem. + +## EXAMPLES + +### Example 1: Create a ContainerAppProbeHttpGetHttpHeadersItem object for ContainerApp. +```powershell +New-AzContainerAppProbeHeaderObject -Name Custom-Header -Value Awesome +``` + +```output +Name Value +---- ----- +Custom-Header Awesome +``` + +Create a ContainerAppProbeHttpGetHttpHeadersItem object for ContainerApp. + +## PARAMETERS + +### -Name +The header field name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The header field value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ContainerAppProbeHttpGetHttpHeadersItem + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppProbeObject.md b/azps-10.1.0/Az.App/New-AzContainerAppProbeObject.md new file mode 100644 index 0000000000..204e29a8ad --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppProbeObject.md @@ -0,0 +1,309 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappprobeobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppProbeObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppProbeObject.md +--- + +# New-AzContainerAppProbeObject + +## SYNOPSIS +Create an in-memory object for ContainerAppProbe. + +## SYNTAX + +``` +New-AzContainerAppProbeObject [-FailureThreshold ] [-HttpGetHost ] + [-HttpGetHttpHeader ] [-HttpGetPath ] + [-HttpGetPort ] [-HttpGetScheme ] [-InitialDelaySecond ] [-PeriodSecond ] + [-SuccessThreshold ] [-TcpSocketHost ] [-TcpSocketPort ] + [-TerminationGracePeriodSecond ] [-TimeoutSecond ] [-Type ] [] +``` + +## DESCRIPTION +Create an in-memory object for ContainerAppProbe. + +## EXAMPLES + +### Example 1: Create a ContainerAppProb object for ContainerApp. +```powershell +New-AzContainerAppProbeObject -HttpGetPath "/health" -HttpGetPort 8080 -InitialDelaySecond 3 -PeriodSecond 3 -Type Liveness +``` + +```output +FailureThreshold InitialDelaySecond PeriodSecond SuccessThreshold TerminationGracePeriodSecond TimeoutSecond +---------------- ------------------ ------------ ---------------- ---------------------------- ------------- + 3 3 +``` + +Create a ContainerAppProb object for ContainerApp. + +## PARAMETERS + +### -FailureThreshold +Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. +Minimum value is 1. +Maximum value is 10. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpGetHost +Host name to connect to, defaults to the pod IP. +You probably want to set "Host" in httpHeaders instead. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpGetHttpHeader +Custom headers to set in the request. +HTTP allows repeated headers. +To construct, see NOTES section for HTTPGETHTTPHEADER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IContainerAppProbeHttpGetHttpHeadersItem[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpGetPath +Path to access on the HTTP server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpGetPort +Name or number of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpGetScheme +Scheme to use for connecting to the host. +Defaults to HTTP. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.Scheme +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialDelaySecond +Number of seconds after the container has started before liveness probes are initiated. +Minimum value is 1. +Maximum value is 60. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeriodSecond +How often (in seconds) to perform the probe. +Default to 10 seconds. +Minimum value is 1. +Maximum value is 240. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuccessThreshold +Minimum consecutive successes for the probe to be considered successful after having failed. +Defaults to 1. +Must be 1 for liveness and startup. +Minimum value is 1. +Maximum value is 10. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TcpSocketHost +Optional: Host name to connect to, defaults to the pod IP. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TcpSocketPort +Number or name of the port to access on the container. +Number must be in the range 1 to 65535. +Name must be an IANA_SVC_NAME. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TerminationGracePeriodSecond +Optional duration in seconds the pod needs to terminate gracefully upon probe failure. +The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. +Set this value longer than the expected cleanup time for your process. +If this value is nil, the pod's terminationGracePeriodSeconds will be used. +Otherwise, this value overrides the value provided by the pod spec. +Value must be non-negative integer. +The value zero indicates stop immediately via the kill signal (no opportunity to shut down). +This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. +Maximum value is 3600 seconds (1 hour). + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutSecond +Number of seconds after which the probe times out. +Defaults to 1 second. +Minimum value is 1. +Maximum value is 240. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The type of probe. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.Type +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ContainerAppProbe + +## 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. + + +`HTTPGETHTTPHEADER `: Custom headers to set in the request. HTTP allows repeated headers. + - `Name `: The header field name + - `Value `: The header field value + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppRegistryCredentialObject.md b/azps-10.1.0/Az.App/New-AzContainerAppRegistryCredentialObject.md new file mode 100644 index 0000000000..f6d424cc1d --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppRegistryCredentialObject.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappregistrycredentialobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppRegistryCredentialObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppRegistryCredentialObject.md +--- + +# New-AzContainerAppRegistryCredentialObject + +## SYNOPSIS +Create an in-memory object for RegistryCredentials. + +## SYNTAX + +``` +New-AzContainerAppRegistryCredentialObject [-Identity ] [-PasswordSecretRef ] + [-Server ] [-Username ] [] +``` + +## DESCRIPTION +Create an in-memory object for RegistryCredentials. + +## EXAMPLES + +### Example 1: Create a RegistryCredentials object for ContainerApp. +```powershell +New-AzContainerAppRegistryCredentialObject -Identity system -PasswordSecretRef "myloginpassword" -Server azps-containerapp -Username azps-container-user +``` + +```output +Identity PasswordSecretRef Server Username +-------- ----------------- ------ -------- +system myloginpassword azps-containerapp azps-container-user +``` + +Create a RegistryCredentials object for ContainerApp. + +## PARAMETERS + +### -Identity +A Managed Identity to use to authenticate with Azure Container Registry. +For user-assigned identities, use the full user-assigned identity Resource ID. +For system-assigned identities, use 'system'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordSecretRef +The name of the Secret that contains the registry login password. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +Container Registry Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Username +Container Registry Username. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.RegistryCredentials + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppScaleRuleAuthObject.md b/azps-10.1.0/Az.App/New-AzContainerAppScaleRuleAuthObject.md new file mode 100644 index 0000000000..24077e9b40 --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppScaleRuleAuthObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappscaleruleauthobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppScaleRuleAuthObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppScaleRuleAuthObject.md +--- + +# New-AzContainerAppScaleRuleAuthObject + +## SYNOPSIS +Create an in-memory object for ScaleRuleAuth. + +## SYNTAX + +``` +New-AzContainerAppScaleRuleAuthObject [-SecretRef ] [-TriggerParameter ] [] +``` + +## DESCRIPTION +Create an in-memory object for ScaleRuleAuth. + +## EXAMPLES + +### Example 1: Create a ScaleRuleAuth object for ScaleRule. +```powershell +New-AzContainerAppScaleRuleAuthObject -SecretRef "facebook-secret" -TriggerParameter "TriggerParameter" +``` + +```output +SecretRef TriggerParameter +--------- ---------------- +facebook-secret TriggerParameter +``` + +Create a ScaleRuleAuth object for ScaleRule. + +## PARAMETERS + +### -SecretRef +Name of the Container App secret from which to pull the auth params. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerParameter +Trigger Parameter that uses the secret. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ScaleRuleAuth + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppScaleRuleObject.md b/azps-10.1.0/Az.App/New-AzContainerAppScaleRuleObject.md new file mode 100644 index 0000000000..6bf603f8f4 --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppScaleRuleObject.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappscaleruleobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppScaleRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppScaleRuleObject.md +--- + +# New-AzContainerAppScaleRuleObject + +## SYNOPSIS +Create an in-memory object for ScaleRule. + +## SYNTAX + +``` +New-AzContainerAppScaleRuleObject [-AzureQueueAuth ] [-AzureQueueLength ] + [-AzureQueueName ] [-CustomAuth ] [-CustomMetadata ] + [-CustomType ] [-HttpAuth ] [-HttpMetadata ] + [-Name ] [] +``` + +## DESCRIPTION +Create an in-memory object for ScaleRule. + +## EXAMPLES + +### Example 1: Create a ScaleRule object for ContainerApp. +```powershell +$scaleRule = @() +$scaleRule += New-AzContainerAppScaleRuleObject -Name scaleRuleName1 -AzureQueueLength 30 -AzureQueueName azps_containerapp -CustomType "azure-servicebus" +$scaleRule += New-AzContainerAppScaleRuleObject -Name scaleRuleName2 -AzureQueueLength 30 -AzureQueueName azps_containerapp -CustomType "azure-servicebus" +``` + +```output +Name +---- +scaleRuleName +``` + +Create a ScaleRule object for ContainerApp. +The ScaleRule object as value of the `ScaleRule` parameter in the cmdlet `New-AzContainerApp`. + +## PARAMETERS + +### -AzureQueueAuth +Authentication secrets for the queue scale rule. +To construct, see NOTES section for AZUREQUEUEAUTH properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IScaleRuleAuth[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureQueueLength +Queue length. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureQueueName +Queue name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAuth +Authentication secrets for the custom scale rule. +To construct, see NOTES section for CUSTOMAUTH properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IScaleRuleAuth[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomMetadata +Metadata properties to describe custom scale rule. +To construct, see NOTES section for CUSTOMMETADATA properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ICustomScaleRuleMetadata +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomType +Type of the custom scale rule + eg: azure-servicebus, redis etc. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpAuth +Authentication secrets for the custom scale rule. +To construct, see NOTES section for HTTPAUTH properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IScaleRuleAuth[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpMetadata +Metadata properties to describe http scale rule. +To construct, see NOTES section for HTTPMETADATA properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IHttpScaleRuleMetadata +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Scale Rule Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ScaleRule + +## 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. + + +`AZUREQUEUEAUTH `: Authentication secrets for the queue scale rule. + - `[SecretRef ]`: Name of the Container App secret from which to pull the auth params. + - `[TriggerParameter ]`: Trigger Parameter that uses the secret + +`CUSTOMAUTH `: Authentication secrets for the custom scale rule. + - `[SecretRef ]`: Name of the Container App secret from which to pull the auth params. + - `[TriggerParameter ]`: Trigger Parameter that uses the secret + +`CUSTOMMETADATA `: Metadata properties to describe custom scale rule. + - `[(Any) ]`: This indicates any property can be added to this object. + +`HTTPAUTH `: Authentication secrets for the custom scale rule. + - `[SecretRef ]`: Name of the Container App secret from which to pull the auth params. + - `[TriggerParameter ]`: Trigger Parameter that uses the secret + +`HTTPMETADATA `: Metadata properties to describe http scale rule. + - `[(Any) ]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppSecretObject.md b/azps-10.1.0/Az.App/New-AzContainerAppSecretObject.md new file mode 100644 index 0000000000..68338d22b9 --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppSecretObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappsecretobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppSecretObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppSecretObject.md +--- + +# New-AzContainerAppSecretObject + +## SYNOPSIS +Create an in-memory object for Secret. + +## SYNTAX + +``` +New-AzContainerAppSecretObject [-Name ] [-Value ] [] +``` + +## DESCRIPTION +Create an in-memory object for Secret. + +## EXAMPLES + +### Example 1: Create a Secret object for ManagedEnvDaprSecret. +```powershell +New-AzContainerAppSecretObject -Name "masterkey" -Value "keyvalue" +``` + +```output +Name Value +---- ----- +masterkey keyvalue +``` + +Create a Secret object for ManagedEnvDaprSecret. + +## PARAMETERS + +### -Name +Secret Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Secret Value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.Secret + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppTemplateObject.md b/azps-10.1.0/Az.App/New-AzContainerAppTemplateObject.md new file mode 100644 index 0000000000..fefccac693 --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppTemplateObject.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerapptemplateobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppTemplateObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppTemplateObject.md +--- + +# New-AzContainerAppTemplateObject + +## SYNOPSIS +Create an in-memory object for Container. + +## SYNTAX + +``` +New-AzContainerAppTemplateObject [-Arg ] [-Command ] [-Env ] + [-Image ] [-Name ] [-Probe ] [-ResourceCpu ] + [-ResourceMemory ] [-VolumeMount ] [] +``` + +## DESCRIPTION +Create an in-memory object for Container. + +## EXAMPLES + +### Example 1: Create an image object for Container. +```powershell +$containerAppHttpHeader = New-AzContainerAppProbeHeaderObject -Name Custom-Header -Value Awesome +$probeArray = @() +$probeArray += New-AzContainerAppProbeObject -HttpGetPath "/health01" -HttpGetPort 8080 -InitialDelaySecond 3 -PeriodSecond 3 -Type Liveness -HttpGetHttpHeader $containerAppHttpHeader +$probeArray += New-AzContainerAppProbeObject -HttpGetPath "/health02" -HttpGetPort 8080 -InitialDelaySecond 3 -PeriodSecond 3 -Type Liveness -HttpGetHttpHeader $containerAppHttpHeader +New-AzContainerAppTemplateObject -Name azps-containerapp -Image mcr.microsoft.com/azuredocs/containerapps-helloworld:latest -Probe $probeArray -ResourceCpu 2.0 -ResourceMemory 4.0Gi +``` + +```output +Arg Command Image Name +--- ------- ----- ---- + mcr.microsoft.com/azuredocs/containerapps-helloworld:latest azps-containerapp +``` + +Create an image object for Container. + +## PARAMETERS + +### -Arg +Container start command arguments. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Command +Container start command. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Env +Container environment variables. +To construct, see NOTES section for ENV properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IEnvironmentVar[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Image +Container image tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Custom container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Probe +List of probes for the container. +To construct, see NOTES section for PROBE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IContainerAppProbe[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceCpu +Required CPU in cores, e.g. +0.5. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceMemory +Required memory, e.g. +"250Mb". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeMount +Container volume mounts. +To construct, see NOTES section for VOLUMEMOUNT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IVolumeMount[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.Container + +## 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. + + +`ENV `: Container environment variables. + - `[Name ]`: Environment variable name. + - `[SecretRef ]`: Name of the Container App secret from which to pull the environment variable value. + - `[Value ]`: Non-secret environment variable value. + +`PROBE `: List of probes for the container. + - `[FailureThreshold ]`: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10. + - `[HttpGetHost ]`: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + - `[HttpGetHttpHeader ]`: Custom headers to set in the request. HTTP allows repeated headers. + - `Name `: The header field name + - `Value `: The header field value + - `[HttpGetPath ]`: Path to access on the HTTP server. + - `[HttpGetPort ]`: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + - `[HttpGetScheme ]`: Scheme to use for connecting to the host. Defaults to HTTP. + - `[InitialDelaySecond ]`: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. + - `[PeriodSecond ]`: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. + - `[SuccessThreshold ]`: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10. + - `[TcpSocketHost ]`: Optional: Host name to connect to, defaults to the pod IP. + - `[TcpSocketPort ]`: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + - `[TerminationGracePeriodSecond ]`: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour) + - `[TimeoutSecond ]`: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. + - `[Type ]`: The type of probe. + +`VOLUMEMOUNT `: Container volume mounts. + - `[MountPath ]`: Path within the container at which the volume should be mounted.Must not contain ':'. + - `[VolumeName ]`: This must match the Name of a Volume. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppTrafficWeightObject.md b/azps-10.1.0/Az.App/New-AzContainerAppTrafficWeightObject.md new file mode 100644 index 0000000000..21bb57a314 --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppTrafficWeightObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerapptrafficweightobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppTrafficWeightObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppTrafficWeightObject.md +--- + +# New-AzContainerAppTrafficWeightObject + +## SYNOPSIS +Create an in-memory object for TrafficWeight. + +## SYNTAX + +``` +New-AzContainerAppTrafficWeightObject [-Label ] [-LatestRevision ] [-RevisionName ] + [-Weight ] [] +``` + +## DESCRIPTION +Create an in-memory object for TrafficWeight. + +## EXAMPLES + +### Example 1: Create a TrafficWeight object for ContainerApp. +```powershell +New-AzContainerAppTrafficWeightObject -Label production -LatestRevision $True -Weight 100 +``` + +```output +Label LatestRevision RevisionName Weight +----- -------------- ------------ ------ +production True 100 +``` + +Create a TrafficWeight object for ContainerApp. + +## PARAMETERS + +### -Label +Associates a traffic label with a revision. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LatestRevision +Indicates that the traffic weight belongs to a latest stable revision. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RevisionName +Name of a revision. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Weight +Traffic weight assigned to a revision. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.TrafficWeight + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppVolumeMountObject.md b/azps-10.1.0/Az.App/New-AzContainerAppVolumeMountObject.md new file mode 100644 index 0000000000..eeb8f1d1b8 --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppVolumeMountObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappvolumemountobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppVolumeMountObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppVolumeMountObject.md +--- + +# New-AzContainerAppVolumeMountObject + +## SYNOPSIS +Create an in-memory object for VolumeMount. + +## SYNTAX + +``` +New-AzContainerAppVolumeMountObject [-MountPath ] [-VolumeName ] [] +``` + +## DESCRIPTION +Create an in-memory object for VolumeMount. + +## EXAMPLES + +### Example 1: Create a VolumeMount object for ContainerApp. +```powershell +New-AzContainerAppVolumeMountObject -MountPath "/mountPath" -VolumeName "VolumeName" +``` + +```output +MountPath VolumeName +--------- ---------- +/mountPath VolumeName +``` + +Create a VolumeMount object for ContainerApp. + +## PARAMETERS + +### -MountPath +Path within the container at which the volume should be mounted.Must not contain ':'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeName +This must match the Name of a Volume. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.VolumeMount + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/New-AzContainerAppVolumeObject.md b/azps-10.1.0/Az.App/New-AzContainerAppVolumeObject.md new file mode 100644 index 0000000000..45e3696f54 --- /dev/null +++ b/azps-10.1.0/Az.App/New-AzContainerAppVolumeObject.md @@ -0,0 +1,103 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/new-azcontainerappvolumeobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppVolumeObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/New-AzContainerAppVolumeObject.md +--- + +# New-AzContainerAppVolumeObject + +## SYNOPSIS +Create an in-memory object for Volume. + +## SYNTAX + +``` +New-AzContainerAppVolumeObject [-Name ] [-StorageName ] [-StorageType ] + [] +``` + +## DESCRIPTION +Create an in-memory object for Volume. + +## EXAMPLES + +### Example 1: Create a Volume object for ContainerApp. +```powershell +New-AzContainerAppVolumeObject -Name "volumeName" -StorageName "azpssa" +``` + +```output +Name StorageName StorageType +---- ----------- ----------- +volumeName azpssa +``` + +Create a Volume object for ContainerApp. + +## PARAMETERS + +### -Name +Volume name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageName +Name of storage resource. +No need to provide for EmptyDir. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageType +Storage type for the volume. +If not provided, use EmptyDir. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.StorageType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.Volume + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Remove-AzContainerApp.md b/azps-10.1.0/Az.App/Remove-AzContainerApp.md new file mode 100644 index 0000000000..6b3569fc6d --- /dev/null +++ b/azps-10.1.0/Az.App/Remove-AzContainerApp.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/remove-azcontainerapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Remove-AzContainerApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Remove-AzContainerApp.md +--- + +# Remove-AzContainerApp + +## SYNOPSIS +Delete a Container App. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerApp -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerApp -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a Container App. + +## EXAMPLES + +### Example 1: Delete a Container App. +```powershell +Remove-AzContainerApp -Name azps-containerapp -ResourceGroupName azpstest_gp +``` + +Delete a Container App. + +### Example 2: Delete a Container App. +```powershell +Get-AzContainerApp -Name azps-containerapp -ResourceGroupName azpstest_gp | Remove-AzContainerApp +``` + +Delete a Container App. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Container App. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ContainerAppName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Remove-AzContainerAppAuthConfig.md b/azps-10.1.0/Az.App/Remove-AzContainerAppAuthConfig.md new file mode 100644 index 0000000000..ece09a2831 --- /dev/null +++ b/azps-10.1.0/Az.App/Remove-AzContainerAppAuthConfig.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/remove-azcontainerappauthconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Remove-AzContainerAppAuthConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Remove-AzContainerAppAuthConfig.md +--- + +# Remove-AzContainerAppAuthConfig + +## SYNOPSIS +Delete a Container App AuthConfig. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerAppAuthConfig -AuthConfigName -ContainerAppName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerAppAuthConfig -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a Container App AuthConfig. + +## EXAMPLES + +### Example 1: Delete a Container App AuthConfig. +```powershell +Remove-AzContainerAppAuthConfig -AuthConfigName current -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp +``` + +Delete a Container App AuthConfig. + +### Example 2: Delete a Container App AuthConfig. +```powershell +Get-AzContainerAppAuthConfig -AuthConfigName current -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp | Remove-AzContainerAppAuthConfig +``` + +Delete a Container App AuthConfig. + +## PARAMETERS + +### -AuthConfigName +Name of the Container App AuthConfig. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerAppName +Name of the Container App. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Remove-AzContainerAppManagedEnv.md b/azps-10.1.0/Az.App/Remove-AzContainerAppManagedEnv.md new file mode 100644 index 0000000000..aa62c93259 --- /dev/null +++ b/azps-10.1.0/Az.App/Remove-AzContainerAppManagedEnv.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/remove-azcontainerappmanagedenv +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Remove-AzContainerAppManagedEnv.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Remove-AzContainerAppManagedEnv.md +--- + +# Remove-AzContainerAppManagedEnv + +## SYNOPSIS +Delete a Managed Environment if it does not have any container apps. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerAppManagedEnv -EnvName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerAppManagedEnv -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a Managed Environment if it does not have any container apps. + +## EXAMPLES + +### Example 1: Delete a Managed Environment. +```powershell +Remove-AzContainerAppManagedEnv -EnvName azps-env -ResourceGroupName azpstest_gp +``` + +Delete a Managed Environment. + +### Example 2: Delete a Managed Environment. +```powershell +Get-AzContainerAppManagedEnv -EnvName azps-env -ResourceGroupName azpstest_gp | Remove-AzContainerAppManagedEnv +``` + +Delete a Managed Environment. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Environment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Remove-AzContainerAppManagedEnvCert.md b/azps-10.1.0/Az.App/Remove-AzContainerAppManagedEnvCert.md new file mode 100644 index 0000000000..91e686837d --- /dev/null +++ b/azps-10.1.0/Az.App/Remove-AzContainerAppManagedEnvCert.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/remove-azcontainerappmanagedenvcert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Remove-AzContainerAppManagedEnvCert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Remove-AzContainerAppManagedEnvCert.md +--- + +# Remove-AzContainerAppManagedEnvCert + +## SYNOPSIS +Deletes the specified Certificate. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerAppManagedEnvCert -EnvName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerAppManagedEnvCert -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes the specified Certificate. + +## EXAMPLES + +### Example 1: Deletes the specified Certificate. +```powershell +Remove-AzContainerAppManagedEnvCert -EnvName azps-env -ResourceGroupName azpstest_gp -Name azps-env-cert-02 +``` + +Deletes the specified Certificate. + +### Example 2: Deletes the specified Certificate. +```powershell +Get-AzContainerAppManagedEnvCert -EnvName azps-env -ResourceGroupName azpstest_gp -Name azps-env-cert-02 | Remove-AzContainerAppManagedEnvCert +``` + +Deletes the specified Certificate. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Managed Environment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Certificate. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Remove-AzContainerAppManagedEnvDapr.md b/azps-10.1.0/Az.App/Remove-AzContainerAppManagedEnvDapr.md new file mode 100644 index 0000000000..4a3d1d7c6a --- /dev/null +++ b/azps-10.1.0/Az.App/Remove-AzContainerAppManagedEnvDapr.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/remove-azcontainerappmanagedenvdapr +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Remove-AzContainerAppManagedEnvDapr.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Remove-AzContainerAppManagedEnvDapr.md +--- + +# Remove-AzContainerAppManagedEnvDapr + +## SYNOPSIS +Delete a Dapr Component from a Managed Environment. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerAppManagedEnvDapr -DaprName -EnvName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerAppManagedEnvDapr -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a Dapr Component from a Managed Environment. + +## EXAMPLES + +### Example 1: Delete a Dapr Component from a Managed Environment. +```powershell +Remove-AzContainerAppManagedEnvDapr -EnvName azps-env -ResourceGroupName azpstest_gp -DaprName azps-dapr +``` + +Delete a Dapr Component from a Managed Environment. + +### Example 2: Delete a Dapr Component from a Managed Environment. +```powershell +Get-AzContainerAppManagedEnvDapr -EnvName azps-env -ResourceGroupName azpstest_gp -DaprName azps-dapr | Remove-AzContainerAppManagedEnvDapr +``` + +Delete a Dapr Component from a Managed Environment. + +## PARAMETERS + +### -DaprName +Name of the Dapr Component. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Managed Environment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Remove-AzContainerAppManagedEnvStorage.md b/azps-10.1.0/Az.App/Remove-AzContainerAppManagedEnvStorage.md new file mode 100644 index 0000000000..13b18fec4b --- /dev/null +++ b/azps-10.1.0/Az.App/Remove-AzContainerAppManagedEnvStorage.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/remove-azcontainerappmanagedenvstorage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Remove-AzContainerAppManagedEnvStorage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Remove-AzContainerAppManagedEnvStorage.md +--- + +# Remove-AzContainerAppManagedEnvStorage + +## SYNOPSIS +Delete storage for a managedEnvironment. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerAppManagedEnvStorage -EnvName -ResourceGroupName -StorageName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerAppManagedEnvStorage -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete storage for a managedEnvironment. + +## EXAMPLES + +### Example 1: Delete storage for a managedEnvironment. +```powershell +Remove-AzContainerAppManagedEnvStorage -EnvName azps-env -ResourceGroupName azpstest_gp -StorageName azpstestsa +``` + +Delete storage for a managedEnvironment. + +### Example 2: Delete storage for a managedEnvironment. +```powershell +Get-AzContainerAppManagedEnvStorage -EnvName azps-env -ResourceGroupName azpstest_gp -StorageName azpstestsa | Remove-AzContainerAppManagedEnvStorage +``` + +Delete storage for a managedEnvironment. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Environment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageName +Name of the storage. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Restart-AzContainerAppRevision.md b/azps-10.1.0/Az.App/Restart-AzContainerAppRevision.md new file mode 100644 index 0000000000..539e2ebea8 --- /dev/null +++ b/azps-10.1.0/Az.App/Restart-AzContainerAppRevision.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/restart-azcontainerapprevision +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Restart-AzContainerAppRevision.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Restart-AzContainerAppRevision.md +--- + +# Restart-AzContainerAppRevision + +## SYNOPSIS +Restarts a revision for a Container App + +## SYNTAX + +### Restart (Default) +``` +Restart-AzContainerAppRevision -ContainerAppName -ResourceGroupName -RevisionName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### RestartViaIdentity +``` +Restart-AzContainerAppRevision -InputObject [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Restarts a revision for a Container App + +## EXAMPLES + +### Example 1: Restarts a revision for a Container App +```powershell +Restart-AzContainerAppRevision -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp -RevisionName azps-containerapp--ksjb6f1 + +Get-AzContainerAppRevision -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp +``` + +```output +Name Active TrafficWeight ProvisioningState ResourceGroupName +---- ------ ------------- ----------------- ----------------- +azps-containerapp--ksjb6f1 True 100 Provisioned azpstest_gp +``` + +Restarts a revision for a Container App + +## PARAMETERS + +### -ContainerAppName +Name of the Container App. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RevisionName +Name of the Container App Revision. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Update-AzContainerApp.md b/azps-10.1.0/Az.App/Update-AzContainerApp.md new file mode 100644 index 0000000000..430926c4d6 --- /dev/null +++ b/azps-10.1.0/Az.App/Update-AzContainerApp.md @@ -0,0 +1,694 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/update-azcontainerapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Update-AzContainerApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Update-AzContainerApp.md +--- + +# Update-AzContainerApp + +## SYNOPSIS +Patches a Container App using JSON Merge Patch + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzContainerApp -Name -ResourceGroupName -Location [-SubscriptionId ] + [-ConfigurationActiveRevisionsMode ] [-ConfigurationRegistry ] + [-ConfigurationSecret ] [-DaprAppId ] [-DaprAppPort ] + [-DaprAppProtocol ] [-DaprEnabled] [-IdentityType ] + [-IdentityUserAssignedIdentity ] [-IngressAllowInsecure] [-IngressCustomDomain ] + [-IngressExternal] [-IngressTargetPort ] [-IngressTraffic ] + [-IngressTransport ] [-ManagedEnvironmentId ] [-ScaleMaxReplica ] + [-ScaleMinReplica ] [-ScaleRule ] [-Tag ] [-TemplateContainer ] + [-TemplateRevisionSuffix ] [-TemplateVolume ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzContainerApp -InputObject -Location + [-ConfigurationActiveRevisionsMode ] [-ConfigurationRegistry ] + [-ConfigurationSecret ] [-DaprAppId ] [-DaprAppPort ] + [-DaprAppProtocol ] [-DaprEnabled] [-IdentityType ] + [-IdentityUserAssignedIdentity ] [-IngressAllowInsecure] [-IngressCustomDomain ] + [-IngressExternal] [-IngressTargetPort ] [-IngressTraffic ] + [-IngressTransport ] [-ManagedEnvironmentId ] [-ScaleMaxReplica ] + [-ScaleMinReplica ] [-ScaleRule ] [-Tag ] [-TemplateContainer ] + [-TemplateRevisionSuffix ] [-TemplateVolume ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Patches a Container App using JSON Merge Patch + +## EXAMPLES + +### Example 1: Update a Container App. +```powershell +$secretObject = Get-AzContainerAppSecret -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp +$newSecretObject = @(0..($secretObject.Count-1)) +[array]::copy($secretObject,$newSecretObject,$secretObject.Count) +$secretObject += New-AzContainerAppSecretObject -Name "yourkey" -Value "yourvalue" + +Update-AzContainerApp -ContainerAppName azps-containerapp -ResourceGroupName azpstest_gp -Location canadacentral -ConfigurationSecret $secretObject -DaprEnabled -DaprAppProtocol 'http' -DaprAppId "container-app-1" -DaprAppPort 8080 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +Canada Central azps-containerapp azpstest_gp +``` + +Update a Container App. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationActiveRevisionsMode +ActiveRevisionsMode controls how active revisions are handled for the Container app:\\Multiple: multiple revisions can be active.\\Single: Only one revision can be active at a time. +Revision weights can not be used in this mode. +If no value if provided, this is the default.\\ + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.ActiveRevisionsMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationRegistry +Collection of private container registry credentials for containers used by the Container app +To construct, see NOTES section for CONFIGURATIONREGISTRY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IRegistryCredentials[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationSecret +Collection of secrets used by a Container app +To construct, see NOTES section for CONFIGURATIONSECRET properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ISecret[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaprAppId +Dapr application identifier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaprAppPort +Tells Dapr which port your application is listening on + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaprAppProtocol +Tells Dapr which protocol your application is using. +Valid options are http and grpc. +Default is http + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.AppProtocol +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaprEnabled +Boolean indicating if the Dapr side car is enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngressAllowInsecure +Bool indicating if HTTP connections to is allowed. +If set to false HTTP connections are automatically redirected to HTTPS connections + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngressCustomDomain +custom domain bindings for Container Apps' hostnames. +To construct, see NOTES section for INGRESSCUSTOMDOMAIN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ICustomDomain[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngressExternal +Bool indicating if app exposes an external http endpoint + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngressTargetPort +Target Port in containers for traffic from ingress + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngressTraffic +Traffic weights for app's revisions +To construct, see NOTES section for INGRESSTRAFFIC properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ITrafficWeight[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngressTransport +Ingress transport protocol + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Support.IngressTransportMethod +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.App.Models.IAppIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedEnvironmentId +Resource ID of the Container App's environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Container App. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ContainerAppName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleMaxReplica +Optional. +Maximum number of container replicas. +Defaults to 10 if not set. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleMinReplica +Optional. +Minimum number of container replicas. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleRule +Scaling rules. +To construct, see NOTES section for SCALERULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IScaleRule[] +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateContainer +List of container definitions for the Container App. +To construct, see NOTES section for TEMPLATECONTAINER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IContainer[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateRevisionSuffix +User friendly suffix that is appended to the revision name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateVolume +List of volume definitions for the Container App. +To construct, see NOTES section for TEMPLATEVOLUME properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IVolume[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.IContainerApp + +## 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. + + +`CONFIGURATIONREGISTRY `: Collection of private container registry credentials for containers used by the Container app + - `[Identity ]`: A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system' + - `[PasswordSecretRef ]`: The name of the Secret that contains the registry login password + - `[Server ]`: Container Registry Server + - `[Username ]`: Container Registry Username + +`CONFIGURATIONSECRET `: Collection of secrets used by a Container app + - `[Name ]`: Secret Name. + - `[Value ]`: Secret Value. + +`INGRESSCUSTOMDOMAIN `: custom domain bindings for Container Apps' hostnames. + - `CertificateId `: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. + - `Name `: Hostname. + - `[BindingType ]`: Custom Domain binding type. + +`INGRESSTRAFFIC `: Traffic weights for app's revisions + - `[Label ]`: Associates a traffic label with a revision + - `[LatestRevision ]`: Indicates that the traffic weight belongs to a latest stable revision + - `[RevisionName ]`: Name of a revision + - `[Weight ]`: Traffic weight assigned to a revision + +`INPUTOBJECT `: Identity Parameter + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +`SCALERULE `: Scaling rules. + - `[AzureQueueAuth ]`: Authentication secrets for the queue scale rule. + - `[SecretRef ]`: Name of the Container App secret from which to pull the auth params. + - `[TriggerParameter ]`: Trigger Parameter that uses the secret + - `[AzureQueueLength ]`: Queue length. + - `[AzureQueueName ]`: Queue name. + - `[CustomAuth ]`: Authentication secrets for the custom scale rule. + - `[CustomMetadata ]`: Metadata properties to describe custom scale rule. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[CustomType ]`: Type of the custom scale rule eg: azure-servicebus, redis etc. + - `[HttpAuth ]`: Authentication secrets for the custom scale rule. + - `[HttpMetadata ]`: Metadata properties to describe http scale rule. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[Name ]`: Scale Rule Name + +`TEMPLATECONTAINER `: List of container definitions for the Container App. + - `[Arg ]`: Container start command arguments. + - `[Command ]`: Container start command. + - `[Env ]`: Container environment variables. + - `[Name ]`: Environment variable name. + - `[SecretRef ]`: Name of the Container App secret from which to pull the environment variable value. + - `[Value ]`: Non-secret environment variable value. + - `[Image ]`: Container image tag. + - `[Name ]`: Custom container name. + - `[Probe ]`: List of probes for the container. + - `[FailureThreshold ]`: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10. + - `[HttpGetHost ]`: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + - `[HttpGetHttpHeader ]`: Custom headers to set in the request. HTTP allows repeated headers. + - `Name `: The header field name + - `Value `: The header field value + - `[HttpGetPath ]`: Path to access on the HTTP server. + - `[HttpGetPort ]`: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + - `[HttpGetScheme ]`: Scheme to use for connecting to the host. Defaults to HTTP. + - `[InitialDelaySecond ]`: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. + - `[PeriodSecond ]`: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. + - `[SuccessThreshold ]`: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10. + - `[TcpSocketHost ]`: Optional: Host name to connect to, defaults to the pod IP. + - `[TcpSocketPort ]`: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + - `[TerminationGracePeriodSecond ]`: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour) + - `[TimeoutSecond ]`: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. + - `[Type ]`: The type of probe. + - `[ResourceCpu ]`: Required CPU in cores, e.g. 0.5 + - `[ResourceMemory ]`: Required memory, e.g. "250Mb" + - `[VolumeMount ]`: Container volume mounts. + - `[MountPath ]`: Path within the container at which the volume should be mounted.Must not contain ':'. + - `[VolumeName ]`: This must match the Name of a Volume. + +`TEMPLATEVOLUME `: List of volume definitions for the Container App. + - `[Name ]`: Volume name. + - `[StorageName ]`: Name of storage resource. No need to provide for EmptyDir. + - `[StorageType ]`: Storage type for the volume. If not provided, use EmptyDir. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.App/Update-AzContainerAppManagedEnvCert.md b/azps-10.1.0/Az.App/Update-AzContainerAppManagedEnvCert.md new file mode 100644 index 0000000000..af07bcf362 --- /dev/null +++ b/azps-10.1.0/Az.App/Update-AzContainerAppManagedEnvCert.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.App +online version: https://learn.microsoft.com/powershell/module/az.app/update-azcontainerappmanagedenvcert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Update-AzContainerAppManagedEnvCert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/App/help/Update-AzContainerAppManagedEnvCert.md +--- + +# Update-AzContainerAppManagedEnvCert + +## SYNOPSIS +Patches a certificate. +Currently only patching of tags is supported + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzContainerAppManagedEnvCert -EnvName -Name -ResourceGroupName + [-SubscriptionId ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzContainerAppManagedEnvCert -InputObject [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Patches a certificate. +Currently only patching of tags is supported + +## EXAMPLES + +### Example 1: Patches a certificate. +```powershell +Update-AzContainerAppManagedEnvCert -EnvName azps-env -ResourceGroupName azpstest_gp -Name azps-env-cert -Tag @{"123"="abc"} +``` + +```output +Name Location Issuer ProvisioningState SubjectName Thumbprint ResourceGroupName +---- -------- ------ ----------------- ----------- ---------- ----------------- +azps-env-cert canadacentral CN=www.fabrikam.com Succeeded CN=www.fabrikam.com 684DFA8457230B8A04675FBCB7251FA88AE10D80 azpstest_gp +``` + +Currently only patching of tags is supported. + +### Example 2: Patches a certificate. +```powershell +Get-AzContainerAppManagedEnvCert -EnvName azps-env -ResourceGroupName azpstest_gp -Name azps-env-cert | Update-AzContainerAppManagedEnvCert -Tag @{"123"="abc"} +``` + +```output +Name Location Issuer ProvisioningState SubjectName Thumbprint ResourceGroupName +---- -------- ------ ----------------- ----------- ---------- ----------------- +azps-env-cert canadacentral CN=www.fabrikam.com Succeeded CN=www.fabrikam.com 684DFA8457230B8A04675FBCB7251FA88AE10D80 azpstest_gp +``` + +Currently only patching of tags is supported. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvName +Name of the Managed Environment. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Certificate. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.App.Models.Api20220301.ICertificate + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AuthConfigName ]`: Name of the Container App AuthConfig. + - `[CertificateName ]`: Name of the Certificate. + - `[ComponentName ]`: Name of the Dapr Component. + - `[ContainerAppName ]`: Name of the Container App. + - `[EnvironmentName ]`: Name of the Managed Environment. + - `[Id ]`: Resource identity path + - `[ReplicaName ]`: Name of the Container App Revision Replica. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[RevisionName ]`: Name of the Container App Revision. + - `[SourceControlName ]`: Name of the Container App SourceControl. + - `[StorageName ]`: Name of the storage. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.AppConfiguration/Az.AppConfiguration.md b/azps-10.1.0/Az.AppConfiguration/Az.AppConfiguration.md new file mode 100644 index 0000000000..f57d05ea86 --- /dev/null +++ b/azps-10.1.0/Az.AppConfiguration/Az.AppConfiguration.md @@ -0,0 +1,42 @@ +--- +Module Name: Az.AppConfiguration +Module Guid: d297739c-d9bb-4bdc-8b1c-b3b577d9215a +Download Help Link: https://learn.microsoft.com/powershell/module/az.appconfiguration +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Az.AppConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Az.AppConfiguration.md +--- + +# Az.AppConfiguration Module +## Description +Microsoft Azure PowerShell: AppConfiguration cmdlets + +## Az.AppConfiguration Cmdlets +### [Clear-AzAppConfigurationDeletedStore](Clear-AzAppConfigurationDeletedStore.md) +Permanently deletes the specified configuration store. + +### [Get-AzAppConfigurationDeletedStore](Get-AzAppConfigurationDeletedStore.md) +Gets a deleted Azure app configuration store. + +### [Get-AzAppConfigurationStore](Get-AzAppConfigurationStore.md) +Get or list app configuration stores. + +### [Get-AzAppConfigurationStoreKey](Get-AzAppConfigurationStoreKey.md) +Lists the access key for the specified configuration store. + +### [New-AzAppConfigurationStore](New-AzAppConfigurationStore.md) +Creates a configuration store with the specified parameters. + +### [New-AzAppConfigurationStoreKey](New-AzAppConfigurationStoreKey.md) +Regenerates an access key for the specified configuration store. + +### [Remove-AzAppConfigurationStore](Remove-AzAppConfigurationStore.md) +Deletes a configuration store. + +### [Test-AzAppConfigurationStoreNameAvailability](Test-AzAppConfigurationStoreNameAvailability.md) +Checks whether the configuration store name is available for use. + +### [Update-AzAppConfigurationStore](Update-AzAppConfigurationStore.md) +Updates a configuration store with the specified parameters. + diff --git a/azps-10.1.0/Az.AppConfiguration/Clear-AzAppConfigurationDeletedStore.md b/azps-10.1.0/Az.AppConfiguration/Clear-AzAppConfigurationDeletedStore.md new file mode 100644 index 0000000000..55083471fc --- /dev/null +++ b/azps-10.1.0/Az.AppConfiguration/Clear-AzAppConfigurationDeletedStore.md @@ -0,0 +1,225 @@ +--- +external help file: Az.AppConfiguration-help.xml +Module Name: Az.AppConfiguration +online version: https://learn.microsoft.com/powershell/module/az.appconfiguration/clear-azappconfigurationdeletedstore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Clear-AzAppConfigurationDeletedStore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Clear-AzAppConfigurationDeletedStore.md +--- + +# Clear-AzAppConfigurationDeletedStore + +## SYNOPSIS +Permanently deletes the specified configuration store. + +## SYNTAX + +### Purge (Default) +``` +Clear-AzAppConfigurationDeletedStore -Location -Name [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### PurgeViaIdentity +``` +Clear-AzAppConfigurationDeletedStore -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Permanently deletes the specified configuration store. + +## EXAMPLES + +### Example 1: Permanently deletes the specified configuration store. +```powershell +Clear-AzAppConfigurationDeletedStore -Location eastus -Name azpstestappstore +``` + +Permanently deletes the specified configuration store. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity +Parameter Sets: PurgeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location in which uniqueness will be verified. + +```yaml +Type: System.String +Parameter Sets: Purge +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the configuration store. + +```yaml +Type: System.String +Parameter Sets: Purge +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Microsoft Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Purge +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[ConfigStoreName ]`: The name of the configuration store. + - `[GroupName ]`: The name of the private link resource group. + - `[Id ]`: Resource identity path + - `[KeyValueName ]`: Identifier of key and label combination. Key and label are joined by $ character. Label is optional. + - `[Location ]`: The location in which uniqueness will be verified. + - `[PrivateEndpointConnectionName ]`: Private endpoint connection name + - `[ResourceGroupName ]`: The name of the resource group to which the container registry belongs. + - `[SubscriptionId ]`: The Microsoft Azure subscription ID. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AppConfiguration/Get-AzAppConfigurationDeletedStore.md b/azps-10.1.0/Az.AppConfiguration/Get-AzAppConfigurationDeletedStore.md new file mode 100644 index 0000000000..1c1ff39335 --- /dev/null +++ b/azps-10.1.0/Az.AppConfiguration/Get-AzAppConfigurationDeletedStore.md @@ -0,0 +1,176 @@ +--- +external help file: Az.AppConfiguration-help.xml +Module Name: Az.AppConfiguration +online version: https://learn.microsoft.com/powershell/module/az.appconfiguration/get-azappconfigurationdeletedstore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Get-AzAppConfigurationDeletedStore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Get-AzAppConfigurationDeletedStore.md +--- + +# Get-AzAppConfigurationDeletedStore + +## SYNOPSIS +Gets a deleted Azure app configuration store. + +## SYNTAX + +### List (Default) +``` +Get-AzAppConfigurationDeletedStore [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzAppConfigurationDeletedStore -Location -Name [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAppConfigurationDeletedStore -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets a deleted Azure app configuration store. + +## EXAMPLES + +### Example 1: Gets a deleted Azure app configuration store. +```powershell +Remove-AzAppConfigurationStore -Name azpstestappstore -ResourceGroupName azpstest-gp +Get-AzAppConfigurationDeletedStore +``` + +```output +Name ResourceGroupName +---- ----------------- +azpstestappstore +``` + +Gets a deleted Azure app configuration store. + +### Example 2: Gets a deleted Azure app configuration store. +```powershell +Remove-AzAppConfigurationStore -Name azpstestappstore -ResourceGroupName azpstest-gp +Get-AzAppConfigurationDeletedStore -Location eastus -Name azpstestappstore +``` + +```output +Name ResourceGroupName +---- ----------------- +azpstestappstore +``` + +Gets a deleted Azure app configuration store. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location in which uniqueness will be verified. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the configuration store. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Microsoft Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.Api20220501.IDeletedConfigurationStore + +## 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 + - `[ConfigStoreName ]`: The name of the configuration store. + - `[GroupName ]`: The name of the private link resource group. + - `[Id ]`: Resource identity path + - `[KeyValueName ]`: Identifier of key and label combination. Key and label are joined by $ character. Label is optional. + - `[Location ]`: The location in which uniqueness will be verified. + - `[PrivateEndpointConnectionName ]`: Private endpoint connection name + - `[ResourceGroupName ]`: The name of the resource group to which the container registry belongs. + - `[SubscriptionId ]`: The Microsoft Azure subscription ID. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AppConfiguration/Get-AzAppConfigurationStore.md b/azps-10.1.0/Az.AppConfiguration/Get-AzAppConfigurationStore.md new file mode 100644 index 0000000000..3e2e09429b --- /dev/null +++ b/azps-10.1.0/Az.AppConfiguration/Get-AzAppConfigurationStore.md @@ -0,0 +1,193 @@ +--- +external help file: Az.AppConfiguration-help.xml +Module Name: Az.AppConfiguration +online version: https://learn.microsoft.com/powershell/module/az.appconfiguration/get-azappconfigurationstore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Get-AzAppConfigurationStore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Get-AzAppConfigurationStore.md +--- + +# Get-AzAppConfigurationStore + +## SYNOPSIS +Get or list app configuration stores. + +## SYNTAX + +### List (Default) +``` +Get-AzAppConfigurationStore [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAppConfigurationStore -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzAppConfigurationStore -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAppConfigurationStore -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get or list app configuration stores. + +## EXAMPLES + +### Example 1: List all app configuration stores under a subscription +```powershell +Get-AzAppConfigurationStore +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstest-appstore azpstest_gp +eastus azpstestappstore azpstest-gp +``` + +This command lists all app configuration stores under a subscription. + +### Example 2: List all app configuration stores under a resource group +```powershell +Get-AzAppConfigurationStore -ResourceGroupName azpstest_gp +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstest-appstore azpstest_gp +``` + +This command lists all app configuration stores under a resource group. + +### Example 3: Get an app configuration store by name +```powershell +Get-AzAppConfigurationStore -Name azpstest-appstore -ResourceGroupName azpstest_gp +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstest-appstore azpstest_gp +``` + +This command gets an app configuration store by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the configuration store. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the container registry belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Microsoft Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.Api20220501.IConfigurationStore + +## 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 + - `[ConfigStoreName ]`: The name of the configuration store. + - `[GroupName ]`: The name of the private link resource group. + - `[Id ]`: Resource identity path + - `[KeyValueName ]`: Identifier of key and label combination. Key and label are joined by $ character. Label is optional. + - `[Location ]`: The location in which uniqueness will be verified. + - `[PrivateEndpointConnectionName ]`: Private endpoint connection name + - `[ResourceGroupName ]`: The name of the resource group to which the container registry belongs. + - `[SubscriptionId ]`: The Microsoft Azure subscription ID. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AppConfiguration/Get-AzAppConfigurationStoreKey.md b/azps-10.1.0/Az.AppConfiguration/Get-AzAppConfigurationStoreKey.md new file mode 100644 index 0000000000..9193cb4645 --- /dev/null +++ b/azps-10.1.0/Az.AppConfiguration/Get-AzAppConfigurationStoreKey.md @@ -0,0 +1,149 @@ +--- +external help file: Az.AppConfiguration-help.xml +Module Name: Az.AppConfiguration +online version: https://learn.microsoft.com/powershell/module/az.appconfiguration/get-azappconfigurationstorekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Get-AzAppConfigurationStoreKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Get-AzAppConfigurationStoreKey.md +--- + +# Get-AzAppConfigurationStoreKey + +## SYNOPSIS +Lists the access key for the specified configuration store. + +## SYNTAX + +``` +Get-AzAppConfigurationStoreKey -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Lists the access key for the specified configuration store. + +## EXAMPLES + +### Example 1: List all store keys of an app configuration store +```powershell +Get-AzAppConfigurationStoreKey -Name azpstest-appstore -ResourceGroupName azpstest_gp +``` + +```output +ConnectionString LastModified Name ReadOnly ResourceGroupName Value +---------------- ------------ ---- -------- ----------------- --- +Endpoint=https://azpstest-appstore.azconfig.io;Id=SXvQ-l0-s0:1EG/TDfXP30kHZoLxGxb;Secret=GknYAPIAFixLJw5wfGOGt0dgwj0hr2eGoRnusIgkNdc= 2022-08-24 AM 06:11:51 Secondary False Gk… +Endpoint=https://azpstest-appstore.azconfig.io;Id=WCoZ-l0-s0:OY71pf8vbFCZTtDpuIfE;Secret=06+woMjMn4iQNhpvmpCuLQys0qjGXbal3UFgQxAipas= 2022-08-24 AM 06:11:51 Primary Read Only True 06… +Endpoint=https://azpstest-appstore.azconfig.io;Id=7sDt-l0-s0:1tEtn3TApcmgJjk0PlqM;Secret=jZDAxcgFtEhj5ug2VYjUvdImaHybGwRSvkq45dvnVFk= 2022-08-24 AM 06:11:51 Secondary Read Only True jZ… +Endpoint=https://azpstest-appstore.azconfig.io;Id=m6TW-l0-s0:g302jTPLEpvmI0AahitF;Secret=vt5aKm6ezq2iVKNjQo+dQpA8QyuH1UhH9Jv8N3jfZdE= 2022-08-24 AM 06:13:21 Primary False vt… +``` + +This command lists all store keys of an app configuration store. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the configuration store. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the container registry belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Microsoft Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.Api20220501.IApiKey + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AppConfiguration/New-AzAppConfigurationStore.md b/azps-10.1.0/Az.AppConfiguration/New-AzAppConfigurationStore.md new file mode 100644 index 0000000000..2501528ac1 --- /dev/null +++ b/azps-10.1.0/Az.AppConfiguration/New-AzAppConfigurationStore.md @@ -0,0 +1,382 @@ +--- +external help file: Az.AppConfiguration-help.xml +Module Name: Az.AppConfiguration +online version: https://learn.microsoft.com/powershell/module/az.appconfiguration/new-azappconfigurationstore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/New-AzAppConfigurationStore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/New-AzAppConfigurationStore.md +--- + +# New-AzAppConfigurationStore + +## SYNOPSIS +Creates a configuration store with the specified parameters. + +## SYNTAX + +``` +New-AzAppConfigurationStore -Name -ResourceGroupName [-SubscriptionId ] + -Location -Sku [-CreateMode ] [-DisableLocalAuth] [-EnablePurgeProtection] + [-EncryptionKeyIdentifier ] [-IdentityType ] [-KeyVaultIdentityClientId ] + [-PublicNetworkAccess ] [-SoftDeleteRetentionInDay ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Creates a configuration store with the specified parameters. + +## EXAMPLES + +### Example 1: Creates a configuration store with the specified parameters. +```powershell +New-AzAppConfigurationStore -Name azpstest-appstore -ResourceGroupName azpstest_gp -Location eastus -Sku Standard +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstest-appstore azpstest_gp +``` + +Creates a configuration store with the specified parameters. + +### Example 2: Recover one deleted store. +```powershell +$storeName = "azpstest-appstore-recover" +$resourceGroupName = "azpstest_gp" +$location = "eastus" +New-AzAppConfigurationStore -Name $storeName -ResourceGroupName $resourceGroupName -Location $location -Sku Standard +Remove-AzAppConfigurationStore -Name $storeName -ResourceGroupName $resourceGroupName +Get-AzAppConfigurationDeletedStore -Location $location -Name $storeName +New-AzAppConfigurationStore -Name $storeName -ResourceGroupName $resourceGroupName -Location $location -Sku Standard -CreateMode 'Recover' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstest-appstore-recover azpstest_gp +``` + +Recover one deleted store. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateMode +Indicates whether the configuration store need to be recovered. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Support.CreateMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Disables all authentication methods other than AAD authentication. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePurgeProtection +Property specifying whether protection against purge is enabled for this configuration store. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyIdentifier +The URI of the key vault key used to encrypt data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The type of managed identity used. +The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. +The type 'None' will remove any identities. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Support.IdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultIdentityClientId +The client id of the identity which will be used to access key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the configuration store. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Control permission for data plane traffic coming from public networks while private endpoint is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the container registry belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SKU name of the configuration store. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeleteRetentionInDay +The amount of time in days that the configuration store will be retained when it is soft deleted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Microsoft Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The list of user-assigned identities associated with the resource. +The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.Api20220501.IConfigurationStore + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AppConfiguration/New-AzAppConfigurationStoreKey.md b/azps-10.1.0/Az.AppConfiguration/New-AzAppConfigurationStoreKey.md new file mode 100644 index 0000000000..56551a05e1 --- /dev/null +++ b/azps-10.1.0/Az.AppConfiguration/New-AzAppConfigurationStoreKey.md @@ -0,0 +1,202 @@ +--- +external help file: Az.AppConfiguration-help.xml +Module Name: Az.AppConfiguration +online version: https://learn.microsoft.com/powershell/module/az.appconfiguration/new-azappconfigurationstorekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/New-AzAppConfigurationStoreKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/New-AzAppConfigurationStoreKey.md +--- + +# New-AzAppConfigurationStoreKey + +## SYNOPSIS +Regenerates an access key for the specified configuration store. + +## SYNTAX + +### RegenerateExpanded (Default) +``` +New-AzAppConfigurationStoreKey -Name -ResourceGroupName [-SubscriptionId ] + -Id [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### RegenerateViaIdentityExpanded +``` +New-AzAppConfigurationStoreKey -InputObject -Id + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Regenerates an access key for the specified configuration store. + +## EXAMPLES + +### Example 1: Regenerate key of an app configuration store +```powershell +$keys = Get-AzAppConfigurationStoreKey -Name azpstest-appstore -ResourceGroupName azpstest_gp +New-AzAppConfigurationStoreKey -Name azpstest-appstore -ResourceGroupName azpstest_gp -Id $keys[0].id +``` + +```output +ConnectionString LastModified Name ReadOnly ResourceGroupName Value +---------------- ------------ ---- -------- ----------------- ----- +Endpoint=https://azpstest-appstore.azconfig.io;Id=m6TW-l0-s0:g302jTPLEpvmI0AahitF;Secret=vt5aKm6ezq2iVKNjQo+dQpA8QyuH1UhH9Jv8N3jfZdE= 2022-08-24 AM 06:13:21 Primary False vt5aKm6ezq2iV… +``` + +This command regenerate key of an app configuration store. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The id of the key to regenerate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity +Parameter Sets: RegenerateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the configuration store. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the container registry belongs. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Microsoft Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.Api20220501.IApiKey + +## 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 + - `[ConfigStoreName ]`: The name of the configuration store. + - `[GroupName ]`: The name of the private link resource group. + - `[Id ]`: Resource identity path + - `[KeyValueName ]`: Identifier of key and label combination. Key and label are joined by $ character. Label is optional. + - `[Location ]`: The location in which uniqueness will be verified. + - `[PrivateEndpointConnectionName ]`: Private endpoint connection name + - `[ResourceGroupName ]`: The name of the resource group to which the container registry belongs. + - `[SubscriptionId ]`: The Microsoft Azure subscription ID. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AppConfiguration/Remove-AzAppConfigurationStore.md b/azps-10.1.0/Az.AppConfiguration/Remove-AzAppConfigurationStore.md new file mode 100644 index 0000000000..a8e3228d32 --- /dev/null +++ b/azps-10.1.0/Az.AppConfiguration/Remove-AzAppConfigurationStore.md @@ -0,0 +1,232 @@ +--- +external help file: Az.AppConfiguration-help.xml +Module Name: Az.AppConfiguration +online version: https://learn.microsoft.com/powershell/module/az.appconfiguration/remove-azappconfigurationstore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Remove-AzAppConfigurationStore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Remove-AzAppConfigurationStore.md +--- + +# Remove-AzAppConfigurationStore + +## SYNOPSIS +Deletes a configuration store. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAppConfigurationStore -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAppConfigurationStore -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a configuration store. + +## EXAMPLES + +### Example 1: Remove an app configuration store +```powershell +Remove-AzAppConfigurationStore -Name azpstestappstore -ResourceGroupName azpstest-gp +``` + +This command removes an app configuration store. + +### Example 2: Remove an app configuration store +```powershell +Get-AzAppConfigurationStore -Name azpstest-appstore -ResourceGroupName azpstest_gp | Remove-AzAppConfigurationStore +``` + +This command removes an app configuration store. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the configuration store. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the container registry belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Microsoft Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[ConfigStoreName ]`: The name of the configuration store. + - `[GroupName ]`: The name of the private link resource group. + - `[Id ]`: Resource identity path + - `[KeyValueName ]`: Identifier of key and label combination. Key and label are joined by $ character. Label is optional. + - `[Location ]`: The location in which uniqueness will be verified. + - `[PrivateEndpointConnectionName ]`: Private endpoint connection name + - `[ResourceGroupName ]`: The name of the resource group to which the container registry belongs. + - `[SubscriptionId ]`: The Microsoft Azure subscription ID. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AppConfiguration/Test-AzAppConfigurationStoreNameAvailability.md b/azps-10.1.0/Az.AppConfiguration/Test-AzAppConfigurationStoreNameAvailability.md new file mode 100644 index 0000000000..d025c7bc7b --- /dev/null +++ b/azps-10.1.0/Az.AppConfiguration/Test-AzAppConfigurationStoreNameAvailability.md @@ -0,0 +1,131 @@ +--- +external help file: Az.AppConfiguration-help.xml +Module Name: Az.AppConfiguration +online version: https://learn.microsoft.com/powershell/module/az.appconfiguration/test-azappconfigurationstorenameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Test-AzAppConfigurationStoreNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Test-AzAppConfigurationStoreNameAvailability.md +--- + +# Test-AzAppConfigurationStoreNameAvailability + +## SYNOPSIS +Checks whether the configuration store name is available for use. + +## SYNTAX + +``` +Test-AzAppConfigurationStoreNameAvailability [-SubscriptionId ] -Name + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Checks whether the configuration store name is available for use. + +## EXAMPLES + +### Example 1: Test availability of the app configuration store name +```powershell +Test-AzAppConfigurationStoreNameAvailability -Name appconfig-test01 +``` + +```output +Message NameAvailable Reason +------- ------------- ------ +The specified name is available. True +``` + +This command tests availability of the app configuration store name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name to check for availability. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Microsoft Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.Api20220501.INameAvailabilityStatus + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.AppConfiguration/Update-AzAppConfigurationStore.md b/azps-10.1.0/Az.AppConfiguration/Update-AzAppConfigurationStore.md new file mode 100644 index 0000000000..73949c0bf3 --- /dev/null +++ b/azps-10.1.0/Az.AppConfiguration/Update-AzAppConfigurationStore.md @@ -0,0 +1,374 @@ +--- +external help file: Az.AppConfiguration-help.xml +Module Name: Az.AppConfiguration +online version: https://learn.microsoft.com/powershell/module/az.appconfiguration/update-azappconfigurationstore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Update-AzAppConfigurationStore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/AppConfiguration/AppConfiguration/help/Update-AzAppConfigurationStore.md +--- + +# Update-AzAppConfigurationStore + +## SYNOPSIS +Updates a configuration store with the specified parameters. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAppConfigurationStore -Name -ResourceGroupName [-SubscriptionId ] + [-DisableLocalAuth] [-EnablePurgeProtection] [-EncryptionKeyIdentifier ] + [-IdentityType ] [-KeyVaultIdentityClientId ] + [-PublicNetworkAccess ] [-Sku ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAppConfigurationStore -InputObject [-DisableLocalAuth] + [-EnablePurgeProtection] [-EncryptionKeyIdentifier ] [-IdentityType ] + [-KeyVaultIdentityClientId ] [-PublicNetworkAccess ] [-Sku ] + [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Updates a configuration store with the specified parameters. + +## EXAMPLES + +### Example 1: Updates a configuration store with the specified parameters. +```powershell +Update-AzAppConfigurationStore -Name azpstest-appstore -ResourceGroupName azpstest_gp -DisableLocalAuth -EnablePurgeProtection -PublicNetworkAccess 'Enabled' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstest-appstore azpstest_gp +``` + +Updates a configuration store with the specified parameters. + +### Example 2: Updates a configuration store with the specified parameters. +```powershell +Get-AzAppConfigurationStore -Name azpstest-appstore -ResourceGroupName azpstest_gp | Update-AzAppConfigurationStore -DisableLocalAuth -EnablePurgeProtection -PublicNetworkAccess 'Enabled' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstest-appstore azpstest_gp +``` + +Updates a configuration store with the specified parameters. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Disables all authentication methods other than AAD authentication. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePurgeProtection +Property specifying whether protection against purge is enabled for this configuration store. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyIdentifier +The URI of the key vault key used to encrypt data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The type of managed identity used. +The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. +The type 'None' will remove any identities. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Support.IdentityType +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.AppConfiguration.Models.IAppConfigurationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyVaultIdentityClientId +The client id of the identity which will be used to access key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the configuration store. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Control permission for data plane traffic coming from public networks while private endpoint is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the container registry belongs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SKU name of the configuration store. + +```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 Microsoft Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The ARM resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The list of user-assigned identities associated with the resource. +The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.IAppConfigurationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.Api20220501.IConfigurationStore + +## 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 + - `[ConfigStoreName ]`: The name of the configuration store. + - `[GroupName ]`: The name of the private link resource group. + - `[Id ]`: Resource identity path + - `[KeyValueName ]`: Identifier of key and label combination. Key and label are joined by $ character. Label is optional. + - `[Location ]`: The location in which uniqueness will be verified. + - `[PrivateEndpointConnectionName ]`: Private endpoint connection name + - `[ResourceGroupName ]`: The name of the resource group to which the container registry belongs. + - `[SubscriptionId ]`: The Microsoft Azure subscription ID. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ApplicationInsights/Az.ApplicationInsights.md b/azps-10.1.0/Az.ApplicationInsights/Az.ApplicationInsights.md new file mode 100644 index 0000000000..cb11f86d61 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Az.ApplicationInsights.md @@ -0,0 +1,128 @@ +--- +Module Name: Az.ApplicationInsights +Module Guid: 031a685e-5904-433f-b2f8-4fcef3cd15d8 +Download Help Link: https://learn.microsoft.com/powershell/module/az.applicationinsights +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Az.ApplicationInsights.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Az.ApplicationInsights.md +--- + +# Az.ApplicationInsights Module +## Description +Microsoft Azure PowerShell: ApplicationInsights cmdlets + +## Az.ApplicationInsights Cmdlets +### [Get-AzApplicationInsights](Get-AzApplicationInsights.md) +Returns an Application Insights component. + +### [Get-AzApplicationInsightsApiKey](Get-AzApplicationInsightsApiKey.md) +Get the API Key for this key id. + +### [Get-AzApplicationInsightsContinuousExport](Get-AzApplicationInsightsContinuousExport.md) +Get the Continuous Export configuration for this export id. + +### [Get-AzApplicationInsightsLinkedStorageAccount](Get-AzApplicationInsightsLinkedStorageAccount.md) +Returns the current linked storage settings for an Application Insights component. + +### [Get-AzApplicationInsightsMyWorkbook](Get-AzApplicationInsightsMyWorkbook.md) +Get a single private workbook by its resourceName. + +### [Get-AzApplicationInsightsWebTest](Get-AzApplicationInsightsWebTest.md) +Get a specific Application Insights web test definition. + +### [Get-AzApplicationInsightsWorkbook](Get-AzApplicationInsightsWorkbook.md) +Get a single workbook by its resourceName. + +### [Get-AzApplicationInsightsWorkbookRevision](Get-AzApplicationInsightsWorkbookRevision.md) +Get a single workbook revision defined by its revisionId. + +### [Get-AzApplicationInsightsWorkbookTemplate](Get-AzApplicationInsightsWorkbookTemplate.md) +Get a single workbook template by its resourceName. + +### [New-AzApplicationInsights](New-AzApplicationInsights.md) +Creates (or updates) an Application Insights component. +Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. + +### [New-AzApplicationInsightsApiKey](New-AzApplicationInsightsApiKey.md) +Create an API Key of an Application Insights component. + +### [New-AzApplicationInsightsContinuousExport](New-AzApplicationInsightsContinuousExport.md) +Create a Continuous Export configuration of an Application Insights component. + +### [New-AzApplicationInsightsLinkedStorageAccount](New-AzApplicationInsightsLinkedStorageAccount.md) +Replace current linked storage account for an Application Insights component. + +### [New-AzApplicationInsightsMyWorkbook](New-AzApplicationInsightsMyWorkbook.md) +Create a new private workbook. + +### [New-AzApplicationInsightsWebTest](New-AzApplicationInsightsWebTest.md) +Creates or updates an Application Insights web test definition. + +### [New-AzApplicationInsightsWebTestGeolocationObject](New-AzApplicationInsightsWebTestGeolocationObject.md) +Create an in-memory object for WebTestGeolocation. + +### [New-AzApplicationInsightsWebTestHeaderFieldObject](New-AzApplicationInsightsWebTestHeaderFieldObject.md) +Create a in-memory object for HeaderField + +### [New-AzApplicationInsightsWorkbook](New-AzApplicationInsightsWorkbook.md) +Create a new workbook. + +### [New-AzApplicationInsightsWorkbookTemplate](New-AzApplicationInsightsWorkbookTemplate.md) +Create a new workbook template. + +### [New-AzApplicationInsightsWorkbookTemplateGalleryObject](New-AzApplicationInsightsWorkbookTemplateGalleryObject.md) +Create an in-memory object for WorkbookTemplateGallery. + +### [Remove-AzApplicationInsights](Remove-AzApplicationInsights.md) +Deletes an Application Insights component. + +### [Remove-AzApplicationInsightsApiKey](Remove-AzApplicationInsightsApiKey.md) +Delete an API Key of an Application Insights component. + +### [Remove-AzApplicationInsightsContinuousExport](Remove-AzApplicationInsightsContinuousExport.md) +Delete a Continuous Export configuration of an Application Insights component. + +### [Remove-AzApplicationInsightsLinkedStorageAccount](Remove-AzApplicationInsightsLinkedStorageAccount.md) +Delete linked storage accounts for an Application Insights component. + +### [Remove-AzApplicationInsightsMyWorkbook](Remove-AzApplicationInsightsMyWorkbook.md) +Delete a private workbook. + +### [Remove-AzApplicationInsightsWebTest](Remove-AzApplicationInsightsWebTest.md) +Deletes an Application Insights web test. + +### [Remove-AzApplicationInsightsWorkbook](Remove-AzApplicationInsightsWorkbook.md) +Delete a workbook. + +### [Remove-AzApplicationInsightsWorkbookTemplate](Remove-AzApplicationInsightsWorkbookTemplate.md) +Delete a workbook template. + +### [Set-AzApplicationInsightsContinuousExport](Set-AzApplicationInsightsContinuousExport.md) +Create a Continuous Export configuration of an Application Insights component. + +### [Set-AzApplicationInsightsDailyCap](Set-AzApplicationInsightsDailyCap.md) +Update current billing features for an Application Insights component. + +### [Set-AzApplicationInsightsPricingPlan](Set-AzApplicationInsightsPricingPlan.md) +Update current billing features for an Application Insights component. + +### [Update-AzApplicationInsights](Update-AzApplicationInsights.md) +Creates (or updates) an Application Insights component. +Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. + +### [Update-AzApplicationInsightsLinkedStorageAccount](Update-AzApplicationInsightsLinkedStorageAccount.md) +Update linked storage accounts for an Application Insights component. + +### [Update-AzApplicationInsightsMyWorkbook](Update-AzApplicationInsightsMyWorkbook.md) +Updates a private workbook that has already been added. + +### [Update-AzApplicationInsightsWebTestTag](Update-AzApplicationInsightsWebTestTag.md) +Updates the tags associated with an Application Insights web test. + +### [Update-AzApplicationInsightsWorkbook](Update-AzApplicationInsightsWorkbook.md) +Updates a workbook that has already been added. + +### [Update-AzApplicationInsightsWorkbookTemplate](Update-AzApplicationInsightsWorkbookTemplate.md) +Updates a workbook template that has already been added. + diff --git a/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsights.md b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsights.md new file mode 100644 index 0000000000..f87ea189c9 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsights.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/get-azapplicationinsights +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsights.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsights.md +--- + +# Get-AzApplicationInsights + +## SYNOPSIS +Returns an Application Insights component. + +## SYNTAX + +### ListBySubscription (Default) +``` +Get-AzApplicationInsights [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzApplicationInsights -Name -ResourceGroupName [-SubscriptionId ] [-Full] + [-DefaultProfile ] [] +``` + +### GetByInputObject +``` +Get-AzApplicationInsights -InputObject [-DefaultProfile ] + [] +``` + +### GetByResourceId +``` +Get-AzApplicationInsights -ResourceId [-Full] [-DefaultProfile ] [] +``` + +### ListByResourceGroupName +``` +Get-AzApplicationInsights -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Returns an Application Insights component. + +## EXAMPLES + +### Example 1: Get application insights resource +```powershell +Get-AzApplicationInsights -ResourceGroupName "testgroup" -Name "test" +``` + +Get application insights resource + +### Example 2: Get application insights resource with pricing plan information +```powershell +Get-AzApplicationInsights -ResourceGroupName "testgroup" -Name "test" -IncludePricingPlan +``` + +Get application insights resource with pricing plan information + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Full + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Get, GetByResourceId +Aliases: IncludeDailyCap, IncludeDailyCapStatus, IncludePricingPlan + +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.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: GetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, ListByResourceGroupName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource ID of applicationinsights component. + +```yaml +Type: System.String +Parameter Sets: GetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, ListByResourceGroupName, ListBySubscription +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api202002.IApplicationInsightsComponent + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.PSApplicationInsightsComponentWithPricingPlan + +## 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 + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsApiKey.md b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsApiKey.md new file mode 100644 index 0000000000..f97eef9a25 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsApiKey.md @@ -0,0 +1,184 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/get-azapplicationinsightsapikey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsApiKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsApiKey.md +--- + +# Get-AzApplicationInsightsApiKey + +## SYNOPSIS +Get the API Key for this key id. + +## SYNTAX + +### List (Default) +``` +Get-AzApplicationInsightsApiKey -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzApplicationInsightsApiKey -ApiKeyId -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzApplicationInsightsApiKey -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get the API Key for this key id. + +## EXAMPLES + +### Example 1: Get Api Keys for an application insights resource +```powershell +Get-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" +``` + +Get Api Keys for an application insights resource + +### Example 2: Get specific API key for an application insights resource +```powershell +Get-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId 7c4c61dc-b392-4aa4-992f-ee92b84e5dee +``` + +Get specific API key for an application insights resource + +## PARAMETERS + +### -ApiKeyId +The API Key ID. +This is unique within a Application Insights component. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20150501.IApplicationInsightsComponentApiKey + +## 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 + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsContinuousExport.md b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsContinuousExport.md new file mode 100644 index 0000000000..e1c4e3e1d7 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsContinuousExport.md @@ -0,0 +1,184 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/get-azapplicationinsightscontinuousexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsContinuousExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsContinuousExport.md +--- + +# Get-AzApplicationInsightsContinuousExport + +## SYNOPSIS +Get the Continuous Export configuration for this export id. + +## SYNTAX + +### List (Default) +``` +Get-AzApplicationInsightsContinuousExport -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzApplicationInsightsContinuousExport -ExportId -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzApplicationInsightsContinuousExport -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get the Continuous Export configuration for this export id. + +## EXAMPLES + +### Example 1: Get continuous export for an application insights resource +```powershell +Get-AzApplicationInsightsContinuousExport -ResourceGroupName "testgroup" -Name "test" +``` + +Get continuous export for an application insights resource + +### Example 2: Get continuous export for an application insights resource +```powershell +Get-AzApplicationInsightsContinuousExport -ResourceGroupName "testgroup" -Name "test" -ExportId "ZJrfffySPdtG3ESn3iRxVIEFuNY=" +``` + +Get continuous export for an application insights resource + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportId +The Continuous Export configuration ID. +This is unique within a Application Insights component. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20150501.IApplicationInsightsComponentExportConfiguration + +## 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 + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsLinkedStorageAccount.md b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsLinkedStorageAccount.md new file mode 100644 index 0000000000..63bc385731 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsLinkedStorageAccount.md @@ -0,0 +1,155 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/get-azapplicationinsightslinkedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsLinkedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsLinkedStorageAccount.md +--- + +# Get-AzApplicationInsightsLinkedStorageAccount + +## SYNOPSIS +Returns the current linked storage settings for an Application Insights component. + +## SYNTAX + +### Get (Default) +``` +Get-AzApplicationInsightsLinkedStorageAccount -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzApplicationInsightsLinkedStorageAccount -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Returns the current linked storage settings for an Application Insights component. + +## EXAMPLES + +### Example 1: Get linked storage account associated with component "componentName" +```powershell +Get-AzApplicationInsightsLinkedStorageAccount -ResourceGroupName "rgName" -ComponentName "componentName" +``` + +Get linked storage account associated with component "componentName" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20200301Preview.IComponentLinkedStorageAccounts + +## 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 + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsMyWorkbook.md b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsMyWorkbook.md new file mode 100644 index 0000000000..6df49214b6 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsMyWorkbook.md @@ -0,0 +1,230 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/get-azapplicationinsightsmyworkbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsMyWorkbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsMyWorkbook.md +--- + +# Get-AzApplicationInsightsMyWorkbook + +## SYNOPSIS +Get a single private workbook by its resourceName. + +## SYNTAX + +### List1 (Default) +``` +Get-AzApplicationInsightsMyWorkbook -Category [-SubscriptionId ] [-CanFetchContent] + [-Tag ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzApplicationInsightsMyWorkbook -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### List +``` +Get-AzApplicationInsightsMyWorkbook -ResourceGroupName -Category + [-SubscriptionId ] [-CanFetchContent] [-LinkedSourceId ] [-Tag ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a single private workbook by its resourceName. + +## EXAMPLES + +### Example 1: List private workbook by category +```powershell +Get-AzApplicationInsightsMyWorkbook -Category 'workbook' +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test 7d195dcc-7d02-459f-a181-5b46662e4060 Workbook01 westus2 shared workbook +appinsights-hkrs2v-test c65b3461-9270-45b7-b6ad-ddd644458b0e westus2 user workbook +appinsights-hkrs2v-test 2e47417f-c136-44c0-b78f-7a4ca35fd9d1 Workbook02-display westus2 user workbook +appinsights-hkrs2v-test 842437e8-8ef1-4ce7-b1a7-4cebf6c10188 Workbook03-display westus2 user workbook +appinsights-hkrs2v-test aac4bf14-0f25-4ac3-a4d4-76c63bf7312e Workbook03-display westus2 user workbook +appinsights-hkrs2v-test 74446cb1-d125-4c1f-ab84-e57fd93101d2 Workbook03-display westus2 shared workbook +appinsights-hkrs2v-test 5df8625f-fae4-4a38-9f43-62a40a2e99d1 5df8625f-fae4-4a38-9f43-62a40a2e99d1-display westus2 user workbook +``` + +This command lists my workbook by category. + +### Example 2: Get a single private workbook by its resourceName +```powershell +Get-AzApplicationInsightsMyWorkbook -ResourceGroupName appinsights-hkrs2v-test -Name 5df8625f-fae4-4a38-9f43-62a40a2e99d1 +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test 5df8625f-fae4-4a38-9f43-62a40a2e99d1 5df8625f-fae4-4a38-9f43-62a40a2e99d1-display westus2 user workbook +``` + +This command gets a single private workbook by its resourceName. + +### Example 3: List private workbook by resource group +```powershell +Get-AzApplicationInsightsMyWorkbook -ResourceGroupName appinsights-hkrs2v-test -Category 'workbook' +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test 7d195dcc-7d02-459f-a181-5b46662e4060 Workbook01 westus2 shared workbook +appinsights-hkrs2v-test c65b3461-9270-45b7-b6ad-ddd644458b0e westus2 user workbook +appinsights-hkrs2v-test 2e47417f-c136-44c0-b78f-7a4ca35fd9d1 Workbook02-display westus2 user workbook +appinsights-hkrs2v-test 842437e8-8ef1-4ce7-b1a7-4cebf6c10188 Workbook03-display westus2 user workbook +appinsights-hkrs2v-test aac4bf14-0f25-4ac3-a4d4-76c63bf7312e Workbook03-display westus2 user workbook +appinsights-hkrs2v-test 74446cb1-d125-4c1f-ab84-e57fd93101d2 Workbook03-display westus2 shared workbook +appinsights-hkrs2v-test 5df8625f-fae4-4a38-9f43-62a40a2e99d1 5df8625f-fae4-4a38-9f43-62a40a2e99d1-display westus2 user workbook +``` + +This command lists private workbook by resource group. + +## PARAMETERS + +### -CanFetchContent +Flag indicating whether or not to return the full content for each applicable workbook. +If false, only return summary content for workbooks. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Category +Category of workbook to return. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.CategoryType +Parameter Sets: List, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedSourceId +Azure Resource Id that will fetch all linked workbooks. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags presents on each workbook returned. + +```yaml +Type: System.String[] +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20210308.IMyWorkbook + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsWebTest.md b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsWebTest.md new file mode 100644 index 0000000000..4c2f559cbb --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsWebTest.md @@ -0,0 +1,265 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/get-azapplicationinsightswebtest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsWebTest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsWebTest.md +--- + +# Get-AzApplicationInsightsWebTest + +## SYNOPSIS +Get a specific Application Insights web test definition. + +## SYNTAX + +### List1 (Default) +``` +Get-AzApplicationInsightsWebTest [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzApplicationInsightsWebTest -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzApplicationInsightsWebTest -InputObject [-DefaultProfile ] + [] +``` + +### List +``` +Get-AzApplicationInsightsWebTest -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### List2 +``` +Get-AzApplicationInsightsWebTest -AppInsightsName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a specific Application Insights web test definition. + +## EXAMPLES + +### Example 1: List all Application Insights web tests under a subscription +```powershell +Get-AzApplicationInsightsWebTest +``` + +```output +Name Location WebTestKind ResourceGroupName +---- -------- ----------- ----------------- +bsaic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test +basic-portal02-appinsights-portal01 westus2 ping azpwsh-rg-test +basic-portal03-appinsights-portal01 westus2 ping azpwsh-rg-test +standard-portal-appinsights-portal01 westus2 standard azpwsh-rg-test +standard-pwsh01 westus2 standard azpwsh-rg-test +``` + +This command lists all Application Insights web tests under a subscription. + +### Example 2: List all Application Insights web tests under a resource group +```powershell +Get-AzApplicationInsightsWebTest -ResourceGroupName azpwsh-rg-test +``` + +```output +Name Location WebTestKind ResourceGroupName +---- -------- ----------- ----------------- +bsaic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test +basic-portal02-appinsights-portal01 westus2 ping azpwsh-rg-test +basic-portal03-appinsights-portal01 westus2 ping azpwsh-rg-test +standard-portal-appinsights-portal01 westus2 standard azpwsh-rg-test +standard-pwsh01 westus2 standard azpwsh-rg-test +``` + +This command lists all Application Insights web tests under a resource group. + +### Example 3: List all Application Insights web tests under a specific Application Insights +```powershell +Get-AzApplicationInsightsWebTest -ResourceGroupName azpwsh-rg-test -AppInsightsName appinsights-portal01 +``` + +```output +Name Location WebTestKind ResourceGroupName Enabled +---- -------- ----------- ----------------- ------- +bsaic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test True +basic-portal02-appinsights-portal01 westus2 ping azpwsh-rg-test True +basic-portal03-appinsights-portal01 westus2 ping azpwsh-rg-test True +standard-portal-appinsights-portal01 westus2 standard azpwsh-rg-test True +standard-pwsh01 westus2 standard azpwsh-rg-test True +``` + +This command lists all Application Insights web tests under a specific Application Insights. + +### Example 4: Get a specific Application Insights web test definition +```powershell +Get-AzApplicationInsightsWebTest -ResourceGroupName azpwsh-rg-test -Name standard-pwsh01 +``` + +```output +Name Location WebTestKind ResourceGroupName Enabled +---- -------- ----------- ----------------- ------- +standard-pwsh01 westus2 standard azpwsh-rg-test True +``` + +This command gets a specific Application Insights web test definition. + +### Example 5: Get a specific Application Insights web test definition by pipeline +```powershell +$location01 = New-AzApplicationInsightsWebTestGeolocationObject -Location "emea-nl-ams-azr" +$location02 = New-AzApplicationInsightsWebTestGeolocationObject -Location "us-ca-sjc-azr" +New-AzApplicationInsightsWebTest -ResourceGroupName azpwsh-rg-test -Name standardwebtestpwsh03 -Location 'westus2' ` +-Tag @{"hidden-link:/subscriptions/xxxxxxxxxx-xxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/azpwsh-rg-test/providers/microsoft.insights/components/appinsightsportal01" = "Resource"} ` +-RequestUrl "https://learn.microsoft.com/" -RequestHttpVerb "GET" ` +-TestName 'standardwebtestpwsh03' ` +-RuleSslCheck -RuleSslCertRemainingLifetimeCheck 7 -RuleExpectedHttpStatusCode 200 ` +-Enabled -Frequency 300 -Timeout 120 -Kind "standard" -RetryEnabled -GeoLocation $location01, $location02 ` |Get-AzApplicationInsightsWebTest +``` + +```output +Name Location WebTestKind ResourceGroupName Enabled +---- -------- ----------- ----------------- ------- +standardwebtestpwsh03 westus2 standard azpwsh-rg-test True +``` + +This command gets a specific Application Insights web test definition by pipeline. + +## PARAMETERS + +### -AppInsightsName +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights WebTest resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: WebTestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1, List2 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220615.IWebTest + +## 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 + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsWorkbook.md b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsWorkbook.md new file mode 100644 index 0000000000..6667dc7601 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsWorkbook.md @@ -0,0 +1,291 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/get-azapplicationinsightsworkbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsWorkbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsWorkbook.md +--- + +# Get-AzApplicationInsightsWorkbook + +## SYNOPSIS +Get a single workbook by its resourceName. + +## SYNTAX + +### List (Default) +``` +Get-AzApplicationInsightsWorkbook -Category [-SubscriptionId ] [-CanFetchContent] + [-Tag ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzApplicationInsightsWorkbook -Name -ResourceGroupName [-SubscriptionId ] + [-CanFetchContent] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzApplicationInsightsWorkbook -InputObject [-CanFetchContent] + [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzApplicationInsightsWorkbook -ResourceGroupName -Category + [-SubscriptionId ] [-CanFetchContent] [-LinkedSourceId ] [-Tag ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a single workbook by its resourceName. + +## EXAMPLES + +### Example 1: List workbooks by category +```powershell +Get-AzApplicationInsightsWorkbook -Category 'workbook' +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test 7d195dcc-7d02-459f-a181-5b46662e4060 Workbook01 westus2 shared workbook +appinsights-hkrs2v-test c65b3461-9270-45b7-b6ad-ddd644458b0e westus2 user workbook +appinsights-hkrs2v-test 2e47417f-c136-44c0-b78f-7a4ca35fd9d1 Workbook02-display westus2 user workbook +appinsights-hkrs2v-test 842437e8-8ef1-4ce7-b1a7-4cebf6c10188 Workbook03-display westus2 user workbook +appinsights-hkrs2v-test aac4bf14-0f25-4ac3-a4d4-76c63bf7312e Workbook03-display westus2 user workbook +appinsights-hkrs2v-test 74446cb1-d125-4c1f-ab84-e57fd93101d2 Workbook03-display westus2 shared workbook +appinsights-hkrs2v-test 5df8625f-fae4-4a38-9f43-62a40a2e99d1 5df8625f-fae4-4a38-9f43-62a40a2e99d1-display westus2 user workbook +appinsights-hkrs2v-test b41466f0-a464-4531-ab31-df6ba613d8fe b41466f0-a464-4531-ab31-df6ba613d8fe-display westus2 user workbook +appinsights-hkrs2v-test f7d7151e-7907-4f46-8a5e-6bf4a4cfedec f7d7151e-7907-4f46-8a5e-6bf4a4cfedec-display westus2 shared workbook +``` + +This command lists workbooks by category. + +### Example 2: Get a single workbook by its resourceName +```powershell +Get-AzApplicationInsightsWorkbook -ResourceGroupName appinsights-hkrs2v-test -Name f7d7151e-7907-4f46-8a5e-6bf4a4cfedec +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test f7d7151e-7907-4f46-8a5e-6bf4a4cfedec f7d7151e-7907-4f46-8a5e-6bf4a4cfedec-display westus2 shared workboo +``` + +This command get a single workbook by its resourceName. + +### Example 3: Get a single workbook by pipeline +```powershell +$name = (New-Guid).ToString() +New-AzApplicationInsightsWorkbook -ResourceGroupName appinsights-hkrs2v-test -Name $name -Location westus2 -DisplayName "$name-display" -SourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/appinsights-hkrs2v-test/providers/microsoft.insights/components/appinsights-48mah3-pwsh" -Category 'workbook' -SerializedData $null | Get-AzApplicationInsightsWorkbook +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test f7d7151e-7907-4f46-8a5e-6bf4a4cfedec f7d7151e-7907-4f46-8a5e-6bf4a4cfedec-display westus2 shared workboo +``` + +This command gets a single workbook by pipeline. + +### Example 4: List all workbooks by resource group +```powershell +Get-AzApplicationInsightsWorkbook -ResourceGroupName appinsights-hkrs2v-test -Category 'workbook' +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test 7d195dcc-7d02-459f-a181-5b46662e4060 Workbook01 westus2 shared workbook +appinsights-hkrs2v-test c65b3461-9270-45b7-b6ad-ddd644458b0e westus2 user workbook +appinsights-hkrs2v-test 2e47417f-c136-44c0-b78f-7a4ca35fd9d1 Workbook02-display westus2 user workbook +appinsights-hkrs2v-test 842437e8-8ef1-4ce7-b1a7-4cebf6c10188 Workbook03-display westus2 user workbook +appinsights-hkrs2v-test aac4bf14-0f25-4ac3-a4d4-76c63bf7312e Workbook03-display westus2 user workbook +appinsights-hkrs2v-test 74446cb1-d125-4c1f-ab84-e57fd93101d2 Workbook03-display westus2 shared workbook +appinsights-hkrs2v-test 5df8625f-fae4-4a38-9f43-62a40a2e99d1 5df8625f-fae4-4a38-9f43-62a40a2e99d1-display westus2 user workbook +appinsights-hkrs2v-test b41466f0-a464-4531-ab31-df6ba613d8fe b41466f0-a464-4531-ab31-df6ba613d8fe-display westus2 user workbook +appinsights-hkrs2v-test f7d7151e-7907-4f46-8a5e-6bf4a4cfedec f7d7151e-7907-4f46-8a5e-6bf4a4cfedec-display westus2 shared workbook +``` + +This command lists all workbooks by resource group. + +## PARAMETERS + +### -CanFetchContent +Flag indicating whether or not to return the full content for each applicable workbook. +If false, only return summary content for workbooks. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Category +Category of workbook to return. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.CategoryType +Parameter Sets: List, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkedSourceId +Azure Resource Id that will fetch all linked workbooks. + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags presents on each workbook returned. + +```yaml +Type: System.String[] +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220401.IWorkbook + +## 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 + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsWorkbookRevision.md b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsWorkbookRevision.md new file mode 100644 index 0000000000..c732f81c1a --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsWorkbookRevision.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/get-azapplicationinsightsworkbookrevision +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsWorkbookRevision.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsWorkbookRevision.md +--- + +# Get-AzApplicationInsightsWorkbookRevision + +## SYNOPSIS +Get a single workbook revision defined by its revisionId. + +## SYNTAX + +### List (Default) +``` +Get-AzApplicationInsightsWorkbookRevision -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzApplicationInsightsWorkbookRevision -Name -ResourceGroupName -RevisionId + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzApplicationInsightsWorkbookRevision -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a single workbook revision defined by its revisionId. + +## EXAMPLES + +### Example 1: List all workbook revisions +```powershell +Get-AzApplicationInsightsWorkbookRevision -ResourceGroupName appinsights-hkrs2v-test -Name f7d7151e-7907-4f46-8a5e-6bf4a4cfedec | fl +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test f7d7151e-7907-4f46-8a5e-6bf4a4cfedec f7d7151e-7907-4f46-8a5e-6bf4a4cfedec-display westus2 shared workbook +``` + +This command lists all workbook revisions. + +### Example 2: Get a single workbook revision defined by its revisionId +```powershell +Get-AzApplicationInsightsWorkbookRevision -ResourceGroupName appinsights-hkrs2v-test -Name f7d7151e-7907-4f46-8a5e-6bf4a4cfedec -RevisionId "91788fbfb8384ea5998ac73b9fa3e6eb" +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test f7d7151e-7907-4f46-8a5e-6bf4a4cfedec f7d7151e-7907-4f46-8a5e-6bf4a4cfedec-display westus2 shared workbook +``` + +This command gets a single workbook revision defined by its revisionId. + +### Example 3: Get a single workbook revision defined by resource id +```powershell +Get-AzApplicationInsightsWorkbookRevision -InputObject "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/appinsights-hkrs2v-test/providers/microsoft.insights/workbooks/f7d7151e-7907-4f46-8a5e-6bf4a4cfedec/revisions/91788fbfb8384ea5998ac73b9fa3e6eb" +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test f7d7151e-7907-4f46-8a5e-6bf4a4cfedec f7d7151e-7907-4f46-8a5e-6bf4a4cfedec-display westus2 shared workbook +``` + +This commmand gets a single workbook revision defined by resource id. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RevisionId +The id of the workbook's revision. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220401.IWorkbook + +## 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 + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsWorkbookTemplate.md b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsWorkbookTemplate.md new file mode 100644 index 0000000000..6720381475 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Get-AzApplicationInsightsWorkbookTemplate.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/get-azapplicationinsightsworkbooktemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsWorkbookTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Get-AzApplicationInsightsWorkbookTemplate.md +--- + +# Get-AzApplicationInsightsWorkbookTemplate + +## SYNOPSIS +Get a single workbook template by its resourceName. + +## SYNTAX + +### Get (Default) +``` +Get-AzApplicationInsightsWorkbookTemplate -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzApplicationInsightsWorkbookTemplate -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a single workbook template by its resourceName. + +## EXAMPLES + +### Example 1: Get a single workbook template by its resourceName +```powershell +Get-AzApplicationInsightsWorkbookTemplate -ResourceGroupName resourceGroup -Name workbooktemplate-pwsh01 +``` + +```output +ResourceGroupName Name Location +----------------- ---- -------- +appinsights-hkrs2v-test workbooktemplate-pwsh01 westu +``` + +This command gets a single workbook template by its resourceName. + +### Example 2: Get a single workbook template by pipeline +```powershell +$gallery = New-AzApplicationInsightsWorkbookTemplateGalleryObject -Category "Failures" -Name "Simple Template" -Type 'tsg' -ResourceType "microsoft.insights/components" -Order 100 + +$data = @{ + "version"= "Notebook/1.0"; + "items"= @( + @{ + "type"= 1; + "content"= @{ + "json"= "## New workbook\n---\n\nWelcome to your new workbook. This area will display text formatted as markdown.\n\n\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections." + }; + "name"= "text - 2" + }, + @{ + "type"= 3; + "content"= @{ + "version"= "KqlItem/1.0"; + "query"= "union withsource=TableName *\n| summarize Count=count() by TableName\n| render barchart"; + "size"= 1; + "exportToExcelOptions"= "visible"; + "queryType"= 0; + "resourceType"= "microsoft.operationalinsights/workspaces" + }; + "name"= "query - 2" + } + ); + "styleSettings"= @{}; + "$schema"= "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json" +} + +New-AzApplicationInsightsWorkbookTemplate -ResourceGroupName resourceGroup -Name 'workbooktemplate-pwsh01' -Location 'westus2' -Gallery $gallery -TemplateData $data -Priority 1 | Get-AzApplicationInsightsWorkbookTemplate +``` + +```output +ResourceGroupName Name Location +----------------- ---- -------- +appinsights-hkrs2v-test workbooktemplate-pwsh01 westus2 +``` + +This command gets a single workbook template by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20201120.IWorkbookTemplate + +## 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 + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsights.md b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsights.md new file mode 100644 index 0000000000..32624f252c --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsights.md @@ -0,0 +1,425 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/new-azapplicationinsights +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsights.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsights.md +--- + +# New-AzApplicationInsights + +## SYNOPSIS +Creates (or updates) an Application Insights component. +Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. + +## SYNTAX + +``` +New-AzApplicationInsights -Name -ResourceGroupName -Location + [-SubscriptionId ] [-ApplicationType ] [-DisableIPMasking] [-DisableLocalAuth] + [-Etag ] [-FlowType ] [-ForceCustomerStorageForProfiler] [-HockeyAppId ] + [-ImmediatePurgeDataOn30Day] [-IngestionMode ] [-Kind ] + [-PublicNetworkAccessForIngestion ] + [-PublicNetworkAccessForQuery ] [-RequestSource ] + [-RetentionInDays ] [-SamplingPercentage ] [-Tag ] [-WorkspaceResourceId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates (or updates) an Application Insights component. +Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. + +## EXAMPLES + +### Example 1: Create a new application insights resource +```powershell +New-AzApplicationInsights -Kind java -ResourceGroupName testgroup -Name test1027 -location eastus +``` + +Add a new application insights resource named as "test" in resource group "testgroup" with kind "java" + +## PARAMETERS + +### -ApplicationType +Type of application being monitored. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.ApplicationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableIPMasking +Disable IP masking. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Disable Non-AAD based Auth. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Resource etag + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowType +Used by the Application Insights system to determine what kind of flow this component was created by. +This is to be set to 'Bluefield' when creating/updating a component via the REST API. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.FlowType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceCustomerStorageForProfiler +Force users to create their own storage account for profiler and debugger. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HockeyAppId +The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmediatePurgeDataOn30Day +Purge data immediately after 30 days. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngestionMode +Indicates the flow of the ingestion. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.IngestionMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +The kind of application that this component refers to, used to customize UI. +This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationKind + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccessForIngestion +The network access type for accessing Application Insights ingestion. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.PublicNetworkAccessType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccessForQuery +The network access type for accessing Application Insights query. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.PublicNetworkAccessType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestSource +Describes what tool created this Application Insights component. +Customers using this API should set this to the default 'rest'. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.RequestSource +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionInDays +Retention period in days. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamplingPercentage +Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry. + +```yaml +Type: System.Double +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +Resource Id of the log analytics workspace which the data will be ingested to. +This property is required to create an application with this API version. +Applications from older versions will not have this property. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api202002.IApplicationInsightsComponent + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsApiKey.md b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsApiKey.md new file mode 100644 index 0000000000..928380d452 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsApiKey.md @@ -0,0 +1,176 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/new-azapplicationinsightsapikey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsApiKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsApiKey.md +--- + +# New-AzApplicationInsightsApiKey + +## SYNOPSIS +Create an API Key of an Application Insights component. + +## SYNTAX + +``` +New-AzApplicationInsightsApiKey -Name -ResourceGroupName -Description + -Permissions [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create an API Key of an Application Insights component. + +## EXAMPLES + +### Example 1: Create a new Api Key for an application insights resource +```powershell +$apiKeyDescription = "testapiKey" +$permissions = @("ReadTelemetry", "WriteAnnotations") +New-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -Description $apiKeyDescription -Permissions $permissions + +``` + +Create a new Api Key for an application insights resource + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The name of the API Key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permissions +The read access rights of this API Key. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20150501.IApplicationInsightsComponentApiKey + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsContinuousExport.md b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsContinuousExport.md new file mode 100644 index 0000000000..45513a7f0f --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsContinuousExport.md @@ -0,0 +1,258 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/new-azapplicationinsightscontinuousexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsContinuousExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsContinuousExport.md +--- + +# New-AzApplicationInsightsContinuousExport + +## SYNOPSIS +Create a Continuous Export configuration of an Application Insights component. + +## SYNTAX + +``` +New-AzApplicationInsightsContinuousExport -Name -ResourceGroupName + [-SubscriptionId ] [-DestinationType ] [-DocumentType ] + [-NotificationQueueEnabled ] [-NotificationQueueUri ] [-StorageAccountId ] + [-StorageLocation ] [-StorageSASUri ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create a Continuous Export configuration of an Application Insights component. + +## EXAMPLES + +### Example 1: Create a new continuous export configuration for an application insights resource +```powershell +$sastoken = New-AzStorageContainerSASToken -Name testcontainer -Context $context -ExpiryTime (Get-Date).AddYears(50) -Permission w +$sasuri = "https://teststorageaccount.blob.core.windows.net/testcontainer" + $sastoken +New-AzApplicationInsightsContinuousExport -ResourceGroupName "testgroup" -Name "test" ` +-DocumentType "Request","Trace", "Custom Event" -StorageAccountId "/subscriptions/50359d91-7b9d-4823-85af-eb298a61ba96/resourceGroups/testgroup/providers/Microsoft.Storage/storageAccounts/teststorageaccount" -StorageLocation sourcecentralus ` +-StorageSASUri $sasuri -DestinationType Blob +``` + +Create a new application insights continuous export configuration to export "Request" and "Trace" document types to storage contain "testcontainer" in storage account "teststorageaccount" in resource group "testgroup". +The SAS token have to be valid and have write permission to the container, otherwise continuous export feature won't work.If SAS token expired, the continuous export feature will stop working. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationType +The Continuous Export destination type. +This has to be 'Blob'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentType +The document types to be exported, as comma separated values. +Allowed values include 'Requests', 'Custom Event', 'Exception', 'Metric', 'Page View', 'Page Load', 'Dependency', 'Performance Counter', 'Availability', 'Trace'. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationQueueEnabled +Deprecated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationQueueUri +Deprecated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountId +The name of destination storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageLocation +The location ID of the destination storage container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSASUri +The SAS URL for the destination storage container. +It must grant write permission. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20150501.IApplicationInsightsComponentExportConfiguration + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsLinkedStorageAccount.md b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsLinkedStorageAccount.md new file mode 100644 index 0000000000..af2d915420 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsLinkedStorageAccount.md @@ -0,0 +1,159 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/new-azapplicationinsightslinkedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsLinkedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsLinkedStorageAccount.md +--- + +# New-AzApplicationInsightsLinkedStorageAccount + +## SYNOPSIS +Replace current linked storage account for an Application Insights component. + +## SYNTAX + +``` +New-AzApplicationInsightsLinkedStorageAccount -Name -ResourceGroupName + [-SubscriptionId ] [-LinkedStorageAccountResourceId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Replace current linked storage account for an Application Insights component. + +## EXAMPLES + +### Example 1: Create an application insights linked storage account +```powershell +$account = Get-AzStorageAccount -ResourceGroupName "rgName" -Name "accountName" +Get-AzApplicationInsights -ResourceGroupName "rgName" -Name "componentName" | New-AzApplicationInsightsLinkedStorageAccount -LinkedStorageAccountResourceId $account.Id +``` + +Create linked storage account $account under component "componentName" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedStorageAccountResourceId +Linked storage account resource ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20200301Preview.IComponentLinkedStorageAccounts + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsMyWorkbook.md b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsMyWorkbook.md new file mode 100644 index 0000000000..407eb5b20e --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsMyWorkbook.md @@ -0,0 +1,365 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/new-azapplicationinsightsmyworkbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsMyWorkbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsMyWorkbook.md +--- + +# New-AzApplicationInsightsMyWorkbook + +## SYNOPSIS +Create a new private workbook. + +## SYNTAX + +``` +New-AzApplicationInsightsMyWorkbook -Name -ResourceGroupName [-SubscriptionId ] + [-LinkedSourceId ] [-Category ] [-DisplayName ] [-Etag ] [-Id ] + [-IdentityType ] [-Location ] [-SerializedData ] [-SourceId ] + [-SourceTag ] [-StorageUri ] [-Tag ] [-Type ] [-Version ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a new private workbook. + +## EXAMPLES + +### Example 1: Create a new private workbook +```powershell +# The value of the parameter name is the Guid type. +$name = (New-Guid).ToString() +New-AzApplicationInsightsMyWorkbook -ResourceGroupName appinsights-hkrs2v-test -Name $name -Location westus2 -DisplayName "$name-display" -SourceId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/appinsights-hkrs2v-test/providers/microsoft.insights/components/appinsights-48mah3-pwsh" -Category 'workbook' -SerializedData $null +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test 2e47417f-c136-44c0-b78f-7a4ca35fd9d1 pwsh01 westus2 user workbook +``` + +This command create a new private workbook + +## PARAMETERS + +### -Category +Workbook category, as defined by the user at creation time. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The user-defined name of the private workbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Resource etag + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Azure resource Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedSourceId +Azure Resource Id that will fetch all linked workbooks. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SerializedData +Configuration of this particular private workbook. +Configuration data is a string containing valid JSON + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceId +Optional resourceId for a source resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceTag +A list of 0 or more tags that are associated with this private workbook definition + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageUri +BYOS Storage Account URI + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Azure resource type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +This instance's version of the data model. +This can change as new features are added that can be marked private workbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20210308.IMyWorkbook + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWebTest.md b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWebTest.md new file mode 100644 index 0000000000..2b25cfc869 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWebTest.md @@ -0,0 +1,606 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/new-azapplicationinsightswebtest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsWebTest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsWebTest.md +--- + +# New-AzApplicationInsightsWebTest + +## SYNOPSIS +Creates or updates an Application Insights web test definition. + +## SYNTAX + +### CreateStandard (Default) +``` +New-AzApplicationInsightsWebTest -Name -ResourceGroupName -Location + [-SubscriptionId ] [-ContentIgnoreCase] [-ContentMatch ] [-ContentPassIfTextFound] + [-Description ] [-Enabled] [-Frequency ] [-GeoLocation ] + [-Kind ] [-RequestBody ] [-RequestFollowRedirect] [-RequestHeader ] + [-RequestHttpVerb ] [-RequestParseDependent] [-RequestUrl ] [-RetryEnabled] + [-RuleExpectedHttpStatusCode ] [-RuleIgnoreHttpsStatusCode] + [-RuleSslCertRemainingLifetimeCheck ] [-RuleSslCheck] [-Tag ] [-TestName ] + [-Timeout ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateClassic +``` +New-AzApplicationInsightsWebTest -Name -ResourceGroupName -Location + [-SubscriptionId ] [-Configuration ] [-ContentMatch ] [-Description ] + [-Enabled] [-Frequency ] [-GeoLocation ] [-Kind ] + [-RequestParseDependent] [-RequestUrl ] [-RetryEnabled] [-RuleExpectedHttpStatusCode ] + [-Tag ] [-TestName ] [-Timeout ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Creates or updates an Application Insights web test definition. + +## EXAMPLES + +### Example 1: Creates or updates an standard kind of the Application Insights web test +```powershell +$geoLocation = @() +$geoLocation += New-AzApplicationInsightsWebTestGeolocationObject -Location "emea-nl-ams-azr" +$geoLocation += New-AzApplicationInsightsWebTestGeolocationObject -Location "us-ca-sjc-azr" +New-AzApplicationInsightsWebTest -ResourceGroupName azpwsh-rg-test -Name standard-pwsh01 -Location 'westus2' ` +-Tag @{"hidden-link:/subscriptions/xxxxxxxxxx-xxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/azpwsh-rg-test/providers/microsoft.insights/components/appinsights-portal01" = "Resource"} ` +-RequestUrl "https://www.bing.com" -RequestHttpVerb "GET" -TestName 'standard-pwsh01' ` +-RuleExpectedHttpStatusCode 200 -Frequency 300 -Enabled -Timeout 120 -Kind 'standard' -RetryEnabled -GeoLocation $geoLocation +``` + +```output +Name Location WebTestKind ResourceGroupName Enabled +---- -------- ----------- ----------------- ------- +standard-pwsh01 westus2 standard azpwsh-rg-test True +``` + +This command creates or updates an standard kind of the Application Insights web test. + +We enter hidden-link in the `Tag` parameter to associate WebTest and Application Insights. + +### Example 2: Creates or updates an ping kind of the Application Insights web test +```powershell +$geoLocation = @() +$geoLocation += New-AzApplicationInsightsWebTestGeolocationObject -Location "emea-nl-ams-azr" +$geoLocation += New-AzApplicationInsightsWebTestGeolocationObject -Location "us-ca-sjc-azr" +New-AzApplicationInsightsWebTest -ResourceGroupName azpwsh-rg-test -Name 'pingwebtest-pwsh01' -TestName 'pingwentest-pwsh01testname' -Location 'westus2' ` +-Tag @{"hidden-link:/subscriptions/xxxxxxxxxx-xxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/azpwsh-rg-test/providers/microsoft.insights/components/appinsights-portal01" = "Resource"} ` +-GeoLocation $geoLocation -RetryEnabled -Enabled -Frequency 300 -Timeout 90 ` +-Kind 'ping' -RequestUrl 'https://cn.bing.com' -RequestParseDependent -RuleExpectedHttpStatusCode 200 ` +-ContentMatch "status" +``` + +```output +Name Location WebTestKind ResourceGroupName Enabled +---- -------- ----------- ----------------- ------- +pingwebtest-pwsh01 westus2 ping azpwsh-rg-test True +``` + +This command creates or updates an ping kind of the Application Insights web test. + +### Example 3: Creates or updates an ping kind of the Application Insights web test with custom configuration +```powershell +$geoLocation = @() +$geoLocation += New-AzApplicationInsightsWebTestGeolocationObject -Location "emea-nl-ams-azr" +$geoLocation += New-AzApplicationInsightsWebTestGeolocationObject -Location "us-ca-sjc-azr" +New-AzApplicationInsightsWebTest -ResourceGroupName azpwsh-rg-test -Name 'pingwebtest-pwsh01' -TestName 'pingwentest-pwsh01testname' -Location 'westus2' ` +-Tag @{"hidden-link:/subscriptions/xxxxxxxxxx-xxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/azpwsh-rg-test/providers/microsoft.insights/components/appinsights-portal01" = "Resource"} ` +-GeoLocation $geoLocation -RetryEnabled -Enabled -Frequency 300 -Timeout 90 ` +-Kind 'ping' ` +-Configuration " + + + + + + + + + + + + + +" +``` + +```output +Name Location WebTestKind ResourceGroupName Enabled +---- -------- ----------- ----------------- ------- +pingwebtest-pwsh01 westus2 ping azpwsh-rg-test True +``` + +This command creates or updates an ping kind of the Application Insights web test with custom configuration. + +## PARAMETERS + +### -Configuration +The XML specification of a WebTest to run against an application. + +```yaml +Type: System.String +Parameter Sets: CreateClassic +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentIgnoreCase +When set, this value makes the ContentMatch validation case insensitive. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateStandard +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatch +Content to look for in the return of the WebTest. +Must not be null or empty. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentPassIfTextFound +When true, validation will pass if there is a match for the ContentMatch string. +If false, validation will fail if there is a match + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateStandard +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +User defined description for this WebTest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Is the test actively being monitored. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Frequency +Interval in seconds between test runs for this WebTest. +Default value is 300. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeoLocation +A list of where to physically run the tests from to give global coverage for accessibility of your application. +To construct, see NOTES section for GEOLOCATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220615.IWebTestGeolocation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +The kind of web test this is, valid choices are ping, multistep, and standard. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.WebTestKindEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights WebTest resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WebTestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestBody +Base64 encoded string body to send with this web test. + +```yaml +Type: System.String +Parameter Sets: CreateStandard +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestFollowRedirect +Follow redirects for this web test. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateStandard +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestHeader +List of headers and their values to add to the WebTest call. +To construct, see NOTES section for REQUESTHEADER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220615.IHeaderField[] +Parameter Sets: CreateStandard +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestHttpVerb +Http verb to use for this web test. + +```yaml +Type: System.String +Parameter Sets: CreateStandard +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestParseDependent +Parse Dependent request for this WebTest. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestUrl +Url location to test. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetryEnabled +Allow for retries should this WebTest fail. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleExpectedHttpStatusCode +Validate that the WebTest returns the http status code provided. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleIgnoreHttpsStatusCode +When set, validation will ignore the status code. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateStandard +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSslCertRemainingLifetimeCheck +A number of days to check still remain before the the existing SSL cert expires. +Value must be positive and the SSLCheck must be set to true. + +```yaml +Type: System.Int32 +Parameter Sets: CreateStandard +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSslCheck +Checks to see if the SSL cert is still valid. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateStandard +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestName +User defined name if this WebTest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +Seconds until this WebTest will timeout and fail. +Default value is 30. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220615.IWebTest + +## 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. + + +`GEOLOCATION `: A list of where to physically run the tests from to give global coverage for accessibility of your application. + - `[Location ]`: Location ID for the WebTest to run from. + +`REQUESTHEADER `: List of headers and their values to add to the WebTest call. + - `[Name ]`: The name of the header. + - `[Value ]`: The value of the header. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWebTestGeolocationObject.md b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWebTestGeolocationObject.md new file mode 100644 index 0000000000..c0750051ef --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWebTestGeolocationObject.md @@ -0,0 +1,71 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.ApplicationInsights/new-AzApplicationInsightsWebTestGeolocationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsWebTestGeolocationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsWebTestGeolocationObject.md +--- + +# New-AzApplicationInsightsWebTestGeolocationObject + +## SYNOPSIS +Create an in-memory object for WebTestGeolocation. + +## SYNTAX + +``` +New-AzApplicationInsightsWebTestGeolocationObject [-Location ] [] +``` + +## DESCRIPTION +Create an in-memory object for WebTestGeolocation. + +## EXAMPLES + +### Example 1: Create a in-memory object for WebTestGeolocation +```powershell +New-AzApplicationInsightsWebTestGeolocationObject -Location "emea-nl-ams-azr" +``` + +```output +Location +-------- +emea-nl-ams-azr +``` + +This command creates a memory object for WebTestGeolocation. +As value of the `GeoLocation` parameter in `New-AzApplicationInsightsWebTest`. + +## PARAMETERS + +### -Location +Location ID for the WebTest to run from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220615.WebTestGeolocation + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWebTestHeaderFieldObject.md b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWebTestHeaderFieldObject.md new file mode 100644 index 0000000000..b0fe24816b --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWebTestHeaderFieldObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.ApplicationInsights/new-AzApplicationInsightsWebTestHeaderFieldObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsWebTestHeaderFieldObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsWebTestHeaderFieldObject.md +--- + +# New-AzApplicationInsightsWebTestHeaderFieldObject + +## SYNOPSIS +Create a in-memory object for HeaderField + +## SYNTAX + +``` +New-AzApplicationInsightsWebTestHeaderFieldObject [-Name ] [-Value ] [] +``` + +## DESCRIPTION +Create a in-memory object for HeaderField + +## EXAMPLES + +### Example 1: Create a in-memory object for HeaderField +```powershell +New-AzApplicationInsightsWebTestHeaderFieldObject -Name 'version' -Value '2.0.1' +``` + +```output +Name Value +---- ----- +version 2.0.1 +``` + +This command creates a in-memory object for HeaderField, As value of the `RequestHeader` parameter in `New-AzApplicationInsightsWebTest`. + +## PARAMETERS + +### -Name +The name of the header. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The value of the header. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220615.HeaderField + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWorkbook.md b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWorkbook.md new file mode 100644 index 0000000000..744f876c25 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWorkbook.md @@ -0,0 +1,366 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/new-azapplicationinsightsworkbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsWorkbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsWorkbook.md +--- + +# New-AzApplicationInsightsWorkbook + +## SYNOPSIS +Create a new workbook. + +## SYNTAX + +``` +New-AzApplicationInsightsWorkbook -Name -ResourceGroupName -Location + [-SubscriptionId ] [-LinkedSourceId ] [-Category ] [-Description ] + [-DisplayName ] [-Etag ] [-IdentityType ] + [-IdentityUserAssignedIdentity ] [-SerializedData ] [-SourceId ] + [-SourceTag ] [-StorageUri ] [-Tag ] [-Version ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a new workbook. + +## EXAMPLES + +### Example 1: Create a new workbook +```powershell +$name = (New-Guid).ToString() +New-AzApplicationInsightsWorkbook -ResourceGroupName appinsights-hkrs2v-test -Name $name -Location westus2 -DisplayName "$name-display" -SourceId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/appinsights-hkrs2v-test/providers/microsoft.insights/components/appinsights-48mah3-pwsh" -Category 'workbook' -SerializedData $null +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test 2e47417f-c136-44c0-b78f-7a4ca35fd9d1 pwsh01 westus2 user workbook +``` + +This command create a new workbook. + +## PARAMETERS + +### -Category +Workbook category, as defined by the user at creation time. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the workbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The user-defined name (display name) of the workbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Resource etag + +```yaml +Type: System.String +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedSourceId +Azure Resource Id that will fetch all linked workbooks. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SerializedData +Configuration of this particular workbook. +Configuration data is a string containing valid JSON + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceId +ResourceId for a source resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceTag +Being deprecated, please use the other tags field + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageUri +The resourceId to the storage account when bring your own storage is used + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220401.IWorkbook + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWorkbookTemplate.md b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWorkbookTemplate.md new file mode 100644 index 0000000000..2db30a8221 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWorkbookTemplate.md @@ -0,0 +1,298 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/new-azapplicationinsightsworkbooktemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsWorkbookTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsWorkbookTemplate.md +--- + +# New-AzApplicationInsightsWorkbookTemplate + +## SYNOPSIS +Create a new workbook template. + +## SYNTAX + +``` +New-AzApplicationInsightsWorkbookTemplate -Name -ResourceGroupName -Location + [-SubscriptionId ] [-Author ] [-Gallery ] + [-Localized ] [-Priority ] [-Tag ] [-TemplateData ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a new workbook template. + +## EXAMPLES + +### Example 1: Create a new workbook template +```powershell +$gallery = New-AzApplicationInsightsWorkbookTemplateGalleryObject -Category "Failures" -Name "Simple Template" -Type 'tsg' -ResourceType "microsoft.insights/components" -Order 100 +$data = @{ + "version"= "Notebook/1.0"; + "items"= @( + @{ + "type"= 1; + "content"= @{ + "json"= "## New workbook\n---\n\nWelcome to your new workbook. This area will display text formatted as markdown.\n\n\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections." + }; + "name"= "text - 2" + }, + @{ + "type"= 3; + "content"= @{ + "version"= "KqlItem/1.0"; + "query"= "union withsource=TableName *\n| summarize Count=count() by TableName\n| render barchart"; + "size"= 1; + "exportToExcelOptions"= "visible"; + "queryType"= 0; + "resourceType"= "microsoft.operationalinsights/workspaces" + }; + "name"= "query - 2" + } + ); + "styleSettings"= @{}; + "$schema"= "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json" +} + +New-AzApplicationInsightsWorkbookTemplate -ResourceGroupName resourceGroup -Name 'workbooktemplate-pwsh01' -Location 'westus2' -Gallery $gallery -TemplateData $data -Priority 1 +``` + +```output +ResourceGroupName Name Location +----------------- ---- -------- +appinsights-hkrs2v-test workbooktemplate-pwsh01 westus2 +``` + +Create a new workbook template. + +## PARAMETERS + +### -Author +Information about the author of the workbook template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Gallery +Workbook galleries supported by the template. +To construct, see NOTES section for GALLERY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20201120.IWorkbookTemplateGallery[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Localized +Key value pair of localized gallery. +Each key is the locale code of languages supported by the Azure portal. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Priority of the template. +Determines which template to open when a workbook gallery is opened in viewer mode. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateData +Valid JSON object containing workbook template payload. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20201120.IWorkbookTemplate + +## 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. + + +`GALLERY `: Workbook galleries supported by the template. + - `[Category ]`: Category for the gallery. + - `[Name ]`: Name of the workbook template in the gallery. + - `[Order ]`: Order of the template within the gallery. + - `[ResourceType ]`: Azure resource type supported by the gallery. + - `[Type ]`: Type of workbook supported by the workbook template. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWorkbookTemplateGalleryObject.md b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWorkbookTemplateGalleryObject.md new file mode 100644 index 0000000000..d9e5d5a2aa --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/New-AzApplicationInsightsWorkbookTemplateGalleryObject.md @@ -0,0 +1,131 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.ApplicationInsights/new-AzApplicationInsightsWorkbookTemplateGalleryObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsWorkbookTemplateGalleryObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/New-AzApplicationInsightsWorkbookTemplateGalleryObject.md +--- + +# New-AzApplicationInsightsWorkbookTemplateGalleryObject + +## SYNOPSIS +Create an in-memory object for WorkbookTemplateGallery. + +## SYNTAX + +``` +New-AzApplicationInsightsWorkbookTemplateGalleryObject [-Category ] [-Name ] [-Order ] + [-ResourceType ] [-Type ] [] +``` + +## DESCRIPTION +Create an in-memory object for WorkbookTemplateGallery. + +## EXAMPLES + +### Example 1: Create an in-memory object for WorkbookTemplateGallery +```powershell +New-AzApplicationInsightsWorkbookTemplateGalleryObject -Category "Failures" -Name "Simple Template" -Type 'tsg' -ResourceType "microsoft.insights/components" -Order 100 +``` + +```output +Name Category +---- -------- +Simple Template Failures +``` + +Create an in-memory object for WorkbookTemplateGallery. + +## PARAMETERS + +### -Category +Category for the gallery. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the workbook template in the gallery. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +Order of the template within the gallery. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +Azure resource type supported by the gallery. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of workbook supported by the workbook template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20201120.WorkbookTemplateGallery + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsights.md b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsights.md new file mode 100644 index 0000000000..7a70befa30 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsights.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/remove-azapplicationinsights +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsights.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsights.md +--- + +# Remove-AzApplicationInsights + +## SYNOPSIS +Deletes an Application Insights component. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzApplicationInsights -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzApplicationInsights -InputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an Application Insights component. + +## EXAMPLES + +### Example 1: Remove an application insights resource +```powershell +Remove-AzApplicationInsights -ResourceGroupName "testgroup" -Name "test" -PassThru +``` + +Remove an application insights resource named "test" in resource group "testgroup" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsApiKey.md b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsApiKey.md new file mode 100644 index 0000000000..6bb449a003 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsApiKey.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/remove-azapplicationinsightsapikey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsApiKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsApiKey.md +--- + +# Remove-AzApplicationInsightsApiKey + +## SYNOPSIS +Delete an API Key of an Application Insights component. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzApplicationInsightsApiKey -ApiKeyId -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzApplicationInsightsApiKey -InputObject [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete an API Key of an Application Insights component. + +## EXAMPLES + +### Example 1: Remove an application insights api key for an application insights resource +```powershell +Remove-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId dd173f38-4fd1-4c75-8af5-99c29aa0f867 +``` + +Remove an application insights api key for an application insights resource + +## PARAMETERS + +### -ApiKeyId +The API Key ID. +This is unique within a Application Insights component. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20150501.IApplicationInsightsComponentApiKey + +## 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 + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsContinuousExport.md b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsContinuousExport.md new file mode 100644 index 0000000000..bb64ba1b93 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsContinuousExport.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/remove-azapplicationinsightscontinuousexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsContinuousExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsContinuousExport.md +--- + +# Remove-AzApplicationInsightsContinuousExport + +## SYNOPSIS +Delete a Continuous Export configuration of an Application Insights component. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzApplicationInsightsContinuousExport -ExportId -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzApplicationInsightsContinuousExport -InputObject + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a Continuous Export configuration of an Application Insights component. + +## EXAMPLES + +### Example 1: Remove a continuous export configuration in an application insights resource +```powershell +Remove-AzApplicationInsightsContinuousExport -ResourceGroupName "testgroup" -Name "test" -ExportId "uGOoki0jQsyEs3IdQ83Q4QsNr4=" +``` + +Remove a continuous export configuration in an application insights resource + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportId +The Continuous Export configuration ID. +This is unique within a Application Insights component. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20150501.IApplicationInsightsComponentExportConfiguration + +## 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 + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsLinkedStorageAccount.md b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsLinkedStorageAccount.md new file mode 100644 index 0000000000..3253f19631 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsLinkedStorageAccount.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/remove-azapplicationinsightslinkedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsLinkedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsLinkedStorageAccount.md +--- + +# Remove-AzApplicationInsightsLinkedStorageAccount + +## SYNOPSIS +Delete linked storage accounts for an Application Insights component. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzApplicationInsightsLinkedStorageAccount -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzApplicationInsightsLinkedStorageAccount -InputObject + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete linked storage accounts for an Application Insights component. + +## EXAMPLES + +### Example 1: Delete linked storage account associated with application insights component "componentName" +```powershell +Get-AzApplicationInsights -ResourceGroupName "rgName" -Name "componentName" | Remove-AzApplicationInsightsLinkedStorageAccount +``` + +Delete linked storage account associated with application insights component "componentName" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsMyWorkbook.md b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsMyWorkbook.md new file mode 100644 index 0000000000..7b0d73ee73 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsMyWorkbook.md @@ -0,0 +1,157 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/remove-azapplicationinsightsmyworkbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsMyWorkbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsMyWorkbook.md +--- + +# Remove-AzApplicationInsightsMyWorkbook + +## SYNOPSIS +Delete a private workbook. + +## SYNTAX + +``` +Remove-AzApplicationInsightsMyWorkbook -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a private workbook. + +## EXAMPLES + +### Example 1: Delete a private workbook +```powershell +Remove-AzApplicationInsightsMyWorkbook -ResourceGroupName appinsights-hkrs2v-test -Name c65b3461-9270-45b7-b6ad-ddd644458b0eR +``` + +Delete a private workbook. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsWebTest.md b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsWebTest.md new file mode 100644 index 0000000000..1c111339bf --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsWebTest.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/remove-azapplicationinsightswebtest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsWebTest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsWebTest.md +--- + +# Remove-AzApplicationInsightsWebTest + +## SYNOPSIS +Deletes an Application Insights web test. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzApplicationInsightsWebTest -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzApplicationInsightsWebTest -InputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an Application Insights web test. + +## EXAMPLES + +### Example 1: Deletes an Application Insights web test +```powershell +Remove-AzApplicationInsightsWebTest -ResourceGroupName azpwsh-rg-test -Name standardwebtest01-lucasappinsights +``` + +This command deletes an Application Insights web test. + +### Example 2: Deletes an Application Insights web test by pipeline +```powershell +Get-AzApplicationInsightsWebTest -ResourceGroupName azpwsh-rg-test -Name webtest01-lucasappinsights | Remove-AzApplicationInsightsWebTest +``` + +This command deletes an Application Insights web test by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights WebTest resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: WebTestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsWorkbook.md b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsWorkbook.md new file mode 100644 index 0000000000..3e63e61718 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsWorkbook.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/remove-azapplicationinsightsworkbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsWorkbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsWorkbook.md +--- + +# Remove-AzApplicationInsightsWorkbook + +## SYNOPSIS +Delete a workbook. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzApplicationInsightsWorkbook -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzApplicationInsightsWorkbook -InputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a workbook. + +## EXAMPLES + +### Example 1: Delete a workbook +```powershell +Remove-AzApplicationInsightsWorkbook -ResourceGroupName appinsights-hkrs2v-test -Name 7d195dcc-7d02-459f-a181-5b46662e4060 +``` + +Delete a workbook. + +### Example 2: Delete a workbook by pipeline +```powershell +Get-AzApplicationInsightsWorkbook -ResourceGroupName appinsights-hkrs2v-test -Name 7d195dcc-7d02-459f-a181-5b46662e4060 | Remove-AzApplicationInsightsWorkbook +``` + +Delete a workbook by pipeline + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsWorkbookTemplate.md b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsWorkbookTemplate.md new file mode 100644 index 0000000000..71602409da --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Remove-AzApplicationInsightsWorkbookTemplate.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/remove-azapplicationinsightsworkbooktemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsWorkbookTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Remove-AzApplicationInsightsWorkbookTemplate.md +--- + +# Remove-AzApplicationInsightsWorkbookTemplate + +## SYNOPSIS +Delete a workbook template. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzApplicationInsightsWorkbookTemplate -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzApplicationInsightsWorkbookTemplate -InputObject + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a workbook template. + +## EXAMPLES + +### Example 1: Delete a workbook template +```powershell +Remove-AzApplicationInsightsWorkbookTemplate -ResourceGroupName appinsights-hkrs2v-test -Name workbooktemplate-pwsh01 +``` + +Delete a workbook template. + +### Example 2: Delete a workbook template by pipeline +```powershell +Get-AzApplicationInsightsWorkbookTemplate -ResourceGroupName appinsights-hkrs2v-test -Name workbooktemplate-pwsh01 | Remove-AzApplicationInsightsWorkbookTemplate +``` + +Delete a workbook template by pipeline + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Set-AzApplicationInsightsContinuousExport.md b/azps-10.1.0/Az.ApplicationInsights/Set-AzApplicationInsightsContinuousExport.md new file mode 100644 index 0000000000..c424000900 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Set-AzApplicationInsightsContinuousExport.md @@ -0,0 +1,289 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/set-azapplicationinsightscontinuousexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Set-AzApplicationInsightsContinuousExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Set-AzApplicationInsightsContinuousExport.md +--- + +# Set-AzApplicationInsightsContinuousExport + +## SYNOPSIS +Create a Continuous Export configuration of an Application Insights component. + +## SYNTAX + +``` +Set-AzApplicationInsightsContinuousExport -ExportId -Name -ResourceGroupName + [-SubscriptionId ] [-DestinationType ] [-DisableConfiguration] [-DocumentType ] + [-NotificationQueueEnabled ] [-NotificationQueueUri ] [-StorageAccountId ] + [-StorageLocation ] [-StorageSASUri ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create a Continuous Export configuration of an Application Insights component. + +## EXAMPLES + +### Example 1: Update continuous export configuration +```powershell +$sastoken = New-AzStorageContainerSASToken -Name testcontainer -Context $context -ExpiryTime (Get-Date).AddYears(50) -Permission w +$sasuri = "https://teststorageaccount.blob.core.windows.net/testcontainer" + $sastoken +Set-AzApplicationInsightsContinuousExport -ResourceGroupName "testgroup" -Name "test" ` +-DocumentType "Request","Trace" -ExportId "jlTFEiBg1rkDXOCIeJQ2mB2TxZg=" -StorageAccountId "/subscriptions/50359d91-7b9d-4823-85af-eb298a61ba96/resourceGroups/testgroup/providers/Microsoft.Storage/storageAccounts/teststorageaccount" -StorageLocation sourcecentralus ` +-StorageSASUri $sasuri -DestinationType Blob +``` + +Update continuous export configuration "jlTFEiBg1rkDXOCIeJQ2mB2TxZg=" of resource "test" in resource group "testgroup" to export "Request" and "Trace" documents to storage container "testcontainer" in "teststorageaccount".The SAS token have to be valid and have write permission to the container, otherwise continuous export feature won't work. +If SAS token expired, the continuous export feature will stop working. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationType +The Continuous Export destination type. +This has to be 'Blob'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableConfiguration + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentType +The document types to be exported, as comma separated values. +Allowed values include 'Requests', 'Custom Event', 'Exception', 'Metric', 'Page View', 'Page Load', 'Dependency', 'Performance Counter', 'Availability', 'Trace'. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportId +The Continuous Export configuration ID. +This is unique within a Application Insights component. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationQueueEnabled +Deprecated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationQueueUri +Deprecated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountId +The name of destination storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageLocation +The location ID of the destination storage container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSASUri +The SAS URL for the destination storage container. +It must grant write permission. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20150501.IApplicationInsightsComponentExportConfiguration + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Set-AzApplicationInsightsDailyCap.md b/azps-10.1.0/Az.ApplicationInsights/Set-AzApplicationInsightsDailyCap.md new file mode 100644 index 0000000000..d751214d3f --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Set-AzApplicationInsightsDailyCap.md @@ -0,0 +1,173 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/set-azapplicationinsightsdailycap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Set-AzApplicationInsightsDailyCap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Set-AzApplicationInsightsDailyCap.md +--- + +# Set-AzApplicationInsightsDailyCap + +## SYNOPSIS +Update current billing features for an Application Insights component. + +## SYNTAX + +``` +Set-AzApplicationInsightsDailyCap -Name -ResourceGroupName [-SubscriptionId ] + [-DailyCapGB ] [-DisableNotificationWhenHitCap] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Update current billing features for an Application Insights component. + +## EXAMPLES + +### Example 1: Set daily data volume cap for an application insights resource +```powershell +Set-AzApplicationInsightsDailyCap -ResourceGroupName "testgroup" -Name "test" -DailyCapGB 400 -DisableNotificationWhenHitCap +``` + +Set the daily data volume cap to 400GB per day and stop send notification when hit cap for resource "test" in resource group "testgroup" + +## PARAMETERS + +### -DailyCapGB +Daily data volume cap in GB. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableNotificationWhenHitCap +Stop send notification when hit cap. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20150501.IApplicationInsightsComponentBillingFeatures + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Set-AzApplicationInsightsPricingPlan.md b/azps-10.1.0/Az.ApplicationInsights/Set-AzApplicationInsightsPricingPlan.md new file mode 100644 index 0000000000..adc247d3c7 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Set-AzApplicationInsightsPricingPlan.md @@ -0,0 +1,189 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/set-azapplicationinsightspricingplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Set-AzApplicationInsightsPricingPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Set-AzApplicationInsightsPricingPlan.md +--- + +# Set-AzApplicationInsightsPricingPlan + +## SYNOPSIS +Update current billing features for an Application Insights component. + +## SYNTAX + +``` +Set-AzApplicationInsightsPricingPlan -Name -ResourceGroupName [-SubscriptionId ] + [-DailyCapGB ] [-DisableNotificationWhenHitCap] [-PricingPlan ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update current billing features for an Application Insights component. + +## EXAMPLES + +### Example 1: Set pricing plan and daily data volume information for an application insights resource +```powershell +Set-AzApplicationInsightsPricingPlan -ResourceGroupName "testgroup" -Name "test" -PricingPlan "Basic" -DailyCapGB 400 +``` + +Set the pricing plan to "Basic", set the daily data volume cap to 400GB per day and stop send notification when hit cap for resource "test" in resource group "testgroup" + +## PARAMETERS + +### -DailyCapGB +Daily data volume cap in GB. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableNotificationWhenHitCap +Stop send notification when hit cap. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PricingPlan +Current enabled pricing plan. +When the component is in the Enterprise plan, this will list both 'Basic' and 'Application Insights Enterprise'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20150501.IApplicationInsightsComponentBillingFeatures + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsights.md b/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsights.md new file mode 100644 index 0000000000..5bb9e89408 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsights.md @@ -0,0 +1,394 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/update-azapplicationinsights +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Update-AzApplicationInsights.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Update-AzApplicationInsights.md +--- + +# Update-AzApplicationInsights + +## SYNOPSIS +Creates (or updates) an Application Insights component. +Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. + +## SYNTAX + +``` +Update-AzApplicationInsights -Name -ResourceGroupName [-SubscriptionId ] + [-ApplicationType ] [-DisableIPMasking] [-DisableLocalAuth] [-Etag ] + [-FlowType ] [-ForceCustomerStorageForProfiler] [-HockeyAppId ] + [-ImmediatePurgeDataOn30Day] [-IngestionMode ] + [-PublicNetworkAccessForIngestion ] + [-PublicNetworkAccessForQuery ] [-RequestSource ] + [-RetentionInDays ] [-SamplingPercentage ] [-Tag ] [-WorkspaceResourceId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates (or updates) an Application Insights component. +Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. + +## EXAMPLES + +### Example 1: Update application insights component +```powershell +Update-AzApplicationInsights -ResourceGroupName "rgName" -Name "aiName" -PublicNetworkAccessForIngestion "Disabled" -PublicNetworkAccessForQuery "Disabled" +``` + +update application insights component "aiName" PublicNetworkAccessForIngestion/PublicNetworkAccessForQuery both to "Disabled" + +## PARAMETERS + +### -ApplicationType +Type of application being monitored. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.ApplicationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableIPMasking +Disable IP masking. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Disable Non-AAD based Auth. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Resource etag + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowType +Used by the Application Insights system to determine what kind of flow this component was created by. +This is to be set to 'Bluefield' when creating/updating a component via the REST API. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.FlowType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceCustomerStorageForProfiler +Force users to create their own storage account for profiler and debugger. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HockeyAppId +The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmediatePurgeDataOn30Day +Purge data immediately after 30 days. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngestionMode +Indicates the flow of the ingestion. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.IngestionMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccessForIngestion +The network access type for accessing Application Insights ingestion. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.PublicNetworkAccessType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccessForQuery +The network access type for accessing Application Insights query. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.PublicNetworkAccessType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestSource +Describes what tool created this Application Insights component. +Customers using this API should set this to the default 'rest'. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Support.RequestSource +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionInDays +Retention period in days. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamplingPercentage +Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry. + +```yaml +Type: System.Double +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +Resource Id of the log analytics workspace which the data will be ingested to. +This property is required to create an application with this API version. +Applications from older versions will not have this property. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api202002.IApplicationInsightsComponent + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsLinkedStorageAccount.md b/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsLinkedStorageAccount.md new file mode 100644 index 0000000000..99eae29afb --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsLinkedStorageAccount.md @@ -0,0 +1,204 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/update-azapplicationinsightslinkedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Update-AzApplicationInsightsLinkedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Update-AzApplicationInsightsLinkedStorageAccount.md +--- + +# Update-AzApplicationInsightsLinkedStorageAccount + +## SYNOPSIS +Update linked storage accounts for an Application Insights component. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzApplicationInsightsLinkedStorageAccount -Name -ResourceGroupName + [-SubscriptionId ] [-LinkedStorageAccountResourceId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzApplicationInsightsLinkedStorageAccount -InputObject + [-LinkedStorageAccountResourceId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Update linked storage accounts for an Application Insights component. + +## EXAMPLES + +### Example 1: Update linked storage account +```powershell +$account = Get-AzStorageAccount -ResourceGroupName "rgName" -Name "accountName" +Get-AzApplicationInsights -ResourceGroupName "rgName" -Name "componentName" | Update-AzApplicationInsightsLinkedStorageAccount -LinkedStorageAccountResourceId $account.Id +``` + +Update linked storage account under component "componentName" to associate with $account + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkedStorageAccountResourceId +Linked storage account resource ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ApplicationInsightsComponentName, ComponentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20200301Preview.IComponentLinkedStorageAccounts + +## 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 + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsMyWorkbook.md b/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsMyWorkbook.md new file mode 100644 index 0000000000..7271a9a90a --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsMyWorkbook.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/update-azapplicationinsightsmyworkbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Update-AzApplicationInsightsMyWorkbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Update-AzApplicationInsightsMyWorkbook.md +--- + +# Update-AzApplicationInsightsMyWorkbook + +## SYNOPSIS +Updates a private workbook that has already been added. + +## SYNTAX + +``` +Update-AzApplicationInsightsMyWorkbook -Name -ResourceGroupName + -WorkbookProperty [-SubscriptionId ] [-LinkedSourceId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates a private workbook that has already been added. + +## EXAMPLES + +### Example 1: Updates a private workbook that has already been added +```powershell +$myWorkbook = Get-AzApplicationInsightsMyWorkbook -ResourceGroupName "appinsights-hkrs2v-test" -Name "2e47417f-c136-44c0-b78f-7a4ca35fd9d1" +$myWorkbook.DisplayName = "pwsh01" +Update-AzApplicationInsightsMyWorkbook -ResourceGroupName "appinsights-hkrs2v-test" -Name "2e47417f-c136-44c0-b78f-7a4ca35fd9d1" -WorkbookProperty $myWorkbook +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test 2e47417f-c136-44c0-b78f-7a4ca35fd9d1 pwsh01 westus2 user workbook +``` + +Updates a private workbook that has already been added. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedSourceId +Azure Resource Id that will fetch all linked workbooks. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkbookProperty +An Application Insights private workbook definition. +To construct, see NOTES section for WORKBOOKPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20210308.IMyWorkbook +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20210308.IMyWorkbook + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20210308.IMyWorkbook + +## 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. + + +`WORKBOOKPROPERTY `: An Application Insights private workbook definition. + - `[Etag ]`: Resource etag + - `[(Any) ]`: This indicates any property can be added to this object. + - `[Id ]`: Azure resource Id + - `[IdentityType ]`: The identity type. + - `[Location ]`: Resource location + - `[Name ]`: Azure resource name + - `[Tag ]`: Resource tags + - `[(Any) ]`: This indicates any property can be added to this object. + - `[Type ]`: Azure resource type + - `[Category ]`: Workbook category, as defined by the user at creation time. + - `[DisplayName ]`: The user-defined name of the private workbook. + - `[Kind ]`: The kind of workbook. Choices are user and shared. + - `[PropertiesTag ]`: A list of 0 or more tags that are associated with this private workbook definition + - `[SerializedData ]`: Configuration of this particular private workbook. Configuration data is a string containing valid JSON + - `[SourceId ]`: Optional resourceId for a source resource. + - `[StorageUri ]`: BYOS Storage Account URI + - `[SystemDataCreatedAt ]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy ]`: The identity that created the resource. + - `[SystemDataCreatedByType ]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt ]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy ]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType ]`: The type of identity that last modified the resource. + - `[Version ]`: This instance's version of the data model. This can change as new features are added that can be marked private workbook. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsWebTestTag.md b/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsWebTestTag.md new file mode 100644 index 0000000000..470786e2e9 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsWebTestTag.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/update-azapplicationinsightswebtesttag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Update-AzApplicationInsightsWebTestTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Update-AzApplicationInsightsWebTestTag.md +--- + +# Update-AzApplicationInsightsWebTestTag + +## SYNOPSIS +Updates the tags associated with an Application Insights web test. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzApplicationInsightsWebTestTag -Name -ResourceGroupName [-SubscriptionId ] + [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzApplicationInsightsWebTestTag -InputObject [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates the tags associated with an Application Insights web test. + +## EXAMPLES + +### Example 1: Updates Application Insights link of the Web test +```powershell +Update-AzApplicationInsightsWebTestTag -ResourceGroupName azpwsh-rg-test -Name webtest01-lucasappinsights -Tag @{"hidden-link:/subscriptions/xxxxxxxxxx-xxxxx-xxxx-xxxxxxxxxxxx/resourceGroups/azpwsh-rg-test/providers/microsoft.insights/components/lucasappinsights" = "Resource"} +``` + +```output +Location Name WebTestKind ResourceGroupName Enabled +-------- ---- ----------- ----------------- ------- +westus2 webtest01-lucasappinsights standard azpwsh-rg-test True +``` + +This command updates Application Insights link of the Web test. + +### Example 2: Updates Application Insights link of the Web test by pipeline +```powershell +Get-AzApplicationInsightsWebTest -ResourceGroupName azpwsh-rg-test -WebTestName webtest01-lucasappinsights | Update-AzApplicationInsightsWebTestTag -Tag @{"hidden-link:/subscriptions/xxxxxxxxxx-xxxxx-xxxx-xxxxxxxxxxxx/resourceGroups/azpwsh-rg-test/providers/microsoft.insights/components/appinsightsportal01" = "Resource"} +``` + +```output +Location Name WebTestKind ResourceGroupName Enabled +-------- ---- ----------- ----------------- ------- +westus2 webtest01-lucasappinsights standard azpwsh-rg-test True +``` + +This command updates Application Insights link of the Web test by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights WebTest resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220615.IWebTest + +## 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 + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsWorkbook.md b/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsWorkbook.md new file mode 100644 index 0000000000..107e183023 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsWorkbook.md @@ -0,0 +1,330 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/update-azapplicationinsightsworkbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Update-AzApplicationInsightsWorkbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Update-AzApplicationInsightsWorkbook.md +--- + +# Update-AzApplicationInsightsWorkbook + +## SYNOPSIS +Updates a workbook that has already been added. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzApplicationInsightsWorkbook -Name -ResourceGroupName [-SubscriptionId ] + [-LinkedSourceId ] [-Category ] [-Description ] [-DisplayName ] + [-Revision ] [-SerializedData ] [-SourceTag ] [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzApplicationInsightsWorkbook -InputObject [-LinkedSourceId ] + [-Category ] [-Description ] [-DisplayName ] [-Revision ] + [-SerializedData ] [-SourceTag ] [-Tag ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Updates a workbook that has already been added. + +## EXAMPLES + +### Example 1: Updates a workbook that has already been added +```powershell +Update-AzApplicationInsightsWorkbook -ResourceGroupName appinsights-hkrs2v-test -Name cc18e5e4-9558-4be1-b333-20b28aaca021 -DisplayName "workbook-portal" +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test cc18e5e4-9558-4be1-b333-20b28aaca021 workbook-portal eastus shared workbook +``` + +Updates a workbook that has already been added + +### Example 2: Updates a workbook that has already been added by pipeline +```powershell +Get-AzApplicationInsightsWorkbook -ResourceGroupName appinsights-hkrs2v-test -Name cc18e5e4-9558-4be1-b333-20b28aaca021 | Update-AzApplicationInsightsWorkbook -Tag @{'k1'='v1'} +``` + +```output +ResourceGroupName Name DisplayName Location Kind Category +----------------- ---- ----------- -------- ---- -------- +appinsights-hkrs2v-test cc18e5e4-9558-4be1-b333-20b28aaca021 workbook-portal eastus shared workbook +``` + +Updates a workbook that has already been added by pipeline. + +## PARAMETERS + +### -Category +Workbook category, as defined by the user at creation time. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the workbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The user-defined name (display name) of the workbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkedSourceId +Azure Resource Id that will fetch all linked workbooks. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Revision +The unique revision id for this workbook definition + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SerializedData +Configuration of this particular workbook. +Configuration data is a string containing valid JSON + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceTag +A list of 0 or more tags that are associated with this workbook definition + +```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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220401.IWorkbook + +## 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 + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsWorkbookTemplate.md b/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsWorkbookTemplate.md new file mode 100644 index 0000000000..2c2d76ed48 --- /dev/null +++ b/azps-10.1.0/Az.ApplicationInsights/Update-AzApplicationInsightsWorkbookTemplate.md @@ -0,0 +1,308 @@ +--- +external help file: +Module Name: Az.ApplicationInsights +online version: https://learn.microsoft.com/powershell/module/az.applicationinsights/update-azapplicationinsightsworkbooktemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Update-AzApplicationInsightsWorkbookTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ApplicationInsights/help/Update-AzApplicationInsightsWorkbookTemplate.md +--- + +# Update-AzApplicationInsightsWorkbookTemplate + +## SYNOPSIS +Updates a workbook template that has already been added. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzApplicationInsightsWorkbookTemplate -Name -ResourceGroupName + [-SubscriptionId ] [-Author ] [-Gallery ] + [-Localized ] [-Priority ] [-Tag ] [-TemplateData ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzApplicationInsightsWorkbookTemplate -InputObject [-Author ] + [-Gallery ] [-Localized ] [-Priority ] [-Tag ] + [-TemplateData ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates a workbook template that has already been added. + +## EXAMPLES + +### Example 1: Updates a workbook template that has already been added +```powershell +Update-AzApplicationInsightsWorkbookTemplate -ResourceGroupName resourceGroup -Name workbooktemplate-pwsh01 -Tag @{'k1'='v1'} +``` + +```output +ResourceGroupName Name Location +----------------- ---- -------- +appinsights-hkrs2v-test workbooktemplate-pwsh01 westus2 +``` + +Updates a workbook template that has already been added. + +### Example 2: Updates a workbook template that has already been added by pipeline +```powershell +Get-AzApplicationInsightsWorkbookTemplate -ResourceGroupName resourceGroup -Name workbooktemplate-pwsh01 | Update-AzApplicationInsightsWorkbookTemplate -Tag @{'k1'='v1'} +``` + +```output +ResourceGroupName Name Location +----------------- ---- -------- +appinsights-hkrs2v-test workbooktemplate-pwsh01 westus2 +``` + +Updates a workbook template that has already been added by pipeline. + +## PARAMETERS + +### -Author +Information about the author of the workbook template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Gallery +Workbook galleries supported by the template. +To construct, see NOTES section for GALLERY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20201120.IWorkbookTemplateGallery[] +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.ApplicationInsights.Models.IApplicationInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Localized +Key value pair of localized gallery. +Each key is the locale code of languages supported by the Azure portal. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Insights component resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Priority of the template. +Determines which template to open when a workbook gallery is opened in viewer mode. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateData +Valid JSON object containing workbook template payload. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20201120.IWorkbookTemplate + +## 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. + + +`GALLERY `: Workbook galleries supported by the template. + - `[Category ]`: Category for the gallery. + - `[Name ]`: Name of the workbook template in the gallery. + - `[Order ]`: Order of the template within the gallery. + - `[ResourceType ]`: Azure resource type supported by the gallery. + - `[Type ]`: Type of workbook supported by the workbook template. + +`INPUTOBJECT `: Identity Parameter + - `[AnnotationId ]`: The unique annotation ID. This is unique within a Application Insights component. + - `[ComponentName ]`: The name of the Application Insights component resource. + - `[ExportId ]`: The Continuous Export configuration ID. This is unique within a Application Insights component. + - `[Id ]`: Resource identity path + - `[KeyId ]`: The API Key ID. This is unique within a Application Insights component. + - `[PurgeId ]`: In a purge status request, this is the Id of the operation the status of which is returned. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: The name of the Application Insights component resource. + - `[RevisionId ]`: The id of the workbook's revision. + - `[StorageType ]`: The type of the Application Insights component data source for the linked storage account. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WebTestName ]`: The name of the Application Insights WebTest resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ArcResourceBridge/Az.ArcResourceBridge.md b/azps-10.1.0/Az.ArcResourceBridge/Az.ArcResourceBridge.md new file mode 100644 index 0000000000..f6fa647ba7 --- /dev/null +++ b/azps-10.1.0/Az.ArcResourceBridge/Az.ArcResourceBridge.md @@ -0,0 +1,39 @@ +--- +Module Name: Az.ArcResourceBridge +Module Guid: 329aa971-c12b-4d4b-abe5-3b638b0b5660 +Download Help Link: https://learn.microsoft.com/powershell/module/az.arcresourcebridge +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Az.ArcResourceBridge.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Az.ArcResourceBridge.md +--- + +# Az.ArcResourceBridge Module +## Description +Microsoft Azure PowerShell: ArcResourceBridge cmdlets + +## Az.ArcResourceBridge Cmdlets +### [Get-AzArcResourceBridge](Get-AzArcResourceBridge.md) +Gets the details of an Appliance with a specified resource group and name. + +### [Get-AzArcResourceBridgeApplianceCredential](Get-AzArcResourceBridgeApplianceCredential.md) +Returns the cluster user credentials for the dedicated appliance. + +### [Get-AzArcResourceBridgeCredential](Get-AzArcResourceBridgeCredential.md) +Returns the cluster customer credentials for the dedicated appliance. + +### [Get-AzArcResourceBridgeTelemetryConfig](Get-AzArcResourceBridgeTelemetryConfig.md) +Gets the telemetry config. + +### [Get-AzArcResourceBridgeUpgradeGraph](Get-AzArcResourceBridgeUpgradeGraph.md) +Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train. + +### [New-AzArcResourceBridge](New-AzArcResourceBridge.md) +Creates or updates an Appliance in the specified Subscription and Resource Group. + +### [Remove-AzArcResourceBridge](Remove-AzArcResourceBridge.md) +Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id. + +### [Update-AzArcResourceBridge](Update-AzArcResourceBridge.md) +Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription. + diff --git a/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridge.md b/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridge.md new file mode 100644 index 0000000000..9cc9f2065f --- /dev/null +++ b/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridge.md @@ -0,0 +1,192 @@ +--- +external help file: +Module Name: Az.ArcResourceBridge +online version: https://learn.microsoft.com/powershell/module/az.arcresourcebridge/get-azarcresourcebridge +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Get-AzArcResourceBridge.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Get-AzArcResourceBridge.md +--- + +# Get-AzArcResourceBridge + +## SYNOPSIS +Gets the details of an Appliance with a specified resource group and name. + +## SYNTAX + +### List (Default) +``` +Get-AzArcResourceBridge [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzArcResourceBridge -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzArcResourceBridge -InputObject [-DefaultProfile ] + [] +``` + +### List1 +``` +Get-AzArcResourceBridge -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets the details of an Appliance with a specified resource group and name. + +## EXAMPLES + +### Example 1: List the details of Appliance with a specified subId. +```powershell +Get-AzArcResourceBridge +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +azps-resource-bridge eastus Succeeded azps_test_group +``` + +List the details of Appliance with a specified subId. + +### Example 2: List the details of Appliance with a specified resource group. +```powershell +Get-AzArcResourceBridge -ResourceGroupName azps_test_group +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +azps-resource-bridge eastus Succeeded azps_test_group +``` + +List the details of Appliance with a specified resource group. + +### Example 3: Get the details of an Appliance with a specified resource group and name. +```powershell +Get-AzArcResourceBridge -ResourceGroupName azps_test_group -Name azps-resource-bridge +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +azps-resource-bridge eastus Succeeded azps_test_group +``` + +Get the details of an Appliance with a specified resource group and name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.IArcResourceBridgeIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Appliances name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.IArcResourceBridgeIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.Api20221027.IAppliance + +## 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 ]`: Appliances name. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[UpgradeGraph ]`: Upgrade graph version, ex - stable + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridgeApplianceCredential.md b/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridgeApplianceCredential.md new file mode 100644 index 0000000000..ec8a9c7318 --- /dev/null +++ b/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridgeApplianceCredential.md @@ -0,0 +1,154 @@ +--- +external help file: +Module Name: Az.ArcResourceBridge +online version: https://learn.microsoft.com/powershell/module/az.arcresourcebridge/get-azarcresourcebridgeappliancecredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Get-AzArcResourceBridgeApplianceCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Get-AzArcResourceBridgeApplianceCredential.md +--- + +# Get-AzArcResourceBridgeApplianceCredential + +## SYNOPSIS +Returns the cluster user credentials for the dedicated appliance. + +## SYNTAX + +``` +Get-AzArcResourceBridgeApplianceCredential -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Returns the cluster user credentials for the dedicated appliance. + +## EXAMPLES + +### Example 1: Returns the cluster user credentials for the dedicated appliance. +```powershell +Get-AzArcResourceBridgeApplianceCredential -ResourceGroupName azps_test_group -Name azps-resource-bridge +``` + +```output +HybridConnectionConfigExpirationTime : 1678424933 +HybridConnectionConfigHybridConnectionName : microsoft.resourceconnector/appliances/bc2***a81fb98c/167***794176 +HybridConnectionConfigRelay : azgnrelay-ph0-l1 +HybridConnectionConfigToken : SharedAccessSignature***30308 +Kubeconfig : {{ + "name": "clusterUser", + "value": "YXBpV***zZQo=" + }} +``` + +Returns the cluster user credentials for the dedicated appliance. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Appliances name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.Api20221027.IApplianceListCredentialResults + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridgeCredential.md b/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridgeCredential.md new file mode 100644 index 0000000000..f86e6f2eee --- /dev/null +++ b/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridgeCredential.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.ArcResourceBridge +online version: https://learn.microsoft.com/powershell/module/az.arcresourcebridge/get-azarcresourcebridgecredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Get-AzArcResourceBridgeCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Get-AzArcResourceBridgeCredential.md +--- + +# Get-AzArcResourceBridgeCredential + +## SYNOPSIS +Returns the cluster customer credentials for the dedicated appliance. + +## SYNTAX + +``` +Get-AzArcResourceBridgeCredential -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Returns the cluster customer credentials for the dedicated appliance. + +## EXAMPLES + +### Example 1: Returns the cluster customer credentials for the dedicated appliance. +```powershell +Get-AzArcResourceBridgeCredential -ResourceGroupName azps_test_group -Name azps-resource-bridge +``` + +```output +ArtifactProfile Kubeconfig SshKey +--------------- ---------- ------ +{… {… +``` + +Returns the cluster customer credentials for the dedicated appliance. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Appliances name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.Api20221027.IApplianceListKeysResults + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridgeTelemetryConfig.md b/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridgeTelemetryConfig.md new file mode 100644 index 0000000000..a7917ae215 --- /dev/null +++ b/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridgeTelemetryConfig.md @@ -0,0 +1,122 @@ +--- +external help file: +Module Name: Az.ArcResourceBridge +online version: https://learn.microsoft.com/powershell/module/az.arcresourcebridge/get-azarcresourcebridgetelemetryconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Get-AzArcResourceBridgeTelemetryConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Get-AzArcResourceBridgeTelemetryConfig.md +--- + +# Get-AzArcResourceBridgeTelemetryConfig + +## SYNOPSIS +Gets the telemetry config. + +## SYNTAX + +### Get (Default) +``` +Get-AzArcResourceBridgeTelemetryConfig [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzArcResourceBridgeTelemetryConfig -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets the telemetry config. + +## EXAMPLES + +### Example 1: Gets the telemetry config. +```powershell +Get-AzArcResourceBridgeTelemetryConfig +``` + +```output +8340f324-76bb-4716-9838-7b3eedd19914 +``` + +Gets the telemetry config. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.IArcResourceBridgeIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.IArcResourceBridgeIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[Id ]`: Resource identity path + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: Appliances name. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[UpgradeGraph ]`: Upgrade graph version, ex - stable + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridgeUpgradeGraph.md b/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridgeUpgradeGraph.md new file mode 100644 index 0000000000..d44b38dc3b --- /dev/null +++ b/azps-10.1.0/Az.ArcResourceBridge/Get-AzArcResourceBridgeUpgradeGraph.md @@ -0,0 +1,170 @@ +--- +external help file: +Module Name: Az.ArcResourceBridge +online version: https://learn.microsoft.com/powershell/module/az.arcresourcebridge/get-azarcresourcebridgeupgradegraph +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Get-AzArcResourceBridgeUpgradeGraph.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Get-AzArcResourceBridgeUpgradeGraph.md +--- + +# Get-AzArcResourceBridgeUpgradeGraph + +## SYNOPSIS +Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train. + +## SYNTAX + +### Get (Default) +``` +Get-AzArcResourceBridgeUpgradeGraph -Name -ResourceGroupName -UpgradeGraph + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzArcResourceBridgeUpgradeGraph -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train. + +## EXAMPLES + +### Example 1: Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train. +```powershell +Get-AzArcResourceBridgeUpgradeGraph -ResourceGroupName azps_test_group -Name azps-resource-bridge -UpgradeGraph Stable +``` + +```output +Name ResourceGroupName +---- ----------------- +stable azps_test_group +``` + +Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.IArcResourceBridgeIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Appliances name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeGraph +Upgrade graph version, ex - stable + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.IArcResourceBridgeIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.Api20221027.IUpgradeGraph + +## 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 ]`: Appliances name. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[UpgradeGraph ]`: Upgrade graph version, ex - stable + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ArcResourceBridge/New-AzArcResourceBridge.md b/azps-10.1.0/Az.ArcResourceBridge/New-AzArcResourceBridge.md new file mode 100644 index 0000000000..163a4b35f1 --- /dev/null +++ b/azps-10.1.0/Az.ArcResourceBridge/New-AzArcResourceBridge.md @@ -0,0 +1,288 @@ +--- +external help file: +Module Name: Az.ArcResourceBridge +online version: https://learn.microsoft.com/powershell/module/az.arcresourcebridge/new-azarcresourcebridge +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/New-AzArcResourceBridge.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/New-AzArcResourceBridge.md +--- + +# New-AzArcResourceBridge + +## SYNOPSIS +Creates or updates an Appliance in the specified Subscription and Resource Group. + +## SYNTAX + +``` +New-AzArcResourceBridge -Name -ResourceGroupName -Location + [-SubscriptionId ] [-Distro ] [-IdentityType ] + [-InfrastructureConfigProvider ] [-PublicKey ] [-Tag ] [-Version ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates or updates an Appliance in the specified Subscription and Resource Group. + +## EXAMPLES + +### Example 1: Creates or updates an Appliance in the specified Subscription and Resource Group. +```powershell +New-AzArcResourceBridge -Name azps-resource-bridge -ResourceGroupName azps_test_group -Location eastus -IdentityType 'SystemAssigned' -Distro 'AKSEdge' -InfrastructureConfigProvider 'VMware' -Tag @{"123"="abc"} +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +azps-resource-bridge eastus Succeeded azps_test_group +``` + +Creates or updates an Appliance in the specified Subscription and Resource Group. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Distro +Represents a supported Fabric/Infra. +(AKSEdge etc...). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Support.Distro +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InfrastructureConfigProvider +Information about the connected appliance. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Support.Provider +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Appliances name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicKey +Certificates pair used to download MSI certificate from HIS. +Can only be set once. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version of the Appliance + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.Api20221027.IAppliance + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ArcResourceBridge/Remove-AzArcResourceBridge.md b/azps-10.1.0/Az.ArcResourceBridge/Remove-AzArcResourceBridge.md new file mode 100644 index 0000000000..98ace60e97 --- /dev/null +++ b/azps-10.1.0/Az.ArcResourceBridge/Remove-AzArcResourceBridge.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.ArcResourceBridge +online version: https://learn.microsoft.com/powershell/module/az.arcresourcebridge/remove-azarcresourcebridge +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Remove-AzArcResourceBridge.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Remove-AzArcResourceBridge.md +--- + +# Remove-AzArcResourceBridge + +## SYNOPSIS +Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzArcResourceBridge -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzArcResourceBridge -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id. + +## EXAMPLES + +### Example 1: Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id. +```powershell +Remove-AzArcResourceBridge -Name azps-resource-bridge -ResourceGroupName azps_test_group +``` + +Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id. + +### Example 2: Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id. +```powershell +Get-AzArcResourceBridge -Name azps-resource-bridge -ResourceGroupName azps_test_group | Remove-AzArcResourceBridge +``` + +Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.IArcResourceBridgeIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Appliances name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.IArcResourceBridgeIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[Id ]`: Resource identity path + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[ResourceName ]`: Appliances name. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[UpgradeGraph ]`: Upgrade graph version, ex - stable + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ArcResourceBridge/Update-AzArcResourceBridge.md b/azps-10.1.0/Az.ArcResourceBridge/Update-AzArcResourceBridge.md new file mode 100644 index 0000000000..c3450a088d --- /dev/null +++ b/azps-10.1.0/Az.ArcResourceBridge/Update-AzArcResourceBridge.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.ArcResourceBridge +online version: https://learn.microsoft.com/powershell/module/az.arcresourcebridge/update-azarcresourcebridge +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Update-AzArcResourceBridge.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ArcResourceBridge/help/Update-AzArcResourceBridge.md +--- + +# Update-AzArcResourceBridge + +## SYNOPSIS +Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzArcResourceBridge -Name -ResourceGroupName [-SubscriptionId ] + [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzArcResourceBridge -InputObject [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription. + +## EXAMPLES + +### Example 1: Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription. +```powershell +Update-AzArcResourceBridge -Name azps-resource-bridge -ResourceGroupName azps_test_group -Tag @{"111"="222";"aaa"="bbb"} +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +azps-resource-bridge eastus Succeeded azps_test_group +``` + +Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription. + +### Example 2: Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription. +```powershell +Get-AzArcResourceBridge -ResourceGroupName azps_test_group -Name azps-resource-bridge | Update-AzArcResourceBridge -Tag @{"111"="222";"aaa"="bbb"} +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +azps-resource-bridge eastus Succeeded azps_test_group +``` + +Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.IArcResourceBridgeIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Appliances name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.IArcResourceBridgeIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ArcResourceBridge.Models.Api20221027.IAppliance + +## 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 ]`: Appliances name. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[UpgradeGraph ]`: Upgrade graph version, ex - stable + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Attestation/Add-AzAttestationPolicySigner.md b/azps-10.1.0/Az.Attestation/Add-AzAttestationPolicySigner.md new file mode 100644 index 0000000000..670ededcb1 --- /dev/null +++ b/azps-10.1.0/Az.Attestation/Add-AzAttestationPolicySigner.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Attestation.dll-Help.xml +Module Name: Az.Attestation +online version: https://learn.microsoft.com/powershell/module/az.attestation/add-azattestationpolicysigner +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Add-AzAttestationPolicySigner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Add-AzAttestationPolicySigner.md +--- + +# Add-AzAttestationPolicySigner + +## SYNOPSIS +Adds a trusted policy signer for a tenant in Azure Attestation. + +## SYNTAX + +### NameParameterSet +``` +Add-AzAttestationPolicySigner [-Name] [-ResourceGroupName] -Signer + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ResourceIdParameterSet +``` +Add-AzAttestationPolicySigner [-ResourceId] -Signer + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Add-AzAttestationPolicySigner cmdlet adds a trusted policy signer for a tenant in Azure Attestation. + +## EXAMPLES + +### Example 1 +```powershell +$trustedSigner = Get-Content -Path .\trusted.signer.txt +Add-AzAttestationPolicySigner -Name pshtest -ResourceGroupName psh-test-rg -Signer $trustedSigner +``` + +Add a trusted signer for the Atteestation Provider named *pshtest*. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the ResourceID of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Signer +Specifies the RFC7519 JSON Web Token containing a claim named "maa-policyCertificate" whose value is an RFC7517 JSON Web Key which contains a new trusted signing key to add. +The RFC7519 JWT must be signed with one of the existing trusted signing keys. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Attestation.Models.PSPolicySigners + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Attestation/Az.Attestation.md b/azps-10.1.0/Az.Attestation/Az.Attestation.md new file mode 100644 index 0000000000..abcacc45ad --- /dev/null +++ b/azps-10.1.0/Az.Attestation/Az.Attestation.md @@ -0,0 +1,48 @@ +--- +Module Name: Az.Attestation +Module Guid: 249cb945-683e-4866-a9af-5704a2d890a5 +Download Help Link: https://learn.microsoft.com/powershell/module/az.attestation +Help Version: 0.0.1.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Az.Attestation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Az.Attestation.md +--- + +# Az.Attestation Module +## Description +This topic displays help topics for the Azure Attestation Cmdlets. + +## Az.Attestation Cmdlets +### [Add-AzAttestationPolicySigner](Add-AzAttestationPolicySigner.md) +Adds a trusted policy signer for a tenant in Azure Attestation. + +### [Get-AzAttestationDefaultProvider](Get-AzAttestationDefaultProvider.md) +Get the default provider by location. + +### [Get-AzAttestationPolicy](Get-AzAttestationPolicy.md) +Gets the policy from a tenant in Azure Attestation. + +### [Get-AzAttestationPolicySigners](Get-AzAttestationPolicySigners.md) +Gets the trusted policy signers from a tenant in Azure Attestation. + +### [Get-AzAttestationProvider](Get-AzAttestationProvider.md) +Get the status of Attestation Provider. + +### [New-AzAttestationProvider](New-AzAttestationProvider.md) +Creates a new Attestation Provider. + +### [Remove-AzAttestationPolicySigner](Remove-AzAttestationPolicySigner.md) +Removes a trusted policy signer for a tenant in Azure Attestation. + +### [Remove-AzAttestationProvider](Remove-AzAttestationProvider.md) +Delete Attestation Service. + +### [Reset-AzAttestationPolicy](Reset-AzAttestationPolicy.md) +Resets the policy from a tenant in Azure Attestationn.} + +### [Set-AzAttestationPolicy](Set-AzAttestationPolicy.md) +Sets the policy from a tenant in Azure Attestationn. + +### [Update-AzAttestationProvider](Update-AzAttestationProvider.md) +Updates the Attestation Provider. + diff --git a/azps-10.1.0/Az.Attestation/Get-AzAttestationDefaultProvider.md b/azps-10.1.0/Az.Attestation/Get-AzAttestationDefaultProvider.md new file mode 100644 index 0000000000..b13d11e206 --- /dev/null +++ b/azps-10.1.0/Az.Attestation/Get-AzAttestationDefaultProvider.md @@ -0,0 +1,204 @@ +--- +external help file: Az.Attestation-help.xml +Module Name: Az.Attestation +online version: https://learn.microsoft.com/powershell/module/az.attestation/get-azattestationdefaultprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Get-AzAttestationDefaultProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Get-AzAttestationDefaultProvider.md +--- + +# Get-AzAttestationDefaultProvider + +## SYNOPSIS +Get the default provider by location. + +## SYNTAX + +### List (Default) +``` +Get-AzAttestationDefaultProvider [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAttestationDefaultProvider -Location [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzAttestationDefaultProvider -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get the default provider by location. + +## EXAMPLES + +### Example 1: Get the default provider by location +```powershell +Get-AzAttestationDefaultProvider -Location "East US" +``` + +```output +Get-AzAttestationDefaultProvider -Location "East US" + +Location Name ResourceGroupName +-------- ---- ----------------- +east us sharedeus +``` + +This command gets the default provider in "East US". + +### Example 2: List default providers +```powershell +Get-AzAttestationDefaultProvider +``` + +```output +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Value : {{ + "id": "/providers/Microsoft.Attestation/attestationProviders/sharedeus2", + "name": "sharedeus2", + "type": "Microsoft.Attestation/attestationProviders", + "location": "East US 2", + "properties": { + "trustModel": "AAD", + "status": "Ready", + "attestUri": "https://sharedeus2.eus2.attest.azure.net" + } + }, { + "id": "/providers/Microsoft.Attestation/attestationProviders/sharedcus", + "name": "sharedcus", + "type": "Microsoft.Attestation/attestationProviders", + "location": "Central US", + "properties": { + "trustModel": "AAD", + "status": "Ready", + "attestUri": "https://sharedcus.cus.attest.azure.net" + } + }, { + "id": "/providers/Microsoft.Attestation/attestationProviders/shareduks", + "name": "shareduks", + "type": "Microsoft.Attestation/attestationProviders", + "location": "UK South", + "properties": { + "trustModel": "AAD", + "status": "Ready", + "attestUri": "https://shareduks.uks.attest.azure.net" + } + }, { + "id": "/providers/Microsoft.Attestation/attestationProviders/sharedeus", + "name": "sharedeus", + "type": "Microsoft.Attestation/attestationProviders", + "location": "east us", + "properties": { + "trustModel": "AAD", + "status": "Ready", + "attestUri": "https://sharedeus.eus.attest.azure.net" + } + }…} +``` + +This commands lists default providers. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.IAttestationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the default provider. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.IAttestationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.Api20201001.IAttestationProvider + +### Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.Api20201001.IAttestationProviderListResult + +## 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 + - `[Location ]`: The location of the default provider. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection associated with the Azure resource + - `[ProviderName ]`: Name of the attestation provider. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Attestation/Get-AzAttestationPolicy.md b/azps-10.1.0/Az.Attestation/Get-AzAttestationPolicy.md new file mode 100644 index 0000000000..4610652f37 --- /dev/null +++ b/azps-10.1.0/Az.Attestation/Get-AzAttestationPolicy.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Attestation.dll-Help.xml +Module Name: Az.Attestation +online version: https://learn.microsoft.com/powershell/module/az.attestation/get-azattestationpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Get-AzAttestationPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Get-AzAttestationPolicy.md +--- + +# Get-AzAttestationPolicy + +## SYNOPSIS +Gets the policy from a tenant in Azure Attestation. + +## SYNTAX + +### NameParameterSet +``` +Get-AzAttestationPolicy [-Name] [-ResourceGroupName] -Tee + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ResourceIdParameterSet +``` +Get-AzAttestationPolicy [-ResourceId] -Tee [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### DefaultProviderParameterSet +``` +Get-AzAttestationPolicy [-Location] [-DefaultProvider] -Tee + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Get-AzAttestationPolicy cmdlet gets the policy from a tenant in Azure Attestation. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAttestationPolicy -Name pshtest -ResourceGroupName psh-test-rg -Tee SgxEnclave +``` + +```output +Text : version= 1.0; + authorizationrules{ + c:[type=="$is-debuggable"] => permit(); + }; + issuancerules{ + c:[type=="$is-debuggable"] => issue(type="is-debuggable", value=c.value); + c:[type=="$sgx-mrsigner"] => issue(type="sgx-mrsigner", value=c.value); + c:[type=="$sgx-mrenclave"] => issue(type="sgx-mrenclave", value=c.value); + c:[type=="$product-id"] => issue(type="product-id", value=c.value); + c:[type=="$svn"] => issue(type="svn", value=c.value); + c:[type=="$tee"] => issue(type="tee", value=c.value); + c:[type=="$tee-future"] => issue(type="tee-future", value=c.value); + }; + +TextLength : 604 +Jwt : eyJhbGciOiJub25lIn0.eyJBdHRlc3RhdGlvblBvbGljeSI6ICJkbVZ5YzJsdmJqMGdNUzR3T3cwS1lYVjBhRzl5YVhwaGRHbHZibkoxYkdWemV3MEtJQ0FnSUdNNlczUjVjR1U5UFNJa2FYTXRaR1ZpZFdkbllXSnNaU0pkSUQwLUlIQmxjbTFwZENncE93MEtmVHNOQ21semMzVmhibU5sY25Wc1pYTjdEUW9nSUNBZ1l6cGJkSGx3WlQwOUlpUnBjeTFrWldKMVoyZGhZbXhsSWwwZ1BUNGdhWE56ZFdVb2RIbHdaVDBpYVhNdFpHVmlkV2RuWVdKc1pTSXNJSFpoYkhWbFBXTXVkbUZzZFdVcE93MEtJQ0FnSUdNNlczUjVjR1U5UFNJa2MyZDRMVzF5YzJsbmJtVnlJbDBnUFQ0Z2FYTnpkV1VvZEhsd1pUMGljMmQ0TFcxeWMybG5ibVZ5SWl3Z2RtRnNkV1U5WXk1MllXeDFaU2s3RFFvZ0lDQWdZenBiZEhsd1pUMDlJaVJ6WjNndGJYSmxibU5zWVhabElsMGdQVDRnYVhOemRXVW9kSGx3WlQwaWMyZDRMVzF5Wlc1amJHRjJaU0lzSUhaaGJIVmxQV011ZG1Gc2RXVXBPdzBLSUNBZ0lHTTZXM1I1Y0dVOVBTSWtjSEp2WkhWamRDMXBaQ0pkSUQwLUlHbHpjM1ZsS0hSNWNHVTlJbkJ5YjJSMVkzUXRhV1FpTENCMllXeDFaVDFqTG5aaGJIVmxLVHNOQ2lBZ0lDQmpPbHQwZVhCbFBUMGlKSE4yYmlKZElEMC1JR2x6YzNWbEtIUjVjR1U5SW5OMmJpSXNJSFpoYkhWbFBXTXVkbUZzZFdVcE93MEtJQ0FnSUdNNlczUjVjR1U5UFNJa2RHVmxJbDBnUFQ0Z2FYTnpkV1VvZEhsd1pUMGlkR1ZsSWl3Z2RtRnNkV1U5WXk1MllXeDFaU2s3RFFvZ0lDQWdZenBiZEhsd1pUMDlJaVIwWldVdFpuVjBkWEpsSWwwZ1BUNGdhWE56ZFdVb2RIbHdaVDBpZEdWbExXWjFkSFZ5WlNJc0lIWmhiSFZsUFdNdWRtRnNkV1VwT3cwS2ZUc05DZyJ9. +JwtLength : 1129 +Algorithm : none +``` + +Gets the policy for Attestation Provider *pshtest* for Tee type *SgxEnclave*. + +### Example 2 +```powershell +Get-AzAttestationPolicy -DefaultProvider -Location "UK South" -Tee SgxEnclave +``` + +```output +Text : version= 1.0;authorizationrules{c:[type=="$is-debuggable"] => permit();};issuancerules{c:[type=="$is-debuggable"] => issue(type="is-debuggable", + value=c.value);c:[type=="$sgx-mrsigner"] => issue(type="sgx-mrsigner", value=c.value);c:[type=="$sgx-mrenclave"] => issue(type="sgx-mrenclave", + value=c.value);c:[type=="$product-id"] => issue(type="product-id", value=c.value);c:[type=="$svn"] => issue(type="svn", value=c.value);c:[type=="$tee"] + => issue(type="tee", value=c.value);}; +TextLength : 479 +Jwt : eyJhbGciOiJub25lIn0.eyJBdHRlc3RhdGlvblBvbGljeSI6ICJkbVZ5YzJsdmJqMGdNUzR3TzJGMWRHaHZjbWw2WVhScGIyNXlkV3hsYzN0ak9sdDBlWEJsUFQwaUpHbHpMV1JsWW5WbloyRmliR1Vp + WFNBOVBpQndaWEp0YVhRb0tUdDlPMmx6YzNWaGJtTmxjblZzWlhON1l6cGJkSGx3WlQwOUlpUnBjeTFrWldKMVoyZGhZbXhsSWwwZ1BUNGdhWE56ZFdVb2RIbHdaVDBpYVhNdFpHVmlkV2RuWVdKc1pT + SXNJSFpoYkhWbFBXTXVkbUZzZFdVcE8yTTZXM1I1Y0dVOVBTSWtjMmQ0TFcxeWMybG5ibVZ5SWwwZ1BUNGdhWE56ZFdVb2RIbHdaVDBpYzJkNExXMXljMmxuYm1WeUlpd2dkbUZzZFdVOVl5NTJZV3gx + WlNrN1l6cGJkSGx3WlQwOUlpUnpaM2d0YlhKbGJtTnNZWFpsSWwwZ1BUNGdhWE56ZFdVb2RIbHdaVDBpYzJkNExXMXlaVzVqYkdGMlpTSXNJSFpoYkhWbFBXTXVkbUZzZFdVcE8yTTZXM1I1Y0dVOVBT + SWtjSEp2WkhWamRDMXBaQ0pkSUQwLUlHbHpjM1ZsS0hSNWNHVTlJbkJ5YjJSMVkzUXRhV1FpTENCMllXeDFaVDFqTG5aaGJIVmxLVHRqT2x0MGVYQmxQVDBpSkhOMmJpSmRJRDAtSUdsemMzVmxLSFI1 + Y0dVOUluTjJiaUlzSUhaaGJIVmxQV011ZG1Gc2RXVXBPMk02VzNSNWNHVTlQU0lrZEdWbElsMGdQVDRnYVhOemRXVW9kSGx3WlQwaWRHVmxJaXdnZG1Gc2RXVTlZeTUyWVd4MVpTazdmVHMifQ. +JwtLength : 907 +Algorithm : none +``` + +Gets the policy for Attestation Default Provider from Location *UK South* for Tee type *SgxEnclave*. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProvider +Specifies this is the request to a default attestation provider. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultProviderParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the Location of the default attestation provider. + +```yaml +Type: System.String +Parameter Sets: DefaultProviderParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name of the tenant. +This cmdlet gets the attestation policy for the tenant that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the ResourceID of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tee +Specifies a type of Trusted Execution Environment. +We support four types of environment: SgxEnclave, OpenEnclave, CyResComponent and VBSEnclave. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Attestation.Models.PSPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Attestation/Get-AzAttestationPolicySigners.md b/azps-10.1.0/Az.Attestation/Get-AzAttestationPolicySigners.md new file mode 100644 index 0000000000..657815c3e2 --- /dev/null +++ b/azps-10.1.0/Az.Attestation/Get-AzAttestationPolicySigners.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Attestation.dll-Help.xml +Module Name: Az.Attestation +online version: https://learn.microsoft.com/powershell/module/az.attestation/get-azattestationpolicysigners +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Get-AzAttestationPolicySigners.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Get-AzAttestationPolicySigners.md +--- + +# Get-AzAttestationPolicySigners + +## SYNOPSIS +Gets the trusted policy signers from a tenant in Azure Attestation. + +## SYNTAX + +### NameParameterSet +``` +Get-AzAttestationPolicySigners [-Name] [-ResourceGroupName] + [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzAttestationPolicySigners [-ResourceId] [-DefaultProfile ] + [] +``` + +### DefaultProviderParameterSet +``` +Get-AzAttestationPolicySigners [-Location] [-DefaultProvider] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzAttestationPolicySigners cmdlet gets the trusted policy signers from a tenant in Azure Attestation. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAttestationPolicySigners -Name pshtest -ResourceGroupName psh-test-rg +``` + +```output +CertificateCount : 0 +Jwt : eyJhbGciOiAiUlMyNTYiLCAiamt1IjogImh0dHBzOi8vcHNodGVzdC51cy5hdHRlc3QuYXp1cmUubmV0L2NlcnRzIiwgImtpZCI6ICJrdlB4aUJlemk4RGJsQVY0WE5nNG5wVjlocE5WTnRqS0NQTlZZUjRuRVJzPSIsICJ0eXAiOiAiSldUIn0.eyJhYXMtcG9saWN5Q2VydGlmaWNhdGVzIjogeyJrZXlzIjogW119LCAiZXhwIjogMTU4NDM5NDgxOSwgImlhdCI6IDE1ODQzOTEyMTksICJpc3MiOiAiaHR0cHM6Ly9wc2h0ZXN0LnVzLmF0dGVzdC5henVyZS5uZXQiLCAibmJmIjogMTU4NDM5MTIxOX0.hXDejUE2Tfbnvy0RN4ONyxtg2NTEmHKz7wOJIY2YhF43MUJQYgh7TREE3BAMl93mQIO9px2HNvo_MSzNhDRmCMvZt6tUdC8Gw1xK40w2nqngvfmTONOcKskSXUVc1Igk2C47cuCQjB1W8t2qdCrwpR4UTEGdidyGlb7NFkAaFMOK119H1c0DQ7LSpY0bqodrVDW1DNa0LOFLxL3DwxqkRF-itk +duZJn9aqlkrgIPPSE_kdNUUURjpx3F6eCEONsdtu8zfj76v7Yb6Oyf70rh8EOyVdEu2wwmfg9ASZnooANwo7C6o68ESpfvi6DHPTyBsD0rgysVsNYtkS0tuXNj3A +Algorithm : RS256 +JKU : https://pshtest.us.attest.azure.net/certs +Certificates : {} +``` + +Gets the trusted policy signers for the Attestation Provider *pshtest* in Resource Group *psh-test-rg*. Note that there are no trusted signers for this Attestation Provider. + +### Example 2 +```powershell +Get-AzAttestationPolicySigners -Name pshtest2 -ResourceGroupName psh-test-rg +``` + +```output +CertificateCount : 1 +Jwt : eyJhbGciOiAiUlMyNTYiLCAiamt1IjogImh0dHBzOi8vcHNodGVzdDIudXMuYXR0ZXN0LmF6dXJlLm5ldC9jZXJ0cyIsICJraWQiOiAiL09KMXJ0U0hkbFJnR1VqMGVuTEl5bDhLeHQ3NHZYdmJLTW9VbmFZMlNJRT0iLCAidHlwIjogIkpXVCJ9.eyJhYXMtcG9saWN5Q2VydGlmaWNhdGVzIjogeyJrZXlzIjogW3siYWxnIjogIlJTMjU2IiwgImt0eSI6ICJSU0EiLCAidXNlIjogInNpZyIsICJ4NWMiOiBbIk1JSURMRENDQWhTZ0F3SUJBZ0lJYStGTE1oT1ZkMFF3RFFZSktvWklodmNOQVFFTEJRQXdGekVWTUJNR0ExVUVBd3dNVFdGaFZHVnpkRU5sY25ReE1DQVhEVEl3TURNd016QXdNREF3TUZvWUR6SXdOekF3TXpBek1EQXdNREF3V2pBWE1SVXdFd1lEVlFRRERBeE5ZV0ZVWlhOMFEyVnlkREV3Z2dFaU1BMEdDU3FHU0liM0RRRUJBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRQ3BidzRLeHJhME05OE9RNUMzQkk3Uk9BS2k4dnlRNTF5eWJoUi9saTJDd1Y4WkVJZmVZSEJMMFM5UC9naVQ2VTlZRkNtNEw3c2hGTm5kYTBJcG5zeTZSaFhCUnRYampZdVR1SlcxTk01SVh0OVFJMEtkUUNQbG5VVlNnb2UzdW9pQ0l6S25HU1Nka0MrU25nblVveDFsVnVRNEpLSmtLUXBubTFCekgzTGNzUEFnQUJwYTloVnlieG9XUHU4c2tEek1TSVFZVzMxemVYVkxZdlprZmxoTWttNFZLby9DUWpYNXJWTFNXeVZWa1YrOUhDQjlVQk1HMExiNmhldWZTQTVKTE5mR2taY0kwNHBHRmFqVzZnVUJkcmJnM2R4V0s5VzdKUVZYT05maEJ6NkE2bWM1a0wxRUtLNWhIc2dnekdYeEdLWmhwWU5JSDNiek52eTNrUUFQQWdNQkFBR2plakI0TUVZR0ExVWRJd1EvTUQyQUZIWnBTaFI4UUlRMGFzZy9Yb1NwR2hNOURGN25vUnVrR1RBWE1SVXdFd1lEVlFRRERBeE5ZV0ZVWlhOMFEyVnlkREdDQ0d2aFN6SVRsWGRFTUIwR0ExVWREZ1FXQkJSMmFVb1VmRUNFTkdySVAxNkVxUm9UUFF4ZTV6QVBCZ05WSFJNQkFmOEVCVEFEQVFIL01BMEdDU3FHU0liM0RRRUJDd1VBQTRJQkFRQVFpWXpFeUtVbDlkSWVUVGZnTVpBWEo0V0NFZXpFN2FRcHd2QnU5Rkk0MXN4L1pzbEV2RVFvTDVWNTZTQVhQZCtTOWdlZnVJNjFuZ056OTl5RTlrZGgrOWxmVTJVTU1tdXFCdVFWaWI5RzBKakllYVNHM1J2OGVyRXNGMUUrbXhjbzRtVGVEdUdLUklmN1dHNnNYZjZ5b2N1U0FVaEV2emM5NzZTSUNJLzQxclZEVkg5bnFJdS9LUnZleHpWcFJqZ1EzWlVnMTMydmVnb2djNjc1UndreTJHckxrZDBJN015bGcwZVIyamd1ZndLcTVBbnZ1YTlzRFJyUUpLUCtqclpmcWpiOEpoZ2VsUEtLVXl4S1JIS1Z6QUxzQ3JHTkRQS0ozVDlsWUhmZmFuWE9JeEpnTDExcDNBMmVMUWtWN3BMdEpUenhrb1lDZFZKdTNmbDZJNWVsIl19XX0sICJleHAiOiAxNTg0Mzk1MTE5LCAiaWF0IjogMTU4NDM5MTUxOSwgImlzcyI6ICJodHRwczovL3BzaHRlc3QyLnVzLmF0dGVzdC5henVyZS5uZXQiLCAibmJmIjogMTU4NDM5MTUxOX0Irkd3eNG7jD-fJThxBKURjjSlsfbRgOnOvN_nI8ukH-VvpaYIKGgk74iuefWhPYQJr--mAUT2IaEqcBGXvRV6K4oDUXUHn7iCNL1aIWzQ4udTrFVChNTUjEH4x1tmyDLC04SBeoi_yP5R0Bfijb51qnKwSU6ppuKTTletpzFztib2MN_RUQidHjuaeivMECJPRu5Bit2DbLRObokMRRY-rftcxPf7rLr1mK_4WUbRjIKT_ic03qWcqY0lakwC3MdFV9xQsvCH7-sizgJShSIOIS9pHrRp6YIEyG8LoF6Kj9aL-imNTUZ2IjwxtDJOmnhXh56pYjzQNpW_bzQlOeNaA +Algorithm : RS256 +JKU : https://pshtest2.us.attest.azure.net/certs +Certificates : {{ + "alg": "RS256", + "kty": "RSA", + "use": "sig", + "x5c": ["MIIDLDCCAhSgAwIBAgIIa+FLMhOVd0QwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAwwMTWFhVGVzdENlcnQxMCAXDTIwMDMwMzAwMDAwMFoYDzIwNzAwMzAzMDAwMDAwWjAXMRUwEwYDVQQDDAxNYWFUZXN0Q2VydDEwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCpbw4Kxra0M98OQ5C3BI7ROAKi8vyQ51yybhR/li2CwV8ZEIfeYHBL0S9P/giT6U9YFCm4L7shFNnda0Ipnsy6RhXBRtXjjYuTuJW1NM5IXt9QI0KdQCPlnUVSgoe3uoiCIzKnGSSdkC+SngnUox1lVuQ4JKJkKQpnm1BzH3LcsPAgABpa9hVybxoWPu8skDzMSIQYW31zeXVLYvZkflhMkm4VKo/CQjX5rVLSWyVVkV+9HCB9UBMG0Lb6heufSA5JLNfGkZcI04pGFajW6gUBdrbg3dxWK9W7JQVXONfhBz6A6mc5kL1EKK5hHsggzGXxGKZhpYNIH3bzNvy3kQAPAgMBAAGjejB4MEYGA1UdIwQ/MD2AFHZpShR8QIQ0asg/XoSpGhM9DF7noRukGTAXMRUwEwYDVQQDDAxNYWFUZXN0Q2VydDGCCGvhSzITlXdEMB0GA1UdDgQWBBR2aUoUfECENGrIP16EqRoTPQxe5zAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQAQiYzEyKUl9dIeTTfgMZAXJ4WCEezE7aQpwvBu9FI41sx/ZslEvEQoL5V56SAXPd+S9gefuI61ngNz99yE9kdh+9lfU2UMMmuqBuQVib9G0JjIeaSG3Rv8erEsF1E+mxco4mTeDuGKRIf7WG6sXf6yocuSAUhEvzc976SICI/41rVDVH9nqIu/KRvexzVpRjgQ3ZUg132vegogc675Rwky2GrLkd0I7Mylg0eR2jgufwKq5Anvua9sDRrQJKP+jrZfqjb8JhgelPKKUyxKRHKVzALsCrGNDPKJ3T9lYHffanXOIxJgL11p3A2eLQkV7pLtJTzxkoYCdVJu3fl6I5el"] + }} +``` + +Gets the trusted policy signers for the Attestation Provider *pshtest2* in Resource Group *psh-test-rg*. Note that there is one trusted signer for this Attestation Provider. + +### Example 3 +```powershell +Get-AzAttestationPolicySigners -DefaultProvider -Location "Central US" +``` + +```output +CertificateCount : 0 +Jwt : eyJhbGciOiAiUlMyNTYiLCAiamt1IjogImh0dHBzOi8vc2hhcmVkZXVzLmV1cy50ZXN0LmF0dGVzdC5henVyZS5uZXQvY2VydHMi + LCAia2lkIjogIlhodGZtZlR0bS9MNnhUUkU2RGoxc3BTVkpSRnAwcXdyTjNRem9RWHJwR0E9IiwgInR5cCI6ICJKV1QifQ.eyJhY + XMtcG9saWN5Q2VydGlmaWNhdGVzIjogeyJrZXlzIjogW119LCAiZXhwIjogMTU5Mzc1ODEyOCwgImlhdCI6IDE1OTM3NTQ1MjgsI + CJpc3MiOiAiaHR0cHM6Ly9zaGFyZWRldXMuZXVzLnRlc3QuYXR0ZXN0LmF6dXJlLm5ldCIsICJtYWEtcG9saWN5Q2VydGlmaWNhd + GVzIjogeyJrZXlzIjogW119LCAibmJmIjogMTU5Mzc1NDUyOH0.C1FPzJVuAQQszL1s-5FpiZf4YDF7VD6cYnoy0S9QFAQYlJOy- + PX00GT_uCnOHKzPvhwQ-doiQCkEhIRpA6coK9gEU4k_R4KK5kmtWZEpzDGo2M-8ScIsVQlN0-nITfMk4kf4nRZgiqWSr_X7nuWCD + 7Ddhj0OrKWK_6Cz6WlktGrjdhozU0-HNNTy6DKWcLB3cubPY9j6L9Uyvu4uO5m1QjN_Cn4G_6Zq21aM89kOcUzDgpHYralrNXkKH + 3XBRKfGcQqatJky8Tq3s5Kd-0TRokOsekH681fMTFv_K2R6ORxOPoh7h-dX7LysmSGqmX_7GqhAgTGGXBaGekO6BNRe1A +Algorithm : RS256 +JKU : https://sharedcus.cus.attest.azure.net/certs +Certificates : {} +``` + +Gets the trusted policy signers for the Attestation Default Provider in Location *Central US*. Note that there are no trusted signers for Attestation Default Provider. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProvider +Specifies this is the request to a default attestation provider. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultProviderParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the Location of the default attestation provider. + +```yaml +Type: System.String +Parameter Sets: DefaultProviderParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the ResourceID of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Attestation.Models.PSPolicySigners + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Attestation/Get-AzAttestationProvider.md b/azps-10.1.0/Az.Attestation/Get-AzAttestationProvider.md new file mode 100644 index 0000000000..a64134c881 --- /dev/null +++ b/azps-10.1.0/Az.Attestation/Get-AzAttestationProvider.md @@ -0,0 +1,291 @@ +--- +external help file: Az.Attestation-help.xml +Module Name: Az.Attestation +online version: https://learn.microsoft.com/powershell/module/az.attestation/get-azattestationprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Get-AzAttestationProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Get-AzAttestationProvider.md +--- + +# Get-AzAttestationProvider + +## SYNOPSIS +Get the status of Attestation Provider. + +## SYNTAX + +### List (Default) +``` +Get-AzAttestationProvider [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAttestationProvider -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzAttestationProvider -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzAttestationProvider -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get the status of Attestation Provider. + +## EXAMPLES + +### Example 1: Get the status of a specific Attestation Provider +```powershell +Get-AzAttestationProvider -Name testprovider1 -ResourceGroupName test-rg | fl +``` + +```output +AttestUri : https://testprovider1.eus.attest.azure.net +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/testprovider1 +Location : eastus +Name : testprovider1 +PrivateEndpointConnection : +ResourceGroupName : test-rg +Status : Ready +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : { + } +TrustModel : AAD +Type : Microsoft.Attestation/attestationProviders +``` + +This command gets the status of a specific Attestation Provider named `testprovider1`. + +### Example 2: List statuses of all Attestation Providers in current subscription +```powershell +Get-AzAttestationProvider +``` + +```output +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Value : {{ + "id": "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/test", + "name": "test", + "type": "Microsoft.Attestation/attestationProviders", + "tags": { + "Test": "true", + "CreationYear": "2020" + }, + "location": "East US", + "properties": { + "trustModel": "Isolated", + "status": "Ready", + "attestUri": "https://test.eus.attest.azure.net" + } + }, { + "id": "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/testprovider1", + "name": "testprovider1", + "type": "Microsoft.Attestation/attestationProviders", + "tags": { + "Test": "true", + "CreationYear": "2020" + }, + "location": "East US", + "properties": { + "trustModel": "Isolated", + "status": "Ready", + "attestUri": "https://testprovider1.eus.attest.azure.net" + } + },{ + "id": "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/test-rg/providers/Microsoft.Att + estation/attestationProviders/testprovider2", + "name": "testprovider2", + "type": "Microsoft.Attestation/attestationProviders", + "location": "eastus", + "properties": { + "trustModel": "AAD", + "status": "Ready", + "attestUri": "https://testprovider2.eus.attest.azure.net" + } + }} +``` + +This command lists statuses of all Attestation Providers in current subscription. + +### Example 2: List statuses of all Attestation Providers in a resource group +```powershell +Get-AzAttestationProvider -ResourceGroupName test-rg +``` + +```output +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Value : {{ + "id": "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/test", + "name": "test", + "type": "Microsoft.Attestation/attestationProviders", + "tags": { + "Test": "true", + "CreationYear": "2020" + }, + "location": "East US", + "properties": { + "trustModel": "Isolated", + "status": "Ready", + "attestUri": "https://test.eus.attest.azure.net" + } + }, { + "id": "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/testprovider1", + "name": "testprovider1", + "type": "Microsoft.Attestation/attestationProviders", + "tags": { + "Test": "true", + "CreationYear": "2020" + }, + "location": "East US", + "properties": { + "trustModel": "Isolated", + "status": "Ready", + "attestUri": "https://testprovider1.eus.attest.azure.net" + } + },{ + "id": "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/testprovider2", + "name": "testprovider2", + "type": "Microsoft.Attestation/attestationProviders", + "location": "eastus", + "properties": { + "trustModel": "AAD", + "status": "Ready", + "attestUri": "https://testprovider2.eus.attest.azure.net" + } + }} +``` + +This command lists statuses of all Attestation Providers in a resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.IAttestationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the attestation provider. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ProviderName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: List, Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.IAttestationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.Api20201001.IAttestationProvider + +### Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.Api20201001.IAttestationProviderListResult + +## 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 + - `[Location ]`: The location of the default provider. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection associated with the Azure resource + - `[ProviderName ]`: Name of the attestation provider. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Attestation/New-AzAttestationProvider.md b/azps-10.1.0/Az.Attestation/New-AzAttestationProvider.md new file mode 100644 index 0000000000..87a9ebad82 --- /dev/null +++ b/azps-10.1.0/Az.Attestation/New-AzAttestationProvider.md @@ -0,0 +1,209 @@ +--- +external help file: Az.Attestation-help.xml +Module Name: Az.Attestation +online version: https://learn.microsoft.com/powershell/module/az.attestation/new-azattestationprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/New-AzAttestationProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/New-AzAttestationProvider.md +--- + +# New-AzAttestationProvider + +## SYNOPSIS +Creates a new Attestation Provider. + +## SYNTAX + +``` +New-AzAttestationProvider -Name -ResourceGroupName [-SubscriptionId ] + -Location [-PolicySigningCertificateKeyPath ] [-Tag ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates a new Attestation Provider. + +## EXAMPLES + +### Example 1: Create a new Attestation Provider +```powershell +New-AzAttestationProvider -Name testprovider1 -ResourceGroupName test-rg -Location "eastus" +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus testprovider1 test-rg +``` + +This command creates a new Attestation Provider named `testprovider1` in resource group `test-rg`. + +### Example 2: Create a new Attestation Provider with trusted signing keys +```powershell +New-AzAttestationProvider -Name testprovider2 -ResourceGroupName test-rg -Location "eastus" -PolicySigningCertificateKeyPath .\cert1.pem +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus testprovider2 test-rg +``` + +This command creates a new Attestation Provider named `testprovider2` with trusted signing keys in resource group `test-rg`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The supported Azure location where the attestation provider should be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the attestation provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ProviderName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicySigningCertificateKeyPath +Specifies the set of trusted signing keys for issuance policy in a single certificate file. +The value of the "keys" parameter is an array of JWK values. +Bydefault, the order of the JWK values within the array does not implyan order of preference among them, although applications of JWK Setscan choose to assign a meaning to the order for their purposes, ifdesired. +To construct, see NOTES section for POLICYSIGNINGCERTIFICATEKEY properties and create a hash table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags that will be assigned to the attestation provider. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.Api20201001.IAttestationProvider + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Attestation/Remove-AzAttestationPolicySigner.md b/azps-10.1.0/Az.Attestation/Remove-AzAttestationPolicySigner.md new file mode 100644 index 0000000000..801fba893c --- /dev/null +++ b/azps-10.1.0/Az.Attestation/Remove-AzAttestationPolicySigner.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Attestation.dll-Help.xml +Module Name: Az.Attestation +online version: https://learn.microsoft.com/powershell/module/az.attestation/remove-azattestationpolicysigner +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Remove-AzAttestationPolicySigner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Remove-AzAttestationPolicySigner.md +--- + +# Remove-AzAttestationPolicySigner + +## SYNOPSIS +Removes a trusted policy signer for a tenant in Azure Attestation. + +## SYNTAX + +### NameParameterSet +``` +Remove-AzAttestationPolicySigner [-Name] [-ResourceGroupName] -Signer + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ResourceIdParameterSet +``` +Remove-AzAttestationPolicySigner [-ResourceId] -Signer + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Remove-AzAttestationPolicySigner cmdlet removes a trusted policy signer for a tenant in Azure Attestation. + +## EXAMPLES + +### Example 1 +```powershell +$trustedSigner = Get-Content -Path .\trusted.signer.txt +Remove-AzAttestationPolicySigner -Name pshtest -ResourceGroupName psh-test-rg -Signer $trustedSigner +``` + +Remove a trusted signer for the Attestation Provider named *pshtest*. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the ResourceID of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Signer +Specifies the RFC7519 JSON Web Token containing a claim named "maa-policyCertificate" whose value is an RFC7517 JSON Web Key which contains a trusted signing key to remove. +The RFC7519 JWT must be signed with one of the existing trusted signing keys. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Attestation.Models.PSPolicySigners + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Attestation/Remove-AzAttestationProvider.md b/azps-10.1.0/Az.Attestation/Remove-AzAttestationProvider.md new file mode 100644 index 0000000000..ca54cb05be --- /dev/null +++ b/azps-10.1.0/Az.Attestation/Remove-AzAttestationProvider.md @@ -0,0 +1,209 @@ +--- +external help file: Az.Attestation-help.xml +Module Name: Az.Attestation +online version: https://learn.microsoft.com/powershell/module/az.attestation/remove-azattestationprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Remove-AzAttestationProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Remove-AzAttestationProvider.md +--- + +# Remove-AzAttestationProvider + +## SYNOPSIS +Delete Attestation Service. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAttestationProvider -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAttestationProvider -InputObject [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete Attestation Service. + +## EXAMPLES + +### Example 1: Remove a specific Attestation Provider. +```powershell +Remove-AzAttestationProvider -Name testprovider -ResourceGroupName test-rg -PassThru +``` + +```output +True +``` + +This command removes a specific Attestation Provider. + +### Example 2: Remove a specific Attestation Provider by piping +```powershell +Get-AzAttestationProvider -Name testprovider -ResourceGroupName test-rg | Remove-AzAttestationProvider -PassThru +``` + +```output +True +``` + +These commands remove a specific Attestation Provider by piping. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.IAttestationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the attestation service + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ProviderName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.IAttestationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[Id ]`: Resource identity path + - `[Location ]`: The location of the default provider. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection associated with the Azure resource + - `[ProviderName ]`: Name of the attestation provider. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Attestation/Reset-AzAttestationPolicy.md b/azps-10.1.0/Az.Attestation/Reset-AzAttestationPolicy.md new file mode 100644 index 0000000000..b2384cec13 --- /dev/null +++ b/azps-10.1.0/Az.Attestation/Reset-AzAttestationPolicy.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Attestation.dll-Help.xml +Module Name: Az.Attestation +online version: https://learn.microsoft.com/powershell/module/az.attestation/reset-azattestationpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Reset-AzAttestationPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Reset-AzAttestationPolicy.md +--- + +# Reset-AzAttestationPolicy + +## SYNOPSIS +Resets the policy from a tenant in Azure Attestationn.} + +## SYNTAX + +### NameParameterSet +``` +Reset-AzAttestationPolicy [-Name] [-ResourceGroupName] -Tee [-Policy ] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ResourceIdParameterSet +``` +Reset-AzAttestationPolicy [-ResourceId] -Tee [-Policy ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Reset-AzAttestationPolicy cmdlet resets the user defined attestation policy from a tenant in Azure Attestation. + +## EXAMPLES + +### Example 1 +```powershell +Reset-AzAttestationPolicy -Name pshtest -ResourceGroupName psh-test-rg -Tee SgxEnclave +``` + +Reset the policy to the default for the Attestation Provider *pshtest* for Tee type *SgxEnclave*. + +### Example 2 +```powershell +$resetJwt = Get-Content -Path .\reset.policy.txt.signed.txt +Reset-AzAttestationPolicy -Name pshtest -ResourceGroupName psh-test-rg -Tee SgxEnclave -Policy $resetJwt +``` + +If the Attestation Provider *pshtest* is configured to use the isolated trust model, reset the policy to the default for Tee type *SgxEnclave* by including a signed policy. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name of the tenant. +This cmdlet resets the attestation policy for the tenant that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the JSON Web Token describing the policy document to reset. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the ResourceID of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tee +Specifies a type of Trusted Execution Environment. +We support four types of environment: SgxEnclave, OpenEnclave, CyResComponent and VBSEnclave. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Attestation/Set-AzAttestationPolicy.md b/azps-10.1.0/Az.Attestation/Set-AzAttestationPolicy.md new file mode 100644 index 0000000000..11436bd80b --- /dev/null +++ b/azps-10.1.0/Az.Attestation/Set-AzAttestationPolicy.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Attestation.dll-Help.xml +Module Name: Az.Attestation +online version: https://learn.microsoft.com/powershell/module/az.attestation/set-azattestationpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Set-AzAttestationPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Set-AzAttestationPolicy.md +--- + +# Set-AzAttestationPolicy + +## SYNOPSIS +Sets the policy from a tenant in Azure Attestationn. + +## SYNTAX + +### NameParameterSet +``` +Set-AzAttestationPolicy [-Name] [-ResourceGroupName] -Tee -Policy + [-PolicyFormat ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### ResourceIdParameterSet +``` +Set-AzAttestationPolicy [-ResourceId] -Tee -Policy [-PolicyFormat ] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Set-AzAttestationPolicy cmdlet sets the policy from a tenant in Azure Attestation. + +## EXAMPLES + +### Example 1 +```powershell +$policy = Get-Content -Path .\custom.sgx.policy.txt +Set-AzAttestationPolicy -Name pshtest -ResourceGroupName psh-test-rg -Tee SgxEnclave -Policy $policy +``` + +Sets the user defined policy for TEE type *SgxEnclave* for Attestation Provider *pshtest* using a text policy format (default). + +### Example 2 +```powershell +$policyjwt = Get-Content -Path .\custom.sgx.policy.jwt.format.txt +Set-AzAttestationPolicy -Name pshtest -ResourceGroupName psh-test-rg -Tee SgxEnclave -Policy $policyjwt -PolicyFormat JWT +``` + +Sets the user defined policy for TEE type *SgxEnclave* for Attestation Provider *pshtest* using a JWT policy format. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name of the tenant. +This cmdlet sets the attestation policy for the tenant that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the policy document to set. The policy format can be either Text or JSON Web Token (JWT). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyFormat +Specifies the format for the policy, either Text or JWT (JSON Web Token). The default policy format is Text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the ResourceID of an attestation provider. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tee +Specifies a type of Trusted Execution Environment. +Four types of environment are supported: SgxEnclave, OpenEnclave, CyResComponent and VBSEnclave. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Attestation/Update-AzAttestationProvider.md b/azps-10.1.0/Az.Attestation/Update-AzAttestationProvider.md new file mode 100644 index 0000000000..899fc5506e --- /dev/null +++ b/azps-10.1.0/Az.Attestation/Update-AzAttestationProvider.md @@ -0,0 +1,245 @@ +--- +external help file: Az.Attestation-help.xml +Module Name: Az.Attestation +online version: https://learn.microsoft.com/powershell/module/az.attestation/update-azattestationprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Update-AzAttestationProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Attestation/Attestation/help/Update-AzAttestationProvider.md +--- + +# Update-AzAttestationProvider + +## SYNOPSIS +Updates the Attestation Provider. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAttestationProvider -Name -ResourceGroupName [-SubscriptionId ] + [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAttestationProvider -InputObject [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Updates the Attestation Provider. + +## EXAMPLES + +### Example 1: Update a specific Attestation Provider. +```powershell +Update-AzAttestationProvider -Name testprovider -ResourceGroupName test-rg -Tag @{"k"="v"} | fl +``` + +```output +AttestUri : https://testprovider.eus.attest.azure.net +Id : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/test-rg/providers/Microsoft.Attestation/ + attestationProviders/testprovider +Location : eastus +Name : testprovider +PrivateEndpointConnection : +ResourceGroupName : test-rg +Status : Ready +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : { + "k": "v" + } +TrustModel : AAD +Type : Microsoft.Attestation/attestationProviders +``` + +This command updates a specific Attestation Provider. + +### Example 2: Update a specific Attestation Provider by piping +```powershell +Get-AzAttestationProvider -Name testprovider -ResourceGroupName test-rg | Update-AzAttestationProvider -Tag @{"k"="v"} | fl +``` + +```output +AttestUri : https://testprovider.eus.attest.azure.net +Id : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/test-rg/providers/Microsoft.Attestation/ + attestationProviders/testprovider +Location : eastus +Name : testprovider +PrivateEndpointConnection : +ResourceGroupName : test-rg +Status : Ready +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : { + "k": "v" + } +TrustModel : AAD +Type : Microsoft.Attestation/attestationProviders +``` + +These commands update a specific Attestation Provider by piping. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.IAttestationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the attestation provider. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ProviderName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags that will be assigned to the attestation provider. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.IAttestationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.Api20201001.IAttestationProvider + +## 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 + - `[Location ]`: The location of the default provider. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection associated with the Azure resource + - `[ProviderName ]`: Name of the attestation provider. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automanage/Az.Automanage.md b/azps-10.1.0/Az.Automanage/Az.Automanage.md new file mode 100644 index 0000000000..a94a0b735b --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Az.Automanage.md @@ -0,0 +1,66 @@ +--- +Module Name: Az.Automanage +Module Guid: b573b797-567a-4f0d-8ba3-6a447bed6278 +Download Help Link: https://learn.microsoft.com/powershell/module/az.automanage +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Az.Automanage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Az.Automanage.md +--- + +# Az.Automanage Module +## Description +Microsoft Azure PowerShell: Automanage cmdlets + +## Az.Automanage Cmdlets +### [Get-AzAutomanageBestPractice](Get-AzAutomanageBestPractice.md) +Get information about a Automanage best practice + +### [Get-AzAutomanageConfigProfile](Get-AzAutomanageConfigProfile.md) +Get information about a configuration profile + +### [Get-AzAutomanageConfigProfileAssignment](Get-AzAutomanageConfigProfileAssignment.md) +Get information about a configuration profile assignment + +### [Get-AzAutomanageConfigProfileHciAssignment](Get-AzAutomanageConfigProfileHciAssignment.md) +Get information about a configuration profile assignment + +### [Get-AzAutomanageConfigProfileHcrpAssignment](Get-AzAutomanageConfigProfileHcrpAssignment.md) +Get information about a configuration profile assignment + +### [Get-AzAutomanageHciReport](Get-AzAutomanageHciReport.md) +Get information about a report associated with a configuration profile assignment run + +### [Get-AzAutomanageHcrpReport](Get-AzAutomanageHcrpReport.md) +Get information about a report associated with a configuration profile assignment run + +### [Get-AzAutomanageReport](Get-AzAutomanageReport.md) +Get information about a report associated with a configuration profile assignment run + +### [New-AzAutomanageConfigProfile](New-AzAutomanageConfigProfile.md) +Creates a configuration profile + +### [New-AzAutomanageConfigProfileAssignment](New-AzAutomanageConfigProfileAssignment.md) +Creates an association between a VM and Automanage configuration profile + +### [New-AzAutomanageConfigProfileHciAssignment](New-AzAutomanageConfigProfileHciAssignment.md) +Creates an association between a AzureStackHCI cluster and Automanage configuration profile + +### [New-AzAutomanageConfigProfileHcrpAssignment](New-AzAutomanageConfigProfileHcrpAssignment.md) +Creates an association between a ARC machine and Automanage configuration profile + +### [Remove-AzAutomanageConfigProfile](Remove-AzAutomanageConfigProfile.md) +Delete a configuration profile + +### [Remove-AzAutomanageConfigProfileAssignment](Remove-AzAutomanageConfigProfileAssignment.md) +Delete a configuration profile assignment + +### [Remove-AzAutomanageConfigProfileHciAssignment](Remove-AzAutomanageConfigProfileHciAssignment.md) +Delete a configuration profile assignment + +### [Remove-AzAutomanageConfigProfileHcrpAssignment](Remove-AzAutomanageConfigProfileHcrpAssignment.md) +Delete a configuration profile assignment + +### [Update-AzAutomanageConfigProfile](Update-AzAutomanageConfigProfile.md) +Updates a configuration profile + diff --git a/azps-10.1.0/Az.Automanage/Get-AzAutomanageBestPractice.md b/azps-10.1.0/Az.Automanage/Get-AzAutomanageBestPractice.md new file mode 100644 index 0000000000..3a751aaa8d --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Get-AzAutomanageBestPractice.md @@ -0,0 +1,105 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/get-azautomanagebestpractice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageBestPractice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageBestPractice.md +--- + +# Get-AzAutomanageBestPractice + +## SYNOPSIS +Get information about a Automanage best practice + +## SYNTAX + +### List (Default) +``` +Get-AzAutomanageBestPractice [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomanageBestPractice -Name [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get information about a Automanage best practice + +## EXAMPLES + +### Example 1: List all Automanage best practices under a subscription +```powershell +Get-AzAutomanageBestPractice +``` + +```output +Name +---- +AzureBestPracticesProduction +AzureBestPracticesDevTest +``` + +This commmand lists all Automanage best practices under a subscription. + +### Example 2: Get information about a Automanage best practice by name +```powershell +Get-AzAutomanageBestPractice -Name AzureBestPracticesProduction +``` + +```output +Name +---- +AzureBestPracticesProduction +``` + +This command gets information about a Automanage best practice by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Automanage best practice name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: BestPracticeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.Api20220504.IBestPractice + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/Get-AzAutomanageConfigProfile.md b/azps-10.1.0/Az.Automanage/Get-AzAutomanageConfigProfile.md new file mode 100644 index 0000000000..4da62be2c7 --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Get-AzAutomanageConfigProfile.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/get-azautomanageconfigprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageConfigProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageConfigProfile.md +--- + +# Get-AzAutomanageConfigProfile + +## SYNOPSIS +Get information about a configuration profile + +## SYNTAX + +### List1 (Default) +``` +Get-AzAutomanageConfigProfile [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomanageConfigProfile -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomanageConfigProfile -InputObject [-DefaultProfile ] + [] +``` + +### List +``` +Get-AzAutomanageConfigProfile -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get information about a configuration profile + +## EXAMPLES + +### Example 1: List all configuration profiles under a subscription +```powershell +Get-AzAutomanageConfigProfile +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus confpro-pwsh01 automangerg +eastus lucas-best-practices-devtest automangerg +``` + +This command lists all configuration profiles under a subscription. + +### Example 2: List all configuration profiles under a resource group +```powershell +Get-AzAutomanageConfigProfile -ResourceGroupName automangerg +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus confpro-pwsh01 automangerg +eastus lucas-best-practices-devtest automangerg +``` + +This command lists all configuration profiles under a resource group. + +### Example 3: Get information about a configuration profile by name +```powershell +Get-AzAutomanageConfigProfile -ResourceGroupName automangerg -Name lucas-best-practices-devtest +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus lucas-best-practices-devtest automangerg +``` + +This command gets information about a configuration profile by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The configuration profile name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ConfigurationProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.Api20220504.IConfigurationProfile + +## 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 + - `[BestPracticeName ]`: The Automanage best practice name. + - `[ClusterName ]`: The name of the Arc machine. + - `[ConfigurationProfileAssignmentName ]`: Name of the configuration profile assignment. Only default is supported. + - `[ConfigurationProfileName ]`: Name of the configuration profile. + - `[Id ]`: Resource identity path + - `[MachineName ]`: The name of the Arc machine. + - `[ReportName ]`: The report name. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VMName ]`: The name of the virtual machine. + - `[VersionName ]`: The Automanage best practice version name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/Get-AzAutomanageConfigProfileAssignment.md b/azps-10.1.0/Az.Automanage/Get-AzAutomanageConfigProfileAssignment.md new file mode 100644 index 0000000000..997c3f1999 --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Get-AzAutomanageConfigProfileAssignment.md @@ -0,0 +1,241 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/get-azautomanageconfigprofileassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageConfigProfileAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageConfigProfileAssignment.md +--- + +# Get-AzAutomanageConfigProfileAssignment + +## SYNOPSIS +Get information about a configuration profile assignment + +## SYNTAX + +### List2 (Default) +``` +Get-AzAutomanageConfigProfileAssignment [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzAutomanageConfigProfileAssignment -ResourceGroupName -VMName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomanageConfigProfileAssignment -InputObject [-DefaultProfile ] + [] +``` + +### List1 +``` +Get-AzAutomanageConfigProfileAssignment -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### List3 +``` +Get-AzAutomanageConfigProfileAssignment -MachineName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### List4 +``` +Get-AzAutomanageConfigProfileAssignment -ClusterName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get information about a configuration profile assignment + +## EXAMPLES + +### Example 1: List all configuration profile assignments under a subscription +```powershell +Get-AzAutomanageConfigProfileAssignment +``` + +```output +Name ResourceGroupName ManagedBy Status TargetId +---- ----------------- --------- ------ -------- +default automangerg Conformant /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/automangerg/providers/Microsoft.Compute/virtualMachines/aglinuxvm +default lnxtest Conformant /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lnxtest/providers/Microsoft.Compute/virtualMachines/advisortest2 +``` + +This command lists all configuration profile assignments under a subscription. + +### Example 2: List all configuration profile assignments under a resource group +```powershell +Get-AzAutomanageConfigProfileAssignment -ResourceGroupName automangerg +``` + +```output +Name ResourceGroupName ManagedBy Status TargetId +---- ----------------- --------- ------ -------- +default automangerg Conformant /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/automangerg/providers/Microsoft.Compute/virtualMachines/aglinuxvm +``` + +This command lists all configuration profile assignments under a resource group. + +### Example 3: Get information about a configuration profile assignment of the VM +```powershell +Get-AzAutomanageConfigProfileAssignment -ResourceGroupName automangerg -VMName aglinuxvm +``` + +```output +Name ResourceGroupName ManagedBy Status TargetId +---- ----------------- --------- ------ -------- +default automangerg Conformant /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/automangerg/providers/Microsoft.Compute/virtualMachines/aglinuxvm +``` + +This command gets information about a configuration profile assignment of the VM. + +## PARAMETERS + +### -ClusterName +The name of the Arc machine. + +```yaml +Type: System.String +Parameter Sets: List4 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MachineName +The name of the Arc machine. + +```yaml +Type: System.String +Parameter Sets: List3 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1, List3, List4 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List1, List2, List3, List4 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName +The name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.Api20220504.IConfigurationProfileAssignment + +## 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 + - `[BestPracticeName ]`: The Automanage best practice name. + - `[ClusterName ]`: The name of the Arc machine. + - `[ConfigurationProfileAssignmentName ]`: Name of the configuration profile assignment. Only default is supported. + - `[ConfigurationProfileName ]`: Name of the configuration profile. + - `[Id ]`: Resource identity path + - `[MachineName ]`: The name of the Arc machine. + - `[ReportName ]`: The report name. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VMName ]`: The name of the virtual machine. + - `[VersionName ]`: The Automanage best practice version name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/Get-AzAutomanageConfigProfileHciAssignment.md b/azps-10.1.0/Az.Automanage/Get-AzAutomanageConfigProfileHciAssignment.md new file mode 100644 index 0000000000..04782b4a65 --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Get-AzAutomanageConfigProfileHciAssignment.md @@ -0,0 +1,187 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/get-azautomanageconfigprofilehciassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageConfigProfileHciAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageConfigProfileHciAssignment.md +--- + +# Get-AzAutomanageConfigProfileHciAssignment + +## SYNOPSIS +Get information about a configuration profile assignment + +## SYNTAX + +### Get (Default) +``` +Get-AzAutomanageConfigProfileHciAssignment -ClusterName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomanageConfigProfileHciAssignment -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get information about a configuration profile assignment + +## EXAMPLES + +### Example 1: List all configuration profile assignments under a subscription +```powershell +Get-AzAutomanageConfigProfileHciAssignment +``` + +```output +Name ResourceGroupName ManagedBy Status TargetId +---- ----------------- --------- ------ -------- +default automangerg Conformant /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/automangerg/providers/Microsoft.Compute/virtualMachines/aglinuxvm +default lnxtest Conformant /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lnxtest/providers/Microsoft.Compute/virtualMachines/advisortest2 +``` + +This command lists all configuration profile assignments under a subscription. + +### Example 2: List all configuration profile assignments under a resource group +```powershell +Get-AzAutomanageConfigProfileHciAssignment -ResourceGroupName automangerg +``` + +```output +Name ResourceGroupName ManagedBy Status TargetId +---- ----------------- --------- ------ -------- +default automangerg Conformant /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/automangerg/providers/Microsoft.Compute/virtualMachines/aglinuxvm +``` + +This command lists all configuration profile assignments under a resource group. + +### Example 3: Get information about a configuration profile assignment +```powershell +Get-AzAutomanageConfigProfileHciAssignment -ResourceGroupName automangerg -ClusterName aglinuxclusters +``` + +```output +Name ResourceGroupName ManagedBy Status TargetId +---- ----------------- --------- ------ -------- +default automangerg Conformant /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/automangerg/providers/Microsoft.AzureStackHci/clusters/aglinuxclusters +``` + +This command gets information about a configuration profile assignment. + +## PARAMETERS + +### -ClusterName +The name of the Arc machine. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.Api20220504.IConfigurationProfileAssignment + +## 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 + - `[BestPracticeName ]`: The Automanage best practice name. + - `[ClusterName ]`: The name of the Arc machine. + - `[ConfigurationProfileAssignmentName ]`: Name of the configuration profile assignment. Only default is supported. + - `[ConfigurationProfileName ]`: Name of the configuration profile. + - `[Id ]`: Resource identity path + - `[MachineName ]`: The name of the Arc machine. + - `[ReportName ]`: The report name. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VMName ]`: The name of the virtual machine. + - `[VersionName ]`: The Automanage best practice version name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/Get-AzAutomanageConfigProfileHcrpAssignment.md b/azps-10.1.0/Az.Automanage/Get-AzAutomanageConfigProfileHcrpAssignment.md new file mode 100644 index 0000000000..4258ab361a --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Get-AzAutomanageConfigProfileHcrpAssignment.md @@ -0,0 +1,187 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/get-azautomanageconfigprofilehcrpassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageConfigProfileHcrpAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageConfigProfileHcrpAssignment.md +--- + +# Get-AzAutomanageConfigProfileHcrpAssignment + +## SYNOPSIS +Get information about a configuration profile assignment + +## SYNTAX + +### Get (Default) +``` +Get-AzAutomanageConfigProfileHcrpAssignment -MachineName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomanageConfigProfileHcrpAssignment -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get information about a configuration profile assignment + +## EXAMPLES + +### Example 1: List all configuration profile assignments under a subscription +```powershell +Get-AzAutomanageConfigProfileHcrpAssignment +``` + +```output +Name ResourceGroupName ManagedBy Status TargetId +---- ----------------- --------- ------ -------- +default automangerg Conformant /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/automangerg/providers/Microsoft.Compute/virtualMachines/aglinuxvm +default lnxtest Conformant /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lnxtest/providers/Microsoft.Compute/virtualMachines/advisortest2 +``` + +This command lists all configuration profile assignments under a subscription. + +### Example 2: List all configuration profile assignments under a resource group +```powershell +Get-AzAutomanageConfigProfileHcrpAssignment -ResourceGroupName automangerg +``` + +```output +Name ResourceGroupName ManagedBy Status TargetId +---- ----------------- --------- ------ -------- +default automangerg Conformant /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/automangerg/providers/Microsoft.Compute/virtualMachines/aglinuxvm +``` + +This command lists all configuration profile assignments under a resource group. + +### Example 3: Get information about a configuration profile assignment +```powershell +Get-AzAutomanageConfigProfileHcrpAssignment -ResourceGroupName automangerg -MachineName aglinuxmachines +``` + +```output +Name ResourceGroupName ManagedBy Status TargetId +---- ----------------- --------- ------ -------- +default automangerg Conformant /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/automangerg/providers/Microsoft.HybridCompute/machines/aglinuxmachines +``` + +This command gets information about a configuration profile assignment. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MachineName +The name of the Arc machine. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.Api20220504.IConfigurationProfileAssignment + +## 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 + - `[BestPracticeName ]`: The Automanage best practice name. + - `[ClusterName ]`: The name of the Arc machine. + - `[ConfigurationProfileAssignmentName ]`: Name of the configuration profile assignment. Only default is supported. + - `[ConfigurationProfileName ]`: Name of the configuration profile. + - `[Id ]`: Resource identity path + - `[MachineName ]`: The name of the Arc machine. + - `[ReportName ]`: The report name. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VMName ]`: The name of the virtual machine. + - `[VersionName ]`: The Automanage best practice version name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/Get-AzAutomanageHciReport.md b/azps-10.1.0/Az.Automanage/Get-AzAutomanageHciReport.md new file mode 100644 index 0000000000..19b8f061e4 --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Get-AzAutomanageHciReport.md @@ -0,0 +1,200 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/get-azautomanagehcireport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageHciReport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageHciReport.md +--- + +# Get-AzAutomanageHciReport + +## SYNOPSIS +Get information about a report associated with a configuration profile assignment run + +## SYNTAX + +### List (Default) +``` +Get-AzAutomanageHciReport -ClusterName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomanageHciReport -ClusterName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomanageHciReport -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get information about a report associated with a configuration profile assignment run + +## EXAMPLES + +### Example 1: List all information about a report associated with a configuration profile assignment run +```powershell +Get-AzAutomanageHciReport -ResourceGroupName automangerg -ClusterName aglinuxclusters +``` + +```output +Name ResourceGroupName +---- ----------------- +default/a261e96e-90bd-4feb-bed6-c9e1fb436d51 automangerg +default/787969f2-d8b2-4f33-afb3-f3636880884e automangerg +default/638cc61a-70d9-4a88-9ffc-f5a49e981dd7 automangerg +default/8cbcf4be-6f16-480b-85ac-4c0392ff0476 automangerg +default/20640074-b8fd-4e27-abc3-7c9440ea40db automangerg +default/0a9e1d06-6903-4580-8876-84ab7be07239 automangerg +default/6ae85795-33c1-45e9-8823-3124e53378ab automangerg +default/ec6183de-759e-4db2-ae94-142d0d65c33a automangerg +``` + +This command lists all information about a report associated with a configuration profile assignment run. + +### Example 2: Get information about a report associated with a configuration profile assignment run +```powershell +Get-AzAutomanageHciReport -ResourceGroupName automangerg -ClusterName aglinuxclusters -Name cb998749-f7da-4899-8273-d0fde617f49e +``` + +```output +Name ResourceGroupName +---- ----------------- +default/cb998749-f7da-4899-8273-d0fde617f49e automangerg +``` + +This command gets information about a report associated with a configuration profile assignment run. + +## PARAMETERS + +### -ClusterName +The name of the Arc machine. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The report name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.Api20220504.IReport + +## 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 + - `[BestPracticeName ]`: The Automanage best practice name. + - `[ClusterName ]`: The name of the Arc machine. + - `[ConfigurationProfileAssignmentName ]`: Name of the configuration profile assignment. Only default is supported. + - `[ConfigurationProfileName ]`: Name of the configuration profile. + - `[Id ]`: Resource identity path + - `[MachineName ]`: The name of the Arc machine. + - `[ReportName ]`: The report name. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VMName ]`: The name of the virtual machine. + - `[VersionName ]`: The Automanage best practice version name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/Get-AzAutomanageHcrpReport.md b/azps-10.1.0/Az.Automanage/Get-AzAutomanageHcrpReport.md new file mode 100644 index 0000000000..d62b71863c --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Get-AzAutomanageHcrpReport.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/get-azautomanagehcrpreport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageHcrpReport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageHcrpReport.md +--- + +# Get-AzAutomanageHcrpReport + +## SYNOPSIS +Get information about a report associated with a configuration profile assignment run + +## SYNTAX + +### List (Default) +``` +Get-AzAutomanageHcrpReport -MachineName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomanageHcrpReport -MachineName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomanageHcrpReport -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get information about a report associated with a configuration profile assignment run + +## EXAMPLES + +### Example 1: List all information about a report associated with a configuration profile assignment run +```powershell +Get-AzAutomanageHcrpReport -ResourceGroupName automangerg -MachineName aglinuxmachines +``` + +```output +Name ResourceGroupName +---- ----------------- +default/a261e96e-90bd-4feb-bed6-c9e1fb436d51 automangerg +default/787969f2-d8b2-4f33-afb3-f3636880884e automangerg +default/638cc61a-70d9-4a88-9ffc-f5a49e981dd7 automangerg +default/8cbcf4be-6f16-480b-85ac-4c0392ff0476 automangerg +default/20640074-b8fd-4e27-abc3-7c9440ea40db automangerg +default/0a9e1d06-6903-4580-8876-84ab7be07239 automangerg +default/6ae85795-33c1-45e9-8823-3124e53378ab automangerg +default/ec6183de-759e-4db2-ae94-142d0d65c33a automangerg +``` + +This command lists all information about a report associated with a configuration profile assignment run. + +### Example 2: Get information about a report associated with a configuration profile assignment run +```powershell +Get-AzAutomanageHcrpReport -ResourceGroupName automangerg -MachineName aglinuxmachines -Name cb998749-f7da-4899-8273-d0fde617f49e +``` + +```output +Name ResourceGroupName +---- ----------------- +default/cb998749-f7da-4899-8273-d0fde617f49e automangerg +``` + +This command gets information about a report associated with a configuration profile assignment run. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MachineName +The name of the Arc machine. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The report name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.Api20220504.IReport + +## 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 + - `[BestPracticeName ]`: The Automanage best practice name. + - `[ClusterName ]`: The name of the Arc machine. + - `[ConfigurationProfileAssignmentName ]`: Name of the configuration profile assignment. Only default is supported. + - `[ConfigurationProfileName ]`: Name of the configuration profile. + - `[Id ]`: Resource identity path + - `[MachineName ]`: The name of the Arc machine. + - `[ReportName ]`: The report name. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VMName ]`: The name of the virtual machine. + - `[VersionName ]`: The Automanage best practice version name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/Get-AzAutomanageReport.md b/azps-10.1.0/Az.Automanage/Get-AzAutomanageReport.md new file mode 100644 index 0000000000..daa33105b2 --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Get-AzAutomanageReport.md @@ -0,0 +1,200 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/get-azautomanagereport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageReport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Get-AzAutomanageReport.md +--- + +# Get-AzAutomanageReport + +## SYNOPSIS +Get information about a report associated with a configuration profile assignment run + +## SYNTAX + +### List (Default) +``` +Get-AzAutomanageReport -ResourceGroupName -VMName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomanageReport -Name -ResourceGroupName -VMName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomanageReport -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get information about a report associated with a configuration profile assignment run + +## EXAMPLES + +### Example 1: List all information about a report associated with a configuration profile assignment run +```powershell +Get-AzAutomanageReport -ResourceGroupName automangerg -VMName aglinuxvm +``` + +```output +Name ResourceGroupName +---- ----------------- +default/a261e96e-90bd-4feb-bed6-c9e1fb436d51 automangerg +default/787969f2-d8b2-4f33-afb3-f3636880884e automangerg +default/638cc61a-70d9-4a88-9ffc-f5a49e981dd7 automangerg +default/8cbcf4be-6f16-480b-85ac-4c0392ff0476 automangerg +default/20640074-b8fd-4e27-abc3-7c9440ea40db automangerg +default/0a9e1d06-6903-4580-8876-84ab7be07239 automangerg +default/6ae85795-33c1-45e9-8823-3124e53378ab automangerg +default/ec6183de-759e-4db2-ae94-142d0d65c33a automangerg +``` + +This command lists all information about a report associated with a configuration profile assignment run. + +### Example 2: Get information about a report associated with a configuration profile assignment run +```powershell +Get-AzAutomanageReport -ResourceGroupName automangerg -VMName aglinuxvm -Name cb998749-f7da-4899-8273-d0fde617f49e +``` + +```output +Name ResourceGroupName +---- ----------------- +default/cb998749-f7da-4899-8273-d0fde617f49e automangerg +``` + +This command gets information about a report associated with a configuration profile assignment run. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The report name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ReportName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName +The name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.Api20220504.IReport + +## 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 + - `[BestPracticeName ]`: The Automanage best practice name. + - `[ClusterName ]`: The name of the Arc machine. + - `[ConfigurationProfileAssignmentName ]`: Name of the configuration profile assignment. Only default is supported. + - `[ConfigurationProfileName ]`: Name of the configuration profile. + - `[Id ]`: Resource identity path + - `[MachineName ]`: The name of the Arc machine. + - `[ReportName ]`: The report name. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VMName ]`: The name of the virtual machine. + - `[VersionName ]`: The Automanage best practice version name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/New-AzAutomanageConfigProfile.md b/azps-10.1.0/Az.Automanage/New-AzAutomanageConfigProfile.md new file mode 100644 index 0000000000..38ac8d5957 --- /dev/null +++ b/azps-10.1.0/Az.Automanage/New-AzAutomanageConfigProfile.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/new-azautomanageconfigprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/New-AzAutomanageConfigProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/New-AzAutomanageConfigProfile.md +--- + +# New-AzAutomanageConfigProfile + +## SYNOPSIS +Creates a configuration profile + +## SYNTAX + +``` +New-AzAutomanageConfigProfile -Name -ResourceGroupName -Location + [-SubscriptionId ] [-Configuration ] [-Tag ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a configuration profile + +## EXAMPLES + +### Example 1: Creates a configuration profile +```powershell +$confprof = @{ + "Antimalware/Enable"='false'; + "Backup/Enable"='false'; + "VMInsights/Enable"= 'true'; + "AzureSecurityCenter/Enable"='true'; + "UpdateManagement/Enable"='true'; + "ChangeTrackingAndInventory/Enable"='true'; + "GuestConfiguration/Enable"='true'; + "LogAnalytics/Enable"='true'; + "BootDiagnostics/Enable"='true' + } +New-AzAutomanageConfigProfile -ResourceGroupName automangerg -Name confpro-pwsh01 -Location eastus -Configuration $confprof +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus confpro-pwsh01 automangerg +``` + +This command creates a configuration profile. + +## PARAMETERS + +### -Configuration +configuration dictionary of the configuration profile. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the configuration profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConfigurationProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.Api20220504.IConfigurationProfile + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/New-AzAutomanageConfigProfileAssignment.md b/azps-10.1.0/Az.Automanage/New-AzAutomanageConfigProfileAssignment.md new file mode 100644 index 0000000000..273fcf724c --- /dev/null +++ b/azps-10.1.0/Az.Automanage/New-AzAutomanageConfigProfileAssignment.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/new-azautomanageconfigprofileassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/New-AzAutomanageConfigProfileAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/New-AzAutomanageConfigProfileAssignment.md +--- + +# New-AzAutomanageConfigProfileAssignment + +## SYNOPSIS +Creates an association between a VM and Automanage configuration profile + +## SYNTAX + +``` +New-AzAutomanageConfigProfileAssignment -ResourceGroupName -VMName + [-SubscriptionId ] [-ConfigurationProfile ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Creates an association between a VM and Automanage configuration profile + +## EXAMPLES + +### Example 1: Creates an association between a VM and Automanage configuration profile +```powershell +New-AzAutomanageConfigProfileAssignment -ResourceGroupName automangerg -VMName aglinuxvm -ConfigurationProfile "/providers/Microsoft.Automanage/bestPractices/AzureBestPracticesProduction" +``` + +```output +Name ResourceGroupName ManagedBy Status TargetId +---- ----------------- --------- ------ -------- +default automangerg Unknown /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/automangerg/providers/Microsoft.Compute/virtualMachines/aglinuxvm +``` + +This command creates an association between a VM and Automanage configuration profile. + +## PARAMETERS + +### -ConfigurationProfile +The Automanage configurationProfile ARM Resource URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName +The name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.Api20220504.IConfigurationProfileAssignment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/New-AzAutomanageConfigProfileHciAssignment.md b/azps-10.1.0/Az.Automanage/New-AzAutomanageConfigProfileHciAssignment.md new file mode 100644 index 0000000000..f74b9a4771 --- /dev/null +++ b/azps-10.1.0/Az.Automanage/New-AzAutomanageConfigProfileHciAssignment.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/new-azautomanageconfigprofilehciassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/New-AzAutomanageConfigProfileHciAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/New-AzAutomanageConfigProfileHciAssignment.md +--- + +# New-AzAutomanageConfigProfileHciAssignment + +## SYNOPSIS +Creates an association between a AzureStackHCI cluster and Automanage configuration profile + +## SYNTAX + +``` +New-AzAutomanageConfigProfileHciAssignment -ClusterName -ResourceGroupName + [-SubscriptionId ] [-ConfigurationProfile ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Creates an association between a AzureStackHCI cluster and Automanage configuration profile + +## EXAMPLES + +### Example 1: Creates an association between a AzureStackHCI cluster and Automanage configuration profile +```powershell +New-AzAutomanageConfigProfileHciAssignment -ResourceGroupName automangerg -ClusterName aglinuxcluster -ConfigurationProfile "/providers/Microsoft.Automanage/bestPractices/AzureBestPracticesProduction" +``` + +```output +Name ResourceGroupName ManagedBy Status TargetId +---- ----------------- --------- ------ -------- +default automangerg Unknown /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/automangerg/providers/Microsoft.AzureStackHci/clusters/aglinuxcluster +``` + +This command creates an association between a AzureStackHCI cluster and Automanage configuration profile. + +## PARAMETERS + +### -ClusterName +The name of the Arc machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationProfile +The Automanage configurationProfile ARM Resource URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.Api20220504.IConfigurationProfileAssignment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/New-AzAutomanageConfigProfileHcrpAssignment.md b/azps-10.1.0/Az.Automanage/New-AzAutomanageConfigProfileHcrpAssignment.md new file mode 100644 index 0000000000..1be8b53043 --- /dev/null +++ b/azps-10.1.0/Az.Automanage/New-AzAutomanageConfigProfileHcrpAssignment.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/new-azautomanageconfigprofilehcrpassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/New-AzAutomanageConfigProfileHcrpAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/New-AzAutomanageConfigProfileHcrpAssignment.md +--- + +# New-AzAutomanageConfigProfileHcrpAssignment + +## SYNOPSIS +Creates an association between a ARC machine and Automanage configuration profile + +## SYNTAX + +``` +New-AzAutomanageConfigProfileHcrpAssignment -MachineName -ResourceGroupName + [-SubscriptionId ] [-ConfigurationProfile ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Creates an association between a ARC machine and Automanage configuration profile + +## EXAMPLES + +### Example 1: Creates an association between a ARC machine and Automanage configuration profile +```powershell +New-AzAutomanageConfigProfileHcrpAssignment -ResourceGroupName automangerg -MachineName aglinuxmachines -ConfigurationProfile "/providers/Microsoft.Automanage/bestPractices/AzureBestPracticesProduction" +``` + +```output +Name ResourceGroupName ManagedBy Status TargetId +---- ----------------- --------- ------ -------- +default automangerg Unknown /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/automangerg/providers/Microsoft.HybridCompute/machines/aglinuxmachines +``` + +This command creates an association between a ARC machine and Automanage configuration profile. + +## PARAMETERS + +### -ConfigurationProfile +The Automanage configurationProfile ARM Resource URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineName +The name of the Arc machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.Api20220504.IConfigurationProfileAssignment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/Remove-AzAutomanageConfigProfile.md b/azps-10.1.0/Az.Automanage/Remove-AzAutomanageConfigProfile.md new file mode 100644 index 0000000000..f46b8f6144 --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Remove-AzAutomanageConfigProfile.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/remove-azautomanageconfigprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Remove-AzAutomanageConfigProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Remove-AzAutomanageConfigProfile.md +--- + +# Remove-AzAutomanageConfigProfile + +## SYNOPSIS +Delete a configuration profile + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomanageConfigProfile -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomanageConfigProfile -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a configuration profile + +## EXAMPLES + +### Example 1: Delete a configuration profile by name +```powershell +Remove-AzAutomanageConfigProfile -ResourceGroupName automangerg -Name confpro-pwsh01 +``` + +This command delete a configuration profile by name. + +### Example 2: Delete a configuration profile by pipeline +```powershell +Get-AzAutomanageConfigProfile -ResourceGroupName automangerg -Name confpro-pwsh01 | Remove-AzAutomanageConfigProfile +``` + +This command delete a configuration profile by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the configuration profile + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ConfigurationProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[BestPracticeName ]`: The Automanage best practice name. + - `[ClusterName ]`: The name of the Arc machine. + - `[ConfigurationProfileAssignmentName ]`: Name of the configuration profile assignment. Only default is supported. + - `[ConfigurationProfileName ]`: Name of the configuration profile. + - `[Id ]`: Resource identity path + - `[MachineName ]`: The name of the Arc machine. + - `[ReportName ]`: The report name. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VMName ]`: The name of the virtual machine. + - `[VersionName ]`: The Automanage best practice version name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/Remove-AzAutomanageConfigProfileAssignment.md b/azps-10.1.0/Az.Automanage/Remove-AzAutomanageConfigProfileAssignment.md new file mode 100644 index 0000000000..f58127e806 --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Remove-AzAutomanageConfigProfileAssignment.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/remove-azautomanageconfigprofileassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Remove-AzAutomanageConfigProfileAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Remove-AzAutomanageConfigProfileAssignment.md +--- + +# Remove-AzAutomanageConfigProfileAssignment + +## SYNOPSIS +Delete a configuration profile assignment + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomanageConfigProfileAssignment -ResourceGroupName -VMName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomanageConfigProfileAssignment -InputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a configuration profile assignment + +## EXAMPLES + +### Example 1: Delete a configuration profile assignment by name +```powershell +Remove-AzAutomanageConfigProfileAssignment -ResourceGroupName automangerg -VMName aglinuxvm +``` + +This command deletes a configuration profile assignment by name. + +### Example 2: Delete a configuration profile assignment by pipeline +```powershell +Get-AzAutomanageConfigProfileAssignment -ResourceGroupName automangerg -VMName aglinuxvm | Remove-AzAutomanageConfigProfileAssignment +``` + +This command deletes a configuration profile assignment by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName +The name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[BestPracticeName ]`: The Automanage best practice name. + - `[ClusterName ]`: The name of the Arc machine. + - `[ConfigurationProfileAssignmentName ]`: Name of the configuration profile assignment. Only default is supported. + - `[ConfigurationProfileName ]`: Name of the configuration profile. + - `[Id ]`: Resource identity path + - `[MachineName ]`: The name of the Arc machine. + - `[ReportName ]`: The report name. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VMName ]`: The name of the virtual machine. + - `[VersionName ]`: The Automanage best practice version name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/Remove-AzAutomanageConfigProfileHciAssignment.md b/azps-10.1.0/Az.Automanage/Remove-AzAutomanageConfigProfileHciAssignment.md new file mode 100644 index 0000000000..54288f797a --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Remove-AzAutomanageConfigProfileHciAssignment.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/remove-azautomanageconfigprofilehciassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Remove-AzAutomanageConfigProfileHciAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Remove-AzAutomanageConfigProfileHciAssignment.md +--- + +# Remove-AzAutomanageConfigProfileHciAssignment + +## SYNOPSIS +Delete a configuration profile assignment + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomanageConfigProfileHciAssignment -ClusterName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomanageConfigProfileHciAssignment -InputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a configuration profile assignment + +## EXAMPLES + +### Example 1: Delete a configuration profile assignment by name +```powershell +Remove-AzAutomanageConfigProfileHciAssignment -ResourceGroupName automangerg -ClusterName aglinuxcluster +``` + +This command deletes a configuration profile assignment by name. + +### Example 2: Delete a configuration profile assignment by pipeline +```powershell +Get-AzAutomanageConfigProfileHciAssignment -ResourceGroupName automangerg -ClusterName aglinuxcluster | Remove-AzAutomanageConfigProfileHciAssignment +``` + +This command deletes a configuration profile assignment by pipeline. + +## PARAMETERS + +### -ClusterName +The name of the Arc machine. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[BestPracticeName ]`: The Automanage best practice name. + - `[ClusterName ]`: The name of the Arc machine. + - `[ConfigurationProfileAssignmentName ]`: Name of the configuration profile assignment. Only default is supported. + - `[ConfigurationProfileName ]`: Name of the configuration profile. + - `[Id ]`: Resource identity path + - `[MachineName ]`: The name of the Arc machine. + - `[ReportName ]`: The report name. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VMName ]`: The name of the virtual machine. + - `[VersionName ]`: The Automanage best practice version name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/Remove-AzAutomanageConfigProfileHcrpAssignment.md b/azps-10.1.0/Az.Automanage/Remove-AzAutomanageConfigProfileHcrpAssignment.md new file mode 100644 index 0000000000..8bca40f97d --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Remove-AzAutomanageConfigProfileHcrpAssignment.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/remove-azautomanageconfigprofilehcrpassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Remove-AzAutomanageConfigProfileHcrpAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Remove-AzAutomanageConfigProfileHcrpAssignment.md +--- + +# Remove-AzAutomanageConfigProfileHcrpAssignment + +## SYNOPSIS +Delete a configuration profile assignment + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomanageConfigProfileHcrpAssignment -MachineName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomanageConfigProfileHcrpAssignment -InputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a configuration profile assignment + +## EXAMPLES + +### Example 1: Delete a configuration profile assignment by name +```powershell +Remove-AzAutomanageConfigProfileHcrpAssignment -ResourceGroupName automangerg -MachineName aglinuxmachine +``` + +This command deletes a configuration profile assignment by name. + +### Example 2: Delete a configuration profile assignment by pipeline +```powershell +Get-AzAutomanageConfigProfileHcrpAssignment -ResourceGroupName automangerg -MachineName aglinuxmachine | Remove-AzAutomanageConfigProfileHcrpAssignment +``` + +This command deletes a configuration profile assignment by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MachineName +The name of the Arc machine. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[BestPracticeName ]`: The Automanage best practice name. + - `[ClusterName ]`: The name of the Arc machine. + - `[ConfigurationProfileAssignmentName ]`: Name of the configuration profile assignment. Only default is supported. + - `[ConfigurationProfileName ]`: Name of the configuration profile. + - `[Id ]`: Resource identity path + - `[MachineName ]`: The name of the Arc machine. + - `[ReportName ]`: The report name. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VMName ]`: The name of the virtual machine. + - `[VersionName ]`: The Automanage best practice version name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automanage/Update-AzAutomanageConfigProfile.md b/azps-10.1.0/Az.Automanage/Update-AzAutomanageConfigProfile.md new file mode 100644 index 0000000000..f22cab4640 --- /dev/null +++ b/azps-10.1.0/Az.Automanage/Update-AzAutomanageConfigProfile.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: Az.Automanage +online version: https://learn.microsoft.com/powershell/module/az.automanage/update-azautomanageconfigprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Update-AzAutomanageConfigProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automanage/help/Update-AzAutomanageConfigProfile.md +--- + +# Update-AzAutomanageConfigProfile + +## SYNOPSIS +Updates a configuration profile + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomanageConfigProfile -Name -ResourceGroupName [-SubscriptionId ] + [-Configuration ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomanageConfigProfile -InputObject [-Configuration ] + [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates a configuration profile + +## EXAMPLES + +### Example 1: Updates a configuration profile +```powershell +Update-AzAutomanageConfigProfile -ResourceGroupName automangerg -Name confpro-pwsh01 -Tag @{"Organization" = "Administration"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus confpro-pwsh01 automangerg +``` + +This command updates a configuration profile. + +### Example 2: Updates a configuration pipeline. +```powershell +Get-AzAutomanageConfigProfile -ResourceGroupName automangerg -Name confpro-pwsh01 | Update-AzAutomanageConfigProfile -Tag @{"Organization" = "Administration"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus confpro-pwsh01 automangerg +``` + +This command updates a configuration pipeline. + +## PARAMETERS + +### -Configuration +configuration dictionary of the configuration profile. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the configuration profile. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ConfigurationProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags of the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.IAutomanageIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automanage.Models.Api20220504.IConfigurationProfile + +## 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 + - `[BestPracticeName ]`: The Automanage best practice name. + - `[ClusterName ]`: The name of the Arc machine. + - `[ConfigurationProfileAssignmentName ]`: Name of the configuration profile assignment. Only default is supported. + - `[ConfigurationProfileName ]`: Name of the configuration profile. + - `[Id ]`: Resource identity path + - `[MachineName ]`: The name of the Arc machine. + - `[ReportName ]`: The report name. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VMName ]`: The name of the virtual machine. + - `[VersionName ]`: The Automanage best practice version name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Automation/Az.Automation.md b/azps-10.1.0/Az.Automation/Az.Automation.md new file mode 100644 index 0000000000..8e46bb585e --- /dev/null +++ b/azps-10.1.0/Az.Automation/Az.Automation.md @@ -0,0 +1,279 @@ +--- +Module Name: Az.Automation +Module Guid: bcea1c70-a32b-48c3-a05c-323e1c02f4d3 +Download Help Link: https://learn.microsoft.com/powershell/module/az.automation +Help Version: 4.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Az.Automation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Az.Automation.md +--- + +# Az.Automation Module +## Description +This topic displays help topics for the Azure Automation Cmdlets. + +## Az.Automation Cmdlets +### [Export-AzAutomationDscConfiguration](Export-AzAutomationDscConfiguration.md) +Exports a DSC configuration from Automation to a local file. + +### [Export-AzAutomationDscNodeReportContent](Export-AzAutomationDscNodeReportContent.md) +Exports the raw content of a DSC report sent from a DSC node to Automation. + +### [Export-AzAutomationRunbook](Export-AzAutomationRunbook.md) +Exports an Automation runbook. + +### [Get-AzAutomationAccount](Get-AzAutomationAccount.md) +Gets Automation accounts in a resource group. + +### [Get-AzAutomationCertificate](Get-AzAutomationCertificate.md) +Gets Automation certificates. + +### [Get-AzAutomationConnection](Get-AzAutomationConnection.md) +Gets an Automation connection. + +### [Get-AzAutomationCredential](Get-AzAutomationCredential.md) +Gets Automation credentials. + +### [Get-AzAutomationDscCompilationJob](Get-AzAutomationDscCompilationJob.md) +Gets DSC compilation jobs in Automation. + +### [Get-AzAutomationDscCompilationJobOutput](Get-AzAutomationDscCompilationJobOutput.md) +Gets the logging streams of an Automation DSC compilation job. + +### [Get-AzAutomationDscConfiguration](Get-AzAutomationDscConfiguration.md) +Gets DSC configurations from Automation. + +### [Get-AzAutomationDscNode](Get-AzAutomationDscNode.md) +Gets DSC nodes from Automation. + +### [Get-AzAutomationDscNodeConfiguration](Get-AzAutomationDscNodeConfiguration.md) +Gets metadata for DSC node configurations in Automation. + +### [Get-AzAutomationDscNodeConfigurationDeployment](Get-AzAutomationDscNodeConfigurationDeployment.md) +Gets DSC Node configuration deployments in Automation. + +### [Get-AzAutomationDscNodeConfigurationDeploymentSchedule](Get-AzAutomationDscNodeConfigurationDeploymentSchedule.md) +Gets a DSC Node configuration deployment job schedule in Automation. + +### [Get-AzAutomationDscNodeReport](Get-AzAutomationDscNodeReport.md) +Gets reports sent from a DSC node to Automation. + +### [Get-AzAutomationDscOnboardingMetaconfig](Get-AzAutomationDscOnboardingMetaconfig.md) +Creates meta-configuration .mof files. + +### [Get-AzAutomationHybridWorkerGroup](Get-AzAutomationHybridWorkerGroup.md) +Gets hybrid runbook worker groups. + +### [Get-AzAutomationJob](Get-AzAutomationJob.md) +Gets Automation runbook jobs. + +### [Get-AzAutomationJobOutput](Get-AzAutomationJobOutput.md) +Gets the output of an Automation job. + +### [Get-AzAutomationJobOutputRecord](Get-AzAutomationJobOutputRecord.md) +Gets the full output of an Automation job output record. + +### [Get-AzAutomationModule](Get-AzAutomationModule.md) +Gets metadata for modules from Automation. + +### [Get-AzAutomationRegistrationInfo](Get-AzAutomationRegistrationInfo.md) +Gets registration information for onboarding a DSC node or hybrid worker to Automation. + +### [Get-AzAutomationRunbook](Get-AzAutomationRunbook.md) +Gets a runbook. + +### [Get-AzAutomationSchedule](Get-AzAutomationSchedule.md) +Gets an Automation schedule. + +### [Get-AzAutomationScheduledRunbook](Get-AzAutomationScheduledRunbook.md) +Gets Automation runbooks and associated schedules. + +### [Get-AzAutomationSoftwareUpdateConfiguration](Get-AzAutomationSoftwareUpdateConfiguration.md) +Gets a list of azure automation software update configurations. + +### [Get-AzAutomationSoftwareUpdateMachineRun](Get-AzAutomationSoftwareUpdateMachineRun.md) +Gets a list of azure automation software update configuration machine runs. + +### [Get-AzAutomationSoftwareUpdateRun](Get-AzAutomationSoftwareUpdateRun.md) +Gets a list of azure automation software update runs. + +### [Get-AzAutomationSourceControl](Get-AzAutomationSourceControl.md) +Gets a list of Azure Automation source controls. + +### [Get-AzAutomationSourceControlSyncJob](Get-AzAutomationSourceControlSyncJob.md) +Gets Azure Automation source control sync jobs. + +### [Get-AzAutomationSourceControlSyncJobOutput](Get-AzAutomationSourceControlSyncJobOutput.md) +Gets the output of an Azure Automation source control sync job. + +### [Get-AzAutomationVariable](Get-AzAutomationVariable.md) +Gets an Automation variable. + +### [Get-AzAutomationWebhook](Get-AzAutomationWebhook.md) +Gets webhooks from Automation. + +### [Import-AzAutomationDscConfiguration](Import-AzAutomationDscConfiguration.md) +Imports a DSC configuration into Automation. + +### [Import-AzAutomationDscNodeConfiguration](Import-AzAutomationDscNodeConfiguration.md) +Imports a MOF document as a DSC node configuration in Automation. + +### [Import-AzAutomationRunbook](Import-AzAutomationRunbook.md) +Imports an Automation runbook. + +### [New-AzAutomationAccount](New-AzAutomationAccount.md) +Creates an Automation account. + +### [New-AzAutomationCertificate](New-AzAutomationCertificate.md) +Creates an Automation certificate. + +### [New-AzAutomationConnection](New-AzAutomationConnection.md) +Creates an Automation connection. + +### [New-AzAutomationCredential](New-AzAutomationCredential.md) +Creates an Automation credential. + +### [New-AzAutomationKey](New-AzAutomationKey.md) +Regenerates registration keys for an Automation account. + +### [New-AzAutomationModule](New-AzAutomationModule.md) +Imports a module into Automation. + +### [New-AzAutomationRunbook](New-AzAutomationRunbook.md) +Creates an Automation runbook. + +### [New-AzAutomationSchedule](New-AzAutomationSchedule.md) +Creates an Automation schedule. + +### [New-AzAutomationSoftwareUpdateConfiguration](New-AzAutomationSoftwareUpdateConfiguration.md) +Creates a scheduled azure automation software update configuration. + +### [New-AzAutomationSourceControl](New-AzAutomationSourceControl.md) +Creates an Azure Automation source control. + +### [New-AzAutomationUpdateManagementAzureQuery](New-AzAutomationUpdateManagementAzureQuery.md) +Creates an Update Management Azure Query object. + +### [New-AzAutomationVariable](New-AzAutomationVariable.md) +Creates an Automation variable. + +### [New-AzAutomationWebhook](New-AzAutomationWebhook.md) +Creates a webhook for an Automation runbook. + +### [Publish-AzAutomationRunbook](Publish-AzAutomationRunbook.md) +Publishes a runbook. + +### [Register-AzAutomationDscNode](Register-AzAutomationDscNode.md) +Registers an Azure virtual machine running Windows OS as a DSC node for an Automation account. + +### [Register-AzAutomationScheduledRunbook](Register-AzAutomationScheduledRunbook.md) +Associates a runbook to a schedule. + +### [Remove-AzAutomationAccount](Remove-AzAutomationAccount.md) +Removes an Automation account. + +### [Remove-AzAutomationCertificate](Remove-AzAutomationCertificate.md) +Removes an Automation certificate. + +### [Remove-AzAutomationConnection](Remove-AzAutomationConnection.md) +Removes an Automation connection. + +### [Remove-AzAutomationConnectionType](Remove-AzAutomationConnectionType.md) +Removes an Automation connection type. + +### [Remove-AzAutomationCredential](Remove-AzAutomationCredential.md) +Removes an Automation credential. + +### [Remove-AzAutomationDscConfiguration](Remove-AzAutomationDscConfiguration.md) +Removes DSC configurations from Automation. + +### [Remove-AzAutomationDscNodeConfiguration](Remove-AzAutomationDscNodeConfiguration.md) +Removes metadata from DSC node configurations in Automation. + +### [Remove-AzAutomationHybridWorkerGroup](Remove-AzAutomationHybridWorkerGroup.md) +Removes hybrid worker group from Automation. + +### [Remove-AzAutomationModule](Remove-AzAutomationModule.md) +Removes a module from Automation. + +### [Remove-AzAutomationRunbook](Remove-AzAutomationRunbook.md) +Removes a runbook. + +### [Remove-AzAutomationSchedule](Remove-AzAutomationSchedule.md) +Deletes an Automation schedule. + +### [Remove-AzAutomationSoftwareUpdateConfiguration](Remove-AzAutomationSoftwareUpdateConfiguration.md) +Removes an azure automation software update configuration. + +### [Remove-AzAutomationSourceControl](Remove-AzAutomationSourceControl.md) +Removes an Azure Automation source control. + +### [Remove-AzAutomationVariable](Remove-AzAutomationVariable.md) +Removes an Automation variable. + +### [Remove-AzAutomationWebhook](Remove-AzAutomationWebhook.md) +Removes a webhook from an Automation runbook. + +### [Resume-AzAutomationJob](Resume-AzAutomationJob.md) +Resumes a suspended Automation job. + +### [Set-AzAutomationAccount](Set-AzAutomationAccount.md) +Modifies an Automation account. + +### [Set-AzAutomationCertificate](Set-AzAutomationCertificate.md) +Modifies the configuration of an Automation certificate. + +### [Set-AzAutomationConnectionFieldValue](Set-AzAutomationConnectionFieldValue.md) +Modifies the value of a field in an Automation connection. + +### [Set-AzAutomationCredential](Set-AzAutomationCredential.md) +Modifies an Automation credential. + +### [Set-AzAutomationDscNode](Set-AzAutomationDscNode.md) +Modifies the node configuration that a DSC node is mapped to. + +### [Set-AzAutomationModule](Set-AzAutomationModule.md) +Updates a module in Automation. + +### [Set-AzAutomationRunbook](Set-AzAutomationRunbook.md) +Modifies a runbook. + +### [Set-AzAutomationSchedule](Set-AzAutomationSchedule.md) +Modifies an Automation schedule. + +### [Set-AzAutomationVariable](Set-AzAutomationVariable.md) +Modifies an Automation variable. + +### [Set-AzAutomationWebhook](Set-AzAutomationWebhook.md) +Modifies a webhook for an Automation runbook. + +### [Start-AzAutomationDscCompilationJob](Start-AzAutomationDscCompilationJob.md) +Compiles a DSC configuration in Automation. + +### [Start-AzAutomationDscNodeConfigurationDeployment](Start-AzAutomationDscNodeConfigurationDeployment.md) +Deploys a DSC Node configuration in Automation. + +### [Start-AzAutomationRunbook](Start-AzAutomationRunbook.md) +Starts a runbook job. + +### [Start-AzAutomationSourceControlSyncJob](Start-AzAutomationSourceControlSyncJob.md) +Starts an Azure Automation source control sync job. + +### [Stop-AzAutomationDscNodeConfigurationDeployment](Stop-AzAutomationDscNodeConfigurationDeployment.md) +Stops a DSC Node configuration deployment in Automation. It only stops the current deployment job but does not unassign already assigned node configurations. + +### [Stop-AzAutomationJob](Stop-AzAutomationJob.md) +Stops an Automation job. + +### [Suspend-AzAutomationJob](Suspend-AzAutomationJob.md) +Suspends an Automation job. + +### [Unregister-AzAutomationDscNode](Unregister-AzAutomationDscNode.md) +Removes a DSC node from management by an Automation account. + +### [Unregister-AzAutomationScheduledRunbook](Unregister-AzAutomationScheduledRunbook.md) +Removes an association between a runbook and a schedule. + +### [Update-AzAutomationSourceControl](Update-AzAutomationSourceControl.md) +Updates an Azure Automation source control. + diff --git a/azps-10.1.0/Az.Automation/Export-AzAutomationDscConfiguration.md b/azps-10.1.0/Az.Automation/Export-AzAutomationDscConfiguration.md new file mode 100644 index 0000000000..cfd9860ef3 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Export-AzAutomationDscConfiguration.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 595D3304-3331-4F44-BA57-AE090FB8A132 +online version: https://learn.microsoft.com/powershell/module/az.automation/export-azautomationdscconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Export-AzAutomationDscConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Export-AzAutomationDscConfiguration.md +--- + +# Export-AzAutomationDscConfiguration + +## SYNOPSIS +Exports a DSC configuration from Automation to a local file. + +## SYNTAX + +``` +Export-AzAutomationDscConfiguration -Name [-Slot ] [-OutputFolder ] [-Force] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Export-AzAutomationDscConfiguration** cmdlet exports an APS Desired State Configuration (DSC) configuration from Azure Automation to a local file. +The exported file has a .ps1 file name extension. + +## EXAMPLES + +### Example 1: Export the published version of a DSC configuration +```powershell +Export-AzAutomationDscConfiguration -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Name "Configuration01" -Slot Published -OutputFolder "C:\Users\PattiFuller\Desktop" +``` + +This command exports the published version of a DSC configuration in Automation to the specified folder, which is the desktop. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains the DSC that this cmdlet exports. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet replaces an existing local file with a new file that has the same name. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the DSC configuration that this cmdlet exports. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OutputFolder +Specifies the output folder where this cmdlet exports the DSC configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet exports a DSC configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Slot +Specifies which version of the DSC configuration that this cmdlet exports. +Valid values are: +- Draft +- Published +The default value is Published. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Published, Draft + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.IO.DirectoryInfo + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationDscConfiguration](./Get-AzAutomationDscConfiguration.md) + +[Import-AzAutomationDscConfiguration](./Import-AzAutomationDscConfiguration.md) + + diff --git a/azps-10.1.0/Az.Automation/Export-AzAutomationDscNodeReportContent.md b/azps-10.1.0/Az.Automation/Export-AzAutomationDscNodeReportContent.md new file mode 100644 index 0000000000..5e187c77af --- /dev/null +++ b/azps-10.1.0/Az.Automation/Export-AzAutomationDscNodeReportContent.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 4285EF77-FA70-4BE7-96E0-89E2E8FC5AD6 +online version: https://learn.microsoft.com/powershell/module/az.automation/export-azautomationdscnodereportcontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Export-AzAutomationDscNodeReportContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Export-AzAutomationDscNodeReportContent.md +--- + +# Export-AzAutomationDscNodeReportContent + +## SYNOPSIS +Exports the raw content of a DSC report sent from a DSC node to Automation. + +## SYNTAX + +``` +Export-AzAutomationDscNodeReportContent -NodeId -ReportId [-OutputFolder ] [-Force] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Export-AzAutomationDscNodeReportContent** cmdlet exports the raw contents of an APS Desired State Configuration (DSC) report. +A DSC node sends a DSC report to Azure Automation. + +## EXAMPLES + +### Example 1: Export a report from a DSC node +```powershell +$Node = Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "AutomationAccount01" -Name "Computer14" +$Report = Get-AzAutomationDscNodeReport -ResourceGroupName "ResourceGroup03" -AutomationAccountName "ContosoAutomationAccount" -NodeId $Node.Id -Latest +$Report | Export-AzAutomationDscNodeReportContent -OutputFolder "C:\Users\PattiFuller\Desktop" +``` + +This set of commands exports the latest report from the DSC node named Computer14 to the desktop. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account. +This cmdlet exports report content for a DSC node that belongs to the Automation account that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet replaces an existing local file with a new file that has the same name. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeId +Specifies the unique ID of the DSC node for which this cmdlet exports report contents. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OutputFolder +Specifies the output folder where this cmdlet exports report contents. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReportId +Specifies the unique ID of the DSC node report that this cmdlet exports. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet exports the contents of a report for the DSC node that belongs to the resource group that this cmdlet specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### System.IO.DirectoryInfo + +## NOTES + +## RELATED LINKS + +[Export-AzAutomationDscNodeReportContent](./Export-AzAutomationDscNodeReportContent.md) + +[Get-AzAutomationDscNode](./Get-AzAutomationDscNode.md) + +[Get-AzAutomationDscNodeReport](./Get-AzAutomationDscNodeReport.md) + + diff --git a/azps-10.1.0/Az.Automation/Export-AzAutomationRunbook.md b/azps-10.1.0/Az.Automation/Export-AzAutomationRunbook.md new file mode 100644 index 0000000000..751c4bbcb7 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Export-AzAutomationRunbook.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 0FF88136-4FC9-41F2-A3E6-BFADBAFF4E44 +online version: https://learn.microsoft.com/powershell/module/az.automation/export-azautomationrunbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Export-AzAutomationRunbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Export-AzAutomationRunbook.md +--- + +# Export-AzAutomationRunbook + +## SYNOPSIS +Exports an Automation runbook. + +## SYNTAX + +``` +Export-AzAutomationRunbook [-Name] [-Slot ] [-OutputFolder ] [-Force] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Export-AzAutomationRunbook** cmdlet exports an Azure Automation runbook to a wps_2 script (.ps1 ) file, for wps_2 or wps_2 Workflow runbooks, or to a graphical runbook (.graphrunbook) file, for graphical runbooks. +The name of the runbook becomes the name of the exported file. + +## EXAMPLES + +### Example 1: Export a runbook +```powershell +Export-AzAutomationRunbook -ResourceGroupName "ResourceGroup01" -AutomationAccountName "ContosoAutomationAccount" -Name "Runbook03" -Slot "Published" -OutputFolder "C:\Users\PattiFuller\Desktop" +``` + +This command exports the published version of an Automation runbook to a user desktop. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account in which this cmdlet exports a runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the runbook that this cmdlet exports. +The name of the runbook becomes the name of the export file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OutputFolder +Specifies the path of a folder in which this cmdlet creates the export file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet exports a runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Slot +Specifies whether this cmdlet exports the draft or published content of the runbook. +Valid values are: +- Published +- Draft + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Published, Draft + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.IO.DirectoryInfo + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationRunbook](./Get-AzAutomationRunbook.md) + +[Import-AzAutomationRunbook](./Import-AzAutomationRunbook.md) + +[New-AzAutomationRunbook](./New-AzAutomationRunbook.md) + +[New-AzAutomationRunbook](./New-AzAutomationRunbook.md) + +[Publish-AzAutomationRunbook](./Publish-AzAutomationRunbook.md) + +[Remove-AzAutomationRunbook](./Remove-AzAutomationRunbook.md) + +[Set-AzAutomationRunbook](./Set-AzAutomationRunbook.md) + +[Start-AzAutomationRunbook](./Start-AzAutomationRunbook.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationAccount.md b/azps-10.1.0/Az.Automation/Get-AzAutomationAccount.md new file mode 100644 index 0000000000..1166730173 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationAccount.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: B32A8423-A7AA-418E-A95D-6C18566741AB +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationAccount.md +--- + +# Get-AzAutomationAccount + +## SYNOPSIS +Gets Automation accounts in a resource group. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationAccount [[-ResourceGroupName] ] [-DefaultProfile ] + [] +``` + +### ByAutomationAccountName +``` +Get-AzAutomationAccount [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationAccount** cmdlet gets Azure Automation accounts in a resource group. +For more information about Automation accounts, see the New-AzAutomationAccount cmdlet. + +## EXAMPLES + +### Example 1: Get all accounts +```powershell +Get-AzAutomationAccount -ResourceGroupName "ResourceGroup03" +``` + +This command gets all Automation accounts in the resource group named ResourceGroup03. + +### Example 2: Get an account +```powershell +Get-AzAutomationAccount -ResourceGroupName "ResourceGroup03" -Name "ContosoAutomationAccount" +``` + +This command gets the Automation account named ContosoAutomationAccount in the resource group named ContosoResourceGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Automation account that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ByAutomationAccountName +Aliases: AutomationAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet gets Automation accounts. + +```yaml +Type: System.String +Parameter Sets: ByAll +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByAutomationAccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.AutomationAccount + +## NOTES + +## RELATED LINKS + +[New-AzAutomationAccount](./New-AzAutomationAccount.md) + +[Remove-AzAutomationAccount](./Remove-AzAutomationAccount.md) + +[Set-AzAutomationAccount](./Set-AzAutomationAccount.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationCertificate.md b/azps-10.1.0/Az.Automation/Get-AzAutomationCertificate.md new file mode 100644 index 0000000000..9bf08f9100 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationCertificate.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: D690C903-A481-45F2-9D42-1CE2F4184A98 +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationCertificate.md +--- + +# Get-AzAutomationCertificate + +## SYNOPSIS +Gets Automation certificates. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationCertificate [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByCertificateName +``` +Get-AzAutomationCertificate [-Name] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationCertificate** cmdlet gets one or more Azure Automation certificates. +By default, this cmdlet gets all certificates. +Specify the name of a certificate to get a specific certificate. + +## EXAMPLES + +### Example 1: Get all certificates +```powershell +Get-AzAutomationCertificate -ResourceGroupName "ResourceGroup07" -AutomationAccountName "Contoso17" +``` + +This command gets metadata for all certificates in the Automation account named Contoso17. + +### Example 2: Get a certificate +```powershell +Get-AzAutomationCertificate -ResourceGroupName "ResourceGroup07" -AutomationAccountName "Contoso17" -Name "ContosoCertificate" +``` + +This command gets metadata for the certificate named ContosoCertificate. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account for which this cmdlet retrieves a certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a certificate to retrieve. + +```yaml +Type: System.String +Parameter Sets: ByCertificateName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet gets an Automation certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.CertificateInfo + +## NOTES + +## RELATED LINKS + +[New-AzAutomationCertificate](./New-AzAutomationCertificate.md) + +[Remove-AzAutomationCertificate](./Remove-AzAutomationCertificate.md) + +[Set-AzAutomationCertificate](./Set-AzAutomationCertificate.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationConnection.md b/azps-10.1.0/Az.Automation/Get-AzAutomationConnection.md new file mode 100644 index 0000000000..0154ef5e42 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationConnection.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: D12007E8-8693-45B9-8919-CF8A4BA63AAA +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationConnection.md +--- + +# Get-AzAutomationConnection + +## SYNOPSIS +Gets an Automation connection. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationConnection [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByConnectionName +``` +Get-AzAutomationConnection [-Name] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByConnectionTypeName +``` +Get-AzAutomationConnection [-ConnectionTypeName] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationConnection** cmdlet gets one or more Azure Automation connections. +By default, this cmdlet retrieves all connections. +Specify the name of a connection to get a specific connection. +Specify the connection type name to get all connections of a specific type. + +## EXAMPLES + +### Example 1: Get all connections +```powershell +Get-AzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" +``` + +This command gets metadata for all connections in the Automation account named Contoso17. + +### Example 2: Get all connections of a type +```powershell +Get-AzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -ConnectionTypeName "SqlServer" +``` + +This command gets metadata for connections in the Automation account named Contoso17. +This command gets connections of the type SqlServer. + +### Example 3: Get a connection +```powershell +Get-AzAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -Name "ContosoConnection" +``` + +This command gets metadata for the connection named ContosoConnection. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account for which this cmdlet gets connections. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConnectionTypeName +Specifies the name of a connection type for which this cmdlet retrieves connections. + +```yaml +Type: System.String +Parameter Sets: ByConnectionTypeName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a connection that this cmdlet retrieves. + +```yaml +Type: System.String +Parameter Sets: ByConnectionName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet gets connections. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Connection + +## NOTES + +## RELATED LINKS + +[New-AzAutomationConnection](./New-AzAutomationConnection.md) + +[Remove-AzAutomationConnection](./Remove-AzAutomationConnection.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationCredential.md b/azps-10.1.0/Az.Automation/Get-AzAutomationCredential.md new file mode 100644 index 0000000000..d01a420195 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationCredential.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: DAFB709D-A6F2-4645-8A9E-F8D95669E02F +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationCredential.md +--- + +# Get-AzAutomationCredential + +## SYNOPSIS +Gets Automation credentials. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationCredential [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByName +``` +Get-AzAutomationCredential [-Name] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationCredential** cmdlet gets one or more Azure Automation credentials. +By default, all credentials are returned. +Specify the name of a credential to get a specific credential. +For security purposes, this cmdlet does not return credential passwords. + +## EXAMPLES + +### Example 1: Get all credentials +```powershell +Get-AzAutomationCredential -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" +``` + +This command gets metadata for all credentials in the Automation account named Contoso17. + +### Example 2: Get a credential +```powershell +Get-AzAutomationCredential -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -Name "ContosoCredential" +``` + +This command gets metadata for the credential named ContosoCredential in the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account for which this cmdlet retrieves credentials. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a credential to retrieve. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group for which this cmdlet retrieves credentials. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.CredentialInfo + +## NOTES + +## RELATED LINKS + +[New-AzAutomationCredential](./New-AzAutomationCredential.md) + +[Remove-AzAutomationCredential](./Remove-AzAutomationCredential.md) + +[Set-AzAutomationCredential](./Set-AzAutomationCredential.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationDscCompilationJob.md b/azps-10.1.0/Az.Automation/Get-AzAutomationDscCompilationJob.md new file mode 100644 index 0000000000..acfcdd80d9 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationDscCompilationJob.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: D704BAC0-D89E-4F15-ACF8-FA2C1F0D1B8F +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationdsccompilationjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscCompilationJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscCompilationJob.md +--- + +# Get-AzAutomationDscCompilationJob + +## SYNOPSIS +Gets DSC compilation jobs in Automation. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationDscCompilationJob [-Status ] [-StartTime ] [-EndTime ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +### ByJobId +``` +Get-AzAutomationDscCompilationJob -Id [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByConfigurationName +``` +Get-AzAutomationDscCompilationJob -ConfigurationName [-Status ] [-StartTime ] + [-EndTime ] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationDscCompilationJob** cmdlet gets APS Desired State Configuration (DSC) compilation jobs in Azure Automation. + +## EXAMPLES + +### Example 1: Get all DSC compilation jobs +```powershell +Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" +``` + +This command gets all compilation jobs in the Automation account named Contoso17. + +### Example 2: Get DSC compilation jobs for a configuration +```powershell +Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -ConfigurationName "ContosoConfiguration" +``` + +This command gets all compilation jobs for the DSC configuration named ContosoConfiguration in the Automation account named Contoso17. + +### Example 3: Get a specific DSC compilation job +```powershell +Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Id c0a1718e-d8be-4fa3-91b6-82e1d3a36298 +``` + +This command gets the compilation job with the specified ID in the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains DSC compilation jobs that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConfigurationName +Specifies the name of the DSC configuration for which this cmdlet gets compilation jobs. + +```yaml +Type: System.String +Parameter Sets: ByConfigurationName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +Specifies an end time. +This cmdlet gets compilations jobs that started up to the time that this parameter specifies. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: ByAll, ByConfigurationName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the unique ID of the DSC compilation job that this cmdlet gets. + +```yaml +Type: System.Guid +Parameter Sets: ByJobId +Aliases: JobId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet gets DSC compilation jobs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +Specifies a start time. +This cmdlet gets jobs that start at or after the time that this parameter specifies. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: ByAll, ByConfigurationName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Specifies the status of jobs that this cmdlet gets. +Valid values are: +- Completed +- Failed +- Queued +- Starting +- Resuming +- Running +- Stopped +- Stopping +- Suspended +- Suspending +- Activating +- New + +```yaml +Type: System.String +Parameter Sets: ByAll, ByConfigurationName +Aliases: +Accepted values: Completed, Failed, Queued, Starting, Resuming, Running, Stopped, Stopping, Suspended, Suspending, Activating, New + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.CompilationJob + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationDscCompilationJobOutput](./Get-AzAutomationDscCompilationJobOutput.md) + +[Start-AzAutomationDscCompilationJob](./Start-AzAutomationDscCompilationJob.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationDscCompilationJobOutput.md b/azps-10.1.0/Az.Automation/Get-AzAutomationDscCompilationJobOutput.md new file mode 100644 index 0000000000..595b67e94a --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationDscCompilationJobOutput.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: D40BA2E2-50DF-4D51-A4D2-2D02AECBF20F +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationdsccompilationjoboutput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscCompilationJobOutput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscCompilationJobOutput.md +--- + +# Get-AzAutomationDscCompilationJobOutput + +## SYNOPSIS +Gets the logging streams of an Automation DSC compilation job. + +## SYNTAX + +``` +Get-AzAutomationDscCompilationJobOutput [-Id] [-Stream ] + [-StartTime ] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationDscCompilationJobOutput** cmdlet gets the stream records of an APS Desired State Configuration (DSC) compilation job in Azure Automation. + +## EXAMPLES + +### Example 1: Get the logs for a DSC compilation job +```powershell +$Jobs = Get-AzAutomationDscCompilationJob -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" +$Jobs[0] | Get-AzAutomationDscCompilationJobOutput -Stream "Any" +``` + +The first command gets the compilation jobs in the Automation account named Contoso17 by using the Get-AzAutomationDscCompilationJob cmdlet. +The command stores those objects in the $Jobs variable. +The second command gets the compilation job output for any stream for the first member of the $Jobs array. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains the DSC compilation job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the unique ID of the DSC compilation job for which this cmdlet gets output. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: JobId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the DSC compilation job for which this cmdlet gets stream records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +Specifies a start time. +This cmdlet gets stream records that the DSC compilation job outputs after this time. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Stream +Specifies the type of stream for the output that this cmdlet gets. +Valid values are: +- Any +- Warning +- Error +- Verbose + +```yaml +Type: Microsoft.Azure.Commands.Automation.Common.CompilationJobStreamType +Parameter Sets: (All) +Aliases: +Accepted values: Warning, Error, Verbose, Any + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### Microsoft.Azure.Commands.Automation.Common.CompilationJobStreamType + +### System.Nullable`1[[System.DateTimeOffset, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.JobStream + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationDscCompilationJob](./Get-AzAutomationDscCompilationJob.md) + +[Start-AzAutomationDscCompilationJob](./Start-AzAutomationDscCompilationJob.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationDscConfiguration.md b/azps-10.1.0/Az.Automation/Get-AzAutomationDscConfiguration.md new file mode 100644 index 0000000000..e2479a55fc --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationDscConfiguration.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: BBD37C4B-BB6F-4560-BDEE-F0440EC1938A +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationdscconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscConfiguration.md +--- + +# Get-AzAutomationDscConfiguration + +## SYNOPSIS +Gets DSC configurations from Automation. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationDscConfiguration [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByConfigurationName +``` +Get-AzAutomationDscConfiguration [-Name] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationDscConfiguration** cmdlet gets APS Desired State Configuration (DSC) configurations from Azure Automation. + +## EXAMPLES + +### Example 1: Get all DSC configurations +```powershell +Get-AzAutomationDscConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" +``` + +This command gets metadata for all DSC configurations in the Automation account named Contoso17. + +### Example 2: Get a DSC configuration by name +```powershell +Get-AzAutomationDscConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "ContosoConfiguration" +``` + +This command gets metadata for a DSC configuration named MyConfiguration in the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains DSC configurations that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the DSC configuration that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ByConfigurationName +Aliases: ConfigurationName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet gets DSC configurations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.DscConfiguration + +## NOTES + +## RELATED LINKS + +[Export-AzAutomationDscConfiguration](./Export-AzAutomationDscConfiguration.md) + +[Import-AzAutomationDscConfiguration](./Import-AzAutomationDscConfiguration.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationDscNode.md b/azps-10.1.0/Az.Automation/Get-AzAutomationDscNode.md new file mode 100644 index 0000000000..43b8cfdedf --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationDscNode.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 6493186F-064B-45B7-8DFD-7799B1F2E5C9 +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationdscnode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscNode.md +--- + +# Get-AzAutomationDscNode + +## SYNOPSIS +Gets DSC nodes from Automation. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationDscNode [-Status ] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ById +``` +Get-AzAutomationDscNode -Id [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByName +``` +Get-AzAutomationDscNode [-Status ] -Name [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ByNodeConfiguration +``` +Get-AzAutomationDscNode [-Status ] -NodeConfigurationName [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ByConfiguration +``` +Get-AzAutomationDscNode -ConfigurationName [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationDscNode** cmdlet gets APS Desired State Configuration (DSC) nodes from Azure Automation. + +## EXAMPLES + +### Example 1: Get all DSC nodes +```powershell +Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" +``` + +This command gets metadata for all DSC nodes in the Automation account named Contoso17. + +### Example 2: Get all DSC nodes for a DSC configuration +```powershell +Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -ConfigurationName "ContosoConfiguration" +``` + +This command gets metadata for all DSC nodes in the Automation account named Contoso17 that are mapped to a DSC node configuration which was generated by DSC configuration ContosoConfiguration. + +### Example 3: Get a DSC node by ID +```powershell +Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Id c0a1718e-d8be-4fa3-91b6-82e1d3a36298 +``` + +This command gets metadata on a DSC node with the specified ID in the Automation account named Contoso17. + +### Example 4: Get a DSC node by name +```powershell +Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "Computer14" +``` + +This command gets metadata on a DSC node with the name Computer14 in the Automation account named Contoso17. + +### Example 5: Get all DSC nodes mapped to a DSC node configuration +```powershell +Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -NodeConfigurationName "ContosoConfiguration.webserver" +``` + +This command gets metadata on all DSC nodes in the Automation account named Contoso17 that are mapped to a DSC node configuration named ContosoConfiguration.webserver. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains the DSC nodes that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConfigurationName +Specifies the name of a DSC configuration. +This cmdlet gets DSC nodes that match the node configurations generated from the configuration that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByConfiguration +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the unique ID of the DSC node that this cmdlet gets. + +```yaml +Type: System.Guid +Parameter Sets: ById +Aliases: NodeId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a DSC node that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: NodeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeConfigurationName +Specifies the name of a node configuration that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ByNodeConfiguration +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet gets DSC nodes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +Specifies the status of the DSC nodes that this cmdlet gets. +Valid values are: +- Compliant +- NotCompliant +- Failed +- Pending +- Received +- Unresponsive + +```yaml +Type: Microsoft.Azure.Commands.Automation.Common.DscNodeStatus +Parameter Sets: ByAll, ByName, ByNodeConfiguration +Aliases: +Accepted values: Compliant, NotCompliant, Failed, Pending, Received, Unresponsive + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.DscNode + +## NOTES + +## RELATED LINKS + +[Register-AzAutomationDscNode](./Register-AzAutomationDscNode.md) + +[Set-AzAutomationDscNode](./Set-AzAutomationDscNode.md) + +[Unregister-AzAutomationDscNode](./Unregister-AzAutomationDscNode.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationDscNodeConfiguration.md b/azps-10.1.0/Az.Automation/Get-AzAutomationDscNodeConfiguration.md new file mode 100644 index 0000000000..e98d0c7b8f --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationDscNodeConfiguration.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 89C931AE-DA81-47A7-80E4-159C36497DA0 +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationdscnodeconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscNodeConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscNodeConfiguration.md +--- + +# Get-AzAutomationDscNodeConfiguration + +## SYNOPSIS +Gets metadata for DSC node configurations in Automation. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationDscNodeConfiguration [-RollupStatus ] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ByNodeConfigurationName +``` +Get-AzAutomationDscNodeConfiguration -Name [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ByConfigurationName +``` +Get-AzAutomationDscNodeConfiguration -ConfigurationName [-RollupStatus ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzAutomationDscNodeConfiguration** cmdlet gets metadata for APS Desired State Configuration (DSC) node configurations in Azure Automation. +Automation stores DSC node configuration as a Managed Object Format (MOF) configuration document. + +## EXAMPLES + +### Example 1: Get all DSC node configurations +```powershell +Get-AzAutomationDscNodeConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" +``` + +This command gets metadata for all DSC node configurations in the Automation account named Contoso17. + +### Example 2: Get all DSC node configurations for a DSC configuration +```powershell +Get-AzAutomationDscNodeConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -ConfigurationName "ContosoConfiguration" +``` + +This command gets metadata for all DSC node configurations in the Automation account named Contoso17 that the DSC configuration named ContosoConfiguration generated. + +### Example 3: Get a DSC node configuration by name +```powershell +Get-AzAutomationDscNodeConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "ContosoConfiguration.webserver" +``` + +This command gets metadata for a DSC node configuration with the name ContosoConfiguration.webserver in the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account that contains the DSC node configurations for which this cmdlet gets metadata. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConfigurationName +Specifies the name of DSC configuration for which this cmdlet gets node configuration metadata. + +```yaml +Type: System.String +Parameter Sets: ByConfigurationName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the DSC node configuration for which this cmdlet gets metadata. + +```yaml +Type: System.String +Parameter Sets: ByNodeConfigurationName +Aliases: NodeConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet gets metadata for DSC node configurations in the resource group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RollupStatus +Specifies the rollup status of DSC node configurations that this cmdlet gets. +Valid values are: +- Bad +- Good +*Bad: Non-Compliant* *Good: Compliant* +>[!NOTE] +> Even if one node is non-compliant, the overall state of the node configuration shows as bad. + +```yaml +Type: System.String +Parameter Sets: ByAll, ByConfigurationName +Aliases: +Accepted values: Good, Bad + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.CompilationJob + +## NOTES + +## RELATED LINKS + +[Import-AzAutomationDscNodeConfiguration](./Import-AzAutomationDscNodeConfiguration.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationDscNodeConfigurationDeployment.md b/azps-10.1.0/Az.Automation/Get-AzAutomationDscNodeConfigurationDeployment.md new file mode 100644 index 0000000000..8870261a8d --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationDscNodeConfigurationDeployment.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 32CF9BF7-519F-4B5D-9F2B-3CC556A77A48 +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationdscnodeconfigurationdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscNodeConfigurationDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscNodeConfigurationDeployment.md +--- + +# Get-AzAutomationDscNodeConfigurationDeployment + +## SYNOPSIS +Gets DSC Node configuration deployments in Automation. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationDscNodeConfigurationDeployment [-Status ] [-StartTime ] + [-EndTime ] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByJobId +``` +Get-AzAutomationDscNodeConfigurationDeployment -JobId [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationDscNodeConfigurationDeployment** cmdlet deploys an APS Desired State Configuration (DSC) node configuration in Azure Automation. + +## EXAMPLES + +### Example 1: Get a node configuration deployment + + + +```powershell +$deployment = Get-AzAutomationDscNodeConfigurationDeployment ` + -JobId 35b14eb4-52b7-4a1d-ad62-8e9f84adc657 ` + -AutomationAccountName "Contoso01" ` + -ResourceGroupName "ResourceGroup01" + +ResourceGroupName : ResourceGroup01 +AutomationAccountName : Contoso01 +JobId : 35b14eb4-52b7-4a1d-ad62-8e9f84adc657 +Job : Microsoft.Azure.Commands.Automation.Model.Job +JobStatus : Running +NodeStatus : {System.Collections.Generic.Dictionary`2[System.String,System.String], System.Collections.Generic.Dictionary`2[System.String,System.String]} +NodeConfigurationName : Config01.Node1 +JobSchedule : +JobScheduleId : 00000000-0000-0000-0000-000000000000 + +$deployment | Select-Object -ExpandProperty nodeStatus + +Key Value +--- ----- +WebServer Pending +WebServer2 Pending +WebServer3 Compliant +``` + +The above command deploys the DSC node configuration named "Config01.Node1" to the given two-dimensional array of Node Names. The deployment happens in a staged manner. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +End time filter. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: ByAll +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId +Specifies the Job id of an existing deployment job. + +```yaml +Type: System.Guid +Parameter Sets: ByJobId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet compiles a configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +Start time filter. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: ByAll +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Status of the Job filter. + +```yaml +Type: System.String +Parameter Sets: ByAll +Aliases: +Accepted values: Completed, Failed, Queued, Starting, Resuming, Running, Stopped, Stopping, Suspended, Suspending, Activating + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeployment + +## NOTES + +## RELATED LINKS + +[Start-AzAutomationDscCompilationJob](./Start-AzAutomationDscCompilationJob.md) + +[Import-AzAutomationDscNodeConfiguration](./Import-AzAutomationDscNodeConfiguration.md) + +[Start-AzAutomationDscNodeConfigurationDeployment](./Start-AzAutomationDscNodeConfigurationDeployment.md) + +[Stop-AzAutomationDscNodeConfigurationDeployment](./Stop-AzAutomationDscNodeConfigurationDeployment.md) + +[Get-AzAutomationDscNodeConfigurationDeploymentSchedule](./Get-AzAutomationDscNodeConfigurationDeploymentSchedule.md) diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationDscNodeConfigurationDeploymentSchedule.md b/azps-10.1.0/Az.Automation/Get-AzAutomationDscNodeConfigurationDeploymentSchedule.md new file mode 100644 index 0000000000..0df088d7c4 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationDscNodeConfigurationDeploymentSchedule.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 32CF9BF7-519F-4B5D-9F2B-3CC556A77A48 +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationdscnodeconfigurationdeploymentschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscNodeConfigurationDeploymentSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscNodeConfigurationDeploymentSchedule.md +--- + +# Get-AzAutomationDscNodeConfigurationDeploymentSchedule + +## SYNOPSIS +Gets a DSC Node configuration deployment job schedule in Automation. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationDscNodeConfigurationDeploymentSchedule [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ByJobScheduleId +``` +Get-AzAutomationDscNodeConfigurationDeploymentSchedule -JobScheduleId [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationDscNodeConfigurationDeployment** cmdlet deploys an APS Desired State Configuration (DSC) node configuration in Azure Automation. + +## EXAMPLES + +### Example 1: Get all the deployment schedules +```powershell +Get-AzAutomationDscNodeConfigurationDeploymentSchedule ` + -AutomationAccountName "Contoso01" ` + -ResourceGroupName "ResourceGroup01" +``` + +```output +ResourceGroupName : ResourceGroup01 +AutomationAccountName : Contoso01 +JobScheduleId : 2b1d7738-093d-4ff7-b87b-e4b2321319e5 +JobSchedule : Microsoft.Azure.Commands.Automation.Model.JobSchedule +RunbookName : Deploy-NodeConfigurationToAutomationDscNodesV1 + +ResourceGroupName : ResourceGroup01 +AutomationAccountName : Contoso01 +JobScheduleId : e347dfc4-62fe-4ed6-adfb-55518c57b558 +JobSchedule : Microsoft.Azure.Commands.Automation.Model.JobSchedule +RunbookName : Deploy-NodeConfigurationToAutomationDscNodesV1 +``` + +### Example 2: Get a deployment schedule + + + +```powershell +$js = Get-AzAutomationDscNodeConfigurationDeploymentSchedule ` + -AutomationAccountName "Contoso01" ` + -ResourceGroupName "ResourceGroup01" ` + -JobScheduleId 2b1d7738-093d-4ff7-b87b-e4b2321319e5 +$js + +ResourceGroupName : ResourceGroup01 +AutomationAccountName : Contoso01 +JobScheduleId : 2b1d7738-093d-4ff7-b87b-e4b2321319e5 +JobSchedule : Microsoft.Azure.Commands.Automation.Model.JobSche +RunbookName : Deploy-NodeConfigurationToAutomationDscNodesV1 + +$js.JobSchedule + +ResourceGroupName : ResourceGroup01 +RunOn : +AutomationAccountName : Contoso01 +JobScheduleId : 2b1d7738-093d-4ff7-b87b-e4b2321319e5 +RunbookName : Deploy-NodeConfigurationToAutomationDscNodesV1 +ScheduleName : TestScheduleName +Parameters : {AutomationAccountName, NodeConfigurationName, ResourceGroupName, ListOfNodeNames} +HybridWorker : +``` + +The above command deploys the DSC node configuration named "Config01.Node1" to the given two-dimensional array of Node Names. The deployment happens in a staged manner. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobScheduleId +Specifies the Job Schedule id of an existing scheduled deployment job. + +```yaml +Type: System.Guid +Parameter Sets: ByJobScheduleId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet compiles a configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeploymentSchedule + +## NOTES + +## RELATED LINKS + +[Start-AzAutomationDscCompilationJob](./Start-AzAutomationDscCompilationJob.md) + +[Import-AzAutomationDscNodeConfiguration](./Import-AzAutomationDscNodeConfiguration.md) + +[Start-AzAutomationDscNodeConfigurationDeployment](./Start-AzAutomationDscNodeConfigurationDeployment.md) + +[Stop-AzAutomationDscNodeConfigurationDeployment](./Stop-AzAutomationDscNodeConfigurationDeployment.md) + +[Get-AzAutomationDscNodeConfigurationDeployment](./Get-AzAutomationDscNodeConfigurationDeployment.md) diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationDscNodeReport.md b/azps-10.1.0/Az.Automation/Get-AzAutomationDscNodeReport.md new file mode 100644 index 0000000000..5e190f93ba --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationDscNodeReport.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 1246C3AC-A123-4EA1-B99E-458A85789109 +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationdscnodereport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscNodeReport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscNodeReport.md +--- + +# Get-AzAutomationDscNodeReport + +## SYNOPSIS +Gets reports sent from a DSC node to Automation. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationDscNodeReport -NodeId [-StartTime ] [-EndTime ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +### ByLatest +``` +Get-AzAutomationDscNodeReport -NodeId [-Latest] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ById +``` +Get-AzAutomationDscNodeReport -NodeId -Id [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationDscNodeReport** cmdlet gets reports sent from an APS Desired State Configuration (DSC) node to Azure Automation. + +## EXAMPLES + +### Example 1: Get all reports for a DSC node +```powershell +$Node = Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "Computer14" +Get-AzAutomationDscNodeReport -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -NodeId $Node.Id +``` + +The first command gets the DSC node for the computer named Computer14 in the Automation account named Contoso17. +The command stores this object in the $Node variable. +The second command gets metadata for all reports sent from the DSC node named Computer14 to the Automation account named Contoso17. +The command specifies the node by using the **Id** property of the $Node object. + +### Example 2: Get a report for a DSC node by report ID +```powershell +$Node = Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "Computer14" +Get-AzAutomationDscNodeReport -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -NodeId $Node.Id -Id c0a1718e-d8be-4fa3-91b6-82e1d3a36298 +``` + +The first command gets the DSC node for the computer named Computer14 in the Automation account named Contoso17. +The command stores this object in the $Node variable. +The second command gets metadata for the report identified by the specified ID sent from the DSC node named Computer14 to the Automation account named Contoso17. + +### Example 3: Get the latest report for a DSC node +```powershell +$Node = Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "Computer14" +Get-AzAutomationDscNodeReport -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -NodeId $Node.Id -Latest +``` + +The first command gets the DSC node for the computer named Computer14 in the Automation account named Contoso17. +The command stores this object in the $Node variable. +The second command gets metadata for the latest report sent from the DSC node named Computer14 to the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account. +This cmdlet exports reports for a DSC node that belongs to the account that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +Specifies an end time. +This cmdlet gets reports that Automation received before this time. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: ByAll +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id +Specifies the unique ID of the DSC node report for this cmdlet to get. + +```yaml +Type: System.Guid +Parameter Sets: ById +Aliases: ReportId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Latest +Indicates that this cmdlet gets the latest DSC report for the specified node only. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByLatest +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeId +Specifies the unique ID of the DSC node for which this cmdlet gets reports. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains the DSC node for which this cmdlet gets reports. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +Specifies a start time. +This cmdlet gets reports that Automation received after this time. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: ByAll +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.Nullable`1[[System.DateTimeOffset, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.DscNode + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationDscNode](./Get-AzAutomationDscNode.md) + +[Export-AzAutomationDscNodeReportContent](./Export-AzAutomationDscNodeReportContent.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationDscOnboardingMetaconfig.md b/azps-10.1.0/Az.Automation/Get-AzAutomationDscOnboardingMetaconfig.md new file mode 100644 index 0000000000..973540aa3c --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationDscOnboardingMetaconfig.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: FB331566-AC13-4751-A600-3A0E576308C7 +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationdsconboardingmetaconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscOnboardingMetaconfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationDscOnboardingMetaconfig.md +--- + +# Get-AzAutomationDscOnboardingMetaconfig + +## SYNOPSIS +Creates meta-configuration .mof files. + +## SYNTAX + +``` +Get-AzAutomationDscOnboardingMetaconfig [-OutputFolder ] [-ComputerName ] [-Force] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Get-AzAutomationDscOnboardingMetaconfig** cmdlet creates APS Desired State Configuration (DSC) meta-configuration Managed Object Format (MOF) files. +This cmdlet creates a .mof file for each computer name that you specify. +The cmdlet creates a folder for the .mof files. +You can run the Set-DscLocalConfigurationManager cmdlet for this folder to onboard these computers into an Azure Automation account as DSC nodes. + +## EXAMPLES + +### Example 1: Onboard servers to Automation DSC +```powershell +Get-AzAutomationDscOnboardingMetaconfig -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -ComputerName "Server01", "Server02" -OutputFolder "C:\Users\PattiFuller\Desktop" +Set-DscLocalConfigurationManager -Path "C:\Users\PattiFuller\Desktop\DscMetaConfigs" -ComputerName "Server01", "Server02" +``` + +The first command creates DSC meta-configuration files for two servers for the Automation account named Contoso17. +The command saves these files on a desktop. +The second command uses the **Set-DscLocalConfigurationManager** cmdlet to apply the meta-configuration to the specified computers to onboard them as DSC nodes. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account. +You can onboard the computers that the *ComputerName* parameter specifies to the account that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ComputerName +Specifies an array of names of computers for which this cmdlet generates .mof files. +If you do not specify this parameter, the cmdlet generates an .mof file for the current computer (localhost). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without prompting you for confirmation, and to replace existing .mof files that have the same name. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFolder +Specifies the name of a folder where this cmdlet stores .mof files. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet creates .mof files to onboard computers in the resource group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.DscOnboardingMetaconfig + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationHybridRunbookWorker.md b/azps-10.1.0/Az.Automation/Get-AzAutomationHybridRunbookWorker.md new file mode 100644 index 0000000000..c0837b4853 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationHybridRunbookWorker.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationhybridrunbookworker +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationHybridRunbookWorker.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationHybridRunbookWorker.md +--- + +# Get-AzAutomationHybridRunbookWorker + +## SYNOPSIS +Gets a Hybrid Runbook Worker. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationHybridRunbookWorker [-HybridRunbookWorkerGroupName] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ByName +``` +Get-AzAutomationHybridRunbookWorker [-Name] [-HybridRunbookWorkerGroupName] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzAutomationHybridRunbookWorker** cmdlet gets a Hybrid Runbook Worker. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAutomationHybridRunbookWorker -AutomationAccountName "Contoso17" -Name "RunbookWorkerName" -ResourceGroupName "ResourceGroup01" +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridRunbookWorkerGroupName +The Hybrid Runbook Worker Group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WorkerGroup, RunbookWorkerGroup + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Hybrid Runbook Worker name + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: RunbookWorker, RunbookWorkerId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Automation.Models.HybridRunbookWorker + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationHybridRunbookWorkerGroup.md b/azps-10.1.0/Az.Automation/Get-AzAutomationHybridRunbookWorkerGroup.md new file mode 100644 index 0000000000..a83c0875c0 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationHybridRunbookWorkerGroup.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationhybridrunbookworkergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationHybridRunbookWorkerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationHybridRunbookWorkerGroup.md +--- + +# Get-AzAutomationHybridRunbookWorkerGroup + +## SYNOPSIS +Gets a Hybrid Runbook Worker Group. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationHybridRunbookWorkerGroup [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByName +``` +Get-AzAutomationHybridRunbookWorkerGroup [-Name] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationHybridRunbookWorkerGroup** cmdlet gets a Hybrid Runbook Worker Group. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAutomationHybridRunbookWorkerGroup -AutomationAccountName "Contoso17" -Name "RunbookWorkerGroupName" -ResourceGroupName "ResourceGroup01" +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Hybrid Runbook Worker Group name + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: WorkerGroup, RunbookWorkerGroup + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Automation.Models.HybridRunbookWorkerGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationHybridWorkerGroup.md b/azps-10.1.0/Az.Automation/Get-AzAutomationHybridWorkerGroup.md new file mode 100644 index 0000000000..170c56949d --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationHybridWorkerGroup.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 9B0BBBB4-A7A0-4243-9264-362A00F5B399 +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationhybridworkergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationHybridWorkerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationHybridWorkerGroup.md +--- + +# Get-AzAutomationHybridWorkerGroup + +## SYNOPSIS +Gets hybrid runbook worker groups. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationHybridWorkerGroup [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByName +``` +Get-AzAutomationHybridWorkerGroup [[-Name] ] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationHybridWorkerGroup** cmdlet gets Azure Automation hybrid runbook worker groups. +To get a specific group, specify its name. + +## EXAMPLES + +### Example 1: Get all hybrid runbook worker groups +```powershell +Get-AzAutomationHybridWorkerGroup -ResourceGroupName "ResourceGroupName01" -AutomationAccountName "Contoso17" +``` + +This command gets all hybrid runbook worker groups in the Automation account named Contoso17. + +### Example 2: Get a single hybrid runbook worker group +```powershell +Get-AzAutomationHybridWorkerGroup -ResourceGroupName "ResourceGroupName01" -AutomationAccountName "Contoso17" -Name "HybridRunbookWorkerGroup01" +``` + +This command gets the hybrid runbook worker group named HybridRunbookWorkerGroup01 in the Automation account named Contoso17. + +### Example 3: Get the workers in a hybrid runbook worker group +```powershell +(Get-AzAutomationHybridWorkerGroup -ResourceGroupName "ResourceGroupName01" -AutomationAccountName "Contoso17" -Name "HybridRunbookWorkerGroup01").RunbookWorker +``` + +This command gets the hybrid runbook workers in the hybrid runbook worker group named HybridRunbookWorkerGroup01 in the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the hybrid runbook worker group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: Group + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.HybridRunbookWorkerGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationJob.md b/azps-10.1.0/Az.Automation/Get-AzAutomationJob.md new file mode 100644 index 0000000000..f3b1c37bf2 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationJob.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: BD32B909-296B-4E46-A24F-6E2BD4B9764B +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationJob.md +--- + +# Get-AzAutomationJob + +## SYNOPSIS +Gets Automation runbook jobs. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationJob [-Status ] [-StartTime ] [-EndTime ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +### ByJobId +``` +Get-AzAutomationJob -Id [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByRunbookName +``` +Get-AzAutomationJob -RunbookName [-Status ] [-StartTime ] + [-EndTime ] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationJob** cmdlet gets runbook jobs in Azure Automation. + +## EXAMPLES + +### Example 1: Get a specific runbook job +```powershell +Get-AzAutomationJob -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b647 +``` + +This command gets the job that has the specified GUID. + +### Example 2: Get all jobs for a runbook +```powershell +Get-AzAutomationJob -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -RunbookName "Runbook02" +``` + +This command gets all jobs associated with a runbook named Runbook02. + +### Example 3: Get all running jobs +```powershell +Get-AzAutomationJob -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -Status "Running" +``` + +This command gets all running jobs in the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account for which this cmdlet gets jobs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +Specifies the end time for a job as a **DateTimeOffset** object. +You can specify a string that can be converted to a valid **DateTimeOffset**. +This cmdlet gets jobs that have an end time at or before the value that this parameter specifies. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: ByAll, ByRunbookName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of a job that this cmdlet gets. + +```yaml +Type: System.Guid +Parameter Sets: ByJobId +Aliases: JobId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet gets jobs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunbookName +Specifies the name of a runbook for which this cmdlet gets jobs. + +```yaml +Type: System.String +Parameter Sets: ByRunbookName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies the start time of a job as a **DateTimeOffset** object. +This cmdlet gets jobs that have a start time at or after the value that this parameter specifies. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: ByAll, ByRunbookName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Specifies the status of a job. +This cmdlet gets jobs that have a status matching this parameter. +Valid values are: +- Activating +- Completed +- Failed +- Queued +- Resuming +- Running +- Starting +- Stopped +- Stopping +- Suspended +- Suspending + +```yaml +Type: System.String +Parameter Sets: ByAll, ByRunbookName +Aliases: +Accepted values: Completed, Failed, Queued, Starting, Resuming, Running, Stopped, Stopping, Suspended, Suspending, Activating + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Job + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationJobOutput](./Get-AzAutomationJobOutput.md) + +[Resume-AzAutomationJob](./Resume-AzAutomationJob.md) + +[Stop-AzAutomationJob](./Stop-AzAutomationJob.md) + +[Suspend-AzAutomationJob](./Suspend-AzAutomationJob.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationJobOutput.md b/azps-10.1.0/Az.Automation/Get-AzAutomationJobOutput.md new file mode 100644 index 0000000000..0647931e00 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationJobOutput.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: B39C4D6B-392A-4C8D-A6FB-886DA1A2BA58 +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationjoboutput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationJobOutput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationJobOutput.md +--- + +# Get-AzAutomationJobOutput + +## SYNOPSIS +Gets the output of an Automation job. + +## SYNTAX + +``` +Get-AzAutomationJobOutput [-Id] [-Stream ] [-StartTime ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzAutomationJobOutput** cmdlet gets the output of an Azure Automation job. + +## EXAMPLES + +### Example 1: Get the output of an Automation job +```powershell +Get-AzAutomationJobOutput -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 -ResourceGroupName "ResourceGroup01" -Stream "Any" +``` + +This command gets all of the output of the job that has the specified ID. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account for which this cmdlet gets job output. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of a job for which this cmdlet gets output. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: JobId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet gets job output. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +Specifies a start time as a **DateTimeOffset** object. +You can specify a string that can be converted to a valid **DateTimeOffset**. +The cmdlet retrieves output created after this time. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Stream +Specifies the type of output. +Valid values are: +- Any +- Debug +- Error +- Output +- Progress +- Verbose +- Warning + +```yaml +Type: Microsoft.Azure.Commands.Automation.Common.StreamType +Parameter Sets: (All) +Aliases: +Accepted values: Any, Progress, Output, Warning, Error, Verbose + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### Microsoft.Azure.Commands.Automation.Common.StreamType + +### System.Nullable`1[[System.DateTimeOffset, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.JobStream + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationJob](./Get-AzAutomationJob.md) + +[Resume-AzAutomationJob](./Resume-AzAutomationJob.md) + +[Stop-AzAutomationJob](./Stop-AzAutomationJob.md) + +[Suspend-AzAutomationJob](./Suspend-AzAutomationJob.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationJobOutputRecord.md b/azps-10.1.0/Az.Automation/Get-AzAutomationJobOutputRecord.md new file mode 100644 index 0000000000..f3ec4e3fb9 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationJobOutputRecord.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 38BB4F4E-B72B-460E-8DF2-2A7A9CACDB41 +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationjoboutputrecord +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationJobOutputRecord.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationJobOutputRecord.md +--- + +# Get-AzAutomationJobOutputRecord + +## SYNOPSIS +Gets the full output of an Automation job output record. + +## SYNTAX + +``` +Get-AzAutomationJobOutputRecord [-JobId] [-Id] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationJobOutputRecord** cmdlet gets the full output of an Automation job output record. +Although the **Get-AzAutomationJobOutput** cmdlet lists one or more job output records, it returns only a summary, as a string, of the value of any output record. +It does not return the full value of an output record's outputted value in its original type. +In addition, the summary has a maximum length, which the full value that this cmdlet outputs may exceed. + +## EXAMPLES + +### Example 1: Get the full output of an Automation job +```powershell +Get-AzAutomationJobOutput -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 -ResourceGroupName "ResourceGroup01" -Stream "Any" | Get-AzAutomationJobOutputRecord +``` + +This command gets the full output of the job that has the specified job ID. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account for which this cmdlet gets a job output record. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of a job output record for this cmdlet to retrieve. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StreamRecordId + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of a job for which this cmdlet gets an output record. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet gets a job output record. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.JobStreamRecord + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationJobOutput](./Get-AzAutomationJobOutput.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationModule.md b/azps-10.1.0/Az.Automation/Get-AzAutomationModule.md new file mode 100644 index 0000000000..a322dfce28 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationModule.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: A73B388A-E859-40D3-BA63-0E231CF1E81D +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationmodule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationModule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationModule.md +--- + +# Get-AzAutomationModule + +## SYNOPSIS +Gets metadata for modules from Automation. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationModule [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByName +``` +Get-AzAutomationModule [-Name] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationModule** cmdlet gets metadata for modules from Azure Automation. + +## EXAMPLES + +### Example 1: Get all modules +```powershell +Get-AzAutomationModule -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" +``` + +This command gets all modules in the Automation account named Contoso17. + +### Example 2: Get a module +```powershell +Get-AzAutomationModule -AutomationAccountName "Contoso17" -Name "ContosoModule" -ResourceGroupName "ResourceGroup01" +``` + +This command gets a module named ContosoModule in the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account for which this cmdlet gets module metadata. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the module for which this cmdlet gets metadata. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet gets module metadata. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Module + +## NOTES + +## RELATED LINKS + +[New-AzAutomationModule](./New-AzAutomationModule.md) + +[Remove-AzAutomationModule](./Remove-AzAutomationModule.md) + +[Set-AzAutomationModule](./Set-AzAutomationModule.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationPython3Package.md b/azps-10.1.0/Az.Automation/Get-AzAutomationPython3Package.md new file mode 100644 index 0000000000..7602892434 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationPython3Package.md @@ -0,0 +1,98 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationpython3package +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationPython3Package.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationPython3Package.md +--- + +# Get-AzAutomationPython3Package + +## SYNOPSIS +Gets a Python3 Package. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationPython3Package [-ResourceGroupName] [-AutomationAccountName] +``` + +### ByName +``` +Get-AzAutomationPython3Package [-Name] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationPython3Package** cmdlet gets a Python3 Package or list of Python3 Packages in Automation Account. + +## EXAMPLES + +### Example 1 +```powershell +New-AzAutomationPython3Package -AutomationAccountName "Contoso17" -Name "RunbookWorkerName" -ResourceGroupName "ResourceGroup01" -ErrorAction SilentlyContinue +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The Python3 Package name. + +```yaml +Type: String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Module + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationRegistrationInfo.md b/azps-10.1.0/Az.Automation/Get-AzAutomationRegistrationInfo.md new file mode 100644 index 0000000000..7ee113c5ac --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationRegistrationInfo.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 09823BE3-A98B-42EF-B6F4-99F95F2B342E +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationregistrationinfo +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationRegistrationInfo.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationRegistrationInfo.md +--- + +# Get-AzAutomationRegistrationInfo + +## SYNOPSIS +Gets registration information for onboarding a DSC node or hybrid worker to Automation. + +## SYNTAX + +``` +Get-AzAutomationRegistrationInfo [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationRegistrationInfo** cmdlet gets the endpoint and keys required to onboard a Desired State Configuration (DSC) node or hybrid worker into an Azure Automation account. + +## EXAMPLES + +### Example 1: Get registration information +```powershell +Get-AzAutomationRegistrationInfo -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" +``` + +This command gets the registration information for the Automation account named AutomationAccount01 in the Resource Group named ResourceGroup01. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of Automation account for which this cmdlet gets registration information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet gets registration information for the resource group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.AgentRegistration + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationAccount](./Get-AzAutomationAccount.md) + +[Get-AzAutomationDscNode](./Get-AzAutomationDscNode.md) + +[New-AzAutomationKey](./New-AzAutomationKey.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationRunbook.md b/azps-10.1.0/Az.Automation/Get-AzAutomationRunbook.md new file mode 100644 index 0000000000..899ab1c0e0 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationRunbook.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: EDB918EA-4FF3-44EF-A4CA-5BFBD14340EA +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationrunbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationRunbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationRunbook.md +--- + +# Get-AzAutomationRunbook + +## SYNOPSIS +Gets a runbook. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationRunbook [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByRunbookName +``` +Get-AzAutomationRunbook [-Name] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationRunbook** cmdlet gets Azure Automation runbooks. +To get a specific runbook, specify its name. + +## EXAMPLES + +### Example 1: Get all runbooks +```powershell +Get-AzAutomationRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" +``` + +This command gets all runbooks in the Azure Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account in which this cmdlet gets runbooks. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a runbook that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ByRunbookName +Aliases: RunbookName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet gets runbooks. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Runbook + +## NOTES + +## RELATED LINKS + +[Export-AzAutomationRunbook](./Export-AzAutomationRunbook.md) + +[Import-AzAutomationRunbook](./Import-AzAutomationRunbook.md) + +[New-AzAutomationRunbook](./New-AzAutomationRunbook.md) + +[New-AzAutomationRunbook](./New-AzAutomationRunbook.md) + +[Publish-AzAutomationRunbook](./Publish-AzAutomationRunbook.md) + +[Remove-AzAutomationRunbook](./Remove-AzAutomationRunbook.md) + +[Set-AzAutomationRunbook](./Set-AzAutomationRunbook.md) + +[Start-AzAutomationRunbook](./Start-AzAutomationRunbook.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationSchedule.md b/azps-10.1.0/Az.Automation/Get-AzAutomationSchedule.md new file mode 100644 index 0000000000..f6f3a13127 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationSchedule.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 2908890B-7A46-41B7-931F-AE94638D1EDF +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSchedule.md +--- + +# Get-AzAutomationSchedule + +## SYNOPSIS +Gets an Automation schedule. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationSchedule [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByName +``` +Get-AzAutomationSchedule [-Name] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationSchedule** cmdlet gets an Azure Automation schedule. + +## EXAMPLES + +### Example 1: Get a schedule +```powershell +Get-AzAutomationSchedule -AutomationAccountName "Contoso17" -Name "DailySchedule08" -ResourceGroupName "ResourceGroup01" +``` + +This command gets the schedule named DailySchedule08. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account for which this cmdlet get a schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a schedule that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ScheduleName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet gets a schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Schedule + +## NOTES + +## RELATED LINKS + +[New-AzAutomationSchedule](./New-AzAutomationSchedule.md) + +[Remove-AzAutomationSchedule](./Remove-AzAutomationSchedule.md) + +[Set-AzAutomationSchedule](./Set-AzAutomationSchedule.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationScheduledRunbook.md b/azps-10.1.0/Az.Automation/Get-AzAutomationScheduledRunbook.md new file mode 100644 index 0000000000..777d9f31e4 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationScheduledRunbook.md @@ -0,0 +1,197 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: EE854F8A-4B6B-4831-992A-6EC318BEE234 +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationscheduledrunbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationScheduledRunbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationScheduledRunbook.md +--- + +# Get-AzAutomationScheduledRunbook + +## SYNOPSIS +Gets Automation runbooks and associated schedules. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationScheduledRunbook [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByJobScheduleId +``` +Get-AzAutomationScheduledRunbook -JobScheduleId [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ByRunbookName +``` +Get-AzAutomationScheduledRunbook -RunbookName [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ByRunbookNameAndScheduleName +``` +Get-AzAutomationScheduledRunbook -RunbookName -ScheduleName [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ByScheduleName +``` +Get-AzAutomationScheduledRunbook -ScheduleName [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationScheduledRunbook** cmdlet gets one or more Azure Automation runbooks and associated schedules. +By default, this cmdlet gets all scheduled runbooks. +Specify the name of a runbook or a schedule or both to see specific runbook schedules. + +## EXAMPLES + +### Example 1: Get all scheduled runbooks +```powershell +Get-AzAutomationScheduledRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" +``` + +This command gets all scheduled runbooks in the Azure Automation account named Contoso17. + +### Example 2: Get all schedules associated with a runbook +```powershell +Get-AzAutomationScheduledRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -RunbookName "Runbk01" +``` + +This command gets all scheduled runbooks for the runbook Runbk01 in the Azure Automation account named Contoso17. + +### Example 3: Get all runbooks associated with a schedule +```powershell +Get-AzAutomationScheduledRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -ScheduleName "Schedule01" +``` + +This command gets all scheduled runbooks for the schedule Schedule01 in the Azure Automation account named Contoso17. + +### Example 4: Get Parameters given to a particular Scheduled Runbook + +```powershell +Get-AzAutomationScheduledRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -JobScheduleId "2b1d7738-093d-4ff7-b87b-e4b2321319e5" +``` + +This is currently not supported for jobs created with complex parameters (for example - array) through Azure portal. + +## PARAMETERS + +### -AutomationAccountName +Specifies an Automation account for the runbook on which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobScheduleId +Specifies the ID of a scheduled job that this cmdlet gets. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: ByJobScheduleId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for scheduled runbooks that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunbookName +Specifies the name of a runbook for which this cmdlet gets scheduled runbooks. + +```yaml +Type: System.String +Parameter Sets: ByRunbookName, ByRunbookNameAndScheduleName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScheduleName +Specifies the name of a schedule for which this cmdlet gets scheduled runbooks. + +```yaml +Type: System.String +Parameter Sets: ByRunbookNameAndScheduleName, ByScheduleName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.JobSchedule + +## NOTES + +## RELATED LINKS + +[Register-AzAutomationScheduledRunbook](./Register-AzAutomationScheduledRunbook.md) + +[Unregister-AzAutomationScheduledRunbook](./Unregister-AzAutomationScheduledRunbook.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationSoftwareUpdateConfiguration.md b/azps-10.1.0/Az.Automation/Get-AzAutomationSoftwareUpdateConfiguration.md new file mode 100644 index 0000000000..90549cca7d --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationSoftwareUpdateConfiguration.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationsoftwareupdateconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSoftwareUpdateConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSoftwareUpdateConfiguration.md +--- + +# Get-AzAutomationSoftwareUpdateConfiguration + +## SYNOPSIS +Gets a list of azure automation software update configurations. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationSoftwareUpdateConfiguration [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByName +``` +Get-AzAutomationSoftwareUpdateConfiguration -Name [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ByVMId +``` +Get-AzAutomationSoftwareUpdateConfiguration -AzureVMResourceId [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzAutomationSoftwareUpdateConfiguration returns a list of software update configurations. To get a specific software update configuration, specify the name parameter. You can also list software update configurations targeting specific azure virtual machine by specifying the azure resource Id for this virtual machine. + +## EXAMPLES + +### Example 1 +Get an azure automation software update configuration by name. + +```powershell +Get-AzAutomationSoftwareUpdateConfiguration -ResourceGroupName "mygroup" -AutomationAccountName "myaccount" -Name "MyWeeklySchedule" +``` + +```output +UpdateConfiguration : Microsoft.Azure.Commands.Automation.Model.UpdateManagement.UpdateConfiguration +ScheduleConfiguration : Microsoft.Azure.Commands.Automation.Model.Schedule +ProvisioningState : Succeeded +ErrorInfo : +ResourceGroupName : mygroup +AutomationAccountName : myaccount +Name : MyWeeklySchedule +CreationTime : 9/14/2018 3:53:27 AM +00:00 +LastModifiedTime : 9/14/2018 3:53:37 AM +00:00 +Description : +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureVMResourceId +Azure resource Id of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: ByVMId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the software update configuration. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationSoftwareUpdateMachineRun.md b/azps-10.1.0/Az.Automation/Get-AzAutomationSoftwareUpdateMachineRun.md new file mode 100644 index 0000000000..00261429bc --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationSoftwareUpdateMachineRun.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationsoftwareupdatemachinerun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSoftwareUpdateMachineRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSoftwareUpdateMachineRun.md +--- + +# Get-AzAutomationSoftwareUpdateMachineRun + +## SYNOPSIS +Gets a list of azure automation software update configuration machine runs. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationSoftwareUpdateMachineRun [-Status ] [-TargetComputer ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +### ById +``` +Get-AzAutomationSoftwareUpdateMachineRun -Id [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### BySucrId +``` +Get-AzAutomationSoftwareUpdateMachineRun [-SoftwareUpdateRunId ] + [-Status ] [-TargetComputer ] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### BySucr +``` +Get-AzAutomationSoftwareUpdateMachineRun [-SoftwareUpdateRun ] + [-Status ] [-TargetComputer ] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +This cmdlet returns a list of machine runs. Each software update run will trigger a machine run for each of the software update configuration target machine. To get a specific machine run, pass the Id parameter. You can list all the machine runs, all runs for a specific computer, all runs with specific status by passing the corresponding parameters. + +## EXAMPLES + +### Example 1 +This example returns all failed machine runs for the specified azure virtual machine. + + +```powershell +$targetComputer = "/subscriptions/22e2445a-0984-4fa5-86a4-0280d76c4b2c/resourceGroups/compute/providers/Microsoft.Compute/virtualMachines/myvm" +Get-AzAutomationSoftwareUpdateMachineRun -ResourceGroupName "mygroup" ` + -AutomationAccountName "myaccount" ` + -TargetComputer $targetComputer ` + -Status Failed +``` + +```output +MachineRunId : 0033d6d6-828d-4712-adab-293cc4fc8809 +TargetComputer : /subscriptions/22e2445a-0984-4fa5-86a4-0280d76c4b2c/resourceGroups/compute/providers/Microsoft.Compute/virtualMachines/myvm +TargetComputerType : AzureVirtualMachines +SoftwareUpdateRunId : 46568d26-0182-49b2-8bfd-af3455780397 +OperatingSystem : Windows +Status : Failed +ResourceGroupName : mygroup +AutomationAccountName : myaccount +Name : 0033d6d6-828d-4712-adab-293cc4fc8809 +CreationTime : 5/17/2018 2:06:44 AM +00:00 +LastModifiedTime : 5/17/2018 2:08:49 AM +00:00 +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of the software update machine run. + +```yaml +Type: System.Guid +Parameter Sets: ById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SoftwareUpdateRun +The software update run. + +```yaml +Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateRun +Parameter Sets: BySucr +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SoftwareUpdateRunId +Id of the software update run. + +```yaml +Type: System.Guid +Parameter Sets: BySucrId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +Status of the machine run. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateMachineRunStatus] +Parameter Sets: ByAll, BySucrId, BySucr +Aliases: +Accepted values: NotStarted, InProgress, Succeeded, Failed, MaintenanceWindowExceeded, FailedToStart + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetComputer +target computer for the machine run. +Can be either a non-az computer name or an azure VM resource id. + +```yaml +Type: System.String +Parameter Sets: ByAll, BySucrId, BySucr +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateRun + +### System.Nullable`1[[Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateMachineRunStatus, Microsoft.Azure.PowerShell.Cmdlets.Automation, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateMachineRun + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationSoftwareUpdateRun.md b/azps-10.1.0/Az.Automation/Get-AzAutomationSoftwareUpdateRun.md new file mode 100644 index 0000000000..c47ccb75c0 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationSoftwareUpdateRun.md @@ -0,0 +1,253 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationsoftwareupdaterun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSoftwareUpdateRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSoftwareUpdateRun.md +--- + +# Get-AzAutomationSoftwareUpdateRun + +## SYNOPSIS +Gets a list of azure automation software update runs. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationSoftwareUpdateRun [-OperatingSystem ] [-Status ] + [-StartTime ] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ById +``` +Get-AzAutomationSoftwareUpdateRun -Id [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### BySucName +``` +Get-AzAutomationSoftwareUpdateRun [-SoftwareUpdateConfigurationName ] + [-OperatingSystem ] [-Status ] [-StartTime ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +### BySuc +``` +Get-AzAutomationSoftwareUpdateRun [-SoftwareUpdateConfiguration ] + [-OperatingSystem ] [-Status ] [-StartTime ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The Get-AzAutomationSoftwareUpdateRun cmdlet returns a list of software update runs. Since a software update configuration has an associated schedule, it can be triggered multiple times. Each time a schedule is triggered will result in an update run created. Update run is an aggregate of the result of all machine runs. You can get runs for specific software update configuration by passing the SoftwareUpdateConfigurationName parameter. To get a specific runs, you need to pass the name parameter. You can also list runs with specific status, runs targeting specific operating system, or runs started after specific time by passing the appropriate parameter. + +## EXAMPLES + +### Example 1 +This example list all update runs triggered by a specific software update configuration. + +```powershell +Get-AzAutomationSoftwareUpdateRun -ResourceGroupName "mygroup" ` + -AutomationAccountName "myaccount" ` + -SoftwareUpdateConfigurationName "MyUpdateConfiguration" +``` + +```output +RunId : ec9ce57f-da18-44be-b33b-651a0f93cb52 +SoftwareUpdateConfigurationName : MyUpdateConfiguration +ConfiguredDuration : 02:00:00 +OperatingSystem : Windows +StartTime : 5/22/2018 11:37:42 PM +00:00 +EndTime : 5/22/2018 11:38:31 PM +00:00 +ComputerCount : 2 +FailedCount : 0 +ResourceGroupName : mygroup +AutomationAccountName : myaccount +Name : ec9ce57f-da18-44be-b33b-651a0f93cb52 +CreationTime : 5/22/2018 11:37:42 PM +00:00 +LastModifiedTime : 5/22/2018 11:38:54 PM +00:00 +Description : + +RunId : ac9396c7-a837-43d4-be97-fbfe46c80baa +SoftwareUpdateConfigurationName : MyUpdateConfiguration +ConfiguredDuration : 02:00:00 +OperatingSystem : Windows +StartTime : 5/22/2018 10:00:47 PM +00:00 +EndTime : 5/22/2018 10:02:20 PM +00:00 +ComputerCount : 2 +FailedCount : 0 +ResourceGroupName : mygroup +AutomationAccountName : myaccount +Name : ac9396c7-a837-43d4-be97-fbfe46c80baa +CreationTime : 5/22/2018 10:00:47 PM +00:00 +LastModifiedTime : 5/22/2018 10:02:58 PM +00:00 +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of the software update configuration run. + +```yaml +Type: System.Guid +Parameter Sets: ById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OperatingSystem +The operating system of the run. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Automation.Model.UpdateManagement.OperatingSystemType] +Parameter Sets: ByAll, BySucName, BySuc +Aliases: +Accepted values: Windows, Linux + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SoftwareUpdateConfiguration +The software update configuration triggered the run. + +```yaml +Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateConfiguration +Parameter Sets: BySuc +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SoftwareUpdateConfigurationName +Name of the software update configuration triggered the run. + +```yaml +Type: System.String +Parameter Sets: BySucName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +Minimum start time of the run. + +```yaml +Type: System.DateTimeOffset +Parameter Sets: ByAll, BySucName, BySuc +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +Status of the run. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateRunStatus] +Parameter Sets: ByAll, BySucName, BySuc +Aliases: +Accepted values: NotStarted, InProgress, Succeeded, Failed, MaintenanceWindowExceeded + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateConfiguration + +### System.Nullable`1[[Microsoft.Azure.Commands.Automation.Model.UpdateManagement.OperatingSystemType, Microsoft.Azure.PowerShell.Cmdlets.Automation, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +### System.Nullable`1[[Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateRunStatus, Microsoft.Azure.PowerShell.Cmdlets.Automation, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +### System.DateTimeOffset + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateRun + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationSourceControl.md b/azps-10.1.0/Az.Automation/Get-AzAutomationSourceControl.md new file mode 100644 index 0000000000..476bd8261a --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationSourceControl.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationsourcecontrol +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSourceControl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSourceControl.md +--- + +# Get-AzAutomationSourceControl + +## SYNOPSIS +Gets a list of Azure Automation source controls. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationSourceControl [-SourceType ] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ByName +``` +Get-AzAutomationSourceControl -Name [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzAutomationSourceControl cmdlet gets Automation source controls. +To get a specific source control, specify its name. + +## EXAMPLES + +### Example 1 +This command gets an Automation source control named VSTSNative in the account named devAccount. + + +```powershell +Get-AzAutomationSourceControl -ResourceGroupName "rg1" ` + -AutomationAccountName "devAccount" ` + -Name "VSTSNative" +``` + +```output +Name SourceType Branch FolderPath AutoSync PublishRunbook RepoUrl +---- ---------- ------ ---------- -------- -------------- ------- +VSTSNative VsoTfvc /MyRunbooks False True https://contoso.visualstudio.com/_git/Fin... +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The source control name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceType +The source control type. + +```yaml +Type: System.String +Parameter Sets: ByAll +Aliases: +Accepted values: GitHub, VsoGit, VsoTfvc + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.SourceControl + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationSourceControlSyncJob.md b/azps-10.1.0/Az.Automation/Get-AzAutomationSourceControlSyncJob.md new file mode 100644 index 0000000000..7ac42103c3 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationSourceControlSyncJob.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationsourcecontrolsyncjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSourceControlSyncJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSourceControlSyncJob.md +--- + +# Get-AzAutomationSourceControlSyncJob + +## SYNOPSIS +Gets Azure Automation source control sync jobs. + +## SYNTAX + +``` +Get-AzAutomationSourceControlSyncJob -SourceControlName [-JobId ] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzAutomationSourceControlSyncJob cmdlet gets Azure Automation source control sync jobs. To get a specific source control sync job, specify its id. + +## EXAMPLES + +### Example 1 +This command gets all the Automation source control sync jobs for the source control VSTSNative. + + +```powershell +Get-AzAutomationSourceControlSyncJob -ResourceGroupName "rg1" ` + -AutomationAccountName "devAccount" ` + -Name "VSTSNative" +``` + +```output +SourceControlSyncJobId SyncType Status StartTime EndTime +---------------------- -------- ------ --------- ------- +08d6d266-27b6-463c-beea-bc48a67ace15 FullSync Failed 08/15/2018 09:17 AM 08/15/2018 09:18 AM +b566d564-878a-4641-8c44-25bf7850531e FullSync Failed 08/15/2018 09:09 AM 08/15/2018 09:10 AM +``` + +### Example 2 +This command gets the source control sync job with id 08d6d266-27b6-463c-beea-bc48a67ace15 +for the source control VSTSNative. + + +```powershell +Get-AzAutomationSourceControlSyncJob -ResourceGroupName "rg1" ` + -AutomationAccountName "devAccount" ` + -Name "VSTSNative" ` + -JobId "08d6d266-27b6-463c-beea-bc48a67ace15" +``` + +```output +Status SyncType Exception +------ -------- --------- +Failed FullSync There were errors while syncing the user runbooks. Please see error streams for more information. (T... +``` + +### Example 3 + +Gets Azure Automation source control sync jobs. (autogenerated) + + + + +```powershell +Get-AzAutomationSourceControlSyncJob -AutomationAccountName 'devAccount' -JobId 00000000-0000-0000-0000-00000000000000000 -ResourceGroupName 'rg1' -SourceControlName 'VSTSNative' +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId +The source control sync job id. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: SourceControlSyncJobId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceControlName +The source control name of the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.SourceControlSyncJob + +### Microsoft.Azure.Commands.Automation.Model.SourceControlSyncJobRecord + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationSourceControlSyncJobOutput.md b/azps-10.1.0/Az.Automation/Get-AzAutomationSourceControlSyncJobOutput.md new file mode 100644 index 0000000000..74e8601b00 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationSourceControlSyncJobOutput.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationsourcecontrolsyncjoboutput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSourceControlSyncJobOutput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationSourceControlSyncJobOutput.md +--- + +# Get-AzAutomationSourceControlSyncJobOutput + +## SYNOPSIS +Gets the output of an Azure Automation source control sync job. + +## SYNTAX + +``` +Get-AzAutomationSourceControlSyncJobOutput -SourceControlName -JobId + [-Stream ] [-StreamId ] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationSourceControlSyncJobOutput** cmdlet gets the output for a Azure Automation source control sync job. + +## EXAMPLES + +### Example 1 +This command gets the output of source control sync job with id 08d6d266-27b6-463c-beea-bc48a67ace15 for the source control VSTSNative. + + +```powershell +Get-AzAutomationSourceControlSyncJobOutput -ResourceGroupName "rg1" ` + -AutomationAccountName "devAccount" ` + -SourceControlName "VSTSNative" ` + -JobId "08d6d266-27b6-463c-beea-bc48a67ace15" ` + -Stream Output | ForEach-Object {$_.summary} +``` + +```output +Azure Automation Source Control Public Preview. +Supported runbooks to sync: PowerShell Workflow, PowerShell Scripts, DSC Configurations, Graphical, and Python 2. +Setting AzureRmEnvironment. +Getting AzureRunAsConnection. +Logging in to Azure... +Source control information for syncing: +[RepoUrl = https://contoso.visualstudio.com/_git/GitDemo] [Branch = master] [FolderPath = /] +Verifying url: https://fcontoso.visualstudio.com/_git/GitDemo +Connecting to VSTS... + +Source Control Sync Summary: + +2 files synced: + - RunbookA.ps1 + - RunbookB.ps1 + +Failed to import runbook: + - RunbookC.ps1 + +File is not a runbook: + - README.md + - text_file.txt + +File size exceeds 1Mb: + - RunbookD_GreatherThan1MB.ps1 + +Invalid runbook name: + - RunbookZ_ĈĦŕĬŞ.ps1 +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId +The source control sync job id. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: SourceControlSyncJobId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceControlName +The source control name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Stream +The stream type. +Defaults to Any. + +```yaml +Type: Microsoft.Azure.Commands.Automation.Common.SourceControlSyncJobStreamType +Parameter Sets: (All) +Aliases: +Accepted values: Any, Output, Error + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StreamId +The stream id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SourceControlSyncJobStreamId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +### Microsoft.Azure.Commands.Automation.Common.SourceControlSyncJobStreamType + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.SourceControlSyncJobStream + +### Microsoft.Azure.Commands.Automation.Model.SourceControlSyncJobStreamRecord + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationVariable.md b/azps-10.1.0/Az.Automation/Get-AzAutomationVariable.md new file mode 100644 index 0000000000..303920d9a7 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationVariable.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 8FB78A4A-8392-44EE-A907-10FDF756071B +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationvariable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationVariable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationVariable.md +--- + +# Get-AzAutomationVariable + +## SYNOPSIS +Gets an Automation variable. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationVariable [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByName +``` +Get-AzAutomationVariable [-Name] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationVariable** cmdlet gets one or more Azure Automation variables. +To get a specific variable, specify its name. + +## EXAMPLES + +### Example 1: Get a variable +```powershell +$Variable = Get-AzAutomationVariable -AutomationAccountName "Contoso17" -Name "Variable06" -ResourceGroupName "ResourceGroup01" +$Value = $Variable.value +``` + +The first command gets an Automation variable named Variable06 in the account named Contoso17. +The command stores that object in the $Variable variable. +The second command uses standard dot notation to refer to the **value** property of $Variable. +The command stores the value in the $value variable. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains the variables that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a variable that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group for which this cmdlet gets variables. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Variable + +## NOTES + +## RELATED LINKS + +[New-AzAutomationVariable](./New-AzAutomationVariable.md) + +[Remove-AzAutomationVariable](./Remove-AzAutomationVariable.md) + +[Set-AzAutomationVariable](./Set-AzAutomationVariable.md) + + diff --git a/azps-10.1.0/Az.Automation/Get-AzAutomationWebhook.md b/azps-10.1.0/Az.Automation/Get-AzAutomationWebhook.md new file mode 100644 index 0000000000..540a26c228 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Get-AzAutomationWebhook.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: A0A956E9-6C4F-4432-A39F-A180CD519C04 +online version: https://learn.microsoft.com/powershell/module/az.automation/get-azautomationwebhook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationWebhook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Get-AzAutomationWebhook.md +--- + +# Get-AzAutomationWebhook + +## SYNOPSIS +Gets webhooks from Automation. + +## SYNTAX + +### ByAll (Default) +``` +Get-AzAutomationWebhook [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByName +``` +Get-AzAutomationWebhook -Name [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByRunbookName +``` +Get-AzAutomationWebhook -RunbookName [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzAutomationWebhook** cmdlet gets webhooks. +To get specific webhooks, specify a webhook name or specify the name of an Azure Automation runbook to get the webhooks connected to it.
+**Note:** The WebhookUri is returned as empty string due to security concerns. Please make sure to save the webhook URL that **New-AzAutomationWebhook** cmdlet returns, because it cannot be retrieved by using **Get-AzAutomationWebhook**. + +## EXAMPLES + +### Example 1: Get all webhooks for a runbook +```powershell +Get-AzAutomationWebhook -RunbookName "Runbook03" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" +``` + +This command gets all webhooks for a runbook named Runbook03 in the Automation account named AutomationAccount01 in the resource group named ResourceGroup01. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account in which this cmdlet gets a webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the webhook that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: WebhookName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet gets webhooks. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunbookName +Specifies the name of a runbook for which this cmdlet gets webhooks. + +```yaml +Type: System.String +Parameter Sets: ByRunbookName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Webhook + +## NOTES + +## RELATED LINKS + +[New-AzAutomationWebhook](./New-AzAutomationWebhook.md) + +[Remove-AzAutomationWebhook](./Remove-AzAutomationWebhook.md) + +[Set-AzAutomationWebhook](./Set-AzAutomationWebhook.md) + + diff --git a/azps-10.1.0/Az.Automation/Import-AzAutomationDscConfiguration.md b/azps-10.1.0/Az.Automation/Import-AzAutomationDscConfiguration.md new file mode 100644 index 0000000000..d4df4eefb7 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Import-AzAutomationDscConfiguration.md @@ -0,0 +1,241 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: BA508F0B-847F-4531-9D5D-A5A044A2D207 +online version: https://learn.microsoft.com/powershell/module/az.automation/import-azautomationdscconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Import-AzAutomationDscConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Import-AzAutomationDscConfiguration.md +--- + +# Import-AzAutomationDscConfiguration + +## SYNOPSIS +Imports a DSC configuration into Automation. + +## SYNTAX + +``` +Import-AzAutomationDscConfiguration -SourcePath [-Tags ] [-Description ] + [-Published] [-Force] [-LogVerbose ] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Import-AzAutomationDscConfiguration** cmdlet imports an APS Desired State Configuration (DSC) configuration into Azure Automation. +Specify the path of an APS script that contains a single DSC configuration. + +## EXAMPLES + +### Example 1: Import a DSC configuration into Automation +```powershell +Import-AzAutomationDscConfiguration -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -SourcePath "C:\DSC\client.ps1" -Force +``` + +This command imports the DSC configuration in the file named client.ps1 into the Automation account +named Contoso17. The command specifies the *Force* parameter. If there is an existing DSC +configuration, this command replaces it. + +### Example 2 + +Imports a DSC configuration into Automation. (autogenerated) + + + + +```powershell +Import-AzAutomationDscConfiguration -AutomationAccountName 'Contoso17' -Published -ResourceGroupName 'ResourceGroup01' -SourcePath 'C:\DSC\client.ps1' +``` + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account into which this cmdlet imports a DSC configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description of the configuration that this cmdlet imports. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet replaces an existing DSC configuration in Automation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogVerbose +Specifies whether this cmdlet turns verbose logging on or off for compilation jobs of this DSC +configuration. Specify a value of $True to turn verbose logging on or $False to turn it off. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Published +Indicates that this cmdlet imports the DSC configuration in the published state. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet imports a DSC configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourcePath +Specifies the path of the wps_2 script that contains the DSC configuration that this cmdlet imports. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Path + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tags +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.IDictionary + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.DscConfiguration + +## NOTES + +## RELATED LINKS + +[Export-AzAutomationDscConfiguration](./Export-AzAutomationDscConfiguration.md) + +[Get-AzAutomationDscConfiguration](./Get-AzAutomationDscConfiguration.md) diff --git a/azps-10.1.0/Az.Automation/Import-AzAutomationDscNodeConfiguration.md b/azps-10.1.0/Az.Automation/Import-AzAutomationDscNodeConfiguration.md new file mode 100644 index 0000000000..dc0805d030 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Import-AzAutomationDscNodeConfiguration.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: CC9D74BB-DFB2-41F3-B5CF-B265C549EC33 +online version: https://learn.microsoft.com/powershell/module/az.automation/import-azautomationdscnodeconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Import-AzAutomationDscNodeConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Import-AzAutomationDscNodeConfiguration.md +--- + +# Import-AzAutomationDscNodeConfiguration + +## SYNOPSIS +Imports a MOF document as a DSC node configuration in Automation. + +## SYNTAX + +``` +Import-AzAutomationDscNodeConfiguration -Path -ConfigurationName [-Force] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-IncrementNodeConfigurationBuild] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Import-AzAutomationDscConfiguration** cmdlet imports a Managed Object Format (MOF) configuration document into Azure Automation as a Desired State Configuration (DSC) node configuration. +Specify the path of a .mof file. + +## EXAMPLES + +### Example 1: Import a DSC node configuration into Automation +```powershell +Import-AzAutomationDscNodeConfiguration -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -ConfigurationName "ContosoConfiguration" -Path "C:\DSC\webserver.mof" -Force +``` + +This command imports a DSC node configuration from the file named webserver.mof into the Automation account named Contoso17, under the DSC configuration ContosoConfiguration. +The command specifies the *Force* parameter. +If there is an existing DSC node configuration named ContosoConfiguration.webserver, this command replaces it. + +### Example 2: Import a DSC node configuration into Automation and create a new build version and not overwrite existing NodeConfiguration. +```powershell +Import-AzAutomationDscNodeConfiguration -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -ConfigurationName "ContosoConfiguration" -Path "C:\DSC\webserver.mof" -IncrementNodeConfigurationBuild +``` + +This command imports a DSC node configuration from the file named webserver.mof into the Automation account named Contoso17, under the DSC configuration ContosoConfiguration. +The command specifies the *Force* parameter. +If there is an existing DSC node configuration named ContosoConfiguration.webserver, this command adds a new build version with the name ContosoConfiguration[2].webserver. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account into which this cmdlet imports a DSC node configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConfigurationName +Specifies the name of a DSC configuration in Automation to use as the namespace and container for the node configuration to import. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet replaces an existing DSC node configuration in Automation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncrementNodeConfigurationBuild +Creates a new Node Configuration build version. + +```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 +``` + +### -Path +Specifies the path of the MOF configuration document that this cmdlet imports. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet imports a DSC node configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.NodeConfiguration + +## NOTES + +## RELATED LINKS + +[Export-AzAutomationDscConfiguration](./Export-AzAutomationDscConfiguration.md) + +[Get-AzAutomationDscConfiguration](./Get-AzAutomationDscConfiguration.md) + + diff --git a/azps-10.1.0/Az.Automation/Import-AzAutomationRunbook.md b/azps-10.1.0/Az.Automation/Import-AzAutomationRunbook.md new file mode 100644 index 0000000000..e21be7f914 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Import-AzAutomationRunbook.md @@ -0,0 +1,309 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: B6487D26-2B6A-4938-B1CD-48EADD8D0C3C +online version: https://learn.microsoft.com/powershell/module/az.automation/import-azautomationrunbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Import-AzAutomationRunbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Import-AzAutomationRunbook.md +--- + +# Import-AzAutomationRunbook + +## SYNOPSIS +Imports an Automation runbook. + +## SYNTAX + +``` +Import-AzAutomationRunbook [-Path] [-Description ] [-Name ] [-Tags ] + -Type [-LogProgress ] [-LogVerbose ] [-Published] [-Force] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Import-AzAutomationRunbook** cmdlet imports an Azure Automation runbook. Specify the +path to a wps_2 script (.ps1) file to import for wps_2 and wps_2 Workflow runbooks, +(.graphrunbook) file for graphical runbooks, or (.py) file for python 2 runbooks. +For wps_2 Workflow runbooks, the script must contain a single wps_2 Workflow definition that matches the name of the file. + +## EXAMPLES + +### Example 1: Import a runbook from a file +```powershell +$Tags = @{"tag01"="value01"; "tag02"="value02"} +Import-AzAutomationRunbook -Path .\GraphicalRunbook06.graphrunbook -Tags $Tags -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Type GraphicalPowershell +``` + +The first command assigns two key/value pairs to the $Tags variable. +The second command imports a graphical runbook called GraphicalRunbook06 into the Automation account named AutomationAccount01. +The command also assigns the tags stored in $Tags. + +### Example 2 + +Imports an Automation runbook. (autogenerated) + + + + +```powershell +Import-AzAutomationRunbook -AutomationAccountName 'AutomationAccount01' -Name 'Configuration01' -Path .\GraphicalRunbook06.graphrunbook -Published -ResourceGroupName 'ResourceGroup01' -Type PowerShell +``` + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account into which this cmdlet imports a runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the imported runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogProgress +Specifies whether the runbook logs progress information. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LogVerbose +Specifies whether the runbook logs detailed information. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the runbook that this cmdlet imports. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the path of a .ps1 or .graphrunbook file that this cmdlet imports. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SourcePath + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Published +Indicates that this cmdlet publishes the runbook that it imports. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet imports a runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tags +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Specifies the type of runbook that this cmdlet creates. +Valid values are: +- PowerShell +- GraphicalPowerShell +- PowerShellWorkflow +- GraphicalPowerShellWorkflow +- Graph +- Python2 +The value Graph is obsolete. +It is equivalent to GraphicalPowerShellWorkflow. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: PowerShell, GraphicalPowerShell, PowerShellWorkflow, GraphicalPowerShellWorkflow, Graph, Python2 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.IDictionary + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Runbook + +## NOTES + +## RELATED LINKS + +[Export-AzAutomationRunbook](./Export-AzAutomationRunbook.md) + +[Get-AzAutomationRunbook](./Get-AzAutomationRunbook.md) + +[New-AzAutomationRunbook](./New-AzAutomationRunbook.md) + +[Publish-AzAutomationRunbook](./Publish-AzAutomationRunbook.md) + +[Remove-AzAutomationRunbook](./Remove-AzAutomationRunbook.md) + +[Set-AzAutomationRunbook](./Set-AzAutomationRunbook.md) + +[Start-AzAutomationRunbook](./Start-AzAutomationRunbook.md) diff --git a/azps-10.1.0/Az.Automation/Move-AzAutomationHybridRunbookWorker.md b/azps-10.1.0/Az.Automation/Move-AzAutomationHybridRunbookWorker.md new file mode 100644 index 0000000000..c43200025c --- /dev/null +++ b/azps-10.1.0/Az.Automation/Move-AzAutomationHybridRunbookWorker.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/move-azautomationhybridrunbookworker +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Move-AzAutomationHybridRunbookWorker.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Move-AzAutomationHybridRunbookWorker.md +--- + +# Move-AzAutomationHybridRunbookWorker + +## SYNOPSIS +Moves a runbook worker from one runbook worker group to the other. + +## SYNTAX + +``` +Move-AzAutomationHybridRunbookWorker [-Name] [-HybridRunbookWorkerGroupName] + -TargetHybridRunbookWorkerGroupName [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Move-AzAutomationHybridRunbookWorker** cmdlet moves a runbook worker from one runbook worker group to the other. + +## EXAMPLES + +### Example 1 +```powershell +Move-AzAutomationHybridRunbookWorker -AutomationAccountName "Contoso17" -Name "RunbookWorkerName" -HybridRunbookWorkerGroupName "RunbookWorkerGroupName" -TargetHybridRunbookWorkerGroupName "TargetHybridRunbookWorkerGroupName" -ResourceGroupName "contosoRG" +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridRunbookWorkerGroupName +The hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookWorkerGroup, WorkerGroup + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Hybrid Runbook Worker name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookWorker, RunbookWorkerId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetHybridRunbookWorkerGroupName +The target hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TargetRunbookWorkerGroup, TargetWorkerGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Automation.Models.HybridRunbookWorker + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationAccount.md b/azps-10.1.0/Az.Automation/New-AzAutomationAccount.md new file mode 100644 index 0000000000..77d2f5a59d --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationAccount.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 2D5B16F0-0662-4D9F-A13F-808CE5EEBBA3 +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationAccount.md +--- + +# New-AzAutomationAccount + +## SYNOPSIS +Creates an Automation account. + +## SYNTAX + +``` +New-AzAutomationAccount [-ResourceGroupName] [-Name] [-Location] [-Plan ] + [-Tags ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzAutomationAccount** cmdlet creates an Azure Automation account in a resource group. +An Automation account is a container for Automation resources that is isolated from the resources +of other Automation accounts. Automation resources include runbooks, Desired State Configuration +(DSC) configurations, jobs, and assets. + +## EXAMPLES + +### Example 1: Create an automation account +```powershell +New-AzAutomationAccount -Name "ContosoAutomationAccount" -Location "East US" -ResourceGroupName "ResourceGroup01" +``` + +This command creates a new automation account named ContosoAutomationAccount in the East US region. + +### Example 2 + +Creates an Automation account. (autogenerated) + + + + +```powershell +New-AzAutomationAccount -Location 'East US' -Name 'ContosoAutomationAccount' -ResourceGroupName 'ResourceGroup01' -Tags +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location in which this cmdlet creates the Automation account. +To obtain valid locations, use the Get-AzLocation cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the Automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AutomationAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Plan +Specifies the plan for the Automation account. +Valid values are: +- Basic +- Free + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Free, Basic + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group to which this cmdlet adds an Automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tags +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.IDictionary + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.AutomationAccount + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationAccount](./Get-AzAutomationAccount.md) + +[Remove-AzAutomationAccount](./Remove-AzAutomationAccount.md) + +[Set-AzAutomationAccount](./Set-AzAutomationAccount.md) diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationCertificate.md b/azps-10.1.0/Az.Automation/New-AzAutomationCertificate.md new file mode 100644 index 0000000000..0bb31fc291 --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationCertificate.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: A504099E-BA96-45C9-A7A6-195E7087A0D4 +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationCertificate.md +--- + +# New-AzAutomationCertificate + +## SYNOPSIS +Creates an Automation certificate. + +## SYNTAX + +``` +New-AzAutomationCertificate [-Name] [-Description ] [-Password ] + [-Path] [-Exportable] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzAutomationCertificate** cmdlet creates a certificate in Azure Automation. +Provide the path to a certificate file to upload. + +## EXAMPLES + +### Example 1: Create a new certificate +```powershell +$Password = ConvertTo-SecureString -String "Password" -AsPlainText -Force +New-AzAutomationCertificate -AutomationAccountName "Contoso17" -Name "ContosoCertificate" -Path "./cert.pfx" -Password $Password -ResourceGroupName "ResourceGroup01" +``` + +The first command converts a plain text password to be a secure string by using the ConvertTo-SecureString cmdlet. +The command stores that object in the $Password variable. +The second command creates a certificate named ContosoCertificate. +The command uses the password stored in $Password. +The command specifies the account name and the path of the file that it uploads. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account for which this cmdlet stores the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Exportable +Specifies whether the certificate can be exported. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name for the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Password +Specifies the password for the certificate file. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the path to a script file that this cmdlet uploads. +The file can be a .cer or a .pfx file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet creates a certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Security.SecureString + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.CertificateInfo + +## NOTES + +This command should be run on a machine that you are an administrator of, as well as in an elevated PowerShell session; before the certificate is uploaded, this cmdlet uses the local X.509 store to retrieve the thumbprint and key, and if this cmdlet is run outside of an elevated PowerShell session, you will receive an "Access denied" error. + +## RELATED LINKS + +[Get-AzAutomationCertificate](./Get-AzAutomationCertificate.md) + +[Remove-AzAutomationCertificate](./Remove-AzAutomationCertificate.md) + +[Set-AzAutomationCertificate](./Set-AzAutomationCertificate.md) + + diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationConnection.md b/azps-10.1.0/Az.Automation/New-AzAutomationConnection.md new file mode 100644 index 0000000000..af1c523fa6 --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationConnection.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 95103160-8101-4C43-8DAA-0BD75DFF3150 +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationConnection.md +--- + +# New-AzAutomationConnection + +## SYNOPSIS +Creates an Automation connection. + +## SYNTAX + +``` +New-AzAutomationConnection [-Name] [-ConnectionTypeName] + [-ConnectionFieldValues] [-Description ] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzAutomationConnection** cmdlet creates a connection in Azure Automation. + +## EXAMPLES + +### Example 1: Create a connection for ConnectionTypeName=Azure +```powershell +$FieldValues = @{"AutomationCertificateName"="ContosoCertificate";"SubscriptionID"="81b59010-dc55-45b7-89cd-5ca26db62472"} +New-AzAutomationConnection -Name "Connection12" -ConnectionTypeName Azure -ConnectionFieldValues $FieldValues -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" +``` + +The first command assigns a hash table of field values to the $FieldValue variable. +The second command creates an Azure connection named Connection12 in the Automation account named AutomationAccount01. +The command uses the connection field values in $FieldValues. + +### Example 2: Create a connection for ConnectionTypeName=AzureServicePrincipal +```powershell +$Thumbprint = "0SZTNJ34TCCMUJ5MJZGR8XQD3S0RVHJBA33Z8ZXV" +$TenantId = "4cd76576-b611-43d0-8f2b-adcb139531bf" +$ApplicationId = "3794a65a-e4e4-493d-ac1d-f04308d712dd" +$SubscriptionId = "81b59010-dc55-45b7-89cd-5ca26db62472" +$RunAsAccountConnectionFieldValues = @{"ApplicationId" = $ApplicationId; "TenantId" = $TenantId; "CertificateThumbprint" = $Thumbprint; "SubscriptionId" = $SubscriptionId} +New-AzAutomationConnection -Name "Connection13" -ConnectionTypeName AzureServicePrincipal -ConnectionFieldValues $RunAsAccountConnectionFieldValues -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" +``` + +The command creates an Azure connection named Connection13 in the Automation account named AutomationAccount01 using $RunAsAccountConnectionFieldValues and ConnectionTypeName=AzureServicePrincipal. +This ConnectionTypeName=AzureServicePrincipal is mainly used for Azure Run As Account. + +### Example 3: Create a connection for ConnectionTypeName=AzureClassicCertificate +```powershell +$SubscriptionName = "MyTestSubscription" +$SubscriptionId = "81b59010-dc55-45b7-89cd-5ca26db62472" +$ClassicRunAsAccountCertifcateAssetName = "AzureClassicRunAsCertificate" +$ClassicRunAsAccountConnectionFieldValues = @{"SubscriptionName" = $SubscriptionName; "SubscriptionId" = $SubscriptionId; "CertificateAssetName" = $ClassicRunAsAccountCertifcateAssetName} +New-AzAutomationConnection -Name "Connection14" -ConnectionTypeName AzureClassicCertificate -ConnectionFieldValues $ClassicRunAsAccountConnectionFieldValues -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" +``` + +The command creates an Azure connection named Connection14 in the Automation account named AutomationAccount01 using $ClassicRunAsAccountConnectionFieldValues and ConnectionTypeName=AzureClassicCertificate. +This ConnectionTypeName=AzureClassicCertificate is mainly used for Azure Classic Run As Account. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account for which this cmdlet creates a connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConnectionFieldValues +Specifies a hash table that contains key/value pairs. +The keys represent the connection fields for the specified connection type. +The values represent the specific values of each connection field for the connection instance. + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConnectionTypeName +Specifies the name of the connection type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet creates a connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.IDictionary + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Connection + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationConnection](./Get-AzAutomationConnection.md) + +[Remove-AzAutomationConnection](./Remove-AzAutomationConnection.md) + + diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationCredential.md b/azps-10.1.0/Az.Automation/New-AzAutomationCredential.md new file mode 100644 index 0000000000..f3a31533cb --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationCredential.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 739EB137-E4A8-4E85-96BD-4CF26D2C5763 +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationCredential.md +--- + +# New-AzAutomationCredential + +## SYNOPSIS +Creates an Automation credential. + +## SYNTAX + +``` +New-AzAutomationCredential [-Name] [-Description ] [-Value] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **New-AzAutomationCredential** cmdlet creates a credential as a **PSCredential** object in Azure Automation. + +## EXAMPLES + +### Example 1: Create a credential +```powershell +$User = "Contoso\PFuller" +$Password = ConvertTo-SecureString "Password" -AsPlainText -Force +$Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $Password +New-AzAutomationCredential -AutomationAccountName "Contoso17" -Name "ContosoCredential" -Value $Credential -ResourceGroupName "ResourceGroup01" +``` + +The first command assigns a user name to the $User variable. +The second command converts a plain text password into a secure string by using the ConvertTo-SecureString cmdlet. +The command stores that object in the $Password variable. +The third command creates a credential based on $User and $Password, and then stores it in the $Credential variable. +The final command creates an Automation credential named ContosoCredential that uses $Credential. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account in which this cmdlet stores the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies a description for the resource group for which this cmdlet creates a credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Specifies the credentials as a **PSCredential** object. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.PSCredential + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.CredentialInfo + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationCredential](./Get-AzAutomationCredential.md) + +[Remove-AzAutomationCredential](./Remove-AzAutomationCredential.md) + +[Set-AzAutomationCredential](./Set-AzAutomationCredential.md) + + diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationHybridRunbookWorker.md b/azps-10.1.0/Az.Automation/New-AzAutomationHybridRunbookWorker.md new file mode 100644 index 0000000000..7be009c251 --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationHybridRunbookWorker.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationhybridrunbookworker +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationHybridRunbookWorker.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationHybridRunbookWorker.md +--- + +# New-AzAutomationHybridRunbookWorker + +## SYNOPSIS +Create a Runbook Worker. + +## SYNTAX + +``` +New-AzAutomationHybridRunbookWorker [-Name] [-HybridRunbookWorkerGroupName] + -VmResourceId [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **New-AzAutomationHybridRunbookWorker** cmdlet creates a Runbook Worker. + +## EXAMPLES + +### Example 1 +```powershell +New-AzAutomationHybridRunbookWorker -AutomationAccountName "Contoso17" -Name "RunbookWorkerName" -HybridRunbookWorkerGroupName "RunbookWorkerGroupName" -VmResourceId "VmResourceId" -ResourceGroupName "ResourceGroup01" +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridRunbookWorkerGroupName +The hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookWorkerGroup, WorkerGroup + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Hybrid Runbook Worker name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookWorker, RunbookWorkerId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VmResourceId +The resource id of the vm to be added to the hybrid worker group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VMId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Automation.Models.HybridRunbookWorker + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationHybridRunbookWorkerGroup.md b/azps-10.1.0/Az.Automation/New-AzAutomationHybridRunbookWorkerGroup.md new file mode 100644 index 0000000000..3cc0849ffb --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationHybridRunbookWorkerGroup.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationhybridrunbookworkergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationHybridRunbookWorkerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationHybridRunbookWorkerGroup.md +--- + +# New-AzAutomationHybridRunbookWorkerGroup + +## SYNOPSIS +Creates a Runbook Worker Group. + +## SYNTAX + +``` +New-AzAutomationHybridRunbookWorkerGroup [-Name] [-CredentialName ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **New-AzAutomationHybridRunbookWorkerGroup** cmdlet creates a new runbook worker group. + +## EXAMPLES + +### Example 1 +```powershell +New-AzAutomationHybridRunbookWorkerGroup -AutomationAccountName "Contoso17" -Name "RunbookWorkerGroupName" -ResourceGroupName "ResourceGroup01" +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CredentialName +The credential present in the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WorkerGroup, RunbookWorkerGroup + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Automation.Models.HybridRunbookWorkerGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationKey.md b/azps-10.1.0/Az.Automation/New-AzAutomationKey.md new file mode 100644 index 0000000000..481e341cab --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationKey.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 055526FA-5DB7-4F1D-81B3-5D9753283FE2 +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationKey.md +--- + +# New-AzAutomationKey + +## SYNOPSIS +Regenerates registration keys for an Automation account. + +## SYNTAX + +``` +New-AzAutomationKey [-KeyType] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzAutomationKey** cmdlet regenerates registration keys for an Azure Automation account. + +## EXAMPLES + +### Example 1: Regenerate a key for an Automation account +```powershell +New-AzAutomationKey -KeyType Primary -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" +``` + +This command regenerates the primary key for the Azure Automation account named AutomationAccount01 in the resource group named ResourceGroup01. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account for which this cmdlet regenerates keys. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyType +Specifies the type of the agent registration key. +Valid values are: +- Primary +- Secondary + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet regenerates keys for an Automation account in the resource group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.AgentRegistration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationModule.md b/azps-10.1.0/Az.Automation/New-AzAutomationModule.md new file mode 100644 index 0000000000..0286fb6074 --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationModule.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 2DC97415-D59A-428E-8FFE-56B17B320DAF +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationmodule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationModule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationModule.md +--- + +# New-AzAutomationModule + +## SYNOPSIS +Imports a module into Automation. + +## SYNTAX + +``` +New-AzAutomationModule [-Name] [-ContentLinkUri] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzAutomationModule** cmdlet imports a module into Azure Automation. +This command accepts a compressed file that has a .zip file name extension. +The file contains a folder that includes a file that is one of the following types: +- Windows PowerShell module, which has a .psm1 or .dll file name extension +- Windows PowerShell module manifest, which has a .psd1 file name extension +The name of the .zip file, the name of the folder, and the name of the file in the folder must be the same. +Specify the .zip file as a URL that the Automation service can access. +If you import a Windows PowerShell module into Automation by using this cmdlet or the Set-AzAutomationModule cmdlet, the operation is asynchronous. +The command finishes whether the import succeeds or fails. +To check whether it succeeded, run the following command: +`PS C:\\\> $ModuleInstance = Get-AzAutomationModule -Name `ModuleName +Check the **ProvisioningState** property for a value of Succeeded. + +## EXAMPLES + +### Example 1: Import a module +```powershell +New-AzAutomationModule -AutomationAccountName "Contoso17" -Name "ContosoModule" -ContentLink "http://contosostorage.blob.core.windows.net/modules/ContosoModule.zip" -ResourceGroupName "ResourceGroup01" +``` + +This command imports a module named ContosoModule into the Automation account named Contoso17. +The module is stored in an Azure blob in a storage account named contosostorage and a container named modules. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account for which this cmdlet imports a module. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContentLinkUri +The url to a module zip package + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: ContentLink + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the module that this cmdlet imports. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet imports a module. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Uri + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Module + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationModule](./Get-AzAutomationModule.md) + +[Remove-AzAutomationModule](./Remove-AzAutomationModule.md) + +[Set-AzAutomationModule](./Set-AzAutomationModule.md) + + diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationPython3Package.md b/azps-10.1.0/Az.Automation/New-AzAutomationPython3Package.md new file mode 100644 index 0000000000..c0da0dc65b --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationPython3Package.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationpython3package +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationPython3Package.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationPython3Package.md +--- + +# New-AzAutomationPython3Package + +## SYNOPSIS +Add Python3 Package to Automation account + +## SYNTAX + +``` +New-AzAutomationPython3Package [-Name] [-ContentLinkUri] [-ResourceGroupName] + [-AutomationAccountName] +``` + +## DESCRIPTION +The **New-AzAutomationPython3Package** cmdlet adds a Python3 Package to Automation Account. + +## EXAMPLES + +### Example 1 +```powershell +New-AzAutomationPython3Package -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -Name "Python3PackageName" -ContentLinkUri "https://packageURI.com/package.whl" +``` + + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContentLinkUri +The url to a Python3Package. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: ContentLink + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The Python3Package name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Uri + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Module + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationRunbook.md b/azps-10.1.0/Az.Automation/New-AzAutomationRunbook.md new file mode 100644 index 0000000000..2053bb8ada --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationRunbook.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: B6E35D4D-B2C1-4527-94A6-E7E3488F510B +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationrunbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationRunbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationRunbook.md +--- + +# New-AzAutomationRunbook + +## SYNOPSIS +Creates an Automation runbook. + +## SYNTAX + +``` +New-AzAutomationRunbook [-Name] [-Description ] [-Tags ] -Type + [-LogProgress ] [-LogVerbose ] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzAutomationRunbook** cmdlet creates an empty Azure Automation runbook by using APS. +Specify a name for the runbook. + +## EXAMPLES + +### Example 1: Create a runbook +```powershell +New-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbook02" -ResourceGroupName "ResourceGroup01" +``` + +This command creates a runbook named Runbook02 in the Azure Automation account named Contoso17. + +### Example 2 + +Creates an Automation runbook. (autogenerated) + + + + +```powershell +New-AzAutomationRunbook -AutomationAccountName 'Contoso17' -Name 'Runbook02' -ResourceGroupName 'ResourceGroup01' -Type PowerShell +``` + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account in which this cmdlet creates a runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LogProgress +Specifies whether the runbook logs progress. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LogVerbose +Specifies whether logging includes detailed information. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet creates a runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tags +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Specifies the type of runbook that this cmdlet creates. +Valid values are: +- PowerShell +- GraphicalPowerShell +- PowerShellWorkflow +- GraphicalPowerShellWorkflow +- Graph +- Python2 +The value Graph is obsolete. +It is equivalent to GraphicalPowerShellWorkflow. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: PowerShell, GraphicalPowerShell, PowerShellWorkflow, GraphicalPowerShellWorkflow, Graph, Python2 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.IDictionary + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Runbook + +## NOTES + +## RELATED LINKS + +[Export-AzAutomationRunbook](./Export-AzAutomationRunbook.md) + +[Get-AzAutomationRunbook](./Get-AzAutomationRunbook.md) + +[Import-AzAutomationRunbook](./Import-AzAutomationRunbook.md) + +[Publish-AzAutomationRunbook](./Publish-AzAutomationRunbook.md) + +[Remove-AzAutomationRunbook](./Remove-AzAutomationRunbook.md) + +[Set-AzAutomationRunbook](./Set-AzAutomationRunbook.md) + +[Start-AzAutomationRunbook](./Start-AzAutomationRunbook.md) diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationSchedule.md b/azps-10.1.0/Az.Automation/New-AzAutomationSchedule.md new file mode 100644 index 0000000000..64a3d13c51 --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationSchedule.md @@ -0,0 +1,430 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: CB621890-EF8A-4F14-8F18-D8806E624DAB +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationSchedule.md +--- + +# New-AzAutomationSchedule + +## SYNOPSIS +Creates an Automation schedule. + +## SYNTAX + +### ByDaily (Default) +``` +New-AzAutomationSchedule [-Name] [-StartTime] [-Description ] + [-ExpiryTime ] -DayInterval [-TimeZone ] [-ForUpdateConfiguration] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +### ByWeekly +``` +New-AzAutomationSchedule [-Name] [-StartTime] [-Description ] + [-DaysOfWeek ] [-ExpiryTime ] -WeekInterval [-TimeZone ] + [-ForUpdateConfiguration] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByMonthlyDaysOfMonth +``` +New-AzAutomationSchedule [-Name] [-StartTime] [-Description ] + [-DaysOfMonth ] [-ExpiryTime ] -MonthInterval [-TimeZone ] + [-ForUpdateConfiguration] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByMonthlyDayOfWeek +``` +New-AzAutomationSchedule [-Name] [-StartTime] [-Description ] + [-DayOfWeek ] [-DayOfWeekOccurrence ] [-ExpiryTime ] + -MonthInterval [-TimeZone ] [-ForUpdateConfiguration] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### ByOneTime +``` +New-AzAutomationSchedule [-Name] [-StartTime] [-Description ] [-OneTime] + [-TimeZone ] [-ForUpdateConfiguration] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByHourly +``` +New-AzAutomationSchedule [-Name] [-StartTime] [-Description ] + [-ExpiryTime ] -HourInterval [-TimeZone ] [-ForUpdateConfiguration] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **New-AzAutomationSchedule** cmdlet creates a schedule in Azure Automation. + +## EXAMPLES + +### Example 1: Create a one-time schedule in local time +```powershell +$TimeZone = ([System.TimeZoneInfo]::Local).Id +New-AzAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule01" -StartTime "23:00" -OneTime -ResourceGroupName "ResourceGroup01" -TimeZone $TimeZone +``` + +The first command gets the time zone ID from the system and stores it in the $TimeZone variable. +The second command creates a schedule that runs one time on the current date at 11:00 PM in the specified time zone. + +### Example 2: Create a one-time schedule in another time zone +```powershell +$TimeZone = "Europe/Paris" +New-AzAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule01" -StartTime "23:00Z" -OneTime -ResourceGroupName "ResourceGroup01" -TimeZone $TimeZone +``` + +The first command initializes a $TimeZone variable with value `Europe/Paris` +The second command creates a schedule that runs one time on the current date at 23:00 UTC in the specified time zone. +> Note: Schedule *StartTime* is calculated by adding the *TimeZone* Offset to provided *StartTime* + +### Example 3: Create a recurring schedule +```powershell +$StartTime = Get-Date "13:00:00" +$EndTime = $StartTime.AddYears(1) +New-AzAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule02" -StartTime $StartTime -ExpiryTime $EndTime -DayInterval 1 -ResourceGroupName "ResourceGroup01" +``` + +The first command creates a date object by using the **Get-Date** cmdlet, and then stores the object in the $StartDate variable. +Specify a time that is at least five minutes in the future. +The second command creates a date object by using the **Get-Date** cmdlet, and then stores the object in the $EndDate variable. +The command specifies a future time. +The final command creates a daily schedule named Schedule02 to begin at the time stored in $StartDate and expire at the time stored in $EndDate. + +### Example 4: Create a weekly recurring schedule +```powershell +$StartTime = (Get-Date "13:00:00").AddDays(1) +[System.DayOfWeek[]]$WeekDays = @([System.DayOfWeek]::Monday..[System.DayOfWeek]::Friday) +New-AzAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule03" -StartTime $StartTime -WeekInterval 1 -DaysOfWeek $WeekDays -ResourceGroupName "ResourceGroup01" +``` + +The first command creates a date object by using the **Get-Date** cmdlet, and then stores the object in the $StartDate variable. +The second command creates an array of week days that contains Monday, Tuesday, Wednesday, Thursday and Friday. +The final command creates a daily schedule named Schedule03 that will run Monday to Friday each week at 13:00. The schedule will never expire. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account for which this cmdlet creates a schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DayInterval +Specifies an interval, in days, for the schedule. +If you do not specify this parameter, and you do not specify the *OneTime* parameter, the default value is one (1). + +```yaml +Type: System.Byte +Parameter Sets: ByDaily +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DayOfWeek +Specifies a list of days of the week for the weekly schedule. + +```yaml +Type: System.Nullable`1[System.DayOfWeek] +Parameter Sets: ByMonthlyDayOfWeek +Aliases: +Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DayOfWeekOccurrence +Specifies the occurrence of the week within the month that the schedule runs. +psdx_paramvalues +- 1 +- 2 +- 3 +- 4 +- -1 +- First +- Second +- Third +- Fourth +- LastDay + +```yaml +Type: Microsoft.Azure.Commands.Automation.Cmdlet.DayOfWeekOccurrence +Parameter Sets: ByMonthlyDayOfWeek +Aliases: +Accepted values: First, Second, Third, Fourth, Last + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaysOfMonth +Specifies a list of days of the month for the monthly schedule. + +```yaml +Type: Microsoft.Azure.Commands.Automation.Cmdlet.DaysOfMonth[] +Parameter Sets: ByMonthlyDaysOfMonth +Aliases: +Accepted values: One, Two, Three, Four, Five, Six, Seventh, Eighth, Ninth, Tenth, Eleventh, Twelfth, Thirteenth, Fourteenth, Fifteenth, Sixteenth, Seventeenth, Eighteenth, Nineteenth, Twentieth, TwentyFirst, TwentySecond, TwentyThird, TwentyFourth, TwentyFifth, TwentySixth, TwentySeventh, TwentyEighth, TwentyNinth, Thirtieth, ThirtyFirst, LastDay + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaysOfWeek +Specifies a list of days of the week for the weekly schedule. + +```yaml +Type: System.DayOfWeek[] +Parameter Sets: ByWeekly +Aliases: +Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the expiry time of a schedule as a **DateTimeOffset** object. +You can specify a string that can be converted to a valid **DateTimeOffset**. + +```yaml +Type: System.DateTimeOffset +Parameter Sets: ByDaily, ByWeekly, ByMonthlyDaysOfMonth, ByMonthlyDayOfWeek, ByHourly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForUpdateConfiguration +Indicates that this schedule object will be used for scheduling a software update configuration + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HourInterval +Specifies an interval, in hours, for the schedule. + +```yaml +Type: System.Byte +Parameter Sets: ByHourly +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonthInterval +Specifies an interval, in Months, for the schedule. + +```yaml +Type: System.Byte +Parameter Sets: ByMonthlyDaysOfMonth, ByMonthlyDayOfWeek +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OneTime +Specifies that the cmdlet creates a one-time schedule. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByOneTime +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet creates a schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +Specifies the start time of a schedule as a **DateTimeOffset** object. +You can specify a string that can be converted to a valid **DateTimeOffset**. +If the *TimeZone* is provided, *StartTime* is calculated by adding the Offset of Input *TimeZone*. + +```yaml +Type: System.DateTimeOffset +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TimeZone +Specifies the time zone for the schedule. +This string can be the IANA ID or the Windows Time Zone ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WeekInterval +Specifies an interval, in weeks, for the schedule. + +```yaml +Type: System.Byte +Parameter Sets: ByWeekly +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.DateTimeOffset + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Schedule + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationSchedule](./Get-AzAutomationSchedule.md) + +[Remove-AzAutomationSchedule](./Remove-AzAutomationSchedule.md) + +[Set-AzAutomationSchedule](./Set-AzAutomationSchedule.md) + + diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationSoftwareUpdateConfiguration.md b/azps-10.1.0/Az.Automation/New-AzAutomationSoftwareUpdateConfiguration.md new file mode 100644 index 0000000000..21a0d504ea --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationSoftwareUpdateConfiguration.md @@ -0,0 +1,492 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationsoftwareupdateconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationSoftwareUpdateConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationSoftwareUpdateConfiguration.md +--- + +# New-AzAutomationSoftwareUpdateConfiguration + +## SYNOPSIS +Creates a scheduled azure automation software update configuration. + +## SYNTAX + +### Windows (Default) +``` +New-AzAutomationSoftwareUpdateConfiguration -Schedule [-Windows] [-RebootOnly] + [-AzureVMResourceId ] [-PreTaskRunbookName ] [-PostTaskRunbookName ] + [-PreTaskRunbookParameter ] [-PostTaskRunbookParameter ] [-NonAzureComputer ] + [-AzureQuery ] [-NonAzureQuery ] [-Duration ] + [-RebootSetting ] [-IncludedUpdateClassification ] + [-ExcludedKbNumber ] [-IncludedKbNumber ] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### Linux +``` +New-AzAutomationSoftwareUpdateConfiguration -Schedule [-Linux] [-RebootOnly] + [-AzureVMResourceId ] [-PreTaskRunbookName ] [-PostTaskRunbookName ] + [-PreTaskRunbookParameter ] [-PostTaskRunbookParameter ] [-NonAzureComputer ] + [-AzureQuery ] [-NonAzureQuery ] [-Duration ] + [-RebootSetting ] [-IncludedPackageClassification ] + [-ExcludedPackageNameMask ] [-IncludedPackageNameMask ] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Creates a software update configuration that runs on a schedule to update a list of computers. Computers include both azure virtual machines or non-az computers. + +## EXAMPLES + +### Example 1 +Creates a software update configuration to install critical updates on two Windows azure virtual machines once every Saturday 9PM. Update duration is set to 2 hours in this example. + +```powershell +$startTime = [DateTimeOffset]"2018-09-13T21:00" +$targetMachines = @( + "/subscriptions/22e2445a-0984-4fa5-86a4-0280d76c4b2c/resourceGroups/compute/providers/Microsoft.Compute/virtualMachines/vm-w-01", + "/subscriptions/22e2445a-0984-4fa5-86a4-0280d76c4b2c/resourceGroups/compute/providers/Microsoft.Compute/virtualMachines/vm-w-02" +) +$duration = New-TimeSpan -Hours 2 +$schedule = New-AzAutomationSchedule -ResourceGroupName "mygroup" ` + -AutomationAccountName "myaccount" ` + -Name MyWeeklySchedule ` + -StartTime $startTime ` + -DaysOfWeek Saturday ` + -WeekInterval 1 ` + -ForUpdateConfiguration + +New-AzAutomationSoftwareUpdateConfiguration -ResourceGroupName "mygroup" ` + -AutomationAccountName "myaccount" ` + -Schedule $schedule ` + -Windows ` + -AzureVMResourceId $targetMachines ` + -IncludedUpdateClassification Critical ` + -Duration $duration +``` + +```output +UpdateConfiguration : Microsoft.Azure.Commands.Automation.Model.UpdateManagement.UpdateConfiguration +ScheduleConfiguration : Microsoft.Azure.Commands.Automation.Model.Schedule +ProvisioningState : Provisioning +ErrorInfo : +ResourceGroupName : mygroup +AutomationAccountName : myaccount +Name : MyWeeklySchedule +CreationTime : 9/14/2018 3:53:27 AM +00:00 +LastModifiedTime : 9/14/2018 3:53:27 AM +00:00 +Description : +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureQuery +Dynamic group azure query. + +```yaml +Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.AzureQueryProperties[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureVMResourceId +Resource Ids for azure virtual machines. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Duration +Maximum duration for the update. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExcludedKbNumber +KB numbers of excluded updates. + +```yaml +Type: System.String[] +Parameter Sets: Windows +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExcludedPackageNameMask +Excluded Linux package masks. + +```yaml +Type: System.String[] +Parameter Sets: Linux +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludedKbNumber +KB numbers of included updates. + +```yaml +Type: System.String[] +Parameter Sets: Windows +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludedPackageClassification +Included Linux package classifications. + +```yaml +Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.LinuxPackageClasses[] +Parameter Sets: Linux +Aliases: +Accepted values: Unclassified, Critical, Security, Other + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludedPackageNameMask +Included Linux package masks. + +```yaml +Type: System.String[] +Parameter Sets: Linux +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludedUpdateClassification +Included Windows Update classifications. + +```yaml +Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.WindowsUpdateClasses[] +Parameter Sets: Windows +Aliases: +Accepted values: Unclassified, Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools, Updates + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Linux +Indicates that the software update configuration targeting Linux operating system machines. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Linux +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NonAzureComputer +Non-Az computer names. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NonAzureQuery +Dynamic group non Azure query. + +```yaml +Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.NonAzureQueryProperties[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PostTaskRunbookName +Post task. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PostTaskRunbookParameter +Post task parameter. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PreTaskRunbookName +Pre task. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PreTaskRunbookParameter +Pre task parameter. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RebootOnly +Indicates that the software update configuration will Only Reboot the machines. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RebootSetting +Reboot Setting. + +```yaml +Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.RebootSetting +Parameter Sets: (All) +Aliases: +Accepted values: IfRequired, Never, Always, RebootOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Schedule +Schedule object used for software update configuration. + +```yaml +Type: Microsoft.Azure.Commands.Automation.Model.Schedule +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Windows +Indicates that the software update configuration targeting windows operating system machines. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Windows +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Automation.Model.Schedule + +### System.Management.Automation.SwitchParameter + +### System.String[] + +### System.TimeSpan + +### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.WindowsUpdateClasses[] + +### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.LinuxPackageClasses[] + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationSourceControl.md b/azps-10.1.0/Az.Automation/New-AzAutomationSourceControl.md new file mode 100644 index 0000000000..c728e6c6b1 --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationSourceControl.md @@ -0,0 +1,327 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationsourcecontrol +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationSourceControl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationSourceControl.md +--- + +# New-AzAutomationSourceControl + +## SYNOPSIS +Creates an Azure Automation source control. + +## SYNTAX + +``` +New-AzAutomationSourceControl -Name -RepoUrl -SourceType -AccessToken + -FolderPath [-Branch ] [-Description ] [-EnableAutoSync] [-DoNotPublishRunbook] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The New-AzAutomationSourceControl cmdlet creates a configuration to link an Azure Automation account with a VSTS TFVC, VSTS Git or GitHub. + +## EXAMPLES + +### Example 1 +Create a source control configuration to link an Azure Automation account with a VSTS TFVC project. TFVC projects do not have branches, and therefore, the Branch parameter is not specified. + +```powershell +# VSTS Personal access token +$token = "vppmrabbs65axamofglyo66rjg6reddaa7xxgvaddd5555aaaaddxzbmma" +$accessToken = ConvertTo-SecureString -String $token -AsPlainText -Force +New-AzAutomationSourceControl -ResourceGroupName "rg1" ` + -AutomationAccountName "devAccount" ` + -Name "VSTSNative" ` + -RepoUrl "https://dev.azure.com///_git/" ` + -SourceType "VsoTfvc" ` + -FolderPath "/Runbooks" ` + -AccessToken $accessToken +``` + +```output +Name SourceType Branch FolderPath AutoSync PublishRunbook RepoUrl +---- ---------- ------ ---------- -------- -------------- ------- +VSTSNative VsoTfvc /Runbooks True True https://dev.azure.com////_git/" ` + -SourceType "VsoGit" ` + -Branch "Development" ` + -FolderPath "/" ` + -AccessToken $accessToken +``` + +```output +Name SourceType Branch FolderPath AutoSync PublishRunbook RepoUrl +---- ---------- ------ ---------- -------- -------------- ------- +VSTSGit VsoGit Development / True True https://dev.azure.com// [-Location ] [-Tag ] + [-FilterOperator ] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Creates an "Update Management Azure Query" object that will dynamically resolve a list of Azure virtual machines for use in scheduling software updates. + +## EXAMPLES + +### Example 1 +```powershell +$query1Scope = @( + "/subscriptions/22e2445a-0984-4fa5-86a4-0280d76c4b2c/resourceGroups/resourceGroupName", + "/subscriptions/32e2445a-0984-4fa5-86a4-0280d76c4b2d/" +) +$query1Location =@("Japan East", "UK South") +$query1FilterOperator = "All" +$tag1 = @{"tag1"= @("tag1Value1", "tag1Value2")} +$tag1.add("tag2", "tag2Value") +$azq = New-AzAutomationUpdateManagementAzureQuery -ResourceGroupName "mygroup" ` + -AutomationAccountName "myaccount" ` + -Scope $query1Scope ` + -Location $query1Location ` + -Tag $tag1 +$AzureQueries = @($azq) +$startTime = [DateTimeOffset]"2018-09-13T21:00" + +$duration = New-TimeSpan -Hours 2 +$schedule = New-AzAutomationSchedule -ResourceGroupName "mygroup" ` + -AutomationAccountName "myaccount" ` + -Name MyWeeklySchedule ` + -StartTime $startTime ` + -DaysOfWeek Saturday ` + -WeekInterval 1 ` + -ForUpdateConfiguration + +New-AzAutomationSoftwareUpdateConfiguration -ResourceGroupName "mygroup" ` + -AutomationAccountName "myaccount" ` + -Schedule $schedule ` + -Windows ` + -AzureQuery $AzureQueries ` + -IncludedUpdateClassification Critical ` + -Duration $duration +``` + +```output +UpdateConfiguration : Microsoft.Azure.Commands.Automation.Model.UpdateManagement.UpdateConfiguration +ScheduleConfiguration : Microsoft.Azure.Commands.Automation.Model.Schedule +ProvisioningState : Provisioning +ErrorInfo : +ResourceGroupName : mygroup +AutomationAccountName : myaccount +Name : MyWeeklySchedule +CreationTime : 9/14/2018 3:53:27 AM +00:00 +LastModifiedTime : 9/14/2018 3:53:27 AM +00:00 +Description : +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterOperator +Tag filter operator. + +```yaml +Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.TagOperators +Parameter Sets: (All) +Aliases: +Accepted values: All, Any + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +List of locations for azure virtual machines. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: Locaton + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Resource Ids for azure virtual machines. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag for azure virtual machines. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.TagOperators + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.AzureQueryProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationVariable.md b/azps-10.1.0/Az.Automation/New-AzAutomationVariable.md new file mode 100644 index 0000000000..e8b002dc26 --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationVariable.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 5AF6F70F-7137-48E2-96ED-2C509042F127 +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationvariable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationVariable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationVariable.md +--- + +# New-AzAutomationVariable + +## SYNOPSIS +Creates an Automation variable. + +## SYNTAX + +``` +New-AzAutomationVariable [-Name] -Encrypted [-Description ] [-Value ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **New-AzAutomationVariable** cmdlet creates a variable in Azure Automation. +To encrypt the variable, specify the *Encrypted* parameter. +You cannot modify the encrypted state of a variable after creation. + +## EXAMPLES + +### Example 1: Create a variable with a simple value +```powershell +New-AzAutomationVariable -AutomationAccountName "Contoso17" -Name "StringVariable22" -Encrypted $False -Value "My String" -ResourceGroupName "ResourceGroup01" +``` + +This command creates a variable named StringVariable22 with a string value in the Automation account named Contoso17. + +### Example 2: Create a variable with a complex value +```powershell +$VirtualMachine = Get-AzVM -Name "VirtualMachine03" +New-AzAutomationVariable -AutomationAccountName "Contoso17" -Name "ComplexVariable01" -Encrypted $False -Value $VirtualMachine -ResourceGroupName "ResourceGroup01" +``` + +The first command gets a virtual machine by using the Get-AzVM cmdlet. +The command stores it in the $VirtualMachine variable. +The second command creates a variable named ComplexVariable01 in the Automation account named Contoso17. +This command uses a complex object for its value, in this case, the virtual machine in $VirtualMachine. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account in which to store the variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Encrypted +Specifies whether this cmdlet encrypts the value of the variable for storage. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group for which this cmdlet creates a variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Specifies a value for the variable. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Boolean + +### System.Object + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Variable + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationVariable](./Get-AzAutomationVariable.md) + +[Remove-AzAutomationVariable](./Remove-AzAutomationVariable.md) + +[Set-AzAutomationVariable](./Set-AzAutomationVariable.md) + + diff --git a/azps-10.1.0/Az.Automation/New-AzAutomationWebhook.md b/azps-10.1.0/Az.Automation/New-AzAutomationWebhook.md new file mode 100644 index 0000000000..2583762854 --- /dev/null +++ b/azps-10.1.0/Az.Automation/New-AzAutomationWebhook.md @@ -0,0 +1,266 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: E1FC931E-4EB8-4DCA-92BD-8013DDC13219 +online version: https://learn.microsoft.com/powershell/module/az.automation/new-azautomationwebhook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationWebhook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/New-AzAutomationWebhook.md +--- + +# New-AzAutomationWebhook + +## SYNOPSIS +Creates a webhook for an Automation runbook. + +## SYNTAX + +``` +New-AzAutomationWebhook [-Name] [-RunbookName] [-IsEnabled] + [-ExpiryTime] [-Parameters ] [-Force] [-RunOn ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **New-AzAutomationWebhook** cmdlet creates a webhook for an Azure Automation runbook. +Be sure to save the webhook URL that this cmdlet returns, because it cannot be retrieved again. + +## EXAMPLES + +### Example 1: Create a webhook +```powershell +$Webhook = New-AzAutomationWebhook -Name "Webhook06" -IsEnabled $True -ExpiryTime "10/2/2016" -RunbookName "ContosoRunbook" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Force +``` + +This command creates a webhook named Webhook06 for the runbook named ContosoRunbook in the Automation account named AutomationAccount01. +The command stores the webhook in the $Webhook variable. +The webhook is enabled. +The webhook expires at the specified time. +This command does not provide any values for webhook parameters. +This command specifies the *Force* parameter. +Therefore, it does not prompt you for confirmation. + +### Example 2: Create a webhook with parameters +```powershell +$Params = @{"StringParam"="Hello World";"IntegerParam"=32} +$Webhook = New-AzAutomationWebhook -Name "Webhook11" -Parameters $Params -IsEnabled $True -ExpiryTime "10/2/2016" -RunbookName "ContosoRunbook" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Force +``` + +The first command creates a dictionary of parameters, and stores them in the $Params variable. +The second command creates a webhook named Webhook11 for the runbook named ContosoRunbook in the Automation account named AutomationAccount01. +The command assigns the parameters in $Params to the webhook. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account in which this cmdlet creates a webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the expiry time for the webhook as a **DateTimeOffset** object. +You can specify a string or a **DateTime** that can be converted to a valid **DateTimeOffset**. + +```yaml +Type: System.DateTimeOffset +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsEnabled +Specifies whether the webhook is enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameters +Specifies a dictionary of key/value pairs. +The keys are the runbook parameter names. +The values are the runbook parameter values. +When the runbook starts in response to a webhook, these parameters are passed to the runbook. + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet creates a webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunbookName +Specifies the name of the runbook to associate to the webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunOn +Optional name of the hybrid worker group which should execute the runbook + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HybridWorker + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Boolean + +### System.DateTimeOffset + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Webhook + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationWebhook](./Get-AzAutomationWebhook.md) + +[Remove-AzAutomationWebhook](./Remove-AzAutomationWebhook.md) + +[Set-AzAutomationWebhook](./Set-AzAutomationWebhook.md) + + diff --git a/azps-10.1.0/Az.Automation/Publish-AzAutomationRunbook.md b/azps-10.1.0/Az.Automation/Publish-AzAutomationRunbook.md new file mode 100644 index 0000000000..cd067b3586 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Publish-AzAutomationRunbook.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: E7F31B71-983A-4DB3-BB30-BDC5C0247E74 +online version: https://learn.microsoft.com/powershell/module/az.automation/publish-azautomationrunbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Publish-AzAutomationRunbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Publish-AzAutomationRunbook.md +--- + +# Publish-AzAutomationRunbook + +## SYNOPSIS +Publishes a runbook. + +## SYNTAX + +``` +Publish-AzAutomationRunbook [-Name] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Publish-AzAutomationRunbook** cmdlet publishes a runbook for use in the production environment of Azure Automation. + +## EXAMPLES + +### Example 1: Publish a runbook +```powershell +Publish-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01" +``` + +This command publishes the runbook named Runbk01 in the Azure Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account in which this cmdlet publishes a runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the runbook that this cmdlet publishes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet publishes a runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Runbook + +## NOTES + +## RELATED LINKS + +[Export-AzAutomationRunbook](./Export-AzAutomationRunbook.md) + +[Get-AzAutomationRunbook](./Get-AzAutomationRunbook.md) + +[Import-AzAutomationRunbook](./Import-AzAutomationRunbook.md) + +[New-AzAutomationRunbook](./New-AzAutomationRunbook.md) + +[New-AzAutomationRunbook](./New-AzAutomationRunbook.md) + +[Remove-AzAutomationRunbook](./Remove-AzAutomationRunbook.md) + +[Set-AzAutomationRunbook](./Set-AzAutomationRunbook.md) + +[Start-AzAutomationRunbook](./Start-AzAutomationRunbook.md) + + diff --git a/azps-10.1.0/Az.Automation/Register-AzAutomationDscNode.md b/azps-10.1.0/Az.Automation/Register-AzAutomationDscNode.md new file mode 100644 index 0000000000..e3b7fade52 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Register-AzAutomationDscNode.md @@ -0,0 +1,276 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 73E6DF02-7171-481B-966F-DECEC122A602 +online version: https://learn.microsoft.com/powershell/module/az.automation/register-azautomationdscnode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Register-AzAutomationDscNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Register-AzAutomationDscNode.md +--- + +# Register-AzAutomationDscNode + +## SYNOPSIS +Registers an Azure virtual machine running Windows OS as a DSC node for an Automation account. + +## SYNTAX + +``` +Register-AzAutomationDscNode -AzureVMName [-NodeConfigurationName ] + [-ConfigurationMode ] [-ConfigurationModeFrequencyMins ] [-RefreshFrequencyMins ] + [-RebootNodeIfNeeded ] [-ActionAfterReboot ] [-AllowModuleOverwrite ] + [-AzureVMResourceGroup ] [-AzureVMLocation ] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Register-AzAutomationDscNode** cmdlet registers an Azure virtual machine as an APS Desired State Configuration (DSC) node in an Azure Automation account. This cmdlet will only register VMs running Windows OS as an Automation DSC Node for an account. + +If you need to register a node to an automation account in a different subscription, +you will need to use an ARM template rather than cmdlets. +See the Azure Automation +[documentation](https://learn.microsoft.com/azure/automation/automation-dsc-onboarding#registering-virtual-machines-across-azure-subscriptions) +for more details. + +## EXAMPLES + +### Example 1: Register an Azure virtual machine as an Azure DSC node +```powershell +Register-AzAutomationDscNode -AutomationAccountName "Contoso17" -AzureVMName "VirtualMachine01" -ResourceGroupName "ResourceGroup01"-NodeConfigurationName "ContosoConfiguration.webserver" +``` + +This command registers the Azure virtual machine named VirtualMachine01 as a DSC node in the Automation account named Contoso17. + +## PARAMETERS + +### -ActionAfterReboot +Specifies the action that the virtual machine takes after it restarts. +Valid values are: +- ContinueConfiguration +- StopConfiguration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: ContinueConfiguration, StopConfiguration + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AllowModuleOverwrite +Specifies whether new configurations that this DSC node downloads from the Azure Automation DSC pull server replace the existing modules already on the target node. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutomationAccountName +Specifies the name of an Automation account in which this cmdlet registers a virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureVMLocation +The Azure VM location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureVMName +The name of the Azure virtual machine to register for management with Azure Automation DSC. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureVMResourceGroup +The Azure VM resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConfigurationMode +Specifies the DSC configuration mode. +Valid values are: +- ApplyAndMonitor +- ApplyAndAutocorrect +- ApplyOnly + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: ApplyAndMonitor, ApplyAndAutocorrect, ApplyOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConfigurationModeFrequencyMins +Specifies the frequency, in minutes, at which the background application of DSC attempts to implement the current configuration on the target node. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeConfigurationName +Specifies the name of the node configuration that this cmdlet configures the virtual machine to pull from Azure Automation DSC. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RebootNodeIfNeeded +Specifies whether to restart the virtual machine, if needed. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RefreshFrequencyMins +Specifies the frequency, in minutes, at which the local Configuration Manager contacts the Azure Automation DSC pull server to download the latest node configuration. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +The Automation account with which this cmdlet registers a virtual machine belongs to the resource group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +### System.Boolean + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationDscNode](./Get-AzAutomationDscNode.md) + +[Set-AzAutomationDscNode](./Set-AzAutomationDscNode.md) + +[Unregister-AzAutomationDscNode](./Unregister-AzAutomationDscNode.md) + + diff --git a/azps-10.1.0/Az.Automation/Register-AzAutomationScheduledRunbook.md b/azps-10.1.0/Az.Automation/Register-AzAutomationScheduledRunbook.md new file mode 100644 index 0000000000..54b9147e32 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Register-AzAutomationScheduledRunbook.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: F79AFF9A-CEDA-4E57-B5DB-9D0A7CDA6D27 +online version: https://learn.microsoft.com/powershell/module/az.automation/register-azautomationscheduledrunbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Register-AzAutomationScheduledRunbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Register-AzAutomationScheduledRunbook.md +--- + +# Register-AzAutomationScheduledRunbook + +## SYNOPSIS +Associates a runbook to a schedule. + +## SYNTAX + +### ByRunbookName (Default) +``` +Register-AzAutomationScheduledRunbook [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +### ByRunbookNameAndScheduleName +``` +Register-AzAutomationScheduledRunbook -RunbookName -ScheduleName [-Parameters ] + [-RunOn ] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Register-AzAutomationScheduledRunbook** cmdlet associates an Azure Automation runbook to a schedule. +The runbook starts based on the schedule you specify using the *ScheduleName* parameter. + +## EXAMPLES + +### Example 1: Associate a runbook with a schedule +```powershell +Register-AzAutomationScheduledRunbook -AutomationAccountName "Contoso17" -RunbookName "Runbk01" -ScheduleName "Sched01" -ResourceGroupName "ResourceGroup01" +``` + +This command associates the runbook named Runbk01 with the schedule named Sched01 in the Azure Automation account named Contoso17. + +### Example 2 + +Associates a runbook to a schedule. (autogenerated) + + + + +```powershell +Register-AzAutomationScheduledRunbook -AutomationAccountName 'Contoso17' -Parameters -ResourceGroupName 'ResourceGroup01' -RunbookName 'Runbk01' -ScheduleName 'Sched01' +``` + +## PARAMETERS + +### -AutomationAccountName +Specifies an Automation account for the runbook on which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameters +Specifies a hash table of key/value pairs. +The keys are runbook parameter names. +The values are runbook parameter values. +When the runbook starts in response to the associated schedule, these parameters are passed to the runbook. +Example: -Parameters @{"Key1"="Value1";"Key2"="Value2"} + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: ByRunbookNameAndScheduleName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for the scheduled runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunbookName +Specifies the name of the runbook that this cmdlet associates to a schedule. + +```yaml +Type: System.String +Parameter Sets: ByRunbookNameAndScheduleName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunOn +The name of the hybrid runbook worker group. + +```yaml +Type: System.String +Parameter Sets: ByRunbookNameAndScheduleName +Aliases: HybridWorker + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScheduleName +Specifies the name of the schedule to which this cmdlet associates a runbook. + +```yaml +Type: System.String +Parameter Sets: ByRunbookNameAndScheduleName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.JobSchedule + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationScheduledRunbook](./Get-AzAutomationScheduledRunbook.md) + +[Unregister-AzAutomationScheduledRunbook](./Unregister-AzAutomationScheduledRunbook.md) + + diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationAccount.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationAccount.md new file mode 100644 index 0000000000..a55e97c279 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationAccount.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 515933DF-5DB1-452A-808B-0198A3A2EA8B +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationAccount.md +--- + +# Remove-AzAutomationAccount + +## SYNOPSIS +Removes an Automation account. + +## SYNTAX + +``` +Remove-AzAutomationAccount [-ResourceGroupName] [-Name] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzAutomationAccount** cmdlet removes an Azure Automation account from a resource group. +For more information about Automation accounts, see the New-AzAutomationAccount cmdlet. + +## EXAMPLES + +### Example 1: Remove an automation account +```powershell +Remove-AzAutomationAccount -Name "ContosoAutomationAccount" -Force -ResourceGroupName "ResourceGroup01" +``` + +This command removes an automation account named ContosoAutomationAccount without prompting for user validation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Automation account that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AutomationAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group from which this cmdlet removes an Automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.AutomationAccount + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationAccount](./Get-AzAutomationAccount.md) + +[New-AzAutomationAccount](./New-AzAutomationAccount.md) + +[Set-AzAutomationAccount](./Set-AzAutomationAccount.md) + + diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationCertificate.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationCertificate.md new file mode 100644 index 0000000000..788271b1bc --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationCertificate.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: C0B24E18-9163-458A-8297-93CB5C2003FA +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationCertificate.md +--- + +# Remove-AzAutomationCertificate + +## SYNOPSIS +Removes an Automation certificate. + +## SYNTAX + +``` +Remove-AzAutomationCertificate [-Name] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzAutomationCertificate** cmdlet removes a certificate from Azure Automation. + +## EXAMPLES + +### Example 1: Remove a certificate +```powershell +Remove-AzAutomationCertificate -AutomationAccountName "Contoso17" -Name "Cert01" -ResourceGroupName "ResourceGroup01" +``` + +This command removes a certificate named Cert01 in the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account for which this cmdlet removes a certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the certificate that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet removes a certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationCertificate](./Get-AzAutomationCertificate.md) + +[New-AzAutomationCertificate](./New-AzAutomationCertificate.md) + +[Set-AzAutomationCertificate](./Set-AzAutomationCertificate.md) + + diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationConnection.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationConnection.md new file mode 100644 index 0000000000..d7fbd61828 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationConnection.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: C1C0F69D-6A3F-4523-BB70-27676A3DDCBD +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationConnection.md +--- + +# Remove-AzAutomationConnection + +## SYNOPSIS +Removes an Automation connection. + +## SYNTAX + +``` +Remove-AzAutomationConnection [-Name] [-Force] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzAutomationConnection** cmdlet removes a connection from Azure Automation. + +## EXAMPLES + +### Example 1: Remove a connection +```powershell +Remove-AzAutomationConnection -AutomationAccountName "Contoso17" -Name "ContosoConnection" -ResourceGroupName "ResourceGroup01" +``` + +This command removes a certificate named ContosoConnection in the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the automation account for which this cmdlet removes a connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the connection that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet removes a connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationConnection](./Get-AzAutomationConnection.md) + +[New-AzAutomationConnection](./New-AzAutomationConnection.md) + + diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationConnectionType.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationConnectionType.md new file mode 100644 index 0000000000..65d60764f9 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationConnectionType.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 92B69069-0F98-428A-B05C-BBA09EBC0381 +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationconnectiontype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationConnectionType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationConnectionType.md +--- + +# Remove-AzAutomationConnectionType + +## SYNOPSIS +Removes an Automation connection type. + +## SYNTAX + +``` +Remove-AzAutomationConnectionType [-Name] [-Force] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzAutomationConnectionType** cmdlet removes a connection type from Azure Automation. +All connections that are associated with the connection type that you delete become unusable. +Remove them, unless you create a new connection type that meets the following criteria: +- The type has the same name as the original connection type. +- The type has the same field definitions as the original connection type. +It can have additional fields. + +## EXAMPLES + +### Example 1: Remove a connection type +```powershell +Remove-AzAutomationConnectionType -AutomationAccountName "Contoso17" -Name "ContosoConnectionType" -ResourceGroupName "ResourceGroup01" +``` + +This command removes a connection type named ContosoConnectionType in the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account for which this cmdlet removes a connection type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Automation connection type that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group from which this cmdlet removes an Automation connection type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Remove-AzAutomationConnection](./Remove-AzAutomationConnection.md) + + diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationCredential.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationCredential.md new file mode 100644 index 0000000000..3b68346779 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationCredential.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: B53B765F-5CFC-4BF8-A48A-E638A73E1FC5 +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationCredential.md +--- + +# Remove-AzAutomationCredential + +## SYNOPSIS +Removes an Automation credential. + +## SYNTAX + +``` +Remove-AzAutomationCredential [-Name] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzAutomationCredential** cmdlet removes a credential from Azure Automation. + +## EXAMPLES + +### Example 1: Remove a credential +```powershell +Remove-AzAutomationCredential -AutomationAccountName "Contoso17" -Name "ContosoCredential" -ResourceGroupName "ResourceGroup01" +``` + +This command removes a credential named ContosoCredential in the Azure Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account from which this cmdlet removes a credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the credential that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet removes a credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationCredential](./Get-AzAutomationCredential.md) + +[New-AzAutomationCredential](./New-AzAutomationCredential.md) + +[Set-AzAutomationCredential](./Set-AzAutomationCredential.md) + + diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationDscConfiguration.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationDscConfiguration.md new file mode 100644 index 0000000000..341461d775 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationDscConfiguration.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 6389EE2A-12B5-46A1-A2B9-4B3CF5A55A30 +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationdscconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationDscConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationDscConfiguration.md +--- + +# Remove-AzAutomationDscConfiguration + +## SYNOPSIS +Removes DSC configurations from Automation. + +## SYNTAX + +``` +Remove-AzAutomationDscConfiguration [-Name] [-Force] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzAutomationDscConfiguration** cmdlet removes APS Desired State Configuration (DSC) configurations from Azure Automation. + +## EXAMPLES + +### Example 1 + +Removes DSC configurations from Automation. (autogenerated) + + + + +```powershell +Remove-AzAutomationDscConfiguration -AutomationAccountName 'AutomationAccount01' -Name 'Configuration01' -ResourceGroupName myresourcegroup +``` + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains DSC configurations that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the DSC configuration that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConfigurationName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet gets DSC configurations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Export-AzAutomationDscConfiguration](./Export-AzAutomationDscConfiguration.md) + +[Get-AzAutomationDscConfiguration](./Get-AzAutomationDscConfiguration.md) + +[Import-AzAutomationDscConfiguration](./Import-AzAutomationDscConfiguration.md) + + diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationDscNodeConfiguration.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationDscNodeConfiguration.md new file mode 100644 index 0000000000..3615e9b996 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationDscNodeConfiguration.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 6C6C7142-31CD-4245-BC55-CB7916EA12E0 +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationdscnodeconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationDscNodeConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationDscNodeConfiguration.md +--- + +# Remove-AzAutomationDscNodeConfiguration + +## SYNOPSIS +Removes metadata from DSC node configurations in Automation. + +## SYNTAX + +``` +Remove-AzAutomationDscNodeConfiguration [-Name] [-Force] [-IgnoreNodeMappings] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzAutomationDscNodeConfiguration** cmdlet removes metadata from APS Desired State Configuration (DSC) node configurations in Azure Automation. +Automation stores DSC node configuration as a Managed Object Format (MOF) configuration document. + +## EXAMPLES + +### Example 1 + +Removes metadata from DSC node configurations in Automation. (autogenerated) + + + + +```powershell +Remove-AzAutomationDscNodeConfiguration -AutomationAccountName 'AutomationAccount01' -IgnoreNodeMappings -Name 'Configuration01' -ResourceGroupName myresourcegroup +``` + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account that contains the DSC node configurations for which this cmdlet removes metadata. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreNodeMappings +Indicates that this cmdlet ignores node mappings. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the DSC node configuration for which this cmdlet removes metadata. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: NodeConfigurationName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet removes metadata for DSC node configurations in the resource group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationDscNodeConfiguration](./Get-AzAutomationDscNodeConfiguration.md) + +[Import-AzAutomationDscNodeConfiguration](./Import-AzAutomationDscNodeConfiguration.md) + +[Azure Automation Cmdlets](/powershell/module/Az.Automation/) diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationHybridRunbookWorker.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationHybridRunbookWorker.md new file mode 100644 index 0000000000..f3643f2957 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationHybridRunbookWorker.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationhybridrunbookworker +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationHybridRunbookWorker.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationHybridRunbookWorker.md +--- + +# Remove-AzAutomationHybridRunbookWorker + +## SYNOPSIS +Removes a hybrid runbook worker. + +## SYNTAX + +``` +Remove-AzAutomationHybridRunbookWorker [-Name] [-HybridRunbookWorkerGroupName] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzAutomationHybridRunbookWorker** cmdlet removes a hybrid runbook worker. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzAutomationHybridRunbookWorker -AutomationAccountName "Contoso17" -Name "RunbookWorkerName" -HybridRunbookWorkerGroupName "RunbookWorkerGroupName" -ResourceGroupName "ResourceGroup01" +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridRunbookWorkerGroupName +The hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookWorkerGroup, WorkerGroup + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The hybrid runbook worker name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookWorker, RunbookWorkerId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationHybridRunbookWorkerGroup.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationHybridRunbookWorkerGroup.md new file mode 100644 index 0000000000..91a14c674a --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationHybridRunbookWorkerGroup.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationhybridrunbookworkergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationHybridRunbookWorkerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationHybridRunbookWorkerGroup.md +--- + +# Remove-AzAutomationHybridRunbookWorkerGroup + +## SYNOPSIS +Removes a hybrid runbook worker group. + +## SYNTAX + +``` +Remove-AzAutomationHybridRunbookWorkerGroup [-Name] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzAutomationHybridRunbookWorkerGroup** cmdlet removes a hybrid runbook worker group. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzAutomationHybridRunbookWorkerGroup -AutomationAccountName "Contoso17" -Name "RunbookWorkerGroupName" -ResourceGroupName "ResourceGroup01" +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The hybrid worker group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookWorkerGroup, WorkerGroup + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationHybridWorkerGroup.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationHybridWorkerGroup.md new file mode 100644 index 0000000000..9ca673cd7a --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationHybridWorkerGroup.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationhybridworkergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationHybridWorkerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationHybridWorkerGroup.md +--- + +# Remove-AzAutomationHybridWorkerGroup + +## SYNOPSIS +Removes hybrid worker group from Automation. + +## SYNTAX + +``` +Remove-AzAutomationHybridWorkerGroup [-Name] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The Remove-AzAutomationHybridWorkerGroup cmdlet removes a hybrid worker group from Automation. + +## EXAMPLES + +### Example 1 +This command removes a hybrid worker by name. + +```powershell +Remove-AzAutomationHybridWorkerGroup -ResourceGroupName "rg1" ` + -AutomationAccountName "devAccount" ` + -Name "GroupName" +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The hybrid worker group name. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Group + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### System.Void +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationModule.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationModule.md new file mode 100644 index 0000000000..6304ec6879 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationModule.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 5F45A12C-BB50-4732-BE80-188491DEF8B5 +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationmodule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationModule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationModule.md +--- + +# Remove-AzAutomationModule + +## SYNOPSIS +Removes a module from Automation. + +## SYNTAX + +``` +Remove-AzAutomationModule [-Name] [-Force] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzAutomationModule** cmdlet removes a module from an Automation account in Azure Automation. + +## EXAMPLES + +### Example 1: Remove a module +```powershell +Remove-AzAutomationModule -AutomationAccountName "Contoso17" -Name "ContosoModule" -ResourceGroupName "ResourceGroup01" +``` + +This command removes a module named ContosoModule from the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account from which this cmdlet removes a module. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the module that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet removes a module. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationModule](./Get-AzAutomationModule.md) + +[New-AzAutomationModule](./New-AzAutomationModule.md) + +[Set-AzAutomationModule](./Set-AzAutomationModule.md) + + diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationPython3Package.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationPython3Package.md new file mode 100644 index 0000000000..4f4c307bc6 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationPython3Package.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationpython3package +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationPython3Package.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationPython3Package.md +--- + +# Remove-AzAutomationPython3Package + +## SYNOPSIS +Remove a Python3 Package from Automation Account + +## SYNTAX + +``` +Remove-AzAutomationPython3Package [-Name] [-Force] [-ResourceGroupName] + [-AutomationAccountName] +``` + +## DESCRIPTION +The **Remove-AzAutomationPython3Package** cmdlet removes a Python3 Package from Automation Account. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzAutomationPython3Package -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -Name "Python3PackageName" +``` + + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Confirm the removal of Python 3 package + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Python 3 package name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Module + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationRunbook.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationRunbook.md new file mode 100644 index 0000000000..f6ab30521f --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationRunbook.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 16055879-C001-46E7-B8C3-1FE2A1A67AC4 +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationrunbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationRunbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationRunbook.md +--- + +# Remove-AzAutomationRunbook + +## SYNOPSIS +Removes a runbook. + +## SYNTAX + +``` +Remove-AzAutomationRunbook [-Name] [-Force] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzAutomationRunbook** cmdlet removes a runbook from Azure Automation. + +## EXAMPLES + +### Example 1: Remove a runbook +```powershell +Remove-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbook03" -ResourceGroupName "ResourceGroup01" +``` + +This command removes the runbook named Runbook03 in the Azure Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account in which this cmdlet removes a runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the runbook that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet publishes a runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Export-AzAutomationRunbook](./Export-AzAutomationRunbook.md) + +[Get-AzAutomationRunbook](./Get-AzAutomationRunbook.md) + +[Import-AzAutomationRunbook](./Import-AzAutomationRunbook.md) + +[New-AzAutomationRunbook](./New-AzAutomationRunbook.md) + +[New-AzAutomationRunbook](./New-AzAutomationRunbook.md) + +[Publish-AzAutomationRunbook](./Publish-AzAutomationRunbook.md) + +[Set-AzAutomationRunbook](./Set-AzAutomationRunbook.md) + +[Start-AzAutomationRunbook](./Start-AzAutomationRunbook.md) + + diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationSchedule.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationSchedule.md new file mode 100644 index 0000000000..635a0e0ca0 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationSchedule.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: EAD39EE1-C66F-4092-8876-E7F9FA612481 +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationSchedule.md +--- + +# Remove-AzAutomationSchedule + +## SYNOPSIS +Deletes an Automation schedule. + +## SYNTAX + +``` +Remove-AzAutomationSchedule [-Name] [-Force] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzAutomationSchedule** cmdlet deletes a schedule from Azure Automation. + +## EXAMPLES + +### Example 1: Remove a schedule +```powershell +Remove-AzAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule01" -ResourceGroupName "ResourceGroup01" +``` + +This command deletes the schedule named Schedule01 in automation account Contoso17 in resource group ResourceGroup01. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account for which this cmdlet removes a schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name for the schedule that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet removes a schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationSchedule](./Get-AzAutomationSchedule.md) + +[New-AzAutomationSchedule](./New-AzAutomationSchedule.md) + +[Set-AzAutomationSchedule](./Set-AzAutomationSchedule.md) + + diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationSoftwareUpdateConfiguration.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationSoftwareUpdateConfiguration.md new file mode 100644 index 0000000000..bd33c68c2d --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationSoftwareUpdateConfiguration.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationsoftwareupdateconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationSoftwareUpdateConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationSoftwareUpdateConfiguration.md +--- + +# Remove-AzAutomationSoftwareUpdateConfiguration + +## SYNOPSIS +Removes an azure automation software update configuration. + +## SYNTAX + +### BySucName (Default) +``` +Remove-AzAutomationSoftwareUpdateConfiguration -Name [-PassThru] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### BySuc +``` +Remove-AzAutomationSoftwareUpdateConfiguration -SoftwareUpdateConfiguration + [-PassThru] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet removed an azure automation software update configuration. + +## EXAMPLES + +### Example 1 +This example shows how to remove 'MyUpdateConfiguration' from automation account + +```powershell +Remove-AzAutomationSoftwareUpdateConfiguration -ResourceGroupName "mygroup" -AutomationAccountName "myaccount" -Name "MyUpdateConfiguration" +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the software update configuration to remove. + +```yaml +Type: System.String +Parameter Sets: BySucName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +PassThru returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SoftwareUpdateConfiguration +The software update configuration to remove. + +```yaml +Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateConfiguration +Parameter Sets: BySuc +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateConfiguration + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationSourceControl.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationSourceControl.md new file mode 100644 index 0000000000..46038a521e --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationSourceControl.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationsourcecontrol +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationSourceControl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationSourceControl.md +--- + +# Remove-AzAutomationSourceControl + +## SYNOPSIS +Removes an Azure Automation source control. + +## SYNTAX + +``` +Remove-AzAutomationSourceControl [-Name] [-PassThru] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The Remove-AzAutomationSourceControl cmdlet removes a source control from Azure Automation. + +## EXAMPLES + +### Example 1 +This command removes the Automation source control named VSTSNative in the account named devAccount. + +```powershell +Remove-AzAutomationSourceControl -ResourceGroupName "rg1" ` + -AutomationAccountName "devAccount" ` + -Name "VSTSNative" +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The source control name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +PassThru returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationVariable.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationVariable.md new file mode 100644 index 0000000000..053e505c45 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationVariable.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 760C03A0-12DB-43C4-A180-B013FA77A513 +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationvariable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationVariable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationVariable.md +--- + +# Remove-AzAutomationVariable + +## SYNOPSIS +Removes an Automation variable. + +## SYNTAX + +``` +Remove-AzAutomationVariable [-Name] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzAutomationVariable** cmdlet removes a variable from Azure Automation. + +## EXAMPLES + +### Example 1: Remove a variable +```powershell +Remove-AzAutomationVariable -AutomationAccountName "Contoso17" -Name "StringVariable22" -ResourceGroupName "ResourceGroup01" +``` + +This command removes a variable named StringVariable22 in the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains the variable that this cmdlet deletes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the variable that this cmdlet deletes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group for which this cmdlet deletes a variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationVariable](./Get-AzAutomationVariable.md) + +[New-AzAutomationVariable](./New-AzAutomationVariable.md) + +[Set-AzAutomationVariable](./Set-AzAutomationVariable.md) + + diff --git a/azps-10.1.0/Az.Automation/Remove-AzAutomationWebhook.md b/azps-10.1.0/Az.Automation/Remove-AzAutomationWebhook.md new file mode 100644 index 0000000000..03ac702d84 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Remove-AzAutomationWebhook.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 71043093-DEE5-4395-B67A-2F104CF67893 +online version: https://learn.microsoft.com/powershell/module/az.automation/remove-azautomationwebhook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationWebhook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Remove-AzAutomationWebhook.md +--- + +# Remove-AzAutomationWebhook + +## SYNOPSIS +Removes a webhook from an Automation runbook. + +## SYNTAX + +``` +Remove-AzAutomationWebhook [-Name] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzAutomationWebhook** cmdlet removes a webhook from an Azure Automation runbook. +The webhook is deleted. + +## EXAMPLES + +### Example 1: Remove a webhook +```powershell +Remove-AzAutomationWebhook -Name "Webhook11" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" +``` + +This command removes a webhook named Webhook11 in the Automation account named AutomationAccount01. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account from which this cmdlet removes a webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the webhook that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet removes a webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationWebhook](./Get-AzAutomationWebhook.md) + +[New-AzAutomationWebhook](./New-AzAutomationWebhook.md) + +[Set-AzAutomationWebhook](./Set-AzAutomationWebhook.md) + + diff --git a/azps-10.1.0/Az.Automation/Resume-AzAutomationJob.md b/azps-10.1.0/Az.Automation/Resume-AzAutomationJob.md new file mode 100644 index 0000000000..e1df11cf66 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Resume-AzAutomationJob.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 9400E9EB-E927-44D5-8722-9706BDD92FD5 +online version: https://learn.microsoft.com/powershell/module/az.automation/resume-azautomationjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Resume-AzAutomationJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Resume-AzAutomationJob.md +--- + +# Resume-AzAutomationJob + +## SYNOPSIS +Resumes a suspended Automation job. + +## SYNTAX + +``` +Resume-AzAutomationJob [-Id] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Resume-AzAutomationJob** cmdlet resumes a suspended Azure Automation job. +Specify the suspended job. +To suspend a job, use the Suspend-AzAutomationJob cmdlet. + +## EXAMPLES + +### Example 1: Resume a suspended job +```powershell +Resume-AzAutomationJob -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 -ResourceGroupName "ResourceGroup01" +``` + +This command resumes the job that has the specified ID. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account in which this cmdlet resume a job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of a job that this cmdlet resumes. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: JobId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet resumes a job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationJob](./Get-AzAutomationJob.md) + +[Get-AzAutomationJobOutput](./Get-AzAutomationJobOutput.md) + +[Stop-AzAutomationJob](./Stop-AzAutomationJob.md) + +[Suspend-AzAutomationJob](./Suspend-AzAutomationJob.md) + + diff --git a/azps-10.1.0/Az.Automation/Set-AzAutomationAccount.md b/azps-10.1.0/Az.Automation/Set-AzAutomationAccount.md new file mode 100644 index 0000000000..52fe3095bb --- /dev/null +++ b/azps-10.1.0/Az.Automation/Set-AzAutomationAccount.md @@ -0,0 +1,293 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: B1897EFC-0184-4A8B-B8E4-203CC8E3B179 +online version: https://learn.microsoft.com/powershell/module/az.automation/set-azautomationaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationAccount.md +--- + +# Set-AzAutomationAccount + +## SYNOPSIS +Modifies an Automation account. + +## SYNTAX + +### AutomationServicesEncryption (Default) +``` +Set-AzAutomationAccount [-ResourceGroupName] [-Name] [-Plan ] [-Tags ] + [-AssignSystemIdentity] [-AssignUserIdentity ] [-AutomationServicesEncryption] + [-DisablePublicNetworkAccess] [-DefaultProfile ] [] +``` + +### KeyVaultEncryption +``` +Set-AzAutomationAccount [-ResourceGroupName] [-Name] [-Plan ] [-Tags ] + [-AssignSystemIdentity] [-AssignUserIdentity ] [-KeyVaultEncryption] -KeyName + -KeyVersion -KeyVaultUri [-UserIdentityEncryption ] [-DisablePublicNetworkAccess] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzAutomationAccount** cmdlet modifies an Azure Automation account. +For more information about Automation accounts, see the New-AzAutomationAccount cmdlet. + +## EXAMPLES + +### Example 1: Set the tags for an Automation account +```powershell +$Tags = @{"tag01"="value01";"tag02"="value02"} +Set-AzAutomationAccount -Name "AutomationAccount01" -ResourceGroupName "ResourceGroup01" -Tags $Tags +``` + +The first command assigns two key/value pairs to the $Tags variable. +The second command sets tags in $Tags for the Automation account named AutomationAccount01. + +### Example 2: Change the plan for an Automation account +```powershell +Set-AzAutomationAccount -Name "AutomationAccount01" -ResourceGroupName "ResourceGroup01" -Plan Basic +``` + +This command changes the plan to Basic for the Automation account named AutomationAccount01. + +## PARAMETERS + +### -AssignSystemIdentity +Generate and assign a new System Identity for this automation account + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignUserIdentity +Assign the User Assigned Identities to this automation account + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomationServicesEncryption +Whether to set Automation Account KeySource to Microsoft.Automation or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AutomationServicesEncryption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisablePublicNetworkAccess +Whether to disable traffic on the non-ARM endpoints (Webhook/Agent) from the public internet + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +CMK KeyName + +```yaml +Type: System.String +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultEncryption +Whether to set Automation Account KeySource to Microsoft.KeyVault(enable CMK) or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultUri +CMK KeyVaultUri + +```yaml +Type: System.String +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVersion +CMK KeyVersion + +```yaml +Type: System.String +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Automation account that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AutomationAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Plan +Specifies the plan for the Automation account. +Valid values are: +- Basic +- Free + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Free, Basic + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains the Automation account that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tags +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserIdentityEncryption +User Assigned Identity used for encryption + +```yaml +Type: System.String +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.IDictionary + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.AutomationAccount + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationAccount](./Get-AzAutomationAccount.md) + +[New-AzAutomationAccount](./New-AzAutomationAccount.md) + +[Remove-AzAutomationAccount](./Remove-AzAutomationAccount.md) diff --git a/azps-10.1.0/Az.Automation/Set-AzAutomationCertificate.md b/azps-10.1.0/Az.Automation/Set-AzAutomationCertificate.md new file mode 100644 index 0000000000..77565a5be1 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Set-AzAutomationCertificate.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: F1A2861F-14EF-4F67-8452-31FD498528BB +online version: https://learn.microsoft.com/powershell/module/az.automation/set-azautomationcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationCertificate.md +--- + +# Set-AzAutomationCertificate + +## SYNOPSIS +Modifies the configuration of an Automation certificate. + +## SYNTAX + +``` +Set-AzAutomationCertificate [-Name] [-Description ] [-Password ] + [-Path ] [-Exportable ] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzAutomationCertificate** cmdlet modifies the configuration of a certificate in Azure Automation. + +## EXAMPLES + +### Example 1: Modify a certificate +```powershell +$Password = ConvertTo-SecureString -String "Password" -AsPlainText -Force +Set-AzAutomationCertificate -AutomationAccountName "Contos17" -Name "ContosoCertificate" -Path "./cert.pfx" -Password $Password -ResourceGroupName "ResourceGroup01" +``` + +The first command converts a plain text password to be a secure string by using the ConvertTo-SecureString cmdlet. +The command stores that object in the $Password variable. +The second command modifies a certificate named ContosoCertificate. +The command uses the password stored in $Password. +The command specifies the account name and the path of the file that it uploads. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account for which this cmdlet modifies a certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the certificate that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Exportable +Specifies whether the certificate can be exported. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the certificate that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Password +Specifies the password for the certificate file. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the path to a script file to upload. +The file can be a .cer file or a .pfx file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet modifies a certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Security.SecureString + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.CertificateInfo + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationCertificate](./Get-AzAutomationCertificate.md) + +[New-AzAutomationCertificate](./New-AzAutomationCertificate.md) + +[Remove-AzAutomationCertificate](./Remove-AzAutomationCertificate.md) + + diff --git a/azps-10.1.0/Az.Automation/Set-AzAutomationConnectionFieldValue.md b/azps-10.1.0/Az.Automation/Set-AzAutomationConnectionFieldValue.md new file mode 100644 index 0000000000..3ac070de75 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Set-AzAutomationConnectionFieldValue.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: CA25260C-D0BF-4F9C-A846-9D9B6C48CE8A +online version: https://learn.microsoft.com/powershell/module/az.automation/set-azautomationconnectionfieldvalue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationConnectionFieldValue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationConnectionFieldValue.md +--- + +# Set-AzAutomationConnectionFieldValue + +## SYNOPSIS +Modifies the value of a field in an Automation connection. + +## SYNTAX + +``` +Set-AzAutomationConnectionFieldValue [-Name] -ConnectionFieldName -Value + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Set-AzAutomationConnectionFieldValue** cmdlet modifies the value of a field in a connection in Azure Automation. + +## EXAMPLES + +### Example 1: Change a field value in a connection +```powershell +Set-AzAutomationConnectionFieldValue -Name "ContosoConnection" -ConnectionFieldName "SubscriptionID" -Value "b53ec456-3494-4847-8f2b-180901c51050" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" +``` + +This command changes the subscription ID for the Azure connection named ContosoConnection in the Automation account named AutomationAccount01. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account for which this cmdlet modifies a field in a connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConnectionFieldName +Specifies a name for the field that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the connection for which this cmdlet modifies a field. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet modifies a field in a connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Specifies a value to modify in the connection field. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Object + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Connection + +## NOTES + +## RELATED LINKS + +[New-AzAutomationConnection](./New-AzAutomationConnection.md) + + diff --git a/azps-10.1.0/Az.Automation/Set-AzAutomationCredential.md b/azps-10.1.0/Az.Automation/Set-AzAutomationCredential.md new file mode 100644 index 0000000000..0377cc5b06 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Set-AzAutomationCredential.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: D6325A22-2D1B-4228-A5BC-3F1071E26FB2 +online version: https://learn.microsoft.com/powershell/module/az.automation/set-azautomationcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationCredential.md +--- + +# Set-AzAutomationCredential + +## SYNOPSIS +Modifies an Automation credential. + +## SYNTAX + +``` +Set-AzAutomationCredential [-Name] [-Description ] [-Value ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Set-AzAutomationCredential** cmdlet modifies a credential as a **PSCredential** object in Azure Automation. + +## EXAMPLES + +### Example 1: Update a credential +```powershell +$User = "Contoso\DChew" +$Password = ConvertTo-SecureString "Password" -AsPlainText -Force +$Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $Password +Set-AzAutomationCredential -AutomationAccountName "Contoso17" -Name "ContosoCredential" -ResourceGroupName "ResourceGroup01" -Value $Credential +``` + +The first command assigns a user name to the $User variable. +The second command converts a plain text password into a secure string by using the ConvertTo-SecureString cmdlet. +The command stores that object in the $Password variable. +The third command creates a credential based on $User and $Password, and then stores it in the $Credential variable. +The final command modifies the Automation credential named ContosoCredential to use the credential in $Credential. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account for which this cmdlet modifies a credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the credential that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the credential that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet modifies a credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Specifies the credentials as a **PSCredential** object. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.PSCredential + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.CredentialInfo + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationCredential](./Get-AzAutomationCredential.md) + +[New-AzAutomationCredential](./New-AzAutomationCredential.md) + +[Remove-AzAutomationCredential](./Remove-AzAutomationCredential.md) + + diff --git a/azps-10.1.0/Az.Automation/Set-AzAutomationDscNode.md b/azps-10.1.0/Az.Automation/Set-AzAutomationDscNode.md new file mode 100644 index 0000000000..6a7540e636 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Set-AzAutomationDscNode.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 60023C8D-EA37-41DA-97E6-AF89F7F9BADD +online version: https://learn.microsoft.com/powershell/module/az.automation/set-azautomationdscnode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationDscNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationDscNode.md +--- + +# Set-AzAutomationDscNode + +## SYNOPSIS +Modifies the node configuration that a DSC node is mapped to. + +## SYNTAX + +``` +Set-AzAutomationDscNode -Id -NodeConfigurationName [-Force] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Set-AzAutomationDscNode** cmdlet modifies an APS Desired State Configuration (DSC) node configuration. +Azure Automation stores DSC node configuration as a Managed Object Format (MOF) configuration document. + +## EXAMPLES + +### Example 1: Modify node configuration mapping +```powershell +Set-AzAutomationDscNode -NodeConfigurationName "Contoso.NodeConfiguration01" -ResourceGroupName "ResourceGroup01" -Id 064a8929-c98b-25e4-80hh-111c8a6067j8 +``` + +This command assigns the node configuration named Contoso.NodeConfiguration01 to the node that has the specified GUID. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains the DSC node for which this cmdlet modifies the configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the unique ID of the DSC node for which this cmdlet modifies the configuration. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: NodeId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeConfigurationName +Specifies the name of the node configuration to which this cmdlet maps the node. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet modifies a DSC node configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.DscNode + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationDscNode](./Get-AzAutomationDscNode.md) + +[Register-AzAutomationDscNode](./Register-AzAutomationDscNode.md) + +[Unregister-AzAutomationDscNode](./Unregister-AzAutomationDscNode.md) + + diff --git a/azps-10.1.0/Az.Automation/Set-AzAutomationHybridRunbookWorkerGroup.md b/azps-10.1.0/Az.Automation/Set-AzAutomationHybridRunbookWorkerGroup.md new file mode 100644 index 0000000000..b784668c01 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Set-AzAutomationHybridRunbookWorkerGroup.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/set-azautomationhybridrunbookworkergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationHybridRunbookWorkerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationHybridRunbookWorkerGroup.md +--- + +# Set-AzAutomationHybridRunbookWorkerGroup + +## SYNOPSIS +Updates a hybrid runbook worker group. + +## SYNTAX + +``` +Set-AzAutomationHybridRunbookWorkerGroup [-Name] [-CredentialName ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Set-AzAutomationHybridRunbookWorkerGroup** cmdlet updates a hybrid runbook worker group. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzAutomationHybridRunbookWorkerGroup -AutomationAccountName "Contoso17" -Name "RunbookWorkerGroupName" -ResourceGroupName "ResourceGroup01" -CredentialName "AutomationCredentialName" +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CredentialName +The credential present in the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WorkerGroup, RunbookWorkerGroup + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Automation.Models.HybridRunbookWorkerGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Set-AzAutomationModule.md b/azps-10.1.0/Az.Automation/Set-AzAutomationModule.md new file mode 100644 index 0000000000..e529dacb3d --- /dev/null +++ b/azps-10.1.0/Az.Automation/Set-AzAutomationModule.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: A06D36D7-3F72-4D21-8995-9DBBB9A9B880 +online version: https://learn.microsoft.com/powershell/module/az.automation/set-azautomationmodule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationModule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationModule.md +--- + +# Set-AzAutomationModule + +## SYNOPSIS +Updates a module in Automation. + +## SYNTAX + +``` +Set-AzAutomationModule [-Name] [-ContentLinkUri ] [-ContentLinkVersion ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Set-AzAutomationModule** cmdlet updates a module in Azure Automation. +This command accepts a compressed file that has a .zip file name extension. +The file contains a folder that includes a file that is one of the following types: +- wps_2 module, which has a .psm1 or .dll file name extension +- wps_2 module manifest, which has a .psd1 file name extension +The name of the .zip file, the name of the folder, and the name of the file in the folder must be the same. +Specify the .zip file as a URL that the Automation service can access. +If you import a wps_2 module into Automation by using this cmdlet or the New-AzAutomationModule cmdlet, the operation is asynchronous. +The command finishes whether the import succeeds or fails. +To check whether it succeeded, run the following command: +`PS C:\\\> $ModuleInstance = Get-AzAutomationModule -Name `ModuleName +Check the **ProvisioningState** property for a value of Succeeded. + +## EXAMPLES + +### Example 1: Update a module +```powershell +Set-AzAutomationModule -AutomationAccountName "Contoso17" -Name "ContosoModule" -ContentLinkUri "http://contosostorage.blob.core.windows.net/modules/ContosoModule.zip" -ContentLinkVersion "1.1" -ResourceGroupName "ResourceGroup01" +``` + +This command imports an updated version of an existing module named ContosoModule into the Automation account named Contoso17. The module is stored in an Azure blob in a storage account named contosostorage and a container named modules. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account for which this cmdlet updates a module. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContentLinkUri +Specifies the URL of the .zip file that contains the new version of a module that this cmdlet imports. + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: ContentLink + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContentLinkVersion +Specifies the version of the module to which this cmdlet updates Automation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the module that this cmdlet imports. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet updates a module. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Uri + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Module + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationModule](./Get-AzAutomationModule.md) + +[New-AzAutomationModule](./New-AzAutomationModule.md) + +[Remove-AzAutomationModule](./Remove-AzAutomationModule.md) + + diff --git a/azps-10.1.0/Az.Automation/Set-AzAutomationPython3Package.md b/azps-10.1.0/Az.Automation/Set-AzAutomationPython3Package.md new file mode 100644 index 0000000000..ac387d87b8 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Set-AzAutomationPython3Package.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/set-azautomationpython3package +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationPython3Package.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationPython3Package.md +--- + +# Set-AzAutomationPython3Package + +## SYNOPSIS +Update Python3 Package in Automation account + +## SYNTAX + +``` +Set-AzAutomationPython3Package [-Name] [-ContentLinkUri ] [-ContentLinkVersion ] + [-ResourceGroupName] [-AutomationAccountName] +``` + +## DESCRIPTION +The **Set-AzAutomationPython3Package** cmdlet updates a Python3 Package in Automation Account. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzAutomationPython3Package -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -Name "Python3PackageName" -ContentLinkUri "https://packageURI.com/package.whl" +``` + + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContentLinkUri +The url to module zip file package. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: ContentLink + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContentLinkVersion +The ContentLink version. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The module name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Uri + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Module + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Set-AzAutomationRunbook.md b/azps-10.1.0/Az.Automation/Set-AzAutomationRunbook.md new file mode 100644 index 0000000000..cb4ed668f0 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Set-AzAutomationRunbook.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 920C028B-0471-43EB-9123-C444289FD845 +online version: https://learn.microsoft.com/powershell/module/az.automation/set-azautomationrunbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationRunbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationRunbook.md +--- + +# Set-AzAutomationRunbook + +## SYNOPSIS +Modifies a runbook. + +## SYNTAX + +``` +Set-AzAutomationRunbook [-Name] [-Description ] [-Tag ] [-LogProgress ] + [-LogVerbose ] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzAutomationRunbook** cmdlet modifies the configuration of an Azure Automation runbook in APS. + +## EXAMPLES + +### Example 1: Enable verbose logging for a runbook +```powershell +Set-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbook02" -LogVerbose $True -ResourceGroupName "ResourceGroup01" +``` + +This command enables verbose logging for the jobs of the specified runbook in the Azure Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account in which this cmdlet modifies a runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LogProgress +Specifies whether the runbook logs progress. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LogVerbose +Specifies whether logging includes detailed information. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the runbook that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet modifies a runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The runbook tags. + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.IDictionary + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Runbook + +## NOTES + +## RELATED LINKS + +[Export-AzAutomationRunbook](./Export-AzAutomationRunbook.md) + +[Get-AzAutomationRunbook](./Get-AzAutomationRunbook.md) + +[Import-AzAutomationRunbook](./Import-AzAutomationRunbook.md) + +[New-AzAutomationRunbook](./New-AzAutomationRunbook.md) + +[New-AzAutomationRunbook](./New-AzAutomationRunbook.md) + +[Publish-AzAutomationRunbook](./Publish-AzAutomationRunbook.md) + +[Remove-AzAutomationRunbook](./Remove-AzAutomationRunbook.md) + +[Start-AzAutomationRunbook](./Start-AzAutomationRunbook.md) + + diff --git a/azps-10.1.0/Az.Automation/Set-AzAutomationSchedule.md b/azps-10.1.0/Az.Automation/Set-AzAutomationSchedule.md new file mode 100644 index 0000000000..3c6519b10a --- /dev/null +++ b/azps-10.1.0/Az.Automation/Set-AzAutomationSchedule.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 6429C564-1995-4D9B-BF9B-963B4F5FB3BD +online version: https://learn.microsoft.com/powershell/module/az.automation/set-azautomationschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationSchedule.md +--- + +# Set-AzAutomationSchedule + +## SYNOPSIS +Modifies an Automation schedule. + +## SYNTAX + +``` +Set-AzAutomationSchedule [-Name] [-IsEnabled ] [-Description ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Set-AzAutomationSchedule** cmdlet modifies a schedule in Azure Automation. + +## EXAMPLES + +### Example 1: Modify a schedule +```powershell +Set-AzAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule01" -Description "Automation Schedule" -ResourceGroupName "ResourceGroup01" +``` + +This command modifies the description of the schedule named Schedule01. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account for which this cmdlet modifies a schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IsEnabled +Specifies whether this cmdlet enables the schedule. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name for the schedule that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which this cmdlet modifies a schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Schedule + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationSchedule](./Get-AzAutomationSchedule.md) + +[New-AzAutomationSchedule](./New-AzAutomationSchedule.md) + +[Remove-AzAutomationSchedule](./Remove-AzAutomationSchedule.md) + + diff --git a/azps-10.1.0/Az.Automation/Set-AzAutomationVariable.md b/azps-10.1.0/Az.Automation/Set-AzAutomationVariable.md new file mode 100644 index 0000000000..81084db9cf --- /dev/null +++ b/azps-10.1.0/Az.Automation/Set-AzAutomationVariable.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: F344D8D1-5593-4C09-A1CA-37579D2A3A61 +online version: https://learn.microsoft.com/powershell/module/az.automation/set-azautomationvariable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationVariable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationVariable.md +--- + +# Set-AzAutomationVariable + +## SYNOPSIS +Modifies an Automation variable. + +## SYNTAX + +### UpdateVariableValue +``` +Set-AzAutomationVariable [-Name] -Encrypted -Value [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +### UpdateVariableDescription +``` +Set-AzAutomationVariable [-Name] -Description [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzAutomationVariable** cmdlet modifies the value or description of a variable in Azure Automation. +To encrypt the variable, specify the *Encrypted* parameter. +You cannot modify the encrypted state of a variable after creation. +Specifying *Encrypted* for an existing, non-encrypted, variable fails. + +## EXAMPLES + +### Example 1: Set the value of a variable +```powershell +Set-AzAutomationVariable -AutomationAccountName "Contoso17" -Name "StringVariable22" -ResourceGroupName "ResourceGroup01" -Value "New Value" -Encrypted $False +``` + +This command sets a new value for the variable named StringVariable22 in the Azure Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account in which the variable is stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the variable. + +```yaml +Type: System.String +Parameter Sets: UpdateVariableDescription +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Encrypted +Specifies whether cmdlet encrypts the value of the variable for storage. + +```yaml +Type: System.Boolean +Parameter Sets: UpdateVariableValue +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the variable that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group for which this cmdlet modifies a variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Specifies a value for the variable. + +```yaml +Type: System.Object +Parameter Sets: UpdateVariableValue +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Boolean + +### System.Object + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Variable + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationVariable](./Get-AzAutomationVariable.md) + +[New-AzAutomationVariable](./New-AzAutomationVariable.md) + +[Remove-AzAutomationVariable](./Remove-AzAutomationVariable.md) + + diff --git a/azps-10.1.0/Az.Automation/Set-AzAutomationWebhook.md b/azps-10.1.0/Az.Automation/Set-AzAutomationWebhook.md new file mode 100644 index 0000000000..9ec8352738 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Set-AzAutomationWebhook.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 9EA7F710-36FB-435C-BF28-1015E5D3155F +online version: https://learn.microsoft.com/powershell/module/az.automation/set-azautomationwebhook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationWebhook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Set-AzAutomationWebhook.md +--- + +# Set-AzAutomationWebhook + +## SYNOPSIS +Modifies a webhook for an Automation runbook. + +## SYNTAX + +``` +Set-AzAutomationWebhook [-Name] [-IsEnabled] [[-Parameters] ] [-RunOn ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Set-AzAutomationWebhook** cmdlet modifies a webhook for an Azure Automation runbook. + +## EXAMPLES + +### Example 1: Disable a webhook +```powershell +Set-AzAutomationWebhook -Name "Webhook01" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -IsEnabled $False +``` + +This command disables a webhook named Webhook01 in the Automation account named AutomationAccount01. + +### Example 2 +```powershell +Set-AzAutomationWebhook -Name "Webhook01" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -RunOn 'Windows' +``` + +This command sets the run on value for the webhook and forces the runbook to be run on a Hybrid Worker group called Windows. + +### Example 3 +```powershell +Set-AzAutomationWebhook -Name "Webhook01" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -RunOn $null +``` + +This command updates the run on value for the webhook and forces the runbook to be run on an Azure runbook worker. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account in which this cmdlet modifies a webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsEnabled +Specifies whether the webhook is enabled. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name of the webhook that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameters +Specifies a dictionary of key/value pairs. +The keys are the runbook parameter names. +The values are the runbook parameter values. +When the runbook starts in response to a webhook, these parameters are passed to the runbook. + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which this cmdlet modifies a webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunOn +Optional name of the hybrid agent which should execute the runbook + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HybridWorker + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Collections.IDictionary + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Webhook + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationWebhook](./Get-AzAutomationWebhook.md) + +[New-AzAutomationWebhook](./New-AzAutomationWebhook.md) + +[Remove-AzAutomationWebhook](./Remove-AzAutomationWebhook.md) + + diff --git a/azps-10.1.0/Az.Automation/Start-AzAutomationDscCompilationJob.md b/azps-10.1.0/Az.Automation/Start-AzAutomationDscCompilationJob.md new file mode 100644 index 0000000000..f0035c2f56 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Start-AzAutomationDscCompilationJob.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 32CF9BF7-519F-4B5D-9F2B-3CC556A77A48 +online version: https://learn.microsoft.com/powershell/module/az.automation/start-azautomationdsccompilationjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Start-AzAutomationDscCompilationJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Start-AzAutomationDscCompilationJob.md +--- + +# Start-AzAutomationDscCompilationJob + +## SYNOPSIS +Compiles a DSC configuration in Automation. + +## SYNTAX + +``` +Start-AzAutomationDscCompilationJob [-ConfigurationName] [-Parameters ] + [-ConfigurationData ] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [-IncrementNodeConfigurationBuild] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Start-AzAutomationDscCompilationJob** cmdlet compiles an APS Desired State Configuration (DSC) configuration in Azure Automation. + +## EXAMPLES + +### Example 1: Compile an Azure DSC configuration in Automation +```powershell +$Params = @{"StringParam"="Hello World";"IntegerParam"=32} +Start-AzAutomationDscCompilationJob -ConfigurationName "Config01" -Parameters $Params -ResourceGroupName "ResourceGroup01" +``` + +The first command creates a dictionary of parameters, and stores them in the $Params variable. +The second command compiles the DSC configuration named Config01. +The command includes the values in $Params for DSC configuration parameters. + +### Example 2: Compile an Azure DSC configuration in Automation with a new Node Configuration build version. +```powershell +$Params = @{"StringParam"="Hello World";"IntegerParam"=32} +Start-AzAutomationDscCompilationJob -ConfigurationName "Config01" -Parameters $Params -ResourceGroupName "ResourceGroup01" -IncrementNodeConfigurationBuild +``` + +Similar to the first example, the first command creates a dictionary of parameters, and stores them in the $Params variable. +The second command compiles the DSC configuration named Config01. +The command includes the values in $Params for DSC configuration parameters. +It does not override the earlier existing Node Configuration by creating a new Node Configuration with the name `Config01[<2>].`. +The version number is incremented based on the existing version number already present. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConfigurationData +Specifies a dictionary of configuration data for DSC configuration. + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationName +Specifies the name of the DSC configuration that this cmdlet compiles. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncrementNodeConfigurationBuild +Creates a new Node Configuration build version. + +```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 +Specifies a dictionary of parameters that this cmdlet uses to compile the DSC configuration. + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet compiles a configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.CompilationJob + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationDscCompilationJob](./Get-AzAutomationDscCompilationJob.md) + +[Get-AzAutomationDscCompilationJobOutput](./Get-AzAutomationDscCompilationJobOutput.md) + + diff --git a/azps-10.1.0/Az.Automation/Start-AzAutomationDscNodeConfigurationDeployment.md b/azps-10.1.0/Az.Automation/Start-AzAutomationDscNodeConfigurationDeployment.md new file mode 100644 index 0000000000..439c96e9d3 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Start-AzAutomationDscNodeConfigurationDeployment.md @@ -0,0 +1,295 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 32CF9BF7-519F-4B5D-9F2B-3CC556A77A48 +online version: https://learn.microsoft.com/powershell/module/az.automation/start-azautomationdscnodeconfigurationdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Start-AzAutomationDscNodeConfigurationDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Start-AzAutomationDscNodeConfigurationDeployment.md +--- + +# Start-AzAutomationDscNodeConfigurationDeployment + +## SYNOPSIS +Deploys a DSC Node configuration in Automation. + +## SYNTAX + +### ByAll (Default) +``` +Start-AzAutomationDscNodeConfigurationDeployment [-NodeConfigurationName] [-NodeName] + [-Schedule ] [-Force] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Start-AzAutomationDscNodeConfigurationDeployment [-NodeConfigurationName] [-NodeName] + -InputObject [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Start-AzAutomationDscNodeConfigurationDeployment** cmdlet deploys a Desired State Configuration (DSC) node configuration in Azure Automation. + +## EXAMPLES + +### Example 1: Deploy an Azure DSC node configuration in Automation +```powershell +$pilot = @("WebServerPilot1", "WebServerPilot2") +$prod = @("WebServerProd1", "WebServerProd2") +$nodes = @($pilot, $prod) +Start-AzAutomationDscNodeConfigurationDeployment ` + -NodeConfigurationName "Config01.Node1" ` + -AutomationAccountName "Contoso01" ` + -ResourceGroupName "ResourceGroup01" ` + -NodeName $nodes +``` + +```output +Starting a node configuration deployment. +Starting a node configuration deployment. It will override any existing node configurations assigned to the node. +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Yes + +ResourceGroupName : ResourceGroup01 +AutomationAccountName : Contoso01 +JobId : 35b14eb4-52b7-4a1d-ad62-8e9f84adc657 +Job : Microsoft.Azure.Commands.Automation.Model.Job +JobStatus : New +NodeStatus : +NodeConfigurationName : Config01.Node1 +JobSchedule : +JobScheduleId : 00000000-0000-0000-0000-000000000000 +``` + +The above command deploys the DSC node configuration named "Config01.Node1" to the given two-dimensional array of Node Names. The deployment happens in a staged manner. + +### Example 2: Schedule an Azure DSC node configuration deployment in Automation +```powershell +$sched = New-AzAutomationSchedule -AutomationAccountName "Contoso01" ` + -ResourceGroupName "ResourceGroup01" ` + -Name "TestSchedule" ` + -StartTime "23:00" ` + -OneTime +$pilot = @("WebServerPilot1", "WebServerPilot2") +$prod = @("WebServerProd1", "WebServerProd2") +$nodes = @($pilot, $prod) +Start-AzAutomationDscNodeConfigurationDeployment ` + -NodeConfigurationName "Config01.Node1" ` + -AutomationAccountName "Contoso01" ` + -ResourceGroupName "ResourceGroup01" ` + -NodeName $nodes ` + -Schedule $sched +``` + +```output +Starting a node configuration deployment. +Starting a node configuration deployment. It will override any existing node configurations assigned to the node. +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y + +ResourceGroupName : ResourceGroup01 +AutomationAccountName : Contoso01 +JobId : 00000000-0000-0000-0000-000000000000 +Job : +JobStatus : +NodeStatus : +NodeConfigurationName : Config01.Node1 +JobSchedule : Microsoft.Azure.Commands.Automation.Model.JobSchedule +JobScheduleId : 2b1d7738-093d-4ff7-b87b-e4b2321319e5 +``` + +The above command schedules a deployment of a DSC node configuration named "Config01.Node1" to the given two-dimensional array of Node Names. The deployment happens in a staged manner and will be executed based on the schedule. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByAll +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input object for Piping + +```yaml +Type: Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeployment +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NodeConfigurationName +Specifies the name of the DSC node configuration that this cmdlet deploys. + +```yaml +Type: System.String +Parameter Sets: ByAll +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByInputObject +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeName +Specifies the names of the nodes to which the Node Configuration would be deployed to. + +```yaml +Type: System.String[][] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet compiles a configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Schedule +Automation Schedule object to schedule the deployment job. + +```yaml +Type: Microsoft.Azure.Commands.Automation.Model.Schedule +Parameter Sets: ByAll +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeployment + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeployment + +## NOTES + +## RELATED LINKS + +[Start-AzAutomationDscCompilationJob](./Start-AzAutomationDscCompilationJob.md) + +[Import-AzAutomationDscNodeConfiguration](./Import-AzAutomationDscNodeConfiguration.md) + +[Stop-AzAutomationDscNodeConfigurationDeployment](./Stop-AzAutomationDscNodeConfigurationDeployment.md) + +[Get-AzAutomationDscNodeConfigurationDeployment](./Get-AzAutomationDscNodeConfigurationDeployment.md) + +[Get-AzAutomationDscNodeConfigurationDeploymentSchedule](./Get-AzAutomationDscNodeConfigurationDeploymentSchedule.md) + +[New-AzAutomationSchedule](./New-AzAutomationSchedule.md) diff --git a/azps-10.1.0/Az.Automation/Start-AzAutomationRunbook.md b/azps-10.1.0/Az.Automation/Start-AzAutomationRunbook.md new file mode 100644 index 0000000000..0230655c0b --- /dev/null +++ b/azps-10.1.0/Az.Automation/Start-AzAutomationRunbook.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: B2D9FF7B-EA3B-4853-814C-00FC4E328957 +online version: https://learn.microsoft.com/powershell/module/az.automation/start-azautomationrunbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Start-AzAutomationRunbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Start-AzAutomationRunbook.md +--- + +# Start-AzAutomationRunbook + +## SYNOPSIS +Starts a runbook job. + +## SYNTAX + +### ByAsynchronousReturnJob (Default) +``` +Start-AzAutomationRunbook [-Name] [-Parameters ] [-RunOn ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [] +``` + +### BySynchronousReturnJobOutput +``` +Start-AzAutomationRunbook [-Name] [-Parameters ] [-RunOn ] [-Wait] + [-MaxWaitSeconds ] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Start-AzAutomationRunbook** cmdlet starts an Azure Automation runbook job. +Specify the ID or name of a runbook. + +## EXAMPLES + +### Example 1: Start a runbook job +```powershell +Start-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01" +``` + +This command starts a runbook job for the runbook named Runbk01 in the Azure Automation account named Contoso17. + +### Example 2: Start a Python 2 runbook job with parameters +```powershell +$params = [ordered]@{"Key1"="ValueForPosition1";"Key2"="ValueForPosition2"} +Start-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "RunbkPy01" -ResourceGroupName "ResourceGroup01" -Parameters $params +``` + +This command starts a runbook job for the Python 2 runbook named RunbkPy01 in the Azure Automation account named Contoso17 with "ValueForPosition1" as the first positional parameter and "ValueForPosition2" for the second one. + +### Example 3: Start a runbook job and wait for results +```powershell +Start-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01" -MaxWaitSeconds 1000 -Wait +``` + +This command starts a runbook job for the runbook named Runbk01 in the Azure Automation account named Contoso17. +This command specifies the _Wait_ parameter. +Therefore, it returns results after the job is completed. +The cmdlet waits up to 1000 seconds for the results. + +## PARAMETERS + +### -AutomationAccountName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxWaitSeconds +Specifies the number of seconds this cmdlet waits for a job to finish before it abandons the job. +The default value is 10800, or three hours. + +```yaml +Type: System.Int32 +Parameter Sets: BySynchronousReturnJobOutput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunbookName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameters +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: JobParameters + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunOn +Specifies which Hybrid Worker Group on which to run the runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HybridWorker + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Indicates that this cmdlet waits for job to complete, suspend, or fail, and then returns control to Azure PowerShell. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BySynchronousReturnJobOutput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.Job + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS + +[Export-AzAutomationRunbook](./Export-AzAutomationRunbook.md) + +[Get-AzAutomationRunbook](./Get-AzAutomationRunbook.md) + +[Import-AzAutomationRunbook](./Import-AzAutomationRunbook.md) + +[New-AzAutomationRunbook](./New-AzAutomationRunbook.md) + +[New-AzAutomationRunbook](./New-AzAutomationRunbook.md) + +[Publish-AzAutomationRunbook](./Publish-AzAutomationRunbook.md) + +[Remove-AzAutomationRunbook](./Remove-AzAutomationRunbook.md) + +[Set-AzAutomationRunbook](./Set-AzAutomationRunbook.md) diff --git a/azps-10.1.0/Az.Automation/Start-AzAutomationSourceControlSyncJob.md b/azps-10.1.0/Az.Automation/Start-AzAutomationSourceControlSyncJob.md new file mode 100644 index 0000000000..16f9b96642 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Start-AzAutomationSourceControlSyncJob.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/start-azautomationsourcecontrolsyncjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Start-AzAutomationSourceControlSyncJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Start-AzAutomationSourceControlSyncJob.md +--- + +# Start-AzAutomationSourceControlSyncJob + +## SYNOPSIS +Starts an Azure Automation source control sync job. + +## SYNTAX + +``` +Start-AzAutomationSourceControlSyncJob -SourceControlName [-JobId ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Start-AzAutomationSourceControlSyncJob cmdlet starts a Azure Automation source control sync job for the given source control name. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzAutomationSourceControlSyncJob -ResourceGroupName "rg1" ` + -AutomationAccountName "devAccount" ` + -Name "VSTSNative" +``` + +```output +SourceControlSyncJobId SyncType Status StartTime EndTime +---------------------- -------- ------ --------- ------- +b51aed78-bef6-40d4-a966-cd45fd5af576 FullSync Running +``` + +## PARAMETERS + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId +The source control sync job id. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: SourceControlSyncJobId + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceControlName +The source control name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.SourceControlSyncJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Automation/Stop-AzAutomationDscNodeConfigurationDeployment.md b/azps-10.1.0/Az.Automation/Stop-AzAutomationDscNodeConfigurationDeployment.md new file mode 100644 index 0000000000..77f37be2a5 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Stop-AzAutomationDscNodeConfigurationDeployment.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: 32CF9BF7-519F-4B5D-9F2B-3CC556A77A48 +online version: https://learn.microsoft.com/powershell/module/az.automation/stop-azautomationdscnodeconfigurationdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Stop-AzAutomationDscNodeConfigurationDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Stop-AzAutomationDscNodeConfigurationDeployment.md +--- + +# Stop-AzAutomationDscNodeConfigurationDeployment + +## SYNOPSIS +Stops a DSC Node configuration deployment in Automation. It only stops the current deployment job but does not unassign already assigned node configurations. + +## SYNTAX + +### ByJobId (Default) +``` +Stop-AzAutomationDscNodeConfigurationDeployment -JobId [-Force] [-PassThru] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Stop-AzAutomationDscNodeConfigurationDeployment [-PassThru] -InputObject + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Stop-AzAutomationDscNodeConfigurationDeployment** cmdlet stops a deployment of a Desired State Configuration (DSC) node configuration in Azure Automation. It stops assignment of node configuration to groups of nodes, if any are remaining to be assigned, but does not unassign already assigned nodes. To unregister a scheduled job, please use the [Unregister-AzAutomationScheduledRunbook](./Unregister-AzAutomationScheduledRunbook.md) with the JobScheduleId to unassign an existing scheduled job. + +## EXAMPLES + +### Example 1: Deploy an Azure DSC node configuration in Automation +```powershell +Stop-AzAutomationDscNodeConfigurationDeployment -AutomationAccountName "Contoso01" -ResourceGroupName "ResourceGroup01" -JobId 00000000-0000-0000-0000-000000000000 +``` + +The above command stops the DSC node configuration deployment job with the jobId passed in. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByJobId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input object for Piping + +```yaml +Type: Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeployment +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobId +Specifies the Job id of an existing deployment job. + +```yaml +Type: System.Guid +Parameter Sets: ByJobId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet compiles a configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.Guid + +### Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeployment + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Start-AzAutomationDscCompilationJob](./Start-AzAutomationDscCompilationJob.md) + +[Import-AzAutomationDscNodeConfiguration](./Import-AzAutomationDscNodeConfiguration.md) + +[Start-AzAutomationDscNodeConfigurationDeployment](./Start-AzAutomationDscNodeConfigurationDeployment.md) + +[Get-AzAutomationDscNodeConfigurationDeployment](./Get-AzAutomationDscNodeConfigurationDeployment.md) + +[Get-AzAutomationDscNodeConfigurationDeploymentSchedule](./Get-AzAutomationDscNodeConfigurationDeploymentSchedule.md) diff --git a/azps-10.1.0/Az.Automation/Stop-AzAutomationJob.md b/azps-10.1.0/Az.Automation/Stop-AzAutomationJob.md new file mode 100644 index 0000000000..3641140177 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Stop-AzAutomationJob.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: BE1A9247-9F8E-45EA-9590-684A5A5662AC +online version: https://learn.microsoft.com/powershell/module/az.automation/stop-azautomationjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Stop-AzAutomationJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Stop-AzAutomationJob.md +--- + +# Stop-AzAutomationJob + +## SYNOPSIS +Stops an Automation job. + +## SYNTAX + +``` +Stop-AzAutomationJob [-Id] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Stop-AzAutomationJob** cmdlet stops an Azure Automation job. +Specify a running Automation job. + +## EXAMPLES + +### Example 1: Stop a job +```powershell +Stop-AzAutomationJob -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 -ResourceGroupName "ResourceGroup01" +``` + +This command stops the job that has the specified ID. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account in which this cmdlet stops a job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of a job that this cmdlet stops. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: JobId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationJob](./Get-AzAutomationJob.md) + +[Get-AzAutomationJobOutput](./Get-AzAutomationJobOutput.md) + +[Resume-AzAutomationJob](./Resume-AzAutomationJob.md) + +[Suspend-AzAutomationJob](./Suspend-AzAutomationJob.md) + + diff --git a/azps-10.1.0/Az.Automation/Suspend-AzAutomationJob.md b/azps-10.1.0/Az.Automation/Suspend-AzAutomationJob.md new file mode 100644 index 0000000000..952f8e2be6 --- /dev/null +++ b/azps-10.1.0/Az.Automation/Suspend-AzAutomationJob.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: FF44BCD2-AD8E-4F5C-AB10-BD6BD69E7F45 +online version: https://learn.microsoft.com/powershell/module/az.automation/suspend-azautomationjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Suspend-AzAutomationJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Suspend-AzAutomationJob.md +--- + +# Suspend-AzAutomationJob + +## SYNOPSIS +Suspends an Automation job. + +## SYNTAX + +``` +Suspend-AzAutomationJob [-Id] [-ResourceGroupName] [-AutomationAccountName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Suspend-AzAutomationJob** cmdlet suspends an Azure Automation job. +Specify a running Automation job. +To resume a suspended job, use the Resume-AzAutomationJob cmdlet. + +## EXAMPLES + +### Example 1: Suspend a job +```powershell +Suspend-AzAutomationJob -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 -ResourceGroupName "ResourceGroup01" +``` + +This command suspends the job that has the specified ID. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of an Automation account in which this cmdlet suspends a job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of a job that this cmdlet suspends. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: JobId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the ID of a job that this cmdlet suspends. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationJob](./Get-AzAutomationJob.md) + +[Get-AzAutomationJobOutput](./Get-AzAutomationJobOutput.md) + +[Resume-AzAutomationJob](./Resume-AzAutomationJob.md) + +[Stop-AzAutomationJob](./Stop-AzAutomationJob.md) + + diff --git a/azps-10.1.0/Az.Automation/Unregister-AzAutomationDscNode.md b/azps-10.1.0/Az.Automation/Unregister-AzAutomationDscNode.md new file mode 100644 index 0000000000..985dc1225f --- /dev/null +++ b/azps-10.1.0/Az.Automation/Unregister-AzAutomationDscNode.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: E4FC60AE-16B4-4E62-874F-49B9285CFF7A +online version: https://learn.microsoft.com/powershell/module/az.automation/unregister-azautomationdscnode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Unregister-AzAutomationDscNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Unregister-AzAutomationDscNode.md +--- + +# Unregister-AzAutomationDscNode + +## SYNOPSIS +Removes a DSC node from management by an Automation account. + +## SYNTAX + +``` +Unregister-AzAutomationDscNode -Id [-Force] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Unregister-AzAutomationDscNode** cmdlet removes an APS Desired State Configuration (DSC) node from management by an Azure Automation account. + +## EXAMPLES + +### Example 1: Remove an Azure DSC node from management by an Automation account +```powershell +Unregister-AzAutomationDscNode -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -Id 064a8929-c98b-25e4-80hh-111ca86067j8 +``` + +This command removes the DSC node that has the specified GUID from management by the Automation account named Contoso17. + +## PARAMETERS + +### -AutomationAccountName +Specifies the name of the Automation account from which this cmdlet removes a DSC node. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the unique ID of the DSC node that this cmdlet removes. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: NodeId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet unregisters a DSC node. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.DscNode + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationDscNode](./Get-AzAutomationDscNode.md) + +[Register-AzAutomationDscNode](./Register-AzAutomationDscNode.md) + +[Set-AzAutomationDscNode](./Set-AzAutomationDscNode.md) + + diff --git a/azps-10.1.0/Az.Automation/Unregister-AzAutomationScheduledRunbook.md b/azps-10.1.0/Az.Automation/Unregister-AzAutomationScheduledRunbook.md new file mode 100644 index 0000000000..4f0780a53c --- /dev/null +++ b/azps-10.1.0/Az.Automation/Unregister-AzAutomationScheduledRunbook.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +ms.assetid: C7C193CF-4E3A-4275-8289-946C99B1C553 +online version: https://learn.microsoft.com/powershell/module/az.automation/unregister-azautomationscheduledrunbook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Unregister-AzAutomationScheduledRunbook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Unregister-AzAutomationScheduledRunbook.md +--- + +# Unregister-AzAutomationScheduledRunbook + +## SYNOPSIS +Removes an association between a runbook and a schedule. + +## SYNTAX + +### ByJobScheduleId (Default) +``` +Unregister-AzAutomationScheduledRunbook -JobScheduleId [-Force] [-ResourceGroupName] + [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### ByRunbookNameAndScheduleName +``` +Unregister-AzAutomationScheduledRunbook -RunbookName -ScheduleName [-Force] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Unregister-AzAutomationScheduledRunbook** cmdlet removes the association between an Azure Automation runbook and a schedule. +The schedule no longer starts the runbook. + +## EXAMPLES + +### Example 1: Remove the association between a runbook and a schedule +```powershell +Unregister-AzAutomationScheduledRunbook -AutomationAccountName "Contoso17" -RunbookName "Runbk01" -ResourceGroupName "ResourceGroup01" -ScheduleName "Runbk01Sched" +``` + +This command removes the association between the runbook named Runbk01 and the schedule named Runbk01Sched. + +## PARAMETERS + +### -AutomationAccountName +Specifies an Automation account for the runbook on which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +ps_force + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobScheduleId +Specifies the ID of a scheduled runbook. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: ByJobScheduleId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for the scheduled runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunbookName +Specifies the name of the runbook that this cmdlet dissociates from a schedule. + +```yaml +Type: System.String +Parameter Sets: ByRunbookNameAndScheduleName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScheduleName +Specifies the name of the schedule from which this cmdlet dissociates a runbook. + +```yaml +Type: System.String +Parameter Sets: ByRunbookNameAndScheduleName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzAutomationScheduledRunbook](./Get-AzAutomationScheduledRunbook.md) + +[Register-AzAutomationScheduledRunbook](./Register-AzAutomationScheduledRunbook.md) + + diff --git a/azps-10.1.0/Az.Automation/Update-AzAutomationSourceControl.md b/azps-10.1.0/Az.Automation/Update-AzAutomationSourceControl.md new file mode 100644 index 0000000000..d2a5424d3c --- /dev/null +++ b/azps-10.1.0/Az.Automation/Update-AzAutomationSourceControl.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml +Module Name: Az.Automation +online version: https://learn.microsoft.com/powershell/module/az.automation/update-azautomationsourcecontrol +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Update-AzAutomationSourceControl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Automation/Automation/help/Update-AzAutomationSourceControl.md +--- + +# Update-AzAutomationSourceControl + +## SYNOPSIS +Updates an Azure Automation source control. + +## SYNTAX + +``` +Update-AzAutomationSourceControl -Name [-AccessToken ] [-FolderPath ] + [-Branch ] [-Description ] [-AutoSync ] [-PublishRunbook ] + [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Update-AzAutomationSourceControl cmdlet modifies the value of a field in a source control in Azure Automation. + +## EXAMPLES + +### Example 1 +This commands sets the PublishRunbook field to false for the Azure Automation source control named VSTSNative in the account named devAccount. + + +```powershell +Update-AzAutomationSourceControl -ResourceGroupName "rg1" ` + -AutomationAccountName "devAccount" ` + -Name "VSTSNative" ` + -PublishRunbook $false +``` + +```output +Name SourceType Branch FolderPath AutoSync PublishRunbook RepoUrl +---- ---------- ------ ---------- -------- -------------- ------- +VSTSNative VsoTfvc /MyRunbooks False False https://contoso.visualstudio.com/_git/Fin... +``` + +### Example 2 + +Updates an Azure Automation source control. (autogenerated) + + + + +```powershell +Update-AzAutomationSourceControl -AccessToken -AutomationAccountName 'devAccount' -Name 'VSTSNative' -ResourceGroupName 'rg1' +``` + +## PARAMETERS + +### -AccessToken +The source control access token. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomationAccountName +The automation account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutoSync +The autoSync property for the source control. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Branch +The source control branch. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The source control description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FolderPath +The source control folder path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The source control name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublishRunbook +The publishRunbook property of the source control. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Automation.Model.SourceControl + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.BareMetal/Az.BareMetal.md b/azps-10.1.0/Az.BareMetal/Az.BareMetal.md new file mode 100644 index 0000000000..e460f63b52 --- /dev/null +++ b/azps-10.1.0/Az.BareMetal/Az.BareMetal.md @@ -0,0 +1,21 @@ +--- +Module Name: Az.BareMetal +Module Guid: 4b038ccd-b128-4b3d-be04-8a9921c69093 +Download Help Link: https://learn.microsoft.com/powershell/module/az.baremetal +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BareMetal/help/Az.BareMetal.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BareMetal/help/Az.BareMetal.md +--- + +# Az.BareMetal Module +## Description +Microsoft Azure PowerShell: BareMetal cmdlets + +## Az.BareMetal Cmdlets +### [Get-AzBareMetal](Get-AzBareMetal.md) +Gets an Azure BareMetal instance for the specified subscription, resource group, and instance name. + +### [Update-AzBareMetal](Update-AzBareMetal.md) +Patches the Tags field of a Azure BareMetal instance for the specified subscription, resource group, and instance name. + diff --git a/azps-10.1.0/Az.BareMetal/Get-AzBareMetal.md b/azps-10.1.0/Az.BareMetal/Get-AzBareMetal.md new file mode 100644 index 0000000000..125df6a1aa --- /dev/null +++ b/azps-10.1.0/Az.BareMetal/Get-AzBareMetal.md @@ -0,0 +1,159 @@ +--- +external help file: +Module Name: Az.BareMetal +online version: https://learn.microsoft.com/powershell/module/az.baremetal/get-azbaremetal +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BareMetal/help/Get-AzBareMetal.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BareMetal/help/Get-AzBareMetal.md +--- + +# Get-AzBareMetal + +## SYNOPSIS +Gets an Azure BareMetal instance for the specified subscription, resource group, and instance name. + +## SYNTAX + +### List (Default) +``` +Get-AzBareMetal [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzBareMetal -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzBareMetal -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets an Azure BareMetal instance for the specified subscription, resource group, and instance name. + +## EXAMPLES + +### Example 1: List +```powershell +Get-AzBareMetal +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westus2 rhel79ora01 MWH03A-T210 +westus2 rhel79ora02 MWH03A-T210 +southcentralus oelnvmetest SAT09A-T230 +centraluseuap orcllabdsm01 DSM05A-T030 +``` + +Gets Azure BareMetal instance. + +### Example 2: Get +```powershell +Get-AzBareMetal -Name oelnvmetest -ResourceGroupName SAT09A-T230 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +southcentralus oelnvmetest SAT09A-T230 +``` + +Gets an Azure BareMetal instance for the specified subscription, resource group, and instance name. + +### Example 3: List1 +```powershell +Get-AzBareMetal -ResourceGroupName MWH03A-T210 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westus2 rhel79ora01 MWH03A-T210 +westus2 rhel79ora02 MWH03A-T210 +``` + +Gets Azure BareMetal instance for the resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure BareMetal on Azure instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AzureBareMetalInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BareMetal.Models.Api20210809.IAzureBareMetalInstance + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BareMetal/Update-AzBareMetal.md b/azps-10.1.0/Az.BareMetal/Update-AzBareMetal.md new file mode 100644 index 0000000000..0ce997aa19 --- /dev/null +++ b/azps-10.1.0/Az.BareMetal/Update-AzBareMetal.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.BareMetal +online version: https://learn.microsoft.com/powershell/module/az.baremetal/update-azbaremetal +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BareMetal/help/Update-AzBareMetal.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BareMetal/help/Update-AzBareMetal.md +--- + +# Update-AzBareMetal + +## SYNOPSIS +Patches the Tags field of a Azure BareMetal instance for the specified subscription, resource group, and instance name. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzBareMetal -Name -ResourceGroupName [-SubscriptionId ] [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzBareMetal -InputObject [-Tag ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Patches the Tags field of a Azure BareMetal instance for the specified subscription, resource group, and instance name. + +## EXAMPLES + +### Example 1: UpdateExpanded +```powershell +Update-AzBareMetal -Name oraclerac53 -ResourceGroupName SAT09A-T530 -Tag @{"env"="test"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +southcentralus oraclerac53 SAT09A-T530 +``` + +Patches the Tags field of a Azure BareMetal instance for the specified subscription, resource group, and instance name. + +### Example 2: UpdateViaIdentityExpanded +```powershell +Get-AzBareMetal -Name oraclerac53 -ResourceGroupName SAT09A-T530 | Update-AzBareMetal -Tag @{"env"="test"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +southcentralus oraclerac53 SAT09A-T530 +``` + +Patches the Tags field of a Azure BareMetal instance for the specified subscription, resource group, and instance name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BareMetal.Models.IBareMetalIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Azure BareMetal on Azure instance. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: AzureBareMetalInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags field of the AzureBareMetal instance. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BareMetal.Models.IBareMetalIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BareMetal.Models.Api20210809.IAzureBareMetalInstance + +## 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 + - `[AzureBareMetalInstanceName ]`: Name of the Azure BareMetal on Azure instance. + - `[Id ]`: Resource identity path + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Batch/Az.Batch.md b/azps-10.1.0/Az.Batch/Az.Batch.md new file mode 100644 index 0000000000..e4f1f092bb --- /dev/null +++ b/azps-10.1.0/Az.Batch/Az.Batch.md @@ -0,0 +1,237 @@ +--- +Module Name: Az.Batch +Module Guid: a8f00f40-1c1a-49b5-9db3-24076b75c3cf +Download Help Link: https://learn.microsoft.com/powershell/module/az.batch +Help Version: 4.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Az.Batch.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Az.Batch.md +--- + +# Az.Batch Module +## Description +The Azure Batch cmdlets in the Azure module enable you to manage Microsoft Azure Batch services in Azure PowerShell. + +## Az.Batch Cmdlets +### [Disable-AzBatchAutoScale](Disable-AzBatchAutoScale.md) +Disables automatic scaling of a pool. + +### [Disable-AzBatchComputeNodeScheduling](Disable-AzBatchComputeNodeScheduling.md) +Disables task scheduling on the specified compute node. + +### [Disable-AzBatchJob](Disable-AzBatchJob.md) +Disables a Batch job. + +### [Disable-AzBatchJobSchedule](Disable-AzBatchJobSchedule.md) +Disables a Batch job schedule. + +### [Enable-AzBatchAutoScale](Enable-AzBatchAutoScale.md) +Enables automatic scaling of a pool. + +### [Enable-AzBatchComputeNodeScheduling](Enable-AzBatchComputeNodeScheduling.md) +Enables task scheduling on the specified compute node. + +### [Enable-AzBatchJob](Enable-AzBatchJob.md) +Enables a Batch job. + +### [Enable-AzBatchJobSchedule](Enable-AzBatchJobSchedule.md) +Enables a Batch job schedule. + +### [Enable-AzBatchTask](Enable-AzBatchTask.md) +Reactivates a task. + +### [Get-AzBatchAccount](Get-AzBatchAccount.md) +Gets a Batch account in the current subscription. + +### [Get-AzBatchAccountKey](Get-AzBatchAccountKey.md) +Gets the keys of a Batch account. + +### [Get-AzBatchApplication](Get-AzBatchApplication.md) +Gets information about the specified application. + +### [Get-AzBatchApplicationPackage](Get-AzBatchApplicationPackage.md) +Gets information about an application package in a Batch account. + +### [Get-AzBatchCertificate](Get-AzBatchCertificate.md) +Gets the certificates in a Batch account. + +### [Get-AzBatchComputeNode](Get-AzBatchComputeNode.md) +Gets Batch compute nodes from a pool. + +### [Get-AzBatchComputeNodeExtension](Get-AzBatchComputeNodeExtension.md) +Gets Batch compute node extensions from a compute node. + +### [Get-AzBatchJob](Get-AzBatchJob.md) +Gets Batch jobs for a Batch account or job schedule. + +### [Get-AzBatchJobPreparationAndReleaseTaskStatus](Get-AzBatchJobPreparationAndReleaseTaskStatus.md) +Gets Batch job preparation and release task status. + +### [Get-AzBatchJobSchedule](Get-AzBatchJobSchedule.md) +Gets Batch job schedules. + +### [Get-AzBatchJobStatistic](Get-AzBatchJobStatistic.md) +Gets job summary statistics for a Batch account. + +### [Get-AzBatchLocationQuota](Get-AzBatchLocationQuota.md) +Gets the Batch service quotas for your subscription at the given location. + +### [Get-AzBatchNodeFile](Get-AzBatchNodeFile.md) +Gets the properties of Batch node files. + +### [Get-AzBatchNodeFileContent](Get-AzBatchNodeFileContent.md) +Gets a Batch node file. + +### [Get-AzBatchPool](Get-AzBatchPool.md) +Gets Batch pools under the specified Batch account. + +### [Get-AzBatchPoolNodeCount](Get-AzBatchPoolNodeCount.md) +Gets Batch node counts per node state grouped by pool id. + +### [Get-AzBatchPoolStatistic](Get-AzBatchPoolStatistic.md) +Gets pool summary statistics for a Batch account. + +### [Get-AzBatchPoolUsageMetric](Get-AzBatchPoolUsageMetric.md) +Gets pool usage metrics for a Batch account. + +### [Get-AzBatchRemoteDesktopProtocolFile](Get-AzBatchRemoteDesktopProtocolFile.md) +Gets an RDP file from a compute node. + +### [Get-AzBatchRemoteLoginSetting](Get-AzBatchRemoteLoginSetting.md) +Gets remote logon settings for a compute node. + +### [Get-AzBatchSubtask](Get-AzBatchSubtask.md) +Gets the subtask information of the specified task. + +### [Get-AzBatchSupportedImage](Get-AzBatchSupportedImage.md) +Gets Batch supported images for a Batch account. + +### [Get-AzBatchSupportedVirtualMachineSku](Get-AzBatchSupportedVirtualMachineSku.md) +Gets the list of Batch supported Virtual Machine VM sizes available at the given location. + +### [Get-AzBatchTask](Get-AzBatchTask.md) +Gets the Batch tasks for a job. + +### [Get-AzBatchTaskCount](Get-AzBatchTaskCount.md) +Gets the task counts for the specified job. + +### [Get-AzBatchTaskSlotCount](Get-AzBatchTaskSlotCount.md) +Gets the task slot counts for the specified job. + +### [New-AzBatchAccount](New-AzBatchAccount.md) +Creates a Batch account. + +### [New-AzBatchAccountKey](New-AzBatchAccountKey.md) +Regenerates a key of a Batch account. + +### [New-AzBatchApplication](New-AzBatchApplication.md) +Adds an application to the specified Batch account. + +### [New-AzBatchApplicationPackage](New-AzBatchApplicationPackage.md) +Creates an application package in a Batch account. + +### [New-AzBatchCertificate](New-AzBatchCertificate.md) +Adds a certificate to the specified Batch account. + +### [New-AzBatchComputeNodeUser](New-AzBatchComputeNodeUser.md) +Creates a user account on a Batch compute node. + +### [New-AzBatchJob](New-AzBatchJob.md) +Creates a job in the Batch service. + +### [New-AzBatchJobSchedule](New-AzBatchJobSchedule.md) +Creates a job schedule in the Batch service. + +### [New-AzBatchPool](New-AzBatchPool.md) +Creates a pool in the Batch service. + +### [New-AzBatchResourceFile](New-AzBatchResourceFile.md) +Creates a Resource File for usage by `New-AzBatchTask`. + +### [New-AzBatchTask](New-AzBatchTask.md) +Creates a Batch task under a job. + +### [Remove-AzBatchAccount](Remove-AzBatchAccount.md) +Removes a Batch account. + +### [Remove-AzBatchApplication](Remove-AzBatchApplication.md) +Deletes an application from a Batch account. + +### [Remove-AzBatchApplicationPackage](Remove-AzBatchApplicationPackage.md) +Deletes an application package record and the binary file. + +### [Remove-AzBatchCertificate](Remove-AzBatchCertificate.md) +Deletes a certificate from an account. + +### [Remove-AzBatchComputeNode](Remove-AzBatchComputeNode.md) +Removes compute nodes from a pool. + +### [Remove-AzBatchComputeNodeUser](Remove-AzBatchComputeNodeUser.md) +Deletes a user account from a Batch compute node. + +### [Remove-AzBatchJob](Remove-AzBatchJob.md) +Deletes a Batch job. + +### [Remove-AzBatchJobSchedule](Remove-AzBatchJobSchedule.md) +Removes a Batch job schedule. + +### [Remove-AzBatchNodeFile](Remove-AzBatchNodeFile.md) +Deletes a node file for a task or compute node. + +### [Remove-AzBatchPool](Remove-AzBatchPool.md) +Deletes the specified Batch pool. + +### [Remove-AzBatchTask](Remove-AzBatchTask.md) +Deletes a Batch task. + +### [Reset-AzBatchComputeNode](Reset-AzBatchComputeNode.md) +Reinstalls the operating system on the specified compute node. + +### [Restart-AzBatchComputeNode](Restart-AzBatchComputeNode.md) +Reboots the specified compute node. + +### [Set-AzBatchAccount](Set-AzBatchAccount.md) +Updates a Batch account. + +### [Set-AzBatchApplication](Set-AzBatchApplication.md) +Updates settings for the specified application. + +### [Set-AzBatchComputeNodeUser](Set-AzBatchComputeNodeUser.md) +Modifies properties of an account on a Batch compute node. + +### [Set-AzBatchJob](Set-AzBatchJob.md) +Updates a Batch job. + +### [Set-AzBatchJobSchedule](Set-AzBatchJobSchedule.md) +Sets a job schedule. + +### [Set-AzBatchPool](Set-AzBatchPool.md) +Updates the properties of a pool. + +### [Set-AzBatchTask](Set-AzBatchTask.md) +Updates the properties of a task. + +### [Start-AzBatchComputeNodeServiceLogUpload](Start-AzBatchComputeNodeServiceLogUpload.md) +Upload compute node service log files to an Azure Storage container. + +### [Start-AzBatchPoolResize](Start-AzBatchPoolResize.md) +Starts to resize a pool. + +### [Stop-AzBatchCertificateDeletion](Stop-AzBatchCertificateDeletion.md) +Cancels a failed deletion of a certificate. + +### [Stop-AzBatchJob](Stop-AzBatchJob.md) +Stops a Batch job. + +### [Stop-AzBatchJobSchedule](Stop-AzBatchJobSchedule.md) +Stops a Batch job schedule. + +### [Stop-AzBatchPoolResize](Stop-AzBatchPoolResize.md) +Stops a pool resize operation. + +### [Stop-AzBatchTask](Stop-AzBatchTask.md) +Stops a Batch task. + +### [Test-AzBatchAutoScale](Test-AzBatchAutoScale.md) +Gets the result of an automatic scaling formula on a pool. + diff --git a/azps-10.1.0/Az.Batch/Disable-AzBatchAutoScale.md b/azps-10.1.0/Az.Batch/Disable-AzBatchAutoScale.md new file mode 100644 index 0000000000..3db4ea1c07 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Disable-AzBatchAutoScale.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 9C755BE8-0624-4CF7-AE7C-34DAF44678E8 +online version: https://learn.microsoft.com/powershell/module/az.batch/disable-azbatchautoscale +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Disable-AzBatchAutoScale.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Disable-AzBatchAutoScale.md +--- + +# Disable-AzBatchAutoScale + +## SYNOPSIS +Disables automatic scaling of a pool. + +## SYNTAX + +``` +Disable-AzBatchAutoScale [-Id] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Disable-AzBatchAutoScale** cmdlet disables automatic scaling of the specified pool. + +## EXAMPLES + +### Example 1: Disable automatic scaling of a pool +```powershell +Disable-AzBatchAutoScale -Id "MyPool" -BatchContext $Context +``` + +This command disables automatic scaling for the pool named MyPool. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the object ID of the pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Enable-AzBatchAutoScale](./Enable-AzBatchAutoScale.md) + +[Test-AzBatchAutoScale](./Test-AzBatchAutoScale.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) + + diff --git a/azps-10.1.0/Az.Batch/Disable-AzBatchComputeNodeScheduling.md b/azps-10.1.0/Az.Batch/Disable-AzBatchComputeNodeScheduling.md new file mode 100644 index 0000000000..698becfb34 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Disable-AzBatchComputeNodeScheduling.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 2DF5FB4D-A5CB-439C-AC6F-DF2130AF33EC +online version: https://learn.microsoft.com/powershell/module/az.batch/disable-azbatchcomputenodescheduling +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Disable-AzBatchComputeNodeScheduling.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Disable-AzBatchComputeNodeScheduling.md +--- + +# Disable-AzBatchComputeNodeScheduling + +## SYNOPSIS +Disables task scheduling on the specified compute node. + +## SYNTAX + +### Id (Default) +``` +Disable-AzBatchComputeNodeScheduling [-PoolId] [-Id] + [-DisableSchedulingOption ] -BatchContext + [-DefaultProfile ] [] +``` + +### InputObject +``` +Disable-AzBatchComputeNodeScheduling [[-ComputeNode] ] + [-DisableSchedulingOption ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Disable-AzBatchComputeNodeScheduling** cmdlet disables task scheduling on the specified compute node. +A compute node is an Azure virtual machine dedicated to a specific application workload. +When you disable task scheduling on a compute node you will also have the option of determining what to do about jobs currently in the node's task queue. +**Disable-AzBatchComputeNodeScheduling** lets you do the following: +- Terminate the tasks and put them back in the job queue. +This enables those tasks to be rescheduled on another compute node. +- Terminate the tasks and remove them from the job queue. +Tasks stopped in this manner will not be rescheduled. +- Wait for all the tasks currently being executed to complete and then disable task scheduling on the compute node. +- Wait for all the running tasks to complete and all the data retention periods to expire, and then disable task scheduling on the compute node. + +## EXAMPLES + +### Example 1: Disable task scheduling on a compute node +```powershell +$Context = Get-AzBatchAccountKey -AccountName "contosobatchaccount" +Disable-AzBatchComputeNodeScheduling -PoolId "myPool" -Id "tvm-1783593343_34-20151117t222514z" -BatchContext $Context +``` + +These commands disable task schedule on the compute node tvm-1783593343_34-20151117t222514z. +To do this, the first command in the example creates an object reference to the account keys for the batch account contosobatchaccount. +This object reference is stored in a variable named $context. +The second command then uses this object reference and the **Disable-AzBatchComputeNodeScheduling** cmdlet to connect to the pool myPool and disable task scheduling on node tvm-1783593343_34-20151117t222514z. +Because the *DisableComputeNodeSchedulingOptions* parameter was not included any tasks currently running on the compute node will be requeued. + +### Example 2: Disable task scheduling on all compute nodes in a pool +```powershell +$Context = Get-AzBatchAccountKey -AccountName "contosobatchaccount" +Get-AzBatchComputeNode -PoolId "Pool06" -BatchContext $Context | Disable-AzBatchComputeNodeScheduling -BatchContext $Context +``` + +These commands disable task scheduling on all the computer nodes in the batch pool Pool06. +To perform this task, the first command in the example creates an object reference to the account keys for the batch account contosobatchaccount. +This object reference is stored in a variable named $context. +The second command in the example then uses this object reference and **Get-AzBatchComputeNode** to return a collection of all the compute nodes found in Pool06. +That collection is then piped to then **Disable-AzBatchComputeNodeScheduling** cmdlet to disable task scheduling on each compute node in the collection. +Because the *DisableComputeNodeSchedulingOptions* parameter was not included any tasks currently running on the compute nodes will be requeued. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNode +Specifies an object reference to the compute node where task scheduling is disabled. +This object reference is created by using the Get-AzBatchComputeNode cmdlet and storing the returned compute node object in a variable. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode +Parameter Sets: InputObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableSchedulingOption +Specifies how this cmdlet deals with any tasks currently running on the computer node where scheduling is being disabled. +The acceptable values for this parameter are: +- Requeue. +Tasks are stopped immediately and returned to the job queue. +This enables the tasks to be rescheduled on another compute node. +This is the default value. +- Terminate. +Tasks are stopped immediately and removed from the job queue. +These tasks will not be rescheduled. +- TaskCompletion. +Currently running tasks will be able to complete before task scheduling is disabled on the compute node. +No new tasks will be scheduled on this node. +- RetainedData. +Currently running tasks will be able to complete and data retention periods will be able to expire before task scheduling is disabled on the compute node. +No new tasks will be scheduled on this node. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption] +Parameter Sets: (All) +Aliases: +Accepted values: Requeue, Terminate, TaskCompletion + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the compute node where task scheduling is disabled. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the batch pool that contains the compute node where task scheduling is disabled. +If you use the *PoolId* parameter, do not use the *ComputeNode* parameter in that same command. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSComputeNode + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Enable-AzBatchComputeNodeScheduling](./Enable-AzBatchComputeNodeScheduling.md) + + diff --git a/azps-10.1.0/Az.Batch/Disable-AzBatchJob.md b/azps-10.1.0/Az.Batch/Disable-AzBatchJob.md new file mode 100644 index 0000000000..11047af87d --- /dev/null +++ b/azps-10.1.0/Az.Batch/Disable-AzBatchJob.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: C831F934-7513-4882-A155-816E56CD9807 +online version: https://learn.microsoft.com/powershell/module/az.batch/disable-azbatchjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Disable-AzBatchJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Disable-AzBatchJob.md +--- + +# Disable-AzBatchJob + +## SYNOPSIS +Disables a Batch job. + +## SYNTAX + +``` +Disable-AzBatchJob [-Id] [-DisableJobOption] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Disable-AzBatchJob** cmdlet disables an Azure Batch job. +After you enable a job, new tasks can run. +Disabled jobs do not run new tasks. +You can enable a disabled job later. + +## EXAMPLES + +### Example 1: Disable a Batch job +```powershell +Disable-AzBatchJob -Id "Job-000001" -DisableJobOption "Terminate" -BatchContext $Context +``` + +This command disables the job that has the ID Job-000001. +The command terminates active tasks for the job. +Use the **Get-AzBatchAccountKey** cmdlet to assign a context to the $Context variable. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableJobOption +Specifies what to do with active tasks associated with the job that this cmdlet disables. +Valid values are: +- Requeue +- Terminate +- Wait + +```yaml +Type: Microsoft.Azure.Batch.Common.DisableJobOption +Parameter Sets: (All) +Aliases: +Accepted values: Requeue, Terminate, Wait + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the job that this cmdlet disables. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Enable-AzBatchJob](./Enable-AzBatchJob.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchJob](./Get-AzBatchJob.md) + +[New-AzBatchJob](./New-AzBatchJob.md) + +[Remove-AzBatchJob](./Remove-AzBatchJob.md) + +[Stop-AzBatchJob](./Stop-AzBatchJob.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Disable-AzBatchJobSchedule.md b/azps-10.1.0/Az.Batch/Disable-AzBatchJobSchedule.md new file mode 100644 index 0000000000..21f3ba9391 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Disable-AzBatchJobSchedule.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: B4737AE8-F57C-4B95-B81E-74802EF8E7AE +online version: https://learn.microsoft.com/powershell/module/az.batch/disable-azbatchjobschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Disable-AzBatchJobSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Disable-AzBatchJobSchedule.md +--- + +# Disable-AzBatchJobSchedule + +## SYNOPSIS +Disables a Batch job schedule. + +## SYNTAX + +``` +Disable-AzBatchJobSchedule [-Id] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Disable-AzBatchJobSchedule** cmdlet disables an Azure Batch job schedule. +If you disable a schedule, jobs are not created according to that schedule. +You can enable a disabled schedule later. + +## EXAMPLES + +### Example 1: Disable a job schedule +```powershell +Disable-AzBatchJobSchedule -Id "JobSchedule17" -BatchContext $Context +``` + +This command disables the job schedule that has the ID JobSchedule17. +Use the **Get-AzBatchAccountKey** cmdlet to assign a context to the $Context variable. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the job schedule that this cmdlet disables. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Enable-AzBatchJobSchedule](./Enable-AzBatchJobSchedule.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchJobSchedule](./Get-AzBatchJobSchedule.md) + +[New-AzBatchJobSchedule](./New-AzBatchJobSchedule.md) + +[Remove-AzBatchJobSchedule](./Remove-AzBatchJobSchedule.md) + +[Stop-AzBatchJobSchedule](./Stop-AzBatchJobSchedule.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Enable-AzBatchAutoScale.md b/azps-10.1.0/Az.Batch/Enable-AzBatchAutoScale.md new file mode 100644 index 0000000000..94429f6159 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Enable-AzBatchAutoScale.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 3107D061-7F25-45D0-8029-C99120A156DA +online version: https://learn.microsoft.com/powershell/module/az.batch/enable-azbatchautoscale +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Enable-AzBatchAutoScale.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Enable-AzBatchAutoScale.md +--- + +# Enable-AzBatchAutoScale + +## SYNOPSIS +Enables automatic scaling of a pool. + +## SYNTAX + +``` +Enable-AzBatchAutoScale [-Id] [[-AutoScaleFormula] ] + [[-AutoScaleEvaluationInterval] ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Enable-AzBatchAutoScale** cmdlet enables automatic scaling of the specified pool. + +## EXAMPLES + +### Example 1: Enable automatic scaling for a pool +```powershell +$Formula = 'totalNodes=($CPUPercent.GetSamplePercent(TimeInterval_Minute*0,TimeInterval_Minute*10)<0.7?5:(min($CPUPercent.GetSample(TimeInterval_Minute*0, TimeInterval_Minute*10))>0.8?($CurrentDedicated*1.1):$CurrentDedicated));$TargetDedicated=min(100,totalNodes);'; +Enable-AzBatchAutoScale -Id "MyPool" -AutoScaleFormula $Formula -BatchContext $Context +``` + +The first command defines a formula, and then saves it to the $Formula variable. +The second command enables automatic scaling on the pool named MyPool using the formula in $Formula. + +## PARAMETERS + +### -AutoScaleEvaluationInterval +Specifies the amount of time (in minutes) that elapses before the pool size is automatically adjusted according to the AutoScale formula. +The default value is 15 minutes, and the minimum value is 5 minutes. + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoScaleFormula +Specifies the formula for the desired number of compute nodes in the pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the object ID of the pool for which to enable automatic scaling. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchAutoScale](./Disable-AzBatchAutoScale.md) + +[Test-AzBatchAutoScale](./Test-AzBatchAutoScale.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Enable-AzBatchComputeNodeScheduling.md b/azps-10.1.0/Az.Batch/Enable-AzBatchComputeNodeScheduling.md new file mode 100644 index 0000000000..47c0e18a94 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Enable-AzBatchComputeNodeScheduling.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 36EB9CE6-EAC9-471C-97D6-14E882E0F710 +online version: https://learn.microsoft.com/powershell/module/az.batch/enable-azbatchcomputenodescheduling +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Enable-AzBatchComputeNodeScheduling.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Enable-AzBatchComputeNodeScheduling.md +--- + +# Enable-AzBatchComputeNodeScheduling + +## SYNOPSIS +Enables task scheduling on the specified compute node. + +## SYNTAX + +### Id (Default) +``` +Enable-AzBatchComputeNodeScheduling [-PoolId] [-Id] -BatchContext + [-DefaultProfile ] [] +``` + +### InputObject +``` +Enable-AzBatchComputeNodeScheduling [[-ComputeNode] ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Enable-AzBatchComputeNodeScheduling** cmdlet enables task scheduling on the specified compute node. +A compute node is an Azure virtual machine dedicated to a specific application workload. + +## EXAMPLES + +### Example 1: Enable task scheduling on a compute node +```powershell +$Context = Get-AzBatchAccountKey -AccountName "contosobatchaccount" +Enable-AzBatchComputeNodeScheduling -PoolId "myPool" -Id "tvm-1783593343_34-20151117t222514z" -BatchContext $Context +``` + +These commands enable task scheduling on the compute node tvm-1783593343_34-20151117t222514z. +To do this, the first command in the example creates an object reference containing the account keys for the batch account contosobatchaccount. +This object reference is stored in a variable named $context. +The second command then uses this object reference and the **Enable-AzBatchComputeNodeScheduling** cmdlet to connect to the pool myPool and enable task scheduling on tvm-1783593343_34-20151117t222514z. + +### Example 2: Enable task scheduling on compute nodes in a pool +```powershell +$Context = Get-AzBatchAccountKey -AccountName "contosobatchaccount" +Get-AzBatchComputeNode -PoolId "Pool06" -BatchContext $Context | Enable-AzBatchComputeNodeScheduling -BatchContext $Context +``` + +These commands enable task scheduling on all the compute nodes found in the pool Pool06. +To perform this task, the first command in the example creates an object reference containing the account keys for the batch account contosobatchaccount. +This object reference is stored in a variable named $context. +The second command in the example then uses this object reference and **Get-AzBatchComputeNode** to return a collection of all the compute nodes found in Pool06. +That collection is then piped to the **Enable-AzBatchComputeNodeScheduling** cmdlet, which enables task scheduling on each compute node in the collection. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNode +Specifies an object reference to the compute node where task scheduling is enabled. +This object reference is created by using the Get-AzBatchComputeNode cmdlet and storing the returned compute node object in a variable. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode +Parameter Sets: InputObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the compute node where task scheduling is enabled. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the batch pool that contains the compute node where task scheduling is enabled. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSComputeNode + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchComputeNodeScheduling](./Disable-AzBatchComputeNodeScheduling.md) + + diff --git a/azps-10.1.0/Az.Batch/Enable-AzBatchJob.md b/azps-10.1.0/Az.Batch/Enable-AzBatchJob.md new file mode 100644 index 0000000000..ff7d7aca4d --- /dev/null +++ b/azps-10.1.0/Az.Batch/Enable-AzBatchJob.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 7C79BFF1-41E1-472D-AF67-1C3B39AB7548 +online version: https://learn.microsoft.com/powershell/module/az.batch/enable-azbatchjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Enable-AzBatchJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Enable-AzBatchJob.md +--- + +# Enable-AzBatchJob + +## SYNOPSIS +Enables a Batch job. + +## SYNTAX + +``` +Enable-AzBatchJob [-Id] -BatchContext [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Enable-AzBatchJob** cmdlet enables an Azure Batch job. +After you enable a job, new tasks can run. + +## EXAMPLES + +### Example 1: Enable a Batch job +```powershell +Enable-AzBatchJob -Id "Job-000001" -BatchContext $Context +``` + +This command enables the job that has the ID Job-000001. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the job that this cmdlet enables. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchJob](./Disable-AzBatchJob.md) + +[Get-AzBatchJob](./Get-AzBatchJob.md) + +[New-AzBatchJob](./New-AzBatchJob.md) + +[Remove-AzBatchJob](./Remove-AzBatchJob.md) + +[Stop-AzBatchJob](./Stop-AzBatchJob.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Enable-AzBatchJobSchedule.md b/azps-10.1.0/Az.Batch/Enable-AzBatchJobSchedule.md new file mode 100644 index 0000000000..fe6274a9b7 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Enable-AzBatchJobSchedule.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 02F91510-F14F-4401-BC5F-06B0874AEB4B +online version: https://learn.microsoft.com/powershell/module/az.batch/enable-azbatchjobschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Enable-AzBatchJobSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Enable-AzBatchJobSchedule.md +--- + +# Enable-AzBatchJobSchedule + +## SYNOPSIS +Enables a Batch job schedule. + +## SYNTAX + +``` +Enable-AzBatchJobSchedule [-Id] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Enable-AzBatchJobSchedule** cmdlet enables an Azure Batch job schedule. +After you enable a job schedule, jobs can be created according to that schedule. + +## EXAMPLES + +### Example 1: Enable a job schedule +```powershell +Enable-AzBatchJobSchedule -Id "JobSchedule17" -BatchContext $Context +``` + +This command enables the job schedule that has the ID JobSchedule17. +Use the **Get-AzBatchAccountKey** cmdlet to assign a context to the $Context variable. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the job schedule that this cmdlet enables. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchJobSchedule](./Disable-AzBatchJobSchedule.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchJobSchedule](./Get-AzBatchJobSchedule.md) + +[New-AzBatchJobSchedule](./New-AzBatchJobSchedule.md) + +[Remove-AzBatchJobSchedule](./Remove-AzBatchJobSchedule.md) + +[Stop-AzBatchJobSchedule](./Stop-AzBatchJobSchedule.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Enable-AzBatchTask.md b/azps-10.1.0/Az.Batch/Enable-AzBatchTask.md new file mode 100644 index 0000000000..6c3a1f7c8b --- /dev/null +++ b/azps-10.1.0/Az.Batch/Enable-AzBatchTask.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 67FB5D02-4F4B-4119-B3AC-0D205247253E +online version: https://learn.microsoft.com/powershell/module/az.batch/enable-azbatchtask +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Enable-AzBatchTask.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Enable-AzBatchTask.md +--- + +# Enable-AzBatchTask + +## SYNOPSIS +Reactivates a task. + +## SYNTAX + +### Id +``` +Enable-AzBatchTask [-JobId] [-Id] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### InputObject +``` +Enable-AzBatchTask [-Task] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Enable-AzBatchTask** cmdlet reactivates a task. +If a task has exhausted its retry count, this cmdlet nevertheless enables it to run. + +## EXAMPLES + +### Example 1: Reactivate a task +```powershell +Enable-AzBatchTask -JobId "Job7" -Id "Task2" -BatchContext $Context +``` + +This command reactivates the task Task2 in job Job7. + +### Example 2: Reactivate a task by using the pipeline +```powershell +Get-AzBatchTask -JobId "Job8" -Id "Task3" -BatchContext $Context | Enable-AzBatchTask -BatchContext $Context +``` + +This command gets the Batch task that has the ID Task3 in the job that has the ID Job8 by using the Get-AzBatchTask cmdlet. +The command passes that task to the current cmdlet by using the pipeline operator. +The command reactivates that task. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the task to reactivate. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of the job that contains the task. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Task +Specifies the task that this cmdlet reactivates. +To obtain a **PSCloudTask** object, use the Get-AzBatchTask cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSCloudTask + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchTask](./Get-AzBatchTask.md) + +[New-AzBatchTask](./New-AzBatchTask.md) + +[Remove-AzBatchTask](./Remove-AzBatchTask.md) + +[Set-AzBatchTask](./Set-AzBatchTask.md) + +[Stop-AzBatchTask](./Stop-AzBatchTask.md) + + diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchAccount.md b/azps-10.1.0/Az.Batch/Get-AzBatchAccount.md new file mode 100644 index 0000000000..06afb1083c --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchAccount.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 818D5D85-B6D5-458C-A26E-E4DE8E111A10 +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchAccount.md +--- + +# Get-AzBatchAccount + +## SYNOPSIS +Gets a Batch account in the current subscription. + +## SYNTAX + +``` +Get-AzBatchAccount [[-AccountName] ] [[-ResourceGroupName] ] [[-Tag] ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchAccount** cmdlet gets an Azure Batch account in the current subscription. You +can use the *AccountName* parameter to get a single account, or you can use the *ResourceGroupName* +parameter to get accounts under that resource group. + +## EXAMPLES + +### Example 1: Get a batch account by name +```powershell +Get-AzBatchAccount -AccountName "pfuller" +``` + +```output +AccountName : pfuller +Location : westus +ResourceGroupName : CmdletExampleRG +DedicatedCoreQuota : 20 +LowPriorityCoreQuota : 20 +PoolQuota : 20 +ActiveJobAndJobScheduleQuota : 20 +Tags : +TaskTenantUrl : https://pfuller.westus.batch.azure.com +``` + +This command gets the batch account named pfuller. + +### Example 2: Get the batch accounts associated with a resource group +```powershell +Get-AzBatchAccount -ResourceGroupName "CmdletExampleRG" +``` + +```output +AccountName : cmdletexample +Location : westus +ResourceGroupName : CmdletExampleRG +DedicatedCoreQuota : 20 +LowPriorityCoreQuota : 20 +PoolQuota : 20 +ActiveJobAndJobScheduleQuota : 20 +Tags : +TaskTenantUrl : https://cmdletexample.westus.batch.azure.com +AccountName : cmdletexample2 +Location : westus +ResourceGroupName : CmdletExampleRG +DedicatedCoreQuota : 20 +LowPriorityCoreQuota : 20 +PoolQuota : 20 +ActiveJobAndJobScheduleQuota : 20 +Tags : +TaskTenantUrl : https://cmdletexample.westus.batch.azure.com +``` + +This command gets the batch accounts associated with the CmdletExampleRG resource group. + +## PARAMETERS + +### -AccountName +Specifies the name of an account. +If you specify an account name, this cmdlet only returns that account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +If you specify a resource group, this cmdlet gets the accounts under the specified resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} +This cmdlet gets accounts that contain the tags that this parameter specifies. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## NOTES + +## RELATED LINKS + +[New-AzBatchAccount](./New-AzBatchAccount.md) + +[Remove-AzBatchAccount](./Remove-AzBatchAccount.md) + +[Set-AzBatchAccount](./Set-AzBatchAccount.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchAccountKey.md b/azps-10.1.0/Az.Batch/Get-AzBatchAccountKey.md new file mode 100644 index 0000000000..13a17f4175 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchAccountKey.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: AFDE5ECD-29AB-4C91-98BF-1B8C9C3BB079 +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchAccountKey.md +--- + +# Get-AzBatchAccountKey + +## SYNOPSIS +Gets the keys of a Batch account. + +## SYNTAX + +``` +Get-AzBatchAccountKey [-AccountName] [-ResourceGroupName ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchAccountKey** cmdlet gets the keys of an Azure Batch account in the current subscription. + +## EXAMPLES + +### Example 1: Get batch account keys and save it in $Context variable for use later +```powershell +$Context = Get-AzBatchAccountKey -AccountName myaccount +``` + +This command gets the account details and stores it in a `$Context` object for use later. + +### Example 2: Get batch account keys and display them + + + +```powershell +$Context = Get-AzBatchAccountKey -AccountName myaccount +$Context.PrimaryAccountKey +ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMN== +$Context.SecondaryAccountKey +ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMN== +``` + +This command gets the account keys and prints them to the console. + +## PARAMETERS + +### -AccountName +Specifies the name of the account for which this cmdlet gets keys. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the account for which this cmdlet gets keys. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## NOTES + +## RELATED LINKS + +[New-AzBatchAccountKey](./New-AzBatchAccountKey.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchApplication.md b/azps-10.1.0/Az.Batch/Get-AzBatchApplication.md new file mode 100644 index 0000000000..e1a9584cb0 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchApplication.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: CF8B8E94-3C6C-4D68-B55B-956393890946 +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchApplication.md +--- + +# Get-AzBatchApplication + +## SYNOPSIS +Gets information about the specified application. + +## SYNTAX + +``` +Get-AzBatchApplication [-AccountName] [-ResourceGroupName] [[-ApplicationName] ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchApplication** cmdlet gets information about an application in an Azure Batch account. + +## EXAMPLES + +### Example 1: Display the applications in a Batch account +```powershell +Get-AzBatchApplication -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" +``` + +```output +ApplicationName AllowUpdates DisplayName + +------------- ------------ ---------------------------- + +litware False Litware Advanced Reticulator +``` + +This command displays all applications in the ContosoBatch account. + +## PARAMETERS + +### -AccountName +Specifies the name of the Batch account that contains the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationName +Specifies the name of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationId + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Batch account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSApplication + +## NOTES + +## RELATED LINKS + +[Get-AzBatchApplicationPackage](./Get-AzBatchApplicationPackage.md) + +[New-AzBatchApplication](./New-AzBatchApplication.md) + +[New-AzBatchApplicationPackage](./New-AzBatchApplicationPackage.md) + +[Remove-AzBatchApplication](./Remove-AzBatchApplication.md) + +[Remove-AzBatchApplicationPackage](./Remove-AzBatchApplicationPackage.md) + +[Set-AzBatchApplication](./Set-AzBatchApplication.md) + + diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchApplicationPackage.md b/azps-10.1.0/Az.Batch/Get-AzBatchApplicationPackage.md new file mode 100644 index 0000000000..00fd058caf --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchApplicationPackage.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 17653793-3CE1-465F-87F7-20B4B8F56193 +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchapplicationpackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchApplicationPackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchApplicationPackage.md +--- + +# Get-AzBatchApplicationPackage + +## SYNOPSIS +Gets information about an application package in a Batch account. + +## SYNTAX + +``` +Get-AzBatchApplicationPackage [-AccountName] [-ResourceGroupName] [-ApplicationName] + [[-ApplicationVersion] ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchApplicationPackage** cmdlet gets information about an application package in an Azure Batch account. + +## EXAMPLES + +### Example 1: Get details of an application package in a Batch account +```powershell +Get-AzBatchApplicationPackage -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationName "Litware" -ApplicationVersion "1.0" +``` + +```output +Format : zip +State : Active +Version : 1.0 +LastActivationTime : 13/05/2016 4:03:24 AM +StorageUrl : https://contosobatch.blob.core.windows.net/app-test +StorageUrlExpiry : 13/05/2016 8:04:44 AM +Id : litware +``` + +This command gets the details of version 1.0 of the Litware package. + +## PARAMETERS + +### -AccountName +Specifies the name of the Batch account from which this cmdlet gets information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationName +Specifies the name of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationVersion +Specifies the version of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Batch account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSApplicationPackage + +## NOTES + +## RELATED LINKS + +[Get-AzBatchApplication](./Get-AzBatchApplication.md) + +[New-AzBatchApplication](./New-AzBatchApplication.md) + +[New-AzBatchApplicationPackage](./New-AzBatchApplicationPackage.md) + +[Remove-AzBatchApplication](./Remove-AzBatchApplication.md) + +[Remove-AzBatchApplicationPackage](./Remove-AzBatchApplicationPackage.md) + +[Set-AzBatchApplication](./Set-AzBatchApplication.md) + + diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchCertificate.md b/azps-10.1.0/Az.Batch/Get-AzBatchCertificate.md new file mode 100644 index 0000000000..93dd261b47 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchCertificate.md @@ -0,0 +1,248 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: A9C98F8F-90F2-4BF4-A234-31966FBB975B +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchCertificate.md +--- + +# Get-AzBatchCertificate + +## SYNOPSIS +Gets the certificates in a Batch account. + +## SYNTAX + +### ODataFilter (Default) +``` +Get-AzBatchCertificate [-Filter ] [-MaxCount ] [-Select ] + -BatchContext [-DefaultProfile ] [] +``` + +### Thumbprint +``` +Get-AzBatchCertificate [-ThumbprintAlgorithm] [-Thumbprint] [-Select ] + -BatchContext [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchCertificate** cmdlet gets the certificates in the Azure Batch account that the *BatchContext* parameter specifies. +To obtain a particular certificate, specify the *ThumbprintAlgorithm* and *Thumbprint* parameters. +Specify the *Filter* parameter to get the certificates that match an Open Data Protocol (OData) filter. + +## EXAMPLES + +### Example 1: Get a certificate by thumbprint +```powershell +Get-AzBatchCertificate -ThumbprintAlgorithm "sha1" -Thumbprint "C1E494A415149C5F211C4778B52F2E834A07247C" -BatchContext $Context +``` + +```output +Thumbprint : c1e494a415149c5f211c4778b52f2e834a07247c +ThumbprintAlgorithm : sha1 +Url : https://pstests.eastus.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=C1E494A415149C5F211C4778B52F2E834A07247 +C) +State : Active +StateTransitionTime : 10/6/2015 6:21:16 PM +PreviousState : +PreviousStateTransitionTime : +Data : +CertificateFormat : +Password : +PublicData : MIIB9DCCAWGgAwIBAgIQpUXhwCuAPJRDhl7kY/0PdTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC0JhdGNoVGVzdDAxMB4XDTE1MTAwMjE2MjkwNVoXDTM5MTIzMTIzNTk +1OVowFjEUMBIGA1UEAxMLQmF0Y2hUZXN0MDEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAM06unpRipn3BmHBM75d0s8w/Wwifci16PoJo4c2V68GwsCCFsNOn5 +ypo7BBXo1fpBjrnso5w+koaE5LjxkBSVm+TkogwbKlW6WURTM0O5viRVbPnEEU/Y01Pj5cJElFuLEk9Uoe/r/lP8b5A607t1cPjSXkwhEZEYc3LkHDSo0ZAgMBAAGjS +zBJMEcGA1UdAQRAMD6AEFRsTAsrvF+FmPuICooZXaKhGDAWMRQwEgYDVQQDEwtCYXRjaFRlc3QwMYIQpUXhwCuAPJRDhl7kY/0PdTAJBgUrDgMCHQUAA4GBALt0F8Ep ++8XVE/M2aNtxzlku72gxiOiAo1HmpUaixXx3gl8kdP3xgoKMaq4JskqdLmbJJUnCQ3wmzsdPwjswsW2ycT12zuBddaiS+id98k8U/KYc6FxMgS+H70FYOxARLn7P4FS +SBf/QCyign+BherzezdZ5NBdfzbmWxIMP5iFJ +DeleteCertificateError : +``` + +This command gets a single certificate that has the specified thumbprint. +The certificate thumbprint algorithm is sha1. + +### Example 2: Get filtered certificates +```powershell +Get-AzBatchCertificate -Filter "state eq 'active'" -BatchContext $Context +``` + +```output +Thumbprint : 025b351b087a084c5067f5e71eff8591970323f9 +ThumbprintAlgorithm : sha1 +Url : https://pstests.eastus.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=025b351b087a084c5067f5e71eff8591970323f9) +State : Active +StateTransitionTime : 10/6/2015 6:21:17 PM +PreviousState : +PreviousStateTransitionTime : +Data : +CertificateFormat : +Password : +PublicData : MIIB9DCCAWGgAwIBAgIQy9W5y8iwhppGhtAG06dHKTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC0JhdGNoVGVzdDAyMB4XDTE1MTAwMjE2MjkxNFoXDTM5MTIzMTIzNTk +1OVowFjEUMBIGA1UEAxMLQmF0Y2hUZXN0MDIwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAJxagvVrlnKfv6hfzSiFJUkdGkPjC3tFiKebK6IaeHzesFdFfupXUE +wT0xOWh9xwa3OVkPECEc/u1sw3iVX/J4AODiwzmOWutoVRpWjxGFpgw9+dPvXMjs/Ue7JL7ag3siHs5EcarW91qKbgtko6i/r4emaRyk60U93TrbWQAWJ9AgMBAAGjS +zBJMEcGA1UdAQRAMD6AEAdqsOpyeXF/uDe7ZGKeez+hGDAWMRQwEgYDVQQDEwtCYXRjaFRlc3QwMoIQy9W5y8iwhppGhtAG06dHKTAJBgUrDgMCHQUAA4GBAC0MaAem +6ByyURFvGnFZyjEepjXC5wcaGq+gguDFe8rG88ceig1ZqewdcmC1y4p05uBhbmETbYVWzJarNsHYq2LTihi4t2J4jt2YVYz/IRdUB82iaFFbJRSPrN+6xD3KM2lve5N +4OjtlZAdiXiSUYFf3I6ypberUsAdba3QQajCN +DeleteCertificateError : + +Thumbprint : c1e494a415149c5f211c4778b52f2e834a07247c +ThumbprintAlgorithm : sha1 +Url : https://pstests.eastus.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=c1e494a415149c5f211c4778b52f2e834a07247c) +State : Active +StateTransitionTime : 10/6/2015 6:21:16 PM +PreviousState : +PreviousStateTransitionTime : +Data : +CertificateFormat : +Password : +PublicData : MIIB9DCCAWGgAwIBAgIQpUXhwCuAPJRDhl7kY/0PdTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC0JhdGNoVGVzdDAxMB4XDTE1MTAwMjE2MjkwNVoXDTM5MTIzMTIzNTk +1OVowFjEUMBIGA1UEAxMLQmF0Y2hUZXN0MDEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAM06unpRipn3BmHBM75d0s8w/Wwifci16PoJo4c2V68GwsCCFsNOn5 +ypo7BBXo1fpBjrnso5w+koaE5LjxkBSVm+TkogwbKlW6WURTM0O5viRVbPnEEU/Y01Pj5cJElFuLEk9Uoe/r/lP8b5A607t1cPjSXkwhEZEYc3LkHDSo0ZAgMBAAGjS +zBJMEcGA1UdAQRAMD6AEFRsTAsrvF+FmPuICooZXaKhGDAWMRQwEgYDVQQDEwtCYXRjaFRlc3QwMYIQpUXhwCuAPJRDhl7kY/0PdTAJBgUrDgMCHQUAA4GBALt0F8Ep ++8XVE/M2aNtxzlku72gxiOiAo1HmpUaixXx3gl8kdP3xgoKMaq4JskqdLmbJJUnCQ3wmzsdPwjswsW2ycT12zuBddaiS+id98k8U/KYc6FxMgS+H70FYOxARLn7P4FS +SBf/QCyign+BherzezdZ5NBdfzbmWxIMP5iFJ +DeleteCertificateError : +``` + +This command gets all certificates in the active state from the Batch account. +The *Filter* parameter specifies the state. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Specifies an OData filter clause. +If you specify this parameter, this cmdlet gets the certificates that match the filter. + +```yaml +Type: System.String +Parameter Sets: ODataFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of certificates to return. +If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. +The default value is 1000. + +```yaml +Type: System.Int32 +Parameter Sets: ODataFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Specifies an OData select clause. +Specify a value for this parameter to get specific properties rather than all object properties. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Thumbprint +Specifies the thumbprint of the certificate that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: Thumbprint +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ThumbprintAlgorithm +Specifies the algorithm used to derive the *Thumbprint* parameter. +Currently, the only valid value is sha1. + +```yaml +Type: System.String +Parameter Sets: Thumbprint +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSCertificate + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[New-AzBatchCertificate](./New-AzBatchCertificate.md) + +[Remove-AzBatchCertificate](./Remove-AzBatchCertificate.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchComputeNode.md b/azps-10.1.0/Az.Batch/Get-AzBatchComputeNode.md new file mode 100644 index 0000000000..2ff94b0cfc --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchComputeNode.md @@ -0,0 +1,318 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 93614655-A8F2-4A67-887D-43D41AB91F82 +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchcomputenode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchComputeNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchComputeNode.md +--- + +# Get-AzBatchComputeNode + +## SYNOPSIS +Gets Batch compute nodes from a pool. + +## SYNTAX + +### ODataFilter (Default) +``` +Get-AzBatchComputeNode [-PoolId] [-Filter ] [-MaxCount ] [-Select ] + -BatchContext [-DefaultProfile ] [] +``` + +### Id +``` +Get-AzBatchComputeNode [-PoolId] [[-Id] ] [-Select ] + -BatchContext [-DefaultProfile ] [] +``` + +### ParentObject +``` +Get-AzBatchComputeNode [[-Pool] ] [-Filter ] [-MaxCount ] [-Select ] + -BatchContext [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchComputeNode** cmdlet gets Azure Batch compute nodes from a pool. +Specify either the *PoolID* or *Pool* parameter. +Specify the *Id* parameter to get a single compute node. +Specify the *Filter* parameter to get the compute nodes that match an Open Data Protocol (OData) filter. + +## EXAMPLES + +### Example 1: Get a compute node by ID +```powershell +Get-AzBatchComputeNode -PoolId "Pool06" -Id "tvm-2316545714_1-20150725t213220z" -BatchContext $Context +``` + +```output +Id : tvm-2316545714_1-20150725t213220z +Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_1-20150725t213220z +State : Idle +StateTransitionTime : 7/25/2015 9:36:53 PM +LastBootTime : 7/25/2015 9:36:53 PM +AllocationTime : 7/25/2015 9:32:20 PM +IPAddress : 10.14.121.1 +AffinityId : TVM:tvm-2316545714_1-20150725t213220z +VirtualMachineSize : standard_d1_v2 +TotalTasksRun : 1 +StartTaskInformation : +RecentTasks : {} +StartTask : +CertificateReferences : +Errors : +``` + +This command gets the compute node that has the ID tvm-2316545714_1-20150725t213220z from the pool that has the ID Pool06. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Get all idle compute nodes from a pool +```powershell +Get-AzBatchComputeNode -PoolId "Pool06" -Filter "state eq 'idle'" -BatchContext $Context +``` + +```output +Id : tvm-2316545714_1-20150725t213220z +Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_1-20150725t213220z +State : Idle +StateTransitionTime : 7/25/2015 9:36:53 PM +LastBootTime : 7/25/2015 9:36:53 PM +AllocationTime : 7/25/2015 9:32:20 PM +IPAddress : 10.14.121.1 +AffinityId : TVM:tvm-2316545714_1-20150725t213220z +VirtualMachineSize : standard_d1_v2 +TotalTasksRun : 1 +StartTaskInformation : +RecentTasks : {} +StartTask : +CertificateReferences : +Errors : + +Id : tvm-2316545714_2-20150726t172920z +Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_2-20150726t172920z +State : Idle +StateTransitionTime : 7/26/2015 5:33:58 PM +LastBootTime : 7/26/2015 5:33:58 PM +AllocationTime : 7/26/2015 5:29:20 PM +IPAddress : 10.14.121.38 +AffinityId : TVM:tvm-2316545714_2-20150726t172920z +VirtualMachineSize : standard_d1_v2 +TotalTasksRun : 0 +StartTaskInformation : +RecentTasks : +StartTask : +CertificateReferences : +Errors : +``` + +This command gets all idle compute nodes that are contained in the pool that has the ID Pool06. +The command specifies the idle state by using the *Filter* parameter. + +### Example 3: Get all compute nodes in a specified pool +```powershell +Get-AzBatchPool -Id "Pool07" -BatchContext $Context | Get-AzBatchComputeNode -BatchContext $Context +``` + +```output +Id : tvm-2316545714_1-20150725t213220z +Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_1-20150725t213220z +State : Idle +StateTransitionTime : 7/25/2015 9:36:53 PM +LastBootTime : 7/25/2015 9:36:53 PM +AllocationTime : 7/25/2015 9:32:20 PM +IPAddress : 10.14.121.1 +AffinityId : TVM:tvm-2316545714_1-20150725t213220z +VirtualMachineSize : standard_d1_v2 +TotalTasksRun : 1 +StartTaskInformation : +RecentTasks : {} +StartTask : +CertificateReferences : +Errors : + + +Id : tvm-2316545714_2-20150726t172920z +Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_2-20150726t172920z +State : Idle +StateTransitionTime : 7/26/2015 5:33:58 PM +LastBootTime : 7/26/2015 5:33:58 PM +AllocationTime : 7/26/2015 5:29:20 PM + +IPAddress : 10.14.121.38 +AffinityId : TVM:tvm-2316545714_2-20150726t172920z +VirtualMachineSize : standard_d1_v2 +TotalTasksRun : 0 +StartTaskInformation : +RecentTasks : +StartTask : +CertificateReferences : +Errors : +``` + +This command gets the pool that has the ID Pool07 by using the Get-AzBatchPool cmdlet. +The command passes that pool to the current cmdlet by using the pipeline operator. +That cmdlet gets all compute nodes from that pool. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Specifies an OData filter clause. +This cmdlet returns compute nodes that match the filter that this parameter specifies. +If you do not specify a filter, this cmdlet returns all compute nodes for the pool. + +```yaml +Type: System.String +Parameter Sets: ODataFilter, ParentObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the compute node that this cmdlet gets from the pool. +You cannot specify wildcard characters. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of compute nodes to return. +If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. +The default value is 1000. + +```yaml +Type: System.Int32 +Parameter Sets: ODataFilter, ParentObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pool +Specifies the pool, as a **PSCloudPool** object, that contains the compute nodes. +To obtain a **PSCloudPool** object, use the Get-AzBatchPool cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudPool +Parameter Sets: ParentObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the pool that contains the compute nodes. + +```yaml +Type: System.String +Parameter Sets: ODataFilter, Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Select +Specifies an OData select clause. +Specify a value for this parameter to get specific properties rather than all object properties. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSCloudPool + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSComputeNode + +## NOTES + +## RELATED LINKS + +[Get-AzBatchComputeNode](./Get-AzBatchComputeNode.md) + +[Get-AzBatchNodeFile](./Get-AzBatchNodeFile.md) + +[Get-AzBatchNodeFileContent](./Get-AzBatchNodeFileContent.md) + +[Get-AzBatchPool](./Get-AzBatchPool.md) + +[Reset-AzBatchComputeNode](./Reset-AzBatchComputeNode.md) + +[Restart-AzBatchComputeNode](./Restart-AzBatchComputeNode.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchComputeNodeExtension.md b/azps-10.1.0/Az.Batch/Get-AzBatchComputeNodeExtension.md new file mode 100644 index 0000000000..c8613bf72a --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchComputeNodeExtension.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchcomputenodeextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchComputeNodeExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchComputeNodeExtension.md +--- + +# Get-AzBatchComputeNodeExtension + +## SYNOPSIS +Gets Batch compute node extensions from a compute node. + +## SYNTAX + +### Id (Default) +``` +Get-AzBatchComputeNodeExtension [-PoolId] [-ComputeNodeId] [[-Name] ] + [-Select ] [-MaxCount ] -BatchContext + [-DefaultProfile ] [] +``` + +### ParentObject +``` +Get-AzBatchComputeNodeExtension [-Pool] [-ComputeNodeId] [[-Name] ] + [-Select ] [-MaxCount ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +If an extension name is provided, a single extension with a matching name is returned from the provided compute node (if found). Otherwise, all extensions on teh compute node is returned. Further extension details can be found on the extension's VmExtension Property. + +## EXAMPLES + +### Example 1 Get all extensions from a compute node. +```powershell +Get-AzBatchComputeNodeExtension "testPool" "testNode" -BatchContext $context +``` + +```output +InstanceView ProvisioningState VmExtension +------------ ----------------- ----------- +Microsoft.Azure.Commands.Batch.Models.PSVMExtensionInstanceView Succeeded Microsoft.Azure.Commands.Batch.Models.PSVMExtension +Microsoft.Azure.Commands.Batch.Models.PSVMExtensionInstanceView Failed Microsoft.Azure.Commands.Batch.Models.PSVMExtension +``` + +### Example 2 Get a specific extension from a compute node. + +```powershell +Get-AzBatchComputeNodeExtension "testPool" "testNode" "secretext" -BatchContext $context +``` + +```output +InstanceView ProvisioningState VmExtension +------------ ----------------- ----------- +Microsoft.Azure.Commands.Batch.Models.PSVMExtensionInstanceView Failed Microsoft.Azure.Commands.Batch.Models.PSVMExtension +``` + +## PARAMETERS + +### -BatchContext +The BatchAccountContext instance to use when interacting with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. +To use shared key authentication instead, use the Get-AzBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. +When using shared key authentication, the primary access key is used by default. +To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNodeId +The id of the compute node to which the extension belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of compute node extensions to return. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the extension to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pool +The pool to which the extension's compute node belongs. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudPool +Parameter Sets: ParentObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PoolId +The id of the pool to which the extension's compute node belongs. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Select +Specifies an OData select clause. +Specify a value for this parameter to get specific properties rather than all object properties. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSCloudPool + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSNodeVMExtension + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchJob.md b/azps-10.1.0/Az.Batch/Get-AzBatchJob.md new file mode 100644 index 0000000000..1edb72e707 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchJob.md @@ -0,0 +1,317 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 8BF49C4D-E7CD-4FD0-AFAC-9856239D24EC +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchJob.md +--- + +# Get-AzBatchJob + +## SYNOPSIS +Gets Batch jobs for a Batch account or job schedule. + +## SYNTAX + +### ODataFilter (Default) +``` +Get-AzBatchJob [-JobScheduleId ] [-Filter ] [-MaxCount ] [-Select ] + [-Expand ] -BatchContext [-DefaultProfile ] + [] +``` + +### Id +``` +Get-AzBatchJob [[-Id] ] [-Select ] [-Expand ] -BatchContext + [-DefaultProfile ] [] +``` + +### ParentObject +``` +Get-AzBatchJob [[-JobSchedule] ] [-Filter ] [-MaxCount ] [-Select ] + [-Expand ] -BatchContext [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzBatchJob** cmdlet gets the Azure Batch jobs for the Batch account specified by the *BatchAccountContext* parameter. +You can use the *Id* parameter to get a single job. +You can use the *Filter* parameter to get the jobs that match an Open Data Protocol (OData) filter. +If you supply a job schedule ID or **PSCloudJobSchedule** instance, this cmdlet returns only the jobs for that job schedule. + +## EXAMPLES + +### Example 1: Get a Batch job by ID +```powershell +Get-AzBatchJob -Id "Job01" -BatchContext $Context +``` + +```output +CommonEnvironmentSettings : +Constraints : Microsoft.Azure.Commands.Batch.Models.PSJobConstraints +CreationTime : 7/25/2015 9:12:07 PM +DisplayName : +ETag : 0x8D29535B2941439 +ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobExecutionInformation +Id : Job01 +JobManagerTask : +JobPreparationTask : +JobReleaseTask : +LastModified : 7/25/2015 9:12:07 PM +Metadata : +PoolInformation : Microsoft.Azure.Commands.Batch.Models.PSPoolInformation +PreviousState : +PreviousStateTransitionTime : +Priority : 0 +State : Active +StateTransitionTime : 7/25/2015 9:12:07 PM +Statistics : +Url : https://pfuller.westus.batch.azure.com/jobs/Job01 +``` + +This command gets the job that has the ID Job01. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Get all active jobs for a job schedule +```powershell +Get-AzBatchJob -JobScheduleId "JobSchedule27" -Filter "state eq 'active'" -BatchContext $Context +``` + +```output +CommonEnvironmentSettings : +Constraints : Microsoft.Azure.Commands.Batch.Models.PSJobConstraints +CreationTime : 7/25/2015 9:15:44 PM +DisplayName : +ETag : 0x8D2953633DD13E1 +ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobExecutionInformation +Id : JobSchedule27:job-1 +JobManagerTask : +JobPreparationTask : +JobReleaseTask : +LastModified : 7/25/2015 9:15:44 PM +Metadata : +PoolInformation : Microsoft.Azure.Commands.Batch.Models.PSPoolInformation +PreviousState : +PreviousStateTransitionTime : +Priority : 0 +State : Active +StateTransitionTime : 7/25/2015 9:15:44 PM +Statistics : +Url : https://pfuller.westus.batch.azure.com/jobs/JobSchedule27:job-1 +``` + +This command gets the active jobs for the job schedule that has the ID JobSchedule27. + +### Example 3: Gets all jobs under a job schedule by using the pipeline +```powershell +Get-AzBatchJobSchedule -Id "JobSchedule27" -BatchContext $Context | Get-AzBatchJob -BatchContext $Context +``` + +```output +CommonEnvironmentSettings : +Constraints : Microsoft.Azure.Commands.Batch.Models.PSJobConstraints +CreationTime : 7/25/2015 9:15:44 PM +DisplayName : +ETag : 0x8D2953633DD13E1 +ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobExecutionInformation +Id : JobSchedule27:job-1 +JobManagerTask : +JobPreparationTask : +JobReleaseTask : +LastModified : 7/25/2015 9:15:44 PM +Metadata : +PoolInformation : Microsoft.Azure.Commands.Batch.Models.PSPoolInformation +PreviousState : +PreviousStateTransitionTime : +Priority : 0 +State : Active +StateTransitionTime : 7/25/2015 9:15:44 PM +Statistics : +Url : https://pfuller.westus.batch.azure.com/jobs/JobSchedule27:job-1 +``` + +This command gets the job schedule that has the ID JobSchedule27 by using the Get-AzBatchJobSchedule cmdlet. +The command passes that job schedule to the current cmdlet by using the pipeline operator. +The command gets all jobs for that job schedule. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Specifies an Open Data Protocol (OData) expand clause. +Specify a value for this parameter to get associated entities of the main entity that you get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Specifies an OData filter clause for jobs. +If you do not specify a filter, this cmdlet returns all jobs for the Batch account or job schedule. + +```yaml +Type: System.String +Parameter Sets: ODataFilter, ParentObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the job that this cmdlet gets. +You cannot specify wildcard characters. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobSchedule +Specifies a **PSCloudJobSchedule** object that represents the job schedule which contains the jobs. +To obtain a **PSCloudJobSchedule** object, use the Get-AzBatchJobSchedule cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJobSchedule +Parameter Sets: ParentObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobScheduleId +Specifies the ID of the job schedule which contains the jobs. + +```yaml +Type: System.String +Parameter Sets: ODataFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of jobs to return. +If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. +The default value is 1000. + +```yaml +Type: System.Int32 +Parameter Sets: ODataFilter, ParentObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Specifies an OData select clause. +Specify a value for this parameter to get specific properties rather than all object properties. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSCloudJobSchedule + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSCloudJob + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchJob](./Disable-AzBatchJob.md) + +[Enable-AzBatchJob](./Enable-AzBatchJob.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchJobSchedule](./Get-AzBatchJobSchedule.md) + +[New-AzBatchJob](./New-AzBatchJob.md) + +[Remove-AzBatchJob](./Remove-AzBatchJob.md) + +[Stop-AzBatchJob](./Stop-AzBatchJob.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchJobPreparationAndReleaseTaskStatus.md b/azps-10.1.0/Az.Batch/Get-AzBatchJobPreparationAndReleaseTaskStatus.md new file mode 100644 index 0000000000..fc6dc85c84 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchJobPreparationAndReleaseTaskStatus.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchjobpreparationandreleasetaskstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchJobPreparationAndReleaseTaskStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchJobPreparationAndReleaseTaskStatus.md +--- + +# Get-AzBatchJobPreparationAndReleaseTaskStatus + +## SYNOPSIS +Gets Batch job preparation and release task status. + +## SYNTAX + +### Id (Default) +``` +Get-AzBatchJobPreparationAndReleaseTaskStatus [-Id] [-Filter ] [-MaxCount ] + [-Select ] [-Expand ] -BatchContext + [-DefaultProfile ] [] +``` + +### InputObject +``` +Get-AzBatchJobPreparationAndReleaseTaskStatus [-InputObject] [-Filter ] + [-MaxCount ] [-Select ] [-Expand ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchJobPreparationAndReleaseTaskStatus** cmdlet gets the Azure Batch job preparation and release task status for a Batch job. +You must supply the *Id* parameter or a **PSCloudJob** instance to this cmdlet. + +## EXAMPLES + +### Example 1: Get the job preparation and release status of a job +```powershell +Get-AzBatchJobPreparationAndReleaseTaskStatus -BatchContext $Context -Id Test +``` + +```output +ComputeNodeId : tvm-2316545714_1-20170613t201733z +ComputeNodeUrl : https://account.westus.batch.azure.com/pools/test/nodes/tvm-2316545714_1-20170613t201733z +JobPreparationTaskExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobPreparationTaskExecutionInformation +JobReleaseTaskExecutionInformation : +PoolId : test +``` + +This command gets the job preparation and release task status for job "Test". +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Get the job preparation and release status of a job with Filter and Select specified +```powershell +Get-AzBatchJobPreparationAndReleaseTaskStatus -BatchContext $context -Id Test -Filter "nodeId eq 'tvm-2316545714_1-20170613t201733z'" -Select "jobPreparationTaskExecutionInfo" +``` + +```output +ComputeNodeId : +ComputeNodeUrl : +JobPreparationTaskExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobPreparationTaskExecutionInformation +JobReleaseTaskExecutionInformation : +PoolId : +``` + +This command gets the job preparation and release task status for job "Test" on node "tvm-2316545714_1-20170613t201733z" and uses the Select clause to specify to only return the JobPreparationTaskExecutionInformation information + +## PARAMETERS + +### -BatchContext +The BatchAccountContext instance to use when interacting with the Batch service. +Use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Specifies an Open Data Protocol (OData) expand clause. +Specify a value for this parameter to get associated entities of the main entity that you get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Specifies an OData filter clause. +If you do not specify a filter, this cmdlet returns all job preparation and release task status' for the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the job whose preparation and release tasks should be retrieved. +You cannot specify wildcard characters. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies a **PSCloudJob** object that represents the job to get the preparation and release task status from. +To obtain a **PSCloudJob** object, use the Get-AzBatchJob cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJob +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of jobs preparation and release task status' to return. +If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. +The default value is 1000. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Specifies an OData select clause. +Specify a value for this parameter to get specific properties rather than all object properties. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSCloudJob + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSJobPreparationAndReleaseTaskExecutionInformation + +## NOTES + +## RELATED LINKS + +[Get-AzBatchJob](./Get-AzBatchJob.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchJobSchedule.md b/azps-10.1.0/Az.Batch/Get-AzBatchJobSchedule.md new file mode 100644 index 0000000000..cca839293c --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchJobSchedule.md @@ -0,0 +1,248 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 8BAA6D8C-1530-4CC4-8AE5-A2CE6B1192CA +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchjobschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchJobSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchJobSchedule.md +--- + +# Get-AzBatchJobSchedule + +## SYNOPSIS +Gets Batch job schedules. + +## SYNTAX + +### ODataFilter (Default) +``` +Get-AzBatchJobSchedule [-Filter ] [-MaxCount ] [-Select ] [-Expand ] + -BatchContext [-DefaultProfile ] [] +``` + +### Id +``` +Get-AzBatchJobSchedule [[-Id] ] [-Select ] [-Expand ] + -BatchContext [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchJobSchedule** cmdlet gets Azure Batch job schedules for the Batch account specified by the *BatchContext* parameter. +Specify an ID to get a single job schedule. +Specify the *Filter* parameter to get the job schedules that match an Open Data Protocol (OData) filter. + +## EXAMPLES + +### Example 1: Get a job schedule by specifying an ID +```powershell +Get-AzBatchJobSchedule -Id "JobSchedule23" -BatchContext $Context +``` + +```output +CreationTime : 7/25/2015 9:15:43 PM +DisplayName : +ETag : 0x8D2953633427FCA +ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobScheduleExecutionInformation +Id : JobSchedule23 +JobSpecification : Microsoft.Azure.Commands.Batch.Models.PSJobSpecification +LastModified : 7/25/2015 9:15:43 PM +Metadata : +PreviousState : Invalid +PreviousStateTransitionTime : +Schedule : +State : Active +StateTransitionTime : 7/25/2015 9:15:43 PM +Statistics : +Url : https://pfuller.westus.batch.azure.com/jobschedules/JobSchedule23 +``` + +This command gets the job schedule that has the ID JobSchedule23. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Get job schedules by using a filter +```powershell +Get-AzBatchJobSchedule -Filter "startswith(id,'Job')" -BatchContext $Context +``` + +```output +CreationTime : 7/25/2015 9:15:43 PM +DisplayName : +ETag : 0x8D2953633427FCA +ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobScheduleExecutionInformation +Id : JobSchedule23 +JobSpecification : Microsoft.Azure.Commands.Batch.Models.PSJobSpecification +LastModified : 7/25/2015 9:15:43 PM +Metadata : +PreviousState : Invalid +PreviousStateTransitionTime : +Schedule : +State : Active +StateTransitionTime : 7/25/2015 9:15:43 PM +Statistics : +Url : https://pfuller.westus.batch.azure.com/jobschedules/JobSchedule23 + +CreationTime : 7/26/2015 5:39:33 PM +DisplayName : +ETag : 0x8D295E12B1084B4 +ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobScheduleExecutionInformation +Id : JobSchedule26 +JobSpecification : Microsoft.Azure.Commands.Batch.Models.PSJobSpecification +LastModified : 7/26/2015 5:39:33 PM +Metadata : +PreviousState : Invalid +PreviousStateTransitionTime : +Schedule : +State : Active +StateTransitionTime : 7/26/2015 5:39:33 PM +Statistics : +Url : https://pfuller.westus.batch.azure.com/jobschedules/JobSchedule26 +``` + +This command gets all job schedules that have IDs that start with Job by specifying the *Filter* parameter. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Specifies an Open Data Protocol (OData) expand clause. +Specify a value for this parameter to get associated entities of the main entity that you get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Specifies an OData filter clause. +This cmdlet returns job schedules that match the filter that this parameter specifies. +If you do not specify a filter, this cmdlet returns all job schedules for the Batch context. + +```yaml +Type: System.String +Parameter Sets: ODataFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the job schedule that this cmdlet gets. +You cannot specify wildcard characters. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of job schedules to return. +If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. +The default value is 1000. + +```yaml +Type: System.Int32 +Parameter Sets: ODataFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Specifies an OData select clause. +Specify a value for this parameter to get specific properties rather than all object properties. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSCloudJobSchedule + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchJobSchedule](./Disable-AzBatchJobSchedule.md) + +[Enable-AzBatchJobSchedule](./Enable-AzBatchJobSchedule.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[New-AzBatchJobSchedule](./New-AzBatchJobSchedule.md) + +[Remove-AzBatchJobSchedule](./Remove-AzBatchJobSchedule.md) + +[Stop-AzBatchJobSchedule](./Stop-AzBatchJobSchedule.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchJobStatistic.md b/azps-10.1.0/Az.Batch/Get-AzBatchJobStatistic.md new file mode 100644 index 0000000000..aed9b13b48 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchJobStatistic.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: E655684D-9601-4A0B-BB09-EFB787EB2B1B +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchjobstatistic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchJobStatistic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchJobStatistic.md +--- + +# Get-AzBatchJobStatistic + +## SYNOPSIS +Gets job summary statistics for a Batch account. + +## SYNTAX + +``` +Get-AzBatchJobStatistic -BatchContext [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzBatchJobStatistic** cmdlet gets lifetime summary statistics for all of the jobs in an Azure Batch account. +Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. + +## EXAMPLES + +### Example 1: Get summary statistics for all jobs +```powershell +Get-AzBatchJobStatistic -BatchContext $Context +``` + +```output +FailedTaskCount : 330 +KernelCpuTime : 00:24:31.8440000 +LastUpdateTime : 5/16/2016 6:00:00 PM +ReadIOGiB : 38.1271341182292 +ReadIOps : 26546054 +StartTime : 11/3/2015 9:47:14 PM +SucceededTaskCount : 766 +TaskRetryCount : 0 +Url : https://accountname.westus.batch.azure.com/lifetimejobstats +UserCpuTime : 20:55:50.3200000 +WaitTime : 03:54:49.8530000 +WallClockTime : 20:55:50.3200000 +WriteIOGiB : 0.159623090177774 +WriteIOps : 146946 +``` + +The first command creates an object reference to the account keys for the batch account named ContosoBatchAccount by using **Get-AzBatchAccountKey**. +The command stores this object reference in the $Context variable. +The second command gets the summary statistics for all of the jobs. +The command uses the $Context value from the first command. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSJobStatistics + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchPoolStatistic](./Get-AzBatchPoolStatistic.md) + +[Get-AzBatchPoolUsageMetrics](./Get-AzBatchPoolUsageMetric.md) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchLocationQuota.md b/azps-10.1.0/Az.Batch/Get-AzBatchLocationQuota.md new file mode 100644 index 0000000000..01b2d96474 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchLocationQuota.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: A39A415A-B403-48D3-AF80-CF7CFE382577 +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchlocationquota +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchLocationQuota.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchLocationQuota.md +--- + +# Get-AzBatchLocationQuota + +## SYNOPSIS +Gets the Batch service quotas for your subscription at the given location. + +## SYNTAX + +``` +Get-AzBatchLocationQuota [-Location] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the Batch service quotas for the specified subscription at the given location. + +## EXAMPLES + +### Example 1: Get the Batch service quotas for the subscription in the West US region +```powershell +Get-AzBatchLocationQuota -Location "westus" +``` + +```output +AccountQuota Location + ------------ -------- + 1 westus +``` + +This command gets the quotas for the current subscription in the West US region. +The return value indicates that this subscription can create only one Batch account in that region. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the region for which this cmdlet checks the quotas. +For more information, see Azure Regions (https://azure.microsoft.com/regions). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSBatchLocationQuotas + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchNodeFile.md b/azps-10.1.0/Az.Batch/Get-AzBatchNodeFile.md new file mode 100644 index 0000000000..eb0813fd5a --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchNodeFile.md @@ -0,0 +1,381 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 38ED2854-23D0-400E-A5C8-239346B2AF99 +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchnodefile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchNodeFile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchNodeFile.md +--- + +# Get-AzBatchNodeFile + +## SYNOPSIS +Gets the properties of Batch node files. + +## SYNTAX + +### ComputeNode_Id (Default) +``` +Get-AzBatchNodeFile [-PoolId] [-ComputeNodeId] [[-Path] ] + -BatchContext [-DefaultProfile ] [] +``` + +### Task_Id +``` +Get-AzBatchNodeFile -JobId -TaskId [[-Path] ] -BatchContext + [-DefaultProfile ] [] +``` + +### Task_ODataFilter +``` +Get-AzBatchNodeFile -JobId -TaskId [-Filter ] [-MaxCount ] [-Recursive] + -BatchContext [-DefaultProfile ] [] +``` + +### ParentTask +``` +Get-AzBatchNodeFile [[-Task] ] [-Filter ] [-MaxCount ] [-Recursive] + -BatchContext [-DefaultProfile ] [] +``` + +### ComputeNode_ODataFilter +``` +Get-AzBatchNodeFile [-PoolId] [-ComputeNodeId] [-Filter ] [-MaxCount ] + [-Recursive] -BatchContext [-DefaultProfile ] + [] +``` + +### ParentComputeNode +``` +Get-AzBatchNodeFile [[-ComputeNode] ] [-Filter ] [-MaxCount ] [-Recursive] + -BatchContext [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchNodeFile** cmdlet gets the properties of the Azure Batch node files of a task or compute node. +To narrow your results, you can specify an Open Data Protocol (OData) filter. +If you specify a task, but not a filter, this cmdlet returns properties for all node files for that task. +If you specify a compute node, but not a filter, this cmdlet returns properties for all node files for that compute node. + +## EXAMPLES + +### Example 1: Get the properties of a node file associated with a task +```powershell +Get-AzBatchNodeFile -JobId "Job-000001" -TaskId "Task26" -Path "Stdout.txt" -BatchContext $Context +``` + +```output +IsDirectory Name Properties Url + +----------- ---- ---------- --- + +False StdOut.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... +``` + +This command gets the properties of the StdOut.txt node file associated with the task that has the ID Task26 in the job that has the ID Job-000001. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Get the properties of node files associated with a task by using a filter +```powershell +Get-AzBatchNodeFile -JobId "Job-00002" -TaskId "Task26" -Filter "startswith(name,'St')" -BatchContext $Context +``` + +```output +IsDirectory Name Properties Url + +----------- ---- ---------- --- + +False StdErr.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... +False StdOut.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... +``` + +This command gets the properties of the node files whose names start with st and are associated with task that has the ID Task26 under job that has the ID Job-00002. + +### Example 3: Recursively get the properties of node files associated with a task +```powershell +Get-AzBatchTask "Job-00003" "Task31" -BatchContext $Context | Get-AzBatchNodeFile -Recursive -BatchContext $Context +``` + +```output +IsDirectory Name Properties Url + +----------- ---- ---------- --- + +False ProcessEnv.cmd Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... +False StdErr.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... +False StdOut.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... +True wd https://cmdletexample.westus.Batch.contoso... +False wd\newFile.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... +``` + +This command gets the properties of all files associated with the task that has the ID Task31 in job Job-00003. +This command specifies the *Recursive* parameter. +Therefore, the cmdlet performs a recursive file search is performed, and returns the wd\newFile.txt node file. + +### Example 4: Get a single file from a compute node +```powershell +Get-AzBatchNodeFile -PoolId "Pool22" -ComputeNodeId "ComputeNode01" -Path "Startup\StdOut.txt" -BatchContext $Context +``` + +```output +IsDirectory Name Properties Url +----------- ---- ---------- --- +False startup\stdout.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... +``` + +This command gets the file that is named Startup\StdOut.txt from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool22. + +### Example 5: Get all files under a folder from a compute node +```powershell +Get-AzBatchNodeFile -PoolId "Pool22" -ComputeNodeId "ComputeNode01" -Filter "startswith(name,'startup')" -Recursive -BatchContext $Context +``` + +```output +IsDirectory Name Properties Url +----------- ---- ---------- --- +True startup https://cmdletexample.westus.Batch.contoso... +False startup\ProcessEnv.cmd Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... +False startup\stderr.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... +False startup\stdout.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... +True startup\wd https://cmdletexample.westus.Batch.contoso... +``` + +This command gets all the files under the startup folder from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool22. +This cmdlet specifies the *Recursive* parameter. + +### Example 6: Get files from the root folder of a compute node +```powershell +Get-AzBatchComputeNode "Pool22" -Id "ComputeNode01" -BatchContext $Context | Get-AzBatchNodeFile -BatchContext $Context +``` + +```output +IsDirectory Name Properties Url +----------- ---- ---------- --- +True shared https://cmdletexample.westus.Batch.contoso... +True startup https://cmdletexample.westus.Batch.contoso... +True workitems https://cmdletexample.westus.Batch.contoso... +``` + +This command gets all the files at the root folder of the compute node that has the ID ComputeNode01 in the pool that has the ID Pool22. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNode +Specifies the compute node, as a **PSComputeNode** object, that contains the Batch node files. +To obtain a compute node object, use the Get-AzBatchComputeNode cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode +Parameter Sets: ParentComputeNode +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNodeId +Specifies the ID of the compute node that contains the Batch node files. + +```yaml +Type: System.String +Parameter Sets: ComputeNode_Id, ComputeNode_ODataFilter +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Specifies an OData filter clause. +This cmdlet returns properties for node files that match the filter that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: Task_ODataFilter, ParentTask, ComputeNode_ODataFilter, ParentComputeNode +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of the job that contains the target task. + +```yaml +Type: System.String +Parameter Sets: Task_Id, Task_ODataFilter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of node files for which this cmdlet returns properties. +If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. +The default value is 1000. + +```yaml +Type: System.Int32 +Parameter Sets: Task_ODataFilter, ParentTask, ComputeNode_ODataFilter, ParentComputeNode +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the path of the node file for which this cmdlet retrieves properties. +You cannot specify wildcard characters. + +```yaml +Type: System.String +Parameter Sets: ComputeNode_Id, Task_Id +Aliases: Name + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the pool that contains the compute node from which to get properties of node files. + +```yaml +Type: System.String +Parameter Sets: ComputeNode_Id, ComputeNode_ODataFilter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Recursive +Indicates that this cmdlet returns a recursive list of files. +Otherwise, it returns only the files in the root folder. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Task_ODataFilter, ParentTask, ComputeNode_ODataFilter, ParentComputeNode +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Task +Specifies the task, as a **PSCloudTask** object, with which the node files are associated. +To obtain a task object, use the Get-AzBatchTask cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask +Parameter Sets: ParentTask +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TaskId +Specifies the ID of the task for which this cmdlet gets properties of node files. + +```yaml +Type: System.String +Parameter Sets: Task_Id, Task_ODataFilter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSCloudTask + +### Microsoft.Azure.Commands.Batch.Models.PSComputeNode + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSNodeFile + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchComputeNode](./Get-AzBatchComputeNode.md) + +[Get-AzBatchNodeFileContent](./Get-AzBatchNodeFileContent.md) + +[Get-AzBatchTask](./Get-AzBatchTask.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchNodeFileContent.md b/azps-10.1.0/Az.Batch/Get-AzBatchNodeFileContent.md new file mode 100644 index 0000000000..0f7de0b122 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchNodeFileContent.md @@ -0,0 +1,330 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: C9E2D9EC-3B6A-492D-B183-9856185548CD +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchnodefilecontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchNodeFileContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchNodeFileContent.md +--- + +# Get-AzBatchNodeFileContent + +## SYNOPSIS +Gets a Batch node file. + +## SYNTAX + +### Task_Id_Path +``` +Get-AzBatchNodeFileContent -JobId -TaskId [-Path] -DestinationPath + [-ByteRangeStart ] [-ByteRangeEnd ] -BatchContext + [-DefaultProfile ] [] +``` + +### Task_Id_Stream +``` +Get-AzBatchNodeFileContent -JobId -TaskId [-Path] -DestinationStream + [-ByteRangeStart ] [-ByteRangeEnd ] -BatchContext + [-DefaultProfile ] [] +``` + +### ComputeNode_Id_Path +``` +Get-AzBatchNodeFileContent [-PoolId] [-ComputeNodeId] [-Path] + -DestinationPath [-ByteRangeStart ] [-ByteRangeEnd ] + -BatchContext [-DefaultProfile ] [] +``` + +### ComputeNode_Id_Stream +``` +Get-AzBatchNodeFileContent [-PoolId] [-ComputeNodeId] [-Path] + -DestinationStream [-ByteRangeStart ] [-ByteRangeEnd ] + -BatchContext [-DefaultProfile ] [] +``` + +### InputObject_Path +``` +Get-AzBatchNodeFileContent [[-InputObject] ] -DestinationPath [-ByteRangeStart ] + [-ByteRangeEnd ] -BatchContext [-DefaultProfile ] + [] +``` + +### InputObject_Stream +``` +Get-AzBatchNodeFileContent [[-InputObject] ] -DestinationStream [-ByteRangeStart ] + [-ByteRangeEnd ] -BatchContext [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzBatchNodeFileContent** cmdlet gets an Azure Batch node file and saves it as a file or to a stream. + +## EXAMPLES + +### Example 1: Get a Batch node file associated with a task and save the file +```powershell +Get-AzBatchNodeFileContent -JobId "Job01" -TaskId "Task01" -Path "StdOut.txt" -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context +``` + +This command gets the node file that is named StdOut.txt, and saves it to the E:\PowerShell\StdOut.txt file path on the local computer. +The StdOut.txt node file is associated with task that has the ID Task01 for the job that has the ID Job01. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Get a Batch node file and save it to a specified file path using the pipeline +```powershell +Get-AzBatchNodeFile -JobId "Job02" -TaskId "Task02" -Path "StdErr.txt" -BatchContext $Context | Get-AzBatchNodeFileContent -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context +``` + +This command gets the node file that is named StdErr.txt by using the Get-AzBatchNodeFile cmdlet. +The command passes that file to the current cmdlet by using the pipeline operator. +The current cmdlet saves that file to the E:\PowerShell\StdOut.txt file path on the local computer. +The StdOut.txt node file is associated with the task that has the ID Task02 for the job that has the ID Job02. + +### Example 3: Get a Batch node file associated with a task and direct it to a stream +```powershell +$Stream = New-Object -TypeName "System.IO.MemoryStream" +Get-AzBatchNodeFileContent -JobId "Job03" -TaskId "Task11" -Path "StdOut.txt" -DestinationStream $Stream -BatchContext $Context +``` + +The first command creates a stream by using the New-Object cmdlet, and then stores it in the $Stream variable. +The second command gets the node file that is named StdOut.txt from the task that has the ID Task11 for the job that has the ID Job03. +The command directs file contents to the stream in $Stream. + +### Example 4: Get a node file from a compute node and save it +```powershell +Get-AzBatchNodeFileContent -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Path "Startup\StdOut.txt" -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context +``` + +This command gets the node file Startup\StdOut.txt from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool01. +The command saves the file to the E:\PowerShell\StdOut.txt file path on the local computer. + +### Example 5: Get a node file from a compute node and save it by using the pipeline +```powershell +Get-AzBatchNodeFile -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Path "Startup\StdOut.txt" -BatchContext $Context | Get-AzBatchNodeFileContent -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context +``` + +This command gets the node file Startup\StdOut.txt by using Get-AzBatchNodeFile from the compute node that has the ID ComputeNode01. +The compute node is in the pool that has the ID Pool01. +The command passes that node file to the current cmdlet. +That cmdlet saves the file to the E:\PowerShell\StdOut.txt file path on the local computer. + +### Example 6: Get a node file from a compute node and direct it to a stream +```powershell +$Stream = New-Object -TypeName "System.IO.MemoryStream" +Get-AzBatchNodeFileContent -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Path "startup\stdout.txt" -DestinationStream $Stream -BatchContext $Context +``` + +The first command creates a stream by using the New-Object cmdlet, and then stores it in the $Stream variable. +The second command gets the node file that is named StdOut.txt from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool01. +The command directs file contents to the stream in $Stream. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ByteRangeEnd +The end of the byte range to be downloaded. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ByteRangeStart +The start of the byte range to be downloaded. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeNodeId +Specifies the ID of the compute node that contains the node file that this cmdlet returns. + +```yaml +Type: System.String +Parameter Sets: ComputeNode_Id_Path, ComputeNode_Id_Stream +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPath +Specifies the file path where this cmdlet saves the node file. + +```yaml +Type: System.String +Parameter Sets: Task_Id_Path, ComputeNode_Id_Path, InputObject_Path +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationStream +Specifies the stream into which this cmdlet writes the node file contents. +This cmdlet does not close or rewind this stream. + +```yaml +Type: System.IO.Stream +Parameter Sets: Task_Id_Stream, ComputeNode_Id_Stream, InputObject_Stream +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the file that this cmdlet gets, as a **PSNodeFile** object. +To obtain a node file object, use the Get-AzBatchNodeFile cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSNodeFile +Parameter Sets: InputObject_Path, InputObject_Stream +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of the job that contains the target task. + +```yaml +Type: System.String +Parameter Sets: Task_Id_Path, Task_Id_Stream +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +The path of the node file to download. + +```yaml +Type: System.String +Parameter Sets: Task_Id_Path, Task_Id_Stream, ComputeNode_Id_Path, ComputeNode_Id_Stream +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the pool that contains the compute node that contains the node file that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ComputeNode_Id_Path, ComputeNode_Id_Stream +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TaskId +Specifies the ID of the task. + +```yaml +Type: System.String +Parameter Sets: Task_Id_Path, Task_Id_Stream +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSNodeFile + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchNodeFile](./Get-AzBatchNodeFile.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchPool.md b/azps-10.1.0/Az.Batch/Get-AzBatchPool.md new file mode 100644 index 0000000000..dd5299a97e --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchPool.md @@ -0,0 +1,249 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 44D877F1-D066-4C9C-A797-05EF03785B54 +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchPool.md +--- + +# Get-AzBatchPool + +## SYNOPSIS +Gets Batch pools under the specified Batch account. + +## SYNTAX + +### ODataFilter (Default) +``` +Get-AzBatchPool [-Filter ] [-MaxCount ] [-Select ] [-Expand ] + -BatchContext [-DefaultProfile ] [] +``` + +### Id +``` +Get-AzBatchPool [[-Id] ] [-Select ] [-Expand ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchPool** cmdlet gets the Azure Batch pools under the Batch account specified with the *BatchContext* parameter. +You can use the *Id* parameter to get a single pool, or you can use the *Filter* parameter to get the pools that match an Open Data Protocol (OData) filter. + +## EXAMPLES + +### Example 1: Get a pool by ID +```powershell +Get-AzBatchPool -Id "MyPool" -BatchContext $Context +``` + +```output +AllocationState : Resizing +AllocationStateTransitionTime : 7/25/2015 9:30:28 PM +AutoScaleEnabled : False +AutoScaleFormula : +AutoScaleRun : +CertificateReferences : +CreationTime : 7/25/2015 9:30:28 PM +CurrentDedicated : 0 +CurrentOSVersion : * +DisplayName : +ETag : 0x8D29538429CF04C +Id : MyPool +InterComputeNodeCommunicationEnabled : False +LastModified : 7/25/2015 9:30:28 PM +MaxTasksPerComputeNode : 1 +Metadata : +OSFamily : 4 +ResizeError : +ResizeTimeout : 00:05:00 +TaskSchedulingPolicy : Microsoft.Azure.Commands.Batch.Models.PSTaskSchedulingPolicy +StartTask : +State : Active +StateTransitionTime : 7/25/2015 9:30:28 PM +Statistics : +TargetDedicated : 1 +TargetOSVersion : * +Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool +VirtualMachineSize : standard_d1_v2 +``` + +This command gets the pool with ID MyPool. + +### Example 2: Get all pools using an OData filter +```powershell +Get-AzBatchPool -Filter "startswith(id,'My')" -BatchContext $Context +``` + +```output +AllocationState : Resizing +AllocationStateTransitionTime : 7/25/2015 9:30:28 PM +AutoScaleEnabled : False +AutoScaleFormula : +AutoScaleRun : +CertificateReferences : +CreationTime : 7/25/2015 9:30:28 PM +CurrentDedicated : 0 +CurrentOSVersion : * +DisplayName : +ETag : 0x8D29538429CF04C +Id : MyPool +InterComputeNodeCommunicationEnabled : False +LastModified : 7/25/2015 9:30:28 PM +MaxTasksPerComputeNode : 1 +Metadata : +OSFamily : 4 +ResizeError : +ResizeTimeout : 00:05:00 +TaskSchedulingPolicy : Microsoft.Azure.Commands.Batch.Models.PSTaskSchedulingPolicy +StartTask : +State : Active +StateTransitionTime : 7/25/2015 9:30:28 PM +Statistics : +TargetDedicated : 1 +TargetOSVersion : * +Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool +VirtualMachineSize : standard_d1_v2 +``` + +This command gets the pools whose IDs start with My by using the *Filter* parameter. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Specifies an Open Data Protocol (OData) expand clause. +Specify a value for this parameter to get associated entities of the main entity that you get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Specifies the OData filter clause to use when querying for pools. +If you do not specify a filter, all pools under the Batch account specified with the *BatchContext* parameter are returned. + +```yaml +Type: System.String +Parameter Sets: ODataFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the pool to get. +You cannot specify wildcard characters. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of pools to return. +If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. +The default value is 1000. + +```yaml +Type: System.Int32 +Parameter Sets: ODataFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Specifies an OData select clause. +Specify a value for this parameter to get specific properties rather than all object properties. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSCloudPool + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[New-AzBatchPool](./New-AzBatchPool.md) + +[Remove-AzBatchPool](./Remove-AzBatchPool.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchPoolNodeCount.md b/azps-10.1.0/Az.Batch/Get-AzBatchPoolNodeCount.md new file mode 100644 index 0000000000..904eccd59b --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchPoolNodeCount.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchpoolnodecount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchPoolNodeCount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchPoolNodeCount.md +--- + +# Get-AzBatchPoolNodeCount + +## SYNOPSIS +Gets Batch node counts per node state grouped by pool id. + +## SYNTAX + +### AzureBatchPoolNodeCounts (Default) +``` +Get-AzBatchPoolNodeCount -BatchContext [-DefaultProfile ] + [] +``` + +### PoolId +``` +Get-AzBatchPoolNodeCount [-PoolId ] -BatchContext + [-DefaultProfile ] [] +``` + +### ParentObject +``` +Get-AzBatchPoolNodeCount [-Pool ] -BatchContext + [-DefaultProfile ] [] +``` + +### ODataFilter +``` +Get-AzBatchPoolNodeCount [-MaxCount ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzBatchPoolNodeCount cmdlet allows customers to get back node counts per node state grouped by pool. Possible node states are creating, idle, leavingPool, offline, preempted, rebooting, reimaging, running, starting, startTaskFailed, unknown, unusable and waitingForStartTask. The cmdlet takes PoolId or Pool parameter to filter only pool with pool id specified. + +## EXAMPLES + +### Example 1 +```powershell +$batchContext = Get-AzBatchAccountKey -AccountName "contosobatch" +Get-AzBatchPoolNodeCount -BatchContext $batchContext +``` + +```output +PoolId Dedicated LowPriority +------ --------- ----------- +contosopool1 Creating: 1, Idle: 1, Rebooting: 1, Running: 5, Total: 8 Total: 0 +contosopool2 Idle: 1, Rebooting: 1, Total: 2 Total: 0 +``` + +List node counts per node state for pools under current batch account context. + +### Example 2 + + +```powershell +Get-AzBatchPoolNodeCount -BatchContext $batchContext -PoolId "contosopool1" + +PoolId Dedicated LowPriority +------ --------- ----------- +contosopool1 Creating: 1, Idle: 1, Rebooting: 1, Running: 5, Total: 8 Total: 0 + +$poolnodecounts = Get-AzBatchPoolNodeCount -BatchContext $batchContext -PoolId "contosopool1" +$poolnodecounts.Dedicated + +Creating : 1 +Idle : 1 +LeavingPool : 0 +Offline : 0 +Preempted : 0 +Rebooting : 1 +Reimaging : 0 +Running : 5 +Starting : 0 +StartTaskFailed : 0 +Total : 8 +Unknown : 0 +Unusable : 0 +WaitingForStartTask : 0 + +Get-AzBatchPool -Id "contosopool1" -BatchContext $batchContext | Get-AzBatchPoolNodeCount -BatchContext $batchContext + +PoolId Dedicated LowPriority +------ --------- ----------- +contosopool1 Creating: 1, Idle: 1, Rebooting: 1, Running: 5, Total: 8 Total: 0 +``` + +Show node counts per node state for a pool given pool id. + +## PARAMETERS + +### -BatchContext +The BatchAccountContext instance to use when interacting with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. +To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. +When using shared key authentication, the primary access key is used by default. +To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of pools to return. +The default value is 10. + +```yaml +Type: System.Int32 +Parameter Sets: ODataFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pool +Specifies the **PSCloudPool** for which to get node counts. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudPool +Parameter Sets: ParentObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PoolId +The id of the pool for which to get node counts. + +```yaml +Type: System.String +Parameter Sets: PoolId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSCloudPool + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSPoolNodeCounts + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey]() + +[Get-AzBatchJob]() + +[Azure Batch Cmdlets]() + diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchPoolStatistic.md b/azps-10.1.0/Az.Batch/Get-AzBatchPoolStatistic.md new file mode 100644 index 0000000000..25db07a867 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchPoolStatistic.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 8188C617-4895-4B43-8D3B-FA6FC5B868DD +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchpoolstatistic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchPoolStatistic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchPoolStatistic.md +--- + +# Get-AzBatchPoolStatistic + +## SYNOPSIS +Gets pool summary statistics for a Batch account. + +## SYNTAX + +``` +Get-AzBatchPoolStatistic -BatchContext [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzBatchPoolStatistic** cmdlet gets the lifetime statistics for all of the pools in the specified account. +Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. + +## EXAMPLES + +### Example 1: Get resource statistics of all pools in an account +```powershell +$Context = Get-AzBatchAccountKey -AccountName "ContosoBatchAccount" +$PoolStatistics = Get-AzBatchPoolStatistic -BatchContext $Context +$PoolStatistics.ResourceStatistics +``` + +```output +AverageCpuPercentage : 0.351232518750755 +AverageDiskGiB : 55.2569014701165 +AverageMemoryGiB : 2.87273772318252 +DiskReadGiB : 45.1326256990433 +DiskReadIOps : 878278 +DiskWriteGiB : 1230.72120628133 +DiskWriteIOps : 176832212 +LastUpdateTime : 5/16/2016 4:30:00 PM +NetworkReadGiB : 29.3502839952707 +NetworkWriteGiB : 25.5208827350289 +PeakDiskGiB : 21.9638671875 +PeakMemoryGiB : 1.11184692382813 +StartTime : 2/10/2016 7:07:24 PM +``` + +The first command creates an object reference to the account keys for the batch account named ContosoBatchAccount by using **Get-AzBatchAccountKey**. +The command stores this object reference in the $Context variable. +The second command gets the statistics of all of the pools in the specified account, and then stores them in the $PoolStatistics. +The final command displays the **ResourceStatistics** property of $PoolStatistics. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSPoolStatistics + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchPoolUsageMetrics](./Get-AzBatchPoolUsageMetric.md) + +[Get-AzBatchJobStatistic](./Get-AzBatchJobStatistic.md) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchPoolUsageMetric.md b/azps-10.1.0/Az.Batch/Get-AzBatchPoolUsageMetric.md new file mode 100644 index 0000000000..6caf978c7f --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchPoolUsageMetric.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 4B373447-3078-4C1F-932E-8337AB170DEB +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchpoolusagemetric +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchPoolUsageMetric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchPoolUsageMetric.md +--- + +# Get-AzBatchPoolUsageMetric + +## SYNOPSIS +Gets pool usage metrics for a Batch account. + +## SYNTAX + +``` +Get-AzBatchPoolUsageMetric [-StartTime ] [-EndTime ] [-Filter ] + -BatchContext [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchPoolUsageMetric** cmdlet gets the usage metrics, aggregated by pool across individual time intervals, for the specified account. +You can get the statistics for a specific pool and for a time range. + +## EXAMPLES + +### Example 1: Get pool usage metrics for a time range +```powershell +$Context = Get-AzBatchAccountKey -AccountName "ContosoBatchAccount" +$StartTime = Get-Date -Date "2016-05-16 00:00:00Z" +$EndTime = Get-Date -Date "2016-05-16 01:00:00Z" +Get-AzBatchPoolUsageMetric -StartTime $StartTime -EndTime $EndTime -BatchContext $context +``` + +```output +DataEgressGiB : 6.68875873088837E-06 +DataIngressGiB : 1.9485130906105E-05 +EndTime : 5/16/2016 12:30:00 AM +PoolId : testpool1 +StartTime : 5/16/2016 12:00:00 AM +TotalCoreHours : 8 +VirtualMachineSize : standard_d4 + +DataEgressGiB : 5.61587512493134E-06 +DataIngressGiB : 1.76150351762772E-05 +EndTime : 5/16/2016 12:30:00 AM +PoolId : testpool2 +StartTime : 5/16/2016 12:00:00 AM +TotalCoreHours : 12 +VirtualMachineSize : standard_d4 + +DataEgressGiB : 7.36676156520844E-06 +DataIngressGiB : 2.10804864764214E-05 +EndTime : 5/16/2016 1:00:00 AM +PoolId : testpool1 +StartTime : 5/16/2016 12:30:00 AM +TotalCoreHours : 7.99999999955555 +VirtualMachineSize : standard_d4 + +DataEgressGiB : 5.80586493015289E-06 +DataIngressGiB : 1.80602073669434E-05 +EndTime : 5/16/2016 1:00:00 AM +PoolId : testpool2 +StartTime : 5/16/2016 12:30:00 AM +TotalCoreHours : 11.9999999993333 +VirtualMachineSize : standard_d4 +``` + +The first command creates an object reference to the account keys for the batch account named ContosoBatchAccount by using **Get-AzBatchAccountKey**. +The command stores this object reference in the $Context variable. +The next two commands create **DateTime** objects by using the Get-Date cmdlet. +The commands store these values in the $StartTime and $EndTime variables for use with the final command. +The final command returns all of the pool usage metrics, aggregated by pool, across time interval between the specified start and end times. + +### Example 2: Get pool usage metrics by using a filter +```powershell +Get-AzBatchPoolUsageMetric -Filter "poolId eq 'ContosoPool'" -BatchContext $Context +``` + +```output +DataEgressGiB : 9.0496614575386E-06 +DataIngressGiB : 2.60043889284134E-05 +EndTime : 5/16/2016 5:30:00 PM +PoolId : MyPool +StartTime : 5/16/2016 5:00:00 PM +TotalCoreHours : 12 +VirtualMachineSize : standard_d4 +``` + +This command returns the usage metrics for pool named ContosoPool. +The command specifies a filter string to specify that pool, and uses the same $Context value as the previous example. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +Specifies the end of a time range for which this cmdlet gets usage metrics. +Specify a time at least two hours earlier. +If you do not specify an end time, this cmdlet uses the last aggregation interval currently available. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Specifies an OData filter clause to use to filter the metrics that this cmdlet returns. +The only valid property is **poolId** with a string value. +Possible operations are the following: eq, ge, gt, le, lt, startswith. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies the start of a time range for which this cmdlet gets usage metrics. +Specify a time at least two and a half hours earlier. +If you do not specify a start time, this cmdlet uses the last aggregation interval currently available. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSPoolUsageMetrics + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchPoolStatistics](./Get-AzBatchPoolStatistic.md) + +[Get-AzBatchJobStatistics](./Get-AzBatchJobStatistic.md) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchRemoteDesktopProtocolFile.md b/azps-10.1.0/Az.Batch/Get-AzBatchRemoteDesktopProtocolFile.md new file mode 100644 index 0000000000..bd4ec26dca --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchRemoteDesktopProtocolFile.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: D077DB50-12BC-45AB-8EAC-57810DA83035 +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchremotedesktopprotocolfile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchRemoteDesktopProtocolFile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchRemoteDesktopProtocolFile.md +--- + +# Get-AzBatchRemoteDesktopProtocolFile + +## SYNOPSIS +Gets an RDP file from a compute node. + +## SYNTAX + +### Id_Path (Default) +``` +Get-AzBatchRemoteDesktopProtocolFile [-PoolId] [-ComputeNodeId] -DestinationPath + -BatchContext [-DefaultProfile ] [] +``` + +### Id_Stream +``` +Get-AzBatchRemoteDesktopProtocolFile [-PoolId] [-ComputeNodeId] -DestinationStream + -BatchContext [-DefaultProfile ] [] +``` + +### InputObject_Path +``` +Get-AzBatchRemoteDesktopProtocolFile [[-ComputeNode] ] -DestinationPath + -BatchContext [-DefaultProfile ] [] +``` + +### InputObject_Stream +``` +Get-AzBatchRemoteDesktopProtocolFile [[-ComputeNode] ] -DestinationStream + -BatchContext [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchRemoteDesktopProtocolFile** cmdlet gets a Remote Desktop Protocol (RDP) file from a compute node and saves it as a file or to a user supplied stream. + +## EXAMPLES + +### Example 1: Get an RDP file from a specified compute node and save the file +```powershell +Get-AzBatchRemoteDesktopProtocolFile -PoolId "Pool06" -ComputeNodeId "ComputeNode01" -DestinationPath "C:\PowerShell\ComputeNode01.rdp" -BatchContext $Context +``` + +This command gets an RDP file from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool06. +The command saves the .rdp file as C:\PowerShell\MyComputeNode.rdp. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Get an RDP file from a compute node and save the file by using the pipeline +```powershell +Get-AzBatchComputeNode -PoolId "Pool06" -Id "ComputeNode02" -BatchContext $Context | Get-AzBatchRemoteDesktopProtocolFile -DestinationPath "C:\PowerShell\MyComputeNode02.rdp" -BatchContext $Context +``` + +This command gets the compute node that has the ID ComputeNode02 in the pool that has the ID Pool06. +The command passes that compute node to the current cmdlet by using the pipeline operator. +The current cmdlet gets an .rpd file from the compute node, and then saves the contents as a file that is named C:\PowerShell\MyComputeNode02.rdp. + +### Example 3: Get a RDP file from a specified compute node and direct it to a stream +```powershell +$Stream = New-Object -TypeName "System.IO.MemoryStream" +Get-AzBatchRemoteDesktopProtocolFile "Pool06" -ComputeNodeId "ComputeNode03" -DestinationStream $Stream -BatchContext $Context +``` + +The first command creates a stream by using the New-Object cmdlet, and then stores it in the $Stream variable. +The second command gets an .rdp file from the compute node that has the ID ComputeNode03 in the pool that has the ID Pool06. +The command directs file contents to the stream in $Stream. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNode +Specifies a compute node, as a **PSComputeNode** object, to which the .rdp file points. +To obtain a compute node object, use the Get-AzBatchComputeNode cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode +Parameter Sets: InputObject_Path, InputObject_Stream +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNodeId +Specifies the ID of the compute node to which the .rdp file points. + +```yaml +Type: System.String +Parameter Sets: Id_Path, Id_Stream +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPath +Specifies the file path where this cmdlet saves the .rdp file. + +```yaml +Type: System.String +Parameter Sets: Id_Path, InputObject_Path +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationStream +Specifies the stream into which this cmdlet directs the RDP data. +This cmdlet does not close or rewind this stream. + +```yaml +Type: System.IO.Stream +Parameter Sets: Id_Stream, InputObject_Stream +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the pool that contains the compute node from which this cmdlet gets an .rdp file. + +```yaml +Type: System.String +Parameter Sets: Id_Path, Id_Stream +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSComputeNode + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchComputeNode](./Get-AzBatchComputeNode.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchRemoteLoginSetting.md b/azps-10.1.0/Az.Batch/Get-AzBatchRemoteLoginSetting.md new file mode 100644 index 0000000000..25d4a7beca --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchRemoteLoginSetting.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 07811B64-6A77-452C-B148-DE8C13E73DEF +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchremoteloginsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchRemoteLoginSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchRemoteLoginSetting.md +--- + +# Get-AzBatchRemoteLoginSetting + +## SYNOPSIS +Gets remote logon settings for a compute node. + +## SYNTAX + +### Id (Default) +``` +Get-AzBatchRemoteLoginSetting [-PoolId] [-ComputeNodeId] -BatchContext + [-DefaultProfile ] [] +``` + +### InputObject +``` +Get-AzBatchRemoteLoginSetting [[-ComputeNode] ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchRemoteLoginSetting** cmdlet gets remote logon settings for a compute node in a virtual machines infrastructure-based pool. + +## EXAMPLES + +### Example 1: Get remote logon settings for all nodes in a pool +```powershell +$Context = Get-AzBatchAccountKey -AccountName "ContosoBatchAccount" +Get-AzBatchComputeNode -PoolId "ContosoPool" -BatchContext $Context | Get-AzBatchRemoteLoginSetting -BatchContext $Context +``` + +```output +IPAddress Port +--------- ---- +10.214.75.221 50002 +10.214.75.221 50001 +10.214.75.221 50000 +``` + +The first command gets a batch account context that contains access keys for your subscription by using **Get-AzBatchAccountKey**. +The command stores the context in the $Context variable to use in the next command. +The second command gets each compute node in the pool that has the ID ContosoPool by using **Get-AzBatchComputeNode**. +The command passes each computer node to the current cmdlet by using the pipeline operator. +The command gets the remote logon settings for each compute node. + +### Example 2: Get remote logon settings for a node +```powershell +$Context = Get-AzBatchAccountKey -AccountName "ContosoBatchAccount" +Get-AzBatchRemoteLoginSetting -PoolId "ContosoPool" -ComputeNodeId "tvm-1900272697_1-20150330t205553z" -BatchContext $Context +``` + +```output +IPAddress Port +--------- ---- +10.214.75.221 50000 +``` + +The first command gets a batch account context that contains access keys for your subscription, and then stores it in the $Context variable. +The second command gets the remote logon settings for the compute node that has the specified ID in the pool that has the ID ContosoPool. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +To obtain a **BatchAccountContext** that contains access keys for your subscription, use the Get-AzBatchAccountKey cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNode +Specifies a compute node, as a **PSComputeNode** object, for which this cmdlet gets remote logon settings. +To obtain a compute node object, use the Get-AzBatchComputeNode cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode +Parameter Sets: InputObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNodeId +Specifies the ID of the compute node for which to get the remote logon settings. +for which this cmdlet gets remote logon settings. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the pool that contains the virtual machine. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSComputeNode + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSRemoteLoginSettings + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchComputeNode](./Get-AzBatchComputeNode.md) + +[Get-AzBatchRemoteDesktopProtocolFile](./Get-AzBatchRemoteDesktopProtocolFile.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchSubtask.md b/azps-10.1.0/Az.Batch/Get-AzBatchSubtask.md new file mode 100644 index 0000000000..90704300d3 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchSubtask.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 7D0D8B46-4BF0-47D5-9261-3306AEB9E7DD +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchsubtask +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchSubtask.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchSubtask.md +--- + +# Get-AzBatchSubtask + +## SYNOPSIS +Gets the subtask information of the specified task. + +## SYNTAX + +### ODataFilter (Default) +``` +Get-AzBatchSubtask [-JobId] [-TaskId] [-MaxCount ] -BatchContext + [-DefaultProfile ] [] +``` + +### ParentObject +``` +Get-AzBatchSubtask [[-Task] ] [-MaxCount ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchSubtask** cmdlet retrieves the subtask information about the specified task. +Subtasks provide parallel processing for individual tasks, and enable precise monitoring of task execution and progress. + +## EXAMPLES + +### Example 1: Return all subtasks for a specified task +```powershell +$Context = Get-AzBatchAccountKey -AccountName "contosobatchaccount" +Get-AzBatchSubtask -JobId "Job-01" -TaskID "myTask" -BatchContext $Context +``` + +These commands return all the subtasks for the task with the ID myTask. +To do this, the first command in the example creates an object reference to the account keys for the batch account contosobatchaccount. +This object reference is stored in a variable named $context. +The second command then uses that object reference and the **Get-AzBatchSubtask** cmdlet to return all the subtasks for myTask, a task that runs as part of job Job-01. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of the job that contains the task whose subtasks this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ODataFilter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of subtasks to return. +If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. +The default value is 1000. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Task +Specifies an object reference to the task that contain the subtasks that this cmdlet returns. +This object reference is created by using the Get-AzBatchTask cmdlet and storing the returned object in a variable. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask +Parameter Sets: ParentObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TaskId +Specifies the ID of the task whose subtasks this cmdlet returns. + +```yaml +Type: System.String +Parameter Sets: ODataFilter +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSCloudTask + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSSubtaskInformation + +## NOTES + +## RELATED LINKS + +[Get-AzBatchTask](./Get-AzBatchTask.md) + + diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchSupportedImage.md b/azps-10.1.0/Az.Batch/Get-AzBatchSupportedImage.md new file mode 100644 index 0000000000..8c4165a744 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchSupportedImage.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchsupportedimage.md +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchSupportedImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchSupportedImage.md +--- + +# Get-AzBatchSupportedImage + +## SYNOPSIS +Gets Batch supported images for a Batch account. + +## SYNTAX + +``` +Get-AzBatchSupportedImage [-Filter ] [-MaxCount ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchSupportedImage** cmdlet gets supported virtual machine images that are available in an Azure Batch account. +Specify the account by using the *BatchContext* parameter. + +## EXAMPLES + +### Example 1: Get all available supported images + +```powershell +$Context = Get-AzBatchAccountKey -AccountName "ContosoBatchAccount" +Get-AzBatchSupportedImage -BatchContext $Context +``` + +```output +BatchSupportEndOfLife : +Capabilities : +ImageReference : canonical:ubuntuserver:16.04-lts:latest +NodeAgentSkuId : batch.node.ubuntu 16.04 +OSType : Linux +VerificationType : Verified + +BatchSupportEndOfLife : +Capabilities : +ImageReference : canonical:ubuntuserver:18.04-lts:latest +NodeAgentSkuId : batch.node.ubuntu 18.04 +OSType : Linux +VerificationType : Verified + +BatchSupportEndOfLife : +Capabilities : +ImageReference : credativ:debian:8:latest +NodeAgentSkuId : batch.node.debian 8 +OSType : Linux +VerificationType : Verified + +BatchSupportEndOfLife : +Capabilities : +ImageReference : microsoftwindowsserver:windowsserver:2016-datacenter:latest +NodeAgentSkuId : batch.node.windows amd64 +OSType : Windows +VerificationType : Verified + +... +``` + +The first command gets a Batch account context that contains access keys for your subscription by using **Get-AzBatchAccountKey**. +The command stores the context in the $Context variable to use in the next command. +The second command gets all available supported images for that Batch account. + +## PARAMETERS + +### -BatchContext +The BatchAccountContext instance to use when interacting with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. +To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. +When using shared key authentication, the primary access key is used by default. +To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Specifies an OData filter clause for supported images. +If you do not specify a filter, this cmdlet returns all images the Batch account supports. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of supported images to return. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSImageInformation + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchSupportedVirtualMachineSku.md b/azps-10.1.0/Az.Batch/Get-AzBatchSupportedVirtualMachineSku.md new file mode 100644 index 0000000000..72306018fc --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchSupportedVirtualMachineSku.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchsupportedvirtualmachinesku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchSupportedVirtualMachineSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchSupportedVirtualMachineSku.md +--- + +# Get-AzBatchSupportedVirtualMachineSku + +## SYNOPSIS +Gets the list of Batch supported Virtual Machine VM sizes available at the given location. + +## SYNTAX + +``` +Get-AzBatchSupportedVirtualMachineSku [-Location] [[-MaxResultCount] ] [[-Filter] ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the list of Batch supported Virtual Machine VM sizes available at the given location. + +## EXAMPLES + +### Example 1 Get supported skus for a region +```powershell +Get-AzBatchSupportedVirtualMachineSku eastus +``` + +```output +Name FamilyName Capabilities +---- ---------- ------------ +Basic_A1 basicAFamily {MaxResourceVolumeMB, OSVhdSizeMB, vCPUs, MemoryPreservingMaintenanceSupporte... +Basic_A2 basicAFamily {MaxResourceVolumeMB, OSVhdSizeMB, vCPUs, MemoryPreservingMaintenanceSupporte... +Basic_A3 basicAFamily {MaxResourceVolumeMB, OSVhdSizeMB, vCPUs, MemoryPreservingMaintenanceSupporte... +... +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +OData filter expression. +Valid properties for filtering are "familyName". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +The region to get the supported SKUs from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxResultCount +The maximum number of items to return in the response. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSSupportedSku + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchTask.md b/azps-10.1.0/Az.Batch/Get-AzBatchTask.md new file mode 100644 index 0000000000..d0f7d6b174 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchTask.md @@ -0,0 +1,296 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 4B5FE41A-090B-4859-B021-05CF0A8B7882 +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchtask +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchTask.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchTask.md +--- + +# Get-AzBatchTask + +## SYNOPSIS +Gets the Batch tasks for a job. + +## SYNTAX + +### ODataFilter (Default) +``` +Get-AzBatchTask [-JobId] [-Filter ] [-MaxCount ] [-Select ] [-Expand ] + -BatchContext [-DefaultProfile ] [] +``` + +### Id +``` +Get-AzBatchTask [-JobId] [[-Id] ] [-Select ] [-Expand ] + -BatchContext [-DefaultProfile ] [] +``` + +### ParentObject +``` +Get-AzBatchTask [[-Job] ] [-Filter ] [-MaxCount ] [-Select ] + [-Expand ] -BatchContext [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzBatchTask** cmdlet gets Azure Batch tasks for a Batch job. +Specify a job by either the *JobId* parameter or the *Job* parameter. +To get a single task, specify the *Id* parameter. +You can specify the *Filter* parameter to get the tasks that match an Open Data Protocol (OData) filter. + +## EXAMPLES + +### Example 1: Get a task by ID +```powershell +Get-AzBatchTask -JobId "Job01" -Id "Task03" -BatchContext $Context +``` + +```output +AffinityInformation : +CommandLine : cmd /c dir /s +ComputeNodeInformation : Microsoft.Azure.Commands.Batch.Models.PSComputeNodeInformation +Constraints : Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints +CreationTime : 7/25/2015 11:24:52 PM +DisplayName : +EnvironmentSettings : +ETag : 0x8D295483E08BD9D +ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSTaskExecutionInformation +Id : Task03 +LastModified : 7/25/2015 11:24:52 PM +PreviousState : Running +PreviousStateTransitionTime : 7/25/2015 11:24:59 PM +ResourceFiles : +RunElevated : False +State : Completed +StateTransitionTime : 7/25/2015 11:24:59 PM +Statistics : +Url : https://pfuller.westus.batch.azure.com/jobs/Job01/tasks/Task03 +``` + +This command gets the task with ID Task03 under job Job01. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Get all completed tasks from a specified job +```powershell +Get-AzBatchTask -JobId "Job02" -Filter "state eq 'completed'" -BatchContext $Context +``` + +```output +AffinityInformation : +CommandLine : cmd /c dir /s +ComputeNodeInformation : Microsoft.Azure.Commands.Batch.Models.PSComputeNodeInformation +Constraints : Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints +CreationTime : 3/24/2015 10:21:51 PM +EnvironmentSettings : +ETag : 0x8D295483E08BD9D +ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSTaskExecutionInformation +Id : Task17 +LastModified : 3/24/2015 10:21:51 PM +PreviousState : Running +PreviousStateTransitionTime : 3/24/2015 10:22:00 PM +ResourceFiles : +RunElevated : False +State : Completed +StateTransitionTime : 3/24/2015 10:22:00 PM +Statistics : +Url : https://pfuller.westus.batch.azure.com/jobs/Job02/tasks/Task17 + +AffinityInformation : +CommandLine : cmd /c echo hello > newFile.txt +ComputeNodeInformation : Microsoft.Azure.Commands.Batch.Models.PSComputeNodeInformation +Constraints : Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints +CreationTime : 3/24/2015 10:21:51 PM +EnvironmentSettings : +ETag : 0x8D295483E08BD9D +ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSTaskExecutionInformation +Id : Task27 +LastModified : 3/24/2015 10:23:35 PM +PreviousState : Running +PreviousStateTransitionTime : 3/24/2015 10:23:37 PM +ResourceFiles : +RunElevated : True +State : Completed +StateTransitionTime : 3/24/2015 10:23:37 PM +Statistics : +Url : https://pfuller.westus.batch.azure.com/jobs/Job02/tasks/Task27 +``` + +This command gets the completed tasks from the job that has the ID Job02. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Specifies an OData expand clause. +Specify a value for this parameter to get associated entities of the main entity to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Specifies an OData filter clause for tasks. +If you do not specify a filter, this cmdlet returns all tasks for the Batch account or job. + +```yaml +Type: System.String +Parameter Sets: ODataFilter, ParentObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the task that this cmdlet gets. +You cannot specify wildcard characters. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Job +Specifies the job that contains tasks that this cmdlet gets. +To obtain a **PSCloudJob** object, use the Get-AzBatchJob cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJob +Parameter Sets: ParentObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of the job that contains the tasks that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ODataFilter, Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of tasks to return. +If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. +The default value is 1000. + +```yaml +Type: System.Int32 +Parameter Sets: ODataFilter, ParentObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Specifies an OData select clause. +Specify a value for this parameter to get specific properties rather than all object properties. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSCloudJob + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSCloudTask + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchJob](./Get-AzBatchJob.md) + +[New-AzBatchTask](./New-AzBatchTask.md) + +[Remove-AzBatchTask](./Remove-AzBatchTask.md) + +[Stop-AzBatchTask](./Stop-AzBatchTask.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchTaskCount.md b/azps-10.1.0/Az.Batch/Get-AzBatchTaskCount.md new file mode 100644 index 0000000000..00d71aa673 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchTaskCount.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchtaskcount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchTaskCount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchTaskCount.md +--- + +# Get-AzBatchTaskCount + +## SYNOPSIS +Gets the task counts for the specified job. + +## SYNTAX + +### Id +``` +Get-AzBatchTaskCount [-JobId] -BatchContext + [-DefaultProfile ] [] +``` + +### ParentObject +``` +Get-AzBatchTaskCount [[-Job] ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchTaskCount** cmdlet gets the Azure Batch tasks count for a Batch job. +Specify a job by either the *JobId* parameter or the *Job* parameter. +Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running. If the validationStatus is unvalidated, then the Batch service has not been able to check state counts against the task states as reported in the List Tasks API. The validationStatus may be unvalidated if the job contains more than 200,000 tasks. + +## EXAMPLES + +### Example 1: Get task counts by ID +```powershell +Get-AzBatchTaskCount -JobId "Job01" -BatchContext $Context +``` + +```output +Active : 1 +Completed : 0 +Failed : 0 +Running : 1 +Succeeded : 5 +ValidationStatus : Validated +``` + +This command gets the task counts for job Job01. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +## PARAMETERS + +### -BatchContext +The BatchAccountContext instance to use when interacting with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. +To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. +When using shared key authentication, the primary access key is used by default. +To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Job +Specifies the job that contains tasks that this cmdlet gets. +To obtain a **PSCloudJob** object, use the Get-AzBatchJob cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJob +Parameter Sets: ParentObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobId +The id of the job for which to get task counts. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSCloudJob + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSTaskCounts + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchJob](./Get-AzBatchJob.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Get-AzBatchTaskSlotCount.md b/azps-10.1.0/Az.Batch/Get-AzBatchTaskSlotCount.md new file mode 100644 index 0000000000..0553c50e7d --- /dev/null +++ b/azps-10.1.0/Az.Batch/Get-AzBatchTaskSlotCount.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +online version: https://learn.microsoft.com/powershell/module/az.batch/get-azbatchtaskslotcount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchTaskSlotCount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Get-AzBatchTaskSlotCount.md +--- + +# Get-AzBatchTaskSlotCount + +## SYNOPSIS +Gets the task slot counts for the specified job. + +## SYNTAX + +### Id (Default) +``` +Get-AzBatchTaskSlotCount [-JobId] -BatchContext + [-DefaultProfile ] [] +``` + +### ParentObject +``` +Get-AzBatchTaskSlotCount [[-Job] ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBatchTaskSlotCount** cmdlet gets the Azure Batch task slot counts for a Batch job. +Specify a job by either the *JobId* parameter or the *Job* parameter. +Task slot counts provide a count of slots by active, running or completed task state, and a count of slots on which tasks succeeded or failed. Slots for tasks in the preparing state are counted as running. If the validationStatus is unvalidated, then the Batch service has not been able to check state counts against the task states as reported in the List Tasks API. The validationStatus may be unvalidated if the job contains more than 200,000 tasks. + +## EXAMPLES + +### Example 1: Get task counts by ID +```powershell +Get-AzBatchTaskSlotCount -JobId "Job01" -BatchContext $Context +``` + +```output +Active : 1 +Completed : 0 +Failed : 0 +Running : 1 +Succeeded : 5 +ValidationStatus : Validated +``` + +This command gets the task counts for job Job01. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +## PARAMETERS + +### -BatchContext +The BatchAccountContext instance to use when interacting with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. +To use shared key authentication instead, use the Get-AzBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. +When using shared key authentication, the primary access key is used by default. +To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Job +Specifies the job that contains tasks that this cmdlet gets. To obtain a **PSCloudJob** object, use the Get-AzBatchJob cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJob +Parameter Sets: ParentObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobId +The id of the job for which to get task slot counts. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSCloudJob + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSTaskSlotCounts + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Batch/New-AzBatchAccount.md b/azps-10.1.0/Az.Batch/New-AzBatchAccount.md new file mode 100644 index 0000000000..ebc35eb5b4 --- /dev/null +++ b/azps-10.1.0/Az.Batch/New-AzBatchAccount.md @@ -0,0 +1,307 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 82C7B128-8818-4390-B1A5-CB40AC9D53CA +online version: https://learn.microsoft.com/powershell/module/az.batch/new-azbatchaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchAccount.md +--- + +# New-AzBatchAccount + +## SYNOPSIS +Creates a Batch account. + +## SYNTAX + +``` +New-AzBatchAccount [-AccountName] [-Location] [-ResourceGroupName] + [[-AutoStorageAccountId] ] [-PoolAllocationMode ] [-KeyVaultId ] + [-KeyVaultUrl ] [-Tag ] [-PublicNetworkAccess ] + [-IdentityType ] [-IdentityId ] [-EncryptionKeySource ] + [-EncryptionKeyIdentifier ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzBatchAccount** cmdlet creates an Azure Batch account for the specified resource group and location. + +## EXAMPLES + +### Example 1: Create a Batch account +```powershell +New-AzBatchAccount -AccountName "pfuller" -ResourceGroupName "ResourceGroup03" -Location "WestUS" +``` + +```output +AccountName : pfuller +Location : westus +ResourceGroupName : ResourceGroup03 +DedicatedCoreQuota : 20 +LowPriorityCoreQuota : 20 +PoolQuota : 20 +ActiveJobAndJobScheduleQuota : 20 +Tags : +TaskTenantUrl : https://cmdletexample.westus.batch.azure.com +``` + +This command creates a Batch account named pfuller using the ResourceGroup03 resource group in the West US location. + +### Example 2 + +Creates a Batch account. (autogenerated) + + + + +```powershell +New-AzBatchAccount -AccountName 'pfuller' -AutoStorageAccountId -Location 'WestUS' -ResourceGroupName 'ResourceGroup03' +``` + +## PARAMETERS + +### -AccountName +Specifies the name of the Batch account that this cmdlet creates. +Batch account names must be between 3 and 24 characters long and contain only numbers and lowercase letters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutoStorageAccountId +Specifies the resource ID of the storage account to be used for auto storage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyIdentifier +The Key Identifier for customer-based encryption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeySource +Configures how customer data is encrypted inside the Batch account. +By default, accounts are encrypted using a Microsoft managed key. +For additional control, a customer-managed key can be used instead. + +```yaml +Type: Microsoft.Azure.Management.Batch.Models.KeySource +Parameter Sets: (All) +Aliases: +Accepted values: MicrosoftBatch, MicrosoftKeyVault + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityId +The list of user assigned identities associated with the BatchAccount. This parameter is only used when IdentityType is set to UserAssigned. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity associated with the BatchAccount + +```yaml +Type: Microsoft.Azure.Management.Batch.Models.ResourceIdentityType +Parameter Sets: (All) +Aliases: +Accepted values: SystemAssigned, UserAssigned, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultId +The resource ID of the Azure key vault associated with the Batch account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyVaultUrl +The URL of the Azure key vault associated with the Batch account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the region where this cmdlet creates the account. +For more information, see [Azure Regions](https://azure.microsoft.com/en-us/regions). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PoolAllocationMode +The allocation mode for creating pools in the Batch account. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Batch.Models.PoolAllocationMode] +Parameter Sets: (All) +Aliases: +Accepted values: BatchService, UserSubscription + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +The public network access type + +```yaml +Type: Microsoft.Azure.Management.Batch.Models.PublicNetworkAccessType +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group in which this cmdlet creates the account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Management.Batch.Models.PoolAllocationMode, Microsoft.Azure.Management.Batch, Version=9.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccount](./Get-AzBatchAccount.md) + +[Remove-AzBatchAccount](./Remove-AzBatchAccount.md) + +[Set-AzBatchAccount](./Set-AzBatchAccount.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/New-AzBatchAccountKey.md b/azps-10.1.0/Az.Batch/New-AzBatchAccountKey.md new file mode 100644 index 0000000000..cc05f750ba --- /dev/null +++ b/azps-10.1.0/Az.Batch/New-AzBatchAccountKey.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 486748AC-3932-4E0C-BBCC-2BC194E69DCC +online version: https://learn.microsoft.com/powershell/module/az.batch/new-azbatchaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchAccountKey.md +--- + +# New-AzBatchAccountKey + +## SYNOPSIS +Regenerates a key of a Batch account. + +## SYNTAX + +``` +New-AzBatchAccountKey [-AccountName] [-ResourceGroupName ] -KeyType + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzBatchAccountKey** cmdlet regenerates the primary or secondary key of an Azure Batch account. +The cmdlet returns a **BatchAccountContext** object that has its current **PrimaryAccountKey** and **SecondaryAccountKey** properties. + +## EXAMPLES + +### Example 1: Regenerate the primary account key on a Batch account +```powershell +New-AzBatchAccountKey -AccountName "pfuller" -KeyType "Primary" +``` + +```output +AccountName : pfuller +Location : westus +ResourceGroupName : CmdletExampleRG +DedicatedCoreQuota : 20 +LowPriorityCoreQuota : 20 +PoolQuota : 20 +ActiveJobAndJobScheduleQuota : 20 +Tags : +TaskTenantUrl : https://cmdletexample.westus.batch.azure.com +``` + +This command regenerates the primary account key on the Batch account named pfuller. + +## PARAMETERS + +### -AccountName +Specifies the name of the Batch account for which this cmdlet regenerates a key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyType +Specifies the type of key that this cmdlet regenerates. +Valid values are: +- Primary +- Secondary + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group of the account for which this cmdlet regenerates a key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/New-AzBatchApplication.md b/azps-10.1.0/Az.Batch/New-AzBatchApplication.md new file mode 100644 index 0000000000..82fa63c73a --- /dev/null +++ b/azps-10.1.0/Az.Batch/New-AzBatchApplication.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: FF111B74-90A3-4F7C-B515-CE1EEF68EB54 +online version: https://learn.microsoft.com/powershell/module/az.batch/new-azbatchapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchApplication.md +--- + +# New-AzBatchApplication + +## SYNOPSIS +Adds an application to the specified Batch account. + +## SYNTAX + +``` +New-AzBatchApplication [-AccountName] [-ResourceGroupName] [-ApplicationName] + [[-AllowUpdates] ] [[-DisplayName] ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **New-AzBatchApplication** cmdlet adds an application to the specified Azure Batch account. + +## EXAMPLES + +### Example 1: Add an empty application to a Batch account +```powershell +New-AzBatchApplication -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationName "Litware" -AllowUpdates $True -DisplayName "Litware Advanced Reticulator" +``` + +This command creates the Litware application in the ContosoBatch account. +The application initially contains no packages. + +## PARAMETERS + +### -AccountName +Specifies the name of the Batch account to which this cmdlet adds an application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AllowUpdates +Specifies whether packages within the application can be overwritten using the same version string. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationName +Specifies the name of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies the display name for the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Batch account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSApplication + +## NOTES + +## RELATED LINKS + +[Get-AzBatchApplication](./Get-AzBatchApplication.md) + +[Get-AzBatchApplicationPackage](./Get-AzBatchApplicationPackage.md) + +[New-AzBatchApplicationPackage](./New-AzBatchApplicationPackage.md) + +[Remove-AzBatchApplication](./Remove-AzBatchApplication.md) + +[Remove-AzBatchApplicationPackage](./Remove-AzBatchApplicationPackage.md) + +[Set-AzBatchApplication](./Set-AzBatchApplication.md) + + diff --git a/azps-10.1.0/Az.Batch/New-AzBatchApplicationPackage.md b/azps-10.1.0/Az.Batch/New-AzBatchApplicationPackage.md new file mode 100644 index 0000000000..7f159fe0b1 --- /dev/null +++ b/azps-10.1.0/Az.Batch/New-AzBatchApplicationPackage.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: D53DAEB6-DC4F-473C-A193-A1E2A65326D4 +online version: https://learn.microsoft.com/powershell/module/az.batch/new-azbatchapplicationpackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchApplicationPackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchApplicationPackage.md +--- + +# New-AzBatchApplicationPackage + +## SYNOPSIS +Creates an application package in a Batch account. + +## SYNTAX + +### UploadAndActivate (Default) +``` +New-AzBatchApplicationPackage [-AccountName] [-ResourceGroupName] [-ApplicationName] + [-ApplicationVersion] [-Format] -FilePath + [-DefaultProfile ] [] +``` + +### ActivateOnly +``` +New-AzBatchApplicationPackage [-AccountName] [-ResourceGroupName] [-ApplicationName] + [-ApplicationVersion] [-Format] [-ActivateOnly] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **New-AzBatchApplicationPackage** cmdlet creates an application package in an Azure Batch account. + +## EXAMPLES + +### Example 1: Install an application package into a Batch account +```powershell +New-AzBatchApplicationPackage -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationName "Litware" -ApplicationVersion "1.0" -FilePath "litware.1.0.zip" -Format "zip" +``` + +This command creates and activates version 1.0 of the Litware application, and uploads the contents of litware.1.0.zip as the application package content. + +## PARAMETERS + +### -AccountName +Specifies the name of the Batch account to which this cmdlet adds an application package. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ActivateOnly +Indicates that this cmdlet activates an application package that has already been uploaded. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ActivateOnly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationName +Specifies the name of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationVersion +Specifies the version of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +Specifies the file to be uploaded as the application package binary file. + +```yaml +Type: System.String +Parameter Sets: UploadAndActivate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Format +Specifies the format of the application package binary file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Batch account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSApplicationPackage + +## NOTES + +## RELATED LINKS + +[Get-AzBatchApplication](./Get-AzBatchApplication.md) + +[Get-AzBatchApplicationPackage](./Get-AzBatchApplicationPackage.md) + +[New-AzBatchApplication](./New-AzBatchApplication.md) + +[Remove-AzBatchApplication](./Remove-AzBatchApplication.md) + +[Remove-AzBatchApplicationPackage](./Remove-AzBatchApplicationPackage.md) + +[Set-AzBatchApplication](./Set-AzBatchApplication.md) + + diff --git a/azps-10.1.0/Az.Batch/New-AzBatchCertificate.md b/azps-10.1.0/Az.Batch/New-AzBatchCertificate.md new file mode 100644 index 0000000000..dcc7acef30 --- /dev/null +++ b/azps-10.1.0/Az.Batch/New-AzBatchCertificate.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: B423C1A1-1988-4721-81E7-3B7EC163B03A +online version: https://learn.microsoft.com/powershell/module/az.batch/new-azbatchcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchCertificate.md +--- + +# New-AzBatchCertificate + +## SYNOPSIS +Adds a certificate to the specified Batch account. + +## SYNTAX + +### File (Default) +``` +New-AzBatchCertificate [-FilePath] [-Password ] [-Kind ] + -BatchContext [-DefaultProfile ] [] +``` + +### RawData +``` +New-AzBatchCertificate [-RawData] [-Password ] [-Kind ] + -BatchContext [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzBatchCertificate** cmdlet adds a certificate to the specified Azure Batch account. + +## EXAMPLES + +### Example 1: Add a certificate from a file +```powershell +New-AzBatchCertificate -FilePath "E:\Certificates\MyCert.cer" -BatchContext $Context +``` + +This command adds a certificate to the specified Batch account by using the file E:\Certificates\MyCert.cer. + +### Example 2: Add a certificate from raw data +```powershell +$RawData = [System.IO.File]::ReadAllBytes("E:\Certificates\MyCert.pfx") +New-AzBatchCertificate -RawData $RawData -Password "Password1234" -BatchContext $Context +``` + +The first command reads the data from the file named MyCert.pfx into the $RawData variable. +The second command adds a certificate to the specified Batch account using the raw data stored in $RawData. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +Specifies the path of the certificate file. +The certificate file must be in either .cer or .pfx format. + +```yaml +Type: System.String +Parameter Sets: File +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +The kind of certificate to create. If this is not specified, it is assumed that all certificates without a password are CER and all certificates with password are PFX. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCertificateKind +Parameter Sets: (All) +Aliases: +Accepted values: Cer, Pfx + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Specifies the password to access the certificate private key. +You must specify this parameter if you specify a certificate in .pfx format. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RawData +Specifies the raw certificate data in either .cer or .pfx format. + +```yaml +Type: System.Byte[] +Parameter Sets: RawData +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Byte[] + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchCertificate](./Get-AzBatchCertificate.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Remove-AzBatchCertificate](./Remove-AzBatchCertificate.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/New-AzBatchComputeNodeUser.md b/azps-10.1.0/Az.Batch/New-AzBatchComputeNodeUser.md new file mode 100644 index 0000000000..ee4570a721 --- /dev/null +++ b/azps-10.1.0/Az.Batch/New-AzBatchComputeNodeUser.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: FE7689DE-4EC6-4C6B-94A4-D22C61CA569D +online version: https://learn.microsoft.com/powershell/module/az.batch/new-azbatchcomputenodeuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchComputeNodeUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchComputeNodeUser.md +--- + +# New-AzBatchComputeNodeUser + +## SYNOPSIS +Creates a user account on a Batch compute node. + +## SYNTAX + +### Id +``` +New-AzBatchComputeNodeUser [-PoolId] [-ComputeNodeId] -Name -Password + [-ExpiryTime ] [-IsAdmin] -BatchContext + [-DefaultProfile ] [] +``` + +### ParentObject +``` +New-AzBatchComputeNodeUser [[-ComputeNode] ] -Name -Password + [-ExpiryTime ] [-IsAdmin] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzBatchComputeNodeUser** cmdlet creates a user account on an Azure Batch compute node. + +## EXAMPLES + +### Example 1: Create a user account that has administrative credentials +```powershell +New-AzBatchComputeNodeUser -PoolId "MyPool01" -ComputeNodeId "ComputeNode01" -Name "TestUser" -Password "Password" -ExpiryTime ([DateTime]::Now.AddDays(7)) -IsAdmin -BatchContext $Context +``` + +This command creates a user account on the compute node that has the ID ComputeNode01. +The node is in the pool that has the ID MyPool01. +The user name is TestUser, the password is Password, the account expires in seven days, and the account is has administrative credentials. + +### Example 2: Create a user account on a compute node by using the pipeline +```powershell +Get-AzBatchComputeNode "MyPool01" -Id "ComputeNode01" -BatchContext $Context | New-AzBatchComputeNodeUser -Name "TestUser" -Password "Password" -BatchContext $Context +``` + +This command gets the compute node named ComputeNode01 by using the **Get-AzBatchComputeNode** cmdlet. +That node is in the pool that has the ID MyPool01. +The command passes that compute node to the current cmdlet by using the pipeline operator. +The command creates a user account that has the user name TestUser and the password Password. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNode +Specifies the compute node, as a **PSComputeNode** object, on which this cmdlet creates a user account. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode +Parameter Sets: ParentObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNodeId +Specifies the ID of the compute node on which this cmdlet creates a user account. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the expiry time for the new user account. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAdmin +Indicates that the cmdlet creates a user account that has administrative credentials. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the new local Windows account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Specifies the user account password. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the pool that contains the compute node on which to create the user account. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSComputeNode + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchComputeNode](./Get-AzBatchComputeNode.md) + +[Remove-AzBatchComputeNodeUser](./Remove-AzBatchComputeNodeUser.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/New-AzBatchJob.md b/azps-10.1.0/Az.Batch/New-AzBatchJob.md new file mode 100644 index 0000000000..7f91886b75 --- /dev/null +++ b/azps-10.1.0/Az.Batch/New-AzBatchJob.md @@ -0,0 +1,317 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: B6229D26-D38C-44CD-B9CA-7F39365C8B9D +online version: https://learn.microsoft.com/powershell/module/az.batch/new-azbatchjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchJob.md +--- + +# New-AzBatchJob + +## SYNOPSIS +Creates a job in the Batch service. + +## SYNTAX + +``` +New-AzBatchJob [-Id] [-CommonEnvironmentSettings ] [-DisplayName ] + [-Constraints ] [-JobManagerTask ] + [-JobPreparationTask ] [-JobReleaseTask ] [-Metadata ] + -PoolInformation [-Priority ] [-UsesTaskDependencies] + [-OnTaskFailure ] [-OnAllTasksComplete ] + -BatchContext [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzBatchJob** cmdlet creates a job in the Azure Batch service in the account specified by the *BatchAccountContext* parameter. + +## EXAMPLES + +### Example 1: Create a job +```powershell +$PoolInformation = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSPoolInformation" +$PoolInformation.PoolId = "Pool22" +New-AzBatchJob -Id "ContosoJob35" -PoolInformation $PoolInformation -BatchContext $Context +``` + +The first command creates a **PSPoolInformation** object by using the New-Object cmdlet. +The command stores that object in the $PoolInformation variable. +The second command assigns the ID Pool22 to the **PoolId** property of the object in $PoolInformation. +The final command creates a job that has the ID ContosoJob35. +Tasks added to the job run on the pool that has the ID Pool22. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CommonEnvironmentSettings +Specifies the common environment variables, as key/value pairs, that this cmdlet sets for all tasks in the job. +The key is the environment variable name. +The value is the environment variable value. + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: CommonEnvironmentSetting + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Constraints +Specifies the execution constraints for the job. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSJobConstraints +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies the display name for the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies an ID for the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -JobManagerTask +Specifies the Job Manager task. +The Batch service runs the Job Manager task when the job is started. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSJobManagerTask +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobPreparationTask +Specifies the Job Preparation task. +The Batch service runs the Job Preparation task on a compute node before it starts any tasks of that job on that compute node. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSJobPreparationTask +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobReleaseTask +Specifies the Job Release task. +The Batch service runs the Job Release task when the job ends. +The Batch service runs the Job Release task on each compute node where it ran any task of the job. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSJobReleaseTask +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies metadata, as key/value pairs, to add to the job. +The key is the metadata name. +The value is the metadata value. + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnAllTasksComplete +Specifies an action the Batch service takes if all tasks in the job are in the completed state. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Batch.Common.OnAllTasksComplete] +Parameter Sets: (All) +Aliases: +Accepted values: NoAction, TerminateJob + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnTaskFailure +Specifies an action the Batch service takes if any task in the job fails. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Batch.Common.OnTaskFailure] +Parameter Sets: (All) +Aliases: +Accepted values: NoAction, PerformExitOptionsJobAction + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolInformation +Specifies the details of the pool on which the Batch service runs the tasks of the job. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSPoolInformation +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Specifies the priority of the job. +Valid values are: integers from -1000 to 1000. +A value of -1000 is the lowest priority. +A value of 1000 is the highest priority. +The default value is 0. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsesTaskDependencies +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchJob](./Disable-AzBatchJob.md) + +[Enable-AzBatchJob](./Enable-AzBatchJob.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchJob](./Get-AzBatchJob.md) + +[Get-AzBatchJobSchedule](./Get-AzBatchJobSchedule.md) + +[Remove-AzBatchJob](./Remove-AzBatchJob.md) + +[Stop-AzBatchJob](./Stop-AzBatchJob.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/New-AzBatchJobSchedule.md b/azps-10.1.0/Az.Batch/New-AzBatchJobSchedule.md new file mode 100644 index 0000000000..fd27195b47 --- /dev/null +++ b/azps-10.1.0/Az.Batch/New-AzBatchJobSchedule.md @@ -0,0 +1,188 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 87E7FA51-427E-4DB8-A6A2-D8638FD3DB8B +online version: https://learn.microsoft.com/powershell/module/az.batch/new-azbatchjobschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchJobSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchJobSchedule.md +--- + +# New-AzBatchJobSchedule + +## SYNOPSIS +Creates a job schedule in the Batch service. + +## SYNTAX + +``` +New-AzBatchJobSchedule [-Id] [-DisplayName ] -Schedule + -JobSpecification [-Metadata ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzBatchJobSchedule** cmdlet creates a job schedule in the Azure Batch service. +The *BatchAccountContext* parameter specifies the account in which this cmdlet creates the schedule. + +## EXAMPLES + +### Example 1: Create a job schedule +```powershell +$Schedule = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSSchedule" +$Schedule.RecurrenceInterval = [TimeSpan]::FromDays(1) +$JobSpecification = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSJobSpecification" +$JobSpecification.PoolInformation = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSPoolInformation" +$JobSpecification.PoolInformation.PoolId = "ContosoPool06" +New-AzBatchJobSchedule -Id "JobSchedule17" -Schedule $Schedule -JobSpecification $JobSpecification -BatchContext $Context +``` + +This example creates a job schedule. +The first five commands create and modify **PSSchedule**, **PSJobSpecification**, and **PSPoolInformation** objects. +The commands use the New-Object cmdlet and standard Azure PowerShell syntax. +The commands store these objects in the $Schedule and $JobSpecification variables. +The final command creates a job schedule that has the ID JobSchedule17. +This schedule creates jobs with a recurrence interval of one day. +The jobs run on the pool that has the ID ContosoPool06, as specified in the fifth command. +Use the **Get-AzBatchAccountKey** cmdlet to assign a context to the $Context variable. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies a display name for the job schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the job schedule that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -JobSpecification +Specifies the details of the jobs that this cmdlet includes in the job schedule. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSJobSpecification +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies metadata, as key/value pairs, to add to the job schedule. +The key is the metadata name. +The value is the metadata value. + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schedule +Specifies the schedule that determines when to create jobs. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSSchedule +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchJobSchedule](./Disable-AzBatchJobSchedule.md) + +[Enable-AzBatchJobSchedule](./Enable-AzBatchJobSchedule.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchJobSchedule](./Get-AzBatchJobSchedule.md) + +[Remove-AzBatchJobSchedule](./Remove-AzBatchJobSchedule.md) + +[Stop-AzBatchJobSchedule](./Stop-AzBatchJobSchedule.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/New-AzBatchPool.md b/azps-10.1.0/Az.Batch/New-AzBatchPool.md new file mode 100644 index 0000000000..40025ea9d4 --- /dev/null +++ b/azps-10.1.0/Az.Batch/New-AzBatchPool.md @@ -0,0 +1,570 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: C71C486E-34EB-42B5-B38A-D85B7DAA2F74 +online version: https://learn.microsoft.com/powershell/module/az.batch/new-azbatchpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchPool.md +--- + +# New-AzBatchPool + +## SYNOPSIS +Creates a pool in the Batch service. + +## SYNTAX + +### CloudServiceAndTargetDedicated (Default) +``` +New-AzBatchPool [-Id] -VirtualMachineSize [-DisplayName ] [-ResizeTimeout ] + [-TargetDedicatedComputeNodes ] [-TargetLowPriorityComputeNodes ] [-TaskSlotsPerNode ] + [-TaskSchedulingPolicy ] [-Metadata ] + [-InterComputeNodeCommunicationEnabled] [-StartTask ] + [-CertificateReferences ] + [-ApplicationPackageReferences ] + [-ApplicationLicenses ] + [-CloudServiceConfiguration ] [-NetworkConfiguration ] + [-MountConfiguration ] [-UserAccount ] + [-CurrentNodeCommunicationMode ] [-TargetNodeCommunicationMode ] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### VirtualMachineAndTargetDedicated +``` +New-AzBatchPool [-Id] -VirtualMachineSize [-DisplayName ] [-ResizeTimeout ] + [-TargetDedicatedComputeNodes ] [-TargetLowPriorityComputeNodes ] [-TaskSlotsPerNode ] + [-TaskSchedulingPolicy ] [-Metadata ] + [-InterComputeNodeCommunicationEnabled] [-StartTask ] + [-CertificateReferences ] + [-ApplicationPackageReferences ] + [-ApplicationLicenses ] + [-VirtualMachineConfiguration ] + [-NetworkConfiguration ] [-MountConfiguration ] + [-UserAccount ] [-CurrentNodeCommunicationMode ] + [-TargetNodeCommunicationMode ] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### CloudServiceAndAutoScale +``` +New-AzBatchPool [-Id] -VirtualMachineSize [-DisplayName ] + [-AutoScaleEvaluationInterval ] [-AutoScaleFormula ] [-TaskSlotsPerNode ] + [-TaskSchedulingPolicy ] [-Metadata ] + [-InterComputeNodeCommunicationEnabled] [-StartTask ] + [-CertificateReferences ] + [-ApplicationPackageReferences ] + [-ApplicationLicenses ] + [-CloudServiceConfiguration ] [-NetworkConfiguration ] + [-MountConfiguration ] [-UserAccount ] + [-CurrentNodeCommunicationMode ] [-TargetNodeCommunicationMode ] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### VirtualMachineAndAutoScale +``` +New-AzBatchPool [-Id] -VirtualMachineSize [-DisplayName ] + [-AutoScaleEvaluationInterval ] [-AutoScaleFormula ] [-TaskSlotsPerNode ] + [-TaskSchedulingPolicy ] [-Metadata ] + [-InterComputeNodeCommunicationEnabled] [-StartTask ] + [-CertificateReferences ] + [-ApplicationPackageReferences ] + [-ApplicationLicenses ] + [-VirtualMachineConfiguration ] + [-NetworkConfiguration ] [-MountConfiguration ] + [-UserAccount ] [-CurrentNodeCommunicationMode ] + [-TargetNodeCommunicationMode ] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **New-AzBatchPool** cmdlet creates a pool in the Azure Batch service under the account specified by the *BatchContext* parameter. + +## EXAMPLES + +### Example 1: Create a new pool using the TargetDedicated parameter set using CloudServiceConfiguration +```powershell +$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSCloudServiceConfiguration" -ArgumentList @(4,"*") +New-AzBatchPool -Id "MyPool" -VirtualMachineSize "STANDARD_D1_V2" -CloudServiceConfiguration $configuration -TargetDedicatedComputeNodes 3 -BatchContext $Context +``` + +The pool is configured to use STANDARD_D1_V2 virtual machines with operating system version of family four. + +### Example 2: Create a new pool using the TargetDedicated parameter set using VirtualMachineConfiguration +```powershell +$imageReference = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("WindowsServer", "MicrosoftWindowsServer", "2016-Datacenter", "*") +$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSVirtualMachineConfiguration" -ArgumentList @($imageReference, "batch.node.windows amd64") +New-AzBatchPool -Id "MyPool" -VirtualMachineSize "STANDARD_D1_V2" -VirtualMachineConfiguration $configuration -TargetDedicatedComputeNodes 3 -BatchContext $Context +``` + +This command creates a new pool with ID MyPool using the TargetDedicated parameter set. +The target allocation is three compute nodes. +The pool is configured to use STANDARD_D1_V2 virtual machines with the Windows-2016-Datacenter operating system image. + +### Example 3: Create a new pool using the AutoScale parameter set +```powershell +$imageReference = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("WindowsServer", "MicrosoftWindowsServer", "2016-Datacenter", "*") +$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSVirtualMachineConfiguration" -ArgumentList @($imageReference, "batch.node.windows amd64") +New-AzBatchPool -Id "AutoScalePool" -VirtualMachineSize "STANDARD_D1_V2" -VirtualMachineConfiguration $configuration -AutoScaleFormula '$TargetDedicated=2;' -BatchContext $Context +``` + +This command creates a new pool with ID AutoScalePool using the AutoScale parameter set. +The pool is configured to use STANDARD_D1_V2 virtual machines with the Windows-2016-Datacenter operating system image, and the target number of compute nodes are determined by the Autoscale formula. + +### Example 4: Create a pool with nodes in a subnet +```powershell +$imageReference = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("WindowsServer", "MicrosoftWindowsServer", "2016-Datacenter", "*") +$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSVirtualMachineConfiguration" -ArgumentList @($imageReference, "batch.node.windows amd64") +$networkConfig = New-Object Microsoft.Azure.Commands.Batch.Models.PSNetworkConfiguration +$networkConfig.SubnetId = "/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}" +New-AzBatchPool -Id "AutoScalePool" -VirtualMachineSize "STANDARD_D1_V2" -VirtualMachineConfiguration $configuration -TargetDedicatedComputeNodes 3 -NetworkConfiguration $networkConfig -BatchContext $Context +``` + +### Example 5: Create a pool with custom user accounts +```powershell +$imageReference = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("WindowsServer", "MicrosoftWindowsServer", "2016-Datacenter", "*") +$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSVirtualMachineConfiguration" -ArgumentList @($imageReference, "batch.node.windows amd64") +$userAccount = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserAccount -ArgumentList @("myaccount", "mypassword") +New-AzBatchPool -Id "AutoScalePool" -VirtualMachineSize "STANDARD_D1_V2" -VirtualMachineConfiguration $configuration -TargetDedicatedComputeNodes 3 -UserAccount $userAccount +``` + +## PARAMETERS + +### -ApplicationLicenses +The list of application licenses the Batch service will make available on each compute node in the pool. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: ApplicationLicense + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationPackageReferences +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSApplicationPackageReference[] +Parameter Sets: (All) +Aliases: ApplicationPackageReference + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoScaleEvaluationInterval +Specifies the amount of time, in minutes, that elapses before the pool size is automatically adjusted according to the AutoScale formula. +The default value is 15 minutes, and the minimum value is 5 minutes. + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: CloudServiceAndAutoScale, VirtualMachineAndAutoScale +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoScaleFormula +Specifies the formula for automatically scaling the pool. + +```yaml +Type: System.String +Parameter Sets: CloudServiceAndAutoScale, VirtualMachineAndAutoScale +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertificateReferences +Specifies certificates associated with the pool. +The Batch service installs the referenced certificates on each compute node of the pool. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCertificateReference[] +Parameter Sets: (All) +Aliases: CertificateReference + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServiceConfiguration +Specifies configuration settings for a pool based on the Azure cloud service platform. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudServiceConfiguration +Parameter Sets: CloudServiceAndTargetDedicated, CloudServiceAndAutoScale +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CurrentNodeCommunicationMode +The current pool communication mode. + +```yaml +Type: Microsoft.Azure.Batch.Common.NodeCommunicationMode +Parameter Sets: (All) +Aliases: +Accepted values: Default, Classic, Simplified + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies the display name of the pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the pool to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InterComputeNodeCommunicationEnabled +Indicates that this cmdlet sets up the pool for direct communication between dedicated compute nodes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies the metadata, as key/value pairs, to add to the new pool. +The key is the metadata name. +The value is the metadata value. + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MountConfiguration +A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSMountConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkConfiguration +The network configuration for the pool. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSNetworkConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResizeTimeout +Specifies the time-out for allocating compute nodes to the pool. + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: CloudServiceAndTargetDedicated, VirtualMachineAndTargetDedicated +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTask +Specifies the start task specification for the pool. +The start task is run when a compute node joins the pool, or when the compute node is rebooted or reimaged. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSStartTask +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDedicatedComputeNodes +Specifies the target number of dedicated compute nodes to allocate to the pool. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: CloudServiceAndTargetDedicated, VirtualMachineAndTargetDedicated +Aliases: TargetDedicated + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetLowPriorityComputeNodes +Specifies the target number of low-priority compute nodes to allocate to the pool. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: CloudServiceAndTargetDedicated, VirtualMachineAndTargetDedicated +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNodeCommunicationMode +The desired node communication mode for the pool. + +```yaml +Type: Microsoft.Azure.Batch.Common.NodeCommunicationMode +Parameter Sets: (All) +Aliases: +Accepted values: Default, Classic, Simplified + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TaskSchedulingPolicy +Specifies the task scheduling policy, such as the ComputeNodeFillType. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSTaskSchedulingPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TaskSlotsPerNode +The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. +The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: MaxTasksPerComputeNode + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAccount +The list of user accounts to be created on each node in the pool. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSUserAccount[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineConfiguration +Specifies configuration settings for a pool on the virtual machines infrastructure. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSVirtualMachineConfiguration +Parameter Sets: VirtualMachineAndTargetDedicated, VirtualMachineAndAutoScale +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineSize +Specifies the size of the virtual machines in the pool. +For more information about virtual machine sizes, see [Sizes for virtual machines](/azure/virtual-machines/sizes) in the Microsoft Azure site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchPool](./Get-AzBatchPool.md) + +[Remove-AzBatchPool](./Remove-AzBatchPool.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/New-AzBatchResourceFile.md b/azps-10.1.0/Az.Batch/New-AzBatchResourceFile.md new file mode 100644 index 0000000000..062c070c88 --- /dev/null +++ b/azps-10.1.0/Az.Batch/New-AzBatchResourceFile.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +online version: https://learn.microsoft.com/powershell/module/az.batch/new-azbatchresourcefile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchResourceFile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchResourceFile.md +--- + +# New-AzBatchResourceFile + +## SYNOPSIS +Creates a Resource File for usage by `New-AzBatchTask`. + +## SYNTAX + +### HttpUrl (Default) +``` +New-AzBatchResourceFile -HttpUrl -FilePath [-FileMode ] + [-DefaultProfile ] [] +``` + +### StorageContainerUrl +``` +New-AzBatchResourceFile [-FilePath ] [-FileMode ] [-BlobPrefix ] + -StorageContainerUrl [-DefaultProfile ] [] +``` + +### AutoStorageContainerName +``` +New-AzBatchResourceFile [-FilePath ] [-FileMode ] -AutoStorageContainerName + [-BlobPrefix ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Creates a Resource File for usage by `New-AzBatchTask`. + +## EXAMPLES + +### Example 1: Create a resource file from an HTTP URL pointing at a single file +```powershell +$file = New-AzBatchResourceFile -HttpUrl "https://testacct.blob.core.windows.net/" -FilePath "file1" +New-AzBatchTask -JobId "Job-000001" -Id "Task23" -CommandLine "cmd /c dir /s" -ResourceFiles $file -BatchContext $Context +``` + +Creates a `PSResourceFile` referencing an HTTP url. + +### Example 2: Create a resource file from an Azure Storage container URL +```powershell +$file = New-AzBatchResourceFile -StorageContainerUrl "https://testacct.blob.core.windows.net/mycontainer" -FilePath "myfolder" +New-AzBatchTask -JobId "Job-000001" -Id "Task23" -CommandLine "cmd /c dir /s" -ResourceFiles $file -BatchContext $Context +``` + +Creates a `PSResourceFile` referencing an Azure Storage container URL. All files in the container will be downloaded to the specified folder. + +### Example 3: Create a resource file from an Auto Storage container name +```powershell +$file = New-AzBatchResourceFile -AutoStorageContainerName "mycontainer" -FilePath "myfolder" +New-AzBatchTask -JobId "Job-000001" -Id "Task23" -CommandLine "cmd /c dir /s" -ResourceFiles $file -BatchContext $Context +``` + +Creates a `PSResourceFile` referencing an Auto Storage container name. All files in the container will be downloaded to the specified folder. + +## PARAMETERS + +### -AutoStorageContainerName +The storage container name in the auto storage account. + +```yaml +Type: System.String +Parameter Sets: AutoStorageContainerName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobPrefix +Gets the blob prefix to use when downloading blobs from an Azure Storage container. +Only the blobs whose names begin with the specified prefix will be downloaded. +This prefix can be a partial filename or a subdirectory. +If a prefix is not specified, all the files in the container will be downloaded. + +```yaml +Type: System.String +Parameter Sets: StorageContainerUrl, AutoStorageContainerName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileMode +Gets the file permission mode attribute in octal format. +This property is applicable only if the resource file is downloaded to a Linux node. +If this property is not specified for a Linux node, then the default value is 0770. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +The location on the compute node to which to download the file(s), relative to the task's working directory. If the HttpUrl parameter is specified, the FilePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the AutoStorageContainerName or StorageContainerUrl parameters are specified, FilePath is optional and is the directory to download the files to. In the case where FilePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified FilePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). + +```yaml +Type: System.String +Parameter Sets: HttpUrl +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: StorageContainerUrl, AutoStorageContainerName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpUrl +The URL of the file to download. +If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. +There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access. + +```yaml +Type: System.String +Parameter Sets: HttpUrl +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerUrl +The URL of the blob container within Azure Blob Storage. +This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading blobs from the container. +There are two ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the container, or set the ACL for the container to allow public access. + +```yaml +Type: System.String +Parameter Sets: StorageContainerUrl +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSResourceFile + +## NOTES + +## RELATED LINKS + +[New-AzBatchTask](./New-AzBatchTask.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Batch/New-AzBatchTask.md b/azps-10.1.0/Az.Batch/New-AzBatchTask.md new file mode 100644 index 0000000000..78fb3fb9c0 --- /dev/null +++ b/azps-10.1.0/Az.Batch/New-AzBatchTask.md @@ -0,0 +1,480 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 2B4BFDDA-9721-42E6-84E1-A209CB782954 +online version: https://learn.microsoft.com/powershell/module/az.batch/new-azbatchtask +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchTask.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/New-AzBatchTask.md +--- + +# New-AzBatchTask + +## SYNOPSIS +Creates a Batch task under a job. + +## SYNTAX + +### JobId_Single (Default) +``` +New-AzBatchTask -JobId -Id [-DisplayName ] -CommandLine + [-ResourceFiles ] [-EnvironmentSettings ] + [-AuthenticationTokenSettings ] [-UserIdentity ] + [-AffinityInformation ] [-Constraints ] + [-MultiInstanceSettings ] [-DependsOn ] + [-ApplicationPackageReferences ] [-OutputFile ] + [-ExitConditions ] [-ContainerSettings ] + -BatchContext [-DefaultProfile ] [] +``` + +### JobId_Bulk +``` +New-AzBatchTask -JobId [-Tasks ] -BatchContext + [-DefaultProfile ] [] +``` + +### JobObject_Bulk +``` +New-AzBatchTask [-Job ] [-Tasks ] -BatchContext + [-DefaultProfile ] [] +``` + +### JobObject_Single +``` +New-AzBatchTask [-Job ] -Id [-DisplayName ] -CommandLine + [-ResourceFiles ] [-EnvironmentSettings ] + [-AuthenticationTokenSettings ] [-UserIdentity ] + [-AffinityInformation ] [-Constraints ] + [-MultiInstanceSettings ] [-DependsOn ] + [-ApplicationPackageReferences ] [-OutputFile ] + [-ExitConditions ] [-ContainerSettings ] + -BatchContext [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **New-AzBatchTask** cmdlet creates an Azure Batch task under the job specified by the *JobId* parameter or the *Job* parameter. + +## EXAMPLES + +### Example 1: Create a Batch task +```powershell +New-AzBatchTask -JobId "Job-000001" -Id "Task23" -CommandLine "cmd /c dir /s" -BatchContext $Context +``` + +This command creates a task that has the ID Task23 under the job that has the ID Job-000001. +The task runs the specified command. +Use the **Get-AzBatchAccountKey** cmdlet to assign a context to the $Context variable. + +### Example 2: Create a Batch task +```powershell +$autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin") +$userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser +Get-AzBatchJob -Id "Job-000001" -BatchContext $Context | New-AzBatchTask -Id "Task26" -CommandLine "cmd /c echo hello > newFile.txt" -UserIdentity $userIdentity -BatchContext $Context +``` + +This command gets the Batch job that has the ID Job-000001 by using the **Get-AzBatchJob** cmdlet. +The command passes that job to the current cmdlet by using the pipeline operator. +The command creates a task that has the ID Task26 under that job. +The task runs the specified command by using elevated permissions. + +### Example 3: Add a collection of tasks to the specified job by using the pipeline +```powershell +$Context = Get-AzBatchAccountKey -AccountName "ContosoBatchAccount" +$Task01 = New-Object Microsoft.Azure.Commands.Batch.Models.PSCloudTask("Task23", "cmd /c dir /s") +$Task02 = New-Object Microsoft.Azure.Commands.Batch.Models.PSCloudTask("Task24", "cmd /c dir /s") +Get-AzBatchJob -Id "Job-000001" -BatchContext $Context | New-AzBatchTask -Tasks @($Task01, $Task02) -BatchContext $Context +``` + +The first command creates an object reference to the account keys for the batch account named ContosoBatchAccount by using **Get-AzBatchAccountKey**. +The command stores this object reference in the $Context variable. +The next two commands create **PSCloudTask** objects by using the New-Object cmdlet. +The commands store the tasks in the $Task01 and $Task02 variables. +The final command gets the Batch job that has the ID Job-000001 by using **Get-AzBatchJob**. +Then the command passes that job to the current cmdlet by using the pipeline operator. +The command adds a collection of tasks under that job. +The command uses the context stored in $Context. + +### Example 4: Add a collection of tasks to the specified job +```powershell +$Context = Get-AzBatchAccountKey -AccountName "ContosoBatchAccount" +$Task01 = New-Object Microsoft.Azure.Commands.Batch.Models.PSCloudTask("Task23", "cmd /c dir /s") +$Task02 = New-Object Microsoft.Azure.Commands.Batch.Models.PSCloudTask("Task24", "cmd /c dir /s") +New-AzBatchTask -JobId "Job-000001" -Tasks @($Task01, $Task02) -BatchContext $Context +``` + +The first command creates an object reference to the account keys for the batch account named ContosoBatchAccount by using **Get-AzBatchAccountKey**. +The command stores this object reference in the $Context variable. +The next two commands create **PSCloudTask** objects by using the New-Object cmdlet. +The commands store the tasks in the $Task01 and $Task02 variables. +The final command adds the tasks stored in $Task01 and $Task02 under the job that has the ID Job-000001. + +### Example 5: Add a task with output files +```powershell +New-AzBatchTask -JobId "Job-000001" -Id "Task23" -CommandLine "cmd /c dir /s" -BatchContext $Context +$blobContainerDestination = New-Object Microsoft.Azure.Commands.Batch.Models.PSOutputFileBlobContainerDestination "https://myaccount.blob.core.windows.net/sascontainer?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D" +$destination = New-Object Microsoft.Azure.Commands.Batch.Models.PSOutputFileDestination $blobContainerDestination +$uploadOptions = New-Object Microsoft.Azure.Commands.Batch.Models.PSOutputFileUploadOptions "TaskSuccess" +$outputFile = New-Object Microsoft.Azure.Commands.Batch.Models.PSOutputFile "*.txt", $blobContainerDestination, $uploadOptions + +New-AzBatchTask -JobId "Job-000001" -Id "Task23" -CommandLine "cmd /c dir /s" -OutputFile $outputFile -BatchContext $Context +``` + +### Example 6: Add a task with authentication token settings +```powershell +$authSettings = New-Object Microsoft.Azure.Commands.Batch.Models.PSAuthenticationTokenSettings +$authSettings.Access = "Job" +New-AzBatchTask -JobId "Job-000001" -Id "Task23" -CommandLine "cmd /c dir /s" -AuthenticationTokenSettings $authSettings -BatchContext $Context +``` + +### Example 7: Add a task which runs in a container +```powershell +$Context = Get-AzBatchAccountKey -AccountName "ContosoBatchAccount" +New-AzBatchTask -JobId "Job-000001" -Id "Task23" -CommandLine "cmd /c dir /s" -ContainerSettings (New-Object Microsoft.Azure.Commands.Batch.Models.PSTaskContainerSettings "containerImageName") -BatchContext $Context +``` + +## PARAMETERS + +### -AffinityInformation +Specifies a locality hint that the Batch service uses to select a node on which to run the task. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSAffinityInformation +Parameter Sets: JobId_Single, JobObject_Single +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationPackageReferences +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSApplicationPackageReference[] +Parameter Sets: JobId_Single, JobObject_Single +Aliases: ApplicationPackageReference + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationTokenSettings +The settings for an authentication token that the task can use to perform Batch service operations. +If this is set, the Batch service provides the task with an authentication token which can be used to +authenticate Batch service operations without requiring an account access key. The token is provided via the +AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token +depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, +or check the status of the job or of other tasks. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSAuthenticationTokenSettings +Parameter Sets: JobId_Single, JobObject_Single +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CommandLine +Specifies the command line for the task. + +```yaml +Type: System.String +Parameter Sets: JobId_Single, JobObject_Single +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Constraints +Specifies the execution constraints that apply to this task. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints +Parameter Sets: JobId_Single, JobObject_Single +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerSettings +The settings for the container under which the task runs. +If the pool that will run this task has containerConfiguration set, this must be set as well. If the pool that will run this task +doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the +AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables +are mapped into the container, and the task command line is executed in the container. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSTaskContainerSettings +Parameter Sets: JobId_Single, JobObject_Single +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DependsOn +Specifies that the task depends on other tasks. +The task will not be scheduled until all depended-on tasks have completed successfully. + +```yaml +Type: Microsoft.Azure.Batch.TaskDependencies +Parameter Sets: JobId_Single, JobObject_Single +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies the display name of the task. + +```yaml +Type: System.String +Parameter Sets: JobId_Single, JobObject_Single +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentSettings +Specifies the environment settings, as key/value pairs, that this cmdlet adds to the task. +The key is the environment setting name. +The value is the environment setting. + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: JobId_Single, JobObject_Single +Aliases: EnvironmentSetting + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExitConditions +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSExitConditions +Parameter Sets: JobId_Single, JobObject_Single +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the task. + +```yaml +Type: System.String +Parameter Sets: JobId_Single, JobObject_Single +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Job +Specifies the job under which this cmdlet creates the task. +To obtain a **PSCloudJob** object, use the Get-AzBatchJob cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJob +Parameter Sets: JobObject_Bulk, JobObject_Single +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of the job under which this cmdlet creates the task. + +```yaml +Type: System.String +Parameter Sets: JobId_Single, JobId_Bulk +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiInstanceSettings +Specifies information about how to run a multi-instance task. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings +Parameter Sets: JobId_Single, JobObject_Single +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFile +Gets or sets a list of files that the Batch service will upload from the compute node after running the command line. +For multi-instance tasks, the files will only be uploaded from the compute node on which the primary task is executed. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSOutputFile[] +Parameter Sets: JobId_Single, JobObject_Single +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceFiles +Specifies resource files, as key/value pairs, that the task requires. +The key is the resource file path. +The value is the resource file blob source. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSResourceFile[] +Parameter Sets: JobId_Single, JobObject_Single +Aliases: ResourceFile + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tasks +Specifies the collection of tasks to be added. +Each task must have a unique ID. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask[] +Parameter Sets: JobId_Bulk, JobObject_Bulk +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserIdentity +The user identity under which the task runs. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSUserIdentity +Parameter Sets: JobId_Single, JobObject_Single +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSCloudJob + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchJob](./Get-AzBatchJob.md) + +[Get-AzBatchTask](./Get-AzBatchTask.md) + +[New-AzBatchTask](./New-AzBatchTask.md) + +[Remove-AzBatchTask](./Remove-AzBatchTask.md) + +[Stop-AzBatchTask](./Stop-AzBatchTask.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Remove-AzBatchAccount.md b/azps-10.1.0/Az.Batch/Remove-AzBatchAccount.md new file mode 100644 index 0000000000..5c8bc4bb5d --- /dev/null +++ b/azps-10.1.0/Az.Batch/Remove-AzBatchAccount.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 89F604DD-EE77-440D-BCC9-3F74D994C447 +online version: https://learn.microsoft.com/powershell/module/az.batch/remove-azbatchaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchAccount.md +--- + +# Remove-AzBatchAccount + +## SYNOPSIS +Removes a Batch account. + +## SYNTAX + +``` +Remove-AzBatchAccount [-AccountName] [[-ResourceGroupName] ] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzBatchAccount** cmdlet removes an Azure Batch account. +This cmdlet prompts you before it removes an account, unless you specify the *Force* parameter. + +## EXAMPLES + +### Example 1: Remove a Batch account +```powershell +Remove-AzBatchAccount -AccountName "pfuller" +``` + +This command removes the Batch account named pfuller. +This command prompts you for confirmation before it deletes the account. + +## PARAMETERS + +### -AccountName +Specifies the name of the Batch account that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group of the account that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccount](./Get-AzBatchAccount.md) + +[New-AzBatchAccount](./New-AzBatchAccount.md) + +[Set-AzBatchAccount](./Set-AzBatchAccount.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Remove-AzBatchApplication.md b/azps-10.1.0/Az.Batch/Remove-AzBatchApplication.md new file mode 100644 index 0000000000..1f0e990cd0 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Remove-AzBatchApplication.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 2CED21D6-4BEF-423B-A04A-5B812CEB975D +online version: https://learn.microsoft.com/powershell/module/az.batch/remove-azbatchapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchApplication.md +--- + +# Remove-AzBatchApplication + +## SYNOPSIS +Deletes an application from a Batch account. + +## SYNTAX + +``` +Remove-AzBatchApplication [-AccountName] [-ResourceGroupName] [-ApplicationName] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Remove-AzBatchApplication** cmdlet deletes an application from an Azure Batch account. + +## EXAMPLES + +### Example 1: Delete an application from a Batch account +```powershell +Remove-AzBatchApplication -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationName "Litware" +``` + +This command deletes the Litware application from the ContosoBatch account. +The command fails if the application contains any packages. + +## PARAMETERS + +### -AccountName +Specifies the name of the Batch account from which this cmdlet removes an application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationName +Specifies the name of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Batch account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchApplication](./Get-AzBatchApplication.md) + +[Get-AzBatchApplicationPackage](./Get-AzBatchApplicationPackage.md) + +[New-AzBatchApplication](./New-AzBatchApplication.md) + +[New-AzBatchApplicationPackage](./New-AzBatchApplicationPackage.md) + +[Remove-AzBatchApplicationPackage](./Remove-AzBatchApplicationPackage.md) + +[Set-AzBatchApplication](./Set-AzBatchApplication.md) + + diff --git a/azps-10.1.0/Az.Batch/Remove-AzBatchApplicationPackage.md b/azps-10.1.0/Az.Batch/Remove-AzBatchApplicationPackage.md new file mode 100644 index 0000000000..348650b7ba --- /dev/null +++ b/azps-10.1.0/Az.Batch/Remove-AzBatchApplicationPackage.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: FD2E3442-9CEA-4390-BE9C-772C7D6FD1E2 +online version: https://learn.microsoft.com/powershell/module/az.batch/remove-azbatchapplicationpackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchApplicationPackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchApplicationPackage.md +--- + +# Remove-AzBatchApplicationPackage + +## SYNOPSIS +Deletes an application package record and the binary file. + +## SYNTAX + +``` +Remove-AzBatchApplicationPackage [-AccountName] [-ResourceGroupName] + [-ApplicationName] [-ApplicationVersion] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Remove-AzBatchApplicationPackage** cmdlet deletes an application package record and the binary file from an Azure Batch account. + +## EXAMPLES + +### Example 1: Delete an application package from a Batch account +```powershell +Remove-AzBatchApplicationPackage -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationName "litware" -ApplicationVersion "1.0" +``` + +This command deletes version 1.0 of the Litware application from the ContosoBatchGroup account. +The command deletes both the package record and the blob that contain the package binary file. + +## PARAMETERS + +### -AccountName +Specifies the name of the Batch account from which this cmdlet deletes an application package. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationName +Specifies the name of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationVersion +Specifies the version of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Batch account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchApplication](./Get-AzBatchApplication.md) + +[Get-AzBatchApplicationPackage](./Get-AzBatchApplicationPackage.md) + +[New-AzBatchApplication](./New-AzBatchApplication.md) + +[New-AzBatchApplicationPackage](./New-AzBatchApplicationPackage.md) + +[Remove-AzBatchApplication](./Remove-AzBatchApplication.md) + +[Set-AzBatchApplication](./Set-AzBatchApplication.md) + + diff --git a/azps-10.1.0/Az.Batch/Remove-AzBatchCertificate.md b/azps-10.1.0/Az.Batch/Remove-AzBatchCertificate.md new file mode 100644 index 0000000000..1c30da4cfc --- /dev/null +++ b/azps-10.1.0/Az.Batch/Remove-AzBatchCertificate.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 3DFFD0F2-6CD8-4FBE-B15C-8505CBF8F44E +online version: https://learn.microsoft.com/powershell/module/az.batch/remove-azbatchcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchCertificate.md +--- + +# Remove-AzBatchCertificate + +## SYNOPSIS +Deletes a certificate from an account. + +## SYNTAX + +``` +Remove-AzBatchCertificate [-ThumbprintAlgorithm] [-Thumbprint] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzBatchCertificate** cmdlet removes a certificate from the specified Azure Batch account. + +## EXAMPLES + +### Example 1: Remove a certificate +```powershell +Remove-AzBatchCertificate -ThumbprintAlgorithm "sha1" -Thumbprint "c1e494a415149c5f211c4778b52f2e834a07247c" -BatchContext $Context +``` + +This command removes the certificate that has the specified thumbprint. + +### Example 2:Remove all active certificates +```powershell +Get-AzBatchCertificate -Filter "state eq 'active'" -BatchContext $Context | Remove-AzBatchCertificate -BatchContext $Context +``` + +This command gets all certificates that are active by using the Get-AzBatchCertificate cmdlet. +The command passes the active certificates to the current cmdlet by using the pipeline operator. +That cmdlet removes each certificate. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Thumbprint +Specifies the thumbprint of the certificate that this cmdlet deletes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ThumbprintAlgorithm +Specifies the algorithm used to derive the *Thumbprint* parameter. +Currently, the only valid value is sha1. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchCertificate](./Get-AzBatchCertificate.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[New-AzBatchCertificate](./New-AzBatchCertificate.md) + +[Stop-AzBatchCertificateDeletion](./Stop-AzBatchCertificateDeletion.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Remove-AzBatchComputeNode.md b/azps-10.1.0/Az.Batch/Remove-AzBatchComputeNode.md new file mode 100644 index 0000000000..7219cfb6fe --- /dev/null +++ b/azps-10.1.0/Az.Batch/Remove-AzBatchComputeNode.md @@ -0,0 +1,248 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 0BB79553-26DA-413C-8086-740DB6B31A85 +online version: https://learn.microsoft.com/powershell/module/az.batch/remove-azbatchcomputenode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchComputeNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchComputeNode.md +--- + +# Remove-AzBatchComputeNode + +## SYNOPSIS +Removes compute nodes from a pool. + +## SYNTAX + +### Id (Default) +``` +Remove-AzBatchComputeNode [-PoolId] [-Ids] + [-DeallocationOption ] [-ResizeTimeout ] [-Force] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### InputObject +``` +Remove-AzBatchComputeNode [[-ComputeNode] ] + [-DeallocationOption ] [-ResizeTimeout ] [-Force] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzBatchComputeNode** cmdlet removes Azure Batch compute nodes from a pool. + +## EXAMPLES + +### Example 1: Remove a compute node +```powershell +Remove-AzBatchComputeNode -PoolId "Pool07" -Ids "tvm-2316545714_1-20150725t213220z" -DeallocationOption Terminate -ResizeTimeout ([TimeSpan]::FromMinutes(10)) -BatchContext $Context +``` + +This command removes compute node that has the specified ID from pool that has the ID Pool07. +The command specifies the Terminate deallocation option. +The resize time-out is of 10 minutes. + +### Example 2: Remove a compute node by using the pipeline +```powershell +Get-AzBatchComputeNode -PoolId "Pool07" -Id "tvm-2316545714_1-20150725t213220z" -BatchContext $Context | Remove-AzBatchComputeNode -Force -BatchContext $Context +``` + +This command gets the compute node that has the specified ID from pool that has the ID Pool07 by using the Get-AzBatchComputeNode cmdlet. +The command passes that node to the current cmdlet by using the pipeline. +The current cmdlet removes the compute node. +The command specifies the *Force* parameter. +Therefore, the command does not prompt you for confirmation. + +### Example 3: Remove multiple nodes +```powershell +Remove-AzBatchComputeNode -PoolId "Pool07" @("tvm-1783593343_28-20151117t214257z","tvm-1783593343_29-20151117t214257z") -Force -BatchContext $Context +``` + +This command removes two compute nodes from the pool that has the ID Pool07. +The command does not prompt you for confirmation. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNode +Specifies the **PSComputeNode** object that represents the compute node that this cmdlet removes. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode +Parameter Sets: InputObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DeallocationOption +Specifies a deallocation option for the removal operation that this cmdlet starts. +The default value is Requeue. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption] +Parameter Sets: (All) +Aliases: +Accepted values: Requeue, Terminate, TaskCompletion, RetainedData + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ids +Specifies an array of IDs of compute nodes that this cmdlet removes from the pool. + +```yaml +Type: System.String[] +Parameter Sets: Id +Aliases: Id + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the pool that contains the compute nodes that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResizeTimeout +Specifies the time-out interval for removal of the compute nodes from the pool. +The default value is 10 minutes. +The minimum value is 5 minutes. + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSComputeNode + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchComputeNode](./Get-AzBatchComputeNode.md) + +[Restart-AzBatchComputeNode](./Restart-AzBatchComputeNode.md) + + diff --git a/azps-10.1.0/Az.Batch/Remove-AzBatchComputeNodeUser.md b/azps-10.1.0/Az.Batch/Remove-AzBatchComputeNodeUser.md new file mode 100644 index 0000000000..110c718c82 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Remove-AzBatchComputeNodeUser.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 9E423A10-06AF-42F8-AC90-82DB01012AFA +online version: https://learn.microsoft.com/powershell/module/az.batch/remove-azbatchcomputenodeuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchComputeNodeUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchComputeNodeUser.md +--- + +# Remove-AzBatchComputeNodeUser + +## SYNOPSIS +Deletes a user account from a Batch compute node. + +## SYNTAX + +``` +Remove-AzBatchComputeNodeUser [-PoolId] [-ComputeNodeId] [-Name] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzBatchComputeNodeUser** cmdlet deletes a user account from an Azure Batch compute node. + +## EXAMPLES + +### Example 1: Delete a user from a compute node +```powershell +Remove-AzBatchComputeNodeUser -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Name "User14" -BatchContext $Context +``` + +This command deletes the user named User14 from compute node named ComputeNode01. +The compute node is in the pool named Pool01. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNodeId +Specifies the ID of the compute node on which this cmdlet deletes the user account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the user account to delete. +You cannot specify wildcard characters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the pool that contains the compute node on which to delete the user account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[New-AzBatchComputeNodeUser](./New-AzBatchComputeNodeUser.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Remove-AzBatchJob.md b/azps-10.1.0/Az.Batch/Remove-AzBatchJob.md new file mode 100644 index 0000000000..4da7551362 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Remove-AzBatchJob.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: CB2F472B-C792-4A11-A055-F4161DCFBB28 +online version: https://learn.microsoft.com/powershell/module/az.batch/remove-azbatchjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchJob.md +--- + +# Remove-AzBatchJob + +## SYNOPSIS +Deletes a Batch job. + +## SYNTAX + +``` +Remove-AzBatchJob [-Id] [-Force] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzBatchJob** cmdlet deletes an Azure Batch job. +This cmdlet prompts you for confirmation before it removes a job, unless you specify the *Force* parameter. + +## EXAMPLES + +### Example 1: Delete a Batch job +```powershell +Remove-AzBatchJob -Id "Job-000001" -BatchContext $Context +``` + +This command deletes the job that has the ID Job-000001. +The command prompts you for confirmation before it deletes the job. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Delete a Batch job without confirmation by using the pipeline +```powershell +Get-AzBatchJob -Id "Job-000002" -BatchContext $Context | Remove-AzBatchJob -Force -BatchContext $Context +``` + +This command gets the job that has the ID Job-000002 by using the Get-AzBatchJob cmdlet. +The command passes that job to the current cmdlet by using the pipeline operator. +The command deletes that job. +Because the command includes the *Force* parameter, it does not prompt you for confirmation. + +### Example 3: Loop through all jobs and delete +```powershell +# Get context +$accountname = "PUT YOUR AZURE BATCH ACCOUNT NAME HERE" +$batchcontext = Get-AzBatchAccount -AccountName $accountname + +# Get jobs +$jobs = Get-AzBatchJob -BatchContext $batchcontext + +# Loop through jobs +foreach ($element in $jobs) { + Write-Host "Processing "$element.Id + Remove-AzBatchJob -Id $element.Id -BatchContext $batchcontext -Force -Confirm:$false +} +``` + +The commands above Remove all of the jobs for a given Azure Batch account. +Because the command includes the *Force* parameter, it does not prompt you for confirmation. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the job that this cmdlet deletes. +You cannot specify wildcard characters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchJob](./Disable-AzBatchJob.md) + +[Enable-AzBatchJob](./Enable-AzBatchJob.md) + +[Get-AzBatchJob](./Get-AzBatchJob.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[New-AzBatchJob](./New-AzBatchJob.md) + +[Stop-AzBatchJob](./Stop-AzBatchJob.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Remove-AzBatchJobSchedule.md b/azps-10.1.0/Az.Batch/Remove-AzBatchJobSchedule.md new file mode 100644 index 0000000000..bd1c96134e --- /dev/null +++ b/azps-10.1.0/Az.Batch/Remove-AzBatchJobSchedule.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 97FA5983-0D73-4336-99DA-46E5992F06DC +online version: https://learn.microsoft.com/powershell/module/az.batch/remove-azbatchjobschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchJobSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchJobSchedule.md +--- + +# Remove-AzBatchJobSchedule + +## SYNOPSIS +Removes a Batch job schedule. + +## SYNTAX + +``` +Remove-AzBatchJobSchedule [-Id] [-Force] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzBatchJobSchedule** cmdlet removes an Azure Batch job schedule. + +## EXAMPLES + +### Example 1: Delete a Batch job schedule +```powershell +Remove-AzBatchJobSchedule -Id "MyJobSchedule" -BatchContext $Context +``` + +This command deletes the job schedule that has the ID MyJobSchedule. +The command prompts you for confirmation before it deletes the job. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Delete a Batch job without confirmation by using the pipeline +```powershell +Get-AzBatchJobSchedule -Id "MyJobSchedule" -BatchContext $Context | Remove-AzBatchJobSchedule -Force -BatchContext $Context +``` + +This command gets the job schedule that has the ID MyJobSchedule by using the Get-AzBatchJobSchedule cmdlet. +The command passes that job schedule to the current cmdlet by using the pipeline operator. +The command deletes that job schedule. +Because the command includes the *Force* parameter, it does not prompt you for confirmation. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the job schedule to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchJobSchedule](./Disable-AzBatchJobSchedule.md) + +[Enable-AzBatchJobSchedule](./Enable-AzBatchJobSchedule.md) + +[Get-AzBatchJobSchedule](./Get-AzBatchJobSchedule.md) + +[New-AzBatchJobSchedule](./New-AzBatchJobSchedule.md) + +[Set-AzBatchJobSchedule](./Set-AzBatchJobSchedule.md) + +[Stop-AzBatchJobSchedule](./Stop-AzBatchJobSchedule.md) + + diff --git a/azps-10.1.0/Az.Batch/Remove-AzBatchNodeFile.md b/azps-10.1.0/Az.Batch/Remove-AzBatchNodeFile.md new file mode 100644 index 0000000000..94cea11b0d --- /dev/null +++ b/azps-10.1.0/Az.Batch/Remove-AzBatchNodeFile.md @@ -0,0 +1,281 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: DBA02017-8372-4A91-A4F1-985777DEDAB9 +online version: https://learn.microsoft.com/powershell/module/az.batch/remove-azbatchnodefile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchNodeFile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchNodeFile.md +--- + +# Remove-AzBatchNodeFile + +## SYNOPSIS +Deletes a node file for a task or compute node. + +## SYNTAX + +### Task +``` +Remove-AzBatchNodeFile -JobId -TaskId -Path [-Force] [-Recursive] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### ComputeNode +``` +Remove-AzBatchNodeFile [-PoolId] [-ComputeNodeId] -Path [-Force] [-Recursive] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### InputObject +``` +Remove-AzBatchNodeFile [[-InputObject] ] [-Force] [-Recursive] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzBatchNodeFile** cmdlet deletes an Azure Batch node file for a task or compute node. + +## EXAMPLES + +### Example 1: Delete a file associated with a task +```powershell +Remove-AzBatchNodeFile -JobId "Job-000001" -TaskId "Task26" -Path "wd\testFile.txt" -BatchContext $Context +``` + +This command deletes the node file that is named wd\testFile.txt. +That file is associated with the task that has the ID Task26 under the job Job-000001. + +### Example 2: Delete a file from a compute node +```powershell +Remove-AzBatchNodeFile -PoolId "Pool07" -ComputeNodeId "tvm-2316545714_1-20150725t213220z" -Path "startup\testFile.txt" -BatchContext $Context +``` + +This command deletes the node file that is named startup\testFile.txt from the specified compute node in the pool that has the ID Pool07. + +### Example 3: Remove a file by using the pipeline +```powershell +Get-AzBatchNodeFile -JobId "Job-000001" -TaskId "Task26" -Path "wd\testFile2.txt" -BatchContext $Context | Remove-AzBatchNodeFile -Force -BatchContext $Context +``` + +This command gets the node file by using **Get-AzBatchNodeFile**. +That file is associated with the task that has the ID Task26 under the job Job-000001. +The command passes that file to the current cmdlet by using the pipeline. +The current cmdlet removes the node file. +The command specifies the *Force* parameter. +Therefore, the command does not prompt you for confirmation. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNodeId +Specifies the ID of the compute node that contains the Batch node file that this cmdlet deletes. + +```yaml +Type: System.String +Parameter Sets: ComputeNode +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies **PSNodeFile** object that represent the node file that this cmdlet deletes. +To obtain a **PSNodeFile**, use the Get-AzBatchNodeFile cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSNodeFile +Parameter Sets: InputObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of the job that contains the task. + +```yaml +Type: System.String +Parameter Sets: Task +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +The file path of the node file to delete. + +```yaml +Type: System.String +Parameter Sets: Task, ComputeNode +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the pool that contains the compute nodes for which this cmdlet removes a file. + +```yaml +Type: System.String +Parameter Sets: ComputeNode +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Recursive +Indicates that this cmdlet deletes the folder and all subfolders and files under the specified path. +This cmdlet is relevant only if the path is a folder. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TaskId +Specifies the ID of the task. + +```yaml +Type: System.String +Parameter Sets: Task +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSNodeFile + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchNodeFile](./Get-AzBatchNodeFile.md) + +[Get-AzBatchNodeFileContent](./Get-AzBatchNodeFileContent.md) + + diff --git a/azps-10.1.0/Az.Batch/Remove-AzBatchPool.md b/azps-10.1.0/Az.Batch/Remove-AzBatchPool.md new file mode 100644 index 0000000000..8a995ac63c --- /dev/null +++ b/azps-10.1.0/Az.Batch/Remove-AzBatchPool.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: DB0A8E4B-AD3F-4BAC-A0B2-031913E019D4 +online version: https://learn.microsoft.com/powershell/module/az.batch/remove-azbatchpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchPool.md +--- + +# Remove-AzBatchPool + +## SYNOPSIS +Deletes the specified Batch pool. + +## SYNTAX + +``` +Remove-AzBatchPool [-Id] [-Force] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzBatchPool** cmdlet deletes the specified Azure Batch pool. +You are prompted for confirmation unless you use the *Force* parameter. + +## EXAMPLES + +### Example 1: Delete a Batch pool by pool ID +```powershell +Remove-AzBatchPool -Id "MyPool" -BatchContext $Context +``` + +This command deletes the pool with ID MyPool. +The user is prompted for confirmation before the delete operation takes place. + +### Example 2: Delete all Batch pools by force +```powershell +Get-AzBatchPool -BatchContext $Context | Remove-AzBatchPool -Force -BatchContext $Context +``` + +This command deletes all Batch pools. +Because the *Force* parameter is present, the confirmation prompt is suppressed. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the pool to delete. +You cannot specify wildcard characters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchPool](./Get-AzBatchPool.md) + +[New-AzBatchPool](./New-AzBatchPool.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Remove-AzBatchTask.md b/azps-10.1.0/Az.Batch/Remove-AzBatchTask.md new file mode 100644 index 0000000000..6c54dde47e --- /dev/null +++ b/azps-10.1.0/Az.Batch/Remove-AzBatchTask.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: D79AEF8C-F0DC-40F8-9EEE-A2BB6AE5C4BF +online version: https://learn.microsoft.com/powershell/module/az.batch/remove-azbatchtask +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchTask.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Remove-AzBatchTask.md +--- + +# Remove-AzBatchTask + +## SYNOPSIS +Deletes a Batch task. + +## SYNTAX + +### Id +``` +Remove-AzBatchTask [-JobId] [-Id] [-Force] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### InputObject +``` +Remove-AzBatchTask [-InputObject] [-Force] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-AzBatchTask** cmdlet deletes an Azure Batch task. +This cmdlet prompts you for confirmation, unless you specify the *Force* parameter. + +## EXAMPLES + +### Example 1: Delete a Batch task by ID +```powershell +Remove-AzBatchTask -JobId "Job-000001" -Id "Task23" -BatchContext $Context +``` + +This command deletes a task that has the ID Task23 under the job that has the ID Job-000001. +The command prompts you for confirmation. +Use the **Get-AzBatchAccountKey** cmdlet to assign a context to the $Context variable. + +### Example 2: Delete a Batch task by using the pipeline without confirmation +```powershell +Get-AzBatchTask -JobId "Job-000001" -Id "Task26" -BatchContext $Context | Remove-AzBatchTask -Force -BatchContext $Context +``` + +This command gets the Batch task that has the ID Task26 in the job that has the ID Job-000001 by using the **Get-AzBatchTask** cmdlet. +The command passes that task to the current cmdlet by using the pipeline operator. +The command deletes that task. +This command specifies the *Force* parameter. +Therefore, the command does not prompt you for confirmation. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the task that this cmdlet deletes. +You cannot specify wildcard characters. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Specifies the task that this cmdlet deletes. +To obtain a **PSCloudTask** object, use the Get-AzBatchTask cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of the job that contains the task. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSCloudTask + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchTask](./Get-AzBatchTask.md) + +[New-AzBatchTask](./New-AzBatchTask.md) + +[Remove-AzBatchTask](./Remove-AzBatchTask.md) + +[Stop-AzBatchTask](./Stop-AzBatchTask.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Reset-AzBatchComputeNode.md b/azps-10.1.0/Az.Batch/Reset-AzBatchComputeNode.md new file mode 100644 index 0000000000..ff4e783697 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Reset-AzBatchComputeNode.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: A202537B-D292-4822-A0B9-27A6A20621D4 +online version: https://learn.microsoft.com/powershell/module/az.batch/reset-azbatchcomputenode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Reset-AzBatchComputeNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Reset-AzBatchComputeNode.md +--- + +# Reset-AzBatchComputeNode + +## SYNOPSIS +Reinstalls the operating system on the specified compute node. + +## SYNTAX + +### Id (Default) +``` +Reset-AzBatchComputeNode [-PoolId] [-Id] [-ReimageOption ] + -BatchContext [-DefaultProfile ] [] +``` + +### InputObject +``` +Reset-AzBatchComputeNode [[-ComputeNode] ] [-ReimageOption ] + -BatchContext [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Reset-AzBatchComputeNode** cmdlet reinstalls the operating system on the specified compute node. + +## EXAMPLES + +### Example 1: Reimage a node +```powershell +Reset-AzBatchComputeNode -PoolId "MyPool" -Id "tvm-3257026573_2-20150813t200938z" -BatchContext $Context +``` + +This command reimages the compute node with ID "tvm-3257026573_2-20150813t200938z" in the pool named MyPool. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Reimage all nodes in a pool +```powershell +Get-AzBatchComputeNode -PoolId "MyPool" -BatchContext $Context | Reset-AzBatchComputeNode -BatchContext $Context +``` + +This command reimages every compute node in the pool named MyPool. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNode +Specifies the **PSComputeNode** object that represents the compute node to reimage. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode +Parameter Sets: InputObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the compute node to reimage. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the pool that contains the compute node. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReimageOption +Specifies when to reimage the node and what to do with currently running tasks. +The default is Requeue. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Batch.Common.ComputeNodeReimageOption] +Parameter Sets: (All) +Aliases: +Accepted values: Requeue, Terminate, TaskCompletion, RetainedData + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSComputeNode + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchComputeNode](./Get-AzBatchComputeNode.md) + +[Restart-AzBatchComputeNode](./Restart-AzBatchComputeNode.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Restart-AzBatchComputeNode.md b/azps-10.1.0/Az.Batch/Restart-AzBatchComputeNode.md new file mode 100644 index 0000000000..1701b6f56c --- /dev/null +++ b/azps-10.1.0/Az.Batch/Restart-AzBatchComputeNode.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 029361F0-C4E9-4948-9EBA-BFBD1B029909 +online version: https://learn.microsoft.com/powershell/module/az.batch/restart-azbatchcomputenode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Restart-AzBatchComputeNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Restart-AzBatchComputeNode.md +--- + +# Restart-AzBatchComputeNode + +## SYNOPSIS +Reboots the specified compute node. + +## SYNTAX + +### Id (Default) +``` +Restart-AzBatchComputeNode [-PoolId] [-Id] [[-RebootOption] ] + -BatchContext [-DefaultProfile ] [] +``` + +### InputObject +``` +Restart-AzBatchComputeNode [[-ComputeNode] ] [[-RebootOption] ] + -BatchContext [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Restart-AzBatchComputeNode** cmdlet reboots the specified compute node. + +## EXAMPLES + +### Example 1: Restart a compute node +```powershell +Restart-AzBatchComputeNode -PoolId "MyPool" -Id "tvm-3257026573_2-20150813t200938z" -BatchContext $Context +``` + +This command reboots the compute node with the ID "tvm-3257026573_2-20150813t200938z" in the pool MyPool. + +### Example 2: Restart every compute node in a pool +```powershell +Get-AzBatchComputeNode -PoolId "MyPool" -BatchContext $Context | Restart-AzBatchComputeNode -BatchContext $Context +``` + +This command reboots every compute node in the pool MyPool. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNode +Specifies the **PSComputeNode** object that represents the compute node to reboot. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode +Parameter Sets: InputObject +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the compute node to reboot. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the pool that contains the compute node. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RebootOption +Specifies when to reboot the node and what to do with currently running tasks. +The default is Requeue. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Batch.Common.ComputeNodeRebootOption] +Parameter Sets: (All) +Aliases: +Accepted values: Requeue, Terminate, TaskCompletion, RetainedData + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSComputeNode + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchComputeNode](./Get-AzBatchComputeNode.md) + +[Reset-AzBatchComputeNode](./Reset-AzBatchComputeNode.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Set-AzBatchAccount.md b/azps-10.1.0/Az.Batch/Set-AzBatchAccount.md new file mode 100644 index 0000000000..21437e4699 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Set-AzBatchAccount.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 9BEE5888-304D-4438-BE97-D1FE254AEE98 +online version: https://learn.microsoft.com/powershell/module/az.batch/set-azbatchaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchAccount.md +--- + +# Set-AzBatchAccount + +## SYNOPSIS +Updates a Batch account. + +## SYNTAX + +``` +Set-AzBatchAccount [-AccountName] [-Tag] [-ResourceGroupName ] + [-AutoStorageAccountId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzBatchAccount** cmdlet updates an Azure Batch account. +Currently, this cmdlet can update only tags. + +## EXAMPLES + +### Example 1: Update the tags on a Batch account +```powershell +Set-AzBatchAccount -AccountName "cmdletexample" -Tag @{key0="value0";key1=$null;key2="value2"} +``` + +```output +AccountName : cmdletexample +Location : westus +ResourceGroupName : CmdletExampleRG +DedicatedCoreQuota : 20 +LowPriorityCoreQuota : 20 +PoolQuota : 20 +ActiveJobAndJobScheduleQuota : 20 +Tags : + Name Value + ==== ====== + key0 value0 + key1 + key2 value2 +TaskTenantUrl : https://cmdletexample.westus.batch.azure.com +``` + +This command updates the tags on the account named pfuller. + +## PARAMETERS + +### -AccountName +Specifies the name of the Batch account that this cmdlet updates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutoStorageAccountId +Specifies the resource ID of the storage account to be used for auto storage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group of the account that this cmdlet updates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccount](./Get-AzBatchAccount.md) + +[New-AzBatchAccount](./New-AzBatchAccount.md) + +[Remove-AzBatchAccount](./Remove-AzBatchAccount.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Set-AzBatchApplication.md b/azps-10.1.0/Az.Batch/Set-AzBatchApplication.md new file mode 100644 index 0000000000..bb779ff208 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Set-AzBatchApplication.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: DCA1FD7A-54AF-48B1-A245-BFA9C43ACA9B +online version: https://learn.microsoft.com/powershell/module/az.batch/set-azbatchapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchApplication.md +--- + +# Set-AzBatchApplication + +## SYNOPSIS +Updates settings for the specified application. + +## SYNTAX + +``` +Set-AzBatchApplication [-AccountName] [-ResourceGroupName] [-ApplicationName] + [[-DisplayName] ] [[-DefaultVersion] ] [[-AllowUpdates] ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzBatchApplication** cmdlet modifies settings for the specified Azure Batch application. + +## EXAMPLES + +### Example 1: Update an application in a Batch account +```powershell +Set-AzBatchApplication -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationName "Litware" -AllowUpdates $False +``` + +This command changes whether the Litware application in the ContosoBatch account allows updates. +The command does not change the default version or display name of the application. + +### Example 2 + +Updates settings for the specified application. (autogenerated) + + + + +```powershell +Set-AzBatchApplication -AccountName 'ContosoBatch' -ApplicationName 'Litware' -DefaultVersion -ResourceGroupName 'ContosoBatchGroup' +``` + +## PARAMETERS + +### -AccountName +Specifies the name of the Batch account for which this cmdlet modifies an application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AllowUpdates +Specifies whether packages within the application can be overwritten using the same version string. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationName +Specifies the name of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultVersion +Specifies which package to use if a client requests the application but does not specify a version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +Specifies the display name for the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Batch account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchApplication](./Get-AzBatchApplication.md) + +[Get-AzBatchApplicationPackage](./Get-AzBatchApplicationPackage.md) + +[New-AzBatchApplication](./New-AzBatchApplication.md) + +[New-AzBatchApplicationPackage](./New-AzBatchApplicationPackage.md) + +[Remove-AzBatchApplication](./Remove-AzBatchApplication.md) + +[Remove-AzBatchApplicationPackage](./Remove-AzBatchApplicationPackage.md) + + diff --git a/azps-10.1.0/Az.Batch/Set-AzBatchComputeNodeUser.md b/azps-10.1.0/Az.Batch/Set-AzBatchComputeNodeUser.md new file mode 100644 index 0000000000..be9f06b0ec --- /dev/null +++ b/azps-10.1.0/Az.Batch/Set-AzBatchComputeNodeUser.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: A0D620DA-B5A3-4F8F-BD43-A58630C95432 +online version: https://learn.microsoft.com/powershell/module/az.batch/set-azbatchcomputenodeuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchComputeNodeUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchComputeNodeUser.md +--- + +# Set-AzBatchComputeNodeUser + +## SYNOPSIS +Modifies properties of an account on a Batch compute node. + +## SYNTAX + +``` +Set-AzBatchComputeNodeUser [-PoolId] [-ComputeNodeId] [-Name] + [-Password] [-ExpiryTime ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzBatchComputeNodeUser** cmdlet modifies properties of a user account on an Azure Batch compute node. + +## EXAMPLES + +### Example 1: Update a user account +```powershell +Set-AzBatchComputeNodeUser -PoolId "ContosoPool" -ComputeNodeId "tvm-3257026573_1-20150904t230807z" -Name "PFuller" -BatchContext $Context -Password "Password" -ExpiryTime ([DateTime]::Now.AddDays(14)) +``` + +This command modifies user account named PFuller on the compute node that has the specified ID in the pool named ContosoPool. +The command changes the account password and expiry time. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNodeId +Specifies the ID of the compute node on which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the expiry time for the user account. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the user account that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Specifies the password for the user account. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +Specifies the ID of the pool that contains the compute node on which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[New-AzBatchComputeNodeUser](./New-AzBatchComputeNodeUser.md) + +[Remove-AzBatchComputeNodeUser](./Remove-AzBatchComputeNodeUser.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Set-AzBatchJob.md b/azps-10.1.0/Az.Batch/Set-AzBatchJob.md new file mode 100644 index 0000000000..b479ad096c --- /dev/null +++ b/azps-10.1.0/Az.Batch/Set-AzBatchJob.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 75483BC7-440A-437B-9EDE-D270D87CF3C5 +online version: https://learn.microsoft.com/powershell/module/az.batch/set-azbatchjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchJob.md +--- + +# Set-AzBatchJob + +## SYNOPSIS +Updates a Batch job. + +## SYNTAX + +``` +Set-AzBatchJob [-Job] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzBatchJob** cmdlet updates an Azure Batch job. +Use the Get-AzBatchJob cmdlet to get a **PSCloudJob** object. +Modify the properties of that object, and then use the current cmdlet to commit your changes to the Batch service. + +## EXAMPLES + +### Example 1: Update a job +```powershell +$Job = Get-AzBatchJob -Id "Job17" -BatchContext $Context +$Job.Priority = 1 +Set-AzBatchJob -Job $Job -BatchContext $Context +``` + +The first command gets a job by using **Get-AzBatchJob**, and then stores it in the $Job variable. +The second command modifies the priority specification on the $Job object. +The final command updates the Batch service to match the local object in $Job. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Job +Specifies a **PSCloudJob** to which this cmdlet updates the Batch service. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJob +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSCloudJob + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchJob](./Disable-AzBatchJob.md) + +[Enable-AzBatchJob](./Enable-AzBatchJob.md) + +[Get-AzBatchJob](./Get-AzBatchJob.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[New-AzBatchJob](./New-AzBatchJob.md) + +[Remove-AzBatchJob](./Remove-AzBatchJob.md) + +[Stop-AzBatchJob](./Stop-AzBatchJob.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Set-AzBatchJobSchedule.md b/azps-10.1.0/Az.Batch/Set-AzBatchJobSchedule.md new file mode 100644 index 0000000000..46f3b55fc5 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Set-AzBatchJobSchedule.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 14026F0E-4959-4150-A31F-A94BC56ED808 +online version: https://learn.microsoft.com/powershell/module/az.batch/set-azbatchjobschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchJobSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchJobSchedule.md +--- + +# Set-AzBatchJobSchedule + +## SYNOPSIS +Sets a job schedule. + +## SYNTAX + +``` +Set-AzBatchJobSchedule [-JobSchedule] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzBatchJobSchedule** cmdlet sets a job schedule in the Azure Batch service. + +## EXAMPLES + +### Example 1: Update a job schedule +```powershell +$JobSchedule = Get-AzBatchJobSchedule -Id "MyJobSchedule" -BatchContext $Context +$JobSchedule.Schedule.RecurrenceInterval = New-TimeSpan -Days 2 +Set-AzBatchJobSchedule -JobSchedule $Job -BatchContext $Context +``` + +The first command gets a job by using **Get-AzBatchJobSchedule**, and then stores it in the $JobSchedule variable. +The second command modifies the recurrence interval on the `$JobSchedule.Schedule` object. +The final command updates the Batch service to match the local object in $JobSchedule. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobSchedule +Specifies a **PSCloudJobSchedule** object that represents a job schedule. +To obtain a **PSCloudJobSchedule** object, use the Get-AzBatchJobSchedule cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJobSchedule +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSCloudJobSchedule + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchJobSchedule](./Disable-AzBatchJobSchedule.md) + +[Enable-AzBatchJobSchedule](./Enable-AzBatchJobSchedule.md) + +[Get-AzBatchJobSchedule](./Get-AzBatchJobSchedule.md) + +[New-AzBatchJobSchedule](./New-AzBatchJobSchedule.md) + +[Remove-AzBatchJobSchedule](./Remove-AzBatchJobSchedule.md) + +[Stop-AzBatchJobSchedule](./Stop-AzBatchJobSchedule.md) + + diff --git a/azps-10.1.0/Az.Batch/Set-AzBatchPool.md b/azps-10.1.0/Az.Batch/Set-AzBatchPool.md new file mode 100644 index 0000000000..186bd43767 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Set-AzBatchPool.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 23893EAE-47F3-45AA-AEB2-354FB8316C25 +online version: https://learn.microsoft.com/powershell/module/az.batch/set-azbatchpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchPool.md +--- + +# Set-AzBatchPool + +## SYNOPSIS +Updates the properties of a pool. + +## SYNTAX + +``` +Set-AzBatchPool [-Pool] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzBatchPool** cmdlet updates the properties of a pool in the Azure Batch service. +Use the Get-AzBatchPool cmdlet to get a **PSCloudPool** object. +Modify the properties of that object, and then use the current cmdlet to commit your changes to the Batch service. + +## EXAMPLES + +### Example 1: Update a pool +```powershell +$Pool = Get-AzBatchPool "ContosoPool" -BatchContext $Context +$StartTask = New-Object Microsoft.Azure.Commands.Batch.Models.PSStartTask +$StartTask.CommandLine = "cmd /c echo example" +$Pool.StartTask = $StartTask +Set-AzBatchPool -Pool $Pool -BatchContext $Context +``` + +The first command gets a pool by using **Get-AzBatchPool**, and then stores it in the $Pool variable. +The next three commands modify the start task specification on the $Pool object. +The final command updates the Batch service to match the local object in $Pool. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pool +Specifies the **PSCloudPool** to which this cmdlet updates the Batch service. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudPool +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSCloudPool + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchPool](./Get-AzBatchPool.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[New-AzBatchPool](./New-AzBatchPool.md) + +[Remove-AzBatchPool](./Remove-AzBatchPool.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Set-AzBatchTask.md b/azps-10.1.0/Az.Batch/Set-AzBatchTask.md new file mode 100644 index 0000000000..4edb0eed01 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Set-AzBatchTask.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 6A6D6C7D-EED7-4AD4-ACE6-BFA64404455E +online version: https://learn.microsoft.com/powershell/module/az.batch/set-azbatchtask +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchTask.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Set-AzBatchTask.md +--- + +# Set-AzBatchTask + +## SYNOPSIS +Updates the properties of a task. + +## SYNTAX + +``` +Set-AzBatchTask [-Task] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Set-AzBatchTask** cmdlet updates the properties of a task in the Azure Batch service. +Use the Get-AzBatchTask cmdlet to get a **PSCloudTask** object. +Modify the properties of that object, and then use the current cmdlet to commit your changes to the Batch service. + +## EXAMPLES + +### Example 1: Update a task +```powershell +$Task = Get-AzBatchTask -JobId "Job16" -Id "Task22" -BatchContext $Context +$Constraints = New-Object Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints -ArgumentList @([TimeSpan]::FromDays(5), [TimeSpan]::FromDays(2), 3) +$Task.Constraints = $Constraints +Set-AzBatchTask -Task $Task -BatchContext $Context +``` + +The first command gets a task by using **Get-AzBatchTask**, and then stores it in the $Task variable. +The next two commands modify the constraints of the task in $Task. +The final command updates the Batch service to match the local object in $Task. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Task +Specifies the **PSCloudTask** to which this cmdlet updates the Batch service. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSCloudTask + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchTask](./Get-AzBatchTask.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[New-AzBatchTask](./New-AzBatchTask.md) + +[Remove-AzBatchTask](./Remove-AzBatchTask.md) + +[Stop-AzBatchTask](./Stop-AzBatchTask.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Start-AzBatchComputeNodeServiceLogUpload.md b/azps-10.1.0/Az.Batch/Start-AzBatchComputeNodeServiceLogUpload.md new file mode 100644 index 0000000000..09b58455cc --- /dev/null +++ b/azps-10.1.0/Az.Batch/Start-AzBatchComputeNodeServiceLogUpload.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +online version: https://learn.microsoft.com/powershell/module/az.batch/Start-AzBatchComputeNodeServiceLogUpload +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Start-AzBatchComputeNodeServiceLogUpload.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Start-AzBatchComputeNodeServiceLogUpload.md +--- + +# Start-AzBatchComputeNodeServiceLogUpload + +## SYNOPSIS +Upload compute node service log files to an Azure Storage container. + +## SYNTAX + +### AzureBatchComputeNodeServiceLogUpload (Default) +``` +Start-AzBatchComputeNodeServiceLogUpload [-ContainerUrl] [-StartTime] [-EndTime ] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### Id +``` +Start-AzBatchComputeNodeServiceLogUpload [-PoolId] [-ComputeNodeId] [-ContainerUrl] + [-StartTime] [-EndTime ] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ParentObject +``` +Start-AzBatchComputeNodeServiceLogUpload [-ComputeNode] [-ContainerUrl] + [-StartTime] [-EndTime ] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet gathers Azure Batch service log files from compute nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service. + +## EXAMPLES + +### Example 1 +```powershell +$storageContext = New-AzStorageContext -StorageAccountName "contosogeneral" -StorageAccountKey "" +$sasToken = New-AzStorageContainerSASToken -Name "contosocontainer" -Context $storageContext +$containerUrl = "https://contosogeneral.blob.core.windows.net/contosocontainer" + $sasToken +$batchContext = Get-AzBatchAccountKey -AccountName "contosobatch" +Start-AzBatchComputeNodeServiceLogUpload -BatchContext $batchContext -PoolId "contosopool" -ComputeNodeId "tvm-1612030122_1-20180405t234700z" -ContainerUrl $containerUrl -StartTime "2018-01-01 00:00:00Z" +``` + +```output +NumberOfFilesUploaded VirtualDirectoryName +--------------------- -------------------- + 4 contosobatch-22F48D278AD60CC2/contosopool/tvm-1612030122_1-20180405t234700z/bc3dd583-19a5-4665-aa83-87e4e1237d35 +``` + +Upload compute node service logs written on or after January 1, 2018 midnight, which were obtained from the compute node, given pool id of the pool in which the compute node resides, and compute node id. + +### Example 2 +```powershell +$storageContext = New-AzStorageContext -StorageAccountName "contosogeneral" -StorageAccountKey "" +$sasToken = New-AzStorageContainerSASToken -Name "contosocontainer" -Context $storageContext +$containerUrl = "https://contosogeneral.blob.core.windows.net/contosocontainer" + $sasToken +$batchContext = Get-AzBatchAccountKey -AccountName "contosobatch" +Start-AzBatchComputeNodeServiceLogUpload -BatchContext $batchContext -PoolId "contosopool" -ComputeNodeId "tvm-1612030122_1-20180405t234700z" -ContainerUrl $containerUrl -StartTime "2018-01-01 00:00:00Z" -EndTime "2018-01-10 00:00:00Z" +``` + +```output +NumberOfFilesUploaded VirtualDirectoryName +--------------------- -------------------- + 2 contosobatch-22F48D278AD60CC2/contosopool/tvm-1612030122_1-20180405t234700z/bc3dd583-19a5-4665-aa83-87e4e1237d35 +``` + +Upload compute node service logs written on or after January 1, 2018 midnight and before January 10, 2018 midnight, which were obtained from the compute node, given pool id of the pool in which the compute node resides, and compute node id. + +### Example 3 +```powershell +$storageContext = New-AzStorageContext -StorageAccountName "contosogeneral" -StorageAccountKey "" +$sasToken = New-AzStorageContainerSASToken -Name "contosocontainer" -Context $storageContext +$containerUrl = "https://contosogeneral.blob.core.windows.net/contosocontainer" + $sasToken +$batchContext = Get-AzBatchAccountKey -AccountName "contosobatch" +Get-AzBatchComputeNode -BatchContext $batchContext -Id "tvm-1612030122_1-20180405t234700z" -PoolId "contosopool" | Start-AzBatchComputeNodeServiceLogUpload -BatchContext $batchContext -ContainerUrl $containerUrl -StartTime "2018-01-01 00:00:00Z" -EndTime "2018-01-10 00:00:00Z" +``` + +```output +NumberOfFilesUploaded VirtualDirectoryName +--------------------- -------------------- + 2 contosobatch-22F48D278AD60CC2/contosopool/tvm-1612030122_1-20180405t234700z/bc3dd583-19a5-4665-aa83-87e4e1237d35 +``` + +Upload compute node service logs written on or after January 1, 2018 midnight and before January 10, 2018 midnight, which were obtained from the compute node object. + +## PARAMETERS + +### -BatchContext +The BatchAccountContext instance to use when interacting with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. +To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. +When using shared key authentication, the primary access key is used by default. +To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNode +Specifies the **PSComputeNode** object from which service logs are retrieved. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode +Parameter Sets: ParentObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNodeId +The id of the compute node. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerUrl +The container url to Azure Storage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +The end time of service log to be uploaded (optional). + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +The id of the pool that contains the compute node. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +The start time of service log to be uploaded. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSComputeNode + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSStartComputeNodeServiceLogUploadResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Batch/Start-AzBatchPoolResize.md b/azps-10.1.0/Az.Batch/Start-AzBatchPoolResize.md new file mode 100644 index 0000000000..037fa3e356 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Start-AzBatchPoolResize.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 82DC8DC4-D8EC-4847-A54C-B779256FD590 +online version: https://learn.microsoft.com/powershell/module/az.batch/start-azbatchpoolresize +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Start-AzBatchPoolResize.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Start-AzBatchPoolResize.md +--- + +# Start-AzBatchPoolResize + +## SYNOPSIS +Starts to resize a pool. + +## SYNTAX + +``` +Start-AzBatchPoolResize [-Id] [-TargetDedicatedComputeNodes ] + [-TargetLowPriorityComputeNodes ] [-ResizeTimeout ] + [-ComputeNodeDeallocationOption ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Start-AzBatchPoolResize** cmdlet starts an Azure Batch resize operation on a pool. + +## EXAMPLES + +### Example 1: Resize a pool to 12 nodes +```powershell +Start-AzBatchPoolResize -Id "ContosoPool06" -TargetDedicatedComputeNodes 12 -BatchContext $Context +``` + +This command starts a resize operation on the pool that has the ID ContosoPool06. +The target for the operation is 12 dedicated compute nodes. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Resize a pool using a deallocation option +```powershell +Get-AzBatchPool -Id "ContosoPool06" -BatchContext $Context | Start-AzBatchPoolResize -TargetDedicatedComputeNodes 5 -ResizeTimeout ([TimeSpan]::FromHours(1)) -ComputeNodeDeallocationOption ([Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption]::Terminate) -BatchContext $Context +``` + +This cmdlet resizes a pool to five dedicated compute nodes. +The command gets the pool that has the ID ContosoPool06 by using the Get-AzBatchPool cmdlet. +The command passes that pool object to the current cmdlet by using the pipeline operator. +The command starts a resize operation on the pool. +The target is five dedicated compute nodes. +The command specifies time-out period of one hour. +The command specifies a deallocation option of Terminate. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNodeDeallocationOption +Specifies a deallocation option for the resizing operation that this cmdlet starts. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption] +Parameter Sets: (All) +Aliases: +Accepted values: Requeue, Terminate, TaskCompletion, RetainedData + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the pool that this cmdlet resizes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ResizeTimeout +Specifies a time-out period for the resizing operation. +If the pool does not reach the target size by this time, the resize operation stops. + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDedicatedComputeNodes +The number of target dedicated compute nodes. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: TargetDedicated + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetLowPriorityComputeNodes +The number of target low-priority compute nodes. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchPool](./Get-AzBatchPool.md) + +[Stop-AzBatchPoolResize](./Stop-AzBatchPoolResize.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Stop-AzBatchCertificateDeletion.md b/azps-10.1.0/Az.Batch/Stop-AzBatchCertificateDeletion.md new file mode 100644 index 0000000000..5b2cac3256 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Stop-AzBatchCertificateDeletion.md @@ -0,0 +1,122 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: B3C8A2DB-6571-418D-8C4B-3BE3FDA42F89 +online version: https://learn.microsoft.com/powershell/module/az.batch/stop-azbatchcertificatedeletion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Stop-AzBatchCertificateDeletion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Stop-AzBatchCertificateDeletion.md +--- + +# Stop-AzBatchCertificateDeletion + +## SYNOPSIS +Cancels a failed deletion of a certificate. + +## SYNTAX + +``` +Stop-AzBatchCertificateDeletion [-ThumbprintAlgorithm] [-Thumbprint] + -BatchContext [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Stop-AzBatchCertificateDeletion** cmdlet cancels a failed deletion of a certificate in the Azure Batch service. +You can stop a deletion only if the certificate is in the **DeleteFailed** state. +This cmdlet restores the certificate to the **Active** state. + +## EXAMPLES + +### Example 1: Cancel a deletion +```powershell +Stop-AzBatchCertificateDeletion -ThumbprintAlgorithm "sha1" -Thumbprint "c1e494a415149c5f211c4778b52f2e834a07247c" -BatchContext $Context +``` + +This command cancels the deletion of the certificate that has the specified thumbprint. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Thumbprint +Specifies the thumbprint of the certificate that this cmdlet restores to the **Active** state. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ThumbprintAlgorithm +Specifies the algorithm used to derive the *Thumbprint* parameter. +Currently, the only valid value is sha1. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Remove-AzBatchCertificate](./Remove-AzBatchCertificate.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Stop-AzBatchJob.md b/azps-10.1.0/Az.Batch/Stop-AzBatchJob.md new file mode 100644 index 0000000000..8ed6799190 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Stop-AzBatchJob.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 975B707C-5001-43ED-81AB-9BB6665135BA +online version: https://learn.microsoft.com/powershell/module/az.batch/stop-azbatchjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Stop-AzBatchJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Stop-AzBatchJob.md +--- + +# Stop-AzBatchJob + +## SYNOPSIS +Stops a Batch job. + +## SYNTAX + +``` +Stop-AzBatchJob [-Id] [[-TerminateReason] ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Stop-AzBatchJob** cmdlet stops an Azure Batch job. +This command marks the job as completed. + +## EXAMPLES + +### Example 1: Stop a Batch job +```powershell +Stop-AzBatchJob -Id "Job-000001" -TerminateReason "No more tasks to run" -BatchContext $Context +``` + +This command stops the job that has the ID Job-000001. +The command specifies a reason that you chose to stop the job. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the job that this cmdlet stops. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -TerminateReason +Specifies the reason that you decided to stop the job. +This cmdlet stores this text as the **TerminateReason** property of the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchJob](./Disable-AzBatchJob.md) + +[Enable-AzBatchJob](./Enable-AzBatchJob.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchJob](./Get-AzBatchJob.md) + +[New-AzBatchJob](./New-AzBatchJob.md) + +[Remove-AzBatchJob](./Remove-AzBatchJob.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Stop-AzBatchJobSchedule.md b/azps-10.1.0/Az.Batch/Stop-AzBatchJobSchedule.md new file mode 100644 index 0000000000..3442da44ca --- /dev/null +++ b/azps-10.1.0/Az.Batch/Stop-AzBatchJobSchedule.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: D1C5B35C-5419-4739-9D57-6C4228E98DAC +online version: https://learn.microsoft.com/powershell/module/az.batch/stop-azbatchjobschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Stop-AzBatchJobSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Stop-AzBatchJobSchedule.md +--- + +# Stop-AzBatchJobSchedule + +## SYNOPSIS +Stops a Batch job schedule. + +## SYNTAX + +``` +Stop-AzBatchJobSchedule [-Id] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Stop-AzBatchJobSchedule** cmdlet stops an Azure Batch job schedule. + +## EXAMPLES + +### Example 1: Stop a job schedule +```powershell +Stop-AzBatchJobSchedule -Id "JobSchedule17" -BatchContext $Context +``` + +This command stops the job schedule that has the ID JobSchedule17. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the job schedule that this cmdlet stops. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchJobSchedule](./Disable-AzBatchJobSchedule.md) + +[Enable-AzBatchJobSchedule](./Enable-AzBatchJobSchedule.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchJobSchedule](./Get-AzBatchJobSchedule.md) + +[New-AzBatchJobSchedule](./New-AzBatchJobSchedule.md) + +[Remove-AzBatchJobSchedule](./Remove-AzBatchJobSchedule.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Stop-AzBatchPoolResize.md b/azps-10.1.0/Az.Batch/Stop-AzBatchPoolResize.md new file mode 100644 index 0000000000..aa8dae3560 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Stop-AzBatchPoolResize.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 3E736E85-0488-4D10-BEA1-4F9B8DA54C4B +online version: https://learn.microsoft.com/powershell/module/az.batch/stop-azbatchpoolresize +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Stop-AzBatchPoolResize.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Stop-AzBatchPoolResize.md +--- + +# Stop-AzBatchPoolResize + +## SYNOPSIS +Stops a pool resize operation. + +## SYNTAX + +``` +Stop-AzBatchPoolResize [-Id] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Stop-AzBatchPoolResize** cmdlet stops an Azure Batch resize operation on a pool. + +## EXAMPLES + +### Example 1: Stop resizing a pool +```powershell +Stop-AzBatchPoolResize -Id "ContosoPool06" -BatchContext $Context +``` + +This command stops a resize operation on the pool that has the ID ContosoPool06. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Stop resizing a pool by using the pipeline +```powershell +Get-AzBatchPool -Id "ContosoPool06" -BatchContext $Context | Stop-AzBatchPoolResize -BatchContext $Context +``` + +This command stops resizing a pool by using the pipeline operator. +The command gets the pool that has the ID ContosoPool06 by using the Get-AzBatchPool cmdlet. +The command passes that pool object to the current cmdlet. +The command stops the resize operation on that pool. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the pool for which this cmdlet stops a resizing operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Get-AzBatchPool](./Get-AzBatchPool.md) + +[Start-AzBatchPoolResize](./Start-AzBatchPoolResize.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Stop-AzBatchTask.md b/azps-10.1.0/Az.Batch/Stop-AzBatchTask.md new file mode 100644 index 0000000000..5df0b297ac --- /dev/null +++ b/azps-10.1.0/Az.Batch/Stop-AzBatchTask.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: 1EA57372-6FA5-45C9-94A1-50D53830FC10 +online version: https://learn.microsoft.com/powershell/module/az.batch/stop-azbatchtask +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Stop-AzBatchTask.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Stop-AzBatchTask.md +--- + +# Stop-AzBatchTask + +## SYNOPSIS +Stops a Batch task. + +## SYNTAX + +### Id +``` +Stop-AzBatchTask [-JobId] [-Id] -BatchContext + [-DefaultProfile ] [] +``` + +### InputObject +``` +Stop-AzBatchTask [-Task] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Stop-AzBatchTask** cmdlet stops an Azure Batch task. + +## EXAMPLES + +### Example 1: Delete a Batch task by ID +```powershell +Stop-AzBatchTask -JobId "Job-000001" -Id "Task23" -BatchContext $Context +``` + +This command stops a task that has the ID Task23 under the job that has the ID Job-000001. +The command prompts you for confirmation. +Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable. + +### Example 2: Stop a Batch task by using the pipeline +```powershell +Get-AzBatchTask -JobId "Job-000001" -Id "Task26" -BatchContext $Context | Stop-AzBatchTask -BatchContext $Context +``` + +This command gets the Batch task that has the ID Task26 in the job that has the ID Job-000001 by using the Get-AzBatchTask cmdlet. +The command passes that task to the current cmdlet by using the pipeline operator. +The command stops that task. + +## PARAMETERS + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the task that this cmdlet stops. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of the job that contains the task. + +```yaml +Type: System.String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Task +Specifies the task that this cmdlet stops. +To obtain a **PSCloudTask** object, use the Get-AzBatchTask cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.Models.PSCloudTask + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzBatchTask](./Get-AzBatchTask.md) + +[New-AzBatchTask](./New-AzBatchTask.md) + +[Remove-AzBatchTask](./Remove-AzBatchTask.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Batch/Test-AzBatchAutoScale.md b/azps-10.1.0/Az.Batch/Test-AzBatchAutoScale.md new file mode 100644 index 0000000000..31ddfb1e53 --- /dev/null +++ b/azps-10.1.0/Az.Batch/Test-AzBatchAutoScale.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml +Module Name: Az.Batch +ms.assetid: BF0C1A2F-2703-492F-A3A7-053416A5D1EB +online version: https://learn.microsoft.com/powershell/module/az.batch/test-azbatchautoscale +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Test-AzBatchAutoScale.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Batch/Batch/help/Test-AzBatchAutoScale.md +--- + +# Test-AzBatchAutoScale + +## SYNOPSIS +Gets the result of an automatic scaling formula on a pool. + +## SYNTAX + +``` +Test-AzBatchAutoScale [-Id] [-AutoScaleFormula] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Test-AzBatchAutoScale** cmdlet gets the result of an automatic scaling formula on the specified pool. + +## EXAMPLES + +### Example 1: Evaluate an autoscale formula on a pool +```powershell +$Formula = 'totalNodes=($CPUPercent.GetSamplePercent(TimeInterval_Minute*0,TimeInterval_Minute*10)<0.7?5:(min($CPUPercent.GetSample(TimeInterval_Minute*0, TimeInterval_Minute*10))>0.8?($CurrentDedicated*1.1):$CurrentDedicated));$TargetDedicated=min(100,totalNodes);'; +$Evaluation = Test-AzBatchAutoScale -Id "ContosoPool" -AutoScaleFormula $Formula -BatchContext $Context +$Evaluation.Results +``` + +```output +$TargetDedicated=5;$NodeDeallocationOption=requeue;totalNodes=5 +``` + +The first command stores a formula in the $Formula variable for use in the example. +The second command evaluates the autoscale formula on the pool that has the ID ContosoPool. +The final command displays the **Results** by using standard dot syntax. + +## PARAMETERS + +### -AutoScaleFormula +Specifies the formula for the desired number of compute nodes in the pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchContext +Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. +If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: Microsoft.Azure.Commands.Batch.BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the object ID of the pool for which to test automatic scaling. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSAutoScaleRun + +## NOTES + +## RELATED LINKS + +[Disable-AzBatchAutoScale](./Disable-AzBatchAutoScale.md) + +[Enable-AzBatchAutoScale](./Enable-AzBatchAutoScale.md) + +[Get-AzBatchAccountKey](./Get-AzBatchAccountKey.md) + +[Azure Batch Cmdlets](/powershell/module/Az.Batch/) diff --git a/azps-10.1.0/Az.Billing/Az.Billing.md b/azps-10.1.0/Az.Billing/Az.Billing.md new file mode 100644 index 0000000000..7361621b6e --- /dev/null +++ b/azps-10.1.0/Az.Billing/Az.Billing.md @@ -0,0 +1,63 @@ +--- +Module Name: Az.Billing +Module Guid: a1f34ce9-bf46-4180-b36c-be232a1f8f63 +Download Help Link: https://learn.microsoft.com/powershell/module/az.billing +Help Version: 2.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Az.Billing.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Az.Billing.md +--- + +# Az.Billing Module +## Description +The topics in this section document the Azure PowerShell cmdlets for Azure Billing in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.Billing namespace. + +## Az.Billing Cmdlets +### [Get-AzBillingInvoice](Get-AzBillingInvoice.md) +Get billing invoices of the subscription. + +### [Get-AzBillingPeriod](Get-AzBillingPeriod.md) +Get billing periods of the subscription. + +### [Get-AzConsumptionBudget](Get-AzConsumptionBudget.md) +Get a list of budgets in either a subscription or a resource group. + +### [Get-AzConsumptionMarketplace](Get-AzConsumptionMarketplace.md) +Get marketplaces of the subscription. + +### [Get-AzConsumptionPriceSheet](Get-AzConsumptionPriceSheet.md) +Get price sheets of the subscription. + +### [Get-AzConsumptionReservationDetail](Get-AzConsumptionReservationDetail.md) +Get reservations details for provided date range. + +### [Get-AzConsumptionReservationSummary](Get-AzConsumptionReservationSummary.md) +Get reservation summaries for daily or monthly grain. + +### [Get-AzConsumptionUsageDetail](Get-AzConsumptionUsageDetail.md) +Get usage details of the subscription. + +### [Get-AzEnrollmentAccount](Get-AzEnrollmentAccount.md) +Get enrollment accounts. + +### [Get-UsageAggregates](Get-UsageAggregates.md) +Gets the reported Azure subscription usage details. + +### [New-AzConsumptionBudget](New-AzConsumptionBudget.md) +Create a budget in either a subscription or a resource group. + +### [Remove-AzConsumptionBudget](Remove-AzConsumptionBudget.md) +Remove a budget in either a subscription or a resource group. + +### [Set-AzConsumptionBudget](Set-AzConsumptionBudget.md) +Update a budget in either a subscription or a resource group. + +### [Get-AzBillingAccount](Get-AzBillingAccount.md) +Get billing accounts. + +### [Get-AzBillingProfile](Get-AzBillingProfile.md) +Get billing profiles. + +### [Get-AzInvoiceSection](Get-AzInvoiceSection.md) +Get invoice sections. + diff --git a/azps-10.1.0/Az.Billing/Get-AzBillingAccount.md b/azps-10.1.0/Az.Billing/Get-AzBillingAccount.md new file mode 100644 index 0000000000..6cd8571f93 --- /dev/null +++ b/azps-10.1.0/Az.Billing/Get-AzBillingAccount.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Billing.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/get-azbillingaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzBillingAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzBillingAccount.md +--- + +# Get-AzBillingAccount + +## SYNOPSIS +Get billing accounts. + +## SYNTAX + +### List (Default) +``` +Get-AzBillingAccount [-IncludeAddress] [-ExpandBillingProfile] [-ExpandInvoiceSection] [-DefaultProfile ] + [] +``` + +### Single +``` +Get-AzBillingAccount -Name [-IncludeAddress] [-ExpandBillingProfile] [-ExpandInvoiceSection] [-ListEntitiesToCreateSubscription] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBillingAccount** cmdlet gets billing accounts, user has access to. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzBillingAccount +``` + +Get all billing accounts user has access to. + +### Example 2 +```powershell +Get-AzBillingAccount -Name 00000000-0000-0000-0000-000000000000 +``` + +Get the billing account with the specified name. + +### Example 3 +```powershell +Get-AzBillingAccount -IncludeAddress +``` + +Get all billing accounts user has access to, and include the address in the result. + +### Example 4 +```powershell +Get-AzBillingAccount -ExpandBillingProfile +``` + +Get all billing accounts user has access to, and include the billing profiles in the result. + +### Example 5 +```powershell +Get-AzBillingAccount -ExpandInvoiceSection +``` + +Get all billing accounts user has access to, and include the billing profiles and invoice sections under them in the result. + +### Example 6 +```powershell +Get-AzBillingAccount -ExpandInvoiceSection -IncludeAddress -ExpandBillingProfile -Name 00000000-0000-0000-0000-000000000000 +``` + +Get the billing account with the specified name, and include the address, billing profiles and invoice sections under them in the result. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAddress +Include the address of the billing account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandBillingProfile +Include the billing profiles under the billing account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandInvoiceSection +Include the billing profiles under billing account and invoices sections under them. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of a specific billing account. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: Single +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListEntitiesToCreateSubscription +List the billing entities under billing account which can be used as input to create subscription. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Single +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Billing.Models.PSBillingAccount + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Get-AzBillingInvoice.md b/azps-10.1.0/Az.Billing/Get-AzBillingInvoice.md new file mode 100644 index 0000000000..9b14aa038a --- /dev/null +++ b/azps-10.1.0/Az.Billing/Get-AzBillingInvoice.md @@ -0,0 +1,270 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Billing.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/get-azbillinginvoice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzBillingInvoice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzBillingInvoice.md +--- + +# Get-AzBillingInvoice + +## SYNOPSIS +Get billing invoices of the subscription. +Get billing invoices of a billing account and billing profile + +## SYNTAX + +### List (Default) +``` +Get-AzBillingInvoice [-MaxCount ] [-GenerateDownloadUrl] [-DefaultProfile ] [-BillingAccountName] [-BillingProfileName] + [] +``` + +### Latest +``` +Get-AzBillingInvoice [-Latest] [-DefaultProfile ] [] [-BillingAccountName] [-BillingProfileName] +``` + +### Single +``` +Get-AzBillingInvoice -Name + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBillingInvoice** cmdlet gets billing invoices of the subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzBillingInvoice -Latest +``` + +Get the latest invoice of the subscription. + +### Example 2 +```powershell +Get-AzBillingInvoice -Name 2017-02-18-432543543 +``` + +Get the invoice of the subscription with the specified name. + +### Example 3 +```powershell +Get-AzBillingInvoice +``` + +Get all available invoices of the subscription in reverse chronological order beginning with the most recent invoice without download Url. + +### Example 4 +```powershell +Get-AzBillingInvoice -GenerateDownloadUrl -MaxCount 10 +``` + +Get most recent 10 invoices of the subscription and include the download Url in the result. + +### Example 5 +```powershell +Get-AzBillingInvoice -Name 2017-02-18-432543543 -GenerateDownloadUrl +``` + +Get the specific invoice by name and include download url in the result. + +### Example 6 +```powershell +Get-AzBillingInvoice -BillingAccountName 00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_0000-00-00 -GenerateDownloadUrl +``` + +Get invoices by billing account name and include download url for each invoice in the result. + +### Example 7 +```powershell +Get-AzBillingInvoice -Name 0000000000 -BillingAccountName 00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_0000-00-00 -GenerateDownloadUrl +``` + +Get specific invoice by invoice name and billing account name and include download url for each invoice in the result. + +### Example 8 +```powershell +Get-AzBillingInvoice -Latest -BillingAccountName 00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_0000-00-00 -GenerateDownloadUrl +``` + +Get latest invoice by billing account name and include download url for invoice in the result. + +### Example 9 +```powershell +Get-AzBillingInvoice -GenerateDownloadUrl -BillingAccountName 00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_0000-00-00 -BillingProfileName 0000-0000-000-000 -MaxCount 10 +``` + +Get most recent 10 invoices of the specific billing account and specific billing profile and include the download Url in the result. + +### Example 10 +```powershell +Get-AzBillingInvoice -Latest -GenerateDownloadUrl -BillingAccountName 00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_0000-00-00 -BillingProfileName 0000-0000-000-000 +``` + +Get latest invoice by billing account name and billing profile name and include download url for invoice in the result. + +### Example 11 +```powershell +Get-AzBillingInvoice -BillingAccountName 00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_0000-00-00 -BillingProfileName 0000-0000-000-000 -PeriodStartDate 0000-00-00 -PeriodEndDate 0000-00-00 +``` + +Get invoices by billing account name and billing profile name for a billing period specified by perioStart date and periodEnd date. + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GenerateDownloadUrl +Generate the download url of the invoices. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Latest +Get the latest invoice. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Latest +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCount +Determines the maximum number of records to return. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of a specific invoice to get or the most recent if not specified. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: Single +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingAccountName +Name of a specific billing account to get invoices for. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingProfileName +Name of a specific billing profile to get invoices for. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeriodStartDate +Start date for invoice. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeriodEndDate +End date for invoice. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Billing.Models.PSInvoice + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Get-AzBillingPeriod.md b/azps-10.1.0/Az.Billing/Get-AzBillingPeriod.md new file mode 100644 index 0000000000..cf50bd588a --- /dev/null +++ b/azps-10.1.0/Az.Billing/Get-AzBillingPeriod.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Billing.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/get-azbillingperiod +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzBillingPeriod.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzBillingPeriod.md +--- + +# Get-AzBillingPeriod + +## SYNOPSIS +Get billing periods of the subscription. + +## SYNTAX + +### List (Default) +``` +Get-AzBillingPeriod [-MaxCount ] [-DefaultProfile ] [] +``` + +### Single +``` +Get-AzBillingPeriod -Name + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBillingPeriod** cmdlet gets billing periods of the subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzBillingPeriod +``` + +Get all available billing periods of the subscription. + +### Example 2 +```powershell +Get-AzBillingPeriod -Name 201704-1 +``` + +Get the billing period of the subscription with the specified name. + +### Example 3 +```powershell +Get-AzBillingPeriod -MaxCount 2 +``` + +Get at most 2 billing periods of the subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCount +Determine the maximum number of records to return. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of a specific billing period to get. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: Single +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Billing.Models.PSBillingPeriod + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Get-AzBillingProfile.md b/azps-10.1.0/Az.Billing/Get-AzBillingProfile.md new file mode 100644 index 0000000000..053072dc1b --- /dev/null +++ b/azps-10.1.0/Az.Billing/Get-AzBillingProfile.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Billing.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/get-azbillingprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzBillingProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzBillingProfile.md +--- + +# Get-AzBillingProfile + +## SYNOPSIS +Get billing profiles. + +## SYNTAX + +### List (Default) +``` +Get-AzBillingProfile -BillingAccountName -BillingProfileName [-ExpandInvoiceSection] + [-DefaultProfile ] [] +``` + +### Single +``` +Get-AzBillingProfile -BillingAccountName -BillingProfileName -Name [-ExpandInvoiceSection] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzBillingProfile** cmdlet gets billing profiles under the specified billing account. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzBillingProfile -BillingAccountName 00000000-0000-0000-0000-000000000000 +``` + +Get all billing profiles under the specified billing account. + +### Example 2 +```powershell +Get-AzBillingProfile -BillingAccountName 00000000-0000-0000-0000-000000000000 -Name AAAA-0A00-AAA-ZZZ +``` + +Get the billing profile with the specified name. + +### Example 3 +```powershell +Get-AzBillingProfile -BillingAccountName 00000000-0000-0000-0000-000000000000 -ExpandInvoiceSection +``` + +Get all billing profiles under specified billing account, and include the invoice sections in the result. + +### Example 4 +```powershell +Get-AzBillingProfile -BillingAccountName 00000000-0000-0000-0000-000000000000 -ExpandInvoiceSection -Name +``` + +Get the billing profile with the specified name, and include the invoice sections in the result. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingAccountName +Name of the specific billing account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandInvoiceSection +Include the invoices sections under billing profile. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of a specific billing profile. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: Single +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Billing.Models.PSBillingProfile + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Get-AzConsumptionBudget.md b/azps-10.1.0/Az.Billing/Get-AzConsumptionBudget.md new file mode 100644 index 0000000000..a8810dcdeb --- /dev/null +++ b/azps-10.1.0/Az.Billing/Get-AzConsumptionBudget.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Consumption.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/get-azconsumptionbudget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzConsumptionBudget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzConsumptionBudget.md +--- + +# Get-AzConsumptionBudget + +## SYNOPSIS +Get a list of budgets in either a subscription or a resource group. + +## SYNTAX + +``` +Get-AzConsumptionBudget [-DefaultProfile ] [-ResourceGroupName ] + [-Name ] [] +``` + +## DESCRIPTION +The Get-AzConsumptionBudget cmdlet gets a list of budgets in either a subscription or a resource group. + +## EXAMPLES + +### Example 1: Get a list of budgets at subscription level +```powershell +Get-AzConsumptionBudget +``` + +```output +Amount: 60 +Category: Cost +CurrentSpend: null +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget +Name: PSBudget +TimeGrain: Monthly +TimePeriod: EndDate: 11/1/2018 12:00:00 AM + StartDate: 6/1/2018 12:00:00 AM +Type: Microsoft.Consumption/budgets +``` + +### Example 2: Get a list of budgets at resource group level +```powershell +Get-AzConsumptionBudget -ResourceGroupName RGBudgets +``` + +```output +Amount: 60 +Category: Cost +CurrentSpend: null +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/RGBudgets/providers/Microsoft.Consumption/budgets/PSBudgetRG +Name: PSBudgetRG +TimeGrain: Monthly +TimePeriod: EndDate: 11/1/2018 12:00:00 AM + StartDate: 6/1/2018 12:00:00 AM +Type: Microsoft.Consumption/budgets +``` + +### Example 3: Get a budget with the budget name at subscription level +```powershell +Get-AzConsumptionBudget -Name PSBudget +``` + +```output +Amount: 60 +Category: Cost +CurrentSpend: null +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget +Name: PSBudget +TimeGrain: Monthly +TimePeriod: EndDate: 11/1/2018 12:00:00 AM + StartDate: 6/1/2018 12:00:00 AM +Type: Microsoft.Consumption/budgets +``` + +### Example 4: Get a budget with the budget name at resource group level +```powershell +Get-AzConsumptionBudget -ResourceGroupName RGBudgets -Name PSBudgetRG +``` + +```output +Amount: 60 +Category: Cost +CurrentSpend: null +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/RGBudgets/providers/Microsoft.Consumption/budgets/PSBudgetRG +Name: PSBudgetRG +TimeGrain: Monthly +TimePeriod: EndDate: 11/1/2018 12:00:00 AM + StartDate: 6/1/2018 12:00:00 AM +Type: Microsoft.Consumption/budgets +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of a budget. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group of a budget. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Consumption.Models.PSBudget + +## NOTES +- Currently, PowerShell SDK for Consumption is only available to Enterprise Agreement customers. +- PowerShell SDK for Consumption is using an older version of Budgets API and few backwards non-compatible items like listing Budgets with filters will not work as expected. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Get-AzConsumptionMarketplace.md b/azps-10.1.0/Az.Billing/Get-AzConsumptionMarketplace.md new file mode 100644 index 0000000000..416454efa3 --- /dev/null +++ b/azps-10.1.0/Az.Billing/Get-AzConsumptionMarketplace.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Consumption.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/get-azconsumptionmarketplace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzConsumptionMarketplace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzConsumptionMarketplace.md +--- + +# Get-AzConsumptionMarketplace + +## SYNOPSIS +Get marketplaces of the subscription. + +## SYNTAX + +``` +Get-AzConsumptionMarketplace [-BillingPeriodName ] [-EndDate ] [-InstanceId ] + [-InstanceName ] [-ResourceGroup ] [-StartDate ] [-Top ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzConsumptionMarketplace** cmdlet gets marketplaces of the subscription. + +## EXAMPLES + +### Example 1: Get marketplaces usage +```powershell +Get-AzConsumptionMarketplace -Top 10 +``` + +```output +BillingPeriodId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201807-1 +ConsumedQuantity: 24 +Currency: USD +Id: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201807-1/providers/Microsoft.Consumption/marketplaces/018b7291-57a5-e194-65ea-28c3f1db76aa +InstanceId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/resourceGroups/TESTRG1/providers/Microsoft.Compute/virtualMachines/TestVM +InstanceName: TestVM +IsEstimated: false +Name: 018b7291-57a5-e194-65ea-28c3f1db76aa +OfferName: 2b380487-dc18-4e5d-981f-1ee2cc59e776 +PretaxCost: 0 +ResourceRate: 0 +SubscriptionGuid: 6b74c45b-9597-4939-a202-36b2ee8fbb3d +Type: Microsoft.Consumption/usageDetails +UsageEnd: 2018-04-29T00:00:00Z +UsageStart: 2018-04-28T00:00:00Z +``` + +### Example 2: Get marketplace usage with date range +```powershell +Get-AzConsumptionMarketplace -StartDate 2018-01-03 -EndDate 2018-01-20 -Top 10 +``` + +```output +BillingPeriodId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201803-1 +ConsumedQuantity: 24 +Currency: USD +Id: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201803-1/providers/Microsoft.Consumption/marketplaces/0ec2bd1e-1cd6-0c75-3661-eaf3f635df33 +InstanceId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/resourceGroups/TESTRG1/providers/Microsoft.Compute/virtualMachines/TestVM +InstanceName: TestVM +IsEstimated: false +Name: 0ec2bd1e-1cd6-0c75-3661-eaf3f635df33 +OfferName: 2b380487-dc18-4e5d-981f-1ee2cc59e776 +PretaxCost: 0 +ResourceRate: 0 +SubscriptionGuid: 6b74c45b-9597-4939-a202-36b2ee8fbb3d +Type: Microsoft.Consumption/usageDetails +UsageEnd: 2018-01-04T00:00:00Z +UsageStart: 2018-01-03T00:00:00Z +``` + +### Example 3: Get marketplace usage of BillingPeriodName +```powershell +Get-AzConsumptionMarketplace -BillingPeriodName 201801-1 -Top 10 +``` + +```output +BillingPeriodId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201801-1 +ConsumedQuantity: 24 +Currency: USD +Id: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201801-1/providers/Microsoft.Consumption/marketplaces/ea82233a-9f76-7eaa-4478-42bd61cf6287 +InstanceId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/resourceGroups/TESTRG1/providers/Microsoft.Compute/virtualMachines/TestVM +InstanceName: TestVM +IsEstimated: false +Name: ea82233a-9f76-7eaa-4478-42bd61cf6287 +OfferName: 2b380487-dc18-4e5d-981f-1ee2cc59e776 +PretaxCost: 0 +ResourceRate: 0 +SubscriptionGuid: 6b74c45b-9597-4939-a202-36b2ee8fbb3d +Type: Microsoft.Consumption/usageDetails +UsageEnd: 2017-10-29T00:00:00Z +UsageStart: 2017-10-28T00:00:00Z +``` + +### Example 4: Get marketplace usage with InstanceName filter +```powershell +Get-AzConsumptionMarketplace -InstanceName TestVM -Top 10 +``` + +```output +BillingPeriodId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201807-1 +ConsumedQuantity: 24 +Currency: USD +Id: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201807-1/providers/Microsoft.Consumption/marketplaces/018b7291-57a5-e194-65ea-28c3f1db76aa +InstanceId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/resourceGroups/TESTRG1/providers/Microsoft.Compute/virtualMachines/TestVM +InstanceName: TestVM +IsEstimated: false +Name: 018b7291-57a5-e194-65ea-28c3f1db76aa +OfferName: 2b380487-dc18-4e5d-981f-1ee2cc59e776 +PretaxCost: 0 +ResourceRate: 0 +SubscriptionGuid: 6b74c45b-9597-4939-a202-36b2ee8fbb3d +Type: Microsoft.Consumption/usageDetails +UsageEnd: 2018-04-29T00:00:00Z +UsageStart: 2018-04-28T00:00:00Z +``` + +## PARAMETERS + +### -BillingPeriodName +Name of a specific billing period to get the marketplace that associate with. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The end date (in UTC) of the marketplaces to filter. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceId +The instance id of the marketplaces to filter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +The instance name of the marketplaces to filter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +The resource group of the marketplaces to filter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The start date (in UTC) of the marketplaces to filter. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Determine the maximum number of records to return. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Consumption.Models.PSMarketplace + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Get-AzConsumptionPriceSheet.md b/azps-10.1.0/Az.Billing/Get-AzConsumptionPriceSheet.md new file mode 100644 index 0000000000..034a1bbf6d --- /dev/null +++ b/azps-10.1.0/Az.Billing/Get-AzConsumptionPriceSheet.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Consumption.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/get-azconsumptionpricesheet +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzConsumptionPriceSheet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzConsumptionPriceSheet.md +--- + +# Get-AzConsumptionPriceSheet + +## SYNOPSIS +Get price sheets of the subscription. + +## SYNTAX + +``` +Get-AzConsumptionPriceSheet [-BillingPeriodName ] [-ExpandMeterDetail] [-Top ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzConsumptionPriceSheet** cmdlet gets price sheets of the subscription. + +## EXAMPLES + +### Example 1: Get price sheets +```powershell +Get-AzConsumptionPriceSheet +``` + +```output +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601/providers/Microsoft.Consumption/pricesheets/default +Name: default +Type: Microsoft.Consumption/pricesheets +Pricesheets: BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601 + CurrencyCode: USD + IncludedQuantity: 0 + MeterId: BACDDD36-2C2C-46BB-8CFA-D13C15EE4A7E + PartNumber: AAA-49135 + UnitOfMeasure: 10 Hours + UnitPrice: 1.33 +``` + +### Example 2: Get price sheets with expand of MeterDetails +```powershell +Get-AzConsumptionPriceSheet -ExpandMeterDetail +``` + +```output +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601/providers/Microsoft.Consumption/pricesheets/default +Name: default +Type: Microsoft.Consumption/pricesheets +Pricesheets: BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601 + CurrencyCode: USD + IncludedQuantity: 0 + MeterDetails: MeterCategory: Virtual Machines + MeterLocation: US North Central + MeterName: Compute Hours + MeterSubCategory: Standard_D11_v2 VM_Promo (Windows) + Unit: Hours + MeterId: BACDDD36-2C2C-46BB-8CFA-D13C15EE4A7E + PartNumber: AAA-49135 + UnitOfMeasure: 10 Hours + UnitPrice: 1.33 +``` + +### Example 3: Get price sheets of BillingPeriodName +```powershell +Get-AzConsumptionPriceSheet -BillingPeriodName 201712 +``` + +```output +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601/providers/Microsoft.Consumption/pricesheets/default +Name: default +Type: Microsoft.Consumption/pricesheets +Pricesheets: BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601 + CurrencyCode: USD + IncludedQuantity: 0 + MeterId: 46367D67-1E4C-4ED4-8267-4477083F581C + PartNumber: AAA-53590 + UnitOfMeasure: 10 Hours + UnitPrice: 1.37 +``` + +### Example 4: Get top 5 records of price sheets +```powershell +Get-AzConsumptionPriceSheet -Top 5 +``` + +```output +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601/providers/Microsoft.Consumption/pricesheets/default +Name: default +Type: Microsoft.Consumption/pricesheets +Pricesheets: BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601 + CurrencyCode: USD + IncludedQuantity: 0 + MeterId: BACDDD36-2C2C-46BB-8CFA-D13C15EE4A7E + PartNumber: AAA-49135 + UnitOfMeasure: 10 Hours + UnitPrice: 1.33 +``` + +## PARAMETERS + +### -BillingPeriodName +Name of a specific billing period to get the price sheets that associate with. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandMeterDetail +Expand the price sheets based on MeterDetails. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Determine the maximum number of records to return. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Consumption.Models.PSPriceSheet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Get-AzConsumptionReservationDetail.md b/azps-10.1.0/Az.Billing/Get-AzConsumptionReservationDetail.md new file mode 100644 index 0000000000..ba6a2c764e --- /dev/null +++ b/azps-10.1.0/Az.Billing/Get-AzConsumptionReservationDetail.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Consumption.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/get-azconsumptionreservationdetail +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzConsumptionReservationDetail.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzConsumptionReservationDetail.md +--- + +# Get-AzConsumptionReservationDetail + +## SYNOPSIS +Get reservations details for provided date range. + +## SYNTAX + +``` +Get-AzConsumptionReservationDetail -StartDate -EndDate -ReservationOrderId + [-ReservationId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzConsumptionReservationDetail** cmdlet gets reservations details for provided date range. + +## EXAMPLES + +### Example 1: Get reservation details with reservation order Id for provided date range +```powershell +Get-AzConsumptionReservationDetail -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -StartDate 2017-10-01 -EndDate 2017-12-07 +``` + +```output +Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640providers/Microsoft.Consumption/reservationDetails/20171007 +InstanceId: subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/testrg/providers/microsoft.compute/virtualmachines/std2swindows +Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20171007 +ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640 +ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b +ReservedHour: 24 +SkuName: Standard_DS2_v2 +TotalReservedQuantity: 1 +Type: Microsoft.Consumption/reservationDetails +UsageDate: 10/7/2017 12:00:00 AM +UsedHour: 24 +``` + +### Example 2: Get reservation details with reservation order Id and reservation Id for provided date range +```powershell +Get-AzConsumptionReservationDetail -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservationId f37f4b70-52ba-4344-a8bd-28abfd21d640 -StartDate 2017-10-01 -EndDate 2017-12-07 +``` + +```output +Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640providers/Microsoft.Consumption/reservationDetails/20171007 +InstanceId: subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/testrg/providers/microsoft.compute/virtualmachines/std2swindows +Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20171007 +ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640 +ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b +ReservedHour: 24 +SkuName: Standard_DS2_v2 +TotalReservedQuantity: 1 +Type: Microsoft.Consumption/reservationDetails +UsageDate: 10/7/2017 12:00:00 AM +UsedHour: 24 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The end data (YYYY-MM-DD in UTC) of the reservation detail. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationId +The identifier of a reservation within a reservation order. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationOrderId +The identifier of a reservation purchase. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The start data (YYYY-MM-DD in UTC) of the reservation detail. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Consumption.Models.PSReservationDetail + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Get-AzConsumptionReservationSummary.md b/azps-10.1.0/Az.Billing/Get-AzConsumptionReservationSummary.md new file mode 100644 index 0000000000..df195ebf4b --- /dev/null +++ b/azps-10.1.0/Az.Billing/Get-AzConsumptionReservationSummary.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Consumption.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/get-azconsumptionreservationsummary +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzConsumptionReservationSummary.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzConsumptionReservationSummary.md +--- + +# Get-AzConsumptionReservationSummary + +## SYNOPSIS +Get reservation summaries for daily or monthly grain. + +## SYNTAX + +``` +Get-AzConsumptionReservationSummary -Grain -ReservationOrderId [-ReservationId ] + [-StartDate ] [-EndDate ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzConsumptionReservationSummary** cmdlet gets reservation summaries for daily or monthly grain. + +## EXAMPLES + +### Example 1: Get reservation summaries with reservation order Id for monthly grain +```powershell +Get-AzConsumptionReservationSummary -Grain monthly -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b +``` + +```output +AvgUtilizationPercentage: 100 +Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640/providers/Microsoft.Consumption/reservationSummaries/20170901 +MaxUtilizationPercentage: 100 +MinUtilizationPercentage: 100 +Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20170901 +ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640 +ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b +ReservedHour: 288 +SkuName: Standard_DS2_v2 +Type: Microsoft.Consumption/reservationSummaries +UsageDate: 9/1/2017 12:00:00 AM +UsedHour: 288 +``` + +### Example 2: Get reservation summaries with reservation order Id and reservation Id for monthly grain +```powershell +Get-AzConsumptionReservationSummary -Grain monthly -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservationId f37f4b70-52ba-4344-a8bd-28abfd21d640 +``` + +```output +AvgUtilizationPercentage: 100 +Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640/providers/Microsoft.Consumption/reservationSummaries/20170901 +MaxUtilizationPercentage: 100 +MinUtilizationPercentage: 100 +Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20170901 +ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640 +ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b +ReservedHour: 288 +SkuName: Standard_DS2_v2 +Type: Microsoft.Consumption/reservationSummaries +UsageDate: 9/1/2017 12:00:00 AM +UsedHour: 288 +``` + +### Example 3: Get reservation summaries with reservation order Id for daily grain provided date range +```powershell +Get-AzConsumptionReservationSummary -Grain daily -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -StartDate 2017-10-01 -EndDate 2017-12-07 +``` + +```output +AvgUtilizationPercentage: 100 +Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640/providers/Microsoft.Consumption/reservationSummaries/20171101 +MaxUtilizationPercentage: 100 +MinUtilizationPercentage: 100 +Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20171101 +ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640 +ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b +ReservedHour: 24 +SkuName: Standard_DS2_v2 +Type: Microsoft.Consumption/reservationSummaries +UsageDate: 11/1/2017 12:00:00 AM +UsedHour: 24 +``` + +### Example 4: Get reservation summaries with reservation order Id and reservation Id for daily grain provided date range +```powershell +Get-AzConsumptionReservationSummary -Grain daily -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservationId f37f4b70-52ba-4344-a8bd-28abfd21d640 -StartDate 2017-10-01 -EndDate 2017-12-07 +``` + +```output +AvgUtilizationPercentage: 100 +Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640/providers/Microsoft.Consumption/reservationSummaries/20171101 +MaxUtilizationPercentage: 100 +MinUtilizationPercentage: 100 +Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20171101 +ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640 +ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b +ReservedHour: 24 +SkuName: Standard_DS2_v2 +Type: Microsoft.Consumption/reservationSummaries +UsageDate: 11/1/2017 12:00:00 AM +UsedHour: 24 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The end data (YYYY-MM-DD in UTC) of the reservation summary, required only for daily grain. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Grain +The time grain of the reservation summary, can be daily or monthly. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: daily, monthly + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationId +The identifier of a reservation within a reservation order. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationOrderId +The identifier of a reservation purchase. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The start data (YYYY-MM-DD in UTC) of the reservation summary, required only for daily grain. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Consumption.Models.PSReservationSummary + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Get-AzConsumptionUsageDetail.md b/azps-10.1.0/Az.Billing/Get-AzConsumptionUsageDetail.md new file mode 100644 index 0000000000..c448defd59 --- /dev/null +++ b/azps-10.1.0/Az.Billing/Get-AzConsumptionUsageDetail.md @@ -0,0 +1,331 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Consumption.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/get-azconsumptionusagedetail +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzConsumptionUsageDetail.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzConsumptionUsageDetail.md +--- + +# Get-AzConsumptionUsageDetail + +## SYNOPSIS +Get usage details of the subscription. + +## SYNTAX + +``` +Get-AzConsumptionUsageDetail [-BillingPeriodName ] [-Expand ] [-IncludeMeterDetails] + [-IncludeAdditionalProperties] [-StartDate ] [-EndDate ] [-ResourceGroup ] + [-InstanceName ] [-InstanceId ] [-Tag ] [-MaxCount ] [-Top ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzConsumptionUsageDetail** cmdlet gets usage details of the subscription. + +## EXAMPLES + +### Example 1: Get usage details with expand of MeterDetails +```powershell +Get-AzConsumptionUsageDetail -Expand MeterDetails -Top 10 +``` + +```output +AccountName: AAAA +BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601 +ConsumedService: Microsoft.Compute +CostCenter: XYZ987 +Currency: USD +DepartmentName: Ama +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601/providers/Microsoft.Consumption/usageDetails/24b9dff0-f022-55a1-886b-17b330000db3 +InstanceId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/MAR-CCM/providers/Microsoft.Compute/disks/mar-ccm-vm01_OsDisk_1_d0beead4b6ff4b4088a687701d355d61 +InstanceLocation: usnorthcentral +InstanceName: mar-ccm-vm01_OsDisk_1_d0beead4b6ff4b4088a687701d355d61 +IsEstimated: true +MeterDetails: MeterCategory: Data Management + MeterLocation: usnorthcentral + MeterName: Standard Managed Disk Operations (in 10,000s) + MeterSubCategory: Data Management + Unit: Operations +MeterId: 82cd70ab-1aee-4b30-bc04-8b71e1204dbc +Name: 24b9dff0-f022-55a1-886b-17b330000db3 +PretaxCost: 0 +Product: Data Management Standard Managed Disk Operations +SubscriptionGuid: 1caaa5a3-2b66-438e-8ab4-bce37d518c5d +SubscriptionName: CCM - Microsoft Azure Enterprise - 1 +Type: Microsoft.Consumption/usageDetails +UsageEnd: 6/1/2018 11:59:59 PM +UsageQuantity: 3.8218 +UsageStart: 6/1/2018 12:00:00 AM +``` + +### Example 2: Get usage details with date range +```powershell +Get-AzConsumptionUsageDetail -StartDate 2017-10-02 -EndDate 2017-10-05 -Top 10 +``` + +```output +AccountName: AAAA +BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20171001 +ConsumedService: Storage +CostCenter: XYZ987 +Currency: USD +DepartmentName: Ama +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20171001/providers/Microsoft.Consumption/usageDetails/732582e5-40ad-bb23-7a69-ca1ff7c8b004 +InstanceId: storsimplezc9q6r2t7f +InstanceLocation: US West Central +InstanceName: storsimplezc9q6r2t7f +IsEstimated: false +MeterId: ad22fac8-9da5-4577-8683-56ae94d39e42 +Name: 732582e5-40ad-bb23-7a69-ca1ff7c8b004 +PretaxCost: 0 +Product: Data Management Geo Redundant Standard IO - Table Write +SubscriptionGuid: 1caaa5a3-2b66-438e-8ab4-bce37d518c5d +SubscriptionName: CCM - Microsoft Azure Enterprise - 1 +Type: Microsoft.Consumption/usageDetails +UsageEnd: 10/2/2017 11:59:59 PM +UsageQuantity: 0.0006 +UsageStart: 10/2/2017 12:00:00 AM +``` + +### Example 3: Get usage details of BillingPeriodName with InstanceName filter +```powershell +Get-AzConsumptionUsageDetail -BillingPeriodName 201710 -InstanceName 1c2052westus -Top 10 +``` + +```output +AccountName: AAAA +BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20171001 +ConsumedService: Microsoft.Storage +CostCenter: XYZ987 +Currency: USD +DepartmentName: Ama +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20171001/providers/Microsoft.Consumption/usageDetails/8abc8b65-e8f1-31e1-f02b-058a7572363f +InstanceId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/securitydata/providers/Microsoft.Storage/storageAccounts/1c2052westus +InstanceLocation: uswest +InstanceName: 1c2052westus +IsEstimated: false +MeterId: 9995d93a-7d35-4d3f-9c69-7a7fea447ef4 +Name: 8abc8b65-e8f1-31e1-f02b-058a7572363f +PretaxCost: 0.000000693016692 +Product: Data Transfer Out - Zone 1 +SubscriptionGuid: 1caaa5a3-2b66-438e-8ab4-bce37d518c5d +SubscriptionName: CCM - Microsoft Azure Enterprise - 1 +Type: Microsoft.Consumption/usageDetails +UsageEnd: 10/1/2017 11:59:59 PM +UsageQuantity: 0.000009 +UsageStart: 10/1/2017 12:00:00 AM +``` + +## PARAMETERS + +### -BillingPeriodName +Name of a specific billing period to get the usage details that associate with. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The end date (in UTC) of the usages to filter. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Expand the usages based on MeterDetails, or AdditionalInfo. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAdditionalProperties +Include additional properties in the usages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeMeterDetails +Include meter details in the usages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceId +The instance id of the usages to filter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +The instance name of the usages to filter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCount +Determine the maximum number of records to return. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +The resource group of the usages to filter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The start date (in UTC) of the usages to filter. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tag of the usages to filter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Determine the maximum number of records to return. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Consumption.Models.PSUsageDetail + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Get-AzEnrollmentAccount.md b/azps-10.1.0/Az.Billing/Get-AzEnrollmentAccount.md new file mode 100644 index 0000000000..d5ce76cb27 --- /dev/null +++ b/azps-10.1.0/Az.Billing/Get-AzEnrollmentAccount.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Billing.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/get-azenrollmentaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzEnrollmentAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzEnrollmentAccount.md +--- + +# Get-AzEnrollmentAccount + +## SYNOPSIS +Get enrollment accounts. + +## SYNTAX + +### List (Default) +``` +Get-AzEnrollmentAccount [-DefaultProfile ] [] +``` + +### Single +``` +Get-AzEnrollmentAccount [-ObjectId] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzEnrollmentAccount** cmdlet gets enrollment accounts. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEnrollmentAccount +``` + +```output +ObjectId PrincipalName +-------- ------------- +dbd8453d-071f-4fb4-8e01-c99f5b067649 jason@contoso.onmicrosoft.com +7ff524ac-a0de-4402-876f-934ccee3b601 carol@contoso.onmicrosoft.com +``` + +Get all available enrollment accounts. + +### Example 2 +```powershell +Get-AzEnrollmentAccount -ObjectId dbd8453d-071f-4fb4-8e01-c99f5b067649 +``` + +```output +ObjectId PrincipalName +-------- ------------- +dbd8453d-071f-4fb4-8e01-c99f5b067649 jason@contoso.onmicrosoft.com +``` + +Get the enrollment account with the specified object id. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +ObjectId of a specific enrollment account to get. + +```yaml +Type: System.String +Parameter Sets: Single +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Billing.Models.PSBillingPeriod + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Get-AzInvoiceSection.md b/azps-10.1.0/Az.Billing/Get-AzInvoiceSection.md new file mode 100644 index 0000000000..9f642f7fd7 --- /dev/null +++ b/azps-10.1.0/Az.Billing/Get-AzInvoiceSection.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Billing.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/get-azinvoicesection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzInvoiceSection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-AzInvoiceSection.md +--- + +# Get-AzInvoiceSection + +## SYNOPSIS +Get invoice sections. + +## SYNTAX + +### List (Default) +``` +Get-AzInvoiceSection -BillingAccountName -BillingProfileName [-DefaultProfile ] + [] +``` + +### Single +``` +Get-AzInvoiceSection -BillingAccountName -BillingProfileName -Name + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzInvoiceSection** cmdlet gets invoice sections under the specified billing profile. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzInvoiceSection -BillingAccountName 00000000-0000-0000-0000-000000000000 -BillingProfileName AAAA-0A00-AAA-ZZZ +``` + +Get all invoice sections under the specified billing profile. + +### Example 2 +```powershell +Get-AzInvoiceSection -BillingAccountName 00000000-0000-0000-0000-000000000000 -BillingProfileName AAAA-0A00-AAA-ZZZ -Name BBBB-0A00-BBB-ZZZ +``` + +Get the invoice section with the specified name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingAccountName +Name of the specific billing account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingProfileName +Name of the specific billing profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of a specific invoice section. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: Single +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Billing.Models.PSInvoiceSection + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Get-UsageAggregates.md b/azps-10.1.0/Az.Billing/Get-UsageAggregates.md new file mode 100644 index 0000000000..d85369e5df --- /dev/null +++ b/azps-10.1.0/Az.Billing/Get-UsageAggregates.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.UsageAggregates.dll-Help.xml +Module Name: Az.Billing +ms.assetid: 52B3ECCB-80E5-4E16-954A-B83D0BDC7E22 +online version: https://learn.microsoft.com/powershell/module/az.billing/get-usageaggregates +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-UsageAggregates.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Get-UsageAggregates.md +--- + +# Get-UsageAggregates + +## SYNOPSIS +Gets the reported Azure subscription usage details. + +## SYNTAX + +``` +Get-UsageAggregates -ReportedStartTime -ReportedEndTime + [-AggregationGranularity ] [-ShowDetails ] [-ContinuationToken ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-UsageAggregates** cmdlet gets aggregated Azure subscription usage data by the following properties: +- Start and end times of when the usage was reported. +- Aggregation precision, either daily or hourly. +- Instance level detail for multiple instances of the same resource. +For consistent results, the returned data is based on when the usage details were reported by the Azure resource. +For more information, see Azure Billing REST API Referencehttps://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c (https://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c) in the Microsoft Developer Network library. + +## EXAMPLES + +### Example 1: Retrieve subscription data +```powershell +Get-UsageAggregates -ReportedStartTime "5/2/2015" -ReportedEndTime "5/5/2015" +``` + +This command retrieves the reported usage data for the subscription between 5/2/2015 and 5/5/2015. + +## PARAMETERS + +### -AggregationGranularity +Specifies the aggregation precision of the data. +Valid values are: Daily and Hourly. +The default value is Daily. + +```yaml +Type: Microsoft.Azure.Commerce.UsageAggregates.Models.AggregationGranularity +Parameter Sets: (All) +Aliases: +Accepted values: Daily, Hourly + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinuationToken +Specifies the continuation token that was retrieved from the response body in the previous call. +For a large result set, responses are paged by using continuation tokens. +The continuation token serves as a bookmark for progress. +If you do not specify this parameter, the data is retrieved from the beginning of the day or hour specified in *ReportedStartTime*. +We recommend that you follow the next link in the response to page though the data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportedEndTime +Specifies the reported end time for when resource usage was recorded in the Azure billing system. +Azure is a distributed system, spanning multiple datacenters around the world, so there is a delay between when the resource was actually consumed, which is the resource usage time, and when the usage event reached the billing system, which is the resource usage reported time. +In order to get all usage events for a subscription that are reported for a time period, you query by reported time. +Even though you query by reported time, the cmdlet aggregates the response data by the resource usage time. +The resource usage data is the useful pivot for analyzing the data. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportedStartTime +Specifies the reported start time for when resource usage was recorded in the Azure billing system. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowDetails +Indicates whether this cmdlet returns instance-level details with the usage data. +The default value is $True. +If $False, the service aggregates the results on the server side, and therefore returns fewer aggregate groups. +For example, if you are running three websites, by default you will get three line items for website consumption. +However, when the value is $False, all the data for the same **subscriptionId**, **meterId**, **usageStartTime**, and **usageEndTime** is collapsed into a single line item. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregationGetResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/New-AzConsumptionBudget.md b/azps-10.1.0/Az.Billing/New-AzConsumptionBudget.md new file mode 100644 index 0000000000..e6ea733e5f --- /dev/null +++ b/azps-10.1.0/Az.Billing/New-AzConsumptionBudget.md @@ -0,0 +1,387 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Consumption.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/new-azconsumptionbudget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/New-AzConsumptionBudget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/New-AzConsumptionBudget.md +--- + +# New-AzConsumptionBudget + +## SYNOPSIS +Create a budget in either a subscription or a resource group. + +## SYNTAX + +### Subscription (Default) +``` +New-AzConsumptionBudget [-DefaultProfile ] -Name -Amount + -Category -TimeGrain -StartDate [-EndDate ] + [-ResourceGroupName ] [-MeterFilter ] [-ResourceFilter ] + [-ResourceGroupFilter ] [-WhatIf] [-Confirm] [] +``` + +### Notification +``` +New-AzConsumptionBudget [-DefaultProfile ] -Name -Amount + -Category -TimeGrain -StartDate [-EndDate ] + [-ResourceGroupName ] [-MeterFilter ] [-ResourceFilter ] + [-ResourceGroupFilter ] -NotificationKey [-NotificationEnabled] + -NotificationThreshold -ContactEmail [-ContactGroup ] [-ContactRole ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The New-AzConsumptionBudget cmdlet creates a budget in either a subscription or a resource group. + +## EXAMPLES + +### Example 1: Create a cost budget with a budget name at subscription level +```powershell +New-AzConsumptionBudget -Amount 60 -Name PSBudget -Category Cost -StartDate 2018-06-01 -EndDate 2018-11-01 -TimeGrain Monthly +``` + +```output +Amount: 60 +Category: Cost +CurrentSpend: null +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget +Name: PSBudget +TimeGrain: Monthly +TimePeriod: EndDate: 11/1/2018 12:00:00 AM + StartDate: 6/1/2018 12:00:00 AM +Type: Microsoft.Consumption/budgets +``` + +### Example 2: Create a cost budget with a budget name at resource group level +```powershell +New-AzConsumptionBudget -ResourceGroupName RGBudgets -Amount 60 -Name PSBudgetRG -Category Cost -StartDate 2018-06-01 -EndDate 2018-11-01 -TimeGrain Monthly +``` + +```output +Amount: 60 +Category: Cost +CurrentSpend: null +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/RGBudgets/providers/Microsoft.Consumption/budgets/PSBudgetRG +Name: PSBudgetRG +TimeGrain: Monthly +TimePeriod: EndDate: 11/1/2018 12:00:00 AM + StartDate: 6/1/2018 12:00:00 AM +Type: Microsoft.Consumption/budgets +``` + +## PARAMETERS + +### -Amount +Amount of a budget. + +```yaml +Type: System.Decimal +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Category +Category of the budget can be cost or usage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Cost, Usage + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactEmail +Email addresses to send the budget notification to when the threshold is exceeded. + +```yaml +Type: System.String[] +Parameter Sets: Notification +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactGroup +Action groups to send the budget notification to when the threshold is exceeded. + +```yaml +Type: System.String[] +Parameter Sets: Notification +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactRole +Contact roles to send the budget notification to when the threshold is exceeded. + +```yaml +Type: System.String[] +Parameter Sets: Notification +Aliases: +Accepted values: Owner, Reader, Contributor + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +End date (YYYY-MM-DD in UTC) of time period of a budget. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeterFilter +Comma-separated list of meters to filter on. +Required if category is usage. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of a budget. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEnabled +The notification is enabled or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Notification +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationKey +Key of a notification associated with a budget, required to create a notification with notification enabled switch, notification threshold, contact emails, contact groups, or contact roles. + +```yaml +Type: System.String +Parameter Sets: Notification +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationThreshold +Threshold value associated with a notification. +Notification is sent when the cost or usage exceeded the threshold. +It is always percent and has to be between 0 and 1000. + +```yaml +Type: System.Nullable`1[System.Decimal] +Parameter Sets: Notification +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceFilter +Comma-separated list of resource instances to filter on. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupFilter +Comma-separated list of resource groups to filter on. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group of a budget. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +Start date (YYYY-MM-DD in UTC) of time period of a budget. +Not prior to current month for monthly time grain. +Not prior to three months for quarterly time grain. +Not prior to twelve months for yearly time grain. +Future start date not more than three months. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeGrain +Time grain of the budget can be monthly, quarterly, or annually. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Monthly, Quarterly, Annually + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Consumption.Models.PSBudget + +## NOTES +- Currently, PowerShell SDK for Consumption is only available to Enterprise Agreement customers. +- PowerShell SDK for Consumption is using an older version of Budgets API and few backwards non-compatible items like listing Budgets with filters will not work as expected. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Remove-AzConsumptionBudget.md b/azps-10.1.0/Az.Billing/Remove-AzConsumptionBudget.md new file mode 100644 index 0000000000..1e36408bc8 --- /dev/null +++ b/azps-10.1.0/Az.Billing/Remove-AzConsumptionBudget.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Consumption.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/remove-azconsumptionbudget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Remove-AzConsumptionBudget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Remove-AzConsumptionBudget.md +--- + +# Remove-AzConsumptionBudget + +## SYNOPSIS +Remove a budget in either a subscription or a resource group. + +## SYNTAX + +### Subscription (Default) +``` +Remove-AzConsumptionBudget [-DefaultProfile ] -Name + [-ResourceGroupName ] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### Piping +``` +Remove-AzConsumptionBudget [-DefaultProfile ] -InputObject [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Remove-AzConsumptionBudget cmdlet removes a budget in either a subscription or a resource group. + +## EXAMPLES + +### Example 1: Remove a budget with a budget name at subscription level +```powershell +Remove-AzConsumptionBudget -Name PSBudget -PassThru +``` + +```output +True +``` + +### Example 2: Remove a budget with a budget name at resource group level +```powershell +Remove-AzConsumptionBudget -ResourceGroupName RGBudgets -Name PSBudgetRG -PassThru +``` + +```output +True +``` + +### Example 3: Remove a budget through piping at subscription level +```powershell +Get-AzConsumptionBudget -Name PSBudget | Remove-AzConsumptionBudget -PassThru +``` + +```output +True +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Budget object. + +```yaml +Type: Microsoft.Azure.Commands.Consumption.Models.PSBudget +Parameter Sets: Piping +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of a budget. + +```yaml +Type: System.String +Parameter Sets: Subscription +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +The Cmdlet returns true if a budget was successfully removed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group of a budget. + +```yaml +Type: System.String +Parameter Sets: Subscription +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Consumption.Models.PSBudget + +## OUTPUTS + +### System.Boolean + +## NOTES +- Currently, PowerShell SDK for Consumption is only available to Enterprise Agreement customers. +- PowerShell SDK for Consumption is using an older version of Budgets API and few backwards non-compatible items like listing Budgets with filters will not work as expected. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Billing/Set-AzConsumptionBudget.md b/azps-10.1.0/Az.Billing/Set-AzConsumptionBudget.md new file mode 100644 index 0000000000..ccf60d03e3 --- /dev/null +++ b/azps-10.1.0/Az.Billing/Set-AzConsumptionBudget.md @@ -0,0 +1,442 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Consumption.dll-Help.xml +Module Name: Az.Billing +online version: https://learn.microsoft.com/powershell/module/az.billing/set-azconsumptionbudget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Set-AzConsumptionBudget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Billing/Billing/help/Set-AzConsumptionBudget.md +--- + +# Set-AzConsumptionBudget + +## SYNOPSIS +Update a budget in either a subscription or a resource group. + +## SYNTAX + +### Subscription (Default) +``` +Set-AzConsumptionBudget [-DefaultProfile ] -Name [-Amount ] + [-Category ] [-TimeGrain ] [-StartDate ] [-EndDate ] + [-ResourceGroupName ] [-MeterFilter ] [-ResourceFilter ] + [-ResourceGroupFilter ] [-WhatIf] [-Confirm] [] +``` + +### Notification +``` +Set-AzConsumptionBudget [-DefaultProfile ] -Name [-Amount ] + [-Category ] [-TimeGrain ] [-StartDate ] [-EndDate ] + [-ResourceGroupName ] [-MeterFilter ] [-ResourceFilter ] + [-ResourceGroupFilter ] -NotificationKey [-NotificationEnabled] + [-NotificationThreshold ] [-ContactEmail ] [-ContactGroup ] + [-ContactRole ] [-WhatIf] [-Confirm] [] +``` + +### Piping +``` +Set-AzConsumptionBudget [-DefaultProfile ] -InputObject [-Amount ] + [-Category ] [-TimeGrain ] [-StartDate ] [-EndDate ] + [-MeterFilter ] [-ResourceFilter ] [-ResourceGroupFilter ] [-WhatIf] [-Confirm] + [] +``` + +### Piping and Notification +``` +Set-AzConsumptionBudget [-DefaultProfile ] -InputObject [-Amount ] + [-Category ] [-TimeGrain ] [-StartDate ] [-EndDate ] + [-MeterFilter ] [-ResourceFilter ] [-ResourceGroupFilter ] + -NotificationKey [-NotificationEnabled] [-NotificationThreshold ] [-ContactEmail ] + [-ContactGroup ] [-ContactRole ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Set-AzConsumptionBudget cmdlet updates a budget in either a subscription or a resource group. + +## EXAMPLES + +### Example 1: Update a budget by a new amount with a budget name at subscription level +```powershell +Set-AzConsumptionBudget -Name PSBudget -Amount 75 +``` + +```output +Amount: 75 +Category: Cost +CurrentSpend: null +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget +Name: PSBudget +TimeGrain: Monthly +TimePeriod: EndDate: 11/1/2018 12:00:00 AM + StartDate: 6/1/2018 12:00:00 AM +Type: Microsoft.Consumption/budgets +``` + +### Example 2: Update a budget with a notification when cost or usage reaches a threshold of 90 percent of amount at subscription level +```powershell +Set-AzConsumptionBudget -Name PSBudget -NotificationKey notificationKey-ps1234 -NotificationEnabled -NotificationThreshold 90 -ContactEmail @('johndoe@contoso.com','janesmith@contoso.com') -ContactRole Owner,Reader,Contributor +``` + +```output +Amount: 75 +Category: Cost +CurrentSpend: null +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget +Name: PSBudget +Notification: NotificationKey: notificationKey-ps1234 + Threshold: 90 + Enabled: true + ContactEmail: johndoe@contoso.com,janesmith@contoso.com + ContactRole: Owner,Reader,Contributor +TimeGrain: Monthly +TimePeriod: EndDate: 11/1/2018 12:00:00 AM + StartDate: 6/1/2018 12:00:00 AM +Type: Microsoft.Consumption/budgets +``` + +### Example 3: Update a budget by a new amount with a budget name at resource group level +```powershell +Set-AzConsumptionBudget -ResourceGroupName RGBudgets -Name PSBudgetRG -Amount 75 +``` + +```output +Amount: 75 +Category: Cost +CurrentSpend: null +Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/RGBudgets/providers/Microsoft.Consumption/budgets/PSBudgetRG +Name: PSBudgetRG +TimeGrain: Monthly +TimePeriod: EndDate: 11/1/2018 12:00:00 AM + StartDate: 6/1/2018 12:00:00 AM +Type: Microsoft.Consumption/budgets +``` + +## PARAMETERS + +### -Amount +Amount of a budget. + +```yaml +Type: System.Nullable`1[System.Decimal] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Category +Category of the budget can be cost or usage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Cost, Usage + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactEmail +Email addresses to send the budget notification to when the threshold is exceeded. + +```yaml +Type: System.String[] +Parameter Sets: Notification, Piping and Notification +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactGroup +Action groups to send the budget notification to when the threshold is exceeded. + +```yaml +Type: System.String[] +Parameter Sets: Notification, Piping and Notification +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactRole +Contact roles to send the budget notification to when the threshold is exceeded. + +```yaml +Type: System.String[] +Parameter Sets: Notification, Piping and Notification +Aliases: +Accepted values: Owner, Reader, Contributor + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +End date (YYYY-MM-DD in UTC) of time period of a budget. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Budget object. + +```yaml +Type: Microsoft.Azure.Commands.Consumption.Models.PSBudget +Parameter Sets: Piping, Piping and Notification +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MeterFilter +Comma-separated list of meters to filter on. +Required if category is usage. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of a budget. + +```yaml +Type: System.String +Parameter Sets: Subscription, Notification +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEnabled +The notification is enabled. +If not specified, the notification is disabled by default. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Notification, Piping and Notification +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationKey +Key of a notification associated with a budget, required to create a notification with notification enabled switch, notification threshold, contact emails, contact groups, or contact roles. + +```yaml +Type: System.String +Parameter Sets: Notification, Piping and Notification +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationThreshold +Threshold value associated with a notification. +Notification is sent when the cost or usage exceeded the threshold. +It is always percent and has to be between 0 and 1000. + +```yaml +Type: System.Nullable`1[System.Decimal] +Parameter Sets: Notification, Piping and Notification +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceFilter +Comma-separated list of resource instances to filter on. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupFilter +Comma-separated list of resource groups to filter on. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group of a budget. + +```yaml +Type: System.String +Parameter Sets: Subscription, Notification +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +Start date (YYYY-MM-DD in UTC) of time period of a budget. +Not prior to current month for monthly time grain. +Not prior to three months for quarterly time grain. +Not prior to twelve months for yearly time grain. +Future start date not more than three months. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeGrain +Time grain of the budget can be monthly, quarterly, or annually. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Monthly, Quarterly, Annually + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Consumption.Models.PSBudget + +## OUTPUTS + +### Microsoft.Azure.Commands.Consumption.Models.PSBudget + +## NOTES +- Currently, PowerShell SDK for Consumption is only available to Enterprise Agreement customers. +- PowerShell SDK for Consumption is using an older version of Budgets API and few backwards non-compatible items like listing Budgets with filters will not work as expected. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.BillingBenefits/Az.BillingBenefits.md b/azps-10.1.0/Az.BillingBenefits/Az.BillingBenefits.md new file mode 100644 index 0000000000..bed25a49d9 --- /dev/null +++ b/azps-10.1.0/Az.BillingBenefits/Az.BillingBenefits.md @@ -0,0 +1,49 @@ +--- +Module Name: Az.BillingBenefits +Module Guid: 7c220d70-27ec-4403-aedd-429aa925a6a6 +Download Help Link: https://learn.microsoft.com/powershell/module/az.billingbenefits +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Az.BillingBenefits.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Az.BillingBenefits.md +--- + +# Az.BillingBenefits Module +## Description +Microsoft Azure PowerShell: BillingBenefits cmdlets + +## Az.BillingBenefits Cmdlets +### [Get-AzBillingBenefitsReservationOrderAlias](Get-AzBillingBenefitsReservationOrderAlias.md) +Get a reservation order alias. + +### [Get-AzBillingBenefitsSavingsPlan](Get-AzBillingBenefitsSavingsPlan.md) +Get savings plan. + +### [Get-AzBillingBenefitsSavingsPlanList](Get-AzBillingBenefitsSavingsPlanList.md) +List savings plans. + +### [Get-AzBillingBenefitsSavingsPlanOrder](Get-AzBillingBenefitsSavingsPlanOrder.md) +Get a savings plan order. + +### [Get-AzBillingBenefitsSavingsPlanOrderAlias](Get-AzBillingBenefitsSavingsPlanOrderAlias.md) +Get a savings plan. + +### [Invoke-AzBillingBenefitsElevateSavingPlanOrder](Invoke-AzBillingBenefitsElevateSavingPlanOrder.md) +Elevate as owner on savings plan order based on billing permissions. + +### [Invoke-AzBillingBenefitsSavingsPlanPurchaseValidation](Invoke-AzBillingBenefitsSavingsPlanPurchaseValidation.md) +Validate savings plan purchase. + +### [Invoke-AzBillingBenefitsSavingsPlanUpdateValidation](Invoke-AzBillingBenefitsSavingsPlanUpdateValidation.md) +Validate savings plan patch. + +### [New-AzBillingBenefitsReservationOrderAlias](New-AzBillingBenefitsReservationOrderAlias.md) +Create a reservation order alias. + +### [New-AzBillingBenefitsSavingsPlanOrderAlias](New-AzBillingBenefitsSavingsPlanOrderAlias.md) +Create a savings plan. +Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851 + +### [Update-AzBillingBenefitsSavingsPlan](Update-AzBillingBenefitsSavingsPlan.md) +Update savings plan. + diff --git a/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsReservationOrderAlias.md b/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsReservationOrderAlias.md new file mode 100644 index 0000000000..1b3e2ab608 --- /dev/null +++ b/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsReservationOrderAlias.md @@ -0,0 +1,139 @@ +--- +external help file: +Module Name: Az.BillingBenefits +online version: https://learn.microsoft.com/powershell/module/az.billingbenefits/get-azbillingbenefitsreservationorderalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Get-AzBillingBenefitsReservationOrderAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Get-AzBillingBenefitsReservationOrderAlias.md +--- + +# Get-AzBillingBenefitsReservationOrderAlias + +## SYNOPSIS +Get a reservation order alias. + +## SYNTAX + +### Get (Default) +``` +Get-AzBillingBenefitsReservationOrderAlias -Name [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzBillingBenefitsReservationOrderAlias -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a reservation order alias. + +## EXAMPLES + +### Example 1: Get a reservation order alias. +```powershell +Get-AzBillingBenefitsReservationOrderAlias -Name "PSRITest2" +``` + +```output +Name DisplayName SkuName Location Term BillingPlan ReservedResourceType ReservationOrderId +---- ----------- ------- -------- ---- ----------- -------------------- ------------------ +PSRITest2 PSRITest2 Standard_B1ls westus P1Y P1M VirtualMachines /providers/Microsoft.Capacity/reservationOrders/8d5aacd0-f098-4202-8d4d-1e7cb8a3ac… +``` + +Get a reservation order alias. + +### Example 2: Get a reservation order alias via identity. +```powershell +$identity = @{ + ReservationOrderAliasName = "PSRITest2" +} + +$response = Get-AzBillingBenefitsReservationOrderAlias -InputObject $identity +``` + +```output +Name DisplayName SkuName Location Term BillingPlan ReservedResourceType ReservationOrderId +---- ----------- ------- -------- ---- ----------- -------------------- ------------------ +PSRITest2 PSRITest2 Standard_B1ls westus P1Y P1M VirtualMachines /providers/Microsoft.Capacity/reservationOrders/8d5aacd0-f098-4202-8d4d-1e7cb8a3ac… +``` + +Get a reservation order alias via identity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the reservation order alias + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ReservationOrderAliasName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.IReservationOrderAliasResponse + +## 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 + - `[ReservationOrderAliasName ]`: Name of the reservation order alias + - `[SavingsPlanId ]`: ID of the savings plan + - `[SavingsPlanOrderAliasName ]`: Name of the savings plan order alias + - `[SavingsPlanOrderId ]`: Order ID of the savings plan + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsSavingsPlan.md b/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsSavingsPlan.md new file mode 100644 index 0000000000..91322293d5 --- /dev/null +++ b/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsSavingsPlan.md @@ -0,0 +1,171 @@ +--- +external help file: +Module Name: Az.BillingBenefits +online version: https://learn.microsoft.com/powershell/module/az.billingbenefits/get-azbillingbenefitssavingsplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Get-AzBillingBenefitsSavingsPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Get-AzBillingBenefitsSavingsPlan.md +--- + +# Get-AzBillingBenefitsSavingsPlan + +## SYNOPSIS +Get savings plan. + +## SYNTAX + +### List (Default) +``` +Get-AzBillingBenefitsSavingsPlan -OrderId [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzBillingBenefitsSavingsPlan -Id -OrderId [-Expand ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzBillingBenefitsSavingsPlan -InputObject [-Expand ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get savings plan. + +## EXAMPLES + +### Example 1: List savings plan under a savings plan order +```powershell +Get-AzBillingBenefitsSavingsPlan -OrderId d7ea1620-2bba-46e2-8434-11f31bfb984d +``` + +```output +Name Status ExpiryDate PurchaseDate Term Scope AppliedScopeDisplayName ProductName CommitmentAmount CommitmentCurrencyCode +---- ------ ---------- ------------ ---- ----- ----------------------- ----------- ---------------- ------------------ +PSTest7 Succeeded 11/29/2025 2:23:51 AM 11/29/2022 2:20:38 AM P3Y Shared Compute_Savings_Plan 0.001 USD +``` + +List savings plan under a savings plan order + +### Example 2: Get a single savings plan +```powershell +Get-AzBillingBenefitsSavingsPlan -OrderId d7ea1620-2bba-46e2-8434-11f31bfb984d -Id 9fde2a72-776b-49fc-869c-dca8859d7d62 +``` + +```output +Name Status ExpiryDate PurchaseDate Term Scope AppliedScopeDisplayName ProductName CommitmentAmount CommitmentCurrencyCode +---- ------ ---------- ------------ ---- ----- ----------------------- ----------- ---------------- ------------------ +PSTest7 Succeeded 11/29/2025 2:23:51 AM 11/29/2022 2:20:38 AM P3Y Shared Compute_Savings_Plan 0.001 USD +``` + +Get a single savings plan + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +May be used to expand the detail information of some properties. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ID of the savings plan + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SavingsPlanId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OrderId +Order ID of the savings plan + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: SavingsPlanOrderId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanModel + +## 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 + - `[ReservationOrderAliasName ]`: Name of the reservation order alias + - `[SavingsPlanId ]`: ID of the savings plan + - `[SavingsPlanOrderAliasName ]`: Name of the savings plan order alias + - `[SavingsPlanOrderId ]`: Order ID of the savings plan + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsSavingsPlanList.md b/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsSavingsPlanList.md new file mode 100644 index 0000000000..eddeb15bc1 --- /dev/null +++ b/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsSavingsPlanList.md @@ -0,0 +1,187 @@ +--- +external help file: +Module Name: Az.BillingBenefits +online version: https://learn.microsoft.com/powershell/module/az.billingbenefits/get-azbillingbenefitssavingsplanlist +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Get-AzBillingBenefitsSavingsPlanList.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Get-AzBillingBenefitsSavingsPlanList.md +--- + +# Get-AzBillingBenefitsSavingsPlanList + +## SYNOPSIS +List savings plans. + +## SYNTAX + +``` +Get-AzBillingBenefitsSavingsPlanList [-Filter ] [-Orderby ] [-RefreshSummary ] + [-SelectedState ] [-Skiptoken ] [-Take ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +List savings plans. + +## EXAMPLES + +### Example 1: List savings plans. +```powershell +Get-AzBillingBenefitsSavingsPlanList +``` + +```output +Name Status ExpiryDate PurchaseDate Term Scope AppliedScopeDisplayName ProductName CommitmentAmount CommitmentCurrencyCode +---- ------ ---------- ------------ ---- ----- ----------------------- ----------- ---------------- ------------------ +Compute_SavingsPlan_11-30-2022_15-19 Succeeded 11/30/2023 11:22:53 PM 11/30/2022 11:19:31 PM P1Y Shared Compute_Savings_Plan 0.001 USD +PSTesth1234 Succeeded 11/30/2025 12:36:25 AM 11/30/2022 12:34:31 AM P3Y Shared Compute_Savings_Plan 0.001 USD +PSTesth123 Succeeded 11/29/2025 2:51:18 AM 11/29/2022 2:49:24 AM P3Y Shared Compute_Savings_Plan 0.001 USD +PSTesth12 Succeeded 11/29/2025 2:48:30 AM 11/29/2022 2:46:45 AM P3Y Shared Compute_Savings_Plan 0.001 USD +PSTesth1 Succeeded 11/29/2025 2:45:28 AM 11/29/2022 2:43:36 AM P3Y Shared Compute_Savings_Plan 0.001 USD +PSTesth Succeeded 11/29/2025 2:42:49 AM 11/29/2022 2:41:03 AM P3Y Shared Compute_Savings_Plan 0.001 USD +``` + +List savings plans. + +### Example 2: List savings plans with filtering condition. +```powershell +Get-AzBillingBenefitsSavingsPlanList -Filter "properties/userFriendlyAppliedScopeType eq 'Shared'" +``` + +```output +Name Status ExpiryDate PurchaseDate Term Scope AppliedScopeDisplayName ProductName CommitmentAmount CommitmentCurrencyCode +---- ------ ---------- ------------ ---- ----- ----------------------- ----------- ---------------- ------------------ +Compute_SavingsPlan_11-30-2022_15-19 Succeeded 11/30/2023 11:22:53 PM 11/30/2022 11:19:31 PM P1Y Shared Compute_Savings_Plan 0.001 USD +PSTesth1234 Succeeded 11/30/2025 12:36:25 AM 11/30/2022 12:34:31 AM P3Y Shared Compute_Savings_Plan 0.001 USD +PSTesth123 Succeeded 11/29/2025 2:51:18 AM 11/29/2022 2:49:24 AM P3Y Shared Compute_Savings_Plan 0.001 USD +PSTesth12 Succeeded 11/29/2025 2:48:30 AM 11/29/2022 2:46:45 AM P3Y Shared Compute_Savings_Plan 0.001 USD +PSTesth1 Succeeded 11/29/2025 2:45:28 AM 11/29/2022 2:43:36 AM P3Y Shared Compute_Savings_Plan 0.001 USD +``` + +List savings plans with filtering condition. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +May be used to filter by reservation properties. +The filter supports 'eq', 'or', and 'and'. +It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. +Reservation properties include sku/name, properties/{appliedScopeType, archived, displayName, displayProvisioningState, effectiveDateTime, expiryDate, provisioningState, quantity, renew, reservedResourceType, term, userFriendlyAppliedScopeType, userFriendlyRenewState} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orderby +May be used to sort order by reservation properties. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RefreshSummary +To indicate whether to refresh the roll up counts of the savings plans group by provisioning states + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SelectedState +The selected provisioning state + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skiptoken +The number of savings plans to skip from the list before returning results + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Take +To number of savings plans to return + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanModel + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsSavingsPlanOrder.md b/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsSavingsPlanOrder.md new file mode 100644 index 0000000000..cc592e4caa --- /dev/null +++ b/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsSavingsPlanOrder.md @@ -0,0 +1,159 @@ +--- +external help file: +Module Name: Az.BillingBenefits +online version: https://learn.microsoft.com/powershell/module/az.billingbenefits/get-azbillingbenefitssavingsplanorder +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Get-AzBillingBenefitsSavingsPlanOrder.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Get-AzBillingBenefitsSavingsPlanOrder.md +--- + +# Get-AzBillingBenefitsSavingsPlanOrder + +## SYNOPSIS +Get a savings plan order. + +## SYNTAX + +### List (Default) +``` +Get-AzBillingBenefitsSavingsPlanOrder [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzBillingBenefitsSavingsPlanOrder -Id [-Expand ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzBillingBenefitsSavingsPlanOrder -InputObject [-Expand ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a savings plan order. + +## EXAMPLES + +### Example 1: List savings plan orders +```powershell +Get-AzBillingBenefitsSavingsPlanOrder +``` + +```output +OrderId SkuName Status ExpiryDate Term BillingPlan +------- ------- ------ ---------- ---- ----------- +23420e73-752b-47e8-96d9-6f9ac2bcee27 Compute_Savings_Plan Succeeded 11/30/2023 11:22:53 PM P1Y P1M +953fc18d-04d6-4f8a-9f51-6b784cbc4d2a Compute_Savings_Plan Succeeded 11/30/2025 12:36:25 AM P3Y P1M +a05e9e28-0adf-4e73-8e24-87bf51ab6cdc Compute_Savings_Plan Succeeded 11/29/2025 2:51:18 AM P3Y P1M +1a06f5fc-2152-40ec-9675-f890ab680df9 Compute_Savings_Plan Succeeded 11/29/2025 2:48:30 AM P3Y P1M +``` + +List savings plan orders + +### Example 2: Get a single savings plan order +```powershell +Get-AzBillingBenefitsSavingsPlanOrder -Id 23420e73-752b-47e8-96d9-6f9ac2bcee27 +``` + +```output +OrderId SkuName Status ExpiryDate Term BillingPlan +------- ------- ------ ---------- ---- ----------- +23420e73-752b-47e8-96d9-6f9ac2bcee27 Compute_Savings_Plan Succeeded 11/30/2023 11:22:53 PM P1Y P1M +``` + +Get a single savings plan order + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +May be used to expand the detail information of some properties. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Order ID of the savings plan + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SavingsPlanOrderId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanOrderModel + +## 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 + - `[ReservationOrderAliasName ]`: Name of the reservation order alias + - `[SavingsPlanId ]`: ID of the savings plan + - `[SavingsPlanOrderAliasName ]`: Name of the savings plan order alias + - `[SavingsPlanOrderId ]`: Order ID of the savings plan + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsSavingsPlanOrderAlias.md b/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsSavingsPlanOrderAlias.md new file mode 100644 index 0000000000..20aa61845e --- /dev/null +++ b/azps-10.1.0/Az.BillingBenefits/Get-AzBillingBenefitsSavingsPlanOrderAlias.md @@ -0,0 +1,139 @@ +--- +external help file: +Module Name: Az.BillingBenefits +online version: https://learn.microsoft.com/powershell/module/az.billingbenefits/get-azbillingbenefitssavingsplanorderalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Get-AzBillingBenefitsSavingsPlanOrderAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Get-AzBillingBenefitsSavingsPlanOrderAlias.md +--- + +# Get-AzBillingBenefitsSavingsPlanOrderAlias + +## SYNOPSIS +Get a savings plan. + +## SYNTAX + +### Get (Default) +``` +Get-AzBillingBenefitsSavingsPlanOrderAlias -Name [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzBillingBenefitsSavingsPlanOrderAlias -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a savings plan. + +## EXAMPLES + +### Example 1: Get a savings plan order alias. +```powershell +Get-AzBillingBenefitsSavingsPlanOrderAlias -Name "PSTest2" +``` + +```output +Name DisplayName SkuName CommitmentAmount CommitmentCurrencyCode CommitmentGrain SavingsPlanOrderId +---- ----------- ------- ---------------- ---------------------- --------------- ------------------ +PSTest2 PSTest2 Compute_Savings_Plan 0.001 USD Hourly /providers/Microsoft.BillingBenefits/savingsPlanOrders/ae177258-5b5c-4027-b46a-2d79d1… +``` + +Get a savings plan order alias. + +### Example 2: Get a savings plan order alias via identity. +```powershell +$identity = @{ + SavingsPlanOrderAliasName = "PSTest2" +} + +$response = Get-AzBillingBenefitsSavingsPlanOrderAlias -InputObject $identity +``` + +```output +Name DisplayName SkuName CommitmentAmount CommitmentCurrencyCode CommitmentGrain SavingsPlanOrderId +---- ----------- ------- ---------------- ---------------------- --------------- ------------------ +PSTest2 PSTest2 Compute_Savings_Plan 0.001 USD Hourly /providers/Microsoft.BillingBenefits/savingsPlanOrders/ae177258-5b5c-4027-b46a-2d79d1… +``` + +Get a savings plan order alias via identity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the savings plan order alias + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SavingsPlanOrderAliasName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanOrderAliasModel + +## 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 + - `[ReservationOrderAliasName ]`: Name of the reservation order alias + - `[SavingsPlanId ]`: ID of the savings plan + - `[SavingsPlanOrderAliasName ]`: Name of the savings plan order alias + - `[SavingsPlanOrderId ]`: Order ID of the savings plan + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BillingBenefits/Invoke-AzBillingBenefitsElevateSavingPlanOrder.md b/azps-10.1.0/Az.BillingBenefits/Invoke-AzBillingBenefitsElevateSavingPlanOrder.md new file mode 100644 index 0000000000..5d0c81eee3 --- /dev/null +++ b/azps-10.1.0/Az.BillingBenefits/Invoke-AzBillingBenefitsElevateSavingPlanOrder.md @@ -0,0 +1,171 @@ +--- +external help file: +Module Name: Az.BillingBenefits +online version: https://learn.microsoft.com/powershell/module/az.billingbenefits/invoke-azbillingbenefitselevatesavingplanorder +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Invoke-AzBillingBenefitsElevateSavingPlanOrder.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Invoke-AzBillingBenefitsElevateSavingPlanOrder.md +--- + +# Invoke-AzBillingBenefitsElevateSavingPlanOrder + +## SYNOPSIS +Elevate as owner on savings plan order based on billing permissions. + +## SYNTAX + +### Elevate (Default) +``` +Invoke-AzBillingBenefitsElevateSavingPlanOrder -SavingsPlanOrderId [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### ElevateViaIdentity +``` +Invoke-AzBillingBenefitsElevateSavingPlanOrder -InputObject + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Elevate as owner on savings plan order based on billing permissions. + +## EXAMPLES + +### Example 1: Elevate savings plan order +```powershell +Invoke-AzBillingBenefitsElevateSavingPlanOrder -SavingsPlanOrderId "e0b1f446-5684-4fa6-a0c8-d394368eda11" +``` + +```output +Name PrincipalId RoleDefinitionId Scope +---- ----------- ---------------- ----- +5c545baf-2ef5-4016-9c31-6e0e23c397a0 067e7443-3a55-40b6-a2d8-0a7a12a9da2d /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635 /providers/Microsoft.BillingBenefits/savingsplanorders/e45905d2-9207-4f24-8549-f615c203b49b +``` + +Elevate savings plan order + +### Example 2: Elevate savings plan order via identiy +```powershell +$identity = @{ + SavingsPlanOrderId = "e45905d2-9207-4f24-8549-f615c203b49b" +} + +$response = Invoke-AzBillingBenefitsElevateSavingPlanOrder -InputObject $identity +``` + +```output +Name PrincipalId RoleDefinitionId Scope +---- ----------- ---------------- ----- +5c545baf-2ef5-4016-9c31-6e0e23c397a0 067e7443-3a55-40b6-a2d8-0a7a12a9da2d /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635 /providers/Microsoft.BillingBenefits/savingsplanorders/e45905d2-9207-4f24-8549-f615c203b49b +``` + +Elevate savings plan order + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity +Parameter Sets: ElevateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SavingsPlanOrderId +Order ID of the savings plan + +```yaml +Type: System.String +Parameter Sets: Elevate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.IRoleAssignmentEntity + +## 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 + - `[ReservationOrderAliasName ]`: Name of the reservation order alias + - `[SavingsPlanId ]`: ID of the savings plan + - `[SavingsPlanOrderAliasName ]`: Name of the savings plan order alias + - `[SavingsPlanOrderId ]`: Order ID of the savings plan + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BillingBenefits/Invoke-AzBillingBenefitsSavingsPlanPurchaseValidation.md b/azps-10.1.0/Az.BillingBenefits/Invoke-AzBillingBenefitsSavingsPlanPurchaseValidation.md new file mode 100644 index 0000000000..aa9cdfa2d0 --- /dev/null +++ b/azps-10.1.0/Az.BillingBenefits/Invoke-AzBillingBenefitsSavingsPlanPurchaseValidation.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.BillingBenefits +online version: https://learn.microsoft.com/powershell/module/az.billingbenefits/invoke-azbillingbenefitssavingsplanpurchasevalidation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Invoke-AzBillingBenefitsSavingsPlanPurchaseValidation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Invoke-AzBillingBenefitsSavingsPlanPurchaseValidation.md +--- + +# Invoke-AzBillingBenefitsSavingsPlanPurchaseValidation + +## SYNOPSIS +Validate savings plan purchase. + +## SYNTAX + +### ValidateExpanded (Default) +``` +Invoke-AzBillingBenefitsSavingsPlanPurchaseValidation [-Benefit ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### Validate +``` +Invoke-AzBillingBenefitsSavingsPlanPurchaseValidation -Body + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Validate savings plan purchase. + +## EXAMPLES + +### Example 1: Validate savings plan purchase(expended). +```powershell +$model = @{ + SkuName = "Compute_Savings_Plan" + DisplayName = "MockName" + Term = "P1Y" + AppliedScopeType = "Shared" + BillingScopeId = "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47" + CommitmentGrain = "Hourly" + CommitmentAmount = 0.01 + CommitmentCurrencyCode = "USD" +} + +$models = @($model) + +Invoke-AzBillingBenefitsSavingsPlanPurchaseValidation -Benefit $models +``` + +```output +Valid ReasonCode Reason +----- ---------- ------ +True +``` + +Validate savings plan purchase(expended). + +### Example 2: Validate savings plan purchase. +```powershell +Invoke-AzBillingBenefitsSavingsPlanPurchaseValidation -Body $body +``` + +```output +Valid ReasonCode Reason +----- ---------- ------ +True +``` + +Validate savings plan purchase. + +## PARAMETERS + +### -Benefit +. +To construct, see NOTES section for BENEFIT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanOrderAliasModel[] +Parameter Sets: ValidateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanPurchaseValidateRequest +Parameter Sets: Validate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanPurchaseValidateRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanValidateResponse + +## 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. + + +`BENEFIT `: . + - `[SystemDataCreatedAt ]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy ]`: The identity that created the resource. + - `[SystemDataCreatedByType ]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt ]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy ]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType ]`: The type of identity that last modified the resource. + - `[AppliedScopePropertyDisplayName ]`: Display name + - `[AppliedScopePropertyManagementGroupId ]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId ]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId ]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId ]`: Tenant ID where the benefit is applied. + - `[AppliedScopeType ]`: Type of the Applied Scope. + - `[AzureAsyncOperation ]`: + - `[BillingPlan ]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. + - `[BillingScopeId ]`: Subscription that will be charged for purchasing the benefit + - `[CommitmentAmount ]`: + - `[CommitmentCurrencyCode ]`: The ISO 4217 3-letter currency code for the currency used by this purchase record. + - `[CommitmentGrain ]`: Commitment grain. + - `[DisplayName ]`: Display name + - `[Kind ]`: Resource provider kind + - `[RetryAfter ]`: + - `[SkuName ]`: Name of the SKU to be applied + - `[Term ]`: Represent benefit term in ISO 8601 format. + +`BODY `: . + - `[Benefit ]`: + - `[SystemDataCreatedAt ]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy ]`: The identity that created the resource. + - `[SystemDataCreatedByType ]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt ]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy ]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType ]`: The type of identity that last modified the resource. + - `[AppliedScopePropertyDisplayName ]`: Display name + - `[AppliedScopePropertyManagementGroupId ]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId ]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId ]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId ]`: Tenant ID where the benefit is applied. + - `[AppliedScopeType ]`: Type of the Applied Scope. + - `[AzureAsyncOperation ]`: + - `[BillingPlan ]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. + - `[BillingScopeId ]`: Subscription that will be charged for purchasing the benefit + - `[CommitmentAmount ]`: + - `[CommitmentCurrencyCode ]`: The ISO 4217 3-letter currency code for the currency used by this purchase record. + - `[CommitmentGrain ]`: Commitment grain. + - `[DisplayName ]`: Display name + - `[Kind ]`: Resource provider kind + - `[RetryAfter ]`: + - `[SkuName ]`: Name of the SKU to be applied + - `[Term ]`: Represent benefit term in ISO 8601 format. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BillingBenefits/Invoke-AzBillingBenefitsSavingsPlanUpdateValidation.md b/azps-10.1.0/Az.BillingBenefits/Invoke-AzBillingBenefitsSavingsPlanUpdateValidation.md new file mode 100644 index 0000000000..9e1682d3d2 --- /dev/null +++ b/azps-10.1.0/Az.BillingBenefits/Invoke-AzBillingBenefitsSavingsPlanUpdateValidation.md @@ -0,0 +1,281 @@ +--- +external help file: +Module Name: Az.BillingBenefits +online version: https://learn.microsoft.com/powershell/module/az.billingbenefits/invoke-azbillingbenefitssavingsplanupdatevalidation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Invoke-AzBillingBenefitsSavingsPlanUpdateValidation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Invoke-AzBillingBenefitsSavingsPlanUpdateValidation.md +--- + +# Invoke-AzBillingBenefitsSavingsPlanUpdateValidation + +## SYNOPSIS +Validate savings plan patch. + +## SYNTAX + +### ValidateExpanded (Default) +``` +Invoke-AzBillingBenefitsSavingsPlanUpdateValidation -SavingsPlanId -SavingsPlanOrderId + [-Benefit ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### Validate +``` +Invoke-AzBillingBenefitsSavingsPlanUpdateValidation -SavingsPlanId -SavingsPlanOrderId + -Body [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### ValidateViaIdentity +``` +Invoke-AzBillingBenefitsSavingsPlanUpdateValidation -InputObject + -Body [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### ValidateViaIdentityExpanded +``` +Invoke-AzBillingBenefitsSavingsPlanUpdateValidation -InputObject + [-Benefit ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Validate savings plan patch. + +## EXAMPLES + +### Example 1: Validate savings plan patch +```powershell +$model = @{ + AppliedScopeType = "Single" + AppliedScopePropertiesSubscriptionId = "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47" +} + +$models = @($model) + +$response = Invoke-AzBillingBenefitsSavingsPlanUpdateValidation -SavingsPlanId "9fde2a72-776b-49fc-869c-dca8859d7d62" -SavingsPlanOrderId "d7ea1620-2bba-46e2-8434-11f31bfb984d" -Benefit $models +``` + +```output +Valid ReasonCode Reason +----- ---------- ------ +True +``` + +Validate savings plan patch + +## PARAMETERS + +### -Benefit +. +To construct, see NOTES section for BENEFIT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanUpdateRequestProperties[] +Parameter Sets: ValidateExpanded, ValidateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanUpdateValidateRequest +Parameter Sets: Validate, ValidateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity +Parameter Sets: ValidateViaIdentity, ValidateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SavingsPlanId +ID of the savings plan + +```yaml +Type: System.String +Parameter Sets: Validate, ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SavingsPlanOrderId +Order ID of the savings plan + +```yaml +Type: System.String +Parameter Sets: Validate, ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanUpdateValidateRequest + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanValidateResponse + +## 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. + + +`BENEFIT `: . + - `[AppliedScopePropertyDisplayName ]`: Display name + - `[AppliedScopePropertyManagementGroupId ]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId ]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId ]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId ]`: Tenant ID where the benefit is applied. + - `[AppliedScopeType ]`: Type of the Applied Scope. + - `[DisplayName ]`: Display name + - `[Renew ]`: Setting this to true will automatically purchase a new benefit on the expiration date time. + - `[RenewProperty ]`: + - `[PurchaseProperty ]`: + - `[AppliedScopePropertyDisplayName ]`: Display name + - `[AppliedScopePropertyManagementGroupId ]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId ]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId ]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId ]`: Tenant ID where the benefit is applied. + - `[AppliedScopeType ]`: Type of the Applied Scope. + - `[BillingPlan ]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. + - `[BillingScopeId ]`: Subscription that will be charged for purchasing the benefit + - `[CommitmentAmount ]`: + - `[CommitmentCurrencyCode ]`: The ISO 4217 3-letter currency code for the currency used by this purchase record. + - `[CommitmentGrain ]`: Commitment grain. + - `[DisplayName ]`: Friendly name of the savings plan + - `[Renew ]`: Setting this to true will automatically purchase a new benefit on the expiration date time. + - `[SkuName ]`: Name of the SKU to be applied + - `[Term ]`: Represent benefit term in ISO 8601 format. + +`BODY `: . + - `[Benefit ]`: + - `[AppliedScopePropertyDisplayName ]`: Display name + - `[AppliedScopePropertyManagementGroupId ]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId ]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId ]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId ]`: Tenant ID where the benefit is applied. + - `[AppliedScopeType ]`: Type of the Applied Scope. + - `[DisplayName ]`: Display name + - `[Renew ]`: Setting this to true will automatically purchase a new benefit on the expiration date time. + - `[RenewProperty ]`: + - `[PurchaseProperty ]`: + - `[AppliedScopePropertyDisplayName ]`: Display name + - `[AppliedScopePropertyManagementGroupId ]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId ]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId ]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId ]`: Tenant ID where the benefit is applied. + - `[AppliedScopeType ]`: Type of the Applied Scope. + - `[BillingPlan ]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. + - `[BillingScopeId ]`: Subscription that will be charged for purchasing the benefit + - `[CommitmentAmount ]`: + - `[CommitmentCurrencyCode ]`: The ISO 4217 3-letter currency code for the currency used by this purchase record. + - `[CommitmentGrain ]`: Commitment grain. + - `[DisplayName ]`: Friendly name of the savings plan + - `[Renew ]`: Setting this to true will automatically purchase a new benefit on the expiration date time. + - `[SkuName ]`: Name of the SKU to be applied + - `[Term ]`: Represent benefit term in ISO 8601 format. + +`INPUTOBJECT `: Identity Parameter + - `[Id ]`: Resource identity path + - `[ReservationOrderAliasName ]`: Name of the reservation order alias + - `[SavingsPlanId ]`: ID of the savings plan + - `[SavingsPlanOrderAliasName ]`: Name of the savings plan order alias + - `[SavingsPlanOrderId ]`: Order ID of the savings plan + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BillingBenefits/New-AzBillingBenefitsReservationOrderAlias.md b/azps-10.1.0/Az.BillingBenefits/New-AzBillingBenefitsReservationOrderAlias.md new file mode 100644 index 0000000000..2ed714a500 --- /dev/null +++ b/azps-10.1.0/Az.BillingBenefits/New-AzBillingBenefitsReservationOrderAlias.md @@ -0,0 +1,508 @@ +--- +external help file: +Module Name: Az.BillingBenefits +online version: https://learn.microsoft.com/powershell/module/az.billingbenefits/new-azbillingbenefitsreservationorderalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/New-AzBillingBenefitsReservationOrderAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/New-AzBillingBenefitsReservationOrderAlias.md +--- + +# New-AzBillingBenefitsReservationOrderAlias + +## SYNOPSIS +Create a reservation order alias. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzBillingBenefitsReservationOrderAlias -Name [-AppliedScopePropertyDisplayName ] + [-AppliedScopePropertyManagementGroupId ] [-AppliedScopePropertyResourceGroupId ] + [-AppliedScopePropertySubscriptionId ] [-AppliedScopePropertyTenantId ] + [-AppliedScopeType ] [-BillingPlan ] [-BillingScopeId ] + [-DisplayName ] [-Location ] [-Quantity ] [-Renew] + [-ReservedResourcePropertyInstanceFlexibility ] + [-ReservedResourceType ] [-ReviewDateTime ] [-SkuName ] + [-Term ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-AzBillingBenefitsReservationOrderAlias -Name -Body + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentity +``` +New-AzBillingBenefitsReservationOrderAlias -InputObject + -Body [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaIdentityExpanded +``` +New-AzBillingBenefitsReservationOrderAlias -InputObject + [-AppliedScopePropertyDisplayName ] [-AppliedScopePropertyManagementGroupId ] + [-AppliedScopePropertyResourceGroupId ] [-AppliedScopePropertySubscriptionId ] + [-AppliedScopePropertyTenantId ] [-AppliedScopeType ] [-BillingPlan ] + [-BillingScopeId ] [-DisplayName ] [-Location ] [-Quantity ] [-Renew] + [-ReservedResourcePropertyInstanceFlexibility ] + [-ReservedResourceType ] [-ReviewDateTime ] [-SkuName ] + [-Term ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a reservation order alias. + +## EXAMPLES + +### Example 1: Create a reservation order alias. +```powershell +New-AzBillingBenefitsReservationOrderAlias -Name "PSRITest1" -AppliedScopeType "Shared" -BillingPlan "P1M" -BillingScopeId "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47" -SkuName "Standard_B1ls" -Location "westus" -Quantity 1 -ReservedResourceType 'VirtualMachines' -Term "P1Y" -DisplayName "PSRITest1" +``` + +```output +Name DisplayName SkuName Location Term BillingPlan ReservedResourceType ReservationOrderId ProvisioningState BillingScopeId AppliedScopeType +---- ----------- ------- -------- ---- ----------- -------------------- ------------------ ----------------- -------------- -------- +PSRITest1 PSRITest1 Standard_B1ls westus P1Y P1M VirtualMachines /providers/Micro... Created /subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47 Shared +``` + +Create a reservation order alias. + +## PARAMETERS + +### -AppliedScopePropertyDisplayName +Display name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyManagementGroupId +Fully-qualified identifier of the management group where the benefit must be applied. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyResourceGroupId +Fully-qualified identifier of the resource group. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertySubscriptionId +Fully-qualified identifier of the subscription. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyTenantId +Tenant ID where the benefit is applied. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopeType +Type of the Applied Scope. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Support.AppliedScopeType +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingPlan +Represents the billing plan in ISO 8601 format. +Required only for monthly billing plans. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Support.BillingPlan +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingScopeId +Subscription that will be charged for purchasing the benefit + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +Reservation order alias +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.IReservationOrderAliasRequest +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +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.BillingBenefits.Models.IBillingBenefitsIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The Azure Region where the reservation benefits are applied to. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the reservation order alias + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: ReservationOrderAliasName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quantity +Total Quantity of the SKUs purchased in the Reservation. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Renew +Setting this to true will automatically purchase a new benefit on the expiration date time. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservedResourcePropertyInstanceFlexibility +Turning this on will apply the reservation discount to other VMs in the same VM size group. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Support.InstanceFlexibility +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservedResourceType +The type of the resource that is being reserved. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Support.ReservedResourceType +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReviewDateTime +This is the date-time when the Azure Hybrid Benefit needs to be reviewed. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name of the SKU to be applied + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Term +Represent benefit term in ISO 8601 format. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Support.Term +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.IReservationOrderAliasRequest + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.IReservationOrderAliasResponse + +## 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. + + +`BODY `: Reservation order alias + - `[SystemDataCreatedAt ]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy ]`: The identity that created the resource. + - `[SystemDataCreatedByType ]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt ]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy ]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType ]`: The type of identity that last modified the resource. + - `[AppliedScopePropertyDisplayName ]`: Display name + - `[AppliedScopePropertyManagementGroupId ]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId ]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId ]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId ]`: Tenant ID where the benefit is applied. + - `[AppliedScopeType ]`: Type of the Applied Scope. + - `[BillingPlan ]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. + - `[BillingScopeId ]`: Subscription that will be charged for purchasing the benefit + - `[DisplayName ]`: Display name + - `[Location ]`: The Azure Region where the reservation benefits are applied to. + - `[Quantity ]`: Total Quantity of the SKUs purchased in the Reservation. + - `[Renew ]`: Setting this to true will automatically purchase a new benefit on the expiration date time. + - `[ReservedResourcePropertyInstanceFlexibility ]`: Turning this on will apply the reservation discount to other VMs in the same VM size group. + - `[ReservedResourceType ]`: The type of the resource that is being reserved. + - `[ReviewDateTime ]`: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. + - `[SkuName ]`: Name of the SKU to be applied + - `[Term ]`: Represent benefit term in ISO 8601 format. + +`INPUTOBJECT `: Identity Parameter + - `[Id ]`: Resource identity path + - `[ReservationOrderAliasName ]`: Name of the reservation order alias + - `[SavingsPlanId ]`: ID of the savings plan + - `[SavingsPlanOrderAliasName ]`: Name of the savings plan order alias + - `[SavingsPlanOrderId ]`: Order ID of the savings plan + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BillingBenefits/New-AzBillingBenefitsSavingsPlanOrderAlias.md b/azps-10.1.0/Az.BillingBenefits/New-AzBillingBenefitsSavingsPlanOrderAlias.md new file mode 100644 index 0000000000..be115210c4 --- /dev/null +++ b/azps-10.1.0/Az.BillingBenefits/New-AzBillingBenefitsSavingsPlanOrderAlias.md @@ -0,0 +1,479 @@ +--- +external help file: +Module Name: Az.BillingBenefits +online version: https://learn.microsoft.com/powershell/module/az.billingbenefits/new-azbillingbenefitssavingsplanorderalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/New-AzBillingBenefitsSavingsPlanOrderAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/New-AzBillingBenefitsSavingsPlanOrderAlias.md +--- + +# New-AzBillingBenefitsSavingsPlanOrderAlias + +## SYNOPSIS +Create a savings plan. +Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851 + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzBillingBenefitsSavingsPlanOrderAlias -Name [-AppliedScopePropertyDisplayName ] + [-AppliedScopePropertyManagementGroupId ] [-AppliedScopePropertyResourceGroupId ] + [-AppliedScopePropertySubscriptionId ] [-AppliedScopePropertyTenantId ] + [-AppliedScopeType ] [-BillingPlan ] [-BillingScopeId ] + [-CommitmentAmount ] [-CommitmentCurrencyCode ] [-CommitmentGrain ] + [-DisplayName ] [-Kind ] [-SkuName ] [-Term ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-AzBillingBenefitsSavingsPlanOrderAlias -Name -Body + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentity +``` +New-AzBillingBenefitsSavingsPlanOrderAlias -InputObject + -Body [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaIdentityExpanded +``` +New-AzBillingBenefitsSavingsPlanOrderAlias -InputObject + [-AppliedScopePropertyDisplayName ] [-AppliedScopePropertyManagementGroupId ] + [-AppliedScopePropertyResourceGroupId ] [-AppliedScopePropertySubscriptionId ] + [-AppliedScopePropertyTenantId ] [-AppliedScopeType ] [-BillingPlan ] + [-BillingScopeId ] [-CommitmentAmount ] [-CommitmentCurrencyCode ] + [-CommitmentGrain ] [-DisplayName ] [-Kind ] [-SkuName ] + [-Term ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a savings plan. +Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851 + +## EXAMPLES + +### Example 1: Create a savings plan +```powershell +New-AzBillingBenefitsSavingsPlanOrderAlias -Name "PSTest1" -AppliedScopeType "Shared" -BillingPlan "P1M" ` +-BillingScopeId "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47" -CommitmentAmount 0.001 -CommitmentCurrencyCode "USD" -CommitmentGrain "Hourly" -SkuName "Compute_Savings_Plan" -DisplayName "PSTest199" -Term "P3Y" +``` + +```output +Name DisplayName SkuName CommitmentAmount CommitmentCurrencyCode CommitmentGrain SavingsPlanOrderId ProvisioningState BillingScopeId +---- ----------- ------- ---------------- ---------------------- --------------- ------------------ ----------------- -------------- +PSTest1 PSTest1 Compute_Savings_Plan 0.001 USD Hourly /providers/Microsoft.BillingBenefits/savingsPlanOrders/955e24a7-6672-4038-9961-619a75c2acf4 Created /subscriptions/eef82110-c91b-4395-9420… +``` + +Create a savings plan + +## PARAMETERS + +### -AppliedScopePropertyDisplayName +Display name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyManagementGroupId +Fully-qualified identifier of the management group where the benefit must be applied. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyResourceGroupId +Fully-qualified identifier of the resource group. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertySubscriptionId +Fully-qualified identifier of the subscription. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyTenantId +Tenant ID where the benefit is applied. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopeType +Type of the Applied Scope. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Support.AppliedScopeType +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingPlan +Represents the billing plan in ISO 8601 format. +Required only for monthly billing plans. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Support.BillingPlan +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingScopeId +Subscription that will be charged for purchasing the benefit + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +Savings plan order alias +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanOrderAliasModel +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CommitmentAmount +. + +```yaml +Type: System.Double +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommitmentCurrencyCode +The ISO 4217 3-letter currency code for the currency used by this purchase record. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommitmentGrain +Commitment grain. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Support.CommitmentGrain +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +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.BillingBenefits.Models.IBillingBenefitsIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Resource provider kind + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the savings plan order alias + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: SavingsPlanOrderAliasName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name of the SKU to be applied + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Term +Represent benefit term in ISO 8601 format. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Support.Term +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanOrderAliasModel + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanOrderAliasModel + +## 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. + + +`BODY `: Savings plan order alias + - `[SystemDataCreatedAt ]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy ]`: The identity that created the resource. + - `[SystemDataCreatedByType ]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt ]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy ]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType ]`: The type of identity that last modified the resource. + - `[AppliedScopePropertyDisplayName ]`: Display name + - `[AppliedScopePropertyManagementGroupId ]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId ]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId ]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId ]`: Tenant ID where the benefit is applied. + - `[AppliedScopeType ]`: Type of the Applied Scope. + - `[AzureAsyncOperation ]`: + - `[BillingPlan ]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. + - `[BillingScopeId ]`: Subscription that will be charged for purchasing the benefit + - `[CommitmentAmount ]`: + - `[CommitmentCurrencyCode ]`: The ISO 4217 3-letter currency code for the currency used by this purchase record. + - `[CommitmentGrain ]`: Commitment grain. + - `[DisplayName ]`: Display name + - `[Kind ]`: Resource provider kind + - `[RetryAfter ]`: + - `[SkuName ]`: Name of the SKU to be applied + - `[Term ]`: Represent benefit term in ISO 8601 format. + +`INPUTOBJECT `: Identity Parameter + - `[Id ]`: Resource identity path + - `[ReservationOrderAliasName ]`: Name of the reservation order alias + - `[SavingsPlanId ]`: ID of the savings plan + - `[SavingsPlanOrderAliasName ]`: Name of the savings plan order alias + - `[SavingsPlanOrderId ]`: Order ID of the savings plan + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BillingBenefits/Update-AzBillingBenefitsSavingsPlan.md b/azps-10.1.0/Az.BillingBenefits/Update-AzBillingBenefitsSavingsPlan.md new file mode 100644 index 0000000000..516dd4a378 --- /dev/null +++ b/azps-10.1.0/Az.BillingBenefits/Update-AzBillingBenefitsSavingsPlan.md @@ -0,0 +1,402 @@ +--- +external help file: +Module Name: Az.BillingBenefits +online version: https://learn.microsoft.com/powershell/module/az.billingbenefits/update-azbillingbenefitssavingsplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Update-AzBillingBenefitsSavingsPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BillingBenefits/help/Update-AzBillingBenefitsSavingsPlan.md +--- + +# Update-AzBillingBenefitsSavingsPlan + +## SYNOPSIS +Update savings plan. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzBillingBenefitsSavingsPlan -Id -OrderId [-AppliedScopePropertyDisplayName ] + [-AppliedScopePropertyManagementGroupId ] [-AppliedScopePropertyResourceGroupId ] + [-AppliedScopePropertySubscriptionId ] [-AppliedScopePropertyTenantId ] + [-AppliedScopeType ] [-DisplayName ] [-Renew] [-RenewProperty ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Update +``` +Update-AzBillingBenefitsSavingsPlan -Id -OrderId -Body + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentity +``` +Update-AzBillingBenefitsSavingsPlan -InputObject -Body + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzBillingBenefitsSavingsPlan -InputObject + [-AppliedScopePropertyDisplayName ] [-AppliedScopePropertyManagementGroupId ] + [-AppliedScopePropertyResourceGroupId ] [-AppliedScopePropertySubscriptionId ] + [-AppliedScopePropertyTenantId ] [-AppliedScopeType ] [-DisplayName ] + [-Renew] [-RenewProperty ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Update savings plan. + +## EXAMPLES + +### Example 1: Update savings plan property value +```powershell +Update-AzBillingBenefitsSavingsPlan -Id "f82fd820-f829-4022-8ba5-e3bf4ffc329b" -OrderId "e0b1f446-5684-4fa6-a0c8-d394368eda11" -DisplayName "NewName" +``` + +```output +Name Status ExpiryDate PurchaseDate Term Scope AppliedScopeDisplayName ProductName CommitmentAmount CommitmentCurrency +---- ------ ---------- ------------ ---- ----- ----------------------- ----------- ---------------- ------------------ +NewName Succeeded 10/25/2025 7:01:05 PM 10/25/2022 6:59:06 PM P3Y Shared Compute_Savings_Plan 0.001 USD +``` + +Update savings plan property value + +## PARAMETERS + +### -AppliedScopePropertyDisplayName +Display name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyManagementGroupId +Fully-qualified identifier of the management group where the benefit must be applied. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyResourceGroupId +Fully-qualified identifier of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertySubscriptionId +Fully-qualified identifier of the subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyTenantId +Tenant ID where the benefit is applied. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopeType +Type of the Applied Scope. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Support.AppliedScopeType +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +Savings plan patch request +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanUpdateRequest +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ID of the savings plan + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: SavingsPlanId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OrderId +Order ID of the savings plan + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: SavingsPlanOrderId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Renew +Setting this to true will automatically purchase a new benefit on the expiration date time. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RenewProperty +. +To construct, see NOTES section for RENEWPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.IRenewProperties +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanUpdateRequest + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.IBillingBenefitsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.Models.Api20221101.ISavingsPlanModel + +## 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. + + +`BODY `: Savings plan patch request + - `[AppliedScopePropertyDisplayName ]`: Display name + - `[AppliedScopePropertyManagementGroupId ]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId ]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId ]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId ]`: Tenant ID where the benefit is applied. + - `[AppliedScopeType ]`: Type of the Applied Scope. + - `[DisplayName ]`: Display name + - `[Renew ]`: Setting this to true will automatically purchase a new benefit on the expiration date time. + - `[RenewProperty ]`: + - `[PurchaseProperty ]`: + - `[AppliedScopePropertyDisplayName ]`: Display name + - `[AppliedScopePropertyManagementGroupId ]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId ]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId ]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId ]`: Tenant ID where the benefit is applied. + - `[AppliedScopeType ]`: Type of the Applied Scope. + - `[BillingPlan ]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. + - `[BillingScopeId ]`: Subscription that will be charged for purchasing the benefit + - `[CommitmentAmount ]`: + - `[CommitmentCurrencyCode ]`: The ISO 4217 3-letter currency code for the currency used by this purchase record. + - `[CommitmentGrain ]`: Commitment grain. + - `[DisplayName ]`: Friendly name of the savings plan + - `[Renew ]`: Setting this to true will automatically purchase a new benefit on the expiration date time. + - `[SkuName ]`: Name of the SKU to be applied + - `[Term ]`: Represent benefit term in ISO 8601 format. + +`INPUTOBJECT `: Identity Parameter + - `[Id ]`: Resource identity path + - `[ReservationOrderAliasName ]`: Name of the reservation order alias + - `[SavingsPlanId ]`: ID of the savings plan + - `[SavingsPlanOrderAliasName ]`: Name of the savings plan order alias + - `[SavingsPlanOrderId ]`: Order ID of the savings plan + +`RENEWPROPERTY `: . + - `[PurchaseProperty ]`: + - `[AppliedScopePropertyDisplayName ]`: Display name + - `[AppliedScopePropertyManagementGroupId ]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId ]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId ]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId ]`: Tenant ID where the benefit is applied. + - `[AppliedScopeType ]`: Type of the Applied Scope. + - `[BillingPlan ]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. + - `[BillingScopeId ]`: Subscription that will be charged for purchasing the benefit + - `[CommitmentAmount ]`: + - `[CommitmentCurrencyCode ]`: The ISO 4217 3-letter currency code for the currency used by this purchase record. + - `[CommitmentGrain ]`: Commitment grain. + - `[DisplayName ]`: Friendly name of the savings plan + - `[Renew ]`: Setting this to true will automatically purchase a new benefit on the expiration date time. + - `[SkuName ]`: Name of the SKU to be applied + - `[Term ]`: Represent benefit term in ISO 8601 format. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Blueprint/Az.Blueprint.md b/azps-10.1.0/Az.Blueprint/Az.Blueprint.md new file mode 100644 index 0000000000..38817663b2 --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/Az.Blueprint.md @@ -0,0 +1,54 @@ +--- +Module Name: Az.Blueprint +Module Guid: ef36c942-4a71-4e19-9450-05a35843deb6 +Download Help Link: https://learn.microsoft.com/powershell/module/az.blueprint +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Az.Blueprint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Az.Blueprint.md +--- + +# Az.Blueprint Module +## Description +The topics in this section document the Azure PowerShell cmdlets for Azure Blueprints in the Azure Resource Manager framework. The cmdlets exist in the Microsoft.Azure.PowerShell.Cmdlets.Blueprint namespace. + +## Az.Blueprint Cmdlets +### [Export-AzBlueprintWithArtifact](Export-AzBlueprintWithArtifact.md) +Export specified blueprint definition to the specified output location as a JSON file. + +### [Get-AzBlueprint](Get-AzBlueprint.md) +Get one or more blueprint definitions. + +### [Get-AzBlueprintArtifact](Get-AzBlueprintArtifact.md) +Retrieve artifacts from a blueprint definition. + +### [Get-AzBlueprintAssignment](Get-AzBlueprintAssignment.md) +Get one or more blueprint assignments. + +### [Import-AzBlueprintWithArtifact](Import-AzBlueprintWithArtifact.md) +Import a blueprint file in JSON format to a blueprint object and save it within the specified subscription or management group. + +### [New-AzBlueprint](New-AzBlueprint.md) +Create a new blueprint definition and save it within the specified subscription or management group. + +### [New-AzBlueprintArtifact](New-AzBlueprintArtifact.md) +Create a new artifact and save it within a blueprint definition. + +### [New-AzBlueprintAssignment](New-AzBlueprintAssignment.md) +Assign a blueprint definition to a subscription or a management group. + +### [Publish-AzBlueprint](Publish-AzBlueprint.md) +Publish a new version of a blueprint. + +### [Remove-AzBlueprintAssignment](Remove-AzBlueprintAssignment.md) +Remove a blueprint assignment from a subscription or a management group. + +### [Set-AzBlueprint](Set-AzBlueprint.md) +Update a blueprint definition. + +### [Set-AzBlueprintArtifact](Set-AzBlueprintArtifact.md) +Update an artifact in a blueprint definition. + +### [Set-AzBlueprintAssignment](Set-AzBlueprintAssignment.md) +Update an existing blueprint assignment. + diff --git a/azps-10.1.0/Az.Blueprint/Export-AzBlueprintWithArtifact.md b/azps-10.1.0/Az.Blueprint/Export-AzBlueprintWithArtifact.md new file mode 100644 index 0000000000..15ca43f41f --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/Export-AzBlueprintWithArtifact.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Blueprint.dll-Help.xml +Module Name: Az.Blueprint +online version: https://learn.microsoft.com/powershell/module/az.blueprint/export-azblueprintwithartifact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Export-AzBlueprintWithArtifact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Export-AzBlueprintWithArtifact.md +--- + +# Export-AzBlueprintWithArtifact + +## SYNOPSIS +Export specified blueprint definition to the specified output location as a JSON file. + +## SYNTAX + +``` +Export-AzBlueprintWithArtifact -Blueprint -OutputPath [-Version ] [-Force] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Export a blueprint definition with its artifacts and save to disk. This cmdlet exports the latest version(draft or published) of the blueprint. + +## EXAMPLES + +### Example 1 +```powershell +$bp = Get-AzBlueprint -Name SimpleBlueprint +Export-AzBlueprintWithArtifact -Blueprint $bp -Version 1.0 -OutputPath C:\Blueprints +``` + +Export a blueprint definition with its artifacts and save to disk. + +## PARAMETERS + +### -Blueprint +The blueprint definition object to export. + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +When set to true, execution will not ask for a confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputPath +Path to a file on disk where to export the Blueprint definition in JSON format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +When set, the cmdlet will return an object representing the exported blueprint definition. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Published blueprint definition version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Blueprint/Get-AzBlueprint.md b/azps-10.1.0/Az.Blueprint/Get-AzBlueprint.md new file mode 100644 index 0000000000..2a45c59691 --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/Get-AzBlueprint.md @@ -0,0 +1,264 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Blueprint.dll-Help.xml +Module Name: Az.Blueprint +online version: https://learn.microsoft.com/powershell/module/az.blueprint/get-azblueprint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Get-AzBlueprint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Get-AzBlueprint.md +--- + +# Get-AzBlueprint + +## SYNOPSIS +Get one or more blueprint definitions. + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzBlueprint [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### ByManagementGroupNameAndVersion +``` +Get-AzBlueprint -Name -ManagementGroupId [-Version] + [-DefaultProfile ] [] +``` + +### BySubscriptionAndName +``` +Get-AzBlueprint [-Name ] [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### ByManagementGroupAndName +``` +Get-AzBlueprint -Name -ManagementGroupId [-DefaultProfile ] + [] +``` + +### ByManagementGroupNameAndLatestPublished +``` +Get-AzBlueprint -Name -ManagementGroupId [-LatestPublished] + [-DefaultProfile ] [] +``` + +### BySubscriptionNameAndLatestPublished +``` +Get-AzBlueprint -Name [-SubscriptionId ] [-LatestPublished] + [-DefaultProfile ] [] +``` + +### BySubscriptionNameAndVersion +``` +Get-AzBlueprint -Name [-SubscriptionId ] [-Version] + [-DefaultProfile ] [] +``` + +### ManagementGroupScope +``` +Get-AzBlueprint -ManagementGroupId [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get one or more blueprint definitions. Blueprint definitions exist at the management group or subscription scope. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzBlueprint +``` + +```output +Name : PS-BlueprintDefinition +Id : /subscriptions/00000000-1111-0000-1111-000000000000/providers/Microsoft.Blueprint/blueprints/PS-BlueprintDefinition +SubscriptionId : 00000000-1111-0000-1111-000000000000 +Versions : {1.0} +Description : Powershell test blueprint +TimeCreated : 2019-02-01 +TargetScope : Subscription +Parameters : {storageData_storageAccountType, storageData_location, allowedlocations_listOfAllowedLocations} +ResourceGroups : ResourceGroup +``` + +Get the blueprint definitions within the current subscription and the management group hierarchy of the subscription. + +### Example 2 +```powershell +Get-AzBlueprint -ManagementGroupId "myManagementGroupId" +``` + +```output +Name : PS-MG-BlueprintDefinition +Id : /providers/Microsoft.Management/managementGroups/myManagementGroupId/providers/Microsoft.Blueprint/blueprints/PS-MG-BlueprintDefinition +ManagementGroupId : myManagementGroupId +Versions : {1.0, 2.0, 3.0, 4.0} +TimeCreated : 2019-03-04 +TargetScope : Subscription +Parameters : {enforcetaganditsvalue_tagName, enforcetaganditsvalue_tagValue, [Usergrouporapplicationname]:Contributor_RoleAssignmentName, + [Usergrouporapplicationname]:Owner_RoleAssignmentName} +ResourceGroups : {ResourceGroup, ResourceGroup2} +``` + +Get the blueprint definitions within the specified management group. + +### Example 3 +```powershell +Get-AzBlueprint -SubscriptionId "00000000-1111-0000-1111-000000000000" +``` + +```output +Name : PS-BlueprintDefinition +Id : /subscriptions/00000000-1111-0000-1111-000000000000/providers/Microsoft.Blueprint/blueprints/PS-BlueprintDefinition +SubscriptionId : 00000000-1111-0000-1111-000000000000 +Versions : {1.0} +Description : Powershell test blueprint +TimeCreated : 2019-02-01 +TargetScope : Subscription +Parameters : {storageData_storageAccountType, storageData_location, allowedlocations_listOfAllowedLocations} +ResourceGroups : ResourceGroup +``` + +Get the blueprint definitions within the specified subscription and the management group hierarchy of the subscription. + +### Example 4 +```powershell +Get-AzBlueprint -SubscriptionId "00000000-1111-0000-1111-000000000000" -Name "myBlueprintName" +``` + +Get the blueprint definition with the given name within the specified subscription. + +### Example 5 +```powershell +Get-AzBlueprint -ManagementGroupId "myManagementGroupId" -Name "myBlueprintName" -Version "myBlueprintVersion" +``` + +Get the blueprint definition with the given name and version within the specified management group. + +### Example 6 +```powershell +Get-AzBlueprint -ManagementGroupId "myManagementGroupId" -Name "myBlueprintName" -LatestPublished +``` + +Get the latest published blueprint definition with the given name within the specified management group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LatestPublished +The latest published blueprint definition flag. +When set, execution returns the latest published version of the blueprint definition. +Defaults to false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByManagementGroupNameAndLatestPublished, BySubscriptionNameAndLatestPublished +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +Management Group Id where the blueprint definition is saved. + +```yaml +Type: System.String +Parameter Sets: ByManagementGroupNameAndVersion, ByManagementGroupAndName, ByManagementGroupNameAndLatestPublished, ManagementGroupScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Blueprint definition name. + +```yaml +Type: System.String +Parameter Sets: ByManagementGroupNameAndVersion, ByManagementGroupAndName, ByManagementGroupNameAndLatestPublished, BySubscriptionNameAndLatestPublished, BySubscriptionNameAndVersion +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: BySubscriptionAndName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id where the blueprint definition is saved. + +```yaml +Type: System.String +Parameter Sets: SubscriptionScope, BySubscriptionAndName, BySubscriptionNameAndLatestPublished, BySubscriptionNameAndVersion +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Published blueprint definition version. + +```yaml +Type: System.String +Parameter Sets: ByManagementGroupNameAndVersion, BySubscriptionNameAndVersion +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Blueprint/Get-AzBlueprintArtifact.md b/azps-10.1.0/Az.Blueprint/Get-AzBlueprintArtifact.md new file mode 100644 index 0000000000..a2fb8e0eb7 --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/Get-AzBlueprintArtifact.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Blueprint.dll-Help.xml +Module Name: Az.Blueprint +online version: https://learn.microsoft.com/powershell/module/az.blueprint/get-azblueprintartifact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Get-AzBlueprintArtifact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Get-AzBlueprintArtifact.md +--- + +# Get-AzBlueprintArtifact + +## SYNOPSIS +Retrieve artifacts from a blueprint definition. + +## SYNTAX + +``` +Get-AzBlueprintArtifact [-Name ] -Blueprint [-BlueprintVersion ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve artifacts from a blueprint definition. If a blueprint definition version is not specified, the draft version is retrieved. In the case where there is no draft version, the latest published blueprint definition is returned. + +## EXAMPLES + +### Example 1 +```powershell +$bp = Get-AzBlueprint -Name SimpleBlueprint +Get-AzBlueprintArtifact -Blueprint $bp +``` + +```output +DisplayName : Audit use of classic virtual machines +Description : +DependsOn : +PolicyDefinitionId : /providers/Microsoft.Authorization/policyDefinitions/1d84d5fb-01f6-4d12-ba4f-4a26081d403d +Parameters : {[effect, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue]} +ResourceGroup : SimpleBlueprintRG +Id : /providers/Microsoft.Management/managementGroups/{mgId}/providers/Microsoft.Blueprint/blueprints/SimpleBlueprint/artifacts/3ab44511-0228-4275-9641-7e93e6f34178 +Type : Microsoft.Blueprint/blueprints/artifacts +Name : 3ab44511-0228-4275-9641-7e93e6f34178 + +DisplayName : Enforce tag and its value +Description : +DependsOn : +PolicyDefinitionId : /providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62 +Parameters : {[tagName, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue], [tagValue, + Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue]} +ResourceGroup : +Id : /providers/Microsoft.Management/managementGroups/{mgId}/providers/Microsoft.Blueprint/blueprints/SimpleBlueprint/artifacts/0e1593da-47d5-4b75-800c-9a797dd23192 +Type : Microsoft.Blueprint/blueprints/artifacts +Name : 0e1593da-47d5-4b75-800c-9a797dd23192 +``` + +Retrieve artifacts from a blueprint definition.. + +## PARAMETERS + +### -Blueprint +Blueprint object. + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -BlueprintVersion +Version of the blueprint to get the artifacts from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the artifact + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Blueprint.Models.PSArtifactKind + +### Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase + +### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +### System.Collections.Hashtable + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintAssignment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Blueprint/Get-AzBlueprintAssignment.md b/azps-10.1.0/Az.Blueprint/Get-AzBlueprintAssignment.md new file mode 100644 index 0000000000..3b8bde1fb8 --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/Get-AzBlueprintAssignment.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Blueprint.dll-Help.xml +Module Name: Az.Blueprint +online version: https://learn.microsoft.com/powershell/module/az.blueprint/get-azblueprintassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Get-AzBlueprintAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Get-AzBlueprintAssignment.md +--- + +# Get-AzBlueprintAssignment + +## SYNOPSIS +Get one or more blueprint assignments. + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzBlueprintAssignment [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### BySubscriptionAndName +``` +Get-AzBlueprintAssignment -Name [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### ByManagementGroupAndName +``` +Get-AzBlueprintAssignment -Name -ManagementGroupId [-DefaultProfile ] + [] +``` + +### ManagementGroupScope +``` +Get-AzBlueprintAssignment -ManagementGroupId [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get one or more blueprint assignments. Blueprint assignments exist at the subscription scope. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzBlueprintAssignment -SubscriptionId "00000000-1111-0000-1111-000000000000" +``` + +```output +Name : Assignment-PS-BlueprintDefinition +Id : /subscriptions/00000000-1111-0000-1111-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/Assignment-PS-BlueprintDefinition +Scope : /subscriptions/00000000-1111-0000-1111-000000000000 +LastModified : 2019-01-08 +LockMode : AllResourcesReadOnly +ProvisioningState : Succeeded +Parameters : {applytaganditsdefaultvalue_tagName, applytaganditsdefaultvalue_tagValue} +ResourceGroups : ResourceGroup +``` + +Get the blueprint assignments within the specified subscription. + +### Example 2 +```powershell +Get-AzBlueprintAssignment -SubscriptionId "00000000-1111-0000-1111-000000000000" -Name "myAssignmentName" +``` + +Get the blueprint assignment with the given name within the specified subscription. + +### Example 3 +```powershell +Get-AzBlueprintAssignment -ManagementGroupId "myManagementGroup" +``` + +Get the blueprint assignments within the specified management group. + +### Example 4 +```powershell +Get-AzBlueprintAssignment -ManagementGroupId "myManagementGroup" -Name "myAssignmentName" +``` + +Get the blueprint assignment with the given name within the specified management group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The ID of the management group where the Blueprint assignment is saved. + +```yaml +Type: System.String +Parameter Sets: ByManagementGroupAndName, ManagementGroupScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Blueprint assignment name. + +```yaml +Type: System.String +Parameter Sets: BySubscriptionAndName, ByManagementGroupAndName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id the blueprint assignment is deployed to. + +```yaml +Type: System.String +Parameter Sets: SubscriptionScope, BySubscriptionAndName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Blueprint/Import-AzBlueprintWithArtifact.md b/azps-10.1.0/Az.Blueprint/Import-AzBlueprintWithArtifact.md new file mode 100644 index 0000000000..880c7b56d9 --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/Import-AzBlueprintWithArtifact.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Blueprint.dll-Help.xml +Module Name: Az.Blueprint +online version: https://learn.microsoft.com/powershell/module/az.blueprint/import-azblueprintwithartifact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Import-AzBlueprintWithArtifact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Import-AzBlueprintWithArtifact.md +--- + +# Import-AzBlueprintWithArtifact + +## SYNOPSIS +Import a blueprint file in JSON format to a blueprint object and save it within the specified subscription or management group. + +## SYNTAX + +``` +Import-AzBlueprintWithArtifact -Name [-SubscriptionId ] [-ManagementGroupId ] + -InputPath [-IncludeSubFolders] [-Force] [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Import a blueprint definition with its artifacts. + +## EXAMPLES + +### Example 1 +```powershell +Import-AzBlueprintWithArtifact -Name MySimpleBlueprint -SubscriptionId 00000000-1111-0000-1111-000000000000 -InputPath C:\Blueprints\SimpleBlueprint +``` + +Import a blueprint definition with its artifacts and save within a subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +When set to true, execution will not ask for a confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSubFolders +When set to true, artifact in the subfolders will be included. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputPath +Path to a Blueprint JSON file on disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagementGroupId +Management Group Id where the blueprint definition is or will be saved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Blueprint definition name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +When set, the cmdlet will return an object representing the imported blueprint definition. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id where the blueprint definition is or will be saved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Blueprint/New-AzBlueprint.md b/azps-10.1.0/Az.Blueprint/New-AzBlueprint.md new file mode 100644 index 0000000000..fa0ef35232 --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/New-AzBlueprint.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Blueprint.dll-Help.xml +Module Name: Az.Blueprint +online version: https://learn.microsoft.com/powershell/module/az.blueprint/new-azblueprint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/New-AzBlueprint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/New-AzBlueprint.md +--- + +# New-AzBlueprint + +## SYNOPSIS +Create a new blueprint definition and save it within the specified subscription or management group. + +## SYNTAX + +### CreateBlueprintBySubscription (Default) +``` +New-AzBlueprint -Name [-SubscriptionId ] -BlueprintFile + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### CreateBlueprintByManagementGroup +``` +New-AzBlueprint -Name -ManagementGroupId -BlueprintFile + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a new blueprint definition. + +## EXAMPLES + +### Example 1 +```powershell +New-AzBlueprint -Name MyNewBlueprint -SubscriptionId 00000000-1111-0000-1111-000000000000 -BlueprintFile C:\Blueprint.json +``` + +```output +Name : SimpleBlueprint +Id : /providers/Microsoft.Management/managementGroups/{mgId}/providers/Microsoft.Blueprint/blueprints/SimpleBlueprint +ManagementGroupId : myManagementGroupId +Versions : +Description : test +TimeCreated : 2019-05-12 +TargetScope : Subscription +Parameters : {enforcetaganditsvalue_tagName, enforcetaganditsvalue_tagValue} +ResourceGroups : {AppNetworkRG} +``` + +Create a new blueprint definition within the specified subscription. + +## PARAMETERS + +### -BlueprintFile +Path to a Blueprint JSON file on disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +Management Group Id where the blueprint definition is or will be saved. + +```yaml +Type: System.String +Parameter Sets: CreateBlueprintByManagementGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Blueprint definition name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id where the blueprint definition is or will be saved. + +```yaml +Type: System.String +Parameter Sets: CreateBlueprintBySubscription +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Blueprint.Models.PSBlueprint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Blueprint/New-AzBlueprintArtifact.md b/azps-10.1.0/Az.Blueprint/New-AzBlueprintArtifact.md new file mode 100644 index 0000000000..27b1dae297 --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/New-AzBlueprintArtifact.md @@ -0,0 +1,394 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Blueprint.dll-Help.xml +Module Name: Az.Blueprint +online version: https://learn.microsoft.com/powershell/module/az.blueprint/new-azblueprintartifact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/New-AzBlueprintArtifact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/New-AzBlueprintArtifact.md +--- + +# New-AzBlueprintArtifact + +## SYNOPSIS +Create a new artifact and save it within a blueprint definition. + +## SYNTAX + +### CreateTemplateArtifact (Default) +``` +New-AzBlueprintArtifact -Name -Type -Blueprint + [-Description ] [-DependsOn ] + -TemplateParameterFile -TemplateFile [-ResourceGroupName ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### CreateArtifactByInputFile +``` +New-AzBlueprintArtifact -Name -Blueprint -ArtifactFile + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### CreateRoleAssignmentArtifact +``` +New-AzBlueprintArtifact -Name -Type -Blueprint + [-Description ] [-DependsOn ] + -RoleDefinitionId -RoleDefinitionPrincipalId [-ResourceGroupName ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### CreatePolicyArtifact +``` +New-AzBlueprintArtifact -Name -Type -Blueprint + [-Description ] [-DependsOn ] + -PolicyDefinitionId -PolicyDefinitionParameter [-ResourceGroupName ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a new artifact. There are two ways to create an artifact: either through an artifact JSON as an input file or through providing inline parameters for the artifact. +While the JSON method doesn't require type of the artifact to be provided inline parameter method requires user to provide the type of the artifact through -Type parameter. + +## EXAMPLES + +### Example 1 +```powershell +$bp = Get-AzBlueprint -Name SimpleBlueprint +New-AzBlueprintArtifact -Name PolicyStorage -Blueprint $bp -ArtifactFile C:\PolicyAssignmentStorageTag.json +``` + +```output +DisplayName : +Description : Apply storage tag and the parameter also used by the template to resource groups +DependsOn : +PolicyDefinitionId : /providers/Microsoft.Authorization/policyDefinitions/49c88fc8-6fd1-46fd-a676-f12d1d3a4c71 +Parameters : {[tagName, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue], [tagValue, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue]} +ResourceGroup : +Id : /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprints/AppNetwork/artifacts/PolicyAssignmentStorageTag +Type : Microsoft.Blueprint/blueprints/artifacts +Name : PolicyAssignmentStorageTag +``` + +Create a new artifact through an artifact JSON file. + +### Example 2 +```powershell +$bp = Get-AzBlueprint -Name SimpleBlueprint +New-AzBlueprintArtifact -Type PolicyAssignmentArtifact -Name "ApplyTag-RG" -Blueprint $bp -PolicyDefinitionId "/providers/Microsoft.Authorization/policyDefinitions/49c88fc8-6fd1-46fd-a676-f12d1d3a4c71" -PolicyDefinitionParameter @{tagName="[parameters('tagName')]"; tagValue="[parameters('tagValue')]"} -ResourceGroupName storageRG +``` + +```output +DisplayName : ApplyTag-RG +Description : +DependsOn : +PolicyDefinitionId : /providers/Microsoft.Authorization/policyDefinitions/49c88fc8-6fd1-46fd-a676-f12d1d3a4c71 +Parameters : {[tagValue, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue], [tagName, + Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue]} +ResourceGroup : storageRG +Id : /subscriptions/28cbf98f-381d-4425-9ac4-cf342dab9753/providers/Microsoft.Blueprint/blueprints/AppNetwork/ + artifacts/ApplyTag-RG +Type : Microsoft.Blueprint/blueprints/artifacts +Name : ApplyTag-RG +``` + +Create a new artifact through inline parameters. + +### Example 3 +```powershell +$bp = Get-AzBlueprint -Name SimpleBlueprint +New-AzBlueprintArtifact -Type TemplateArtifact -Name storage-account -Blueprint $bp -TemplateFile C:\StorageAccountArmTemplate.json -ResourceGroupName "storageRG" -TemplateParameterFile C:\Workspace\BlueprintTemplates\RestTemplatesSomeInline\StorageAccountParameters.json +``` + +```output +DisplayName : storage-account +Description : +DependsOn : +Template : {$schema, contentVersion, parameters, variables...} +Parameters : {} +ResourceGroup : storageRG +Id : /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprints/AppNetwork/artifacts/storage-account +Type : Microsoft.Blueprint/blueprints/artifacts +Name : storage-account +``` + +Create a new artifact through an ARM template file. + +## PARAMETERS + +### -ArtifactFile +Location of the artifact file in JSON format on disk. + +```yaml +Type: System.String +Parameter Sets: CreateArtifactByInputFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Blueprint +Blueprint object. + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase +Parameter Sets: CreateTemplateArtifact, CreateRoleAssignmentArtifact, CreatePolicyArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase +Parameter Sets: CreateArtifactByInputFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DependsOn +List of the names of artifacts that needs to be created before current artifact is created. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: CreateTemplateArtifact, CreateRoleAssignmentArtifact, CreatePolicyArtifact +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +Description of the artifact. + +```yaml +Type: System.String +Parameter Sets: CreateTemplateArtifact, CreateRoleAssignmentArtifact, CreatePolicyArtifact +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the artifact + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinitionId +Definition Id of the policy definition. + +```yaml +Type: System.String +Parameter Sets: CreatePolicyArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinitionParameter +Hashtable of parameters to pass to the policy definition artifact. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreatePolicyArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group the artifact is going to be under. + +```yaml +Type: System.String +Parameter Sets: CreateTemplateArtifact, CreateRoleAssignmentArtifact, CreatePolicyArtifact +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoleDefinitionId +List of role definition + +```yaml +Type: System.String +Parameter Sets: CreateRoleAssignmentArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoleDefinitionPrincipalId +List of role definition principal ids. + +```yaml +Type: System.String[] +Parameter Sets: CreateRoleAssignmentArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateFile +Location of the ARM template file on disk. + +```yaml +Type: System.String +Parameter Sets: CreateTemplateArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +Location of the ARM template parameter file on disk. + +```yaml +Type: System.String +Parameter Sets: CreateTemplateArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Type of the artifact. +There are 3 types supported: RoleAssignmentArtifact, PolicyAssignmentArtifact, TemplateArtifact. + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSArtifactKind +Parameter Sets: CreateTemplateArtifact, CreateRoleAssignmentArtifact, CreatePolicyArtifact +Aliases: +Accepted values: RoleAssignmentArtifact, PolicyAssignmentArtifact, TemplateArtifact + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Blueprint.Models.PSArtifactKind + +### Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase + +### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +### System.Collections.Hashtable + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Management.Blueprint.Models.Artifact + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Blueprint/New-AzBlueprintAssignment.md b/azps-10.1.0/Az.Blueprint/New-AzBlueprintAssignment.md new file mode 100644 index 0000000000..a4e19e1e9e --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/New-AzBlueprintAssignment.md @@ -0,0 +1,399 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Blueprint.dll-Help.xml +Module Name: Az.Blueprint +online version: https://learn.microsoft.com/powershell/module/az.blueprint/new-azblueprintassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/New-AzBlueprintAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/New-AzBlueprintAssignment.md +--- + +# New-AzBlueprintAssignment + +## SYNOPSIS +Assign a blueprint definition to a subscription or a management group. + +## SYNTAX + +### CreateBlueprintAssignment (Default) +``` +New-AzBlueprintAssignment -Name -Blueprint -Location + [-SystemAssignedIdentity] [-UserAssignedIdentity ] [-Lock ] + [-SecureStringParameter ] [-ResourceGroupParameter ] [-Parameter ] + [-ManagementGroupId ] [-SubscriptionId ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CreateBlueprintAssignmentByFile +``` +New-AzBlueprintAssignment -Name [-Blueprint ] [-AssignmentFile ] + [-ManagementGroupId ] [-SubscriptionId ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Assign a blueprint definition to a subscription. + +## EXAMPLES + +### Example 1 +```powershell +$rg = @{ResourceGroup=@{name='storage_rg';location='eastus'}} +$params = @{applytaganditsdefaultvalue_tagName="Department_Cost_Center"; applytaganditsdefaultvalue_tagValue="Contoso/RnD/Dev/986754"} +$blueprintObject = Get-AzBlueprint -SubscriptionId "00000000-1111-0000-1111-000000000000" -Name "myBlueprintName" +$secureString = @{mySecureStringParam=@{keyVaultId='/subscriptions/00000000-1111-0000-1111-000000000000/rsourcegroups/myResourceGroup/providers/Microsoft.Keyvault/Vaults/myKeyVault';secretName='mySecret';secretVersion='1.0'}} +New-AzBlueprintAssignment -Name "myAssignment" -Blueprint $blueprintObject -SubscriptionId "00000000-1111-0000-1111-000000000000" -Location "West US" -ResourceGroupParameter $rg -Parameter $params -SecureStringParameter $secureString +``` + +```output +Name : myAssignment +Id : /subscriptions/00000000-1111-0000-1111-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/myAssignment +Scope : /subscriptions/00000000-1111-0000-1111-000000000000 +LastModified : 2019-01-08 +LockMode : None +ProvisioningState : Creating +Parameters : {applytaganditsdefaultvalue_tagName, applytaganditsdefaultvalue_tagValue} +ResourceGroups : ResourceGroup +``` + +Create a new blueprint assignment of the blueprint definition `$blueprintObject` within the specified subscription using the defined parameter and resource group dictionary. Uses system-assigned identity. The location defines the region for creating the managed identity. + +### Example 2 +```powershell +New-AzBlueprintAssignment -Name "myAssignment" -Blueprint $blueprintObject -SubscriptionId 00000000-1111-0000-1111-000000000000 -Location "West US" -Parameter @{P1="v1"; P2="v2"} -Lock AllResourcesReadOnly +``` + +Create a new blueprint assignment of the blueprint definition `$blueprintObject` within the specified subscription using the defined parameter and resource group dictionary and configuring resource locking to **AllResources**. Defaults to using system-assigned identity. The location defines the region for creating the managed identity. + +### Example 3 +```powershell +New-AzBlueprintAssignment -Name "myAssignment" -Blueprint $blueprintObject -SubscriptionId 00000000-1111-0000-1111-000000000000 -Location "West US" -Parameter @{P1="v1"; P2="v2"} -UserAssignedIdentity "/subscriptions/00000000-1111-0000-1111-000000000000/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-user-defined-identity" +``` + +Create a new blueprint assignment of the blueprint definition `$blueprintObject` within the specified subscription using the defined parameter and resource group dictionary using the specified user-assigned identity id. + +### Example 4 +```powershell +$blueprintObject = Get-AzBlueprint -SubscriptionId "00000000-1111-0000-1111-000000000000" -Name "myBlueprintName" +New-AzBlueprintAssignment -Name "myAssignment" -Blueprint $blueprintObject -SubscriptionId "00000000-1111-0000-1111-000000000000" -AssignmentFile C:\myAssignmentfile.json +``` + +```output +Name : myAssignment +Id : /subscriptions/00000000-1111-0000-1111-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/myAssignment +Scope : /subscriptions/00000000-1111-0000-1111-000000000000 +LastModified : 2019-01-08 +LockMode : None +ProvisioningState : Creating +Parameters : {applytaganditsdefaultvalue_tagName, applytaganditsdefaultvalue_tagValue} +ResourceGroups : ResourceGroup +``` + +Create a blueprint assignment through an assignment file. The format of the assignment file can be found in the request/response samples at: https://github.com/Azure/azure-rest-api-specs/tree/master/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples + +### Example 5 +```powershell +$blueprintObject = Get-AzBlueprint -SubscriptionId "myManagementGroup" -Name "myBlueprintName" +New-AzBlueprintAssignment -Name "myAssignment" -Blueprint $blueprintObject -ManagementGroupId "myManagementGroup" -SubscriptionId 00000000-1111-0000-1111-000000000000 -Location "West US" -Parameter @{P1="v1"; P2="v2"} +``` + +Create a new blueprint assignment of the blueprint definition `$blueprintObject` targeting the specified subscription within the specified management group using the defined parameter. + +## PARAMETERS + +### -AssignmentFile +Location of the assignment file in JSON format on disk. + +```yaml +Type: System.String +Parameter Sets: CreateBlueprintAssignmentByFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Blueprint +Blueprint definition object. + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase +Parameter Sets: CreateBlueprintAssignment +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase +Parameter Sets: CreateBlueprintAssignmentByFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Region for managed identity to be created in. +Learn more at aka.ms/blueprintmsi + +```yaml +Type: System.String +Parameter Sets: CreateBlueprintAssignment +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Lock +Lock resources. +Learn more at aka.ms/blueprintlocks + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Blueprint.Models.PSLockMode] +Parameter Sets: CreateBlueprintAssignment +Aliases: +Accepted values: None, AllResourcesReadOnly, AllResourcesDoNotDelete + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The ID of the management group where the Blueprint assignment(s) will be saved. + +```yaml +Type: System.String +Parameter Sets: CreateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: CreateBlueprintAssignmentByFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Blueprint assignment name. + +```yaml +Type: System.String +Parameter Sets: CreateBlueprintAssignment +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: CreateBlueprintAssignmentByFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameter +Artifact parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupParameter +Hashtable of parameters to pass to the resource group artifact. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecureStringParameter +Secure string parameter for KeyVault resource id, name and version. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id to assign the blueprint definition. +Can be a comma delimited list of subscriptionId strings. + +```yaml +Type: System.String[] +Parameter Sets: CreateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String[] +Parameter Sets: CreateBlueprintAssignmentByFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SystemAssignedIdentity +System assigned identity(MSI) to deploy the artifacts. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +User assigned identity(MSI) to deploy the artifacts. + +```yaml +Type: System.String +Parameter Sets: CreateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase + +### System.String[] + +### System.Collections.Hashtable + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Blueprint/Publish-AzBlueprint.md b/azps-10.1.0/Az.Blueprint/Publish-AzBlueprint.md new file mode 100644 index 0000000000..ef92828829 --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/Publish-AzBlueprint.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Blueprint.dll-Help.xml +Module Name: Az.Blueprint +online version: https://learn.microsoft.com/powershell/module/az.blueprint/publish-azblueprint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Publish-AzBlueprint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Publish-AzBlueprint.md +--- + +# Publish-AzBlueprint + +## SYNOPSIS +Publish a new version of a blueprint. + +## SYNTAX + +``` +Publish-AzBlueprint -Version [-ChangeNote ] -Blueprint + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Publish a new version of a blueprint definition. + +## EXAMPLES + +### Example 1 +```powershell +Publish-AzBlueprint -Blueprint $bp -Version 1.0 +``` + +```output +Name : SimpleBlueprint +Id : /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprints/SimpleBlueprint/versions/1.0 +SubscriptionId : 00000000-1111-0000-1111-000000000000 +Version : 1.0 +Description : My simple blueprint +TimeCreated : 2019-05-30 +TargetScope : Subscription +Parameters : {[tagName, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue], [tagValue, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue]} +ResourceGroups : {storageRG} +``` + +Publish a new version of a blueprint definition. + +## PARAMETERS + +### -Blueprint +Blueprint object. + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSBlueprint +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ChangeNote +Notes to describe the contents of this blueprint version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version for the blueprint definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Blueprint.Models.PSBlueprint + +## OUTPUTS + +### Microsoft.Azure.Commands.Blueprint.Models.PSPublishedBlueprint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Blueprint/Remove-AzBlueprintAssignment.md b/azps-10.1.0/Az.Blueprint/Remove-AzBlueprintAssignment.md new file mode 100644 index 0000000000..00ac41c922 --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/Remove-AzBlueprintAssignment.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Blueprint.dll-Help.xml +Module Name: Az.Blueprint +online version: https://learn.microsoft.com/powershell/module/az.blueprint/remove-azblueprintassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Remove-AzBlueprintAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Remove-AzBlueprintAssignment.md +--- + +# Remove-AzBlueprintAssignment + +## SYNOPSIS +Remove a blueprint assignment from a subscription or a management group. + +## SYNTAX + +### BySubscriptionAndName (Default) +``` +Remove-AzBlueprintAssignment [-Name] [[-SubscriptionId] ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByManagementGroupAndName +``` +Remove-AzBlueprintAssignment [-Name] [-ManagementGroupId] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### DeleteBlueprintAssignmentByObject +``` +Remove-AzBlueprintAssignment -InputObject [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Remove a blueprint that has been assigned to a subscription. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzBlueprintAssignment -Name "myAssignment" -SubscriptionId "00000000-1111-0000-1111-000000000000" -Confirm +``` + +Remove the blueprint assignment specified by name from the specified subscription. The cmdlet will prompt for confirmation before executing the command. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Blueprint assignment object. + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintAssignment +Parameter Sets: DeleteBlueprintAssignmentByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagementGroupId +The ID of the management group where the Blueprint assignment is saved. + +```yaml +Type: System.String +Parameter Sets: ByManagementGroupAndName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Blueprint assignment name. + +```yaml +Type: System.String +Parameter Sets: BySubscriptionAndName, ByManagementGroupAndName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +When set, the cmdlet will return an object representing the removed Blueprint assignment. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id the blueprint assignment is deployed to. + +```yaml +Type: System.String +Parameter Sets: BySubscriptionAndName +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintAssignment[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Blueprint/Set-AzBlueprint.md b/azps-10.1.0/Az.Blueprint/Set-AzBlueprint.md new file mode 100644 index 0000000000..560616588f --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/Set-AzBlueprint.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Blueprint.dll-Help.xml +Module Name: Az.Blueprint +online version: https://learn.microsoft.com/powershell/module/az.blueprint/set-azblueprint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Set-AzBlueprint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Set-AzBlueprint.md +--- + +# Set-AzBlueprint + +## SYNOPSIS +Update a blueprint definition. + +## SYNTAX + +### UpdateBlueprintBySubscription (Default) +``` +Set-AzBlueprint -Name [-SubscriptionId ] -BlueprintFile + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### UpdateBlueprintByManagementGroup +``` +Set-AzBlueprint -Name -ManagementGroupId -BlueprintFile + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update a blueprint definition and save it within the specified subscription or management group. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzBlueprint -Name MyBlueprint -SubscriptionId 00000000-1111-0000-1111-000000000000 -BlueprintFile C:\Blueprint.json +``` + +```output +Name : SimpleBlueprint +Id : /providers/Microsoft.Management/managementGroups/{mgId}/providers/Microsoft.Blueprint/blueprints/SimpleBlueprint +ManagementGroupId : myManagementGroupId +Versions : +Description : test +TimeCreated : 2019-05-12 +TargetScope : Subscription +Parameters : {enforcetaganditsvalue_tagName, enforcetaganditsvalue_tagValue} +ResourceGroups : {AppNetworkRG} +``` + +Update a blueprint definition with new parameters. + +## PARAMETERS + +### -BlueprintFile +Path to a Blueprint JSON file on disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +Management Group Id where the blueprint definition is or will be saved. + +```yaml +Type: System.String +Parameter Sets: UpdateBlueprintByManagementGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Blueprint definition name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id where the blueprint definition is or will be saved. + +```yaml +Type: System.String +Parameter Sets: UpdateBlueprintBySubscription +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Blueprint.Models.PSBlueprint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Blueprint/Set-AzBlueprintArtifact.md b/azps-10.1.0/Az.Blueprint/Set-AzBlueprintArtifact.md new file mode 100644 index 0000000000..81e003fb16 --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/Set-AzBlueprintArtifact.md @@ -0,0 +1,394 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Blueprint.dll-Help.xml +Module Name: Az.Blueprint +online version: https://learn.microsoft.com/powershell/module/az.blueprint/set-azblueprintartifact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Set-AzBlueprintArtifact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Set-AzBlueprintArtifact.md +--- + +# Set-AzBlueprintArtifact + +## SYNOPSIS +Update an artifact in a blueprint definition. + +## SYNTAX + +### UpdateTemplateArtifact (Default) +``` +Set-AzBlueprintArtifact -Name -Type -Blueprint + [-Description ] [-DependsOn ] + -TemplateParameterFile -TemplateFile [-ResourceGroupName ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### UpdateArtifactByInputFile +``` +Set-AzBlueprintArtifact -Name -Blueprint -ArtifactFile + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### UpdateRoleAssignmentArtifact +``` +Set-AzBlueprintArtifact -Name -Type -Blueprint + [-Description ] [-DependsOn ] + -RoleDefinitionId -RoleDefinitionPrincipalId [-ResourceGroupName ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### UpdatePolicyAssignmentArtifact +``` +Set-AzBlueprintArtifact -Name -Type -Blueprint + [-Description ] [-DependsOn ] + -PolicyDefinitionId -PolicyDefinitionParameter [-ResourceGroupName ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update an artifact. There are two ways to update an artifact: either through an artifact JSON as an input file or through providing inline parameters for the artifact. +While the JSON method doesn't require type of the artifact to be provided inline parameter method requires user to provide the type of the artifact through -Type parameter. + +## EXAMPLES + +### Example 1 +```powershell +$bp = Get-AzBlueprint -Name SimpleBlueprint +Set-AzBlueprintArtifact -Name PolicyStorage -Blueprint $bp -ArtifactFile C:\PolicyAssignmentStorageTag.json +``` + +```output +DisplayName : +Description : Apply storage tag and the parameter also used by the template to resource groups +DependsOn : +PolicyDefinitionId : /providers/Microsoft.Authorization/policyDefinitions/49c88fc8-6fd1-46fd-a676-f12d1d3a4c71 +Parameters : {[tagName, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue], [tagValue, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue]} +ResourceGroup : +Id : /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprints/AppNetwork/artifacts/PolicyAssignmentStorageTag +Type : Microsoft.Blueprint/blueprints/artifacts +Name : PolicyAssignmentStorageTag +``` + +Update an artifact through an artifact JSON file. + +### Example 2 +```powershell +$bp = Get-AzBlueprint -Name SimpleBlueprint +Set-AzBlueprintArtifact -Type PolicyAssignmentArtifact -Name "ApplyTag-RG" -Blueprint $bp -PolicyDefinitionId "/providers/Microsoft.Authorization/policyDefinitions/49c88fc8-6fd1-46fd-a676-f12d1d3a4c71" -PolicyDefinitionParameter @{tagName="[parameters('tagName')]"; tagValue="[parameters('tagValue')]"} -ResourceGroupName storageRG +``` + +```output +DisplayName : ApplyTag-RG +Description : +DependsOn : +PolicyDefinitionId : /providers/Microsoft.Authorization/policyDefinitions/49c88fc8-6fd1-46fd-a676-f12d1d3a4c71 +Parameters : {[tagValue, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue], [tagName, + Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue]} +ResourceGroup : storageRG +Id : /subscriptions/28cbf98f-381d-4425-9ac4-cf342dab9753/providers/Microsoft.Blueprint/blueprints/AppNetwork/ + artifacts/ApplyTag-RG +Type : Microsoft.Blueprint/blueprints/artifacts +Name : ApplyTag-RG +``` + +Update an artifact through inline parameters. + +### Example 3 +```powershell +$bp = Get-AzBlueprint -Name SimpleBlueprint +Set-AzBlueprintArtifact -Type TemplateArtifact -Name storage-account -Blueprint $bp -TemplateFile C:\StorageAccountArmTemplate.json -ResourceGroupName "storageRG" -TemplateParameterFile C:\Workspace\BlueprintTemplates\RestTemplatesSomeInline\StorageAccountParameters.json +``` + +```output +DisplayName : storage-account +Description : +DependsOn : +Template : {$schema, contentVersion, parameters, variables...} +Parameters : {} +ResourceGroup : storageRG +Id : /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprints/AppNetwork/artifacts/storage-account +Type : Microsoft.Blueprint/blueprints/artifacts +Name : storage-account +``` + +Update an artifact through an ARM template file. + +## PARAMETERS + +### -ArtifactFile +Location of the artifact file in JSON format on disk. + +```yaml +Type: System.String +Parameter Sets: UpdateArtifactByInputFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Blueprint +Blueprint object. + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase +Parameter Sets: UpdateTemplateArtifact, UpdateRoleAssignmentArtifact, UpdatePolicyAssignmentArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase +Parameter Sets: UpdateArtifactByInputFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DependsOn +List of the names of artifacts that needs to be created before current artifact is created. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: UpdateTemplateArtifact, UpdateRoleAssignmentArtifact, UpdatePolicyAssignmentArtifact +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +Description of the artifact. + +```yaml +Type: System.String +Parameter Sets: UpdateTemplateArtifact, UpdateRoleAssignmentArtifact, UpdatePolicyAssignmentArtifact +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the artifact + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinitionId +Definition Id of the policy definition. + +```yaml +Type: System.String +Parameter Sets: UpdatePolicyAssignmentArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinitionParameter +Hashtable of parameters to pass to the policy definition artifact. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdatePolicyAssignmentArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group the artifact is going to be under. + +```yaml +Type: System.String +Parameter Sets: UpdateTemplateArtifact, UpdateRoleAssignmentArtifact, UpdatePolicyAssignmentArtifact +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoleDefinitionId +List of role definition + +```yaml +Type: System.String +Parameter Sets: UpdateRoleAssignmentArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoleDefinitionPrincipalId +List of role definition principal ids. + +```yaml +Type: System.String[] +Parameter Sets: UpdateRoleAssignmentArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateFile +Location of the ARM template file on disk. + +```yaml +Type: System.String +Parameter Sets: UpdateTemplateArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +Location of the ARM template parameter file on disk. + +```yaml +Type: System.String +Parameter Sets: UpdateTemplateArtifact +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Type of the artifact. +There are 3 types supported: RoleAssignmentArtifact, PolicyAssignmentArtifact, TemplateArtifact. + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSArtifactKind +Parameter Sets: UpdateTemplateArtifact, UpdateRoleAssignmentArtifact, UpdatePolicyAssignmentArtifact +Aliases: +Accepted values: RoleAssignmentArtifact, PolicyAssignmentArtifact, TemplateArtifact + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Blueprint.Models.PSArtifactKind + +### Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase + +### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +### System.Collections.Hashtable + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Management.Blueprint.Models.Artifact + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Blueprint/Set-AzBlueprintAssignment.md b/azps-10.1.0/Az.Blueprint/Set-AzBlueprintAssignment.md new file mode 100644 index 0000000000..fd3bf84c40 --- /dev/null +++ b/azps-10.1.0/Az.Blueprint/Set-AzBlueprintAssignment.md @@ -0,0 +1,384 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Blueprint.dll-Help.xml +Module Name: Az.Blueprint +online version: https://learn.microsoft.com/powershell/module/az.blueprint/set-azblueprintassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Set-AzBlueprintAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Blueprint/Blueprint/help/Set-AzBlueprintAssignment.md +--- + +# Set-AzBlueprintAssignment + +## SYNOPSIS +Update an existing blueprint assignment. + +## SYNTAX + +### UpdateBlueprintAssignment (Default) +``` +Set-AzBlueprintAssignment -Name -Blueprint -Location + [-SystemAssignedIdentity] [-UserAssignedIdentity ] [-Lock ] + [-SecureStringParameter ] [-ResourceGroupParameter ] [-Parameter ] + [-ManagementGroupId ] [-SubscriptionId ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateBlueprintAssignmentByFile +``` +Set-AzBlueprintAssignment -Name [-Blueprint ] [-AssignmentFile ] + [-ManagementGroupId ] [-SubscriptionId ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update an existing blueprint assignment. + +## EXAMPLES + +### Example 1 +```powershell +$rg = @{ResourceGroup=@{name='storage_rg';location='eastus'}} +$params = @{applytaganditsdefaultvalue_tagName="Department_Cost_Center"; applytaganditsdefaultvalue_tagValue="Contoso/HR/Dev/0001"} +$blueprintObject = Get-AzBlueprint -SubscriptionId "00000000-1111-0000-1111-000000000000" -Name "myBlueprintName" +Set-AzBlueprintAssignment -Name "myAssignment" -Blueprint $blueprintObject -SubscriptionId "00000000-1111-0000-1111-000000000000" -Location "West US" -Parameter $params -ResourceGroupParameter $rg -SystemAssignedIdentity +``` + +```output +Name : myAssignment +Id : /subscriptions/00000000-1111-0000-1111-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/myAssignment +Scope : /subscriptions/00000000-1111-0000-1111-000000000000 +LastModified : 2019-01-08 +LockMode : None +ProvisioningState : Creating +Parameters : {applytaganditsdefaultvalue_tagName, applytaganditsdefaultvalue_tagValue} +ResourceGroups : ResourceGroup +``` + +Update an existing blueprint assignment of the blueprint definition `$blueprintObject` within the specified subscription, updating the parameters. Uses system-assigned identity. The location defines the region for creating the managed identity. + +### Example 2 +```powershell +$blueprintObject = Get-AzBlueprint -SubscriptionId "00000000-1111-0000-1111-000000000000" -Name "myBlueprintName" +Set-AzBlueprintAssignment -Name "myAssignment" -Blueprint $blueprintObject -SubscriptionId "00000000-1111-0000-1111-000000000000" -AssignmentFile C:\myAssignmentfile.json +``` + +```output +Name : myAssignment +Id : /subscriptions/00000000-1111-0000-1111-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/myAssignment +Scope : /subscriptions/00000000-1111-0000-1111-000000000000 +LastModified : 2019-01-08 +LockMode : None +ProvisioningState : Creating +Parameters : {applytaganditsdefaultvalue_tagName, applytaganditsdefaultvalue_tagValue} +ResourceGroups : ResourceGroup +``` + +Update an existing blueprint assignment through an assignment file. The format of the assignment file can be found in the request/response samples at: https://github.com/Azure/azure-rest-api-specs/tree/master/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples + +### Example 3 +```powershell +$blueprintObject = Get-AzBlueprint -ManagementGroupId "myManagementGroup" -Name "myBlueprintName" +Set-AzBlueprintAssignment -Name "myAssignment" -Blueprint $blueprintObject -ManagementGroupId "myManagementGroup" -SubscriptionId 00000000-1111-0000-1111-000000000000 -Location "West US" -Parameter @{P1="v1"; P2="v2"} +``` + +Update an existing blueprint assignment of the blueprint definition `$blueprintObject` targeting the specified subscription within the specified management group using the defined parameter. + +## PARAMETERS + +### -AssignmentFile +Location of the assignment file in JSON format on disk. + +```yaml +Type: System.String +Parameter Sets: UpdateBlueprintAssignmentByFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Blueprint +Blueprint object. + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase +Parameter Sets: UpdateBlueprintAssignment +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase +Parameter Sets: UpdateBlueprintAssignmentByFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Region for managed identity to be created in. +Learn more at aka.ms/blueprintmsi + +```yaml +Type: System.String +Parameter Sets: UpdateBlueprintAssignment +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Lock +Lock resources. +Learn more at aka.ms/blueprintlocks + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Blueprint.Models.PSLockMode] +Parameter Sets: UpdateBlueprintAssignment +Aliases: +Accepted values: None, AllResourcesReadOnly, AllResourcesDoNotDelete + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The ID of the management group where the Blueprint assignment(s) will be saved. + +```yaml +Type: System.String +Parameter Sets: UpdateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: UpdateBlueprintAssignmentByFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Blueprint assignment name. + +```yaml +Type: System.String +Parameter Sets: UpdateBlueprintAssignment +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: UpdateBlueprintAssignmentByFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameter +Artifact parameter. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupParameter +Hashtable of parameters to pass to the resource group artifact. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecureStringParameter +Secure string parameter for KeyVault resource id, name and version. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +SubscriptionId to assign the Blueprint. +Can be a comma delimited list of subscriptionId strings. + +```yaml +Type: System.String[] +Parameter Sets: UpdateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String[] +Parameter Sets: UpdateBlueprintAssignmentByFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SystemAssignedIdentity +System assigned identity(MSI) to deploy the artifacts. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +User assigned identity(MSI) to deploy the artifacts. + +```yaml +Type: System.String +Parameter Sets: UpdateBlueprintAssignment +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Blueprint.Models.PSBlueprintBase + +### System.String[] + +### System.Collections.Hashtable + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.BotService/Az.BotService.md b/azps-10.1.0/Az.BotService/Az.BotService.md new file mode 100644 index 0000000000..0e44287ed6 --- /dev/null +++ b/azps-10.1.0/Az.BotService/Az.BotService.md @@ -0,0 +1,42 @@ +--- +Module Name: Az.BotService +Module Guid: 0fbff4fb-215b-4aca-b867-d1acfecab531 +Download Help Link: https://learn.microsoft.com/powershell/module/az.botservice +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Az.BotService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Az.BotService.md +--- + +# Az.BotService Module +## Description +Microsoft Azure PowerShell: BotService cmdlets + +## Az.BotService Cmdlets +### [Export-AzBotServiceApp](Export-AzBotServiceApp.md) +Returns a BotService specified by the parameters. + +### [Get-AzBotService](Get-AzBotService.md) +Returns a BotService specified by the parameters. + +### [Get-AzBotServiceHostSetting](Get-AzBotServiceHostSetting.md) +Get per subscription settings needed to host bot in compute resource such as Azure App Service + +### [Initialize-AzBotServicePrepareDeploy](Initialize-AzBotServicePrepareDeploy.md) +Returns a BotService specified by the parameters. + +### [New-AzBotService](New-AzBotService.md) +Returns a BotService specified by the parameters. + +### [New-AzBotServiceDirectLineKey](New-AzBotServiceDirectLineKey.md) +Regenerates secret keys and returns them for the DirectLine Channel of a particular BotService resource + +### [Publish-AzBotServiceApp](Publish-AzBotServiceApp.md) +Returns a BotService specified by the parameters. + +### [Remove-AzBotService](Remove-AzBotService.md) +Deletes a Bot Service from the resource group. + +### [Update-AzBotService](Update-AzBotService.md) +Updates a Bot Service + diff --git a/azps-10.1.0/Az.BotService/Export-AzBotServiceApp.md b/azps-10.1.0/Az.BotService/Export-AzBotServiceApp.md new file mode 100644 index 0000000000..c13e73374c --- /dev/null +++ b/azps-10.1.0/Az.BotService/Export-AzBotServiceApp.md @@ -0,0 +1,135 @@ +--- +external help file: +Module Name: Az.BotService +online version: https://learn.microsoft.com/powershell/module/az.botservice/export-azbotserviceapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Export-AzBotServiceApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Export-AzBotServiceApp.md +--- + +# Export-AzBotServiceApp + +## SYNOPSIS +Returns a BotService specified by the parameters. + +## SYNTAX + +``` +Export-AzBotServiceApp [-Name ] [-ResourceGroupName ] [-SavePath ] + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Returns a BotService specified by the parameters. + +## EXAMPLES + +### Example 1: Download the BotService App folder +```powershell +Export-AzBotServiceApp -ResourceGroupName youriBotTest -name youriechobottest +``` + +```output +Parameter $SavePath not provided, defaulting to current working directory. + + Directory: D:\powershell\BotService\azure-powershell\src\BotService + +Mode LastWriteTime Length Name +---- ------------- ------ ---- +d---- 2020/12/15 1:45 PM youriechobottest +``` + +Download the BotService App folder + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Bot resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BotName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Bot resource group in the user subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SavePath + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.Api20220615Preview.IBot + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BotService/Get-AzBotService.md b/azps-10.1.0/Az.BotService/Get-AzBotService.md new file mode 100644 index 0000000000..f8343601c8 --- /dev/null +++ b/azps-10.1.0/Az.BotService/Get-AzBotService.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.BotService +online version: https://learn.microsoft.com/powershell/module/az.botservice/get-azbotservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Get-AzBotService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Get-AzBotService.md +--- + +# Get-AzBotService + +## SYNOPSIS +Returns a BotService specified by the parameters. + +## SYNTAX + +### List1 (Default) +``` +Get-AzBotService [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzBotService -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzBotService -InputObject [-DefaultProfile ] [] +``` + +### List +``` +Get-AzBotService -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Returns a BotService specified by the parameters. + +## EXAMPLES + +### Example 1: List by subscription +```powershell +Get-AzBotService +``` + +```output +Etag Kind Location Name SkuName SkuTier Zone +---- ---- -------- ---- ------- ------- ---- +"4f003041-0000-1800-0000-6281fec80000" bot global botTest1 F0 {} +"0d0018e1-0000-1800-0000-6371e9540000" bot global botTest2 F0 {} +"05000ef7-0000-0200-0000-5fd7065a0000" sdk global botTest3 S1 {} +"0600ef2b-0000-0200-0000-5fd727a70000" sdk global botTest4 S1 {} +``` + +Returns BotService resources belonging to current subscription. + +### Example 2: Get by Name and ResourceGroupName +```powershell +Get-AzBotService -Name botTest1 -ResourceGroupName botTest-rg +``` + +```output +Etag Kind Location Name SkuName SkuTier Zone +---- ---- -------- ---- ------- ------- ---- +"4f003041-0000-1800-0000-6281fec80000" bot global botTest1 F0 {} +``` + +Returns a BotService specified by Name and ResourceGroupName. + +### Example 3: GetViaIdentity +```powershell +Get-AzBotService -InputObject $botTest1 +``` + +```output +Etag Kind Location Name SkuName SkuTier Zone +---- ---- -------- ---- ------- ------- ---- +"4f003041-0000-1800-0000-6281fec80000" bot global botTest1 F0 {} +``` + +Returns a BotService specified by the input IBotServiceIdentity. + +### Example 4: List by resource group +```powershell +Get-AzBotService -ResourceGroupName botTest-rg +``` + +```output +Etag Kind Location Name SkuName SkuTier Zone +---- ---- -------- ---- ------- ------- ---- +"4f003041-0000-1800-0000-6281fec80000" bot global botTest1 F0 {} +"05000ef7-0000-0200-0000-5fd7065a0000" sdk global botTest3 S1 {} +``` + +Returns all the resources of a particular type belonging to a resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.IBotServiceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Bot resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: BotName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Bot resource group in the user subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.IBotServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.Api20220615Preview.IBot + +## 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 + - `[ChannelName ]`: The name of the Channel resource. + - `[ConnectionName ]`: The name of the Bot Service Connection Setting resource. + - `[Id ]`: Resource identity path + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName ]`: The name of the Bot resource group in the user subscription. + - `[ResourceName ]`: The name of the Bot resource. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BotService/Get-AzBotServiceHostSetting.md b/azps-10.1.0/Az.BotService/Get-AzBotServiceHostSetting.md new file mode 100644 index 0000000000..6ec493a9ac --- /dev/null +++ b/azps-10.1.0/Az.BotService/Get-AzBotServiceHostSetting.md @@ -0,0 +1,84 @@ +--- +external help file: +Module Name: Az.BotService +online version: https://learn.microsoft.com/powershell/module/az.botservice/get-azbotservicehostsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Get-AzBotServiceHostSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Get-AzBotServiceHostSetting.md +--- + +# Get-AzBotServiceHostSetting + +## SYNOPSIS +Get per subscription settings needed to host bot in compute resource such as Azure App Service + +## SYNTAX + +``` +Get-AzBotServiceHostSetting [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get per subscription settings needed to host bot in compute resource such as Azure App Service + +## EXAMPLES + +### Example 1: Get +```powershell +Get-AzBotServiceHostSetting +``` + +```output +BotOpenIdMetadata OAuthUrl ToBotFromChannelOpenIdMetadataUrl ToBotFromChannelTokenIssuer ToBotFromEmulatorOpenIdMetadataUrl ToChannelFromBotLoginUrl ToChannelFromBotOAuthScope +----------------- -------- --------------------------------- --------------------------- ---------------------------------- ------------------------ -------------------------- +``` + +Get per subscription settings needed to host bot in compute resource such as Azure App Service + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.Api20220615Preview.IHostSettingsResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BotService/Initialize-AzBotServicePrepareDeploy.md b/azps-10.1.0/Az.BotService/Initialize-AzBotServicePrepareDeploy.md new file mode 100644 index 0000000000..dfc62381bf --- /dev/null +++ b/azps-10.1.0/Az.BotService/Initialize-AzBotServicePrepareDeploy.md @@ -0,0 +1,125 @@ +--- +external help file: +Module Name: Az.BotService +online version: https://learn.microsoft.com/powershell/module/az.botservice/initialize-azbotservicepreparedeploy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Initialize-AzBotServicePrepareDeploy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Initialize-AzBotServicePrepareDeploy.md +--- + +# Initialize-AzBotServicePrepareDeploy + +## SYNOPSIS +Returns a BotService specified by the parameters. + +## SYNTAX + +``` +Initialize-AzBotServicePrepareDeploy [-CodeDir ] [-Language ] [-ProjFileName ] + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Returns a BotService specified by the parameters. + +## EXAMPLES + +### Example 1: Initialize the Project FileFolder +```powershell +Initialize-AzBotServicePrepareDeploy -CodeDir D:\zips\MyEchoBot -ProjFileName MyEchoBot.csproj +``` + +Initialize Prepares a resource for use, and sets it to a default state + +## PARAMETERS + +### -CodeDir +The path to prepare a resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Language +The language could be C#, JavaScript or TypeScript. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjFileName +The project file name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.Api20220615Preview.IBot + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BotService/New-AzBotService.md b/azps-10.1.0/Az.BotService/New-AzBotService.md new file mode 100644 index 0000000000..ea00e636c6 --- /dev/null +++ b/azps-10.1.0/Az.BotService/New-AzBotService.md @@ -0,0 +1,335 @@ +--- +external help file: +Module Name: Az.BotService +online version: https://learn.microsoft.com/powershell/module/az.botservice/new-azbotservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/New-AzBotService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/New-AzBotService.md +--- + +# New-AzBotService + +## SYNOPSIS +Returns a BotService specified by the parameters. + +## SYNTAX + +### Registration (Default) +``` +New-AzBotService -ApplicationId -ResourceGroupName -Sku [-BotTemplateType ] + [-Description ] [-DisplayName ] [-Endpoint ] [-Language ] + [-Location ] [-Name ] [-Registration] [-ServerFarmLocation ] + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### WebApp +``` +New-AzBotService -ApplicationId -ApplicationSecret -ResourceGroupName + -Sku [-BotTemplateType ] [-Description ] [-ExistingServerFarmId ] + [-Language ] [-Location ] [-Name ] [-ServerFarmLocation ] + [-SubscriptionId ] [-Webapp] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Returns a BotService specified by the parameters. + +## EXAMPLES + +### Example 1: Create a new bot +```powershell +New-AzBotService -resourcegroupname BotTest-rg -name BotTest1 -ApplicationId "af5fce4d-ee68-4b25-be09-f3222582e133" -Location global -Sku F0 -Description "123134" -Registration +``` + +```output +Etag Kind Location Name SkuName SkuTier Zone +---- ---- -------- ---- ------- ------- ---- +"060085fb-0000-1800-0000-5fd71d7c0000" bot global BotTest1 F0 {} +``` + +Create a new Bot by ResourceGroupName and ApplicationId + +### Example 2: Create a new Web App +```powershell +New-AzBotService -resourcegroupname BotTest-rg -name BotTest2 -ApplicationId "b1ab1727-0465-4255-a1bb-976210af972c" -Location global -Sku F0 -Description "123134" -Webapp +``` + +```output +Etag Kind Location Name SkuName SkuTier Zone +---- ---- -------- ---- ------- ------- ---- +"06008351-0000-0200-0000-5fd732870000" sdk global BotTest2 F0 {} +``` + +Create a new Web App by ResourceGroupName and ApplicationId + +## PARAMETERS + +### -ApplicationId +Microsoft App Id for the bot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationSecret +Microsoft App secret generated by the corresponding Add Id + +```yaml +Type: System.Security.SecureString +Parameter Sets: WebApp +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BotTemplateType + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the bot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +DisplayName can be different from the bot Name. + +```yaml +Type: System.String +Parameter Sets: Registration +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The bot's endpoint + +```yaml +Type: System.String +Parameter Sets: Registration +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExistingServerFarmId +Provide this if required ServerFarm has been created. + +```yaml +Type: System.String +Parameter Sets: WebApp +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Language + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Bot resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BotName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Registration +Default kind of a bot. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Registration +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Bot resource group in the user subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerFarmLocation +Specifies the location of the server farm. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The sku name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Webapp + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WebApp +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.Api20220615Preview.IBot + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BotService/New-AzBotServiceDirectLineKey.md b/azps-10.1.0/Az.BotService/New-AzBotServiceDirectLineKey.md new file mode 100644 index 0000000000..661e847faf --- /dev/null +++ b/azps-10.1.0/Az.BotService/New-AzBotServiceDirectLineKey.md @@ -0,0 +1,187 @@ +--- +external help file: +Module Name: Az.BotService +online version: https://learn.microsoft.com/powershell/module/az.botservice/new-azbotservicedirectlinekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/New-AzBotServiceDirectLineKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/New-AzBotServiceDirectLineKey.md +--- + +# New-AzBotServiceDirectLineKey + +## SYNOPSIS +Regenerates secret keys and returns them for the DirectLine Channel of a particular BotService resource + +## SYNTAX + +``` +New-AzBotServiceDirectLineKey -ChannelName -ResourceGroupName + -ResourceName -Key -SiteName [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Regenerates secret keys and returns them for the DirectLine Channel of a particular BotService resource + +## EXAMPLES + +### Example 1: Regenerate directLine Key +```powershell +New-AzBotServiceDirectLineKey -ChannelName 'DirectLineChannel' -ResourceGroupName botTest-rg -ResourceName botTest1 -Key key1 -SiteName siteName +``` + +Regenerates secret keys and returns them for the DirectLine Channel of a particular BotService resource. + +## PARAMETERS + +### -ChannelName +The name of the Channel resource for which keys are to be regenerated. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BotService.Support.RegenerateKeysChannelName +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Key +Determines which key is to be regenerated + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BotService.Support.Key +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Bot resource group in the user subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the Bot resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteName +The site name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.Api20220615Preview.IBotChannel + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BotService/Publish-AzBotServiceApp.md b/azps-10.1.0/Az.BotService/Publish-AzBotServiceApp.md new file mode 100644 index 0000000000..dacc18eb74 --- /dev/null +++ b/azps-10.1.0/Az.BotService/Publish-AzBotServiceApp.md @@ -0,0 +1,124 @@ +--- +external help file: +Module Name: Az.BotService +online version: https://learn.microsoft.com/powershell/module/az.botservice/publish-azbotserviceapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Publish-AzBotServiceApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Publish-AzBotServiceApp.md +--- + +# Publish-AzBotServiceApp + +## SYNOPSIS +Returns a BotService specified by the parameters. + +## SYNTAX + +``` +Publish-AzBotServiceApp -CodeDir -Name -ResourceGroupName [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Returns a BotService specified by the parameters. + +## EXAMPLES + +### Example 1: Publish your BotService to Azure +```powershell +Publish-AzBotServiceApp -ResourceGroupName youriBotTest -CodeDir D:\zips\MyEchoBot -Name youriechobottest +``` + +Publish your BotService to Azure by code + +## PARAMETERS + +### -CodeDir +This parameter defines the Path of the ZIP + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +This parameter defines the name of the bot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BotService/Remove-AzBotService.md b/azps-10.1.0/Az.BotService/Remove-AzBotService.md new file mode 100644 index 0000000000..7ff3570d76 --- /dev/null +++ b/azps-10.1.0/Az.BotService/Remove-AzBotService.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.BotService +online version: https://learn.microsoft.com/powershell/module/az.botservice/remove-azbotservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Remove-AzBotService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Remove-AzBotService.md +--- + +# Remove-AzBotService + +## SYNOPSIS +Deletes a Bot Service from the resource group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzBotService -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzBotService -InputObject [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a Bot Service from the resource group. + +## EXAMPLES + +### Example 1: Delete the BotService By Name and ResourceGroupName +```powershell +Remove-AzBotService -Name youri-bot -ResourceGroupName youriBotTest +``` + +Delete the BotService By Name and ResourceGroupName + +### Example 2: Delete the BotService By InputObject +```powershell +$getservice = Get-AzBotService -Name youriechobottest -ResourceGroupName youriBotTest +Remove-AzBotService -InputObject $getservice +``` + +Delete the BotService By InputObject + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.IBotServiceIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Bot resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: BotName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Bot resource group in the user subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.IBotServiceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[ChannelName ]`: The name of the Channel resource. + - `[ConnectionName ]`: The name of the Bot Service Connection Setting resource. + - `[Id ]`: Resource identity path + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName ]`: The name of the Bot resource group in the user subscription. + - `[ResourceName ]`: The name of the Bot resource. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.BotService/Update-AzBotService.md b/azps-10.1.0/Az.BotService/Update-AzBotService.md new file mode 100644 index 0000000000..e8b456809c --- /dev/null +++ b/azps-10.1.0/Az.BotService/Update-AzBotService.md @@ -0,0 +1,700 @@ +--- +external help file: +Module Name: Az.BotService +online version: https://learn.microsoft.com/powershell/module/az.botservice/update-azbotservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Update-AzBotService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/BotService/help/Update-AzBotService.md +--- + +# Update-AzBotService + +## SYNOPSIS +Updates a Bot Service + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzBotService -Name -ResourceGroupName [-SubscriptionId ] + [-AllSetting ] [-AppPasswordHint ] [-CmekKeyVaultUrl ] [-Description ] + [-DeveloperAppInsightKey ] [-DeveloperAppInsightsApiKey ] + [-DeveloperAppInsightsApplicationId ] [-DisableLocalAuth] [-DisplayName ] + [-Endpoint ] [-Etag ] [-IconUrl ] [-IsCmekEnabled] [-IsStreamingSupported] + [-Kind ] [-Location ] [-LuisAppId ] [-LuisKey ] [-ManifestUrl ] + [-MsaAppId ] [-MsaAppMsiResourceId ] [-MsaAppTenantId ] [-MsaAppType ] + [-OpenWithHint ] [-Parameter ] [-PublicNetworkAccess ] + [-PublishingCredentials ] [-SchemaTransformationVersion ] [-SkuName ] + [-StorageResourceId ] [-Tag ] [-TenantId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzBotService -InputObject [-AllSetting ] [-AppPasswordHint ] + [-CmekKeyVaultUrl ] [-Description ] [-DeveloperAppInsightKey ] + [-DeveloperAppInsightsApiKey ] [-DeveloperAppInsightsApplicationId ] [-DisableLocalAuth] + [-DisplayName ] [-Endpoint ] [-Etag ] [-IconUrl ] [-IsCmekEnabled] + [-IsStreamingSupported] [-Kind ] [-Location ] [-LuisAppId ] [-LuisKey ] + [-ManifestUrl ] [-MsaAppId ] [-MsaAppMsiResourceId ] [-MsaAppTenantId ] + [-MsaAppType ] [-OpenWithHint ] [-Parameter ] + [-PublicNetworkAccess ] [-PublishingCredentials ] + [-SchemaTransformationVersion ] [-SkuName ] [-StorageResourceId ] [-Tag ] + [-TenantId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates a Bot Service + +## EXAMPLES + +### Example 1: Update the Bot by Name and ResourceGroupName +```powershell +Update-AzBotService -Name 'youri-apptest' -ResourceGroupName 'youriBotTest' -kind Bot +``` + +```output +Etag Kind Location Name SkuName SkuTier Zone +---- ---- -------- ---- ------- ------- ---- +"0700e71b-0000-1800-0000-5fd73ed80000" Bot global youri-apptest F0 {} +``` + +Update the Bot by Name and ResourceGroupName + +### Example 2: Update the Bot by InputObject +```powershell +$getAzbot = Get-AzBotService -Name 'youri-apptest' -ResourceGroupName 'youriBotTest' +Update-AzBotService -InputObject $getAzbot -kind sdk +``` + +```output +Etag Kind Location Name SkuName SkuTier Zone +---- ---- -------- ---- ------- ------- ---- +"07008b1c-0000-1800-0000-5fd73f9e0000" sdk global youri-apptest F0 {} +``` + +Update the Bot by InputObject + +## PARAMETERS + +### -AllSetting +Contains resource all settings defined as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppPasswordHint +The hint (e.g. +keyVault secret resourceId) on how to fetch the app secret + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CmekKeyVaultUrl +The CMK Url + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the bot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeveloperAppInsightKey +The Application Insights key + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeveloperAppInsightsApiKey +The Application Insights Api Key + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeveloperAppInsightsApplicationId +The Application Insights App Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The Name of the bot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The bot's endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Entity Tag + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IconUrl +The Icon Url of the bot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.IBotServiceIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsCmekEnabled +Whether Cmek is enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsStreamingSupported +Whether the bot is streaming supported + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Required. +Gets or sets the Kind of the resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BotService.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LuisAppId +Collection of LUIS App Ids + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LuisKey +The LUIS Key + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManifestUrl +The bot's manifest url + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsaAppId +Microsoft App Id for the bot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsaAppMsiResourceId +Microsoft App Managed Identity Resource Id for the bot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsaAppTenantId +Microsoft App Tenant Id for the bot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsaAppType +Microsoft App Type for the bot + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BotService.Support.MsaAppType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Bot resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: BotName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OpenWithHint +The hint to browser (e.g. +protocol handler) on how to open the bot for authoring + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Contains resource parameters defined as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Whether the bot is in an isolated network + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BotService.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishingCredentials +Publishing credentials of the resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Bot resource group in the user subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchemaTransformationVersion +The channel schema transformation version for the bot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The sku name + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.BotService.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageResourceId +The storage resourceId for the bot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Contains resource tags defined as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +The Tenant Id for the bot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.IBotServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.Api20220615Preview.IBot + +## 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 + - `[ChannelName ]`: The name of the Channel resource. + - `[ConnectionName ]`: The name of the Bot Service Connection Setting resource. + - `[Id ]`: Resource identity path + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName ]`: The name of the Bot resource group in the user subscription. + - `[ResourceName ]`: The name of the Bot resource. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Az.Cdn.md b/azps-10.1.0/Az.Cdn/Az.Cdn.md new file mode 100644 index 0000000000..068feed39e --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Az.Cdn.md @@ -0,0 +1,501 @@ +--- +Module Name: Az.Cdn +Module Guid: 91832aaa-dc11-4583-8239-bce5fd531604 +Download Help Link: https://learn.microsoft.com/powershell/module/az.cdn +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Az.Cdn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Az.Cdn.md +--- + +# Az.Cdn Module +## Description +Microsoft Azure PowerShell: Cdn cmdlets + +## Az.Cdn Cmdlets +### [Clear-AzCdnEndpointContent](Clear-AzCdnEndpointContent.md) +Removes a content from CDN. + +### [Clear-AzFrontDoorCdnEndpointContent](Clear-AzFrontDoorCdnEndpointContent.md) +Removes a content from AzureFrontDoor. + +### [Disable-AzCdnCustomDomainCustomHttps](Disable-AzCdnCustomDomainCustomHttps.md) +Disable https delivery of the custom domain. + +### [Enable-AzCdnCustomDomainCustomHttps](Enable-AzCdnCustomDomainCustomHttps.md) +Enable https delivery of the custom domain. + +### [Enable-AzFrontDoorCdnProfileMigration](Enable-AzFrontDoorCdnProfileMigration.md) +Commit the migrated Azure Front Door(Standard/Premium) profile.. + +### [Get-AzCdnCustomDomain](Get-AzCdnCustomDomain.md) +Gets an existing custom domain within an endpoint. + +### [Get-AzCdnEdgeNode](Get-AzCdnEdgeNode.md) +Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users. + +### [Get-AzCdnEndpoint](Get-AzCdnEndpoint.md) +Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +### [Get-AzCdnEndpointResourceUsage](Get-AzCdnEndpointResourceUsage.md) +Checks the quota and usage of geo filters and custom domains under the given endpoint. + +### [Get-AzCdnOrigin](Get-AzCdnOrigin.md) +Gets an existing origin within an endpoint. + +### [Get-AzCdnOriginGroup](Get-AzCdnOriginGroup.md) +Gets an existing origin group within an endpoint. + +### [Get-AzCdnProfile](Get-AzCdnProfile.md) +Gets an CDN profile with the specified profile name under the specified subscription and resource group. + +### [Get-AzCdnProfileResourceUsage](Get-AzCdnProfileResourceUsage.md) +Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile. + +### [Get-AzCdnProfileSupportedOptimizationType](Get-AzCdnProfileSupportedOptimizationType.md) +Gets the supported optimization types for the current profile. +A user can create an endpoint with an optimization type from the listed values. + +### [Get-AzCdnSubscriptionResourceUsage](Get-AzCdnSubscriptionResourceUsage.md) +Check the quota and actual usage of the CDN profiles under the given subscription. + +### [Get-AzFrontDoorCdnCustomDomain](Get-AzFrontDoorCdnCustomDomain.md) +Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile. + +### [Get-AzFrontDoorCdnEndpoint](Get-AzFrontDoorCdnEndpoint.md) +Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +### [Get-AzFrontDoorCdnEndpointResourceUsage](Get-AzFrontDoorCdnEndpointResourceUsage.md) +Checks the quota and actual usage of endpoints under the given Azure Front Door profile. + +### [Get-AzFrontDoorCdnOrigin](Get-AzFrontDoorCdnOrigin.md) +Gets an existing origin within an origin group. + +### [Get-AzFrontDoorCdnOriginGroup](Get-AzFrontDoorCdnOriginGroup.md) +Gets an existing origin group within a profile. + +### [Get-AzFrontDoorCdnOriginGroupResourceUsage](Get-AzFrontDoorCdnOriginGroupResourceUsage.md) +Checks the quota and actual usage of endpoints under the given Azure Front Door profile.. + +### [Get-AzFrontDoorCdnProfile](Get-AzFrontDoorCdnProfile.md) +Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group. + +### [Get-AzFrontDoorCdnProfileResourceUsage](Get-AzFrontDoorCdnProfileResourceUsage.md) +Checks the quota and actual usage of endpoints under the given Azure Front Door profile. + +### [Get-AzFrontDoorCdnRoute](Get-AzFrontDoorCdnRoute.md) +Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint. + +### [Get-AzFrontDoorCdnRule](Get-AzFrontDoorCdnRule.md) +Gets an existing delivery rule within a rule set. + +### [Get-AzFrontDoorCdnRuleSet](Get-AzFrontDoorCdnRuleSet.md) +Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile. + +### [Get-AzFrontDoorCdnRuleSetResourceUsage](Get-AzFrontDoorCdnRuleSetResourceUsage.md) +Checks the quota and actual usage of endpoints under the given Azure Front Door profile.. + +### [Get-AzFrontDoorCdnSecret](Get-AzFrontDoorCdnSecret.md) +Gets an existing Secret within a profile. + +### [Get-AzFrontDoorCdnSecurityPolicy](Get-AzFrontDoorCdnSecurityPolicy.md) +Gets an existing security policy within a profile. + +### [Import-AzCdnEndpointContent](Import-AzCdnEndpointContent.md) +Pre-loads a content to CDN. +Available for Verizon Profiles. + +### [New-AzCdnCustomDomain](New-AzCdnCustomDomain.md) +Creates a new custom domain within an endpoint. + +### [New-AzCdnDeliveryRuleCacheExpirationActionObject](New-AzCdnDeliveryRuleCacheExpirationActionObject.md) +Create an in-memory object for DeliveryRuleCacheExpirationAction. + +### [New-AzCdnDeliveryRuleCacheKeyQueryStringActionObject](New-AzCdnDeliveryRuleCacheKeyQueryStringActionObject.md) +Create an in-memory object for DeliveryRuleCacheKeyQueryStringAction. + +### [New-AzCdnDeliveryRuleCookiesConditionObject](New-AzCdnDeliveryRuleCookiesConditionObject.md) +Create an in-memory object for DeliveryRuleCookiesCondition. + +### [New-AzCdnDeliveryRuleHttpVersionConditionObject](New-AzCdnDeliveryRuleHttpVersionConditionObject.md) +Create an in-memory object for DeliveryRuleHttpVersionCondition. + +### [New-AzCdnDeliveryRuleIsDeviceConditionObject](New-AzCdnDeliveryRuleIsDeviceConditionObject.md) +Create an in-memory object for DeliveryRuleIsDeviceCondition. + +### [New-AzCdnDeliveryRuleObject](New-AzCdnDeliveryRuleObject.md) +Create an in-memory object for DeliveryRule. + +### [New-AzCdnDeliveryRulePostArgsConditionObject](New-AzCdnDeliveryRulePostArgsConditionObject.md) +Create an in-memory object for DeliveryRulePostArgsCondition. + +### [New-AzCdnDeliveryRuleQueryStringConditionObject](New-AzCdnDeliveryRuleQueryStringConditionObject.md) +Create an in-memory object for DeliveryRuleQueryStringCondition. + +### [New-AzCdnDeliveryRuleRemoteAddressConditionObject](New-AzCdnDeliveryRuleRemoteAddressConditionObject.md) +Create an in-memory object for DeliveryRuleRemoteAddressCondition. + +### [New-AzCdnDeliveryRuleRequestBodyConditionObject](New-AzCdnDeliveryRuleRequestBodyConditionObject.md) +Create an in-memory object for DeliveryRuleRequestBodyCondition. + +### [New-AzCdnDeliveryRuleRequestHeaderActionObject](New-AzCdnDeliveryRuleRequestHeaderActionObject.md) +Create an in-memory object for DeliveryRuleRequestHeaderAction. + +### [New-AzCdnDeliveryRuleRequestHeaderConditionObject](New-AzCdnDeliveryRuleRequestHeaderConditionObject.md) +Create an in-memory object for DeliveryRuleRequestHeaderCondition. + +### [New-AzCdnDeliveryRuleRequestMethodConditionObject](New-AzCdnDeliveryRuleRequestMethodConditionObject.md) +Create an in-memory object for DeliveryRuleRequestMethodCondition. + +### [New-AzCdnDeliveryRuleRequestSchemeConditionObject](New-AzCdnDeliveryRuleRequestSchemeConditionObject.md) +Create an in-memory object for DeliveryRuleRequestSchemeCondition. + +### [New-AzCdnDeliveryRuleRequestUriConditionObject](New-AzCdnDeliveryRuleRequestUriConditionObject.md) +Create an in-memory object for DeliveryRuleRequestUriCondition. + +### [New-AzCdnDeliveryRuleResponseHeaderActionObject](New-AzCdnDeliveryRuleResponseHeaderActionObject.md) +Create an in-memory object for DeliveryRuleResponseHeaderAction. + +### [New-AzCdnDeliveryRuleUrlFileExtensionConditionObject](New-AzCdnDeliveryRuleUrlFileExtensionConditionObject.md) +Create an in-memory object for DeliveryRuleUrlFileExtensionCondition. + +### [New-AzCdnDeliveryRuleUrlFileNameConditionObject](New-AzCdnDeliveryRuleUrlFileNameConditionObject.md) +Create an in-memory object for DeliveryRuleUrlFileNameCondition. + +### [New-AzCdnDeliveryRuleUrlPathConditionObject](New-AzCdnDeliveryRuleUrlPathConditionObject.md) +Create an in-memory object for DeliveryRuleUrlPathCondition. + +### [New-AzCdnEndpoint](New-AzCdnEndpoint.md) +Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +### [New-AzCdnHealthProbeParametersObject](New-AzCdnHealthProbeParametersObject.md) +Create an in-memory object for HealthProbeParameters. + +### [New-AzCdnLoadParametersObject](New-AzCdnLoadParametersObject.md) +Create an in-memory object for LoadParameters. + +### [New-AzCdnManagedHttpsParametersObject](New-AzCdnManagedHttpsParametersObject.md) +Create an in-memory object for CdnManagedHttpsParameters. + +### [New-AzCdnOrigin](New-AzCdnOrigin.md) +Creates a new origin within the specified endpoint. + +### [New-AzCdnOriginGroup](New-AzCdnOriginGroup.md) +Creates a new origin group within the specified endpoint. + +### [New-AzCdnOriginGroupOverrideActionObject](New-AzCdnOriginGroupOverrideActionObject.md) +Create an in-memory object for OriginGroupOverrideAction. + +### [New-AzCdnProfile](New-AzCdnProfile.md) +Creates an CDN profile with the specified profile name under the specified subscription and resource group. + +### [New-AzCdnPurgeParametersObject](New-AzCdnPurgeParametersObject.md) +Create an in-memory object for PurgeParameters. + +### [New-AzCdnResourceReferenceObject](New-AzCdnResourceReferenceObject.md) +Create an in-memory object for ResourceReference. + +### [New-AzCdnResponseBasedOriginErrorDetectionParametersObject](New-AzCdnResponseBasedOriginErrorDetectionParametersObject.md) +Create an in-memory object for ResponseBasedOriginErrorDetectionParameters. + +### [New-AzCdnUrlRedirectActionObject](New-AzCdnUrlRedirectActionObject.md) +Create an in-memory object for UrlRedirectAction. + +### [New-AzCdnUrlRewriteActionObject](New-AzCdnUrlRewriteActionObject.md) +Create an in-memory object for UrlRewriteAction. + +### [New-AzCdnUrlSigningActionObject](New-AzCdnUrlSigningActionObject.md) +Create an in-memory object for UrlSigningAction. + +### [New-AzCdnUserManagedHttpsParametersObject](New-AzCdnUserManagedHttpsParametersObject.md) +Create an in-memory object for UserManagedHttpsParameters. + +### [New-AzFrontDoorCdnCustomDomain](New-AzFrontDoorCdnCustomDomain.md) +Creates a new domain within the specified profile. + +### [New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject](New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject.md) +Create an in-memory object for AFDDomainHttpsParameters. + +### [New-AzFrontDoorCdnEndpoint](New-AzFrontDoorCdnEndpoint.md) +Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +### [New-AzFrontDoorCdnMigrationParametersObject](New-AzFrontDoorCdnMigrationParametersObject.md) +Create an in-memory object for MigrationParameters. + +### [New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject](New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject.md) +Create an in-memory object for MigrationWebApplicationFirewallMapping. + +### [New-AzFrontDoorCdnOrigin](New-AzFrontDoorCdnOrigin.md) +Creates a new origin within the specified origin group. + +### [New-AzFrontDoorCdnOriginGroup](New-AzFrontDoorCdnOriginGroup.md) +Creates a new origin group within the specified profile. + +### [New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject](New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject.md) +Create an in-memory object for HealthProbeParameters. + +### [New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject](New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject.md) +Create an in-memory object for LoadBalancingSettingsParameters. + +### [New-AzFrontDoorCdnProfile](New-AzFrontDoorCdnProfile.md) +Creates a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group. + +### [New-AzFrontDoorCdnProfileChangeSkuWafMappingObject](New-AzFrontDoorCdnProfileChangeSkuWafMappingObject.md) +Create an in-memory object for ProfileChangeSkuWafMapping. + +### [New-AzFrontDoorCdnProfileUpgradeParametersObject](New-AzFrontDoorCdnProfileUpgradeParametersObject.md) +Create an in-memory object for ProfileUpgradeParameters. + +### [New-AzFrontDoorCdnPurgeParametersObject](New-AzFrontDoorCdnPurgeParametersObject.md) +Create an in-memory object for AfdPurgeParameters. + +### [New-AzFrontDoorCdnResourceReferenceObject](New-AzFrontDoorCdnResourceReferenceObject.md) +Create an in-memory object for ResourceReference. + +### [New-AzFrontDoorCdnRoute](New-AzFrontDoorCdnRoute.md) +Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint. + +### [New-AzFrontDoorCdnRule](New-AzFrontDoorCdnRule.md) +Creates a new delivery rule within the specified rule set. + +### [New-AzFrontDoorCdnRuleClientPortConditionObject](New-AzFrontDoorCdnRuleClientPortConditionObject.md) +Create an in-memory object for DeliveryRuleClientPortCondition. + +### [New-AzFrontDoorCdnRuleCookiesConditionObject](New-AzFrontDoorCdnRuleCookiesConditionObject.md) +Create an in-memory object for DeliveryRuleCookiesCondition. + +### [New-AzFrontDoorCdnRuleHostNameConditionObject](New-AzFrontDoorCdnRuleHostNameConditionObject.md) +Create an in-memory object for DeliveryRuleHostNameCondition. + +### [New-AzFrontDoorCdnRuleHttpVersionConditionObject](New-AzFrontDoorCdnRuleHttpVersionConditionObject.md) +Create an in-memory object for DeliveryRuleHttpVersionCondition. + +### [New-AzFrontDoorCdnRuleIsDeviceConditionObject](New-AzFrontDoorCdnRuleIsDeviceConditionObject.md) +Create an in-memory object for DeliveryRuleIsDeviceCondition. + +### [New-AzFrontDoorCdnRulePostArgsConditionObject](New-AzFrontDoorCdnRulePostArgsConditionObject.md) +Create an in-memory object for DeliveryRulePostArgsCondition. + +### [New-AzFrontDoorCdnRuleQueryStringConditionObject](New-AzFrontDoorCdnRuleQueryStringConditionObject.md) +Create an in-memory object for DeliveryRuleQueryStringCondition. + +### [New-AzFrontDoorCdnRuleRemoteAddressConditionObject](New-AzFrontDoorCdnRuleRemoteAddressConditionObject.md) +Create an in-memory object for DeliveryRuleRemoteAddressCondition. + +### [New-AzFrontDoorCdnRuleRequestBodyConditionObject](New-AzFrontDoorCdnRuleRequestBodyConditionObject.md) +Create an in-memory object for DeliveryRuleRequestBodyCondition. + +### [New-AzFrontDoorCdnRuleRequestHeaderActionObject](New-AzFrontDoorCdnRuleRequestHeaderActionObject.md) +Create an in-memory object for DeliveryRuleRequestHeaderAction. + +### [New-AzFrontDoorCdnRuleRequestHeaderConditionObject](New-AzFrontDoorCdnRuleRequestHeaderConditionObject.md) +Create an in-memory object for DeliveryRuleRequestHeaderCondition. + +### [New-AzFrontDoorCdnRuleRequestMethodConditionObject](New-AzFrontDoorCdnRuleRequestMethodConditionObject.md) +Create an in-memory object for DeliveryRuleRequestMethodCondition. + +### [New-AzFrontDoorCdnRuleRequestSchemeConditionObject](New-AzFrontDoorCdnRuleRequestSchemeConditionObject.md) +Create an in-memory object for DeliveryRuleRequestSchemeCondition. + +### [New-AzFrontDoorCdnRuleRequestUriConditionObject](New-AzFrontDoorCdnRuleRequestUriConditionObject.md) +Create an in-memory object for DeliveryRuleRequestUriCondition. + +### [New-AzFrontDoorCdnRuleResponseHeaderActionObject](New-AzFrontDoorCdnRuleResponseHeaderActionObject.md) +Create an in-memory object for DeliveryRuleResponseHeaderAction. + +### [New-AzFrontDoorCdnRuleRouteConfigurationOverrideActionObject](New-AzFrontDoorCdnRuleRouteConfigurationOverrideActionObject.md) +Create an in-memory object for DeliveryRuleRouteConfigurationOverrideAction. + +### [New-AzFrontDoorCdnRuleServerPortConditionObject](New-AzFrontDoorCdnRuleServerPortConditionObject.md) +Create an in-memory object for DeliveryRuleServerPortCondition. + +### [New-AzFrontDoorCdnRuleSet](New-AzFrontDoorCdnRuleSet.md) +Creates a new rule set within the specified profile. + +### [New-AzFrontDoorCdnRuleSocketAddrConditionObject](New-AzFrontDoorCdnRuleSocketAddrConditionObject.md) +Create an in-memory object for DeliveryRuleSocketAddrCondition. + +### [New-AzFrontDoorCdnRuleSslProtocolConditionObject](New-AzFrontDoorCdnRuleSslProtocolConditionObject.md) +Create an in-memory object for DeliveryRuleSslProtocolCondition. + +### [New-AzFrontDoorCdnRuleUrlFileExtensionConditionObject](New-AzFrontDoorCdnRuleUrlFileExtensionConditionObject.md) +Create an in-memory object for DeliveryRuleUrlFileExtensionCondition. + +### [New-AzFrontDoorCdnRuleUrlFileNameConditionObject](New-AzFrontDoorCdnRuleUrlFileNameConditionObject.md) +Create an in-memory object for DeliveryRuleUrlFileNameCondition. + +### [New-AzFrontDoorCdnRuleUrlPathConditionObject](New-AzFrontDoorCdnRuleUrlPathConditionObject.md) +Create an in-memory object for DeliveryRuleUrlPathCondition. + +### [New-AzFrontDoorCdnRuleUrlRedirectActionObject](New-AzFrontDoorCdnRuleUrlRedirectActionObject.md) +Create an in-memory object for UrlRedirectAction. + +### [New-AzFrontDoorCdnRuleUrlRewriteActionObject](New-AzFrontDoorCdnRuleUrlRewriteActionObject.md) +Create an in-memory object for UrlRewriteAction. + +### [New-AzFrontDoorCdnRuleUrlSigningActionObject](New-AzFrontDoorCdnRuleUrlSigningActionObject.md) +Create an in-memory object for UrlSigningAction. + +### [New-AzFrontDoorCdnSecret](New-AzFrontDoorCdnSecret.md) +Creates a new Secret within the specified profile. + +### [New-AzFrontDoorCdnSecretCustomerCertificateParametersObject](New-AzFrontDoorCdnSecretCustomerCertificateParametersObject.md) +Create an in-memory object for CustomerCertificateParameters. + +### [New-AzFrontDoorCdnSecretFirstPartyManagedCertificateParametersObject](New-AzFrontDoorCdnSecretFirstPartyManagedCertificateParametersObject.md) +Create an in-memory object for AzureFirstPartyManagedCertificateParameters. + +### [New-AzFrontDoorCdnSecretManagedCertificateParametersObject](New-AzFrontDoorCdnSecretManagedCertificateParametersObject.md) +Create an in-memory object for ManagedCertificateParameters. + +### [New-AzFrontDoorCdnSecretUrlSigningKeyParametersObject](New-AzFrontDoorCdnSecretUrlSigningKeyParametersObject.md) +Create an in-memory object for UrlSigningKeyParameters. + +### [New-AzFrontDoorCdnSecurityPolicy](New-AzFrontDoorCdnSecurityPolicy.md) +Creates a new security policy within the specified profile. + +### [New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject](New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject.md) +Create an in-memory object for SecurityPolicyWebApplicationFirewallAssociation. + +### [New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject](New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject.md) +Create an in-memory object for SecurityPolicyWebApplicationFirewallParameters. + +### [Remove-AzCdnCustomDomain](Remove-AzCdnCustomDomain.md) +Deletes an existing custom domain within an endpoint. + +### [Remove-AzCdnEndpoint](Remove-AzCdnEndpoint.md) +Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +### [Remove-AzCdnOrigin](Remove-AzCdnOrigin.md) +Deletes an existing origin within an endpoint. + +### [Remove-AzCdnOriginGroup](Remove-AzCdnOriginGroup.md) +Deletes an existing origin group within an endpoint. + +### [Remove-AzCdnProfile](Remove-AzCdnProfile.md) +Deletes an existing CDN profile with the specified profile name under the specified subscription. +Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains. + +### [Remove-AzFrontDoorCdnCustomDomain](Remove-AzFrontDoorCdnCustomDomain.md) +Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile. + +### [Remove-AzFrontDoorCdnEndpoint](Remove-AzFrontDoorCdnEndpoint.md) +Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +### [Remove-AzFrontDoorCdnOrigin](Remove-AzFrontDoorCdnOrigin.md) +Deletes an existing origin within an origin group. + +### [Remove-AzFrontDoorCdnOriginGroup](Remove-AzFrontDoorCdnOriginGroup.md) +Deletes an existing origin group within a profile. + +### [Remove-AzFrontDoorCdnProfile](Remove-AzFrontDoorCdnProfile.md) +Deletes an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified parameters. +Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains. + +### [Remove-AzFrontDoorCdnRoute](Remove-AzFrontDoorCdnRoute.md) +Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint. + +### [Remove-AzFrontDoorCdnRule](Remove-AzFrontDoorCdnRule.md) +Deletes an existing delivery rule within a rule set. + +### [Remove-AzFrontDoorCdnRuleSet](Remove-AzFrontDoorCdnRuleSet.md) +Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile. + +### [Remove-AzFrontDoorCdnSecret](Remove-AzFrontDoorCdnSecret.md) +Deletes an existing Secret within profile. + +### [Remove-AzFrontDoorCdnSecurityPolicy](Remove-AzFrontDoorCdnSecurityPolicy.md) +Deletes an existing security policy within profile. + +### [Start-AzCdnEndpoint](Start-AzCdnEndpoint.md) +Starts an existing CDN endpoint that is on a stopped state. + +### [Start-AzFrontDoorCdnProfilePrepareMigration](Start-AzFrontDoorCdnProfilePrepareMigration.md) +Migrate the classic AFD instance to Azure Front Door(Standard/Premium) profile. +MigrationWebApplicationFirewallMapping should be associated if the front door has WAF policy. +Managed Identity should be associated if the frontdoor has Customer Certificates. +The change need to be committed after this. + +### [Stop-AzCdnEndpoint](Stop-AzCdnEndpoint.md) +Stops an existing running CDN endpoint. + +### [Stop-AzFrontDoorCdnProfileMigration](Stop-AzFrontDoorCdnProfileMigration.md) +Abort classic cdn migrate to AFDx. +Your new Front Door Profile will be deleted and your existing profile will remain active. +WAF policies will not be deleted. + +### [Test-AzCdnEndpointCustomDomain](Test-AzCdnEndpointCustomDomain.md) +Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS. + +### [Test-AzCdnNameAvailability](Test-AzCdnNameAvailability.md) +Check the availability of a resource name. +This is needed for resources where name is globally unique, such as a CDN endpoint. + +### [Test-AzCdnProbe](Test-AzCdnProbe.md) +Check if the probe path is a valid path and the file can be accessed. +Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. +This path is relative to the origin path specified in the endpoint configuration. + +### [Test-AzFrontDoorCdnEndpointCustomDomain](Test-AzFrontDoorCdnEndpointCustomDomain.md) +Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS. + +### [Test-AzFrontDoorCdnEndpointNameAvailability](Test-AzFrontDoorCdnEndpointNameAvailability.md) +Check the availability of a resource name. +This is needed for resources where name is globally unique, such as a afdx endpoint. + +### [Test-AzFrontDoorCdnProfileHostNameAvailability](Test-AzFrontDoorCdnProfileHostNameAvailability.md) +Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS. + +### [Test-AzFrontDoorCdnProfileMigration](Test-AzFrontDoorCdnProfileMigration.md) +Check if a classic AFD instance can be migrated to Azure Front Door(Standard/Premium) profile. + +### [Update-AzCdnEndpoint](Update-AzCdnEndpoint.md) +Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. +Only tags can be updated after creating an endpoint. +To update origins, use the Update Origin operation. +To update origin groups, use the Update Origin group operation. +To update custom domains, use the Update Custom Domain operation. + +### [Update-AzCdnOrigin](Update-AzCdnOrigin.md) +Updates an existing origin within an endpoint. + +### [Update-AzCdnOriginGroup](Update-AzCdnOriginGroup.md) +Updates an existing origin group within an endpoint. + +### [Update-AzCdnProfile](Update-AzCdnProfile.md) +Updates an existing CDN profile with the specified profile name under the specified subscription and resource group. + +### [Update-AzFrontDoorCdnCustomDomain](Update-AzFrontDoorCdnCustomDomain.md) +Updates an existing domain within a profile. + +### [Update-AzFrontDoorCdnCustomDomainValidationToken](Update-AzFrontDoorCdnCustomDomainValidationToken.md) +Updates the domain validation token. + +### [Update-AzFrontDoorCdnEndpoint](Update-AzFrontDoorCdnEndpoint.md) +Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. +Only tags can be updated after creating an endpoint. +To update origins, use the Update Origin operation. +To update origin groups, use the Update Origin group operation. +To update domains, use the Update Custom Domain operation. + +### [Update-AzFrontDoorCdnOrigin](Update-AzFrontDoorCdnOrigin.md) +Updates an existing origin within an origin group. + +### [Update-AzFrontDoorCdnOriginGroup](Update-AzFrontDoorCdnOriginGroup.md) +Updates an existing origin group within a profile. + +### [Update-AzFrontDoorCdnProfile](Update-AzFrontDoorCdnProfile.md) +Updates an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group. + +### [Update-AzFrontDoorCdnProfileSku](Update-AzFrontDoorCdnProfileSku.md) +Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor. + +### [Update-AzFrontDoorCdnRoute](Update-AzFrontDoorCdnRoute.md) +Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint. + +### [Update-AzFrontDoorCdnRule](Update-AzFrontDoorCdnRule.md) +Updates an existing delivery rule within a rule set. + +### [Update-AzFrontDoorCdnSecurityPolicy](Update-AzFrontDoorCdnSecurityPolicy.md) +Updates an existing security policy within a profile. + diff --git a/azps-10.1.0/Az.Cdn/Clear-AzCdnEndpointContent.md b/azps-10.1.0/Az.Cdn/Clear-AzCdnEndpointContent.md new file mode 100644 index 0000000000..f7f2f11b17 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Clear-AzCdnEndpointContent.md @@ -0,0 +1,307 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/clear-azcdnendpointcontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Clear-AzCdnEndpointContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Clear-AzCdnEndpointContent.md +--- + +# Clear-AzCdnEndpointContent + +## SYNOPSIS +Removes a content from CDN. + +## SYNTAX + +### PurgeExpanded1 (Default) +``` +Clear-AzCdnEndpointContent -EndpointName -ProfileName -ResourceGroupName + -ContentPath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Purge1 +``` +Clear-AzCdnEndpointContent -EndpointName -ProfileName -ResourceGroupName + -ContentFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### PurgeViaIdentity1 +``` +Clear-AzCdnEndpointContent -InputObject -ContentFilePath + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### PurgeViaIdentityExpanded1 +``` +Clear-AzCdnEndpointContent -InputObject -ContentPath [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Removes a content from CDN. + +## EXAMPLES + +### Example 1: Removes a content from CDN endpoint using Parameter "ContentPath" +```powershell +Clear-AzCdnEndpointContent -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -ContentPath @("/movies/*","/pictures/pic1.jpg") +``` + +Removes a content from CDN endpoint using Parameter "ContentPath" + +### Example 2: Removes a content from CDN endpoint using Parameter "ContentFilePath" +```powershell +$contentPath = @("/movies/amazing.mp4","/pictures/pic1.jpg") +$contentFilePath = New-AzCdnPurgeParametersObject -ContentPath $contentPath +Clear-AzCdnEndpointContent -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -ContentFilePath $contentFilePath +``` + +Removes a content from CDN endpoint using Parameter "ContentFilePath" + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentFilePath +Parameters required for content purge. +To construct, see NOTES section for CONTENTFILEPATH properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IPurgeParameters +Parameter Sets: Purge1, PurgeViaIdentity1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ContentPath +The path to the content to be purged. +Can describe a file path or a wild card directory. + +```yaml +Type: System.String[] +Parameter Sets: PurgeExpanded1, PurgeViaIdentityExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Purge1, PurgeExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: PurgeViaIdentity1, PurgeViaIdentityExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Purge1, PurgeExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Purge1, PurgeExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Purge1, PurgeExpanded1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IPurgeParameters + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`CONTENTFILEPATH `: Parameters required for content purge. + - `ContentPath `: The path to the content to be purged. Can describe a file path or a wild card directory. + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Clear-AzFrontDoorCdnEndpointContent.md b/azps-10.1.0/Az.Cdn/Clear-AzFrontDoorCdnEndpointContent.md new file mode 100644 index 0000000000..bbd308b930 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Clear-AzFrontDoorCdnEndpointContent.md @@ -0,0 +1,323 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/clear-azfrontdoorcdnendpointcontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Clear-AzFrontDoorCdnEndpointContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Clear-AzFrontDoorCdnEndpointContent.md +--- + +# Clear-AzFrontDoorCdnEndpointContent + +## SYNOPSIS +Removes a content from AzureFrontDoor. + +## SYNTAX + +### PurgeExpanded (Default) +``` +Clear-AzFrontDoorCdnEndpointContent -EndpointName -ProfileName -ResourceGroupName + -ContentPath [-SubscriptionId ] [-Domain ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Purge +``` +Clear-AzFrontDoorCdnEndpointContent -EndpointName -ProfileName -ResourceGroupName + -Content [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### PurgeViaIdentity +``` +Clear-AzFrontDoorCdnEndpointContent -InputObject -Content + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### PurgeViaIdentityExpanded +``` +Clear-AzFrontDoorCdnEndpointContent -InputObject -ContentPath [-Domain ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Removes a content from AzureFrontDoor. + +## EXAMPLES + +### Example 1: Clear the content of an AzureFrontDoor endpoint using Parameter "ContentPath" +```powershell +Clear-AzFrontDoorCdnEndpointContent -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 -ContentPath /a +``` + +Clear the content of an AzureFrontDoor endpoint using Parameter "ContentPath" + +### Example 2: Clear the content of an AzureFrontDoor endpoint using Parameter "Content" +```powershell +$contentPath = "/a" +$content = New-AzFrontDoorCdnPurgeParametersObject -ContentPath $contentPath +Clear-AzFrontDoorCdnEndpointContent -ResourceGroupName testps-rg-afdx -ProfileName cdn001 -EndpointName endpointTest001 -Content $content +``` + +Clear the content of an AzureFrontDoor endpoint using Parameter "Content" + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Content +Parameters required for content purge. +To construct, see NOTES section for CONTENT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdPurgeParameters +Parameter Sets: Purge, PurgeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ContentPath +The path to the content to be purged. +Can describe a file path or a wild card directory. + +```yaml +Type: System.String[] +Parameter Sets: PurgeExpanded, PurgeViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +List of domains. + +```yaml +Type: System.String[] +Parameter Sets: PurgeExpanded, PurgeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Purge, PurgeExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: PurgeViaIdentity, PurgeViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Purge, PurgeExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Purge, PurgeExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Purge, PurgeExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdPurgeParameters + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`CONTENT `: Parameters required for content purge. + - `ContentPath `: The path to the content to be purged. Can describe a file path or a wild card directory. + - `[Domain ]`: List of domains. + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Disable-AzCdnCustomDomainCustomHttps.md b/azps-10.1.0/Az.Cdn/Disable-AzCdnCustomDomainCustomHttps.md new file mode 100644 index 0000000000..f8cc865c88 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Disable-AzCdnCustomDomainCustomHttps.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/disable-azcdncustomdomaincustomhttps +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Disable-AzCdnCustomDomainCustomHttps.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Disable-AzCdnCustomDomainCustomHttps.md +--- + +# Disable-AzCdnCustomDomainCustomHttps + +## SYNOPSIS +Disable https delivery of the custom domain. + +## SYNTAX + +### Disable (Default) +``` +Disable-AzCdnCustomDomainCustomHttps -CustomDomainName -EndpointName -ProfileName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### DisableViaIdentity +``` +Disable-AzCdnCustomDomainCustomHttps -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Disable https delivery of the custom domain. + +## EXAMPLES + +### Example 1: Disable an AzureCDN custom domain under the AzureCDN endpoint +```powershell +Disable-AzCdnCustomDomainCustomHttps -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -CustomDomainName customdomain001 +``` + +Disable an AzureCDN custom domain under the AzureCDN endpoint + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDomainName +Name of the custom domain within an endpoint. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DisableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ICustomDomain + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Enable-AzCdnCustomDomainCustomHttps.md b/azps-10.1.0/Az.Cdn/Enable-AzCdnCustomDomainCustomHttps.md new file mode 100644 index 0000000000..ca021a11de --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Enable-AzCdnCustomDomainCustomHttps.md @@ -0,0 +1,280 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/enable-azcdncustomdomaincustomhttps +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Enable-AzCdnCustomDomainCustomHttps.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Enable-AzCdnCustomDomainCustomHttps.md +--- + +# Enable-AzCdnCustomDomainCustomHttps + +## SYNOPSIS +Enable https delivery of the custom domain. + +## SYNTAX + +### EnableViaIdentity (Default) +``` +Enable-AzCdnCustomDomainCustomHttps -InputObject + -CustomDomainHttpsParameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### Enable +``` +Enable-AzCdnCustomDomainCustomHttps -CustomDomainName -EndpointName -ProfileName + -ResourceGroupName -CustomDomainHttpsParameter + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Enable https delivery of the custom domain. + +## EXAMPLES + +### Example 1: Enable an AzureCDN custom domain under the AzureCDN endpoint +```powershell +$customDomainHttpsParameter = New-AzCdnManagedHttpsParametersObject -CertificateSourceParameterCertificateType Dedicated -CertificateSource Cdn -ProtocolType TLS12 +Enable-AzCdnCustomDomainCustomHttps -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -CustomDomainName customdomain001 -CustomDomainHttpsParameter $customDomainHttpsParameter +``` + +```output +Name ResourceGroupName +---- ----------------- +customdomain001 testps-rg-da16jm +``` + +Enable an AzureCDN custom domain under the AzureCDN endpoint + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDomainHttpsParameter +The JSON object that contains the properties to secure a custom domain. +To construct, see NOTES section for CUSTOMDOMAINHTTPSPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ICustomDomainHttpsParameters +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CustomDomainName +Name of the custom domain within an endpoint. + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: EnableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ICustomDomainHttpsParameters + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ICustomDomain + +## 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. + + +`CUSTOMDOMAINHTTPSPARAMETER `: The JSON object that contains the properties to secure a custom domain. + - `CertificateSource `: Defines the source of the SSL certificate. + - `ProtocolType `: Defines the TLS extension protocol that is used for secure delivery. + - `[MinimumTlsVersion ]`: TLS protocol version that will be used for Https + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Enable-AzFrontDoorCdnProfileMigration.md b/azps-10.1.0/Az.Cdn/Enable-AzFrontDoorCdnProfileMigration.md new file mode 100644 index 0000000000..dea4360046 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Enable-AzFrontDoorCdnProfileMigration.md @@ -0,0 +1,194 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/enable-azfrontdoorcdnprofilemigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Enable-AzFrontDoorCdnProfileMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Enable-AzFrontDoorCdnProfileMigration.md +--- + +# Enable-AzFrontDoorCdnProfileMigration + +## SYNOPSIS +Commit the migrated Azure Front Door(Standard/Premium) profile.. + +## SYNTAX + +``` +Enable-AzFrontDoorCdnProfileMigration -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Commit the migrated Azure Front Door(Standard/Premium) profile.. + +## EXAMPLES + +### Example 1: Commit the migrated Azure Front Door(Standard/Premium) profile. +```powershell +Enable-AzFrontDoorCdnProfileMigration -ProfileName name-migrated -ResourceGroupName rgName +``` + +Commit the migrated Azure Front Door(Standard/Premium) profile. + +### Example 2: Commit the migrated Azure Front Door(Standard/Premium) profile., when the subscription of the profile is different from the local subscrition +```powershell +Enable-AzFrontDoorCdnProfileMigration -ProfileName name-migrated -ResourceGroupName rgName -SubscriptionId testSubId01 +``` + +Commit the migrated Azure Front Door(Standard/Premium) profile., when the subscription of the profile is different from the local subscrition + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzCdnCustomDomain.md b/azps-10.1.0/Az.Cdn/Get-AzCdnCustomDomain.md new file mode 100644 index 0000000000..4be86a7f33 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzCdnCustomDomain.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azcdncustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnCustomDomain.md +--- + +# Get-AzCdnCustomDomain + +## SYNOPSIS +Gets an existing custom domain within an endpoint. + +## SYNTAX + +### List1 (Default) +``` +Get-AzCdnCustomDomain -EndpointName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get1 +``` +Get-AzCdnCustomDomain -EndpointName -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity1 +``` +Get-AzCdnCustomDomain -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an existing custom domain within an endpoint. + +## EXAMPLES + +### Example 1: List AzureCDN custom domains under the AzureCDN endpoint +```powershell +Get-AzCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 +``` + +```output +Name ResourceGroupName +---- ----------------- +customdomain001 testps-rg-da16jm +customdomain002 testps-rg-da16jm +``` + +List AzureCDN custom domains under the AzureCDN endpoint + +### Example 2: Get an AzureCDN custom domain under the AzureCDN endpoint +```powershell +Get-AzCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name customdomain001 +``` + +```output +Name ResourceGroupName +---- ----------------- +customdomain001 testps-rg-da16jm +``` + +Get an AzureCDN custom domain under the AzureCDN endpoint + +### Example 3: Get an AzureCDN custom domain under the AzureCDN endpoint via identity +```powershell +New-AzCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name customdomain010 -HostName 'testcm.dev.cdn.azure.cn' | Get-AzCdnCustomDomain +``` + +```output +Name ResourceGroupName +---- ----------------- +customdomain010 testps-rg-da16jm +``` + +Get an AzureCDN custom domain under the AzureCDN endpoint via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Get1, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the custom domain within an endpoint. + +```yaml +Type: System.String +Parameter Sets: Get1 +Aliases: CustomDomainName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get1, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get1, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get1, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ICustomDomain + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzCdnEdgeNode.md b/azps-10.1.0/Az.Cdn/Get-AzCdnEdgeNode.md new file mode 100644 index 0000000000..6174302a23 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzCdnEdgeNode.md @@ -0,0 +1,73 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azcdnedgenode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnEdgeNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnEdgeNode.md +--- + +# Get-AzCdnEdgeNode + +## SYNOPSIS +Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users. + +## SYNTAX + +``` +Get-AzCdnEdgeNode [-DefaultProfile ] [] +``` + +## DESCRIPTION +Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users. + +## EXAMPLES + +### Example 1: List AzureCDN Edge Noes +```powershell +Get-AzCdnEdgeNode +``` + +```output +Name +---- +Standard_Verizon +Premium_Verizon +Custom_Verizon +``` + +List AzureCDN Edge Noes + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IEdgeNode + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzCdnEndpoint.md b/azps-10.1.0/Az.Cdn/Get-AzCdnEndpoint.md new file mode 100644 index 0000000000..3c31de34a3 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzCdnEndpoint.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azcdnendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnEndpoint.md +--- + +# Get-AzCdnEndpoint + +## SYNOPSIS +Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +## SYNTAX + +### List1 (Default) +``` +Get-AzCdnEndpoint -ProfileName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get1 +``` +Get-AzCdnEndpoint -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity1 +``` +Get-AzCdnEndpoint -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +## EXAMPLES + +### Example 1: List AzureCDN Endpoints under the AzureCDN profile +```powershell +Get-AzCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +WestUs endptest001 testps-rg-da16jm +WestUs endptest002 testps-rg-da16jm +``` + +List AzureCDN Endpoints under the AzureCDN profile + +### Example 2: Get an AzureCDN Endpoint under the AzureCDN profile +```powershell +Get-AzCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -Name endptest001 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +WestUs endptest001 testps-rg-da16jm +``` + +Get an AzureCDN Endpoint under the AzureCDN profile + +### Example 3: Get an AzureCDN Endpoint under the AzureCDN profile via identity +```powershell +$origin = @{ + Name = "origin1" + HostName = "host1.hello.com" +}; + +New-AzCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -Name endptest010 -Location global -Origin $origin | Get-AzCdnEndpoint +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +Global endptest010 testps-rg-da16jm +``` + +Get an AzureCDN Endpoint under the AzureCDN profile via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Get1 +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get1, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get1, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get1, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IEndpoint + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzCdnEndpointResourceUsage.md b/azps-10.1.0/Az.Cdn/Get-AzCdnEndpointResourceUsage.md new file mode 100644 index 0000000000..d0b8c6db65 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzCdnEndpointResourceUsage.md @@ -0,0 +1,170 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azcdnendpointresourceusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnEndpointResourceUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnEndpointResourceUsage.md +--- + +# Get-AzCdnEndpointResourceUsage + +## SYNOPSIS +Checks the quota and usage of geo filters and custom domains under the given endpoint. + +## SYNTAX + +``` +Get-AzCdnEndpointResourceUsage -EndpointName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Checks the quota and usage of geo filters and custom domains under the given endpoint. + +## EXAMPLES + +### Example 1: List resource useages of an AzureCDN Endpoint under the AzureCDN profile +```powershell +Get-AzCdnEndpointResourceUsage -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 +``` + +```output +CurrentValue Limit ResourceType Unit +------------ ----- ------------ ---- +0 25 customdomain count +0 25 geofilter count +0 25 deliveryrule count +0 10 deliveryrulecondition count +0 5 deliveryruleaction count +1 10 origin count +1 10 origingroup count +1 10 originsPerOriginGroup count +``` + +List resource useages of an AzureCDN Endpoint under the AzureCDN profile + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IResourceUsage + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzCdnOrigin.md b/azps-10.1.0/Az.Cdn/Get-AzCdnOrigin.md new file mode 100644 index 0000000000..028d863071 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzCdnOrigin.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azcdnorigin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnOrigin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnOrigin.md +--- + +# Get-AzCdnOrigin + +## SYNOPSIS +Gets an existing origin within an endpoint. + +## SYNTAX + +### List1 (Default) +``` +Get-AzCdnOrigin -EndpointName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get1 +``` +Get-AzCdnOrigin -EndpointName -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity1 +``` +Get-AzCdnOrigin -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an existing origin within an endpoint. + +## EXAMPLES + +### Example 1: List AzureCDN origins under the AzureCDN endpoint +```powershell +Get-AzCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 +``` + +```output +Name ResourceGroupName +---- ----------------- +origin1 testps-rg-da16jm +origin2 testps-rg-da16jm +``` + +List AzureCDN origins under the AzureCDN endpoint + +### Example 2: Get an AzureCDN origin under the AzureCDN endpoint +```powershell +Get-AzCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name origin1 +``` + +```output +Name ResourceGroupName +---- ----------------- +origin1 testps-rg-da16jm +``` + +Get an AzureCDN origin under the AzureCDN endpoint + +### Example 3: Get an AzureCDN origin under the AzureCDN endpoint via identity +```powershell +New-AzCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest010 -Name origin1 -HostName "host1.hello.com" | Get-AzCdnOrigin +``` + +```output +Name Location ResourceGroupName +---- -------- ----------------- +origin1 testps-rg-da16jm +``` + +Get an AzureCDN origin under the AzureCDN endpoint via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Get1, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the origin which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: Get1 +Aliases: OriginName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get1, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get1, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get1, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IOrigin + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzCdnOriginGroup.md b/azps-10.1.0/Az.Cdn/Get-AzCdnOriginGroup.md new file mode 100644 index 0000000000..af4b5eead7 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzCdnOriginGroup.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azcdnorigingroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnOriginGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnOriginGroup.md +--- + +# Get-AzCdnOriginGroup + +## SYNOPSIS +Gets an existing origin group within an endpoint. + +## SYNTAX + +### List1 (Default) +``` +Get-AzCdnOriginGroup -EndpointName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get1 +``` +Get-AzCdnOriginGroup -EndpointName -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity1 +``` +Get-AzCdnOriginGroup -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an existing origin group within an endpoint. + +## EXAMPLES + +### Example 1: List AzureCDN origin groups under the AzureCDN endpoint +```powershell +Get-AzCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 +``` + +```output +Name ResourceGroupName +---- ----------------- +org001 testps-rg-da16jm +org002 testps-rg-da16jm +``` + +List AzureCDN origin groups under the AzureCDN endpoint + +### Example 2: Get an AzureCDN origin group under the AzureCDN endpoint +```powershell +Get-AzCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name org001 +``` + +```output +Name ResourceGroupName +---- ----------------- +org001 testps-rg-da16jm +``` + +Get an AzureCDN origin group under the AzureCDN endpoint + +### Example 3: Get an AzureCDN origin group under the AzureCDN endpoint via identity +```powershell +$healthProbeParameters = New-AzCdnHealthProbeParametersObject -ProbeIntervalInSecond 120 -ProbePath "/check-health.aspx" -ProbeProtocol "Http" -ProbeRequestType "HEAD" +$origin = Get-AzCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest010 -Name origin1 +New-AzCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest010 -Name org001 -HealthProbeSetting $healthProbeParameters -Origin @(@{ Id = $origin.Id }) | Get-AzCdnOriginGroup +``` + +```output +Name Location ResourceGroupName +---- -------- ----------------- +org001 testps-rg-da16jm +``` + +Get an AzureCDN origin group under the AzureCDN endpoint via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Get1, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the origin group which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: Get1 +Aliases: OriginGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get1, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get1, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get1, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IOriginGroup + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzCdnProfile.md b/azps-10.1.0/Az.Cdn/Get-AzCdnProfile.md new file mode 100644 index 0000000000..34679b5385 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzCdnProfile.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azcdnprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnProfile.md +--- + +# Get-AzCdnProfile + +## SYNOPSIS +Gets an CDN profile with the specified profile name under the specified subscription and resource group. + +## SYNTAX + +### List (Default) +``` +Get-AzCdnProfile [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzCdnProfile -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCdnProfile -InputObject [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzCdnProfile -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets an CDN profile with the specified profile name under the specified subscription and resource group. + +## EXAMPLES + +### Example 1: List AzureCDN profiles under the subscription +```powershell +Get-AzCdnProfile +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global p-oln142 cdn testps-rg-godj4q +Global cdn001 cdn testps-rg-da16jm +Global cdn002 cdn testps-rg-da16jm +``` + +List AzureCDN profiles under the subscription + +### Example 2: List AzureCDN profiles under the resource group +```powershell +Get-AzCdnProfile -ResourceGroupName testps-rg-da16jm +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global cdn001 cdn testps-rg-da16jm +Global cdn002 cdn testps-rg-da16jm +``` + +List AzureCDN profiles under the resource group + +### Example 3: Get an AzureCDN profile under the resource group +```powershell +Get-AzCdnProfile -ResourceGroupName testps-rg-da16jm -Name cdn001 +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global cdn001 cdn testps-rg-da16jm +``` + +Get an AzureCDN profile under the resource group + +### Example 4: Get an AzureCDN profile under the resource group via identity +```powershell +New-AzCdnProfile -ResourceGroupName testps-rg-da16jm -Name cdn001 -SkuName Standard_Microsoft -Location Global | Get-AzCdnProfile +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global cdn001 cdn testps-rg-da16jm +``` + +Get an AzureCDN profile under the resource group via identity + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IProfile + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzCdnProfileResourceUsage.md b/azps-10.1.0/Az.Cdn/Get-AzCdnProfileResourceUsage.md new file mode 100644 index 0000000000..c263ae441b --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzCdnProfileResourceUsage.md @@ -0,0 +1,148 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azcdnprofileresourceusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnProfileResourceUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnProfileResourceUsage.md +--- + +# Get-AzCdnProfileResourceUsage + +## SYNOPSIS +Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile. + +## SYNTAX + +``` +Get-AzCdnProfileResourceUsage -ProfileName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile. + +## EXAMPLES + +### Example 1: Get resource usages of an AzureCDN profile +```powershell +Get-AzCdnProfileResourceUsage -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 +``` + +```output +CurrentValue Limit ResourceType Unit +------------ ----- ------------ ---- +0 25 endpoint count +``` + +Get resource usages of an AzureCDN profile + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IResourceUsage + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzCdnProfileSupportedOptimizationType.md b/azps-10.1.0/Az.Cdn/Get-AzCdnProfileSupportedOptimizationType.md new file mode 100644 index 0000000000..2096e36cfb --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzCdnProfileSupportedOptimizationType.md @@ -0,0 +1,148 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azcdnprofilesupportedoptimizationtype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnProfileSupportedOptimizationType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnProfileSupportedOptimizationType.md +--- + +# Get-AzCdnProfileSupportedOptimizationType + +## SYNOPSIS +Gets the supported optimization types for the current profile. +A user can create an endpoint with an optimization type from the listed values. + +## SYNTAX + +``` +Get-AzCdnProfileSupportedOptimizationType -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Gets the supported optimization types for the current profile. +A user can create an endpoint with an optimization type from the listed values. + +## EXAMPLES + +### Example 1: Gets the supported optimization types for the AzureCDN profile +```powershell +Get-AzCdnProfileSupportedOptimizationType -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 +``` + +```output +GeneralWebDelivery +``` + +Gets the supported optimization types for the AzureCDN profile + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.OptimizationType + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzCdnSubscriptionResourceUsage.md b/azps-10.1.0/Az.Cdn/Get-AzCdnSubscriptionResourceUsage.md new file mode 100644 index 0000000000..502f9f0e21 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzCdnSubscriptionResourceUsage.md @@ -0,0 +1,119 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azcdnsubscriptionresourceusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnSubscriptionResourceUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzCdnSubscriptionResourceUsage.md +--- + +# Get-AzCdnSubscriptionResourceUsage + +## SYNOPSIS +Check the quota and actual usage of the CDN profiles under the given subscription. + +## SYNTAX + +``` +Get-AzCdnSubscriptionResourceUsage [-SubscriptionId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Check the quota and actual usage of the CDN profiles under the given subscription. + +## EXAMPLES + +### Example 1: Get the quota and actual usage of the CDN profiles under the given subscription +```powershell +Get-AzCdnSubscriptionResourceUsage +``` + +```output +CurrentValue Limit ResourceType Unit +------------ ----- ------------ ---- +13 25 profile count +29 500 afdprofile count +``` + +Get the quota and actual usage of the CDN profiles under the given subscription + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IResourceUsage + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnCustomDomain.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnCustomDomain.md new file mode 100644 index 0000000000..b73c6bfaa9 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnCustomDomain.md @@ -0,0 +1,209 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdncustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnCustomDomain.md +--- + +# Get-AzFrontDoorCdnCustomDomain + +## SYNOPSIS +Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile. + +## SYNTAX + +### List (Default) +``` +Get-AzFrontDoorCdnCustomDomain -ProfileName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzFrontDoorCdnCustomDomain -CustomDomainName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzFrontDoorCdnCustomDomain -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile. + +## EXAMPLES + +### Example 1: List AzureFrontDoor customdomains under the profile +```powershell +Get-AzFrontDoorCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 +``` + +```output +Name ResourceGroupName +---- ----------------- +domain001 testps-rg-da16jm +domain002 testps-rg-da16jm +``` + +List AzureFrontDoor customdomains under the profile + +### Example 2: Get an AzureFrontDoor customdomain under the profile +```powershell +Get-AzFrontDoorCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -CustomDomainName domain001 +``` + +```output +Name ResourceGroupName +---- ----------------- +domain001 testps-rg-da16jm +``` + +Get an AzureFrontDoor customdomain under the profile + +### Example 2: Get an AzureFrontDoor customdomain under the profile via identity +```powershell +New-AzFrontDoorCdnCustomDomain -CustomDomainName domain001 -ProfileName fdp-v542q6 -ResourceGroupName testps-rg-da16jm -HostName "pstest001.dev.cdn.azure.cn"| Get-AzFrontDoorCdnCustomDomain +``` + +```output +Name ResourceGroupName +---- ----------------- +domain001 testps-rg-da16jm +``` + +Get an AzureFrontDoor customdomain under the profile via identity + +## PARAMETERS + +### -CustomDomainName +Name of the domain under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdDomain + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnEndpoint.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnEndpoint.md new file mode 100644 index 0000000000..3bc58b99da --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnEndpoint.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdnendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnEndpoint.md +--- + +# Get-AzFrontDoorCdnEndpoint + +## SYNOPSIS +Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +## SYNTAX + +### List (Default) +``` +Get-AzFrontDoorCdnEndpoint -ProfileName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzFrontDoorCdnEndpoint -EndpointName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzFrontDoorCdnEndpoint -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +## EXAMPLES + +### Example 1: List AzureFrontDoor endpoints under the profile +```powershell +Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +Global end001 testps-rg-da16jm +Global end002 testps-rg-da16jm +``` + +List AzureFrontDoor endpoints under the profile + +### Example 2: Get an AzureFrontDoor endpoint under the profile +```powershell +Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +Global end001 testps-rg-da16jm +``` + +Get an AzureFrontDoor endpoint under the profile + +### Example 2: Get an AzureFrontDoor endpoint under the profile via identity +```powershell +New-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end011 -Location Global -EnabledState Enabled +| Get-AzFrontDoorCdnEndpoint +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +Global end011 testps-rg-da16jm +``` + +Get an AzureFrontDoor endpoint under the profile via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdEndpoint + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnEndpointResourceUsage.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnEndpointResourceUsage.md new file mode 100644 index 0000000000..410dbd0249 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnEndpointResourceUsage.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdnendpointresourceusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnEndpointResourceUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnEndpointResourceUsage.md +--- + +# Get-AzFrontDoorCdnEndpointResourceUsage + +## SYNOPSIS +Checks the quota and actual usage of endpoints under the given Azure Front Door profile. + +## SYNTAX + +``` +Get-AzFrontDoorCdnEndpointResourceUsage -EndpointName -ProfileName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Checks the quota and actual usage of endpoints under the given Azure Front Door profile. + +## EXAMPLES + +### Example 1: List resource useages of an AzureFrontDoor endpoint under the profile +```powershell +Get-AzFrontDoorCdnEndpointResourceUsage -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 +``` + +```output +CurrentValue Limit Unit +------------ ----- ---- +1 100 count +``` + +List resource useages of an AzureFrontDoor endpoint under the profile + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IUsage + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnOrigin.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnOrigin.md new file mode 100644 index 0000000000..26ef641711 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnOrigin.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdnorigin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnOrigin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnOrigin.md +--- + +# Get-AzFrontDoorCdnOrigin + +## SYNOPSIS +Gets an existing origin within an origin group. + +## SYNTAX + +### List (Default) +``` +Get-AzFrontDoorCdnOrigin -OriginGroupName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzFrontDoorCdnOrigin -OriginGroupName -OriginName -ProfileName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzFrontDoorCdnOrigin -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an existing origin within an origin group. + +## EXAMPLES + +### Example 1: List AzureFrontDoor origins under the origin group +```powershell + Get-AzFrontDoorCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 +``` + +```output +Name ResourceGroupName +---- ----------------- +ori001 testps-rg-da16jm +ori002 testps-rg-da16jm +``` + +List AzureFrontDoor origins under the origin group + +### Example 2: Get an AzureFrontDoor origin under the origin group +```powershell +Get-AzFrontDoorCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -OriginName ori001 +``` + +```output +Name ResourceGroupName +---- ----------------- +ori001 testps-rg-da16jm +``` + +Get an AzureFrontDoor origin under the origin group + +### Example 3: Get an AzureFrontDoor origin under the origin group via identity +```powershell +New-AzFrontDoorCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -OriginName ori001 -OriginHostHeader en.wikipedia.org -HostName en.wikipedia.org -HttpPort 80 -HttpsPort 443 -Priority 1 -Weight 1000 | Get-AzFrontDoorCdnOrigin +``` + +```output +Name ResourceGroupName +---- ----------------- +ori001 testps-rg-da16jm +``` + +Get an AzureFrontDoor origin under the origin group via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OriginGroupName +Name of the origin group which is unique within the profile. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginName +Name of the origin which is unique within the profile. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdOrigin + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnOriginGroup.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnOriginGroup.md new file mode 100644 index 0000000000..d24e4297c0 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnOriginGroup.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdnorigingroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnOriginGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnOriginGroup.md +--- + +# Get-AzFrontDoorCdnOriginGroup + +## SYNOPSIS +Gets an existing origin group within a profile. + +## SYNTAX + +### List (Default) +``` +Get-AzFrontDoorCdnOriginGroup -ProfileName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzFrontDoorCdnOriginGroup -OriginGroupName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzFrontDoorCdnOriginGroup -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an existing origin group within a profile. + +## EXAMPLES + +### Example 1: List AzureFrontDoor origin groups under the profile +```powershell +Get-AzFrontDoorCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 +``` + +```output +Name ResourceGroupName +---- ----------------- +org001 testps-rg-da16jm +org002 testps-rg-da16jm +``` + +List AzureFrontDoor origin groups under the profile + +### Example 2: Get an AzureFrontDoor origin group under the profile +```powershell +Get-AzFrontDoorCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 +``` + +```output +Name ResourceGroupName +---- ----------------- +org001 testps-rg-da16jm +``` + +Get an AzureFrontDoor origin group under the profile + +### Example 3: Get an AzureFrontDoor origin group under the profile via identity +```powershell +$healthProbeSetting = New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject -ProbeIntervalInSecond 1 -ProbePath "/" -ProbeProtocol "Https" -ProbeRequestType "GET" +$loadBalancingSetting = New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject -AdditionalLatencyInMillisecond 200 -SampleSize 5 -SuccessfulSamplesRequired 4 +New-AzFrontDoorCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -LoadBalancingSetting $loadBalancingSetting -HealthProbeSetting $healthProbeSetting | Get-AzFrontDoorCdnOriginGroup +``` + +```output +Name ResourceGroupName +---- ----------------- +org001 testps-rg-da16jm +``` + +Get an AzureFrontDoor origin group under the profile via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OriginGroupName +Name of the origin group which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdOriginGroup + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnOriginGroupResourceUsage.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnOriginGroupResourceUsage.md new file mode 100644 index 0000000000..11247fe695 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnOriginGroupResourceUsage.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdnorigingroupresourceusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnOriginGroupResourceUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnOriginGroupResourceUsage.md +--- + +# Get-AzFrontDoorCdnOriginGroupResourceUsage + +## SYNOPSIS +Checks the quota and actual usage of endpoints under the given Azure Front Door profile.. + +## SYNTAX + +``` +Get-AzFrontDoorCdnOriginGroupResourceUsage -OriginGroupName -ProfileName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Checks the quota and actual usage of endpoints under the given Azure Front Door profile.. + +## EXAMPLES + +### Example 1: List resource useages of an AzureFrontDoor origin group under the profile +```powershell +Get-AzFrontDoorCdnOriginGroupResourceUsage -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 +``` + +```output +CurrentValue Limit Unit +------------ ----- ---- +1 50 count +``` + +List resource useages of an AzureFrontDoor origin group under the profile + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginGroupName +Name of the origin group which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IUsage + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnProfile.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnProfile.md new file mode 100644 index 0000000000..098bafc198 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnProfile.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdnprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnProfile.md +--- + +# Get-AzFrontDoorCdnProfile + +## SYNOPSIS +Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group. + +## SYNTAX + +### List (Default) +``` +Get-AzFrontDoorCdnProfile [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzFrontDoorCdnProfile -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzFrontDoorCdnProfile -InputObject [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzFrontDoorCdnProfile -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group. + +## EXAMPLES + +### Example 1: List AzureFrontDoor profiles under the subscription +```powershell +Get-AzFrontDoorCdnProfile +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global fdp-v542q6 frontdoor testps-rg-da16jm +Global fdp-a345e9 frontdoor testps-rg-da16jm +Global fdp-t0jfb9 frontdoor testps-rg-zvt8sy +``` + +List AzureFrontDoor profiles under the subscription + +### Example 2: List AzureFrontDoor profiles under the resource group +```powershell +Get-AzFrontDoorCdnProfile -ResourceGroupName testps-rg-da16jm +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global fdp-v542q6 frontdoor testps-rg-da16jm +Global fdp-a345e9 frontdoor testps-rg-da16jm +``` + +List AzureFrontDoor profiles under the resource group + +### Example 3: Get an AzureFrontDoor profile under the resource group +```powershell +Get-AzFrontDoorCdnProfile -ResourceGroupName testps-rg-da16jm -Name fdp-v542q6 +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global fdp-v542q6 frontdoor testps-rg-da16jm +``` + +Get an AzureFrontDoor profile under the resource group + +### Example 4: Get an AzureFrontDoor profile under the resource group via identity +```powershell +New-AzFrontDoorCdnProfile -ResourceGroupName testps-rg-da16jm -Name fdp-v542q7 -SkuName Standard_AzureFrontDoor -Location Global | Get-AzFrontDoorCdnProfile +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global fdp-v542q7 frontdoor testps-rg-da16jm +``` + +Get an AzureFrontDoor profile under the resource group via identity + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IProfile + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnProfileResourceUsage.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnProfileResourceUsage.md new file mode 100644 index 0000000000..c9240cb019 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnProfileResourceUsage.md @@ -0,0 +1,153 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdnprofileresourceusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnProfileResourceUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnProfileResourceUsage.md +--- + +# Get-AzFrontDoorCdnProfileResourceUsage + +## SYNOPSIS +Checks the quota and actual usage of endpoints under the given Azure Front Door profile. + +## SYNTAX + +``` +Get-AzFrontDoorCdnProfileResourceUsage -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Checks the quota and actual usage of endpoints under the given Azure Front Door profile. + +## EXAMPLES + +### Example 1: Get resource usages of an AzureFrontDoor profile +```powershell +Get-AzFrontDoorCdnProfileResourceUsage -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 +``` + +```output +CurrentValue Limit Unit +------------ ----- ---- +2 10 count +0 100 count +2 100 count +0 100 count +0 100 count +0 100 count +``` + +Get resource usages of an AzureFrontDoor profile + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IUsage + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnRoute.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnRoute.md new file mode 100644 index 0000000000..eea6287a83 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnRoute.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdnroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnRoute.md +--- + +# Get-AzFrontDoorCdnRoute + +## SYNOPSIS +Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint. + +## SYNTAX + +### List (Default) +``` +Get-AzFrontDoorCdnRoute -EndpointName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzFrontDoorCdnRoute -EndpointName -Name -ProfileName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzFrontDoorCdnRoute -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint. + +## EXAMPLES + +### Example 1: List AzureFrontDoor routes under the AzureFrontDoor profile +```powershell +Get-AzFrontDoorCdnRoute -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 +``` + +```output +Name ResourceGroupName +---- ----------------- +route001 testps-rg-da16jm +route002 testps-rg-da16jm +route003 testps-rg-da16jm +route004 testps-rg-da16jm +``` + +List AzureFrontDoor routes under the AzureFrontDoor profile + +### Example 2: Get an AzureFrontDoor route under the AzureFrontDoor profile +```powershell +Get-AzFrontDoorCdnRoute -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 -Name route001 +``` + +```output +Name ResourceGroupName +---- ----------------- +route001 testps-rg-da16jm +``` + +Get an AzureFrontDoor route under the AzureFrontDoor profile + +### Example 3: Get an AzureFrontDoor route under the AzureFrontDoor profile via identity +```powershell +$originGroup = Get-AzFrontDoorCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 +$ruleSet = Get-AzFrontDoorCdnRuleSet -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 +$customdomain = Get-AzFrontDoorCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -CustomDomainName domain001 + +$ruleSetResoure = New-AzFrontDoorCdnResourceReferenceObject -Id $ruleSet.Id +$customdomainResoure = New-AzFrontDoorCdnResourceReferenceObject -Id $customdomain.Id + +New-AzFrontDoorCdnRoute -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 -Name route001 -OriginGroupId $originGroup.Id -RuleSet @($ruleSetResoure) -PatternsToMatch "/*" -LinkToDefaultDomain "Enabled" -EnabledState "Enabled" -CustomDomain @($customdomainResoure) | Get-AzFrontDoorCdnRoute +``` + +```output +Name ResourceGroupName +---- ----------------- +route001 testps-rg-da16jm +``` + +Get an AzureFrontDoor route under the AzureFrontDoor profile via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the routing rule. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RouteName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IRoute + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnRule.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnRule.md new file mode 100644 index 0000000000..af346694e4 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnRule.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdnrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnRule.md +--- + +# Get-AzFrontDoorCdnRule + +## SYNOPSIS +Gets an existing delivery rule within a rule set. + +## SYNTAX + +### List (Default) +``` +Get-AzFrontDoorCdnRule -ProfileName -ResourceGroupName -SetName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzFrontDoorCdnRule -Name -ProfileName -ResourceGroupName -SetName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzFrontDoorCdnRule -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an existing delivery rule within a rule set. + +## EXAMPLES + +### Example 1: list AzureFrontDoor delivery rules within the specified rule set +```powershell +Get-AzFrontDoorCdnRule -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 +``` + +```output +Name ResourceGroupName +---- ----------------- +testrule1 testps-rg-da16jm +testrule2 testps-rg-da16jm +rule1 testps-rg-da16jm +``` + +list AzureFrontDoor delivery rules within the specified rule set + +### Example 2: Get an AzureFrontDoor delivery rule within the specified rule set +```powershell +Get-AzFrontDoorCdnRule -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 -Name rule1 +``` + +```output +Name ResourceGroupName +---- ----------------- +rule1 testps-rg-da16jm +``` + +Get an AzureFrontDoor delivery rule within the specified rule set + +### Example 3: Get an AzureFrontDoor delivery rule within the specified rule set via identity +```powershell +$conditions = @( + New-AzFrontDoorCdnRuleClientPortConditionObject -Name ClientPort -ParameterOperator Equal -ParameterMatchValue 80,81 + New-AzFrontDoorCdnRuleIsDeviceConditionObject -Name IsDevice -ParameterMatchValue Mobile + New-AzFrontDoorCdnRuleSslProtocolConditionObject -Name SslProtocol -ParameterMatchValue TLSv1.2 +); + + +$actions = @( + New-AzFrontDoorCdnRuleRequestHeaderActionObject -Name ModifyRequestHeader -ParameterHeaderAction Append -ParameterHeaderName a1 -ParameterValue a1 + New-AzFrontDoorCdnRuleResponseHeaderActionObject -Name ModifyResponseHeader -ParameterHeaderAction Append -ParameterHeaderName a1 -ParameterValue a1 + New-AzFrontDoorCdnRuleUrlRedirectActionObject -Name UrlRedirect -ParameterRedirectType Moved -ParameterDestinationProtocol MatchRequest +); + +New-AzFrontDoorCdnRule -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 -Name rule1 -Action $actions -Condition $conditions | Get-AzFrontDoorCdnRule +``` + +```output +Name ResourceGroupName +---- ----------------- +rule1 testps-rg-da16jm +``` + +Get an AzureFrontDoor delivery rule within the specified rule set via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the delivery rule which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetName +Name of the rule set under the profile. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: RuleSetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IRule + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnRuleSet.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnRuleSet.md new file mode 100644 index 0000000000..a958360724 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnRuleSet.md @@ -0,0 +1,209 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdnruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnRuleSet.md +--- + +# Get-AzFrontDoorCdnRuleSet + +## SYNOPSIS +Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile. + +## SYNTAX + +### List (Default) +``` +Get-AzFrontDoorCdnRuleSet -ProfileName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzFrontDoorCdnRuleSet -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzFrontDoorCdnRuleSet -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile. + +## EXAMPLES + +### Example 1: List AzureFrontDoor rule sets under the profile +```powershell +Get-AzFrontDoorCdnRuleSet -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 +``` + +```output +Name ResourceGroupName +---- ----------------- +ruleset001 testps-rg-da16jm +ruleset002 testps-rg-da16jm +``` + +List AzureFrontDoor rule sets under the profile + +### Example 2: Get an AzureFrontDoor rule set under the profile +```powershell +Get-AzFrontDoorCdnRuleSet -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 +``` + +```output +Name ResourceGroupName +---- ----------------- +ruleset001 testps-rg-da16jm +``` + +Get an AzureFrontDoor rule set under the profile + +### Example 3: Get an AzureFrontDoor rule set under the profile via identity +```powershell +New-AzFrontDoorCdnRuleSet -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 | Get-AzFrontDoorCdnRuleSet +``` + +```output +Name ResourceGroupName +---- ----------------- +ruleset001 testps-rg-da16jm +``` + +Get an AzureFrontDoor rule set under the profile via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the rule set under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RuleSetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IRuleSet + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnRuleSetResourceUsage.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnRuleSetResourceUsage.md new file mode 100644 index 0000000000..03b5308dd5 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnRuleSetResourceUsage.md @@ -0,0 +1,163 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdnrulesetresourceusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnRuleSetResourceUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnRuleSetResourceUsage.md +--- + +# Get-AzFrontDoorCdnRuleSetResourceUsage + +## SYNOPSIS +Checks the quota and actual usage of endpoints under the given Azure Front Door profile.. + +## SYNTAX + +``` +Get-AzFrontDoorCdnRuleSetResourceUsage -ProfileName -ResourceGroupName -RuleSetName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Checks the quota and actual usage of endpoints under the given Azure Front Door profile.. + +## EXAMPLES + +### Example 1: Get resource usages of an AzureFrontDoor rule set +```powershell +Get-AzFrontDoorCdnRuleSetResourceUsage -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 +``` + +```output +CurrentValue Limit Unit +------------ ----- ---- +0 100 count +``` + +Get resource usages of an AzureFrontDoor rule set + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSetName +Name of the rule set under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IUsage + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnSecret.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnSecret.md new file mode 100644 index 0000000000..cfd4ac6a3b --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnSecret.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdnsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnSecret.md +--- + +# Get-AzFrontDoorCdnSecret + +## SYNOPSIS +Gets an existing Secret within a profile. + +## SYNTAX + +### List (Default) +``` +Get-AzFrontDoorCdnSecret -ProfileName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzFrontDoorCdnSecret -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzFrontDoorCdnSecret -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an existing Secret within a profile. + +## EXAMPLES + +### Example 1: List AzureFrontDoor secret under the profile +```powershell +Get-AzFrontDoorCdnSecret -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 +``` + +```output +Name ResourceGroupName +---- ----------------- +secret001 testps-rg-da16jm +secret002 testps-rg-da16jm +``` + +List AzureFrontDoor secret under the profile + +### Example 2: Get an AzureFrontDoor secret under the profile +```powershell +Get-AzFrontDoorCdnSecret -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name secret001 +``` + +```output +Name ResourceGroupName +---- ----------------- +secret001 testps-rg-da16jm +``` + +Get an AzureFrontDoor secret under the profile + +### Example 2: Get an AzureFrontDoor secret under the profile via identity +```powershell +$secretSourceId = "xxxxxxxx" +$certificateParameter = New-AzFrontDoorCdnSecretCustomerCertificateParametersObject -UseLatestVersion $true -SubjectAlternativeName @() -Type "CustomerCertificate" -SecretSourceId $secretSourceId +New-AzFrontDoorCdnSecret -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name secret001 -Parameter $certificateParameter | Get-AzFrontDoorCdnSecret +``` + +```output +Name ResourceGroupName +---- ----------------- +secret001 testps-rg-da16jm +``` + +Get an AzureFrontDoor secret under the profile via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Secret under the profile. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SecretName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ISecret + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnSecurityPolicy.md b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnSecurityPolicy.md new file mode 100644 index 0000000000..41493b4053 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Get-AzFrontDoorCdnSecurityPolicy.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/get-azfrontdoorcdnsecuritypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnSecurityPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Get-AzFrontDoorCdnSecurityPolicy.md +--- + +# Get-AzFrontDoorCdnSecurityPolicy + +## SYNOPSIS +Gets an existing security policy within a profile. + +## SYNTAX + +### List (Default) +``` +Get-AzFrontDoorCdnSecurityPolicy -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzFrontDoorCdnSecurityPolicy -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzFrontDoorCdnSecurityPolicy -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an existing security policy within a profile. + +## EXAMPLES + +### Example 1: List AzureFrontDoor security policies within the specified AzureFrontDoor profile +```powershell +Get-AzFrontDoorCdnSecurityPolicy -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 +``` + +```output +Name ResourceGroupName +---- ----------------- +policy001 testps-rg-da16jm +``` + +List AzureFrontDoor security policies within the specified AzureFrontDoor profile + +### Example 2: Get an AzureFrontDoor security policy within the specified AzureFrontDoor profile +```powershell +Get-AzFrontDoorCdnSecurityPolicy -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name policy001 +``` + +```output +Name ResourceGroupName +---- ----------------- +policy001 testps-rg-da16jm +``` + +Get an AzureFrontDoor security policy within the specified AzureFrontDoor profile + +### Example 3: Get an AzureFrontDoor security policy within the specified AzureFrontDoor profile via identity +```powershell +$endpoint = Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 +$endpoint2 = Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end002 +$updateAssociation = New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject -PatternsToMatch @("/*") -Domain @(@{"Id"=$($endpoint.Id)}) +$updateAssociation2 = New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject -PatternsToMatch @("/*") -Domain @(@{"Id"=$($endpoint2.Id)}) + +$wafPolicyId = "/subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourcegroups/rgName01/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf01" +$updateWafParameter = New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject -Association @($updateAssociation, $updateAssociation2) -WafPolicyId $wafPolicyId +Update-AzFrontDoorCdnSecurityPolicy -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name policy001 -Parameter $updateWafParameter | Get-AzFrontDoorCdnSecurityPolicy +``` + +```output +Name ResourceGroupName +---- ----------------- +policy001 testps-rg-da16jm +``` + +Get an AzureFrontDoor security policy within the specified AzureFrontDoor profile via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the security policy under the profile. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SecurityPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ISecurityPolicy + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Import-AzCdnEndpointContent.md b/azps-10.1.0/Az.Cdn/Import-AzCdnEndpointContent.md new file mode 100644 index 0000000000..18f6d11c16 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Import-AzCdnEndpointContent.md @@ -0,0 +1,309 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/import-azcdnendpointcontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Import-AzCdnEndpointContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Import-AzCdnEndpointContent.md +--- + +# Import-AzCdnEndpointContent + +## SYNOPSIS +Pre-loads a content to CDN. +Available for Verizon Profiles. + +## SYNTAX + +### LoadExpanded (Default) +``` +Import-AzCdnEndpointContent -EndpointName -ProfileName -ResourceGroupName + -ContentPath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Load +``` +Import-AzCdnEndpointContent -EndpointName -ProfileName -ResourceGroupName + -ContentFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### LoadViaIdentity +``` +Import-AzCdnEndpointContent -InputObject -ContentFilePath + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### LoadViaIdentityExpanded +``` +Import-AzCdnEndpointContent -InputObject -ContentPath [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Pre-loads a content to CDN. +Available for Verizon Profiles. + +## EXAMPLES + +### Example 1: Import content of an AzureCDN Endpoint under the AzureCDN profile +```powershell +Import-AzCdnEndpointContent -ResourceGroupName testps-rg-verizon -ProfileName verzioncdn001 -EndpointName verzionendptest001 -ContentPath @("/movies/hello","/pictures/pic1.jpg") +``` + +Import content of an AzureCDN Endpoint under the AzureCDN profile, only some skus support this action + +### Example 2: Import content of an AzureCDN Endpoint under the AzureCDN profile using contentFilePath parameter +```powershell +$contentPath = @("/movies/amazing.mp4","/pictures/pic1.jpg") +$contentFilePath = New-AzCdnLoadParametersObject -ContentPath $contentPath +Import-AzCdnEndpointContent -ResourceGroupName testps-rg-verizon -ProfileName verzioncdn001 -EndpointName verzionendptest001 -ContentFilePath $contentFilePath +``` + +Import content of an AzureCDN Endpoint under the AzureCDN profile, only some skus support this action using contentFilePath parameter + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentFilePath +Parameters required for content load. +To construct, see NOTES section for CONTENTFILEPATH properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ILoadParameters +Parameter Sets: Load, LoadViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ContentPath +The path to the content to be loaded. +Path should be a relative file URL of the origin. + +```yaml +Type: System.String[] +Parameter Sets: LoadExpanded, LoadViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Load, LoadExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: LoadViaIdentity, LoadViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Load, LoadExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Load, LoadExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Load, LoadExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ILoadParameters + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`CONTENTFILEPATH `: Parameters required for content load. + - `ContentPath `: The path to the content to be loaded. Path should be a relative file URL of the origin. + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnCustomDomain.md b/azps-10.1.0/Az.Cdn/New-AzCdnCustomDomain.md new file mode 100644 index 0000000000..8e065744e2 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnCustomDomain.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azcdncustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnCustomDomain.md +--- + +# New-AzCdnCustomDomain + +## SYNOPSIS +Creates a new custom domain within an endpoint. + +## SYNTAX + +``` +New-AzCdnCustomDomain -EndpointName -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-HostName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new custom domain within an endpoint. + +## EXAMPLES + +### Example 1: Create an AzureCDN custom domain under the AzureCDN endpoint +```powershell +New-AzCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name customdomain001 -HostName 'testcm.dev.cdn.azure.cn' +``` + +```output +Name ResourceGroupName +---- ----------------- +customdomain001 testps-rg-da16jm +``` + +Create an AzureCDN custom domain under the AzureCDN endpoint + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +The host name of the custom domain. +Must be a domain name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the custom domain within an endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CustomDomainName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ICustomDomain + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleCacheExpirationActionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleCacheExpirationActionObject.md new file mode 100644 index 0000000000..5153336e8d --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleCacheExpirationActionObject.md @@ -0,0 +1,102 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleCacheExpirationActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleCacheExpirationActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleCacheExpirationActionObject.md +--- + +# New-AzCdnDeliveryRuleCacheExpirationActionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleCacheExpirationAction. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleCacheExpirationActionObject -Name + -ParameterCacheBehavior [-ParameterCacheDuration ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleCacheExpirationAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleCacheExpirationAction +```powershell +New-AzCdnDeliveryRuleCacheExpirationActionObject -Name CacheExpiration -ParameterCacheBehavior SetIfMissing -ParameterCacheDuration 0.01:30:00 +``` + +```output +Name +---- +CacheExpiration +``` + +Create an in-memory object for AzureCDN DeliveryRuleCacheExpirationAction + +## PARAMETERS + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterCacheBehavior +Caching behavior for the requests. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.CacheBehavior +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterCacheDuration +The duration for which the content needs to be cached. +Allowed format is [d.]hh:mm:ss. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleCacheExpirationAction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleCacheKeyQueryStringActionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleCacheKeyQueryStringActionObject.md new file mode 100644 index 0000000000..ecaaa94ae5 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleCacheKeyQueryStringActionObject.md @@ -0,0 +1,101 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleCacheKeyQueryStringActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleCacheKeyQueryStringActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleCacheKeyQueryStringActionObject.md +--- + +# New-AzCdnDeliveryRuleCacheKeyQueryStringActionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleCacheKeyQueryStringAction. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleCacheKeyQueryStringActionObject -Name + -ParameterQueryStringBehavior [-ParameterQueryParameter ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleCacheKeyQueryStringAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleCacheKeyQueryStringAction +```powershell +New-AzCdnDeliveryRuleCacheKeyQueryStringActionObject -Name CacheKeyQueryString -ParameterQueryStringBehavior IncludeAll +``` + +```output +Name +---- +CacheKeyQueryString +``` + +Create an in-memory object for AzureCDN DeliveryRuleCacheKeyQueryStringAction + +## PARAMETERS + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterQueryParameter +query parameters to include or exclude (comma separated). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterQueryStringBehavior +Caching behavior for the requests. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.QueryStringBehavior +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleCacheKeyQueryStringAction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleCookiesConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleCookiesConditionObject.md new file mode 100644 index 0000000000..2225ed5be8 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleCookiesConditionObject.md @@ -0,0 +1,147 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleCookiesConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleCookiesConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleCookiesConditionObject.md +--- + +# New-AzCdnDeliveryRuleCookiesConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleCookiesCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleCookiesConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterSelector ] + [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleCookiesCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleCookiesCondition +```powershell +New-AzCdnDeliveryRuleCookiesConditionObject -Name Cookies -ParameterOperator Equal -ParameterSelector test -ParameterMatchValue test -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +Cookies +``` + +Create an in-memory object for AzureCDN DeliveryRuleCookiesCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.CookiesOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterSelector +Name of Cookies to be matched. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleCookiesCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleHttpVersionConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleHttpVersionConditionObject.md new file mode 100644 index 0000000000..d026c50516 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleHttpVersionConditionObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleHttpVersionConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleHttpVersionConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleHttpVersionConditionObject.md +--- + +# New-AzCdnDeliveryRuleHttpVersionConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleHttpVersionCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleHttpVersionConditionObject -Name [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleHttpVersionCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleHttpVersionCondition +```powershell +New-AzCdnDeliveryRuleHttpVersionConditionObject -Name HttpVersion -ParameterMatchValue 2.0 +``` + +```output +Name +---- +HttpVersion +``` + +Create an in-memory object for AzureCDN DeliveryRuleHttpVersionCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleHttpVersionCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleIsDeviceConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleIsDeviceConditionObject.md new file mode 100644 index 0000000000..e6996e1859 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleIsDeviceConditionObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleIsDeviceConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleIsDeviceConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleIsDeviceConditionObject.md +--- + +# New-AzCdnDeliveryRuleIsDeviceConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleIsDeviceCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleIsDeviceConditionObject -Name [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleIsDeviceCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleIsDeviceCondition +```powershell +New-AzCdnDeliveryRuleIsDeviceConditionObject -Name IsDevice -ParameterMatchValue Mobile +``` + +```output +Name +---- +IsDevice +``` + +Create an in-memory object for AzureCDN DeliveryRuleIsDeviceCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleIsDeviceCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleObject.md new file mode 100644 index 0000000000..8e82218dae --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleObject.md @@ -0,0 +1,140 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleObject.md +--- + +# New-AzCdnDeliveryRuleObject + +## SYNOPSIS +Create an in-memory object for DeliveryRule. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleObject -Action -Order + [-Condition ] [-Name ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRule. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRule +```powershell +$cond1 = New-AzCdnDeliveryRuleCookiesConditionObject -Name Cookies -ParameterOperator Equal -ParameterSelector test -ParameterMatchValue test -ParameterNegateCondition $False -ParameterTransform Lowercase +$action1 = New-AzCdnDeliveryRuleResponseHeaderActionObject -Name ModifyResponseHeader -ParameterHeaderAction Append -ParameterHeaderName a1 -ParameterValue a1 +$action2 = New-AzCdnDeliveryRuleRequestHeaderActionObject -Name ModifyRequestHeader -ParameterHeaderAction Append -ParameterHeaderName a1 -ParameterValue a1 + + +$conditions = @($cond1) +$actions = @($action1, $action2) +New-AzCdnDeliveryRuleObject -Name "Rule1" -Condition $conditions -Action $actions -Order 1 +``` + +```output +Name Order +---- ----- +Rule1 1 +``` + +Create an in-memory object for AzureCDN DeliveryRule + +## PARAMETERS + +### -Action +A list of actions that are executed when all the conditions of a rule are satisfied. +To construct, see NOTES section for ACTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IDeliveryRuleAction1[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Condition +A list of conditions that must be matched for the actions to be executed. +To construct, see NOTES section for CONDITION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IDeliveryRuleCondition[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +The order in which the rules are applied for the endpoint. +Possible values {0,1,2,3,………}. +A rule with a lesser order will be applied before a rule with a greater order. +Rule with order 0 is a special rule. +It does not require any condition and actions listed in it will always be applied. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRule + +## 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. + + +`ACTION `: A list of actions that are executed when all the conditions of a rule are satisfied. + - `Name `: The name of the action for the delivery rule. + +`CONDITION `: A list of conditions that must be matched for the actions to be executed. + - `Name `: The name of the condition for the delivery rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRulePostArgsConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRulePostArgsConditionObject.md new file mode 100644 index 0000000000..010e6a67dc --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRulePostArgsConditionObject.md @@ -0,0 +1,147 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRulePostArgsConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRulePostArgsConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRulePostArgsConditionObject.md +--- + +# New-AzCdnDeliveryRulePostArgsConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRulePostArgsCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRulePostArgsConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterSelector ] + [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRulePostArgsCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRulePostArgsCondition +```powershell +New-AzCdnDeliveryRulePostArgsConditionObject -Name PostArgs -ParameterOperator Equal -ParameterMatchValue test -ParameterNegateCondition $False -ParameterSelector test -ParameterTransform Lowercase +``` + +```output +Name +---- +PostArgs +``` + +Create an in-memory object for AzureCDN DeliveryRulePostArgsCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.PostArgsOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterSelector +Name of PostArg to be matched. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRulePostArgsCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleQueryStringConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleQueryStringConditionObject.md new file mode 100644 index 0000000000..06a1b9bd0c --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleQueryStringConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleQueryStringConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleQueryStringConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleQueryStringConditionObject.md +--- + +# New-AzCdnDeliveryRuleQueryStringConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleQueryStringCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleQueryStringConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterTransform ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleQueryStringCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleQueryStringCondition +```powershell +New-AzCdnDeliveryRuleQueryStringConditionObject -Name QueryString -ParameterOperator Equal -ParameterMatchValue test -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +QueryString +``` + +Create an in-memory object for AzureCDN DeliveryRuleQueryStringCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.QueryStringOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleQueryStringCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRemoteAddressConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRemoteAddressConditionObject.md new file mode 100644 index 0000000000..b4267ce62c --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRemoteAddressConditionObject.md @@ -0,0 +1,134 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleRemoteAddressConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRemoteAddressConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRemoteAddressConditionObject.md +--- + +# New-AzCdnDeliveryRuleRemoteAddressConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRemoteAddressCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleRemoteAddressConditionObject -Name + -ParameterOperator [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRemoteAddressCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleRemoteAddressCondition +```powershell +New-AzCdnDeliveryRuleRemoteAddressConditionObject -Name RemoteAddress -ParameterOperator GeoMatch -ParameterMatchValue BJ -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +RemoteAddress +``` + +Create an in-memory object for AzureCDN DeliveryRuleRemoteAddressCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +Match values to match against. +The operator will apply to each value in here with OR semantics. +If any of them match the variable with the given operator this match condition is considered a match. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.RemoteAddressOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRemoteAddressCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestBodyConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestBodyConditionObject.md new file mode 100644 index 0000000000..18a9c85f8a --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestBodyConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleRequestBodyConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRequestBodyConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRequestBodyConditionObject.md +--- + +# New-AzCdnDeliveryRuleRequestBodyConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRequestBodyCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleRequestBodyConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterTransform ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRequestBodyCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleRequestBodyCondition +```powershell +New-AzCdnDeliveryRuleRequestBodyConditionObject -Name RequestBody -ParameterOperator Equal -ParameterMatchValue test -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +RequestBody +``` + +Create an in-memory object for AzureCDN DeliveryRuleRequestBodyCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.RequestBodyOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRequestBodyCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestHeaderActionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestHeaderActionObject.md new file mode 100644 index 0000000000..baf5fca11d --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestHeaderActionObject.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleRequestHeaderActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRequestHeaderActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRequestHeaderActionObject.md +--- + +# New-AzCdnDeliveryRuleRequestHeaderActionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRequestHeaderAction. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleRequestHeaderActionObject -Name + -ParameterHeaderAction -ParameterHeaderName [-ParameterValue ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRequestHeaderAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleRequestHeaderAction +```powershell +New-AzCdnDeliveryRuleRequestHeaderActionObject -Name ModifyRequestHeader -ParameterHeaderAction Append -ParameterHeaderName a1 -ParameterValue a1 +``` + +```output +Name +---- +ModifyRequestHeader +``` + +Create an in-memory object for AzureCDN DeliveryRuleRequestHeaderAction + +## PARAMETERS + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterHeaderAction +Action to perform. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.HeaderAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterHeaderName +Name of the header to modify. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterValue +Value for the specified action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRequestHeaderAction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestHeaderConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestHeaderConditionObject.md new file mode 100644 index 0000000000..72ffb01332 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestHeaderConditionObject.md @@ -0,0 +1,148 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleRequestHeaderConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRequestHeaderConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRequestHeaderConditionObject.md +--- + +# New-AzCdnDeliveryRuleRequestHeaderConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRequestHeaderCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleRequestHeaderConditionObject -Name + -ParameterOperator [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterSelector ] [-ParameterTransform ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRequestHeaderCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleRequestHeaderCondition +```powershell +New-AzCdnDeliveryRuleRequestHeaderConditionObject -Name RequestHeader -ParameterOperator Equal -ParameterSelector test -ParameterMatchValue test -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +RequestHeader +``` + +Create an in-memory object for AzureCDN DeliveryRuleRequestHeaderCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.RequestHeaderOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterSelector +Name of Header to be matched. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRequestHeaderCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestMethodConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestMethodConditionObject.md new file mode 100644 index 0000000000..06406d6058 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestMethodConditionObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleRequestMethodConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRequestMethodConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRequestMethodConditionObject.md +--- + +# New-AzCdnDeliveryRuleRequestMethodConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRequestMethodCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleRequestMethodConditionObject -Name [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRequestMethodCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleRequestMethodCondition +```powershell +New-AzCdnDeliveryRuleRequestMethodConditionObject -Name RequestMethod -ParameterMatchValue GET +``` + +```output +Name +---- +RequestMethod +``` + +Create an in-memory object for AzureCDN DeliveryRuleRequestMethodCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRequestMethodCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestSchemeConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestSchemeConditionObject.md new file mode 100644 index 0000000000..109d85ae80 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestSchemeConditionObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleRequestSchemeConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRequestSchemeConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRequestSchemeConditionObject.md +--- + +# New-AzCdnDeliveryRuleRequestSchemeConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRequestSchemeCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleRequestSchemeConditionObject -Name [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRequestSchemeCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleRequestSchemeCondition +```powershell +New-AzCdnDeliveryRuleRequestSchemeConditionObject -Name RequestScheme -ParameterMatchValue HTTP +``` + +```output +Name +---- +RequestScheme +``` + +Create an in-memory object for AzureCDN DeliveryRuleRequestSchemeCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRequestSchemeCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestUriConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestUriConditionObject.md new file mode 100644 index 0000000000..30fd8e1403 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleRequestUriConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleRequestUriConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRequestUriConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleRequestUriConditionObject.md +--- + +# New-AzCdnDeliveryRuleRequestUriConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRequestUriCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleRequestUriConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterTransform ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRequestUriCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleRequestUriCondition +```powershell +New-AzCdnDeliveryRuleRequestUriConditionObject -Name RequestUri -ParameterOperator Equal -ParameterMatchValue /test +``` + +```output +Name +---- +RequestUri +``` + +Create an in-memory object for AzureCDN DeliveryRuleRequestUriCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.RequestUriOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRequestUriCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleResponseHeaderActionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleResponseHeaderActionObject.md new file mode 100644 index 0000000000..8fd1dad90f --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleResponseHeaderActionObject.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleResponseHeaderActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleResponseHeaderActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleResponseHeaderActionObject.md +--- + +# New-AzCdnDeliveryRuleResponseHeaderActionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleResponseHeaderAction. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleResponseHeaderActionObject -Name + -ParameterHeaderAction -ParameterHeaderName [-ParameterValue ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleResponseHeaderAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleResponseHeaderAction +```powershell +New-AzCdnDeliveryRuleResponseHeaderActionObject -Name ModifyResponseHeader -ParameterHeaderAction Append -ParameterHeaderName a1 -ParameterValue a1 +``` + +```output +Name +---- +ModifyResponseHeader +``` + +Create an in-memory object for AzureCDN DeliveryRuleResponseHeaderAction + +## PARAMETERS + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterHeaderAction +Action to perform. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.HeaderAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterHeaderName +Name of the header to modify. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterValue +Value for the specified action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleResponseHeaderAction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleUrlFileExtensionConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleUrlFileExtensionConditionObject.md new file mode 100644 index 0000000000..4f9e0876e7 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleUrlFileExtensionConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleUrlFileExtensionConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleUrlFileExtensionConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleUrlFileExtensionConditionObject.md +--- + +# New-AzCdnDeliveryRuleUrlFileExtensionConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleUrlFileExtensionCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleUrlFileExtensionConditionObject -Name + -ParameterOperator [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleUrlFileExtensionCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleUrlFileExtensionCondition +```powershell +New-AzCdnDeliveryRuleUrlFileExtensionConditionObject -Name UrlFileExtension -ParameterOperator Equal -ParameterMatchValue txt -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +UrlFileExtension +``` + +Create an in-memory object for AzureCDN DeliveryRuleUrlFileExtensionCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.UrlFileExtensionOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleUrlFileExtensionCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleUrlFileNameConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleUrlFileNameConditionObject.md new file mode 100644 index 0000000000..ab7b5b704d --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleUrlFileNameConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleUrlFileNameConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleUrlFileNameConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleUrlFileNameConditionObject.md +--- + +# New-AzCdnDeliveryRuleUrlFileNameConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleUrlFileNameCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleUrlFileNameConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterTransform ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleUrlFileNameCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleUrlFileNameCondition +```powershell +New-AzCdnDeliveryRuleUrlFileNameConditionObject -Name UrlFileName -ParameterOperator Equal -ParameterMatchValue test -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +UrlFileName +``` + +Create an in-memory object for AzureCDN DeliveryRuleUrlFileNameCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.UrlFileNameOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleUrlFileNameCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleUrlPathConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleUrlPathConditionObject.md new file mode 100644 index 0000000000..1f00242f76 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnDeliveryRuleUrlPathConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnDeliveryRuleUrlPathConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleUrlPathConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnDeliveryRuleUrlPathConditionObject.md +--- + +# New-AzCdnDeliveryRuleUrlPathConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleUrlPathCondition. + +## SYNTAX + +``` +New-AzCdnDeliveryRuleUrlPathConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterTransform ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleUrlPathCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN DeliveryRuleUrlPathCondition +```powershell +New-AzCdnDeliveryRuleUrlPathConditionObject -Name UrlPath -ParameterOperator Equal -ParameterMatchValue /a +``` + +```output +Name +---- +UrlPath +``` + +Create an in-memory object for AzureCDN DeliveryRuleUrlPathCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.UrlPathOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleUrlPathCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnEndpoint.md b/azps-10.1.0/Az.Cdn/New-AzCdnEndpoint.md new file mode 100644 index 0000000000..53bededbbc --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnEndpoint.md @@ -0,0 +1,568 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azcdnendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnEndpoint.md +--- + +# New-AzCdnEndpoint + +## SYNOPSIS +Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +## SYNTAX + +``` +New-AzCdnEndpoint -Name -ProfileName -ResourceGroupName -Location + [-SubscriptionId ] [-ContentTypesToCompress ] [-DefaultOriginGroupId ] + [-DeliveryPolicyDescription ] [-DeliveryPolicyRule ] [-GeoFilter ] + [-IsCompressionEnabled] [-IsHttpAllowed] [-IsHttpsAllowed] [-OptimizationType ] + [-Origin ] [-OriginGroup ] [-OriginHostHeader ] + [-OriginPath ] [-ProbePath ] [-QueryStringCachingBehavior ] + [-Tag ] [-UrlSigningKey ] [-WebApplicationFirewallPolicyLinkId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +## EXAMPLES + +### Example 1: Create an AzureCDN Endpoint under the AzureCDN profile +```powershell +$origin = @{ + Name = "origin1" + HostName = "host1.hello.com" +}; +New-AzCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -Name endptest001 -Location westus -Origin $origin +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +WestUs endptest001 testps-rg-da16jm +``` + +Create an AzureCDN Endpoint under the AzureCDN profile + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentTypesToCompress +List of content types on which compression applies. +The value should be a valid MIME type. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultOriginGroupId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryPolicyDescription +User-friendly description of the policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryPolicyRule +A list of the delivery rules. +To construct, see NOTES section for DELIVERYPOLICYRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IDeliveryRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeoFilter +List of rules defining the user's geo access within a CDN endpoint. +Each geo filter defines an access rule to a specified path or content, e.g. +block APAC for path /pictures/ +To construct, see NOTES section for GEOFILTER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IGeoFilter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsCompressionEnabled +Indicates whether content compression is enabled on CDN. +Default value is false. +If compression is enabled, content will be served as compressed if user requests for a compressed version. +Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsHttpAllowed +Indicates whether HTTP traffic is allowed on the endpoint. +Default value is true. +At least one protocol (HTTP or HTTPS) must be allowed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsHttpsAllowed +Indicates whether HTTPS traffic is allowed on the endpoint. +Default value is true. +At least one protocol (HTTP or HTTPS) must be allowed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizationType +Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. +Download, Media services. +With this information, CDN can apply scenario driven optimization. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.OptimizationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Origin +The source of the content being delivered via CDN. +To construct, see NOTES section for ORIGIN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IDeepCreatedOrigin[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginGroup +The origin groups comprising of origins that are used for load balancing the traffic based on availability. +To construct, see NOTES section for ORIGINGROUP properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IDeepCreatedOriginGroup[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginHostHeader +The host header value sent to the origin with each request. +This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. +Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginPath +A directory path on the origin that CDN can use to retrieve content from, e.g. +contoso.cloudapp.net/originpath. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbePath +Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. +This is relative to the origin path. +This property is only relevant when using a single origin. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryStringCachingBehavior +Defines how CDN caches requests that include query strings. +You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.QueryStringCachingBehavior +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlSigningKey +List of keys used to validate the signed URL hashes. +To construct, see NOTES section for URLSIGNINGKEY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IUrlSigningKey[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApplicationFirewallPolicyLinkId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IEndpoint + +## 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. + + +`DELIVERYPOLICYRULE `: A list of the delivery rules. + - `Action `: A list of actions that are executed when all the conditions of a rule are satisfied. + - `Name `: The name of the action for the delivery rule. + - `Order `: The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied. + - `[Condition ]`: A list of conditions that must be matched for the actions to be executed + - `Name `: The name of the condition for the delivery rule. + - `[Name ]`: Name of the rule + +`GEOFILTER `: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ + - `Action `: Action of the geo filter, i.e. allow or block access. + - `CountryCode `: Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US. + - `RelativePath `: Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) + +`ORIGIN `: The source of the content being delivered via CDN. + - `Name `: Origin name which must be unique within the endpoint. + - `[Enabled ]`: Origin is enabled for load balancing or not. By default, origin is always enabled. + - `[HostName ]`: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. + - `[HttpPort ]`: The value of the HTTP port. Must be between 1 and 65535. + - `[HttpsPort ]`: The value of the HTTPS port. Must be between 1 and 65535. + - `[OriginHostHeader ]`: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. + - `[Priority ]`: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. + - `[PrivateLinkAlias ]`: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' + - `[PrivateLinkApprovalMessage ]`: A custom message to be included in the approval request to connect to the Private Link. + - `[PrivateLinkLocation ]`: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated + - `[PrivateLinkResourceId ]`: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' + - `[Weight ]`: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 + +`ORIGINGROUP `: The origin groups comprising of origins that are used for load balancing the traffic based on availability. + - `Name `: Origin group name which must be unique within the endpoint. + - `[HealthProbeSetting ]`: Health probe settings to the origin that is used to determine the health of the origin. + - `[ProbeIntervalInSecond ]`: The number of seconds between health probes.Default is 240sec. + - `[ProbePath ]`: The path relative to the origin that is used to determine the health of the origin. + - `[ProbeProtocol ]`: Protocol to use for health probe. + - `[ProbeRequestType ]`: The type of health probe request that is made. + - `[Origin ]`: The source of the content being delivered via CDN within given origin group. + - `[Id ]`: Resource ID. + - `[ResponseBasedOriginErrorDetectionSetting ]`: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. + - `[HttpErrorRange ]`: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. + - `[Begin ]`: The inclusive start of the http status code range. + - `[End ]`: The inclusive end of the http status code range. + - `[ResponseBasedDetectedErrorType ]`: Type of response errors for real user requests for which origin will be deemed unhealthy + - `[ResponseBasedFailoverThresholdPercentage ]`: The percentage of failed requests in the sample where failover should trigger. + - `[TrafficRestorationTimeToHealedOrNewEndpointsInMinute ]`: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. + +`URLSIGNINGKEY `: List of keys used to validate the signed URL hashes. + - `KeyId `: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. + - `KeySourceParameterResourceGroupName `: Resource group of the user's Key Vault containing the secret + - `KeySourceParameterSecretName `: The name of secret in Key Vault. + - `KeySourceParameterSecretVersion `: The version(GUID) of secret in Key Vault. + - `KeySourceParameterSubscriptionId `: Subscription Id of the user's Key Vault containing the secret + - `KeySourceParameterVaultName `: The name of the user's Key Vault containing the secret + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnHealthProbeParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnHealthProbeParametersObject.md new file mode 100644 index 0000000000..c77ec87c6f --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnHealthProbeParametersObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnHealthProbeParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnHealthProbeParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnHealthProbeParametersObject.md +--- + +# New-AzCdnHealthProbeParametersObject + +## SYNOPSIS +Create an in-memory object for HealthProbeParameters. + +## SYNTAX + +``` +New-AzCdnHealthProbeParametersObject [-ProbeIntervalInSecond ] [-ProbePath ] + [-ProbeProtocol ] [-ProbeRequestType ] [] +``` + +## DESCRIPTION +Create an in-memory object for HealthProbeParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN HealthProbeParameters +```powershell +New-AzCdnHealthProbeParametersObject -ProbeIntervalInSecond 120 -ProbePath "/check-health.aspx" -ProbeProtocol "Http" -ProbeRequestType "HEAD" +``` + +```output +ProbeIntervalInSecond ProbePath ProbeProtocol ProbeRequestType +--------------------- --------- ------------- ---------------- +120 /check-health.aspx Http HEAD +``` + +Create an in-memory object for AzureCDN HealthProbeParameters + +## PARAMETERS + +### -ProbeIntervalInSecond +The number of seconds between health probes.Default is 240sec. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbePath +The path relative to the origin that is used to determine the health of the origin. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeProtocol +Protocol to use for health probe. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ProbeProtocol +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeRequestType +The type of health probe request that is made. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.HealthProbeRequestType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.HealthProbeParameters + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnLoadParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnLoadParametersObject.md new file mode 100644 index 0000000000..aa64b792a9 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnLoadParametersObject.md @@ -0,0 +1,72 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnLoadParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnLoadParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnLoadParametersObject.md +--- + +# New-AzCdnLoadParametersObject + +## SYNOPSIS +Create an in-memory object for LoadParameters. + +## SYNTAX + +``` +New-AzCdnLoadParametersObject -ContentPath [] +``` + +## DESCRIPTION +Create an in-memory object for LoadParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for LoadParameters +```powershell +$contentPath = @("/movies/amazing.mp4","/pictures/pic1.jpg") +New-AzCdnLoadParametersObject -ContentPath $contentPath +``` + +```output +ContentPath +----------- +{/movies/amazing.mp4, /pictures/pic1.jpg} +``` + +Create an in-memory object for LoadParameters + +## PARAMETERS + +### -ContentPath +The path to the content to be loaded. +Path should be a relative file URL of the origin. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.LoadParameters + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnManagedHttpsParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnManagedHttpsParametersObject.md new file mode 100644 index 0000000000..53a39f4318 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnManagedHttpsParametersObject.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnManagedHttpsParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnManagedHttpsParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnManagedHttpsParametersObject.md +--- + +# New-AzCdnManagedHttpsParametersObject + +## SYNOPSIS +Create an in-memory object for CdnManagedHttpsParameters. + +## SYNTAX + +``` +New-AzCdnManagedHttpsParametersObject -CertificateSource + -CertificateSourceParameterCertificateType -ProtocolType + [-MinimumTlsVersion ] [] +``` + +## DESCRIPTION +Create an in-memory object for CdnManagedHttpsParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN CdnManagedHttpsParameters +```powershell +New-AzCdnManagedHttpsParametersObject -CertificateSourceParameterCertificateType Dedicated -CertificateSource Cdn -ProtocolType ServerNameIndication +``` + +```output +CertificateSource MinimumTlsVersion ProtocolType +----------------- ----------------- ------------ +Cdn TLS12 +``` + +Create an in-memory object for AzureCDN CdnManagedHttpsParameters + +## PARAMETERS + +### -CertificateSource +Defines the source of the SSL certificate. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.CertificateSource +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateSourceParameterCertificateType +Type of certificate used. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.CertificateType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +TLS protocol version that will be used for Https. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MinimumTlsVersion +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtocolType +Defines the TLS extension protocol that is used for secure delivery. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ProtocolType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.CdnManagedHttpsParameters + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnOrigin.md b/azps-10.1.0/Az.Cdn/New-AzCdnOrigin.md new file mode 100644 index 0000000000..a7b07cbe25 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnOrigin.md @@ -0,0 +1,387 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azcdnorigin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnOrigin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnOrigin.md +--- + +# New-AzCdnOrigin + +## SYNOPSIS +Creates a new origin within the specified endpoint. + +## SYNTAX + +``` +New-AzCdnOrigin -EndpointName -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-Enabled] [-HostName ] [-HttpPort ] [-HttpsPort ] + [-OriginHostHeader ] [-Priority ] [-PrivateLinkAlias ] + [-PrivateLinkApprovalMessage ] [-PrivateLinkLocation ] [-PrivateLinkResourceId ] + [-Weight ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new origin within the specified endpoint. + +## EXAMPLES + +### Example 1: Create an AzureCDN origin under the AzureCDN endpoint +```powershell +New-AzCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name origin1 -HostName "host1.hello.com" +``` + +```output +Name ResourceGroupName +---- ----------------- +origin1 testps-rg-da16jm +``` + +Create an AzureCDN origin under the AzureCDN endpoint + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Origin is enabled for load balancing or not + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +The address of the origin. +Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPort +The value of the HTTP port. +Must be between 1 and 65535. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsPort +The value of the HTTPS port. +Must be between 1 and 65535. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the origin that is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: OriginName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginHostHeader +The host header value sent to the origin with each request. +If you leave this blank, the request hostname determines this value. +Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +This overrides the host header defined at Endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Priority of origin in given origin group for load balancing. +Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkAlias +The Alias of the Private Link resource. +Populating this optional field indicates that this origin is 'Private' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkApprovalMessage +A custom message to be included in the approval request to connect to the Private Link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkLocation +The location of the Private Link resource. +Required only if 'privateLinkResourceId' is populated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkResourceId +The Resource Id of the Private Link resource. +Populating this optional field indicates that this backend is 'Private' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Weight +Weight of the origin in given origin group for load balancing. +Must be between 1 and 1000 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IOrigin + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnOriginGroup.md b/azps-10.1.0/Az.Cdn/New-AzCdnOriginGroup.md new file mode 100644 index 0000000000..9b83b2ac26 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnOriginGroup.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azcdnorigingroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnOriginGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnOriginGroup.md +--- + +# New-AzCdnOriginGroup + +## SYNOPSIS +Creates a new origin group within the specified endpoint. + +## SYNTAX + +``` +New-AzCdnOriginGroup -EndpointName -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-HealthProbeSetting ] [-Origin ] + [-ResponseBasedOriginErrorDetectionSetting ] + [-TrafficRestorationTimeToHealedOrNewEndpointsInMinute ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new origin group within the specified endpoint. + +## EXAMPLES + +### Example 1: Create an AzureCDN origin group under the AzureCDN endpoint +```powershell +$healthProbeParameters = New-AzCdnHealthProbeParametersObject -ProbeIntervalInSecond 120 -ProbePath "/check-health.aspx" -ProbeProtocol "Http" -ProbeRequestType "HEAD" +$origin = Get-AzCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name origin1 +New-AzCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name org001 -HealthProbeSetting $healthProbeParameters -Origin @(@{ Id = $origin.Id }) +``` + +```output +Name ResourceGroupName +---- ----------------- +org001 testps-rg-da16jm +``` + +Create an AzureCDN origin group under the AzureCDN endpoint + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthProbeSetting +Health probe settings to the origin that is used to determine the health of the origin. +To construct, see NOTES section for HEALTHPROBESETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IHealthProbeParameters +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the origin group which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: OriginGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Origin +The source of the content being delivered via CDN within given origin group. +To construct, see NOTES section for ORIGIN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IResourceReference[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseBasedOriginErrorDetectionSetting +The JSON object that contains the properties to determine origin health using real requests/responses. +This property is currently not supported. +To construct, see NOTES section for RESPONSEBASEDORIGINERRORDETECTIONSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IResponseBasedOriginErrorDetectionParameters +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficRestorationTimeToHealedOrNewEndpointsInMinute +Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. +Default is 10 mins. +This property is currently not supported. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IOriginGroup + +## 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. + + +`HEALTHPROBESETTING `: Health probe settings to the origin that is used to determine the health of the origin. + - `[ProbeIntervalInSecond ]`: The number of seconds between health probes.Default is 240sec. + - `[ProbePath ]`: The path relative to the origin that is used to determine the health of the origin. + - `[ProbeProtocol ]`: Protocol to use for health probe. + - `[ProbeRequestType ]`: The type of health probe request that is made. + +`ORIGIN `: The source of the content being delivered via CDN within given origin group. + - `[Id ]`: Resource ID. + +`RESPONSEBASEDORIGINERRORDETECTIONSETTING `: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. + - `[HttpErrorRange ]`: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. + - `[Begin ]`: The inclusive start of the http status code range. + - `[End ]`: The inclusive end of the http status code range. + - `[ResponseBasedDetectedErrorType ]`: Type of response errors for real user requests for which origin will be deemed unhealthy + - `[ResponseBasedFailoverThresholdPercentage ]`: The percentage of failed requests in the sample where failover should trigger. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnOriginGroupOverrideActionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnOriginGroupOverrideActionObject.md new file mode 100644 index 0000000000..3a5dcc5d91 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnOriginGroupOverrideActionObject.md @@ -0,0 +1,86 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnOriginGroupOverrideActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnOriginGroupOverrideActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnOriginGroupOverrideActionObject.md +--- + +# New-AzCdnOriginGroupOverrideActionObject + +## SYNOPSIS +Create an in-memory object for OriginGroupOverrideAction. + +## SYNTAX + +``` +New-AzCdnOriginGroupOverrideActionObject -Name [-OriginGroupId ] + [] +``` + +## DESCRIPTION +Create an in-memory object for OriginGroupOverrideAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN OriginGroupOverrideAction +```powershell +New-AzCdnOriginGroupOverrideActionObject -Name OriginGroupOverride -OriginGroupId 001 +``` + +```output +Name +---- +OriginGroupOverride +``` + +Create an in-memory object for AzureCDN OriginGroupOverrideAction + +## PARAMETERS + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginGroupId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.OriginGroupOverrideAction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnProfile.md b/azps-10.1.0/Az.Cdn/New-AzCdnProfile.md new file mode 100644 index 0000000000..06a334b924 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnProfile.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azcdnprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnProfile.md +--- + +# New-AzCdnProfile + +## SYNOPSIS +Creates an CDN profile with the specified profile name under the specified subscription and resource group. + +## SYNTAX + +``` +New-AzCdnProfile -Name -ResourceGroupName -Location [-SubscriptionId ] + [-OriginResponseTimeoutSecond ] [-SkuName ] [-Tag ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates an CDN profile with the specified profile name under the specified subscription and resource group. + +## EXAMPLES + +### Example 1: Create an AzureCDN profile under the resource group +```powershell +New-AzCdnProfile -ResourceGroupName testps-rg-da16jm -Name cdn001 -SkuName Standard_Microsoft -Location Global +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global cdn001 cdn testps-rg-da16jm +``` + +Create an AzureCDN profile under the resource group + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginResponseTimeoutSecond +Send and receive timeout on forwarding request to the origin. +When timeout is reached, the request fails and returns. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name of the pricing tier. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IProfile + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnPurgeParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnPurgeParametersObject.md new file mode 100644 index 0000000000..6288dfb796 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnPurgeParametersObject.md @@ -0,0 +1,72 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnPurgeParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnPurgeParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnPurgeParametersObject.md +--- + +# New-AzCdnPurgeParametersObject + +## SYNOPSIS +Create an in-memory object for PurgeParameters. + +## SYNTAX + +``` +New-AzCdnPurgeParametersObject -ContentPath [] +``` + +## DESCRIPTION +Create an in-memory object for PurgeParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for PurgeParameters +```powershell +$contentPath = @("/movies/amazing.mp4","/pictures/pic1.jpg") +New-AzCdnPurgeParametersObject -ContentPath $contentPath +``` + +```output +ContentPath +----------- +{/movies/amazing.mp4, /pictures/pic1.jpg} +``` + +Create an in-memory object for PurgeParameters + +## PARAMETERS + +### -ContentPath +The path to the content to be purged. +Can describe a file path or a wild card directory. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.PurgeParameters + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnResourceReferenceObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnResourceReferenceObject.md new file mode 100644 index 0000000000..8e1d06a5be --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnResourceReferenceObject.md @@ -0,0 +1,70 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnResourceReferenceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnResourceReferenceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnResourceReferenceObject.md +--- + +# New-AzCdnResourceReferenceObject + +## SYNOPSIS +Create an in-memory object for ResourceReference. + +## SYNTAX + +``` +New-AzCdnResourceReferenceObject [-Id ] [] +``` + +## DESCRIPTION +Create an in-memory object for ResourceReference. + +## EXAMPLES + +### Example 1: Create an in-memory object for ResourceReference +```powershell +New-AzCdnResourceReferenceObject -Id Idtest +``` + +```output +Id +-- +Idtest +``` + +Create an in-memory object for ResourceReference + +## PARAMETERS + +### -Id +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ResourceReference + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnResponseBasedOriginErrorDetectionParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnResponseBasedOriginErrorDetectionParametersObject.md new file mode 100644 index 0000000000..b18645ead6 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnResponseBasedOriginErrorDetectionParametersObject.md @@ -0,0 +1,112 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnResponseBasedOriginErrorDetectionParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnResponseBasedOriginErrorDetectionParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnResponseBasedOriginErrorDetectionParametersObject.md +--- + +# New-AzCdnResponseBasedOriginErrorDetectionParametersObject + +## SYNOPSIS +Create an in-memory object for ResponseBasedOriginErrorDetectionParameters. + +## SYNTAX + +``` +New-AzCdnResponseBasedOriginErrorDetectionParametersObject [-HttpErrorRange ] + [-ResponseBasedDetectedErrorType ] + [-ResponseBasedFailoverThresholdPercentage ] [] +``` + +## DESCRIPTION +Create an in-memory object for ResponseBasedOriginErrorDetectionParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for ResponseBasedOriginErrorDetectionParameters +```powershell +New-AzCdnResponseBasedOriginErrorDetectionParametersObject -ResponseBasedDetectedErrorType testDetctedError -ResponseBasedFailoverThresholdPercentage 6 +``` + +```output +ResponseBasedDetectedErrorType ResponseBasedFailoverThresholdPercentage +------------------------------ ---------------------------------------- +testDetctedError 6 +``` + +Create an in-memory object for ResponseBasedOriginErrorDetectionParameters + +## PARAMETERS + +### -HttpErrorRange +The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. +To construct, see NOTES section for HTTPERRORRANGE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IHttpErrorRangeParameters[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseBasedDetectedErrorType +Type of response errors for real user requests for which origin will be deemed unhealthy. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ResponseBasedDetectedErrorTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseBasedFailoverThresholdPercentage +The percentage of failed requests in the sample where failover should trigger. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ResponseBasedOriginErrorDetectionParameters + +## 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. + + +`HTTPERRORRANGE `: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. + - `[Begin ]`: The inclusive start of the http status code range. + - `[End ]`: The inclusive end of the http status code range. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnUrlRedirectActionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnUrlRedirectActionObject.md new file mode 100644 index 0000000000..683191fcf3 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnUrlRedirectActionObject.md @@ -0,0 +1,172 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnUrlRedirectActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnUrlRedirectActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnUrlRedirectActionObject.md +--- + +# New-AzCdnUrlRedirectActionObject + +## SYNOPSIS +Create an in-memory object for UrlRedirectAction. + +## SYNTAX + +``` +New-AzCdnUrlRedirectActionObject -Name -ParameterRedirectType + [-ParameterCustomFragment ] [-ParameterCustomHostname ] [-ParameterCustomPath ] + [-ParameterCustomQueryString ] [-ParameterDestinationProtocol ] + [] +``` + +## DESCRIPTION +Create an in-memory object for UrlRedirectAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for UrlRedirectAction +```powershell +New-AzCdnUrlRedirectActionObject -Name rule01 -ParameterRedirectType redirect +``` + +```output +Name +---- +rule01 +``` + +Create an in-memory object for UrlRedirectAction + +## PARAMETERS + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterCustomFragment +Fragment to add to the redirect URL. +Fragment is the part of the URL that comes after #. +Do not include the #. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterCustomHostname +Host to redirect. +Leave empty to use the incoming host as the destination host. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterCustomPath +The full path to redirect. +Path cannot be empty and must start with /. +Leave empty to use the incoming path as destination path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterCustomQueryString +The set of query strings to be placed in the redirect URL. +Setting this value would replace any existing query string; leave empty to preserve the incoming query string. +Query string must be in \=\ format. +? and & will be added automatically so do not include them. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterDestinationProtocol +Protocol to use for the redirect. +The default value is MatchRequest. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DestinationProtocol +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterRedirectType +The redirect type the rule will use when redirecting traffic. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.RedirectType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.UrlRedirectAction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnUrlRewriteActionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnUrlRewriteActionObject.md new file mode 100644 index 0000000000..e78ef50dbf --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnUrlRewriteActionObject.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnUrlRewriteActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnUrlRewriteActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnUrlRewriteActionObject.md +--- + +# New-AzCdnUrlRewriteActionObject + +## SYNOPSIS +Create an in-memory object for UrlRewriteAction. + +## SYNTAX + +``` +New-AzCdnUrlRewriteActionObject -Name -ParameterDestination + -ParameterSourcePattern [-ParameterPreserveUnmatchedPath ] [] +``` + +## DESCRIPTION +Create an in-memory object for UrlRewriteAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for UrlRewriteAction +```powershell +New-AzCdnUrlRewriteActionObject -Name rewrite01 -ParameterDestination dest01 -ParameterSourcePattern pattern01 +``` + +```output +Name +---- +rewrite01 +``` + +Create an in-memory object for UrlRewriteAction + +## PARAMETERS + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterDestination +Define the relative URL to which the above requests will be rewritten by. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterPreserveUnmatchedPath +Whether to preserve unmatched path. +Default value is true. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterSourcePattern +define a request URI pattern that identifies the type of requests that may be rewritten. +If value is blank, all strings are matched. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.UrlRewriteAction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnUrlSigningActionObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnUrlSigningActionObject.md new file mode 100644 index 0000000000..9610a0d19e --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnUrlSigningActionObject.md @@ -0,0 +1,112 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnUrlSigningActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnUrlSigningActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnUrlSigningActionObject.md +--- + +# New-AzCdnUrlSigningActionObject + +## SYNOPSIS +Create an in-memory object for UrlSigningAction. + +## SYNTAX + +``` +New-AzCdnUrlSigningActionObject -Name [-ParameterAlgorithm ] + [-ParameterNameOverride ] [] +``` + +## DESCRIPTION +Create an in-memory object for UrlSigningAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for UrlSigningAction +```powershell +New-AzCdnUrlSigningActionObject -Name action01 +``` + +```output +Name +---- +action01 +``` + +Create an in-memory object for UrlSigningAction + +## PARAMETERS + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterAlgorithm +Algorithm to use for URL signing. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Algorithm +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNameOverride +Defines which query string parameters in the url to be considered for expires, key id etc. +. +To construct, see NOTES section for PARAMETERNAMEOVERRIDE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IUrlSigningParamIdentifier[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.UrlSigningAction + +## 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. + + +`PARAMETERNAMEOVERRIDE `: Defines which query string parameters in the url to be considered for expires, key id etc. . + - `ParamIndicator `: Indicates the purpose of the parameter + - `ParamName `: Parameter name + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzCdnUserManagedHttpsParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzCdnUserManagedHttpsParametersObject.md new file mode 100644 index 0000000000..213a0b5159 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzCdnUserManagedHttpsParametersObject.md @@ -0,0 +1,179 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzCdnUserManagedHttpsParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnUserManagedHttpsParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzCdnUserManagedHttpsParametersObject.md +--- + +# New-AzCdnUserManagedHttpsParametersObject + +## SYNOPSIS +Create an in-memory object for UserManagedHttpsParameters. + +## SYNTAX + +``` +New-AzCdnUserManagedHttpsParametersObject -CertificateSource + -CertificateSourceParameterResourceGroupName -CertificateSourceParameterSecretName + -CertificateSourceParameterSubscriptionId -CertificateSourceParameterVaultName + -ProtocolType [-CertificateSourceParameterSecretVersion ] + [-MinimumTlsVersion ] [] +``` + +## DESCRIPTION +Create an in-memory object for UserManagedHttpsParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for UserManagedHttpsParameters +```powershell +New-AzCdnUserManagedHttpsParametersObject -CertificateSource certSource -CertificateSourceParameterResourceGroupName rgName -CertificateSourceParameterSecretName secretName -CertificateSourceParameterSubscriptionId subId -CertificateSourceParameterVaultName kvName -ProtocolType typeTest +``` + +```output +CertificateSource MinimumTlsVersion ProtocolType +----------------- ----------------- ------------ +certSource typeTest +``` + +Create an in-memory object for UserManagedHttpsParameters + +## PARAMETERS + +### -CertificateSource +Defines the source of the SSL certificate. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.CertificateSource +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateSourceParameterResourceGroupName +Resource group of the user's Key Vault containing the SSL certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateSourceParameterSecretName +The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateSourceParameterSecretVersion +The version(GUID) of Key Vault Secret in Key Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateSourceParameterSubscriptionId +Subscription Id of the user's Key Vault containing the SSL certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateSourceParameterVaultName +The name of the user's Key Vault containing the SSL certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +TLS protocol version that will be used for Https. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MinimumTlsVersion +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtocolType +Defines the TLS extension protocol that is used for secure delivery. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ProtocolType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.UserManagedHttpsParameters + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnCustomDomain.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnCustomDomain.md new file mode 100644 index 0000000000..3fc97054f0 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnCustomDomain.md @@ -0,0 +1,287 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azfrontdoorcdncustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnCustomDomain.md +--- + +# New-AzFrontDoorCdnCustomDomain + +## SYNOPSIS +Creates a new domain within the specified profile. + +## SYNTAX + +``` +New-AzFrontDoorCdnCustomDomain -CustomDomainName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-AzureDnsZoneId ] [-ExtendedProperty ] [-HostName ] + [-PropertiesPreValidatedCustomDomainResourceId ] [-TlsSetting ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new domain within the specified profile. + +## EXAMPLES + +### Example 1: Creates an AzureFrontDoor domain within the specified AzureFrontDoor profile +```powershell +$secret = Get-AzFrontDoorCdnSecret -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name secret001 +$secretResoure = New-AzFrontDoorCdnResourceReferenceObject -Id $secret.Id +$tlsSetting = New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject -CertificateType "CustomerCertificate" -MinimumTlsVersion "TLS12" -Secret $secretResoure +New-AzFrontDoorCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -CustomDomainName domain001 -HostName "pstest001.dev.cdn.azure.cn" -TlsSetting $tlsSetting +``` + +```output +Name ResourceGroupName +---- ----------------- +domain001 testps-rg-da16jm +``` + +Creates an AzureFrontDoor domain within the specified AzureFrontDoor profile + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureDnsZoneId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDomainName +Name of the domain under the profile which is unique globally + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProperty +Key-Value pair representing migration properties for domains. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +The host name of the domain. +Must be a domain name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertiesPreValidatedCustomDomainResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TlsSetting +The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. +If not specified, enabling ssl uses AzureFrontDoor managed certificate by default. +To construct, see NOTES section for TLSSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdDomainHttpsParameters +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdDomain + +## 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. + + +`TLSSETTING `: The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default. + - `CertificateType `: Defines the source of the SSL certificate. + - `[MinimumTlsVersion ]`: TLS protocol version that will be used for Https + - `[Secret ]`: Resource reference to the secret. ie. subs/rg/profile/secret + - `[Id ]`: Resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject.md new file mode 100644 index 0000000000..2a6267c836 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject.md @@ -0,0 +1,114 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnCustomDomainTlsSettingParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject.md +--- + +# New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject + +## SYNOPSIS +Create an in-memory object for AFDDomainHttpsParameters. + +## SYNTAX + +``` +New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject -CertificateType + [-MinimumTlsVersion ] [-Secret ] [] +``` + +## DESCRIPTION +Create an in-memory object for AFDDomainHttpsParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for AFDDomainHttpsParameters +```powershell +$secret = Get-AzFrontDoorCdnSecret -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name secret001 +$secretResoure = New-AzFrontDoorCdnResourceReferenceObject -Id $secret.Id +New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject -CertificateType "CustomerCertificate" -MinimumTlsVersion "TLS12" -Secret $secretResoure +``` + +```output +CertificateType MinimumTlsVersion +--------------- ----------------- +CustomerCertificate TLS12 +``` + +Create an in-memory object for AFDDomainHttpsParameters + +## PARAMETERS + +### -CertificateType +Defines the source of the SSL certificate. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.AfdCertificateType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +TLS protocol version that will be used for Https. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.AfdMinimumTlsVersion +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Secret +Resource reference to the secret. +ie. +subs/rg/profile/secret. +To construct, see NOTES section for SECRET properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IResourceReference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.AfdDomainHttpsParameters + +## 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. + + +`SECRET `: Resource reference to the secret. ie. subs/rg/profile/secret. + - `[Id ]`: Resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnEndpoint.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnEndpoint.md new file mode 100644 index 0000000000..1090c9057b --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnEndpoint.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azfrontdoorcdnendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnEndpoint.md +--- + +# New-AzFrontDoorCdnEndpoint + +## SYNOPSIS +Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +## SYNTAX + +``` +New-AzFrontDoorCdnEndpoint -EndpointName -ProfileName -ResourceGroupName + -Location [-SubscriptionId ] + [-AutoGeneratedDomainNameLabelScope ] [-EnabledState ] + [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +## EXAMPLES + +### Example 1: Create an AzureFrontDoor endpoint under the AzureFrontDoor profile +```powershell +New-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 -Location Global -EnabledState Enabled +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +Global end001 testps-rg-da16jm +``` + +Create an AzureFrontDoor endpoint under the AzureFrontDoor profile + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoGeneratedDomainNameLabelScope +Indicates the endpoint name reuse scope. +The default value is TenantReuse. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.AutoGeneratedDomainNameLabelScope +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Whether to enable use of this rule. +Permitted values are 'Enabled' or 'Disabled' + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.EnabledState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdEndpoint + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnMigrationParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnMigrationParametersObject.md new file mode 100644 index 0000000000..10a4fe62ca --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnMigrationParametersObject.md @@ -0,0 +1,127 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzFrontDoorCdnMigrationParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnMigrationParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnMigrationParametersObject.md +--- + +# New-AzFrontDoorCdnMigrationParametersObject + +## SYNOPSIS +Create an in-memory object for MigrationParameters. + +## SYNTAX + +``` +New-AzFrontDoorCdnMigrationParametersObject -ProfileName [-ClassicResourceReferenceId ] + [-MigrationWebApplicationFirewallMapping ] [-SkuName ] + [] +``` + +## DESCRIPTION +Create an in-memory object for MigrationParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for MigrationParameters +```powershell +New-AzFrontDoorCdnMigrationParametersObject -ProfileName test +``` + +```output +ProfileName +----------- +test +``` + +Create an in-memory object for MigrationParameters + +## PARAMETERS + +### -ClassicResourceReferenceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationWebApplicationFirewallMapping +Waf mapping for the migrated profile. +To construct, see NOTES section for MIGRATIONWEBAPPLICATIONFIREWALLMAPPING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IMigrationWebApplicationFirewallMapping[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the new profile that need to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name of the pricing tier. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.MigrationParameters + +## 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. + + +`MIGRATIONWEBAPPLICATIONFIREWALLMAPPING `: Waf mapping for the migrated profile. + - `[MigratedFromId ]`: Resource ID. + - `[MigratedToId ]`: Resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject.md new file mode 100644 index 0000000000..bbcc6aa276 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject.md @@ -0,0 +1,86 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject.md +--- + +# New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject + +## SYNOPSIS +Create an in-memory object for MigrationWebApplicationFirewallMapping. + +## SYNTAX + +``` +New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject [-MigratedFromId ] + [-MigratedToId ] [] +``` + +## DESCRIPTION +Create an in-memory object for MigrationWebApplicationFirewallMapping. + +## EXAMPLES + +### Example 1: Create an in-memory object for MigrationWebApplicationFirewallMapping +```powershell +New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject -MigratedFromId migrateFromId -MigratedToId migrateToId +``` + +```output +MigratedFromId MigratedToId +-------------- ------------ +migrateFromId migrateToId +``` + +Create an in-memory object for MigrationWebApplicationFirewallMapping + +## PARAMETERS + +### -MigratedFromId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigratedToId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.MigrationWebApplicationFirewallMapping + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnOrigin.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnOrigin.md new file mode 100644 index 0000000000..af53b3e5ff --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnOrigin.md @@ -0,0 +1,434 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azfrontdoorcdnorigin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnOrigin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnOrigin.md +--- + +# New-AzFrontDoorCdnOrigin + +## SYNOPSIS +Creates a new origin within the specified origin group. + +## SYNTAX + +``` +New-AzFrontDoorCdnOrigin -OriginGroupName -OriginName -ProfileName + -ResourceGroupName [-SubscriptionId ] [-AzureOriginId ] + [-EnabledState ] [-EnforceCertificateNameCheck] [-HostName ] [-HttpPort ] + [-HttpsPort ] [-OriginHostHeader ] [-Priority ] [-PrivateLinkId ] + [-SharedPrivateLinkResourceGroupId ] [-SharedPrivateLinkResourcePrivateLinkLocation ] + [-SharedPrivateLinkResourceRequestMessage ] + [-SharedPrivateLinkResourceStatus ] [-Weight ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new origin within the specified origin group. + +## EXAMPLES + +### Example 1: Create an AzureFrontDoor origin under the AzureFrontDoor origin group +```powershell + New-AzFrontDoorCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -OriginName ori001 -OriginHostHeader en.wikipedia.org -HostName en.wikipedia.org -HttpPort 80 -HttpsPort 443 -Priority 1 -Weight 1000 +``` + +```output +Name ResourceGroupName +---- ----------------- +ori001 testps-rg-da16jm +``` + +Create an AzureFrontDoor origin under the AzureFrontDoor origin group + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureOriginId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Whether to enable health probes to be made against backends defined under backendPools. +Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.EnabledState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforceCertificateNameCheck +Whether to enable certificate name check at origin level + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +The address of the origin. +Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPort +The value of the HTTP port. +Must be between 1 and 65535. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsPort +The value of the HTTPS port. +Must be between 1 and 65535. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginGroupName +Name of the origin group which is unique within the profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginHostHeader +The host header value sent to the origin with each request. +If you leave this blank, the request hostname determines this value. +Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +This overrides the host header defined at Endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginName +Name of the origin that is unique within the profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Priority of origin in given origin group for load balancing. +Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedPrivateLinkResourceGroupId +The group id from the provider of resource the shared private link resource is for. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedPrivateLinkResourcePrivateLinkLocation +The location of the shared private link resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedPrivateLinkResourceRequestMessage +The request message for requesting approval of the shared private link resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedPrivateLinkResourceStatus +Status of the shared private link resource. +Can be Pending, Approved, Rejected, Disconnected, or Timeout. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.SharedPrivateLinkResourceStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Weight +Weight of the origin in given origin group for load balancing. +Must be between 1 and 1000 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdOrigin + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnOriginGroup.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnOriginGroup.md new file mode 100644 index 0000000000..b423cec995 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnOriginGroup.md @@ -0,0 +1,279 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azfrontdoorcdnorigingroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnOriginGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnOriginGroup.md +--- + +# New-AzFrontDoorCdnOriginGroup + +## SYNOPSIS +Creates a new origin group within the specified profile. + +## SYNTAX + +``` +New-AzFrontDoorCdnOriginGroup -OriginGroupName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-HealthProbeSetting ] + [-LoadBalancingSetting ] [-SessionAffinityState ] + [-TrafficRestorationTimeToHealedOrNewEndpointsInMinute ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new origin group within the specified profile. + +## EXAMPLES + +### Example 1: Create an AzureFrontDoor origin group under the AzureFrontDoor profile +```powershell +$healthProbeSetting = New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject -ProbeIntervalInSecond 1 -ProbePath "/" -ProbeProtocol "Https" -ProbeRequestType "GET" +$loadBalancingSetting = New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject -AdditionalLatencyInMillisecond 200 -SampleSize 5 -SuccessfulSamplesRequired 4 +New-AzFrontDoorCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -LoadBalancingSetting $loadBalancingSetting -HealthProbeSetting $healthProbeSetting +``` + +```output +Name ResourceGroupName +---- ----------------- +org001 testps-rg-da16jm +``` + +Create an AzureFrontDoor origin group under the AzureFrontDoor profile + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthProbeSetting +Health probe settings to the origin that is used to determine the health of the origin. +To construct, see NOTES section for HEALTHPROBESETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IHealthProbeParameters +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancingSetting +Load balancing settings for a backend pool +To construct, see NOTES section for LOADBALANCINGSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ILoadBalancingSettingsParameters +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginGroupName +Name of the origin group which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionAffinityState +Whether to allow session affinity on this host. +Valid options are 'Enabled' or 'Disabled' + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.EnabledState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficRestorationTimeToHealedOrNewEndpointsInMinute +Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. +Default is 10 mins. +This property is currently not supported. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdOriginGroup + +## 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. + + +`HEALTHPROBESETTING `: Health probe settings to the origin that is used to determine the health of the origin. + - `[ProbeIntervalInSecond ]`: The number of seconds between health probes.Default is 240sec. + - `[ProbePath ]`: The path relative to the origin that is used to determine the health of the origin. + - `[ProbeProtocol ]`: Protocol to use for health probe. + - `[ProbeRequestType ]`: The type of health probe request that is made. + +`LOADBALANCINGSETTING `: Load balancing settings for a backend pool + - `[AdditionalLatencyInMillisecond ]`: The additional latency in milliseconds for probes to fall into the lowest latency bucket + - `[SampleSize ]`: The number of samples to consider for load balancing decisions + - `[SuccessfulSamplesRequired ]`: The number of samples within the sample period that must succeed + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject.md new file mode 100644 index 0000000000..5fa55c853a --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnOriginGroupHealthProbeSettingObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject.md +--- + +# New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject + +## SYNOPSIS +Create an in-memory object for HealthProbeParameters. + +## SYNTAX + +``` +New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject [-ProbeIntervalInSecond ] [-ProbePath ] + [-ProbeProtocol ] [-ProbeRequestType ] [] +``` + +## DESCRIPTION +Create an in-memory object for HealthProbeParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureFrontDoor origin group `HealthProbeSetting` object +```powershell +New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject -ProbeIntervalInSecond 1 -ProbePath "/" -ProbeProtocol "Https" -ProbeRequestType "GET" +``` + +```output +ProbeIntervalInSecond ProbePath ProbeProtocol ProbeRequestType +--------------------- --------- ------------- ---------------- +1 / Https GET +``` + +Create an in-memory object for AzureFrontDoor origin group `HealthProbeSetting` object + +## PARAMETERS + +### -ProbeIntervalInSecond +The number of seconds between health probes.Default is 240sec. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbePath +The path relative to the origin that is used to determine the health of the origin. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeProtocol +Protocol to use for health probe. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ProbeProtocol +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeRequestType +The type of health probe request that is made. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.HealthProbeRequestType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.HealthProbeParameters + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject.md new file mode 100644 index 0000000000..94346519b3 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject.md @@ -0,0 +1,101 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject.md +--- + +# New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject + +## SYNOPSIS +Create an in-memory object for LoadBalancingSettingsParameters. + +## SYNTAX + +``` +New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject [-AdditionalLatencyInMillisecond ] + [-SampleSize ] [-SuccessfulSamplesRequired ] [] +``` + +## DESCRIPTION +Create an in-memory object for LoadBalancingSettingsParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureFrontDoor origin group `LoadBalancingSetting` object +```powershell +New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject -AdditionalLatencyInMillisecond 200 -SampleSize 5 -SuccessfulSamplesRequired 4 +``` + +```output +AdditionalLatencyInMillisecond SampleSize SuccessfulSamplesRequired +------------------------------ ---------- ------------------------- +200 5 4 +``` + +Create an in-memory object for AzureFrontDoor origin group `LoadBalancingSetting` object + +## PARAMETERS + +### -AdditionalLatencyInMillisecond +The additional latency in milliseconds for probes to fall into the lowest latency bucket. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SampleSize +The number of samples to consider for load balancing decisions. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuccessfulSamplesRequired +The number of samples within the sample period that must succeed. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.LoadBalancingSettingsParameters + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnProfile.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnProfile.md new file mode 100644 index 0000000000..a02e2e2c3a --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnProfile.md @@ -0,0 +1,272 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azfrontdoorcdnprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnProfile.md +--- + +# New-AzFrontDoorCdnProfile + +## SYNOPSIS +Creates a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group. + +## SYNTAX + +``` +New-AzFrontDoorCdnProfile -Name -ResourceGroupName -Location + [-SubscriptionId ] [-IdentityType ] + [-IdentityUserAssignedIdentity ] [-OriginResponseTimeoutSecond ] [-SkuName ] + [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group. + +## EXAMPLES + +### Example 1: Create an AzureFrontDoor profile under the resource group +```powershell +New-AzFrontDoorCdnProfile -ResourceGroupName testps-rg-da16jm -Name fdp-v542q6 -SkuName Standard_AzureFrontDoor -Location Global +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global fdp-v542q6 frontdoor testps-rg-da16jm +``` + +Create an AzureFrontDoor profile under the resource group + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginResponseTimeoutSecond +Send and receive timeout on forwarding request to the origin. +When timeout is reached, the request fails and returns. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name of the pricing tier. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IProfile + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnProfileChangeSkuWafMappingObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnProfileChangeSkuWafMappingObject.md new file mode 100644 index 0000000000..68b5b4f620 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnProfileChangeSkuWafMappingObject.md @@ -0,0 +1,86 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzFrontDoorCdnProfileChangeSkuWafMappingObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnProfileChangeSkuWafMappingObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnProfileChangeSkuWafMappingObject.md +--- + +# New-AzFrontDoorCdnProfileChangeSkuWafMappingObject + +## SYNOPSIS +Create an in-memory object for ProfileChangeSkuWafMapping. + +## SYNTAX + +``` +New-AzFrontDoorCdnProfileChangeSkuWafMappingObject -SecurityPolicyName + [-ChangeToWafPolicyId ] [] +``` + +## DESCRIPTION +Create an in-memory object for ProfileChangeSkuWafMapping. + +## EXAMPLES + +### Example 1: Create an in-memory object for ProfileChangeSkuWafMapping. +```powershell +New-AzFrontDoorCdnProfileChangeSkuWafMappingObject -SecurityPolicyName policyName -ChangeToWafPolicyId toWafPolicyId +``` + +```output +SecurityPolicyName +------------------ +policyName +``` + +Create an in-memory object for ProfileChangeSkuWafMapping + +## PARAMETERS + +### -ChangeToWafPolicyId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityPolicyName +The security policy name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ProfileChangeSkuWafMapping + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnProfileUpgradeParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnProfileUpgradeParametersObject.md new file mode 100644 index 0000000000..6a381c9685 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnProfileUpgradeParametersObject.md @@ -0,0 +1,104 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzFrontDoorCdnProfileUpgradeParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnProfileUpgradeParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnProfileUpgradeParametersObject.md +--- + +# New-AzFrontDoorCdnProfileUpgradeParametersObject + +## SYNOPSIS +Create an in-memory object for ProfileUpgradeParameters. + +## SYNTAX + +``` +New-AzFrontDoorCdnProfileUpgradeParametersObject -WafMappingList + [] +``` + +## DESCRIPTION +Create an in-memory object for ProfileUpgradeParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for ProfileUpgradeParameters. +```powershell +$waf1 = New-AzFrontDoorCdnProfileChangeSkuWafMappingObject -SecurityPolicyName policyName -ChangeToWafPolicyId toWafPolicyId +New-AzFrontDoorCdnProfileUpgradeParametersObject -WafMappingList $waf1 +``` + +```output +WafMappingList +-------------- +{{… +``` + +Create an in-memory object for ProfileUpgradeParameters. + +### Example 2: Create an in-memory object for ProfileUpgradeParameters, show the details of the object. +```powershell +$waf1 = New-AzFrontDoorCdnProfileChangeSkuWafMappingObject -SecurityPolicyName policyName -ChangeToWafPolicyId toWafPolicyId +$upgrade = New-AzFrontDoorCdnProfileUpgradeParametersObject -WafMappingList $waf1 +$upgrade.ToString() +``` + +```output +{ + "wafMappingList": [ + { + "changeToWafPolicy": { + "id": "toWafPolicyId" + }, + "securityPolicyName": "policyName" + } + ] +} +``` + +Create an in-memory object for ProfileUpgradeParameters, show the details of the object. + +## PARAMETERS + +### -WafMappingList +Web Application Firewall (WAF) and security policy mapping for the profile upgrade. +To construct, see NOTES section for WAFMAPPINGLIST properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IProfileChangeSkuWafMapping[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ProfileUpgradeParameters + +## 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. + + +`WAFMAPPINGLIST `: Web Application Firewall (WAF) and security policy mapping for the profile upgrade. + - `SecurityPolicyName `: The security policy name. + - `[ChangeToWafPolicyId ]`: Resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnPurgeParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnPurgeParametersObject.md new file mode 100644 index 0000000000..137510d0f2 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnPurgeParametersObject.md @@ -0,0 +1,87 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/Az.Cdn/new-AzFrontDoorCdnPurgeParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnPurgeParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnPurgeParametersObject.md +--- + +# New-AzFrontDoorCdnPurgeParametersObject + +## SYNOPSIS +Create an in-memory object for AfdPurgeParameters. + +## SYNTAX + +``` +New-AzFrontDoorCdnPurgeParametersObject -ContentPath [-Domain ] [] +``` + +## DESCRIPTION +Create an in-memory object for AfdPurgeParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for AfdPurgeParameters +```powershell +$contentPath = "/a" +$content = New-AzFrontDoorCdnPurgeParametersObject -ContentPath $contentPath +``` + +```output +ContentPath +----------- +{/a} +``` + +Create an in-memory object for AfdPurgeParameters + +## PARAMETERS + +### -ContentPath +The path to the content to be purged. +Can describe a file path or a wild card directory. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +List of domains. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.AfdPurgeParameters + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnResourceReferenceObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnResourceReferenceObject.md new file mode 100644 index 0000000000..cf864887a2 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnResourceReferenceObject.md @@ -0,0 +1,71 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnResourceReferenceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnResourceReferenceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnResourceReferenceObject.md +--- + +# New-AzFrontDoorCdnResourceReferenceObject + +## SYNOPSIS +Create an in-memory object for ResourceReference. + +## SYNTAX + +``` +New-AzFrontDoorCdnResourceReferenceObject [-Id ] [] +``` + +## DESCRIPTION +Create an in-memory object for ResourceReference. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureCDN ResourceReference +```powershell +$secret = Get-AzFrontDoorCdnSecret -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name secret001 +New-AzFrontDoorCdnResourceReferenceObject -Id $secret.Id +``` + +```output +Id +-- +/subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourcegroups/testps-rg-da16jm/providers/Microsoft.Cdn/profiles/fdp-v542q6/secrets/secret001 +``` + +Create an in-memory object for AzureCDN ResourceReference + +## PARAMETERS + +### -Id +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ResourceReference + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRoute.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRoute.md new file mode 100644 index 0000000000..c3e011ca1a --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRoute.md @@ -0,0 +1,454 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azfrontdoorcdnroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRoute.md +--- + +# New-AzFrontDoorCdnRoute + +## SYNOPSIS +Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint. + +## SYNTAX + +``` +New-AzFrontDoorCdnRoute -EndpointName -Name -ProfileName + -ResourceGroupName [-SubscriptionId ] [-CacheConfigurationQueryParameter ] + [-CacheConfigurationQueryStringCachingBehavior ] + [-CompressionSettingContentTypesToCompress ] [-CompressionSettingIsCompressionEnabled] + [-CustomDomain ] [-EnabledState ] + [-ForwardingProtocol ] [-HttpsRedirect ] + [-LinkToDefaultDomain ] [-OriginGroupId ] [-OriginPath ] + [-PatternsToMatch ] [-RuleSet ] [-SupportedProtocol ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint. + +## EXAMPLES + +### Example 1: Create an AzureFrontDoor route under the AzureFrontDoor profile +```powershell +$originGroup = Get-AzFrontDoorCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 +$ruleSet = Get-AzFrontDoorCdnRuleSet -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 +$customdomain = Get-AzFrontDoorCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -CustomDomainName domain001 + +$ruleSetResoure = New-AzFrontDoorCdnResourceReferenceObject -Id $ruleSet.Id +$customdomainResoure = New-AzFrontDoorCdnResourceReferenceObject -Id $customdomain.Id + +New-AzFrontDoorCdnRoute -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 -Name route001 -OriginGroupId $originGroup.Id -RuleSet @($ruleSetResoure) -PatternsToMatch "/*" -LinkToDefaultDomain "Enabled" -EnabledState "Enabled" -CustomDomain @($customdomainResoure) + +``` + +```output +Name ResourceGroupName +---- ----------------- +route001 testps-rg-da16jm +``` + +Create an AzureFrontDoor route under the AzureFrontDoor profile + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CacheConfigurationQueryParameter +query parameters to include or exclude (comma separated). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CacheConfigurationQueryStringCachingBehavior +Defines how Frontdoor caches requests that include query strings. +You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.AfdQueryStringCachingBehavior +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompressionSettingContentTypesToCompress +List of content types on which compression applies. +The value should be a valid MIME type. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompressionSettingIsCompressionEnabled +Indicates whether content compression is enabled on AzureFrontDoor. +Default value is false. +If compression is enabled, content will be served as compressed if user requests for a compressed version. +Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDomain +Domains referenced by this endpoint. +To construct, see NOTES section for CUSTOMDOMAIN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IActivatedResourceReference[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Whether to enable use of this rule. +Permitted values are 'Enabled' or 'Disabled' + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.EnabledState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingProtocol +Protocol this rule will use when forwarding traffic to backends. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ForwardingProtocol +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsRedirect +Whether to automatically redirect HTTP traffic to HTTPS traffic. +Note that this is a easy way to set up this rule and it will be the first rule that gets executed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.HttpsRedirect +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkToDefaultDomain +whether this route will be linked to the default endpoint domain. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.LinkToDefaultDomain +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the routing rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RouteName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginGroupId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginPath +A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. +contoso.cloudapp.net/originpath. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PatternsToMatch +The route patterns of the rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSet +rule sets referenced by this endpoint. +To construct, see NOTES section for RULESET properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IResourceReference[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportedProtocol +List of supported protocols for this route. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.AfdEndpointProtocols[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IRoute + +## 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. + + +`CUSTOMDOMAIN `: Domains referenced by this endpoint. + - `[Id ]`: Resource ID. + +`RULESET `: rule sets referenced by this endpoint. + - `[Id ]`: Resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRule.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRule.md new file mode 100644 index 0000000000..3280332197 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRule.md @@ -0,0 +1,301 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azfrontdoorcdnrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRule.md +--- + +# New-AzFrontDoorCdnRule + +## SYNOPSIS +Creates a new delivery rule within the specified rule set. + +## SYNTAX + +``` +New-AzFrontDoorCdnRule -Name -ProfileName -ResourceGroupName -SetName + [-SubscriptionId ] [-Action ] [-Condition ] + [-MatchProcessingBehavior ] [-Order ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new delivery rule within the specified rule set. + +## EXAMPLES + +### Example 1: Creates an AzureFrontDoor delivery rule within the specified rule set +```powershell +$conditions = @( + New-AzFrontDoorCdnRuleClientPortConditionObject -Name ClientPort -ParameterOperator Equal -ParameterMatchValue 80,81 + New-AzFrontDoorCdnRuleIsDeviceConditionObject -Name IsDevice -ParameterMatchValue Mobile + New-AzFrontDoorCdnRuleSslProtocolConditionObject -Name SslProtocol -ParameterMatchValue TLSv1.2 +); + + +$actions = @( + New-AzFrontDoorCdnRuleRequestHeaderActionObject -Name ModifyRequestHeader -ParameterHeaderAction Append -ParameterHeaderName a1 -ParameterValue a1 + New-AzFrontDoorCdnRuleResponseHeaderActionObject -Name ModifyResponseHeader -ParameterHeaderAction Append -ParameterHeaderName a1 -ParameterValue a1 + New-AzFrontDoorCdnRuleUrlRedirectActionObject -Name UrlRedirect -ParameterRedirectType Moved -ParameterDestinationProtocol MatchRequest +); + +New-AzFrontDoorCdnRule -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 -Name rule1 -Action $actions -Condition $conditions +``` + +```output +Name ResourceGroupName +---- ----------------- +rule1 testps-rg-da16jm +``` + +Creates an AzureFrontDoor delivery rule within the specified rule set + +## PARAMETERS + +### -Action +A list of actions that are executed when all the conditions of a rule are satisfied. +To construct, see NOTES section for ACTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IDeliveryRuleAction1[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Condition +A list of conditions that must be matched for the actions to be executed +To construct, see NOTES section for CONDITION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IDeliveryRuleCondition[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchProcessingBehavior +If this rule is a match should the rules engine continue running the remaining rules or stop. +If not present, defaults to Continue. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchProcessingBehavior +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the delivery rule which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +The order in which the rules are applied for the endpoint. +Possible values {0,1,2,3,………}. +A rule with a lesser order will be applied before a rule with a greater order. +Rule with order 0 is a special rule. +It does not require any condition and actions listed in it will always be applied. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetName +Name of the rule set under the profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RuleSetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IRule + +## 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. + + +`ACTION `: A list of actions that are executed when all the conditions of a rule are satisfied. + - `Name `: The name of the action for the delivery rule. + +`CONDITION `: A list of conditions that must be matched for the actions to be executed + - `Name `: The name of the condition for the delivery rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleClientPortConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleClientPortConditionObject.md new file mode 100644 index 0000000000..a3398a09a2 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleClientPortConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleClientPortConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleClientPortConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleClientPortConditionObject.md +--- + +# New-AzFrontDoorCdnRuleClientPortConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleClientPortCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleClientPortConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterTransform ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleClientPortCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleClientPortCondition +```powershell +New-AzFrontDoorCdnRuleClientPortConditionObject -Name ClientPort -ParameterOperator Equal -ParameterMatchValue 80,81 +``` + +```output +Name +---- +ClientPort +``` + +Create an in-memory object for DeliveryRuleClientPortCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ClientPortOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleClientPortCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleCookiesConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleCookiesConditionObject.md new file mode 100644 index 0000000000..68a30d46ce --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleCookiesConditionObject.md @@ -0,0 +1,147 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleCookiesConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleCookiesConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleCookiesConditionObject.md +--- + +# New-AzFrontDoorCdnRuleCookiesConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleCookiesCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleCookiesConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterSelector ] + [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleCookiesCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleCookiesCondition +```powershell +New-AzFrontDoorCdnRuleCookiesConditionObject -Name Cookies -ParameterOperator Equal -ParameterSelector test -ParameterMatchValue test -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +Cookies +``` + +Create an in-memory object for DeliveryRuleCookiesCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.CookiesOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterSelector +Name of Cookies to be matched. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleCookiesCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleHostNameConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleHostNameConditionObject.md new file mode 100644 index 0000000000..a0bbd83458 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleHostNameConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleHostNameConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleHostNameConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleHostNameConditionObject.md +--- + +# New-AzFrontDoorCdnRuleHostNameConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleHostNameCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleHostNameConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterTransform ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleHostNameCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleHostNameCondition +```powershell +New-AzFrontDoorCdnRuleHostNameConditionObject -Name HostName -ParameterOperator Equal -ParameterMatchValue azure.com +``` + +```output +Name +---- +HostName +``` + +Create an in-memory object for DeliveryRuleHostNameCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.HostNameOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleHostNameCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleHttpVersionConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleHttpVersionConditionObject.md new file mode 100644 index 0000000000..a48d464f8f --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleHttpVersionConditionObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleHttpVersionConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleHttpVersionConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleHttpVersionConditionObject.md +--- + +# New-AzFrontDoorCdnRuleHttpVersionConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleHttpVersionCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleHttpVersionConditionObject -Name [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleHttpVersionCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleHttpVersionCondition +```powershell +New-AzFrontDoorCdnRuleHttpVersionConditionObject -Name HttpVersion -ParameterMatchValue 2.0 +``` + +```output +Name +---- +HttpVersion +``` + +Create an in-memory object for DeliveryRuleHttpVersionCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleHttpVersionCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleIsDeviceConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleIsDeviceConditionObject.md new file mode 100644 index 0000000000..f65dab36c9 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleIsDeviceConditionObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleIsDeviceConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleIsDeviceConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleIsDeviceConditionObject.md +--- + +# New-AzFrontDoorCdnRuleIsDeviceConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleIsDeviceCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleIsDeviceConditionObject -Name [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleIsDeviceCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleIsDeviceCondition +```powershell +New-AzFrontDoorCdnRuleIsDeviceConditionObject -Name IsDevice -ParameterMatchValue Mobile +``` + +```output +Name +---- +IsDevice +``` + +Create an in-memory object for DeliveryRuleIsDeviceCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleIsDeviceCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRulePostArgsConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRulePostArgsConditionObject.md new file mode 100644 index 0000000000..d37a353f65 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRulePostArgsConditionObject.md @@ -0,0 +1,147 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRulePostArgsConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRulePostArgsConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRulePostArgsConditionObject.md +--- + +# New-AzFrontDoorCdnRulePostArgsConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRulePostArgsCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRulePostArgsConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterSelector ] + [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRulePostArgsCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRulePostArgsCondition +```powershell +New-AzFrontDoorCdnRulePostArgsConditionObject -Name PostArgs -ParameterOperator Equal -ParameterMatchValue test -ParameterNegateCondition $False -ParameterSelector test -ParameterTransform Lowercase +``` + +```output +Name +---- +PostArgs +``` + +Create an in-memory object for DeliveryRulePostArgsCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.PostArgsOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterSelector +Name of PostArg to be matched. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRulePostArgsCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleQueryStringConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleQueryStringConditionObject.md new file mode 100644 index 0000000000..5b47ea7345 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleQueryStringConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleQueryStringConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleQueryStringConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleQueryStringConditionObject.md +--- + +# New-AzFrontDoorCdnRuleQueryStringConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleQueryStringCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleQueryStringConditionObject -Name + -ParameterOperator [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleQueryStringCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleQueryStringCondition +```powershell +New-AzFrontDoorCdnRuleQueryStringConditionObject -Name QueryString -ParameterOperator Equal -ParameterMatchValue test -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +QueryString +``` + +Create an in-memory object for DeliveryRuleQueryStringCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.QueryStringOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleQueryStringCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRemoteAddressConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRemoteAddressConditionObject.md new file mode 100644 index 0000000000..b7c47d1aa8 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRemoteAddressConditionObject.md @@ -0,0 +1,134 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleRemoteAddressConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRemoteAddressConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRemoteAddressConditionObject.md +--- + +# New-AzFrontDoorCdnRuleRemoteAddressConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRemoteAddressCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleRemoteAddressConditionObject -Name + -ParameterOperator [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRemoteAddressCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleRemoteAddressCondition +```powershell +New-AzFrontDoorCdnRuleRemoteAddressConditionObject -Name RemoteAddress -ParameterOperator GeoMatch -ParameterMatchValue BJ -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +RemoteAddress +``` + +Create an in-memory object for DeliveryRuleRemoteAddressCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +Match values to match against. +The operator will apply to each value in here with OR semantics. +If any of them match the variable with the given operator this match condition is considered a match. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.RemoteAddressOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRemoteAddressCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestBodyConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestBodyConditionObject.md new file mode 100644 index 0000000000..ecfe7383c9 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestBodyConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleRequestBodyConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRequestBodyConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRequestBodyConditionObject.md +--- + +# New-AzFrontDoorCdnRuleRequestBodyConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRequestBodyCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleRequestBodyConditionObject -Name + -ParameterOperator [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRequestBodyCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleRequestBodyCondition +```powershell +New-AzFrontDoorCdnRuleRequestBodyConditionObject -Name RequestBody -ParameterOperator Equal -ParameterMatchValue test -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +RequestBody +``` + +Create an in-memory object for DeliveryRuleRequestBodyCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.RequestBodyOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRequestBodyCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestHeaderActionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestHeaderActionObject.md new file mode 100644 index 0000000000..7920484cf6 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestHeaderActionObject.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleRequestHeaderActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRequestHeaderActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRequestHeaderActionObject.md +--- + +# New-AzFrontDoorCdnRuleRequestHeaderActionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRequestHeaderAction. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleRequestHeaderActionObject -Name + -ParameterHeaderAction -ParameterHeaderName [-ParameterValue ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRequestHeaderAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleRequestHeaderAction +```powershell +New-AzFrontDoorCdnRuleRequestHeaderActionObject -Name ModifyRequestHeader -ParameterHeaderAction Append -ParameterHeaderName a1 -ParameterValue a1 +``` + +```output +Name +---- +ModifyRequestHeader +``` + +Create an in-memory object for DeliveryRuleRequestHeaderAction + +## PARAMETERS + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterHeaderAction +Action to perform. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.HeaderAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterHeaderName +Name of the header to modify. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterValue +Value for the specified action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRequestHeaderAction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestHeaderConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestHeaderConditionObject.md new file mode 100644 index 0000000000..1e48b6f332 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestHeaderConditionObject.md @@ -0,0 +1,148 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleRequestHeaderConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRequestHeaderConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRequestHeaderConditionObject.md +--- + +# New-AzFrontDoorCdnRuleRequestHeaderConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRequestHeaderCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleRequestHeaderConditionObject -Name + -ParameterOperator [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterSelector ] [-ParameterTransform ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRequestHeaderCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleRequestHeaderCondition +```powershell +New-AzFrontDoorCdnRuleRequestHeaderConditionObject -Name RequestHeader -ParameterOperator Equal -ParameterSelector test -ParameterMatchValue test -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +RequestHeader +``` + +Create an in-memory object for DeliveryRuleRequestHeaderCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.RequestHeaderOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterSelector +Name of Header to be matched. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRequestHeaderCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestMethodConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestMethodConditionObject.md new file mode 100644 index 0000000000..597730eca2 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestMethodConditionObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleRequestMethodConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRequestMethodConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRequestMethodConditionObject.md +--- + +# New-AzFrontDoorCdnRuleRequestMethodConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRequestMethodCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleRequestMethodConditionObject -Name [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRequestMethodCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleRequestMethodCondition +```powershell +New-AzFrontDoorCdnRuleRequestMethodConditionObject -Name RequestMethod -ParameterMatchValue GET +``` + +```output +Name +---- +RequestMethod +``` + +Create an in-memory object for DeliveryRuleRequestMethodCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRequestMethodCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestSchemeConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestSchemeConditionObject.md new file mode 100644 index 0000000000..7280029f3f --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestSchemeConditionObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleRequestSchemeConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRequestSchemeConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRequestSchemeConditionObject.md +--- + +# New-AzFrontDoorCdnRuleRequestSchemeConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRequestSchemeCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleRequestSchemeConditionObject -Name [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRequestSchemeCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleRequestSchemeCondition +```powershell +New-AzFrontDoorCdnRuleRequestSchemeConditionObject -Name RequestScheme -ParameterMatchValue HTTP +``` + +```output +Name +---- +RequestScheme +``` + +Create an in-memory object for DeliveryRuleRequestSchemeCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRequestSchemeCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestUriConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestUriConditionObject.md new file mode 100644 index 0000000000..e7441ce657 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRequestUriConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleRequestUriConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRequestUriConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRequestUriConditionObject.md +--- + +# New-AzFrontDoorCdnRuleRequestUriConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRequestUriCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleRequestUriConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterTransform ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRequestUriCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleRequestUriCondition +```powershell + New-AzFrontDoorCdnRuleRequestUriConditionObject -Name RequestUri -ParameterOperator Equal -ParameterMatchValue /test +``` + +```output +Name +---- +RequestUri +``` + +Create an in-memory object for DeliveryRuleRequestUriCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.RequestUriOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRequestUriCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleResponseHeaderActionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleResponseHeaderActionObject.md new file mode 100644 index 0000000000..1c1472cbb6 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleResponseHeaderActionObject.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleResponseHeaderActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleResponseHeaderActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleResponseHeaderActionObject.md +--- + +# New-AzFrontDoorCdnRuleResponseHeaderActionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleResponseHeaderAction. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleResponseHeaderActionObject -Name + -ParameterHeaderAction -ParameterHeaderName [-ParameterValue ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleResponseHeaderAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleResponseHeaderAction +```powershell +New-AzFrontDoorCdnRuleResponseHeaderActionObject -Name ModifyResponseHeader -ParameterHeaderAction Append -ParameterHeaderName a1 -ParameterValue a1 +``` + +```output +Name +---- +ModifyResponseHeader +``` + +Create an in-memory object for DeliveryRuleResponseHeaderAction + +## PARAMETERS + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterHeaderAction +Action to perform. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.HeaderAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterHeaderName +Name of the header to modify. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterValue +Value for the specified action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleResponseHeaderAction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRouteConfigurationOverrideActionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRouteConfigurationOverrideActionObject.md new file mode 100644 index 0000000000..6bb0a25a61 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleRouteConfigurationOverrideActionObject.md @@ -0,0 +1,185 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleRouteConfigurationOverrideActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRouteConfigurationOverrideActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleRouteConfigurationOverrideActionObject.md +--- + +# New-AzFrontDoorCdnRuleRouteConfigurationOverrideActionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleRouteConfigurationOverrideAction. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleRouteConfigurationOverrideActionObject -Name + [-CacheConfigurationCacheBehavior ] [-CacheConfigurationCacheDuration ] + [-CacheConfigurationIsCompressionEnabled ] + [-CacheConfigurationQueryParameter ] + [-CacheConfigurationQueryStringCachingBehavior ] [-OriginGroupId ] + [-OriginGroupOverrideForwardingProtocol ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleRouteConfigurationOverrideAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleRouteConfigurationOverrideAction +```powershell +$originGroupId = "xxxx" +New-AzFrontDoorCdnRuleRouteConfigurationOverrideActionObject -Name RouteConfigurationOverride -OriginGroupOverrideForwardingProtocol HttpOnly -OriginGroupId $originGroupId +``` + +```output +Name +---- +RouteConfigurationOverride +``` + +Create an in-memory object for DeliveryRuleRouteConfigurationOverrideAction + +## PARAMETERS + +### -CacheConfigurationCacheBehavior +Caching behavior for the requests. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.RuleCacheBehavior +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CacheConfigurationCacheDuration +The duration for which the content needs to be cached. +Allowed format is [d.]hh:mm:ss. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CacheConfigurationIsCompressionEnabled +Indicates whether content compression is enabled. +If compression is enabled, content will be served as compressed if user requests for a compressed version. +Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.RuleIsCompressionEnabled +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CacheConfigurationQueryParameter +query parameters to include or exclude (comma separated). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CacheConfigurationQueryStringCachingBehavior +Defines how Frontdoor caches requests that include query strings. +You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.RuleQueryStringCachingBehavior +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginGroupId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginGroupOverrideForwardingProtocol +Protocol this rule will use when forwarding traffic to backends. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ForwardingProtocol +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleRouteConfigurationOverrideAction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleServerPortConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleServerPortConditionObject.md new file mode 100644 index 0000000000..bc166beea2 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleServerPortConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleServerPortConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleServerPortConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleServerPortConditionObject.md +--- + +# New-AzFrontDoorCdnRuleServerPortConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleServerPortCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleServerPortConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterTransform ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleServerPortCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleServerPortCondition +```powershell +New-AzFrontDoorCdnRuleServerPortConditionObject -Name ServerPort -ParameterOperator Equal -ParameterMatchValue 80,81 +``` + +```output +Name +---- +ServerPort +``` + +Create an in-memory object for DeliveryRuleServerPortCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ServerPortOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleServerPortCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleSet.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleSet.md new file mode 100644 index 0000000000..cbb27c7cc8 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleSet.md @@ -0,0 +1,163 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azfrontdoorcdnruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleSet.md +--- + +# New-AzFrontDoorCdnRuleSet + +## SYNOPSIS +Creates a new rule set within the specified profile. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleSet -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new rule set within the specified profile. + +## EXAMPLES + +### Example 1: Create an AzureFrontDoor rule set under the AzureFrontDoor profile +```powershell +New-AzFrontDoorCdnRuleSet -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 +``` + +```output +Name ResourceGroupName +---- ----------------- +ruleset001 testps-rg-da16jm +``` + +Create an AzureFrontDoor rule set under the AzureFrontDoor profile + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the rule set under the profile which is unique globally + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RuleSetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IRuleSet + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleSocketAddrConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleSocketAddrConditionObject.md new file mode 100644 index 0000000000..e77aad19fa --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleSocketAddrConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleSocketAddrConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleSocketAddrConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleSocketAddrConditionObject.md +--- + +# New-AzFrontDoorCdnRuleSocketAddrConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleSocketAddrCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleSocketAddrConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterTransform ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleSocketAddrCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleSocketAddrCondition +```powershell + New-AzFrontDoorCdnRuleSocketAddrConditionObject -Name SocketAddr -ParameterOperator IPMatch -ParameterMatchValue 222.10.0.1 +``` + +```output +Name +---- +SocketAddr +``` + +Create an in-memory object for DeliveryRuleSocketAddrCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.SocketAddrOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleSocketAddrCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleSslProtocolConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleSslProtocolConditionObject.md new file mode 100644 index 0000000000..f70bb0c683 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleSslProtocolConditionObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleSslProtocolConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleSslProtocolConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleSslProtocolConditionObject.md +--- + +# New-AzFrontDoorCdnRuleSslProtocolConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleSslProtocolCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleSslProtocolConditionObject -Name [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleSslProtocolCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleSslProtocolCondition +```powershell +New-AzFrontDoorCdnRuleSslProtocolConditionObject -Name SslProtocol -ParameterMatchValue TLSv1.2 +``` + +```output +Name +---- +SslProtocol +``` + +Create an in-memory object for DeliveryRuleSslProtocolCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.SslProtocol[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleSslProtocolCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlFileExtensionConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlFileExtensionConditionObject.md new file mode 100644 index 0000000000..6e38151c89 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlFileExtensionConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleUrlFileExtensionConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleUrlFileExtensionConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleUrlFileExtensionConditionObject.md +--- + +# New-AzFrontDoorCdnRuleUrlFileExtensionConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleUrlFileExtensionCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleUrlFileExtensionConditionObject -Name + -ParameterOperator [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleUrlFileExtensionCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleUrlFileExtensionCondition +```powershell +New-AzFrontDoorCdnRuleUrlFileExtensionConditionObject -Name UrlFileExtension -ParameterOperator Equal -ParameterMatchValue txt -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +UrlFileExtension +``` + +Create an in-memory object for DeliveryRuleUrlFileExtensionCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.UrlFileExtensionOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleUrlFileExtensionCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlFileNameConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlFileNameConditionObject.md new file mode 100644 index 0000000000..a64931b1c6 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlFileNameConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleUrlFileNameConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleUrlFileNameConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleUrlFileNameConditionObject.md +--- + +# New-AzFrontDoorCdnRuleUrlFileNameConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleUrlFileNameCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleUrlFileNameConditionObject -Name + -ParameterOperator [-ParameterMatchValue ] + [-ParameterNegateCondition ] [-ParameterTransform ] [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleUrlFileNameCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleUrlFileNameCondition +```powershell +New-AzFrontDoorCdnRuleUrlFileNameConditionObject -Name UrlFileName -ParameterOperator Equal -ParameterMatchValue test -ParameterNegateCondition $False -ParameterTransform Lowercase +``` + +```output +Name +---- +UrlFileName +``` + +Create an in-memory object for DeliveryRuleUrlFileNameCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.UrlFileNameOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleUrlFileNameCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlPathConditionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlPathConditionObject.md new file mode 100644 index 0000000000..a78ec726a1 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlPathConditionObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleUrlPathConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleUrlPathConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleUrlPathConditionObject.md +--- + +# New-AzFrontDoorCdnRuleUrlPathConditionObject + +## SYNOPSIS +Create an in-memory object for DeliveryRuleUrlPathCondition. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleUrlPathConditionObject -Name -ParameterOperator + [-ParameterMatchValue ] [-ParameterNegateCondition ] [-ParameterTransform ] + [] +``` + +## DESCRIPTION +Create an in-memory object for DeliveryRuleUrlPathCondition. + +## EXAMPLES + +### Example 1: Create an in-memory object for DeliveryRuleUrlPathCondition +```powershell + New-AzFrontDoorCdnRuleUrlPathConditionObject -Name UrlPath -ParameterOperator Equal -ParameterMatchValue /a +``` + +```output +Name +---- +UrlPath +``` + +Create an in-memory object for DeliveryRuleUrlPathCondition + +## PARAMETERS + +### -Name +The name of the condition for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchVariable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterMatchValue +The match value for the condition of the delivery rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNegateCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterOperator +Describes operator to be matched. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.UrlPathOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterTransform +List of transforms. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Transform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.DeliveryRuleUrlPathCondition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlRedirectActionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlRedirectActionObject.md new file mode 100644 index 0000000000..de824824b1 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlRedirectActionObject.md @@ -0,0 +1,172 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleUrlRedirectActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleUrlRedirectActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleUrlRedirectActionObject.md +--- + +# New-AzFrontDoorCdnRuleUrlRedirectActionObject + +## SYNOPSIS +Create an in-memory object for UrlRedirectAction. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleUrlRedirectActionObject -Name -ParameterRedirectType + [-ParameterCustomFragment ] [-ParameterCustomHostname ] [-ParameterCustomPath ] + [-ParameterCustomQueryString ] [-ParameterDestinationProtocol ] + [] +``` + +## DESCRIPTION +Create an in-memory object for UrlRedirectAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for UrlRedirectAction +```powershell +New-AzFrontDoorCdnRuleUrlRedirectActionObject -Name UrlRedirect -ParameterRedirectType Moved -ParameterDestinationProtocol MatchRequest +``` + +```output +Name +---- +UrlRedirect +``` + +Create an in-memory object for UrlRedirectAction + +## PARAMETERS + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterCustomFragment +Fragment to add to the redirect URL. +Fragment is the part of the URL that comes after #. +Do not include the #. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterCustomHostname +Host to redirect. +Leave empty to use the incoming host as the destination host. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterCustomPath +The full path to redirect. +Path cannot be empty and must start with /. +Leave empty to use the incoming path as destination path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterCustomQueryString +The set of query strings to be placed in the redirect URL. +Setting this value would replace any existing query string; leave empty to preserve the incoming query string. +Query string must be in \=\ format. +? and & will be added automatically so do not include them. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterDestinationProtocol +Protocol to use for the redirect. +The default value is MatchRequest. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DestinationProtocol +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterRedirectType +The redirect type the rule will use when redirecting traffic. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.RedirectType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.UrlRedirectAction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlRewriteActionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlRewriteActionObject.md new file mode 100644 index 0000000000..ee5895fcf0 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlRewriteActionObject.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleUrlRewriteActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleUrlRewriteActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleUrlRewriteActionObject.md +--- + +# New-AzFrontDoorCdnRuleUrlRewriteActionObject + +## SYNOPSIS +Create an in-memory object for UrlRewriteAction. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleUrlRewriteActionObject -Name -ParameterDestination + -ParameterSourcePattern [-ParameterPreserveUnmatchedPath ] [] +``` + +## DESCRIPTION +Create an in-memory object for UrlRewriteAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for UrlRewriteAction +```powershell +New-AzFrontDoorCdnRuleUrlRewriteActionObject -Name UrlRewrite -ParameterDestination /b -ParameterSourcePattern /a -ParameterPreserveUnmatchedPath $False +``` + +```output +Name +---- +UrlRewrite +``` + +Create an in-memory object for UrlRewriteAction + +## PARAMETERS + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterDestination +Define the relative URL to which the above requests will be rewritten by. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterPreserveUnmatchedPath +Whether to preserve unmatched path. +Default value is true. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterSourcePattern +define a request URI pattern that identifies the type of requests that may be rewritten. +If value is blank, all strings are matched. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.UrlRewriteAction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlSigningActionObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlSigningActionObject.md new file mode 100644 index 0000000000..61ee2a81f9 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnRuleUrlSigningActionObject.md @@ -0,0 +1,112 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnRuleUrlSigningActionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleUrlSigningActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnRuleUrlSigningActionObject.md +--- + +# New-AzFrontDoorCdnRuleUrlSigningActionObject + +## SYNOPSIS +Create an in-memory object for UrlSigningAction. + +## SYNTAX + +``` +New-AzFrontDoorCdnRuleUrlSigningActionObject -Name [-ParameterAlgorithm ] + [-ParameterNameOverride ] [] +``` + +## DESCRIPTION +Create an in-memory object for UrlSigningAction. + +## EXAMPLES + +### Example 1: Create an in-memory object for UrlSigningAction +```powershell +New-AzFrontDoorCdnRuleUrlSigningActionObject -Name rule01 +``` + +```output +Name +---- +rule01 +``` + +Create an in-memory object for UrlSigningAction + +## PARAMETERS + +### -Name +The name of the action for the delivery rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.DeliveryRuleAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterAlgorithm +Algorithm to use for URL signing. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.Algorithm +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterNameOverride +Defines which query string parameters in the url to be considered for expires, key id etc. +. +To construct, see NOTES section for PARAMETERNAMEOVERRIDE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IUrlSigningParamIdentifier[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.UrlSigningAction + +## 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. + + +`PARAMETERNAMEOVERRIDE `: Defines which query string parameters in the url to be considered for expires, key id etc. . + - `ParamIndicator `: Indicates the purpose of the parameter + - `ParamName `: Parameter name + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecret.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecret.md new file mode 100644 index 0000000000..2ca865f1bc --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecret.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azfrontdoorcdnsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecret.md +--- + +# New-AzFrontDoorCdnSecret + +## SYNOPSIS +Creates a new Secret within the specified profile. + +## SYNTAX + +``` +New-AzFrontDoorCdnSecret -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-Parameter ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new Secret within the specified profile. + +## EXAMPLES + +### Example 1: Create an AzureFrontDoor Secret within the specified AzureFrontDoor profile +```powershell +$secretSourceId = "xxxxxxxx" +$certificateParameter = New-AzFrontDoorCdnSecretCustomerCertificateParametersObject -UseLatestVersion $true -SubjectAlternativeName @() -Type "CustomerCertificate" -SecretSourceId $secretSourceId +New-AzFrontDoorCdnSecret -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name secret001 -Parameter $certificateParameter +``` + +```output +Name ResourceGroupName +---- ----------------- +secret001 testps-rg-da16jm +``` + +Create an AzureFrontDoor Secret within the specified AzureFrontDoor profile + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Secret under the profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SecretName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +object which contains secret parameters +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ISecretParameters +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ISecret + +## 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. + + +`PARAMETER `: object which contains secret parameters + - `Type `: The type of the secret resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecretCustomerCertificateParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecretCustomerCertificateParametersObject.md new file mode 100644 index 0000000000..08cca1c7cf --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecretCustomerCertificateParametersObject.md @@ -0,0 +1,133 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnSecretCustomerCertificateParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecretCustomerCertificateParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecretCustomerCertificateParametersObject.md +--- + +# New-AzFrontDoorCdnSecretCustomerCertificateParametersObject + +## SYNOPSIS +Create an in-memory object for CustomerCertificateParameters. + +## SYNTAX + +``` +New-AzFrontDoorCdnSecretCustomerCertificateParametersObject -Type [-SecretSourceId ] + [-SecretVersion ] [-SubjectAlternativeName ] [-UseLatestVersion ] + [] +``` + +## DESCRIPTION +Create an in-memory object for CustomerCertificateParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureFrontDoor CustomerCertificateParameters +```powershell +$secretSourceId = "xxxxxxxx" +New-AzFrontDoorCdnSecretCustomerCertificateParametersObject -UseLatestVersion $true -SubjectAlternativeName @() -Type "CustomerCertificate" -SecretSourceId $secretSourceId +``` + +```output +CertificateAuthority ExpirationDate SecretVersion Subject SubjectAlternativeName Thumbprint UseLatestVersion +-------------------- -------------- ------------- ------- ---------------------- ---------- ---------------- + {} True +``` + +Create an in-memory object for AzureFrontDoor CustomerCertificateParameters + +## PARAMETERS + +### -SecretSourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretVersion +Version of the secret to be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectAlternativeName +The list of SANs. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The type of the secret resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.SecretType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseLatestVersion +Whether to use the latest version for the certificate. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.CustomerCertificateParameters + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecretFirstPartyManagedCertificateParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecretFirstPartyManagedCertificateParametersObject.md new file mode 100644 index 0000000000..b320a02a49 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecretFirstPartyManagedCertificateParametersObject.md @@ -0,0 +1,70 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnSecretFirstPartyManagedCertificateParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecretFirstPartyManagedCertificateParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecretFirstPartyManagedCertificateParametersObject.md +--- + +# New-AzFrontDoorCdnSecretFirstPartyManagedCertificateParametersObject + +## SYNOPSIS +Create an in-memory object for AzureFirstPartyManagedCertificateParameters. + +## SYNTAX + +``` +New-AzFrontDoorCdnSecretFirstPartyManagedCertificateParametersObject -Type [] +``` + +## DESCRIPTION +Create an in-memory object for AzureFirstPartyManagedCertificateParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureFirstPartyManagedCertificateParameters +```powershell +New-AzFrontDoorCdnSecretFirstPartyManagedCertificateParametersObject -Type BYOC +``` + +```output +Type +---- +BYOC +``` + +Create an in-memory object for AzureFirstPartyManagedCertificateParameters + +## PARAMETERS + +### -Type +The type of the secret resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.SecretType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.AzureFirstPartyManagedCertificateParameters + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecretManagedCertificateParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecretManagedCertificateParametersObject.md new file mode 100644 index 0000000000..27db99317f --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecretManagedCertificateParametersObject.md @@ -0,0 +1,69 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnSecretManagedCertificateParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecretManagedCertificateParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecretManagedCertificateParametersObject.md +--- + +# New-AzFrontDoorCdnSecretManagedCertificateParametersObject + +## SYNOPSIS +Create an in-memory object for ManagedCertificateParameters. + +## SYNTAX + +``` +New-AzFrontDoorCdnSecretManagedCertificateParametersObject -Type [] +``` + +## DESCRIPTION +Create an in-memory object for ManagedCertificateParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for ManagedCertificateParameters +```powershell +New-AzFrontDoorCdnSecretManagedCertificateParametersObject -Type ManagedCert +``` + +```output +ExpirationDate Subject +-------------- ------- +``` + +Create an in-memory object for ManagedCertificateParameters. + +## PARAMETERS + +### -Type +The type of the secret resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.SecretType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ManagedCertificateParameters + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecretUrlSigningKeyParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecretUrlSigningKeyParametersObject.md new file mode 100644 index 0000000000..b018067546 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecretUrlSigningKeyParametersObject.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnSecretUrlSigningKeyParametersObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecretUrlSigningKeyParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecretUrlSigningKeyParametersObject.md +--- + +# New-AzFrontDoorCdnSecretUrlSigningKeyParametersObject + +## SYNOPSIS +Create an in-memory object for UrlSigningKeyParameters. + +## SYNTAX + +``` +New-AzFrontDoorCdnSecretUrlSigningKeyParametersObject -KeyId -Type + [-SecretSourceId ] [-SecretVersion ] [] +``` + +## DESCRIPTION +Create an in-memory object for UrlSigningKeyParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for UrlSigningKeyParameters +```powershell +New-AzFrontDoorCdnSecretUrlSigningKeyParametersObject -KeyId keyId01 -Type Byoc -SecretVersion v1.0 +``` + +```output +KeyId SecretVersion +----- ------------- +keyId01 v1.0 +``` + +Create an in-memory object for UrlSigningKeyParameters. + +## PARAMETERS + +### -KeyId +Defines the customer defined key Id. +This id will exist in the incoming request to indicate the key used to form the hash. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretSourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretVersion +Version of the secret to be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The type of the secret resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.SecretType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.UrlSigningKeyParameters + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecurityPolicy.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecurityPolicy.md new file mode 100644 index 0000000000..e246d02a80 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecurityPolicy.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/new-azfrontdoorcdnsecuritypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecurityPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecurityPolicy.md +--- + +# New-AzFrontDoorCdnSecurityPolicy + +## SYNOPSIS +Creates a new security policy within the specified profile. + +## SYNTAX + +``` +New-AzFrontDoorCdnSecurityPolicy -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-Parameter ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new security policy within the specified profile. + +## EXAMPLES + +### Example 1: Create an AzureFrontDoor security policy within the specified AzureFrontDoor profile +```powershell +$wafPolicyId = "/subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourcegroups/rgName01/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf01" +$endpoint = Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 +$association = New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject -PatternsToMatch @("/*") -Domain @(@{"Id"=$($endpoint.Id)}) +$wafParameter = New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject -Association $association -WafPolicyId $wafPolicyId + +New-AzFrontDoorCdnSecurityPolicy -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name policy001 -Parameter $wafParameter +``` + +```output +Name ResourceGroupName +---- ----------------- +policy001 testps-rg-da16jm +``` + +Create an AzureFrontDoor security policy within the specified AzureFrontDoor profile + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the security policy under the profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SecurityPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +object which contains security policy parameters + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ISecurityPolicyPropertiesParameters +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ISecurityPolicy + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject.md new file mode 100644 index 0000000000..d4f401dd93 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject.md @@ -0,0 +1,96 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject.md +--- + +# New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject + +## SYNOPSIS +Create an in-memory object for SecurityPolicyWebApplicationFirewallAssociation. + +## SYNTAX + +``` +New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject + [-Domain ] [-PatternsToMatch ] [] +``` + +## DESCRIPTION +Create an in-memory object for SecurityPolicyWebApplicationFirewallAssociation. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureFrontDoor SecurityPolicyWebApplicationFirewallAssociation +```powershell +$endpoint = Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 +New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject -PatternsToMatch @("/*") -Domain @(@{"Id"=$($endpoint.Id)}) +``` + +```output +PatternsToMatch +--------------- +{/*} +``` + +Create an in-memory object for AzureFrontDoor SecurityPolicyWebApplicationFirewallAssociation + +## PARAMETERS + +### -Domain +List of domains. +To construct, see NOTES section for DOMAIN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IActivatedResourceReference[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PatternsToMatch +List of paths. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.SecurityPolicyWebApplicationFirewallAssociation + +## 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. + + +`DOMAIN `: List of domains. + - `[Id ]`: Resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject.md b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject.md new file mode 100644 index 0000000000..330ecaebdf --- /dev/null +++ b/azps-10.1.0/Az.Cdn/New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject.md @@ -0,0 +1,101 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.Cdn/new-azfrontdoorcdnsecuritypolicywebapplicationfirewallparametersobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject.md +--- + +# New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject + +## SYNOPSIS +Create an in-memory object for SecurityPolicyWebApplicationFirewallParameters. + +## SYNTAX + +``` +New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject + [-Association ] [-WafPolicyId ] + [] +``` + +## DESCRIPTION +Create an in-memory object for SecurityPolicyWebApplicationFirewallParameters. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureFrontDoor SecurityPolicyWebApplicationFirewallAssociation +```powershell +$endpoint = Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 +$association = New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject -PatternsToMatch @("/*") -Domain @(@{"Id"=$($endpoint.Id)}) +New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject -Association $association ` + -WafPolicyId $wafPolicyId +``` + +```output +Association +----------- +{{... +``` + +Create an in-memory object for AzureFrontDoor SecurityPolicyWebApplicationFirewallAssociation + +## PARAMETERS + +### -Association +Waf associations. +To construct, see NOTES section for ASSOCIATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ISecurityPolicyWebApplicationFirewallAssociation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WafPolicyId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.SecurityPolicyWebApplicationFirewallParameters + +## 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. + + +`ASSOCIATION `: Waf associations. + - `[Domain ]`: List of domains. + - `[Id ]`: Resource ID. + - `[PatternsToMatch ]`: List of paths + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzCdnCustomDomain.md b/azps-10.1.0/Az.Cdn/Remove-AzCdnCustomDomain.md new file mode 100644 index 0000000000..db90060d24 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzCdnCustomDomain.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azcdncustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzCdnCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzCdnCustomDomain.md +--- + +# Remove-AzCdnCustomDomain + +## SYNOPSIS +Deletes an existing custom domain within an endpoint. + +## SYNTAX + +### Delete1 (Default) +``` +Remove-AzCdnCustomDomain -EndpointName -Name -ProfileName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity1 +``` +Remove-AzCdnCustomDomain -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing custom domain within an endpoint. + +## EXAMPLES + +### Example 1: Delete an AzureCDN custom domain under the AzureCDN endpoint +```powershell +Remove-AzCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name customdomain001 +``` + +Delete an AzureCDN custom domain under the AzureCDN endpoint + +### Example 2: Delete an AzureCDN custom domain under the AzureCDN endpoint via identity +```powershell +Get-AzCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name customdomain001 | Remove-AzCdnCustomDomain +``` + +Delete an AzureCDN custom domain under the AzureCDN endpoint via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the custom domain within an endpoint. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: CustomDomainName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzCdnEndpoint.md b/azps-10.1.0/Az.Cdn/Remove-AzCdnEndpoint.md new file mode 100644 index 0000000000..efdc0650ff --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzCdnEndpoint.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azcdnendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzCdnEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzCdnEndpoint.md +--- + +# Remove-AzCdnEndpoint + +## SYNOPSIS +Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +## SYNTAX + +### Delete1 (Default) +``` +Remove-AzCdnEndpoint -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity1 +``` +Remove-AzCdnEndpoint -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +## EXAMPLES + +### Example 1: Delete an AzureCDN Endpoint under the AzureCDN profile +```powershell +Remove-AzCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -Name endptest001 +``` + +Delete an AzureCDN Endpoint under the AzureCDN profile + +### Example 2: Delete an AzureCDN Endpoint under the AzureCDN profile via identity +```powershell +Get-AzCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -Name endptest001 | Remove-AzCdnEndpoint +``` + +Delete an AzureCDN Endpoint under the AzureCDN profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzCdnOrigin.md b/azps-10.1.0/Az.Cdn/Remove-AzCdnOrigin.md new file mode 100644 index 0000000000..900458c9b3 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzCdnOrigin.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azcdnorigin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzCdnOrigin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzCdnOrigin.md +--- + +# Remove-AzCdnOrigin + +## SYNOPSIS +Deletes an existing origin within an endpoint. + +## SYNTAX + +### Delete1 (Default) +``` +Remove-AzCdnOrigin -EndpointName -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity1 +``` +Remove-AzCdnOrigin -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing origin within an endpoint. + +## EXAMPLES + +### Example 1: Delete an AzureCDN origin group under the AzureCDN endpoint +```powershell +Remove-AzCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name origin1 +``` + +Delete an AzureCDN origin group under the AzureCDN endpoint + +### Example 2: Delete an AzureCDN origin under the AzureCDN endpoint via identity +```powershell +Get-AzCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name origin1 | Remove-AzCdnOrigin +``` + +Delete an AzureCDN origin under the AzureCDN endpoint via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the origin which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: OriginName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzCdnOriginGroup.md b/azps-10.1.0/Az.Cdn/Remove-AzCdnOriginGroup.md new file mode 100644 index 0000000000..70f9276c79 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzCdnOriginGroup.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azcdnorigingroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzCdnOriginGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzCdnOriginGroup.md +--- + +# Remove-AzCdnOriginGroup + +## SYNOPSIS +Deletes an existing origin group within an endpoint. + +## SYNTAX + +### Delete1 (Default) +``` +Remove-AzCdnOriginGroup -EndpointName -Name -ProfileName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity1 +``` +Remove-AzCdnOriginGroup -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing origin group within an endpoint. + +## EXAMPLES + +### Example 1: Delete an AzureCDN origin group under the AzureCDN endpoint +```powershell +Remove-AzCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name org001 +``` + +Delete an AzureCDN origin group under the AzureCDN endpoint + +### Example 2: Delete an AzureCDN origin group under the AzureCDN endpoint via identity +```powershell +Get-AzCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name org001| Remove-AzCdnOriginGroup +``` + +Delete an AzureCDN origin group under the AzureCDN endpoint via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the origin group which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: OriginGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzCdnProfile.md b/azps-10.1.0/Az.Cdn/Remove-AzCdnProfile.md new file mode 100644 index 0000000000..fd54ed42db --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzCdnProfile.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azcdnprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzCdnProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzCdnProfile.md +--- + +# Remove-AzCdnProfile + +## SYNOPSIS +Deletes an existing CDN profile with the specified profile name under the specified subscription. +Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCdnProfile -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzCdnProfile -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing CDN profile with the specified profile name under the specified subscription. +Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains. + +## EXAMPLES + +### Example 1: Delete an AzureCDN profile under the resource group +```powershell +Remove-AzCdnProfile -ResourceGroupName testps-rg-da16jm -Name cdn-001 +``` + +Delete an AzureCDN profile under the resource group + +### Example 2: Delete an AzureCDN profile under the resource group via identity +```powershell +Get-AzCdnProfile -ResourceGroupName testps-rg-da16jm -Name fdp-cdn001 | Remove-AzCdnProfile +``` + +Delete an AzureCDN profile under the resource group + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnCustomDomain.md b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnCustomDomain.md new file mode 100644 index 0000000000..17134bbdc0 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnCustomDomain.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azfrontdoorcdncustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnCustomDomain.md +--- + +# Remove-AzFrontDoorCdnCustomDomain + +## SYNOPSIS +Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzFrontDoorCdnCustomDomain -CustomDomainName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzFrontDoorCdnCustomDomain -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile. + +## EXAMPLES + +### Example 1: Delete an AzureFrontDoor customdomain under the profile +```powershell +Remove-AzFrontDoorCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -CustomDomainName domain001 +``` + +Delete an AzureFrontDoor customdomain under the profile + +### Example 2: Delete an AzureFrontDoor customdomain under the profile via identity +```powershell +Get-AzFrontDoorCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -CustomDomainName domain001 | Remove-AzFrontDoorCdnCustomDomain +``` + +Delete an AzureFrontDoor customdomain under the profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDomainName +Name of the domain under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnEndpoint.md b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnEndpoint.md new file mode 100644 index 0000000000..6b90ee12d7 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnEndpoint.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azfrontdoorcdnendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnEndpoint.md +--- + +# Remove-AzFrontDoorCdnEndpoint + +## SYNOPSIS +Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzFrontDoorCdnEndpoint -EndpointName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzFrontDoorCdnEndpoint -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. + +## EXAMPLES + +### Example 1: Delete an AzureFrontDoor endpoint under the profile +```powershell +Remove-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 +``` + +Delete an AzureFrontDoor endpoint under the profile + +### Example 2: Delete an AzureFrontDoor endpoint under the profile via identity +```powershell +Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 | Remove-AzFrontDoorCdnEndpoint +``` + +Delete an AzureFrontDoor endpoint under the profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnOrigin.md b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnOrigin.md new file mode 100644 index 0000000000..2350e00a6d --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnOrigin.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azfrontdoorcdnorigin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnOrigin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnOrigin.md +--- + +# Remove-AzFrontDoorCdnOrigin + +## SYNOPSIS +Deletes an existing origin within an origin group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzFrontDoorCdnOrigin -OriginGroupName -OriginName -ProfileName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzFrontDoorCdnOrigin -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing origin within an origin group. + +## EXAMPLES + +### Example 1: Delete an AzureFrontDoor origin under the origin group +```powershell +Remove-AzFrontDoorCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -OriginName ori001 +``` + +Delete an AzureFrontDoor origin under the origin group + +### Example 2: Delete an AzureFrontDoor origin under the origin group via identity +```powershell +Get-AzFrontDoorCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -OriginName ori001 | Remove-AzFrontDoorCdnOrigin +``` + +Delete an AzureFrontDoor origin under the origin group via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginGroupName +Name of the origin group which is unique within the profile. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginName +Name of the origin which is unique within the profile. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnOriginGroup.md b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnOriginGroup.md new file mode 100644 index 0000000000..94b696b60b --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnOriginGroup.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azfrontdoorcdnorigingroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnOriginGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnOriginGroup.md +--- + +# Remove-AzFrontDoorCdnOriginGroup + +## SYNOPSIS +Deletes an existing origin group within a profile. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzFrontDoorCdnOriginGroup -OriginGroupName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzFrontDoorCdnOriginGroup -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing origin group within a profile. + +## EXAMPLES + +### Example 1: Delete an AzureFrontDoor origin group under the profile +```powershell +Remove-AzFrontDoorCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 +``` + +Delete an AzureFrontDoor origin group under the profile + +### Example 2: Delete an AzureFrontDoor origin group under the profile via identity +```powershell +Get-AzFrontDoorCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 | Remove-AzFrontDoorCdnOriginGroup +``` + +Delete an AzureFrontDoor origin group under the profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginGroupName +Name of the origin group which is unique within the profile. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnProfile.md b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnProfile.md new file mode 100644 index 0000000000..41ef144f6f --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnProfile.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azfrontdoorcdnprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnProfile.md +--- + +# Remove-AzFrontDoorCdnProfile + +## SYNOPSIS +Deletes an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified parameters. +Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzFrontDoorCdnProfile -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzFrontDoorCdnProfile -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified parameters. +Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains. + +## EXAMPLES + +### Example 1: Delete an AzureFrontDoor profile under the resource group +```powershell +Remove-AzFrontDoorCdnProfile -ResourceGroupName testps-rg-da16jm -Name fdp-v542q6 +``` + +Delete an AzureFrontDoor profile under the resource group + +### Example 2: Delete an AzureFrontDoor profile under the resource group via identity +```powershell +Get-AzFrontDoorCdnProfile -ResourceGroupName testps-rg-da16jm -Name fdp-v542q6 | Remove-AzFrontDoorCdnProfile +``` + +Delete an AzureFrontDoor profile under the resource group via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnRoute.md b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnRoute.md new file mode 100644 index 0000000000..34d47ab28a --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnRoute.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azfrontdoorcdnroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnRoute.md +--- + +# Remove-AzFrontDoorCdnRoute + +## SYNOPSIS +Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzFrontDoorCdnRoute -EndpointName -Name -ProfileName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzFrontDoorCdnRoute -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint. + +## EXAMPLES + +### Example 1: Delete an AzureFrontDoor route under the AzureFrontDoor profile +```powershell +Remove-AzFrontDoorCdnRoute -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 -Name route001 +``` + +Delete an AzureFrontDoor route under the AzureFrontDoor profile + +### Example 2: Delete an AzureFrontDoor route under the AzureFrontDoor profile via identity +```powershell +Get-AzFrontDoorCdnRoute -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 -Name route001 | Remove-AzFrontDoorCdnRoute +``` + +Delete an AzureFrontDoor route under the AzureFrontDoor profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the routing rule. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: RouteName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnRule.md b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnRule.md new file mode 100644 index 0000000000..981e82fff5 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnRule.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azfrontdoorcdnrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnRule.md +--- + +# Remove-AzFrontDoorCdnRule + +## SYNOPSIS +Deletes an existing delivery rule within a rule set. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzFrontDoorCdnRule -Name -ProfileName -ResourceGroupName -SetName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzFrontDoorCdnRule -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing delivery rule within a rule set. + +## EXAMPLES + +### Example 1: Delete an AzureFrontDoor delivery rule within the specified rule set +```powershell +Remove-AzFrontDoorCdnRule -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 -Name rule1 +``` + +Delete an AzureFrontDoor delivery rule within the specified rule set + +### Example 2: Delete an AzureFrontDoor delivery rule within the specified rule set via identity +```powershell +Get-AzFrontDoorCdnRule -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 -Name rule1 | Remove-AzFrontDoorCdnRule +``` + +Delete an AzureFrontDoor delivery rule within the specified rule set via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the delivery rule which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: RuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetName +Name of the rule set under the profile. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: RuleSetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnRuleSet.md b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnRuleSet.md new file mode 100644 index 0000000000..37457d89fc --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnRuleSet.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azfrontdoorcdnruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnRuleSet.md +--- + +# Remove-AzFrontDoorCdnRuleSet + +## SYNOPSIS +Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzFrontDoorCdnRuleSet -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzFrontDoorCdnRuleSet -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile. + +## EXAMPLES + +### Example 1: Delete an AzureFrontDoor rule set under the profile +```powershell +Remove-AzFrontDoorCdnRuleSet -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 +``` + +Delete an AzureFrontDoor rule set under the profile + +### Example 2: Delete an AzureFrontDoor rule set under the profile via identity +```powershell +Get-AzFrontDoorCdnRuleSet -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 | Remove-AzFrontDoorCdnRuleSet +``` + +Delete an AzureFrontDoor rule set under the profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the rule set under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: RuleSetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnSecret.md b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnSecret.md new file mode 100644 index 0000000000..b0c8b7eb81 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnSecret.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azfrontdoorcdnsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnSecret.md +--- + +# Remove-AzFrontDoorCdnSecret + +## SYNOPSIS +Deletes an existing Secret within profile. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzFrontDoorCdnSecret -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzFrontDoorCdnSecret -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing Secret within profile. + +## EXAMPLES + +### Example 1: Delete an AzureFrontDoor secret under the profile +```powershell +Remove-AzFrontDoorCdnSecret -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name secret001 +``` + +Delete an AzureFrontDoor secret under the profile + +### Example 2: Delete an AzureFrontDoor secret under the profile via identity +```powershell +Get-AzFrontDoorCdnSecret -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name secret001 | Remove-AzFrontDoorCdnSecret +``` + +Delete an AzureFrontDoor secret under the profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Secret under the profile. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SecretName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnSecurityPolicy.md b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnSecurityPolicy.md new file mode 100644 index 0000000000..932e113c4c --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Remove-AzFrontDoorCdnSecurityPolicy.md @@ -0,0 +1,256 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/remove-azfrontdoorcdnsecuritypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnSecurityPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Remove-AzFrontDoorCdnSecurityPolicy.md +--- + +# Remove-AzFrontDoorCdnSecurityPolicy + +## SYNOPSIS +Deletes an existing security policy within profile. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzFrontDoorCdnSecurityPolicy -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzFrontDoorCdnSecurityPolicy -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing security policy within profile. + +## EXAMPLES + +### Example 1: Delete an AzureFrontDoor security policy within the specified AzureFrontDoor profile +```powershell +Remove-AzFrontDoorCdnSecurityPolicy -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name policy001 +``` + +Delete an AzureFrontDoor security policy within the specified AzureFrontDoor profile + +### Example 2: Delete an AzureFrontDoor security policy within the specified AzureFrontDoor profile via identity +```powershell + +Get-AzFrontDoorCdnSecurityPolicy -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name policy001 | Remove-AzFrontDoorCdnSecurityPolicy +``` + +Delete an AzureFrontDoor security policy within the specified AzureFrontDoor profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the security policy under the profile. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SecurityPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Start-AzCdnEndpoint.md b/azps-10.1.0/Az.Cdn/Start-AzCdnEndpoint.md new file mode 100644 index 0000000000..47b0236e1d --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Start-AzCdnEndpoint.md @@ -0,0 +1,252 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/start-azcdnendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Start-AzCdnEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Start-AzCdnEndpoint.md +--- + +# Start-AzCdnEndpoint + +## SYNOPSIS +Starts an existing CDN endpoint that is on a stopped state. + +## SYNTAX + +### Start (Default) +``` +Start-AzCdnEndpoint -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### StartViaIdentity +``` +Start-AzCdnEndpoint -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Starts an existing CDN endpoint that is on a stopped state. + +## EXAMPLES + +### Example 1: Start an AzureCDN Endpoint under the AzureCDN profile +```powershell +Start-AzCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -Name endptest001 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +WestUs endptest001 testps-rg-da16jm +``` + +Start an AzureCDN Endpoint under the AzureCDN profile + +### Example 2: Start an AzureCDN Endpoint under the AzureCDN profile via identity +```powershell +Get-AzCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -Name endptest001 | Start-AzCdnEndpoint +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +WestUs endptest001 testps-rg-da16jm +``` + +Start an AzureCDN Endpoint under the AzureCDN profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IEndpoint + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Start-AzFrontDoorCdnProfilePrepareMigration.md b/azps-10.1.0/Az.Cdn/Start-AzFrontDoorCdnProfilePrepareMigration.md new file mode 100644 index 0000000000..d825c61778 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Start-AzFrontDoorCdnProfilePrepareMigration.md @@ -0,0 +1,350 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/start-azfrontdoorcdnprofilepreparemigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Start-AzFrontDoorCdnProfilePrepareMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Start-AzFrontDoorCdnProfilePrepareMigration.md +--- + +# Start-AzFrontDoorCdnProfilePrepareMigration + +## SYNOPSIS +Migrate the classic AFD instance to Azure Front Door(Standard/Premium) profile. +MigrationWebApplicationFirewallMapping should be associated if the front door has WAF policy. +Managed Identity should be associated if the frontdoor has Customer Certificates. +The change need to be committed after this. + +## SYNTAX + +``` +Start-AzFrontDoorCdnProfilePrepareMigration -ResourceGroupName -ClassicResourceReferenceId + -ProfileName -SkuName [-SubscriptionId ] + [-IdentityType ] [-IdentityUserAssignedIdentity ] + [-MigrationWebApplicationFirewallMapping ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Migrate the classic AFD instance to Azure Front Door(Standard/Premium) profile. +The change need to be committed after this. + +## EXAMPLES + +### Example 1: When a classic AFD instance associated without WAF policy and has no customer certificates. +```powershell +Start-AzFrontDoorCdnProfilePrepareMigration -ResourceGroupName rgName -ClassicResourceReferenceId /subscriptions/testSubId/resourcegroups/rgName/providers/Microsoft.Network/Frontdoors/name -ProfileName name-migrated -SkuName Standard_AzureFrontDoor +``` + +```output +MigratedProfileResourceId +------------------------- +/subscriptions/testSubId/resourceGroups/rgName/providers/Microsoft.Cdn/profiles/name-migrated +``` + +When a classic AFD instance associated without WAF policy and has no customer certificates. +Migrate the classic AFD to Azure Front Door(Standard/Premium) profile.. +The change need to be committed after this. + +### Example 2: When a classic AFD instance associated with WAF and copy to a new WAF policy. +```powershell +$wafMapping = New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject -MigratedFromId /subscriptions/testSubId/resourcegroups/rgName01/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf01 -MigratedToId /subscriptions/testSubId/resourcegroups/rgName/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/newWAFName +Start-AzFrontDoorCdnProfilePrepareMigration -ResourceGroupName rgName -ClassicResourceReferenceId /subscriptions/testSubId/resourcegroups/rgName/providers/Microsoft.Network/Frontdoors/name -ProfileName name-migrated -SkuName Standard_AzureFrontDoor -MigrationWebApplicationFirewallMapping $wafMapping +``` + +```output +MigratedProfileResourceId +------------------------- +/subscriptions/testSubId/resourceGroups/rgName/providers/Microsoft.Cdn/profiles/name-migrated +``` + +When a classic AFD instance associated with WAF and copy to a new WAF policy. +The new WAF policy should be created in the same subscription and resource group with the classic AFD instance's. +Migrate classic AFD to Azure Front Door(Standard/Premium) profile.. +The change need to be committed after this. + +### Example 3: When a classic AFD instance associated with WAF and select an existing WAF policy. +```powershell +$wafMapping = New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject -MigratedFromId /subscriptions/testSubId/resourcegroups/rgName01/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf01 -MigratedToId /subscriptions/testSubId/resourcegroups/rgName02/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/existingWAFName +Start-AzFrontDoorCdnProfilePrepareMigration -ResourceGroupName rgName -ClassicResourceReferenceId /subscriptions/testSubId/resourcegroups/rgName/providers/Microsoft.Network/Frontdoors/name -ProfileName name-migrated -SkuName Standard_AzureFrontDoor -MigrationWebApplicationFirewallMapping $wafMapping +``` + +```output +MigratedProfileResourceId +------------------------- +/subscriptions/testSubId/resourceGroups/rgName/providers/Microsoft.Cdn/profiles/name-migrated +``` + +When a classic AFD instance associated with WAF and select an existing WAF policy. +You could only select the WAF policy located in the same subscription with the classic AFD instance's. +Migrate the classic AFD to Azure Front Door(Standard/Premium) profile.. +The change need to be committed after this. + +### Example 4: When a classic AFD instance associated with more than one WAF policy and has no customer certificates. +```powershell +$wafMapping1 = New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject -MigratedFromId /subscriptions/testSubId/resourcegroups/rgName01/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf01 -MigratedToId /subscriptions/testSubId/resourcegroups/rgName01/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf01test + +$wafMapping2 = New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject -MigratedFromId /subscriptions/testSubId/resourcegroups/rgName02/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf02 -MigratedToId /subscriptions/testSubId/resourcegroups/rgName02/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf02test + +# enable Managed Identity via SystemAssigned and UserAssigned +$identityType = "SystemAssigned, UserAssigned" + +# UserIdentity information +$userInfo = @{ + "/subscriptions/testSubId/resourceGroups/rgName01/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity01" = @{} + "/subscriptions/testSubId/resourceGroups/rgName02/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity02" = @{} +} + +Start-AzFrontDoorCdnProfilePrepareMigration -ResourceGroupName rgName -ClassicResourceReferenceId /subscriptions/testSubId/resourcegroups/rgName/providers/Microsoft.Network/Frontdoors/name -ProfileName name-migrated -SkuName Premium_AzureFrontDoor -MigrationWebApplicationFirewallMapping @($wafMapping1, $wafMapping2) -IdentityType $identityType -IdentityUserAssignedIdentity $userInfo +``` + +```output +MigratedProfileResourceId +------------------------- +/subscriptions/testSubId/resourceGroups/rgName/providers/Microsoft.Cdn/profiles/name-migrated +``` + +When a classic AFD instance associated with more than one WAF policy and has no customer certificates. +Migrate the classic AFD to Azure Front Door(Standard/Premium) profile.. +The change need to be committed after this. + +### Example 5: When a classic AFD instance not associated with WAF and has no customer certificate, and the subscription of the classic AFD instance is different from the local subscrition. +```powershell +Start-AzFrontDoorCdnProfilePrepareMigration -ResourceGroupName rgName -ClassicResourceReferenceId /subscriptions/testSubId01/resourcegroups/rgName/providers/Microsoft.Network/Frontdoors/name -ProfileName name-migrated -SkuName Standard_AzureFrontDoor -SubscriptionId testSubId01 +``` + +```output +MigratedProfileResourceId +------------------------- +/subscriptions/testSubId/resourceGroups/rgName/providers/Microsoft.Cdn/profiles/name-migrated +``` + +When a classic AFD instance not associated with WAF and has no customer certificate, and the subscription of the classic AFD instance is different from the local subscrition. +Migrate the classic AFD to Azure Front Door(Standard/Premium) profile.. +The change need to be committed after this. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassicResourceReferenceId +Resource ID of the classic front door instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationWebApplicationFirewallMapping +Waf mapping for the migrated profile +To construct, see NOTES section for MIGRATIONWEBAPPLICATIONFIREWALLMAPPING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IMigrationWebApplicationFirewallMapping[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the new AFD Standard/Premium profile that need to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name of the pricing tier. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IMigrateResult + +## 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. + + +`MIGRATIONWEBAPPLICATIONFIREWALLMAPPING `: Waf mapping for the migrated profile + - `[MigratedFromId ]`: Resource ID. + - `[MigratedToId ]`: Resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Stop-AzCdnEndpoint.md b/azps-10.1.0/Az.Cdn/Stop-AzCdnEndpoint.md new file mode 100644 index 0000000000..c3287e1d4c --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Stop-AzCdnEndpoint.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/stop-azcdnendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Stop-AzCdnEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Stop-AzCdnEndpoint.md +--- + +# Stop-AzCdnEndpoint + +## SYNOPSIS +Stops an existing running CDN endpoint. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzCdnEndpoint -Name -ProfileName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### StopViaIdentity +``` +Stop-AzCdnEndpoint -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Stops an existing running CDN endpoint. + +## EXAMPLES + +### Example 1: Stop an AzureCDN Endpoint under the AzureCDN profile +```powershell +Stop-AzCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -Name endptest001 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +WestUs endptest001 testps-rg-da16jm +``` + +Stop an AzureCDN Endpoint under the AzureCDN profile + +### Example 2: Stop an AzureCDN Endpoint under the AzureCDN profile via identity +```powershell +Get-AzCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -Name endptest001 | Stop-AzCdnEndpoint +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +WestUs endptest001 testps-rg-da16jm +``` + +Stop an AzureCDN Endpoint under the AzureCDN profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IEndpoint + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Stop-AzFrontDoorCdnProfileMigration.md b/azps-10.1.0/Az.Cdn/Stop-AzFrontDoorCdnProfileMigration.md new file mode 100644 index 0000000000..86f60ea51f --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Stop-AzFrontDoorCdnProfileMigration.md @@ -0,0 +1,186 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/stop-azfrontdoorcdnprofilemigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Stop-AzFrontDoorCdnProfileMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Stop-AzFrontDoorCdnProfileMigration.md +--- + +# Stop-AzFrontDoorCdnProfileMigration + +## SYNOPSIS +Abort classic cdn migrate to AFDx. +Your new Front Door Profile will be deleted and your existing profile will remain active. +WAF policies will not be deleted. + +## SYNTAX + +``` +Stop-AzFrontDoorCdnProfileMigration -ProfileName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Abort classic cdn migrate to AFDx. +Your new Front Door Profile will be deleted and your existing profile will remain active. +WAF policies will not be deleted. + +## EXAMPLES + +### Example 1: Abort classic CDN migrate to AFDx +```powershell +Stop-AzFrontDoorCdnProfileMigration -ProfileName name-migrated -ResourceGroupName rgName +``` + +Abort classic CDN migrate to AFDx. +This will delete all the AFD Standard or Premium configurations + +### Example 2: Abort classic CDN migrate to AFDx, when the subscription of the classic CDN is different from the local subscrition +```powershell +Stop-AzFrontDoorCdnProfileMigration -ProfileName name-migrated -ResourceGroupName rgName -SubscriptionId testSubId01 +``` + +Abort classic CDN migrate to AFDx. +When the subscription of the classic CDN is different from the local subscrition, You need to set the value of the subscription parameter. +This will delete all the AFD Standard or Premium configurations. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the new AFD Standard/Premium profile that created in AFDx. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Test-AzCdnEndpointCustomDomain.md b/azps-10.1.0/Az.Cdn/Test-AzCdnEndpointCustomDomain.md new file mode 100644 index 0000000000..1579d2fcd6 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Test-AzCdnEndpointCustomDomain.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/test-azcdnendpointcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzCdnEndpointCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzCdnEndpointCustomDomain.md +--- + +# Test-AzCdnEndpointCustomDomain + +## SYNOPSIS +Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS. + +## SYNTAX + +### ValidateExpanded1 (Default) +``` +Test-AzCdnEndpointCustomDomain -EndpointName -ProfileName -ResourceGroupName + -HostName [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### ValidateViaIdentityExpanded1 +``` +Test-AzCdnEndpointCustomDomain -InputObject -HostName [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS. + +## EXAMPLES + +### Example 1: Test an AzureCDN custom domain under the AzureCDN endpoint +```powershell +Test-AzCdnEndpointCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -HostName 'testcm.dev.cdn.azure.cn' +``` + +```output +CustomDomainValidated Message Reason +--------------------- ------- ------ +True +``` + +Test an AzureCDN custom domain under the AzureCDN endpoint + +### Example 2: Test an AzureCDN custom domain under the AzureCDN endpoint via identity +```powershell +Get-AzCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -Name endptest001 | Test-AzCdnEndpointCustomDomain -HostName 'testcm.dev.cdn.azure.cn' +``` + +Test an AzureCDN custom domain under the AzureCDN endpoint via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +The host name of the custom domain. +Must be a domain name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: ValidateViaIdentityExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IValidateCustomDomainOutput + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Test-AzCdnNameAvailability.md b/azps-10.1.0/Az.Cdn/Test-AzCdnNameAvailability.md new file mode 100644 index 0000000000..08a8c2c289 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Test-AzCdnNameAvailability.md @@ -0,0 +1,157 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/test-azcdnnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzCdnNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzCdnNameAvailability.md +--- + +# Test-AzCdnNameAvailability + +## SYNOPSIS +Check the availability of a resource name. +This is needed for resources where name is globally unique, such as a CDN endpoint. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzCdnNameAvailability -Name -Type [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### CheckExpanded1 +``` +Test-AzCdnNameAvailability -Name -Type [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Check the availability of a resource name. +This is needed for resources where name is globally unique, such as a CDN endpoint. + +## EXAMPLES + +### Example 1: Check AzureCDN endpint name availability +```powershell +Test-AzCdnNameAvailability -Name endptest001 -Type Microsoft.Cdn/Profiles/Endpoints +``` + +```output +Message NameAvailable Reason +------- ------------- ------ +Name not available False Name is already in use +``` + +Check AzureCDN endpint name availability + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name to validate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The type of the resource whose name is to be validated. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ResourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ICheckNameAvailabilityOutput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Test-AzCdnProbe.md b/azps-10.1.0/Az.Cdn/Test-AzCdnProbe.md new file mode 100644 index 0000000000..2365f409c3 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Test-AzCdnProbe.md @@ -0,0 +1,137 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/test-azcdnprobe +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzCdnProbe.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzCdnProbe.md +--- + +# Test-AzCdnProbe + +## SYNOPSIS +Check if the probe path is a valid path and the file can be accessed. +Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. +This path is relative to the origin path specified in the endpoint configuration. + +## SYNTAX + +``` +Test-AzCdnProbe -ProbeUrl [-SubscriptionId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Check if the probe path is a valid path and the file can be accessed. +Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. +This path is relative to the origin path specified in the endpoint configuration. + +## EXAMPLES + +### Example 1: Check if the probe path is a valid path and the file can be accessed +```powershell +Test-AzCdnProbe -ProbeUrl "https://azurecdn-files.azureedge.net/dsa-test/probe-v.txt" +``` + +```output +ErrorCode IsValid Message +--------- ------- ------- +None True +``` + +Check if the probe path is a valid path and the file can be accessed + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeUrl +The probe URL to validate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IValidateProbeOutput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Test-AzFrontDoorCdnEndpointCustomDomain.md b/azps-10.1.0/Az.Cdn/Test-AzFrontDoorCdnEndpointCustomDomain.md new file mode 100644 index 0000000000..e7f3734430 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Test-AzFrontDoorCdnEndpointCustomDomain.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/test-azfrontdoorcdnendpointcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzFrontDoorCdnEndpointCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzFrontDoorCdnEndpointCustomDomain.md +--- + +# Test-AzFrontDoorCdnEndpointCustomDomain + +## SYNOPSIS +Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS. + +## SYNTAX + +### ValidateExpanded (Default) +``` +Test-AzFrontDoorCdnEndpointCustomDomain -EndpointName -ProfileName + -ResourceGroupName -HostName [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### ValidateViaIdentityExpanded +``` +Test-AzFrontDoorCdnEndpointCustomDomain -InputObject -HostName + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS. + +## EXAMPLES + +### Example 1: Test an AzureFrontDoor domain within the specified AzureFrontDoor endpoint +```powershell +Test-AzFrontDoorCdnEndpointCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 -HostName "pstest001.dev.cdn.azure.cn" +``` + +```output +CustomDomainValidated Message Reason +--------------------- ------- ------ +True +``` + +Test an AzureFrontDoor domain within the specified AzureFrontDoor endpoint + +### Example 2: Test an AzureFrontDoor domain within the specified AzureFrontDoor endpoint via identity +```powershell +Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 | Test-AzFrontDoorCdnEndpointCustomDomain -HostName "pstest001.dev.cdn.azure.cn" +``` + +```output +CustomDomainValidated Message Reason +--------------------- ------- ------ +True +``` + +Test an AzureFrontDoor domain within the specified AzureFrontDoor endpoint via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +The host name of the custom domain. +Must be a domain name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: ValidateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IValidateCustomDomainOutput + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Test-AzFrontDoorCdnEndpointNameAvailability.md b/azps-10.1.0/Az.Cdn/Test-AzFrontDoorCdnEndpointNameAvailability.md new file mode 100644 index 0000000000..57762a1bc6 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Test-AzFrontDoorCdnEndpointNameAvailability.md @@ -0,0 +1,182 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/test-azfrontdoorcdnendpointnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzFrontDoorCdnEndpointNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzFrontDoorCdnEndpointNameAvailability.md +--- + +# Test-AzFrontDoorCdnEndpointNameAvailability + +## SYNOPSIS +Check the availability of a resource name. +This is needed for resources where name is globally unique, such as a afdx endpoint. + +## SYNTAX + +``` +Test-AzFrontDoorCdnEndpointNameAvailability -ResourceGroupName -Name -Type + [-SubscriptionId ] [-AutoGeneratedDomainNameLabelScope ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Check the availability of a resource name. +This is needed for resources where name is globally unique, such as a afdx endpoint. + +## EXAMPLES + +### Example 1: Test the availability of a endpoint name under the AzureFrontDoor profile +```powershell +Test-AzFrontDoorCdnEndpointNameAvailability -ResourceGroupName testps-rg-da16jm -Type "Microsoft.Cdn/Profiles/AfdEndpoints" -Name end001 +``` + +```output +AvailableHostname Message NameAvailable Reason +----------------- ------- ------------- ------ + Name not available False Name is already in use +``` + +Test the availability of a endpoint name under the AzureFrontDoor profile + +## PARAMETERS + +### -AutoGeneratedDomainNameLabelScope +Indicates the endpoint name reuse scope. +The default value is TenantReuse. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.AutoGeneratedDomainNameLabelScope +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name to validate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The type of the resource whose name is to be validated. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ResourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ICheckEndpointNameAvailabilityOutput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Test-AzFrontDoorCdnProfileHostNameAvailability.md b/azps-10.1.0/Az.Cdn/Test-AzFrontDoorCdnProfileHostNameAvailability.md new file mode 100644 index 0000000000..f5d2dea2f6 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Test-AzFrontDoorCdnProfileHostNameAvailability.md @@ -0,0 +1,222 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/test-azfrontdoorcdnprofilehostnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzFrontDoorCdnProfileHostNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzFrontDoorCdnProfileHostNameAvailability.md +--- + +# Test-AzFrontDoorCdnProfileHostNameAvailability + +## SYNOPSIS +Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzFrontDoorCdnProfileHostNameAvailability -ProfileName -ResourceGroupName + -HostName [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CheckViaIdentityExpanded +``` +Test-AzFrontDoorCdnProfileHostNameAvailability -InputObject -HostName + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS. + +## EXAMPLES + +### Example 1: Test the availability of a host name under the AzureFrontDoor profile +```powershell +Test-AzFrontDoorCdnProfileHostNameAvailability -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -HostName hello1.dev.cdn.azure.cn +``` + +```output +Message NameAvailable Reason +------- ------------- ------ + True +``` + +Test the availability of a host name under the AzureFrontDoor profile + +### Example 2: Test the availability of a host name under the AzureFrontDoor profile via identity +```powershell +Get-AzFrontDoorCdnProfile -ResourceGroupName testps-rg-da16jm -Name fdp-v542q6 | Test-AzFrontDoorCdnProfileHostNameAvailability -HostName hello1.dev.cdn.azure.cn +``` + +```output +Message NameAvailable Reason +------- ------------- ------ + True +``` + +Test the availability of a host name under the AzureFrontDoor profile via identity + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +The host name to validate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ICheckNameAvailabilityOutput + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Test-AzFrontDoorCdnProfileMigration.md b/azps-10.1.0/Az.Cdn/Test-AzFrontDoorCdnProfileMigration.md new file mode 100644 index 0000000000..643add3439 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Test-AzFrontDoorCdnProfileMigration.md @@ -0,0 +1,193 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/test-azfrontdoorcdnprofilemigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzFrontDoorCdnProfileMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Test-AzFrontDoorCdnProfileMigration.md +--- + +# Test-AzFrontDoorCdnProfileMigration + +## SYNOPSIS +Check if a classic AFD instance can be migrated to Azure Front Door(Standard/Premium) profile. + +## SYNTAX + +``` +Test-AzFrontDoorCdnProfileMigration -ResourceGroupName -ClassicResourceReferenceId + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Check if a classic AFD instance can be migrated to Azure Front Door(Standard/Premium) profile. + +## EXAMPLES + +### Example 1: Checks if a classic AFD instance can be migrated to Azure Front Door(Standard/Premium) profile. +```powershell +Test-AzFrontDoorCdnProfileMigration -ResourceGroupName testrg -ClassicResourceReferenceId /subscriptions/testSubId/resourcegroups/testrg/providers/Microsoft.Network/Frontdoors/frontdoorName +``` + +```output +CanMigrate DefaultSku Error +---------- ---------- ----- +True Standard_AzureFrontDoor {} +``` + +Checks if a classic AFD instance can be migrated to Azure Front Door(Standard/Premium) profile. + +### Example 2: Checks if a classic AFD instance can be migrated to Azure Front Door(Standard/Premium) profile, when the subscription of the CDN profile is different from the local subscrition. +```powershell +Test-AzFrontDoorCdnProfileMigration -ResourceGroupName testrg -ClassicResourceReferenceId /subscriptions/testSubId01/resourcegroups/testrg/providers/Microsoft.Network/Frontdoors/frontdoorName -SubscriptionId testSubId01 +``` + +```output +CanMigrate DefaultSku Error +---------- ---------- ----- +True Standard_AzureFrontDoor {} +``` + +Checks if a classic AFD instance can be migrated to Azure Front Door(Standard/Premium) profile, when the subscription of the CDN profile is different from the local subscrition. + +You need to set the value of the subscription parameter. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassicResourceReferenceId +Resource ID of the classic front door instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ICanMigrateResult + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzCdnEndpoint.md b/azps-10.1.0/Az.Cdn/Update-AzCdnEndpoint.md new file mode 100644 index 0000000000..b9d19e9d59 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzCdnEndpoint.md @@ -0,0 +1,560 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azcdnendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzCdnEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzCdnEndpoint.md +--- + +# Update-AzCdnEndpoint + +## SYNOPSIS +Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. +Only tags can be updated after creating an endpoint. +To update origins, use the Update Origin operation. +To update origin groups, use the Update Origin group operation. +To update custom domains, use the Update Custom Domain operation. + +## SYNTAX + +### UpdateExpanded1 (Default) +``` +Update-AzCdnEndpoint -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-ContentTypesToCompress ] [-DefaultOriginGroupId ] + [-DeliveryPolicyDescription ] [-DeliveryPolicyRule ] [-GeoFilter ] + [-IsCompressionEnabled] [-IsHttpAllowed] [-IsHttpsAllowed] [-OptimizationType ] + [-OriginHostHeader ] [-OriginPath ] [-ProbePath ] + [-QueryStringCachingBehavior ] [-Tag ] + [-UrlSigningKey ] [-WebApplicationFirewallPolicyLinkId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded1 +``` +Update-AzCdnEndpoint -InputObject [-ContentTypesToCompress ] + [-DefaultOriginGroupId ] [-DeliveryPolicyDescription ] + [-DeliveryPolicyRule ] [-GeoFilter ] [-IsCompressionEnabled] [-IsHttpAllowed] + [-IsHttpsAllowed] [-OptimizationType ] [-OriginHostHeader ] [-OriginPath ] + [-ProbePath ] [-QueryStringCachingBehavior ] [-Tag ] + [-UrlSigningKey ] [-WebApplicationFirewallPolicyLinkId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. +Only tags can be updated after creating an endpoint. +To update origins, use the Update Origin operation. +To update origin groups, use the Update Origin group operation. +To update custom domains, use the Update Custom Domain operation. + +## EXAMPLES + +### Example 1: Update an AzureCDN Endpoint under the AzureCDN profile +```powershell +$tags = @{ + Tag1 = 11 + Tag2 = 22 +} +Update-AzCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -Name endptest001 -Tag $tags -DefaultOriginGroupId $originGroup.Id +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +WestUs endptest001 testps-rg-da16jm +``` + +Update an AzureCDN Endpoint under the AzureCDN profile + +### Example 2: Update an AzureCDN Endpoint under the AzureCDN profile via identity +```powershell +$tags = @{ + Tag1 = 11 + Tag2 = 22 +} +Get-AzCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -Name endptest001 | Update-AzCdnEndpoint -Tag $tags -DefaultOriginGroupId $originGroup.Id +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +WestUs endptest001 testps-rg-da16jm +``` + +Update an AzureCDN Endpoint under the AzureCDN profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentTypesToCompress +List of content types on which compression applies. +The value should be a valid MIME type. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultOriginGroupId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryPolicyDescription +User-friendly description of the policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryPolicyRule +A list of the delivery rules. +To construct, see NOTES section for DELIVERYPOLICYRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IDeliveryRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeoFilter +List of rules defining the user's geo access within a CDN endpoint. +Each geo filter defines an access rule to a specified path or content, e.g. +block APAC for path /pictures/ +To construct, see NOTES section for GEOFILTER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IGeoFilter[] +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.Cdn.Models.ICdnIdentity +Parameter Sets: UpdateViaIdentityExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsCompressionEnabled +Indicates whether content compression is enabled on CDN. +Default value is false. +If compression is enabled, content will be served as compressed if user requests for a compressed version. +Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsHttpAllowed +Indicates whether HTTP traffic is allowed on the endpoint. +Default value is true. +At least one protocol (HTTP or HTTPS) must be allowed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsHttpsAllowed +Indicates whether HTTPS traffic is allowed on the endpoint. +Default value is true. +At least one protocol (HTTP or HTTPS) must be allowed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizationType +Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. +Download, Media services. +With this information, CDN can apply scenario driven optimization. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.OptimizationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginHostHeader +The host header value sent to the origin with each request. +This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. +Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginPath +A directory path on the origin that CDN can use to retrieve content from, e.g. +contoso.cloudapp.net/originpath. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbePath +Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. +This is relative to the origin path. +This property is only relevant when using a single origin. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryStringCachingBehavior +Defines how CDN caches requests that include query strings. +You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.QueryStringCachingBehavior +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Endpoint tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlSigningKey +List of keys used to validate the signed URL hashes. +To construct, see NOTES section for URLSIGNINGKEY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IUrlSigningKey[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApplicationFirewallPolicyLinkId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IEndpoint + +## 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. + + +`DELIVERYPOLICYRULE `: A list of the delivery rules. + - `Action `: A list of actions that are executed when all the conditions of a rule are satisfied. + - `Name `: The name of the action for the delivery rule. + - `Order `: The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied. + - `[Condition ]`: A list of conditions that must be matched for the actions to be executed + - `Name `: The name of the condition for the delivery rule. + - `[Name ]`: Name of the rule + +`GEOFILTER `: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ + - `Action `: Action of the geo filter, i.e. allow or block access. + - `CountryCode `: Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US. + - `RelativePath `: Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +`URLSIGNINGKEY `: List of keys used to validate the signed URL hashes. + - `KeyId `: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. + - `KeySourceParameterResourceGroupName `: Resource group of the user's Key Vault containing the secret + - `KeySourceParameterSecretName `: The name of secret in Key Vault. + - `KeySourceParameterSecretVersion `: The version(GUID) of secret in Key Vault. + - `KeySourceParameterSubscriptionId `: Subscription Id of the user's Key Vault containing the secret + - `KeySourceParameterVaultName `: The name of the user's Key Vault containing the secret + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzCdnOrigin.md b/azps-10.1.0/Az.Cdn/Update-AzCdnOrigin.md new file mode 100644 index 0000000000..7c37d189f7 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzCdnOrigin.md @@ -0,0 +1,447 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azcdnorigin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzCdnOrigin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzCdnOrigin.md +--- + +# Update-AzCdnOrigin + +## SYNOPSIS +Updates an existing origin within an endpoint. + +## SYNTAX + +### UpdateExpanded1 (Default) +``` +Update-AzCdnOrigin -EndpointName -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-Enabled] [-HostName ] [-HttpPort ] [-HttpsPort ] + [-OriginHostHeader ] [-Priority ] [-PrivateLinkAlias ] + [-PrivateLinkApprovalMessage ] [-PrivateLinkLocation ] [-PrivateLinkResourceId ] + [-Weight ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded1 +``` +Update-AzCdnOrigin -InputObject [-Enabled] [-HostName ] [-HttpPort ] + [-HttpsPort ] [-OriginHostHeader ] [-Priority ] [-PrivateLinkAlias ] + [-PrivateLinkApprovalMessage ] [-PrivateLinkLocation ] [-PrivateLinkResourceId ] + [-Weight ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates an existing origin within an endpoint. + +## EXAMPLES + +### Example 1: Update an AzureCDN origin under the AzureCDN endpoint +```powershell +Update-AzCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name origin1 -HttpPort 456 -HttpsPort 789 +``` + +```output +Name ResourceGroupName +---- ----------------- +origin1 testps-rg-da16jm +``` + +Update an AzureCDN origin under the AzureCDN endpoint + +### Example 2: Update an AzureCDN origin under the AzureCDN endpoint via identity +```powershell +Get-AzCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name origin1 | Update-AzCdnOrigin -HttpPort 456 -HttpsPort 789 +``` + +```output +Name ResourceGroupName +---- ----------------- +origin1 testps-rg-da16jm +``` + +Update an AzureCDN origin under the AzureCDN endpoint via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Origin is enabled for load balancing or not + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +The address of the origin. +Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPort +The value of the HTTP port. +Must be between 1 and 65535. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsPort +The value of the HTTPS port. +Must be between 1 and 65535. + +```yaml +Type: System.Int32 +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.Cdn.Models.ICdnIdentity +Parameter Sets: UpdateViaIdentityExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the origin which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: OriginName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginHostHeader +The host header value sent to the origin with each request. +If you leave this blank, the request hostname determines this value. +Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +This overrides the host header defined at Endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Priority of origin in given origin group for load balancing. +Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkAlias +The Alias of the Private Link resource. +Populating this optional field indicates that this origin is 'Private' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkApprovalMessage +A custom message to be included in the approval request to connect to the Private Link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkLocation +The location of the Private Link resource. +Required only if 'privateLinkResourceId' is populated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkResourceId +The Resource Id of the Private Link resource. +Populating this optional field indicates that this backend is 'Private' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Weight +Weight of the origin in given origin group for load balancing. +Must be between 1 and 1000 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IOrigin + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzCdnOriginGroup.md b/azps-10.1.0/Az.Cdn/Update-AzCdnOriginGroup.md new file mode 100644 index 0000000000..fa9423566c --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzCdnOriginGroup.md @@ -0,0 +1,357 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azcdnorigingroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzCdnOriginGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzCdnOriginGroup.md +--- + +# Update-AzCdnOriginGroup + +## SYNOPSIS +Updates an existing origin group within an endpoint. + +## SYNTAX + +### UpdateExpanded1 (Default) +``` +Update-AzCdnOriginGroup -EndpointName -Name -ProfileName + -ResourceGroupName [-SubscriptionId ] [-HealthProbeSetting ] + [-Origin ] + [-ResponseBasedOriginErrorDetectionSetting ] + [-TrafficRestorationTimeToHealedOrNewEndpointsInMinute ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded1 +``` +Update-AzCdnOriginGroup -InputObject [-HealthProbeSetting ] + [-Origin ] + [-ResponseBasedOriginErrorDetectionSetting ] + [-TrafficRestorationTimeToHealedOrNewEndpointsInMinute ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates an existing origin group within an endpoint. + +## EXAMPLES + +### Example 1: Update an AzureCDN origin group under the AzureCDN endpoint +```powershell +$updateHealthProbeParameters = New-AzCdnHealthProbeParametersObject -ProbeIntervalInSecond 60 -ProbePath "/new-check-health.aspx" -ProbeProtocol "Http" -ProbeRequestType "HEAD" +Update-AzCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name org001 -HealthProbeSetting $updateHealthProbeParameters +``` + +```output +Name ResourceGroupName +---- ----------------- +org001 testps-rg-da16jm +``` + +Update an AzureCDN origin group under the AzureCDN endpoint + +### Example 2: Update an AzureCDN origin group under the AzureCDN endpoint via identity +```powershell +$updateHealthProbeParameters = New-AzCdnHealthProbeParametersObject -ProbeIntervalInSecond 60 -ProbePath "/new-check-health.aspx" -ProbeProtocol "Http" -ProbeRequestType "HEAD" +Get-AzCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -Name org001 | Update-AzCdnOriginGroup -HealthProbeSetting $updateHealthProbeParameters +``` + +```output +Name ResourceGroupName +---- ----------------- +org001 testps-rg-da16jm +``` + +Update an AzureCDN origin group under the AzureCDN endpoint via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthProbeSetting +Health probe settings to the origin that is used to determine the health of the origin. +To construct, see NOTES section for HEALTHPROBESETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IHealthProbeParameters +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.Cdn.Models.ICdnIdentity +Parameter Sets: UpdateViaIdentityExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the origin group which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: OriginGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Origin +The source of the content being delivered via CDN within given origin group. +To construct, see NOTES section for ORIGIN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IResourceReference[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseBasedOriginErrorDetectionSetting +The JSON object that contains the properties to determine origin health using real requests/responses. +This property is currently not supported. +To construct, see NOTES section for RESPONSEBASEDORIGINERRORDETECTIONSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IResponseBasedOriginErrorDetectionParameters +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficRestorationTimeToHealedOrNewEndpointsInMinute +Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. +Default is 10 mins. +This property is currently not supported. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IOriginGroup + +## 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. + + +`HEALTHPROBESETTING `: Health probe settings to the origin that is used to determine the health of the origin. + - `[ProbeIntervalInSecond ]`: The number of seconds between health probes.Default is 240sec. + - `[ProbePath ]`: The path relative to the origin that is used to determine the health of the origin. + - `[ProbeProtocol ]`: Protocol to use for health probe. + - `[ProbeRequestType ]`: The type of health probe request that is made. + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +`ORIGIN `: The source of the content being delivered via CDN within given origin group. + - `[Id ]`: Resource ID. + +`RESPONSEBASEDORIGINERRORDETECTIONSETTING `: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. + - `[HttpErrorRange ]`: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. + - `[Begin ]`: The inclusive start of the http status code range. + - `[End ]`: The inclusive end of the http status code range. + - `[ResponseBasedDetectedErrorType ]`: Type of response errors for real user requests for which origin will be deemed unhealthy + - `[ResponseBasedFailoverThresholdPercentage ]`: The percentage of failed requests in the sample where failover should trigger. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzCdnProfile.md b/azps-10.1.0/Az.Cdn/Update-AzCdnProfile.md new file mode 100644 index 0000000000..f0b7eb2112 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzCdnProfile.md @@ -0,0 +1,275 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azcdnprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzCdnProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzCdnProfile.md +--- + +# Update-AzCdnProfile + +## SYNOPSIS +Updates an existing CDN profile with the specified profile name under the specified subscription and resource group. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCdnProfile -Name -ResourceGroupName [-SubscriptionId ] + [-OriginResponseTimeoutSecond ] [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCdnProfile -InputObject [-OriginResponseTimeoutSecond ] [-Tag ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates an existing CDN profile with the specified profile name under the specified subscription and resource group. + +## EXAMPLES + +### Example 1: Update an AzureCDN profile under the resource group +```powershell +$tags = @{ + Tag1 = 11 + Tag2 = 22 +} +Update-AzCdnProfile -ResourceGroupName testps-rg-da16jm -Name cdn001 -Tag $tags +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global cdn001 cdn testps-rg-da16jm +``` + +Update an AzureCDN profile under the resource group + +### Example 2: Update an AzureCDN profile under the resource group via identity +```powershell +$tags = @{ + Tag1 = 11 + Tag2 = 22 +} +Get-AzCdnProfile -ResourceGroupName testps-rg-da16jm -Name cdn001 | Update-AzCdnProfile -Tag $tags +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global cdn001 cdn testps-rg-da16jm +``` + +Update an AzureCDN profile under the resource group via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginResponseTimeoutSecond +Send and receive timeout on forwarding request to the origin. +When timeout is reached, the request fails and returns. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Profile tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IProfile + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnCustomDomain.md b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnCustomDomain.md new file mode 100644 index 0000000000..bbe94f5d88 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnCustomDomain.md @@ -0,0 +1,313 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azfrontdoorcdncustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnCustomDomain.md +--- + +# Update-AzFrontDoorCdnCustomDomain + +## SYNOPSIS +Updates an existing domain within a profile. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzFrontDoorCdnCustomDomain -CustomDomainName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-AzureDnsZoneId ] + [-PropertiesPreValidatedCustomDomainResourceId ] [-TlsSetting ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzFrontDoorCdnCustomDomain -InputObject [-AzureDnsZoneId ] + [-PropertiesPreValidatedCustomDomainResourceId ] [-TlsSetting ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates an existing domain within a profile. + +## EXAMPLES + +### Example 1: Update an AzureFrontDoor customdomain under the profile +```powershell +$secret = Get-AzFrontDoorCdnSecret -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name secret001 +$secretResoure = New-AzFrontDoorCdnResourceReferenceObject -Id $secret.Id +$updateTlsSetting = New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject -CertificateType "CustomerCertificate" -MinimumTlsVersion "TLS10" -Secret $secretResoure +Update-AzFrontDoorCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -CustomDomainName domain001 -TlsSetting $updateSetting +``` + +```output +Name ResourceGroupName +---- ----------------- +domain001 testps-rg-da16jm +``` + +Update an AzureFrontDoor customdomain under the profile + +### Example 2: Update an AzureFrontDoor customdomain under the profile via identity +```powershell +$secret = Get-AzFrontDoorCdnSecret -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name secret001 +$secretResoure = New-AzFrontDoorCdnResourceReferenceObject -Id $secret.Id +$updateTlsSetting = New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject -CertificateType "CustomerCertificate" -MinimumTlsVersion "TLS10" -Secret $secretResoure +Get-AzFrontDoorCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -CustomDomainName domain001 | Update-AzFrontDoorCdnCustomDomain -TlsSetting $updateSetting +``` + +```output +Name ResourceGroupName +---- ----------------- +domain001 testps-rg-da16jm +``` + +Update an AzureFrontDoor customdomain under the profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureDnsZoneId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDomainName +Name of the domain under the profile which is unique globally + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertiesPreValidatedCustomDomainResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TlsSetting +The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. +If not specified, enabling ssl uses AzureFrontDoor managed certificate by default. +To construct, see NOTES section for TLSSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdDomainHttpsParameters +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdDomain + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +`TLSSETTING `: The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default. + - `CertificateType `: Defines the source of the SSL certificate. + - `[MinimumTlsVersion ]`: TLS protocol version that will be used for Https + - `[Secret ]`: Resource reference to the secret. ie. subs/rg/profile/secret + - `[Id ]`: Resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnCustomDomainValidationToken.md b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnCustomDomainValidationToken.md new file mode 100644 index 0000000000..d667b75a0c --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnCustomDomainValidationToken.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azfrontdoorcdncustomdomainvalidationtoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnCustomDomainValidationToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnCustomDomainValidationToken.md +--- + +# Update-AzFrontDoorCdnCustomDomainValidationToken + +## SYNOPSIS +Updates the domain validation token. + +## SYNTAX + +### Refresh (Default) +``` +Update-AzFrontDoorCdnCustomDomainValidationToken -CustomDomainName -ProfileName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### RefreshViaIdentity +``` +Update-AzFrontDoorCdnCustomDomainValidationToken -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates the domain validation token. + +## EXAMPLES + +### Example 1: Updates the AzureFrontDoor customdomain validation token +```powershell +Update-AzFrontDoorCdnCustomDomainValidationToken -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -CustomDomainName domain001 +``` + +Updates the AzureFrontDoor customdomain validation token + +### Example 2: Updates the AzureFrontDoor customdomain validation token via identity +```powershell +Get-AzFrontDoorCdnCustomDomain -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -CustomDomainName domain001 | Update-AzFrontDoorCdnCustomDomainValidationToken +``` + +Updates the AzureFrontDoor customdomain validation token via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDomainName +Name of the domain under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: RefreshViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnEndpoint.md b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnEndpoint.md new file mode 100644 index 0000000000..586e8e6dc3 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnEndpoint.md @@ -0,0 +1,291 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azfrontdoorcdnendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnEndpoint.md +--- + +# Update-AzFrontDoorCdnEndpoint + +## SYNOPSIS +Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. +Only tags can be updated after creating an endpoint. +To update origins, use the Update Origin operation. +To update origin groups, use the Update Origin group operation. +To update domains, use the Update Custom Domain operation. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzFrontDoorCdnEndpoint -EndpointName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-EnabledState ] [-Tag ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzFrontDoorCdnEndpoint -InputObject [-EnabledState ] [-Tag ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. +Only tags can be updated after creating an endpoint. +To update origins, use the Update Origin operation. +To update origin groups, use the Update Origin group operation. +To update domains, use the Update Custom Domain operation. + +## EXAMPLES + +### Example 1: Update an AzureFrontDoor endpoint under the profile +```powershell +Update-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 -EnabledState Disabled +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +Global end001 testps-rg-da16jm +``` + +Update an AzureFrontDoor endpoint under the profile + +### Example 2: Update an AzureFrontDoor endpoint under the profile via identity +```powershell +Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end011 | Update-AzFrontDoorCdnEndpoint -EnabledState Disabled +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +Global end011 testps-rg-da16jm +``` + +Update an AzureFrontDoor endpoint under the profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Whether to enable use of this rule. +Permitted values are 'Enabled' or 'Disabled' + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.EnabledState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Endpoint tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdEndpoint + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnOrigin.md b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnOrigin.md new file mode 100644 index 0000000000..9cbaa32e8a --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnOrigin.md @@ -0,0 +1,497 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azfrontdoorcdnorigin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnOrigin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnOrigin.md +--- + +# Update-AzFrontDoorCdnOrigin + +## SYNOPSIS +Updates an existing origin within an origin group. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzFrontDoorCdnOrigin -OriginGroupName -OriginName -ProfileName + -ResourceGroupName [-SubscriptionId ] [-AzureOriginId ] + [-EnabledState ] [-EnforceCertificateNameCheck] [-HostName ] [-HttpPort ] + [-HttpsPort ] [-OriginHostHeader ] [-Priority ] [-PrivateLinkId ] + [-SharedPrivateLinkResourceGroupId ] [-SharedPrivateLinkResourcePrivateLinkLocation ] + [-SharedPrivateLinkResourceRequestMessage ] + [-SharedPrivateLinkResourceStatus ] [-Weight ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzFrontDoorCdnOrigin -InputObject [-AzureOriginId ] + [-EnabledState ] [-EnforceCertificateNameCheck] [-HostName ] [-HttpPort ] + [-HttpsPort ] [-OriginHostHeader ] [-Priority ] [-PrivateLinkId ] + [-SharedPrivateLinkResourceGroupId ] [-SharedPrivateLinkResourcePrivateLinkLocation ] + [-SharedPrivateLinkResourceRequestMessage ] + [-SharedPrivateLinkResourceStatus ] [-Weight ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates an existing origin within an origin group. + +## EXAMPLES + +### Example 1: Update an AzureFrontDoor origin group under the profile +```powershell +Update-AzFrontDoorCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -OriginName ori001 -Weight 999 +``` + +```output +Name ResourceGroupName +---- ----------------- +ori001 testps-rg-da16jm +``` + +Update an AzureFrontDoor origin group under the profile + +### Example 2: Update an AzureFrontDoor origin group under the profile via identity +```powershell +Get-AzFrontDoorCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -OriginName ori001 | Update-AzFrontDoorCdnOrigin -Weight 999 +``` + +```output +Name ResourceGroupName +---- ----------------- +ori001 testps-rg-da16jm +``` + +Update an AzureFrontDoor origin group under the profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureOriginId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Whether to enable health probes to be made against backends defined under backendPools. +Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.EnabledState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforceCertificateNameCheck +Whether to enable certificate name check at origin level + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +The address of the origin. +Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPort +The value of the HTTP port. +Must be between 1 and 65535. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsPort +The value of the HTTPS port. +Must be between 1 and 65535. + +```yaml +Type: System.Int32 +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.Cdn.Models.ICdnIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginGroupName +Name of the origin group which is unique within the profile. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginHostHeader +The host header value sent to the origin with each request. +If you leave this blank, the request hostname determines this value. +Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +This overrides the host header defined at Endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginName +Name of the origin which is unique within the profile. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Priority of origin in given origin group for load balancing. +Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedPrivateLinkResourceGroupId +The group id from the provider of resource the shared private link resource is for. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedPrivateLinkResourcePrivateLinkLocation +The location of the shared private link resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedPrivateLinkResourceRequestMessage +The request message for requesting approval of the shared private link resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedPrivateLinkResourceStatus +Status of the shared private link resource. +Can be Pending, Approved, Rejected, Disconnected, or Timeout. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.SharedPrivateLinkResourceStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Weight +Weight of the origin in given origin group for load balancing. +Must be between 1 and 1000 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdOrigin + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnOriginGroup.md b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnOriginGroup.md new file mode 100644 index 0000000000..be1588be75 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnOriginGroup.md @@ -0,0 +1,334 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azfrontdoorcdnorigingroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnOriginGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnOriginGroup.md +--- + +# Update-AzFrontDoorCdnOriginGroup + +## SYNOPSIS +Updates an existing origin group within a profile. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzFrontDoorCdnOriginGroup -OriginGroupName -ProfileName -ResourceGroupName + [-SubscriptionId ] [-HealthProbeSetting ] + [-LoadBalancingSetting ] [-SessionAffinityState ] + [-TrafficRestorationTimeToHealedOrNewEndpointsInMinute ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzFrontDoorCdnOriginGroup -InputObject [-HealthProbeSetting ] + [-LoadBalancingSetting ] [-SessionAffinityState ] + [-TrafficRestorationTimeToHealedOrNewEndpointsInMinute ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates an existing origin group within a profile. + +## EXAMPLES + +### Example 1: Update an AzureFrontDoor origin group under the profile +```powershell +$updateLoadBalancingSetting = New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject -AdditionalLatencyInMillisecond 200 -SampleSize 5 -SuccessfulSamplesRequired 3 +Update-AzFrontDoorCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -LoadBalancingSetting $updateLoadBalancingSetting +``` + +```output +Name ResourceGroupName +---- ----------------- +org001 testps-rg-da16jm +``` + +Update an AzureFrontDoor origin group under the profile + +### Example 2: Update an AzureFrontDoor origin group under the profile via identity +```powershell +$updateLoadBalancingSetting = New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject -AdditionalLatencyInMillisecond 200 -SampleSize 5 -SuccessfulSamplesRequired 3 +Get-AzFrontDoorCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 | Update-AzFrontDoorCdnOriginGroup -LoadBalancingSetting $updateLoadBalancingSetting +``` + +```output +Name ResourceGroupName +---- ----------------- +org001 testps-rg-da16jm +``` + +Update an AzureFrontDoor origin group under the profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthProbeSetting +Health probe settings to the origin that is used to determine the health of the origin. +To construct, see NOTES section for HEALTHPROBESETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IHealthProbeParameters +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.Cdn.Models.ICdnIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LoadBalancingSetting +Load balancing settings for a backend pool +To construct, see NOTES section for LOADBALANCINGSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ILoadBalancingSettingsParameters +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginGroupName +Name of the origin group which is unique within the profile. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionAffinityState +Whether to allow session affinity on this host. +Valid options are 'Enabled' or 'Disabled' + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.EnabledState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficRestorationTimeToHealedOrNewEndpointsInMinute +Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. +Default is 10 mins. +This property is currently not supported. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IAfdOriginGroup + +## 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. + + +`HEALTHPROBESETTING `: Health probe settings to the origin that is used to determine the health of the origin. + - `[ProbeIntervalInSecond ]`: The number of seconds between health probes.Default is 240sec. + - `[ProbePath ]`: The path relative to the origin that is used to determine the health of the origin. + - `[ProbeProtocol ]`: Protocol to use for health probe. + - `[ProbeRequestType ]`: The type of health probe request that is made. + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +`LOADBALANCINGSETTING `: Load balancing settings for a backend pool + - `[AdditionalLatencyInMillisecond ]`: The additional latency in milliseconds for probes to fall into the lowest latency bucket + - `[SampleSize ]`: The number of samples to consider for load balancing decisions + - `[SuccessfulSamplesRequired ]`: The number of samples within the sample period that must succeed + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnProfile.md b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnProfile.md new file mode 100644 index 0000000000..2772429e85 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnProfile.md @@ -0,0 +1,336 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azfrontdoorcdnprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnProfile.md +--- + +# Update-AzFrontDoorCdnProfile + +## SYNOPSIS +Updates an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzFrontDoorCdnProfile -Name -ResourceGroupName [-SubscriptionId ] + [-IdentityType ] [-IdentityUserAssignedIdentity ] + [-OriginResponseTimeoutSecond ] [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzFrontDoorCdnProfile -InputObject [-IdentityType ] + [-IdentityUserAssignedIdentity ] [-OriginResponseTimeoutSecond ] [-Tag ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group. + +## EXAMPLES + +### Example 1: Update an AzureFrontDoor profile under the resource group +```powershell +$tags = @{ + Tag1 = 11 + Tag2 = 22 +} +Update-AzFrontDoorCdnProfile -ResourceGroupName testps-rg-da16jm -Name fdp-v542q6 -Tag $tags +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global fdp-v542q6 frontdoor testps-rg-da16jm +``` + +Update an AzureFrontDoor profile under the resource group + +### Example 2: Update an AzureFrontDoor profile under the resource group via identity +```powershell +$tags = @{ + Tag1 = 11 + Tag2 = 22 +} +Get-AzFrontDoorCdnProfile -ResourceGroupName testps-rg-da16jm -Name fdp-v542q6 | Update-AzFrontDoorCdnProfile -Tag $tags +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global fdp-v542q6 frontdoor testps-rg-da16jm +``` + +Update an AzureFrontDoor profile under the resource group via identity + +### Example 3: Enable managed identity using SystemAssigned type to an AzureFrontDoor profile +```powershell +Update-AzFrontDoorCdnProfile -ResourceGroupName testps-rg-da16jm -Name fdp-v542q6 -IdentityType SystemAssigned +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global fdp-v542q6 frontdoor testps-rg-da16jm +``` + +Enable managed identity using SystemAssigned type to an AzureFrontDoor profile + +### Example 4: Enable managed identity using UserAssigned type to an AzureFrontDoor profile +```powershell +$userId = @{"/subscriptions/subId/resourceGroups/testps-rg-da16jm/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testcdnrpaadidentity" = @{}} +Update-AzFrontDoorCdnProfile -ResourceGroupName testps-rg-da16jm -Name fdp-v542q6 -IdentityType UserAssigned -IdentityUserAssignedIdentity $userId +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global fdp-v542q6 frontdoor testps-rg-da16jm +``` + +Enable managed identity using UserAssigned type to an AzureFrontDoor profile + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginResponseTimeoutSecond +Send and receive timeout on forwarding request to the origin. +When timeout is reached, the request fails and returns. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Profile tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IProfile + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnProfileSku.md b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnProfileSku.md new file mode 100644 index 0000000000..b3125084ab --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnProfileSku.md @@ -0,0 +1,259 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azfrontdoorcdnprofilesku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnProfileSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnProfileSku.md +--- + +# Update-AzFrontDoorCdnProfileSku + +## SYNOPSIS +Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor. + +## SYNTAX + +``` +Update-AzFrontDoorCdnProfileSku -ProfileName -ResourceGroupName + -ProfileUpgradeParameter [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor. + +## EXAMPLES + +### Example 1: When a profile not associated with WAF policy. +```powershell +$nullUpgradePara = @{} +Update-AzFrontDoorCdnProfileSku -ProfileName profileName -ResourceGroupName rgName -ProfileUpgradeParameter $nullUpgradePara +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global profileName frontdoor rgName +``` + +When a profile not associated with WAF policy. +Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor. + +### Example 2: When a CDN profile associated with WAF and copy to a new waf policy... +```powershell +$waf = New-AzFrontDoorCdnProfileChangeSkuWafMappingObject -SecurityPolicyName waf -ChangeToWafPolicyId /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourcegroups/rgName/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/newWAFName +$upgrade = New-AzFrontDoorCdnProfileUpgradeParametersObject -WafMappingList $waf + +Update-AzFrontDoorCdnProfileSku -ProfileName profileName -ResourceGroupName rgName -ProfileUpgradeParameter $upgrade +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global profileName frontdoor rgName +``` + +When a CDN profile associated with WAF and copy to a new WAF policy, the subscription and resource group of the new WAF policy should be same with the profile's. +Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor. + +### Example 2: When the CDN profile associated with WAF and select an exsting WAF policy... +```powershell +$waf1 = New-AzFrontDoorCdnProfileChangeSkuWafMappingObject -SecurityPolicyName waf1 -ChangeToWafPolicyId /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourcegroups/rgtest01/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/existingWAFName1 +$waf2 = New-AzFrontDoorCdnProfileChangeSkuWafMappingObject -SecurityPolicyName waf2 -ChangeToWafPolicyId /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourcegroups/rgtest02/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/existingWAFName2 +$upgrade = New-AzFrontDoorCdnProfileUpgradeParametersObject -WafMappingList @($waf1, $waf2) + +Update-AzFrontDoorCdnProfileSku -ProfileName profileName -ResourceGroupName rgName -ProfileUpgradeParameter $upgrade +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global profileName frontdoor rgName +``` + +When the CDN profile associated with WAF and select an exsting WAF policy, you could only select the WAF policy located in the same subscription with the profile's. +Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor. + +### Example 4: A CDN profile associated with WAF, when the subscription of the profile is different from the local subscrition +```powershell +$waf = New-AzFrontDoorCdnProfileChangeSkuWafMappingObject -SecurityPolicyName waf -ChangeToWafPolicyId /subscriptions/testSubId01/resourcegroups/rgtest01/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/ExistingPremiumWAFName +$upgrade = New-AzFrontDoorCdnProfileUpgradeParametersObject -WafMappingList $waf + +Update-AzFrontDoorCdnProfileSku -ProfileName profileName -ResourceGroupName rgName -ProfileUpgradeParameter $upgrade -SubscriptionId testSubId01 +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +Global profileName frontdoor rgName +``` + +A CDN profile associated with WAF, when the subscription of the profile is different from the local subscrition. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileUpgradeParameter +Parameters required for profile upgrade. +To construct, see NOTES section for PROFILEUPGRADEPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IProfileUpgradeParameters +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IProfileUpgradeParameters + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IProfile + +## 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. + + +`PROFILEUPGRADEPARAMETER `: Parameters required for profile upgrade. + - `WafMappingList `: Web Application Firewall (WAF) and security policy mapping for the profile upgrade + - `SecurityPolicyName `: The security policy name. + - `[ChangeToWafPolicyId ]`: Resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnRoute.md b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnRoute.md new file mode 100644 index 0000000000..f7c36cc9db --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnRoute.md @@ -0,0 +1,505 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azfrontdoorcdnroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnRoute.md +--- + +# Update-AzFrontDoorCdnRoute + +## SYNOPSIS +Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzFrontDoorCdnRoute -EndpointName -Name -ProfileName + -ResourceGroupName [-SubscriptionId ] [-CacheConfigurationQueryParameter ] + [-CacheConfigurationQueryStringCachingBehavior ] + [-CompressionSettingContentTypesToCompress ] [-CompressionSettingIsCompressionEnabled] + [-CustomDomain ] [-EnabledState ] + [-ForwardingProtocol ] [-HttpsRedirect ] + [-LinkToDefaultDomain ] [-OriginGroupId ] [-OriginPath ] + [-PatternsToMatch ] [-RuleSet ] [-SupportedProtocol ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzFrontDoorCdnRoute -InputObject [-CacheConfigurationQueryParameter ] + [-CacheConfigurationQueryStringCachingBehavior ] + [-CompressionSettingContentTypesToCompress ] [-CompressionSettingIsCompressionEnabled] + [-CustomDomain ] [-EnabledState ] + [-ForwardingProtocol ] [-HttpsRedirect ] + [-LinkToDefaultDomain ] [-OriginGroupId ] [-OriginPath ] + [-PatternsToMatch ] [-RuleSet ] [-SupportedProtocol ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint. + +## EXAMPLES + +### Example 1: Update an AzureFrontDoor route under the AzureFrontDoor profile +```powershell +Update-AzFrontDoorCdnRoute -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 -Name route001 -EnabledState "Enabled" +``` + +```output +Name ResourceGroupName +---- ----------------- +route001 testps-rg-da16jm +``` + +Update an AzureFrontDoor route under the AzureFrontDoor profile + +### Example 2: Update an AzureFrontDoor route under the AzureFrontDoor profile via identity +```powershell +Get-AzFrontDoorCdnRoute -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 -Name route001 | Update-AzFrontDoorCdnRoute -EnabledState "Enabled" +``` + +```output +Name ResourceGroupName +---- ----------------- +route001 testps-rg-da16jm +``` + +Update an AzureFrontDoor route under the AzureFrontDoor profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CacheConfigurationQueryParameter +query parameters to include or exclude (comma separated). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CacheConfigurationQueryStringCachingBehavior +Defines how Frontdoor caches requests that include query strings. +You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.AfdQueryStringCachingBehavior +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompressionSettingContentTypesToCompress +List of content types on which compression applies. +The value should be a valid MIME type. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompressionSettingIsCompressionEnabled +Indicates whether content compression is enabled on AzureFrontDoor. +Default value is false. +If compression is enabled, content will be served as compressed if user requests for a compressed version. +Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDomain +Domains referenced by this endpoint. +To construct, see NOTES section for CUSTOMDOMAIN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IActivatedResourceReference[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Whether to enable use of this rule. +Permitted values are 'Enabled' or 'Disabled' + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.EnabledState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the endpoint under the profile which is unique globally. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingProtocol +Protocol this rule will use when forwarding traffic to backends. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.ForwardingProtocol +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsRedirect +Whether to automatically redirect HTTP traffic to HTTPS traffic. +Note that this is a easy way to set up this rule and it will be the first rule that gets executed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.HttpsRedirect +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.Cdn.Models.ICdnIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkToDefaultDomain +whether this route will be linked to the default endpoint domain. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.LinkToDefaultDomain +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the routing rule. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: RouteName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginGroupId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginPath +A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. +contoso.cloudapp.net/originpath. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PatternsToMatch +The route patterns of the rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSet +rule sets referenced by this endpoint. +To construct, see NOTES section for RULESET properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IResourceReference[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportedProtocol +List of supported protocols for this route. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.AfdEndpointProtocols[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IRoute + +## 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. + + +`CUSTOMDOMAIN `: Domains referenced by this endpoint. + - `[Id ]`: Resource ID. + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +`RULESET `: rule sets referenced by this endpoint. + - `[Id ]`: Resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnRule.md b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnRule.md new file mode 100644 index 0000000000..194f397b6e --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnRule.md @@ -0,0 +1,342 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azfrontdoorcdnrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnRule.md +--- + +# Update-AzFrontDoorCdnRule + +## SYNOPSIS +Updates an existing delivery rule within a rule set. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzFrontDoorCdnRule -Name -ProfileName -ResourceGroupName -SetName + [-SubscriptionId ] [-Action ] [-Condition ] + [-MatchProcessingBehavior ] [-Order ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzFrontDoorCdnRule -InputObject [-Action ] + [-Condition ] [-MatchProcessingBehavior ] [-Order ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates an existing delivery rule within a rule set. + +## EXAMPLES + +### Example 1: Update an AzureFrontDoor delivery rule within the specified rule set +```powershell +Update-AzFrontDoorCdnRule -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 -Name rule1 -Order 99 +``` + +```output +Name ResourceGroupName +---- ----------------- +rule1 testps-rg-da16jm +``` + +Update an AzureFrontDoor delivery rule within the specified rule set + +### Example 2: Update an AzureFrontDoor delivery rule within the specified rule set via identity +```powershell +Get-AzFrontDoorCdnRule -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -RuleSetName ruleset001 -Name rule1 | Update-AzFrontDoorCdnRule -Order 99 +``` + +```output +Name ResourceGroupName +---- ----------------- +rule1 testps-rg-da16jm +``` + +Update an AzureFrontDoor delivery rule within the specified rule set via identity + +## PARAMETERS + +### -Action +A list of actions that are executed when all the conditions of a rule are satisfied. +To construct, see NOTES section for ACTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IDeliveryRuleAction1[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Condition +A list of conditions that must be matched for the actions to be executed +To construct, see NOTES section for CONDITION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IDeliveryRuleCondition[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MatchProcessingBehavior +If this rule is a match should the rules engine continue running the remaining rules or stop. +If not present, defaults to Continue. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Support.MatchProcessingBehavior +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the delivery rule which is unique within the endpoint. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: RuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +The order in which the rules are applied for the endpoint. +Possible values {0,1,2,3,………}. +A rule with a lesser order will be applied before a rule with a greater order. +Rule with order 0 is a special rule. +It does not require any condition and actions listed in it will always be applied. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetName +Name of the rule set under the profile. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: RuleSetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.IRule + +## 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. + + +`ACTION `: A list of actions that are executed when all the conditions of a rule are satisfied. + - `Name `: The name of the action for the delivery rule. + +`CONDITION `: A list of conditions that must be matched for the actions to be executed + - `Name `: The name of the condition for the delivery rule. + +`INPUTOBJECT `: Identity Parameter + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnSecurityPolicy.md b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnSecurityPolicy.md new file mode 100644 index 0000000000..121e46d624 --- /dev/null +++ b/azps-10.1.0/Az.Cdn/Update-AzFrontDoorCdnSecurityPolicy.md @@ -0,0 +1,277 @@ +--- +external help file: +Module Name: Az.Cdn +online version: https://learn.microsoft.com/powershell/module/az.cdn/update-azfrontdoorcdnsecuritypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnSecurityPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Cdn/help/Update-AzFrontDoorCdnSecurityPolicy.md +--- + +# Update-AzFrontDoorCdnSecurityPolicy + +## SYNOPSIS +Updates an existing security policy within a profile. + +## SYNTAX + +### PatchExpanded (Default) +``` +Update-AzFrontDoorCdnSecurityPolicy -Name -ProfileName -ResourceGroupName + [-SubscriptionId ] [-Parameter ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### PatchViaIdentityExpanded +``` +Update-AzFrontDoorCdnSecurityPolicy -InputObject + [-Parameter ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Updates an existing security policy within a profile. + +## EXAMPLES + +### Example 1: Update an AzureFrontDoor security policy within the specified AzureFrontDoor profile +```powershell +$endpoint = Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 +$endpoint2 = Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end002 +$updateAssociation = New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject -PatternsToMatch @("/*") -Domain @(@{"Id"=$($endpoint.Id)}) +$updateAssociation2 = New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject -PatternsToMatch @("/*") -Domain @(@{"Id"=$($endpoint2.Id)}) + +$wafPolicyId = "/subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourcegroups/rgName01/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf01" +$updateWafParameter = New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject -Association @($updateAssociation, $updateAssociation2) -WafPolicyId $wafPolicyId +Update-AzFrontDoorCdnSecurityPolicy -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name policy001 -Parameter $updateWafParameter +``` + +```output +Name ResourceGroupName +---- ----------------- +policy001 testps-rg-da16jm +``` + +Update an AzureFrontDoor security policy within the specified AzureFrontDoor profile + +### Example 2: Update an AzureFrontDoor security policy within the specified AzureFrontDoor profile via identity +```powershell +$endpoint = Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end001 +$endpoint2 = Get-AzFrontDoorCdnEndpoint -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -EndpointName end002 +$updateAssociation = New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject -PatternsToMatch @("/*") -Domain @(@{"Id"=$($endpoint.Id)}) +$updateAssociation2 = New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject -PatternsToMatch @("/*") -Domain @(@{"Id"=$($endpoint2.Id)}) + +$wafPolicyId = "/subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourcegroups/rgName01/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf01" +$updateWafParameter = New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject -Association @($updateAssociation, $updateAssociation2) -WafPolicyId $wafPolicyId + +Get-AzFrontDoorCdnSecurityPolicy -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -Name policy001 | Update-AzFrontDoorCdnSecurityPolicy -Parameter $updateWafParameter +``` + +Update an AzureFrontDoor security policy within the specified AzureFrontDoor profile via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity +Parameter Sets: PatchViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the security policy under the profile. + +```yaml +Type: System.String +Parameter Sets: PatchExpanded +Aliases: SecurityPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +object which contains security policy parameters + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ISecurityPolicyPropertiesParameters +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. + +```yaml +Type: System.String +Parameter Sets: PatchExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: PatchExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: PatchExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.ICdnIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20230501.ISecurityPolicy + +## 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 + - `[CustomDomainName ]`: Name of the domain under the profile which is unique globally. + - `[EndpointName ]`: Name of the endpoint under the profile which is unique globally. + - `[Id ]`: Resource identity path + - `[OriginGroupName ]`: Name of the origin group which is unique within the endpoint. + - `[OriginName ]`: Name of the origin which is unique within the profile. + - `[ProfileName ]`: Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. + - `[ResourceGroupName ]`: Name of the Resource group within the Azure subscription. + - `[RouteName ]`: Name of the routing rule. + - `[RuleName ]`: Name of the delivery rule which is unique within the endpoint. + - `[RuleSetName ]`: Name of the rule set under the profile which is unique globally. + - `[SecretName ]`: Name of the Secret under the profile. + - `[SecurityPolicyName ]`: Name of the security policy under the profile. + - `[SubscriptionId ]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ChangeAnalysis/Az.ChangeAnalysis.md b/azps-10.1.0/Az.ChangeAnalysis/Az.ChangeAnalysis.md new file mode 100644 index 0000000000..5f705af1cc --- /dev/null +++ b/azps-10.1.0/Az.ChangeAnalysis/Az.ChangeAnalysis.md @@ -0,0 +1,19 @@ +--- +Module Name: Az.ChangeAnalysis +Module Guid: 435d96dc-827b-4220-a093-565c12c95e4a +Download Help Link: https://learn.microsoft.com/powershell/module/az.changeanalysis +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ChangeAnalysis/help/Az.ChangeAnalysis.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ChangeAnalysis/help/Az.ChangeAnalysis.md +--- + +# Az.ChangeAnalysis Module +## Description +Microsoft Azure PowerShell: ChangeAnalysis cmdlets + +## Az.ChangeAnalysis Cmdlets +### [Get-AzChangeAnalysis](Get-AzChangeAnalysis.md) +Customer data is always masked if query at subscription or resource group level. +For query on a single resource, customer data is masked if the user doesn’t have access. + diff --git a/azps-10.1.0/Az.ChangeAnalysis/Get-AzChangeAnalysis.md b/azps-10.1.0/Az.ChangeAnalysis/Get-AzChangeAnalysis.md new file mode 100644 index 0000000000..15f19f35cd --- /dev/null +++ b/azps-10.1.0/Az.ChangeAnalysis/Get-AzChangeAnalysis.md @@ -0,0 +1,273 @@ +--- +external help file: +Module Name: Az.ChangeAnalysis +online version: https://learn.microsoft.com/powershell/module/az.changeanalysis/get-azchangeanalysis +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ChangeAnalysis/help/Get-AzChangeAnalysis.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ChangeAnalysis/help/Get-AzChangeAnalysis.md +--- + +# Get-AzChangeAnalysis + +## SYNOPSIS +Customer data is always masked if query at subscription or resource group level. +For query on a single resource, customer data is masked if the user doesn’t have access. + +## SYNTAX + +### List2 (Default) +``` +Get-AzChangeAnalysis -EndTime -StartTime [-SubscriptionId ] + [-SkipToken ] [-DefaultProfile ] [] +``` + +### List +``` +Get-AzChangeAnalysis -ResourceId -EndTime -StartTime [-SkipToken ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### List1 +``` +Get-AzChangeAnalysis -ResourceGroupName -EndTime -StartTime + [-SubscriptionId ] [-SkipToken ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Customer data is always masked if query at subscription or resource group level. +For query on a single resource, customer data is masked if the user doesn’t have access. + +## EXAMPLES + +### Example 1: List the changes of a subscription within the specified time range +```powershell +$start = Get-Date -Date "2021-07-16T12:09:03.141Z" -AsUTC +$end = Get-Date -Date "2021-07-18T12:09:03.141Z" -AsUTC +Get-AzChangeAnalysis -StartTime $start -EndTime $end +``` + +```Output +Name Type +---- ---- +ARG_96668df8-baa3-443a-b65e-e473b73a7df0_3671a03a-262c-4470-8abf-0691873f2e20_132709991319090106_132710115679840000 Microsoft.ChangeAnalysis/changes +ARG_6650f699-c589-47d0-8a0c-986747e0da51_02beafb4-a45d-4d2e-b6db-39f78b9c8cdb_132710114132810000_132710114396490000 Microsoft.ChangeAnalysis/changes +ARG_d365ea34-8582-4fb3-8c52-dba9a19f0f33_6650f699-c589-47d0-8a0c-986747e0da51_132709991313340016_132710114132810000 Microsoft.ChangeAnalysis/changes +ARG_3296a3bc-12bd-4fef-946f-43ff2eb355f0_325d8891-9a17-44ef-9c75-adf689a3e472_132709991313810987_132710113966730000 Microsoft.ChangeAnalysis/changes +ARG_311e76ea-5d00-467e-9429-91832bd0a00e_f5eb3b00-1e8c-4e77-9f94-9f9f20a068f7_132709991315140000_132710113635160000 Microsoft.ChangeAnalysis/changes +ARG_0cd19d15-f5e8-4183-8490-c5b46346eb4d_eaa165ed-1312-44cd-857b-dca369af4b9b_132709991311839973_132710113347940000 Microsoft.ChangeAnalysis/changes +ARG_5d07079f-beb6-4c9f-9a6c-c7cc9eb3d99f_7c6d7121-386d-47af-a123-d3780e078917_132709991321439966_132710113013580000 Microsoft.ChangeAnalysis/changes +ARG_041b62e5-7f3d-4f4d-bed7-8a9d3edc2966_f59b6207-b612-4a4d-9a62-03bfd182bc46_132709991316390202_132710112707510000 Microsoft.ChangeAnalysis/changes +ARG_9329dbeb-b807-4a6f-9d74-6918e65f2ff3_41d93e62-7dc3-46e8-9a75-848a1f3a0bda_132709573823920000_132709991325440351 Microsoft.ChangeAnalysis/changes +ARG_dc780601-b504-4649-bf25-0fee0e50c3f4_619618f3-549a-49c3-950a-9b731fc4fb34_132708911328790410_132709991323840381 Microsoft.ChangeAnalysis/changes +ARG_bc844a9d-8694-475b-bc9c-21196773b9f1_9e961411-f05d-4b7a-9b2d-ab8503ca9248_132709579070980000_132709991323240660 Microsoft.ChangeAnalysis/changes +ARG_2b07803b-55c3-41d9-a462-580300f28109_1a1b0c72-b1b7-45e6-b1aa-580164de757a_132708911329840382_132709991321590403 Microsoft.ChangeAnalysis/changes +ARG_1ba3852e-6de7-471d-834f-3ad286131028_271f7c65-8cc4-4652-afcf-c10989594edc_132709572690200000_132709991319040058 Microsoft.ChangeAnalysis/changes +ARG_acc8b899-73e5-4f5d-aaf4-ea27e9a8d784_fb0ec72d-4144-45be-8b21-fd2881dae433_132709572599140000_132709991317290006 Microsoft.ChangeAnalysis/changes +ARG_87e6da89-6a5b-44ff-9897-fdb576be48a3_c5983237-6f04-4091-a720-cfb76c9511c6_132709573194030000_132709991315990351 Microsoft.ChangeAnalysis/changes +ARG_af2eab01-5a60-4032-a73f-3b163ef913f9_5383297e-2aa5-43a5-88b5-df1ad59106bf_132709574410220000_132709991315640327 Microsoft.ChangeAnalysis/changes +ARG_9e2c2860-c8ca-4370-801d-1067ad05985f_08b5431b-7cee-43fb-8212-14bf8dd30818_132709575348480000_132709991314390001 Microsoft.ChangeAnalysis/changes +ARG_89d2c8ed-366f-4478-9a8e-d0d1f9ed111a_e1596920-1b50-4ca6-89be-536ce8fe6517_132709574386530000_132709991314139974 Microsoft.ChangeAnalysis/changes +ARG_8806183f-1dd1-431d-a3c9-4387b867378f_65131d9c-db4e-4598-b57b-c3f6ea74888a_132708911335140459_132709991313289972 Microsoft.ChangeAnalysis/changes +ARG_63783fae-93a4-4cbb-bb28-746b9e0062d1_6caab52f-0b43-4b34-a931-3a4be8408cfc_132709573223190000_132709991312489989 Microsoft.ChangeAnalysis/changes +ARG_8e4b8e63-5039-4552-a710-c7ae939ca5d5_2d066d89-be9d-4ff1-8aea-6894ea6ac5cd_132709572977720000_132709991312389997 Microsoft.ChangeAnalysis/changes +ARG_56379e0a-387c-4a82-bf89-85c5ef8a2197_3d47d3ca-df04-4328-83a9-a9aa4674d50d_132709251496760000_132709356771270000 Microsoft.ChangeAnalysis/changes +ARG_d7f5bba0-bbb1-423b-9104-e29a7417fcad_56173ed6-c09a-4e7a-a45e-1d5d5db60672_132708911330290427_132709252270260000 Microsoft.ChangeAnalysis/changes +ARG_3aba1b22-c4f6-4c11-bb9a-3338ea3119bb_7a15a4cd-7ae3-451c-900e-31da8ccda055_132708911334940487_132709252007650000 Microsoft.ChangeAnalysis/changes +ARG_b2ccb71d-624f-4069-92ca-758f1fda8a83_d76cd7a6-edeb-46f7-88f4-8a5e990f4b46_132708911328490377_132709251682950000 Microsoft.ChangeAnalysis/changes +ARG_da145a0d-cf0e-404c-a19e-d06ce8cea1a3_17adf639-a63f-4b13-8f16-f9f979b5d22d_132709044024690000_132709251657920000 Microsoft.ChangeAnalysis/changes +ARG_8476fa81-cc46-48a2-aa76-e7f6c44e8e95_56379e0a-387c-4a82-bf89-85c5ef8a2197_132708911331540433_132709251496760000 Microsoft.ChangeAnalysis/changes +ARG_c01ccacb-4b92-46bb-adc3-c4149b25a179_204ad6a5-95e8-484c-aa93-59d3144304ac_132708911329890708_132709250915520000 Microsoft.ChangeAnalysis/changes +ARG_c55dc8dc-6b31-4e05-926c-c4d1194fcbc3_dacb205b-3dd6-4c67-bc59-d6ce0789e695_132708911330190400_132709250255420000 Microsoft.ChangeAnalysis/changes +ARG_bd65a427-a683-4c89-bdd2-957596912e47_693e5c36-e7f4-44b0-9806-52d471a818f8_132708911329790438_132709249648610000 Microsoft.ChangeAnalysis/changes +``` + +This command lists the changes of a subscription within the specified time range. +`StartTime` and `EndTime` are UTC date formats. + +### Example 2: List the changes of a resource group within the specified time range +```powershell +$start = Get-Date -Date "2021-07-16T12:09:03.141Z" -AsUTC +$end = Get-Date -Date "2021-07-18T12:09:03.141Z" -AsUTC +Get-AzChangeAnalysis -StartTime $start -EndTime $end -ResourceGroupName azpssmokerg1268133cx4 +``` + +```Output +Name Type +---- ---- +ARG_3dd199c6-cfec-421a-bcd3-797c08de63bc_0ee1aacb-523b-40bd-96a0-00fed2f47380_132711384626690000_132712151317657566 Microsoft.ChangeAnalysis/changes +``` + +This command lists the changes of a resource group within the specified time range. +`StartTime` and `EndTime` are UTC date formats. + +### Example 3: List the changes of a resource within the specified time range +```powershell +$start = Get-Date -Date "2021-07-16T12:09:03.141Z" -AsUTC +$end = Get-Date -Date "2021-07-18T12:09:03.141Z" -AsUTC +Get-AzChangeAnalysis -StartTime $start -EndTime $end -ResourceId '/subscriptions/xxxxxx-xxxxx-xxxx-xxxx-xxxxxxf/resourceGroups/azpssmokerg1268133cx4/providers/Microsoft.Storage/storageAccounts/azpssmokesa1268133cx4' +``` + +```Output +Name Type +---- ---- +ARG_3dd199c6-cfec-421a-bcd3-797c08de63bc_0ee1aacb-523b-40bd-96a0-00fed2f47380_132711384626690000_132712151317657566 Microsoft.ChangeAnalysis/changes +``` + +This command lists the changes of a resource within the specified time range. +`StartTime` and `EndTime` are UTC date formats. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +Specifies the end time of the changes request. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The identifier of the resource. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +A skip token is used to continue retrieving items after an operation returns a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies the start time of the changes request. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: List1, List2 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ChangeAnalysis.Models.Api20210401.IChange + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Az.CloudService.md b/azps-10.1.0/Az.CloudService/Az.CloudService.md new file mode 100644 index 0000000000..0d0ac560a4 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Az.CloudService.md @@ -0,0 +1,110 @@ +--- +Module Name: Az.CloudService +Module Guid: a41eb61d-c5a1-4e9b-81a7-b8905fff7f2c +Download Help Link: https://learn.microsoft.com/powershell/module/az.cloudservice +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Az.CloudService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Az.CloudService.md +--- + +# Az.CloudService Module +## Description +Microsoft Azure PowerShell: CloudService cmdlets + +## Az.CloudService Cmdlets +### [Get-AzCloudService](Get-AzCloudService.md) +Display information about a cloud service. + +### [Get-AzCloudServiceInstanceView](Get-AzCloudServiceInstanceView.md) +Gets the status of a cloud service. + +### [Get-AzCloudServiceNetworkInterface](Get-AzCloudServiceNetworkInterface.md) +Get the specified network interface in a cloud service. + +### [Get-AzCloudServiceOSFamily](Get-AzCloudServiceOSFamily.md) +Gets properties of a guest operating system family that can be specified in the XML service configuration (.cscfg) for a cloud service. + +### [Get-AzCloudServiceOSVersion](Get-AzCloudServiceOSVersion.md) +Gets properties of a guest operating system version that can be specified in the XML service configuration (.cscfg) for a cloud service. + +### [Get-AzCloudServicePublicIPAddress](Get-AzCloudServicePublicIPAddress.md) +Get the specified public IP address in a cloud service. + +### [Get-AzCloudServiceRoleInstance](Get-AzCloudServiceRoleInstance.md) +Gets a role instance from a cloud service. + +### [Get-AzCloudServiceRoleInstanceRemoteDesktopFile](Get-AzCloudServiceRoleInstanceRemoteDesktopFile.md) +Gets a remote desktop file for a role instance in a cloud service. + +### [Get-AzCloudServiceRoleInstanceView](Get-AzCloudServiceRoleInstanceView.md) +Retrieves information about the run-time state of a role instance in a cloud service. + +### [Invoke-AzCloudServiceRebuild](Invoke-AzCloudServiceRebuild.md) +Rebuild Role Instances reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. +If you do not want to initialize storage resources, you can use Reimage Role Instances. + +### [Invoke-AzCloudServiceReimage](Invoke-AzCloudServiceReimage.md) +Reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles. + +### [Invoke-AzCloudServiceRoleInstanceRebuild](Invoke-AzCloudServiceRoleInstanceRebuild.md) +The Rebuild Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. +If you do not want to initialize storage resources, you can use Reimage Role Instance. + +### [Invoke-AzCloudServiceRoleInstanceReimage](Invoke-AzCloudServiceRoleInstanceReimage.md) +The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles. + +### [New-AzCloudService](New-AzCloudService.md) +Create or update a cloud service. +Please note some properties can be set only during cloud service creation. + +### [New-AzCloudServiceDiagnosticsExtension](New-AzCloudServiceDiagnosticsExtension.md) +Create a in-memory object for Diagnostics Extension + +### [New-AzCloudServiceExtensionObject](New-AzCloudServiceExtensionObject.md) +Create a in-memory object for Extension + +### [New-AzCloudServiceLoadBalancerConfigurationObject](New-AzCloudServiceLoadBalancerConfigurationObject.md) +Create a in-memory object for LoadBalancerConfiguration + +### [New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject](New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject.md) +Create a in-memory object for LoadBalancerFrontendIPConfiguration + +### [New-AzCloudServiceRemoteDesktopExtensionObject](New-AzCloudServiceRemoteDesktopExtensionObject.md) +Create a in-memory object for Remote Desktop Extension + +### [New-AzCloudServiceRoleProfilePropertiesObject](New-AzCloudServiceRoleProfilePropertiesObject.md) +Create a in-memory object for CloudServiceRoleProfileProperties + +### [New-AzCloudServiceVaultSecretGroupObject](New-AzCloudServiceVaultSecretGroupObject.md) +Create a in-memory object for Vault Secret Group + +### [Remove-AzCloudService](Remove-AzCloudService.md) +Deletes a cloud service. + +### [Remove-AzCloudServiceRoleInstance](Remove-AzCloudServiceRoleInstance.md) +Deletes role instances in a cloud service. + +### [Restart-AzCloudService](Restart-AzCloudService.md) +Restarts one or more role instances in a cloud service. + +### [Restart-AzCloudServiceRoleInstance](Restart-AzCloudServiceRoleInstance.md) +The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service. + +### [Set-AzCloudServiceUpdateDomain](Set-AzCloudServiceUpdateDomain.md) +Updates the role instances in the specified update domain. + +### [Start-AzCloudService](Start-AzCloudService.md) +Starts the cloud service. + +### [Stop-AzCloudService](Stop-AzCloudService.md) +Power off the cloud service. +Note that resources are still attached and you are getting charged for the resources. + +### [Switch-AzCloudService](Switch-AzCloudService.md) +Swaps VIPs between two cloud service (extended support) load balancers. + +### [Update-AzCloudService](Update-AzCloudService.md) +Create or update a cloud service. +Please note some properties can be set only during cloud service creation. + diff --git a/azps-10.1.0/Az.CloudService/Get-AzCloudService.md b/azps-10.1.0/Az.CloudService/Get-AzCloudService.md new file mode 100644 index 0000000000..c7688a908e --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Get-AzCloudService.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/get-azcloudservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudService.md +--- + +# Get-AzCloudService + +## SYNOPSIS +Display information about a cloud service. + +## SYNTAX + +### List (Default) +``` +Get-AzCloudService [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzCloudService -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCloudService -InputObject [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzCloudService -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Display information about a cloud service. + +## EXAMPLES + +### Example 1: Get all cloud service under a resource group +```powershell +Get-AzCloudService -ResourceGroupName "ContosOrg" +``` + +```output +ResourceGroupName Name Location ProvisioningState +----------------- ---- -------- ----------------- +ContosOrg ContosoCS eastus2euap Succeeded +ContosOrg ContosoCSTest eastus2euap Failed +``` + +This command gets all cloud services in resource group named ContosOrg + +### Example 2: Get cloud service +```powershell +$cloudService = Get-AzCloudService -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" +$cloudService | Format-List +``` + +```output +ResourceGroupName : ContosOrg +Configuration : xxxxxxxx +ConfigurationUrl : +ExtensionProfile : xxxxxxxx +Id : xxxxxxxx +Location : East US +Name : ContosoCS +NetworkProfile : xxxxxxxx +OSProfile : xxxxxxxx +PackageUrl : xxxxxxxx +ProvisioningState : Succeeded +RoleProfile : xxxxxxxx +StartCloudService : +Tag : { + "Owner": "Contos" + } +Type : Microsoft.Compute/cloudServices +UniqueId : xxxxxxxx +UpgradeMode : Auto +``` + +This command gets cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CloudServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudService + +## 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 + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Get-AzCloudServiceInstanceView.md b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceInstanceView.md new file mode 100644 index 0000000000..cd39fde5e0 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceInstanceView.md @@ -0,0 +1,159 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/get-azcloudserviceinstanceview +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceInstanceView.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceInstanceView.md +--- + +# Get-AzCloudServiceInstanceView + +## SYNOPSIS +Gets the status of a cloud service. + +## SYNTAX + +``` +Get-AzCloudServiceInstanceView -CloudServiceName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the status of a cloud service. + +## EXAMPLES + +### Example 1: Get cloud service instance view +```powershell +$cloudServiceInstanceView = Get-AzCloudServiceInstanceView -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" + +$cloudServiceInstanceView +$cloudServiceInstanceView.ToJsonString() +``` + +```output +RoleInstanceStatusesSummary Statuses +--------------------------- -------- + +{{ProvisioningState/succeeded : 4}, {PowerState/started : 4}} {Provisioning succeeded, Started, Current Upgrade Domain of cloud service is -1., Max Upgrade Domain of cloud service is 1.} +{ + "roleInstance": { + "statusesSummary": [ + { + "code": "ProvisioningState/succeeded", + "count": 4 + }, + { + "code": "PowerState/started", + "count": 4 + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "displayStatus": "Provisioning succeeded", + "level": "Info", + "time": "2020-10-28T13:26:48.8109686Z" + }, + { + "code": "PowerState/started", + "displayStatus": "Started", + "level": "Info", + "time": "2020-10-28T13:26:48.8109686Z" + }, + { + "code": "CurrentUpgradeDomain/-1", + "displayStatus": "Current Upgrade Domain of cloud service is -1.", + "level": "Info" + }, + { + "code": "MaxUpgradeDomain/1", + "displayStatus": "Max Upgrade Domain of cloud service is 1.", + "level": "Info" + } + ] +} +``` + +This cmdlet gets the instance view of the cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -CloudServiceName +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudServiceInstanceView + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Get-AzCloudServiceNetworkInterface.md b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceNetworkInterface.md new file mode 100644 index 0000000000..83f6a55360 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceNetworkInterface.md @@ -0,0 +1,222 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/get-azcloudservicenetworkinterface +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceNetworkInterface.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceNetworkInterface.md +--- + +# Get-AzCloudServiceNetworkInterface + +## SYNOPSIS +Get the specified network interface in a cloud service. + +## SYNTAX + +### List1 (Default) +``` +Get-AzCloudServiceNetworkInterface -CloudServiceName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzCloudServiceNetworkInterface -CloudServiceName -Name -ResourceGroupName + -RoleInstanceName [-SubscriptionId ] [-Expand ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzCloudServiceNetworkInterface -InputObject [-Expand ] + [-DefaultProfile ] [] +``` + +### List +``` +Get-AzCloudServiceNetworkInterface -CloudServiceName -ResourceGroupName + -RoleInstanceName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get the specified network interface in a cloud service. + +## EXAMPLES + +### Example 1: Get network interfaces by a cloud service name +```powershell +Get-AzCloudServiceNetworkInterface -ResourceGroupName "BRGThree" -CloudServiceName BService -SubscriptionId 1133e0eb-b53c-1234-b478-2eac8f04afca +``` + +Gets all the network interfaces for a given cloud service name. + +### Example 2: Get network interfaces by a cloud service object +```powershell +$cs = Get-AzCloudService -ResourceGroupName "BRGThree" -CloudServiceName BService -SubscriptionId 1133e0eb-b53c-1234-b478-2eac8f04afca +Get-AzCloudServiceNetworkInterface -InputObject $cs +``` + +Gets all the network interfaces for a given cloud service object. + +## PARAMETERS + +### -CloudServiceName +The name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: Get, List, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Expands referenced resources. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentity +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.CloudService.Models.ICloudServiceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the network interface. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: NetworkInterfaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleInstanceName +The name of role instance. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220701.INetworkInterface + +## 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 + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Get-AzCloudServiceOSFamily.md b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceOSFamily.md new file mode 100644 index 0000000000..7470907848 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceOSFamily.md @@ -0,0 +1,185 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/get-azcloudserviceosfamily +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceOSFamily.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceOSFamily.md +--- + +# Get-AzCloudServiceOSFamily + +## SYNOPSIS +Gets properties of a guest operating system family that can be specified in the XML service configuration (.cscfg) for a cloud service. + +## SYNTAX + +### List (Default) +``` +Get-AzCloudServiceOSFamily -Location [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzCloudServiceOSFamily -Location -OSFamilyName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCloudServiceOSFamily -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets properties of a guest operating system family that can be specified in the XML service configuration (.cscfg) for a cloud service. + +## EXAMPLES + +### Example 1: Get all OS families in a location +```powershell +Get-AzCloudServiceOSFamily -location 'westus2' +``` + +```output +Name Label +---- ----- +5 Windows Server 2016 +4 Windows Server 2012 R2 +6 Windows Server 2019 +3 Windows Server 2012 +2 Windows Server 2008 R2 +``` + +This command gets all OS families in location westus2 + +### Example 2: Get OS family +```powershell +Get-AzCloudServiceOSFamily -location 'westus2' -OSFamilyName 5 +``` + +```output +Name Label +---- ----- +5 Windows Server 2016 +``` + +This command gets OS family named 5 that is located in westus2. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the location that the OS family pertains to. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSFamilyName +Name of the OS family. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.IOSFamily + +## 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 + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Get-AzCloudServiceOSVersion.md b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceOSVersion.md new file mode 100644 index 0000000000..5700ff9332 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceOSVersion.md @@ -0,0 +1,185 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/get-azcloudserviceosversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceOSVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceOSVersion.md +--- + +# Get-AzCloudServiceOSVersion + +## SYNOPSIS +Gets properties of a guest operating system version that can be specified in the XML service configuration (.cscfg) for a cloud service. + +## SYNTAX + +### List (Default) +``` +Get-AzCloudServiceOSVersion -Location [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzCloudServiceOSVersion -Location -OSVersionName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCloudServiceOSVersion -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets properties of a guest operating system version that can be specified in the XML service configuration (.cscfg) for a cloud service. + +## EXAMPLES + +### Example 1: Get all OS versions in a location +```powershell +Get-AzCloudServiceOSVersion -location 'westus2' +``` + +```output +Name Label IsDefault IsActive Family FamilyLabel +---- ----- --------- -------- ------ ----------- +WA-GUEST-OS-6.7_201905-01 Windows Azure Guest OS 6.7 (Release 201905-01) False False 6 Windows Server 2019 +WA-GUEST-OS-3.21_201411-01 Windows Azure Guest OS 3.21 (Release 201411-01) False False 3 Windows Server 2012 +WA-GUEST-OS-3.34_201512-01 Windows Azure Guest OS 3.34 (Release 201512-01) False False 3 Windows Server 2012 +WA-GUEST-OS-3.26_201504-01 Windows Azure Guest OS 3.26 (Release 201504-01) False False 3 Windows Server 2012 +WA-GUEST-OS-2.46_201512-01 Windows Azure Guest OS 2.46 (Release 201512-01) False False 2 Windows Server 2008 R2 +``` + +This command gets all OS versions in location westus2 + +### Example 2: Get OS version +```powershell +Get-AzCloudServiceOSVersion -location 'westus2' -OSVersionName 'WA-GUEST-OS-6.7_201905-01' +``` + +```output +Name Label IsDefault IsActive Family FamilyLabel +---- ----- --------- -------- ------ ----------- +WA-GUEST-OS-6.7_201905-01 Windows Azure Guest OS 6.7 (Release 201905-01) False False 6 Windows Server 2019 +``` + +This command gets OS version named WA-GUEST-OS-6.7_201905-01 that is located in westus2. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the location that the OS version pertains to. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSVersionName +Name of the OS version. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.IOSVersion + +## 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 + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Get-AzCloudServicePublicIPAddress.md b/azps-10.1.0/Az.CloudService/Get-AzCloudServicePublicIPAddress.md new file mode 100644 index 0000000000..1f54b872c9 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Get-AzCloudServicePublicIPAddress.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/get-azcloudservicepublicipaddress +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServicePublicIPAddress.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServicePublicIPAddress.md +--- + +# Get-AzCloudServicePublicIPAddress + +## SYNOPSIS +Get the specified public IP address in a cloud service. + +## SYNTAX + +### List (Default) +``` +Get-AzCloudServicePublicIPAddress -CloudServiceName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzCloudServicePublicIPAddress -CloudServiceName -IPConfigurationName -Name + -NetworkInterfaceName -ResourceGroupName -RoleInstanceName + [-SubscriptionId ] [-Expand ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCloudServicePublicIPAddress -InputObject [-Expand ] + [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzCloudServicePublicIPAddress -CloudServiceName -IPConfigurationName + -NetworkInterfaceName -ResourceGroupName -RoleInstanceName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get the specified public IP address in a cloud service. + +## EXAMPLES + +### Example 1: Get instance level public IP addresses for a given cloud service name. +```powershell +Get-AzCloudServicePublicIPAddress -ResourceGroupName "BRGThree" -CloudServiceName BService -SubscriptionId 1133e0eb-b53c-1234-b478-2eac8f04afca +``` + +Gets the instance level public IP addresses for a given cloud service name. + +### Example 2: Get instance level public IP addresses for a given cloud service object. +```powershell +$cs = Get-AzCloudService -ResourceGroupName "BRGThree" -CloudServiceName BService -SubscriptionId 1133e0eb-b53c-1234-b478-2eac8f04afca +Get-AzCloudServicePublicIPAddress -InputObject $cs +``` + +Gets the instance level public IP addresses for a given cloud service object. + +## PARAMETERS + +### -CloudServiceName +The name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: Get, List, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Expands referenced resources. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentity +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.CloudService.Models.ICloudServiceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IPConfigurationName +The name of the IP configuration. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the public IP Address. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PublicIPAddressName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterfaceName +The name of the network interface. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleInstanceName +The role instance name. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220701.IPublicIPAddress + +## 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 + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Get-AzCloudServiceRoleInstance.md b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceRoleInstance.md new file mode 100644 index 0000000000..b87eb858ae --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceRoleInstance.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/get-azcloudserviceroleinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceRoleInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceRoleInstance.md +--- + +# Get-AzCloudServiceRoleInstance + +## SYNOPSIS +Gets a role instance from a cloud service. + +## SYNTAX + +### List (Default) +``` +Get-AzCloudServiceRoleInstance -CloudServiceName -ResourceGroupName + [-SubscriptionId ] [-Expand ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzCloudServiceRoleInstance -CloudServiceName -ResourceGroupName + -RoleInstanceName [-SubscriptionId ] [-Expand ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCloudServiceRoleInstance -InputObject [-Expand ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets a role instance from a cloud service. + +## EXAMPLES + +### Example 1: Get all role instances +```powershell +Get-AzCloudServiceRoleInstance -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" +``` + +```output +Name Location SkuName SkuTier +---- -------- ------- ------- +ContosoFrontEnd_IN_0 eastus2euap Standard_D1_v2 Standard +ContosoFrontEnd_IN_1 eastus2euap Standard_D1_v2 Standard +ContosoBackEnd_IN_1 eastus2euap Standard_D1_v2 Standard +ContosoBackEnd_IN_1 eastus2euap Standard_D1_v2 Standard +``` + +This command gets the properties of all role instances of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +### Example 2: Get properties for single role instance +```powershell +Get-AzCloudServiceRoleInstance -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstanceName "ContosoFrontEnd_IN_0" +``` + +```output +Name Location SkuName SkuTier +---- -------- ------- ------- +ContosoFrontEnd_IN_0 eastus2euap Standard_D1_v2 Standard +``` + +This command gets the properties of the role instance named ContosoFrontEnd_IN_0 of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -CloudServiceName +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +The expand expression to apply to the operation. +'UserData' is not supported for cloud services. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Support.InstanceViewTypes +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.CloudService.Models.ICloudServiceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleInstanceName +Name of the role instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.IRoleInstance + +## 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 + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Get-AzCloudServiceRoleInstanceRemoteDesktopFile.md b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceRoleInstanceRemoteDesktopFile.md new file mode 100644 index 0000000000..1bbd78ac25 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceRoleInstanceRemoteDesktopFile.md @@ -0,0 +1,157 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/get-azcloudserviceroleinstanceremotedesktopfile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceRoleInstanceRemoteDesktopFile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceRoleInstanceRemoteDesktopFile.md +--- + +# Get-AzCloudServiceRoleInstanceRemoteDesktopFile + +## SYNOPSIS +Gets a remote desktop file for a role instance in a cloud service. + +## SYNTAX + +``` +Get-AzCloudServiceRoleInstanceRemoteDesktopFile -CloudServiceName -ResourceGroupName + -RoleInstanceName -OutFile [-SubscriptionId ] [-DefaultProfile ] + [-PassThru] [] +``` + +## DESCRIPTION +Gets a remote desktop file for a role instance in a cloud service. + +## EXAMPLES + +### Example 1: Get an RDP file +```powershell +Get-AzCloudServiceRoleInstanceRemoteDesktopFile -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstanceName "ContosoFrontEnd_IN_0" -OutFile "C:\temp\ContosoFrontEnd_IN_0.rdp" +``` + +This command gets an RDP file for the role instance named ContosoFrontEnd\_IN\_0 of cloud Service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -CloudServiceName +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutFile +Path to write output file to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleInstanceName +Name of the role instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Get-AzCloudServiceRoleInstanceView.md b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceRoleInstanceView.md new file mode 100644 index 0000000000..bdb4ed10c5 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Get-AzCloudServiceRoleInstanceView.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/get-azcloudserviceroleinstanceview +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceRoleInstanceView.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Get-AzCloudServiceRoleInstanceView.md +--- + +# Get-AzCloudServiceRoleInstanceView + +## SYNOPSIS +Retrieves information about the run-time state of a role instance in a cloud service. + +## SYNTAX + +``` +Get-AzCloudServiceRoleInstanceView -CloudServiceName -ResourceGroupName + -RoleInstanceName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieves information about the run-time state of a role instance in a cloud service. + +## EXAMPLES + +### Example 1: Get instance view details for cloud service role instance +```powershell +Get-AzCloudServiceRoleInstanceView -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstanceName "ContosoFrontEnd_IN_0" +``` + +```output +Statuses PlatformFaultDomain PlatformUpdateDomain +-------- ------------------- -------------------- +{RoleStateStarted} 0 0 +``` + +This cmdlet gets the instance view of the role instance named ContosoFrontEnd_IN_0 of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -CloudServiceName +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleInstanceName +Name of the role instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.IRoleInstanceView + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Invoke-AzCloudServiceRebuild.md b/azps-10.1.0/Az.CloudService/Invoke-AzCloudServiceRebuild.md new file mode 100644 index 0000000000..8502385123 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Invoke-AzCloudServiceRebuild.md @@ -0,0 +1,259 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/invoke-azcloudservicerebuild +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Invoke-AzCloudServiceRebuild.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Invoke-AzCloudServiceRebuild.md +--- + +# Invoke-AzCloudServiceRebuild + +## SYNOPSIS +Rebuild Role Instances reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. +If you do not want to initialize storage resources, you can use Reimage Role Instances. + +## SYNTAX + +### RebuildExpanded (Default) +``` +Invoke-AzCloudServiceRebuild -CloudServiceName -ResourceGroupName -RoleInstance + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### RebuildViaIdentityExpanded +``` +Invoke-AzCloudServiceRebuild -InputObject -RoleInstance + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Rebuild Role Instances reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. +If you do not want to initialize storage resources, you can use Reimage Role Instances. + +## EXAMPLES + +### Example 1: Rebuild role instances of cloud service +```powershell +$roleInstances = @("ContosoFrontEnd_IN_0", "ContosoBackEnd_IN_1") +Invoke-AzCloudServiceRebuild -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstance $roleInstances +``` + +This command rebuilds 2 role instances ContosoFrontEnd_IN_0 and ContosoBackEnd_IN_1 of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +### Example 2: Rebuild all roles of cloud service +```powershell +Invoke-AzCloudServiceRebuild -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstance "*" +``` + +This command rebuilds all role instances of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServiceName +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: RebuildExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: RebuildViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: RebuildExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleInstance +List of cloud service role instance names. +Value of '*' will signify all role instances of the cloud service. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: RebuildExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Invoke-AzCloudServiceReimage.md b/azps-10.1.0/Az.CloudService/Invoke-AzCloudServiceReimage.md new file mode 100644 index 0000000000..05bc55f51f --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Invoke-AzCloudServiceReimage.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/invoke-azcloudservicereimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Invoke-AzCloudServiceReimage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Invoke-AzCloudServiceReimage.md +--- + +# Invoke-AzCloudServiceReimage + +## SYNOPSIS +Reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles. + +## SYNTAX + +### ReimageExpanded (Default) +``` +Invoke-AzCloudServiceReimage -Name -ResourceGroupName -RoleInstance + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### ReimageViaIdentityExpanded +``` +Invoke-AzCloudServiceReimage -InputObject -RoleInstance + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles. + +## EXAMPLES + +### Example 1: Reimage role instances of cloud service +```powershell +$roleInstances = @("ContosoFrontEnd_IN_0", "ContosoBackEnd_IN_1") +Invoke-AzCloudServiceReimage -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstance $roleInstances +``` + +This command reimages 2 role instances ContosoFrontEnd_IN_0 and ContosoBackEnd_IN_1 of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +### Example 2: Reimage all roles of cloud service +```powershell +Invoke-AzCloudServiceReimage -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstance "*" +``` + +This command reimages all role instances of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: ReimageViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: ReimageExpanded +Aliases: CloudServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ReimageExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleInstance +List of cloud service role instance names. +Value of '*' will signify all role instances of the cloud service. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: ReimageExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Invoke-AzCloudServiceRoleInstanceRebuild.md b/azps-10.1.0/Az.CloudService/Invoke-AzCloudServiceRoleInstanceRebuild.md new file mode 100644 index 0000000000..8fe1aa03ad --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Invoke-AzCloudServiceRoleInstanceRebuild.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/invoke-azcloudserviceroleinstancerebuild +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Invoke-AzCloudServiceRoleInstanceRebuild.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Invoke-AzCloudServiceRoleInstanceRebuild.md +--- + +# Invoke-AzCloudServiceRoleInstanceRebuild + +## SYNOPSIS +The Rebuild Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. +If you do not want to initialize storage resources, you can use Reimage Role Instance. + +## SYNTAX + +### Rebuild (Default) +``` +Invoke-AzCloudServiceRoleInstanceRebuild -CloudServiceName -ResourceGroupName + -RoleInstanceName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### RebuildViaIdentity +``` +Invoke-AzCloudServiceRoleInstanceRebuild -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The Rebuild Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. +If you do not want to initialize storage resources, you can use Reimage Role Instance. + +## EXAMPLES + +### Example 1: Rebuild role instance of a cloud service +```powershell +Invoke-AzCloudServiceRoleInstanceRebuild -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstanceName "ContosoFrontEnd_IN_0" +``` + +This command reimages role instance named ContosoFrontEnd_IN_0 of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServiceName +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: Rebuild +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: RebuildViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Rebuild +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleInstanceName +Name of the role instance. + +```yaml +Type: System.String +Parameter Sets: Rebuild +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Rebuild +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Invoke-AzCloudServiceRoleInstanceReimage.md b/azps-10.1.0/Az.CloudService/Invoke-AzCloudServiceRoleInstanceReimage.md new file mode 100644 index 0000000000..739e0ce111 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Invoke-AzCloudServiceRoleInstanceReimage.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/invoke-azcloudserviceroleinstancereimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Invoke-AzCloudServiceRoleInstanceReimage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Invoke-AzCloudServiceRoleInstanceReimage.md +--- + +# Invoke-AzCloudServiceRoleInstanceReimage + +## SYNOPSIS +The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles. + +## SYNTAX + +### Reimage (Default) +``` +Invoke-AzCloudServiceRoleInstanceReimage -CloudServiceName -ResourceGroupName + -RoleInstanceName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ReimageViaIdentity +``` +Invoke-AzCloudServiceRoleInstanceReimage -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles. + +## EXAMPLES + +### Example 1: Reimage role instance of a cloud service +```powershell +Invoke-AzCloudServiceRoleInstanceReimage -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstanceName "ContosoFrontEnd_IN_0" +``` + +This command reimages role instance named ContosoFrontEnd_IN_0 of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServiceName +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: Reimage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: ReimageViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Reimage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleInstanceName +Name of the role instance. + +```yaml +Type: System.String +Parameter Sets: Reimage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Reimage +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/New-AzCloudService.md b/azps-10.1.0/Az.CloudService/New-AzCloudService.md new file mode 100644 index 0000000000..baa8cfa0b7 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/New-AzCloudService.md @@ -0,0 +1,733 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/new-azcloudservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudService.md +--- + +# New-AzCloudService + +## SYNOPSIS +Create or update a cloud service. +Please note some properties can be set only during cloud service creation. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzCloudService -Name -ResourceGroupName -Location [-SubscriptionId ] + [-AllowModelOverride] [-Configuration ] [-ConfigurationUrl ] + [-ExtensionProfile ] [-NetworkProfile ] + [-OSProfile ] [-PackageUrl ] [-RoleProfile ] + [-StartCloudService] [-Tag ] [-UpgradeMode ] [-Zone ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### quickCreateParameterSetWithoutStorage +``` +New-AzCloudService -Name -ResourceGroupName -ConfigurationFile + -DefinitionFile -Location -PackageUrl [-SubscriptionId ] + [-DnsName ] [-ExtensionProfile ] [-KeyVaultName ] + [-StartCloudService] [-Tag ] [-UpgradeMode ] [-Confirm] [-WhatIf] + [] +``` + +### quickCreateParameterSetWithStorage +``` +New-AzCloudService -Name -ResourceGroupName -ConfigurationFile + -DefinitionFile -Location -PackageFile -StorageAccount + [-SubscriptionId ] [-DnsName ] [-ExtensionProfile ] + [-KeyVaultName ] [-StartCloudService] [-Tag ] [-UpgradeMode ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create or update a cloud service. +Please note some properties can be set only during cloud service creation. + +## EXAMPLES + +### Example 1: Create new cloud service with single role +```powershell +# Create role profile object +$role = New-AzCloudServiceRoleProfilePropertiesObject -Name 'ContosoFrontend' -SkuName 'Standard_D1_v2' -SkuTier 'Standard' -SkuCapacity 2 +$roleProfile = @{role = @($role)} + +# Create network profile object +$publicIp = Get-AzPublicIpAddress -ResourceGroupName ContosOrg -Name ContosIp +$feIpConfig = New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject -Name 'ContosoFe' -PublicIPAddressId $publicIp.Id +$loadBalancerConfig = New-AzCloudServiceLoadBalancerConfigurationObject -Name 'ContosoLB' -FrontendIPConfiguration $feIpConfig +$networkProfile = @{loadBalancerConfiguration = $loadBalancerConfig} + +# Read Configuration File +$cscfgFile = "" +$cscfgContent = Get-Content $cscfgFile | Out-String + +# Create cloud service +$cloudService = New-AzCloudService ` + -Name ContosoCS ` + -ResourceGroupName ContosOrg ` + -Location EastUS ` + -PackageUrl "https://xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ` + -Configuration $cscfgContent ` + -UpgradeMode 'Auto' ` + -RoleProfile $roleProfile ` + -NetworkProfile $networkProfile +``` + +Above set of commands creates a cloud service with single role + +### Example 2: Create new cloud service with single role and RDP extension +```powershell +# Create role profile object +$role = New-AzCloudServiceRoleProfilePropertiesObject -Name 'ContosoFrontend' -SkuName 'Standard_D1_v2' -SkuTier 'Standard' -SkuCapacity 2 +$roleProfile = @{role = @($role)} + +# Create network profile object +$publicIp = Get-AzPublicIpAddress -ResourceGroupName ContosoOrg -Name ContosIp +$feIpConfig = New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject -Name 'ContosoFe' -PublicIPAddressId $publicIp.Id +$loadBalancerConfig = New-AzCloudServiceLoadBalancerConfigurationObject -Name 'ContosoLB' -FrontendIPConfiguration $feIpConfig +$networkProfile = @{loadBalancerConfiguration = $loadBalancerConfig} + +# Create RDP extension object +$credential = Get-Credential +$expiration = (Get-Date).AddYears(1) +$extension = New-AzCloudServiceRemoteDesktopExtensionObject -Name 'RDPExtension' -Credential $credential -Expiration $expiration -TypeHandlerVersion '1.2.1' +$extensionProfile = @{extension = @($extension)} + +# Read Configuration File +$cscfgFile = "" +$cscfgContent = Get-Content $cscfgFile | Out-String + +# Create cloud service +$cloudService = New-AzCloudService ` + -Name ContosoCS ` + -ResourceGroupName ContosOrg ` + -Location EastUS ` + -PackageUrl "https://xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ` + -Configuration $cscfgContent ` + -UpgradeMode 'Auto' ` + -RoleProfile $roleProfile ` + -NetworkProfile $networkProfile ` + -ExtensionProfile $extensionProfile +``` + +Above set of commands creates a cloud service with single role and RDP extension + +### Example 3: Create new cloud service with single role and certificate from key vault +```powershell +# Create role profile object +$role = New-AzCloudServiceRoleProfilePropertiesObject -Name 'ContosoFrontend' -SkuName 'Standard_D1_v2' -SkuTier 'Standard' -SkuCapacity 2 +$roleProfile = @{role = @($role)} + +# Create OS profile object +$keyVault = Get-AzKeyVault -ResourceGroupName ContosOrg -VaultName ContosKeyVault +$certificate=Get-AzKeyVaultCertificate -VaultName ContosKeyVault -Name ContosCert +$secretGroup = New-AzCloudServiceVaultSecretGroupObject -Id $keyVault.ResourceId -CertificateUrl $certificate.SecretId +$osProfile = @{secret = @($secretGroup)} + +# Create network profile object +$publicIp = Get-AzPublicIpAddress -ResourceGroupName ContosOrg -Name ContosIp +$feIpConfig = New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject -Name 'ContosoFe' -PublicIPAddressId $publicIp.Id +$loadBalancerConfig = New-AzCloudServiceLoadBalancerConfigurationObject -Name 'ContosoLB' -FrontendIPConfiguration $feIpConfig +$networkProfile = @{loadBalancerConfiguration = $loadBalancerConfig} + +# Read Configuration File +$cscfgFile = "" +$cscfgContent = Get-Content $cscfgFile | Out-String + +# Create cloud service +$cloudService = New-AzCloudService ` + -Name ContosoCS ` + -ResourceGroupName ContosOrg ` + -Location EastUS ` + -PackageUrl "https://xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ` + -Configuration $cscfgContent ` + -UpgradeMode 'Auto' ` + -RoleProfile $roleProfile ` + -NetworkProfile $networkProfile ` + -OSProfile $osProfile +``` + +Above set of commands creates a cloud service with single role and certificate from key vault. + +### Example 4: Create new cloud service with multiple roles and extensions +```powershell +# Create role profile object +$role1 = New-AzCloudServiceRoleProfilePropertiesObject -Name 'ContosoFrontend' -SkuName 'Standard_D1_v2' -SkuTier 'Standard' -SkuCapacity 2 +$role2 = New-AzCloudServiceRoleProfilePropertiesObject -Name 'ContosoBackend' -SkuName 'Standard_D1_v2' -SkuTier 'Standard' -SkuCapacity 2 +$roleProfile = @{role = @($role1, $role2)} + +# Create network profile object +$publicIp = Get-AzPublicIpAddress -ResourceGroupName ContosOrg -Name ContosIp +$feIpConfig = New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject -Name 'ContosoFe' -PublicIPAddressId $publicIp.Id +$loadBalancerConfig = New-AzCloudServiceLoadBalancerConfigurationObject -Name 'ContosoLB' -FrontendIPConfiguration $feIpConfig +$networkProfile = @{loadBalancerConfiguration = $loadBalancerConfig} + +# Create RDP extension object +$credential = Get-Credential +$expiration = (Get-Date).AddYears(1) +$rdpExtension = New-AzCloudServiceRemoteDesktopExtensionObject -Name 'RDPExtension' -Credential $credential -Expiration $expiration -TypeHandlerVersion '1.2.1' + +# Create Geneva extension object +$genevaExtension = New-AzCloudServiceExtensionObject -Name GenevaExtension -Publisher Microsoft.Azure.Geneva -Type GenevaMonitoringPaaS -TypeHandlerVersion "2.14.0.2" +$extensionProfile = @{extension = @($rdpExtension, $genevaExtension)} + +# Add tags +$tag=@{"Owner" = "Contoso"} + +# Read Configuration File +$cscfgFile = "" +$cscfgContent = Get-Content $cscfgFile | Out-String + +# Create cloud service +$cloudService = New-AzCloudService ` + -Name ContosoCS ` + -ResourceGroupName ContosOrg ` + -Location EastUS ` + -PackageUrl "https://xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ` + -Configuration $cscfgContent ` + -UpgradeMode 'Auto' ` + -RoleProfile $roleProfile ` + -NetworkProfile $networkProfile ` + -ExtensionProfile $extensionProfile ` + -Tag $tag +``` + +Above set of commands creates a cloud service with single role and certificate from key vault. + +### Example 5: Create new cloud service with CsCfg, CsDef, and Cspkg files using 'quickCreateParameterSetWithStorage' parameter set. +```powershell +# Set up a storage account if you have not +$storageAccount = New-AzStorageAccount -ResourceGroupName ContosoOrg -Name ContosoStorAcc -Location "East US" -SkuName "Standard_RAGRS" -Kind "StorageV2" + +# Create cloud service +$cloudService = New-AzCloudService ` + -Name ContosoCS ` + -ResourceGroupName ContosOrg ` + -Location EastUS ` + -ConfigurationFile C:\files\CS.cscfg ` + -DefinitionFile C:\files\CS.csdef ` + -PackageFile C:\CS.cspkg ` + -StorageAccount ContosoStorAcc ` + -KeyVaultName ContosoKV + +``` + +Above set of commands creates a cloud service by extracting NetworkProfile and RoleProfile information from the .CsCfg and .CsDef files. + +Those files will also provide OSProfile information along with the Certificates from the keyvault provided in the '-KeyVaultName' parameter. +This parameter set also uploads the .CsPkg file to the provided StorageAccount. + +### Example 6: Create new cloud service with CsCfg, CsDef, and Cspkg files using 'quickCreateParameterSetWithoutStorage' parameter set. +```powershell +# getting Package URL +$tokenStartTime = Get-Date +$tokenEndTime = $tokenStartTime.AddYears(1) +$storAcc = Get-AzStorageAccount -ResourceGroupName ContosoOrg -Name ContosoStorAcc +$csPkgBlob = Get-AzStorageBlob -Container Contoso-Container -Blob ContosoBlob.cspkg -Context $storAcc.Context +$csPkgToken = New-AzStorageBlobSASToken -Container Contoso-Container -Blob ContosoBlob.cspkg -Permission rwd -StartTime $tokenStartTime -ExpiryTime $tokenEndTime -Context $storAcc.Context +$cspkgUrl = $csPkgBlob.ICloudBlob.Uri.AbsoluteUri + $csPkgToken + +# Create cloud service +$cloudService = New-AzCloudService ` + -Name ContosoCS ` + -ResourceGroupName ContosOrg ` + -Location EastUS ` + -ConfigurationFile C:\files\CS.cscfg ` + -DefinitionFile C:\files\CS.csdef ` + -packageUrl $cspkgUrl ` + +``` + +Above set of commands creates a cloud service by extracting NetworkProfile and RoleProfile information from the .CsCfg and .CsDef files. + +Those files will also provide OSProfile information along with the Certificates from the keyvault provided in the '-KeyVaultName' parameter. + +## PARAMETERS + +### -AllowModelOverride +(Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively.The default value is `false`. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Configuration +Specifies the XML service configuration (.cscfg) for the cloud service. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationFile +Specifies the XML service configuration (.cscfg) for the cloud service. + +```yaml +Type: System.String +Parameter Sets: quickCreateParameterSetWithoutStorage, quickCreateParameterSetWithStorage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationUrl +Specifies a URL that refers to the location of the service configuration in the Blob service. +The service package URL can be Shared Access Signature (SAS) URI from any storage account.This is a write-only property and is not returned in GET calls. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: CreateExpanded +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +Path to .csdef file. + +```yaml +Type: System.String +Parameter Sets: quickCreateParameterSetWithoutStorage, quickCreateParameterSetWithStorage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsName +Name of Dns to be used for the CloudService resource. + +```yaml +Type: System.String +Parameter Sets: quickCreateParameterSetWithoutStorage, quickCreateParameterSetWithStorage +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionProfile +Describes a cloud service extension profile. +To construct, see NOTES section for EXTENSIONPROFILE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudServiceExtensionProfile +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultName +Name of the KeyVault to be used for the CloudService resource. + +```yaml +Type: System.String +Parameter Sets: quickCreateParameterSetWithoutStorage, quickCreateParameterSetWithStorage +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CloudServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfile +Network Profile for the cloud service. +To construct, see NOTES section for NETWORKPROFILE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudServiceNetworkProfile +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSProfile +Describes the OS profile for the cloud service. +To construct, see NOTES section for OSPROFILE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudServiceOSProfile +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageFile +Path to .cspkg file. +It will be uploaded to a blob + +```yaml +Type: System.String +Parameter Sets: quickCreateParameterSetWithStorage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageUrl +Specifies a URL that refers to the location of the service package in the Blob service. +The service package URL can be Shared Access Signature (SAS) URI from any storage account.This is a write-only property and is not returned in GET calls. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, quickCreateParameterSetWithoutStorage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleProfile +Describes the role profile for the cloud service. +To construct, see NOTES section for ROLEPROFILE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudServiceRoleProfile +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartCloudService +(Optional) Indicates whether to start the cloud service immediately after it is created. +The default value is `true`.If false, the service model is still deployed, but the code is not run immediately. +Instead, the service is PoweredOff until you call Start, at which time the service will be started. +A deployed service still incurs charges, even if it is poweredoff. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Name of the storage account that will store the Package file. + +```yaml +Type: System.String +Parameter Sets: quickCreateParameterSetWithStorage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeMode +Update mode for the cloud service. +Role instances are allocated to update domains when the service is deployed. +Updates can be initiated manually in each update domain or initiated automatically in all update domains.Possible Values are \
\
**Auto**\
\
**Manual** \
\
**Simultaneous**\
\
If not specified, the default value is Auto. +If set to Manual, PUT UpdateDomain must be called to apply the update. +If set to Auto, the update is automatically applied to each update domain in sequence. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Support.CloudServiceUpgradeMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +List of logical availability zone of the resource. +List should contain only 1 zone where cloud service should be provisioned. +This field is optional. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudService + +## 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. + + +`EXTENSIONPROFILE `: Describes a cloud service extension profile. + - `[Extension ]`: List of extensions for the cloud service. + - `[AutoUpgradeMinorVersion ]`: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. + - `[ForceUpdateTag ]`: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not + - `[Name ]`: The name of the extension. + - `[ProtectedSetting ]`: Protected settings for the extension which are encrypted before sent to the role instance. + - `[ProtectedSettingFromKeyVaultSecretUrl ]`: Secret URL which contains the protected settings of the extension + - `[Publisher ]`: The name of the extension handler publisher. + - `[RolesAppliedTo ]`: Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service. + - `[Setting ]`: Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension. + - `[SourceVaultId ]`: Resource Id + - `[Type ]`: Specifies the type of the extension. + - `[TypeHandlerVersion ]`: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance. + +`NETWORKPROFILE `: Network Profile for the cloud service. + - `[LoadBalancerConfiguration ]`: List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer. + - `FrontendIPConfiguration `: Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration. + - `Name `: The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. + - `[PrivateIPAddress ]`: The virtual network private IP address of the IP configuration. + - `[PublicIPAddressId ]`: Resource Id + - `[SubnetId ]`: Resource Id + - `Name `: The name of the Load balancer + - `[Id ]`: Resource Id + - `[SlotType ]`: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. + - `[SwappableCloudService ]`: The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown. + - `[Id ]`: Resource Id + +`OSPROFILE `: Describes the OS profile for the cloud service. + - `[Secret ]`: Specifies set of certificates that should be installed onto the role instances. + - `[SourceVaultId ]`: Resource Id + - `[VaultCertificate ]`: The list of key vault references in SourceVault which contain certificates. + - `[CertificateUrl ]`: This is the URL of a certificate that has been uploaded to Key Vault as a secret. + +`ROLEPROFILE `: Describes the role profile for the cloud service. + - `[Role ]`: List of roles for the cloud service. + - `[Name ]`: Resource name. + - `[SkuCapacity ]`: Specifies the number of role instances in the cloud service. + - `[SkuName ]`: The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku. + - `[SkuTier ]`: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/New-AzCloudServiceDiagnosticsExtension.md b/azps-10.1.0/Az.CloudService/New-AzCloudServiceDiagnosticsExtension.md new file mode 100644 index 0000000000..98245f542b --- /dev/null +++ b/azps-10.1.0/Az.CloudService/New-AzCloudServiceDiagnosticsExtension.md @@ -0,0 +1,206 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/new-azcloudservicediagnosticsextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceDiagnosticsExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceDiagnosticsExtension.md +--- + +# New-AzCloudServiceDiagnosticsExtension + +## SYNOPSIS +Create a in-memory object for Diagnostics Extension + +## SYNTAX + +``` +New-AzCloudServiceDiagnosticsExtension [-Name] [-ResourceGroupName] + [-CloudServiceName] [-DiagnosticsConfigurationPath] [-StorageAccountName] + [-StorageAccountKey] [[-Subscription] ] [[-TypeHandlerVersion] ] + [[-RolesAppliedTo] ] [[-AutoUpgradeMinorVersion] ] [] +``` + +## DESCRIPTION +Create a in-memory object for Diagnostics Extension + +## EXAMPLES + +### Example 1: Create diagnostics extension object +```powershell +$storageAccountKey = Get-AzStorageAccountKey -ResourceGroupName "ContosOrg" -Name "ContosSA" +$configFile = "" +$extension = New-AzCloudServiceDiagnosticsExtension -Name "WADExtension" -ResourceGroupName "ContosOrg" -CloudServiceName "ContosCS" -StorageAccountName "ContosSA" -StorageAccountKey $storageAccountKey[0].Value -DiagnosticsConfigurationPath $configFile -TypeHandlerVersion "1.5" -AutoUpgradeMinorVersion $true +``` + +This command creates diagnostics extension object which is used for creating or updating a cloud service. +For more details see New-AzCloudService. + +## PARAMETERS + +### -AutoUpgradeMinorVersion +Auto upgrade minor version. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServiceName +Name of Cloud Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticsConfigurationPath +Specifies the configuration for Azure Diagnostics. +You can download the schema by using the following command: (Get-AzureServiceAvailableExtension -ExtensionName 'PaaSDiagnostics' -ProviderNamespace 'Microsoft.Azure.Diagnostics').PublicConfigurationSchema | Out-File -Encoding utf8 -FilePath 'WadConfig.xsd' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Diagnostics Extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name of Cloud Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RolesAppliedTo +Roles applied to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountKey +Storage Account Key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +Name of the Storage Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subscription +Subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.Extension + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/New-AzCloudServiceExtensionObject.md b/azps-10.1.0/Az.CloudService/New-AzCloudServiceExtensionObject.md new file mode 100644 index 0000000000..ca7c30678b --- /dev/null +++ b/azps-10.1.0/Az.CloudService/New-AzCloudServiceExtensionObject.md @@ -0,0 +1,172 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/new-azcloudserviceextensionobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceExtensionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceExtensionObject.md +--- + +# New-AzCloudServiceExtensionObject + +## SYNOPSIS +Create a in-memory object for Extension + +## SYNTAX + +``` +New-AzCloudServiceExtensionObject [-AutoUpgradeMinorVersion ] [-Name ] + [-ProtectedSetting ] [-Publisher ] [-RolesAppliedTo ] [-Setting ] + [-Type ] [-TypeHandlerVersion ] [] +``` + +## DESCRIPTION +Create a in-memory object for Extension + +## EXAMPLES + +### Example 1: Create Geneva extension object +```powershell +$extension = New-AzCloudServiceExtensionObject -Name "GenevaExtension" -Publisher "Microsoft.Azure.Geneva" -Type "GenevaMonitoringPaaS" -TypeHandlerVersion "2.14.0.2" +``` + +This command creates Geneva extension object which is used for creating or updating a cloud service. +For more details see New-AzCloudService. + +## PARAMETERS + +### -AutoUpgradeMinorVersion +Explicitly specify whether CRP can automatically upgrade typeHandlerVersion to higher minor versions when they become available. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectedSetting +Protected settings for the extension which are encrypted before sent to the VM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Publisher +Publisher. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RolesAppliedTo +RolesAppliedTo. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Setting +Public settings for the extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +TypeHandlerVersion. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.Extension + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/New-AzCloudServiceLoadBalancerConfigurationObject.md b/azps-10.1.0/Az.CloudService/New-AzCloudServiceLoadBalancerConfigurationObject.md new file mode 100644 index 0000000000..c70b1b4161 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/New-AzCloudServiceLoadBalancerConfigurationObject.md @@ -0,0 +1,95 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/new-azcloudserviceloadbalancerconfigurationobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceLoadBalancerConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceLoadBalancerConfigurationObject.md +--- + +# New-AzCloudServiceLoadBalancerConfigurationObject + +## SYNOPSIS +Create a in-memory object for LoadBalancerConfiguration + +## SYNTAX + +``` +New-AzCloudServiceLoadBalancerConfigurationObject + [-FrontendIPConfiguration ] [-Name ] [] +``` + +## DESCRIPTION +Create a in-memory object for LoadBalancerConfiguration + +## EXAMPLES + +### Example 1: Create load balancer configuration object +```powershell +$publicIP = Get-AzPublicIpAddress -ResourceGroupName 'ContosoOrg' -Name 'ContosoPublicIP' +$feIpConfig = New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject -Name 'ContosoFe' -PublicIPAddressId $publicIP.Id +$loadBalancerConfig = New-AzCloudServiceLoadBalancerConfigurationObject -Name 'ContosoLB' -FrontendIPConfiguration $feIpConfig +``` + +This command creates load balancer configuration object which is used for creating or updating a cloud service. +For more details see New-AzCloudService. + +## PARAMETERS + +### -FrontendIPConfiguration +FrontendIPConfiguration. +To construct, see NOTES section for FRONTENDIPCONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ILoadBalancerFrontendIPConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of LoadBalancerConfiguration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.LoadBalancerConfiguration + +## 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. + + +`FRONTENDIPCONFIGURATION `: FrontendIPConfiguration. + - `Name `: The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. + - `[PrivateIPAddress ]`: The virtual network private IP address of the IP configuration. + - `[PublicIPAddressId ]`: Resource Id + - `[SubnetId ]`: Resource Id + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject.md b/azps-10.1.0/Az.CloudService/New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject.md new file mode 100644 index 0000000000..6687670d31 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject.md @@ -0,0 +1,131 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/new-azcloudserviceloadbalancerfrontendipconfigurationobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject.md +--- + +# New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject + +## SYNOPSIS +Create a in-memory object for LoadBalancerFrontendIPConfiguration + +## SYNTAX + +### DefaultParameterSet (Default) +``` +New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject [-Name ] [-PublicIPAddressId ] + [] +``` + +### PrivateIP +``` +New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject [-Name ] [-PrivateIPAddress ] + [-SubnetId ] [] +``` + +## DESCRIPTION +Create a in-memory object for LoadBalancerFrontendIPConfiguration + +## EXAMPLES + +### Example 1: Create load balancer frontend IP configuration object +```powershell +$publicIP = Get-AzPublicIpAddress -ResourceGroupName 'ContosoOrg' -Name 'ContosoPublicIP' +$feIpConfig = New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject -Name 'ContosoFe' -PublicIPAddressId $publicIp.Id +$loadBalancerConfig = New-AzCloudServiceLoadBalancerConfigurationObject -Name 'ContosoLB' -FrontendIPConfiguration $feIpConfig +``` + +This command creates load balancer frontend IP configuration object which is used for creating or updating a cloud service. +For more details see New-AzCloudService. + +### Example 2: Create load balancer frontend IP configuration object with Private ID address +```powershell +# Create role profile object +$subnet = New-AzVirtualNetworkSubnetConfig -Name "WebTier" -AddressPrefix "10.0.0.0/24" -WarningAction SilentlyContinue +$feIpConfig = New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject -Name 'ContosoFe' -privateIPAddress '10.0.0.6' -subnetId $Subnet.Id +$loadBalancerConfig = New-AzCloudServiceLoadBalancerConfigurationObject -Name 'ContosoLB' -FrontendIPConfiguration $feIpConfig + +``` + +This command creates load balancer frontend IP configuration object with a Private IP address + +## PARAMETERS + +### -Name +Name of FrontendIpConfigration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIPAddress +Private IP Address + +```yaml +Type: System.String +Parameter Sets: PrivateIP +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIPAddressId +Resource Id. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Subnet ID + +```yaml +Type: System.String +Parameter Sets: PrivateIP +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.LoadBalancerFrontendIPConfiguration + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/New-AzCloudServiceRemoteDesktopExtensionObject.md b/azps-10.1.0/Az.CloudService/New-AzCloudServiceRemoteDesktopExtensionObject.md new file mode 100644 index 0000000000..d0542408f7 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/New-AzCloudServiceRemoteDesktopExtensionObject.md @@ -0,0 +1,144 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/new-azcloudserviceremotedesktopextensionobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceRemoteDesktopExtensionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceRemoteDesktopExtensionObject.md +--- + +# New-AzCloudServiceRemoteDesktopExtensionObject + +## SYNOPSIS +Create a in-memory object for Remote Desktop Extension + +## SYNTAX + +``` +New-AzCloudServiceRemoteDesktopExtensionObject [-Name] [-Credential] + [[-Expiration] ] [[-TypeHandlerVersion] ] [[-RolesAppliedTo] ] + [[-AutoUpgradeMinorVersion] ] [] +``` + +## DESCRIPTION +Create a in-memory object for Remote Desktop Extension + +## EXAMPLES + +### Example 1: Create remote desktop extension object +```powershell +$credential = Get-Credential +$expiration = (Get-Date).AddYears(1) +$extension = New-AzCloudServiceRemoteDesktopExtensionObject -Name 'RDPExtension' -Credential $credential -Expiration $expiration -TypeHandlerVersion '1.2.1' +``` + +This command creates remote desktop extension object which is used for creating or updating a cloud service. +For more details see New-AzCloudService. + +## PARAMETERS + +### -AutoUpgradeMinorVersion +Auto upgrade minor version. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Credential for Remote Desktop Extension. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expiration +Expiration for Remote Desktop Extension. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Remote Desktop Extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RolesAppliedTo +Roles applied to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Remote Desktop Extension version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.Extension + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/New-AzCloudServiceRoleProfilePropertiesObject.md b/azps-10.1.0/Az.CloudService/New-AzCloudServiceRoleProfilePropertiesObject.md new file mode 100644 index 0000000000..3da4dfbeb6 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/New-AzCloudServiceRoleProfilePropertiesObject.md @@ -0,0 +1,111 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/new-azcloudserviceroleprofilepropertiesobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceRoleProfilePropertiesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceRoleProfilePropertiesObject.md +--- + +# New-AzCloudServiceRoleProfilePropertiesObject + +## SYNOPSIS +Create a in-memory object for CloudServiceRoleProfileProperties + +## SYNTAX + +``` +New-AzCloudServiceRoleProfilePropertiesObject [-Name ] [-SkuCapacity ] [-SkuName ] + [-SkuTier ] [] +``` + +## DESCRIPTION +Create a in-memory object for CloudServiceRoleProfileProperties + +## EXAMPLES + +### Example 1: Create role profile properties object +```powershell +$role = New-AzCloudServiceRoleProfilePropertiesObject -Name 'WebRole' -SkuName 'Standard_D1_v2' -SkuTier 'Standard' -SkuCapacity 2 +``` + +This command creates role profile properties object which is used for creating or updating a cloud service. +For more details see New-AzCloudService. + +## PARAMETERS + +### -Name +Name of role profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Specifies the number of role instances in the cloud service. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The sku name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +SkuTier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.CloudServiceRoleProfileProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/New-AzCloudServiceVaultSecretGroupObject.md b/azps-10.1.0/Az.CloudService/New-AzCloudServiceVaultSecretGroupObject.md new file mode 100644 index 0000000000..d084b471ca --- /dev/null +++ b/azps-10.1.0/Az.CloudService/New-AzCloudServiceVaultSecretGroupObject.md @@ -0,0 +1,82 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/new-azcloudservicevaultsecretgroupobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceVaultSecretGroupObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/New-AzCloudServiceVaultSecretGroupObject.md +--- + +# New-AzCloudServiceVaultSecretGroupObject + +## SYNOPSIS +Create a in-memory object for Vault Secret Group + +## SYNTAX + +``` +New-AzCloudServiceVaultSecretGroupObject [-CertificateUrl ] [-Id ] [] +``` + +## DESCRIPTION +Create a in-memory object for Secret Group + +## EXAMPLES + +### Example 1: Create vault secret group object +```powershell +$keyVault = Get-AzKeyVault -VaultName 'ContosoKeyVault' +$certificate = Get-AzKeyVaultCertificate -VaultName 'ContosoKeyVault' -Name 'ContosoCert' +$secretGroup = New-AzCloudServiceVaultSecretGroupObject -Id $keyVault.ResourceId -CertificateUrl $certificate.SecretId +``` + +This command creates vault secret group object which is used for creating or updating a cloud service. +For more details see New-AzCloudService. + +## PARAMETERS + +### -CertificateUrl +This is the URL of a certificate that has been uploaded to Key Vault as a secret. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Key Vault Resource Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.CloudServiceVaultSecretGroup + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Remove-AzCloudService.md b/azps-10.1.0/Az.CloudService/Remove-AzCloudService.md new file mode 100644 index 0000000000..18f2fd7c92 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Remove-AzCloudService.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/remove-azcloudservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Remove-AzCloudService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Remove-AzCloudService.md +--- + +# Remove-AzCloudService + +## SYNOPSIS +Deletes a cloud service. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCloudService -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzCloudService -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a cloud service. + +## EXAMPLES + +### Example 1: Remove a cloud service +```powershell +Remove-AzCloudService -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" +``` + +This command removes the cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CloudServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Remove-AzCloudServiceRoleInstance.md b/azps-10.1.0/Az.CloudService/Remove-AzCloudServiceRoleInstance.md new file mode 100644 index 0000000000..0c59cd1f7a --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Remove-AzCloudServiceRoleInstance.md @@ -0,0 +1,249 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/remove-azcloudserviceroleinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Remove-AzCloudServiceRoleInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Remove-AzCloudServiceRoleInstance.md +--- + +# Remove-AzCloudServiceRoleInstance + +## SYNOPSIS +Deletes role instances in a cloud service. + +## SYNTAX + +### DeleteExpanded (Default) +``` +Remove-AzCloudServiceRoleInstance -CloudServiceName -ResourceGroupName + -RoleInstance [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityExpanded +``` +Remove-AzCloudServiceRoleInstance -InputObject -RoleInstance + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes role instances in a cloud service. + +## EXAMPLES + +### Example 1: Remove a cloud service role instance +```powershell +Remove-AzCloudServiceRoleInstance -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstance "ContosoFrontEnd_IN_0" +``` + +This command removes the role instance named ContosoFrontEnd_IN_0 of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServiceName +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: DeleteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: DeleteViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DeleteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleInstance +List of cloud service role instance names. +Value of '*' will signify all role instances of the cloud service. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: DeleteExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Restart-AzCloudService.md b/azps-10.1.0/Az.CloudService/Restart-AzCloudService.md new file mode 100644 index 0000000000..90d32039d6 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Restart-AzCloudService.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/restart-azcloudservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Restart-AzCloudService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Restart-AzCloudService.md +--- + +# Restart-AzCloudService + +## SYNOPSIS +Restarts one or more role instances in a cloud service. + +## SYNTAX + +### RestartExpanded (Default) +``` +Restart-AzCloudService -Name -ResourceGroupName -RoleInstance + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### RestartViaIdentityExpanded +``` +Restart-AzCloudService -InputObject -RoleInstance + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Restarts one or more role instances in a cloud service. + +## EXAMPLES + +### Example 1: Restart role instances of cloud service +```powershell +$roleInstances = @("ContosoFrontEnd_IN_0", "ContosoBackEnd_IN_1") +Restart-AzCloudService -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstance $roleInstances +``` + +This command restarts 2 role instances ContosoFrontEnd_IN_0 and ContosoBackEnd_IN_1 of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +### Example 2: Restart all roles of cloud service +```powershell +Restart-AzCloudService -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstance "*" +``` + +This command restarts all role instances of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: RestartViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: RestartExpanded +Aliases: CloudServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: RestartExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleInstance +List of cloud service role instance names. +Value of '*' will signify all role instances of the cloud service. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: RestartExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Restart-AzCloudServiceRoleInstance.md b/azps-10.1.0/Az.CloudService/Restart-AzCloudServiceRoleInstance.md new file mode 100644 index 0000000000..7b8696a253 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Restart-AzCloudServiceRoleInstance.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/restart-azcloudserviceroleinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Restart-AzCloudServiceRoleInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Restart-AzCloudServiceRoleInstance.md +--- + +# Restart-AzCloudServiceRoleInstance + +## SYNOPSIS +The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service. + +## SYNTAX + +### Restart (Default) +``` +Restart-AzCloudServiceRoleInstance -CloudServiceName -ResourceGroupName + -RoleInstanceName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### RestartViaIdentity +``` +Restart-AzCloudServiceRoleInstance -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service. + +## EXAMPLES + +### Example 1: Restart role instance of a cloud service +```powershell +Restart-AzCloudServiceRoleInstance -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" -RoleInstanceName "ContosoFrontEnd_IN_0" +``` + +This command restarts role instance named ContosoFrontEnd_IN_0 of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServiceName +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleInstanceName +Name of the role instance. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Set-AzCloudServiceUpdateDomain.md b/azps-10.1.0/Az.CloudService/Set-AzCloudServiceUpdateDomain.md new file mode 100644 index 0000000000..e4eb98541f --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Set-AzCloudServiceUpdateDomain.md @@ -0,0 +1,204 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/set-azcloudserviceupdatedomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Set-AzCloudServiceUpdateDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Set-AzCloudServiceUpdateDomain.md +--- + +# Set-AzCloudServiceUpdateDomain + +## SYNOPSIS +Updates the role instances in the specified update domain. + +## SYNTAX + +``` +Set-AzCloudServiceUpdateDomain -CloudServiceName -ResourceGroupName -UpdateDomain + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Updates the role instances in the specified update domain. + +## EXAMPLES + +### Example 1: Update role instance in update domain +```powershell +Set-AzCloudServiceUpdateDomain -CloudServiceName "ContosoCS" -ResourceGroupName "ContosOrg" -UpdateDomain 0 +``` + +This command updates role instances in update domain 0 of cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServiceName +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateDomain +Specifies an integer value that identifies the update domain. +Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Start-AzCloudService.md b/azps-10.1.0/Az.CloudService/Start-AzCloudService.md new file mode 100644 index 0000000000..b4e05c5917 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Start-AzCloudService.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/start-azcloudservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Start-AzCloudService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Start-AzCloudService.md +--- + +# Start-AzCloudService + +## SYNOPSIS +Starts the cloud service. + +## SYNTAX + +### Start (Default) +``` +Start-AzCloudService -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StartViaIdentity +``` +Start-AzCloudService -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Starts the cloud service. + +## EXAMPLES + +### Example 1: Start cloud service +```powershell +Start-AzCloudService -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" +``` + +This command starts all the role instances that belong to the the cloud service named ContosoCS. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: CloudServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Stop-AzCloudService.md b/azps-10.1.0/Az.CloudService/Stop-AzCloudService.md new file mode 100644 index 0000000000..87834f791e --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Stop-AzCloudService.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/stop-azcloudservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Stop-AzCloudService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Stop-AzCloudService.md +--- + +# Stop-AzCloudService + +## SYNOPSIS +Power off the cloud service. +Note that resources are still attached and you are getting charged for the resources. + +## SYNTAX + +### PowerOff (Default) +``` +Stop-AzCloudService -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### PowerOffViaIdentity +``` +Stop-AzCloudService -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Power off the cloud service. +Note that resources are still attached and you are getting charged for the resources. + +## EXAMPLES + +### Example 1: Stop cloud service +```powershell +Stop-AzCloudService -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" +``` + +This command stops all the role instances that belong to the the cloud service named ContosoCS. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: PowerOffViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the cloud service. + +```yaml +Type: System.String +Parameter Sets: PowerOff +Aliases: CloudServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PowerOff +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: PowerOff +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT `: Identity Parameter + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Switch-AzCloudService.md b/azps-10.1.0/Az.CloudService/Switch-AzCloudService.md new file mode 100644 index 0000000000..8719386544 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Switch-AzCloudService.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/Switch-AzCloudService +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Switch-AzCloudService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Switch-AzCloudService.md +--- + +# Switch-AzCloudService + +## SYNOPSIS +Swaps VIPs between two cloud service (extended support) load balancers. + +## SYNTAX + +### CloudServiceName (Default) +``` +Switch-AzCloudService -CloudServiceName -ResourceGroupName [-SubscriptionId ] + [-Async] [-DefaultProfile ] [-AsJob] [-Confirm] [-WhatIf] [] +``` + +### CloudService +``` +Switch-AzCloudService -CloudService [-SubscriptionId ] [-Async] + [-DefaultProfile ] [-AsJob] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Swaps VIPs between two cloud service (extended support) load balancers. + +## EXAMPLES + +### Example 1: Switch cloud service using name +```powershell +Switch-AzCloudService -ResourceGroupName "BRGThree" -CloudServiceName BService -SubscriptionId 1133e0eb-b53c-1234-b478-2eac8f04afca +``` + +Above command invokes the vipswap operation on the Cloud service with name 'BService' and will perform the operation once the user confirms the action on the confirmation prompt. +'BService' with be swapped with its swappable cloud service. + +### Example 2: Switch cloud service using cloud service object +```powershell +$cs = Get-AzCloudService -ResourceGroupName "BRGThree" -CloudServiceName BService -SubscriptionId 1133e0eb-b53c-1234-b478-2eac8f04afca +Switch-AzCloudService -CloudService $cs +``` + +Above command invokes the vipswap operation on the Cloud service with name 'BService' and will perform the operation once the user confirms the action on the confirmation prompt. +'BService' with be swapped with its swappable cloud service. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Async + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudService +To construct, see NOTES section for CLOUDSERVICE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.CloudService +Parameter Sets: CloudService +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServiceName + + +```yaml +Type: System.String +Parameter Sets: CloudServiceName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: CloudServiceName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`CLOUDSERVICE `: + - `Location `: Resource location. + - `[AllowModelOverride ]`: (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively. The default value is `false`. + - `[Configuration ]`: Specifies the XML service configuration (.cscfg) for the cloud service. + - `[ConfigurationUrl ]`: Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls. + - `[ExtensionProfile ]`: Describes a cloud service extension profile. + - `[Extension ]`: List of extensions for the cloud service. + - `[AutoUpgradeMinorVersion ]`: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. + - `[ForceUpdateTag ]`: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not + - `[Name ]`: The name of the extension. + - `[ProtectedSetting ]`: Protected settings for the extension which are encrypted before sent to the role instance. + - `[ProtectedSettingFromKeyVaultSecretUrl ]`: Secret URL which contains the protected settings of the extension + - `[Publisher ]`: The name of the extension handler publisher. + - `[RolesAppliedTo ]`: Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service. + - `[Setting ]`: Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension. + - `[SourceVaultId ]`: Resource Id + - `[Type ]`: Specifies the type of the extension. + - `[TypeHandlerVersion ]`: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance. + - `[NetworkProfile ]`: Network Profile for the cloud service. + - `[LoadBalancerConfiguration ]`: List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer. + - `FrontendIPConfiguration `: Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration. + - `Name `: The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. + - `[PrivateIPAddress ]`: The virtual network private IP address of the IP configuration. + - `[PublicIPAddressId ]`: Resource Id + - `[SubnetId ]`: Resource Id + - `Name `: The name of the Load balancer + - `[Id ]`: Resource Id + - `[SlotType ]`: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. + - `[SwappableCloudService ]`: The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown. + - `[Id ]`: Resource Id + - `[OSProfile ]`: Describes the OS profile for the cloud service. + - `[Secret ]`: Specifies set of certificates that should be installed onto the role instances. + - `[SourceVaultId ]`: Resource Id + - `[VaultCertificate ]`: The list of key vault references in SourceVault which contain certificates. + - `[CertificateUrl ]`: This is the URL of a certificate that has been uploaded to Key Vault as a secret. + - `[PackageUrl ]`: Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls. + - `[RoleProfile ]`: Describes the role profile for the cloud service. + - `[Role ]`: List of roles for the cloud service. + - `[Name ]`: Resource name. + - `[SkuCapacity ]`: Specifies the number of role instances in the cloud service. + - `[SkuName ]`: The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku. + - `[SkuTier ]`: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** + - `[StartCloudService ]`: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`. If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff. + - `[Tag ]`: Resource tags. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[UpgradeMode ]`: Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains. Possible Values are

**Auto**

**Manual**

**Simultaneous**

If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence. + - `[Zone ]`: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CloudService/Update-AzCloudService.md b/azps-10.1.0/Az.CloudService/Update-AzCloudService.md new file mode 100644 index 0000000000..509d3db034 --- /dev/null +++ b/azps-10.1.0/Az.CloudService/Update-AzCloudService.md @@ -0,0 +1,284 @@ +--- +external help file: +Module Name: Az.CloudService +online version: https://learn.microsoft.com/powershell/module/az.cloudservice/update-azcloudservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Update-AzCloudService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CloudService/help/Update-AzCloudService.md +--- + +# Update-AzCloudService + +## SYNOPSIS +Create or update a cloud service. +Please note some properties can be set only during cloud service creation. + +## SYNTAX + +``` +Update-AzCloudService -InputObject -Parameter + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create or update a cloud service. +Please note some properties can be set only during cloud service creation. + +## EXAMPLES + +### Example 1: Add RDP extension to existing cloud service +```powershell +# Create RDP extension object +$rdpExtension = New-AzCloudServiceRemoteDesktopExtensionObject -Name "RDPExtension" -Credential $credential -Expiration $expiration -TypeHandlerVersion "1.2.1" +# Get existing cloud service +$cloudService = Get-AzCloudService -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" +# Add RDP extension to existing cloud service extension object +$cloudService.ExtensionProfile.Extension = $cloudService.ExtensionProfile.Extension + $rdpExtension +# Update cloud service +$cloudService | Update-AzCloudService +``` + +Above set of commands adds a RDP extension to already existing cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +### Example 2: Remove all extensions from cloud service +```powershell +# Get existing cloud service +$cloudService = Get-AzCloudService -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" +# Set extension to empty list +$cloudService.ExtensionProfile.Extension = @() +# Update cloud service +$cloudService | Update-AzCloudService +``` + +Above set of commands removes all extensions from existing cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +### Example 3: Remove RDP extension from cloud service +```powershell +# Get existing cloud service +$cloudService = Get-AzCloudService -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" +# Remove extension by name RDPExtension +$cloudService.ExtensionProfile.Extension = $cloudService.ExtensionProfile.Extension | Where-Object { $_.Name -ne "RDPExtension" } +# Update cloud service +$cloudService | Update-AzCloudService +``` + +Above set of commands removes RDP extension from existing cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +### Example 4: Scale-Out / Scale-In role instances +```powershell +# Get existing cloud service +$cloudService = Get-AzCloudService -ResourceGroupName "ContosOrg" -CloudServiceName "ContosoCS" + +# Scale-out all role instance count by 1 +$cloudService.RoleProfile.Role | ForEach-Object {$_.SkuCapacity += 1} + +# Scale-in ContosoFrontend role instance count by 1 +$role = $cloudService.RoleProfile.Role | Where-Object {$_.Name -eq "ContosoFrontend"} +$role.SkuCapacity -= 1 + +# Update cloud service configuration as per the new role instance count +$cloudService.Configuration = $configuration + +# Update cloud service +$cloudService | Update-AzCloudService +``` + +Above set of commands shows how to scale-out and scale-in role instance count for cloud service named ContosoCS that belongs to the resource group named ContosOrg. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Describes the cloud service. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudService +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudService + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.ICloudServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ICloudService + +## 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 + - `[CloudServiceName ]`: Name of the cloud service. + - `[IPConfigurationName ]`: The IP configuration name. + - `[Id ]`: Resource identity path + - `[Location ]`: Name of the location that the OS version pertains to. + - `[NetworkInterfaceName ]`: The name of the network interface. + - `[OSFamilyName ]`: Name of the OS family. + - `[OSVersionName ]`: Name of the OS version. + - `[PublicIPAddressName ]`: The name of the public IP Address. + - `[ResourceGroupName ]`: Name of the resource group. + - `[RoleInstanceName ]`: Name of the role instance. + - `[RoleName ]`: Name of the role. + - `[SubscriptionId ]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[UpdateDomain ]`: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. + +`PARAMETER `: Describes the cloud service. + - `Location `: Resource location. + - `[AllowModelOverride ]`: (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively. The default value is `false`. + - `[Configuration ]`: Specifies the XML service configuration (.cscfg) for the cloud service. + - `[ConfigurationUrl ]`: Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls. + - `[ExtensionProfile ]`: Describes a cloud service extension profile. + - `[Extension ]`: List of extensions for the cloud service. + - `[AutoUpgradeMinorVersion ]`: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. + - `[ForceUpdateTag ]`: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not + - `[Name ]`: The name of the extension. + - `[ProtectedSetting ]`: Protected settings for the extension which are encrypted before sent to the role instance. + - `[ProtectedSettingFromKeyVaultSecretUrl ]`: Secret URL which contains the protected settings of the extension + - `[Publisher ]`: The name of the extension handler publisher. + - `[RolesAppliedTo ]`: Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service. + - `[Setting ]`: Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension. + - `[SourceVaultId ]`: Resource Id + - `[Type ]`: Specifies the type of the extension. + - `[TypeHandlerVersion ]`: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance. + - `[NetworkProfile ]`: Network Profile for the cloud service. + - `[LoadBalancerConfiguration ]`: List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer. + - `FrontendIPConfiguration `: Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration. + - `Name `: The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. + - `[PrivateIPAddress ]`: The virtual network private IP address of the IP configuration. + - `[PublicIPAddressId ]`: Resource Id + - `[SubnetId ]`: Resource Id + - `Name `: The name of the Load balancer + - `[Id ]`: Resource Id + - `[SlotType ]`: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. + - `[SwappableCloudService ]`: The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown. + - `[Id ]`: Resource Id + - `[OSProfile ]`: Describes the OS profile for the cloud service. + - `[Secret ]`: Specifies set of certificates that should be installed onto the role instances. + - `[SourceVaultId ]`: Resource Id + - `[VaultCertificate ]`: The list of key vault references in SourceVault which contain certificates. + - `[CertificateUrl ]`: This is the URL of a certificate that has been uploaded to Key Vault as a secret. + - `[PackageUrl ]`: Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls. + - `[RoleProfile ]`: Describes the role profile for the cloud service. + - `[Role ]`: List of roles for the cloud service. + - `[Name ]`: Resource name. + - `[SkuCapacity ]`: Specifies the number of role instances in the cloud service. + - `[SkuName ]`: The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku. + - `[SkuTier ]`: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** + - `[StartCloudService ]`: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`. If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff. + - `[Tag ]`: Resource tags. + - `[(Any) ]`: This indicates any property can be added to this object. + - `[UpgradeMode ]`: Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains. Possible Values are

**Auto**

**Manual**

**Simultaneous**

If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence. + - `[Zone ]`: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CognitiveServices/Add-AzCognitiveServicesAccountNetworkRule.md b/azps-10.1.0/Az.CognitiveServices/Add-AzCognitiveServicesAccountNetworkRule.md new file mode 100644 index 0000000000..53c56c4680 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Add-AzCognitiveServicesAccountNetworkRule.md @@ -0,0 +1,236 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/add-azcognitiveservicesaccountnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Add-AzCognitiveServicesAccountNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Add-AzCognitiveServicesAccountNetworkRule.md +--- + +# Add-AzCognitiveServicesAccountNetworkRule + +## SYNOPSIS +Add IpRules or VirtualNetworkRules to the NetworkRule property of a Cognitive Services account + +## SYNTAX + +### NetWorkRuleString (Default) +``` +Add-AzCognitiveServicesAccountNetworkRule [-ResourceGroupName] [-Name] + -VirtualNetworkResourceId [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### IpRuleObject +``` +Add-AzCognitiveServicesAccountNetworkRule [-ResourceGroupName] [-Name] -IpRule + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### NetworkRuleObject +``` +Add-AzCognitiveServicesAccountNetworkRule [-ResourceGroupName] [-Name] + -VirtualNetworkRule [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### IpRuleString +``` +Add-AzCognitiveServicesAccountNetworkRule [-ResourceGroupName] [-Name] + -IpAddressOrRange [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Add-AzCognitiveServicesAccountNetworkRule** cmdlet adds IpRules or VirtualNetworkRules to the NetworkRule property of a Cognitive Services account + +## EXAMPLES + +### Example 1: Add several IpRules with IpAddressOrRange +```powershell +Add-AzCognitiveServicesAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "myaccount" -IpAddressOrRange "200.0.0.0/24","28.2.0.0/16" +``` + +This command add several IpRules with IpAddressOrRange. + +### Example 2: Add a VirtualNetworkRule with VirtualNetworkResourceID +```powershell +$subnet = Get-AzVirtualNetwork -ResourceGroupName "myResourceGroup" -Name "myvirtualnetwork" | Get-AzVirtualNetworkSubnetConfig +Add-AzCognitiveServicesAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "myaccount" -VirtualNetworkResourceId $subnet[0].Id +``` + +This command add a VirtualNetworkRule with VirtualNetworkResourceID. + +### Example 3: Add VirtualNetworkRules with VirtualNetworkRule Objects from another account +```powershell +$networkrule = Get-AzCognitiveServicesAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "myaccount1" +Add-AzCognitiveServicesAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "myaccount2" -VirtualNetworkRule $networkrule.VirtualNetworkRules +``` + +This command add VirtualNetworkRules with VirtualNetworkRule Objects from another account. + +### Example 4: Add several IpRule with IpRule objects, input with JSON +```powershell +Add-AzCognitiveServicesAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "myaccount" -IpRule (@{IpAddressOrRange="200.0.0.0/24"},@{IpAddressOrRange="28.2.0.0/16"}) +``` + +This command add several IpRule with IpRule objects, input with JSON. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddressOrRange +Cognitive Services Account NetworkRule IpRules IpAddressOrRange in string. + +```yaml +Type: System.String[] +Parameter Sets: IpRuleString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpRule +Cognitive Services Account NetworkRule IpRules. + +```yaml +Type: Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSIpRule[] +Parameter Sets: IpRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkResourceId +Cognitive Services Account NetworkRule VirtualNetworkRules VirtualNetworkResourceId in string. + +```yaml +Type: System.String[] +Parameter Sets: NetWorkRuleString +Aliases: SubnetId, VirtualNetworkId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRule +Cognitive Services Account NetworkRule VirtualNetworkRules. + +```yaml +Type: Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSVirtualNetworkRule[] +Parameter Sets: NetworkRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSIpRule[] + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSVirtualNetworkRule[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSVirtualNetworkRule + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSIpRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/Az.CognitiveServices.md b/azps-10.1.0/Az.CognitiveServices/Az.CognitiveServices.md new file mode 100644 index 0000000000..98a82fd029 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Az.CognitiveServices.md @@ -0,0 +1,105 @@ +--- +Module Name: Az.CognitiveServices +Module Guid: 66c566b4-950c-4a2b-9f3b-199d92f0df1a +Download Help Link: https://learn.microsoft.com/powershell/module/az.cognitiveservices +Help Version: 0.9.4.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Az.CognitiveServices.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Az.CognitiveServices.md +--- + +# Az.CognitiveServices Module +## Description +This topic displays help topics for the Azure Cognitive Services cmdlets. + +## Az.CognitiveServices Cmdlets +### [Add-AzCognitiveServicesAccountNetworkRule](Add-AzCognitiveServicesAccountNetworkRule.md) +Add IpRules or VirtualNetworkRules to the NetworkRule property of a Cognitive Services account + +### [Get-AzCognitiveServicesAccount](Get-AzCognitiveServicesAccount.md) +Gets an account. + +### [Get-AzCognitiveServicesAccountCommitmentPlan](Get-AzCognitiveServicesAccountCommitmentPlan.md) +Get CommitmentPlan of a Cognitive Services account + +### [Get-AzCognitiveServicesAccountDeployment](Get-AzCognitiveServicesAccountDeployment.md) +Get Deployment of a Cognitive Services account + +### [Get-AzCognitiveServicesAccountKey](Get-AzCognitiveServicesAccountKey.md) +Gets the API keys for an account. + +### [Get-AzCognitiveServicesAccountModel](Get-AzCognitiveServicesAccountModel.md) +Get Models available for a Cognitive Services account + +### [Get-AzCognitiveServicesAccountNetworkRuleSet](Get-AzCognitiveServicesAccountNetworkRuleSet.md) +Get the NetworkRule property of a Cognitive Services account + +### [Get-AzCognitiveServicesAccountSku](Get-AzCognitiveServicesAccountSku.md) +Gets the available SKUs for an account. + +### [Get-AzCognitiveServicesAccountType](Get-AzCognitiveServicesAccountType.md) +Gets the available Cognitive Services Account Types. + +### [Get-AzCognitiveServicesAccountUsage](Get-AzCognitiveServicesAccountUsage.md) +Get current usages for a Cognitive Services account. + +### [Get-AzCognitiveServicesCommitmentPlan](Get-AzCognitiveServicesCommitmentPlan.md) +Get Cognitive Services Commitment Plan + +### [Get-AzCognitiveServicesCommitmentPlanAssociation](Get-AzCognitiveServicesCommitmentPlanAssociation.md) +Get Cognitive Services Commitment Plan Association + +### [Get-AzCognitiveServicesCommitmentTier](Get-AzCognitiveServicesCommitmentTier.md) +Get CommitmentTier of Cognitive Services + +### [New-AzCognitiveServicesAccount](New-AzCognitiveServicesAccount.md) +Creates a Cognitive Services account. + +### [New-AzCognitiveServicesAccountApiProperty](New-AzCognitiveServicesAccountApiProperty.md) +Generate a new instance of Cognitive Services Account ApiProperties + +### [New-AzCognitiveServicesAccountCommitmentPlan](New-AzCognitiveServicesAccountCommitmentPlan.md) +Create a CommitmentPlan for a Cognitive Services account + +### [New-AzCognitiveServicesAccountDeployment](New-AzCognitiveServicesAccountDeployment.md) +Create a Deployment for a Cognitive Services account + +### [New-AzCognitiveServicesAccountKey](New-AzCognitiveServicesAccountKey.md) +Regenerates an account key. + +### [New-AzCognitiveServicesCommitmentPlan](New-AzCognitiveServicesCommitmentPlan.md) +Create a Cognitive Services Commitment Plan + +### [New-AzCognitiveServicesCommitmentPlanAssociation](New-AzCognitiveServicesCommitmentPlanAssociation.md) +Create a Cognitive Services Commitment Plan Association + +### [New-AzCognitiveServicesObject](New-AzCognitiveServicesObject.md) +Create a Cognitive Services Object + +### [Remove-AzCognitiveServicesAccount](Remove-AzCognitiveServicesAccount.md) +Deletes a Cognitive Services account. + +### [Remove-AzCognitiveServicesAccountCommitmentPlan](Remove-AzCognitiveServicesAccountCommitmentPlan.md) +Delete a CommitmentPlan from a Cognitive Services account + +### [Remove-AzCognitiveServicesAccountDeployment](Remove-AzCognitiveServicesAccountDeployment.md) +Delete a Deployment from a Cognitive Services account + +### [Remove-AzCognitiveServicesAccountNetworkRule](Remove-AzCognitiveServicesAccountNetworkRule.md) +Remove IpRules or VirtualNetworkRules from the NetWorkRule property of a Cognitive Services account + +### [Remove-AzCognitiveServicesCommitmentPlan](Remove-AzCognitiveServicesCommitmentPlan.md) +Remove a Cognitive Services Commitment Plan + +### [Remove-AzCognitiveServicesCommitmentPlanAssociation](Remove-AzCognitiveServicesCommitmentPlanAssociation.md) +Remove a Cognitive Services Commitment Plan Association + +### [Set-AzCognitiveServicesAccount](Set-AzCognitiveServicesAccount.md) +Modifies an account. + +### [Undo-AzCognitiveServicesAccountRemoval](Undo-AzCognitiveServicesAccountRemoval.md) +Recover a deleted account. + +### [Update-AzCognitiveServicesAccountNetworkRuleSet](Update-AzCognitiveServicesAccountNetworkRuleSet.md) +Update the NetworkRule property of a Cognitive Services account + diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccount.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccount.md new file mode 100644 index 0000000000..c8974bfc1b --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccount.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +ms.assetid: 11D5BFDF-5E5D-46B2-9F9B-A0524EFA1B42 +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicesaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccount.md +--- + +# Get-AzCognitiveServicesAccount + +## SYNOPSIS +Gets an account. + +## SYNTAX + +### ResourceGroupParameterSet +``` +Get-AzCognitiveServicesAccount [[-ResourceGroupName] ] [-DefaultProfile ] + [] +``` + +### AccountNameParameterSet +``` +Get-AzCognitiveServicesAccount [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] +``` + +### GetDeletedAccountParameterSet +``` +Get-AzCognitiveServicesAccount [-ResourceGroupName] [-Name] [-Location] + [-InRemovedState] [-DefaultProfile ] [] +``` + +### ListDeletedAccountParameterSet +``` +Get-AzCognitiveServicesAccount [-InRemovedState] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzCognitiveServicesAccount** cmdlet gets the provisioned Cognitive Services accounts in the resource group specified by the *ResourceGroupName* parameter. +If you do not specify the *ResourceGroupName* parameter, this cmdlet gets all Cognitive Services accounts for the current subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis +``` + +```output +ResourceGroupName : cognitive-services-resource-group +AccountName : myluis +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.Cog + nitiveServices/accounts/myluis +Endpoint : https://westus.api.cognitive.microsoft.com/luis/v2.0 +Location : WESTUS +Sku : Microsoft.Azure.Management.CognitiveServices.Models.Sku +AccountType : LUIS +ResourceType : Microsoft.CognitiveServices/accounts +Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +ProvisioningState : Succeeded +CustomSubDomainName : +PublicNetworkAccess : Enabled +Identity : +Encryption : +UserOwnedStorage : +PrivateEndpointConnections : {} +ApiProperties : +Properties : Microsoft.Azure.Management.CognitiveServices.Models.AccountProperties +RestrictOutboundNetworkAccess : +AllowedFqdnList : +DisableLocalAuth : +NetworkRuleSet : +Capabilities : {DynamicThrottling, VirtualNetworks, Container} +Tags : +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InRemovedState +Specifies whether to only show the deleted accounts in the output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetDeletedAccountParameterSet, ListDeletedAccountParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Cognitive Services Account Location. + +```yaml +Type: System.String +Parameter Sets: GetDeletedAccountParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Cognitive Services account to get. + +```yaml +Type: System.String +Parameter Sets: AccountNameParameterSet, GetDeletedAccountParameterSet +Aliases: CognitiveServicesAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group the Cognitive Services account is assigned to. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: AccountNameParameterSet, GetDeletedAccountParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount + +## NOTES + +## RELATED LINKS + +[New-AzCognitiveServicesAccount](./New-AzCognitiveServicesAccount.md) + +[Remove-AzCognitiveServicesAccount](./Remove-AzCognitiveServicesAccount.md) + +[Set-AzCognitiveServicesAccount](./Set-AzCognitiveServicesAccount.md) + + diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountCommitmentPlan.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountCommitmentPlan.md new file mode 100644 index 0000000000..2041c2a006 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountCommitmentPlan.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicesaccountcommitmentplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountCommitmentPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountCommitmentPlan.md +--- + +# Get-AzCognitiveServicesAccountCommitmentPlan + +## SYNOPSIS +Get CommitmentPlan of a Cognitive Services account + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Get-AzCognitiveServicesAccountCommitmentPlan [[-ResourceGroupName] ] [-AccountName] + [[-Name] ] [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzCognitiveServicesAccountCommitmentPlan [-ResourceId] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get CommitmentPlan of a Cognitive Services account + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCognitiveServicesAccountCommitmentPlan -ResourceGroupName cognitive-services-resource-group -AccountName resource-name +``` + +```output +SystemData : Microsoft.Azure.Management.CognitiveServices.Models.SystemData +Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +Kind : +Sku : +Tags : +Location : +Properties : Microsoft.Azure.Management.CognitiveServices.Models.CommitmentPlanProperties +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.CognitiveServices/accounts/resource-name/commitmentplans/plan-name +Name : plan-name +Type : Microsoft.CognitiveServices/accounts/commitmentplans +``` + +Get CommitmentPlan of a Cognitive Services account + +## PARAMETERS + +### -AccountName +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: CognitiveServicesAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.CognitiveServices.Models.CommitmentPlan + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountDeployment.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountDeployment.md new file mode 100644 index 0000000000..df8707fb81 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountDeployment.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicesaccountdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountDeployment.md +--- + +# Get-AzCognitiveServicesAccountDeployment + +## SYNOPSIS +Get Deployment of a Cognitive Services account + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Get-AzCognitiveServicesAccountDeployment [[-ResourceGroupName] ] [-AccountName] + [[-Name] ] [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzCognitiveServicesAccountDeployment [-ResourceId] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get Deployment of a Cognitive Services account + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCognitiveServicesAccountDeployment -ResourceGroupName cognitive-services-resource-group -AccountName resource-name +``` + +```output +SystemData : Microsoft.Azure.Management.CognitiveServices.Models.SystemData +Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +Properties : Microsoft.Azure.Management.CognitiveServices.Models.DeploymentProperties +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName +Name : deploymentName +Type : Microsoft.CognitiveServices/accounts/deployments +``` + +Get Deployment of a Cognitive Services account + +## PARAMETERS + +### -AccountName +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: CognitiveServicesAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.CognitiveServices.Models.Deployment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountKey.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountKey.md new file mode 100644 index 0000000000..ef2205ba2e --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountKey.md @@ -0,0 +1,107 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +ms.assetid: 73B1EB7E-568E-44E8-993A-91678B7D8AEE +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicesaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountKey.md +--- + +# Get-AzCognitiveServicesAccountKey + +## SYNOPSIS +Gets the API keys for an account. + +## SYNTAX + +``` +Get-AzCognitiveServicesAccountKey [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzCognitiveServicesAccountKey** cmdlet gets the API keys for a provisioned Cognitive Services account. +A Cognitive Services account has two API keys: Key1 and Key2. +The keys enable interaction with the Cognitive Services account endpoint. +Use New-AzCognitiveServicesAccountKey to regenerate a key. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCognitiveServicesAccountKey -ResourceGroupName cognitive-services-resource-group -name myluis +``` + +```output +Key1 Key2 +---- ---- +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the account. +This cmdlet gets the keys for this account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group the account is assigned to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccountKeys + +## NOTES + +## RELATED LINKS + +[New-AzCognitiveServicesAccountKey](./New-AzCognitiveServicesAccountKey.md) + + diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountModel.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountModel.md new file mode 100644 index 0000000000..e34057bd55 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountModel.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicesaccountmodel +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountModel.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountModel.md +--- + +# Get-AzCognitiveServicesAccountModel + +## SYNOPSIS +Get Models available for a Cognitive Services account + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Get-AzCognitiveServicesAccountModel [[-ResourceGroupName] ] [-AccountName] + [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzCognitiveServicesAccountModel [-ResourceId] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get Models available for a Cognitive Services account + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCognitiveServicesAccountModel -ResourceGroupName cognitive-services-resource-group -AccountName resource-name +``` + +```output +BaseModel : +MaxCapacity : 3 +Capabilities : {[fineTune, true]} +Deprecation : Microsoft.Azure.Management.CognitiveServices.Models.ModelDeprecationInfo +SystemData : Microsoft.Azure.Management.CognitiveServices.Models.SystemData +Format : OpenAI +Name : ada +Version : 1 + +BaseModel : +MaxCapacity : 3 +Capabilities : {[fineTune, true]} +Deprecation : Microsoft.Azure.Management.CognitiveServices.Models.ModelDeprecationInfo +SystemData : Microsoft.Azure.Management.CognitiveServices.Models.SystemData +Format : OpenAI +Name : davinci +Version : 1 +``` + +Get Models available for a Cognitive Services account + +## PARAMETERS + +### -AccountName +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: CognitiveServicesAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.CognitiveServices.Models.AccountModel + +## NOTES + +## RELATED LINKS + +[New-AzCognitiveServicesAccountDeployment](./New-AzCognitiveServicesAccountDeployment.md) diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountNetworkRuleSet.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountNetworkRuleSet.md new file mode 100644 index 0000000000..5f4eb2b386 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountNetworkRuleSet.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicesaccountnetworkruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountNetworkRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountNetworkRuleSet.md +--- + +# Get-AzCognitiveServicesAccountNetworkRuleSet + +## SYNOPSIS +Get the NetworkRule property of a Cognitive Services account + +## SYNTAX + +``` +Get-AzCognitiveServicesAccountNetworkRuleSet [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzCognitiveServicesAccountNetworkRuleSet** cmdlet gets the NetworkRule property of a Cognitive Services account + +## EXAMPLES + +### Example 1: Get NetworkRule property of a specified Cognitive Services account +```powershell +Get-AzCognitiveServicesAccountNetworkRuleSet -ResourceGroupName "rg1" -Name "myaccount" +``` + +This command gets NetworkRule property of a specified Cognitive Services account + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSNetworkRuleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountSku.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountSku.md new file mode 100644 index 0000000000..801160dab8 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountSku.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +ms.assetid: 386F09F0-2EEC-4B55-825C-F2E88D3B60AA +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicesaccountsku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountSku.md +--- + +# Get-AzCognitiveServicesAccountSku + +## SYNOPSIS +Gets the available SKUs for an account. + +## SYNTAX + +``` +Get-AzCognitiveServicesAccountSku [-Type ] [-Location ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Get-AzCognitiveServicesAccountSku** cmdlet gets the available SKUs for a Cognitive Services account. +The SKU is the tier plan for an account. +It defines the price, call limit, and rate for the account. +The F0 SKU is a free tier. +Paid tiers include S0, S1, S2, and so on. + +## EXAMPLES + +### Example 1 +```powershell +(Get-AzCognitiveServicesAccountSku -Type 'TextAnalytics' -Location "westus").Value | Select-Object -ExpandProperty Sku; +``` + +```output +Name Tier +---- ---- +F0 Free +S0 Standard +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Cognitive Services Account Location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Cognitive Services Account Type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountType, AccountType, Kind + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.CognitiveServices.Models.ResourceSku + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountType.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountType.md new file mode 100644 index 0000000000..89ec5fdd86 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountType.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicesaccounttype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountType.md +--- + +# Get-AzCognitiveServicesAccountType + +## SYNOPSIS +Gets the available Cognitive Services Account Types. + +## SYNTAX + +### GetAccountTypes (Default) +``` +Get-AzCognitiveServicesAccountType [-Location ] [-DefaultProfile ] + [] +``` + +### GetAccountTypeWithName +``` +Get-AzCognitiveServicesAccountType -TypeName [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzCognitiveServicesAccountType** cmdlet gets the available Cognitive Services Account Types under this subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCognitiveServicesAccountType +``` + +```output +CognitiveServices +ComputerVision +Face +FormRecognizer +LUIS +``` + +Get the list of available Types. + +### Example 2 +```powershell +Get-AzCognitiveServicesAccountType -Location westus +``` + +```output +CognitiveServices +ComputerVision +Face +FormRecognizer +LUIS +``` + +Get the list of available Types in westus. + +### Example 3 +```powershell +Get-AzCognitiveServicesAccountType -TypeName Face +``` + +```output +Face +``` + +Check if `Face` is a valid Type name, the name will be returned if it is a valid name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Cognitive Services Account Location. + +```yaml +Type: System.String +Parameter Sets: GetAccountTypes +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TypeName +Cognitive Services Account Type Name. + +```yaml +Type: System.String +Parameter Sets: GetAccountTypeWithName +Aliases: CognitiveServicesAccountTypeName, AccountTypeName, KindName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String[] + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountUsage.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountUsage.md new file mode 100644 index 0000000000..5351d52b19 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesAccountUsage.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicesaccountusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountUsage.md +--- + +# Get-AzCognitiveServicesAccountUsage + +## SYNOPSIS +Get current usages for a Cognitive Services account. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Get-AzCognitiveServicesAccountUsage [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] +``` + +### InputObjectParameterSet +``` +Get-AzCognitiveServicesAccountUsage [-InputObject] + [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzCognitiveServicesAccountUsage [-ResourceId] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +The **Get-AzCognitiveServicesAccountUsage** cmdlet gets current usages for a Cognitive Services account. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCognitiveServicesAccountUsage -ResourceGroupName TestUsages -Name TestCVUsages_Prediction +``` + +```output +CurrentValue : 0 +Name : CustomVision.Prediction.Transactions +Limit : 10000 +Status : Included +Unit : Count +QuotaPeriod : 30.00:00:00 +NextResetTime : 0001-01-01T00:00:00Z +``` + +### Example 2 +```powershell +$acc = Get-AzCognitiveServicesAccount -ResourceGroupName TestUsages -Name TestCVUsages_Prediction + +Get-AzCognitiveServicesAccountUsage -InputObject $acc +``` + +```output +CurrentValue : 0 +Name : CustomVision.Prediction.Transactions +Limit : 10000 +Status : Included +Unit : Count +QuotaPeriod : 30.00:00:00 +NextResetTime : 0001-01-01T00:00:00Z +``` + +### Example 3 +```powershell +$acc = Get-AzCognitiveServicesAccount -ResourceGroupName TestUsages -Name TestCVUsages_Prediction + +Get-AzCognitiveServicesAccountUsage -ResourceId $acc.Id +``` + +```output +CurrentValue : 0 +Name : CustomVision.Prediction.Transactions +Limit : 10000 +Status : Included +Unit : Count +QuotaPeriod : 30.00:00:00 +NextResetTime : 0001-01-01T00:00:00Z +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Cognitive Services Account Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: CognitiveServicesAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Cognitive Services Account Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesUsage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesCommitmentPlan.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesCommitmentPlan.md new file mode 100644 index 0000000000..8b7170c0de --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesCommitmentPlan.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicescommitmentplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesCommitmentPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesCommitmentPlan.md +--- + +# Get-AzCognitiveServicesCommitmentPlan + +## SYNOPSIS +Get Cognitive Services Commitment Plan + +## SYNTAX + +### ResourceGroupParameterSet (Default) +``` +Get-AzCognitiveServicesCommitmentPlan [[-ResourceGroupName] ] + [-DefaultProfile ] [] +``` + +### CommitmentPlanNameParameterSet +``` +Get-AzCognitiveServicesCommitmentPlan [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get Cognitive Services Commitment Plan + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCognitiveServicesCommitmentPlan -ResourceGroupName ResourceGroupName -Name CommitmentPlanName +``` + +```output +SystemData : Microsoft.Azure.Management.CognitiveServices.Models.SystemData +Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +Kind : +Sku : +Tags : +Location : +Properties : Microsoft.Azure.Management.CognitiveServices.Models.CommitmentPlanProperties +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.CognitiveServices/accounts/resource-name/commitmentplans/plan-name +Name : plan-name +Type : Microsoft.CognitiveServices/accounts/commitmentplans +``` + +Get a Cognitive Services Commitment Plan + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Commitment Plan Name. + +```yaml +Type: System.String +Parameter Sets: CommitmentPlanNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: CommitmentPlanNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount + +## NOTES + +## RELATED LINKS + +[Get-AzCognitiveServicesCommitmentPlanAssociation](./Get-AzCognitiveServicesCommitmentPlanAssociation.md) + +[New-AzCognitiveServicesCommitmentPlan](./New-AzCognitiveServicesCommitmentPlan.md) + +[New-AzCognitiveServicesCommitmentPlanAssociation](./New-AzCognitiveServicesCommitmentPlanAssociation.md) + +[Remove-AzCognitiveServicesCommitmentPlan](./Remove-AzCognitiveServicesCommitmentPlan.md) + +[Remove-AzCognitiveServicesCommitmentPlanAssociation](./Remove-AzCognitiveServicesCommitmentPlanAssociation.md) diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesCommitmentPlanAssociation.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesCommitmentPlanAssociation.md new file mode 100644 index 0000000000..b44c8f3736 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesCommitmentPlanAssociation.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicescommitmentplanassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesCommitmentPlanAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesCommitmentPlanAssociation.md +--- + +# Get-AzCognitiveServicesCommitmentPlanAssociation + +## SYNOPSIS +Get Cognitive Services Commitment Plan Association + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Get-AzCognitiveServicesCommitmentPlanAssociation [[-ResourceGroupName] ] [-CommitmentPlanName] + [[-Name] ] [-DefaultProfile ] [] +``` + +### ResourceIdParameterSet +``` +Get-AzCognitiveServicesCommitmentPlanAssociation [-ResourceId] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get Cognitive Services Commitment Plan Association + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCognitiveServicesCommitmentPlanAssociation -ResourceGroupName ResourceGroupName -CommitmentPlanName CommitmentPlanName -Name AssociationName +``` + +Get a Cognitive Services Commitment Plan Association + +## PARAMETERS + +### -CommitmentPlanName +Cognitive Services CommitmentPlan Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cognitive Services CommitmentPlan AssociationName Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount + +## NOTES + +## RELATED LINKS + +[Get-AzCognitiveServicesCommitmentPlan](./Get-AzCognitiveServicesCommitmentPlan.md) + +[New-AzCognitiveServicesCommitmentPlan](./New-AzCognitiveServicesCommitmentPlan.md) + +[New-AzCognitiveServicesCommitmentPlanAssociation](./New-AzCognitiveServicesCommitmentPlanAssociation.md) + +[Remove-AzCognitiveServicesCommitmentPlan](./Remove-AzCognitiveServicesCommitmentPlan.md) + +[Remove-AzCognitiveServicesCommitmentPlanAssociation](./Remove-AzCognitiveServicesCommitmentPlanAssociation.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesCommitmentTier.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesCommitmentTier.md new file mode 100644 index 0000000000..08d19a1d51 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesCommitmentTier.md @@ -0,0 +1,90 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicescommitmenttier +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesCommitmentTier.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesCommitmentTier.md +--- + +# Get-AzCognitiveServicesCommitmentTier + +## SYNOPSIS +Get CommitmentTier of Cognitive Services + +## SYNTAX + +``` +Get-AzCognitiveServicesCommitmentTier [-Location] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get CommitmentTier of Cognitive Services + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCognitiveServicesCommitmentTier -Location 'WestUS' +``` + +```output +Kind : kind +SkuName : sku +HostingModel : hosting model +PlanType : plan type +Tier : tier +MaxCount : +Quota : Microsoft.Azure.Management.CognitiveServices.Models.CommitmentQuota +Cost : Microsoft.Azure.Management.CognitiveServices.Models.CommitmentCost +``` + +Get CommitmentTier of Cognitive Services + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Cognitive Services Account Location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.CognitiveServices.Models.CommitmentTier + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesModel.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesModel.md new file mode 100644 index 0000000000..fdcd1eab99 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesModel.md @@ -0,0 +1,85 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicesmodel +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesModel.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesModel.md +--- + +# Get-AzCognitiveServicesModel + +## SYNOPSIS +Get Models of Cognitive Services + +## SYNTAX + +``` +Get-AzCognitiveServicesModel [-Location] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get Models of Cognitive Services + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCognitiveServicesModel -Location 'WestUS' +``` + +```output +Kind : kind +SkuName : sku +Model : model +``` + +Get Models of Cognitive Services + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Cognitive Services Account Location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.CognitiveServices.Models.Model + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesUsage.md b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesUsage.md new file mode 100644 index 0000000000..a18baa372f --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Get-AzCognitiveServicesUsage.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/get-azcognitiveservicesusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesUsage.md +--- + +# Get-AzCognitiveServicesUsage + +## SYNOPSIS +Get Usage of Cognitive Services + +## SYNTAX + +``` +Get-AzCognitiveServicesUsage [-Location] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get Usage of Cognitive Services + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCognitiveServicesUsage -Location 'WestUS' +``` + +```output +CurrentValue : 0 +Name : CustomVision.Prediction.Transactions +Limit : 10000 +Status : Included +Unit : Count +QuotaPeriod : 30.00:00:00 +NextResetTime : 0001-01-01T00:00:00Z +``` + +Get Usage of Cognitive Services + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Cognitive Services Account Location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.CognitiveServices.Models.PSCognitiveServicesUsage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccount.md b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccount.md new file mode 100644 index 0000000000..0fa29a7be1 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccount.md @@ -0,0 +1,522 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +ms.assetid: A2B4ACC1-6F53-47DE-A2D4-831E8AC89A5C +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/new-azcognitiveservicesaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesAccount.md +--- + +# New-AzCognitiveServicesAccount + +## SYNOPSIS +Creates a Cognitive Services account. + +## SYNTAX + +### CognitiveServicesEncryption +``` +New-AzCognitiveServicesAccount [-ResourceGroupName] [-Name] [-Type] + [-SkuName] [-Location] [-Tag ] [-CustomSubdomainName ] + [-AssignIdentity] [-UserAssignedIdentityId ] [-IdentityType ] + [-StorageAccountId ] [-CognitiveServicesEncryption] [-NetworkRuleSet ] + [-PublicNetworkAccess ] [-DisableLocalAuth ] [-RestrictOutboundNetworkAccess ] + [-AllowedFqdnList ] [-MultiRegionSetting ] + [-ApiProperty ] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### KeyVaultEncryption +``` +New-AzCognitiveServicesAccount [-ResourceGroupName] [-Name] [-Type] + [-SkuName] [-Location] [-Tag ] [-CustomSubdomainName ] + [-AssignIdentity] [-UserAssignedIdentityId ] [-IdentityType ] + [-StorageAccountId ] [-KeyVaultEncryption] -KeyName -KeyVersion + -KeyVaultUri [-KeyVaultIdentityClientId ] [-NetworkRuleSet ] + [-PublicNetworkAccess ] [-DisableLocalAuth ] [-RestrictOutboundNetworkAccess ] + [-AllowedFqdnList ] [-MultiRegionSetting ] + [-ApiProperty ] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **New-AzCognitiveServicesAccount** cmdlet creates a Cognitive Services account with the +specified type and SKU. + +## EXAMPLES + +### 1: +```powershell +New-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis -Type LUIS -SkuName S0 -Location 'WestUS' +``` + +```output +ResourceGroupName : cognitive-services-resource-group +AccountName : myluis +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.Cog + nitiveServices/accounts/myluis +Endpoint : https://westus.api.cognitive.microsoft.com/luis/v2.0 +Location : WestUS +Sku : Microsoft.Azure.Management.CognitiveServices.Models.Sku +AccountType : LUIS +ResourceType : Microsoft.CognitiveServices/accounts +Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +ProvisioningState : Succeeded +Tags : +``` + +## PARAMETERS + +### -AllowedFqdnList +List of Allowed FQDN. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiProperty +The ApiProperties of Cognitive Services Account. Required by specific account types. + +```yaml +Type: Microsoft.Azure.Management.CognitiveServices.Models.CognitiveServicesAccountApiProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign a new Cognitive Services Account Identity for this storage account for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CognitiveServicesEncryption +Whether to set Cognitive Services Account Encryption KeySource to Microsoft.CognitiveServices or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CognitiveServicesEncryption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomSubdomainName +Cognitive Services Account Subdomain Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +True if disable Local authentication methods. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Set the new Cognitive Services Account Identity type, the idenetity is for use with key management services like Azure KeyVault. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.CognitiveServices.Models.IdentityType] +Parameter Sets: (All) +Aliases: +Accepted values: None, SystemAssigned, UserAssigned, SystemAssignedUserAssigned + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +Cognitive Services Account encryption keySource KeyVault KeyName + +```yaml +Type: System.String +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultEncryption +Whether to set Cognitive Services Account encryption keySource to Microsoft.KeyVault or not. If you specify KeyName, KeyVersion and KeyVaultUri, Cognitive Services Account Encryption KeySource will also be set to Microsoft.KeyVault weather this parameter is set or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultIdentityClientId +Set IdentityClientId to access Azure KeyVault of Cognitive Services Account Encryption. + +```yaml +Type: System.String +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultUri +Cognitive Services Account encryption keySource KeyVault KeyVaultUri + +```yaml +Type: System.String +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVersion +Cognitive Services Account encryption keySource KeyVault KeyVersion + +```yaml +Type: System.String +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location in which to create the account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MultiRegionSetting +Multi-region settings for multi-region account. + +```yaml +Type: Microsoft.Azure.Management.CognitiveServices.Models.MultiRegionSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name for the account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkRuleSet +NetworkRuleSet is used to define a set of configuration rules for firewalls and virtual networks, as well as to set values for network properties such as how to handle requests that don't match any of the defined rules + +```yaml +Type: Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSNetworkRuleSet +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +The network access type for Cognitive Services Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which to assign the account. +The resource group must already exist. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestrictOutboundNetworkAccess +True if restrict outbound network access. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Specifies the SKU for the account. +The acceptable values for this parameter are: +- F0 (free tier) +- S0 +- S1 +- S2 +- S3 +- S4 +For more information, see [Cognitive Service APIs](https://www.microsoft.com/cognitive-services/en-us/apis). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountId +List of User Owned Storage Accounts. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specifies a tag as a name/value pair. + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specifies the type of account to create. Use `Get-AzCognitiveServicesAccountType` cmdlet to get current acceptable values. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountType, AccountType, Kind + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +Set resource ids for the the new Cognitive Services Account user assigned Identity, the identity will be used with key management services like Azure KeyVault. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount + +## NOTES + +## RELATED LINKS + +[Get-AzCognitiveServicesAccount](./Get-AzCognitiveServicesAccount.md) + +[Remove-AzCognitiveServicesAccount](./Remove-AzCognitiveServicesAccount.md) + +[Set-AzCognitiveServicesAccount](./Set-AzCognitiveServicesAccount.md) diff --git a/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccountApiProperty.md b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccountApiProperty.md new file mode 100644 index 0000000000..871919b53e --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccountApiProperty.md @@ -0,0 +1,98 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/new-azcognitiveservicesaccountapiproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesAccountApiProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesAccountApiProperty.md +--- + +# New-AzCognitiveServicesAccountApiProperty + +## SYNOPSIS +Generate a new instance of Cognitive Services Account ApiProperties + +## SYNTAX + +``` +New-AzCognitiveServicesAccountApiProperty [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Generate a new instance of Cognitive Services Account ApiProperties. +ApiProperties can be used when creating a new account or updating an existing account. +ApiProperties is required by certain account types. + +## EXAMPLES + +### Example 1 +```powershell +$apiProperties = New-AzCognitiveServicesAccountApiProperty +$apiProperties.QnaRuntimeEndpoint = "https://qnamaker.azurewebsites.net" +New-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name qnamaker -Type QnAMaker -SkuName S0 -Location WestUS -ApiProperty $apiProperties +``` + +Above example will create an QnAMaker account, with API property "QnaRuntimeEndpoint". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.CognitiveServices.Models.CognitiveServicesAccountApiProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccountCommitmentPlan.md b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccountCommitmentPlan.md new file mode 100644 index 0000000000..872d7bbb06 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccountCommitmentPlan.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/new-azcognitiveservicesaccountcommitmentplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesAccountCommitmentPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesAccountCommitmentPlan.md +--- + +# New-AzCognitiveServicesAccountCommitmentPlan + +## SYNOPSIS +Create a CommitmentPlan for a Cognitive Services account + +## SYNTAX + +``` +New-AzCognitiveServicesAccountCommitmentPlan [-ResourceGroupName] [-AccountName] + [-Name] [-Properties] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Create a CommitmentPlan for a Cognitive Services account + +## EXAMPLES + +### Example 1 +```powershell +New-AzCognitiveServicesAccountDeployment -ResourceGroupName cognitive-services-resource-group -AccountName resource-name -Name "plan" -Properties $properties +``` + +Create a CommitmentPlan for a Cognitive Services account +You can use `New-AzCognitiveServicesObject` to create a CommitmentPlanProperties object + +## PARAMETERS + +### -AccountName +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Properties +Cognitive Services CommitmentPlan Properties. + +```yaml +Type: Microsoft.Azure.Management.CognitiveServices.Models.CommitmentPlanProperties +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.CognitiveServices.Models.CommitmentPlan + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccountDeployment.md b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccountDeployment.md new file mode 100644 index 0000000000..94b20e6cb2 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccountDeployment.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/new-azcognitiveservicesaccountdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesAccountDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesAccountDeployment.md +--- + +# New-AzCognitiveServicesAccountDeployment + +## SYNOPSIS +Create a Deployment for a Cognitive Services account + +## SYNTAX + +``` +New-AzCognitiveServicesAccountDeployment [-ResourceGroupName] [-AccountName] [-Name] + [-Properties] [-Sku] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Create a Deployment for a Cognitive Services account + +## EXAMPLES + +### Example 1 +```powershell +New-AzCognitiveServicesAccountDeployment -ResourceGroupName cognitive-services-resource-group -AccountName resource-name -Name "deployment" -Properties $properties +``` + +Create a Deployment for a Cognitive Services account +You can use `New-AzCognitiveServicesObject` to create a DeploymentProperties object + +## PARAMETERS + +### -AccountName +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Properties +Cognitive Services Deployment Properties. + +```yaml +Type: Microsoft.Azure.Management.CognitiveServices.Models.DeploymentProperties +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Cognitive Services Deployment Sku. + +```yaml +Type: Microsoft.Azure.Management.CognitiveServices.Models.Sku +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.CognitiveServices.Models.Deployment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccountKey.md b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccountKey.md new file mode 100644 index 0000000000..d024acefff --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesAccountKey.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +ms.assetid: E0819A61-157A-4DFD-B492-09C8F1C38E18 +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/new-azcognitiveservicesaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesAccountKey.md +--- + +# New-AzCognitiveServicesAccountKey + +## SYNOPSIS +Regenerates an account key. + +## SYNTAX + +``` +New-AzCognitiveServicesAccountKey [-ResourceGroupName] [-Name] [-KeyName] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **New-AzCognitiveServicesAccountKey** cmdlet regenerates an API key for a Cognitive Services account. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCognitiveServicesAccountKey -ResourceGroupName cognitive-services-resource-group -name myluis -keyname Key1 +``` + +```output +Key1 Key2 +---- ---- +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +Specifies the name of the key to regenerate. +The acceptable values for this parameter are: +- Key1 +- Key2 + +```yaml +Type: Microsoft.Azure.Management.CognitiveServices.Models.KeyName +Parameter Sets: (All) +Aliases: +Accepted values: Key1, Key2 + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group the account is assigned to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Management.CognitiveServices.Models.KeyName + +## OUTPUTS + +### Microsoft.Azure.Management.CognitiveServices.Models.CognitiveServicesAccountKeys + +## NOTES + +## RELATED LINKS + +[Get-AzCognitiveServicesAccountKey](./Get-AzCognitiveServicesAccountKey.md) + + diff --git a/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesCommitmentPlan.md b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesCommitmentPlan.md new file mode 100644 index 0000000000..94d7761698 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesCommitmentPlan.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/new-azcognitiveservicescommitmentplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesCommitmentPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesCommitmentPlan.md +--- + +# New-AzCognitiveServicesCommitmentPlan + +## SYNOPSIS +Create a Cognitive Services Commitment Plan + +## SYNTAX + +``` +New-AzCognitiveServicesCommitmentPlan -ResourceGroupName -Name -Type + -SkuName -Location [-Tag ] -Properties + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a Cognitive Services Commitment Plan + +## EXAMPLES + +### Example 1 +```powershell +$properties = New-AzCognitiveServicesObject -Type CommitmentPlanProperties +$properties.HostingModel = "Web" +$properties.AutoRenew = $false +$properties.PlanType = "STT" +$properties.Current.Tier = "T1" +$properties.Next = $null + +New-AzCognitiveServicesCommitmentPlan -ResourceGroupName ResourceGroupName -Name CommitmentPlanName -Type SpeechServices -SkuName S0 -Location CentralUS -Properties $properties; +``` + +Create a Cognitive Services Commitment Plan for SpeechServices STT T1 + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Cognitive Services CommitmentPlan Location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Properties +Cognitive Services CommitmentPlan Properties. + +```yaml +Type: Microsoft.Azure.Management.CognitiveServices.Models.CommitmentPlanProperties +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuName +Cognitive Services Account/CommitmentPlan Sku Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Cognitive Services CommitmentPlan Tags. + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Cognitive Services Account/CommitmentPlan Type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Kind + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Management.CognitiveServices.Models.CommitmentPlanProperties + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount + +## NOTES + +## RELATED LINKS + +[Get-AzCognitiveServicesCommitmentPlan](./Get-AzCognitiveServicesCommitmentPlan.md) + +[Get-AzCognitiveServicesCommitmentPlanAssociation](./Get-AzCognitiveServicesCommitmentPlanAssociation.md) + +[New-AzCognitiveServicesCommitmentPlanAssociation](./New-AzCognitiveServicesCommitmentPlanAssociation.md) + +[Remove-AzCognitiveServicesCommitmentPlan](./Remove-AzCognitiveServicesCommitmentPlan.md) + +[Remove-AzCognitiveServicesCommitmentPlanAssociation](./Remove-AzCognitiveServicesCommitmentPlanAssociation.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesCommitmentPlanAssociation.md b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesCommitmentPlanAssociation.md new file mode 100644 index 0000000000..7e0616bc76 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesCommitmentPlanAssociation.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/new-azcognitiveservicescommitmentplanassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesCommitmentPlanAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesCommitmentPlanAssociation.md +--- + +# New-AzCognitiveServicesCommitmentPlanAssociation + +## SYNOPSIS +Create a Cognitive Services Commitment Plan Association + +## SYNTAX + +``` +New-AzCognitiveServicesCommitmentPlanAssociation [-ResourceGroupName] [-CommitmentPlanName] + [-Name] [-AccountId] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Create a Cognitive Services Commitment Plan Association + +## EXAMPLES + +### Example 1 +```powershell +New-AzCognitiveServicesCommitmentPlanAssociation -ResourceGroupName ResourceGroupName -CommitmentPlanName CommitmentPlanName -Name AssociationName -AccountId AccountId; +``` + +Create a Cognitive Services Commitment Plan Association between a commitment plan and an account + +## PARAMETERS + +### -AccountId +Cognitive Services Account Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CommitmentPlanName +Cognitive Services CommitmentPlan Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cognitive Services CommitmentPlan Association Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount + +## NOTES + +## RELATED LINKS + +[Get-AzCognitiveServicesCommitmentPlan](./Get-AzCognitiveServicesCommitmentPlan.md) + +[Get-AzCognitiveServicesCommitmentPlanAssociation](./Get-AzCognitiveServicesCommitmentPlanAssociation.md) + +[New-AzCognitiveServicesCommitmentPlan](./New-AzCognitiveServicesCommitmentPlan.md) + +[Remove-AzCognitiveServicesCommitmentPlan](./Remove-AzCognitiveServicesCommitmentPlan.md) + +[Remove-AzCognitiveServicesCommitmentPlanAssociation](./Remove-AzCognitiveServicesCommitmentPlanAssociation.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesObject.md b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesObject.md new file mode 100644 index 0000000000..0be2d2cafe --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/New-AzCognitiveServicesObject.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/new-azcognitiveservicesobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/New-AzCognitiveServicesObject.md +--- + +# New-AzCognitiveServicesObject + +## SYNOPSIS +Create a Cognitive Services Object + +## SYNTAX + +``` +New-AzCognitiveServicesObject [-Type] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a Cognitive Services Object + +## EXAMPLES + +### Example 1 +```powershell +New-AzCognitiveServicesObject -Type DeploymentProperties +``` + +Create a Cognitive Services DeploymentProperties Object + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Cognitive Services Object Type. + +```yaml +Type: Microsoft.Azure.Commands.Management.CognitiveServices.CognitiveServicesObjectType +Parameter Sets: (All) +Aliases: +Accepted values: DeploymentProperties, CommitmentPlanProperties, MultiRegionSettings, RegionSetting, Sku + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.CognitiveServices.Models.DeploymentProperties + +### Microsoft.Azure.Management.CognitiveServices.Models.CommitmentPlanProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesAccount.md b/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesAccount.md new file mode 100644 index 0000000000..6137700c96 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesAccount.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +ms.assetid: 87A79215-5688-474D-822A-6B84B3D10E3F +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/remove-azcognitiveservicesaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Remove-AzCognitiveServicesAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Remove-AzCognitiveServicesAccount.md +--- + +# Remove-AzCognitiveServicesAccount + +## SYNOPSIS +Deletes a Cognitive Services account. + +## SYNTAX + +### AccountParameterSet (Default) +``` +Remove-AzCognitiveServicesAccount [-ResourceGroupName] [-Name] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### DeletedAccountParameterSet +``` +Remove-AzCognitiveServicesAccount [-ResourceGroupName] [-Name] [-InRemovedState] + [-Location] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzCognitiveServicesAccount** cmdlet deletes the specified Cognitive Services account. + +## EXAMPLES + +### Example 1 +This command doesn't return anything. + +```powershell +Remove-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InRemovedState +Specifies whether to only show the deleted accounts in the output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DeletedAccountParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Cognitive Services Account Location. + +```yaml +Type: System.String +Parameter Sets: DeletedAccountParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the account to delete. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group the Cognitive Services account is assigned to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzCognitiveServicesAccount](./Get-AzCognitiveServicesAccount.md) + +[New-AzCognitiveServicesAccount](./New-AzCognitiveServicesAccount.md) + +[Set-AzCognitiveServicesAccount](./Set-AzCognitiveServicesAccount.md) + + diff --git a/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesAccountCommitmentPlan.md b/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesAccountCommitmentPlan.md new file mode 100644 index 0000000000..6ec53db5b0 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesAccountCommitmentPlan.md @@ -0,0 +1,214 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/remove-azcognitiveservicesaccountcommitmentplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Remove-AzCognitiveServicesAccountCommitmentPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Remove-AzCognitiveServicesAccountCommitmentPlan.md +--- + +# Remove-AzCognitiveServicesAccountCommitmentPlan + +## SYNOPSIS +Delete a CommitmentPlan from a Cognitive Services account + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Remove-AzCognitiveServicesAccountCommitmentPlan [-ResourceGroupName] [-AccountName] + [-Name] [-Force] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### InputObjectParameterSet +``` +Remove-AzCognitiveServicesAccountCommitmentPlan [-InputObject] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ResourceIdParameterSet +``` +Remove-AzCognitiveServicesAccountCommitmentPlan [-ResourceId] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete a CommitmentPlan from a Cognitive Services account + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCognitiveServicesAccountCommitmentPlan -ResourceGroupName cognitive-services-resource-group -AccountName resource-name -Name "plan" +``` + +Delete a CommitmentPlan from a Cognitive Services account + +## PARAMETERS + +### -AccountName +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: CognitiveServicesAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +InputObject. + +```yaml +Type: Microsoft.Azure.Management.CognitiveServices.Models.CommitmentPlan +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesAccountDeployment.md b/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesAccountDeployment.md new file mode 100644 index 0000000000..694de94eb5 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesAccountDeployment.md @@ -0,0 +1,214 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/remove-azcognitiveservicesaccountdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Remove-AzCognitiveServicesAccountDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Remove-AzCognitiveServicesAccountDeployment.md +--- + +# Remove-AzCognitiveServicesAccountDeployment + +## SYNOPSIS +Delete a Deployment from a Cognitive Services account + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Remove-AzCognitiveServicesAccountDeployment [-ResourceGroupName] [-AccountName] + [-Name] [-Force] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### InputObjectParameterSet +``` +Remove-AzCognitiveServicesAccountDeployment [-InputObject] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ResourceIdParameterSet +``` +Remove-AzCognitiveServicesAccountDeployment [-ResourceId] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete a Deployment from a Cognitive Services account + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCognitiveServicesAccountDeployment -ResourceGroupName cognitive-services-resource-group -AccountName resource-name -Name "plan" +``` + +Delete a Deployment from a Cognitive Services account + +## PARAMETERS + +### -AccountName +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: CognitiveServicesAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +InputObject. + +```yaml +Type: Microsoft.Azure.Management.CognitiveServices.Models.Deployment +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesAccountNetworkRule.md b/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesAccountNetworkRule.md new file mode 100644 index 0000000000..73f2533049 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesAccountNetworkRule.md @@ -0,0 +1,234 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/remove-azcognitiveservicesaccountnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Remove-AzCognitiveServicesAccountNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Remove-AzCognitiveServicesAccountNetworkRule.md +--- + +# Remove-AzCognitiveServicesAccountNetworkRule + +## SYNOPSIS +Remove IpRules or VirtualNetworkRules from the NetWorkRule property of a Cognitive Services account + +## SYNTAX + +### NetWorkRuleString (Default) +``` +Remove-AzCognitiveServicesAccountNetworkRule [-ResourceGroupName] [-Name] + -VirtualNetworkResourceId [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### IpRuleObject +``` +Remove-AzCognitiveServicesAccountNetworkRule [-ResourceGroupName] [-Name] + -IpRule [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### NetworkRuleObject +``` +Remove-AzCognitiveServicesAccountNetworkRule [-ResourceGroupName] [-Name] + -VirtualNetworkRule [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### IpRuleString +``` +Remove-AzCognitiveServicesAccountNetworkRule [-ResourceGroupName] [-Name] + -IpAddressOrRange [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Remove-AzCognitiveServicesAccountNetworkRule** cmdlet removes IpRules or VirtualNetworkRules from the NetWorkRule property of a Cognitive Services account + +## EXAMPLES + +### Example 1: Remove several IpRules with IPAddressOrRange +```powershell +Remove-AzCognitiveServicesAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "myaccount" -IpAddressOrRange "10.0.0.0/24,28.1.0.0/16" +``` + +This command remove several IpRules with IPAddressOrRange. + +### Example 2: Remove a VirtualNetworkRule with VirtualNetworkRule Object input with JSON +```powershell +Remove-AzCognitiveServicesAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "myaccount" -VirtualNetworkRule (@{VirtualNetworkReourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"}) +``` + +This command remove a VirtualNetworkRule with VirtualNetworkRule Object input with JSON. + +### Example 3: Remove first IpRule with pipeline +```powershell +(Get-AzCognitiveServicesAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "myaccount").IpRules[0] | Remove-AzCognitiveServicesAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "myaccount" +``` + +This command remove first IpRule with pipeline. + +### Example 4: Remove several VirtualNetworkRules with VirtualNetworkResourceID +```powershell +Remove-AzCognitiveServicesAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "myaccount" -VirtualNetworkResourceId "/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1","/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2" +``` + +This command remove several VirtualNetworkRules with VirtualNetworkResourceID. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddressOrRange +Cognitive Services Account NetworkRule IpRules IpAddressOrRange in string. + +```yaml +Type: System.String[] +Parameter Sets: IpRuleString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpRule +Cognitive Services Account NetworkRule IpRules. + +```yaml +Type: Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSIpRule[] +Parameter Sets: IpRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkResourceId +Cognitive Services Account NetworkRule VirtualNetworkRules VirtualNetworkResourceId in string. + +```yaml +Type: System.String[] +Parameter Sets: NetWorkRuleString +Aliases: SubnetId, VirtualNetworkId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRule +Cognitive Services Account NetworkRule VirtualNetworkRules. + +```yaml +Type: Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSVirtualNetworkRule[] +Parameter Sets: NetworkRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSIpRule[] + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSVirtualNetworkRule[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSVirtualNetworkRule + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSIpRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesCommitmentPlan.md b/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesCommitmentPlan.md new file mode 100644 index 0000000000..7bc88e2f11 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesCommitmentPlan.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/remove-azcognitiveservicescommitmentplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Remove-AzCognitiveServicesCommitmentPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Remove-AzCognitiveServicesCommitmentPlan.md +--- + +# Remove-AzCognitiveServicesCommitmentPlan + +## SYNOPSIS +Remove a Cognitive Services Commitment Plan + +## SYNTAX + +``` +Remove-AzCognitiveServicesCommitmentPlan [-ResourceGroupName] [-Name] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Remove a Cognitive Services Commitment Plan + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCognitiveServicesCommitmentPlan -ResourceGroupName ResourceGroupName -Name CommitmentPlanName +``` + +Remove a Cognitive Services Commitment Plan + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cognitive Services CommitmentPlan Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzCognitiveServicesCommitmentPlan](./Get-AzCognitiveServicesCommitmentPlan.md) + +[Get-AzCognitiveServicesCommitmentPlanAssociation](./Get-AzCognitiveServicesCommitmentPlanAssociation.md) + +[New-AzCognitiveServicesCommitmentPlan](./New-AzCognitiveServicesCommitmentPlan.md) + +[New-AzCognitiveServicesCommitmentPlanAssociation](./New-AzCognitiveServicesCommitmentPlanAssociation.md) + +[Remove-AzCognitiveServicesCommitmentPlanAssociation](./Remove-AzCognitiveServicesCommitmentPlanAssociation.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesCommitmentPlanAssociation.md b/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesCommitmentPlanAssociation.md new file mode 100644 index 0000000000..2302413b37 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Remove-AzCognitiveServicesCommitmentPlanAssociation.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/remove-azcognitiveservicescommitmentplanassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Remove-AzCognitiveServicesCommitmentPlanAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Remove-AzCognitiveServicesCommitmentPlanAssociation.md +--- + +# Remove-AzCognitiveServicesCommitmentPlanAssociation + +## SYNOPSIS +Remove a Cognitive Services Commitment Plan Association + +## SYNTAX + +``` +Remove-AzCognitiveServicesCommitmentPlanAssociation [-ResourceGroupName] + [-CommitmentPlanName] [-Name] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Remove a Cognitive Services Commitment Plan Association + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCognitiveServicesCommitmentPlanAssociation -ResourceGroupName ResourceGroupName -CommitmentPlanName CommitmentPlanName -Name AssociationName +``` + +Remove a Cognitive Services Commitment Plan Association + +## PARAMETERS + +### -CommitmentPlanName +Cognitive Services CommitmentPlan Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cognitive Services CommitmentPlan Association Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzCognitiveServicesCommitmentPlan](./Get-AzCognitiveServicesCommitmentPlan.md) + +[Get-AzCognitiveServicesCommitmentPlanAssociation](./Get-AzCognitiveServicesCommitmentPlanAssociation.md) + +[New-AzCognitiveServicesCommitmentPlan](./New-AzCognitiveServicesCommitmentPlan.md) + +[New-AzCognitiveServicesCommitmentPlanAssociation](./New-AzCognitiveServicesCommitmentPlanAssociation.md) + +[Remove-AzCognitiveServicesCommitmentPlan](./Remove-AzCognitiveServicesCommitmentPlan.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.CognitiveServices/Set-AzCognitiveServicesAccount.md b/azps-10.1.0/Az.CognitiveServices/Set-AzCognitiveServicesAccount.md new file mode 100644 index 0000000000..b9806ae1ea --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Set-AzCognitiveServicesAccount.md @@ -0,0 +1,489 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +ms.assetid: 11E2D82A-1DF1-4E19-8328-44674641D1BB +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/set-azcognitiveservicesaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Set-AzCognitiveServicesAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Set-AzCognitiveServicesAccount.md +--- + +# Set-AzCognitiveServicesAccount + +## SYNOPSIS +Modifies an account. + +## SYNTAX + +### CognitiveServicesEncryption (Default) +``` +Set-AzCognitiveServicesAccount [-ResourceGroupName] [-Name] [-SkuName ] + [-Tag ] [-CustomSubdomainName ] [-AssignIdentity] [-UserAssignedIdentityId ] + [-IdentityType ] [-StorageAccountId ] [-CognitiveServicesEncryption] + [-NetworkRuleSet ] [-PublicNetworkAccess ] [-DisableLocalAuth ] + [-RestrictOutboundNetworkAccess ] [-AllowedFqdnList ] + [-MultiRegionSetting ] [-ApiProperty ] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### KeyVaultEncryption +``` +Set-AzCognitiveServicesAccount [-ResourceGroupName] [-Name] [-SkuName ] + [-Tag ] [-CustomSubdomainName ] [-AssignIdentity] [-UserAssignedIdentityId ] + [-IdentityType ] [-StorageAccountId ] [-KeyVaultEncryption] -KeyName + -KeyVersion -KeyVaultUri [-KeyVaultIdentityClientId ] + [-NetworkRuleSet ] [-PublicNetworkAccess ] [-DisableLocalAuth ] + [-RestrictOutboundNetworkAccess ] [-AllowedFqdnList ] + [-MultiRegionSetting ] [-ApiProperty ] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Set-AzCognitiveServicesAccount** cmdlet modifies the SKU or tags of the specified Cognitive Services account. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis -SkuName S0 +``` + +```output +ResourceGroupName : cognitive-services-resource-group +AccountName : myluis +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.Cog + nitiveServices/accounts/myluis +Endpoint : https://westus.api.cognitive.microsoft.com/luis/v2.0 +Location : WESTUS +Sku : Microsoft.Azure.Management.CognitiveServices.Models.Sku +AccountType : LUIS +ResourceType : Microsoft.CognitiveServices/accounts +Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +ProvisioningState : Succeeded +Tags : +``` + +## PARAMETERS + +### -AllowedFqdnList +List of Allowed FQDN. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiProperty +The ApiProperties of Cognitive Services Account. Required by specific account types. + +```yaml +Type: Microsoft.Azure.Management.CognitiveServices.Models.CognitiveServicesAccountApiProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign a new Cognitive Services Account Identity for this storage account for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CognitiveServicesEncryption +Whether to set Cognitive Services Account Encryption KeySource to Microsoft.CognitiveServices or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CognitiveServicesEncryption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomSubdomainName +Cognitive Services Account Subdomain Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +True if disable Local authentication methods. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.CognitiveServices.Models.IdentityType] +Parameter Sets: (All) +Aliases: +Accepted values: None, SystemAssigned, UserAssigned, SystemAssignedUserAssigned + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +Cognitive Services Account encryption keySource KeyVault KeyName + +```yaml +Type: System.String +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultEncryption +Whether to set Cognitive Services Account encryption keySource to Microsoft.KeyVault or not. If you specify KeyName, KeyVersion and KeyVaultUri, Cognitive Services Account Encryption KeySource will also be set to Microsoft.KeyVault weather this parameter is set or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultIdentityClientId +Set IdentityClientId to access Azure KeyVault of Cognitive Services Account Encryption. + +```yaml +Type: System.String +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultUri +Cognitive Services Account encryption keySource KeyVault KeyVaultUri + +```yaml +Type: System.String +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVersion +Cognitive Services Account encryption keySource KeyVault KeyVersion + +```yaml +Type: System.String +Parameter Sets: KeyVaultEncryption +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiRegionSetting +Multi-region settings for multi-region account. + +```yaml +Type: Microsoft.Azure.Management.CognitiveServices.Models.MultiRegionSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the account to modify. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkRuleSet +NetworkRuleSet is used to define a set of configuration rules for firewalls and virtual networks, as well as to set values for network properties such as how to handle requests that don't match any of the defined rules + +```yaml +Type: Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSNetworkRuleSet +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +The network access type for Cognitive Services Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group the account is assigned to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestrictOutboundNetworkAccess +True if restrict outbound network access. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Specifies the SKU for the account. +The acceptable values for this parameter are: +- F0 (free tier) +- S0 +- S1 +- S2 +- S3 +- S4 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountId +List of User Owned Storage Accounts. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specifies a tag as a name/value pair. + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +Set resource ids for the the new Cognitive Services Account user assigned Identity, the identity will be used with key management services like Azure KeyVault. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount + +## NOTES + +## RELATED LINKS + +[Get-AzCognitiveServicesAccount](./Get-AzCognitiveServicesAccount.md) + +[New-AzCognitiveServicesAccount](./New-AzCognitiveServicesAccount.md) + +[Remove-AzCognitiveServicesAccount](./Remove-AzCognitiveServicesAccount.md) diff --git a/azps-10.1.0/Az.CognitiveServices/Undo-AzCognitiveServicesAccountRemoval.md b/azps-10.1.0/Az.CognitiveServices/Undo-AzCognitiveServicesAccountRemoval.md new file mode 100644 index 0000000000..4f253861ac --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Undo-AzCognitiveServicesAccountRemoval.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/undo-azcognitiveservicesaccountremoval +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Undo-AzCognitiveServicesAccountRemoval.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Undo-AzCognitiveServicesAccountRemoval.md +--- + +# Undo-AzCognitiveServicesAccountRemoval + +## SYNOPSIS +Recover a deleted account. + +## SYNTAX + +``` +Undo-AzCognitiveServicesAccountRemoval [-Location] [-ResourceGroupName] [-Name] + [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Undo-AzCognitiveServicesAccountRemoval** cmdlet recover a soft-deleted Cognitive Services account. + +## EXAMPLES + +### Example 1 +```powershell +Undo-AzCognitiveServicesAccountRemoval -Location "Central US EUAP" -ResourceGroupName "ResourceGroupName" -Name "ResourceName" +``` + +Recover a soft-deleted Cognitive Services account. The account was created in "Central US EUAP", the resource group and resource name were "ResourceGroupName" and "ResourceName". +If resource group has been deleted, you can create a new resource group with same name before running `Undo-AzCognitiveServicesAccountRemoval` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Cognitive Services Account Location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountName, AccountName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzCognitiveServicesAccount](./Get-AzCognitiveServicesAccount.md) + +[New-AzCognitiveServicesAccount](./New-AzCognitiveServicesAccount.md) + +[Remove-AzCognitiveServicesAccount](./Remove-AzCognitiveServicesAccount.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.CognitiveServices/Update-AzCognitiveServicesAccountNetworkRuleSet.md b/azps-10.1.0/Az.CognitiveServices/Update-AzCognitiveServicesAccountNetworkRuleSet.md new file mode 100644 index 0000000000..db3be3b7b0 --- /dev/null +++ b/azps-10.1.0/Az.CognitiveServices/Update-AzCognitiveServicesAccountNetworkRuleSet.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml +Module Name: Az.CognitiveServices +online version: https://learn.microsoft.com/powershell/module/az.cognitiveservices/update-azcognitiveservicesaccountnetworkruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Update-AzCognitiveServicesAccountNetworkRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CognitiveServices/CognitiveServices/help/Update-AzCognitiveServicesAccountNetworkRuleSet.md +--- + +# Update-AzCognitiveServicesAccountNetworkRuleSet + +## SYNOPSIS +Update the NetworkRule property of a Cognitive Services account + +## SYNTAX + +``` +Update-AzCognitiveServicesAccountNetworkRuleSet [-ResourceGroupName] [-Name] + [-DefaultAction ] [-IpRule ] + [-VirtualNetworkRule ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Update-AzCognitiveServicesAccountNetworkRuleSet** cmdlet updates the NetworkRule property of a Cognitive Services account + +## EXAMPLES + +### Example 1: Update all properties of NetworkRule, input Rules with JSON +```powershell +Update-AzCognitiveServicesAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "myaccount" -DefaultAction Allow -IpRule (@{IpAddressOrRange="200.0.0.0/24"},@{IpAddressOrRange="28.2.0.0/16"}) ` +-VirtualNetworkRule (@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"},@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2"}) +``` + +This command update all properties of NetworkRule, input Rules with JSON. + +### Example 2: Update Bypass property of NetworkRule +```powershell +Update-AzCognitiveServicesAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "myaccount" +``` + +This command update Bypass property of NetworkRule (other properties won't change). + +### Example 3: Clean up rules of NetworkRule of a Cognitive Services account +```powershell +Update-AzCognitiveServicesAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "myaccount" -IpRule @() -VirtualNetworkRule @() +``` + +This command clean up rules of NetworkRule of a Cognitive Services account (other properties not change). + +## PARAMETERS + +### -DefaultAction +Cognitive Services Account NetworkRule DefaultAction. Default value `Deny`. + +```yaml +Type: Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSNetWorkRuleDefaultActionEnum +Parameter Sets: (All) +Aliases: +Accepted values: Deny, Allow + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpRule +Cognitive Services Account NetworkRule IpRules. + +```yaml +Type: Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSIpRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Cognitive Services Account Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CognitiveServicesAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkRule +Cognitive Services Account NetworkRule VirtualNetworkRules. + +```yaml +Type: Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSVirtualNetworkRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSIpRule[] + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSVirtualNetworkRule[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSNetworkRuleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Communication/Az.Communication.md b/azps-10.1.0/Az.Communication/Az.Communication.md new file mode 100644 index 0000000000..dc664e1f40 --- /dev/null +++ b/azps-10.1.0/Az.Communication/Az.Communication.md @@ -0,0 +1,40 @@ +--- +Module Name: Az.Communication +Module Guid: 32c4dede-9b85-43d4-83ab-447e2938c400 +Download Help Link: https://learn.microsoft.com/powershell/module/az.communication +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Az.Communication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Az.Communication.md +--- + +# Az.Communication Module +## Description +Microsoft Azure PowerShell: Communication cmdlets + +## Az.Communication Cmdlets +### [Get-AzCommunicationService](Get-AzCommunicationService.md) +Get the CommunicationService and its properties. + +### [Get-AzCommunicationServiceKey](Get-AzCommunicationServiceKey.md) +Get the access keys of the CommunicationService resource. + +### [New-AzCommunicationService](New-AzCommunicationService.md) +Create a new CommunicationService or update an existing CommunicationService. + +### [New-AzCommunicationServiceKey](New-AzCommunicationServiceKey.md) +Regenerate CommunicationService access key. +PrimaryKey and SecondaryKey cannot be regenerated at the same time. + +### [Remove-AzCommunicationService](Remove-AzCommunicationService.md) +Operation to delete a CommunicationService. + +### [Set-AzCommunicationServiceNotificationHub](Set-AzCommunicationServiceNotificationHub.md) +Links an Azure Notification Hub to this communication service. + +### [Test-AzCommunicationServiceNameAvailability](Test-AzCommunicationServiceNameAvailability.md) +Checks that the CommunicationService name is valid and is not already in use. + +### [Update-AzCommunicationService](Update-AzCommunicationService.md) +Operation to update an existing CommunicationService. + diff --git a/azps-10.1.0/Az.Communication/Get-AzCommunicationService.md b/azps-10.1.0/Az.Communication/Get-AzCommunicationService.md new file mode 100644 index 0000000000..cdfb535fd1 --- /dev/null +++ b/azps-10.1.0/Az.Communication/Get-AzCommunicationService.md @@ -0,0 +1,180 @@ +--- +external help file: +Module Name: Az.Communication +online version: https://learn.microsoft.com/powershell/module/az.communication/get-azcommunicationservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Get-AzCommunicationService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Get-AzCommunicationService.md +--- + +# Get-AzCommunicationService + +## SYNOPSIS +Get the CommunicationService and its properties. + +## SYNTAX + +### List (Default) +``` +Get-AzCommunicationService [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzCommunicationService -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzCommunicationService -InputObject [-DefaultProfile ] + [] +``` + +### List1 +``` +Get-AzCommunicationService -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get the CommunicationService and its properties. + +## EXAMPLES + +### Example 1: List existing CommunicationServices for a Subscription +```powershell +Get-AzCommunicationService -SubscriptionId 73fc3592-3cef-4300-5e19-8d18b65ce0e8 +``` + +```output +Location Name Type AzureAsyncOperation +-------- ---- ---- ------------------- +global ContosoResource1 Microsoft.Communication/communicationServices +global ContosoResource4 Microsoft.Communication/communicationServices +global ContosoResource3 Microsoft.Communication/communicationServices +global ContosoResource5 Microsoft.Communication/communicationServices +``` + +Returns a list of all ACS resources under that subscription. + +### Example 2: Get infomation on specified Azure Communication resource +```powershell +Get-AzCommunicationService -Name ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 +``` + +```output +Location Name Type AzureAsyncOperation +-------- ---- ---- ------------------- +Global ContosoAcsResource1 Microsoft.Communication/communicationServices +``` + +Returns the information on an ACS resource, if one matching provided parameters is found. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the CommunicationService resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CommunicationServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20200820.ICommunicationServiceResource + +## 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 + - `[CommunicationServiceName ]`: The name of the CommunicationService resource. + - `[Id ]`: Resource identity path + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Communication/Get-AzCommunicationServiceKey.md b/azps-10.1.0/Az.Communication/Get-AzCommunicationServiceKey.md new file mode 100644 index 0000000000..f48dac9a33 --- /dev/null +++ b/azps-10.1.0/Az.Communication/Get-AzCommunicationServiceKey.md @@ -0,0 +1,148 @@ +--- +external help file: +Module Name: Az.Communication +online version: https://learn.microsoft.com/powershell/module/az.communication/get-azcommunicationservicekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Get-AzCommunicationServiceKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Get-AzCommunicationServiceKey.md +--- + +# Get-AzCommunicationServiceKey + +## SYNOPSIS +Get the access keys of the CommunicationService resource. + +## SYNTAX + +``` +Get-AzCommunicationServiceKey -CommunicationServiceName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Get the access keys of the CommunicationService resource. + +## EXAMPLES + +### Example 1: Fetch the Key for the specified Communcation service +```powershell +Get-AzCommunicationServiceKey -CommunicationServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 +``` + +```output +PrimaryConnectionString PrimaryKey SecondaryConnectionString SecondaryKey +----------------------- ---------- ----------------------- ---------- +endpoint= endpoint= +``` + +Displays the ConnectionString and Key for the specified Communcation service. + +## PARAMETERS + +### -CommunicationServiceName +The name of the CommunicationService resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20200820.ICommunicationServiceKeys + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Communication/New-AzCommunicationService.md b/azps-10.1.0/Az.Communication/New-AzCommunicationService.md new file mode 100644 index 0000000000..3e060bc2d1 --- /dev/null +++ b/azps-10.1.0/Az.Communication/New-AzCommunicationService.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Communication +online version: https://learn.microsoft.com/powershell/module/az.communication/new-azcommunicationservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/New-AzCommunicationService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/New-AzCommunicationService.md +--- + +# New-AzCommunicationService + +## SYNOPSIS +Create a new CommunicationService or update an existing CommunicationService. + +## SYNTAX + +``` +New-AzCommunicationService -Name -ResourceGroupName [-SubscriptionId ] + [-DataLocation ] [-Location ] [-Tag ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a new CommunicationService or update an existing CommunicationService. + +## EXAMPLES + +### Example 1: Create a ACS resource +```powershell +New-AzCommunicationService -ResourceGroupName ContosoResourceProvider1 -Name ContosoAcsResource1 -DataLocation UnitedStates -Location Global +``` + +```output +Location Name Type AzureAsyncOperation +-------- ---- ---- ------------------- +Global ContosoAcsResource1 Microsoft.Communication/communicationServices +``` + +Creates a ACS resource using the specified parameters. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataLocation +The location where the communication service stores its data at rest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The Azure location where the CommunicationService is running. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the CommunicationService resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CommunicationServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags of the service which is a list of key value pairs that describe the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20200820.ICommunicationServiceResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Communication/New-AzCommunicationServiceKey.md b/azps-10.1.0/Az.Communication/New-AzCommunicationServiceKey.md new file mode 100644 index 0000000000..73d4e3c5c6 --- /dev/null +++ b/azps-10.1.0/Az.Communication/New-AzCommunicationServiceKey.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.Communication +online version: https://learn.microsoft.com/powershell/module/az.communication/new-azcommunicationservicekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/New-AzCommunicationServiceKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/New-AzCommunicationServiceKey.md +--- + +# New-AzCommunicationServiceKey + +## SYNOPSIS +Regenerate CommunicationService access key. +PrimaryKey and SecondaryKey cannot be regenerated at the same time. + +## SYNTAX + +### RegenerateExpanded (Default) +``` +New-AzCommunicationServiceKey -CommunicationServiceName -ResourceGroupName + [-SubscriptionId ] [-KeyType ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### Regenerate +``` +New-AzCommunicationServiceKey -CommunicationServiceName -ResourceGroupName + -Parameter [-SubscriptionId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### RegenerateViaIdentity +``` +New-AzCommunicationServiceKey -InputObject -Parameter + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### RegenerateViaIdentityExpanded +``` +New-AzCommunicationServiceKey -InputObject [-KeyType ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Regenerate CommunicationService access key. +PrimaryKey and SecondaryKey cannot be regenerated at the same time. + +## EXAMPLES + +### Example 1: Regenerates the Primary key using a IRegenerateKeyParameters hashtable +```powershell +New-AzCommunicationServiceKey -CommunicationServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -Parameter @{KeyType="Primary"} +``` + +```output +PrimaryConnectionString PrimaryKey +----------------------- ---------- +endpoint= +``` + +Invalidates the previous Primary key, regenerate a new one and return it. + +### Example 2: Regenerates the Secondary key using a KeyType +```powershell +New-AzCommunicationServiceKey -CommunicationServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -KeyType Secondary +``` + +```output +SecondaryConnectionString SecondaryKey +----------------------- ---------- +endpoint= +``` + +Invalidates the previous Secondary key, regenerate a new one and return it. + +## PARAMETERS + +### -CommunicationServiceName +The name of the CommunicationService resource. + +```yaml +Type: System.String +Parameter Sets: Regenerate, RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationIdentity +Parameter Sets: RegenerateViaIdentity, RegenerateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyType +The keyType to regenerate. +Must be either 'primary' or 'secondary'(case-insensitive). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Support.KeyType +Parameter Sets: RegenerateExpanded, RegenerateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Parameters describes the request to regenerate access keys +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20200820.IRegenerateKeyParameters +Parameter Sets: Regenerate, RegenerateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Regenerate, RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Regenerate, RegenerateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20200820.IRegenerateKeyParameters + +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20200820.ICommunicationServiceKeys + +## 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 + - `[CommunicationServiceName ]`: The name of the CommunicationService resource. + - `[Id ]`: Resource identity path + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + +PARAMETER ``: Parameters describes the request to regenerate access keys + - `[KeyType ]`: The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive). + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Communication/Remove-AzCommunicationService.md b/azps-10.1.0/Az.Communication/Remove-AzCommunicationService.md new file mode 100644 index 0000000000..ba6e3f05b2 --- /dev/null +++ b/azps-10.1.0/Az.Communication/Remove-AzCommunicationService.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.Communication +online version: https://learn.microsoft.com/powershell/module/az.communication/remove-azcommunicationservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Remove-AzCommunicationService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Remove-AzCommunicationService.md +--- + +# Remove-AzCommunicationService + +## SYNOPSIS +Operation to delete a CommunicationService. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCommunicationService -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzCommunicationService -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Operation to delete a CommunicationService. + +## EXAMPLES + +### Example 1: Remove the specified Azure Communication resource +```powershell +Remove-AzCommunicationService -Name ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 +``` + +Remove / Delete the Azure Communication resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the CommunicationService resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CommunicationServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT ``: Identity Parameter + - `[CommunicationServiceName ]`: The name of the CommunicationService resource. + - `[Id ]`: Resource identity path + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Communication/Set-AzCommunicationServiceNotificationHub.md b/azps-10.1.0/Az.Communication/Set-AzCommunicationServiceNotificationHub.md new file mode 100644 index 0000000000..f77d5e905c --- /dev/null +++ b/azps-10.1.0/Az.Communication/Set-AzCommunicationServiceNotificationHub.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.Communication +online version: https://learn.microsoft.com/powershell/module/az.communication/set-azcommunicationservicenotificationhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Set-AzCommunicationServiceNotificationHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Set-AzCommunicationServiceNotificationHub.md +--- + +# Set-AzCommunicationServiceNotificationHub + +## SYNOPSIS +Links an Azure Notification Hub to this communication service. + +## SYNTAX + +### LinkExpanded (Default) +``` +Set-AzCommunicationServiceNotificationHub -CommunicationServiceName -ResourceGroupName + -ConnectionString -NotificationHubResourceId [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### Link +``` +Set-AzCommunicationServiceNotificationHub -CommunicationServiceName -ResourceGroupName + -LinkNotificationHubParameter [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Links an Azure Notification Hub to this communication service. + +## EXAMPLES + +### Example 1: Provide Notification Hub details interactively +```powershell +Set-AzCommunicationServiceNotificationHub -CommunicationServiceName ContosoAcsResource2 -ResourceGroupName ContosoResourceProvider1 -ConnectionString "" -NotificationHubResourceId "" +``` + +A linked notification hub allows a ACS resource to send notifications for certain events. + +## PARAMETERS + +### -CommunicationServiceName +The name of the CommunicationService resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionString +Connection string for the notification hub + +```yaml +Type: System.String +Parameter Sets: LinkExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkNotificationHubParameter +Description of an Azure Notification Hub to link to the communication service +To construct, see NOTES section for LINKNOTIFICATIONHUBPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20200820.ILinkNotificationHubParameters +Parameter Sets: Link +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NotificationHubResourceId +The resource ID of the notification hub + +```yaml +Type: System.String +Parameter Sets: LinkExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20200820.ILinkNotificationHubParameters + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +LINKNOTIFICATIONHUBPARAMETER ``: Description of an Azure Notification Hub to link to the communication service + - `ConnectionString `: Connection string for the notification hub + - `ResourceId `: The resource ID of the notification hub + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Communication/Test-AzCommunicationServiceNameAvailability.md b/azps-10.1.0/Az.Communication/Test-AzCommunicationServiceNameAvailability.md new file mode 100644 index 0000000000..3718d7d243 --- /dev/null +++ b/azps-10.1.0/Az.Communication/Test-AzCommunicationServiceNameAvailability.md @@ -0,0 +1,146 @@ +--- +external help file: +Module Name: Az.Communication +online version: https://learn.microsoft.com/powershell/module/az.communication/test-azcommunicationservicenameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Test-AzCommunicationServiceNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Test-AzCommunicationServiceNameAvailability.md +--- + +# Test-AzCommunicationServiceNameAvailability + +## SYNOPSIS +Checks that the CommunicationService name is valid and is not already in use. + +## SYNTAX + +``` +Test-AzCommunicationServiceNameAvailability -Name [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Checks that the CommunicationService name is valid and is not already in use. + +## EXAMPLES + +### Example 1: Checks if already in use resource name ContosoAcsResource1 is available +```powershell +Test-AzCommunicationServiceNameAvailability -Name ContosoAcsResource1 +``` + +```output +Message NameAvailable Reason +------- ------------- ------ +Requested name is unavailable for the requested type False AlreadyExists +``` + +Verified that the CommunicationService name is valid and is not already in use. + +### Example 2: Checks if new resource name ContosoAcsResource2 is available +```powershell +Test-AzCommunicationServiceNameAvailability -Name ContosoAcsResource2 +``` + +```output +Message NameAvailable Reason +------- ------------- ------ +Requested name is available for the requested type True NameAvailable +``` + +Verified that the requested CommunicationService name already in use. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The CommunicationService name to validate. +e.g."my-CommunicationService-name-here" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20200820.INameAvailability + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Communication/Update-AzCommunicationService.md b/azps-10.1.0/Az.Communication/Update-AzCommunicationService.md new file mode 100644 index 0000000000..8af1b55774 --- /dev/null +++ b/azps-10.1.0/Az.Communication/Update-AzCommunicationService.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.Communication +online version: https://learn.microsoft.com/powershell/module/az.communication/update-azcommunicationservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Update-AzCommunicationService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Communication/help/Update-AzCommunicationService.md +--- + +# Update-AzCommunicationService + +## SYNOPSIS +Operation to update an existing CommunicationService. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCommunicationService -Name -ResourceGroupName [-SubscriptionId ] + [-DataLocation ] [-Location ] [-Tag ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCommunicationService -InputObject [-DataLocation ] + [-Location ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Operation to update an existing CommunicationService. + +## EXAMPLES + +### Example 1: Update an existing ACS resource to have tags +```powershell +Update-AzCommunicationService -Name ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -Tag @{ExampleKey1="ExampleValue1"} +``` + +```output +Location Name Type AzureAsyncOperation +-------- ---- ---- ------------------- +Global ContosoAcsResource1 Microsoft.Communication/communicationServices +``` + +Attaches the given tags to the specified ACS resource. + +## PARAMETERS + +### -DataLocation +The location where the communication service stores its data at rest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The Azure location where the CommunicationService is running. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the CommunicationService resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: CommunicationServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags of the service which is a list of key value pairs that describe the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20200820.ICommunicationServiceResource + +## 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 + - `[CommunicationServiceName ]`: The name of the CommunicationService resource. + - `[Id ]`: Resource identity path + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Compute/Add-AzImageDataDisk.md b/azps-10.1.0/Az.Compute/Add-AzImageDataDisk.md new file mode 100644 index 0000000000..f3db50fb74 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzImageDataDisk.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azimagedatadisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzImageDataDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzImageDataDisk.md +--- + +# Add-AzImageDataDisk + +## SYNOPSIS +Adds a data disk to an image object. + +## SYNTAX + +``` +Add-AzImageDataDisk [-Image] [[-Lun] ] [[-BlobUri] ] [[-Caching] ] + [-DiskSizeGB ] [-StorageAccountType ] [-SnapshotId ] [-ManagedDiskId ] + [-DiskEncryptionSetId ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The **Add-AzImageDataDisk** cmdlet adds a data disk to an image object. + +## EXAMPLES + +### Example 1 +```powershell +$imageConfig = New-AzImageConfig -Location 'West US'; +$osDiskVhdUri = "https://contoso.blob.core.windows.net/test/os.vhd" +$dataDiskVhdUri1 = "https://contoso.blob.core.windows.net/test/data1.vhd" +$dataDiskVhdUri2 = "https://contoso.blob.core.windows.net/test/data2.vhd" +Set-AzImageOsDisk -Image $imageConfig -OsType 'Windows' -OsState 'Generalized' -BlobUri $osDiskVhdUri; +Add-AzImageDataDisk -Image $imageConfig -Lun 1 -BlobUri $dataDiskVhdUri1; +Add-AzImageDataDisk -Image $imageConfig -Lun 2 -BlobUri $dataDiskVhdUri2; +New-AzImage -Image $imageConfig -ImageName 'ImageName01' -ResourceGroupName 'ResourceGroup01'; +``` + +The first command creates an image object, and then stores it in the $imageConfig variable. +The next three commands assign paths of operating system disk and two data disks to the $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2 variables. +This approach is only for readability of the following commands. +The next three commands each adds an operating system disk and two data disks to the image stored in $imageConfig. +The URI of each disk is stored in $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2. +The final command creates an image named ImageName01 in resource group ResourceGroup01. + +## PARAMETERS + +### -BlobUri +Specifies the link, as a URI, of the blob. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Caching +Specifies the caching mode of the disk. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.CachingTypes] +Parameter Sets: (All) +Aliases: +Accepted values: None, ReadOnly, ReadWrite + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of customer managed disk encryption set. This can only be specified for managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskSizeGB +Specifies the size of the disk in Gigabytes (GB). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Image +Specifies a local image object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSImage +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Lun +Specifies the logical unit number (LUN). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagedDiskId +Specifies the ID of a managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SnapshotId +Specifies the ID of a snapshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountType +The Storage Account type of the data image disk + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage + +### System.Int32 + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Add-AzVMAdditionalUnattendContent.md b/azps-10.1.0/Az.Compute/Add-AzVMAdditionalUnattendContent.md new file mode 100644 index 0000000000..b690efa65a --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVMAdditionalUnattendContent.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 50B64FFE-8277-4DAA-805A-271123B35355 +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmadditionalunattendcontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVMAdditionalUnattendContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVMAdditionalUnattendContent.md +--- + +# Add-AzVMAdditionalUnattendContent + +## SYNOPSIS +Adds information to the unattended Windows Setup answer file. + +## SYNTAX + +``` +Add-AzVMAdditionalUnattendContent [-VM] [[-Content] ] + [[-SettingName] ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The **Add-AzVMAdditionalUnattendContent** cmdlet adds information to the unattended Windows Setup answer file. +Specify additional base 64 encoded .xml formatted information that this cmdlet adds to the unattend.xml file. + +## EXAMPLES + +### Example 1: Add content to unattend.xml +```powershell +$AvailabilitySet = Get-AzAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id +$Credential = Get-Credential +$VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName "Contoso26" -Credential $Credential +$AucContent = "" + "Password" + "true</PlainText></AdministratorPassword></UserAccounts>"; +$VirtualMachine = Add-AzVMAdditionalUnattendContent -VM $VirtualMachine -Content $AucContent -SettingName "AutoLogon" +``` + +The first command gets the availability set named AvailabilitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. +The second command creates a virtual machine object, and then stores it in the $VirtualMachine variable. +The command assigns a name and size to the virtual machine. +The virtual machine belongs to the availability set stored in $AvailabilitySet. +The third command creates a credential object by using the Get-Credential cmdlet, and then stores the result in the $Credential variable. +The command prompts you for a user name and password. +For more information, type `Get-Help Get-Credential`. +The fourth command uses the **Set-AzVMOperatingSystem** cmdlet to configure the virtual machine stored in $VirtualMachine. +The fifth command assigns content to the $AucContent variable. +The content includes a password. +The final command adds the content stored in $AucContent to the unattend.xml file. + +## PARAMETERS + +### -Content +Specifies base 64 encoded XML formatted content. +This cmdlet adds the content to the unattend.xml file. +The XML content must be less than 4 KB and must include the root element for the setting or feature that this cmdlet inserts. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SettingName +Specifies the name of the setting to which the content applies. +The acceptable values for this parameter are: +- FirstLogonCommands +- AutoLogon + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.SettingNames] +Parameter Sets: (All) +Aliases: +Accepted values: AutoLogon, FirstLogonCommands + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine object that this cmdlet modifies. +To obtain a virtual machine object, use the [Get-AzVM](./Get-AzVM.md) cmdlet. +Create a virtual machine object by using the [New-AzVMConfig](./New-AzVMConfig.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.SettingNames, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[Get-AzAvailabilitySet](./Get-AzAvailabilitySet.md) + +[Set-AzVMOperatingSystem](./Set-AzVMOperatingSystem.md) + +[New-AzVMConfig](./New-AzVMConfig.md) diff --git a/azps-10.1.0/Az.Compute/Add-AzVMDataDisk.md b/azps-10.1.0/Az.Compute/Add-AzVMDataDisk.md new file mode 100644 index 0000000000..2a327ecee6 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVMDataDisk.md @@ -0,0 +1,362 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 169E6694-82CD-4FCB-AB3D-E8A74001B8DB +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmdatadisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVMDataDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVMDataDisk.md +--- + +# Add-AzVMDataDisk + +## SYNOPSIS +Adds a data disk to a virtual machine. + +## SYNTAX + +### VmNormalDiskParameterSetName (Default) +``` +Add-AzVMDataDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] [[-Caching] <CachingTypes>] + [[-DiskSizeInGB] <Int32>] [-Lun] <Int32> [-CreateOption] <String> [[-SourceImageUri] <String>] + [-DiskEncryptionSetId <String>] [-DeleteOption <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### VmManagedDiskParameterSetName +``` +Add-AzVMDataDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-Caching] <CachingTypes>] + [[-DiskSizeInGB] <Int32>] [-Lun] <Int32> [-CreateOption] <String> [[-ManagedDiskId] <String>] + [[-StorageAccountType] <String>] [-DiskEncryptionSetId <String>] [-WriteAccelerator] [-DeleteOption <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVMDataDisk** cmdlet adds a data disk to a virtual machine. +You can add a data disk when you create a virtual machine, or you can add a data disk to an existing virtual machine. + +## EXAMPLES + +### Example 1: Add data disks to a new virtual machine +```powershell +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" +$DataDiskVhdUri01 = "https://contoso.blob.core.windows.net/test/data1.vhd" +$DataDiskVhdUri02 = "https://contoso.blob.core.windows.net/test/data2.vhd" +$DataDiskVhdUri03 = "https://contoso.blob.core.windows.net/test/data3.vhd" +$VirtualMachine = Add-AzVMDataDisk -VM $VirtualMachine -Name 'DataDisk1' -Caching 'ReadOnly' -DiskSizeInGB 10 -Lun 0 -VhdUri $DataDiskVhdUri01 -CreateOption Empty +$VirtualMachine = Add-AzVMDataDisk -VM $VirtualMachine -Name 'DataDisk2' -Caching 'ReadOnly' -DiskSizeInGB 11 -Lun 1 -VhdUri $DataDiskVhdUri02 -CreateOption Empty +$VirtualMachine = Add-AzVMDataDisk -VM $VirtualMachine -Name 'DataDisk3' -Caching 'ReadOnly' -DiskSizeInGB 12 -Lun 2 -VhdUri $DataDiskVhdUri03 -CreateOption Empty +``` + +The first command creates a virtual machine object, and then stores it in the $VirtualMachine variable. +The command assigns a name and size to the virtual machine. +The next three commands assign paths of three data disks to the $DataDiskVhdUri01, $DataDiskVhdUri02, and $DataDiskVhdUri03 variables. +This approach is only for readability of the following commands. +The final three commands each adds a data disk to the virtual machine stored in $VirtualMachine. +The command specifies the name and location for the disk, and other properties of the disk. +The URI of each disk is stored in $DataDiskVhdUri01, $DataDiskVhdUri02, and $DataDiskVhdUri03. + +### Example 2: Add a data disk to an existing virtual machine +```powershell +$VirtualMachine = Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" +Add-AzVMDataDisk -VM $VirtualMachine -Name "disk1" -VhdUri "https://contoso.blob.core.windows.net/vhds/diskstandard03.vhd" -LUN 0 -Caching ReadOnly -DiskSizeinGB 1 -CreateOption Empty +Update-AzVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine +``` + +The first command gets the virtual machine named VirtualMachine07 by using the [Get-AzVM](./Get-AzVM.md) cmdlet. +The command stores the virtual machine in the $VirtualMachine variable. +The second command adds a data disk to the virtual machine stored in $VirtualMachine. +The final command updates the state of the virtual machine stored in $VirtualMachine in ResourceGroup11. + +### Example 3: Add a data disk to a new virtual machine from a generalized user image +```powershell +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" +$DataImageUri = "https://contoso.blob.core.windows.net/system/Microsoft.Compute/Images/captured/dataimage.vhd" +$DataDiskUri = "https://contoso.blob.core.windows.net/test/datadisk.vhd" +$VirtualMachine = Add-AzVMDataDisk -VM $VirtualMachine -Name "disk1" -SourceImageUri $DataImageUri -VhdUri $DataDiskUri -Lun 0 -DiskSizeinGB 10 -CreateOption FromImage +``` + +The first command creates a virtual machine object and stores it in the $VirtualMachine variable. +The command assigns a name and size to the virtual machine. +The next two commands assign paths for the data image and data disks to the $DataImageUri and $DataDiskUri variables respectively. +This approach is used to improve the readability of the following commands. +The final commands adds a data disk to the virtual machine stored in $VirtualMachine. +The command specifies the name and location for the disk and other properties of the disk. + +### Example 4: Add data disks to a new virtual machine from a specialized user image +```powershell +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" +$DataDiskUri = "https://contoso.blob.core.windows.net/test/datadisk.vhd" +$VirtualMachine = Add-AzVMDataDisk -VM $VirtualMachine -Name "dd1" -VhdUri $DataDiskUri -Lun 0 -DiskSizeinGB 10 -CreateOption Attach +``` + +The first command creates a virtual machine object and stores it in the $VirtualMachine variable. +The command assigns a name and size to the virtual machine. +The next commands assigns paths of the data disk to the $DataDiskUri variable. +This approach is used to improve the readability of the following commands. +The final command add a data disk to the virtual machine stored in $VirtualMachine. +The command specifies the name and location for the disk, and other properties of the disk. + +## PARAMETERS + +### -Caching +Specifies the caching mode of the disk. +The acceptable values for this parameter are: +- ReadOnly +- ReadWrite +- None +The default value is ReadWrite. +Changing this value causes the virtual machine to restart. +This setting affects the consistency and performance of the disk. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.CachingTypes +Parameter Sets: (All) +Aliases: +Accepted values: None, ReadOnly, ReadWrite + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CreateOption +Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, creates an empty disk, or attaches an existing disk. +The acceptable values for this parameter are: +- Attach. +Specify this option to create a virtual machine from a specialized disk. +When you specify this option, do not specify the *SourceImageUri* parameter. +The *VhdUri* is all that is needed in order to tell the Azure platform the location of the virtual hard disk (VHD) to attach as a data disk to the virtual machine. +- Empty. +Specify this to create an empty data disk. +- FromImage. +Specify this option to create a virtual machine from a generalized image or disk. +When you specify this option, you must specify the *SourceImageUri* parameter also in order to tell the Azure platform the location of the VHD to attach as a data disk. +The *VhdUri* parameter is used as the location identifying where the data disk VHD will be stored when it is used by the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteOption +Data Disk Delete Option. Specifies what action to perform on the disk after VM deletion. Options are: Detach, Delete. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of customer managed disk encryption set. This can only be specified for managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskSizeInGB +Specifies the size, in gigabytes, of an empty disk to attach to a virtual machine. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Lun +Specifies the logical unit number (LUN) for a data disk. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagedDiskId +Specifies the ID of a managed disk. + +```yaml +Type: System.String +Parameter Sets: VmManagedDiskParameterSetName +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the data disk to add. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceImageUri +Specifies the source URI of the disk that this cmdlet attaches. + +```yaml +Type: System.String +Parameter Sets: VmNormalDiskParameterSetName +Aliases: SourceImage + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountType +Specifies the storage account type of managed disk. + +```yaml +Type: System.String +Parameter Sets: VmManagedDiskParameterSetName +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VhdUri +Specifies the Uniform Resource Identifier (URI) for the virtual hard disk (VHD) file to create when a platform image or user image is used. +This cmdlet copies the image binary large object (blob) to this location. +This is the location from which to start the virtual machine. + +```yaml +Type: System.String +Parameter Sets: VmNormalDiskParameterSetName +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +Specifies the local virtual machine object to which to add a data disk. +You can use the **Get-AzVM** cmdlet to obtain a virtual machine object. +You can use the **New-AzVMConfig** cmdlet to create a virtual machine object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WriteAccelerator +Specifies whether WriteAccelerator should be enabled or disabled on a managed data disk. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: VmManagedDiskParameterSetName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.String + +### Microsoft.Azure.Management.Compute.Models.CachingTypes + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM + +## NOTES + +## RELATED LINKS + +[Remove-AzVMDataDisk](./Remove-AzVMDataDisk.md) + +[Get-AzVM](./Get-AzVM.md) + +[New-AzVMConfig](./New-AzVMConfig.md) diff --git a/azps-10.1.0/Az.Compute/Add-AzVMNetworkInterface.md b/azps-10.1.0/Az.Compute/Add-AzVMNetworkInterface.md new file mode 100644 index 0000000000..c994774996 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVMNetworkInterface.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: BF80D456-DAB1-4B51-B50F-A75C2C66A472 +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmnetworkinterface +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVMNetworkInterface.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVMNetworkInterface.md +--- + +# Add-AzVMNetworkInterface + +## SYNOPSIS +Adds a network interface to a virtual machine. + +## SYNTAX + +### GetNicFromNicId (Default) +``` +Add-AzVMNetworkInterface [-VM] <PSVirtualMachine> [-Id] <String> [-Primary] [-DeleteOption <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetNicFromNicObject +``` +Add-AzVMNetworkInterface [-VM] <PSVirtualMachine> + [-NetworkInterface] <System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.INetworkInterfaceReference]> + [-DeleteOption <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVMNetworkInterface** cmdlet adds a network interface to a virtual machine. +You can add an interface when you create a virtual machine or add one to an existing virtual machine. + +## EXAMPLES + +### Example 1: Add a network interface to a new virtual machine +```powershell +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" +Add-AzVMNetworkInterface -VM $VirtualMachine -Id "/subscriptions/46fc8ea4-2de6-4179-8ab1-365da4121af4/resourceGroups/contoso/providers/Microsoft.Network/networkInterfaces/sshNIC" +``` + +The first command creates a virtual machine object, and then stores it in the $VirtualMachine variable. +The command assigns a name and size to the virtual machine. +The second command adds a network interface to the virtual machine stored in $VirtualMachine. + +### Example 2: Add a network interface to an existing virtual machine +```powershell +$VirtualMachine = Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" +Add-AzVMNetworkInterface -VM $VirtualMachine -Id "/subscriptions/46fc8ea4-2de6-4179-8ab1-365da4121af4/resourceGroups/contoso/providers/Microsoft.Network/networkInterfaces/sshNIC" +Update-AzVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine +``` + +The first command gets the virtual machine named VirtualMachine07 by using the **Get-AzVM** cmdlet. +The command stores the virtual machine in the $VirtualMachine variable. +The second command adds a network interface to the virtual machine stored in $VirtualMachine. +The final command updates the state of the virtual machine stored in $VirtualMachine in ResourceGroup11. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteOption +Specifies Network Interface delete option after VM deletion. Options are Detach, Delete + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of a network interface to add to a virtual machine. +You can use the [Get-AzNetworkInterface](/powershell/module/az.network/get-aznetworkinterface) cmdlet to obtain a network interface. + +```yaml +Type: System.String +Parameter Sets: GetNicFromNicId +Aliases: NicId, NetworkInterfaceId + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkInterface +Specifies the network interface. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.INetworkInterfaceReference] +Parameter Sets: GetNicFromNicObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Primary +Indicates that this cmdlet adds the network interface as the primary interface. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetNicFromNicId +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +Specifies a local virtual machine object to which to add a network interface. +To create a virtual machine, use the **New-AzVMConfig** cmdlet. +To obtain an existing virtual machine, use the **Get-AzVM** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.String + +### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Internal.Network.Common.INetworkInterfaceReference, Microsoft.Azure.PowerShell.Clients.Network, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[New-AzVMConfig](./New-AzVMConfig.md) + +[Get-AzVM](./Get-AzVM.md) + +[Get-AzAvailabilitySet](./Get-AzAvailabilitySet.md) diff --git a/azps-10.1.0/Az.Compute/Add-AzVMSecret.md b/azps-10.1.0/Az.Compute/Add-AzVMSecret.md new file mode 100644 index 0000000000..c4791f35fd --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVMSecret.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 5008F83F-AF3E-47CF-99A3-55129E654128 +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVMSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVMSecret.md +--- + +# Add-AzVMSecret + +## SYNOPSIS +Adds a secret to a virtual machine. + +## SYNTAX + +``` +Add-AzVMSecret [-VM] <PSVirtualMachine> [[-SourceVaultId] <String>] [[-CertificateStore] <String>] + [[-CertificateUrl] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION + +The **Add-AzVMSecret** cmdlet adds a secret to a virtual machine. +This value lets you add a certificate to the virtual machine. +The secret must be stored in a Key Vault. +For more information about Key Vault, see [What is Azure Key Vault?](https://azure.microsoft.com/documentation/articles/key-vault-whatis/). +For more information about the cmdlets, see [Azure Key Vault Cmdlets](/powershell/module/az.keyvault) or the [Set-AzKeyVaultSecret](/powershell/module/az.keyvault/set-azkeyvaultsecret) cmdlet. + +> [!NOTE] +> To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows) instead of `Add-AzVMSecret`. + +## EXAMPLES + +### Example: Add a secret to a virtual machine using Add-AzVMSecret +```powershell +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id +$Credential = Get-Credential +$VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName "Contoso26" -Credential $Credential +$SourceVaultId = "/subscriptions/46f8cea4-2de6-4179-8ab1-365da4211af4/resourceGroups/vault/providers/Microsoft.KeyVault/vaults/keyvault" +$CertificateStore01 = "My" +$CertificateUrl01 = "https://contosovault.vault.azure.net/secrets/514ceb769c984379a7e0230bdd703272" +$VirtualMachine = Add-AzVMSecret -VM $VirtualMachine -SourceVaultId $SourceVaultId -CertificateStore $CertificateStore01 -CertificateUrl $CertificateUrl01 +``` + +The first command creates a virtual machine object, and then stores it in the $VirtualMachine variable. +The command assigns a name and size to the virtual machine. +The second command creates a credential object by using the Get-Credential cmdlet, and then stores the result in the $Credential variable. +The command prompts you for a user name and password. +For more information, type `Get-Help Get-Credential`. +The third command uses the **Set-AzVMOperatingSystem** cmdlet to configure the virtual machine stored in $VirtualMachine. +The fourth command assigns a source vault ID to the $SourceVaultId variable for later use. +The command assumes that the $SubscriptionId variable has an appropriate value. +The fifth command assigns a value to the $CertificateStore01 variable for later use. +The sixth command assigns a URL for a certificate store. +The seventh command adds a secret to the virtual machine stored in $VirtualMachine. +The SourceVaultId parameter specifies the Key Vault. +The command specifies the name of the certificate store and the URL of the certificate. +You can run the **Add-AzVMSecret** repeatedly to add secrets for other certificates. + +## PARAMETERS + +### -CertificateStore +Specifies the name of a certificate store on the virtual machine that runs the Windows operating system. +This cmdlet adds the certificate to the store that this parameter specifies. +You can only specify this parameter for virtual machines that run the Windows operating system. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CertificateUrl +Specifies the URL that points to a Key Vault secret which contains a certificate. +The certificate is the Base64 encoding of the following JavaScript Object Notation (JSON) object, which is encoded in UTF-8: +{ +"data": "\<Base64-encoded-file\>", +"dataType": "\<file-format\>", +"password": "\<pfx-file-password\>" +} +Currently, dataType accepts only .pfx files. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceVaultId +Specifies the resource ID of the Key Vault that contains the certificates that you can add to the virtual machine. +This value also acts as the key for adding multiple certificates. +This means that you can use the same value for *SourceVaultId* when you add multiple certificates from the same Key Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Id + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine object that this cmdlet modifies. +To obtain a virtual machine object, use the [Get-AzVM](./Get-AzVM.md) cmdlet. +You can use the [New-AzVMConfig](./New-AzVMConfig.md) cmdlet to create a virtual machine object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[New-AzVMConfig](./New-AzVMConfig.md) + +[Set-AzVMOperatingSystem](./Set-AzVMOperatingSystem.md) diff --git a/azps-10.1.0/Az.Compute/Add-AzVMSshPublicKey.md b/azps-10.1.0/Az.Compute/Add-AzVMSshPublicKey.md new file mode 100644 index 0000000000..7fd79b07a3 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVMSshPublicKey.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 3CE367B1-7685-4046-8E9C-CE680B5AE03F +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmsshpublickey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVMSshPublicKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVMSshPublicKey.md +--- + +# Add-AzVMSshPublicKey + +## SYNOPSIS +Adds the public keys for SSH for a virtual machine, when only creating the VM. + +## SYNTAX + +``` +Add-AzVMSshPublicKey [-VM] <PSVirtualMachine> [[-KeyData] <String>] [[-Path] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVMSshPublicKey** cmdlet adds the public keys that you can use to connect to a Linux virtual machine over Secure Shell (SSH). This cannot be used after VM creation, if you try to use this after VM creation without Update-AzVM, there will be no error, if you use the command with Update-AzVM, the command will error. + +## EXAMPLES + +### Example 1: Add a public key to a virtual machine +```powershell +$VirtualMachine = Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" +$VirtualMachine = Add-AzVMSshPublicKey -VM $VirtualMachine -KeyData "MIIDszCCApugAwIBAgIJALBV9YJCF/tAMA0GCSq12Ib3DQEB21QUAMEUxCzAJBgNV" -Path "/home/admin/.ssh/authorized_keys" +``` + +The first command gets the virtual machine named VirtualMachine07 by using the **Get-AzVM** cmdlet. +The command stores the virtual machine in the $VirtualMachine variable. +The second command adds the public key to the location on VirtualMachine07 that the Path parameter specifies. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyData +Specifies a base 64 encoding of a public key. +You can connect to a Linux virtual machine by using SSH or by using the key that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the full path of a file, on the virtual machine, where this cmdlet stores the SSH public key. +If the file already exists, this cmdlet appends the key to the file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine object that this cmdlet modifies. +To obtain a virtual machine object, use the [Get-AzVM](./Get-AzVM.md) cmdlet. +You can use the [New-AzVMConfig](./New-AzVMConfig.md) cmdlet to create a virtual machine object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[New-AzVMConfig](./New-AzVMConfig.md) diff --git a/azps-10.1.0/Az.Compute/Add-AzVhd.md b/azps-10.1.0/Az.Compute/Add-AzVhd.md new file mode 100644 index 0000000000..738d0f6744 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVhd.md @@ -0,0 +1,368 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: D08DAA8B-B7BF-4167-AB16-F2723985A0B7 +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvhd +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVhd.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVhd.md +--- + +# Add-AzVhd + +## SYNOPSIS +Uploads a virtual hard disk from an on-premises machine to Azure (managed disk or blob). + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Add-AzVhd [-ResourceGroupName] <String> [-Destination] <Uri> [-LocalFilePath] <FileInfo> + [[-NumberOfUploaderThreads] <Int32>] [[-BaseImageUriToPatch] <Uri>] [-OverWrite] [-SkipResizing] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DirectUploadToManagedDiskSet +``` +Add-AzVhd [-ResourceGroupName] <String> [-LocalFilePath] <FileInfo> -DiskName <String> [-Location] <String> + [-DiskSku <String>] [-DiskZone <String[]>] [-DiskHyperVGeneration <String>] + [-DiskOsType <OperatingSystemTypes>] [[-NumberOfUploaderThreads] <Int32>] [-DataAccessAuthMode <String>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVhd** cmdlet uploads an on-premise virtual hard disk to a managed disk or a blob storage account.<br/> + +The virtual hard disk being uploaded needs to be a .vhd file and in size N * Mib + 512 bytes. Using [Hyper-V](https://learn.microsoft.com/en-us/windows-server/virtualization/hyper-v/hyper-v-technology-overview) +functionality, **Add-AzVhd** will convert any .vhdx file to a .vhd file and resize before uploading. +To allow this functionality, you will need to [enable Hyper-V](https://learn.microsoft.com/en-us/windows-server/virtualization/hyper-v/get-started/install-the-hyper-v-role-on-windows-server). +If you are using a Linux machine or choose to not use this functionality, you will need to [resize the VHD file manually](https://learn.microsoft.com/en-us/azure/virtual-machines/linux/create-upload-generic?branch=pr-en-us-185925#resizing-vhds). +Additionally, **Add-AzVhd** will convert dynamically sized VHD files to fixed size during upload. Use `-Verbose` to follow all the process. + +For Default Parameter set (upload to blob), also supported is the ability to upload a patched version of an on-premises .vhd file. +When a base virtual hard disk has already been uploaded, you can upload differencing disks that use the base image as the parent. +Shared access signature (SAS) URI is supported also. <br/> + +For Direct Upload to Managed Disk Parameter set, parameters: ResourceGroupName, DiskName, Location, DiskSku, and Zone will be used to +create a new disk, then the virtual hard disk will be uploaded to it. <br/> + +More information on [using Add-AzVhd to directly upload to a managed disk](https://learn.microsoft.com/en-us/azure/virtual-machines/windows/disks-upload-vhd-to-managed-disk-powershell#use-add-azvhd). + +For VHD files greater than 50 GB, we recommend using [AzCopy](https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azcopy-v10?toc=/azure/storage/blobs/toc.json) for faster upload. + +## EXAMPLES + +### Example 1: Add a VHD file to a blob +```powershell +Add-AzVhd -Destination "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" +``` + +This command adds a .vhd file to a storage account. + +### Example 2: Add a VHD file to a blob and overwrite the destination +```powershell +Add-AzVhd -Destination "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -Overwrite +``` + +This command adds a .vhd file to a storage account. +The command overwrites an existing file. + +### Example 3: Add a VHD file to a blob with number of threads specified +```powershell +Add-AzVhd -Destination "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -NumberOfUploaderThreads 32 +``` + +This command adds a .vhd file to a storage account. +The command specifies the number of threads to use to upload the file. + +### Example 4: Add a VHD file to a blob and specify the SAS URI +```powershell +Add-AzVhd -Destination "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd?st=2013-01 -09T22%3A15%3A49Z&amp;se=2013-01-09T23%3A10%3A49Z&amp;sr=b&amp;sp=w&amp;sig=13T9Ow%2FRJAMmhfO%2FaP3HhKKJ6AY093SmveO SIV4%2FR7w%3D" -LocalFilePath "C:\vhd\win7baseimage.vhd" +``` + +This command adds a .vhd file to a storage account and specifies the SAS URI. + +### Example 5: Add a VHD file directly to a managed disk. +```powershell +Add-AzVhd -LocalFilePath C:\data.vhd -ResourceGroupName rgname -Location eastus -DiskName newDisk +``` + +This command create a managed disk with given ResourceGroupName, Location, and DiskName; and uploads the VHD file to it. + +### Example 6: Add a VHD file directly to a more configured disk. +```powershell +Add-AzVhd -LocalFilePath C:\Data.vhdx -ResourceGroupName rgname -Location eastus -DiskName newDisk -Zone 1 -DiskSku Premium_LRS +``` + +This command will tried to convert vhdx file to vhd file first using Hyper-V. If Hyper-V is not found, it will return an error asking to use a vhd file. After successful conversion, it will create a managed disk with provided parameters, then upload the vhd file. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BaseImageUriToPatch +Specifies the URI to a base image blob in Azure Blob Storage. +An SAS can be specified as the value for this parameter. + +```yaml +Type: System.Uri +Parameter Sets: DefaultParameterSet +Aliases: bs + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataAccessAuthMode +Additional authentication requirements when exporting or uploading to a disk or snapshot. Possible options are: "AzureActiveDirectory" and "None". + +```yaml +Type: System.String +Parameter Sets: DirectUploadToManagedDiskSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +Specifies the URI of a blob in Blob Storage. +The parameter supports SAS URI, although patching scenarios destination cannot be an SAS URI. + +```yaml +Type: System.Uri +Parameter Sets: DefaultParameterSet +Aliases: dst + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskHyperVGeneration +The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Posssible values are: 'V1', 'V2'. + +```yaml +Type: System.String +Parameter Sets: DirectUploadToManagedDiskSet +Aliases: HyperVGeneration + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskName +Name of the new managed Disk + +```yaml +Type: System.String +Parameter Sets: DirectUploadToManagedDiskSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskOsType +The Operating System type of the managed disk. Possible values are: 'Windows', 'Linux'. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes +Parameter Sets: DirectUploadToManagedDiskSet +Aliases: OsType +Accepted values: Windows, Linux + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskSku +Sku for managed disk. Options: Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS + +```yaml +Type: System.String +Parameter Sets: DirectUploadToManagedDiskSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskZone +The Logical zone list for Disk. + +```yaml +Type: System.String[] +Parameter Sets: DirectUploadToManagedDiskSet +Aliases: Zone + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LocalFilePath +Specifies the path of the local .vhd file. + +```yaml +Type: System.IO.FileInfo +Parameter Sets: (All) +Aliases: lf + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Location of new Managed Disk + +```yaml +Type: System.String +Parameter Sets: DirectUploadToManagedDiskSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NumberOfUploaderThreads +Specifies the number of uploader threads to be used when uploading the .vhd file. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: th + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OverWrite +Indicates that this cmdlet overwrites an existing blob in the specified destination URI, if one exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultParameterSet +Aliases: o + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipResizing +Skips the resizing of the VHD file. +Users that wish to upload a VHD files that has its size misaligned (not N * Mib + 512 bytes) to a blob can use this switch parameter. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Uri + +### System.IO.FileInfo + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.VhdUploadContext + +## NOTES + +## RELATED LINKS + +[Save-AzVhd](./Save-AzVhd.md) diff --git a/azps-10.1.0/Az.Compute/Add-AzVmGalleryApplication.md b/azps-10.1.0/Az.Compute/Add-AzVmGalleryApplication.md new file mode 100644 index 0000000000..06e23bc420 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVmGalleryApplication.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmgalleryapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmGalleryApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmGalleryApplication.md +--- + +# Add-AzVmGalleryApplication + +## SYNOPSIS +Add a GalleryApplication object to the PSVirtualMachine object. + +## SYNTAX + +``` +Add-AzVmGalleryApplication -VM <PSVirtualMachine> -GalleryApplication <PSVMGalleryApplication> [-Order <Int32>] + [-TreatFailureAsDeploymentFailure] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Adds a GalleryApplication object to the PSVirtualMachine object. + +## EXAMPLES + +### Example 1 +```powershell +$vm = Get-AzVM -ResourceGroupName $rgName -Name $vmName +$vmGal = New-AzVmGalleryApplication -PackageReferenceId $packageRefId -ConfigReferenceId $configRefId +Add-AzVmGalleryApplication -VM $vm -GalleryApplication $vmGal -Order 1 +``` + +This example creates a local VMGalleryApplication object and adds it to a PSVirtualMachine object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryApplication +PSVMGalleryApplication Object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVMGalleryApplication +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +Order in which the application will be install in. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TreatFailureAsDeploymentFailure +If true, any failure for any operation in the VmApplication will fail the deployment. Defaults to false if not specified. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +The PSVirtualMachine object to add a Gallery Application Reference ID. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Add-AzVmssAdditionalUnattendContent.md b/azps-10.1.0/Az.Compute/Add-AzVmssAdditionalUnattendContent.md new file mode 100644 index 0000000000..fbc98756aa --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVmssAdditionalUnattendContent.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 9BE2E42C-594B-4B67-866C-BBA3B84AA5FD +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmssadditionalunattendcontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssAdditionalUnattendContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssAdditionalUnattendContent.md +--- + +# Add-AzVmssAdditionalUnattendContent + +## SYNOPSIS +Adds information to the unattended Windows Setup answer file. + +## SYNTAX + +``` +Add-AzVmssAdditionalUnattendContent [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> + [[-PassName] <PassNames>] [[-ComponentName] <ComponentNames>] [[-SettingName] <SettingNames>] + [[-Content] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVmssAdditionalUnattendContent** cmdlet adds information to the unattended Windows Setup answer file. + +## EXAMPLES + +### Example 1: Add information to the unattended Windows Setup answer file +```powershell +Add-AzVmssAdditionalUnattendContent -VirtualMachineScaleSet $VMSS -ComponentName $AUCComponentName -Content $AUCContent -PassName $AUCPassName -SettingName $AUCSetting +``` + +This command adds information to the unattended Windows Setup answer file. + +## PARAMETERS + +### -ComponentName +Specifies the name of the component to configure with the added content. +The only allowable value is Microsoft-Windows-Shell-Setup. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.ComponentNames] +Parameter Sets: (All) +Aliases: +Accepted values: MicrosoftWindowsShellSetup + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Content +Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassName +Specifies the name of the pass that the content applies to. +The only allowable value is oobeSystem. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.PassNames] +Parameter Sets: (All) +Aliases: +Accepted values: OobeSystem + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SettingName +Specifies the name of the setting to which the content applies. +The acceptable values for this parameter are:: +- FirstLogonCommands +- AutoLogon + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.SettingNames] +Parameter Sets: (All) +Aliases: +Accepted values: AutoLogon, FirstLogonCommands + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specify the virtual machine **Scale Set** object. +You can use the [New-AzVmssConfig](./New-AzVmssConfig.md) cmdlet to create the object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.PassNames, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.ComponentNames, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.SettingNames, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[New-AzVmssConfig](./New-AzVmssConfig.md) diff --git a/azps-10.1.0/Az.Compute/Add-AzVmssDataDisk.md b/azps-10.1.0/Az.Compute/Add-AzVmssDataDisk.md new file mode 100644 index 0000000000..bbc7815561 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVmssDataDisk.md @@ -0,0 +1,291 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmssdatadisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssDataDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssDataDisk.md +--- + +# Add-AzVmssDataDisk + +## SYNOPSIS +Adds a data disk to the VMSS. + +## SYNTAX + +``` +Add-AzVmssDataDisk [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Name] <String>] [[-Lun] <Int32>] + [[-Caching] <CachingTypes>] [-WriteAccelerator] [-CreateOption <String>] [-DeleteOption <String>] + [-DiskSizeGB <Int32>] [-DiskIOPSReadWrite <Int64>] [-DiskMBpsReadWrite <Int64>] [-StorageAccountType <String>] + [-DiskEncryptionSetId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVmssDataDisk** cmdlet adds a data disk to the Virtual Machine Scale Set (VMSS) instance. + +## EXAMPLES + +### Example 1: Add a data disk +```powershell +$vmss = New-AzVmssConfig -Location $Loc -SkuCapacity 2 -SkuName "Standard_A0" -UpgradePolicyMode "Automatic" +$vmss = Add-AzVmssDataDisk -VirtualMachineScaleSet $vmss -Name 'DataDisk1' -Lun 0 -Caching 'ReadOnly' -CreateOption Empty -DiskSizeGB 10 -StorageAccountType Standard_LRS +``` + +This command adds an empty data disk to the VMSS object. + +## PARAMETERS + +### -Caching +Specifies the caching type of the disk. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.CachingTypes] +Parameter Sets: (All) +Aliases: +Accepted values: None, ReadOnly, ReadWrite + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CreateOption +Specifies the create option of the disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteOption +Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only) + +Accepted Values +Delete - If this value is used, the data disk is deleted when the VMSS Flex VM is deleted. +Detach - If this value is used, the data disk is retained after VMSS Flex VM is deleted. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of customer managed disk encryption set. This can only be specified for managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskIOPSReadWrite +Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskMBpsReadWrite +Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskSizeGB +Specifies the size of the disk in GB. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Lun +Specifies the logical unit number of the disk. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountType +Specifies the storage account type of the disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specify the VMSS object. +You can use the [New-AzVmssConfig](./New-AzVmssConfig.md) cmdlet to create the object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WriteAccelerator +Specifies whether WriteAccelerator should be enabled or disabled on the data disk. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.String + +### System.Int32 + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Add-AzVmssDiagnosticsExtension.md b/azps-10.1.0/Az.Compute/Add-AzVmssDiagnosticsExtension.md new file mode 100644 index 0000000000..06f64d3c82 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVmssDiagnosticsExtension.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 7A1B92F5-C698-4D5E-ACD7-4013F1BC6247 +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmssdiagnosticsextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssDiagnosticsExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssDiagnosticsExtension.md +--- + +# Add-AzVmssDiagnosticsExtension + +## SYNOPSIS +Adds a diagnostics extension to the VMSS. + +## SYNTAX + +``` +Add-AzVmssDiagnosticsExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-SettingFilePath] <String> + [[-ProtectedSettingFilePath] <String>] [[-Name] <String>] [[-TypeHandlerVersion] <String>] + [[-AutoUpgradeMinorVersion] <Boolean>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVmssDiagnosticsExtension** cmdlet adds a diagnostics extension to the Virtual Machine Scale Set (VMSS) instance. + +## EXAMPLES + +### Example 1: Add a diagnostics extension to the VMSS +```powershell +Add-AzVmssDiagnosticsExtension -VirtualMachineScaleSet $VMSS -SettingFilePath $publicConfigPath -ProtectedSettingFilePath $privateConfigPath -Name $extName -TypeHandlerVersion $typeVersion -AutoUpgradeMinorVersion $True -Force +``` + +This command adds a diagnostics extension to the VMSS. + +## PARAMETERS + +### -AutoUpgradeMinorVersion +Indicates whether this cmdlet allows the Azure guest agent to automatically update the extension to a newer minor version. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProtectedSettingFilePath +Specifies the path of the private configuration file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SettingFilePath +Specifies the path of the public configuration file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the extension to use for this VMSS. +To obtain the version, run the [Get-AzVMExtensionImage](./Get-AzVMExtensionImage.md) cmdlet with a value of Microsoft.Azure.Diagnostics for the *PublisherName* parameter and IaaSDiagnostics for the *Type* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HandlerVersion, Version + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specify the VMSS object. +You can use the [New-AzVmssConfig](./New-AzVmssConfig.md) cmdlet to create the object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.String + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[Add-AzVmssExtension](./Add-AzVmssExtension.md) + +[Remove-AzVmssDiagnosticsExtension](./Remove-AzVmssDiagnosticsExtension.md) + +[Set-AzVMDiagnosticsExtension](./Set-AzVMDiagnosticsExtension.md) diff --git a/azps-10.1.0/Az.Compute/Add-AzVmssExtension.md b/azps-10.1.0/Az.Compute/Add-AzVmssExtension.md new file mode 100644 index 0000000000..b8fff893f4 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVmssExtension.md @@ -0,0 +1,335 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 7EC166C7-151D-4DA0-9B10-165E735D4F12 +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmssextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssExtension.md +--- + +# Add-AzVmssExtension + +## SYNOPSIS +Adds an extension to the VMSS. + +## SYNTAX + +``` +Add-AzVmssExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Name] <String>] + [[-Publisher] <String>] [[-Type] <String>] [[-TypeHandlerVersion] <String>] + [[-AutoUpgradeMinorVersion] <Boolean>] [[-Setting] <Object>] [[-ProtectedSetting] <Object>] + [-EnableAutomaticUpgrade <Boolean>] [-ForceUpdateTag <String>] [-ProvisionAfterExtension <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVmssExtension** cmdlet adds an extension to the Virtual Machine Scale Set (VMSS). + +## EXAMPLES + +### Example 1: Add an extension to the VMSS +```powershell +Add-AzVmssExtension -VirtualMachineScaleSet $VMSS -Name $ExtName -Publisher $Publisher -Type $ExtType -TypeHandlerVersion $ExtVer -AutoUpgradeMinorVersion $True +``` + +This command adds an extension to the VMSS. + +### Example 2: Add an extension to the VMSS with settings and protected settings +```powershell +$Settings = @{"fileUris" = "[]"; "commandToExecute" = ""}; +$ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey}; + +Add-AzVmssExtension -VirtualMachineScaleSet $vmss -Name $vmssExtensionName -Publisher $vmssPublisher ` + -Type $vmssExtensionType -TypeHandlerVersion $ExtVer -AutoUpgradeMinorVersion $True ` + -Setting $Settings -ProtectedSetting $ProtectedSettings +``` + +### Example 3: Add an extension to the VMSS with settings and protected settings +```powershell +$BatchFile = "runbook.sh" +$ResourceGroupName = "HelloRG" +$VMScaleSetName = "HelloVmSS" +$TypeHandlerVersion = 2.1 + +#Best Practice for securd paramaters. +$protectedSettings = @{ +"managedIdentity" = @{ "clientId" = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}; +} + +$publicSettings = @{ +"fileUris"= (,"https://storage.blob.core.windows.net/itfiles/$($BatchFile)"); +"commandToExecute"= "sh $($BatchFile)" +} + +# Get information about the scale set +$vmss = Get-AzVmss ` + -ResourceGroupName $ResourceGroupName ` + -VMScaleSetName $VMScaleSetName + +Add-AzVmssExtension -VirtualMachineScaleSet $vmss ` + -Name "CustomScript" ` + -Publisher "Microsoft.Azure.Extensions" ` + -Type "CustomScript" ` + -TypeHandlerVersion $TypeHandlerVersion ` + -AutoUpgradeMinorVersion $true ` + -Setting $publicSettings ` + -ProtectedSetting $protectedSettings + +Update-AzVmss ` + -ResourceGroupName $ResourceGroupName ` + -Name $VMScaleSetName ` + -VirtualMachineScaleSet $vmss +``` + +This command adds an extension to the VMSS with a sample bash script on a blob storage, specify the url of blob storage and executable command in settings and security access in protected settings. + +## PARAMETERS + +### -AutoUpgradeMinorVersion +Indicates whether the extension version should be automatically updated to a newer minor version. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutomaticUpgrade +Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpdateTag +If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the extension that this cmdlet adds. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProtectedSetting +Specifies private configuration for the extension, as a string. +This cmdlet encrypts the private configuration. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProvisionAfterExtension +Collection of extension names after which this extension needs to be provisioned. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Publisher +Specifies the name of the extension publisher. +The publisher provides a name when the publisher registers an extension. +This can use the [Get-AzVMImagePublisher](./Get-AzVMImagePublisher.md) cmdlet to get the publisher. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Setting +Specifies the public configuration, as a string, for the extension. +This cmdlet does not encrypt public configuration. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Specifies the extension type. +You can use the [Get-AzVMExtensionImageType](./Get-AzVMExtensionImageType.md) cmdlet to get the extension type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the extension to use for this virtual machine. +You can use the [Get-AzVMExtensionImage](./Get-AzVMExtensionImage.md) cmdlet to get the version of the extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specify the VMSS object. +You can use the [New-AzVmssConfig](./New-AzVmssConfig.md) to create the object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.String + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Object + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[Remove-AzVmssExtension](./Remove-AzVmssExtension.md) + +[Get-AzVMImagePublisher](./Get-AzVMImagePublisher.md) + +[Get-AzVMExtensionImageType](./Get-AzVMExtensionImageType.md) + +[Get-AzVMExtensionImage](./Get-AzVMExtensionImage.md) + +[New-AzVmssConfig](./New-AzVmssConfig.md) diff --git a/azps-10.1.0/Az.Compute/Add-AzVmssGalleryApplication.md b/azps-10.1.0/Az.Compute/Add-AzVmssGalleryApplication.md new file mode 100644 index 0000000000..429b154e43 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVmssGalleryApplication.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmssgalleryapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssGalleryApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssGalleryApplication.md +--- + +# Add-AzVmssGalleryApplication + +## SYNOPSIS +Add a GalleryApplication object to the PSVirtualMachineProfile object. + +## SYNTAX + +``` +Add-AzVmssGalleryApplication -VirtualMachineScaleSetVM <PSVirtualMachineScaleSetVMProfile> + -GalleryApplication <PSVMGalleryApplication> [-TreatFailureAsDeploymentFailure] [-Order <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Adds a GalleryApplication object to the PSVirtualMachineProfile object. + +## EXAMPLES + +### Example 1 +```powershell +$vmss = Get-AzVmss -ResourceGroupName $rgName -Name $vmssName +$vmGal = New-AzVmssGalleryApplication -PackageReferenceId $packageRefId -ConfigReferenceId $configRefId +Add-AzVmssGalleryApplication -VirtualMachineScaleSetVM $vmss.VirtualMachineProfile -GalleryApplication $vmGal -Order 1 +``` + +This example creates a local VMGalleryApplication object and adds it to a PSVirtualMachineScaleSetVM object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryApplication +VM Gallery Application Object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVMGalleryApplication +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +Order in which the application will be install in. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TreatFailureAsDeploymentFailure +If true, any failure for any operation in the VmApplication will fail the deployment. Defaults to false if not specified. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSetVM +The PSVirtualMachineScaleSetVMProfile object to add a Gallery Application Reference ID. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVMProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVMProfile + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Add-AzVmssNetworkInterfaceConfiguration.md b/azps-10.1.0/Az.Compute/Add-AzVmssNetworkInterfaceConfiguration.md new file mode 100644 index 0000000000..6cca33f71e --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVmssNetworkInterfaceConfiguration.md @@ -0,0 +1,259 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: BAC2FA68-1D82-411D-A853-FD4EE525B533 +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmssnetworkinterfaceconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssNetworkInterfaceConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssNetworkInterfaceConfiguration.md +--- + +# Add-AzVmssNetworkInterfaceConfiguration + +## SYNOPSIS +Adds a network interface configuration to the VMSS. + +## SYNTAX + +``` +Add-AzVmssNetworkInterfaceConfiguration [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Name] <String>] + [[-Primary] <Boolean>] [[-Id] <String>] [[-IpConfiguration] <VirtualMachineScaleSetIPConfiguration[]>] + [-EnableAcceleratedNetworking] [-EnableIPForwarding] [-NetworkSecurityGroupId <String>] + [-DnsSettingsDnsServer <String[]>] [-NetworkApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVmssNetworkInterfaceConfiguration** cmdlet adds a network interface configuration to the Virtual Machine Scale Set (VMSS). + +## EXAMPLES + +### Example 1: Add a network interface configuration to the VMSS +```powershell +Add-AzVmssNetworkInterfaceConfiguration -VirtualMachineScaleSet $VMSS -Name "Test" -Primary $True -IPConfiguration $IPCfg +``` + +This command adds a network interface configuration to the VMSS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsSettingsDnsServer +List of dns server IP addresses for dns settings. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: DnsServer + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableAcceleratedNetworking +Specifies whether the network interface is accelerated networking-enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableIPForwarding +Specifies whether IP forwarding enabled on this NIC. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the Resource ID of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpConfiguration +Specifies the IP configurations of the network interface. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIPConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network interface configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkApiVersion +Specify the Network API version + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkSecurityGroupId +Id of the network security group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Primary +Indicates whether network interfaces created from the network interface configuration will be the primary network information center (NIC) of the virtual machine. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specifies the VMSS object. +You can use the [New-AzVmssConfig](./New-AzVmssConfig.md) cmdlet to create the object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.String + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIPConfiguration[] + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[New-AzVmssConfig](./New-AzVmssConfig.md) diff --git a/azps-10.1.0/Az.Compute/Add-AzVmssRunCommand.md b/azps-10.1.0/Az.Compute/Add-AzVmssRunCommand.md new file mode 100644 index 0000000000..7774e9e06a --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVmssRunCommand.md @@ -0,0 +1,382 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmssruncommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssRunCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssRunCommand.md +--- + +# Add-AzVmssRunCommand + +## SYNOPSIS +Adding Run Command to VMSS instances + +## SYNTAX + +### DefaultParameter (Default) +``` +Add-AzVmssRunCommand [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-Location] <String> + [-CommandId <String>] -Name <String> [-ScriptPath <String>] [-ScriptUri <String>] [-Script <String>] + [-TimeOutInSeconds <String>] [-ErrorBlobUri <String>] [-OutputBlobUri <String>] [-RunAsUser <String>] + [-RunAsPassword <SecureString>] [-Parameter <Hashtable>] [-ProtectedParameter <Hashtable>] + [-AsyncExecution <Boolean>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectParameter +``` +Add-AzVmssRunCommand [-CommandId <String>] -Name <String> [-ScriptPath <String>] [-ScriptUri <String>] + [-Script <String>] [-TimeOutInSeconds <String>] [-ErrorBlobUri <String>] [-OutputBlobUri <String>] + [-RunAsUser <String>] [-RunAsPassword <SecureString>] [-Parameter <Hashtable>] + [-ProtectedParameter <Hashtable>] [-AsyncExecution <Boolean>] + [-VirtualMachineScaleSetVM] <PSVirtualMachineScaleSetVM> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Adding Run Command to All VMSS Instances + +## EXAMPLES + +### Example 1 +```powershell +Add-AzVmssRunCommand -ResourceGroupName $rgname -VMScaleSetName $vmssname -Location eastus -Name myruncommand -Script "Write-Host Hello World" -TimeOutInSeconds 3600 -RunAsUser "admin01" +``` + +Adding 'myruncommand' to VMSS + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsyncExecution +Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandId +RunCommand Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ErrorBlobUri +Specifies the Azure storage blob where script error stream will be uploaded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputBlobUri +Specifies the Azure storage blob where script output stream will be uploaded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +The parameters used by the script. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectedParameter +The parameters used by the script. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunAsPassword +Specifies the user account password on the VM when executing the run command. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunAsUser +Specifies the user account on the VM when executing the run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Script +The source of the run command script. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptPath +The Path of source of the run command script. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptUri +The Uri source of the run command script. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeOutInSeconds +The timeout in seconds to execute the run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSetVM +The VirtualMachineScaleSetVM + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM +Parameter Sets: ObjectParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -VMScaleSetName +The VirtualMachineScaleSet + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSRunCommandResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Add-AzVmssSecret.md b/azps-10.1.0/Az.Compute/Add-AzVmssSecret.md new file mode 100644 index 0000000000..ec6b58a8ce --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVmssSecret.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 656BE930-E778-40B0-8A75-BFE52DE386CE +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmsssecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssSecret.md +--- + +# Add-AzVmssSecret + +## SYNOPSIS +Adds a secret to a VMSS. + +## SYNTAX + +``` +Add-AzVmssSecret [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-SourceVaultId] <String>] + [[-VaultCertificate] <VaultCertificate[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVmssSecret** cmdlet adds a secret to the Virtual Machine Scale Set (VMSS). +The secret must be stored in an Azure Key Vault. +For more information relating to Key Vault, see [What is Azure Key Vault?](https://learn.microsoft.com/azure/key-vault/general/basic-concepts) (https://learn.microsoft.com/azure/key-vault/general/basic-concepts). +For more information about the cmdlets, see [Azure Key Vault Cmdlets](/powershell/module/az.keyvault) or the [Set-AzKeyVaultSecret](/powershell/module/az.keyvault/set-azkeyvaultsecret) cmdlet. + +## EXAMPLES + +### Example 1: Add a secret to the VMSS using the Azure Key Vault virtual machine extension + +```powershell +# Build settings +$settings = @{ + secretsManagementSettings = @{ + pollingIntervalInS = "<pollingInterval>" + certificateStoreName = "<certStoreName>" + certificateStoreLocation = "<certStoreLoc>" + observedCertificates = @("<observedCert1>", "<observedCert2>") + } +} | ConvertTo-Json +$extName = "KeyVaultForLinux" +$extPublisher = "Microsoft.Azure.KeyVault" +$extType = "KeyVaultForLinux" +# Add Extension to VMSS +$vmss = Get-AzVmss -ResourceGroupName <ResourceGroupName> -VMScaleSetName <VmssName> +Add-AzVmssExtension -VirtualMachineScaleSet $vmss -Name $extName -Publisher $extPublisher -Type $extType -TypeHandlerVersion "2.0" -Setting $settings +# Start the deployment +Update-AzVmss -ResourceGroupName <ResourceGroupName> -VMScaleSetName <VmssName> -VirtualMachineScaleSet $vmss +``` + +To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). + +### Example 2: Add a secret to the VMSS using Add-AzVmssSecret +```powershell +$Vault = Get-AzKeyVault -VaultName "ContosoVault" +$CertConfig = New-AzVmssVaultCertificateConfig -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" -CertificateStore "Certificates" +$VMSS = New-AzVmssConfig +Add-AzVmssSecret -VirtualMachineScaleSet $VMSS -SourceVaultId $Vault.ResourceId -VaultCertificate $CertConfig +``` + +This example adds a secret to the VMSS. +The first command uses the Get-AzKeyVault cmdlet to get a vault secret from the vault named ContosoVault and stores the result in the variable named $Vault. +The second command uses the **New-AzVmssVaultCertificateConfig** cmdlet to create a Key Vault certificate configuration using the specified certificate URL from the certificate store named Certificates and stores the results in the variable named $CertConfig. +The third command uses the **New-AzVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS. +The fourth command adds a secret to the VMSS using the vault secret using the key resource ID and the vault certificate stored in the $Vault and $CertConfig variables. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceVaultId +Specifies the resource ID of the Key Vault that contains the certificates that you can add to the virtual machine. +This value also acts as the key for adding multiple certificates. +This means that you can use the same value for the *SourceVaultId* parameter when you add multiple certificates from the same Key Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultCertificate +Specifies the Vault **Certificate** object that contains the certificate URL and certificate name. +You can use the [New-AzVmssVaultCertificateConfig](./New-AzVmssVaultCertificateConfig.md) cmdlet to create this object. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.VaultCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specifies the VMSS object. +You can use the [New-AzVmssConfig](./New-AzVmssConfig.md) cmdlet to create this object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.String + +### Microsoft.Azure.Management.Compute.Models.VaultCertificate[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[New-AzVmssVaultCertificateConfig](./New-AzVmssVaultCertificateConfig.md) + +[New-AzVmssConfig](./New-AzVmssConfig.md) diff --git a/azps-10.1.0/Az.Compute/Add-AzVmssSshPublicKey.md b/azps-10.1.0/Az.Compute/Add-AzVmssSshPublicKey.md new file mode 100644 index 0000000000..0c170a28fa --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVmssSshPublicKey.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 9C216103-EB77-468E-8684-F5E5400B73A7 +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmsssshpublickey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssSshPublicKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssSshPublicKey.md +--- + +# Add-AzVmssSshPublicKey + +## SYNOPSIS +Adds SSH public keys to the VMSS. + +## SYNTAX + +``` +Add-AzVmssSshPublicKey [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Path] <String>] + [[-KeyData] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVmssSshPublicKey** cmdlet adds the public keys that you can use to connect to the Virtual Machine Scale Set (VMSS) virtual machines over Secure Shell (SSH). + +## EXAMPLES + +### Example 1: Add an SSH public key to the VMSS +```powershell +$VMSS = New-AzVmssConfig +Add-AzVmssSshPublicKey -VirtualMachineScaleSet $VMSS -KeyData "MIIDszCCApugAwIBAgIJALBV9YJCF/tAMA0GCSq12Ib3DQEB21QUAMEUxCzAJBgNV" -Path "/home/admin/.ssh/authorized_keys" +``` + +This example adds an SSH public key to the VMSS. +The first command uses the **New-AzVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS. +The second command adds an SSH key with the specified key data and stores the key at the specified path on the virtual machine. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyData +Specifies a SSH RSA public key data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the full path of a file, on the virtual machine, where this cmdlet stores the SSH public key. +If the file already exists, this cmdlet appends the key to the file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specifies the VMSS object. +You can use the [New-AzVmssConfig](./New-AzVmssConfig.md) cmdlet to create the object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[New-AzVmssConfig](./New-AzVmssConfig.md) diff --git a/azps-10.1.0/Az.Compute/Add-AzVmssVMDataDisk.md b/azps-10.1.0/Az.Compute/Add-AzVmssVMDataDisk.md new file mode 100644 index 0000000000..83c8a53634 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVmssVMDataDisk.md @@ -0,0 +1,233 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmssvmdatadisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssVMDataDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssVMDataDisk.md +--- + +# Add-AzVmssVMDataDisk + +## SYNOPSIS +Adds a data disk to a Vmss VM. + +## SYNTAX + +``` +Add-AzVmssVMDataDisk [-VirtualMachineScaleSetVM] <PSVirtualMachineScaleSetVM> [-Lun] <Int32> + [-CreateOption] <String> [-ManagedDiskId] <String> [-StorageAccountType <String>] + [-DiskEncryptionSetId <String>] [-Caching <CachingTypes>] [-DiskSizeInGB <Int32>] [-WriteAccelerator] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVmssVMDataDisk** cmdlet adds a data disk to a Vmss VM. + +## EXAMPLES + +### Example 1: Add a managed data disk to a Vmss VM. +```powershell +$disk = Get-AzDisk -ResourceGroupName $rgname -DiskName $diskname0 +$VmssVM = Get-AzVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 +$VmssVM = Add-AzVmssVMDataDisk -VirtualMachineScaleSetVM $VmssVM -Lun 0 -DiskSizeInGB 10 -CreateOption Attach -StorageAccountType Standard_LRS -ManagedDiskId $disk.Id +Update-AzVmssVM -VirtualMachineScaleSetVM $VmssVM +``` + +The first command gets an existing managed disk. +The next command gets an existing Vmss VM given by the resource group name, the vmss name and the instance ID. +The next command adds the managed disk to the Vmss VM stored locally in $VmssVM. +The final command updates the Vmss VM with added data disk. + +## PARAMETERS + +### -Caching +Specifies the caching mode of the disk. +The acceptable values for this parameter are: +- ReadOnly +- ReadWrite +- None +The default value is ReadWrite. +Changing this value causes the virtual machine to restart. +This setting affects the consistency and performance of the disk. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.CachingTypes +Parameter Sets: (All) +Aliases: +Accepted values: None, ReadOnly, ReadWrite + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CreateOption +Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, creates an empty disk, or attaches an existing disk. +The acceptable values for this parameter are: +- Attach. +Specify this option to create a virtual machine from a specialized disk. +When you specify this option, do not specify the *SourceImageUri* parameter. +The *VhdUri* is all that is needed in order to tell the Azure platform the location of the virtual hard disk (VHD) to attach as a data disk to the virtual machine. +- Empty. +Specify this to create an empty data disk. +- FromImage. +Specify this option to create a virtual machine from a generalized image or disk. +When you specify this option, you must specify the *SourceImageUri* parameter also in order to tell the Azure platform the location of the VHD to attach as a data disk. +The *VhdUri* parameter is used as the location identifying where the data disk VHD will be stored when it is used by the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of customer managed disk encryption set. This can only be specified for managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskSizeInGB +Specifies the size, in gigabytes, of an empty disk to attach to a virtual machine. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Lun +Specifies the logical unit number (LUN) for a data disk. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagedDiskId +Specifies the ID of a managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountType +Specifies the storage account type of managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSetVM +Specifies the local virtual machine scale set VM object to which to add a data disk. +You can use the **Get-AzVmssVM** cmdlet to obtain a virtual machine scale set VM object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WriteAccelerator +Specifies whether WriteAccelerator should be enabled or disabled on a managed data disk. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM + +### System.Int32 + +### System.String + +### Microsoft.Azure.Management.Compute.Models.CachingTypes + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Add-AzVmssWinRMListener.md b/azps-10.1.0/Az.Compute/Add-AzVmssWinRMListener.md new file mode 100644 index 0000000000..7979fddbb9 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Add-AzVmssWinRMListener.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 987BD670-20F3-4105-A5BE-03E712AB2B56 +online version: https://learn.microsoft.com/powershell/module/az.compute/add-azvmsswinrmlistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssWinRMListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Add-AzVmssWinRMListener.md +--- + +# Add-AzVmssWinRMListener + +## SYNOPSIS +Adds a WinRM listener to the VMSS. + +## SYNTAX + +``` +Add-AzVmssWinRMListener [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Protocol] <ProtocolTypes>] + [[-CertificateUrl] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVmssWinRMListener** cmdlet adds a Windows Remote Management (WinRM) listener on the Virtual Machine Scale Set (VMSS). + +## EXAMPLES + +### Example 1: Add a WinRM listener to the VMSS +```powershell +$VMSS = New-AzVmssConfig +Add-AzVmssWinRMListener -VirtualMachineScaleSet $VMSS -Protocol Https -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" +``` + +This example adds a WinRM listener to the VMSS. +The first command uses the **New-AzVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS. +The second command adds an HTTP protocol WinRM listener with the certificate at the specified URL to the VMSS. + +## PARAMETERS + +### -CertificateUrl +Specifies a link, as a URL, of the certificate with which new virtual machines are provisioned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol of the WinRM listener. +The acceptable values for this parameter are: +- Http +- Https + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.ProtocolTypes] +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specifies the VMSS object. +You can use the New-AzVmssConfig cmdlet to create the object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.ProtocolTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[New-AzVmssConfig](./New-AzVmssConfig.md) + + diff --git a/azps-10.1.0/Az.Compute/Az.Compute.md b/azps-10.1.0/Az.Compute/Az.Compute.md new file mode 100644 index 0000000000..b5f4576a7f --- /dev/null +++ b/azps-10.1.0/Az.Compute/Az.Compute.md @@ -0,0 +1,756 @@ +--- +Module Name: Az.Compute +Module Guid: 0a83c907-1ffb-4d87-a492-c65ac7d7ed37 +Download Help Link: https://learn.microsoft.com/powershell/module/az.compute +Help Version: 3.5.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Az.Compute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Az.Compute.md +--- + +# Az.Compute Module +## Description +This topic displays the help topics for the Azure Compute Cmdlets. + +## Az.Compute Cmdlets +### [Add-AzImageDataDisk](Add-AzImageDataDisk.md) +Adds a data disk to an image object. + +### [Add-AzVhd](Add-AzVhd.md) +Uploads a virtual hard disk from an on-premises machine to Azure (managed disk or blob). + +### [Add-AzVMAdditionalUnattendContent](Add-AzVMAdditionalUnattendContent.md) +Adds information to the unattended Windows Setup answer file. + +### [Add-AzVMDataDisk](Add-AzVMDataDisk.md) +Adds a data disk to a virtual machine. + +### [Add-AzVmGalleryApplication](Add-AzVmGalleryApplication.md) +Add a GalleryApplication object to the PSVirtualMachine object. + +### [Add-AzVMNetworkInterface](Add-AzVMNetworkInterface.md) +Adds a network interface to a virtual machine. + +### [Add-AzVMSecret](Add-AzVMSecret.md) +Adds a secret to a virtual machine. + +### [Add-AzVmssAdditionalUnattendContent](Add-AzVmssAdditionalUnattendContent.md) +Adds information to the unattended Windows Setup answer file. + +### [Add-AzVmssDataDisk](Add-AzVmssDataDisk.md) +Adds a data disk to the VMSS. + +### [Add-AzVmssDiagnosticsExtension](Add-AzVmssDiagnosticsExtension.md) +Adds a diagnostics extension to the VMSS. + +### [Add-AzVmssExtension](Add-AzVmssExtension.md) +Adds an extension to the VMSS. + +### [Add-AzVmssGalleryApplication](Add-AzVmssGalleryApplication.md) +Add a GalleryApplication object to the PSVirtualMachineProfile object. + +### [Add-AzVMSshPublicKey](Add-AzVMSshPublicKey.md) +Adds the public keys for SSH for a virtual machine, when only creating the VM. + +### [Add-AzVmssNetworkInterfaceConfiguration](Add-AzVmssNetworkInterfaceConfiguration.md) +Adds a network interface configuration to the VMSS. + +### [Add-AzVmssRunCommand](Add-AzVmssRunCommand.md) +Adding Run Command to VMSS instances + +### [Add-AzVmssSecret](Add-AzVmssSecret.md) +Adds a secret to a VMSS. + +### [Add-AzVmssSshPublicKey](Add-AzVmssSshPublicKey.md) +Adds SSH public keys to the VMSS. + +### [Add-AzVmssVMDataDisk](Add-AzVmssVMDataDisk.md) +Adds a data disk to a Vmss VM. + +### [Add-AzVmssWinRMListener](Add-AzVmssWinRMListener.md) +Adds a WinRM listener to the VMSS. + +### [ConvertTo-AzVMManagedDisk](ConvertTo-AzVMManagedDisk.md) +Converts a virtual machine with blob-based disks to a virtual machine with managed disks. + +### [Disable-AzVMDiskEncryption](Disable-AzVMDiskEncryption.md) +Disables encryption on an IaaS virtual machine. + +### [Disable-AzVmssDiskEncryption](Disable-AzVmssDiskEncryption.md) +Disables disk encryption on a VM scale set. + +### [Export-AzLogAnalyticRequestRateByInterval](Export-AzLogAnalyticRequestRateByInterval.md) +Export logs that show Api requests made by this subscription in the given time window to show throttling activities. + +### [Export-AzLogAnalyticThrottledRequest](Export-AzLogAnalyticThrottledRequest.md) +Export logs that show total throttled Api requests for this subscription in the given time window. + +### [Get-AzAvailabilitySet](Get-AzAvailabilitySet.md) +Gets Azure availability sets in a resource group. + +### [Get-AzCapacityReservation](Get-AzCapacityReservation.md) +Gets the properties of Capacity Reservation resources from a Capacity Reservation Group + +### [Get-AzCapacityReservationGroup](Get-AzCapacityReservationGroup.md) +Gets the properties of Capacity Reservation Groups + +### [Get-AzComputeResourceSku](Get-AzComputeResourceSku.md) +List all compute resource Skus + +### [Get-AzDisk](Get-AzDisk.md) +Gets the properties of a Managed disk. + +### [Get-AzDiskAccess](Get-AzDiskAccess.md) +Gets the properties of Disk Accesses + +### [Get-AzDiskEncryptionSet](Get-AzDiskEncryptionSet.md) +Get or list disk encryption sets. + +### [Get-AzDiskEncryptionSetAssociatedResource](Get-AzDiskEncryptionSetAssociatedResource.md) +Gets the list of resources associated with the specified disk encryption set. + +### [Get-AzGallery](Get-AzGallery.md) +Get or list galleries. + +### [Get-AzGalleryApplication](Get-AzGalleryApplication.md) +Retrieves information about a gallery Application Definition. + +### [Get-AzGalleryApplicationVersion](Get-AzGalleryApplicationVersion.md) +Retrieves information about a gallery Application Version. + +### [Get-AzGalleryImageDefinition](Get-AzGalleryImageDefinition.md) +Get or list gallery image definitions. + +### [Get-AzGalleryImageVersion](Get-AzGalleryImageVersion.md) +Get or list gallery image versions. + +### [Get-AzHost](Get-AzHost.md) +Get or list hosts. + +### [Get-AzHostGroup](Get-AzHostGroup.md) +Get or list hosts. + +### [Get-AzImage](Get-AzImage.md) +Gets the properties of an image. + +### [Get-AzProximityPlacementGroup](Get-AzProximityPlacementGroup.md) +Get or list Proximity Placement Group resource(s). + +### [Get-AzRemoteDesktopFile](Get-AzRemoteDesktopFile.md) +Gets an .rdp file. + +### [Get-AzRestorePoint](Get-AzRestorePoint.md) +Command to get the Restore Point + +### [Get-AzRestorePointCollection](Get-AzRestorePointCollection.md) +Get a Restore Point Collection + +### [Get-AzSnapshot](Get-AzSnapshot.md) +Gets the properties of a snapshot + +### [Get-AzSshKey](Get-AzSshKey.md) +Gets the properties of SSH Public Key resources. + +### [Get-AzVM](Get-AzVM.md) +Gets the properties of a virtual machine. + +### [Get-AzVMAccessExtension](Get-AzVMAccessExtension.md) +Gets information about the VMAccess extension. + +### [Get-AzVMADDomainExtension](Get-AzVMADDomainExtension.md) +Gets information about an AD domain extension. + +### [Get-AzVMAEMExtension](Get-AzVMAEMExtension.md) +Gets information about the AEM extension. + +### [Get-AzVMBootDiagnosticsData](Get-AzVMBootDiagnosticsData.md) +Gets boot diagnostics data for a virtual machine. + +### [Get-AzVMChefExtension](Get-AzVMChefExtension.md) +Gets information about a Chef extension. + +### [Get-AzVMCustomScriptExtension](Get-AzVMCustomScriptExtension.md) +Gets information about a custom script extension. + +### [Get-AzVMDiagnosticsExtension](Get-AzVMDiagnosticsExtension.md) +Gets the settings of the Diagnostics extension on a virtual machine. + +### [Get-AzVMDiskEncryptionStatus](Get-AzVMDiskEncryptionStatus.md) +Gets the encryption status of the virtual machine. + +### [Get-AzVMDscExtension](Get-AzVMDscExtension.md) +Gets the settings of the DSC extension on a particular virtual machine. + +### [Get-AzVMDscExtensionStatus](Get-AzVMDscExtensionStatus.md) +Gets the status of the DSC extension handler for a virtual machine. + +### [Get-AzVMExtension](Get-AzVMExtension.md) +Gets properties of Virtual Machine Extensions installed on a virtual machine. + +### [Get-AzVMExtensionImage](Get-AzVMExtensionImage.md) +Gets all versions for an Azure extension. + +### [Get-AzVMExtensionImageType](Get-AzVMExtensionImageType.md) +Gets the type of an Azure extension. + +### [Get-AzVMImage](Get-AzVMImage.md) +Gets all the versions of a VMImage. + +### [Get-AzVMImageOffer](Get-AzVMImageOffer.md) +Gets VMImage offer types. + +### [Get-AzVMImagePublisher](Get-AzVMImagePublisher.md) +Gets the VMImage publishers. + +### [Get-AzVMImageSku](Get-AzVMImageSku.md) +Gets VMImage SKUs. + +### [Get-AzVMRunCommand](Get-AzVMRunCommand.md) +Gets a specific Run Command or a list of Run Commands for a Virtual Machine + +### [Get-AzVMRunCommandDocument](Get-AzVMRunCommandDocument.md) +Get a run command document. + +### [Get-AzVMSize](Get-AzVMSize.md) +Gets available virtual machine sizes. + +### [Get-AzVMSqlServerExtension](Get-AzVMSqlServerExtension.md) +Gets the settings for a SQL Server extension on a virtual machine. + +### [Get-AzVmss](Get-AzVmss.md) +Gets the properties of a VMSS. + +### [Get-AzVmssDiskEncryption](Get-AzVmssDiskEncryption.md) +Shows the disk encryption status of a VM scale set. + +### [Get-AzVmssRollingUpgrade](Get-AzVmssRollingUpgrade.md) +Shows the status of the latest virtual machine scale set rolling upgrade. + +### [Get-AzVmssSku](Get-AzVmssSku.md) +Gets the available SKUs for the VMSS. + +### [Get-AzVmssVM](Get-AzVmssVM.md) +Gets the properties of a VMSS virtual machine. + +### [Get-AzVmssVMDiskEncryption](Get-AzVmssVMDiskEncryption.md) +Shows the disk encryption status of VMs in a VM scale set. + +### [Get-AzVmssVMRunCommand](Get-AzVmssVMRunCommand.md) +The operation to get the VMSS VM run command. + +### [Get-AzVMUsage](Get-AzVMUsage.md) +Gets the virtual machine core count usage for a location. + +### [Grant-AzDiskAccess](Grant-AzDiskAccess.md) +Grants an access to a disk. + +### [Grant-AzSnapshotAccess](Grant-AzSnapshotAccess.md) +Grants an access to a snapshot. + +### [Invoke-AzVMInstallPatch](Invoke-AzVMInstallPatch.md) +Installs patches on the VM + +### [Invoke-AzVMPatchAssessment](Invoke-AzVMPatchAssessment.md) +Assess patch state of a virtual machine. + +### [Invoke-AzVMReimage](Invoke-AzVMReimage.md) +Reimage an Azure virtual machine. + +### [Invoke-AzVMRunCommand](Invoke-AzVMRunCommand.md) +Run a command on the VM. + +### [Invoke-AzVmssVMRunCommand](Invoke-AzVmssVMRunCommand.md) +Run command on the Virtual Machine Scale Set VM. + +### [New-AzAvailabilitySet](New-AzAvailabilitySet.md) +Creates an Azure availability set. + +### [New-AzCapacityReservation](New-AzCapacityReservation.md) +Creates a Capacity Reservation resource in a Capacity Reservation Group + +### [New-AzCapacityReservationGroup](New-AzCapacityReservationGroup.md) +Creates a Capacity Reservation Group + +### [New-AzDisk](New-AzDisk.md) +Creates a managed disk. + +### [New-AzDiskAccess](New-AzDiskAccess.md) +Creates a Disk Access resource + +### [New-AzDiskConfig](New-AzDiskConfig.md) +Creates a configurable disk object. + +### [New-AzDiskEncryptionSet](New-AzDiskEncryptionSet.md) +Creates a disk encryption set. + +### [New-AzDiskEncryptionSetConfig](New-AzDiskEncryptionSetConfig.md) +Creates a configurable disk encryption set object. + +### [New-AzDiskPurchasePlanConfig](New-AzDiskPurchasePlanConfig.md) +Creates a PurchasePlan Object + +### [New-AzDiskUpdateConfig](New-AzDiskUpdateConfig.md) +Creates a configurable disk update object. + +### [New-AzGallery](New-AzGallery.md) +Create a gallery. + +### [New-AzGalleryApplication](New-AzGalleryApplication.md) +Create or update a gallery Application Definition. + +### [New-AzGalleryApplicationVersion](New-AzGalleryApplicationVersion.md) +Create or update a gallery Application Version. + +### [New-AzGalleryImageDefinition](New-AzGalleryImageDefinition.md) +Create a gallery image definition. + +### [New-AzGalleryImageVersion](New-AzGalleryImageVersion.md) +Create a gallery image version. + +### [New-AzHost](New-AzHost.md) +Creates a host. + +### [New-AzHostGroup](New-AzHostGroup.md) +Creates a host group. + +### [New-AzImage](New-AzImage.md) +Creates an image. + +### [New-AzImageConfig](New-AzImageConfig.md) +Creates a configurable image object. + +### [New-AzProximityPlacementGroup](New-AzProximityPlacementGroup.md) +Create Proximity Placement Group resource. + +### [New-AzRestorePoint](New-AzRestorePoint.md) +This cmdlet can create a New Restore Point + +### [New-AzRestorePointCollection](New-AzRestorePointCollection.md) +Creates a New Restore Point Collection + +### [New-AzSnapshot](New-AzSnapshot.md) +Creates a snapshot. + +### [New-AzSnapshotConfig](New-AzSnapshotConfig.md) +Creates a configurable snapshot object. + +### [New-AzSnapshotUpdateConfig](New-AzSnapshotUpdateConfig.md) +Creates a configurable snapshot update object. + +### [New-AzSshKey](New-AzSshKey.md) +Create a SSH Public Key resource. + +### [New-AzVM](New-AzVM.md) +Creates a virtual machine. + +### [New-AzVMConfig](New-AzVMConfig.md) +Creates a configurable virtual machine object. + +### [New-AzVMDataDisk](New-AzVMDataDisk.md) +Creates a local data disk object for a virtual machine or a Vmss VM. + +### [New-AzVmGalleryApplication](New-AzVmGalleryApplication.md) +Create a local PSVMGalleryApplication object. + +### [New-AzVMSqlServerAutoBackupConfig](New-AzVMSqlServerAutoBackupConfig.md) +Creates a configuration object for SQL Server automatic backup. + +### [New-AzVMSqlServerAutoPatchingConfig](New-AzVMSqlServerAutoPatchingConfig.md) +Creates a configuration object for automatic patching on a virtual machine. + +### [New-AzVMSqlServerKeyVaultCredentialConfig](New-AzVMSqlServerKeyVaultCredentialConfig.md) +Creates a configuration object for SQL server key vault credential on a virtual machine. + +### [New-AzVmss](New-AzVmss.md) +Creates a VMSS. + +### [New-AzVmssConfig](New-AzVmssConfig.md) +Creates a VMSS configuration object. + +### [New-AzVmssGalleryApplication](New-AzVmssGalleryApplication.md) +Create a local PSVMGalleryApplication object. + +### [New-AzVmssIpConfig](New-AzVmssIpConfig.md) +Creates an IP configuration for a network interface of a VMSS. + +### [New-AzVmssIpTagConfig](New-AzVmssIpTagConfig.md) +Creates an IP Tag object for a network interface of a VMSS. + +### [New-AzVmssVaultCertificateConfig](New-AzVmssVaultCertificateConfig.md) +Creates a Key Vault certificate configuration. + +### [Publish-AzVMDscConfiguration](Publish-AzVMDscConfiguration.md) +Uploads a DSC script to Azure blob storage. + +### [Remove-AzAvailabilitySet](Remove-AzAvailabilitySet.md) +Removes an availability set from Azure. + +### [Remove-AzCapacityReservation](Remove-AzCapacityReservation.md) +Removes a Capacity Reservation resource + +### [Remove-AzCapacityReservationGroup](Remove-AzCapacityReservationGroup.md) +Removes a Capacity Reservation Group + +### [Remove-AzDisk](Remove-AzDisk.md) +Removes a disk. + +### [Remove-AzDiskAccess](Remove-AzDiskAccess.md) +Removes a disk access resource. + +### [Remove-AzDiskEncryptionSet](Remove-AzDiskEncryptionSet.md) +Removes a disk encryption set. + +### [Remove-AzGallery](Remove-AzGallery.md) +Delete a gallery. + +### [Remove-AzGalleryApplication](Remove-AzGalleryApplication.md) +Delete a gallery Application. + +### [Remove-AzGalleryApplicationVersion](Remove-AzGalleryApplicationVersion.md) +Delete a gallery Application Version. + +### [Remove-AzGalleryImageDefinition](Remove-AzGalleryImageDefinition.md) +Delete a gallery image definition. + +### [Remove-AzGalleryImageVersion](Remove-AzGalleryImageVersion.md) +Delete a gallery image version. + +### [Remove-AzHost](Remove-AzHost.md) +Removes a host. + +### [Remove-AzHostGroup](Remove-AzHostGroup.md) +Removes a host group. + +### [Remove-AzImage](Remove-AzImage.md) +Removes an image. + +### [Remove-AzImageDataDisk](Remove-AzImageDataDisk.md) +Removes a data disk from an image object. + +### [Remove-AzProximityPlacementGroup](Remove-AzProximityPlacementGroup.md) +Delete Proximity Placement Group resource. + +### [Remove-AzRestorePoint](Remove-AzRestorePoint.md) +This cmdlet can remove a Restore Point + +### [Remove-AzRestorePointCollection](Remove-AzRestorePointCollection.md) +This Cmdlet can remove Restore Point Collection + +### [Remove-AzSnapshot](Remove-AzSnapshot.md) +Removes a snapshot. + +### [Remove-AzSshKey](Remove-AzSshKey.md) +Delete a SSH Public Key resource. + +### [Remove-AzVM](Remove-AzVM.md) +Removes a virtual machine from Azure. + +### [Remove-AzVMAccessExtension](Remove-AzVMAccessExtension.md) +Removes the VMAccess extension from a virtual machine. + +### [Remove-AzVMAEMExtension](Remove-AzVMAEMExtension.md) +Removes the AEM extension from a virtual machine. + +### [Remove-AzVMBackup](Remove-AzVMBackup.md) +Removes the backup from a virtual machine. + +### [Remove-AzVMChefExtension](Remove-AzVMChefExtension.md) +Removes the Chef extension from a virtual machine. + +### [Remove-AzVMCustomScriptExtension](Remove-AzVMCustomScriptExtension.md) +Removes a custom script extension from a virtual machine. + +### [Remove-AzVMDataDisk](Remove-AzVMDataDisk.md) +Removes a data disk from a virtual machine. + +### [Remove-AzVMDiagnosticsExtension](Remove-AzVMDiagnosticsExtension.md) +Removes the Diagnostics extension from a virtual machine. + +### [Remove-AzVMDiskEncryptionExtension](Remove-AzVMDiskEncryptionExtension.md) +Removes the disk encryption extension from a virtual machine. + +### [Remove-AzVMDscExtension](Remove-AzVMDscExtension.md) +Removes a DSC extension handler from a virtual machine in a resource group. + +### [Remove-AzVMExtension](Remove-AzVMExtension.md) +Removes an extension from a virtual machine. + +### [Remove-AzVmGalleryApplication](Remove-AzVmGalleryApplication.md) +Remove a VMGalleryApplication object from the PSVirtualMachine object. + +### [Remove-AzVMNetworkInterface](Remove-AzVMNetworkInterface.md) +Removes a network interface from a virtual machine. + +### [Remove-AzVMRunCommand](Remove-AzVMRunCommand.md) +The operation to delete the run command. + +### [Remove-AzVMSecret](Remove-AzVMSecret.md) +Removes (a) secret(s) from a virtual machine object + +### [Remove-AzVMSqlServerExtension](Remove-AzVMSqlServerExtension.md) +Removes a SQL Server extension from a virtual machine. + +### [Remove-AzVmss](Remove-AzVmss.md) +Removes the VMSS or a virtual machine that is within the VMSS. + +### [Remove-AzVmssDataDisk](Remove-AzVmssDataDisk.md) +Removes a data disk from the VMSS. + +### [Remove-AzVmssDiagnosticsExtension](Remove-AzVmssDiagnosticsExtension.md) +Removes a diagnostics extension from the VMSS. + +### [Remove-AzVmssExtension](Remove-AzVmssExtension.md) +Removes an extension from the VMSS. + +### [Remove-AzVmssGalleryApplication](Remove-AzVmssGalleryApplication.md) +Remove a VMGalleryApplication object from the PSVirtualMachineScaleSetVMProfile object. + +### [Remove-AzVmssNetworkInterfaceConfiguration](Remove-AzVmssNetworkInterfaceConfiguration.md) +Removes a network interface configuration from a VMSS. + +### [Remove-AzVmssRunCommand](Remove-AzVmssRunCommand.md) +Remove VMSS RunCommand + +### [Remove-AzVmssVMDataDisk](Remove-AzVmssVMDataDisk.md) +Removes a data disk from a virtual machine scale set VM + +### [Remove-AzVmssVMRunCommand](Remove-AzVmssVMRunCommand.md) +The operation to delete the VMSS VM run command. + +### [Repair-AzVmssServiceFabricUpdateDomain](Repair-AzVmssServiceFabricUpdateDomain.md) +Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set. + +### [Restart-AzHost](Restart-AzHost.md) +Restart the dedicated host. + +### [Restart-AzVM](Restart-AzVM.md) +Restarts an Azure virtual machine. + +### [Restart-AzVmss](Restart-AzVmss.md) +Restarts the VMSS or a virtual machine within the VMSS. + +### [Revoke-AzDiskAccess](Revoke-AzDiskAccess.md) +Revokes an access to a disk. + +### [Revoke-AzSnapshotAccess](Revoke-AzSnapshotAccess.md) +Revokes an access to a snapshot. + +### [Save-AzVhd](Save-AzVhd.md) +Saves downloaded .vhd images locally. + +### [Save-AzVMImage](Save-AzVMImage.md) +Saves a virtual machine as a VMImage. + +### [Set-AzDiskDiskEncryptionKey](Set-AzDiskDiskEncryptionKey.md) +Sets the disk encryption key properties on a disk object. + +### [Set-AzDiskImageReference](Set-AzDiskImageReference.md) +Sets the image reference properties on a disk object. + +### [Set-AzDiskKeyEncryptionKey](Set-AzDiskKeyEncryptionKey.md) +Sets the key encryption key properties on a disk object. + +### [Set-AzDiskSecurityProfile](Set-AzDiskSecurityProfile.md) +Set SecurityProfile on managed disk + +### [Set-AzDiskUpdateDiskEncryptionKey](Set-AzDiskUpdateDiskEncryptionKey.md) +Sets the disk encryption key properties on a disk update object. + +### [Set-AzDiskUpdateKeyEncryptionKey](Set-AzDiskUpdateKeyEncryptionKey.md) +Sets the key encryption key properties on a disk update object. + +### [Set-AzImageOsDisk](Set-AzImageOsDisk.md) +Sets the operating system disk properties on an image object. + +### [Set-AzSnapshotDiskEncryptionKey](Set-AzSnapshotDiskEncryptionKey.md) +Sets the disk encryption key properties on a snapshot object. + +### [Set-AzSnapshotImageReference](Set-AzSnapshotImageReference.md) +Sets the image reference properties on a snapshot object. + +### [Set-AzSnapshotKeyEncryptionKey](Set-AzSnapshotKeyEncryptionKey.md) +Sets the key encryption key properties on a snapshot object. + +### [Set-AzSnapshotUpdateDiskEncryptionKey](Set-AzSnapshotUpdateDiskEncryptionKey.md) +Sets the disk encryption key properties on a snapshot update object. + +### [Set-AzSnapshotUpdateKeyEncryptionKey](Set-AzSnapshotUpdateKeyEncryptionKey.md) +Sets the key encryption key properties on a snapshot update object. + +### [Set-AzVM](Set-AzVM.md) +This cmdlet can be used to do the followings: reapply or redeploy a virtual machine, mark a virtual machine as generalized, simulate eviction to a spot virtual machine. + +### [Set-AzVMAccessExtension](Set-AzVMAccessExtension.md) +Adds the VMAccess extension to a virtual machine. + +### [Set-AzVMADDomainExtension](Set-AzVMADDomainExtension.md) +Adds an AD domain extension to a virtual machine. + +### [Set-AzVMAEMExtension](Set-AzVMAEMExtension.md) +Enables support for monitoring for SAP systems. + +### [Set-AzVMBackupExtension](Set-AzVMBackupExtension.md) +Sets the backup extension properties on a virtual machine. + +### [Set-AzVMBginfoExtension](Set-AzVMBginfoExtension.md) +Adds the BGInfo extension to a virtual machine. + +### [Set-AzVMBootDiagnostic](Set-AzVMBootDiagnostic.md) +Modifies boot diagnostics properties of a virtual machine. + +### [Set-AzVMChefExtension](Set-AzVMChefExtension.md) +Adds a Chef extension to a virtual machine. + +### [Set-AzVMCustomScriptExtension](Set-AzVMCustomScriptExtension.md) +Adds a custom script extension to a virtual machine. + +### [Set-AzVMDataDisk](Set-AzVMDataDisk.md) +Modifies properties of a virtual machine data disk. + +### [Set-AzVMDiagnosticsExtension](Set-AzVMDiagnosticsExtension.md) +Configures the Azure diagnostics extension on a virtual machine. + +### [Set-AzVMDiskEncryptionExtension](Set-AzVMDiskEncryptionExtension.md) +Enables encryption on a running IaaS virtual machine in Azure. + +### [Set-AzVMDscExtension](Set-AzVMDscExtension.md) +Configures the DSC extension on a virtual machine. + +### [Set-AzVMExtension](Set-AzVMExtension.md) +Updates extension properties or adds an extension to a virtual machine. + +### [Set-AzVMOperatingSystem](Set-AzVMOperatingSystem.md) +Sets operating system properties during the creation of a new virtual machine or updating a virtual machine. + +### [Set-AzVMOSDisk](Set-AzVMOSDisk.md) +Sets the operating system disk properties on a virtual machine. + +### [Set-AzVMPlan](Set-AzVMPlan.md) +Sets the Marketplace plan information on a virtual machine. + +### [Set-AzVMRunCommand](Set-AzVMRunCommand.md) +The operation to create or update the run command. + +### [Set-AzVMSecurityProfile](Set-AzVMSecurityProfile.md) +Sets the SecurityType enum for Virtual Machines. + +### [Set-AzVMSourceImage](Set-AzVMSourceImage.md) +Specifies the image for a virtual machine. + +### [Set-AzVMSqlServerExtension](Set-AzVMSqlServerExtension.md) +Sets the Azure SQL Server extension on a virtual machine. + +### [Set-AzVmss](Set-AzVmss.md) +Sets specific actions on a specified VMSS. + +### [Set-AzVmssBootDiagnostic](Set-AzVmssBootDiagnostic.md) +Sets the virtual machine scale set boot diagnostics profile. + +### [Set-AzVmssDiskEncryptionExtension](Set-AzVmssDiskEncryptionExtension.md) +Enables disk encryption on a VM scale set. + +### [Set-AzVmssOrchestrationServiceState](Set-AzVmssOrchestrationServiceState.md) +Sets the orchestration service state for the VMSS. + +### [Set-AzVmssOsProfile](Set-AzVmssOsProfile.md) +Sets the VMSS operating system profile properties. + +### [Set-AzVmssRollingUpgradePolicy](Set-AzVmssRollingUpgradePolicy.md) +Sets the VMSS rolling upgrade policy properties. + +### [Set-AzVmssSecurityProfile](Set-AzVmssSecurityProfile.md) +This cmdlet allows users to set the SecurityType enum for Virtual Machines scale sets. + +### [Set-AzVmssStorageProfile](Set-AzVmssStorageProfile.md) +Sets the storage profile properties for the VMSS. + +### [Set-AzVmssUefi](Set-AzVmssUefi.md) +Modifies UEFI properties of gen 2 virtual machines that are part of virtual machine scale sets + +### [Set-AzVmssVM](Set-AzVmssVM.md) +Modifies the state of a VMSS instance. + +### [Set-AzVmssVMRunCommand](Set-AzVmssVMRunCommand.md) +The operation to create or update the VMSS VM run command. + +### [Set-AzVMUefi](Set-AzVMUefi.md) +Modifies UEFI properties of a gen 2 virtual machine + +### [Start-AzVM](Start-AzVM.md) +Starts an Azure virtual machine. + +### [Start-AzVmss](Start-AzVmss.md) +Starts the VMSS or a set of virtual machines within the VMSS. + +### [Start-AzVmssRollingExtensionUpgrade](Start-AzVmssRollingExtensionUpgrade.md) +This cmdlet starts a rolling upgrade for all extensions on the given Virtual Machine Scale Set to the latest available version. + +### [Start-AzVmssRollingOSUpgrade](Start-AzVmssRollingOSUpgrade.md) +Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. + +### [Stop-AzVM](Stop-AzVM.md) +Stops an Azure virtual machine. + +### [Stop-AzVmss](Stop-AzVmss.md) +Stops the VMSS or a set of virtual machines within the VMSS. + +### [Stop-AzVmssRollingUpgrade](Stop-AzVmssRollingUpgrade.md) +Cancels the current virtual machine scale set rolling upgrade. + +### [Test-AzVMAEMExtension](Test-AzVMAEMExtension.md) +Checks the configuration of the AEM extension. + +### [Update-AzAvailabilitySet](Update-AzAvailabilitySet.md) +Updates an availability set. + +### [Update-AzCapacityReservation](Update-AzCapacityReservation.md) +Update the Capacity Reservation. + +### [Update-AzCapacityReservationGroup](Update-AzCapacityReservationGroup.md) +Update the Capacity Reservation Group. + +### [Update-AzDisk](Update-AzDisk.md) +Updates a disk. + +### [Update-AzDiskEncryptionSet](Update-AzDiskEncryptionSet.md) +Updates a disk encryption set. + +### [Update-AzGallery](Update-AzGallery.md) +Update a gallery. + +### [Update-AzGalleryApplication](Update-AzGalleryApplication.md) +Update a gallery Application Definition. + +### [Update-AzGalleryApplicationVersion](Update-AzGalleryApplicationVersion.md) +Update a gallery Application Version. + +### [Update-AzGalleryImageDefinition](Update-AzGalleryImageDefinition.md) +Update a gallery image definition. + +### [Update-AzGalleryImageVersion](Update-AzGalleryImageVersion.md) +Update a gallery image version. + +### [Update-AzImage](Update-AzImage.md) +Updates an image. + +### [Update-AzRestorePointCollection](Update-AzRestorePointCollection.md) +Update Restore Point Collection. + +### [Update-AzSnapshot](Update-AzSnapshot.md) +Updates a snapshot. + +### [Update-AzSshKey](Update-AzSshKey.md) +Update a SSH Public Key resource. + +### [Update-AzVM](Update-AzVM.md) +Updates the state of an Azure virtual machine. + +### [Update-AzVmss](Update-AzVmss.md) +Updates the state of a VMSS. + +### [Update-AzVmssInstance](Update-AzVmssInstance.md) +Starts a manual upgrade of the VMSS instance. + +### [Update-AzVmssVM](Update-AzVmssVM.md) +Updates the state of a Vmss VM. + diff --git a/azps-10.1.0/Az.Compute/ConvertTo-AzVMManagedDisk.md b/azps-10.1.0/Az.Compute/ConvertTo-AzVMManagedDisk.md new file mode 100644 index 0000000000..198452b9a8 --- /dev/null +++ b/azps-10.1.0/Az.Compute/ConvertTo-AzVMManagedDisk.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/convertto-azvmmanageddisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/ConvertTo-AzVMManagedDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/ConvertTo-AzVMManagedDisk.md +--- + +# ConvertTo-AzVMManagedDisk + +## SYNOPSIS +Converts a virtual machine with blob-based disks to a virtual machine with managed disks. + +## SYNTAX + +``` +ConvertTo-AzVMManagedDisk [-ResourceGroupName] <String> [-VMName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **ConvertTo-AzVMManagedDisk** cmdlet converts a virtual machine with blob-based disks to a virtual machine with managed disks. +The virtual machine must be stop-deallocated before invoking this operation. + +## EXAMPLES + +### Example 1 +```powershell +ConvertTo-AzVMManagedDisk -ResourceGroupName 'ResourceGroup01' -VMName 'VM01' +``` + +This command converts the blob-based disks of the virtual machine named 'VM01' in the resource group 'ResourceGroup01' to managed disks. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Disable-AzVMDiskEncryption.md b/azps-10.1.0/Az.Compute/Disable-AzVMDiskEncryption.md new file mode 100644 index 0000000000..c05ea6891d --- /dev/null +++ b/azps-10.1.0/Az.Compute/Disable-AzVMDiskEncryption.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 979E956B-4C74-426E-A617-E50C4EBC8A20 +online version: https://learn.microsoft.com/powershell/module/az.compute/disable-azvmdiskencryption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Disable-AzVMDiskEncryption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Disable-AzVMDiskEncryption.md +--- + +# Disable-AzVMDiskEncryption + +## SYNOPSIS +Disables encryption on an IaaS virtual machine. + +## SYNTAX + +``` +Disable-AzVMDiskEncryption [-ResourceGroupName] <String> [-VMName] <String> [[-VolumeType] <String>] + [[-Name] <String>] [[-TypeHandlerVersion] <String>] [-Force] [-DisableAutoUpgradeMinorVersion] + [-ExtensionType <String>] [-ExtensionPublisherName <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzVMDiskEncryption** cmdlet disables encryption on an infrastructure as a service (IaaS) virtual machine. +This cmdlet is only supported on Windows virtual machines and not Linux virtual machines. +This cmdlet installs an extension on the virtual machine to disable encryption. +If the *Name* parameter is not specified, an extension with the default name "AzureDiskEncryption for Windows VMs" is created. +Caution: This cmdlet reboots the virtual machine. + +## EXAMPLES + +### Example 1: Disable encryption for all volumes on a Windows virtual machine +```powershell +Disable-AzVMDiskEncryption -ResourceGroupName "Group001" -VMName "VM002" +``` + +This command disables encryption for volumes of type all for the virtual machine named VM002 that belongs to the resource group named Group001. +Since the *VolumeType* parameter is not specified, the cmdlet sets the value to All. + +### Example 2: Disable encryption for data volumes on a Windows virtual machine +```powershell +$ResourceGroup = "Group002" +$VMName = "VM004" +$VolumeType = "Data" +Disable-AzVMDiskEncryption -ResourceGroupName $ResourceGroup -VMName $VMName -VolumeType $VolumeType +``` + +This command disables encryption for volumes of type data for the virtual machine named VM004 that belongs to the resource group named Group002. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAutoUpgradeMinorVersion +Indicates that this cmdlet disables auto-upgrade of the minor version of the extension. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExtensionPublisherName +The extension publisher name. Specify this parameter only to override the default value of "Microsoft.Azure.Security". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExtensionType +The extension type. Specify this parameter to override its default value of "AzureDiskEncryption" for Windows VMs and "AzureDiskEncryptionForLinux" for Linux VMs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Azure Resource Manager (ARM) resource that represents the extension. +If this parameter is not specified, this cmdlet defaults to "AzureDiskEncryption for Windows VMs". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the encryption extension. +If you do not specify a value for this parameter, the latest version of the extension is used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HandlerVersion, Version + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine that this cmdlet disables encryption on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeType +Specifies the type of virtual machine volumes to perform the encryption operation. +For Windows virtual machines, valid values are: +- All +- OS +- Data. +If you do not specify a value for this parameter, the default value is All. +Disable encryption is not currently supported for Linux. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: OS, Data, All + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMDiskEncryptionStatus](./Get-AzVMDiskEncryptionStatus.md) + +[Remove-AzVMDiskEncryptionExtension](./Remove-AzVMDiskEncryptionExtension.md) + +[Set-AzVMDiskEncryptionExtension](./Set-AzVMDiskEncryptionExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Disable-AzVmssDiskEncryption.md b/azps-10.1.0/Az.Compute/Disable-AzVmssDiskEncryption.md new file mode 100644 index 0000000000..8b2cc492fb --- /dev/null +++ b/azps-10.1.0/Az.Compute/Disable-AzVmssDiskEncryption.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/disable-azvmssdiskencryption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Disable-AzVmssDiskEncryption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Disable-AzVmssDiskEncryption.md +--- + +# Disable-AzVmssDiskEncryption + +## SYNOPSIS +Disables disk encryption on a VM scale set. + +## SYNTAX + +``` +Disable-AzVmssDiskEncryption [-ResourceGroupName] <String> [-VMScaleSetName] <String> + [[-ExtensionName] <String>] [-VolumeType <String>] [-ForceUpdate] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Disables disk encryption on a VM scale set. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzVmssDiskEncryption -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" +``` + +Disables disk encryption on the VM scale set named VMSS001 that belongs to the resource group named Group001. + +### Example 2 + +Disables disk encryption on a VM scale set. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Disable-AzVmssDiskEncryption -ResourceGroupName 'Group001' -VMScaleSetName 'VMSS001' -VolumeType OS +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionName +The extension name. +If this parameter is not specified, default values used are AzureDiskEncryption for windows VMs and AzureDiskEncryptionForLinux for Linux VMs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +To force the removal of the extension from the virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpdate +Generate a tag for force update. This should be given to perform repeated encryption operations on the same VM. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +The virtual machine name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeType +Type of the volume (OS or Data) to perform encryption operation + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: OS, Data, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Export-AzLogAnalyticRequestRateByInterval.md b/azps-10.1.0/Az.Compute/Export-AzLogAnalyticRequestRateByInterval.md new file mode 100644 index 0000000000..ed1d68c75e --- /dev/null +++ b/azps-10.1.0/Az.Compute/Export-AzLogAnalyticRequestRateByInterval.md @@ -0,0 +1,325 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/export-azloganalyticrequestratebyinterval +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Export-AzLogAnalyticRequestRateByInterval.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Export-AzLogAnalyticRequestRateByInterval.md +--- + +# Export-AzLogAnalyticRequestRateByInterval + +## SYNOPSIS +Export logs that show Api requests made by this subscription in the given time window to show throttling activities. + +## SYNTAX + +``` +Export-AzLogAnalyticRequestRateByInterval [-Location] <String> [-FromTime] <DateTime> [-ToTime] <DateTime> + [-BlobContainerSasUri] <String> [-IntervalLength] <IntervalInMins> [-GroupByOperationName] + [-GroupByResourceName] [-GroupByThrottlePolicy] [-GroupByApplicationId] [-GroupByUserAgent] [-AsJob] [-NoWait] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Exports statistical data about the subscription's calls to the Microsoft.Compute API by Success, Failure, or Throttled status, in predefined time intervals. The logs can be further grouped by five parameters: GroupByOperationName, GroupByThrottlePolicy, GroupByResourceName, GroupByUserAgent, or GroupByApplicationId. +Note that this cmdlet collects only Compute Resource Provider logs; moreover, data about the Disk and Snapshot resource types is not yet available. + +For an overview of the Compute Resource Provider's API throttling, see https://learn.microsoft.com/azure/azure-resource-manager/resource-manager-request-limits. + +## EXAMPLES + +### Example 1: Export records aggregated by operation name +```powershell +Export-AzLogAnalyticRequestRateByInterval -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -IntervalLength ThirtyMins -GroupByOperationName +``` + +```output +This command downloads a .csv file to the provided container. The format of the file is: + +TIMESTAMP operationName TotalRequests SuccessfulRequests ThrottledRequests +--------- ------------- ------------- ------------------ ----------------- +2/21/2018 7:00:00 PM <operationName> 10 10 0 +2/21/2018 7:30:00 PM <operationName> 8 8 0 +2/21/2018 9:00:00 PM <operationName> 9 9 0 +``` + +This command stores the aggregated numbers of Microsoft.Compute API calls separated by Success, Failure, or Throttled between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by operation name. + +### Example 2: Export records aggregated by application id +```powershell +Export-AzLogAnalyticRequestRateByInterval -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -IntervalLength ThirtyMins -GroupByApplicationId +``` + +```output +This command downloads a .csv file to the provided container. The format of the file is: + +TIMESTAMP clientApplicationId TotalRequests SuccessfulRequests ThrottledRequests +--------- ------------------- ------------- ------------------ ----------------- +2/21/2018 7:00:00 PM <clientApplicationId> 10 10 0 +2/21/2018 7:30:00 PM <clientApplicationId> 8 8 0 +2/21/2018 9:00:00 PM <clientApplicationId> 9 9 0 +``` + +This command stores the aggregated numbers of Microsoft.Compute API calls separated by Success, Failure, or Throttled between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by application id. + +### Example 3: Export records aggregated by user agent +```powershell +Export-AzLogAnalyticRequestRateByInterval -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -IntervalLength ThirtyMins -GroupByUserAgent +``` + +```output +This command downloads a .csv file to the provided container. The format of the file is: + +TIMESTAMP userAgent TotalRequests SuccessfulRequests ThrottledRequests +--------- --------- ------------- ------------------ ----------------- +2/21/2018 7:00:00 PM <userAgent> 10 10 0 +2/21/2018 7:30:00 PM <userAgent> 8 8 0 +2/21/2018 9:00:00 PM <userAgent> 9 9 0 +``` + +This command stores the aggregated numbers of Microsoft.Compute API calls separated by Success, Failure, or Throttled between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by user agent. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobContainerSasUri +SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromTime +From time of the query + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByApplicationId +Group query result by Application Id. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByOperationName +Group query result by Operation Name. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByResourceName +Group query result by Resource Name. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByThrottlePolicy +Group query result by Throttle Policy applied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByUserAgent +Group query result by UserAgent. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntervalLength +Interval value in minutes used to create LogAnalytics call rate logs. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.IntervalInMins +Parameter Sets: (All) +Aliases: +Accepted values: ThreeMins, FiveMins, ThirtyMins, SixtyMins + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location upon which log analytic is queried. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ToTime +To time of the query + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSLogAnalyticsOperationResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Export-AzLogAnalyticThrottledRequest.md b/azps-10.1.0/Az.Compute/Export-AzLogAnalyticThrottledRequest.md new file mode 100644 index 0000000000..480fdf8dad --- /dev/null +++ b/azps-10.1.0/Az.Compute/Export-AzLogAnalyticThrottledRequest.md @@ -0,0 +1,280 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/export-azloganalyticthrottledrequest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Export-AzLogAnalyticThrottledRequest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Export-AzLogAnalyticThrottledRequest.md +--- + +# Export-AzLogAnalyticThrottledRequest + +## SYNOPSIS +Export logs that show total throttled Api requests for this subscription in the given time window. + +## SYNTAX + +``` +Export-AzLogAnalyticThrottledRequest [-Location] <String> [-FromTime] <DateTime> [-ToTime] <DateTime> + [-BlobContainerSasUri] <String> [-GroupByOperationName] [-GroupByResourceName] [-GroupByThrottlePolicy] + [-GroupByApplicationId] [-GroupByUserAgent] [-AsJob] [-NoWait] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This exports the total number of throttled Microsoft.Compute API calls. +The logs can be further aggregated by five options: GroupByOperationName, GroupByThrottlePolicy, GroupByResourceName, GroupByUserAgent, or GroupByApplicationId. +Note that this cmdlet collects only CRP logs. + +For an overview of the Compute Resource Provider's API throttling, see https://learn.microsoft.com/azure/azure-resource-manager/resource-manager-request-limits. + +## EXAMPLES + +### Example 1: Export records aggregated by operation name +```powershell +Export-AzLogAnalyticThrottledRequest -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -GroupByOperationName +``` + +This command stores the total throttled Microsoft.Compute API calls between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by operation name. + +### Example 2: Export records aggregated by applicaiton id +```powershell +Export-AzLogAnalyticThrottledRequest -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -GroupByApplicationId +``` + +This command stores the total throttled Microsoft.Compute API calls between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by appliction id. + +### Example 3: Export records aggregated by user agent +```powershell +Export-AzLogAnalyticThrottledRequest -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -GroupByUserAgent +``` + +This command stores the total throttled Microsoft.Compute API calls between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by user agent. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobContainerSasUri +SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromTime +From time of the query + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByApplicationId +Group query result by Application Id. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByOperationName +Group query result by Operation Name. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByResourceName +Group query result by Resource Name. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByThrottlePolicy +Group query result by Throttle Policy applied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByUserAgent +Group query result by UserAgent. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location upon which log analytic is queried. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ToTime +To time of the query + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSLogAnalyticsOperationResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzAvailabilitySet.md b/azps-10.1.0/Az.Compute/Get-AzAvailabilitySet.md new file mode 100644 index 0000000000..b308bcdd25 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzAvailabilitySet.md @@ -0,0 +1,262 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 45D55DC9-0027-4EB9-B2F7-9ABF6685E6B5 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azavailabilityset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzAvailabilitySet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzAvailabilitySet.md +--- + +# Get-AzAvailabilitySet + +## SYNOPSIS +Gets Azure availability sets in a resource group. + +## SYNTAX + +``` +Get-AzAvailabilitySet [[-ResourceGroupName] <String>] [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzAvailabilitySet** cmdlet gets Azure availability sets in a resource group. +You can specify the name of a specific availability set to get. + +## EXAMPLES + +### Example 1: Get a specific availability set +```powershell +Get-AzAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" +``` + +```output +ResourceGroupName : ResourceGroup11 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11/providers/ + Microsoft.Compute/availabilitySets/AvailabilitySet03 +Name : AvailabilitySet03 +Type : Microsoft.Compute/availabilitySets +Location : eastus +Managed : False +Sku : Classic +Tags : { + "a": "b" + } +PlatformFaultDomainCount : 3 +PlatformUpdateDomainCount : 2 +Statuses : [] +VirtualMachinesReferences : [] +``` + +This command gets the availability set named AvailabilitySet03 in the resource group named ResourceGroup11. + +### Example 2: Get all availability sets +```powershell +Get-AzAvailabilitySet -ResourceGroupName "ResourceGroup11" +``` + +```output +ResourceGroupName : ResourceGroup11 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11/providers/ + Microsoft.Compute/availabilitySets/AvailabilitySet02 +Name : AvailabilitySet02 +Type : Microsoft.Compute/availabilitySets +Location : eastus +Managed : False +Sku : Classic +Tags : { + "a": "b" + } +PlatformFaultDomainCount : 3 +PlatformUpdateDomainCount : 2 +Statuses : [] +VirtualMachinesReferences : [] + + +ResourceGroupName : ResourceGroup11 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11/providers/ + Microsoft.Compute/availabilitySets/AvailabilitySet03 +Name : AvailabilitySet03 +Type : Microsoft.Compute/availabilitySets +Location : eastus +Managed : False +Sku : Classic +Tags : { + "a": "b" + } +PlatformFaultDomainCount : 3 +PlatformUpdateDomainCount : 2 +Statuses : [] +VirtualMachinesReferences : [] + +ResourceGroupName : ResourceGroup11 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11/providers/ + Microsoft.Compute/availabilitySets/AvailabilitySet10 +Name : AvailabilitySet10 +Type : Microsoft.Compute/availabilitySets +Location : eastus +Managed : False +Sku : Classic +Tags : { + "a": "b" + } +PlatformFaultDomainCount : 3 +PlatformUpdateDomainCount : 2 +Statuses : [] +VirtualMachinesReferences : [] +``` + +This command gets all the availability sets in the resource group named ResourceGroup11. + +### Example 3: Get all availability sets with filtering +```powershell +Get-AzAvailabilitySet -ResourceGroupName "ResourceGroup1*" -Name "AvailabilitySet0*" +``` + +```output +ResourceGroupName : ResourceGroup11 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11/providers/ + Microsoft.Compute/availabilitySets/AvailabilitySet02 +Name : AvailabilitySet02 +Type : Microsoft.Compute/availabilitySets +Location : eastus +Managed : False +Sku : Classic +Tags : { + "a": "b" + } +PlatformFaultDomainCount : 3 +PlatformUpdateDomainCount : 2 +Statuses : [] +VirtualMachinesReferences : [] + + +ResourceGroupName : ResourceGroup11 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11/providers/ + Microsoft.Compute/availabilitySets/AvailabilitySet03 +Name : AvailabilitySet03 +Type : Microsoft.Compute/availabilitySets +Location : eastus +Managed : False +Sku : Classic +Tags : { + "a": "b" + } +PlatformFaultDomainCount : 3 +PlatformUpdateDomainCount : 2 +Statuses : [] +VirtualMachinesReferences : [] +``` + +This command gets all the availability sets in the resource group named ResourceGroup11 that start with "AvailabilitySet0". + +### Example 4: Get all availability sets with name starting with AvailabilitySet0 +```powershell +Get-AzAvailabilitySet -Name AvailabilitySet0* +``` + +```output +ResourceGroupName : ResourceGroup11 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11/providers/ + Microsoft.Compute/availabilitySets/AvailabilitySet02 +Name : AvailabilitySet02 +Type : Microsoft.Compute/availabilitySets +Location : eastus +Managed : False +Sku : Classic +Tags : { + "a": "b" + } +PlatformFaultDomainCount : 3 +PlatformUpdateDomainCount : 2 +Statuses : [] +VirtualMachinesReferences : [] + + +ResourceGroupName : ResourceGroup12 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup12/providers/ + Microsoft.Compute/availabilitySets/AvailabilitySet03 +Name : AvailabilitySet03 +Type : Microsoft.Compute/availabilitySets +Location : eastus +Managed : False +Sku : Classic +Tags : { + "a": "b" + } +PlatformFaultDomainCount : 3 +PlatformUpdateDomainCount : 2 +Statuses : [] +VirtualMachinesReferences : [] +``` + +This command gets all the availability sets that start with "AvailabilitySet0". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an availability set that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, AvailabilitySetName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet + +## NOTES + +## RELATED LINKS + +[New-AzAvailabilitySet](./New-AzAvailabilitySet.md) + +[Remove-AzAvailabilitySet](./Remove-AzAvailabilitySet.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzCapacityReservation.md b/azps-10.1.0/Az.Compute/Get-AzCapacityReservation.md new file mode 100644 index 0000000000..23539c98ab --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzCapacityReservation.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azcapacityreservation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzCapacityReservation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzCapacityReservation.md +--- + +# Get-AzCapacityReservation + +## SYNOPSIS +Gets the properties of Capacity Reservation resources from a Capacity Reservation Group + +## SYNTAX + +``` +Get-AzCapacityReservation -ResourceGroupName <String> -ReservationGroupName <String> [-Name <String>] + [-InstanceView] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCapacityReservation** cmdlet gets the properties of Capacity Reservation resources from a Capacity Reservation Group + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCapacityReservation -ResourceGroupName $rgname -ReservationGroupName "CRGroup1" +``` + +This will retrieve all the Capacity Reservation resources from the Capacity Reservation Group named "CRGroup1". + +### Example 2 +```powershell +Get-AzCapacityReservation -ResourceGroupName $rgname -ReservationGroupName "CRGroup1" -Name "resource1" -InstanceView +``` + +This will retrieve the Capacity Reservation resource named "resource1" with its instance view information from the Capacity Reservation Group named "CRGroup1". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceView +Get the Instance View of the Capacity Reservation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the capacity reservation resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CapacityReservationName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ReservationGroupName +Name of the Capacity Reservation Group that the capacity reservation resource is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CapacityReservationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSCapacityReservation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzCapacityReservationGroup.md b/azps-10.1.0/Az.Compute/Get-AzCapacityReservationGroup.md new file mode 100644 index 0000000000..74e73311fd --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzCapacityReservationGroup.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azcapacityreservationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzCapacityReservationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzCapacityReservationGroup.md +--- + +# Get-AzCapacityReservationGroup + +## SYNOPSIS +Gets the properties of Capacity Reservation Groups + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Get-AzCapacityReservationGroup [-ResourceGroupName <String>] [-Name <String>] [-InstanceView] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIDParameterSet +``` +Get-AzCapacityReservationGroup -ResourceId <String> [-InstanceView] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCapacityReservationGroup** cmdlet gets the properties of Capacity Reservation resources from a Capacity Reservation Group + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCapacityReservationGroup -ResourceGroupName $rgname -Name "CRGroup1" -InstanceView +``` + +This will retrieve the Capacity Reservation Group named "CRGroup1" with its instance view information. + +### Example 2 +```powershell +Get-AzCapacityReservationGroup -ResourceGroupName $rgname +``` + +This will retrieve all the Capacity Reservation Groups' information from resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceView +Get the Instance View of the Capacity Reservation Group. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the capacity reservation group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: CapacityReservationGroupName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +Resource ID for the capacity reservation group. + +```yaml +Type: System.String +Parameter Sets: ResourceIDParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSCapacityReservationGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzComputeResourceSku.md b/azps-10.1.0/Az.Compute/Get-AzComputeResourceSku.md new file mode 100644 index 0000000000..65dad5c6c0 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzComputeResourceSku.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azcomputeresourcesku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzComputeResourceSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzComputeResourceSku.md +--- + +# Get-AzComputeResourceSku + +## SYNOPSIS +List all compute resource Skus + +## SYNTAX + +``` +Get-AzComputeResourceSku [[-Location] <String>] [-EdgeZone <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +List all compute resource Skus + +## EXAMPLES + +### Example 1 +```powershell +Get-AzComputeResourceSku "westus"; +``` + +List all compute resource skus in West US region + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +Sets the edge zone name. If set, the query will be routed to the specified edgezone instead of the main region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies a location of the available skus to list. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSResourceSku + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzDisk.md b/azps-10.1.0/Az.Compute/Get-AzDisk.md new file mode 100644 index 0000000000..bf4f39e4ae --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzDisk.md @@ -0,0 +1,256 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azdisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzDisk.md +--- + +# Get-AzDisk + +## SYNOPSIS +Gets the properties of a Managed disk. + +## SYNTAX + +``` +Get-AzDisk [[-ResourceGroupName] <String>] [[-DiskName] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDisk** cmdlet gets the properties of a Managed disk. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' +``` + +```output +ResourceGroupName : ResourceGroup01 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.DiskSku +Zones : +TimeCreated : 6/29/2018 4:26:27 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +DiskIOPSReadWrite : 500 +DiskMBpsReadWrite : 100 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Compu + te/disks/Disk01 +Name : Disk01 +Type : Microsoft.Compute/disks +Location : westus2 +Tags : {} +``` + +This command gets the properties of the disk named 'Disk01' in the resource group 'ResourceGroup01'. + +### Example 2 +```powershell +Get-AzDisk -ResourceGroupName 'ResourceGroup01' +``` + +```output +ResourceGroupName : ResourceGroup01 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.DiskSku +Zones : +TimeCreated : 6/29/2018 4:26:27 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +DiskIOPSReadWrite : 500 +DiskMBpsReadWrite : 100 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Compu + te/disks/win1_OsDisk_1 +Name : win1_OsDisk_1 +Type : Microsoft.Compute/disks +Location : westus2 +Tags : {} + +ResourceGroupName : ResourceGroup01 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.DiskSku +Zones : +TimeCreated : 6/29/2018 4:27:27 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +DiskIOPSReadWrite : 500 +DiskMBpsReadWrite : 100 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Compu + te/disks/win1_OsDisk_2 +Name : win1_OsDisk_2 +Type : Microsoft.Compute/disks +Location : westus2 +Tags : {} +``` + +This command gets the properties of all disks in the resource group 'ResourceGroup01'. + +### Example 3 +```powershell +Get-AzDisk +``` + +```output +ResourceGroupName : ResourceGroup01 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.DiskSku +Zones : +TimeCreated : 6/29/2018 4:26:27 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +DiskIOPSReadWrite : 500 +DiskMBpsReadWrite : 100 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Compu + te/disks/win1_OsDisk_1 +Name : win1_OsDisk_1 +Type : Microsoft.Compute/disks +Location : westus2 +Tags : {} + +ResourceGroupName : ResourceGroup02 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.DiskSku +Zones : +TimeCreated : 6/29/2018 4:27:27 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +DiskIOPSReadWrite : 500 +DiskMBpsReadWrite : 100 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup02/providers/Microsoft.Compu + te/disks/win1_OsDisk_2 +Name : win1_OsDisk_2 +Type : Microsoft.Compute/disks +Location : westus2 +Tags : {} +``` + +This command gets the properties of all disks under the subscription. + +### Example 4 +```powershell +Get-AzDisk -Name win_OsDisk* +``` + +```output +ResourceGroupName : ResourceGroup01 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.DiskSku +Zones : +TimeCreated : 6/29/2018 4:26:27 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +DiskIOPSReadWrite : 500 +DiskMBpsReadWrite : 100 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Compu + te/disks/win1_OsDisk_1 +Name : win1_OsDisk_1 +Type : Microsoft.Compute/disks +Location : westus2 +Tags : {} + +ResourceGroupName : ResourceGroup02 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.DiskSku +Zones : +TimeCreated : 6/29/2018 4:27:27 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +DiskIOPSReadWrite : 500 +DiskMBpsReadWrite : 100 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup02/providers/Microsoft.Compu + te/disks/win1_OsDisk_2 +Name : win1_OsDisk_2 +Type : Microsoft.Compute/disks +Location : westus2 +Tags : {} +``` + +This command gets the properties of all disks under the subscription name starting with win1_OsDisk. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskName +Specifies the name of a disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzDiskAccess.md b/azps-10.1.0/Az.Compute/Get-AzDiskAccess.md new file mode 100644 index 0000000000..844c928900 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzDiskAccess.md @@ -0,0 +1,233 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzDiskAccess.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzDiskAccess.md +--- + +# Get-AzDiskAccess + +## SYNOPSIS +Gets the properties of Disk Accesses + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Get-AzDiskAccess [[-ResourceGroupName] <String>] [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIDParameterSet +``` +Get-AzDiskAccess [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDiskAccess** cmdlet gets the properties of Disk Accesses + +## EXAMPLES + +### Example 1: Using Default Parameter Set +```powershell +Get-AzDiskAccess -ResourceGroupName 'ResourceGroup01' -Name 'DiskAccess01' +``` + +```output +PrivateEndpointConnections : {} +ProvisioningState : Succeeded +TimeCreated : 8/13/2020 7:02:50 PM +Location : northcentralus +Id : /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/diskAccesses/DiskAccess01 +Name : DiskAccess01 +Type : Microsoft.Compute/diskAccesses +Tags : {} +``` + +This command gets the properties of a Disk Access resource named 'DiskAccess01' in the resource group 'ResourceGroup01'. + +### Example 2: Get-AzDiskAccess by Resource Group +```powershell +Get-AzDiskAccess -ResourceGroupName 'ResourceGroup01' +``` + +```output +PrivateEndpointConnections : {} +ProvisioningState : Succeeded +TimeCreated : 8/13/2020 7:02:50 PM +Location : northcentralus +Id : /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/diskAccesses/DiskAccess01 +Name : DiskAccess01 +Type : Microsoft.Compute/diskAccesses +Tags : {} + +PrivateEndpointConnections : {} +ProvisioningState : Succeeded +TimeCreated : 8/13/2020 7:05:19 PM +Location : northcentralus +Id : /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/diskAccesses/DiskAccess02 +Name : DiskAccess02 +Type : Microsoft.Compute/diskAccesses +Tags : {} +``` + +This command gets the properties of all disk accesses in the resource group 'ResourceGroup01'. + +### Example 3: Getting all Disk Access +```powershell +Get-AzDiskAccess +``` + +```output +PrivateEndpointConnections : {} +ProvisioningState : Succeeded +TimeCreated : 8/13/2020 7:02:50 PM +Location : northcentralus +Id : /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/diskAccesses/DiskAccess01 +Name : DiskAccess01 +Type : Microsoft.Compute/diskAccesses +Tags : {} + +PrivateEndpointConnections : {} +ProvisioningState : Succeeded +TimeCreated : 8/13/2020 7:05:19 PM +Location : northcentralus +Id : /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/ResourceGroup21/providers/Microsoft.Compute/diskAccesses/DiskAccess02 +Name : DiskAccess02 +Type : Microsoft.Compute/diskAccesses +Tags : {} + +PrivateEndpointConnections : {} +ProvisioningState : Succeeded +TimeCreated : 8/13/2020 7:05:19 PM +Location : northcentralus +Id : /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/ResourceGroup08/providers/Microsoft.Compute/diskAccesses/DiskAccess03 +Name : DiskAccess03 +Type : Microsoft.Compute/diskAccesses +Tags : {} +``` + +This command gets the properties of all disk accesses under the subscription. + +### Example 4: Get all Disk Access using Wildcard Character +```powershell +Get-AzDiskAccess -Name DiskAccessMicrosoft* +``` + +```output +PrivateEndpointConnections : {} +ProvisioningState : Succeeded +TimeCreated : 8/13/2020 7:02:50 PM +Location : northcentralus +Id : /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/diskAccesses/DiskAccessMicrosoftAzure +Name : DiskAccessMicrosoftAzure +Type : Microsoft.Compute/diskAccesses +Tags : {} + +PrivateEndpointConnections : {} +ProvisioningState : Succeeded +TimeCreated : 8/13/2020 7:05:19 PM +Location : northcentralus +Id : /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/diskAccesses/DiskAccessMicrosoftTeams +Name : DiskAccessMicrosoftTeams +Type : Microsoft.Compute/diskAccesses +Tags : {} +``` + +This command gets the properties of all disk accesses under the subscription name starting with 'DiskAccessMicrosoft'. + +### Example 5: Get Disk Access using ResourceId. +```powershell +Get-AzDiskAccess -ResourceId '/subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/diskAccesses/DiskAccess01' +``` + +```output +PrivateEndpointConnections : {} +ProvisioningState : Succeeded +TimeCreated : 8/13/2020 7:02:50 PM +Location : northcentralus +Id : /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/diskAccesses/DiskAccess01 +Name : DiskAccess01 +Type : Microsoft.Compute/diskAccesses +Tags : {} +``` + +This command gets the properties of a Disk Access with the given ResourceId. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a disk access. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: diskAccessName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +Resource ID for your disk access. + +```yaml +Type: System.String +Parameter Sets: ResourceIDParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskAccess + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzDiskEncryptionSet.md b/azps-10.1.0/Az.Compute/Get-AzDiskEncryptionSet.md new file mode 100644 index 0000000000..191c7b54a0 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzDiskEncryptionSet.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azdiskencryptionset.md +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzDiskEncryptionSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzDiskEncryptionSet.md +--- + +# Get-AzDiskEncryptionSet + +## SYNOPSIS +Get or list disk encryption sets. + +## SYNTAX + +``` +Get-AzDiskEncryptionSet [[-ResourceGroupName] <String>] [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list disk encryption sets. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDiskEncryptionSet -ResourceGroupName rg1 -Name enc1; +``` + +```output +ResourceGroupName : rg1 +Identity : Microsoft.Azure.Management.Compute.Models.EncryptionSetIdentity +ActiveKey : Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference +PreviousKeys : {} +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/enc1 +Name : enc1 +Type : Microsoft.Compute/diskEncryptionSets +Location : westcentralus +Tags : {} +``` + +Get disk encryption set 'enc1' + +### Example 2 +```powershell +Get-AzDiskEncryptionSet +``` + +```output +ResourceGroupName : rg1 +Identity : Microsoft.Azure.Management.Compute.Models.EncryptionSetIdentity +ActiveKey : Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference +PreviousKeys : {} +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/enc1 +Name : enc1 +Type : Microsoft.Compute/diskEncryptionSets +Location : westcentralus +Tags : {} + +ResourceGroupName : rg1 +Identity : Microsoft.Azure.Management.Compute.Models.EncryptionSetIdentity +ActiveKey : Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference +PreviousKeys : {} +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/enc2 +Name : enc2 +Type : Microsoft.Compute/diskEncryptionSets +Location : westcentralus +Tags : {} +``` + +Get all disk encryption sets in resource group 'rg1'. + +### Example 3 +```powershell +Get-AzDiskEncryptionSet -ResourceGroupName rg1 +``` + +```output +ResourceGroupName : rg1 +Identity : Microsoft.Azure.Management.Compute.Models.EncryptionSetIdentity +ActiveKey : Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference +PreviousKeys : {} +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/enc1 +Name : enc1 +Type : Microsoft.Compute/diskEncryptionSets +Location : westcentralus +Tags : {} + +ResourceGroupName : rg1 +Identity : Microsoft.Azure.Management.Compute.Models.EncryptionSetIdentity +ActiveKey : Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference +PreviousKeys : {} +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/enc2 +Name : enc2 +Type : Microsoft.Compute/diskEncryptionSets +Location : westcentralus +Tags : {} + +ResourceGroupName : rg2 +Identity : Microsoft.Azure.Management.Compute.Models.EncryptionSetIdentity +ActiveKey : Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference +PreviousKeys : {} +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/enc3 +Name : enc3 +Type : Microsoft.Compute/diskEncryptionSets +Location : westcentralus +Tags : {} +``` + +Get all disk encryption sets in subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of disk encryption set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DiskEncryptionSetName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskEncryptionSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzDiskEncryptionSetAssociatedResource.md b/azps-10.1.0/Az.Compute/Get-AzDiskEncryptionSetAssociatedResource.md new file mode 100644 index 0000000000..96a1220644 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzDiskEncryptionSetAssociatedResource.md @@ -0,0 +1,98 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzDiskEncryptionSetAssociatedResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzDiskEncryptionSetAssociatedResource.md +--- + +# Get-AzDiskEncryptionSetAssociatedResource + +## SYNOPSIS +Gets the list of resources associated with the specified disk encryption set. + +## SYNTAX + +``` +Get-AzDiskEncryptionSetAssociatedResource [-ResourceGroupName] <String> [-DiskEncryptionSetName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDiskEncryptionSetAssociatedResource** cmdlet gets the list of resources associated with the specified disk encryption set. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDiskEncryptionSetAssociatedResource -ResourceGroupName $RGname -DiskEncryptionSetName $diskEncryptionSetName +``` + +```output +/subscriptions/xxxxx-xxx-xx/resourceGroups/exampleResourceGroup/providers/Microsoft.Compute/disks/exampleDisk01 +/subscriptions/xxxxx-xxx-xx/resourceGroups/exampleResourceGroup/providers/Microsoft.Compute/disks/exmapleDisk02 +``` + +The cmdlet retrieves the two resources, 'exampleDisk01' and 'exampleDisk02', associated with the provided Disk Encryption Set + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetName +Name of disk encryption set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Uri[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzGallery.md b/azps-10.1.0/Az.Compute/Get-AzGallery.md new file mode 100644 index 0000000000..0bdb2f8814 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzGallery.md @@ -0,0 +1,364 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azgallery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzGallery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzGallery.md +--- + +# Get-AzGallery + +## SYNOPSIS +Get or list galleries. + +## SYNTAX + +### DefaultParameter (Default) +``` +Get-AzGallery [[-ResourceGroupName] <String>] [[-Name] <String>] [-Expand <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Get-AzGallery [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SharedGalleryParameterSet +``` +Get-AzGallery [-GalleryUniqueName <String>] [-Scope <String>] -Location <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### CommunityGalleryParameterSet +``` +Get-AzGallery [-GalleryPublicName <String>] [-Location <String>] [-Community] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list galleries. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzGallery -ResourceGroupName rg1 -GalleryName gallery1 +``` + +```output +ResourceGroupName : rg1 +Description : Gallery created by PowerShell. +Identifier : + UniqueName : 00000000-0000-0000-0000-000000000000-gallery1 +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/galleries/gallery1 +Name : gallery1 +Type : Microsoft.Compute/galleries +Location : southcentralus +Tags : {} +``` + +Get the gallery "gallery1" + +### Example 2 +```powershell +Get-AzGallery -ResourceGroupName rg1 +``` + +```output +ResourceGroupName : rg1 +Description : Gallery created by PowerShell. +Identifier : + UniqueName : 00000000-0000-0000-0000-000000000000-gallery1 +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/galleries/gallery1 +Name : gallery1 +Type : Microsoft.Compute/galleries +Location : southcentralus +Tags : {} + +ResourceGroupName : rg1 +Description : Gallery created by PowerShell. +Identifier : + UniqueName : 00000000-0000-0000-0000-000000000000-gallery2 +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/galleries/gallery2 +Name : gallery2 +Type : Microsoft.Compute/galleries +Location : southcentralus +Tags : {} +``` + +Get all galleries in rg1. + +### Example 3 +```powershell +Get-AzGallery +``` + +```output +ResourceGroupName : rg1 +Description : Gallery created by PowerShell. +Identifier : + UniqueName : 00000000-0000-0000-0000-000000000000-gallery1 +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/galleries/gallery1 +Name : gallery1 +Type : Microsoft.Compute/galleries +Location : southcentralus +Tags : {} + +ResourceGroupName : rg1 +Description : Gallery created by PowerShell. +Identifier : + UniqueName : 00000000-0000-0000-0000-000000000000-gallery2 +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/galleries/gallery2 +Name : gallery2 +Type : Microsoft.Compute/galleries +Location : southcentralus +Tags : {} + +ResourceGroupName : rg2 +Description : Gallery created by PowerShell. +Identifier : + UniqueName : 00000000-0000-0000-0000-000000000000-gallery3 +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg2/providers/Microsoft.Compute/galleries/gallery3 +Name : gallery3 +Type : Microsoft.Compute/galleries +Location : southcentralus +Tags : {} +``` + +Get all galleries in subscription. + +### Example 4 +```powershell +Get-AzGallery -Name gallery* +``` + +```output +ResourceGroupName : rg1 +Description : Gallery created by PowerShell. +Identifier : + UniqueName : 00000000-0000-0000-0000-000000000000-gallery1 +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/galleries/gallery1 +Name : gallery1 +Type : Microsoft.Compute/galleries +Location : southcentralus +Tags : {} + +ResourceGroupName : rg1 +Description : Gallery created by PowerShell. +Identifier : + UniqueName : 00000000-0000-0000-0000-000000000000-gallery2 +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/galleries/gallery2 +Name : gallery2 +Type : Microsoft.Compute/galleries +Location : southcentralus +Tags : {} + +ResourceGroupName : rg2 +Description : Gallery created by PowerShell. +Identifier : + UniqueName : 00000000-0000-0000-0000-000000000000-gallery3 +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg2/providers/Microsoft.Compute/galleries/gallery3 +Name : gallery3 +Type : Microsoft.Compute/galleries +Location : southcentralus +Tags : {} +``` + +Get all galleries in subscription that start with "gallery". + +### Example 5 +```powershell +Get-AzGallery -Name galleryName -ResourceGroupName rg -Expand SharingProfile/Groups +``` + +Get a gallery's sharing profile. + +## PARAMETERS + +### -Community +List community galleries. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CommunityGalleryParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +The expand query option to apply on the operation. Possible value(s): "SharingProfile/Groups" + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryPublicName +The public name of the Shared Image Gallery. + +```yaml +Type: System.String +Parameter Sets: CommunityGalleryParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryUniqueName +The unique name of the Shared Image Gallery. + +```yaml +Type: System.String +Parameter Sets: SharedGalleryParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Location of the Shared Image Gallery. + +```yaml +Type: System.String +Parameter Sets: SharedGalleryParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: CommunityGalleryParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: GalleryName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +The resource id for Gallery + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Specifies galleries shared to subscription or tenant. + +```yaml +Type: System.String +Parameter Sets: SharedGalleryParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzGalleryApplication.md b/azps-10.1.0/Az.Compute/Get-AzGalleryApplication.md new file mode 100644 index 0000000000..58db0ade07 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzGalleryApplication.md @@ -0,0 +1,183 @@ +--- +external help file: Az.Compute-help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azgalleryapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzGalleryApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzGalleryApplication.md +--- + +# Get-AzGalleryApplication + +## SYNOPSIS +Retrieves information about a gallery Application Definition. + +## SYNTAX + +### List (Default) +``` +Get-AzGalleryApplication -GalleryName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzGalleryApplication -GalleryName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzGalleryApplication -InputObject <IComputeIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves information about a gallery Application Definition. + +## EXAMPLES + +### Example 1: Get a Gallery Application in a Gallery +```powershell +Get-AzGalleryApplication -ResourceGroupName $rgName -GalleryName $galleryName -name $galleryAppName +``` + +Retrieve a Gallery Application resource with the provided Resource Group, Gallery, and Gallery Application name. + +### Example 2: Get all the Gallery Applications in a Gallery +```powershell +Get-AzGalleryApplication -GalleryName $GalleryName -ResourceGroupName $rgName +``` + +Retrieve all the Gallery Application resources in the provided Resource Group and Gallery. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryName +The name of the Shared Application Gallery from which the Application Definitions are to be retrieved. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery Application Definition to be retrieved. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: GalleryApplicationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20220103.IGalleryApplication + +## 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 <IComputeIdentity>`: Identity Parameter + - `[CommandId <String>]`: The command id. + - `[GalleryApplicationName <String>]`: The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryApplicationVersionName <String>]`: The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryImageName <String>]`: The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryImageVersionName <String>]`: The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryName <String>]`: The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. + - `[Id <String>]`: Resource identity path + - `[InstanceId <String>]`: The instance ID of the virtual machine. + - `[Location <String>]`: The location upon which run commands is queried. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[RunCommandName <String>]`: The name of the virtual machine run command. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VMName <String>]`: The name of the virtual machine where the run command should be created or updated. + - `[VMScaleSetName <String>]`: The name of the VM scale set. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzGalleryApplicationVersion.md b/azps-10.1.0/Az.Compute/Get-AzGalleryApplicationVersion.md new file mode 100644 index 0000000000..e853c92dac --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzGalleryApplicationVersion.md @@ -0,0 +1,215 @@ +--- +external help file: Az.Compute-help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azgalleryapplicationversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzGalleryApplicationVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzGalleryApplicationVersion.md +--- + +# Get-AzGalleryApplicationVersion + +## SYNOPSIS +Retrieves information about a gallery Application Version. + +## SYNTAX + +### List (Default) +``` +Get-AzGalleryApplicationVersion -GalleryApplicationName <String> -GalleryName <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzGalleryApplicationVersion -GalleryApplicationName <String> -GalleryName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Expand <ReplicationStatusTypes>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzGalleryApplicationVersion -InputObject <IComputeIdentity> [-Expand <ReplicationStatusTypes>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves information about a gallery Application Version. + +## EXAMPLES + +### Example 1: Get a Gallery Application Version +```powershell +Get-AzGalleryApplicationVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryApplicationName $galleryAppName -Name $versionName +``` + +Retrieve a Gallery Application Version resource with the provided Resource Group, Gallery, Gallery Application name, and version name. + +### Example 2: Get all the Gallery Application Versions in a GalleryApplication +```powershell +Get-AzGalleryApplicationVersion -GalleryName $GalleryName -ResourceGroupName $rgName -GalleryApplicationName $galleryAppName +``` + +Retrieve all the Gallery Application Version resources in the provided Resource Group, Gallery, and Gallery Application Name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +The expand expression to apply on the operation. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Support.ReplicationStatusTypes +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryApplicationName +The name of the gallery Application Definition in which the Application Version resides. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryName +The name of the Shared Application Gallery in which the Application Definition resides. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery Application Version to be retrieved. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: GalleryApplicationVersionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20220103.IGalleryApplicationVersion + +## 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 <IComputeIdentity>`: Identity Parameter + - `[CommandId <String>]`: The command id. + - `[GalleryApplicationName <String>]`: The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryApplicationVersionName <String>]`: The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryImageName <String>]`: The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryImageVersionName <String>]`: The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryName <String>]`: The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. + - `[Id <String>]`: Resource identity path + - `[InstanceId <String>]`: The instance ID of the virtual machine. + - `[Location <String>]`: The location upon which run commands is queried. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[RunCommandName <String>]`: The name of the virtual machine run command. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VMName <String>]`: The name of the virtual machine where the run command should be created or updated. + - `[VMScaleSetName <String>]`: The name of the VM scale set. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzGalleryImageDefinition.md b/azps-10.1.0/Az.Compute/Get-AzGalleryImageDefinition.md new file mode 100644 index 0000000000..657b33220c --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzGalleryImageDefinition.md @@ -0,0 +1,416 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azgalleryimagedefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzGalleryImageDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzGalleryImageDefinition.md +--- + +# Get-AzGalleryImageDefinition + +## SYNOPSIS +Get or list gallery image definitions. + +## SYNTAX + +### DefaultParameter (Default) +``` +Get-AzGalleryImageDefinition [-ResourceGroupName] <String> [-GalleryName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SharedGalleryParameterSet +``` +Get-AzGalleryImageDefinition [[-Name] <String>] -GalleryUniqueName <String> [-Scope <String>] + -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### CommunityGalleryParameterSet +``` +Get-AzGalleryImageDefinition [[-Name] <String>] -GalleryPublicName <String> -Location <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Get-AzGalleryImageDefinition [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ListCommunityGalleryParameterSet +``` +Get-AzGalleryImageDefinition [-Location <String>] [-Community] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get or list gallery image definitions. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzGalleryImageDefinition -ResourceGroupName rg1 -GalleryName gallery1 -GalleryImageDefinitionName image1 +``` + +```output +ResourceGroupName : rg1 +Eula : eula +PrivacyStatementUri : Https://www.microsoft.com +ReleaseNoteUri : https://www.microsoft.com +OsType : Windows +OsState : Generalized +EndOfLifeDate : 2/18/2025 12:07:00 PM +Identifier : + Publisher : PsSDKTeamTest + Offer : testgalleryoffer1 + Sku : testgallerysku1 +Recommended : + VCPUs : + Min : 2 + Max : 32 + Memory : + Min : 1 + Max : 100 +Disallowed : + DiskTypes[0] : Standard_LRS +PurchasePlan : + Name : PsSDKTestPlan + Publisher : PSSDKTeam + Product : PsSDKTestProductWindowsVm +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provi +ders/Microsoft.Compute/galleries/gallery1/images/image1 +Name : image1 +Type : Microsoft.Compute/galleries/images +Location : eastus2 +Tags : {} +``` + +Get the gallery image definition. + +### Example 2 +```powershell +Get-AzGalleryImageDefinition -ResourceGroupName rg1 -GalleryName gallery1 -GalleryImageDefinitionName image* +``` + +```output +ResourceGroupName : rg1 +Eula : eula +PrivacyStatementUri : Https://www.microsoft.com +ReleaseNoteUri : https://www.microsoft.com +OsType : Windows +OsState : Generalized +EndOfLifeDate : 2/18/2025 12:07:00 PM +Identifier : + Publisher : PsSDKTeamTest + Offer : testgalleryoffer1 + Sku : testgallerysku1 +Recommended : + VCPUs : + Min : 2 + Max : 32 + Memory : + Min : 1 + Max : 100 +Disallowed : + DiskTypes[0] : Standard_LRS +PurchasePlan : + Name : PsSDKTestPlan + Publisher : PSSDKTeam + Product : PsSDKTestProductWindowsVm +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provi +ders/Microsoft.Compute/galleries/gallery1/images/image1 +Name : image1 +Type : Microsoft.Compute/galleries/images +Location : eastus2 +Tags : {} + +ResourceGroupName : rg1 +Eula : eula +PrivacyStatementUri : Https://www.microsoft.com +ReleaseNoteUri : https://www.microsoft.com +OsType : Windows +OsState : Generalized +EndOfLifeDate : 2/18/2025 12:07:00 PM +Identifier : + Publisher : PsSDKTeamTest + Offer : testgalleryoffer1 + Sku : testgallerysku1 +Recommended : + VCPUs : + Min : 2 + Max : 32 + Memory : + Min : 1 + Max : 100 +Disallowed : + DiskTypes[0] : Standard_LRS +PurchasePlan : + Name : PsSDKTestPlan + Publisher : PSSDKTeam + Product : PsSDKTestProductWindowsVm +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provi +ders/Microsoft.Compute/galleries/gallery1/images/image2 +Name : image2 +Type : Microsoft.Compute/galleries/images +Location : eastus2 +Tags : {} +``` + +Get the gallery image definition that starts with "image". + +### Example 3 +```powershell +Get-AzGalleryImageDefinition -ResourceGroupName rg1 -GalleryName gallery1 +``` + +```output +ResourceGroupName : rg1 +Eula : eula +PrivacyStatementUri : Https://www.microsoft.com +ReleaseNoteUri : https://www.microsoft.com +OsType : Windows +OsState : Generalized +EndOfLifeDate : 2/18/2025 12:07:00 PM +Identifier : + Publisher : PsSDKTeamTest + Offer : testgalleryoffer1 + Sku : testgallerysku1 +Recommended : + VCPUs : + Min : 2 + Max : 32 + Memory : + Min : 1 + Max : 100 +Disallowed : + DiskTypes[0] : Standard_LRS +PurchasePlan : + Name : PsSDKTestPlan + Publisher : PSSDKTeam + Product : PsSDKTestProductWindowsVm +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provi +ders/Microsoft.Compute/galleries/gallery1/images/image1 +Name : image1 +Type : Microsoft.Compute/galleries/images +Location : eastus2 +Tags : {} + +ResourceGroupName : rg1 +Eula : eula +PrivacyStatementUri : Https://www.microsoft.com +ReleaseNoteUri : https://www.microsoft.com +OsType : Windows +OsState : Generalized +EndOfLifeDate : 2/18/2025 12:07:00 PM +Identifier : + Publisher : PsSDKTeamTest + Offer : testgalleryoffer1 + Sku : testgallerysku1 +Recommended : + VCPUs : + Min : 2 + Max : 32 + Memory : + Min : 1 + Max : 100 +Disallowed : + DiskTypes[0] : Standard_LRS +PurchasePlan : + Name : PsSDKTestPlan + Publisher : PSSDKTeam + Product : PsSDKTestProductWindowsVm +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provi +ders/Microsoft.Compute/galleries/gallery1/images/image2 +Name : image2 +Type : Microsoft.Compute/galleries/images +Location : eastus2 +Tags : {} +``` + +Get the gallery image definitions in gallery1. + +## PARAMETERS + +### -Community +List community galleries. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ListCommunityGalleryParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryName +The name of the gallery. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryPublicName +The public name of the Shared Image Gallery. + +```yaml +Type: System.String +Parameter Sets: CommunityGalleryParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryUniqueName +The unique name of the Shared Image Gallery. + +```yaml +Type: System.String +Parameter Sets: SharedGalleryParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Location of the Shared Image Gallery. + +```yaml +Type: System.String +Parameter Sets: SharedGalleryParameterSet, CommunityGalleryParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ListCommunityGalleryParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery image definition. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter, SharedGalleryParameterSet, CommunityGalleryParameterSet +Aliases: GalleryImageDefinitionName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource ID for the gallery image definition + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Specifies galleries shared to subscription or tenant. + +```yaml +Type: System.String +Parameter Sets: SharedGalleryParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzGalleryImageVersion.md b/azps-10.1.0/Az.Compute/Get-AzGalleryImageVersion.md new file mode 100644 index 0000000000..cc42130f61 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzGalleryImageVersion.md @@ -0,0 +1,445 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azgalleryimageversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzGalleryImageVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzGalleryImageVersion.md +--- + +# Get-AzGalleryImageVersion + +## SYNOPSIS +Get or list gallery image versions. + +## SYNTAX + +### DefaultParameter (Default) +``` +Get-AzGalleryImageVersion [-ResourceGroupName] <String> [-GalleryName] <String> + [-GalleryImageDefinitionName] <String> [[-Name] <String>] [-ExpandReplicationStatus] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SharedGalleryParameterSet +``` +Get-AzGalleryImageVersion [-GalleryImageDefinitionName] <String> [[-Name] <String>] [-ExpandReplicationStatus] + -GalleryUniqueName <String> [-Scope <String>] -Location <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### CommunityGalleryParameterSet +``` +Get-AzGalleryImageVersion [-GalleryImageDefinitionName] <String> [[-Name] <String>] [-ExpandReplicationStatus] + -GalleryPublicName <String> -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Get-AzGalleryImageVersion [-ResourceId] <String> [-ExpandReplicationStatus] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListCommunityGalleryParameterSet +``` +Get-AzGalleryImageVersion [-ExpandReplicationStatus] [-Location <String>] [-Community] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list gallery image versions. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzGalleryImageVersion -ResourceGroupName rg1 -GalleryName gallery1 -GalleryImageDefinitionName image1 -GalleryImageVersionName 1.0.0 +``` + +```output +ResourceGroupName : rg1 +PublishingProfile : + TargetRegions[0] : + Name : South Central US + RegionalReplicaCount : 1 + TargetRegions[1] : + Name : East US 2 + RegionalReplicaCount : 2 + TargetRegions[2] : + Name : Central US + RegionalReplicaCount : 1 + Source : + ManagedImage : + Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/ +providers/Microsoft.Compute/images/test1 + ReplicaCount : 1 + ExcludeFromLatest : False + PublishedDate : 11/14/2018 12:00:00 AM + EndOfLifeDate : 2/18/2025 12:07:00 PM +ProvisioningState : Succeeded +StorageProfile : + OsDiskImage : + SizeInGB : 127 + HostCaching : ReadWrite +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/ +providers/Microsoft.Compute/galleries/gallery1/images/image1/versions/1.0.0 +Name : 1.0.0 +Type : Microsoft.Compute/galleries/images/versions +Location : eastus2 +Tags : {} +``` + +Get the gallery image version. + +### Example 2 +```powershell +Get-AzGalleryImageVersion -ResourceGroupName rg1 -GalleryName gallery1 -GalleryImageDefinitionName image1 -GalleryImageVersionName 1* +``` + +```output +ResourceGroupName : rg1 +PublishingProfile : + TargetRegions[0] : + Name : South Central US + RegionalReplicaCount : 1 + TargetRegions[1] : + Name : East US 2 + RegionalReplicaCount : 2 + TargetRegions[2] : + Name : Central US + RegionalReplicaCount : 1 + Source : + ManagedImage : + Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/ +providers/Microsoft.Compute/images/test1 + ReplicaCount : 1 + ExcludeFromLatest : False + PublishedDate : 11/14/2018 12:00:00 AM + EndOfLifeDate : 2/18/2025 12:07:00 PM +ProvisioningState : Succeeded +StorageProfile : + OsDiskImage : + SizeInGB : 127 + HostCaching : ReadWrite +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/ +providers/Microsoft.Compute/galleries/gallery1/images/image1/versions/1.0.0 +Name : 1.0.0 +Type : Microsoft.Compute/galleries/images/versions +Location : eastus2 +Tags : {} + +ResourceGroupName : rg1 +PublishingProfile : + TargetRegions[0] : + Name : South Central US + RegionalReplicaCount : 1 + TargetRegions[1] : + Name : East US 2 + RegionalReplicaCount : 2 + TargetRegions[2] : + Name : Central US + RegionalReplicaCount : 1 + Source : + ManagedImage : + Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/ +providers/Microsoft.Compute/images/test1 + ReplicaCount : 1 + ExcludeFromLatest : False + PublishedDate : 11/14/2018 12:00:00 AM + EndOfLifeDate : 2/18/2025 12:07:00 PM +ProvisioningState : Succeeded +StorageProfile : + OsDiskImage : + SizeInGB : 127 + HostCaching : ReadWrite +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/ +providers/Microsoft.Compute/galleries/gallery1/images/image1/versions/1.1.0 +Name : 1.1.0 +Type : Microsoft.Compute/galleries/images/versions +Location : eastus2 +Tags : {} +``` + +Get the gallery image versions that starts with "1". + +### Example 3 +```powershell +Get-AzGalleryImageVersion -ResourceGroupName rg1 -GalleryName gallery1 -GalleryImageDefinitionName image1 +``` + +```output +ResourceGroupName : rg1 +PublishingProfile : + TargetRegions[0] : + Name : South Central US + RegionalReplicaCount : 1 + TargetRegions[1] : + Name : East US 2 + RegionalReplicaCount : 2 + TargetRegions[2] : + Name : Central US + RegionalReplicaCount : 1 + Source : + ManagedImage : + Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/ +providers/Microsoft.Compute/images/test1 + ReplicaCount : 1 + ExcludeFromLatest : False + PublishedDate : 11/14/2018 12:00:00 AM + EndOfLifeDate : 2/18/2025 12:07:00 PM +ProvisioningState : Succeeded +StorageProfile : + OsDiskImage : + SizeInGB : 127 + HostCaching : ReadWrite +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/ +providers/Microsoft.Compute/galleries/gallery1/images/image1/versions/1.0.0 +Name : 1.0.0 +Type : Microsoft.Compute/galleries/images/versions +Location : eastus2 +Tags : {} + +ResourceGroupName : rg1 +PublishingProfile : + TargetRegions[0] : + Name : South Central US + RegionalReplicaCount : 1 + TargetRegions[1] : + Name : East US 2 + RegionalReplicaCount : 2 + TargetRegions[2] : + Name : Central US + RegionalReplicaCount : 1 + Source : + ManagedImage : + Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/ +providers/Microsoft.Compute/images/test1 + ReplicaCount : 1 + ExcludeFromLatest : False + PublishedDate : 11/14/2018 12:00:00 AM + EndOfLifeDate : 2/18/2025 12:07:00 PM +ProvisioningState : Succeeded +StorageProfile : + OsDiskImage : + SizeInGB : 127 + HostCaching : ReadWrite +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/ +providers/Microsoft.Compute/galleries/gallery1/images/image1/versions/1.1.0 +Name : 1.1.0 +Type : Microsoft.Compute/galleries/images/versions +Location : eastus2 +Tags : {} +``` + +Get all gallery image versions. + +## PARAMETERS + +### -Community +List community galleries. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ListCommunityGalleryParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandReplicationStatus +Show replication status. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryImageDefinitionName +The name of the gallery image definition. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter, SharedGalleryParameterSet, CommunityGalleryParameterSet +Aliases: GalleryImageName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryName +The name of the gallery. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryPublicName +The public name of the Shared Image Gallery. + +```yaml +Type: System.String +Parameter Sets: CommunityGalleryParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryUniqueName +The unique name of the Shared Image Gallery. + +```yaml +Type: System.String +Parameter Sets: SharedGalleryParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Location of the Shared Image Gallery. + +```yaml +Type: System.String +Parameter Sets: SharedGalleryParameterSet, CommunityGalleryParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ListCommunityGalleryParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery image version. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter, SharedGalleryParameterSet, CommunityGalleryParameterSet +Aliases: GalleryImageVersionName + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource ID for the gallery image version + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Specifies galleries shared to subscription or tenant. + +```yaml +Type: System.String +Parameter Sets: SharedGalleryParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzHost.md b/azps-10.1.0/Az.Compute/Get-AzHost.md new file mode 100644 index 0000000000..4f07d3ddec --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzHost.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzHost.md +--- + +# Get-AzHost + +## SYNOPSIS +Get or list hosts. + +## SYNTAX + +### DefaultParameter (Default) +``` +Get-AzHost [-ResourceGroupName] <String> [-HostGroupName] <String> [[-Name] <String>] [-InstanceView] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Get-AzHost [-ResourceId] <String> [-InstanceView] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will get a host in a host group. +This cmdlet also lists all hosts in a host group if a host name is not given. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzHost -ResourceGroupName $resourceGroupName -HostGroupName $hostGroupName -Name $hostName +``` + +```output +ResourceGroupName : myrg01 +PlatformFaultDomain : 1 +AutoReplaceOnFailure : True +HostId : 00000000-0000-0000-0000-000000000000 +VirtualMachines[0] : + Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg01/providers/Microsoft.Compute/virtualMachines/myvm01 +VirtualMachines[1] : + Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg01/providers/Microsoft.Compute/virtualMachines/myvm02 +ProvisioningTime : 7/27/2019 3:22:59 AM +ProvisioningState : Succeeded +Sku : + Name : ESv3-Type1 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg01/providers/Microsoft.Compute/hostGroups/myhostgroup01/hosts/myhost01 +Name : myhost01 +Location : eastus +Tags : {"key1":"val2"} +``` + +This command returns a host. + +### Example 2 +```powershell +Get-AzHost -ResourceGroupName $resourceGroupName -HostGroupName $hostGroupName -Name $hostName -InstanceView +``` + +```output +ResourceGroupName : myrg01 +PlatformFaultDomain : 0 +AutoReplaceOnFailure : True +HostId : 00000000-0000-0000-0000-000000000000 +ProvisioningTime : 8/19/2019 9:13:19 PM +ProvisioningState : Succeeded +InstanceView : + AssetId : 00000000-0000-0000-0000-000000000000 + AvailableCapacity : + AllocatableVMs[0] : + VmSize : Standard_E2s_v3 + Count : 28 + AllocatableVMs[1] : + VmSize : Standard_E4-2s_v3 + Count : 14 + AllocatableVMs[2] : + VmSize : Standard_E4s_v3 + Count : 14 + Statuses[0] : + Code : ProvisioningState/succeeded + Level : Info + DisplayStatus : Provisioning succeeded + Time : 8/19/2019 9:13:19 PM + Statuses[1] : + Code : HealthState/available + Level : Info + DisplayStatus : Host available +Sku : + Name : ESv3-Type1 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg01/providers/Microsoft.Compute/hostGroups/myhostgroup01/hosts/myhost01 +Name : crptestps2264host +Location : eastus +Tags : {"key1":"val2"} +``` + +This command returns the instance view of a host. + +### Example 3 +```powershell +Get-AzHost -ResourceGroupName $resourceGroupName -HostGroupName $hostGroupName +``` + +```output +ResourceGroupName Name Location Tags Sku FD +----------------- ---- -------- ---- --- -- +myrg01 myhost01 eastus {[key1, val2]} ESv3-Type1 0 +myrg01 myhost02 eastus {[key1, val2]} ESv3-Type1 1 +``` + +This command returns all hosts in the given host group. + +### Example 4: This command retuns a Host for provided -ResourceId. +```powershell +$rgname = "rgname" +$loc = "eastus" +$hostGroupName = $rgname + "HostGroup" +$hostName = $rgname + "Host" +$Sku = "ESv3-Type1" +# Create Hostgroup and Hostgroupname +New-AzHostGroup -ResourceGroupName $rgname -Name $hostGroupName -Location $loc -PlatformFaultDomain 1 -Zone "2" +New-AzHost -ResourceGroupName $rgname -HostGroupName $hostGroupName -Name $hostName -Location $loc -Sku $Sku + +# Fetch Host using -ResouceId +$dedicatedHost = Get-AzHost -ResourceGroupName $rgname -HostGroupName $hostGroupName -Name $hostName +$host = Get-AzHost -ResourceId $dedicatedHost.Id +``` + +```output +ResourceGroupName : rgname +PlatformFaultDomain : 0 +AutoReplaceOnFailure : True +HostId : 0730655b-051d-4559-a83a-5d579d15fec2 +ProvisioningTime : 10/14/2022 7:28:47 AM +ProvisioningState : Succeeded +Sku : + Name : ESv3-Type1 +Id : /subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/rgname/providers/Microsoft.Compute/hostGroups/rgnameHostGroup/hosts/rgnameHost +Name : rgnameHost +Type : Microsoft.Compute/hostGroups/hosts +Location : eastus +Tags : {} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostGroupName +The name of the host group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstanceView +Indicates that this cmdlet gets only the instance view of the host. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the host. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: HostName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The ID of the resource. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSHost + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzHostGroup.md b/azps-10.1.0/Az.Compute/Get-AzHostGroup.md new file mode 100644 index 0000000000..e749346fd3 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzHostGroup.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azhostgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzHostGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzHostGroup.md +--- + +# Get-AzHostGroup + +## SYNOPSIS +Get or list hosts. + +## SYNTAX + +### DefaultParameter (Default) +``` +Get-AzHostGroup [[-ResourceGroupName] <String>] [[-Name] <String>] [-InstanceView] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Get-AzHostGroup [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will get a host group. +This cmdlet also lists all host groups in a resource group if a host group name is not given. +This cmdlet also lists all host groups in a subscription if neither host group name nor resource group name is given. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzHostGroup -ResourceGroupName $resourceGroupName -HostGroupName $hostGroupName +``` + +```output +ResourceGroupName : myrg01 +PlatformFaultDomainCount : 2 +Hosts : {/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg01/providers/Microsoft.Compute/hostGroups/myhostgroup01/hosts/myhost01} +Zones : {1} +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg01/providers/Microsoft.Compute/hostGroups/myhostgroup01 +Name : myhostgroup01 +Location : eastus +Tags : {[key1, val1]} +``` + +This command returns a host group. + +### Example 2 +```powershell +Get-AzHostGroup -ResourceGroupName $resourceGroupName +``` + +```output +ResourceGroupName Name Location Tags FDCount +----------------- ---- -------- ---- ------- +myrg01 myhostgroup01 eastus {[key1, val1]} 1 +myrg01 myhostgroup02 eastus {[key1, val1]} 2 +``` + +This command returns all host groups in the given resource group. + +### Example 3 +```powershell +Get-AzHostGroup +``` + +```output +ResourceGroupName Name Location Tags FDCount +----------------- ---- -------- ---- ------- +myrg01 myhostgroup01 eastus {[key1, val1]} 1 +myrg01 myhostgroup02 eastus {[key1, val1]} 2 +myrg02 myhostgroup03 eastus {[key1, val1]} 2 +``` + +This command returns all host groups in the subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceView +Expand the returned object to also list the host's instance views. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultParameter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the host group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: HostGroupName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The ID of the resource. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSHostGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzImage.md b/azps-10.1.0/Az.Compute/Get-AzImage.md new file mode 100644 index 0000000000..0b92c47461 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzImage.md @@ -0,0 +1,237 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzImage.md +--- + +# Get-AzImage + +## SYNOPSIS +Gets the properties of an image. + +## SYNTAX + +``` +Get-AzImage [[-ResourceGroupName] <String>] [[-ImageName] <String>] [[-Expand] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzImage** cmdlet gets the properties of an image. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01' +``` + +```output +ResourceGroupName : ResourceGroup01 +SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource +StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov + iders/Microsoft.Compute/images/Image01 +Name : Image01 +Type : Microsoft.Compute/images +Location : eastus2 +Tags : {} +``` + +This command gets the properties of the image named 'Image01' in the resource group 'ResourceGroup01'. + +### Example 2 +```powershell +Get-AzImage -ResourceGroupName 'ResourceGroup01' +``` + +```output +ResourceGroupName : ResourceGroup01 +SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource +StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov + iders/Microsoft.Compute/images/Image01 +Name : Image01 +Type : Microsoft.Compute/images +Location : eastus2 +Tags : {} + +ResourceGroupName : ResourceGroup01 +SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource +StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov + iders/Microsoft.Compute/images/Image02 +Name : Image02 +Type : Microsoft.Compute/images +Location : eastus2 +Tags : {} +``` + +This command gets the properties of all images in the resource group 'ResourceGroup01'. + +### Example 3 +```powershell +Get-AzImage +``` + +```output +ResourceGroupName : ResourceGroup01 +SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource +StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov + iders/Microsoft.Compute/images/Image01 +Name : Image01 +Type : Microsoft.Compute/images +Location : eastus2 +Tags : {} + +ResourceGroupName : ResourceGroup01 +SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource +StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov + iders/Microsoft.Compute/images/Image02 +Name : Image02 +Type : Microsoft.Compute/images +Location : eastus2 +Tags : {} + +ResourceGroupName : ResourceGroup02 +SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource +StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup02/prov + iders/Microsoft.Compute/images/Image03 +Name : Image03 +Type : Microsoft.Compute/images +Location : eastus2 +Tags : {} +``` + +This command gets the properties of all images under the subscription. + +### Example 4 +```powershell +Get-AzImage -Name "Image*" +``` + +```output +ResourceGroupName : ResourceGroup01 +SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource +StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov + iders/Microsoft.Compute/images/Image01 +Name : Image01 +Type : Microsoft.Compute/images +Location : eastus2 +Tags : {} + +ResourceGroupName : ResourceGroup01 +SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource +StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/prov + iders/Microsoft.Compute/images/Image02 +Name : Image02 +Type : Microsoft.Compute/images +Location : eastus2 +Tags : {} + +ResourceGroupName : ResourceGroup02 +SourceVirtualMachine : Microsoft.Azure.Management.Compute.Models.SubResource +StorageProfile : Microsoft.Azure.Management.Compute.Models.ImageStorageProfile +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup02/prov + iders/Microsoft.Compute/images/Image03 +Name : Image03 +Type : Microsoft.Compute/images +Location : eastus2 +Tags : {} +``` + +This command gets the properties of all images under the subscription that start with "Image". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Specifies the expand expression query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ImageName +Specifies the name of an image. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzProximityPlacementGroup.md b/azps-10.1.0/Az.Compute/Get-AzProximityPlacementGroup.md new file mode 100644 index 0000000000..6a798e8d5d --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzProximityPlacementGroup.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azproximityplacementgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzProximityPlacementGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzProximityPlacementGroup.md +--- + +# Get-AzProximityPlacementGroup + +## SYNOPSIS +Get or list Proximity Placement Group resource(s). + +## SYNTAX + +### DefaultParameter (Default) +``` +Get-AzProximityPlacementGroup [[-ResourceGroupName] <String>] [[-Name] <String>] [-ColocationStatus] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Get-AzProximityPlacementGroup [-ColocationStatus] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will get or list Proximity Placement Group resource(s). + +## EXAMPLES + +### Example 1 +```powershell +Get-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName -Name $proximityPlacementGroupName +``` + +```output +ResourceGroupName : rg0 +ProximityPlacementGroupType : Standard +VirtualMachines : {} +VirtualMachineScaleSets : {} +AvailabilitySets : {} +Id : /subscriptions/5393f919-a68a-43d0-9063-4b2bda6bffdf/resourceGroups/rg0/providers/Microsoft.Compute/proximityPlacementGroups/ppg0 +Name : ppg0 +Type : Microsoft.Compute/proximityPlacementGroups +Location : westcentralus +Tags : {[key1, val1]} +``` + +This command gets the proximity placement group + +### Example 2 +```powershell +Get-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName +``` + +```output +ResourceGroupName Name Location Type +----------------- ---- -------- ---- +rg0 ppg0 westcentralus Standard +rg0 ppg1 westcentralus Standard +``` + +This command list all proximity placement groups under the given resource group. + +### Example 3 +```powershell +Get-AzProximityPlacementGroup +``` + +```output +ResourceGroupName Name Location Type +----------------- ---- -------- ---- +rg0 ppg0 westcentralus Standard +rg0 ppg1 westcentralus Standard +rg1 ppg2 centralus Standard +``` + +This command list all proximity placement groups under the subscription. + +## PARAMETERS + +### -ColocationStatus +Shows the colocation status of a resource in the proximity placement group. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the proximity placement group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: ProximityPlacementGroupName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +The resource id for the proximity placement group. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSProximityPlacementGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzRemoteDesktopFile.md b/azps-10.1.0/Az.Compute/Get-AzRemoteDesktopFile.md new file mode 100644 index 0000000000..014331aac3 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzRemoteDesktopFile.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: E2A56E55-30A3-4A2F-80AE-9D166840909E +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azremotedesktopfile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzRemoteDesktopFile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzRemoteDesktopFile.md +--- + +# Get-AzRemoteDesktopFile + +## SYNOPSIS +Gets an .rdp file. + +## SYNTAX + +### Download +``` +Get-AzRemoteDesktopFile [-ResourceGroupName] <String> [-Name] <String> [-LocalPath] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Launch +``` +Get-AzRemoteDesktopFile [-ResourceGroupName] <String> [-Name] <String> [[-LocalPath] <String>] [-Launch] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRemoteDesktopFile** cmdlet gets a Remote Desktop Protocol (.rdp) file. + +## EXAMPLES + +### Example 1: Get a Remote Desktop file +```powershell +Get-AzRemoteDesktopFile -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -LocalPath "D:\RemoteDesktopFile07.rdp" +``` + +This command gets the Remote Desktop file for the virtual machine named VirtualMachine07. +The command stores the result in the file named D:\RemoteDesktopFile07.rdp. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Launch +Indicates that this cmdlet launches Remote Desktop after it gets the .rdp file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Launch +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalPath +Specifies the local full path where this cmdlet stores the .rdp file. + +```yaml +Type: System.String +Parameter Sets: Download +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: Launch +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the availability set that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VMName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzRestorePoint.md b/azps-10.1.0/Az.Compute/Get-AzRestorePoint.md new file mode 100644 index 0000000000..c29e130bff --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzRestorePoint.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azrestorepoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzRestorePoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzRestorePoint.md +--- + +# Get-AzRestorePoint + +## SYNOPSIS +Command to get the Restore Point + +## SYNTAX + +``` +Get-AzRestorePoint [-ResourceGroupName] <String> [-RestorePointCollectionName] <String> [-Name] <String> + [-InstanceView] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Command to get the Restore Point + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRestorePoint -ResourceGroupName <String> -RestorePointCollectionName <String> -Name <String> +``` + +Get Restore Point + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceView +InstanceView of the resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RestorePointName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestorePointCollectionName +Restore Point Collection Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSRestorePoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzRestorePointCollection.md b/azps-10.1.0/Az.Compute/Get-AzRestorePointCollection.md new file mode 100644 index 0000000000..74bc7a1a28 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzRestorePointCollection.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azrestorepointcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzRestorePointCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzRestorePointCollection.md +--- + +# Get-AzRestorePointCollection + +## SYNOPSIS +Get a Restore Point Collection + +## SYNTAX + +``` +Get-AzRestorePointCollection [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a Restore Point Collection + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRestorePointCollection -ResourceGroupName <String> -Name <String> +``` + +Used to get Restore Point Collection + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RestorePointCollectionName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSRestorePointCollection + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzSnapshot.md b/azps-10.1.0/Az.Compute/Get-AzSnapshot.md new file mode 100644 index 0000000000..f6db98517a --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzSnapshot.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azsnapshot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzSnapshot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzSnapshot.md +--- + +# Get-AzSnapshot + +## SYNOPSIS +Gets the properties of a snapshot + +## SYNTAX + +``` +Get-AzSnapshot [[-ResourceGroupName] <String>] [[-SnapshotName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSnapshot** cmdlet gets the properties of a snapshot. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSnapshot +``` + +```output +ResourceGroupName : ResourceGroupName1 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.SnapshotSku +TimeCreated : 4/10/2018 7:05:42 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupName1/providers/Microsoft.Compu + te/snapshots/SnapshotName1 +Name : SnapshotName1 +Type : Microsoft.Compute/snapshots +Location : westus2 +Tags : {} + +ResourceGroupName : ResourceGroupName1 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.SnapshotSku +TimeCreated : 4/10/2018 7:05:42 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupName1/providers/Microsoft.Compu + te/snapshots/SnapshotName2 +Name : SnapshotName2 +Type : Microsoft.Compute/snapshots +Location : westus2 +Tags : {} + +ResourceGroupName : ResourceGroupName2 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.SnapshotSku +TimeCreated : 4/10/2018 7:05:42 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupName2/providers/Microsoft.Compu + te/snapshots/SnapshotName3 +Name : SnapshotName3 +Type : Microsoft.Compute/snapshots +Location : westus2 +Tags : {} +``` + +This command gets the properties of all snapshots of the subscription. + +### Example 2 +```powershell +Get-AzSnapshot -ResourceGroupName "ResourceGroupName1" +``` + +```output +ResourceGroupName : ResourceGroupName1 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.SnapshotSku +TimeCreated : 4/10/2018 7:05:42 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupName1/providers/Microsoft.Compu + te/snapshots/SnapshotName1 +Name : SnapshotName1 +Type : Microsoft.Compute/snapshots +Location : westus2 +Tags : {} + +ResourceGroupName : ResourceGroupName1 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.SnapshotSku +TimeCreated : 4/10/2018 7:05:42 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupName1/providers/Microsoft.Compu + te/snapshots/SnapshotName2 +Name : SnapshotName2 +Type : Microsoft.Compute/snapshots +Location : westus2 +Tags : {} +``` + +This command gets the properties of all snapshots in the resource group named "ResourceGroupName1" + +### Example 3 +```powershell +Get-AzSnapshot -ResourceGroupName "ResourceGroupName1" -SnapshotName "SnapshotName1" +``` + +```output +ResourceGroupName : ResourceGroupName1 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.SnapshotSku +TimeCreated : 4/10/2018 7:05:42 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupName1/providers/Microsoft.Compu + te/snapshots/SnapshotName1 +Name : SnapshotName1 +Type : Microsoft.Compute/snapshots +Location : westus2 +Tags : {} +``` + +This command gets the properties of the snapshot named "SnapshotName1" in the resource group named "ResourceGroupName1" + +### Example 4 +```powershell +Get-AzSnapshot -SnapshotName "SnapshotName*" +``` + +```output +ResourceGroupName : ResourceGroupName1 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.SnapshotSku +TimeCreated : 4/10/2018 7:05:42 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupName1/providers/Microsoft.Compu + te/snapshots/SnapshotName1 +Name : SnapshotName1 +Type : Microsoft.Compute/snapshots +Location : westus2 +Tags : {} + +ResourceGroupName : ResourceGroupName1 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.SnapshotSku +TimeCreated : 4/10/2018 7:05:42 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupName1/providers/Microsoft.Compu + te/snapshots/SnapshotName2 +Name : SnapshotName2 +Type : Microsoft.Compute/snapshots +Location : westus2 +Tags : {} + +ResourceGroupName : ResourceGroupName2 +ManagedBy : +Sku : Microsoft.Azure.Management.Compute.Models.SnapshotSku +TimeCreated : 4/10/2018 7:05:42 PM +OsType : Windows +CreationData : Microsoft.Azure.Management.Compute.Models.CreationData +DiskSizeGB : 127 +EncryptionSettings : +ProvisioningState : Succeeded +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupName2/providers/Microsoft.Compu + te/snapshots/SnapshotName3 +Name : SnapshotName3 +Type : Microsoft.Compute/snapshots +Location : westus2 +Tags : {} +``` + +This command gets all snapshots that start with "SnapshotName" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SnapshotName +Specifies the name of a snapshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzSshKey.md b/azps-10.1.0/Az.Compute/Get-AzSshKey.md new file mode 100644 index 0000000000..3554cd6570 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzSshKey.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azsshkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzSshKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzSshKey.md +--- + +# Get-AzSshKey + +## SYNOPSIS +Gets the properties of SSH Public Key resources. + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Get-AzSshKey [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIDParameterSet +``` +Get-AzSshKey -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of SSH Public Key resources. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSshKey -ResourceGroupName "testRG" -Name "SshKey1" +``` + +This example retrieves a specific Ssh Public Key resource. + +### Example 2 +```powershell +Get-AzSshKey -ResourceGroupName "testRG" +``` + +This example retrieves a list of Ssh Public Key resources that are in Resource Group: "testRG" + +### Example 3 +```powershell +Get-AzSshKey +``` + +This example retrieves all the Ssh Public Key resources in the subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Ssh Public Key resource to get. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: sshkeyName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +Resource ID for your SSH Public Key Resource. + +```yaml +Type: System.String +Parameter Sets: ResourceIDParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSshPublicKeyResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzVM.md b/azps-10.1.0/Az.Compute/Get-AzVM.md new file mode 100644 index 0000000000..5f1fc3a281 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVM.md @@ -0,0 +1,448 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 6250EC11-79CF-428B-A72F-9BD72C1751F0 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVM.md +--- + +# Get-AzVM + +## SYNOPSIS +Gets the properties of a virtual machine. + +## SYNTAX + +### DefaultParamSet (Default) +``` +Get-AzVM [[-ResourceGroupName] <String>] [[-Name] <String>] [-Status] [-UserData] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetVirtualMachineInResourceGroupParamSet +``` +Get-AzVM [-ResourceGroupName] <String> [-Name] <String> [-Status] [-DisplayHint <DisplayHintType>] [-UserData] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListLocationVirtualMachinesParamSet +``` +Get-AzVM -Location <String> [-Status] [-UserData] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetVirtualMachineById +``` +Get-AzVM [-Status] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVM** cmdlet gets the model view or the instance view of an Azure virtual machine. +The model view is the user specified properties of the virtual machine. +The instance view is the instance level status of the virtual machine. +Specify the *Status* parameter to get the instance view of a virtual machine instead of the model view which is the default. + +## EXAMPLES + +### Example 1: Get model and instance view properties +```powershell +Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" +``` + +```output +ResourceGroupName : ResourceGroup11 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup11/providers/M +icrosoft.Compute/virtualMachines/VirtualMachine07 +VmId : 00000000-0000-0000-0000-000000000000 +Name : VirtualMachine07 +Type : Microsoft.Compute/virtualMachines +Location : eastus +Tags : {"creationSource":"acs-VirtualMachine07"} +AvailabilitySetReference : {Id} +DiagnosticsProfile : {BootDiagnostics} +Extensions : {linuxdiagnostic, waitforleader} +HardwareProfile : {VmSize} +NetworkProfile : {NetworkInterfaces} +OSProfile : {ComputerName, AdminUsername, LinuxConfiguration, Secrets} +ProvisioningState : Succeeded +StorageProfile : {ImageReference, OsDisk, DataDisks} +``` + +This command gets the model view and instance view properties of the virtual machine named VirtualMachine07. + +### Example 2: Get instance view properties +```powershell +Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -Status +``` + +```output +ResourceGroupName : ResourceGroup11 +Name : VirtualMachine07 +Disks[0] : + Name : VirtualMachine07-osdisk + Statuses[0] : + Code : ProvisioningState/succeeded + Level : Info + DisplayStatus : Provisioning succeeded + Time : 3/1/2019 12:59:30 AM +Extensions[0] : + Name : linuxdiagnostic + Type : Microsoft.OSTCExtensions.LinuxDiagnostic + TypeHandlerVersion : 2.3.9029 + Statuses[0] : + Code : ProvisioningState/succeeded + Level : Info + DisplayStatus : Provisioning succeeded + Message : Invalid config settings given: Empty storageAccountName. Install will proceed, but enable +can't proceed, in which case it's still considered a success as it's an external error. +Extensions[1] : + Name : waitforleader + Type : Microsoft.OSTCExtensions.CustomScriptForLinux + TypeHandlerVersion : 1.5.4 + Statuses[0] : + Code : ProvisioningState/succeeded + Level : Info + DisplayStatus : Provisioning succeeded + Message : Command is finished. +---stdout--- +waiting for leader.mesos +waiting for leader.mesos +waiting for leader.mesos +waiting for leader.mesos +waiting for leader.mesos +waiting for leader.mesos +PING leader.mesos (xxx.xx.x.x) 56(84) bytes of data. +64 bytes from xxx.xx.x.x: icmp_seq=1 ttl=64 time=0.022 ms + +--- leader.mesos ping statistics --- +1 packets transmitted, 1 received, 0% packet loss, time 0ms +rtt min/avg/max/mdev = 0.022/0.022/0.022/0.000 ms +leader.mesos up + +---errout--- +ping: unknown host leader.mesos +ping: unknown host leader.mesos +ping: unknown host leader.mesos +ping: unknown host leader.mesos +ping: unknown host leader.mesos +ping: unknown host leader.mesos + + +PlatformFaultDomain : 0 +PlatformUpdateDomain : 0 +VMAgent : + VmAgentVersion : 2.2.37 + ExtensionHandlers[0] : + Type : Microsoft.OSTCExtensions.LinuxDiagnostic + TypeHandlerVersion : 2.3.9029 + Status : + Code : ProvisioningState/succeeded + Level : Info + DisplayStatus : Ready + Message : Plugin enabled + ExtensionHandlers[1] : + Type : Microsoft.OSTCExtensions.CustomScriptForLinux + TypeHandlerVersion : 1.5.4 + Status : + Code : ProvisioningState/succeeded + Level : Info + DisplayStatus : Ready + Message : Plugin enabled + Statuses[0] : + Code : ProvisioningState/succeeded + Level : Info + DisplayStatus : Ready + Message : Guest Agent is running + Time : 3/1/2019 2:04:12 AM +Statuses[0] : + Code : ProvisioningState/succeeded + Level : Info + DisplayStatus : Provisioning succeeded + Time : 3/1/2019 1:01:57 AM +Statuses[1] : + Code : PowerState/running + Level : Info + DisplayStatus : VM running +``` + +This command gets properties of the virtual machine named VirtualMachine07. +This command specifies the *Status* parameter. +Therefore, the command gets only the instance view properties. + +### Example 3: Get properties for all virtual machines in a resource group +```powershell +Get-AzVM -ResourceGroupName "ResourceGroup11" +``` + +```output +ResourceGroupName Name Location VmSize OsType NIC +----------------- ---- -------- ------ ------ --- +ResourceGroup11 test1 eastus Standard_DS1_v2 Windows test1 +ResourceGroup11 test2 westus Standard_DS1_v2 Windows test2 +ResourceGroup11 test3 eastus Standard_DS1_v2 Windows test3 +``` + +This command gets properties for all the virtual machines in the resource group named ResourceGroup11. + +### Example 4: Get all virtual machines in your subscription +```powershell +Get-AzVM +``` + +```output +ResourceGroupName Name Location VmSize OsType NIC +----------------- ---- -------- ------ ------ --- +TEST1 test1 eastus Standard_DS1_v2 Windows test1 +TEST1 test2 westus Standard_DS1_v2 Windows test2 +TEST1 test3 eastus Standard_DS1_v2 Windows test3 +TEST2 test4 westus Standard_DS1_v2 Windows test4 +TEST2 test5 eastus Standard_DS1_v2 Windows test5 +``` + +This command gets all the virtual machines in your subscription. + +### Example 5: Get all virtual machines in the location. +```powershell +Get-AzVM -Location "westus" +``` + +```output +ResourceGroupName Name Location VmSize OsType NIC +----------------- ---- -------- ------ ------ --- +TEST1 test2 westus Standard_DS1_v2 Windows test2 +TEST2 test4 westus Standard_DS1_v2 Windows test4 +``` + +This command gets all the virtual machines in West US region. + +### Example 6: Get all virtual machines using filtering +```powershell +Get-AzVM -Name test* +``` + +```output +ResourceGroupName Name Location VmSize OsType NIC +----------------- ---- -------- ------ ------ --- +TEST1 test1 eastus Standard_DS1_v2 Windows test1 +TEST1 test2 westus Standard_DS1_v2 Windows test2 +TEST1 test3 eastus Standard_DS1_v2 Windows test3 +TEST2 test4 westus Standard_DS1_v2 Windows test4 +TEST2 test5 eastus Standard_DS1_v2 Windows test5 +``` + +This command gets all virtual machines with names start with "test" + +### Example 7: Get VM with UserData value +```powershell +Get-AzVM -ResourceGroupName <Resource Group Name> -Name <VM Name> -UserData; +``` + +```output +ResourceGroupName : <> +Id : /subscriptions/<Subscription Id>/resourceGroups/<Resource Group Name>/providers/Microsoft +.Compute/virtualMachines/<VM Name> +VmId : <VM Id> +Name : <VM Name> +Type : Microsoft.Compute/virtualMachines +Location : eastus +Tags : +{"azsecpack":"nonprod","platformsettings.host_environment.service.platform_optedin_for_rootcerts":"true"} +Extensions : {Microsoft.Azure.Geneva.GenevaMonitoring, +Microsoft.Azure.Security.AntimalwareSignature.AntimalwareConfiguration} +HardwareProfile : {VmSize} +NetworkProfile : {NetworkInterfaces} +OSProfile : {ComputerName, AdminUsername, WindowsConfiguration, Secrets, AllowExtensionOperations, +RequireGuestProvisionSignal} +ProvisioningState : Succeeded +StorageProfile : {ImageReference, OsDisk, DataDisks} +UserData : bm90IGVuY29kZWQ= +``` + +The UserData value must always be Base64 encoded. This command assumes you have already created a VM with a UserData value. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayHint +Determines how the virtual machine object is displayed. +Valid values are: +-- Compact: displays only top level properties +-- Expand: displays all properties in all levels + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.DisplayHintType +Parameter Sets: GetVirtualMachineInResourceGroupParamSet +Aliases: +Accepted values: Compact, Expand + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies a location for the virtual machines to list. + +```yaml +Type: System.String +Parameter Sets: ListLocationVirtualMachinesParamSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual machine to get. + +```yaml +Type: System.String +Parameter Sets: DefaultParamSet +Aliases: ResourceName, VMName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: GetVirtualMachineInResourceGroupParamSet +Aliases: ResourceName, VMName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: GetVirtualMachineInResourceGroupParamSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +Id of the VM + +```yaml +Type: System.String +Parameter Sets: GetVirtualMachineById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Status +Indicates that this cmdlet gets only the instance view of the virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserData +UserData for the VM, which will be base-64 encoded. Customer should not pass any secrets in here. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultParamSet, GetVirtualMachineInResourceGroupParamSet, ListLocationVirtualMachinesParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Uri + +### Microsoft.Azure.Commands.Compute.Models.DisplayHintType + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineInstanceView + +## NOTES + +## RELATED LINKS + +[New-AzVM](./New-AzVM.md) + +[Remove-AzVM](./Remove-AzVM.md) + +[Restart-AzVM](./Restart-AzVM.md) + +[Start-AzVM](./Start-AzVM.md) + +[Stop-AzVM](./Stop-AzVM.md) + +[Update-AzVM](./Update-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMADDomainExtension.md b/azps-10.1.0/Az.Compute/Get-AzVMADDomainExtension.md new file mode 100644 index 0000000000..97f7dfe56c --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMADDomainExtension.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 49D17667-35C3-4A79-A0C8-C197DAA5CD90 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmaddomainextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMADDomainExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMADDomainExtension.md +--- + +# Get-AzVMADDomainExtension + +## SYNOPSIS +Gets information about an AD domain extension. + +## SYNTAX + +``` +Get-AzVMADDomainExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Status] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMADDomainExtension** cmdlet gets information about the specified Azure Active Directory (AD) domain extension. + +## EXAMPLES + +### Example 1 + +Gets information about an AD domain extension. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Get-AzVMADDomainExtension -Name 'AgentPool01' -ResourceGroupName myresourcegroup -VMName 'VM01' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the domain extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +Indicates that this cmdlet gets the instance view of the domain extension. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.VirtualMachineADDomainExtensionContext + +## NOTES + +## RELATED LINKS + +[Set-AzVMADDomainExtension](./Set-AzVMADDomainExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMAEMExtension.md b/azps-10.1.0/Az.Compute/Get-AzVMAEMExtension.md new file mode 100644 index 0000000000..0b46c2c0c4 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMAEMExtension.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 212281F0-9A3E-4652-919F-400455E3950E +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmaemextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMAEMExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMAEMExtension.md +--- + +# Get-AzVMAEMExtension + +## SYNOPSIS +Gets information about the AEM extension. + +## SYNTAX + +``` +Get-AzVMAEMExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] + [[-OSType] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMAEMExtension** cmdlet gets information about the Azure Enhanced Monitoring (AEM) extension. + +## EXAMPLES + +### Example 1: Get the AEM extension +```powershell +Get-AzVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server" +``` + +This command gets information for the AEM extension for the virtual machine named contoso-server. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a virtual machine. +This cmdlet gets information for the AEM extension on the virtual machine that this cmdlet specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OSType +Specifies the type of the operating system of the operating system disk. +If the operating system disk does not have a type, you must specify this parameter. +The acceptable values for this parameter are: Windows and Linux. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of a virtual machine. +This cmdlet gets information for the AEM extension on that virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +Indicates that this cmdlet gets only the instance view of the AEM extension. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine. +This cmdlet gets information about AEM extension for the virtual machine that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension + +## NOTES + +## RELATED LINKS + +[Remove-AzVMAEMExtension](./Remove-AzVMAEMExtension.md) + +[Set-AzVMAEMExtension](./Set-AzVMAEMExtension.md) + +[Test-AzVMAEMExtension](./Test-AzVMAEMExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMAccessExtension.md b/azps-10.1.0/Az.Compute/Get-AzVMAccessExtension.md new file mode 100644 index 0000000000..4e1bc1d314 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMAccessExtension.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 32CF9DA7-5607-4CF9-A2D0-D76A0C005FDA +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmaccessextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMAccessExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMAccessExtension.md +--- + +# Get-AzVMAccessExtension + +## SYNOPSIS +Gets information about the VMAccess extension. + +## SYNTAX + +``` +Get-AzVMAccessExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Status] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMAccessExtension** cmdlet gets information about the Virtual Machine Access (VMAccess) Virtual Machine Extension. + +## EXAMPLES + +### Example 1: Get the VMAccess extension +```powershell +$VMAccessExtension = Get-AzVMAccessExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoTest" +``` + +This command gets the VMAccess extension named ContosoTest for the virtual machine named VirtualMachine07. + +### Example 2: Get the instance view of the VMAccess extension +```powershell +$VMAccessExtension = Get-AzVMAccessExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoTest" -Status +``` + +This command gets the instance view of the VMAccess extension named ContosoTest for the virtual machine named VirtualMachine07. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the extension that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +Indicates that this cmdlet gets only the instance view of the extension. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine. +This cmdlet gets information about VMAccess for the virtual machine that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.VirtualMachineAccessExtensionContext + +## NOTES + +## RELATED LINKS + +[Remove-AzVMAccessExtension](./Remove-AzVMAccessExtension.md) + +[Set-AzVMAccessExtension](./Set-AzVMAccessExtension.md) + +[Get-AzVMExtension](./Get-AzVMExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMBootDiagnosticsData.md b/azps-10.1.0/Az.Compute/Get-AzVMBootDiagnosticsData.md new file mode 100644 index 0000000000..3cf0d7718b --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMBootDiagnosticsData.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 15CAC050-F2E9-4872-88E7-516A6D194FAB +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmbootdiagnosticsdata +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMBootDiagnosticsData.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMBootDiagnosticsData.md +--- + +# Get-AzVMBootDiagnosticsData + +## SYNOPSIS +Gets boot diagnostics data for a virtual machine. + +## SYNTAX + +### WindowsParamSet (Default) +``` +Get-AzVMBootDiagnosticsData [-ResourceGroupName] <String> [-Name] <String> [-Windows] [-LocalPath] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### LinuxParamSet +``` +Get-AzVMBootDiagnosticsData [-ResourceGroupName] <String> [-Name] <String> [-Linux] [[-LocalPath] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMBootDiagnosticsData** cmdlet gets boot diagnostics data for a virtual machine. + +## EXAMPLES + +### Example 1: Get boot diagnostics data +```powershell +Get-AzVMBootDiagnosticsData -ResourceGroupName "ResourceGroup11" -Name "ContosoVM07" -Windows -LocalPath "C:\Contoso\BootDiagnostics" +``` + +This command gets boot diagnostics data for the virtual machine named ContosoVM07. +This virtual machine runs the Windows operating system. +The command stores the data in specified local path. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Linux +Indicates that the virtual machine runs the Linux operating system. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: LinuxParamSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalPath +Specifies the local path for the boot diagnostics data. + +```yaml +Type: System.String +Parameter Sets: WindowsParamSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: LinuxParamSet +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual machine for which this cmdlet gets diagnostics data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VMName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Windows +Indicates that the virtual machine runs the Windows operating system. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WindowsParamSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineInstanceView + +## NOTES + +## RELATED LINKS + +[Set-AzVMBootDiagnostic](./Set-AzVMBootDiagnostic.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMChefExtension.md b/azps-10.1.0/Az.Compute/Get-AzVMChefExtension.md new file mode 100644 index 0000000000..45178c9e7f --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMChefExtension.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: F41953F1-9515-4081-8624-6A1494DA4BB2 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmchefextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMChefExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMChefExtension.md +--- + +# Get-AzVMChefExtension + +## SYNOPSIS +Gets information about a Chef extension. + +## SYNTAX + +### Linux +``` +Get-AzVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] [-Linux] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Windows +``` +Get-AzVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] [-Windows] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMChefExtension** cmdlet gets information about a Chef extension installed on a virtual machine. + +## EXAMPLES + +### Example 1: Get the details of Chef extension for a Windows virtual machine +```powershell +Get-AzVMChefExtension -ResourceGroupName "ResourceGroup001" -VMName "WindowsVM001" -Windows +``` + +This command gets the Chef extension from a Windows virtual machine named WindowsVM001 that belongs to the resource group named ResourceGroup001. + +### Example 2: Get the details of Chef extension for a Linux virtual machine +```powershell +Get-AzVMChefExtension -ResourceGroupName "ResourceGroup002" -VMName "LinuxVM001" -Linux +``` + +This command gets the Chef extension from a Linux virtual machine named LinuxVM001 that belongs to the resource group named ResourceGroup002. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Linux +Indicates that this cmdlet works on a Linux virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Linux +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Chef extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +Indicates that this cmdlet gets only the instance view of the Chef extension. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Windows +Indicates that this cmdlet is for a Windows virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Windows +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension + +## NOTES + +## RELATED LINKS + +[Set-AzVMChefExtension](./Set-AzVMChefExtension.md) + +[Remove-AzVMChefExtension](./Remove-AzVMChefExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMCustomScriptExtension.md b/azps-10.1.0/Az.Compute/Get-AzVMCustomScriptExtension.md new file mode 100644 index 0000000000..3d44dcba2a --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMCustomScriptExtension.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 1017A74D-6420-4E51-A4A4-1AD3AD6D8122 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmcustomscriptextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMCustomScriptExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMCustomScriptExtension.md +--- + +# Get-AzVMCustomScriptExtension + +## SYNOPSIS +Gets information about a custom script extension. + +## SYNTAX + +``` +Get-AzVMCustomScriptExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Status] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMCustomScriptExtension** cmdlet gets information about a custom script Virtual Machine Extension on a virtual machine. + +## EXAMPLES + +### Example 1: Get a custom script extension +```powershell +$VMCustomScriptExtension = Get-AzVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoCustomScript" +``` + +This command gets the custom script extension named ContosoCustomScript for the virtual machine named VirtualMachine07. + +### Example 2: Get the instance view of a custom script extension +```powershell +$VMCustomScriptExtension = Get-AzVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoCustomScript" -Status +``` + +This command gets the instance view of the custom script extension named ContosoCustomScript for the virtual machine named VirtualMachine07. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the custom script extension about which this cmdlet gets information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +Indicates that this cmdlet gets the instance view of the custom script extension. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine for which this cmdlet gets the custom script extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.VirtualMachineCustomScriptExtensionContext + +## NOTES + +## RELATED LINKS + +[Get-AzVMAccessExtension](./Get-AzVMAccessExtension.md) + +[Get-AzVMExtension](./Get-AzVMExtension.md) + +[Get-AzVMExtensionImage](./Get-AzVMExtensionImage.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMDiagnosticsExtension.md b/azps-10.1.0/Az.Compute/Get-AzVMDiagnosticsExtension.md new file mode 100644 index 0000000000..543c307616 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMDiagnosticsExtension.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: D5BEA683-44AE-4D71-827D-02A03F0BEAE9 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmdiagnosticsextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMDiagnosticsExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMDiagnosticsExtension.md +--- + +# Get-AzVMDiagnosticsExtension + +## SYNOPSIS +Gets the settings of the Diagnostics extension on a virtual machine. + +## SYNTAX + +``` +Get-AzVMDiagnosticsExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMDiagnosticsExtension** cmdlet gets the settings of the Azure Diagnostics extension on a virtual machine. + +## EXAMPLES + +### Example 1: Get the diagnostics extension applied to a virtual machine +```powershell +Get-AzVMDiagnosticsExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM22" +``` + +This command gets the diagnostics extension applied to the virtual machine named ContosoVM22. + +### Example 2 + +Gets the settings of the Diagnostics extension on a virtual machine. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Get-AzVMDiagnosticsExtension -Name 'AgentPool01' -ResourceGroupName 'ResourceGroup11' -Status -VMName 'ContosoVM22' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Diagnostics extension for which this cmdlet gets settings. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +Indicates that this cmdlet uses the Status value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine from which this cmdlet gets the Diagnostics extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension + +## NOTES + +## RELATED LINKS + +[Remove-AzVMDiagnosticsExtension](./Remove-AzVMDiagnosticsExtension.md) + +[Set-AzVMDiagnosticsExtension](./Set-AzVMDiagnosticsExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMDiskEncryptionStatus.md b/azps-10.1.0/Az.Compute/Get-AzVMDiskEncryptionStatus.md new file mode 100644 index 0000000000..26f8d655fa --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMDiskEncryptionStatus.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: E6F91D2E-6481-44C2-AF21-F62947C3D78C +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmdiskencryptionstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMDiskEncryptionStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMDiskEncryptionStatus.md +--- + +# Get-AzVMDiskEncryptionStatus + +## SYNOPSIS +Gets the encryption status of the virtual machine. + +## SYNTAX + +``` +Get-AzVMDiskEncryptionStatus [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] + [-ExtensionType <String>] [-ExtensionPublisherName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMDiskEncryptionStatus** cmdlet gets the encryption status of the virtual machine. +It displays the encryption status of the operating system and data volumes. +In addition to encryption status, it also displays the encryption secret URL, key encryption key URL, resource IDs of the **KeyVaults** where the encryption key and key encryption key for operating system volume are present. + +## EXAMPLES + +### Example 1: Get the encryption status of a virtual machine +```powershell +Get-AzVmDiskEncryptionStatus -ResourceGroupName "MyResourceGroup001" -VMName "VM001" +``` + +This command gets the encryption status of the virtual machine named VM001. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionPublisherName +The extension publisher name. Specify this parameter only to override the default value of "Microsoft.Azure.Security". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExtensionType +The extension type. Specify this parameter to override its default value of "AzureDiskEncryption" for Windows VMs and "AzureDiskEncryptionForLinux" for Linux VMs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Extension.AzureDiskEncryption.AzureDiskEncryptionExtensionContext + +## NOTES + +## RELATED LINKS + +[Remove-AzVMDiskEncryptionExtension](./Remove-AzVMDiskEncryptionExtension.md) + +[Set-AzVMDiskEncryptionExtension](./Set-AzVMDiskEncryptionExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMDscExtension.md b/azps-10.1.0/Az.Compute/Get-AzVMDscExtension.md new file mode 100644 index 0000000000..73a3aa2c40 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMDscExtension.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 5B7A1BE6-F5F5-4968-BE32-7743D0E25FE3 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmdscextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMDscExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMDscExtension.md +--- + +# Get-AzVMDscExtension + +## SYNOPSIS +Gets the settings of the DSC extension on a particular virtual machine. + +## SYNTAX + +### GetDscExtension (Default) +``` +Get-AzVMDscExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### VMParameterSet +``` +Get-AzVMDscExtension [-Status] [-VM <PSVirtualMachine>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMDscExtension** cmdlet gets the settings of the Desired State Configuration (DSC) extension on a particular virtual machine. + +## EXAMPLES + +### Example 1: Get the settings of a DSC extension +```powershell +Get-AzVMDscExtension -ResourceGroupName "ResourceGroup002" -VMName "VM07" -Name "DSC" +``` + +This command gets the settings of extension named DSC on the virtual machine named VM07. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Azure Resource Manager resource that represents the extension. +The Set-AzVMDscExtension cmdlet sets this name to Microsoft.Powershell.DSC, which is the same value that is used by **Get-AzVMDscExtension**. +Specify this parameter only if you changed the default name in the **Set-AzVMDscExtension** cmdlet or used a different resource name in a Resource Manager template. + +```yaml +Type: System.String +Parameter Sets: GetDscExtension +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: GetDscExtension +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +Indicates that this cmdlet gets the instance view of the DSC extension. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine object the extension is on. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: VMParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine for which this cmdlet gets the DSC extension. + +```yaml +Type: System.String +Parameter Sets: GetDscExtension +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Extension.DSC.VirtualMachineDscExtensionContext + +## NOTES + +## RELATED LINKS + +[Remove-AzVMDscExtension](./Remove-AzVMDscExtension.md) + +[Set-AzVMDscExtension](./Set-AzVMDscExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMDscExtensionStatus.md b/azps-10.1.0/Az.Compute/Get-AzVMDscExtensionStatus.md new file mode 100644 index 0000000000..b11f2c669c --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMDscExtensionStatus.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 695F224D-DA25-49F2-916E-25DA2A48A4A7 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmdscextensionstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMDscExtensionStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMDscExtensionStatus.md +--- + +# Get-AzVMDscExtensionStatus + +## SYNOPSIS +Gets the status of the DSC extension handler for a virtual machine. + +## SYNTAX + +### GetDscExtension (Default) +``` +Get-AzVMDscExtensionStatus [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### VMParameterSet +``` +Get-AzVMDscExtensionStatus [-VM <PSVirtualMachine>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMDscExtensionStatus** cmdlet gets the status of the Desired State Configuration (DSC) extension handler for a virtual machine in a resource group. +When a configuration is applied this cmdlet produces output consistent with the Start-DscConfiguration cmdlet. + +## EXAMPLES + +### Example 1 + +Gets the status of the DSC extension handler for a virtual machine. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Get-AzVMDscExtensionStatus -Name 'AgentPool01' -ResourceGroupName myresourcegroup -VMName 'VM01' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Azure Resource Manager resource that represents the extension. +The Set-AzVMDscExtension cmdlet sets this name to Microsoft.Powershell.DSC, which is the same value that is used by **Get-AzVMDscExtensionStatus**. +Specify this parameter only if you changed the default name in the Set cmdlet or used a different resource name in a Resource Manager template. + +```yaml +Type: System.String +Parameter Sets: GetDscExtension +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: GetDscExtension +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine object the extension is on. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: VMParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine for which this cmdlet gets the DSC extension status. + +```yaml +Type: System.String +Parameter Sets: GetDscExtension +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineInstanceView + +## NOTES + +## RELATED LINKS + +[Set-AzVMDscExtension](./Set-AzVMDscExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMExtension.md b/azps-10.1.0/Az.Compute/Get-AzVMExtension.md new file mode 100644 index 0000000000..5906ba026c --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMExtension.md @@ -0,0 +1,280 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 842652D4-0F1C-4D0D-AB55-0D43D3C5D82A +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMExtension.md +--- + +# Get-AzVMExtension + +## SYNOPSIS +Gets properties of Virtual Machine Extensions installed on a virtual machine. + +## SYNTAX + +### GetExtensionParameterSet (Default) +``` +Get-AzVMExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### VMParameterSet +``` +Get-AzVMExtension [-Status] [-VMObject <PSVirtualMachine>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzVMExtension [-Status] [-ResourceId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMExtension** cmdlet gets properties of Virtual Machine Extensions installed on a virtual machine. +Specify the name of an extension for which to get properties. +To get only the instance view of an extension, specify the Status parameter. + +## EXAMPLES + +### Example 1: Get properties of an extension +```powershell +Get-AzVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension" +``` + +```output +ResourceGroupName : ResourceGroup11 +VMName : VirtualMachine22 +Name : CustomScriptExtension +Location : eastus +Etag : null +Publisher : Microsoft.Azure.Extensions +ExtensionType : CustomScript +TypeHandlerVersion : 2.0 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11 + /providers/Microsoft.Compute/virtualMachines/VirtualMachine22/extensions/CustomScriptExtension +PublicSettings : {} +ProtectedSettings : +ProvisioningState : Succeeded +Statuses : +SubStatuses : +AutoUpgradeMinorVersion : True +ForceUpdateTag : +``` + +This command gets properties for the extension named CustomScriptExtension on the virtual machine named VirtualMachine22 in the resource group ResourceGroup11. + +### Example 2: Get instance view of an extension +```powershell +Get-AzVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Status +``` + +```output +ResourceGroupName : ResourceGroup11 +VMName : VirtualMachine22 +Name : CustomScriptExtension +Location : eastus +Etag : null +Publisher : Microsoft.Azure.Extensions +ExtensionType : CustomScript +TypeHandlerVersion : 2.0 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11 + /providers/Microsoft.Compute/virtualMachines/VirtualMachine22/extensions/CustomScriptExtension +PublicSettings : {} +ProtectedSettings : +ProvisioningState : Succeeded +Statuses : {Microsoft.Azure.Management.Compute.Models.InstanceViewStatus} +SubStatuses : +AutoUpgradeMinorVersion : True +ForceUpdateTag : +``` + +This command gets the instance view for the extension named CustomScriptExtension on the virtual machine named VirtualMachine22 in the resource group ResourceGroup11. + +### Example 3: Get all extensions installed on a VM +```powershell +Get-AzVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" +``` + +```output +ResourceGroupName : ResourceGroup11 +VMName : VirtualMachine22 +Name : CustomScriptExtension +Location : eastus +Etag : null +Publisher : Microsoft.Azure.Extensions +ExtensionType : CustomScript +TypeHandlerVersion : 2.0 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11 + /providers/Microsoft.Compute/virtualMachines/VirtualMachine22/extensions/CustomScriptExtension +PublicSettings : {} +ProtectedSettings : +ProvisioningState : Succeeded +Statuses : +SubStatuses : +AutoUpgradeMinorVersion : True +ForceUpdateTag : +``` + +### Example 4: Get properties of an extension using the VMObject parameter +```powershell +$vm = Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine22" +Get-AzVMExtension -VMObject $vm +``` + +```output +ResourceGroupName : ResourceGroup11 +VMName : VirtualMachine22 +Name : CustomScriptExtension +Location : eastus +Etag : null +Publisher : Microsoft.Azure.Extensions +ExtensionType : CustomScript +TypeHandlerVersion : 2.0 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11 + /providers/Microsoft.Compute/virtualMachines/VirtualMachine22/extensions/CustomScriptExtension +PublicSettings : {} +ProtectedSettings : +ProvisioningState : Succeeded +Statuses : +SubStatuses : +AutoUpgradeMinorVersion : True +ForceUpdateTag : +``` + +This command gets the list of extensions installed on the virtual machine named VirtualMachine22 in the resource group ResourceGroup11. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an extension. +This cmdlet gets properties for the extension that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: GetExtensionParameterSet +Aliases: ExtensionName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: GetExtensionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id specifying the virtual machine object the extension is on. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Status +Indicates that this cmdlet gets only the instance view of an extension. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine. +This cmdlet gets properties of an extension from the virtual machine that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: GetExtensionParameterSet +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMObject +Specifies the virtual machine object the extension is on. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: VMParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension + +## NOTES + +## RELATED LINKS + +[Remove-AzVMExtension](./Remove-AzVMExtension.md) + +[Set-AzVMExtension](./Set-AzVMExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMExtensionImage.md b/azps-10.1.0/Az.Compute/Get-AzVMExtensionImage.md new file mode 100644 index 0000000000..65ffe2ddc8 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMExtensionImage.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: F46041A3-355F-4449-B582-4D2F7314CA05 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmextensionimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMExtensionImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMExtensionImage.md +--- + +# Get-AzVMExtensionImage + +## SYNOPSIS +Gets all versions for an Azure extension. + +## SYNTAX + +``` +Get-AzVMExtensionImage -Location <String> -PublisherName <String> -Type <String> [-FilterExpression <String>] + [-Version <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMExtensionImage** cmdlet gets all versions for an Azure extension. + +## EXAMPLES + +### Example 1: Get the versions of an extension image +```powershell +Get-AzVMExtensionImage -Location "West US" -PublisherName "Chef.Bootstrap.WindowsAzure" -Type "ChefClient" +``` + +```output +Id : /Subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.Compute/Locations/westus/Pub + lishers/Chef.Bootstrap.WindowsAzure/ArtifactTypes/VMExtension/Types/ChefClient/Versions/11.18.6.2 +Location : westus +PublisherName : Chef.Bootstrap.WindowsAzure +Type : ChefClient +Version : 11.18.6.2 +FilterExpression : + +Id : /Subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.Compute/Locations/westus/Pub + lishers/Chef.Bootstrap.WindowsAzure/ArtifactTypes/VMExtension/Types/ChefClient/Versions/1207.12.3.0 +Location : westus +PublisherName : Chef.Bootstrap.WindowsAzure +Type : ChefClient +Version : 1207.12.3.0 +FilterExpression : + +Id : /Subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.Compute/Locations/westus/Pub + lishers/Chef.Bootstrap.WindowsAzure/ArtifactTypes/VMExtension/Types/ChefClient/Versions/1210.12.109. + 1004 +Location : westus +PublisherName : Chef.Bootstrap.WindowsAzure +Type : ChefClient +Version : 1210.12.109.1004 +FilterExpression : +``` + +This command gets all the versions of the extension image for the specified location, publisher, and type. + +### Example 2: Get the versions of an extension image with filter over version +```powershell +Get-AzVMExtensionImage -Location "West US" -PublisherName "Chef.Bootstrap.WindowsAzure" -Type "ChefClient" -Version 12* +``` + +```output +Id : /Subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.Compute/Locations/westus/Pub + lishers/Chef.Bootstrap.WindowsAzure/ArtifactTypes/VMExtension/Types/ChefClient/Versions/1207.12.3.0 +Location : westus +PublisherName : Chef.Bootstrap.WindowsAzure +Type : ChefClient +Version : 1207.12.3.0 +FilterExpression : + +Id : /Subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.Compute/Locations/westus/Pub + lishers/Chef.Bootstrap.WindowsAzure/ArtifactTypes/VMExtension/Types/ChefClient/Versions/1210.12.109. + 1004 +Location : westus +PublisherName : Chef.Bootstrap.WindowsAzure +Type : ChefClient +Version : 1210.12.109.1004 +FilterExpression : +``` + +This command gets all the versions of the extension image for the specified location, publisher, type, and version starting with 12. + +### Example 3: Get the versions of an extension image with filter over version +```powershell +Get-AzVMExtensionImage -Location "West US" -PublisherName "Chef.Bootstrap.WindowsAzure" -Type "ChefClient" -Version 1207.12.3.0 +``` + +```output +Id : /Subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.Compute/Locations/ + westus/Publishers/Chef.Bootstrap.WindowsAzure/ArtifactTypes/VMExtension/Types/ChefClient/V + ersions/1207.12.3.0 +Location : westus +PublisherName : Chef.Bootstrap.WindowsAzure +Type : ChefClient +Version : 1207.12.3.0 +FilterExpression : +Name : +HandlerSchema : +OperatingSystem : Windows +ComputeRole : IaaS +SupportsMultipleExtensions : False +VMScaleSetEnabled : False +``` + +This command gets all the versions of the extension image for the specified location, publisher, type, and version. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterExpression +Specifies a filter expression. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of an extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublisherName +Specifies the name of an extension publisher. +To obtain an extension publisher, use the Get-AzVMImagePublisher cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Specifies the type of the extension. +To obtain an extension type, use the Get-AzVMExtensionImageType cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Specifies the version of the extension that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtensionImage + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtensionImageDetails + +## NOTES + +## RELATED LINKS + +[Get-AzVMExtensionImageType](./Get-AzVMExtensionImageType.md) + +[Get-AzVMImage](./Get-AzVMImage.md) + +[Get-AzVMImagePublisher](./Get-AzVMImagePublisher.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMExtensionImageType.md b/azps-10.1.0/Az.Compute/Get-AzVMExtensionImageType.md new file mode 100644 index 0000000000..42e93f9d15 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMExtensionImageType.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 45F35BDD-969E-4521-9E8D-3499A15434A6 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmextensionimagetype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMExtensionImageType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMExtensionImageType.md +--- + +# Get-AzVMExtensionImageType + +## SYNOPSIS +Gets the type of an Azure extension. + +## SYNTAX + +``` +Get-AzVMExtensionImageType -Location <String> -PublisherName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMExtensionImageType** cmdlet gets the type of an Azure extension. + +## EXAMPLES + +### Example 1: Get an extension image type +```powershell +Get-AzVMExtensionImageType -Location "Central US" -PublisherName "Fabrikam" +``` + +This command gets the extension image type for the specified publisher and location. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of an extension. +This cmdlet gets the type for an extension at the location that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublisherName +Specifies the name of a publisher of an extension. +To obtain an extension publisher, use the Get-AzVMImagePublisher cmdlet. +This cmdlet gets the type for an extension from the publisher that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtensionImageType + +## NOTES + +## RELATED LINKS + +[Get-AzVMExtensionImage](./Get-AzVMExtensionImage.md) + +[Get-AzVMImagePublisher](./Get-AzVMImagePublisher.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMImage.md b/azps-10.1.0/Az.Compute/Get-AzVMImage.md new file mode 100644 index 0000000000..30fa7afeed --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMImage.md @@ -0,0 +1,264 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: D5254218-8B3B-4DE2-9480-D65EE5483018 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMImage.md +--- + +# Get-AzVMImage + +## SYNOPSIS +Gets all the versions of a VMImage. + +## SYNTAX + +### ListVMImage +``` +Get-AzVMImage -Location <String> [-EdgeZone <String>] -PublisherName <String> -Offer <String> -Skus <String> + [-Top <Int32>] [-OrderBy <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetVMImageDetail +``` +Get-AzVMImage -Location <String> [-EdgeZone <String>] -PublisherName <String> -Offer <String> -Skus <String> + -Version <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMImage** cmdlet gets all the versions of a VMImage. + +## EXAMPLES + +### Example 1: Get VMImage objects +```powershell +Get-AzVMImage -Location "Central US" -PublisherName "MicrosoftWindowsServer" -Offer "windowsserver" -Skus "2012-R2-Datacenter" +``` + +```output +Version Skus Offer PublisherName Location Id +------- ---- ----- ------------- -------- -- +4.127.20180315 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20180510 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20180815 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20180912 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20181010 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20181125 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20190104 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20190115 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20190204 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20190218 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +``` + +This command gets all the versions of VMImage that match the specified values. + +### Example 2: Get VMImage object +```powershell +Get-AzVMImage -Location "Central US" -PublisherName "MicrosoftWindowsServer" -Offer "windowsserver" -Skus "2012-R2-Datacenter" -Version 4.127.20180315 +``` + +```output +Id : /Subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.Compute/Locations/centralus/ + Publishers/MicrosoftWindowsServer/ArtifactTypes/VMImage/Offers/windowsserver/Skus/2012-R2-Datacenter + /Versions/4.127.20180315 +Location : centralus +PublisherName : MicrosoftWindowsServer +Offer : windowsserver +Skus : 2012-R2-Datacenter +Version : 4.127.20180315 +Name : 4.127.20180315 +OSDiskImage : { + "operatingSystem": "Windows" + } +PurchasePlan : null +DataDiskImages : [] +``` + +This command gets a specific version of VMImage that matches the specified values. + +### Example 3: Get VMImage objects +```powershell +Get-AzVMImage -Location "Central US" -PublisherName "MicrosoftWindowsServer" -Offer "windowsserver" -Skus "2012-R2-Datacenter" -Version 4.127.2018* +``` + +```output +Version Skus Offer PublisherName Location Id +------- ---- ----- ------------- -------- -- +4.127.20180315 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20180510 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20180815 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20180912 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20181010 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +4.127.20181125 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2... +``` + +This command gets all the versions of VMImage that match the specified values with filtering over version. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +Set the extended location name for EdgeZone. If not set, VM Image will be queried from Azure main region. Otherwise it will be queried from the specified extended location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the location of a VMImage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Offer +Specifies the type of VMImage offer. +To obtain an image offer, use the Get-AzVMImageOffer cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OrderBy +Specifies the order of the results returned. Formatted as an OData query. + +```yaml +Type: System.String +Parameter Sets: ListVMImage +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublisherName +Specifies the publisher of a VMImage. +To obtain an image publisher, use the Get-AzVMImagePublisher cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Skus +Specifies a VMImage SKU. +To obtain an SKU, use the Get-AzVMImageSku cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +Specifies the maximum number of virtual machine images returned. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ListVMImage +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Specifies the version of the VMImage. + +```yaml +Type: System.String +Parameter Sets: GetVMImageDetail +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImage + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImageDetail + +## NOTES + +## RELATED LINKS + +[Get-AzVMImageOffer](./Get-AzVMImageOffer.md) + +[Get-AzVMImagePublisher](./Get-AzVMImagePublisher.md) + +[Get-AzVMImageSku](./Get-AzVMImageSku.md) + +[Save-AzVMImage](./Save-AzVMImage.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMImageOffer.md b/azps-10.1.0/Az.Compute/Get-AzVMImageOffer.md new file mode 100644 index 0000000000..158507f560 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMImageOffer.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: D2CCAEB4-E43E-4075-9436-77F2C4FE9463 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmimageoffer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMImageOffer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMImageOffer.md +--- + +# Get-AzVMImageOffer + +## SYNOPSIS +Gets VMImage offer types. + +## SYNTAX + +``` +Get-AzVMImageOffer -Location <String> [-EdgeZone <String>] -PublisherName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMImageOffer** cmdlet gets the VMImage offer types. + +## EXAMPLES + +### Example 1: Get offer types for a publisher +```powershell +Get-AzVMImageOffer -Location "Central US" -PublisherName "Fabrikam" +``` + +This command gets the offer types for the specified publisher in the Central US region. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +Set the extended location name for EdgeZone. If not set, VM Image offer will be queried from Azure main region. Otherwise it will be queried from the specified extended location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the VMImage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublisherName +Specifies the name of a publisher of a VMImage. +To obtain a publisher, use the Get-AzVMImagePublisher cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImageOffer + +## NOTES + +## RELATED LINKS + +[Get-AzVMImage](./Get-AzVMImage.md) + +[Get-AzVMImagePublisher](./Get-AzVMImagePublisher.md) + +[Get-AzVMImageSku](./Get-AzVMImageSku.md) + +[Save-AzVMImage](./Save-AzVMImage.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMImagePublisher.md b/azps-10.1.0/Az.Compute/Get-AzVMImagePublisher.md new file mode 100644 index 0000000000..956b044494 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMImagePublisher.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 7311F66C-3370-4436-8030-6D98D42C3112 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmimagepublisher +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMImagePublisher.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMImagePublisher.md +--- + +# Get-AzVMImagePublisher + +## SYNOPSIS +Gets the VMImage publishers. + +## SYNTAX + +``` +Get-AzVMImagePublisher -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMImagePublisher** cmdlet gets the VMImage publishers. + +## EXAMPLES + +### Example 1: Get VMImage publishers for a region +```powershell +Get-AzVMImagePublisher -Location "Central US" +``` + +This command gets the publishers of VMImage instances for the Central US region within your Azure profile. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the VMImage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImagePublisher + +## NOTES + +## RELATED LINKS + +[Get-AzVMImage](./Get-AzVMImage.md) + +[Get-AzVMImageOffer](./Get-AzVMImageOffer.md) + +[Get-AzVMImageSku](./Get-AzVMImageSku.md) + +[Save-AzVMImage](./Save-AzVMImage.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMImageSku.md b/azps-10.1.0/Az.Compute/Get-AzVMImageSku.md new file mode 100644 index 0000000000..5c8ed09a60 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMImageSku.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: D2BBAC5B-A7B9-44DA-BE37-24D89E03BAB3 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmimagesku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMImageSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMImageSku.md +--- + +# Get-AzVMImageSku + +## SYNOPSIS +Gets VMImage SKUs. + +## SYNTAX + +``` +Get-AzVMImageSku -Location <String> [-EdgeZone <String>] -PublisherName <String> -Offer <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMImageSku** cmdlet gets VMImage SKUs. + +## EXAMPLES + +### Example 1: Get VMImage SKUs +```powershell +Get-AzVMImageSku -Location "Central US" -PublisherName "Fabrikam" -Offer "LinuxServer" +``` + +This command gets the SKUs for the specified publisher and offer. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +Set the extended location name for EdgeZone. If not set, VM Image sku will be queried from Azure main region. Otherwise it will be queried from the specified extended location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the VMImage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Offer +Specifies the type of VMImage offer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublisherName +Specifies the publisher of a VMImage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImageSku + +## NOTES + +## RELATED LINKS + +[Get-AzVMImage](./Get-AzVMImage.md) + +[Get-AzVMImageOffer](./Get-AzVMImageOffer.md) + +[Get-AzVMImagePublisher](./Get-AzVMImagePublisher.md) + +[Save-AzVMImage](./Save-AzVMImage.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMRunCommand.md b/azps-10.1.0/Az.Compute/Get-AzVMRunCommand.md new file mode 100644 index 0000000000..945df88f07 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMRunCommand.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/Get-AzVMRunCommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMRunCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMRunCommand.md +--- + +# Get-AzVMRunCommand + +## SYNOPSIS +Gets a specific Run Command or a list of Run Commands for a Virtual Machine + +## SYNTAX + +``` +Get-AzVMRunCommand -ResourceGroupName <String> -VMName <String> [-RunCommandName <String>] [-Expand <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets specific run command for a subscription in a location. + +## EXAMPLES + +### Example 1: Get a Run Command for VM. + +```powershell +Get-AzVMRunCommand -ResourceGroupName MyRG -VMName MyVM -RunCommandName MyRunCommand +``` + +Get a Run Command for VM without Instance View. + +### Example 2: Get a Run Command for VM with Instance View + +```powershell +$x = Get-AzVMRunCommand -ResourceGroupName MyRG -VMName MyVM -RunCommandName MyRunCommand -Expand InstanceView +$x.InstanceView +``` + +```output +ExecutionState : Succeeded +ExecutionMessage : +ExitCode : 0 +Output : Directory: C:\ + + + Mode LastWriteTime Length Name + ---- ------------- ------ ---- + -a---- 10/27/2022 9:10 PM 0 HelloWorld2022-10-27T21.10.54.9266231+00.00.txt + + +Error : +StartTime : 10/27/2022 9:10:52 PM +EndTime : 10/27/2022 9:10:55 PM +Statuses : +``` + +Get a Run Command for VM with Instance View. Instance View contains execution state of run command (Succeeded, Failed, etc.), exit code, standard output and standard error generated by executing the script using Run Command. A non-zero ExitCode indicates an unsuccessful execution. + +### Example 3: Get all Run Commands for a VM + +```powershell +Get-AzVMRunCommand -ResourceGroupName MyRG -VMName MyVM +``` + +Get all Run Commands for a VM + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +The expand expression to apply on the operation. Possible value(s): InstanceView + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group for the run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -RunCommandName +The name of the virtual machine run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +The name of the virtual machine containing the run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Compute.Models.PSVirtualMachineRunCommand + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzVMRunCommandDocument.md b/azps-10.1.0/Az.Compute/Get-AzVMRunCommandDocument.md new file mode 100644 index 0000000000..d93ef0df85 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMRunCommandDocument.md @@ -0,0 +1,101 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmruncommanddocument +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMRunCommandDocument.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMRunCommandDocument.md +--- + +# Get-AzVMRunCommandDocument + +## SYNOPSIS +Get a run command document. + +## SYNTAX + +``` +Get-AzVMRunCommandDocument [-Location] <String> [[-CommandId] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a run command document. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVMRunCommandDocument -Location 'westus' -CommandId 'RunPowerShellScript' +``` + +Gets a specific run command document for 'RunPowerShellScript' in 'westus'. + +### Example 2 +```powershell +Get-AzVMRunCommandDocument -Location 'westus' +``` + +Lists all available run commands in 'westus'. + +## PARAMETERS + +### -CommandId +The command ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location upon which run commands are queried. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSRunCommandDocument + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzVMSize.md b/azps-10.1.0/Az.Compute/Get-AzVMSize.md new file mode 100644 index 0000000000..ae6bc0abae --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMSize.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: B7A675D3-EF79-4EE2-9330-D4C690739006 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmsize +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMSize.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMSize.md +--- + +# Get-AzVMSize + +## SYNOPSIS +Gets available virtual machine sizes. + +## SYNTAX + +### ListVirtualMachineSizeParamSet (Default) +``` +Get-AzVMSize [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListAvailableSizesForAvailabilitySet +``` +Get-AzVMSize [-ResourceGroupName] <String> [-AvailabilitySetName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListAvailableSizesForVirtualMachine +``` +Get-AzVMSize [-ResourceGroupName] <String> [-VMName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMSize** cmdlet gets available virtual machine sizes. + +## EXAMPLES + +### Example 1: Get virtual machine sizes for a location +```powershell +Get-AzVMSize -Location "Central US" +``` + +This command gets the available sizes for virtual machines in the specified location. + +### Example 2: Get sizes for an availability set +```powershell +Get-AzVMSize -ResourceGroupName "ResourceGroup03" -AvailabilitySetName "AvailabilitySet17" +``` + +This command gets available sizes for virtual machines that you can deploy in the availability set named AvailabilitySet17. + +### Example 3: Get sizes for an existing virtual machine +```powershell +Get-AzVMSize -ResourceGroupName "ResourceGroup03" -VMName "VirtualMachine12" +``` + +This command gets available sizes for the existing virtual machine named VirtualMachine12. +You can resize this virtual machine to the sizes that this command gets. + +## PARAMETERS + +### -AvailabilitySetName +Specifies the name of the Availability Set for which this cmdlet gets the available virtual machine sizes. + +```yaml +Type: System.String +Parameter Sets: ListAvailableSizesForAvailabilitySet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location for which this cmdlet gets the available virtual machine sizes. + +```yaml +Type: System.String +Parameter Sets: ListVirtualMachineSizeParamSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: ListAvailableSizesForAvailabilitySet, ListAvailableSizesForVirtualMachine +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine that this cmdlet gets the available virtual machine sizes for resizing. + +```yaml +Type: System.String +Parameter Sets: ListAvailableSizesForVirtualMachine +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineSize + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMSqlServerExtension.md b/azps-10.1.0/Az.Compute/Get-AzVMSqlServerExtension.md new file mode 100644 index 0000000000..bd0fad9e30 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMSqlServerExtension.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: CAA3E6A9-7E1A-4D57-A269-0B2D3D9C3BEC +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmsqlserverextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMSqlServerExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMSqlServerExtension.md +--- + +# Get-AzVMSqlServerExtension + +## SYNOPSIS +Gets the settings for a SQL Server extension on a virtual machine. + +## SYNTAX + +``` +Get-AzVMSqlServerExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMSqlServerExtension** cmdlet gets the settings of the SQL Server infrastructure as a service (IaaS) Agent on a virtual machine. + +## EXAMPLES + +### Example 1: Get the settings of a SQL Server extension on a virtual machine +```powershell +Get-AzVMSqlServerExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM07" +``` + +```output +ExtensionName : SqlIaaSAgent +Publisher : Microsoft.SqlServer.Management +Version : 1.0 +State : Enable +RoleName : VMName +AutoPatchingSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoPatchingSettings +AutoBackupSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoBackupSettings +``` + +This command gets the settings of the SQL Server extension on a virtual machine named ContosoVM07. + +### Example 2: Get the settings by using the pipeline +```powershell +Get-AzVM -ResourceGroupName "testrg" -Name "ContosoVM22" | Get-AzVMSqlServerExtension +``` + +```output +ExtensionName : SqlIaaSAgent +Publisher : Microsoft.SqlServer.Management +Version : 1.0 +State : Enable +RoleName : VMName +AutoPatchingSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoPatchingSettings +AutoBackupSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoBackupSettings +``` + +This command gets the virtual machine named ContosoVM22 in the Resource Group testrg by using the Get-AzVM cmdlet. +The command passes the results to the current cmdlet by using the pipeline operator. +The current command gets the settings of the SQL Server IaaS Agent on that virtual machine. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the SQL Server the extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.VirtualMachineSqlServerExtensionContext + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[Remove-AzVMSqlServerExtension](./Remove-AzVMSqlServerExtension.md) + +[Set-AzVMSqlServerExtension](./Set-AzVMSqlServerExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVMUsage.md b/azps-10.1.0/Az.Compute/Get-AzVMUsage.md new file mode 100644 index 0000000000..2c60c90d53 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVMUsage.md @@ -0,0 +1,83 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 3702701E-428D-47E2-A227-0F38B055F881 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVMUsage.md +--- + +# Get-AzVMUsage + +## SYNOPSIS +Gets the virtual machine core count usage for a location. + +## SYNTAX + +``` +Get-AzVMUsage [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVMUsage** cmdlet gets the virtual machine core count usage for a location. + +## EXAMPLES + +### Example 1: Get core count usage for a location +```powershell +Get-AzVMUsage -Location "Central US" +``` + +This command gets the virtual machine core count usage for the location Central US. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location for which this cmdlet gets virtual machine core count usage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSUsage + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVmss.md b/azps-10.1.0/Az.Compute/Get-AzVmss.md new file mode 100644 index 0000000000..522dbe1792 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVmss.md @@ -0,0 +1,408 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: FC6BC096-DBC4-48DA-A366-B87EB18A0496 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmss +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmss.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmss.md +--- + +# Get-AzVmss + +## SYNOPSIS +Gets the properties of a VMSS. + +## SYNTAX + +### DefaultParameter (Default) +``` +Get-AzVmss [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### FriendMethod +``` +Get-AzVmss [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [-InstanceView] [-UserData] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### OSUpgradeHistoryMethodParameter +``` +Get-AzVmss [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [-OSUpgradeHistory] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzVmss [-ResourceId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVmss** cmdlet gets the model and instance view of a Virtual Machine Scale Set (VMSS). +The model view is the user specified properties of the virtual machine scale set. +The instance view is the instance level status of the virtual machine scale set. +Specify the *InstanceView* parameter to get only the instance view of a virtual machine scale set. + +## EXAMPLES + +### Example 1: Get the properties of a VMSS +```powershell +Get-AzVmss -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" +``` + +```output +ResourceGroupName : Group001 +Sku : + Name : Standard_DS1_v2 + Tier : Standard + Capacity : 2 +UpgradePolicy : + Mode : Manual +VirtualMachineProfile : + OsProfile : + ComputerNamePrefix : test + AdminUsername : contoso + WindowsConfiguration : + ProvisionVMAgent : True + EnableAutomaticUpdates : True + StorageProfile : + ImageReference : + Publisher : MicrosoftWindowsServer + Offer : WindowsServer + Sku : 2016-Datacenter + Version : latest + OsDisk : + Caching : None + CreateOption : FromImage + ManagedDisk : + StorageAccountType : Premium_LRS + NetworkProfile : + NetworkInterfaceConfigurations[0] : + Name : Group001 + Primary : True + EnableAcceleratedNetworking : False + NetworkSecurityGroup : + Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/Group001 +/providers/Microsoft.Network/networkSecurityGroups/Group001 + DnsSettings : + IpConfigurations[0] : + Name : Group001 + Subnet : + Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/group001 +/providers/Microsoft.Network/virtualNetworks/Group001/subnets/Group001 + PrivateIPAddressVersion : IPv4 + LoadBalancerBackendAddressPools[0] : + Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/group001 +/providers/Microsoft.Network/loadBalancers/Group001/backendAddressPools/Group001 + LoadBalancerInboundNatPools[0] : + Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/group001 +/providers/Microsoft.Network/loadBalancers/Group001/inboundNatPools/Group001 + LoadBalancerInboundNatPools[1] : + Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/group001 +/providers/Microsoft.Network/loadBalancers/Group001/inboundNatPools/Group001 + EnableIPForwarding : False +ProvisioningState : Succeeded +Overprovision : True +UniqueId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SinglePlacementGroup : False +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/Group001/ +providers/Microsoft.Compute/virtualMachineScaleSets/VMSS001 +Name : VMSS001 +Type : Microsoft.Compute/virtualMachineScaleSets +Location : eastus +Tags : {} +``` + +This command gets the properties of the VMSS named VMSS001 that belongs to the resource group named Group001. +Since the command does not specify the *InstanceView* switch parameter, the cmdlet gets the model view of the virtual machine scale set. + +### Example 2: Get all Vmss in a resource group +```powershell +Get-AzVmss -ResourceGroupName "Group001" +``` + +```output +ResourceGroupName Name Location Sku Capacity ProvisioningState +----------------- ---- -------- --- -------- ----------------- +Group001 VMSS001 eastus Standard_DS1_v2 2 Succeeded +Group001 VMSS002 eastus Standard_A1 2 Succeeded +``` + +Get all Vmss in resource group "Group001" + +### Example 3: Get all Vmss in a subscription +```powershell +Get-AzVmss +``` + +```output +ResourceGroupName Name Location Sku Capacity ProvisioningState +----------------- ---- -------- --- -------- ----------------- +Group001 VMSS001 eastus Standard_DS1_v2 2 Succeeded +Group001 VMSS002 eastus Standard_A1 2 Succeeded +Group002 VMSS003 eastus Standard_A1 1 Succeeded +Group002 VMSS004 eastus Standard_DS1_v2 2 Succeeded +``` + +Get all Vmss in subscription. + +### Example 4: Get all Vmss using filtering +```powershell +Get-AzVmss -Name VMSS00* +``` + +```output +ResourceGroupName Name Location Sku Capacity ProvisioningState +----------------- ---- -------- --- -------- ----------------- +Group001 VMSS001 eastus Standard_DS1_v2 2 Succeeded +Group001 VMSS002 eastus Standard_A1 2 Succeeded +Group002 VMSS003 eastus Standard_A1 1 Succeeded +Group002 VMSS004 eastus Standard_DS1_v2 2 Succeeded +``` + +Get all Vmss in subscription that start with "VMSS00". + +### Example 5: Get the Vmss with a UserData value +```powershell +Get-AzVmss -ResourceGroupName <RESOURCE GROUP NAME> -VMScaleSetName <VMSS NAME> -InstanceView:$false -UserData; +``` + +```output +ResourceGroupName : <RESOURCE GROUP NAME> +Sku : + Name : Standard_DS1_v2 + Tier : Standard + Capacity : 2 +UpgradePolicy : + Mode : Manual +ProvisioningState : Succeeded +Overprovision : True +DoNotRunExtensionsOnOverprovisionedVMs : False +UniqueId : <UNIQUE ID> +SinglePlacementGroup : False +Id : /subscriptions/<SUBSCRIPTION ID>/resourceGroups/<RESOURCE GROUP NAME>/providers/Microsoft.Compute/virtualMachineScaleSets/<VMSS NAME> +Name : usdvmss +Type : Microsoft.Compute/virtualMachineScaleSets +Location : eastus +Tags : +{"azsecpack":"nonprod","platformsettings.host_environment.service.platform_optedin_for_rootcerts":"true"} +VirtualMachineProfile : + OsProfile : + ComputerNamePrefix : <PREFIX> + AdminUsername : <USERNAME> + WindowsConfiguration : + ProvisionVMAgent : True + EnableAutomaticUpdates : True + StorageProfile : + ImageReference : + Publisher : MicrosoftWindowsServer + Offer : WindowsServer + Sku : 2016-Datacenter + Version : latest + OsDisk : + Caching : None + CreateOption : FromImage + DiskSizeGB : 127 + OsType : Windows + ManagedDisk : + StorageAccountType : Premium_LRS + NetworkProfile : + NetworkInterfaceConfigurations[0] : + Name : <VMSS NAME> + Primary : True + EnableAcceleratedNetworking : False + DnsSettings : + IpConfigurations[0] : + Name : <VMSS NAME> + Subnet : + Id : /subscriptions/<SUBSCRIPTION ID>/resourceGroups/<RESOURCE GROUP NAME>/providers/Microsoft.Network/virtualNetworks/<VMSS NAME>/subnets/<VMSS NAME> + PrivateIPAddressVersion : IPv4 + LoadBalancerBackendAddressPools[0] : + Id : /subscriptions/<SUBSCRIPTION ID>/resourceGroups/<RESOURCE GROUP NAME>/providers/Microsoft.Network/loadBalancers/<VMSS NAME>/backendAddressPools/<VMSS NAME> + LoadBalancerInboundNatPools[0] : + Id : /subscriptions/<SUBSCRIPTION ID>/resourceGroups/<RESOURCE GROUP NAME>/providers/Microsoft.Network/loadBalancers/<VMSS NAME>/inboundNatPools/<VMSS NAME> + LoadBalancerInboundNatPools[1] : + Id : /subscriptions/<SUBSCRIPTION ID>/resourceGroups/<RESOURCE GROUP NAME>/providers/Microsoft.Network/loadBalancers/<VMSS NAME>/inboundNatPools/<VMSS NAME> + EnableIPForwarding : False + ExtensionProfile : + Extensions[0] : + Name : Microsoft.Azure.Security.AntimalwareSignature.AntimalwareConfiguration + Publisher : Microsoft.Azure.Security.AntimalwareSignature + Type : AntimalwareConfiguration + TypeHandlerVersion : 2.0 + AutoUpgradeMinorVersion : True + EnableAutomaticUpgrade : True + Settings : {} + Extensions[1] : + Name : Microsoft.Azure.Geneva.GenevaMonitoring + Publisher : Microsoft.Azure.Geneva + Type : GenevaMonitoring + TypeHandlerVersion : 2.0 + AutoUpgradeMinorVersion : True + EnableAutomaticUpgrade : True + Settings : {} + UserData : dQBwAGQAYQB0AGUAIAB2AG0AcwBzAA== +``` + +The UserData value must be Base64 encoded. This command assumes you have created a Vmss with a UserData value. + +### Example 6: Get a Virtual Machine Scale Set via its ResourceId. +```powershell +$rgname = "ResourceGroupName"; +$loc = "eastus"; +New-AzResourceGroup -Name $rgname -Location $loc; + +$vmssSize = 'Standard_D4s_v3'; +$vmssName1 = 'vmss1' + $rgname; +$imageName = "Win2019Datacenter"; +$adminUsername = <Username>; +$adminPassword = <Password> | ConvertTo-SecureString -AsPlainText -Force; +$cred = New-Object System.Management.Automation.PSCredential($adminUsername, $adminPassword); + +$result = New-AzVmss -ResourceGroupName $rgname -Credential $cred -VMScaleSetName $vmssName1 -ImageName $imageName; + +$vmss = Get-AzVmss -ResourceGroupName $rgname -VMScaleSetName $vmssName1; +$vmssId = $vmss.Id; +$vmssGet = Get-AzVmss -ResourceId $vmssId; +``` + +Make a Vmss then get that same Vmss via its ARM resource Id. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceView +Indicates that this cmdlet gets only the instance view of the virtual machine scale set. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FriendMethod +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSUpgradeHistory +Indicates that this cmdlet lists the os upgrade history of the virtual machine scale set. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: OSUpgradeHistoryMethodParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the Resource Group of the VMSS. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter, FriendMethod, OSUpgradeHistoryMethodParameter +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +The ARM resource id specifying the specific virtual machine scale set object you want returned. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserData +UserData for the Vmss, which will be base-64 encoded. Customer should not pass any secrets in here. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FriendMethod +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +Species the name of the VMSS. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter, FriendMethod, OSUpgradeHistoryMethodParameter +Aliases: Name + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[New-AzVmss](./New-AzVmss.md) + +[Remove-AzVmss](./Remove-AzVmss.md) + +[Restart-AzVmss](./Restart-AzVmss.md) + +[Set-AzVmss](./Set-AzVmss.md) + +[Start-AzVmss](./Start-AzVmss.md) + +[Stop-AzVmss](./Stop-AzVmss.md) + +[Update-AzVmss](./Update-AzVmss.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVmssDiskEncryption.md b/azps-10.1.0/Az.Compute/Get-AzVmssDiskEncryption.md new file mode 100644 index 0000000000..ef0885c3bb --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVmssDiskEncryption.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmssdiskencryption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmssDiskEncryption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmssDiskEncryption.md +--- + +# Get-AzVmssDiskEncryption + +## SYNOPSIS +Shows the disk encryption status of a VM scale set. + +## SYNTAX + +``` +Get-AzVmssDiskEncryption [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] + [[-ExtensionName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Shows the disk encryption status of a VM scale set. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVmssDiskEncryption -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" +``` + +Shows the disk encryption status of the VM scale set named VMSS001 that belongs to the resource group named Group001. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionName +The extension name. +If this parameter is not specified, default values used are AzureDiskEncryption for windows VMs and AzureDiskEncryptionForLinux for Linux VMs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name of the virtual machine scale set + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +The virtual machine scale set name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVmssDiskEncryptionStatusContext + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzVmssRollingUpgrade.md b/azps-10.1.0/Az.Compute/Get-AzVmssRollingUpgrade.md new file mode 100644 index 0000000000..496079fdc7 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVmssRollingUpgrade.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmssrollingupgrade +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmssRollingUpgrade.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmssRollingUpgrade.md +--- + +# Get-AzVmssRollingUpgrade + +## SYNOPSIS +Shows the status of the latest virtual machine scale set rolling upgrade. + +## SYNTAX + +``` +Get-AzVmssRollingUpgrade [-ResourceGroupName] <String> [-VMScaleSetName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Shows the status of the latest virtual machine scale set rolling upgrade. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVmssRollingUpgrade -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" +``` + +This command shows the status of the latest rolling upgrade of the VMSS named VMSS001 that belongs to the resource group named Group001. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +The name of the VM scale set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSRollingUpgradeStatusInfo + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzVmssSku.md b/azps-10.1.0/Az.Compute/Get-AzVmssSku.md new file mode 100644 index 0000000000..7e9f8e723a --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVmssSku.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: BB6AFC7D-7E74-4D39-B336-A011B98D0682 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmsssku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmssSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmssSku.md +--- + +# Get-AzVmssSku + +## SYNOPSIS +Gets the available SKUs for the VMSS. + +## SYNTAX + +``` +Get-AzVmssSku [-ResourceGroupName] <String> [-VMScaleSetName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVmssSku** cmdlet gets the available SKUs for the Virtual Machine Scale Set (VMSS). + +## EXAMPLES + +### Example 1: Get all available SKUs from the VMSS +```powershell +Get-AzVmssSku -ResourceGroupName "ContosoGroup" -VMScaleSetName "ContosoVMSS" +``` + +This command gets all the available SKUs from the VMSS named ContosoVMSS that belongs to the resource group named ContosoGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the VMSS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +Species the name of the VMSS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetSku + +## NOTES + +## RELATED LINKS + +[Get-AzVmss](./Get-AzVmss.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVmssVM.md b/azps-10.1.0/Az.Compute/Get-AzVmssVM.md new file mode 100644 index 0000000000..430246797f --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVmssVM.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 63D48BA4-EE80-4740-90B9-0EE05B3F6536 +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmssvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmssVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmssVM.md +--- + +# Get-AzVmssVM + +## SYNOPSIS +Gets the properties of a VMSS virtual machine. + +## SYNTAX + +### DefaultParameter (Default) +``` +Get-AzVmssVM [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [[-InstanceId] <String>] [-UserData] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### FriendMethod +``` +Get-AzVmssVM [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [[-InstanceId] <String>] + [-InstanceView] [-UserData] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVmssVM** cmdlet gets the model view and instance view of a Virtual Machine Scale Set (VMSS) virtual machine. +The model view is the user specified properties of the virtual machine. +The instance view is the instance level status of the virtual machine. +Specify the *Status* parameter to get only the instance view of a virtual machine. + +## EXAMPLES + +### Example 1: Get the properties of a VMSS virtual machine +```powershell +Get-AzVmssVM -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" +``` + +This command gets the properties of the VMSS virtual machine named VMSS001 that belongs to the resource group named Group001. +Since the command does not specify the *InstanceView* switch parameter, the cmdlet gets the model view of the virtual machine. + +### Example 2: Get the model view properties of a VMSS virtual machine +```powershell +Get-AzVmssVM -ResourceGroupName "Group002" -VMScaleSetName "VMSS004" -InstanceId $ID +``` + +This command gets the properties of the VMSS virtual machine named VMSS004 that belongs to the resource group named Group002. +The command gets the instance ID stored in the variable $ID for which to get the model view. + +### Example 3: Get the instance view properties of a VMSS virtual machine +```powershell +Get-AzVmssVM -InstanceView -ResourceGroupName $rgname -VMScaleSetName $vmssName -InstanceId $ID +``` + +This command gets the properties of the VMSS virtual machine named VMSS004 that belongs to the resource group named Group002. +Since the command specifies the *InstanceView* switch parameter, the cmdlet gets the instance view of the virtual machine. +The command gets the instance ID stored in the variable $ID for which to get the instance view. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceId +Specifies the instance ID for which to get the model view. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstanceView +Indicates that this cmdlet gets only the instance view of the virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FriendMethod +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the Resource Group of the VMSS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserData +UserData for the Vmss, which will be base-64 encoded. Customer should not pass any secrets in here. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +Species the name of the VMSS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM + +## NOTES + +## RELATED LINKS + +[Set-AzVmssVM](./Set-AzVmssVM.md) + +[Get-AzVmss](./Get-AzVmss.md) + + diff --git a/azps-10.1.0/Az.Compute/Get-AzVmssVMDiskEncryption.md b/azps-10.1.0/Az.Compute/Get-AzVmssVMDiskEncryption.md new file mode 100644 index 0000000000..816f6ab889 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVmssVMDiskEncryption.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmssvmdiskencryption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmssVMDiskEncryption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmssVMDiskEncryption.md +--- + +# Get-AzVmssVMDiskEncryption + +## SYNOPSIS +Shows the disk encryption status of VMs in a VM scale set. + +## SYNTAX + +``` +Get-AzVmssVMDiskEncryption [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String>] + [-ExtensionName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Shows the disk encryption status of VM scale set. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVmssVMDiskEncryption -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -InstanceId "1" +``` + +Shows the disk encryption status of VM instance 1 in the VM scale set named VMSS001 that belongs to the resource group named Group001. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionName +The extension name. +If this parameter is not specified, default values used are AzureDiskEncryption for windows VMs and AzureDiskEncryptionForLinux for Linux VMs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstanceId +Specifies the instance ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name of the virtual machine scale set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +The virtual machine scale set name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVmssVMDiskEncryptionStatusContext + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Get-AzVmssVMRunCommand.md b/azps-10.1.0/Az.Compute/Get-AzVmssVMRunCommand.md new file mode 100644 index 0000000000..e274f9b6da --- /dev/null +++ b/azps-10.1.0/Az.Compute/Get-AzVmssVMRunCommand.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/get-azvmssvmruncommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmssVMRunCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Get-AzVmssVMRunCommand.md +--- + +# Get-AzVmssVMRunCommand + +## SYNOPSIS +The operation to get the VMSS VM run command. + +## SYNTAX + +``` +Get-AzVmssVMRunCommand -ResourceGroupName <String> -VMScaleSetName <String> -InstanceId <String> + [-RunCommandName <String>] [-Expand <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to get the VMSS VM run command. + +## EXAMPLES + +### Example 1: Get a Run Command for VMSS VM instance + +```powershell +Get-AzVmssVMRunCommand -ResourceGroupName MyRG0 -VMScaleSetName MyVMSS -InstanceId 0 -RunCommandName MyRunCommand +``` + +Get a Run Command for VM without Instance View. + +### Example 2: Get a Run Command for VMSS VM instance with Instance View + +```powershell +$x = Get-AzVmssVMRunCommand -ResourceGroupName MyRG0 -VMScaleSetName MyVMSS -InstanceId 0 -RunCommandName MyRunCommand -Expand InstanceView +$x.InstanceView +``` + +```output +ExecutionState : Succeeded +ExecutionMessage : +ExitCode : 0 +Output : Directory: C:\ + + + Mode LastWriteTime Length Name + ---- ------------- ------ ---- + -a---- 10/27/2022 9:10 PM 0 HelloWorld2022-10-27T21.10.54.9266231+00.00.txt + + +Error : +StartTime : 10/27/2022 9:10:52 PM +EndTime : 10/27/2022 9:10:55 PM +Statuses : +``` + +Get a Run Command for VM with Instance View. Instance View contains execution state of run command (Succeeded, Failed, etc.), exit code, standard output and standard error generated by executing the script using Run Command. A non-zero ExitCode indicates an unsuccessful execution. + +### Example 3: Get all Run Commands for a VMSS VM instance + +```powershell +Get-AzVmssVMRunCommand -ResourceGroupName MyRG -VMScaleSetName MyVMSS -InstanceId 1 +``` + +Get list of all Run Commands for a VM. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +The expand expression to apply on the operation. For instance view, pass in "InstanceView". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstanceId +Instance ID of the virtual machine for from the VM scale set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group for the run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -RunCommandName +Name of the run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +Name of the virtual machine scale set of the run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Compute.Models.PSVirtualMachineRunCommand + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Grant-AzDiskAccess.md b/azps-10.1.0/Az.Compute/Grant-AzDiskAccess.md new file mode 100644 index 0000000000..c05e5e191b --- /dev/null +++ b/azps-10.1.0/Az.Compute/Grant-AzDiskAccess.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/grant-azdiskaccess +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Grant-AzDiskAccess.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Grant-AzDiskAccess.md +--- + +# Grant-AzDiskAccess + +## SYNOPSIS +Grants an access to a disk. + +## SYNTAX + +``` +Grant-AzDiskAccess [-ResourceGroupName] <String> [-DiskName] <String> [-Access] <String> + [[-DurationInSecond] <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Grant-AzDiskAccess** cmdlet grants an access to a disk. + +## EXAMPLES + +### Example 1 +```powershell +Grant-AzDiskAccess -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Access 'Read' -DurationInSecond 60; +``` + +Grant 'Read' access to the disk named 'Disk01' in the resource group named 'ResourceGroup01' for 60 seconds. + +## PARAMETERS + +### -Access +Specifies Access level. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskName +Specifies the name of a disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DurationInSecond +Specifies access duration in seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSAccessUri + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Grant-AzSnapshotAccess.md b/azps-10.1.0/Az.Compute/Grant-AzSnapshotAccess.md new file mode 100644 index 0000000000..bf74adb9dd --- /dev/null +++ b/azps-10.1.0/Az.Compute/Grant-AzSnapshotAccess.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/grant-azsnapshotaccess +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Grant-AzSnapshotAccess.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Grant-AzSnapshotAccess.md +--- + +# Grant-AzSnapshotAccess + +## SYNOPSIS +Grants an access to a snapshot. + +## SYNTAX + +``` +Grant-AzSnapshotAccess [-ResourceGroupName] <String> [-SnapshotName] <String> [-Access] <String> + [[-DurationInSecond] <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Grant-AzSnapshotAccess** cmdlet grants an access to a snapshot. + +## EXAMPLES + +### Example 1 +```powershell +Grant-AzSnapshotAccess -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Access 'Read' -DurationInSecond 60; +``` + +Grant 'Read' access to the snapshot named 'Snapshot01' in the resource group named 'ResourceGroup01' for 60 seconds. + +## PARAMETERS + +### -Access +Specifies Access level. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DurationInSecond +Specifies access duration in seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SnapshotName +Specifies the name of a snapshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSAccessUri + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Invoke-AzVMInstallPatch.md b/azps-10.1.0/Az.Compute/Invoke-AzVMInstallPatch.md new file mode 100644 index 0000000000..01c91d2b18 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Invoke-AzVMInstallPatch.md @@ -0,0 +1,406 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/invoke-azvminstallpatch +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Invoke-AzVMInstallPatch.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Invoke-AzVMInstallPatch.md +--- + +# Invoke-AzVMInstallPatch + +## SYNOPSIS +Installs patches on the VM + +## SYNTAX + +### WindowsDefaultParameterSet (Default) +``` +Invoke-AzVMInstallPatch -ResourceGroupName <String> -VMName <String> [-Windows] -RebootSetting <String> + -MaximumDuration <String> [-KBNumberToInclude <String[]>] [-KBNumberToExclude <String[]>] + [-ExcludeKBsRequiringReboot] [-ClassificationToIncludeForWindows <String[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### LinuxDefaultParameterSet +``` +Invoke-AzVMInstallPatch -ResourceGroupName <String> -VMName <String> [-Linux] -RebootSetting <String> + -MaximumDuration <String> [-PackageNameMaskToInclude <String[]>] [-PackageNameMaskToExclude <String[]>] + [-ClassificationToIncludeForLinux <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### WindowsResourceIDParameterSet +``` +Invoke-AzVMInstallPatch -ResourceId <String> [-Windows] -RebootSetting <String> -MaximumDuration <String> + [-KBNumberToInclude <String[]>] [-KBNumberToExclude <String[]>] [-ExcludeKBsRequiringReboot] + [-ClassificationToIncludeForWindows <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### LinuxResourceIDParameterSet +``` +Invoke-AzVMInstallPatch -ResourceId <String> [-Linux] -RebootSetting <String> -MaximumDuration <String> + [-PackageNameMaskToInclude <String[]>] [-PackageNameMaskToExclude <String[]>] + [-ClassificationToIncludeForLinux <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### WindowsInputObjectParameterSet +``` +Invoke-AzVMInstallPatch [-VM] <PSVirtualMachine> [-Windows] -RebootSetting <String> -MaximumDuration <String> + [-KBNumberToInclude <String[]>] [-KBNumberToExclude <String[]>] [-ExcludeKBsRequiringReboot] + [-ClassificationToIncludeForWindows <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### LinuxInputObjectParameterSet +``` +Invoke-AzVMInstallPatch [-VM] <PSVirtualMachine> [-Linux] -RebootSetting <String> -MaximumDuration <String> + [-PackageNameMaskToInclude <String[]>] [-PackageNameMaskToExclude <String[]>] + [-ClassificationToIncludeForLinux <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Installs patches on the VM + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzVmInstallPatch -ResourceGroupName 'MyRG' -VmName 'MyVM' -Windows -RebootSetting 'never' -MaximumDuration PT2H -ClassificationToIncludeForWindows Critical +``` + +This example installs critical patches on the VM. + +### Example 2 +```powershell +$myVM = Get-AzVM -ResourceGroupName 'MyRG' -Name 'MyVM' +Invoke-AzVmInstallPatch -VM $myVM -MaximumDuration "PT90M" -RebootSetting "Always" -Windows -ClassificationToIncludeForWindows "Security" -KBNumberToInclude "KB1234567", "KB123567" -KBNumberToExclude "KB1234702", "KB1234802" -ExcludeKBsRequiringReboot +``` + +This example passes a PSVirtualMachine object to '-VM' parameter. It also installs security patches while including and excluding certain KBs by using '-KBNumberToExclude' and '-KBNumberToInclude'. It also excludes KBs that require reboot by using '-ExcludeKBsRequiringReboot'. + +### Example 3 +```powershell +$myLinuxVM = Get-AzVM -ResourceGroupName 'MyRG' -Name 'MyLinuxVM' +Invoke-AzVMInstallPatch -ResourceId $myLinuxVM.id -MaximumDuration "PT90M" -RebootSetting "Always" -Linux -ClassificationToIncludeForLinux "Security" -PackageNameMaskToInclude "package123" -PackageNameMaskToExclude "package567" +``` + +This example installs certain packages to the Linux VM provided by Resource ID. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationToIncludeForLinux +The update classifications to select when installing patches. +Possible values differ for Windows and Linux. + +```yaml +Type: System.String[] +Parameter Sets: LinuxDefaultParameterSet, LinuxResourceIDParameterSet, LinuxInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationToIncludeForWindows +The update classifications to select when installing patches. +Possible values differ for Windows and Linux. + +```yaml +Type: System.String[] +Parameter Sets: WindowsDefaultParameterSet, WindowsResourceIDParameterSet, WindowsInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeKBsRequiringReboot +Filters out KBs that don't have a reboot behavior of 'NeverReboots' when this is set. +This parameter is only available for Windows VM. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WindowsDefaultParameterSet, WindowsResourceIDParameterSet, WindowsInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KBNumberToExclude +KBs to exclude in the patch operation. +This parameter is only available for Windows VM. + +```yaml +Type: System.String[] +Parameter Sets: WindowsDefaultParameterSet, WindowsResourceIDParameterSet, WindowsInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KBNumberToInclude +KBs to include in the patch operation. +This parameter is only available for Windows VM. + +```yaml +Type: System.String[] +Parameter Sets: WindowsDefaultParameterSet, WindowsResourceIDParameterSet, WindowsInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Linux +For Linux VM + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: LinuxDefaultParameterSet, LinuxResourceIDParameterSet, LinuxInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumDuration +Specifies the maximum amount of time that the operation will run. +It must be an ISO 8601-compliant duration string such as PT2H (2 hours). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageNameMaskToExclude +Packages to exclude in the patch operation. +Format: packageName_packageVersion. +This parameter is only available for Linux VM. + +```yaml +Type: System.String[] +Parameter Sets: LinuxDefaultParameterSet, LinuxResourceIDParameterSet, LinuxInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageNameMaskToInclude +Packages to include in the patch operation. +Format: packageName_packageVersion. +This parameter is only available for Linux VM. + +```yaml +Type: System.String[] +Parameter Sets: LinuxDefaultParameterSet, LinuxResourceIDParameterSet, LinuxInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RebootSetting +Defines when it is acceptable to reboot a VM during a software update operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: WindowsDefaultParameterSet, LinuxDefaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID for your virtual machine. + +```yaml +Type: System.String +Parameter Sets: WindowsResourceIDParameterSet, LinuxResourceIDParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -VM +PowerShell Virtual Machine Object + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: WindowsInputObjectParameterSet, LinuxInputObjectParameterSet +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -VMName +Virtual Machine name + +```yaml +Type: System.String +Parameter Sets: WindowsDefaultParameterSet, LinuxDefaultParameterSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Windows +For Windows VM + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WindowsDefaultParameterSet, WindowsResourceIDParameterSet, WindowsInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineInstallPatchesResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Invoke-AzVMPatchAssessment.md b/azps-10.1.0/Az.Compute/Invoke-AzVMPatchAssessment.md new file mode 100644 index 0000000000..9dad3520a7 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Invoke-AzVMPatchAssessment.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Invoke-AzVMPatchAssessment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Invoke-AzVMPatchAssessment.md +--- + +# Invoke-AzVMPatchAssessment + +## SYNOPSIS +Assess patch state of a virtual machine. + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Invoke-AzVMPatchAssessment [-ResourceGroupName] <String> [-VMName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIDParameterSet +``` +Invoke-AzVMPatchAssessment [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Invoke-AzVMPatchAssessment [-VM] <PSVirtualMachine> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Assesses the patch status of a VM and reports all detected patches that are available for installation. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzVMPatchAssessment -ResourceGroupName "myRG" -VMName "myVM" +``` + +This command invokes patch assessment on virtual machine "mvVM" under resource group "myRG" + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID for your virtual machine. + +```yaml +Type: System.String +Parameter Sets: ResourceIDParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +PowerShell Virtual Machine Object + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: InputObjectParameterSet +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -VMName +Virtual Machine name + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachinePatchAssessmentResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Invoke-AzVMReimage.md b/azps-10.1.0/Az.Compute/Invoke-AzVMReimage.md new file mode 100644 index 0000000000..be7d1a1956 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Invoke-AzVMReimage.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/invoke-azvmreimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Invoke-AzVMReimage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Invoke-AzVMReimage.md +--- + +# Invoke-AzVMReimage + +## SYNOPSIS +Reimage an Azure virtual machine. + +## SYNTAX + +``` +Invoke-AzVMReimage [-ResourceGroupName] <String> [-VMName] <String> [-TempDisk] [-AsJob] + [-ExactVersion <String>] [-CustomData <String>] [-AdminPassword <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzVMReimage** cmdlet reimages an Azure virtual machine. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzVMReimage -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" +``` + +This command reimages the virtual machine named VirtualMachine07 in ResourceGroup11. + +### Example 2 +```powershell +$SecurePassword = ConvertTo-SecureString "password" -AsPlainText +Invoke-AzVMReimage -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -TempDisk -CustomData $CustomData -AdminPassword $SecurePassword -ExactVersion "10.0.14393.0" +``` + +Passing in -AdminPassword using SecureString along with other parameters to reimage the virtual machine. + +## PARAMETERS + +### -AdminPassword +Specifies the password of the administrator account. +<br><br> **Minimum-length (Windows):** 8 characters +<br><br> **Minimum-length (Linux):** 6 characters +<br><br> **Max-length (Windows):** 123 characters +<br><br> **Max-length (Linux):** 72 characters +<br><br> **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled +<br> Has lower characters +<br>Has upper characters +<br> Has a digit +<br> Has a special character (Regex match [\\W_]) +<br><br> **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\" +<br><br> For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp) +<br><br> For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomData +Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. +<br><br> **Note: Do not pass any secrets or passwords in customData property** +<br><br> This property cannot be updated after the VM is created. +<br><br> customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/) +<br><br> For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExactVersion +Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TempDisk +Specifies whether to reimage temp disk. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName +The virtual machine name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Invoke-AzVMRunCommand.md b/azps-10.1.0/Az.Compute/Invoke-AzVMRunCommand.md new file mode 100644 index 0000000000..b28a04f716 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Invoke-AzVMRunCommand.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/invoke-azvmruncommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Invoke-AzVMRunCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Invoke-AzVMRunCommand.md +--- + +# Invoke-AzVMRunCommand + +## SYNOPSIS +Run a command on the VM. + +## SYNTAX + +### DefaultParameter (Default) +``` +Invoke-AzVMRunCommand [-ResourceGroupName] <String> [-VMName] <String> -CommandId <String> + [-ScriptPath <String>] [-ScriptString <String>] [-Parameter <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Invoke-AzVMRunCommand -CommandId <String> [-ScriptPath <String>] [-ScriptString <String>] + [-Parameter <Hashtable>] [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### VMParameter +``` +Invoke-AzVMRunCommand -CommandId <String> [-ScriptPath <String>] [-ScriptString <String>] + [-Parameter <Hashtable>] [-VM] <PSVirtualMachine> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Invoke a run command on the VM. + +## EXAMPLES + +### Example 1: Invoke a command on Windows +```powershell +Invoke-AzVMRunCommand -ResourceGroupName 'rgname' -VMName 'vmname' -CommandId 'RunPowerShellScript' -ScriptPath 'sample.ps1' -Parameter @{param1 = "var1"; param2 = "var2"} +``` + +Invoke a run command 'RunPowerShellScript' with overriding the script 'sample.ps1' on a Windows VM named 'vmname' in resource group 'rgname'. Var1 and var2 are defined as parameters in the sample.ps1. Parameter value can be string type only and script is responsible for converting them to other types if needed. + +### Example 2: Invoke a command on Linux +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +export param1=var1 param2=var2 +set -- var1 var2 var3 + +Invoke-AzVMRunCommand -ResourceGroupName 'rgname' -Name 'vmname' -CommandId 'RunShellScript' -ScriptPath 'sample.bash' -Parameter @{"param1" = "var1";"param2" = "var2"} +echo This is a sample bash script +echo Usage 1: Ordered parameters: $0 $1 +echo Usage 2: Named exports: $var1 $var2 +``` + +This command invokes a run command 'RunShellScript' with overriding the script 'sample.bash' on a Linux VM named 'vmname'. Var1 and var2 are defined as parameters in the sample.bash. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a job object to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandId +The run command ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +The run command parameters. Specify parameters as key/value pairs to be passed at script execution. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource ID for the VM. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScriptPath +Path of the script to be executed. When this value is given, the given script will override the default script of the command. +Path should point to a file from a local file system. The command will load it and send it for execution. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptString +The script to be executed as a string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +The PS virtual machine object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: VMParameter +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -VMName +The name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSRunCommandResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Invoke-AzVmssVMRunCommand.md b/azps-10.1.0/Az.Compute/Invoke-AzVmssVMRunCommand.md new file mode 100644 index 0000000000..0167a956a6 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Invoke-AzVmssVMRunCommand.md @@ -0,0 +1,271 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/invoke-azvmssvmruncommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Invoke-AzVmssVMRunCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Invoke-AzVmssVMRunCommand.md +--- + +# Invoke-AzVmssVMRunCommand + +## SYNOPSIS +Run command on the Virtual Machine Scale Set VM. + +## SYNTAX + +### DefaultParameter (Default) +``` +Invoke-AzVmssVMRunCommand [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> + -CommandId <String> [-ScriptPath <String>] [-ScriptString <String>] [-Parameter <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Invoke-AzVmssVMRunCommand -CommandId <String> [-ScriptPath <String>] [-ScriptString <String>] + [-Parameter <Hashtable>] [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ObjectParameter +``` +Invoke-AzVmssVMRunCommand -CommandId <String> [-ScriptPath <String>] [-ScriptString <String>] + [-Parameter <Hashtable>] [-VirtualMachineScaleSetVM] <PSVirtualMachineScaleSetVM> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Invoke a run command on the Virtual Machine Scale Set VM. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzVmssVMRunCommand -ResourceGroupName 'rgname' -VMScaleSetName 'vmssname' -InstanceId '0' -CommandId 'RunPowerShellScript' -ScriptPath 'sample.ps1' -Parameter @{"arg1" = "var1";"arg2" = "var2"} +``` + +Invoke a run command of RunPowerShellScript with overriding the script 'sample.ps1' and the parameters on the ID '0' VM in the virtual machine scale set of 'vmssname' in resource group 'rgname'. + +### Example 2 +```powershell +$VmssVM = Get-AzVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 +Invoke-AzVmssVMRunCommand -VirtualMachineScaleSetVM $VmssVM -CommandId 'RunPowerShellScript' -ScriptPath 'sample.ps1' -Parameter @{"arg1" = "var1";"arg2" = "var2"} +``` + +Invoke a run command of RunPowerShellScript with overriding the script 'sample.ps1' and the parameters on the ID '0' VM in the virtual machine scale set of 'vmssname' in resource group 'rgname'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandId +The run command id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceId +The instance ID of the virtual machine scale set VM. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameter +The run command parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id for the virtual machine scale set VM + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScriptPath +Path of the script to be executed. When this value is given, the given script will override the default script of the command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptString +The script as a string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSetVM +The PS Virtual Machine Scale Set VM Object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM +Parameter Sets: ObjectParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -VMScaleSetName +The name of the virtual machine scale set VM. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSRunCommandResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzAvailabilitySet.md b/azps-10.1.0/Az.Compute/New-AzAvailabilitySet.md new file mode 100644 index 0000000000..2f1b734542 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzAvailabilitySet.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: BF6AA8D4-D624-4BE1-A393-1A43909450C4 +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azavailabilityset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzAvailabilitySet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzAvailabilitySet.md +--- + +# New-AzAvailabilitySet + +## SYNOPSIS +Creates an Azure availability set. + +## SYNTAX + +``` +New-AzAvailabilitySet [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + [[-PlatformUpdateDomainCount] <Int32>] [[-PlatformFaultDomainCount] <Int32>] [[-Sku] <String>] + [-ProximityPlacementGroupId <String>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzAvailabilitySet** cmdlet creates an Azure availability set. + +## EXAMPLES + +### Example 1: Create an availability set +```powershell +New-AzAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" -Location "West US" +``` + +This command creates an availability set named AvailabilitySet03 in the resource group named ResourceGroup11. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location for the availability set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the availability set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, AvailabilitySetName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PlatformFaultDomainCount +Specifies the platform fault domain count. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PlatformUpdateDomainCount +Specifies the platform update domain count. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProximityPlacementGroupId +The resource id of the Proximity Placement Group to use with this availability set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +The Name of Sku. +The acceptable values for this parameter are: +- Aligned: For managed disks +- Classic: For unmanaged disks + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet + +## NOTES + +## RELATED LINKS + +[Get-AzAvailabilitySet](./Get-AzAvailabilitySet.md) + +[Remove-AzAvailabilitySet](./Remove-AzAvailabilitySet.md) + + diff --git a/azps-10.1.0/Az.Compute/New-AzCapacityReservation.md b/azps-10.1.0/Az.Compute/New-AzCapacityReservation.md new file mode 100644 index 0000000000..49b5258b7a --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzCapacityReservation.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azcapacityreservation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzCapacityReservation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzCapacityReservation.md +--- + +# New-AzCapacityReservation + +## SYNOPSIS +Creates a Capacity Reservation resource in a Capacity Reservation Group + +## SYNTAX + +``` +New-AzCapacityReservation -ResourceGroupName <String> -ReservationGroupName <String> -Name <String> + -Location <String> -CapacityToReserve <Int32> -Sku <String> [-AsJob] [-Tag <Hashtable>] [-Zone <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCapacityReservation** cmdlet creates a Capacity Reservation resource in a Capacity Reservation Group + +## EXAMPLES + +### Example 1 +```powershell +New-AzCapacityReservation -ResourceGroupName "myRG" -Location "eastus" -ReservationGroupName "myCapacityReservationGroup" -Name "myCapacityReservation" -Sku "Standard_DS1_v2" -CapacityToReserve 4 +``` + +This command will create a Capacity Reservation resource with the provided sku and capacity in the Capacity Reservation Group named "myCapacityReservationGroup". + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapacityToReserve +Specifies the number of virtual machines in the scale set. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the capacity reservation resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CapacityReservationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReservationGroupName +Specifies the name of the capacity reservation group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CapacityReservationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +SKU of the resource for which capacity needs be reserved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Size + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specifies that resources and resource groups can be tagged with a set of name-value pairs. Adding tags to resources enables you to group resources together across resource groups and to create your own views. Each resource or resource group can have a maximum of 15 tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +Availability Zone to use for this capacity reservation. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSCapacityReservation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzCapacityReservationGroup.md b/azps-10.1.0/Az.Compute/New-AzCapacityReservationGroup.md new file mode 100644 index 0000000000..1bba01f6ed --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzCapacityReservationGroup.md @@ -0,0 +1,188 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azcapacityreservationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzCapacityReservationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzCapacityReservationGroup.md +--- + +# New-AzCapacityReservationGroup + +## SYNOPSIS +Creates a Capacity Reservation Group + +## SYNTAX + +``` +New-AzCapacityReservationGroup -ResourceGroupName <String> -Name <String> -Location <String> [-AsJob] + [-Tag <Hashtable>] [-Zone <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCapacityReservationGroup** cmdlet creates a Capacity Reservation Group + +## EXAMPLES + +### Example 1 +```powershell +New-AzCapacityReservationGroup -ResourceGroupName "myRG" -Location "eastus" -Name "myCapacityReservationGroup" +``` + +This command will create a Capacity Reservation Group with given properties. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the capacity reservation group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CapacityReservationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specifies that resources and resource groups can be tagged with a set of name-value pairs. Adding tags to resources enables you to group resources together across resource groups and to create your own views. Each resource or resource group can have a maximum of 15 tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +Specifies the zone list of the virtual machine. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSCapacityReservationGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzDisk.md b/azps-10.1.0/Az.Compute/New-AzDisk.md new file mode 100644 index 0000000000..7549519aba --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzDisk.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azdisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDisk.md +--- + +# New-AzDisk + +## SYNOPSIS + +Creates a managed disk. + +## SYNTAX + +``` +New-AzDisk [-ResourceGroupName] <String> [-DiskName] <String> [-Disk] <PSDisk> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The **New-AzDisk** cmdlet creates a managed disk. + +## EXAMPLES + +### Example 1 + +```powershell +$diskconfig = New-AzDiskConfig -Location 'Central US' -DiskSizeGB 5 -SkuName Standard_LRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$diskconfig = Set-AzDiskDiskEncryptionKey -Disk $diskconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$diskconfig = Set-AzDiskKeyEncryptionKey -Disk $diskconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +New-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; +``` + +The first command creates a local empty disk object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. +The second and third commands set the disk encryption key and key encryption key settings for the disk object. +The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. + +### Example 2 + +```powershell +$diskconfig = New-AzDiskConfig -Location 'Central US' -DiskSizeGB 5 -SkuName Standard_LRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; +$diskConfig.EncryptionSettingsCollection = New-Object Microsoft.Azure.Management.Compute.Models.EncryptionSettingsCollection + +$encryptionSettingsElement1 = New-Object Microsoft.Azure.Management.Compute.Models.EncryptionSettingsElement +$encryptionSettingsElement1.DiskEncryptionKey = New-Object Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference +$encryptionSettingsElement1.DiskEncryptionKey.SourceVault = New-Object Microsoft.Azure.Management.Compute.Models.SourceVault +$encryptionSettingsElement1.DiskEncryptionKey.SourceVault.Id = $disk_encryption_key_id_1 +$encryptionSettingsElement1.DiskEncryptionKey.SecretUrl = $disk_encryption_secret_url_1 +$encryptionSettingsElement1.KeyEncryptionKey = New-Object Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference +$encryptionSettingsElement1.KeyEncryptionKey.SourceVault = New-Object Microsoft.Azure.Management.Compute.Models.SourceVault +$encryptionSettingsElement1.KeyEncryptionKey.SourceVault.Id = $key_encryption_key_id_1 +$encryptionSettingsElement1.KeyEncryptionKey.KeyUrl = $key_encryption_key_url_1 + +$encryptionSettingsElement2 = New-Object Microsoft.Azure.Management.Compute.Models.EncryptionSettingsElement +$encryptionSettingsElement2.DiskEncryptionKey = New-Object Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference +$encryptionSettingsElement2.DiskEncryptionKey.SourceVault = New-Object Microsoft.Azure.Management.Compute.Models.SourceVault +$encryptionSettingsElement2.DiskEncryptionKey.SourceVault.Id = $disk_encryption_key_id_2 +$encryptionSettingsElement2.DiskEncryptionKey.SecretUrl = $disk_encryption_secret_url_2 +$encryptionSettingsElement2.KeyEncryptionKey = New-Object Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference +$encryptionSettingsElement2.KeyEncryptionKey.SourceVault = New-Object Microsoft.Azure.Management.Compute.Models.SourceVault +$encryptionSettingsElement2.KeyEncryptionKey.SourceVault.Id = $key_encryption_key_id_2 +$encryptionSettingsElement2.KeyEncryptionKey.KeyUrl = $key_encryption_key_url_2 + +$diskConfig.EncryptionSettingsCollection.EncryptionSettings += $encryptionSettingsElement1 +$diskConfig.EncryptionSettingsCollection.EncryptionSettings += $encryptionSettingsElement2 +New-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; +``` + +The above command creates a disk with two encryption settings. + +### Example 3: Export a gallery image version to disk. + +```powershell +$galleryImageVersionID = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myImageRG/providers/Microsoft.Compute/galleries/myGallery/images/myImage/versions/1.0.0" +$location = "eastus" +$rgName = "eastus" +$region = "eastus" + + # Export the OS disk +$myDiskName = "myOSDisk" +$imageOSDisk = @{Id = $galleryImageVersionID} +$OSDiskConfig = New-AzDiskConfig -Location $location -CreateOption "FromImage" -GalleryImageReference $imageOSDisk +New-AzDisk -ResourceGroupName $rgName -DiskName $myDiskName -Disk $OSDiskConfig + + # Export any data disk from the image version +$myDiskName = "myDataDisk" +$imageDataDisk = @{Id = $galleryImageVersionID; Lun=1} +$dataDiskConfig = New-AzDiskConfig -Location $location -CreateOption "FromImage" -GalleryImageReference $imageDataDisk +New-AzDisk -ResourceGroupName $rgName -DiskName $myDiskName -Disk $dataDiskConfig +``` + +This example exports a disk from the image version. To export a data disk from the image version, include the LUN number of the data disk to export from the image version. + +## PARAMETERS + +### -AsJob + +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disk + +Specifies a local disk object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DiskName + +Specifies the name of a disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzDiskAccess.md b/azps-10.1.0/Az.Compute/New-AzDiskAccess.md new file mode 100644 index 0000000000..60246adbb6 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzDiskAccess.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDiskAccess.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDiskAccess.md +--- + +# New-AzDiskAccess + +## SYNOPSIS +Creates a Disk Access resource + +## SYNTAX + +``` +New-AzDiskAccess [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDiskAccess** cmdlet creates a Disk Access resource + +## EXAMPLES + +### Example 1 +```powershell +New-AzDiskAccess -ResourceGroupName "ResourceGroup01" -Name "DiskAccess01" -Location "NorthCentralUS" +``` + +This command will create a Disk Access with given properties. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a disk access. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DiskAccessName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskAccess + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzDiskConfig.md b/azps-10.1.0/Az.Compute/New-AzDiskConfig.md new file mode 100644 index 0000000000..421a234671 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzDiskConfig.md @@ -0,0 +1,730 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azdiskconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDiskConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDiskConfig.md +--- + +# New-AzDiskConfig + +## SYNOPSIS +Creates a configurable disk object. + +## SYNTAX + +``` +New-AzDiskConfig [[-SkuName] <String>] [-Tier <String>] [-LogicalSectorSize <Int32>] + [[-OsType] <OperatingSystemTypes>] [[-DiskSizeGB] <Int32>] [[-Location] <String>] [-EdgeZone <String>] + [-PurchasePlan <PSPurchasePlan>] [-SupportsHibernation <Boolean>] [-Zone <String[]>] + [-HyperVGeneration <String>] [-DiskIOPSReadWrite <Int64>] [-DiskMBpsReadWrite <Int64>] + [-DiskIOPSReadOnly <Int64>] [-DiskMBpsReadOnly <Int64>] [-MaxSharesCount <Int32>] [-Tag <Hashtable>] + [-CreateOption <String>] [-StorageAccountId <String>] [-ImageReference <ImageDiskReference>] + [-GalleryImageReference <ImageDiskReference>] [-SourceUri <String>] [-SourceResourceId <String>] + [-UploadSizeInBytes <Int64>] [-EncryptionSettingsEnabled <Boolean>] + [-DiskEncryptionKey <KeyVaultAndSecretReference>] [-KeyEncryptionKey <KeyVaultAndKeyReference>] + [-DiskEncryptionSetId <String>] [-EncryptionType <String>] [-DiskAccessId <String>] + [-NetworkAccessPolicy <String>] [-BurstingEnabled <Boolean>] [-PublicNetworkAccess <String>] + [-AcceleratedNetwork <Boolean>] [-DataAccessAuthMode <String>] [-Architecture <String>] + [-PerformancePlus <Boolean>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDiskConfig** cmdlet creates a configurable disk object. + +## EXAMPLES + +### Example 1 +```powershell +$diskconfig = New-AzDiskConfig -Location 'Central US' -DiskSizeGB 5 -SkuName Standard_LRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$diskconfig = Set-AzDiskDiskEncryptionKey -Disk $diskconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$diskconfig = Set-AzDiskKeyEncryptionKey -Disk $diskconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +New-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; +``` + +The first command creates a local empty disk object with size 5GB in Standard_LRS storage account +type. It also sets Windows OS type and enables encryption settings. The second and third commands +set the disk encryption key and key encryption key settings for the disk object. The last command +takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. + +### Example 2 +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$diskconfig = New-AzDiskConfig -Location 'Central US' -DiskSizeGB 1023 -SkuName Standard_LRS -OsType Windows -CreateOption Upload -DiskIOPSReadWrite 500 -DiskMBpsReadWrite 8; +New-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; +$diskSas = Grant-AzDiskAccess -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DurationInSecond 86400 -Access 'Write' +$disk = Get-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' +# $disk.DiskState == 'ReadyToUpload' + AzCopy /Source:https://myaccount.blob.core.windows.net/mycontainer1 /Dest:$diskSas +$disk = Get-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' +# $disk.DiskState == 'ActiveUpload' +Revoke-AzDiskAccess -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' +``` + +The first command creates a local disk object for Upload. +The second command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. +The third command gets SAS Url for the disk. +The fourth command gets the state of the disk. +If the disk state is 'ReadyToUpload', a user can upload a disk from blob storage to the disk SAS Url using AzCopy. +During uploading, the disk state is changed to 'ActiveUpload'. +The last command revokes the disk access for the SAS Url. + +### Example 3 +```powershell +$galleryImageReference = @{Id = '/subscriptions/0296790d-427c-48ca-b204-8b729bbd8670/resourceGroups/swaggertests/providers/Microsoft.Compute/galleries/swaggergallery/images/swaggerimagedef/versions/1.0.0'; Lun=1} +$diskConfig = New-AzDiskConfig -Location 'West US' -CreateOption 'FromImage' -GalleryImageReference $galleryImageReference; +New-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskConfig +``` + +Create a disk from a Shared Gallery Image Version. Id is the id of the shared gallery image version. Lun is needed only if the source is a data disk. + +## PARAMETERS + +### -AcceleratedNetwork +True if the image from which the OS disk is created supports accelerated networking. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Architecture +CPU architecture supported by an OS disk. Possible values are "X64" and "Arm64". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BurstingEnabled +Enables bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CreateOption +Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, +creates an empty disk, or attaches an existing disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataAccessAuthMode +Additional authentication requirements when exporting or uploading to a disk or snapshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskAccessId +Gets or sets ARM ID of the DiskAccess resource for using private endpoints on. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionKey +Specifies the disk encryption key object on a disk. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of the disk encryption set to use for enabling encryption at rest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskIOPSReadOnly +The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskIOPSReadWrite +The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskMBpsReadOnly +The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskMBpsReadWrite +The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskSizeGB +Specifies the size of the disk in GB. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EdgeZone +Sets the edge zone name. If set, the query will be routed to the specified edgezone instead of the main region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptionSettingsEnabled +Enable encryption settings. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptionType +The type of key used to encrypt the data of the disk. Available values are: 'EncryptionAtRestWithPlatformKey', 'EncryptionAtRestWithCustomerKey' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryImageReference +The GalleryImageReference object. Required if creating from a Gallery Image. +The id will be the ARM id of the shared galley image version from which to create a disk. +A lun is needed if the source of the copy is one of the data disks in the gallery image; if null, the OS disk of the image will be copied. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.ImageDiskReference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HyperVGeneration +The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Allowed values are V1 and V2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ImageReference +Specifies the image reference on a disk. +The ID will be the ARM ID of the PIR or user image from which to create a disk. +A LUN is needed if the source of the copy is one of the data disks in the gallery image; if null, the OS disk of the image will be copied. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.ImageDiskReference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyEncryptionKey +Specifies the Key encryption key on a disk. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies a location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LogicalSectorSize +Logical sector size in bytes for Ultra disks. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxSharesCount +The maximum number of VMs that can attach to the disk at the same time. +Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkAccessPolicy +Network access policy defines the network access policy. +Possible values include: 'AllowAll', 'AllowPrivate', 'DenyAll' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsType +Specifies the OS type. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes] +Parameter Sets: (All) +Aliases: +Accepted values: Windows, Linux + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PerformancePlus +Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Policy for controlling export on the disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PurchasePlan +Specifies the Purchase Plan for the Disk. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSPurchasePlan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuName +Specifies the Sku name of the storage account. Available values are Standard_LRS, Premium_LRS, StandardSSD_LRS, and UltraSSD_LRS, Premium_ZRS and StandardSSD_ZRS. UltraSSD_LRS can only be used with Empty value for CreateOption parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountType + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceResourceId +Specifies the source resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceUri +Specifies the source Uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountId +Specifies the storage account ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SupportsHibernation +Customers can set the SupportsHibernation flag on the Disk. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tier +Performance tier of the disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UploadSizeInBytes +Specifies the size of the contents of the upload including the VHD footer when CreateOption is Upload. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer). + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +Specifies the logical zone list for Disk. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Int32 + +### System.String[] + +### System.Collections.Hashtable + +### Microsoft.Azure.Management.Compute.Models.ImageDiskReference + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference + +### Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzDiskEncryptionSet.md b/azps-10.1.0/Az.Compute/New-AzDiskEncryptionSet.md new file mode 100644 index 0000000000..051ad7871a --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzDiskEncryptionSet.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azdiskencryptionset.md +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDiskEncryptionSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDiskEncryptionSet.md +--- + +# New-AzDiskEncryptionSet + +## SYNOPSIS +Creates a disk encryption set. + +## SYNTAX + +``` +New-AzDiskEncryptionSet [-ResourceGroupName] <String> [-Name] <String> [-InputObject] <PSDiskEncryptionSet> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a disk encryption set. + +## EXAMPLES + +### Example 1 +```powershell +$config = New-AzDiskEncryptionSetConfig -Location 'westcentralus' -KeyUrl "https://valut1.vault.azure.net:443/keys/key1/mykey" -SourceVaultId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.KeyVault/vaults/vault1' -IdentityType 'SystemAssigned' +$config | New-AzDiskEncryptionSet -ResourceGroupName 'rg1' -Name 'enc1' +``` + +Creates disk encryption set using the given active key in the key vault. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The local object of the disk encryption set. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskEncryptionSet +Parameter Sets: (All) +Aliases: DiskEncryptionSet + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of disk encryption set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DiskEncryptionSetName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskEncryptionSet + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskEncryptionSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzDiskEncryptionSetConfig.md b/azps-10.1.0/Az.Compute/New-AzDiskEncryptionSetConfig.md new file mode 100644 index 0000000000..d7488deca9 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzDiskEncryptionSetConfig.md @@ -0,0 +1,246 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azdiskencryptionsetconfig.md +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDiskEncryptionSetConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDiskEncryptionSetConfig.md +--- + +# New-AzDiskEncryptionSetConfig + +## SYNOPSIS +Creates a configurable disk encryption set object. + +## SYNTAX + +``` +New-AzDiskEncryptionSetConfig [-Location] <String> [[-Tag] <Hashtable>] [[-IdentityType] <String>] + [[-SourceVaultId] <String>] [-KeyUrl <String>] [-EncryptionType <String>] + [-RotationToLatestKeyVersionEnabled <Boolean>] [-FederatedClientId <String>] + [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a configurable disk encryption set object. + +## EXAMPLES + +### Example 1 +```powershell +$config = New-AzDiskEncryptionSetConfig -Location 'westcentralus' -KeyUrl "https://valut1.vault.azure.net:443/keys/key1/mykey" -SourceVaultId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.KeyVault/vaults/vault1' -IdentityType 'SystemAssigned' +$config | New-AzDiskEncryptionSet -ResourceGroupName 'rg1' -Name 'enc1' +``` + +Creates disk encryption set using the given active key in the key vault. + +### Example 2 +```powershell +$userAssignedIdentities = @{ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" = @{}}; +$config = New-AzDiskEncryptionSetConfig -Location 'westcentralus' -KeyUrl "https://valut1.vault.azure.net:443/keys/key1/mykey" -SourceVaultId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.KeyVault/vaults/vault1' -IdentityType 'UserAssigned' -RotationToLatestKeyVersionEnabled $True -UserAssignedIdentity $userAssignedIdentities -FederatedClientId "13ebe945-1314-41b4-8b58-f3784e0dd278" +$config | New-AzDiskEncryptionSet -ResourceGroupName 'rg1' -Name 'enc1' +``` + +Using UserAssignedIdentity and FederatedClientId + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionType +Use this to set the encryption type of the disk encryption set. Available values are: 'EncryptionAtRestWithPlatformKey', 'EncryptionAtRestWithCustomerKey'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FederatedClientId +Multi-tenant application client id to access key vault in a different tenant. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityType +The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyUrl +Url pointing to the active key in KeyVault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies a location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RotationToLatestKeyVersionEnabled +Gets or sets set this flag to true to enable auto-updating of this disk encryption + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceVaultId +Resource id of the KeyVault containing the active key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskEncryptionSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzDiskPurchasePlanConfig.md b/azps-10.1.0/Az.Compute/New-AzDiskPurchasePlanConfig.md new file mode 100644 index 0000000000..1ac24cb380 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzDiskPurchasePlanConfig.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azdiskpurchaseplanconfig.md +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDiskPurchasePlanConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDiskPurchasePlanConfig.md +--- + +# New-AzDiskPurchasePlanConfig + +## SYNOPSIS +Creates a PurchasePlan Object + +## SYNTAX + +``` +New-AzDiskPurchasePlanConfig -Publisher <String> -Name <String> -Product <String> [-PromotionCode <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a PurchasePlan Object + +## EXAMPLES + +### Example 1 +```powershell +$diskPurchasePlan = New-AzDiskPurchasePlanConfig -Name "planName" -Publisher "planPublisher" -Product "planPorduct" -PromotionCode "planPromotionCode" +$diskConfig = New-AzDiskConfig -Location 'eastus2euap' -AccountType 'Premium_LRS' -CreateOption 'Empty' -DiskSizeGB 32 -PurchasePlan $diskPurchasePlan +New-AzDisk -ResourceGroupName 'ResourceGroup02' -DiskName 'Disk02' -Disk $diskConfig +$disk = Get-AzDisk -ResourceGroupName 'ResourceGroup02' -DiskName 'Disk02' +``` + +Customers can set the PurchasePlan on the Managed Disks. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Config + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Product +Name of Product + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PromotionCode +PromotionCode for Purchase Plan + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Publisher +Name of Publisher + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSPurchasePlan + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSPurchasePlan + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzDiskUpdateConfig.md b/azps-10.1.0/Az.Compute/New-AzDiskUpdateConfig.md new file mode 100644 index 0000000000..ebb46c3b85 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzDiskUpdateConfig.md @@ -0,0 +1,493 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azdiskupdateconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDiskUpdateConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzDiskUpdateConfig.md +--- + +# New-AzDiskUpdateConfig + +## SYNOPSIS +Creates a configurable disk update object. + +## SYNTAX + +``` +New-AzDiskUpdateConfig [[-SkuName] <String>] [-Tier <String>] [-DiskIOPSReadOnly <Int64>] + [-DiskMBpsReadOnly <Int64>] [-MaxSharesCount <Int32>] [-NetworkAccessPolicy <String>] [-DiskAccessId <String>] + [[-OsType] <OperatingSystemTypes>] [[-DiskSizeGB] <Int32>] [[-Tag] <Hashtable>] [-DiskIOPSReadWrite <Int32>] + [-DiskMBpsReadWrite <Int32>] [-PurchasePlan <PSPurchasePlan>] [-SupportsHibernation <Boolean>] + [-EncryptionSettingsEnabled <Boolean>] [-DiskEncryptionKey <KeyVaultAndSecretReference>] + [-KeyEncryptionKey <KeyVaultAndKeyReference>] [-DiskEncryptionSetId <String>] [-EncryptionType <String>] + [-BurstingEnabled <Boolean>] [-PublicNetworkAccess <String>] [-AcceleratedNetwork <Boolean>] + [-DataAccessAuthMode <String>] [-Architecture <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDiskUpdateConfig** cmdlet creates a configurable disk update object. + +## EXAMPLES + +### Example 1 +```powershell +$diskupdateconfig = New-AzDiskUpdateConfig -DiskSizeGB 10 -SkuName Premium_LRS -OsType Windows -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$diskupdateconfig = Set-AzDiskUpdateDiskEncryptionKey -DiskUpdate $diskupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$diskupdateconfig = Set-AzDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +Update-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig; +``` + +The first command creates a local empty disk update object with size 10GB in Premium_LRS storage +account type. It also sets Windows OS type and enables encryption settings. The second and third +commands set the disk encryption key and key encryption key settings for the disk update object. +The last command takes the disk update object and updates an existing disk with name 'Disk01' in +resource group 'ResourceGroup01'. + +### Example 2 +```powershell +New-AzDiskUpdateConfig -DiskSizeGB 10 | Update-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01'; +``` + +This command updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01' to 10 GB disk size. + +## PARAMETERS + +### -AcceleratedNetwork +True if the image from which the OS disk is created supports accelerated networking. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Architecture +CPU architecture supported by an OS disk. Possible values are "X64" and "Arm64". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BurstingEnabled +Enables bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataAccessAuthMode +Additional authentication requirements when exporting or uploading to a disk or snapshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskAccessId +ARM id of the DiskAccess resource for using private endpoints on disks + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionKey +Specifies the disk encryption key object on a disk. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of the disk encryption set to use for enabling encryption at rest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskIOPSReadOnly +The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskIOPSReadWrite +The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskMBpsReadOnly +The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskMBpsReadWrite +The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskSizeGB +Specifies the size of the disk in GB. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptionSettingsEnabled +Enable encryption settings on the disk + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptionType +The type of key used to encrypt the data of the disk. Available values are: EncryptionAtRestWithPlatformKey, EncryptionAtRestWithCustomerKey + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyEncryptionKey +Specifies the Key encryption key on a disk. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxSharesCount +The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkAccessPolicy +Policy for accessing the disk via network. Available values are: AllowAll, AllowPrivate, DeyAll + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsType +Specifies the OS type. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes] +Parameter Sets: (All) +Aliases: +Accepted values: Windows, Linux + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Policy for controlling export on the disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PurchasePlan +Sets the purchase plan for the disk. Used for establishing the purchase context of any 3rd Party artifact through Marketplace. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSPurchasePlan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuName +Specifies the Sku name of the storage account. Available values are Standard_LRS, Premium_LRS, StandardSSD_LRS, and UltraSSD_LRS. UltraSSD_LRS can only be used with Empty value for CreateOption parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountType + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SupportsHibernation +Indicates if the OS on the disk supports hibernation with $true or $false + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tier +Performance tier of the disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Int32 + +### System.Collections.Hashtable + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference + +### Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzGallery.md b/azps-10.1.0/Az.Compute/New-AzGallery.md new file mode 100644 index 0000000000..8b2ccc97e8 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzGallery.md @@ -0,0 +1,271 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azgallery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzGallery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzGallery.md +--- + +# New-AzGallery + +## SYNOPSIS +Create a gallery. + +## SYNTAX + +``` +New-AzGallery [-ResourceGroupName] <String> [-Name] <String> [-AsJob] [-Location] <String> + [-Description <String>] [-Tag <Hashtable>] [-Permission <String>] [-PublisherUri <String>] + [-PublisherContact <String>] [-Eula <String>] [-PublicNamePrefix <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a gallery. + +## EXAMPLES + +### Example 1 +```powershell +New-AzGallery -ResourceGroupName $rgname -Name $galleryName -Location $location -Description $galleryDescription +``` + +Create a gallery. + +### Example 2 +```powershell +New-AzGallery -ResourceGroupName $rgname -Name $galleryName -Location $location -Description $galleryDescription -Permission Groups +``` + +Create a gallery with Direct Sharing enabled. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the gallery resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Eula +Gets or sets end-user license agreement for community gallery image. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GalleryName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Permission +This property allows you to specify the permission of sharing gallery. Possible values are: 'Private' and 'Groups'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNamePrefix +Gets or sets the prefix of the gallery name that will be displayed publicly. Visible to all users. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublisherContact +Gets or sets community gallery publisher support email. The email address of the publisher. Visible to all users. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublisherUri +Gets or sets the link to the publisher website. Visible to all users. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzGalleryApplication.md b/azps-10.1.0/Az.Compute/New-AzGalleryApplication.md new file mode 100644 index 0000000000..9fe240e448 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzGalleryApplication.md @@ -0,0 +1,257 @@ +--- +external help file: Az.Compute-help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azgalleryapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzGalleryApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzGalleryApplication.md +--- + +# New-AzGalleryApplication + +## SYNOPSIS +Create or update a gallery Application Definition. + +## SYNTAX + +``` +New-AzGalleryApplication -GalleryName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -Location <String> -SupportedOSType <OperatingSystemTypes> [-Description <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a gallery Application Definition. + +## EXAMPLES + +### Example 1: Create a gallery application +```powershell +New-AzGalleryApplication -ResourceGroupName $rgName -Location EastUS -GalleryName $galleryName -Name $name -SupportedOSType Windows +``` + +Creating a Gallery Application in a Gallery. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of this gallery Application Definition resource. +This property is updatable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryName +The name of the Shared Application Gallery in which the Application Definition is to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the gallery Application Definition to be created or updated. +The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. +The maximum length is 80 characters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GalleryApplicationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportedOSType +This property allows you to specify the supported type of the OS that application is built for. + + + Possible values are: + + **Windows** + + **Linux** + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Support.OperatingSystemTypes +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20220103.IGalleryApplication + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzGalleryApplicationVersion.md b/azps-10.1.0/Az.Compute/New-AzGalleryApplicationVersion.md new file mode 100644 index 0000000000..dc22877465 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzGalleryApplicationVersion.md @@ -0,0 +1,447 @@ +--- +external help file: Az.Compute-help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azgalleryapplicationversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzGalleryApplicationVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzGalleryApplicationVersion.md +--- + +# New-AzGalleryApplicationVersion + +## SYNOPSIS +Create or update a gallery Application Version. + +## SYNTAX + +``` +New-AzGalleryApplicationVersion -GalleryApplicationName <String> -GalleryName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] -Location <String> -Install <String> -Remove <String> + [-DefaultConfigFileLink <String>] [-PackageFileLink <String>] [-PublishingProfileEndOfLifeDate <DateTime>] + [-PublishingProfileExcludeFromLatest] [-ReplicaCount <Int32>] [-Tag <Hashtable>] + [-TargetRegion <ITargetRegion[]>] [-Update <String>] [-PackageFileName <String>] [-ConfigFileName <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a gallery Application Version. + +## EXAMPLES + +### Example 1: Create a gallery application version. +```powershell +$ctx = New-AzStorageContext -StorageAccountName $storAccName +$SASToken = New-AzStorageBlobSASToken -Context $ctx -Container $containerName -blob $blobName -Permission r +$storAcc = Get-AzStorageAccount -ResourceGroupName $rgName -Name $storAccName +$blob = Get-AzStorageBlob -Container $containerName -Blob $blobName -Context $storAcc.Context +$SASToken = New-AzStorageBlobSASToken -Container $containerName -Blob $blobName -Permission rwd -Context $storAcc.Context +$SASUri = $blob.ICloudBlob.Uri.AbsoluteUri + $SASToken +New-AzGalleryApplicationVersion -ResourceGroupName $rgname -Location EastUS -GalleryName $galleryName -GalleryApplicationName $galleryApplicationName -name "0.1.0" -PackageFileLink $SASUri -Install "powershell -command 'Expand-Archive -Path package.zip -DestinationPath C:\\package\'" -Remove "del C:\\package" +``` + +Creating a Gallery Application Version. +Using SAS Uri for the blob for PackageFileLink. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigFileName +Optional. +The name to assign the downloaded config file on the VM. +This is limited to 4096 characters. +If not specified, the config file will be named the Gallery Application name appended with "_config". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConfigFileLink +Optional. +The defaultConfigurationLink of the artifact, must be a readable storage page blob. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryApplicationName +The name of the gallery Application Definition in which the Application Version is to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryName +The name of the Shared Application Gallery in which the Application Definition resides. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Install +Required. +The path and arguments to install the gallery application. +This is limited to 4096 characters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the gallery Application Version to be created. +Needs to follow semantic version name pattern: The allowed characters are digit and period. +Digits must be within the range of a 32-bit integer. +Format: \<MajorVersion\>.\<MinorVersion\>.\<Patch\> + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GalleryApplicationVersionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageFileLink +Required. +The mediaLink of the artifact, must be a readable storage page blob. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageFileName +Optional. +The name to assign the downloaded package file on the VM. +This is limited to 4096 characters. +If not specified, the package file will be named the same as the Gallery Application name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishingProfileEndOfLifeDate +The end of life date of the gallery image version. +This property can be used for decommissioning purposes. +This property is updatable. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishingProfileExcludeFromLatest +If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Remove +Required. +The path and arguments to remove the gallery application. +This is limited to 4096 characters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaCount +The number of replicas of the Image Version to be created per region. +This property would take effect for a region when regionalReplicaCount is not specified. +This property is updatable. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetRegion +The target regions where the Image Version is going to be replicated to. +This property is updatable. +To construct, see NOTES section for TARGETREGION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20220103.ITargetRegion[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Update +Optional. +The path and arguments to update the gallery application. +If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. +This is limited to 4096 characters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20220103.IGalleryApplicationVersion + +## 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. + + +`TARGETREGION <ITargetRegion[]>`: The target regions where the Image Version is going to be replicated to. This property is updatable. + - `Name <String>`: The name of the region. + - `[EncryptionDataDiskImage <IDataDiskImageEncryption[]>]`: A list of encryption specifications for data disk images. + - `Lun <Int32>`: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. + - `[DiskEncryptionSetId <String>]`: A relative URI containing the resource ID of the disk encryption set. + - `[OSDiskImageDiskEncryptionSetId <String>]`: A relative URI containing the resource ID of the disk encryption set. + - `[RegionalReplicaCount <Int32?>]`: The number of replicas of the Image Version to be created per region. This property is updatable. + - `[SecurityProfileConfidentialVMEncryptionType <ConfidentialVMEncryptionType?>]`: confidential VM encryption types + - `[SecurityProfileSecureVMDiskEncryptionSetId <String>]`: secure VM disk encryption set id + - `[StorageAccountType <StorageAccountType?>]`: Specifies the storage account type to be used to store the image. This property is not updatable. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzGalleryImageDefinition.md b/azps-10.1.0/Az.Compute/New-AzGalleryImageDefinition.md new file mode 100644 index 0000000000..a4fedfe7f9 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzGalleryImageDefinition.md @@ -0,0 +1,699 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azgalleryimagedefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzGalleryImageDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzGalleryImageDefinition.md +--- + +# New-AzGalleryImageDefinition + +## SYNOPSIS + +Create a gallery image definition. + +## SYNTAX + +``` +New-AzGalleryImageDefinition [-ResourceGroupName] <String> [-GalleryName] <String> [-Name] <String> [-AsJob] + [-Location] <String> -Publisher <String> -Offer <String> -Sku <String> -OsState <OperatingSystemStateTypes> + -OsType <OperatingSystemTypes> [-Description <String>] [-DisallowedDiskType <String[]>] + [-EndOfLifeDate <DateTime>] [-Eula <String>] [-HyperVGeneration <String>] [-MinimumMemory <Int32>] + [-MinimumVCPU <Int32>] [-MaximumMemory <Int32>] [-MaximumVCPU <Int32>] [-PrivacyStatementUri <String>] + [-PurchasePlanName <String>] [-PurchasePlanProduct <String>] [-PurchasePlanPublisher <String>] + [-ReleaseNoteUri <String>] [-Tag <Hashtable>] [-Feature <GalleryImageFeature[]>] [-Architecture <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +Create a gallery image definition. + +## EXAMPLES + +### Example 1: Create an image definition for specialized linux images + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$location = "eastus" +$publisherName = "GreatPublisher" +$offerName = "GreatOffer" +$skuName = "GreatSku" +$description = "My gallery" +New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Specialized" -OsType "Linux" -Description $description +``` + +Creates a gallery image definition to contain image versions for specialized linux images. + +### Example 2: Create an image definition for generalized linux images + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$location = "eastus" +$publisherName = "GreatPublisher" +$offerName = "GreatOffer" +$skuName = "GreatSku" +$description = "My gallery" +New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -Description $description +``` + +Creates a gallery image definition to contain image versions for generalized linux images. + +### Example 3: Create an image definition for specialized windows images + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$location = "eastus" +$publisherName = "GreatPublisher" +$offerName = "GreatOffer" +$skuName = "GreatSku" +$description = "My gallery" +New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Specialized" -OsType "Windows" -Description $description +``` + +Creates a gallery image definition to contain image versions for specialized windows images. + +### Example 4: Create an image definition for generalized windows images and set features. + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$location = "eastus" +$publisherName = "GreatPublisher" +$offerName = "GreatOffer" +$skuName = "GreatSku" +$description = "My gallery" +$IsHibernateSupported = @{Name='IsHibernateSupported';Value='True'} +$IsAcceleratedNetworkSupported = @{Name='IsAcceleratedNetworkSupported';Value='False'} +$ConfidentialVMSupported = @{Name='SecurityType';Value='ConfidentialVMSupported'} +$features = @($IsHibernateSupported,$IsAcceleratedNetworkSupported, $ConfidentialVMSupported) +New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Windows" -Description $description -Feature $features -HyperVGeneration "V2" +``` + +Creates a gallery image definition to contain image versions for generalized windows images. + +### Example 5: Create an image definition with plan information + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$location = "eastus" +$publisherName = "GreatPublisher" +$offerName = "GreatOffer" +$skuName = "GreatSku" +$purchasePlanName = "myPlanName" +$purchasePlanProduct = "myPlanProduct" +$purchasePlanPublisher = "myPlanPublisher" +New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -PurchasePlanName $purchasePlanName -PurchasePlanProduct $purchasePlanProduct -PurchasePlanPublisher $purchasePlanPublisher +``` + +Creates a gallery image definition for linux generalized images and define the plan name, product, and publisher. Only image versions that match the plan information can be added to this definition. + +### Example 6: Create an image definition and indicate end of life date + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$location = "eastus" +$publisherName = "GreatPublisher" +$offerName = "GreatOffer" +$skuName = "GreatSku" +$endOfLifeDate = "2024-08-02T00:00:00+00:00" +New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -EndOfLifeDate $endOfLifeDate +``` + +This example has the end-of-life date for image definitions set to August 2, 2024 at mignight UTC. End-of-life dates can be specified for image definitions and image versions. Image definitions can still be used after the end-of-life dates. + +### Example 7: Create an image definition and recommend minimum and maximum CPU and memory (GB) + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$location = "eastus" +$publisherName = "GreatPublisher" +$offerName = "GreatOffer" +$skuName = "GreatSku" +$minMemory = 32 +$maxMemory = 128 +$minVCPU = 2 +$maxVCPU = 8 +New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -MinimumMemory $minMemory -MaximumMemory $maxMemory -MinimumVCPU $minVCPU -MaximumVCPU $maxVCPU +``` + +Creates a gallery image definition and recommends the minimum and maximum ranges for the CPU and memory that the image versions in this image definition support. Image versions can still be used to create virtual machines with memory and vCPU settings outside the recommended ranges. + +### Example 8: Create an image definition and indicate which OS disk types are not recommended for the image + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$location = "eastus" +$publisherName = "GreatPublisher" +$offerName = "GreatOffer" +$skuName = "GreatSku" +$disallowedDiskTypes = @("Standard_LRS") +New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -DisallowedDiskType $disallowedDiskTypes +``` + +Creates a gallery image definition and indicate which OS disk types may not be compatible with image versions within this image definition. Image versions can still be used to create virtual machines with an OS disk that is one of the disallowed disk types. + +### Example 9: Create an image definition and provide the EULA, privacy statement URI, and release notes URI + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$location = "eastus" +$publisherName = "GreatPublisher" +$offerName = "GreatOffer" +$skuName = "GreatSku" +$eula = "https://myeula" +$privacyStatementUri = "https://mystatement" +$releaseNoteUri = "https://myreleasenotes" +New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -Eula $eula -PrivacyStatementUri $privacyStatementUri -ReleaseNoteUri $releaseNoteUri +``` + +Creates a gallery image definition for linux generalized images and specify either the string or path to an EULA agreement, privacy statement, and release notes tied to all image versions in the image definition. + +## PARAMETERS + +### -Architecture +CPU architecture supported by an OS disk. Possible values are "X64" and "Arm64". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob + +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +The description of the gallery image Definition resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisallowedDiskType + +The disallowed disk types. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EndOfLifeDate + +The end of life date of the gallery Image Definition + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Eula + +The Eula agreement for the gallery Image Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Feature + +A list of gallery image features. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.GalleryImageFeature[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryName + +The name of the gallery. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HyperVGeneration + +The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Allowed values are V1 and V2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location + +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaximumMemory + +The maximum of the recommended memory + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaximumVCPU + +The maximum of the recommended CPU core + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MinimumMemory + +The minimum of the recommended memory + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MinimumVCPU + +The minimum of the recommended CPU core + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name + +The name of the gallery image definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GalleryImageDefinitionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Offer + +The name of the gallery Image Definition offer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsState + +The state of OS + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.OperatingSystemStateTypes +Parameter Sets: (All) +Aliases: +Accepted values: Generalized, Specialized + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsType + +The type of OS + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes +Parameter Sets: (All) +Aliases: +Accepted values: Windows, Linux + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivacyStatementUri + +The privacy statement uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Publisher + +The name of the gallery Image Definition publisher. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PurchasePlanName + +The ID for the purchase plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PurchasePlanProduct + +The product ID for the purchase plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PurchasePlanPublisher + +The publisher ID for the purchase plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReleaseNoteUri + +The release note uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName + +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku + +The name of the gallery Image Definition SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag + +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Management.Compute.Models.OperatingSystemStateTypes + +### Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes + +### System.DateTime + +### System.Collections.Hashtable + +### System.Int32 + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzGalleryImageVersion.md b/azps-10.1.0/Az.Compute/New-AzGalleryImageVersion.md new file mode 100644 index 0000000000..ea4a8f5905 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzGalleryImageVersion.md @@ -0,0 +1,617 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azgalleryimageversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzGalleryImageVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzGalleryImageVersion.md +--- + +# New-AzGalleryImageVersion + +## SYNOPSIS + +Create a gallery image version. + +## SYNTAX + +``` +New-AzGalleryImageVersion [-ResourceGroupName] <String> [-GalleryName] <String> + [-GalleryImageDefinitionName] <String> [-Name] <String> [-AsJob] -Location <String> + [-DataDiskImage <GalleryDataDiskImage[]>] [-OSDiskImage <GalleryOSDiskImage>] + [-PublishingProfileEndOfLifeDate <DateTime>] [-PublishingProfileExcludeFromLatest] [-ReplicaCount <Int32>] + [-SourceImageId <String>] [-StorageAccountType <String>] [-Tag <Hashtable>] [-TargetRegion <Hashtable[]>] + [-TargetExtendedLocation <Hashtable[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +Create a gallery image version. + +## EXAMPLES + +### Example 1: Create an image version from a virtual machine + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$galleryImageVersionName = "1.0.0" +$location = "eastus" +$sourceImageId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myVMRG/providers/Microsoft.Compute/virtualMachines/myVM" +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -SourceImageId $sourceImageId +``` + +Add a new image version from a virtual machine into the image definition. + +### Example 2: Create an image version from a managed image + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$galleryImageVersionName = "1.0.0" +$location = "eastus" +$sourceImageId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myImageRG/providers/Microsoft.Compute/images/myImage" +$storageAccountType = "StandardSSD_LRS" + +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -StorageAccountType $storageAccountType -SourceImageId $sourceImageId +``` + +Add a new image version from a managed image into the image definition. + +### Example 3: Create an image version from an another image version + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$galleryImageVersionName = "1.0.0" +$location = "eastus" +$sourceImageId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myImageRG/providers/Microsoft.Compute/galleries/myOtherGallery/images/myImageDefinition/versions/1.0.0" +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -SourceImageId $sourceImageId +``` + +Copy an image version into another image version + +### Example 4: Add a new image version from a managed disk + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$galleryImageVersionName = "1.0.0" +$location = "eastus" +$osDisk = @{Source = @{Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myDiskRG/providers/Microsoft.Compute/disks/myOSDisk" }} +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -OSDiskImage $osDisk +``` + +Create an image version from a managed disk + +### Example 5: Add a new image version from a managed disk and add additional data disks + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$galleryImageVersionName = "1.0.0" +$location = "eastus" +$osDisk = @{Source = @{Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myDiskRG/providers/Microsoft.Compute/disks/myOSDisk" }} +$dataDisk0 = @{Source = @{Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myDiskRG/providers/Microsoft.Compute/disks/myDataDisk" }; Lun = 0; } +$dataDisks = @($dataDisk0) +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -OSDiskImage $osDisk -DataDiskImage $dataDisks +``` + +Create an image version by specifying OS and data disks + +### Example 6: Add a new image version from a snapshot of an OS disk + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$galleryImageVersionName = "1.0.0" +$location = "eastus" +$osSnapshot = @{Source = @{Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mySnapshotRG/providers/Microsoft.Compute/snapshots/myOSSnapshot" }} +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -OSDiskImage $osSnapshot +``` + +Create an image version from a disk snapshot + +### Example 7: Add a new image version from a snapshot of an OS disk and add additional data disks + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$galleryImageVersionName = "1.0.0" +$location = "eastus" +$osSnapshot = @{Source = @{Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mySnapshotRG/providers/Microsoft.Compute/snapshots/myOSSnapshot" }} +$dataSnapshot0 = @{Source = @{Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mySnapshotRG/providers/Microsoft.Compute/snapshots/myDataSnapshot" }; Lun = 0; } +$dataDisks = @($dataSnapshot0) +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -OSDiskImage $osSnapshot -DataDiskImage $dataDisks +``` + +Create an image version by specifying snapshots for OS and data disks. + +### Example 8: Add a new image version from a combination of disks and snapshots + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$galleryImageVersionName = "1.0.0" +$location = "eastus" +$osSnapshot = @{Source = @{Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mySnapshotRG/providers/Microsoft.Compute/snapshots/myOSSnapshot" }} +$dataDisk0 = @{Source = @{Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myDiskRG/providers/Microsoft.Compute/disks/myDataDisk" }; Lun = 0; } +$dataDisks = @($dataDisk0) +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -OSDiskImage $osSnapshot -DataDiskImage $dataDisks +``` + +Create an image version by specifying a snapshot as an OS disk and a managed disk as a data disk. + +### Example 9: Add a new image version and copy it to additional regions. + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$galleryImageVersionName = "1.0.0" +$location = "eastus" + +$sourceImageId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myVMRG/providers/Microsoft.Compute/virtualMachines/myVM" +$replicaCount = 1 +$storageAccountType = "Standard_ZRS" + +$region_eastus = @{Name = 'East US';ReplicaCount = 3;StorageAccountType = 'Standard_LRS'} +$region_westus = @{Name = 'West US'} +$region_ukwest = @{Name = 'UK West';ReplicaCount = 2} +$region_southcentralus = @{Name = 'South Central US';StorageAccountType = 'Standard_LRS'} + +$targetRegions = @($region_eastus, $region_westus, $region_ukwest, $region_southcentralus) + +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -SourceImageId $sourceImageId -ReplicaCount 1 -StorageAccountType $storageAccountType -TargetRegion $targetRegions +``` + +Create an image version in four regions. In this example, the global replica count is 1 and the global storage account type is Standard_ZRS. East US will have 3 replicas, each stored on Standard_LRS account storage. West US will inherit from global settings and have 1 replica stored on Standard_ZRS. UK West will have a replica count of 2 stored on Standard_ZRS. South Central US will have one replica stored on Standard_LRS. + +### Example 10: Add a new image version with encryption in multiple regions + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$galleryImageVersionName = "1.0.0" +$location = "eastus" +$sourceImageId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myVMRG/providers/Microsoft.Compute/virtualMachines/myVM" +$replicaCount = 1 +$storageAccountType = "Standard_ZRS" + +# East US regional settings +$eastUSdes = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myDESrg/providers/Microsoft.Compute/diskEncryptionSets/myEastUSDES" +$encryption_eastus_os = @{DiskEncryptionSetId = $eastUSdes } +$encryption_eastus_dd0 = @{DiskEncryptionSetId = $eastUSdes; Lun = 0 } +$encryption_eastus_dd = @($encryption_eastus_dd0) +$eastus_encryption = @{OSDiskImage = $eastus_encryption_os; DataDiskImages = $eastus_encryption_dd } +$region_eastus = @{Name = 'East US';ReplicaCount = 3;StorageAccountType = 'Standard_LRS'; Encryption = $encryption_eastus} + +# West US regional settings +$westUS2des = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myDESrg/providers/Microsoft.Compute/diskEncryptionSets/myWestUSDES" +$encryption_westus_os = @{DiskEncryptionSetId = $westUSdes } +$encryption_westus_dd0 = @{DiskEncryptionSetId = $westUSdes; Lun = 0 } +$encryption_westus_dd = @($encryption_westus_dd0) +$westus_encryption = @{OSDiskImage = $encryption_westus_os; DataDiskImages = $encryption_westus_dd } +$region_westus = @{Name = 'West US'; Encryption = $westus_encryption} + +# Create images +$targetRegions = @($region_eastus, $region_westus) +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -SourceImageId $sourceImageId -TargetRegion $targetRegions +``` + +Create an image version with encryption in two regions. Disk encryption sets are regional resources and a different disk encryption set must be used in each region. + +### Example 11: Create an image version and have it excluded from latest + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$galleryImageVersionName = "1.0.0" +$location = "eastus" +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -SourceImageId $sourceImageId -PublishingProfileExcludeFromLatest +``` + +Add a new image version into an image definition but exclude it from being considered for latest version within its image definition. + +### Example 12: Create an image version and set its end-of-life date + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "myImage" +$galleryImageVersionName = "1.0.0" +$location = "eastus" +$endOfLifeDate = "2024-08-02T00:00:00+00:00" +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -SourceImageId $sourceImageId -PublishingProfileEndOfLifeDate $endOfLifeDate +``` + +This example has the end-of-life date for image version set to August 2, 2024 at mignight UTC. End-of-life dates can be specified for both the image definitions and image versions. Image versions can still be used after the end-of-life dates. + +### Example 13: Create an image version for Confidential VM + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "cvmImage" +$galleryImageVersionName = "1.0.0" +$location = "North Europe" + +$sourceImageId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myVMRG/providers/Microsoft.Compute/virtualMachines/myVM" +$cvmDiskEncryptionSetId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myVMRG/providers/Microsoft.Compute/diskEncryptionSets/cvmDiskEncryptionSet" +$dataDiskEncryptionSetId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myVMRG/providers/Microsoft.Compute/diskEncryptionSets/dataDiskEncryptionSet" + +$cvmOsDiskEncryption = @{CVMEncryptionType='EncryptedWithCmk'; CVMDiskEncryptionSetID=$cvmDiskEncryptionSetId} + +$cvmDataDiskEncryption_lun0 = @{DiskEncryptionSetId = $dataDiskEncryptionSetId ; Lun = 0} +$cvmDataDiskEncryption = @($cvmDataDiskEncryption_lun0) + +$cvmEncryption = @{OSDiskImage = $cvmOsDiskEncryption; DataDiskImages = $cvmDataDiskEncryption} +$region_northEurope = @{Name = 'NorthEurope';ReplicaCount = 3;StorageAccountType = 'Standard_LRS'; Encryption = $cvmEncryption} +$targetRegions = @($region_northEurope) + +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -SourceImageId $sourceImageId -ReplicaCount 1 -StorageAccountType "Standard_LRS" -TargetRegion $targetRegions +``` + +In this example, Confidential VM (CVM) Image with Customer Managed Key (CMK) is created under Image definition which supports ConfidentialVM security type. + +### Example 14: Create an image version with a target extended location + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$galleryImageDefinitionName = "cvmImage" +$galleryImageVersionName = "1.0.0" +$location = "EastUs" +$sourceImageId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myVMRG/providers/Microsoft.Compute/virtualMachines/myVM" + +$replicaCount = 1 +$extendedLocation = @{Name = 'microsoftlosangeles1';Type='EdgeZone'} +$edgezone_losangeles = @{Location = "westus";ExtendedLocation=$extendedLocation;ReplicaCount = 3;StorageAccountType = 'StandardSSD_LRS'} +$targetExtendedLocations = @($edgezone_losangeles) + +New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $galleryImageDefinitionName -Name $galleryImageVersionName -Location $location -SourceImageId $sourceImageId -ReplicaCount 1 -StorageAccountType "Standard_LRS" -TargetExtendedLocation $targetExtendedLocations +``` + +This example creates a hashtable for target extended location properties and passes in with -TargetExtendedLocation parameter. + +## PARAMETERS + +### -AsJob + +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataDiskImage + +Data disk images. e.g. @{Source = @{Id = <source_id>}; Lun = 1; SizeInGB = 100; HostCaching = "ReadOnly" } + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.GalleryDataDiskImage[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryImageDefinitionName + +The name of the gallery. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GalleryImageName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryName + +The name of the gallery. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location + +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name + +The name of the gallery image version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GalleryImageVersionName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OSDiskImage + +OS disk image e.g. @{Source = @{Id = <source_id>}; SizeInGB = 100; HostCaching = "ReadOnly" } + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.GalleryOSDiskImage +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublishingProfileEndOfLifeDate + +The end of life date of the gallery Image Version. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublishingProfileExcludeFromLatest + +If it is set, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReplicaCount + +The number of replicas of the Image Version to be created per region. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName + +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceImageId + +The ID of the source image from which the Image Version is going to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountType + +Specifies the storage account type to be used to store the image. This property is not updatable. Available values are Standard_LRS, Standard_ZRS and Premium_LRS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag + +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetExtendedLocation +The target extended locations where the Image Version is going to be replicated to. This property is updatable. + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetRegion + +The target regions where the Image Version is going to be replicated to. + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Int32 + +### System.Management.Automation.SwitchParameter + +### System.DateTime + +### System.Collections.Hashtable[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzHost.md b/azps-10.1.0/Az.Compute/New-AzHost.md new file mode 100644 index 0000000000..bffcea25ee --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzHost.md @@ -0,0 +1,263 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzHost.md +--- + +# New-AzHost + +## SYNOPSIS +Creates a host. + +## SYNTAX + +``` +New-AzHost [-ResourceGroupName] <String> [-HostGroupName] <String> [-Name] <String> [-Location] <String> + -Sku <String> [-PlatformFaultDomain <Int32>] [-AutoReplaceOnFailure <Boolean>] + [-LicenseType <DedicatedHostLicenseTypes>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will create a Host. + +## EXAMPLES + +### Example 1 +```powershell +New-AzHost -ResourceGroupName $resourceGroupName -HostGroupName $hostGroupName -Name $hostName -Location $location -Sku $skuName +``` + +```output +ResourceGroupName : myrg01 +PlatformFaultDomain : 0 +AutoReplaceOnFailure : True +HostId : 00000000-0000-0000-0000-000000000000 +ProvisioningTime : 7/25/2019 8:34:16 PM +ProvisioningState : Succeeded +Sku : + Name : ESv3-Type1 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg01/providers/Microsoft.Compute/hostGroups/myhostgroup01/hosts/myhost01 +Name : myhost01 +Location : eastus +Tags : {"key1":"val2"} +``` + +This command creates a host of the given Sku in the given host group and the given location. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoReplaceOnFailure +Specifies whether the host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostGroupName +Specifies the name of the host group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LicenseType +Specifies the software license type that will be applied to the VMs deployed on the host. Possible values are: None, Windows_Server_Hybrid, and Windows_Server_Perpetual. Default value is None. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.DedicatedHostLicenseTypes +Parameter Sets: (All) +Aliases: +Accepted values: None, WindowsServerHybrid, WindowsServerPerpetual + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the host. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HostName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PlatformFaultDomain +Specifies the number of platform fault domain of the host. Then minimum value is 0 and the maximum value is 2. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Specifies the name of the SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specifies Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSHost + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzHostGroup.md b/azps-10.1.0/Az.Compute/New-AzHostGroup.md new file mode 100644 index 0000000000..5c2d08a939 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzHostGroup.md @@ -0,0 +1,245 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azhostgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzHostGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzHostGroup.md +--- + +# New-AzHostGroup + +## SYNOPSIS +Creates a host group. + +## SYNTAX + +``` +New-AzHostGroup [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + -PlatformFaultDomain <Int32> [-Zone <String[]>] [-SupportAutomaticPlacement <Boolean>] [-Tag <Hashtable>] + [-EnableUltraSSD] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will create a Host group. + +## EXAMPLES + +### Example 1 +```powershell +New-AzHostGroup -ResourceGroupName $resourceGroupName -Name $hostGroupName -Location $location -Zone $zone +``` + +```output +ResourceGroupName : myrg01 +PlatformFaultDomainCount : 2 +Hosts : {/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg01/providers/Microsoft.Compute/hostGroups/myhostgroup01/hosts/myhost01} +Zones : {1} +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg01/providers/Microsoft.Compute/hostGroups/myhostgroup01 +Name : myhostgroup01 +Location : eastus +Tags : {[key1, val1]} +``` + +This command creates a host group in the given location and zone. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUltraSSD +The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. Please refer to https://learn.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the host group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HostGroupName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PlatformFaultDomain +Specifies the number of fault domains that the host group can span. The minimum value is 1 and the maximum value is 3. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SupportAutomaticPlacement +Specifies if HostGroup will enable automatic placement of vm's. +Automatic placement means these VMs are placed on dedicated hosts, chosen by Azure, under the dedicated host group. +If not specified, default value will be false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specifies Tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +Specifies Zones of the host group. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSHostGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzImage.md b/azps-10.1.0/Az.Compute/New-AzImage.md new file mode 100644 index 0000000000..859b6fac1e --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzImage.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzImage.md +--- + +# New-AzImage + +## SYNOPSIS +Creates an image. + +## SYNTAX + +``` +New-AzImage [-ResourceGroupName] <String> [-ImageName] <String> [-Image] <PSImage> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzImage** cmdlet creates an image. + +## EXAMPLES + +### Example 1 +```powershell +$imageConfig = New-AzImageConfig -Location 'West US'; +$osDiskVhdUri = "https://contoso.blob.core.windows.net/test/os.vhd" +$dataDiskVhdUri1 = "https://contoso.blob.core.windows.net/test/data1.vhd" +$dataDiskVhdUri2 = "https://contoso.blob.core.windows.net/test/data2.vhd" +Set-AzImageOsDisk -Image $imageConfig -OsType 'Windows' -OsState 'Generalized' -BlobUri $osDiskVhdUri; +Add-AzImageDataDisk -Image $imageConfig -Lun 1 -BlobUri $dataDiskVhdUri1; +Add-AzImageDataDisk -Image $imageConfig -Lun 2 -BlobUri $dataDiskVhdUri2; +New-AzImage -Image $imageConfig -ImageName 'ImageName01' -ResourceGroupName 'ResourceGroup01'; +``` + +The first command creates an image object, and then stores it in the $imageConfig variable. +The next three commands assign paths of os disk and two data disks to the $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2 variables. +This approach is only for readability of the following commands. +The next three commands each adds an os disk and two data disks to the image stored in $imageConfig. +The URI of each disk is stored in $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2. +The final command creates an image named 'ImageName01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Image +Specifies a local image object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSImage +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ImageName +Specifies the name of an image. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzImageConfig.md b/azps-10.1.0/Az.Compute/New-AzImageConfig.md new file mode 100644 index 0000000000..ab79c566eb --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzImageConfig.md @@ -0,0 +1,236 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azimageconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzImageConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzImageConfig.md +--- + +# New-AzImageConfig + +## SYNOPSIS +Creates a configurable image object. + +## SYNTAX + +``` +New-AzImageConfig [[-Location] <String>] [-EdgeZone <String>] [[-Tag] <Hashtable>] + [[-SourceVirtualMachineId] <String>] [[-OsDisk] <ImageOSDisk>] [-HyperVGeneration <String>] + [-DataDisk <ImageDataDisk[]>] [-ZoneResilient] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzImageConfig** cmdlet creates a configurable image object. + +## EXAMPLES + +### Example 1 +```powershell +$imageConfig = New-AzImageConfig -Location 'West US'; +$osDiskVhdUri = "https://contoso.blob.core.windows.net/test/os.vhd" +$dataDiskVhdUri1 = "https://contoso.blob.core.windows.net/test/data1.vhd" +$dataDiskVhdUri2 = "https://contoso.blob.core.windows.net/test/data2.vhd" +Set-AzImageOsDisk -Image $imageConfig -OsType 'Windows' -OsState 'Generalized' -BlobUri $osDiskVhdUri; +Add-AzImageDataDisk -Image $imageConfig -Lun 1 -BlobUri $dataDiskVhdUri1; +Add-AzImageDataDisk -Image $imageConfig -Lun 2 -BlobUri $dataDiskVhdUri2; +New-AzImage -Image $imageConfig -ImageName 'ImageName01' -ResourceGroupName 'ResourceGroup01'; +``` + +The first command creates an image object, and then stores it in the $imageConfig variable. +The next three commands assign paths of os disk and two data disks to the $osDiskVhdUri, +$dataDiskVhdUri1, and $dataDiskVhdUri2 variables. This approach is only for readability of the +following commands. +The next three commands each adds an os disk and two data disks to the image stored in $imageConfig. +The URI of each disk is stored in $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2. +The final command creates an image named 'ImageName01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -DataDisk +Specifies the data disk object. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.ImageDataDisk[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +Sets the edge zone name. If set, the query will be routed to the specified edgezone instead of the main region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HyperVGeneration +Specifies the HyperVGeneration Type for the virtual machine created from the image. Allowed values are V1 and V2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies a location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsDisk +Specifies the operating system Disk. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.ImageOSDisk +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceVirtualMachineId +Specifies the source virtual machine ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ZoneResilient +Enable zone resilient + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### Microsoft.Azure.Management.Compute.Models.ImageOSDisk + +### Microsoft.Azure.Management.Compute.Models.ImageDataDisk[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzProximityPlacementGroup.md b/azps-10.1.0/Az.Compute/New-AzProximityPlacementGroup.md new file mode 100644 index 0000000000..7bd8ba2c51 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzProximityPlacementGroup.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azproximityplacementgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzProximityPlacementGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzProximityPlacementGroup.md +--- + +# New-AzProximityPlacementGroup + +## SYNOPSIS +Create Proximity Placement Group resource. + +## SYNTAX + +``` +New-AzProximityPlacementGroup [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + [-ProximityPlacementGroupType <String>] [-Tag <Hashtable>] [-AsJob] [-Zone <String[]>] + [-IntentVMSizeList <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will create Proximity Placement Group resource. + +## EXAMPLES + +### Example 1 +```powershell +New-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName -Name $proximityPlacementGroupName -Location $location -Tag @{key1 = "val1"} +``` + +```output +ResourceGroupName : rg0 +ProximityPlacementGroupType : Standard +Id : /subscriptions/5393f919-a68a-43d0-9063-4b2bda6bffdf/resourceGroups/rg0/providers/Microsoft.Compute/proximityPlacementGroups/ppg0 +Name : ppg0 +Type : Microsoft.Compute/proximityPlacementGroups +Location : westcentralus +Tags : {"key1":"val1"} +``` + +This command creates a proximity place group in the given location. + +### Example 2 + +Create Proximity Placement Group resource. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzProximityPlacementGroup -Location westus -Name 'AgentPool01' -ProximityPlacementGroupType <String> -ResourceGroupName myresourcegroup +``` + +### Example 3 +```powershell +$ResourceGroupName = <Resource Group Name> +$PPGName = <PPG Name> +$Location = <Azure Region> +# Use the VM Sizes and Zone that you want to use for the Zone and IntentVMSizeList parameters. +New-AzProximityPlacementGroup -ResourceGroupName $ResourceGroupName -Name $PPGName -Location $Location -Zone '1' -IntentVMSizeList 'Standard_D4d_v4', 'Standard_D4d_v5'; +$ppg = Get-AzProximityPlacementGroup -ResourceGroupName $ResourceGroupName -Name $PPGName; + +# View the new values at $ppg.Intent.VmSizes[0], $ppg.Intent.VmSizes[1], and $ppg.Zones[0]. +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntentVMSizeList +Specifies possible sizes of virtual machines that can be created in the proximity placement group. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the proximity placement group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ProximityPlacementGroupName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProximityPlacementGroupType +Specifies the type of the proximity placement group. Possible values are: Standard or Ultra + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSProximityPlacementGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzRestorePoint.md b/azps-10.1.0/Az.Compute/New-AzRestorePoint.md new file mode 100644 index 0000000000..020c3b15de --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzRestorePoint.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azrestorepoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzRestorePoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzRestorePoint.md +--- + +# New-AzRestorePoint + +## SYNOPSIS +This cmdlet can create a New Restore Point + +## SYNTAX + +``` +New-AzRestorePoint [-ResourceGroupName] <String> [-RestorePointCollectionName] <String> [-Name] <String> + [[-Location] <String>] [-RestorePointId <String>] [-DisksToExclude <String[]>] [-ConsistencyMode <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create's a new Restore Point + +## EXAMPLES + +### Example 1 +```powershell +New-AzRestorePoint -ResourceGroupName "myRG" -RestorePointCollectionName "myCollection" -Name "myRestorePoint" -ConsistencyMode "CrashConsistent" +``` + +Creates a new Restore Point + +## PARAMETERS + +### -ConsistencyMode +ConsistencyMode of the restore point. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisksToExclude +List of disk resource Id values that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Set the region of the restore point + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the restore point + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RestorePointName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name this resource belongs to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestorePointCollectionName +Name of the restore point collection this restore point is part of + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestorePointId +ARM Id of the source restore point + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSRestorePoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzRestorePointCollection.md b/azps-10.1.0/Az.Compute/New-AzRestorePointCollection.md new file mode 100644 index 0000000000..96c112e9be --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzRestorePointCollection.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azrestorepointcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzRestorePointCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzRestorePointCollection.md +--- + +# New-AzRestorePointCollection + +## SYNOPSIS +Creates a New Restore Point Collection + +## SYNTAX + +### DefaultParameter (Default) +``` +New-AzRestorePointCollection [-ResourceGroupName] <String> [-Name] <String> [-VmId] <String> + [-Location <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RestorePointCollectionId +``` +New-AzRestorePointCollection [-ResourceGroupName] <String> [-Name] <String> [[-VmId] <String>] + [-RestorePointCollectionId] <String> -Location <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a New Restore Point Collection + +## EXAMPLES + +### Example 1 +```powershell +New-AzRestorePointCollection -ResourceGroupName <String> -Name <String> -VmId <String> +``` + +Create a new Restore Point Collection using a VM Id. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +location of the source resource used to create this restore point collection. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: RestorePointCollectionId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RestorePointCollectionName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestorePointCollectionId +ARM Id of Source RestorePoint Collection + +```yaml +Type: System.String +Parameter Sets: RestorePointCollectionId +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VmId +resource Id of the source resource used to create this restore point Collection + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: RestorePointCollectionId +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSRestorePointCollection + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzSnapshot.md b/azps-10.1.0/Az.Compute/New-AzSnapshot.md new file mode 100644 index 0000000000..fc7e33dda9 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzSnapshot.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azsnapshot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzSnapshot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzSnapshot.md +--- + +# New-AzSnapshot + +## SYNOPSIS +Creates a snapshot. + +## SYNTAX + +``` +New-AzSnapshot [-ResourceGroupName] <String> [-SnapshotName] <String> [-Snapshot] <PSSnapshot> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSnapshot** cmdlet creates a snapshot. + +## EXAMPLES + +### Example 1 +```powershell +$snapshotconfig = New-AzSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType Standard_LRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$snapshotconfig = Set-AzSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$snapshotconfig = Set-AzSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +New-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; +``` + +The first command creates a local empty snapshot object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. +The second and third commands set the disk encryption key and key encryption key settings for the snapshot object. +The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Snapshot +Specifies a local snapshot object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SnapshotName +Specifies the name of a snapshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzSnapshotConfig.md b/azps-10.1.0/Az.Compute/New-AzSnapshotConfig.md new file mode 100644 index 0000000000..f7ebd03cf6 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzSnapshotConfig.md @@ -0,0 +1,529 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azsnapshotconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzSnapshotConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzSnapshotConfig.md +--- + +# New-AzSnapshotConfig + +## SYNOPSIS +Creates a configurable snapshot object. + +## SYNTAX + +``` +New-AzSnapshotConfig [[-SkuName] <String>] [[-OsType] <OperatingSystemTypes>] [[-DiskSizeGB] <Int32>] + [[-Location] <String>] [-EdgeZone <String>] [-HyperVGeneration <String>] [-Incremental] [-Tag <Hashtable>] + [-CreateOption <String>] [-StorageAccountId <String>] [-PurchasePlan <PSPurchasePlan>] + [-SupportsHibernation <Boolean>] [-ImageReference <ImageDiskReference>] [-SourceUri <String>] + [-SourceResourceId <String>] [-EncryptionSettingsEnabled <Boolean>] + [-DiskEncryptionKey <KeyVaultAndSecretReference>] [-KeyEncryptionKey <KeyVaultAndKeyReference>] + [-DiskEncryptionSetId <String>] [-EncryptionType <String>] [-DiskAccessId <String>] + [-NetworkAccessPolicy <String>] [-PublicNetworkAccess <String>] [-AcceleratedNetwork <Boolean>] + [-DataAccessAuthMode <String>] [-Architecture <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSnapshotConfig** cmdlet creates a configurable snapshot object. + +## EXAMPLES + +### Example 1 +```powershell +$snapshotconfig = New-AzSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$snapshotconfig = Set-AzSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$snapshotconfig = Set-AzSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +New-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; +``` + +The first command creates a local empty snapshot object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. +The second and third commands set the disk encryption key and key encryption key settings for the snapshot object. +The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. + +### Example 2 + +Creates a configurable snapshot object. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzSnapshotConfig -CreateOption Empty -Location 'Central US' -SourceUri 'https://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd' +``` + +## PARAMETERS + +### -AcceleratedNetwork +True if the image from which the OS disk is created supports accelerated networking. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Architecture +CPU architecture supported by an OS disk. Possible values are "X64" and "Arm64". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CreateOption +Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, creates an empty disk, or attaches an existing disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataAccessAuthMode +Additional authentication requirements when exporting or uploading to a disk or snapshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskAccessId +Gets or sets ARM id of the DiskAccess resource for using private endpoints on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionKey +Specifies the disk encryption key object on a snapshot. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of the disk encryption set to use for enabling encryption at rest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskSizeGB +Specifies the size of the disk in GB. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EdgeZone +Sets the edge zone name. If set, the query will be routed to the specified edgezone instead of the main region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptionSettingsEnabled +Enable encryption settings. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptionType +The type of key used to encrypt the data of the disk. Available values are: 'EncryptionAtRestWithPlatformKey', 'EncryptionAtRestWithCustomerKey' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HyperVGeneration +The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Allowed values are V1 and V2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ImageReference +Specifies the image reference on a snapshot. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.ImageDiskReference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Incremental +Specifies an incremental snapshot. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyEncryptionKey +Specifies the Key encryption key on a snapshot. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies a location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkAccessPolicy +Network access policy defines the network access policy. +Possible values include: 'AllowAll', 'AllowPrivate', 'DenyAll' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsType +Specifies the OS type. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes] +Parameter Sets: (All) +Aliases: +Accepted values: Windows, Linux + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Policy for controlling export on the disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PurchasePlan +Sets the purchase plan for the snapshot. Used for establishing the purchase context of any 3rd Party artifact through Marketplace. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSPurchasePlan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuName +Specifies the Sku name of the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountType + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceResourceId +Specifies the source resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceUri +Specifies the source Uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountId +Specifies the storage account ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SupportsHibernation +Indicates if the OS on the snapshot supports hibernation with $true or $false + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Int32 + +### System.Collections.Hashtable + +### Microsoft.Azure.Management.Compute.Models.ImageDiskReference + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference + +### Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzSnapshotUpdateConfig.md b/azps-10.1.0/Az.Compute/New-AzSnapshotUpdateConfig.md new file mode 100644 index 0000000000..85fb841055 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzSnapshotUpdateConfig.md @@ -0,0 +1,357 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azsnapshotupdateconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzSnapshotUpdateConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzSnapshotUpdateConfig.md +--- + +# New-AzSnapshotUpdateConfig + +## SYNOPSIS +Creates a configurable snapshot update object. + +## SYNTAX + +``` +New-AzSnapshotUpdateConfig [[-SkuName] <String>] [[-OsType] <OperatingSystemTypes>] [[-DiskSizeGB] <Int32>] + [[-Tag] <Hashtable>] [-SupportsHibernation <Boolean>] [-EncryptionSettingsEnabled <Boolean>] + [-DiskEncryptionKey <KeyVaultAndSecretReference>] [-EdgeZone <String>] + [-KeyEncryptionKey <KeyVaultAndKeyReference>] [-DiskEncryptionSetId <String>] [-EncryptionType <String>] + [-PublicNetworkAccess <String>] [-DataAccessAuthMode <String>] [-Architecture <String>] + [-NetworkAccessPolicy <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSnapshotUpdateConfig** cmdlet creates a configurable snapshot update object. + +## EXAMPLES + +### Example 1 +```powershell +$snapshotupdateconfig = New-AzSnapshotUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$snapshotupdateconfig = Set-AzSnapshotUpdateDiskEncryptionKey -SnapshotUpdate $snapshotupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$snapshotupdateconfig = Set-AzSnapshotUpdateKeyEncryptionKey -SnapshotUpdate $snapshotupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +Update-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -SnapshotUpdate $snapshotupdateconfig; +``` + +The first command creates a local empty snapshot update object with size 10GB in Premium_LRS +storage account type. It also sets Windows OS type and enables encryption settings. The second and +third commands set the disk encryption key and key encryption key settings for the snapshot update +object. The last command takes the snapshot update object and updates an existing snapshot with +name 'Snapshot01' in resource group 'ResourceGroup01'. + +### Example 2 +```powershell +New-AzSnapshotUpdateConfig -DiskSizeGB 10 | Update-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01'; +``` + +This command updates an existing snapshot with name 'Snapshot01' in resource group +'ResourceGroup01' to 10 GB disk size. + +## PARAMETERS + +### -Architecture +CPU architecture supported by an OS disk. Possible values are "X64" and "Arm64". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataAccessAuthMode +Additional authentication requirements when exporting or uploading to a disk or snapshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionKey +Specifies the disk encryption key object on a snapshot. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of the disk encryption set to use for enabling encryption at rest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskSizeGB +Specifies the size of the disk in GB. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EdgeZone +Sets the edge zone name. If set, the query will be routed to the specified edgezone instead of the main region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptionSettingsEnabled +Enable encryption settings. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptionType +The type of key used to encrypt the data of the disk. Available values are: 'EncryptionAtRestWithPlatformKey', 'EncryptionAtRestWithCustomerKey' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyEncryptionKey +Specifies the Key encryption key on a snapshot. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkAccessPolicy +Policy for accessing the disk via network. Available values are: AllowAll, AllowPrivate, DeyAll + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsType +Specifies the OS type. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes] +Parameter Sets: (All) +Aliases: +Accepted values: Windows, Linux + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Policy for controlling export on the disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuName +Specifies the Sku name of the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountType + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SupportsHibernation +Indicates if the OS on the snapshot supports hibernation with $true or $false + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Int32 + +### System.Collections.Hashtable + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference + +### Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzSshKey.md b/azps-10.1.0/Az.Compute/New-AzSshKey.md new file mode 100644 index 0000000000..f4039c91d7 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzSshKey.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azsshkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzSshKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzSshKey.md +--- + +# New-AzSshKey + +## SYNOPSIS +Create a SSH Public Key resource. + +## SYNTAX + +``` +New-AzSshKey -ResourceGroupName <String> -Name <String> [-PublicKey <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a SSH Public Key resource. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSshKey -ResourceGroupName "testRG" -Name "sshkey1" -PublicKey $publicKey +``` + +Creating a SSH Key resource with provided a public key. + +### Example 2 +```powershell +New-AzSshKey -ResourceGroupName "testRG" -Name "sshkey1" +``` + +Creating a SSH Key resource without providing a public key. A key pair will be generated and saved in ~\.ssh. The public key will also be saved in the SSH Key resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Ssh Public Key resource to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: sshkeyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PublicKey +Public Key value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSshPublicKeyResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzVM.md b/azps-10.1.0/Az.Compute/New-AzVM.md new file mode 100644 index 0000000000..cc3a0303ec --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzVM.md @@ -0,0 +1,1341 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 05E6155D-4F0E-406B-9312-77AD97EF66EE +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVM.md +--- + +# New-AzVM + +## SYNOPSIS +Creates a virtual machine. + +## SYNTAX + +### SimpleParameterSet (Default) +``` +New-AzVM [[-ResourceGroupName] <String>] [[-Location] <String>] [-EdgeZone <String>] [[-Zone] <String[]>] + [-PublicIpSku <String>] -Name <String> -Credential <PSCredential> [-NetworkInterfaceDeleteOption <String>] + [-VirtualNetworkName <String>] [-AddressPrefix <String>] [-SubnetName <String>] + [-SubnetAddressPrefix <String>] [-PublicIpAddressName <String>] [-DomainNameLabel <String>] + [-AllocationMethod <String>] [-SecurityGroupName <String>] [-OpenPorts <Int32[]>] [-Image <String>] + [-Size <String>] [-AvailabilitySetName <String>] [-SystemAssignedIdentity] [-UserAssignedIdentity <String>] + [-AsJob] [-OSDiskDeleteOption <String>] [-DataDiskSizeInGb <Int32[]>] [-DataDiskDeleteOption <String>] + [-EnableUltraSSD] [-ProximityPlacementGroupId <String>] [-HostId <String>] [-VmssId <String>] + [-Priority <String>] [-EvictionPolicy <String>] [-MaxPrice <Double>] [-EncryptionAtHost] + [-HostGroupId <String>] [-SshKeyName <String>] [-GenerateSshKey] [-CapacityReservationGroupId <String>] + [-UserData <String>] [-ImageReferenceId <String>] [-PlatformFaultDomain <Int32>] [-HibernationEnabled] + [-vCPUCountAvailable <Int32>] [-vCPUCountPerCore <Int32>] [-DiskControllerType <String>] + [-SharedGalleryImageId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DefaultParameterSet +``` +New-AzVM [-ResourceGroupName] <String> [-Location] <String> [-EdgeZone <String>] [-VM] <PSVirtualMachine> + [[-Zone] <String[]>] [-DisableBginfoExtension] [-Tag <Hashtable>] [-LicenseType <String>] [-AsJob] + [-OSDiskDeleteOption <String>] [-DataDiskDeleteOption <String>] [-SshKeyName <String>] [-GenerateSshKey] + [-vCPUCountAvailable <Int32>] [-vCPUCountPerCore <Int32>] [-DisableIntegrityMonitoring] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DiskFileParameterSet +``` +New-AzVM [[-ResourceGroupName] <String>] [[-Location] <String>] [-EdgeZone <String>] [-PublicIpSku <String>] + -Name <String> [-NetworkInterfaceDeleteOption <String>] [-VirtualNetworkName <String>] + [-AddressPrefix <String>] [-SubnetName <String>] [-SubnetAddressPrefix <String>] + [-PublicIpAddressName <String>] [-DomainNameLabel <String>] [-AllocationMethod <String>] + [-SecurityGroupName <String>] [-OpenPorts <Int32[]>] -DiskFile <String> [-Linux] [-Size <String>] + [-AvailabilitySetName <String>] [-SystemAssignedIdentity] [-UserAssignedIdentity <String>] [-AsJob] + [-OSDiskDeleteOption <String>] [-DataDiskSizeInGb <Int32[]>] [-DataDiskDeleteOption <String>] + [-EnableUltraSSD] [-ProximityPlacementGroupId <String>] [-HostId <String>] [-VmssId <String>] + [-Priority <String>] [-EvictionPolicy <String>] [-MaxPrice <Double>] [-EncryptionAtHost] + [-HostGroupId <String>] [-CapacityReservationGroupId <String>] [-UserData <String>] + [-PlatformFaultDomain <Int32>] [-HibernationEnabled] [-vCPUCountAvailable <Int32>] [-vCPUCountPerCore <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVM** cmdlet creates a virtual machine in Azure. +This cmdlet takes a virtual machine object as input. The **New-AzVM** cmdlet will create a new storage account for boot diagnostics if one does not already exist. <br> <br> +Use the **[New-AzVMConfig](https://learn.microsoft.com/en-us/powershell/module/az.compute/new-azvmconfig)** cmdlet to create a virtual machine object. <br> +Then use the following cmdlets to set different properties of the virtual machine object: +- **[Add-AzVMNetworkInterface](https://learn.microsoft.com/en-us/powershell/module/az.compute/add-azvmnetworkinterface)** to set the network profile.<br> +- **[Set-AzVMOperatingSystem](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmoperatingsystem)** to set the OS profile. <br> +- **[Set-AzVMSourceImage](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmsourceimage)** to set the source image.<br> +- **[Set-AzVMOSDisk](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmosdisk)** to set the OS disk(storage profile).<br> +- **[Get-AzComputeResourceSku](https://learn.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku)** can also be used to find out available virtual machine sizes for your subscription and region.<br> +<br> +The `SimpleParameterSet` provides a convenient method to create a VM by making common VM creation arguments optional.<br> +<br> +See [Quickstart: Create a Windows virtual machine in Azure with PowerShell](https://learn.microsoft.com/en-us/azure/virtual-machines/windows/quick-create-powershell) for tutorial. <br> + +## EXAMPLES + +### Example 1: Create a virtual machine +```powershell +New-AzVM -Name MyVm -Credential (Get-Credential) +``` + +```output +VERBOSE: Use 'mstsc /v:myvm-222222.eastus.cloudapp.azure.com' to connect to the VM. + +ResourceGroupName : MyVm +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyVm/provi +ders/Microsoft.Compute/virtualMachines/MyVm +VmId : 11111111-1111-1111-1111-111111111111 +Name : MyVm +Type : Microsoft.Compute/virtualMachines +Location : eastus +Tags : {} +HardwareProfile : {VmSize} +NetworkProfile : {NetworkInterfaces} +OSProfile : {ComputerName, AdminUsername, WindowsConfiguration, Secrets} +ProvisioningState : Succeeded +StorageProfile : {ImageReference, OsDisk, DataDisks} +FullyQualifiedDomainName : myvm-222222.eastus.cloudapp.azure.com +``` + +This example script shows how to create a virtual machine. +The script will ask a user name and password for the VM. +This script uses several other cmdlets. + +### Example 2: Create a virtual machine from a custom user image +```powershell +## VM Account +# Credentials for Local Admin account you created in the sysprepped (generalized) vhd image +$VMLocalAdminUser = "LocalAdminUser" +$VMLocalAdminSecurePassword = ConvertTo-SecureString "Password" -AsPlainText -Force +## Azure Account +$LocationName = "westus" +$ResourceGroupName = "MyResourceGroup" +# This a Premium_LRS storage account. +# It is required in order to run a client VM with efficiency and high performance. +$StorageAccount = "Mydisk" + +## VM +$OSDiskName = "MyClient" +$ComputerName = "MyClientVM" +$OSDiskUri = "https://Mydisk.blob.core.windows.net/disks/MyOSDisk.vhd" +$SourceImageUri = "https://Mydisk.blob.core.windows.net/vhds/MyOSImage.vhd" +$VMName = "MyVM" +# Modern hardware environment with fast disk, high IOPs performance. +# Required to run a client VM with efficiency and performance +$VMSize = "Standard_DS3" +$OSDiskCaching = "ReadWrite" +$OSCreateOption = "FromImage" + +## Networking +$DNSNameLabel = "mydnsname" # mydnsname.westus.cloudapp.azure.com +$NetworkName = "MyNet" +$NICName = "MyNIC" +$PublicIPAddressName = "MyPIP" +$SubnetName = "MySubnet" +$SubnetAddressPrefix = "10.0.0.0/24" +$VnetAddressPrefix = "10.0.0.0/16" + +$SingleSubnet = New-AzVirtualNetworkSubnetConfig -Name $SubnetName -AddressPrefix $SubnetAddressPrefix +$Vnet = New-AzVirtualNetwork -Name $NetworkName -ResourceGroupName $ResourceGroupName -Location $LocationName -AddressPrefix $VnetAddressPrefix -Subnet $SingleSubnet +$PIP = New-AzPublicIpAddress -Name $PublicIPAddressName -DomainNameLabel $DNSNameLabel -ResourceGroupName $ResourceGroupName -Location $LocationName -AllocationMethod Dynamic +$NIC = New-AzNetworkInterface -Name $NICName -ResourceGroupName $ResourceGroupName -Location $LocationName -SubnetId $Vnet.Subnets[0].Id -PublicIpAddressId $PIP.Id + +$Credential = New-Object System.Management.Automation.PSCredential ($VMLocalAdminUser, $VMLocalAdminSecurePassword); + +$VirtualMachine = New-AzVMConfig -VMName $VMName -VMSize $VMSize +$VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName $ComputerName -Credential $Credential -ProvisionVMAgent -EnableAutoUpdate +$VirtualMachine = Add-AzVMNetworkInterface -VM $VirtualMachine -Id $NIC.Id +$VirtualMachine = Set-AzVMOSDisk -VM $VirtualMachine -Name $OSDiskName -VhdUri $OSDiskUri -SourceImageUri $SourceImageUri -Caching $OSDiskCaching -CreateOption $OSCreateOption -Windows + +New-AzVM -ResourceGroupName $ResourceGroupName -Location $LocationName -VM $VirtualMachine -Verbose -Zone @("1") +``` + +This example takes an existing sys-prepped, generalized custom operating system image and attaches a data disk to it, provisions a new network, deploys the VHD, and runs it. +This script can be used for automatic provisioning because it uses the local virtual machine admin credentials inline instead of calling **Get-Credential** which requires user interaction. +This script assumes that you are already logged into your Azure account. +You can confirm your login status by using the **Get-AzSubscription** cmdlet. + +### Example 3: Create a VM from a marketplace image without a Public IP +```powershell +$VMLocalAdminUser = "LocalAdminUser" +$VMLocalAdminSecurePassword = ConvertTo-SecureString "password" -AsPlainText -Force +$LocationName = "westus" +$ResourceGroupName = "MyResourceGroup" +$ComputerName = "MyVM" +$VMName = "MyVM" +$VMSize = "Standard_DS3" + +$NetworkName = "MyNet" +$NICName = "MyNIC" +$SubnetName = "MySubnet" +$SubnetAddressPrefix = "10.0.0.0/24" +$VnetAddressPrefix = "10.0.0.0/16" + +$SingleSubnet = New-AzVirtualNetworkSubnetConfig -Name $SubnetName -AddressPrefix $SubnetAddressPrefix +$Vnet = New-AzVirtualNetwork -Name $NetworkName -ResourceGroupName $ResourceGroupName -Location $LocationName -AddressPrefix $VnetAddressPrefix -Subnet $SingleSubnet +$NIC = New-AzNetworkInterface -Name $NICName -ResourceGroupName $ResourceGroupName -Location $LocationName -SubnetId $Vnet.Subnets[0].Id + +$Credential = New-Object System.Management.Automation.PSCredential ($VMLocalAdminUser, $VMLocalAdminSecurePassword); + +$VirtualMachine = New-AzVMConfig -VMName $VMName -VMSize $VMSize +$VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName $ComputerName -Credential $Credential -ProvisionVMAgent -EnableAutoUpdate +$VirtualMachine = Add-AzVMNetworkInterface -VM $VirtualMachine -Id $NIC.Id +$VirtualMachine = Set-AzVMSourceImage -VM $VirtualMachine -PublisherName 'MicrosoftWindowsServer' -Offer 'WindowsServer' -Skus '2022-datacenter-azure-edition-core' -Version latest + +New-AzVM -ResourceGroupName $ResourceGroupName -Location $LocationName -VM $VirtualMachine -Verbose +``` + +This command creates a VM from a marketplace image without a Public IP. + +### Example 4: Create a VM with a UserData value: +```powershell +## VM Account +$VMLocalAdminUser = "LocalAdminUser"; +$VMLocalAdminSecurePassword = ConvertTo-SecureString "Password" -AsPlainText -Force; + +## Azure Account +$LocationName = "eastus"; +$ResourceGroupName = "MyResourceGroup"; + +# VM Profile & Hardware +$VMName = 'v' + $ResourceGroupName; +$domainNameLabel = "d1" + $ResourceGroupName; +$Credential = New-Object System.Management.Automation.PSCredential ($VMLocalAdminUser, $VMLocalAdminSecurePassword); + +# Create UserData value +$text = "text for UserData"; +$bytes = [System.Text.Encoding]::Unicode.GetBytes($text); +$userData = [Convert]::ToBase64String($bytes); + +# Create VM +New-AzVM -ResourceGroupName $ResourceGroupName -Name $VMName -Credential $cred -DomainNameLabel $domainNameLabel -UserData $userData; +$vm = Get-AzVM -ResourceGroupName $ResourceGroupName -Name $VMName -UserData; +``` + +The UserData value must always be Base64 encoded. + +### Example 5: Creating a new VM with an existing subnet in another resource group +```powershell +$UserName = "User" +$Password = ConvertTo-SecureString "############" -AsPlainText -Force +$psCred = New-Object System.Management.Automation.PSCredential($UserName, $Password) + +$Vnet = $(Get-AzVirtualNetwork -ResourceGroupName ResourceGroup2 -Name VnetName) +$PIP = (Get-AzPublicIpAddress -ResourceGroupName ResourceGroup2 -Name PublicIPName) + +$NIC = New-AzNetworkInterface -Name NICname -ResourceGroupName ResourceGroup2 -Location SouthCentralUS -SubnetId $Vnet.Subnets[1].Id -PublicIpAddressId $PIP.Id +$VirtualMachine = New-AzVMConfig -VMName VirtualMachineName -VMSize Standard_D4s_v3 +$VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName computerName -Credential $psCred -ProvisionVMAgent -EnableAutoUpdate +$VirtualMachine = Add-AzVMNetworkInterface -VM $VirtualMachine -Id $NIC.Id +$VirtualMachine = Set-AzVMSourceImage -VM $VirtualMachine -PublisherName 'MicrosoftWindowsServer' -Offer 'WindowsServer' -Skus '2022-datacenter-azure-edition-core' -Version latest +New-AzVM -ResourceGroupName ResourceGroup1 -Location SouthCentralUS -VM $VirtualMachine +``` + +This example deploys a Windows VM from the marketplace in one resource group with an existing subnet in another resource group. + +### Example 6: Creating a new VM as part of a VMSS with a PlatformFaultDomain value. +```powershell +$resourceGroupName= "Resource Group Name" +$domainNameLabel = "Domain Name Label Name" +$vmname = "Virtual Machine Name" +$platformFaultDomainVMDefaultSet = 2 +$securePassword = "Password" | ConvertTo-SecureString -AsPlainText -Force +$user = "Username" +$cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword) +$vmssName = "Vmss Name"; + +$vmssConfig = New-AzVmssConfig -Location $loc -PlatformFaultDomainCount $vmssFaultDomain; +$vmss = New-AzVmss -ResourceGroupName $resourceGroupName -Name $vmssName -VirtualMachineScaleSet $vmssConfig; + +$vm = New-AzVM -ResourceGroupName $resourceGroupName -Name $vmname -Credential $cred -DomainNameLabel $domainNameLabel -PlatformFaultDomain $platformFaultDomainVMDefaultSet -VmssId $vmss.Id +``` + +This example creates a new VM as part of a VMSS with a PlatformFaultDomain value. + +### Example 7: Creating a new VM with the GuestAttestation extension installed by default, then recreating the VM with DisableIntegrityMonitoring to prevent this. +``` +$rgname = <RESOURCE GROUP NAME>; +$loc = <AZURE REGION>; +New-AzResourceGroup -Name $rgname -Location $loc -Force; + +# VM Profile & Hardware +$vmname = 'vm' + $rgname; +$domainNameLabel = "d1" + $rgname; +$vnetname = "myVnet"; +$vnetAddress = "10.0.0.0/16"; +$subnetname = "slb" + $rgname; +$subnetAddress = "10.0.2.0/24"; +$OSDiskName = $vmname + "-osdisk"; +$NICName = $vmname+ "-nic"; +$NSGName = $vmname + "-NSG"; +$OSDiskSizeinGB = 128; +$VMSize = "Standard_DS2_v2"; +$PublisherName = "MicrosoftWindowsServer"; +$Offer = "WindowsServer"; +$SKU = "2019-DATACENTER-GENSECOND"; +$securityType = "TrustedLaunch"; +$secureboot = $true; +$vtpm = $true; + +# Default extension and identity values. +$extDefaultName = "GuestAttestation"; +$vmGADefaultIDentity = "SystemAssigned"; + +# Credential +$password = <PASSWORD>; +$securePassword = $password | ConvertTo-SecureString -AsPlainText -Force; +$user = <USER NAME>; +$cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword); + +# Network resources +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name $subnetname -AddressPrefix $subnetAddress; +$vnet = New-AzVirtualNetwork -Name $vnetname -ResourceGroupName $rgname -Location $loc -AddressPrefix $vnetAddress -Subnet $frontendSubnet; +$nsgRuleRDP = New-AzNetworkSecurityRuleConfig -Name RDP -Protocol Tcp -Direction Inbound -Priority 1001 -SourceAddressPrefix * -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 -Access Allow; +$nsg = New-AzNetworkSecurityGroup -ResourceGroupName $RGName -Location $loc -Name $NSGName -SecurityRules $nsgRuleRDP; +$nic = New-AzNetworkInterface -Name $NICName -ResourceGroupName $RGName -Location $loc -SubnetId $vnet.Subnets[0].Id -NetworkSecurityGroupId $nsg.Id -EnableAcceleratedNetworking; + +# VM creation +$vmConfig = New-AzVMConfig -VMName $vmName -VMSize $VMSize; +Set-AzVMOperatingSystem -VM $vmConfig -Windows -ComputerName $vmName -Credential $cred; +Set-AzVMSourceImage -VM $vmConfig -PublisherName $PublisherName -Offer $Offer -Skus $SKU -Version latest; +Add-AzVMNetworkInterface -VM $vmConfig -Id $nic.Id; +$vmConfig = Set-AzVMSecurityProfile -VM $vmConfig -SecurityType $securityType; +$vmConfig = Set-AzVMUefi -VM $vmConfig -EnableVtpm $vtpm -EnableSecureBoot $secureboot; +New-AzVM -ResourceGroupName $RGName -Location $loc -VM $vmConfig; + +# Verify values +$vm = Get-AzVM -ResourceGroupName $rgname -Name $vmName; +$vmExt = Get-AzVMExtension -ResourceGroupName $rgname -VMName $vmName -Name $extDefaultName; +# Check the default extension has been installed, and the Identity.Type defaulted to SystemAssigned. +# $vmExt.Name +# $vm.Identity.Type + +# Use the DisableIntegrityMonitoring parameter +Remove-AzVM -ResourceGroupName $rgname -Name $vmname -Force; +New-AzVM -ResourceGroupName $rgname -Location $loc -VM $vmConfig -DisableIntegrityMonitoring; +# This VM does not have the Guest Attestation extension installed on it, and the Identity is not set to SystemAssigned by default. +``` + +This example creates a new VM with the GuestAttestation extension installed by default, then recreating the VM with DisableIntegrityMonitoring to prevent this. + +### Example 8: Create a VM using the -Image alias. +```powershell +$resourceGroupName= "<Resource Group Name>" +$loc = "<Azure Region>" +$domainNameLabel = "<Domain Name Label>" +$vmname = "<Virtual Machine Name>" +$securePassword = "<Password>" | ConvertTo-SecureString -AsPlainText -Force +$user = "<Username>" +$cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword) + +New-AzResourceGroup -Name $rgname -Location $loc -Force + +# Create a VM using an Image alias. +$vmname = 'v' + $rgname +$domainNameLabel = "d" + $rgname +$vm = New-AzVM -ResourceGroupName $rgname -Name $vmname -Credential $cred -Image OpenSuseLeap154Gen2 -DomainNameLabel $domainNameLabel + +$vm = Get-AzVM -ResourceGroupName $rgname -Name $vmname +``` + +This example creates a new VM using the -Image parameter, providing many default values to the VM. + +### Example 9: Creating a VM for Trusted Launch SecurityType. +```powershell +$rgname = <Resource Group Name>; +$loc = "eastus"; + +New-AzResourceGroup -Name $rgname -Location $loc -Force; +# VM Profile & Hardware +$domainNameLabel1 = 'd1' + $rgname; +$vmsize = 'Standard_D4s_v3'; +$vmname1 = 'v' + $rgname; +$imageName = "Win2016DataCenterGenSecond"; +$disable = $false; +$enable = $true; +$securityType = "TrustedLaunch"; + +$password = <Password>; +$securePassword = $password | ConvertTo-SecureString -AsPlainText -Force; +$user = <Username>; +$cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword); + +# VM creation using Simple parameterset +New-AzVM -ResourceGroupName $rgname -Location $loc -Name $vmname1 -Credential $cred -Size $vmsize -Image $imageName -DomainNameLabel $domainNameLabel1 -SecurityType $securityType; +$vm1 = Get-AzVM -ResourceGroupName $rgname -Name $vmname1; + +# Verify Values +#$vm1.SecurityProfile.SecurityType "TrustedLaunch"; +#$vm1.SecurityProfile.UefiSettings.VTpmEnabled $true; +#$vm1.SecurityProfile.UefiSettings.SecureBootEnabled $true; + +# Verify the GuestAttestation extension is installed. +$vm = Get-AzVM -ResourceGroupName $rgname -Name $vmname1; +$extDefaultName = "GuestAttestation"; +$vmExt = Get-AzVMExtension -ResourceGroupName $rgname -VMName $vmname1 -Name $extDefaultName; +# $vmExt.Name "GuestAttestation"; +``` + +This example Creates a new VM with the TrustedLaunch Security Type and sets flags EnableSecureBoot and EnableVtpm as True by default. +It also checks that the GuestAttestation extension is installed by default when using TrustedLaunch and the EnableSecureBoot and EnableVtpm are True. + +## PARAMETERS + +### -AddressPrefix +The address prefix for the virtual network which will be created for the VM. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: 192.168.0.0/16 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllocationMethod +The IP allocation method for the public IP which will be created for the VM. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: +Accepted values: Static, Dynamic + +Required: False +Position: Named +Default value: Static +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilitySetName +Specifies a name for the availability set. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapacityReservationGroupId +Id of the capacity reservation Group that is used to allocate. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The administrator credentials for the VM. <br><br> +**Username** <br> +**Restriction:** <br> +Windows: Cannot contain special characters \/""[]:|<>+=;,?*@& or end in \".\" <br> +Linux: Username must only contain letters, numbers, hyphens, and underscores and may not start with a hyphen or number. <br> +**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\". <br> +**Minimum-length:** 1 character <br> +**Max-length:** 20 characters for Windows, 64 characters for Linux <br><br> +**Password** <br> +Must have 3 of the following: 1 lower case character, 1 upper case character, 1 number, and 1 special character. <br> +The value must be between 12 and 123 characters long. + + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: SimpleParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataDiskDeleteOption +Specifies Data Disk delete option after VM deletion. Options are Detach, Delete + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataDiskSizeInGb +Specifies the sizes of data disks in GB. + +```yaml +Type: System.Int32[] +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableBginfoExtension +Indicates that this cmdlet does not install the **BG Info** extension on the virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableIntegrityMonitoring +This flag disables the default behavior to install the Guest Attestation extension to the virtual machine if: 1) SecurityType is TrustedLaunch, 2) SecureBootEnabled on the SecurityProfile is true, 3) VTpmEnabled on the SecurityProfile is true. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskControllerType +Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://learn.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://learn.microsoft.com/rest/api/compute/resourceskus/list) . <br> For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskFile +The local path to the virtual hard disk file to be uploaded to the cloud and for creating the VM, and it must have '.vhd' as its suffix. + +```yaml +Type: System.String +Parameter Sets: DiskFileParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainNameLabel +The subdomain label for the fully-qualified domain name (FQDN) of the VM. This will take the form `{domainNameLabel}.{location}.cloudapp.azure.com`. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +Sets the edge zone name. If set, the query will be routed to the specified edgezone instead of the main region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableUltraSSD +Use UltraSSD disks for the vm. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionAtHost +EncryptionAtHost property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. +This will enable the encryption for all the disks including Resource/Temp disk at host itself. +Default: The Encryption at host will be disabled unless this property is set to true for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EvictionPolicy +The eviction policy for the Azure Spot virtual machine. Supported values are 'Deallocate' and 'Delete'. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GenerateSshKey +Generate a SSH Public/Private key pair and create a SSH Public Key resource on Azure. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SimpleParameterSet, DefaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HibernationEnabled +The flag that enables or disables hibernation capability on the VM. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HostGroupId +Specifies the dedicated host group the virtual machine will reside in. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HostId +The Id of Host + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Image +The friendly image name upon which the VM will be built. The available aliases are: Win2022AzureEditionCore, Win2019Datacenter, Win2016Datacenter, Win2012R2Datacenter, Win2012Datacenter, UbuntuLTS, Ubuntu2204, CentOS, CentOS85Gen2, Debian, Debian11, OpenSuseLeap154Gen2, RHEL, RHELRaw8LVMGen2, SuseSles15SP3, FlatcarLinuxFreeGen2. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: ImageName + +Required: False +Position: Named +Default value: Win2016Datacenter +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceId +Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +Specifies a license type, which indicates that the image or disk for the virtual machine was licensed on-premises. +Possible values for Windows Server are: +- Windows_Client +- Windows_Server +Possible values for Linux Server operating system are: +- RHEL_BYOS (for RHEL) +- SLES_BYOS (for SUSE) + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Linux +Indicates whether the disk file is for Linux VM, if specified; or Windows, if not specified by default. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies a location for the virtual machine. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPrice +The max price of the billing of a low priority virtual machine. + +```yaml +Type: System.Double +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the VM resource. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterfaceDeleteOption +Specifies what action to perform on the NetworkInterface resource when the VM is deleted. Options are: Detach, Delete. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OpenPorts +A list of ports to open on the network security group (NSG) for the created VM. The default value depends on the type of image chosen (i.e., Windows: 3389, 5985 and Linux: 22). + +```yaml +Type: System.Int32[] +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSDiskDeleteOption +Specifies OS Disk delete option after VM deletion. Options are Detach, Delete + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlatformFaultDomain +Specifies the fault domain of the virtual machine. + +```yaml +Type: System.Int32 +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Priority +The priority for the virtual machine. Only supported values are 'Regular', 'Spot' and 'Low'. +'Regular' is for regular virtual machine. +'Spot' is for spot virtual machine. +'Low' is also for spot virtual machine but is replaced by 'Spot'. Please use 'Spot' instead of 'Low'. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProximityPlacementGroupId +The resource id of the Proximity Placement Group to use with this virtual machine. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: ProximityPlacementGroup + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddressName +The name of a new (or existing) public IP address for the created VM to use. If not specified, a name will be generated. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpSku +Specifies public IP sku name + +Accepted values are "Basic" and "Standard" + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityGroupName +The name of a new (or existing) network security group (NSG) for the created VM to use. If not specified, a name will be generated. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedGalleryImageId +Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Size +The Virtual Machine Size. [Get-AzComputeResourceSku](https://learn.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku) can be used to find out available sizes for your subscription and region.<br> +The Default Value is: Standard_D2s_v3. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: Standard_D2s_v3 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshKeyName +Name of the SSH Public Key resource. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DefaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetAddressPrefix +The address prefix for the subnet which will be created for the VM. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: 192.168.1.0/24 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetName +The name of a new (or existing) subnet for the created VM to use. If not specified, a name will be generated. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemAssignedIdentity +If the parameter is present then the VM is assigned a managed system identity that is auto generated. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specifies that resources and resource groups can be tagged with a set of name-value pairs. +Adding tags to resources enables you to group resources together across resource groups and to create your own views. +Each resource or resource group can have a maximum of 15 tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The name of a managed service identity that should be assigned to the VM. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserData +UserData for the VM, which will be base-64 encoded. Customer should not pass any secrets in here. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -vCPUCountAvailable +Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -vCPUCountPerCore +Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). Setting this property to 1 also means that hyper-threading is disabled. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkName +The name of a new (or existing) virtual network for the created VM to use. If not specified, a name will be generated. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +Specifies a local virtual machine to create. +To obtain a virtual machine object, use the New-AzVMConfig cmdlet. +Other cmdlets can be used to configure the virtual machine, such as Set-AzVMOperatingSystem, Set-AzVMSourceImage, and Add-AzVMNetworkInterface. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: DefaultParameterSet +Aliases: VMProfile + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -VmssId +The ID of Virtual Machine Scale Set that this VM will be associated with + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, DiskFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +Specifies the zone of the virtual machine. Although it takes in an array of zones, virtual machines do not support multiple availability zones. +The allowed value depends on the capabilities of the region. Allowed value will normally be 1, 2, or 3. More information on [Azure availability zones](https://learn.microsoft.com/en-us/azure/reliability/availability-zones-overview#availability-zones). + +```yaml +Type: System.String[] +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String[] +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.String[] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[Remove-AzVM](./Remove-AzVM.md) + +[Restart-AzVM](./Restart-AzVM.md) + +[Start-AzVM](./Start-AzVM.md) + +[Stop-AzVM](./Stop-AzVM.md) + +[Update-AzVM](./Update-AzVM.md) + +[Add-AzVMDataDisk](./Add-AzVMDataDisk.md) + +[Add-AzVMNetworkInterface](./Add-AzVMNetworkInterface.md) + +[New-AzVMConfig](./New-AzVMConfig.md) + +[Set-AzVMOperatingSystem](./Set-AzVMOperatingSystem.md) + +[Set-AzVMSourceImage](./Set-AzVMSourceImage.md) + +[Set-AzVMOSDisk](./Set-AzVMOSDisk.md) + + diff --git a/azps-10.1.0/Az.Compute/New-AzVMConfig.md b/azps-10.1.0/Az.Compute/New-AzVMConfig.md new file mode 100644 index 0000000000..e66b6c7413 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzVMConfig.md @@ -0,0 +1,656 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 1BECAC91-BB43-46EB-B2C9-C965C6FBC831 +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azvmconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVMConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVMConfig.md +--- + +# New-AzVMConfig + +## SYNOPSIS +Creates a configurable virtual machine object. + +## SYNTAX + +### DefaultParameterSet (Default) +``` +New-AzVMConfig [-VMName] <String> [-VMSize] <String> [[-AvailabilitySetId] <String>] [[-LicenseType] <String>] + [-Zone <String[]>] [-ProximityPlacementGroupId <String>] [-HostId <String>] [-VmssId <String>] + [-MaxPrice <Double>] [-EvictionPolicy <String>] [-Priority <String>] [-Tags <Hashtable>] [-EnableUltraSSD] + [-EncryptionAtHost] [-CapacityReservationGroupId <String>] [-ImageReferenceId <String>] + [-DiskControllerType <String>] [-UserData <String>] [-PlatformFaultDomain <Int32>] [-HibernationEnabled] + [-vCPUCountAvailable <Int32>] [-vCPUCountPerCore <Int32>] [-SharedGalleryImageId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ExplicitIdentityParameterSet +``` +New-AzVMConfig [-VMName] <String> [-VMSize] <String> [[-AvailabilitySetId] <String>] [[-LicenseType] <String>] + [-IdentityType] <ResourceIdentityType> [-IdentityId <String[]>] [-Zone <String[]>] + [-ProximityPlacementGroupId <String>] [-HostId <String>] [-VmssId <String>] [-MaxPrice <Double>] + [-EvictionPolicy <String>] [-Priority <String>] [-Tags <Hashtable>] [-EnableUltraSSD] [-EncryptionAtHost] + [-CapacityReservationGroupId <String>] [-ImageReferenceId <String>] [-DiskControllerType <String>] + [-UserData <String>] [-PlatformFaultDomain <Int32>] [-HibernationEnabled] [-vCPUCountAvailable <Int32>] + [-vCPUCountPerCore <Int32>] [-SharedGalleryImageId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVMConfig** cmdlet creates a configurable local virtual machine object for Azure. <br> + +The following cmdlets are used to set different properties of the virtual machine object: <br> +- **[Add-AzVMNetworkInterface](https://learn.microsoft.com/en-us/powershell/module/az.compute/add-azvmnetworkinterface)** to set the network profile.<br> +- **[Set-AzVMOperatingSystem](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmoperatingsystem)** to set the OS profile. <br> +- **[Set-AzVMSourceImage](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmsourceimage)** to set the source image.<br> +- **[Set-AzVMOSDisk](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmosdisk)** to set the OS disk (storage profile).<br> +- **[Get-AzComputeResourceSku](https://learn.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku)** can also be used to find out available virtual machine sizes for your subscription and region.<br> +<br> +See [Quickstart: Create a Windows virtual machine in Azure with PowerShell](https://learn.microsoft.com/en-us/azure/virtual-machines/windows/quick-create-powershell) for tutorial. <br> + +## EXAMPLES + +### Example 1: Create a virtual machine resource +```powershell +$rgname = "resourceGroupName"; +$loc = "eastus"; + +New-AzResourceGroup -Name $rgname -Location $loc -Force; + +# General Setup +$vmname = 'v' + $rgname; +$domainNameLabel = "d1" + $rgname; +$vmSize = 'Standard_DS3_v2'; +$computerName = "c" + $rgname; + +# Credential. Input Username and Password values +$user = ""; +$securePassword = "" | ConvertTo-SecureString -AsPlainText -Force; +$cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword); + +# Creating a VMConfig +$vmconfig = New-AzVMConfig -VMName $vmname -vmsize $vmsize; + +# Set source image values +$publisherName = "MicrosoftWindowsServer"; +$offer = "WindowsServer"; +$sku = "2019-DataCenter"; +$vmconfig = Set-AzVMSourceImage -VM $vmconfig -PublisherName $publisherName -Offer $offer -Skus $sku -Version 'latest'; + +# NRP Setup +$subnet = New-AzVirtualNetworkSubnetConfig -Name ('subnet' + $rgname) -AddressPrefix "10.0.0.0/24"; +$vnet = New-AzVirtualNetwork -Force -Name ('vnet' + $rgname) -ResourceGroupName $rgname -Location $loc -AddressPrefix "10.0.0.0/16" -Subnet $subnet; +$vnet = Get-AzVirtualNetwork -Name ('vnet' + $rgname) -ResourceGroupName $rgname; +$subnetId = $vnet.Subnets[0].Id; +$pubip = New-AzPublicIpAddress -Force -Name ('pubip' + $rgname) -ResourceGroupName $rgname -Location $loc -AllocationMethod Static -DomainNameLabel $domainNameLabel; +$pubip = Get-AzPublicIpAddress -Name ('pubip' + $rgname) -ResourceGroupName $rgname; +$pubipId = $pubip.Id; +$nic = New-AzNetworkInterface -Force -Name ('nic' + $rgname) -ResourceGroupName $rgname -Location $loc -SubnetId $subnetId -PublicIpAddressId $pubip.Id; +$nic = Get-AzNetworkInterface -Name ('nic' + $rgname) -ResourceGroupName $rgname; +$nicId = $nic.Id; + +$vmconfig = Add-AzVMNetworkInterface -VM $vmconfig -Id $nicId; +$vmconfig = Set-AzVMOperatingSystem -VM $vmconfig -Windows -ComputerName $computerName -Credential $cred; + +# Create the VM +New-AzVM -ResourceGroupName $rgname -Location $loc -Vm $vmconfig; +$vm = Get-AzVM -ResourceGroupName $rgname -Name $vmname; + +``` + +### Example 2: Create a virtual machine object in a virtual machine scale set with fault domains setup +```powershell +$rgname = "resourceGroupName"; +$loc = "eastus"; +$vmname = "vm" + $rgname; + +New-AzResourceGroup -Name $rgname -Location $loc -Force; + +$domainNameLabel = "d1" + $rgname; +$vmname = "v" + $rgname; +$vnetname = "myVnet"; +$vnetAddress = "10.0.0.0/16"; +$subnetname = "slb" + $rgname; +$subnetAddress = "10.0.2.0/24"; +$vmssName = "vmss" + $rgname; +$faultDomainNumber = 2; +$vmssFaultDomain = 3; + +$OSDiskName = $vmname + "-osdisk"; +$NICName = $vmname+ "-nic"; +$NSGName = $vmname + "-NSG"; +$OSDiskSizeinGB = 128; +$VMSize = "Standard_DS2_v2"; +$PublisherName = "MicrosoftWindowsServer"; +$Offer = "WindowsServer"; +$SKU = "2019-Datacenter"; + +# Credential. Input Username and Password values. +$user = ""; +$securePassword = "" | ConvertTo-SecureString -AsPlainText -Force; +$cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword); + +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name $subnetname -AddressPrefix $subnetAddress; +$vnet = New-AzVirtualNetwork -Name $vnetname -ResourceGroupName $rgname -Location $loc -AddressPrefix $vnetAddress -Subnet $frontendSubnet; + +$vmssConfig = New-AzVmssConfig -Location $loc -PlatformFaultDomainCount $vmssFaultDomain; +$vmss = New-AzVmss -ResourceGroupName $RGName -Name $VMSSName -VirtualMachineScaleSet $vmssConfig; + +$nsgRuleRDP = New-AzNetworkSecurityRuleConfig -Name RDP -Protocol Tcp -Direction Inbound -Priority 1001 -SourceAddressPrefix * -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 -Access Allow; +$nsg = New-AzNetworkSecurityGroup -ResourceGroupName $RGName -Location $loc -Name $NSGName -SecurityRules $nsgRuleRDP; +$nic = New-AzNetworkInterface -Name $NICName -ResourceGroupName $RGName -Location $loc -SubnetId $vnet.Subnets[0].Id -NetworkSecurityGroupId $nsg.Id -EnableAcceleratedNetworking; + +# VM +$vmConfig = New-AzVMConfig -VMName $vmName -VMSize $VMSize -VmssId $vmss.Id -PlatformFaultDomain $faultDomainNumber ; +Set-AzVMOperatingSystem -VM $vmConfig -Windows -ComputerName $vmName -Credential $cred ; +Set-AzVMOSDisk -VM $vmConfig -StorageAccountType "Premium_LRS" -Caching ReadWrite -Name $OSDiskName -DiskSizeInGB $OSDiskSizeinGB -CreateOption FromImage ; +Set-AzVMSourceImage -VM $vmConfig -PublisherName $PublisherName -Offer $Offer -Skus $SKU -Version latest ; +Add-AzVMNetworkInterface -VM $vmConfig -Id $nic.Id; + +New-AzVM -ResourceGroupName $RGName -Location $loc -VM $vmConfig; +$vm = Get-AzVM -ResourceGroupName $rgname -Name $vmName; + +``` + +### Example 2: Create a VM using Virtual Machine Config object for TrustedLaunch Secuirty Type, flags Vtpm and Secure Boot are set to True by default. +```powershell +$rgname = "rgname"; +$loc = "eastus"; +New-AzResourceGroup -Name $rgname -Location $loc -Force; + +# VM Profile & Hardware +$domainNameLabel = "d1" + $rgname; +$vmsize = 'Standard_D4s_v3'; +$vmname = $rgname + 'Vm'; +$securityType_TL = "TrustedLaunch"; +$vnetname = "myVnet"; +$vnetAddress = "10.0.0.0/16"; +$subnetname = "slb" + $rgname; +$subnetAddress = "10.0.2.0/24"; +$OSDiskName = $vmname + "-osdisk"; +$NICName = $vmname+ "-nic"; +$NSGName = $vmname + "-NSG"; +$OSDiskSizeinGB = 128; +$PublisherName = "MicrosoftWindowsServer"; +$Offer = "WindowsServer"; +$SKU = "2016-datacenter-gensecond"; +$disable = $false; +$enable = $true; +$extDefaultName = "GuestAttestation"; +$vmGADefaultIDentity = "SystemAssigned"; +# Credential +$password = <Password>; +$securePassword = $password | ConvertTo-SecureString -AsPlainText -Force; +$user = <Username>; +$cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword); +# Network resources +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name $subnetname -AddressPrefix $subnetAddress; +$vnet = New-AzVirtualNetwork -Name $vnetname -ResourceGroupName $rgname -Location $loc -AddressPrefix $vnetAddress -Subnet $frontendSubnet; +$nsgRuleRDP = New-AzNetworkSecurityRuleConfig -Name RDP -Protocol Tcp -Direction Inbound -Priority 1001 -SourceAddressPrefix * -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 -Access Allow; +$nsg = New-AzNetworkSecurityGroup -ResourceGroupName $rgname -Location $loc -Name $NSGName -SecurityRules $nsgRuleRDP; +$nic = New-AzNetworkInterface -Name $NICName -ResourceGroupName $rgname -Location $loc -SubnetId $vnet.Subnets[0].Id -NetworkSecurityGroupId $nsg.Id -EnableAcceleratedNetworking; +# Configure Values using VMConfig Object +$vmConfig = New-AzVMConfig -VMName $vmname -VMSize $vmsize; +Set-AzVMOperatingSystem -VM $vmConfig -Windows -ComputerName $vmname -Credential $cred; +Set-AzVMSourceImage -VM $vmConfig -PublisherName $PublisherName -Offer $Offer -Skus $SKU -Version latest ; +Add-AzVMNetworkInterface -VM $vmConfig -Id $nic.Id; + +# VM Creation using VMConfig for Trusted Launch SecurityType +$vmConfig = Set-AzVMSecurityProfile -VM $vmConfig -SecurityType $securityType_TL; +New-AzVM -ResourceGroupName $rgname -Location $loc -VM $vmConfig; +$vm = Get-AzVM -ResourceGroupName $rgname -Name $vmname; +# Validate that for -SecurityType "TrustedLaunch", "-Vtpm" and "-SecureBoot" are "Enabled/true" +#$vm.SecurityProfile.UefiSettings.VTpmEnabled $true; +#$vm.SecurityProfile.UefiSettings.SecureBootEnabled $true; +``` + +This example creates a VM using a VMConfig object for the TrustedLaunch Security Type and validates flags VtpmEnabled and SecureBootEnabled are true by default. + +## PARAMETERS + +### -AvailabilitySetId +Specifies the ID of an availability set. +To obtain an availability set object, use the Get-AzAvailabilitySet cmdlet. +The availability set object contains an ID property. <br> +Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. <br> +For more information about availability sets, see [Manage the availability of virtual machines](/azure/virtual-machines/availability). <br> +For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](/azure/virtual-machines/maintenance-and-updates?toc=/azure/virtual-machines/windows/toc.json&bc=/azure/virtual-machines/windows/breadcrumb/toc.json) <br> +Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br> +This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CapacityReservationGroupId +Id of the capacity reservation Group that is used to allocate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskControllerType +Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://learn.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://learn.microsoft.com/rest/api/compute/resourceskus/list) . <br> For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUltraSSD +Enables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM. +Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine only if this property is enabled. + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptionAtHost +EncryptionAtHost property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. +This will enable the encryption for all the disks including Resource/Temp disk at host itself. +Default: The Encryption at host will be disabled unless this property is set to true for the resource. + +```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 +``` + +### -EvictionPolicy +The eviction policy for the Azure Spot virtual machine. Supported values are 'Deallocate' and 'Delete'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HibernationEnabled +The flag that enables or disables hibernation capability on the VM. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HostId +The Id of Host + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityId +Specifies the list of user identities associated with the virtual machine scale set. +The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' + +```yaml +Type: System.String[] +Parameter Sets: ExplicitIdentityParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityType +The identity of the virtual machine, if configured. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.ResourceIdentityType] +Parameter Sets: ExplicitIdentityParameterSet +Aliases: +Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceId +Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +Specifies a license type, which indicates that the image or disk for the virtual machine was licensed on-premises. +Possible values for Windows Server are: +- Windows_Client +- Windows_Server + +Possible values for Linux Server operating system are: +- RHEL_BYOS (for RHEL) +- SLES_BYOS (for SUSE) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPrice +Specifies the maximum price you are willing to pay for a low priority VM/VMSS. This price is in US Dollars. This price will be compared with the current low priority price for the VM size. Also, the prices are compared at the time of create/update of low priority VM/VMSS and the operation will only succeed if the maxPrice is greater than the current low priority price. The maxPrice will also be used for evicting a low priority VM/VMSS if the current low priority price goes beyond the maxPrice after creation of VM/VMSS. Possible values are: any decimal value greater than zero. Example: 0.01538. -1 indicates that the low priority VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PlatformFaultDomain +Specifies the fault domain of the virtual machine. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Priority +The priority for the virtual machine. Only supported values are 'Regular', 'Spot' and 'Low'. +'Regular' is for regular virtual machine. +'Spot' is for spot virtual machine. +'Low' is also for spot virtual machine but is replaced by 'Spot'. Please use 'Spot' instead of 'Low'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProximityPlacementGroupId +The resource id of the Proximity Placement Group to use with this virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SharedGalleryImageId +Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +The tags attached to the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserData +UserData for the VM, which will be base-64 encoded. Customer should not pass any secrets in here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -vCPUCountAvailable +Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -vCPUCountPerCore +Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). Setting this property to 1 also means that hyper-threading is disabled. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies a name for the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMSize +Specifies the size for the virtual machine. [Get-AzComputeResourceSku](https://learn.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku) can be used to find out available sizes for your subscription and region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VmssId +The Id of virtual machine scale set + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +Specifies the availability zone for the virtual machine. Although it takes in an array of zones, virtual machines do not support multiple availability zones. +The allowed value depends on the capabilities of the region. Allowed value will normally be 1, 2, or 3. More information on [Azure availability zones](https://learn.microsoft.com/en-us/azure/reliability/availability-zones-overview#availability-zones). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Collections.Hashtable + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[Update-AzVM](./Update-AzVM.md) + +[Set-AzVMOperatingSystem](./Set-AzVMOperatingSystem.md) + +[Set-AzVMSourceImage](./Set-AzVMSourceImage.md) + +[Get-AzAvailabilitySet](./Get-AzAvailabilitySet.md) + + diff --git a/azps-10.1.0/Az.Compute/New-AzVMDataDisk.md b/azps-10.1.0/Az.Compute/New-AzVMDataDisk.md new file mode 100644 index 0000000000..fad410821b --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzVMDataDisk.md @@ -0,0 +1,263 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azvmdatadisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVMDataDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVMDataDisk.md +--- + +# New-AzVMDataDisk + +## SYNOPSIS +Creates a local data disk object for a virtual machine or a Vmss VM. + +## SYNTAX + +### NormalDiskParameterSetName (Default) +``` +New-AzVMDataDisk [-Lun] <Int32> [-CreateOption] <String> [-Name <String>] [-Caching <CachingTypes>] + [-DiskSizeInGB <Int32>] [-VhdUri <String>] [-SourceImageUri <String>] [-DiskEncryptionSetId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ManagedDiskParameterSetName +``` +New-AzVMDataDisk [-Lun] <Int32> [-CreateOption] <String> [-Name <String>] [-Caching <CachingTypes>] + [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] [-StorageAccountType <String>] + [-DiskEncryptionSetId <String>] [-WriteAccelerator] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVMDataDisk** cmdlet creates a local data disk object for a virtual machine or a Vmss VM. + +## EXAMPLES + +### Example 1: Add a managed data disk to a Vmss VM. +```powershell +$disk = Get-AzDisk -ResourceGroupName $rgname -DiskName $diskname0 +$datadisk = New-AzVMDataDisk -Caching 'ReadOnly' -Lun 2 -CreateOption Attach -StorageAccountType Standard_LRS -ManagedDiskId $disk.Id +$VmssVM = Get-AzVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 +Update-AzVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 -DataDisk $datadisk +``` + +The first command gets an existing managed disk. +The next command creates a data disk object with the managed disk. +The next command gets an existing Vmss VM given by the resource group name, the vmss name and the instance ID. +The final command updates the Vmss VM by adding a new data disk. + +### Example 2 + +Creates a local data disk object for a virtual machine or a Vmss VM. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzVMDataDisk -Caching None -CreateOption Attach -DiskSizeInGB 1 -Lun 2 -Name 'AgentPool01' +``` + +## PARAMETERS + +### -Caching +The virtual machine data disk's caching. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.CachingTypes +Parameter Sets: (All) +Aliases: +Accepted values: None, ReadOnly, ReadWrite + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CreateOption +The virtual machine data disk's create option. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +The virtual machine managed disk encryption set's Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskSizeInGB +The virtual machine data disk's size in GB. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Lun +The virtual machine data disk's Lun. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagedDiskId +The virtual machine managed disk's Id. + +```yaml +Type: System.String +Parameter Sets: ManagedDiskParameterSetName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The virtual machine data disk's name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceImageUri +The virtual machine OS disk's source image Uri. + +```yaml +Type: System.String +Parameter Sets: NormalDiskParameterSetName +Aliases: SourceImage + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountType +The virtual machine managed disk's account type. + +```yaml +Type: System.String +Parameter Sets: ManagedDiskParameterSetName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VhdUri +The virtual machine data disk's Vhd Uri. + +```yaml +Type: System.String +Parameter Sets: NormalDiskParameterSetName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WriteAccelerator +Specifies whether WriteAccelerator should be enabled or disabled on a managed data disk. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ManagedDiskParameterSetName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 + +### System.String + +### Microsoft.Azure.Management.Compute.Models.CachingTypes + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineDataDisk + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzVMSqlServerAutoBackupConfig.md b/azps-10.1.0/Az.Compute/New-AzVMSqlServerAutoBackupConfig.md new file mode 100644 index 0000000000..f62a6bd3e0 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzVMSqlServerAutoBackupConfig.md @@ -0,0 +1,355 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 0AC17275-17A9-47DE-BF04-C1A51DF057DC +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azvmsqlserverautobackupconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVMSqlServerAutoBackupConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVMSqlServerAutoBackupConfig.md +--- + +# New-AzVMSqlServerAutoBackupConfig + +## SYNOPSIS +Creates a configuration object for SQL Server automatic backup. + +## SYNTAX + +### StorageUriSqlServerAutoBackup (Default) +``` +New-AzVMSqlServerAutoBackupConfig [-ResourceGroupName] <String> [-Enable] [[-RetentionPeriodInDays] <Int32>] + [-EnableEncryption] [[-CertificatePassword] <SecureString>] [[-StorageUri] <Uri>] + [[-StorageKey] <SecureString>] [-BackupSystemDbs] [-BackupScheduleType <String>] + [-FullBackupFrequency <String>] [-FullBackupStartHour <Int32>] [-FullBackupWindowInHours <Int32>] + [-LogBackupFrequencyInMinutes <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### StorageContextSqlServerAutoBackup +``` +New-AzVMSqlServerAutoBackupConfig [-ResourceGroupName] <String> [-Enable] [[-RetentionPeriodInDays] <Int32>] + [-EnableEncryption] [[-CertificatePassword] <SecureString>] [[-StorageContext] <IStorageContext>] + [[-StorageUri] <Uri>] [[-StorageKey] <SecureString>] [-BackupSystemDbs] [-BackupScheduleType <String>] + [-FullBackupFrequency <String>] [-FullBackupStartHour <Int32>] [-FullBackupWindowInHours <Int32>] + [-LogBackupFrequencyInMinutes <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVMSqlServerAutoBackupConfig** cmdlet creates a configuration object for SQL Server automatic backup. + +## EXAMPLES + +### Example 1: Create an automatic backup configuration using storage URI and account key +```powershell +$AutoBackupConfig = New-AzVMSqlServerAutoBackupConfig -Enable -RetentionPeriodInDays 10 -StorageUri "\\contoso\StorageGeneral" -StorageKey "< Storage Key for ContosoGeneral >" +``` + +```output +Enable : True +EnableEncryption : False +RetentionPeriodInDays : 10 +``` + +This command creates an automatic backup configuration object by specifying storage URI and account key. +Automatic backup is enabled and automatic backups are kept for 10 days. +The command stores the result in the $AutoBackupConfig variable. +You can specify this configuration item for other cmdlets, such as the Set-AzVMSqlServerExtension cmdlet. + +### Example 2: Create an automatic backup configuration using storage context +```powershell +$StorageContext = New-AzStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral >" +$AutoBackupConfig = New-AzVMSqlServerAutoBackupConfig -StorageContext $StorageContext -Enable -RetentionPeriodInDays 10 +``` + +```output +Enable : True +EnableEncryption : False +RetentionPeriodInDays : 10 +``` + +The first command creates a storage context, and then stores it in the $StorageContext variable. +For more information, see New-AzStorageContext. +The second command creates an automatic backup configuration object by specifying the storage context in $StorageContext. +Automatic backup is enabled and automatic backups are kept for 10 days. + +### Example 3: Create an automatic backup configuration using storage context with encryption and password +```powershell +$StorageContext = New-AzVMSqlServerAutoBackupConfig -StorageContext $StorageContext -Enable -RetentionPeriodInDays 10 -EnableEncryption -CertificatePassword $CertificatePassword +``` + +```output +Enable : True +EnableEncryption : True +RetentionPeriodInDays : 10 +``` + +This command creates and stores an automatic backup configuration object. +The command specifies the storage context created in a previous example. +The command enables encryption with password. +The password was previously stored as a secure string in the $CertificatePassword variable. +To create a secure string, use the ConvertTo-SecureString cmdlet. + +## PARAMETERS + +### -BackupScheduleType +Backup schedule type, manual or automated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Manual, Automated + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackupSystemDbs +Backup system databases + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CertificatePassword +Specifies a password to encrypt the certificate that is used to perform SQL Server encrypted backups. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Indicates that automated backup for the SQL Server virtual machine is enabled. +If you specify this parameter, automated backup sets a backup schedule for all current and new databases. +This updates your Managed Backup settings to follow this schedule. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableEncryption +Indicates that this cmdlet enables encryption. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FullBackupFrequency +Sql Server Full Backup frequency, daily or weekly + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Daily, Weekly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FullBackupStartHour +Hour of the day (0-23) when the Sql Server Full Backup should start + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FullBackupWindowInHours +Sql Server Full Backup window in hours + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LogBackupFrequencyInMinutes +Sql Server Log Backup frequency, once every 1-60 minutes + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionPeriodInDays +Specifies the number of days to retain a backup. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageContext +Specifies the storage account that will be used to store backups. +To obtain an **AzureStorageContext** object, use the New-AzStorageContext cmdlet. +The default is the storage account that is associated with the SQL Server virtual machine. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: StorageContextSqlServerAutoBackup +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageKey +Specifies the storage key of the blob storage account. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageUri +Specifies the Uniform Resource Identifier (URI) of the blob storage account. + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +### System.Int32 + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +### System.Uri + +### System.Security.SecureString + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.AutoBackupSettings + +## NOTES + +## RELATED LINKS + +[New-AzVMSqlServerAutoPatchingConfig](./New-AzVMSqlServerAutoPatchingConfig.md) + +[Set-AzVMSqlServerExtension](./Set-AzVMSqlServerExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/New-AzVMSqlServerAutoPatchingConfig.md b/azps-10.1.0/Az.Compute/New-AzVMSqlServerAutoPatchingConfig.md new file mode 100644 index 0000000000..7a9abbabf4 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzVMSqlServerAutoPatchingConfig.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 7016BAA9-C25D-404E-9F75-2BE49FBF91A8 +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azvmsqlserverautopatchingconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVMSqlServerAutoPatchingConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVMSqlServerAutoPatchingConfig.md +--- + +# New-AzVMSqlServerAutoPatchingConfig + +## SYNOPSIS +Creates a configuration object for automatic patching on a virtual machine. + +## SYNTAX + +``` +New-AzVMSqlServerAutoPatchingConfig [-Enable] [-DayOfWeek <String>] [-MaintenanceWindowStartingHour <Int32>] + [-MaintenanceWindowDuration <Int32>] [-PatchCategory <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVMSqlServerAutoPatchingConfig** cmdlet creates a configuration object for automatic patching on a virtual machine. + +## EXAMPLES + +### Example 1: Create a configuration object to configure automatic patching +```powershell +$AutoPatchingConfig = New-AzVMSqlServerAutoPatchingConfig -Enable -DayOfWeek "Thursday" -MaintenanceWindowStartingHour 11 -MaintenanceWindowDuration 120 -PatchCategory "Important" +``` + +```output +Enable : True +DayOfWeek : Thursday +MaintenanceWindowStartingHour : 11 +MaintenanceWindowDuration : 120 +PatchCategory : Important +``` + +This command creates configuration object for patching. +The command specifies the day of the week and defines the maintenance window. +This configuration enables patching that uses these values. +The command stores the result in the $AutoBackupConfig variable. +You can specify this configuration item for other cmdlets, such as the Set-AzVMSqlServerExtension cmdlet. + +## PARAMETERS + +### -DayOfWeek +Specifies the day of the week when updates should be installed. +The acceptable values for this parameter are: +- Sunday +- Monday +- Tuesday +- Wednesday +- Thursday +- Friday +- Saturday +- Everyday + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Everyday + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Indicates that automated patching for the virtual machine is enabled. +If you enable automated patching the cmdlet puts Windows Update into interactive mode. +If you disable automated patching, Windows Update settings do not change. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceWindowDuration +Specifies the duration, in minutes, of the maintenance window. +Automated patching avoids performing an action that can affect a virtual machine availability outside that window. +Specify a multiple of 30 minutes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceWindowStartingHour +Specifies the hour of the day when maintenance window starts. +This time defines when updates start to install. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PatchCategory +Specifies whether important updates should be included. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Important + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.AutoPatchingSettings + +## NOTES + +## RELATED LINKS + +[New-AzVMSqlServerAutoBackupConfig](./New-AzVMSqlServerAutoBackupConfig.md) + +[Set-AzVMSqlServerExtension](./Set-AzVMSqlServerExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/New-AzVMSqlServerKeyVaultCredentialConfig.md b/azps-10.1.0/Az.Compute/New-AzVMSqlServerKeyVaultCredentialConfig.md new file mode 100644 index 0000000000..bf6525f43d --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzVMSqlServerKeyVaultCredentialConfig.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: B30C2BDD-6DA9-47B5-88FE-3AD43E15A072 +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azvmsqlserverkeyvaultcredentialconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVMSqlServerKeyVaultCredentialConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVMSqlServerKeyVaultCredentialConfig.md +--- + +# New-AzVMSqlServerKeyVaultCredentialConfig + +## SYNOPSIS +Creates a configuration object for SQL server key vault credential on a virtual machine. + +## SYNTAX + +``` +New-AzVMSqlServerKeyVaultCredentialConfig [-ResourceGroupName] <String> [-Enable] [-CredentialName <String>] + [-AzureKeyVaultUrl <String>] [-ServicePrincipalName <String>] [-ServicePrincipalSecret <SecureString>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVMSqlServerKeyVaultCredentialConfig** cmdlet creates a configuration object for SQL server key vault credential on a virtual machine. + +## EXAMPLES + +### Example 1 +```powershell +New-AzVMSqlServerKeyVaultCredentialConfig -ResourceGroupName "ResourceGroup11" -Enable -AzureKeyVaultUrl https://myvault.vault.azure.net/ -CredentialName test1 +``` + +```Output +ResourceGroupName : ResourceGroup11 +Enable : True +CredentialName : test1 +AzureKeyVaultUrl : https://myvault.vault.azure.net/ +ServicePrincipalName : +ServicePrincipalSecret : +Credentials : +``` + +## PARAMETERS + +### -AzureKeyVaultUrl +Azure Key Vault service URL + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CredentialName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Enable +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServicePrincipalName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServicePrincipalSecret +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +### System.Security.SecureString + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.KeyVaultCredentialSettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzVmGalleryApplication.md b/azps-10.1.0/Az.Compute/New-AzVmGalleryApplication.md new file mode 100644 index 0000000000..50b97ee6f6 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzVmGalleryApplication.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azvmgalleryapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmGalleryApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmGalleryApplication.md +--- + +# New-AzVmGalleryApplication + +## SYNOPSIS +Create a local PSVMGalleryApplication object. + +## SYNTAX + +``` +New-AzVmGalleryApplication -PackageReferenceId <String> [-ConfigReferenceId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a local PSVMGalleryApplication object. + +## EXAMPLES + +### Example 1 +```powershell +$vm = Get-AzVM -ResourceGroupName $rgName -Name $vmName +$vmGal = New-AzVmGalleryApplication -PackageReferenceId $packageRefId -ConfigReferenceId $configRefId +Add-AzVmGalleryApplication -VM $vm -GalleryApplication $vmGal -Order 1 +``` + +This example creates a local VMGalleryApplication object and adds it to a PSVirtualMachine object. + +## PARAMETERS + +### -ConfigReferenceId +Configuration Reference Id of the Gallery Application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageReferenceId +Package Reference Id of the Gallery Application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVMGalleryApplication + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzVmss.md b/azps-10.1.0/Az.Compute/New-AzVmss.md new file mode 100644 index 0000000000..94882676cd --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzVmss.md @@ -0,0 +1,1090 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 1A2C843C-6962-4B0E-ACBF-A5EFF609A5BE +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azvmss +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmss.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmss.md +--- + +# New-AzVmss + +## SYNOPSIS +Creates a VMSS. + +## SYNTAX + +### DefaultParameter (Default) +``` +New-AzVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> + [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-AsJob] [-DisableIntegrityMonitoring] + [-EdgeZone <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SimpleParameterSet +``` +New-AzVmss [[-ResourceGroupName] <String>] [-VMScaleSetName] <String> [-AsJob] [-UserData <String>] + [-DisableIntegrityMonitoring] [-ImageName <String>] -Credential <PSCredential> [-InstanceCount <Int32>] + [-VirtualNetworkName <String>] [-SubnetName <String>] [-PublicIpAddressName <String>] + [-DomainNameLabel <String>] [-SecurityGroupName <String>] [-LoadBalancerName <String>] + [-BackendPort <Int32[]>] [-Location <String>] [-EdgeZone <String>] [-VmSize <String>] + [-UpgradePolicyMode <UpgradeMode>] [-AllocationMethod <String>] [-VnetAddressPrefix <String>] + [-SubnetAddressPrefix <String>] [-FrontendPoolName <String>] [-BackendPoolName <String>] + [-SystemAssignedIdentity] [-UserAssignedIdentity <String>] [-EnableUltraSSD] + [-Zone <System.Collections.Generic.List`1[System.String]>] [-NatBackendPort <Int32[]>] + [-DataDiskSizeInGb <Int32[]>] [-ProximityPlacementGroupId <String>] [-HostGroupId <String>] + [-Priority <String>] [-EvictionPolicy <String>] [-MaxPrice <Double>] [-ScaleInPolicy <String[]>] + [-SkipExtensionsOnOverprovisionedVMs] [-EncryptionAtHost] [-PlatformFaultDomainCount <Int32>] + [-OrchestrationMode <String>] [-CapacityReservationGroupId <String>] [-ImageReferenceId <String>] + [-DiskControllerType <String>] [-SharedGalleryImageId <String>] [-DefaultProfile <IAzureContextContainer>] + [-SinglePlacementGroup] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVmss** cmdlet creates a Virtual Machine Scale Set (VMSS) in Azure. +Use the simple parameter set (`SimpleParameterSet`) to quickly create a pre-set VMSS and associated resources. <br> + +Use the default parameter set (`DefaultParameter`) for more advanced scenarios when you need to precisely configure each component of the VMSS and each associated resource before creation. +For default parameter set, first use the **[New-AzVmssConfig](https://learn.microsoft.com/en-us/powershell/module/az.compute/new-azvmss)** cmdlet to create a virtual machine scale set object. <br> <br> + +Then use the following cmdlets to set different properties of the virtual machine scale set object: <br> +- **[Add-AzVmssNetworkInterfaceConfiguration](https://learn.microsoft.com/en-us/powershell/module/az.compute/add-azvmssnetworkinterfaceconfiguration)** to set the network profile.<br> +- **[Set-AzVmssOsProfile](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmssosprofile)** to set the OS profile. <br> +- **[Set-AzVmssStorageProfile](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmssstorageprofile)** to set the storage profile.<br> +- **[Get-AzComputeResourceSku](https://learn.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku)** can also be used to find out available virtual machine sizes for your subscription and region.<br><br> + +See other cmdlets for virtual machine scale set [here](https://learn.microsoft.com/en-us/powershell/module/az.compute/#vm-scale-sets).<br> +<br> +See [Quickstart: Create a virtual machine scale set with Azure PowerShell](https://learn.microsoft.com/en-us/azure/virtual-machine-scale-sets/quick-create-powershell) for tutorial. + +## EXAMPLES + +### Example 1: Create a VMSS using the SimpleParameterSet +```powershell +$vmssName = 'VMSSNAME' +# Create credentials, I am using one way to create credentials, there are others as well. +# Pick one that makes the most sense according to your use case. +$vmPassword = ConvertTo-SecureString "PASSWORD" -AsPlainText -Force +$vmCred = New-Object System.Management.Automation.PSCredential('USERNAME', $vmPassword) + +#Create a VMSS using the default settings +New-AzVmss -Credential $vmCred -VMScaleSetName $vmssName +``` + +The command above creates the following with the name `$vmssName` : +* A Resource Group +* A virtual network +* A load balancer +* A public IP +* the VMSS with 2 instances + +The default image chosen for the VMs in the VMSS is `2016-Datacenter Windows Server` and the SKU is `Standard_DS1_v2` + +### Example 2: Create a VMSS using the DefaultParameterSet +```powershell +# Common +$LOC = "WestUs"; +$RGName = "rgkyvms"; + +New-AzResourceGroup -Name $RGName -Location $LOC -Force; + +# SRP +$STOName = "sto" + $RGName; +$STOType = "Standard_GRS"; +New-AzStorageAccount -ResourceGroupName $RGName -Name $STOName -Location $LOC -Type $STOType; +$STOAccount = Get-AzStorageAccount -ResourceGroupName $RGName -Name $STOName; + +# NRP +$SubNet = New-AzVirtualNetworkSubnetConfig -Name ("subnet" + $RGName) -AddressPrefix "10.0.0.0/24"; +$VNet = New-AzVirtualNetwork -Force -Name ("vnet" + $RGName) -ResourceGroupName $RGName -Location $LOC -AddressPrefix "10.0.0.0/16" -DnsServer "10.1.1.1" -Subnet $SubNet; +$VNet = Get-AzVirtualNetwork -Name ('vnet' + $RGName) -ResourceGroupName $RGName; +$SubNetId = $VNet.Subnets[0].Id; + +$PubIP = New-AzPublicIpAddress -Force -Name ("pubip" + $RGName) -ResourceGroupName $RGName -Location $LOC -AllocationMethod Dynamic -DomainNameLabel ("pubip" + $RGName); +$PubIP = Get-AzPublicIpAddress -Name ("pubip" + $RGName) -ResourceGroupName $RGName; + +# Create LoadBalancer +$FrontendName = "fe" + $RGName +$BackendAddressPoolName = "bepool" + $RGName +$ProbeName = "vmssprobe" + $RGName +$InboundNatPoolName = "innatpool" + $RGName +$LBRuleName = "lbrule" + $RGName +$LBName = "vmsslb" + $RGName + +$Frontend = New-AzLoadBalancerFrontendIpConfig -Name $FrontendName -PublicIpAddress $PubIP +$BackendAddressPool = New-AzLoadBalancerBackendAddressPoolConfig -Name $BackendAddressPoolName +$Probe = New-AzLoadBalancerProbeConfig -Name $ProbeName -RequestPath healthcheck.aspx -Protocol http -Port 80 -IntervalInSeconds 15 -ProbeCount 2 +$InboundNatPool = New-AzLoadBalancerInboundNatPoolConfig -Name $InboundNatPoolName -FrontendIPConfigurationId ` + $Frontend.Id -Protocol Tcp -FrontendPortRangeStart 3360 -FrontendPortRangeEnd 3367 -BackendPort 3370; +$LBRule = New-AzLoadBalancerRuleConfig -Name $LBRuleName ` + -FrontendIPConfiguration $Frontend -BackendAddressPool $BackendAddressPool ` + -Probe $Probe -Protocol Tcp -FrontendPort 80 -BackendPort 80 ` + -IdleTimeoutInMinutes 15 -EnableFloatingIP -LoadDistribution SourceIP; +$ActualLb = New-AzLoadBalancer -Name $LBName -ResourceGroupName $RGName -Location $LOC ` + -FrontendIpConfiguration $Frontend -BackendAddressPool $BackendAddressPool ` + -Probe $Probe -LoadBalancingRule $LBRule -InboundNatPool $InboundNatPool; +$ExpectedLb = Get-AzLoadBalancer -Name $LBName -ResourceGroupName $RGName + +# New VMSS Parameters +$VMSSName = "vmss" + $RGName; + +$AdminUsername = "Admin01"; +$AdminPassword = "p4ssw0rd@123" + $RGName; + +$PublisherName = "MicrosoftWindowsServer" +$Offer = "WindowsServer" +$Sku = "2012-R2-Datacenter" +$Version = "latest" + +$VHDContainer = "https://" + $STOName + ".blob.core.windows.net/" + $VMSSName; + +$ExtName = "CSETest"; +$Publisher = "Microsoft.Compute"; +$ExtType = "BGInfo"; +$ExtVer = "2.1"; + +#IP Config for the NIC +$IPCfg = New-AzVmssIpConfig -Name "Test" ` + -LoadBalancerInboundNatPoolsId $ExpectedLb.InboundNatPools[0].Id ` + -LoadBalancerBackendAddressPoolsId $ExpectedLb.BackendAddressPools[0].Id ` + -SubnetId $SubNetId; + +#VMSS Config +$VMSS = New-AzVmssConfig -Location $LOC -SkuCapacity 2 -SkuName "Standard_E4-2ds_v4" -UpgradePolicyMode "Automatic" ` + | Add-AzVmssNetworkInterfaceConfiguration -Name "Test" -Primary $True -IPConfiguration $IPCfg ` + | Add-AzVmssNetworkInterfaceConfiguration -Name "Test2" -IPConfiguration $IPCfg ` + | Set-AzVmssOsProfile -ComputerNamePrefix "Test" -AdminUsername $AdminUsername -AdminPassword $AdminPassword ` + | Set-AzVmssStorageProfile -Name "Test" -OsDiskCreateOption 'FromImage' -OsDiskCaching "None" ` + -ImageReferenceOffer $Offer -ImageReferenceSku $Sku -ImageReferenceVersion $Version ` + -ImageReferencePublisher $PublisherName -VhdContainer $VHDContainer ` + | Add-AzVmssExtension -Name $ExtName -Publisher $Publisher -Type $ExtType -TypeHandlerVersion $ExtVer -AutoUpgradeMinorVersion $True + +#Create the VMSS +New-AzVmss -ResourceGroupName $RGName -Name $VMSSName -VirtualMachineScaleSet $VMSS; +``` + +The complex example above creates a VMSS, following is an explanation of what is happening: +* The first command creates a resource group with the specified name and location. +* The second command uses the **New-AzStorageAccount** cmdlet to create a storage account. +* The third command then uses the **Get-AzStorageAccount** cmdlet to get the storage account created in the second command and stores the result in the $STOAccount variable. +* The fifth command uses the **New-AzVirtualNetworkSubnetConfig** cmdlet to create a subnet and stores the result in the variable named $SubNet. +* The sixth command uses the **New-AzVirtualNetwork** cmdlet to create a virtual network and stores the result in the variable named $VNet. +* The seventh command uses the **Get-AzVirtualNetwork** to get information about the virtual network created in the sixth command and stores the information in the variable named $VNet. +* The eighth and ninth command uses the **New-AzPublicIpAddress** and **Get- AzureRmPublicIpAddress** to create and get information from that public IP address. +* The commands store the information in the variable named $PubIP. +* The tenth command uses the **New- AzureRmLoadBalancerFrontendIpConfig** cmdlet to create a frontend load balancer and stores the result in the variable named $Frontend. +* The eleventh command uses the **New-AzLoadBalancerBackendAddressPoolConfig** to create a backend address pool configuration and stores the result in the variable named $BackendAddressPool. +* The twelfth command uses the **New-AzLoadBalancerProbeConfig** to create a probe and stores the probe information in the variable named $Probe. +* The thirteenth command uses the **New-AzLoadBalancerInboundNatPoolConfig** cmdlet to create a load balancer inbound network address translation (NAT) pool configuration. +* The fourteenth command uses the **New-AzLoadBalancerRuleConfig** to create a load balancer rule configuration and stores the result in the variable named $LBRule. +* The fifteenth command uses the **New-AzLoadBalancer** cmdlet to create a load balancer and stores the result in the variable named $ActualLb. +* The sixteenth command uses the **Get-AzLoadBalancer** to get information about the load balancer that was created in the fifteenth command and stores the information in the variable named $ExpectedLb. +* The seventeenth command uses the **New-AzVmssIpConfig** cmdlet to create a VMSS IP configuration and stores the information in the variable named $IPCfg. +* The eighteenth command uses the **New-AzVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS. +* The nineteenth command uses the **New-AzVmss** cmdlet to create the VMSS. + +### Example 3: Create a VMSS with a UserData value +```powershell +$ResourceGroupName = 'RESOURCE GROUP NAME'; +$vmssName = 'VMSSNAME'; +$domainNameLabel = "dnl" + $ResourceGroupName; +# Create credentials, I am using one way to create credentials, there are others as well. +# Pick one that makes the most sense according to your use case. +$vmPassword = ConvertTo-SecureString 'PASSWORD' -AsPlainText -Force; +$vmCred = New-Object System.Management.Automation.PSCredential('USERNAME', $vmPassword); + +$text = "UserData value to encode"; +$bytes = [System.Text.Encoding]::Unicode.GetBytes($text); +$userData = [Convert]::ToBase64String($bytes); + +#Create a VMSS +New-AzVmss -ResourceGroupName $ResourceGroupName -Name $vmssName -Credential $vmCred -DomainNameLabel $domainNameLabel -Userdata $userData; +$vmss = Get-AzVmss -ResourceGroupName $ResourceGroupName -VMScaleSetName $vmssName -InstanceView:$false -Userdata; +``` + +Create a VMSS with a UserData value + +### Example 4: Create a VMSS with the Guest Attestation extension installed with the TrustedLaunch security type. +```powershell +# Common setup +$rgname = <RESOURCE GROUP NAME>; +$loc = <AZURE REGION>; +New-AzResourceGroup -Name $rgname -Location $loc -Force; +$vmssSize = 'Standard_DS3_v2'; +$PublisherName = "MicrosoftWindowsServer"; +$Offer = "WindowsServer"; +$SKU = "2019-DATACENTER-GENSECOND"; +$securityType = "TrustedLaunch"; +$secureboot = $true; +$vtpm = $true; + +# NRP +$subnet = New-AzVirtualNetworkSubnetConfig -Name ('subnet' + $rgname) -AddressPrefix "10.0.0.0/24"; +$vnet = New-AzVirtualNetwork -Force -Name ('vnet' + $rgname) -ResourceGroupName $rgname -Location $loc -AddressPrefix "10.0.0.0/16" -Subnet $subnet; +$vnet = Get-AzVirtualNetwork -Name ('vnet' + $rgname) -ResourceGroupName $rgname; +$subnetId = $vnet.Subnets[0].Id; + +# New VMSS Parameters +$vmssName = 'vmss' + $rgname; +$vmssType = 'Microsoft.Compute/virtualMachineScaleSets'; +$adminUsername = <USER NAME>; +$adminPassword = <PASSWORD> | ConvertTo-SecureString -AsPlainText -Force; +$imgRef = New-Object -TypeName 'Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImage'; +$imgRef.PublisherName = $PublisherName; +$imgRef.Offer = $Offer; +$imgRef.Skus = $SKU; +$imgRef.Version = "latest"; +$ipCfg = New-AzVmssIpConfig -Name 'test' -SubnetId $subnetId; + +$vmss = New-AzVmssConfig -Location $loc -SkuCapacity 2 -SkuName $vmssSize -UpgradePolicyMode 'Manual' ` +| Add-AzVmssNetworkInterfaceConfiguration -Name 'test' -Primary $true -IPConfiguration $ipCfg ` +| Set-AzVmssOsProfile -ComputerNamePrefix 'test' -AdminUsername $adminUsername -AdminPassword $adminPassword ` +| Set-AzVmssStorageProfile -OsDiskCreateOption 'FromImage' -OsDiskCaching 'ReadOnly' ` + -ImageReferenceOffer $imgRef.Offer -ImageReferenceSku $imgRef.Skus -ImageReferenceVersion $imgRef.Version ` + -ImageReferencePublisher $imgRef.PublisherName ; + +# Requirements for the Guest Attestation defaulting behavior. +# SecurityType is TrustedLaunch, EnableVtpm is true, EnableSecureBoot is true, DisableIntegrityMonitoring is not true. +$vmss = Set-AzVmssSecurityProfile -VirtualMachineScaleSet $vmss -SecurityType $securityType; +$vmss = Set-AzVmssUefi -VirtualMachineScaleSet $VMSS -EnableVtpm $vtpm -EnableSecureBoot $secureboot; + +# Create Vmss +$result = New-AzVmss -ResourceGroupName $rgname -Name $vmssName -VirtualMachineScaleSet $vmss; +# This Vmss and its Vm instances has the GuestAttestation extension installed, and the Identity of SystemAssigned. +``` + +Create a VMSS with the Guest Attestation extension installed with the TrustedLaunch security type + +### Example 5: Create a Vmss with the security type TrustedLaunch +```powershell +$rgname = "rganme"; +$loc = "eastus"; +New-AzResourceGroup -Name $rgname -Location $loc -Force; +# VMSS Profile & Hardware requirements for the TrustedLaunch default behavior. +$vmssSize = 'Standard_D4s_v3'; +$vmssName1 = 'vmss1' + $rgname; +$vmssName2 = 'vmss2' + $rgname; +$imageName = "Win2016DataCenterGenSecond"; +$adminUsername = "<Username>"; +$adminPassword = "<Password>" | ConvertTo-SecureString -AsPlainText -Force; +$vmCred = New-Object System.Management.Automation.PSCredential ($adminUsername, $adminPassword); + +# VMSS Creation +$result = New-AzVmss -Credential $vmCred -VMScaleSetName $vmssName1 -ImageName $imageName -SecurityType "TrustedLaunch"; +# Validate that for -SecurityType "TrustedLaunch" "-Vtpm" and -"SecureBoot" are "Enabled/true" +# $result.VirtualMachineProfile.SecurityProfile.UefiSettings.VTpmEnabled $true; +# $result.VirtualMachineProfile.SecurityProfile.UefiSettings.SecureBootEnabled $true; +``` +This example Creates a new VMSS with the new Security Type 'TrustedLaunch'. + +## PARAMETERS + +### -AllocationMethod +Allocation method for the Public IP Address of the Scale Set (Static or Dynamic). If no value is supplied, allocation will be static. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: +Accepted values: Static, Dynamic + +Required: False +Position: Named +Default value: Static +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendPoolName +The name of the backend address pool to use in the load balancer for this Scale Set. If no value is provided, a new backend pool will be created, with the same name as the Scale Set. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendPort +Backend port numbers used by the Scale Set load balancer to communicate with VMs in the Scale Set. If no values are specified, ports 3389 and 5985 will be used for Windows VMS, and port 22 will be used for Linux VMs. + +```yaml +Type: System.Int32[] +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapacityReservationGroupId +Id of the capacity reservation Group that is used to allocate. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The administrator credentials (username and password) for VMs in this Scale Set. <br><br> +**Username** <br> +**Restriction:** <br> +Windows: Cannot contain special characters \/""[]:|<>+=;,?*@& or end in \".\" <br> +Linux: Username must only contain letters, numbers, hyphens, and underscores and may not start with a hyphen or number. <br> +**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\". <br> +**Minimum-length:** 1 character <br> +**Max-length:** 20 characters for Windows, 64 characters for Linux <br> +**Password** <br> +Must have 3 of the following: 1 lower case character, 1 upper case character, 1 number, and 1 special character. <br> +The value must be between 12 and 123 characters long. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: SimpleParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataDiskSizeInGb +Specifies the sizes of data disks in GB. + +```yaml +Type: System.Int32[] +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableIntegrityMonitoring +This flag disables the default behavior to install the Guest Attestation extension to the virtual machine scale set and its vm instances if: 1) SecurityType is TrustedLaunch, 2) SecureBootEnabled on the SecurityProfile is true, 3) VTpmEnabled on the SecurityProfile is true. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskControllerType +Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://learn.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://learn.microsoft.com/rest/api/compute/resourceskus/list) . <br> For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainNameLabel +The domain name label for the public Fully-Qualified domain name (FQDN) for this Scale Set. This is the first component of the domain name that is automatically assigned to the Scale Set. Automatically assigned Domain names use the form (`<DomainNameLabel>.<Location>.cloudapp.azure.com`). If no value is supplied, the default domain name label will be the concatenation of `<ScaleSetName>` and `<ResourceGroupName>`. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +Sets the edge zone name. If set, the query will be routed to the specified edgezone instead of the main region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableUltraSSD +Use UltraSSD disks for the VMs in the scale set. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionAtHost +This parameter will enable the encryption for all the disks including Resource/Temp disk at host itself. +Default: The Encryption at host will be disabled unless this property is set to true for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EvictionPolicy +The eviction policy for the low priority virtual machine scale set. Only supported values are 'Deallocate' and 'Delete'. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendPoolName +The name of the frontend address pool to use in the Scale Set load balancer. If no value is supplied, a new Frontend Address Pool will be created, with the same name as the scale set. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostGroupId +Specifies the dedicated host group the virtual machine scale set will reside in. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: HostGroup + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ImageName +The alias of the image for VMs in this Scale Set. If no value is provided, the "Windows Server 2016 DataCenter" image will be used. The available aliases are: Win2022AzureEditionCore, Win2019Datacenter, Win2016Datacenter, Win2012R2Datacenter, Win2012Datacenter, UbuntuLTS, Ubuntu2204, CentOS, CentOS85Gen2, Debian, Debian11, OpenSuseLeap154Gen2, RHEL, RHELRaw8LVMGen2, SuseSles15SP3, FlatcarLinuxFreeGen2. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: Image + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceId +Specified the shared gallery image unique id for vmss deployment. This can be fetched from shared gallery image GET call. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceCount +The number of VM images in the Scale Set. If no value is provided, 2 instances will be created. + +```yaml +Type: System.Int32 +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: 2 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerName +The name of the load balancer to use with this Scale Set. A new load balancer using the same name as the Scale Set will be created if no value is specified. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The Azure location where this Scale Set will be created. If no value is specified, the location will be inferred from the location of other resources referenced in the parameters. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPrice +The max price of the billing of a low priority virtual machine scale set. + +```yaml +Type: System.Double +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NatBackendPort +Backend port for inbound network address translation. + +```yaml +Type: System.Int32[] +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrchestrationMode +Specifies the orchestration mode for the virtual machine scale set. Possible values: Uniform, Flexible + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PlatformFaultDomainCount +Fault Domain count for each placement group. + +```yaml +Type: System.Int32 +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Priority +The priority for the virtual machine in the scale set. Only supported values are 'Regular', 'Spot' and 'Low'. +'Regular' is for regular virtual machine. +'Spot' is for spot virtual machine. +'Low' is also for spot virtual machine but is replaced by 'Spot'. Please use 'Spot' instead of 'Low'. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProximityPlacementGroupId +The resource id of the Proximity Placement Group to use with this scale set. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: ProximityPlacementGroup + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddressName +The name of the public IP Address to use with this scale set. A new Public IPAddress with the same name as the Scale Set will be created if no value is provided. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the VMSS. If no value is specified, a new ResourceGroup will be created using the same name as the Scale Set. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScaleInPolicy +The rules to be followed when scaling-in a virtual machine scale set. Possible values are: 'Default', 'OldestVM' and 'NewestVM'. 'Default' when a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. 'OldestVM' when a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. 'NewestVM' when a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal. + +```yaml +Type: System.String[] +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityGroupName +The name of the network security group to apply to this Scale Set. If no value is provided, a default network security group with the same name as the Scale Set will be created and applied to the Scale Set. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedGalleryImageId +Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SinglePlacementGroup +Use this to create the Scale set in a single placement group, default is multiple groups + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipExtensionsOnOverprovisionedVMs +Specifies that the extensions do not run on the extra overprovisioned VMs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetAddressPrefix +The address prefix of the Subnet this ScaleSet will use. Default Subnet settings (192.168.1.0/24) will be applied if no value is provided. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: 192.168.1.0/24 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetName +The name of the subnet to use with this Scale Set. A new Subnet will be created with the same name as the Scale Set if no value is provided. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemAssignedIdentity +If the parameter is present then the VM(s) in the scale set is(are) assigned a managed system identity that is auto generated. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradePolicyMode +The upgrade policy mode for VM instances in this Scale Set. Upgrade policy could specify Automatic, Manual, or Rolling upgrades. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.UpgradeMode +Parameter Sets: SimpleParameterSet +Aliases: +Accepted values: Automatic, Manual, Rolling + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The name of a managed service identity that should be assigned to the VM(s) in the scale set. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserData +UserData for the Vmss, which will be base-64 encoded. Customer should not pass any secrets in here. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specifies the **VirtualMachineScaleSet** object that contains the properties of the VMSS that this cmdlet creates. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualNetworkName +The name fo the Virtual Network to use with this scale set. If no value is supplied, a new virtual network with the same name as the Scale Set will be created. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMScaleSetName +Specifies the name of the VMSS that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VmSize +The size of the VM instances in this scale set. [Get-AzComputeResourceSku](https://learn.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku) can be used to find out available sizes for your subscription and region. A default size (Standard_DS1_v2) will be used if no Size is specified. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: Standard_DS1_v2 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetAddressPrefix +The address prefix for the virtual network used with this Scale Set. Default virtual network address prefix settings (192.168.0.0/16) will be used if no value is supplied. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: 192.168.0.0/16 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +A list of availability zones denoting the IP allocated for the resource needs to come from. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[Get-AzVmss](./Get-AzVmss.md) + +[Remove-AzVmss](./Remove-AzVmss.md) + +[Restart-AzVmss](./Restart-AzVmss.md) + +[Set-AzVmss](./Set-AzVmss.md) + +[Start-AzVmss](./Start-AzVmss.md) + +[Stop-AzVmss](./Stop-AzVmss.md) + +[Update-AzVmss](./Update-AzVmss.md) diff --git a/azps-10.1.0/Az.Compute/New-AzVmssConfig.md b/azps-10.1.0/Az.Compute/New-AzVmssConfig.md new file mode 100644 index 0000000000..0e25698ef7 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzVmssConfig.md @@ -0,0 +1,1120 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: CE32F620-8DB2-4004-8012-F1C4AA235B60 +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azvmssconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmssConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmssConfig.md +--- + +# New-AzVmssConfig + +## SYNOPSIS +Creates a VMSS configuration object. + +## SYNTAX + +### DefaultParameterSet (Default) +``` +New-AzVmssConfig [[-Overprovision] <Boolean>] [[-Location] <String>] [-EdgeZone <String>] [[-Tag] <Hashtable>] + [[-SkuName] <String>] [[-SkuTier] <String>] [[-SkuCapacity] <Int32>] [[-UpgradePolicyMode] <UpgradeMode>] + [[-OsProfile] <VirtualMachineScaleSetOSProfile>] [[-StorageProfile] <VirtualMachineScaleSetStorageProfile>] + [[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>] + [[-Extension] <PSVirtualMachineScaleSetExtension[]>] [-SkipExtensionsOnOverprovisionedVMs] + [-SinglePlacementGroup <Boolean>] [-ZoneBalance] [-PlatformFaultDomainCount <Int32>] [-Zone <String[]>] + [-PlanName <String>] [-PlanPublisher <String>] [-PlanProduct <String>] [-PlanPromotionCode <String>] + [-RollingUpgradePolicy <RollingUpgradePolicy>] [-EnableAutomaticRepair] [-AutomaticRepairGracePeriod <String>] + [-AutoOSUpgrade] [-DisableAutoRollback <Boolean>] [-EnableUltraSSD] [-HealthProbeId <String>] + [-BootDiagnostic <BootDiagnostics>] [-LicenseType <String>] [-Priority <String>] [-EnableSpotRestore] + [-SpotRestoreTimeout <String>] [-EvictionPolicy <String>] [-MaxPrice <Double>] [-TerminateScheduledEvents] + [-TerminateScheduledEventNotBeforeTimeoutInMinutes <Int32>] [-ProximityPlacementGroupId <String>] + [-ScaleInPolicy <String[]>] [-EncryptionAtHost] [-OrchestrationMode <String>] + [-CapacityReservationGroupId <String>] [-UserData <String>] [-AutomaticRepairAction <String>] + [-BaseRegularPriorityCount <Int32>] [-RegularPriorityPercentage <Int32>] [-ImageReferenceId <String>] + [-SharedGalleryImageId <String>] [-OSImageScheduledEventEnabled] + [-OSImageScheduledEventNotBeforeTimeoutInMinutes <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ExplicitIdentityParameterSet +``` +New-AzVmssConfig [[-Overprovision] <Boolean>] [[-Location] <String>] [-EdgeZone <String>] [[-Tag] <Hashtable>] + [[-SkuName] <String>] [[-SkuTier] <String>] [[-SkuCapacity] <Int32>] [[-UpgradePolicyMode] <UpgradeMode>] + [[-OsProfile] <VirtualMachineScaleSetOSProfile>] [[-StorageProfile] <VirtualMachineScaleSetStorageProfile>] + [[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>] + [[-Extension] <PSVirtualMachineScaleSetExtension[]>] [-SkipExtensionsOnOverprovisionedVMs] + [-SinglePlacementGroup <Boolean>] [-ZoneBalance] [-PlatformFaultDomainCount <Int32>] [-Zone <String[]>] + [-PlanName <String>] [-PlanPublisher <String>] [-PlanProduct <String>] [-PlanPromotionCode <String>] + [-RollingUpgradePolicy <RollingUpgradePolicy>] [-EnableAutomaticRepair] [-AutomaticRepairGracePeriod <String>] + [-AutoOSUpgrade] [-DisableAutoRollback <Boolean>] [-EnableUltraSSD] [-HealthProbeId <String>] + [-BootDiagnostic <BootDiagnostics>] [-LicenseType <String>] [-Priority <String>] [-EnableSpotRestore] + [-SpotRestoreTimeout <String>] [-EvictionPolicy <String>] [-MaxPrice <Double>] [-TerminateScheduledEvents] + [-TerminateScheduledEventNotBeforeTimeoutInMinutes <Int32>] [-ProximityPlacementGroupId <String>] + [-ScaleInPolicy <String[]>] -IdentityType <ResourceIdentityType> [-IdentityId <String[]>] [-EncryptionAtHost] + [-OrchestrationMode <String>] [-CapacityReservationGroupId <String>] [-UserData <String>] + [-AutomaticRepairAction <String>] [-BaseRegularPriorityCount <Int32>] [-RegularPriorityPercentage <Int32>] + [-ImageReferenceId <String>] [-SharedGalleryImageId <String>] [-OSImageScheduledEventEnabled] + [-OSImageScheduledEventNotBeforeTimeoutInMinutes <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVmssConfig** cmdlet creates a configurable local Virtual Manager Scale Set (VMSS) +object. <br> + +Use the following cmdlets to configure the VMSS object: +- **[Add-AzVmssNetworkInterfaceConfiguration](https://learn.microsoft.com/en-us/powershell/module/az.compute/add-azvmssnetworkinterfaceconfiguration)** to set the network profile.<br> +- **[Set-AzVmssOsProfile](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmssosprofile)** to set the OS profile. <br> +- **[Set-AzVmssStorageProfile](https://learn.microsoft.com/en-us/powershell/module/az.compute/set-azvmssstorageprofile)** to set the storage profile.<br> +- **[Get-AzComputeResourceSku](https://learn.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku)** can also be used to find out available virtual machine sizes for your subscription and region.<br><br> + +See other cmdlets for virtual machine scale set [here](https://learn.microsoft.com/en-us/powershell/module/az.compute/#vm-scale-sets).<br> +<br> +See [Quickstart: Create a virtual machine scale set with Azure PowerShell](https://learn.microsoft.com/en-us/azure/virtual-machine-scale-sets/quick-create-powershell) for tutorial. + +## EXAMPLES + +### Example 1: Create a VMSS configuration object +```powershell +$VMSS = New-AzVmssConfig -Location $Loc -SkuCapacity 2 -SkuName "Standard_A0" -UpgradePolicyMode "Automatic" -NetworkInterfaceConfiguration $NetCfg ` + | Add-AzVmssNetworkInterfaceConfiguration -Name "Test" -Primary $True -IPConfiguration $IPCfg ` + | Set-AzVmssOsProfile -ComputerNamePrefix "Test" -AdminUsername $adminUsername -AdminPassword $AdminPassword ` + | Set-AzVmssStorageProfile -Name "Test" -OsDiskCreateOption "FromImage" -OsDiskCaching "None" ` + -ImageReferenceOffer $ImgRef.Offer -ImageReferenceSku $ImgRef.Skus -ImageReferenceVersion $ImgRef.Version ` + -ImageReferencePublisher $ImgRef.PublisherName -VhdContainer $VHDContainer ` + | Add-AzVmssAdditionalUnattendContent -ComponentName $AUCComponentName -Content $AUCContent -PassName $AUCPassName -SettingName $AUCSetting; + +New-AzVmss -ResourceGroupName $RGName -Name $VMSSName -VirtualMachineScaleSet $VMSS; +``` + +This example creates a VMSS configuration object. The first command uses the +**New-AzVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the +variable named $VMSS. The second command uses the **New-AzVmss** cmdlet to create a VMSS that +uses the VMSS configuration object created in the first command. + +### Example 2 + +Creates a VMSS configuration object. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzVmssConfig -Location <String> -Overprovision $false -SkuCapacity 2 -SkuName 'Standard_A0' -Tag @{key0="value0";key1=$null;key2="value2"} -UpgradePolicyMode Automatic; +``` + +### Example 3 + +Creates a VMSS configuration object. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzVmssConfig -Location <String> -SkuCapacity 2 -SkuName 'Standard_A0' -UpgradePolicyMode Automatic -IdentityType SystemAssigned; +``` + +### Example 4: Create a VMSS with the OS Image Scheduled Events enabled +```powershell +$publisher = "MicrosoftWindowsServer"; +$offer = "WindowsServer"; +$imgSku = "2019-Datacenter"; +$version = "latest"; +$vmssName = 'vmss' + $rgname; +$vmssSku = "Standard_D2s_v3"; +$vmssname = "vmss" + $rgname; +$domainNameLabel = "d" + $rgname; +$username = <Username>; +$password = <Password>; +$securePassword = $password | ConvertTo-SecureString -AsPlainText -Force + +$credential = New-Object System.Management.Automation.PSCredential ($username, $securePassword); + +# SRP +$stoname = 'sto' + $rgname; +$stotype = 'Standard_GRS'; +New-AzStorageAccount -ResourceGroupName $rgname -Name $stoname -Location $loc -Type $stotype; +$stoaccount = Get-AzStorageAccount -ResourceGroupName $rgname -Name $stoname; + +# NRP +$subnet = New-AzVirtualNetworkSubnetConfig -Name ('subnet' + $rgname) -AddressPrefix "10.0.0.0/24"; +$vnet = New-AzVirtualNetwork -Force -Name ('vnet' + $rgname) -ResourceGroupName $rgname -Location $loc -AddressPrefix "10.0.0.0/16" -Subnet $subnet; +$vnet = Get-AzVirtualNetwork -Name ('vnet' + $rgname) -ResourceGroupName $rgname; +$subnetId = $vnet.Subnets[0].Id; + +# Create VMSS with managed disk +$timeoutValue = 'PT15M'; +$ipCfg = New-AzVmssIpConfig -Name 'test' -SubnetId $subnetId; +$vmss = New-AzVmssConfig -Location $loc -SkuCapacity 2 -SkuName $vmssSku -OSImageScheduledEventEnabled -OSImageScheduledEventNotBeforeTimeoutInMinutes $timeoutValue -UpgradePolicyMode "Automatic" ` + | Add-AzVmssNetworkInterfaceConfiguration -Name 'test' -Primary $true -IPConfiguration $ipCfg ` + | Set-AzVmssOsProfile -ComputerNamePrefix 'test' -AdminUsername $username -AdminPassword $password ` + | Set-AzVmssStorageProfile -OsDiskCreateOption 'FromImage' -OsDiskCaching 'None' ` + -ImageReferenceOffer $offer -ImageReferenceSku $imgSku -ImageReferenceVersion $version ` + -ImageReferencePublisher $publisher; + +$result = New-AzVmss -ResourceGroupName $rgname -Name $vmssName -VirtualMachineScaleSet $vmss; + +$vmss = Get-AzVmss -ResourceGroupName $rgname -VMScaleSetName $vmssName; +# $vmss.VirtualMachineProfile.ScheduledEventsProfile.OsImageNotificationProfile.Enable is the OSImageScheduledEventEnabled flag. +# $vmss.VirtualMachineProfile.ScheduledEventsProfile.OsImageNotificationProfile.NotBeforeTimeout is the timeout value 'PT15M'. + +``` + +### Example 5: Create a Vmss with the security type TrustedLaunch +```powershell + $rgname = "rganme"; + $loc = "eastus"; + New-AzResourceGroup -Name $rgname -Location $loc -Force; +# VMSS Profile & Hardware requirements for the TrustedLaunch default behavior. +$vmssSize = 'Standard_D4s_v3'; +$PublisherName = "MicrosoftWindowsServer"; +$Offer = "WindowsServer"; +$SKU = "2016-datacenter-gensecond"; +$securityType = "TrustedLaunch"; +$enable = $true; +$disable = $false; +$extDefaultName = "GuestAttestation"; +$vmGADefaultIDentity = "SystemAssigned"; + +# NRP +$subnet = New-AzVirtualNetworkSubnetConfig -Name ('subnet' + $rgname) -AddressPrefix "10.0.0.0/24"; +$vnet = New-AzVirtualNetwork -Force -Name ('vnet' + $rgname) -ResourceGroupName $rgname -Location $loc -AddressPrefix "10.0.0.0/16" -Subnet $subnet; +$vnet = Get-AzVirtualNetwork -Name ('vnet' + $rgname) -ResourceGroupName $rgname; +$subnetId = $vnet.Subnets[0].Id; + +# New VMSS Parameters +$vmssName1 = 'vmss1' + $rgname; +$vmssName2 = 'vmss2' + $rgname; +$vmssType = 'Microsoft.Compute/virtualMachineScaleSets'; +$adminUsername = <Username>; +$adminPassword = <Password> | ConvertTo-SecureString -AsPlainText -Force; +$imgRef = New-Object -TypeName 'Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImage'; +$imgRef.PublisherName = $PublisherName; +$imgRef.Offer = $Offer; +$imgRef.Skus = $SKU; +$imgRef.Version = "latest"; +$ipCfg = New-AzVmssIpConfig -Name 'test' -SubnetId $subnetId; + +$vmss = New-AzVmssConfig -Location $loc -SkuCapacity 2 -SkuName $vmssSize -UpgradePolicyMode 'Manual' ` + | Add-AzVmssNetworkInterfaceConfiguration -Name 'test' -Primary $true -IPConfiguration $ipCfg ` + | Set-AzVmssOsProfile -ComputerNamePrefix 'test' -AdminUsername $adminUsername -AdminPassword $adminPassword ` + | Set-AzVmssStorageProfile -OsDiskCreateOption 'FromImage' -OsDiskCaching 'ReadOnly' ` + -ImageReferenceOffer $imgRef.Offer -ImageReferenceSku $imgRef.Skus -ImageReferenceVersion $imgRef.Version ` + -ImageReferencePublisher $imgRef.PublisherName; + +# VMSS Creation using VMSSConfig for Trusted Launch SecurityType +$vmss1 = Set-AzVmssSecurityProfile -VirtualMachineScaleSet $vmss -SecurityType $securityType; +$result = New-AzVmss -ResourceGroupName $rgname -VMScaleSetName $vmssName1 -VirtualMachineScaleSet $vmss1; +$vmssGet = Get-AzVmss -ResourceGroupName $rgname -VMScaleSetName $vmssName1; + +# Validate that for -SecurityType "TrustedLaunch" "-Vtpm" and -"SecureBoot" are "Enabled/true" +#$vmssGet.VirtualMachineProfile.SecurityProfile.UefiSettings.VTpmEnabled $true; +#$vmssGet.VirtualMachineProfile.SecurityProfile.UefiSettings.SecureBootEnabled $true; + +``` + +This example Creates a new VMSS using VMSSConfig object for the Trusted Launch Security Type and validates flags SecureBoot and Vtpm as True by default. + +## PARAMETERS + +### -AutomaticRepairAction +Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutomaticRepairGracePeriod +The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutoOSUpgrade +Sets whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BaseRegularPriorityCount +Specifies the minimum number of VMs that must be of Regular priority as a VMSS Flex instance scales out. This parameter is only valid for VMSS instances with Flexible OrchestrationMode. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BootDiagnostic +Specifies the virtual machine scale set boot diagnostics profile. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.BootDiagnostics +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CapacityReservationGroupId +Id of the capacity reservation Group that is used to allocate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAutoRollback +Disable Auto Rollback for Auto OS Upgrade Policy + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +Sets the edge zone name. If set, the query will be routed to the specified edgezone instead of the main region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableAutomaticRepair +Enables automatic repairs on the virtual machine scale set. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableSpotRestore +Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableUltraSSD +Enables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the virtual machine scale set. +Managed disks with storage account type UltraSSD_LRS can be added to a VMSS only if this property is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptionAtHost +This parameter will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EvictionPolicy +Specifies the eviction policy for the virtual machines in the scale set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Extension +Specifies the extension information object for the VMSS. You can use the +**Add-AzVmssExtension** cmdlet to add this object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HealthProbeId +Specifies the ID of a load balancer probe used to determine the health of an instance in the virtual machine scale set. +HealthProbeId is in the form of '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityId +Specifies the list of user identities associated with the virtual machine scale set. +The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' + +```yaml +Type: System.String[] +Parameter Sets: ExplicitIdentityParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityType +Specifies the type of identity used for the virtual machine scale set. +The type 'SystemAssignedUserAssigned' includes both an implicitly created identity and a set of user assigned identities. +The type 'None' will remove any identities from the virtual machine scale set. +The acceptable values for this parameter are: +- SystemAssigned +- UserAssigned +- SystemAssignedUserAssigned +- None + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.ResourceIdentityType] +Parameter Sets: ExplicitIdentityParameterSet +Aliases: +Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ImageReferenceId +Specified the gallery image unique id for vmss deployment. This can be fetched from gallery image GET call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +Specify the license type, which is for bringing your own license scenario. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the Azure location where the VMSS is created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxPrice +Specifies the maximum price you are willing to pay for a Spot VM/VMSS. This price is in US Dollars. This price will be compared with the current Spot price for the VM size. Also, the prices are compared at the time of create/update of Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Spot price. The maxPrice will also be used for evicting a Spot VM/VMSS if the current Spot price goes beyond the maxPrice after creation of VM/VMSS. Possible values are: any decimal value greater than zero. Example: 0.01538. -1 indicates that the Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkInterfaceConfiguration +Specifies the network profile object that contains the networking properties for the VMSS configuration. +You can use the **Add-AzVmssNetworkInterfaceConfiguration** cmdlet to add this object. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetNetworkConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OrchestrationMode +Specifies the orchestration mode for the virtual machine scale set. Possible values: Uniform, Flexible + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OSImageScheduledEventEnabled +Specifies whether the OS Image Scheduled event is enabled or disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSImageScheduledEventNotBeforeTimeoutInMinutes +The length of time a virtual machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, with the value set to 15 minutes (PT15M). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsProfile +Specifies the operating system profile object that contains the operating system properties for the VMSS configuration. +You can use the **Set-AzVmssOsProfile** cmdlet to set this object. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetOSProfile +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Overprovision +Indicates whether the cmdlet overprovisions the VMSS. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PlanName +Specifies the plan name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PlanProduct +Specifies the plan product. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PlanPromotionCode +Specifies the plan promotion code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PlanPublisher +Specifies the plan publisher. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PlatformFaultDomainCount +Fault Domain count for each placement group. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Priority +The priority for the virtual machien in the scale set. Only supported values are 'Regular', 'Spot' and 'Low'. +'Regular' is for regular virtual machine. +'Spot' is for spot virtual machine. +'Low' is also for spot virtual machine but is replaced by 'Spot'. Please use 'Spot' instead of 'Low'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProximityPlacementGroupId +The resource id of the Proximity Placement Group to use with this scale set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RegularPriorityPercentage +Specifies the desired percentage of VMs, after the BaseRegularCount has been met, that are of Regular priority as the VMSS Flex instance scales out. This property is only valid for VMSS instances with Flexible OrchestrationMode. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RollingUpgradePolicy +Specifies the rolling upgrade policy. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.RollingUpgradePolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScaleInPolicy +The rules to be followed when scaling-in a virtual machine scale set. Possible values are: 'Default', 'OldestVM' and 'NewestVM'. 'Default' when a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. 'OldestVM' when a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. 'NewestVM' when a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SharedGalleryImageId +Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SinglePlacementGroup +Specifies the single placement group. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipExtensionsOnOverprovisionedVMs +Specifies that the extensions do not run on the extra overprovisioned VMs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Specifies the number of instances in the VMSS. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuName +Specifies the size of all the instances of VMSS. [Get-AzComputeResourceSku](https://learn.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku) can be used to find out available sizes for your subscription and region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountType + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuTier +Specifies the tier of VMSS. The acceptable values for this parameter are: +- Standard +- Basic + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SpotRestoreTimeout +Specifies timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageProfile +Specifies the storage profile object that contains the disk properties for the VMSS configuration. +You can use the **Set-AzVmssStorageProfile** cmdlet to set this object. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetStorageProfile +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TerminateScheduledEventNotBeforeTimeoutInMinutes +Configurable length of time (in minutes) a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TerminateScheduledEvents +Enable the Terminate Scheduled events + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UpgradePolicyMode +Specified the mode of an upgrade to virtual machines in the scale set. +The acceptable values for this parameter are: +- Automatic +- Manual + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.UpgradeMode] +Parameter Sets: (All) +Aliases: +Accepted values: Automatic, Manual, Rolling + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserData +UserData for the VM, which will be base-64 encoded. Customer should not pass any secrets in here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +Specifies the zone list for the virtual machine scale set. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ZoneBalance +Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String + +### System.Collections.Hashtable + +### System.Int32 + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.UpgradeMode, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetOSProfile + +### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetStorageProfile + +### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetNetworkConfiguration[] + +### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetExtension[] + +### System.String[] + +### Microsoft.Azure.Management.Compute.Models.RollingUpgradePolicy + +### System.Management.Automation.SwitchParameter + +### Microsoft.Azure.Management.Compute.Models.BootDiagnostics + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.ResourceIdentityType, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[Set-AzVmssOsProfile](./Set-AzVmssOsProfile.md) + +[Set-AzVmssStorageProfile](./Set-AzVmssStorageProfile.md) + +[Add-AzVmssNetworkInterfaceConfiguration](./Add-AzVmssNetworkInterfaceConfiguration.md) + +[Add-AzVmssExtension](./Add-AzVmssExtension.md) + +[New-AzVmss](./New-AzVmss.md) diff --git a/azps-10.1.0/Az.Compute/New-AzVmssGalleryApplication.md b/azps-10.1.0/Az.Compute/New-AzVmssGalleryApplication.md new file mode 100644 index 0000000000..10fb3c2760 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzVmssGalleryApplication.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azvmssgalleryapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmssGalleryApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmssGalleryApplication.md +--- + +# New-AzVmssGalleryApplication + +## SYNOPSIS +Create a local PSVMGalleryApplication object. + +## SYNTAX + +``` +New-AzVmssGalleryApplication -PackageReferenceId <String> [-ConfigReferenceId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a local PSVMGalleryApplication object. + +## EXAMPLES + +### Example 1 +```powershell +$vmss = Get-AzVmss -ResourceGroupName $rgName -Name $vmssName +$vmGal = New-AzVmssGalleryApplication -PackageReferenceId $packageRefId -ConfigReferenceId $configRefId +Add-AzVmssGalleryApplication -VirtualMachineScaleSetVM $vmss.VirtualMachineProfile -GalleryApplication $vmGal -Order 1 +``` + +This example creates a local VMGalleryApplication object and adds it to a PSVirtualMachineScaleSetVM object. + +## PARAMETERS + +### -ConfigReferenceId +Configuration Reference Id of the Gallery Application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageReferenceId +Package Reference Id of the Gallery Application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.Compute.Models.VMGalleryApplication + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzVmssIpConfig.md b/azps-10.1.0/Az.Compute/New-AzVmssIpConfig.md new file mode 100644 index 0000000000..37443c6249 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzVmssIpConfig.md @@ -0,0 +1,341 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 92F192A5-F75E-4EFE-B2D2-B0DF0B78D3B5 +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azvmssipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmssIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmssIpConfig.md +--- + +# New-AzVmssIpConfig + +## SYNOPSIS +Creates an IP configuration for a network interface of a VMSS. + +## SYNTAX + +``` +New-AzVmssIpConfig [[-Name] <String>] [[-Id] <String>] [[-SubnetId] <String>] + [[-ApplicationGatewayBackendAddressPoolsId] <String[]>] [[-LoadBalancerBackendAddressPoolsId] <String[]>] + [[-LoadBalancerInboundNatPoolsId] <String[]>] [-Primary] [-PrivateIPAddressVersion <String>] + [-PublicIPAddressConfigurationName <String>] [-PublicIPAddressConfigurationIdleTimeoutInMinutes <Int32>] + [-DnsSetting <String>] [-IpTag <VirtualMachineScaleSetIpTag[]>] [-PublicIPPrefix <String>] + [-PublicIPAddressVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVmssIpConfig** cmdlet creates an IP configuration object for a network interface of a Virtual Machine Scale Set (VMSS). +Specify the configuration from this cmdlet as the *IPConfiguration* parameter of the Add-AzVmssNetworkInterfaceConfiguration cmdlet. + +## EXAMPLES + +### Example 1: Create an IP configuration object for a VMSS interface +```powershell +$IPConfiguration = New-AzVmssIPConfig -Name "ContosoVmssInterface02" -SubnetId $SubnetId +``` + +This command creates an IP configuration object named ContosoVmssInterface02. +The command uses a previously defined subnet ID stored in $SubnetId. +The command stores the configuration settings in the $IPConfiguration variable for later use with **Add-AzVmssNetworkInterfaceConfiguration**. + +### Example 2: Create an IP configuration object that includes NAT pool settings +```powershell +$IPConfiguration = New-AzVmssIPConfig -Name "ContosoVmssInterface03" -LoadBalancerInboundNatPoolsId $expectedLb.InboundNatPools[0].Id -LoadBalancerBackendAddressPoolsId $expectedLb.BackendAddressPools[0].Id -SubnetId $SubnetId +``` + +This command creates an IP configuration object named ContosoVmssInterface03, and then stores it in the $IPConfiguration variable for later use. +The command uses a previously defined subnet ID stored in $SubnetId. +The command stores the configuration settings in the $IPConfiguration variable for later use. +The command specifies values for the *LoadBalancerInboundNatPoolsId* and *LoadBalancerBackendAddressPoolsId* parameters. + +## PARAMETERS + +### -ApplicationGatewayBackendAddressPoolsId +Specifies an array of references to backend address pools of load balancers. +A scale set can reference backend address pools of one public and one internal load balancer. +Multiple scale sets cannot use the same load balancer. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsSetting +The dns settings to be applied on the publicIP addresses. +The domain name label of the Dns settings to be applied on the publicIP addresses. +The concatenation of the domain name label and vm index will be the domain name labels of the Public IP Address resources that will be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PublicIPAddressDomainNameLabel + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id +Specifies an ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpTag +Specifies an array of Ip Tag objects. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIpTag[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerBackendAddressPoolsId +Specifies an array of references to incoming network address translation (NAT) pools of the load balancers. +A scale set can reference incoming NAT pools of one public and one internal load balancer. +Multiple scale sets cannot use the same load balancer. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerInboundNatPoolsId +Specifies an array of references to incoming NAT pools of the load balancers. +A scale set can reference incoming NAT pools of one public and one internal load balancer. +Multiple scale sets cannot use the same load balancer. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the IP configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Primary +Specifies the primary IP Configuration in case the network interface has more than one IP Configuration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIPAddressVersion +Specify the IP configuration for private IP address. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIPAddressConfigurationIdleTimeoutInMinutes +The idle timeout of the public IP address. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: PublicIPAddressIdleTimeoutInMinutes + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIPAddressConfigurationName +The publicIP address configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PublicIPAddressName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIPAddressVersion +Specify the IP configuration for public IP address. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIPPrefix +The ID of Public IP Prefix + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubnetId +Specifies the subnet ID in which the configuration creates the VMSS network interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Int32 + +### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIpTag[] + +## OUTPUTS + +### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIPConfiguration + +## NOTES + +## RELATED LINKS + +[Add-AzVmssNetworkInterfaceConfiguration](./Add-AzVmssNetworkInterfaceConfiguration.md) + + diff --git a/azps-10.1.0/Az.Compute/New-AzVmssIpTagConfig.md b/azps-10.1.0/Az.Compute/New-AzVmssIpTagConfig.md new file mode 100644 index 0000000000..da7a89c7b0 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzVmssIpTagConfig.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azvmssiptagconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmssIpTagConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmssIpTagConfig.md +--- + +# New-AzVmssIpTagConfig + +## SYNOPSIS +Creates an IP Tag object for a network interface of a VMSS. + +## SYNTAX + +``` +New-AzVmssIpTagConfig [-IpTagType] <String> [-Tag <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVmssIpTagConfig** cmdlet creates an IP Tag configuration object for a network interface of a Virtual Machine Scale Set (VMSS). +Specify the configuration from this cmdlet as the *IPTag* parameter of the New-AzVmssIpConfig cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +$iptag = New-AzVmssIpTagConfig -IpTagType 'FirstPartyUsage' -Tag 'Sql' +$ipCfg = New-AzVmssIPConfig -Name 'test' -SubnetId $subnetId -IpTag $ipTag; +``` + +This command creates an IP Tag local object with 'FirstPartyUsage' type and 'Sql' tag, and then creates an IP configuration with this IP tag. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpTagType +Specifies an IP Tag Type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specifies an IP Tag Value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIpTag + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/New-AzVmssVaultCertificateConfig.md b/azps-10.1.0/Az.Compute/New-AzVmssVaultCertificateConfig.md new file mode 100644 index 0000000000..8bab097d65 --- /dev/null +++ b/azps-10.1.0/Az.Compute/New-AzVmssVaultCertificateConfig.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 5CC89899-00B6-424A-8896-FD32DE9DDA28 +online version: https://learn.microsoft.com/powershell/module/az.compute/new-azvmssvaultcertificateconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmssVaultCertificateConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/New-AzVmssVaultCertificateConfig.md +--- + +# New-AzVmssVaultCertificateConfig + +## SYNOPSIS +Creates a Key Vault certificate configuration. + +## SYNTAX + +``` +New-AzVmssVaultCertificateConfig [[-CertificateUrl] <String>] [[-CertificateStore] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVmssVaultCertificateConfig** cmdlet specifies the secret that needs to be placed on the Virtual Machine Scale Set (VMSS) virtual machines. +The output of this cmdlet is intended to be used with the Add-AzVmssSecret cmdlet. + +## EXAMPLES + +### Example 1: Create a Key Vault certificate configuration +```powershell +New-AzVmssVaultCertificateConfig -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" -CertificateStore "MyCerts" +``` + +This command creates a Key Vault certificate configuration that uses the certificate store named MyCerts located at the specified certificate URL. + +## PARAMETERS + +### -CertificateStore +Specifies the certificate store on the virtual machines in the scale set where the certificate is added. +This is only valid for Windows Virtual Machine Scale Sets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CertificateUrl +Specifies the URI of a certificate stored in the Key Vault. +It is the base64 encoding of the following JSON Object which is encoded in UTF-8: +{ + "data":"\<Base64-encoded-certificate\>", + "dataType":"pfx", + "password":"\<pfx-file-password\>" +} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Compute.Models.VaultCertificate + +## NOTES + +## RELATED LINKS + +[Add-AzVmssSecret](./Add-AzVmssSecret.md) diff --git a/azps-10.1.0/Az.Compute/Publish-AzVMDscConfiguration.md b/azps-10.1.0/Az.Compute/Publish-AzVMDscConfiguration.md new file mode 100644 index 0000000000..a72cdaebc7 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Publish-AzVMDscConfiguration.md @@ -0,0 +1,299 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: FB9ACBA2-081E-4876-A21A-F5BA11CBEDA2 +online version: https://learn.microsoft.com/powershell/module/az.compute/publish-azvmdscconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Publish-AzVMDscConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Publish-AzVMDscConfiguration.md +--- + +# Publish-AzVMDscConfiguration + +## SYNOPSIS +Uploads a DSC script to Azure blob storage. + +## SYNTAX + +### UploadArchive (Default) +``` +Publish-AzVMDscConfiguration [-ResourceGroupName] <String> [-ConfigurationPath] <String> + [[-ContainerName] <String>] [-StorageAccountName] <String> [-StorageEndpointSuffix <String>] [-Force] + [-SkipDependencyDetection] [-ConfigurationDataPath <String>] [-AdditionalPath <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateArchive +``` +Publish-AzVMDscConfiguration [-ConfigurationPath] <String> [[-OutputArchivePath] <String>] [-Force] + [-SkipDependencyDetection] [-ConfigurationDataPath <String>] [-AdditionalPath <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Publish-AzVMDscConfiguration** cmdlet uploads a Desired State Configuration (DSC) script to Azure blob storage, which later can be applied to Azure virtual machines using the Set-AzVMDscExtension cmdlet. + +## EXAMPLES + +### Example 1: Create a .zip package an upload it to Azure storage +```powershell +Publish-AzVMDscConfiguration ".\MyConfiguration.ps1" +``` + +This command creates a .zip package for the given script and any dependent resource modules and uploads it to Azure storage. + +### Example 2: Create a .zip package and store it to a local file +```powershell +Publish-AzVMDscConfiguration ".\MyConfiguration.ps1" -OutputArchivePath ".\MyConfiguration.ps1.zip" +``` + +This command creates a .zip package for the given script and any dependent resource modules and stores it in the local file that is named .\MyConfiguration.ps1.zip. + +### Example 3: Add configuration to the archive and then upload it to storage +```powershell +Publish-AzVMDscConfiguration -ConfigurationPath "C:\Sample.ps1" -SkipDependencyDetection +``` + +This command adds configuration named Sample.ps1 to the configuration archive to upload to Azure storage and skips dependent resource modules. + +### Example 4: Add configuration and configuration data to the archive and then upload it to storage +```powershell +Publish-AzVMDscConfiguration -ConfigurationPath "C:\Sample.ps1" -ConfigurationDataPath "C:\SampleData.psd1" +``` + +This command adds configuration named Sample.ps1 and configuration data named SampleData.psd1 to the configuration archive to upload to Azure storage. + +### Example 5: Add configuration, configuration data, and additional content to the archive and then upload it to storage +```powershell +Publish-AzVMDscConfiguration -ConfigurationPath "C:\Sample.ps1" -AdditionalPath @("C:\ContentDir1", "C:\File.txt") -ConfigurationDataPath "C:\SampleData.psd1" +``` + +This command adds configuration named Sample.ps1, configuration data SampleData.psd1, and additional content to configuration archive to upload to Azure storage. + +## PARAMETERS + +### -AdditionalPath +Specifies the path of a file or a directory to include in the configuration archive. +It gets downloaded to the virtual machine together with the configuration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConfigurationDataPath +Specifies the path of a .psd1 file that specifies the data for the configuration. +This is added to the configuration archive and then passed to the configuration function. +It gets overwritten by the configuration data path provided through the Set-AzVMDscExtension cmdlet + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConfigurationPath +Specifies the path of a file that contains one or more configurations. +The file can be a Windows PowerShell script (.ps1) file or a Windows PowerShell module (.psm1) file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ContainerName +Specifies the name of the Azure storage container the configuration is uploaded to. + +```yaml +Type: System.String +Parameter Sets: UploadArchive +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputArchivePath +Specifies the path of a local .zip file to write the configuration archive to. +When this parameter is used, the configuration script is not uploaded to Azure blob storage. + +```yaml +Type: System.String +Parameter Sets: CreateArchive +Aliases: ConfigurationArchivePath + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the storage account. + +```yaml +Type: System.String +Parameter Sets: UploadArchive +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipDependencyDetection +Indicates that this cmdlet excludes DSC resource dependencies from the configuration archive. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +Specifies the Azure storage account name that is used to upload the configuration script to the container specified by the *ContainerName* parameter. + +```yaml +Type: System.String +Parameter Sets: UploadArchive +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageEndpointSuffix +Specifies the suffix for the storage end point. + +```yaml +Type: System.String +Parameter Sets: UploadArchive +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzVMDscExtension](./Get-AzVMDscExtension.md) + +[Remove-AzVMDscExtension](./Remove-AzVMDscExtension.md) + +[Set-AzVMDscExtension](./Set-AzVMDscExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzAvailabilitySet.md b/azps-10.1.0/Az.Compute/Remove-AzAvailabilitySet.md new file mode 100644 index 0000000000..3e12d38f3b --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzAvailabilitySet.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 7320B832-50FD-48AE-9089-445318F3B08A +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azavailabilityset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzAvailabilitySet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzAvailabilitySet.md +--- + +# Remove-AzAvailabilitySet + +## SYNOPSIS +Removes an availability set from Azure. + +## SYNTAX + +``` +Remove-AzAvailabilitySet [-ResourceGroupName] <String> [[-Name] <String>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzAvailabilitySet** cmdlet removes an availability set from Azure. + +## EXAMPLES + +### Example 1: Remove an availability set +```powershell +Remove-AzAvailabilitySet -Name "AvailabilitySet03" -ResourceGroupName "ResourceGroup11" +``` + +This command removes an availability set named AvailabilitySet03 in the resource group named ResourceGroup11. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The availability set name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, AvailabilitySetName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzAvailabilitySet](./Get-AzAvailabilitySet.md) + +[New-AzAvailabilitySet](./New-AzAvailabilitySet.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzCapacityReservation.md b/azps-10.1.0/Az.Compute/Remove-AzCapacityReservation.md new file mode 100644 index 0000000000..3757589eb8 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzCapacityReservation.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azcapacityreservation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzCapacityReservation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzCapacityReservation.md +--- + +# Remove-AzCapacityReservation + +## SYNOPSIS +Removes a Capacity Reservation resource + +## SYNTAX + +``` +Remove-AzCapacityReservation -ResourceGroupName <String> -ReservationGroupName <String> [-Name <String>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCapacityReservation** cmdlet removes a Capacity Reservation resource + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCapacityReservation -ResourceGroupName "myRG" -ReservationGroupName "myCapacityReservationGroup" -Name "myCapacityReservation" +``` + +This command removes the Capacity Reservation resource. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the capacity reservation resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CapacityReservationName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ReservationGroupName +Specifies the name of the capacity reservation group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CapacityReservationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzCapacityReservationGroup.md b/azps-10.1.0/Az.Compute/Remove-AzCapacityReservationGroup.md new file mode 100644 index 0000000000..2fa746f9b0 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzCapacityReservationGroup.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azcapacityreservationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzCapacityReservationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzCapacityReservationGroup.md +--- + +# Remove-AzCapacityReservationGroup + +## SYNOPSIS +Removes a Capacity Reservation Group + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Remove-AzCapacityReservationGroup -ResourceGroupName <String> -Name <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIDParameterSet +``` +Remove-AzCapacityReservationGroup -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzCapacityReservationGroup -InputObject <PSCapacityReservationGroup> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCapacityReservationGroup** cmdlet removes a Capacity Reservation Group + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCapacityReservationGroup -ResourceGroupName "myRG" -Name "myCapacityReservationGroup" +``` + +This command removes the Capacity Reservation Group. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PowerShell capacity reservation group object + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSCapacityReservationGroup +Parameter Sets: InputObjectParameterSet +Aliases: CapacityReservationGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the capacity reservation group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: CapacityReservationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID for your capacity reservation group. + +```yaml +Type: System.String +Parameter Sets: ResourceIDParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSCapacityReservationGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzDisk.md b/azps-10.1.0/Az.Compute/Remove-AzDisk.md new file mode 100644 index 0000000000..6e2a66c896 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzDisk.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azdisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzDisk.md +--- + +# Remove-AzDisk + +## SYNOPSIS +Removes a disk. + +## SYNTAX + +``` +Remove-AzDisk [-ResourceGroupName] <String> [-DiskName] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDisk** cmdlet removes a disk. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Force; +``` + +This command removes the disk named 'Disk01' in the resource group 'ResourceGroup01'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskName +Specifies the name of a disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzDiskAccess.md b/azps-10.1.0/Az.Compute/Remove-AzDiskAccess.md new file mode 100644 index 0000000000..4df744e732 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzDiskAccess.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzDiskAccess.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzDiskAccess.md +--- + +# Remove-AzDiskAccess + +## SYNOPSIS +Removes a disk access resource. + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Remove-AzDiskAccess [-ResourceGroupName] <String> [-Name] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIDParameterSet +``` +Remove-AzDiskAccess [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzDiskAccess [-InputObject] <PSDiskAccess> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDiskAccess** cmdlet removes a disk access resource. + +## EXAMPLES + +### Example 1: Remove Disk Access using Default Parameter Set +```powershell +Remove-AzDiskAccess -ResourceGroupName "ResourceGroup01" -Name "DiskAccess01" +``` + +This command removes the disk access named "DiskAccess01" in resource group "ResourceGroup01" + +### Example 2: Remove Disk Access using Resource ID +```powershell +$myDiskAccess = Get-AzDiskAccess -ResourceGroupName "ResourceGroup01" -Name "DiskAccess01" +Remove-AzDiskAccess -ResourceId $myDiskAccess.id +``` + +This command removes the disk access by Resource ID + +### Example 3: Remove Disk Access using Input Object +```powershell +$myDiskAccess = Get-AzDiskAccess -ResourceGroupName "ResourceGroup01" -Name "DiskAccess01" +Remove-AzDiskAccess -InputObject $myDiskAccess +``` + +This command removes the disk access by InputObject + +### Example 4: Remove Disk Access by piping Input Object +```powershell +Get-AzDiskAccess -ResourceGroupName "ResourceGroup01" -Name "DiskAccess01" | Remove-AzDiskAccess +``` + +This command removes the disk access by piping the InputObject + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PowerShell Disk Access Object + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskAccess +Parameter Sets: InputObjectParameterSet +Aliases: DiskAccess + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a disk access. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: DiskAccessName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID for your disk access. + +```yaml +Type: System.String +Parameter Sets: ResourceIDParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskAccess + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzDiskEncryptionSet.md b/azps-10.1.0/Az.Compute/Remove-AzDiskEncryptionSet.md new file mode 100644 index 0000000000..2a591567bf --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzDiskEncryptionSet.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azdiskencryptionset.md +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzDiskEncryptionSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzDiskEncryptionSet.md +--- + +# Remove-AzDiskEncryptionSet + +## SYNOPSIS +Removes a disk encryption set. + +## SYNTAX + +### DefaultParameter (Default) +``` +Remove-AzDiskEncryptionSet [-ResourceGroupName] <String> [-Name] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Remove-AzDiskEncryptionSet [-Force] [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameter +``` +Remove-AzDiskEncryptionSet [-Force] [-InputObject] <PSDiskEncryptionSet> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes a disk encryption set. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDiskEncryptionSet -ResourceGroupName 'rg1' -Name 'enc1' -Force; +``` + +Delete disk encryption set 'enc1' in 'rg1' + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The local object of the disk encryption set. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskEncryptionSet +Parameter Sets: ObjectParameter +Aliases: DiskEncryptionSet + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of disk encryption set. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: DiskEncryptionSetName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The ID of the resource. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskEncryptionSet + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzGallery.md b/azps-10.1.0/Az.Compute/Remove-AzGallery.md new file mode 100644 index 0000000000..7084776cc4 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzGallery.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azgallery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzGallery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzGallery.md +--- + +# Remove-AzGallery + +## SYNOPSIS +Delete a gallery. + +## SYNTAX + +### DefaultParameter (Default) +``` +Remove-AzGallery [-ResourceGroupName] <String> [-Name] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Remove-AzGallery [-Force] [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ObjectParameter +``` +Remove-AzGallery [-Force] [-InputObject] <PSGallery> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a gallery. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzGallery -ResourceGroupName $rgname -GalleryName $galleryName +``` + +Delete the given gallery. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The PS Gallery Object + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery +Parameter Sets: ObjectParameter +Aliases: Gallery + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: GalleryName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id for the gallery + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzGalleryApplication.md b/azps-10.1.0/Az.Compute/Remove-AzGalleryApplication.md new file mode 100644 index 0000000000..9907c129de --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzGalleryApplication.md @@ -0,0 +1,248 @@ +--- +external help file: Az.Compute-help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azgalleryapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzGalleryApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzGalleryApplication.md +--- + +# Remove-AzGalleryApplication + +## SYNOPSIS +Delete a gallery Application. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzGalleryApplication -GalleryName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzGalleryApplication -InputObject <IComputeIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a gallery Application. + +## EXAMPLES + +### Example 1: Remove a Gallery Application +```powershell +Remove-AzGalleryApplication -ResourceGroupName $rgNmae -GalleryName $galleryName -Name $name +``` + +Delete a gallery application. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryName +The name of the Shared Application Gallery in which the Application Definition is to be deleted. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery Application Definition to be deleted. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: GalleryApplicationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IComputeIdentity>`: Identity Parameter + - `[CommandId <String>]`: The command id. + - `[GalleryApplicationName <String>]`: The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryApplicationVersionName <String>]`: The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryImageName <String>]`: The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryImageVersionName <String>]`: The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryName <String>]`: The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. + - `[Id <String>]`: Resource identity path + - `[InstanceId <String>]`: The instance ID of the virtual machine. + - `[Location <String>]`: The location upon which run commands is queried. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[RunCommandName <String>]`: The name of the virtual machine run command. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VMName <String>]`: The name of the virtual machine where the run command should be created or updated. + - `[VMScaleSetName <String>]`: The name of the VM scale set. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzGalleryApplicationVersion.md b/azps-10.1.0/Az.Compute/Remove-AzGalleryApplicationVersion.md new file mode 100644 index 0000000000..1919a79655 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzGalleryApplicationVersion.md @@ -0,0 +1,263 @@ +--- +external help file: Az.Compute-help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azgalleryapplicationversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzGalleryApplicationVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzGalleryApplicationVersion.md +--- + +# Remove-AzGalleryApplicationVersion + +## SYNOPSIS +Delete a gallery Application Version. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzGalleryApplicationVersion -GalleryApplicationName <String> -GalleryName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzGalleryApplicationVersion -InputObject <IComputeIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a gallery Application Version. + +## EXAMPLES + +### Example 1: Remove a Gallery Application Version +```powershell +Remove-AzGalleryApplicationVersion -ResourceGroupName $rgNmae -GalleryName $galleryName -GalleryApplicationName $galleryApplicationName -Name $name +``` + +Delete a gallery application version. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryApplicationName +The name of the gallery Application Definition in which the Application Version resides. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryName +The name of the Shared Application Gallery in which the Application Definition resides. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery Application Version to be deleted. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: GalleryApplicationVersionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IComputeIdentity>`: Identity Parameter + - `[CommandId <String>]`: The command id. + - `[GalleryApplicationName <String>]`: The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryApplicationVersionName <String>]`: The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryImageName <String>]`: The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryImageVersionName <String>]`: The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryName <String>]`: The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. + - `[Id <String>]`: Resource identity path + - `[InstanceId <String>]`: The instance ID of the virtual machine. + - `[Location <String>]`: The location upon which run commands is queried. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[RunCommandName <String>]`: The name of the virtual machine run command. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VMName <String>]`: The name of the virtual machine where the run command should be created or updated. + - `[VMScaleSetName <String>]`: The name of the VM scale set. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzGalleryImageDefinition.md b/azps-10.1.0/Az.Compute/Remove-AzGalleryImageDefinition.md new file mode 100644 index 0000000000..1ec9fef71c --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzGalleryImageDefinition.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azgalleryimagedefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzGalleryImageDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzGalleryImageDefinition.md +--- + +# Remove-AzGalleryImageDefinition + +## SYNOPSIS +Delete a gallery image definition. + +## SYNTAX + +### DefaultParameter (Default) +``` +Remove-AzGalleryImageDefinition [-ResourceGroupName] <String> [-GalleryName] <String> [-Name] <String> [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Remove-AzGalleryImageDefinition [-Force] [-ResourceId] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameter +``` +Remove-AzGalleryImageDefinition [-Force] [-InputObject] <PSGalleryImage> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a gallery image definition. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzGalleryImageDefinition -ResourceGroupName $rgname -GalleryName $gallery -GalleryImageDefinitionName $galleryImage +``` + +Remove the gallery image definition. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryName +The name of the gallery. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The PS Gallery Image Definition Object + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage +Parameter Sets: ObjectParameter +Aliases: GalleryImageDefinition + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery image definition. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: GalleryImageDefinitionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource ID for the gallery image definition + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzGalleryImageVersion.md b/azps-10.1.0/Az.Compute/Remove-AzGalleryImageVersion.md new file mode 100644 index 0000000000..32c65a80c6 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzGalleryImageVersion.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azgalleryimageversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzGalleryImageVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzGalleryImageVersion.md +--- + +# Remove-AzGalleryImageVersion + +## SYNOPSIS +Delete a gallery image version. + +## SYNTAX + +### DefaultParameter (Default) +``` +Remove-AzGalleryImageVersion [-ResourceGroupName] <String> [-GalleryName] <String> + [-GalleryImageDefinitionName] <String> [-Name] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Remove-AzGalleryImageVersion [-Force] [-ResourceId] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameter +``` +Remove-AzGalleryImageVersion [-Force] [-InputObject] <PSGalleryImageVersion> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a gallery image version. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzGalleryImageVersion -ResourceGroupName $rgname -GalleryName $gallery -GalleryImageDefinitionName $image -Name $version +``` + +Delete the given gallery image version. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryImageDefinitionName +The name of the gallery image definition. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: GalleryImageName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryName +The name of the gallery. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The PS Gallery Image Version Object + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion +Parameter Sets: ObjectParameter +Aliases: GalleryImageVersion + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery image version. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: GalleryImageVersionName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource ID for gallery image version + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzHost.md b/azps-10.1.0/Az.Compute/Remove-AzHost.md new file mode 100644 index 0000000000..f49354f456 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzHost.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzHost.md +--- + +# Remove-AzHost + +## SYNOPSIS +Removes a host. + +## SYNTAX + +### DefaultParameter (Default) +``` +Remove-AzHost [-ResourceGroupName] <String> [-HostGroupName] <String> [-Name] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Remove-AzHost [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectParameter +``` +Remove-AzHost [-InputObject] <PSHost> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will delete a Host + +## EXAMPLES + +### Example 1 +```powershell +Get-AzHost -ResourceGroupName $resourceGroupName -HostGroupName $hostGroupName -Name $hostName | Remove-AzHost +``` + +This command gets and removes the given host. + +### Example 2 +```powershell +Remove-AzHost -ResourceGroupName $resourceGroupName -HostGroupName $hostGroupName -Name $hostName +``` + +This command removes the given host. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostGroupName +The name of the host group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The local object of the host. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSHost +Parameter Sets: ObjectParameter +Aliases: Host + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the host. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: HostName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The ID of the resource. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSHost + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzHostGroup.md b/azps-10.1.0/Az.Compute/Remove-AzHostGroup.md new file mode 100644 index 0000000000..e544fecd54 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzHostGroup.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azhostgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzHostGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzHostGroup.md +--- + +# Remove-AzHostGroup + +## SYNOPSIS +Removes a host group. + +## SYNTAX + +### DefaultParameter (Default) +``` +Remove-AzHostGroup [-ResourceGroupName] <String> [-Name] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Remove-AzHostGroup [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ObjectParameter +``` +Remove-AzHostGroup [-InputObject] <PSHostGroup> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will delete a Host group + +## EXAMPLES + +### Example 1 +```powershell +Get-AzHostGroup -ResourceGroupName $resourceGroupName -HostGroupName $hostGroupName | Remove-AzHostGroup +``` + +This command gets and removes the given host group. + +### Example 2 +```powershell +Remove-AzHostGroup -ResourceGroupName $resourceGroupName -HostGroupName $hostGroupName +``` + +This command removes the given host group. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The local object of the host group. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSHostGroup +Parameter Sets: ObjectParameter +Aliases: HostGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the host group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: HostGroupName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The ID of the resource. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSHostGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzImage.md b/azps-10.1.0/Az.Compute/Remove-AzImage.md new file mode 100644 index 0000000000..086c987aef --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzImage.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzImage.md +--- + +# Remove-AzImage + +## SYNOPSIS +Removes an image. + +## SYNTAX + +``` +Remove-AzImage [-ResourceGroupName] <String> [-ImageName] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzImage** cmdlet removes an image.. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01' -Force; +``` + +This command removes the image named 'Image01' in the resource group 'ResourceGroup01'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageName +Specifies the name of an image. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzImageDataDisk.md b/azps-10.1.0/Az.Compute/Remove-AzImageDataDisk.md new file mode 100644 index 0000000000..2460aa0e73 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzImageDataDisk.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azimagedatadisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzImageDataDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzImageDataDisk.md +--- + +# Remove-AzImageDataDisk + +## SYNOPSIS +Removes a data disk from an image object. + +## SYNTAX + +``` +Remove-AzImageDataDisk [-Image] <PSImage> [-Lun] <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzImageDataDisk** cmdlet removes a data disk from an image object. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01' | Remove-AzImageDataDisk -Lun 1 | Update-AzImage; +``` + +This command removes the data disk of logical unit number 1 from the existing image 'Image01' in the resource group 'ResourceGroup01'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Image +Specifies a local image object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSImage +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Lun +Specifies the logical unit number (LUN). + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzProximityPlacementGroup.md b/azps-10.1.0/Az.Compute/Remove-AzProximityPlacementGroup.md new file mode 100644 index 0000000000..2a82e4010f --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzProximityPlacementGroup.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azproximityplacementgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzProximityPlacementGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzProximityPlacementGroup.md +--- + +# Remove-AzProximityPlacementGroup + +## SYNOPSIS +Delete Proximity Placement Group resource. + +## SYNTAX + +### DefaultParameter (Default) +``` +Remove-AzProximityPlacementGroup [-ResourceGroupName] <String> [-Name] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Remove-AzProximityPlacementGroup [-Force] [-ResourceId] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameter +``` +Remove-AzProximityPlacementGroup [-Force] [-InputObject] <PSProximityPlacementGroup> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will delete Proximity Placement Group resource. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName -Name $proximityPlacementGroupName | Remove-AzProximityPlacementGroup +``` + +This command removes the given proximity placement group. + +### Example 2 + +This command removes the given proximity placement group. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Remove-AzProximityPlacementGroup -Name 'AgentPool01' -ResourceGroupName myresourcegroup +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The PS Proximity Placement Group Object + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSProximityPlacementGroup +Parameter Sets: ObjectParameter +Aliases: ProximityPlacementGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the proximity placement group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: ProximityPlacementGroupName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id for the proximity placement group. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSProximityPlacementGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzRestorePoint.md b/azps-10.1.0/Az.Compute/Remove-AzRestorePoint.md new file mode 100644 index 0000000000..938730ef58 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzRestorePoint.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azrestorepoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzRestorePoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzRestorePoint.md +--- + +# Remove-AzRestorePoint + +## SYNOPSIS +This cmdlet can remove a Restore Point + +## SYNTAX + +``` +Remove-AzRestorePoint [-ResourceGroupName] <String> [-RestorePointCollectionName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet can remove a Restore Point + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzRestorePoint -ResourceGroupName <String> -RestorePointCollectionName <String> -Name <String> -Confirm +``` + +Use this to Remove a Restore Point + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RestorePointName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestorePointCollectionName +Restore Point Collection Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSRestorePoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzRestorePointCollection.md b/azps-10.1.0/Az.Compute/Remove-AzRestorePointCollection.md new file mode 100644 index 0000000000..ad12fa589f --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzRestorePointCollection.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azrestorepointcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzRestorePointCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzRestorePointCollection.md +--- + +# Remove-AzRestorePointCollection + +## SYNOPSIS +This Cmdlet can remove Restore Point Collection + +## SYNTAX + +``` +Remove-AzRestorePointCollection [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This Cmdlet can remove Restore Point Collection + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzRestorePointCollection -ResourceGroupName <String> -Name <String> -Confirm +``` + +Use this to remove Restore Point Collection + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RestorePointCollectionName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzSnapshot.md b/azps-10.1.0/Az.Compute/Remove-AzSnapshot.md new file mode 100644 index 0000000000..b377b64d1b --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzSnapshot.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azsnapshot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzSnapshot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzSnapshot.md +--- + +# Remove-AzSnapshot + +## SYNOPSIS +Removes a snapshot. + +## SYNTAX + +``` +Remove-AzSnapshot [-ResourceGroupName] <String> [-SnapshotName] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSnapshot** cmdlet removes a snapshot. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Force; +``` + +This command removes the snapshot named 'Snapshot01' in the resource group 'ResourceGroup01'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SnapshotName +Specifies the name of a snapshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzSshKey.md b/azps-10.1.0/Az.Compute/Remove-AzSshKey.md new file mode 100644 index 0000000000..ad7e0e93dc --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzSshKey.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azsshkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzSshKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzSshKey.md +--- + +# Remove-AzSshKey + +## SYNOPSIS +Delete a SSH Public Key resource. + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Remove-AzSshKey -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceIDParameterSet +``` +Remove-AzSshKey -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzSshKey -InputObject <PSSshPublicKeyResource> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a SSH Public Key resource. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSshKey -ResourceGroupName "testRG" -Name "sshKey1" +``` + +Deletes Ssh Public Key resource named "sshKey1" in Resource Group "testRG" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PowerShell SSH Public Key Object + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSshPublicKeyResource +Parameter Sets: InputObjectParameterSet +Aliases: SshKey + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Ssh Public Key resource to get. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: sshkeyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +Resource ID for your SSH Public Key Resource. + +```yaml +Type: System.String +Parameter Sets: ResourceIDParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzVM.md b/azps-10.1.0/Az.Compute/Remove-AzVM.md new file mode 100644 index 0000000000..244face478 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVM.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: A16C2084-30A4-4AB8-AE22-28CC6E74FD48 +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVM.md +--- + +# Remove-AzVM + +## SYNOPSIS +Removes a virtual machine from Azure. + +## SYNTAX + +### ResourceGroupNameParameterSetName (Default) +``` +Remove-AzVM [-Name] <String> [-ForceDeletion <Boolean>] [-Force] [-NoWait] [-ResourceGroupName] <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdParameterSetName +``` +Remove-AzVM [-ForceDeletion <Boolean>] [-Force] [-NoWait] [-Id] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVM** cmdlet removes a virtual machine from Azure. + +## EXAMPLES + +### Example 1: Remove a virtual machine +```powershell +Remove-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" +``` + +This command removes the virtual machine named VirtualMachine07 in the resource group ResourceGroup11. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +Optional parameter to force delete a VM. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The resource group name. + +```yaml +Type: System.String +Parameter Sets: IdParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSetName +Aliases: ResourceName, VMName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[New-AzVM](./New-AzVM.md) + +[Restart-AzVM](./Restart-AzVM.md) + +[Start-AzVM](./Start-AzVM.md) + +[Stop-AzVM](./Stop-AzVM.md) + +[Update-AzVM](./Update-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMAEMExtension.md b/azps-10.1.0/Az.Compute/Remove-AzVMAEMExtension.md new file mode 100644 index 0000000000..584a25109e --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMAEMExtension.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: B1CD5302-9BF0-460E-98FE-F60DFE072848 +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmaemextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMAEMExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMAEMExtension.md +--- + +# Remove-AzVMAEMExtension + +## SYNOPSIS +Removes the AEM extension from a virtual machine. + +## SYNTAX + +``` +Remove-AzVMAEMExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] + [[-OSType] <String>] [-NoWait] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVMAEMExtension** cmdlet removes the Azure Enhanced Monitoring (AEM) extension from a virtual machine. + +## EXAMPLES + +### Example 1: Remove the AEM extension +```powershell +Remove-AzVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server" +``` + +This command removes the AEM extension for the virtual machine named contoso-server. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual machine from which this cmdlet removes the AEM extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSType +Specifies the type of the operating system of the operating system disk. +If the operating system disk does not have a type, you must specify this parameter. +The acceptable values for this parameter are: Windows and Linux. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of a virtual machine. +This cmdlet removes the AEM extension from that virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine. +This cmdlet removes the AEM extension for the virtual machine that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMAEMExtension](./Get-AzVMAEMExtension.md) + +[Set-AzVMAEMExtension](./Set-AzVMAEMExtension.md) + +[Test-AzVMAEMExtension](./Test-AzVMAEMExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMAccessExtension.md b/azps-10.1.0/Az.Compute/Remove-AzVMAccessExtension.md new file mode 100644 index 0000000000..8f14ced058 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMAccessExtension.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 22C490C2-0135-4375-897E-7224DBBE13A7 +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmaccessextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMAccessExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMAccessExtension.md +--- + +# Remove-AzVMAccessExtension + +## SYNOPSIS +Removes the VMAccess extension from a virtual machine. + +## SYNTAX + +``` +Remove-AzVMAccessExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Force] [-NoWait] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVMAccessExtension** cmdlet removes the Virtual Machine Access (VMAccess) Virtual Machine Extension from a virtual machine. + +## EXAMPLES + +### Example 1 + +Removes the VMAccess extension from a virtual machine. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Remove-AzVMAccessExtension -Name 'AgentPool01' -ResourceGroupName myresourcegroup -VMName 'VM01' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the extension that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine. +This cmdlet removes VMAccess for the virtual machine that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMAccessExtension](./Get-AzVMAccessExtension.md) + +[Set-AzVMAccessExtension](./Set-AzVMAccessExtension.md) + +[Remove-AzVMExtension](./Remove-AzVMExtension.md) diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMBackup.md b/azps-10.1.0/Az.Compute/Remove-AzVMBackup.md new file mode 100644 index 0000000000..1f23d5879b --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMBackup.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 2AB1B227-68C4-49AE-84C0-E1421E609DE7 +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMBackup.md +--- + +# Remove-AzVMBackup + +## SYNOPSIS +Removes the backup from a virtual machine. + +## SYNTAX + +``` +Remove-AzVMBackup [-ResourceGroupName] <String> [-VMName] <String> [-Tag] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVMBackup** cmdlet removes the backup from a virtual machine. + +## EXAMPLES + +### Example 1 +``` +Remove-AzVMBackup -ResourceGroupName $rgname -VMName $vmName +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMChefExtension.md b/azps-10.1.0/Az.Compute/Remove-AzVMChefExtension.md new file mode 100644 index 0000000000..b47c98450e --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMChefExtension.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 473C71A8-1DF7-487A-B239-B80E2BB63B82 +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmchefextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMChefExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMChefExtension.md +--- + +# Remove-AzVMChefExtension + +## SYNOPSIS +Removes the Chef extension from a virtual machine. + +## SYNTAX + +### Linux +``` +Remove-AzVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Linux] [-NoWait] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Windows +``` +Remove-AzVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Windows] + [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVMChefExtension** cmdlet removes the Chef extension from a virtual machine. + +## EXAMPLES + +### Example 1: Remove a Chef extension from a Windows virtual machine +```powershell +Remove-AzVMChefExtension -ResourceGroupName "ResourceGroup001" -VMName "WindowsVM001" -Windows +``` + +This command removes a Chef extension from a Windows based virtual machine named WindowsVM001 that belongs to the resource group named ResourceGroup001. + +### Example 2: Remove a Chef extension from a Linux virtual machine +```powershell +Remove-AzVMChefExtension -ResourceGroupName "ResourceGroup002" -VMName "LinuxVM001" -Linux +``` + +This command removes a Chef extension from a Linux based virtual machine named LinuxVM001 that belongs to the resource group named ResourceGroup002. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Linux +Indicates that this cmdlet targets a Linux virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Linux +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Chef extension that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine for which this cmdlet removes the Chef extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Windows +Indicates that this cmdlet targets a Windows virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Windows +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMChefExtension](./Get-AzVMChefExtension.md) + +[Set-AzVMChefExtension](./Set-AzVMChefExtension.md) diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMCustomScriptExtension.md b/azps-10.1.0/Az.Compute/Remove-AzVMCustomScriptExtension.md new file mode 100644 index 0000000000..7e9b10fa57 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMCustomScriptExtension.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: A65E82D5-706B-4470-A51E-936E381DA78F +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmcustomscriptextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMCustomScriptExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMCustomScriptExtension.md +--- + +# Remove-AzVMCustomScriptExtension + +## SYNOPSIS +Removes a custom script extension from a virtual machine. + +## SYNTAX + +``` +Remove-AzVMCustomScriptExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Force] + [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVMCustomScriptExtension** cmdlet removes a custom script Virtual Machine Extension from a virtual machine. + +## EXAMPLES + +### Example 1 + +Removes a custom script extension from a virtual machine. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Remove-AzVMCustomScriptExtension -Name 'AgentPool01' -ResourceGroupName myresourcegroup -VMName 'VM01' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the custom script extension that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine from which this cmdlet removes the custom script extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMCustomScriptExtension](./Get-AzVMCustomScriptExtension.md) + +[Set-AzVMCustomScriptExtension](./Set-AzVMCustomScriptExtension.md) diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMDataDisk.md b/azps-10.1.0/Az.Compute/Remove-AzVMDataDisk.md new file mode 100644 index 0000000000..8239630937 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMDataDisk.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: D5943E9F-E4E6-4A1F-A144-44691CF32FC8 +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmdatadisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMDataDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMDataDisk.md +--- + +# Remove-AzVMDataDisk + +## SYNOPSIS +Removes a data disk from a virtual machine. + +## SYNTAX + +``` +Remove-AzVMDataDisk [-VM] <PSVirtualMachine> [[-DataDiskNames] <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVMDataDisk** cmdlet removes a data disk from a virtual machine. + +## EXAMPLES + +### Example 1: Remove a data disk from a virtual machine +```powershell +$VirtualMachine = Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" +Remove-AzVMDataDisk -VM $VirtualMachine -Name "Disk3" +Update-AzVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine +``` + +The first command gets the virtual machine named VirtualMachine07 by using the **Get-AzVM** cmdlet. +The command stores the virtual machine in the $VirtualMachine variable. +The second command removes the data disk named Disk3 from the virtual machine stored in $VirtualMachine. +The final command updates the state of the virtual machine stored in $VirtualMachine in ResourceGroup11. + +## PARAMETERS + +### -DataDiskNames +Specifies the names of one or more data disks that this cmdlet removes. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +Specifies the local virtual machine object from which to remove a data disk. +To obtain a virtual machine object, use the Get-AzVM cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[Add-AzVMDataDisk](./Add-AzVMDataDisk.md) + +[Get-AzVM](./Get-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMDiagnosticsExtension.md b/azps-10.1.0/Az.Compute/Remove-AzVMDiagnosticsExtension.md new file mode 100644 index 0000000000..3b3fd4b0eb --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMDiagnosticsExtension.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 89DA3965-5344-4A1D-AEF1-10EA58E129CF +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmdiagnosticsextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMDiagnosticsExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMDiagnosticsExtension.md +--- + +# Remove-AzVMDiagnosticsExtension + +## SYNOPSIS +Removes the Diagnostics extension from a virtual machine. + +## SYNTAX + +``` +Remove-AzVMDiagnosticsExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-NoWait] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVMDiagnosticsExtension** cmdlet removes an Azure Diagnostics extension from a virtual machine. +You must pass the output of this cmdlet to the Update-AzVM cmdlet to implement your changes. + +## EXAMPLES + +### Example 1: Remove the Diagnostics extension from a virtual machine +```powershell +Remove-AzVMDiagnosticsExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM22" | Update-AzVM +``` + +This command removes the Diagnostics extension from a virtual machine named ContosoVM22. +The command passes the result to the Update-AzVM cmdlet by using the pipeline operator. +That command updates the virtual machine. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Diagnostics extension that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine from which this cmdlet removes a Diagnostics extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMDiagnosticsExtension](./Get-AzVMDiagnosticsExtension.md) + +[Set-AzVMDiagnosticsExtension](./Set-AzVMDiagnosticsExtension.md) + +[Update-AzVM](./Update-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMDiskEncryptionExtension.md b/azps-10.1.0/Az.Compute/Remove-AzVMDiskEncryptionExtension.md new file mode 100644 index 0000000000..94d5f7a122 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMDiskEncryptionExtension.md @@ -0,0 +1,188 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 9DDB3672-4C98-4449-9F29-DD9501ED4D3E +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmdiskencryptionextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMDiskEncryptionExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMDiskEncryptionExtension.md +--- + +# Remove-AzVMDiskEncryptionExtension + +## SYNOPSIS +Removes the disk encryption extension from a virtual machine. + +## SYNTAX + +``` +Remove-AzVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Force] + [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVMDiskEncryptionExtension** cmdlet removes the disk encryption extension and the associated extension configuration from a virtual machine. If no extension name is specified, this cmdlet removes the extension with default name AzureDiskEncryption for virtual machines that run the Windows operating system or AzureDiskEncryptionForLinux for Linux based virtual machines. + +This cmdlet will fail if encryption on the virtual machine has not been first disabled. To disable encryption on a virtual machine, use [Disable-AzVMDiskEncryption](./Disable-AzVMDiskEncryption.md). + +## EXAMPLES + +### Example 1: Remove the disk encryption extension from a virtual machine. +```powershell +Remove-AzVMDiskEncryptionExtension -ResourceGroupName "MyResourceGroup" -VMName "MyTestVM" +``` + +This command removes the extension with default name AzureDiskEncryption for a virtual machine that runs the Windows operating system or AzureDiskEncryptionForLinux for Linux based virtual machine named MyTestVM. + +### Example 2: Remove a specific disk encryption extension from a virtual machine. +```powershell +Remove-AzVMDiskEncryptionExtension -ResourceGroupName "MyResourceGroup" -VMName "MyTestVM" -Name "MyDiskEncryptionExtension" +``` + +This command removes the encryption extension named MyDiskEncryptionExtension from the virtual machine named MyTestVM. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Azure Resource Manager resource that represents the extension. +The Set-AzVMDiskEncryptionExtension cmdlet sets this name to AzureDiskEncryption for virtual machines that run the Windows operating system and AzureDiskEncryptionForLinux for Linux virtual machines. +Specify this parameter only if you changed the default name in the **Set-AzVMDiskEncryptionExtension** cmdlet or used a different resource name in a Resource Manager template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMDiskEncryptionStatus](./Get-AzVMDiskEncryptionStatus.md) + +[Set-AzVMDiskEncryptionExtension](./Set-AzVMDiskEncryptionExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMDscExtension.md b/azps-10.1.0/Az.Compute/Remove-AzVMDscExtension.md new file mode 100644 index 0000000000..d2df71ec85 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMDscExtension.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: C7FCF2CA-2C8D-4280-BF68-10DEA96642A5 +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmdscextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMDscExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMDscExtension.md +--- + +# Remove-AzVMDscExtension + +## SYNOPSIS +Removes a DSC extension handler from a virtual machine in a resource group. + +## SYNTAX + +``` +Remove-AzVMDscExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-NoWait] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVMDscExtension** cmdlet removes a Desired State Configuration (DSC) extension handler from a virtual machine in a resource group. + +## EXAMPLES + +### Example 1: Remove a DSC extension +```powershell +Remove-AzVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -Name "DSC" +``` + +This command removes the extension named DSC on virtual machine named VM07. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the DSC extension that this cmdlet removes. +The Set-AzVMDscExtension cmdlet sets this name to Microsoft.Powershell.DSC, which is the default value used by **Remove-AzVMDscExtension**. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine from which this cmdlet removes the DSC extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMDscExtension](./Get-AzVMDscExtension.md) + +[Set-AzVMDscExtension](./Set-AzVMDscExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMExtension.md b/azps-10.1.0/Az.Compute/Remove-AzVMExtension.md new file mode 100644 index 0000000000..0211fae614 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMExtension.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 6C40A7BA-6BE2-464A-84E4-9021935A5BF6 +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMExtension.md +--- + +# Remove-AzVMExtension + +## SYNOPSIS +Removes an extension from a virtual machine. + +## SYNTAX + +``` +Remove-AzVMExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVMExtension** cmdlet removes an extension from the Virtual Machine Extensions of a virtual machine. + +## EXAMPLES + +### Example 1: Remove an extension from a virtual machine +```powershell +Remove-AzVMExtension -ResourceGroupName "ResourceGroup11" -Name "ContosoTest" -VMName "VirtualMachine22" +``` + +This command removes the extension named ContosoTest from the virtual machine named VirtualMachine22 in ResourceGroup11. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the extension that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine from which this cmdlet removes the extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMExtension](./Get-AzVMExtension.md) + +[Set-AzVMExtension](./Set-AzVMExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMNetworkInterface.md b/azps-10.1.0/Az.Compute/Remove-AzVMNetworkInterface.md new file mode 100644 index 0000000000..2bb51aac2f --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMNetworkInterface.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 6B26DADE-BF71-48D2-98C9-87B2F6182AC2 +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmnetworkinterface +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMNetworkInterface.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMNetworkInterface.md +--- + +# Remove-AzVMNetworkInterface + +## SYNOPSIS +Removes a network interface from a virtual machine. + +## SYNTAX + +``` +Remove-AzVMNetworkInterface [-VM] <PSVirtualMachine> [[-NetworkInterfaceIDs] <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVMNetworkInterface** cmdlet removes a network interface from a virtual machine. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzVMNetworkInterface -VM $vmConfig +$vmConfig.NetworkProfile +``` + +```Output +NetworkInterfaces NetworkApiVersion NetworkInterfaceConfigurations +----------------- ----------------- ------------------------------ +{} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterfaceIDs +Specifies an array of network interface IDs that this cmdlet removes. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: Id, NicIds + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine from which this cmdlet removes a network interface. +To obtain a virtual machine object, use the Get-AzVM cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMRunCommand.md b/azps-10.1.0/Az.Compute/Remove-AzVMRunCommand.md new file mode 100644 index 0000000000..5d7f2eab22 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMRunCommand.md @@ -0,0 +1,248 @@ +--- +external help file: Az.Compute-help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmruncommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMRunCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMRunCommand.md +--- + +# Remove-AzVMRunCommand + +## SYNOPSIS +The operation to delete the run command. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzVMRunCommand -ResourceGroupName <String> -RunCommandName <String> [-SubscriptionId <String>] + -VMName <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzVMRunCommand -InputObject <IComputeIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to delete the run command. + +## EXAMPLES + +### Example 1: Remove Run Command +```powershell +Remove-AzVMRunCommand -ResourceGroupName $rgname -VMName $vmname -RunCommandName "firstruncommand" +``` + +Remove a Run Command by its Name + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunCommandName +The name of the virtual machine run command. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName +The name of the virtual machine where the run command should be deleted. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IComputeIdentity>`: Identity Parameter + - `[CommandId <String>]`: The command id. + - `[GalleryApplicationName <String>]`: The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryApplicationVersionName <String>]`: The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryImageName <String>]`: The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryImageVersionName <String>]`: The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryName <String>]`: The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. + - `[Id <String>]`: Resource identity path + - `[InstanceId <String>]`: The instance ID of the virtual machine. + - `[Location <String>]`: The location upon which run commands is queried. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[RunCommandName <String>]`: The name of the virtual machine run command. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VMName <String>]`: The name of the virtual machine where the run command should be created or updated. + - `[VMScaleSetName <String>]`: The name of the VM scale set. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMSecret.md b/azps-10.1.0/Az.Compute/Remove-AzVMSecret.md new file mode 100644 index 0000000000..9271d73a93 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMSecret.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMSecret.md +--- + +# Remove-AzVMSecret + +## SYNOPSIS +Removes (a) secret(s) from a virtual machine object + +## SYNTAX + +``` +Remove-AzVMSecret [-VM] <PSVirtualMachine> [[-SourceVaultId] <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzVMSecret cmdlet removes (a) secret(s) from a virtual machine object. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVM -ResourceGroupName "rg1" -Name "vm1" | Remove-AzVMSecret | Update-AzVM +``` + +Removes all secrets from a virtual machine "vm1" in resource group "rg1" and update the VM + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceVaultId +Specifies an array of source vault IDs that this cmdlet removes. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: Id + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine from which this cmdlet removes (a) secret(s). +To obtain a virtual machine object, use the Get-AzVM cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzVMSqlServerExtension.md b/azps-10.1.0/Az.Compute/Remove-AzVMSqlServerExtension.md new file mode 100644 index 0000000000..7e03a7bbb3 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVMSqlServerExtension.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: B02CEAC8-C838-4890-8C21-9897CA39EF45 +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmsqlserverextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMSqlServerExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVMSqlServerExtension.md +--- + +# Remove-AzVMSqlServerExtension + +## SYNOPSIS +Removes a SQL Server extension from a virtual machine. + +## SYNTAX + +``` +Remove-AzVMSqlServerExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-NoWait] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVMSqlServerExtension** cmdlet removes an AzureSQL Server extension from a virtual machine. + +## EXAMPLES + +### Example 1: Remove a SQL Server extension +```powershell +Remove-AzVMSqlServerExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM22" -Name "SqlIaaSAgent" +``` + +This command removes a SQL Server extension from the virtual machine named ContosoVM22. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the SQL Server the extension that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine from which this cmdlet removes the SQL Server extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMSqlServerExtension](./Get-AzVMSqlServerExtension.md) + +[Set-AzVMSqlServerExtension](./Set-AzVMSqlServerExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzVmGalleryApplication.md b/azps-10.1.0/Az.Compute/Remove-AzVmGalleryApplication.md new file mode 100644 index 0000000000..897ec537bb --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVmGalleryApplication.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmgalleryapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmGalleryApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmGalleryApplication.md +--- + +# Remove-AzVmGalleryApplication + +## SYNOPSIS +Remove a VMGalleryApplication object from the PSVirtualMachine object. + +## SYNTAX + +``` +Remove-AzVmGalleryApplication -VM <PSVirtualMachine> -GalleryApplicationsReferenceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes a VMGalleryApplication object from the PSVirtualMachine object. + +## EXAMPLES + +### Example 1 +```powershell +$vm = Get-AzVM -ResourceGroupName $rgname -Name $vmName +Remove-AzVmGalleryApplication -VM $vm -GalleryApplicationsReferenceId $refId +``` + +Remove gallery application by reference Id + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryApplicationsReferenceId +Package Reference Id of the Gallery Application to delete. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +The PSVirtualMachine object to delete a Gallery Application Reference ID from. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzVmss.md b/azps-10.1.0/Az.Compute/Remove-AzVmss.md new file mode 100644 index 0000000000..a68912f920 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVmss.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: E6F2EE87-97C4-416A-9AE1-9FBD72062F0F +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmss +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmss.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmss.md +--- + +# Remove-AzVmss + +## SYNOPSIS +Removes the VMSS or a virtual machine that is within the VMSS. + +## SYNTAX + +``` +Remove-AzVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] + [-ForceDeletion <Boolean>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVmss** cmdlet removes the Virtual Machine Scale Set (VMSS) from Azure. +This cmdlet can also be used to remove a specific virtual machine inside the VMSS. +You can use the *InstanceId* parameter to remove a specific virtual machine inside the VMSS. + +## EXAMPLES + +### Example 1: Remove a VMSS +```powershell +Remove-AzVmss -ResourceGroupName "Group001" -VMScaleSetName "VMScaleSet001" +``` + +This command removes the VMSS named VMScaleSet001 that belongs to the resource group named Group001. + +### Example 2: Remove a virtual machine from within a VMSS +```powershell +Remove-AzVmss -ResourceGroupName "Group002" -VMScaleSetName "VMScaleSet002" -InstanceId "3"; +``` + +This command removes the virtual machine with instance ID 3 from the VMSS named VMScaleSet002 that belongs to the resource group named Group002. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +Optional parameter to force delete a VM. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceId +Specifies, as a string array, the ID of the instances that need to be started. +For instance: `-InstanceId "0", "3"` + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the VMSS belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +Species the name of the VMSS that this cmdlet removes. +If you specify the *InstanceId* parameter, the cmdlet will remove the specified virtual machine from the VMSS named by this parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVmss](./Get-AzVmss.md) + +[New-AzVmss](./New-AzVmss.md) + +[Restart-AzVmss](./Restart-AzVmss.md) + +[Set-AzVmss](./Set-AzVmss.md) + +[Start-AzVmss](./Start-AzVmss.md) + +[Stop-AzVmss](./Stop-AzVmss.md) + +[Update-AzVmss](./Update-AzVmss.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzVmssDataDisk.md b/azps-10.1.0/Az.Compute/Remove-AzVmssDataDisk.md new file mode 100644 index 0000000000..46e6a29f95 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVmssDataDisk.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmssdatadisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssDataDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssDataDisk.md +--- + +# Remove-AzVmssDataDisk + +## SYNOPSIS +Removes a data disk from the VMSS. + +## SYNTAX + +### NameParameterSet +``` +Remove-AzVmssDataDisk [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### LunParameterSet +``` +Remove-AzVmssDataDisk [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-Lun] <Int32> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVmssDataDisk** cmdlet removes a data disk from the Virtual Machine Scale Set (VMSS) instance. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzVmssDataDisk -VirtualMachineScaleSet $vmss -Name 'DataDisk1' +``` + +This command removes the data disk named 'DataDisk1' from the VMSS object. + +### Example 2 +```powershell +Remove-AzVmssDataDisk -VirtualMachineScaleSet $vmss -Lun 0 +``` + +This command removes the data disk of LUN 0 from the VMSS object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lun +Specifies the logical unit number of the disk. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: LunParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the disk. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specify the VMSS object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzVmssDiagnosticsExtension.md b/azps-10.1.0/Az.Compute/Remove-AzVmssDiagnosticsExtension.md new file mode 100644 index 0000000000..762a630adc --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVmssDiagnosticsExtension.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 5F135E64-9432-4D08-961F-4604410378A3 +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmssdiagnosticsextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssDiagnosticsExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssDiagnosticsExtension.md +--- + +# Remove-AzVmssDiagnosticsExtension + +## SYNOPSIS +Removes a diagnostics extension from the VMSS. + +## SYNTAX + +``` +Remove-AzVmssDiagnosticsExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVmssDiagnosticsExtension** cmdlet removes a diagnostics extension from the Virtual Machine Scale Set (VMSS). + +## EXAMPLES + +### Example 1: Remove a diagnostics extension from the VMSS +```powershell +Remove-AzVmssDiagnosticsExtension -VirtualMachineScaleSet $VMSS -Name $extName +``` + +This command removes diagnostics extension from the VMSS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the extension that this cmdlet removes from the VMSS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specifies the VMSS from which to remove the extension. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[Add-AzVmssDiagnosticsExtension](./Add-AzVmssDiagnosticsExtension.md) + +[Remove-AzVMDiagnosticsExtension](./Remove-AzVMDiagnosticsExtension.md) + +[Remove-AzVmssExtension](./Remove-AzVmssExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzVmssExtension.md b/azps-10.1.0/Az.Compute/Remove-AzVmssExtension.md new file mode 100644 index 0000000000..a0deb8348e --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVmssExtension.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 8C1C12AD-5130-42E7-99BB-B13900D7A712 +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmssextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssExtension.md +--- + +# Remove-AzVmssExtension + +## SYNOPSIS +Removes an extension from the VMSS. + +## SYNTAX + +### NameParameterSet +``` +Remove-AzVmssExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdParameterSet +``` +Remove-AzVmssExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-Id] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVmssExtension** cmdlet removes an extension from the Virtual Machine Scale Set (VMSS). + +## EXAMPLES + +### Example 1: Remove a VMSS extension +```powershell +$vmss = Get-AzVmss -ResourceGroupName $RGName -VMScaleSetName $vmssName +Remove-AzVmssExtension -VirtualMachineScaleSet $vmss -Name $vmssExtensionName +Update-AzVmss -ResourceGroupName $RGName -Name $vmssName -VirtualMachineScaleSet $vmss +``` + +This command removes the extension of a VMSS and update the VMSS after the modification. + +### Example 2: Remove an instance from within a VMSS +```powershell +$vmss = Get-AzVmss -ResourceGroupName $RGName -VMScaleSetName $vmssName +Remove-AzVmssExtension -VirtualMachineScaleSet $vmss -Id $extensionId +``` + +This command removes specify extension id from the VMSS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the extension that this cmdlet removes from the VMSS. + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the extension that this cmdlet removes from the VMSS. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specifies the VMSS from which to remove the extension from. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[Add-AzVmssExtension](./Add-AzVmssExtension.md) diff --git a/azps-10.1.0/Az.Compute/Remove-AzVmssGalleryApplication.md b/azps-10.1.0/Az.Compute/Remove-AzVmssGalleryApplication.md new file mode 100644 index 0000000000..46e591bc85 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVmssGalleryApplication.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmssgalleryapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssGalleryApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssGalleryApplication.md +--- + +# Remove-AzVmssGalleryApplication + +## SYNOPSIS +Remove a VMGalleryApplication object from the PSVirtualMachineScaleSetVMProfile object. + +## SYNTAX + +``` +Remove-AzVmssGalleryApplication -VirtualMachineScaleSetVM <PSVirtualMachineScaleSetVMProfile> + -GalleryApplicationsReferenceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Removes a VMGalleryApplication object from the PSVirtualMachineScaleSetVMProfile object. + +## EXAMPLES + +### Example 1 +```powershell +$vmss = Get-AzVmss -ResourceGroupName $rgname -Name $vmssName +Remove-AzVmssGalleryApplication -VirtualMachineScaleSetVM $vmss.VirtualMachineProfile -GalleryApplicationsReferenceId $refId +``` + +Remove gallery application by reference Id + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryApplicationsReferenceId +Package Reference Id of the Gallery Application to delete. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSetVM +The PSVirtualMachineScaleSetVMProfile object to delete a Gallery Application Reference ID from. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVMProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVMProfile + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzVmssNetworkInterfaceConfiguration.md b/azps-10.1.0/Az.Compute/Remove-AzVmssNetworkInterfaceConfiguration.md new file mode 100644 index 0000000000..74f4084852 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVmssNetworkInterfaceConfiguration.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: EC4E8CC1-C21F-4D41-818F-D0BC15AEEE1D +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmssnetworkinterfaceconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssNetworkInterfaceConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssNetworkInterfaceConfiguration.md +--- + +# Remove-AzVmssNetworkInterfaceConfiguration + +## SYNOPSIS +Removes a network interface configuration from a VMSS. + +## SYNTAX + +### NameParameterSet +``` +Remove-AzVmssNetworkInterfaceConfiguration [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdParameterSet +``` +Remove-AzVmssNetworkInterfaceConfiguration [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-Id] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVmssNetworkInterfaceConfiguration** cmdlet removes a network interface configuration from a Virtual Machine Scale Set (VMSS). + +## EXAMPLES + +### Example 1: Remove an interface configuration +```powershell +$VMSS = Get-AzVmss -ResourceGroupName "ResourceGroup11" -VMScaleSetName "ContosoVMSS14" +Remove-AzVmssNetworkInterfaceConfiguration -VirtualMachineScaleSet $VMSS -Name "ContosoVmssInterface02" +``` + +The first command gets a VMSS by using the Get-AzVmss cmdlet, and then stores it in the $VMSS variable. +The second command removes the network interface configuration named ContosoVmssInterface02 from the set in $VMSS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the network interface configuration that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network interface configuration that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specifies the VMSS object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[Add-AzVmssNetworkInterfaceConfiguration](./Add-AzVmssNetworkInterfaceConfiguration.md) + +[Get-AzVmss](./Get-AzVmss.md) + + diff --git a/azps-10.1.0/Az.Compute/Remove-AzVmssRunCommand.md b/azps-10.1.0/Az.Compute/Remove-AzVmssRunCommand.md new file mode 100644 index 0000000000..415991ee82 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVmssRunCommand.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmssruncommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssRunCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssRunCommand.md +--- + +# Remove-AzVmssRunCommand + +## SYNOPSIS +Remove VMSS RunCommand + +## SYNTAX + +``` +Remove-AzVmssRunCommand [-ResourceGroupName] <String> [-VMScaleSetName] <String> -RunCommandName <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove RunCommand from the VMSS + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzVmssRunCommand -ResourceGroupName $rgname -VMScaleSetName $vmssname -Name myruncommand +``` + +Remove Run Command from Vmss + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunCommandName +Run Command Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMScaleSetName +VMScaleSet Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSRunCommandResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzVmssVMDataDisk.md b/azps-10.1.0/Az.Compute/Remove-AzVmssVMDataDisk.md new file mode 100644 index 0000000000..20608101ac --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVmssVMDataDisk.md @@ -0,0 +1,98 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmssvmdatadisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssVMDataDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssVMDataDisk.md +--- + +# Remove-AzVmssVMDataDisk + +## SYNOPSIS +Removes a data disk from a virtual machine scale set VM + +## SYNTAX + +``` +Remove-AzVmssVMDataDisk [-VirtualMachineScaleSetVM] <PSVirtualMachineScaleSetVM> [-Lun] <Int32> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVmssVMDataDisk** cmdlet removes a data disk from a VM scale set VM + +## EXAMPLES + +### Example 1: Remove a data disk from a VM scale set VM +```powershell +$VmssVM = Get-AzVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 +Remove-AzVmssVMDataDisk -VirtualMachineScaleSetVM $VirtualMachine -Lun 0 +Update-AzVmssVM -VirtualMachineScaleSetVM $VmssVM +``` + +The first command getsan existing Vmss VM given by the resource group name, the vmss name and the instance ID. +The second command removes the data disk lun 0 from the VM scale set VM stored in $VmssVM +The final command updates the Vmss VM with removed data disk. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lun +Specifies the logical unit number of the disk. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSetVM +The virtual machine scale set VM profile. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Remove-AzVmssVMRunCommand.md b/azps-10.1.0/Az.Compute/Remove-AzVmssVMRunCommand.md new file mode 100644 index 0000000000..085264a59b --- /dev/null +++ b/azps-10.1.0/Az.Compute/Remove-AzVmssVMRunCommand.md @@ -0,0 +1,263 @@ +--- +external help file: Az.Compute-help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/remove-azvmssvmruncommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssVMRunCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Remove-AzVmssVMRunCommand.md +--- + +# Remove-AzVmssVMRunCommand + +## SYNOPSIS +The operation to delete the VMSS VM run command. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzVmssVMRunCommand -InstanceId <String> -ResourceGroupName <String> -RunCommandName <String> + [-SubscriptionId <String>] -VMScaleSetName <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzVmssVMRunCommand -InputObject <IComputeIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to delete the VMSS VM run command. + +## EXAMPLES + +### Example 1: Remove VMSS VM RunCommand +```powershell +Remove-AzVmssVMRunCommand -InstanceId 3 -ResourceGroupName $rgname -RunCommandName "first" -VMScaleSetName $vmssname +``` + +Remove VMSS VM RunCommand + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceId +The instance ID of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunCommandName +The name of the virtual machine run command. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMScaleSetName +The name of the VM scale set. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IComputeIdentity>`: Identity Parameter + - `[CommandId <String>]`: The command id. + - `[GalleryApplicationName <String>]`: The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryApplicationVersionName <String>]`: The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryImageName <String>]`: The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryImageVersionName <String>]`: The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryName <String>]`: The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. + - `[Id <String>]`: Resource identity path + - `[InstanceId <String>]`: The instance ID of the virtual machine. + - `[Location <String>]`: The location upon which run commands is queried. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[RunCommandName <String>]`: The name of the virtual machine run command. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VMName <String>]`: The name of the virtual machine where the run command should be created or updated. + - `[VMScaleSetName <String>]`: The name of the VM scale set. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Repair-AzVmssServiceFabricUpdateDomain.md b/azps-10.1.0/Az.Compute/Repair-AzVmssServiceFabricUpdateDomain.md new file mode 100644 index 0000000000..58f704a35f --- /dev/null +++ b/azps-10.1.0/Az.Compute/Repair-AzVmssServiceFabricUpdateDomain.md @@ -0,0 +1,248 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/repair-azvmssservicefabricupdatedomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Repair-AzVmssServiceFabricUpdateDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Repair-AzVmssServiceFabricUpdateDomain.md +--- + +# Repair-AzVmssServiceFabricUpdateDomain + +## SYNOPSIS +Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set. + +## SYNTAX + +### DefaultParameter (Default) +``` +Repair-AzVmssServiceFabricUpdateDomain [-ResourceGroupName] <String> [-VMScaleSetName] <String> + [-PlatformUpdateDomain] <Int32> [-Zone <String>] [-PlacementGroupId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Repair-AzVmssServiceFabricUpdateDomain [-PlatformUpdateDomain] <Int32> [-Zone <String>] + [-PlacementGroupId <String>] [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameter +``` +Repair-AzVmssServiceFabricUpdateDomain [-PlatformUpdateDomain] <Int32> [-Zone <String>] + [-PlacementGroupId <String>] [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Force manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set. + +## EXAMPLES + +### Example 1 +```powershell +Repair-AzVmssServiceFabricUpdateDomain -ResourceGroupName $rgname -VMScaleSetName $vmssName -PlatformUpdateDomain 0 +``` + +This command forces service fabric update walk on UD 0 for the virtual machine scale set specified by resource group name and scale set name. + +### Example 2 +```powershell +$vmss = Get-AzVmss -ResourceGroupName $rgname -VMScaleSetName $vmssName +Repair-AzVmssServiceFabricUpdateDomain -VirtualMachineScaleSet $vmss -PlatformUpdateDomain 1 +``` + +This command forces service fabric update walk on UD 1 for the virtual machine scale set specified by VM scale set object. + +### Example 3 +```powershell +Repair-AzVmssServiceFabricUpdateDomain -ResourceId $resourceId -PlatformUpdateDomain 2; +``` + +This command forces service fabric update walk on UD 2 for the virtual machine scale set specified by resource id. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlacementGroupId +Placement Group Id of the Vmss + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlatformUpdateDomain +The platform update domain for which a manual recovery walk is requested. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id for the virtual machine scale set. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Local virtual machine scale set object + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: ObjectParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMScaleSetName +The name of the virtual machine scale set + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +Zone of the Vmss + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSRecoveryWalkResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Restart-AzHost.md b/azps-10.1.0/Az.Compute/Restart-AzHost.md new file mode 100644 index 0000000000..6decc46be0 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Restart-AzHost.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/restart-azhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Restart-AzHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Restart-AzHost.md +--- + +# Restart-AzHost + +## SYNOPSIS +Restart the dedicated host. + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Restart-AzHost [-ResourceGroupName] <String> [-HostGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Restart-AzHost -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectParameterSet +``` +Restart-AzHost -InputObject <PSHost> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://learn.microsoft.com/en-us/azure/service-health/resource-health-overview for more details. + +## EXAMPLES + +### Example 1 +```powershell +$Location = 'Location'; +$ResourceGroupName = New-AzResourceGroup -Name $rgname -Location $Location -Force; + +$hostGroupName = $ResourceGroupName + 'hostgroup' +New-AzHostGroup -ResourceGroupName $ResourceGroupName -Name $hostGroupName -Location $Location -PlatformFaultDomain 1 -Zone "2" -Tag @{key1 = "val1"}; + +$hostGroup = Get-AzHostGroup -ResourceGroupName $ResourceGroupName -Name $hostGroupName; +$hostName = $ResourceGroupName + 'host'; +New-AzHost -ResourceGroupName $ResourceGroupName -HostGroupName $hostGroupName -Name $hostName -Location $Location -Sku "ESv3-Type1" -Tag @{key1 = "val2"}; + +$dedicatedHost = Get-AzHost -ResourceGroupName $ResourceGroupName -HostGroupName $hostGroupName -Name $hostName; +Restart-AzHost -ResourceGroupName $ResourceGroupName -HostGroupName $hostGroupName -Name $hostName; + +# Check the status of the restart operation +$hostRestart = Get-AzHost -ResourceGroupName $rgname -HostGroupName $hostGroupName -Name $hostName -InstanceView; +$hostRestart.InstanceView.Statuses[1].DisplayStatus; +``` + +This example creates a dedicated host group and a dedicated host. Then it begins restarting the dedicated host, and checks the status of this restart operation. +You can query the status of the restart operation with the `Get-AzHost` cmdlet using the `-InstanceView` parameter. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostGroupName +The name of the dedicated host group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The dedicated host object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSHost +Parameter Sets: ObjectParameterSet +Aliases: Host + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the dedicated host. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: HostName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The ARM resource id of the dedicated host. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSHost + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Restart-AzVM.md b/azps-10.1.0/Az.Compute/Restart-AzVM.md new file mode 100644 index 0000000000..bd7e0f01b7 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Restart-AzVM.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: EF155949-5766-4BC4-9C8A-2B97E8EA032D +online version: https://learn.microsoft.com/powershell/module/az.compute/restart-azvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Restart-AzVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Restart-AzVM.md +--- + +# Restart-AzVM + +## SYNOPSIS +Restarts an Azure virtual machine. + +## SYNTAX + +### RestartResourceGroupNameParameterSetName (Default) +``` +Restart-AzVM [-ResourceGroupName] <String> [-Name] <String> [-AsJob] [-NoWait] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PerformMaintenanceResourceGroupNameParameterSetName +``` +Restart-AzVM [-ResourceGroupName] <String> [-Name] <String> [-PerformMaintenance] [-AsJob] [-NoWait] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RestartIdParameterSetName +``` +Restart-AzVM [-Id] <String> [-AsJob] [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### PerformMaintenanceIdParameterSetName +``` +Restart-AzVM [-Id] <String> [-PerformMaintenance] [-AsJob] [-NoWait] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Restart-AzVM** cmdlet restarts an Azure virtual machine. + +## EXAMPLES + +### Example 1: Restart a virtual machine +```powershell +Restart-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" +``` + +This command restarts the virtual machine named VirtualMachine07 in ResourceGroup11. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ID of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: RestartIdParameterSetName, PerformMaintenanceIdParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The virtual machine name. + +```yaml +Type: System.String +Parameter Sets: RestartResourceGroupNameParameterSetName, PerformMaintenanceResourceGroupNameParameterSetName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PerformMaintenance +To perform the maintenance of virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PerformMaintenanceResourceGroupNameParameterSetName, PerformMaintenanceIdParameterSetName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: RestartResourceGroupNameParameterSetName, PerformMaintenanceResourceGroupNameParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[New-AzVM](./New-AzVM.md) + +[Remove-AzVM](./Remove-AzVM.md) + +[Start-AzVM](./Start-AzVM.md) + +[Stop-AzVM](./Stop-AzVM.md) + +[Update-AzVM](./Update-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Restart-AzVmss.md b/azps-10.1.0/Az.Compute/Restart-AzVmss.md new file mode 100644 index 0000000000..6a3c0e6d85 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Restart-AzVmss.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 47F0EE55-78C0-4C71-BD32-C7CB7B200DC3 +online version: https://learn.microsoft.com/powershell/module/az.compute/restart-azvmss +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Restart-AzVmss.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Restart-AzVmss.md +--- + +# Restart-AzVmss + +## SYNOPSIS +Restarts the VMSS or a virtual machine within the VMSS. + +## SYNTAX + +``` +Restart-AzVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Restart-AzVmss** cmdlet restarts the Virtual Machine Scale Set (VMSS). +This cmdlet can also be used to restart a specific virtual machine inside the VMSS by using the *InstanceId* parameter. + +## EXAMPLES + +### Example 1: Restart the VMSS +```powershell +Restart-AzVmss -ResourceGroupName "Group001" -VMScaleSetName "VMSS001"; +``` + +This command restarts the VMSS named VMSS001 that belongs to the resource group named Group001. + +### Example 2: Restart a specific virtual machine within the VMSS +```powershell +Restart-AzVmss -ResourceGroupName "Group004" -VMScaleSetName "VMSS001" -InstanceId "1" +``` + +This command restarts a virtual machine that has the instance ID of 1 in the VMSS named VMSS001 that belongs to the resource group named Group001. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceId +Specifies, as a string array, the ID of the instances that need restarted. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the VMSS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +Species the name of the VMSS that this cmdlet restarts. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVmss](./Get-AzVmss.md) + +[New-AzVmss](./New-AzVmss.md) + +[Remove-AzVmss](./Remove-AzVmss.md) + +[Set-AzVmss](./Set-AzVmss.md) + +[Start-AzVmss](./Start-AzVmss.md) + +[Stop-AzVmss](./Stop-AzVmss.md) + +[Update-AzVmss](./Update-AzVmss.md) + + diff --git a/azps-10.1.0/Az.Compute/Revoke-AzDiskAccess.md b/azps-10.1.0/Az.Compute/Revoke-AzDiskAccess.md new file mode 100644 index 0000000000..9f2d58cfe7 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Revoke-AzDiskAccess.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/revoke-azdiskaccess +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Revoke-AzDiskAccess.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Revoke-AzDiskAccess.md +--- + +# Revoke-AzDiskAccess + +## SYNOPSIS +Revokes an access to a disk. + +## SYNTAX + +``` +Revoke-AzDiskAccess [-ResourceGroupName] <String> [-DiskName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Revoke-AzDiskAccess** cmdlet revokes an access to a disk. + +## EXAMPLES + +### Example 1 +```powershell +Revoke-AzDiskAccess -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' +``` + +Revoke the access to the disk named 'Disk01' in the resource group named 'ResourceGroup01' + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskName +Specifies the name of a disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Revoke-AzSnapshotAccess.md b/azps-10.1.0/Az.Compute/Revoke-AzSnapshotAccess.md new file mode 100644 index 0000000000..957045ef33 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Revoke-AzSnapshotAccess.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/revoke-azsnapshotaccess +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Revoke-AzSnapshotAccess.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Revoke-AzSnapshotAccess.md +--- + +# Revoke-AzSnapshotAccess + +## SYNOPSIS +Revokes an access to a snapshot. + +## SYNTAX + +``` +Revoke-AzSnapshotAccess [-ResourceGroupName] <String> [-SnapshotName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Revoke-AzSnapshotAccess** cmdlet revokes an access to a snapshot. + +## EXAMPLES + +### Example 1 +```powershell +Revoke-AzSnapshotAccess -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' +``` + +Revoke the access to the snapshot named 'Snapshot01' in the resource group named 'ResourceGroup01' + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SnapshotName +Specifies the name of a snapshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Save-AzVMImage.md b/azps-10.1.0/Az.Compute/Save-AzVMImage.md new file mode 100644 index 0000000000..3c772aa43a --- /dev/null +++ b/azps-10.1.0/Az.Compute/Save-AzVMImage.md @@ -0,0 +1,230 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: D2B5BC27-6D51-45BC-AE6A-F7FED11B8651 +online version: https://learn.microsoft.com/powershell/module/az.compute/save-azvmimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Save-AzVMImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Save-AzVMImage.md +--- + +# Save-AzVMImage + +## SYNOPSIS +Saves a virtual machine as a VMImage. + +## SYNTAX + +### ResourceGroupNameParameterSetName (Default) +``` +Save-AzVMImage [-Name] <String> [-DestinationContainerName] <String> [-VHDNamePrefix] <String> [-Overwrite] + [[-Path] <String>] [-ResourceGroupName] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### IdParameterSetName +``` +Save-AzVMImage [-DestinationContainerName] <String> [-VHDNamePrefix] <String> [-Overwrite] [[-Path] <String>] + [-Id] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Save-AzVMImage** cmdlet saves a virtual machine as a VMImage. +Before you create a virtual machine image, sysprep the virtual machine, and then mark it as generalized by using the Set-AzVM cmdlet. +The output of this cmdlet is a JavaScript Object Notation (JSON) template. +You can deploy virtual machines from your captured image. + +## EXAMPLES + +### Example 1: Capture a virtual machine +```powershell +Set-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -Generalized +Save-AzVMImage -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -DestinationContainerName "VMContainer01" -VHDNamePrefix "VM07" +``` + +The first command marks the virtual machine named VirtualMachine07 as generalized. +The second command captures a virtual machine named VirtualMachine07 as a VMImage. +The **Output** property returns a JSON template. + +### Example 2 + +Saves a virtual machine as a VMImage. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Save-AzVMImage -DestinationContainerName 'VMContainer01' -Name 'VirtualMachine07' -Path '/home/admin/.ssh/authorized_keys' -ResourceGroupName 'ResourceGroup11' -VHDNamePrefix 'VM07' +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationContainerName +Specifies the name of a container inside the "system" container that you want to hold your images. +If the container doesn't exist, it is created for you. +The virtual hard disks (VHDs) that constitute the VMImage reside in the container that this parameter specifies. +If the VHDs are spread across multiple storage accounts, this cmdlet creates one container that has this name in each storage account. +The URL of the saved image is similar to: +https://\<storageAccountName\>.blob.core.windows.net/system/Microsoft.Compute/Images/\<imagesContainer\>/\<vhdPrefix-osDisk\>.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.vhd. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id +Specifies the Resource ID of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: IdParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSetName +Aliases: VMName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Overwrite +Indicates that this cmdlet overwrites any VHDs that have the same prefix in the destination container. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +The file path in which the template of the captured image is stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VHDNamePrefix +Specifies the prefix in the name of the blobs that constitute the storage profile of the VMImage. +For example, a prefix vhdPrefix for an operating system disk results in the name vhdPrefix-osdisk.\<guid\>.vhd. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VirtualHardDiskNamePrefix + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation + +## NOTES + +## RELATED LINKS + +[Get-AzVMImage](./Get-AzVMImage.md) + +[Get-AzVMImageOffer](./Get-AzVMImageOffer.md) + +[Get-AzVMImagePublisher](./Get-AzVMImagePublisher.md) + +[Get-AzVMImageSku](./Get-AzVMImageSku.md) + +[Set-AzVM](./Set-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Save-AzVhd.md b/azps-10.1.0/Az.Compute/Save-AzVhd.md new file mode 100644 index 0000000000..ed8ceccf7f --- /dev/null +++ b/azps-10.1.0/Az.Compute/Save-AzVhd.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 18E1AD70-42A6-47A2-A685-6E218B6DC4BE +online version: https://learn.microsoft.com/powershell/module/az.compute/save-azvhd +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Save-AzVhd.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Save-AzVhd.md +--- + +# Save-AzVhd + +## SYNOPSIS +Saves downloaded .vhd images locally. + +## SYNTAX + +### ResourceGroupParameterSetName +``` +Save-AzVhd [-ResourceGroupName] <String> [-SourceUri] <Uri> [-LocalFilePath] <FileInfo> + [[-NumberOfThreads] <Int32>] [-OverWrite] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### StorageKeyParameterSetName +``` +Save-AzVhd [-StorageKey] <String> [-SourceUri] <Uri> [-LocalFilePath] <FileInfo> [[-NumberOfThreads] <Int32>] + [-OverWrite] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Save-AzVhd** cmdlet saves .vhd images from a blob where they are stored to a file. +You can specify the number of downloader threads that the process uses and whether to replace a file that already exists. +This cmdlet downloads content as it is. +It does not apply any Virtual Hard Disk (VHD) format conversion. + +## EXAMPLES + +### Example 1: Download an image +```powershell +Save-AzVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -ResourceGroupName "rgname" +``` + +This command downloads a .vhd file, and stores it in the local path C:\vhd\Win7Image.vhd. + +### Example 2: Download an image and overwrite the local file +```powershell +Save-AzVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -Overwrite -ResourceGroupName "rgname" +``` + +This command downloads a .vhd file, and stores it in the local path. +The command includes the *Overwrite* parameter. +Therefore, if C:\vhd\Win7Image.vhd already exists, this command replaces it. + +### Example 3: Download an image by using a specified number of threads +```powershell +Save-AzVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -NumberOfThreads 32 -ResourceGroupName "rgname" +``` + +This command downloads a .vhd file, and stores it in the local path. +The command specifies a value of 32 for the *NumberOfThreads* parameter. +Therefore, the cmdlet uses 32 threads for this action. + +### Example 4: Download an image and specify the storage key +```powershell +Save-AzVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -StorageKey "zNvcH0r5vAGmC5AbwEtpcyWCMyBd3eMDbdaa4ua6kwxq6vTZH3Y+sw==" +``` + +This command downloads a .vhd file and specifies the storage key. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalFilePath +Specifies the local file path of the saved image. + +```yaml +Type: System.IO.FileInfo +Parameter Sets: (All) +Aliases: lf + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfThreads +Specifies the number of download threads that this cmdlet uses during download. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: th + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverWrite +Indicates that this cmdlet replaces the file specified by *LocalFilePath* file if it exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: o + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the storage account. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceUri +Specifies the Uniform Resource Identifier (URI) of the blob in `Azure`. + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: src, Source + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageKey +Specifies the storage key of the blob storage account. +If you do not specify a key, this cmdlet attempts to determine the storage key of the account in *SourceUri* from Azure. + +```yaml +Type: System.String +Parameter Sets: StorageKeyParameterSetName +Aliases: sk + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Uri + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.VhdDownloadContext + +## NOTES + +## RELATED LINKS + +[Add-AzVhd](./Add-AzVhd.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzDiskDiskEncryptionKey.md b/azps-10.1.0/Az.Compute/Set-AzDiskDiskEncryptionKey.md new file mode 100644 index 0000000000..0bb4c50341 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzDiskDiskEncryptionKey.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azdiskdiskencryptionkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzDiskDiskEncryptionKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzDiskDiskEncryptionKey.md +--- + +# Set-AzDiskDiskEncryptionKey + +## SYNOPSIS +Sets the disk encryption key properties on a disk object. + +## SYNTAX + +``` +Set-AzDiskDiskEncryptionKey [-Disk] <PSDisk> [[-SecretUrl] <String>] [[-SourceVaultId] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDiskDiskEncryptionKey** cmdlet sets the disk encryption key properties on a disk object. + +## EXAMPLES + +### Example 1 +```powershell +$diskconfig = New-AzDiskConfig -Location 'Central US' -DiskSizeGB 5 -SkuName Standard_LRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$diskconfig = Set-AzDiskDiskEncryptionKey -Disk $diskconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$diskconfig = Set-AzDiskKeyEncryptionKey -Disk $diskconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +$diskConfig.EncryptionSettingsCollection.EncryptionSettingsVersion = '1.1'; +New-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; +``` + +The first command creates a local empty disk object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. +The second and third commands set the disk encryption key and key encryption key settings for the disk object. +The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disk +Specifies a local disk object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecretUrl +Specifies the secret Url. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceVaultId +Specifies the source vault ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzDiskImageReference.md b/azps-10.1.0/Az.Compute/Set-AzDiskImageReference.md new file mode 100644 index 0000000000..4e495941bc --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzDiskImageReference.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azdiskimagereference +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzDiskImageReference.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzDiskImageReference.md +--- + +# Set-AzDiskImageReference + +## SYNOPSIS +Sets the image reference properties on a disk object. + +## SYNTAX + +``` +Set-AzDiskImageReference [-Disk] <PSDisk> [[-Id] <String>] [[-Lun] <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDiskImageReference** cmdlet sets the image reference properties on a disk object. + +## EXAMPLES + +### Example 1 +```powershell +$diskconfig = New-AzDiskConfig -Location "East US" -DiskSizeGB 10 -AccountType Premium_LRS -OsType Windows -CreateOption FromImage +$image = '/Subscriptions/00000000-0000-0000-0000-000000000000/Providers/Microsoft.Compute/Locations/westeurope/Publishers/MicrosoftWindowsDesktop/ArtifactTypes/VMImage/Offers/Windows-10/Skus/win10-21h2-avd-g2/Versions/19044.1526.220204' +$diskconfig = Set-AzDiskImageReference -Disk $diskconfig -Id $image -Lun 0 +New-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig +``` + +The first command creates a local disk object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type. +The second command sets the image id and the logical unit number 0 for the disk object. +The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disk +Specifies a local disk object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of PIR or user image. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Lun +Specifies the logical unit number (LUN). If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzDiskKeyEncryptionKey.md b/azps-10.1.0/Az.Compute/Set-AzDiskKeyEncryptionKey.md new file mode 100644 index 0000000000..4fbc70207b --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzDiskKeyEncryptionKey.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azdiskkeyencryptionkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzDiskKeyEncryptionKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzDiskKeyEncryptionKey.md +--- + +# Set-AzDiskKeyEncryptionKey + +## SYNOPSIS +Sets the key encryption key properties on a disk object. + +## SYNTAX + +``` +Set-AzDiskKeyEncryptionKey [-Disk] <PSDisk> [[-KeyUrl] <String>] [[-SourceVaultId] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDiskKeyEncryptionKey** cmdlet sets the key encryption key properties on a disk object. + +## EXAMPLES + +### Example 1 +```powershell +$diskconfig = New-AzDiskConfig -Location 'Central US' -DiskSizeGB 5 -SkuName Standard_LRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$diskconfig = Set-AzDiskDiskEncryptionKey -Disk $diskconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$diskconfig = Set-AzDiskKeyEncryptionKey -Disk $diskconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +$diskconfig.EncryptionSettingsCollection.EncryptionSettingsVersion = '1.1'; +New-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; +``` + +The first command creates a local empty disk object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. +The second and third commands set the disk encryption key and key encryption key settings for the disk object. +The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disk +Specifies a local disk object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -KeyUrl +Specifies the key Url. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceVaultId +Specifies the source vault ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzDiskSecurityProfile.md b/azps-10.1.0/Az.Compute/Set-AzDiskSecurityProfile.md new file mode 100644 index 0000000000..69dff6edaf --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzDiskSecurityProfile.md @@ -0,0 +1,188 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azdisksecurityprofile.md +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzDiskSecurityProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzDiskSecurityProfile.md +--- + +# Set-AzDiskSecurityProfile + +## SYNOPSIS +Set SecurityProfile on managed disk + +## SYNTAX + +``` +Set-AzDiskSecurityProfile [-Disk] <PSDisk> -SecurityType <String> [-SecureVMDiskEncryptionSet <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Set SecurityProfile on managed disk + +## EXAMPLES + +### Example 1 +```powershell +$diskconfig = New-AzDiskConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption FromImage; +$image = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/images/TestImage123'; +$diskconfig = Set-AzDiskImageReference -Disk $diskconfig -Id $image -Lun 0; +$diskconfig = Set-AzDiskSecurityProfile -Disk $diskconfig -SecurityType "TrustedLaunch"; +New-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; +#$disk.Properties.SecurityProfile.SecurityType == "TrustedLaunch"; +``` + +Customers can set the SecurityType of managed Disks. + +### Example 2: Create a Disk with a Disk Encrption Set with the encryption type of ConfidentialVM_DiskEncryptedWithCustomerKey +```powershell +$Location = "northeurope"; +$KeyVaultName = "val" + $rgname; +$KeyName = "key" + $rgname; +$DesName= "des" + $rgname; +$KeySize = 3072; + +$SecurePassword = "Password" | ConvertTo-SecureString -AsPlainText -Force; +$User = "Username"; +$Cred = New-Object System.Management.Automation.PSCredential ($User, $SecurePassword); + +New-AzKeyVault -Name $KeyVaultName -Location $Location -ResourceGroupName $ResourceGroupName -Sku Premium -EnablePurgeProtection -EnabledForDiskEncryption; + +# Add Key vault Key +Add-AzKeyVaultKey -VaultName $KeyVaultName -Name $KeyName -Size $KeySize -KeyOps wrapKey,unwrapKey -KeyType RSA -Destination HSM -Exportable -UseDefaultCVMPolicy; + +# Capture Keyvault and key details +$KeyVaultId = (Get-AzKeyVault -VaultName $KeyVaultName -ResourceGroupName $ResourceGroupName).ResourceId; +$KeyUrl = (Get-AzKeyVaultKey -VaultName $KeyVaultName -KeyName $KeyName).Key.Kid; + +# Create new DES Config and DES +$diskEncryptionType = "ConfidentialVmEncryptedWithCustomerKey"; +$desConfig = New-AzDiskEncryptionSetConfig -Location $Location -SourceVaultId $keyvaultId -KeyUrl $keyUrl -IdentityType SystemAssigned -EncryptionType $diskEncryptionType; +New-AzDiskEncryptionSet -ResourceGroupName $ResourceGroupName -Name $DesName -DiskEncryptionSet $desConfig; +$diskencset = Get-AzDiskEncryptionSet -ResourceGroupName $ResourceGroupName -Name $desName; + +# Assign DES Access Policy to key vault +$desIdentity = (Get-AzDiskEncryptionSet -Name $DesName -ResourceGroupName $ResourceGroupName).Identity.PrincipalId; +Set-AzKeyVaultAccessPolicy -VaultName $KeyVaultName -ResourceGroupName $ResourceGroupName -ObjectId $desIdentity -PermissionsToKeys wrapKey,unwrapKey,get -BypassObjectIdValidation; + +$diskSecurityType = "ConfidentialVM_DiskEncryptedWithCustomerKey"; +$diskName = "diskname"; +$diskconfig = New-AzDiskConfig -AccountType Premium_LRS -OsType Windows -CreateOption FromImage -Location $Location; +$diskconfig = Set-AzDiskImageReference -Disk $diskconfig -Id "/Subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/Providers/Microsoft.Compute/Locations/northeurope/Publishers/MicrosoftWindowsServer/ArtifactTypes/VMImage/Offers/windows-cvm/Skus/2019-datacenter-cvm/Versions/latest"; +$diskconfig = Set-AzDiskSecurityProfile -Disk $diskconfig -SecurityType $diskSecurityType -SecureVMDiskEncryptionSet $diskencset.id; +New-AzDisk -ResourceGroupName $ResourceGroupName -DiskName $diskName -Disk $diskconfig; +$disk = Get-AzDisk -ResourceGroupName $ResourceGroupName -DiskName $diskName; +# Verify the SecurityType value. +# $disk.Properties.SecurityProfile.SecurityType returns "ConfidentialVM"; +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disk +Disk Security Profile + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk +Parameter Sets: (All) +Aliases: DiskSecurityProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecureVMDiskEncryptionSet +ResourceId of the disk encryption set to use for enabling encryption at rest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecurityType +Security Type of Disk + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzDiskUpdateDiskEncryptionKey.md b/azps-10.1.0/Az.Compute/Set-AzDiskUpdateDiskEncryptionKey.md new file mode 100644 index 0000000000..271a6fd649 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzDiskUpdateDiskEncryptionKey.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azdiskupdatediskencryptionkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzDiskUpdateDiskEncryptionKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzDiskUpdateDiskEncryptionKey.md +--- + +# Set-AzDiskUpdateDiskEncryptionKey + +## SYNOPSIS +Sets the disk encryption key properties on a disk update object. + +## SYNTAX + +``` +Set-AzDiskUpdateDiskEncryptionKey [-DiskUpdate] <PSDiskUpdate> [[-SecretUrl] <String>] + [[-SourceVaultId] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDiskUpdateDiskEncryptionKey** cmdlet sets the disk encryption key properties on a disk update object. + +## EXAMPLES + +### Example 1 +```powershell +$diskupdateconfig = New-AzDiskUpdateConfig -DiskSizeGB 10 -SkuName Premium_LRS -OsType Windows -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$diskupdateconfig = Set-AzDiskUpdateDiskEncryptionKey -DiskUpdate $diskupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$diskupdateconfig = Set-AzDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +Update-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig; +``` + +The first command creates a local empty disk update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. +The second and third commands set the disk encryption key and key encryption key settings for the disk update object. +The last command takes the disk update object and updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskUpdate +Specifies a local disk update object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SecretUrl +Specifies the secret Url. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceVaultId +Specifies the source vault ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzDiskUpdateKeyEncryptionKey.md b/azps-10.1.0/Az.Compute/Set-AzDiskUpdateKeyEncryptionKey.md new file mode 100644 index 0000000000..891430b6a1 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzDiskUpdateKeyEncryptionKey.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azdiskupdatekeyencryptionkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzDiskUpdateKeyEncryptionKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzDiskUpdateKeyEncryptionKey.md +--- + +# Set-AzDiskUpdateKeyEncryptionKey + +## SYNOPSIS +Sets the key encryption key properties on a disk update object. + +## SYNTAX + +``` +Set-AzDiskUpdateKeyEncryptionKey [-DiskUpdate] <PSDiskUpdate> [[-KeyUrl] <String>] [[-SourceVaultId] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDiskUpdateKeyEncryptionKey** cmdlet sets the key encryption key properties on a disk update object. + +## EXAMPLES + +### Example 1 +```powershell +$diskupdateconfig = New-AzDiskUpdateConfig -DiskSizeGB 10 -SkuName Premium_LRS -OsType Windows -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$diskupdateconfig = Set-AzDiskUpdateDiskEncryptionKey -DiskUpdate $diskupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$diskupdateconfig = Set-AzDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +Update-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig; +``` + +The first command creates a local empty disk update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. +The second and third commands set the disk encryption key and key encryption key settings for the disk update object. +The last command takes the disk update object and updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskUpdate +Specifies a local disk update object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -KeyUrl +Specifies the key Url. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceVaultId +Specifies the source vault ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzImageOsDisk.md b/azps-10.1.0/Az.Compute/Set-AzImageOsDisk.md new file mode 100644 index 0000000000..e1d7550a6f --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzImageOsDisk.md @@ -0,0 +1,272 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azimageosdisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzImageOsDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzImageOsDisk.md +--- + +# Set-AzImageOsDisk + +## SYNOPSIS +Sets the operating system disk properties on an image object. + +## SYNTAX + +``` +Set-AzImageOsDisk [-Image] <PSImage> [[-OsType] <OperatingSystemTypes>] + [[-OsState] <OperatingSystemStateTypes>] [[-BlobUri] <String>] [-Caching <CachingTypes>] [-DiskSizeGB <Int32>] + [-StorageAccountType <String>] [-SnapshotId <String>] [-ManagedDiskId <String>] + [-DiskEncryptionSetId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzImageOsDisk** cmdlet sets the operating system disk properties on an image object. + +## EXAMPLES + +### Example 1 +```powershell +$imageConfig = New-AzImageConfig -Location 'West US'; +$osDiskVhdUri = "https://contoso.blob.core.windows.net/test/os.vhd" +$dataDiskVhdUri1 = "https://contoso.blob.core.windows.net/test/data1.vhd" +$dataDiskVhdUri2 = "https://contoso.blob.core.windows.net/test/data2.vhd" +Set-AzImageOsDisk -Image $imageConfig -OsType 'Windows' -OsState 'Generalized' -BlobUri $osDiskVhdUri; +Add-AzImageDataDisk -Image $imageConfig -Lun 1 -BlobUri $dataDiskVhdUri1; +Add-AzImageDataDisk -Image $imageConfig -Lun 2 -BlobUri $dataDiskVhdUri2; +New-AzImage -Image $imageConfig -ImageName 'ImageName01' -ResourceGroupName 'ResourceGroup01'; +``` + +The first command creates an image object, and then stores it in the $imageConfig variable. +The next three commands assign paths of os disk and two data disks to the $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2 variables. +This approach is only for readability of the following commands. +The next three commands each adds an os disk and two data disks to the image stored in $imageConfig. +The URI of each disk is stored in $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2. +The final command creates an image named 'ImageName01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -BlobUri +Specifies the Uri of the blob. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Caching +Specifies the caching mode of the disk. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.CachingTypes] +Parameter Sets: (All) +Aliases: +Accepted values: None, ReadOnly, ReadWrite + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of customer managed disk encryption set. This can only be specified for managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskSizeGB +Specifies the size of the disk in GB. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Image +Specifies a local image object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSImage +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ManagedDiskId +Specifies the ID of a managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsState +Specifies the OS state. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemStateTypes] +Parameter Sets: (All) +Aliases: +Accepted values: Generalized, Specialized + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsType +Specifies the OS type. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes] +Parameter Sets: (All) +Aliases: +Accepted values: Windows, Linux + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SnapshotId +Specifies the ID of a snapshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountType +The Storage Account type of Os Image Disk + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemStateTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzSnapshotDiskEncryptionKey.md b/azps-10.1.0/Az.Compute/Set-AzSnapshotDiskEncryptionKey.md new file mode 100644 index 0000000000..52f48a8eaa --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzSnapshotDiskEncryptionKey.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azsnapshotdiskencryptionkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzSnapshotDiskEncryptionKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzSnapshotDiskEncryptionKey.md +--- + +# Set-AzSnapshotDiskEncryptionKey + +## SYNOPSIS +Sets the disk encryption key properties on a snapshot object. + +## SYNTAX + +``` +Set-AzSnapshotDiskEncryptionKey [-Snapshot] <PSSnapshot> [[-SecretUrl] <String>] [[-SourceVaultId] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSnapshotDiskEncryptionKey** cmdlet sets the disk encryption key properties on a snapshot object. + +## EXAMPLES + +### Example 1 +```powershell +$snapshotconfig = New-AzSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType Standard_LRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$snapshotconfig = Set-AzSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$snapshotconfig = Set-AzSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +New-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; +``` + +The first command creates a local empty snapshot object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. +The second and third commands set the disk encryption key and key encryption key settings for the snapshot object. +The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretUrl +Specifies the secret Url. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Snapshot +Specifies a local snapshot object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SourceVaultId +Specifies the source vault ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzSnapshotImageReference.md b/azps-10.1.0/Az.Compute/Set-AzSnapshotImageReference.md new file mode 100644 index 0000000000..674ac86106 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzSnapshotImageReference.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azsnapshotimagereference +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzSnapshotImageReference.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzSnapshotImageReference.md +--- + +# Set-AzSnapshotImageReference + +## SYNOPSIS +Sets the image reference properties on a snapshot object. + +## SYNTAX + +``` +Set-AzSnapshotImageReference [-Snapshot] <PSSnapshot> [[-Id] <String>] [[-Lun] <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSnapshotImageReference** cmdlet sets the image reference properties on a snapshot object. + +## EXAMPLES + +### Example 1 +```powershell +$snapshotconfig = New-AzSnapshotConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption FromImage; +$image = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/images/TestImage123'; +$snapshotconfig = Set-AzSnapshotImageReference -Snapshot $snapshotconfig -Id $image -Lun 0; +New-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; +``` + +The first command creates a local snapshot object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type. +The second command sets the image ID and the logical unit number 0 for the snapshot object. +The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Lun +Specifies the logical unit number (LUN). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Snapshot +Specifies a local snapshot object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzSnapshotKeyEncryptionKey.md b/azps-10.1.0/Az.Compute/Set-AzSnapshotKeyEncryptionKey.md new file mode 100644 index 0000000000..ab1df70676 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzSnapshotKeyEncryptionKey.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azsnapshotkeyencryptionkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzSnapshotKeyEncryptionKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzSnapshotKeyEncryptionKey.md +--- + +# Set-AzSnapshotKeyEncryptionKey + +## SYNOPSIS +Sets the key encryption key properties on a snapshot object. + +## SYNTAX + +``` +Set-AzSnapshotKeyEncryptionKey [-Snapshot] <PSSnapshot> [[-KeyUrl] <String>] [[-SourceVaultId] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSnapshotKeyEncryptionKey** cmdlet sets the key encryption key properties on a snapshot object. + +## EXAMPLES + +### Example 1 +```powershell +$snapshotconfig = New-AzSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType Standard_LRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$snapshotconfig = Set-AzSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$snapshotconfig = Set-AzSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +New-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; +``` + +The first command creates a local empty snapshot object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. +The second and third commands set the disk encryption key and key encryption key settings for the snapshot object. +The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyUrl +Specifies the key Url. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Snapshot +Specifies a local snapshot object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SourceVaultId +Specifies the source vault ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzSnapshotUpdateDiskEncryptionKey.md b/azps-10.1.0/Az.Compute/Set-AzSnapshotUpdateDiskEncryptionKey.md new file mode 100644 index 0000000000..5e56800627 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzSnapshotUpdateDiskEncryptionKey.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azsnapshotupdatediskencryptionkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzSnapshotUpdateDiskEncryptionKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzSnapshotUpdateDiskEncryptionKey.md +--- + +# Set-AzSnapshotUpdateDiskEncryptionKey + +## SYNOPSIS +Sets the disk encryption key properties on a snapshot update object. + +## SYNTAX + +``` +Set-AzSnapshotUpdateDiskEncryptionKey [-SnapshotUpdate] <PSSnapshotUpdate> [[-SecretUrl] <String>] + [[-SourceVaultId] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSnapshotUpdateDiskEncryptionKey** cmdlet sets the disk encryption key properties on a snapshot update object. + +## EXAMPLES + +### Example 1 +```powershell +$snapshotupdateconfig = New-AzSnapshotUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$snapshotupdateconfig = Set-AzSnapshotUpdateDiskEncryptionKey -SnapshotUpdate $snapshotupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$snapshotupdateconfig = Set-AzSnapshotUpdateKeyEncryptionKey -SnapshotUpdate $snapshotupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +Update-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -SnapshotUpdate $snapshotupdateconfig; +``` + +The first command creates a local empty snapshot update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. +The second and third commands set the disk encryption key and key encryption key settings for the snapshot update object. +The last command takes the snapshot update object and updates an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretUrl +Specifies the secret Url. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SnapshotUpdate +Specifies a local snapshot update object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SourceVaultId +Specifies the source vault ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzSnapshotUpdateKeyEncryptionKey.md b/azps-10.1.0/Az.Compute/Set-AzSnapshotUpdateKeyEncryptionKey.md new file mode 100644 index 0000000000..87c857a587 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzSnapshotUpdateKeyEncryptionKey.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azsnapshotupdatekeyencryptionkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzSnapshotUpdateKeyEncryptionKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzSnapshotUpdateKeyEncryptionKey.md +--- + +# Set-AzSnapshotUpdateKeyEncryptionKey + +## SYNOPSIS +Sets the key encryption key properties on a snapshot update object. + +## SYNTAX + +``` +Set-AzSnapshotUpdateKeyEncryptionKey [-SnapshotUpdate] <PSSnapshotUpdate> [[-KeyUrl] <String>] + [[-SourceVaultId] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSnapshotUpdateKeyEncryptionKey** cmdlet sets the key encryption key properties on a snapshot update object. + +## EXAMPLES + +### Example 1 +```powershell +$snapshotupdateconfig = New-AzSnapshotUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$snapshotupdateconfig = Set-AzSnapshotUpdateDiskEncryptionKey -SnapshotUpdate $snapshotupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$snapshotupdateconfig = Set-AzSnapshotUpdateKeyEncryptionKey -SnapshotUpdate $snapshotupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +Update-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -SnapshotUpdate $snapshotupdateconfig; +``` + +The first command creates a local empty snapshot update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. +The second and third commands set the disk encryption key and key encryption key settings for the snapshot update object. +The last command takes the snapshot update object and updates an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyUrl +Specifies the key Url. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SnapshotUpdate +Specifies a local snapshot update object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SourceVaultId +Specifies the source vault ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzVM.md b/azps-10.1.0/Az.Compute/Set-AzVM.md new file mode 100644 index 0000000000..faf33d7931 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVM.md @@ -0,0 +1,274 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 939320CB-2595-4150-AFDD-500CEA78559C +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVM.md +--- + +# Set-AzVM + +## SYNOPSIS +This cmdlet can be used to do the followings: reapply or redeploy a virtual machine, mark a virtual machine as generalized, simulate eviction to a spot virtual machine. + +## SYNTAX + +### GeneralizeResourceGroupNameParameterSetName (Default) +``` +Set-AzVM [-ResourceGroupName] <String> [-Name] <String> [-Generalized] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RedeployResourceGroupNameParameterSetName +``` +Set-AzVM [-ResourceGroupName] <String> [-Name] <String> [-Redeploy] [-AsJob] [-NoWait] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ReapplyResourceGroupNameParameterSetName +``` +Set-AzVM [-ResourceGroupName] <String> [-Name] <String> [-Reapply] [-AsJob] [-NoWait] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SimulateEvictionResourceGroupNameParameterSetName +``` +Set-AzVM [-ResourceGroupName] <String> [-Name] <String> [-SimulateEviction] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GeneralizeIdParameterSetName +``` +Set-AzVM [-Id] <String> [-Generalized] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RedeployIdParameterSetName +``` +Set-AzVM [-Id] <String> [-Redeploy] [-AsJob] [-NoWait] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ReapplyIdParameterSetName +``` +Set-AzVM [-Id] <String> [-Reapply] [-AsJob] [-NoWait] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SimulateEvictionIdParameterSetName +``` +Set-AzVM [-Id] <String> [-SimulateEviction] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVM** cmdlet can be used to redeploy or reapply a virtual machine. It can also be used to mark a virtual machine as generalized or simulate eviction to a spot virtual machine.<br> +Before you mark a virtual machine as generalized, log on to the virtual machine and use Sysprep to prepare the hard disk. See [here](https://learn.microsoft.com/en-us/azure/virtual-machines/generalize#windows) for more information. + +## EXAMPLES + +### Example 1: Mark a virtual machine as generalized +```powershell +Set-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -Generalized +``` + +This command marks the virtual machine named "VirtualMachine07" as generalized. + +### Example 2: Simulate eviction to a spot virtual machine using resource ID +```powershell +$vm = Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" +Set-AzVM -Id $vm.id -SimulateEviction +``` + +This command simulates eviction to the virtual machine named "VirtualMachine07" using the resource ID. + +### Example 3: Reapply a virtual machine +```powershell +Set-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -Reapply +``` + +This command reapplies the virtual machine named "VirtualMachine07". + +### Example 4: Redeploy a virtual machine using resource ID +```powershell +$vm = Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" +Set-AzVM -Id $vm.id -Redeploy +``` + +This command deploys the virtual machine named "VirtualMachine07" using the resource ID. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Generalized +Indicates that this cmdlet marks a virtual machine as generalized. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GeneralizeResourceGroupNameParameterSetName, GeneralizeIdParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the Resource ID of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: GeneralizeIdParameterSetName, RedeployIdParameterSetName, ReapplyIdParameterSetName, SimulateEvictionIdParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual machine on which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: GeneralizeResourceGroupNameParameterSetName, RedeployResourceGroupNameParameterSetName, ReapplyResourceGroupNameParameterSetName, SimulateEvictionResourceGroupNameParameterSetName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RedeployResourceGroupNameParameterSetName, ReapplyResourceGroupNameParameterSetName, RedeployIdParameterSetName, ReapplyIdParameterSetName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reapply +To reapply virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ReapplyResourceGroupNameParameterSetName, ReapplyIdParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Redeploy +Indicates that this cmdlet manually redeploys the virtual machine to a different Azure host to fix any problems. +If you redeploy a virtual machine, it restarts, which results in the loss of ephemeral drive data. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RedeployResourceGroupNameParameterSetName, RedeployIdParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: GeneralizeResourceGroupNameParameterSetName, RedeployResourceGroupNameParameterSetName, ReapplyResourceGroupNameParameterSetName, SimulateEvictionResourceGroupNameParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SimulateEviction +Indicates that this cmdlet simulates the eviction of spot virtual machine. +The eviction will occur within 30 minutes of calling the API. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SimulateEvictionResourceGroupNameParameterSetName, SimulateEvictionIdParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMADDomainExtension.md b/azps-10.1.0/Az.Compute/Set-AzVMADDomainExtension.md new file mode 100644 index 0000000000..7ce61572cb --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMADDomainExtension.md @@ -0,0 +1,318 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 65BF37D3-4FCE-48A3-BC5D-01AA20FEB6CA +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmaddomainextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMADDomainExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMADDomainExtension.md +--- + +# Set-AzVMADDomainExtension + +## SYNOPSIS +Adds an AD domain extension to a virtual machine. + +## SYNTAX + +``` +Set-AzVMADDomainExtension -DomainName <String> [-OUPath <String>] [-JoinOption <UInt32>] + [-Credential <PSCredential>] [-Restart] [-ResourceGroupName] <String> [-VMName] <String> -Name <String> + [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] + [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMADDomainExtension** cmdlet adds an Azure Active Directory (AD) domain virtual machine extension to a virtual machine. +This extension lets your virtual machine join a domain. + +## EXAMPLES + +### Example 1 +```powershell +# Create a Resource Group and Virtual Machine before this. +$extensionName = "extensionName" +$virtualMachineName = "vmName" +$resourceGroupName = "resourceGroupName" +$domainName = "domain.com" +Set-AzVMADDomainExtension -ResourceGroupName $resourceGroupName -VMName $virtualMachineName -Name $extensionName -DomainName $domainName +``` + +```Output +RequestId IsSuccessStatusCode StatusCode ReasonPhrase +--------- ------------------- ---------- ------------ + True OK OK +``` + +## PARAMETERS + +### -Credential +Specifies the user name and password for the virtual machine as a **PSCredential** object. +To obtain a credential, use the Get-Credential cmdlet. +For more information, type `Get-Help Get-Credential`. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAutoUpgradeMinorVersion +Indicates that this cmdlet disables auto-upgrade of the minor version of the extension. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DomainName +Specifies the name of the domain. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ForceRerun +Indicates that this cmdlet forces a rerun of the same extension configuration on the virtual machine without uninstalling and reinstalling the extension. +The value can be any string different from the current value. +If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -JoinOption +Specifies the join option. For join options see [JoinOptions](https://learn.microsoft.com/windows/desktop/api/lmjoin/nf-lmjoin-netjoindomain) + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the domain extension to add. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OUPath +Specifies an organizational unit (OU) for the domain account. +Enter the full distinguished name of the OU in quotation marks. +The default value is the default OU for machine objects in the domain. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Restart +Indicates that this cmdlet restarts the virtual machine. +A restart is often required to make the change effective. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the domain extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HandlerVersion, Version + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.UInt32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Management.Automation.PSCredential + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMADDomainExtension](./Get-AzVMADDomainExtension.md) diff --git a/azps-10.1.0/Az.Compute/Set-AzVMAEMExtension.md b/azps-10.1.0/Az.Compute/Set-AzVMAEMExtension.md new file mode 100644 index 0000000000..e80be9c7bb --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMAEMExtension.md @@ -0,0 +1,292 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 3B15C734-DF57-433A-8854-ACE2B35FF6CB +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmaemextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMAEMExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMAEMExtension.md +--- + +# Set-AzVMAEMExtension + +## SYNOPSIS +Enables support for monitoring for SAP systems. + +## SYNTAX + +``` +Set-AzVMAEMExtension [-ResourceGroupName] <String> [-VMName] <String> [-EnableWAD] + [[-WADStorageAccountName] <String>] [[-OSType] <String>] [-SkipStorage] [-NoWait] + [-SetAccessToIndividualResources] [-InstallNewExtension] [[-ProxyURI] <String>] [-DebugExtension] + [[-PathUserIdentity] <String>] [-SkipIdentity] [-IsTest] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMAEMExtension** cmdlet updates the configuration of a virtual machine to enable or update the support for monitoring for SAP systems that are installed on the virtual machine. +The cmdlet installs the Azure Enhanced Monitoring (AEM) extension that collects the performance data and makes it discoverable for the SAP system. + +## EXAMPLES + +### Example 1: Use AEM extension +```powershell +Set-AzVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server" -WADStorageAccountName "stdstorage" +``` + +This command configures the virtual machine named contoso-server to use the AEM extension. +The command specifies the storage account named stdstorage. + +## PARAMETERS + +### -DebugExtension +Enable debug mode for the VM Extension. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableWAD +If this parameter is provided, the commandlet will enable Windows Azure Diagnostics for this virtual machine. + +```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 +``` + +### -InstallNewExtension +Install the new VM Extension for SAP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsTest +Use test version of the extension. The parameter is meant for earlybird and private builds. Please use it only if advised by the product support. Not for production. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSType +Specifies the type of the operating system of the operating system disk. +If the operating system disk does not have a type, you must specify this parameter. +The acceptable values for this parameter are: Windows and Linux. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PathUserIdentity +Assures user assigned identity on the VM and configures the extension to authenticate with the user assigned identity. +For example: +-PathUserIdentity "/subscriptions/272eae8b-75b3-41e5-88b4-782d16d0d97e/resourcegroups/ContosoRresourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ContosoUserAssignedIdentity" +You can use the -PathUserIdentity parameter along with -SkipIdentity, in this case the script will only configure the extension and the VM must already has a valid user identity assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyURI +Configures the proxy URI that should be used by the VM Extension for SAP. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SetAccessToIndividualResources +Sets the access of the VM identity to the individual resources, e.g. data disks instead of the complete resource group. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipIdentity +Bypas the VM identity configuration. The VM must already have either system or user identity assigned. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipStorage +Indicates that this cmdlet skips configuration of storage. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine. +This cmdlet adds the AEM extension for the virtual machine that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WADStorageAccountName +Specifies the name of the storage account that this cmdlet uses to configure the LinuxDiagnostics or IaaSDiagnostics extension. +If the virtual machine does not use a standard storage account, you must specify a value for this parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMAEMExtension](./Get-AzVMAEMExtension.md) + +[Remove-AzVMAEMExtension](./Remove-AzVMAEMExtension.md) + +[Test-AzVMAEMExtension](./Test-AzVMAEMExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMAccessExtension.md b/azps-10.1.0/Az.Compute/Set-AzVMAccessExtension.md new file mode 100644 index 0000000000..da65cffc0d --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMAccessExtension.md @@ -0,0 +1,264 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: D93666EC-C252-4E3B-B311-50B6EEA6D4BF +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmaccessextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMAccessExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMAccessExtension.md +--- + +# Set-AzVMAccessExtension + +## SYNOPSIS +Adds the VMAccess extension to a virtual machine. + +## SYNTAX + +``` +Set-AzVMAccessExtension [-Credential <PSCredential>] [-ResourceGroupName] <String> [-VMName] <String> + -Name <String> [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] + [-ForceRerun <String>] [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMAccessExtension** cmdlet adds the Virtual Machine Access (VMAccess) Virtual Machine VMAccess Extension to a virtual machine. VMAccess Extension can be used to set a temporary password and this should be immediately changed it after logging into the machine. This is not supported on Windows Domain Controllers. + +## EXAMPLES + +### Example 1: Add a VMAccess extension +```powershell +Set-AzVMAccessExtension -ResourceGroupName "ResourceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "2.4" +``` + +This command adds a VMAccess extension for the virtual machine named VirtualMachine07 in ResourceGroup11. +The command specifies the name and type handler version for VMAccess. + +### Example 2 + +Adds the VMAccess extension to a virtual machine. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzVMAccessExtension -Credential <PSCredential> -Location 'Central US' -Name 'ContosoTest' -ResourceGroupName 'ResourceGroup11' -TypeHandlerVersion '2.4' -VMName 'VirtualMachine07' +``` + +## PARAMETERS + +### -Credential +Specifies the user name and password for the virtual machine as a **PSCredential** object. +If you type a different name than the current local administrator account on your VM, the VMAccess extension will add a local administrator account with that name, and assign your specified password to that account. If the local administrator account on your VM exists, it will reset the password and if the account is disabled, the VMAccess extension enables it. +To obtain a credential, use the Get-Credential cmdlet. +For more information, type `Get-Help Get-Credential`. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAutoUpgradeMinorVersion +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ForceRerun +Indicates that this cmdlet forces a rerun of the same extension configuration on the virtual machine without uninstalling and reinstalling the extension. +The value can be any string different from the current value. +If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the extension that this cmdlet adds. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the extension to use for this virtual machine. +To obtain the version, run the Get-AzVMExtensionImage cmdlet with a value of Microsoft.Compute for the *PublisherName* parameter and VMAccessAgent for the *Type* parameter. The typeHandlerVersion must be 2.0 or greater, as version 1 is deprecated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HandlerVersion, Version + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine. +This cmdlet adds VMAccess for the virtual machine that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.Management.Automation.PSCredential + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMAccessExtension](./Get-AzVMAccessExtension.md) + +[Remove-AzVMAccessExtension](./Remove-AzVMAccessExtension.md) + +[Set-AzVMExtension](./Set-AzVMExtension.md) + +[Get-AzVMExtensionImage](./Get-AzVMExtensionImage.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMBackupExtension.md b/azps-10.1.0/Az.Compute/Set-AzVMBackupExtension.md new file mode 100644 index 0000000000..74ee64c22f --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMBackupExtension.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: CBFFBF1B-1AF0-4D2F-9315-C3790A4E9346 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmbackupextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMBackupExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMBackupExtension.md +--- + +# Set-AzVMBackupExtension + +## SYNOPSIS +Sets the backup extension properties on a virtual machine. + +## SYNTAX + +``` +Set-AzVMBackupExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Tag] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION + +## EXAMPLES + +### 1: +```powershell +Set-AzVMBackupExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoTest" -Tag "Backup" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzVMBginfoExtension.md b/azps-10.1.0/Az.Compute/Set-AzVMBginfoExtension.md new file mode 100644 index 0000000000..805fb6345b --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMBginfoExtension.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: B2B4E132-4A71-4DB8-A7B9-9ED3FE7EB292 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmbginfoextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMBginfoExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMBginfoExtension.md +--- + +# Set-AzVMBginfoExtension + +## SYNOPSIS +Adds the BGInfo extension to a virtual machine. + +## SYNTAX + +``` +Set-AzVMBginfoExtension [-ResourceGroupName] <String> [-VMName] <String> -Name <String> + [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] + [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMBGInfoExtension** cmdlet adds the BGInfo extension to a virtual machine. + +## EXAMPLES + +### Example 1: Add the BGInfo extension for a virtual machine +```powershell +Set-AzVMBgInfoExtension -ResourceGroupName "ContosoRG" -VMName "ContosoVM" -Name "ExtensionName" -TypeHandlerVersion "2.1" -Location "West Europe" +``` + +This command adds the BGInfo extension to virtual machine named ContosoVM. +The command specifies the resource group and location of the virtual machine. +The command specifies the name and version of the extension. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAutoUpgradeMinorVersion +Indicates that this cmdlet prevents the Azure guest agent from automatically updating the extension to a newer minor version. +By default, this cmdlet enables the guest agent to update the extension. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ForceRerun +Specifies that the extension should be run again with the same public or protected settings. +The value can be any string different from the current value. +If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the BGInfo extension that this cmdlet adds to a virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine to which this cmdlet adds an extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the extension that this cmdlet adds to the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HandlerVersion, Version + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine to which this cmdlet adds the BGInfo extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzVMBootDiagnostic.md b/azps-10.1.0/Az.Compute/Set-AzVMBootDiagnostic.md new file mode 100644 index 0000000000..8b6777dd94 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMBootDiagnostic.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 9A6F140C-9F1C-4701-9603-FC6107FCAF92 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmbootdiagnostic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMBootDiagnostic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMBootDiagnostic.md +--- + +# Set-AzVMBootDiagnostic + +## SYNOPSIS +Modifies boot diagnostics properties of a virtual machine. + +## SYNTAX + +### EnableBootDiagnostics +``` +Set-AzVMBootDiagnostic [-VM] <PSVirtualMachine> [-Enable] [[-ResourceGroupName] <String>] + [[-StorageAccountName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DisableBootDiagnostics +``` +Set-AzVMBootDiagnostic [-VM] <PSVirtualMachine> [-Disable] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMBootDiagnostic** cmdlet modifies boot diagnostics properties of a virtual machine. + +## EXAMPLES + +### Example 1: Enable boot diagnostics +```powershell +$VM = Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "ContosoVM07" +Set-AzVMBootDiagnostic -VM $VM -Enable -ResourceGroupName "ResourceGroup11" -StorageAccountName "DiagnosticStorage" +Update-AzVM -VM $VM -ResourceGroupName "ResourceGroup11" +``` + +The first command gets the virtual machine named ContosoVM07 by using **Get-AzVM**. +The command stores it in the $VM variable. +The second command enables boot diagnostics for the virtual machine in $VM. +Diagnostics data is stored in the specified account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disable +Indicates that this cmdlet disables the boot diagnostics for the virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DisableBootDiagnostics +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Indicates that this cmdlet enables the boot diagnostics for the virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EnableBootDiagnostics +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of storage account. + +```yaml +Type: System.String +Parameter Sets: EnableBootDiagnostics +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountName +Specifies the name of the storage account in which to save boot diagnostics data. If not provided, it will look for a StorageUri in the BootDiagnostic Profile in the PSVirtualMachine object provided in the '-VM' parameter. If StorageUri is null, it will default to used a managed storage account. + +```yaml +Type: System.String +Parameter Sets: EnableBootDiagnostics +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine for which this cmdlet changes boot diagnostics. +To obtain a virtual machine object, use the Get-AzVM cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[Get-AzVMBootDiagnosticsData](./Get-AzVMBootDiagnosticsData.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMChefExtension.md b/azps-10.1.0/Az.Compute/Set-AzVMChefExtension.md new file mode 100644 index 0000000000..1bfd760886 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMChefExtension.md @@ -0,0 +1,469 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: CC306D8C-A5EE-4655-B686-E5A77CCE5042 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmchefextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMChefExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMChefExtension.md +--- + +# Set-AzVMChefExtension + +## SYNOPSIS +Adds a Chef extension to a virtual machine. + +## SYNTAX + +### Linux +``` +Set-AzVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-TypeHandlerVersion] <String>] + -ValidationPem <String> [-ClientRb <String>] [-BootstrapOptions <String>] [-JsonAttribute <String>] + [-ChefDaemonInterval <String>] [-Daemon <String>] [-Secret <String>] [-SecretFile <String>] + [-RunList <String>] [-ChefServerUrl <String>] [-ValidationClientName <String>] [-OrganizationName <String>] + [-BootstrapVersion <String>] [-Linux] [[-Location] <String>] [[-Name] <String>] + [[-AutoUpgradeMinorVersion] <Boolean>] [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### Windows +``` +Set-AzVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-TypeHandlerVersion] <String>] + -ValidationPem <String> [-ClientRb <String>] [-BootstrapOptions <String>] [-JsonAttribute <String>] + [-ChefDaemonInterval <String>] [-Daemon <String>] [-Secret <String>] [-SecretFile <String>] + [-RunList <String>] [-ChefServerUrl <String>] [-ValidationClientName <String>] [-OrganizationName <String>] + [-BootstrapVersion <String>] [-Windows] [[-Location] <String>] [[-Name] <String>] + [[-AutoUpgradeMinorVersion] <Boolean>] [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMChefExtension** cmdlet adds the Chef extension to the virtual machine. + +## EXAMPLES + +### Example 1: Add a Chef extension to a Windows virtual machine +```powershell +Set-AzVMChefExtension -ResourceGroupName "ResourceGroup001" -VMName "WindowsVM001" -ValidationPem "C:\my-org-validator.pem" -ClientRb "C:\client.rb" -RunList "Apache" -Daemon "service" -SecretFile "C:\my_encrypted_data_bag_secret" -Windows +``` + +This command adds a Chef extension to a Windows virtual machine named WindowsVM001. +When the virtual machine starts, Chef bootstraps the virtual machine to run Apache. + +### Example 2: Add a Chef extension to a Linux virtual machine +```powershell +Set-AzVMChefExtension -ResourceGroupName "ResourceGroup002" -VMName "LinuxVM001" -ValidationPem "C:\my-org-validator.pem" -ClientRb "C:\client.rb" -RunList "Apache" -Secret "my_secret" -Linux +``` + +This command adds a Chef extension to a Linux virtual machine named LinuxVM001. +When the virtual machine starts, Chef bootstraps the virtual machine to run Apache. + +### Example 3: Add a Chef extension to a Windows virtual machine with bootstrap options +```powershell +Set-AzVMChefExtension -ResourceGroupName "ResourceGroup003" -VMName "WindowsVM002" -ValidationPem C:\my-org-validator.pem -ClientRb C:\client.rb -BootstrapOptions '{"chef_node_name":"your_node_name","chef_server_url":"https://api.opscode.com/organizations/some-org", "validation_client_name":"some-org-validator"}' -RunList "Apache" -Windows +``` + +This command adds the Chef extension to a Windows virtual machine named WindowsVM002. +When the virtual machine starts, Chef bootstraps the virtual machine to run Apache. +After bootstrapping, the virtual machine refers to the BootstrapOptions specified in JSON format. + +## PARAMETERS + +### -AutoUpgradeMinorVersion +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BootstrapOptions +Specifies configuration settings in the client_rb option. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BootstrapVersion +Specifies the version of the bootstrap configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ChefDaemonInterval +Specifies the frequency (in minutes) at which the chef-service runs. If in case you don't want the chef-service to be installed on the Azure VM then set value as 0 in this field. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ChefServiceInterval + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ChefServerUrl +Specifies the Chef server link, as a URL. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientRb +Specifies the full path of the Chef client.rb. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Daemon +Configures the chef-client service for unattended execution. The node platform should be Windows. +Allowed options: 'none','service' and 'task'. +none - Currently prevents the chef-client service from being configured as a service. +service - Configures the chef-client to run automatically in the background as a service. +task - Configures the chef-client to run automatically in the background as a scheduled task. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: none, service, task + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonAttribute +A JSON string to be added to the first run of chef-client. e.g. -JsonAttribute '{"foo" : "bar"}' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Linux +Indicates that this cmdlet creates a Windows virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Linux +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Chef extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationName +Specifies the organization name of the Chef extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunList +Specifies the Chef node run list. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Secret +The encryption key used to encrypt and decrypt the data bag item values. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecretFile +The path to the file that contains the encryption key used to encrypt and decrypt the data bag item values. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the extension to use for this virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HandlerVersion, Version + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ValidationClientName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ValidationPem +Specifies the Chef validator .pem file path + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine. +This cmdlet adds the Chef extension for the virtual machine that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Windows +Indicates that this cmdlet creates a Windows virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Windows +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMChefExtension](./Get-AzVMChefExtension.md) + +[Remove-AzVMChefExtension](./Remove-AzVMChefExtension.md) diff --git a/azps-10.1.0/Az.Compute/Set-AzVMCustomScriptExtension.md b/azps-10.1.0/Az.Compute/Set-AzVMCustomScriptExtension.md new file mode 100644 index 0000000000..26398f8373 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMCustomScriptExtension.md @@ -0,0 +1,570 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 64AB1BAE-A756-43A8-A40F-10B746EA0946 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmcustomscriptextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMCustomScriptExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMCustomScriptExtension.md +--- + +# Set-AzVMCustomScriptExtension + +## SYNOPSIS +Adds a custom script extension to a virtual machine. + +## SYNTAX + +### ByNameWithContainerAndFileNamesParameterSet (Default) +``` +Set-AzVMCustomScriptExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] + -ContainerName <String> -FileName <String[]> [-StorageAccountName <String>] [-StorageEndpointSuffix <String>] + [-StorageAccountKey <String>] [-Run <String>] [-Argument <String>] [-SecureExecution] + [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] + [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByNameWithFileUriParameterSet +``` +Set-AzVMCustomScriptExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] + [-FileUri <String[]>] [-Run <String>] [-Argument <String>] [-SecureExecution] [-TypeHandlerVersion <String>] + [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] [-NoWait] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectWithContainerAndFileNamesParameterSet +``` +Set-AzVMCustomScriptExtension -Name <String> -VMObject <PSVirtualMachine> -ContainerName <String> + -FileName <String[]> [-StorageAccountName <String>] [-StorageEndpointSuffix <String>] + [-StorageAccountKey <String>] [-Run <String>] [-Argument <String>] [-SecureExecution] + [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] + [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectWithFileUriParameterSet +``` +Set-AzVMCustomScriptExtension -Name <String> -VMObject <PSVirtualMachine> [-FileUri <String[]>] [-Run <String>] + [-Argument <String>] [-SecureExecution] [-TypeHandlerVersion <String>] [-Location <String>] + [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] [-NoWait] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdWithContainerAndFileNamesParameterSet +``` +Set-AzVMCustomScriptExtension -ResourceId <String> -ContainerName <String> -FileName <String[]> + [-StorageAccountName <String>] [-StorageEndpointSuffix <String>] [-StorageAccountKey <String>] [-Run <String>] + [-Argument <String>] [-SecureExecution] [-TypeHandlerVersion <String>] [-Location <String>] + [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] [-NoWait] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdWithFileUriParameterSet +``` +Set-AzVMCustomScriptExtension -ResourceId <String> [-FileUri <String[]>] [-Run <String>] [-Argument <String>] + [-SecureExecution] [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] + [-ForceRerun <String>] [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObjectWithContainerAndFileNamesParameterSet +``` +Set-AzVMCustomScriptExtension -InputObject <VirtualMachineCustomScriptExtensionContext> -ContainerName <String> + -FileName <String[]> [-StorageAccountName <String>] [-StorageEndpointSuffix <String>] + [-StorageAccountKey <String>] [-Run <String>] [-Argument <String>] [-SecureExecution] + [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] + [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectWithFileUriParameterSet +``` +Set-AzVMCustomScriptExtension -InputObject <VirtualMachineCustomScriptExtensionContext> [-FileUri <String[]>] + [-Run <String>] [-Argument <String>] [-SecureExecution] [-TypeHandlerVersion <String>] [-Location <String>] + [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] [-NoWait] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMCustomScriptExtension** cmdlet adds a custom script Virtual Machine Extension to a virtual machine. +This extension lets you run your own scripts on the virtual machine. + +## EXAMPLES + +### Example 1: Add a custom script +```powershell +Set-AzVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "1.1" -StorageAccountName "Contoso" -StorageAccountKey <StorageKey> -FileName "ContosoScript.exe" -ContainerName "Scripts" +``` + +This command adds a custom script to the virtual machine named VirtualMachine07. +The script file is contososcript.exe. + +### Example 2 + +Adds a custom script extension to a virtual machine. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzVMCustomScriptExtension -Argument <String> -ContainerName 'Scripts' -DefaultProfile <IAzureContextContainer> -FileName 'ContosoScript.exe' -Location 'Central US' -Name 'ContosoTest' -ResourceGroupName 'ResourceGroup11' -Run 'myScript.ps1' -SecureExecution -StorageAccountKey <String> -StorageAccountName 'Contoso' -TypeHandlerVersion '1.1' -VMName 'VirtualMachine07' +``` + +## PARAMETERS + +### -Argument +Specifies arguments that the script extension passes to the script. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ContainerName +Specifies the name of the Azure storage container where this cmdlet stores the script. + +```yaml +Type: System.String +Parameter Sets: ByNameWithContainerAndFileNamesParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByParentObjectWithContainerAndFileNamesParameterSet, ByResourceIdWithContainerAndFileNamesParameterSet, ByInputObjectWithContainerAndFileNamesParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAutoUpgradeMinorVersion +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FileName +Specifies the name of the script file. If the file is stored in Azure Blob storage, the file name +value is case-sensitive. File names of files stored in Azure File storage are not case-sensitive. + +```yaml +Type: System.String[] +Parameter Sets: ByNameWithContainerAndFileNamesParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String[] +Parameter Sets: ByParentObjectWithContainerAndFileNamesParameterSet, ByResourceIdWithContainerAndFileNamesParameterSet, ByInputObjectWithContainerAndFileNamesParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FileUri +Specifies the URI of the script file. + +```yaml +Type: System.String[] +Parameter Sets: ByNameWithFileUriParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String[] +Parameter Sets: ByParentObjectWithFileUriParameterSet, ByResourceIdWithFileUriParameterSet, ByInputObjectWithFileUriParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ForceRerun +Indicates that this cmdlet forces a rerun of the same extension configuration on the virtual machine without uninstalling and reinstalling the extension. +The value can be any string different from the current value. +If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +VM extension object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.VirtualMachineCustomScriptExtensionContext +Parameter Sets: ByInputObjectWithContainerAndFileNamesParameterSet, ByInputObjectWithFileUriParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the custom script extension. + +```yaml +Type: System.String +Parameter Sets: ByNameWithContainerAndFileNamesParameterSet, ByNameWithFileUriParameterSet +Aliases: ExtensionName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByParentObjectWithContainerAndFileNamesParameterSet, ByParentObjectWithFileUriParameterSet +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: ByNameWithContainerAndFileNamesParameterSet, ByNameWithFileUriParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +VM extension ResourceID. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdWithContainerAndFileNamesParameterSet, ByResourceIdWithFileUriParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Run +Specifies the command to use that runs your script. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RunFile, Command + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecureExecution +Indicates that this cmdlet makes sure that the value of the *Run* parameter is not logged on the server or returned to the user by using the GET extension API. +The value of *Run* might contain secrets or passwords to be passed to the script file securely. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountKey +Specifies the key for the Azure storage container. + +```yaml +Type: System.String +Parameter Sets: ByNameWithContainerAndFileNamesParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByParentObjectWithContainerAndFileNamesParameterSet, ByResourceIdWithContainerAndFileNamesParameterSet, ByInputObjectWithContainerAndFileNamesParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountName +Specifies the name of the Azure storage account where this cmdlet stores the script. + +```yaml +Type: System.String +Parameter Sets: ByNameWithContainerAndFileNamesParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByParentObjectWithContainerAndFileNamesParameterSet, ByResourceIdWithContainerAndFileNamesParameterSet, ByInputObjectWithContainerAndFileNamesParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageEndpointSuffix +Specifies the storage endpoint suffix. + +```yaml +Type: System.String +Parameter Sets: ByNameWithContainerAndFileNamesParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByParentObjectWithContainerAndFileNamesParameterSet, ByResourceIdWithContainerAndFileNamesParameterSet, ByInputObjectWithContainerAndFileNamesParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the extension to use for this virtual machine. +To obtain the version, run the Get-AzVMExtensionImage cmdlet with a value of Microsoft.Compute for the *PublisherName* parameter and CustomScriptExtension for the *Type* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HandlerVersion, Version + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine. +This cmdlet adds the custom script extension for the virtual machine that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByNameWithContainerAndFileNamesParameterSet, ByNameWithFileUriParameterSet +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMObject +VM object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: ByParentObjectWithContainerAndFileNamesParameterSet, ByParentObjectWithFileUriParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.String[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMCustomScriptExtension](./Get-AzVMCustomScriptExtension.md) + +[Remove-AzVMCustomScriptExtension](./Remove-AzVMCustomScriptExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMDataDisk.md b/azps-10.1.0/Az.Compute/Set-AzVMDataDisk.md new file mode 100644 index 0000000000..5fcbf3902c --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMDataDisk.md @@ -0,0 +1,230 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: C453485D-67A7-480E-83F6-527D4F5EBC93 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmdatadisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMDataDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMDataDisk.md +--- + +# Set-AzVMDataDisk + +## SYNOPSIS +Modifies properties of a virtual machine data disk. + +## SYNTAX + +### ChangeWithName +``` +Set-AzVMDataDisk [-VM] <PSVirtualMachine> [-Name] <String> [[-Caching] <CachingTypes>] + [[-DiskSizeInGB] <Int32>] [-StorageAccountType <String>] [-DiskEncryptionSetId <String>] [-WriteAccelerator] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ChangeWithLun +``` +Set-AzVMDataDisk [-VM] <PSVirtualMachine> [-Lun] <Int32> [[-Caching] <CachingTypes>] [[-DiskSizeInGB] <Int32>] + [-StorageAccountType <String>] [-DiskEncryptionSetId <String>] [-WriteAccelerator] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMDataDisk** cmdlet modifies properties of a virtual machine data disk. + +## EXAMPLES + +### Example 1: Modify the caching mode of a data disk +```powershell +$VM = Get-AzVM -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM07" +Set-AzVMDataDisk -VM $VM -Name "DataDisk01" -Caching ReadWrite | Update-AzVM +``` + +The first command gets the virtual machine named ContosoVM07 by using **Get-AzVM**. +The command stores it in the $VM variable. +The second command modifies the caching mode for the data disk named DataDisk01 on the virtual machine in $VM. +The command passes the result to the Update-AzVM cmdlet, which implements your changes. +A change to the cashing mode causes the virtual machine to restart. + +### Example 2 + +Modifies properties of a virtual machine data disk. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzVMDataDisk -Caching None -Lun 1 -VM <PSVirtualMachine> +``` + +## PARAMETERS + +### -Caching +Specifies the caching mode of the disk. +The acceptable values for this parameter are: +- ReadOnly +- ReadWrite +The default value is ReadWrite. +Changing this value causes the virtual machine to restart. +This setting affects the consistency and performance of the disk. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.CachingTypes] +Parameter Sets: (All) +Aliases: +Accepted values: None, ReadOnly, ReadWrite + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of customer managed disk encryption set. This can only be specified for managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskSizeInGB +Specifies the size, in gigabytes, for the data disk. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Lun +Specifies the logical unit number (LUN) of the data disk that this cmdlet modifies. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ChangeWithLun +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the data disk that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: ChangeWithName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountType +The virtual machine managed disk's account type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine for which this cmdlet modifies a data disk. +To obtain a virtual machine object, use the Get-AzVM cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WriteAccelerator +Specifies whether WriteAccelerator should be enabled or disabled on the data disk. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[Update-AzVM](./Update-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMDiagnosticsExtension.md b/azps-10.1.0/Az.Compute/Set-AzVMDiagnosticsExtension.md new file mode 100644 index 0000000000..c87761c23d --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMDiagnosticsExtension.md @@ -0,0 +1,280 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 13ED884A-6224-4BD4-9F12-F896932F7842 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmdiagnosticsextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMDiagnosticsExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMDiagnosticsExtension.md +--- + +# Set-AzVMDiagnosticsExtension + +## SYNOPSIS +Configures the Azure diagnostics extension on a virtual machine. + +## SYNTAX + +``` +Set-AzVMDiagnosticsExtension [-ResourceGroupName] <String> [-VMName] <String> + [-DiagnosticsConfigurationPath] <String> [[-StorageAccountName] <String>] [[-StorageAccountKey] <String>] + [[-StorageAccountEndpoint] <String>] [[-StorageContext] <IStorageContext>] [[-Location] <String>] + [[-Name] <String>] [[-TypeHandlerVersion] <String>] [[-AutoUpgradeMinorVersion] <Boolean>] [-NoWait] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMDiagnosticsExtension** cmdlet configures the Azure diagnostics extension on a virtual machine. + +## EXAMPLES + +### Example 1: Enable diagnostics using a storage account specified in a diagnostics configuration file +```powershell +Set-AzVMDiagnosticsExtension -ResourceGroupName "ResourceGroup01" -VMName "VirtualMachine02" -DiagnosticsConfigurationPath "diagnostics_publicconfig.xml" +``` + +This command uses a diagnostics configuration file to enable diagnostics. +The file diagnostics_publicconfig.xml contains the public XML configuration for the diagnostics extension including the name of the storage account to which diagnostics data will be sent. +The diagnostics storage account must be in the same subscription as the virtual machine. + +### Example 2: Enable diagnostics using a storage account name +```powershell +Set-AzVMDiagnosticsExtension -ResourceGroupName "ResourceGroup1" -VMName "VirtualMachine2" -DiagnosticsConfigurationPath diagnostics_publicconfig.xml -StorageAccountName "MyStorageAccount" +``` + +This command uses the storage account name to enable diagnostics. +If the diagnostics configuration does not specify a storage account name or if you want to override the diagnostics storage account name specified in the configuration file, use the *StorageAccountName* parameter. +The diagnostics storage account must be in the same subscription as the virtual machine. + +### Example 3: Enable diagnostics using storage account name and key +```powershell +Set-AzVMDiagnosticsExtension -ResourceGroupName "ResourceGroup01" -VMName "VirtualMachine02" -DiagnosticsConfigurationPath "diagnostics_publicconfig.xml" -StorageAccountName "MyStorageAccount" -StorageAccountKey $storage_key +``` + +This command uses the storage account name and key to enable diagnostics. +If the diagnostics storage account is in a different subscription than the virtual machine then enable sending diagnostics data to that storage account by explicitly specifying its name and key. + +## PARAMETERS + +### -AutoUpgradeMinorVersion +Indicates whether this cmdlet allows the Azure guest agent to automatically update the extension to a newer minor version. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticsConfigurationPath +Specifies the path of the configuration file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountEndpoint +Specifies the storage account endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountKey +Specifies the storage account key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountName +Specifies the storage account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageContext +Specifies the Azure storage context. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the extension to use for this virtual machine. +To obtain the version, run the Get-AzVMExtensionImage cmdlet with a value of Microsoft.Compute for the *PublisherName* parameter and VMAccessAgent for the *Type* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HandlerVersion, Version + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine on which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMDiagnosticsExtension](./Get-AzVMDiagnosticsExtension.md) + +[Get-AzVMExtensionImage](./Get-AzVMExtensionImage.md) + +[Remove-AzVMDiagnosticsExtension](./Remove-AzVMDiagnosticsExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMDiskEncryptionExtension.md b/azps-10.1.0/Az.Compute/Set-AzVMDiskEncryptionExtension.md new file mode 100644 index 0000000000..b6b519b6e8 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMDiskEncryptionExtension.md @@ -0,0 +1,695 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 6BCB36BC-F5E6-4EDD-983C-8BDE7A9B004D +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmdiskencryptionextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMDiskEncryptionExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMDiskEncryptionExtension.md +--- + +# Set-AzVMDiskEncryptionExtension + +## SYNOPSIS +Enables encryption on a running IaaS virtual machine in Azure. + +## SYNTAX + +### SinglePassParameterSet (Default) +``` +Set-AzVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> + [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String> [[-KeyEncryptionKeyUrl] <String>] + [[-KeyEncryptionKeyVaultId] <String>] [[-KeyEncryptionAlgorithm] <String>] [[-VolumeType] <String>] + [[-SequenceVersion] <String>] [[-TypeHandlerVersion] <String>] [[-Name] <String>] [[-Passphrase] <String>] + [-Force] [-DisableAutoUpgradeMinorVersion] [-SkipVmBackup] [-ExtensionType <String>] + [-ExtensionPublisherName <String>] [-EncryptFormatAll] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AADClientSecretParameterSet +``` +Set-AzVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> [-AadClientID] <String> + [-AadClientSecret] <String> [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String> + [[-KeyEncryptionKeyUrl] <String>] [[-KeyEncryptionKeyVaultId] <String>] [[-KeyEncryptionAlgorithm] <String>] + [[-VolumeType] <String>] [[-SequenceVersion] <String>] [[-TypeHandlerVersion] <String>] [[-Name] <String>] + [[-Passphrase] <String>] [-Force] [-DisableAutoUpgradeMinorVersion] [-SkipVmBackup] [-ExtensionType <String>] + [-ExtensionPublisherName <String>] [-EncryptFormatAll] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AADClientCertParameterSet +``` +Set-AzVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> [-AadClientID] <String> + [-AadClientCertThumbprint] <String> [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String> + [[-KeyEncryptionKeyUrl] <String>] [[-KeyEncryptionKeyVaultId] <String>] [[-KeyEncryptionAlgorithm] <String>] + [[-VolumeType] <String>] [[-SequenceVersion] <String>] [[-TypeHandlerVersion] <String>] [[-Name] <String>] + [[-Passphrase] <String>] [-Force] [-DisableAutoUpgradeMinorVersion] [-SkipVmBackup] [-ExtensionType <String>] + [-ExtensionPublisherName <String>] [-EncryptFormatAll] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### MigrateADEVersionParameterSet +``` +Set-AzVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> + [[-KeyEncryptionAlgorithm] <String>] [[-VolumeType] <String>] [[-SequenceVersion] <String>] + [[-TypeHandlerVersion] <String>] [[-Name] <String>] [[-Passphrase] <String>] [-Force] + [-DisableAutoUpgradeMinorVersion] [-SkipVmBackup] [-ExtensionType <String>] [-ExtensionPublisherName <String>] + [-EncryptFormatAll] [-Migrate] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### MigrateADEVersionRecoveryParameterSet +``` +Set-AzVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> + [[-KeyEncryptionAlgorithm] <String>] [[-VolumeType] <String>] [[-SequenceVersion] <String>] + [[-TypeHandlerVersion] <String>] [[-Name] <String>] [[-Passphrase] <String>] [-Force] + [-DisableAutoUpgradeMinorVersion] [-SkipVmBackup] [-ExtensionType <String>] [-ExtensionPublisherName <String>] + [-EncryptFormatAll] [-MigrationRecovery] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMDiskEncryptionExtension** cmdlet enables encryption on a running infrastructure as a service (IaaS) virtual machine in Azure. It enables encryption by installing the disk encryption extension on the virtual machine. + +This cmdlet requires confirmation from the users as one of the steps to enable encryption requires a restart of the virtual machine. + +It is advised that you save your work on the virtual machine before you run this cmdlet. + +Linux: The **VolumeType** parameter is required when encrypting Linux virtual machines, and must be set to a value ("Os", "Data", or "All") supported by the Linux distribution. + +Windows: The **VolumeType** parameter may be omitted, in which case the operation defaults to All; if the VolumeType parameter is present for a Windows virtual machine, it must be set to either All or OS. + +## EXAMPLES + +### Example 1: Enable encryption +```powershell +$RGName = "MyResourceGroup" +$VMName = "MyTestVM" +$VaultName= "MyKeyVault" +$KeyVault = Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName +$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri +$KeyVaultResourceId = $KeyVault.ResourceId +$VolumeType = "All" +Set-AzVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -VolumeType $VolumeType +``` + +This example enables encryption on a VM without specifying AD credentials. + +### Example 2: Enable encryption with pipelined input +```powershell +$params = New-Object PSObject -Property @{ + ResourceGroupName = "[resource-group-name]" + VMName = "[vm-name]" + DiskEncryptionKeyVaultId = "/subscriptions/[subscription-id-guid]/resourceGroups/[resource-group-name]/providers/Microsoft.KeyVault/vaults/[keyvault-name]" + DiskEncryptionKeyVaultUrl = "https://[keyvault-name].vault.azure.net" + KeyEncryptionKeyVaultId = "/subscriptions/[subscription-id-guid]/resourceGroups/[resource-group-name]/providers/Microsoft.KeyVault/vaults/[keyvault-name]" + KeyEncryptionKeyUrl = "https://[keyvault-name].vault.azure.net/keys/[kekname]/[kek-unique-id]" + VolumeType = "All" +} + +$params | Set-AzVMDiskEncryptionExtension +``` + +This example sends parameters using pipelined input to enable encryption on a VM, without specifying AD credentials. + +### Example 3: Enable encryption using Azure AD Client ID and Client Secret +```powershell +$RGName = "MyResourceGroup" +$VMName = "MyTestVM" +$AADClientID = "<clientID of your Azure AD app>" +$AADClientSecret = "<clientSecret of your Azure AD app>" +$VaultName= "MyKeyVault" +$KeyVault = Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName +$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri +$KeyVaultResourceId = $KeyVault.ResourceId +$VolumeType = "All" +Set-AzVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -AadClientID $AADClientID -AadClientSecret $AADClientSecret -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -VolumeType $VolumeType +``` + +This example uses Azure AD client ID and client secret to enable encryption on a VM. + +### Example 4: Enable encryption using Azure AD client ID and client certification thumbprint +```powershell +$RGName = "MyResourceGroup" +$VMName = "MyTestVM" +#The KeyVault must have enabledForDiskEncryption property set on it +$VaultName= "MyKeyVault" +$KeyVault = Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName +$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri +$KeyVaultResourceId = $KeyVault.ResourceId +$VolumeType = "All" + +# create Azure AD application and associate the certificate +$CertPath = "C:\certificates\examplecert.pfx" +$CertPassword = "Password" +$Cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2($CertPath, $CertPassword) +$CertValue = [System.Convert]::ToBase64String($cert.GetRawCertData()) +$AzureAdApplication = New-AzADApplication -DisplayName "<Your Application Display Name>" -HomePage "<https://YourApplicationHomePage>" -IdentifierUris "<https://YouApplicationUri>" -CertValue $CertValue +$ServicePrincipal = New-AzADServicePrincipal -ApplicationId $AzureAdApplication.ApplicationId + +$AADClientID = $AzureAdApplication.ApplicationId +$aadClientCertThumbprint= $cert.Thumbprint + +#Upload pfx to KeyVault +$KeyVaultSecretName = "MyAADCert" +$FileContentBytes = Get-Content $CertPath -Encoding Byte +$FileContentEncoded = [System.Convert]::ToBase64String($fileContentBytes) +$JSONObject = @" + { + "data" : "$filecontentencoded", + "dataType" : "pfx", + "password" : "$CertPassword" + } +"@ +$JSONObjectBytes = [System.Text.Encoding]::UTF8.GetBytes($jsonObject) +$JSONEncoded = [System.Convert]::ToBase64String($jsonObjectBytes) + +$Secret = ConvertTo-SecureString -String $JSONEncoded -AsPlainText -Force +Set-AzKeyVaultSecret -VaultName $VaultName -Name $KeyVaultSecretName -SecretValue $Secret +Set-AzKeyVaultAccessPolicy -VaultName $VaultName -ResourceGroupName $RGName -EnabledForDeployment + +#deploy cert to VM +$CertUrl = (Get-AzKeyVaultSecret -VaultName $VaultName -Name $KeyVaultSecretName).Id +$SourceVaultId = (Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName).ResourceId +$VM = Get-AzVM -ResourceGroupName $RGName -Name $VMName +$VM = Add-AzVMSecret -VM $VM -SourceVaultId $SourceVaultId -CertificateStore "My" -CertificateUrl $CertUrl +Update-AzVM -VM $VM -ResourceGroupName $RGName + +#Enable encryption on the virtual machine using Azure AD client ID and client cert thumbprint +Set-AzVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -AadClientID $AADClientID -AadClientCertThumbprint $AADClientCertThumbprint -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -VolumeType $VolumeType +``` + +This example uses Azure AD client ID and client certification thumbprints to enable encryption on a VM. + +### Example 5: Enable encryption using Azure AD client ID, client secret, and wrap disk encryption key by using key encryption key +```powershell +$RGName = "MyResourceGroup" +$VMName = "MyTestVM" + +$AADClientID = "<clientID of your Azure AD app>" +$AADClientSecret = "<clientSecret of your Azure AD app>" + +$VaultName= "MyKeyVault" +$KeyVault = Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName +$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri +$KeyVaultResourceId = $KeyVault.ResourceId +$VolumeType = "All" + +$KEKName = "MyKeyEncryptionKey" +$KEK = Add-AzKeyVaultKey -VaultName $VaultName -Name $KEKName -Destination "Software" +$KeyEncryptionKeyUrl = $KEK.Key.kid + +Set-AzVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -AadClientID $AADClientID -AadClientSecret $AADClientSecret -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -KeyEncryptionKeyUrl $KeyEncryptionKeyUrl -KeyEncryptionKeyVaultId $KeyVaultResourceId -VolumeType $VolumeType +``` + +This example uses Azure AD client ID and client secret to enable encryption on a VM, and wraps the disk encryption key using a key encryption key. + +### Example 6: Enable encryption using Azure AD client ID, client cert thumbprint, and wrap disk encryptionkey by using key encryption key +```powershell +$RGName = "MyResourceGroup" +$VMName = "MyTestVM" +#The KeyVault must have enabledForDiskEncryption property set on it +$VaultName= "MyKeyVault" +$KeyVault = Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName +$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri +$KeyVaultResourceId = $KeyVault.ResourceId +$KEKName = "MyKeyEncryptionKey" +$KEK = Add-AzKeyVaultKey -VaultName $VaultName -Name $KEKName -Destination "Software" +$KeyEncryptionKeyUrl = $KEK.Key.kid +$VolumeType = "All" + +# create Azure AD application and associate the certificate +$CertPath = "C:\certificates\examplecert.pfx" +$CertPassword = "Password" +$Cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2($CertPath, $CertPassword) +$CertValue = [System.Convert]::ToBase64String($cert.GetRawCertData()) +$AzureAdApplication = New-AzADApplication -DisplayName "<Your Application Display Name>" -HomePage "<https://YourApplicationHomePage>" -IdentifierUris "<https://YouApplicationUri>" -CertValue $CertValue +$ServicePrincipal = New-AzADServicePrincipal -ApplicationId $AzureAdApplication.ApplicationId + +$AADClientID = $AzureAdApplication.ApplicationId +$AADClientCertThumbprint= $Cert.Thumbprint + +#Upload pfx to KeyVault +$KeyVaultSecretName = "MyAADCert" +$FileContentBytes = Get-Content $CertPath -Encoding Byte +$FileContentEncoded = [System.Convert]::ToBase64String($FileContentBytes) +$JSONObject = @" + { + "data" : "$filecontentencoded", + "dataType" : "pfx", + "password" : "$CertPassword" + } +"@ +$JSONObjectBytes = [System.Text.Encoding]::UTF8.GetBytes($JSONObject) +$JsonEncoded = [System.Convert]::ToBase64String($JSONObjectBytes) +$Secret = ConvertTo-SecureString -String $JSONEncoded -AsPlainText -Force +Set-AzKeyVaultSecret -VaultName $VaultName-Name $KeyVaultSecretName -SecretValue $Secret +Set-AzKeyVaultAccessPolicy -VaultName $VaultName -ResourceGroupName $RGName -EnabledForDeployment + +#deploy cert to VM +$CertUrl = (Get-AzKeyVaultSecret -VaultName $VaultName -Name $KeyVaultSecretName).Id +$SourceVaultId = (Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName).ResourceId +$VM = Get-AzVM -ResourceGroupName $RGName -Name $VMName +$VM = Add-AzVMSecret -VM $VM -SourceVaultId $SourceVaultId -CertificateStore "My" -CertificateUrl $CertUrl +Update-AzVM -VM $VM -ResourceGroupName $RGName + +#Enable encryption on the virtual machine using Azure AD client ID and client cert thumbprint +Set-AzVMDiskEncryptionExtension -ResourceGroupName $RGname -VMName $VMName -AadClientID $AADClientID -AadClientCertThumbprint $AADClientCertThumbprint -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -KeyEncryptionKeyUrl $KeyEncryptionKeyUrl -KeyEncryptionKeyVaultId $KeyVaultResourceId -VolumeType $VolumeType +``` + +This example uses Azure AD client ID and client cert thumbprint to enable encryption on a VM, and wraps the disk encryption key using a key encryption key. + +## PARAMETERS + +### -AadClientCertThumbprint +Specifies the thumbprint of the AzureActive Directory (Azure AD) application client certificate that has permissions to write secrets to **KeyVault**. +As a prerequisite, the Azure AD client certificate must be previously deployed to the virtual machine's local computer `my` certificate store. +The Add-AzVMSecret cmdlet can be used to deploy a certificate to a virtual machine in Azure. +For more details, see the **Add-AzVMSecret** cmdlet help. +The certificate must be previously deployed to the virtual machine local computer my certificate store. + +```yaml +Type: System.String +Parameter Sets: AADClientCertParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AadClientID +Specifies the client ID of the Azure AD application that has permissions to write secrets to **KeyVault**. + +```yaml +Type: System.String +Parameter Sets: AADClientSecretParameterSet, AADClientCertParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AadClientSecret +Specifies the client secret of the Azure AD application that has permissions to write secrets to **KeyVault**. + +```yaml +Type: System.String +Parameter Sets: AADClientSecretParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAutoUpgradeMinorVersion +Indicates that this cmdlet disables auto-upgrade of the minor version of the extension. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 14 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionKeyVaultId +Specifies the resource ID of the **KeyVault** to which the virtual machine encryption keys should be uploaded. + +```yaml +Type: System.String +Parameter Sets: SinglePassParameterSet, AADClientSecretParameterSet, AADClientCertParameterSet +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionKeyVaultUrl +Specifies the **KeyVault** URL to which the virtual machine encryption keys should be uploaded. + +```yaml +Type: System.String +Parameter Sets: SinglePassParameterSet, AADClientSecretParameterSet, AADClientCertParameterSet +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptFormatAll +Encrypt-Format all data drives that are not already encrypted + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionPublisherName +The extension publisher name. Specify this parameter only to override the default value of "Microsoft.Azure.Security". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExtensionType +The extension type. Specify this parameter to override its default value of "AzureDiskEncryption" for Windows VMs and "AzureDiskEncryptionForLinux" for Linux VMs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionAlgorithm +Specifies the algorithm that is used to wrap and unwrap the key encryption key of the virtual machine. +The default value is RSA-OAEP. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: RSA-OAEP, RSA1_5 + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyUrl +Specifies the URL of the key encryption key that is used to wrap and unwrap the virtual machine encryption key. +This must be the full versioned URL. + +```yaml +Type: System.String +Parameter Sets: SinglePassParameterSet, AADClientSecretParameterSet, AADClientCertParameterSet +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyVaultId +Specifies the resource ID of the **KeyVault** that contains key encryption key that is used to wrap and unwrap the virtual machine encryption key. +This must be a full versioned URL. + +```yaml +Type: System.String +Parameter Sets: SinglePassParameterSet, AADClientSecretParameterSet, AADClientCertParameterSet +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Migrate +Initiates migration of the VM to latest Azure Disk Encryption extension version (ADE without AAD credentials). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: MigrateADEVersionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MigrationRecovery +Initiates migration recovery for failures during migration of ADE extension version with AAD to ADE extension version without AAD. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: MigrateADEVersionRecoveryParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Azure Resource Manager resource that represents the extension. If the *Name* parameter is omitted, the installed extension will be named AzureDiskEncryption on Windows virtual machines and AzureDiskEncryptionForLinux on Linux virtual machines. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: False +Position: 12 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Passphrase +Specifies the passphrase used for encrypting Linux virtual machines only. +This parameter is not used for virtual machines that run the Windows operating system. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 13 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SequenceVersion +Specifies the sequence number of the encryption operations for a virtual machine. +This is unique per each encryption operation performed on the same virtual machine. +The Get-AzVMExtension cmdlet can be used to retrieve the previous sequence number that was used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipVmBackup +Skip backup creation for Linux VMs + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 15 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the encryption extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HandlerVersion, Version + +Required: False +Position: 11 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeType +Specifies the type of virtual machine volumes on which to perform encryption operation: OS, Data, or All. + +Linux: The **VolumeType** parameter is required when encrypting Linux virtual machines, and must be set to a value ("Os", "Data", or "All") supported by the Linux distribution. + +Windows: The **VolumeType** parameter may be omitted, in which case the operation defaults to All; if the VolumeType parameter is present for a Windows virtual machine, it must be set to either All or OS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: OS, Data, All + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Add-AzVMSecret](./Add-AzVMSecret.md) + +[Get-AzVMDiskEncryptionStatus](./Get-AzVMDiskEncryptionStatus.md) + +[Remove-AzVMDiskEncryptionExtension](./Remove-AzVMDiskEncryptionExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMDscExtension.md b/azps-10.1.0/Az.Compute/Set-AzVMDscExtension.md new file mode 100644 index 0000000000..4f2caab0a2 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMDscExtension.md @@ -0,0 +1,408 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 04F58D88-53D6-42CA-852C-9E2A129898C7 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmdscextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMDscExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMDscExtension.md +--- + +# Set-AzVMDscExtension + +## SYNOPSIS +Configures the DSC extension on a virtual machine. + +## SYNTAX + +``` +Set-AzVMDscExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] + [-ArchiveBlobName] <String> [-ArchiveStorageAccountName] <String> [-ArchiveResourceGroupName <String>] + [-ArchiveStorageEndpointSuffix <String>] [-ArchiveContainerName <String>] [-ConfigurationName <String>] + [-ConfigurationArgument <Hashtable>] [-ConfigurationData <String>] [-Version] <String> [-Force] + [-Location <String>] [-AutoUpdate] [-WmfVersion <String>] [-DataCollection <String>] [-NoWait] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMDscExtension** cmdlet configures the Windows PowerShell Desired State Configuration (DSC) extension on a virtual machine in a resource group. + +## EXAMPLES + +### Example 1: Set a DSC extension +```powershell +Set-AzVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -Version "1.10" -Location "West US" +``` + +This command sets the DSC extension on the virtual machine named VM07 to download Sample.ps1.zip from the storage account named Stg and the default container. +The command invokes the configuration named ConfigName. +The Sample.ps1.zip file was previously uploaded by using **Publish-AzVMDscConfiguration**. + +### Example 2: Set a DSC extension with configuration data +```powershell +Set-AzVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM13" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName "WindowsPowerShellDSC" -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US" +``` + +This command sets the extension on the virtual machine named VM13 to download Sample.ps1.zip from the storage account named Stg and the container named WindowsPowerShellDSC. +The command the configuration named ConfigName and specifies configuration data and arguments. +The Sample.ps1.zip file was previously uploaded by using **Publish-AzVMDscConfiguration**. + +### Example 3: Set a DSC extension with configuration data that has auto update +```powershell +Set-AzVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM22" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName WindowsPowerShellDSC -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US" -AutoUpdate +``` + +This command sets the extension on the virtual machine named VM22 to download Sample.ps1.zip from the storage account named Stg and the container named WindowsPowerShellDSC. +The command invokes the configuration named ConfigName and specifies configuration data and arguments. +This command also enables auto update of extension handler to the latest version. +The Sample.ps1.zip was previously uploaded by using **Publish-AzVMDscConfiguration**. + +## PARAMETERS + +### -ArchiveBlobName +Specifies the name of the configuration file that was previously uploaded by the Publish-AzVMDscConfiguration cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConfigurationArchiveBlob + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ArchiveContainerName +Species name of the Azure storage container where the configuration archive is located. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ContainerName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ArchiveResourceGroupName +Specifies the name of the resource group that contains the storage account that contains the configuration archive. +This parameter is optional if the storage account and virtual machine are both in the same resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ArchiveStorageAccountName +Specifies the Azure storage account name that is used to download the ArchiveBlobName. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountName + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ArchiveStorageEndpointSuffix +Specifies the storage endpoint suffix. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageEndpointSuffix + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutoUpdate +Specifies the extension handler version specified by the *Version* parameter. +By default extension handler is not autoupdated. +Use the *AutoUpdate* parameter to enable auto update of the extension handler to the latest version as and when it is available. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationArgument +Specifies a hash table that contains the arguments to the configuration function. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConfigurationData +Specifies the path of a .psd1 file that specifies the data for the configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConfigurationName +Specifies the name of the configuration that the DSC Extension invokes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataCollection +Specifies the data collection type. +The acceptable values for this parameter are: Enable and Disable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enable, Disable + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the path of the resource extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Azure Resource Manager resource that represents the extension. +The default value is Microsoft.Powershell.DSC. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Specifies the version of the DSC extension that Set-AzVMDscExtension applies the settings to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HandlerVersion + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine where DSC extension handler is installed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WmfVersion +Specifies the WMF version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: 4.0, 5.0, 5.1, latest + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMDscExtension](./Get-AzVMDscExtension.md) + +[Remove-AzVMDscExtension](./Remove-AzVMDscExtension.md) + +[Publish-AzVMDscConfiguration](./Publish-AzVMDscConfiguration.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMExtension.md b/azps-10.1.0/Az.Compute/Set-AzVMExtension.md new file mode 100644 index 0000000000..a5cbb0faf1 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMExtension.md @@ -0,0 +1,385 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 064196C3-ABF3-4F3A-A4AB-EB0D27098C70 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMExtension.md +--- + +# Set-AzVMExtension + +## SYNOPSIS +Updates extension properties or adds an extension to a virtual machine. + +## SYNTAX + +### Settings (Default) +``` +Set-AzVMExtension -Publisher <String> -ExtensionType <String> [-Settings <Hashtable>] + [-ProtectedSettings <Hashtable>] [-EnableAutomaticUpgrade <Boolean>] [-AsJob] [-ResourceGroupName] <String> + [-VMName] <String> -Name <String> [-TypeHandlerVersion <String>] [-Location <String>] + [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] [-NoWait] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SettingString +``` +Set-AzVMExtension -Publisher <String> -ExtensionType <String> [-SettingString <String>] + [-ProtectedSettingString <String>] [-EnableAutomaticUpgrade <Boolean>] [-AsJob] [-ResourceGroupName] <String> + [-VMName] <String> -Name <String> [-TypeHandlerVersion <String>] [-Location <String>] + [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] [-NoWait] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMExtension** cmdlet updates properties for existing Virtual Machine Extensions or adds an extension to a virtual machine. + +## EXAMPLES + +### Example 1: Modify settings by using hash tables +```powershell +$Settings = @{"fileUris" = "[]"; "commandToExecute" = ""}; +$ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey}; +Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "ContosoTest" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -Settings $Settings -ProtectedSettings $ProtectedSettings; +``` + +The first two commands use standard Windows PowerShell syntax to create hash tables, and then stores those hash tables in the $Settings and $ProtectedSettings variables. +For more information, type `Get-Help about_Hash_Tables`. +The second command includes two values previously created and stored in variables. +The final command modifies an extension of the virtual machine named VirtualMachine22 in ResourceGroup11 according to the contents of $Settings and $ProtectedSettings. +The command specifies other required information that includes the publisher and the extension type. + +### Example 2: Modify settings by using strings +```powershell +$SettingsString = '{"fileUris":[],"commandToExecute":""}'; +$ProtectedSettingsString = '{"storageAccountName":"' + $stoname + '","storageAccountKey":"' + $stokey + '"}'; +Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -SettingString $SettingsString -ProtectedSettingString $ProtectedSettingsString ; +``` + +The first two commands create strings that contain settings, and then stores them in the $SettingsString and $ProtectedSettingsString variables. +The final command modifies an extension of the virtual machine named VirtualMachine22 in ResourceGroup11 according to the contents of $SettingsString and $ProtectedSettingsString. +The command specifies other required information that includes the publisher and the extension type. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAutoUpgradeMinorVersion +Indicates that this cmdlet prevents the Azure guest agent from automatically updating the extensions to a newer minor version. +By default, this cmdlet enables the guest agent to update the extensions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableAutomaticUpgrade +Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionType +Specifies the extension type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Type + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ForceRerun +Indicates that this cmdlet forces a rerun of the same extension configuration on the virtual machine without uninstalling and reinstalling the extension. +The value can be any string different from the current value. +If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectedSettings +Specifies private configuration for the extension, as a hash table. +This cmdlet encrypts the private configuration. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: Settings +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProtectedSettingString +Specifies private configuration for the extension, as a string. +This cmdlet encrypts the private configuration. + +```yaml +Type: System.String +Parameter Sets: SettingString +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Publisher +Specifies the name of the extension publisher. +The publisher provides a name when the publisher registers an extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Settings +Specifies public configuration for the extension, as a hash table. +This cmdlet does not encrypt public configuration. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: Settings +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SettingString +Specifies public configuration for the extension, as a string. +This cmdlet does not encrypt public configuration. + +```yaml +Type: System.String +Parameter Sets: SettingString +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the extension to use for this virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HandlerVersion, Version + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine. +This cmdlet modifies extensions for the virtual machine that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVMExtension](./Get-AzVMExtension.md) + +[Remove-AzVMExtension](./Remove-AzVMExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMOSDisk.md b/azps-10.1.0/Az.Compute/Set-AzVMOSDisk.md new file mode 100644 index 0000000000..9c00eb074c --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMOSDisk.md @@ -0,0 +1,593 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 8F7AF1B8-D769-452C-92CF-4486C3EB894D +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmosdisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMOSDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMOSDisk.md +--- + +# Set-AzVMOSDisk + +## SYNOPSIS +Sets the operating system disk properties on a virtual machine. + +## SYNTAX + +### DefaultParamSet (Default) +``` +Set-AzVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] [[-Caching] <CachingTypes>] + [[-SourceImageUri] <String>] [[-CreateOption] <String>] [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] + [-StorageAccountType <String>] [-DiskEncryptionSetId <String>] [-WriteAccelerator] [-DiffDiskSetting <String>] + [-DiffDiskPlacement <String>] [-DeleteOption <String>] [-SecurityEncryptionType <String>] + [-SecureVMDiskEncryptionSet <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### WindowsParamSet +``` +Set-AzVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] [[-Caching] <CachingTypes>] + [[-SourceImageUri] <String>] [[-CreateOption] <String>] [-Windows] [-DiskSizeInGB <Int32>] + [-ManagedDiskId <String>] [-StorageAccountType <String>] [-DiskEncryptionSetId <String>] [-WriteAccelerator] + [-DiffDiskSetting <String>] [-DiffDiskPlacement <String>] [-DeleteOption <String>] + [-SecurityEncryptionType <String>] [-SecureVMDiskEncryptionSet <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### WindowsDiskEncryptionParameterSet +``` +Set-AzVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] [[-Caching] <CachingTypes>] + [[-SourceImageUri] <String>] [[-CreateOption] <String>] [-Windows] [-DiskEncryptionKeyUrl] <String> + [-DiskEncryptionKeyVaultId] <String> [[-KeyEncryptionKeyUrl] <String>] [[-KeyEncryptionKeyVaultId] <String>] + [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] [-StorageAccountType <String>] + [-DiskEncryptionSetId <String>] [-WriteAccelerator] [-DiffDiskSetting <String>] [-DiffDiskPlacement <String>] + [-DeleteOption <String>] [-SecurityEncryptionType <String>] [-SecureVMDiskEncryptionSet <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### LinuxParamSet +``` +Set-AzVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] [[-Caching] <CachingTypes>] + [[-SourceImageUri] <String>] [[-CreateOption] <String>] [-Linux] [-DiskSizeInGB <Int32>] + [-ManagedDiskId <String>] [-StorageAccountType <String>] [-DiskEncryptionSetId <String>] [-WriteAccelerator] + [-DiffDiskSetting <String>] [-DiffDiskPlacement <String>] [-DeleteOption <String>] + [-SecurityEncryptionType <String>] [-SecureVMDiskEncryptionSet <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### LinuxDiskEncryptionParameterSet +``` +Set-AzVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] [[-Caching] <CachingTypes>] + [[-SourceImageUri] <String>] [[-CreateOption] <String>] [-Linux] [-DiskEncryptionKeyUrl] <String> + [-DiskEncryptionKeyVaultId] <String> [[-KeyEncryptionKeyUrl] <String>] [[-KeyEncryptionKeyVaultId] <String>] + [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] [-StorageAccountType <String>] + [-DiskEncryptionSetId <String>] [-WriteAccelerator] [-DiffDiskSetting <String>] [-DiffDiskPlacement <String>] + [-DeleteOption <String>] [-SecurityEncryptionType <String>] [-SecureVMDiskEncryptionSet <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMOSDisk** cmdlet sets the operating system disk properties on a virtual machine. + +## EXAMPLES + +### Example 1: Set properties on a virtual machine from platform image +```powershell +$AvailabilitySet = Get-AzAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet13" +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id +Set-AzVMOSDisk -VM $VirtualMachine -Name "OsDisk12" -VhdUri "os.vhd" -Caching ReadWrite +$VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Linux -ComputerName "MainComputer" -Credential (Get-Credential) +$VirtualMachine = Set-AzVMSourceImage -VM $VirtualMachine -PublisherName "Canonical" -Offer "UbuntuServer" -Skus "15.10" -Version "latest" +$VirtualMachine = Set-AzVMOSDisk -VM $VirtualMachine -Name "osDisk.vhd" -VhdUri "https://mystorageaccount.blob.core.windows.net/disks/" -CreateOption FromImage +New-AzVM -VM $VirtualMachine -ResourceGroupName "ResourceGroup11" +``` + +The first command gets the availability set named AvailabilitySet13 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. +The second command creates a virtual machine object, and then stores it in the $VirtualMachine variable. +The command assigns a name and size to the virtual machine. +The virtual machine belongs to the availability set stored in $AvailabilitySet. +The final command sets the properties on the virtual machine in $VirtualMachine. + +### Example 2: Sets properties on a virtual machine from generalized user image +```powershell +$AvailabilitySet = Get-AzAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet13" +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1" +$VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Linux -ComputerName "MainComputer" -Credential (Get-Credential) +$VirtualMachine = Set-AzVMOSDisk -VM $VirtualMachine -Name "osDisk.vhd" -SourceImageUri "https://mystorageaccount.blob.core.windows.net/vhds/myOSImage.vhd" -VhdUri "https://mystorageaccount.blob.core.windows.net/disks/" -CreateOption fromImage -Linux +New-AzVM -VM $VirtualMachine -ResourceGroupName "ResourceGroup11" +``` + +The first command gets the availability set named AvailabilitySet13 in the resource group named ResourceGroup11 and stores that object in the $AvailabilitySet variable. +The second command creates a virtual machine object and stores it in the $VirtualMachine variable. +The command assigns a name and size to the virtual machine. +The virtual machine belongs to the availability set stored in $AvailabilitySet. +The final command sets the properties on the virtual machine in $VirtualMachine. + +### Example 3: Sets properties on a virtual machine from specialized user image +```powershell +$AvailabilitySet = Get-AzAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet13" +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1" +$VirtualMachine = Set-AzVMOSDisk -VM $VirtualMachine -Name "osDisk.vhd" -VhdUri "https://mystorageaccount.blob.core.windows.net/disks/" -CreateOption Attach -Linux +New-AzVM -VM $VirtualMachine -ResourceGroupName "ResourceGroup11" +``` + +The first command gets the availability set named AvailabilitySet13 in the resource group named ResourceGroup11 and stores that object in the $AvailabilitySet variable. +The second command creates a virtual machine object and stores it in the $VirtualMachine variable. +The command assigns a name and size to the virtual machine. +The virtual machine belongs to the availability set stored in $AvailabilitySet. +The final command sets the properties on the virtual machine in $VirtualMachine. + +### Example 4: Set the disk encryption settings on a virtual machine operating system disk +```powershell +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1" +$VirtualMachine = Set-AzVMOSDisk -VM $VirtualMachine -Name "OsDisk12" -VhdUri "os.vhd" -Caching ReadWrite -Windows -CreateOption "Attach" -DiskEncryptionKeyUrl "https://mytestvault.vault.azure.net/secrets/Test1/514ceb769c984379a7e0230bddaaaaaa" -DiskEncryptionKeyVaultId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/mytestvault" +New-AzVM -VM $VirtualMachine -ResourceGroupName " ResourceGroup11" +``` + +This example sets the disk encryption settings on a virtual machine operating system disk. + +### Example 5: Create a ConfidentialVM virtual machine with VM OS Disk encryption of DiskWithVMGuestState, and Disk Encryption Set encryption of ConfidentialVmEncryptedWithCustomerKey. +```powershell +# Create Resource Group +$Location = 'northeurope'; +New-AzResourceGroup -Name $ResourceGroupName -Location $Location; + +$vmSize = "Standard_DC2as_v5"; +$identityType = "SystemAssigned"; +$secureEncryptGuestState = "DiskWithVMGuestState"; +$vmSecurityType = "ConfidentialVM"; +$securePassword = "Password" | ConvertTo-SecureString -AsPlainText -Force; +$cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword); + +# Create Key Vault +New-AzKeyVault -Name $keyVaultName -Location $Location -ResourceGroupName $ResourceGroupName -Sku Premium -EnablePurgeProtection -EnabledForDiskEncryption; + +$cvmAgent = Get-AzADServicePrincipal -ApplicationId 'bf7b6499-ff71-4aa2-97a4-f372087be7f0'; +Set-AzKeyVaultAccessPolicy -VaultName $keyVaultName -ResourceGroupName $ResourceGroupName -ObjectId $cvmAgent.id -PermissionsToKeys get,release; + +# Add Key vault Key +$KeyName = "keyname"; +$KeySize = 3072; + +Add-AzKeyVaultKey -VaultName $kvname -Name $KeyName -Size $KeySize -KeyOps wrapKey,unwrapKey -KeyType RSA -Destination HSM -Exportable -UseDefaultCVMPolicy; + +# Capture Key Vault and Key details +$encryptionKeyVaultId = (Get-AzKeyVault -VaultName $keyVaultName -ResourceGroupName $ResourceGroupName).ResourceId; +$encryptionKeyURL = (Get-AzKeyVaultKey -VaultName $keyVaultName -KeyName $keyName).Key.Kid; + +# Create new DES Config and Disk Encryption Set +$diskEncryptionType = "ConfidentialVmEncryptedWithCustomerKey"; +$desConfig = New-AzDiskEncryptionSetConfig -Location $loc -SourceVaultId $encryptionKeyVaultId -KeyUrl $encryptionKeyURL -IdentityType SystemAssigned -EncryptionType $diskEncryptionType; +New-AzDiskEncryptionSet -ResourceGroupName $ResourceGroupName -Name $desName -DiskEncryptionSet $desConfig; + +$diskencset = Get-AzDiskEncryptionSet -ResourceGroupName $rgname -Name $desName; + +# Assign DES Access Policy to key vault +$desIdentity = (Get-AzDiskEncryptionSet -Name $desName -ResourceGroupName $ResourceGroupName).Identity.PrincipalId; + +Set-AzKeyVaultAccessPolicy -VaultName $keyVaultName -ResourceGroupName $ResourceGroupName -ObjectId $desIdentity -PermissionsToKeys wrapKey,unwrapKey,get -BypassObjectIdValidation; + +$VirtualMachine = New-AzVMConfig -VMName $VMName -VMSize $vmSize; +$VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName $computerName -Credential $cred -ProvisionVMAgent -EnableAutoUpdate; +$VirtualMachine = Set-AzVMSourceImage -VM $VirtualMachine -PublisherName 'MicrosoftWindowsServer' -Offer 'windowsserver' -Skus '2022-datacenter-smalldisk-g2' -Version "latest"; + +$subnet = New-AzVirtualNetworkSubnetConfig -Name ($subnetPrefix + $ResourceGroupName) -AddressPrefix "10.0.0.0/24"; +$vnet = New-AzVirtualNetwork -Force -Name ($vnetPrefix + $ResourceGroupName) -ResourceGroupName $ResourceGroupName -Location $loc -AddressPrefix "10.0.0.0/16" -Subnet $subnet; +$vnet = Get-AzVirtualNetwork -Name ($vnetPrefix + $ResourceGroupName) -ResourceGroupName $ResourceGroupName; +$subnetId = $vnet.Subnets[0].Id; +$pubip = New-AzPublicIpAddress -Force -Name ($pubIpPrefix + $ResourceGroupName) -ResourceGroupName $ResourceGroupName -Location $loc -AllocationMethod Dynamic -DomainNameLabel $domainNameLabel2; +$pubip = Get-AzPublicIpAddress -Name ($pubIpPrefix + $ResourceGroupName) -ResourceGroupName $ResourceGroupName; +$pubipId = $pubip.Id; +$nic = New-AzNetworkInterface -Force -Name ($nicPrefix + $ResourceGroupName) -ResourceGroupName $ResourceGroupName -Location $loc -SubnetId $subnetId -PublicIpAddressId $pubip.Id; +$nic = Get-AzNetworkInterface -Name ($nicPrefix + $ResourceGroupName) -ResourceGroupName $ResourceGroupName; +$nicId = $nic.Id; + +$VirtualMachine = Add-AzVMNetworkInterface -VM $VirtualMachine -Id $nicId; + +# Set VM SecurityType and connect to DES +$VirtualMachine = Set-AzVMOSDisk -VM $VirtualMachine -StorageAccountType "StandardSSD_LRS" -CreateOption "FromImage" -SecurityEncryptionType $secureEncryptGuestState -SecureVMDiskEncryptionSet $diskencset.Id; +$VirtualMachine = Set-AzVmSecurityProfile -VM $VirtualMachine -SecurityType $vmSecurityType; +$VirtualMachine = Set-AzVmUefi -VM $VirtualMachine -EnableVtpm $true -EnableSecureBoot $true; + +New-AzVM -ResourceGroupName $ResourceGroupName -Location $loc -Vm $VirtualMachine; +$vm = Get-AzVm -ResourceGroupName $ResourceGroupName -Name $vmname; + +# Verify the SecurityEncryptionType value on the disk. +# $vm.StorageProfile.OsDisk.ManagedDisk.SecurityProfile.SecurityEncryptionType == 'DiskWithVMGuestState'; +``` + +## PARAMETERS + +### -Caching +Specifies the caching mode of the operating system disk. +Valid values are: +- ReadOnly +- ReadWrite +The default value is ReadWrite. +Changing the caching value causes the virtual machine to restart. +This setting affects the performance of the disk. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.CachingTypes] +Parameter Sets: (All) +Aliases: +Accepted values: None, ReadOnly, ReadWrite + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateOption +Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, or attaches an existing disk. +Valid values are: +- Attach. +Specify this option to create a virtual machine from a specialized disk. +When you specify this option, do not specify the *SourceImageUri* parameter. +Instead, use the Set-AzVMSourceImage cmdlet. +You must also use the use the *Windows* or *Linux* parameters to tell the azure platform the type of the operating system on the VHD. +The *VhdUri* parameter is enough to tell the azure platform the location of the disk to attach. +- FromImage. +Specify this option to create a virtual machine from a platform image or a generalized user image. +In the case of a generalized user image, you also need to specify the *SourceImageUri* parameter and either the *Windows* or *Linux* parameters to tell the Azure platform the location and type of the operating system disk VHD instead of using the **Set-AzVMSourceImage** cmdlet. +In the case of a platform image, the *VhdUri* parameter is sufficient. +- Empty. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteOption +Specifies OS Disk delete option after VM deletion. Options are Detach, Delete + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiffDiskPlacement +Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e. cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. This parameter can only be used if the parameter DiffDiskSetting is set to 'Local'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiffDiskSetting +Specifies the differencing disk settings for operating system disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionKeyUrl +Specifies the location of the disk encryption key. + +```yaml +Type: System.String +Parameter Sets: WindowsDiskEncryptionParameterSet, LinuxDiskEncryptionParameterSet +Aliases: + +Required: True +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionKeyVaultId +Specifies the resource ID of the Key Vault containing the disk encryption key. + +```yaml +Type: System.String +Parameter Sets: WindowsDiskEncryptionParameterSet, LinuxDiskEncryptionParameterSet +Aliases: + +Required: True +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of customer managed disk encryption set. This can only be specified for managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskSizeInGB +Specifies the size, in GB, of the operating system disk. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyUrl +Specifies the location of the key encryption key. + +```yaml +Type: System.String +Parameter Sets: WindowsDiskEncryptionParameterSet, LinuxDiskEncryptionParameterSet +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyVaultId +Specifies the resource ID of the Key Vault containing the key encryption key. + +```yaml +Type: System.String +Parameter Sets: WindowsDiskEncryptionParameterSet, LinuxDiskEncryptionParameterSet +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Linux +Indicates that the operating system on the user image is Linux. +Specify this parameter for user image based virtual machine deployment. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: LinuxParamSet, LinuxDiskEncryptionParameterSet +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedDiskId +Specifies the ID of a managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the operating system disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: OSDiskName, DiskName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecureVMDiskEncryptionSet +ARM Resource ID for Disk Encryption Set. Allows customer to provide ARM ID for Disk Encryption Set created with ConfidentialVmEncryptedWithCustomerKey encryption type. This will allow customer to use Customer Managed Key (CMK) encryption with Confidential VM. Parameter SecurityEncryptionType value should be DiskwithVMGuestState. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecurityEncryptionType +Sets the SecurityEncryptionType value on the managed disk of the VM. possible values include: TrustedLaunch, ConfidentialVM_DiskEncryptedWithCustomerKey, ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey, ConfidentialVM_DiskEncryptedWithPlatformKey + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceImageUri +Specifies the URI of the VHD for user image scenarios. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SourceImage + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountType +Specifies the storage account type of managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VhdUri +Specifies the Uniform Resource Identifier (URI) of a virtual hard disk (VHD). +For an image based virtual machine, this parameter specifies the VHD file to create when a platform image or user image is specified. +This is the location from which the image binary large object (BLOB) is copied to start the virtual machine. +For a disk based virtual machine boot scenario, this parameter specifies the VHD file that the virtual machine uses directly for starting up. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: OSDiskVhdUri, DiskVhdUri + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +Specifies the local virtual machine object on which to set operating system disk properties. +To obtain a virtual machine object, use the Get-AzVM cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Windows +Indicates that the operating system on the user image is Windows. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WindowsParamSet, WindowsDiskEncryptionParameterSet +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WriteAccelerator +Specifies whether WriteAccelerator should be enabled or disabled on the OS disk. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[Get-AzAvailabilitySet](./Get-AzAvailabilitySet.md) + +[New-AzVMConfig](./New-AzVMConfig.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMOperatingSystem.md b/azps-10.1.0/Az.Compute/Set-AzVMOperatingSystem.md new file mode 100644 index 0000000000..5a0125d55e --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMOperatingSystem.md @@ -0,0 +1,459 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 39AADD19-2EDD-4C1F-BC9E-22186DD9A085 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmoperatingsystem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMOperatingSystem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMOperatingSystem.md +--- + +# Set-AzVMOperatingSystem + +## SYNOPSIS +Sets operating system properties during the creation of a new virtual machine or updating a virtual machine. + +## SYNTAX + +### Windows (Default) +``` +Set-AzVMOperatingSystem [-VM] <PSVirtualMachine> [-Windows] [[-ComputerName] <String>] + [[-Credential] <PSCredential>] [[-CustomData] <String>] [-ProvisionVMAgent] [-EnableAutoUpdate] + [[-TimeZone] <String>] [-WinRMHttp] [-PatchMode <String>] [-EnableHotpatching] [-AssessmentMode <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### WindowsWinRmHttps +``` +Set-AzVMOperatingSystem [-VM] <PSVirtualMachine> [-Windows] [[-ComputerName] <String>] + [[-Credential] <PSCredential>] [[-CustomData] <String>] [-ProvisionVMAgent] [-EnableAutoUpdate] + [[-TimeZone] <String>] [-WinRMHttp] [-WinRMHttps] [-WinRMCertificateUrl] <Uri> [-PatchMode <String>] + [-EnableHotpatching] [-AssessmentMode <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### WindowsDisableVMAgent +``` +Set-AzVMOperatingSystem [-VM] <PSVirtualMachine> [-Windows] [[-ComputerName] <String>] + [[-Credential] <PSCredential>] [[-CustomData] <String>] [-DisableVMAgent] [-EnableAutoUpdate] + [[-TimeZone] <String>] [-WinRMHttp] [-PatchMode <String>] [-EnableHotpatching] [-AssessmentMode <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### WindowsDisableVMAgentWinRmHttps +``` +Set-AzVMOperatingSystem [-VM] <PSVirtualMachine> [-Windows] [[-ComputerName] <String>] + [[-Credential] <PSCredential>] [[-CustomData] <String>] [-DisableVMAgent] [-EnableAutoUpdate] + [[-TimeZone] <String>] [-WinRMHttp] [-WinRMHttps] [-WinRMCertificateUrl] <Uri> [-PatchMode <String>] + [-EnableHotpatching] [-AssessmentMode <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### Linux +``` +Set-AzVMOperatingSystem [-VM] <PSVirtualMachine> [-Linux] [[-ComputerName] <String>] + [[-Credential] <PSCredential>] [[-CustomData] <String>] [-PatchMode <String>] [-DisablePasswordAuthentication] + [-AssessmentMode <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMOperatingSystem** cmdlet sets operating system properties during the creation of a new virtual machine. +You can specify logon credentials, computer name, and operating system type. + +## EXAMPLES + +### Example 1: Set operating system properties for a new virtual machine +```powershell +$SecurePassword = ConvertTo-SecureString "Password" -AsPlainText -Force +$Credential = New-Object System.Management.Automation.PSCredential ("FullerP", $SecurePassword); +$AvailabilitySet = Get-AzAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id +$ComputerName = "ContosoVM122" +$WinRMCertUrl = "http://keyVaultName.vault.azure.net/secrets/secretName/secretVersion" +$TimeZone = "Pacific Standard Time" +$CustomData = "echo 'Hello World'" +$VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName $ComputerName -Credential $Credential -CustomData $CustomData -WinRMHttp -WinRMHttps -WinRMCertificateUrl $WinRMCertUrl -ProvisionVMAgent -EnableAutoUpdate -TimeZone $TimeZone -PatchMode "AutomaticByPlatform" +``` + +The first command converts a password to a secure string, and then stores it in the $SecurePassword variable. +For more information, type `Get-Help ConvertTo-SecureString`. +The second command creates a credential for the user FullerP and the password stored in $SecurePassword, and then stores the credential in the $Credential variable. +For more information, type `Get-Help New-Object`. +The third command gets the availability set named AvailabilitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. +The fourth command creates a virtual machine object, and then stores it in the $VirtualMachine variable. +The command assigns a name and size to the virtual machine. +The virtual machine belongs to the availability set stored in $AvailabilitySet. +The next four commands assign values to variables to use in the following command. +Because you could specify these strings directly in the **Set-AzVMOperatingSystem** command, this approach is used only for readability. +However, you might use an approach such as this in scripts. +The final command sets operating system properties for the virtual machine stored in $VirtualMachine. +The command uses the credentials stored in $Credential. +The command uses variables assigned in previous commands for some parameters. + +### Example 2: Set operating system properties for a new virtual machine with hot patching enabled +```powershell +$SecurePassword = ConvertTo-SecureString "Password" -AsPlainText -Force +$Credential = New-Object System.Management.Automation.PSCredential ("FullerP", $SecurePassword); +$AvailabilitySet = Get-AzAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id +$ComputerName = "ContosoVM122" +$WinRMCertUrl = "http://keyVaultName.vault.azure.net/secrets/secretName/secretVersion" +$TimeZone = "Pacific Standard Time" +$CustomData = "echo 'Hello World'" +$VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName $ComputerName -Credential $Credential -CustomData $CustomData -WinRMHttp -WinRMHttps -WinRMCertificateUrl $WinRMCertUrl -ProvisionVMAgent -EnableAutoUpdate -TimeZone $TimeZone -PatchMode "AutomaticByPlatform" -EnableHotPatching +``` + +The first command converts a password to a secure string, and then stores it in the $SecurePassword variable. +For more information, type `Get-Help ConvertTo-SecureString`. +The second command creates a credential for the user FullerP and the password stored in $SecurePassword, and then stores the credential in the $Credential variable. +For more information, type `Get-Help New-Object`. +The third command gets the availability set named AvailabilitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. +The fourth command creates a virtual machine object, and then stores it in the $VirtualMachine variable. +The command assigns a name and size to the virtual machine. +The virtual machine belongs to the availability set stored in $AvailabilitySet. +The next four commands assign values to variables to use in the following command. +Because you could specify these strings directly in the **Set-AzVMOperatingSystem** command, this approach is used only for readability. +However, you might use an approach such as this in scripts. +The final command sets operating system properties for the virtual machine stored in $VirtualMachine. +The command uses the credentials stored in $Credential. +The command uses variables assigned in previous commands for some parameters. +The command enables Hotpatching on the virtual machine. + +### Example 3: Set operating system properties for a new Linux virtual machine +```powershell +$SecurePassword = ConvertTo-SecureString "Password" -AsPlainText -Force +$Credential = New-Object System.Management.Automation.PSCredential ("FullerP", $SecurePassword); +$AvailabilitySet = Get-AzAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id +$ComputerName = "ContosoVM122" +$CustomData = "echo 'Hello World'" +$VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Linux -ComputerName $ComputerName -Credential $Credential -CustomData $CustomData -PatchMode "AutomaticByPlatform" +``` + +The first command converts a password to a secure string, and then stores it in the $SecurePassword variable. +For more information, type `Get-Help ConvertTo-SecureString`. +The second command creates a credential for the user FullerP and the password stored in $SecurePassword, and then stores the credential in the $Credential variable. +For more information, type `Get-Help New-Object`. +The third command gets the availability set named AvailabilitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. +The fourth command creates a virtual machine object, and then stores it in the $VirtualMachine variable. +The command assigns a name and size to the virtual machine. +The virtual machine belongs to the availability set stored in $AvailabilitySet. +The next two commands assign values to variables to use in the following command. +The final command sets operating system properties for the virtual machine stored in $VirtualMachine. +The command uses the credentials stored in $Credential. +The command uses variables assigned in previous commands for some parameters. +The command sets the patch mode value on the virtual machine to "AutomaticByPlatform". + +## PARAMETERS + +### -AssessmentMode +Automatic assessment mode value for the virtual machine. Possible values are ImageDefault and AutomaticByPlatform. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ComputerName +Specifies the name of the computer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Credential +Specifies the user name and password for the virtual machine as a **PSCredential** object. +To obtain a credential, use the Get-Credential cmdlet. +For more information, type `Get-Help Get-Credential`. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CustomData +Specifies a string to be passed to the virtual machine. For more information see [Custom Data on Azure VMs](https://learn.microsoft.com/azure/virtual-machines/custom-data). +**Note: It is not recommended to store sensitive information in custom data.** + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisablePasswordAuthentication +Indicates that this cmdlet disables password authentication. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Linux +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisableVMAgent +Disable Provision VM Agent. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WindowsDisableVMAgent, WindowsDisableVMAgentWinRmHttps +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoUpdate +Indicates that this cmdlet enables auto update. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Windows, WindowsWinRmHttps, WindowsDisableVMAgent, WindowsDisableVMAgentWinRmHttps +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableHotpatching +Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Windows, WindowsWinRmHttps, WindowsDisableVMAgent, WindowsDisableVMAgentWinRmHttps +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Linux +Indicates that the type of operating system is Linux. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Linux +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PatchMode +Specifies the mode of in-guest patching to IaaS virtual machine.<br><br> +Possible values are:<br> +**AutomaticByPlatform** - Patch installation for the virtual machine will be managed by Azure. Use with -Windows or -Linux. Requires -ProvisionVMAgent. Requires -EnableAutoUpdate when used with -Windows. <br> +**AutomaticByOS** - Patch installation for the virtual machine will be managed by the OS. Use with -Windows. Requires -ProvisionVMAgent and -EnableAutoUpdate.<br> +**Manual** - You control the application of patches to a virtual machine. Use with -Windows. Requires -ProvisionVMAgent.<br> +**ImageDefault** - Patch installation managed by the default settings on the OS image. Use with -Linux. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProvisionVMAgent +Indicates that the settings require that the virtual machine agent be installed on the virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Windows, WindowsWinRmHttps +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TimeZone +Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\". <br> +Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). + +```yaml +Type: System.String +Parameter Sets: Windows, WindowsWinRmHttps, WindowsDisableVMAgent, WindowsDisableVMAgentWinRmHttps +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +Specifies the local virtual machine object on which to set operating system properties. +To obtain a virtual machine object, use the Get-AzVM cmdlet. +Create a virtual machine object by using the New-AzVMConfig cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Windows +Indicates that the type of operating system is Windows. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Windows, WindowsWinRmHttps, WindowsDisableVMAgent, WindowsDisableVMAgentWinRmHttps +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WinRMCertificateUrl +Specifies the URI of a WinRM certificate. +This needs to be stored in a Key Vault. + +```yaml +Type: System.Uri +Parameter Sets: WindowsWinRmHttps, WindowsDisableVMAgentWinRmHttps +Aliases: + +Required: True +Position: 10 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WinRMHttp +Indicates that this operating system uses HTTP WinRM. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Windows, WindowsWinRmHttps, WindowsDisableVMAgent, WindowsDisableVMAgentWinRmHttps +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WinRMHttps +Indicates that this operating system uses HTTPS WinRM. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WindowsWinRmHttps, WindowsDisableVMAgentWinRmHttps +Aliases: + +Required: True +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.Management.Automation.SwitchParameter + +### System.String + +### System.Management.Automation.PSCredential + +### System.Uri + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[New-AzVMConfig](./New-AzVMConfig.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMPlan.md b/azps-10.1.0/Az.Compute/Set-AzVMPlan.md new file mode 100644 index 0000000000..0ff0a2e144 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMPlan.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: A1EA7D34-A8B4-4FA0-BD8C-3E846715AFBA +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMPlan.md +--- + +# Set-AzVMPlan + +## SYNOPSIS +Sets the Marketplace plan information on a virtual machine. + +## SYNTAX + +``` +Set-AzVMPlan [-VM] <PSVirtualMachine> [-Name] <String> [[-Product] <String>] [[-PromotionCode] <String>] + [[-Publisher] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMPlan** cmdlet sets the Azure Marketplace plan information for a virtual machine. +Before being able to deploy a Marketplace image through the command-line, programmatic access must be enabled or the virtual machine must be deployed by using the Azure portal. + +## EXAMPLES + +### Example 1 +```powershell +New-AzVMConfig -VMName "VirtualMachine07" -VMSize "Standard_B1s" | + Set-AzVMPlan -Publisher "Canonical" -Product "UbuntuServer" -Name "18.04-LTS" +``` + +```Output +Name : VirtualMachine07 +HardwareProfile : {VmSize} +Plan : {Name, Publisher, Product} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the image from the Marketplace. +This is the same value that is returned by the Get-AzVMImageSku cmdlet. +For more information about how to find image information, see [Find and use Azure Marketplace VM images with Azure PowerShell](/azure/virtual-machines/windows/cli-ps-findimage) in the Microsoft Azure documentation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Product +Specifies the product of the image from the Marketplace. +This is the same information as the **Offer** value of the **imageReference** element. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PromotionCode +Specifies a promotion code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Publisher +Specifies the publisher of the image. +You can find this information by using the Get-AzVMImagePublisher cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine object for which to set a Marketplace plan. +You can use the Get-AzVM cmdlet to obtain a virtual machine object. +You can use the New-AzVMConfig cmdlet to create a virtual machine object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[Get-AzVMImagePublisher](./Get-AzVMImagePublisher.md) + +[Get-AzVMImageSku](./Get-AzVMImageSku.md) + +[New-AzVMConfig](./New-AzVMConfig.md) diff --git a/azps-10.1.0/Az.Compute/Set-AzVMRunCommand.md b/azps-10.1.0/Az.Compute/Set-AzVMRunCommand.md new file mode 100644 index 0000000000..6f5d9fd8ea --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMRunCommand.md @@ -0,0 +1,510 @@ +--- +external help file: Az.Compute-help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmruncommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMRunCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMRunCommand.md +--- + +# Set-AzVMRunCommand + +## SYNOPSIS +The operation to create or update the run command. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzVMRunCommand -ResourceGroupName <String> -RunCommandName <String> -VMName <String> + [-SubscriptionId <String>] -Location <String> [-AsyncExecution] [-ErrorBlobUri <String>] + [-OutputBlobUri <String>] [-Parameter <IRunCommandInputParameter[]>] + [-ProtectedParameter <IRunCommandInputParameter[]>] [-RunAsPassword <String>] [-RunAsUser <String>] + [-SourceCommandId <String>] [-SourceScript <String>] [-SourceScriptUri <String>] [-Tag <Hashtable>] + [-TimeoutInSecond <Int32>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ScriptLocalPath +``` +Set-AzVMRunCommand -ResourceGroupName <String> -RunCommandName <String> -VMName <String> + [-SubscriptionId <String>] -Location <String> [-AsyncExecution] [-ErrorBlobUri <String>] + [-OutputBlobUri <String>] [-Parameter <IRunCommandInputParameter[]>] + [-ProtectedParameter <IRunCommandInputParameter[]>] [-RunAsPassword <String>] [-RunAsUser <String>] + [-Tag <Hashtable>] [-TimeoutInSecond <Int32>] -ScriptLocalPath <String> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to create or update the run command. + +## EXAMPLES + +### Example 1: Create or update Run Command on a VM using a storage blob SAS URL +```powershell +Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri "https://myst.blob.core.windows.net/mycontainer/myscript.ps1?sp=r&st=2022-10-27T21:02:35Z&se=2022-10-28T05:02:35Z&spr=https&sv=2021-06-08&sr=b&sig=0I%2FIiYayRwHasfasasfdasdfasdeTsQjLnpZjA%3D" +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap MyRunCommand Microsoft.Compute/virtualMachines/runCommands +``` + +Create or update Run Command on a Windows VM using a SAS URL of a storage blob that contains .ps1 script. +Note SAS URL must provide read access to the blob. +An expiry time of 24 hours is suggested for SAS URL. +SAS URLs can be generated on Azure portal using blob's options , or SAS token using New-AzStorageBlobSASToken. +If generating SAS token using New-AzStorageBlobSASToken, your SAS URL = base blob URL + "?" + SAS token from New-AzStorageBlobSASToken. + +### Example 2: Create or update Run Command on a VM using a local script file. +```powershell +Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap MyRunCommand Microsoft.Compute/virtualMachines/runCommands +``` + +Create or update Run Command on a VM using a local script file that is on the client machine where cmdlet is executed. + +### Example 3: Create or update Run Command on a VM using script text. +```powershell +Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand2 -Location EastUS2EUAP -SourceScript "id; echo HelloWorld" +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap MyRunCommand2 Microsoft.Compute/virtualMachines/runCommands +``` + +Create or update Run Command on a VM passing the script content directly to -SourceScript parameter. +Use ';' to delimit multiple commands. + +### Example 4: Create or update Run Command on a VM using commandId. +```powershell +Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceCommandId DisableWindowsUpdate +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap MyRunCommand Microsoft.Compute/virtualMachines/runCommands +``` + +Create or update Run Command on a VM using pre-existing commandId. +Available commandIds can be retrieved using Get-AzVMRunCommandDocument. + +### Example 5: Create or update Run Command on a VM and stream standard output and standard error messages to output and error Append blobs. +```powershell +Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand3 -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -OutputBlobUri "https://vivst.blob.core.windows.net/vivcontainer/output.txt?sp=racw&st=2022-10-27T22:18:36Z&se=2022-10-28T06:18:36Z&spr=https&sv=2021-06-08&sr=b&sig=HQAu3Bl%2BKMofYTjMo8o5hasfadsfasdF4jIkRJra4S5FlEo%3D" -ErrorBlobUri "https://vivst.blob.core.windows.net/vivcontainer/error.txt?sp=racw&st=2022-10-27T22:18:36Z&se=2022-10-28T06:18:36Z&spr=https&sv=2021-06-08&sr=b&sig=HQAu3Bl%2BKMofYTjMo8o5h%asfasdfgdT%2F4jasfasdf5FlEo%3D" +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap MyRunCommand3 Microsoft.Compute/virtualMachines/runCommands +``` + +Create or update Run Command on a VM and stream standard output and standard error messages to output and error Append blobs. +Note output and error blobs must be of type AppendBlob and their SAS URLs must provide read, append, create, write access to the blob. +An expiry time of 24 hours is suggested for SAS URL. +If output or error blob does not exist, a blob of type AppendBlob will be created. +SAS URLs can be generated on Azure portal using blob's options , or SAS token using New-AzStorageBlobSASToken. +If generating SAS token using New-AzStorageBlobSASToken, your SAS URL = base blob URL + "?" + SAS token from New-AzStorageBlobSASToken. + +### Example 6: Create or update Run Command on a VM, run the Run Command as a different user using RunAsUser and RunAsPassword parameters. +```powershell +Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -RunAsUser myusername -RunAsPassword mypassword +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap MyRunCommand Microsoft.Compute/virtualMachines/runCommands +``` + +Create or update Run Command on a VM, run the Run Command as a different user using RunAsUser and RunAsPassword parameters. +For RunAs to work properly, contact admin of VM and make sure user is added on the VM, user has access to resources accessed by the Run Command (Directories, Files, Network etc.), and in case of Windows VM, 'Secondary Logon' service is running on the VM. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsyncExecution +Optional. +If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ErrorBlobUri +Specifies the Azure storage blob where script error stream will be uploaded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputBlobUri +Specifies the Azure storage blob where script output stream will be uploaded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +The parameters used by the script. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectedParameter +The parameters used by the script. +To construct, see NOTES section for PROTECTEDPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunAsPassword +Specifies the user account password on the VM when executing the run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunAsUser +Specifies the user account on the VM when executing the run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunCommandName +The name of the virtual machine run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptLocalPath + +```yaml +Type: System.String +Parameter Sets: ScriptLocalPath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceCommandId +Specifies a commandId of predefined built-in script. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceScript +Specifies the script content to be executed on the VM. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceScriptUri +Specifies the script download location. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutInSecond +The timeout in seconds to execute the run command. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName +The name of the virtual machine where the run command should be created or updated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IVirtualMachineRunCommand + +## 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. + + +`PARAMETER <IRunCommandInputParameter[]>`: The parameters used by the script. + - `Name <String>`: The run command parameter name. + - `Value <String>`: The run command parameter value. + +`PROTECTEDPARAMETER <IRunCommandInputParameter[]>`: The parameters used by the script. + - `Name <String>`: The run command parameter name. + - `Value <String>`: The run command parameter value. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzVMSecurityProfile.md b/azps-10.1.0/Az.Compute/Set-AzVMSecurityProfile.md new file mode 100644 index 0000000000..9fccd1c274 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMSecurityProfile.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmsecurityprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMSecurityProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMSecurityProfile.md +--- + +# Set-AzVMSecurityProfile + +## SYNOPSIS +Sets the SecurityType enum for Virtual Machines. + +## SYNTAX + +``` +Set-AzVMSecurityProfile [-VM] <PSVirtualMachine> [-SecurityType <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMSecurityProfile** cmdlet sets the Security Type of the VM + +## EXAMPLES + +### Example 1 +```powershell +$VM = Get-AzVM -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM07" +$VM = Set-AzVMSecurityProfile -VM $VM -SecurityType "TrustedLaunch" +``` + +The first command gets the virtual machine named ContosoVM07 by using **Get-AzVm**. +The command stores it in the $VM variable. +The second command sets the SecurityType enum to "TrustedLaunch". Trusted launch requires the creation of new virtual machines. You can't enable trusted launch on existing virtual machines that were initially created without it. + +### Example 2: Create a ConfidentialVM Virtual Machine and the Disk encrypted with the VMGuestStateOnly type. +```powershell +$vmSize = "Standard_DC2as_v5"; +$DNSNameLabel = "cvm1" +$ResourceGroupName; +$SubnetAddressPrefix = "10.0.0.0/24"; +$VnetAddressPrefix = "10.0.0.0/16"; + +# Credential setup. +$password = "Password" |ConvertTo-SecureString -AsPlainText -Force; +$securePassword = ConvertTo-SecureString $password -AsPlainText -Force; +$credential = New-Object System.Management.Automation.PSCredential ($user, $securePassword); + +$SecurityType = "ConfidentialVM"; +$vmDiskSecurityEncryptionType = "VMGuestStateOnly"; +$VirtualMachine = New-AzVMConfig -VMName $VMName -VMSize $VMSize; + +# Create the Network resources and VM OS setup. +$SingleSubnet = New-AzVirtualNetworkSubnetConfig -Name $SubnetName -AddressPrefix $SubnetAddressPrefix; +$Vnet = New-AzVirtualNetwork -Name $NetworkName -ResourceGroupName $rgname -Location $LocationName -AddressPrefix $VnetAddressPrefix -Subnet $SingleSubnet; +$PIP = New-AzPublicIpAddress -Name $PublicIPAddressName -DomainNameLabel $DNSNameLabel -ResourceGroupName $rgname -Location $LocationName -AllocationMethod Dynamic; +$NIC = New-AzNetworkInterface -Name $NICName -ResourceGroupName $rgname -Location $LocationName -SubnetId $Vnet.Subnets[0].Id -PublicIpAddressId $PIP.Id; +$VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName $ComputerName -Credential $Credential -ProvisionVMAgent -EnableAutoUpdate; +$VirtualMachine = Add-AzVMNetworkInterface -VM $VirtualMachine -Id $NIC.Id; +$VirtualMachine = Set-AzVMSourceImage -VM $VirtualMachine -PublisherName 'MicrosoftWindowsServer' -Offer 'windowsserver' -Skus '2022-datacenter-smalldisk-g2' -Version 'latest'; +$VirtualMachine = Set-AzVMOSDisk -VM $VirtualMachine -StorageAccountType "StandardSSD_LRS" -CreateOption "FromImage"; + +# Set the SecurityType and necessary values on the Uefi settings. +$VirtualMachine = Set-AzVmSecurityProfile -VM $VirtualMachine -SecurityType $SecurityType; +$VirtualMachine = Set-AzVmUefi -VM $VirtualMachine -EnableVtpm $true -EnableSecureBoot $true; + +# Set the Disk Encryption Type. +$VirtualMachine = Set-AzVMOSDisk -VM $VirtualMachine -StorageAccountType "StandardSSD_LRS" -CreateOption "FromImage" -SecurityEncryptionType $vmDiskSEcurityEncryptionType; + +$vm = New-AzVM -ResourceGroupName $rgname -Location $LocationName -VM $VirtualMachine; +$vm = Get-AzVm -ResourceGroupName $rgname -Name $vmname; +# Verify SecurityType value. +# $vm.SecurityProfile.SecurityType == "ConfidentialVM"; +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityType +Enum that represents the security type (ex: Trusted Launch) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +The virtual machine profile. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### Microsoft.Azure.Management.Compute.Models.SecurityTypes + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzVMSourceImage.md b/azps-10.1.0/Az.Compute/Set-AzVMSourceImage.md new file mode 100644 index 0000000000..630adefb92 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMSourceImage.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 91B2DE2F-442D-4428-8A6F-9C2CEC181CA7 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmsourceimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMSourceImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMSourceImage.md +--- + +# Set-AzVMSourceImage + +## SYNOPSIS +Specifies the image for a virtual machine. + +## SYNTAX + +### ImageReferenceSkuParameterSet (Default) +``` +Set-AzVMSourceImage [-VM] <PSVirtualMachine> [-PublisherName] <String> [-Offer] <String> [-Skus] <String> + [-Version] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ImageReferenceIdParameterSet +``` +Set-AzVMSourceImage [-VM] <PSVirtualMachine> [-Id] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMSourceImage** cmdlet specifies the platform image to use for a virtual machine. + +## EXAMPLES + +### Example 1: Set values for an image +```powershell +$AvailabilitySet = Get-AzAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" +$VirtualMachine = New-AzVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id +Set-AzVMSourceImage -VM $VirtualMachine -PublisherName "MicrosoftWindowsServer" -Offer "WindowsServer" -Skus "2012-R2-Datacenter" -Version "latest" +``` + +The first command gets the availability set named AvailabilitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. +The second command creates a virtual machine object, and then stores it in the $VirtualMachine variable. +The command assigns a name and size to the virtual machine. +The virtual machine belongs to the availability set stored in $AvailabilitySet. +The final command sets values for publisher name, offer, SKU, and version. +The **Get-AzVMImagePublisher**, **Get-AzVMImageOffer**, **Get-AzVMImageSku**, and **Get-AzVMImage** cmdlets can discover these settings. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID. + +```yaml +Type: System.String +Parameter Sets: ImageReferenceIdParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Offer +Specifies the type of VMImage offer. +To obtain an image offer, use the Get-AzVMImageOffer cmdlet. + +```yaml +Type: System.String +Parameter Sets: ImageReferenceSkuParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublisherName +Specifies the name of a publisher of a VMImage. +To obtain a publisher, use the Get-AzVMImagePublisher cmdlet. + +```yaml +Type: System.String +Parameter Sets: ImageReferenceSkuParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Skus +Specifies a VMImage SKU. +To obtain SKUs, use the Get-AzVMImageSku cmdlet. + +```yaml +Type: System.String +Parameter Sets: ImageReferenceSkuParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Specifies a version of a VMImage. +To use the latest version, specify a value of latest instead of a particular version. + +```yaml +Type: System.String +Parameter Sets: ImageReferenceSkuParameterSet +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +Specifies the local virtual machine object to configure. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS + +[Get-AzAvailabilitySet](./Get-AzAvailabilitySet.md) + +[Get-AzVMImage](./Get-AzVMImage.md) + +[Get-AzVMImageOffer](./Get-AzVMImageOffer.md) + +[Get-AzVMImagePublisher](./Get-AzVMImagePublisher.md) + +[Get-AzVMImageSku](./Get-AzVMImageSku.md) + +[New-AzVMConfig](./New-AzVMConfig.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMSqlServerExtension.md b/azps-10.1.0/Az.Compute/Set-AzVMSqlServerExtension.md new file mode 100644 index 0000000000..281421341a --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMSqlServerExtension.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: C650E465-7CDE-47F8-B85A-8FA3E1756FAF +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmsqlserverextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMSqlServerExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMSqlServerExtension.md +--- + +# Set-AzVMSqlServerExtension + +## SYNOPSIS +Sets the Azure SQL Server extension on a virtual machine. + +## SYNTAX + +``` +Set-AzVMSqlServerExtension [[-Version] <String>] [-ResourceGroupName] <String> [-VMName] <String> + [[-Name] <String>] [[-AutoPatchingSettings] <AutoPatchingSettings>] + [[-AutoBackupSettings] <AutoBackupSettings>] [[-KeyVaultCredentialSettings] <KeyVaultCredentialSettings>] + [[-Location] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMSqlServerExtension** cmdlet sets the AzureSQL Server extension on a virtual machine. + +## EXAMPLES + +### Example 1: Set automatic patching settings on a virtual machine +```powershell +$AutoPatchingConfig = New-AzVMSqlServerAutoPatchingConfig -Enable -DayOfWeek "Thursday" -MaintenanceWindowStartingHour 11 -MaintenanceWindowDuration 120 -PatchCategory "Important" +Get-AzVM -ResourceGroupName "testrg" -Name "VirtualMachine11" | Set-AzVMSqlServerExtension -AutoPatchingSettings $AutoPatchingConfig | Update-AzVM +``` + +The first command creates a configuration object by using the **New-AzVMSqlServerAutoPatchingConfig** cmdlet. +The command stores the configuration in the $AutoPatchingConfig variable. +The second command gets the virtual machine named VirtualMachine11 in the Resource Group testrg by using the Get-AzVM cmdlet. +The command passes that object to the current cmdlet by using the pipeline operator. +The current cmdlet sets the automatic patching settings in $AutoPatchingConfig for the virtual machine. +The command passes the virtual machine to the Update-AzVM cmdlet. + +### Example 2: Set automatic backup settings on a virtual machine +```powershell +$AutoBackupConfig = New-AzVMSqlServerAutoBackupConfig -Enable -RetentionPeriodInDays 10 -StorageUri $StorageUrl -StorageKey $StorageAccountKeySecure +Get-AzVM -ResourceGroupName "testrg" -Name "VirtualMachine11" | Set-AzVMSqlServerExtension -AutoBackupSettings $AutoBackupConfig | Update-AzVM +``` + +The first command creates a configuration object by using the **New-AzVMSqlServerAutoBackupConfig** cmdlet. +The command stores the configuration in the $AutoBackupConfig variable. +The second command gets the virtual machine named VirtualMachine11 in the Resource Group testrg, and then passes it to the current cmdlet. +The current cmdlet sets the automatic backup settings in $AutoBackupConfig for the virtual machine. +The command passes the virtual machine to the Update-AzVM cmdlet. + +## PARAMETERS + +### -AutoBackupSettings +Specifies the automatic SQL Server backup settings. +To create an **AutoBackupSettings** object , use the New-AzVMSqlServerAutoBackupConfig cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Compute.AutoBackupSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutoPatchingSettings +Specifies the automatic SQL Server patching settings. +To create an **AutoPatchingSettings** object , use the New-AzVMSqlServerAutoPatchingConfig cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Compute.AutoPatchingSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultCredentialSettings +```yaml +Type: Microsoft.Azure.Commands.Compute.KeyVaultCredentialSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the SQL Server the extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Specifies the version of the SQL Server extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HandlerVersion + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine on which this cmdlet sets the SQL Server extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.AutoPatchingSettings + +### Microsoft.Azure.Commands.Compute.AutoBackupSettings + +### Microsoft.Azure.Commands.Compute.KeyVaultCredentialSettings + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[Get-AzVMSqlServerExtension](./Get-AzVMSqlServerExtension.md) + +[New-AzVMSqlServerAutoPatchingConfig](./New-AzVMSqlServerAutoPatchingConfig.md) + +[New-AzVMSqlServerAutoBackupConfig](./New-AzVMSqlServerAutoBackupConfig.md) + +[Remove-AzVMSqlServerExtension](./Remove-AzVMSqlServerExtension.md) + +[Update-AzVM](./Update-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVMUefi.md b/azps-10.1.0/Az.Compute/Set-AzVMUefi.md new file mode 100644 index 0000000000..9530674e1b --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVMUefi.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmuefi +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMUefi.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVMUefi.md +--- + +# Set-AzVMUefi + +## SYNOPSIS +Modifies UEFI properties of a gen 2 virtual machine + +## SYNTAX + +``` +Set-AzVMUefi [-VM] <PSVirtualMachine> [-EnableVtpm <Boolean>] [-EnableSecureBoot <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVMUefi** cmdlet modifies UEFI properties of a virtual machine. + +## EXAMPLES + +### Example 1 +```powershell +$VM = Get-AzVM -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM07" +Set-AzVMUefi -VM $VM -EnableVtpm $true -EnableSecureBoot $true +``` + +The first command gets the virtual machine named ContosoVM07 by using **Get-AzVM**. +The command stores it in the $VM variable. +The second command modifies the UEFI settings to enable SecureBoot and vTPM on the virtual machine in $VM. +The command passes the result to the Update-AzVM cmdlet, which implements your changes. +A change to the cashing mode causes the virtual machine to restart. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSecureBoot +Parameter to toggle secure boot on the VM + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableVtpm +Parameter to toggle vTPM on the VM + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +The virtual machine profile. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzVmss.md b/azps-10.1.0/Az.Compute/Set-AzVmss.md new file mode 100644 index 0000000000..0b5777074c --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVmss.md @@ -0,0 +1,280 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 6442E5BB-D59D-483B-8AC5-2586C6C1E925 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmss +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmss.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmss.md +--- + +# Set-AzVmss + +## SYNOPSIS +Sets specific actions on a specified VMSS. + +## SYNTAX + +### DefaultParameter (Default) +``` +Set-AzVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-TempDisk] + [-Reimage] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FriendMethod +``` +Set-AzVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-ReimageAll] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RedeployMethodParameter +``` +Set-AzVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-Redeploy] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PerformMaintenanceMethodParameter +``` +Set-AzVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] + [-PerformMaintenance] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVmss** cmdlet sets specific actions on the Virtual Machine Scale Set (VMSS). +The only action this cmdlet supports is Reimage. + +## EXAMPLES + +### Example 1: Reimage a VMSS +```powershell +Set-AzVmss -Reimage -ResourceGroupName "ContosoGroup" -VMScaleSetName "ContosoVMSS" +``` + +This command reimages the VMSS named ContosoVMSS that belongs to the resource group named ContosoGroup. + +### Example 2 + +Sets specific actions on a specified VMSS. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzVmss -ReimageAll -ResourceGroupName 'ContosoGroup' -VMScaleSetName 'ContosoVMSS' +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceId +The instance ID of the virtual machine. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PerformMaintenance +Indicates that this cmdlet performs maintenance one or more virtual machines in the VMSS. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PerformMaintenanceMethodParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Redeploy +Indicates that the cmdlet redeploys one or more virtual machines in the VMSS. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RedeployMethodParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reimage +Indicates that the cmdlet reimages the VMSS. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReimageAll +Indicates that the cmdlet reimages all the disks in the VMSS. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FriendMethod +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the VMSS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TempDisk +Specifies whether to reimage temp disk. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultParameter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMScaleSetName +Species the name of the VMSS for which this cmdlet sets actions on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVmss](./Get-AzVmss.md) + +[New-AzVmss](./New-AzVmss.md) + +[Remove-AzVmss](./Remove-AzVmss.md) + +[Restart-AzVmss](./Restart-AzVmss.md) + +[Start-AzVmss](./Start-AzVmss.md) + +[Stop-AzVmss](./Stop-AzVmss.md) + +[Update-AzVmss](./Update-AzVmss.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVmssBootDiagnostic.md b/azps-10.1.0/Az.Compute/Set-AzVmssBootDiagnostic.md new file mode 100644 index 0000000000..1813547f1f --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVmssBootDiagnostic.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmssbootdiagnostic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssBootDiagnostic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssBootDiagnostic.md +--- + +# Set-AzVmssBootDiagnostic + +## SYNOPSIS +Sets the virtual machine scale set boot diagnostics profile. + +## SYNTAX + +``` +Set-AzVmssBootDiagnostic [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Enabled] <Boolean>] + [[-StorageUri] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets the virtual machine scale set boot diagnostics profile. + +## EXAMPLES + +### Example 1: Set the boot diagnostics profile property for a VMSS +```powershell +$vmss = New-AzVmssConfig -Location $loc -SkuCapacity 2 -SkuName 'Standard_A0' +Set-AzVmssBootDiagnostic -VirtualMachineScaleSet $vmss -Enabled $true -StorageUri $storageUri; +New-AzVmss -ResourceGroupName $rgname -Name "ContosoVMSS" -VirtualMachineScaleSet $vmss; +``` + +This command sets boot diagnostics profile property for the VMSS named ContosoVMSS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Whether boot diagnostics should be enabled on the virtual machine scale set. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageUri +URI of the storage account to use for placing the console output and screenshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specifies the VMSS object. +You can use the New-AzVmssConfig cmdlet to create the object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzVmssDiskEncryptionExtension.md b/azps-10.1.0/Az.Compute/Set-AzVmssDiskEncryptionExtension.md new file mode 100644 index 0000000000..fcff35c99e --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVmssDiskEncryptionExtension.md @@ -0,0 +1,391 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmssdiskencryptionextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssDiskEncryptionExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssDiskEncryptionExtension.md +--- + +# Set-AzVmssDiskEncryptionExtension + +## SYNOPSIS +Enables disk encryption on a VM scale set. + +## SYNTAX + +``` +Set-AzVmssDiskEncryptionExtension [-ResourceGroupName] <String> [-VMScaleSetName] <String> + [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String> [-KeyEncryptionKeyUrl <String>] + [-KeyEncryptionKeyVaultId <String>] [-KeyEncryptionAlgorithm <String>] [-VolumeType <String>] [-ForceUpdate] + [-TypeHandlerVersion <String>] [-ExtensionPublisherName <String>] [-ExtensionName <String>] + [-ExtensionType <String>] [-EncryptFormatAll] [-Passphrase <String>] [-Force] + [-DisableAutoUpgradeMinorVersion] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVmssDiskEncryptionExtension** cmdlet enables encryption on a VM scale set. This cmdlet enables encryption by installing the disk encryption extension on the VM scale set. + +For Linux virtual machines, the *VolumeType* parameter must be present and must be set to "Data" + +## EXAMPLES + +### Example 1 +```powershell +$RGName = "MyResourceGroup" +$VmssName = "MyTestVmss" +$VaultName= "MyKeyVault" +$KeyVault = Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName +$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri +$KeyVaultResourceId = $KeyVault.ResourceId + +Set-AzVmssDiskEncryptionExtension -ResourceGroupName $RGName -VMScaleSetName $VmssName -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId +``` + +This command enables encryption on all disks of all Windows VMs in a VM scale set. + +### Example 2 +```powershell +$RGName = "MyResourceGroup" +$VmssName = "MyTestVmss" +$VaultName= "MyKeyVault" +$KeyVault = Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName +$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri +$KeyVaultResourceId = $KeyVault.ResourceId +$VolumeType = "Data" + +Set-AzVmssDiskEncryptionExtension -ResourceGroupName $RGName -VMScaleSetName $VmssName -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId ` + -VolumeType $volumeType +``` + +This command enables encryption on the data disks of all Linux VMs in a VM scale set. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAutoUpgradeMinorVersion +Disable auto-upgrade of minor version + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionKeyVaultId +ResourceID of the KeyVault where generated encryption key will be placed to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskEncryptionKeyVaultUrl +URL of the KeyVault where generated encryption key will be placed to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptFormatAll +EncryptFormatAll data drives that are not already encrypted + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionName +The extension name. +If this parameter is not specified, default values used are AzureDiskEncryption for Windows VMs and AzureDiskEncryptionForLinux for Linux VMs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExtensionPublisherName +The extension publisher name. If this parameter is not specified, default value is Microsoft.Azure.Security for Windows VMs and Linux VMs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExtensionType +The extension type. Specify this parameter to override its default value of "AzureDiskEncryption" for Windows VMs and "AzureDiskEncryptionForLinux" for Linux VMs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +To force enabling encryption on the virtual machine scale set. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpdate +Generate a tag for force update. This should be given to perform repeated encryption operations on the same VM. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyEncryptionAlgorithm +KeyEncryption Algorithm used to encrypt the volume encryption key + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: RSA-OAEP, RSA1_5 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyUrl +Versioned KeyVault URL of the KeyEncryptionKey used to encrypt the disk encryption key + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyVaultId +ResourceID of the KeyVault containing the KeyEncryptionKey used to encrypt the disk encryption key + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Passphrase +The passphrase specified in parameters. +This parameter only works for Linux VM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name to which the VM Scale Set belongs to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +The type handler version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HandlerVersion, Version + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +Name of the virtual machine scale set + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeType +Specifies the type of virtual machine volumes on which to perform encryption operation: OS, Data, or All. + +Linux: The **VolumeType** parameter must be present and must be set to Data. + +Windows: The **VolumeType** parameter, if present, must be set to either All or OS. If the **VolumeType** parameter is omitted it defaults to "All". + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: OS, Data, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineScaleSetExtension + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzVmssOrchestrationServiceState.md b/azps-10.1.0/Az.Compute/Set-AzVmssOrchestrationServiceState.md new file mode 100644 index 0000000000..25d52f8128 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVmssOrchestrationServiceState.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmssorchestrationservicestate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssOrchestrationServiceState.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssOrchestrationServiceState.md +--- + +# Set-AzVmssOrchestrationServiceState + +## SYNOPSIS +Sets the orchestration service state for the VMSS. + +## SYNTAX + +### DefaultParameter (Default) +``` +Set-AzVmssOrchestrationServiceState [-ResourceGroupName] <String> [-VMScaleSetName] <String> + [-ServiceName] <String> [-Action] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Set-AzVmssOrchestrationServiceState [-ServiceName] <String> [-Action] <String> [-ResourceId] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameter +``` +Set-AzVmssOrchestrationServiceState [-ServiceName] <String> [-Action] <String> + [-InputObject] <PSVirtualMachineScaleSet> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets the orchestration service state for the VMSS. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzVmssOrchestrationServiceState -ResourceGroupName "rg" -VMScaleSetName "vmss1" -ServiceName "AutomaticRepairs" -Action "Suspend" +``` + +This command suspends Automatic Repairs service on the VMSS "vmss1" in the resource group "rg". + +### Example 2 +```powershell +Get-AzVmss -ResourceGroupName "rg" -VMScaleSetName "vmss1" | Set-AzVmssOrchestrationServiceState -ServiceName "AutomaticRepairs" -Action "Resume" +``` + +This command resumes Automatic Repairs service on the VMSS "vmss1" in the resource group "rg". + +## PARAMETERS + +### -Action +The action to be performed. Possible values are: Resume, Suspend. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The local object of the virtual machine scale set. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: ObjectParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The ID of the resource. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +The name of the service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +The name of the virtual machine scale set. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzVmssOsProfile.md b/azps-10.1.0/Az.Compute/Set-AzVmssOsProfile.md new file mode 100644 index 0000000000..48b30c30b8 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVmssOsProfile.md @@ -0,0 +1,553 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 3E7B9EFA-8BC2-46EB-9AD7-43EAB7FF3891 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmssosprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssOsProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssOsProfile.md +--- + +# Set-AzVmssOsProfile + +## SYNOPSIS +Sets the VMSS operating system profile properties. + +## SYNTAX + +``` +Set-AzVmssOsProfile [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-ComputerNamePrefix] <String>] + [[-AdminUsername] <String>] [[-AdminPassword] <String>] [[-CustomData] <String>] + [[-WindowsConfigurationProvisionVMAgent] <Boolean>] [-LinuxConfigurationProvisionVMAgent <Boolean>] + [[-WindowsConfigurationEnableAutomaticUpdate] <Boolean>] [[-TimeZone] <String>] + [[-AdditionalUnattendContent] <AdditionalUnattendContent[]>] [[-Listener] <WinRMListener[]>] + [[-LinuxConfigurationDisablePasswordAuthentication] <Boolean>] [[-PublicKey] <SshPublicKey[]>] + [[-Secret] <VaultSecretGroup[]>] [-WindowsConfigurationPatchMode <String>] + [-LinuxConfigurationPatchMode <String>] [-EnableHotpatching] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVmssOsProfile** cmdlet sets the Virtual Machine Scale Set operating system profile properties. + +## EXAMPLES + +### Example 1: Set the operating system profile properties for a VMSS +```powershell +$vmss = New-AzVmssConfig -Location $Loc -SkuCapacity 2 -SkuName "Standard_A0" -UpgradePolicyMode "Automatic" -NetworkInterfaceConfiguration $NetCfg +Set-AzVmssOsProfile -VirtualMachineScaleSet $vmss -ComputerNamePrefix "Test" -AdminUsername $AdminUsername -AdminPassword $AdminPassword +``` + +This command sets operating system profile properties for the $vmss object. +The command sets the computer name prefix for all the virtual machine instances in the VMSS to Test and supplies the administrator username and password. + +### Example 2: Set the operating system profile properties for a Vmss in Flexible mode with Hotpatching enabled. +```powershell +# Setup variables. +$loc = "eastus"; +$rgname = "<Resource Group Name>"; +$vmssName = "myVmssSlb"; +$vmNamePrefix = "vmSlb"; +$vmssInstanceCount = 5; +$vmssSku = "Standard_DS1_v2"; +$vnetname = "myVnet"; +$vnetAddress = "10.0.0.0/16"; +$subnetname = "default-slb"; +$subnetAddress = "10.0.2.0/24"; +$securePassword = "<Password>" | ConvertTo-SecureString -AsPlainText -Force; +$cred = New-Object System.Management.Automation.PSCredential ("<Username>", $securePassword); + +# VMSS Flex requires explicit outbound access. +# Create a virtual network. +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name $subnetname -AddressPrefix $subnetAddress; +$virtualNetwork = New-AzVirtualNetwork -Name $vnetname -ResourceGroupName $rgname -Location $loc -AddressPrefix $vnetAddress -Subnet $frontendSubnet; + +# Create a public IP address. +$publicIP = New-AzPublicIpAddress ` + -ResourceGroupName $rgname ` + -Location $loc ` + -AllocationMethod Static ` + -Sku "Standard" ` + -IpAddressVersion "IPv4" ` + -Name "myLBPublicIP"; + +# Create a frontend and backend IP pool. +$frontendIP = New-AzLoadBalancerFrontendIpConfig ` + -Name "myFrontEndPool" ` + -PublicIpAddress $publicIP; + +$backendPool = New-AzLoadBalancerBackendAddressPoolConfig -Name "myBackEndPool" ; + +# Create the load balancer. +$lb = New-AzLoadBalancer ` + -ResourceGroupName $rgname ` + -Name "myLoadBalancer" ` + -Sku "Standard" ` + -Tier "Regional" ` + -Location $loc ` + -FrontendIpConfiguration $frontendIP ` + -BackendAddressPool $backendPool; + +# Create a load balancer health probe for TCP port 80. +Add-AzLoadBalancerProbeConfig -Name "myHealthProbe" ` + -LoadBalancer $lb ` + -Protocol TCP ` + -Port 80 ` + -IntervalInSeconds 15 ` + -ProbeCount 2; + +# Create a load balancer rule to distribute traffic on port TCP 80. +# The health probe from the previous step is used to make sure that traffic is +# only directed to healthy VM instances. +Add-AzLoadBalancerRuleConfig ` + -Name "myLoadBalancerRule" ` + -LoadBalancer $lb ` + -FrontendIpConfiguration $lb.FrontendIpConfigurations[0] ` + -BackendAddressPool $lb.BackendAddressPools[0] ` + -Protocol TCP ` + -FrontendPort 80 ` + -BackendPort 80 ` + -DisableOutboundSNAT ` + -Probe (Get-AzLoadBalancerProbeConfig -Name "myHealthProbe" -LoadBalancer $lb); + +# Add outbound connectivity rule. +Add-AzLoadBalancerOutboundRuleConfig ` + -Name "outboundrule" ` + -LoadBalancer $lb ` + -AllocatedOutboundPort '10000' ` + -Protocol 'All' ` + -IdleTimeoutInMinutes '15' ` + -FrontendIpConfiguration $lb.FrontendIpConfigurations[0] ` + -BackendAddressPool $lb.BackendAddressPools[0]; + +# Update the load balancer configuration. +Set-AzLoadBalancer -LoadBalancer $lb; + +# Create IP address configurations. +# Instances will require explicit outbound connectivity, for example +# - NAT Gateway on the subnet (recommended) +# - Instances in backend pool of Standard LB with outbound connectivity rules +# - Public IP address on each instance +# See aka.ms/defaultoutboundaccess for more info. +$ipConfig = New-AzVmssIpConfig ` + -Name "myIPConfig" ` + -SubnetId $virtualNetwork.Subnets[0].Id ` + -LoadBalancerBackendAddressPoolsId $lb.BackendAddressPools[0].Id ` + -Primary; + +# Create a config object. +# The Vmss config object stores the core information for creating a scale set. +$vmssConfig = New-AzVmssConfig ` + -Location $loc ` + -SkuCapacity $vmssInstanceCount ` + -SkuName $vmssSku ` + -OrchestrationMode 'Flexible' ` + -PlatformFaultDomainCount 1; + +# Reference a virtual machine image from the gallery. +Set-AzVmssStorageProfile $vmssConfig ` + -OsDiskCreateOption "FromImage" ` + -ImageReferencePublisher "MicrosoftWindowsServer" ` + -ImageReferenceOffer "WindowsServer" ` + -ImageReferenceSku "2022-datacenter-azure-edition-core-smalldisk" ` + -ImageReferenceVersion "latest"; + +# Set up information for authenticating with the virtual machine. +Set-AzVmssOsProfile $vmssConfig ` + -AdminUsername $cred.UserName ` + -AdminPassword $cred.Password ` + -ComputerNamePrefix $vmNamePrefix ` + -WindowsConfigurationProvisionVMAgent $true ` + -WindowsConfigurationPatchMode "AutomaticByPlatform" ` + -EnableHotpatching; + +# Attach the virtual network to the config object. +Add-AzVmssNetworkInterfaceConfiguration ` + -VirtualMachineScaleSet $vmssConfig ` + -Name "network-config" ` + -Primary $true ` + -IPConfiguration $ipConfig ` + -NetworkApiVersion '2020-11-01'; + +# Define the Application Health extension properties. +$publicConfig = @{"protocol" = "http"; "port" = 80; "requestPath" = "/healthEndpoint"}; +$extensionName = "myHealthExtension"; +$extensionType = "ApplicationHealthWindows"; +$publisher = "Microsoft.ManagedServices"; +# Add the Application Health extension to the scale set model. +Add-AzVmssExtension -VirtualMachineScaleSet $vmssConfig ` + -Name $extensionName ` + -Publisher $publisher ` + -Setting $publicConfig ` + -Type $extensionType ` + -TypeHandlerVersion "1.0" ` + -AutoUpgradeMinorVersion $True; + +# Create the virtual machine scale set. +$vmss = New-AzVmss ` + -ResourceGroupName $rgname ` + -Name $vmssName ` + -VirtualMachineScaleSet $vmssConfig; +``` + +Set the operating system profile properties for a Vmss in Flexible mode with Hotpatching enabled + +## PARAMETERS + +### -AdditionalUnattendContent +Specifies an unattended content object. +You can use the Add-AzVMAdditionalUnattendContent to create the object. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.AdditionalUnattendContent[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AdminPassword +Specifies the administrator password to use for all the virtual machine instances in the VMSS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AdminUsername +Specifies the administrator account name to use for all the virtual machine instances in the VMSS. <br> +**Restriction:** <br> +Windows: Cannot contain special characters \/""[]:|<>+=;,?*@& or end in \".\" <br> +Linux: Username must only contain letters, numbers, hyphens, and underscores and may not start with a hyphen or number. <br> +**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\". <br> +**Minimum-length:** 1 character <br> +**Max-length:** 20 characters for Windows, 64 characters for Linux <br> +For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://learn.microsoft.com/azure/devops/organizations/settings/naming-restrictions). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ComputerNamePrefix +Specifies the computer name prefix for all the virtual machine instances in the VMSS. +Computer names must be 1 to 15 characters long. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CustomData +Specifies a base-64 encoded string of custom data. +This is decoded to a binary array that is saved as a file on the virtual machine. +The maximum length of the binary array is 65535 bytes. <br> +For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](/azure/virtual-machines/linux/tutorial-automate-vm-deployment). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableHotpatching +Enables customers to patch their Azure Vmss without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LinuxConfigurationDisablePasswordAuthentication +Indicates that this cmdlet disables password authentication. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LinuxConfigurationPatchMode +Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - The virtual machine's default patching configuration is used. <br /><br /> **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LinuxConfigurationProvisionVMAgent +Indicates whether virtual machine agent should be provisioned on the virtual machine. <br><br> When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Listener +Specifies the Windows Remote Management (WinRM) listeners. +This enables remote Windows PowerShell. +You can use the Add-AzVmssWinRMListener cmdlet to create the listener. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.WinRMListener[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicKey +Specifies the Secure Shell (SSH) public key object. +You can use the Add-AzVMSshPublicKey cmdlet to create the object. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.SshPublicKey[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Secret +Specifies the secrets object which contains the certificate references to place on the virtual machine. +You can use the Add-AzVmssSecret cmdlet to create the secrets object. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.VaultSecretGroup[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TimeZone +Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\". <br> +Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specifies the VMSS object. +You can use the New-AzVmssConfig cmdlet to create the object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WindowsConfigurationEnableAutomaticUpdate +Indicates whether the virtual machines in the VMSS are enabled for automatic updates. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WindowsConfigurationPatchMode +Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false<br /><br /> **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. <br /><br /> **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WindowsConfigurationProvisionVMAgent +Indicates whether virtual machine agent should be provisioned on the virtual machines in the VMSS. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.String + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Management.Compute.Models.AdditionalUnattendContent[] + +### Microsoft.Azure.Management.Compute.Models.WinRMListener[] + +### Microsoft.Azure.Management.Compute.Models.SshPublicKey[] + +### Microsoft.Azure.Management.Compute.Models.VaultSecretGroup[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[Add-AzVMAdditionalUnattendContent](./Add-AzVMAdditionalUnattendContent.md) + +[Add-AzVmssWinRMListener](./Add-AzVmssWinRMListener.md) + +[Add-AzVMSshPublicKey](./Add-AzVMSshPublicKey.md) + +[Add-AzVmssSecret](./Add-AzVmssSecret.md) + +[New-AzVmssConfig](./New-AzVmssConfig.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVmssRollingUpgradePolicy.md b/azps-10.1.0/Az.Compute/Set-AzVmssRollingUpgradePolicy.md new file mode 100644 index 0000000000..1c790149ee --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVmssRollingUpgradePolicy.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmssrollingupgradepolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssRollingUpgradePolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssRollingUpgradePolicy.md +--- + +# Set-AzVmssRollingUpgradePolicy + +## SYNOPSIS +Sets the VMSS rolling upgrade policy properties. + +## SYNTAX + +``` +Set-AzVmssRollingUpgradePolicy [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> + [[-MaxBatchInstancePercent] <Int32>] [[-MaxUnhealthyInstancePercent] <Int32>] + [[-MaxUnhealthyUpgradedInstancePercent] <Int32>] [-PauseTimeBetweenBatches <String>] + [-EnableCrossZoneUpgrade <Boolean>] [-PrioritizeUnhealthyInstance <Boolean>] [-MaxSurge <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets the VMSS rolling upgrade policy properties. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzVmssRollingUpgradePolicy -VirtualMachineScaleSet $vmss -MaxBatchInstancePercent 40 -MaxUnhealthyInstancePercent 35 -MaxUnhealthyUpgradedInstancePercent 30 -PauseTimeBetweenBatches "PT30S" +``` + +This command sets 40 percent for MaxBatchInstance, 35 percent for MaxUnhealthyInstance, 30 percent for MaxUnhealthyUpgradedInstance and 30 second pause time between batches for VMSS local object $vmss. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCrossZoneUpgrade +Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxBatchInstancePercent +The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. +As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. +If the value is not specified, it is set to 20. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxSurge +If enabled, VMSS will create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxUnhealthyInstancePercent +The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. +This constraint will be checked prior to starting any batch. +If the value is not specified, it is set to 20. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxUnhealthyUpgradedInstancePercent +The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. +This check will happen after each batch is upgraded. +If this percentage is ever exceeded, the rolling update aborts. +If the value is not specified, it is set to 20. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PauseTimeBetweenBatches +The wait time between completing the update for all virtual machines in one batch and starting the next batch. +The time duration should be specified in ISO 8601 format. +The default value is 0 seconds (PT0S). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrioritizeUnhealthyInstance +Upgrade all unhealthy instances in a scale set before any healthy instances. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specifies the VMSS object. +You can use the New-AzVmssConfig cmdlet to create the object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.Int32 + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzVmssSecurityProfile.md b/azps-10.1.0/Az.Compute/Set-AzVmssSecurityProfile.md new file mode 100644 index 0000000000..8ee723030d --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVmssSecurityProfile.md @@ -0,0 +1,454 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmsssecurityprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssSecurityProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssSecurityProfile.md +--- + +# Set-AzVmssSecurityProfile + +## SYNOPSIS +This cmdlet allows users to set the SecurityType enum for Virtual Machines scale sets. + +## SYNTAX + +``` +Set-AzVmssSecurityProfile [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-SecurityType] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Sets the Security Type of the VMSS + +## EXAMPLES + +### Example 1 +```powershell +$VMSS = Get-AzVmss -ResourceGroupName "ResourceGroup11" -VMScaleSetName "ContosoVM07" +$VMSS = Set-AzVmssSecurityProfile -VirtualMachineScaleSet $VMSS -SecurityType "TrustedLaunch" +``` + +The first command gets the virtual machine scale set named ContosoVM07 by using **Get-AzVmss**. +The command stores it in the $VMSS variable. +The second command sets the SecurityType enum to "TrustedLaunch". + +### Example 2: Create a Confidential Vmss resource with encryption type VMGuestStateOnly. +```powershell +# Common Variables + $rgname = <Resource Group Name> + $loc = "northeurope" + New-AzResourceGroup -Name $rgname -Location $loc -Force + + $vmssSize = "Standard_DC2as_v5" + $PublisherName = "MicrosoftWindowsServer" + $Offer = "WindowsServer" + $SKU = '2022-datacenter-smalldisk-g2' + $version = "latest" + $securityType = "ConfidentialVM" + $securityEncryptionType = "VMGuestStateOnly" + $secureboot = $true + $vtpm = $true + + # NRP + $subnet = New-AzVirtualNetworkSubnetConfig -Name ('subnet' + $rgname) -AddressPrefix "10.0.0.0/24" + $vnet = New-AzVirtualNetwork -Force -Name ('vnet' + $rgname) -ResourceGroupName $rgname -Location $loc -AddressPrefix "10.0.0.0/16" -Subnet $subnet + $vnet = Get-AzVirtualNetwork -Name ('vnet' + $rgname) -ResourceGroupName $rgname + $subnetId = $vnet.Subnets[0].Id + + # New VMSS Parameters + $vmssName = 'vmss' + $rgname + $adminUsername = <User Name> + $adminPassword = <Password> | ConvertTo-SecureString -AsPlainText -Force + + $imgRef = New-Object -TypeName 'Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImage' + $imgRef.PublisherName = $PublisherName + $imgRef.Offer = $Offer + $imgRef.Skus = $SKU + $imgRef.Version = $version + + $vmssIPName = <IP Name> + $vmssNICName = <NIC Name> + $computerNamePrefix = <Name Prefix> + $ipCfg = New-AzVmssIpConfig -Name $vmssIPName -SubnetId $subnetId + + $vmss = New-AzVmssConfig -Location $loc -SkuCapacity 2 -SkuName $vmssSize -UpgradePolicyMode 'Manual' ` + | Add-AzVmssNetworkInterfaceConfiguration -Name $vmssNICName -Primary $true -IPConfiguration $ipCfg ` + | Set-AzVmssOsProfile -ComputerNamePrefix $computerNamePrefix -AdminUsername $adminUsername -AdminPassword $adminPassword ` + | Set-AzVmssStorageProfile -OsDiskCreateOption 'FromImage' -OsDiskCaching 'ReadOnly' -SecurityEncryptionType $securityEncryptionType ` + -ImageReferenceOffer $imgRef.Offer -ImageReferenceSku $imgRef.Skus -ImageReferenceVersion $imgRef.Version ` + -ImageReferencePublisher $imgRef.PublisherName + + # Confidential Vmss required parameters + $vmss = Set-AzVmssSecurityProfile -VirtualMachineScaleSet $vmss -SecurityType $securityType + $vmss = Set-AzVmssUefi -VirtualMachineScaleSet $VMSS -EnableVtpm $vtpm -EnableSecureBoot $secureboot + + # Create Vmss + $result = New-AzVmss -ResourceGroupName $rgname -Name $vmssName -VirtualMachineScaleSet $vmss + + # Validate + $vmssGet = Get-AzVmss -ResourceGroupName $rgname -Name $vmssName + # SecurityType value can be seen at $vmssGet.VirtualMachineProfile.SecurityProfile.SecurityType +``` + +### Example 3: Create a Confidential Vmss resource with encryption type DiskWithVMGuestState and Image reference Disk Encryption set to EncryptedWithPmk. +```powershell +# Common variables + $rgname = <Resource Group Name> + $loc = "northeurope" + New-AzResourceGroup -ResourceGroupName $rgName -Location $loc -Force + $secureBoot = $true + $vtpm = $true + $vmssName = "vmss" + $rgname + + # VM variables + $vmName = <VM Name> + $vmSize = "Standard_DC2as_v5" + $vmssSize = "Standard_DC2as_v5" + + $password = <Password> + $securePassword = $password | ConvertTo-SecureString -AsPlainText -Force + $username = <User Name> + $vmCred = New-Object System.Management.Automation.PSCredential ($username, $securePassword) + + + $imagePublisher = "MicrosoftWindowsServer" + $imageOffer = "windowsserver" + $imageSku = "2022-datacenter-smalldisk-g2" + $imageVersion = "latest" + $osDiskSecurityType = "DiskwithVMGuestState" + $vmSecurityType = "ConfidentialVM" + + # Network variables + $NetworkName = [system.string]::concat($vmName, '-vnet') + $NICName = [system.string]::concat($vmName, '-nic') + $SubnetName = [system.string]::concat($vmName, '-subnet') + $SubnetAddressPrefix = "10.0.0.0/24" + $VnetAddressPrefix = "10.0.0.0/16" + + # Setup Network + $SingleSubnet = New-AzVirtualNetworkSubnetConfig -Name $SubnetName -AddressPrefix $SubnetAddressPrefix + $Vnet = New-AzVirtualNetwork -Name $NetworkName -ResourceGroupName $rgName ` + -Location $loc -AddressPrefix $VnetAddressPrefix -Subnet $SingleSubnet + $NIC = New-AzNetworkInterface -Name $NICName -ResourceGroupName $rgName ` + -Location $loc -SubnetId $Vnet.Subnets[0].Id + + # Setup CVM + $virtualMachine = New-AzVMConfig -VMName $vmName -VMSize $vmSize + $VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName $vmName ` + -Credential $vmCred -ProvisionVMAgent -EnableAutoUpdate + $VirtualMachine = Add-AzVMNetworkInterface -VM $VirtualMachine -Id $NIC.Id + $VirtualMachine = Set-AzVMSourceImage -VM $VirtualMachine -PublisherName $imagePublisher ` + -Offer $imageOffer -Skus $imageSku -Version $imageVersion + $VirtualMachine = Set-AzVMOSDisk -VM $VirtualMachine -StorageAccountType "StandardSSD_LRS" ` + -CreateOption "FromImage" -SecurityEncryptionType $osDiskSecurityType + $VirtualMachine = Set-AzVMSecurityProfile -VM $VirtualMachine -SecurityType $vmSecurityType + $VirtualMachine = Set-AzVMUefi -VM $VirtualMachine -EnableVtpm $true -EnableSecureBoot $true + + New-AzVM -ResourceGroupName $rgName -Location $loc -VM $VirtualMachine + + $cvm = Get-AzVM -VMName $vmName -ResourceGroupName $rgName + + # Image Gallery variables + $galleryName = "rg" + $rgname + $definitionName = "def"+$rgname + $publisherName = "cvm01" + $versionName = "1.0.0" + # Platform Managed Key encryption + $cvmEncryptionType = "EncryptedWithPmk" + $replicaCount = 1 + $storageAccountType = "Standard_LRS" + $osState = "Specialized" + $osType = "Windows" + $sourceImageId = $cvm.Id + + # Setup Image Gallery + New-AzGallery -ResourceGroupName $rgName -Name $galleryName -location $loc + + $imagePublisher = "MicrosoftWindowsServer" + $imageOffer = "windowsserver" + $imageSku = "2022-datacenter-smalldisk-g2" + $vmSecurityType = "ConfidentialVM" + + # Setup Image Definition + $SecurityTypeTable = @{Name='SecurityType';Value='ConfidentialVM'} + $features = @($SecurityTypeTable) + New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $definitionName ` + -Feature $features -Publisher $imagePublisher -Offer $imageOffer -Sku $imageSku -location $loc ` + -OsState $osState -OsType $osType -HyperVGeneration 'V2' + + $galDefinition = Get-AzGalleryImageDefinition -ResourceGroupName $rgname -GalleryName $galleryName -Name $definitionName + + # Setup Image Version + $cvmOsDiskEncryption = @{CVMEncryptionType=$cvmEncryptionType} + $cvmEncryption = @{OSDiskImage = $cvmOsDiskEncryption} + $region = @{Name = $loc; ReplicaCount = $replicaCount; StorageAccountType = $storageAccountType; Encryption = $cvmEncryption} + $targetRegions = @($region) + + # Pause the script to ensure the referenced VM is in the Succeeded state. The amount of time can vary and this just a precaution. + Start-Sleep -Seconds 360 + + New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $definitionName ` + -Name $versionName -Location $loc -SourceImageId $sourceImageId -ReplicaCount $replicaCount ` + -StorageAccountType $storageAccountType -TargetRegion $targetRegions + + $galVersion = Get-AzGalleryImageVersion -ResourceGroupName $rgname -GalleryName $galleryName -GalleryImageDefinitionName $definitionName + + # NRP for vmss setup. This is not required if you want to reuse the previous NRP setup. + $subnet = New-AzVirtualNetworkSubnetConfig -Name ('subnet' + $rgname) -AddressPrefix $SubnetAddressPrefix + $vnet = New-AzVirtualNetwork -Force -Name ('vnet' + $rgname) -ResourceGroupName $rgname -Location $loc -AddressPrefix $VnetAddressPrefix -Subnet $subnet + $subnetId = $vnet.Subnets[0].Id + $vmssIPName = <IP Name> + $vmssNICName = <NIC Name> + + $ipCfg = New-AzVmssIpConfig -Name $vmssIPName -SubnetId $subnetId + + # Vmss setup + $securityEncryptionType = "DiskWithVMGuestState" + $vmss = New-AzVmssConfig -Location $loc -SkuCapacity 2 -SkuName $vmssSize -UpgradePolicyMode 'Manual' -ImageReferenceId $galDefinition.Id` + | Add-AzVmssNetworkInterfaceConfiguration -Name $vmssNICName -Primary $true -IPConfiguration $ipCfg ` + | Set-AzVmssStorageProfile -OsDiskCreateOption 'FromImage' -OsDiskCaching 'ReadOnly' -SecurityEncryptionType $securityEncryptionType + + # Confidential Vmss required parameters + $vmss = Set-AzVmssSecurityProfile -VirtualMachineScaleSet $vmss -SecurityType $vmSecurityType + $vmss = Set-AzVmssUefi -VirtualMachineScaleSet $VMSS -EnableVtpm $vtpm -EnableSecureBoot $secureboot + + # Create Vmss + $result = New-AzVmss -ResourceGroupName $rgname -Name $vmssName -VirtualMachineScaleSet $vmss + + # Validate + $vmssGet = Get-AzVmss -ResourceGroupName $rgname -Name $vmssName + # Verify the Vmss SecurityType at $vmssGet.VirtualMAchineProfile.SecurityProfile.SecurityType + + $vmssvms = Get-AzVmssVM -ResourceGroupName $rgname -VMScaleSetName $vmssName + $vmssvm = Get-AzVmssVM -ResourceGroupName $rgname -VMScaleSetName $vmssName -InstanceId $vmssvms[0].InstanceId + # Verify the SecurityEncryptionType at $vmssvm.StorageProfile.OsDIsk.ManagedDisk.SecurityProfile.SecurityEncryptionType +``` + +### Example 4: Create a Confidential Vmss resource with encryption type DiskWithVMGuestState and Image reference Disk Encryption set to EncryptedWithCmk. +```powershell +# Common Variables + $rgname = <Resource Group Name>; + $loc = "northeurope"; + + New-AzResourceGroup -ResourceGroupName $rgName -Location $loc -Force; + + $secureBoot = $true; + $vtpm = $true; + $vmssName = "vmss" + $rgname; + + # VM variables + $vmName = "v" + $rgname; + $vmSize = "Standard_DC2as_v5"; + $vmssSize = "Standard_DC2as_v5"; + $password = <Password>; + $securePassword = $password | ConvertTo-SecureString -AsPlainText -Force; + $username = <Username>; + $vmCred = New-Object System.Management.Automation.PSCredential ($username, $securePassword); + $imagePublisher = "MicrosoftWindowsServer"; + $imageOffer = "windowsserver"; + $imageSku = "2022-datacenter-smalldisk-g2"; + $imageVersion = "latest"; + $osDiskSecurityType = "DiskwithVMGuestState"; + $vmSecurityType = "ConfidentialVM"; + $deployCMK = $true; + $storageType = "StandardSSD_LRS"; + + # Network variables + $NetworkName = $vmname + "-vnet"; + $NICName = $vmName + "-nic"; + $SubnetName = $vmName + "-subnet"; + $SubnetAddressPrefix = "10.0.0.0/24"; + $VnetAddressPrefix = "10.0.0.0/16"; + + # Key Vault setup + $keyVaultName = "kv" + $rgname; + $keyName = "k" + $rgname; + $desName = "des" + $rgname; + $cvmAgent = Get-AzADServicePrincipal -ApplicationId "bf7b6499-ff71-4aa2-97a4-f372087be7f0"; + $kv = New-AzKeyVault -Name $keyVaultName -ResourceGroupName $rgName -Location $loc -Sku "Premium" -EnablePurgeProtection -SoftDeleteRetentionInDays 7; + Set-AzKeyVaultAccessPolicy -ObjectId $cvmAgent.Id -VaultName $keyVaultName -ResourceGroupName $rgName -PermissionsToKeys "get","release"; + Start-BitsTransfer -Source https://cvmprivatepreviewsa.blob.core.windows.net/cvmpublicpreviewcontainer/skr-policy.json -Destination ".\skr-policy.json"; + $desKey = Add-AzKeyVaultKey -Name $keyName -VaultName $keyVaultName -KeyOps "wrapKey","unwrapKey" -KeyType "RSA-HSM" -Size 3072 ` + -Exportable -ReleasePolicyPath ".\skr-policy.json" -Destination "HSM"; + + $desConfig = New-AzDiskEncryptionSetConfig -Location $loc -KeyUrl $desKey.Id -SourceVaultId $kv.ResourceId -IdentityType "SystemAssigned" ` + -EncryptionType "ConfidentialVmEncryptedWithCustomerKey"; + $des = New-AzDiskEncryptionSet -DiskEncryptionSet $desConfig -DiskEncryptionSetName $desName -ResourceGroupName $rgName; + $desIdentity = Get-AzADServicePrincipal -ObjectId $des.Identity.PrincipalId -ErrorAction 'SilentlyContinue'; + Set-AzKeyVaultAccessPolicy -ObjectId $des.Identity.PrincipalId -ResourceGroupName $rgName -VaultName $keyVaultName -PermissionsToKeys "wrapKey","unwrapKey","get"; + + $des = Get-AzDiskEncryptionSet -ResourceGroupName $rgname -Name $desName; + + # Setup Network + $SingleSubnet = New-AzVirtualNetworkSubnetConfig -Name $SubnetName -AddressPrefix $SubnetAddressPrefix; + $Vnet = New-AzVirtualNetwork -Name $NetworkName -ResourceGroupName $rgName ` + -Location $loc -AddressPrefix $VnetAddressPrefix -Subnet $SingleSubnet + $NIC = New-AzNetworkInterface -Name $NICName -ResourceGroupName $rgName ` + -Location $loc -SubnetId $Vnet.Subnets[0].Id; + + # Setup Confidential VM + $virtualMachine = New-AzVMConfig -VMName $vmName -VMSize $vmSize; + $VirtualMachine = Set-AzVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName $vmName ` + -Credential $vmCred -ProvisionVMAgent -EnableAutoUpdate; + $VirtualMachine = Add-AzVMNetworkInterface -VM $VirtualMachine -Id $NIC.Id; + $VirtualMachine = Set-AzVMSourceImage -VM $VirtualMachine -PublisherName $imagePublisher ` + -Offer $imageOffer -Skus $imageSku -Version $imageVersion; + + $paramSetAzVmOsDisk = @{ + VM = $virtualMachine + StorageAccountType = $storageType + CreateOption = "FromImage" + SecurityEncryptionType = $osDiskSecurityType + ErrorAction = 'Stop' + SecureVMDiskEncryptionSet = $des.Id + }; + $VirtualMachine = Set-AzVMOSDisk @paramSetAzVmOsDisk; + + $VirtualMachine = Set-AzVMSecurityProfile -VM $VirtualMachine -SecurityType $vmSecurityType; + $VirtualMachine = Set-AzVMUefi -VM $VirtualMachine -EnableVtpm $true -EnableSecureBoot $true; + + # Create CVM to be used as Image reference + New-AzVM -ResourceGroupName $rgName -Location $loc -VM $VirtualMachine; + $cvm = Get-AzVM -VMName $vmName -ResourceGroupName $rgName; + + # Image Gallery variables + $galleryName = "gal" + $rgname; + $definitionName = "def"+$rgname; + $publisherName = <Publisher Name>; + $versionName = "1.0.0"; + # Customer Managed Key encryption + $cvmEncryptionType = "EncryptedWithCmk" + $replicaCount = 1; + $storageAccountType = "Standard_LRS"; + $osState = "Specialized"; + $osType = "Windows"; + $sourceImageId = $cvm.Id; + + # Setup Image Gallery + New-AzGallery -ResourceGroupName $rgName -Name $galleryName -location $loc; + + # Setup Image Definition + $SecurityTypeTable = @{Name='SecurityType';Value='ConfidentialVM'}; + $features = @($SecurityTypeTable); + New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $definitionName ` + -Feature $features -Publisher $imagePublisher -Offer $imageOffer -Sku $imageSku -location $loc ` + -OsState $osState -OsType $osType -HyperVGeneration 'V2'; + + $galDefinition = Get-AzGalleryImageDefinition -ResourceGroupName $rgname -GalleryName $galleryName -Name $definitionName; + + # Setup Image Version + $cvmOsDiskEncryption = @{CVMEncryptionType=$cvmEncryptionType; }; + $cvmOsDiskEncryption.Add('CVMDiskEncryptionSetID', $des.Id); + $cvmEncryption = @{OSDiskImage = $cvmOsDiskEncryption}; + $region = @{Name = $loc; ReplicaCount = $replicaCount; StorageAccountType = $storageAccountType; Encryption = $cvmEncryption}; + $targetRegions = @($region); + + # Pause the script to ensure the referenced VM is in the Succeeded state. The amount of time can vary and this just a precaution. + Start-Sleep -Seconds 360; + + New-AzGalleryImageVersion -ResourceGroupName $rgName -GalleryName $galleryName -GalleryImageDefinitionName $definitionName ` + -Name $versionName -Location $loc -SourceImageId $sourceImageId -ReplicaCount $replicaCount ` + -StorageAccountType $storageAccountType -TargetRegion $targetRegions; + + $galVersion = Get-AzGalleryImageVersion -ResourceGroupName $rgname -GalleryName $galleryName -GalleryImageDefinitionName $definitionName; + + $securityEncryptionType = "DiskWithVMGuestState"; + + # NRP Vmss setup + $subnet = New-AzVirtualNetworkSubnetConfig -Name ('subnet2' + $rgname) -AddressPrefix $SubnetAddressPrefix; + $vnet = New-AzVirtualNetwork -Force -Name ('vnet2' + $rgname) -ResourceGroupName $rgname -Location $loc -AddressPrefix $VnetAddressPrefix -Subnet $subnet; + $vnet = Get-AzVirtualNetwork -Name ('vnet2' + $rgname) -ResourceGroupName $rgname; + $subnetId = $vnet.Subnets[0].Id; + + $vmssIPName = <IP Name> + $vmssNICName = <NIC Name> + $ipCfg = New-AzVmssIpConfig -Name $vmssIPName -SubnetId $subnetId; + + # Vmss setup + $vmss = New-AzVmssConfig -Location $loc -SkuCapacity 2 -SkuName $vmssSize -UpgradePolicyMode 'Manual' -ImageReferenceId $galDefinition.Id` + | Add-AzVmssNetworkInterfaceConfiguration -Name $vmssNICName -Primary $true -IPConfiguration $ipCfg ` + | Set-AzVmssStorageProfile -OsDiskCreateOption 'FromImage' -OsDiskCaching 'ReadOnly' -SecurityEncryptionType $securityEncryptionType -SecureVMDiskEncryptionSet $des.Id; + + # Confidential Vmss required parameters + $vmss = Set-AzVmssSecurityProfile -VirtualMachineScaleSet $vmss -SecurityType $vmSecurityType; + $vmss = Set-AzVmssUefi -VirtualMachineScaleSet $VMSS -EnableVtpm $vtpm -EnableSecureBoot $secureboot; + + # Create Vmss + $result = New-AzVmss -ResourceGroupName $rgname -Name $vmssName -VirtualMachineScaleSet $vmss; + + # Validate + $vmssGet = Get-AzVmss -ResourceGroupName $rgname -Name $vmssName; + # Verify Vmss SecurityType at $vmssGet.VirtualMachineProfile.SecurityProfile.SecurityType; + + $vmssvms = Get-AzVmssVM -ResourceGroupName $rgname -VMScaleSetName $vmssName; + $vmssvm = Get-AzVmssVM -ResourceGroupName $rgname -VMScaleSetName $vmssName -InstanceId $vmssvms[0].InstanceId; + # Verify the SEcurityEncryptionType at $vmssvm.StorageProfile.OsDIsk.ManagedDisk.SecurityProfile.SecurityEncryptionType; + + # Verify the Gallery Version encyrption at $galVersion.PublishingProfile.TargetRegions.Encryption.OSDiskImage.SecurityProfile.ConfidentialVMEncryptionType $cvmEncryptionType; +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityType +Parameter to set the SecurityType on the VMs of the scale set. Possible values are TrustedLaunch, ConfidentialVM + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +The virtual machine scale set profile. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### Microsoft.Azure.Management.Compute.Models.SecurityTypes + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzVmssStorageProfile.md b/azps-10.1.0/Az.Compute/Set-AzVmssStorageProfile.md new file mode 100644 index 0000000000..ae5a0ebbaa --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVmssStorageProfile.md @@ -0,0 +1,508 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 230DAE05-C197-451F-A24C-F4A2DAE4AD04 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmssstorageprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssStorageProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssStorageProfile.md +--- + +# Set-AzVmssStorageProfile + +## SYNOPSIS +Sets the storage profile properties for the VMSS. + +## SYNTAX + +``` +Set-AzVmssStorageProfile [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> + [[-ImageReferencePublisher] <String>] [[-ImageReferenceOffer] <String>] [[-ImageReferenceSku] <String>] + [[-ImageReferenceVersion] <String>] [[-OsDiskName] <String>] [[-OsDiskCaching] <CachingTypes>] + [[-OsDiskCreateOption] <String>] [-OsDiskDeleteOption <String>] [[-OsDiskOsType] <OperatingSystemTypes>] + [[-Image] <String>] [[-VhdContainer] <String[]>] [-ImageReferenceId <String>] [-OsDiskWriteAccelerator] + [-DiffDiskSetting <String>] [-DiffDiskPlacement <String>] [-ManagedDisk <String>] + [-DiskEncryptionSetId <String>] [-DataDisk <VirtualMachineScaleSetDataDisk[]>] [-OSDiskSizeGB <Int32>] + [-DiskControllerType <String>] [-SecurityEncryptionType <String>] [-SecureVMDiskEncryptionSet <String>] + [-SharedGalleryImageId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVmssStorageProfile** cmdlet sets the storage profile properties for the Virtual Machine Scale Set (VMSS). + +## EXAMPLES + +### Example 1: Set the storage profile properties for the VMSS +```powershell +Set-AzVmssStorageProfile -VirtualMachineScaleSet "ContosoVMSS" -Name "Test" -OsDiskCreateOption "FromImage" -OsDiskCaching "None" ` + -ImageReferenceOffer $ImgRef.Offer -ImageReferenceSku $ImgRef.Skus -ImageReferenceVersion $ImgRef.Version ` + -ImageReferencePublisher $ImgRef.PublisherName -VhdContainer $VhdContainer +``` + +This command sets the storage profile properties for the VMSS named ContosoVMSS. + +## PARAMETERS + +### -DataDisk +Specifies the data disk object. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetDataDisk[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiffDiskPlacement +Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e. cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. This parameter can only be used if the parameter DiffDiskSetting is set to 'Local'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiffDiskSetting +Specifies the differencing disk settings for operating system disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskControllerType +Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://learn.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://learn.microsoft.com/rest/api/compute/resourceskus/list) . <br> For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of customer managed disk encryption set. This can only be specified for managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Image +Specifies the blob URI for the user image. +VMSS creates an operating system disk in the same container of the user image. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ImageReferenceId +Specifies the image reference ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ImageReferenceOffer +Specifies the type of virtual machine image (VMImage) offer. +To obtain an image offer, use the Get-AzVMImageOffer cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ImageReferencePublisher +Specifies the name of a publisher of a VMImage. +To obtain a publisher, use the Get-AzVMImagePublisher cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ImageReferenceSku +Specifies the VMImage SKU. +To obtain SKUs, use the Get-AzVMImageSku cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ImageReferenceVersion +Specifies the version of the VMImage. +To use the latest version, specify a value of latest instead of a particular version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagedDisk +Specifies the managed disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsDiskCaching +Specifies the caching mode of the operating system disk. +The acceptable values for this parameter are: +- ReadOnly +- ReadWrite +The default value is ReadWrite. +If you change the caching value, the cmdlet will restart the virtual machine. +This setting affects the consistency and performance of the disk. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.CachingTypes] +Parameter Sets: (All) +Aliases: +Accepted values: None, ReadOnly, ReadWrite + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsDiskCreateOption +Specifies how this cmdlet creates the VMSS virtual machines. +The acceptable values for this parameter are: +- Attach : This value is used when you are using a specialized disk to create the VMSS virtual machine. +- FromImage : This value is used when you are using an image to create the VMSS virtual machine. +If you are using a platform image, you will also use the *imageReference* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsDiskDeleteOption +Specifies whether OS disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). + +Accepted Values +Delete - If this value is used, the OS disk is deleted when the VMSS Flex VM is deleted. +Detach - If this value is used, the OS disk is retained after VMSS Flex VM is deleted. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsDiskName +Specifies the name of the operating system disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsDiskOsType +Specifies the type of operating system on the disk. +This is only needed for user image scenarios and not for a platform image. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes] +Parameter Sets: (All) +Aliases: +Accepted values: Windows, Linux + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OSDiskSizeGB +Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsDiskWriteAccelerator +Specifies whether WriteAccelerator should be enabled or disabled on the OS disk. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecureVMDiskEncryptionSet +ResourceId of the disk encryption set to use for enabling encryption at rest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecurityEncryptionType +Sets the SecurityEncryptionType of the virtual machine scale set. Possible values include: DiskWithVMGuestState, VMGuestStateOnly + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SharedGalleryImageId +Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VhdContainer +Specifies the container URLs that are used to store operating system disks for the VMSS. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specifies the VMSS object. +To obtain the object, use the New-AzVmssConfig object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.String[] + +### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetDataDisk[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[Get-AzVMImageOffer](./Get-AzVMImageOffer.md) + +[Get-AzVMImagePublisher](./Get-AzVMImagePublisher.md) + +[Get-AzVMImageSku](./Get-AzVMImageSku.md) + +[New-AzVmssConfig](./New-AzVmssConfig.md) + + diff --git a/azps-10.1.0/Az.Compute/Set-AzVmssUefi.md b/azps-10.1.0/Az.Compute/Set-AzVmssUefi.md new file mode 100644 index 0000000000..e9fa321a6d --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVmssUefi.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmssuefi +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssUefi.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssUefi.md +--- + +# Set-AzVmssUefi + +## SYNOPSIS +Modifies UEFI properties of gen 2 virtual machines that are part of virtual machine scale sets + +## SYNTAX + +``` +Set-AzVmssUefi [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-EnableVtpm] <Boolean>] + [[-EnableSecureBoot] <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVmssUefi** cmdlet modifies UEFI properties of virtual machines in a virtual machine scale set. + +## EXAMPLES + +### Example 1 +```powershell +$VMSS = Get-AzVmss -ResourceGroupName "ResourceGroup11" -VMScaleSetName "ContosoVM07" +Set-AzVmssUefi -VirtualMachineScaleSet $VMSS -EnableVtpm $true -EnableSecureBoot $true +``` + +The first command gets the virtual machine scale set named ContosoVM07 by using **Get-AzVmss**. +The command stores it in the $VMSS variable. +The second command modifies the UEFI settings to enable SecureBoot and vTPM on virtual machines in $VMSS. +The command passes the result to the Update-AzVmss cmdlet, which implements your changes. +A change to the cashing mode causes the virtual machine to restart. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSecureBoot +Parameter to toggle secure boot on the VMs of the scale set + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableVtpm +Parameter to toggle vTPM on the VMs of the scale set + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +The virtual machine scale set profile. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Set-AzVmssVM.md b/azps-10.1.0/Az.Compute/Set-AzVmssVM.md new file mode 100644 index 0000000000..ca81f01d6a --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVmssVM.md @@ -0,0 +1,275 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 70AA9747-232E-40F2-845C-35A779F51CD2 +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmssvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssVM.md +--- + +# Set-AzVmssVM + +## SYNOPSIS +Modifies the state of a VMSS instance. + +## SYNTAX + +### DefaultParameter (Default) +``` +Set-AzVmssVM [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> [-Reimage] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FriendMethod +``` +Set-AzVmssVM [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> [-ReimageAll] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RedeployMethodParameter +``` +Set-AzVmssVM [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> [-Redeploy] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PerformMaintenanceMethodParameter +``` +Set-AzVmssVM [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> + [-PerformMaintenance] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SimulateEvictionMethodParameter +``` +Set-AzVmssVM [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> + [-SimulateEviction] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVmssVM** cmdlet modifies the state of a Virtual Machine Scale Set (VMSS) instance. + +## EXAMPLES + +### Example 1 + +Modifies the state of a VMSS instance. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzVmssVM -InstanceId <String> -Reimage -ResourceGroupName myresourcegroup -VMScaleSetName 'VMSS001' +``` + +### Example 2 + +Modifies the state of a VMSS instance. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzVmssVM -InstanceId <String> -PerformMaintenance -ResourceGroupName myresourcegroup -VMScaleSetName 'VMSS001' +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceId +Specifies the ID of the VMSS instance for which this cmdlet modifies state. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PerformMaintenance +Indicates that this cmdlet performs maintenance on a virtual machine in the VMSS. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PerformMaintenanceMethodParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Redeploy +Indicates that this cmdlet redeploys a virtual machine in the VMSS. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RedeployMethodParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reimage +Indicates that this cmdlet reimages the VMSS instance. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReimageAll +Indicates that the cmdlet reimages all the disks in the VMSS instance. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FriendMethod +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the VMSS instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SimulateEviction +Indicates that this cmdlet simulates the eviction of spot virtual machine in a VM scale set. +The eviction will occur within 30 minutes of calling the API. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SimulateEvictionMethodParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMScaleSetName +Specifies the name of the VMSS instance that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVmssVM](./Get-AzVmssVM.md) diff --git a/azps-10.1.0/Az.Compute/Set-AzVmssVMRunCommand.md b/azps-10.1.0/Az.Compute/Set-AzVmssVMRunCommand.md new file mode 100644 index 0000000000..8d2ed9aab9 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Set-AzVmssVMRunCommand.md @@ -0,0 +1,525 @@ +--- +external help file: Az.Compute-help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/set-azvmssvmruncommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssVMRunCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Set-AzVmssVMRunCommand.md +--- + +# Set-AzVmssVMRunCommand + +## SYNOPSIS +The operation to create or update the VMSS VM run command. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzVmssVMRunCommand -InstanceId <String> -ResourceGroupName <String> -RunCommandName <String> + -VMScaleSetName <String> [-SubscriptionId <String>] -Location <String> [-AsyncExecution] + [-ErrorBlobUri <String>] [-OutputBlobUri <String>] [-Parameter <IRunCommandInputParameter[]>] + [-ProtectedParameter <IRunCommandInputParameter[]>] [-RunAsPassword <String>] [-RunAsUser <String>] + [-SourceCommandId <String>] [-SourceScript <String>] [-SourceScriptUri <String>] [-Tag <Hashtable>] + [-TimeoutInSecond <Int32>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ScriptLocalPath +``` +Set-AzVmssVMRunCommand -InstanceId <String> -ResourceGroupName <String> -RunCommandName <String> + -VMScaleSetName <String> [-SubscriptionId <String>] -Location <String> [-AsyncExecution] + [-ErrorBlobUri <String>] [-OutputBlobUri <String>] [-Parameter <IRunCommandInputParameter[]>] + [-ProtectedParameter <IRunCommandInputParameter[]>] [-RunAsPassword <String>] [-RunAsUser <String>] + [-Tag <Hashtable>] [-TimeoutInSecond <Int32>] -ScriptLocalPath <String> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to create or update the VMSS VM run command. + +## EXAMPLES + +### Example 1: Create or update Run Command on a VMSS VM instance using a storage blob SAS URL +```powershell +Set-AzVmssVMRunCommand -ResourceGroupName MyRG0 -VMScaleSetName MyVMSS -InstanceId 0 -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri "https://myst.blob.core.windows.net/mycontainer/myscript.ps1?sp=r&st=2022-10-27T21:02:35Z&se=2022-10-28T05:02:35Z&spr=https&sv=2021-06-08&sr=b&sig=0I%2FIiYayRwHasfasasfdasdfasdeTsQjLnpZjA%3D" +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap MyRunCommand Microsoft.Compute/virtualMachines/runCommands +``` + +Create or update Run Command on a Windows VMSS VM instance using a SAS URL of a storage blob that contains .ps1 script. +Note SAS URL must provide read access to the blob. +An expiry time of 24 hours is suggested for SAS URL. +SAS URLs can be generated on Azure portal using blob's options , or SAS token using New-AzStorageBlobSASToken. +If generating SAS token using New-AzStorageBlobSASToken, your SAS URL = base blob URL + "?" + SAS token from New-AzStorageBlobSASToken. + +### Example 2: Create or update Run Command on a VMSS VM instance using a local script file. +```powershell +Set-AzVmssVMRunCommand -ResourceGroupName MyRG0 -VMScaleSetName MyVMSS -InstanceId 0 -RunCommandName MyRunCommand -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap MyRunCommand Microsoft.Compute/virtualMachines/runCommands +``` + +Create or update Run Command on a VMSS VM instance using a local script file that is on the client machine where cmdlet is executed. + +### Example 3: Create or update Run Command on a VMSS VM instance using script text. +```powershell +Set-AzVmssVMRunCommand -ResourceGroupName MyRG0 -VMScaleSetName MyVMSSL -InstanceId 1 -RunCommandName MyRunCommand2 -Location EastUS2EUAP -SourceScript "id; echo HelloWorld" +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap MyRunCommand2 Microsoft.Compute/virtualMachines/runCommands +``` + +Create or update Run Command on a VMSS VM instance passing the script content directly to -SourceScript parameter. +Use ';' to delimit multiple commands. + +### Example 4: Create or update Run Command on a VMSS VM instance using commandId. +```powershell +Set-AzVmssVMRunCommand -ResourceGroupName MyRG0 -VMScaleSetName MyVMSS -InstanceId 0 -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceCommandId DisableWindowsUpdate +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap MyRunCommand Microsoft.Compute/virtualMachines/runCommands +``` + +Create or update Run Command on a VMSS VM instance using pre-existing commandId. +Available commandIds can be retrieved using Get-AzVMRunCommandDocument. + +### Example 5: Create or update Run Command on a VMSS VM instance and stream standard output and standard error messages to output and error Append blobs. +```powershell +Set-AzVmssVMRunCommand -ResourceGroupName MyRG0 -VMScaleSetName MyVMSS -InstanceId 1 -RunCommandName MyRunCommand3 -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -OutputBlobUri "https://vivst.blob.core.windows.net/vivcontainer/output.txt?sp=racw&st=2022-10-27T22:18:36Z&se=2022-10-28T06:18:36Z&spr=https&sv=2021-06-08&sr=b&sig=HQAu3Bl%2BKMofYTjMo8o5hasfadsfasdF4jIkRJra4S5FlEo%3D" -ErrorBlobUri "https://vivst.blob.core.windows.net/vivcontainer/error.txt?sp=racw&st=2022-10-27T22:18:36Z&se=2022-10-28T06:18:36Z&spr=https&sv=2021-06-08&sr=b&sig=HQAu3Bl%2BKMofYTjMo8o5h%asfasdfgdT%2F4jasfasdf5FlEo%3D" +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap MyRunCommand3 Microsoft.Compute/virtualMachines/runCommands +``` + +Create or update Run Command on a VMSS VM instance and stream standard output and standard error messages to output and error Append blobs. +Note output and error blobs must be of type AppendBlob and their SAS URLs must provide read, append, create, write access to the blob. +An expiry time of 24 hours is suggested for SAS URL. +If output or error blob does not exist, a blob of type AppendBlob will be created. +SAS URLs can be generated on Azure portal using blob's options , or SAS token using New-AzStorageBlobSASToken. +If generating SAS token using New-AzStorageBlobSASToken, your SAS URL = base blob URL + "?" + SAS token from New-AzStorageBlobSASToken. + +### Example 6: Create or update Run Command on a VMSS VM instance, run the Run Command as a different user using RunAsUser and RunAsPassword parameters. +```powershell +Set-AzVmssVMRunCommand -ResourceGroupName MyRG0 -VMScaleSetName MyVMSS -InstanceId 1 -RunCommandName MyRunCommand -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -RunAsUser myusername -RunAsPassword mypassword +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap MyRunCommand Microsoft.Compute/virtualMachines/runCommands +``` + +Create or update Run Command on a VMSS VM instance, run the Run Command as a different user using RunAsUser and RunAsPassword parameters. +For RunAs to work properly, contact admin of VM and make sure user is added on the VM, user has access to resources accessed by the Run Command (Directories, Files, Network etc.), and in case of Windows VM, 'Secondary Logon' service is running on the VM. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsyncExecution +Optional. +If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ErrorBlobUri +Specifies the Azure storage blob where script error stream will be uploaded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceId +The instance ID of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputBlobUri +Specifies the Azure storage blob where script output stream will be uploaded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +The parameters used by the script. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectedParameter +The parameters used by the script. +To construct, see NOTES section for PROTECTEDPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunAsPassword +Specifies the user account password on the VM when executing the run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunAsUser +Specifies the user account on the VM when executing the run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunCommandName +The name of the virtual machine run command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptLocalPath + +```yaml +Type: System.String +Parameter Sets: ScriptLocalPath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceCommandId +Specifies a commandId of predefined built-in script. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceScript +Specifies the script content to be executed on the VM. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceScriptUri +Specifies the script download location. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutInSecond +The timeout in seconds to execute the run command. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMScaleSetName +The name of the VM scale set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IVirtualMachineRunCommand + +## 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. + + +`PARAMETER <IRunCommandInputParameter[]>`: The parameters used by the script. + - `Name <String>`: The run command parameter name. + - `Value <String>`: The run command parameter value. + +`PROTECTEDPARAMETER <IRunCommandInputParameter[]>`: The parameters used by the script. + - `Name <String>`: The run command parameter name. + - `Value <String>`: The run command parameter value. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Start-AzVM.md b/azps-10.1.0/Az.Compute/Start-AzVM.md new file mode 100644 index 0000000000..c43770caab --- /dev/null +++ b/azps-10.1.0/Az.Compute/Start-AzVM.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 7B3259CD-079D-4E07-8608-F818522EE7CF +online version: https://learn.microsoft.com/powershell/module/az.compute/start-azvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Start-AzVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Start-AzVM.md +--- + +# Start-AzVM + +## SYNOPSIS +Starts an Azure virtual machine. + +## SYNTAX + +### ResourceGroupNameParameterSetName (Default) +``` +Start-AzVM [-Name] <String> [-NoWait] [-ResourceGroupName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdParameterSetName +``` +Start-AzVM [-NoWait] [-Id] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzVM** cmdlet starts an Azure virtual machine. + +## EXAMPLES + +### Example 1: Start a virtual machine +```powershell +Start-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" +``` + +This command starts the virtual machine named VirtualMachine07 in ResourceGroup11. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ID of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: IdParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The virtual machine name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSetName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[New-AzVM](./New-AzVM.md) + +[Remove-AzVM](./Remove-AzVM.md) + +[Restart-AzVM](./Restart-AzVM.md) + +[Stop-AzVM](./Stop-AzVM.md) + +[Update-AzVM](./Update-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Start-AzVmss.md b/azps-10.1.0/Az.Compute/Start-AzVmss.md new file mode 100644 index 0000000000..a5b5888bed --- /dev/null +++ b/azps-10.1.0/Az.Compute/Start-AzVmss.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 7F7D1F05-617C-4EC5-8FF5-D816E9148841 +online version: https://learn.microsoft.com/powershell/module/az.compute/start-azvmss +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Start-AzVmss.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Start-AzVmss.md +--- + +# Start-AzVmss + +## SYNOPSIS +Starts the VMSS or a set of virtual machines within the VMSS. + +## SYNTAX + +``` +Start-AzVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzVmss** cmdlet starts all the virtual machines within the Virtual Machine Scale Set (VMSS) or a set of virtual machines. +You can use the *InstanceId* parameter to select a set of virtual machines. + +## EXAMPLES + +### Example 1: Start a specific set of virtual machines within the VMSS +```powershell +Start-AzVmss -ResourceGroupName "ContosOrg" -VMScaleSetName "ContosoVMSS"-InstanceId "0", "1" +``` + +This command starts a specific set of virtual machines specified by the instance ID string array that belong to the VMSS named ContosoVMSS. + +### Example 2: Start all virtual machines within the VMSS +```powershell +Start-AzVmss -ResourceGroupName "ContosOrg" -VMScaleSetName "ContosoVMSS" +``` + +This command starts all virtual machines that belong to the VMSS named ContosoVMSS. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceId +Specifies, as a string array, the ID or IDs of the instances that cmdlet starts. +For instance: `-InstanceId "0", "3"` + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the VMSS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +Specifies the name of the VMSS that this cmdlet starts the virtual machines. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVmss](./Get-AzVmss.md) + +[New-AzVmss](./New-AzVmss.md) + +[Remove-AzVmss](./Remove-AzVmss.md) + +[Restart-AzVmss](./Restart-AzVmss.md) + +[Set-AzVmss](./Set-AzVmss.md) + +[Stop-AzVmss](./Stop-AzVmss.md) + +[Update-AzVmss](./Update-AzVmss.md) + + diff --git a/azps-10.1.0/Az.Compute/Start-AzVmssRollingExtensionUpgrade.md b/azps-10.1.0/Az.Compute/Start-AzVmssRollingExtensionUpgrade.md new file mode 100644 index 0000000000..928c2aa3d2 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Start-AzVmssRollingExtensionUpgrade.md @@ -0,0 +1,188 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/start-azvmssrollingextensionupgrade +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Start-AzVmssRollingExtensionUpgrade.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Start-AzVmssRollingExtensionUpgrade.md +--- + +# Start-AzVmssRollingExtensionUpgrade + +## SYNOPSIS +This cmdlet starts a rolling upgrade for all extensions on the given Virtual Machine Scale Set to the latest available version. + +## SYNTAX + +### DefaultParameter (Default) +``` +Start-AzVmssRollingExtensionUpgrade -ResourceGroupName <String> -VMScaleSetName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Start-AzVmssRollingExtensionUpgrade -VirtualMachineScaleSet <PSVirtualMachineScaleSet> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Start-AzVmssRollingExtensionUpgrade -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Starts a rolling upgrade to move all extensions on this virtual machine scale set to the latest available version. +Extensions which are already running the latest available version are not affected. + +## EXAMPLES + +### Example 1 +```powershell +$vmss = Get-AzVmss -ResourceGroupName "MyResourceGroupName" -Name "MyVmssName"; +Add-AzVmssExtension -VirtualMachineScaleSet $vmss -Name "testExtension" -Publisher Microsoft.CPlat.Core -Type "NullWindows" -TypeHandlerVersion "3.0" -AutoUpgradeMinorVersion $True -Setting ""; +Start-AzVmssRollingExtensionUpgrade -ResourceGroupName "MyResourceGroupName" -VMScaleSetName "MyVmssName"; +``` + +This example gets the existing VM scale set "MyVmssName", and adds an extension to it. The final command runs the extension rolling upgrade process. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id of the VM scale set object. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +The VM scale set object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMScaleSetName +The name of the VM scale set. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Start-AzVmssRollingOSUpgrade.md b/azps-10.1.0/Az.Compute/Start-AzVmssRollingOSUpgrade.md new file mode 100644 index 0000000000..4badb84081 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Start-AzVmssRollingOSUpgrade.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/start-azvmssrollingosupgrade +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Start-AzVmssRollingOSUpgrade.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Start-AzVmssRollingOSUpgrade.md +--- + +# Start-AzVmssRollingOSUpgrade + +## SYNOPSIS +Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. + +## SYNTAX + +``` +Start-AzVmssRollingOSUpgrade [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. +Instances which are already running the latest available OS version are not affected. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzVmssRollingOSUpgrade -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" +``` + +This command starts a rolling upgrade of all vm instances of VM scale set "VMSS001" in resource group "Group001". + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +The name of the VM scale set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Stop-AzVM.md b/azps-10.1.0/Az.Compute/Stop-AzVM.md new file mode 100644 index 0000000000..627b37ef6d --- /dev/null +++ b/azps-10.1.0/Az.Compute/Stop-AzVM.md @@ -0,0 +1,266 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 7C3CF963-6F1A-444C-B90C-C1D24F89204D +online version: https://learn.microsoft.com/powershell/module/az.compute/stop-azvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Stop-AzVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Stop-AzVM.md +--- + +# Stop-AzVM + +## SYNOPSIS +Stops an Azure virtual machine. + +## SYNTAX + +### ResourceGroupNameParameterSetName (Default) +``` +Stop-AzVM [-ResourceGroupName] <String> [-Name] <String> [-Force] [-StayProvisioned] [-NoWait] [-SkipShutdown] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceGroupHibernateParameterSet +``` +Stop-AzVM [-ResourceGroupName] <String> [-Name] <String> [-Force] [-NoWait] [-Hibernate] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdParameterSetName +``` +Stop-AzVM [-Force] [-StayProvisioned] [-NoWait] [-SkipShutdown] [-Id] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdHibernateParameterSet +``` +Stop-AzVM [-Force] [-NoWait] [-Hibernate] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzVM** cmdlet stops an Azure virtual machine. + +## EXAMPLES + +### Example 1: Stop a virtual machine +```powershell +Stop-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" +``` + +This command stops the virtual machine named VirtualMachine07 in ResourceGroup11. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Hibernate +Optional parameter to hibernate a virtual machine. (Feature in Preview) + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ResourceGroupHibernateParameterSet, IdHibernateParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id +The ID of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: IdParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The virtual machine name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSetName, ResourceGroupHibernateParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSetName, ResourceGroupHibernateParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipShutdown +To request non-graceful VM shutdown when keeping the VM provisioned. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ResourceGroupNameParameterSetName, IdParameterSetName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StayProvisioned +The cmdlet stops a virtual machine, but does not deallocate it. The account +is charged for the stopped virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ResourceGroupNameParameterSetName, IdParameterSetName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[New-AzVM](./New-AzVM.md) + +[Remove-AzVM](./Remove-AzVM.md) + +[Restart-AzVM](./Restart-AzVM.md) + +[Start-AzVM](./Start-AzVM.md) + +[Update-AzVM](./Update-AzVM.md) + + diff --git a/azps-10.1.0/Az.Compute/Stop-AzVmss.md b/azps-10.1.0/Az.Compute/Stop-AzVmss.md new file mode 100644 index 0000000000..845cb8723e --- /dev/null +++ b/azps-10.1.0/Az.Compute/Stop-AzVmss.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: AF0DDDD0-B664-4AD8-A569-1363FB2EDB40 +online version: https://learn.microsoft.com/powershell/module/az.compute/stop-azvmss +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Stop-AzVmss.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Stop-AzVmss.md +--- + +# Stop-AzVmss + +## SYNOPSIS +Stops the VMSS or a set of virtual machines within the VMSS. + +## SYNTAX + +### DefaultParameter (Default) +``` +Stop-AzVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FriendMethod +``` +Stop-AzVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-Force] + [-StayProvisioned] [-SkipShutdown] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzVmss** cmdlet stops all the virtual machines within the Virtual Machine Scale Set (VMSS) or a set of virtual machines. +You can use the *InstanceId* parameter to select a set of virtual machines. + +## EXAMPLES + +### Example 1: Stop all the virtual machines within the VMSS +```powershell +Stop-AzVmss -ResourceGroupName "ContosoGroup" -VMScaleSetName "ContosoVMSS" +``` + +This command stops all virtual machines that belong to the VMSS named ContosoVMSS. + +### Example 2: Stop a specific set of virtual machines within the VMSS +```powershell +Stop-AzVmss -ResourceGroupName "ContosoGroup" -VMScaleSetName "ContosoVMSS" -InstanceId "3","5" +``` + +This command stops a specific set of virtual machines specified by the instance ID string array that belong to the VMSS named ContosoVMSS. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceId +Specifies, as a string array, the ID or IDs of the virtual machine instances that this cmdlet stops. +For instance: `-InstanceId "0", "3"`. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the VMSS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipShutdown +To request non-graceful VM shutdown + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FriendMethod +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StayProvisioned +If specified, the virtual machine will enter stopped state. If not specified, the virtual machine will enter stopped-deallocated state. The user is still charged for VMs in stopped state but not for VMs in stopped-deallocated state. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FriendMethod +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMScaleSetName +Specifies the name of the VMSS for which this cmdlet stops the virtual machines. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVmss](./Get-AzVmss.md) + +[New-AzVmss](./New-AzVmss.md) + +[Remove-AzVmss](./Remove-AzVmss.md) + +[Restart-AzVmss](./Restart-AzVmss.md) + +[Set-AzVmss](./Set-AzVmss.md) + +[Start-AzVmss](./Start-AzVmss.md) + +[Update-AzVmss](./Update-AzVmss.md) + + diff --git a/azps-10.1.0/Az.Compute/Stop-AzVmssRollingUpgrade.md b/azps-10.1.0/Az.Compute/Stop-AzVmssRollingUpgrade.md new file mode 100644 index 0000000000..d526636c68 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Stop-AzVmssRollingUpgrade.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/stop-azvmssrollingupgrade +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Stop-AzVmssRollingUpgrade.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Stop-AzVmssRollingUpgrade.md +--- + +# Stop-AzVmssRollingUpgrade + +## SYNOPSIS +Cancels the current virtual machine scale set rolling upgrade. + +## SYNTAX + +``` +Stop-AzVmssRollingUpgrade [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Cancels the current virtual machine scale set rolling upgrade. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzVmssRollingUpgrade -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" +``` + +This command cancels on-going rolling upgrade of VM scale set "VMSS001" in resource group "Group001". + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +The name of the VM scale set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Test-AzVMAEMExtension.md b/azps-10.1.0/Az.Compute/Test-AzVMAEMExtension.md new file mode 100644 index 0000000000..3ead38a9ce --- /dev/null +++ b/azps-10.1.0/Az.Compute/Test-AzVMAEMExtension.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 67AED9B8-AE3D-47E5-813C-9B46E11AE46C +online version: https://learn.microsoft.com/powershell/module/az.compute/test-azvmaemextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Test-AzVMAEMExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Test-AzVMAEMExtension.md +--- + +# Test-AzVMAEMExtension + +## SYNOPSIS +Checks the configuration of the AEM extension. + +## SYNTAX + +``` +Test-AzVMAEMExtension [-ResourceGroupName] <String> [-VMName] <String> [[-OSType] <String>] + [[-WaitTimeInMinutes] <Int32>] [-SkipStorageCheck] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzVMAEMExtension** cmdlet checks the configuration of the Azure Enhanced Monitoring (AEM) extension. +The AEM extension collects the performance data. +This cmdlet checks whether performance data is available. + +## EXAMPLES + +### Example 1: Check the configuration of the AEM extension +```powershell +Test-AzVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server" +``` + +This command checks the configuration of the AEM extension for the virtual machine named contoso-server. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSType +Specifies the type of the operating system of the operating system disk. +If the operating system disk does not have a type, you must specify this parameter. +The acceptable values for this parameter are: Windows and Linux. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine that this cmdlet checks. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipStorageCheck +Indicates that this cmdlet skips the check of storage configuration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of a virtual machine. +This cmdlet tests the AEM extension for the virtual machine that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WaitTimeInMinutes +Specifies a time-out period, in minutes, for the storage configuration check. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Extension.AEM.AEMTestResult + +## NOTES + +## RELATED LINKS + +[Get-AzVMAEMExtension](./Get-AzVMAEMExtension.md) + +[Remove-AzVMAEMExtension](./Remove-AzVMAEMExtension.md) + +[Set-AzVMAEMExtension](./Set-AzVMAEMExtension.md) + + diff --git a/azps-10.1.0/Az.Compute/Update-AzAvailabilitySet.md b/azps-10.1.0/Az.Compute/Update-AzAvailabilitySet.md new file mode 100644 index 0000000000..9b44ae6511 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzAvailabilitySet.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azavailabilityset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzAvailabilitySet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzAvailabilitySet.md +--- + +# Update-AzAvailabilitySet + +## SYNOPSIS +Updates an availability set. + +## SYNTAX + +``` +Update-AzAvailabilitySet [-AvailabilitySet] <PSAvailabilitySet> [[-Sku] <String>] + [-ProximityPlacementGroupId <String>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzAvailabilitySet** cmdlet updates an availability set. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAvailabilitySet -ResourceGroupName 'ResourceGroup01' -Name 'AvSet01' | Update-AzAvailabilitySet -Tag @{key1 = "val1"}; +``` + +This command updates the tag of the availability set named 'AvSet01' in the resource group named 'ResourceGroup01'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilitySet +Specifies the availability set object to be updated. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProximityPlacementGroupId +The resource id of the Proximity Placement Group to use with this availability set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The Name of Sku + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzCapacityReservation.md b/azps-10.1.0/Az.Compute/Update-AzCapacityReservation.md new file mode 100644 index 0000000000..cdca3fd2d8 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzCapacityReservation.md @@ -0,0 +1,248 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azcapacityreservation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzCapacityReservation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzCapacityReservation.md +--- + +# Update-AzCapacityReservation + +## SYNOPSIS +Update the Capacity Reservation. + +## SYNTAX + +### DefaultParameter (Default) +``` +Update-AzCapacityReservation [-CapacityToReserve <Int32>] [-AsJob] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DefaultParameterSet +``` +Update-AzCapacityReservation -ResourceGroupName <String> -ReservationGroupName <String> -Name <String> + [-CapacityToReserve <Int32>] [-AsJob] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Update-AzCapacityReservation -CapacityReservation <PSCapacityReservation> [-CapacityToReserve <Int32>] [-AsJob] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIDParameterSet +``` +Update-AzCapacityReservation -ResourceId <String> [-CapacityToReserve <Int32>] [-AsJob] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update the Capacity Reservation. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCapacityReservation -ResourceGroupName $rgname -ReservationGroupName $capResGroup -Name $capRes -CapacityToReserve 4 +``` + +Updating the capacity reservation. + +### Example 2 +```powershell +Get-AzCapacityReservation -ResourceGroupName $rgname -ReservationGroupName $capResGroup -Name $capRes | Update-AzCapacityReservation -CapacityToReserve 4 +``` + +Updating the capacity reservation using the InputObject parameter set. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapacityReservation +PSCapacityReservation object to update. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSCapacityReservation +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -CapacityToReserve +Specifies the number of virtual machines in the scale set. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Capacity Reservation. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: CapacityReservationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReservationGroupName +Name of the Capacity Reservation Group that the capacity reservation resource is in. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: CapacityReservationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID for your Capacity Reservation. + +```yaml +Type: System.String +Parameter Sets: ResourceIDParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSCapacityReservation + +### System.Int32 + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSCapacityReservation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzCapacityReservationGroup.md b/azps-10.1.0/Az.Compute/Update-AzCapacityReservationGroup.md new file mode 100644 index 0000000000..b38f4fd50e --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzCapacityReservationGroup.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azcapacityreservationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzCapacityReservationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzCapacityReservationGroup.md +--- + +# Update-AzCapacityReservationGroup + +## SYNOPSIS +Update the Capacity Reservation Group. + +## SYNTAX + +### DefaultParameter (Default) +``` +Update-AzCapacityReservationGroup [-AsJob] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DefaultParameterSet +``` +Update-AzCapacityReservationGroup -ResourceGroupName <String> -Name <String> [-AsJob] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Update-AzCapacityReservationGroup -CapacityReservationGroup <PSCapacityReservationGroup> [-AsJob] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIDParameterSet +``` +Update-AzCapacityReservationGroup -ResourceId <String> [-AsJob] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update the Capacity Reservation Group. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCapacityReservationGroup -ResourceGroupName $rgname -Name $capResGroup -Tag @{ CreatedBy = "John" } +``` + +Updating the Capacity Reservation Group's tags. + +### Example 2 +```powershell +Get-AzCapacityReservationGroup -ResourceGroupName $rgname -Name $capResGroup | Update-AzCapacityReservationGroup -Tag @{ CreatedBy = "John" } +``` + +Updating the Capacity Reservation Group's tags using the InputObject parameter set. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapacityReservationGroup +PSCapacityReservationGroup object to update. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSCapacityReservationGroup +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Capacity Reservation Group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: CapacityReservationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID for your Capacity Reservation Group. + +```yaml +Type: System.String +Parameter Sets: ResourceIDParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSCapacityReservationGroup + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSCapacityReservationGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzDisk.md b/azps-10.1.0/Az.Compute/Update-AzDisk.md new file mode 100644 index 0000000000..083ffd8178 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzDisk.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azdisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzDisk.md +--- + +# Update-AzDisk + +## SYNOPSIS +Updates a disk. + +## SYNTAX + +### DefaultParameter (Default) +``` +Update-AzDisk [-ResourceGroupName] <String> [-DiskName] <String> [-DiskUpdate] <PSDiskUpdate> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FriendMethod +``` +Update-AzDisk [-ResourceGroupName] <String> [-DiskName] <String> [-Disk] <PSDisk> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzDisk** cmdlet updates a disk. + +## EXAMPLES + +### Example 1 +```powershell +$diskupdateconfig = New-AzDiskUpdateConfig -DiskSizeGB 10 -SkuName Premium_LRS -OsType Windows -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$diskupdateconfig = Set-AzDiskUpdateDiskEncryptionKey -DiskUpdate $diskupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$diskupdateconfig = Set-AzDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +Update-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig; +``` + +The first command creates a local empty disk update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. +The second and third commands set the disk encryption key and key encryption key settings for the disk update object. +The last command takes the disk update object and updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01'. + +### Example 2 +```powershell +New-AzDiskUpdateConfig -DiskSizeGB 10 | Update-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01'; +``` + +This command updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01' to 10 GB disk size. + +### Example 3 +```powershell +$disk = Get-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01'; +$disk.DiskSizeGB = 10; +Update-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $disk; +``` + +These commands also update an existing disk with name 'Disk01' in resource group 'ResourceGroup01' to 10 GB disk size. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disk +Specifies a local disk object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk +Parameter Sets: FriendMethod +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DiskName +Specifies the name of a disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiskUpdate +Specifies a local disk update object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzDiskEncryptionSet.md b/azps-10.1.0/Az.Compute/Update-AzDiskEncryptionSet.md new file mode 100644 index 0000000000..e3307e5b04 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzDiskEncryptionSet.md @@ -0,0 +1,284 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azdiskencryptionset.md +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzDiskEncryptionSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzDiskEncryptionSet.md +--- + +# Update-AzDiskEncryptionSet + +## SYNOPSIS +Updates a disk encryption set. + +## SYNTAX + +### DefaultParameter (Default) +``` +Update-AzDiskEncryptionSet [-ResourceGroupName] <String> [-Name] <String> [-KeyUrl <String>] + [-SourceVaultId <String>] [-RotationToLatestKeyVersionEnabled <Boolean>] [[-Tag] <Hashtable>] [-AsJob] + [-FederatedClientId <String>] [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Update-AzDiskEncryptionSet [-ResourceId] <String> [-KeyUrl <String>] [-SourceVaultId <String>] + [-RotationToLatestKeyVersionEnabled <Boolean>] [[-Tag] <Hashtable>] [-AsJob] [-FederatedClientId <String>] + [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectParameter +``` +Update-AzDiskEncryptionSet [-InputObject] <PSDiskEncryptionSet> [-KeyUrl <String>] [-SourceVaultId <String>] + [-RotationToLatestKeyVersionEnabled <Boolean>] [[-Tag] <Hashtable>] [-AsJob] [-FederatedClientId <String>] + [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates a disk encryption set. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzDiskEncryptionSet -ResourceGroupName 'rg1' -Name 'enc1' -KeyUrl "https://valut1.vault.azure.net:443/keys/key1/mykey" -SourceVaultId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.KeyVault/vaults/vault1'; +``` + +Updates disk encryption set using the given active key in the key vault. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedClientId +Multi-tenant application client id to access key vault in a different tenant. Setting value to 'None' will clear the property. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The local object of the disk encryption set. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskEncryptionSet +Parameter Sets: ObjectParameter +Aliases: DiskEncryptionSet + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyUrl +Url pointing to the active key in KeyVault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of disk encryption set. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: DiskEncryptionSetName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The ID of the resource. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RotationToLatestKeyVersionEnabled +Set this flag to true to enable auto-updating of this disk encryption set to the latest key version + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceVaultId +Resource id of the KeyVault containing the active key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskEncryptionSet + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskEncryptionSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzGallery.md b/azps-10.1.0/Az.Compute/Update-AzGallery.md new file mode 100644 index 0000000000..f089fdaf26 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzGallery.md @@ -0,0 +1,413 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azgallery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzGallery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzGallery.md +--- + +# Update-AzGallery + +## SYNOPSIS +Update a gallery. + +## SYNTAX + +### DefaultParameter (Default) +``` +Update-AzGallery [-ResourceGroupName] <String> [-Name] <String> [-AsJob] [-Description <String>] + [-Tag <Hashtable>] [-Permission <String>] [-Subscription <String[]>] [-Tenant <String[]>] + [-RemoveSubscription <String[]>] [-RemoveTenant <String[]>] [-Share] [-Community] [-Reset] + [-PublisherUri <String>] [-PublisherContact <String>] [-Eula <String>] [-PublicNamePrefix <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Update-AzGallery [-ResourceId] <String> [-AsJob] [-Description <String>] [-Tag <Hashtable>] + [-Permission <String>] [-Subscription <String[]>] [-Tenant <String[]>] [-RemoveSubscription <String[]>] + [-RemoveTenant <String[]>] [-Share] [-Community] [-Reset] [-PublisherUri <String>] + [-PublisherContact <String>] [-Eula <String>] [-PublicNamePrefix <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameter +``` +Update-AzGallery [-InputObject] <PSGallery> [-AsJob] [-Description <String>] [-Tag <Hashtable>] + [-Permission <String>] [-Subscription <String[]>] [-Tenant <String[]>] [-RemoveSubscription <String[]>] + [-RemoveTenant <String[]>] [-Share] [-Community] [-Reset] [-PublisherUri <String>] + [-PublisherContact <String>] [-Eula <String>] [-PublicNamePrefix <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update a gallery. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzGallery -ResourceGroupName $rgname -Name $galleryName -Description $galleryDescription +``` + +Update a gallery. + +### Example 2 +```powershell +Update-AzGallery -ResourceGroupName $rgname -Name $galleryName -Permission Groups -Share -Tenant xxxxxxxx-xxx-xxxxxxx,zzzzzz-zzzzzzz-zzzzzz +``` + +Update a gallery to be shared and add two subscriptions it is to be shared with. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Community +Update sharing profile of the gallery to community. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the gallery resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Eula +Gets or sets end-user license agreement for community gallery image. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The PS Gallery Object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery +Parameter Sets: ObjectParameter +Aliases: Gallery + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: GalleryName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Permission +This property allows you to specify the permission of the sharing gallery. Possible values are: 'Private' and 'Groups'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNamePrefix +Gets or sets the prefix of the gallery name that will be displayed publicly. Visible to all users. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublisherContact +Gets or sets community gallery publisher support email. The email address of the publisher. Visible to all users. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublisherUri +Gets or sets the link to the publisher website. Visible to all users. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RemoveSubscription +A list of subscription IDs the gallery will stop sharing to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RemoveTenant +A list of tenant IDs the gallery will stop sharing to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Reset +Resets the sharing permission of the gallery to 'Private'. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id for the gallery + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Share +Update sharing profile of the gallery. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Subscription +A list of subscription IDs the gallery is aimed to be shared to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tenant +A list of tenant IDs the gallery is aimed to be shared to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzGalleryApplication.md b/azps-10.1.0/Az.Compute/Update-AzGalleryApplication.md new file mode 100644 index 0000000000..1aedf35b5d --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzGalleryApplication.md @@ -0,0 +1,266 @@ +--- +external help file: Az.Compute-help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azgalleryapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzGalleryApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzGalleryApplication.md +--- + +# Update-AzGalleryApplication + +## SYNOPSIS +Update a gallery Application Definition. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzGalleryApplication -GalleryName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Description <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzGalleryApplication -InputObject <IComputeIdentity> [-Description <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update a gallery Application Definition. + +## EXAMPLES + +### Example 1: Update a Gallery Application +```powershell +Update-AzGalleryApplication -ResourceGroupName $rgName -GalleryName $galleryName -Name $name -Description "New Description" +``` + +Updating a Gallery Application. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of this gallery Application Definition resource. +This property is updatable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryName +The name of the Shared Application Gallery in which the Application Definition is to be updated. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery Application Definition to be updated. +The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. +The maximum length is 80 characters. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: GalleryApplicationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20220103.IGalleryApplication + +## 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 <IComputeIdentity>`: Identity Parameter + - `[CommandId <String>]`: The command id. + - `[GalleryApplicationName <String>]`: The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryApplicationVersionName <String>]`: The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryImageName <String>]`: The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryImageVersionName <String>]`: The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryName <String>]`: The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. + - `[Id <String>]`: Resource identity path + - `[InstanceId <String>]`: The instance ID of the virtual machine. + - `[Location <String>]`: The location upon which run commands is queried. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[RunCommandName <String>]`: The name of the virtual machine run command. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VMName <String>]`: The name of the virtual machine where the run command should be created or updated. + - `[VMScaleSetName <String>]`: The name of the VM scale set. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzGalleryApplicationVersion.md b/azps-10.1.0/Az.Compute/Update-AzGalleryApplicationVersion.md new file mode 100644 index 0000000000..b8ff5b44d5 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzGalleryApplicationVersion.md @@ -0,0 +1,388 @@ +--- +external help file: Az.Compute-help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azgalleryapplicationversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzGalleryApplicationVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzGalleryApplicationVersion.md +--- + +# Update-AzGalleryApplicationVersion + +## SYNOPSIS +Update a gallery Application Version. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzGalleryApplicationVersion -GalleryApplicationName <String> -GalleryName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] -PackageFileLink <String> + [-DefaultConfigFileLink <String>] [-PublishingProfileEndOfLifeDate <DateTime>] + [-PublishingProfileExcludeFromLatest] [-ReplicaCount <Int32>] [-Tag <Hashtable>] + [-TargetRegion <ITargetRegion[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzGalleryApplicationVersion -InputObject <IComputeIdentity> -PackageFileLink <String> + [-DefaultConfigFileLink <String>] [-PublishingProfileEndOfLifeDate <DateTime>] + [-PublishingProfileExcludeFromLatest] [-ReplicaCount <Int32>] [-Tag <Hashtable>] + [-TargetRegion <ITargetRegion[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Update a gallery Application Version. + +## EXAMPLES + +### Example 1: Update Replica Count of Gallery Application Version +```powershell +$ctx = New-AzStorageContext -StorageAccountName $storAccName +$SASToken = New-AzStorageBlobSASToken -Context $ctx -Container $containerName -blob $blobName -Permission r +$storAcc = Get-AzStorageAccount -ResourceGroupName $rgName -Name $storAccName +$blob = Get-AzStorageBlob -Container $containerName -Blob $blobName -Context $storAcc.Context +$SASToken = New-AzStorageBlobSASToken -Container $containerName -Blob $blobName -Permission rwd -Context $storAcc.Context +$SASUri = $blob.ICloudBlob.Uri.AbsoluteUri + "?" +$SASToken +Update-AzGalleryApplicationVersion -ResourceGroupName $rgname -GalleryName $galleryName -GalleryApplicationName $galleryApplicationName -name "0.1.0" -PackageFileLink $SASUri -ReplicaCount 3 +``` + +Updating a Gallery Application Version's replica count. +Using SAS Uri for the blob for PackageFileLink. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConfigFileLink +Optional. +The defaultConfigurationLink of the artifact, must be a readable storage page blob. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryApplicationName +The name of the gallery Application Definition in which the Application Version is to be updated. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryName +The name of the Shared Application Gallery in which the Application Definition resides. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery Application Version to be updated. +Needs to follow semantic version name pattern: The allowed characters are digit and period. +Digits must be within the range of a 32-bit integer. +Format: \<MajorVersion\>.\<MinorVersion\>.\<Patch\> + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: GalleryApplicationVersionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageFileLink +Required. +The mediaLink of the artifact, must be a readable storage page blob. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishingProfileEndOfLifeDate +The end of life date of the gallery image version. +This property can be used for decommissioning purposes. +This property is updatable. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishingProfileExcludeFromLatest +If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaCount +The number of replicas of the Image Version to be created per region. +This property would take effect for a region when regionalReplicaCount is not specified. +This property is updatable. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetRegion +The target regions where the Image Version is going to be replicated to. +This property is updatable. +To construct, see NOTES section for TARGETREGION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20220103.ITargetRegion[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20220103.IGalleryApplicationVersion + +## 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 <IComputeIdentity>`: Identity Parameter + - `[CommandId <String>]`: The command id. + - `[GalleryApplicationName <String>]`: The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryApplicationVersionName <String>]`: The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryImageName <String>]`: The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. + - `[GalleryImageVersionName <String>]`: The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> + - `[GalleryName <String>]`: The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. + - `[Id <String>]`: Resource identity path + - `[InstanceId <String>]`: The instance ID of the virtual machine. + - `[Location <String>]`: The location upon which run commands is queried. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[RunCommandName <String>]`: The name of the virtual machine run command. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VMName <String>]`: The name of the virtual machine where the run command should be created or updated. + - `[VMScaleSetName <String>]`: The name of the VM scale set. + +`TARGETREGION <ITargetRegion[]>`: The target regions where the Image Version is going to be replicated to. This property is updatable. + - `Name <String>`: The name of the region. + - `[EncryptionDataDiskImage <IDataDiskImageEncryption[]>]`: A list of encryption specifications for data disk images. + - `Lun <Int32>`: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. + - `[DiskEncryptionSetId <String>]`: A relative URI containing the resource ID of the disk encryption set. + - `[OSDiskImageDiskEncryptionSetId <String>]`: A relative URI containing the resource ID of the disk encryption set. + - `[RegionalReplicaCount <Int32?>]`: The number of replicas of the Image Version to be created per region. This property is updatable. + - `[SecurityProfileConfidentialVMEncryptionType <ConfidentialVMEncryptionType?>]`: confidential VM encryption types + - `[SecurityProfileSecureVMDiskEncryptionSetId <String>]`: secure VM disk encryption set id + - `[StorageAccountType <StorageAccountType?>]`: Specifies the storage account type to be used to store the image. This property is not updatable. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzGalleryImageDefinition.md b/azps-10.1.0/Az.Compute/Update-AzGalleryImageDefinition.md new file mode 100644 index 0000000000..36c64bffdf --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzGalleryImageDefinition.md @@ -0,0 +1,441 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azgalleryimagedefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzGalleryImageDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzGalleryImageDefinition.md +--- + +# Update-AzGalleryImageDefinition + +## SYNOPSIS +Update a gallery image definition. + +## SYNTAX + +### DefaultParameter (Default) +``` +Update-AzGalleryImageDefinition [-ResourceGroupName] <String> [-GalleryName] <String> [-Name] <String> [-AsJob] + [-Description <String>] [-DisallowedDiskType <String[]>] [-EndOfLifeDate <DateTime>] [-Eula <String>] + [-MinimumMemory <Int32>] [-MinimumVCPU <Int32>] [-MaximumMemory <Int32>] [-MaximumVCPU <Int32>] + [-PrivacyStatementUri <String>] [-PurchasePlanName <String>] [-PurchasePlanProduct <String>] + [-PurchasePlanPublisher <String>] [-ReleaseNoteUri <String>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Update-AzGalleryImageDefinition [-ResourceId] <String> [-AsJob] [-Description <String>] + [-DisallowedDiskType <String[]>] [-EndOfLifeDate <DateTime>] [-Eula <String>] [-MinimumMemory <Int32>] + [-MinimumVCPU <Int32>] [-MaximumMemory <Int32>] [-MaximumVCPU <Int32>] [-PrivacyStatementUri <String>] + [-PurchasePlanName <String>] [-PurchasePlanProduct <String>] [-PurchasePlanPublisher <String>] + [-ReleaseNoteUri <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectParameter +``` +Update-AzGalleryImageDefinition [-InputObject] <PSGalleryImage> [-AsJob] [-Description <String>] + [-DisallowedDiskType <String[]>] [-EndOfLifeDate <DateTime>] [-Eula <String>] [-MinimumMemory <Int32>] + [-MinimumVCPU <Int32>] [-MaximumMemory <Int32>] [-MaximumVCPU <Int32>] [-PrivacyStatementUri <String>] + [-PurchasePlanName <String>] [-PurchasePlanProduct <String>] [-PurchasePlanPublisher <String>] + [-ReleaseNoteUri <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Update a gallery image definition. + +## EXAMPLES + +### Example 1: Change the recommended configurations for an image definition + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$imageName = "myImage" +$versionName = "1.0.0" +$minVCPU = 1 +$maxVCPU = 4 +$minMemory = 1 +$maxMemory = 8 +$description = "My image definition" +$endOfLifeDate = "2024-08-02T00:00:00+00:00" +Update-AzGalleryImageDefinition -ResourceGroupName $resourceGroupName -GalleryName $galleryName -Name $galleryImageDefinitionName -Description $description -EndOfLifeDate $endOfLifeDate -MinimumMemory $minMemory -MaximumMemory $maxMemory -MinimumVCPU $minVCPU -MaximumVCPU $maxVCPU +``` + +Update a gallery image definition's recommended configuration settings + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the gallery image Definition resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisallowedDiskType +The disallowed disk types. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EndOfLifeDate +The end of life date of the gallery Image Definition + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Eula +The Eula agreement for the gallery Image Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryName +The name of the gallery. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The PS Gallery Image Definition Object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage +Parameter Sets: ObjectParameter +Aliases: GalleryImageDefinition + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaximumMemory +The maximum of the recommended memory + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaximumVCPU +The maximum of the recommended CPU core + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MinimumMemory +The minimum of the recommended memory + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MinimumVCPU +The minimum of the recommended CPU core + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery image definition. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: GalleryImageDefinitionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivacyStatementUri +The privacy statement uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PurchasePlanName +The ID for the purchase plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PurchasePlanProduct +The product ID for the purchase plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PurchasePlanPublisher +The publisher ID for the purchase plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReleaseNoteUri +The release note uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource ID for the image definition + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage + +### System.DateTime + +### System.Collections.Hashtable + +### System.Int32 + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzGalleryImageVersion.md b/azps-10.1.0/Az.Compute/Update-AzGalleryImageVersion.md new file mode 100644 index 0000000000..cda43ffa51 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzGalleryImageVersion.md @@ -0,0 +1,385 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azgalleryimageversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzGalleryImageVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzGalleryImageVersion.md +--- + +# Update-AzGalleryImageVersion + +## SYNOPSIS +Update a gallery image version. + +## SYNTAX + +### DefaultParameter (Default) +``` +Update-AzGalleryImageVersion [-ResourceGroupName] <String> [-GalleryName] <String> + [-GalleryImageDefinitionName] <String> [-Name] <String> [-AsJob] [-PublishingProfileEndOfLifeDate <DateTime>] + [-PublishingProfileExcludeFromLatest] [-ReplicaCount <Int32>] [-Tag <Hashtable>] [-TargetRegion <Hashtable[]>] + [-TargetExtendedLocation <Hashtable[]>] [-AllowDeletionOfReplicatedLocation <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Update-AzGalleryImageVersion [-ResourceId] <String> [-AsJob] [-PublishingProfileEndOfLifeDate <DateTime>] + [-PublishingProfileExcludeFromLatest] [-ReplicaCount <Int32>] [-Tag <Hashtable>] [-TargetRegion <Hashtable[]>] + [-TargetExtendedLocation <Hashtable[]>] [-AllowDeletionOfReplicatedLocation <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameter +``` +Update-AzGalleryImageVersion [-InputObject] <PSGalleryImageVersion> [-AsJob] + [-PublishingProfileEndOfLifeDate <DateTime>] [-PublishingProfileExcludeFromLatest] [-ReplicaCount <Int32>] + [-Tag <Hashtable>] [-TargetRegion <Hashtable[]>] [-TargetExtendedLocation <Hashtable[]>] + [-AllowDeletionOfReplicatedLocation <Boolean>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Update a gallery image version. + +## EXAMPLES + +### Example 1: Change the replication regions and replica count + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$imageName = "myImage" +$versionName = "1.0.0" +$region1 = @{Name='West US';ReplicaCount=1} +$region2 = @{Name='East US';ReplicaCount=2} +$region3 = @{Name='Central US'} +$targetRegions = @($region1,$region2,$region3) +Update-AzGalleryImageVersion -ResourceGroupName $rgname -GalleryName $galleryName -GalleryImageDefinitionName $imageName -Name $versionName -ReplicaCount 2 -TargetRegion $targetRegions +``` + +Update a gallery image version's regions. + +### Example 2: Change whether an image version should be considered for latest. + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$imageName = "myImage" +$versionName = "1.0.0" +Update-AzGalleryImageVersion -ResourceGroupName $rgname -GalleryName $galleryName -GalleryImageDefinitionName $imageName -Name $versionName -PublishingProfileExcludeFromLatest:$false +``` + +Update a gallery image version's exclude from latest status. To include an image version in consideration for latest, use `-PublishingProfileExcludeFromLatest:$false`. To exclude an image version from consideration for latest, use `-PublishingProfileExcludeFromLatest`. + +### Example 3: Change the end-of-life date for an image version. + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$imageName = "myImage" +$versionName = "1.0.0" +$endOfLifeDate = "2024-08-02T00:00:00+00:00" +Update-AzGalleryImageVersion -ResourceGroupName $rgname -GalleryName $galleryName -GalleryImageDefinitionName $imageName -Name $versionName -PublishingProfileEndOfLifeDate $endOfLifeDate +``` + +Update a gallery image version's end-of-life date. The image version can still be used to create virtual machines after the end-of-life date. + +### Example 4: Update to remove TargetExtendedLocations. + +```powershell +$rgName = "myResourceGroup" +$galleryName = "myGallery" +$imageName = "myImage" +$versionName = "1.0.0" + +Update-AzGalleryImageVersion -ResourceGroupName $rgname -GalleryName $galleryName -GalleryImageDefinitionName $imageName -Name $versionName -TargetExtendedLocation @() -AllowDeletionOfReplicatedLocation $True +``` + +Update a gallery image version to remove existing target extended locations. Pass in an empty array for -TargetExtendedLocation and set -AllowDeletionOfReplicatedLocation to true. + +## PARAMETERS + +### -AllowDeletionOfReplicatedLocation +Indicates whether or not removing this Gallery Image Version from replicated regions is allowed. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryImageDefinitionName +The name of the gallery image definition. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: GalleryImageName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GalleryName +The name of the gallery. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The PS Gallery Image Version Object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion +Parameter Sets: ObjectParameter +Aliases: GalleryImageVersion + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the gallery image version. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: GalleryImageVersionName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublishingProfileEndOfLifeDate +The end of life date of the gallery Image Version. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublishingProfileExcludeFromLatest +If it is set, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReplicaCount +The number of replicas of the Image Version to be created per region. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource ID for the gallery image version. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetExtendedLocation +The target extended locations where the Image Version is going to be replicated to. This property is updatable. + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetRegion +The target regions where the Image Version is going to be replicated to. + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion + +### System.Collections.Hashtable + +### System.Int32 + +### System.Management.Automation.SwitchParameter + +### System.DateTime + +### System.Collections.Hashtable[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzImage.md b/azps-10.1.0/Az.Compute/Update-AzImage.md new file mode 100644 index 0000000000..1ab8b02ea9 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzImage.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzImage.md +--- + +# Update-AzImage + +## SYNOPSIS +Updates an image. + +## SYNTAX + +### DefaultParameter (Default) +``` +Update-AzImage [-ResourceGroupName] <String> [-ImageName] <String> [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Update-AzImage [-Tag <Hashtable>] [-AsJob] [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameter +``` +Update-AzImage [-Tag <Hashtable>] [-AsJob] [-Image] <PSImage> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzImage** cmdlet updates an image. +Currently, only the Tags can be updated. + +## EXAMPLES + +### Example 1 +```powershell +$image = Get-AzImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01' +$image.Tags = New-Object "System.Collections.Generic.Dictionary``2[System.String,System.String]" +$image.Tags.Add("key1", "val1") +Update-AzImage -Image $image +``` + +This command updates the Tag value of the existing image 'Image01' in the resource group 'ResourceGroup01'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Image +Specifies a local image object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSImage +Parameter Sets: ObjectParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ImageName +Specifies the name of an image. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id for the image + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzRestorePointCollection.md b/azps-10.1.0/Az.Compute/Update-AzRestorePointCollection.md new file mode 100644 index 0000000000..973b40f78b --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzRestorePointCollection.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azrestorepointcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzRestorePointCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzRestorePointCollection.md +--- + +# Update-AzRestorePointCollection + +## SYNOPSIS +Update Restore Point Collection. + +## SYNTAX + +``` +Update-AzRestorePointCollection [-ResourceGroupName] <String> [-Name] <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update Restore Point Collection. Can only Update Tags + +## EXAMPLES + +### Example 1 +```powershell +Update-AzRestorePointCollection -ResourceGroupName <String> -Name <String> -Tag <Hashtable> -Confirm +``` + +Add updated tags using -Tag parameter + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RestorePointCollectionName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSRestorePointCollection + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzSnapshot.md b/azps-10.1.0/Az.Compute/Update-AzSnapshot.md new file mode 100644 index 0000000000..721a8197b2 --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzSnapshot.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azsnapshot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzSnapshot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzSnapshot.md +--- + +# Update-AzSnapshot + +## SYNOPSIS +Updates a snapshot. + +## SYNTAX + +### DefaultParameter (Default) +``` +Update-AzSnapshot [-ResourceGroupName] <String> [-SnapshotName] <String> [-SnapshotUpdate] <PSSnapshotUpdate> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FriendMethod +``` +Update-AzSnapshot [-ResourceGroupName] <String> [-SnapshotName] <String> [-Snapshot] <PSSnapshot> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSnapshot** cmdlet updates a snapshot. + +## EXAMPLES + +### Example 1 +```powershell +$snapshotupdateconfig = New-AzSnapshotUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -EncryptionSettingsEnabled $true; +$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/'; +$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; +$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456'; +$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; +$snapshotupdateconfig = Set-AzSnapshotUpdateDiskEncryptionKey -SnapshotUpdate $snapshotupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; +$snapshotupdateconfig = Set-AzSnapshotUpdateKeyEncryptionKey -SnapshotUpdate $snapshotupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; +Update-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -SnapshotUpdate $snapshotupdateconfig; +``` + +The first command creates a local empty snapshot update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. +The second and third commands set the disk encryption key and key encryption key settings for the snapshot update object. +The last command takes the snapshot update object and updates an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. + +### Example 2 +```powershell +New-AzSnapshotUpdateConfig -DiskSizeGB 10 | Update-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01'; +``` + +This command updates an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01' to 10 GB disk size. + +### Example 3 +```powershell +$snapshot = Get-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01'; +$snapshot.DiskSizeGB = 10; +Update-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshot; +``` + +These commands also update an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01' to 10 GB disk size. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Snapshot +Specifies a local snapshot object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot +Parameter Sets: FriendMethod +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SnapshotName +Specifies the name of a snapshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SnapshotUpdate +Specifies a local snapshot update object. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzSshKey.md b/azps-10.1.0/Az.Compute/Update-AzSshKey.md new file mode 100644 index 0000000000..d822f7f53d --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzSshKey.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azsshkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzSshKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzSshKey.md +--- + +# Update-AzSshKey + +## SYNOPSIS +Update a SSH Public Key resource. + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Update-AzSshKey -ResourceGroupName <String> -Name <String> -PublicKey <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIDParameterSet +``` +Update-AzSshKey -ResourceId <String> -PublicKey <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Update-AzSshKey -InputObject <PSSshPublicKeyResource> -PublicKey <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update a SSH Public Key resource. + +## EXAMPLES + +### Example 1 +```powershell +$SshKey1 = Get-AzSshKey -ResourceGroupName "testRG" -Name "sshKey1" +Update-AzSshKey -ResourceGroupName "testRG" -Name "sshKey2" -PublicKey $SshKey1.publickey +``` + +Updates the public key value of 'sshKey2' with public key value from 'sshKey1' + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PowerShell SSH Public Key Object + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSshPublicKeyResource +Parameter Sets: InputObjectParameterSet +Aliases: SshKey + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Ssh Public Key resource to get. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: sshkeyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PublicKey +Public Key value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +Resource ID for your SSH Public Key Resource. + +```yaml +Type: System.String +Parameter Sets: ResourceIDParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSSshPublicKeyResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Compute/Update-AzVM.md b/azps-10.1.0/Az.Compute/Update-AzVM.md new file mode 100644 index 0000000000..49ff51c47e --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzVM.md @@ -0,0 +1,457 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 38917534-49C6-47EA-B815-240F794EE655 +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzVM.md +--- + +# Update-AzVM + +## SYNOPSIS +Updates the state of an Azure virtual machine. + +## SYNTAX + +### ResourceGroupNameParameterSetName (Default) +``` +Update-AzVM [-ResourceGroupName] <String> -VM <PSVirtualMachine> [-Tag <Hashtable>] + [-OsDiskWriteAccelerator <Boolean>] [-UltraSSDEnabled <Boolean>] [-MaxPrice <Double>] + [-EncryptionAtHost <Boolean>] [-ProximityPlacementGroupId <String>] [-HostId <String>] + [-CapacityReservationGroupId <String>] [-AsJob] [-NoWait] [-UserData <String>] [-HibernationEnabled] + [-vCPUCountAvailable <Int32>] [-vCPUCountPerCore <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ExplicitIdentityParameterSet +``` +Update-AzVM [-ResourceGroupName] <String> -VM <PSVirtualMachine> [-Tag <Hashtable>] + -IdentityType <ResourceIdentityType> [-IdentityId <String[]>] [-OsDiskWriteAccelerator <Boolean>] + [-UltraSSDEnabled <Boolean>] [-MaxPrice <Double>] [-EncryptionAtHost <Boolean>] + [-ProximityPlacementGroupId <String>] [-HostId <String>] [-CapacityReservationGroupId <String>] [-AsJob] + [-NoWait] [-UserData <String>] [-HibernationEnabled] [-vCPUCountAvailable <Int32>] [-vCPUCountPerCore <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdParameterSetName +``` +Update-AzVM [-Id] <String> -VM <PSVirtualMachine> [-Tag <Hashtable>] [-OsDiskWriteAccelerator <Boolean>] + [-UltraSSDEnabled <Boolean>] [-MaxPrice <Double>] [-EncryptionAtHost <Boolean>] + [-ProximityPlacementGroupId <String>] [-HostId <String>] [-CapacityReservationGroupId <String>] [-AsJob] + [-NoWait] [-UserData <String>] [-HibernationEnabled] [-vCPUCountAvailable <Int32>] [-vCPUCountPerCore <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzVM** cmdlet updates the state of an Azure virtual machine to the state of a virtual machine object. + +## EXAMPLES + +### Example 1: Update a virtual machine +```powershell +Update-AzVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine +``` + +This command updates the virtual machine, $VirtualMachine, in ResourceGroup11. +The command updates it by using the virtual machine object stored in the $VirtualMachine variable. +To obtain a virtual machine object, use the **Get-AzVM** cmdlet. + +### Example 2: Update a virtual machine to disable hyperthreading. +```powershell +$resourceGroupName = 'Resource Group Name>' +$vmname = 'Virtual Machine Name'; +$domainNameLabel = "d1" + $rgname; +$vCPUsCoreInitial = 2; +$vCPUsAvailableInitial = 4; +$vCPUsCore1 = 1; +$vCPUsAvailable1 = 1; +$vmSize = 'Standard_D4s_v4'; + +$securePassword = 'Password' | ConvertTo-SecureString -AsPlainText -Force; +$user = "user"; +$cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword); +$vm = New-AzVM -ResourceGroupName $rgname -Name $vmname -Credential $cred -DomainNameLabel $domainNameLabel -Size $vmSize -vCPUCountPerCore $vCPUsCoreInitial -vCPUCountAvailable $vCPUsAvailableInitial; +# The $vm.HardwareProfile.VmSizeProperties.VCPUsPerCore property is 2, and the $vm.HardwareProfile.VmSizeProperties.VCPUsAvailable property is 4. + +Update-AzVm -ResourceGroupName $rgname -VM $vm -vCPUCountAvailable $vCPUsAvailable1 -vCPUCountPerCore $vCPUsCore1; +# The $vm.HardwareProfile.VmSizeProperties.VCPUsPerCore property is 1, and the $vm.HardwareProfile.VmSizeProperties.VCPUsAvailable property is 1. +# Hyperthreading is now disabled for this VM. +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapacityReservationGroupId +Id of the capacity reservation Group that is used to allocate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionAtHost +EncryptionAtHost property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. +This will enable the encryption for all the disks including Resource/Temp disk at host itself. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HibernationEnabled +The flag that enables or disables hibernation capability on the VM. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HostId +The Id of Host + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id +Specifies the resource ID of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: IdParameterSetName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityId +Specifies the list of user identities associated with the virtual machine. +The user identity references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' + +```yaml +Type: System.String[] +Parameter Sets: ExplicitIdentityParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The type of identity used for the virtual machine. Valid values are SystemAssigned, UserAssigned, SystemAssignedUserAssigned, and None. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.ResourceIdentityType] +Parameter Sets: ExplicitIdentityParameterSet +Aliases: +Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPrice +Specifies the maximum price you are willing to pay for a low priority VM/VMSS. This price is in US Dollars. This price will be compared with the current low priority price for the VM size. Also, the prices are compared at the time of create/update of low priority VM/VMSS and the operation will only succeed if the maxPrice is greater than the current low priority price. The maxPrice will also be used for evicting a low priority VM/VMSS if the current low priority price goes beyond the maxPrice after creation of VM/VMSS. Possible values are: any decimal value greater than zero. Example: 0.01538. -1 indicates that the low priority VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsDiskWriteAccelerator +Specifies whether WriteAccelerator should be enabled or disabled on the OS disk. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProximityPlacementGroupId +The resource id of the Proximity Placement Group to use with this virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSetName, ExplicitIdentityParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specifies the resources and resource groups can be tagged with a set of name-value pairs. +Adding tags to resources enables you to group resources together across resource groups and to create your own views. +Each resource or resource group can have a maximum of 15 tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UltraSSDEnabled +The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM. +Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine only if this property is enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserData +UserData for the VM, which will be base-64 encoded. Customer should not pass any secrets in here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -vCPUCountAvailable +Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -vCPUCountPerCore +Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). Setting this property to 1 also means that hyper-threading is disabled. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VM +Specifies a local virtual machine object. +To obtain a virtual machine object, use the Get-AzVM cmdlet. +This virtual machine object contains the updated state for the virtual machine. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine +Parameter Sets: (All) +Aliases: VMProfile + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzVM](./Get-AzVM.md) + +[New-AzVM](./New-AzVM.md) + +[Remove-AzVM](./Remove-AzVM.md) + +[Restart-AzVM](./Restart-AzVM.md) + +[Start-AzVM](./Start-AzVM.md) + +[Stop-AzVM](./Stop-AzVM.md) + +[New-AzVMConfig](./New-AzVMConfig.md) + + diff --git a/azps-10.1.0/Az.Compute/Update-AzVmss.md b/azps-10.1.0/Az.Compute/Update-AzVmss.md new file mode 100644 index 0000000000..f5f8dcaf8f --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzVmss.md @@ -0,0 +1,1124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: 9EE192A5-4E3F-41ED-A539-8E0A5D5EA4C9 +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azvmss +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzVmss.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzVmss.md +--- + +# Update-AzVmss + +## SYNOPSIS +Updates the state of a VMSS. + +## SYNTAX + +### DefaultParameter (Default) +``` +Update-AzVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> + [[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>] [-AutomaticOSUpgrade <Boolean>] + [-AutomaticRepairGracePeriod <String>] [-BootDiagnosticsEnabled <Boolean>] + [-BootDiagnosticsStorageUri <String>] [-CustomData <String>] [-DisableAutoRollback <Boolean>] + [-DisablePasswordAuthentication <Boolean>] [-EnableAutomaticRepair <Boolean>] + [-EnableAutomaticUpdate <Boolean>] [-ImageReferenceId <String>] [-ImageReferenceOffer <String>] + [-ImageReferencePublisher <String>] [-ImageReferenceSku <String>] [-ImageReferenceVersion <String>] + [-ImageUri <String>] [-LicenseType <String>] [-ManagedDiskStorageAccountType <String>] + [-MaxBatchInstancePercent <Int32>] [-MaxPrice <Double>] [-MaxUnhealthyInstancePercent <Int32>] + [-MaxUnhealthyUpgradedInstancePercent <Int32>] [-OsDiskCaching <CachingTypes>] + [-OsDiskWriteAccelerator <Boolean>] [-Overprovision <Boolean>] [-ScaleInPolicyForceDeletion <Boolean>] + [-PauseTimeBetweenBatches <String>] [-PlanName <String>] [-PlanProduct <String>] [-PlanPromotionCode <String>] + [-PlanPublisher <String>] [-ProvisionVMAgent <Boolean>] [-ProximityPlacementGroupId <String>] + [-ScaleInPolicy <String[]>] [-SinglePlacementGroup <Boolean>] [-SkipExtensionsOnOverprovisionedVMs <Boolean>] + [-SkuCapacity <Int32>] [-SkuName <String>] [-SkuTier <String>] [-Tag <Hashtable>] + [-TerminateScheduledEventNotBeforeTimeoutInMinutes <Int32>] [-TerminateScheduledEvents <Boolean>] + [-TimeZone <String>] [-UltraSSDEnabled <Boolean>] [-UpgradePolicyMode <UpgradeMode>] + [-CapacityReservationGroupId <String>] [-VhdContainer <String[]>] [-AsJob] [-EncryptionAtHost <Boolean>] + [-UserData <String>] [-AutomaticRepairAction <String>] [-BaseRegularPriorityCount <Int32>] + [-RegularPriorityPercentage <Int32>] [-SharedGalleryImageId <String>] [-OSImageScheduledEventEnabled] + [-OSImageScheduledEventNotBeforeTimeoutInMinutes <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ExplicitIdentityParameterSet +``` +Update-AzVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> + [[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>] [-AutomaticOSUpgrade <Boolean>] + [-AutomaticRepairGracePeriod <String>] [-BootDiagnosticsEnabled <Boolean>] + [-BootDiagnosticsStorageUri <String>] [-CustomData <String>] [-DisableAutoRollback <Boolean>] + [-DisablePasswordAuthentication <Boolean>] [-EnableAutomaticRepair <Boolean>] + [-EnableAutomaticUpdate <Boolean>] [-IdentityId <String[]>] -IdentityType <ResourceIdentityType> + [-ImageReferenceId <String>] [-ImageReferenceOffer <String>] [-ImageReferencePublisher <String>] + [-ImageReferenceSku <String>] [-ImageReferenceVersion <String>] [-ImageUri <String>] [-LicenseType <String>] + [-ManagedDiskStorageAccountType <String>] [-MaxBatchInstancePercent <Int32>] [-MaxPrice <Double>] + [-MaxUnhealthyInstancePercent <Int32>] [-MaxUnhealthyUpgradedInstancePercent <Int32>] + [-OsDiskCaching <CachingTypes>] [-OsDiskWriteAccelerator <Boolean>] [-Overprovision <Boolean>] + [-ScaleInPolicyForceDeletion <Boolean>] [-PauseTimeBetweenBatches <String>] [-PlanName <String>] + [-PlanProduct <String>] [-PlanPromotionCode <String>] [-PlanPublisher <String>] [-ProvisionVMAgent <Boolean>] + [-ProximityPlacementGroupId <String>] [-ScaleInPolicy <String[]>] [-SinglePlacementGroup <Boolean>] + [-SkipExtensionsOnOverprovisionedVMs <Boolean>] [-SkuCapacity <Int32>] [-SkuName <String>] [-SkuTier <String>] + [-Tag <Hashtable>] [-TerminateScheduledEventNotBeforeTimeoutInMinutes <Int32>] + [-TerminateScheduledEvents <Boolean>] [-TimeZone <String>] [-UltraSSDEnabled <Boolean>] + [-UpgradePolicyMode <UpgradeMode>] [-CapacityReservationGroupId <String>] [-VhdContainer <String[]>] [-AsJob] + [-EncryptionAtHost <Boolean>] [-UserData <String>] [-AutomaticRepairAction <String>] + [-BaseRegularPriorityCount <Int32>] [-RegularPriorityPercentage <Int32>] [-SharedGalleryImageId <String>] + [-OSImageScheduledEventEnabled] [-OSImageScheduledEventNotBeforeTimeoutInMinutes <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzVmss** cmdlet updates the state of a Virtual Machine Scale Set (VMSS) to the state of a local VMSS object. + +## EXAMPLES + +### Example 1: Update the state of a VMSS to the state of a local VMSS object. +```powershell +Update-AzVmss -ResourceGroupName "Group001" -Name "VMSS001" -VirtualMachineScaleSet $LocalVMSS +``` + +This command updates the state of the VMSS named VMSS001 that belongs to the resource group named Group001 to the state of a local VMSS object, $LocalVMSS. + +### Example 2 + +Updates the state of a VMSS. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Update-AzVmss -ResourceGroupName 'Group001' -VMScaleSetName 'VMSS001' -VirtualMachineScaleSet <PSVirtualMachineScaleSet> -IdentityType SystemAssigned +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticOSUpgrade +Sets whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticRepairAction +Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutomaticRepairGracePeriod +The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BaseRegularPriorityCount +Specifies the minimum number of VMs that must be of Regular priority as a VMSS Flex instance scales out. This parameter is only valid for VMSS instances with Flexible OrchestrationMode. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BootDiagnosticsEnabled +Whether boot diagnostics should be enabled on the virtual machine scale set. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BootDiagnosticsStorageUri +URI of the storage account to use for placing the console output and screenshot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapacityReservationGroupId +Id of the capacity reservation Group that is used to allocate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomData +Specifies a base-64 encoded string of custom data. +This is decoded to a binary array that is saved as a file on the virtual machine. +The maximum length of the binary array is 65535 bytes. <br> +For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](/azure/virtual-machines/linux/tutorial-automate-vm-deployment). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAutoRollback +Disable Auto Rollback for Auto OS Upgrade Policy + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisablePasswordAuthentication +Indicates that this cmdlet disables password authentication for Linux OS. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutomaticRepair +Enable or disable automatic repairs on the virtual machine scale set. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutomaticUpdate +Indicates whether the Windows virtual machines in the VMSS are enabled for automatic updates. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionAtHost +This parameter can be used by user in the request to enable or disable the Host Encryption for the virtual machine scale set. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityId +Specifies the list of user identities associated with the virtual machine scale set. +The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' + +```yaml +Type: System.String[] +Parameter Sets: ExplicitIdentityParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Specifies the type of identity used for the virtual machine scale set. +The type 'SystemAssignedUserAssigned' includes both an implicitly created identity and a set of user assigned identities. +The type 'None' will remove any identities from the virtual machine scale set. +The acceptable values for this parameter are: +- SystemAssigned +- UserAssigned +- SystemAssignedUserAssigned +- None + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.ResourceIdentityType] +Parameter Sets: ExplicitIdentityParameterSet +Aliases: +Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceId +Specifies the image reference ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceOffer +Specifies the type of virtual machine image (VMImage) offer. +To obtain an image offer, use the Get-AzVMImageOffer cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferencePublisher +Specifies the name of a publisher of a VMImage. +To obtain a publisher, use the Get-AzVMImagePublisher cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceSku +Specifies the VMImage SKU. +To obtain SKUs, use the Get-AzVMImageSku cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceVersion +Specifies the version of the VMImage. +To use the latest version, specify a value of latest instead of a particular version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageUri +Specifies the blob URI for the user image. +VMSS creates an operating system disk in the same container of the user image. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +Specify the license type, which is for bringing your own license scenario. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedDiskStorageAccountType +Specifies the storage account type for managed disk. +The acceptable values for this parameter are: +- Standard_LRS +- Premium_LRS + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxBatchInstancePercent +The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. +As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. +If the value is not specified, it is set to 20. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPrice +Specifies the maximum price you are willing to pay for a low priority VM/VMSS. This price is in US Dollars. This price will be compared with the current low priority price for the VM size. Also, the prices are compared at the time of create/update of low priority VM/VMSS and the operation will only succeed if the maxPrice is greater than the current low priority price. The maxPrice will also be used for evicting a low priority VM/VMSS if the current low priority price goes beyond the maxPrice after creation of VM/VMSS. Possible values are: any decimal value greater than zero. Example: 0.01538. -1 indicates that the low priority VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxUnhealthyInstancePercent +The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. +This constraint will be checked prior to starting any batch. +If the value is not specified, it is set to 20. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxUnhealthyUpgradedInstancePercent +The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. +This check will happen after each batch is upgraded. +If this percentage is ever exceeded, the rolling update aborts. +If the value is not specified, it is set to 20. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsDiskCaching +Specifies the caching mode of the operating system disk. +The acceptable values for this parameter are: +- None +- ReadOnly +- ReadWrite +The default value is ReadWrite. +If you change the caching value, the cmdlet will restart the virtual machine. +This setting affects the consistency and performance of the disk. + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.CachingTypes +Parameter Sets: (All) +Aliases: +Accepted values: None, ReadOnly, ReadWrite + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsDiskWriteAccelerator +Specifies whether WriteAccelerator should be enabled or disabled on the OS disk. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSImageScheduledEventEnabled +Specifies whether the OS Image Scheduled event is enabled or disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSImageScheduledEventNotBeforeTimeoutInMinutes +The length of time a virtual machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, with the value set to 15 minutes (PT15M). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overprovision +Indicates whether the cmdlet overprovisions the VMSS. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PauseTimeBetweenBatches +The wait time between completing the update for all virtual machines in one batch and starting the next batch. +The time duration should be specified in ISO 8601 format. +The default value is 0 seconds (PT0S). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanName +Specifies the plan name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanProduct +Specifies the plan product. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanPromotionCode +Specifies the plan promotion code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanPublisher +Specifies the plan publisher. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisionVMAgent +Indicates whether virtual machine agent should be provisioned on the Windows virtual machines in the VMSS. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProximityPlacementGroupId +The resource id of the Proximity Placement Group to use with this scale set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegularPriorityPercentage +Specifies the desired percentage of VMs, after the BaseRegularCount has been met, that are of Regular priority as the VMSS Flex instance scales out. This property is only valid for VMSS instances with Flexible OrchestrationMode. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group the VMSS belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScaleInPolicy +The rules to be followed when scaling-in a virtual machine scale set. Possible values are: 'Default', 'OldestVM' and 'NewestVM'. 'Default' when a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. 'OldestVM' when a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. 'NewestVM' when a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleInPolicyForceDeletion +Applying Force Deletion when using ScaleIn Policy. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedGalleryImageId +Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SinglePlacementGroup +Specifies the single placement group. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipExtensionsOnOverprovisionedVMs +Specifies that the extensions do not run on the extra overprovisioned VMs. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Specifies the number of instances in the VMSS. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Specifies the size of all the instances of VMSS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +Specifies the tier of VMSS. +The acceptable values for this parameter are: +- Standard +- Basic + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TerminateScheduledEventNotBeforeTimeoutInMinutes +Configurable length of time (in minutes) a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TerminateScheduledEvents +Specifies whether the Terminate Scheduled event is enabled or disabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TimeZone +Specifies the time zone for Windows OS. e.g. \"Pacific Standard Time\". <br> +Possible values can be [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UltraSSDEnabled +The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the virtual machine scale set. +Managed disks with storage account type UltraSSD_LRS can be added to a VMSS only if this property is enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UpgradePolicyMode +Specified the mode of an upgrade to virtual machines in the scale set. +The acceptable values for this parameter are: +- Automatic +- Manual +- Rolling + +```yaml +Type: Microsoft.Azure.Management.Compute.Models.UpgradeMode +Parameter Sets: (All) +Aliases: +Accepted values: Automatic, Manual, Rolling + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserData +UserData for the Vmss, which will be base-64 encoded. Customer should not pass any secrets in here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VhdContainer +Specifies the container URLs that are used to store operating system disks for the VMSS. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSet +Specifies a local VMSS object. +To obtain a VMSS object, use the Get-AzVmss cmdlet. +This virtual machine object contains the updated state for the VMSS. + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMScaleSetName +Specifies the name of the VMSS that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet + +## NOTES + +## RELATED LINKS + +[Get-AzVmss](./Get-AzVmss.md) + +[New-AzVmss](./New-AzVmss.md) + +[Remove-AzVmss](./Remove-AzVmss.md) + +[Restart-AzVmss](./Restart-AzVmss.md) + +[Set-AzVmss](./Set-AzVmss.md) + +[Start-AzVmss](./Start-AzVmss.md) + +[Stop-AzVmss](./Stop-AzVmss.md) + + diff --git a/azps-10.1.0/Az.Compute/Update-AzVmssInstance.md b/azps-10.1.0/Az.Compute/Update-AzVmssInstance.md new file mode 100644 index 0000000000..b845edac4d --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzVmssInstance.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +ms.assetid: E8C9D68E-7C68-43D0-B348-72E9713CB99F +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azvmssinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzVmssInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzVmssInstance.md +--- + +# Update-AzVmssInstance + +## SYNOPSIS +Starts a manual upgrade of the VMSS instance. + +## SYNTAX + +``` +Update-AzVmssInstance [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String[]> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Update-AzVmssInstance cmdlet starts a manual upgrade of the specified Virtual Machine Scale Set (VMSS) instance. +This is used when the upgrade policy on the VMSS Scale Set is set to manual. + +## EXAMPLES + +### Example 1: Start an upgrade of the VMSS instance +```powershell +Update-AzVmssInstance -ResourceGroupName "Group011" -VMScaleSetName "VMScaleSet001" -InstanceId "0" +``` + +This command starts an upgrade of the VMSS named VMScaleSet001 that has the instance ID of 0. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceId +Specifies, as a string array, the ID or IDs of the instance to upgrade. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the VMSS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VMScaleSetName +Specifies the name of the VMSS instance that this cmdlet upgrades. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse + +## NOTES + +## RELATED LINKS + +[Update-AzVmss](./Update-AzVmss.md) + + diff --git a/azps-10.1.0/Az.Compute/Update-AzVmssVM.md b/azps-10.1.0/Az.Compute/Update-AzVmssVM.md new file mode 100644 index 0000000000..cb9f810cdc --- /dev/null +++ b/azps-10.1.0/Az.Compute/Update-AzVmssVM.md @@ -0,0 +1,295 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml +Module Name: Az.Compute +online version: https://learn.microsoft.com/powershell/module/az.compute/update-azvmssvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzVmssVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Compute/Compute/help/Update-AzVmssVM.md +--- + +# Update-AzVmssVM + +## SYNOPSIS +Updates the state of a Vmss VM. + +## SYNTAX + +### DefaultParameter (Default) +``` +Update-AzVmssVM [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> + [-DataDisk <PSVirtualMachineDataDisk[]>] [-ProtectFromScaleIn <Boolean>] + [-ProtectFromScaleSetAction <Boolean>] [-AsJob] [-UserData <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameter +``` +Update-AzVmssVM [-DataDisk <PSVirtualMachineDataDisk[]>] [-ProtectFromScaleIn <Boolean>] + [-ProtectFromScaleSetAction <Boolean>] [-ResourceId] <String> [-AsJob] [-UserData <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameter +``` +Update-AzVmssVM [-DataDisk <PSVirtualMachineDataDisk[]>] [-ProtectFromScaleIn <Boolean>] + [-ProtectFromScaleSetAction <Boolean>] [-VirtualMachineScaleSetVM] <PSVirtualMachineScaleSetVM> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the state of a Vmss VM. For now, the only allowed update is adding a managed data disk. + +## EXAMPLES + +### Example 1: Add a managed data disk to a Vmss VM using New-AzVMDataDisk +```powershell +$disk = Get-AzDisk -ResourceGroupName $rgname -DiskName $diskname0 +$datadisk = New-AzVMDataDisk -Caching 'ReadOnly' -Lun 2 -CreateOption Attach -StorageAccountType Standard_LRS -ManagedDiskId $disk.Id +$VmssVM = Get-AzVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 +Update-AzVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 -DataDisk $datadisk +``` + +The first command gets an existing managed disk. +The next command creates a data disk object with the managed disk. +The next command gets an existing Vmss VM given by the resource group name, the vmss name and the instance ID. +The final command updates the Vmss VM by adding a new data disk. + +### Example 2: Add a managed data disk to a Vmss VM using Add-AzVMDataDisk +```powershell +$disk = Get-AzDisk -ResourceGroupName $rgname -DiskName $diskname0 +$VmssVM = Get-AzVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 +$VmssVM = Add-AzVMDataDisk -VM $VmssVM -Lun 0 -DiskSizeInGB 10 -CreateOption Attach -StorageAccountType Standard_LRS -ManagedDiskId $disk.Id +Update-AzVmssVM -VirtualMachineScaleSetVM $VmssVM +``` + +The first command gets an existing managed disk. +The next command gets an existing Vmss VM given by the resource group name, the vmss name and the instance ID. +The next command adds the managed disk to the Vmss VM stored locally in $VmssVM. +The final command updates the Vmss VM with added data disk. + +### Example 3 + +Updates the state of a Vmss VM. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Update-AzVmssVM -InstanceId 0 -ProtectFromScaleIn $false -ProtectFromScaleSetAction $false -ResourceGroupName 'myrg' -VMScaleSetName 'myvmss' +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataDisk + +```yaml +Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineDataDisk[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceId +Specifies the instance ID of a VMSS VM. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProtectFromScaleIn +Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectFromScaleSetAction +Indicates that model updates or actions (including scale-in) initiated on the VMSS should not be applied to the VMSS VM. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the Resource Group of the VMSS. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id for the virtual machine scale set VM + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserData +UserData for the Vmss Vm, which will be base-64 encoded. Customer should not pass any secrets in here. + +```yaml +Type: System.String +Parameter Sets: DefaultParameter, ResourceIdParameter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSetVM +Local virtual machine scale set VM object + +```yaml +Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM +Parameter Sets: ObjectParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMScaleSetName +The name of the virtual machine scale set + +```yaml +Type: System.String +Parameter Sets: DefaultParameter +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineDataDisk[] + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM + +## OUTPUTS + +### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ConfidentialLedger/Az.ConfidentialLedger.md b/azps-10.1.0/Az.ConfidentialLedger/Az.ConfidentialLedger.md new file mode 100644 index 0000000000..dace36a47b --- /dev/null +++ b/azps-10.1.0/Az.ConfidentialLedger/Az.ConfidentialLedger.md @@ -0,0 +1,36 @@ +--- +Module Name: Az.ConfidentialLedger +Module Guid: c7eaa9c1-72c4-4251-9e7d-bf9b8e8fa71e +Download Help Link: https://learn.microsoft.com/powershell/module/az.confidentialledger +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/Az.ConfidentialLedger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/Az.ConfidentialLedger.md +--- + +# Az.ConfidentialLedger Module +## Description +Microsoft Azure PowerShell: ConfidentialLedger cmdlets + +## Az.ConfidentialLedger Cmdlets +### [Get-AzConfidentialLedger](Get-AzConfidentialLedger.md) +Retrieves the properties of a Confidential Ledger. + +### [New-AzConfidentialLedger](New-AzConfidentialLedger.md) +Creates a Confidential Ledger with the specified ledger parameters. + +### [New-AzConfidentialLedgerAADBasedSecurityPrincipalObject](New-AzConfidentialLedgerAADBasedSecurityPrincipalObject.md) +Create an in-memory object for AADBasedSecurityPrincipal. + +### [New-AzConfidentialLedgerCertBasedSecurityPrincipalObject](New-AzConfidentialLedgerCertBasedSecurityPrincipalObject.md) +Create an in-memory object for CertBasedSecurityPrincipal. + +### [Remove-AzConfidentialLedger](Remove-AzConfidentialLedger.md) +Deletes an existing Confidential Ledger. + +### [Test-AzConfidentialLedgerNameAvailability](Test-AzConfidentialLedgerNameAvailability.md) +To check whether a resource name is available. + +### [Update-AzConfidentialLedger](Update-AzConfidentialLedger.md) +Updates properties of Confidential Ledger + diff --git a/azps-10.1.0/Az.ConfidentialLedger/Get-AzConfidentialLedger.md b/azps-10.1.0/Az.ConfidentialLedger/Get-AzConfidentialLedger.md new file mode 100644 index 0000000000..ec639a9b06 --- /dev/null +++ b/azps-10.1.0/Az.ConfidentialLedger/Get-AzConfidentialLedger.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.ConfidentialLedger +online version: https://learn.microsoft.com/powershell/module/az.confidentialledger/get-azconfidentialledger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/Get-AzConfidentialLedger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/Get-AzConfidentialLedger.md +--- + +# Get-AzConfidentialLedger + +## SYNOPSIS +Retrieves the properties of a Confidential Ledger. + +## SYNTAX + +### List1 (Default) +``` +Get-AzConfidentialLedger [-SubscriptionId <String[]>] [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzConfidentialLedger -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzConfidentialLedger -InputObject <IConfidentialLedgerIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzConfidentialLedger -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Filter <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the properties of a Confidential Ledger. + +## EXAMPLES + +### Example 1: List Confidential Ledgers +```powershell +Get-AzConfidentialLedger ` + -SubscriptionId 00000000-0000-0000-0000-000000000000 +``` + +```output +Location Name +eastus testledger0 +eastus testledger1 +eastus testledger2 +``` + +Lists all the Confidential Ledgers under a subscription. + +### Example 2: Get a Confidential Ledger +```powershell +Get-AzConfidentialLedger ` + -Name test-ledger ` + -ResourceGroupName test-rg +``` + +```output +Location Name +eastus test-ledger +``` + +Lists all the Confidential Ledgers under a resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply on the list operation. +eg. +$filter=ledgerType eq 'Public' + +```yaml +Type: System.String +Parameter Sets: List, List1 +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.ConfidentialLedger.Models.IConfidentialLedgerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Confidential Ledger + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: LedgerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.IConfidentialLedgerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.Api20220513.IConfidentialLedger + +## 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 `<IConfidentialLedgerIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[LedgerName <String>]`: Name of the Confidential Ledger + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConfidentialLedger/New-AzConfidentialLedger.md b/azps-10.1.0/Az.ConfidentialLedger/New-AzConfidentialLedger.md new file mode 100644 index 0000000000..b3f1cbf653 --- /dev/null +++ b/azps-10.1.0/Az.ConfidentialLedger/New-AzConfidentialLedger.md @@ -0,0 +1,317 @@ +--- +external help file: +Module Name: Az.ConfidentialLedger +online version: https://learn.microsoft.com/powershell/module/az.confidentialledger/new-azconfidentialledger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/New-AzConfidentialLedger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/New-AzConfidentialLedger.md +--- + +# New-AzConfidentialLedger + +## SYNOPSIS +Creates a Confidential Ledger with the specified ledger parameters. + +## SYNTAX + +``` +New-AzConfidentialLedger -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AadBasedSecurityPrincipal <IAadBasedSecurityPrincipal[]>] + [-CertBasedSecurityPrincipal <ICertBasedSecurityPrincipal[]>] [-LedgerType <LedgerType>] [-Location <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a Confidential Ledger with the specified ledger parameters. + +## EXAMPLES + +### Example 1: Create a new Confidential Ledger +```powershell +New-AzConfidentialLedger ` + -Name test-ledger ` + -ResourceGroupName rg-000 ` + -SubscriptionId 00000000-0000-0000-0000-000000000000 ` + -AadBasedSecurityPrincipal ` + @{ + LedgerRoleName="Administrator"; + PrincipalId="34621747-6fc8-4771-a2eb-72f31c461f2e"; + TenantId="bce123b9-2b7b-4975-8360-5ca0b9b1cd08" + } ` + -CertBasedSecurityPrincipal ` + @{ + Cert="-----BEGIN CERTIFICATE-----********************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************-----END CERTIFICATE-----"; + LedgerRoleName="Reader" + } ` + -LedgerType Public ` + -Location eastus ` + -Tag @{Location="additional properties 0"} +``` + +```output +Location Name +eastus test-ledger +``` + +Creates a new Confidential Ledger. + +### Example 2: Create Using Security Principal Objects +```powershell +$aadSecurityPrincipal = New-AzConfidentialLedgerAadBasedSecurityPrincipalObject ` + -LedgerRoleName "Administrator" ` + -PrincipalId "34621747-6fc8-4771-a2eb-72f31c461f2e" ` + -TenantId "bce123b9-2b7b-4975-8360-5ca0b9b1cd08" + +$certSecurityPrincipal = New-AzConfidentialLedgerCertBasedSecurityPrincipalObject ` + -Cert "-----BEGIN CERTIFICATE-----********************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************-----END CERTIFICATE-----" ` + -LedgerRoleName "Reader" + +New-AzConfidentialLedger ` + -Name test-ledger ` + -ResourceGroupName rg-000 ` + -SubscriptionId 00000000-0000-0000-0000-000000000000 ` + -AadBasedSecurityPrincipal $aadSecurityPrincipal ` + -CertBasedSecurityPrincipal $certSecurityPrincipal ` + -LedgerType Public ` + -Location eastus ` + -Tag @{Location="additional properties 0"} +``` + +```output +Location Name +eastus test-ledger +``` + +Creates a new Confidential Ledger using objects for `AadBasedSecurityPrincipal` and `CertBasedSecurityPrincipal`. + +## PARAMETERS + +### -AadBasedSecurityPrincipal +Array of all AAD based Security Principals. +To construct, see NOTES section for AADBASEDSECURITYPRINCIPAL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.Api20220513.IAadBasedSecurityPrincipal[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertBasedSecurityPrincipal +Array of all cert based Security Principals. +To construct, see NOTES section for CERTBASEDSECURITYPRINCIPAL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.Api20220513.ICertBasedSecurityPrincipal[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LedgerType +Type of Confidential Ledger + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Support.LedgerType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The Azure location where the Confidential Ledger is running. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Confidential Ledger + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LedgerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Additional tags for Confidential Ledger + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.Api20220513.IConfidentialLedger + +## 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. + + +AADBASEDSECURITYPRINCIPAL <IAadBasedSecurityPrincipal[]>: Array of all AAD based Security Principals. + - `[LedgerRoleName <LedgerRoleName?>]`: LedgerRole associated with the Security Principal of Ledger + - `[PrincipalId <String>]`: UUID/GUID based Principal Id of the Security Principal + - `[TenantId <String>]`: UUID/GUID based Tenant Id of the Security Principal + +CERTBASEDSECURITYPRINCIPAL <ICertBasedSecurityPrincipal[]>: Array of all cert based Security Principals. + - `[Cert <String>]`: Public key of the user cert (.pem or .cer) + - `[LedgerRoleName <LedgerRoleName?>]`: LedgerRole associated with the Security Principal of Ledger + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConfidentialLedger/New-AzConfidentialLedgerAADBasedSecurityPrincipalObject.md b/azps-10.1.0/Az.ConfidentialLedger/New-AzConfidentialLedgerAADBasedSecurityPrincipalObject.md new file mode 100644 index 0000000000..19a36ab035 --- /dev/null +++ b/azps-10.1.0/Az.ConfidentialLedger/New-AzConfidentialLedgerAADBasedSecurityPrincipalObject.md @@ -0,0 +1,104 @@ +--- +external help file: +Module Name: Az.ConfidentialLedger +online version: https://learn.microsoft.com/powershell/module/az.ConfidentialLedger/new-AzConfidentialLedgerAADBasedSecurityPrincipalObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/New-AzConfidentialLedgerAADBasedSecurityPrincipalObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/New-AzConfidentialLedgerAADBasedSecurityPrincipalObject.md +--- + +# New-AzConfidentialLedgerAADBasedSecurityPrincipalObject + +## SYNOPSIS +Create an in-memory object for AADBasedSecurityPrincipal. + +## SYNTAX + +``` +New-AzConfidentialLedgerAADBasedSecurityPrincipalObject [-LedgerRoleName <LedgerRoleName>] + [-PrincipalId <String>] [-TenantId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AADBasedSecurityPrincipal. + +## EXAMPLES + +### Example 1: Object creation +```powershell +New-AzConfidentialLedgerAadBasedSecurityPrincipalObject ` + -LedgerRoleName "Administrator" ` + -PrincipalId "34621747-6fc8-4771-a2eb-72f31c461f2e" ` + -TenantId "bce123b9-2b7b-4975-8360-5ca0b9b1cd08" +``` + +```output +LedgerRoleName PrincipalId TenantId +-------------- ----------- -------- +Administrator 34621747-6fc8-4771-a2eb-72f31c461f2e bce123b9-2b7b-4975-8360-5ca0b9b1cd08 +``` + +Creates an AadBasedSecurityPrincipalObject that may be used for `Az.ConfidentialLedger` commands. + +## PARAMETERS + +### -LedgerRoleName +LedgerRole associated with the Security Principal of Ledger. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Support.LedgerRoleName +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalId +UUID/GUID based Principal Id of the Security Principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +UUID/GUID based Tenant Id of the Security Principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.Api20220513.AadBasedSecurityPrincipal + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConfidentialLedger/New-AzConfidentialLedgerCertBasedSecurityPrincipalObject.md b/azps-10.1.0/Az.ConfidentialLedger/New-AzConfidentialLedgerCertBasedSecurityPrincipalObject.md new file mode 100644 index 0000000000..a5ef25de8e --- /dev/null +++ b/azps-10.1.0/Az.ConfidentialLedger/New-AzConfidentialLedgerCertBasedSecurityPrincipalObject.md @@ -0,0 +1,88 @@ +--- +external help file: +Module Name: Az.ConfidentialLedger +online version: https://learn.microsoft.com/powershell/module/az.ConfidentialLedger/new-AzConfidentialLedgerCertBasedSecurityPrincipalObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/New-AzConfidentialLedgerCertBasedSecurityPrincipalObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/New-AzConfidentialLedgerCertBasedSecurityPrincipalObject.md +--- + +# New-AzConfidentialLedgerCertBasedSecurityPrincipalObject + +## SYNOPSIS +Create an in-memory object for CertBasedSecurityPrincipal. + +## SYNTAX + +``` +New-AzConfidentialLedgerCertBasedSecurityPrincipalObject [-Cert <String>] [-LedgerRoleName <LedgerRoleName>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for CertBasedSecurityPrincipal. + +## EXAMPLES + +### Example 1: Object creation +```powershell +New-AzConfidentialLedgerCertBasedSecurityPrincipalObject ` + -Cert "-----BEGIN CERTIFICATE-----********************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************-----END CERTIFICATE-----" ` + -LedgerRoleName "Reader" +``` + +```output +Cert +---- +-----BEGIN CERTIFICATE-----MIIBsjCCATigAwIBAgIUZWIbyG79TniQLd2UxJuU74tqrKcwCgYIKoZIzj0EAwMwEDEOMAwGA1UEAwwFdXNlcjAwHhc… +``` + +Creates an AadBasedSecurityPrincipalObject that may be used for `Az.ConfidentialLedger` commands. + +## PARAMETERS + +### -Cert +Public key of the user cert (.pem or .cer). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LedgerRoleName +LedgerRole associated with the Security Principal of Ledger. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Support.LedgerRoleName +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.Api20220513.CertBasedSecurityPrincipal + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConfidentialLedger/Remove-AzConfidentialLedger.md b/azps-10.1.0/Az.ConfidentialLedger/Remove-AzConfidentialLedger.md new file mode 100644 index 0000000000..b8756393f8 --- /dev/null +++ b/azps-10.1.0/Az.ConfidentialLedger/Remove-AzConfidentialLedger.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.ConfidentialLedger +online version: https://learn.microsoft.com/powershell/module/az.confidentialledger/remove-azconfidentialledger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/Remove-AzConfidentialLedger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/Remove-AzConfidentialLedger.md +--- + +# Remove-AzConfidentialLedger + +## SYNOPSIS +Deletes an existing Confidential Ledger. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzConfidentialLedger -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzConfidentialLedger -InputObject <IConfidentialLedgerIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing Confidential Ledger. + +## EXAMPLES + +### Example 1: Delete a Confidential Ledger +```powershell +Remove-AzConfidentialLedger ` + -Name test-ledger ` + -ResourceGroupName rg-000 +``` + +Deletes the specified Confidential Ledger. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.IConfidentialLedgerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Confidential Ledger + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: LedgerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.IConfidentialLedgerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IConfidentialLedgerIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[LedgerName <String>]`: Name of the Confidential Ledger + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConfidentialLedger/Test-AzConfidentialLedgerNameAvailability.md b/azps-10.1.0/Az.ConfidentialLedger/Test-AzConfidentialLedgerNameAvailability.md new file mode 100644 index 0000000000..c6b13545cf --- /dev/null +++ b/azps-10.1.0/Az.ConfidentialLedger/Test-AzConfidentialLedgerNameAvailability.md @@ -0,0 +1,170 @@ +--- +external help file: +Module Name: Az.ConfidentialLedger +online version: https://learn.microsoft.com/powershell/module/az.confidentialledger/test-azconfidentialledgernameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/Test-AzConfidentialLedgerNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/Test-AzConfidentialLedgerNameAvailability.md +--- + +# Test-AzConfidentialLedgerNameAvailability + +## SYNOPSIS +To check whether a resource name is available. + +## SYNTAX + +``` +Test-AzConfidentialLedgerNameAvailability [-SubscriptionId <String>] [-Name <String>] [-Type <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +To check whether a resource name is available. + +## EXAMPLES + +### Example 1: Name is available +```powershell +Test-AzConfidentialLedgerNameAvailability ` + -Name "available-name" ` + -Type "Microsoft.ConfidentialLedger/ledgers" +``` + +```output +Message : +NameAvailable : True +Reason : +``` + +Checks to see if the specified Confidential Ledger name is available. +In this case, the name is available. +Confidential Ledger names must be globally unique. + +### Example 2: Name is not available +```powershell +Test-AzConfidentialLedgerNameAvailability ` + -Name "not-available-name" ` + -Type "Microsoft.ConfidentialLedger/ledgers" +``` + +```output +Message : Resource name already exists +NameAvailable : False +Reason : AlreadyExists +``` + +Checks to see if the specified Confidential Ledger name is available. +In this case, the name is not available. +Confidential Ledger names must be globally unique. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the resource for which availability needs to be checked. + +```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 Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.Api20.ICheckNameAvailabilityResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConfidentialLedger/Update-AzConfidentialLedger.md b/azps-10.1.0/Az.ConfidentialLedger/Update-AzConfidentialLedger.md new file mode 100644 index 0000000000..cbb2b78114 --- /dev/null +++ b/azps-10.1.0/Az.ConfidentialLedger/Update-AzConfidentialLedger.md @@ -0,0 +1,325 @@ +--- +external help file: +Module Name: Az.ConfidentialLedger +online version: https://learn.microsoft.com/powershell/module/az.confidentialledger/update-azconfidentialledger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/Update-AzConfidentialLedger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConfidentialLedger/help/Update-AzConfidentialLedger.md +--- + +# Update-AzConfidentialLedger + +## SYNOPSIS +Updates properties of Confidential Ledger + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzConfidentialLedger -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-AadBasedSecurityPrincipal <IAadBasedSecurityPrincipal[]>] + [-CertBasedSecurityPrincipal <ICertBasedSecurityPrincipal[]>] [-LedgerType <LedgerType>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzConfidentialLedger -InputObject <IConfidentialLedgerIdentity> -Location <String> + [-AadBasedSecurityPrincipal <IAadBasedSecurityPrincipal[]>] + [-CertBasedSecurityPrincipal <ICertBasedSecurityPrincipal[]>] [-LedgerType <LedgerType>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates properties of Confidential Ledger + +## EXAMPLES + +### Example 1: Update tags for a Confidential Ledger +```powershell +Update-AzConfidentialLedger ` + -Name test-ledger ` + -ResourceGroupName rg-000 ` + -SubscriptionId 00000000-0000-0000-0000-000000000000 ` + -AadBasedSecurityPrincipal ` + @{ + LedgerRoleName="Administrator"; + PrincipalId="34621747-6fc8-4771-a2eb-72f31c461f2e"; + TenantId="bce123b9-2b7b-4975-8360-5ca0b9b1cd08" + } ` + -CertBasedSecurityPrincipal ` + @{ + Cert="-----BEGIN CERTIFICATE-----********************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************-----END CERTIFICATE-----"; + LedgerRoleName="Reader" + } ` + -LedgerType Public ` + -Location eastus ` + -Tag ` + @{ + Location="additional properties 0" + NewTag="New tag" + } +``` + +```output +Location Name +eastus test-ledger +``` + +Updates metadata for an existing Confidential Ledger. + +## PARAMETERS + +### -AadBasedSecurityPrincipal +Array of all AAD based Security Principals. +To construct, see NOTES section for AADBASEDSECURITYPRINCIPAL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.Api20220513.IAadBasedSecurityPrincipal[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertBasedSecurityPrincipal +Array of all cert based Security Principals. +To construct, see NOTES section for CERTBASEDSECURITYPRINCIPAL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.Api20220513.ICertBasedSecurityPrincipal[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.IConfidentialLedgerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LedgerType +Type of Confidential Ledger + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Support.LedgerType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The Azure location where the Confidential Ledger is running. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Confidential Ledger + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: LedgerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Additional tags for Confidential Ledger + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.IConfidentialLedgerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConfidentialLedger.Models.Api20220513.IConfidentialLedger + +## 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. + + +AADBASEDSECURITYPRINCIPAL <IAadBasedSecurityPrincipal[]>: Array of all AAD based Security Principals. + - `[LedgerRoleName <LedgerRoleName?>]`: LedgerRole associated with the Security Principal of Ledger + - `[PrincipalId <String>]`: UUID/GUID based Principal Id of the Security Principal + - `[TenantId <String>]`: UUID/GUID based Tenant Id of the Security Principal + +CERTBASEDSECURITYPRINCIPAL <ICertBasedSecurityPrincipal[]>: Array of all cert based Security Principals. + - `[Cert <String>]`: Public key of the user cert (.pem or .cer) + - `[LedgerRoleName <LedgerRoleName?>]`: LedgerRole associated with the Security Principal of Ledger + +INPUTOBJECT `<IConfidentialLedgerIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[LedgerName <String>]`: Name of the Confidential Ledger + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Confluent/Az.Confluent.md b/azps-10.1.0/Az.Confluent/Az.Confluent.md new file mode 100644 index 0000000000..494b82f1cd --- /dev/null +++ b/azps-10.1.0/Az.Confluent/Az.Confluent.md @@ -0,0 +1,30 @@ +--- +Module Name: Az.Confluent +Module Guid: 957f617c-6cbe-4ea3-b46c-ab3ae8eddb3c +Download Help Link: https://learn.microsoft.com/powershell/module/az.confluent +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Confluent/help/Az.Confluent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Confluent/help/Az.Confluent.md +--- + +# Az.Confluent Module +## Description +Microsoft Azure PowerShell: Confluent cmdlets + +## Az.Confluent Cmdlets +### [Get-AzConfluentMarketplaceAgreement](Get-AzConfluentMarketplaceAgreement.md) +List Confluent marketplace agreements in the subscription. + +### [Get-AzConfluentOrganization](Get-AzConfluentOrganization.md) +Get the properties of a specific Organization resource. + +### [New-AzConfluentOrganization](New-AzConfluentOrganization.md) +Create Organization resource + +### [Remove-AzConfluentOrganization](Remove-AzConfluentOrganization.md) +Delete Organization resource + +### [Update-AzConfluentOrganization](Update-AzConfluentOrganization.md) +Update Organization resource + diff --git a/azps-10.1.0/Az.Confluent/Get-AzConfluentMarketplaceAgreement.md b/azps-10.1.0/Az.Confluent/Get-AzConfluentMarketplaceAgreement.md new file mode 100644 index 0000000000..dcb98a773c --- /dev/null +++ b/azps-10.1.0/Az.Confluent/Get-AzConfluentMarketplaceAgreement.md @@ -0,0 +1,87 @@ +--- +external help file: +Module Name: Az.Confluent +online version: https://learn.microsoft.com/powershell/module/az.confluent/get-azconfluentmarketplaceagreement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Confluent/help/Get-AzConfluentMarketplaceAgreement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Confluent/help/Get-AzConfluentMarketplaceAgreement.md +--- + +# Get-AzConfluentMarketplaceAgreement + +## SYNOPSIS +List Confluent marketplace agreements in the subscription. + +## SYNTAX + +``` +Get-AzConfluentMarketplaceAgreement [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +List Confluent marketplace agreements in the subscription. + +## EXAMPLES + +### Example 1: List all confluent marketplace agreement under a subscription +```powershell +Get-AzConfluentMarketplaceAgreement +``` + +```output +Name Type +---- ---- +marketplace Microsoft.Confluent/agreements +confluent Microsoft.Confluent/offertypes +``` + +This command lists all confluent marketplace agreement under a subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Microsoft Azure subscription id + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Confluent.Models.Api20200301.IConfluentAgreementResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Confluent/Get-AzConfluentOrganization.md b/azps-10.1.0/Az.Confluent/Get-AzConfluentOrganization.md new file mode 100644 index 0000000000..e3d082a4a4 --- /dev/null +++ b/azps-10.1.0/Az.Confluent/Get-AzConfluentOrganization.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.Confluent +online version: https://learn.microsoft.com/powershell/module/az.confluent/get-azconfluentorganization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Confluent/help/Get-AzConfluentOrganization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Confluent/help/Get-AzConfluentOrganization.md +--- + +# Get-AzConfluentOrganization + +## SYNOPSIS +Get the properties of a specific Organization resource. + +## SYNTAX + +### List (Default) +``` +Get-AzConfluentOrganization [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzConfluentOrganization -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzConfluentOrganization -InputObject <IConfluentIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzConfluentOrganization -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the properties of a specific Organization resource. + +## EXAMPLES + +### Example 1: List all confluent organizations under a subscription +```powershell +Get-AzConfluentOrganization +``` + +```output +Location Name Type +-------- ---- ---- +westus2 RegionTestWestUS2 Microsoft.Confluent/organizations +westus2 RohitWUS2 Microsoft.Confluent/organizations +westus2 Rohit-Secret Microsoft.Confluent/organizations +westus2 Rohit-Secret-2 Microsoft.Confluent/organizations +westus2 Rohit-Secret-WUS2-0 Microsoft.Confluent/organizations +westus2 RohitWus200 Microsoft.Confluent/organizations +westus2 RohitWUS300 Microsoft.Confluent/organizations +westus2 WestUS2-SSOTest Microsoft.Confluent/organizations +westus2 dri-01-02-postman-stable Microsoft.Confluent/organizations +westus2 dri-02-02 Microsoft.Confluent/organizations +westcentralus RohitWCUS88 Microsoft.Confluent/organizations +``` + +This command lists all confluent organizations under a subscription. + +### Example 2: List all confluent organizations under a resource group +```powershell +Get-AzConfluentOrganization -ResourceGroupName azure-rg-test +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap ppe-metrics-2 Microsoft.Confluent/organizations +``` + +This command lists all confluent organizations under a resource group. + +### Example 3: Get a confluent organization by name +```powershell +Get-AzConfluentOrganization -ResourceGroupName azure-rg-test -Name confluentorg-01-portal +``` + +```output +Location Name Type +-------- ---- ---- +eastus confluentorg-01-portal Microsoft.Confluent/organizations +``` + +This command gets a confluent organization by name. + +### Example 4: Get a confluent organization by pipeline +```powershell +New-AzConfluentOrganization -ResourceGroupName azure-rg-test -Name confluentorg-02-pwsh -Location eastus -OfferDetailId "confluent-cloud-azure-prod" -OfferDetailPlanId "confluent-cloud-azure-payg-prod" -OfferDetailPlanName "Confluent Cloud - Pay as you Go" -OfferDetailPublisherId "confluentinc" -OfferDetailTermUnit "P1M" | Get-AzConfluentOrganization +``` + +```output +Location Name Type +-------- ---- ---- +eastus confluentorg-02-pwsh Microsoft.Confluent/organizations +``` + +This command gets a confluent organization by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Confluent.Models.IConfluentIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Organization resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: OrganizationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Microsoft Azure subscription id + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Confluent.Models.IConfluentIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Confluent.Models.Api20200301.IOrganizationResource + +## 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 `<IConfluentIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[OrganizationName <String>]`: Organization resource name + - `[ResourceGroupName <String>]`: Resource group name + - `[SubscriptionId <String>]`: Microsoft Azure subscription id + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Confluent/New-AzConfluentOrganization.md b/azps-10.1.0/Az.Confluent/New-AzConfluentOrganization.md new file mode 100644 index 0000000000..0ae7b9e7ec --- /dev/null +++ b/azps-10.1.0/Az.Confluent/New-AzConfluentOrganization.md @@ -0,0 +1,330 @@ +--- +external help file: +Module Name: Az.Confluent +online version: https://learn.microsoft.com/powershell/module/az.confluent/new-azconfluentorganization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Confluent/help/New-AzConfluentOrganization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Confluent/help/New-AzConfluentOrganization.md +--- + +# New-AzConfluentOrganization + +## SYNOPSIS +Create Organization resource + +## SYNTAX + +``` +New-AzConfluentOrganization -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Location <String>] [-OfferDetailId <String>] [-OfferDetailPlanId <String>] [-OfferDetailPlanName <String>] + [-OfferDetailPublisherId <String>] [-OfferDetailTermUnit <String>] [-Tag <Hashtable>] + [-UserDetailEmailAddress <String>] [-UserDetailFirstName <String>] [-UserDetailLastName <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create Organization resource + +## EXAMPLES + +### Example 1: Create a confluent organization +```powershell +New-AzConfluentOrganization -ResourceGroupName azure-rg-test -Name confluentorg-02-pwsh -Location eastus -OfferDetailId "confluent-cloud-azure-prod" -OfferDetailPlanId "confluent-cloud-azure-payg-prod" -OfferDetailPlanName "Confluent Cloud - Pay as you Go" -OfferDetailPublisherId "confluentinc" -OfferDetailTermUnit "P1M" -UserDetailEmailAddress "xxxx@microsoft.com" +``` + +```output +Location Name Type +-------- ---- ---- +eastus confluentorg-02-pwsh Microsoft.Confluent/organizations +``` + +This command creates a confluent organization. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of Organization resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Organization resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: OrganizationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailId +Offer Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanId +Offer Plan Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanName +Offer Plan Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPublisherId +Publisher Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailTermUnit +Offer Plan Term unit + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Microsoft Azure subscription id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Organization resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserDetailEmailAddress +Email address + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserDetailFirstName +First name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserDetailLastName +Last name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Confluent.Models.Api20200301.IOrganizationResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Confluent/Remove-AzConfluentOrganization.md b/azps-10.1.0/Az.Confluent/Remove-AzConfluentOrganization.md new file mode 100644 index 0000000000..a7c1e24620 --- /dev/null +++ b/azps-10.1.0/Az.Confluent/Remove-AzConfluentOrganization.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.Confluent +online version: https://learn.microsoft.com/powershell/module/az.confluent/remove-azconfluentorganization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Confluent/help/Remove-AzConfluentOrganization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Confluent/help/Remove-AzConfluentOrganization.md +--- + +# Remove-AzConfluentOrganization + +## SYNOPSIS +Delete Organization resource + +## SYNTAX + +### Delete (Default) +``` +Remove-AzConfluentOrganization -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzConfluentOrganization -InputObject <IConfluentIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete Organization resource + +## EXAMPLES + +### Example 1: Remove a confluent organization by name +```powershell +Remove-AzConfluentOrganization -ResourceGroupName azure-rg-test -Name confluentorg-01-portal +``` + +```output +- This action cannot be undone. +- This will permanently delete ‘<resource_name>’ and its Azure subscription +- Stop billing for the selected Confluent organization through Azure Marketplace +Do you want to proceed (Y/N)?: y +``` + +This command removes a confluent organization by name + +### Example 2: Remove a confluent organization by pipeline +```powershell +Get-AzConfluentOrganization -ResourceGroupName azure-rg-test -Name confluentorg-02-pwsh | Remove-AzConfluentOrganization +``` + +```output +- This action cannot be undone. +- This will permanently delete ‘<resource_name>’ and its Azure subscription +- Stop billing for the selected Confluent organization through Azure Marketplace +Do you want to proceed (Y/N)?: y +``` + +This command removes a confluent organization by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Confluent.Models.IConfluentIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Organization resource name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: OrganizationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Microsoft Azure subscription id + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Confluent.Models.IConfluentIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IConfluentIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[OrganizationName <String>]`: Organization resource name + - `[ResourceGroupName <String>]`: Resource group name + - `[SubscriptionId <String>]`: Microsoft Azure subscription id + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Confluent/Update-AzConfluentOrganization.md b/azps-10.1.0/Az.Confluent/Update-AzConfluentOrganization.md new file mode 100644 index 0000000000..800a7c61a4 --- /dev/null +++ b/azps-10.1.0/Az.Confluent/Update-AzConfluentOrganization.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: Az.Confluent +online version: https://learn.microsoft.com/powershell/module/az.confluent/update-azconfluentorganization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Confluent/help/Update-AzConfluentOrganization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Confluent/help/Update-AzConfluentOrganization.md +--- + +# Update-AzConfluentOrganization + +## SYNOPSIS +Update Organization resource + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzConfluentOrganization -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzConfluentOrganization -InputObject <IConfluentIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update Organization resource + +## EXAMPLES + +### Example 1: Update a confluent organization by name +```powershell +Update-AzConfluentOrganization -ResourceGroupName azure-rg-test -Name confluentorg-02-pwsh -Tag @{"key01" = "value01"} +``` + +```output +Location Name Type +-------- ---- ---- +eastus confluentorg-02-pwsh Microsoft.Confluent/organizations +``` + +This command updates a confluent organization by name. + +### Example 2: Update a confluent organization by pipeline +```powershell +Get-AzConfluentOrganization -ResourceGroupName azure-rg-test -Name confluentorg-02-pwsh | Update-AzConfluentOrganization -Tag @{"key01" = "value01"; "key02"="value02"} +``` + +```output +Location Name Type +-------- ---- ---- +eastus confluentorg-02-pwsh Microsoft.Confluent/organizations +``` + +This command updates a confluent organization by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Confluent.Models.IConfluentIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Organization resource name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: OrganizationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Microsoft Azure subscription id + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +ARM resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Confluent.Models.IConfluentIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Confluent.Models.Api20200301.IOrganizationResource + +## 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 `<IConfluentIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[OrganizationName <String>]`: Organization resource name + - `[ResourceGroupName <String>]`: Resource group name + - `[SubscriptionId <String>]`: Microsoft Azure subscription id + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedKubernetes/Az.ConnectedKubernetes.md b/azps-10.1.0/Az.ConnectedKubernetes/Az.ConnectedKubernetes.md new file mode 100644 index 0000000000..ac9a207d52 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedKubernetes/Az.ConnectedKubernetes.md @@ -0,0 +1,30 @@ +--- +Module Name: Az.ConnectedKubernetes +Module Guid: 59df8ab1-442a-41ae-9b55-60b505bae789 +Download Help Link: https://learn.microsoft.com/powershell/module/az.connectedkubernetes +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedKubernetes/help/Az.ConnectedKubernetes.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedKubernetes/help/Az.ConnectedKubernetes.md +--- + +# Az.ConnectedKubernetes Module +## Description +Microsoft Azure PowerShell: ConnectedKubernetes cmdlets + +## Az.ConnectedKubernetes Cmdlets +### [Get-AzConnectedKubernetes](Get-AzConnectedKubernetes.md) +Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details. + +### [Get-AzConnectedKubernetesUserCredential](Get-AzConnectedKubernetesUserCredential.md) +Gets cluster user credentials of the connected cluster with a specified resource group and name. + +### [New-AzConnectedKubernetes](New-AzConnectedKubernetes.md) +API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM). + +### [Remove-AzConnectedKubernetes](Remove-AzConnectedKubernetes.md) +Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM). + +### [Update-AzConnectedKubernetes](Update-AzConnectedKubernetes.md) +API to update certain properties of the connected cluster resource + diff --git a/azps-10.1.0/Az.ConnectedKubernetes/Get-AzConnectedKubernetes.md b/azps-10.1.0/Az.ConnectedKubernetes/Get-AzConnectedKubernetes.md new file mode 100644 index 0000000000..5436da216c --- /dev/null +++ b/azps-10.1.0/Az.ConnectedKubernetes/Get-AzConnectedKubernetes.md @@ -0,0 +1,206 @@ +--- +external help file: +Module Name: Az.ConnectedKubernetes +online version: https://learn.microsoft.com/powershell/module/az.connectedkubernetes/get-azconnectedkubernetes +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedKubernetes/help/Get-AzConnectedKubernetes.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedKubernetes/help/Get-AzConnectedKubernetes.md +--- + +# Get-AzConnectedKubernetes + +## SYNOPSIS +Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details. + +## SYNTAX + +### List1 (Default) +``` +Get-AzConnectedKubernetes [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzConnectedKubernetes -ClusterName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzConnectedKubernetes -InputObject <IConnectedKubernetesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzConnectedKubernetes -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details. + +## EXAMPLES + +### Example 1: Get all connected kubernetes under a subscription. +```powershell +Get-AzConnectedKubernetes +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster azps_test_group +eastus azps_test_cluster_ahb azps_test_group +``` + +This command gets all connected kubernetes under a subscription. + +### Example 2: Get all connected kubernetes under the resource group. +```powershell +Get-AzConnectedKubernetes -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster azps_test_group +eastus azps_test_cluster_ahb azps_test_group +``` + +This command gets all connected kubernetes under the resource group. + +### Example 3: Get a connected kubernetes. +```powershell +Get-AzConnectedKubernetes -ResourceGroupName azps_test_group -Name azps_test_cluster +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster azps_test_group +``` + +This command gets a connected kubernetes. + +### Example 4: Get a connected kubernetes by object. +```powershell +$conAks = Get-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group +Get-AzConnectedKubernetes -InputObject $conAks +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster_ahb azps_test_group +``` + +This command gets a connected kubernetes by object. + +## PARAMETERS + +### -ClusterName +The name of the Kubernetes cluster on which get is called. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IConnectedCluster + +## 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 <IConnectedKubernetesIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the Kubernetes cluster on which get is called. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedKubernetes/Get-AzConnectedKubernetesUserCredential.md b/azps-10.1.0/Az.ConnectedKubernetes/Get-AzConnectedKubernetesUserCredential.md new file mode 100644 index 0000000000..abb5111176 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedKubernetes/Get-AzConnectedKubernetesUserCredential.md @@ -0,0 +1,237 @@ +--- +external help file: +Module Name: Az.ConnectedKubernetes +online version: https://learn.microsoft.com/powershell/module/az.connectedkubernetes/get-azconnectedkubernetesusercredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedKubernetes/help/Get-AzConnectedKubernetesUserCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedKubernetes/help/Get-AzConnectedKubernetesUserCredential.md +--- + +# Get-AzConnectedKubernetesUserCredential + +## SYNOPSIS +Gets cluster user credentials of the connected cluster with a specified resource group and name. + +## SYNTAX + +### ListExpanded (Default) +``` +Get-AzConnectedKubernetesUserCredential -ClusterName <String> -ResourceGroupName <String> + -AuthenticationMethod <AuthenticationMethod> -ClientProxy [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### List +``` +Get-AzConnectedKubernetesUserCredential -ClusterName <String> -ResourceGroupName <String> + -Property <IListClusterUserCredentialProperties> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Gets cluster user credentials of the connected cluster with a specified resource group and name. + +## EXAMPLES + +### Example 1: Gets cluster user credentials of the connected cluster with a specified resource group and name. +```powershell +Get-AzConnectedKubernetesUserCredential -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -AuthenticationMethod AAD -ClientProxy +``` + +```output +HybridConnectionConfigExpirationTime : 1635508790 +HybridConnectionConfigHybridConnectionName : microsoft.kubernetes/connectedclusters/8d3bccced1f3ad1d0e01b03e87d1c8f8a312df7ff028e642512a7999542e46fc/1635497990523092736 +HybridConnectionConfigRelay : azgnrelay-eastus-l1 +HybridConnectionConfigToken : SharedAccessSignature sr=http%3A%2F%2Fazgnrelay-eastus-l1.servicebus.windows.net%2Fmicrosoft.kubernetes%2Fconnectedclusters%2F8d3bccced1f3ad1d0e01b03e87d1c8f8a312df7ff028e642512a7999542e46fc%2F1635497990523092736%2F&sig=wrukC6KAxVFb%2FmsdaTwSv3ChHo0hvTWjf5A80IZs2P4%3D&se=1635509390&skn=sender20211026 +Kubeconfig : {{ + "name": "KubeConfig", + "value": "YXBpVm***G9wDQo=" + }} +``` + +Gets cluster user credentials of the connected cluster with a specified resource group and name. + +### Example 2: Gets cluster user credentials of the connected cluster with a specified resource group and name. +```powershell +Get-AzConnectedKubernetesUserCredential -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -AuthenticationMethod Token -ClientProxy:$false +``` + +```output +HybridConnectionConfigExpirationTime : +HybridConnectionConfigHybridConnectionName : +HybridConnectionConfigRelay : +HybridConnectionConfigToken : +Kubeconfig : {{ + "name": "KubeConfig", + "value": "YXBpVm***G9wDQo=" + }} +``` + +Gets cluster user credentials of the connected cluster with a specified resource group and name. + +## PARAMETERS + +### -AuthenticationMethod +The mode of client authentication. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AuthenticationMethod +Parameter Sets: ListExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientProxy +Boolean value to indicate whether the request is for client side proxy or not + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ListExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kubernetes cluster on which get is called. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +. +To construct, see NOTES section for PROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IListClusterUserCredentialProperties +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IListClusterUserCredentialProperties + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.ICredentialResults + +## 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 <IListClusterUserCredentialProperties>`: . + - `AuthenticationMethod <AuthenticationMethod>`: The mode of client authentication. + - `ClientProxy <Boolean>`: Boolean value to indicate whether the request is for client side proxy or not + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedKubernetes/New-AzConnectedKubernetes.md b/azps-10.1.0/Az.ConnectedKubernetes/New-AzConnectedKubernetes.md new file mode 100644 index 0000000000..f1d3be1e21 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedKubernetes/New-AzConnectedKubernetes.md @@ -0,0 +1,565 @@ +--- +external help file: +Module Name: Az.ConnectedKubernetes +online version: https://learn.microsoft.com/powershell/module/az.connectedkubernetes/new-azconnectedkubernetes +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedKubernetes/help/New-AzConnectedKubernetes.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedKubernetes/help/New-AzConnectedKubernetes.md +--- + +# New-AzConnectedKubernetes + +## SYNOPSIS +API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM). + +## SYNTAX + +``` +New-AzConnectedKubernetes -ClusterName <String> -ResourceGroupName <String> -Location <String> + [-ContainerLogPath <String>] [-DisableAutoUpgrade] [-HttpProxy <Uri>] [-HttpsProxy <Uri>] [-NoProxy <String>] + [-OnboardingTimeout <Int32>] [-ProxyCert <String>] [-SubscriptionId <String>] [-AcceptEULA] + [-AzureHybridBenefit <AzureHybridBenefit>] [-Distribution <String>] [-DistributionVersion <String>] + [-Infrastructure <String>] [-KubeConfig <String>] [-KubeContext <String>] + [-PrivateLinkScopeResourceId <String>] [-PrivateLinkState <PrivateLinkState>] + [-ProvisioningState <ProvisioningState>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +API to register a new Kubernetes cluster and create a tracked resource in Azure Resource Manager (ARM). + +## EXAMPLES + +### Example 1: Create a connected kubernetes. +```powershell +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster azps_test_group +``` + +This command creates a connected kubernetes. + +### Example 2: Create a connected kubernetes with parameters kubeConfig and kubeContext. +```powershell +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster azps_test_group +``` + +This command creates a connected kubernetes with parameters kubeConfig and kubeContext. + +### Example 3: Create a ConnectedKubernetes's AzureHybridBenefit. +```powershell +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -PrivateLinkState 'Enabled' -Distribution "AKS_Management" -DistributionVersion "1.0" -PrivateLinkScopeResourceId "/subscriptions/{subscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HybridCompute/privateLinkScopes/azps-privatelinkscope" -infrastructure "azure_stack_hci" -ProvisioningState 'Succeeded' -AzureHybridBenefit 'True' +``` + +```output +I confirm I have an eligible Windows Server license with Azure Hybrid Benefit to apply this benefit to AKS on Azure Stack HCI or Windows Server. Visit https://aka.ms/ahb-aks for details. +[Y] Yes [N] No (default is "N"): Y + +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster_ahb azps_test_group +``` + +Create a ConnectedKubernetes's AzureHybridBenefit. + +### Example 4: Using [-AcceptEULA] will default to your acceptance of the terms of our legal agreement and create a connected kubernetes. +```powershell +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -PrivateLinkState 'Enabled' -Distribution "AKS_Management" -DistributionVersion "1.0" -PrivateLinkScopeResourceId "/subscriptions/{subscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HybridCompute/privateLinkScopes/azps-privatelinkscope" -infrastructure "azure_stack_hci" -ProvisioningState 'Succeeded' -AzureHybridBenefit 'True' -AcceptEULA +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster_ahb azps_test_group +``` + +Using [-AcceptEULA] will default to your acceptance of the terms of our legal agreement and create a connected kubernetes. + +### Example 5: Create a connected kubernetes with parameters HttpProxy, HttpsProxy, NoProxy and Proxy. +```powershell +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-user:proxy-password@proxy-ip:port" +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster_ahb azps_test_group +``` + +This command creates a connected kubernetes with parameters HttpProxy, HttpsProxy, NoProxy and Proxy. + +### Example 6: Create a connected kubernetes with parameters HttpProxy, HttpsProxy, NoProxy, Proxy and ProxyCredential. +```powershell +$pwd = ConvertTo-SecureString "proxy-password" -AsPlainText -Force +$cred = New-Object System.Management.Automation.PSCredential ("proxy-user", $pwd) +New-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 -HttpProxy "http://proxy-user:proxy-password@proxy-ip:port" -HttpsProxy "http://proxy-user:proxy-password@proxy-ip:port" -NoProxy "localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.96.0.0/12,10.244.0.0/16,10.43.0.0/24,.svc" -Proxy "http://proxy-ip:port" -ProxyCredential $cred +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster_ahb azps_test_group +``` + +This command creates a connected kubernetes with parameters HttpProxy, HttpsProxy, NoProxy, Proxy and ProxyCredential. + +### Example 7: Create a connected kubernetes and disable auto upgrade of arc agents. +```powershell +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -DisableAutoUpgrade +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster azps_test_group +``` + +This command creates a connected kubernetes and disable auto upgrade of arc agents. + +### Example 8: Create a connected kubernetes with custom onboarding timeout. +```powershell +New-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -OnboardingTimeout 600 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster azps_test_group +``` + +This command creates a connected kubernetes with custom onboarding timeout. + +## PARAMETERS + +### -AcceptEULA +Accept EULA of ConnectedKubernetes, legal term will pop up without this parameter provided + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureHybridBenefit +Indicates whether Azure Hybrid Benefit is opted in + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kubernetes cluster on which get is called. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerLogPath +Override the default container log path to enable fluent-bit logging. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAutoUpgrade +Flag to disable auto upgrade of arc agents. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Distribution +The Kubernetes distribution running on this connected cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionVersion +The Kubernetes distribution version on this connected cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpProxy +The http URI of the proxy server for the kubernetes cluster 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 +``` + +### -HttpsProxy +The https URI of the proxy server for the kubernetes cluster 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 +``` + +### -Infrastructure +The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KubeConfig +Path to the kube config file + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KubeContext +Kubconfig context from current machine + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoProxy +The comma-separated list of hostnames that should be excluded from the proxy server for the kubernetes cluster to use + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnboardingTimeout +The time required (in seconds) for the arc-agent pods to be installed on the kubernetes cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkScopeResourceId +The resource id of the private link scope this connected cluster is assigned to, if any. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkState +Property which describes the state of private link on a connected cluster resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.PrivateLinkState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisioningState +Provisioning state of the connected cluster resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.ProvisioningState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCert +The path to the certificate file for proxy or custom Certificate Authority. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IConnectedCluster + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedKubernetes/Remove-AzConnectedKubernetes.md b/azps-10.1.0/Az.ConnectedKubernetes/Remove-AzConnectedKubernetes.md new file mode 100644 index 0000000000..e8181c194b --- /dev/null +++ b/azps-10.1.0/Az.ConnectedKubernetes/Remove-AzConnectedKubernetes.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.ConnectedKubernetes +online version: https://learn.microsoft.com/powershell/module/az.connectedkubernetes/remove-azconnectedkubernetes +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedKubernetes/help/Remove-AzConnectedKubernetes.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedKubernetes/help/Remove-AzConnectedKubernetes.md +--- + +# Remove-AzConnectedKubernetes + +## SYNOPSIS +Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM). + +## SYNTAX + +### Delete (Default) +``` +Remove-AzConnectedKubernetes -ClusterName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-KubeConfig <String>] [-KubeContext <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzConnectedKubernetes -InputObject <IConnectedKubernetesIdentity> [-KubeConfig <String>] + [-KubeContext <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM). + +## EXAMPLES + +### Example 1: Remove a connected kubernetes. +```powershell +Remove-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group +``` + +This command removes a connected kubernetes. + +### Example 2: Remove a connected kubernetes by object. +```powershell +Get-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group | Remove-AzConnectedKubernetes +``` + +This command removes a connected kubernetes by object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kubernetes cluster on which get is called. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KubeConfig +Path to the kube config file + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KubeContext +Kubconfig context from current machine + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IConnectedKubernetesIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the Kubernetes cluster on which get is called. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedKubernetes/Update-AzConnectedKubernetes.md b/azps-10.1.0/Az.ConnectedKubernetes/Update-AzConnectedKubernetes.md new file mode 100644 index 0000000000..3cd04f8f19 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedKubernetes/Update-AzConnectedKubernetes.md @@ -0,0 +1,304 @@ +--- +external help file: +Module Name: Az.ConnectedKubernetes +online version: https://learn.microsoft.com/powershell/module/az.connectedkubernetes/update-azconnectedkubernetes +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedKubernetes/help/Update-AzConnectedKubernetes.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedKubernetes/help/Update-AzConnectedKubernetes.md +--- + +# Update-AzConnectedKubernetes + +## SYNOPSIS +API to update certain properties of the connected cluster resource + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzConnectedKubernetes -ClusterName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AcceptEULA] [-AzureHybridBenefit <AzureHybridBenefit>] [-Distribution <String>] + [-DistributionVersion <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzConnectedKubernetes -InputObject <IConnectedKubernetesIdentity> [-AcceptEULA] + [-AzureHybridBenefit <AzureHybridBenefit>] [-Distribution <String>] [-DistributionVersion <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +API to update certain properties of the connected cluster resource + +## EXAMPLES + +### Example 1: Update a connected kubernetes. +```powershell +Update-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Tag @{'key'='1'} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster azps_test_group +``` + +This command updates a connected kubernetes. + +### Example 2: Update a connected kubernetes by object. +```powershell +Get-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group | Update-AzConnectedKubernetes -Tag @{'key'='2'} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster azps_test_group +``` + +This command updates a connected kubernetes by object. + +### Example 3: Update a ConnectedKubernetes's AzureHybridBenefit. +```powershell +Update-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Tag @{'key'='1'} -AzureHybridBenefit 'True' +``` + +```output +I confirm I have an eligible Windows Server license with Azure Hybrid Benefit to apply this benefit to AKS on Azure Stack HCI or Windows Server. Visit https://aka.ms/ahb-aks for details. +[Y] Yes [N] No (default is "N"): y + +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster_ahb azps_test_group +``` + +Update a ConnectedKubernetes's AzureHybridBenefit. + +### Example 4: Using [-AcceptEULA] will default to your acceptance of the terms of our legal agreement and update a ConnectedKubernetes's AzureHybridBenefit. +```powershell +Update-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group -Tag @{'key'='1'} -AzureHybridBenefit 'True' -AcceptEULA +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps_test_cluster_ahb azps_test_group +``` + +Using [-AcceptEULA] will default to your acceptance of the terms of our legal agreement and update a ConnectedKubernetes's AzureHybridBenefit. + +## PARAMETERS + +### -AcceptEULA +Accept EULA of ConnectedKubernetes, legal term will pop up without this parameter provided + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureHybridBenefit +Indicates whether Azure Hybrid Benefit is opted in + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Support.AzureHybridBenefit +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kubernetes cluster on which get is called. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Distribution +Represents the distribution of the connected cluster + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionVersion +Represents the Kubernetes distribution version on this connected cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.IConnectedKubernetesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedKubernetes.Models.Api20221001Preview.IConnectedCluster + +## 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 <IConnectedKubernetesIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the Kubernetes cluster on which get is called. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/Az.ConnectedMachine.md b/azps-10.1.0/Az.ConnectedMachine/Az.ConnectedMachine.md new file mode 100644 index 0000000000..e9f7df4681 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Az.ConnectedMachine.md @@ -0,0 +1,63 @@ +--- +Module Name: Az.ConnectedMachine +Module Guid: 259a0542-8329-4b9e-8f72-dab0efc583e9 +Download Help Link: https://learn.microsoft.com/powershell/module/az.connectedmachine +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Az.ConnectedMachine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Az.ConnectedMachine.md +--- + +# Az.ConnectedMachine Module +## Description +Microsoft Azure PowerShell: ConnectedMachine cmdlets + +## Az.ConnectedMachine Cmdlets +### [Connect-AzConnectedMachine](Connect-AzConnectedMachine.md) +API to register a new machine and thereby create a tracked resource in ARM + +### [Get-AzConnectedMachine](Get-AzConnectedMachine.md) +Retrieves information about the model view or the instance view of a hybrid machine. + +### [Get-AzConnectedMachineExtension](Get-AzConnectedMachineExtension.md) +The operation to get the extension. + +### [Get-AzConnectedPrivateLinkScope](Get-AzConnectedPrivateLinkScope.md) +Returns a Azure Arc PrivateLinkScope. + +### [New-AzConnectedMachineExtension](New-AzConnectedMachineExtension.md) +The operation to create or update the extension. + +### [New-AzConnectedPrivateLinkScope](New-AzConnectedPrivateLinkScope.md) +Creates (or updates) a Azure Arc PrivateLinkScope. +Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. + +### [Remove-AzConnectedMachine](Remove-AzConnectedMachine.md) +The operation to remove a hybrid machine identity in Azure. + +### [Remove-AzConnectedMachineExtension](Remove-AzConnectedMachineExtension.md) +The operation to delete the extension. + +### [Remove-AzConnectedPrivateLinkScope](Remove-AzConnectedPrivateLinkScope.md) +Deletes a Azure Arc PrivateLinkScope. + +### [Set-AzConnectedMachineExtension](Set-AzConnectedMachineExtension.md) +The operation to create or update the extension. + +### [Set-AzConnectedPrivateLinkScope](Set-AzConnectedPrivateLinkScope.md) +Creates (or updates) a Azure Arc PrivateLinkScope. +Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. + +### [Update-AzConnectedExtension](Update-AzConnectedExtension.md) +The operation to Upgrade Machine Extensions. + +### [Update-AzConnectedMachine](Update-AzConnectedMachine.md) +The operation to update a hybrid machine. + +### [Update-AzConnectedMachineExtension](Update-AzConnectedMachineExtension.md) +The operation to create or update the extension. + +### [Update-AzConnectedPrivateLinkScopeTag](Update-AzConnectedPrivateLinkScopeTag.md) +Updates an existing PrivateLinkScope's tags. +To update other fields use the CreateOrUpdate method. + diff --git a/azps-10.1.0/Az.ConnectedMachine/Connect-AzConnectedMachine.md b/azps-10.1.0/Az.ConnectedMachine/Connect-AzConnectedMachine.md new file mode 100644 index 0000000000..a9edf86749 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Connect-AzConnectedMachine.md @@ -0,0 +1,206 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/connect-azconnectedmachine +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Connect-AzConnectedMachine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Connect-AzConnectedMachine.md +--- + +# Connect-AzConnectedMachine + +## SYNOPSIS +API to register a new machine and thereby create a tracked resource in ARM + +## SYNTAX + +``` +Connect-AzConnectedMachine [-ResourceGroupName] <String> [-Location] <String> [[-SubscriptionId] <String>] + [[-Name] <String>] [[-DefaultProfile] <PSObject>] [[-PSSession] <PSSession[]>] [[-Tag] <Hashtable>] + [[-Proxy] <Uri>] [<CommonParameters>] +``` + +## DESCRIPTION +API to register a new machine and thereby create a tracked resource in ARM + +## EXAMPLES + +### Example 1: Onboards the machine you're on as a connected machine +```powershell +Connect-AzConnectedMachine -ResourceGroupName contoso-connected-machines -Name linux_eastus1_1 -Location eastus +``` + +```output +< truncated output of installing the azcmagent > + +time="2020-08-07T13:13:25-07:00" level=info msg="Onboarding Machine. It usually takes a few minutes to complete. Sometimes it may take longer depending on network and server load status." +time="2020-08-07T13:13:25-07:00" level=info msg="Check network connectivity to all endpoints..." +time="2020-08-07T13:13:29-07:00" level=info msg="All endpoints are available... continue onboarding" +time="2020-08-07T13:13:50-07:00" level=info msg="Successfully Onboarded Resource to Azure" VM Id=978ab182-6cf0-4de3-a58b-53c8d0a3235e + +Name Location OSName Status ProvisioningState +---- -------- ------ ------ ----------------- +linux_eastus1_1 eastus linux Connected Succeeded +``` + +Onboards the machine you're on as a connected machine. + +### Example 2: Onboards a remote machine as a connected device +```powershell +$session = Connect-PSSession -ComputerName WINBOX +Connect-AzConnectedMachine -ResourceGroupName contoso-rg -Name win_eastus1_1 -Location eastus -PSSession $session +``` + +```output +< truncated output of installing the azcmagent > + +time="2020-08-07T13:13:25-07:00" level=info msg="Onboarding Machine. It usually takes a few minutes to complete. Sometimes it may take longer depending on network and server load status." +time="2020-08-07T13:13:25-07:00" level=info msg="Check network connectivity to all endpoints..." +time="2020-08-07T13:13:29-07:00" level=info msg="All endpoints are available... continue onboarding" +time="2020-08-07T13:13:50-07:00" level=info msg="Successfully Onboarded Resource to Azure" VM Id=978ab182-6cf0-4de3-a58b-53c8d0a3236a + +Name Location OSName Status ProvisioningState +---- -------- ------ ------ ----------------- +win_eastus1_1 eastus windows Connected Succeeded +``` + +Onboards a remote machine as a connected device using PowerShell remoting. +Note: only Windows as the target is supported at this time. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location for the created ConnectedMachine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name that will be used for this machine. +The hostname is used by default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +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: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PSSession +When specified, the command that onboards machines to Azure will be run within each PSSession. +NOTE: This only works on Windows for now. + +```yaml +Type: System.Management.Automation.Runspaces.PSSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group you want to add the machine to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription you want to add the machine to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/Get-AzConnectedMachine.md b/azps-10.1.0/Az.ConnectedMachine/Get-AzConnectedMachine.md new file mode 100644 index 0000000000..15e759beba --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Get-AzConnectedMachine.md @@ -0,0 +1,176 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/get-azconnectedmachine +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Get-AzConnectedMachine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Get-AzConnectedMachine.md +--- + +# Get-AzConnectedMachine + +## SYNOPSIS +Retrieves information about the model view or the instance view of a hybrid machine. + +## SYNTAX + +### List1 (Default) +``` +Get-AzConnectedMachine [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzConnectedMachine -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Expand <InstanceViewTypes>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzConnectedMachine -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves information about the model view or the instance view of a hybrid machine. + +## EXAMPLES + +### Example 1: List all connected machines in a subscription +```powershell +Get-AzConnectedMachine -SubscriptionId 67379433-5e19-4702-b39a-c0a03ca8d20c +``` + +```output +Name Location OSName Status ProvisioningState +---- -------- ------ ------ ----------------- +winwestus2_1 westus2 windows Connected Succeeded +linwestus2_1 westus2 linux Connected Succeeded +winwestus2_2 westus2 windows Connected Succeeded +winwestus2_3 westus2 windows Connected Succeeded + +``` + +Lists all connected machines in a subscription. +If subscription isn't specified, it will use the subscription from your current Azure PowerShell context. + +### Example 2: List all connected machines in a resource group +```powershell +Get-AzConnectedMachine -ResourceGroupName contoso-connected-machines +``` + +```output +Name Location OSName Status ProvisioningState +---- -------- ------ ------ ----------------- +winwestus2_2 westus2 windows Connected Succeeded +winwestus2_3 westus2 windows Connected Succeeded +``` + +List all connected machines in a resource group. + +### Example 3: Get a connected machine in a resource group by name +```powershell +Get-AzConnectedMachine -ResourceGroupName contoso-connected-machines -Name winwestus2_1 +``` + +```output +Name Location OSName Status ProvisioningState +---- -------- ------ ------ ----------------- +winwestus2_1 westus2 windows Connected Succeeded +``` + +Get a connected machine in a resource group by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +The expand expression to apply on the operation. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Support.InstanceViewTypes +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the hybrid machine. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: MachineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachine + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/Get-AzConnectedMachineExtension.md b/azps-10.1.0/Az.ConnectedMachine/Get-AzConnectedMachineExtension.md new file mode 100644 index 0000000000..a2f787cad1 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Get-AzConnectedMachineExtension.md @@ -0,0 +1,169 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/get-azconnectedmachineextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Get-AzConnectedMachineExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Get-AzConnectedMachineExtension.md +--- + +# Get-AzConnectedMachineExtension + +## SYNOPSIS +The operation to get the extension. + +## SYNTAX + +### List (Default) +``` +Get-AzConnectedMachineExtension -MachineName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Expand <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzConnectedMachineExtension -MachineName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to get the extension. + +## EXAMPLES + +### Example 1: List all extensions for a machine +```powershell +Get-AzConnectedMachineExtension -ResourceGroupName contoso-connected-machines -MachineName winwestus2_2 +``` + +```output +Name Location PropertiesType ProvisioningState +---- -------- -------------- ----------------- +custom westus2 CustomScriptExtension Succeeded +custom westus2 CustomScriptExtension Succeeded +dsc westus2 DSC Succeeded +``` + +Lists all extensions for a specific machine. + +### Example 2: Get a specific extension on a machine +```powershell +Get-AzConnectedMachineExtension -ResourceGroupName contoso-connected-machines -MachineName winwestus2_2 -Name dsc +``` + +```output +Name Location PropertiesType ProvisioningState +---- -------- -------------- ----------------- +dsc westus2 CustomScriptExtension Succeeded +``` + +Gets a specific extension on a machine. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +The expand expression to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineName +The name of the machine containing the extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the machine extension. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineExtension + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/Get-AzConnectedPrivateLinkScope.md b/azps-10.1.0/Az.ConnectedMachine/Get-AzConnectedPrivateLinkScope.md new file mode 100644 index 0000000000..145199ab0b --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Get-AzConnectedPrivateLinkScope.md @@ -0,0 +1,144 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/get-azconnectedprivatelinkscope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Get-AzConnectedPrivateLinkScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Get-AzConnectedPrivateLinkScope.md +--- + +# Get-AzConnectedPrivateLinkScope + +## SYNOPSIS +Returns a Azure Arc PrivateLinkScope. + +## SYNTAX + +### List (Default) +``` +Get-AzConnectedPrivateLinkScope [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzConnectedPrivateLinkScope -ResourceGroupName <String> -ScopeName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzConnectedPrivateLinkScope -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns a Azure Arc PrivateLinkScope. + +## EXAMPLES + +### Example 1: List all private link scopes in a resource group +```powershell +Get-AzConnectedPrivateLinkScope -ResourceGroupName $resourceGroupName +``` + +```output +Name Location PublicNetworkAccess ProvisioningState +---- -------- ------------------- ----------------- +name1 eastus2euap Enabled Succeeded +name2 eastus2euap Disabled Succeeded +name3 eastus2euap Enabled Succeeded +``` + +Lists all private link scopes in a specified resource group + +### Example 2: Get a private link scope in a resource group by name +```powershell +Get-AzConnectedPrivateLinkScope -ResourceGroupName $resourceGroupName -ScopeName $scopeName +``` + +```output +Name Location PublicNetworkAccess ProvisioningState +---- -------- ------------------- ----------------- +name1 eastus2euap Enabled Succeeded +``` + +Gets a private link scope in a specified resource group by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeName +The name of the Azure Arc PrivateLinkScope resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IHybridComputePrivateLinkScope + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/New-AzConnectedMachineExtension.md b/azps-10.1.0/Az.ConnectedMachine/New-AzConnectedMachineExtension.md new file mode 100644 index 0000000000..e79a40f83f --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/New-AzConnectedMachineExtension.md @@ -0,0 +1,621 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/new-azconnectedmachineextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/New-AzConnectedMachineExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/New-AzConnectedMachineExtension.md +--- + +# New-AzConnectedMachineExtension + +## SYNOPSIS +The operation to create or update the extension. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzConnectedMachineExtension -MachineName <String> -Name <String> -ResourceGroupName <String> + -Location <String> [-SubscriptionId <String>] [-AutoUpgradeMinorVersion] [-EnableAutomaticUpgrade] + [-ExtensionType <String>] [-ForceRerun <String>] [-InstanceViewName <String>] [-InstanceViewType <String>] + [-InstanceViewTypeHandlerVersion <String>] [-ProtectedSetting <Hashtable>] [-Publisher <String>] + [-Setting <Hashtable>] [-StatusCode <String>] [-StatusDisplayStatus <String>] + [-StatusLevel <StatusLevelTypes>] [-StatusMessage <String>] [-StatusTime <DateTime>] [-Tag <Hashtable>] + [-TypeHandlerVersion <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Create +``` +New-AzConnectedMachineExtension -MachineName <String> -Name <String> -ResourceGroupName <String> + -ExtensionParameter <IMachineExtension> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentity +``` +New-AzConnectedMachineExtension -InputObject <IConnectedMachineIdentity> + -ExtensionParameter <IMachineExtension> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzConnectedMachineExtension -InputObject <IConnectedMachineIdentity> -Location <String> + [-AutoUpgradeMinorVersion] [-EnableAutomaticUpgrade] [-ExtensionType <String>] [-ForceRerun <String>] + [-InstanceViewName <String>] [-InstanceViewType <String>] [-InstanceViewTypeHandlerVersion <String>] + [-ProtectedSetting <Hashtable>] [-Publisher <String>] [-Setting <Hashtable>] [-StatusCode <String>] + [-StatusDisplayStatus <String>] [-StatusLevel <StatusLevelTypes>] [-StatusMessage <String>] + [-StatusTime <DateTime>] [-Tag <Hashtable>] [-TypeHandlerVersion <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to create or update the extension. + +## EXAMPLES + +### Example 1: Add a new extension to a machine +```powershell +$Settings = @{ "commandToExecute" = "powershell.exe -c Get-Process" } +New-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName win-eastus1 -Location eastus -Publisher "Microsoft.Compute" -TypeHandlerVersion 1.10 -Settings $Settings -ExtensionType CustomScriptExtension +``` + +```output +Name Location ProvisioningState +---- -------- ----------------- +custom eastus Succeeded +``` + +Sets an extension on a machine. + +### Example 2: Add a new extension with extension parameters specified via the pipeline +```powershell +$otherExtension = Get-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName other +$otherExtension | New-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName important +``` + +```output +Name Location ProvisioningState +---- -------- ----------------- +custom eastus Succeeded +``` + +This creates a new extension with the extension parameters provided by the object passed in via the pipeline. +This is great if you want to grab the parameters of one machine and apply it to another machine. + +### Example 3: Add a new extension with location specified via the pipeline +```powershell +$identity = [Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.ConnectedMachineIdentity]@{ + Id = "/subscriptions/$($SubscriptionId)/resourceGroups/$($ResourceGroupName)/providers/Microsoft.HybridCompute/machines/$MachineName/extensions/$ExtensionName" +} +$Settings = @{ "commandToExecute" = "powershell.exe -c Get-Process" } +$identity | New-AzConnectedMachineExtension -Location eastus -Publisher "Microsoft.Compute" -TypeHandlerVersion 1.10 -Settings $Settings -ExtensionType CustomScriptExtension +``` + +```output +Name Location ProvisioningState +---- -------- ----------------- +custom eastus Succeeded +``` + +This creates a new machine extension using the identity provided via the pipeline. +You likely won't do this, but it's possible. + +### Example 4: Add a new extension using an extension object as both the location and parameters for updating +```powershell +$ext = Get-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName other +$ext | New-AzConnectedMachineExtension -ExtensionParameter $ext +``` + +This creates a new machine extension using the identity provided via the pipeline and the extension details provided by the passed in extension object. +You likely won't do this, but it's possible. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoUpgradeMinorVersion +Indicates whether the extension should use a newer minor version if one is available at deployment time. +Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutomaticUpgrade +Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionParameter +Describes a Machine Extension. +To construct, see NOTES section for EXTENSIONPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineExtension +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ExtensionType +Specifies the type of the extension; an example is "CustomScriptExtension". + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceRerun +How the extension handler should be forced to update even if the extension configuration has not changed. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +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.ConnectedMachine.Models.IConnectedMachineIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceViewName +The machine extension name. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceViewType +Specifies the type of the extension; an example is "CustomScriptExtension". + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceViewTypeHandlerVersion +Specifies the version of the script handler. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineName +The name of the machine where the extension should be created or updated. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the machine extension. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectedSetting +The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: ProtectedSettings + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Publisher +The name of the extension handler publisher. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Setting +Json formatted public settings for the extension. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: Settings + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusCode +The status code. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusDisplayStatus +The short localizable label for the status. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusLevel +The level code. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Support.StatusLevelTypes +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusMessage +The detailed status message, including for alerts and error messages. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusTime +The time of the status. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the script handler. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineExtension + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineExtension + +## 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. + + +`EXTENSIONPARAMETER <IMachineExtension>`: Describes a Machine Extension. + - `Location <String>`: The geo-location where the resource lives + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AutoUpgradeMinorVersion <Boolean?>]`: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + - `[EnableAutomaticUpgrade <Boolean?>]`: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + - `[ForceUpdateTag <String>]`: How the extension handler should be forced to update even if the extension configuration has not changed. + - `[InstanceViewName <String>]`: The machine extension name. + - `[InstanceViewType <String>]`: Specifies the type of the extension; an example is "CustomScriptExtension". + - `[InstanceViewTypeHandlerVersion <String>]`: Specifies the version of the script handler. + - `[MachineExtensionType <String>]`: Specifies the type of the extension; an example is "CustomScriptExtension". + - `[ProtectedSetting <IMachineExtensionPropertiesProtectedSettings>]`: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[Publisher <String>]`: The name of the extension handler publisher. + - `[Setting <IMachineExtensionPropertiesSettings>]`: Json formatted public settings for the extension. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[StatusCode <String>]`: The status code. + - `[StatusDisplayStatus <String>]`: The short localizable label for the status. + - `[StatusLevel <StatusLevelTypes?>]`: The level code. + - `[StatusMessage <String>]`: The detailed status message, including for alerts and error messages. + - `[StatusTime <DateTime?>]`: The time of the status. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[TypeHandlerVersion <String>]`: Specifies the version of the script handler. + +`INPUTOBJECT <IConnectedMachineIdentity>`: Identity Parameter + - `[ExtensionName <String>]`: The name of the machine extension. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the target resource. + - `[MachineName <String>]`: The name of the hybrid machine. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkScopeId <String>]`: The id (Guid) of the Azure Arc PrivateLinkScope resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScopeName <String>]`: The name of the Azure Arc PrivateLinkScope resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/New-AzConnectedPrivateLinkScope.md b/azps-10.1.0/Az.ConnectedMachine/New-AzConnectedPrivateLinkScope.md new file mode 100644 index 0000000000..6fa64f62c9 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/New-AzConnectedPrivateLinkScope.md @@ -0,0 +1,284 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/new-azconnectedprivatelinkscope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/New-AzConnectedPrivateLinkScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/New-AzConnectedPrivateLinkScope.md +--- + +# New-AzConnectedPrivateLinkScope + +## SYNOPSIS +Creates (or updates) a Azure Arc PrivateLinkScope. +Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzConnectedPrivateLinkScope -ResourceGroupName <String> -ScopeName <String> -Location <String> + [-SubscriptionId <String>] [-PublicNetworkAccess <PublicNetworkAccessType>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzConnectedPrivateLinkScope -ResourceGroupName <String> -ScopeName <String> + -Parameter <IHybridComputePrivateLinkScope> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentity +``` +New-AzConnectedPrivateLinkScope -InputObject <IConnectedMachineIdentity> + -Parameter <IHybridComputePrivateLinkScope> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzConnectedPrivateLinkScope -InputObject <IConnectedMachineIdentity> -Location <String> + [-PublicNetworkAccess <PublicNetworkAccessType>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates (or updates) a Azure Arc PrivateLinkScope. +Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. + +## EXAMPLES + +### Example 1: Add a new private link scope in a subscription +```powershell +New-AzConnectedPrivateLinkScope -ResourceGroupName $resourceGroupName -ScopeName $scopeName -PublicNetworkAccess "Enabled" -Location $location +``` + +```output +Name Location PublicNetworkAccess ProvisioningState +---- -------- ------------------- ----------------- +name1 eastus2euap Enabled Succeeded + +``` + +PublicNetworkAccess should be either "Enabled" or "Disabled" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +An Azure Arc PrivateLinkScope definition. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IHybridComputePrivateLinkScope +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Support.PublicNetworkAccessType +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeName +The name of the Azure Arc PrivateLinkScope resource. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IHybridComputePrivateLinkScope + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IHybridComputePrivateLinkScope + +## 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 <IConnectedMachineIdentity>`: Identity Parameter + - `[ExtensionName <String>]`: The name of the machine extension. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the target resource. + - `[MachineName <String>]`: The name of the hybrid machine. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkScopeId <String>]`: The id (Guid) of the Azure Arc PrivateLinkScope resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScopeName <String>]`: The name of the Azure Arc PrivateLinkScope resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`PARAMETER <IHybridComputePrivateLinkScope>`: An Azure Arc PrivateLinkScope definition. + - `Location <String>`: Resource location + - `[Tag <IPrivateLinkScopesResourceTags>]`: Resource tags + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[PublicNetworkAccess <PublicNetworkAccessType?>]`: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/Remove-AzConnectedMachine.md b/azps-10.1.0/Az.ConnectedMachine/Remove-AzConnectedMachine.md new file mode 100644 index 0000000000..939d330efb --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Remove-AzConnectedMachine.md @@ -0,0 +1,206 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/remove-azconnectedmachine +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Remove-AzConnectedMachine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Remove-AzConnectedMachine.md +--- + +# Remove-AzConnectedMachine + +## SYNOPSIS +The operation to remove a hybrid machine identity in Azure. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzConnectedMachine -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzConnectedMachine -InputObject <IConnectedMachineIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to remove a hybrid machine identity in Azure. + +## EXAMPLES + +### Example 1: Remove a connected machine +```powershell +Remove-AzConnectedMachine -Name myMachine -ResourceGroupName myRG +``` + +Deletes the connected machine. + +### Example 2: Remove connected machines via the pipeline +```powershell +Get-AzConnectedMachine -ResourceGroupName contoso-connected-machines | Remove-AzConnectedMachine +``` + +Removes all machines in the `contoso-connected-machines` resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the hybrid machine. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: MachineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IConnectedMachineIdentity>`: Identity Parameter + - `[ExtensionName <String>]`: The name of the machine extension. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the target resource. + - `[MachineName <String>]`: The name of the hybrid machine. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkScopeId <String>]`: The id (Guid) of the Azure Arc PrivateLinkScope resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScopeName <String>]`: The name of the Azure Arc PrivateLinkScope resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/Remove-AzConnectedMachineExtension.md b/azps-10.1.0/Az.ConnectedMachine/Remove-AzConnectedMachineExtension.md new file mode 100644 index 0000000000..aa5bfd873e --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Remove-AzConnectedMachineExtension.md @@ -0,0 +1,252 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/remove-azconnectedmachineextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Remove-AzConnectedMachineExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Remove-AzConnectedMachineExtension.md +--- + +# Remove-AzConnectedMachineExtension + +## SYNOPSIS +The operation to delete the extension. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzConnectedMachineExtension -MachineName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzConnectedMachineExtension -InputObject <IConnectedMachineIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to delete the extension. + +## EXAMPLES + +### Example 1: Remove a machine extension. +```powershell +Remove-AzConnectedMachineExtension -MachineName myMachine -ResourceGroupName myRG -Name custom +``` + +Deletes the extension on the machine. + +### Example 2: Remove extension via the pipeline +```powershell +Get-AzConnectedMachineExtension -ResourceGroupName contoso-connected-machines -MachineName myMachine | Remove-AzConnectedMachineExtension +``` + +Removes all extensions in the specified machine. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MachineName +The name of the machine where the extension should be deleted. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the machine extension. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IConnectedMachineIdentity>`: Identity Parameter + - `[ExtensionName <String>]`: The name of the machine extension. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the target resource. + - `[MachineName <String>]`: The name of the hybrid machine. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkScopeId <String>]`: The id (Guid) of the Azure Arc PrivateLinkScope resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScopeName <String>]`: The name of the Azure Arc PrivateLinkScope resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/Remove-AzConnectedPrivateLinkScope.md b/azps-10.1.0/Az.ConnectedMachine/Remove-AzConnectedPrivateLinkScope.md new file mode 100644 index 0000000000..3a283afd30 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Remove-AzConnectedPrivateLinkScope.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/remove-azconnectedprivatelinkscope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Remove-AzConnectedPrivateLinkScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Remove-AzConnectedPrivateLinkScope.md +--- + +# Remove-AzConnectedPrivateLinkScope + +## SYNOPSIS +Deletes a Azure Arc PrivateLinkScope. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzConnectedPrivateLinkScope -ResourceGroupName <String> -ScopeName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzConnectedPrivateLinkScope -InputObject <IConnectedMachineIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Azure Arc PrivateLinkScope. + +## EXAMPLES + +### Example 1: Remove a private link scope in a subscription by name +```powershell +Remove-AzConnectedPrivateLinkScope -ResourceGroupName $resourceGroupName -ScopeName $scopeName +``` + +```output +<None> +``` + +Remove a private link scope in a subscription by name + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeName +The name of the Azure Arc PrivateLinkScope resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IConnectedMachineIdentity>`: Identity Parameter + - `[ExtensionName <String>]`: The name of the machine extension. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the target resource. + - `[MachineName <String>]`: The name of the hybrid machine. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkScopeId <String>]`: The id (Guid) of the Azure Arc PrivateLinkScope resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScopeName <String>]`: The name of the Azure Arc PrivateLinkScope resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/Set-AzConnectedMachineExtension.md b/azps-10.1.0/Az.ConnectedMachine/Set-AzConnectedMachineExtension.md new file mode 100644 index 0000000000..2ffda7dce2 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Set-AzConnectedMachineExtension.md @@ -0,0 +1,546 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/set-azconnectedmachineextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Set-AzConnectedMachineExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Set-AzConnectedMachineExtension.md +--- + +# Set-AzConnectedMachineExtension + +## SYNOPSIS +The operation to create or update the extension. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzConnectedMachineExtension -MachineName <String> -Name <String> -ResourceGroupName <String> + -Location <String> [-SubscriptionId <String>] [-AutoUpgradeMinorVersion] [-EnableAutomaticUpgrade] + [-ExtensionType <String>] [-ForceRerun <String>] [-InstanceViewName <String>] [-InstanceViewType <String>] + [-InstanceViewTypeHandlerVersion <String>] [-ProtectedSetting <Hashtable>] [-Publisher <String>] + [-Setting <Hashtable>] [-StatusCode <String>] [-StatusDisplayStatus <String>] + [-StatusLevel <StatusLevelTypes>] [-StatusMessage <String>] [-StatusTime <DateTime>] [-Tag <Hashtable>] + [-TypeHandlerVersion <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Update +``` +Set-AzConnectedMachineExtension -MachineName <String> -Name <String> -ResourceGroupName <String> + -ExtensionParameter <IMachineExtension> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to create or update the extension. + +## EXAMPLES + +### Example 1: Set an extension on a machine +```powershell +$Settings = @{ "commandToExecute" = "powershell.exe -c Get-Process" } +Set-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName win-eastus1 -Location eastus -Publisher "Microsoft.Compute" -TypeHandlerVersion 1.10 -Settings $Settings -ExtensionType CustomScriptExtension +``` + +```output +Name Location ProvisioningState +---- -------- ----------------- +custom eastus Succeeded +``` + +Sets an extension on a machine. + +### Example 2: Set an extension with extension parameters specified via the pipeline +```powershell +$otherExtension = Get-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName other +$otherExtension | Set-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName important +``` + +```output +Name Location ProvisioningState +---- -------- ----------------- +custom eastus Succeeded +``` + +This sets an extension with the extension parameters provided by the object passed in via the pipeline. +This is great if you want to grab the parameters of one machine and apply it to another machine. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoUpgradeMinorVersion +Indicates whether the extension should use a newer minor version if one is available at deployment time. +Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutomaticUpgrade +Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionParameter +Describes a Machine Extension. +To construct, see NOTES section for EXTENSIONPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineExtension +Parameter Sets: Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ExtensionType +Specifies the type of the extension; an example is "CustomScriptExtension". + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceRerun +How the extension handler should be forced to update even if the extension configuration has not changed. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceViewName +The machine extension name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceViewType +Specifies the type of the extension; an example is "CustomScriptExtension". + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceViewTypeHandlerVersion +Specifies the version of the script handler. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineName +The name of the machine where the extension should be created or updated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the machine extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectedSetting +The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded +Aliases: ProtectedSettings + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Publisher +The name of the extension handler publisher. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Setting +Json formatted public settings for the extension. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded +Aliases: Settings + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusCode +The status code. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusDisplayStatus +The short localizable label for the status. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusLevel +The level code. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Support.StatusLevelTypes +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusMessage +The detailed status message, including for alerts and error messages. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusTime +The time of the status. + +```yaml +Type: System.DateTime +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the script handler. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineExtension + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineExtension + +## 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. + + +`EXTENSIONPARAMETER <IMachineExtension>`: Describes a Machine Extension. + - `Location <String>`: The geo-location where the resource lives + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AutoUpgradeMinorVersion <Boolean?>]`: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + - `[EnableAutomaticUpgrade <Boolean?>]`: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + - `[ForceUpdateTag <String>]`: How the extension handler should be forced to update even if the extension configuration has not changed. + - `[InstanceViewName <String>]`: The machine extension name. + - `[InstanceViewType <String>]`: Specifies the type of the extension; an example is "CustomScriptExtension". + - `[InstanceViewTypeHandlerVersion <String>]`: Specifies the version of the script handler. + - `[MachineExtensionType <String>]`: Specifies the type of the extension; an example is "CustomScriptExtension". + - `[ProtectedSetting <IMachineExtensionPropertiesProtectedSettings>]`: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[Publisher <String>]`: The name of the extension handler publisher. + - `[Setting <IMachineExtensionPropertiesSettings>]`: Json formatted public settings for the extension. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[StatusCode <String>]`: The status code. + - `[StatusDisplayStatus <String>]`: The short localizable label for the status. + - `[StatusLevel <StatusLevelTypes?>]`: The level code. + - `[StatusMessage <String>]`: The detailed status message, including for alerts and error messages. + - `[StatusTime <DateTime?>]`: The time of the status. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[TypeHandlerVersion <String>]`: Specifies the version of the script handler. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/Set-AzConnectedPrivateLinkScope.md b/azps-10.1.0/Az.ConnectedMachine/Set-AzConnectedPrivateLinkScope.md new file mode 100644 index 0000000000..821b63da8a --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Set-AzConnectedPrivateLinkScope.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/set-azconnectedprivatelinkscope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Set-AzConnectedPrivateLinkScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Set-AzConnectedPrivateLinkScope.md +--- + +# Set-AzConnectedPrivateLinkScope + +## SYNOPSIS +Creates (or updates) a Azure Arc PrivateLinkScope. +Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzConnectedPrivateLinkScope -ResourceGroupName <String> -ScopeName <String> -Location <String> + [-SubscriptionId <String>] [-PublicNetworkAccess <PublicNetworkAccessType>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Update +``` +Set-AzConnectedPrivateLinkScope -ResourceGroupName <String> -ScopeName <String> + -Parameter <IHybridComputePrivateLinkScope> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates (or updates) a Azure Arc PrivateLinkScope. +Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. + +## EXAMPLES + +### Example 1: Set a private link scope in a subscription by name +```powershell +Set-AzConnectedPrivateLinkScope -ResourceGroupName $resourceGroupName -ScopeName $scopeName -PublicNetworkAccess "Disabled" -Tag $tags -Location $location +``` + +```output +Name Location PublicNetworkAccess ProvisioningState +---- -------- ------------------- ----------------- +name eastus2euap Disabled Succeeded +``` + +Updates the PublicNetworkAccess to "Disable" and tags to $tags + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +An Azure Arc PrivateLinkScope definition. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IHybridComputePrivateLinkScope +Parameter Sets: Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Support.PublicNetworkAccessType +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeName +The name of the Azure Arc PrivateLinkScope resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IHybridComputePrivateLinkScope + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IHybridComputePrivateLinkScope + +## 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. + + +`PARAMETER <IHybridComputePrivateLinkScope>`: An Azure Arc PrivateLinkScope definition. + - `Location <String>`: Resource location + - `[Tag <IPrivateLinkScopesResourceTags>]`: Resource tags + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[PublicNetworkAccess <PublicNetworkAccessType?>]`: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/Update-AzConnectedExtension.md b/azps-10.1.0/Az.ConnectedMachine/Update-AzConnectedExtension.md new file mode 100644 index 0000000000..eb08a15776 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Update-AzConnectedExtension.md @@ -0,0 +1,286 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/update-azconnectedextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Update-AzConnectedExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Update-AzConnectedExtension.md +--- + +# Update-AzConnectedExtension + +## SYNOPSIS +The operation to Upgrade Machine Extensions. + +## SYNTAX + +### UpgradeExpanded (Default) +``` +Update-AzConnectedExtension -MachineName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-ExtensionTarget <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### Upgrade +``` +Update-AzConnectedExtension -MachineName <String> -ResourceGroupName <String> + -ExtensionUpgradeParameter <IMachineExtensionUpgrade> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpgradeViaIdentity +``` +Update-AzConnectedExtension -InputObject <IConnectedMachineIdentity> + -ExtensionUpgradeParameter <IMachineExtensionUpgrade> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpgradeViaIdentityExpanded +``` +Update-AzConnectedExtension -InputObject <IConnectedMachineIdentity> [-ExtensionTarget <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to Upgrade Machine Extensions. + +## EXAMPLES + +### Example 1: Update an extension in a machine to a specific version +```powershell +$target = @{"Microsoft.Compute.CustomScriptExtension" = @{"targetVersion"="1.10.12"}} +Update-AzConnectedExtension -ResourceGroupName $env.ResourceGroupName -MachineName $machineName -ExtensionTarget $target +``` + +```output +<None> +``` + +Update an extension in a machine to a specific version + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionTarget +Describes the Extension Target Properties. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpgradeExpanded, UpgradeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionUpgradeParameter +Describes the Machine Extension Upgrade Properties +To construct, see NOTES section for EXTENSIONUPGRADEPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineExtensionUpgrade +Parameter Sets: Upgrade, UpgradeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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.ConnectedMachine.Models.IConnectedMachineIdentity +Parameter Sets: UpgradeViaIdentity, UpgradeViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MachineName +The name of the hybrid machine. + +```yaml +Type: System.String +Parameter Sets: Upgrade, UpgradeExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Upgrade, UpgradeExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Upgrade, UpgradeExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineExtensionUpgrade + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`EXTENSIONUPGRADEPARAMETER <IMachineExtensionUpgrade>`: Describes the Machine Extension Upgrade Properties + - `[ExtensionTarget <IExtensionTarget>]`: Describes the Extension Target Properties. + - `[(Any) <IExtensionTargetProperties>]`: This indicates any property can be added to this object. + +`INPUTOBJECT <IConnectedMachineIdentity>`: Identity Parameter + - `[ExtensionName <String>]`: The name of the machine extension. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the target resource. + - `[MachineName <String>]`: The name of the hybrid machine. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkScopeId <String>]`: The id (Guid) of the Azure Arc PrivateLinkScope resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScopeName <String>]`: The name of the Azure Arc PrivateLinkScope resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/Update-AzConnectedMachine.md b/azps-10.1.0/Az.ConnectedMachine/Update-AzConnectedMachine.md new file mode 100644 index 0000000000..7af94a2e11 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Update-AzConnectedMachine.md @@ -0,0 +1,440 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/update-azconnectedmachine +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Update-AzConnectedMachine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Update-AzConnectedMachine.md +--- + +# Update-AzConnectedMachine + +## SYNOPSIS +The operation to update a hybrid machine. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzConnectedMachine -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IdentityType <ResourceIdentityType>] [-LinuxConfigurationPatchSettingsAssessmentMode <AssessmentModeTypes>] + [-LinuxConfigurationPatchSettingsPatchMode <PatchModeTypes>] [-LocationDataCity <String>] + [-LocationDataCountryOrRegion <String>] [-LocationDataDistrict <String>] [-LocationDataName <String>] + [-ParentClusterResourceId <String>] [-PrivateLinkScopeResourceId <String>] [-Tag <Hashtable>] + [-WindowsConfigurationPatchSettingsAssessmentMode <AssessmentModeTypes>] + [-WindowsConfigurationPatchSettingsPatchMode <PatchModeTypes>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### Update +``` +Update-AzConnectedMachine -Name <String> -ResourceGroupName <String> -Parameter <IMachineUpdate> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzConnectedMachine -InputObject <IConnectedMachineIdentity> -Parameter <IMachineUpdate> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzConnectedMachine -InputObject <IConnectedMachineIdentity> [-IdentityType <ResourceIdentityType>] + [-LinuxConfigurationPatchSettingsAssessmentMode <AssessmentModeTypes>] + [-LinuxConfigurationPatchSettingsPatchMode <PatchModeTypes>] [-LocationDataCity <String>] + [-LocationDataCountryOrRegion <String>] [-LocationDataDistrict <String>] [-LocationDataName <String>] + [-ParentClusterResourceId <String>] [-PrivateLinkScopeResourceId <String>] [-Tag <Hashtable>] + [-WindowsConfigurationPatchSettingsAssessmentMode <AssessmentModeTypes>] + [-WindowsConfigurationPatchSettingsPatchMode <PatchModeTypes>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to update a hybrid machine. + +## EXAMPLES + +### Example 1: Update a machine using parameters +```powershell +Update-AzConnectedMachine -Name surface -ResourceGroupName rg -PrivateLinkScopeResourceId privateLinkScopeId -WindowsConfigurationPatchSettingsAssessmentMode AutomaticByOS -Tag @{"key"="value"} +``` + +```output +ResourceGroupName Name Location OSType Status ProvisioningState +----------------- ---- -------- ------ ------ ----------------- +rg surface eastus2euap windows Connected Updating +``` + +Update a machine + +### Example 2: Update a machine - cleaning a field +```powershell +Update-AzConnectedMachine -Name surface -ResourceGroupName rg -PrivateLinkScopeResourceId $null +``` + +```output +ResourceGroupName Name Location OSType Status ProvisioningState +----------------- ---- -------- ------ ------ ----------------- +rg surface eastus2euap windows Connected Updating +``` + +Update a machine to clean a field + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Support.ResourceIdentityType +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +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.ConnectedMachine.Models.IConnectedMachineIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinuxConfigurationPatchSettingsAssessmentMode +Specifies the assessment mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Support.AssessmentModeTypes +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinuxConfigurationPatchSettingsPatchMode +Specifies the patch mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Support.PatchModeTypes +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationDataCity +The city or locality where the resource is located. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationDataCountryOrRegion +The country or region where the resource is located + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationDataDistrict +The district, state, or province where the resource is located. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationDataName +A canonical name for the geographic or physical location. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the hybrid machine. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: MachineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Describes a hybrid machine Update. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineUpdate +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentClusterResourceId +The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkScopeResourceId +The resource id of the private link scope this machine is assigned to, if any. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsConfigurationPatchSettingsAssessmentMode +Specifies the assessment mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Support.AssessmentModeTypes +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsConfigurationPatchSettingsPatchMode +Specifies the patch mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Support.PatchModeTypes +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineUpdate + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachine + +## 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 <IConnectedMachineIdentity>`: Identity Parameter + - `[ExtensionName <String>]`: The name of the machine extension. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the target resource. + - `[MachineName <String>]`: The name of the hybrid machine. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkScopeId <String>]`: The id (Guid) of the Azure Arc PrivateLinkScope resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScopeName <String>]`: The name of the Azure Arc PrivateLinkScope resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`PARAMETER <IMachineUpdate>`: Describes a hybrid machine Update. + - `[Tag <IResourceUpdateTags>]`: Resource tags + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[IdentityType <ResourceIdentityType?>]`: The identity type. + - `[LinuxConfigurationPatchSettingsAssessmentMode <AssessmentModeTypes?>]`: Specifies the assessment mode. + - `[LinuxConfigurationPatchSettingsPatchMode <PatchModeTypes?>]`: Specifies the patch mode. + - `[LocationDataCity <String>]`: The city or locality where the resource is located. + - `[LocationDataCountryOrRegion <String>]`: The country or region where the resource is located + - `[LocationDataDistrict <String>]`: The district, state, or province where the resource is located. + - `[LocationDataName <String>]`: A canonical name for the geographic or physical location. + - `[ParentClusterResourceId <String>]`: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. + - `[PrivateLinkScopeResourceId <String>]`: The resource id of the private link scope this machine is assigned to, if any. + - `[WindowsConfigurationPatchSettingsAssessmentMode <AssessmentModeTypes?>]`: Specifies the assessment mode. + - `[WindowsConfigurationPatchSettingsPatchMode <PatchModeTypes?>]`: Specifies the patch mode. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/Update-AzConnectedMachineExtension.md b/azps-10.1.0/Az.ConnectedMachine/Update-AzConnectedMachineExtension.md new file mode 100644 index 0000000000..24e6134d7e --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Update-AzConnectedMachineExtension.md @@ -0,0 +1,488 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/update-azconnectedmachineextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Update-AzConnectedMachineExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Update-AzConnectedMachineExtension.md +--- + +# Update-AzConnectedMachineExtension + +## SYNOPSIS +The operation to create or update the extension. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzConnectedMachineExtension -MachineName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AutoUpgradeMinorVersion] [-EnableAutomaticUpgrade] [-ForceRerun <String>] + [-ProtectedSetting <Hashtable>] [-Publisher <String>] [-Setting <Hashtable>] [-Tag <Hashtable>] + [-Type <String>] [-TypeHandlerVersion <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### Update +``` +Update-AzConnectedMachineExtension -MachineName <String> -Name <String> -ResourceGroupName <String> + -ExtensionParameter <IMachineExtensionUpdate> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzConnectedMachineExtension -InputObject <IConnectedMachineIdentity> + -ExtensionParameter <IMachineExtensionUpdate> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzConnectedMachineExtension -InputObject <IConnectedMachineIdentity> [-AutoUpgradeMinorVersion] + [-EnableAutomaticUpgrade] [-ForceRerun <String>] [-ProtectedSetting <Hashtable>] [-Publisher <String>] + [-Setting <Hashtable>] [-Tag <Hashtable>] [-Type <String>] [-TypeHandlerVersion <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to create or update the extension. + +## EXAMPLES + +### Example 1: Update an extension +```powershell +$splat = @{ + ResourceGroupName = "connectedMachines" + MachineName = "linux-eastus1_1" + Name = "customScript" + Settings = @{ + commandToExecute = "ls -l" + } +} +Update-AzConnectedMachineExtension @splat +``` + +```output +Name Location ProvisioningState +---- -------- ----------------- +customScript eastus Succeeded +``` + +Updates an extension on a specific machine. + +### Example 2: Update an extension with location specified via the pipeline +```powershell +$extToUpdate = Get-AzConnectedMachineExtension -ResourceGroupName connectedMachines -MachineName linux-eastus1_1 -Name customScript +$extToUpdate | Update-AzConnectedMachineExtension -Settings @{ + commandToExecute = "ls -l" +} +``` + +```output +Name Location ProvisioningState +---- -------- ----------------- +customScript eastus Succeeded +``` + +Updates a specific extension passed in via the pipeline. +Here we are using the extension passed in via the pipeline to help us identify which extension we want to operate on and are specifying what we want to change via the normal parameters (like `-Settings`) + +### Example 3: Update an extension with extension parameters specified via the pipeline +```powershell +$extToUpdate = Get-AzConnectedMachineExtension -ResourceGroupName connectedMachines -MachineName linux-eastus1_1 -Name customScript +# Update the settings on the object that will be used via the pipeline +$extToUpdate.Setting.commandToExecute = "ls -l" +$splat = @{ + ResourceGroupName = "connectedMachines" + MachineName = "linux-eastus1_1" + Name = "customScript" +} +$extToUpdate | Update-AzConnectedMachineExtension @splat +``` + +```output +Name Location ProvisioningState +---- -------- ----------------- +customScript eastus Succeeded +``` + +Updates a specific extension passed in via the pipeline. +Here we are using the extension passed in via the pipeline to provide the changes we want to make on the extension. +The location of the extension is not retrieved via the pipeline but rather via the parameters specified normally (by the splat parameter). + +### Example 4: Using an extension object as both the location and parameters for updating +```powershell +$extToUpdate = Get-AzConnectedMachineExtension -ResourceGroupName connectedMachines -MachineName linux-eastus1_1 -Name customScript +# Update the settings on the object that will be used via the pipeline +$extToUpdate.Setting.commandToExecute = "ls -l" +$extToUpdate | Update-AzConnectedMachineExtension -ExtensionParameter $extToUpdate +``` + +```output +Name Location ProvisioningState +---- -------- ----------------- +customScript eastus Succeeded +``` + +Updates a specific extension passed in via the pipeline. +Here we are using the extension passed in via the pipeline to help us identify which extension we want to operate on. +In addition to that, we are using the parameters of the extension object to specify what to update. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoUpgradeMinorVersion +Indicates whether the extension should use a newer minor version if one is available at deployment time. +Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutomaticUpgrade +Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionParameter +Describes a Machine Extension Update. +To construct, see NOTES section for EXTENSIONPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineExtensionUpdate +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ForceRerun +How the extension handler should be forced to update even if the extension configuration has not changed. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MachineName +The name of the machine where the extension should be created or updated. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the machine extension. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectedSetting +The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: ProtectedSettings + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Publisher +The name of the extension handler publisher. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Setting +Json formatted public settings for the extension. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: Settings + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specifies the type of the extension; an example is "CustomScriptExtension". + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the script handler. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineExtensionUpdate + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IMachineExtension + +## 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. + + +`EXTENSIONPARAMETER <IMachineExtensionUpdate>`: Describes a Machine Extension Update. + - `[Tag <IResourceUpdateTags>]`: Resource tags + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AutoUpgradeMinorVersion <Boolean?>]`: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + - `[EnableAutomaticUpgrade <Boolean?>]`: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + - `[ForceUpdateTag <String>]`: How the extension handler should be forced to update even if the extension configuration has not changed. + - `[ProtectedSetting <IMachineExtensionUpdatePropertiesProtectedSettings>]`: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[Publisher <String>]`: The name of the extension handler publisher. + - `[Setting <IMachineExtensionUpdatePropertiesSettings>]`: Json formatted public settings for the extension. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[Type <String>]`: Specifies the type of the extension; an example is "CustomScriptExtension". + - `[TypeHandlerVersion <String>]`: Specifies the version of the script handler. + +`INPUTOBJECT <IConnectedMachineIdentity>`: Identity Parameter + - `[ExtensionName <String>]`: The name of the machine extension. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the target resource. + - `[MachineName <String>]`: The name of the hybrid machine. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkScopeId <String>]`: The id (Guid) of the Azure Arc PrivateLinkScope resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScopeName <String>]`: The name of the Azure Arc PrivateLinkScope resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedMachine/Update-AzConnectedPrivateLinkScopeTag.md b/azps-10.1.0/Az.ConnectedMachine/Update-AzConnectedPrivateLinkScopeTag.md new file mode 100644 index 0000000000..f21890bf6e --- /dev/null +++ b/azps-10.1.0/Az.ConnectedMachine/Update-AzConnectedPrivateLinkScopeTag.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.ConnectedMachine +online version: https://learn.microsoft.com/powershell/module/az.connectedmachine/update-azconnectedprivatelinkscopetag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Update-AzConnectedPrivateLinkScopeTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedMachine/help/Update-AzConnectedPrivateLinkScopeTag.md +--- + +# Update-AzConnectedPrivateLinkScopeTag + +## SYNOPSIS +Updates an existing PrivateLinkScope's tags. +To update other fields use the CreateOrUpdate method. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzConnectedPrivateLinkScopeTag -ResourceGroupName <String> -ScopeName <String> + [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Update +``` +Update-AzConnectedPrivateLinkScopeTag -ResourceGroupName <String> -ScopeName <String> + -PrivateLinkScopeTag <ITagsResource> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzConnectedPrivateLinkScopeTag -InputObject <IConnectedMachineIdentity> + -PrivateLinkScopeTag <ITagsResource> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzConnectedPrivateLinkScopeTag -InputObject <IConnectedMachineIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing PrivateLinkScope's tags. +To update other fields use the CreateOrUpdate method. + +## EXAMPLES + +### Example 1: Update the tags of a private link scope +```powershell +$scope = Update-AzConnectedPrivateLinkScopeTag -ResourceGroupName $resourceGroupName -ScopeName $scopeName -Tag $tags2 + +Name Location PublicNetworkAccess ProvisioningState +---- -------- ------------------- ----------------- +name eastus2euap Disabled Succeeded + +$scope.Tag +``` + +Update the tags of a private link scope + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateLinkScopeTag +A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance. +To construct, see NOTES section for PRIVATELINKSCOPETAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.ITagsResource +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeName +The name of the Azure Arc PrivateLinkScope resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.ITagsResource + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.IConnectedMachineIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.Api20220310.IHybridComputePrivateLinkScope + +## 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 <IConnectedMachineIdentity>`: Identity Parameter + - `[ExtensionName <String>]`: The name of the machine extension. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the target resource. + - `[MachineName <String>]`: The name of the hybrid machine. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkScopeId <String>]`: The id (Guid) of the Azure Arc PrivateLinkScope resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScopeName <String>]`: The name of the Azure Arc PrivateLinkScope resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`PRIVATELINKSCOPETAG <ITagsResource>`: A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance. + - `[Tag <ITagsResourceTags>]`: Resource tags + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Az.ConnectedNetwork.md b/azps-10.1.0/Az.ConnectedNetwork/Az.ConnectedNetwork.md new file mode 100644 index 0000000000..43d25cdbd4 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Az.ConnectedNetwork.md @@ -0,0 +1,118 @@ +--- +Module Name: Az.ConnectedNetwork +Module Guid: 86910398-1fa6-447a-8b10-54e0ac5a2a6a +Download Help Link: https://learn.microsoft.com/powershell/module/az.connectednetwork +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Az.ConnectedNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Az.ConnectedNetwork.md +--- + +# Az.ConnectedNetwork Module +## Description +Microsoft Azure PowerShell: ConnectedNetwork cmdlets + +## Az.ConnectedNetwork Cmdlets +### [Get-AzConnectedNetworkDevice](Get-AzConnectedNetworkDevice.md) +Gets information about the specified device. + +### [Get-AzConnectedNetworkDeviceRegistrationKey](Get-AzConnectedNetworkDeviceRegistrationKey.md) +List the registration key for the device. + +### [Get-AzConnectedNetworkFunction](Get-AzConnectedNetworkFunction.md) +Gets information about the specified network function resource. + +### [Get-AzConnectedNetworkFunctionVendor](Get-AzConnectedNetworkFunctionVendor.md) +Lists all the available vendor and sku information. + +### [Get-AzConnectedNetworkVendor](Get-AzConnectedNetworkVendor.md) +Gets information about the specified vendor. + +### [Get-AzConnectedNetworkVendorFunction](Get-AzConnectedNetworkVendorFunction.md) +Gets information about the specified vendor network function. + +### [Get-AzConnectedNetworkVendorFunctionRoleInstance](Get-AzConnectedNetworkVendorFunctionRoleInstance.md) +Gets the information of role instance of vendor network function. + +### [Get-AzConnectedNetworkVendorSku](Get-AzConnectedNetworkVendorSku.md) +Gets information about the specified sku. + +### [Get-AzConnectedNetworkVendorSkuPreview](Get-AzConnectedNetworkVendorSkuPreview.md) +Gets the preview information of a vendor sku. + +### [New-AzConnectedNetworkAzureStackEdgeObject](New-AzConnectedNetworkAzureStackEdgeObject.md) +Create a in-memory object for AzureStackEdgeFormat + +### [New-AzConnectedNetworkDevice](New-AzConnectedNetworkDevice.md) +Creates or updates a device. + +### [New-AzConnectedNetworkFunction](New-AzConnectedNetworkFunction.md) +Creates or updates a network function resource. +This operation can take up to 6 hours to complete. +This is expected service behavior. + +### [New-AzConnectedNetworkFunctionRoleConfigurationObject](New-AzConnectedNetworkFunctionRoleConfigurationObject.md) +Create a in-memory object for NetworkFunctionRoleConfiguration + +### [New-AzConnectedNetworkFunctionUserConfigurationObject](New-AzConnectedNetworkFunctionUserConfigurationObject.md) +Create a in-memory object for NetworkFunctionUserConfiguration + +### [New-AzConnectedNetworkFunctionVendorConfigurationObject](New-AzConnectedNetworkFunctionVendorConfigurationObject.md) +Create a in-memory object for NetworkFunctionVendorConfiguration + +### [New-AzConnectedNetworkInterfaceIPConfigurationObject](New-AzConnectedNetworkInterfaceIPConfigurationObject.md) +Create a in-memory object for NetworkInterfaceIPConfiguration + +### [New-AzConnectedNetworkInterfaceObject](New-AzConnectedNetworkInterfaceObject.md) +Create a in-memory object for NetworkInterface + +### [New-AzConnectedNetworkVendor](New-AzConnectedNetworkVendor.md) +Creates or updates a vendor. + +### [New-AzConnectedNetworkVendorFunction](New-AzConnectedNetworkVendorFunction.md) +Creates or updates a vendor network function. +This operation can take up to 6 hours to complete. +This is expected service behavior. + +### [New-AzConnectedNetworkVendorSku](New-AzConnectedNetworkVendorSku.md) +Creates or updates a sku. +This operation can take up to 2 hours to complete. +This is expected service behavior. + +### [New-AzConnectedNetworkVendorSkuPreview](New-AzConnectedNetworkVendorSkuPreview.md) +Creates or updates preview information of a vendor sku. + +### [Remove-AzConnectedNetworkDevice](Remove-AzConnectedNetworkDevice.md) +Deletes the specified device. + +### [Remove-AzConnectedNetworkFunction](Remove-AzConnectedNetworkFunction.md) +Deletes the specified network function resource. +This operation can take up to 1 hour to complete. +This is expected service behavior. + +### [Remove-AzConnectedNetworkVendor](Remove-AzConnectedNetworkVendor.md) +Deletes the specified vendor. + +### [Remove-AzConnectedNetworkVendorSku](Remove-AzConnectedNetworkVendorSku.md) +Deletes the specified sku. +This operation can take up to 2 hours to complete. +This is expected service behavior. + +### [Remove-AzConnectedNetworkVendorSkuPreview](Remove-AzConnectedNetworkVendorSkuPreview.md) +Deletes the preview information of a vendor sku. + +### [Restart-AzConnectedNetworkVendorFunctionRoleInstance](Restart-AzConnectedNetworkVendorFunctionRoleInstance.md) +Restarts a role instance of a vendor network function. + +### [Start-AzConnectedNetworkVendorFunctionRoleInstance](Start-AzConnectedNetworkVendorFunctionRoleInstance.md) +Starts a role instance of a vendor network function. + +### [Stop-AzConnectedNetworkVendorFunctionRoleInstance](Stop-AzConnectedNetworkVendorFunctionRoleInstance.md) +Powers off (stop) a role instance of a vendor network function. + +### [Update-AzConnectedNetworkDeviceTag](Update-AzConnectedNetworkDeviceTag.md) +Updates device tags. + +### [Update-AzConnectedNetworkFunctionTag](Update-AzConnectedNetworkFunctionTag.md) +Updates the tags for the network function resource. + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkDevice.md b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkDevice.md new file mode 100644 index 0000000000..9a38161300 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkDevice.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/get-azconnectednetworkdevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkDevice.md +--- + +# Get-AzConnectedNetworkDevice + +## SYNOPSIS +Gets information about the specified device. + +## SYNTAX + +### List (Default) +``` +Get-AzConnectedNetworkDevice [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzConnectedNetworkDevice -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzConnectedNetworkDevice -InputObject <IConnectedNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzConnectedNetworkDevice -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified device. + +## EXAMPLES + +### Example 1: Get-AzConnectedNetworkDevice via Resource Group and Resource name +```powershell +Get-AzConnectedNetworkDevice -ResourceGroupName myResources -Name myMecDevice +``` + +```output +DeviceType : AzureStackEdge +Id : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMecDevice +Location : westcentralus +Name : myMecDevice +NetworkFunction : {/subscriptions/xxxxx-00000-xxxxx-00000/resourcegroups/myResources/providers/Microsoft.HybridNetwork/networkFunctions/myVnf1} +ProvisioningState : Succeeded +ResourceGroupName : myResources +Status : Registered +SystemDataCreatedAt : 11/25/2020 5:34:49 AM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/25/2020 5:58:38 AM +SystemDataLastModifiedBy : xxxxx-11111-xxxxx-11111 +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20.TrackedResourceTags +Type : Microsoft.HybridNetwork/devices + +``` + +Getting information about the NFM device in resource group myResources with name myMecDevice. + +### Example 2: Get-AzConnectedNetworkDevice via Identity +```powershell +$mecDevice = @{ DeviceName = "myMecDevice1"; Location = "eastus"; ResourceGroupName = "myResources"; SubscriptionId = "xxxxx-00000-xxxxx-00000"} +Get-AzConnectedNetworkDevice -InputObject $mecDevice +``` + +```output +DeviceType : AzureStackEdge +Id : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMecDevice1 +Location : eastus +Name : myMecDevice1 +NetworkFunction : {/subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/mrg-vmware_sdwan_edge_zones-20211124063650/providers/Microsoft.HybridNetwork/networkFunctions/myEdge1} +ProvisioningState : Succeeded +ResourceGroupName : myResources +Status : Registered +SystemDataCreatedAt : 11/23/2021 10:27:13 PM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/24/2021 7:42:41 AM +SystemDataLastModifiedBy : xxxxx-11111-xxxxx-11111 +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20.TrackedResourceTags +Type : microsoft.hybridnetwork/devices + +``` + +Creating an identity with device name myMecDevice1, resource group myResources and the given subscription. +Getting the information about the device using this identity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the device resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DeviceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IDevice + +## 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 `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkDeviceRegistrationKey.md b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkDeviceRegistrationKey.md new file mode 100644 index 0000000000..9769e940b3 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkDeviceRegistrationKey.md @@ -0,0 +1,159 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/get-azconnectednetworkdeviceregistrationkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkDeviceRegistrationKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkDeviceRegistrationKey.md +--- + +# Get-AzConnectedNetworkDeviceRegistrationKey + +## SYNOPSIS +List the registration key for the device. + +## SYNTAX + +``` +Get-AzConnectedNetworkDeviceRegistrationKey -DeviceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List the registration key for the device. + +## EXAMPLES + +### Example 1: Get-AzConnectedNetworkDeviceRegistrationKey using Resource Group, Resource name +```powershell +Get-AzConnectedNetworkDeviceRegistrationKey -DeviceName myMecDevice -ResourceGroupName myResources +``` + +```output +eyJNZWNEZXZpY2VUcmFuc2llbnRBdXRoS2V5IjoiMTIzNCIsIk1lY0RldmljZUF1dGhLZXlTdGFydFRpbWUiOiIyMDIxLTExLTIyVDA5OjQ2OjQwLjY0ODExOTFaIiwiU2VydmljZUJ1c1F1ZXVlTmFtZSI6ImFiY2QtMTIzNCIsIkFBREVuZHBvaW50IjpudWxsLCJBQURBdWRpZW5jZSI6bnVsbCwiQXJtUmVzb3VyY2VJZCI6bnVsbCwiTWVjQ29udHJvbGxlckVuZHBvaW50IjoiaHR0cHM6Ly93ZXN0Y2VudHJhbHVzLXByb2QubWVjZGV2aWNlLmF6dXJlLmNvbTo0NDMiLCJEYmVEZXZpY2VJZCI6bnVsbCwiUmVzb3VyY2VVbmlxdWVJZCI6IjEyMy1hYmMtMTIzIiwiU3Vic2NyaXB0aW9uSWQiOiJ4eHh4LTEyMzQteHh4eC0xMjM0IiwiUmVzb3VyY2VHcm91cE5hbWUiOiJzYW1wbGVSR25hbWUiLCJQcm92aWRlck5hbWVzcGFjZSI6Ik1pY3Jvc29mdC5IeWJyaWROZXR3b3JrIiwiUmVzb3VyY2VUeXBlIjoiRGV2aWNlcyIsIlJlc291cmNlVHlwZU5hbWUiOiJJREMtRGV2aWNlNC1XZXN0Q2VudHJhbCJ9 +``` + +Getting the registration key for NFM device in resource group myResources with resource name myMecDevice. +To register the device, use the commandlet Invoke-MecRegister with the registration key in the minishell session. + +### Example 2: Get-AzConnectedNetworkDeviceRegistrationKey using Resource Group, Resource name and Subscription Id +```powershell +Get-AzConnectedNetworkDeviceRegistrationKey -DeviceName myMecDevice -ResourceGroupName myResources -SubscriptionId xxxxx-00000-xxxxx-00000 +``` + +```output +eyJNZWNEZXZpY2VUcmFuc2llbnRBdXRoS2V5IjoiMTIzNCIsIk1lY0RldmljZUF1dGhLZXlTdGFydFRpbWUiOiIyMDIxLTExLTIyVDA5OjQ2OjQwLjY0ODExOTFaIiwiU2VydmljZUJ1c1F1ZXVlTmFtZSI6ImFiY2QtMTIzNCIsIkFBREVuZHBvaW50IjpudWxsLCJBQURBdWRpZW5jZSI6bnVsbCwiQXJtUmVzb3VyY2VJZCI6bnVsbCwiTWVjQ29udHJvbGxlckVuZHBvaW50IjoiaHR0cHM6Ly93ZXN0Y2VudHJhbHVzLXByb2QubWVjZGV2aWNlLmF6dXJlLmNvbTo0NDMiLCJEYmVEZXZpY2VJZCI6bnVsbCwiUmVzb3VyY2VVbmlxdWVJZCI6IjEyMy1hYmMtMTIzIiwiU3Vic2NyaXB0aW9uSWQiOiJ4eHh4LTEyMzQteHh4eC0xMjM0IiwiUmVzb3VyY2VHcm91cE5hbWUiOiJzYW1wbGVSR25hbWUiLCJQcm92aWRlck5hbWVzcGFjZSI6Ik1pY3Jvc29mdC5IeWJyaWROZXR3b3JrIiwiUmVzb3VyY2VUeXBlIjoiRGV2aWNlcyIsIlJlc291cmNlVHlwZU5hbWUiOiJJREMtRGV2aWNlNC1XZXN0Q2VudHJhbCJ9 +``` + +Getting the registration key for NFM device in resource group myResources with resource name myMecDevice. +To register the device, use the commandlet Invoke-MecRegister with the registration key in the minishell session. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +The name of the device resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkFunction.md b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkFunction.md new file mode 100644 index 0000000000..d47f1e11a0 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkFunction.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/get-azconnectednetworkfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkFunction.md +--- + +# Get-AzConnectedNetworkFunction + +## SYNOPSIS +Gets information about the specified network function resource. + +## SYNTAX + +### List (Default) +``` +Get-AzConnectedNetworkFunction [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzConnectedNetworkFunction -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzConnectedNetworkFunction -InputObject <IConnectedNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzConnectedNetworkFunction -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified network function resource. + +## EXAMPLES + +### Example 1: Get-AzConnectedNetworkFunction via Resource group and Resource name +```powershell +Get-AzConnectedNetworkFunction -Name myVnf -ResourceGroupName myResources +``` + +```output +ContainerConfiguration : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.NetworkFunctionPropertiesFormatNetworkFunctionContainerConfigurations +DeviceId : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMec +Etag : "0000a530-0000-3400-0000-615c10fa0000" +Id : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/networkFunctions/myVnf +Location : centraluseuap +ManagedApplicationId : +ManagedApplicationParameter : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.NetworkFunctionPropertiesFormatManagedApplicationParameters +Name : myVnf +ProvisioningState : Failed +ResourceGroupName : myResources +ServiceKey : 397a7415-ec52-46b5-892b-f840ba491aab +SkuName : mySku1 +SkuType : EvolvedPacketCore +SystemDataCreatedAt : 10/5/2021 8:45:49 AM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/5/2021 8:46:49 AM +SystemDataLastModifiedBy : xxxxx-11111-xxxxx-11111 +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20.TrackedResourceTags +Type : microsoft.hybridnetwork/networkfunctions +UserConfiguration : {hpehss} +VendorName : AffirmedVendor +VendorProvisioningState : NotProvisioned + +``` + +Getting information about the network function in resource group myResources with resource name myVnf. + +### Example 2: Get-AzConnectedNetworkFunction via Identity +```powershell +$vnf = @{ NetworkFunctionName = "myVnf1"; ResourceGroupName = "myResources"; SubscriptionId = "xxxxx-00000-xxxxx-00000"} +Get-AzConnectedNetworkFunction -InputObject $vnf +``` + +```output +ContainerConfiguration : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.NetworkFunctionPropertiesFormatNetworkFunctionContainerConfigurations +DeviceId : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMec1 +Etag : "sampleEtagValue" +Id : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/networkFunctions/myVnf1 +Location : eastus +ManagedApplicationId : +ManagedApplicationParameter : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.NetworkFunctionPropertiesFormatManagedApplicationParameters +Name : myVnf1 +ProvisioningState : Succeeded +ResourceGroupName : myResources +ServiceKey : aa11-bb22-cc33-dd44 +SkuName : mySku +SkuType : EvolvedPacketCore +SystemDataCreatedAt : 11/1/2021 11:13:57 AM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/15/2021 4:53:08 AM +SystemDataLastModifiedBy : xxxxx-11111-xxxxx-11111 +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20.TrackedResourceTags +Type : microsoft.hybridnetwork/networkfunctions +UserConfiguration : {hpehss} +VendorName : AffirmedVendor +VendorProvisioningState : Provisioned + +``` + +Creating an identity with NetworkFunctionName myVnf1, ResourceGroupName myResources and subscription. +Getting information about the network function using this identity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the network function resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: NetworkFunctionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.INetworkFunction + +## 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 `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkFunctionVendor.md b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkFunctionVendor.md new file mode 100644 index 0000000000..b045dbb727 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkFunctionVendor.md @@ -0,0 +1,102 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/get-azconnectednetworkfunctionvendor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkFunctionVendor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkFunctionVendor.md +--- + +# Get-AzConnectedNetworkFunctionVendor + +## SYNOPSIS +Lists all the available vendor and sku information. + +## SYNTAX + +``` +Get-AzConnectedNetworkFunctionVendor [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Lists all the available vendor and sku information. + +## EXAMPLES + +### Example 1: Get-AzConnectedNetworkFunctionVendor +```powershell +Get-AzConnectedNetworkFunctionVendor +``` + +```output +SkuList VendorName +------- ---------- +{vendor-sku, vendor-sku1, vendor-sku2, vendor-sku3, vendor-sku4, vendor-sku4, vendor-sku5...} myVendor +{vendor1-sku, vendor1-sku2} myVendor1 +{vendor2-sku1} myVendor2 +``` + +Getting information about the vendors and their skus + +### Example 2: Get-AzConnectedNetworkFunctionVendor via Subscription Id +```powershell +Get-AzConnectedNetworkFunctionVendor -SubscriptionId "xxxxx-00000-xxxxx-00000" +``` + +```output +SkuList VendorName +------- ---------- +{vendor1-sku, vendor1-sku2} myVendor1 +{vendor2-sku1} myVendor2 +``` + +Gets information about the vendors and their skus in the given subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.INetworkFunctionVendor + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendor.md b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendor.md new file mode 100644 index 0000000000..0c1c2556c3 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendor.md @@ -0,0 +1,185 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/get-azconnectednetworkvendor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkVendor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkVendor.md +--- + +# Get-AzConnectedNetworkVendor + +## SYNOPSIS +Gets information about the specified vendor. + +## SYNTAX + +### List (Default) +``` +Get-AzConnectedNetworkVendor [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzConnectedNetworkVendor -Name <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzConnectedNetworkVendor -InputObject <IConnectedNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified vendor. + +## EXAMPLES + +### Example 1: Get-AzConnectedNetworkVendor using vendor name +```powershell +Get-AzConnectedNetworkVendor -Name myVendor +``` + +```output +Id : /subscriptions/xxxxx-00000-xxxxx-00000/providers/Microsoft.HybridNetwork/vendors/myVendor +Name : myVendor +ProvisioningState : Succeeded +ResourceGroupName : +Sku : +SystemDataCreatedAt : 9/7/2021 3:02:02 AM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/7/2021 3:02:03 AM +SystemDataLastModifiedBy : xxxxx-11111-xxxxx-11111 +SystemDataLastModifiedByType : Application +Type : microsoft.hybridnetwork/vendors + +``` + +Getting information about the vendor with vendor name myVendor. + +### Example 2: Get-AzConnectedNetworkVendor using Identity +```powershell +$vendor = @{ VendorName = "myVendor1"; SubscriptionId = "xxxxx-00000-xxxxx-00000"} +Get-AzConnectedNetworkVendor -InputObject $vendor +``` + +```output +Id : /subscriptions/xxxxx-00000-xxxxx-00000/providers/Microsoft.HybridNetwork/vendors/myVendor1 +Name : myVendor1 +ProvisioningState : Succeeded +ResourceGroupName : +Sku : +SystemDataCreatedAt : 9/7/2021 3:02:02 AM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/7/2021 3:02:03 AM +SystemDataLastModifiedBy : xxxxx-11111-xxxxx-11111 +SystemDataLastModifiedByType : Application +Type : microsoft.hybridnetwork/vendors + +``` + +Creating an identity with VendorName myVendor1 and the given subscription. +Getting information about the vendor using this identity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: VendorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IVendor + +## 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 `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendorFunction.md b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendorFunction.md new file mode 100644 index 0000000000..65c083d32d --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendorFunction.md @@ -0,0 +1,241 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/get-azconnectednetworkvendorfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkVendorFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkVendorFunction.md +--- + +# Get-AzConnectedNetworkVendorFunction + +## SYNOPSIS +Gets information about the specified vendor network function. + +## SYNTAX + +### List (Default) +``` +Get-AzConnectedNetworkVendorFunction -LocationName <String> -VendorName <String> [-SubscriptionId <String[]>] + [-Filter <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzConnectedNetworkVendorFunction -LocationName <String> -ServiceKey <String> -VendorName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzConnectedNetworkVendorFunction -InputObject <IConnectedNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified vendor network function. + +## EXAMPLES + +### Example 1: Get-AzConnectedNetworkVendorFunction via Location Name, Service Key and Subscription +```powershell +Get-AzConnectedNetworkVendorFunction -LocationName centraluseuap -ServiceKey 1234-abcd-4321-dcba -SubscriptionId xxxx-3333-xxxx-3333 -VendorName myVendor +``` + +```output +Id : /subscriptions/xxxx-3333-xxxx-3333/providers/Microsoft.HybridNetwork/locations/centraluseuap/vendors/myVendor/networkfunctions/1b69005b-9168-4d74-a371-d4c4f6a521d + 0 +Name : 1234-abcd-4321-dcba +NetworkFunctionVendorConfiguration : {Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.SshPublicKey} +ProvisioningState : Succeeded +ResourceGroupName : +SkuName : mySku +SkuType : EvolvedPacketCore +SystemDataCreatedAt : 11/25/2021 2:04:28 PM +SystemDataCreatedBy : xxxxx-11111-xxxxx-11111 +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 11/25/2021 2:04:28 PM +SystemDataLastModifiedBy : xxxxx-11111-xxxxx-11111 +SystemDataLastModifiedByType : Application +Type : microsoft.hybridnetwork/locations/vendors/networkfunctions +VendorProvisioningState : NotProvisioned + +``` + +Getting the information of a vendor network function with service key 1234-abcd-4321-dcba, vendor name myVendor, location centraluseuap and subscription. +Service key can be obtained when getting details of network funcrtion or when creating a network function. + +### Example 2: Get-AzConnectedNetworkVendorFunction via Identity +```powershell +$vendorNF = @{ ServiceKey = "1234-abcd-4321-dcba"; VendorName = "myVendor"; LocationName = "centraluseuap"; SubscriptionId = "xxxx-3333-xxxx-3333"} +Get-AzConnectedNetworkVendorFunction -InputObject $vendorNF +``` + +```output +Id : /subscriptions/xxxx-3333-xxxx-3333/providers/Microsoft.HybridNetwork/locations/centraluseuap/vendors/myVendor/networkfunctions/1b69005b-9168-4d74-a371-d4c4f6a521d + 0 +Name : 1234-abcd-4321-dcba +NetworkFunctionVendorConfiguration : {Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.SshPublicKey} +ProvisioningState : Succeeded +ResourceGroupName : +SkuName : mySku +SkuType : EvolvedPacketCore +SystemDataCreatedAt : 11/25/2021 2:04:44 PM +SystemDataCreatedBy : xxxxx-11111-xxxxx-11111 +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 11/25/2021 2:36:28 PM +SystemDataLastModifiedBy : xxxxx-11111-xxxxx-11111 +SystemDataLastModifiedByType : Application +Type : microsoft.hybridnetwork/locations/vendors/networkfunctions +VendorProvisioningState : Provisioned + +``` + +Creating a identity with service key 1234-abcd-4321-dcba, vendor name myVendor, location centraluseuap and subscription. +Getting the information of a vendor network function using this identity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply on the operation. +The properties you can use for eq (equals) are: skuType, skuName and vendorProvisioningState. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LocationName +The Azure region where the network function resource was created by the customer. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceKey +The GUID for the vendor network function. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IVendorNetworkFunction + +## 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 `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendorFunctionRoleInstance.md b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendorFunctionRoleInstance.md new file mode 100644 index 0000000000..fd196ea3d0 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendorFunctionRoleInstance.md @@ -0,0 +1,230 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/get-azconnectednetworkvendorfunctionroleinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkVendorFunctionRoleInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkVendorFunctionRoleInstance.md +--- + +# Get-AzConnectedNetworkVendorFunctionRoleInstance + +## SYNOPSIS +Gets the information of role instance of vendor network function. + +## SYNTAX + +### List (Default) +``` +Get-AzConnectedNetworkVendorFunctionRoleInstance -LocationName <String> -ServiceKey <String> + -VendorName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzConnectedNetworkVendorFunctionRoleInstance -LocationName <String> -Name <String> -ServiceKey <String> + -VendorName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzConnectedNetworkVendorFunctionRoleInstance -InputObject <IConnectedNetworkIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the information of role instance of vendor network function. + +## EXAMPLES + +### Example 1: Get-AzConnectedNetworkVendorFunctionRoleInstance via Location, Service key, vendor name and role name +```powershell +Get-AzConnectedNetworkVendorFunctionRoleInstance -LocationName centraluseuap -ServiceKey 1234-abcd-4321-dcba -SubscriptionId xxxx-3333-xxxx-3333 -VendorName myVendor -Name hpehss +``` + +```output +Id : +Name : hpehss +OperationalState : Running +ProvisioningState : +ResourceGroupName : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : + +``` + +Getting the role instance information of role hpehss with Location centraluseuap, Service key 1234-abcd-4321-dcba and vendor name myVendor. + +### Example 2: Get-AzConnectedNetworkVendorFunctionRoleInstance via Identity +```powershell +$role = @{ RoleInstanceName = "hpehss"; LocationName = "centraluseuap"; SubscriptionId = "xxxx-3333-xxxx-3333"; VendorName = "myVendor"; serviceKey = "1234-abcd-4321-dcba"} +Get-AzConnectedNetworkVendorFunctionRoleInstance -InputObject $role +``` + +```output +Id : +Name : hpehss +OperationalState : Stopped +ProvisioningState : +ResourceGroupName : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : + +``` + +Getting the role instance information of role hpehss with Location centraluseuap, Service key 1234-abcd-4321-dcba, vendor name myVendor and the given subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LocationName +The Azure region where the network function resource was created by customer. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the role instance of the vendor network function. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RoleInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceKey +The GUID for the vendor network function. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IRoleInstance + +## 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 `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendorSku.md b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendorSku.md new file mode 100644 index 0000000000..5b3d7a1dea --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendorSku.md @@ -0,0 +1,200 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/get-azconnectednetworkvendorsku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkVendorSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkVendorSku.md +--- + +# Get-AzConnectedNetworkVendorSku + +## SYNOPSIS +Gets information about the specified sku. + +## SYNTAX + +### List (Default) +``` +Get-AzConnectedNetworkVendorSku -VendorName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzConnectedNetworkVendorSku -SkuName <String> -VendorName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzConnectedNetworkVendorSku -InputObject <IConnectedNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified sku. + +## EXAMPLES + +### Example 1: Get-AzConnectedNetworkVendorSku using Vendor name and Subscription Id +```powershell +Get-AzConnectedNetworkVendorSku -VendorName myVendor -SubscriptionId xxxxx-22222-xxxxx-22222 +``` + +```output +DeploymentMode : PrivateEdgeZone +Id : /subscriptions/xxxxx-22222-xxxxx-22222/providers/Microsoft.HybridNetwork/vendors/myVendor/VendorSkus/mySku +ManagedApplicationParameter : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.VendorSkuPropertiesFormatManagedApplicationParameters +ManagedApplicationTemplate : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.VendorSkuPropertiesFormatManagedApplicationTemplate +Name : mySku +NetworkFunctionTemplateNetworkFunctionRoleConfiguration : {Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.SshPublicKey} +NetworkFunctionType : +Preview : True +ProvisioningState : Succeeded +ResourceGroupName : +SkuType : EvolvedPacketCore +SystemDataCreatedAt : 11/4/2020 3:35:33 PM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/4/2020 3:43:58 PM +SystemDataLastModifiedBy : xxxxx-11111-xxxxx-11111 +SystemDataLastModifiedByType : Application +Type : Microsoft.HybridNetwork/vendors/VendorSkus + +DeploymentMode : PrivateEdgeZone +Id : /subscriptions/xxxxx-22222-xxxxx-22222/providers/Microsoft.HybridNetwork/vendors/myVendor/vendorskus/mySku_1 +ManagedApplicationParameter : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.VendorSkuPropertiesFormatManagedApplicationParameters +ManagedApplicationTemplate : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.VendorSkuPropertiesFormatManagedApplicationTemplate +Name : mySku_1 +NetworkFunctionTemplateNetworkFunctionRoleConfiguration : {Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.SshPublicKey} +NetworkFunctionType : +Preview : True +ProvisioningState : Failed +ResourceGroupName : +SkuType : EvolvedPacketCore +SystemDataCreatedAt : 11/11/2020 2:25:32 PM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/11/2020 2:25:32 PM +SystemDataLastModifiedBy : user@microsoft.com +SystemDataLastModifiedByType : User +Type : Microsoft.HybridNetwork/vendors/vendorskus +``` + +Fetching all the sku of vendor myVendor in the given subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SkuName +The name of the sku. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IVendorSku + +## 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 `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendorSkuPreview.md b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendorSkuPreview.md new file mode 100644 index 0000000000..3812c086e2 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Get-AzConnectedNetworkVendorSkuPreview.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/get-azconnectednetworkvendorskupreview +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkVendorSkuPreview.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Get-AzConnectedNetworkVendorSkuPreview.md +--- + +# Get-AzConnectedNetworkVendorSkuPreview + +## SYNOPSIS +Gets the preview information of a vendor sku. + +## SYNTAX + +### List (Default) +``` +Get-AzConnectedNetworkVendorSkuPreview -SkuName <String> -VendorName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzConnectedNetworkVendorSkuPreview -PreviewSubscription <String> -SkuName <String> -VendorName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzConnectedNetworkVendorSkuPreview -InputObject <IConnectedNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the preview information of a vendor sku. + +## EXAMPLES + +### Example 1: Get-AzConnectedNetworkVendorSkuPreview using sku name, vendor name and preview subscription +```powershell +Get-AzConnectedNetworkVendorSkuPreview -SkuName mySku -VendorName myVendor -PreviewSubscription xxxxx-22222-xxxxx-22222 +``` + +```output +Id : /subscriptions/xxxxx-00000-xxxxx-00000/providers/Microsoft.HybridNetwork/vendors/myVendor/vendorSkus/mySku/previewSubscriptions/xxxxx-22222-xxxxx-22222 +Name : xxxxx-22222-xxxxx-22222 +ProvisioningState : Succeeded +ResourceGroupName : +SystemDataCreatedAt : 11/24/2021 4:41:22 AM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/24/2021 4:41:22 AM +SystemDataLastModifiedBy : user@microsoft.com +SystemDataLastModifiedByType : User +Type : microsoft.hybridnetwork/vendors/vendorskus/previewsubscriptions + +``` + +Getting the preview information of a vendor sku mySku with vendor myVendor for the specified subscription. + +### Example 2: Get-AzConnectedNetworkVendorSkuPreview via Identity +```powershell +$skuPreview = @{ SkuName = "mySku"; VendorName = "myVendor"; PreviewSubscription = "xxxxx-22222-xxxxx-22222"; SubscriptionId = "xxxxx-00000-xxxxx-00000"} +Get-AzConnectedNetworkVendorSkuPreview -InputObject $skuPreview +``` + +```output +Id : /subscriptions/xxxxx-00000-xxxxx-00000/providers/Microsoft.HybridNetwork/vendors/myVendor/vendorSkus/mySku/previewSubscriptions/xxxxx-22222-xxxxx-22222 +Name : xxxxx-22222-xxxxx-22222 +ProvisioningState : Succeeded +ResourceGroupName : +SystemDataCreatedAt : 11/24/2021 4:41:22 AM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/24/2021 4:41:22 AM +SystemDataLastModifiedBy : user@microsoft.com +SystemDataLastModifiedByType : User +Type : microsoft.hybridnetwork/vendors/vendorskus/previewsubscriptions + +``` + +Creating a identity with SkuName mySku, VendorName myVendor, preview subscription and subscription id. +Getting the preview information of this vendor sku using this identity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PreviewSubscription +Preview subscription ID. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the vendor sku. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IPreviewSubscription + +## 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 `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkAzureStackEdgeObject.md b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkAzureStackEdgeObject.md new file mode 100644 index 0000000000..bdabf1912d --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkAzureStackEdgeObject.md @@ -0,0 +1,70 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.ConnectedNetwork/new-AzConnectedNetworkAzureStackEdgeObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkAzureStackEdgeObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkAzureStackEdgeObject.md +--- + +# New-AzConnectedNetworkAzureStackEdgeObject + +## SYNOPSIS +Create a in-memory object for AzureStackEdgeFormat + +## SYNTAX + +``` +New-AzConnectedNetworkAzureStackEdgeObject [-AzureStackEdgeId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for AzureStackEdgeFormat + +## EXAMPLES + +### Example 1: Create a in-memory stored AzureStackEdgeFormat object for creating the device +```powershell +New-AzConnectedNetworkAzureStackEdgeObject -AzureStackEdgeId "/subscriptions/xxxxx-00000-xxxxx-00000/resourcegroups/myResources/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/myAse1" +``` + +```output +eviceType ProvisioningState Status +---------- ----------------- ------ +AzureStackEdge +``` + +Create a in-memory stored AzureStackEdgeFormat object for creating the device + +## PARAMETERS + +### -AzureStackEdgeId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.AzureStackEdgeFormat + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkDevice.md b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkDevice.md new file mode 100644 index 0000000000..108488c7f5 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkDevice.md @@ -0,0 +1,276 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/new-azconnectednetworkdevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkDevice.md +--- + +# New-AzConnectedNetworkDevice + +## SYNOPSIS +Creates or updates a device. + +## SYNTAX + +``` +New-AzConnectedNetworkDevice -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-Property <IDevicePropertiesFormat>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a device. + +## EXAMPLES + +### Example 1: New-AzConnectedNetworkDevice +```powershell +$ase = New-AzConnectedNetworkAzureStackEdgeObject -AzureStackEdgeId "/subscriptions/xxxxx-00000-xxxxx-00000/resourcegroups/myResources/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/myAse" +New-AzConnectedNetworkDevice -Name "myMecDevice" -ResourceGroupName "myResources" -Location "eastus" -Property $ase +``` + +```output +DeviceType : AzureStackEdge +Id : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMecDevice +Location : eastus +Name : myMecDevice +NetworkFunction : +ProvisioningState : Succeeded +ResourceGroupName : myResources +Status : NotRegistered +SystemDataCreatedAt : 11/25/2021 4:47:45 AM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : myVendor +SystemDataLastModifiedAt : 11/25/2021 4:47:47 AM +SystemDataLastModifiedBy : xxxxx-11111-xxxxx-11111 +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20.TrackedResourceTags +Type : microsoft.hybridnetwork/devices + +``` + +Create a device with Device Name with resource myMecDevice name in Resource Group myResources, Location eastus with Ase Device Id /subscriptions/xxxxx-00000-xxxxx-00000/resourcegroups/myResources/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/myAse. + +### Example 2: New-AzConnectedNetworkDevice +```powershell +$ase = New-AzConnectedNetworkAzureStackEdgeObject -AzureStackEdgeId "/subscriptions/xxxxx-00000-xxxxx-00000/resourcegroups/myResources/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/myAse1" +New-AzConnectedNetworkDevice -Name "myMecDevice1" -ResourceGroupName "myResources" -Location "eastus2euap" -Property $ase -SubscriptionId xxxxx-00000-xxxxx-00000 +``` + +```output +DeviceType : AzureStackEdge +Id : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMecDevice1 +Location : eastus +Name : myMecDevice1 +NetworkFunction : +ProvisioningState : Succeeded +ResourceGroupName : myResources +Status : Registered +SystemDataCreatedAt : 11/25/2021 4:49:34 AM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : myVendor +SystemDataLastModifiedAt : 11/25/2021 4:57:47 AM +SystemDataLastModifiedBy : xxxxx-11111-xxxxx-11111 +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20.TrackedResourceTags +Type : microsoft.hybridnetwork/devices + +``` + +Create a device with Device Name myMecDevice1 in Resource Group myResources, Location eastus2euap, SubscriptionId and Ase Device Id /subscriptions/xxxxx-00000-xxxxx-00000/resourcegroups/myResources/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/myAse1. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name for the device resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeviceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +Device properties. +To construct, see NOTES section for PROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IDevicePropertiesFormat +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IDevice + +## 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 `<IDevicePropertiesFormat>`: Device properties. + - `DeviceType <DeviceType>`: The type of the device. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkFunction.md b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkFunction.md new file mode 100644 index 0000000000..08fb7453b3 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkFunction.md @@ -0,0 +1,371 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/new-azconnectednetworkfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkFunction.md +--- + +# New-AzConnectedNetworkFunction + +## SYNOPSIS +Creates or updates a network function resource. +This operation can take up to 6 hours to complete. +This is expected service behavior. + +## SYNTAX + +``` +New-AzConnectedNetworkFunction -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-ContainerConfiguration <Hashtable>] [-DeviceId <String>] [-Etag <String>] + [-ManagedApplicationParameter <Hashtable>] [-SkuName <String>] [-Tag <Hashtable>] + [-UserConfiguration <INetworkFunctionUserConfiguration[]>] [-VendorName <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a network function resource. +This operation can take up to 6 hours to complete. +This is expected service behavior. + +## EXAMPLES + +### Example 1: 1-step VNF deployment +```powershell +$ipconf1 = New-AzConnectedNetworkInterfaceIPConfigurationObject -IPAllocationMethod "Dynamic" -IPVersion "IPv4" +$ipconf2 = New-AzConnectedNetworkInterfaceIPConfigurationObject -IPAllocationMethod "Dynamic" -IPVersion "IPv4" +$ip1 = New-AzConnectedNetworkInterfaceObject -IPConfiguration $ipconf1 -Name "mrmmanagementnic1" -VMSwitchType "Management" +$ip2 = New-AzConnectedNetworkInterfaceObject -IPConfiguration $ipconf2 -Name "mrmlannic1" -VMSwitchType "Lan" +$customData = "I2Nsb3VkLWNvbmZpZwp3cml0ZV9maWxlczoKLSBwYXRoOiAvdmFyL2xpYi9jbG91ZC9paHNzY29uZmlnLmpzb24KICBwZXJtaXNzaW9uczogJzA2NDQnCiAgb3duZXI6IHJvb3Q6cm9vdAogIGNvbnRlbnQ6IHwKICAgIHsKICAgICAgICAgICAiRGlhbWV0ZXJHVyI6ewogICAgICAgICAgICAgICAgICAiSE9TVElQQUREUkVTUyI6IjEyOC4wLjAuMSIsCiAgICAgICAgICAgICAgICAgICJGUUROIjoiaHNzLmF5VmVuZG9yLmNvbSIsCiAgICAgICAgICAgICAgICAgICJSRUFMTSI6Imhzcy5lcGMubXlWZW5kb3I5OS5teVZlbmRvci4zZ3BwbmV0d29yay5vcmciCiAgICAgICAgICAgfSwKICAgICAgICAgICAiREdXQmluZEFkZHIiOnsKICAgICAgICAgICAgICAgICAgIkFERFJFU1MiOiIxMjguMC4wLjIiLAogICAgICAgICAgICAgICAgICAiVFJBTlNQT1JUIjoiU0NUUCIsCiAgICAgICAgICAgICAgICAgICJQT1JUIjozODY4CiAgICAgICAgICAgfSwKICAgICAgICAgICAiU05NUFRhcmdldCI6ewogICAgICAgICAgICAgICAgICAiSE9TVCI6IjEyOC4wLjAuMyIsCiAgICAgICAgICAgICAgICAgICJQT1JUIjoiMTYyIiwKICAgICAgICAgICAgICAgICAgIlRSSUdHRVJfTEVWRUwiOiIzIgogICAgICAgICAgIH0sCiAgICAgICAgICAgIk1hbmFnZW1lbnQiOnsKICAgICAgICAgICAgICAgICAgImlwQWRkcmVzcyI6IjEyOC4wLjAuNCIsCiAgICAgICAgICAgICAgICAgICJzdWJuZXQiOiIxMjguMC4wLjEvMjQiLAogICAgICAgICAgICAgICAgICAiZ2F0ZXdheSI6IjEyOC4wLjAuMCIKICAgICAgICAgICB9LAogICAgICAgICAgICJMYW4iOnsKICAgICAgICAgICAgICAgICAgImlwQWRkcmVzcyI6IjEyOC4wLjAuNSIsCiAgICAgICAgICAgICAgICAgICJzdWJuZXQiOiIxMjguMC4wLjAvMjQiLAogICAgICAgICAgICAgICAgICAiZ2F0ZXdheSI6IjEyOC4wLjAuMCIKICAgICAgICAgICB9LAoKICAgIH0JCSAgCg==" +$userconf = New-AzConnectedNetworkFunctionUserConfigurationObject -NetworkInterface $ip1,$ip2 -OSProfileCustomData $customData -RoleName "hpehss" +New-AzConnectedNetworkFunction -Name vnf_Test1 -ResourceGroupName myResources -Location "eastus" -DeviceId /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/mec_2111_020 -SkuName Affirmed-HSS-0527 -UserConfiguration $userconf -VendorName "AffirmedVendor" +``` + +```output +Location Name Etag ResourceGroupName +-------- ---- ---- ----------------- +eastus vnf_Test1 "SampleEtagvalue" myResources +``` + +Creating network interfaces with dynamic method allocation and ip version to IPv4. +And using these to create two network configuration objects with vm switch type. +Then using that to create user configuration object with role name hpehss, custom data and network interface array. +Then creating NF using userconfiguration, vendor name, sku name, device name etc. + +### Example 2: 2-step VNF deployment +```powershell +$ipconf1 = New-AzConnectedNetworkInterfaceIPConfigurationObject -IPAllocationMethod "Dynamic" -IPVersion "IPv4" +$ipconf2 = New-AzConnectedNetworkInterfaceIPConfigurationObject -IPAllocationMethod "Dynamic" -IPVersion "IPv4" +$ip1 = New-AzConnectedNetworkInterfaceObject -IPConfiguration $ipconf1 -Name "mrmmanagementnic1" -VMSwitchType "Management" +$ip2 = New-AzConnectedNetworkInterfaceObject -IPConfiguration $ipconf2 -Name "mrmlannic1" -VMSwitchType "Lan" +$userconfig2 = New-AzConnectedNetworkFunctionUserConfigurationObject -NetworkInterface $ip1,$ip2 -RoleName "hpehss" +$vnf1 = New-AzConnectedNetworkFunction -Name vnftest11 -DeviceId /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/mec_autotest_01 -ResourceGroupName myResources -SubscriptionId xxxxx-00000-xxxxx-00000 -Location eastus2euap -SkuName staticSku -VendorName hssvendor01 -UserConfiguration $userconfig2 -verbose +$v2.ServiceKey +``` + +```output +abcd-sample-service-key-val-1234 +``` + +Same as 1 step workflow other than no custom data field in User Configuration object. +Creating a NF and will be using the service key obtained here to deploy vendor NF. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerConfiguration +The network function container configurations from the user. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +A unique read-only string that changes whenever the resource is updated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedApplicationParameter +The parameters for the managed application. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name for the network function resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: NetworkFunctionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The sku name for the network function. +Once set, it cannot be updated. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserConfiguration +The network function configurations from the user. +To construct, see NOTES section for USERCONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.INetworkFunctionUserConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The vendor name for the network function. +Once set, it cannot be updated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.INetworkFunction + +## 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. + + +USERCONFIGURATION <INetworkFunctionUserConfiguration[]>: The network function configurations from the user. + - `[NetworkInterface <INetworkInterface[]>]`: The network interface configuration. + - `[IPConfiguration <INetworkInterfaceIPConfiguration[]>]`: A list of IP configurations of the network interface. + - `[DnsServer <String[]>]`: The list of DNS servers IP addresses. + - `[Gateway <String>]`: The value of the gateway. + - `[IPAddress <String>]`: The value of the IP address. + - `[IPAllocationMethod <IPAllocationMethod?>]`: IP address allocation method. + - `[IPVersion <IPVersion?>]`: IP address version. + - `[Subnet <String>]`: The value of the subnet. + - `[MacAddress <String>]`: The MAC address of the network interface. + - `[Name <String>]`: The name of the network interface. + - `[VMSwitchType <VMSwitchType?>]`: The type of the VM switch. + - `[OSProfileCustomData <String>]`: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property** This property cannot be updated after the VM is created. customData is passed to the VM to be saved as a file. For more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/) For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](/azure/virtual-machines/linux/using-cloud-init) + - `[RoleName <String>]`: The name of the network function role. + - `[UserDataParameter <IAny>]`: The user data parameters from the customer. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkFunctionRoleConfigurationObject.md b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkFunctionRoleConfigurationObject.md new file mode 100644 index 0000000000..21ede13698 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkFunctionRoleConfigurationObject.md @@ -0,0 +1,452 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.ConnectedNetwork/new-AzConnectedNetworkFunctionRoleConfigurationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkFunctionRoleConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkFunctionRoleConfigurationObject.md +--- + +# New-AzConnectedNetworkFunctionRoleConfigurationObject + +## SYNOPSIS +Create a in-memory object for NetworkFunctionRoleConfiguration + +## SYNTAX + +``` +New-AzConnectedNetworkFunctionRoleConfigurationObject [-CustomProfileMetadataConfigurationPath <String>] + [-ImageReferenceExactVersion <String>] [-ImageReferenceOffer <String>] [-ImageReferencePublisher <String>] + [-ImageReferenceSku <String>] [-ImageReferenceVersion <String>] [-NetworkInterface <INetworkInterface[]>] + [-OSDiskName <String>] [-OSDiskOstype <OperatingSystemTypes>] [-OSDiskSizeGb <Int32>] + [-OSProfileAdminUsername <String>] [-OSProfileCustomData <String>] [-OSProfileCustomDataRequired <Boolean>] + [-RoleName <String>] [-RoleType <NetworkFunctionRoleConfigurationType>] [-SshPublicKey <ISshPublicKey[]>] + [-StorageProfileDataDisk <IDataDisk[]>] [-UserDataParameter <IAny>] [-UserDataTemplate <IAny>] + [-VhdUri <String>] [-VirtualMachineSize <VirtualMachineSizeTypes>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for NetworkFunctionRoleConfiguration + +## EXAMPLES + +### Example 1: New-AzConnectedNetworkFunctionUserConfigurationObject +```powershell +$ipconf1 = New-AzConnectedNetworkInterfaceIPConfigurationObject -IPAllocationMethod "Dynamic" -IPVersion "IPv4" +$ipconf2 = New-AzConnectedNetworkInterfaceIPConfigurationObject -IPAllocationMethod "Dynamic" -IPVersion "IPv4" +$ip1 = New-AzConnectedNetworkInterfaceObject -IPConfiguration $ipconf1 -Name "mrmmanagementnic1" -VMSwitchType "Management" +$ip2 = New-AzConnectedNetworkInterfaceObject -IPConfiguration $ipconf2 -Name "mrmlannic1" -VMSwitchType "Lan" +$keyData = @{keyData = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCyMpVbBgu0kftv1k+z1c3NtcB5CVDoo/X9X1LE2JUjlLlo0luEkFGJk61i53BhiTSTeRmQXN8hAZ7sn4MDUmZK7fWcHouZ2fsJo+ehses3wQPLubWBFw2L/hoSTyXifXMbEBu9SxHgqf1CEKQcvdNiWf4U7npXwjweXW9DtsF5E7h4kxhKJKFI4sNFTIX0IwUB15QEVHoBs92kDwH3fBH3kZZCMBJE/u6kT+XB22crRKkIGlp3a9gcogtOCvP+3xmsP7hjw5+nHxMUwkc/6kYyfTeLwvfI4xrTWpnB5xufts5LW5/U5GOXVg97ix9EXgiV0czThowG5K2xQ649UlJb"; path = $Null} +$key = @( $keyData) +$role = New-AzConnectedNetworkFunctionRoleConfigurationObject -NetworkInterface $ip1,$ip2 -OSDiskName Disk1 -OSDiskOstype Linux -OSDiskSizeGb 40 -OSProfileCustomDataRequired $False -OSProfileAdminUsername MecUser -RoleName hpehss -RoleType VirtualMachine -VirtualMachineSize "Standard_D3_v2" -SshPublicKey $key -StorageProfileDataDisk $storage -VhdUri "https://mecvdrvhd.blob.core.windows/myvhd.vhd" +``` + +```output +RoleName RoleType VirtualMachineSize +-------- -------- ------------------ +hpehss VirtualMachine Standard_D3_v2 + +``` + +Creating 2 ip configuration objects (ipconf1 and ipconf2) with dynamic allocation method and IPv4. +Using these to create network interface objects with ipconfiguration $ipconf1 and $ipconf2, interface name as mrmmanagementnic1 and mrmlannic1 and switch type as management and lan, respectively. +Storing the os profile key Data in key array. +And creating network function user configuration object from the network interface objects, key data and role name hpehss. + +## PARAMETERS + +### -CustomProfileMetadataConfigurationPath +Path for metadata configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceExactVersion +Specifies in decimal numbers, the exact version of image used to create the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceOffer +Specifies the offer of the image used to create the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferencePublisher +The image publisher. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceSku +The image SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceVersion +Specifies the version of the image used to create the virtual machine. +The allowed formats are Major.Minor.Build or 'latest'. +Major, Minor, and Build are decimal numbers. +Specify 'latest' to use the latest version of an image available at deploy time. +Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterface +The network interface configurations. +To construct, see NOTES section for NETWORKINTERFACE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.INetworkInterface[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSDiskName +The VHD name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSDiskOstype +The OS type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Support.OperatingSystemTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSDiskSizeGb +Specifies the size of os disk in gigabytes. +This is the fully expanded disk size needed of the VHD image on the ASE. +This disk size should be greater than the size of the VHD provided in vhdUri. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSProfileAdminUsername +Specifies the name of the administrator account. + + + **Windows-only restriction:** Cannot end in "." + + **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". + + + **Minimum-length (Linux):** 1 character + + **Max-length (Linux):** 64 characters + + **Max-length (Windows):** 20 characters + +\<li\> For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://learn.microsoft.com/azure/virtual-machines/linux/use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) +\<li\> For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://learn.microsoft.com/azure/virtual-machines/linux/usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSProfileCustomData +Specifies a base-64 encoded string of custom data. +The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. +The maximum length of the binary array is 65535 bytes. + + + **Note: Do not pass any secrets or passwords in customData property** + + This property cannot be updated after the VM is created. + + + customData is passed to the VM to be saved as a file. +For more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/) + + For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSProfileCustomDataRequired +Indicates if custom data is required to deploy this role. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleName +The name of the network function role. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleType +Role type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Support.NetworkFunctionRoleConfigurationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshPublicKey +The list of SSH public keys used to authenticate with linux based VMs. +To construct, see NOTES section for SSHPUBLICKEY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.ISshPublicKey[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageProfileDataDisk +Specifies the parameters that are used to add a data disk to a virtual machine. +To construct, see NOTES section for STORAGEPROFILEDATADISK properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IDataDisk[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserDataParameter +The user parameters for customers. +The format of user data parameters has to be matched with the provided user data template. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IAny +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserDataTemplate +The user data template for customers. +This is a json schema template describing the format and data type of user data parameters. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IAny +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VhdUri +Specifies the virtual hard disk's uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineSize +The size of the virtual machine. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Support.VirtualMachineSizeTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.NetworkFunctionRoleConfiguration + +## 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. + + +NETWORKINTERFACE <INetworkInterface[]>: The network interface configurations. + - `[IPConfiguration <INetworkInterfaceIPConfiguration[]>]`: A list of IP configurations of the network interface. + - `[DnsServer <String[]>]`: The list of DNS servers IP addresses. + - `[Gateway <String>]`: The value of the gateway. + - `[IPAddress <String>]`: The value of the IP address. + - `[IPAllocationMethod <IPAllocationMethod?>]`: IP address allocation method. + - `[IPVersion <IPVersion?>]`: IP address version. + - `[Subnet <String>]`: The value of the subnet. + - `[MacAddress <String>]`: The MAC address of the network interface. + - `[Name <String>]`: The name of the network interface. + - `[VMSwitchType <VMSwitchType?>]`: The type of the VM switch. + +SSHPUBLICKEY <ISshPublicKey[]>: The list of SSH public keys used to authenticate with linux based VMs. + - `[KeyData <String>]`: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://learn.microsoft.com/azure/virtual-machines/linux/mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). + - `[Path <String>]`: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys + +STORAGEPROFILEDATADISK <IDataDisk[]>: Specifies the parameters that are used to add a data disk to a virtual machine. + - `[CreateOption <DiskCreateOptionTypes?>]`: Specifies how the virtual machine should be created. + - `[DiskSizeGb <Int32?>]`: Specifies the size of an empty disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. + - `[Name <String>]`: The name of data disk. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkFunctionUserConfigurationObject.md b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkFunctionUserConfigurationObject.md new file mode 100644 index 0000000000..2489a90696 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkFunctionUserConfigurationObject.md @@ -0,0 +1,148 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.ConnectedNetwork/new-AzConnectedNetworkFunctionUserConfigurationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkFunctionUserConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkFunctionUserConfigurationObject.md +--- + +# New-AzConnectedNetworkFunctionUserConfigurationObject + +## SYNOPSIS +Create a in-memory object for NetworkFunctionUserConfiguration + +## SYNTAX + +``` +New-AzConnectedNetworkFunctionUserConfigurationObject [-NetworkInterface <INetworkInterface[]>] + [-OSProfileCustomData <String>] [-RoleName <String>] [-UserDataParameter <IAny>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for NetworkFunctionUserConfiguration + +## EXAMPLES + +### Example 1: New-AzConnectedNetworkFunction +```powershell +$ipconf1 = New-AzConnectedNetworkInterfaceIPConfigurationObject -IPAllocationMethod "Dynamic" -IPVersion "IPv4" +$ip1 = New-AzConnectedNetworkInterfaceObject -IPConfiguration $ipconf1 -Name "mrmmanagementnic1" -VMSwitchType "Management" +$ipconf2 = New-AzConnectedNetworkInterfaceIPConfigurationObject -IPAllocationMethod "Dynamic" -IPVersion "IPv4" +$ip2 = New-AzConnectedNetworkInterfaceObject -IPConfiguration $ipconf2 -Name "mrmlannic1" -VMSwitchType "LAN" +$customData = "I2Nsb3VkLWNvbmZpZwp3cml0ZV9maWxlczoKLSBwYXRoOiAvdmFyL2xpYi9jbG91ZC9paHNzY29uZmlnLmpzb24KICBwZXJtaXNzaW9uczogJzA2NDQnCiAgb3duZXI6IHJvb3Q6cm9vdAogIGNvbnRlbnQ6IHwKICAgIHsKICAgICAgICAgICAiRGlhbWV0ZXJHVyI6ewogICAgICAgICAgICAgICAgICAiSE9TVElQQUREUkVTUyI6IjEyOC4wLjAuMSIsCiAgICAgICAgICAgICAgICAgICJGUUROIjoiaHNzLmF5VmVuZG9yLmNvbSIsCiAgICAgICAgICAgICAgICAgICJSRUFMTSI6Imhzcy5lcGMubXlWZW5kb3I5OS5teVZlbmRvci4zZ3BwbmV0d29yay5vcmciCiAgICAgICAgICAgfSwKICAgICAgICAgICAiREdXQmluZEFkZHIiOnsKICAgICAgICAgICAgICAgICAgIkFERFJFU1MiOiIxMjguMC4wLjIiLAogICAgICAgICAgICAgICAgICAiVFJBTlNQT1JUIjoiU0NUUCIsCiAgICAgICAgICAgICAgICAgICJQT1JUIjozODY4CiAgICAgICAgICAgfSwKICAgICAgICAgICAiU05NUFRhcmdldCI6ewogICAgICAgICAgICAgICAgICAiSE9TVCI6IjEyOC4wLjAuMyIsCiAgICAgICAgICAgICAgICAgICJQT1JUIjoiMTYyIiwKICAgICAgICAgICAgICAgICAgIlRSSUdHRVJfTEVWRUwiOiIzIgogICAgICAgICAgIH0sCiAgICAgICAgICAgIk1hbmFnZW1lbnQiOnsKICAgICAgICAgICAgICAgICAgImlwQWRkcmVzcyI6IjEyOC4wLjAuNCIsCiAgICAgICAgICAgICAgICAgICJzdWJuZXQiOiIxMjguMC4wLjEvMjQiLAogICAgICAgICAgICAgICAgICAiZ2F0ZXdheSI6IjEyOC4wLjAuMCIKICAgICAgICAgICB9LAogICAgICAgICAgICJMYW4iOnsKICAgICAgICAgICAgICAgICAgImlwQWRkcmVzcyI6IjEyOC4wLjAuNSIsCiAgICAgICAgICAgICAgICAgICJzdWJuZXQiOiIxMjguMC4wLjAvMjQiLAogICAgICAgICAgICAgICAgICAiZ2F0ZXdheSI6IjEyOC4wLjAuMCIKICAgICAgICAgICB9LAoKICAgIH0JCSAgCg==" +$userconf = New-AzConnectedNetworkFunctionUserConfigurationObject -NetworkInterface $ip1,$ip2 -OSProfileCustomData $customData -RoleName "hpehss" +``` + +Creating network interfaces with dynamic method allocation and ip version to IPv4. +And using these to create two network configuration objects with vm switch type. +Then using that to create user configuration object with role name hpehss, custom data and network interface array. + +## PARAMETERS + +### -NetworkInterface +The network interface configuration. +To construct, see NOTES section for NETWORKINTERFACE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.INetworkInterface[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSProfileCustomData +Specifies a base-64 encoded string of custom data. +The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. +The maximum length of the binary array is 65535 bytes. + + + **Note: Do not pass any secrets or passwords in customData property** + + This property cannot be updated after the VM is created. + + + customData is passed to the VM to be saved as a file. +For more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/) + + For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](/azure/virtual-machines/linux/using-cloud-init). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleName +The name of the network function role. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserDataParameter +The user data parameters from the customer. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IAny +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.NetworkFunctionUserConfiguration + +## 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. + + +NETWORKINTERFACE <INetworkInterface[]>: The network interface configuration. + - `[IPConfiguration <INetworkInterfaceIPConfiguration[]>]`: A list of IP configurations of the network interface. + - `[DnsServer <String[]>]`: The list of DNS servers IP addresses. + - `[Gateway <String>]`: The value of the gateway. + - `[IPAddress <String>]`: The value of the IP address. + - `[IPAllocationMethod <IPAllocationMethod?>]`: IP address allocation method. + - `[IPVersion <IPVersion?>]`: IP address version. + - `[Subnet <String>]`: The value of the subnet. + - `[MacAddress <String>]`: The MAC address of the network interface. + - `[Name <String>]`: The name of the network interface. + - `[VMSwitchType <VMSwitchType?>]`: The type of the VM switch. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkFunctionVendorConfigurationObject.md b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkFunctionVendorConfigurationObject.md new file mode 100644 index 0000000000..5742b37ca0 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkFunctionVendorConfigurationObject.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.ConnectedNetwork/new-AzConnectedNetworkFunctionVendorConfigurationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkFunctionVendorConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkFunctionVendorConfigurationObject.md +--- + +# New-AzConnectedNetworkFunctionVendorConfigurationObject + +## SYNOPSIS +Create a in-memory object for NetworkFunctionVendorConfiguration + +## SYNTAX + +``` +New-AzConnectedNetworkFunctionVendorConfigurationObject [-NetworkInterface <INetworkInterface[]>] + [-OSProfileAdminUsername <String>] [-OSProfileCustomData <String>] [-OSProfileCustomDataRequired <Boolean>] + [-RoleName <String>] [-SshPublicKey <ISshPublicKey[]>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for NetworkFunctionVendorConfiguration + +## EXAMPLES + +### Example 1: New-AzConnectedNetworkFunctionVendorConfigurationObject +```powershell +$ipconf1 = New-AzConnectedNetworkInterfaceIPConfigurationObject -IPAllocationMethod "Dynamic" -IPVersion "IPv4" +$ipconf2 = New-AzConnectedNetworkInterfaceIPConfigurationObject -IPAllocationMethod "Dynamic" -IPVersion "IPv4" +$ip1 = New-AzConnectedNetworkInterfaceObject -IPConfiguration $ipconf1 -Name "mrmmanagementnic1" -VMSwitchType "Management" +$ip2 = New-AzConnectedNetworkInterfaceObject -IPConfiguration $ipconf2 -Name "mrmlannic1" -VMSwitchType "Lan" +$keyData = @{keyData = "ssh-rsa\AAAAB3NzaC1yc2EAAAADAQABAAABAQCyMpVbBgu0kftv1k+z1c3NtcB5CVDoo/X9X1LE2JUjlLlo0luEkFGJk61i53BhiTSTeRmQXN8hAZ7sn4MDUmZK7fWcHouZ2fsJo+ehses3wQPLubWBFw2L/hoSTyXifXMbEBu9SxHgqf1CEKQcvdNiWf4U7npXwjweXW9DtsF5E7h4kxhKJKFI4sNFTIX0IwUB15QEVHoBs92kDwH3fBH3kZZCMBJE/u6kT+XB22crRKkIGlp3a9gcogtOCvP+3xmsP7hjw5+nHxMUwkc/6kYyfTeLwvfI4xrTWpnB5xufts5LW5/U5GOXVg97ix9EXgiV0czThowG5K2xQ649UlJb redmond\userk@n1-azuredev1"; path = $Null} +$keys = @{ } +$key += $keyData +$vendorconf = New-AzConnectedNetworkFunctionVendorConfigurationObject -NetworkInterface $ip1,$ip2 -RoleName hpehss -OSProfileAdminUsername MecUser -OSProfileCustomData $customData -OSProfileCustomDataRequired $True -SshPublicKey $key +``` + +Creating network interfaces with dynamic method allocation and ip version to IPv4. +And using these to create two network configuration objects with vm switch type. +Creating a ssh key identity, Then using those to create vendor configuration object with role name hpehss, custom data, keyData and network interface array, which will be used in vendor NF creation. + +## PARAMETERS + +### -NetworkInterface +The network interface configurations. +To construct, see NOTES section for NETWORKINTERFACE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.INetworkInterface[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSProfileAdminUsername +Specifies the name of the administrator account. + + + **Windows-only restriction:** Cannot end in "." + + **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". + + + **Minimum-length (Linux):** 1 character + + **Max-length (Linux):** 64 characters + + **Max-length (Windows):** 20 characters + +\<li\> For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](/azure/virtual-machines/linux/use-root-privileges) +\<li\> For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](/azure/virtual-machines/linux/usernames). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSProfileCustomData +Specifies a base-64 encoded string of custom data. +The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. +The maximum length of the binary array is 65535 bytes. + + + **Note: Do not pass any secrets or passwords in customData property** + + This property cannot be updated after the VM is created. + + + customData is passed to the VM to be saved as a file. +For more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/) + + For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](/azure/virtual-machines/linux/using-cloud-init). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSProfileCustomDataRequired +Indicates if custom data is required to deploy this role. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleName +The name of the vendor network function role. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshPublicKey +The list of SSH public keys used to authenticate with linux based VMs. +To construct, see NOTES section for SSHPUBLICKEY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.ISshPublicKey[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.NetworkFunctionVendorConfiguration + +## 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. + + +NETWORKINTERFACE <INetworkInterface[]>: The network interface configurations. + - `[IPConfiguration <INetworkInterfaceIPConfiguration[]>]`: A list of IP configurations of the network interface. + - `[DnsServer <String[]>]`: The list of DNS servers IP addresses. + - `[Gateway <String>]`: The value of the gateway. + - `[IPAddress <String>]`: The value of the IP address. + - `[IPAllocationMethod <IPAllocationMethod?>]`: IP address allocation method. + - `[IPVersion <IPVersion?>]`: IP address version. + - `[Subnet <String>]`: The value of the subnet. + - `[MacAddress <String>]`: The MAC address of the network interface. + - `[Name <String>]`: The name of the network interface. + - `[VMSwitchType <VMSwitchType?>]`: The type of the VM switch. + +SSHPUBLICKEY <ISshPublicKey[]>: The list of SSH public keys used to authenticate with linux based VMs. + - `[KeyData <String>]`: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](/azure/virtual-machines/linux/mac-create-ssh-keys). + - `[Path <String>]`: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkInterfaceIPConfigurationObject.md b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkInterfaceIPConfigurationObject.md new file mode 100644 index 0000000000..989cbcdc55 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkInterfaceIPConfigurationObject.md @@ -0,0 +1,147 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.ConnectedNetwork/new-AzConnectedNetworkInterfaceIPConfigurationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkInterfaceIPConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkInterfaceIPConfigurationObject.md +--- + +# New-AzConnectedNetworkInterfaceIPConfigurationObject + +## SYNOPSIS +Create a in-memory object for NetworkInterfaceIPConfiguration + +## SYNTAX + +``` +New-AzConnectedNetworkInterfaceIPConfigurationObject [-DnsServer <String[]>] [-Gateway <String>] + [-IPAddress <String>] [-IPAllocationMethod <IPAllocationMethod>] [-IPVersion <IPVersion>] [-Subnet <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for NetworkInterfaceIPConfiguration + +## EXAMPLES + +### Example 1: Create a in-memory object for NetworkInterfaceIPConfiguration +```powershell +New-AzConnectedNetworkInterfaceIPConfigurationObject -IPAllocationMethod "Dynamic" -IPVersion "IPv4" +``` + +```output +DnsServer Gateway IPAddress IPAllocationMethod IPVersion Subnet +--------- ------- --------- ------------------ --------- ------ + Dynamic IPv4 +``` + +Create a in-memory object for NetworkInterfaceIPConfiguration + +## PARAMETERS + +### -DnsServer +The list of DNS servers IP addresses. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Gateway +The value of the gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddress +The value of the IP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAllocationMethod +IP address allocation method. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Support.IPAllocationMethod +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPVersion +IP address version. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Support.IPVersion +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +The value of the subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.NetworkInterfaceIPConfiguration + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkInterfaceObject.md b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkInterfaceObject.md new file mode 100644 index 0000000000..a4021deec5 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkInterfaceObject.md @@ -0,0 +1,130 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.ConnectedNetwork/new-AzConnectedNetworkInterfaceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkInterfaceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkInterfaceObject.md +--- + +# New-AzConnectedNetworkInterfaceObject + +## SYNOPSIS +Create a in-memory object for NetworkInterface + +## SYNTAX + +``` +New-AzConnectedNetworkInterfaceObject [-IPConfiguration <INetworkInterfaceIPConfiguration[]>] + [-MacAddress <String>] [-Name <String>] [-VMSwitchType <VMSwitchType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for NetworkInterface + +## EXAMPLES + +### Example 1: Create a in-memory object for NetworkInterface +```powershell +New-AzConnectedNetworkInterfaceObject -IPConfiguration $ipconf1 -Name "mrmmanagementnic1" -VMSwitchType "Management" +``` + +```output +MacAddress Name VMSwitchType +---------- ---- ------------ + mrmmanagementnic1 Management +``` + +Create a in-memory object for NetworkInterface + +## PARAMETERS + +### -IPConfiguration +A list of IP configurations of the network interface. +To construct, see NOTES section for IPCONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.INetworkInterfaceIPConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MacAddress +The MAC address of the network interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the network interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMSwitchType +The type of the VM switch. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Support.VMSwitchType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.NetworkInterface + +## 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. + + +IPCONFIGURATION <INetworkInterfaceIPConfiguration[]>: A list of IP configurations of the network interface. + - `[DnsServer <String[]>]`: The list of DNS servers IP addresses. + - `[Gateway <String>]`: The value of the gateway. + - `[IPAddress <String>]`: The value of the IP address. + - `[IPAllocationMethod <IPAllocationMethod?>]`: IP address allocation method. + - `[IPVersion <IPVersion?>]`: IP address version. + - `[Subnet <String>]`: The value of the subnet. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkVendor.md b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkVendor.md new file mode 100644 index 0000000000..353f01feb6 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkVendor.md @@ -0,0 +1,193 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/new-azconnectednetworkvendor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkVendor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkVendor.md +--- + +# New-AzConnectedNetworkVendor + +## SYNOPSIS +Creates or updates a vendor. + +## SYNTAX + +``` +New-AzConnectedNetworkVendor -Name <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a vendor. + +## EXAMPLES + +### Example 1: New-AzConnectedNetworkVendor +```powershell +New-AzConnectedNetworkVendor -Name myVendor +``` + +```output +Id : /subscriptions/xxxxx-00000-xxxxx-00000/providers/Microsoft.HybridNetwork/vendors/myVendor +Name : myVendor +ProvisioningState : Succeeded +ResourceGroupName : +Sku : +SystemDataCreatedAt : 11/23/2021 6:18:55 PM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/23/2021 6:19:08 PM +SystemDataLastModifiedBy : xxxxx-11111-xxxxx-11111 +SystemDataLastModifiedByType : Application +Type : microsoft.hybridnetwork/vendors +``` + +Creating a vendor with name myVendor. + +### Example 2: New-AzConnectedNetworkVendor with SubscriptionId +```powershell +New-AzConnectedNetworkVendor -Name myVendor2 -SubscriptionId xxxxx-22222-xxxxx-22222 +``` + +```output +Id : /subscriptions/xxxxx-22222-xxxxx-22222/providers/Microsoft.HybridNetwork/vendors/myVendor2 +Name : myVendor2 +ProvisioningState : Succeeded +ResourceGroupName : +Sku : +SystemDataCreatedAt : 11/23/2021 6:20:28 PM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/23/2021 6:20:32 PM +SystemDataLastModifiedBy : xxxxx-11111-xxxxx-11111 +SystemDataLastModifiedByType : Application +Type : microsoft.hybridnetwork/vendors +``` + +Creating a vendor with name myVendor2 in xxxxx-22222-xxxxx-22222 subscription. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VendorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IVendor + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkVendorFunction.md b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkVendorFunction.md new file mode 100644 index 0000000000..2ab2b08e41 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkVendorFunction.md @@ -0,0 +1,275 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/new-azconnectednetworkvendorfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkVendorFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkVendorFunction.md +--- + +# New-AzConnectedNetworkVendorFunction + +## SYNOPSIS +Creates or updates a vendor network function. +This operation can take up to 6 hours to complete. +This is expected service behavior. + +## SYNTAX + +``` +New-AzConnectedNetworkVendorFunction -LocationName <String> -ServiceKey <String> -VendorName <String> + [-SubscriptionId <String>] [-SkuType <SkuType>] + [-VendorConfiguration <INetworkFunctionVendorConfiguration[]>] + [-VendorProvisioningState <VendorProvisioningState>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a vendor network function. +This operation can take up to 6 hours to complete. +This is expected service behavior. + +## EXAMPLES + +### Example 1: New-AzConnectedNetworkVendorFunction +```powershell +$ipconf1 = New-AzConnectedNetworkInterfaceIPConfigurationObject -IPAllocationMethod "Dynamic" -IPVersion "IPv4" +$ipconf2 = New-AzConnectedNetworkInterfaceIPConfigurationObject -IPAllocationMethod "Dynamic" -IPVersion "IPv4" +$ip1 = New-AzConnectedNetworkInterfaceObject -IPConfiguration $ipconf1 -Name "mrmmanagementnic1" -VMSwitchType "Management" +$ip2 = New-AzConnectedNetworkInterfaceObject -IPConfiguration $ipconf2 -Name "mrmlannic1" -VMSwitchType "Lan" +$keyData = @{keyData = "ssh-rsa\AAAAB3NzaC1yc2EAAAADAQABAAABAQCyMpVbBgu0kftv1k+z1c3NtcB5CVDoo/X9X1LE2JUjlLlo0luEkFGJk61i53BhiTSTeRmQXN8hAZ7sn4MDUmZK7fWcHouZ2fsJo+ehses3wQPLubWBFw2L/hoSTyXifXMbEBu9SxHgqf1CEKQcvdNiWf4U7npXwjweXW9DtsF5E7h4kxhKJKFI4sNFTIX0IwUB15QEVHoBs92kDwH3fBH3kZZCMBJE/u6kT+XB22crRKkIGlp3a9gcogtOCvP+3xmsP7hjw5+nHxMUwkc/6kYyfTeLwvfI4xrTWpnB5xufts5LW5/U5GOXVg97ix9EXgiV0czThowG5K2xQ649UlJb redmond\user@n1-azuredev1"; path = $Null} +$keys = @{ } +$key += $keyData +$vendorconf = New-AzConnectedNetworkFunctionVendorConfigurationObject -NetworkInterface $ip1,$ip2 -RoleName hpehss -OSProfileAdminUsername MecUser -OSProfileCustomData $customData -OSProfileCustomDataRequired $True -SshPublicKey $key +$vendorvnf1 = New-AzConnectedNetworkVendorFunction -LocationName eastus2euap -ServiceKey b78d39-xxxx-xxxx-00946c5 -SubscriptionId xxxx-4444-xxxx-4444 -VendorName myVendor -VendorConfiguration $vendorconf -SkuType EvolvedPacketCore -VendorProvisioningState Provisioning +``` + +Creating network interfaces with dynamic method allocation and ip version to IPv4. +And using these to create two network configuration objects with vm switch type. +Creating a ssh key identity, Then using those to create vendor configuration object with role name hpehss, custom data, keyData and network interface array. +Using this to create vendor NF with the specified service key, vendor subscription, location eastus2euap, vendor name myVendor, sku type EvolvedPacketCore, vendor provisioning state Provisioning. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationName +The Azure region where the network function resource was created by the customer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceKey +The GUID for the vendor network function. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuType +The sku type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Support.SkuType +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorConfiguration +An array of network function vendor configurations. +To construct, see NOTES section for VENDORCONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.INetworkFunctionVendorConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorProvisioningState +The vendor controlled provisioning state of the vendor network function. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Support.VendorProvisioningState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IVendorNetworkFunction + +## 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. + + +VENDORCONFIGURATION <INetworkFunctionVendorConfiguration[]>: An array of network function vendor configurations. + - `[NetworkInterface <INetworkInterface[]>]`: The network interface configurations. + - `[IPConfiguration <INetworkInterfaceIPConfiguration[]>]`: A list of IP configurations of the network interface. + - `[DnsServer <String[]>]`: The list of DNS servers IP addresses. + - `[Gateway <String>]`: The value of the gateway. + - `[IPAddress <String>]`: The value of the IP address. + - `[IPAllocationMethod <IPAllocationMethod?>]`: IP address allocation method. + - `[IPVersion <IPVersion?>]`: IP address version. + - `[Subnet <String>]`: The value of the subnet. + - `[MacAddress <String>]`: The MAC address of the network interface. + - `[Name <String>]`: The name of the network interface. + - `[VMSwitchType <VMSwitchType?>]`: The type of the VM switch. + - `[OSProfileAdminUsername <String>]`: Specifies the name of the administrator account. **Windows-only restriction:** Cannot end in "." **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". **Minimum-length (Linux):** 1 character **Max-length (Linux):** 64 characters **Max-length (Windows):** 20 characters <li> For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](/azure/virtual-machines/linux/use-root-privileges) <li> For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](/azure/virtual-machines/linux/usernames). + - `[OSProfileCustomData <String>]`: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property** This property cannot be updated after the VM is created. customData is passed to the VM to be saved as a file. For more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/) For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](/azure/virtual-machines/linux/using-cloud-init) + - `[OSProfileCustomDataRequired <Boolean?>]`: Indicates if custom data is required to deploy this role. + - `[RoleName <String>]`: The name of the vendor network function role. + - `[SshPublicKey <ISshPublicKey[]>]`: The list of SSH public keys used to authenticate with linux based VMs. + - `[KeyData <String>]`: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](/azure/virtual-machines/linux/mac-create-ssh-keys). + - `[Path <String>]`: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkVendorSku.md b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkVendorSku.md new file mode 100644 index 0000000000..b5e0447e69 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkVendorSku.md @@ -0,0 +1,330 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/new-azconnectednetworkvendorsku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkVendorSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkVendorSku.md +--- + +# New-AzConnectedNetworkVendorSku + +## SYNOPSIS +Creates or updates a sku. +This operation can take up to 2 hours to complete. +This is expected service behavior. + +## SYNTAX + +``` +New-AzConnectedNetworkVendorSku -SkuName <String> -VendorName <String> [-SubscriptionId <String>] + [-DeploymentMode <SkuDeploymentMode>] [-ManagedApplicationParameter <Hashtable>] + [-ManagedApplicationTemplate <Hashtable>] + [-NetworkFunctionRoleConfigurationType <INetworkFunctionRoleConfiguration[]>] + [-NetworkFunctionType <NetworkFunctionType>] [-Preview] [-SkuType <SkuType>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a sku. +This operation can take up to 2 hours to complete. +This is expected service behavior. + +## EXAMPLES + +### Example 1: New-AzConnectedNetworkVendorSku +```powershell +$role = New-AzConnectedNetworkFunctionRoleConfigurationObject -NetworkInterface $ip1,$ip2 -OSDiskName NetFoundry -OSDiskOstype Linux -OSDiskSizeGb 40 -OSProfileCustomDataRequired $False -OSProfileAdminUsername MecUser -RoleName hpehss -RoleType VirtualMachine -VirtualMachineSize "Standard_D3_v2" -SshPublicKey $key -StorageProfileDataDisk $storage -VhdUri "https://mecvdrvhd.blob.core.windows/myvhd.vhd" +New-AzConnectedNetworkVendorSku -SkuName sku1 -VendorName myVendor -SubscriptionId xxxxx-22222-xxxxx-22222 -SkuType VirtualMachine -DeploymentMode PrivateEdgeZone -NetworkFunctionRoleConfigurationType @($role) +``` + +Creating NF role configuration object wuth the specified details. +Using this to create sku with sku name sku1, vendor name myVendor, sku type VirtualMachine, deployment type PrivateEdgeZone. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentMode +The sku deployment mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Support.SkuDeploymentMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedApplicationParameter +The parameters for the managed application to be supplied by the vendor. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedApplicationTemplate +The template for the managed application deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkFunctionRoleConfigurationType +An array of network function role definitions. +To construct, see NOTES section for NETWORKFUNCTIONROLECONFIGURATIONTYPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.INetworkFunctionRoleConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkFunctionType +The network function type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Support.NetworkFunctionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Preview +Indicates if the vendor sku is in preview mode. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the sku. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuType +The sku type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Support.SkuType +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IVendorSku + +## 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. + + +NETWORKFUNCTIONROLECONFIGURATIONTYPE <INetworkFunctionRoleConfiguration[]>: An array of network function role definitions. + - `[CustomProfileMetadataConfigurationPath <String>]`: Path for metadata configuration. + - `[ImageReferenceExactVersion <String>]`: Specifies in decimal numbers, the exact version of image used to create the virtual machine. + - `[ImageReferenceOffer <String>]`: Specifies the offer of the image used to create the virtual machine. + - `[ImageReferencePublisher <String>]`: The image publisher. + - `[ImageReferenceSku <String>]`: The image SKU. + - `[ImageReferenceVersion <String>]`: Specifies the version of the image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. + - `[NetworkInterface <INetworkInterface[]>]`: The network interface configurations. + - `[IPConfiguration <INetworkInterfaceIPConfiguration[]>]`: A list of IP configurations of the network interface. + - `[DnsServer <String[]>]`: The list of DNS servers IP addresses. + - `[Gateway <String>]`: The value of the gateway. + - `[IPAddress <String>]`: The value of the IP address. + - `[IPAllocationMethod <IPAllocationMethod?>]`: IP address allocation method. + - `[IPVersion <IPVersion?>]`: IP address version. + - `[Subnet <String>]`: The value of the subnet. + - `[MacAddress <String>]`: The MAC address of the network interface. + - `[Name <String>]`: The name of the network interface. + - `[VMSwitchType <VMSwitchType?>]`: The type of the VM switch. + - `[OSDiskName <String>]`: The VHD name. + - `[OSDiskOstype <OperatingSystemTypes?>]`: The OS type. + - `[OSDiskSizeGb <Int32?>]`: Specifies the size of os disk in gigabytes. This is the fully expanded disk size needed of the VHD image on the ASE. This disk size should be greater than the size of the VHD provided in vhdUri. + - `[OSProfileAdminUsername <String>]`: Specifies the name of the administrator account. **Windows-only restriction:** Cannot end in "." **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". **Minimum-length (Linux):** 1 character **Max-length (Linux):** 64 characters **Max-length (Windows):** 20 characters <li> For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](/azure/virtual-machines/linux/use-root-privileges) <li> For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](/azure/virtual-machines/linux/usernames). + - `[OSProfileCustomData <String>]`: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property** This property cannot be updated after the VM is created. customData is passed to the VM to be saved as a file. For more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/) For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](/azure/virtual-machines/linux/using-cloud-init) + - `[OSProfileCustomDataRequired <Boolean?>]`: Indicates if custom data is required to deploy this role. + - `[RoleName <String>]`: The name of the network function role. + - `[RoleType <NetworkFunctionRoleConfigurationType?>]`: Role type. + - `[SshPublicKey <ISshPublicKey[]>]`: The list of SSH public keys used to authenticate with linux based VMs. + - `[KeyData <String>]`: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](/azure/virtual-machines/linux/mac-create-ssh-keys). + - `[Path <String>]`: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys + - `[StorageProfileDataDisk <IDataDisk[]>]`: Specifies the parameters that are used to add a data disk to a virtual machine. + - `[CreateOption <DiskCreateOptionTypes?>]`: Specifies how the virtual machine should be created. + - `[DiskSizeGb <Int32?>]`: Specifies the size of an empty disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. + - `[Name <String>]`: The name of data disk. + - `[UserDataParameter <IAny>]`: The user parameters for customers. The format of user data parameters has to be matched with the provided user data template. + - `[UserDataTemplate <IAny>]`: The user data template for customers. This is a json schema template describing the format and data type of user data parameters. + - `[VhdUri <String>]`: Specifies the virtual hard disk's uri. + - `[VirtualMachineSize <VirtualMachineSizeTypes?>]`: The size of the virtual machine. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkVendorSkuPreview.md b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkVendorSkuPreview.md new file mode 100644 index 0000000000..12c6cd5191 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/New-AzConnectedNetworkVendorSkuPreview.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/new-azconnectednetworkvendorskupreview +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkVendorSkuPreview.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/New-AzConnectedNetworkVendorSkuPreview.md +--- + +# New-AzConnectedNetworkVendorSkuPreview + +## SYNOPSIS +Creates or updates preview information of a vendor sku. + +## SYNTAX + +``` +New-AzConnectedNetworkVendorSkuPreview -PreviewSubscription <String> -SkuName <String> -VendorName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates preview information of a vendor sku. + +## EXAMPLES + +### Example 1: New-AzConnectedNetworkVendorSkuPreview using preview subscription, sku name, vendor name and subscription +```powershell +New-AzConnectedNetworkVendorSkuPreview -PreviewSubscription xxxxx-00000-xxxxx-00000 -SkuName mySku -VendorName myVendor -SubscriptionId xxxxx-22222-xxxxx-22222 +``` + +```output +Id : /subscriptions/xxxxx-22222-xxxxx-22222/providers/Microsoft.HybridNetwork/vendors/myVendor/vendorSkus/mySku/previewSubscriptions/xxxxx-00000-xxxxx-00000 +Name : xxxxx-00000-xxxxx-00000 +ProvisioningState : Succeeded +ResourceGroupName : +SystemDataCreatedAt : 12/6/2021 5:37:35 AM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 12/6/2021 5:37:35 AM +SystemDataLastModifiedBy : user@microsoft.com +SystemDataLastModifiedByType : User +Type : microsoft.hybridnetwork/vendors/vendorskus/previewsubscriptions + +``` + +Creating preview subscription for subscription xxxxx-00000-xxxxx-00000 of a vendor sku mySku with vendor name myVendor, which is allowed to deploy network function. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreviewSubscription +Preview subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the vendor sku. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IPreviewSubscription + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkDevice.md b/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkDevice.md new file mode 100644 index 0000000000..29697c9b68 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkDevice.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/remove-azconnectednetworkdevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Remove-AzConnectedNetworkDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Remove-AzConnectedNetworkDevice.md +--- + +# Remove-AzConnectedNetworkDevice + +## SYNOPSIS +Deletes the specified device. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzConnectedNetworkDevice -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzConnectedNetworkDevice -InputObject <IConnectedNetworkIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified device. + +## EXAMPLES + +### Example 1: Remove-AzConnectedNetworkDevice via resource name and resource group +```powershell +Remove-AzConnectedNetworkDevice -Name myMecDevice -ResourceGroupName myResources +``` + +Deleting the NFM device with device name myMecDevice in resource group myResources. + +### Example 2: Remove-AzConnectedNetworkDevice via Identity +```powershell +$mecDevice = Get-AzConnectedNetworkDevice -Name myMecDevice2 -ResourceGroupName myResources +Remove-AzConnectedNetworkDevice -InputObject $mecDevice +``` + +Creating an identity with name myMecDevice2 and resource group name myResources. +Deleting the NFM device with the given identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the device resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DeviceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkFunction.md b/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkFunction.md new file mode 100644 index 0000000000..98a0ac9fb0 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkFunction.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/remove-azconnectednetworkfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Remove-AzConnectedNetworkFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Remove-AzConnectedNetworkFunction.md +--- + +# Remove-AzConnectedNetworkFunction + +## SYNOPSIS +Deletes the specified network function resource. +This operation can take up to 1 hour to complete. +This is expected service behavior. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzConnectedNetworkFunction -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzConnectedNetworkFunction -InputObject <IConnectedNetworkIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified network function resource. +This operation can take up to 1 hour to complete. +This is expected service behavior. + +## EXAMPLES + +### Example 1: Remove-AzConnectedNetworkFunction via Resource Group and Resource name +```powershell +Remove-AzConnectedNetworkFunction -ResourceGroupName myResources -Name myVnf +``` + +Deleting the Network Function in Resource Group myResources with name myVnf. + +### Example 2: Remove-AzConnectedNetworkFunction via Identity +```powershell +$vnf = Get-AzConnectedNetworkFunction -ResourceGroupName myResources -Name myVnf1 +Remove-AzConnectedNetworkFunction -InputObject $vnf +``` + +Creating an identity with name myVnf1 and resource group name myResources. +Deleting the Network Function with the given Identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the network function. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: NetworkFunctionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkVendor.md b/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkVendor.md new file mode 100644 index 0000000000..e20b9ff9d5 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkVendor.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/remove-azconnectednetworkvendor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Remove-AzConnectedNetworkVendor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Remove-AzConnectedNetworkVendor.md +--- + +# Remove-AzConnectedNetworkVendor + +## SYNOPSIS +Deletes the specified vendor. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzConnectedNetworkVendor -Name <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzConnectedNetworkVendor -InputObject <IConnectedNetworkIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified vendor. + +## EXAMPLES + +### Example 1: Remove-AzConnectedNetworkVendor via vendor name +```powershell +Remove-AzConnectedNetworkVendor -Name MyVendor +``` + +Deleting the vendor with name MyVendor + +### Example 2: Remove-AzConnectedNetworkVendor via InputObject +```powershell +$vendor = Get-AzConnectedNetworkVendor -Name MyVendor1 +Remove-AzConnectedNetworkVendor -InputObject $vendor +``` + +Deleting the vendor with name MyVendor1 + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: VendorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkVendorSku.md b/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkVendorSku.md new file mode 100644 index 0000000000..190009c8da --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkVendorSku.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/remove-azconnectednetworkvendorsku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Remove-AzConnectedNetworkVendorSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Remove-AzConnectedNetworkVendorSku.md +--- + +# Remove-AzConnectedNetworkVendorSku + +## SYNOPSIS +Deletes the specified sku. +This operation can take up to 2 hours to complete. +This is expected service behavior. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzConnectedNetworkVendorSku -SkuName <String> -VendorName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzConnectedNetworkVendorSku -InputObject <IConnectedNetworkIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified sku. +This operation can take up to 2 hours to complete. +This is expected service behavior. + +## EXAMPLES + +### Example 1: Remove-AzConnectedNetworkVendorSku via Sku name and Vendor name +```powershell +Remove-AzConnectedNetworkVendorSku -SkuName MySku -VendorName MyVendor +``` + +Deleting the sku MySku with Vendor name MyVendor. + +### Example 2: Remove-AzConnectedNetworkVendorSku via Identity +```powershell +$sku = Get-AzConnectedNetworkVendorSku -SkuName MySku1 -VendorName MyVendor +Remove-AzConnectedNetworkVendorSku -InputObject $sku +``` + +Creating an identity with sku name MySku1 and vendor name MyVendor. +Deleting the sku with the given Identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the sku. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkVendorSkuPreview.md b/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkVendorSkuPreview.md new file mode 100644 index 0000000000..b6e251297e --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Remove-AzConnectedNetworkVendorSkuPreview.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/remove-azconnectednetworkvendorskupreview +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Remove-AzConnectedNetworkVendorSkuPreview.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Remove-AzConnectedNetworkVendorSkuPreview.md +--- + +# Remove-AzConnectedNetworkVendorSkuPreview + +## SYNOPSIS +Deletes the preview information of a vendor sku. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzConnectedNetworkVendorSkuPreview -PreviewSubscription <String> -SkuName <String> -VendorName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzConnectedNetworkVendorSkuPreview -InputObject <IConnectedNetworkIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the preview information of a vendor sku. + +## EXAMPLES + +### Example 1: Remove-AzConnectedNetworkVendorSkuPreview via sku name, vendor name and preview subscription +```powershell +Remove-AzConnectedNetworkVendorSkuPreview -SkuName mySku -VendorName myVendor -PreviewSubscription xxxxx-22222-xxxxx-22222 +``` + +Deleting the preview information of sku mySku with vendor name myVendor for the given preview subscription. + +### Example 2: Remove-AzConnectedNetworkVendorSkuPreview via Identity +```powershell +$sku = Get-AzConnectedNetworkVendorSkuPreview -SkuName mySku1 -VendorName myVendor -PreviewSubscription xxxxx-22222-xxxxx-22222 +Remove-AzConnectedNetworkVendorSkuPreview -InputObject $sku +``` + +Creating an identity with skuname mySku1, vendor name myVendor and preview subscription. +Deleting the preview information using the given identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreviewSubscription +Preview subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the vendor sku. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Restart-AzConnectedNetworkVendorFunctionRoleInstance.md b/azps-10.1.0/Az.ConnectedNetwork/Restart-AzConnectedNetworkVendorFunctionRoleInstance.md new file mode 100644 index 0000000000..351af09a37 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Restart-AzConnectedNetworkVendorFunctionRoleInstance.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/restart-azconnectednetworkvendorfunctionroleinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Restart-AzConnectedNetworkVendorFunctionRoleInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Restart-AzConnectedNetworkVendorFunctionRoleInstance.md +--- + +# Restart-AzConnectedNetworkVendorFunctionRoleInstance + +## SYNOPSIS +Restarts a role instance of a vendor network function. + +## SYNTAX + +### Restart (Default) +``` +Restart-AzConnectedNetworkVendorFunctionRoleInstance -LocationName <String> -Name <String> + -ServiceKey <String> -VendorName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RestartViaIdentity +``` +Restart-AzConnectedNetworkVendorFunctionRoleInstance -InputObject <IConnectedNetworkIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Restarts a role instance of a vendor network function. + +## EXAMPLES + +### Example 1: Restart-AzConnectedNetworkVendorFunctionRoleInstance via location, serviceKey, vendor name and role instance name +```powershell +Restart-AzConnectedNetworkVendorFunctionRoleInstance -LocationName centraluseuap -ServiceKey 1234-abcd-4321-dcba -SubscriptionId xxxx-3333-xxxx-3333 -VendorName myVendor -Name role1 +``` + +Restarting a role instance of a vendor network function with the specified serviceKey, location centraluseuap, vendor name myVendor and role instance name role1. + +### Example 2: Restart-AzConnectedNetworkVendorFunctionRoleInstance via Identity +```powershell +$role = @{ RoleInstanceName = "role1"; LocationName = "centraluseuap"; SubscriptionId = "xxxx-3333-xxxx-3333"; VendorName = "myVendor"; serviceKey = "1234-abcd-4321-dcba"} +Restart-AzConnectedNetworkVendorFunctionRoleInstance -InputObject $role +``` + +Creating an identity with role instance name role1, location centraluseuap, vendor name myVendor specified subscription, serviceKey. +Restarting a role instance with the given identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LocationName +The Azure region where the network function resource was created by customer. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the role instance of the vendor network function. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: RoleInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceKey +The GUID for the vendor network function. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Start-AzConnectedNetworkVendorFunctionRoleInstance.md b/azps-10.1.0/Az.ConnectedNetwork/Start-AzConnectedNetworkVendorFunctionRoleInstance.md new file mode 100644 index 0000000000..6ca98d8118 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Start-AzConnectedNetworkVendorFunctionRoleInstance.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/start-azconnectednetworkvendorfunctionroleinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Start-AzConnectedNetworkVendorFunctionRoleInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Start-AzConnectedNetworkVendorFunctionRoleInstance.md +--- + +# Start-AzConnectedNetworkVendorFunctionRoleInstance + +## SYNOPSIS +Starts a role instance of a vendor network function. + +## SYNTAX + +### Start (Default) +``` +Start-AzConnectedNetworkVendorFunctionRoleInstance -LocationName <String> -Name <String> -ServiceKey <String> + -VendorName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzConnectedNetworkVendorFunctionRoleInstance -InputObject <IConnectedNetworkIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Starts a role instance of a vendor network function. + +## EXAMPLES + +### Example 1: Start-AzConnectedNetworkVendorFunctionRoleInstance via location, serviceKey, vendor name and role instance name +```powershell +Start-AzConnectedNetworkVendorFunctionRoleInstance -LocationName centraluseuap -ServiceKey 1234-abcd-4321-dcba -SubscriptionId xxxx-3333-xxxx-3333 -VendorName myVendor -Name role1 +``` + +Starting a role instance of a vendor network function with the specified serviceKey, location centraluseuap, vendor name myVendor and role instance name role1. + +### Example 2: Start-AzConnectedNetworkVendorFunctionRoleInstance via Identity +```powershell +$role = @{ RoleInstanceName = "role1"; LocationName = "centraluseuap"; SubscriptionId = "xxxx-3333-xxxx-3333"; VendorName = "myVendor"; serviceKey = "1234-abcd-4321-dcba"} +Start-AzConnectedNetworkVendorFunctionRoleInstance -InputObject $role +``` + +Creating an identity with role instance name role1, location centraluseuap, vendor name myVendor specified subscription, serviceKey. +Starting a role instance with the given identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LocationName +The Azure region where the network function resource was created by customer. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the role instance of the vendor network function. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: RoleInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceKey +The GUID for the vendor network function. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Stop-AzConnectedNetworkVendorFunctionRoleInstance.md b/azps-10.1.0/Az.ConnectedNetwork/Stop-AzConnectedNetworkVendorFunctionRoleInstance.md new file mode 100644 index 0000000000..27c5a67711 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Stop-AzConnectedNetworkVendorFunctionRoleInstance.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/stop-azconnectednetworkvendorfunctionroleinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Stop-AzConnectedNetworkVendorFunctionRoleInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Stop-AzConnectedNetworkVendorFunctionRoleInstance.md +--- + +# Stop-AzConnectedNetworkVendorFunctionRoleInstance + +## SYNOPSIS +Powers off (stop) a role instance of a vendor network function. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzConnectedNetworkVendorFunctionRoleInstance -LocationName <String> -Name <String> -ServiceKey <String> + -VendorName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzConnectedNetworkVendorFunctionRoleInstance -InputObject <IConnectedNetworkIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Powers off (stop) a role instance of a vendor network function. + +## EXAMPLES + +### Example 1: Stop-AzConnectedNetworkVendorFunctionRoleInstance via location, serviceKey, vendor name and role instance name +```powershell +Stop-AzConnectedNetworkVendorFunctionRoleInstance -LocationName centraluseuap -ServiceKey 1234-abcd-4321-dcba -SubscriptionId xxxx-3333-xxxx-3333 -VendorName myVendor -Name role1 +``` + +Stoping a role instance of a vendor network function with the specified serviceKey, location centraluseuap, vendor name myVendor and role instance name role1. + +### Example 2: Stop-AzConnectedNetworkVendorFunctionRoleInstance via Identity +```powershell +$role = @{ RoleInstanceName = "role1"; LocationName = "centraluseuap"; SubscriptionId = "xxxx-3333-xxxx-3333"; VendorName = "myVendor"; serviceKey = "1234-abcd-4321-dcba"} +Stop-AzConnectedNetworkVendorFunctionRoleInstance -InputObject $role +``` + +Creating an identity with role instance name role1, location centraluseuap, vendor name myVendor specified subscription, serviceKey. +Stopping a role instance with the given identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LocationName +The Azure region where the network function resource was created by customer. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the role instance of the vendor network function. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: RoleInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceKey +The GUID for the vendor network function. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Update-AzConnectedNetworkDeviceTag.md b/azps-10.1.0/Az.ConnectedNetwork/Update-AzConnectedNetworkDeviceTag.md new file mode 100644 index 0000000000..dbeb91a910 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Update-AzConnectedNetworkDeviceTag.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/update-azconnectednetworkdevicetag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Update-AzConnectedNetworkDeviceTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Update-AzConnectedNetworkDeviceTag.md +--- + +# Update-AzConnectedNetworkDeviceTag + +## SYNOPSIS +Updates device tags. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzConnectedNetworkDeviceTag -DeviceName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzConnectedNetworkDeviceTag -InputObject <IConnectedNetworkIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates device tags. + +## EXAMPLES + +### Example 1: Update-AzConnectedNetworkDeviceTag via Resource name and Device name +```powershell +$tags = @{ NewTag = "NewTagValue"} +Update-AzConnectedNetworkDeviceTag -DeviceName "myMecDevice" -ResourceGroupName "myResources" -Tag $tags +``` + +```output +DeviceType : AzureStackEdge +Id : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMecDevice +Location : eastus +Name : myMecDevice +NetworkFunction : +ProvisioningState : Succeeded +ResourceGroupName : myResources +Status : NotRegistered +SystemDataCreatedAt : 11/25/2021 4:47:45 AM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/25/2021 5:22:57 AM +SystemDataLastModifiedBy : user@microsoft.com +SystemDataLastModifiedByType : User +Tag : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20.TrackedResourceTags +Type : microsoft.hybridnetwork/devices +``` + +Creating an identity with field NewTag and value NewTagValue. +Updating the tag of device with resource name myMecDevice in resource group myResources. + +### Example 2: Update-AzConnectedNetworkDeviceTag via Identity +```powershell +$tags = @{ NewTag1 = "NewTagValue1"} +$mecDevice = @{ DeviceName = "myMecDevice1"; Location = "eastus"; ResourceGroupName = "myResources"; SubscriptionId = "xxxxx-00000-xxxxx-00000"} +Update-AzConnectedNetworkDeviceTag -InputObject $mecDevice -Tag $tags +``` + +```output +DeviceType : AzureStackEdge +Id : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/mec_2111_09 +Location : eastus +Name : mec_2111_09 +NetworkFunction : {/subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/mrg-vmware_sdwan_edge_zones-20211124063650/providers/Microsoft.HybridNetwork/networkFunctions/Edge101} +ProvisioningState : Succeeded +ResourceGroupName : myResources +Status : Registered +SystemDataCreatedAt : 11/23/2021 10:27:13 PM +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/25/2021 5:53:12 AM +SystemDataLastModifiedBy : user@microsoft.com +SystemDataLastModifiedByType : User +Tag : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20.TrackedResourceTags +Type : microsoft.hybridnetwork/devices + +``` + +Creating an identity with field NewTag1 and value NewTagValue1. +Creating another identity with device name myMecDevice1, resource group myResources, location eastus and specified subscription. +Updating the tag of device using identity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +The name of the device resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.IDevice + +## 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 `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ConnectedNetwork/Update-AzConnectedNetworkFunctionTag.md b/azps-10.1.0/Az.ConnectedNetwork/Update-AzConnectedNetworkFunctionTag.md new file mode 100644 index 0000000000..9bdea7ef42 --- /dev/null +++ b/azps-10.1.0/Az.ConnectedNetwork/Update-AzConnectedNetworkFunctionTag.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.ConnectedNetwork +online version: https://learn.microsoft.com/powershell/module/az.connectednetwork/update-azconnectednetworkfunctiontag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Update-AzConnectedNetworkFunctionTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ConnectedNetwork/help/Update-AzConnectedNetworkFunctionTag.md +--- + +# Update-AzConnectedNetworkFunctionTag + +## SYNOPSIS +Updates the tags for the network function resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzConnectedNetworkFunctionTag -NetworkFunctionName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzConnectedNetworkFunctionTag -InputObject <IConnectedNetworkIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the tags for the network function resource. + +## EXAMPLES + +### Example 1: Update-AzConnectedNetworkFunctionTag +```powershell +$tags = @{ NewTag = "NewTagValue"} +Update-AzConnectedNetworkFunctionTag -NetworkFunctionName myNewVnf1 -ResourceGroupName myResources -Tag $tags +``` + +```output +Location Name Etag ResourceGroupName +-------- ---- ---- ----------------- +eastus2euap myNewVnf1 "sampleEtagValue" myResources +``` + +Creating an identity with field NewTag and value NewTagValue. +Updating the tag of NF with resource name myNewVnf1 in resource group myResources. + +### Example 2: Update-AzConnectedNetworkFunctionTag +```powershell +$tags = @{ NewTag = "NewTagValue"} +$vnf = @{ NetworkFunctionName = "myVnf1"; ResourceGroupName = "myResources"; SubscriptionId = "00000000-0000-0000-0000-000000000000"} +Update-AzConnectedNetworkFunctionTag -InputObject $vnf -Tag $tags +``` + +```output +Location Name Etag ResourceGroupName +-------- ---- ---- ----------------- +eastus2euap myNewVnf1 "0000f211-0000-3300-0000-61a9edc70000" myResources +``` + +Creating an identity with field NewTag and value NewTagValue. +Creating an identity with NetworkFunctionName myVnf1, ResourceGroupName myResources and subscription.Updating the tag of NF specified in identity with the tags. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkFunctionName +Resource name for the network function resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.IConnectedNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.INetworkFunction + +## 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 `<IConnectedNetworkIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the device resource. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The Azure region where the network function resource was created by the customer. + - `[NetworkFunctionName <String>]`: The name of the network function. + - `[PreviewSubscription <String>]`: Preview subscription ID. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RoleInstanceName <String>]`: The name of the role instance of the vendor network function. + - `[ServiceKey <String>]`: The GUID for the vendor network function. + - `[SkuName <String>]`: The name of the sku. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VendorName <String>]`: The name of the vendor. + - `[VendorSkuName <String>]`: The name of the network function sku. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Add-AzContainerInstanceOutput.md b/azps-10.1.0/Az.ContainerInstance/Add-AzContainerInstanceOutput.md new file mode 100644 index 0000000000..f5e5ca48f5 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Add-AzContainerInstanceOutput.md @@ -0,0 +1,165 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/add-azcontainerinstanceoutput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Add-AzContainerInstanceOutput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Add-AzContainerInstanceOutput.md +--- + +# Add-AzContainerInstanceOutput + +## SYNOPSIS +Attach to the output stream of a specific container instance in a specified resource group and container group. + +## SYNTAX + +``` +Add-AzContainerInstanceOutput -GroupName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Attach to the output stream of a specific container instance in a specified resource group and container group. + +## EXAMPLES + +### Example 1: Attach to the output of a specific container instance +```powershell +$response = Add-AzContainerInstanceOutput -GroupName test-cg -Name test-container -ResourceGroupName test-rg +$response +``` + +```output +Password WebSocketUri +-------- ------------ +****************** wss://********.eastus.atlas.cloudapp.azure.com:19390/logstream/sessionId/00000000-0000-0000-0000-000000000000?api-version=1.0 +``` + +This command attaches to the output stream of a specific container instance in a specified resource group and container group. +Please send `Password` as an Authorization header value when connecting to the `WebSocketUri`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +The name of the container group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ContainerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the container instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ContainerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IContainerAttachResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Az.ContainerInstance.md b/azps-10.1.0/Az.ContainerInstance/Az.ContainerInstance.md new file mode 100644 index 0000000000..2e3665cb8d --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Az.ContainerInstance.md @@ -0,0 +1,94 @@ +--- +Module Name: Az.ContainerInstance +Module Guid: ddf74844-4a25-4263-8a5c-f27979292e4e +Download Help Link: https://learn.microsoft.com/powershell/module/az.containerinstance +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Az.ContainerInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Az.ContainerInstance.md +--- + +# Az.ContainerInstance Module +## Description +Microsoft Azure PowerShell: ContainerInstance cmdlets + +## Az.ContainerInstance Cmdlets +### [Add-AzContainerInstanceOutput](Add-AzContainerInstanceOutput.md) +Attach to the output stream of a specific container instance in a specified resource group and container group. + +### [Get-AzContainerGroup](Get-AzContainerGroup.md) +Gets the properties of the specified container group in the specified subscription and resource group. +The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. + +### [Get-AzContainerInstanceCachedImage](Get-AzContainerInstanceCachedImage.md) +Get the list of cached images on specific OS type for a subscription in a region. + +### [Get-AzContainerInstanceCapability](Get-AzContainerInstanceCapability.md) +Get the list of CPU/memory/GPU capabilities of a region. + +### [Get-AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint](Get-AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint.md) +Gets all the network dependencies for this container group to allow complete control of network setting and configuration. +For container groups, this will always be an empty list. + +### [Get-AzContainerInstanceLog](Get-AzContainerInstanceLog.md) +Get the logs for a specified container instance in a specified resource group and container group. + +### [Get-AzContainerInstanceUsage](Get-AzContainerInstanceUsage.md) +Get the usage for a subscription + +### [Invoke-AzContainerInstanceCommand](Invoke-AzContainerInstanceCommand.md) +Executes a command for a specific container instance in a specified resource group and container group. + +### [New-AzContainerGroup](New-AzContainerGroup.md) +Create or update container groups with specified configurations. + +### [New-AzContainerGroupImageRegistryCredentialObject](New-AzContainerGroupImageRegistryCredentialObject.md) +Create a in-memory object for ImageRegistryCredential + +### [New-AzContainerGroupPortObject](New-AzContainerGroupPortObject.md) +Create a in-memory object for Port + +### [New-AzContainerGroupVolumeObject](New-AzContainerGroupVolumeObject.md) +Create an in-memory object for Volume. + +### [New-AzContainerInstanceEnvironmentVariableObject](New-AzContainerInstanceEnvironmentVariableObject.md) +Create a in-memory object for EnvironmentVariable + +### [New-AzContainerInstanceHttpHeaderObject](New-AzContainerInstanceHttpHeaderObject.md) +Create a in-memory object for HttpHeader + +### [New-AzContainerInstanceInitDefinitionObject](New-AzContainerInstanceInitDefinitionObject.md) +Create a in-memory object for InitContainerDefinition + +### [New-AzContainerInstanceObject](New-AzContainerInstanceObject.md) +Create a in-memory object for Container + +### [New-AzContainerInstancePortObject](New-AzContainerInstancePortObject.md) +Create a in-memory object for ContainerPort + +### [New-AzContainerInstanceVolumeMountObject](New-AzContainerInstanceVolumeMountObject.md) +Create a in-memory object for VolumeMount + +### [Remove-AzContainerGroup](Remove-AzContainerGroup.md) +Delete the specified container group in the specified subscription and resource group. +The operation does not delete other resources provided by the user, such as volumes. + +### [Remove-AzContainerInstanceSubnetServiceAssociationLink](Remove-AzContainerInstanceSubnetServiceAssociationLink.md) +Delete container group virtual network association links. +The operation does not delete other resources provided by the user. + +### [Restart-AzContainerGroup](Restart-AzContainerGroup.md) +Restarts all containers in a container group in place. +If container image has updates, new image will be downloaded. + +### [Start-AzContainerGroup](Start-AzContainerGroup.md) +Starts all containers in a container group. +Compute resources will be allocated and billing will start. + +### [Stop-AzContainerGroup](Stop-AzContainerGroup.md) +Stops all containers in a container group. +Compute resources will be deallocated and billing will stop. + +### [Update-AzContainerGroup](Update-AzContainerGroup.md) +Updates container group tags with specified values. + diff --git a/azps-10.1.0/Az.ContainerInstance/Get-AzContainerGroup.md b/azps-10.1.0/Az.ContainerInstance/Get-AzContainerGroup.md new file mode 100644 index 0000000000..54fa3c89c2 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Get-AzContainerGroup.md @@ -0,0 +1,256 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/get-azcontainergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Get-AzContainerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Get-AzContainerGroup.md +--- + +# Get-AzContainerGroup + +## SYNOPSIS +Gets the properties of the specified container group in the specified subscription and resource group. +The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerGroup [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzContainerGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzContainerGroup -InputObject <IContainerInstanceIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzContainerGroup -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the specified container group in the specified subscription and resource group. +The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. + +## EXAMPLES + +### Example 1: List all container groups in the current subscription +```powershell +Get-AzContainerGroup +``` + +```output +Location Name Zone ResourceGroupName +-------- ---- ---- ----------------- +eastus test-cg1 test-rg +eastus test-cg2 test-rg +``` + +This command gets all container groups in the current subscription. + +### Example 2: Get a specific container group +```powershell +Get-AzContainerGroup -Name test-cg1 -ResourceGroupName test-rg | Format-List +``` + +```output +Container : {test-container1} +DnsConfigNameServer : +DnsConfigOption : +DnsConfigSearchDomain : +EncryptionPropertyKeyName : +EncryptionPropertyKeyVersion : +EncryptionPropertyVaultBaseUrl : +IPAddressDnsNameLabel : +IPAddressFqdn : +IPAddressIP : 000.000.000.000 +IPAddressPort : {Microsoft.Azure.PowerShell.Cmdlets.ContainerInsta + nce.Models.Api20210301.Port, Microsoft.Azure.Power + Shell.Cmdlets.ContainerInstance.Models.Api20210301 + .Port} +IPAddressType : Public +Id : /subscriptions/00000000-0000-0000-0000-000000000000 + 0/resourceGroups/test-rg/providers/Microsoft.Contai + nerInstance/containerGroups/test-cg1 +IdentityPrincipalId : +IdentityTenantId : +IdentityType : +IdentityUserAssignedIdentity : Microsoft.Azure.PowerShell.Cmdlets.ContainerInstan + ce.Models.Api20210301.ContainerGroupIdentityUserAs + signedIdentities +ImageRegistryCredentials : +InitContainer : {} +InstanceViewEvent : +InstanceViewState : +Location : eastus +LogAnalyticLogType : +LogAnalyticMetadata : Microsoft.Azure.PowerShell.Cmdlets.ContainerInstan + ce.Models.Api20210301.LogAnalyticsMetadata +LogAnalyticWorkspaceId : +LogAnalyticWorkspaceKey : +LogAnalyticWorkspaceResourceId : Microsoft.Azure.PowerShell.Cmdlets.ContainerInstan + ce.Models.Api20210301.LogAnalyticsWorkspaceResourc + eId +Name : test-cg1 +NetworkProfileId : +OSType : Linux +ProvisioningState : Succeeded +ResourceGroupName : test-rg +RestartPolicy : Never +Sku : Standard +Tag : Microsoft.Azure.PowerShell.Cmdlets.ContainerInstan + ce.Models.Api20210301.ResourceTags +Type : Microsoft.ContainerInstance/containerGroups +Volume : +``` + +The command gets the specified container group. + +### Example 3: Get container groups in a resource group +```powershell +Get-AzContainerGroup -ResourceGroupName test-rg +``` + +```output +Location Name Zone ResourceGroupName +-------- ---- ---- ----------------- +eastus test-cg1 test-rg +eastus test-cg2 test-rg +``` + +The command gets the container groups in the resource group `test-rg`. + +### Example 4: Get a container group by piping +```powershell +Update-AzContainerGroup -Name test-cg1 -ResourceGroupName test-rg -Tag @{"test"="value"} | Get-AzContainerGroup +``` + +```output +Location Name Zone ResourceGroupName +-------- ---- ---- ----------------- +eastus test-cg1 test-rg +``` + +The command gets the updated container group by piping. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the container group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ContainerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IContainerGroup + +## 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 <IContainerInstanceIdentity>`: Identity Parameter + - `[ContainerGroupName <String>]`: The name of the container group. + - `[ContainerName <String>]`: The name of the container instance. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The identifier for the physical azure location. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubnetName <String>]`: The name of the subnet. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceCachedImage.md b/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceCachedImage.md new file mode 100644 index 0000000000..e1bbbddd25 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceCachedImage.md @@ -0,0 +1,105 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/get-azcontainerinstancecachedimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Get-AzContainerInstanceCachedImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Get-AzContainerInstanceCachedImage.md +--- + +# Get-AzContainerInstanceCachedImage + +## SYNOPSIS +Get the list of cached images on specific OS type for a subscription in a region. + +## SYNTAX + +``` +Get-AzContainerInstanceCachedImage -Location <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the list of cached images on specific OS type for a subscription in a region. + +## EXAMPLES + +### Example 1: Get the list of cached images for the current subscription in a region. +```powershell +Get-AzContainerInstanceCachedImage -Location eastus +``` + +```output +Image OSType +----- ------ +microsoft/dotnet-framework:4.7.2-runtime-20181211-windowsservercore-ltsc2016 Windows +microsoft/dotnet-framework:4.7.2-runtime-20190108-windowsservercore-ltsc2016 Windows +microsoft/dotnet-framework:4.7.2-runtime-20190212-windowsservercore-ltsc2016 Windows +... +``` + +This command gets the list of cached images for the current subscription in the region `eastus`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The identifier for the physical azure location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.ICachedImages + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceCapability.md b/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceCapability.md new file mode 100644 index 0000000000..c60d1da70f --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceCapability.md @@ -0,0 +1,109 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/get-azcontainerinstancecapability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Get-AzContainerInstanceCapability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Get-AzContainerInstanceCapability.md +--- + +# Get-AzContainerInstanceCapability + +## SYNOPSIS +Get the list of CPU/memory/GPU capabilities of a region. + +## SYNTAX + +``` +Get-AzContainerInstanceCapability -Location <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the list of CPU/memory/GPU capabilities of a region. + +## EXAMPLES + +### Example 1: Get the list of capabilities of the location +```powershell +Get-AzContainerInstanceCapability -Location eastus +``` + +```output +Gpu IPAddressType Location OSType ResourceType +--- ------------- -------- ------ ------------ +None Public eastus NotSpecified containerGroups +None Private eastus NotSpecified containerGroups +None Public EASTUS Linux containerGroups +None Private EASTUS Linux containerGroups +K80 Public EASTUS Linux containerGroups +P100 Public EASTUS Linux containerGroups +V100 Public EASTUS Linux containerGroups +None Public EASTUS Windows containerGroups +``` + +This command gets the list of CPU/memory/GPU capabilities of the region `eastus`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The identifier for the physical azure location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.ICapabilities + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint.md b/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint.md new file mode 100644 index 0000000000..ea3f250119 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint.md @@ -0,0 +1,160 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/get-azcontainerinstancecontainergroupoutboundnetworkdependencyendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Get-AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Get-AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint.md +--- + +# Get-AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint + +## SYNOPSIS +Gets all the network dependencies for this container group to allow complete control of network setting and configuration. +For container groups, this will always be an empty list. + +## SYNTAX + +### Get (Default) +``` +Get-AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint -ContainerGroupName <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint + -InputObject <IContainerInstanceIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets all the network dependencies for this container group to allow complete control of network setting and configuration. +For container groups, this will always be an empty list. + +## EXAMPLES + +### Example 1: Get a list of the outbound network dependencies +```powershell +Get-AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint -ResourceGroupName test-rg -ContainerGroupName test-cg +``` + +```output +[] +``` + +This command returns a list of the outbound network dependencies for Container Instances. +Container Instances does not have any outbound network dependencies, so this list will be empty. + +## PARAMETERS + +### -ContainerGroupName +The name of the container group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +Get-AzContainerGroupOutboundNetworkDependencyEndpoint + +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 <IContainerInstanceIdentity>`: Identity Parameter + - `[ContainerGroupName <String>]`: The name of the container group. + - `[ContainerName <String>]`: The name of the container instance. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The identifier for the physical azure location. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubnetName <String>]`: The name of the subnet. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceLog.md b/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceLog.md new file mode 100644 index 0000000000..fd2cdeb672 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceLog.md @@ -0,0 +1,182 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/get-azcontainerinstancelog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Get-AzContainerInstanceLog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Get-AzContainerInstanceLog.md +--- + +# Get-AzContainerInstanceLog + +## SYNOPSIS +Get the logs for a specified container instance in a specified resource group and container group. + +## SYNTAX + +``` +Get-AzContainerInstanceLog -ContainerGroupName <String> -ContainerName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-Tail <Int32>] [-Timestamp] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the logs for a specified container instance in a specified resource group and container group. + +## EXAMPLES + +### Example 1: Get the tail log of a container instance +```powershell +Get-AzContainerInstanceLog -ContainerGroupName test-cg -ContainerName test-container -ResourceGroupName test-rg +``` + +```output +/docker-entrypoint.sh: /docker-entrypoint.d/ is not empty, will attempt to perform configuration +/docker-entrypoint.sh: Looking for shell scripts in /docker-entrypoint.d/ +/docker-entrypoint.sh: Launching /docker-entrypoint.d/10-listen-on-ipv6-by-default.sh +10-listen-on-ipv6-by-default.sh: info: Getting the checksum of /etc/nginx/conf.d/default.conf +10-listen-on-ipv6-by-default.sh: info: Enabled listen on IPv6 in /etc/nginx/conf.d/default.conf +/docker-entrypoint.sh: Launching /docker-entrypoint.d/20-envsubst-on-templates.sh +/docker-entrypoint.sh: Launching /docker-entrypoint.d/30-tune-worker-processes.sh +/docker-entrypoint.sh: Configuration complete; ready for start up +``` + +Get the log from test-container in container group test-cg. +By default, it will return up to 4MB log content. + +### Example 2: Get the tail 2 lines of log of a container instance +```powershell +Get-AzContainerInstanceLog -ContainerGroupName test-cg -ContainerName test-container -ResourceGroupName test-rg -Tail 2 +``` + +```output +/docker-entrypoint.sh: Launching /docker-entrypoint.d/30-tune-worker-processes.sh +/docker-entrypoint.sh: Configuration complete; ready for start up +``` + +Get the tail 2 lines of log from test-container in container group test-cg. + +## PARAMETERS + +### -ContainerGroupName +The name of the container group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +The name of the container instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tail +The number of lines to show from the tail of the container instance log. +If not provided, all available logs are shown up to 4mb. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timestamp +If true, adds a timestamp at the beginning of every line of log output. +If not provided, defaults to false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceUsage.md b/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceUsage.md new file mode 100644 index 0000000000..403ac56410 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Get-AzContainerInstanceUsage.md @@ -0,0 +1,108 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/get-azcontainerinstanceusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Get-AzContainerInstanceUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Get-AzContainerInstanceUsage.md +--- + +# Get-AzContainerInstanceUsage + +## SYNOPSIS +Get the usage for a subscription + +## SYNTAX + +``` +Get-AzContainerInstanceUsage -Location <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the usage for a subscription + +## EXAMPLES + +### Example 1: Get the usage of the location +```powershell +Get-AzContainerInstanceUsage -Location eastus +``` + +```output +CurrentValue Limit Unit +------------ ----- ---- +9 100 Count +9 100 Count +1 48 Count +0 0 Count +0 0 Count +0 0 Count +0 3000 Count +``` + +Get the usage for the current subscription in the region `eastus`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The identifier for the physical azure location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IUsage + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Invoke-AzContainerInstanceCommand.md b/azps-10.1.0/Az.ContainerInstance/Invoke-AzContainerInstanceCommand.md new file mode 100644 index 0000000000..528c522406 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Invoke-AzContainerInstanceCommand.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/invoke-azcontainerinstancecommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Invoke-AzContainerInstanceCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Invoke-AzContainerInstanceCommand.md +--- + +# Invoke-AzContainerInstanceCommand + +## SYNOPSIS +Executes a command for a specific container instance in a specified resource group and container group. + +## SYNTAX + +``` +Invoke-AzContainerInstanceCommand -ContainerGroupName <String> -ContainerName <String> + -ResourceGroupName <String> -Command <String> [-SubscriptionId <String>] [-TerminalSizeCol <Int32>] + [-TerminalSizeRow <Int32>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Executes a command for a specific container instance in a specified resource group and container group. + +## EXAMPLES + +### Example 1: Execute a command in a specific container instance +```powershell +Invoke-AzContainerInstanceCommand -ContainerGroupName test-cg -ContainerName test-container -ResourceGroupName test-rg -Command "echo hello" +``` + +```output +hello +``` + +Executes command "echo hello" in a container instance `test-container`. + +## PARAMETERS + +### -Command +The command to be executed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerGroupName +The name of the container group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +The name of the container instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns last execution result when the command succeeds. +By default the cmdlet returns nothing. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TerminalSizeCol +The column size of the terminal + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $host.UI.RawUI.WindowSize.Width +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TerminalSizeRow +The row size of the terminal + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $host.UI.RawUI.WindowSize.Height +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/New-AzContainerGroup.md b/azps-10.1.0/Az.ContainerInstance/New-AzContainerGroup.md new file mode 100644 index 0000000000..62177a35e7 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/New-AzContainerGroup.md @@ -0,0 +1,820 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/new-azcontainergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerGroup.md +--- + +# New-AzContainerGroup + +## SYNOPSIS +Create or update container groups with specified configurations. + +## SYNTAX + +``` +New-AzContainerGroup -Name <String> -ResourceGroupName <String> -Container <IContainer[]> -Location <String> + [-SubscriptionId <String>] [-DnsConfigNameServer <String[]>] [-DnsConfigOption <String>] + [-DnsConfigSearchDomain <String>] [-EncryptionPropertyKeyName <String>] + [-EncryptionPropertyKeyVersion <String>] [-EncryptionPropertyVaultBaseUrl <String>] + [-IdentityType <ResourceIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] + [-ImageRegistryCredential <IImageRegistryCredential[]>] [-InitContainer <IInitContainerDefinition[]>] + [-IPAddressDnsNameLabel <String>] [-IPAddressIP <String>] [-IPAddressPort <IPort[]>] + [-IPAddressType <ContainerGroupIPAddressType>] [-LogAnalyticLogType <LogAnalyticsLogType>] + [-LogAnalyticMetadata <Hashtable>] [-LogAnalyticWorkspaceId <String>] [-LogAnalyticWorkspaceKey <String>] + [-LogAnalyticWorkspaceResourceId <String>] [-OSType <OperatingSystemTypes>] [-Priority <String>] + [-RestartPolicy <ContainerGroupRestartPolicy>] [-Sku <ContainerGroupSku>] + [-SubnetId <IContainerGroupSubnetId[]>] [-Tag <Hashtable>] [-Volume <IVolume[]>] [-Zone <String[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update container groups with specified configurations. + +## EXAMPLES + +### Example 1: Create a container group with a container instance and request a public IP address with opening ports +```powershell +$port1 = New-AzContainerInstancePortObject -Port 8000 -Protocol TCP +$port2 = New-AzContainerInstancePortObject -Port 8001 -Protocol TCP +$container = New-AzContainerInstanceObject -Name test-container -Image nginx -RequestCpu 1 -RequestMemoryInGb 1.5 -Port @($port1, $port2) +$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -OsType Linux -RestartPolicy "Never" -IpAddressType Public +``` + +```output +Location Name Zone ResourceGroupName +-------- ---- ---- ----------------- +eastus test-cg test-rg +``` + +This commands creates a container group with a container instance, whose image is latest nginx, and requests a public IP address with opening port 8000 and 8001. + +### Example 2: Create container group and runs a custom script inside the container. +```powershell +$env1 = New-AzContainerInstanceEnvironmentVariableObject -Name "env1" -Value "value1" +$env2 = New-AzContainerInstanceEnvironmentVariableObject -Name "env2" -SecureValue (ConvertTo-SecureString -String "value2" -AsPlainText -Force) +$container = New-AzContainerInstanceObject -Name test-container -Image alpine -Command "/bin/sh -c myscript.sh" -EnvironmentVariable @($env1, $env2) +$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -OsType Linux +``` + +```output +Location Name Zone ResourceGroupName +-------- ---- ---- ----------------- +eastus test-cg test-rg +``` + +This commands creates a container group and runs a custom script inside the container. + +### Example 3: Create a run-to-completion container group +```powershell +$container = New-AzContainerInstanceObject -Name test-container -Image alpine -Command "echo hello" +$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -OsType Linux +``` + +```output +Location Name Zone ResourceGroupName +-------- ---- ---- ----------------- +eastus test-cg test-rg +``` + +This commands creates a container group which prints out 'hello' and stops. + +### Example 4: Create a container group with a container instance using image nginx in Azure Container Registry +```powershell +$container = New-AzContainerInstanceObject -Name test-container -Image myacr.azurecr.io/nginx:latest +$imageRegistryCredential = New-AzContainerGroupImageRegistryCredentialObject -Server "myacr.azurecr.io" -Username "username" -Password (ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force) +$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -ImageRegistryCredential $imageRegistryCredential +``` + +```output +Location Name Zone ResourceGroupName +-------- ---- ---- ----------------- +eastus test-cg test-rg +``` + +This commands creates a container group with a container instance, whose image is nginx in Azure Container Registry. + +### Example 5: Create a container group with a container instance using image nginx in custom container image Registry +```powershell +$container = New-AzContainerInstanceObject -Name test-container -Image myserver.com/nginx:latest +$imageRegistryCredential = New-AzContainerGroupImageRegistryCredentialObject -Server "myserver.com" -Username "username" -Password (ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force) +$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -ImageRegistryCredential $imageRegistryCredential +``` + +```output +Location Name Zone ResourceGroupName +-------- ---- ---- ----------------- +eastus test-cg test-rg +``` + +This commands creates a container group with a container instance, whose image is a custom image from a custom container image registry. + +### Example 6: Create a container group that mounts Azure File volume +```powershell +$volume = New-AzContainerGroupVolumeObject -Name "myvolume" -AzureFileShareName "myshare" -AzureFileStorageAccountName "username" -AzureFileStorageAccountKey (ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force) +$mount = New-AzContainerInstanceVolumeMountObject -MountPath "/aci/logs" -Name "myvolume" +$container = New-AzContainerInstanceObject -Name test-container -Image alpine -VolumeMount $mount +$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -Volume $volume +``` + +```output +Location Name Zone ResourceGroupName +-------- ---- ---- ----------------- +eastus test-cg test-rg +``` + +This commands creates a container group with a container instance, whose image is a custom image from a custom container image registry. + +### Example 7: Create a container group with system assigned and user assigned identity +```powershell +$container = New-AzContainerInstanceObject -Name test-container -Image alpine +$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -IdentityType "SystemAssigned, UserAssigned" -IdentityUserAssignedIdentity @{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" = @{}} +``` + +```output +Location Name Zone ResourceGroupName +-------- ---- ---- ----------------- +eastus test-cg test-rg +``` + +This commands creates a container group with system assigned and user assigned identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +The containers within the container group. +To construct, see NOTES section for CONTAINER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IContainer[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsConfigNameServer +The DNS servers for the container group. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsConfigOption +The DNS options for the container group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsConfigSearchDomain +The DNS search domains for hostname lookup in the container group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionPropertyKeyName +The encryption key name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionPropertyKeyVersion +The encryption key version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionPropertyVaultBaseUrl +The keyvault base url. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The type of identity used for the container group. +The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. +The type 'None' will remove any identities from the container group. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +The list of user identities associated with the container group. +The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageRegistryCredential +The image registry credentials by which the container group is created from. +To construct, see NOTES section for IMAGEREGISTRYCREDENTIAL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IImageRegistryCredential[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitContainer +The init containers for a container group. +To construct, see NOTES section for INITCONTAINER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IInitContainerDefinition[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressDnsNameLabel +The Dns name label for the IP. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressIP +The IP exposed to the public internet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressPort +The list of ports exposed on the container group. +To construct, see NOTES section for IPADDRESSPORT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IPort[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressType +Specifies if the IP is exposed to the public internet or private VNET. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Support.ContainerGroupIPAddressType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticLogType +The log type to be used. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Support.LogAnalyticsLogType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticMetadata +Metadata for log analytics. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticWorkspaceId +The workspace id for log analytics + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticWorkspaceKey +The workspace key for log analytics + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticWorkspaceResourceId +The workspace resource id for log analytics + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the container group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ContainerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSType +The operating system type required by the containers in the container group. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Support.OperatingSystemTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: "Linux" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The priority of the Container Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestartPolicy +Restart policy for all containers within the container group. +- `Always` Always restart- `OnFailure` Restart on failure- `Never` Never restart + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Support.ContainerGroupRestartPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SKU for a container group. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Support.ContainerGroupSku +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The subnet resource IDs for a container group. +To construct, see NOTES section for SUBNETID properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IContainerGroupSubnetId[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Volume +The list of volumes that can be mounted by containers in this container group. +To construct, see NOTES section for VOLUME properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IVolume[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +The zones for the container group. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IContainerGroup + +## 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. + + +`CONTAINER <IContainer[]>`: The containers within the container group. + - `Image <String>`: The name of the image used to create the container instance. + - `Name <String>`: The user-provided name of the container instance. + - `RequestCpu <Double>`: The CPU request of this container instance. + - `RequestMemoryInGb <Double>`: The memory request in GB of this container instance. + - `[Command <String[]>]`: The commands to execute within the container instance in exec form. + - `[EnvironmentVariable <IEnvironmentVariable[]>]`: The environment variables to set in the container instance. + - `Name <String>`: The name of the environment variable. + - `[SecureValue <String>]`: The value of the secure environment variable. + - `[Value <String>]`: The value of the environment variable. + - `[LimitCpu <Double?>]`: The CPU limit of this container instance. + - `[LimitMemoryInGb <Double?>]`: The memory limit in GB of this container instance. + - `[LimitsGpuCount <Int32?>]`: The count of the GPU resource. + - `[LimitsGpuSku <GpuSku?>]`: The SKU of the GPU resource. + - `[LivenessProbeExecCommand <String[]>]`: The commands to execute within the container. + - `[LivenessProbeFailureThreshold <Int32?>]`: The failure threshold. + - `[LivenessProbeHttpGetHttpHeader <IHttpHeader[]>]`: The HTTP headers. + - `[Name <String>]`: The header name. + - `[Value <String>]`: The header value. + - `[LivenessProbeHttpGetPath <String>]`: The path to probe. + - `[LivenessProbeHttpGetPort <Int32?>]`: The port number to probe. + - `[LivenessProbeHttpGetScheme <Scheme?>]`: The scheme. + - `[LivenessProbeInitialDelaySecond <Int32?>]`: The initial delay seconds. + - `[LivenessProbePeriodSecond <Int32?>]`: The period seconds. + - `[LivenessProbeSuccessThreshold <Int32?>]`: The success threshold. + - `[LivenessProbeTimeoutSecond <Int32?>]`: The timeout seconds. + - `[Port <IContainerPort[]>]`: The exposed ports on the container instance. + - `Port <Int32>`: The port number exposed within the container group. + - `[Protocol <ContainerNetworkProtocol?>]`: The protocol associated with the port. + - `[ReadinessProbeExecCommand <String[]>]`: The commands to execute within the container. + - `[ReadinessProbeFailureThreshold <Int32?>]`: The failure threshold. + - `[ReadinessProbeHttpGetHttpHeader <IHttpHeader[]>]`: The HTTP headers. + - `[ReadinessProbeHttpGetPath <String>]`: The path to probe. + - `[ReadinessProbeHttpGetPort <Int32?>]`: The port number to probe. + - `[ReadinessProbeHttpGetScheme <Scheme?>]`: The scheme. + - `[ReadinessProbeInitialDelaySecond <Int32?>]`: The initial delay seconds. + - `[ReadinessProbePeriodSecond <Int32?>]`: The period seconds. + - `[ReadinessProbeSuccessThreshold <Int32?>]`: The success threshold. + - `[ReadinessProbeTimeoutSecond <Int32?>]`: The timeout seconds. + - `[RequestsGpuCount <Int32?>]`: The count of the GPU resource. + - `[RequestsGpuSku <GpuSku?>]`: The SKU of the GPU resource. + - `[VolumeMount <IVolumeMount[]>]`: The volume mounts available to the container instance. + - `MountPath <String>`: The path within the container where the volume should be mounted. Must not contain colon (:). + - `Name <String>`: The name of the volume mount. + - `[ReadOnly <Boolean?>]`: The flag indicating whether the volume mount is read-only. + +`IMAGEREGISTRYCREDENTIAL <IImageRegistryCredential[]>`: The image registry credentials by which the container group is created from. + - `Server <String>`: The Docker image registry server without a protocol such as "http" and "https". + - `[Identity <String>]`: The identity for the private registry. + - `[IdentityUrl <String>]`: The identity URL for the private registry. + - `[Password <String>]`: The password for the private registry. + - `[Username <String>]`: The username for the private registry. + +`INITCONTAINER <IInitContainerDefinition[]>`: The init containers for a container group. + - `Name <String>`: The name for the init container. + - `[Command <String[]>]`: The command to execute within the init container in exec form. + - `[EnvironmentVariable <IEnvironmentVariable[]>]`: The environment variables to set in the init container. + - `Name <String>`: The name of the environment variable. + - `[SecureValue <String>]`: The value of the secure environment variable. + - `[Value <String>]`: The value of the environment variable. + - `[Image <String>]`: The image of the init container. + - `[VolumeMount <IVolumeMount[]>]`: The volume mounts available to the init container. + - `MountPath <String>`: The path within the container where the volume should be mounted. Must not contain colon (:). + - `Name <String>`: The name of the volume mount. + - `[ReadOnly <Boolean?>]`: The flag indicating whether the volume mount is read-only. + +`IPADDRESSPORT <IPort[]>`: The list of ports exposed on the container group. + - `Port1 <Int32>`: The port number. + - `[Protocol <ContainerGroupNetworkProtocol?>]`: The protocol associated with the port. + +`SUBNETID <IContainerGroupSubnetId[]>`: The subnet resource IDs for a container group. + - `Id <String>`: Resource ID of virtual network and subnet. + - `[Name <String>]`: Friendly name for the subnet. + +`VOLUME <IVolume[]>`: The list of volumes that can be mounted by containers in this container group. + - `Name <String>`: The name of the volume. + - `[AzureFileReadOnly <Boolean?>]`: The flag indicating whether the Azure File shared mounted as a volume is read-only. + - `[AzureFileShareName <String>]`: The name of the Azure File share to be mounted as a volume. + - `[AzureFileStorageAccountKey <String>]`: The storage account access key used to access the Azure File share. + - `[AzureFileStorageAccountName <String>]`: The name of the storage account that contains the Azure File share. + - `[EmptyDir <IVolumeEmptyDir>]`: The empty directory volume. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[GitRepoDirectory <String>]`: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. + - `[GitRepoRepository <String>]`: Repository URL + - `[GitRepoRevision <String>]`: Commit hash for the specified revision. + - `[Secret <ISecretVolume>]`: The secret volume. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/New-AzContainerGroupImageRegistryCredentialObject.md b/azps-10.1.0/Az.ContainerInstance/New-AzContainerGroupImageRegistryCredentialObject.md new file mode 100644 index 0000000000..960c09361c --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/New-AzContainerGroupImageRegistryCredentialObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.ContainerInstance/new-AzContainerGroupImageRegistryCredentialObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerGroupImageRegistryCredentialObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerGroupImageRegistryCredentialObject.md +--- + +# New-AzContainerGroupImageRegistryCredentialObject + +## SYNOPSIS +Create a in-memory object for ImageRegistryCredential + +## SYNTAX + +``` +New-AzContainerGroupImageRegistryCredentialObject -Server <String> [-AcrIdentity <String>] + [-Password <SecureString>] [-Username <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for ImageRegistryCredential + +## EXAMPLES + +### Example 1: Set up an image registry credential to create a container group +```powershell +New-AzContainerGroupImageRegistryCredentialObject -Server "myserver.com" -Username "username" -Password (ConvertTo-SecureString "******" -AsPlainText -Force) +``` + +```output +Password Server Username +-------- ------ -------- +****** myserver.com username +``` + +This command sets up an image registry credential to create a container group + +## PARAMETERS + +### -AcrIdentity +The identity with access to the ACR. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The password for the private registry. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The Docker image registry server without a protocol such as "http" and "https". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Username +The username for the private registry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.ImageRegistryCredential + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/New-AzContainerGroupPortObject.md b/azps-10.1.0/Az.ContainerInstance/New-AzContainerGroupPortObject.md new file mode 100644 index 0000000000..e8ccde5f70 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/New-AzContainerGroupPortObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.ContainerInstance/new-AzContainerGroupPortObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerGroupPortObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerGroupPortObject.md +--- + +# New-AzContainerGroupPortObject + +## SYNOPSIS +Create a in-memory object for Port + +## SYNTAX + +``` +New-AzContainerGroupPortObject -Port <Int32> [-Protocol <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for Port + +## EXAMPLES + +### Example 1: Specify port 8000 exposed on a container group with TCP protocol +```powershell +New-AzContainerGroupPortObject -Port 8000 -Protocol TCP +``` + +```output +Port1 Protocol +----- -------- +8000 TCP +``` + +This command specifies port 8000 exposed on a container group with TCP protocol. + +## PARAMETERS + +### -Port +The port number. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +The protocol associated with the port. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.Port + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/New-AzContainerGroupVolumeObject.md b/azps-10.1.0/Az.ContainerInstance/New-AzContainerGroupVolumeObject.md new file mode 100644 index 0000000000..d147bd1374 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/New-AzContainerGroupVolumeObject.md @@ -0,0 +1,246 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.ContainerInstance/new-AzContainerGroupVolumeObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerGroupVolumeObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerGroupVolumeObject.md +--- + +# New-AzContainerGroupVolumeObject + +## SYNOPSIS +Create an in-memory object for Volume. + +## SYNTAX + +``` +New-AzContainerGroupVolumeObject -Name <String> [-AzureFileReadOnly] [-AzureFileShareName <String>] + [-AzureFileStorageAccountKey <SecureString>] [-AzureFileStorageAccountName <String>] + [-EmptyDir <IVolumeEmptyDir>] [-GitRepoDirectoryName <String>] [-GitRepoRepositoryUrl <String>] + [-GitRepoRevision <String>] [-Secret <ISecretVolume>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for Volume. + +## EXAMPLES + +### Example 1: Create a Azure File volume +```powershell +New-AzContainerGroupVolumeObject -Name "myvolume" -AzureFileShareName "myshare" -AzureFileStorageAccountName "username" -AzureFileStorageAccountKey (ConvertTo-SecureString "******" -AsPlainText -Force) +``` + +```output +Name +---- +myvolume +``` + +This command creates a Azure File volume. + +### Example 2: Create an empty directory volume +```powershell +New-AzContainerGroupVolumeObject -Name "emptyvolume" -EmptyDir @{} | Format-List +``` + +```output +AzureFileReadOnly : +AzureFileShareName : +AzureFileStorageAccountKey : +AzureFileStorageAccountName : +EmptyDir : { + } +GitRepoDirectory : +GitRepoRepository : +GitRepoRevision : +Name : emptyvolume +Secret : { + } +``` + +This command creates an empty directory volume. + +## PARAMETERS + +### -AzureFileReadOnly +The flag indicating whether the Azure File shared mounted as a volume is read-only. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureFileShareName +The name of the Azure File share to be mounted as a volume. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureFileStorageAccountKey +The storage account access key used to access the Azure File share. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureFileStorageAccountName +The name of the storage account that contains the Azure File share. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmptyDir +The empty directory volume. +To construct, see NOTES section for EMPTYDIR properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IVolumeEmptyDir +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepoDirectoryName +Target directory name. +Must not contain or start with '..'. +If '.' is supplied, the volume directory will be the git repository. +Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepoRepositoryUrl +Repository URL. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepoRevision +Commit hash for the specified revision. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the volume. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Secret +The secret volume. +To construct, see NOTES section for SECRET properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.ISecretVolume +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.Volume + +## 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. + + +`EMPTYDIR <IVolumeEmptyDir>`: The empty directory volume. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + +`SECRET <ISecretVolume>`: The secret volume. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceEnvironmentVariableObject.md b/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceEnvironmentVariableObject.md new file mode 100644 index 0000000000..20d2c1638f --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceEnvironmentVariableObject.md @@ -0,0 +1,114 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.ContainerInstance/new-AzContainerInstanceEnvironmentVariableObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerInstanceEnvironmentVariableObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerInstanceEnvironmentVariableObject.md +--- + +# New-AzContainerInstanceEnvironmentVariableObject + +## SYNOPSIS +Create a in-memory object for EnvironmentVariable + +## SYNTAX + +``` +New-AzContainerInstanceEnvironmentVariableObject -Name <String> [-SecureValue <SecureString>] + [-Value <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for EnvironmentVariable + +## EXAMPLES + +### Example 1: Create an environment variable within a container instance +```powershell +New-AzContainerInstanceEnvironmentVariableObject -Name "env1" -Value "value1" +``` + +```output +Name SecureValue Value +---- ----------- ----- +env1 value1 +``` + +This command creates an environment variable within a container instance. + +### Example 2: Create a secure environment variable within a container instance +```powershell +New-AzContainerInstanceEnvironmentVariableObject -Name "env2" -SecureValue (ConvertTo-SecureString -String "******" -AsPlainText -Force) +``` + +```output +Name SecureValue Value +---- ----------- ----- +env2 ****** +``` + +This command creates a secure environment variable within a container instance + +## PARAMETERS + +### -Name +The name of the environment variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecureValue +The value of the secure environment variable. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The value of the environment variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.EnvironmentVariable + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceHttpHeaderObject.md b/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceHttpHeaderObject.md new file mode 100644 index 0000000000..23e7c8e6b0 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceHttpHeaderObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.ContainerInstance/New-AzContainerInstanceHttpHeaderObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerInstanceHttpHeaderObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerInstanceHttpHeaderObject.md +--- + +# New-AzContainerInstanceHttpHeaderObject + +## SYNOPSIS +Create a in-memory object for HttpHeader + +## SYNTAX + +``` +New-AzContainerInstanceHttpHeaderObject -Name <String> [-Value <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for HttpHeader + +## EXAMPLES + +### Example 1: Create an HTTP Header object +```powershell +New-AzContainerInstanceHttpHeaderObject -name foo -value bar +``` + +```output +Name Value +---- ----- +foo bar +``` + +Create an HTTP Header object to be used in liveness or readiness probes. + +## PARAMETERS + +### -Name +The header name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The header value.. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.HttpHeader + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceInitDefinitionObject.md b/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceInitDefinitionObject.md new file mode 100644 index 0000000000..dfeb19b79a --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceInitDefinitionObject.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.ContainerInstance/new-AzContainerInstanceInitDefinitionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerInstanceInitDefinitionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerInstanceInitDefinitionObject.md +--- + +# New-AzContainerInstanceInitDefinitionObject + +## SYNOPSIS +Create a in-memory object for InitContainerDefinition + +## SYNTAX + +``` +New-AzContainerInstanceInitDefinitionObject -Name <String> [-Command <String[]>] + [-EnvironmentVariable <IEnvironmentVariable[]>] [-Image <String>] [-VolumeMount <IVolumeMount[]>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for InitContainerDefinition + +## EXAMPLES + +### Example 1: Set up the init container definition +```powershell +New-AzContainerInstanceInitDefinitionObject -Name "initDefinition" -Command "/bin/sh -c myscript.sh" +``` + +```output +Name +---- +initDefinition +``` + +This command sets up the init container definition with command `/bin/sh -c myscript.sh` + +## PARAMETERS + +### -Command +The command to execute within the init container in exec form. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentVariable +The environment variables to set in the init container. +To construct, see NOTES section for ENVIRONMENTVARIABLE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IEnvironmentVariable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Image +The image of the init container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name for the init container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeMount +The volume mounts available to the init container. +To construct, see NOTES section for VOLUMEMOUNT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IVolumeMount[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.InitContainerDefinition + +## 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. + + +`ENVIRONMENTVARIABLE <IEnvironmentVariable[]>`: The environment variables to set in the init container. + - `Name <String>`: The name of the environment variable. + - `[SecureValue <String>]`: The value of the secure environment variable. + - `[Value <String>]`: The value of the environment variable. + +`VOLUMEMOUNT <IVolumeMount[]>`: The volume mounts available to the init container. + - `MountPath <String>`: The path within the container where the volume should be mounted. Must not contain colon (:). + - `Name <String>`: The name of the volume mount. + - `[ReadOnly <Boolean?>]`: The flag indicating whether the volume mount is read-only. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceObject.md b/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceObject.md new file mode 100644 index 0000000000..f02ee16cb8 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceObject.md @@ -0,0 +1,637 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.ContainerInstance/new-AzContainerInstanceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerInstanceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerInstanceObject.md +--- + +# New-AzContainerInstanceObject + +## SYNOPSIS +Create a in-memory object for Container + +## SYNTAX + +``` +New-AzContainerInstanceObject -Image <String> -Name <String> [-Command <String[]>] + [-EnvironmentVariable <IEnvironmentVariable[]>] [-LimitCpu <Double>] [-LimitMemoryInGb <Double>] + [-LimitsGpuCount <Int32>] [-LimitsGpuSku <String>] [-LivenessProbeExecCommand <String[]>] + [-LivenessProbeFailureThreshold <Int32>] [-LivenessProbeHttpGetHttpHeader <IHttpHeader[]>] + [-LivenessProbeHttpGetPath <String>] [-LivenessProbeHttpGetPort <Int32>] + [-LivenessProbeHttpGetScheme <String>] [-LivenessProbeInitialDelaySecond <Int32>] + [-LivenessProbePeriodSecond <Int32>] [-LivenessProbeSuccessThreshold <Int32>] + [-LivenessProbeTimeoutSecond <Int32>] [-Port <IContainerPort[]>] [-ReadinessProbeExecCommand <String[]>] + [-ReadinessProbeFailureThreshold <Int32>] [-ReadinessProbeHttpGetHttpHeader <IHttpHeader[]>] + [-ReadinessProbeHttpGetPath <String>] [-ReadinessProbeHttpGetPort <Int32>] + [-ReadinessProbeHttpGetScheme <String>] [-ReadinessProbeInitialDelaySecond <Int32>] + [-ReadinessProbePeriodSecond <Int32>] [-ReadinessProbeSuccessThreshold <Int32>] + [-ReadinessProbeTimeoutSecond <Int32>] [-RequestCpu <Double>] [-RequestMemoryInGb <Double>] + [-RequestsGpuCount <Int32>] [-RequestsGpuSku <String>] [-VolumeMount <IVolumeMount[]>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for Container + +## EXAMPLES + +### Example 1: Create a container instance using image alphine with request cpu 1.0 and request memory 1.5Gb +```powershell +New-AzContainerInstanceObject -Name "test-container" -Image alpine -RequestCpu 1 -RequestMemoryInGb 1.5 +``` + +```output +Name +---- +test-container +``` + +Create a container instance using image alphine with request cpu 1.0 and request memory 1.5Gb + +### Example 2: Create a container instance using image alphine with limit cpu 2.0 and limit memory 2.5Gb +```powershell +New-AzContainerInstanceObject -Image alpine -Name "test-container" -LimitCpu 2 -LimitMemoryInGb 2.5 +``` + +```output +Name +---- +test-container +``` + +Create a container instance using image alphine with limit cpu 2.0 and limit memory 2.5Gb + +### Example 3: Create a container group with a container instance +```powershell +$container = New-AzContainerInstanceObject -Name test-container -Image alpine +New-AzContainerGroup -ResourceGroupName testrg-rg -Name test-cg -Location eastus -Container $container +``` + +```output +Location Name Zone ResourceGroupName +-------- ---- ---- ----------------- +eastus test-cg test-rg +``` + +Create a container group with a container instance + +## PARAMETERS + +### -Command +The commands to execute within the container instance in exec form. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentVariable +The environment variables to set in the container instance. +To construct, see NOTES section for ENVIRONMENTVARIABLE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IEnvironmentVariable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Image +The name of the image used to create the container instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitCpu +The CPU limit of this container instance. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitMemoryInGb +The memory limit in GB of this container instance. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitsGpuCount +The count of the GPU resource. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitsGpuSku +The SKU of the GPU resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbeExecCommand +The commands to execute within the container. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbeFailureThreshold +The failure threshold. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbeHttpGetHttpHeader +The HTTP headers for liveness probe. +To construct, see NOTES section for LIVENESSPROBEHTTPGETHTTPHEADER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IHttpHeader[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbeHttpGetPath +The path to probe. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbeHttpGetPort +The port number to probe. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbeHttpGetScheme +The scheme. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbeInitialDelaySecond +The initial delay seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbePeriodSecond +The period seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbeSuccessThreshold +The success threshold. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbeTimeoutSecond +The timeout seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The user-provided name of the container instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +The exposed ports on the container instance. +To construct, see NOTES section for PORT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IContainerPort[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbeExecCommand +The commands to execute within the container. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbeFailureThreshold +The failure threshold. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbeHttpGetHttpHeader +The HTTP headers for readiness probe. +To construct, see NOTES section for READINESSPROBEHTTPGETHTTPHEADER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IHttpHeader[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbeHttpGetPath +The path to probe. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbeHttpGetPort +The port number to probe. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbeHttpGetScheme +The scheme. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbeInitialDelaySecond +The initial delay seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbePeriodSecond +The period seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbeSuccessThreshold +The success threshold. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbeTimeoutSecond +The timeout seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestCpu +The CPU request of this container instance. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestMemoryInGb +The memory request in GB of this container instance. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestsGpuCount +The count of the GPU resource. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestsGpuSku +The SKU of the GPU resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeMount +The volume mounts available to the container instance. +To construct, see NOTES section for VOLUMEMOUNT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IVolumeMount[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.Container + +## 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. + + +`ENVIRONMENTVARIABLE <IEnvironmentVariable[]>`: The environment variables to set in the container instance. + - `Name <String>`: The name of the environment variable. + - `[SecureValue <String>]`: The value of the secure environment variable. + - `[Value <String>]`: The value of the environment variable. + +`LIVENESSPROBEHTTPGETHTTPHEADER <IHttpHeader[]>`: The HTTP headers for liveness probe. + - `[Name <String>]`: The header name. + - `[Value <String>]`: The header value. + +`PORT <IContainerPort[]>`: The exposed ports on the container instance. + - `Port <Int32>`: The port number exposed within the container group. + - `[Protocol <ContainerNetworkProtocol?>]`: The protocol associated with the port. + +`READINESSPROBEHTTPGETHTTPHEADER <IHttpHeader[]>`: The HTTP headers for readiness probe. + - `[Name <String>]`: The header name. + - `[Value <String>]`: The header value. + +`VOLUMEMOUNT <IVolumeMount[]>`: The volume mounts available to the container instance. + - `MountPath <String>`: The path within the container where the volume should be mounted. Must not contain colon (:). + - `Name <String>`: The name of the volume mount. + - `[ReadOnly <Boolean?>]`: The flag indicating whether the volume mount is read-only. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstancePortObject.md b/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstancePortObject.md new file mode 100644 index 0000000000..142cd87234 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstancePortObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.ContainerInstance/new-AzContainerInstancePortObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerInstancePortObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerInstancePortObject.md +--- + +# New-AzContainerInstancePortObject + +## SYNOPSIS +Create a in-memory object for ContainerPort + +## SYNTAX + +``` +New-AzContainerInstancePortObject -Port <Int32> [-Protocol <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for ContainerPort + +## EXAMPLES + +### Example 1: Specify port 8000 exposed on a container instance with TCP protocol +```powershell +New-AzContainerInstancePortObject -Port 8000 -Protocol TCP +``` + +```output +Port Protocol +----- -------- +8000 TCP +``` + +This command specifies port 8000 exposed on the container instance with TCP protocol. + +## PARAMETERS + +### -Port +The port number exposed within the container group. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +The protocol associated with the port. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.ContainerPort + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceVolumeMountObject.md b/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceVolumeMountObject.md new file mode 100644 index 0000000000..0a16fb6e53 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/New-AzContainerInstanceVolumeMountObject.md @@ -0,0 +1,102 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.ContainerInstance/new-AzContainerInstanceVolumeMountObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerInstanceVolumeMountObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/New-AzContainerInstanceVolumeMountObject.md +--- + +# New-AzContainerInstanceVolumeMountObject + +## SYNOPSIS +Create a in-memory object for VolumeMount + +## SYNTAX + +``` +New-AzContainerInstanceVolumeMountObject -MountPath <String> -Name <String> [-ReadOnly <Boolean>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for VolumeMount + +## EXAMPLES + +### Example 1: Specify a volume mount available to a container instance +```powershell +New-AzContainerInstanceVolumeMountObject -Name "mnt" -MountPath "/mnt/azfile" -ReadOnly $true +``` + +```output +MountPath Name ReadOnly +--------- ---- -------- +/mnt/azfile mnt True +``` + +This command specifies a volume mount available to a container instance + +## PARAMETERS + +### -MountPath +The path within the container where the volume should be mounted. +Must not contain colon (:). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the volume mount. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadOnly +The flag indicating whether the volume mount is read-only. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.VolumeMount + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Remove-AzContainerGroup.md b/azps-10.1.0/Az.ContainerInstance/Remove-AzContainerGroup.md new file mode 100644 index 0000000000..50f67303a2 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Remove-AzContainerGroup.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/remove-azcontainergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Remove-AzContainerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Remove-AzContainerGroup.md +--- + +# Remove-AzContainerGroup + +## SYNOPSIS +Delete the specified container group in the specified subscription and resource group. +The operation does not delete other resources provided by the user, such as volumes. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerGroup -InputObject <IContainerInstanceIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the specified container group in the specified subscription and resource group. +The operation does not delete other resources provided by the user, such as volumes. + +## EXAMPLES + +### Example 1: Remove a container group +```powershell +Remove-AzContainerGroup -Name test-cg -ResourceGroupName test-rg +``` + +```output +Location Name Zone ResourceGroupName +-------- ---- ---- ----------------- +eastus test-cg test-rg +``` + +This command removes the specified container group. + +### Example 2: Removes a container group by piping +```powershell +Get-AzContainerGroup -Name test-cg -ResourceGroupName bez-rg | Remove-AzContainerGroup +``` + +```output +Location Name Zone ResourceGroupName +-------- ---- ---- ----------------- +eastus test-cg test-rg +``` + +This command removes a container group by piping. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the container group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ContainerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IContainerGroup + +## 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 <IContainerInstanceIdentity>`: Identity Parameter + - `[ContainerGroupName <String>]`: The name of the container group. + - `[ContainerName <String>]`: The name of the container instance. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The identifier for the physical azure location. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubnetName <String>]`: The name of the subnet. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Remove-AzContainerInstanceSubnetServiceAssociationLink.md b/azps-10.1.0/Az.ContainerInstance/Remove-AzContainerInstanceSubnetServiceAssociationLink.md new file mode 100644 index 0000000000..c91d241d2c --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Remove-AzContainerInstanceSubnetServiceAssociationLink.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/remove-azcontainerinstancesubnetserviceassociationlink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Remove-AzContainerInstanceSubnetServiceAssociationLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Remove-AzContainerInstanceSubnetServiceAssociationLink.md +--- + +# Remove-AzContainerInstanceSubnetServiceAssociationLink + +## SYNOPSIS +Delete container group virtual network association links. +The operation does not delete other resources provided by the user. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerInstanceSubnetServiceAssociationLink -ResourceGroupName <String> -SubnetName <String> + -VirtualNetworkName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerInstanceSubnetServiceAssociationLink -InputObject <IContainerInstanceIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete container group virtual network association links. +The operation does not delete other resources provided by the user. + +## EXAMPLES + +### Example 1: Remove Subnet Service Association Link +```powershell +Remove-AzContainerInstanceSubnetServiceAssociationLink -ResourceGroupName testRg -SubnetName testSubnetName -VirtualNetworkName testVnetName +``` + +Removes the service association link for the specified subnet. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetName +The name of the subnet. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkName +The name of the virtual network. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerInstanceIdentity>`: Identity Parameter + - `[ContainerGroupName <String>]`: The name of the container group. + - `[ContainerName <String>]`: The name of the container instance. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The identifier for the physical azure location. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubnetName <String>]`: The name of the subnet. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Restart-AzContainerGroup.md b/azps-10.1.0/Az.ContainerInstance/Restart-AzContainerGroup.md new file mode 100644 index 0000000000..9457b1cf24 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Restart-AzContainerGroup.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/restart-azcontainergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Restart-AzContainerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Restart-AzContainerGroup.md +--- + +# Restart-AzContainerGroup + +## SYNOPSIS +Restarts all containers in a container group in place. +If container image has updates, new image will be downloaded. + +## SYNTAX + +### Restart (Default) +``` +Restart-AzContainerGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RestartViaIdentity +``` +Restart-AzContainerGroup -InputObject <IContainerInstanceIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Restarts all containers in a container group in place. +If container image has updates, new image will be downloaded. + +## EXAMPLES + +### Example 1: Restart all containers in a container group +```powershell +Restart-AzContainerGroup -Name test-cg -ResourceGroupName test-rg +``` + +This command restarts all containers in a container group. + +### Example 2: Restart all containers in a container group by piping +```powershell +Get-AzContainerGroup -Name test-cg -ResourceGroupName test-rg | Restart-AzContainerGroup +``` + +This command restarts all containers in a container group by piping. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity +Parameter Sets: RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the container group. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: ContainerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerInstanceIdentity>`: Identity Parameter + - `[ContainerGroupName <String>]`: The name of the container group. + - `[ContainerName <String>]`: The name of the container instance. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The identifier for the physical azure location. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubnetName <String>]`: The name of the subnet. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Start-AzContainerGroup.md b/azps-10.1.0/Az.ContainerInstance/Start-AzContainerGroup.md new file mode 100644 index 0000000000..7796d2634c --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Start-AzContainerGroup.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/start-azcontainergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Start-AzContainerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Start-AzContainerGroup.md +--- + +# Start-AzContainerGroup + +## SYNOPSIS +Starts all containers in a container group. +Compute resources will be allocated and billing will start. + +## SYNTAX + +### Start (Default) +``` +Start-AzContainerGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzContainerGroup -InputObject <IContainerInstanceIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Starts all containers in a container group. +Compute resources will be allocated and billing will start. + +## EXAMPLES + +### Example 1: Start all containers in a container group +```powershell +Start-AzContainerGroup -Name test-cg -ResourceGroupName test-rg +``` + +This command starts all containers in a container group. + +### Example 2: Start all containers in a container group by piping +```powershell +Get-AzContainerGroup -Name test-cg -ResourceGroupName test-rg | Start-AzContainerGroup +``` + +This command starts all containers in a container group by piping. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the container group. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: ContainerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerInstanceIdentity>`: Identity Parameter + - `[ContainerGroupName <String>]`: The name of the container group. + - `[ContainerName <String>]`: The name of the container instance. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The identifier for the physical azure location. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubnetName <String>]`: The name of the subnet. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Stop-AzContainerGroup.md b/azps-10.1.0/Az.ContainerInstance/Stop-AzContainerGroup.md new file mode 100644 index 0000000000..b138b5eda1 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Stop-AzContainerGroup.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/stop-azcontainergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Stop-AzContainerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Stop-AzContainerGroup.md +--- + +# Stop-AzContainerGroup + +## SYNOPSIS +Stops all containers in a container group. +Compute resources will be deallocated and billing will stop. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzContainerGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzContainerGroup -InputObject <IContainerInstanceIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Stops all containers in a container group. +Compute resources will be deallocated and billing will stop. + +## EXAMPLES + +### Example 1: Stop all containers in a container group +```powershell +Stop-AzContainerGroup -Name test-cg -ResourceGroupName test-rg +``` + +This command stops all containers in a container group. +Compute resources will be deallocated and billing will stop. + +### Example 2: Stop all containers in a container group by piping +```powershell +Get-AzContainerGroup -Name test-cg -ResourceGroupName test-rg | Stop-AzContainerGroup +``` + +This command stops all containers in a container group by piping. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the container group. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: ContainerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerInstanceIdentity>`: Identity Parameter + - `[ContainerGroupName <String>]`: The name of the container group. + - `[ContainerName <String>]`: The name of the container instance. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The identifier for the physical azure location. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubnetName <String>]`: The name of the subnet. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerInstance/Update-AzContainerGroup.md b/azps-10.1.0/Az.ContainerInstance/Update-AzContainerGroup.md new file mode 100644 index 0000000000..8ec991f703 --- /dev/null +++ b/azps-10.1.0/Az.ContainerInstance/Update-AzContainerGroup.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.ContainerInstance +online version: https://learn.microsoft.com/powershell/module/az.containerinstance/update-azcontainergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Update-AzContainerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerInstance/help/Update-AzContainerGroup.md +--- + +# Update-AzContainerGroup + +## SYNOPSIS +Updates container group tags with specified values. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzContainerGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Location <String>] [-Tag <Hashtable>] [-Zone <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzContainerGroup -InputObject <IContainerInstanceIdentity> [-Location <String>] [-Tag <Hashtable>] + [-Zone <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates container group tags with specified values. + +## EXAMPLES + +### Example 1: Update a container group +```powershell +$container = Update-AzContainerGroup -Name test-cg -ResourceGroupName test-rg -Tag @{"k"="v"} +$container.Tag | Format-List +``` + +```output +Keys : {k} +Values : {v} +AdditionalProperties : {[k, v]} +Count : 1 +``` + +This command updates a container group. + +### Example 2: Update a container group using piping +```powershell +$container = Get-AzContainerGroup -Name test-cg -ResourceGroupName test-rg | Update-AzContainerGroup -Tag @{"k"="v"} +$container.Tag | Format-List +``` + +```output +Keys : {k} +Values : {v} +AdditionalProperties : {[k, v]} +Count : 1 +``` + +This command updates a container group using pipeing. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The 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 +``` + +### -Name +The name of the container group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ContainerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +The zones for the container group. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerInstanceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20221001Preview.IContainerGroup + +## 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 <IContainerInstanceIdentity>`: Identity Parameter + - `[ContainerGroupName <String>]`: The name of the container group. + - `[ContainerName <String>]`: The name of the container instance. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The identifier for the physical azure location. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubnetName <String>]`: The name of the subnet. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ContainerRegistry/Az.ContainerRegistry.md b/azps-10.1.0/Az.ContainerRegistry/Az.ContainerRegistry.md new file mode 100644 index 0000000000..be3e5549bb --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Az.ContainerRegistry.md @@ -0,0 +1,163 @@ +--- +Module Name: Az.ContainerRegistry +Module Guid: b3ca459c-feb9-41cc-a954-46222505acb3 +Download Help Link: https://learn.microsoft.com/powershell/module/az.containerregistry +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Az.ContainerRegistry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Az.ContainerRegistry.md +--- + +# Az.ContainerRegistry Module +## Description +This topic displays help topics for the Azure Container Registry Management Cmdlets. + +## Az.ContainerRegistry Cmdlets +### [Connect-AzContainerRegistry](Connect-AzContainerRegistry.md) +Login to an azure container registry. + +### [Get-AzContainerRegistry](Get-AzContainerRegistry.md) +Gets the properties of the specified container registry. + +### [Get-AzContainerRegistryAgentPool](Get-AzContainerRegistryAgentPool.md) +Gets the detailed information for a given agent pool. + +### [Get-AzContainerRegistryAgentPoolQueueStatus](Get-AzContainerRegistryAgentPoolQueueStatus.md) +Gets the count of queued runs for a given agent pool. + +### [Get-AzContainerRegistryCredential](Get-AzContainerRegistryCredential.md) +Lists the login credentials for the specified container registry. + +### [Get-AzContainerRegistryExportPipeline](Get-AzContainerRegistryExportPipeline.md) +Gets the properties of the export pipeline. + +### [Get-AzContainerRegistryImportPipeline](Get-AzContainerRegistryImportPipeline.md) +Gets the properties of the import pipeline. + +### [Get-AzContainerRegistryManifest](Get-AzContainerRegistryManifest.md) +Get or list ACR manifest. + +### [Get-AzContainerRegistryReplication](Get-AzContainerRegistryReplication.md) +Gets the properties of the specified replication. + +### [Get-AzContainerRegistryRepository](Get-AzContainerRegistryRepository.md) +Get or list ACR repositories. + +### [Get-AzContainerRegistryScopeMap](Get-AzContainerRegistryScopeMap.md) +Gets the properties of the specified scope map. + +### [Get-AzContainerRegistryTag](Get-AzContainerRegistryTag.md) +Get or list ACR tag. + +### [Get-AzContainerRegistryToken](Get-AzContainerRegistryToken.md) +Gets the properties of the specified token. + +### [Get-AzContainerRegistryUsage](Get-AzContainerRegistryUsage.md) +Gets the quota usages for the specified container registry. + +### [Get-AzContainerRegistryWebhook](Get-AzContainerRegistryWebhook.md) +Gets the properties of the specified webhook. + +### [Get-AzContainerRegistryWebhookCallbackConfig](Get-AzContainerRegistryWebhookCallbackConfig.md) +Gets the configuration of service URI and custom headers for the webhook. + +### [Get-AzContainerRegistryWebhookEvent](Get-AzContainerRegistryWebhookEvent.md) +Lists recent events for the specified webhook. + +### [Import-AzContainerRegistryImage](Import-AzContainerRegistryImage.md) +Copies an image to this container registry from the specified container registry. + +### [New-AzContainerRegistry](New-AzContainerRegistry.md) +Creates a container registry with the specified parameters. + +### [New-AzContainerRegistryAgentPool](New-AzContainerRegistryAgentPool.md) +Creates an agent pool for a container registry with the specified parameters. + +### [New-AzContainerRegistryExportPipeline](New-AzContainerRegistryExportPipeline.md) +Creates an export pipeline for a container registry with the specified parameters. + +### [New-AzContainerRegistryImportPipeline](New-AzContainerRegistryImportPipeline.md) +Creates an import pipeline for a container registry with the specified parameters. + +### [New-AzContainerRegistryIPRuleObject](New-AzContainerRegistryIPRuleObject.md) +Create an in-memory object for IPRule. + +### [New-AzContainerRegistryReplication](New-AzContainerRegistryReplication.md) +Creates a replication for a container registry with the specified parameters. + +### [New-AzContainerRegistryScopeMap](New-AzContainerRegistryScopeMap.md) +Creates a scope map for a container registry with the specified parameters. + +### [New-AzContainerRegistryToken](New-AzContainerRegistryToken.md) +Creates a token for a container registry with the specified parameters. + +### [New-AzContainerRegistryWebhook](New-AzContainerRegistryWebhook.md) +Creates a webhook for a container registry with the specified parameters. + +### [Remove-AzContainerRegistry](Remove-AzContainerRegistry.md) +Deletes a container registry. + +### [Remove-AzContainerRegistryAgentPool](Remove-AzContainerRegistryAgentPool.md) +Deletes a specified agent pool resource. + +### [Remove-AzContainerRegistryExportPipeline](Remove-AzContainerRegistryExportPipeline.md) +Deletes an export pipeline from a container registry. + +### [Remove-AzContainerRegistryImportPipeline](Remove-AzContainerRegistryImportPipeline.md) +Deletes an import pipeline from a container registry. + +### [Remove-AzContainerRegistryManifest](Remove-AzContainerRegistryManifest.md) +Delete ACR manifest. + +### [Remove-AzContainerRegistryReplication](Remove-AzContainerRegistryReplication.md) +Deletes a replication from a container registry. + +### [Remove-AzContainerRegistryRepository](Remove-AzContainerRegistryRepository.md) +Delete repository from ACR. + +### [Remove-AzContainerRegistryScopeMap](Remove-AzContainerRegistryScopeMap.md) +Deletes a scope map from a container registry. + +### [Remove-AzContainerRegistryTag](Remove-AzContainerRegistryTag.md) +Untag ACR tag. + +### [Remove-AzContainerRegistryToken](Remove-AzContainerRegistryToken.md) +Deletes a token from a container registry. + +### [Remove-AzContainerRegistryWebhook](Remove-AzContainerRegistryWebhook.md) +Deletes a webhook from a container registry. + +### [Test-AzContainerRegistryNameAvailability](Test-AzContainerRegistryNameAvailability.md) +Checks whether the container registry name is available for use. +The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length. + +### [Test-AzContainerRegistryWebhook](Test-AzContainerRegistryWebhook.md) +Triggers a ping event to be sent to the webhook. + +### [Update-AzContainerRegistry](Update-AzContainerRegistry.md) +Updates a container registry with the specified parameters. + +### [Update-AzContainerRegistryAgentPool](Update-AzContainerRegistryAgentPool.md) +Updates an agent pool with the specified parameters. + +### [Update-AzContainerRegistryCredential](Update-AzContainerRegistryCredential.md) +Regenerates one of the login credentials for the specified container registry. + +### [Update-AzContainerRegistryManifest](Update-AzContainerRegistryManifest.md) +Update ACR manifest. + +### [Update-AzContainerRegistryRepository](Update-AzContainerRegistryRepository.md) +Update ACR repository. + +### [Update-AzContainerRegistryScopeMap](Update-AzContainerRegistryScopeMap.md) +Updates a scope map with the specified parameters. + +### [Update-AzContainerRegistryTag](Update-AzContainerRegistryTag.md) +Update ACR tag. + +### [Update-AzContainerRegistryToken](Update-AzContainerRegistryToken.md) +Updates a token with the specified parameters. + +### [Update-AzContainerRegistryWebhook](Update-AzContainerRegistryWebhook.md) +Updates a webhook with the specified parameters. + diff --git a/azps-10.1.0/Az.ContainerRegistry/Connect-AzContainerRegistry.md b/azps-10.1.0/Az.ContainerRegistry/Connect-AzContainerRegistry.md new file mode 100644 index 0000000000..e20a71a10e --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Connect-AzContainerRegistry.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.dll-Help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/connect-azcontainerregistry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Connect-AzContainerRegistry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Connect-AzContainerRegistry.md +--- + +# Connect-AzContainerRegistry + +## SYNOPSIS +Login to an azure container registry. + +## SYNTAX + +### WithoutNameAndPasswordParameterSet (Default) +``` +Connect-AzContainerRegistry -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### WithNameAndPasswordParameterSet +``` +Connect-AzContainerRegistry -Name <String> -UserName <String> -Password <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Login to an azure container registry. + +## EXAMPLES + +### Example 1 +```powershell +Connect-AzContainerRegistry -Name $RegistryName +``` + +Login to ACR with no credentials when already login to azure account. + +### Example 2 +```powershell +Connect-AzContainerRegistry -Name $RegistryName -UserName $RegistryName -Password $AdminPassWord +``` + +Login to ACR with admin username/password when admin user was enabled. + +### Example 3 +```powershell +Connect-AzContainerRegistry -Name $RegistryName -UserName $ServicePrincipal -Password $ServicePrincipalPassword +``` + +Login to ACR with service principal application ID and password. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure Container Registry Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Password For Azure Container Registry. + +```yaml +Type: System.String +Parameter Sets: WithNameAndPasswordParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserName +User Name For Azure Container Registry. + +```yaml +Type: System.String +Parameter Sets: WithNameAndPasswordParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistry.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistry.md new file mode 100644 index 0000000000..d58b4befe7 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistry.md @@ -0,0 +1,224 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistry.md +--- + +# Get-AzContainerRegistry + +## SYNOPSIS +Gets the properties of the specified container registry. + +## SYNTAX + +### List2 (Default) +``` +Get-AzContainerRegistry [-SubscriptionId <String[]>] [-IncludeDetail] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzContainerRegistry [-SubscriptionId <String[]>] [-IncludeDetail] -ResourceGroupName <String> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzContainerRegistry [-SubscriptionId <String[]>] [-IncludeDetail] -Name <String> + -ResourceGroupName <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzContainerRegistry [-IncludeDetail] -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the specified container registry. + +## EXAMPLES + +### Example 1: Get a specified container registry +```powershell +Get-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" +``` + +```output +Name SkuName LoginServer CreationDate ProvisioningState AdminUserEnabled +---- ------- ----------- ------------ ----------------- ---------------- +testc Premium testc.azurecr.io 16/01/2023 8:45:50 pm Succeeded True +``` + +This command gets the specified container registry. + +### Example 2: Get all the container registries in a resource group +```powershell +Get-AzContainerRegistry -ResourceGroupName "MyResourceGroup" +``` + +```output +Name SkuName LoginServer CreationDate ProvisioningState AdminUserEnabled +---- ------- ----------- ------------ ----------------- ---------------- +testc2 Premium testc2.azurecr.io 17/01/2023 3:47:50 pm Succeeded True +testc Premium testc.azurecr.io 16/01/2023 8:45:50 pm Succeeded True +``` + +This command gets all the container registries in a resource group. + +### Example 3: Get all the container registries in the subscription +```powershell +Get-AzContainerRegistry +``` + +```output +Name SkuName LoginServer CreationDate ProvisioningState AdminUserEnabled +---- ------- ----------- ------------ ----------------- ---------------- +testc2 Premium testc2.azurecr.io 17/01/2023 3:47:50 pm Succeeded True +testc Premium testc.azurecr.io 16/01/2023 8:45:50 pm Succeeded True +``` + +This command gets all the container registries in the subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDetail +Usage of an azure container registry. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RegistryName, ResourceName, ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List1, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List2, List1, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistry + +## 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 <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryAgentPool.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryAgentPool.md new file mode 100644 index 0000000000..d1082ca454 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryAgentPool.md @@ -0,0 +1,190 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistryagentpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryAgentPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryAgentPool.md +--- + +# Get-AzContainerRegistryAgentPool + +## SYNOPSIS +Gets the detailed information for a given agent pool. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerRegistryAgentPool -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzContainerRegistryAgentPool -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzContainerRegistryAgentPool -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the detailed information for a given agent pool. + +## EXAMPLES + +### Example 1: Get the agent pool of an registry +```powershell +Get-AzContainerRegistryAgentPool -RegistryName RegistryExample -ResourceGroupName MyResourceGroup +``` + +```output +Name Location OS Count ProvisioningState +---- -------- -- ----- ----------------- +agent eastus Linux 5 Succeeded +``` + +Get the agent pool of an registry + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the agent pool. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AgentPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the container registry belongs. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api20190601Preview.IAgentPool + +## 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 <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryAgentPoolQueueStatus.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryAgentPoolQueueStatus.md new file mode 100644 index 0000000000..5efca5894f --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryAgentPoolQueueStatus.md @@ -0,0 +1,214 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistryagentpoolqueuestatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryAgentPoolQueueStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryAgentPoolQueueStatus.md +--- + +# Get-AzContainerRegistryAgentPoolQueueStatus + +## SYNOPSIS +Gets the count of queued runs for a given agent pool. + +## SYNTAX + +### Get (Default) +``` +Get-AzContainerRegistryAgentPoolQueueStatus -AgentPoolName <String> -RegistryName <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzContainerRegistryAgentPoolQueueStatus -InputObject <IContainerRegistryIdentity> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the count of queued runs for a given agent pool. + +## EXAMPLES + +### Example 1: Gets the count of queued runs for a given agent pool. +```powershell +Get-AzContainerRegistryAgentPoolQueueStatus -AgentPoolName agent -RegistryName RegistryExample -ResourceGroupName MyResourceGroup +``` + +```output +10 +``` + +Gets the count of queued runs for a given agent pool. + +## PARAMETERS + +### -AgentPoolName +The name of the agent pool. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the container registry belongs. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### System.Int32 + +## 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 <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryCredential.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryCredential.md new file mode 100644 index 0000000000..c9c80e6ff3 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryCredential.md @@ -0,0 +1,219 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistrycredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryCredential.md +--- + +# Get-AzContainerRegistryCredential + +## SYNOPSIS +Lists the login credentials for the specified container registry. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerRegistryCredential -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GetByRegistry +``` +Get-AzContainerRegistryCredential [-SubscriptionId <String[]>] -Registry <IRegistry> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Lists the login credentials for the specified container registry. + +## EXAMPLES + +### Example 1: Get the login credentials for a container registry +```powershell +Get-AzContainerRegistryCredential -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" +``` + +```output +Username Password Password2 +-------- -------- --------- +RegistryExample xxxxxxxxx XXXXXXXXX +``` + +This command gets the login credentials for the specified container registry. +Admin user has to be enabled for the container registry `RegistryExample` to get login credentials. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Registry +The Registry Object. +To construct, see NOTES section for REGISTRY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistry +Parameter Sets: GetByRegistry +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistry + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.PSContainerRegistryCredential + +## 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. + + +`REGISTRY <IRegistry>`: The Registry Object. + - `Location <String>`: The location of the resource. This cannot be changed after the resource is created. + - `SkuName <SkuName>`: The SKU name of the container registry. Required for registry creation. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource modification (UTC). + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <LastModifiedByType?>]`: The type of identity that last modified the resource. + - `[Tag <IResourceTags>]`: The tags of the resource. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdminUserEnabled <Boolean?>]`: The value that indicates whether the admin user is enabled. + - `[AnonymousPullEnabled <Boolean?>]`: Enables registry-wide pull from unauthenticated clients. + - `[AzureAdAuthenticationAsArmPolicyStatus <AzureAdAuthenticationAsArmPolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[AzureAsyncOperation <String>]`: + - `[DataEndpointEnabled <Boolean?>]`: Enable a single data endpoint per region for serving data. + - `[EncryptionStatus <EncryptionStatus?>]`: Indicates whether or not the encryption is enabled for container registry. + - `[ExportPolicyStatus <ExportPolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[IdentityPrincipalId <String>]`: The principal ID of resource identity. + - `[IdentityTenantId <String>]`: The tenant ID of resource. + - `[IdentityType <ResourceIdentityType?>]`: The identity type. + - `[IdentityUserAssignedIdentity <IIdentityPropertiesUserAssignedIdentities>]`: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + - `[(Any) <IUserIdentityProperties>]`: This indicates any property can be added to this object. + - `[KeyVaultPropertyIdentity <String>]`: The client id of the identity which will be used to access key vault. + - `[KeyVaultPropertyKeyIdentifier <String>]`: Key vault uri to access the encryption key. + - `[NetworkRuleBypassOption <NetworkRuleBypassOptions?>]`: Whether to allow trusted Azure services to access a network restricted registry. + - `[NetworkRuleSetDefaultAction <DefaultAction?>]`: The default action of allow or deny when no other rules match. + - `[NetworkRuleSetIPRule <IIPRule[]>]`: The IP ACL rules. + - `IPAddressOrRange <String>`: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + - `[Action <Action?>]`: The action of IP ACL rule. + - `[PublicNetworkAccess <PublicNetworkAccess?>]`: Whether or not public network access is allowed for the container registry. + - `[QuarantinePolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[RetentionPolicyDay <Int32?>]`: The number of days to retain an untagged manifest after which it gets purged. + - `[RetentionPolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[SoftDeletePolicyRetentionDay <Int32?>]`: The number of days after which a soft-deleted item is permanently deleted. + - `[SoftDeletePolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[TrustPolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[TrustPolicyType <TrustPolicyType?>]`: The type of trust policy. + - `[ZoneRedundancy <ZoneRedundancy?>]`: Whether or not zone redundancy is enabled for this container registry + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryExportPipeline.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryExportPipeline.md new file mode 100644 index 0000000000..96d9273e43 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryExportPipeline.md @@ -0,0 +1,191 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistryexportpipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryExportPipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryExportPipeline.md +--- + +# Get-AzContainerRegistryExportPipeline + +## SYNOPSIS +Gets the properties of the export pipeline. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerRegistryExportPipeline -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzContainerRegistryExportPipeline -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzContainerRegistryExportPipeline -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the export pipeline. + +## EXAMPLES + +### Example 1: Lists all export pipelines for the specified container registry. +```powershell +Get-AzContainerRegistryExportPipeline -RegistryName RegistryExample -ResourceGroupName MyResourceGroup +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ +Example 30/01/2023 9:09:31 am user@microsoft.com User 30/01/2023 9:09:31 am user@microsoft.com +``` + +Lists all export pipelines for the specified container registry. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the export pipeline. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ExportPipelineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IExportPipeline + +## 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 <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryImportPipeline.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryImportPipeline.md new file mode 100644 index 0000000000..20b16cf1d8 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryImportPipeline.md @@ -0,0 +1,191 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistryimportpipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryImportPipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryImportPipeline.md +--- + +# Get-AzContainerRegistryImportPipeline + +## SYNOPSIS +Gets the properties of the import pipeline. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerRegistryImportPipeline -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzContainerRegistryImportPipeline -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzContainerRegistryImportPipeline -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the import pipeline. + +## EXAMPLES + +### Example 1: Lists all import pipelines for the specified container registry. +```powershell +Get-AzContainerRegistryImportPipeline -RegistryName RegistryExample -ResourceGroupName MyResourceGroup +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ +Example 30/01/2023 9:09:31 am user@microsoft.com User 30/01/2023 9:09:31 am user@microsoft.com +``` + +Lists all import pipelines for the specified container registry. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the import pipeline. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ImportPipelineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IImportPipeline + +## 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 <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryManifest.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryManifest.md new file mode 100644 index 0000000000..8490ab4cc3 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryManifest.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.dll-Help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistrymanifest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryManifest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryManifest.md +--- + +# Get-AzContainerRegistryManifest + +## SYNOPSIS +Get or list ACR manifest. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzContainerRegistryManifest -RepositoryName <String> -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetParameterSet +``` +Get-AzContainerRegistryManifest -RepositoryName <String> -Name <String> -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list ACR manifest. +To use this cmdlet please run +`Update-AzContainerRegistryRepository -RegistryName XXX -Repository XXX -ReadEnable $true -ListEnable $true` +first. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzContainerRegistryManifest -RegistryName registry -RepositoryName alpine +``` + +```output +Registry ImageName ManifestsAttributes +-------- --------- ------------------- +registry.azurecr.io alpine {Microsoft.Azure.Commands.ContainerRegistry.Models.PSManifestAttributeBase, Microsoft.Azure.Comm…} +``` + +List manifests for repository alpine under registry. + +### Example 2 +```powershell +Get-AzContainerRegistryManifest -RegistryName registry -RepositoryName alpine -Name sha256:a5426f084c755f4d6c1d1562a2d456aa574a24a61706f6806415627360c06ac0 +``` + +```output +Registry ImageName Attributes +-------- --------- ---------- +registry.azurecr.io alpine Microsoft.Azure.Commands.ContainerRegistry.Models.PSManifestAttributeBase +``` + +Get manifests sha256:a5426f084c755f4d6c1d1562a2d456aa574a24a61706f6806415627360c06ac0 for repository alpine under registry. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Manifest reference. + +```yaml +Type: System.String +Parameter Sets: GetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RegistryName +Azure Container Registry Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RepositoryName +Repository Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ContainerRegistry.Models.PSManifestAttribute + +### Microsoft.Azure.Commands.ContainerRegistry.Models.PSAcrManifest + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryReplication.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryReplication.md new file mode 100644 index 0000000000..637738e949 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryReplication.md @@ -0,0 +1,267 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistryreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryReplication.md +--- + +# Get-AzContainerRegistryReplication + +## SYNOPSIS +Gets the properties of the specified replication. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerRegistryReplication -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzContainerRegistryReplication -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] -Name <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzContainerRegistryReplication -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetByRegistry +``` +Get-AzContainerRegistryReplication -Registry <IRegistry> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the specified replication. + +## EXAMPLES + +### Example 1: Gets all the replications of a container registry +```powershell +Get-AzContainerRegistryReplication -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" +``` + +```output +Name Location ProvisioningState StatusTimestamp +---- -------- ----------------- --------------- +replication001 westus Succeeded 1/19/2023 5:57:00 AM +eastus2 eastus2 Succeeded 1/19/2023 5:56:51 AM +``` + +Gets all the replications of a container registry + +### Example 2: Gets a specified replication of a container registry +```powershell +Get-AzContainerRegistryReplication -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "replication001" +``` + +```output +Name Location ProvisioningState StatusTimestamp +---- -------- ----------------- --------------- +replication001 westus Succeeded 1/19/2023 5:57:00 AM +``` + +Gets a specified replication of a container registry + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the replication. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ReplicationName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Registry +The Registry Object. +To construct, see NOTES section for REGISTRY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistry +Parameter Sets: GetByRegistry +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistry + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IReplication + +## 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 <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +`REGISTRY <IRegistry>`: The Registry Object. + - `Location <String>`: The location of the resource. This cannot be changed after the resource is created. + - `SkuName <SkuName>`: The SKU name of the container registry. Required for registry creation. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource modification (UTC). + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <LastModifiedByType?>]`: The type of identity that last modified the resource. + - `[Tag <IResourceTags>]`: The tags of the resource. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdminUserEnabled <Boolean?>]`: The value that indicates whether the admin user is enabled. + - `[AnonymousPullEnabled <Boolean?>]`: Enables registry-wide pull from unauthenticated clients. + - `[AzureAdAuthenticationAsArmPolicyStatus <AzureAdAuthenticationAsArmPolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[AzureAsyncOperation <String>]`: + - `[DataEndpointEnabled <Boolean?>]`: Enable a single data endpoint per region for serving data. + - `[EncryptionStatus <EncryptionStatus?>]`: Indicates whether or not the encryption is enabled for container registry. + - `[ExportPolicyStatus <ExportPolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[IdentityPrincipalId <String>]`: The principal ID of resource identity. + - `[IdentityTenantId <String>]`: The tenant ID of resource. + - `[IdentityType <ResourceIdentityType?>]`: The identity type. + - `[IdentityUserAssignedIdentity <IIdentityPropertiesUserAssignedIdentities>]`: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + - `[(Any) <IUserIdentityProperties>]`: This indicates any property can be added to this object. + - `[KeyVaultPropertyIdentity <String>]`: The client id of the identity which will be used to access key vault. + - `[KeyVaultPropertyKeyIdentifier <String>]`: Key vault uri to access the encryption key. + - `[NetworkRuleBypassOption <NetworkRuleBypassOptions?>]`: Whether to allow trusted Azure services to access a network restricted registry. + - `[NetworkRuleSetDefaultAction <DefaultAction?>]`: The default action of allow or deny when no other rules match. + - `[NetworkRuleSetIPRule <IIPRule[]>]`: The IP ACL rules. + - `IPAddressOrRange <String>`: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + - `[Action <Action?>]`: The action of IP ACL rule. + - `[PublicNetworkAccess <PublicNetworkAccess?>]`: Whether or not public network access is allowed for the container registry. + - `[QuarantinePolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[RetentionPolicyDay <Int32?>]`: The number of days to retain an untagged manifest after which it gets purged. + - `[RetentionPolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[SoftDeletePolicyRetentionDay <Int32?>]`: The number of days after which a soft-deleted item is permanently deleted. + - `[SoftDeletePolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[TrustPolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[TrustPolicyType <TrustPolicyType?>]`: The type of trust policy. + - `[ZoneRedundancy <ZoneRedundancy?>]`: Whether or not zone redundancy is enabled for this container registry + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryRepository.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryRepository.md new file mode 100644 index 0000000000..51cdca9551 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryRepository.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.dll-Help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistryrepository +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryRepository.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryRepository.md +--- + +# Get-AzContainerRegistryRepository + +## SYNOPSIS +Get or list ACR repositories. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzContainerRegistryRepository [-First <Int32>] -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetParameterSet +``` +Get-AzContainerRegistryRepository -Name <String> -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list ACR repositories. +List returns repository names only. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzContainerRegistryRepository -RegistryName registry +``` + +```output +alpine +test/busybox0 +test/busybox1 +test/busybox10 +``` + +List all repositories in registry. + +### Example 2 +```powershell +Get-AzContainerRegistryRepository -RegistryName registry -First 3 +``` + +```output +alpine +test/busybox0 +test/busybox1 +``` + +List first 3 repositories in registry. + +### Example 3 +```powershell +Get-AzContainerRegistryRepository -RegistryName registry -Name alpine +``` + +```output +Registry : registry.azurecr.io +ImageName : alpine +CreatedTime : 2020-10-13T05:45:25.5896115Z +LastUpdateTime : 2021-01-04T08:31:46.2406505Z +ManifestCount : 7 +TagCount : 1 +ChangeableAttributes : Microsoft.Azure.Commands.ContainerRegistry.Models.PSChangeableAttribute +``` + +Get repository alpine under registry. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Repository Name. + +```yaml +Type: System.String +Parameter Sets: GetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RegistryName +Azure Container Registry Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -First +First n results. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ListParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String + +### Microsoft.Azure.Commands.ContainerRegistry.Models.PSRepositoryAttribute + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryScopeMap.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryScopeMap.md new file mode 100644 index 0000000000..8b69f69d4a --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryScopeMap.md @@ -0,0 +1,192 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistryscopemap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryScopeMap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryScopeMap.md +--- + +# Get-AzContainerRegistryScopeMap + +## SYNOPSIS +Gets the properties of the specified scope map. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerRegistryScopeMap -RegistryName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzContainerRegistryScopeMap -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzContainerRegistryScopeMap -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the specified scope map. + +## EXAMPLES + +### Example 1: List all scope maps for a container registry +```powershell +Get-AzContainerRegistryScopeMap -RegistryName RegistryExample -ResourceGroupName MyResourceGroup +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLa + stModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------ +newmap 01/20/2023 05:30:05 user@microsoft.com User 01/20/2023 05:30:05 +``` + +List all scope maps for a container registry + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the scope map. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ScopeMapName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IScopeMap + +## 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 <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryTag.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryTag.md new file mode 100644 index 0000000000..ac36a82384 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryTag.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.dll-Help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistrytag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryTag.md +--- + +# Get-AzContainerRegistryTag + +## SYNOPSIS +Get or list ACR tag. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzContainerRegistryTag -RepositoryName <String> -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetParameterSet +``` +Get-AzContainerRegistryTag -RepositoryName <String> -Name <String> -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list ACR tag. +To use this cmdlet please run +`Update-AzContainerRegistryRepository -RegistryName XXX -Repository XXX -ReadEnable $true -ListEnable $true` +first. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzContainerRegistryTag -RegistryName registry -RepositoryName alpine +``` + +```output +Registry ImageName Tags +-------- --------- ---- +registry.azurecr.io alpine {latest} +``` + +List tags for repository alpine under registry. + +### Example 2 +```powershell +Get-AzContainerRegistryTag -RegistryName registry -RepositoryName alpine -name latest +``` + +```output +Registry ImageName Attributes +-------- --------- ---------- +registry.azurecr.io alpine Microsoft.Azure.Commands.ContainerRegistry.Models.PSTagAttributeBase +``` + +Get tag latest for repository alpine under registry. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Tag. + +```yaml +Type: System.String +Parameter Sets: GetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RegistryName +Azure Container Registry Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RepositoryName +Repository Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ContainerRegistry.Models.PSTagAttribute + +### Microsoft.Azure.Commands.ContainerRegistry.Models.PSTagList + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryToken.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryToken.md new file mode 100644 index 0000000000..bfc00597d1 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryToken.md @@ -0,0 +1,193 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistrytoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryToken.md +--- + +# Get-AzContainerRegistryToken + +## SYNOPSIS +Gets the properties of the specified token. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerRegistryToken -RegistryName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzContainerRegistryToken -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzContainerRegistryToken -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the specified token. + +## EXAMPLES + +### Example 1: List Registry token in a registry +```powershell +Get-AzContainerRegistryToken -RegistryName RegistryExample -ResourceGroupName MyResourceGroup +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLa + stModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------ +token 01/20/2023 05:12:02 user@microsoft.com User 01/20/2023 05:12:02 user +token2 01/20/2023 05:14:16 user@microsoft.com User 01/20/2023 05:14:16 user +``` + +List Registry token in a registry + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the token. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: TokenName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IToken + +## 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 <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryUsage.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryUsage.md new file mode 100644 index 0000000000..7821fe5560 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryUsage.md @@ -0,0 +1,125 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistryusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryUsage.md +--- + +# Get-AzContainerRegistryUsage + +## SYNOPSIS +Gets the quota usages for the specified container registry. + +## SYNTAX + +``` +Get-AzContainerRegistryUsage -RegistryName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the quota usages for the specified container registry. + +## EXAMPLES + +### Example 1: Get Usage of an azure container registry. +```powershell +Get-AzContainerRegistryUsage -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" +``` + +```output +CurrentValue Limit Name Unit +------------ ----- ---- ---- +0 536870912000 Size Bytes +0 500 Webhooks Count +2 -1 Geo-replications Count +0 100 IPRules Count +0 100 VNetRules Count +0 200 PrivateEndpointConnections Count +0 50000 ScopeMaps Count +0 50000 Tokens Count +``` + +Get Usage of an azure container registry. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistryUsage + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryWebhook.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryWebhook.md new file mode 100644 index 0000000000..301cf2f101 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryWebhook.md @@ -0,0 +1,266 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistrywebhook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryWebhook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryWebhook.md +--- + +# Get-AzContainerRegistryWebhook + +## SYNOPSIS +Gets the properties of the specified webhook. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerRegistryWebhook -RegistryName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzContainerRegistryWebhook -RegistryName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + -Name <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzContainerRegistryWebhook -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetByRegistry +``` +Get-AzContainerRegistryWebhook -Registry <IRegistry> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the specified webhook. + +## EXAMPLES + +### Example 1: Gets a container registry webhook. +```powershell +Get-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "webhook001" +``` + +```output +Name Location Status Scope ProvisioningState +---- -------- ------ ----- ----------------- +webhook001 eastus2 enabled Succeeded +``` + +Gets a container registry webhook. + +### Example 2: Get all the webhooks of a container registry +```powershell +Get-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" +``` + +```output +Name Location Status Scope ProvisioningState +---- -------- ------ ----- ----------------- +webhook001 eastus2 enabled Succeeded +webhook002 eastus2 enabled Succeeded +webhook003 eastus enabled foo:* Succeeded +``` + +Get all the webhooks of a container registry + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the webhook. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: WebhookName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Registry +The Registry Object. +To construct, see NOTES section for REGISTRY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistry +Parameter Sets: GetByRegistry +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IWebhook + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +`REGISTRY <IRegistry>`: The Registry Object. + - `Location <String>`: The location of the resource. This cannot be changed after the resource is created. + - `SkuName <SkuName>`: The SKU name of the container registry. Required for registry creation. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource modification (UTC). + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <LastModifiedByType?>]`: The type of identity that last modified the resource. + - `[Tag <IResourceTags>]`: The tags of the resource. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdminUserEnabled <Boolean?>]`: The value that indicates whether the admin user is enabled. + - `[AnonymousPullEnabled <Boolean?>]`: Enables registry-wide pull from unauthenticated clients. + - `[AzureAdAuthenticationAsArmPolicyStatus <AzureAdAuthenticationAsArmPolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[AzureAsyncOperation <String>]`: + - `[DataEndpointEnabled <Boolean?>]`: Enable a single data endpoint per region for serving data. + - `[EncryptionStatus <EncryptionStatus?>]`: Indicates whether or not the encryption is enabled for container registry. + - `[ExportPolicyStatus <ExportPolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[IdentityPrincipalId <String>]`: The principal ID of resource identity. + - `[IdentityTenantId <String>]`: The tenant ID of resource. + - `[IdentityType <ResourceIdentityType?>]`: The identity type. + - `[IdentityUserAssignedIdentity <IIdentityPropertiesUserAssignedIdentities>]`: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + - `[(Any) <IUserIdentityProperties>]`: This indicates any property can be added to this object. + - `[KeyVaultPropertyIdentity <String>]`: The client id of the identity which will be used to access key vault. + - `[KeyVaultPropertyKeyIdentifier <String>]`: Key vault uri to access the encryption key. + - `[NetworkRuleBypassOption <NetworkRuleBypassOptions?>]`: Whether to allow trusted Azure services to access a network restricted registry. + - `[NetworkRuleSetDefaultAction <DefaultAction?>]`: The default action of allow or deny when no other rules match. + - `[NetworkRuleSetIPRule <IIPRule[]>]`: The IP ACL rules. + - `IPAddressOrRange <String>`: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + - `[Action <Action?>]`: The action of IP ACL rule. + - `[PublicNetworkAccess <PublicNetworkAccess?>]`: Whether or not public network access is allowed for the container registry. + - `[QuarantinePolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[RetentionPolicyDay <Int32?>]`: The number of days to retain an untagged manifest after which it gets purged. + - `[RetentionPolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[SoftDeletePolicyRetentionDay <Int32?>]`: The number of days after which a soft-deleted item is permanently deleted. + - `[SoftDeletePolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[TrustPolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[TrustPolicyType <TrustPolicyType?>]`: The type of trust policy. + - `[ZoneRedundancy <ZoneRedundancy?>]`: Whether or not zone redundancy is enabled for this container registry + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryWebhookCallbackConfig.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryWebhookCallbackConfig.md new file mode 100644 index 0000000000..a808af9611 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryWebhookCallbackConfig.md @@ -0,0 +1,217 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistrywebhookcallbackconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryWebhookCallbackConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryWebhookCallbackConfig.md +--- + +# Get-AzContainerRegistryWebhookCallbackConfig + +## SYNOPSIS +Gets the configuration of service URI and custom headers for the webhook. + +## SYNTAX + +### Get (Default) +``` +Get-AzContainerRegistryWebhookCallbackConfig -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] -WebhookName <String> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzContainerRegistryWebhookCallbackConfig -InputObject <IContainerRegistryIdentity> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the configuration of service URI and custom headers for the webhook. + +## EXAMPLES + +### Example 1: Gets the configuration of service URI and custom headers for the webhook. +```powershell +Get-AzContainerRegistryWebhookCallbackConfig -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -WebhookName "webhook001" +``` + +```output +ServiceUri +---------- +http://www.bing.com +``` + +Gets the configuration of service URI and custom headers for the webhook. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebhookName +The name of the webhook. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.ICallbackConfig + +## 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 <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryWebhookEvent.md b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryWebhookEvent.md new file mode 100644 index 0000000000..48f6ebaf17 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Get-AzContainerRegistryWebhookEvent.md @@ -0,0 +1,213 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/get-azcontainerregistrywebhookevent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryWebhookEvent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Get-AzContainerRegistryWebhookEvent.md +--- + +# Get-AzContainerRegistryWebhookEvent + +## SYNOPSIS +Lists recent events for the specified webhook. + +## SYNTAX + +### List (Default) +``` +Get-AzContainerRegistryWebhookEvent -RegistryName <String> -ResourceGroupName <String> -WebhookName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GetByWebhook +``` +Get-AzContainerRegistryWebhookEvent [-SubscriptionId <String[]>] -Webhook <IWebhook> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Lists recent events for the specified webhook. + +## EXAMPLES + +### Example 1: Gets events of a container registry webhook. +```powershell +Get-AzContainerRegistryWebhookEvent -ResourceGroupName lnxtest -RegistryName lnxcr -WebhookName webhook001 +``` + +```output +ContentAction ContentTimestamp ResponseMessageStatusCode +------------- ---------------- ------------------------- +ping 1/19/2023 6:57:21 AM 200 +ping 1/16/2023 9:30:18 PM 200 +ping 1/16/2023 9:27:30 PM 200 +ping 1/16/2023 9:23:50 PM 200 +ping 1/16/2023 9:13:47 PM 200 +ping 1/16/2023 9:04:55 PM 200 +``` + +Gets events of a container registry webhook. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Webhook +The Webhook Object. +To construct, see NOTES section for WEBHOOK properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IWebhook +Parameter Sets: GetByWebhook +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WebhookName +The name of the webhook. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IWebhook + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IEvent + +## 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. + + +`WEBHOOK <IWebhook>`: The Webhook Object. + - `Location <String>`: The location of the resource. This cannot be changed after the resource is created. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource modification (UTC). + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <LastModifiedByType?>]`: The type of identity that last modified the resource. + - `[Tag <IResourceTags>]`: The tags of the resource. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[Action <WebhookAction[]>]`: The list of actions that trigger the webhook to post notifications. + - `[AzureAsyncOperation <String>]`: + - `[Scope <String>]`: The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events. + - `[Status <WebhookStatus?>]`: The status of the webhook at the time the operation was called. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Import-AzContainerRegistryImage.md b/azps-10.1.0/Az.ContainerRegistry/Import-AzContainerRegistryImage.md new file mode 100644 index 0000000000..e5a145e5db --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Import-AzContainerRegistryImage.md @@ -0,0 +1,362 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/import-azcontainerregistryimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Import-AzContainerRegistryImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Import-AzContainerRegistryImage.md +--- + +# Import-AzContainerRegistryImage + +## SYNOPSIS +Copies an image to this container registry from the specified container registry. + +## SYNTAX + +### ImportExpanded (Default) +``` +Import-AzContainerRegistryImage -RegistryName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + -SourceImage <String> [-Mode <ImportMode>] [-Password <String>] [-SourceRegistryUri <String>] + [-SourceResourceId <String>] [-TargetTag <String[]>] [-UntaggedTargetRepository <String[]>] + [-Username <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Import +``` +Import-AzContainerRegistryImage -RegistryName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + -Parameter <IImportImageParameters> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Copies an image to this container registry from the specified container registry. + +## EXAMPLES + +### Example 1: Import image from a public/azure registry to an azure container registry. +```powershell +Import-AzContainerRegistryImage -SourceImage library/busybox:latest -ResourceGroupName $resourceGroupName -RegistryName $RegistryName -SourceRegistryUri docker.io -TargetTag busybox:latest +``` + +Import busybox to ACR. +Note: +"library/" need to be add before source image. +"busybox:latest" =\> "library/busybox:latest" +Credential needed if source registry is not publicly available +SourceRegistryResourceId or SourceRegistryUri is required for this cmdlet + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +When Force, any existing target tags will be overwritten. +When NoForce, any existing target tags will fail the operation before any copying begins. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.ImportMode +Parameter Sets: ImportExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IImportImageParameters +Parameter Sets: Import +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The password used to authenticate with the source registry. + +```yaml +Type: System.String +Parameter Sets: ImportExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceImage +Repository name of the source image.Specify an image by repository ('hello-world'). +This will use the 'latest' tag.Specify an image by tag ('hello-world:latest').Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). + +```yaml +Type: System.String +Parameter Sets: ImportExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceRegistryUri +The address of the source registry (e.g. +'mcr.microsoft.com'). + +```yaml +Type: System.String +Parameter Sets: ImportExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceResourceId +The resource identifier of the source Azure Container Registry. + +```yaml +Type: System.String +Parameter Sets: ImportExpanded +Aliases: SourceRegistryResourceId + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetTag +List of strings of the form repo[:tag]. +When tag is omitted the source will be used (or 'latest' if source tag is also omitted). + +```yaml +Type: System.String[] +Parameter Sets: ImportExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UntaggedTargetRepository +List of strings of repository names to do a manifest only copy. +No tag will be created. + +```yaml +Type: System.String[] +Parameter Sets: ImportExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Username +The username to authenticate with the source registry. + +```yaml +Type: System.String +Parameter Sets: ImportExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IImportImageParameters + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`PARAMETER <IImportImageParameters>`: . + - `SourceImage <String>`: Repository name of the source image. Specify an image by repository ('hello-world'). This will use the 'latest' tag. Specify an image by tag ('hello-world:latest'). Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). + - `[CredentialsPassword <String>]`: The password used to authenticate with the source registry. + - `[CredentialsUsername <String>]`: The username to authenticate with the source registry. + - `[Mode <ImportMode?>]`: When Force, any existing target tags will be overwritten. When NoForce, any existing target tags will fail the operation before any copying begins. + - `[SourceRegistryUri <String>]`: The address of the source registry (e.g. 'mcr.microsoft.com'). + - `[SourceResourceId <String>]`: The resource identifier of the source Azure Container Registry. + - `[TargetTag <String[]>]`: List of strings of the form repo[:tag]. When tag is omitted the source will be used (or 'latest' if source tag is also omitted). + - `[UntaggedTargetRepository <String[]>]`: List of strings of repository names to do a manifest only copy. No tag will be created. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistry.md b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistry.md new file mode 100644 index 0000000000..dd7836c455 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistry.md @@ -0,0 +1,621 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/new-azcontainerregistry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistry.md +--- + +# New-AzContainerRegistry + +## SYNOPSIS +Creates a container registry with the specified parameters. + +## SYNTAX + +``` +New-AzContainerRegistry -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + -Location <String> -Sku <SkuName> [-AnonymousPullEnabled] + [-AzureAdAuthenticationAsArmPolicyStatus <AzureAdAuthenticationAsArmPolicyStatus>] [-DataEndpointEnabled] + [-EnableAdminUser] [-EncryptionStatus <EncryptionStatus>] [-ExportPolicyStatus <ExportPolicyStatus>] + [-IdentityPrincipalId <String>] [-IdentityTenantId <String>] [-IdentityType <ResourceIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-KeyVaultPropertyIdentity <String>] + [-KeyVaultPropertyKeyIdentifier <String>] [-NetworkRuleBypassOption <NetworkRuleBypassOptions>] + [-NetworkRuleSetDefaultAction <DefaultAction>] [-NetworkRuleSetIPRule <IIPRule[]>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-QuarantinePolicyStatus <PolicyStatus>] + [-RetentionPolicyDay <Int32>] [-RetentionPolicyStatus <PolicyStatus>] [-SoftDeletePolicyRetentionDay <Int32>] + [-SoftDeletePolicyStatus <PolicyStatus>] [-Tag <Hashtable>] [-TrustPolicyStatus <PolicyStatus>] + [-TrustPolicyType <TrustPolicyType>] [-ZoneRedundancy <ZoneRedundancy>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a container registry with the specified parameters. + +## EXAMPLES + +### Example 1: Create a container registry with a new storage account. +```powershell +New-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "RegistryExample" -Sku "Basic" -Location "west us" +``` + +```output +Name SkuName LoginServer CreationDate ProvisioningState AdminUserEnabled +---- ------- ----------- ------------ ----------------- ---------------- +RegistryExample Basic registryexample.azurecr.io 1/19/2023 6:10:49 AM Succeeded False +``` + +Create a container registry with a new storage account. + +### Example 2: Create a container registry with admin user enabled. +```powershell +New-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "RegistryExample" -Sku "Basic" -Location "west us" -EnableAdminUser +``` + +```output +Name SkuName LoginServer CreationDate ProvisioningState AdminUserEnabled +---- ------- ----------- ------------ ----------------- ---------------- +RegistryExample Basic registryexample.azurecr.io 1/19/2023 6:10:49 AM Succeeded True +``` + +Create a container registry with admin user enabled. + +## PARAMETERS + +### -AnonymousPullEnabled +Enables registry-wide pull from unauthenticated clients. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureAdAuthenticationAsArmPolicyStatus +The value that indicates whether the policy is enabled or not. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.AzureAdAuthenticationAsArmPolicyStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEndpointEnabled +Enable a single data endpoint per region for serving data. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAdminUser +The value that indicates whether the admin user is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionStatus +Indicates whether or not the encryption is enabled for container registry. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.EncryptionStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportPolicyStatus +The value that indicates whether the policy is enabled or not. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.ExportPolicyStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityPrincipalId +The principal ID of resource identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityTenantId +The tenant ID of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +The list of user identities associated with the resource. +The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyIdentity +The client id of the identity which will be used to access key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyIdentifier +Key vault uri to access the encryption key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. +This cannot be changed after the resource is created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RegistryName, ResourceName, ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkRuleBypassOption +Whether to allow trusted Azure services to access a network restricted registry. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.NetworkRuleBypassOptions +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkRuleSetDefaultAction +The default action of allow or deny when no other rules match. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.DefaultAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkRuleSetIPRule +The IP ACL rules. +To construct, see NOTES section for NETWORKRULESETIPRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IIPRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Whether or not public network access is allowed for the container registry. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantinePolicyStatus +The value that indicates whether the policy is enabled or not. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PolicyStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicyDay +The number of days to retain an untagged manifest after which it gets purged. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicyStatus +The value that indicates whether the policy is enabled or not. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PolicyStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SKU name of the container registry. +Required for registry creation. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletePolicyRetentionDay +The number of days after which a soft-deleted item is permanently deleted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletePolicyStatus +The value that indicates whether the policy is enabled or not. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PolicyStatus +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. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags of the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustPolicyStatus +The value that indicates whether the policy is enabled or not. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PolicyStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustPolicyType +The type of trust policy. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.TrustPolicyType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundancy +Whether or not zone redundancy is enabled for this container registry + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.ZoneRedundancy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistry + +## 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. + + +`NETWORKRULESETIPRULE <IIPRule[]>`: The IP ACL rules. + - `IPAddressOrRange <String>`: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + - `[Action <Action?>]`: The action of IP ACL rule. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryAgentPool.md b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryAgentPool.md new file mode 100644 index 0000000000..cdbc7543d9 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryAgentPool.md @@ -0,0 +1,287 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/new-azcontainerregistryagentpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryAgentPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryAgentPool.md +--- + +# New-AzContainerRegistryAgentPool + +## SYNOPSIS +Creates an agent pool for a container registry with the specified parameters. + +## SYNTAX + +``` +New-AzContainerRegistryAgentPool -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -Location <String> [-Count <Int32>] [-OS <OS>] [-Tag <Hashtable>] [-Tier <String>] + [-VirtualNetworkSubnetResourceId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an agent pool for a container registry with the specified parameters. + +## EXAMPLES + +### Example 1: Creates an agent pool for a container registry with the specified parameters. +```powershell +New-AzContainerRegistryAgentPool -name agent -RegistryName RegistryExample -ResourceGroupName MyResourceGroup -Location 'eastus' -Count 1 -Tier S1 -os 'Linux' +``` + +```output +Name Location OS Count ProvisioningState +---- -------- -- ----- ----------------- +agent eastus Linux 1 Succeeded +``` + +Creates an agent pool for a container registry with the specified parameters. +Please notice that some parameters are required in this cmdlets but not marked as required in syntax, we would change it later. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +The count of agent machine + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. +This cannot be changed after the resource is created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the agent pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AgentPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OS +The OS of agent machine + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.OS +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the container registry belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags of the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tier +The Tier of agent machine + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkSubnetResourceId +The Virtual Network Subnet Resource Id of the agent machine + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api20190601Preview.IAgentPool + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryExportPipeline.md b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryExportPipeline.md new file mode 100644 index 0000000000..7c0ff7cf23 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryExportPipeline.md @@ -0,0 +1,333 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/new-azcontainerregistryexportpipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryExportPipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryExportPipeline.md +--- + +# New-AzContainerRegistryExportPipeline + +## SYNOPSIS +Creates an export pipeline for a container registry with the specified parameters. + +## SYNTAX + +``` +New-AzContainerRegistryExportPipeline -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IdentityPrincipalId <String>] [-IdentityTenantId <String>] + [-IdentityType <ResourceIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] [-Location <String>] + [-Option <PipelineOptions[]>] [-TargetKeyVaultUri <String>] [-TargetType <String>] [-TargetUri <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an export pipeline for a container registry with the specified parameters. + +## EXAMPLES + +### Example 1: Create a new export pipeline +```powershell +New-AzContainerRegistryExportPipeline -name Exam -RegistryName RegistryExample -ResourceGroupName MyResourceGroup -IdentityType 'SystemAssigned' -TargetType AzureStorageBlobContainer -TargetUri https://sa.blob.core.windows.net/public/ -TargetKeyVaultUri https://examplekeyvault.vault.azure.net/secrets/test/18d55a35beba4b20bdd044a2a9d14c30 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ +Exam 30/01/2023 9:09:31 am user@microsoft.com User 30/01/2023 9:09:31 am user@microsoft.com +``` + +Create a new export pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityPrincipalId +The principal ID of resource identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityTenantId +The tenant ID of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +The list of user identities associated with the resource. +The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the export pipeline. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the export pipeline. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExportPipelineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Option +The list of all options configured for the pipeline. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PipelineOptions[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetKeyVaultUri +They key vault secret uri to obtain the target storage SAS token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetType +The type of target for the export pipeline. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetUri +The target uri of the export pipeline.When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName"When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IExportPipeline + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryIPRuleObject.md b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryIPRuleObject.md new file mode 100644 index 0000000000..4661225a81 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryIPRuleObject.md @@ -0,0 +1,85 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/Az.ContainerRegistry/new-AzContainerRegistryIPRuleObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryIPRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryIPRuleObject.md +--- + +# New-AzContainerRegistryIPRuleObject + +## SYNOPSIS +Create an in-memory object for IPRule. + +## SYNTAX + +``` +New-AzContainerRegistryIPRuleObject -IPAddressOrRange <String> [-Action <Action>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for IPRule. + +## EXAMPLES + +### Example 1: Create a IP network rule. +```powershell +New-AzContainerRegistryIPRuleObject -IPAddressOrRange 0.0.0.0 -Action 'Allow' +``` + +```output +Action IPAddressOrRange +------ ---------------- +Allow 0.0.0.0 +``` + +Create a IP network rule. + +## PARAMETERS + +### -Action +The action of IP ACL rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.Action +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressOrRange +Specifies the IP or IP range in CIDR format. +Only IPV4 address is allowed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IPRule + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryImportPipeline.md b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryImportPipeline.md new file mode 100644 index 0000000000..7460c580fa --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryImportPipeline.md @@ -0,0 +1,349 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/new-azcontainerregistryimportpipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryImportPipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryImportPipeline.md +--- + +# New-AzContainerRegistryImportPipeline + +## SYNOPSIS +Creates an import pipeline for a container registry with the specified parameters. + +## SYNTAX + +``` +New-AzContainerRegistryImportPipeline -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IdentityPrincipalId <String>] [-IdentityTenantId <String>] + [-IdentityType <ResourceIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] [-Location <String>] + [-Option <PipelineOptions[]>] [-SourceKeyVaultUri <String>] [-SourceTriggerStatus <TriggerStatus>] + [-SourceType <PipelineSourceType>] [-SourceUri <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an import pipeline for a container registry with the specified parameters. + +## EXAMPLES + +### Example 1: Create a new import pipeline +```powershell +New-AzContainerRegistryImportPipeline -name Exam -RegistryName RegistryExample -ResourceGroupName MyResourceGroup -IdentityType 'SystemAssigned' -SourceType AzureStorageBlobContainer -SourceUri https://sa.blob.core.windows.net/public/ -SourceKeyVaultUri https://examplekeyvault.vault.azure.net/secrets/test/18d55a35beba4b20bdd044a2a9d14c30 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ +Exam 30/01/2023 9:09:31 am user@microsoft.com User 30/01/2023 9:09:31 am user@microsoft.com +``` + +Create a new import pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityPrincipalId +The principal ID of resource identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityTenantId +The tenant ID of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +The list of user identities associated with the resource. +The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the import pipeline. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the import pipeline. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ImportPipelineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Option +The list of all options configured for the pipeline. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PipelineOptions[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceKeyVaultUri +They key vault secret uri to obtain the source storage SAS token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceTriggerStatus +The current status of the source trigger. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.TriggerStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceType +The type of source for the import pipeline. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PipelineSourceType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceUri +The source uri of the import pipeline.When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName"When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" + +```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. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IImportPipeline + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryReplication.md b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryReplication.md new file mode 100644 index 0000000000..d8a878114b --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryReplication.md @@ -0,0 +1,326 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/new-azcontainerregistryreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryReplication.md +--- + +# New-AzContainerRegistryReplication + +## SYNOPSIS +Creates a replication for a container registry with the specified parameters. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzContainerRegistryReplication -RegistryName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String>] -Location <String> [-RegionEndpointEnabled] [-Tag <Hashtable>] + [-ZoneRedundancy <ZoneRedundancy>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CreateByRegistry +``` +New-AzContainerRegistryReplication [-Name <String>] [-SubscriptionId <String>] -Registry <IRegistry> + -Location <String> [-RegionEndpointEnabled] [-Tag <Hashtable>] [-ZoneRedundancy <ZoneRedundancy>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a replication for a container registry with the specified parameters. + +## EXAMPLES + +### Example 1: Creates a container registry replication. +```powershell +New-AzContainerRegistryReplication -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name replication001 -Location 'west us' -Tag @{tagName='MyTag'} +``` + +```output +Name Location ProvisioningState StatusTimestamp +---- -------- ----------------- --------------- +replication001 westus Succeeded 1/19/2023 5:57:00 AM +``` + +Creates a container registry replication. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. +This cannot be changed after the resource is created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ReplicationLocation + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the replication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ReplicationName, ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegionEndpointEnabled +Specifies whether the replication's regional endpoint is enabled. +Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Registry +The Registry Object. +To construct, see NOTES section for REGISTRY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistry +Parameter Sets: CreateByRegistry +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags of the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundancy +Whether or not zone redundancy is enabled for this container registry replication + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.ZoneRedundancy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IReplication + +## 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. + + +`REGISTRY <IRegistry>`: The Registry Object. + - `Location <String>`: The location of the resource. This cannot be changed after the resource is created. + - `SkuName <SkuName>`: The SKU name of the container registry. Required for registry creation. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource modification (UTC). + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <LastModifiedByType?>]`: The type of identity that last modified the resource. + - `[Tag <IResourceTags>]`: The tags of the resource. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdminUserEnabled <Boolean?>]`: The value that indicates whether the admin user is enabled. + - `[AnonymousPullEnabled <Boolean?>]`: Enables registry-wide pull from unauthenticated clients. + - `[AzureAdAuthenticationAsArmPolicyStatus <AzureAdAuthenticationAsArmPolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[AzureAsyncOperation <String>]`: + - `[DataEndpointEnabled <Boolean?>]`: Enable a single data endpoint per region for serving data. + - `[EncryptionStatus <EncryptionStatus?>]`: Indicates whether or not the encryption is enabled for container registry. + - `[ExportPolicyStatus <ExportPolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[IdentityPrincipalId <String>]`: The principal ID of resource identity. + - `[IdentityTenantId <String>]`: The tenant ID of resource. + - `[IdentityType <ResourceIdentityType?>]`: The identity type. + - `[IdentityUserAssignedIdentity <IIdentityPropertiesUserAssignedIdentities>]`: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + - `[(Any) <IUserIdentityProperties>]`: This indicates any property can be added to this object. + - `[KeyVaultPropertyIdentity <String>]`: The client id of the identity which will be used to access key vault. + - `[KeyVaultPropertyKeyIdentifier <String>]`: Key vault uri to access the encryption key. + - `[NetworkRuleBypassOption <NetworkRuleBypassOptions?>]`: Whether to allow trusted Azure services to access a network restricted registry. + - `[NetworkRuleSetDefaultAction <DefaultAction?>]`: The default action of allow or deny when no other rules match. + - `[NetworkRuleSetIPRule <IIPRule[]>]`: The IP ACL rules. + - `IPAddressOrRange <String>`: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + - `[Action <Action?>]`: The action of IP ACL rule. + - `[PublicNetworkAccess <PublicNetworkAccess?>]`: Whether or not public network access is allowed for the container registry. + - `[QuarantinePolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[RetentionPolicyDay <Int32?>]`: The number of days to retain an untagged manifest after which it gets purged. + - `[RetentionPolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[SoftDeletePolicyRetentionDay <Int32?>]`: The number of days after which a soft-deleted item is permanently deleted. + - `[SoftDeletePolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[TrustPolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[TrustPolicyType <TrustPolicyType?>]`: The type of trust policy. + - `[ZoneRedundancy <ZoneRedundancy?>]`: Whether or not zone redundancy is enabled for this container registry + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryScopeMap.md b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryScopeMap.md new file mode 100644 index 0000000000..441a797663 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryScopeMap.md @@ -0,0 +1,227 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/new-azcontainerregistryscopemap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryScopeMap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryScopeMap.md +--- + +# New-AzContainerRegistryScopeMap + +## SYNOPSIS +Creates a scope map for a container registry with the specified parameters. + +## SYNTAX + +``` +New-AzContainerRegistryScopeMap -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Action <String[]>] [-Description <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a scope map for a container registry with the specified parameters. + +## EXAMPLES + +### Example 1: Create scope map for a container registry +```powershell +New-AzContainerRegistryScopeMap -Name newmap -RegistryName RegistryExample -ResourceGroupName MyResourceGroup -Action "repositories/busybox/content/read" +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLa + stModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------ +newmap 01/20/2023 05:30:05 user@microsoft.com User 01/20/2023 05:30:05 +``` + +Create scope map for a container registry + +## PARAMETERS + +### -Action +The list of scoped permissions for registry artifacts.E.g. +repositories/repository-name/content/read,repositories/repository-name/metadata/write + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The user friendly description of the scope map. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the scope map. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ScopeMapName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IScopeMap + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryToken.md b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryToken.md new file mode 100644 index 0000000000..bff8b42ffd --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryToken.md @@ -0,0 +1,275 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/new-azcontainerregistrytoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryToken.md +--- + +# New-AzContainerRegistryToken + +## SYNOPSIS +Creates a token for a container registry with the specified parameters. + +## SYNTAX + +``` +New-AzContainerRegistryToken -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-CredentialsCertificate <ITokenCertificate[]>] + [-CredentialsPassword <ITokenPassword[]>] [-ScopeMapId <String>] [-Status <TokenStatus>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a token for a container registry with the specified parameters. + +## EXAMPLES + +### Example 1: Create new token for certain container registry +```powershell +New-AzContainerRegistryToken -Name token2 -RegistryName lnxcr -ResourceGroupName lnxtest -ScopeMapId /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lnxtest/providers/Microsoft.ContainerRegistry/registries/lnxcr/scopeMaps/newmap +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLa + stModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------ +token 01/20/2023 05:14:16 user@microsoft.com User 01/20/2023 05:14:16 user +``` + +Create new token for certain container registry + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialsCertificate +. +To construct, see NOTES section for CREDENTIALSCERTIFICATE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.ITokenCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialsPassword +. +To construct, see NOTES section for CREDENTIALSPASSWORD properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.ITokenPassword[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TokenName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeMapId +The resource ID of the scope map to which the token will be associated with. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The status of the token example enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.TokenStatus +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. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IToken + +## 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. + + +`CREDENTIALSCERTIFICATE <ITokenCertificate[]>`: . + - `[EncodedPemCertificate <String>]`: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. + - `[Expiry <DateTime?>]`: The expiry datetime of the certificate. + - `[Name <TokenCertificateName?>]`: + - `[Thumbprint <String>]`: The thumbprint of the certificate. + +`CREDENTIALSPASSWORD <ITokenPassword[]>`: . + - `[CreationTime <DateTime?>]`: The creation datetime of the password. + - `[Expiry <DateTime?>]`: The expiry datetime of the password. + - `[Name <TokenPasswordName?>]`: The password name "password1" or "password2" + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryWebhook.md b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryWebhook.md new file mode 100644 index 0000000000..109783ac6c --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/New-AzContainerRegistryWebhook.md @@ -0,0 +1,376 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/new-azcontainerregistrywebhook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryWebhook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/New-AzContainerRegistryWebhook.md +--- + +# New-AzContainerRegistryWebhook + +## SYNOPSIS +Creates a webhook for a container registry with the specified parameters. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzContainerRegistryWebhook -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -Action <WebhookAction[]> [-Location <String>] [-CustomHeader <Hashtable>] + [-Scope <String>] [-ServiceUri <String>] [-Status <WebhookStatus>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByRegistry +``` +New-AzContainerRegistryWebhook -Name <String> [-SubscriptionId <String>] -Registry <IRegistry> + -Action <WebhookAction[]> [-Location <String>] [-CustomHeader <Hashtable>] [-Scope <String>] + [-ServiceUri <String>] [-Status <WebhookStatus>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a webhook for a container registry with the specified parameters. + +## EXAMPLES + +### Example 1: The New-AzContainerRegistryWebhook cmdlet creates a container registry webhook. +```powershell +New-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "webhook001" -Uri http://www.bing.com -Action Delete,Push -Header @{SpecialHeader='headerVal'} -Tag @{Key="val"} -Location "east us" -Status Enabled -Scope "foo:*" +``` + +```output +Name Location Status Scope ProvisioningState +---- -------- ------ ----- ----------------- +webhook001 eastus enabled foo:* Succeeded +``` + +Create a container registry webhook. +Please notice that some parameters are required in this cmdlets but not marked as required in syntax, we would change it later. + +## PARAMETERS + +### -Action +The list of actions that trigger the webhook to post notifications. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.WebhookAction[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomHeader +Custom headers that will be added to the webhook notifications. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Header + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the webhook. +This cannot be changed after the resource 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 +``` + +### -Name +The name of the webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WebhookName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Registry +The Registry Object. +To construct, see NOTES section for REGISTRY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistry +Parameter Sets: CreateByRegistry +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of repositories where the event can be triggered. +For example, 'foo:*' means events for all tags under repository 'foo'. +'foo:bar' means events for 'foo:bar' only. +'foo' is equivalent to 'foo:latest'. +Empty means all events. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceUri +The service URI for the webhook to post notifications. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Uri + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The status of the webhook at the time the operation was called. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.WebhookStatus +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. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags for the webhook. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IWebhook + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`REGISTRY <IRegistry>`: The Registry Object. + - `Location <String>`: The location of the resource. This cannot be changed after the resource is created. + - `SkuName <SkuName>`: The SKU name of the container registry. Required for registry creation. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource modification (UTC). + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <LastModifiedByType?>]`: The type of identity that last modified the resource. + - `[Tag <IResourceTags>]`: The tags of the resource. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdminUserEnabled <Boolean?>]`: The value that indicates whether the admin user is enabled. + - `[AnonymousPullEnabled <Boolean?>]`: Enables registry-wide pull from unauthenticated clients. + - `[AzureAdAuthenticationAsArmPolicyStatus <AzureAdAuthenticationAsArmPolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[AzureAsyncOperation <String>]`: + - `[DataEndpointEnabled <Boolean?>]`: Enable a single data endpoint per region for serving data. + - `[EncryptionStatus <EncryptionStatus?>]`: Indicates whether or not the encryption is enabled for container registry. + - `[ExportPolicyStatus <ExportPolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[IdentityPrincipalId <String>]`: The principal ID of resource identity. + - `[IdentityTenantId <String>]`: The tenant ID of resource. + - `[IdentityType <ResourceIdentityType?>]`: The identity type. + - `[IdentityUserAssignedIdentity <IIdentityPropertiesUserAssignedIdentities>]`: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + - `[(Any) <IUserIdentityProperties>]`: This indicates any property can be added to this object. + - `[KeyVaultPropertyIdentity <String>]`: The client id of the identity which will be used to access key vault. + - `[KeyVaultPropertyKeyIdentifier <String>]`: Key vault uri to access the encryption key. + - `[NetworkRuleBypassOption <NetworkRuleBypassOptions?>]`: Whether to allow trusted Azure services to access a network restricted registry. + - `[NetworkRuleSetDefaultAction <DefaultAction?>]`: The default action of allow or deny when no other rules match. + - `[NetworkRuleSetIPRule <IIPRule[]>]`: The IP ACL rules. + - `IPAddressOrRange <String>`: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + - `[Action <Action?>]`: The action of IP ACL rule. + - `[PublicNetworkAccess <PublicNetworkAccess?>]`: Whether or not public network access is allowed for the container registry. + - `[QuarantinePolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[RetentionPolicyDay <Int32?>]`: The number of days to retain an untagged manifest after which it gets purged. + - `[RetentionPolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[SoftDeletePolicyRetentionDay <Int32?>]`: The number of days after which a soft-deleted item is permanently deleted. + - `[SoftDeletePolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[TrustPolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[TrustPolicyType <TrustPolicyType?>]`: The type of trust policy. + - `[ZoneRedundancy <ZoneRedundancy?>]`: Whether or not zone redundancy is enabled for this container registry + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistry.md b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistry.md new file mode 100644 index 0000000000..fd6f67a13e --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistry.md @@ -0,0 +1,240 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/remove-azcontainerregistry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistry.md +--- + +# Remove-AzContainerRegistry + +## SYNOPSIS +Deletes a container registry. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerRegistry -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerRegistry -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a container registry. + +## EXAMPLES + +### Example 1: Remove a specified container registry +```powershell +Remove-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" +``` + +This command removes the specified container registry. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: RegistryName, ResourceName, ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryAgentPool.md b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryAgentPool.md new file mode 100644 index 0000000000..68de486114 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryAgentPool.md @@ -0,0 +1,255 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/remove-azcontainerregistryagentpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryAgentPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryAgentPool.md +--- + +# Remove-AzContainerRegistryAgentPool + +## SYNOPSIS +Deletes a specified agent pool resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerRegistryAgentPool -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerRegistryAgentPool -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a specified agent pool resource. + +## EXAMPLES + +### Example 1: Delete a specified agent pool resource. +```powershell +Remove-AzContainerRegistryAgentPool -Name agentpool -RegistryName RegistryExample -ResourceGroupName MyResourceGroup +``` + +Delete a specified agent pool resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the agent pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AgentPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the container registry belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryExportPipeline.md b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryExportPipeline.md new file mode 100644 index 0000000000..21c54d4430 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryExportPipeline.md @@ -0,0 +1,256 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/remove-azcontainerregistryexportpipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryExportPipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryExportPipeline.md +--- + +# Remove-AzContainerRegistryExportPipeline + +## SYNOPSIS +Deletes an export pipeline from a container registry. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerRegistryExportPipeline -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerRegistryExportPipeline -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an export pipeline from a container registry. + +## EXAMPLES + +### Example 1: Delete a export pipeline +```powershell +Remove-AzContainerRegistryExportPipeline -name Exam -RegistryName RegistryExample -ResourceGroupName MyResourceGroup +``` + +Delete a export pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the export pipeline. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ExportPipelineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryImportPipeline.md b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryImportPipeline.md new file mode 100644 index 0000000000..2ccb1e08f5 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryImportPipeline.md @@ -0,0 +1,256 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/remove-azcontainerregistryimportpipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryImportPipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryImportPipeline.md +--- + +# Remove-AzContainerRegistryImportPipeline + +## SYNOPSIS +Deletes an import pipeline from a container registry. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerRegistryImportPipeline -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerRegistryImportPipeline -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an import pipeline from a container registry. + +## EXAMPLES + +### Example 1: Delete a import pipeline +```powershell +Remove-AzContainerRegistryImportPipeline -name Exam -RegistryName RegistryExample -ResourceGroupName MyResourceGroup +``` + +Delete a export pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the import pipeline. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ImportPipelineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryManifest.md b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryManifest.md new file mode 100644 index 0000000000..3aefac625b --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryManifest.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.dll-Help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/remove-azcontainerregistrymanifest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryManifest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryManifest.md +--- + +# Remove-AzContainerRegistryManifest + +## SYNOPSIS +Delete ACR manifest. + +## SYNTAX + +### ByManifestParameterSet (Default) +``` +Remove-AzContainerRegistryManifest -RepositoryName <String> -Manifest <String> -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTagParameterSet +``` +Remove-AzContainerRegistryManifest -RepositoryName <String> -Tag <String> -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete ACR manifest. +To use this cmdlet please run +`Update-AzContainerRegistryRepository -RegistryName XXX -Repository XXX -DeleteEnable $true` +first. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzContainerRegistryManifest -RegistryName registry -RepositoryName test/busybox27 -Manifest sha256:31a54a0cf86d7354788a8265f60ae6acb4b348a67efbcf7c1007dd3cf7af05ab +``` + +```output +True +``` + +Delete manifest sha256:31a54a0cf86d7354788a8265f60ae6acb4b348a67efbcf7c1007dd3cf7af05ab for repository test/busybox27 under registry + +### Example 2 +```powershell +Remove-AzContainerRegistryManifest -RegistryName registry -RepositoryName test/busybox27 -Tag latest +``` + +```output +True +``` + +Delete manifest with tag latest for repository test/busybox27 under registry + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Manifest +Manifest reference. + +```yaml +Type: System.String +Parameter Sets: ByManifestParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RegistryName +Azure Container Registry Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RepositoryName +Repository Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Tag. + +```yaml +Type: System.String +Parameter Sets: ByTagParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryReplication.md b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryReplication.md new file mode 100644 index 0000000000..0e61922a89 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryReplication.md @@ -0,0 +1,256 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/remove-azcontainerregistryreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryReplication.md +--- + +# Remove-AzContainerRegistryReplication + +## SYNOPSIS +Deletes a replication from a container registry. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerRegistryReplication -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerRegistryReplication -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a replication from a container registry. + +## EXAMPLES + +### Example 1: Deletes a replication from a container registry. +```powershell +Remove-AzContainerRegistryReplication -Name "NewReplication" -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" +``` + +Deletes a replication from a container registry. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the replication. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ReplicationName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryRepository.md b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryRepository.md new file mode 100644 index 0000000000..5516223719 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryRepository.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.dll-Help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/remove-azcontainerregistryrepository +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryRepository.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryRepository.md +--- + +# Remove-AzContainerRegistryRepository + +## SYNOPSIS +Delete repository from ACR. + +## SYNTAX + +``` +Remove-AzContainerRegistryRepository -Name <String> -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete repository from ACR. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzContainerRegistryRepository -RegistryName registry -Name test/busybox15 +``` + +```output +ManifestsDeleted TagsDeleted +---------------- ----------- +{sha256:31a54a0cf86d7354788a8265f60ae6acb4b348a67efbcf7c1007dd3cf7af05ab} {latest} +``` + +Delete repository test/busybox15 under registry. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Repository Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RegistryName +Azure Container Registry Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ContainerRegistry.Models.PSDeletedRepository + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryScopeMap.md b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryScopeMap.md new file mode 100644 index 0000000000..6189183aea --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryScopeMap.md @@ -0,0 +1,256 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/remove-azcontainerregistryscopemap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryScopeMap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryScopeMap.md +--- + +# Remove-AzContainerRegistryScopeMap + +## SYNOPSIS +Deletes a scope map from a container registry. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerRegistryScopeMap -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerRegistryScopeMap -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a scope map from a container registry. + +## EXAMPLES + +### Example 1: Remove a scope map for a container registry +```powershell +Remove-AzContainerRegistryScopeMap -Name newmap -RegistryName RegistryExample -ResourceGroupName MyResourceGroup +``` + +Remove a scope map for a container registry + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the scope map. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ScopeMapName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryTag.md b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryTag.md new file mode 100644 index 0000000000..b38cf2bea3 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryTag.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.dll-Help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/Remove-azcontainerregistrytag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryTag.md +--- + +# Remove-AzContainerRegistryTag + +## SYNOPSIS +Untag ACR tag. + +## SYNTAX + +``` +Remove-AzContainerRegistryTag -RepositoryName <String> -Name <String> -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Untag ACR tag. +To use this cmdlet please run +`Update-AzContainerRegistryRepository -RegistryName XXX -Repository XXX -DeleteEnable $true` +first. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzContainerRegistryTag -RegistryName registry -RepositoryName alpine -Name latest +``` + +```output +True +``` + +Untag alpine:tag under registry. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RegistryName +Azure Container Registry Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RepositoryName +Repository Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryToken.md b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryToken.md new file mode 100644 index 0000000000..30e06b49cd --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryToken.md @@ -0,0 +1,256 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/remove-azcontainerregistrytoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryToken.md +--- + +# Remove-AzContainerRegistryToken + +## SYNOPSIS +Deletes a token from a container registry. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerRegistryToken -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerRegistryToken -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a token from a container registry. + +## EXAMPLES + +### Example 1: Remove a token for the container registry +```powershell +Remove-AzContainerRegistryToken -Name token -RegistryName RegistryExample -ResourceGroupName MyResourceGroup +``` + +Remove a token for the container registry + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the token. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: TokenName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryWebhook.md b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryWebhook.md new file mode 100644 index 0000000000..03a2aafef7 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Remove-AzContainerRegistryWebhook.md @@ -0,0 +1,256 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/remove-azcontainerregistrywebhook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryWebhook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Remove-AzContainerRegistryWebhook.md +--- + +# Remove-AzContainerRegistryWebhook + +## SYNOPSIS +Deletes a webhook from a container registry. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzContainerRegistryWebhook -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzContainerRegistryWebhook -InputObject <IContainerRegistryIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a webhook from a container registry. + +## EXAMPLES + +### Example 1: Removes a container registry webhook. +```powershell +Remove-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "webhook001" +``` + +Removes a container registry webhook. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the webhook. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: WebhookName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Test-AzContainerRegistryNameAvailability.md b/azps-10.1.0/Az.ContainerRegistry/Test-AzContainerRegistryNameAvailability.md new file mode 100644 index 0000000000..5d8ecf8408 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Test-AzContainerRegistryNameAvailability.md @@ -0,0 +1,135 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/test-azcontainerregistrynameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Test-AzContainerRegistryNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Test-AzContainerRegistryNameAvailability.md +--- + +# Test-AzContainerRegistryNameAvailability + +## SYNOPSIS +Checks whether the container registry name is available for use. +The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length. + +## SYNTAX + +``` +Test-AzContainerRegistryNameAvailability [-SubscriptionId <String>] -Name <String> [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Checks whether the container registry name is available for use. +The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length. + +## EXAMPLES + +### Example 1: Checks the availability of a container registry name +```powershell +Test-AzContainerRegistryNameAvailability -Name 'SomeRegistryName' +``` + +```output +NameAvailable Reason Message +------------- ------ ------- + True +``` + +Checks the availability of a container registry name + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistryNameStatus + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Test-AzContainerRegistryWebhook.md b/azps-10.1.0/Az.ContainerRegistry/Test-AzContainerRegistryWebhook.md new file mode 100644 index 0000000000..443114ba58 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Test-AzContainerRegistryWebhook.md @@ -0,0 +1,204 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/test-azcontainerregistrywebhook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Test-AzContainerRegistryWebhook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Test-AzContainerRegistryWebhook.md +--- + +# Test-AzContainerRegistryWebhook + +## SYNOPSIS +Triggers a ping event to be sent to the webhook. + +## SYNTAX + +### Ping (Default) +``` +Test-AzContainerRegistryWebhook -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PingByWebhook +``` +Test-AzContainerRegistryWebhook [-SubscriptionId <String>] -Webhook <IWebhook> [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Triggers a ping event to be sent to the webhook. + +## EXAMPLES + +### Example 1: Triggers a webhook ping event. +```powershell +Test-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "webhook001" +``` + +```output +c5950af0-c8d0-4924-9873-1ba7da5cbf83 +``` + +Triggers a webhook ping event. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the webhook. + +```yaml +Type: System.String +Parameter Sets: Ping +Aliases: WebhookName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: Ping +Aliases: ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Ping +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Webhook +The webhook object. +To construct, see NOTES section for WEBHOOK properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IWebhook +Parameter Sets: PingByWebhook +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`WEBHOOK <IWebhook>`: The webhook object. + - `Location <String>`: The location of the resource. This cannot be changed after the resource is created. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource modification (UTC). + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <LastModifiedByType?>]`: The type of identity that last modified the resource. + - `[Tag <IResourceTags>]`: The tags of the resource. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[Action <WebhookAction[]>]`: The list of actions that trigger the webhook to post notifications. + - `[AzureAsyncOperation <String>]`: + - `[Scope <String>]`: The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events. + - `[Status <WebhookStatus?>]`: The status of the webhook at the time the operation was called. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistry.md b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistry.md new file mode 100644 index 0000000000..f2a71140bf --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistry.md @@ -0,0 +1,633 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/update-azcontainerregistry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistry.md +--- + +# Update-AzContainerRegistry + +## SYNOPSIS +Updates a container registry with the specified parameters. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzContainerRegistry -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AnonymousPullEnabled] [-AzureAdAuthenticationAsArmPolicyStatus <AzureAdAuthenticationAsArmPolicyStatus>] + [-DataEndpointEnabled] [-EnableAdminUser] [-EncryptionStatus <EncryptionStatus>] + [-ExportPolicyStatus <ExportPolicyStatus>] [-IdentityPrincipalId <String>] [-IdentityTenantId <String>] + [-IdentityType <ResourceIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] + [-KeyVaultPropertyIdentity <String>] [-KeyVaultPropertyKeyIdentifier <String>] + [-NetworkRuleBypassOption <NetworkRuleBypassOptions>] [-NetworkRuleSetDefaultAction <DefaultAction>] + [-NetworkRuleSetIPRule <IIPRule[]>] [-PublicNetworkAccess <PublicNetworkAccess>] + [-QuarantinePolicyStatus <PolicyStatus>] [-RetentionPolicyDay <Int32>] [-RetentionPolicyStatus <PolicyStatus>] + [-Sku <SkuName>] [-SoftDeletePolicyRetentionDay <Int32>] [-SoftDeletePolicyStatus <PolicyStatus>] + [-Tag <Hashtable>] [-TrustPolicyStatus <PolicyStatus>] [-TrustPolicyType <TrustPolicyType>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzContainerRegistry -InputObject <IContainerRegistryIdentity> [-AnonymousPullEnabled] + [-AzureAdAuthenticationAsArmPolicyStatus <AzureAdAuthenticationAsArmPolicyStatus>] [-DataEndpointEnabled] + [-EnableAdminUser] [-EncryptionStatus <EncryptionStatus>] [-ExportPolicyStatus <ExportPolicyStatus>] + [-IdentityPrincipalId <String>] [-IdentityTenantId <String>] [-IdentityType <ResourceIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-KeyVaultPropertyIdentity <String>] + [-KeyVaultPropertyKeyIdentifier <String>] [-NetworkRuleBypassOption <NetworkRuleBypassOptions>] + [-NetworkRuleSetDefaultAction <DefaultAction>] [-NetworkRuleSetIPRule <IIPRule[]>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-QuarantinePolicyStatus <PolicyStatus>] + [-RetentionPolicyDay <Int32>] [-RetentionPolicyStatus <PolicyStatus>] [-Sku <SkuName>] + [-SoftDeletePolicyRetentionDay <Int32>] [-SoftDeletePolicyStatus <PolicyStatus>] [-Tag <Hashtable>] + [-TrustPolicyStatus <PolicyStatus>] [-TrustPolicyType <TrustPolicyType>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a container registry with the specified parameters. + +## EXAMPLES + +### Example 1: Enable admin user for a specified container registry +```powershell +Update-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "RegistryExample" -EnableAdminUser +``` + +```output +Name SkuName LoginServer CreationDate ProvisioningState AdminUserEnabled +---- ------- ----------- ------------ ----------------- ---------------- +RegistryExample Basic registryexample.azurecr.io 1/19/2023 6:10:49 AM Succeeded True +``` + +This command enables admin user for the specified container registry. + +## PARAMETERS + +### -AnonymousPullEnabled +Enables registry-wide pull from unauthenticated clients. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureAdAuthenticationAsArmPolicyStatus +The value that indicates whether the policy is enabled or not. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.AzureAdAuthenticationAsArmPolicyStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEndpointEnabled +Enable a single data endpoint per region for serving data. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAdminUser +The value that indicates whether the admin user is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionStatus +Indicates whether or not the encryption is enabled for container registry. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.EncryptionStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportPolicyStatus +The value that indicates whether the policy is enabled or not. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.ExportPolicyStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityPrincipalId +The principal ID of resource identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityTenantId +The tenant ID of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +The list of user identities associated with the resource. +The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyVaultPropertyIdentity +The client id of the identity which will be used to access key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyIdentifier +Key vault uri to access the encryption key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: RegistryName, ResourceName, ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkRuleBypassOption +Whether to allow trusted Azure services to access a network restricted registry. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.NetworkRuleBypassOptions +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkRuleSetDefaultAction +The default action of allow or deny when no other rules match. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.DefaultAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkRuleSetIPRule +The IP ACL rules. +To construct, see NOTES section for NETWORKRULESETIPRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IIPRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Whether or not public network access is allowed for the container registry. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantinePolicyStatus +The value that indicates whether the policy is enabled or not. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PolicyStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicyDay +The number of days to retain an untagged manifest after which it gets purged. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicyStatus +The value that indicates whether the policy is enabled or not. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PolicyStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SKU name of the container registry. +Required for registry creation. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletePolicyRetentionDay +The number of days after which a soft-deleted item is permanently deleted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletePolicyStatus +The value that indicates whether the policy is enabled or not. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PolicyStatus +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. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags for the container registry. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustPolicyStatus +The value that indicates whether the policy is enabled or not. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PolicyStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustPolicyType +The type of trust policy. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.TrustPolicyType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistry + +## 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 <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +`NETWORKRULESETIPRULE <IIPRule[]>`: The IP ACL rules. + - `IPAddressOrRange <String>`: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + - `[Action <Action?>]`: The action of IP ACL rule. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryAgentPool.md b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryAgentPool.md new file mode 100644 index 0000000000..8c33bb2091 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryAgentPool.md @@ -0,0 +1,276 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/update-azcontainerregistryagentpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryAgentPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryAgentPool.md +--- + +# Update-AzContainerRegistryAgentPool + +## SYNOPSIS +Updates an agent pool with the specified parameters. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzContainerRegistryAgentPool -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Count <Int32>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzContainerRegistryAgentPool -InputObject <IContainerRegistryIdentity> [-Count <Int32>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an agent pool with the specified parameters. + +## EXAMPLES + +### Example 1: Updates an agent pool with the specified parameters +```powershell +Update-AzContainerRegistryAgentPool -AgentPoolName agent -RegistryName RegistryExample -ResourceGroupName MyResourceGroup -Count 5 +``` + +```output +Name Location OS Count ProvisioningState +---- -------- -- ----- ----------------- +agent eastus Linux 5 Succeeded +``` + +Updates an agent pool with the specified parameters + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +The count of agent machine + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the agent pool. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: AgentPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the container registry belongs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The ARM resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api20190601Preview.IAgentPool + +## 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 <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryCredential.md b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryCredential.md new file mode 100644 index 0000000000..62f068b9a1 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryCredential.md @@ -0,0 +1,309 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/update-azcontainerregistrycredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryCredential.md +--- + +# Update-AzContainerRegistryCredential + +## SYNOPSIS +Regenerates one of the login credentials for the specified container registry. + +## SYNTAX + +### RegenerateExpanded (Default) +``` +Update-AzContainerRegistryCredential -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -PasswordName <PasswordName> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Regenerate +``` +Update-AzContainerRegistryCredential -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -RegenerateCredentialParameter <IRegenerateCredentialParameters> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RegenerateViaIdentityExpanded +``` +Update-AzContainerRegistryCredential -InputObject <IContainerRegistryIdentity> -PasswordName <PasswordName> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RegenerateByRegistry +``` +Update-AzContainerRegistryCredential -Registry <IRegistry> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Regenerates one of the login credentials for the specified container registry. + +## EXAMPLES + +### Example 1: Regenerate a login credential for a container registry +```powershell +Update-AzContainerRegistryCredential -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -PasswordName Password +``` + +```output +Username Password Password2 +-------- -------- --------- +RegistryExample xxxxxxxxx xxxxxxxxx +``` + +This command regenerates a login credential for the specified container registry. +Admin user has to be enabled for the container registry \`MyRegistry\` to regenerate login credentials. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: RegenerateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PasswordName +Specifies name of the password which should be regenerated -- password or password2. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.PasswordName +Parameter Sets: RegenerateExpanded, RegenerateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegenerateCredentialParameter +The parameters used to regenerate the login credential. +To construct, see NOTES section for REGENERATECREDENTIALPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegenerateCredentialParameters +Parameter Sets: Regenerate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Registry +The Registry Object. +To construct, see NOTES section for REGISTRY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistry +Parameter Sets: RegenerateByRegistry +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded, Regenerate +Aliases: ContainerRegistryName, Name, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded, Regenerate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded, Regenerate +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegenerateCredentialParameters + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IRegistry + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.PSContainerRegistryCredential + +## 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 <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +`REGENERATECREDENTIALPARAMETER <IRegenerateCredentialParameters>`: The parameters used to regenerate the login credential. + - `Name <PasswordName>`: Specifies name of the password which should be regenerated -- password or password2. + +`REGISTRY <IRegistry>`: The Registry Object. + - `Location <String>`: The location of the resource. This cannot be changed after the resource is created. + - `SkuName <SkuName>`: The SKU name of the container registry. Required for registry creation. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource modification (UTC). + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <LastModifiedByType?>]`: The type of identity that last modified the resource. + - `[Tag <IResourceTags>]`: The tags of the resource. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdminUserEnabled <Boolean?>]`: The value that indicates whether the admin user is enabled. + - `[AnonymousPullEnabled <Boolean?>]`: Enables registry-wide pull from unauthenticated clients. + - `[AzureAdAuthenticationAsArmPolicyStatus <AzureAdAuthenticationAsArmPolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[AzureAsyncOperation <String>]`: + - `[DataEndpointEnabled <Boolean?>]`: Enable a single data endpoint per region for serving data. + - `[EncryptionStatus <EncryptionStatus?>]`: Indicates whether or not the encryption is enabled for container registry. + - `[ExportPolicyStatus <ExportPolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[IdentityPrincipalId <String>]`: The principal ID of resource identity. + - `[IdentityTenantId <String>]`: The tenant ID of resource. + - `[IdentityType <ResourceIdentityType?>]`: The identity type. + - `[IdentityUserAssignedIdentity <IIdentityPropertiesUserAssignedIdentities>]`: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + - `[(Any) <IUserIdentityProperties>]`: This indicates any property can be added to this object. + - `[KeyVaultPropertyIdentity <String>]`: The client id of the identity which will be used to access key vault. + - `[KeyVaultPropertyKeyIdentifier <String>]`: Key vault uri to access the encryption key. + - `[NetworkRuleBypassOption <NetworkRuleBypassOptions?>]`: Whether to allow trusted Azure services to access a network restricted registry. + - `[NetworkRuleSetDefaultAction <DefaultAction?>]`: The default action of allow or deny when no other rules match. + - `[NetworkRuleSetIPRule <IIPRule[]>]`: The IP ACL rules. + - `IPAddressOrRange <String>`: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + - `[Action <Action?>]`: The action of IP ACL rule. + - `[PublicNetworkAccess <PublicNetworkAccess?>]`: Whether or not public network access is allowed for the container registry. + - `[QuarantinePolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[RetentionPolicyDay <Int32?>]`: The number of days to retain an untagged manifest after which it gets purged. + - `[RetentionPolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[SoftDeletePolicyRetentionDay <Int32?>]`: The number of days after which a soft-deleted item is permanently deleted. + - `[SoftDeletePolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[TrustPolicyStatus <PolicyStatus?>]`: The value that indicates whether the policy is enabled or not. + - `[TrustPolicyType <TrustPolicyType?>]`: The type of trust policy. + - `[ZoneRedundancy <ZoneRedundancy?>]`: Whether or not zone redundancy is enabled for this container registry + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryManifest.md b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryManifest.md new file mode 100644 index 0000000000..0af990f3e0 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryManifest.md @@ -0,0 +1,246 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.dll-Help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/update-azcontainerregistrymanifest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryManifest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryManifest.md +--- + +# Update-AzContainerRegistryManifest + +## SYNOPSIS +Update ACR manifest. + +## SYNTAX + +### ByManifestParameterSet (Default) +``` +Update-AzContainerRegistryManifest -RepositoryName <String> -Manifest <String> [-DeleteEnabled <Boolean>] + [-WriteEnabled <Boolean>] [-ListEnabled <Boolean>] [-ReadEnabled <Boolean>] -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTagParameterSet +``` +Update-AzContainerRegistryManifest -RepositoryName <String> -Tag <String> [-DeleteEnabled <Boolean>] + [-WriteEnabled <Boolean>] [-ListEnabled <Boolean>] [-ReadEnabled <Boolean>] -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update ACR manifest. +To use this cmdlet please run +`Update-AzContainerRegistryRepository -RegistryName XXX -Repository XXX -WriteEnable $true` +first. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzContainerRegistryManifest -RegistryName registry -RepositoryName alpine -Manifest sha256:185518070891758909c9f839cf4ca393ee977ac378609f700f60a771a2dfe321 -DeleteEnabled $false -WriteEnabled $true -ListEnabled $true -ReadEnabled $true +``` + +```output +Registry ImageName Attributes +-------- --------- ---------- +registry.azurecr.io alpine Microsoft.Azure.Commands.ContainerRegistry.Models.PSManifestAttributeBase +``` + +Update attributes for manifest sha256:185518070891758909c9f839cf4ca393ee977ac378609f700f60a771a2dfe321 under registry. + +### Example 2 +```powershell +Update-AzContainerRegistryManifest -RegistryName registry -RepositoryName alpine -Tag latest -DeleteEnabled $false -WriteEnabled $true -ListEnabled $true -ReadEnabled $true +``` + +```output +Registry ImageName Attributes +-------- --------- ---------- +registry.azurecr.io alpine Microsoft.Azure.Commands.ContainerRegistry.Models.PSManifestAttributeBase +``` + +Update attributes for manifest with tag latest under registry. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteEnabled +Delete enable. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListEnabled +List enable. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Manifest +Manifest reference. + +```yaml +Type: System.String +Parameter Sets: ByManifestParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReadEnabled +Read enable. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +Azure Container Registry Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RepositoryName +Repository Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Tag. + +```yaml +Type: System.String +Parameter Sets: ByTagParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WriteEnabled +Write enable. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ContainerRegistry.Models.PSManifestAttribute + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryRepository.md b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryRepository.md new file mode 100644 index 0000000000..2a3dfb0f02 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryRepository.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.dll-Help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/update-azcontainerregistryrepository +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryRepository.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryRepository.md +--- + +# Update-AzContainerRegistryRepository + +## SYNOPSIS +Update ACR repository. + +## SYNTAX + +``` +Update-AzContainerRegistryRepository -Name <String> [-DeleteEnabled <Boolean>] [-WriteEnabled <Boolean>] + [-ListEnabled <Boolean>] [-ReadEnabled <Boolean>] -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update ACR repository. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzContainerRegistryRepository -RegistryName registry -Name test/busybox8 -DeleteEnabled $false -WriteEnabled $true -ListEnabled $true -ReadEnabled $true +``` + +```output +Registry : registry.azurecr.io +ImageName : test/busybox8 +CreatedTime : 2020-12-11T08:57:56.2070002Z +LastUpdateTime : 2020-12-11T08:57:56.5188237Z +ManifestCount : 1 +TagCount : 1 +ChangeableAttributes : Microsoft.Azure.Commands.ContainerRegistry.Models.PSChangeableAttribute +``` + +Update attributes for repository alpine under registry. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteEnabled +Delete enable. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListEnabled +List enable. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Repository Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReadEnabled +Read enable. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +Azure Container Registry Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WriteEnabled +Write enable. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ContainerRegistry.Models.PSRepositoryAttribute + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryScopeMap.md b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryScopeMap.md new file mode 100644 index 0000000000..e934005ee4 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryScopeMap.md @@ -0,0 +1,280 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/update-azcontainerregistryscopemap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryScopeMap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryScopeMap.md +--- + +# Update-AzContainerRegistryScopeMap + +## SYNOPSIS +Updates a scope map with the specified parameters. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzContainerRegistryScopeMap -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Action <String[]>] [-Description <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzContainerRegistryScopeMap -InputObject <IContainerRegistryIdentity> [-Action <String[]>] + [-Description <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates a scope map with the specified parameters. + +## EXAMPLES + +### Example 1: Update action for a scope map +```powershell +Update-AzContainerRegistryScopeMap -Name newmap -RegistryName RegistryExample -ResourceGroupName MyResourceGroup -Action "repositories/busybox/content/read" +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLas + tModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------- +newmap 01/20/2023 05:49:36 user@microsoft.com User 01/20/2023 05:49:36 user@microsoft.com +``` + +Update action for a scope map + +## PARAMETERS + +### -Action +The list of scope permissions for registry artifacts.E.g. +repositories/repository-name/pull, repositories/repository-name/delete + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The user friendly description of the scope map. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the scope map. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ScopeMapName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IScopeMap + +## 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 <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryTag.md b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryTag.md new file mode 100644 index 0000000000..ae7e9b068e --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryTag.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.dll-Help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/update-azcontainerregistrytag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryTag.md +--- + +# Update-AzContainerRegistryTag + +## SYNOPSIS +Update ACR tag. + +## SYNTAX + +``` +Update-AzContainerRegistryTag -RepositoryName <String> -Name <String> [-DeleteEnabled <Boolean>] + [-WriteEnabled <Boolean>] [-ListEnabled <Boolean>] [-ReadEnabled <Boolean>] -RegistryName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update attributes of a given ACR tag. + +Before using this cmdlet you must run `Update-AzContainerRegistryRepository -RegistryName XXX -Repository XXX -WriteEnable $true` +first. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzContainerRegistryTag -RegistryName registry -RepositoryName alpine -Name latest -DeleteEnabled $false -WriteEnabled $true -ListEnabled $true -ReadEnabled $true +``` + +```output +Registry ImageName Attributes +-------- --------- ---------- +registry.azurecr.io alpine Microsoft.Azure.Commands.ContainerRegistry.Models.PSTagAttribute +``` + +Update attributes for tag latest under registry. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteEnabled +Delete enable. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListEnabled +List enable. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReadEnabled +Read enable. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +Azure Container Registry Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RepositoryName +Repository Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WriteEnabled +Write enable. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ContainerRegistry.Models.PSTagAttribute + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryToken.md b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryToken.md new file mode 100644 index 0000000000..6063d3aa40 --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryToken.md @@ -0,0 +1,324 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/update-azcontainerregistrytoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryToken.md +--- + +# Update-AzContainerRegistryToken + +## SYNOPSIS +Updates a token with the specified parameters. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzContainerRegistryToken -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-CredentialsCertificate <ITokenCertificate[]>] + [-CredentialsPassword <ITokenPassword[]>] [-ScopeMapId <String>] [-Status <TokenStatus>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzContainerRegistryToken -InputObject <IContainerRegistryIdentity> + [-CredentialsCertificate <ITokenCertificate[]>] [-CredentialsPassword <ITokenPassword[]>] + [-ScopeMapId <String>] [-Status <TokenStatus>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a token with the specified parameters. + +## EXAMPLES + +### Example 1: Update token scope map for a token +```powershell +Update-AzContainerRegistryToken -name token -ScopeMapId /subscriptions/${subscription}/resourceGroups/myResourceGroups/providers/Microsoft.ContainerRegistry/registry/MyRegistries/scopeMaps/test -RegistryName MyRegistry -ResourceGroupName myResourceGroups +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLa + stModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------ +token 01/20/2023 05:59:56 user@microsoft.com User 01/20/2023 05:59:56 user +``` + +Update token scope map for a token + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialsCertificate +. +To construct, see NOTES section for CREDENTIALSCERTIFICATE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.ITokenCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialsPassword +. +To construct, see NOTES section for CREDENTIALSPASSWORD properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.ITokenPassword[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the token. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: TokenName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeMapId +The resource ID of the scope map to which the token will be associated with. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The status of the token example enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.TokenStatus +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. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IToken + +## 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. + + +`CREDENTIALSCERTIFICATE <ITokenCertificate[]>`: . + - `[EncodedPemCertificate <String>]`: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. + - `[Expiry <DateTime?>]`: The expiry datetime of the certificate. + - `[Name <TokenCertificateName?>]`: + - `[Thumbprint <String>]`: The thumbprint of the certificate. + +`CREDENTIALSPASSWORD <ITokenPassword[]>`: . + - `[CreationTime <DateTime?>]`: The creation datetime of the password. + - `[Expiry <DateTime?>]`: The expiry datetime of the password. + - `[Name <TokenPasswordName?>]`: The password name "password1" or "password2" + +`INPUTOBJECT <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryWebhook.md b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryWebhook.md new file mode 100644 index 0000000000..8d99bec37d --- /dev/null +++ b/azps-10.1.0/Az.ContainerRegistry/Update-AzContainerRegistryWebhook.md @@ -0,0 +1,343 @@ +--- +external help file: Az.ContainerRegistry-help.xml +Module Name: Az.ContainerRegistry +online version: https://learn.microsoft.com/powershell/module/az.containerregistry/update-azcontainerregistrywebhook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryWebhook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/help/Update-AzContainerRegistryWebhook.md +--- + +# Update-AzContainerRegistryWebhook + +## SYNOPSIS +Updates a webhook with the specified parameters. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzContainerRegistryWebhook -Name <String> -RegistryName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Action <WebhookAction[]>] [-CustomHeader <Hashtable>] [-Scope <String>] + [-ServiceUri <String>] [-Status <WebhookStatus>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzContainerRegistryWebhook -InputObject <IContainerRegistryIdentity> [-Action <WebhookAction[]>] + [-CustomHeader <Hashtable>] [-Scope <String>] [-ServiceUri <String>] [-Status <WebhookStatus>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a webhook with the specified parameters. + +## EXAMPLES + +### Example 1: Update an existing container registry webhook. +```powershell +Update-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "webhook001" -Uri http://www.bing.com -Action Delete,Push -Header @{SpecialHeader='headerVal'} -Tag @{Key='val'} -Status Enabled -Scope 'foo:*' +``` + +```output +Name Location Status Scope ProvisioningState +---- -------- ------ ----- ----------------- +webhook001 eastus2 enabled foo:* Succeeded +``` + +Update an existing container registry webhook. + +## PARAMETERS + +### -Action +The list of actions that trigger the webhook to post notifications. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.WebhookAction[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomHeader +Custom headers that will be added to the webhook notifications. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Header + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the webhook. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: WebhookName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistryName +The name of the container registry. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ContainerRegistryName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of repositories where the event can be triggered. +For example, 'foo:*' means events for all tags under repository 'foo'. +'foo:bar' means events for 'foo:bar' only. +'foo' is equivalent to 'foo:latest'. +Empty means all events. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceUri +The service URI for the webhook to post notifications. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Uri + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The status of the webhook at the time the operation was called. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Support.WebhookStatus +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. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags for the webhook. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.IContainerRegistryIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api202301Preview.IWebhook + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IContainerRegistryIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the agent pool. + - `[CacheRuleName <String>]`: The name of the cache rule. + - `[ConnectedRegistryName <String>]`: The name of the connected registry. + - `[CredentialSetName <String>]`: The name of the credential set. + - `[ExportPipelineName <String>]`: The name of the export pipeline. + - `[GroupName <String>]`: The name of the private link resource. + - `[Id <String>]`: Resource identity path + - `[ImportPipelineName <String>]`: The name of the import pipeline. + - `[PipelineRunName <String>]`: The name of the pipeline run. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[RegistryName <String>]`: The name of the container registry. + - `[ReplicationName <String>]`: The name of the replication. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RunId <String>]`: The run ID. + - `[ScopeMapName <String>]`: The name of the scope map. + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[TaskName <String>]`: The name of the container registry task. + - `[TaskRunName <String>]`: The name of the task run. + - `[TokenName <String>]`: The name of the token. + - `[WebhookName <String>]`: The name of the webhook. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Az.CosmosDB.md b/azps-10.1.0/Az.CosmosDB/Az.CosmosDB.md new file mode 100644 index 0000000000..d31ead6d6f --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Az.CosmosDB.md @@ -0,0 +1,496 @@ +--- +Module Name: Az.CosmosDB +Module Guid: 91832aaa-dc11-4583-8239-bce5fd531604 +Download Help Link: {{ https://learn.microsoft.com/powershell/module/az.cosmosdb }} +Help Version: {{ 1.0.0.1 }} +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Az.CosmosDB.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Az.CosmosDB.md +--- + +# Az.CosmosDB Module +## Description +The topics in this section document the Azure PowerShell cmdlets for Azure Cosmos DB and Azure Managed Instance for Apache Cassandra in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.CosmosDB namespace. + +## Az.CosmosDB Cmdlets +### [Get-AzCosmosDBAccount](Get-AzCosmosDBAccount.md) +Get Cosmos DB Account. + +### [Get-AzCosmosDBAccountKey](Get-AzCosmosDBAccountKey.md) +Get Keys{"ConnectionKeys", "PrimaryReadOnly" or "Keys"} for the given Cosmos DB Account. + +### [Get-AzCosmosDBCassandraKeyspace](Get-AzCosmosDBCassandraKeyspace.md) +Gets a CosmosDB Cassandra Keyspace. + +### [Get-AzCosmosDBCassandraKeyspaceThroughput](Get-AzCosmosDBCassandraKeyspaceThroughput.md) +Gets the throughput value of the Cassandra Keyspace. + +### [Get-AzCosmosDBCassandraTable](Get-AzCosmosDBCassandraTable.md) +Gets a CosmosDB Cassandra Table. + +### [Get-AzCosmosDBCassandraTableThroughput](Get-AzCosmosDBCassandraTableThroughput.md) +Gets the throughput value of the Cassandra Table. + +### [Get-AzCosmosDbClientEncryptionKey](Get-AzCosmosDbClientEncryptionKey.md) +Gets the CosmosDB Client Encryption Key. + +### [Get-AzCosmosDBGremlinDatabase](Get-AzCosmosDBGremlinDatabase.md) +Gets the CosmosDB Gremlin Database. + +### [Get-AzCosmosDBGremlinDatabaseThroughput](Get-AzCosmosDBGremlinDatabaseThroughput.md) +Gets the throughput of a CosmosDB Gremlin Database. + +### [Get-AzCosmosDBGremlinGraph](Get-AzCosmosDBGremlinGraph.md) +Gets the CosmosDB Gremlin Graph. + +### [Get-AzCosmosDBGremlinGraphBackupInformation](Get-AzCosmosDBGremlinGraphBackupInformation.md) +Retrieves the latest restorable timestamp for a gremlin graph. + +### [Get-AzCosmosDBGremlinGraphThroughput](Get-AzCosmosDBGremlinGraphThroughput.md) +Gets the throughput of a CosmosDB Gremlin Graph. + +### [Get-AzCosmosDBGremlinRestorableDatabase](Get-AzCosmosDBGremlinRestorableDatabase.md) +Gets the list of all the restorable Azure Cosmos DB Gremlin databases available under the restorable account. + +### [Get-AzCosmosDBGremlinRestorableGraph](Get-AzCosmosDBGremlinRestorableGraph.md) +Lists all the restorable Azure Cosmos DB Gremlin graphs available for a specific database. + +### [Get-AzCosmosDBGremlinRestorableResource](Get-AzCosmosDBGremlinRestorableResource.md) +Lists all the restorable Azure Cosmos DB Gremlin resources available for a specific database account at a given time and location. + +### [Get-AzCosmosDBLocation](Get-AzCosmosDBLocation.md) +List Azure Cosmos DB locations and their properties. +Get Azure Cosmos DB location properties for a specific location. + +### [Get-AzCosmosDBMongoDBCollection](Get-AzCosmosDBMongoDBCollection.md) +Gets the CosmosDB MongoDB Collection. + +### [Get-AzCosmosDBMongoDBCollectionBackupInformation](Get-AzCosmosDBMongoDBCollectionBackupInformation.md) +Retrieves the latest restorable timestamp for a mongodb collection. + +### [Get-AzCosmosDBMongoDBCollectionThroughput](Get-AzCosmosDBMongoDBCollectionThroughput.md) +Gets the CosmosDB throughput properties of MongoDB Collection. + +### [Get-AzCosmosDBMongoDBDatabase](Get-AzCosmosDBMongoDBDatabase.md) +Gets the CosmosDB MongoDB Database + +### [Get-AzCosmosDBMongoDBDatabaseThroughput](Get-AzCosmosDBMongoDBDatabaseThroughput.md) +Gets the CosmosDB throughput properties of MongoDB Database. + +### [Get-AzCosmosDBMongoDBRestorableCollection](Get-AzCosmosDBMongoDBRestorableCollection.md) +Lists all the restorable Azure Cosmos DB MongoDB collection available for a specific database. + +### [Get-AzCosmosDBMongoDBRestorableDatabase](Get-AzCosmosDBMongoDBRestorableDatabase.md) +Gets the list of all the restorable Azure Cosmos DB MongoDB databases available under the restorable account. + +### [Get-AzCosmosDBMongoDBRestorableResource](Get-AzCosmosDBMongoDBRestorableResource.md) +Lists all the restorable Azure Cosmos DB MongoDB resources available for a specific database account at a given time and location. + +### [Get-AzCosmosDBMongoDBRoleDefinition](Get-AzCosmosDBMongoDBRoleDefinition.md) +Gets the CosmosDB MongoDB Role Definition for the specified resource group and account. + +### [Get-AzCosmosDBMongoDBUserDefinition](Get-AzCosmosDBMongoDBUserDefinition.md) +Gets the CosmosDB MongoDB User Definition. + +### [Get-AzCosmosDBRestorableDatabaseAccount](Get-AzCosmosDBRestorableDatabaseAccount.md) +Gets the restorable database account object + +### [Get-AzCosmosDBSqlContainer](Get-AzCosmosDBSqlContainer.md) +Gets the CosmosDB Sql Container. + +### [Get-AzCosmosDBSqlContainerBackupInformation](Get-AzCosmosDBSqlContainerBackupInformation.md) +Retrieves the latest restorable timestamp for a sql container. + +### [Get-AzCosmosDBSqlContainerThroughput](Get-AzCosmosDBSqlContainerThroughput.md) +Gets the throughput settings corresponding to a CosmosDB Sql Container. + +### [Get-AzCosmosDBSqlDatabase](Get-AzCosmosDBSqlDatabase.md) +Gets the CosmosDB Sql Database. + +### [Get-AzCosmosDBSqlDatabaseThroughput](Get-AzCosmosDBSqlDatabaseThroughput.md) +Gets the throughput settings corresponding to a CosmosDB Sql Database. + +### [Get-AzCosmosDBSqlRestorableContainer](Get-AzCosmosDBSqlRestorableContainer.md) +Lists all the restorable Azure Cosmos DB SQL containers available for a specific database. + +### [Get-AzCosmosDBSqlRestorableDatabase](Get-AzCosmosDBSqlRestorableDatabase.md) +Gets the list of all the restorable Azure Cosmos DB Sql databases available under the restorable account. + +### [Get-AzCosmosDBSqlRestorableResource](Get-AzCosmosDBSqlRestorableResource.md) +Lists all the restorable Azure Cosmos DB SQL resources available for a specific database account at a given time and location. + +### [Get-AzCosmosDBSqlRoleAssignment](Get-AzCosmosDBSqlRoleAssignment.md) +Gets the CosmosDB Sql Role Assignment. + +### [Get-AzCosmosDBSqlRoleDefinition](Get-AzCosmosDBSqlRoleDefinition.md) +Gets the CosmosDB Role Definition. + +### [Get-AzCosmosDBSqlStoredProcedure](Get-AzCosmosDBSqlStoredProcedure.md) +Gets the CosmosDB Sql StoredProcedure. + +### [Get-AzCosmosDBSqlTrigger](Get-AzCosmosDBSqlTrigger.md) +Gets the CosmosDB Sql Trigger. + +### [Get-AzCosmosDBSqlUserDefinedFunction](Get-AzCosmosDBSqlUserDefinedFunction.md) +Gets the CosmosDB Sql User Defined Function. + +### [Get-AzCosmosDBTable](Get-AzCosmosDBTable.md) +Gets a CosmosDB Table. + +### [Get-AzCosmosDBTableBackupInformation](Get-AzCosmosDBTableBackupInformation.md) +Retrieves the latest restorable timestamp for a table. + +### [Get-AzCosmosDBTableRestorableResource](Get-AzCosmosDBTableRestorableResource.md) +Lists all the restorable Azure Cosmos DB Table resources available for a specific database account at a given time and location. + +### [Get-AzCosmosDBTableRestorableTable](Get-AzCosmosDBTableRestorableTable.md) +Lists all the restorable Azure Cosmos DB Tables available for a specific database. + +### [Get-AzCosmosDBTableThroughput](Get-AzCosmosDBTableThroughput.md) +Gets the throughput of a CosmosDB Table. + +### [Get-AzManagedCassandraCluster](Get-AzManagedCassandraCluster.md) +Gets a Azure Managed Instances for Apache Cassandra cluster. + +### [Get-AzManagedCassandraDatacenter](Get-AzManagedCassandraDatacenter.md) +Gets a Azure Managed Instances for Apache Cassandra data center. + +### [Get-AzCosmosDBService](Get-AzCosmosDBService.md) +Gets the Cosmos DB Service + +### [Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration](Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration.md) +Use this to migrate autoscale throughput to manual throughput and vice versa. + +### [Invoke-AzCosmosDBCassandraTableThroughputMigration](Invoke-AzCosmosDBCassandraTableThroughputMigration.md) +Use this to migrate autoscale throughput to manual throughput and vice versa. + +### [Invoke-AzCosmosDBGremlinDatabaseThroughputMigration](Invoke-AzCosmosDBGremlinDatabaseThroughputMigration.md) +Use this to migrate autoscale throughput to manual throughput and vice versa. + +### [Invoke-AzCosmosDBGremlinGraphThroughputMigration](Invoke-AzCosmosDBGremlinGraphThroughputMigration.md) +Use this to migrate autoscale throughput to manual throughput and vice versa. + +### [Invoke-AzCosmosDBMongoDBCollectionThroughputMigration](Invoke-AzCosmosDBMongoDBCollectionThroughputMigration.md) +Use this to migrate autoscale throughput to manual throughput and vice versa. + +### [Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration](Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration.md) +Use this to migrate autoscale throughput to manual throughput and vice versa. + +### [Invoke-AzCosmosDBSqlContainerThroughputMigration](Invoke-AzCosmosDBSqlContainerThroughputMigration.md) +Use this to migrate autoscale throughput to manual throughput and vice versa. + +### [Invoke-AzCosmosDBSqlDatabaseThroughputMigration](Invoke-AzCosmosDBSqlDatabaseThroughputMigration.md) +Use this to migrate autoscale throughput to manual throughput and vice versa. + +### [Invoke-AzCosmosDBTableThroughputMigration](Invoke-AzCosmosDBTableThroughputMigration.md) +Use this to migrate autoscale throughput to manual throughput and vice versa. + +### [New-AzCosmosDBAccount](New-AzCosmosDBAccount.md) +Create a new Cosmos DB Account. + +### [New-AzCosmosDBAccountKey](New-AzCosmosDBAccountKey.md) +Regenerate a given Cosmos DB Account Key. + +### [New-AzCosmosDBCassandraClusterKey](New-AzCosmosDBCassandraClusterKey.md) +Creates a new CosmosDB Cassandra Cluster Key. + +### [New-AzCosmosDBCassandraColumn](New-AzCosmosDBCassandraColumn.md) +Creates a new CosmosDB Cassandra Column. + +### [New-AzCosmosDBCassandraKeyspace](New-AzCosmosDBCassandraKeyspace.md) +Creates a new CosmosDB Cassandra Keyspace. + +### [New-AzCosmosDBCassandraSchema](New-AzCosmosDBCassandraSchema.md) +Creates a new CosmosDB Cassandra Schema. + +### [New-AzCosmosDBCassandraTable](New-AzCosmosDBCassandraTable.md) +Creates a new CosmosDB Cassandra Table. + +### [New-AzCosmosDbClientEncryptionKey](New-AzCosmosDbClientEncryptionKey.md) +Creates a new CosmosDB Client Encryption Key. + +### [New-AzCosmosDBDatabaseToRestore](New-AzCosmosDBDatabaseToRestore.md) +Creates a new CosmosDB Database to Restore object(PSDatabaseToRestore) + +### [New-AzCosmosDBGremlinCompositePath](New-AzCosmosDBGremlinCompositePath.md) +Creates a new object of type PSCompositePath. It can be passed as a parameter value for Set-AzCosmosDBGremlinGraph. + +### [New-AzCosmosDBGremlinConflictResolutionPolicy](New-AzCosmosDBGremlinConflictResolutionPolicy.md) +Creates a new object of type PSConflictResolutionPolicy. It can be passed as a parameter value for Set-AzCosmosDBGremlinGraph. + +### [New-AzCosmosDBGremlinDatabase](New-AzCosmosDBGremlinDatabase.md) +Creates a new CosmosDB Gremlin Database. + +### [New-AzCosmosDBGremlinDatabaseToRestore](New-AzCosmosDBGremlinDatabaseToRestore.md) +Creates a new CosmosDB Gremlin Database to Restore object(PSGremlinDatabaseToRestore) + +### [New-AzCosmosDBGremlinGraph](New-AzCosmosDBGremlinGraph.md) +Creates a new CosmosDB Gremlin Graph. + +### [New-AzCosmosDBGremlinIncludedPath](New-AzCosmosDBGremlinIncludedPath.md) +Creates a new object of type PSIncludedPath. It can be passed as a parameter value for Set-AzCosmosDBGremlinGraph. + +### [New-AzCosmosDBGremlinIncludedPathIndex](New-AzCosmosDBGremlinIncludedPathIndex.md) +Creates a new object of type PSIndexes. It can be passed as a parameter value for Set-AzCosmosDBGremlinIncludedPath. + +### [New-AzCosmosDBGremlinIndexingPolicy](New-AzCosmosDBGremlinIndexingPolicy.md) +Creates a new CosmosDB IndexingPolicy object. + +### [New-AzCosmosDBGremlinSpatialSpec](New-AzCosmosDBGremlinSpatialSpec.md) +Creates a new object of type PSSpatialSpec. It can be passed as a parameter value for Set-AzCosmosDBGremlinIndexingPolicy. + +### [New-AzCosmosDBGremlinUniqueKey](New-AzCosmosDBGremlinUniqueKey.md) +Creates a new CosmosDB UniqueKeyPolicy object. + +### [New-AzCosmosDBGremlinUniqueKeyPolicy](New-AzCosmosDBGremlinUniqueKeyPolicy.md) +Creates a new CosmosDB UniqueKeyPolicy object. + +### [New-AzCosmosDBLocationObject](New-AzCosmosDBLocationObject.md) +Create a new CosmosDB Location Object(PSLocation). + +### [New-AzCosmosDBMongoDBCollection](New-AzCosmosDBMongoDBCollection.md) +Creates a new CosmosDB MongoDB Collection. + +### [New-AzCosmosDBMongoDBDatabase](New-AzCosmosDBMongoDBDatabase.md) +Creates a new CosmosDB MongoDB Database. + +### [New-AzCosmosDBMongoDBIndex](New-AzCosmosDBMongoDBIndex.md) +Creates a new CosmosDB MongoDB Index. + +### [New-AzCosmosDBMongoDBPrivilege](New-AzCosmosDBMongoDBPrivilege.md) +Creates a new CosmosDB MongoDB Privilege object to be used to create or update a CosmosDB MongoDB Role Definition. + +### [New-AzCosmosDBMongoDBPrivilegeResource](New-AzCosmosDBMongoDBPrivilegeResource.md) +Creates a new CosmosDB MongoDB PrivilegeResource object to be used to create or update a CosmosDB MongoDB Role Definition. + +### [New-AzCosmosDBMongoDBRole](New-AzCosmosDBMongoDBRole.md) +Creates a new CosmosDB MongoDB Role object to be used to create or update a CosmosDB MongoDB Role Definition and User Definition. + +### [New-AzCosmosDBMongoDBRoleDefinition](New-AzCosmosDBMongoDBRoleDefinition.md) +Creates a new CosmosDB MongoDB Role Definition. + +### [New-AzCosmosDBMongoDBUserDefinition](New-AzCosmosDBMongoDBUserDefinition.md) +Creates a new CosmosDB MongoDB User Definition. + +### [New-AzCosmosDBPermission](New-AzCosmosDBPermission.md) +Creates a new CosmosDB Permission object to be used to create or update a Role Definition. + +### [New-AzCosmosDBSqlCompositePath](New-AzCosmosDBSqlCompositePath.md) +Creates a new object of type PSCompositePath. It can be passed as a parameter value for Set-AzCosmosDBSqlContainer. + +### [New-AzCosmosDBSqlConflictResolutionPolicy](New-AzCosmosDBSqlConflictResolutionPolicy.md) +Creates a new object of type PSSqlConflictResolutionPolicy. It can be passed as a parameter value for Set-AzCosmosDBSqlContainer. + +### [New-AzCosmosDBSqlContainer](New-AzCosmosDBSqlContainer.md) +Creates a new CosmosDB Sql Container. + +### [New-AzCosmosDBSqlDatabase](New-AzCosmosDBSqlDatabase.md) +Creates a new CosmosDB Sql Database. + +### [New-AzCosmosDBSqlIncludedPath](New-AzCosmosDBSqlIncludedPath.md) +Creates a new object of type PSIncludedPath. It can be passed as a parameter value for Set-AzCosmosDBSqlContainer. + +### [New-AzCosmosDBSqlIncludedPathIndex](New-AzCosmosDBSqlIncludedPathIndex.md) +Creates a new object of type PSIndexes. It can be passed as a parameter value for Set-AzCosmosDBSqlIncludedPath. + +### [New-AzCosmosDBSqlIndexingPolicy](New-AzCosmosDBSqlIndexingPolicy.md) +Creates a new CosmosDB Sql IndexingPolicy object. + +### [New-AzCosmosDBSqlRoleAssignment](New-AzCosmosDBSqlRoleAssignment.md) +Creates a new CosmosDB Sql Role Assignment. + +### [New-AzCosmosDBSqlRoleDefinition](New-AzCosmosDBSqlRoleDefinition.md) +Creates a new CosmosDB Sql Role Definition. + +### [New-AzCosmosDBSqlSpatialSpec](New-AzCosmosDBSqlSpatialSpec.md) +Creates a new object of type PSSpatialSpec. It can be passed as a parameter value for Set-AzCosmosDBSqlIndexingPolicy. + +### [New-AzCosmosDBSqlStoredProcedure](New-AzCosmosDBSqlStoredProcedure.md) +Creates a new CosmosDB Sql StoredProcedure. + +### [New-AzCosmosDBSqlTrigger](New-AzCosmosDBSqlTrigger.md) +Creates a new CosmosDB Sql Trigger. + +### [New-AzCosmosDBSqlUniqueKey](New-AzCosmosDBSqlUniqueKey.md) +Creates a new CosmosDB Sql UniqueKey object. + +### [New-AzCosmosDBSqlUniqueKeyPolicy](New-AzCosmosDBSqlUniqueKeyPolicy.md) +Creates a new CosmosDB SqlUniqueKeyPolicy object. + +### [New-AzCosmosDBSqlUserDefinedFunction](New-AzCosmosDBSqlUserDefinedFunction.md) +Creates a new CosmosDB Sql UserDefinedFunction. + +### [New-AzCosmosDBTable](New-AzCosmosDBTable.md) +Creates a new CosmosDB Table. + +### [New-AzCosmosDBTableToRestore](New-AzCosmosDBTableToRestore.md) +Creates a new CosmosDB Table to Restore object(PSTableToRestore) + +### [New-AzCosmosDBVirtualNetworkRule](New-AzCosmosDBVirtualNetworkRule.md) +Create a new CosmosDB VirtualNetworkRule Object(PSVirtualNetworkRule). + +### [New-AzManagedCassandraCluster](New-AzManagedCassandraCluster.md) +Creates a new Azure Managed Instances for Apache Cassandra cluster. + +### [New-AzManagedCassandraDatacenter](New-AzManagedCassandraDatacenter.md) +Create a new Azure Managed Instances for Apache Cassandra data center. + +### [New-AzCosmosDBService](New-AzCosmosDBService.md) +Creates a new Cosmos DB Service + +### [Remove-AzCosmosDBAccount](Remove-AzCosmosDBAccount.md) +Remove a Cosmos DB Account. + +### [Remove-AzCosmosDBCassandraKeyspace](Remove-AzCosmosDBCassandraKeyspace.md) +Deletes a CosmosDB Cassandra Keyspace. + +### [Remove-AzCosmosDBCassandraTable](Remove-AzCosmosDBCassandraTable.md) +Deletes a CosmosDB Cassandra Table. + +### [Remove-AzCosmosDBGremlinDatabase](Remove-AzCosmosDBGremlinDatabase.md) +Deletes a CosmosDB Gremlin Database. + +### [Remove-AzCosmosDBGremlinGraph](Remove-AzCosmosDBGremlinGraph.md) +Deletes a CosmosDB Gremlin Graph. + +### [Remove-AzCosmosDBMongoDBCollection](Remove-AzCosmosDBMongoDBCollection.md) +Deletes a CosmosDB MongoDB Collection. + +### [Remove-AzCosmosDBMongoDBDatabase](Remove-AzCosmosDBMongoDBDatabase.md) +Deletes a CosmosDB MongoDB Database. + +### [Remove-AzCosmosDBMongoDBDatabase](Remove-AzCosmosDBMongoDBDatabase.md) +Deletes a CosmosDB MongoDB Database. + +### [Remove-AzCosmosDBMongoDBUserDefinition](Remove-AzCosmosDBMongoDBUserDefinition.md) +Deletes an existing CosmosDB MongoDB User Definition. + +### [Remove-AzCosmosDBSqlContainer](Remove-AzCosmosDBSqlContainer.md) +Deletes the CosmosDB Sql Container. + +### [Remove-AzCosmosDBSqlDatabase](Remove-AzCosmosDBSqlDatabase.md) +Deletes the CosmosDB Sql Database. + +### [Remove-AzCosmosDBSqlRoleAssignment](Remove-AzCosmosDBSqlRoleAssignment.md) +Deletes the CosmosDB Sql Role Assignment. + +### [Remove-AzCosmosDBSqlRoleDefinition](Remove-AzCosmosDBSqlRoleDefinition.md) +Deletes the CosmosDB Sql Role Definition. + +### [Remove-AzCosmosDBSqlStoredProcedure](Remove-AzCosmosDBSqlStoredProcedure.md) +Deletes the CosmosDB Sql StoredProcedure. + +### [Remove-AzCosmosDBSqlTrigger](Remove-AzCosmosDBSqlTrigger.md) +Deletes the CosmosDB Sql Trigger. + +### [Remove-AzCosmosDBSqlUserDefinedFunction](Remove-AzCosmosDBSqlUserDefinedFunction.md) +Deletes the CosmosDB Sql UserDefinedFunction. + +### [Remove-AzCosmosDBTable](Remove-AzCosmosDBTable.md) +Deletes the CosmosDB Table. + +### [Remove-AzManagedCassandraCluster](Remove-AzManagedCassandraCluster.md) +Deletes a Azure Managed Instances for Apache Cassandra cluster. + +### [Remove-AzManagedCassandraDatacenter](Remove-AzManagedCassandraDatacenter.md) +Deletes a Azure Managed Instances for Apache Cassandra data center. + +### [Remove-AzCosmosDBService](Remove-AzCosmosDBService.md) +Deletes a Cosmos DB Service + +### [Restore-AzCosmosDBAccount](Restore-AzCosmosDBAccount.md) +Restores an existing CosmosDB account (live or deleted) to a given timestamp to a new account + +### [Update-AzCosmosDBAccount](Update-AzCosmosDBAccount.md) +Update a CosmosDB account attributes. + +### [Update-AzCosmosDBAccountFailoverPriority](Update-AzCosmosDBAccountFailoverPriority.md) +Update Failover Region Priority of a Cosmos DB Account. + +### [Update-AzCosmosDBAccountRegion](Update-AzCosmosDBAccountRegion.md) +Update Regions of a Cosmos DB Account. + +### [Update-AzCosmosDBCassandraKeyspace](Update-AzCosmosDBCassandraKeyspace.md) +Updates the CosmosDB Cassandra Keyspace. Performs a client side patch operation by reading the existing Keyspace. + +### [Update-AzCosmosDBCassandraKeyspaceThroughput](Update-AzCosmosDBCassandraKeyspaceThroughput.md) +Updates the throughput value of a CosmosDB Cassandra Keyspace. + +### [Update-AzCosmosDBCassandraTable](Update-AzCosmosDBCassandraTable.md) +Updates the CosmosDB Cassandra Table. Performs a client side patch operation by reading the existing Table. + +### [Update-AzCosmosDBCassandraTableThroughput](Update-AzCosmosDBCassandraTableThroughput.md) +Updates the throughput value of a CosmosDB Cassandra Table. + +### [Update-AzCosmosDbClientEncryptionKey](Update-AzCosmosDbClientEncryptionKey.md) +Updates the CosmosDB Client Encryption Key. Performs a client side patch operation by reading the existing Client Encryption Key. + +### [Update-AzCosmosDBGremlinDatabase](Update-AzCosmosDBGremlinDatabase.md) +Updates the CosmosDB Gremlin Database. Performs a client side patch operation by reading the existing Database. + +### [Update-AzCosmosDBGremlinDatabaseThroughput](Update-AzCosmosDBGremlinDatabaseThroughput.md) +Updates the throughput value of a CosmosDB Gremlin Database. + +### [Update-AzCosmosDBGremlinGraph](Update-AzCosmosDBGremlinGraph.md) +Updates the CosmosDB Gremlin Graph. Performs a client side patch operation by reading the existing Graph. + +### [Update-AzCosmosDBGremlinGraphThroughput](Update-AzCosmosDBGremlinGraphThroughput.md) +Updates the throughput value of a CosmosDB Gremlin Graph. + +### [Update-AzCosmosDBMongoDBCollection](Update-AzCosmosDBMongoDBCollection.md) +Updates the CosmosDB MongoDB Collection. Performs a client side patch operation by reading the existing Collection. + +### [Update-AzCosmosDBMongoDBCollectionThroughput](Update-AzCosmosDBMongoDBCollectionThroughput.md) +Updates the throughput value of a CosmosDB MongoDB Collection. + +### [Update-AzCosmosDBMongoDBDatabase](Update-AzCosmosDBMongoDBDatabase.md) +Updates the CosmosDB MongoDB Database. Performs a client side patch operation by reading the existing Database. + +### [Update-AzCosmosDBMongoDBDatabaseThroughput](Update-AzCosmosDBMongoDBDatabaseThroughput.md) +Updates the throughput value of a CosmosDB MongoDB Database. + +### [New-AzCosmosDBMongoDBRoleDefinition](New-AzCosmosDBMongoDBRoleDefinition.md) +Update an existing CosmosDB MongoDB Role Definition. + +### [New-AzCosmosDBMongoDBUserDefinition](New-AzCosmosDBMongoDBUserDefinition.md) +Update an existing CosmosDB MongoDB User Definition. + +### [Update-AzCosmosDBSqlContainer](Update-AzCosmosDBSqlContainer.md) +Updates the CosmosDB Sql Container. Performs a client side patch operation by reading the existing Container. + +### [Update-AzCosmosDBSqlContainerThroughput](Update-AzCosmosDBSqlContainerThroughput.md) +Updates the throughput value of a CosmosDB Sql Container. + +### [Update-AzCosmosDBSqlDatabase](Update-AzCosmosDBSqlDatabase.md) +Updates the CosmosDB Sql Database. Performs a client side patch operation by reading the existing Database. + +### [Update-AzCosmosDBSqlDatabaseThroughput](Update-AzCosmosDBSqlDatabaseThroughput.md) +Updates the throughput value of a CosmosDB Sql Database. + +### [Update-AzCosmosDBSqlRoleAssignment](Update-AzCosmosDBSqlRoleAssignment.md) +Updates an existing CosmosDB Sql Role Assignment. + +### [Update-AzCosmosDBSqlRoleDefinition](Update-AzCosmosDBSqlRoleDefinition.md) +Updates an existing CosmosDB Sql Role Definition. + +### [Update-AzCosmosDBSqlStoredProcedure](Update-AzCosmosDBSqlStoredProcedure.md) +Updates the CosmosDB Sql StoredProcedure. Performs a client side patch operation by reading the existing StoredProcedure. + +### [Update-AzCosmosDBSqlTrigger](Update-AzCosmosDBSqlTrigger.md) +Updates the CosmosDB Sql Trigger. Performs a client side patch operation by reading the existing Trigger. + +### [Update-AzCosmosDBSqlUserDefinedFunction](Update-AzCosmosDBSqlUserDefinedFunction.md) +Updates the CosmosDB Sql UserDefinedFunction. Performs a client side patch operation by reading the existing UserDefinedFunction. + +### [Update-AzCosmosDBTable](Update-AzCosmosDBTable.md) +Updates the CosmosDB Table. Performs a client side patch operation by reading the existing Table. + +### [Update-AzCosmosDBTableThroughput](Update-AzCosmosDBTableThroughput.md) +Updates the throughput value of a CosmosDB Table. + +### [Update-AzManagedCassandraCluster](Update-AzManagedCassandraCluster.md) +Update an existing Azure Managed Instances for Apache Cassandra cluster. + +### [Update-AzManagedCassandraDatacenter](Update-AzManagedCassandraDatacenter.md) +Update an existing Azure Managed Instances for Apache Cassandra data center. + diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBAccount.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBAccount.md new file mode 100644 index 0000000000..a3bdda7321 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBAccount.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBAccount.md +--- + +# Get-AzCosmosDBAccount + +## SYNOPSIS +Get CosmosDB Account. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBAccount -ResourceGroupName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzCosmosDBAccount -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBAccount** cmdlet gets the list of all existing CosmosDB accounts for a given ResourceGroupName and gets a single CosmosDB account for a given ResourceGroupName and AccountName. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBAccount -ResourceGroupName "resourceGroupName" -Name "databaseAccountName" +``` + +```output +Id : /subscriptions/{subscriptionid}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{databaseAccountName} +Name : {databaseAccountName} +FailoverPolicies : {databaseAccountName-region1} +ReadLocations : {databaseAccountName-region1} +WriteLocations : {databaseAccountName-region1} +Capabilities : {} +ConsistencyPolicy : Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy +EnableAutomaticFailover : False +IsVirtualNetworkFilterEnabled : False +IpRangeFilter : +DatabaseAccountOfferType : Standard +DocumentEndpoint : https://databaseAccountName.documents.azure.com:443/ +ProvisioningState : Succeeded +Kind : GlobalDocumentDB +VirtualNetworkRules : {} +EnableMultipleWriteLocations : False +NetworkAclBypass : None +NetworkAclBypassResourceIds : {} +``` + +Get CosmosDB database account with name databaseAccountName in ResourceGroup resourceGroupName. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBAccountKey.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBAccountKey.md new file mode 100644 index 0000000000..44cb6909c8 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBAccountKey.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBAccountKey.md +--- + +# Get-AzCosmosDBAccountKey + +## SYNOPSIS +Get Keys{"ConnectionKeys", "PrimaryReadOnly" or "Keys"} for the given CosmosDB Account. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBAccountKey -ResourceGroupName <String> -Name <String> [-Type <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzCosmosDBAccountKey [-Type <String>] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Get-AzCosmosDBAccountKey [-Type <String>] -InputObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the list of connection keys. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBAccountKey -ResourceGroupName rg1 -Name dbname -Type "ReadOnlyKeys" +``` + +```output +Name Value +---- ----- +PrimaryReadonlyMasterKey qjw0ISW1WNN0BIVPeaI7Tm3H8uZ1h7ESQjxaUendxHmIUNQowVvcL84fTqeXoC2HFgyu8Zo1mCFEcg0jZJHPjA== +SecondaryReadonlyMasterKey 9YRcTABuOHcKyHAKf0lmCeHsrcXu02aeID1g3wjXjlX8SU4s2WNlEB5htJoy3xqxNDqIyGfnq3dblLbrZDbesg== +``` + +Lists the keys for CosmosDB Account. The Key Type can be value from : ConnectionStrings, Keys and ReadOnlyKeys. Default is Keys. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Value from: {ConnectionStrings, Keys, ReadOnlyKeys}. +Default is Keys. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountListConnectionStrings + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountListKeysResult + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountListReadOnlyKeysResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBCassandraKeyspace.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBCassandraKeyspace.md new file mode 100644 index 0000000000..ba5f4000d7 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBCassandraKeyspace.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbcassandrakeyspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBCassandraKeyspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBCassandraKeyspace.md +--- + +# Get-AzCosmosDBCassandraKeyspace + +## SYNOPSIS +Gets a CosmosDB Cassandra Keyspace. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBCassandraKeyspace -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBCassandraKeyspace [-Name <String>] -ParentObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBCassandraKeyspace** cmdlet creates a new or updates an existing CosmosDB Cassandra Keyspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBCassandraKeyspace -ResourceGroupName "resourceGroupName" -AccountName "accountName" -Name "name" +``` + +```output +Name Id Resource +{name} {id} {resourceObject} +``` + +Get-AzCosmosDBCassandraKeyspace gets the properties of an existing CassandraKeyspace. You can expand the Resource to get the _etag, _ts, _rid properties. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cassandra Keyspace Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBCassandraKeyspaceThroughput.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBCassandraKeyspaceThroughput.md new file mode 100644 index 0000000000..51a2308ade --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBCassandraKeyspaceThroughput.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbcassandrakeyspacethroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBCassandraKeyspaceThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBCassandraKeyspaceThroughput.md +--- + +# Get-AzCosmosDBCassandraKeyspaceThroughput + +## SYNOPSIS +Gets the throughput value of the Cassandra Keyspace. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBCassandraKeyspaceThroughput -ResourceGroupName <String> -AccountName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBCassandraKeyspaceThroughput -Name <String> -InputObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBCassandraKeyspaceThroughput** cmdlet gets the throughput object corresponding to a given Keyspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBCassandraKeyspaceThroughput -ResourceGroupName "resourceGroupName" -AccountName "accountName" -Name "name" +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Cassandra Keyspace Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBCassandraTable.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBCassandraTable.md new file mode 100644 index 0000000000..015d652f88 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBCassandraTable.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbcassandratable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBCassandraTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBCassandraTable.md +--- + +# Get-AzCosmosDBCassandraTable + +## SYNOPSIS +Gets a CosmosDB Cassandra Table. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBCassandraTable -AccountName <String> -KeyspaceName <String> -ResourceGroupName <String> + [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBCassandraTable [-Name <String>] -ParentObject <PSCassandraKeyspaceGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBCassandraTable** cmdlet creates a new or updates an existing CosmosDB Cassandra Keyspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBCassandraTable -ResourceGroupName "resourceGroupName" -AccountName "accountName" -KeyspaceName "keyspaceName" -Name "tableName" +``` + +```output +Name Id Resource +{name} {id} {resourceObject} +``` + +{{ Get-AzCosmosDBCassandraTable gets the properties of an existing CassandraKeyspace. You can expand the Resource to get the DefaultTtl, Schema, _etag, _ts, _rid properties.}} + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyspaceName +Cassandra Keyspace Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cassandra Table Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Cassandra Keyspace object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraTableGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBCassandraTableThroughput.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBCassandraTableThroughput.md new file mode 100644 index 0000000000..5b07dbb96f --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBCassandraTableThroughput.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbcassandratablethroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBCassandraTableThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBCassandraTableThroughput.md +--- + +# Get-AzCosmosDBCassandraTableThroughput + +## SYNOPSIS +Gets the throughput value of the Cassandra Table. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBCassandraTableThroughput -ResourceGroupName <String> -AccountName <String> -KeyspaceName <String> + -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBCassandraTableThroughput -InputObject <PSCassandraKeyspaceGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBCassandraTableThroughput** cmdlet gets the throughput object corresponding to a given Keyspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBCassandraTableThroughput -ResourceGroupName "resourceGroupName" -AccountName "accountName" -KeyspaceName "keyspaceName" -Name "tableName" +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Cassandra Table object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyspaceName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cassandra Table Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinDatabase.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinDatabase.md new file mode 100644 index 0000000000..d7c5f9b5bc --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinDatabase.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbgremlindatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinDatabase.md +--- + +# Get-AzCosmosDBGremlinDatabase + +## SYNOPSIS +Gets the CosmosDB Gremlin Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBGremlinDatabase -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBGremlinDatabase [-Name <String>] -ParentObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBGremlinDatabase** cmdlet gets the CosmosDB Gremlin Database. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBGremlinDatabase -ResourceGroupName "rgName" -AccountName "accountName" -Name "databaseName" +``` + +```output +Name Id Resource +{name} {id} Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetPropertiesResource +``` + +Resource Object contains _rid, _ts, _etag. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinDatabaseThroughput.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinDatabaseThroughput.md new file mode 100644 index 0000000000..cd3c859243 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinDatabaseThroughput.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbgremlindatabasethroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinDatabaseThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinDatabaseThroughput.md +--- + +# Get-AzCosmosDBGremlinDatabaseThroughput + +## SYNOPSIS +Gets the throughput of a CosmosDB Gremlin Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBGremlinDatabaseThroughput -ResourceGroupName <String> -AccountName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBGremlinDatabaseThroughput -Name <String> -InputObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBGremlinDatabaseThroughput** cmdlet gets the throughput of a CosmosDB Gremlin Database. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBGremlinDatabaseThroughput -ResourceGroupName "rgName" -AccountName "accountName" -Name "databaseName" +``` + +```output +Name: {throughputName} +Id: {Id} +Throughput: {value} +MinimumThroughput: {value} +OfferReplacePending: {value} +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinGraph.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinGraph.md new file mode 100644 index 0000000000..937b94098b --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinGraph.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbgremlingraph +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinGraph.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinGraph.md +--- + +# Get-AzCosmosDBGremlinGraph + +## SYNOPSIS +Gets the CosmosDB Gremlin Graph. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBGremlinGraph -ResourceGroupName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] -AccountName <String> -DatabaseName <String> [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBGremlinGraph [-Name <String>] -ParentObject <PSGremlinDatabaseGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBGremlinGraph** cmdlet gets the CosmosDB Gremlin Graph properties. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBGremlinGraph -ResourceGroupName "rgName" -AccountName "accountName" -DatabaseName "dbName" -Name "graphName" +``` + +```output +Name Id Resource +{name} {id} Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetPropertiesResource +``` + +Resource Object contains IndexingPolicy, PartitionKey, DefaultTtl, UniqueKeyPolicy, ConflictResolutionPolicy, _rid, _ts, _etag. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gremlin Graph Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Gremlin Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinGraphBackupInformation.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinGraphBackupInformation.md new file mode 100644 index 0000000000..1a6c7b2161 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinGraphBackupInformation.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbgremlingraphbackupinformation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinGraphBackupInformation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinGraphBackupInformation.md +--- + +# Get-AzCosmosDBGremlinGraphBackupInformation + +## SYNOPSIS +Retrieves the latest restorable timestamp for a gremlin graph. + +## SYNTAX + +``` +Get-AzCosmosDBGremlinGraphBackupInformation -ResourceGroupName <String> -AccountName <String> + -DatabaseName <String> -Name <String> -Location <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the latest restorable timestamp for a gremlin graph. This is the latest timestamp upto which user can successfully restore this gremlin graph. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBGremlinGraphBackupInformation -ResourceGroupName CosmosDBResourceGroup3668 -AccountName pitr-gremlin-stage-source -DatabaseName TestDB1 -Name TestGraphInDB1 -Location "EAST US 2" +``` + +```output +LatestRestorableTimestamp +------------------------- +1623042210 +``` + +Retrieves the latest restorable timestamp for a gremlin graph. This is the latest timestamp upto which user can successfully restore this gremlin graph. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Gremlin Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gremlin Graph Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.Restore.PSGraphBackupInformation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinGraphThroughput.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinGraphThroughput.md new file mode 100644 index 0000000000..233ed7ad6b --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinGraphThroughput.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbgremlingraphthroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinGraphThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinGraphThroughput.md +--- + +# Get-AzCosmosDBGremlinGraphThroughput + +## SYNOPSIS +Gets the throughput of a CosmosDB Gremlin Graph. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBGremlinGraphThroughput -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBGremlinGraphThroughput [-Name <String>] -InputObject <PSGremlinGraphGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBGremlinGraphThroughput** cmdlet gets the throughput of a CosmosDB Gremlin Graph. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBGremlinGraphThroughput -ResourceGroupName "rgName" -AccountName "accountName" -DatabaseName "dbName" -Name "graphName" +``` + +```output +Name: {throughputName} +Id: {Id} +Throughput: {value} +MinimumThroughput: {value} +OfferReplacePending: {value} +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gremlin Graph object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Gremlin Graph Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinRestorableDatabase.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinRestorableDatabase.md new file mode 100644 index 0000000000..69406faf62 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinRestorableDatabase.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbgremlinrestorabledatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinRestorableDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinRestorableDatabase.md +--- + +# Get-AzCosmosDBGremlinRestorableDatabase + +## SYNOPSIS +Gets the list of all the restorable Azure Cosmos DB Gremlin databases available under the restorable account. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBGremlinRestorableDatabase -Location <String> -DatabaseAccountInstanceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBGremlinRestorableDatabase -InputObject <PSRestorableDatabaseAccountGetResult> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the list of all the restorable Azure Cosmos DB Gremlin database events available under the restorable account. +The list would have entries corresponding to create, replace and delete events of all live and deleted databases. +This list is useful to identify the restore timestamp based on the changes in the database. +For example, if user wants to restore the database account to a timestamp when a database named foo is deleted, the user can find corresponding database delete event from this list, and choose a timestamp before the delete event for restore. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBGremlinRestorableDatabase -Location "location" -DatabaseAccountInstanceId "DatabaseAccountInstanceIdInstanceId" +``` + +```output +Name : cb04fbfc-4142-413d-b2c5-c91723a17e28 +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{DatabaseAccountInstanceIdInstanceId}/restorableGremlinDatabases/cb04fbfc-4142-413d-b2c5-c91723 + a17e28 +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinDatabases +_rid : a+35ZwAAAA== +OperationType : Create +EventTimestamp : 01/20/2021 18:42:37 +OwnerId : foo-db1 +OwnerResourceId : Ts0YAA== +``` + +The resource object contains the properties of the database resource + +## PARAMETERS + +### -DatabaseAccountInstanceId +The instance Id of the CosmosDB database account. +(This is returned as a part of database account properties). + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Restorable Database Account object + +```yaml +Type: Microsoft.Azure.Management.CosmosDB.Models.PSRestorableDatabaseAccountGetResult +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.CosmosDB.Models.PSRestorableDatabaseAccountGetResult + +## OUTPUTS + +### Microsoft.Azure.Management.CosmosDB.Models.PSRestorableGremlinDatabaseGetResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinRestorableGraph.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinRestorableGraph.md new file mode 100644 index 0000000000..9fd5c334fb --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinRestorableGraph.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbgremlinrestorablegraph +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinRestorableGraph.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinRestorableGraph.md +--- + +# Get-AzCosmosDBGremlinRestorableGraph + +## SYNOPSIS +Lists all the restorable Azure Cosmos DB Gremlin graphs available for a specific database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBGremlinRestorableGraph -Location <String> -DatabaseAccountInstanceId <String> + -DatabaseRId <String> [-StartTime <String>] [-EndTime <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBGremlinRestorableGraph -InputObject <PSRestorableGremlinDatabaseGetResult> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all the restorable Azure Cosmos DB Gremlin graphs available for a specific database. +The list would have entries corresponding to create, replace and delete events of all live and deleted graphs under a specific database. +This list is useful to identify the restore timestamp based on the changes in the graph. +For example, if user wants to restore the database account to a timestamp when a specific graph is deleted, the user can find corresponding graph delete event from this list, and choose a timestamp before the delete event for restore. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBGremlinRestorableGraph -Location "locationName" -DatabaseAccountInstanceId "DatabaseAccountInstanceIdInstanceId" -DatabaseRId "DatabaseRId" +``` + +```output +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{locationName}/restorableDatabaseAccounts + /{DatabaseAccountInstanceIdInstanceId}/restorableGremlinGraphs/6a0cb3e4-7d2b-4363-b585-04a3b14ada8c +Name : 6a0cb3e4-7d2b-4363-b585-04a3b14ada8c +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinGraphs +_rid : qsLuzwAAAA== +OperationType : Create +EventTimestamp : 01/20/2021 18:44:07 +OwnerId : foo-graph1 +OwnerResourceId : Ts0YAPGKTvw= + +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{locationName}/restorableDatabaseAccounts + /{DatabaseAccountInstanceIdInstanceId}/restorableGremlinGraphs/ff36d1d3-f9dc-40a0-a003-60fe349abcfb +Name : ff36d1d3-f9dc-40a0-a003-60fe349abcfb +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinGraphs +_rid : Ngu72QAAAA== +OperationType : Replace +EventTimestamp : 01/20/2021 18:44:07 +OwnerId : foo-graph1 +OwnerResourceId : Ts0YAP+RbG0= + +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{locationName}/restorableDatabaseAccounts + /{DatabaseAccountInstanceIdInstanceId}/restorableGremlinGraphs/2afb35ba-1755-4fbc-85be-ae175dd0668f +Name : 2afb35ba-1755-4fbc-85be-ae175dd0668f +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinGraphs +_rid : lSuf5gAAAA== +OperationType : Create +EventTimestamp : 01/20/2021 18:42:43 +OwnerId : foo-graph2 +OwnerResourceId : Ts0YAP+RbG0= +``` + +The resource object contains the properties of the collection resource + +## PARAMETERS + +### -DatabaseAccountInstanceId +The instance Id of the CosmosDB database account. +(This is returned as a part of database account properties). + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseRId +ResourceId of the database. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +Restorable Gremlin graphs event feed end time. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Restorable Gremlin Database object. + +```yaml +Type: Microsoft.Azure.Management.CosmosDB.Models.PSRestorableGremlinDatabaseGetResult +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Restorable Gremlin graphs event feed start time. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.CosmosDB.Models.PSRestorableGremlinDatabaseGetResult + +## OUTPUTS + +### Microsoft.Azure.Management.CosmosDB.Models.PSRestorableGremlinGraphGetResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinRestorableResource.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinRestorableResource.md new file mode 100644 index 0000000000..ad7235becc --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBGremlinRestorableResource.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbgremlinrestorableresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinRestorableResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinRestorableResource.md +--- + +# Get-AzCosmosDBGremlinRestorableResource + +## SYNOPSIS +Lists all the restorable Azure Cosmos DB Gremlin resources available for a specific database account at a given time and location. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBGremlinRestorableResource -Location <String> -DatabaseAccountInstanceId <String> + -RestoreTimestampInUtc <DateTime> -RestoreLocation <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBGremlinRestorableResource -Location <String> -DatabaseAccountInstanceId <String> + -RestoreTimestampInUtc <DateTime> -RestoreLocation <String> + -InputObject <PSRestorableDatabaseAccountGetResult> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Lists all the restorable Azure Cosmos DB Gremlin resources available for a specific database account at a given time and location. +The list is useful to know what resources exist in the source account at the given time. This will provide the user an indication of what to expect if the account is restored to the given time. +The user can also use this list and provide a subset of restorable resources if the user wants to restore only specific databases/graphs. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBGremlinRestorableResource -Location "location" -DatabaseAccountInstanceId "DatabaseInstanceId" -RestoreLocation "RestoreLocation" -RestoreTimestampInUtc $RestoreTimestamp +``` + +```output +DatabaseName GraphNames +------------ --------------- +{DBName} {Graph names} +``` + +Returns the list of all restorable Azure Cosmos DB Gremlin resources available for a specific database account at a given time and location. + +## PARAMETERS + +### -DatabaseAccountInstanceId +The instance Id of the CosmosDB database account. +(This is returned as a part of database account properties). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Restorable Database Account object + +```yaml +Type: Microsoft.Azure.Management.CosmosDB.Models.PSRestorableDatabaseAccountGetResult +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreLocation +The location of the source account from which restore is triggered. +This will also be the write region of the restored account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreTimestampInUtc +The timestamp to which the source account has to be restored to. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.CosmosDB.Models.PSRestorableDatabaseAccountGetResult + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseToRestore + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBLocation.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBLocation.md new file mode 100644 index 0000000000..cd13050d0b --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBLocation.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdblocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBLocation.md +--- + +# Get-AzCosmosDBLocation + +## SYNOPSIS +List Azure Cosmos DB locations and their properties. +Get Azure Cosmos DB location properties for a specific location. + +## SYNTAX + +``` +Get-AzCosmosDBLocation [-Location <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +List Azure Cosmos DB locations with their location properties. It includes Location Id, Name, Type, SupportsAvailabilityZone, IsResidencyRestricted, BackupStorageRedundancies, IsSubscriptionRegionAccessAllowedForRegular, IsSubscriptionRegionAccessAllowedForAz and Status. + +## EXAMPLES + +### Example 1: Get Azure Cosmos DB Account Location Properties for Given Location +<!-- Skip: Output cannot be splitted from code --> +```powershell +Get-AzCosmosDBLocation -Location "Central US" + +Id Name Type Properties +-- ---- ---- ---------- +subscriptionId/subscriptionId/providers/Microsoft.DocumentDB/locations/centralus/ Central US Microsoft.DocumentDB/locations Microsoft.Azure.Commands.CosmosDB.Models.PSLocationP... + + +Get-AzCosmosDBLocation -Location "Central US" | ConvertTo-Json +{ + "Id": "subscriptionId/<subscriptionId>/providers/Microsoft.DocumentDB/locations/centralus/", + "Name": "Central US", + "Type": "Microsoft.DocumentDB/locations", + "Properties": { + "SupportsAvailabilityZone": true, + "IsResidencyRestricted": false, + "BackupStorageRedundancies": [ + "Geo", + "Zone", + "Local" + ], + "IsSubscriptionRegionAccessAllowedForRegular": true, + "IsSubscriptionRegionAccessAllowedForAz": false, + "Status": "Online" + } +} +``` + +### Example 2: List Azure Cosmos DB Account Locations and their properties +<!-- Skip: Output cannot be splitted from code --> +```powershell +Get-AzCosmosDBLocation + +Id Name Type Properties +-- ---- ---- ---------- +subscriptionId/<subscriptionId>/providers/Microsoft.DocumentDB/locations/brazilsoutheast/ Brazil Southeast Microsoft.DocumentDB/locations Microsoft.Azure.Commands.CosmosDB... +subscriptionId/<subscriptionId>/providers/Microsoft.DocumentDB/locations/centralus/ Central US Microsoft.DocumentDB/locations Microsoft.Azure.Commands.CosmosDB... +.... + + +Get-AzCosmosDBLocation | ConvertTo-Json +[ + { + "Id": "subscriptionId/<subscriptionId>/providers/Microsoft.DocumentDB/locations/brazilsoutheast/", + "Name": "Brazil Southeast", + "Type": "Microsoft.DocumentDB/locations", + "Properties": { + "SupportsAvailabilityZone": true, + "IsResidencyRestricted": false, + "BackupStorageRedundancies": "Geo Local", + "IsSubscriptionRegionAccessAllowedForRegular": true, + "IsSubscriptionRegionAccessAllowedForAz": false, + "Status": "Online" + } + }, + { + "Id": "subscriptionId/<subscriptionId>/providers/Microsoft.DocumentDB/locations/centralus/", + "Name": "Central US", + "Type": "Microsoft.DocumentDB/locations", + "Properties": { + "SupportsAvailabilityZone": true, + "IsResidencyRestricted": false, + "BackupStorageRedundancies": "Geo Zone Local", + "IsSubscriptionRegionAccessAllowedForRegular": false, + "IsSubscriptionRegionAccessAllowedForAz": true, + "Status": "Online" + } + }, + { + "Id": "subscriptionId/<subscriptionId>/providers/Microsoft.DocumentDB/locations/australiasoutheast/", + "Name": "Australia Southeast", + "Type": "Microsoft.DocumentDB/locations", + "Properties": { + "SupportsAvailabilityZone": false, + "IsResidencyRestricted": false, + "BackupStorageRedundancies": "Geo Local", + "IsSubscriptionRegionAccessAllowedForRegular": true, + "IsSubscriptionRegionAccessAllowedForAz": true, + "Status": "Online" + } + } +] +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +-Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSLocationGetResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBCollection.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBCollection.md new file mode 100644 index 0000000000..35b7eb6bc8 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBCollection.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBCollection.md +--- + +# Get-AzCosmosDBMongoDBCollection + +## SYNOPSIS +Gets the CosmosDB MongoDB Collection. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBMongoDBCollection -ResourceGroupName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] -AccountName <String> -DatabaseName <String> [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBMongoDBCollection [-Name <String>] -ParentObject <PSMongoDBDatabaseGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBMongoDBCollection** cmdlet gets the CosmosDB MongoDB Collection. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBMongoDBCollection -ResourceGroupName rgName -AccountName accountName -DatabaseName dbName -Name collectionName +``` + +```output +Name : collectionName +Id : /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbDatabases/dbName/collections/collectionName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetPropertiesResource +``` + +Resource Object contains AnalyticalStorageTtl, Id, Indexes, ShardKey, _etag, _rid, _ts properties. + +### Example 2 +```powershell +(Get-AzCosmosDBMongoDBCollection -ResourceGroupName rgName -AccountName accountName -DatabaseName dbName -Name collectionName).Resource.ShardKey +``` + +```output +Key Value +---- ----- +<ShardKey> <Value> +``` + +This example gets the ShardKey of the retrieved collection + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Collection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Mongo Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBCollectionBackupInformation.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBCollectionBackupInformation.md new file mode 100644 index 0000000000..0695b474d8 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBCollectionBackupInformation.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbcollectionbackupinformation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBCollectionBackupInformation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBCollectionBackupInformation.md +--- + +# Get-AzCosmosDBMongoDBCollectionBackupInformation + +## SYNOPSIS +Retrieves the latest restorable timestamp for a mongodb collection. + +## SYNTAX + +``` +Get-AzCosmosDBMongoDBCollectionBackupInformation -ResourceGroupName <String> -AccountName <String> + -DatabaseName <String> -Name <String> -Location <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the latest restorable timestamp for a mongodb collection. This is the latest timestamp upto which user can successfully restore this collection. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBMongoDBCollectionBackupInformation -ResourceGroupName CosmosDBResourceGroup3668 -AccountName pitr-sql-stage-source -DatabaseName TestDB1 -Name TestCollectionInDB1 -Location "EAST US 2" +``` + +```output +LatestRestorableTimestamp +------------------------- +1623042210 +``` + +Retrieves the latest restorable timestamp for a mongodb collection. This is the latest timestamp upto which user can successfully restore this collection. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +-Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Collection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.Restore.MongoDB.PSMongoDBBackupInformation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBCollectionThroughput.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBCollectionThroughput.md new file mode 100644 index 0000000000..173589336f --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBCollectionThroughput.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbcollectionthroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBCollectionThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBCollectionThroughput.md +--- + +# Get-AzCosmosDBMongoDBCollectionThroughput + +## SYNOPSIS +Gets the CosmosDB throughput properties of MongoDB Collection. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBMongoDBCollectionThroughput -ResourceGroupName <String> -AccountName <String> + -DatabaseName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBMongoDBCollectionThroughput [-Name <String>] -InputObject <PSMongoDBCollectionGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBMongoDBCollectionThroughput** cmdlet gets the throughput properties of MongoDB Collection. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBMongoDBCollectionThroughput -ResourceGroupName "rgName" -AccountName "accountName" -DatabaseName "databaseName" -Name "collectionName" +``` + +```output +Name: {throughputName} +Id: {Id} +Throughput: {value} +MinimumThroughput: {value} +OfferReplacePending: {value} +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +If provided then, the cmdlet returns the collection with the corresponding throughput value. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Collection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBDatabase.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBDatabase.md new file mode 100644 index 0000000000..fa35099d4c --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBDatabase.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBDatabase.md +--- + +# Get-AzCosmosDBMongoDBDatabase + +## SYNOPSIS +Gets the CosmosDB MongoDB Database + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBMongoDBDatabase -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Get-AzCosmosDBMongoDBDatabase [-Name <String>] -ParentObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBMongoDBDatabase** cmdlet gets the CosmosDB MongoDB Database. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBMongoDBDatabase -ResourceGroupName "rgName" -AccountName "accountName" -Name "dbName" +``` + +```output +Name Id Resource +{name} {id} Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetPropertiesResource +``` + +Resource Object contains _rid, _ts, _etag properties. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBDatabaseThroughput.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBDatabaseThroughput.md new file mode 100644 index 0000000000..81fcdebede --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBDatabaseThroughput.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbdatabasethroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBDatabaseThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBDatabaseThroughput.md +--- + +# Get-AzCosmosDBMongoDBDatabaseThroughput + +## SYNOPSIS +Gets the CosmosDB throughput properties of MongoDB Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBMongoDBDatabaseThroughput -ResourceGroupName <String> -AccountName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBMongoDBDatabaseThroughput -Name <String> -InputObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBMongoDBDatabaseThroughput** cmdlet gets the throughput properties of MongoDB Database. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBMongoDBDatabaseThroughput -ResourceGroupName "rgName" -AccountName "accountName" -Name "databaseName" +``` + +```output +Name: {throughputName} +Id: {Id} +Throughput: {value} +MinimumThroughput: {value} +OfferReplacePending: {value} +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBRestorableCollection.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBRestorableCollection.md new file mode 100644 index 0000000000..8af5966bfd --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBRestorableCollection.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbrestorablecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBRestorableCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBRestorableCollection.md +--- + +# Get-AzCosmosDBMongoDBRestorableCollection + +## SYNOPSIS +Lists all the restorable Azure Cosmos DB MongoDB collection available for a specific database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBMongoDBRestorableCollection -Location <String> -DatabaseAccountInstanceId <String> + -DatabaseRId <String> [-StartTime <String>] [-EndTime <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBMongoDBRestorableCollection -InputObject <PSRestorableSqlDatabaseGetResult> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all the restorable Azure Cosmos DB MongoDB collection available for a specific database. +The list would have entries corresponding to create, replace and delete events of all live and deleted collections under a specific database. +This list is useful to identify the restore timestamp based on the changes in the collection. +For example, if user wants to restore the database account to a timestamp when a specific collection is deleted, the user can find corresponding collection delete event from this list, and choose a timestamp before the delete event for restore. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBMongoDBRestorableCollection -Location "location" -DatabaseAccountInstanceId "DatabaseAccountInstanceId" -DatabaseRId "DatabaseRId" +``` + +```output +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts + /{DatabaseAccountInstanceId}/restorableMongoDBCollections/6a0cb3e4-7d2b-4363-b585-04a3b14ada8c +Name : 6a0cb3e4-7d2b-4363-b585-04a3b14ada8c +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongoDBCollections +_rid : qsLuzwAAAA== +OperationType : Create +EventTimestamp : 01/20/2021 18:44:07 +OwnerId : foo-collection2 +OwnerResourceId : Ts0YAPGKTvw= + +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts + /{DatabaseAccountInstanceId}/restorableMongoDBCollections/ff36d1d3-f9dc-40a0-a003-60fe349abcfb +Name : ff36d1d3-f9dc-40a0-a003-60fe349abcfb +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongoDBCollections +_rid : Ngu72QAAAA== +OperationType : Replace +EventTimestamp : 01/20/2021 18:44:07 +OwnerId : foo-collection1 +OwnerResourceId : Ts0YAP+RbG0= + +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts + /{DatabaseAccountInstanceId}/restorableMongoDBCollections/2afb35ba-1755-4fbc-85be-ae175dd0668f +Name : 2afb35ba-1755-4fbc-85be-ae175dd0668f +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongoDBCollections +_rid : lSuf5gAAAA== +OperationType : Create +EventTimestamp : 01/20/2021 18:42:43 +OwnerId : foo-collection1 +OwnerResourceId : Ts0YAP+RbG0= +``` + +The resource object contains the properties of the collection resource + +## PARAMETERS + +### -DatabaseAccountInstanceId +The instance Id of the CosmosDB database account. +(This is returned as a part of database account properties). + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseRId +ResourceId of the database. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +Restorable MongoDB collections event feed end time. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Restorable MongoDB Database object + +```yaml +Type: Microsoft.Azure.Management.CosmosDB.Models.PSRestorableSqlDatabaseGetResult +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Restorable MongoDB collections event feed start time. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.CosmosDB.Models.PSRestorableMongodbCollectionGetResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBRestorableDatabase.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBRestorableDatabase.md new file mode 100644 index 0000000000..9282184bdb --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBRestorableDatabase.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbrestorabledatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBRestorableDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBRestorableDatabase.md +--- + +# Get-AzCosmosDBMongoDBRestorableDatabase + +## SYNOPSIS +Gets the list of all the restorable Azure Cosmos DB MongoDB databases available under the restorable account. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBMongoDBRestorableDatabase -Location <String> -DatabaseAccountInstanceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBMongoDBRestorableDatabase -InputObject <PSRestorableDatabaseAccountGetResult> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the list of all the restorable Azure Cosmos DB MongoDB database events available under the restorable account. +The list would have entries corresponding to create, replace and delete events of all live and deleted databases. +This list is useful to identify the restore timestamp based on the changes in the database. +For example, if user wants to restore the database account to a timestamp when a database named foo is deleted, the user can find corresponding database delete event from this list, and choose a timestamp before the delete event for restore. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBMongoDBRestorableDatabase -Location "location" -DatabaseAccountInstanceId "DatabaseAccountInstanceId" +``` + +```output +Name : cb04fbfc-4142-413d-b2c5-c91723a17e28 +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{DatabaseAccountInstanceId}/restorableMongoDBDatabases/cb04fbfc-4142-413d-b2c5-c91723 + a17e28 +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongoDBDatabases +_rid : a+35ZwAAAA== +OperationType : Create +EventTimestamp : 01/20/2021 18:42:37 +OwnerId : foo-db1 +OwnerResourceId : Ts0YAA== +``` + +The resource object contains the properties of the database resource + +## PARAMETERS + +### -DatabaseAccountInstanceId +The instance Id of the CosmosDB database account. +(This is returned as a part of database account properties). + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Restorable Database Account object + +```yaml +Type: Microsoft.Azure.Management.CosmosDB.Models.PSRestorableDatabaseAccountGetResult +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.CosmosDB.Models.PSRestorableMongodbDatabaseGetResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBRestorableResource.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBRestorableResource.md new file mode 100644 index 0000000000..32070ee010 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBRestorableResource.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbrestorableresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBRestorableResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBRestorableResource.md +--- + +# Get-AzCosmosDBMongoDBRestorableResource + +## SYNOPSIS +Lists all the restorable Azure Cosmos DB MongoDB resources available for a specific database account at a given time and location. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBMongoDBRestorableResource -Location <String> -DatabaseAccountInstanceId <String> + -RestoreTimestampInUtc <DateTimeOffset> -RestoreLocation <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBMongoDBRestorableResource -Location <String> -DatabaseAccountInstanceId <String> + -RestoreTimestampInUtc <DateTimeOffset> -RestoreLocation <String> + -InputObject <PSRestorableDatabaseAccountGetResult> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Lists all the restorable Azure Cosmos DB MongoDB resources available for a specific database account at a given time and location. +The list is useful to know what resources exist in the source account at the given time. This will provide the user an indication of what to expect if the account is restored to the given time. +The user can also use this list and provide a subset of restorable resources if the user wants to restore only specific databases/collections. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBMongoDBRestorableResource -Location "location" -DatabaseAccountInstanceId "DatabaseInstanceId" -RestoreLocation "Database" -RestoreTimestampInUtc $RestoreTimestamp +``` + +```output +DatabaseName CollectionNames +------------ --------------- +{DBName} {Collection names} +``` + +Returns the list of all restorable Azure Cosmos DB MongoDB resources available for a specific database account at a given time and location. + +## PARAMETERS + +### -DatabaseAccountInstanceId +The instance Id of the CosmosDB database account. +(This is returned as a part of database account properties). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Restorable Database Account object + +```yaml +Type: Microsoft.Azure.Management.CosmosDB.Models.PSRestorableDatabaseAccountGetResult +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreLocation +The location of the source account from which restore is triggered. +This will also be the write region of the restored account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreTimestampInUtc +The timestamp to which the source account has to be restored to. + +```yaml +Type: System.DateTimeOffset +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseToRestore + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBRoleDefinition.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBRoleDefinition.md new file mode 100644 index 0000000000..1afd258358 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBRoleDefinition.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBRoleDefinition.md +--- + +# Get-AzCosmosDBMongoDBRoleDefinition + +## SYNOPSIS +Gets the CosmosDB MongoDB Role Definition for the specified resource group and account. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBMongoDBRoleDefinition -ResourceGroupName <String> -AccountName <String> [-Id <String>] + [-DatabaseName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBMongoDBRoleDefinition [-Id <String>] [-DatabaseName <String>] + -DatabaseAccountObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzCosmosDBMongoDBRoleDefinition cmdlet gets the list of all existing CosmosDB MongoDB API Role Definitions for a given ResourceGroupName, AccountName and gets a single CosmosDB Mongo API Database for a given ResourceGroupName, AccountName, and Id. +Id can be either fully qualified or just the id string. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBMongoDBRoleDefinition -AccountName accountName -ResourceGroupName resourceGroupName -Id id +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbRoleDefinitions/id +RoleName : test_mongo_role +Type : CustomRole +DatabaseName : test +Privileges : {Microsoft.Azure.Management.CosmosDB.Models.Privilege} +Roles : {Microsoft.Azure.Management.CosmosDB.Models.Role, Microsoft.Azure.Management.CosmosDB.Models.Role} +``` + +Get Mongo Role Definition for the given Resource Group and Account Role Id. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseAccountObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DatabaseName +Database Name for the MongoDB Role Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role Definition Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBRoleDefinitionGetResults +## NOTES + +## RELATED LINKS + +[New-AzCosmosDBMongoDBRoleDefinition](./New-AzCosmosDBMongoDBRoleDefinition.md) + +[Update-AzCosmosDBMongoDBRoleDefinition](./Update-AzCosmosDBMongoDBRoleDefinition.md) + +[Remove-AzCosmosDBMongoDBRoleDefinition](./Remove-AzCosmosDBMongoDBRoleDefinition.md) diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBUserDefinition.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBUserDefinition.md new file mode 100644 index 0000000000..a1a1d69ca2 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBMongoDBUserDefinition.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbuserdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBUserDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBUserDefinition.md +--- + +# Get-AzCosmosDBMongoDBUserDefinition + +## SYNOPSIS +Gets the CosmosDB MongoDB User Definition. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBMongoDBUserDefinition -ResourceGroupName <String> -AccountName <String> [-Id <String>] + [-DatabaseName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBMongoDBUserDefinition [-Id <String>] [-DatabaseName <String>] + -DatabaseAccountObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzCosmosDBMongoDBUserDefinition cmdlet gets the list of all existing CosmosDB MongoDB API User Definitions for a given ResourceGroupName, AccountName and gets a single CosmosDB Mongo API Database for a given ResourceGroupName, AccountName, and Id. +Id can be either fully qualified or just the id string. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBMongoDBUserDefinition -AccountName accountName -ResourceGroupName resourceGroupName -Id id +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbUserDefinitions/id +UserName : test_user_name +Password : +Mechanisms : SCRAM-SHA-256 +DatabaseName : test +CustomData : +Roles : {Microsoft.Azure.Management.CosmosDB.Models.Role, Microsoft.Azure.Management.CosmosDB.Models.Role} +``` + +Get Mongo User Definition for the given Resource Group and Account and User id. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseAccountObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DatabaseName +Database Name for the MongoDB Role Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +User Definition Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBUserDefinitionGetResults +## NOTES + +## RELATED LINKS + +[New-AzCosmosDBMongoDBRoleDefinition](./New-AzCosmosDBMongoDBRoleDefinition.md) + +[Update-AzCosmosDBMongoDBRoleDefinition](./Update-AzCosmosDBMongoDBRoleDefinition.md) + +[Remove-AzCosmosDBMongoDBRoleDefinition](./Remove-AzCosmosDBMongoDBRoleDefinition.md) diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBRestorableDatabaseAccount.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBRestorableDatabaseAccount.md new file mode 100644 index 0000000000..31daf2f8f4 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBRestorableDatabaseAccount.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbrestorabledatabaseaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBRestorableDatabaseAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBRestorableDatabaseAccount.md +--- + +# Get-AzCosmosDBRestorableDatabaseAccount + +## SYNOPSIS +Gets the restorable database account object + +## SYNTAX + +``` +Get-AzCosmosDBRestorableDatabaseAccount [-Location <String>] [-DatabaseAccountInstanceId <String>] + [-DatabaseAccountName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the list of all restorable database account objects in the given account, or a specific restorable database account object with the given instanceId and location + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBRestorableDatabaseAccount +``` + +```output +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/fb8f230e-bab0-452b-81cf-e32643ccc898 +DatabaseAccountInstanceId : fb8f230e-bab0-452b-81cf-e32643ccc898 +Location : West US +DatabaseAccountName : deleted-account-1 +CreationTime : 8/2/2020 10:23:00 PM +DeletionTime : 8/2/2020 10:26:13 PM +OldestRestorableTime : 8/2/2020 10:23:00 PM +ApiType : Sql +RestorableLocations : {West US, East US} + +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/eastus/restorableDatabaseAccounts/ff921125-e31c-4e8c-ae0a-20fe719baca6 +DatabaseAccountInstanceId : ff921125-e31c-4e8c-ae0a-20fe719baca6 +Location : East US +DatabaseAccountName : deleted-account-2 +CreationTime : 8/2/2020 6:32:32 PM +DeletionTime : 8/2/2020 6:34:48 PM +OldestRestorableTime : 8/2/2020 6:32:32 PM +ApiType : Sql +RestorableLocations : {Australia Southeast, East US, West US} + +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/c7b27ad9-3bc0-4955-8cc2-a81790e5c3b3 +DatabaseAccountInstanceId : c7b27ad9-3bc0-4955-8cc2-a81790e5c3b3 +Location : West US +DatabaseAccountName : live-account-1 +CreationTime : 8/2/2020 6:34:35 PM +DeletionTime : +OldestRestorableTime : 8/2/2020 6:34:35 PM +ApiType : MongoDB +RestorableLocations : {West US} +``` + +Lists all the restorable database accounts in the current subscription + +### Example 1 +```powershell +Get-AzCosmosDBRestorableDatabaseAccount -Location "West US" -DatabaseAccountInstanceId fb8f230e-bab0-452b-81cf-e32643ccc898 +``` + +```output +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/fb8f230e-bab0-452b-81cf-e32643ccc898 +DatabaseAccountInstanceId : fb8f230e-bab0-452b-81cf-e32643ccc898 +Location : West US +DatabaseAccountName : deleted-account-1 +CreationTime : 8/2/2020 10:23:00 PM +DeletionTime : 8/2/2020 10:26:13 PM +OldestRestorableTime : 8/2/2020 10:23:00 PM +ApiType : Sql +RestorableLocations : {West US, East US} +``` + +Gets the restorable database account with the given DatabaseInstanceId in the given ARM location + +## PARAMETERS + +### -DatabaseAccountInstanceId +The instance Id of the CosmosDB database account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseAccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.CosmosDB.Models.PSRestorableDatabaseAccountGetResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBService.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBService.md new file mode 100644 index 0000000000..c209d9f1c2 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBService.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBService.md +--- + +# Get-AzCosmosDBService + +## SYNOPSIS +Gets the CosmosDB Service + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBService -ResourceGroupName <String> -AccountName <String> [-ServiceName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBService [-ServiceName <String>] -ParentObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBService** cmdlet gets the list of all existing CosmosDB Services for a given ResourceGroupName, AccountName and DatabaseName and gets a single CosmosDB Service for a given ResourceGroupName, AccountName, DatabaseName and ServiceName. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBService -AccountName "accountName" -ResourceGroupName "resourceGroupName" -ServiceName "sqlDedicatedGateway" +``` + +```output +Name : sqlDedicatedGateway +Id : {Id} +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSServiceGetResults +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Unique ID (Guid) for the Role Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSServiceGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlContainer.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlContainer.md new file mode 100644 index 0000000000..9282ddb841 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlContainer.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbsqlcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlContainer.md +--- + +# Get-AzCosmosDBSqlContainer + +## SYNOPSIS +Gets the CosmosDB Sql Container. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBSqlContainer -ResourceGroupName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] -AccountName <String> -DatabaseName <String> [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBSqlContainer [-Name <String>] -ParentObject <PSSqlDatabaseGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBSqlContainer** cmdlet gets the list of all existing CosmosDB Sql Containers for a given ResourceGroupName, AccountName and DatabaseName and gets a single CosmosDB Sql Container for a given ResourceGroupName, AccountName, DatabaseName and ContainerName. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBSqlContainer -AccountName "accountName" -ResourceGroupName "resourceGroupName" -DatabaseName "databaseName" +``` + +```output +Name : {containerName1} +Id : Id +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlContainerBackupInformation.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlContainerBackupInformation.md new file mode 100644 index 0000000000..c324375269 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlContainerBackupInformation.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbsqlcontainerbackupinformation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlContainerBackupInformation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlContainerBackupInformation.md +--- + +# Get-AzCosmosDBSqlContainerBackupInformation + +## SYNOPSIS +Retrieves the latest restorable timestamp for a sql container. + +## SYNTAX + +``` +Get-AzCosmosDBSqlContainerBackupInformation -ResourceGroupName <String> -AccountName <String> + -DatabaseName <String> -Name <String> -Location <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the latest restorable timestamp for a sql container. This is the latest timestamp upto which user can successfully restore this container. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBSqlContainerBackupInformation -ResourceGroupName CosmosDBResourceGroup3668 -AccountName pitr-sql-stage-source -DatabaseName TestDB1 -Name TestCollectionInDB1 -Location "EAST US 2" +``` + +```output +LatestRestorableTimestamp +------------------------- +1623042210 +``` + +Retrieves the latest restorable timestamp for a sql container. This is the latest timestamp upto which user can successfully restore this container. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +-Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.Restore.Sql.PSSqlBackupInformation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlContainerThroughput.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlContainerThroughput.md new file mode 100644 index 0000000000..c13610ca59 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlContainerThroughput.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbsqlcontainerthroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlContainerThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlContainerThroughput.md +--- + +# Get-AzCosmosDBSqlContainerThroughput + +## SYNOPSIS +Gets the throughput settings corresponding to a CosmosDB Sql Container. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBSqlContainerThroughput -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Get-AzCosmosDBSqlContainerThroughput [-Name <String>] -InputObject <PSSqlContainerGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBSqlContainerThroughput** cmdlet gets the throughput settings corresponding to a CosmosDB Sql Container. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBSqlContainerThroughput -AccountName "accountName" -ResourceGroupName "resourceGroupName" -DatabaseName "databaseName" -Name "containerName" +``` + +```output +Throughput : {throughputValue} +MinimumThroughput : +OfferReplacePending : +Id : +Name : {Name} +Type : Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings +Location : +Tags : +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlDatabase.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlDatabase.md new file mode 100644 index 0000000000..7628a2d860 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlDatabase.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbsqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlDatabase.md +--- + +# Get-AzCosmosDBSqlDatabase + +## SYNOPSIS +Gets the CosmosDB Sql Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBSqlDatabase -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBSqlDatabase [-Name <String>] -ParentObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBSqlDatabase** cmdlet gets the list of all existing CosmosDB Sql Databases for a given ResourceGroupName, AccountName and gets a single CosmosDB Sql Database for a given ResourceGroupName, AccountName, DatabaseName and ContainerName. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBSqlDatabase -AccountName "accountName" -ResourceGroupName "resourceGroupName" -Name "databaseName" +``` + +```output +Name : {databaseName} +Id : {databaseId} +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlDatabaseThroughput.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlDatabaseThroughput.md new file mode 100644 index 0000000000..74e7525afe --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlDatabaseThroughput.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbsqldatabasethroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlDatabaseThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlDatabaseThroughput.md +--- + +# Get-AzCosmosDBSqlDatabaseThroughput + +## SYNOPSIS +Gets the throughput settings corresponding to a CosmosDB Sql Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBSqlDatabaseThroughput -ResourceGroupName <String> -AccountName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBSqlDatabaseThroughput -Name <String> -InputObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBSqlDatabaseThroughput** cmdlet gets the throughput settings corresponding to a CosmosDB Sql Database. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBSqlDatabaseThroughput -AccountName "accountName" -ResourceGroupName "resourceGroupName" -Name "databaseName" +``` + +```output +Name : {throughputResourceName} +Id : {throughputId} +Throughput : 0 +MinimumThroughput : +OfferReplacePending : +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRestorableContainer.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRestorableContainer.md new file mode 100644 index 0000000000..1d800131f1 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRestorableContainer.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbsqlrestorablecontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlRestorableContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlRestorableContainer.md +--- + +# Get-AzCosmosDBSqlRestorableContainer + +## SYNOPSIS +Lists all the restorable Azure Cosmos DB SQL containers available for a specific database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBSqlRestorableContainer -Location <String> -DatabaseAccountInstanceId <String> + -DatabaseRId <String> [-StartTime <String>] [-EndTime <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBSqlRestorableContainer -InputObject <PSRestorableSqlDatabaseGetResult> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all the restorable Azure Cosmos DB SQL containers available for a specific database. +The list would have entries corresponding to create, replace and delete events of all live and deleted containers under the database. +This list is useful to identify the restore timestamp based on the changes in the container. +For example, if user wants to restore the database account to a timestamp when a specific container is deleted, the user can find corresponding collection delete event from this list, and choose a timestamp before the delete event for restore. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBSqlRestorableContainer -Location "location" -DatabaseAccountInstanceId "DatabaseAccountInstanceId" -DatabaseRId "DatabaseRId" +``` + +```output +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts + /{DatabaseAccountInstanceId}/restorableSqlContainers/6a0cb3e4-7d2b-4363-b585-04a3b14ada8c +Name : 6a0cb3e4-7d2b-4363-b585-04a3b14ada8c +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers +_rid : qsLuzwAAAA== +OperationType : Create +EventTimestamp : 01/20/2021 18:44:07 +OwnerId : foo-container2 +OwnerResourceId : Ts0YAPGKTvw= +Container : Microsoft.Azure.Management.CosmosDB.Models.PSRestorableSqlContainerPropertiesResourceContainer + +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts + /{DatabaseAccountInstanceId}/restorableSqlContainers/ff36d1d3-f9dc-40a0-a003-60fe349abcfb +Name : ff36d1d3-f9dc-40a0-a003-60fe349abcfb +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers +_rid : Ngu72QAAAA== +OperationType : Replace +EventTimestamp : 01/20/2021 18:44:07 +OwnerId : foo-container1 +OwnerResourceId : Ts0YAP+RbG0= +Container : Microsoft.Azure.Management.CosmosDB.Models.PSRestorableSqlContainerPropertiesResourceContainer + +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts + /{DatabaseAccountInstanceId}/restorableSqlContainers/2afb35ba-1755-4fbc-85be-ae175dd0668f +Name : 2afb35ba-1755-4fbc-85be-ae175dd0668f +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers +_rid : lSuf5gAAAA== +OperationType : Create +EventTimestamp : 01/20/2021 18:42:43 +OwnerId : foo-container1 +OwnerResourceId : Ts0YAP+RbG0= +Container : Microsoft.Azure.Management.CosmosDB.Models.PSRestorableSqlContainerPropertiesResourceContainer +``` + +The resource object contains the properties of the container resource + +## PARAMETERS + +### -DatabaseAccountInstanceId +The instance Id of the CosmosDB database account. +(This is returned as a part of database account properties). + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseRId +ResourceId of the database. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +Restorable Sql containers event feed end time. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Restorable Sql Database object + +```yaml +Type: Microsoft.Azure.Management.CosmosDB.Models.PSRestorableSqlDatabaseGetResult +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Restorable Sql containers event feed start time. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.CosmosDB.Models.PSRestorableSqlContainerGetResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRestorableDatabase.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRestorableDatabase.md new file mode 100644 index 0000000000..4d9b391b21 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRestorableDatabase.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbsqlrestorabledatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlRestorableDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlRestorableDatabase.md +--- + +# Get-AzCosmosDBSqlRestorableDatabase + +## SYNOPSIS +Gets the list of all the restorable Azure Cosmos DB Sql databases available under the restorable account. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBSqlRestorableDatabase -Location <String> -DatabaseAccountInstanceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBSqlRestorableDatabase -InputObject <PSRestorableDatabaseAccountGetResult> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the list of all the restorable Azure Cosmos DB Sql databases available under the restorable account. +The list would have entries corresponding to create, replace and delete events of all live and deleted databases. +This list is useful to identify the restore timestamp based on the changes in the database. +For example, if user wants to restore the database account to a timestamp when a database named foo is deleted, the user can find corresponding database delete event from this list, and choose a timestamp before the delete event for restore. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBSqlRestorableDatabase -Location "location" -DatabaseAccountInstanceId "DatabaseAccountInstanceId" +``` + +```output +Name : cb04fbfc-4142-413d-b2c5-c91723a17e28 +Id : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{DatabaseAccountInstanceId}/restorableSqlDatabases/cb04fbfc-4142-413d-b2c5-c91723 + a17e28 +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases +_rid : a+35ZwAAAA== +OperationType : Create +EventTimestamp : 01/20/2021 18:42:37 +OwnerId : foo-db1 +OwnerResourceId : Ts0YAA== +Database : Microsoft.Azure.Management.CosmosDB.Models.PSRestorableSqlDatabasePropertiesResourceDatabase +``` + +The resource object contains the properties of the database resource + +## PARAMETERS + +### -DatabaseAccountInstanceId +The instance Id of the CosmosDB database account. +(This is returned as a part of database account properties). + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Restorable Database Account object + +```yaml +Type: Microsoft.Azure.Management.CosmosDB.Models.PSRestorableDatabaseAccountGetResult +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.CosmosDB.Models.PSRestorableSqlDatabaseGetResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRestorableResource.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRestorableResource.md new file mode 100644 index 0000000000..87243b3d25 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRestorableResource.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbsqlrestorableresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlRestorableResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlRestorableResource.md +--- + +# Get-AzCosmosDBSqlRestorableResource + +## SYNOPSIS +Lists all the restorable Azure Cosmos DB SQL resources available for a specific database account at a given time and location. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBSqlRestorableResource -Location <String> -DatabaseAccountInstanceId <String> + -RestoreTimestampInUtc <DateTime> -RestoreLocation <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBSqlRestorableResource -Location <String> -DatabaseAccountInstanceId <String> + -RestoreTimestampInUtc <DateTime> -RestoreLocation <String> + -InputObject <PSRestorableDatabaseAccountGetResult> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Lists all the restorable Azure Cosmos DB SQL resources available for a specific database account at a given time and location. +The list is useful to know what resources exist in the source account at the given time. This will provide the user an indication of what to expect if the account is restored to the given time. +The user can also use this list and provide a subset of restorable resources if the user wants to restore only specific databases/containers. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBSqlRestorableResource -Location "location" -DatabaseAccountInstanceId "DatabaseInstanceId" -RestoreLocation "Database" -RestoreTimestampInUtc $RestoreTimestamp +``` + +```output +DatabaseName CollectionNames +------------ --------------- +{DBName} {Collection names} +``` + +Returns the list of all restorable Azure Cosmos DB SQL resources available for a specific database account at a given time and location. + +## PARAMETERS + +### -DatabaseAccountInstanceId +The instance Id of the CosmosDB database account. +(This is returned as a part of database account properties). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Restorable Database Account object + +```yaml +Type: Microsoft.Azure.Management.CosmosDB.Models.PSRestorableDatabaseAccountGetResult +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreLocation +The location of the source account from which restore is triggered. +This will also be the write region of the restored account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreTimestampInUtc +The timestamp to which the source account has to be restored to. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseToRestore + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRoleAssignment.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRoleAssignment.md new file mode 100644 index 0000000000..476cc6df99 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRoleAssignment.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbsqlroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlRoleAssignment.md +--- + +# Get-AzCosmosDBSqlRoleAssignment + +## SYNOPSIS +Gets the CosmosDB Sql Role Assignment. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBSqlRoleAssignment -ResourceGroupName <String> -AccountName <String> [-Id <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBSqlRoleAssignment [-Id <String>] -ParentObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzCosmosDBSqlRoleAssignment cmdlet gets the list of all existing CosmosDB Sql Role Assignments for a given ResourceGroupName, AccountName and gets a single CosmosDB Sql Role Assignment for a given ResourceGroupName, AccountName, Id. +Id can be either fully qualified or just the Guid. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBSqlRoleAssignment -AccountName accountName -ResourceGroupName resourceGroupName -Id roleAssignmentId +``` + +```output +Id : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleAssignments/roleAssignmentId +Scope : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/ +RoleDefinitionId : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/roleDefinitionId +PrincipalId : principalId +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role Assignment Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Cosmos DB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleAssignmentGetResults +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRoleDefinition.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRoleDefinition.md new file mode 100644 index 0000000000..34b9052198 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlRoleDefinition.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbsqlroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlRoleDefinition.md +--- + +# Get-AzCosmosDBSqlRoleDefinition + +## SYNOPSIS +Gets the CosmosDB Role Definition. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBSqlRoleDefinition -ResourceGroupName <String> -AccountName <String> [-Id <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBSqlRoleDefinition [-Id <String>] -ParentObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzCosmosDBSqlRoleDefinition cmdlet gets the list of all existing CosmosDB Sql Role Definitions for a given ResourceGroupName, AccountName and gets a single CosmosDB Sql Database for a given ResourceGroupName, AccountName, and Id. +Id can be either fully qualified or just the Guid. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBSqlRoleDefinition -AccountName accountName -ResourceGroupName resourceGroupName -Id id +``` + +```output +RoleName : roleName +Id : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/id +Type : CustomRole +Permissions : {Microsoft.Azure.Management.CosmosDB.Models.Permission} +AssignableScopes : {/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName} +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role Definition Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleDefinitionGetResults +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlStoredProcedure.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlStoredProcedure.md new file mode 100644 index 0000000000..c16ed79d5d --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlStoredProcedure.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbsqlstoredprocedure +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlStoredProcedure.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlStoredProcedure.md +--- + +# Get-AzCosmosDBSqlStoredProcedure + +## SYNOPSIS +Gets the CosmosDB Sql StoredProcedure. + +## SYNTAX + +### ByNameParameterSet +``` +Get-AzCosmosDBSqlStoredProcedure -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -ContainerName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBSqlStoredProcedure [-Name <String>] -ParentObject <PSSqlContainerGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBSqlStoredProcedure** cmdlet gets the list of all existing CosmosDB Sql StoredProcedures for a given ResourceGroupName, AccountName, DatabaseName and ContainerName and gets a single CosmosDB Sql StoredProcedure for a given ResourceGroupName, AccountName, DatabaseName, ContainerName and StoredProcedureName. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBSqlStoredProcedure -AccountName "accountName" -ResourceGroupName "resourceGroupName" -DatabaseName "databaseName" -Name "storedProcedureName" -ContainerName "containerName" +``` + +```output +Name : {storedProcedureName} +Id : {storedProcedureId} +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlStoredProcedureGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Container name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Stored Prcodecure Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlStoredProcedureGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlTrigger.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlTrigger.md new file mode 100644 index 0000000000..4294825398 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlTrigger.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbsqltrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlTrigger.md +--- + +# Get-AzCosmosDBSqlTrigger + +## SYNOPSIS +Gets the CosmosDB Sql Trigger. + +## SYNTAX + +### ByNameParameterSet +``` +Get-AzCosmosDBSqlTrigger -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -ContainerName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBSqlTrigger [-Name <String>] -ParentObject <PSSqlContainerGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBSqlTrigger** cmdlet gets the list of all existing CosmosDB Sql Triggers for a given ResourceGroupName, AccountName, DatabaseName and ContainerName and gets a single CosmosDB Sql Trigger for a given ResourceGroupName, AccountName, DatabaseName, ContainerName and TriggerName. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBSqlTrigger -AccountName "accountName" -ResourceGroupName "resourceGroupName" -DatabaseName "databaseName" -Name "triggerName" -ContainerName "containerName" +``` + +```output +Name : {triggerName} +Id : {triggerId} +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlTriggerGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Container name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Trigger name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlTriggerGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlUserDefinedFunction.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlUserDefinedFunction.md new file mode 100644 index 0000000000..b40c056bad --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBSqlUserDefinedFunction.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbsqluserdefinedfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlUserDefinedFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBSqlUserDefinedFunction.md +--- + +# Get-AzCosmosDBSqlUserDefinedFunction + +## SYNOPSIS +Gets the CosmosDB Sql User Defined Function. + +## SYNTAX + +### ByNameParameterSet +``` +Get-AzCosmosDBSqlUserDefinedFunction -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -ContainerName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBSqlUserDefinedFunction [-Name <String>] -ParentObject <PSSqlContainerGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBSqlUserDefinedFunction** cmdlet gets the list of all existing CosmosDB Sql UserDefinedFunctions for a given ResourceGroupName, AccountName, DatabaseName and ContainerName and gets a single CosmosDB Sql UserDefinedFunction for a given ResourceGroupName, AccountName, DatabaseName, ContainerName and UserDefinedFunctionName. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBSqlUserDefinedFunction -AccountName "accountName" -ResourceGroupName "resourceGroupName" -DatabaseName "databaseName" -Name "userDefinedFunctionName" -ContainerName "containerName" +``` + +```output +Name : {userDefinedFunctionName} +Id : {userDefinedFunctionId} +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUserDefinedFunctionGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Container name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +User Defined Function Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUserDefinedFunctionGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTable.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTable.md new file mode 100644 index 0000000000..afa5487935 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTable.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbtable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBTable.md +--- + +# Get-AzCosmosDBTable + +## SYNOPSIS +Gets a CosmosDB Table. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBTable -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBTable [-Name <String>] -ParentObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBTable** cmdlet gets an existing Table. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBTable -AccountName "account" -Name "tableName" -ResourceGroupName "rgName" +``` + +```output +Name Id Resource +{name} {id} Microsoft.Azure.Commands.CosmosDB.Models.PSTableGetPropertiesResource +``` + +Resource object contains _rid, _ts, _ etag properties of the Table. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSTableGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTableBackupInformation.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTableBackupInformation.md new file mode 100644 index 0000000000..dd727864e8 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTableBackupInformation.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbtablebackupinformation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBTableBackupInformation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBTableBackupInformation.md +--- + +# Get-AzCosmosDBTableBackupInformation + +## SYNOPSIS +Retrieves the latest restorable timestamp for a table. + +## SYNTAX + +``` +Get-AzCosmosDBTableBackupInformation -ResourceGroupName <String> -AccountName <String> -Name <String> + -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the latest restorable timestamp for a table. This is the latest timestamp upto which user can successfully restore this table. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBTableBackupInformation -ResourceGroupName CosmosDBResourceGroup3668 -AccountName pitr-table-stage-source -Name TestTable1 -Location "EAST US 2" +``` + +```output +LatestRestorableTimestamp +------------------------- +1623032210 +``` + +Retrieves the latest restorable timestamp for a table. This is the latest timestamp upto which user can successfully restore this table. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.Restore.PSTableBackupInformation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTableRestorableResource.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTableRestorableResource.md new file mode 100644 index 0000000000..5718b4b572 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTableRestorableResource.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbtablerestorableresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBTableRestorableResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBTableRestorableResource.md +--- + +# Get-AzCosmosDBTableRestorableResource + +## SYNOPSIS +Lists all the restorable Azure Cosmos DB Table resources available for a specific database account at a given time and location. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBTableRestorableResource -Location <String> -DatabaseAccountInstanceId <String> + -RestoreTimestampInUtc <DateTime> -RestoreLocation <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBTableRestorableResource -Location <String> -DatabaseAccountInstanceId <String> + -RestoreTimestampInUtc <DateTime> -RestoreLocation <String> + -InputObject <PSRestorableDatabaseAccountGetResult> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Lists all the restorable Azure Cosmos DB Table resources available for a specific database account at a given time and location. +The list is useful to know what resources exist in the source account at the given time. This will provide the user an indication of what to expect if the account is restored to the given time. +The user can also use this list and provide a subset of restorable resources if the user wants to restore only specific tables. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBTableRestorableResource -Location "location" -DatabaseAccountInstanceId "DatabaseInstanceId" -RestoreLocation "RestoreLocation" -RestoreTimestampInUtc "RestoreTimestamp" +``` + +```output +TableNames +---------- +{table1, table2} +``` + +Returns the list of all restorable Azure Cosmos DB Tables available for a specific database account at a given time and location. + +## PARAMETERS + +### -DatabaseAccountInstanceId +The instance Id of the CosmosDB database account. +(This is returned as a part of database account properties). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Restorable Database Account object + +```yaml +Type: Microsoft.Azure.Management.CosmosDB.Models.PSRestorableDatabaseAccountGetResult +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreLocation +The location of the source account from which restore is triggered. +This will also be the write region of the restored account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreTimestampInUtc +The timestamp to which the source account has to be restored to. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.CosmosDB.Models.PSRestorableDatabaseAccountGetResult + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSTablesToRestore + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTableRestorableTable.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTableRestorableTable.md new file mode 100644 index 0000000000..fd077b4105 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTableRestorableTable.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbtablerestorabletable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBTableRestorableTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBTableRestorableTable.md +--- + +# Get-AzCosmosDBTableRestorableTable + +## SYNOPSIS +Lists all the restorable Azure Cosmos DB Tables available for a specific database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBTableRestorableTable -Location <String> -DatabaseAccountInstanceId <String> [-StartTime <String>] + [-EndTime <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBTableRestorableTable -InputObject <PSRestorableTableGetResult> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all the restorable Azure Cosmos DB Tables available for a specific database account. +The list would have entries corresponding to create, replace and delete events of all live and deleted tables under a specific database account. +This list is useful to identify the restore timestamp based on the changes in the collection. +For example, if user wants to restore the database account to a timestamp when a specific table is deleted, the user can find corresponding table delete event from this list, and choose a timestamp before the delete event for restore. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBTableRestorableTable -Location "location" -DatabaseAccountInstanceId "DatabaseAccountInstanceId" -StartTime "StartTime" -EndTime "EndTime" +``` + +```output +Id : /subscriptions/23587e98-b6ac-4328-a753-03bcd3c8e744/providers/Microsoft.DocumentDB/locations/East%20US2%20EUAP/restorableDatabaseAccounts/45221949-3b3b-457a-b23c-2562858de5a8/restorab + leTables/768c880d-082a-4414-9095-33eb612de58e +Name : 768c880d-082a-4414-9095-33eb612de58e +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableTables +_rid : QEE+IAAAAA== +OperationType : Create +EventTimestamp : 01/27/2022 02:08:02 +OwnerId : table1 +OwnerResourceId : F45qAKUxkWc= + +Id : /subscriptions/23587e98-b6ac-4328-a753-03bcd3c8e744/providers/Microsoft.DocumentDB/locations/East%20US2%20EUAP/restorableDatabaseAccounts/45221949-3b3b-457a-b23c-2562858de5a8/restorab + leTables/6af230dc-dd95-4a36-97b9-5c7071d40fef +Name : 6af230dc-dd95-4a36-97b9-5c7071d40fef +Type : Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableTables +_rid : s74kawAAAA== +OperationType : Create +EventTimestamp : 01/27/2022 02:08:34 +OwnerId : table2 +OwnerResourceId : F45qAJxEhOM= +``` + +The resource object contains the properties of the table resource. + +## PARAMETERS + +### -DatabaseAccountInstanceId +The instance Id of the CosmosDB database account. +(This is returned as a part of database account properties). + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +Restorable Tables event feed end time. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Restorable Table object. + +```yaml +Type: Microsoft.Azure.Management.CosmosDB.Models.PSRestorableTableGetResult +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Restorable Tables event feed start time. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.CosmosDB.Models.PSRestorableTableGetResult + +## OUTPUTS + +### Microsoft.Azure.Management.CosmosDB.Models.PSRestorableTableGetResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTableThroughput.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTableThroughput.md new file mode 100644 index 0000000000..29780d0a3f --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDBTableThroughput.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbtablethroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBTableThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBTableThroughput.md +--- + +# Get-AzCosmosDBTableThroughput + +## SYNOPSIS +Gets the throughput of a CosmosDB Table. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDBTableThroughput -ResourceGroupName <String> -AccountName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDBTableThroughput -Name <String> -InputObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDBTableThroughput** cmdlet gets the throughput of a CosmosDB Table. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDBTableThroughput -ResourceGroupName "rgName" -AccountName "accountName" -Name "databaseName" +``` + +```output +Name: {throughputName} +Id: {Id} +Throughput: {value} +MinimumThroughput: {value} +OfferReplacePending: {value} +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDbClientEncryptionKey.md b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDbClientEncryptionKey.md new file mode 100644 index 0000000000..e81bea31b5 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzCosmosDbClientEncryptionKey.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbclientencryptionkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDbClientEncryptionKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzCosmosDbClientEncryptionKey.md +--- + +# Get-AzCosmosDbClientEncryptionKey + +## SYNOPSIS +Gets the CosmosDB Client Encryption Key. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzCosmosDbClientEncryptionKey -ResourceGroupName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] -AccountName <String> -DatabaseName <String> [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzCosmosDbClientEncryptionKey [-Name <String>] -SqlDatabaseObject <PSSqlDatabaseGetResults> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCosmosDbClientEncryptionKey** cmdlet gets the list of all existing CosmosDB Client Encryption Key for a given ResourceGroupName, AccountName and DatabaseName and gets a single CosmosDB Client Encryption Key for a given ResourceGroupName, AccountName, DatabaseName and ClientEncryptionKeyName. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCosmosDbClientEncryptionKey -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName +``` + +```output +Name : {clientEncryptionKeyName} +Id : Id +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetPropertiesResource +``` + +The command gets all the client encryption keys in the database as set in myRgName. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Client Encryption Key name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClientEncryptionKeyName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlDatabaseObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetResults + +## NOTES + +## RELATED LINKS + +[New-AzCosmosDbClientEncryptionKey](./New-AzCosmosDbClientEncryptionKey.md) + +[Update-AzCosmosDbClientEncryptionKey](./Update-AzCosmosDbClientEncryptionKey.md) diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzManagedCassandraCluster.md b/azps-10.1.0/Az.CosmosDB/Get-AzManagedCassandraCluster.md new file mode 100644 index 0000000000..c2bcb7b1a3 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzManagedCassandraCluster.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azmanagedcassandracluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzManagedCassandraCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzManagedCassandraCluster.md +--- + +# Get-AzManagedCassandraCluster + +## SYNOPSIS +Gets a Azure Managed Instances for Apache Cassandra cluster. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzManagedCassandraCluster [-ResourceGroupName <String>] [-ClusterName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzManagedCassandraCluster -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Get-AzManagedCassandraCluster -InputObject <PSClusterResource> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzManagedCassandraCluster** cmdlet fetches the properties of an existing managed Cassandra cluster. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzManagedCassandraCluster -ResourceGroupName "resourceGroupName" -ClusterName "clusterName" +``` + +### Example 2 +```powershell +Get-AzManagedCassandraCluster -ResourceId "resourceId" +``` + +### Example 3 +```powershell +$clusterResource | Get-AzManagedCassandraCluster +``` + +## PARAMETERS + +### -ClusterName +Name of the managed Cassandra cluster. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Managed Cassandra Cluster object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource id of the managed Cassandra cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Get-AzManagedCassandraDataCenter.md b/azps-10.1.0/Az.CosmosDB/Get-AzManagedCassandraDataCenter.md new file mode 100644 index 0000000000..aee2b82da5 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Get-AzManagedCassandraDataCenter.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azmanagedcassandradatacenter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzManagedCassandraDataCenter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Get-AzManagedCassandraDataCenter.md +--- + +# Get-AzManagedCassandraDatacenter + +## SYNOPSIS +Gets a Azure Managed Instances for Apache Cassandra data center. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzManagedCassandraDatacenter -ResourceGroupName <String> -ClusterName <String> [-DataCenterName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzManagedCassandraDatacenter -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Get-AzManagedCassandraDatacenter -InputObject <PSDataCenterResource> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzManagedCassandraDatacenter -ParentObject <PSClusterResource> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzManagedCassandraDataCenter** cmdlet fetches the properties of an existing managed Cassandra data center. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzManagedCassandraDataCenter -ResourceGroupName "resourceGroupName" -ClusterName "clusterName" -DataCenterName "dataCenterName" +``` + +### Example 2 +```powershell +Get-AzManagedCassandraDataCenter -ResourceId "resourceId" +``` + +### Example 3 +```powershell +$clusterResource | Get-AzManagedCassandraDataCenter +``` + +## PARAMETERS + +### -ClusterName +Name of the managed Cassandra cluster. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataCenterName +Name of the managed Cassandra data center. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Managed Cassandra Datacenter object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDataCenterResource +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentObject +Managed Cassandra cluster object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource id of the managed Cassandra cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDataCenterResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration.md b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration.md new file mode 100644 index 0000000000..59fdd34979 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/invoke-azcosmosdbcassandrakeyspacethroughputmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration.md +--- + +# Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration + +## SYNOPSIS +Use this to migrate autoscale throughput to manual throughput and vice versa. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration [-Name <String>] -ResourceGroupName <String> + -AccountName <String> -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration [-Name <String>] + -ParentObject <PSDatabaseAccountGetResults> -ThroughputType <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration [-Name <String>] + -InputObject <PSCassandraKeyspaceGetResults> -ThroughputType <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +ThroughpyteType paramter defines the throughput to which you want to migrate to. + +## EXAMPLES + +### Example 1 +```powershell +$NewKeyspace = New-AzCosmosDBCassandraKeyspace -AccountName myAccountName -ResourceGroupName myRgName -Name myKeyspaceName -Throughput 700 +$AutoscaleThroughput = Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration -InputObject $NewKeyspace -ThroughputType Autoscale +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Cassandra Keyspace object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Cassandra Keyspace Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThroughputType +Throughput type to migrate to. +Possible values are: Autoscale, Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBCassandraTableThroughputMigration.md b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBCassandraTableThroughputMigration.md new file mode 100644 index 0000000000..15e27feab9 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBCassandraTableThroughputMigration.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/invoke-azcosmosdbcassandratablethroughputmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBCassandraTableThroughputMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBCassandraTableThroughputMigration.md +--- + +# Invoke-AzCosmosDBCassandraTableThroughputMigration + +## SYNOPSIS +Use this to migrate autoscale throughput to manual throughput and vice versa. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Invoke-AzCosmosDBCassandraTableThroughputMigration -KeyspaceName <String> [-Name <String>] + -ResourceGroupName <String> -AccountName <String> -ThroughputType <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Invoke-AzCosmosDBCassandraTableThroughputMigration [-Name <String>] + -ParentObject <PSCassandraKeyspaceGetResults> -ThroughputType <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Invoke-AzCosmosDBCassandraTableThroughputMigration [-Name <String>] -InputObject <PSCassandraTableGetResults> + -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +ThroughpyteType paramter defines the throughput to which you want to migrate to. + +## EXAMPLES + +### Example 1 +```powershell +$NewTable = New-AzCosmosDBCassandraTable -AccountName myAccountName -ResourceGroupName myRgName -Name myTableName -Throughput 700 -KeyspaceName myKeyspaceName +$AutoscaleThroughput = Invoke-AzCosmosDBCassandraTableThroughputMigration -InputObject $NewTable -ThroughputType Autoscale +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Cassandra Table object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraTableGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyspaceName +Cassandra Keyspace Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cassandra Table Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Cassandra Keyspace object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThroughputType +Throughput type to migrate to. +Possible values are: Autoscale, Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraTableGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBGremlinDatabaseThroughputMigration.md b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBGremlinDatabaseThroughputMigration.md new file mode 100644 index 0000000000..5aefad81cf --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBGremlinDatabaseThroughputMigration.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/invoke-azcosmosdbgremlindatabasethroughputmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBGremlinDatabaseThroughputMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBGremlinDatabaseThroughputMigration.md +--- + +# Invoke-AzCosmosDBGremlinDatabaseThroughputMigration + +## SYNOPSIS +Use this to migrate autoscale throughput to manual throughput and vice versa. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Invoke-AzCosmosDBGremlinDatabaseThroughputMigration [-Name <String>] -ResourceGroupName <String> + -AccountName <String> -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Invoke-AzCosmosDBGremlinDatabaseThroughputMigration [-Name <String>] + -ParentObject <PSDatabaseAccountGetResults> -ThroughputType <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Invoke-AzCosmosDBGremlinDatabaseThroughputMigration [-Name <String>] -InputObject <PSGremlinDatabaseGetResults> + -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +ThroughpyteType paramter defines the throughput to which you want to migrate to. + +## EXAMPLES + +### Example 1 +```powershell +$NewDb = New-AzCosmosDBGremlinDatabase -AccountName myAccountName -ResourceGroupName myRgName -Name myDbName -Throughput 700 +$AutoscaleThroughput = Invoke-AzCosmosDBGremlinDatabaseThroughputMigration -InputObject $NewDb -ThroughputType Autoscale +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gremlin Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThroughputType +Throughput type to migrate to. +Possible values are: Autoscale, Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBGremlinGraphThroughputMigration.md b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBGremlinGraphThroughputMigration.md new file mode 100644 index 0000000000..641cfc7b80 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBGremlinGraphThroughputMigration.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/invoke-azcosmosdbgremlingraphthroughputmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBGremlinGraphThroughputMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBGremlinGraphThroughputMigration.md +--- + +# Invoke-AzCosmosDBGremlinGraphThroughputMigration + +## SYNOPSIS +Use this to migrate autoscale throughput to manual throughput and vice versa. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Invoke-AzCosmosDBGremlinGraphThroughputMigration -DatabaseName <String> [-Name <String>] + -ResourceGroupName <String> -AccountName <String> -ThroughputType <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Invoke-AzCosmosDBGremlinGraphThroughputMigration [-Name <String>] -ParentObject <PSGremlinDatabaseGetResults> + -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Invoke-AzCosmosDBGremlinGraphThroughputMigration [-Name <String>] -InputObject <PSGremlinGraphGetResults> + -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +ThroughpyteType paramter defines the throughput to which you want to migrate to. + +## EXAMPLES + +### Example 1 +```powershell +$NewGraph = New-AzCosmosDBGremlinGraph -AccountName myAccountName -ResourceGroupName myRgName -Name myGraphName -Throughput 700 -DatabaseName myDbName +$AutoscaleThroughput = Invoke-AzCosmosDBGremlinGraphThroughputMigration -InputObject $NewGraph -ThroughputType Autoscale +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gremlin Graph object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Gremlin Graph Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Gremlin Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThroughputType +Throughput type to migrate to. +Possible values are: Autoscale, Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBMongoDBCollectionThroughputMigration.md b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBMongoDBCollectionThroughputMigration.md new file mode 100644 index 0000000000..a43d3c8f4d --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBMongoDBCollectionThroughputMigration.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/invoke-azcosmosdbmongodbcollectionthroughputmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBMongoDBCollectionThroughputMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBMongoDBCollectionThroughputMigration.md +--- + +# Invoke-AzCosmosDBMongoDBCollectionThroughputMigration + +## SYNOPSIS +Use this to migrate autoscale throughput to manual throughput and vice versa. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Invoke-AzCosmosDBMongoDBCollectionThroughputMigration -DatabaseName <String> [-Name <String>] + -ResourceGroupName <String> -AccountName <String> -ThroughputType <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Invoke-AzCosmosDBMongoDBCollectionThroughputMigration [-Name <String>] + -ParentObject <PSMongoDBDatabaseGetResults> -ThroughputType <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Invoke-AzCosmosDBMongoDBCollectionThroughputMigration [-Name <String>] + -InputObject <PSMongoDBCollectionGetResults> -ThroughputType <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +ThroughpyteType paramter defines the throughput to which you want to migrate to. + +## EXAMPLES + +### Example 1 +```powershell +$NewCollection = New-AzCosmosDBMongoDBCollection -AccountName myAccountName -ResourceGroupName myRgName -Name myCollectionName -Throughput 700 -DatabaseName myDbName +$AutoscaleThroughput = Invoke-AzCosmosDBMongoDBCollectionThroughputMigration -InputObject $NewCollection -ThroughputType Autoscale +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Mongo Collection object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Collection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Mongo Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThroughputType +Throughput type to migrate to. +Possible values are: Autoscale, Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration.md b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration.md new file mode 100644 index 0000000000..ab522f20af --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/invoke-azcosmosdbmongodbdatabasethroughputmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration.md +--- + +# Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration + +## SYNOPSIS +Use this to migrate autoscale throughput to manual throughput and vice versa. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration [-Name <String>] -ResourceGroupName <String> + -AccountName <String> -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration [-Name <String>] + -ParentObject <PSDatabaseAccountGetResults> -ThroughputType <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration [-Name <String>] -InputObject <PSMongoDBDatabaseGetResults> + -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +ThroughpyteType paramter defines the throughput to which you want to migrate to. + +## EXAMPLES + +### Example 1 +```powershell +$NewMongodbDatabase = New-AzCosmosDBMongoDBDatabase -AccountName myAccountName -ResourceGroupName myRgName -Name myDbName -Throughput 700 +$AutoscaleThroughput = Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration -InputObject $NewMongodbDatabase -ThroughputType Autoscale +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Mongo Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThroughputType +Throughput type to migrate to. +Possible values are: Autoscale, Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBSqlContainerThroughputMigration.md b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBSqlContainerThroughputMigration.md new file mode 100644 index 0000000000..a713816723 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBSqlContainerThroughputMigration.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/invoke-azcosmosdbsqlcontainerthroughputmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBSqlContainerThroughputMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBSqlContainerThroughputMigration.md +--- + +# Invoke-AzCosmosDBSqlContainerThroughputMigration + +## SYNOPSIS +Use this to migrate autoscale throughput to manual throughput and vice versa. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Invoke-AzCosmosDBSqlContainerThroughputMigration -DatabaseName <String> [-Name <String>] + -ResourceGroupName <String> -AccountName <String> -ThroughputType <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Invoke-AzCosmosDBSqlContainerThroughputMigration [-Name <String>] -ParentObject <PSSqlDatabaseGetResults> + -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Invoke-AzCosmosDBSqlContainerThroughputMigration [-Name <String>] -InputObject <PSSqlContainerGetResults> + -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +ThroughputType parameter defines the throughput to which you want to migrate to. + +## EXAMPLES + +### Example 1 +```powershell +$NewSqlContainer = New-AzCosmosDBSqlContainer -AccountName myAccountName -ResourceGroupName myRgName -Name myContainerName -Throughput 700 -DatabaseName myDbName +$AutoscaleThroughput = Invoke-AzCosmosDBSqlContainerThroughputMigration -InputObject $NewSqlContainer -ThroughputType Autoscale +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThroughputType +Throughput type to migrate to. +Possible values are: Autoscale, Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBSqlDatabaseThroughputMigration.md b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBSqlDatabaseThroughputMigration.md new file mode 100644 index 0000000000..c56ffb459a --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBSqlDatabaseThroughputMigration.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/invoke-azcosmosdbsqldatabasethroughputmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBSqlDatabaseThroughputMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBSqlDatabaseThroughputMigration.md +--- + +# Invoke-AzCosmosDBSqlDatabaseThroughputMigration + +## SYNOPSIS +Use this to migrate autoscale throughput to manual throughput and vice versa. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Invoke-AzCosmosDBSqlDatabaseThroughputMigration [-Name <String>] -ResourceGroupName <String> + -AccountName <String> -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Invoke-AzCosmosDBSqlDatabaseThroughputMigration [-Name <String>] -ParentObject <PSDatabaseAccountGetResults> + -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Invoke-AzCosmosDBSqlDatabaseThroughputMigration [-Name <String>] -InputObject <PSSqlDatabaseGetResults> + -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +ThroughpyteType paramter defines the throughput to which you want to migrate to. + +## EXAMPLES + +### Example 1 +```powershell +$NewSqlDatabase = New-AzCosmosDBSqlDatabase -AccountName myAccountName -ResourceGroupName myRgName -Name myDbName -Throughput 700 +$AutoscaleThroughput = Invoke-AzCosmosDBSqlDatabaseThroughputMigration -InputObject $NewSqlDatabase -ThroughputType Autoscale +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThroughputType +Throughput type to migrate to. +Possible values are: Autoscale, Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBTableThroughputMigration.md b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBTableThroughputMigration.md new file mode 100644 index 0000000000..dfc2197fc8 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Invoke-AzCosmosDBTableThroughputMigration.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/invoke-azcosmosdbtablethroughputmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBTableThroughputMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Invoke-AzCosmosDBTableThroughputMigration.md +--- + +# Invoke-AzCosmosDBTableThroughputMigration + +## SYNOPSIS +Use this to migrate autoscale throughput to manual throughput and vice versa. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Invoke-AzCosmosDBTableThroughputMigration [-Name <String>] -ResourceGroupName <String> -AccountName <String> + -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Invoke-AzCosmosDBTableThroughputMigration [-Name <String>] -ParentObject <PSDatabaseAccountGetResults> + -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Invoke-AzCosmosDBTableThroughputMigration [-Name <String>] -InputObject <PSTableGetResults> + -ThroughputType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +ThroughpyteType paramter defines the throughput to which you want to migrate to. + +## EXAMPLES + +### Example 1 +```powershell +$NewTable = New-AzCosmosDBTable -AccountName myAccountName -ResourceGroupName myRgName -Name myTableName -Throughput 700 +$AutoscaleThroughput = Invoke-AzCosmosDBTableThroughputMigration -InputObject $NewTable -ThroughputType Autoscale +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Table Object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSTableGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThroughputType +Throughput type to migrate to. +Possible values are: Autoscale, Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSTableGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBAccount.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBAccount.md new file mode 100644 index 0000000000..d6c1ad5a68 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBAccount.md @@ -0,0 +1,633 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBAccount.md +--- + +# New-AzCosmosDBAccount + +## SYNOPSIS +Create a new CosmosDB Account. + +## SYNTAX + +``` +New-AzCosmosDBAccount [-EnableAutomaticFailover] [-EnableMultipleWriteLocations] [-EnableVirtualNetwork] + [-FromPointInTimeBackup] [-ApiKind <String>] [-DisableKeyBasedMetadataWriteAccess] [-EnableFreeTier <Boolean>] + [-Location <String[]>] [-LocationObject <PSLocation[]>] [-Capabilities <String[]>] -ResourceGroupName <String> + -Name <String> [-DefaultConsistencyLevel <String>] [-IpRule <String[]>] + [-MaxStalenessIntervalInSeconds <Int32>] [-MaxStalenessPrefix <Int32>] [-Tag <Hashtable>] + [-VirtualNetworkRule <String[]>] [-VirtualNetworkRuleObject <PSVirtualNetworkRule[]>] + [-PublicNetworkAccess <String>] [-KeyVaultKeyUri <String>] [-EnableAnalyticalStorage <Boolean>] [-AsJob] + [-NetworkAclBypass <String>] [-NetworkAclBypassResourceId <String[]>] [-ServerVersion <String>] + [-BackupIntervalInMinutes <Int32>] [-BackupRetentionIntervalInHours <Int32>] + [-BackupStorageRedundancy <String>] [-BackupPolicyType <String>] [-ContinuousTier <String>] [-AnalyticalStorageSchemaType <String>] [-EnablePartitionMerge <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new CosmosDB Account in the given ResourceGroup. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBAccount -ResourceGroupName resourceGroupName -Name databaseAccountName -Location "East US" +``` + +```output +Kind : GlobalDocumentDB +ProvisioningState : Initializing +DocumentEndpoint : +DatabaseAccountOfferType : Standard +IpRangeFilter : +IsVirtualNetworkFilterEnabled : False +EnableAutomaticFailover : False +ConsistencyPolicy : Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy +Capabilities : {} +WriteLocations : {databaseAccountName-eastus} +ReadLocations : {databaseAccountName-eastus} +FailoverPolicies : {databaseAccountName-eastus} +VirtualNetworkRules : {} +EnableMultipleWriteLocations : False +Location : East US +Tags : {} +Id : /subscriptions/{subscriptionid}/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/databaseAccountName +Name : databaseAccountName +Type : Microsoft.DocumentDB/databaseAccounts +NetworkAclBypass : None +NetworkAclBypassResourceIds : {} +``` + +A new CosmosDB Account with name databaseAccountName is created in the ResourceGroup resourceGroupName. + +## PARAMETERS + +### -AnalyticalStorageSchemaType +The schema type for analytical storage. Valid values include: 'WellDefined' and 'FullFidelity'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiKind +The type of Cosmos DB database account to create. +Accepted values: GlobalDocumentDB, MongoDB, Gremlin, Table, Cassandra. +Default value: GlobalDocumentDB + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupIntervalInMinutes +The interval(in minutes) with which backup are taken (only for accounts with periodic mode backups) + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupPolicyType +The type of backups on the Cosmos DB account. Accepted values: Periodic, Continuous + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionIntervalInHours +The time(in hours) for which each backup is retained (only for accounts with periodic mode backups) + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupStorageRedundancy +The redundancy type of the backup Storage account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Capabilities +Add a location to the Cosmos DB database account. Array of strings, ordered by failover priority. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinuousTier +The tier of continuous backups mode on the Cosmos DB account. Accepted values: Continuous7Days, Continuous30Days + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConsistencyLevel +Default consistency level of the Cosmos DB database account. +Accepted values: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableKeyBasedMetadataWriteAccess +Disable write operations on metadata resources (databases, containers, throughput) via account keys + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAnalyticalStorage +Bool to indicate if AnalyticalStorage is enabled on the account. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePartitionMerge +Bool to indicate if PartitionMerge is enabled on the account. +Accepted Values: false, true +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutomaticFailover +Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. +Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account. +Accepted values: false, true + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFreeTier +Bool to indicate if FreeTier is enabled on the account. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMultipleWriteLocations +Enable Multiple Write Locations. +Accepted values: false, true + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableVirtualNetwork +Enables virtual network on the Cosmos DB database account. +Accepted values: false, true + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromPointInTimeBackup +Indicates that the new Cosmos DB account request is a restore request. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpRule +Firewall support. Specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultKeyUri +URI of the KeyVault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Add a location to the Cosmos DB database account. +Array of strings, ordered by failover priority. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationObject +Add a location to the Cosmos DB database account. Array of PSLocation objects. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSLocation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxStalenessIntervalInSeconds +When used with Bounded Staleness consistency, this value represents the time amount of staleness (in timespan) tolerated. +Accepted range for this value is 5-86400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxStalenessPrefix +When used with Bounded Staleness consistency, this value represents the number of stale requests tolerated. +Accepted range for this value is 1 - 2,147,483,647. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkAclBypass +Whether or not Network Acl Bypass is enabled for this account for Synapse Link. Possible values include: 'None', 'AzureServices'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkAclBypassResourceId +List of Resource Ids to allow Network Acl Bypass for Synapse Link. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Whether or not public endpoint access is allowed for this server. Possible values include: 'Enabled', 'Disabled' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerVersion +ServerVersion, valid only in case of MongoDB Accounts. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Hashtable of tags as key-value pairs. +Use empty string to clear existing tag. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRule +Array of string values of ACL's for virtual network. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRuleObject +Array of PSVirtualNetworkRuleObjects for virtual network. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSVirtualNetworkRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBAccountKey.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBAccountKey.md new file mode 100644 index 0000000000..c08e907bec --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBAccountKey.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBAccountKey.md +--- + +# New-AzCosmosDBAccountKey + +## SYNOPSIS +Regenerate a given CosmosDB Account Key. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBAccountKey -ResourceGroupName <String> -Name <String> [-KeyKind <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +New-AzCosmosDBAccountKey [-KeyKind <String>] -ResourceId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +New-AzCosmosDBAccountKey [-KeyKind <String>] -InputObject <PSDatabaseAccountGetResults> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new CosmosDB Account in the given ResourceGroup. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBAccountKey -ResourceGroupName rg -Name dbname +``` + +New keys are generated for Account with account name dbname in ResourceGroup rg. + +### Example 2 + +Regenerate a given CosmosDB Account Key. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzCosmosDBAccountKey -KeyKind <String> -Name dbname -ResourceGroupName rg +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyKind +The access key to regenerate. +Accepted values: primary, primaryReadonly, secondary, secondaryReadonly + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraClusterKey.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraClusterKey.md new file mode 100644 index 0000000000..3c679790d7 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraClusterKey.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbcassandraclusterkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBCassandraClusterKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBCassandraClusterKey.md +--- + +# New-AzCosmosDBCassandraClusterKey + +## SYNOPSIS +Creates a new CosmosDB Cassandra Cluster Key. + +## SYNTAX + +``` +New-AzCosmosDBCassandraClusterKey -Name <String> -OrderBy <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCosmosDBCassandraClusterKey** creates a new CosmosDB Cassandra Cluster Key. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBCassandraClusterKey -Name "name" -OrderBy "Asc" +``` + +```output +Name OrderBy +---- ------- +{name} Asc +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Cassandra Cluster Key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderBy +Ordering of Cassandra Cluster key. +Possible values include: 'Asc', 'Desc' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSClusterKey + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraColumn.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraColumn.md new file mode 100644 index 0000000000..c9f3540c37 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraColumn.md @@ -0,0 +1,98 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbcassandracolumn +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBCassandraColumn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBCassandraColumn.md +--- + +# New-AzCosmosDBCassandraColumn + +## SYNOPSIS +Creates a new CosmosDB Cassandra Column. + +## SYNTAX + +``` +New-AzCosmosDBCassandraColumn -Name <String> -Type <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCosmosDBCassandraColumn** creates a new CosmosDB Cassandra Column. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBCassandraColumn -Name "name" -Type int +``` + +```output +Name Type +---- ---- +name int +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Cassandra Column. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of Cassandra Column. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSColumn + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraKeyspace.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraKeyspace.md new file mode 100644 index 0000000000..38fa42a98b --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraKeyspace.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbcassandrakeyspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBCassandraKeyspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBCassandraKeyspace.md +--- + +# New-AzCosmosDBCassandraKeyspace + +## SYNOPSIS +Creates a new CosmosDB Cassandra Keyspace. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBCassandraKeyspace -ResourceGroupName <String> -AccountName <String> -Name <String> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBCassandraKeyspace -Name <String> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -ParentObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB Cassandra Keyspace. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBCassandraKeyspace -AccountName myAccountName -ResourceGroupName myRgName -Name myKeyspaceName -Throughput 600 +``` + +```output +Name : myKeyspace +Id : /subscriptions/mySubId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/cassandraKeyspaces/myKeyspaceName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cassandra Keyspace Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Cassandra Keyspace (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ConflictingResourceException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraSchema.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraSchema.md new file mode 100644 index 0000000000..0e3f27ea5f --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraSchema.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbcassandraschema +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBCassandraSchema.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBCassandraSchema.md +--- + +# New-AzCosmosDBCassandraSchema + +## SYNOPSIS +Creates a new CosmosDB Cassandra Schema. + +## SYNTAX + +``` +New-AzCosmosDBCassandraSchema [-Column <PSColumn[]>] [-PartitionKey <String[]>] [-ClusterKey <PSClusterKey[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCosmosDBCassandraSchema** creates a new CosmosDB Cassandra Schema. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBCassandraSchema -Column $column1 -PartitionKey "a" -ClusterKey $clusterkey1 +``` + +```output +Columns PartitionKeys ClusterKeys +------- ------------- ----------- +{column1} {a} {clusterkey1} +``` + +## PARAMETERS + +### -ClusterKey +Array of PSClusterKey objects. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSClusterKey[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Column +PSColumn object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSColumn[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionKey +Array of strings containing Partition Keys. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraSchema + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraTable.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraTable.md new file mode 100644 index 0000000000..f1a77885db --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBCassandraTable.md @@ -0,0 +1,280 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbcassandratable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBCassandraTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBCassandraTable.md +--- + +# New-AzCosmosDBCassandraTable + +## SYNOPSIS +Creates a new CosmosDB Cassandra Table. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBCassandraTable -ResourceGroupName <String> -AccountName <String> -KeyspaceName <String> + -Name <String> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-TtlInSeconds <Int32>] + [-AnalyticalStorageTtl <Int32>] -Schema <PSCassandraSchema> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBCassandraTable -Name <String> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + [-TtlInSeconds <Int32>] [-AnalyticalStorageTtl <Int32>] -Schema <PSCassandraSchema> + -ParentObject <PSCassandraKeyspaceGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB Cassandra Table. + +## EXAMPLES + +### Example 1 +```powershell +$Column1 = New-AzCosmosDBCassandraColumn -Name "ColumnA" -Type "int" +$Column2 = New-AzCosmosDBCassandraColumn -Name "ColumnB" -Type "ascii" +$Column3 = New-AzCosmosDBCassandraColumn -Name "ColumnC" -Type "int" +$Column4 = New-AzCosmosDBCassandraColumn -Name "ColumnD" -Type "ascii" + +$clusterkey1 = New-AzCosmosDBCassandraClusterKey -Name "ColumnB" -OrderBy "Asc" +$clusterkey2 = New-AzCosmosDBCassandraClusterKey -Name "ColumnA" -OrderBy "Asc" + +$schema = New-AzCosmosDBCassandraSchema -Column $Column1,$Column2 -ClusterKey $clusterkey1 -PartitionKey "ColumnA" + +New-AzCosmosDBCassandraTable -AccountName myAccountName -ResourceGroupName myRgName -KeyspaceName myKeyspaceName -Name myTableName -Schema $schema +``` + +```output +Name : myTable +Id : /subscriptions/mySubId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/cassandraKeyspaces/myKeyspaceName/tables/myTableName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraTableGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnalyticalStorageTtl +Analytical Storage TTL. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyspaceName +Cassandra Keyspace Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cassandra Table Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Cassandra Keyspace object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schema +PSCassandraSchema object. +Use New-AzCosmosDBCassandraSchema to create this object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraSchema +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Cassandra Keyspace (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TtlInSeconds +Default Ttl in seconds. +If the value is missing or set to - 1, items don't expire. +If the value is set to n, items will expire n seconds after last modified time. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraSchema + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraTableGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ConflictingResourceException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBDatabaseToRestore.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBDatabaseToRestore.md new file mode 100644 index 0000000000..0b75694657 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBDatabaseToRestore.md @@ -0,0 +1,101 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbdatabasetorestore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBDatabaseToRestore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBDatabaseToRestore.md +--- + +# New-AzCosmosDBDatabaseToRestore + +## SYNOPSIS +Creates a new CosmosDB Database to Restore object(PSDatabaseToRestore) + +## SYNTAX + +``` +New-AzCosmosDBDatabaseToRestore -DatabaseName <String> [-CollectionName <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB DatabaseToRestore object(PSDatabaseToRestore). This returned object can be uses to speficy the subset of databases and collections to restore. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBDatabaseToRestore -DatabaseName database1 -CollectionName collection1,collection2,collection3 +``` + +```output +DatabaseName CollectionNames +------------ --------------- +database1 {collection1, collection2, collection3} +``` + +Creates a new DatabaseToRestore object with the name database1 and collections with names collection1, collection2 and collection3. + +## PARAMETERS + +### -CollectionName +The names of the collections to be restored. +(If not provided, all the collections will be restored) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database to restore + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseToRestore + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinCompositePath.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinCompositePath.md new file mode 100644 index 0000000000..29a45104f0 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinCompositePath.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbgremlincompositepath +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinCompositePath.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinCompositePath.md +--- + +# New-AzCosmosDBGremlinCompositePath + +## SYNOPSIS +Creates a new object of type PSCompositePath. It can be passed as a parameter value for Set-AzCosmosDBGremlinGraph. + +## SYNTAX + +``` +New-AzCosmosDBGremlinCompositePath [-Path <String>] [-Order <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Object corresponding to Gremlin API's CompositePath. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBGremlinCompositePath -Path "/abc" -Order Ascending +``` + +```output +Path Order +---- ----- +/abc Ascending +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +Gets or sets sort order for composite paths. +Possible values include: 'Ascending', 'Descending' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path for which the indexing behavior applies to. +Index paths typically start with root and end with wildcard (/path/*) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinConflictResolutionPolicy.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinConflictResolutionPolicy.md new file mode 100644 index 0000000000..d3418cffee --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinConflictResolutionPolicy.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbgremlinconflictresolutionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinConflictResolutionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinConflictResolutionPolicy.md +--- + +# New-AzCosmosDBGremlinConflictResolutionPolicy + +## SYNOPSIS +Creates a new object of type PSConflictResolutionPolicy. It can be passed as a parameter value for Set-AzCosmosDBGremlinGraph. + +## SYNTAX + +``` +New-AzCosmosDBGremlinConflictResolutionPolicy -Type <String> [-Path <String>] + [-ConflictResolutionProcedure <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Object corresponding to Gremlin API's ConflictResolutionPolicy. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBGremlinConflictResolutionPolicy -Type LastWriterWins -Path "/myPath" +``` + +```output +Mode ConflictResolutionPath ConflictResolutionProcedure +---- ---------------------- --------------------------- +LastWriterWins /myPath +``` + +## PARAMETERS + +### -ConflictResolutionProcedure +To be provided when the type is custom. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +To be provided when the type is LastWriterWins. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Can have the values: LastWriterWins, Custom, Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSConflictResolutionPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinDatabase.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinDatabase.md new file mode 100644 index 0000000000..c02df71ed6 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinDatabase.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbgremlindatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinDatabase.md +--- + +# New-AzCosmosDBGremlinDatabase + +## SYNOPSIS +Creates a new CosmosDB Gremlin Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBGremlinDatabase -ResourceGroupName <String> -AccountName <String> -Name <String> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBGremlinDatabase -Name <String> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -ParentObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB Gremlin Database. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBGremlinDatabase -AccountName myAccountName -Name myDatabaseName -ResourceGroupName myResourcegroupName +``` + +```output +Name : myDatabaseName +Id : /subscriptions/mySubscriptionId/resourceGroups/myResourcegroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/gremlinDatabases/myDatabaseName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Gremlin Database (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ConflictingResourceException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinDatabaseToRestore.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinDatabaseToRestore.md new file mode 100644 index 0000000000..ffee251513 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinDatabaseToRestore.md @@ -0,0 +1,101 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbgremlindatabasetorestore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinDatabaseToRestore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinDatabaseToRestore.md +--- + +# New-AzCosmosDBGremlinDatabaseToRestore + +## SYNOPSIS +Creates a new CosmosDB Gremlin Database to Restore object(PSGremlinDatabaseToRestore) + +## SYNTAX + +``` +New-AzCosmosDBGremlinDatabaseToRestore -DatabaseName <String> [-GraphNames <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB GremlinDatabaseToRestore object(PSGremlinDatabaseToRestore). This returned object can be uses to speficy the subset of databases and graphs to restore. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBGremlinDatabaseToRestore -DatabaseName database1 -GraphName graph1,graph2,graph3 +``` + +```output +DatabaseName GraphNames +------------ --------------- +database1 {graph1, graph2, graph3} +``` + +Creates a new GremlinDatabaseToRestore object with the name database1 and graphs with names graph1, graph2 and graph3. + +## PARAMETERS + +### -DatabaseName +The name of the gremlin database to restore + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GraphNames +The names of the graphs to be restored. +(If not provided, all the graphs will be restored) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseToRestore + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinGraph.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinGraph.md new file mode 100644 index 0000000000..560030ac0a --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinGraph.md @@ -0,0 +1,385 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbgremlingraph +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinGraph.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinGraph.md +--- + +# New-AzCosmosDBGremlinGraph + +## SYNOPSIS +Creates a new CosmosDB Gremlin Graph. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBGremlinGraph -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -Name <String> [-IndexingPolicy <PSIndexingPolicy>] [-PartitionKeyVersion <Int32>] -PartitionKeyKind <String> + -PartitionKeyPath <String[]> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-TtlInSeconds <Int32>] + [-UniqueKeyPolicy <PSUniqueKeyPolicy>] [-ConflictResolutionPolicyMode <String>] + [-ConflictResolutionPolicyPath <String>] [-ConflictResolutionPolicyProcedure <String>] + [-ConflictResolutionPolicy <PSConflictResolutionPolicy>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBGremlinGraph -Name <String> [-IndexingPolicy <PSIndexingPolicy>] [-PartitionKeyVersion <Int32>] + -PartitionKeyKind <String> -PartitionKeyPath <String[]> [-Throughput <Int32>] + [-AutoscaleMaxThroughput <Int32>] [-TtlInSeconds <Int32>] [-UniqueKeyPolicy <PSUniqueKeyPolicy>] + [-ConflictResolutionPolicyMode <String>] [-ConflictResolutionPolicyPath <String>] + [-ConflictResolutionPolicyProcedure <String>] [-ConflictResolutionPolicy <PSConflictResolutionPolicy>] + -ParentObject <PSGremlinDatabaseGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB Gremlin Graph. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBGremlinGraph -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myContainerName -PartitionKeyPath /a -PartitionKeyKind Hash +``` + +```output +Name : myContainerName +Id : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/gremlinDatabases/myDatabaseName/graphs/myGraphName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicy +ConflictResolutionPolicy Object of type PSConflictResolutionPolicy, when provided this is set as the ConflictResolutionPolicy of the container. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSConflictResolutionPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicyMode +Can have the values: LastWriterWins, Custom, Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicyPath +To be provided when the type is LastWriterWins. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicyProcedure +To be provided when the type is custom. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IndexingPolicy +Indexing Policy Object of type Microsoft.Azure.Commands.CosmosDB.PSIndexingPolicy. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSIndexingPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Gremlin Graph Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Gremlin Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PartitionKeyKind +The kind of algorithm used for partitioning. +Possible values include: 'Hash', 'Range' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionKeyPath +Partition Key Path, e.g., '/address/zipcode'. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionKeyVersion +The version of the partition key definition + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Gremlin Graph (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TtlInSeconds +Default Ttl in seconds. +If the value is missing or set to - 1, items don't expire. +If the value is set to n, items will expire n seconds after last modified time. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UniqueKeyPolicy +UniqueKeyPolicy Object of type Microsoft.Azure.Commands.CosmosDB.PSUniqueKeyPolicy. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSUniqueKeyPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSIndexingPolicy + +### Microsoft.Azure.Commands.CosmosDB.Models.PSUniqueKeyPolicy + +### Microsoft.Azure.Commands.CosmosDB.Models.PSConflictResolutionPolicy + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetResults + +### System.Exception + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinIncludedPath.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinIncludedPath.md new file mode 100644 index 0000000000..ec88465923 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinIncludedPath.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbgremlinincludedpath +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinIncludedPath.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinIncludedPath.md +--- + +# New-AzCosmosDBGremlinIncludedPath + +## SYNOPSIS +Creates a new object of type PSIncludedPath. It can be passed as a parameter value for Set-AzCosmosDBGremlinGraph. + +## SYNTAX + +``` +New-AzCosmosDBGremlinIncludedPath [-Path <String>] [-Index <PSIndexes[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Object corresponding to Gremlin API's IncludedPath. + +## EXAMPLES + +### Example 1 +```powershell +$index1 = New-AzCosmosDBGremlinIncludedPathIndex -DataType String -Precision -1 -Kind Hash +New-AzCosmosDBGremlinIncludedPath -Path "/*" -Index $index1 +``` + +```output +Path Indexes +---- ------- +/* {Microsoft.Azure.Commands.CosmosDB.Models.PSIndexes} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Index +List of indexes for this path + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSIndexes[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path for which the indexing behavior applies to. +Index paths typically start with root and end with wildcard (/path/*) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSIncludedPath + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinIncludedPathIndex.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinIncludedPathIndex.md new file mode 100644 index 0000000000..9133338779 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinIncludedPathIndex.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbgremlinincludedpathindex +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinIncludedPathIndex.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinIncludedPathIndex.md +--- + +# New-AzCosmosDBGremlinIncludedPathIndex + +## SYNOPSIS +Creates a new object of type PSIndexes. It can be passed as a parameter value for Set-AzCosmosDBGremlinIncludedPath. + +## SYNTAX + +``` +New-AzCosmosDBGremlinIncludedPathIndex -DataType <String> [-Precision <Int32>] -Kind <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Object corresponding to Gremlin API's IncludedPath's Indexes. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBGremlinIncludedPathIndex -DataType String -Precision -1 -Kind Hash +``` + +```output +DataType Precision Kind +-------- --------- ---- +String -1 Hash +``` + +## PARAMETERS + +### -DataType +Datatype for which the indexing behavior is applied to. +Possible values include: 'String', 'Number', 'Point', 'Polygon', 'LineString', 'MultiPolygon' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Indicates the type of index. +Possible values include: 'Hash', 'Range', 'Spatial' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Precision +The precision of the index. +-1 is maximum precision. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSIndexes + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinIndexingPolicy.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinIndexingPolicy.md new file mode 100644 index 0000000000..92f7bb564a --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinIndexingPolicy.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbgremlinindexingpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinIndexingPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinIndexingPolicy.md +--- + +# New-AzCosmosDBGremlinIndexingPolicy + +## SYNOPSIS +Creates a new CosmosDB IndexingPolicy object. + +## SYNTAX + +``` +New-AzCosmosDBGremlinIndexingPolicy [-IncludedPath <PSIncludedPath[]>] [-SpatialSpec <PSSpatialSpec[]>] + [-CompositePath <PSCompositePath[][]>] [-ExcludedPath <String[]>] [-Automatic <Boolean>] + [-IndexingMode <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCosmosDBGremlinIndexingPolicy** cmdlet creates a new object of type PSIndexingPolicy. + +## EXAMPLES + +### Example 1 +```powershell +$ipath1 = New-AzCosmosDBGremlinIncludedPathIndex -DataType String -Precision -1 -Kind Hash +$ipath2 = New-AzCosmosDBGremlinIncludedPathIndex -DataType String -Precision -1 -Kind Hash +$IncludedPath = New-AzCosmosDBGremlinIncludedPath -Path "/*" -Index $ipath1, $ipath2 +$SpatialSpec = New-AzCosmosDBGremlinSpatialSpec -Path "/mySpatialPath/*" -Type "Point", "LineString", "Polygon", "MultiPolygon" +$cp1 = New-AzCosmosDBGremlinCompositePath -Path "/abc" -Order Ascending +$cp2 = New-AzCosmosDBGremlinCompositePath -Path "/aberc" -Order Descending +$compositePath = (($cp1, $cp2), ($cp2, $cp1)) +New-AzCosmosDBGremlinIndexingPolicy -IncludedPath $IncludedPath -SpatialSpec $SpatialSpec -CompositePath $compositePath -ExcludedPath "/myPathToNotIndex/*" -Automatic 1 -IndexingMode Consistent +``` + +```output +Automatic : True +IndexingMode : Consistent +IncludedPaths : {Microsoft.Azure.Commands.CosmosDB.Models.PSIncludedPath} +ExcludedPaths : {Microsoft.Azure.Commands.CosmosDB.Models.PSExcludedPath} +CompositeIndexes : {Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath, + Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath} +SpatialIndexes : {Microsoft.Azure.Commands.CosmosDB.Models.PSSpatialSpec} +``` + +## PARAMETERS + +### -Automatic +Bool to indicate if the indexing policy is automatic + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompositePath +Array of array of objects of type Microsoft.Azure.Commands.CosmosDB.PSCompositePath + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath[][] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedPath +Array of strings containing excludedPath(Specifies a path within a JSON document to be excluded in the Azure Cosmos DB service.) elements. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedPath +Array of strings containing includedPath (Specifies a path within a JSON document to be included in the Azure Cosmos DB service.) elements. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSIncludedPath[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IndexingMode +Indicates the indexing mode. +Possible values include: 'Consistent', 'Lazy', 'None' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpatialSpec +Array of objects of type Microsoft.Azure.Commands.CosmosDB.PSSpatialSpec + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSpatialSpec[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSIndexingPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinSpatialSpec.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinSpatialSpec.md new file mode 100644 index 0000000000..527dc78ca5 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinSpatialSpec.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbgremlinspatialspec +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinSpatialSpec.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinSpatialSpec.md +--- + +# New-AzCosmosDBGremlinSpatialSpec + +## SYNOPSIS +Creates a new object of type PSSpatialSpec. It can be passed as a parameter value for Set-AzCosmosDBGremlinIndexingPolicy. + +## SYNTAX + +``` +New-AzCosmosDBGremlinSpatialSpec -Path <String> -Type <String[]> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates Object corresponding to Gremlin API's SpatialSpec. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBGremlinSpatialSpec -Path "/abc" -Type String +``` + +```output +Path Types +---- ----- +/abc {String} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Path in JSON document to index. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Array of strings with acceptable values: Point, LineString, Polygon, MultiPolygon. +Represent's paths spatial type. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSpatialSpec + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinUniqueKey.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinUniqueKey.md new file mode 100644 index 0000000000..6093b1b8ff --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinUniqueKey.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbgremlinuniquekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinUniqueKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinUniqueKey.md +--- + +# New-AzCosmosDBGremlinUniqueKey + +## SYNOPSIS +Creates a new CosmosDB UniqueKeyPolicy object. + +## SYNTAX + +``` +New-AzCosmosDBGremlinUniqueKey -Path <String[]> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCosmosDBGremlinUniqueKeyPolicy** cmdlet creates a new object of type PSUniqueKeyPolicy. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBGremlinUniqueKey -Path "abc" +``` + +```output +UniqueKeys +---------- +{Microsoft.Azure.Commands.CosmosDB.Models.PSUniqueKey} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Array of string of path values + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSUniqueKey + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinUniqueKeyPolicy.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinUniqueKeyPolicy.md new file mode 100644 index 0000000000..2a20c755ef --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBGremlinUniqueKeyPolicy.md @@ -0,0 +1,85 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbgremlinuniquekeypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinUniqueKeyPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBGremlinUniqueKeyPolicy.md +--- + +# New-AzCosmosDBGremlinUniqueKeyPolicy + +## SYNOPSIS +Creates a new CosmosDB UniqueKeyPolicy object. + +## SYNTAX + +``` +New-AzCosmosDBGremlinUniqueKeyPolicy -UniqueKey <PSSqlUniqueKey[]> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCosmosDBGremlinUniqueKeyPolicy** cmdlet creates a new object of type PSUniqueKeyPolicy. + +## EXAMPLES + +### Example 1 +```powershell +$uk = New-AzCosmosDBGremlinUniqueKey -Path "abc" + +New-AzCosmosDBGremlinUniqueKeyPolicy -UniqueKey $uk,$uk +``` + +```output +UniqueKey +--------- +{Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUniqueKey, Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUniqueKey} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UniqueKey +Array of objects of type PSUniqueKey. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUniqueKey[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSUniqueKeyPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBLocationObject.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBLocationObject.md new file mode 100644 index 0000000000..2b90b6f76f --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBLocationObject.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdblocationobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBLocationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBLocationObject.md +--- + +# New-AzCosmosDBLocationObject + +## SYNOPSIS +Create a new CosmosDB Location Object(PSLocation). + +## SYNTAX + +``` +New-AzCosmosDBLocationObject -LocationName <String> [-FailoverPriority <Int32>] [-IsZoneRedundant <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new CosmosDB Location Object(PSLocation). + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBLocationObject -LocationName "locationName" -FailoverPriority 2 -IsZoneRedundant 0 +``` + +```output +LocationName FailoverPriority IsZoneRedundant +------------ ---------------- --------------- +{locationName} 2 False +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverPriority +Failover priority of the location. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsZoneRedundant +Boolean to indicate whether or not this region is an AvailabilityZone. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationName +Name of the Location in string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSLocation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBCollection.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBCollection.md new file mode 100644 index 0000000000..2627400997 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBCollection.md @@ -0,0 +1,270 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBCollection.md +--- + +# New-AzCosmosDBMongoDBCollection + +## SYNOPSIS +Creates a new CosmosDB MongoDB Collection. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBMongoDBCollection -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -Name <String> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-Shard <String>] + [-AnalyticalStorageTtl <Int32>] [-Index <PSMongoIndex[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBMongoDBCollection -Name <String> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + [-Shard <String>] [-AnalyticalStorageTtl <Int32>] [-Index <PSMongoIndex[]>] + -ParentObject <PSMongoDBDatabaseGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB MongoDB Collection. + +## EXAMPLES + +### Example 1 +```powershell +$ttlInSeconds = 604800 +$index1 = New-AzCosmosDBMongoDBIndex -Key @("partitionkey1", "partitionkey2") -Unique 1 +$index2 = New-AzCosmosDBMongoDBIndex -Key @("_ts") -TtlInSeconds $ttlInSeconds + +New-AzCosmosDBMongoDBCollection -AccountName myAccountName -ResourceGroupName myRgName -DatabaseName myDatabaseName -Name myCollectionName -Index $index1,$index2 -Shard myShardKey +``` + +```output +Name : collection1 +Id : /subscriptions/mySubId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbDatabases/myDatabaseName/collect + ions/myCollectionName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnalyticalStorageTtl +TTL for Analytical Storage. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Index +Array of PSMongoIndex objects. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoIndex[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Collection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Mongo Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Shard +Sharding key path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of SQL container (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ConflictingResourceException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBDatabase.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBDatabase.md new file mode 100644 index 0000000000..9a8326e4ad --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBDatabase.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBDatabase.md +--- + +# New-AzCosmosDBMongoDBDatabase + +## SYNOPSIS +Creates a new CosmosDB MongoDB Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBMongoDBDatabase -ResourceGroupName <String> -AccountName <String> -Name <String> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBMongoDBDatabase -Name <String> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -ParentObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB MongoDB Database. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBMongoDBDatabase -AccountName myAccountName -Name myDatabaseName -ResourceGroupName myResourcegroupName +``` + +```output +Name : myDatabaseName +Id : /subscriptions/mySubscriptionId/resourceGroups/myResourcegroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbDatabases/myDatabaseName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Mongo database (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ConflictingResourceException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBIndex.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBIndex.md new file mode 100644 index 0000000000..875200c116 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBIndex.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbindex +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBIndex.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBIndex.md +--- + +# New-AzCosmosDBMongoDBIndex + +## SYNOPSIS +Creates a new CosmosDB MongoDB Index. + +## SYNTAX + +``` +New-AzCosmosDBMongoDBIndex [-TtlInSeconds <Int32>] [-Unique <Boolean>] [-Key <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCosmosDBMongoDBIndex** creates a new CosmosDB MongoDB Index. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBMongoDBIndex -TtlInSeconds 604800 -Unique 1 -Key "key1" +``` + +```output +Key Options +--- ------- +Microsoft.Azure.Commands.CosmosDB.Models.PSMongoIndexKeys Microsoft.Azure.Commands.CosmosDB.Models.PSMongoIndexOptions +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Key +Array of key values as strings. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TtlInSeconds +Number of seconds after which the index expires. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Unique +Bool to indicate if the index is unique or not. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoIndex + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBPrivilege.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBPrivilege.md new file mode 100644 index 0000000000..0966caa602 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBPrivilege.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbprivilege +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBPrivilege.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBPrivilege.md +--- + +# New-AzCosmosDBMongoDBPrivilege + +## SYNOPSIS +Creates a new CosmosDB MongoDB Privilege object to be used to create or update a CosmosDB MongoDB Role Definition. + +## SYNTAX + +``` +New-AzCosmosDBMongoDBPrivilege [-PrivilegeResource <PSMongoPrivilegeResource>] [-Actions <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB MongoDB Privilege object to be used to create or update a CosmosDB MongoDB Role Definition. + +## EXAMPLES + +### Example 1 +```powershell +$db = 'test' +$collection = 'coll' +$Actions = 'insert', 'find' +$PrivilegeResource = New-AzCosmosDBMongoDBPrivilegeResource -Database $db -Collection $collection + +New-AzCosmosDBMongoDBPrivilege -PrivilegeResource $PrivilegeResource -Actions $Actions +``` + +```output +Object +Microsoft.Azure.Commands.CosmosDB.Models.PSMongoPrivilege +``` + +## PARAMETERS + +### -Actions +Array of valid Actions(e.g. insert, find). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivilegeResource +Microsoft.Azure.Commands.CosmosDB.Models.PSMongoPrivilegeResource Object. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoPrivilegeResource +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoPrivilege +## NOTES + +## RELATED LINKS + +[New-AzCosmosDBMongoDBRoleDefinition](./New-AzCosmosDBMongoDBRoleDefinition.md) + +[Update-AzCosmosDBMongoDBRoleDefinition](./Update-AzCosmosDBMongoDBRoleDefinition.md) diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBPrivilegeResource.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBPrivilegeResource.md new file mode 100644 index 0000000000..f2717834f4 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBPrivilegeResource.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbprivilegeresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBPrivilegeResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBPrivilegeResource.md +--- + +# New-AzCosmosDBMongoDBPrivilegeResource + +## SYNOPSIS +Creates a new CosmosDB MongoDB PrivilegeResource object to be used to create or update a CosmosDB MongoDB Role Definition. + +## SYNTAX + +``` +New-AzCosmosDBMongoDBPrivilegeResource -Database <String> -Collection <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB MongoDB PrivilegeResource object to be used to create or update a CosmosDB MongoDB Role Definition. + +## EXAMPLES + +### Example 1 +```powershell +$db = 'test' +$collection = 'coll' + +New-AzCosmosDBMongoDBPrivilegeResource -Database $db -Collection $collection +``` + +```output +Object +Microsoft.Azure.Commands.CosmosDB.Models.PSMongoPrivilegeResource +``` + +## PARAMETERS + +### -Collection +Collection Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database +Database Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoPrivilegeResource +## NOTES + +## RELATED LINKS + +[New-AzCosmosDBMongoDBRoleDefinition](./New-AzCosmosDBMongoDBRoleDefinition.md) + +[Update-AzCosmosDBMongoDBRoleDefinition](./Update-AzCosmosDBMongoDBRoleDefinition.md) diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBRole.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBRole.md new file mode 100644 index 0000000000..e30698e21d --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBRole.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbrole +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBRole.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBRole.md +--- + +# New-AzCosmosDBMongoDBRole + +## SYNOPSIS +Creates a new CosmosDB MongoDB Role object to be used to create or update a CosmosDB MongoDB Role Definition and User Definition. + +## SYNTAX + +``` +New-AzCosmosDBMongoDBRole -Database <String> -Role <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB MongoDB Role object to be used to create or update a CosmosDB MongoDB Role Definition and User Definition. + +## EXAMPLES + +### Example 1 +```powershell +$db = 'test' +$role = 'testRoleName' + +New-AzCosmosDBMongoDBRole -Database $db -Role $role +``` + +```output +Object +Microsoft.Azure.Commands.CosmosDB.Models.PSMongoRole +``` + +## PARAMETERS + +### -Database +Database Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +Role Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoRole +## NOTES + +## RELATED LINKS + +[New-AzCosmosDBMongoDBRoleDefinition](./New-AzCosmosDBMongoDBRoleDefinition.md) + +[Update-AzCosmosDBMongoDBRoleDefinition](./Update-AzCosmosDBMongoDBRoleDefinition.md) + +[New-AzCosmosDBMongoDBUserDefinition](./New-AzCosmosDBMongoDBUserDefinition.md) + +[Update-AzCosmosDBMongoDBUserDefinition](./Update-AzCosmosDBMongoDBUserDefinition.md) diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBRoleDefinition.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBRoleDefinition.md new file mode 100644 index 0000000000..fc9660e0b7 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBRoleDefinition.md @@ -0,0 +1,327 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBRoleDefinition.md +--- + +# New-AzCosmosDBMongoDBRoleDefinition + +## SYNOPSIS +Creates a new CosmosDB MongoDB Role Definition. + +## SYNTAX + +### ByFieldsDataActionsParameterSet (Default) +``` +New-AzCosmosDBMongoDBRoleDefinition -Id <String> -RoleName <String> -Type <String> -DatabaseName <String> + -Privileges <PSMongoPrivilege[]> [-Roles <PSMongoRole[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByNameParameterSet +``` +New-AzCosmosDBMongoDBRoleDefinition -ResourceGroupName <String> -AccountName <String> -Id <String> + -RoleName <String> -Type <String> -DatabaseName <String> -Privileges <PSMongoPrivilege[]> + [-Roles <PSMongoRole[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectDataActionsParameterSet +``` +New-AzCosmosDBMongoDBRoleDefinition -Id <String> -RoleName <String> -Type <String> -DatabaseName <String> + -Privileges <PSMongoPrivilege[]> [-Roles <PSMongoRole[]>] -DatabaseAccountObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectPermissionsParameterSet +``` +New-AzCosmosDBMongoDBRoleDefinition -Id <String> -RoleName <String> -Type <String> -DatabaseName <String> + -Privileges <PSMongoPrivilege[]> [-Roles <PSMongoRole[]>] -DatabaseAccountObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +New-AzCosmosDBMongoDBRoleDefinition -Id <String> -RoleName <String> -Type <String> -DatabaseName <String> + -Privileges <PSMongoPrivilege[]> [-Roles <PSMongoRole[]>] [-ResourceId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB MongoDB Role Definition. +In order to specify the Role Definition's Privileges, use the New-AzCosmosDBMongoDBPrivilege cmdlet to create PSMongoPrivilege objects to pass in through the Privileges parameter. +In order to specify the Role Definition's Roles, use the New-AzCosmosDBMongoDBRole cmdlet to create PSMongoRole objects to pass in through the Roles parameter. + +## EXAMPLES + +### Example 1: Default +```powershell +$Actions = 'insert', 'find' + $PrivilegeResource = New-AzCosmosDBMongoDBPrivilegeResource -Database test -Collection test + $Privilege = New-AzCosmosDBMongoDBPrivilege -PrivilegeResource $PrivilegeResource -Actions $Actions + $Roles = New-AzCosmosDBMongoDBRole -Database test -Role roleName + + +New-AzCosmosDBMongoDBRoleDefinition ` + -AccountName accountName ` + -ResourceGroupName resourceGroupName ` + -DatabaseName test ` + -Id id ` + -Type CustomRole ` + -RoleName roleName ` + -Privileges $Privilege ` + -Roles $Roles +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbRoleDefinitions/id +RoleName : roleName +Type : CustomRole +DatabaseName : test +Privileges : {Microsoft.Azure.Management.CosmosDB.Models.Privilege} +Roles : {Microsoft.Azure.Management.CosmosDB.Models.Role, Microsoft.Azure.Management.CosmosDB.Models.Role} +``` + +### Example 2: ParentObject +```powershell +$DatabaseAccount = Get-AzCosmosDBAccount -Name accountName -ResourceGroupName resourceGroupName +$Actions = 'insert', 'find' +$PrivilegeResource = New-AzCosmosDBMongoDBPrivilegeResource -Database test -Collection test +$Privilege = New-AzCosmosDBMongoDBPrivilege -PrivilegeResource $PrivilegeResource -Actions $Actions +$Roles = New-AzCosmosDBMongoDBRole -Database test -Role roleName +New-AzCosmosDBMongoDBRoleDefinition ` + -Id id ` + -Type CustomRole ` + -RoleName roleName ` + -Privileges $Privilege ` + -Roles $Roles ` + -DatabaseAccountObject $DatabaseAccount +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbRoleDefinitions/id +RoleName : roleName +Type : CustomRole +DatabaseName : test +Privileges : {Microsoft.Azure.Management.CosmosDB.Models.Privilege} +Roles : {Microsoft.Azure.Management.CosmosDB.Models.Role, Microsoft.Azure.Management.CosmosDB.Models.Role} +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseAccountObject +Role definition object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectDataActionsParameterSet, ByParentObjectPermissionsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DatabaseName +Database Name for the MongoDB Role Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role Definition Unique Id(Format is `<databaseName>.<roleName>`). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Privileges +Set of Privileges for CosmosDB MongoDB API. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoPrivilege[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleName +Role Definition Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Roles +Set of inherited roles for CosmosDB MongoDB API Role Definition. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of Role Definition, either CustomRole or BuiltInRole. +Default value is CustomRole. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBRoleDefinitionGetResults +## NOTES + +## RELATED LINKS + +[Get-AzCosmosDBMongoDBRoleDefinition](./Get-AzCosmosDBMongoDBRoleDefinition.md) + +[Update-AzCosmosDBMongoDBRoleDefinition](./Update-AzCosmosDBMongoDBRoleDefinition.md) + +[Remove-AzCosmosDBMongoDBRoleDefinition](./Remove-AzCosmosDBMongoDBRoleDefinition.md) diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBUserDefinition.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBUserDefinition.md new file mode 100644 index 0000000000..41df91aa65 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBMongoDBUserDefinition.md @@ -0,0 +1,347 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbuserdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBUserDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBUserDefinition.md +--- + +# New-AzCosmosDBMongoDBUserDefinition + +## SYNOPSIS +Creates a new CosmosDB MongoDB User Definition. + +## SYNTAX + +### ByFieldsDataActionsParameterSet (Default) +``` +New-AzCosmosDBMongoDBUserDefinition -Id <String> -UserName <String> -Password <String> [-Mechanisms <String>] + -DatabaseName <String> + -Roles <System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole]> + [-CustomData <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByNameParameterSet +``` +New-AzCosmosDBMongoDBUserDefinition -ResourceGroupName <String> -AccountName <String> -Id <String> + -UserName <String> -Password <String> [-Mechanisms <String>] -DatabaseName <String> + -Roles <System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole]> + [-CustomData <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectDataActionsParameterSet +``` +New-AzCosmosDBMongoDBUserDefinition -Id <String> -UserName <String> -Password <String> [-Mechanisms <String>] + -DatabaseName <String> + -Roles <System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole]> + [-CustomData <String>] -DatabaseAccountObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectPermissionsParameterSet +``` +New-AzCosmosDBMongoDBUserDefinition -Id <String> -UserName <String> -Password <String> [-Mechanisms <String>] + -DatabaseName <String> + -Roles <System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole]> + [-CustomData <String>] -DatabaseAccountObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +New-AzCosmosDBMongoDBUserDefinition -Id <String> -UserName <String> -Password <String> [-Mechanisms <String>] + -DatabaseName <String> + -Roles <System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole]> + [-CustomData <String>] [-ResourceId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB MongoDB User Definition. +In order to specify the Role Definition's Roles, use the New-AzCosmosDBMongoDBRole cmdlet to create PSMongoRole objects to pass in through the Roles parameter. + +## EXAMPLES + +### Example 1: Default +```powershell +$Roles = New-AzCosmosDBMongoDBRole -Database test -Role roleName + + +New-AzCosmosDBMongoDBUserDefinition ` + -AccountName accountName ` + -ResourceGroupName resourceGroupName ` + -DatabaseName 'test' ` + -UserName 'myName' ` + -Password 'pass' ` + -Id id ` + -Mechanisms 'SCRAM-SHA-256' ` + -CustomData 'test' ` + -Roles $Roles +``` + +```output +Id : /subscriptions/80be3961-0521-4a0a-8570-5cd5a4e2f98c/resourceGroups/mongorbactest02/providers/Microsoft.DocumentDB/databaseAccounts/ashwini001/mongodbUserDefinitions/test.testuser1 +UserName : testuser1 +Password : +Mechanisms : SCRAM-SHA-256 +DatabaseName : test +CustomData : +Roles : {Microsoft.Azure.Management.CosmosDB.Models.Role} +``` + +### Example 2: ParentObject +```powershell +$DatabaseAccount = Get-AzCosmosDBAccount -Name accountName -ResourceGroupName resourceGroupName +$Actions = 'insert', 'find' +$PrivilegeResource = New-AzCosmosDBMongoDBPrivilegeResource -Database test -Collection test +$Privilege = New-AzCosmosDBMongoDBPrivilege -PrivilegeResource $PrivilegeResource -Actions $Actions +$Roles = New-AzCosmosDBMongoDBRole -Database test -Role roleName +New-AzCosmosDBMongoDBRoleDefinition ` + -Id id ` + -Type CustomRole ` + -RoleName roleName ` + -Privileges $Privilege ` + -Roles $Roles ` + -DatabaseAccountObject $DatabaseAccount +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbRoleDefinitions/id +RoleName : roleName +Type : CustomRole +DatabaseName : test +Privileges : {Microsoft.Azure.Management.CosmosDB.Models.Privilege} +Roles : {Microsoft.Azure.Management.CosmosDB.Models.Role, Microsoft.Azure.Management.CosmosDB.Models.Role} +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomData +Additional information about the user Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseAccountObject +Role definition object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectDataActionsParameterSet, ByParentObjectPermissionsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DatabaseName +Database Name for the MongoDB Role Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role Definition Unique Id(Format is `<databaseName>.<roleName>`). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mechanisms +Password for the user Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Password for the user Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Roles +Set of inherited roles for CosmosDB MongoDB API Role Definition. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserName +Unique username(per database) for the user Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBRoleDefinitionGetResults +## NOTES + +## RELATED LINKS + +[Get-AzCosmosDBMongoDBUserDefinition](./Get-AzCosmosDBMongoDBUserDefinition.md) + +[Update-AzCosmosDBMongoDBUserDefinition](./Update-AzCosmosDBMongoDBUserDefinition.md) + +[Remove-AzCosmosDBMongoDBUserDefinition](./Remove-AzCosmosDBMongoDBUserDefinition.md) diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBPermission.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBPermission.md new file mode 100644 index 0000000000..ec61791fc8 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBPermission.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbpermission +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBPermission.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBPermission.md +--- + +# New-AzCosmosDBPermission + +## SYNOPSIS +Creates a new CosmosDB Permission object to be used to create or update a Role Definition. + +## SYNTAX + +``` +New-AzCosmosDBPermission -DataAction <System.Collections.Generic.List`1[System.String]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB Permission object to be used to create or update a Role Definition. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBPermission -DataAction "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create" +``` + +```output +DataActions +----------- +{Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create} +``` + +## PARAMETERS + +### -DataAction +Set of data actions granted through the Role Definition. List of allowed actions can be found at: https://aka.ms/cosmos-native-rbac + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSPermission +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBService.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBService.md new file mode 100644 index 0000000000..396a09d9cd --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBService.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBService.md +--- + +# New-AzCosmosDBService + +## SYNOPSIS +Creates a new CosmosDB Service. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBService -ResourceGroupName <String> -AccountName <String> -ServiceName <String> + -InstanceSize <String> -InstanceCount <Int32> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBService -ServiceName <String> -InstanceSize <String> -InstanceCount <Int32> + -ParentObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCosmosDBService** cmdlet creates a new CosmosDB Service. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBService -ResourceGroupName "ResourceGroup" -AccountName "AccountName" -ServiceName "ServiceName" -InstanceSize "Cosmos.D4s" -InstanceCount 1 +``` + +```output +Name : {serviceName} +Id : {id} +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSServiceGetResults +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceCount +Instance size of the service + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceSize +Instance count of the service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Name of the service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSServiceGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlCompositePath.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlCompositePath.md new file mode 100644 index 0000000000..8fbbf37dae --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlCompositePath.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqlcompositepath +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlCompositePath.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlCompositePath.md +--- + +# New-AzCosmosDBSqlCompositePath + +## SYNOPSIS +Creates a new object of type PSCompositePath. It can be passed as a parameter value for Set-AzCosmosDBSqlContainer. + +## SYNTAX + +``` +New-AzCosmosDBSqlCompositePath [-Path <String>] [-Order <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Object corresponding to Sql API's CompositePath. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBSqlCompositePath -Path "/abc" -Order Ascending +``` + +```output +Path Order +---- ----- +/abc Ascending +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +Gets or sets sort order for composite paths. +Possible values include: 'Ascending', 'Descending' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path for which the indexing behavior applies to. +Index paths typically start with root and end with wildcard (/path/*) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlConflictResolutionPolicy.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlConflictResolutionPolicy.md new file mode 100644 index 0000000000..06b42573a9 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlConflictResolutionPolicy.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqlconflictresolutionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlConflictResolutionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlConflictResolutionPolicy.md +--- + +# New-AzCosmosDBSqlConflictResolutionPolicy + +## SYNOPSIS +Creates a new object of type PSSqlConflictResolutionPolicy. It can be passed as a parameter value for Set-AzCosmosDBSqlContainer. + +## SYNTAX + +``` +New-AzCosmosDBSqlConflictResolutionPolicy -Type <String> [-Path <String>] + [-ConflictResolutionProcedure <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Object corresponding to Sql API's ConflictResolutionPolicy. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBSqlConflictResolutionPolicy -Type LastWriterWins -Path "/myPath" +``` + +```output +Mode ConflictResolutionPath ConflictResolutionProcedure +---- ---------------------- --------------------------- +LastWriterWins /myPath +``` + +## PARAMETERS + +### -ConflictResolutionProcedure +To be provided when the type is custom. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +To be provided when the type is LastWriterWins. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Can have the values: LastWriterWins, Custom, Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlConflictResolutionPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlContainer.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlContainer.md new file mode 100644 index 0000000000..d03c64a961 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlContainer.md @@ -0,0 +1,442 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqlcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlContainer.md +--- + +# New-AzCosmosDBSqlContainer + +## SYNOPSIS +Creates a new CosmosDB Sql Container. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBSqlContainer -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -Name <String> [-IndexingPolicy <PSSqlIndexingPolicy>] [-PartitionKeyVersion <Int32>] + -PartitionKeyKind <String> -PartitionKeyPath <String[]> [-Throughput <Int32>] + [-AutoscaleMaxThroughput <Int32>] [-TtlInSeconds <Int32>] [-UniqueKeyPolicy <PSSqlUniqueKeyPolicy>] + [-ConflictResolutionPolicyMode <String>] [-ConflictResolutionPolicyPath <String>] + [-ConflictResolutionPolicyProcedure <String>] [-ConflictResolutionPolicy <PSSqlConflictResolutionPolicy>] + [-ClientEncryptionPolicy <PSSqlClientEncryptionPolicy>] [-AnalyticalStorageTtl <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBSqlContainer -Name <String> [-IndexingPolicy <PSSqlIndexingPolicy>] + [-PartitionKeyVersion <Int32>] -PartitionKeyKind <String> -PartitionKeyPath <String[]> [-Throughput <Int32>] + [-AutoscaleMaxThroughput <Int32>] [-TtlInSeconds <Int32>] [-UniqueKeyPolicy <PSSqlUniqueKeyPolicy>] + [-ConflictResolutionPolicyMode <String>] [-ConflictResolutionPolicyPath <String>] + [-ConflictResolutionPolicyProcedure <String>] [-ConflictResolutionPolicy <PSSqlConflictResolutionPolicy>] + [-ClientEncryptionPolicy <PSSqlClientEncryptionPolicy>] [-AnalyticalStorageTtl <Int32>] + -ParentObject <PSSqlDatabaseGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB Sql Container. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBSqlContainer -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myContainerName -PartitionKeyPath /a/b/c -PartitionKeyKind Hash +``` + +```output +Name : myContainerName +Id : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName/contain + ers/myContainerName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetPropertiesResource +``` + +### Example 2: Create a new CosmosDB Sql Container with Client Encryption Policy +```powershell +$includedPath1 = [Microsoft.Azure.Management.CosmosDB.Models.ClientEncryptionIncludedPath]::new("/path1","key1","Deterministic","AEAD_AES_256_CBC_HMAC_SHA256"); +$includedPath2 = [Microsoft.Azure.Management.CosmosDB.Models.ClientEncryptionIncludedPath]::new("/path2","key2","Randomized","AEAD_AES_256_CBC_HMAC_SHA256"); +$listofIncludedPaths = New-Object Collections.Generic.List[Microsoft.Azure.Management.CosmosDB.Models.ClientEncryptionIncludedPath] +$listofIncludedPaths.Add($includedPath1) +$listofIncludedPaths.Add($includedPath2) +$newClientEncryptionPolicy = [Microsoft.Azure.Management.CosmosDB.Models.ClientEncryptionPolicy]::new($listofIncludedPaths, 2) +$newPSSqlClientEncryptionPolicy = [Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionPolicy]::new($newClientEncryptionPolicy) +New-AzCosmosDBSqlContainer -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myContainerName -PartitionKeyPath /a/b/c -PartitionKeyKind Hash -ClientEncryptionPolicy $newPSSqlClientEncryptionPolicy +``` + +```output +Name : myContainerName +Id : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName/contain + ers/myContainerName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnalyticalStorageTtl +TTL for Analytical Storage (in Seconds). + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientEncryptionPolicy +ClientEncryptionPolicy Object of type PSSqlClientEncryptionPolicy, when provided this is set as the ClientEncryptionPolicy of the container. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicy +ConflictResolutionPolicy Object of type PSSqlConflictResolutionPolicy, when provided this is set as the ConflictResolutionPolicy of the container. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlConflictResolutionPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicyMode +Can have the values: LastWriterWins, Custom, Manual. +If provided along with ConflictResolutionPolicy parameter, it is ignored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicyPath +To be provided when the type is LastWriterWins. +If provided along with ConflictResolutionPolicy parameter, it is ignored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicyProcedure +To be provided when the type is custom. +If provided along with ConflictResolutionPolicy parameter, it is ignored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IndexingPolicy +Indexing Policy Object of type Microsoft.Azure.Commands.CosmosDB.PSSqlIndexingPolicy. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlIndexingPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PartitionKeyKind +The kind of algorithm used for partitioning. +Possible values include: 'Hash', 'Range' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionKeyPath +Partition Key Path, e.g., '/address/zipcode'. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionKeyVersion +The version of the partition key definition + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of SQL container (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TtlInSeconds +Default Ttl in seconds. +If the value is missing or set to - 1, items don't expire. +If the value is set to n, items will expire n seconds after last modified time. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UniqueKeyPolicy +UniqueKeyPolicy Object of type Microsoft.Azure.Commands.CosmosDB.PSSqlUniqueKeyPolicy. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUniqueKeyPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlIndexingPolicy + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUniqueKeyPolicy + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlConflictResolutionPolicy + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ConflictingResourceException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlDatabase.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlDatabase.md new file mode 100644 index 0000000000..da577e855f --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlDatabase.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlDatabase.md +--- + +# New-AzCosmosDBSqlDatabase + +## SYNOPSIS +Creates a new CosmosDB Sql Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBSqlDatabase -ResourceGroupName <String> -AccountName <String> -Name <String> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBSqlDatabase -Name <String> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -ParentObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB Sql Database. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBSqlDatabase -AccountName myAccountName -Name myDatabaseName -ResourceGroupName myResourcegroupName +``` + +```output +Name : myDatabaseName +Id : /subscriptions/mySubscriptionId/resourceGroups/myResourcegroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of SQL database (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ConflictingResourceException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlIncludedPath.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlIncludedPath.md new file mode 100644 index 0000000000..6b122d64da --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlIncludedPath.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqlincludedpath +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlIncludedPath.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlIncludedPath.md +--- + +# New-AzCosmosDBSqlIncludedPath + +## SYNOPSIS +Creates a new object of type PSIncludedPath. It can be passed as a parameter value for Set-AzCosmosDBSqlContainer. + +## SYNTAX + +``` +New-AzCosmosDBSqlIncludedPath [-Path <String>] [-Index <PSIndexes[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Object corresponding to Sql API's IncludedPath. + +## EXAMPLES + +### Example 1 +```powershell +$index1 = New-AzCosmosDBSqlIncludedPathIndex -DataType String -Precision -1 -Kind Hash +$index2 = New-AzCosmosDBSqlIncludedPathIndex -DataType String -Precision -1 -Kind Hash + +New-AzCosmosDBSqlIncludedPath -Path "/*" -Index $index1,$index2 +``` + +```output +Path Indexes +---- ------- +/* {Microsoft.Azure.Commands.CosmosDB.Models.PSIndexes,Microsoft.Azure.Commands.CosmosDB.Models.PSIndexes} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Index +List of indexes for this path + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSIndexes[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path for which the indexing behavior applies to. +Index paths typically start with root and end with wildcard (/path/*) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSIncludedPath + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlIncludedPathIndex.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlIncludedPathIndex.md new file mode 100644 index 0000000000..7d061d3651 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlIncludedPathIndex.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqlincludedpathindex +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlIncludedPathIndex.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlIncludedPathIndex.md +--- + +# New-AzCosmosDBSqlIncludedPathIndex + +## SYNOPSIS +Creates a new object of type PSIndexes. It can be passed as a parameter value for Set-AzCosmosDBSqlIncludedPath. + +## SYNTAX + +``` +New-AzCosmosDBSqlIncludedPathIndex -DataType <String> [-Precision <Int32>] -Kind <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Object corresponding to Sql API's IncludedPath's Indexes. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBSqlIncludedPathIndex -DataType String -Precision -1 -Kind Hash +``` + +```output +DataType Precision Kind +-------- --------- ---- +String -1 Hash +``` + +## PARAMETERS + +### -DataType +Datatype for which the indexing behavior is applied to. +Possible values include: 'String', 'Number', 'Point', 'Polygon', 'LineString', 'MultiPolygon' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Indicates the type of index. +Possible values include: 'Hash', 'Range', 'Spatial' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Precision +The precision of the index. +-1 is maximum precision. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSIndexes + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlIndexingPolicy.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlIndexingPolicy.md new file mode 100644 index 0000000000..35bd044e76 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlIndexingPolicy.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqlindexingpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlIndexingPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlIndexingPolicy.md +--- + +# New-AzCosmosDBSqlIndexingPolicy + +## SYNOPSIS +Creates a new CosmosDB Sql IndexingPolicy object. + +## SYNTAX + +``` +New-AzCosmosDBSqlIndexingPolicy [-IncludedPath <PSIncludedPath[]>] [-SpatialSpec <PSSpatialSpec[]>] + [-CompositePath <PSCompositePath[][]>] [-ExcludedPath <String[]>] [-Automatic <Boolean>] + [-IndexingMode <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCosmosDBSqlIndexingPolicy** cmdlet creates a new object of type PSSqlIndexingPolicy. + +## EXAMPLES + +### Example 1 +```powershell +$ipath1 = New-AzCosmosDBSqlIncludedPathIndex -DataType String -Precision -1 -Kind Hash +$ipath2 = New-AzCosmosDBSqlIncludedPathIndex -DataType String -Precision -1 -Kind Hash +$IncludedPath = New-AzCosmosDBSqlIncludedPath -Path "/*" -Index $ipath1, $ipath2 +$SpatialSpec = New-AzCosmosDBSqlSpatialSpec -Path "/mySpatialPath/*" -Type "Point", "LineString", "Polygon", "MultiPolygon" +$cp1 = New-AzCosmosDBSqlCompositePath -Path "/abc" -Order Ascending +$cp2 = New-AzCosmosDBSqlCompositePath -Path "/aberc" -Order Descending +$compositePath = (($cp1, $cp2), ($cp2, $cp1)) +New-AzCosmosDBSqlIndexingPolicy -IncludedPath $IncludedPath -SpatialSpec $SpatialSpec -CompositePath $compositePath -ExcludedPath "/myPathToNotIndex/*" -Automatic 1 -IndexingMode Consistent +``` + +```output +Automatic : True +IndexingMode : Consistent +IncludedPaths : {Microsoft.Azure.Commands.CosmosDB.Models.PSIncludedPath} +ExcludedPaths : {Microsoft.Azure.Commands.CosmosDB.Models.PSExcludedPath} +CompositeIndexes : {Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath, + Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath} +SpatialIndexes : {Microsoft.Azure.Commands.CosmosDB.Models.PSSpatialSpec} +``` + +## PARAMETERS + +### -Automatic +Bool to indicate if the indexing policy is automatic + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompositePath +Array of array of objects of type Microsoft.Azure.Commands.CosmosDB.PSCompositePath + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath[][] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedPath +Array of strings containing excludedPath(Specifies a path within a JSON document to be excluded in the Azure Cosmos DB service.) elements. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedPath +Array of strings containing includedPath (Specifies a path within a JSON document to be included in the Azure Cosmos DB service.) elements. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSIncludedPath[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IndexingMode +indicates the indexing mode. +Possible values include: 'Consistent', 'Lazy', 'None' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpatialSpec +Array of objects of type Microsoft.Azure.Commands.CosmosDB.PSSpatialSpec + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSpatialSpec[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlIndexingPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlRoleAssignment.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlRoleAssignment.md new file mode 100644 index 0000000000..81d757c9f4 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlRoleAssignment.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqlroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlRoleAssignment.md +--- + +# New-AzCosmosDBSqlRoleAssignment + +## SYNOPSIS +Creates a new CosmosDB Sql Role Assignment. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzCosmosDBSqlRoleAssignment -ResourceGroupName <String> -AccountName <String> [-Id <String>] + -RoleDefinitionId <String> -Scope <String> -PrincipalId <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByNameParameterSet +``` +New-AzCosmosDBSqlRoleAssignment -ResourceGroupName <String> -AccountName <String> [-Id <String>] + -RoleDefinitionName <String> -Scope <String> -PrincipalId <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBSqlRoleAssignment [-Id <String>] -Scope <String> -PrincipalId <String> + -ParentObject <PSSqlRoleDefinitionGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB Sql Role Assignment. +Scope can be either fully qualified (ie. +/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/dbs/dbName) or start with the database name (ie. +/dbs/dbName). +RoleDefinitionId can be either fully qualified or just the Guid. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBSqlRoleAssignment ` + -AccountName accountName ` + -ResourceGroupName resourceGroupName ` + -RoleDefinitionId "/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/roleDefinitionId" ` + -Scope "/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName" ` + -PrincipalId principalId +``` + +```output +Id : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleAssignments/roleAssignmentId +Scope : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName +RoleDefinitionId : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/roleDefinitionId +PrincipalId : principalId +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role Assignment Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Role definition object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleDefinitionGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrincipalId +Guid Principal Id of the Role Assignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +Role Definition Id. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionName +Role Definition Name + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Scope. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleDefinitionGetResults +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleAssignmentGetResults +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlRoleDefinition.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlRoleDefinition.md new file mode 100644 index 0000000000..9e49dcaa2c --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlRoleDefinition.md @@ -0,0 +1,293 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqlroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlRoleDefinition.md +--- + +# New-AzCosmosDBSqlRoleDefinition + +## SYNOPSIS +Creates a new CosmosDB Sql Role Definition. + +## SYNTAX + +### ByFieldsDataActionsParameterSet (Default) +``` +New-AzCosmosDBSqlRoleDefinition -ResourceGroupName <String> -AccountName <String> [-Id <String>] + -RoleName <String> [-Type <String>] -AssignableScope <System.Collections.Generic.List`1[System.String]> + -DataAction <System.Collections.Generic.List`1[System.String]> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFieldsPermissionsParameterSet +``` +New-AzCosmosDBSqlRoleDefinition -ResourceGroupName <String> -AccountName <String> [-Id <String>] + -RoleName <String> [-Type <String>] -AssignableScope <System.Collections.Generic.List`1[System.String]> + -Permission <System.Collections.Generic.List`1[Microsoft.Azure.Commands.CosmosDB.Models.PSPermission]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectDataActionsParameterSet +``` +New-AzCosmosDBSqlRoleDefinition [-Id <String>] -RoleName <String> [-Type <String>] + -AssignableScope <System.Collections.Generic.List`1[System.String]> + -DataAction <System.Collections.Generic.List`1[System.String]> -ParentObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectPermissionsParameterSet +``` +New-AzCosmosDBSqlRoleDefinition [-Id <String>] -RoleName <String> [-Type <String>] + -AssignableScope <System.Collections.Generic.List`1[System.String]> + -Permission <System.Collections.Generic.List`1[Microsoft.Azure.Commands.CosmosDB.Models.PSPermission]> + -ParentObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB Sql Role Definition. +Assignable Scopes can be either fully qualified (ie. +/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/dbs/dbName) or start with the database name (ie. +/dbs/dbName). +In order to specify the Role Definition's Permissions, either use the DataAction parameter and pass in a list of strings that will be turned into a single Permission object, or use the New-AzCosmosDBPermission cmdlet to create PSPermission objects to pass in through the Permission parameter. + +## EXAMPLES + +### Example 1: Using DataAction +```powershell +New-AzCosmosDBSqlRoleDefinition ` + -AccountName accountName ` + -ResourceGroupName resourceGroupName ` + -Type CustomRole ` + -RoleName roleName ` + -DataAction "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create" ` + -AssignableScope "/" +``` + +```output +RoleName : roleName +Id : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/id +Type : CustomRole +Permissions : {Microsoft.Azure.Management.CosmosDB.Models.Permission} +AssignableScopes : {/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName} +``` + +### Example 2: Using Permission and ParentObject +```powershell +$DatabaseAccount = Get-AzCosmosDBAccount -Name accountName -ResourceGroupName resourceGroupName +$Permission = New-AzCosmosDBPermission -DataAction "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create" +New-AzCosmosDBSqlRoleDefinition ` + -Type CustomRole ` + -RoleName roleName ` + -Permission $Permission ` + -AssignableScope "/" ` + -ParentObject $DatabaseAccount +``` + +```output +RoleName : roleName +Id : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/id +Type : CustomRole +Permissions : {Microsoft.Azure.Management.CosmosDB.Models.Permission} +AssignableScopes : {/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName} +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByFieldsDataActionsParameterSet, ByFieldsPermissionsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignableScope +Set of resource paths below which a Role Assignment can be attached to the Role Definition. Eg. '/', '/dbs/dbname','/dbs/dbname/colls/collname'. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataAction +Set of data actions granted through the Role Definition. List of allowed actions can be found at: https://aka.ms/cosmos-native-rbac + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: ByFieldsDataActionsParameterSet, ByParentObjectDataActionsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role Assignment Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Role definition object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectDataActionsParameterSet, ByParentObjectPermissionsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Permission +Permission is a collection of data actions. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.CosmosDB.Models.PSPermission] +Parameter Sets: ByFieldsPermissionsParameterSet, ByParentObjectPermissionsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByFieldsDataActionsParameterSet, ByFieldsPermissionsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleName +Role Definition Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of Role Definition, either CustomRole or BuiltInRole. +Default value is CustomRole. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleDefinitionGetResults +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleDefinitionGetResults +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlSpatialSpec.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlSpatialSpec.md new file mode 100644 index 0000000000..766594d410 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlSpatialSpec.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqlspatialspec +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlSpatialSpec.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlSpatialSpec.md +--- + +# New-AzCosmosDBSqlSpatialSpec + +## SYNOPSIS +Creates a new object of type PSSpatialSpec. It can be passed as a parameter value for Set-AzCosmosDBSqlIndexingPolicy. + +## SYNTAX + +``` +New-AzCosmosDBSqlSpatialSpec -Path <String> -Type <String[]> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates Object corresponding to Sql API's SpatialSpec. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBSqlSpatialSpec -Path "/abc" -Type String +``` + +```output +Path Types +---- ----- +/abc {String} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Path in JSON document to index. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Array of strings with acceptable values: Point, LineString, Polygon, MultiPolygon. +Represent's paths spatial type. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSpatialSpec + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlStoredProcedure.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlStoredProcedure.md new file mode 100644 index 0000000000..2465154748 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlStoredProcedure.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqlstoredprocedure +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlStoredProcedure.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlStoredProcedure.md +--- + +# New-AzCosmosDBSqlStoredProcedure + +## SYNOPSIS +Creates a new CosmosDB Sql StoredProcedure. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBSqlStoredProcedure -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -ContainerName <String> -Name <String> -Body <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBSqlStoredProcedure -Name <String> -Body <String> -ParentObject <PSSqlContainerGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB Sql StoredProcedure. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBSqlStoredProcedure -AccountName MyAccountName -ResourceGroupName MyRgName -DatabaseName MyDatabaseName -ContainerName MyContainerName -Name mySprocrName -Body myBody +``` + +```output +Name : mySprocName +Id : /subscriptions/mySubId/resourceGroups/MyRgName/providers/Microsoft.DocumentDB/databaseAccounts/MyAccountName/sqlDatabases/MyDatabaseName/contain + ers/MyContainerName/storedProcedures/mySprocName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlStoredProcedureGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +The body of the Stored Procedure. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Container name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Stored Prcodecure Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlStoredProcedureGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ConflictingResourceException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlTrigger.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlTrigger.md new file mode 100644 index 0000000000..132d552ab6 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlTrigger.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqltrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlTrigger.md +--- + +# New-AzCosmosDBSqlTrigger + +## SYNOPSIS +Creates a new CosmosDB Sql Trigger. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBSqlTrigger -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -ContainerName <String> -Name <String> -Body <String> [-TriggerOperation <String>] [-TriggerType <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBSqlTrigger -Name <String> -Body <String> [-TriggerOperation <String>] [-TriggerType <String>] + -ParentObject <PSSqlContainerGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB Sql Trigger. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBSqlTrigger -AccountName MyAccountName -ResourceGroupName MyRgName -DatabaseName MyDatabaseName -ContainerName MyContainerName -Name myTriggerName -Body myTriggerBody -TriggerOperation All -TriggerType Pre +``` + +```output +Name : myTriggerName +Id : /subscriptions/mySubId/resourceGroups/MyRgName/providers/Microsoft.DocumentDB/databaseAccounts/MyAccountName/sqlDatabases/MyDatabaseName/contain + ers/MyContainerName/triggers/myTriggerName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlTriggerGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +The body of the Trigger. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Container name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Trigger name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerOperation +The operation the trigger is associated with. +Possible values include: 'All', 'Create', 'Update', 'Delete', 'Replace' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerType +Type of the Trigger. +Possible values include: 'Pre', 'Post' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlTriggerGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ConflictingResourceException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlUniqueKey.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlUniqueKey.md new file mode 100644 index 0000000000..f6ccfba150 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlUniqueKey.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqluniquekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlUniqueKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlUniqueKey.md +--- + +# New-AzCosmosDBSqlUniqueKey + +## SYNOPSIS +Creates a new CosmosDB Sql UniqueKey object. + +## SYNTAX + +``` +New-AzCosmosDBSqlUniqueKey -Path <String[]> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCosmosDBSqlUniqueKey** cmdlet creates a new object of type PSUniqueKey. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBSqlUniqueKey -Path "path" +``` + +```output +Path +---- +{path} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Array of string of path values + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUniqueKey + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlUniqueKeyPolicy.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlUniqueKeyPolicy.md new file mode 100644 index 0000000000..3c7f9b4ccf --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlUniqueKeyPolicy.md @@ -0,0 +1,83 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqluniquekeypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlUniqueKeyPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlUniqueKeyPolicy.md +--- + +# New-AzCosmosDBSqlUniqueKeyPolicy + +## SYNOPSIS +Creates a new CosmosDB SqlUniqueKeyPolicy object. + +## SYNTAX + +``` +New-AzCosmosDBSqlUniqueKeyPolicy -UniqueKey <PSSqlUniqueKey[]> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCosmosDBSqlUniqueKeyPolicy** cmdlet creates a new object of type PSSqlUniqueKeyPolicy. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBSqlUniqueKeyPolicy -UniqueKey $psUniqueKey1, $psUniqueKey2 +``` + +```output +UniqueKey +--------- +{Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUniqueKey, Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUniqueKey} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UniqueKey +Database name. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUniqueKey[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUniqueKeyPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlUserDefinedFunction.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlUserDefinedFunction.md new file mode 100644 index 0000000000..c6eba3581c --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBSqlUserDefinedFunction.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbsqluserdefinedfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlUserDefinedFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBSqlUserDefinedFunction.md +--- + +# New-AzCosmosDBSqlUserDefinedFunction + +## SYNOPSIS +Creates a new CosmosDB Sql UserDefinedFunction. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBSqlUserDefinedFunction -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -ContainerName <String> -Name <String> -Body <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBSqlUserDefinedFunction -Name <String> -Body <String> -ParentObject <PSSqlContainerGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB Sql UserDefinedFunction. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBSqlUserDefinedFunction -AccountName MyAccountName -ResourceGroupName MyRgName -DatabaseName MyDatabaseName -ContainerName MyContainerName -Name myUDFName -Body myBody +``` + +```output +Name : myTriggerName +Id : /subscriptions/mySubId/resourceGroups/MyRgName/providers/Microsoft.DocumentDB/databaseAccounts/MyAccountName/sqlDatabases/MyDatabaseName/contain + ers/MyContainerName/userDefinedFunctions/myUDFName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUserDefinedPropertiesGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +The body of the User Defined Function. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Container name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +User Defined Function Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUserDefinedFunctionGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ConflictingResourceException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBTable.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBTable.md new file mode 100644 index 0000000000..d4031fca74 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBTable.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbtable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBTable.md +--- + +# New-AzCosmosDBTable + +## SYNOPSIS +Creates a new CosmosDB Table. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDBTable -ResourceGroupName <String> -AccountName <String> -Name <String> [-Throughput <Int32>] + [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDBTable -Name <String> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -ParentObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB Table. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBTable -AccountName myAcccountName -Name myTableName -ResourceGroupName myRgName +``` + +```output +Name : myTableName +Id : /subscriptions/mySubscriptionId/resourceGroups/myResourcegroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/Tables/myTableName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSTableGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Table (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSTableGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ConflictingResourceException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBTableToRestore.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBTableToRestore.md new file mode 100644 index 0000000000..d763f872c3 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBTableToRestore.md @@ -0,0 +1,86 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbtabletorestore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBTableToRestore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBTableToRestore.md +--- + +# New-AzCosmosDBTableToRestore + +## SYNOPSIS +Creates a new CosmosDB Table to Restore object(PSTableToRestore) + +## SYNTAX + +``` +New-AzCosmosDBTableToRestore [-TableNames <String[]>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB TableToRestore object(PSTableToRestore). This returned object can be uses to speficy the subset of tables to restore. + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBTableToRestore -TableName table1,table2,table3 +``` + +```output +TableNames +--------------- +{table1, table2, table3} +``` + +Creates a new TableToRestore object with the table names table1, table2 and table3. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableNames +The names of the tables to be restored. +(If not provided, all the tables will be restored) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSTablesToRestore + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBVirtualNetworkRule.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBVirtualNetworkRule.md new file mode 100644 index 0000000000..dd06a145c4 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDBVirtualNetworkRule.md @@ -0,0 +1,98 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbvirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDBVirtualNetworkRule.md +--- + +# New-AzCosmosDBVirtualNetworkRule + +## SYNOPSIS +Create a new CosmosDB VirtualNetworkRule Object(PSVirtualNetworkRule). + +## SYNTAX + +``` +New-AzCosmosDBVirtualNetworkRule -Id <String> [-IgnoreMissingVNetServiceEndpoint <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new CosmosDB VirtualNetworkRule Object(PSVirtualNetworkRule). + +## EXAMPLES + +### Example 1 +```powershell +New-AzCosmosDBVirtualNetworkRule -Id "id" -IgnoreMissingVNetServiceEndpoint 0 +``` + +```output +Id IgnoreMissingVNetServiceEndpoint +-- -------------------------------- +{id} False +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreMissingVNetServiceEndpoint +Boolean to indicate if to create firewall rule before the virtual network has vnet service endpoint enabled. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSVirtualNetworkRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzCosmosDbClientEncryptionKey.md b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDbClientEncryptionKey.md new file mode 100644 index 0000000000..061ecdade6 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzCosmosDbClientEncryptionKey.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbclientencryptionkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDbClientEncryptionKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzCosmosDbClientEncryptionKey.md +--- + +# New-AzCosmosDbClientEncryptionKey + +## SYNOPSIS +Creates a new CosmosDB Client Encryption Key. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzCosmosDbClientEncryptionKey -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -Name <String> -EncryptionAlgorithmName <String> -KeyWrapMetadata <PSSqlKeyWrapMetadata> + [-KeyEncryptionKeyResolver <IKeyEncryptionKeyResolver>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzCosmosDbClientEncryptionKey -Name <String> -EncryptionAlgorithmName <String> + -KeyWrapMetadata <PSSqlKeyWrapMetadata> [-KeyEncryptionKeyResolver <IKeyEncryptionKeyResolver>] + -SqlDatabaseObject <PSSqlDatabaseGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCosmosDbClientEncryptionKey** creates a new CosmosDB Client Encryption Key. + +## EXAMPLES + +### Example 1 +```powershell +$myKeyWrapMetadataObject = [Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata]::new([Microsoft.Azure.Management.CosmosDB.Models.KeyWrapMetadata]::new("myKekV1","AZURE_KEY_VAULT", "https://contoso.vault.azure.net/keys/myKekV1/78deebed173b48e48f55abf87ed4cf71", "RSA-OAEP")) +New-AzCosmosDbClientEncryptionKey -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myClientEncryptionKeyName -EncryptionAlgorithmName "AEAD_AES_256_CBC_HMAC_SHA256" -KeyWrapMetadata $myKeyWrapMetadataObject +``` + +```output +Name : myContainerName +Id : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName/clientEncryptionKeys/myClientEncryptionKeyName +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetPropertiesResource +``` + +This example shows how a new key is created. If KeyEncryptionKeyResolver is not passed Azure Key Vault KeyResolver is used by default. +The first command creates a KeyWrapMetadata object with name myKekV1 of type AZURE_KEY_VAULT with value set to key id https://contoso.vault.azure.net/keys/myKekV1/78deebed173b48e48f55abf87ed4cf71 and algorithm type "RSA-OAEP" used to encrypt the key. +In the second command a new key is created with name as set in myClientEncryptionKeyName variable and with KeyWrapMetadata set to value returned by first command. + +### Example 2 +```powershell +$myKeyWrapMetadataObject = [Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata]::new([Microsoft.Azure.Management.CosmosDB.Models.KeyWrapMetadata]::new("myKekV1","AZURE_KEY_VAULT", "https://contoso.vault.azure.net/keys/myKekV1/78deebed173b48e48f55abf87ed4cf71", "RSA-OAEP")) +$azureKeyVaultKeyResolver = [Azure.Security.KeyVault.Keys.Cryptography.KeyResolver]::new([Azure.Identity.DefaultAzureCredential]::new()) +New-AzCosmosDbClientEncryptionKey -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myClientEncryptionKeyName -EncryptionAlgorithmName "AEAD_AES_256_CBC_HMAC_SHA256" -KeyWrapMetadata $myKeyWrapMetadataObject -KeyEncryptionKeyResolver $azureKeyVaultKeyResolver +``` + +```output +Name : myContainerName +Id : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName/clientEncryptionKeys/myClientEncryptionKeyName +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetPropertiesResource +``` + +This example shows how a new key is created and how KeyEncryptionKeyResolver can be passed as a parameter. +The first command creates a KeyWrapMetadata object with name myKekV1 of type AZURE_KEY_VAULT with value set to key id https://contoso.vault.azure.net/keys/myKekV1/78deebed173b48e48f55abf87ed4cf71 and algorithm type "RSA-OAEP" used to encrypt the key. +The second command creates a Azure Key Vault KeyResolver object using the Azure Default credentials. +In the third command a new key is created with name as set in myClientEncryptionKeyName variable, KeyWrapMetadata set to value returned by first command and KeyEncryptionKeyResolver value set to KeyResolver object obtained via the second command. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionAlgorithmName +Client Encryption Algorithm name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyResolver +IKeyEncryptionKeyResolver interface of type Azure.Core.Cryptography.IKeyEncryptionKeyResolver + +```yaml +Type: Azure.Core.Cryptography.IKeyEncryptionKeyResolver +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyWrapMetadata +KeyWrapMetaData Object of type Microsoft.Azure.Commands.CosmosDB.PSSqlKeyWrapMetadata. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Client Encryption Key name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClientEncryptionKeyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlDatabaseObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata + +### System.Byte[] + +### Microsoft.Data.Encryption.Cryptography.EncryptionKeyStoreProvider + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ConflictingResourceException + +## NOTES + +## RELATED LINKS + +[Get-AzCosmosDbClientEncryptionKey](./Get-AzCosmosDbClientEncryptionKey.md) + +[Update-AzCosmosDbClientEncryptionKey](./Update-AzCosmosDbClientEncryptionKey.md) diff --git a/azps-10.1.0/Az.CosmosDB/New-AzManagedCassandraCluster.md b/azps-10.1.0/Az.CosmosDB/New-AzManagedCassandraCluster.md new file mode 100644 index 0000000000..fad82ccd63 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzManagedCassandraCluster.md @@ -0,0 +1,324 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azmanagedcassandracluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzManagedCassandraCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzManagedCassandraCluster.md +--- + +# New-AzManagedCassandraCluster + +## SYNOPSIS +Creates a new Azure Managed Instances for Apache Cassandra cluster. + +## SYNTAX + +``` +New-AzManagedCassandraCluster -Location <String> -DelegatedManagementSubnetId <String> + [-InitialCassandraAdminPassword <String>] [-ClusterNameOverride <String>] [-RestoreFromBackupId <String>] + -ResourceGroupName <String> -ClusterName <String> [-Tag <Hashtable>] [-ExternalGossipCertificate <String[]>] + [-ClientCertificate <String[]>] [-RepairEnabled <Boolean>] [-TimeBetweenBackupInHours <Int32>] + [-AuthenticationMethod <String>] [-CassandraVersion <String>] [-ExternalSeedNode <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzManagedCassandraCluster** cmdlet creates a new managed Cassandra cluster. + +## EXAMPLES + +### Example 1 +```powershell +New-AzManagedCassandraCluster ` + -ResourceGroupName "resourceGroupName" ` + -ClusterName "clusterName" ` + -DelegatedManagementSubnetId "resourceId" ` + -Location "location" ` + -InitialCassandraAdminPassword "password" +``` + +## PARAMETERS + +### -AuthenticationMethod +How to authenticate clients, one of `Cassandra` (for password authentication), `Ldap` (for LDAP/AD authentication), or `None` (for no authentication required). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Cassandra +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CassandraVersion +Which version of Cassandra to run. Currently only 3.11 is supported. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 3.11 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientCertificate +The list of TLS certificates to use to authenticate clients. If this is omitted, all client connections still connect with TLS, but are not required to provide valid client certificates. If this is provided, clients most provide a valid TLS client certificate to connect to the cluster. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Name of the managed Cassandra cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterNameOverride +If the cluster name in `cassandra.yaml` needs to be different than the argument of `-ClusterName`, use this property to set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Same as -ClusterName +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelegatedManagementSubnetId +The resource id of the virtual network subnet where managed Cassandra should attach network interfaces. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalGossipCertificate +A list of additional TLS certificates the managed Cassandra cluster will use to authenticate gossip. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalSeedNode +List of IP addresses of external seed nodes to bridge this cluster to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialCassandraAdminPassword +The initial password for the admin account on the cluster if the cluster is using password auth. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location to create the managed Cassandra cluster in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepairEnabled +If true, managed Cassandra will run reaper to repair the database regularly. This should only be disabled for hybrid clusters which run their own repair process outside of Azure. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreFromBackupId +Resource id of backup to restore into this cluster. If omitted, creates a new, empty cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Hashtable of tags to set on the cluster resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeBetweenBackupInHours +Hours between taking full backups of the cluster. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/New-AzManagedCassandraDataCenter.md b/azps-10.1.0/Az.CosmosDB/New-AzManagedCassandraDataCenter.md new file mode 100644 index 0000000000..f006331049 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/New-AzManagedCassandraDataCenter.md @@ -0,0 +1,306 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azmanagedcassandradatacenter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzManagedCassandraDataCenter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/New-AzManagedCassandraDataCenter.md +--- + +# New-AzManagedCassandraDatacenter + +## SYNOPSIS +Create a new Azure Managed Instances for Apache Cassandra data center. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +New-AzManagedCassandraDatacenter -Location <String> -DelegatedSubnetId <String> [-Sku <String>] + [-DiskCapacity <Int32>] [-ManagedDiskCustomerKeyUri <String>] [-UseAvailabilityZone] + -ResourceGroupName <String> -ClusterName <String> -DatacenterName <String> [-NodeCount <Int32>] + [-Base64EncodedCassandraYamlFragment <String>] [-BackupStorageCustomerKeyUri <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzManagedCassandraDatacenter -Location <String> -DelegatedSubnetId <String> + -ParentObject <PSClusterResource> [-Sku <String>] [-DiskCapacity <Int32>] + [-ManagedDiskCustomerKeyUri <String>] [-UseAvailabilityZone] [-NodeCount <Int32>] + [-Base64EncodedCassandraYamlFragment <String>] [-BackupStorageCustomerKeyUri <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzManagedCassandraDataCenter** cmdlet creates a new managed Cassandra data center. + +## EXAMPLES + +### Example 1 +```powershell +New-AzManagedCassandraDataCenter ` + -ResourceGroupName "resourceGroupName" ` + -ClusterName "clusterName" ` + -DataCenterName "dataCenterName" ` + -DelegatedSubnetId "resourceId" ` + -Location "location" ` + -NodeCount 3 +``` + +## PARAMETERS + +### -BackupStorageCustomerKeyUri +URI to a KeyVault key used to encrypt backups of the cluster. If omitted, Azure's own keys will be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Base64EncodedCassandraYamlFragment +Fragment of configuration to include in `cassandra.yaml` on nodes of this data center, Base64 encoded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Name of the managed Cassandra cluster. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatacenterName +Managed Cassandra Datacenter Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelegatedSubnetId +The resource id of the virtual network subnet where managed Cassandra should attach network interfaces. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskCapacity +The number of data disks to connect to each node in the cluster. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 4 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location to create the managed Cassandra cluster in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedDiskCustomerKeyUri +URI of a KeyVault key used to encrypt data at rest in the cluster. If omitted, Azure's own keys will be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeCount +The number of nodes to create in this data center. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 3 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Cassandra cluster object to create a data center in. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +Name of the virtual machine sku to use for nodes in this data center. See the [documentation](https://learn.microsoft.com/en-us/azure/managed-instance-apache-cassandra/create-cluster-cli) for supported skus. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Standard_DS14_v2 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseAvailabilityZone +If set, allocate nodes in this data center using availability zones if they are supported in the region. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDataCenterResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBAccount.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBAccount.md new file mode 100644 index 0000000000..65ed233abf --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBAccount.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBAccount.md +--- + +# Remove-AzCosmosDBAccount + +## SYNOPSIS +Remove a Cosmos DB Account. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Remove-AzCosmosDBAccount -ResourceGroupName <String> -Name <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzCosmosDBAccount -ResourceId <String> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBAccount -InputObject <PSDatabaseAccountGetResults> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a Cosmos DB Account with a given Name in the given ResourceGroup. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBAccount -ResourceGroupName rg -Name dbname -PassThru +``` + +```output +True +``` + +The Account with account name dbname in ResourceGroup rg is deleted. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Database Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBCassandraKeyspace.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBCassandraKeyspace.md new file mode 100644 index 0000000000..68c40d1fd9 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBCassandraKeyspace.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbcassandrakeyspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBCassandraKeyspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBCassandraKeyspace.md +--- + +# Remove-AzCosmosDBCassandraKeyspace + +## SYNOPSIS +Deletes a CosmosDB Cassandra Keyspace. + +## SYNTAX + +### ByNameParameterSet +``` +Remove-AzCosmosDBCassandraKeyspace -AccountName <String> -Name <String> -ResourceGroupName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBCassandraKeyspace -InputObject <PSCassandraKeyspaceGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBCassandraKeyspace** cmdlet deletes an existing CosmosDB Cassandra Keyspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBCassandraKeyspace -ResourceGroupName "resourceGroupName" -AccountName "accountName" -Name "keyspaceName" +``` + +The cmdlet returns an object of type bool(when -PassThru is passed) which is true if the delete was successful. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Cassandra Keyspace object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Cassandra Keyspace Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBCassandraTable.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBCassandraTable.md new file mode 100644 index 0000000000..f1fdc1b2c2 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBCassandraTable.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbcassandratable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBCassandraTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBCassandraTable.md +--- + +# Remove-AzCosmosDBCassandraTable + +## SYNOPSIS +Deletes a CosmosDB Cassandra Table. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Remove-AzCosmosDBCassandraTable -ResourceGroupName <String> -AccountName <String> -KeyspaceName <String> + -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBCassandraTable -InputObject <PSCassandraTableGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBCassandraTable** delete a CosmosDB Cassandra Table. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBCassandraTable -ResourceGroupName "resourceGroupName" -AccountName "accountName" -KeyspaceName "keyspaceName" -Name "tableName" +``` + +The cmdlet returns an object of type bool(when -PassThru is passed) which is true, if the delete was successful. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Cassandra Table object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraTableGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyspaceName +Cassandra Keyspace Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cassandra Table Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraTableGetResults + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBGremlinDatabase.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBGremlinDatabase.md new file mode 100644 index 0000000000..b124114170 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBGremlinDatabase.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbgremlindatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBGremlinDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBGremlinDatabase.md +--- + +# Remove-AzCosmosDBGremlinDatabase + +## SYNOPSIS +Deletes a CosmosDB Gremlin Database. + +## SYNTAX + +### ByNameParameterSet +``` +Remove-AzCosmosDBGremlinDatabase -AccountName <String> -Name <String> -ResourceGroupName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBGremlinDatabase -InputObject <PSGremlinDatabaseGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBGremlinDatabase** cmdlet deletes a CosmosDB Gremlin Database. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBGremlinDatabase -ResourceGroupName "rgName" -AccountName "accountName" -Name "dbName" +``` + +The cmdlet returns an object of type bool(when -PassThru is passed) which is true, if the delete was successful. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gremlin Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBGremlinGraph.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBGremlinGraph.md new file mode 100644 index 0000000000..f4306c8b97 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBGremlinGraph.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbgremlingraph +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBGremlinGraph.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBGremlinGraph.md +--- + +# Remove-AzCosmosDBGremlinGraph + +## SYNOPSIS +Deletes a CosmosDB Gremlin Graph. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Remove-AzCosmosDBGremlinGraph -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBGremlinGraph -InputObject <PSGremlinGraphGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBGremlinGraph** cmdlet deletes a CosmosDB Gremlin Graph. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBGremlinGraph -ResourceGroupName "rgName" -AccountName "accountName" -DatabaseName "dbName" -Name "graphName" +``` + +The cmdlet returns an object of type bool(when -PassThru is passed) which is true, if the delete was successful. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gremlin Graph object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Gremlin Graph Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetResults + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBMongoDBCollection.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBMongoDBCollection.md new file mode 100644 index 0000000000..b697664ed3 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBMongoDBCollection.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbmongodbcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBCollection.md +--- + +# Remove-AzCosmosDBMongoDBCollection + +## SYNOPSIS +Deletes a CosmosDB MongoDB Collection. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Remove-AzCosmosDBMongoDBCollection -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBMongoDBCollection -InputObject <PSMongoDBCollectionGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBMongoDBCollection** cmdlet deletes a CosmosDB MongoDB Collection. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBMongoDBCollection -ResourceGroupName "rgName" -AccountName "accountName" -DatabaseName "dbName" -Name "collectionName" +``` + +The cmdlet returns an object of type bool(when -PassThru is passed) which is true, if the delete was successful. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Collection name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetResults + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBMongoDBDatabase.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBMongoDBDatabase.md new file mode 100644 index 0000000000..e155dcb842 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBMongoDBDatabase.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbmongodbdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBDatabase.md +--- + +# Remove-AzCosmosDBMongoDBDatabase + +## SYNOPSIS +Deletes a CosmosDB MongoDB Database. + +## SYNTAX + +### ByNameParameterSet +``` +Remove-AzCosmosDBMongoDBDatabase -AccountName <String> -Name <String> -ResourceGroupName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBMongoDBDatabase -InputObject <PSMongoDBDatabaseGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBMongoDBDatabase** cmdlet deletes a CosmosDB MongoDB Database. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBMongoDBDatabase -ResourceGroupName "rgName" -AccountName "accountName" -Name "dbName" +``` + +The cmdlet returns an object of type bool(when -PassThru is passed) which is true, if the delete was successful. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Mongo Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBMongoDBRoleDefinition.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBMongoDBRoleDefinition.md new file mode 100644 index 0000000000..8da66a5af7 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBMongoDBRoleDefinition.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbmongodbroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBRoleDefinition.md +--- + +# Remove-AzCosmosDBMongoDBDatabase + +## SYNOPSIS +Deletes a CosmosDB MongoDB Database. + +## SYNTAX + +### ByNameParameterSet +``` +Remove-AzCosmosDBMongoDBDatabase -AccountName <String> -Name <String> -ResourceGroupName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBMongoDBDatabase -InputObject <PSMongoDBDatabaseGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBMongoDBDatabase** cmdlet deletes a CosmosDB MongoDB Database. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBMongoDBDatabase -ResourceGroupName "rgName" -AccountName "accountName" -Name "dbName" +``` + +The cmdlet returns an object of type bool(when -PassThru is passed) which is true, if the delete was successful. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Mongo Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBMongoDBUserDefinition.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBMongoDBUserDefinition.md new file mode 100644 index 0000000000..2367cc9cf3 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBMongoDBUserDefinition.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbmongodbuserdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBUserDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBUserDefinition.md +--- + +# Remove-AzCosmosDBMongoDBUserDefinition + +## SYNOPSIS +Deletes an existing CosmosDB MongoDB User Definition. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Remove-AzCosmosDBMongoDBUserDefinition -ResourceGroupName <String> -AccountName <String> -Id <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzCosmosDBMongoDBUserDefinition -Id <String> -DatabaseAccountObject <PSDatabaseAccountGetResults> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBMongoDBUserDefinition -Id <String> -InputObject <PSMongoDBUserDefinitionGetResults> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBMongoDBUserDefinition** cmdlet deletes an existing CosmosDB MongoDB User Definition. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBMongoDBUserDefinition -ResourceGroupName rgName -AccountName accountName -Id userDefId +``` + +The cmdlet returns an object of type bool(when -PassThru is passed) which is true, if the delete was successful. + +### Example 2 +```powershell +$UserDef = Get-AzCosmosDBMongoDBUserDefinition -AccountName accountName -ResourceGroupName resourceGroupName -Id id + +Remove-AzCosmosDBMongoDBUserDefinition -InputObject $UserDef +``` + +The cmdlet returns an object of type bool(when -PassThru is passed) which is true, if the delete was successful. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseAccountObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Mongo User Definition ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSMongoDBUserDefinitionGetResults Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoDBUserDefinitionGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBUserDefinitionGetResults + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzCosmosDBMongoDBUserDefinition](./Get-AzCosmosDBMongoDBUserDefinition.md) + +[New-AzCosmosDBMongoDBUserDefinition](./New-AzCosmosDBMongoDBUserDefinition.md) + +[Update-AzCosmosDBMongoDBUserDefinition](./Update-AzCosmosDBMongoDBUserDefinition.md) diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBService.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBService.md new file mode 100644 index 0000000000..d34af04ff6 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBService.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBService.md +--- + +# Remove-AzCosmosDBService + +## SYNOPSIS +Deletes the CosmosDB Service. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Remove-AzCosmosDBService -ResourceGroupName <String> -AccountName <String> -ServiceName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBService -ServiceName <String> -InputObject <PSServiceGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBService** cmdlet deletes the CosmosDB Service. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBService -ResourceGroupName "ResourceGroup" -AccountName "AccountName" -ServiceName "ServiceName" +``` + +The cmdlet returns an object of type bool(when -PassThru is passed) which is true, if the delete was successful. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSServiceGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Name of the service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSServiceGetResults + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlContainer.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlContainer.md new file mode 100644 index 0000000000..a22647b900 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlContainer.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbsqlcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlContainer.md +--- + +# Remove-AzCosmosDBSqlContainer + +## SYNOPSIS +Deletes the CosmosDB Sql Container. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Remove-AzCosmosDBSqlContainer -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBSqlContainer -InputObject <PSSqlContainerGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBSqlContainer** cmdlet deletes the CosmosDB Sql Container corresponding to the given ResourceGroupName, AccountName, DatabaseName and ContainerName. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBSqlContainer -ResourceGroupName "resourceGroupName" -AccountName "accountName" -DatabaseName "databaseName" -Name "containerName" +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlDatabase.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlDatabase.md new file mode 100644 index 0000000000..e43876f1a8 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlDatabase.md @@ -0,0 +1,178 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbsqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlDatabase.md +--- + +# Remove-AzCosmosDBSqlDatabase + +## SYNOPSIS +Deletes the CosmosDB Sql Database. + +## SYNTAX + +### ByNameParameterSet +``` +Remove-AzCosmosDBSqlDatabase -AccountName <String> -Name <String> -ResourceGroupName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBSqlDatabase -InputObject <PSSqlDatabaseGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBSqlDatabase** cmdlet deletes the CosmosDB Sql Database corresponding to the given ResourceGroupName, AccountName and DatabaseName. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBSqlDatabase -ResourceGroupName "resourceGroupName" -AccountName "accountName" -Name "databaseName" +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlRoleAssignment.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlRoleAssignment.md new file mode 100644 index 0000000000..3baaa55ce1 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlRoleAssignment.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbsqlroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlRoleAssignment.md +--- + +# Remove-AzCosmosDBSqlRoleAssignment + +## SYNOPSIS +Deletes the CosmosDB Sql Role Assignment. + +## SYNTAX + +### ByResourceIdParameterSet (Default) +``` +Remove-AzCosmosDBSqlRoleAssignment -ResourceGroupName <String> -AccountName <String> -Id <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzCosmosDBSqlRoleAssignment -Id <String> -ParentObject <PSDatabaseAccountGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBSqlRoleAssignment -InputObject <PSSqlRoleAssignmentGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzCosmosDBSqlRoleAssignment cmdlet deletes the CosmosDB Sql Role Assignment corresponding to the given ResourceGroupName, AccountName and Id. +Id can be either fully qualified or just the Guid. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBSqlRoleAssignment -ResourceGroupName resourceGroupName -AccountName accountName -Id id -PassThru +``` + +```output +true +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role Assignment Id. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet, ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Role assignment object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleAssignmentGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```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 +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleAssignmentGetResults +## OUTPUTS + +### System.Void +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlRoleDefinition.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlRoleDefinition.md new file mode 100644 index 0000000000..cd08ccd7ef --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlRoleDefinition.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbsqlroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlRoleDefinition.md +--- + +# Remove-AzCosmosDBSqlRoleDefinition + +## SYNOPSIS +Deletes the CosmosDB Sql Role Definition. + +## SYNTAX + +### ByResourceIdParameterSet (Default) +``` +Remove-AzCosmosDBSqlRoleDefinition -ResourceGroupName <String> -AccountName <String> -Id <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzCosmosDBSqlRoleDefinition -Id <String> -ParentObject <PSDatabaseAccountGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBSqlRoleDefinition -InputObject <PSSqlRoleDefinitionGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzCosmosDBSqlRoleDefinition cmdlet deletes the CosmosDB Sql Role Definition corresponding to the given ResourceGroupName, AccountName and Id. +Id can be either fully qualified or just the Guid. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBSqlRoleDefinition -ResourceGroupName resourceGroupName -AccountName accountName -Id id -PassThru +``` + +```output +true +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role Definition Id. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet, ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Role definition object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleDefinitionGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```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 +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleDefinitionGetResults +## OUTPUTS + +### System.Void +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlStoredProcedure.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlStoredProcedure.md new file mode 100644 index 0000000000..f1082149c6 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlStoredProcedure.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbsqlstoredprocedure +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlStoredProcedure.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlStoredProcedure.md +--- + +# Remove-AzCosmosDBSqlStoredProcedure + +## SYNOPSIS +Deletes the CosmosDB Sql StoredProcedure. + +## SYNTAX + +### ByNameParameterSet +``` +Remove-AzCosmosDBSqlStoredProcedure -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -ContainerName <String> -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBSqlStoredProcedure -InputObject <PSSqlStoredProcedureGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBSqlStoredProcedure** cmdlet deletes the CosmosDB Sql StoredProcedure corresponding to the given ResourceGroupName, AccountName and DatabaseName. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBSqlStoredProcedure -ResourceGroupName "resourceGroupName" -AccountName "accountName" -DatabaseName "databaseName" -ContainerName "containerName" -Name "storedProcedureName" +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Container name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlStoredProcedureGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Stored Prcodecure Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlTrigger.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlTrigger.md new file mode 100644 index 0000000000..55b6b75cae --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlTrigger.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbsqltrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlTrigger.md +--- + +# Remove-AzCosmosDBSqlTrigger + +## SYNOPSIS +Deletes the CosmosDB Sql Trigger. + +## SYNTAX + +### ByNameParameterSet +``` +Remove-AzCosmosDBSqlTrigger -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -ContainerName <String> -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBSqlTrigger -InputObject <PSSqlTriggerGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBSqlTrigger** cmdlet deletes the CosmosDB Sql Trigger corresponding to the given ResourceGroupName, AccountName and DatabaseName. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBSqlTrigger -ResourceGroupName "resourceGroupName" -AccountName "accountName" -DatabaseName "databaseName" -ContainerName "containerName" -Name "triggerName" +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Container name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql trigger Object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlTriggerGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Trigger name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlUserDefinedFunction.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlUserDefinedFunction.md new file mode 100644 index 0000000000..663bf30096 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBSqlUserDefinedFunction.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbsqluserdefinedfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlUserDefinedFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBSqlUserDefinedFunction.md +--- + +# Remove-AzCosmosDBSqlUserDefinedFunction + +## SYNOPSIS +Deletes the CosmosDB Sql UserDefinedFunction. + +## SYNTAX + +### ByNameParameterSet +``` +Remove-AzCosmosDBSqlUserDefinedFunction -ResourceGroupName <String> -AccountName <String> + -DatabaseName <String> -ContainerName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBSqlUserDefinedFunction -InputObject <PSSqlUserDefinedFunctionGetResults> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBSqlUserDefinedFunction** cmdlet deletes the CosmosDB Sql UserDefinedFunction corresponding to the given ResourceGroupName, AccountName and DatabaseName. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBSqlUserDefinedFunction -ResourceGroupName "resourceGroupName" -AccountName "accountName" -DatabaseName "databaseName" -ContainerName "containerName" -Name "userDefinedFunctionName" +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Container name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql User Defined Function Object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUserDefinedFunctionGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +User Defined Function Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBTable.md b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBTable.md new file mode 100644 index 0000000000..fa8bbc55a1 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzCosmosDBTable.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbtable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBTable.md +--- + +# Remove-AzCosmosDBTable + +## SYNOPSIS +Deletes the CosmosDB Table. + +## SYNTAX + +### ByNameParameterSet +``` +Remove-AzCosmosDBTable -AccountName <String> -Name <String> -ResourceGroupName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzCosmosDBTable -InputObject <PSTableGetResults> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCosmosDBTable** cmdlet deletes the CosmosDB Table. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCosmosDBTable -AccountName "account" -Name "tableName" -ResourceGroupName "rgName" +``` + +The cmdlet returns an object of type bool(when -PassThru is passed) which is true, if the delete was successful. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSTableGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Table. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. +The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSTableGetResults + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzManagedCassandraCluster.md b/azps-10.1.0/Az.CosmosDB/Remove-AzManagedCassandraCluster.md new file mode 100644 index 0000000000..4effe43953 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzManagedCassandraCluster.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azmanagedcassandracluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzManagedCassandraCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzManagedCassandraCluster.md +--- + +# Remove-AzManagedCassandraCluster + +## SYNOPSIS +Deletes a Azure Managed Instances for Apache Cassandra cluster. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Remove-AzManagedCassandraCluster -ResourceGroupName <String> -ClusterName <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzManagedCassandraCluster -ResourceId <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzManagedCassandraCluster -InputObject <PSClusterResource> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzManagedCassandraCluster** cmdlet deletes a managed Cassandra cluster and all data centers in it. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzManagedCassandraCluster ` + -ResourceGroupName "resourceGroupName" ` + -ClusterName "clusterName" +``` + +### Example 2 +```powershell +Remove-AzManagedCassandraCluster -ResourceId "clusterResourceId" +``` + +### Example 3 +```powershell +$clusterResource | Remove-AzManagedCassandraCluster +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Name of the managed Cassandra cluster. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +A cluster object to remove. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource id of the managed Cassandra cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Remove-AzManagedCassandraDataCenter.md b/azps-10.1.0/Az.CosmosDB/Remove-AzManagedCassandraDataCenter.md new file mode 100644 index 0000000000..7bebed6436 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Remove-AzManagedCassandraDataCenter.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azmanagedcassandradatacenter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzManagedCassandraDataCenter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzManagedCassandraDataCenter.md +--- + +# Remove-AzManagedCassandraDatacenter + +## SYNOPSIS +Deletes a Azure Managed Instances for Apache Cassandra data center. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Remove-AzManagedCassandraDatacenter -ResourceGroupName <String> -ClusterName <String> -DataCenterName <String> + [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzManagedCassandraDatacenter -ResourceId <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzManagedCassandraDatacenter -InputObject <PSDataCenterResource> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzManagedCassandraDatacenter [-AsJob] [-PassThru] -ParentObject <PSClusterResource> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzManagedCassandraDataCenter** cmdlet deletes a managed Cassandra data center. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzManagedCassandraDataCenter ` + -ResourceGroupName "resourceGroupName" ` + -ClusterName "clusterName" ` + -DataCenterName "dataCenterName" +``` + +### Example 2 +```powershell +Remove-AzManagedCassandraDataCenter -ResourceId "dataCenterResourceId" +``` + +### Example 3 +```powershell +$dataCenterResource | Remove-AzManagedCassandraDataCenter +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Name of the managed Cassandra cluster. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataCenterName +Name of the managed Cassandra data center. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Managed Cassandra data center object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDataCenterResource +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentObject +Managed Cassandra Cluster object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +To be set to true if the user wants to receive an output. The output is true if the operation was successful and an error is thrown if not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource id of the managed Cassandra DataCenter. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDataCenterResource + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Restore-AzCosmosDBAccount.md b/azps-10.1.0/Az.CosmosDB/Restore-AzCosmosDBAccount.md new file mode 100644 index 0000000000..b2e6f11ed6 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Restore-AzCosmosDBAccount.md @@ -0,0 +1,269 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/restore-azcosmosdbaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Restore-AzCosmosDBAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Restore-AzCosmosDBAccount.md +--- + +# Restore-AzCosmosDBAccount + +## SYNOPSIS +Restores an existing CosmosDB account (live or deleted) to a given timestamp to a new account + +## SYNTAX + +``` +Restore-AzCosmosDBAccount -RestoreTimestampInUtc <DateTime> -SourceDatabaseAccountName <String> + -Location <String> -TargetResourceGroupName <String> -TargetDatabaseAccountName <String> + [-DatabasesToRestore <PSDatabaseToRestore[]>] [-GremlinDatabasesToRestore <PSGremlinDatabaseToRestore[]>] + [-TablesToRestore <PSTablesToRestore>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new CosmosDB account by restoring an existing account with the given name and timestamp. + +## EXAMPLES + +### Example 1 +```powershell +Restore-AzCosmosDBAccount -TargetResourceGroupName resourceGroupName -TargetDatabaseAccountName restored-account-name -SourceDatabaseAccountName sourceDatabaseAccountName -RestoreTimestampInUtc 2020-07-20T17:19:25+0000 -Location "West US" +``` + +```output +Id : /subscriptions/259fbb24-9bcd-4cfc-865c-fc33b22fe38a/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/restored-account-name +Name : restored-account-name +InstanceId : eeb45f7f-4c05-4b52-9f42-6807d8eb8703 +Location : West US +Tags : {} +EnableCassandraConnector : +EnableMultipleWriteLocations : False +VirtualNetworkRules : {} +FailoverPolicies : {restored-account-name-westus} +Locations : {restored-account-name-westus} +ReadLocations : {restored-account-name-westus} +WriteLocations : {restored-account-name-westus} +Capabilities : {} +ConsistencyPolicy : Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy +EnableAutomaticFailover : False +IsVirtualNetworkFilterEnabled : False +IpRules : {} +DatabaseAccountOfferType : Standard +DocumentEndpoint : https://restored-account-name.documents.azure.com:443/ +ProvisioningState : Succeeded +Kind : GlobalDocumentDB +ConnectorOffer : +DisableKeyBasedMetadataWriteAccess : False +PublicNetworkAccess : Enabled +KeyVaultKeyUri : +PrivateEndpointConnections : +EnableFreeTier : False +ApiProperties : Microsoft.Azure.Commands.CosmosDB.Models.PSApiProperties +EnableAnalyticalStorage : False +BackupPolicy : Microsoft.Azure.Commands.CosmosDB.Models.PSBackupPolicy +RestoreParameters : Microsoft.Azure.Commands.CosmosDB.Models.PSRestoreParameters +CreateMode : Restore +``` + +{{ Creates a new CosmosDB account by restoring an existing account with the given name and timestamp. }} + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabasesToRestore +The list of PSDatabaseToRestore objects which specify the subset of databases and collections to restore from the source account. (If not provided, all the databases will be restored) + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseToRestore[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GremlinDatabasesToRestore +The list of PSGremlinDatabaseToRestore objects which specify the subset of databases and graphs to restore from the source account. (If not provided, all the databases will be restored) + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseToRestore[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the source account from which restore is triggered. +This will also be the write region of the restored account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreTimestampInUtc +The timestamp to which the source account has to be restored to. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDatabaseAccountName +The name of the source database account of the restore. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TablesToRestore +The list of PSTableToRestore objects which specify the subset of tables to restore from the source account. (If not provided, all the tables will be restored) + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSTablesToRestore +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDatabaseAccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBAccount.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBAccount.md new file mode 100644 index 0000000000..e4a6b256f7 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBAccount.md @@ -0,0 +1,599 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBAccount.md +--- + +# Update-AzCosmosDBAccount + +## SYNOPSIS +Update a Cosmos DB Account attributes. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBAccount [-EnableAutomaticFailover <Boolean>] [-EnableMultipleWriteLocations <Boolean>] + [-EnableVirtualNetwork <Boolean>] [-DisableKeyBasedMetadataWriteAccess <Boolean>] -ResourceGroupName <String> + -Name <String> [-DefaultConsistencyLevel <String>] [-IpRule <String[]>] + [-MaxStalenessIntervalInSeconds <Int32>] [-MaxStalenessPrefix <Int32>] [-Tag <Hashtable>] + [-VirtualNetworkRule <String[]>] [-VirtualNetworkRuleObject <PSVirtualNetworkRule[]>] + [-PublicNetworkAccess <String>] [-KeyVaultKeyUri <String>] [-EnableAnalyticalStorage <Boolean>] [-AsJob] + [-NetworkAclBypass <String>] [-NetworkAclBypassResourceId <String[]>] [-ServerVersion <String>] + [-BackupIntervalInMinutes <Int32>] [-BackupRetentionIntervalInHours <Int32>] + [-BackupStorageRedundancy <String>] [-BackupPolicyType <String>] [-ContinuousTier <String>] [-AnalyticalStorageSchemaType <String>] [-EnablePartitionMerge <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzCosmosDBAccount -ResourceId <String> [-EnableAutomaticFailover <Boolean>] + [-EnableMultipleWriteLocations <Boolean>] [-EnableVirtualNetwork <Boolean>] + [-DisableKeyBasedMetadataWriteAccess <Boolean>] [-DefaultConsistencyLevel <String>] [-IpRule <String[]>] + [-MaxStalenessIntervalInSeconds <Int32>] [-MaxStalenessPrefix <Int32>] [-Tag <Hashtable>] + [-VirtualNetworkRule <String[]>] [-VirtualNetworkRuleObject <PSVirtualNetworkRule[]>] + [-PublicNetworkAccess <String>] [-KeyVaultKeyUri <String>] [-EnableAnalyticalStorage <Boolean>] [-AsJob] + [-NetworkAclBypass <String>] [-NetworkAclBypassResourceId <String[]>] [-ServerVersion <String>] + [-BackupIntervalInMinutes <Int32>] [-BackupRetentionIntervalInHours <Int32>] + [-BackupStorageRedundancy <String>] [-BackupPolicyType <String>] [-ContinuousTier <String>] [-AnalyticalStorageSchemaType <String>] [-EnablePartitionMerge <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBAccount -InputObject <PSDatabaseAccountGetResults> [-EnableAutomaticFailover <Boolean>] + [-EnableMultipleWriteLocations <Boolean>] [-EnableVirtualNetwork <Boolean>] + [-DisableKeyBasedMetadataWriteAccess <Boolean>] [-DefaultConsistencyLevel <String>] [-IpRule <String[]>] + [-MaxStalenessIntervalInSeconds <Int32>] [-MaxStalenessPrefix <Int32>] [-Tag <Hashtable>] + [-VirtualNetworkRule <String[]>] [-VirtualNetworkRuleObject <PSVirtualNetworkRule[]>] + [-PublicNetworkAccess <String>] [-KeyVaultKeyUri <String>] [-EnableAnalyticalStorage <Boolean>] [-AsJob] + [-NetworkAclBypass <String>] [-NetworkAclBypassResourceId <String[]>] [-ServerVersion <String>] + [-BackupIntervalInMinutes <Int32>] [-BackupRetentionIntervalInHours <Int32>] + [-BackupStorageRedundancy <String>] [-BackupPolicyType <String>] [-ContinuousTier <String>] [-AnalyticalStorageSchemaType <String>] [-EnablePartitionMerge <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update the properties of a CosmosDB account. Cannot update Account Regions simulataneously with other properties. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBAccount -ResourceGroupName resourceGroupName -Name accountName -DefaultConsistencyLevel "Strong" -EnableAutomaticFailover 1 -EnableMultipleWriteLocations 1 -EnableVirtualNetwork 1 +``` + +```output +Kind : GlobalDocumentDB +ProvisioningState : Initializing +DocumentEndpoint : +DatabaseAccountOfferType : Standard +IpRangeFilter : +IsVirtualNetworkFilterEnabled : True +EnableAutomaticFailover : True +ConsistencyPolicy : Microsoft.Azure.Management.CosmosDB.Fluent.Models.ConsistencyPolicy +Capabilities : {} +WriteLocations : {accountName-eastus} +ReadLocations : {accountName-eastus} +FailoverPolicies : {accountName-eastus} +VirtualNetworkRules : {} +EnableMultipleWriteLocations : True +Location : East US +Tags : {} +Id : /subscriptions/{subscriptionid}/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName +Name : accountName +Type : Microsoft.DocumentDB/databaseAccounts +NetworkAclBypass : None +NetworkAclBypassResourceIds : {} +``` + +Updated DefaultConsistencyLevel to "Strong", Enabled AutomaticFailover, Enabled MultipleWriteLocations and Enabled VirtualNetwork for Cosmos DB Account with name accountName. + +## PARAMETERS + +### -AnalyticalStorageSchemaType +The schema type for analytical storage. Valid values include: 'WellDefined' and 'FullFidelity'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupIntervalInMinutes +The interval(in minutes) with which backup are taken (only for accounts with periodic mode backups) + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupPolicyType +The type of backups on the Cosmos DB account. Accepted values: Periodic, Continuous + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionIntervalInHours +The time(in hours) for which each backup is retained (only for accounts with periodic mode backups) + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupStorageRedundancy +The redundancy type of the backup Storage account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinuousTier +The tier of continuous backups mode on the Cosmos DB account. Accepted values: Continuous7Days, Continuous30Days + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConsistencyLevel +Default consistency level of the Cosmos DB database account. +Accepted values: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableKeyBasedMetadataWriteAccess +Disable write operations on metadata resources (databases, containers, throughput) via account keys + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAnalyticalStorage +Bool to indicate if AnalyticalStorage is enabled on the account. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutomaticFailover +Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. +Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account. +Accepted values: false, true + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePartitionMerge +Enable Partition Merge on Account +Accepted values: false, true + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMultipleWriteLocations +Enable Multiple Write Locations. +Accepted values: false, true + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableVirtualNetwork +Enables virtual network on the Cosmos DB database account. +Accepted values: false, true + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Cosmos DB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IpRule +Firewall support. Specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultKeyUri +URI of the KeyVault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxStalenessIntervalInSeconds +When used with Bounded Staleness consistency, this value represents the time amount of staleness (in timespan) tolerated. +Accepted range for this value is 5-86400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxStalenessPrefix +When used with Bounded Staleness consistency, this value represents the number of stale requests tolerated. +Accepted range for this value is 1 - 2,147,483,647. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkAclBypass +Whether or not Network Acl Bypass is enabled for this account for Synapse Link. Possible values include: 'None', 'AzureServices'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkAclBypassResourceId +List of Resource Ids to allow Network Acl Bypass for Synapse Link. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Whether or not public endpoint access is allowed for this server. Possible values include: 'Enabled', 'Disabled' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerVersion +ServerVersion, valid only in case of MongoDB Accounts. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Hashtable of tags as key-value pairs. +Use empty string to clear existing tag. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRule +Array of string values of ACL's for virtual network. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRuleObject +Array of PSVirtualNetworkRuleObjects for virtual network. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSVirtualNetworkRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBAccountFailoverPriority.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBAccountFailoverPriority.md new file mode 100644 index 0000000000..05ef4926a3 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBAccountFailoverPriority.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbaccountfailoverpriority +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBAccountFailoverPriority.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBAccountFailoverPriority.md +--- + +# Update-AzCosmosDBAccountFailoverPriority + +## SYNOPSIS +Update Failover Region Priority of a Cosmos DB Account. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBAccountFailoverPriority -ResourceGroupName <String> -Name <String> -FailoverPolicy <String[]> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzCosmosDBAccountFailoverPriority -ResourceId <String> -FailoverPolicy <String[]> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBAccountFailoverPriority -FailoverPolicy <String[]> -InputObject <PSDatabaseAccountGetResults> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update Failover Region Priority of a Cosmos DB Account. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBAccountFailoverPriority -ResourceGroupName rg -Name dbname -FailoverPolicy "region1", "region2", "region3" +``` + +```output +Id : /subscriptions/{subscriptionid}/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/dbname +Name : dbname +Location : region1 +Tags : {} +EnableCassandraConnector : +EnableMultipleWriteLocations : True +VirtualNetworkRules : {} +FailoverPolicies : {dbname-region1, dbname-region2, dbname-region3} +Locations : {dbname-region1, dbname-region2, dbname-region3} +ReadLocations : {dbname-region1, dbname-region2, dbname-region3} +WriteLocations : {dbname-region1} +Capabilities : {} +ConsistencyPolicy : Microsoft.Azure.Management.CosmosDB.Fluent.Models.ConsistencyPolicy +EnableAutomaticFailover : False +IsVirtualNetworkFilterEnabled : False +IpRules : {} +DatabaseAccountOfferType : Standard +DocumentEndpoint : https://dbname.documents.azure.com:443/ +ProvisioningState : Succeeded +Kind : GlobalDocumentDB +``` + +FailoverPolicies updated with region1 as FailoverPriority 1, region2 as FailoverPriority 2 and region3 as FailoverPriority 3. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverPolicy +Array of strings having region names, ordered by failover priority. +E.g eastus, westus + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Cosmos DB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBAccountRegion.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBAccountRegion.md new file mode 100644 index 0000000000..fd6ac1747e --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBAccountRegion.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbaccountregion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBAccountRegion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBAccountRegion.md +--- + +# Update-AzCosmosDBAccountRegion + +## SYNOPSIS +Update Regions of a Cosmos DB Account. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBAccountRegion -ResourceGroupName <String> -Name <String> [-Location <String[]>] + [-LocationObject <PSLocation[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzCosmosDBAccountRegion [-Location <String[]>] [-LocationObject <PSLocation[]>] -ResourceId <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBAccountRegion [-Location <String[]>] [-LocationObject <PSLocation[]>] + -InputObject <PSDatabaseAccountGetResults> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update Regions of a Cosmos DB Account. Location can be provided either as an object of type PSLocation or as strings of Location Name ordered by failover priority. +LocationObject parameter expects the list of current locations (failover priorities included) appended by the new LocationObjects corresponding to new locations to be added. +Location parameter expects the list of current location(ordered by failover priority) and the new locations. +Please note, we only support Addition of Regions. Please provide either Location or LocationObject. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBAccountRegion -ResourceGroupName rg -Name dbname -Location "location1", "location2" +``` + +```output +Id : /subscriptions/{subscriptionid}/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/dbname +Name : dbname +Location : location1 +Tags : {} +EnableCassandraConnector : +EnableMultipleWriteLocations : True +VirtualNetworkRules : {} +FailoverPolicies : {dbname-location1, dbname-location2} +Locations : {dbname-location1, dbname-location2} +ReadLocations : {dbname-location1, dbname-location2} +WriteLocations : {dbname-location1} +Capabilities : {} +ConsistencyPolicy : Microsoft.Azure.Management.CosmosDB.Fluent.Models.ConsistencyPolicy +EnableAutomaticFailover : False +IsVirtualNetworkFilterEnabled : False +IpRules : {} +DatabaseAccountOfferType : Standard +DocumentEndpoint : https://dbname.documents.azure.com:443/ +ProvisioningState : Succeeded +Kind : GlobalDocumentDB +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +ResourceId of the resource. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Name of the location to be added. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationObject +Add a location to the Cosmos DB database account. Array of PSLocation objects. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSLocation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBCassandraKeyspace.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBCassandraKeyspace.md new file mode 100644 index 0000000000..38f6103998 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBCassandraKeyspace.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbcassandrakeyspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBCassandraKeyspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBCassandraKeyspace.md +--- + +# Update-AzCosmosDBCassandraKeyspace + +## SYNOPSIS +Updates the CosmosDB Cassandra Keyspace. Performs a client side patch operation by reading the existing Keyspace. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBCassandraKeyspace -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBCassandraKeyspace [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -ParentObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBCassandraKeyspace [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -InputObject <PSCassandraKeyspaceGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the CosmosDB Cassandra Keyspace. Performs a client side patch operation by reading the existing Keyspace. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBCassandraKeyspace -AccountName myAccountName -ResourceGroupName myRgName -Name myKeyspaceName -Throughput 600 +``` + +```output +Name : myKeyspace +Id : /subscriptions/mySubId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/cassandraKeyspaces/myKeyspaceName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Cassandra Keyspace object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Cassandra Keyspace Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Cassandra Keyspace (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ResourceNotFoundException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBCassandraKeyspaceThroughput.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBCassandraKeyspaceThroughput.md new file mode 100644 index 0000000000..213c18b310 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBCassandraKeyspaceThroughput.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbcassandrakeyspacethroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBCassandraKeyspaceThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBCassandraKeyspaceThroughput.md +--- + +# Update-AzCosmosDBCassandraKeyspaceThroughput + +## SYNOPSIS +Updates the throughput value of a CosmosDB Cassandra Keyspace. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBCassandraKeyspaceThroughput [-Name <String>] -ResourceGroupName <String> -AccountName <String> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBCassandraKeyspaceThroughput [-Name <String>] -ParentObject <PSDatabaseAccountGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBCassandraKeyspaceThroughput [-Name <String>] -InputObject <PSCassandraKeyspaceGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the throughput value of a CosmosDB Cassandra Keyspace. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBCassandraKeyspaceThroughput -AccountName "myAccountName" -ResourceGroupName "myResourceGroupName" -Name "myKeyspaceName" -Throughput $updatedThroughputValue +``` + +```output +Name : mxGp +Id : /subscriptions/{mySubscriptionId}/resourceGroups/{myResourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{myAccountName}/cassandraKeyspace/{myKeyspaceName}/throughputSettings/default +Throughput : {updatedThroughputValue} +MinimumThroughput : 400 +OfferReplacePending : +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Cassandra Keyspace Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Cassandra Keyspace (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBCassandraTable.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBCassandraTable.md new file mode 100644 index 0000000000..c5e373d4ee --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBCassandraTable.md @@ -0,0 +1,296 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbcassandratable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBCassandraTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBCassandraTable.md +--- + +# Update-AzCosmosDBCassandraTable + +## SYNOPSIS +Updates the CosmosDB Cassandra Table. Performs a client side patch operation by reading the existing Table. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBCassandraTable -ResourceGroupName <String> -AccountName <String> -KeyspaceName <String> + [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-TtlInSeconds <Int32>] + [-AnalyticalStorageTtl <Int32>] [-Schema <PSCassandraSchema>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBCassandraTable [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + [-TtlInSeconds <Int32>] [-AnalyticalStorageTtl <Int32>] [-Schema <PSCassandraSchema>] + -ParentObject <PSCassandraKeyspaceGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBCassandraTable [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + [-TtlInSeconds <Int32>] [-AnalyticalStorageTtl <Int32>] [-Schema <PSCassandraSchema>] + -InputObject <PSCassandraTableGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the CosmosDB Cassandra Table. Performs a client side patch operation by reading the existing Table. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBCassandraTable -AccountName myAccountName -ResourceGroupName myRgName -KeyspaceName myKeyspaceName -Name myTableName -Schema updatedSchema +``` + +```output +Name : myTable +Id : /subscriptions/mySubId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/cassandraKeyspaces/myKeyspaceName/t + ables/myTableName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraTableGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnalyticalStorageTtl +Analytical Storage TTL. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Cassandra Table object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraTableGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyspaceName +Cassandra Keyspace Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cassandra Table Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Cassandra Keyspace object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schema +PSCassandraSchema object. +Use New-AzCosmosDBCassandraSchema to create this object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraSchema +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Cassandra Keyspace (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TtlInSeconds +Default Ttl in seconds. +If the value is missing or set to - 1, items don't expire. +If the value is set to n, items will expire n seconds after last modified time. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraSchema + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraTableGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraTableGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ResourceNotFoundException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBCassandraTableThroughput.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBCassandraTableThroughput.md new file mode 100644 index 0000000000..530ff0b100 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBCassandraTableThroughput.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbcassandratablethroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBCassandraTableThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBCassandraTableThroughput.md +--- + +# Update-AzCosmosDBCassandraTableThroughput + +## SYNOPSIS +Updates the throughput value of a CosmosDB Cassandra Table. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBCassandraTableThroughput -KeyspaceName <String> [-Name <String>] -ResourceGroupName <String> + -AccountName <String> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBCassandraTableThroughput [-Name <String>] -ParentObject <PSCassandraKeyspaceGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBCassandraTableThroughput [-Name <String>] -InputObject <PSCassandraTableGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the throughput value of a CosmosDB Cassandra Table. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBCassandraTableThroughput -AccountName "myAccountName" -ResourceGroupName "myResourceGroupName" -KeyspaceName "myKeyspaceName" -Name "myTableName" -Throughput $updatedThroughputValue +``` + +```output +Name : mxGp +Id : /subscriptions/{mySubscriptionId}/resourceGroups/{myResourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{myAccountName}/cassandraKeyspace/{myKeyspaceName}/tables/{myTableName}/throughputSettings/default +Throughput : {updatedThroughputValue} +MinimumThroughput : 400 +OfferReplacePending : +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Cassandra Keyspace object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraTableGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyspaceName +Cassandra Keyspace Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cassandra Table Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Cassandra Keyspace object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Cassandra Keyspace (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSCassandraKeyspaceGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBGremlinDatabase.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBGremlinDatabase.md new file mode 100644 index 0000000000..3c7dc3b968 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBGremlinDatabase.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbgremlindatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBGremlinDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBGremlinDatabase.md +--- + +# Update-AzCosmosDBGremlinDatabase + +## SYNOPSIS +Updates the CosmosDB Gremlin Database. Performs a client side patch operation by reading the existing Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBGremlinDatabase -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBGremlinDatabase [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -ParentObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBGremlinDatabase [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -InputObject <PSGremlinDatabaseGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the CosmosDB Gremlin Database. Performs a client side patch operation by reading the existing Database. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBGremlinDatabase -AccountName "myAccountName" -Name "myDatabaseName" -ResourceGroupName "myResourcegroupName" -Throughput 700 +``` + +```output +Name : myDatabaseName +Id : /subscriptions/mySubscriptionId/resourceGroups/myResourcegroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/gremlinDatabases/myDatabaseName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gremlin Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Gremlin Database (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ResourceNotFoundException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBGremlinDatabaseThroughput.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBGremlinDatabaseThroughput.md new file mode 100644 index 0000000000..add358c3c4 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBGremlinDatabaseThroughput.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbgremlindatabasethroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBGremlinDatabaseThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBGremlinDatabaseThroughput.md +--- + +# Update-AzCosmosDBGremlinDatabaseThroughput + +## SYNOPSIS +Updates the throughput value of a CosmosDB Gremlin Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBGremlinDatabaseThroughput [-Name <String>] -ResourceGroupName <String> -AccountName <String> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBGremlinDatabaseThroughput [-Name <String>] -ParentObject <PSDatabaseAccountGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBGremlinDatabaseThroughput [-Name <String>] -InputObject <PSGremlinDatabaseGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the throughput value of a CosmosDB Gremlin Database. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBGremlinDatabaseThroughput -AccountName "myAccountName" -ResourceGroupName "myResourceGroupName" -Name "myDatabaseName" -Throughput $updatedThroughputValue +``` + +```output +Name : mxGp +Id : /subscriptions/{mySubscriptionId}/resourceGroups/{myResourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{myAccountName}/gremlinDatabases/{myDatabaseName}/throughputSettings/default +Throughput : {updatedThroughputValue} +MinimumThroughput : 400 +OfferReplacePending : +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Gremlin Database (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBGremlinGraph.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBGremlinGraph.md new file mode 100644 index 0000000000..210ecfe986 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBGremlinGraph.md @@ -0,0 +1,413 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbgremlingraph +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBGremlinGraph.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBGremlinGraph.md +--- + +# Update-AzCosmosDBGremlinGraph + +## SYNOPSIS +Updates the CosmosDB Gremlin Graph. Performs a client side patch operation by reading the existing Graph. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBGremlinGraph -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + [-Name <String>] [-IndexingPolicy <PSIndexingPolicy>] [-PartitionKeyVersion <Int32>] + [-PartitionKeyKind <String>] [-PartitionKeyPath <String[]>] [-Throughput <Int32>] + [-AutoscaleMaxThroughput <Int32>] [-TtlInSeconds <Int32>] [-UniqueKeyPolicy <PSUniqueKeyPolicy>] + [-ConflictResolutionPolicyMode <String>] [-ConflictResolutionPolicyPath <String>] + [-ConflictResolutionPolicyProcedure <String>] [-ConflictResolutionPolicy <PSConflictResolutionPolicy>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBGremlinGraph [-Name <String>] [-IndexingPolicy <PSIndexingPolicy>] + [-PartitionKeyVersion <Int32>] [-PartitionKeyKind <String>] [-PartitionKeyPath <String[]>] + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-TtlInSeconds <Int32>] + [-UniqueKeyPolicy <PSUniqueKeyPolicy>] [-ConflictResolutionPolicyMode <String>] + [-ConflictResolutionPolicyPath <String>] [-ConflictResolutionPolicyProcedure <String>] + [-ConflictResolutionPolicy <PSConflictResolutionPolicy>] -ParentObject <PSGremlinDatabaseGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBGremlinGraph [-Name <String>] [-IndexingPolicy <PSIndexingPolicy>] + [-PartitionKeyVersion <Int32>] [-PartitionKeyKind <String>] [-PartitionKeyPath <String[]>] + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-TtlInSeconds <Int32>] + [-UniqueKeyPolicy <PSUniqueKeyPolicy>] [-ConflictResolutionPolicyMode <String>] + [-ConflictResolutionPolicyPath <String>] [-ConflictResolutionPolicyProcedure <String>] + [-ConflictResolutionPolicy <PSConflictResolutionPolicy>] -InputObject <PSGremlinGraphGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the CosmosDB Gremlin Graph. Performs a client side patch operation by reading the existing Graph. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBGremlinGraph -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myContainerName -Throughput updatedThroughputValue +``` + +```output +Name : myContainerName +Id : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/gremlinDatabases/myDatabaseName/graphs/myGraphName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicy +ConflictResolutionPolicy Object of type PSConflictResolutionPolicy, when provided this is set as the ConflictResolutionPolicy of the container. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSConflictResolutionPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicyMode +Can have the values: LastWriterWins, Custom, Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicyPath +To be provided when the type is LastWriterWins. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicyProcedure +To be provided when the type is custom. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IndexingPolicy +Indexing Policy Object of type Microsoft.Azure.Commands.CosmosDB.PSIndexingPolicy. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSIndexingPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Gremlin Graph object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Gremlin Graph Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Gremlin Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PartitionKeyKind +The kind of algorithm used for partitioning. +Possible values include: 'Hash', 'Range' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionKeyPath +Partition Key Path, e.g., '/address/zipcode'. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionKeyVersion +The version of the partition key definition + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Gremlin Graph (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TtlInSeconds +Default Ttl in seconds. +If the value is missing or set to - 1, items don't expire. +If the value is set to n, items will expire n seconds after last modified time. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UniqueKeyPolicy +UniqueKeyPolicy Object of type Microsoft.Azure.Commands.CosmosDB.PSUniqueKeyPolicy. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSUniqueKeyPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSIndexingPolicy + +### Microsoft.Azure.Commands.CosmosDB.Models.PSUniqueKeyPolicy + +### Microsoft.Azure.Commands.CosmosDB.Models.PSConflictResolutionPolicy + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ResourceNotFoundException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBGremlinGraphThroughput.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBGremlinGraphThroughput.md new file mode 100644 index 0000000000..086cf1c25a --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBGremlinGraphThroughput.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbgremlingraphthroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBGremlinGraphThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBGremlinGraphThroughput.md +--- + +# Update-AzCosmosDBGremlinGraphThroughput + +## SYNOPSIS +Updates the throughput value of a CosmosDB Gremlin Graph. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBGremlinGraphThroughput -DatabaseName <String> [-Name <String>] -ResourceGroupName <String> + -AccountName <String> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBGremlinGraphThroughput [-Name <String>] -ParentObject <PSGremlinDatabaseGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBGremlinGraphThroughput [-Name <String>] -InputObject <PSGremlinGraphGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the throughput value of a CosmosDB Gremlin Graph. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBGremlinGraphThroughput -AccountName "myAccountName" -ResourceGroupName "myResourceGroupName" -DatabaseName "mydatabaseName" -Name "myGraphName" -Throughput $updatedThroughputValue +``` + +```output +Name : mxGp +Id : /subscriptions/{mySubscriptionId}/resourceGroups/{myResourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{myAccountName}/gremlinDatabase/{mydatabaseName}/graphs/{myGraphName}/throughputSettings/default +Throughput : {updatedThroughputValue} +MinimumThroughput : 400 +OfferReplacePending : +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gremlin Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinGraphGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Gremlin Graph Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Gremlin Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Gremlin Graph (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBCollection.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBCollection.md new file mode 100644 index 0000000000..a74aeadd1e --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBCollection.md @@ -0,0 +1,291 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbmongodbcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBCollection.md +--- + +# Update-AzCosmosDBMongoDBCollection + +## SYNOPSIS +Updates the CosmosDB MongoDB Collection. Performs a client side patch operation by reading the existing Collection. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBMongoDBCollection -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-Shard <String>] + [-AnalyticalStorageTtl <Int32>] [-Index <PSMongoIndex[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBMongoDBCollection [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + [-Shard <String>] [-AnalyticalStorageTtl <Int32>] [-Index <PSMongoIndex[]>] + -ParentObject <PSMongoDBDatabaseGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBMongoDBCollection [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + [-Shard <String>] [-AnalyticalStorageTtl <Int32>] [-Index <PSMongoIndex[]>] + -InputObject <PSMongoDBCollectionGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the CosmosDB MongoDB Collection. Performs a client side patch operation by reading the existing Collection. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBMongoDBCollection -AccountName myAccountName -ResourceGroupName myRgName -DatabaseName myDatabaseName -Name myCollectionName -Index $index1,$index2 +``` + +```output +Name : collection1 +Id : /subscriptions/mySubId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbDatabases/myDatabaseName/collect + ions/myCollectionName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnalyticalStorageTtl +TTL for Analytical Storage. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Index +Array of PSMongoIndex objects. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoIndex[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Collection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Mongo Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Shard +Sharding key path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of SQL container (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ResourceNotFoundException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBCollectionThroughput.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBCollectionThroughput.md new file mode 100644 index 0000000000..c9d2622cb9 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBCollectionThroughput.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbmongodbcollectionthroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBCollectionThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBCollectionThroughput.md +--- + +# Update-AzCosmosDBMongoDBCollectionThroughput + +## SYNOPSIS +Updates the throughput value of a CosmosDB MongoDB Collection. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBMongoDBCollectionThroughput -DatabaseName <String> [-Name <String>] + -ResourceGroupName <String> -AccountName <String> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBMongoDBCollectionThroughput [-Name <String>] -ParentObject <PSMongoDBDatabaseGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBMongoDBCollectionThroughput [-Name <String>] -InputObject <PSMongoDBCollectionGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the throughput value of a CosmosDB MongoDB Collection. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBMongoDBCollectionThroughput -AccountName "myAccountName" -ResourceGroupName "myResourceGroupName" -DatabaseName "mydatabaseName" -Name "myCollectionName" -Throughput $updatedThroughputValue +``` + +```output +Name : mxGp +Id : /subscriptions/{mySubscriptionId}/resourceGroups/{myResourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{myAccountName}/mongodbDatabase/{mydatabaseName}/collections/{myCollectionName}/throughputSettings/default +Throughput : {updatedThroughputValue} +MinimumThroughput : 400 +OfferReplacePending : +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Mongo Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Collection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Mongo Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of SQL container (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBDatabase.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBDatabase.md new file mode 100644 index 0000000000..5ece9c86f8 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBDatabase.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbmongodbdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBDatabase.md +--- + +# Update-AzCosmosDBMongoDBDatabase + +## SYNOPSIS +Updates the CosmosDB MongoDB Database. Performs a client side patch operation by reading the existing Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBMongoDBDatabase -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBMongoDBDatabase [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -ParentObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBMongoDBDatabase [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -InputObject <PSMongoDBDatabaseGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the CosmosDB MongoDB Database. Performs a client side patch operation by reading the existing Database. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBMongoDBDatabase -AccountName myAccountName -Name myDatabaseName -ResourceGroupName myResourcegroupName -Throughput 600 +``` + +```output +Name : myDatabaseName +Id : /subscriptions/mySubscriptionId/resourceGroups/myResourcegroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbDatabases/myDatabaseName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Mongo Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Mongo database (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ResourceNotFoundException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBDatabaseThroughput.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBDatabaseThroughput.md new file mode 100644 index 0000000000..15404091dc --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBDatabaseThroughput.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbmongodbdatabasethroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBDatabaseThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBDatabaseThroughput.md +--- + +# Update-AzCosmosDBMongoDBDatabaseThroughput + +## SYNOPSIS +Updates the throughput value of a CosmosDB MongoDB Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBMongoDBDatabaseThroughput [-Name <String>] -ResourceGroupName <String> -AccountName <String> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBMongoDBDatabaseThroughput [-Name <String>] -ParentObject <PSDatabaseAccountGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBMongoDBDatabaseThroughput [-Name <String>] -InputObject <PSMongoDBDatabaseGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the throughput value of a CosmosDB MongoDB Database. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBMongoDBDatabaseThroughput -AccountName "myAccountName" -ResourceGroupName "myResourceGroupName" -Name "myDatabaseName" -Throughput $updatedThroughputValue +``` + +```output +Name : mxGp +Id : /subscriptions/{mySubscriptionId}/resourceGroups/{myResourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{myAccountName}/mongodbDatabases/{myDatabaseName}/throughputSettings/default +Throughput : {updatedThroughputValue} +MinimumThroughput : 400 +OfferReplacePending : +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Mongo database (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBRoleDefinition.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBRoleDefinition.md new file mode 100644 index 0000000000..c30bbf5498 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBRoleDefinition.md @@ -0,0 +1,354 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbmongodbroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBRoleDefinition.md +--- + +# New-AzCosmosDBMongoDBRoleDefinition + +## SYNOPSIS +Update an existing CosmosDB MongoDB Role Definition. + +## SYNTAX + +### ByFieldsDataActionsParameterSet (Default) +``` +New-AzCosmosDBMongoDBRoleDefinition -Id <String> -RoleName <String> -Type <String> -DatabaseName <String> + -Privileges <PSMongoPrivilege[]> [-Roles <PSMongoRole[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByNameParameterSet +``` +New-AzCosmosDBMongoDBRoleDefinition -ResourceGroupName <String> -AccountName <String> -Id <String> + -RoleName <String> -Type <String> -DatabaseName <String> -Privileges <PSMongoPrivilege[]> + [-Roles <PSMongoRole[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectDataActionsParameterSet +``` +New-AzCosmosDBMongoDBRoleDefinition -Id <String> -RoleName <String> -Type <String> -DatabaseName <String> + -Privileges <PSMongoPrivilege[]> [-Roles <PSMongoRole[]>] -DatabaseAccountObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectPermissionsParameterSet +``` +New-AzCosmosDBMongoDBRoleDefinition -Id <String> -RoleName <String> -Type <String> -DatabaseName <String> + -Privileges <PSMongoPrivilege[]> [-Roles <PSMongoRole[]>] -DatabaseAccountObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +New-AzCosmosDBMongoDBRoleDefinition -Id <String> -RoleName <String> -Type <String> -DatabaseName <String> + -Privileges <PSMongoPrivilege[]> [-Roles <PSMongoRole[]>] [-ResourceId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update an existing CosmosDB MongoDB Role Definition. +In order to specify the Role Definition's Privileges, use the New-AzCosmosDBMongoDBPrivilege cmdlet to create PSMongoPrivilege objects to pass in through the Privileges parameter. +In order to specify the Role Definition's Roles, use the New-AzCosmosDBMongoDBRole cmdlet to create PSMongoRole objects to pass in through the Roles parameter. + +## EXAMPLES + +### Example 1: Default +```powershell +$Actions = 'insert', 'find' + $PrivilegeResource = New-AzCosmosDBMongoDBPrivilegeResource -Database test -Collection test + $Privilege = New-AzCosmosDBMongoDBPrivilege -PrivilegeResource $PrivilegeResource -Actions $Actions + $Roles = New-AzCosmosDBMongoDBRole -Database test -Role roleName + + +Update-AzCosmosDBMongoDBRoleDefinition ` + -AccountName accountName ` + -ResourceGroupName resourceGroupName ` + -DatabaseName test ` + -Id id ` + -Type CustomRole ` + -RoleName roleName ` + -Privileges $Privilege ` + -Roles $Roles +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbRoleDefinitions/id +RoleName : roleName +Type : CustomRole +DatabaseName : test +Privileges : {Microsoft.Azure.Management.CosmosDB.Models.Privilege} +Roles : {Microsoft.Azure.Management.CosmosDB.Models.Role, Microsoft.Azure.Management.CosmosDB.Models.Role} +``` + +### Example 2: ParentObject +```powershell +$DatabaseAccount = Get-AzCosmosDBAccount -Name accountName -ResourceGroupName resourceGroupName +$Actions = 'insert', 'find' +$PrivilegeResource = New-AzCosmosDBMongoDBPrivilegeResource -Database test -Collection test +$Privilege = New-AzCosmosDBMongoDBPrivilege -PrivilegeResource $PrivilegeResource -Actions $Actions +$Roles = New-AzCosmosDBMongoDBRole -Database test -Role roleName +Update-AzCosmosDBMongoDBRoleDefinition ` + -Id id ` + -Type CustomRole ` + -RoleName roleName ` + -Privileges $Privilege ` + -Roles $Roles ` + -DatabaseAccountObject $DatabaseAccount +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbRoleDefinitions/id +RoleName : roleName +Type : CustomRole +DatabaseName : test +Privileges : {Microsoft.Azure.Management.CosmosDB.Models.Privilege} +Roles : {Microsoft.Azure.Management.CosmosDB.Models.Role, Microsoft.Azure.Management.CosmosDB.Models.Role} +``` + +### Example 3: InputObject +```powershell +$DatabaseAccount = Get-AzCosmosDBAccount -Name accountName -ResourceGroupName resourceGroupName +$Actions = 'insert', 'find' +$PrivilegeResource = New-AzCosmosDBMongoDBPrivilegeResource -Database test -Collection test +$Privilege = New-AzCosmosDBMongoDBPrivilege -PrivilegeResource $PrivilegeResource -Actions $Actions +$Roles = New-AzCosmosDBMongoDBRole -Database test -Role roleName +$RoleDef = Get-AzCosmosDBMongoDBRoleDefinition -AccountName accountName -ResourceGroupName resourceGroupName -Id id + +Update-AzCosmosDBMongoDBRoleDefinition ` + -Id id ` + -Type CustomRole ` + -RoleName roleName ` + -Privileges $Privilege ` + -Roles $Roles ` + -InputObject $RoleDef +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbRoleDefinitions/id +RoleName : roleName +Type : CustomRole +DatabaseName : test +Privileges : {Microsoft.Azure.Management.CosmosDB.Models.Privilege} +Roles : {Microsoft.Azure.Management.CosmosDB.Models.Role, Microsoft.Azure.Management.CosmosDB.Models.Role} +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseAccountObject +Role definition object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectDataActionsParameterSet, ByParentObjectPermissionsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DatabaseName +Database Name for the MongoDB Role Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role Definition Unique Id(Format is `<databaseName>.<roleName>`). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Privileges +Set of Privileges for CosmosDB MongoDB API. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoPrivilege[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleName +Role Definition Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Roles +Set of inherited roles for CosmosDB MongoDB API Role Definition. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of Role Definition, either CustomRole or BuiltInRole. +Default value is CustomRole. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBRoleDefinitionGetResults +## NOTES + +## RELATED LINKS + +[Get-AzCosmosDBMongoDBRoleDefinition](./Get-AzCosmosDBMongoDBRoleDefinition.md) + +[New-AzCosmosDBMongoDBRoleDefinition](./New-AzCosmosDBMongoDBRoleDefinition.md) + +[Remove-AzCosmosDBMongoDBRoleDefinition](./Remove-AzCosmosDBMongoDBRoleDefinition.md) diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBUserDefinition.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBUserDefinition.md new file mode 100644 index 0000000000..644274da5b --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBMongoDBUserDefinition.md @@ -0,0 +1,322 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbmongodbuserdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBUserDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBUserDefinition.md +--- + +# New-AzCosmosDBMongoDBUserDefinition + +## SYNOPSIS +Update an existing CosmosDB MongoDB User Definition. + +## SYNTAX + +### ByFieldsDataActionsParameterSet (Default) +``` +New-AzCosmosDBMongoDBUserDefinition -Id <String> -UserName <String> -Password <String> [-Mechanisms <String>] + -DatabaseName <String> + -Roles <System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole]> + [-CustomData <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByNameParameterSet +``` +New-AzCosmosDBMongoDBUserDefinition -ResourceGroupName <String> -AccountName <String> -Id <String> + -UserName <String> -Password <String> [-Mechanisms <String>] -DatabaseName <String> + -Roles <System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole]> + [-CustomData <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectDataActionsParameterSet +``` +New-AzCosmosDBMongoDBUserDefinition -Id <String> -UserName <String> -Password <String> [-Mechanisms <String>] + -DatabaseName <String> + -Roles <System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole]> + [-CustomData <String>] -DatabaseAccountObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectPermissionsParameterSet +``` +New-AzCosmosDBMongoDBUserDefinition -Id <String> -UserName <String> -Password <String> [-Mechanisms <String>] + -DatabaseName <String> + -Roles <System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole]> + [-CustomData <String>] -DatabaseAccountObject <PSDatabaseAccountGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +New-AzCosmosDBMongoDBUserDefinition -Id <String> -UserName <String> -Password <String> [-Mechanisms <String>] + -DatabaseName <String> + -Roles <System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole]> + [-CustomData <String>] [-ResourceId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Update an existing CosmosDB MongoDB User Definition. +In order to specify the Role Definition's Roles, use the New-AzCosmosDBMongoDBRole cmdlet to create PSMongoRole objects to pass in through the Roles parameter. + +## EXAMPLES + +### Example 1: Default +```powershell +$Roles = New-AzCosmosDBMongoDBRole -Database test -Role roleName + + +Update-AzCosmosDBMongoDBUserDefinition ` + -AccountName accountName ` + -ResourceGroupName resourceGroupName ` + -DatabaseName 'test' ` + -UserName 'myName' ` + -Password 'pass' ` + -Id id ` + -Mechanisms 'SCRAM-SHA-256' ` + -CustomData 'test' ` + -Roles $Roles +``` + +```output +Id : /subscriptions/80be3961-0521-4a0a-8570-5cd5a4e2f98c/resourceGroups/mongorbactest02/providers/Microsoft.DocumentDB/databaseAccounts/ashwini001/mongodbUserDefinitions/test.testuser1 +UserName : testuser1 +Password : +Mechanisms : SCRAM-SHA-256 +DatabaseName : test +CustomData : +Roles : {Microsoft.Azure.Management.CosmosDB.Models.Role} +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomData +Additional information about the user Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseAccountObject +Role definition object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectDataActionsParameterSet, ByParentObjectPermissionsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DatabaseName +Database Name for the MongoDB Role Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role Definition Unique Id(Format is `<databaseName>.<roleName>`). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mechanisms +Password for the user Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Password for the user Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Roles +Set of inherited roles for CosmosDB MongoDB API Role Definition. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoRole] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserName +Unique username(per database) for the user Definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBUserDefinitionGetResults +## NOTES + +## RELATED LINKS + +[Get-AzCosmosDBMongoDBUserDefinition](./Get-AzCosmosDBMongoDBUserDefinition.md) + +[New-AzCosmosDBMongoDBUserDefinition](./New-AzCosmosDBMongoDBUserDefinition.md) + +[Remove-AzCosmosDBMongoDBUserDefinition](./Remove-AzCosmosDBMongoDBUserDefinition.md) diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlContainer.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlContainer.md new file mode 100644 index 0000000000..eee0580270 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlContainer.md @@ -0,0 +1,434 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbsqlcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlContainer.md +--- + +# Update-AzCosmosDBSqlContainer + +## SYNOPSIS +Updates the CosmosDB Sql Container. Performs a client side patch operation by reading the existing Container. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBSqlContainer -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + [-Name <String>] [-IndexingPolicy <PSSqlIndexingPolicy>] [-PartitionKeyVersion <Int32>] + [-PartitionKeyKind <String>] [-PartitionKeyPath <String[]>] [-Throughput <Int32>] + [-AutoscaleMaxThroughput <Int32>] [-TtlInSeconds <Int32>] [-UniqueKeyPolicy <PSSqlUniqueKeyPolicy>] + [-ConflictResolutionPolicyMode <String>] [-ConflictResolutionPolicyPath <String>] + [-ConflictResolutionPolicyProcedure <String>] [-ConflictResolutionPolicy <PSSqlConflictResolutionPolicy>] + [-AnalyticalStorageTtl <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBSqlContainer [-Name <String>] [-IndexingPolicy <PSSqlIndexingPolicy>] + [-PartitionKeyVersion <Int32>] [-PartitionKeyKind <String>] [-PartitionKeyPath <String[]>] + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-TtlInSeconds <Int32>] + [-UniqueKeyPolicy <PSSqlUniqueKeyPolicy>] [-ConflictResolutionPolicyMode <String>] + [-ConflictResolutionPolicyPath <String>] [-ConflictResolutionPolicyProcedure <String>] + [-ConflictResolutionPolicy <PSSqlConflictResolutionPolicy>] -ParentObject <PSSqlDatabaseGetResults> + [-AnalyticalStorageTtl <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBSqlContainer [-Name <String>] [-IndexingPolicy <PSSqlIndexingPolicy>] + [-PartitionKeyVersion <Int32>] [-PartitionKeyKind <String>] [-PartitionKeyPath <String[]>] + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-TtlInSeconds <Int32>] + [-UniqueKeyPolicy <PSSqlUniqueKeyPolicy>] [-ConflictResolutionPolicyMode <String>] + [-ConflictResolutionPolicyPath <String>] [-ConflictResolutionPolicyProcedure <String>] + [-ConflictResolutionPolicy <PSSqlConflictResolutionPolicy>] [-AnalyticalStorageTtl <Int32>] + -InputObject <PSSqlContainerGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the CosmosDB Sql Container. Performs a client side patch operation by reading the existing Container. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBSqlContainer -AccountName myAccountName -Name myDatabaseName -ResourceGroupName myResourcegroupName -Throughput 800 +``` + +```output +Name : myDatabaseName +Id : /subscriptions/mySubscriptionId/resourceGroups/myResourcegroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnalyticalStorageTtl +TTL for Analytical Storage (in Seconds). + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicy +ConflictResolutionPolicy Object of type PSSqlConflictResolutionPolicy, when provided this is set as the ConflictResolutionPolicy of the container. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlConflictResolutionPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicyMode +Can have the values: LastWriterWins, Custom, Manual. +If provided along with ConflictResolutionPolicy parameter, it is ignored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicyPath +To be provided when the type is LastWriterWins. +If provided along with ConflictResolutionPolicy parameter, it is ignored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConflictResolutionPolicyProcedure +To be provided when the type is custom. +If provided along with ConflictResolutionPolicy parameter, it is ignored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IndexingPolicy +Indexing Policy Object of type Microsoft.Azure.Commands.CosmosDB.PSSqlIndexingPolicy. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlIndexingPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PartitionKeyKind +The kind of algorithm used for partitioning. +Possible values include: 'Hash', 'Range' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionKeyPath +Partition Key Path, e.g., '/address/zipcode'. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionKeyVersion +The version of the partition key definition + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of SQL container (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TtlInSeconds +Default Ttl in seconds. +If the value is missing or set to - 1, items don't expire. +If the value is set to n, items will expire n seconds after last modified time. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UniqueKeyPolicy +UniqueKeyPolicy Object of type Microsoft.Azure.Commands.CosmosDB.PSSqlUniqueKeyPolicy. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUniqueKeyPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlIndexingPolicy + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUniqueKeyPolicy + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlConflictResolutionPolicy + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ResourceNotFoundException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlContainerThroughput.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlContainerThroughput.md new file mode 100644 index 0000000000..4e3aeccfc0 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlContainerThroughput.md @@ -0,0 +1,249 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbsqlcontainerthroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlContainerThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlContainerThroughput.md +--- + +# Update-AzCosmosDBSqlContainerThroughput + +## SYNOPSIS +Updates the throughput value of a CosmosDB Sql Container. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBSqlContainerThroughput -DatabaseName <String> [-Name <String>] -ResourceGroupName <String> + -AccountName <String> [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBSqlContainerThroughput [-Name <String>] -ParentObject <PSSqlDatabaseGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBSqlContainerThroughput [-Name <String>] -InputObject <PSSqlContainerGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the throughput value of a CosmosDB Sql Container. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBSqlContainerThroughput -AccountName "myAccountName" -ResourceGroupName "myResourceGroupName" -DatabaseName "myDatabaseName" -Name "myContainerName" -Throughput $updatedThroughputValue +``` + +```output +Name : mxGp +Id : /subscriptions/{mySubscriptionId}/resourceGroups/{myResourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{myAccountName}/sqlDatabases/{myDatabaseName}/conatiners/{myContainerName}/throughputSettings/default +Throughput : {updatedThroughputValue} +MinimumThroughput : 400 +OfferReplacePending : +``` + +### Example 2 + +Updates the throughput value of a CosmosDB Sql Container. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Update-AzCosmosDBSqlContainerThroughput -AccountName myAccountName -AutoscaleMaxThroughput <Int32> -DatabaseName myDatabaseName -Name dbname -ResourceGroupName rg1 +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of SQL container (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlDatabase.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlDatabase.md new file mode 100644 index 0000000000..6432018ba7 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlDatabase.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbsqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlDatabase.md +--- + +# Update-AzCosmosDBSqlDatabase + +## SYNOPSIS +Updates the CosmosDB Sql Database. Performs a client side patch operation by reading the existing Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBSqlDatabase -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBSqlDatabase [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -ParentObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBSqlDatabase [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -InputObject <PSSqlDatabaseGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the CosmosDB Sql Database. Performs a client side patch operation by reading the existing Database. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBSqlDatabase -AccountName myAccountName -Name myDatabaseName -ResourceGroupName myResourcegroupName -Throughput 900 +``` + +```output +Name : myDatabaseName +Id : /subscriptions/mySubscriptionId/resourceGroups/myResourcegroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of SQL database (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ResourceNotFoundException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlDatabaseThroughput.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlDatabaseThroughput.md new file mode 100644 index 0000000000..47dd491c09 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlDatabaseThroughput.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbsqldatabasethroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlDatabaseThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlDatabaseThroughput.md +--- + +# Update-AzCosmosDBSqlDatabaseThroughput + +## SYNOPSIS +Updates the throughput value of a CosmosDB Sql Database. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBSqlDatabaseThroughput [-Name <String>] -ResourceGroupName <String> -AccountName <String> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBSqlDatabaseThroughput [-Name <String>] -ParentObject <PSDatabaseAccountGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBSqlDatabaseThroughput [-Name <String>] -InputObject <PSSqlDatabaseGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the throughput value of a CosmosDB Sql Database. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBSqlDatabaseThroughput -AccountName "myAccountName" -ResourceGroupName "myResourceGroupName" -Name "myDatabaseName" -Throughput $updatedThroughputValue +``` + +```output +Name : mxGp +Id : /subscriptions/{mySubscriptionId}/resourceGroups/{myResourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{myAccountName}/sqlDatabases/{myDatabaseName}/throughputSettings/default +Throughput : {updatedThroughputValue} +MinimumThroughput : 400 +OfferReplacePending : +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of SQL database (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlRoleAssignment.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlRoleAssignment.md new file mode 100644 index 0000000000..c32ab853f2 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlRoleAssignment.md @@ -0,0 +1,256 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbsqlroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlRoleAssignment.md +--- + +# Update-AzCosmosDBSqlRoleAssignment + +## SYNOPSIS +Updates an existing CosmosDB Sql Role Assignment. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Update-AzCosmosDBSqlRoleAssignment -ResourceGroupName <String> -AccountName <String> -Id <String> + [-RoleDefinitionId <String>] [-RoleDefinitionName <String>] [-Scope <String>] [-PrincipalId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBSqlRoleAssignment -Id <String> [-Scope <String>] [-PrincipalId <String>] + -ParentObject <PSSqlRoleDefinitionGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBSqlRoleAssignment -InputObject <PSSqlRoleAssignmentGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing CosmosDB Sql Role Assignment. +Scope can be either fully qualified (ie. +/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/dbs/dbName) or start with the database name (ie. +/dbs/dbName). +RoleDefinitionId and Id can be either fully qualified or just the Guid. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBSqlRoleAssignment ` + -AccountName accountName ` + -ResourceGroupName resourceGroupName ` + -Id roleAssignmentId ` + -RoleDefinitionId "/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/roleDefinitionId" +``` + +```output +Id : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleAssignments/roleAssignmentId +Scope : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/ +RoleDefinitionId : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/roleDefinitionId +PrincipalId : principalId +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role Assignment Id. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Role Assignment object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleAssignmentGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleDefinitionGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrincipalId +Object ID (Guid) of the AAD principal to which the Role Assignment is being granted. This could be user, group, service principal, or managed identity. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +Fully Qualified Role Definition Id. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionName +Role Definition Name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Resource path below which the Role Assignment shall grant access. Eg. '/', '/dbs/dbname','/dbs/dbname/colls/collname'. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleDefinitionGetResults +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleDefinitionGetResults +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlRoleDefinition.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlRoleDefinition.md new file mode 100644 index 0000000000..cdb1926ac1 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlRoleDefinition.md @@ -0,0 +1,303 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbsqlroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlRoleDefinition.md +--- + +# Update-AzCosmosDBSqlRoleDefinition + +## SYNOPSIS +Updates an existing CosmosDB Sql Role Definition. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Update-AzCosmosDBSqlRoleDefinition -ResourceGroupName <String> -AccountName <String> -Id <String> + [-Type <String>] [-RoleName <String>] [-DataAction <System.Collections.Generic.List`1[System.String]>] + [-Permission <System.Collections.Generic.List`1[Microsoft.Azure.Commands.CosmosDB.Models.PSPermission]>] + [-AssignableScope <System.Collections.Generic.List`1[System.String]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBSqlRoleDefinition -Id <String> [-Type <String>] [-RoleName <String>] + [-DataAction <System.Collections.Generic.List`1[System.String]>] + [-Permission <System.Collections.Generic.List`1[Microsoft.Azure.Commands.CosmosDB.Models.PSPermission]>] + [-AssignableScope <System.Collections.Generic.List`1[System.String]>] + -ParentObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBSqlRoleDefinition -InputObject <PSSqlRoleDefinitionGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing CosmosDB Sql Role Definition. +Assignable Scopes can be either fully qualified (ie. +/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/dbs/dbName) or start with the database name (ie. +/dbs/dbName). +Id can be either fully qualified or just the Guid. +In order to specify the Role Definition's Permissions, either use the DataAction parameter and pass in a list of strings that will be turned into a single Permission object, or use the New-AzCosmosDBPermission cmdlet to create PSPermission objects to pass in through the Permission parameter. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBSqlRoleDefinition ` + -AccountName accountName ` + -ResourceGroupName resourceGroupName ` + -Id id ` + -Type CustomRole ` + -RoleName roleName ` + -DataAction "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create" ` + -AssignableScope "/" +``` + +```output +RoleName : roleName +Id : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/id +Type : CustomRole +Permissions : {Microsoft.Azure.Management.CosmosDB.Models.Permission} +AssignableScopes : {/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName} +``` + +### Example 2: Using Permission and ParentObject +```powershell +$DatabaseAccount = Get-AzCosmosDBAccount -Name accountName -ResourceGroupName resourceGroupName +$Permission = New-AzCosmosDBPermission -DataAction "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create" +Update-AzCosmosDBSqlRoleDefinition ` + -Type CustomRole ` + -Id id ` + -RoleName roleName ` + -Permission $Permission ` + -AssignableScope "/" ` + -ParentObject $DatabaseAccount +``` + +```output +RoleName : roleName +Id : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/id +Type : CustomRole +Permissions : {Microsoft.Azure.Management.CosmosDB.Models.Permission} +AssignableScopes : {/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName} +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignableScope +Set of resource paths below which a Role Assignment can be attached to the Role Definition. Eg. '/', '/dbs/dbname','/dbs/dbname/colls/collname'. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataAction +Set of data actions granted through the Role Definition. List of allowed actions can be found at: https://aka.ms/cosmos-native-rbac + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role Definition Id. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlRoleDefinitionGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Permission +Permission is a collection of data actions. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.CosmosDB.Models.PSPermission] +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleName +Role Definition Name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of Role Definition, either CustomRole or BuiltInRole. +Default value is CustomRole. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlStoredProcedure.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlStoredProcedure.md new file mode 100644 index 0000000000..19ae8eccea --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlStoredProcedure.md @@ -0,0 +1,241 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbsqlstoredprocedure +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlStoredProcedure.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlStoredProcedure.md +--- + +# Update-AzCosmosDBSqlStoredProcedure + +## SYNOPSIS +Updates the CosmosDB Sql StoredProcedure. Performs a client side patch operation by reading the existing StoredProcedure. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBSqlStoredProcedure -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -ContainerName <String> [-Name <String>] [-Body <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBSqlStoredProcedure [-Name <String>] [-Body <String>] -ParentObject <PSSqlContainerGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBSqlStoredProcedure [-Name <String>] [-Body <String>] + -InputObject <PSSqlStoredProcedureGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the CosmosDB Sql StoredProcedure. Performs a client side patch operation by reading the existing StoredProcedure. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBSqlStoredProcedure -AccountName MyAccountName -ResourceGroupName MyRgName -DatabaseName MyDatabaseName -ContainerName MyContainerName -Name mySprocrName -Body myBody +``` + +```output +Name : mySprocName +Id : /subscriptions/mySubId/resourceGroups/MyRgName/providers/Microsoft.DocumentDB/databaseAccounts/MyAccountName/sqlDatabases/MyDatabaseName/contain + ers/MyContainerName/storedProcedures/mySprocName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlStoredProcedureGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +The body of the Stored Procedure. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Container name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql Stored Procedure Object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlStoredProcedureGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Stored Prcodecure Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlStoredProcedureGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlStoredProcedureGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ResourceNotFoundException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlTrigger.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlTrigger.md new file mode 100644 index 0000000000..fb99efcfc8 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlTrigger.md @@ -0,0 +1,274 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbsqltrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlTrigger.md +--- + +# Update-AzCosmosDBSqlTrigger + +## SYNOPSIS +Updates the CosmosDB Sql Trigger. Performs a client side patch operation by reading the existing Trigger. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBSqlTrigger -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -ContainerName <String> [-Name <String>] [-Body <String>] [-TriggerOperation <String>] [-TriggerType <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBSqlTrigger [-Name <String>] [-Body <String>] [-TriggerOperation <String>] + [-TriggerType <String>] -ParentObject <PSSqlContainerGetResults> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBSqlTrigger [-Name <String>] [-Body <String>] [-TriggerOperation <String>] + [-TriggerType <String>] -InputObject <PSSqlTriggerGetResults> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the CosmosDB Sql Trigger. Performs a client side patch operation by reading the existing Trigger. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBSqlTrigger -AccountName MyAccountName -ResourceGroupName MyRgName -DatabaseName MyDatabaseName -ContainerName MyContainerName -Name myTriggerName -Body myTriggerBody -TriggerOperation All -TriggerType Pre +``` + +```output +Name : myTriggerName +Id : /subscriptions/mySubId/resourceGroups/MyRgName/providers/Microsoft.DocumentDB/databaseAccounts/MyAccountName/sqlDatabases/MyDatabaseName/contain + ers/MyContainerName/triggers/myTriggerName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlTriggerGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +The body of the Trigger. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Container name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql trigger Object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlTriggerGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Trigger name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerOperation +The operation the trigger is associated with. +Possible values include: 'All', 'Create', 'Update', 'Delete', 'Replace' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerType +Type of the Trigger. +Possible values include: 'Pre', 'Post' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlTriggerGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlTriggerGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ResourceNotFoundException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlUserDefinedFunction.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlUserDefinedFunction.md new file mode 100644 index 0000000000..4bf38a7c97 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBSqlUserDefinedFunction.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbsqluserdefinedfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlUserDefinedFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBSqlUserDefinedFunction.md +--- + +# Update-AzCosmosDBSqlUserDefinedFunction + +## SYNOPSIS +Updates the CosmosDB Sql UserDefinedFunction. Performs a client side patch operation by reading the existing UserDefinedFunction. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBSqlUserDefinedFunction -ResourceGroupName <String> -AccountName <String> + -DatabaseName <String> -ContainerName <String> [-Name <String>] [-Body <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBSqlUserDefinedFunction [-Name <String>] [-Body <String>] + -ParentObject <PSSqlContainerGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBSqlUserDefinedFunction [-Name <String>] [-Body <String>] + -InputObject <PSSqlUserDefinedFunctionGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the CosmosDB Sql UserDefinedFunction. Performs a client side patch operation by reading the existing UserDefinedFunction. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBSqlUserDefinedFunction -AccountName MyAccountName -ResourceGroupName MyRgName -DatabaseName MyDatabaseName -ContainerName MyContainerName -Name myUDFName -Body myBody +``` + +```output +Name : myTriggerName +Id : /subscriptions/mySubId/resourceGroups/MyRgName/providers/Microsoft.DocumentDB/databaseAccounts/MyAccountName/sqlDatabases/MyDatabaseName/contain + ers/MyContainerName/userDefinedFunctions/myUDFName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUserDefinedPropertiesGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +The body of the User Defined Function. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Container name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sql User Defined Function Object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUserDefinedFunctionGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +User Defined Function Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Sql Container object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUserDefinedFunctionGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlUserDefinedFunctionGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ResourceNotFoundException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBTable.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBTable.md new file mode 100644 index 0000000000..7df98662ab --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBTable.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbtable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBTable.md +--- + +# Update-AzCosmosDBTable + +## SYNOPSIS +Updates the CosmosDB Table. Performs a client side patch operation by reading the existing Table. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBTable -ResourceGroupName <String> -AccountName <String> [-Name <String>] [-Throughput <Int32>] + [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBTable [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -ParentObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBTable [-Name <String>] [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] + -InputObject <PSTableGetResults> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the CosmosDB Table. Performs a client side patch operation by reading the existing Table. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBTable -AccountName myAcccountName -Name myTableName -ResourceGroupName myRgName -Throughput 800 +``` + +```output +Name : myTableName +Id : /subscriptions/mySubscriptionId/resourceGroups/myResourcegroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/Tables/myTableName +Location : +Tags : +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSTableGetPropertiesResource +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Table Object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSTableGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Table (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +### Microsoft.Azure.Commands.CosmosDB.Models.PSTableGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSTableGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ResourceNotFoundException + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBTableThroughput.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBTableThroughput.md new file mode 100644 index 0000000000..2a46cadb4a --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDBTableThroughput.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbtablethroughput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBTableThroughput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBTableThroughput.md +--- + +# Update-AzCosmosDBTableThroughput + +## SYNOPSIS +Updates the throughput value of a CosmosDB Table. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDBTableThroughput [-Name <String>] -ResourceGroupName <String> -AccountName <String> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDBTableThroughput [-Name <String>] -ParentObject <PSDatabaseAccountGetResults> + [-Throughput <Int32>] [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDBTableThroughput [-Name <String>] -InputObject <PSTableGetResults> [-Throughput <Int32>] + [-AutoscaleMaxThroughput <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the throughput value of a CosmosDB Table. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzCosmosDBTableThroughput -AccountName "myAccountName" -ResourceGroupName "myResourceGroupName" -Name "myTableName" -Throughput $updatedThroughputValue +``` + +```output +Name : mxGp +Id : /subscriptions/{mySubscriptionId}/resourceGroups/{myResourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{myAccountName}/table/{myTableName}/throughputSettings/default +Throughput : {updatedThroughputValue} +MinimumThroughput : 400 +OfferReplacePending : +``` + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleMaxThroughput +Maximum Throughput value if autoscale is enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSTableGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +CosmosDB Account object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Throughput +The throughput of Table (RU/s). +Default value is 400. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDbClientEncryptionKey.md b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDbClientEncryptionKey.md new file mode 100644 index 0000000000..ec1282da55 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzCosmosDbClientEncryptionKey.md @@ -0,0 +1,290 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbclientencryptionkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDbClientEncryptionKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzCosmosDbClientEncryptionKey.md +--- + +# Update-AzCosmosDbClientEncryptionKey + +## SYNOPSIS +Updates the CosmosDB Client Encryption Key. Performs a client side patch operation by reading the existing Client Encryption Key. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzCosmosDbClientEncryptionKey -ResourceGroupName <String> -AccountName <String> -DatabaseName <String> + -Name <String> -KeyWrapMetadata <PSSqlKeyWrapMetadata> [-KeyEncryptionKeyResolver <IKeyEncryptionKeyResolver>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzCosmosDbClientEncryptionKey -Name <String> -KeyWrapMetadata <PSSqlKeyWrapMetadata> + [-KeyEncryptionKeyResolver <IKeyEncryptionKeyResolver>] -SqlDatabaseObject <PSSqlDatabaseGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzCosmosDbClientEncryptionKey -KeyWrapMetadata <PSSqlKeyWrapMetadata> + [-KeyEncryptionKeyResolver <IKeyEncryptionKeyResolver>] -InputObject <PSSqlClientEncryptionKeyGetResults> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzCosmosDbClientEncryptionKey** updates the CosmosDb Client Encryption Key. Performs a client side patch operation by reading the existing CosmosDB Client Encryption Key. + +## EXAMPLES + +### Example 1 +```powershell +$updatedKeyWrapMetadataObject = [Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata]::new([Microsoft.Azure.Management.CosmosDB.Models.KeyWrapMetadata]::new("myKekV2","AZURE_KEY_VAULT", "https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71", "RSA-OAEP")) +Update-AzCosmosDbClientEncryptionKey -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myClientEncryptionKeyName -KeyWrapMetadata $updatedKeyWrapMetadataObject +``` + +```output +Name : myContainerName +Id : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName/clientEncryptionKeys/myClientEncryptionKeyName +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetPropertiesResource +``` + +This example shows how a key is updated. If KeyEncryptionKeyResolver is not passed Azure Key Vault KeyResolver is used by default. +The first command creates a KeyWrapMetadata object with name myKekV2 of type AZURE_KEY_VAULT with value set to key id https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 and algorithm type "RSA-OAEP" used to encrypt the key. +In the second command a key with name as set in myClientEncryptionKeyName variable is updated with KeyWrapMetadata set to value returned by first command. + +### Example 2 +```powershell +$updatedKeyWrapMetadataObject = [Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata]::new([Microsoft.Azure.Management.CosmosDB.Models.KeyWrapMetadata]::new("myKekV2","AZURE_KEY_VAULT", "https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71", "RSA-OAEP")) +$azureKeyVaultKeyResolver = [Azure.Security.KeyVault.Keys.Cryptography.KeyResolver]::new([Azure.Identity.DefaultAzureCredential]::new()) +Update-AzCosmosDbClientEncryptionKey -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -Name myClientEncryptionKeyName -KeyWrapMetadata $updatedKeyWrapMetadataObject -KeyEncryptionKeyResolver $azureKeyVaultKeyResolver +``` + +```output +Name : myContainerName +Id : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName/clientEncryptionKeys/myClientEncryptionKeyName +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetPropertiesResource +``` + +This example shows how a key is updated and how KeyEncryptionKeyResolver can be passed as a parameter. +The first command creates a KeyWrapMetadata object with name myKekV2 of type AZURE_KEY_VAULT with value set to key id https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 and algorithm type "RSA-OAEP" used to encrypt the key. +The second command creates a Azure Key Vault KeyResolver object using the Azure Default credentials. +In the third command a key with name as set in myClientEncryptionKeyName variable is updated with KeyWrapMetadata set to value returned by first command and KeyEncryptionKeyResolver value set to KeyResolver object obtained via the second command. + +### Example 3 +```powershell +$updatedKeyWrapMetadataObject = [Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata]::new([Microsoft.Azure.Management.CosmosDB.Models.KeyWrapMetadata]::new("myKekV2","AZURE_KEY_VAULT", "https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71", "RSA-OAEP")) +$keyToUpdate = Get-AzCosmosDbClientEncryptionKey -AccountName myAccountName -DatabaseName myDatabaseName -ResourceGroupName myRgName -ClientEncryptionKeyName myClientEncryptionKeyName +Update-AzCosmosDbClientEncryptionKey -InputObject $keyToUpdate -KeyWrapMetadata $updatedKeyWrapMetadataObject -KeyEncryptionKeyResolver $azureKeyVaultKeyResolver +``` + +```output +Name : myContainerName +Id : /subscriptions/mySubscriptionId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName/clientEncryptionKeys/myClientEncryptionKeyName +Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetPropertiesResource +``` + +This example shows how a key is updated using an InputObject which is obtained by reading the key which has to be updated. +The first command creates a KeyWrapMetadata object with name myKekV2 of type AZURE_KEY_VAULT with value set to key id https://contoso.vault.azure.net/keys/myKekV2/78deebed173b48e48f55abf87ed4cf71 and algorithm type "RSA-OAEP" used to encrypt the key. +In the second command reads the key which is to be updated. +The third command updates the key which was read earlier in the second command. The object read in the second command is passed as the InputObject along with the updated KeyWrapMetadata obtained in the first command. + +## PARAMETERS + +### -AccountName +Name of the Cosmos DB database account. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Client Encryption Key object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetResults +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyResolver +IKeyEncryptionKeyResolver interface of type Azure.Core.Cryptography.IKeyEncryptionKeyResolver + +```yaml +Type: Azure.Core.Cryptography.IKeyEncryptionKeyResolver +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyWrapMetadata +KeyWrapMetaData Object of type Microsoft.Azure.Commands.CosmosDB.PSSqlKeyWrapMetadata. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Client Encryption Key name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet, ByParentObjectParameterSet +Aliases: ClientEncryptionKeyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlDatabaseObject +Sql Database object. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Byte[] + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlKeyWrapMetadata + +### Microsoft.Data.Encryption.Cryptography.EncryptionKeyStoreProvider + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlDatabaseGetResults + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetResults + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSSqlClientEncryptionKeyGetResults + +### Microsoft.Azure.Commands.CosmosDB.Exceptions.ResourceNotFoundException + +## NOTES + +## RELATED LINKS + +[Get-AzCosmosDbClientEncryptionKey](./Get-AzCosmosDbClientEncryptionKey.md) + +[New-AzCosmosDbClientEncryptionKey](./New-AzCosmosDbClientEncryptionKey.md) diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzManagedCassandraCluster.md b/azps-10.1.0/Az.CosmosDB/Update-AzManagedCassandraCluster.md new file mode 100644 index 0000000000..24f388ed62 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzManagedCassandraCluster.md @@ -0,0 +1,316 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azmanagedcassandracluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzManagedCassandraCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzManagedCassandraCluster.md +--- + +# Update-AzManagedCassandraCluster + +## SYNOPSIS +Update an existing Azure Managed Instances for Apache Cassandra cluster. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzManagedCassandraCluster -ResourceGroupName <String> -ClusterName <String> [-Tag <Hashtable>] + [-ExternalGossipCertificate <String[]>] [-ClientCertificate <String[]>] [-RepairEnabled <Boolean>] + [-TimeBetweenBackupInHours <Int32>] [-AuthenticationMethod <String>] [-CassandraVersion <String>] + [-ExternalSeedNode <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzManagedCassandraCluster -ResourceId <String> [-Tag <Hashtable>] + [-ExternalGossipCertificate <String[]>] [-ClientCertificate <String[]>] [-RepairEnabled <Boolean>] + [-TimeBetweenBackupInHours <Int32>] [-AuthenticationMethod <String>] [-CassandraVersion <String>] + [-ExternalSeedNode <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzManagedCassandraCluster -InputObject <PSClusterResource> [-Tag <Hashtable>] + [-ExternalGossipCertificate <String[]>] [-ClientCertificate <String[]>] [-RepairEnabled <Boolean>] + [-TimeBetweenBackupInHours <Int32>] [-AuthenticationMethod <String>] [-CassandraVersion <String>] + [-ExternalSeedNode <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzManagedCassandraCluster** cmdlet alters an existing managed Cassandra cluster. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzManagedCassandraCluster ` + -ResourceGroupName "resourceGroupName" ` + -ClusterName "clusterName" ` + -ExternalGossipCertificate "certificates" ` + -ClientCertificate "certificates" ` + -RepairEnabled $true +``` + +### Example 2 +```powershell +Update-AzManagedCassandraCluster ` + -ResourceId "clusterResourceId" ` + -ExternalGossipCertificate "certificates" ` + -ClientCertificate "certificates" ` + -RepairEnabled $true +``` + +### Example 3 +```powershell +$clusterResource | Update-AzManagedCassandraCluster ` + -ExternalGossipCertificate "certificates" ` + -ClientCertificate "certificates" ` + -RepairEnabled $true +``` + +## PARAMETERS + +### -AuthenticationMethod +How to authenticate clients, one of `Cassandra` (for password authentication), `Ldap` (for LDAP/AD authentication), or `None` (for no authentication required). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Cassandra +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CassandraVersion +Which version of Cassandra to run. Currently only 3.11 is supported. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 3.11 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientCertificate +The list of TLS certificates to use to authenticate clients. If this is omitted, all client connections still connect with TLS, but are not required to provide valid client certificates. If this is provided, clients most provide a valid TLS client certificate to connect to the cluster. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Name of the managed Cassandra cluster. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalGossipCertificate +A list of additional TLS certificates the managed Cassandra cluster will use to authenticate gossip. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalSeedNode +List of IP addresses of external seed nodes to bridge this cluster to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Managed Cassandra Cluster object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RepairEnabled +If true, managed Cassandra will run reaper to repair the database regularly. This should only be disabled for hybrid clusters which run their own repair process outside of Azure. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Hashtable of tags to set on the data center resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeBetweenBackupInHours +Hours between taking full backups of the cluster. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CosmosDB/Update-AzManagedCassandraDataCenter.md b/azps-10.1.0/Az.CosmosDB/Update-AzManagedCassandraDataCenter.md new file mode 100644 index 0000000000..610e278433 --- /dev/null +++ b/azps-10.1.0/Az.CosmosDB/Update-AzManagedCassandraDataCenter.md @@ -0,0 +1,256 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml +Module Name: Az.CosmosDB +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azmanagedcassandradatacenter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzManagedCassandraDataCenter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Update-AzManagedCassandraDataCenter.md +--- + +# Update-AzManagedCassandraDatacenter + +## SYNOPSIS +Update an existing Azure Managed Instances for Apache Cassandra data center. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Update-AzManagedCassandraDatacenter -ResourceGroupName <String> -ClusterName <String> -DatacenterName <String> + [-NodeCount <Int32>] [-Base64EncodedCassandraYamlFragment <String>] [-BackupStorageCustomerKeyUri <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzManagedCassandraDatacenter -ResourceId <String> [-NodeCount <Int32>] + [-Base64EncodedCassandraYamlFragment <String>] [-BackupStorageCustomerKeyUri <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzManagedCassandraDatacenter -InputObject <PSDataCenterResource> [-NodeCount <Int32>] + [-Base64EncodedCassandraYamlFragment <String>] [-BackupStorageCustomerKeyUri <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzManagedCassandraDatacenter -ParentObject <PSClusterResource> [-NodeCount <Int32>] + [-Base64EncodedCassandraYamlFragment <String>] [-BackupStorageCustomerKeyUri <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzManagedCassandraDataCenter** cmdlet updates an existing managed Cassandra data center. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzManagedCassandraDataCenter ` + -ResourceGroupName "resourceGroupName" ` + -ClusterName "clusterName" ` + -DataCenterName "dataCenterName" ` + -NodeCount 3 +``` + +## PARAMETERS + +### -BackupStorageCustomerKeyUri +URI to KeyVault key that is used to encrypt Cassandra backups. If not set, will use Azure's own keys. Ensure the system assigned identity of the cluster has been assigned appropriate permissions (key get/wrap/unwrap permissions) on the key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Base64EncodedCassandraYamlFragment +Fragment of configuration to include in `cassandra.yaml` on nodes of this data center, Base64 encoded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Name of the managed Cassandra cluster. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatacenterName +Managed Cassandra Datacenter Name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Managed Cassandra Datacenter object + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDataCenterResource +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NodeCount +The number of nodes to create in this data center. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 3 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Cassandra cluster object to create a data center in. + +```yaml +Type: Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSClusterResource + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDataCenterResource + +## OUTPUTS + +### Microsoft.Azure.Commands.CosmosDB.Models.PSDataCenterResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.CostManagement/Az.CostManagement.md b/azps-10.1.0/Az.CostManagement/Az.CostManagement.md new file mode 100644 index 0000000000..3a9fbdef25 --- /dev/null +++ b/azps-10.1.0/Az.CostManagement/Az.CostManagement.md @@ -0,0 +1,63 @@ +--- +Module Name: Az.CostManagement +Module Guid: 4cd9af10-559e-4fb9-8dcd-d3e8eb9e03b7 +Download Help Link: https://learn.microsoft.com/powershell/module/az.costmanagement +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Az.CostManagement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Az.CostManagement.md +--- + +# Az.CostManagement Module +## Description +Microsoft Azure PowerShell: Cost cmdlets + +## Az.CostManagement Cmdlets +### [Get-AzCostManagementExport](Get-AzCostManagementExport.md) +The operation to get the export for the defined scope by export name. + +### [Get-AzCostManagementExportExecutionHistory](Get-AzCostManagementExportExecutionHistory.md) +The operation to get the execution history of an export for the defined scope and export name. + +### [Invoke-AzCostManagementExecuteExport](Invoke-AzCostManagementExecuteExport.md) +The operation to execute an export. + +### [Invoke-AzCostManagementQuery](Invoke-AzCostManagementQuery.md) +Query the usage data for scope defined. + +### [Invoke-AzCostManagementReservationDetailReport](Invoke-AzCostManagementReservationDetailReport.md) +Generates the reservations details report for provided date range asynchronously based on enrollment id. +The Reservation usage details can be viewed only by certain enterprise roles. +For more details on the roles see, https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role + +### [New-AzCostManagementDetailReport](New-AzCostManagementDetailReport.md) +This API is the replacement for all previously release Usage Details APIs. +Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. +The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. +The 'Location' header will provide the endpoint to poll to get the result of the report generation. +The 'Retry-After' provides the duration to wait before polling for the generated report. +A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. +Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. +The details on the file(s) available for download will be available in the polling response body. + +### [New-AzCostManagementExport](New-AzCostManagementExport.md) +The operation to create or update a export. +Update operation requires latest eTag to be set in the request. +You may obtain the latest eTag by performing a get operation. +Create operation does not require eTag. + +### [New-AzCostManagementQueryComparisonExpressionObject](New-AzCostManagementQueryComparisonExpressionObject.md) +Create a in-memory object for QueryComparisonExpression + +### [New-AzCostManagementQueryFilterObject](New-AzCostManagementQueryFilterObject.md) +Create a in-memory object for QueryFilter + +### [Remove-AzCostManagementExport](Remove-AzCostManagementExport.md) +The operation to delete a export. + +### [Update-AzCostManagementExport](Update-AzCostManagementExport.md) +The operation to create or update a export. +Update operation requires latest eTag to be set in the request. +You may obtain the latest eTag by performing a get operation. +Create operation does not require eTag. + diff --git a/azps-10.1.0/Az.CostManagement/Get-AzCostManagementExport.md b/azps-10.1.0/Az.CostManagement/Get-AzCostManagementExport.md new file mode 100644 index 0000000000..6abd4e7622 --- /dev/null +++ b/azps-10.1.0/Az.CostManagement/Get-AzCostManagementExport.md @@ -0,0 +1,180 @@ +--- +external help file: +Module Name: Az.CostManagement +online version: https://learn.microsoft.com/powershell/module/az.costmanagement/get-azcostmanagementexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Get-AzCostManagementExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Get-AzCostManagementExport.md +--- + +# Get-AzCostManagementExport + +## SYNOPSIS +The operation to get the export for the defined scope by export name. + +## SYNTAX + +### List (Default) +``` +Get-AzCostManagementExport -Scope <String> [-Expand <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzCostManagementExport -Name <String> -Scope <String> [-Expand <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzCostManagementExport -InputObject <ICostManagementIdentity> [-Expand <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to get the export for the defined scope by export name. + +## EXAMPLES + +### Example 1: Get all AzCostManagementExports by scope +```powershell +Get-AzCostManagementExport -Scope 'subscriptions/**********' +``` + +```output +ETag Name Type +---- ---- ---- +"************" TestExport Microsoft.CostManagement/exports +"************" TestExport1 Microsoft.CostManagement/exports +"************" TestExport2 Microsoft.CostManagement/exports +``` + +Get all AzCostManagementExports by Scope + +### Example 2: Get AzCostManagementExport by Name and scope +```powershell +Get-AzCostManagementExport -Name 'TestExport' -Scope 'subscriptions/**********' +``` + +```output +ETag Name Type +---- ---- ---- +"************" TestExport Microsoft.CostManagement/exports +``` + +Get AzCostManagementExport by Name and scope + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +May be used to expand the properties within an export. +Currently only 'runHistory' is supported and will return information for the last 10 executions of the export. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.ICostManagementIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Export Name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ExportName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +This parameter defines the scope of costmanagement from different perspectives 'Subscription','ResourceGroup' and 'Provide Service'. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.ICostManagementIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IExport + +## 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 <ICostManagementIdentity>`: Identity Parameter + - `[AlertId <String>]`: Alert ID + - `[BillingAccountId <String>]`: Enrollment ID (Legacy BillingAccount ID) + - `[BillingProfileId <String>]`: BillingProfile ID + - `[ExportName <String>]`: Export Name. + - `[ExternalCloudProviderId <String>]`: This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. + - `[ExternalCloudProviderType <ExternalCloudProviderType?>]`: The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: The target operation Id. + - `[Scope <String>]`: The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. + - `[ViewName <String>]`: View name + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CostManagement/Get-AzCostManagementExportExecutionHistory.md b/azps-10.1.0/Az.CostManagement/Get-AzCostManagementExportExecutionHistory.md new file mode 100644 index 0000000000..111e7d942a --- /dev/null +++ b/azps-10.1.0/Az.CostManagement/Get-AzCostManagementExportExecutionHistory.md @@ -0,0 +1,159 @@ +--- +external help file: +Module Name: Az.CostManagement +online version: https://learn.microsoft.com/powershell/module/az.costmanagement/get-azcostmanagementexportexecutionhistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Get-AzCostManagementExportExecutionHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Get-AzCostManagementExportExecutionHistory.md +--- + +# Get-AzCostManagementExportExecutionHistory + +## SYNOPSIS +The operation to get the execution history of an export for the defined scope and export name. + +## SYNTAX + +### Get (Default) +``` +Get-AzCostManagementExportExecutionHistory -ExportName <String> -Scope <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzCostManagementExportExecutionHistory -InputObject <ICostManagementIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +The operation to get the execution history of an export for the defined scope and export name. + +## EXAMPLES + +### Example 1: Get AzCostManagementExportExecutionHistory +```powershell +Get-AzCostManagementExportExecutionHistory -ExportName 'TestExport' -Scope 'subscriptions/**********' +``` + +```output +ExecutionType ProcessingStartTime ProcessingEndTime Status FileName +------------- ------------------- ----------------- ------ -------- +Scheduled 2020/6/11 12:03:20 2020/6/11 12:03:43 Completed ad-hoc/TestExport/20200601-20200630/TestExport_00000000-0000-0000-0000-000000000000.csv +Scheduled 2020/6/12 12:03:37 2020/6/12 12:03:48 Completed ad-hoc/TestExport/20200601-20200630/TestExport_00000000-0000-0000-0000-000000000000.csv +``` + +Get AzCostManagementExportExecutionHistory By ExportName and Scope + +### Example 2: Get AzCostManagementExportExecutionHistory by InputObject +```powershell +$getExport = Get-AzCostManagementExport -Name 'TestExport' -Scope 'subscriptions/**********' +Get-AzCostManagementExportExecutionHistory -InputObject $getExport +``` + +```output +ExecutionType ProcessingStartTime ProcessingEndTime Status FileName +------------- ------------------- ----------------- ------ -------- +Scheduled 2020/6/11 12:03:20 2020/6/11 12:03:43 Completed ad-hoc/TestExport/20200601-20200630/TestExport_00000000-0000-0000-0000-000000000000.csv +Scheduled 2020/6/12 12:03:37 2020/6/12 12:03:48 Completed ad-hoc/TestExport/20200601-20200630/ +``` + +Get AzCostManagementExportExecutionHistory By InputObject + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportName +Export Name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.ICostManagementIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Scope +This parameter defines the scope of costmanagement from different perspectives 'Subscription','ResourceGroup' and 'Provide Service'. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.ICostManagementIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IExportExecution + +## 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 <ICostManagementIdentity>`: Identity Parameter + - `[AlertId <String>]`: Alert ID + - `[BillingAccountId <String>]`: Enrollment ID (Legacy BillingAccount ID) + - `[BillingProfileId <String>]`: BillingProfile ID + - `[ExportName <String>]`: Export Name. + - `[ExternalCloudProviderId <String>]`: This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. + - `[ExternalCloudProviderType <ExternalCloudProviderType?>]`: The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: The target operation Id. + - `[Scope <String>]`: The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. + - `[ViewName <String>]`: View name + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CostManagement/Invoke-AzCostManagementExecuteExport.md b/azps-10.1.0/Az.CostManagement/Invoke-AzCostManagementExecuteExport.md new file mode 100644 index 0000000000..26a27ac763 --- /dev/null +++ b/azps-10.1.0/Az.CostManagement/Invoke-AzCostManagementExecuteExport.md @@ -0,0 +1,191 @@ +--- +external help file: +Module Name: Az.CostManagement +online version: https://learn.microsoft.com/powershell/module/az.costmanagement/invoke-azcostmanagementexecuteexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Invoke-AzCostManagementExecuteExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Invoke-AzCostManagementExecuteExport.md +--- + +# Invoke-AzCostManagementExecuteExport + +## SYNOPSIS +The operation to execute an export. + +## SYNTAX + +### Execute (Default) +``` +Invoke-AzCostManagementExecuteExport -ExportName <String> -Scope <String> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ExecuteViaIdentity +``` +Invoke-AzCostManagementExecuteExport -InputObject <ICostManagementIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to execute an export. + +## EXAMPLES + +### Example 1: Invoke Export by ExportName and Scope +```powershell +Invoke-AzCostManagementExecuteExport -ExportName 'TestExport' -Scope 'subscriptions/**********' +``` + +Invoke Export by ExportName and Scope + +### Example 2: Invoke Export by InputObject +```powershell +$getExport = Get-AzCostManagementExport -Name 'TestExport' -Scope 'subscriptions/**********' +Invoke-AzCostManagementExecuteExport -InputObject $getExport +``` + +Invoke Export by InputObject + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportName +Export Name. + +```yaml +Type: System.String +Parameter Sets: Execute +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.ICostManagementIdentity +Parameter Sets: ExecuteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +This parameter defines the scope of costmanagement from different perspectives 'Subscription','ResourceGroup' and 'Provide Service'. + +```yaml +Type: System.String +Parameter Sets: Execute +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.ICostManagementIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ICostManagementIdentity>`: Identity Parameter + - `[AlertId <String>]`: Alert ID + - `[BillingAccountId <String>]`: Enrollment ID (Legacy BillingAccount ID) + - `[BillingProfileId <String>]`: BillingProfile ID + - `[ExportName <String>]`: Export Name. + - `[ExternalCloudProviderId <String>]`: This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. + - `[ExternalCloudProviderType <ExternalCloudProviderType?>]`: The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: The target operation Id. + - `[Scope <String>]`: The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. + - `[ViewName <String>]`: View name + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CostManagement/Invoke-AzCostManagementQuery.md b/azps-10.1.0/Az.CostManagement/Invoke-AzCostManagementQuery.md new file mode 100644 index 0000000000..ba7d062499 --- /dev/null +++ b/azps-10.1.0/Az.CostManagement/Invoke-AzCostManagementQuery.md @@ -0,0 +1,329 @@ +--- +external help file: +Module Name: Az.CostManagement +online version: https://learn.microsoft.com/powershell/module/az.costmanagement/invoke-azcostmanagementquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Invoke-AzCostManagementQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Invoke-AzCostManagementQuery.md +--- + +# Invoke-AzCostManagementQuery + +## SYNOPSIS +Query the usage data for scope defined. + +## SYNTAX + +### UsageExpanded (Default) +``` +Invoke-AzCostManagementQuery -Scope <String> -Timeframe <TimeframeType> -Type <ExportType> + [-ConfigurationColumn <String[]>] [-DatasetAggregation <Hashtable>] [-DatasetFilter <IQueryFilter>] + [-DatasetGranularity <GranularityType>] [-DatasetGrouping <IQueryGrouping[]>] [-TimePeriodFrom <DateTime>] + [-TimePeriodTo <DateTime>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UsageExpanded1 +``` +Invoke-AzCostManagementQuery -ExternalCloudProviderId <String> + -ExternalCloudProviderType <ExternalCloudProviderType> -Timeframe <TimeframeType> -Type <ExportType> + [-ConfigurationColumn <String[]>] [-DatasetAggregation <Hashtable>] [-DatasetFilter <IQueryFilter>] + [-DatasetGranularity <GranularityType>] [-DatasetGrouping <IQueryGrouping[]>] [-TimePeriodFrom <DateTime>] + [-TimePeriodTo <DateTime>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Query the usage data for scope defined. + +## EXAMPLES + +### Example 1: Invoke AzCostManagementQuery by Scope +```powershell +Invoke-AzCostManagementQuery -Scope "/subscriptions/***********" -Timeframe MonthToDate -Type Usage -DatasetGranularity 'Daily' +``` + +```output +Column Row +------ --- +{UsageDate, Currency} {20201101 USD, 20201102 USD, 20201103 USD, 20201104 USD…} +``` + +Invoke AzCostManagementQuery by Scope + +### Example 2: Invoke AzCostManagementQuery by Scope with Dimensions +```powershell +$dimensions = New-AzCostManagementQueryComparisonExpressionObject -Name 'ResourceGroup' -Value 'API' +$filter = New-AzCostManagementQueryFilterObject -Dimensions $dimensions +Invoke-AzCostManagementQuery -Type Usage -Scope "subscriptions/***********" -DatasetGranularity 'Monthly' -DatasetFilter $filter -Timeframe MonthToDate -Debug +``` + +```output +Column Row +------ --- +{BillingMonth, Currency} {} +``` + +Invoke AzCostManagementQuery by Scope with Dimensions + +## PARAMETERS + +### -ConfigurationColumn +Array of column names to be included in the query. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatasetAggregation +Dictionary of aggregation expression to use in the query. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatasetFilter +Has filter expression to use in the query. +To construct, see NOTES section for DATASETFILTER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IQueryFilter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatasetGranularity +The granularity of rows in the query. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.GranularityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatasetGrouping +Array of group by expression to use in the query. +To construct, see NOTES section for DATASETGROUPING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IQueryGrouping[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalCloudProviderId +This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. + +```yaml +Type: System.String +Parameter Sets: UsageExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalCloudProviderType +The external cloud provider type associated with dimension/query operations. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.ExternalCloudProviderType +Parameter Sets: UsageExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +This includes 'subscriptions/{subscriptionId}/' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. + +```yaml +Type: System.String +Parameter Sets: UsageExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeframe +The time frame for pulling data for the query. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.TimeframeType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimePeriodFrom +The start date to pull data from. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimePeriodTo +The end date to pull data to. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The type of the query. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.ExportType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IQueryResult + +## 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. + + +`DATASETFILTER <IQueryFilter>`: Has filter expression to use in the query. + - `[And <IQueryFilter[]>]`: The logical "AND" expression. Must have at least 2 items. + - `[Dimensions <IQueryComparisonExpression>]`: Has comparison expression for a dimension + - `Name <String>`: The name of the column to use in comparison. + - `Value <String[]>`: Array of values to use for comparison + - `[Not <IQueryFilter>]`: The logical "NOT" expression. + - `[Or <IQueryFilter[]>]`: The logical "OR" expression. Must have at least 2 items. + - `[Tag <IQueryComparisonExpression>]`: Has comparison expression for a tag + +`DATASETGROUPING <IQueryGrouping[]>`: Array of group by expression to use in the query. + - `Name <String>`: The name of the column to group. + - `Type <QueryColumnType>`: Has type of the column to group. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CostManagement/Invoke-AzCostManagementReservationDetailReport.md b/azps-10.1.0/Az.CostManagement/Invoke-AzCostManagementReservationDetailReport.md new file mode 100644 index 0000000000..5658575f41 --- /dev/null +++ b/azps-10.1.0/Az.CostManagement/Invoke-AzCostManagementReservationDetailReport.md @@ -0,0 +1,198 @@ +--- +external help file: +Module Name: Az.CostManagement +online version: https://learn.microsoft.com/powershell/module/az.costmanagement/invoke-azcostmanagementreservationdetailreport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Invoke-AzCostManagementReservationDetailReport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Invoke-AzCostManagementReservationDetailReport.md +--- + +# Invoke-AzCostManagementReservationDetailReport + +## SYNOPSIS +Generates the reservations details report for provided date range asynchronously based on enrollment id. +The Reservation usage details can be viewed only by certain enterprise roles. +For more details on the roles see, https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role + +## SYNTAX + +### By (Default) +``` +Invoke-AzCostManagementReservationDetailReport -BillingAccountId <String> -EndDate <String> + -StartDate <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### By1 +``` +Invoke-AzCostManagementReservationDetailReport -BillingAccountId <String> -BillingProfileId <String> + -EndDate <String> -StartDate <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Generates the reservations details report for provided date range asynchronously based on enrollment id. +The Reservation usage details can be viewed only by certain enterprise roles. +For more details on the roles see, https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role + +## EXAMPLES + +### Example 1: Generates the reservations details report for provided date range asynchronously based on billing account id +```powershell +Invoke-AzCostManagementReservationDetailReport -BillingAccountId "00000000-0000-0000-0000-0000000000" -StartDate "2022-10-01" -EndDate "2022-10-20" +``` + +This command generates the reservations details report for provided date range asynchronously based on billing account id. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingAccountId +Enrollment ID (Legacy BillingAccount ID) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingProfileId +BillingProfile ID + +```yaml +Type: System.String +Parameter Sets: By1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +End Date + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +Start Date + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IOperationStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CostManagement/New-AzCostManagementDetailReport.md b/azps-10.1.0/Az.CostManagement/New-AzCostManagementDetailReport.md new file mode 100644 index 0000000000..991d03fa2b --- /dev/null +++ b/azps-10.1.0/Az.CostManagement/New-AzCostManagementDetailReport.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.CostManagement +online version: https://learn.microsoft.com/powershell/module/az.costmanagement/new-azcostmanagementdetailreport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/New-AzCostManagementDetailReport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/New-AzCostManagementDetailReport.md +--- + +# New-AzCostManagementDetailReport + +## SYNOPSIS +This API is the replacement for all previously release Usage Details APIs. +Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. +The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. +The 'Location' header will provide the endpoint to poll to get the result of the report generation. +The 'Retry-After' provides the duration to wait before polling for the generated report. +A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. +Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. +The details on the file(s) available for download will be available in the polling response body. + +## SYNTAX + +``` +New-AzCostManagementDetailReport -Scope <String> [-BillingPeriod <String>] [-InvoiceId <String>] + [-Metric <CostDetailsMetricType>] [-TimePeriodEnd <String>] [-TimePeriodStart <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +This API is the replacement for all previously release Usage Details APIs. +Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. +The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. +The 'Location' header will provide the endpoint to poll to get the result of the report generation. +The 'Retry-After' provides the duration to wait before polling for the generated report. +A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. +Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. +The details on the file(s) available for download will be available in the polling response body. + +## EXAMPLES + +### Example 1: Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope +```powershell +New-AzCostManagementDetailReport -Scope "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f" -Metric 'ActualCost' -TimePeriodStart "2022-10-01" -TimePeriodEnd "2022-10-20" +``` + +This command requests to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingPeriod +This parameter can be used only by Enterprise Agreement customers. +Use the YearMonth(e.g. +202008) format. +This parameter cannot be used alongside either the invoiceId or timePeriod parameters. +If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InvoiceId +This parameter can only be used by Microsoft Customer Agreement customers. +Additionally, it can only be used at the Billing Profile or Customer scope. +This parameter cannot be used alongside either the billingPeriod or timePeriod parameters. +If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metric +The type of the detailed report. +By default ActualCost is provided + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.CostDetailsMetricType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope associated with usage details operations. +This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. +Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimePeriodEnd +The end date to pull data to. +example format 2020-03-15 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimePeriodStart +The start date to pull data from. +example format 2020-03-15 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20220501.ICostDetailsOperationResults + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CostManagement/New-AzCostManagementExport.md b/azps-10.1.0/Az.CostManagement/New-AzCostManagementExport.md new file mode 100644 index 0000000000..65c848d212 --- /dev/null +++ b/azps-10.1.0/Az.CostManagement/New-AzCostManagementExport.md @@ -0,0 +1,359 @@ +--- +external help file: +Module Name: Az.CostManagement +online version: https://learn.microsoft.com/powershell/module/az.costmanagement/new-azcostmanagementexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/New-AzCostManagementExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/New-AzCostManagementExport.md +--- + +# New-AzCostManagementExport + +## SYNOPSIS +The operation to create or update a export. +Update operation requires latest eTag to be set in the request. +You may obtain the latest eTag by performing a get operation. +Create operation does not require eTag. + +## SYNTAX + +``` +New-AzCostManagementExport -Name <String> -Scope <String> [-ConfigurationColumn <String[]>] + [-DataSetGranularity <GranularityType>] [-DefinitionTimeframe <TimeframeType>] [-DefinitionType <ExportType>] + [-DestinationContainer <String>] [-DestinationResourceId <String>] [-DestinationRootFolderPath <String>] + [-Format <FormatType>] [-RecurrencePeriodFrom <DateTime>] [-RecurrencePeriodTo <DateTime>] + [-ScheduleRecurrence <RecurrenceType>] [-ScheduleStatus <StatusType>] [-TimePeriodFrom <DateTime>] + [-TimePeriodTo <DateTime>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to create or update a export. +Update operation requires latest eTag to be set in the request. +You may obtain the latest eTag by performing a get operation. +Create operation does not require eTag. + +## EXAMPLES + +### Example 1: Create an AzCostManagementExport +```powershell +New-AzCostManagementExport -Scope "subscriptions/***********" -Name "CostManagementExportTest" -ScheduleStatus "Active" -ScheduleRecurrence "Daily" -RecurrencePeriodFrom "2020-10-31T20:00:00Z" -RecurrencePeriodTo "2020-11-30T00:00:00Z" -Format "Csv" -DestinationResourceId "/subscriptions/*************/resourceGroups/ResourceGroupTest/providers/Microsoft.Storage/storageAccounts/storageAccountTest" ` -DestinationContainer "exports" -DestinationRootFolderPath "ad-hoc" -DefinitionType "Usage" -DefinitionTimeframe "MonthToDate" -DatasetGranularity "Daily" +``` + +```output +ETag Name Type +---- ---- ---- +"********" TestExportDatasetAggregationInfosagdhaghj Microsoft.CostManagement/exports +``` + +Create an AzCostManagementExport + +## PARAMETERS + +### -ConfigurationColumn +Array of column names to be included in the export. +If not provided then the export will include all available columns. +The available columns can vary by customer channel (see examples). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataSetGranularity +The granularity of rows in the export. +Currently only 'Daily' is supported. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.GranularityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionTimeframe +The time frame for pulling data for the export. +If custom, then a specific time period must be provided. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.TimeframeType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionType +The type of the export. +Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.ExportType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationContainer +The name of the container where exports will be uploaded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationResourceId +The resource id of the storage account where exports will be delivered. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationRootFolderPath +The name of the directory where exports will be uploaded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +The format of the export being delivered. +Currently only 'Csv' is supported. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.FormatType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Export Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExportName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrencePeriodFrom +The start date of recurrence. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrencePeriodTo +The end date of recurrence. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleRecurrence +The schedule recurrence. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.RecurrenceType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleStatus +The status of the export's schedule. +If 'Inactive', the export's schedule is paused. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.StatusType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +This parameter defines the scope of costmanagement from different perspectives 'Subscription','ResourceGroup' and 'Provide Service'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimePeriodFrom +The start date for export data. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimePeriodTo +The end date for export data. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IExport + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CostManagement/New-AzCostManagementQueryComparisonExpressionObject.md b/azps-10.1.0/Az.CostManagement/New-AzCostManagementQueryComparisonExpressionObject.md new file mode 100644 index 0000000000..8f443d3dc6 --- /dev/null +++ b/azps-10.1.0/Az.CostManagement/New-AzCostManagementQueryComparisonExpressionObject.md @@ -0,0 +1,101 @@ +--- +external help file: +Module Name: Az.CostManagement +online version: https://learn.microsoft.com/powershell/module/az.CostManagement/new-AzCostManagementQueryComparisonExpressionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/New-AzCostManagementQueryComparisonExpressionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/New-AzCostManagementQueryComparisonExpressionObject.md +--- + +# New-AzCostManagementQueryComparisonExpressionObject + +## SYNOPSIS +Create a in-memory object for QueryComparisonExpression + +## SYNTAX + +``` +New-AzCostManagementQueryComparisonExpressionObject -Name <String> -Operator <OperatorType> -Value <String[]> + [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for QueryComparisonExpression + +## EXAMPLES + +### Example 1: Create a comparison expression object of query for cost management export +```powershell +New-AzCostManagementQueryComparisonExpressionObject -Name 'ResourceLocation' -Value @('East US', 'West Europe') +``` + +```output +Name Operator Value +---- -------- ----- +ResourceLocation In {East US, West Europe} +``` + +This command creates a comparison expression object of query for cost management export. + +## PARAMETERS + +### -Name +The name of the column to use in comparison. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operator +The operator to use for comparison. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.OperatorType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Array of values to use for comparison. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.QueryComparisonExpression + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CostManagement/New-AzCostManagementQueryFilterObject.md b/azps-10.1.0/Az.CostManagement/New-AzCostManagementQueryFilterObject.md new file mode 100644 index 0000000000..2924a9960b --- /dev/null +++ b/azps-10.1.0/Az.CostManagement/New-AzCostManagementQueryFilterObject.md @@ -0,0 +1,182 @@ +--- +external help file: +Module Name: Az.CostManagement +online version: https://learn.microsoft.com/powershell/module/az.CostManagement/new-AzCostManagementQueryFilterObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/New-AzCostManagementQueryFilterObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/New-AzCostManagementQueryFilterObject.md +--- + +# New-AzCostManagementQueryFilterObject + +## SYNOPSIS +Create a in-memory object for QueryFilter + +## SYNTAX + +``` +New-AzCostManagementQueryFilterObject [-And <IQueryFilter[]>] [-Dimensions <IQueryComparisonExpression>] + [-Not <IQueryFilter>] [-Or <IQueryFilter[]>] [-Tag <IQueryComparisonExpression>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for QueryFilter + +## EXAMPLES + +### Example 1: Create a filter object of query for cost management export +```powershell +$orDimension = New-AzCostManagementQueryComparisonExpressionObject -Name 'ResourceLocation' -Value @('East US', 'West Europe') +$orTag = New-AzCostManagementQueryComparisonExpressionObject -Name 'Environment' -Value @('UAT', 'Prod') +New-AzCostManagementQueryFilterObject -or @((New-AzCostManagementQueryFilterObject -Dimensions $orDimension), (New-AzCostManagementQueryFilterObject -Tag $orTag)) +``` + +```output +And : +Dimension : Microsoft.Azure.PowerShell.Cmdlets.Cost.Models.Api20211001.QueryComparisonExpression +Not : Microsoft.Azure.PowerShell.Cmdlets.Cost.Models.Api20211001.QueryFilter +Or : {Microsoft.Azure.PowerShell.Cmdlets.Cost.Models.Api20211001.QueryFilter, Microsoft.Azure.PowerShell.Cmdlets.Cost.Models.Api20211001.QueryFilter} +Tag : Microsoft.Azure.PowerShell.Cmdlets.Cost.Models.Api20211001.QueryComparisonExpression +``` + +this command creates a filter object of query for cost management export. + +## PARAMETERS + +### -And +The logical "AND" expression. +Must have at least 2 items. +To construct, see NOTES section for AND properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IQueryFilter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Dimensions +Has comparison expression for a dimensions. +To construct, see NOTES section for DIMENSIONS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IQueryComparisonExpression +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Not +The logical "NOT" expression. +To construct, see NOTES section for NOT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IQueryFilter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Or +The logical "OR" expression. +Must have at least 2 items. +To construct, see NOTES section for OR properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IQueryFilter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Has comparison expression for a tag. +To construct, see NOTES section for TAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IQueryComparisonExpression +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.QueryFilter + +## 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. + + +`AND <IQueryFilter[]>`: The logical "AND" expression. Must have at least 2 items. + - `[And <IQueryFilter[]>]`: The logical "AND" expression. Must have at least 2 items. + - `[Dimensions <IQueryComparisonExpression>]`: Has comparison expression for a dimension + - `Name <String>`: The name of the column to use in comparison. + - `Value <String[]>`: Array of values to use for comparison + - `[Not <IQueryFilter>]`: The logical "NOT" expression. + - `[Or <IQueryFilter[]>]`: The logical "OR" expression. Must have at least 2 items. + - `[Tag <IQueryComparisonExpression>]`: Has comparison expression for a tag + +`DIMENSIONS <IQueryComparisonExpression>`: Has comparison expression for a dimensions. + - `Name <String>`: The name of the column to use in comparison. + - `Value <String[]>`: Array of values to use for comparison + +`NOT <IQueryFilter>`: The logical "NOT" expression. + - `[And <IQueryFilter[]>]`: The logical "AND" expression. Must have at least 2 items. + - `[Dimensions <IQueryComparisonExpression>]`: Has comparison expression for a dimension + - `Name <String>`: The name of the column to use in comparison. + - `Value <String[]>`: Array of values to use for comparison + - `[Not <IQueryFilter>]`: The logical "NOT" expression. + - `[Or <IQueryFilter[]>]`: The logical "OR" expression. Must have at least 2 items. + - `[Tag <IQueryComparisonExpression>]`: Has comparison expression for a tag + +`OR <IQueryFilter[]>`: The logical "OR" expression. Must have at least 2 items. + - `[And <IQueryFilter[]>]`: The logical "AND" expression. Must have at least 2 items. + - `[Dimensions <IQueryComparisonExpression>]`: Has comparison expression for a dimension + - `Name <String>`: The name of the column to use in comparison. + - `Value <String[]>`: Array of values to use for comparison + - `[Not <IQueryFilter>]`: The logical "NOT" expression. + - `[Or <IQueryFilter[]>]`: The logical "OR" expression. Must have at least 2 items. + - `[Tag <IQueryComparisonExpression>]`: Has comparison expression for a tag + +`TAG <IQueryComparisonExpression>`: Has comparison expression for a tag. + - `Name <String>`: The name of the column to use in comparison. + - `Value <String[]>`: Array of values to use for comparison + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CostManagement/Remove-AzCostManagementExport.md b/azps-10.1.0/Az.CostManagement/Remove-AzCostManagementExport.md new file mode 100644 index 0000000000..7a99bcd383 --- /dev/null +++ b/azps-10.1.0/Az.CostManagement/Remove-AzCostManagementExport.md @@ -0,0 +1,191 @@ +--- +external help file: +Module Name: Az.CostManagement +online version: https://learn.microsoft.com/powershell/module/az.costmanagement/remove-azcostmanagementexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Remove-AzCostManagementExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Remove-AzCostManagementExport.md +--- + +# Remove-AzCostManagementExport + +## SYNOPSIS +The operation to delete a export. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCostManagementExport -Name <String> -Scope <String> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzCostManagementExport -InputObject <ICostManagementIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to delete a export. + +## EXAMPLES + +### Example 1: Delete the AzCostManagementExport by Scope and Name +```powershell +Remove-AzCostManagementExport -Scope 'subscriptions/********' -name 'TestExportDatasetAggregationInfoYouri' +``` + +Delete the AzCostManagementExport By Scope and ExportName + +### Example 2: Delete the AzCostManagementExport by Export Object +```powershell +$getExport = Get-AzCostManagementExport -Scope 'subscriptions/*********' -name 'TestExportDatasetAggregationYouori' +Remove-AzCostManagementExport -InputObject $getExport +``` + +Delete the AzCostManagementExport By InputObject + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.ICostManagementIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Export Name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ExportName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +This parameter defines the scope of costmanagement from different perspectives 'Subscription','ResourceGroup' and 'Provide Service'. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.ICostManagementIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ICostManagementIdentity>`: Identity Parameter + - `[AlertId <String>]`: Alert ID + - `[BillingAccountId <String>]`: Enrollment ID (Legacy BillingAccount ID) + - `[BillingProfileId <String>]`: BillingProfile ID + - `[ExportName <String>]`: Export Name. + - `[ExternalCloudProviderId <String>]`: This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. + - `[ExternalCloudProviderType <ExternalCloudProviderType?>]`: The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: The target operation Id. + - `[Scope <String>]`: The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. + - `[ViewName <String>]`: View name + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CostManagement/Update-AzCostManagementExport.md b/azps-10.1.0/Az.CostManagement/Update-AzCostManagementExport.md new file mode 100644 index 0000000000..d98c75c394 --- /dev/null +++ b/azps-10.1.0/Az.CostManagement/Update-AzCostManagementExport.md @@ -0,0 +1,435 @@ +--- +external help file: +Module Name: Az.CostManagement +online version: https://learn.microsoft.com/powershell/module/az.costmanagement/update-azcostmanagementexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Update-AzCostManagementExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CostManagement/help/Update-AzCostManagementExport.md +--- + +# Update-AzCostManagementExport + +## SYNOPSIS +The operation to create or update a export. +Update operation requires latest eTag to be set in the request. +You may obtain the latest eTag by performing a get operation. +Create operation does not require eTag. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCostManagementExport -Name <String> -Scope <String> [-ConfigurationColumn <String[]>] + [-DataSetGranularity <GranularityType>] [-DefinitionTimeframe <TimeframeType>] [-DefinitionType <ExportType>] + [-DestinationContainer <String>] [-DestinationResourceId <String>] [-DestinationRootFolderPath <String>] + [-ETag <String>] [-Format <FormatType>] [-RecurrencePeriodFrom <DateTime>] [-RecurrencePeriodTo <DateTime>] + [-ScheduleRecurrence <RecurrenceType>] [-ScheduleStatus <StatusType>] [-TimePeriodFrom <DateTime>] + [-TimePeriodTo <DateTime>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCostManagementExport -InputObject <ICostManagementIdentity> [-ConfigurationColumn <String[]>] + [-DataSetGranularity <GranularityType>] [-DefinitionTimeframe <TimeframeType>] [-DefinitionType <ExportType>] + [-DestinationContainer <String>] [-DestinationResourceId <String>] [-DestinationRootFolderPath <String>] + [-ETag <String>] [-Format <FormatType>] [-RecurrencePeriodFrom <DateTime>] [-RecurrencePeriodTo <DateTime>] + [-ScheduleRecurrence <RecurrenceType>] [-ScheduleStatus <StatusType>] [-TimePeriodFrom <DateTime>] + [-TimePeriodTo <DateTime>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to create or update a export. +Update operation requires latest eTag to be set in the request. +You may obtain the latest eTag by performing a get operation. +Create operation does not require eTag. + +## EXAMPLES + +### Example 1: Update AzCostManagementExport by scope and name +```powershell +Update-AzCostManagementExport -Scope "subscriptions//*********" -Name "TestExport" -ScheduleRecurrence 'Weekly' +``` + +```output +ETag Name Type +---- ---- ---- +"********" TestExportDatasetAggregationInfo Microsoft.CostManagement/exports +``` + +Update AzCostManagementExport by Scope and name + +### Example 2: Update AzCostManagementExport by InputObject +```powershell +$oldExport = Get-AzCostManagementExport -Scope "subscriptions/*********" -Name "TestExport" +Update-AzCostManagementExport -InputObject $oldExport -ScheduleRecurrence 'Weekly' +``` + +```output +ETag Name Type +---- ---- ---- +"********" TestExportDatasetAggregationInfo Microsoft.CostManagement/exports +``` + +Update AzCostManagementExport by InputObject + +## PARAMETERS + +### -ConfigurationColumn +Array of column names to be included in the export. +If not provided then the export will include all available columns. +The available columns can vary by customer channel (see examples). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataSetGranularity +The granularity of rows in the export. +Currently only 'Daily' is supported. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.GranularityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionTimeframe +The time frame for pulling data for the export. +If custom, then a specific time period must be provided. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.TimeframeType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionType +The type of the export. +Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.ExportType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationContainer +The name of the container where exports will be uploaded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationResourceId +The resource id of the storage account where exports will be delivered. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationRootFolderPath +The name of the directory where exports will be uploaded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETag +eTag of the resource. +To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +The format of the export being delivered. +Currently only 'Csv' is supported. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.FormatType +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.CostManagement.Models.ICostManagementIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Export Name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ExportName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrencePeriodFrom +The start date of recurrence. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrencePeriodTo +The end date of recurrence. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleRecurrence +The schedule recurrence. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.RecurrenceType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleStatus +The status of the export's schedule. +If 'Inactive', the export's schedule is paused. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.StatusType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +This parameter defines the scope of costmanagement from different perspectives 'Subscription','ResourceGroup' and 'Provide Service'. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimePeriodFrom +The start date for export data. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimePeriodTo +The end date for export data. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.ICostManagementIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IExport + +## 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 <ICostManagementIdentity>`: Identity Parameter + - `[AlertId <String>]`: Alert ID + - `[BillingAccountId <String>]`: Enrollment ID (Legacy BillingAccount ID) + - `[BillingProfileId <String>]`: BillingProfile ID + - `[ExportName <String>]`: Export Name. + - `[ExternalCloudProviderId <String>]`: This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. + - `[ExternalCloudProviderType <ExternalCloudProviderType?>]`: The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: The target operation Id. + - `[Scope <String>]`: The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. + - `[ViewName <String>]`: View name + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CustomLocation/Az.CustomLocation.md b/azps-10.1.0/Az.CustomLocation/Az.CustomLocation.md new file mode 100644 index 0000000000..f527de3aef --- /dev/null +++ b/azps-10.1.0/Az.CustomLocation/Az.CustomLocation.md @@ -0,0 +1,30 @@ +--- +Module Name: Az.CustomLocation +Module Guid: b5a68592-6b36-4d8f-b582-a157eb4dfacf +Download Help Link: https://learn.microsoft.com/powershell/module/az.customlocation +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomLocation/help/Az.CustomLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomLocation/help/Az.CustomLocation.md +--- + +# Az.CustomLocation Module +## Description +Microsoft Azure PowerShell: CustomLocation cmdlets + +## Az.CustomLocation Cmdlets +### [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. + +### [New-AzCustomLocation](New-AzCustomLocation.md) +Creates or updates a Custom Location in the specified Subscription and Resource Group + +### [Remove-AzCustomLocation](Remove-AzCustomLocation.md) +Deletes the Custom Location with the specified 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. + diff --git a/azps-10.1.0/Az.CustomLocation/Get-AzCustomLocation.md b/azps-10.1.0/Az.CustomLocation/Get-AzCustomLocation.md new file mode 100644 index 0000000000..7cc9dd8a55 --- /dev/null +++ b/azps-10.1.0/Az.CustomLocation/Get-AzCustomLocation.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.CustomLocation +online version: https://learn.microsoft.com/powershell/module/az.customlocation/get-azcustomlocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomLocation/help/Get-AzCustomLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomLocation/help/Get-AzCustomLocation.md +--- + +# Get-AzCustomLocation + +## SYNOPSIS +Gets the details of the customLocation with a specified resource group and name. + +## SYNTAX + +### List (Default) +``` +Get-AzCustomLocation [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzCustomLocation -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzCustomLocation -InputObject <ICustomLocationIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzCustomLocation -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the details of the customLocation with a specified resource group and name. + +## EXAMPLES + +### Example 1: List the details of the customLocation. +```powershell +Get-AzCustomLocation +``` + +```output +Location Name Namespace +-------- ---- ---- +eastus azps_test_cluster arc +``` + +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 +``` + +```output +Location Name Namespace +-------- ---- ---- +eastus azps_test_cluster arc +``` + +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 +``` + +```output +Location Name Namespace +-------- ---- ---- +eastus azps_test_cluster arc +``` + +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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Custom Locations name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.Api20210815.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 `<ICustomLocationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceName <String>]`: Custom Locations name. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CustomLocation/Get-AzCustomLocationEnabledResourceType.md b/azps-10.1.0/Az.CustomLocation/Get-AzCustomLocationEnabledResourceType.md new file mode 100644 index 0000000000..a165041c1e --- /dev/null +++ b/azps-10.1.0/Az.CustomLocation/Get-AzCustomLocationEnabledResourceType.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: Az.CustomLocation +online version: https://learn.microsoft.com/powershell/module/az.customlocation/get-azcustomlocationenabledresourcetype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomLocation/help/Get-AzCustomLocationEnabledResourceType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomLocation/help/Get-AzCustomLocationEnabledResourceType.md +--- + +# Get-AzCustomLocationEnabledResourceType + +## SYNOPSIS +Gets the list of the Enabled Resource Types. + +## SYNTAX + +``` +Get-AzCustomLocationEnabledResourceType -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the list of the Enabled Resource Types. + +## EXAMPLES + +### Example 1: Gets the list of the Enabled Resource Types. +```powershell +Get-AzCustomLocationEnabledResourceType -ResourceGroupName azps_test_group -Name azps_test_cluster +``` + +```output +Name Type +---- ---- +017e563408cfcbaad0604875fef1f0e5a36d5fefa5e81a4c1c212c5a77fbcbde Microsoft.ExtendedLocation/customLocations/enabledResourceTypes +``` + +Gets the list of the Enabled Resource Types. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Custom Locations name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.Api20210815.IEnabledResourceType + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CustomLocation/New-AzCustomLocation.md b/azps-10.1.0/Az.CustomLocation/New-AzCustomLocation.md new file mode 100644 index 0000000000..b6cff09290 --- /dev/null +++ b/azps-10.1.0/Az.CustomLocation/New-AzCustomLocation.md @@ -0,0 +1,317 @@ +--- +external help file: +Module Name: Az.CustomLocation +online version: https://learn.microsoft.com/powershell/module/az.customlocation/new-azcustomlocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomLocation/help/New-AzCustomLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomLocation/help/New-AzCustomLocation.md +--- + +# New-AzCustomLocation + +## SYNOPSIS +Creates or updates a Custom Location in the specified Subscription and Resource Group + +## SYNTAX + +``` +New-AzCustomLocation -Name <String> -ResourceGroupName <String> -ClusterExtensionId <String[]> + -HostResourceId <String> -Location <String> -Namespace <String> [-SubscriptionId <String>] + [-AuthenticationType <String>] [-AuthenticationValue <String>] [-DisplayName <String>] + [-IdentityType <ResourceIdentityType>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates 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 +```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 +``` + +```output +Location Name Namespace +-------- ---- ---- +eastus azps_test_cluster arc +``` + +Creates or updates a Custom Location in the specified Subscription and Resource Group + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationType +The type of the Custom Locations authentication + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationValue +The kubeconfig value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterExtensionId +Contains the reference to the add-on that contains charts to deploy CRDs and operators. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display name for the Custom Locations location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostResourceId +Connected Cluster or AKS Cluster. +The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Custom Locations name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Kubernetes namespace that will be created on the specified cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.Api20210815.ICustomLocation + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CustomLocation/Remove-AzCustomLocation.md b/azps-10.1.0/Az.CustomLocation/Remove-AzCustomLocation.md new file mode 100644 index 0000000000..df9bdac8db --- /dev/null +++ b/azps-10.1.0/Az.CustomLocation/Remove-AzCustomLocation.md @@ -0,0 +1,230 @@ +--- +external help file: +Module Name: Az.CustomLocation +online version: https://learn.microsoft.com/powershell/module/az.customlocation/remove-azcustomlocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomLocation/help/Remove-AzCustomLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomLocation/help/Remove-AzCustomLocation.md +--- + +# Remove-AzCustomLocation + +## SYNOPSIS +Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCustomLocation -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzCustomLocation -InputObject <ICustomLocationIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id. + +## EXAMPLES + +### Example 1: Deletes the Custom Location. +```powershell +Remove-AzCustomLocation -ResourceGroupName azps_test_group -Name azps_test_cluster +``` + +Deletes the Custom Location. + +### Example 2: Deletes the Custom Location. +```powershell +Get-AzCustomLocation -ResourceGroupName azps_test_group -Name azps_test_cluster | Remove-AzCustomLocation +``` + +Deletes the Custom Location. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Custom Locations name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ICustomLocationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceName <String>]`: Custom Locations name. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CustomLocation/Update-AzCustomLocation.md b/azps-10.1.0/Az.CustomLocation/Update-AzCustomLocation.md new file mode 100644 index 0000000000..5565693680 --- /dev/null +++ b/azps-10.1.0/Az.CustomLocation/Update-AzCustomLocation.md @@ -0,0 +1,323 @@ +--- +external help file: +Module Name: Az.CustomLocation +online version: https://learn.microsoft.com/powershell/module/az.customlocation/update-azcustomlocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomLocation/help/Update-AzCustomLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomLocation/help/Update-AzCustomLocation.md +--- + +# Update-AzCustomLocation + +## SYNOPSIS +Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCustomLocation -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AuthenticationType <String>] [-AuthenticationValue <String>] [-ClusterExtensionId <String[]>] + [-DisplayName <String>] [-HostResourceId <String>] [-IdentityType <ResourceIdentityType>] + [-Namespace <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCustomLocation -InputObject <ICustomLocationIdentity> [-AuthenticationType <String>] + [-AuthenticationValue <String>] [-ClusterExtensionId <String[]>] [-DisplayName <String>] + [-HostResourceId <String>] [-IdentityType <ResourceIdentityType>] [-Namespace <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription. + +## EXAMPLES + +### 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 +``` + +```output +Location Name Namespace +-------- ---- ---- +eastus azps_test_cluster_1 arc +``` + +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 +``` + +```output +Location Name Namespace +-------- ---- ---- +eastus azps_test_cluster_1 arc +``` + +Updates a Custom Location. + +## PARAMETERS + +### -AuthenticationType +The type of the Custom Locations authentication + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationValue +The kubeconfig value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterExtensionId +Contains the reference to the add-on that contains charts to deploy CRDs and operators. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display name for the Custom Locations location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostResourceId +Connected Cluster or AKS Cluster. +The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Support.ResourceIdentityType +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.CustomLocation.Models.ICustomLocationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Custom Locations name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Kubernetes namespace that will be created on the specified cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.Api20210815.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 `<ICustomLocationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceName <String>]`: Custom Locations name. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CustomProviders/Az.CustomProviders.md b/azps-10.1.0/Az.CustomProviders/Az.CustomProviders.md new file mode 100644 index 0000000000..c4f0ceb195 --- /dev/null +++ b/azps-10.1.0/Az.CustomProviders/Az.CustomProviders.md @@ -0,0 +1,37 @@ +--- +Module Name: Az.CustomProviders +Module Guid: b98dded0-6e9a-4371-b2c6-d74464fb724b +Download Help Link: https://learn.microsoft.com/powershell/module/az.customproviders +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/Az.CustomProviders.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/Az.CustomProviders.md +--- + +# Az.CustomProviders Module +## Description +Microsoft Azure PowerShell: Custom Providers cmdlets + +## Az.CustomProviders Cmdlets +### [Get-AzCustomProvider](Get-AzCustomProvider.md) +Gets the custom resource provider manifest. + +### [Get-AzCustomProviderAssociation](Get-AzCustomProviderAssociation.md) +Get an association. + +### [New-AzCustomProvider](New-AzCustomProvider.md) +Creates or updates the custom resource provider. + +### [New-AzCustomProviderAssociation](New-AzCustomProviderAssociation.md) +Create or update an association. + +### [Remove-AzCustomProvider](Remove-AzCustomProvider.md) +Deletes the custom resource provider. + +### [Remove-AzCustomProviderAssociation](Remove-AzCustomProviderAssociation.md) +Delete an association. + +### [Update-AzCustomProvider](Update-AzCustomProvider.md) +Updates an existing custom resource provider. +The only value that can be updated via PATCH currently is the tags. + diff --git a/azps-10.1.0/Az.CustomProviders/Get-AzCustomProvider.md b/azps-10.1.0/Az.CustomProviders/Get-AzCustomProvider.md new file mode 100644 index 0000000000..65f416e33c --- /dev/null +++ b/azps-10.1.0/Az.CustomProviders/Get-AzCustomProvider.md @@ -0,0 +1,188 @@ +--- +external help file: +Module Name: Az.CustomProviders +online version: https://learn.microsoft.com/powershell/module/az.customproviders/get-azcustomprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/Get-AzCustomProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/Get-AzCustomProvider.md +--- + +# Get-AzCustomProvider + +## SYNOPSIS +Gets the custom resource provider manifest. + +## SYNTAX + +### List1 (Default) +``` +Get-AzCustomProvider [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzCustomProvider -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzCustomProvider -InputObject <ICustomProvidersIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzCustomProvider -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the custom resource provider manifest. + +## EXAMPLES + +### Example 1: List all Custom Providers in a subscription +```powershell +Get-AzCustomProvider +``` + +```output +Location Name Type +-------- ---- ---- +West US 2 Namespace.Type Microsoft.CustomProviders/resourceproviders +East US 2 Namespace2.Type Microsoft.CustomProviders/resourceproviders +``` + +Lists all the custom providers in a subscription + +### Example 2: Get a single custom provider +```powershell +Get-AzCustomProvider -ResourceGroupName myRg -Name Namespace.Type | Format-List +``` + +```output +Action : +Id : /subscriptions/xxxxx-yyyyy-xxxx-yyyy/resourceGroups/mc-cp01/providers/Microsoft.CustomProviders/resourceproviders/Namespace.Type +Location : West US 2 +Name : Namespace.Type +ProvisioningState : Succeeded +ResourceType : {CustomRoute1, associations} +Tag : Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.Api20180901Preview.ResourceTags +Type : Microsoft.CustomProviders/resourceproviders +Validation : + +``` + +Gets details for a single custom provider. +Use Format-List to show object details on the screen. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.ICustomProvidersIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the resource provider. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ResourceProviderName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.ICustomProvidersIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.Api20180901Preview.ICustomRpManifest + +## 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 `<ICustomProvidersIdentity>`: Identity Parameter + - `[AssociationName <String>]`: The name of the association. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[ResourceProviderName <String>]`: The name of the resource provider. + - `[Scope <String>]`: The scope of the association. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CustomProviders/Get-AzCustomProviderAssociation.md b/azps-10.1.0/Az.CustomProviders/Get-AzCustomProviderAssociation.md new file mode 100644 index 0000000000..3dcce0cb3e --- /dev/null +++ b/azps-10.1.0/Az.CustomProviders/Get-AzCustomProviderAssociation.md @@ -0,0 +1,157 @@ +--- +external help file: +Module Name: Az.CustomProviders +online version: https://learn.microsoft.com/powershell/module/az.customproviders/get-azcustomproviderassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/Get-AzCustomProviderAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/Get-AzCustomProviderAssociation.md +--- + +# Get-AzCustomProviderAssociation + +## SYNOPSIS +Get an association. + +## SYNTAX + +### List (Default) +``` +Get-AzCustomProviderAssociation -Scope <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzCustomProviderAssociation -Name <String> -Scope <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzCustomProviderAssociation -InputObject <ICustomProvidersIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get an association. + +## EXAMPLES + +### Example 1: List custom provider associations +```powershell +Get-AzCustomProviderAssociation +``` + +```output +Location Name Type +-------- ---- ---- +East US 2 MyAssoc Microsoft.CustomProviders/associations +``` + +List all custom provider associations for a given scope. + +### Example 2: Get an association +```powershell +Get-AzCustomProviderAssociation -Scope $resourceId -Name MyAssoc +``` + +```output +Location Name Type +-------- ---- ---- +East US 2 MyAssoc Microsoft.CustomProviders/associations +``` + +Get details for a single CustomProvider association + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.ICustomProvidersIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the association. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AssociationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the association. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.ICustomProvidersIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.Api20180901Preview.IAssociation + +## 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 `<ICustomProvidersIdentity>`: Identity Parameter + - `[AssociationName <String>]`: The name of the association. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[ResourceProviderName <String>]`: The name of the resource provider. + - `[Scope <String>]`: The scope of the association. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CustomProviders/New-AzCustomProvider.md b/azps-10.1.0/Az.CustomProviders/New-AzCustomProvider.md new file mode 100644 index 0000000000..d1bdba4f40 --- /dev/null +++ b/azps-10.1.0/Az.CustomProviders/New-AzCustomProvider.md @@ -0,0 +1,291 @@ +--- +external help file: +Module Name: Az.CustomProviders +online version: https://learn.microsoft.com/powershell/module/az.customproviders/new-azcustomprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/New-AzCustomProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/New-AzCustomProvider.md +--- + +# New-AzCustomProvider + +## SYNOPSIS +Creates or updates the custom resource provider. + +## SYNTAX + +``` +New-AzCustomProvider -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-Action <ICustomRpActionRouteDefinition[]>] [-ResourceType <ICustomRpResourceTypeRouteDefinition[]>] + [-Tag <Hashtable>] [-Validation <ICustomRpValidations[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the custom resource provider. + +## EXAMPLES + +### Example 1: Create a custom provider +```powershell +New-AzCustomProvider -ResourceGroupName myRG -Name Namespace.Type -Location "West US 2" -ResourceType @{Name="CustomRoute1"; Endpoint="https://www.contoso.com/"} +``` + +```output +Location Name Type +-------- ---- ---- +West US 2 Namespace.Type Microsoft.CustomProviders/resourceproviders +``` + +Create a custom resource provider + +### Example 2: Create a custom provider with associations +```powershell +New-AzCustomProvider -ResourceGroupName myRG -Name Namespace2.Type -Location "West US 2" -ResourceType @{Name="CustomRoute1"; Endpoint="https://www.contoso.com/"}, @{Name="Associations"; Endpoint="https://contoso.com/myService"; RoutingType="Proxy,Cache,Extension"} +``` + +```output +Location Name Type +-------- ---- ---- +West US 2 Namespace2.Type Microsoft.CustomProviders/resourceproviders +``` + +Create a custom provider, with a route for Custom provider associations. + +## PARAMETERS + +### -Action +A list of actions that the custom resource provider implements. +To construct, see NOTES section for ACTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.Api20180901Preview.ICustomRpActionRouteDefinition[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the resource provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceProviderName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +A list of resource types that the custom resource provider implements. +To construct, see NOTES section for RESOURCETYPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.Api20180901Preview.ICustomRpResourceTypeRouteDefinition[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Validation +A list of validations to run on the custom resource provider's requests. +To construct, see NOTES section for VALIDATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.Api20180901Preview.ICustomRpValidations[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.Api20180901Preview.ICustomRpManifest + +## 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. + + +ACTION <ICustomRpActionRouteDefinition[]>: A list of actions that the custom resource provider implements. + - `Endpoint <String>`: The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}') + - `Name <String>`: The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') + - `[RoutingType <ActionRouting?>]`: The routing types that are supported for action requests. + +RESOURCETYPE <ICustomRpResourceTypeRouteDefinition[]>: A list of resource types that the custom resource provider implements. + - `Endpoint <String>`: The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}') + - `Name <String>`: The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') + - `[RoutingType <ResourceTypeRouting?>]`: The routing types that are supported for resource requests. + +VALIDATION <ICustomRpValidations[]>: A list of validations to run on the custom resource provider's requests. + - `Specification <String>`: A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. + - `[ValidationType <ValidationType?>]`: The type of validation to run against a matching request. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CustomProviders/New-AzCustomProviderAssociation.md b/azps-10.1.0/Az.CustomProviders/New-AzCustomProviderAssociation.md new file mode 100644 index 0000000000..b00fd9b516 --- /dev/null +++ b/azps-10.1.0/Az.CustomProviders/New-AzCustomProviderAssociation.md @@ -0,0 +1,180 @@ +--- +external help file: +Module Name: Az.CustomProviders +online version: https://learn.microsoft.com/powershell/module/az.customproviders/new-azcustomproviderassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/New-AzCustomProviderAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/New-AzCustomProviderAssociation.md +--- + +# New-AzCustomProviderAssociation + +## SYNOPSIS +Create or update an association. + +## SYNTAX + +``` +New-AzCustomProviderAssociation -Name <String> -Scope <String> [-TargetResourceId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update an association. + +## EXAMPLES + +### Example 1: Create a custom provider association +```powershell +$provider = Get-AzCustomProvider -ResourceGroupName myRg -Name Namespace.Type +New-AzCustomProviderAssociation -Scope $resourceId -Name MyAssoc -TargetResourceId $provider.Id +``` + +```output +Location Name Type +-------- ---- ---- +East US 2 MyAssoc Microsoft.CustomProviders/associations +``` + +Create a custom provider association, the associated target provioder must be properly configured with a route for "associations" + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the association. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AssociationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the association. +The scope can be any valid REST resource instance. +For example, use '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}' for a virtual machine resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceId +The REST resource instance of the target resource for this association. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.Api20180901Preview.IAssociation + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CustomProviders/Remove-AzCustomProvider.md b/azps-10.1.0/Az.CustomProviders/Remove-AzCustomProvider.md new file mode 100644 index 0000000000..9be14e96d4 --- /dev/null +++ b/azps-10.1.0/Az.CustomProviders/Remove-AzCustomProvider.md @@ -0,0 +1,237 @@ +--- +external help file: +Module Name: Az.CustomProviders +online version: https://learn.microsoft.com/powershell/module/az.customproviders/remove-azcustomprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/Remove-AzCustomProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/Remove-AzCustomProvider.md +--- + +# Remove-AzCustomProvider + +## SYNOPSIS +Deletes the custom resource provider. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCustomProvider -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzCustomProvider -InputObject <ICustomProvidersIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the custom resource provider. + +## EXAMPLES + +### Example 1: Remove a custom provider. +```powershell +Remove-AzCustomProvider -ResourceGroupName myRg -Name Namespace.Type +``` + +Remove a custom provider + +### Example 2: Remove a custom provider with PassThru +```powershell +Remove-AzCustomProvider -ResourceGroupName myRg -Name Namespace.Type -PassThru +``` + +```output +True +``` + +Remove a custom provider, using the PassThru feature to indicate success or failure. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.ICustomProvidersIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the resource provider. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ResourceProviderName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.ICustomProvidersIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ICustomProvidersIdentity>`: Identity Parameter + - `[AssociationName <String>]`: The name of the association. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[ResourceProviderName <String>]`: The name of the resource provider. + - `[Scope <String>]`: The scope of the association. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CustomProviders/Remove-AzCustomProviderAssociation.md b/azps-10.1.0/Az.CustomProviders/Remove-AzCustomProviderAssociation.md new file mode 100644 index 0000000000..c857daea49 --- /dev/null +++ b/azps-10.1.0/Az.CustomProviders/Remove-AzCustomProviderAssociation.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: Az.CustomProviders +online version: https://learn.microsoft.com/powershell/module/az.customproviders/remove-azcustomproviderassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/Remove-AzCustomProviderAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/Remove-AzCustomProviderAssociation.md +--- + +# Remove-AzCustomProviderAssociation + +## SYNOPSIS +Delete an association. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzCustomProviderAssociation -Name <String> -Scope <String> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzCustomProviderAssociation -InputObject <ICustomProvidersIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete an association. + +## EXAMPLES + +### Example 1: Remove a custom provider association. +```powershell +Remove-AzCustomProviderAssociation -Scope $id -Name Namespace.Type +``` + +Remove a custom provider association. + +### Example 2: Remove a custom provider association with Piping +```powershell +Get-AzCustomProviderAssociation | Remove-AzCustomProviderAssociation -PassThru +``` + +```output +True +``` + +Remove a custom provider association, using piping and the PassThru feature to indicate success or failure. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.ICustomProvidersIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the association. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AssociationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the association. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.ICustomProvidersIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ICustomProvidersIdentity>`: Identity Parameter + - `[AssociationName <String>]`: The name of the association. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[ResourceProviderName <String>]`: The name of the resource provider. + - `[Scope <String>]`: The scope of the association. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.CustomProviders/Update-AzCustomProvider.md b/azps-10.1.0/Az.CustomProviders/Update-AzCustomProvider.md new file mode 100644 index 0000000000..dd1f81fd8c --- /dev/null +++ b/azps-10.1.0/Az.CustomProviders/Update-AzCustomProvider.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.CustomProviders +online version: https://learn.microsoft.com/powershell/module/az.customproviders/update-azcustomprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/Update-AzCustomProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CustomProviders/help/Update-AzCustomProvider.md +--- + +# Update-AzCustomProvider + +## SYNOPSIS +Updates an existing custom resource provider. +The only value that can be updated via PATCH currently is the tags. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzCustomProvider -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzCustomProvider -InputObject <ICustomProvidersIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing custom resource provider. +The only value that can be updated via PATCH currently is the tags. + +## EXAMPLES + +### Example 1: Add Tags to a custom Provider +```powershell +Update-AzCustomProvider -ResourceGroupName myRg -Name Namespace.Type -Tag @{MyTag="MyValue"} | Format-List +``` + +```output +Action : +Id : /subscriptions/xxxxx-yyyyy-xxxx-yyyy/resourceGroups/mc-cp01/providers/Microsoft.CustomProviders/resourceproviders/Namespace.Type +Location : West US 2 +Name : Namespace.Type +ProvisioningState : Succeeded +ResourceType : {CustomRoute1, associations} +Tag : Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.Api20180901Preview.ResourceTags +Type : Microsoft.CustomProviders/resourceproviders +Validation : +``` + +Update the tags of a custom provider. + +### Example 2: Update custom provider with piping +```powershell +Get-AzCustomProvider -ResourceGroupName myRg -Name Namespace.Type | Update-AzCustomProvider -Tag @{MyTag="MyValue"} +``` + +```output +Location Name Type +-------- ---- ---- +West US 2 Namespace.Type Microsoft.CustomProviders/resourceproviders +``` + +Update a custom provider using piping. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.ICustomProvidersIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the resource provider. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ResourceProviderName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.ICustomProvidersIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.CustomProviders.Models.Api20180901Preview.ICustomRpManifest + +## 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 `<ICustomProvidersIdentity>`: Identity Parameter + - `[AssociationName <String>]`: The name of the association. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[ResourceProviderName <String>]`: The name of the resource provider. + - `[Scope <String>]`: The scope of the association. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Dashboard/Az.Dashboard.md b/azps-10.1.0/Az.Dashboard/Az.Dashboard.md new file mode 100644 index 0000000000..3b48c41162 --- /dev/null +++ b/azps-10.1.0/Az.Dashboard/Az.Dashboard.md @@ -0,0 +1,31 @@ +--- +Module Name: Az.Dashboard +Module Guid: 8475f339-2250-485a-a9cc-aba350de72d2 +Download Help Link: https://learn.microsoft.com/powershell/module/az.dashboard +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dashboard/help/Az.Dashboard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dashboard/help/Az.Dashboard.md +--- + +# Az.Dashboard Module +## Description +Microsoft Azure PowerShell: Dashboard cmdlets + +## Az.Dashboard Cmdlets +### [Get-AzGrafana](Get-AzGrafana.md) +Get the properties of a specific workspace for Grafana resource. + +### [New-AzGrafana](New-AzGrafana.md) +Create or update a workspace for Grafana resource. +This API is idempotent, so user can either create a new grafana or update an existing grafana. + +### [New-AzGrafanaMonitorWorkspaceIntegrationObject](New-AzGrafanaMonitorWorkspaceIntegrationObject.md) +Create an in-memory object for AzureMonitorWorkspaceIntegration. + +### [Remove-AzGrafana](Remove-AzGrafana.md) +Delete a workspace for Grafana resource. + +### [Update-AzGrafana](Update-AzGrafana.md) +Update a workspace for Grafana resource. + diff --git a/azps-10.1.0/Az.Dashboard/Get-AzGrafana.md b/azps-10.1.0/Az.Dashboard/Get-AzGrafana.md new file mode 100644 index 0000000000..6783509138 --- /dev/null +++ b/azps-10.1.0/Az.Dashboard/Get-AzGrafana.md @@ -0,0 +1,191 @@ +--- +external help file: +Module Name: Az.Dashboard +online version: https://learn.microsoft.com/powershell/module/az.dashboard/get-azgrafana +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dashboard/help/Get-AzGrafana.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dashboard/help/Get-AzGrafana.md +--- + +# Get-AzGrafana + +## SYNOPSIS +Get the properties of a specific workspace for Grafana resource. + +## SYNTAX + +### List (Default) +``` +Get-AzGrafana [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzGrafana -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzGrafana -InputObject <IDashboardIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzGrafana -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the properties of a specific workspace for Grafana resource. + +## EXAMPLES + +### Example 1: List the specific workspace. +```powershell +Get-AzGrafana +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstest-grafana azpstest-gp +``` + +List the specific workspace. + +### Example 2: Get the properties of a specific workspace for Resource Group. +```powershell +Get-AzGrafana -ResourceGroupName azpstest-gp +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstest-grafana azpstest-gp +``` + +Get the properties of a specific workspace for Resource Group. + +### Example 3: Get the properties of a specific workspace for Grafana resource. +```powershell +Get-AzGrafana -ResourceGroupName azpstest-gp -GrafanaName azpstest-grafana +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstest-grafana azpstest-gp +``` + +Get the properties of a specific workspace for Grafana resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.IDashboardIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The workspace name of Azure Managed Grafana. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: GrafanaName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.IDashboardIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IManagedGrafana + +## 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 <IDashboardIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[PrivateEndpointConnectionName <String>]`: The private endpoint connection name of Azure Managed Grafana. + - `[PrivateLinkResourceName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The workspace name of Azure Managed Grafana. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Dashboard/New-AzGrafana.md b/azps-10.1.0/Az.Dashboard/New-AzGrafana.md new file mode 100644 index 0000000000..a5ed17eee0 --- /dev/null +++ b/azps-10.1.0/Az.Dashboard/New-AzGrafana.md @@ -0,0 +1,362 @@ +--- +external help file: +Module Name: Az.Dashboard +online version: https://learn.microsoft.com/powershell/module/az.dashboard/new-azgrafana +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dashboard/help/New-AzGrafana.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dashboard/help/New-AzGrafana.md +--- + +# New-AzGrafana + +## SYNOPSIS +Create or update a workspace for Grafana resource. +This API is idempotent, so user can either create a new grafana or update an existing grafana. + +## SYNTAX + +``` +New-AzGrafana -Name <String> -ResourceGroupName <String> -ApiKey <ApiKey> + -AutoGeneratedDomainNameLabelScope <AutoGeneratedDomainNameLabelScope> + -DeterministicOutboundIP <DeterministicOutboundIP> -IdentityType <ManagedServiceIdentityType> + -Location <String> -PublicNetworkAccess <PublicNetworkAccess> -SkuName <String> + -ZoneRedundancy <ZoneRedundancy> [-SubscriptionId <String>] [-IdentityUserAssignedIdentity <Hashtable>] + [-MonitorWorkspaceIntegration <IAzureMonitorWorkspaceIntegration[]>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a workspace for Grafana resource. +This API is idempotent, so user can either create a new grafana or update an existing grafana. + +## EXAMPLES + +### Example 1: Create or update a workspace for Grafana resource. +```powershell +New-AzGrafana -Name azpstest-grafana -ResourceGroupName azpstest-gp -ApiKey Enabled -AutoGeneratedDomainNameLabelScope 'TenantReuse' -DeterministicOutboundIP 'Enabled' -IdentityType 'SystemAssigned' -Location eastus -PublicNetworkAccess 'Enabled' -SkuName Standard -ZoneRedundancy 'Enabled' -Tag @{"Environment"="Dev"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstest-grafana azpstest-gp +``` + +Create or update a workspace for Grafana resource. +This API is idempotent, so user can either create a new grafana or update an existing grafana. + +## PARAMETERS + +### -ApiKey +The api key setting of the Grafana instance. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Support.ApiKey +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoGeneratedDomainNameLabelScope +Scope for dns deterministic name hash calculation. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Support.AutoGeneratedDomainNameLabelScope +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeterministicOutboundIP +Whether a Grafana instance uses deterministic outbound IPs. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Support.DeterministicOutboundIP +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the grafana resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorWorkspaceIntegration +The MonitorWorkspaceIntegration of Azure Managed Grafana. +To construct, see NOTES section for MONITORWORKSPACEINTEGRATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IAzureMonitorWorkspaceIntegration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The workspace name of Azure Managed Grafana. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GrafanaName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Indicate the state for enable or disable traffic over the public interface. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The Sku of the grafana resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags for grafana resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundancy +The zone redundancy setting of the Grafana instance. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Support.ZoneRedundancy +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IManagedGrafana + +## 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. + + +`MONITORWORKSPACEINTEGRATION <IAzureMonitorWorkspaceIntegration[]>`: The MonitorWorkspaceIntegration of Azure Managed Grafana. + - `[AzureMonitorWorkspaceResourceId <String>]`: The resource Id of the connected Azure Monitor Workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Dashboard/New-AzGrafanaMonitorWorkspaceIntegrationObject.md b/azps-10.1.0/Az.Dashboard/New-AzGrafanaMonitorWorkspaceIntegrationObject.md new file mode 100644 index 0000000000..57a891e122 --- /dev/null +++ b/azps-10.1.0/Az.Dashboard/New-AzGrafanaMonitorWorkspaceIntegrationObject.md @@ -0,0 +1,71 @@ +--- +external help file: +Module Name: Az.Dashboard +online version: https://learn.microsoft.com/powershell/module/az.dashboard/new-azgrafanamonitorworkspaceintegrationobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dashboard/help/New-AzGrafanaMonitorWorkspaceIntegrationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dashboard/help/New-AzGrafanaMonitorWorkspaceIntegrationObject.md +--- + +# New-AzGrafanaMonitorWorkspaceIntegrationObject + +## SYNOPSIS +Create an in-memory object for AzureMonitorWorkspaceIntegration. + +## SYNTAX + +``` +New-AzGrafanaMonitorWorkspaceIntegrationObject [-AzureMonitorWorkspaceResourceId <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureMonitorWorkspaceIntegration. + +## EXAMPLES + +### Example 1: Create an AzureMonitorWorkspaceIntegration for Grafana. +```powershell +New-AzGrafanaMonitorWorkspaceIntegrationObject -AzureMonitorWorkspaceResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace" +``` + +```output +AzureMonitorWorkspaceResourceId +------------------------------- +/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace +``` + +Create an AzureMonitorWorkspaceIntegration for Grafana. + +## PARAMETERS + +### -AzureMonitorWorkspaceResourceId +The resource Id of the connected Azure Monitor Workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.AzureMonitorWorkspaceIntegration + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Dashboard/Remove-AzGrafana.md b/azps-10.1.0/Az.Dashboard/Remove-AzGrafana.md new file mode 100644 index 0000000000..7e4950756f --- /dev/null +++ b/azps-10.1.0/Az.Dashboard/Remove-AzGrafana.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.Dashboard +online version: https://learn.microsoft.com/powershell/module/az.dashboard/remove-azgrafana +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dashboard/help/Remove-AzGrafana.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dashboard/help/Remove-AzGrafana.md +--- + +# Remove-AzGrafana + +## SYNOPSIS +Delete a workspace for Grafana resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzGrafana -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzGrafana -InputObject <IDashboardIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a workspace for Grafana resource. + +## EXAMPLES + +### Example 1: Delete a workspace for Grafana resource. +```powershell +Remove-AzGrafana -GrafanaName azpstest-grafana -ResourceGroupName azpstest-gp +``` + +Delete a workspace for Grafana resource. + +### Example 2: Delete a workspace for Grafana resource. +```powershell +Get-AzGrafana -ResourceGroupName azpstest-gp -GrafanaName azpstest-grafana | Remove-AzGrafana +``` + +Delete a workspace for Grafana resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.IDashboardIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The workspace name of Azure Managed Grafana. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: GrafanaName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.IDashboardIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDashboardIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[PrivateEndpointConnectionName <String>]`: The private endpoint connection name of Azure Managed Grafana. + - `[PrivateLinkResourceName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The workspace name of Azure Managed Grafana. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Dashboard/Update-AzGrafana.md b/azps-10.1.0/Az.Dashboard/Update-AzGrafana.md new file mode 100644 index 0000000000..cced3811db --- /dev/null +++ b/azps-10.1.0/Az.Dashboard/Update-AzGrafana.md @@ -0,0 +1,333 @@ +--- +external help file: +Module Name: Az.Dashboard +online version: https://learn.microsoft.com/powershell/module/az.dashboard/update-azgrafana +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dashboard/help/Update-AzGrafana.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dashboard/help/Update-AzGrafana.md +--- + +# Update-AzGrafana + +## SYNOPSIS +Update a workspace for Grafana resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzGrafana -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-ApiKey <ApiKey>] + [-DeterministicOutboundIP <DeterministicOutboundIP>] [-IdentityType <ManagedServiceIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] + [-MonitorWorkspaceIntegration <IAzureMonitorWorkspaceIntegration[]>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-Tag <Hashtable>] [-ZoneRedundancy <ZoneRedundancy>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzGrafana -InputObject <IDashboardIdentity> [-ApiKey <ApiKey>] + [-DeterministicOutboundIP <DeterministicOutboundIP>] [-IdentityType <ManagedServiceIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] + [-MonitorWorkspaceIntegration <IAzureMonitorWorkspaceIntegration[]>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-Tag <Hashtable>] [-ZoneRedundancy <ZoneRedundancy>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a workspace for Grafana resource. + +## EXAMPLES + +### Example 1: Update a workspace for Grafana resource. +```powershell +Update-AzGrafana -GrafanaName azpstest-grafana -ResourceGroupName azpstest-gp -ApiKey Enabled -DeterministicOutboundIP 'Enabled' -IdentityType 'SystemAssigned' -PublicNetworkAccess 'Enabled' -ZoneRedundancy 'Enabled' -Tag @{"Environment"="Dev"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstest-grafana azpstest-gp +``` + +Update a workspace for Grafana resource. + +### Example 2: Update a workspace for Grafana resource. +```powershell +Get-AzGrafana -ResourceGroupName azpstest-gp -GrafanaName azpstest-grafana | Update-AzGrafana -ApiKey Enabled -DeterministicOutboundIP 'Enabled' -IdentityType 'SystemAssigned' -PublicNetworkAccess 'Enabled' -ZoneRedundancy 'Enabled' -Tag @{"Environment"="Dev"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstest-grafana azpstest-gp +``` + +Update a workspace for Grafana resource. + +## PARAMETERS + +### -ApiKey +The api key setting of the Grafana instance. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Support.ApiKey +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeterministicOutboundIP +Whether a Grafana instance uses deterministic outbound IPs. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Support.DeterministicOutboundIP +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.IDashboardIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorWorkspaceIntegration +The MonitorWorkspaceIntegration of Azure Managed Grafana. +To construct, see NOTES section for MONITORWORKSPACEINTEGRATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IAzureMonitorWorkspaceIntegration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The workspace name of Azure Managed Grafana. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: GrafanaName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Indicate the state for enable or disable traffic over the public interface. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The new tags of the grafana resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundancy +The zone redundancy setting of the Grafana instance. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Support.ZoneRedundancy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.IDashboardIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IManagedGrafana + +## 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 <IDashboardIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[PrivateEndpointConnectionName <String>]`: The private endpoint connection name of Azure Managed Grafana. + - `[PrivateLinkResourceName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The workspace name of Azure Managed Grafana. + +`MONITORWORKSPACEINTEGRATION <IAzureMonitorWorkspaceIntegration[]>`: The MonitorWorkspaceIntegration of Azure Managed Grafana. + - `[AzureMonitorWorkspaceResourceId <String>]`: The resource Id of the connected Azure Monitor Workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/Az.DataBox.md b/azps-10.1.0/Az.DataBox/Az.DataBox.md new file mode 100644 index 0000000000..078ef35dec --- /dev/null +++ b/azps-10.1.0/Az.DataBox/Az.DataBox.md @@ -0,0 +1,64 @@ +--- +Module Name: Az.DataBox +Module Guid: 9602a6b3-8b77-4f08-a6ed-edefff13e149 +Download Help Link: https://learn.microsoft.com/powershell/module/az.databox +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/Az.DataBox.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/Az.DataBox.md +--- + +# Az.DataBox Module +## Description +Microsoft Azure PowerShell: DataBox cmdlets + +## Az.DataBox Cmdlets +### [Get-AzDataBoxJob](Get-AzDataBoxJob.md) +Gets information about the specified job. + +### [Get-AzDataBoxJobCredential](Get-AzDataBoxJobCredential.md) +This method gets the unencrypted secrets related to the job. + +### [New-AzDataBoxContactDetailsObject](New-AzDataBoxContactDetailsObject.md) +Create an in-memory object for ContactDetails. + +### [New-AzDataBoxCustomerDiskJobDetailsObject](New-AzDataBoxCustomerDiskJobDetailsObject.md) +Create an in-memory object for DataBoxCustomerDiskJobDetails. + +### [New-AzDataBoxDiskJobDetailsObject](New-AzDataBoxDiskJobDetailsObject.md) +Create an in-memory object for DataBoxDiskJobDetails. + +### [New-AzDataBoxHeavyJobDetailsObject](New-AzDataBoxHeavyJobDetailsObject.md) +Create an in-memory object for DataBoxHeavyJobDetails. + +### [New-AzDataBoxJob](New-AzDataBoxJob.md) +Creates a new job with the specified parameters. +Existing job cannot be updated with this API and should instead be updated with the Update job API. + +### [New-AzDataBoxJobDetailsObject](New-AzDataBoxJobDetailsObject.md) +Create an in-memory object for DataBoxJobDetails. + +### [New-AzDataBoxKeyEncryptionKeyObject](New-AzDataBoxKeyEncryptionKeyObject.md) +Create an in-memory object for KeyEncryptionKey. + +### [New-AzDataBoxManagedDiskDetailsObject](New-AzDataBoxManagedDiskDetailsObject.md) +Create an in-memory object for ManagedDiskDetails. + +### [New-AzDataBoxShippingAddressObject](New-AzDataBoxShippingAddressObject.md) +Create an in-memory object for ShippingAddress. + +### [New-AzDataBoxStorageAccountDetailsObject](New-AzDataBoxStorageAccountDetailsObject.md) +Create an in-memory object for StorageAccountDetails. + +### [New-AzDataBoxTransferConfigurationObject](New-AzDataBoxTransferConfigurationObject.md) +Create an in-memory object for TransferConfiguration. + +### [Remove-AzDataBoxJob](Remove-AzDataBoxJob.md) +Deletes a job. + +### [Stop-AzDataBoxJob](Stop-AzDataBoxJob.md) +CancelJob. + +### [Update-AzDataBoxJob](Update-AzDataBoxJob.md) +Updates the properties of an existing job. + diff --git a/azps-10.1.0/Az.DataBox/Get-AzDataBoxJob.md b/azps-10.1.0/Az.DataBox/Get-AzDataBoxJob.md new file mode 100644 index 0000000000..ed29c3147f --- /dev/null +++ b/azps-10.1.0/Az.DataBox/Get-AzDataBoxJob.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/az.databox/get-azdataboxjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/Get-AzDataBoxJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/Get-AzDataBoxJob.md +--- + +# Get-AzDataBoxJob + +## SYNOPSIS +Gets information about the specified job. + +## SYNTAX + +### List (Default) +``` +Get-AzDataBoxJob [-SubscriptionId <String[]>] [-SkipToken <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzDataBoxJob -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Expand <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzDataBoxJob -ResourceGroupName <String> [-SubscriptionId <String[]>] [-SkipToken <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified job. + +## EXAMPLES + +### Example 1: Gets a particular job +```powershell +Get-AzDataBoxJob -Name "Powershell10" -ResourceGroupName "resourceGroupName" -SubscriptionId "SubscriptionId" +``` + +```output +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +Powershell10 WestUS DeviceOrdered ImportToAzure DataBox None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxJobDetails +``` + +Gets a particular job + +### Example 2: List all job under a subscription +```powershell +Get-AzDataBoxJob -SubscriptionId "SubscriptionId" +``` + +```output +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +brtestdbd brazilsouth DeviceOrdered ImportToAzure DataBoxDisk None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxDiskJobDetails +testorder uksouth Cancelled ImportToAzure DataBoxDisk None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxDiskJobDetails +``` + +List all job under a subscription + +### Example 3: List all job under a resourcegroup +```powershell +Get-AzDataBoxJob -ResourceGroupName "resourceGroupName" +``` + +```output +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +abcbnkndnkndn westus DeviceOrdered ImportToAzure DataBox None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxJobDetails +abcbnkndnkndn-Clone westus DeviceOrdered ImportToAzure DataBox None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxJobDetails +abcOrder westus Cancelled ImportToAzure DataBox None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxJobDetails +``` + +List all job under a resource group + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +$expand is supported on details parameter for job, which provides details on the job stages. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the job Resource within the specified resource group. +job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs. + +```yaml +Type: System.String +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription Id + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IJobResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/Get-AzDataBoxJobCredential.md b/azps-10.1.0/Az.DataBox/Get-AzDataBoxJobCredential.md new file mode 100644 index 0000000000..63abe6fc30 --- /dev/null +++ b/azps-10.1.0/Az.DataBox/Get-AzDataBoxJobCredential.md @@ -0,0 +1,174 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/az.databox/get-azdataboxjobcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/Get-AzDataBoxJobCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/Get-AzDataBoxJobCredential.md +--- + +# Get-AzDataBoxJobCredential + +## SYNOPSIS +This method gets the unencrypted secrets related to the job. + +## SYNTAX + +``` +Get-AzDataBoxJobCredential -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +This method gets the unencrypted secrets related to the job. + +## EXAMPLES + +### Example 1: Get databoxHeavy job credential +```powershell +Get-AzDataBoxJobCredential -Name "DtbxPowershell" -ResourceGroupName "resourceGroupName" + +$obj = Get-AzDataBoxJobCredential -Name TJy-637522091284252285 -ResourceGroupName bvttoolrg12-Wednesday +$obj | Format-List +$obj.JobSecret | Format-List +$cabinetJobSecret = $obj.JobSecret.CabinetPodSecret | Format-List +``` + +```output +AdditionalInfo : +Code : +DcAccessSecurityCodeForwardDcAccessCode : +DcAccessSecurityCodeReverseDcAccessCode : +Detail : +JobName : DtbxPowershell +JobSecret : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxHeavyJobSecrets +JobSecretJobSecretsType : DataBoxHeavy +Message : +Target : + + +AdditionalInfo : +CabinetPodSecret : {, } +Code : +DcAccessSecurityCode : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DcAccessSecurityCode +DcAccessSecurityCodeForwardDcAccessCode : +DcAccessSecurityCodeReverseDcAccessCode : +Detail : +Error : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.CloudError +Message : +Target : +Type : DataBoxHeavy +``` + +Get databoxHeavy job credential + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the job Resource within the specified resource group. +job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription Id + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IUnencryptedCredentials + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/New-AzDataBoxContactDetailsObject.md b/azps-10.1.0/Az.DataBox/New-AzDataBoxContactDetailsObject.md new file mode 100644 index 0000000000..f7d41f98db --- /dev/null +++ b/azps-10.1.0/Az.DataBox/New-AzDataBoxContactDetailsObject.md @@ -0,0 +1,157 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/Az.DataBox/new-AzDataBoxContactDetailsObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxContactDetailsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxContactDetailsObject.md +--- + +# New-AzDataBoxContactDetailsObject + +## SYNOPSIS +Create an in-memory object for ContactDetails. + +## SYNTAX + +``` +New-AzDataBoxContactDetailsObject -ContactName <String> -EmailList <String[]> -Phone <String> + [-Mobile <String>] [-NotificationPreference <INotificationPreference[]>] [-PhoneExtension <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ContactDetails. + +## EXAMPLES + +### Example 1: Create a in-memory object for ContactDetails +```powershell +New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891" +``` + +```output +ContactName EmailList Mobile Phone PhoneExtension +----------- --------- ------ ----- -------------- +random {emailId} 1234567891 +``` + +Create a in-memory object for ContactDetails + +## PARAMETERS + +### -ContactName +Contact name of the person. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailList +List of Email-ids to be notified about job progress. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mobile +Mobile number of the contact person. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationPreference +Notification preference for a job stage. +To construct, see NOTES section for NOTIFICATIONPREFERENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.INotificationPreference[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Phone +Phone number of the contact person. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneExtension +Phone extension number of the contact person. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.ContactDetails + +## 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. + + +`NOTIFICATIONPREFERENCE <INotificationPreference[]>`: Notification preference for a job stage. + - `SendNotification <Boolean>`: Notification is required or not. + - `StageName <NotificationStageName>`: Name of the stage. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/New-AzDataBoxCustomerDiskJobDetailsObject.md b/azps-10.1.0/Az.DataBox/New-AzDataBoxCustomerDiskJobDetailsObject.md new file mode 100644 index 0000000000..1b716f6853 --- /dev/null +++ b/azps-10.1.0/Az.DataBox/New-AzDataBoxCustomerDiskJobDetailsObject.md @@ -0,0 +1,347 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/Az.DataBox/new-AzDataBoxCustomerDiskJobDetailsObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxCustomerDiskJobDetailsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxCustomerDiskJobDetailsObject.md +--- + +# New-AzDataBoxCustomerDiskJobDetailsObject + +## SYNOPSIS +Create an in-memory object for DataBoxCustomerDiskJobDetails. + +## SYNTAX + +``` +New-AzDataBoxCustomerDiskJobDetailsObject -ContactDetail <IContactDetails> -Type <ClassDiscriminator> + [-DataExportDetail <IDataExportDetails[]>] [-DataImportDetail <IDataImportDetails[]>] + [-ExpectedDataSizeInTeraByte <Int32>] + [-ExportDiskDetailsCollection <IDataBoxCustomerDiskJobDetailsExportDiskDetailsCollection>] + [-ImportDiskDetailsCollection <IDataBoxCustomerDiskJobDetailsImportDiskDetailsCollection>] + [-KeyEncryptionKey <IKeyEncryptionKey>] [-Preference <IPreferences>] + [-ReturnToCustomerPackageDetailCarrierAccountNumber <String>] + [-ReverseShippingDetail <IReverseShippingDetails>] [-ShippingAddress <IShippingAddress>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for DataBoxCustomerDiskJobDetails. + +## EXAMPLES + +### Example 1: DataBoxCustomerDisk details in-memory object +```powershell +$dataAccount = New-AzDataBoxStorageAccountDetailsObject -DataAccountType "StorageAccount" -StorageAccountId "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroup/providers/Microsoft.Storage/storageAccounts/YourStorageAccount" +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "XXXX XXXX" -EmailList @("emailId") -Phone "0000000000" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "XXXX XXXX" -StateOrProvince "XX" -Country "XX" -City "XXXX XXXX" -PostalCode "00000" -AddressType "Commercial" +$importDiskDetailsCollection = @{"XXXXXX"= @{ManifestFile = "xyz.txt"; ManifestHash = "xxxx"; BitLockerKey = "xxx"}} + +New-AzDataBoxCustomerDiskJobDetailsObject -Type "DataBoxCustomerDisk" -DataImportDetail @(@{AccountDetail=$dataAccount; AccountDetailDataAccountType = "StorageAccount"} ) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -ImportDiskDetailsCollection $importDiskDetailsCollection -ReturnToCustomerPackageDetailCarrierAccountNumber "00000" +``` + +DataBoxCustomerDisk details in-memory object + +## PARAMETERS + +### -ContactDetail +Contact details for notification and shipping. +To construct, see NOTES section for CONTACTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IContactDetails +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataExportDetail +Details of the data to be exported from azure. +To construct, see NOTES section for DATAEXPORTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IDataExportDetails[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataImportDetail +Details of the data to be imported into azure. +To construct, see NOTES section for DATAIMPORTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IDataImportDetails[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpectedDataSizeInTeraByte +The expected size of the data, which needs to be transferred in this job, in terabytes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportDiskDetailsCollection +Contains the map of disk serial number to the disk details for export jobs. +To construct, see NOTES section for EXPORTDISKDETAILSCOLLECTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IDataBoxCustomerDiskJobDetailsExportDiskDetailsCollection +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImportDiskDetailsCollection +Contains the map of disk serial number to the disk details for import jobs. +To construct, see NOTES section for IMPORTDISKDETAILSCOLLECTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IDataBoxCustomerDiskJobDetailsImportDiskDetailsCollection +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKey +Details about which key encryption type is being used. +To construct, see NOTES section for KEYENCRYPTIONKEY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IKeyEncryptionKey +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Preference +Preferences for the order. +To construct, see NOTES section for PREFERENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IPreferences +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnToCustomerPackageDetailCarrierAccountNumber +Carrier Account Number of customer for customer disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReverseShippingDetail +Optional Reverse Shipping details for order. +To construct, see NOTES section for REVERSESHIPPINGDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IReverseShippingDetails +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingAddress +Shipping address of the customer. +To construct, see NOTES section for SHIPPINGADDRESS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IShippingAddress +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Indicates the type of job details. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.ClassDiscriminator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.DataBoxCustomerDiskJobDetails + +## 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. + + +`CONTACTDETAIL <IContactDetails>`: Contact details for notification and shipping. + - `ContactName <String>`: Contact name of the person. + - `EmailList <String[]>`: List of Email-ids to be notified about job progress. + - `Phone <String>`: Phone number of the contact person. + - `[Mobile <String>]`: Mobile number of the contact person. + - `[NotificationPreference <INotificationPreference[]>]`: Notification preference for a job stage. + - `SendNotification <Boolean>`: Notification is required or not. + - `StageName <NotificationStageName>`: Name of the stage. + - `[PhoneExtension <String>]`: Phone extension number of the contact person. + +`DATAEXPORTDETAIL <IDataExportDetails[]>`: Details of the data to be exported from azure. + - `AccountDetailDataAccountType <DataAccountType>`: Account Type of the data to be transferred. + - `TransferConfiguration <ITransferConfiguration>`: Configuration for the data transfer. + - `Type <TransferConfigurationType>`: Type of the configuration for transfer. + - `[TransferAllDetail <ITransferConfigurationTransferAllDetails>]`: Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll + - `[IncludeDataAccountType <DataAccountType?>]`: Type of the account of data + - `[IncludeTransferAllBlob <Boolean?>]`: To indicate if all Azure blobs have to be transferred + - `[IncludeTransferAllFile <Boolean?>]`: To indicate if all Azure Files have to be transferred + - `[TransferFilterDetail <ITransferConfigurationTransferFilterDetails>]`: Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. + - `[AzureFileFilterDetailFilePathList <String[]>]`: List of full path of the files to be transferred. + - `[AzureFileFilterDetailFilePrefixList <String[]>]`: Prefix list of the Azure files to be transferred. + - `[AzureFileFilterDetailFileShareList <String[]>]`: List of file shares to be transferred. + - `[BlobFilterDetailBlobPathList <String[]>]`: List of full path of the blobs to be transferred. + - `[BlobFilterDetailBlobPrefixList <String[]>]`: Prefix list of the Azure blobs to be transferred. + - `[BlobFilterDetailContainerList <String[]>]`: List of blob containers to be transferred. + - `[IncludeDataAccountType <DataAccountType?>]`: Type of the account of data. + - `[IncludeFilterFileDetail <IFilterFileDetails[]>]`: Details of the filter files to be used for data transfer. + - `FilterFilePath <String>`: Path of the file that contains the details of all items to transfer. + - `FilterFileType <FilterFileType>`: Type of the filter file. + - `[AccountDetailSharePassword <String>]`: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ + - `[LogCollectionLevel <LogCollectionLevel?>]`: Level of the logs to be collected. + +`DATAIMPORTDETAIL <IDataImportDetails[]>`: Details of the data to be imported into azure. + - `AccountDetailDataAccountType <DataAccountType>`: Account Type of the data to be transferred. + - `[AccountDetailSharePassword <String>]`: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ + - `[LogCollectionLevel <LogCollectionLevel?>]`: Level of the logs to be collected. + +`EXPORTDISKDETAILSCOLLECTION <IDataBoxCustomerDiskJobDetailsExportDiskDetailsCollection>`: Contains the map of disk serial number to the disk details for export jobs. + - `[(Any) <IExportDiskDetails>]`: This indicates any property can be added to this object. + +`IMPORTDISKDETAILSCOLLECTION <IDataBoxCustomerDiskJobDetailsImportDiskDetailsCollection>`: Contains the map of disk serial number to the disk details for import jobs. + - `[(Any) <IImportDiskDetails>]`: This indicates any property can be added to this object. + +`KEYENCRYPTIONKEY <IKeyEncryptionKey>`: Details about which key encryption type is being used. + - `KekType <KekType>`: Type of encryption key used for key encryption. + - `[IdentityProperty <IIdentityProperties>]`: Managed identity properties used for key encryption. + - `[Type <String>]`: Managed service identity type. + - `[UserAssignedResourceId <String>]`: Arm resource id for user assigned identity to be used to fetch MSI token. + - `[KekUrl <String>]`: Key encryption key. It is required in case of Customer managed KekType. + - `[KekVaultResourceId <String>]`: Kek vault resource id. It is required in case of Customer managed KekType. + +`PREFERENCE <IPreferences>`: Preferences for the order. + - `[EncryptionPreferenceDoubleEncryption <DoubleEncryption?>]`: Defines secondary layer of software-based encryption enablement. + - `[EncryptionPreferenceHardwareEncryption <HardwareEncryption?>]`: Defines Hardware level encryption (Only for disk) + - `[PreferredDataCenterRegion <String[]>]`: Preferred data center region. + - `[ReverseTransportPreferencePreferredShipmentType <TransportShipmentTypes?>]`: Indicates Shipment Logistics type that the customer preferred. + - `[StorageAccountAccessTierPreference <StorageAccountAccessTier[]>]`: Preferences related to the Access Tier of storage accounts. + - `[TransportPreferencePreferredShipmentType <TransportShipmentTypes?>]`: Indicates Shipment Logistics type that the customer preferred. + +`REVERSESHIPPINGDETAIL <IReverseShippingDetails>`: Optional Reverse Shipping details for order. + - `[ContactDetailContactName <String>]`: Contact name of the person. + - `[ContactDetailMobile <String>]`: Mobile number of the contact person. + - `[ContactDetailPhone <String>]`: Phone number of the contact person. + - `[ContactDetailPhoneExtension <String>]`: Phone extension number of the contact person. + - `[ShippingAddress <IShippingAddress>]`: Shipping address where customer wishes to receive the device. + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[SkipAddressValidation <Boolean?>]`: Flag to indicate if customer has chosen to skip default address validation + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[TaxIdentificationNumber <String>]`: Tax Identification Number + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +`SHIPPINGADDRESS <IShippingAddress>`: Shipping address of the customer. + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[SkipAddressValidation <Boolean?>]`: Flag to indicate if customer has chosen to skip default address validation + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[TaxIdentificationNumber <String>]`: Tax Identification Number + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/New-AzDataBoxDiskJobDetailsObject.md b/azps-10.1.0/Az.DataBox/New-AzDataBoxDiskJobDetailsObject.md new file mode 100644 index 0000000000..892afa9460 --- /dev/null +++ b/azps-10.1.0/Az.DataBox/New-AzDataBoxDiskJobDetailsObject.md @@ -0,0 +1,333 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/Az.DataBox/new-AzDataBoxDiskJobDetailsObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxDiskJobDetailsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxDiskJobDetailsObject.md +--- + +# New-AzDataBoxDiskJobDetailsObject + +## SYNOPSIS +Create an in-memory object for DataBoxDiskJobDetails. + +## SYNTAX + +``` +New-AzDataBoxDiskJobDetailsObject -ContactDetail <IContactDetails> -Type <ClassDiscriminator> + [-DataExportDetail <IDataExportDetails[]>] [-DataImportDetail <IDataImportDetails[]>] + [-ExpectedDataSizeInTeraByte <Int32>] [-KeyEncryptionKey <IKeyEncryptionKey>] [-Passkey <String>] + [-Preference <IPreferences>] [-PreferredDisk <IDataBoxDiskJobDetailsPreferredDisks>] + [-ReverseShippingDetail <IReverseShippingDetails>] [-ShippingAddress <IShippingAddress>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for DataBoxDiskJobDetails. + +## EXAMPLES + +### Example 1: DataBoxDisk details in-memory object +```powershell +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" + +New-AzDataBoxDiskJobDetailsObject -Type "DataBoxDisk" -DataImportDetail @(@{AccountDetail=$dataAccount; AccountDetailDataAccountType = "StorageAccount"} ) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -Passkey "randm@423jarABC" -PreferredDisk @{"8" = 8; "4" = 2} -ExpectedDataSizeInTeraByte 18 +``` + +```output +Action ChainOfCustodySasKey ExpectedDataSizeInTeraByte ReverseShipmentLabelSasKey Type Passkey +------ -------------------- -------------------------- -------------------------- ---- ------- + 18 DataBoxDisk randm@423jarABC +``` + +DataBoxDisk details in-memory object + +## PARAMETERS + +### -ContactDetail +Contact details for notification and shipping. +To construct, see NOTES section for CONTACTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IContactDetails +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataExportDetail +Details of the data to be exported from azure. +To construct, see NOTES section for DATAEXPORTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IDataExportDetails[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataImportDetail +Details of the data to be imported into azure. +To construct, see NOTES section for DATAIMPORTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IDataImportDetails[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpectedDataSizeInTeraByte +The expected size of the data, which needs to be transferred in this job, in terabytes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKey +Details about which key encryption type is being used. +To construct, see NOTES section for KEYENCRYPTIONKEY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IKeyEncryptionKey +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Passkey +User entered passkey for DataBox Disk job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Preference +Preferences for the order. +To construct, see NOTES section for PREFERENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IPreferences +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredDisk +User preference on what size disks are needed for the job. +The map is from the disk size in TB to the count. +Eg. +{2,5} means 5 disks of 2 TB size. +Key is string but will be checked against an int. +To construct, see NOTES section for PREFERREDDISK properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IDataBoxDiskJobDetailsPreferredDisks +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReverseShippingDetail +Optional Reverse Shipping details for order. +To construct, see NOTES section for REVERSESHIPPINGDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IReverseShippingDetails +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingAddress +Shipping address of the customer. +To construct, see NOTES section for SHIPPINGADDRESS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IShippingAddress +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Indicates the type of job details. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.ClassDiscriminator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.DataBoxDiskJobDetails + +## 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. + + +`CONTACTDETAIL <IContactDetails>`: Contact details for notification and shipping. + - `ContactName <String>`: Contact name of the person. + - `EmailList <String[]>`: List of Email-ids to be notified about job progress. + - `Phone <String>`: Phone number of the contact person. + - `[Mobile <String>]`: Mobile number of the contact person. + - `[NotificationPreference <INotificationPreference[]>]`: Notification preference for a job stage. + - `SendNotification <Boolean>`: Notification is required or not. + - `StageName <NotificationStageName>`: Name of the stage. + - `[PhoneExtension <String>]`: Phone extension number of the contact person. + +`DATAEXPORTDETAIL <IDataExportDetails[]>`: Details of the data to be exported from azure. + - `AccountDetailDataAccountType <DataAccountType>`: Account Type of the data to be transferred. + - `TransferConfiguration <ITransferConfiguration>`: Configuration for the data transfer. + - `Type <TransferConfigurationType>`: Type of the configuration for transfer. + - `[TransferAllDetail <ITransferConfigurationTransferAllDetails>]`: Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll + - `[IncludeDataAccountType <DataAccountType?>]`: Type of the account of data + - `[IncludeTransferAllBlob <Boolean?>]`: To indicate if all Azure blobs have to be transferred + - `[IncludeTransferAllFile <Boolean?>]`: To indicate if all Azure Files have to be transferred + - `[TransferFilterDetail <ITransferConfigurationTransferFilterDetails>]`: Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. + - `[AzureFileFilterDetailFilePathList <String[]>]`: List of full path of the files to be transferred. + - `[AzureFileFilterDetailFilePrefixList <String[]>]`: Prefix list of the Azure files to be transferred. + - `[AzureFileFilterDetailFileShareList <String[]>]`: List of file shares to be transferred. + - `[BlobFilterDetailBlobPathList <String[]>]`: List of full path of the blobs to be transferred. + - `[BlobFilterDetailBlobPrefixList <String[]>]`: Prefix list of the Azure blobs to be transferred. + - `[BlobFilterDetailContainerList <String[]>]`: List of blob containers to be transferred. + - `[IncludeDataAccountType <DataAccountType?>]`: Type of the account of data. + - `[IncludeFilterFileDetail <IFilterFileDetails[]>]`: Details of the filter files to be used for data transfer. + - `FilterFilePath <String>`: Path of the file that contains the details of all items to transfer. + - `FilterFileType <FilterFileType>`: Type of the filter file. + - `[AccountDetailSharePassword <String>]`: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ + - `[LogCollectionLevel <LogCollectionLevel?>]`: Level of the logs to be collected. + +`DATAIMPORTDETAIL <IDataImportDetails[]>`: Details of the data to be imported into azure. + - `AccountDetailDataAccountType <DataAccountType>`: Account Type of the data to be transferred. + - `[AccountDetailSharePassword <String>]`: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ + - `[LogCollectionLevel <LogCollectionLevel?>]`: Level of the logs to be collected. + +`KEYENCRYPTIONKEY <IKeyEncryptionKey>`: Details about which key encryption type is being used. + - `KekType <KekType>`: Type of encryption key used for key encryption. + - `[IdentityProperty <IIdentityProperties>]`: Managed identity properties used for key encryption. + - `[Type <String>]`: Managed service identity type. + - `[UserAssignedResourceId <String>]`: Arm resource id for user assigned identity to be used to fetch MSI token. + - `[KekUrl <String>]`: Key encryption key. It is required in case of Customer managed KekType. + - `[KekVaultResourceId <String>]`: Kek vault resource id. It is required in case of Customer managed KekType. + +`PREFERENCE <IPreferences>`: Preferences for the order. + - `[EncryptionPreferenceDoubleEncryption <DoubleEncryption?>]`: Defines secondary layer of software-based encryption enablement. + - `[EncryptionPreferenceHardwareEncryption <HardwareEncryption?>]`: Defines Hardware level encryption (Only for disk) + - `[PreferredDataCenterRegion <String[]>]`: Preferred data center region. + - `[ReverseTransportPreferencePreferredShipmentType <TransportShipmentTypes?>]`: Indicates Shipment Logistics type that the customer preferred. + - `[StorageAccountAccessTierPreference <StorageAccountAccessTier[]>]`: Preferences related to the Access Tier of storage accounts. + - `[TransportPreferencePreferredShipmentType <TransportShipmentTypes?>]`: Indicates Shipment Logistics type that the customer preferred. + +`PREFERREDDISK <IDataBoxDiskJobDetailsPreferredDisks>`: User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. + - `[(Any) <Int32>]`: This indicates any property can be added to this object. + +`REVERSESHIPPINGDETAIL <IReverseShippingDetails>`: Optional Reverse Shipping details for order. + - `[ContactDetailContactName <String>]`: Contact name of the person. + - `[ContactDetailMobile <String>]`: Mobile number of the contact person. + - `[ContactDetailPhone <String>]`: Phone number of the contact person. + - `[ContactDetailPhoneExtension <String>]`: Phone extension number of the contact person. + - `[ShippingAddress <IShippingAddress>]`: Shipping address where customer wishes to receive the device. + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[SkipAddressValidation <Boolean?>]`: Flag to indicate if customer has chosen to skip default address validation + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[TaxIdentificationNumber <String>]`: Tax Identification Number + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +`SHIPPINGADDRESS <IShippingAddress>`: Shipping address of the customer. + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[SkipAddressValidation <Boolean?>]`: Flag to indicate if customer has chosen to skip default address validation + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[TaxIdentificationNumber <String>]`: Tax Identification Number + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/New-AzDataBoxHeavyJobDetailsObject.md b/azps-10.1.0/Az.DataBox/New-AzDataBoxHeavyJobDetailsObject.md new file mode 100644 index 0000000000..d491cdfab3 --- /dev/null +++ b/azps-10.1.0/Az.DataBox/New-AzDataBoxHeavyJobDetailsObject.md @@ -0,0 +1,316 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/Az.DataBox/new-AzDataBoxHeavyJobDetailsObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxHeavyJobDetailsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxHeavyJobDetailsObject.md +--- + +# New-AzDataBoxHeavyJobDetailsObject + +## SYNOPSIS +Create an in-memory object for DataBoxHeavyJobDetails. + +## SYNTAX + +``` +New-AzDataBoxHeavyJobDetailsObject -ContactDetail <IContactDetails> -Type <ClassDiscriminator> + [-DataExportDetail <IDataExportDetails[]>] [-DataImportDetail <IDataImportDetails[]>] + [-DevicePassword <String>] [-ExpectedDataSizeInTeraByte <Int32>] [-KeyEncryptionKey <IKeyEncryptionKey>] + [-Preference <IPreferences>] [-ReverseShippingDetail <IReverseShippingDetails>] + [-ShippingAddress <IShippingAddress>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for DataBoxHeavyJobDetails. + +## EXAMPLES + +### Example 1: Create a in-memory object for DataBoxHeavyJobDetails +```powershell +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" + +New-AzDataBoxHeavyJobDetailsObject -Type "DataBoxHeavy" -DataImportDetail @(@{AccountDetail=$dataAccount; AccountDetailDataAccountType = "StorageAccount"} ) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -DevicePassword "randm@423jarABC" -ExpectedDataSizeInTeraByte 10 +``` + +```output +Action ChainOfCustodySasKey ExpectedDataSizeInTeraByte ReverseShipmentLabelSasKey Type Passkey +------ -------------------- -------------------------- -------------------------- ---- ------- + 18 DataBoxDisk randm@423jarABC +``` + +Create a in-memory object for DataBoxHeavyJobDetails + +## PARAMETERS + +### -ContactDetail +Contact details for notification and shipping. +To construct, see NOTES section for CONTACTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IContactDetails +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataExportDetail +Details of the data to be exported from azure. +To construct, see NOTES section for DATAEXPORTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IDataExportDetails[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataImportDetail +Details of the data to be imported into azure. +To construct, see NOTES section for DATAIMPORTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IDataImportDetails[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DevicePassword +Set Device password for unlocking Databox Heavy. +Should not be passed for TransferType:ExportFromAzure jobs. +If this is not passed, the service will generate password itself. +This will not be returned in Get Call. +Password Requirements : Password must be minimum of 12 and maximum of 64 characters. +Password must have at least one uppercase alphabet, one number and one special character. +Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpectedDataSizeInTeraByte +The expected size of the data, which needs to be transferred in this job, in terabytes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKey +Details about which key encryption type is being used. +To construct, see NOTES section for KEYENCRYPTIONKEY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IKeyEncryptionKey +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Preference +Preferences for the order. +To construct, see NOTES section for PREFERENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IPreferences +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReverseShippingDetail +Optional Reverse Shipping details for order. +To construct, see NOTES section for REVERSESHIPPINGDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IReverseShippingDetails +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingAddress +Shipping address of the customer. +To construct, see NOTES section for SHIPPINGADDRESS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IShippingAddress +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Indicates the type of job details. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.ClassDiscriminator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.DataBoxHeavyJobDetails + +## 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. + + +`CONTACTDETAIL <IContactDetails>`: Contact details for notification and shipping. + - `ContactName <String>`: Contact name of the person. + - `EmailList <String[]>`: List of Email-ids to be notified about job progress. + - `Phone <String>`: Phone number of the contact person. + - `[Mobile <String>]`: Mobile number of the contact person. + - `[NotificationPreference <INotificationPreference[]>]`: Notification preference for a job stage. + - `SendNotification <Boolean>`: Notification is required or not. + - `StageName <NotificationStageName>`: Name of the stage. + - `[PhoneExtension <String>]`: Phone extension number of the contact person. + +`DATAEXPORTDETAIL <IDataExportDetails[]>`: Details of the data to be exported from azure. + - `AccountDetailDataAccountType <DataAccountType>`: Account Type of the data to be transferred. + - `TransferConfiguration <ITransferConfiguration>`: Configuration for the data transfer. + - `Type <TransferConfigurationType>`: Type of the configuration for transfer. + - `[TransferAllDetail <ITransferConfigurationTransferAllDetails>]`: Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll + - `[IncludeDataAccountType <DataAccountType?>]`: Type of the account of data + - `[IncludeTransferAllBlob <Boolean?>]`: To indicate if all Azure blobs have to be transferred + - `[IncludeTransferAllFile <Boolean?>]`: To indicate if all Azure Files have to be transferred + - `[TransferFilterDetail <ITransferConfigurationTransferFilterDetails>]`: Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. + - `[AzureFileFilterDetailFilePathList <String[]>]`: List of full path of the files to be transferred. + - `[AzureFileFilterDetailFilePrefixList <String[]>]`: Prefix list of the Azure files to be transferred. + - `[AzureFileFilterDetailFileShareList <String[]>]`: List of file shares to be transferred. + - `[BlobFilterDetailBlobPathList <String[]>]`: List of full path of the blobs to be transferred. + - `[BlobFilterDetailBlobPrefixList <String[]>]`: Prefix list of the Azure blobs to be transferred. + - `[BlobFilterDetailContainerList <String[]>]`: List of blob containers to be transferred. + - `[IncludeDataAccountType <DataAccountType?>]`: Type of the account of data. + - `[IncludeFilterFileDetail <IFilterFileDetails[]>]`: Details of the filter files to be used for data transfer. + - `FilterFilePath <String>`: Path of the file that contains the details of all items to transfer. + - `FilterFileType <FilterFileType>`: Type of the filter file. + - `[AccountDetailSharePassword <String>]`: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ + - `[LogCollectionLevel <LogCollectionLevel?>]`: Level of the logs to be collected. + +`DATAIMPORTDETAIL <IDataImportDetails[]>`: Details of the data to be imported into azure. + - `AccountDetailDataAccountType <DataAccountType>`: Account Type of the data to be transferred. + - `[AccountDetailSharePassword <String>]`: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ + - `[LogCollectionLevel <LogCollectionLevel?>]`: Level of the logs to be collected. + +`KEYENCRYPTIONKEY <IKeyEncryptionKey>`: Details about which key encryption type is being used. + - `KekType <KekType>`: Type of encryption key used for key encryption. + - `[IdentityProperty <IIdentityProperties>]`: Managed identity properties used for key encryption. + - `[Type <String>]`: Managed service identity type. + - `[UserAssignedResourceId <String>]`: Arm resource id for user assigned identity to be used to fetch MSI token. + - `[KekUrl <String>]`: Key encryption key. It is required in case of Customer managed KekType. + - `[KekVaultResourceId <String>]`: Kek vault resource id. It is required in case of Customer managed KekType. + +`PREFERENCE <IPreferences>`: Preferences for the order. + - `[EncryptionPreferenceDoubleEncryption <DoubleEncryption?>]`: Defines secondary layer of software-based encryption enablement. + - `[EncryptionPreferenceHardwareEncryption <HardwareEncryption?>]`: Defines Hardware level encryption (Only for disk) + - `[PreferredDataCenterRegion <String[]>]`: Preferred data center region. + - `[ReverseTransportPreferencePreferredShipmentType <TransportShipmentTypes?>]`: Indicates Shipment Logistics type that the customer preferred. + - `[StorageAccountAccessTierPreference <StorageAccountAccessTier[]>]`: Preferences related to the Access Tier of storage accounts. + - `[TransportPreferencePreferredShipmentType <TransportShipmentTypes?>]`: Indicates Shipment Logistics type that the customer preferred. + +`REVERSESHIPPINGDETAIL <IReverseShippingDetails>`: Optional Reverse Shipping details for order. + - `[ContactDetailContactName <String>]`: Contact name of the person. + - `[ContactDetailMobile <String>]`: Mobile number of the contact person. + - `[ContactDetailPhone <String>]`: Phone number of the contact person. + - `[ContactDetailPhoneExtension <String>]`: Phone extension number of the contact person. + - `[ShippingAddress <IShippingAddress>]`: Shipping address where customer wishes to receive the device. + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[SkipAddressValidation <Boolean?>]`: Flag to indicate if customer has chosen to skip default address validation + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[TaxIdentificationNumber <String>]`: Tax Identification Number + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +`SHIPPINGADDRESS <IShippingAddress>`: Shipping address of the customer. + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[SkipAddressValidation <Boolean?>]`: Flag to indicate if customer has chosen to skip default address validation + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[TaxIdentificationNumber <String>]`: Tax Identification Number + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/New-AzDataBoxJob.md b/azps-10.1.0/Az.DataBox/New-AzDataBoxJob.md new file mode 100644 index 0000000000..2a7f3369ec --- /dev/null +++ b/azps-10.1.0/Az.DataBox/New-AzDataBoxJob.md @@ -0,0 +1,647 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/az.databox/new-azdataboxjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxJob.md +--- + +# New-AzDataBoxJob + +## SYNOPSIS +Creates a new job with the specified parameters. +Existing job cannot be updated with this API and should instead be updated with the Update job API. + +## SYNTAX + +``` +New-AzDataBoxJob -Name <String> -ResourceGroupName <String> -Location <String> -SkuName <SkuName> + -TransferType <TransferType> [-SubscriptionId <String>] [-DeliveryInfoScheduledDateTime <DateTime>] + [-DeliveryType <JobDeliveryType>] [-Detail <IJobDetails>] [-IdentityType <String>] [-SkuDisplayName <String>] + [-SkuFamily <String>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new job with the specified parameters. +Existing job cannot be updated with this API and should instead be updated with the Update job API. + +## EXAMPLES + +### Example 1: Create a databox import job +```powershell +$dataAccount = New-AzDataBoxStorageAccountDetailsObject -DataAccountType "StorageAccount" -StorageAccountId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +$details = New-AzDataBoxJobDetailsObject -Type "DataBox" -DataImportDetail @(@{AccountDetail=$dataAccount; AccountDetailDataAccountType = "StorageAccount"} ) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails +$DebugPreference = "Continue" +# You can use `$DebugPreference = "Continue"`, with any example/usecase to get exact details of error in below format when creation command fails. +# { +# "Error": { +# "Code": "StaticValidationGenericCountryCodeHasInvalidLength", +# "Message": "The attribute country code does not meet length constraints.\r\nEnter a value with 2 characters for country code.", +# "Details": [ +# null +# ], +# "Target": null +# } +# } +$resource = New-AzDataBoxJob -Name "ImportTest" -SubscriptionId "SubscriptionId" -ResourceGroupName "resourceGroupName" -TransferType "ImportToAzure" -Detail $details -Location "WestUS" -SkuName "DataBox" +$resource +$resource.Detail +$resource.Detail.ShippingAddress +``` + +```output +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +ImportTest WestUS DeviceOrdered ImportToAzure DataBox None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxJobDetails + + +Action : +ChainOfCustodySasKey : +ContactDetail : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.ContactDetails +CopyLogDetail : +CopyProgress : +DataExportDetail : +DataImportDetail : {Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataImportDetails} +DeliveryPackage : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.PackageShippingDetails +DevicePassword : +ExpectedDataSizeInTeraByte : 0 +JobStage : +KeyEncryptionKey : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.KeyEncryptionKey +LastMitigationActionOnJob : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.LastMitigationActionOnJob +Preference : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.Preferences +ReturnPackage : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.PackageShippingDetails +ReverseShipmentLabelSasKey : +ShippingAddress : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.ShippingAddress +Type : DataBox + + +AddressType City CompanyName Country PostalCode StateOrProvince StreetAddress1 StreetAddress2 StreetAddress3 ZipExtendedCode +----------- ---- ----------- ------- ---------- --------------- -------------- -------------- -------------- --------------- +Commercial San Francisco US 94107 CA 101 TOWNSEND ST +``` + +You can expand and visualize other object in similar way how details and shipping address expanded. + +### Example 2: Creates a databox export job +```powershell +$dataAccount = New-AzDataBoxStorageAccountDetailsObject -DataAccountType "StorageAccount" -StorageAccountId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +$transferConfigurationType = New-AzDataBoxTransferConfigurationObject -Type "TransferAll" -TransferAllDetail @{"IncludeDataAccountType"="StorageAccount";"IncludeTransferAllBlob"= "True"; "IncludeTransferAllFile"="True"} +$details = New-AzDataBoxJobDetailsObject -Type "DataBox" -DataExportDetail @(@{AccountDetail=$dataAccount; AccountDetailDataAccountType = "StorageAccount"; "TransferConfiguration"= $transferConfigurationType} ) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails +$resource = New-AzDataBoxJob -Name "ExportTest" -SubscriptionId "SubscriptionId" -ResourceGroupName "resourceGroupName" -TransferType "ExportFromAzure" -Detail $details -Location "WestUS" -SkuName "DataBox" +``` + +```output +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +ExportTest WestUS DeviceOrdered ExportFromAzure DataBox None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxJobDetails +``` + +Creates a databox export job. +For any failure re-run with $DebugPreference = "Continue" as mentioned in example 1 + +### Example 3: Creates a databox import job with managed disk account +```powershell +$managedDiskAccount=New-AzDataBoxManagedDiskDetailsObject -ResourceGroupId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName" -StagingStorageAccountId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/stagingAccountName" -DataAccountType "ManagedDisk" +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +$details = New-AzDataBoxJobDetailsObject -Type "DataBox" -DataImportDetail @(@{AccountDetail=$managedDiskAccount; AccountDetailDataAccountType = "ManagedDisk"} ) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails +New-AzDataBoxJob -Name "PwshManagedDisk" -SubscriptionId "SubscriptionId" -ResourceGroupName "resourceGroupName" -TransferType "ImportToAzure" -Detail $details -Location "WestUS" -SkuName "DataBox" +``` + +```output +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +PwshManagedDisk WestUS DeviceOrdered ImportToAzure DataBox None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxJobDetails +``` + +Creates a databox import job with managed disk account. +For any failure re-run with $DebugPreference = "Continue" as mentioned in example 1 + +### Example 4: Creates a databox import job with user assigned identity +```powershell +$dataAccount = New-AzDataBoxStorageAccountDetailsObject -DataAccountType "StorageAccount" -StorageAccountId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +$keyEncryptionDetails = New-AzDataBoxKeyEncryptionKeyObject -KekType "CustomerManaged" -IdentityProperty @{Type = "UserAssigned"; UserAssignedResourceId = "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName"} -KekUrl "keyIdentifier" -KekVaultResourceId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" +$details = New-AzDataBoxJobDetailsObject -Type "DataBox" -DataImportDetail @(@{AccountDetail=$dataAccount; AccountDetailDataAccountType = "StorageAccount"} ) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -KeyEncryptionKey $keyEncryptionDetails +New-AzDataBoxJob -Name "PowershellMSI" -SubscriptionId "SubscriptionId" -ResourceGroupName "resourceGroupName" -TransferType "ImportToAzure" -Detail $details -Location "WestUS" -SkuName "DataBox" -IdentityType "UserAssigned" -UserAssignedIdentity @{"/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName" = @{}} +``` + +```output +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +PowershellMSI WestUS DeviceOrdered ImportToAzure DataBox UserAssigned NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxJobDetails +``` + +Creates a databox import job with user assigned identity. +For any failure re-run with $DebugPreference = "Continue" as mentioned in example 1 + +### Example 5: Creates a databox job with your own key +```powershell +$dataAccount = New-AzDataBoxStorageAccountDetailsObject -DataAccountType "StorageAccount" -StorageAccountId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +$details = New-AzDataBoxJobDetailsObject -Type "DataBox" -DataImportDetail @(@{AccountDetail=$dataAccount; AccountDetailDataAccountType = "StorageAccount"} ) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -DevicePassword "randmPass@12345" +$resource = New-AzDataBoxJob -Name "PowershellBYOK" -SubscriptionId "SubscriptionId" -ResourceGroupName "resourceGroupName" -TransferType "ImportToAzure" -Detail $details -Location "WestUS" -SkuName "DataBox" +``` + +```output +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +PowershellBYOK WestUS DeviceOrdered ImportToAzure DataBox None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxJobDetails +``` + +Creates a databox job with your own key. +For any failure re-run with $DebugPreference = "Continue" as mentioned in example 1 + +### Example 6: Creates a databoxHeavy job with your own key +```powershell +$dataAccount = New-AzDataBoxStorageAccountDetailsObject -DataAccountType "StorageAccount" -StorageAccountId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +$details = New-AzDataBoxHeavyJobDetailsObject -Type "DataBoxHeavy" -DataImportDetail @(@{AccountDetail=$dataAccount; AccountDetailDataAccountType = "StorageAccount"} ) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -DevicePassword "randm@423jarABC" -ExpectedDataSizeInTeraByte 10 +$resource = New-AzDataBoxJob -Name "DbxHeavy" -SubscriptionId "SubscriptionId" -ResourceGroupName "resourceGroupName" -TransferType "ImportToAzure" -Detail $details -Location "WestUS" -SkuName "DataBoxHeavy" +``` + +```output +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +DbxHeavy WestUS DeviceOrdered ImportToAzure DataBoxHeavy None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxHeavyJobDetails +``` + +Creates a databoxHeavy job with your own key. +For any failure re-run with $DebugPreference = "Continue" as mentioned in example 1 + +### Example 7: Creates a databoxDisk job with your own Passkey +```powershell +$dataAccount = New-AzDataBoxStorageAccountDetailsObject -DataAccountType "StorageAccount" -StorageAccountId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +$details = New-AzDataBoxDiskJobDetailsObject -Type "DataBoxDisk" -DataImportDetail @(@{AccountDetail=$dataAccount; AccountDetailDataAccountType = "StorageAccount"} ) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -Passkey "randm@423jarABC" -PreferredDisk @{"8" = 8; "4" = 2} -ExpectedDataSizeInTeraByte 18 +New-AzDataBoxJob -Name "pwshDisk" -SubscriptionId "SubscriptionId" -ResourceGroupName "resourceGroupName" -TransferType "ImportToAzure" -Detail $details -Location "WestUS" -SkuName "DataBoxDisk" +``` + +```output +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +pwshDisk WestUS DeviceOrdered ImportToAzure DataBoxDisk None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxDiskJobDetails +``` + +Creates a databoxDisky job with your own Passkey. +For any failure re-run with $DebugPreference = "Continue" as mentioned in example 1 + +### Example 8: Creates a databox job with double encryption enabled +```powershell +$dataAccount = New-AzDataBoxStorageAccountDetailsObject -DataAccountType "StorageAccount" -StorageAccountId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +$details = New-AzDataBoxJobDetailsObject -Type "DataBox" -DataImportDetail @(@{AccountDetail=$dataAccount; AccountDetailDataAccountType = "StorageAccount"} ) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -Preference @{EncryptionPreferenceDoubleEncryption="Enabled"} +New-AzDataBoxJob -Name "pwshDoubEncy" -SubscriptionId "SubscriptionId" -ResourceGroupName "resourceGroupName" -TransferType "ImportToAzure" -Detail $details -Location "WestUS" -SkuName "DataBox" +``` + +```output +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +pwshDoubEncy WestUS DeviceOrdered ImportToAzure DataBox None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxDiskJobDetails +``` + +Creates a databox job with double encryption enabled. +For any failure re-run with $DebugPreference = "Continue" as mentioned in example 1 + +### Example 9: Creates a Data Box Customer Disk import job +```powershell +$dataAccount = New-AzDataBoxStorageAccountDetailsObject -DataAccountType "StorageAccount" -StorageAccountId "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroup/providers/Microsoft.Storage/storageAccounts/YourStorageAccount" +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "XXXX XXXX" -EmailList @("emailId") -Phone "0000000000" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "XXXX XXXX" -StateOrProvince "XX" -Country "XX" -City "XXXX XXXX" -PostalCode "00000" -AddressType "Commercial" +$importDiskDetailsCollection = @{"XXXXXX"= @{ManifestFile = "xyz.txt"; ManifestHash = "xxxx"; BitLockerKey = "xxx"}} +$customerDiskDetails = New-AzDataBoxCustomerDiskJobDetailsObject -Type "DataBoxCustomerDisk" -DataImportDetail @(@{AccountDetail=$dataAccount; AccountDetailDataAccountType = "StorageAccount"} ) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -ImportDiskDetailsCollection $importDiskDetailsCollection -ReturnToCustomerPackageDetailCarrierAccountNumber "00000" + +New-AzDataBoxJob -Name "testJobName1" -SubscriptionId "YourSubscriptionId" -ResourceGroupName "YourResourceGroup" -TransferType "ImportToAzure" -Detail $customerDiskDetails -Location "westus" -SkuName "DataBoxCustomerDisk" +``` + +```output + +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +testJobName1 westus AwaitingShipmentDetails ImportToAzure DataBoxCustomerDisk None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.DataBoxCustomerDiskJobDetails + +``` + +Creates a databox customer disk job to import data to Azure. +For any failure re-run with $DebugPreference = "Continue" as mentioned in example 1 + +### Example 10: Creates a Data Box Customer Disk export job +```powershell +$dataAccount = New-AzDataBoxStorageAccountDetailsObject -DataAccountType "StorageAccount" -StorageAccountId "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroup/providers/Microsoft.Storage/storageAccounts/YourStorageAccount" +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "XXXX XXXX" -EmailList @("emailId") -Phone "0000000000" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "XXXX XXXX" -StateOrProvince "XX" -Country "XX" -City "XXXX XXXX" -PostalCode "00000" -AddressType "Commercial" +$transferConfiguration = New-AzDataBoxTransferConfigurationObject -Type "TransferAll" -TransferAllDetail @{"IncludeDataAccountType"="StorageAccount";"IncludeTransferAllBlob"= "True"; "IncludeTransferAllFile"="False"} +$customerDiskDetails = New-AzDataBoxCustomerDiskJobDetailsObject -Type "DataBoxCustomerDisk" -DataExportDetail @(@{ AccountDetail=$dataAccount; AccountDetailDataAccountType = "StorageAccount"; "TransferConfiguration"=$transferConfiguration }) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -ReturnToCustomerPackageDetailCarrierAccountNumber "00000" + +New-AzDataBoxJob -Name "testJobName2" -SubscriptionId "YourSubscriptionId" -ResourceGroupName "YourResourceGroup" -TransferType "ExportFromAzure" -Detail $customerDiskDetails -Location "westus" -SkuName "DataBoxCustomerDisk" +``` + +```output + +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +testJobName2 westus AwaitingShipmentDetails ExportFromAzure DataBoxCustomerDisk None NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.DataBoxCustomerDiskJobDetails + +``` + +Creates a databox customer disk job to export data from Azure. +For any failure re-run with $DebugPreference = "Continue" as mentioned in example 1 + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryInfoScheduledDateTime +Scheduled date time. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryType +Delivery type of Job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.JobDeliveryType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Detail +Details of a job run. +This field will only be sent for expand details filter. +To construct, see NOTES section for DETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IJobDetails +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Identity type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. +This will be one of the supported and registered Azure Regions (e.g. +West US, East US, Southeast Asia, etc.). +The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the job Resource within the specified resource group. +job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuDisplayName +The display 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 +``` + +### -SkuFamily +The sku family. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The sku name. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The list of key value pairs that describe the resource. +These tags can be used in viewing and grouping this resource (across resource groups). + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransferType +Type of the data transfer. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.TransferType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +User Assigned Identities + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IJobResource + +## 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. + + +`DETAIL <IJobDetails>`: Details of a job run. This field will only be sent for expand details filter. + - `ContactDetail <IContactDetails>`: Contact details for notification and shipping. + - `ContactName <String>`: Contact name of the person. + - `EmailList <String[]>`: List of Email-ids to be notified about job progress. + - `Phone <String>`: Phone number of the contact person. + - `[Mobile <String>]`: Mobile number of the contact person. + - `[NotificationPreference <INotificationPreference[]>]`: Notification preference for a job stage. + - `SendNotification <Boolean>`: Notification is required or not. + - `StageName <NotificationStageName>`: Name of the stage. + - `[PhoneExtension <String>]`: Phone extension number of the contact person. + - `Type <ClassDiscriminator>`: Indicates the type of job details. + - `[DataExportDetail <IDataExportDetails[]>]`: Details of the data to be exported from azure. + - `AccountDetailDataAccountType <DataAccountType>`: Account Type of the data to be transferred. + - `TransferConfiguration <ITransferConfiguration>`: Configuration for the data transfer. + - `Type <TransferConfigurationType>`: Type of the configuration for transfer. + - `[TransferAllDetail <ITransferConfigurationTransferAllDetails>]`: Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll + - `[IncludeDataAccountType <DataAccountType?>]`: Type of the account of data + - `[IncludeTransferAllBlob <Boolean?>]`: To indicate if all Azure blobs have to be transferred + - `[IncludeTransferAllFile <Boolean?>]`: To indicate if all Azure Files have to be transferred + - `[TransferFilterDetail <ITransferConfigurationTransferFilterDetails>]`: Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. + - `[AzureFileFilterDetailFilePathList <String[]>]`: List of full path of the files to be transferred. + - `[AzureFileFilterDetailFilePrefixList <String[]>]`: Prefix list of the Azure files to be transferred. + - `[AzureFileFilterDetailFileShareList <String[]>]`: List of file shares to be transferred. + - `[BlobFilterDetailBlobPathList <String[]>]`: List of full path of the blobs to be transferred. + - `[BlobFilterDetailBlobPrefixList <String[]>]`: Prefix list of the Azure blobs to be transferred. + - `[BlobFilterDetailContainerList <String[]>]`: List of blob containers to be transferred. + - `[IncludeDataAccountType <DataAccountType?>]`: Type of the account of data. + - `[IncludeFilterFileDetail <IFilterFileDetails[]>]`: Details of the filter files to be used for data transfer. + - `FilterFilePath <String>`: Path of the file that contains the details of all items to transfer. + - `FilterFileType <FilterFileType>`: Type of the filter file. + - `[AccountDetailSharePassword <String>]`: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ + - `[LogCollectionLevel <LogCollectionLevel?>]`: Level of the logs to be collected. + - `[DataImportDetail <IDataImportDetails[]>]`: Details of the data to be imported into azure. + - `AccountDetailDataAccountType <DataAccountType>`: Account Type of the data to be transferred. + - `[AccountDetailSharePassword <String>]`: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ + - `[LogCollectionLevel <LogCollectionLevel?>]`: Level of the logs to be collected. + - `[ExpectedDataSizeInTeraByte <Int32?>]`: The expected size of the data, which needs to be transferred in this job, in terabytes. + - `[KeyEncryptionKey <IKeyEncryptionKey>]`: Details about which key encryption type is being used. + - `KekType <KekType>`: Type of encryption key used for key encryption. + - `[IdentityProperty <IIdentityProperties>]`: Managed identity properties used for key encryption. + - `[Type <String>]`: Managed service identity type. + - `[UserAssignedResourceId <String>]`: Arm resource id for user assigned identity to be used to fetch MSI token. + - `[KekUrl <String>]`: Key encryption key. It is required in case of Customer managed KekType. + - `[KekVaultResourceId <String>]`: Kek vault resource id. It is required in case of Customer managed KekType. + - `[Preference <IPreferences>]`: Preferences for the order. + - `[EncryptionPreferenceDoubleEncryption <DoubleEncryption?>]`: Defines secondary layer of software-based encryption enablement. + - `[EncryptionPreferenceHardwareEncryption <HardwareEncryption?>]`: Defines Hardware level encryption (Only for disk) + - `[PreferredDataCenterRegion <String[]>]`: Preferred data center region. + - `[ReverseTransportPreferencePreferredShipmentType <TransportShipmentTypes?>]`: Indicates Shipment Logistics type that the customer preferred. + - `[StorageAccountAccessTierPreference <StorageAccountAccessTier[]>]`: Preferences related to the Access Tier of storage accounts. + - `[TransportPreferencePreferredShipmentType <TransportShipmentTypes?>]`: Indicates Shipment Logistics type that the customer preferred. + - `[ReverseShippingDetail <IReverseShippingDetails>]`: Optional Reverse Shipping details for order. + - `[ContactDetailContactName <String>]`: Contact name of the person. + - `[ContactDetailMobile <String>]`: Mobile number of the contact person. + - `[ContactDetailPhone <String>]`: Phone number of the contact person. + - `[ContactDetailPhoneExtension <String>]`: Phone extension number of the contact person. + - `[ShippingAddress <IShippingAddress>]`: Shipping address where customer wishes to receive the device. + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[SkipAddressValidation <Boolean?>]`: Flag to indicate if customer has chosen to skip default address validation + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[TaxIdentificationNumber <String>]`: Tax Identification Number + - `[ZipExtendedCode <String>]`: Extended Zip Code. + - `[ShippingAddress <IShippingAddress>]`: Shipping address of the customer. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/New-AzDataBoxJobDetailsObject.md b/azps-10.1.0/Az.DataBox/New-AzDataBoxJobDetailsObject.md new file mode 100644 index 0000000000..0e46780671 --- /dev/null +++ b/azps-10.1.0/Az.DataBox/New-AzDataBoxJobDetailsObject.md @@ -0,0 +1,331 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/Az.DataBox/new-AzDataBoxJobDetailsObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxJobDetailsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxJobDetailsObject.md +--- + +# New-AzDataBoxJobDetailsObject + +## SYNOPSIS +Create an in-memory object for DataBoxJobDetails. + +## SYNTAX + +``` +New-AzDataBoxJobDetailsObject -ContactDetail <IContactDetails> -Type <ClassDiscriminator> + [-DataExportDetail <IDataExportDetails[]>] [-DataImportDetail <IDataImportDetails[]>] + [-DevicePassword <String>] [-ExpectedDataSizeInTeraByte <Int32>] [-KeyEncryptionKey <IKeyEncryptionKey>] + [-Preference <IPreferences>] [-ReverseShippingDetail <IReverseShippingDetails>] + [-ShippingAddress <IShippingAddress>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for DataBoxJobDetails. + +## EXAMPLES + +### Example 1: Creates a databox job detail in memory object +```powershell +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" + +New-AzDataBoxJobDetailsObject -Type "DataBox" -DataImportDetail @(@{AccountDetail=$dataAccount; AccountDetailDataAccountType = "StorageAccount"} ) -ContactDetail $contactDetail -ShippingAddress $ShippingDetails +``` + +```output +Action : +ChainOfCustodySasKey : +ContactDetail : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.ContactDetails +CopyLogDetail : +CopyProgress : +DataExportDetail : +DataImportDetail : {Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataImportDetails} +DeliveryPackage : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.PackageShippingDetails +DevicePassword : +ExpectedDataSizeInTeraByte : 0 +JobStage : +KeyEncryptionKey : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.KeyEncryptionKey +LastMitigationActionOnJob : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.LastMitigationActionOnJob +Preference : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.Preferences +ReturnPackage : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.PackageShippingDetails +ReverseShipmentLabelSasKey : +ShippingAddress : Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.ShippingAddress +Type : DataBox +``` + +Create a in-memory object for DataBoxJobDetails + +## PARAMETERS + +### -ContactDetail +Contact details for notification and shipping. +To construct, see NOTES section for CONTACTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IContactDetails +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataExportDetail +Details of the data to be exported from azure. +To construct, see NOTES section for DATAEXPORTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IDataExportDetails[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataImportDetail +Details of the data to be imported into azure. +To construct, see NOTES section for DATAIMPORTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IDataImportDetails[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DevicePassword +Set Device password for unlocking Databox. +Should not be passed for TransferType:ExportFromAzure jobs. +If this is not passed, the service will generate password itself. +This will not be returned in Get Call. +Password Requirements : Password must be minimum of 12 and maximum of 64 characters. +Password must have at least one uppercase alphabet, one number and one special character. +Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpectedDataSizeInTeraByte +The expected size of the data, which needs to be transferred in this job, in terabytes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKey +Details about which key encryption type is being used. +To construct, see NOTES section for KEYENCRYPTIONKEY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IKeyEncryptionKey +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Preference +Preferences for the order. +To construct, see NOTES section for PREFERENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IPreferences +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReverseShippingDetail +Optional Reverse Shipping details for order. +To construct, see NOTES section for REVERSESHIPPINGDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IReverseShippingDetails +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingAddress +Shipping address of the customer. +To construct, see NOTES section for SHIPPINGADDRESS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IShippingAddress +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Indicates the type of job details. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.ClassDiscriminator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.DataBoxJobDetails + +## 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. + + +`CONTACTDETAIL <IContactDetails>`: Contact details for notification and shipping. + - `ContactName <String>`: Contact name of the person. + - `EmailList <String[]>`: List of Email-ids to be notified about job progress. + - `Phone <String>`: Phone number of the contact person. + - `[Mobile <String>]`: Mobile number of the contact person. + - `[NotificationPreference <INotificationPreference[]>]`: Notification preference for a job stage. + - `SendNotification <Boolean>`: Notification is required or not. + - `StageName <NotificationStageName>`: Name of the stage. + - `[PhoneExtension <String>]`: Phone extension number of the contact person. + +`DATAEXPORTDETAIL <IDataExportDetails[]>`: Details of the data to be exported from azure. + - `AccountDetailDataAccountType <DataAccountType>`: Account Type of the data to be transferred. + - `TransferConfiguration <ITransferConfiguration>`: Configuration for the data transfer. + - `Type <TransferConfigurationType>`: Type of the configuration for transfer. + - `[TransferAllDetail <ITransferConfigurationTransferAllDetails>]`: Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll + - `[IncludeDataAccountType <DataAccountType?>]`: Type of the account of data + - `[IncludeTransferAllBlob <Boolean?>]`: To indicate if all Azure blobs have to be transferred + - `[IncludeTransferAllFile <Boolean?>]`: To indicate if all Azure Files have to be transferred + - `[TransferFilterDetail <ITransferConfigurationTransferFilterDetails>]`: Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. + - `[AzureFileFilterDetailFilePathList <String[]>]`: List of full path of the files to be transferred. + - `[AzureFileFilterDetailFilePrefixList <String[]>]`: Prefix list of the Azure files to be transferred. + - `[AzureFileFilterDetailFileShareList <String[]>]`: List of file shares to be transferred. + - `[BlobFilterDetailBlobPathList <String[]>]`: List of full path of the blobs to be transferred. + - `[BlobFilterDetailBlobPrefixList <String[]>]`: Prefix list of the Azure blobs to be transferred. + - `[BlobFilterDetailContainerList <String[]>]`: List of blob containers to be transferred. + - `[IncludeDataAccountType <DataAccountType?>]`: Type of the account of data. + - `[IncludeFilterFileDetail <IFilterFileDetails[]>]`: Details of the filter files to be used for data transfer. + - `FilterFilePath <String>`: Path of the file that contains the details of all items to transfer. + - `FilterFileType <FilterFileType>`: Type of the filter file. + - `[AccountDetailSharePassword <String>]`: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ + - `[LogCollectionLevel <LogCollectionLevel?>]`: Level of the logs to be collected. + +`DATAIMPORTDETAIL <IDataImportDetails[]>`: Details of the data to be imported into azure. + - `AccountDetailDataAccountType <DataAccountType>`: Account Type of the data to be transferred. + - `[AccountDetailSharePassword <String>]`: Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ + - `[LogCollectionLevel <LogCollectionLevel?>]`: Level of the logs to be collected. + +`KEYENCRYPTIONKEY <IKeyEncryptionKey>`: Details about which key encryption type is being used. + - `KekType <KekType>`: Type of encryption key used for key encryption. + - `[IdentityProperty <IIdentityProperties>]`: Managed identity properties used for key encryption. + - `[Type <String>]`: Managed service identity type. + - `[UserAssignedResourceId <String>]`: Arm resource id for user assigned identity to be used to fetch MSI token. + - `[KekUrl <String>]`: Key encryption key. It is required in case of Customer managed KekType. + - `[KekVaultResourceId <String>]`: Kek vault resource id. It is required in case of Customer managed KekType. + +`PREFERENCE <IPreferences>`: Preferences for the order. + - `[EncryptionPreferenceDoubleEncryption <DoubleEncryption?>]`: Defines secondary layer of software-based encryption enablement. + - `[EncryptionPreferenceHardwareEncryption <HardwareEncryption?>]`: Defines Hardware level encryption (Only for disk) + - `[PreferredDataCenterRegion <String[]>]`: Preferred data center region. + - `[ReverseTransportPreferencePreferredShipmentType <TransportShipmentTypes?>]`: Indicates Shipment Logistics type that the customer preferred. + - `[StorageAccountAccessTierPreference <StorageAccountAccessTier[]>]`: Preferences related to the Access Tier of storage accounts. + - `[TransportPreferencePreferredShipmentType <TransportShipmentTypes?>]`: Indicates Shipment Logistics type that the customer preferred. + +`REVERSESHIPPINGDETAIL <IReverseShippingDetails>`: Optional Reverse Shipping details for order. + - `[ContactDetailContactName <String>]`: Contact name of the person. + - `[ContactDetailMobile <String>]`: Mobile number of the contact person. + - `[ContactDetailPhone <String>]`: Phone number of the contact person. + - `[ContactDetailPhoneExtension <String>]`: Phone extension number of the contact person. + - `[ShippingAddress <IShippingAddress>]`: Shipping address where customer wishes to receive the device. + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[SkipAddressValidation <Boolean?>]`: Flag to indicate if customer has chosen to skip default address validation + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[TaxIdentificationNumber <String>]`: Tax Identification Number + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +`SHIPPINGADDRESS <IShippingAddress>`: Shipping address of the customer. + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[SkipAddressValidation <Boolean?>]`: Flag to indicate if customer has chosen to skip default address validation + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[TaxIdentificationNumber <String>]`: Tax Identification Number + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/New-AzDataBoxKeyEncryptionKeyObject.md b/azps-10.1.0/Az.DataBox/New-AzDataBoxKeyEncryptionKeyObject.md new file mode 100644 index 0000000000..016300fa89 --- /dev/null +++ b/azps-10.1.0/Az.DataBox/New-AzDataBoxKeyEncryptionKeyObject.md @@ -0,0 +1,128 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/Az.DataBox/new-AzDataBoxKeyEncryptionKeyObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxKeyEncryptionKeyObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxKeyEncryptionKeyObject.md +--- + +# New-AzDataBoxKeyEncryptionKeyObject + +## SYNOPSIS +Create an in-memory object for KeyEncryptionKey. + +## SYNTAX + +``` +New-AzDataBoxKeyEncryptionKeyObject -KekType <KekType> [-IdentityProperty <IIdentityProperties>] + [-KekUrl <String>] [-KekVaultResourceId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for KeyEncryptionKey. + +## EXAMPLES + +### Example 1: Create a in-memory object for KeyEncryptionKey +```powershell +New-AzDataBoxKeyEncryptionKeyObject -KekType "CustomerManaged" -IdentityProperty @{Type = "UserAssigned"; UserAssignedResourceId = "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName"} -KekUrl "keyIdentifier" -KekVaultResourceId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" +``` + +```output +KekType KekUrl KekVaultResourceId +------- ------ ------------------ +CustomerManaged keyIdentifier /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName +``` + +Create a in-memory object for KeyEncryptionKey + +## PARAMETERS + +### -IdentityProperty +Managed identity properties used for key encryption. +To construct, see NOTES section for IDENTITYPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IIdentityProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KekType +Type of encryption key used for key encryption. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.KekType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KekUrl +Key encryption key. +It is required in case of Customer managed KekType. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KekVaultResourceId +Kek vault resource id. +It is required in case of Customer managed KekType. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.KeyEncryptionKey + +## 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. + + +`IDENTITYPROPERTY <IIdentityProperties>`: Managed identity properties used for key encryption. + - `[Type <String>]`: Managed service identity type. + - `[UserAssignedResourceId <String>]`: Arm resource id for user assigned identity to be used to fetch MSI token. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/New-AzDataBoxManagedDiskDetailsObject.md b/azps-10.1.0/Az.DataBox/New-AzDataBoxManagedDiskDetailsObject.md new file mode 100644 index 0000000000..7f98a9cbe5 --- /dev/null +++ b/azps-10.1.0/Az.DataBox/New-AzDataBoxManagedDiskDetailsObject.md @@ -0,0 +1,122 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/Az.DataBox/new-AzDataBoxManagedDiskDetailsObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxManagedDiskDetailsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxManagedDiskDetailsObject.md +--- + +# New-AzDataBoxManagedDiskDetailsObject + +## SYNOPSIS +Create an in-memory object for ManagedDiskDetails. + +## SYNTAX + +``` +New-AzDataBoxManagedDiskDetailsObject -DataAccountType <DataAccountType> -ResourceGroupId <String> + -StagingStorageAccountId <String> [-SharePassword <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ManagedDiskDetails. + +## EXAMPLES + +### Example 1: ManagedDisk object +```powershell +New-AzDataBoxManagedDiskDetailsObject -ResourceGroupId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName" -StagingStorageAccountId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/stagingAccountName" -DataAccountType "ManagedDisk" +``` + +```output +DataAccountType SharePassword ResourceGroupId StagingStorageAccountId +--------------- ------------- --------------- ----------------------- +ManagedDisk /subscriptions/SubscriptionId/resourceGroups/resourceGroupName /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/stagingAccountName +``` + +Creates a in-memory managed disk object + +## PARAMETERS + +### -DataAccountType +Account Type of the data to be transferred. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.DataAccountType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupId +Resource Group Id of the compute disks. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePassword +Password for all the shares to be created on the device. +Should not be passed for TransferType:ExportFromAzure jobs. +If this is not passed, the service will generate password itself. +This will not be returned in Get Call. +Password Requirements : Password must be minimum of 12 and maximum of 64 characters. +Password must have at least one uppercase alphabet, one number and one special character. +Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StagingStorageAccountId +Resource Id of the storage account that can be used to copy the vhd for staging. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.ManagedDiskDetails + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/New-AzDataBoxShippingAddressObject.md b/azps-10.1.0/Az.DataBox/New-AzDataBoxShippingAddressObject.md new file mode 100644 index 0000000000..12c3d68075 --- /dev/null +++ b/azps-10.1.0/Az.DataBox/New-AzDataBoxShippingAddressObject.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/Az.DataBox/new-AzDataBoxShippingAddressObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxShippingAddressObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxShippingAddressObject.md +--- + +# New-AzDataBoxShippingAddressObject + +## SYNOPSIS +Create an in-memory object for ShippingAddress. + +## SYNTAX + +``` +New-AzDataBoxShippingAddressObject -Country <String> -StreetAddress1 <String> [-AddressType <AddressType>] + [-City <String>] [-CompanyName <String>] [-PostalCode <String>] [-SkipAddressValidation <Boolean>] + [-StateOrProvince <String>] [-StreetAddress2 <String>] [-StreetAddress3 <String>] + [-TaxIdentificationNumber <String>] [-ZipExtendedCode <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ShippingAddress. + +## EXAMPLES + +### Example 1: Shipping Address object +```powershell +New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +``` + +```output +AddressType City CompanyName Country PostalCode StateOrProvince StreetAddress1 StreetAddress2 StreetAddress3 ZipExtendedCode +----------- ---- ----------- ------- ---------- --------------- -------------- -------------- -------------- --------------- +Commercial San Francisco US 94107 CA 101 TOWNSEND ST +``` + +Creates a in-memory shipping address object + +## PARAMETERS + +### -AddressType +Type of address. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.AddressType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -City +Name of the City. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +Name of the company. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Country +Name of the Country. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostalCode +Postal code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipAddressValidation +Flag to indicate if customer has chosen to skip default address validation. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StateOrProvince +Name of the State or Province. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreetAddress1 +Street Address line 1. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreetAddress2 +Street Address line 2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreetAddress3 +Street Address line 3. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TaxIdentificationNumber +Tax Identification Number. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZipExtendedCode +Extended Zip Code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.ShippingAddress + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/New-AzDataBoxStorageAccountDetailsObject.md b/azps-10.1.0/Az.DataBox/New-AzDataBoxStorageAccountDetailsObject.md new file mode 100644 index 0000000000..60a7a19f78 --- /dev/null +++ b/azps-10.1.0/Az.DataBox/New-AzDataBoxStorageAccountDetailsObject.md @@ -0,0 +1,107 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/Az.DataBox/new-AzDataBoxStorageAccountDetailsObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxStorageAccountDetailsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxStorageAccountDetailsObject.md +--- + +# New-AzDataBoxStorageAccountDetailsObject + +## SYNOPSIS +Create an in-memory object for StorageAccountDetails. + +## SYNTAX + +``` +New-AzDataBoxStorageAccountDetailsObject -DataAccountType <DataAccountType> -StorageAccountId <String> + [-SharePassword <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for StorageAccountDetails. + +## EXAMPLES + +### Example 1: Storage account in-memory object +```powershell +New-AzDataBoxStorageAccountDetailsObject -DataAccountType "StorageAccount" -StorageAccountId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" +``` + +```output +DataAccountType SharePassword StorageAccountId +--------------- ------------- ---------------- +StorageAccount /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName +``` + +Storage account in-memory object + +## PARAMETERS + +### -DataAccountType +Account Type of the data to be transferred. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.DataAccountType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePassword +Password for all the shares to be created on the device. +Should not be passed for TransferType:ExportFromAzure jobs. +If this is not passed, the service will generate password itself. +This will not be returned in Get Call. +Password Requirements : Password must be minimum of 12 and maximum of 64 characters. +Password must have at least one uppercase alphabet, one number and one special character. +Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountId +Storage Account Resource Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.StorageAccountDetails + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/New-AzDataBoxTransferConfigurationObject.md b/azps-10.1.0/Az.DataBox/New-AzDataBoxTransferConfigurationObject.md new file mode 100644 index 0000000000..aa9eda3154 --- /dev/null +++ b/azps-10.1.0/Az.DataBox/New-AzDataBoxTransferConfigurationObject.md @@ -0,0 +1,122 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/Az.DataBox/new-AzDataBoxTransferConfigurationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxTransferConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/New-AzDataBoxTransferConfigurationObject.md +--- + +# New-AzDataBoxTransferConfigurationObject + +## SYNOPSIS +Create an in-memory object for TransferConfiguration. + +## SYNTAX + +``` +New-AzDataBoxTransferConfigurationObject -Type <TransferConfigurationType> + [-TransferAllDetail <ITransferConfigurationTransferAllDetails>] + [-TransferFilterDetail <ITransferConfigurationTransferFilterDetails>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for TransferConfiguration. + +## EXAMPLES + +### Example 1: In-memory object for export job transfer configuration +```powershell +New-AzDataBoxTransferConfigurationObject -Type "TransferAll" -TransferAllDetail @{"IncludeDataAccountType"="StorageAccount";"IncludeTransferAllBlob"= "True"; "IncludeTransferAllFile"="True"} +``` + +Create a in-memory object for export jobs TransferConfiguration + +## PARAMETERS + +### -TransferAllDetail +Map of filter type and the details to transfer all data. +This field is required only if the TransferConfigurationType is given as TransferAll. +To construct, see NOTES section for TRANSFERALLDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.ITransferConfigurationTransferAllDetails +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransferFilterDetail +Map of filter type and the details to filter. +This field is required only if the TransferConfigurationType is given as TransferUsingFilter. +To construct, see NOTES section for TRANSFERFILTERDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.ITransferConfigurationTransferFilterDetails +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of the configuration for transfer. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.TransferConfigurationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.TransferConfiguration + +## 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. + + +`TRANSFERALLDETAIL <ITransferConfigurationTransferAllDetails>`: Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll. + - `[IncludeDataAccountType <DataAccountType?>]`: Type of the account of data + - `[IncludeTransferAllBlob <Boolean?>]`: To indicate if all Azure blobs have to be transferred + - `[IncludeTransferAllFile <Boolean?>]`: To indicate if all Azure Files have to be transferred + +`TRANSFERFILTERDETAIL <ITransferConfigurationTransferFilterDetails>`: Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. + - `[AzureFileFilterDetailFilePathList <String[]>]`: List of full path of the files to be transferred. + - `[AzureFileFilterDetailFilePrefixList <String[]>]`: Prefix list of the Azure files to be transferred. + - `[AzureFileFilterDetailFileShareList <String[]>]`: List of file shares to be transferred. + - `[BlobFilterDetailBlobPathList <String[]>]`: List of full path of the blobs to be transferred. + - `[BlobFilterDetailBlobPrefixList <String[]>]`: Prefix list of the Azure blobs to be transferred. + - `[BlobFilterDetailContainerList <String[]>]`: List of blob containers to be transferred. + - `[IncludeDataAccountType <DataAccountType?>]`: Type of the account of data. + - `[IncludeFilterFileDetail <IFilterFileDetails[]>]`: Details of the filter files to be used for data transfer. + - `FilterFilePath <String>`: Path of the file that contains the details of all items to transfer. + - `FilterFileType <FilterFileType>`: Type of the filter file. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/Remove-AzDataBoxJob.md b/azps-10.1.0/Az.DataBox/Remove-AzDataBoxJob.md new file mode 100644 index 0000000000..1498b24adb --- /dev/null +++ b/azps-10.1.0/Az.DataBox/Remove-AzDataBoxJob.md @@ -0,0 +1,188 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/az.databox/remove-azdataboxjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/Remove-AzDataBoxJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/Remove-AzDataBoxJob.md +--- + +# Remove-AzDataBoxJob + +## SYNOPSIS +Deletes a job. + +## SYNTAX + +``` +Remove-AzDataBoxJob -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a job. + +## EXAMPLES + +### Example 1: Deletes a job +```powershell +Remove-AzDataBoxJob -Name "Powershell10" -ResourceGroupName "resourceGroupName" +``` + +Deletes a job + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the job Resource within the specified resource group. +job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/Stop-AzDataBoxJob.md b/azps-10.1.0/Az.DataBox/Stop-AzDataBoxJob.md new file mode 100644 index 0000000000..dfdaf0c541 --- /dev/null +++ b/azps-10.1.0/Az.DataBox/Stop-AzDataBoxJob.md @@ -0,0 +1,180 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/az.databox/stop-azdataboxjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/Stop-AzDataBoxJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/Stop-AzDataBoxJob.md +--- + +# Stop-AzDataBoxJob + +## SYNOPSIS +CancelJob. + +## SYNTAX + +``` +Stop-AzDataBoxJob -Name <String> -ResourceGroupName <String> -Reason <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +CancelJob. + +## EXAMPLES + +### Example 1: Cancel a Job +```powershell +Stop-AzDataBoxJob -Name "Powershell10" -ResourceGroupName "resourceGroupName" -Reason "Powershell demo job" +Get-AzDataBoxJob -Name "Powershell10" -ResourceGroupName "resourceGroupName" +``` + +```output +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +Powershell10 WestUS Cancelled ImportToAzure DataBox UserAssigned NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxJobDetails +``` + +Cancel a job + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the job Resource within the specified resource group. +job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reason +Reason for cancellation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBox/Update-AzDataBoxJob.md b/azps-10.1.0/Az.DataBox/Update-AzDataBoxJob.md new file mode 100644 index 0000000000..e72f65cf89 --- /dev/null +++ b/azps-10.1.0/Az.DataBox/Update-AzDataBoxJob.md @@ -0,0 +1,627 @@ +--- +external help file: +Module Name: Az.DataBox +online version: https://learn.microsoft.com/powershell/module/az.databox/update-azdataboxjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/Update-AzDataBoxJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBox/help/Update-AzDataBoxJob.md +--- + +# Update-AzDataBoxJob + +## SYNOPSIS +Updates the properties of an existing job. + +## SYNTAX + +``` +Update-AzDataBoxJob -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-IfMatch <String>] + [-ContactDetail <IContactDetails>] [-ContactDetailContactName <String>] [-ContactDetailMobile <String>] + [-ContactDetailPhone <String>] [-ContactDetailPhoneExtension <String>] + [-EncryptionPreferenceDoubleEncryption <DoubleEncryption>] + [-EncryptionPreferenceHardwareEncryption <HardwareEncryption>] [-IdentityType <String>] + [-KeyEncryptionKey <IKeyEncryptionKey>] [-PreferencePreferredDataCenterRegion <String[]>] + [-ReturnToCustomerPackageDetailCarrierAccountNumber <String>] + [-ReturnToCustomerPackageDetailCarrierName <String>] [-ReturnToCustomerPackageDetailTrackingId <String>] + [-ReverseShippingDetail <IShippingAddress>] [-ReverseTransportPreferredShipmentType <TransportShipmentTypes>] + [-ShippingAddress <IShippingAddress>] [-StorageAccountAccessTierPreference <StorageAccountAccessTier[]>] + [-Tag <Hashtable>] [-TransportPreferredShipmentType <TransportShipmentTypes>] + [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the properties of an existing job. + +## EXAMPLES + +### Example 1: Update databox job encryption from microsoft managed to customer managed with user assigned identities +```powershell +$keyEncryptionDetails = New-AzDataBoxKeyEncryptionKeyObject -KekType "CustomerManaged" -IdentityProperty @{Type = "UserAssigned"; UserAssignedResourceId = "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName"} -KekUrl "keyIdentifier" -KekVaultResourceId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + +$DebugPreference = "Continue" + +# You can use `$DebugPreference = "Continue"`, with any example/usecase to get exact details of error in below format when update command fails. +# { +# "Error": { +# "Code": "StaticValidationGenericCountryCodeHasInvalidLength", +# "Message": "The attribute country code does not meet length constraints.\r\nEnter a value with 2 characters for country code.", +# "Details": [ +# null +# ], +# "Target": null +# } +# } + +Update-AzDataBoxJob -Name "powershell10" -ResourceGroupName "resourceGroupName" -KeyEncryptionKey $keyEncryptionDetails -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -IdentityType "UserAssigned" -UserAssignedIdentity @{"/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName" = @{}} + +$keyEncryptionDetails +``` + +```output +KekType KekUrl KekVaultResourceId +------- ------ ------------------ +CustomerManaged keyIdentifier /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName + +Name Location Status TransferType SkuName IdentityType DeliveryType Detail +---- -------- ------ ------------ ------- ------------ ------------ ------ +Powershell10 WestUS DeviceOrdered ImportToAzure DataBox UserAssigned NonScheduled Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20210301.DataBoxJobDetails +``` + +Update databox job encryption from microsoft managed to customer managed with user assigned identities. + +### Example 2: Update databox job encryption from microsoft managed to customer managed with system identities in 2 updates +```powershell +$databoxUpdate = Update-AzDataBoxJob -Name "pwshTestSAssigned" -ResourceGroupName "resourceGroupName" -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -IdentityType "SystemAssigned" + +$databoxUpdate.Identity + +$keyEncryptionDetails = New-AzDataBoxKeyEncryptionKeyObject -KekType "CustomerManaged" -IdentityProperty @{Type = "SystemAssigned"} -KekUrl "keyIdentifier" -KekVaultResourceId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + +$databoxUpdateWithCMK = Update-AzDataBoxJob -Name "pwshTestSAssigned" -ResourceGroupName "resourceGroupName" -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -KeyEncryptionKey $keyEncryptionDetails + +$databoxUpdateWithCMK.Identity + +$databoxUpdateWithCMK.Detail.KeyEncryptionKey +``` + +```output +PrincipalId TenantId Type +----------- -------- ---- +920850f5-9b6b-4017-a81a-3dcafe348be7 72f988bf-86f1-41af-91ab-2d7cd011db47 SystemAssigned + +PrincipalId TenantId Type +----------- -------- ---- +920850f5-9b6b-4017-a81a-3dcafe348be7 72f988bf-86f1-41af-91ab-2d7cd011db47 SystemAssigned + +KekType KekUrl KekVaultResourceId +------- ------ ------------------ +CustomerManaged keyIdentifier /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName +``` + +Update databox job encryption from microsoft managed to customer managed to customer managed with sytem assigned identity. +For any failure re-run with $DebugPreference = "Continue" as mentioned in example 1 + +### Example 3: Update databox job from system assigned to user assigned with customer managed key encryption +```powershell +$contactDetail = New-AzDataBoxContactDetailsObject -ContactName "random" -EmailList @("emailId") -Phone "1234567891" +$ShippingDetails = New-AzDataBoxShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" + +Update-AzDataBoxJob -Name "pwshTestSAssigned" -ResourceGroupName "resourceGroupName" -KeyEncryptionKey $keyEncryptionDetails -ContactDetail $contactDetail -ShippingAddress $ShippingDetails -IdentityType "SystemAssigned,UserAssigned" -UserAssignedIdentity @{"/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName" = @{}} +``` + +Update databox job from system assigned to user assigned with customer managed key encryption. +For any failure re-run with $DebugPreference = "Continue" as mentioned in example 1 + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactDetail +Contact details for notification and shipping. +To construct, see NOTES section for CONTACTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IContactDetails +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactDetailContactName +Contact name of the person. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactDetailMobile +Mobile number of the contact person. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactDetailPhone +Phone number of the contact person. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactDetailPhoneExtension +Phone extension number of the contact person. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionPreferenceDoubleEncryption +Defines secondary layer of software-based encryption enablement. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.DoubleEncryption +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionPreferenceHardwareEncryption +Defines Hardware level encryption (Only for disk) + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.HardwareEncryption +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Identity type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +Defines the If-Match condition. +The patch will be performed only if the ETag of the job on the server matches this value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKey +Key encryption key for the job. +To construct, see NOTES section for KEYENCRYPTIONKEY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IKeyEncryptionKey +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the job Resource within the specified resource group. +job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferencePreferredDataCenterRegion +Preferred data center region. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnToCustomerPackageDetailCarrierAccountNumber +Carrier Account Number of customer for customer disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnToCustomerPackageDetailCarrierName +Name of the carrier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnToCustomerPackageDetailTrackingId +Tracking Id of shipment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReverseShippingDetail +Shipping address where customer wishes to receive the device. +To construct, see NOTES section for REVERSESHIPPINGDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IShippingAddress +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReverseTransportPreferredShipmentType +Indicates Shipment Logistics type that the customer preferred. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.TransportShipmentTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingAddress +Shipping address of the customer. +To construct, see NOTES section for SHIPPINGADDRESS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IShippingAddress +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountAccessTierPreference +Preferences related to the Access Tier of storage accounts. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.StorageAccountAccessTier[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The list of key value pairs that describe the resource. +These tags can be used in viewing and grouping this resource (across resource groups). + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportPreferredShipmentType +Indicates Shipment Logistics type that the customer preferred. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBox.Support.TransportShipmentTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +User Assigned Identities + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBox.Models.Api20221201.IJobResource + +## 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. + + +`CONTACTDETAIL <IContactDetails>`: Contact details for notification and shipping. + - `ContactName <String>`: Contact name of the person. + - `EmailList <String[]>`: List of Email-ids to be notified about job progress. + - `Phone <String>`: Phone number of the contact person. + - `[Mobile <String>]`: Mobile number of the contact person. + - `[NotificationPreference <INotificationPreference[]>]`: Notification preference for a job stage. + - `SendNotification <Boolean>`: Notification is required or not. + - `StageName <NotificationStageName>`: Name of the stage. + - `[PhoneExtension <String>]`: Phone extension number of the contact person. + +`KEYENCRYPTIONKEY <IKeyEncryptionKey>`: Key encryption key for the job. + - `KekType <KekType>`: Type of encryption key used for key encryption. + - `[IdentityProperty <IIdentityProperties>]`: Managed identity properties used for key encryption. + - `[Type <String>]`: Managed service identity type. + - `[UserAssignedResourceId <String>]`: Arm resource id for user assigned identity to be used to fetch MSI token. + - `[KekUrl <String>]`: Key encryption key. It is required in case of Customer managed KekType. + - `[KekVaultResourceId <String>]`: Kek vault resource id. It is required in case of Customer managed KekType. + +`REVERSESHIPPINGDETAIL <IShippingAddress>`: Shipping address where customer wishes to receive the device. + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[SkipAddressValidation <Boolean?>]`: Flag to indicate if customer has chosen to skip default address validation + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[TaxIdentificationNumber <String>]`: Tax Identification Number + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +`SHIPPINGADDRESS <IShippingAddress>`: Shipping address of the customer. + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[SkipAddressValidation <Boolean?>]`: Flag to indicate if customer has chosen to skip default address validation + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[TaxIdentificationNumber <String>]`: Tax Identification Number + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataBoxEdge/Az.DataBoxEdge.md b/azps-10.1.0/Az.DataBoxEdge/Az.DataBoxEdge.md new file mode 100644 index 0000000000..8758e78d49 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Az.DataBoxEdge.md @@ -0,0 +1,133 @@ +--- +Module Name: Az.DataBoxEdge +Module Guid: 3C11EF12-C79F-45FE-ACDF-A2C784D99C97 +Download Help Link: +Help Version: +Locale: +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Az.DataBoxEdge.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Az.DataBoxEdge.md +--- + +# Az.DataBoxEdge Module +## Description +Module to create a device and perform operations on DataBoxEdge devices + +## Az.DataBoxEdge Cmdlets +### [Get-AzDataBoxEdgeBandwidthSchedule](Get-AzDataBoxEdgeBandwidthSchedule.md) +Gets the information about the Bandwidth schedules + +### [Get-AzDataBoxEdgeDevice](Get-AzDataBoxEdgeDevice.md) +Gets the information on available Data Box Edge devices. + +### [Get-AzDataBoxEdgeJob](Get-AzDataBoxEdgeJob.md) +Gets the jobs scheduled on a device. + +### [Get-AzDataBoxEdgeOrder](Get-AzDataBoxEdgeOrder.md) +Get the order details for a device + +### [Get-AzDataBoxEdgeRole](Get-AzDataBoxEdgeRole.md) +Fetches the available roles for a device. + +### [Get-AzDataBoxEdgeShare](Get-AzDataBoxEdgeShare.md) +Gets the available shares for a device. + +### [Get-AzDataBoxEdgeStorageAccount](Get-AzDataBoxEdgeStorageAccount.md) +Gets the Edge Storage accounts on the device. + +### [Get-AzDataBoxEdgeStorageAccountCredential](Get-AzDataBoxEdgeStorageAccountCredential.md) +Gets the storage account credentials corresponding to the storage account on the device. + +### [Get-AzDataBoxEdgeStorageContainer](Get-AzDataBoxEdgeStorageContainer.md) +Gets the containers for an Edge Storage account on a device. + +### [Get-AzDataBoxEdgeTrigger](Get-AzDataBoxEdgeTrigger.md) +Get the Triggers configured on a device + + +### [Get-AzDataBoxEdgeUser](Get-AzDataBoxEdgeUser.md) +Gets the configured users for a device. + +### [Invoke-AzDataBoxEdgeDevice](Invoke-AzDataBoxEdgeDevice.md) +Invokes specific actions on the device. + +### [Invoke-AzDataBoxEdgeShare](Invoke-AzDataBoxEdgeShare.md) +Invokes specific actions on a share. + +### [Invoke-AzDataBoxEdgeStorageContainer](Invoke-AzDataBoxEdgeStorageContainer.md) +Invokes specific actions on a storage container + +### [New-AzDataBoxEdgeBandwidthSchedule](New-AzDataBoxEdgeBandwidthSchedule.md) +Creates a new Bandwidth schedule + +### [New-AzDataBoxEdgeDevice](New-AzDataBoxEdgeDevice.md) +Configures a new Data Box Edge device + +### [New-AzDataBoxEdgeOrder](New-AzDataBoxEdgeOrder.md) +Creates a new order for a device. + +### [New-AzDataBoxEdgeRole](New-AzDataBoxEdgeRole.md) +Creates a new Role for a device + +### [New-AzDataBoxEdgeShare](New-AzDataBoxEdgeShare.md) +Creates a new share on the device. + +### [New-AzDataBoxEdgeStorageAccount](New-AzDataBoxEdgeStorageAccount.md) +Creates a new Edge Storage account in the device. + +### [New-AzDataBoxEdgeStorageAccountCredential](New-AzDataBoxEdgeStorageAccountCredential.md) +Creates new credentials for an edge storage account on the device. + +### [New-AzDataBoxEdgeStorageContainer](New-AzDataBoxEdgeStorageContainer.md) +Creates a new storage container in the Edge Storage account on the device. + +### [New-AzDataBoxEdgeTrigger](New-AzDataBoxEdgeTrigger.md) +Configures a trigger on the device. + +### [New-AzDataBoxEdgeUser](New-AzDataBoxEdgeUser.md) +Creates a new user for the device. + +### [Remove-AzDataBoxEdgeBandwidthSchedule](Remove-AzDataBoxEdgeBandwidthSchedule.md) +Removes a Bandwidth Schedule. + +### [Remove-AzDataBoxEdgeDevice](Remove-AzDataBoxEdgeDevice.md) +Removes a Data Box Edge device. + +### [Remove-AzDataBoxEdgeOrder](Remove-AzDataBoxEdgeOrder.md) +Removes the order for a device. + +### [Remove-AzDataBoxEdgeRole](Remove-AzDataBoxEdgeRole.md) +Removes the associated IoT role for a device. + +### [Remove-AzDataBoxEdgeShare](Remove-AzDataBoxEdgeShare.md) +Removes a share from the device. + +### [Remove-AzDataBoxEdgeStorageAccount](Remove-AzDataBoxEdgeStorageAccount.md) +Removes the Edge Storage account for a device. + +### [Remove-AzDataBoxEdgeStorageAccountCredential](Remove-AzDataBoxEdgeStorageAccountCredential.md) +Removes a storage account credential for a device. + +### [Remove-AzDataBoxEdgeStorageContainer](Remove-AzDataBoxEdgeStorageContainer.md) +Removes a storage container for the Edge Storage account on a device. + +### [Remove-AzDataBoxEdgeTrigger](Remove-AzDataBoxEdgeTrigger.md) +Removes an existing trigger on the device. + +### [Remove-AzDataBoxEdgeUser](Remove-AzDataBoxEdgeUser.md) +Removes a user on a device. + +### [Set-AzDataBoxEdgeBandwidthSchedule](Set-AzDataBoxEdgeBandwidthSchedule.md) +Updates a Bandwidth Schedule. + +### [Set-AzDataBoxEdgeRole](Set-AzDataBoxEdgeRole.md) +Updates a Role for a device + +### [Set-AzDataBoxEdgeShare](Set-AzDataBoxEdgeShare.md) +Updates the share for a device. + +### [Set-AzDataBoxEdgeStorageAccountCredential](Set-AzDataBoxEdgeStorageAccountCredential.md) +Sets the storage account credential for a device. + +### [Set-AzDataBoxEdgeUser](Set-AzDataBoxEdgeUser.md) +Sets a new password for a user on the device. + diff --git a/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeBandwidthSchedule.md b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeBandwidthSchedule.md new file mode 100644 index 0000000000..a24dec2515 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeBandwidthSchedule.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/get-azdataboxedgebandwidthschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeBandwidthSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeBandwidthSchedule.md +--- + +# Get-AzDataBoxEdgeBandwidthSchedule + +## SYNOPSIS +Gets the information about the Bandwidth schedules + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzDataBoxEdgeBandwidthSchedule [-ResourceGroupName] <String> [-DeviceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzDataBoxEdgeBandwidthSchedule -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzDataBoxEdgeBandwidthSchedule [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzDataBoxEdgeBandwidthSchedule [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] + -DeviceObject <PSDataBoxEdgeDevice> [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataBoxEdgeBandwidthSchedule** cmdlet gets the information about the Bandwidth Schedules. You can specify the Name of a Schedule along with the Resource Group name and Device name to get the information about a specific Bandwidth schedule + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataBoxEdgeBandwidthSchedule -ResourceGroupname resource-group-name -DeviceName device-name +``` + +```output +Name DaysOfWeek RateInMbps StartTime StopTime +---- ---------- ---------- --------- -------- +schedule-name Sunday,Saturday unlimited 13:00:00 14:00:00 +Schedule-1 Tuesday,Friday unlimited 00:00:00 23:59:00 +Schedule-2 Thursday 50 00:01:00 05:00:00 +``` + +### Example 2 +```powershell +Get-AzDataBoxEdgeBandwidthSchedule -ResourceGroupname resource-group-name -DeviceName device-name -Name Schedule-1 +``` + +```output +Name DaysOfWeek RateInMbps StartTime StopTime +---- ---------- ---------- --------- -------- +Schedule-1 Sunday,Saturday unlimited 13:00:00 14:00:00 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceObject +Please provide corresponding device object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeBandWidthSchedule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeDevice.md b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeDevice.md new file mode 100644 index 0000000000..e76affcc73 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeDevice.md @@ -0,0 +1,277 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/get-azdataboxedgedevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeDevice.md +--- + +# Get-AzDataBoxEdgeDevice + +## SYNOPSIS +Gets the information on available Data Box Edge devices. + +## SYNTAX + +### ListByParameterSet (Default) +``` +Get-AzDataBoxEdgeDevice [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzDataBoxEdgeDevice -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetExtendedInfoByResourceIdParameterSet +``` +Get-AzDataBoxEdgeDevice -ResourceId <String> [-ExtendedInfo] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetNetworkSettingByResourceIdParameterSet +``` +Get-AzDataBoxEdgeDevice -ResourceId <String> [-NetworkSetting] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetSummaryUpdateByResourceIdParameterSet +``` +Get-AzDataBoxEdgeDevice -ResourceId <String> [-UpdateSummary] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetAlertByResourceIdParameterSet +``` +Get-AzDataBoxEdgeDevice -ResourceId <String> [-Alert] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzDataBoxEdgeDevice [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetSummaryUpdateParameterSet +``` +Get-AzDataBoxEdgeDevice [-ResourceGroupName] <String> [-Name] <String> [-UpdateSummary] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetNetworkSettingParameterSet +``` +Get-AzDataBoxEdgeDevice [-ResourceGroupName] <String> [-Name] <String> [-NetworkSetting] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetExtendedInfoParameterSet +``` +Get-AzDataBoxEdgeDevice [-ResourceGroupName] <String> [-Name] <String> [-ExtendedInfo] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetAlertParameterSet +``` +Get-AzDataBoxEdgeDevice [-ResourceGroupName] <String> [-Name] <String> [-Alert] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataBoxEdgeDevice** cmdlet gets the information about the available Data Box Edge Devices. You can specify the Name of the device along with the Resource Group Name to get the information on a specific device. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataBoxEdgeDevice +``` + +```output +Name ResourceGroupName Model Location +---- ----------------- ----- -------- +deviceNameOne resourceGroupName1 Edge eastus +deviceNameTwo resourceGroupName2 Edge westus +deviceNameThree resourceGroupName3 Gateway eastus +``` + +### Example 2 +```powershell +Get-AzDataBoxEdgeDevice -ResourceId /subscriptions/subscriptionId/resourcegroups/resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/deviceName +``` + +```output +Name ResourceGroupName Model Location +---- ----------------- ----- -------- +deviceName resourceGroupName Edge eastus +``` + +### Example 3 +```powershell +Get-AzDataBoxEdgeDevice -ResourceGroupName resourceGroupName -Name deviceName +``` + +```output +Name ResourceGroupName Model Location +---- ----------------- ----- -------- +deviceName resourceGroupName Edge eastus +``` + +## PARAMETERS + +### -Alert +Fetch the alerts on the data box edge/gateway device + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetAlertByResourceIdParameterSet, GetAlertParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedInfo +Gets additional information for the specified Data Box Edge/Data Box Gateway device + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetExtendedInfoByResourceIdParameterSet, GetExtendedInfoParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Device Name + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetSummaryUpdateParameterSet, GetNetworkSettingParameterSet, GetExtendedInfoParameterSet, GetAlertParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSetting +Gets the network settings of the specified Data Box Edge/Data Box Gateway device + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetNetworkSettingByResourceIdParameterSet, GetNetworkSettingParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ListByParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetSummaryUpdateParameterSet, GetNetworkSettingParameterSet, GetExtendedInfoParameterSet, GetAlertParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet, GetExtendedInfoByResourceIdParameterSet, GetNetworkSettingByResourceIdParameterSet, GetSummaryUpdateByResourceIdParameterSet, GetAlertByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateSummary +Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetSummaryUpdateByResourceIdParameterSet, GetSummaryUpdateParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeNetworkAdapter + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDeviceExtendedInfo + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeUpdateSummary + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeAlert + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeJob.md b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeJob.md new file mode 100644 index 0000000000..9d0850b396 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeJob.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/get-azdataboxedgejob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeJob.md +--- + +# Get-AzDataBoxEdgeJob + +## SYNOPSIS +Gets the jobs scheduled on a device. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzDataBoxEdgeJob [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdObject +``` +Get-AzDataBoxEdgeJob -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzDataBoxEdgeJob [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + -DeviceObject <PSDataBoxEdgeDevice> [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataBoxEdgeJob** cmdlet gets the active jobs on a Data Box Edge device. You can mention the Name parameter to get details of a specific job. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataBoxEdgeJob -ResourceGroupName resourceGroupName -DeviceName deviceName -Name 1f2d8f1b-9104-49c3-b780-76db9abe7bd1 +``` + +```output +Name Device-Name status +------------------ ------------- ------- +1f2d8f1b-9104-49c3-b780-76db9abe7bd1 deviceName Scheduled +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Name of the device + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceObject +Please provide corresponding device object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Job, Generally a GUID + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeOrder.md b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeOrder.md new file mode 100644 index 0000000000..8b04ddf6b3 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeOrder.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/get-azdataboxedgeorder +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeOrder.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeOrder.md +--- + +# Get-AzDataBoxEdgeOrder + +## SYNOPSIS +Get the order details for a device + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzDataBoxEdgeOrder [-ResourceGroupName] <String> [-DeviceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByDeviceObjectParameterSet +``` +Get-AzDataBoxEdgeOrder -DeviceObject <PSDataBoxEdgeDevice> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzDataBoxEdgeOrder -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataBoxEdgeOrder** cmdlet gets the order details for a Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataBoxEdgeOrder -ResourceGroupName resourceGroupName -DeviceName deviceName +``` + +```output +DeviceName ResourceGroupName Status UpdatedDatetime +---------- ----------------- ------ --------------- +deviceName resourceGroupName Untracked 01-Jan-01 12:00:00 AM +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DeviceObject +Please provide corresponding device object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice +Parameter Sets: GetByDeviceObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeOrder + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeRole.md b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeRole.md new file mode 100644 index 0000000000..0689927eb6 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeRole.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/get-azdataboxedgerole +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeRole.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeRole.md +--- + +# Get-AzDataBoxEdgeRole + +## SYNOPSIS +Fetches the available roles for a device. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzDataBoxEdgeRole [-ResourceGroupName] <String> [-DeviceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzDataBoxEdgeRole -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzDataBoxEdgeRole [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzDataBoxEdgeRole [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] + -DeviceObject <PSDataBoxEdgeDevice> [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataBoxEdgeRole** cmdlet fetches the available IoT roles for a Data Box Edge device. You can mention the Name parameter to get the details of a specific IoT role. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataBoxEdgeRole -ResourceGroupName resourceGroupName -DeviceName deviceName +``` + +```output +Name IoTHostHub Platform Status IotEdgeDeviceId IotDeviceId ResourceGroupName +---- ---------- -------- ------ --------------- ----------- ----------------- +iotrole ehub.azure-devices.net Linux Enabled iotEdgeDeviceUd iotDevice resourceGroupName +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceObject +Please provide corresponding device object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeRole + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeShare.md b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeShare.md new file mode 100644 index 0000000000..0b58c43b86 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeShare.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/get-azdataboxedgeshare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeShare.md +--- + +# Get-AzDataBoxEdgeShare + +## SYNOPSIS +Gets the available shares for a device. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzDataBoxEdgeShare [-ResourceGroupName] <String> [-DeviceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzDataBoxEdgeShare -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzDataBoxEdgeShare [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzDataBoxEdgeShare [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] + -DeviceObject <PSDataBoxEdgeDevice> [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataBoxEdgeShare** cmdlet gets the available shares for a Data Box Edge device. If Name is provided this will get the share by Name. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataBoxEdgeShare -ResourceGroupName resourceGroupName -DeviceName deviceName +``` + +```output +Name Type DataPolicy DataFormat ResourceGroupName StorageAccountName +---------- ---------- ---------------- ---------------- --------------------- ------------------- +share-1 SMB Cloud PageBlob resourceGroupName storageAccountName +share-2 SMB Cloud PageBlob resourceGroupName storageAccountName +share-3 SMB Cloud PageBlob resourceGroupName storageAccountName +share-4 SMB Cloud PageBlob resourceGroupName storageAccountName +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceObject +Please provide corresponding device object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeShare + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeStorageAccount.md b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeStorageAccount.md new file mode 100644 index 0000000000..8851b9c2d4 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeStorageAccount.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/get-azdataboxedgestorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeStorageAccount.md +--- + +# Get-AzDataBoxEdgeStorageAccount + +## SYNOPSIS +Gets the Edge Storage accounts on the device. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzDataBoxEdgeStorageAccount [-ResourceGroupName] <String> [-DeviceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzDataBoxEdgeStorageAccount -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzDataBoxEdgeStorageAccount [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzDataBoxEdgeStorageAccount [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] + -DeviceObject <PSDataBoxEdgeDevice> [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataBoxEdgeStorageAccount** cmdlet gets the Edge Storage accounts available on a Data Box Edge device. You can specify the Name as a parameter in the cmdlet to get the information of a specific Edge Storage account. + +## EXAMPLES + +### Example 2 +```powershell +Get-AzDataBoxEdgeStorageAccount -ResourceGroupName rgpName -DeviceName db-edge -Name edgestoragegacount1 +``` + +```output +Name ContainerCount Status BlobEndpoint CloudStorageAccountName DeviceName ResourceGroupName +---- -------------- ----- ------------ ----------------------- ---------- ----------------- +edgestoragegacount1 2 OK https://edgestoragegacount1.blob.db-edge.microsoftdatabox.com/ cloudstorageaccount1 db-edge rgpName +``` + +### Example 2 +```powershell +Get-AzDataBoxEdgeStorageAccount -ResourceGroupName rgpName -DeviceName db-edge +``` + +```output +Name ContainerCount Status BlobEndpoint CloudStorageAccountName DeviceName ResourceGroupName +---- -------------- ----- ------------ ----------------------- ---------- ----------------- +edgestoragegacount1 2 OK https://edgestoragegacount1.blob.db-edge.microsoftdatabox.com/ cloudstorageaccount1 db-edge rgpName +edgestoragegacount2 0 OK https://edgestoragegacount2.blob.db-edge.microsoftdatabox.com/ cloudstorageaccount2 db-edge rgpName +``` + +### Example 3 +```powershell +Get-AzDataBoxEdgeDevice -ResourceGroupName rgpName -Name db-edge | Get-AzDataBoxEdgeStorageAccount +``` + +```output +Name ContainerCount Status BlobEndpoint CloudStorageAccountName DeviceName ResourceGroupName +---- -------------- ----- ------------ ----------------------- ---------- ----------------- +edgestoragegacount1 2 OK https://edgestoragegacount1.blob.db-edge.microsoftdatabox.com/ cloudstorageaccount1 db-edge rgpName +edgestoragegacount2 0 OK https://edgestoragegacount2.blob.db-edge.microsoftdatabox.com/ cloudstorageaccount2 db-edge rgpName +``` + +### Example 4 +```powershell +Get-AzDataBoxEdgeStorageAccount -DeviceObject $dbEdge +``` + +```output +Name ContainerCount Status BlobEndpoint CloudStorageAccountName DeviceName ResourceGroupName +---- -------------- ----- ------------ ----------------------- ---------- ----------------- +edgestoragegacount1 2 OK https://edgestoragegacount1.blob.db-edge.microsoftdatabox.com/ cloudstorageaccount1 db-edge rgpName +edgestoragegacount2 0 OK https://edgestoragegacount2.blob.db-edge.microsoftdatabox.com/ cloudstorageaccount2 db-edge rgpName +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DeviceObject +Please provide corresponding device object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: EdgeStorageAccountName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByParentObjectParameterSet +Aliases: EdgeStorageAccountName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccount + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeStorageAccountCredential.md b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeStorageAccountCredential.md new file mode 100644 index 0000000000..9f43d258fb --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeStorageAccountCredential.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/get-azdataboxedgestorageaccountcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeStorageAccountCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeStorageAccountCredential.md +--- + +# Get-AzDataBoxEdgeStorageAccountCredential + +## SYNOPSIS +Gets the storage account credentials corresponding to the storage account on the device. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzDataBoxEdgeStorageAccountCredential [-ResourceGroupName] <String> [-DeviceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzDataBoxEdgeStorageAccountCredential -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzDataBoxEdgeStorageAccountCredential [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzDataBoxEdgeStorageAccountCredential [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] + -DeviceObject <PSDataBoxEdgeDevice> [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataBoxEdgeStorageAccountCredential** cmdlet gets the storage account credentials for the corresponding storage account on the Data Box Edge device. You can specify Name, Resource Group Name and Device Name parameters to get information about a specific storage account credential. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataBoxEdgeStorageAccountCredential -ResourceGroupName resourceGroupName -DeviceName deviceName +``` + +```output +Name StorageAccount SslStatus ResourceGroupName +----------------------------- ---------------------- ---------- --------------------- +storageAccountCredentialName StorageAccountName Enabled resourceGroupName +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceObject +Please provide corresponding device object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the storage account to be used + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccountCredential + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeStorageContainer.md b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeStorageContainer.md new file mode 100644 index 0000000000..64839910bd --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeStorageContainer.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/get-azdataboxedgestoragecontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeStorageContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeStorageContainer.md +--- + +# Get-AzDataBoxEdgeStorageContainer + +## SYNOPSIS +Gets the containers for an Edge Storage account on a device. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzDataBoxEdgeStorageContainer [-ResourceGroupName] <String> [-DeviceName] <String> + [-EdgeStorageAccountName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzDataBoxEdgeStorageContainer [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzDataBoxEdgeStorageContainer [-ResourceGroupName] <String> [-DeviceName] <String> + [-EdgeStorageAccountName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzDataBoxEdgeStorageContainer [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] + -EdgeStorageAccountObject <PSDataBoxEdgeStorageAccount> [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataBoxEdgeStorageContainer** cmdlet gets the storage container for an Edge Storage account on a Data Box Edge device. You can specify the name as a parameter in the cmdlet to fetch the details of a specific storage container. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataBoxEdgeStorageContainer -ResourceGroupName resourceGroupName -DeviceName db-edge -EdgeStorageAccountName edgestorageaccount1 -Name container1 +``` + +```output +Name DataFormat Status EdgeStorageAccountName DeviceName ResourceGroupName +---- ---------- ------ ---------------------- ---------- ----------------- +container1 BlockBlob Ok edgestorageaccount1 db-edge resourceGroupName +``` + +### Example 2 +```powershell +Get-AzDataBoxEdgeStorageContainer -ResourceGroupName resourceGroupName -DeviceName db-edge -EdgeStorageAccountName edgestorageaccount1 +``` + +```output +Name DataFormat Status EdgeStorageAccountName DeviceName ResourceGroupName +---- ---------- ------ ---------------------- ---------- ----------------- +container1 BlockBlob Ok edgestorageaccount1 db-edge resourceGroupName +container2 BlockBlob Ok edgestorageaccount1 db-edge resourceGroupName +``` + +### Example 3 +```powershell +Get-AzDataBoxEdgeDevice -ResourceGroupName resourceGroupName -Name db-edge | Get-AzDataBoxEdgeStorageAccount | Get-AzDataBoxEdgeStorageContainer +``` + +```output +Name DataFormat Status EdgeStorageAccountName DeviceName ResourceGroupName +---- ---------- ------ ---------------------- ---------- ----------------- +container1 BlockBlob Ok edgestorageaccount1 db-edge resourceGroupName +container2 BlockBlob Ok edgestorageaccount1 db-edge resourceGroupName +container4 BlockBlob Ok edgestorageaccount2 db-edge resourceGroupName +container5 BlockBlob Ok edgestorageaccount2 db-edge resourceGroupName +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EdgeStorageAccountName +Provide existing EdgeStorageAccount's Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EdgeStorageAccountObject +Provide existing EdgeStorageAccount Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccount +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the EdgeStorageContainer + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: EdgeStorageContainerName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByParentObjectParameterSet +Aliases: EdgeStorageContainerName + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccount + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageContainer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeTrigger.md b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeTrigger.md new file mode 100644 index 0000000000..dae76389ed --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeTrigger.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/get-azdataboxedgetrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeTrigger.md +--- + +# Get-AzDataBoxEdgeTrigger + +## SYNOPSIS +Get the Triggers configured on a device + + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzDataBoxEdgeTrigger [-ResourceGroupName] <String> [-DeviceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzDataBoxEdgeTrigger -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzDataBoxEdgeTrigger [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzDataBoxEdgeTrigger [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] + -DeviceObject <PSDataBoxEdgeDevice> [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataBoxEdgeTriger** cmdlet gets the triggers for a device. You can specify the name as a parameter in the cmdlet to fetch the details of a specific specific Triggers + + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataBoxEdgeTrigger -ResourceGroupName resourceGroupName -DeviceName deviceName +``` + +```output +Name Kind +---- ---- +triggerName PeriodicTimerEvent +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceObject +Please provide corresponding device object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeTrigger + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeUser.md b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeUser.md new file mode 100644 index 0000000000..fb752c41c6 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Get-AzDataBoxEdgeUser.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/get-azdataboxedgeuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Get-AzDataBoxEdgeUser.md +--- + +# Get-AzDataBoxEdgeUser + +## SYNOPSIS +Gets the configured users for a device. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzDataBoxEdgeUser [-ResourceGroupName] <String> [-DeviceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzDataBoxEdgeUser -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzDataBoxEdgeUser [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzDataBoxEdgeUser [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] + -DeviceObject <PSDataBoxEdgeDevice> [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataBoxEdgeUser** cmdlet lists the users configured for a Data Box Edge device. You can mention the Name in parameters to get details about a specific user. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataBoxEdgeUser -ResourceGroupName resourceGroupName -DeviceName deviceName +``` + +```output +User name Type ResourceGroupName DeviceName +--------- ---- ----------------- ---------- +deviceName Share resourceGroupName deviceName +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceObject +Please provide corresponding device object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Username + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ListParameterSet, GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeUser + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Invoke-AzDataBoxEdgeDevice.md b/azps-10.1.0/Az.DataBoxEdge/Invoke-AzDataBoxEdgeDevice.md new file mode 100644 index 0000000000..4967ef006a --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Invoke-AzDataBoxEdgeDevice.md @@ -0,0 +1,286 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/invoke-azdataboxedgedevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Invoke-AzDataBoxEdgeDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Invoke-AzDataBoxEdgeDevice.md +--- + +# Invoke-AzDataBoxEdgeDevice + +## SYNOPSIS +Invokes specific actions on the device. + +## SYNTAX + +### InvokeScanForUpdateParameterSet (Default) +``` +Invoke-AzDataBoxEdgeDevice [-ResourceGroupName] <String> [-Name] <String> [-ScanForUpdate] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeFetchUpdatesByResourceIdParameterSet +``` +Invoke-AzDataBoxEdgeDevice -ResourceId <String> [-FetchUpdate] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeInstallUpdatesByResourceIdParameterSet +``` +Invoke-AzDataBoxEdgeDevice -ResourceId <String> [-InstallUpdate] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeScanForUpdateByResourceIdParameterSet +``` +Invoke-AzDataBoxEdgeDevice -ResourceId <String> [-ScanForUpdate] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeInstallUpdateParameterSet +``` +Invoke-AzDataBoxEdgeDevice [-ResourceGroupName] <String> [-Name] <String> [-InstallUpdate] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeFetchUpdateParameterSet +``` +Invoke-AzDataBoxEdgeDevice [-ResourceGroupName] <String> [-Name] <String> [-FetchUpdate] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeFetchUpdatesByDeviceObjectParameterSet +``` +Invoke-AzDataBoxEdgeDevice -DeviceObject <PSDataBoxEdgeDevice> [-FetchUpdate] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeScanForUpdateByDeviceObjectParameterSet +``` +Invoke-AzDataBoxEdgeDevice -DeviceObject <PSDataBoxEdgeDevice> [-ScanForUpdate] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeInstallUpdatesByDeviceObjectParameterSet +``` +Invoke-AzDataBoxEdgeDevice -DeviceObject <PSDataBoxEdgeDevice> [-InstallUpdate] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzDataBoxEdgeDevice** cmdlet invokes actions to scan, download and install the updates on the Data Box Edge device. An automatic scan runs on the device daily, you can trigger the scan explicitly by running this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzDataBoxEdgeDevice -ResourceGroupName resourceGroupName -Name deviceName -ScanForUpdate +``` + +### Example 2 +```powershell +Invoke-AzDataBoxEdgeDevice -ResourceGroupName resourceGroupName -Name deviceName -FetchUpdate +``` + +### Example 3 +```powershell +Invoke-AzDataBoxEdgeDevice -ResourceGroupName resourceGroupName -Name deviceName -InstallUpdate +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceObject +Please provide corresponding device object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice +Parameter Sets: InvokeFetchUpdatesByDeviceObjectParameterSet, InvokeScanForUpdateByDeviceObjectParameterSet, InvokeInstallUpdatesByDeviceObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FetchUpdate +Downloads the updates on a data box edge/gateway device + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: InvokeFetchUpdatesByResourceIdParameterSet, InvokeFetchUpdateParameterSet, InvokeFetchUpdatesByDeviceObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstallUpdate +Installs the updates on the data box edge/gateway device + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: InvokeInstallUpdatesByResourceIdParameterSet, InvokeInstallUpdateParameterSet, InvokeInstallUpdatesByDeviceObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Device Name + +```yaml +Type: System.String +Parameter Sets: InvokeScanForUpdateParameterSet, InvokeInstallUpdateParameterSet, InvokeFetchUpdateParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +returns true if successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: InvokeScanForUpdateParameterSet, InvokeInstallUpdateParameterSet, InvokeFetchUpdateParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: InvokeFetchUpdatesByResourceIdParameterSet, InvokeInstallUpdatesByResourceIdParameterSet, InvokeScanForUpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanForUpdate +Scans for updates on a data box edge/gateway device. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: InvokeScanForUpdateParameterSet, InvokeScanForUpdateByResourceIdParameterSet, InvokeScanForUpdateByDeviceObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Invoke-AzDataBoxEdgeShare.md b/azps-10.1.0/Az.DataBoxEdge/Invoke-AzDataBoxEdgeShare.md new file mode 100644 index 0000000000..5506e089f6 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Invoke-AzDataBoxEdgeShare.md @@ -0,0 +1,237 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/invoke-azdataboxedgeshare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Invoke-AzDataBoxEdgeShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Invoke-AzDataBoxEdgeShare.md +--- + +# Invoke-AzDataBoxEdgeShare + +## SYNOPSIS +Invokes specific actions on a share. + +## SYNTAX + +### InvokeByNameParameterSet (Default) +``` +Invoke-AzDataBoxEdgeShare [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-RefreshData] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InvokeByResourceIdParameterSet +``` +Invoke-AzDataBoxEdgeShare -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-RefreshData] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeByInputObjectParameterSet +``` +Invoke-AzDataBoxEdgeShare [-AsJob] [-DefaultProfile <IAzureContextContainer>] -InputObject <PSDataBoxEdgeShare> + [-RefreshData] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzDataBoxEdgeShare** cmdlet invokes action to refresh data on a share on a Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzDataBoxEdgeShare -ResourceGroupName resourceGroupName -DeviceName deviceName -Name share1 -PassThru +``` + +```output +true +``` + +### Example 2 +```powershell +Invoke-AzDataBoxEdgeShare -ResourceGroupName resourceGroupName -DeviceName deviceName -Name share1 | Invoke-AzDataBoxEdgeShare +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: InvokeByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeShare +Parameter Sets: InvokeByInputObjectParameterSet +Aliases: EdgeShare + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: InvokeByNameParameterSet +Aliases: EdgeShareName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +returns true if successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RefreshData +Refresh Share Metadata with the data from the cloud + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: InvokeByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: InvokeByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeShare + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Invoke-AzDataBoxEdgeStorageContainer.md b/azps-10.1.0/Az.DataBoxEdge/Invoke-AzDataBoxEdgeStorageContainer.md new file mode 100644 index 0000000000..19aab4fd5c --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Invoke-AzDataBoxEdgeStorageContainer.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/invoke-azdataboxedgestoragecontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Invoke-AzDataBoxEdgeStorageContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Invoke-AzDataBoxEdgeStorageContainer.md +--- + +# Invoke-AzDataBoxEdgeStorageContainer + +## SYNOPSIS +Invokes specific actions on a storage container + +## SYNTAX + +### InvokeByNameParameterSet (Default) +``` +Invoke-AzDataBoxEdgeStorageContainer [-ResourceGroupName] <String> [-DeviceName] <String> + [-EdgeStorageAccountName] <String> [-Name] <String> [-RefreshData] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeByResourceIdParameterSet +``` +Invoke-AzDataBoxEdgeStorageContainer [-ResourceId] <String> [-RefreshData] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeByInputObjectParameterSet +``` +Invoke-AzDataBoxEdgeStorageContainer [-RefreshData] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + -InputObject <PSDataBoxEdgeStorageContainer> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzDataBoxEdgeStorageContainer** cmdlet invokes actions to refresh the data on a storage container on a Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzDataBoxEdgeStorageContainer -ResourceGroupName resourceGroupName -DeviceName deviceName -EdgeStorageAccountName edgestorageaccount1 -Name container1 -PassThru +``` + +```output +true +``` + +### Example 2 +```powershell +Get-AzDataBoxEdgeStorageContainer -ResourceGroupName resourceGroupName -DeviceName deviceName -EdgeStorageAccountName edgestorageaccount1 -Name container1 | Invoke-AzDataBoxEdgeStorageContainer +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: InvokeByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EdgeStorageAccountName +Resource Name + +```yaml +Type: System.String +Parameter Sets: InvokeByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Provide existing EdgeStorageAccount Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageContainer +Parameter Sets: InvokeByInputObjectParameterSet +Aliases: EdgeContainer + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: InvokeByNameParameterSet +Aliases: EdgeContainerName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +returns true if successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RefreshData +Refresh Container Metadata with the data from the cloud + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: InvokeByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: InvokeByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageContainer + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageContainer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeBandwidthSchedule.md b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeBandwidthSchedule.md new file mode 100644 index 0000000000..2bf37045e8 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeBandwidthSchedule.md @@ -0,0 +1,253 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/new-azdataboxedgebandwidthschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeBandwidthSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeBandwidthSchedule.md +--- + +# New-AzDataBoxEdgeBandwidthSchedule + +## SYNOPSIS +Creates a new Bandwidth schedule + +## SYNTAX + +### BandwidthParameterSet (Default) +``` +New-AzDataBoxEdgeBandwidthSchedule [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + -StartTime <String> -StopTime <String> -DaysOfWeek <String[]> -Bandwidth <Int32> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UnlimitedBandwidthParameterSet +``` +New-AzDataBoxEdgeBandwidthSchedule [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + -StartTime <String> -StopTime <String> -DaysOfWeek <String[]> -UnlimitedBandwidth <Boolean> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataBoxEdgeBandwidthSchedule** cmdlet creates a new Bandwidth Schedule for a Data Box Edge device to help manage the Bandwidth usage. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataBoxEdgeBandwidthSchedule -DaysOfWeek Sunday,Tuesday,Saturday -ResourceGroupName resourceGroupName -DeviceName deviceName -Name bandwidthSchedule -StartTime 11:00 -StopTime 12:00 -Bandwidth 30 +``` + +```output +Name DaysOfWeek RateInMbps StartTime StopTime +---- ---------- ---------- --------- -------- +bandwidthSchedule Sunday, Tuesday, Saturday 30 11:00:00 12:00:00 +``` + +### Example 2 +```powershell +New-AzDataBoxEdgeBandwidthSchedule -DaysOfWeek Sunday,Tuesday,Saturday -ResourceGroupName resourceGroupName -DeviceName deviceName -Name bandwidthScheduleUnlimited -StartTime 11:00 -StopTime 12:00 -UnlimitedBandwidth $ture +``` + +```output +Name DaysOfWeek RateInMbps StartTime StopTime +---------------- ---------------------- ----------- ----------- --------- +bandwidthScheduleUnlimited Sunday,Tuesday,Saturday unlimited 11:00:00 12:00:00 +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Bandwidth +Bandwidth in Mbps + +```yaml +Type: System.Int32 +Parameter Sets: BandwidthParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaysOfWeek +Scheduled DaysOfWeek + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Schedule Start Time + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StopTime +Schedule Stop Time + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnlimitedBandwidth +Will Set Unlimited Bandwidth, if set to false will set default value as 20 Mbps + +```yaml +Type: System.Boolean +Parameter Sets: UnlimitedBandwidthParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeBandWidthSchedule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeDevice.md b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeDevice.md new file mode 100644 index 0000000000..df10dc068c --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeDevice.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/new-azdataboxedgedevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeDevice.md +--- + +# New-AzDataBoxEdgeDevice + +## SYNOPSIS +Configures a new Data Box Edge device + +## SYNTAX + +``` +New-AzDataBoxEdgeDevice [-ResourceGroupName] <String> [-Name] <String> -Location <String> -Sku <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataBoxEdgeDevice** cmdlet configures a new Data Box Edge device + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataBoxEdgeDevice -ResourceGroupName resourceGroupName -Name deviceName -Location eastus -Sku Edge +``` + +```output +Name ResourceGroupName Model Location +---- ----------------- ----- -------- +deviceName resourceGroupName Edge eastus +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the device + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +Available Skus are Edge, Gateway + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeOrder.md b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeOrder.md new file mode 100644 index 0000000000..1d9ac35b8d --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeOrder.md @@ -0,0 +1,310 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/new-azdataboxedgeorder +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeOrder.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeOrder.md +--- + +# New-AzDataBoxEdgeOrder + +## SYNOPSIS +Creates a new order for a device. + +## SYNTAX + +``` +New-AzDataBoxEdgeOrder [-ResourceGroupName] <String> [-DeviceName] <String> -ContactPerson <String> + -CompanyName <String> -Phone <String> -Email <String[]> -AddressLine1 <String> -PostalCode <String> + -City <String> -State <String> -Country <String> [-AddressLine2 <String>] [-AddressLine3 <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataBoxEdgeOrder** cmdlet creates a new order for a Data Box Edge device. A Data Box Edge device resource needs to be created first before creating an order. You can specify details like contact person, company name, email, address etc. as parameters for creating the order. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataBoxEdgeOrder -ResourceGroupName rg-name -DeviceName device-name -ContactPerson "John Mcclane" -CompanyName Microsoft -Phone 8004269400 -Email john@microsoft.com -AddressLine1 "Microsoft Corporation" -PostalCode 98052 -City Redmond -State WA -Country USA +``` + +```output +DeviceName ResourceGroupName Status UpdatedDatetime +---------- ----------------- ------ --------------- +deviceName resourceGroupName Untracked 01-Jan-01 12:00:00 AM +``` + +## PARAMETERS + +### -AddressLine1 +Address first line + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressLine2 +Address second line + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressLine3 +Address third line + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -City +Name of the City + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +Name of the company + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactPerson +Name of the contact person + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Country +Name of the Country + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Email +List of Emails to receive updates, Accepts max of 10 emails + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Phone +Phone number of the contact person + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostalCode +Postal Code of the Address + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Name of the State + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeOrder + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeRole.md b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeRole.md new file mode 100644 index 0000000000..b2c9cedeff --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeRole.md @@ -0,0 +1,352 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/new-azdataboxedgerole +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeRole.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeRole.md +--- + +# New-AzDataBoxEdgeRole + +## SYNOPSIS +Creates a new Role for a device + +## SYNTAX + +### ConnectionStringParameterSet (Default) +``` +New-AzDataBoxEdgeRole [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> [-ConnectionString] + -IotDeviceConnectionString <SecureString> -IotEdgeDeviceConnectionString <SecureString> + -EncryptionKey <SecureString> -Platform <String> -RoleStatus <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IotParameterSet +``` +New-AzDataBoxEdgeRole [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> [-DeviceProperty] + -IotDeviceId <String> -IotDeviceAccessKey <SecureString> -IotEdgeDeviceId <String> + -IotEdgeDeviceAccessKey <SecureString> -IotHostHub <String> -EncryptionKey <SecureString> -Platform <String> + -RoleStatus <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataBoxEdgeRole** cmdlet creates a new Role for a Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataBoxEdgeRole -ResourceGroupName resourceGroupName -DeviceName deviceName -Name iotrole -DeviceProperty ` + -IotDeviceId iotDeviceId -IotDeviceAccessKey iotAccessKey -IotEdgeDeviceId iotEdgeDeviceId -IotEdgeDeviceAccessKey iotEdgeDeviceAccessKey ` + -IotHostHub "ehub.azure-devices.net" -EncryptionKey @SecureString -Platform Linux -RoleStatus Enabled +``` + +```output +Name IoTHostHub Platform Status IotEdgeDeviceId IotDeviceId ResourceGroupName +---- ---------- -------- ------ --------------- ----------- ----------------- +iotrole ehub.azure-devices.net Linux Enabled iotEdgeDeviceId iotDeviceId resourceGroupName +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionString +To Provide Connection Strings + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ConnectionStringParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceProperty +To Provide Device Properties + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: IotParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKey +Encryption key of the Edge device + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotDeviceAccessKey +Iot Device Access Key + +```yaml +Type: System.Security.SecureString +Parameter Sets: IotParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotDeviceConnectionString +Please provide connection string of IOT Device + +```yaml +Type: System.Security.SecureString +Parameter Sets: ConnectionStringParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotDeviceId +Device Id of the Iot Device + +```yaml +Type: System.String +Parameter Sets: IotParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotEdgeDeviceAccessKey +Access key of the Iot Edge device + +```yaml +Type: System.Security.SecureString +Parameter Sets: IotParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotEdgeDeviceConnectionString +Please provide connection string of Edge Device + +```yaml +Type: System.Security.SecureString +Parameter Sets: ConnectionStringParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotEdgeDeviceId +Id of the Iot Edge Device + +```yaml +Type: System.String +Parameter Sets: IotParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHostHub +Hosthub address + +```yaml +Type: System.String +Parameter Sets: IotParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Platform +Provide the Platform, for ex: Linux + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleStatus +Provide the status enable/disable + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeRole + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeShare.md b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeShare.md new file mode 100644 index 0000000000..f16da5b711 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeShare.md @@ -0,0 +1,304 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/new-azdataboxedgeshare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeShare.md +--- + +# New-AzDataBoxEdgeShare + +## SYNOPSIS +Creates a new share on the device. + +## SYNTAX + +### SmbParameterSet (Default) +``` +New-AzDataBoxEdgeShare [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> [-SMB] + [-UserAccessRight <Hashtable[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CloudShareNfsParameterSet +``` +New-AzDataBoxEdgeShare [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-StorageAccountCredentialName] <String> [-CloudShare] -DataFormat <String> [-ContainerName <String>] [-NFS] + [-ClientAccessRight <Hashtable[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CloudShareSmbParameterSet +``` +New-AzDataBoxEdgeShare [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-StorageAccountCredentialName] <String> [-CloudShare] -DataFormat <String> [-ContainerName <String>] [-SMB] + [-UserAccessRight <Hashtable[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### NfsParameterSet +``` +New-AzDataBoxEdgeShare [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> [-NFS] + [-ClientAccessRight <Hashtable[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataBoxEdgeShare** cmdlet creates a new share on the Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataBoxEdgeShare -ResourceGroupName resourceGroupName -DeviceName deviceName -Name share-1 -SMB ` +-StorageAccountCredentialName storageCredentialName -DataFormat PageBlob +``` + +```output +Name Type DataPolicy DataFormat ResourceGroupName StorageAccountName +---------- ---------- ---------------- ---------------- --------------------- ------------------- +share-1 SMB Cloud PageBlob resourceGroupName storageAccountName +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientAccessRight +Read/Write Access for clientIds, For ex:@(@{"ClientId"="192.168.10.10";"AccessRight"="NoAccess"}, @{"ClientId"="192.168.10.11";"AccessRight"="ReadOnly"}) + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: CloudShareNfsParameterSet, NfsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudShare +Provide existing StorageAccountCredential's Resource Name + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CloudShareNfsParameterSet, CloudShareSmbParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Container name (Based on the data format specified, this represents the name of Azure Files/Pageblob/Block blob) + +```yaml +Type: System.String +Parameter Sets: CloudShareNfsParameterSet, CloudShareSmbParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFormat +Set Data Format ex: PageBlob, BlobBlob + +```yaml +Type: System.String +Parameter Sets: CloudShareNfsParameterSet, CloudShareSmbParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NFS +AccessProtocol in the case of creating Share + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CloudShareNfsParameterSet, NfsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SMB +AccessProtocol in the case of creating Share + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SmbParameterSet, CloudShareSmbParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountCredentialName +Provide existing StorageAccountCredential's Resource Name + +```yaml +Type: System.String +Parameter Sets: CloudShareNfsParameterSet, CloudShareSmbParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAccessRight +provide access right along with existing usernames to access SMB Share types, For ex: @(@{"Username"="user-name-1";"AccessRight"="Read"}, @{"Username"="user-name-2";"AccessRight"="Read"}, @{"Username"="user-name-3";"AccessRight"="Custom"}) + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: SmbParameterSet, CloudShareSmbParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeShare + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeStorageAccount.md b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeStorageAccount.md new file mode 100644 index 0000000000..753b237d98 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeStorageAccount.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/new-azdataboxedgestorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeStorageAccount.md +--- + +# New-AzDataBoxEdgeStorageAccount + +## SYNOPSIS +Creates a new Edge Storage account in the device. + +## SYNTAX + +``` +New-AzDataBoxEdgeStorageAccount [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + -StorageAccountCredentialName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-Cloud] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataBoxEdgeStorageAccount** cmdlet creates a new Edge Storage account in a Data Box Edge device. For a device, one Edge Storage account can be mapped at most to only one Cloud Storage account. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataBoxEdgeStorageAccount -ResourceGroupName resourceGroupName -DeviceName dbEdge -Name edgestoragegacount1 -StorageAccountCredentialName cloudstorageaccount1 -Cloud +``` + +```output +Name ContainerCount Status BlobEndpoint CloudStorageAccountName DeviceName ResourceGroupName +---- -------------- ----- ------------ ----------------------- ---------- ----------------- +edgestoragegacount1 0 OK https://edgestoragegacount1.blob.dbEdge.microsoftdatabox.com/ cloudstorageaccount1 dbEdge resourceGroupName +``` + +### Example 2 +```powershell +New-AzDataBoxEdgeStorageAccount -ResourceGroupName resourceGroupName -DeviceName dbEdge -Name edgestoragegacount2 -StorageAccountCredentialName cloudstorageaccount2 +``` + +```output +Name ContainerCount Status BlobEndpoint CloudStorageAccountName DeviceName ResourceGroupName +---- -------------- ----- ------------ ----------------------- ---------- ----------------- +edgestoragegacount2 0 OK https://edgestoragegacount2.blob.dbEdge.microsoftdatabox.com/ cloudstorageaccount2 dbEdge resourceGroupName +``` + +2 EdgeStorageAccounts on the device cannot share more than 1 Cloud Storage Account + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cloud +Will use a CloudStorageAccount for tiering + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountCredentialName +Provide existing StorageAccountCredential's Resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccount + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeStorageAccountCredential.md b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeStorageAccountCredential.md new file mode 100644 index 0000000000..3face6367d --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeStorageAccountCredential.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/new-azdataboxedgestorageaccountcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeStorageAccountCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeStorageAccountCredential.md +--- + +# New-AzDataBoxEdgeStorageAccountCredential + +## SYNOPSIS +Creates new credentials for an edge storage account on the device. + +## SYNTAX + +``` +New-AzDataBoxEdgeStorageAccountCredential [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + -StorageAccountType <String> -StorageAccountAccessKey <SecureString> -EncryptionKey <SecureString> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataBoxEdgeStorageAccountCredential** cmdlet creates a new edge storage account credential for a Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataBoxEdgeStorageAccountCredential -ResourceGroupName resourceGroupName -DeviceName device-name -Name storageAccountName -StorageAccountType BlobStorage -StorageAccountAccessKey @SecureString -EncryptionKey @SecureString +``` + +```output +Name StorageAccount SslStatus ResourceGroupName +--------------------------- ---------------------- ---------- --------------------- +storageAccountCredentalName storageAccountName Enabled resourceGroupName +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKey +Encryption key of the Edge device + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the storage account to be used + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountAccessKey +provide storage account access key + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountType +Possible Storage Access type GeneralPurposeStorage, BlockStorage + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccountCredential + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeStorageContainer.md b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeStorageContainer.md new file mode 100644 index 0000000000..aded36ea8d --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeStorageContainer.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/new-azdataboxedgestoragecontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeStorageContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeStorageContainer.md +--- + +# New-AzDataBoxEdgeStorageContainer + +## SYNOPSIS +Creates a new storage container in the Edge Storage account on the device. + +## SYNTAX + +``` +New-AzDataBoxEdgeStorageContainer [-ResourceGroupName] <String> [-DeviceName] <String> + [-EdgeStorageAccountName] <String> [-Name] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-DataFormat <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataBoxEdgeStorageContainer** cmdlet creates a new storage container in the Edge Storage account on a Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataBoxEdgeStorageContainer -ResourceGroupName resourceGroupName -DeviceName db-edge -EdgeStorageAccountName edgestorageaccount1 -Name edgecontainer1 -DataFormat BlockBlob +``` + +```output +Name DataFormat EdgeStorageAccountName DeviceName ResourceGroupName +---- ---------- ---------------------- ---------- ----------------- +container1 BlockBlob edgestorageaccount1 db-edge resourceGroupName +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFormat +Set Data Format ex: PageBlob, BlobBlob + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EdgeStorageAccountName +Provide existing EdgeStorageAccount's Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageContainer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeTrigger.md b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeTrigger.md new file mode 100644 index 0000000000..f068acb186 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeTrigger.md @@ -0,0 +1,299 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/new-azdataboxedgetrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeTrigger.md +--- + +# New-AzDataBoxEdgeTrigger + +## SYNOPSIS +Configures a trigger on the device. + +## SYNTAX + +### FileEventTriggerParameterSet (Default) +``` +New-AzDataBoxEdgeTrigger [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + -RoleName <String> [-FileEvent] -ShareName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PeriodicTimerTriggerParameterSet +``` +New-AzDataBoxEdgeTrigger [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + -RoleName <String> [-PeriodicTimerEvent] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + -Schedule <String> -StartTime <DateTime> -Topic <String> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FileEventTriggerResourceIdParameterSet +``` +New-AzDataBoxEdgeTrigger [-FileEvent] -ShareId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PeriodicTimerTriggerResourceIdParameterSet +``` +New-AzDataBoxEdgeTrigger [-PeriodicTimerEvent] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + -Schedule <String> -StartTime <DateTime> -Topic <String> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataBoxEdgeTrigger** cmdlet configures a trigger on the Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataBoxEdgeTrigger -ResourceGroupName resourceGroupName -DeviceName deviceName -PeriodicTimerEvent -Name periodic-trigger -RoleName IOTRole -Schedule "00:00" -StartTime "2019-10-28 12:00:00" -Topic sample-topic +``` + +```output +Name Kind +---- ---- +periodic-trigger PeriodicTimerEvent +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: FileEventTriggerParameterSet, PeriodicTimerTriggerParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileEvent +Pass this switch parameter to configure FileEvent Trigger + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FileEventTriggerParameterSet, FileEventTriggerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: FileEventTriggerParameterSet, PeriodicTimerTriggerParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeriodicTimerEvent +Pass this switch parameter to configure PeriodicTimerEvent Trigger + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PeriodicTimerTriggerParameterSet, PeriodicTimerTriggerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: FileEventTriggerParameterSet, PeriodicTimerTriggerParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleName +Compute role against which events will be raised. + +```yaml +Type: System.String +Parameter Sets: FileEventTriggerParameterSet, PeriodicTimerTriggerParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schedule +Periodic frequency at which timer event needs to be raised. Specify a schedule in either days (between 1 and 365) , hours (between 1 and 23), or minutes (between 1 and 59). + +```yaml +Type: System.String +Parameter Sets: PeriodicTimerTriggerParameterSet, PeriodicTimerTriggerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareId +File share ID to be passed in FileEvent Trigger + +```yaml +Type: System.String +Parameter Sets: FileEventTriggerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +File share ID to be passed in FileEvent Trigger + +```yaml +Type: System.String +Parameter Sets: FileEventTriggerParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified up to seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. + +```yaml +Type: System.DateTime +Parameter Sets: PeriodicTimerTriggerParameterSet, PeriodicTimerTriggerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Topic +Topic where periodic events are published to IoT device. + +```yaml +Type: System.String +Parameter Sets: PeriodicTimerTriggerParameterSet, PeriodicTimerTriggerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeTrigger + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeUser.md b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeUser.md new file mode 100644 index 0000000000..efe6be229e --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/New-AzDataBoxEdgeUser.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/new-azdataboxedgeuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/New-AzDataBoxEdgeUser.md +--- + +# New-AzDataBoxEdgeUser + +## SYNOPSIS +Creates a new user for the device. + +## SYNTAX + +``` +New-AzDataBoxEdgeUser [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + -Password <SecureString> -EncryptionKey <SecureString> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [[-Type] <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataBoxEdgeUser** cmdlet creates a new user for the Data Box Edge device. Creation of only users of type `Share` is supported. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataBoxEdgeUser -ResourceGroupName resourceGroupName -DeviceName deviceName -Name username ` + -Password password-secured-string -EncryptionKey encryption-key + ``` + +```output +User name Type ResourceGroupName DeviceName +--------- ---- ----------------- ---------- +username Share resourceGroupName deviceName +``` + +```powershell +New-AzDataBoxEdgeUser -ResourceGroupName resourceGroupName -DeviceName deviceName -Name username ` + -Password password-secured-string -EncryptionKey encryption-key -Type Share + ``` + +```output +User name Type ResourceGroupName DeviceName +--------- ---- ----------------- ---------- +username Share resourceGroupName deviceName +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKey +Encryption key of the Edge device + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Username + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Password, provide as a secure string + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Select UserType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeBandwidthSchedule.md b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeBandwidthSchedule.md new file mode 100644 index 0000000000..d851770d51 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeBandwidthSchedule.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/remove-azdataboxedgebandwidthschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeBandwidthSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeBandwidthSchedule.md +--- + +# Remove-AzDataBoxEdgeBandwidthSchedule + +## SYNOPSIS +Removes a Bandwidth Schedule. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzDataBoxEdgeBandwidthSchedule [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzDataBoxEdgeBandwidthSchedule -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzDataBoxEdgeBandwidthSchedule -InputObject <PSDataBoxEdgeBandWidthSchedule> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataBoxEdgeBandwidthSchedule** cmdlet removes the Bandwidth schedule for a Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataBoxEdgeBandwidthSchedule -ResourceGroupName resourceGroupName -DeviceName deviceName -Name bandwidthSchedule +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeBandWidthSchedule +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +returns true if successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeBandWidthSchedule + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeDevice.md b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeDevice.md new file mode 100644 index 0000000000..c36de463a3 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeDevice.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/remove-azdataboxedgedevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeDevice.md +--- + +# Remove-AzDataBoxEdgeDevice + +## SYNOPSIS +Removes a Data Box Edge device. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzDataBoxEdgeDevice [-ResourceGroupName] <String> [-Name] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzDataBoxEdgeDevice -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzDataBoxEdgeDevice -InputObject <PSDataBoxEdgeDevice> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataBoxEdgeDevice** cmdlet removes the configuration for a Data Box Edge device. +Note that the device can only be deleted after you have placed the order and before the device is prepared by Microsoft for shipment. + +Refer the documentation on Deleting the resource before using this [cmdlet](https://learn.microsoft.com/azure/databox-online/data-box-edge-return-device#delete-the-resource) + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataBoxEdgeDevice -ResourceGroupName resourceGroupName -Name deviceName +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +returns true if successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeDevice + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeOrder.md b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeOrder.md new file mode 100644 index 0000000000..e3c6465c71 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeOrder.md @@ -0,0 +1,197 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/remove-azdataboxedgeorder +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeOrder.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeOrder.md +--- + +# Remove-AzDataBoxEdgeOrder + +## SYNOPSIS +Removes the order for a device. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzDataBoxEdgeOrder [-ResourceGroupName] <String> [-DeviceName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzDataBoxEdgeOrder -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzDataBoxEdgeOrder -InputObject <PSDataBoxEdgeOrder> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataBoxEdgeOrder** cmdlet deletes an existing order for a Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataBoxEdgeOrder -ResourceGroupName resourceGroupName -DeviceName deviceName +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeOrder +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +returns true if successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeOrder + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeOrder + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeRole.md b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeRole.md new file mode 100644 index 0000000000..2ef1eea2e7 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeRole.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/remove-azdataboxedgerole +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeRole.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeRole.md +--- + +# Remove-AzDataBoxEdgeRole + +## SYNOPSIS +Removes the associated IoT role for a device. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzDataBoxEdgeRole [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzDataBoxEdgeRole -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzDataBoxEdgeRole -InputObject <PSDataBoxEdgeRole> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataBoxEdgeRole** cmdlet removes the associated IoT role for a Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataBoxEdgeRole -ResourceGroupName resourceGroupName -DeviceName deviceName -Name roleName +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeRole +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +returns true if successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeRole + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeRole + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeShare.md b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeShare.md new file mode 100644 index 0000000000..1103594769 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeShare.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/remove-azdataboxedgeshare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeShare.md +--- + +# Remove-AzDataBoxEdgeShare + +## SYNOPSIS +Removes a share from the device. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzDataBoxEdgeShare [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzDataBoxEdgeShare [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzDataBoxEdgeShare [-InputObject] <PSDataBoxEdgeShare> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataBoxEdgeEdgeShare** cmdlet removes the associated edge shares for a Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataBoxEdgeShare -ResourceGroupName resourceGroupName -DeviceName deviceName -Name shareName +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeShare +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +returns true if successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeShare + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeStorageAccount.md b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeStorageAccount.md new file mode 100644 index 0000000000..e33359563b --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeStorageAccount.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/remove-azdataboxedgestorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeStorageAccount.md +--- + +# Remove-AzDataBoxEdgeStorageAccount + +## SYNOPSIS +Removes the Edge Storage account for a device. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzDataBoxEdgeStorageAccount [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzDataBoxEdgeStorageAccount [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzDataBoxEdgeStorageAccount [-InputObject] <PSDataBoxEdgeStorageAccount> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataBoxEdgeStorageAccount** cmdlet removes an associated Edge Storage Account for a Data Box Edge device. You can specify the name of the Edge Storage Account to be removed as a parameter in the cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataBoxEdgeStorageAccount -ResourceGroupName resourceGroupName -DeviceName deviceName -Name edgestorageaccountname +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccount +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +returns true if successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccount + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeStorageAccountCredential.md b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeStorageAccountCredential.md new file mode 100644 index 0000000000..05889235a2 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeStorageAccountCredential.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/remove-azdataboxedgestorageaccountcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeStorageAccountCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeStorageAccountCredential.md +--- + +# Remove-AzDataBoxEdgeStorageAccountCredential + +## SYNOPSIS +Removes a storage account credential for a device. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzDataBoxEdgeStorageAccountCredential [-ResourceGroupName] <String> [-DeviceName] <String> + [-Name] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzDataBoxEdgeStorageAccountCredential [-ResourceId] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzDataBoxEdgeStorageAccountCredential [-InputObject] <PSDataBoxEdgeStorageAccountCredential> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataBoxEdgeStorageAccountCredential** cmdlet removes the storage account credential for a Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataBoxEdgeStorageAccountCredential -ResourceGroupName resourceGroupName -DeviceName deviceName -Name storageAccountName +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccountCredential +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the storage account to be used + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +returns true if successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccountCredential + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeStorageContainer.md b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeStorageContainer.md new file mode 100644 index 0000000000..4dda83914b --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeStorageContainer.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/remove-azdataboxedgestoragecontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeStorageContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeStorageContainer.md +--- + +# Remove-AzDataBoxEdgeStorageContainer + +## SYNOPSIS +Removes a storage container for the Edge Storage account on a device. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzDataBoxEdgeStorageContainer [-ResourceGroupName] <String> [-DeviceName] <String> + [-EdgeStorageAccountName] <String> [-Name] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzDataBoxEdgeStorageContainer -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzDataBoxEdgeStorageContainer -InputObject <PSDataBoxEdgeStorageContainer> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataBoxEdgeStorageContainer** cmdlet removes an associated storage container for the Edge Storage account on a Data Box Edge device. You can specify the name of the storage container to be removed as a parameter. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataBoxEdgeStorageContainer -ResourceGroupName resourceGroupName -DeviceName deviceName -EdgeStorageAccountName edgestorageaccountname -Name container1 +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EdgeStorageAccountName +Provide existing EdgeStorageAccount's Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageContainer +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +returns true if successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageContainer + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeTrigger.md b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeTrigger.md new file mode 100644 index 0000000000..b6a5fedad5 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeTrigger.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/remove-azdataboxedgetrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeTrigger.md +--- + +# Remove-AzDataBoxEdgeTrigger + +## SYNOPSIS +Removes an existing trigger on the device. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzDataBoxEdgeTrigger [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzDataBoxEdgeTrigger [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzDataBoxEdgeTrigger [-InputObject] <PSDataBoxEdgeTrigger> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataBoxEdgeTrigger** cmdlet removes an existing trigger on the Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataBoxEdgeTrigger -ResourceGroupName resourceGroupName -DeviceName deviceName -Name triggerName +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeTrigger +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +returns true if successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeTrigger + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeUser.md b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeUser.md new file mode 100644 index 0000000000..0e0447bdbc --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Remove-AzDataBoxEdgeUser.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/remove-azdataboxedgeuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Remove-AzDataBoxEdgeUser.md +--- + +# Remove-AzDataBoxEdgeUser + +## SYNOPSIS +Removes a user on a device. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzDataBoxEdgeUser [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzDataBoxEdgeUser [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzDataBoxEdgeUser [-InputObject] <PSDataBoxEdgeUser> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataBoxEdgeUser** cmdlet removes a user on the Data Box Edge device. Creation of only users of type `Share` is supported. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataBoxEdgeUser -ResourceGroupName resourceGroupName -DeviceName deviceName -Name username +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeUser +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Username + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +returns true if successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeUser + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccountCredential + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeBandwidthSchedule.md b/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeBandwidthSchedule.md new file mode 100644 index 0000000000..699ee5300c --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeBandwidthSchedule.md @@ -0,0 +1,332 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/set-azdataboxedgebandwidthschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Set-AzDataBoxEdgeBandwidthSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Set-AzDataBoxEdgeBandwidthSchedule.md +--- + +# Set-AzDataBoxEdgeBandwidthSchedule + +## SYNOPSIS +Updates a Bandwidth Schedule. + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Set-AzDataBoxEdgeBandwidthSchedule [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-StartTime <String>] [-StopTime <String>] [-DaysOfWeek <String[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByResourceIdParameterSet +``` +Set-AzDataBoxEdgeBandwidthSchedule -ResourceId <String> [-StartTime <String>] [-StopTime <String>] + [-DaysOfWeek <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByResourceIdParameterUnlimitedBandwidthSet +``` +Set-AzDataBoxEdgeBandwidthSchedule -ResourceId <String> [-StartTime <String>] [-StopTime <String>] + [-DaysOfWeek <String[]>] -UnlimitedBandwidth <Boolean> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByResourceIdParameterBandwidthSet +``` +Set-AzDataBoxEdgeBandwidthSchedule -ResourceId <String> [-StartTime <String>] [-StopTime <String>] + [-DaysOfWeek <String[]>] -Bandwidth <Int32> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Set-AzDataBoxEdgeBandwidthSchedule -InputObject <PSDataBoxEdgeBandWidthSchedule> [-StartTime <String>] + [-StopTime <String>] [-DaysOfWeek <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectParameterUnlimitedBandwidthSet +``` +Set-AzDataBoxEdgeBandwidthSchedule -InputObject <PSDataBoxEdgeBandWidthSchedule> [-StartTime <String>] + [-StopTime <String>] [-DaysOfWeek <String[]>] -UnlimitedBandwidth <Boolean> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectParameterBandwidthSet +``` +Set-AzDataBoxEdgeBandwidthSchedule -InputObject <PSDataBoxEdgeBandWidthSchedule> [-StartTime <String>] + [-StopTime <String>] [-DaysOfWeek <String[]>] -Bandwidth <Int32> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByNameParameterUnlimitedBandwidthSet +``` +Set-AzDataBoxEdgeBandwidthSchedule [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-StartTime <String>] [-StopTime <String>] [-DaysOfWeek <String[]>] -UnlimitedBandwidth <Boolean> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByNameParameterBandwidthSet +``` +Set-AzDataBoxEdgeBandwidthSchedule [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + [-StartTime <String>] [-StopTime <String>] [-DaysOfWeek <String[]>] -Bandwidth <Int32> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataBoxEdgeBandwidthSchedule** cmdlet updates a Bandwidth schedule for a Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDataBoxEdgeBandwidthSchedule -ResourceGroupName resourceGroupName -DeviceName deviceName -Name bandwidthSchedule -UnlimitedBandwidth $ture +``` + +```output +Name DaysOfWeek RateInMbps StartTime StopTime +---- ---------- ---------- --------- -------- +bandwidthSchedule Sunday, Tuesday, Saturday Unlimited 11:00:00 12:00:00 +``` + +### Example 2 +```powershell +New-AzDataBoxEdgeBandwidthSchedule -ResourceGroupName resourceGroupName -DeviceName deviceName -Name bandwidthSchedule -StopTime 21:00 +``` + +```output +Name DaysOfWeek RateInMbps StartTime StopTime +---- ---------- ---------- --------- -------- +bandwidthSchedule Sunday, Tuesday, Saturday Unlimited 11:00:00 21:00:00 +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Bandwidth +Bandwidth in Mbps + +```yaml +Type: System.Int32 +Parameter Sets: UpdateByResourceIdParameterBandwidthSet, UpdateByInputObjectParameterBandwidthSet, UpdateByNameParameterBandwidthSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaysOfWeek +Scheduled DaysOfWeek + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, UpdateByNameParameterUnlimitedBandwidthSet, UpdateByNameParameterBandwidthSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure ResourceId + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeBandWidthSchedule +Parameter Sets: UpdateByInputObjectParameterSet, UpdateByInputObjectParameterUnlimitedBandwidthSet, UpdateByInputObjectParameterBandwidthSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, UpdateByNameParameterUnlimitedBandwidthSet, UpdateByNameParameterBandwidthSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, UpdateByNameParameterUnlimitedBandwidthSet, UpdateByNameParameterBandwidthSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdParameterSet, UpdateByResourceIdParameterUnlimitedBandwidthSet, UpdateByResourceIdParameterBandwidthSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Schedule Start Time + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StopTime +Schedule Stop Time + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnlimitedBandwidth +Will Set Unlimited Bandwidth + +```yaml +Type: System.Boolean +Parameter Sets: UpdateByResourceIdParameterUnlimitedBandwidthSet, UpdateByInputObjectParameterUnlimitedBandwidthSet, UpdateByNameParameterUnlimitedBandwidthSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeBandWidthSchedule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeRole.md b/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeRole.md new file mode 100644 index 0000000000..a36d5bf9c1 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeRole.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/set-azdataboxedgerole +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Set-AzDataBoxEdgeRole.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Set-AzDataBoxEdgeRole.md +--- + +# Set-AzDataBoxEdgeRole + +## SYNOPSIS +Updates a Role for a device + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Set-AzDataBoxEdgeRole [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + -ShareName <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Set-AzDataBoxEdgeRole -ResourceId <String> -ShareName <String[]> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Set-AzDataBoxEdgeRole -ShareName <String[]> [-DefaultProfile <IAzureContextContainer>] + -InputObject <PSDataBoxEdgeRole> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataBoxEdgeRole** cmdlet updates an IoT role for a Data Box Edge device. The old mounted shares will be replaced with the newly provided ones in the ShareName parameter. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDataBoxEdgeRole -ResourceGroupName resourceGroupName -DeviceName deviceName -Name IotRole -ShareName sharename1,sharename2,sharename3 +``` + +```output +Name IoTHostHub Platform Status IotEdgeDeviceId IotDeviceId ResourceGroupName +---- ---------- -------- ------ --------------- ----------- ----------------- +IotRole ehub.azure-devices.net Linux Enabled iotEdgeDeviceUd iotDevice resourceGroupName +``` + +Share Names will replace the old mounted shares with the newly provided ones + +### Example 2 +```powershell +Set-AzDataBoxEdgeRole -ResourceGroupName resourceGroupName -DeviceName deviceName -Name IotRole -ShareName @() +``` + +```output +Name IoTHostHub Platform Status IotEdgeDeviceId IotDeviceId ResourceGroupName +---- ---------- -------- ------ --------------- ----------- ----------------- +IotRole ehub.azure-devices.net Linux Enabled iotEdgeDeviceUd iotDevice resourceGroupName +``` + +To unmount all shares + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Please provide corresponding device object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeRole +Parameter Sets: SetByInputObjectParameterSet +Aliases: Role + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Role + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareName +Share(s) in a role + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeRole + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeRole + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeShare.md b/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeShare.md new file mode 100644 index 0000000000..544298c824 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeShare.md @@ -0,0 +1,270 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/set-azdataboxedgeshare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Set-AzDataBoxEdgeShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Set-AzDataBoxEdgeShare.md +--- + +# Set-AzDataBoxEdgeShare + +## SYNOPSIS +Updates the share for a device. + +## SYNTAX + +### SmbParameterSet (Default) +``` +Set-AzDataBoxEdgeShare [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + -UserAccessRight <Hashtable[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByResourceIdSmbParameterSet +``` +Set-AzDataBoxEdgeShare -ResourceId <String> -UserAccessRight <Hashtable[]> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByResourceIdNfsParameterSet +``` +Set-AzDataBoxEdgeShare -ResourceId <String> -ClientAccessRight <Hashtable[]> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectSmbParameterSet +``` +Set-AzDataBoxEdgeShare -InputObject <PSDataBoxEdgeShare> -UserAccessRight <Hashtable[]> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectNfsParameterSet +``` +Set-AzDataBoxEdgeShare -InputObject <PSDataBoxEdgeShare> -ClientAccessRight <Hashtable[]> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NfsParameterSet +``` +Set-AzDataBoxEdgeShare [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + -ClientAccessRight <Hashtable[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This **Set-AzDataBoxEdgeShare** will replace the access rights + +## EXAMPLES + +### Example 1 +```powershell +$AccessRights = @(@{"ClientId"="192.168.10.10";"AccessRight"="NoAccess"}, @{"ClientId"="192.168.10.11";"AccessRight"="ReadOnly"}) +Set-AzDataBoxEdgeShare -ResourceGroupName resource-group-name -ClientAccessRight $AccessRights +``` + +```output +Name Type DataPolicy DataFormat ResourceGroupName StorageAccountName +---------- ---------- ---------------- ---------------- --------------------- ------------------- +share-2 NFS Cloud PageBlob resource-group-name storage-account-name +## $ClientAccessRights = @(@{"ClientId"="192.168.10.10";"AccessRight"="NoAccess"}, @{"ClientId"="192.168.10.11";"AccessRight"="ReadOnly"}) +## Possible values for AccessRight options are 'NoAccess', 'ReadOnly', 'ReadWrite' +``` + +### Example 2 +```powershell +$AccessRights = @(@{"Username"="user-name-1";"AccessRight"="Read"}, @{"Username"="user-name-2";"AccessRight"="Read"}, @{"Username"="user-name-3";"AccessRight"="Custom"}) +Set-AzDataBoxEdgeShare -ResourceGroupName resource-group-name -UserAccessRight $AccessRights +``` + +```output +Name Type DataPolicy DataFormat ResourceGroupName StorageAccountName +---------- ---------- ---------------- ---------------- --------------------- ------------------- +share-1 SMB Cloud PageBlob resource-group-name storage-account-name +## $UserAccessRights = @(@{"Username"="user-name-1";"AccessRight"="Read"}, @{"Username"="user-name-2";"AccessRight"="Read"}, @{"Username"="user-name-3";"AccessRight"="Custom"}) +## Possible values for AccessRight are 'Change', 'Read', 'Custom' +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientAccessRight +Read/Write Access for clientIds, For ex:@(@{"ClientId"="192.168.10.10";"AccessRight"="NoAccess"}, @{"ClientId"="192.168.10.11";"AccessRight"="ReadOnly"}) + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: UpdateByResourceIdNfsParameterSet, UpdateByInputObjectNfsParameterSet, NfsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: SmbParameterSet, NfsParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeShare +Parameter Sets: UpdateByInputObjectSmbParameterSet, UpdateByInputObjectNfsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource Name + +```yaml +Type: System.String +Parameter Sets: SmbParameterSet, NfsParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: SmbParameterSet, NfsParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdSmbParameterSet, UpdateByResourceIdNfsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserAccessRight +provide access right along with existing usernames to access SMB Share types, For ex: @(@{"Username"="user-name-1";"AccessRight"="Read"}, @{"Username"="user-name-2";"AccessRight"="Read"}, @{"Username"="user-name-3";"AccessRight"="Custom"}) + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: SmbParameterSet, UpdateByResourceIdSmbParameterSet, UpdateByInputObjectSmbParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeShare + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeShare + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeStorageAccountCredential.md b/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeStorageAccountCredential.md new file mode 100644 index 0000000000..b4ffef2b3f --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeStorageAccountCredential.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/set-azdataboxedgestorageaccountcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Set-AzDataBoxEdgeStorageAccountCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Set-AzDataBoxEdgeStorageAccountCredential.md +--- + +# Set-AzDataBoxEdgeStorageAccountCredential + +## SYNOPSIS +Sets the storage account credential for a device. + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Set-AzDataBoxEdgeStorageAccountCredential [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + -StorageAccountAccessKey <SecureString> -EncryptionKey <SecureString> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Set-AzDataBoxEdgeStorageAccountCredential -ResourceId <String> -StorageAccountAccessKey <SecureString> + -EncryptionKey <SecureString> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByParentObjectParameterSet +``` +Set-AzDataBoxEdgeStorageAccountCredential -StorageAccountAccessKey <SecureString> -EncryptionKey <SecureString> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] -InputObject <PSDataBoxEdgeStorageAccountCredential> + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataBoxEdgeStorageAccountCredential** cmdlet updates the storage account credential corresponding to a storage account on the Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDataBoxEdgeStorageAccountCredential -ResourceGroupName resourceGroupName -DeviceName deviceName -Name storageAccountName ` + -StorageAccountAccessKey @SecureString -EncryptionKey @SecureString +``` + +```output +Name StorageAccount SslStatus ResourceGroupName +--------------------------- ------------------- ---------- --------------------- +storageAcountCredentialName storageAccountName Enabled resourceGroupName +``` + +Helps in rotating access keys for a storage account + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptionKey +Encryption key of the Edge device + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccountCredential +Parameter Sets: SetByParentObjectParameterSet +Aliases: StorageAccountCredential + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the storage account to be used + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: StorageAccountName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountAccessKey +provide storage account access key + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccountCredential + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeStorageAccountCredential + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeUser.md b/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeUser.md new file mode 100644 index 0000000000..43aa6b5c05 --- /dev/null +++ b/azps-10.1.0/Az.DataBoxEdge/Set-AzDataBoxEdgeUser.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.dll-Help.xml +Module Name: Az.DataBoxEdge +online version: https://learn.microsoft.com/powershell/module/az.databoxedge/set-azdataboxedgeuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Set-AzDataBoxEdgeUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataBoxEdge/DataBoxEdge/help/Set-AzDataBoxEdgeUser.md +--- + +# Set-AzDataBoxEdgeUser + +## SYNOPSIS +Sets a new password for a user on the device. + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Set-AzDataBoxEdgeUser [-ResourceGroupName] <String> [-DeviceName] <String> [-Name] <String> + -Password <SecureString> -EncryptionKey <SecureString> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Set-AzDataBoxEdgeUser -ResourceId <String> -Password <SecureString> -EncryptionKey <SecureString> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Set-AzDataBoxEdgeUser -InputObject <PSDataBoxEdgeUser> -Password <SecureString> -EncryptionKey <SecureString> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataBoxEdgeUser** cmdlet sets a new password for a user on the Data Box Edge device. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDataBoxEdgeUser -ResourceGroupName resourceGroupName -DeviceName deviceName -Name username ` + -Password @SecureString -EncryptionKey @SecureString +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceName +Device Name + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKey +Encryption key of the Edge device + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeUser +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Username + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Password, provide as a secure string + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure ResourceId + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataBoxEdge.Models.PSDataBoxEdgeUser + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataFactory/Add-AzDataFactoryV2DataFlowDebugSessionPackage.md b/azps-10.1.0/Az.DataFactory/Add-AzDataFactoryV2DataFlowDebugSessionPackage.md new file mode 100644 index 0000000000..3acc712e3c --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Add-AzDataFactoryV2DataFlowDebugSessionPackage.md @@ -0,0 +1,301 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/add-azdatafactoryv2dataflowdebugsessionpackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Add-AzDataFactoryV2DataFlowDebugSessionPackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Add-AzDataFactoryV2DataFlowDebugSessionPackage.md +--- + +# Add-AzDataFactoryV2DataFlowDebugSessionPackage + +## SYNOPSIS +Add data flow resource and its dependencies into specific data flow debug session. + +## SYNTAX + +### ByFactoryName (Default) +``` +Add-AzDataFactoryV2DataFlowDebugSessionPackage [-PackageFile] <String> [-PassThru] + [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Add-AzDataFactoryV2DataFlowDebugSessionPackage [-PackageFile] <String> [-PassThru] + [-DataFactory] <PSDataFactory> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Add-AzDataFactoryV2DataFlowDebugSessionPackage [-PackageFile] <String> [-PassThru] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command attaches data flow resource and its dependencies to the specific debug session +The PowerShell command sequence for data flow debug workflow should be: +1. Start-AzDataFactoryV2DataFlowDebugSession +1. Add-AzDataFactoryV2DataFlowDebugSessionPackage +1. Invoke-AzDataFactoryV2DataFlowDebugSessionCommand (repeat this step for different commands/targets, or repeat step 2-3 in order to change the package file) +1. Stop-AzDataFactoryV2DataFlowDebugSession + +## EXAMPLES + +### Example 1 +```powershell +Add-AzDataFactoryV2DataFlowDebugSessionPackage -ResourceGroupName adf -DataFactoryName WikiADF -PackageFile "D:\dataflowps\addpackage.json" -SessionId 550effe4-93a3-485c-8525-eaf25259efbd +``` + +Add data flow package into debug session "550effe4-93a3-485c-8525-eaf25259efbd" of "WikiADF" data factory. +Pakcage file contains data flow debug resource, list of dataset debug resource, list of linked service debug resource, debug setting and session ID. For instance: + +{ + "dataFlow": { + "name": "dataflow5", + "properties": { + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "DelimitedTextInput", + "type": "DatasetReference" + }, + "name": "source1", + "typeProperties": {} + } + ], + "sinks": [], + "transformations": [], + "script": "\n\nsource(output(\n\t\tResourceAgencyNum as string,\n\t\tPublicName as string\n\t),\n\tallowSchemaDrift: true,\n\tvalidateSchema: false) ~> source1" + } + } + }, + "datasets": [ + { + "name": "DelimitedTextInput", + "properties": { + "linkedServiceName": { + "referenceName": "AzureBlobStorage1", + "type": "LinkedServiceReference" + }, + "annotations": [], + "type": "DelimitedText", + "typeProperties": { + "location": { + "type": "AzureBlobStorageLocation", + "container": "20192019" + }, + "columnDelimiter": ",", + "escapeChar": "\\", + "firstRowAsHeader": true, + "quoteChar": "\"" + }, + "schema": [ + { + "name": "ResourceAgencyNum", + "type": "String" + }, + { + "name": "PublicName", + "type": "String" + } + ] + }, + "type": "Microsoft.DataFactory/factories/datasets" + } + ], + "linkedServices": [ + { + "name": "AzureBlobStorage1", + "type": "Microsoft.DataFactory/factories/linkedservices", + "properties": { + "annotations": [], + "type": "AzureBlobStorage", + "typeProperties": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=name;AccountKey=key;EndpointSuffix=core.windows.net" + } + } + } + ], + "debugSettings": { + "sourceSettings": [ + { + "sourceName": "source1", + "rowLimit": 1000 + } + ] + }, + "sessionId": "4f988caf-e765-47d2-82cd-430334a6b135" +} + +SessionID parameter is used to replace the existing sessionId property in the package file. + +## PARAMETERS + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Start-AzDataFactoryV2DataFlowDebugSession](./Start-AzDataFactoryV2DataFlowDebugSession.md) + +[Get-AzDataFactoryV2DataFlowDebugSession](./Get-AzDataFactoryV2DataFlowDebugSession.md) + +[Invoke-AzDataFactoryV2DataFlowDebugSessionCommand](./Invoke-AzDataFactoryV2DataFlowDebugSessionCommand.md) + +[Stop-AzDataFactoryV2DataFlowDebugSession](./Stop-AzDataFactoryV2DataFlowDebugSession.md) diff --git a/azps-10.1.0/Az.DataFactory/Add-AzDataFactoryV2TriggerSubscription.md b/azps-10.1.0/Az.DataFactory/Add-AzDataFactoryV2TriggerSubscription.md new file mode 100644 index 0000000000..5da9953277 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Add-AzDataFactoryV2TriggerSubscription.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/add-azdatafactoryv2triggersubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Add-AzDataFactoryV2TriggerSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Add-AzDataFactoryV2TriggerSubscription.md +--- + +# Add-AzDataFactoryV2TriggerSubscription + +## SYNOPSIS +Subscribe the event trigger to external service events. + +## SYNTAX + +### ByFactoryName (Default) +``` +Add-AzDataFactoryV2TriggerSubscription [-Name] <String> [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObject +``` +Add-AzDataFactoryV2TriggerSubscription [-InputObject] <PSTrigger> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Add-AzDataFactoryV2TriggerSubscription [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command subscribes the event trigger to the specified external service events from the trigger defintion. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzDataFactoryV2TriggerSubscription -ResourceGroupName ADF -DataFactoryName WikiADF -Name Trigger1 +``` + +```output +TriggerName Status +----------- ------ +Trigger1 Provisioning +``` + +This command will subscribe BlobEnetTrigger1 trigger to the specified events from the trigger defintion. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The trigger object. + +```yaml +Type: PSTrigger +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: String +Parameter Sets: ByFactoryName +Aliases: TriggerName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTriggerSubscriptionStatus + +## NOTES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataFactory/Az.DataFactory.md b/azps-10.1.0/Az.DataFactory/Az.DataFactory.md new file mode 100644 index 0000000000..50a64c490b --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Az.DataFactory.md @@ -0,0 +1,250 @@ +--- +Module Name: Az.DataFactory +Module Guid: e3c0f6bc-fe96-41a0-88f4-5e490a91f05d +Download Help Link: https://learn.microsoft.com/powershell/module/az.datafactory +Help Version: 0.5.3.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Az.DataFactory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Az.DataFactory.md +--- + +# Az.DataFactory Module +## Description +Azure Data Factory V2 is the data integration platform that goes beyond Azure Data Factory V1's orchestration and batch-processing of time-series log data, with a general purpose app model supporting modern data warehousing patterns and scenarios, lift-and-shift SSIS, and data-driven SaaS applications. Compose and manage reliable and secure data integration workflows at scale. Use native ADF data connectors and Integration Runtimes to move and transform cloud and on-premises data that can be unstructured, semi-structured, and structured with Hadoop, Azure Data Lake, Spark, SQL Server, Cosmos DB and many other data platforms. + +> [!NOTE] +> APIs that do not have V2 in their signature apply to Azure Data Factory version 1. Version 1 is maintenance mode. Current version is version 2 + +## Az.DataFactory Cmdlets + +### V2 + +#### [Add-AzDataFactoryV2DataFlowDebugSessionPackage](Add-AzDataFactoryV2DataFlowDebugSessionPackage.md) +Add data flow resource and its dependencies into specific data flow debug session. + +#### [Get-AzDataFactoryV2](Get-AzDataFactoryV2.md) +Gets information about Data Factory. + +#### [Get-AzDataFactoryV2ActivityRun](Get-AzDataFactoryV2ActivityRun.md) +Gets information about activity runs for a pipeline run. + +#### [Get-AzDataFactoryV2Dataset](Get-AzDataFactoryV2Dataset.md) +Gets information about datasets in Data Factory. + +#### [Get-AzDataFactoryV2DataFlow](Get-AzDataFactoryV2DataFlow.md) +Gets information about data flows in Data Factory. + +#### [Get-AzDataFactoryV2DataFlowDebugSession](Get-AzDataFactoryV2DataFlowDebugSession.md) +Get all active data flow debug sessions by Azure Data Factory. + +#### [Get-AzDataFactoryV2IntegrationRuntime](Get-AzDataFactoryV2IntegrationRuntime.md) +Gets information about integration runtime resources. + +#### [Get-AzDataFactoryV2IntegrationRuntimeKey](Get-AzDataFactoryV2IntegrationRuntimeKey.md) +Gets keys for a self-hosted integration runtime. + +#### [Get-AzDataFactoryV2IntegrationRuntimeMetric](Get-AzDataFactoryV2IntegrationRuntimeMetric.md) +Gets metric data for an integration runtime. + +#### [Get-AzDataFactoryV2IntegrationRuntimeNode](Get-AzDataFactoryV2IntegrationRuntimeNode.md) +Gets an integration runtime node information. + +#### [Get-AzDataFactoryV2LinkedService](Get-AzDataFactoryV2LinkedService.md) +Gets information about linked services in Data Factory. + +#### [Get-AzDataFactoryV2Pipeline](Get-AzDataFactoryV2Pipeline.md) +Gets information about pipelines in Data Factory. + +#### [Get-AzDataFactoryV2PipelineRun](Get-AzDataFactoryV2PipelineRun.md) +Gets information about pipeline runs. + +#### [Get-AzDataFactoryV2Trigger](Get-AzDataFactoryV2Trigger.md) +Gets information about triggers in a data factory. + +#### [Get-AzDataFactoryV2TriggerRun](Get-AzDataFactoryV2TriggerRun.md) +Returns information about trigger runs. + +#### [Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade](Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade.md) +Upgrades self-hosted integration runtime. + +#### [Invoke-AzDataFactoryV2DataFlowDebugSessionCommand](Invoke-AzDataFactoryV2DataFlowDebugSessionCommand.md) +Invoke debug action in data flow debug session. + +#### [Invoke-AzDataFactoryV2Pipeline](Invoke-AzDataFactoryV2Pipeline.md) +Invokes a pipeline to start a run for it. + +#### [New-AzDataFactoryV2IntegrationRuntimeKey](New-AzDataFactoryV2IntegrationRuntimeKey.md) +Regenerate self-hosted integration runtime key. + +#### [New-AzDataFactoryV2LinkedServiceEncryptedCredential](New-AzDataFactoryV2LinkedServiceEncryptedCredential.md) +Encrypt credential in linked service with specified integration runtime. + +#### [Remove-AzDataFactoryV2](Remove-AzDataFactoryV2.md) +Removes a data factory. + +#### [Remove-AzDataFactoryV2Dataset](Remove-AzDataFactoryV2Dataset.md) +Removes a dataset from Data Factory. + +#### [Remove-AzDataFactoryV2DataFlow](Remove-AzDataFactoryV2DataFlow.md) +Removes a data flow from Data Factory. + +#### [Remove-AzDataFactoryV2IntegrationRuntime](Remove-AzDataFactoryV2IntegrationRuntime.md) +Removes an integration runtime. + +#### [Remove-AzDataFactoryV2IntegrationRuntimeNode](Remove-AzDataFactoryV2IntegrationRuntimeNode.md) +Remove a node with the given name on an integration runtime. + +#### [Remove-AzDataFactoryV2LinkedService](Remove-AzDataFactoryV2LinkedService.md) +Removes a linked service from Data Factory. + +#### [Remove-AzDataFactoryV2Pipeline](Remove-AzDataFactoryV2Pipeline.md) +Removes a pipeline from Data Factory. + +#### [Remove-AzDataFactoryV2Trigger](Remove-AzDataFactoryV2Trigger.md) +Removes a trigger from a data factory. + +#### [Set-AzDataFactoryV2](Set-AzDataFactoryV2.md) +Creates a data factory. + +#### [Set-AzDataFactoryV2Dataset](Set-AzDataFactoryV2Dataset.md) +Creates a dataset in Data Factory. + +#### [Set-AzDataFactoryV2DataFlow](Set-AzDataFactoryV2DataFlow.md) +Creates a data flow in Data Factory. + +#### [Set-AzDataFactoryV2IntegrationRuntime](Set-AzDataFactoryV2IntegrationRuntime.md) +Updates an integration runtime. + +#### [Set-AzDataFactoryV2LinkedService](Set-AzDataFactoryV2LinkedService.md) +Links a data store or a cloud service to Data Factory. + +#### [Set-AzDataFactoryV2Pipeline](Set-AzDataFactoryV2Pipeline.md) +Creates a pipeline in Data Factory. + +#### [Set-AzDataFactoryV2Trigger](Set-AzDataFactoryV2Trigger.md) +Creates a trigger in a data factory. + +#### [Start-AzDataFactoryV2IntegrationRuntime](Start-AzDataFactoryV2IntegrationRuntime.md) +Starts a managed dedicated integration runtime. + +#### [Start-AzDataFactoryV2Trigger](Start-AzDataFactoryV2Trigger.md) +Starts a trigger in a data factory. + +#### [Start-AzDataFactoryV2DataFlowDebugSession](Start-AzDataFactoryV2DataFlowDebugSession.md) +Starts a data flow debug session in Azure Data Factory. + +#### [Stop-AzDataFactoryV2IntegrationRuntime](Stop-AzDataFactoryV2IntegrationRuntime.md) +Stops a managed dedicated integration runtime. + +#### [Stop-AzDataFactoryV2PipelineRun](Stop-AzDataFactoryV2PipelineRun.md) +Stops a pipeline run in a data factory. + +#### [Stop-AzDataFactoryV2Trigger](Stop-AzDataFactoryV2Trigger.md) +Stops a trigger in a data factory. + +#### [Stop-AzDataFactoryV2DataFlowDebugSession](Stop-AzDataFactoryV2DataFlowDebugSession.md) +Stops a data flow debug session in Azure Data Factory. + +#### [Sync-AzDataFactoryV2IntegrationRuntimeCredential](Sync-AzDataFactoryV2IntegrationRuntimeCredential.md) +Synchronizes credentials among integration runtime nodes. + +#### [Update-AzDataFactoryV2](Update-AzDataFactoryV2.md) +Updates the properties of a data factory. + +#### [Update-AzDataFactoryV2IntegrationRuntime](Update-AzDataFactoryV2IntegrationRuntime.md) +Updates an integration runtime. + +#### [Update-AzDataFactoryV2IntegrationRuntimeNode](Update-AzDataFactoryV2IntegrationRuntimeNode.md) +Updates self-hosted integration runtime node. + +### V1 + +#### [Get-AzDataFactory](Get-AzDataFactory.md) +Gets information about Data Factories. + +#### [Get-AzDataFactoryActivityWindow](Get-AzDataFactoryActivityWindow.md) +Gets information about activity windows associated with a data factory. + +#### [Get-AzDataFactoryDataset](Get-AzDataFactoryDataset.md) +Gets information about datasets in Azure Data Factory. + +#### [Get-AzDataFactoryGateway](Get-AzDataFactoryGateway.md) +Gets information about logical gateways in Azure Data Factory. + +#### [Get-AzDataFactoryGatewayAuthKey](Get-AzDataFactoryGatewayAuthKey.md) +Gets gateway auth key for an Azure Data Factory. + +#### [Get-AzDataFactoryHub](Get-AzDataFactoryHub.md) +Gets information about hubs in Azure Data Factory. + +#### [Get-AzDataFactoryLinkedService](Get-AzDataFactoryLinkedService.md) +Gets information about linked services in Azure Data Factory. + +#### [Get-AzDataFactoryPipeline](Get-AzDataFactoryPipeline.md) +Gets information about pipelines in Azure Data Factory. + +#### [Get-AzDataFactoryRun](Get-AzDataFactoryRun.md) +Gets runs for a data slice of a dataset in Azure Data Factory. + +#### [Get-AzDataFactorySlice](Get-AzDataFactorySlice.md) +Sets data slices for a dataset in Azure Data Factory. + +#### [New-AzDataFactory](New-AzDataFactory.md) +Creates a data factory. + +#### [New-AzDataFactoryDataset](New-AzDataFactoryDataset.md) +Creates a dataset in Data Factory. + +#### [New-AzDataFactoryEncryptValue](New-AzDataFactoryEncryptValue.md) +Encrypts sensitive data. + +#### [New-AzDataFactoryGateway](New-AzDataFactoryGateway.md) +Creates a gateway for an Azure Data Factory. + +#### [New-AzDataFactoryGatewayAuthKey](New-AzDataFactoryGatewayAuthKey.md) +Creates auth key for an Azure Data Factory Gateway. + +#### [New-AzDataFactoryHub](New-AzDataFactoryHub.md) +Creates a hub for an Azure Data Factory. + +#### [New-AzDataFactoryLinkedService](New-AzDataFactoryLinkedService.md) +Links a data store or a cloud service to an Azure Data Factory. + +#### [New-AzDataFactoryPipeline](New-AzDataFactoryPipeline.md) +Creates a pipeline in Data Factory. + +#### [Remove-AzDataFactory](Remove-AzDataFactory.md) +Removes a data factory. + +#### [Remove-AzDataFactoryDataset](Remove-AzDataFactoryDataset.md) +Removes a dataset from Azure Data Factory. + +#### [Remove-AzDataFactoryGateway](Remove-AzDataFactoryGateway.md) +Removes a gateway from Azure Data Factory. + +#### [Remove-AzDataFactoryHub](Remove-AzDataFactoryHub.md) +Removes a hub from Azure Data Factory. + +#### [Remove-AzDataFactoryLinkedService](Remove-AzDataFactoryLinkedService.md) +Removes a linked service from Azure Data Factory. + +#### [Remove-AzDataFactoryPipeline](Remove-AzDataFactoryPipeline.md) +Removes a pipeline from Azure Data Factory. + +#### [Resume-AzDataFactoryPipeline](Resume-AzDataFactoryPipeline.md) +Resumes a suspended pipeline in Data Factory. + +#### [Save-AzDataFactoryLog](Save-AzDataFactoryLog.md) +Downloads log files from Azure HDInsight processing. + +#### [Set-AzDataFactoryGateway](Set-AzDataFactoryGateway.md) +Sets the description for a gateway in Azure Data Factory. + +#### [Set-AzDataFactoryPipelineActivePeriod](Set-AzDataFactoryPipelineActivePeriod.md) +Configures the active period for data slices. + +#### [Set-AzDataFactorySliceStatus](Set-AzDataFactorySliceStatus.md) +Sets the status of slices for a dataset in Azure Data Factory. + +#### [Suspend-AzDataFactoryPipeline](Suspend-AzDataFactoryPipeline.md) +Suspends a pipeline in Azure Data Factory. diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactory.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactory.md new file mode 100644 index 0000000000..f5470b786c --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactory.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: ECE1F469-E3C3-4294-A288-8BAE851E8599 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactory.md +--- + +# Get-AzDataFactory + +## SYNOPSIS +Gets information about Data Factories. + +## SYNTAX + +``` +Get-AzDataFactory [[-Name] <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactory** cmdlet gets information about data factories in an Azure resource group. +If you specify the name of a data factory, this cmdlet gets information about that data factory. +If you do not specify a name, this cmdlet gets information about all of the data factories in an Azure resource group. + +## EXAMPLES + +### Example 1: Get all data factories +```powershell +Get-AzDataFactory -ResourceGroupName "ADF" +``` + +```output +DataFactoryName : WikiADF +ResourceGroupName : ADF +Location : WestUS +Tags : {} +Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration + +DataFactoryName : WikiADF2 +ResourceGroupName : ADF +Location : westus +Tags : {} +Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration +``` + +This command displays information about all data factories in the Azure subscription. + +### Example 2: Get a specific data factory +```powershell +$DataFactory = Get-AzDataFactory -ResourceGroupName "ADF" -Name "WikiADF" +``` + +```output +DataFactoryName : WikiADF +ResourceGroupName : ADF +Location : westus +Tags : {} +Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration +``` + +This command displays information about the data factory named WikiADF in the subscription for the resource group named ADF, and then stores it in the $DataFactory variable. +Specify the *DataFactory* parameter in subsequent cmdlets to use the data factory stored in $DataFactory. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the data factory about which to get information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet gets information about data factories that belong to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[New-AzDataFactory](./New-AzDataFactory.md) + +[Remove-AzDataFactory](./Remove-AzDataFactory.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryActivityWindow.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryActivityWindow.md new file mode 100644 index 0000000000..0d0339b28a --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryActivityWindow.md @@ -0,0 +1,400 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: F8C67F7B-64C5-45E4-A0BF-32212BEBE885 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryactivitywindow +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryActivityWindow.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryActivityWindow.md +--- + +# Get-AzDataFactoryActivityWindow + +## SYNOPSIS +Gets information about activity windows associated with a data factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryActivityWindow [-DataFactoryName] <String> [[-DatasetName] <String>] + [[-PipelineName] <String>] [[-ActivityName] <String>] [-WindowState <String>] [-WindowSubstate <String>] + [-Filter <String>] [-OrderBy <String>] [-WindowStart <DateTime>] [-WindowEnd <DateTime>] + [-RunStart <DateTime>] [-RunEnd <DateTime>] [-Top <Int32>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryActivityWindow [-DataFactory] <PSDataFactory> [[-DatasetName] <String>] + [[-PipelineName] <String>] [[-ActivityName] <String>] [-WindowState <String>] [-WindowSubstate <String>] + [-Filter <String>] [-OrderBy <String>] [-WindowStart <DateTime>] [-WindowEnd <DateTime>] + [-RunStart <DateTime>] [-RunEnd <DateTime>] [-Top <Int32>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactoryActivityWindow** cmdlet gets information about the activity windows associated with a data factory. + +## EXAMPLES + +### Example 1: Get activity windows associated with a data factory +```powershell +Get-AzDataFactoryActivityWindow -DataFactoryName "WikiADF" -ResourceGroupName "ADF" -Top 3 +``` + +```output +ResourceGroupName : ADF +DataFactoryName : WikiADF +PipelineName : DP_WikipediaSamplePipeline +ActivityName : BlobToSqlCopyActivity +ActivityType : Copy +LinkedServiceName : +WindowState : Waiting +WindowSubstate : ConcurrencyLimit +Duration : 00:00:00 +InputDatasets : {DA_CuratedWikiData} +OutputDatasets : {DA_WikiAggregatedData} +PercentComplete : 0 +RunAttempts : 1 +RunStart : 8/17/2016 10:05:51 PM +RunEnd : 8/17/2016 10:05:51 PM +WindowStart : 8/17/2016 6:00:00 AM +WindowEnd : 8/17/2016 7:00:00 AM + + +ResourceGroupName : ADF +DataFactoryName : WikiADF +PipelineName : DP_WikipediaSamplePipeline +ActivityName : BlobToSqlCopyActivity +ActivityType : Copy +LinkedServiceName : +WindowState : Waiting +WindowSubstate : ConcurrencyLimit +Duration : 00:00:00 +InputDatasets : {DA_CuratedWikiData} +OutputDatasets : {DA_WikiAggregatedData} +PercentComplete : 0 +RunAttempts : 1 +RunStart : 8/17/2016 10:05:51 PM +RunEnd : 8/17/2016 10:05:51 PM +WindowStart : 8/16/2016 10:00:00 PM +WindowEnd : 8/16/2016 11:00:00 PM + + +ResourceGroupName : ADF +DataFactoryName : WikiADF +PipelineName : DP_WikipediaSamplePipeline +ActivityName : WikiHiveActivity +ActivityType : HDInsightHive +LinkedServiceName : HDILinkedService +WindowState : Ready +WindowSubstate : +Duration : 00:03:37.8020000 +InputDatasets : {DA_WikipediaClickEvents} +OutputDatasets : {DA_CuratedWikiData} +PercentComplete : 100 +RunAttempts : 1 +RunStart : 8/17/2016 11:09:23 PM +RunEnd : 8/17/2016 11:13:01 PM +WindowStart : 8/17/2016 3:00:00 AM +WindowEnd : 8/17/2016 4:00:00 AM +``` + +This command gets information about all activity window associated with the data factory named WikiADF. + +## PARAMETERS + +### -ActivityName +Specifies the name of the activity. +This cmdlet gets activity windows for the activity that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactory +Specifies a **PSDataFactory** object returned by a cmdlet. +This cmdlet gets activity windows that belong to the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of the data factory. +This cmdlet gets activity windows that belong to the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatasetName +Specifies the name of the dataset. +This cmdlet gets activity windows that belong to the dataset that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Specifies the activity window expressed by using Azure Search filter grammar. +For information about the grammar, see OData Expression Syntax for Azure Searchhttps://msdn.microsoft.com/en-us/library/azure/dn798921.aspx (https://msdn.microsoft.com/en-us/library/azure/dn798921.aspx) in MSDN. +The activity windows list is filtered by the search string that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OrderBy +Specifies to order the response by one of the activity window list parameters. +This is a list of comma separated properties. +For example: WindowStart, PercentComplete. +By default, the order is ascending order (ASC). +Specify DESC if you want to order the list in descending order. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PipelineName +Specifies the name of the pipeline. +This cmdlet gets activity windows that belong to the pipeline that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. +This cmdlet gets activity windows that belong to the resource group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunEnd +Specifies the end time of the activity window run. +This cmdlet gets activity windows whose run times fall between *RunStart* and *RunEnd* times. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunStart +Specifies the start time of the activity window run. +This cmdlet gets activity windows whose run times fall between *RunStart* and *RunEnd* times. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +Specifies the maximum number of activity windows that this cmdlet returns. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WindowEnd +Specifies the end time of activity window. +This cmdlet gets activity windows whose times fall between *WindowStart* and *WindowEnd* times. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WindowStart +Specifies the start time of activity window. +This cmdlet gets activity windows whose times fall between *WindowStart* and *WindowEnd* times. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WindowState +Specifies the state of the activity window. +The acceptable values for this parameter are: +- None +- Waiting +- InProgress +- Ready +- Failed +- Skipped +This cmdlet gets activity windows that are in the state that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WindowSubstate +Specifies the substate of the activity window. +The acceptable values for this parameter are: +- Canceled +- timedOut +- Validating +This cmdlet gets activity windows that are in the substate that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSActivityWindow + +## NOTES + +## RELATED LINKS + +[Azure Data Factories Cmdlets](./Az.DataFactory.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryDataset.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryDataset.md new file mode 100644 index 0000000000..316675aebd --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryDataset.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: BB18EEF3-570A-4667-AF0E-FCEEE17B4905 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactorydataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryDataset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryDataset.md +--- + +# Get-AzDataFactoryDataset + +## SYNOPSIS +Gets information about datasets in Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryDataset [-DataFactoryName] <String> [[-Name] <String>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryDataset [-DataFactory] <PSDataFactory> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactoryDataset** cmdlet gets information about datasets in Azure Data Factory. +If you specify the name of a dataset, this cmdlet gets information about that dataset. +If you do not specify a name, this cmdlet gets information about all the datasets in the data factory. + +## EXAMPLES + +### Example 1: Get information about all datasets +```powershell +Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" +``` + +```output +DatasetName : DACuratedWikiData +ResourceGroupName : ADF +DataFactoryName : WikiADF +Availability : Microsoft.DataFactories.Availability +Location : +Policy : +Structure : {} + +DatasetName : DAWikipediaClickEvents +ResourceGroupName : ADF +DataFactoryName : WikiADF +Availability : Microsoft.DataFactories.Availability +Location : +Policy : +Structure : {} + +DatasetName : DAWikiAggregatedData +ResourceGroupName : ADF +DataFactoryName : WikiADF +Availability : Microsoft.DataFactories.Availability +Location : +Policy : +Structure : {} +``` + +This command gets information about all datasets in the data factory named WikiADF. + +### Example 2: Get information about a specific dataset +```powershell +Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" +``` + +```output +DatasetName : DAWikipediaClickEvents +ResourceGroupName : ADF +DataFactoryName : WikiADF +Availability : Microsoft.DataFactories.Availability +Location : Microsoft.DataFactories.AzureBlobLocation +Policy : Microsoft.DataFactories.Policy +Structure : {} +``` + +This command gets information about the dataset named DAWikipediaClickEvents in the data factory named WikiADF. + +### Example 3: Get the location for a specific dataset +```powershell +(Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents").Location +``` + +```output +BlobPath : wikidatagateway/wikisampledatain/ +FilenamePrefix : +Format : +LinkedServiceName : LinkedServiceWikipediaClickEvents +PartitionBy : {} +``` + +This command gets information for the dataset named DAWikipediaClickEvents in the data factory named WikiADF, and then uses standard dot notation to view the **Location** associated with that dataset. +Alternatively, assign the output of the **Get-AzDataFactoryDataset** cmdlet to a variable, and then use dot notation to view the Location property associated with the dataset object stored in that variable. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet gets datasets that belong to the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet gets datasets that belong to the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the dataset about which this cmdlet gets information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet gets datasets that belong to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataset + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[New-AzDataFactoryDataset](./New-AzDataFactoryDataset.md) + +[Remove-AzDataFactoryDataset](./Remove-AzDataFactoryDataset.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryGateway.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryGateway.md new file mode 100644 index 0000000000..990ac8c95e --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryGateway.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: D85FF5ED-23EA-48C7-8E61-D931713E0064 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactorygateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryGateway.md +--- + +# Get-AzDataFactoryGateway + +## SYNOPSIS +Gets information about logical gateways in Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryGateway [-DataFactoryName] <String> [[-Name] <String>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryGateway [-DataFactory] <PSDataFactory> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactoryGateway** cmdlet gets information about logical gateways in Azure Data Factory. +If you specify the name of a gateway, this cmdlet gets information about that gateway. +If you do not specify a name, this cmdlet gets information about all gateways for a data factory. +If you want to add an on-premises Microsoft SQL Server as a linked service to a data factory, you must install a gateway on your on-premises computer. + +## EXAMPLES + +### Example 1: Get all logical gateways in a data factory +```powershell +Get-AzDataFactoryGateway -ResourceGroupName "ADF" -DataFactoryName "WikiADF" +``` + +```output +Name : gateway1 +Description : +Version : 1.3.5338.1 +Status : Online +VersionStatus : UpToDate +CreateTime : 8/22/2014 1:40:34 AM +RegisterTime : 8/22/2014 1:41:46 AM +LastConnectTime : 8/22/2014 1:44:56 AM +ExpiryTime : +Name : gateway2 +Description : +Version : 1.3.5338.1 +Status : Offline +VersionStatus : UpToDate +CreateTime : 8/29/2014 1:46:44 AM +RegisterTime : 8/29/2014 1:48:36 AM +LastConnectTime : 8/29/2014 1:56:56 AM +ExpiryTime : +``` + +This command gets information about all logical gateways for the data factory named WikiADF in the resource group named ADF. + +### Example 2: Get a specific logical gateway in a data factory +```powershell +Get-AzDataFactoryGateway -ResourceGroupName "ADF" -Name "Gateway01" -DataFactoryName "WikiADF" +``` + +```output +Name : Gateway01 +Description : +Version : 1.3.5338.1 +Status : Online +VersionStatus : UpToDate +CreateTime : 8/22/2014 1:40:34 AM +RegisterTime : 8/22/2014 1:41:46 AM +LastConnectTime : 8/22/2014 1:44:56 AM +ExpiryTime : +``` + +This command gets information about the logical gateway named Gateway01 in the data factory named WikiADF in the resource group named ADF. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet gets information about logical gateways in the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet gets information about logical gateways in the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the logical gateway about which to get information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet gets information about logical gateways that belong to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactoryGateway + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[New-AzDataFactoryGateway](./New-AzDataFactoryGateway.md) + +[Remove-AzDataFactoryGateway](./Remove-AzDataFactoryGateway.md) + +[Set-AzDataFactoryGateway](./Set-AzDataFactoryGateway.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryGatewayAuthKey.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryGatewayAuthKey.md new file mode 100644 index 0000000000..501a4def05 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryGatewayAuthKey.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactorygatewayauthkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryGatewayAuthKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryGatewayAuthKey.md +--- + +# Get-AzDataFactoryGatewayAuthKey + +## SYNOPSIS +Gets gateway auth key for an Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryGatewayAuthKey [-DataFactoryName] <String> [-GatewayName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryGatewayAuthKey [-InputObject] <PSDataFactory> [-GatewayName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactoryGatewayAuthKey** cmdlet gets gateway auth key for a specified Azure Data Factory gateway. +You register the gateway with a cloud service by using this key1 or key2 of this auth key. + +## EXAMPLES + +### Example 1: Gets auth key of a gateway +```powershell +Get-AzDataFactoryGatewayAuthKey -ResourceGroupName ADFResource -GatewayName 'MyGateway' -DataFactoryName MyADF +``` + +```output +Key1 : DMG@632e739e-1053-4070-9102-8591f067526e@41fcbc45-c594-4152-a8f1-fcbcd6452aea@wu@ZgBjjX6GfJcrzTQInEV9PoOqsDrqOmC + gGHqUg1THLqA= +Key2 : DMG@632e739e-1053-4070-9102-8591f067526e@41fcbc45-c594-4152-a8f1-fcbcd6452aea@wu@kFXxBdFCEBeL7LPB3hA3LqLd1uNFbyv + YmWxtV4WD3JQ= +``` + +This command gets gateway auth key for the data factory gateway named MyGateway. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayName +The data factory gateway name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The data factory object + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: DataFactory + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactoryGatewayAuthKey + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[New-AzDataFactoryGateway](./New-AzDataFactoryGateway.md) +[New-AzDataFactoryGatewayAuthKey](./New-AzDataFactoryGatewayAuthKey.md) + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryHub.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryHub.md new file mode 100644 index 0000000000..c8f517d61e --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryHub.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: B07FE1A2-732D-4CCF-A0DF-3CF6B91FB3F3 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryHub.md +--- + +# Get-AzDataFactoryHub + +## SYNOPSIS +Gets information about hubs in Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryHub [[-Name] <String>] [-DataFactoryName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryHub [[-Name] <String>] [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactoryHub** cmdlet gets information about hubs in Azure Data Factory. +If you specify the name of a hub, this cmdlet gets information about that hub. +If you do not specify a name, this cmdlet gets information about all of the hubs in a data factory. + +## EXAMPLES + +### Example 1: Get all data hubs +```powershell +Get-AzDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" +``` + +This command gets all data hubs in the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory. + +### Example 2: Get a specific data hub +```powershell +Get-AzDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -Name "MyDataHub" +``` + +This command gets information about the hub named MyDataHub in the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet gets information about hubs in the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet gets information about hubs in the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the hub about which to get information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet gets information about hubs that belong to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSHub + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[New-AzDataFactoryHub](./New-AzDataFactoryHub.md) + +[Remove-AzDataFactoryHub](./Remove-AzDataFactoryHub.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryLinkedService.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryLinkedService.md new file mode 100644 index 0000000000..be9d0a9457 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryLinkedService.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: DFA41A2B-7C8A-42CB-B0B6-5E6FF853EFEE +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactorylinkedservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryLinkedService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryLinkedService.md +--- + +# Get-AzDataFactoryLinkedService + +## SYNOPSIS +Gets information about linked services in Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryLinkedService [-DataFactoryName] <String> [[-Name] <String>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryLinkedService [-DataFactory] <PSDataFactory> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactoryLinkedService** cmdlet gets information about linked services in Azure Data Factory. +If you specify the name of a linked service, this cmdlet gets information about that linked service. +If you do not specify a name, this cmdlet gets information about all the linked services in the data factory. + +## EXAMPLES + +### Example 1: Get information about all linked services +```powershell +Get-AzDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" | Format-List +``` + +This command gets information about all linked services in the data factory named WikiADF, and then passes the linked services to the Format-List cmdlet by using the pipeline operator. +That cmdlet formats the results. +For more information, type `Get-Help Format-List`. + +### Example 2: Get information about a specific linked service +```powershell +Get-AzDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "HDILinkedService" +``` + +```output +LinkedServiceName ResourceGroupName DataFactoryName Properties +----------------- ----------------- --------------- ---------- +HDILinkedService ADF WikiADF Microsoft.DataFactories.HDInsightBYOCAsset +``` + +This command gets information about the linked service named HDILinkedService in the data factory named WikiADF. + +### Example 3: Get information about a specific linked service by specifying the DataFactory parameter +```powershell +$DataFactory = Get-AzDataFactory -ResourceGroupName "ADF" -Name "ContosoFactory" +Get-AzDataFactoryLinkedService -DataFactory $DataFactory | Format-Table -Property LinkedServiceName, DataFactoryName, ResourceGroupName +``` + +The first command uses the Get-AzDataFactory cmdlet to get the data factory named ContosoFactory, and then stores it in the $DataFactory variable. +The second command gets information about the linked service for the data factory stored in $DataFactory, and then passes that information to the Format-Table cmdlet by using the pipeline operator. +**Format-Table** formats the output as a dataset with the specified properties as dataset columns. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet gets linked services that belong to the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet gets linked services that belong to the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the linked service about which to get information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet gets linked services that belong to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSLinkedService + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[New-AzDataFactoryLinkedService](./New-AzDataFactoryLinkedService.md) + +[Remove-AzDataFactoryLinkedService](./Remove-AzDataFactoryLinkedService.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryPipeline.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryPipeline.md new file mode 100644 index 0000000000..a3cdb062cb --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryPipeline.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 5224BDF5-D492-4160-893E-4BB5F76C22F3 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactorypipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryPipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryPipeline.md +--- + +# Get-AzDataFactoryPipeline + +## SYNOPSIS +Gets information about pipelines in Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryPipeline [[-Name] <String>] [-DataFactoryName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryPipeline [[-Name] <String>] [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactoryPipeline** cmdlet gets information about pipelines in Azure Data Factory. +If you specify the name of a pipeline, this cmdlet gets information about that pipeline. +If you do not specify a name, this cmdlet gets information about all the pipelines in the data factory. + +## EXAMPLES + +### Example 1: Get information about all pipelines +```powershell +Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF" +``` + +This command gets information about all pipelines in the data factory named WikiADF. +You can either one of the following example commands. +The second one uses a **DataFactory** object as a parameter. + +### Example 2: Get information about a specific pipeline +```powershell +Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" | Format-List +``` + +```output +PipelineName : DPWikisample +ResourceGroupName : ADF +DataFactoryName : WikiADF +Properties : Microsoft.DataFactories.PipelineProperties +``` + +This command gets information about the pipeline named DPWikisample in the data factory named WikiADF. +The command passes that information to the Format-List cmdlet by using the pipeline operator. +That cmdlet formats the results. +For more information, type `Get-Help Format-List`. + +### Example 3: Get the properties for a specific pipeline +```powershell +(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name DPWikisample -DataFactoryName "WikiADF").Properties +``` + +```output +Activities : {WikiHiveActivity, BlobToSqlCopyActivity} +Description : DP Wikipedia Sample Pipelines +End : 6/6/2014 8:00:00 AM +IsPaused : +RuntimeInfo : Microsoft.DataFactories.PipelineRuntimeInfo +Start : 6/5/2014 8:00:00 PM +``` + +This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the **Properties** property associated with that pipeline. + +### Example 4: Get the activities for a specific pipeline +```powershell +(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF").Properties.Activities +``` + +```output +Transformation : Microsoft.DataFactories.HDInsightActivityProperties +Description : +Inputs : {DAWikipediaClickEvents} +LinkedServiceName : HDILinkedService +Name : WikiHiveActivity +Outputs : {DACuratedWikiData} +Policy : Microsoft.DataFactories.ActivityPolicy + +Transformation : Microsoft.DataFactories.CopyActivityProperties +Description : +Inputs : {DACuratedWikiData} +LinkedServiceName : HDILinkedService +Name : BlobToSqlCopyActivity +Outputs : {DAWikiAggregatedData} +Policy : Microsoft.DataFactories.ActivityPolicy +``` + +This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the **Activities** property associated with that pipeline. + +### Example 5: Get the runtime information for a specific pipeline +```powershell +(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF").Properties.RuntimeInfo +``` + +```output +DeploymentTime +-------------- +6/5/2014 10:36:46 PM +``` + +This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the **RuntimeInfo** property associated with that pipeline. + +### Example 6: Get information about inputs for the first activity +```powershell +(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF11").Properties.Activities[0].Inputs | Format-List +``` + +```output +EndTime : +Length : +Name : DAWikipediaClickEvents +StartTime : +``` + +This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the **Activities** property associated with that pipeline. +The command displays the **Inputs** property of the first element of the **Activities** array by using **Format-List**. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet gets pipelines that belong to the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet gets pipelines that belong to the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the pipeline about which to get information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet gets pipelines that belong to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSPipeline + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[New-AzDataFactoryPipeline](./New-AzDataFactoryPipeline.md) + +[Remove-AzDataFactoryPipeline](./Remove-AzDataFactoryPipeline.md) + +[Resume-AzDataFactoryPipeline](./Resume-AzDataFactoryPipeline.md) + +[Set-AzDataFactoryPipelineActivePeriod](./Set-AzDataFactoryPipelineActivePeriod.md) + +[Suspend-AzDataFactoryPipeline](./Suspend-AzDataFactoryPipeline.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryRun.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryRun.md new file mode 100644 index 0000000000..9715173847 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryRun.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 7100B5F0-A07B-4305-BF80-1F52647A03AB +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryrun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryRun.md +--- + +# Get-AzDataFactoryRun + +## SYNOPSIS +Gets runs for a data slice of a dataset in Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryRun [-DataFactoryName] <String> [-DatasetName] <String> [-StartDateTime] <DateTime> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryRun [-DataFactory] <PSDataFactory> [-DatasetName] <String> [-StartDateTime] <DateTime> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactoryRun** cmdlet gets the runs for a data slice of a dataset in Azure Data Factory. +A dataset in a data factory is composed of slices over the time axis. +The width of a slice is determined by the schedule, either hourly or daily. +A run is a unit of processing for a slice. +There could be one or more runs for a slice in case of retries or in case you rerun your slice due to failures. +A slice is identified by its start time. +To obtain the start time of a slice, use the Get-AzDataFactorySlice cmdlet. +For example, to get a run for the following slice, use the start time 2015-04-02T20:00:00. +ResourceGroupName : ADF +DataFactoryName : SPDataFactory0924 +DatasetName : MarketingCampaignEffectivenessBlobDataset +Start : 5/2/2014 8:00:00 PM +End : 5/3/2014 8:00:00 PM +RetryCount : 0 +Status : Ready +LatencyStatus : + +## EXAMPLES + +### Example 1: Get a dataset +```powershell +Get-AzDataFactoryRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-21T16:00:00Z +``` + +```output +Id : a7c4913c-9623-49b3-ae1e-3e45e2b68819 +ResourceGroupName : ADF +DataFactoryName : WikiADF +DatasetName : DAWikiAggregatedData +PipelineName : 249ea141-ca00-8597-fad9-a148e5e7bdba +ActivityId : fcefe2bd-39b1-2d7a-7b35-bcc2b0432300 +ResumptionToken : a7c4913c-9623-49b3-ae1e-3e45e2b68819 +ContinuationToken : +ProcessingStartTime : 5/21/2014 5:02:41 PM +ProcessingEndTime : 5/21/2014 5:04:12 PM +PercentComplete : 100 +DataSliceStart : 5/21/2014 4:00:00 PM +DataSliceEnd : 5/21/2014 5:00:00 PM +Status : Succeeded +Timestamp : 5/21/2014 5:02:41 PM +RetryAttempt : 0 +Properties : {[errors, ]} +ErrorMessage : +``` + +This command gets all runs for slices of the dataset named DAWikiAggregatedData in the data factory named WikiADF that start from 4 PM GMT on 05/21/2014. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet gets runs for slices that belong to the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet gets runs for slices that belong to the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatasetName +Specifies the name of the dataset. +This cmdlet gets runs for slices that belong to the dataset that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet gets factory runs for slices that belong to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartDateTime +Specifies the start of a time period as a **DateTime** object. +This cmdlet gets runs for the data slices that match this time period. +*StartDateTime* must be specified in the ISO8601 format, as in the following examples: +2015-01-01Z +2015-01-01T00:00:00Z +2015-01-01T00:00:00.000Z (UTC) +2015-01-01T00:00:00-08:00 (Pacific Standard Time) +The default time zone designator is UTC. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataSliceRun + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactorySlice](./Get-AzDataFactorySlice.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactorySlice.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactorySlice.md new file mode 100644 index 0000000000..ff5558908a --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactorySlice.md @@ -0,0 +1,268 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: C102232A-C9C8-4CEE-8535-7C7A70057B06 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryslice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactorySlice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactorySlice.md +--- + +# Get-AzDataFactorySlice + +## SYNOPSIS +Gets data slices for a dataset in Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactorySlice [[-EndDateTime] <DateTime>] [-DataFactoryName] <String> [-DatasetName] <String> + [-StartDateTime] <DateTime> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactorySlice [[-EndDateTime] <DateTime>] [-DataFactory] <PSDataFactory> [-DatasetName] <String> + [-StartDateTime] <DateTime> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactorySlice** cmdlet gets data slices for a dataset in Azure Data Factory. +Specify a start time and an end time to define a range of data slices to view. +The status of a data slice is one of the following values: +- PendingExecution. +Data processing has not started. +- InProgress. +Data processing is in progress. +- Ready. +Data processing is completed. +The data slice is ready for dependent slices to consume it. +- Failed. +The run that produces the slice failed. +- Skip. +Data Factory skips processing of the slice. +- Retry. +Data Factory retries the run that produces the slice. +- Timed Out. +Data processing has timed out. +- PendingValidation. +Data slice is waiting for validation before it is processed. +- Retry Validation. +Data Factory retries the validation of the slice. +- Failed Validation. +Validation of the slice failed. +For each of the slices, you can see more information about the run that produces the slice by using the Get-AzDataFactoryRun cmdlet. + +## EXAMPLES + +### Example 1: Get data slices for a dataset +```powershell +Get-AzDataFactorySlice -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-20T10:00:00Z +``` + +```output +ResourceGroupName : ADF +DataFactoryName : WikiADF +DatasetName : DAWikiAggregatedData +Start : 5/21/2014 1:00:00 AM +End : 5/21/2014 2:00:00 AM +RetryCount : 0 +Status : Ready + +ResourceGroupName : ADF +DataFactoryName : WikiADF +DatasetName : DAWikiAggregatedData +Start : 5/21/2014 2:00:00 AM +End : 5/21/2014 3:00:00 AM +RetryCount : 0 +Status : Ready + +. . . + +ResourceGroupName : ADF +DataFactoryName : WikiADF +DatasetName : DAWikiAggregatedData +Start : 5/21/2014 8:00:00 PM +End : 5/21/2014 9:00:00 PM +RetryCount : 0 +Status : PendingExecution + +ResourceGroupName : ADF +DataFactoryName : WikiADF +DatasetName : DAWikiAggregatedData +Start : 5/21/2014 9:00:00 PM +End : 5/21/2014 10:00:00 PM +RetryCount : 0 +Status : PendingExecution + +. . . +``` + +This command gets all the data slices for the dataset named WikiAggregatedData in the data factory named WikiADF. +The command gets slices produced after the time that the StartDateTime parameter specifies. +The following example code sets the availability for this dataset every hour in the JavaScript Object Notation (JSON) file. + availability: + { + period: "Hour", + periodMultiplier: 1 + } + Some of the results are Ready and others are PendingExecution. +Ready slices have already run. +The pending slices are waiting to run at the end of each hour in the interval that the Set-AzDataFactoryPipelineActivePeriod cmdlet specifies. +In this example, both start and end periods for the pipeline and the slice have a value of one day (24 hours). + +### Example 2 + +Gets data slices for a dataset in Azure Data Factory. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzDataFactorySlice -DataFactoryName 'WikiADF' -DatasetName 'DAWikiAggregatedData' -EndDateTime 2014-05-22T16:00:00Z -ResourceGroupName 'ADF' -StartDateTime 2014-05-20T10:00:00Z +``` + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet gets slices that belong to the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet gets slices that belong to the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatasetName +Specifies the name of the dataset for which this cmdlet gets slices. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDateTime +Specifies the end of a time period as a **DateTime** object. +This cmdlet gets slices produced before the time that this parameter specifies. +For more information about **DateTime** objects, type `Get-Help Get-Date`. +*EndDateTime* must be specified in the ISO8601 format as in the following examples: +2015-01-01Z +2015-01-01T00:00:00Z +2015-01-01T00:00:00.000Z (UTC) +2015-01-01T00:00:00-08:00 (Pacific Standard Time) +The default time zone designator is UTC. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet gets slices that belong to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartDateTime +Specifies the start of a time period as a **DateTime** object. +This cmdlet gets slices produced after the time that this parameter specifies. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataSlice + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Set-AzDataFactorySliceStatus](./Set-AzDataFactorySliceStatus.md) + +[Get-AzDataFactoryRun](./Get-AzDataFactoryRun.md) + +[Set-AzDataFactoryPipelineActivePeriod](./Set-AzDataFactoryPipelineActivePeriod.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2.md new file mode 100644 index 0000000000..9c46767094 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2 +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2.md +--- + +# Get-AzDataFactoryV2 + +## SYNOPSIS +Gets information about Data Factory. + +## SYNTAX + +### BySubscriptionId (Default) +``` +Get-AzDataFactoryV2 [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryName +``` +Get-AzDataFactoryV2 [-ResourceGroupName] <String> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDataFactoryV2 cmdlet gets information about data factories in an Azure resource group. +If you specify the name of a data factory, this cmdlet gets information about that data factory. +If you do not specify a name, this cmdlet gets information about all of the data factories in an Azure resource group. + +## EXAMPLES + +### Example 1: Get all data factories +```powershell +Get-AzDataFactoryV2 -ResourceGroupName "ADF" +``` + +```output + DataFactoryName : WikiADF + DataFactoryId : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataFactory/factories/wikiadf + ResourceGroupName : ADF + Location : EastUS + Tags : {} + Identity : Microsoft.Azure.Management.DataFactory.Models.FactoryIdentity + ProvisioningState : Succeeded + + DataFactoryName : WikiADF2 + DataFactoryId : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataFactory/factories/wikiadf2 + ResourceGroupName : ADF + Location : EastUS + Tags : {} + Identity : + ProvisioningState : Succeeded +``` + +Displays information about all data factories in the Azure subscription. + +### Example 2: Get a specific data factory +```powershell +$DataFactory = Get-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF" +``` + +```output + DataFactoryName : WikiADF + DataFactoryId : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataF + actory/factories/wikiadf + ResourceGroupName : ADF + Location : EastUS + Tags : {} + Identity : Microsoft.Azure.Management.DataFactory.Models.FactoryIdentity + ProvisioningState : Succeeded +``` + +This command displays information about the data factory named WikiADF in the subscription for the resource group named ADF, and then stores it in the $DataFactory variable. +Specify the DataFactory parameter in subsequent cmdlets to use the data factory stored in $DataFactory. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the data factory about which to get information. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: DataFactoryName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet gets information about data factories that belong to the group this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Set-AzDataFactoryV2]() + +[Remove-AzDataFactoryV2]() + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2ActivityRun.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2ActivityRun.md new file mode 100644 index 0000000000..4bcba0c528 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2ActivityRun.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2activityrun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2ActivityRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2ActivityRun.md +--- + +# Get-AzDataFactoryV2ActivityRun + +## SYNOPSIS +Gets information about activity runs for a pipeline run. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryV2ActivityRun [-PipelineRunId] <String> [-RunStartedAfter] <DateTime> + [-RunStartedBefore] <DateTime> [[-ActivityName] <String>] [[-Status] <String>] [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryV2ActivityRun [-PipelineRunId] <String> [-RunStartedAfter] <DateTime> + [-RunStartedBefore] <DateTime> [[-ActivityName] <String>] [[-Status] <String>] [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactoryV2ActivityRun** cmdlet gets information about runs in Azure Data Factory for the specified pipeline run that happened in the given timeframe. Additionally, you can specify filters for activity name, linked service name that executed the run, and the status of the run. + +## EXAMPLES + +### Example 1: Get all activity runs for a pipeline run +```powershell +Get-AzDataFactoryV2ActivityRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineRunId "f288712d-fb08-4cb8-96ef-82d3b9b30621" -RunStartedAfter "2017-09-01" -RunStartedBefore "2017-09-30" +``` + +```output + ResourceGroupName : ADF + DataFactoryName : WikiADF + ActivityName : MyWebActivity + PipelineRunId : f288712d-fb08-4cb8-96ef-82d3b9b30621 + PipelineName : DPWikisample + Input : {method, url, headers, body...} + Output : {operationstatus} + ActivityRunStart : 9/14/2017 12:20:57 AM + ActivityRunEnd : 9/14/2017 12:21:00 AM + DurationInMs : 2768 + Status : Succeeded + Error : {errorCode, message, failureType, target} +``` + +This command gets details about all activity runs in the pipeline run with ID "f288712d-fb08-4cb8-96ef-82d3b9b30621" that happened between "2017-09-01" and "2017-09-30". + +## PARAMETERS + +### -ActivityName +The name of the activity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineRunId +The Run ID of the pipeline. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunStartedAfter +The time at or after which the pipeline run started to execute. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunStartedBefore +The time at or before which the pipeline run started to execute. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The status of the pipeline run. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSActivityRun + +## NOTES + +## RELATED LINKS + +[Invoke-AzDataFactoryV2Pipeline]() + +[Get-AzDataFactoryV2PipelineRun]() + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2DataFlow.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2DataFlow.md new file mode 100644 index 0000000000..1e58038911 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2DataFlow.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2dataflow +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2DataFlow.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2DataFlow.md +--- + +# Get-AzDataFactoryV2DataFlow + +## SYNOPSIS +Gets information about data flows in Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryV2DataFlow [[-Name] <String>] [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryV2DataFlow [[-Name] <String>] [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzDataFactoryV2DataFlow [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDataFactoryV2DataFlow cmdlet gets information about data flows in Azure Data Factory. +If you specify the name of a data flow, this cmdlet gets information about that data flow. +If you do not specify a name, this cmdlet gets information about all the data flows in the data factory. + +## EXAMPLES +### Example 1: Get information about all data flows +```powershell +Get-AzDataFactoryV2DataFlow -ResourceGroupName "ADF" -DataFactoryName "WikiADF" +``` + +```output +DataFlowName DataFactoryName ResourceGroupName Properties +------------ --------------- ----------------- ---------- +TaxiDemo1 WikiADF adf Microsoft.Azure.Management.DataFactory.Models.MappingDataFlow +dataflow1 WikiADF adf Microsoft.Azure.Management.DataFactory.Models.MappingDataFlow +dataflow3 WikiADF adf Microsoft.Azure.Management.DataFactory.Models.MappingDataFlow +``` + +This command gets information about all data flows in the data factory named WikiADF. + +### Example 2: Get information about a specific data flow +```powershell +Get-AzDataFactoryV2DataFlow -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "dataflow1" +``` + +```output +DataFlowName DataFactoryName ResourceGroupName Properties +------------ --------------- ----------------- ---------- +TaxiDemo1 WikiADF adf Microsoft.Azure.Management.DataFactory.Models.MappingDataFlow +``` + +This command gets information about the data flow named dataflow1 in the data factory named WikiADF. + +## PARAMETERS + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The data flow name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName, ByFactoryObject +Aliases: DataFlowName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFlow + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Set-AzDataFactoryV2DataFlow](./set-azdatafactoryv2dataflow.md) + +[Remove-AzDataFactoryV2DataFlow](./remove-azdatafactoryv2dataflow.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2DataFlowDebugSession.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2DataFlowDebugSession.md new file mode 100644 index 0000000000..31f0a4a7b0 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2DataFlowDebugSession.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2dataflowdebugsession +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2DataFlowDebugSession.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2DataFlowDebugSession.md +--- + +# Get-AzDataFactoryV2DataFlowDebugSession + +## SYNOPSIS +Get all active data flow debug sessions by Azure Data Factory + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryV2DataFlowDebugSession [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzDataFactoryV2DataFlowDebugSession [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryV2DataFlowDebugSession [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +List all active data flow debug sessions by Azure Data Factory with details. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataFactoryV2DataFlowDebugSession -ResourceGroupName adf -DataFactoryName WikiADF +``` + +```output +SessionId ComputeType CoreCount StartTime LastActivityTime TimeToLiveInMinutes IntegrationRuntimeName DataFlowName +--------- ----------- --------- --------- ---------------- ------------------- ---------------------- ------------ +3c68dbd6-f9c3-4b5f-a200-2310258016a7 General 8 2019-10-04T18:19:58.5550364+00:00 2019-10-04T18:24:51.3680548+00:00 60 DebugSession-0a7e0d6e-f2b7-48cc-8cd8-618326f5662f +``` + +Get all active data flow debug sessions in Azure Data Factory "WikiADF". + +## PARAMETERS + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFlowDebugSessionInfo + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Start-AzDataFactoryV2DataFlowDebugSession](./Start-AzDataFactoryV2DataFlowDebugSession.md) + +[Add-AzDataFactoryV2DataFlowDebugSessionPackage](./Add-AzDataFactoryV2DataFlowDebugSessionPackage.md) + +[Invoke-AzDataFactoryV2DataFlowDebugSessionCommand](./Invoke-AzDataFactoryV2DataFlowDebugSessionCommand.md) + +[Stop-AzDataFactoryV2DataFlowDebugSession](./Stop-AzDataFactoryV2DataFlowDebugSession.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2Dataset.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2Dataset.md new file mode 100644 index 0000000000..b13413b95b --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2Dataset.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2dataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2Dataset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2Dataset.md +--- + +# Get-AzDataFactoryV2Dataset + +## SYNOPSIS +Gets information about datasets in Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryV2Dataset [[-Name] <String>] [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryV2Dataset [[-Name] <String>] [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzDataFactoryV2Dataset [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDataFactoryV2Dataset cmdlet gets information about datasets in Azure Data Factory. +If you specify the name of a dataset, this cmdlet gets information about that dataset. +If you do not specify a name, this cmdlet gets information about all the datasets in the data factory. + +## EXAMPLES + +### Example 1: Get information about all datasets +```powershell +Get-AzDataFactoryV2Dataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" +``` + +```output + DatasetName : DACuratedWikiData + ResourceGroupName : ADF + DataFactoryName : WikiADF + Structure : + Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset + + DatasetName : DAWikipediaClickEvents + ResourceGroupName : ADF + DataFactoryName : WikiADF + Structure : + Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset + + DatasetName : DAWikiAggregatedData + ResourceGroupName : ADF + DataFactoryName : WikiADF + Structure : + Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset +``` + +This command gets information about all datasets in the data factory named WikiADF. + +### Example 2: Get information about a specific dataset +```powershell +Get-AzDataFactoryV2Dataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" +``` + +```output + DatasetName : DAWikipediaClickEvents + ResourceGroupName : ADF + DataFactoryName : WikiADF + Structure : + Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset +``` + +This command gets information about the dataset named DAWikipediaClickEvents in the data factory named WikiADF. + +## PARAMETERS + +### -DataFactory +Specifies a PSDataFactory object. +This cmdlet gets datasets that belong to the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet gets datasets that belong to the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the dataset about which to get information. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName, ByFactoryObject +Aliases: DatasetName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet gets datasets that belong to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataset + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Set-AzDataFactoryV2Dataset]() + +[Remove-AzDataFactoryV2Dataset]() diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntime.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntime.md new file mode 100644 index 0000000000..1836d32267 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntime.md @@ -0,0 +1,294 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2integrationruntime +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2IntegrationRuntime.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2IntegrationRuntime.md +--- + +# Get-AzDataFactoryV2IntegrationRuntime + +## SYNOPSIS +Gets information about integration runtime resources. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Get-AzDataFactoryV2IntegrationRuntime [[-Name] <String>] [-Status] [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzDataFactoryV2IntegrationRuntime [-Status] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Get-AzDataFactoryV2IntegrationRuntime [-Status] [-InputObject] <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDataFactoryV2IntegrationRuntime cmdlet gets information about integration runtimes in a data factory. +If you specify the name of an integration runtime, this cmdlet gets information about that integration runtime. +If you do not specify a name, this cmdlet gets information about all of the integration runtimes in a data factory. + +## EXAMPLES + +### Example 1: List all integration runtimes in a data factory +```powershell +Get-AzDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 +``` + +```output + ResourceGroupName DataFactoryName Name Description + ----------------- --------------- ---- ----------- + rg-test-dfv2 test-df-eu2 test-reserved-ir Reserved IR + rg-test-dfv2 test-df-eu2 test-dedicated-ir Reserved IR + rg-test-dfv2 test-df-eu2 test-selfhost-ir selfhost IR +``` + +List all integration runtimes in the data factory named 'test-df-eu2'. + +### Example 2: Get managed dedicated integration runtime +```powershell +Get-AzDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-dedicated-ir +``` + +```output + Location : West US + NodeSize : Standard_D1_v2 + NodeCount : 1 + MaxParallelExecutionsPerNode : 1 + CatalogServerEndpoint : test.database.windows.net + CatalogAdminUserName : test + CatalogAdminPassword : ********** + CatalogPricingTier : S1 + VNetId : + Subnet : + SubnetId : + VNetInjectionMethod : Express + PublicIPs : + State : Starting + ResourceGroupName : rg-test-dfv2 + DataFactoryName : test-df-eu2 + Name : test-dedicated-ir + Description : Reserved IR +``` + +This command displays information about the integration runtime named 'test-dedicated-ir' in the subscription for the resource group named 'rg-test-dfv2' and data factory named 'test-df-eu2'. + +### Example 3: Get managed dedicated integration runtime with detail status +```powershell +Get-AzDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-dedicated-ir -Status +``` + +```output + CreateTime : + Nodes : + OtherErrors : + LastOperation : + State : Initial + Location : West US + NodeSize : Standard_D1_v2 + NodeCount : 1 + MaxParallelExecutionsPerNode : 1 + CatalogServerEndpoint : test.database.windows.net + CatalogAdminUserName : test + CatalogAdminPassword : ********** + CatalogPricingTier : S1 + VNetId : + Subnet : + SubnetId : + VNetInjectionMethod : Standard + PublicIPs : + ResourceGroupName : rg-test-dfv2 + DataFactoryName : test-df-eu2 + Name : test-dedicated-ir + Description : Reserved IR +``` + +This command displays information about the integration runtime named 'test-dedicated-ir' in the subscription for the resource group named 'rg-test-dfv2' and data factory named 'test-df-eu2'. + +### Example 4: Get self-hosted integration runtime +```powershell +Get-AzDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-selfhost-ir +``` + +```output + ResourceGroupName DataFactoryName Name Description + ----------------- --------------- ---- ----------- + rg-test-dfv2 test-df-eu2 test-selfhost-ir selfhost IR +``` + +This command displays information about the integration runtime named 'test-dedicated-ir' in the subscription for the resource group named 'rg-test-dfv2' and data factory named 'test-df-eu2'. + +### Example 5: Get self-hosted integration runtime with detail status +```powershell +Get-AzDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-selfhost-ir -Status +``` + +```output + State : Online + Version : 4.2.7233.1 + CreateTime : 9/26/2019 6:00:08 AM + AutoUpdate : Off + ScheduledUpdateDate : + UpdateDelayOffset : 03:00:00 + LocalTimeZoneOffset : 08:00:00 + InternalChannelEncryption : + Capabilities : {[serviceBusConnected, True], [httpsPortEnabled, True], [credentialInSync, True], [connectedToResourceManager, True]...} + ServiceUrls : {} + Nodes : {} + Links : {} + AutoUpdateETA : + LatestVersion : 4.3.7265.1 + PushedVersion : 4.3.7265.1 + TaskQueueId : fe2d60b5-86f5-58bf-bdae-7ef698284088 + VersionStatus : UpdateAvailable + Name : test-selfhost-ir + Type : SelfHosted + ResourceGroupName : rg-test-dfv2 + DataFactoryName : test-df-eu2 + Description : + Id : /subscriptions/41fcbc45-c594-4152-a8f1-fcbcd6452aea/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir +``` + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: IntegrationRuntimeName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +The integration runtime detail status. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSManagedIntegrationRuntime + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSSelfHostedIntegrationRuntime + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedIntegrationRuntime + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime + +## RELATED LINKS + +[Set-AzDataFactoryV2IntegrationRuntime]() + +[Remove-AzDataFactoryV2IntegrationRuntime]() diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntimeKey.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntimeKey.md new file mode 100644 index 0000000000..d47ff8c7e0 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntimeKey.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2integrationruntimekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2IntegrationRuntimeKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2IntegrationRuntimeKey.md +--- + +# Get-AzDataFactoryV2IntegrationRuntimeKey + +## SYNOPSIS +Gets keys for a self-hosted integration runtime. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Get-AzDataFactoryV2IntegrationRuntimeKey [-Name] <String> [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzDataFactoryV2IntegrationRuntimeKey [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Get-AzDataFactoryV2IntegrationRuntimeKey [-InputObject] <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get keys for an integration runtime. The keys are used to register an integration runtime node. + +## EXAMPLES + +### Example 1: Get integration runtime keys +```powershell +Get-AzDataFactoryV2IntegrationRuntimeKey -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' +``` + +```output +AuthKey1 AuthKey2 +-------- -------- +IR@89895504-f647-48fd-8dd3-42fa556d67e3****** IR@89895504-f647-48fd-8dd3-42fa556d67e3**** +``` + +The cmdlet retrieves keys for an integration runtime named 'test-selfhost-ir'. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: IntegrationRuntimeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntimeKeys + +## NOTES + +## RELATED LINKS + +[New-AzDataFactoryV2IntegrationRuntimeKey]() diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntimeMetric.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntimeMetric.md new file mode 100644 index 0000000000..4baf07a2cb --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntimeMetric.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2integrationruntimemetric +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2IntegrationRuntimeMetric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2IntegrationRuntimeMetric.md +--- + +# Get-AzDataFactoryV2IntegrationRuntimeMetric + +## SYNOPSIS +Gets metric data for an integration runtime. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Get-AzDataFactoryV2IntegrationRuntimeMetric [-Name] <String> [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzDataFactoryV2IntegrationRuntimeMetric [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Get-AzDataFactoryV2IntegrationRuntimeMetric [-InputObject] <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDataFactoryV2IntegrationRuntimeMetric cmdlet gets metric data about integration runtime in a data factory. + +## EXAMPLES + +### Example 1: Get integration runtime metric +```powershell +Get-AzDataFactoryV2IntegrationRuntimeMetric -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' +``` + +```output +IntegrationRuntimeName ResourceGroupName DataFactoryName Nodes +---------------------- ----------------- --------------- ----- +test-selfhost-ir rg-test-dfv2 test-df-eu2 {Node_1} +``` + +This command displays metric data about the integration runtime named 'test-selfhost-ir' in the subscription for the resource group named 'rg-test-dfv2' and data factory named 'test-df-eu2'. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: IntegrationRuntimeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntimeMetrics + +## NOTES + +## RELATED LINKS + +[Get-AzDataFactoryV2IntegrationRuntime]() + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntimeNode.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntimeNode.md new file mode 100644 index 0000000000..5bbf932982 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntimeNode.md @@ -0,0 +1,247 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2integrationruntimenode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2IntegrationRuntimeNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2IntegrationRuntimeNode.md +--- + +# Get-AzDataFactoryV2IntegrationRuntimeNode + +## SYNOPSIS +Gets an integration runtime node information. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Get-AzDataFactoryV2IntegrationRuntimeNode -Name <String> [-IpAddress] [-IntegrationRuntimeName] <String> + [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzDataFactoryV2IntegrationRuntimeNode -Name <String> [-IpAddress] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Get-AzDataFactoryV2IntegrationRuntimeNode -Name <String> [-IpAddress] [-InputObject] <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactoryV2IntegrationRuntimeNode** cmdlet gets the detail information of an integration runtime node. + +## EXAMPLES + +### Example 1: Gets the detail information of an integration runtime node. +```powershell +Get-AzDataFactoryV2IntegrationRuntimeNode -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -IntegrationRuntimeName 'test-selfhost-ir' -Name 'Node_1' +``` + +```output +ResourceGroupName : rg-test-dfv2 +DataFactoryName : test-df-eu2 +IntegrationRuntimeName : test-selfhost-ir +Name : Node_1 +MachineName : Test-02 +HostServiceUri : https://Test-02.redmond.corp.microsoft.com:8050/HostServiceRemote.svc/ +Status : Online +Capabilities : {[serviceBusConnected, True], [httpsPortEnabled, True], [credentialInSync, True], [connectedToResourceManager, True]...} +VersionStatus : UpToDate +Version : 3.2.6519.3 +RegisterTime : 12/1/2017 6:48:15 AM +LastConnectTime : 12/1/2017 7:35:03 AM +ExpiryTime : +LastStartTime : 12/1/2017 6:49:26 AM +LastStopTime : +LastUpdateResult : None +LastStartUpdateTime : +LastEndUpdateTime : +IsActiveDispatcher : True +ConcurrentJobsLimit : +MaxConcurrentJobs : 48 +IpAddress : +``` + +The cmdlet gets information of node named 'Node_1' in self-hosted integration runtime 'test-selfhost-ir' in data factory 'test-df-eu2'. + +### Example 2: Gets the detail information of an integration runtime node together with IP address. +```powershell +Get-AzDataFactoryV2IntegrationRuntimeNode -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -IntegrationRuntimeName 'test-selfhost-ir' -Name 'Node_1' -IpAddress +``` + +```output +ResourceGroupName : rg-test-dfv2 +DataFactoryName : test-df-eu2 +IntegrationRuntimeName : test-selfhost-ir +Name : Node_1 +MachineName : Test-02 +HostServiceUri : https://Test-02.redmond.corp.microsoft.com:8050/HostServiceRemote.svc/ +Status : Online +Capabilities : {[serviceBusConnected, True], [httpsPortEnabled, True], [credentialInSync, True], [connectedToResourceManager, True]...} +VersionStatus : UpToDate +Version : 3.2.6519.3 +RegisterTime : 12/1/2017 6:48:15 AM +LastConnectTime : 12/1/2017 7:35:03 AM +ExpiryTime : +LastStartTime : 12/1/2017 6:49:26 AM +LastStopTime : +LastUpdateResult : None +LastStartUpdateTime : +LastEndUpdateTime : +IsActiveDispatcher : True +ConcurrentJobsLimit : +MaxConcurrentJobs : 48 +IpAddress : 167.220.1.167 +``` + +The cmdlet gets information of node named 'Node_1' in self-hosted integration runtime 'test-selfhost-ir' in data factory 'test-df-eu2', including the IP address. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntegrationRuntimeName +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpAddress +The IP Address of integration runtime node. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration runtime node name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSManagedIntegrationRuntimeNode + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSSelfHostedIntegrationRuntimeNode + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime + +## RELATED LINKS + +[Get-AzDataFactoryV2IntegrationRuntime]() diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint.md new file mode 100644 index 0000000000..9cedad88a3 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint.md +--- + +# Get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint + +## SYNOPSIS +Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint [-Name] <String> + [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint [-InputObject] <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint cmdlet provides a list of outbound network dependencies for SSIS integration runtime in Azure Data Factory that joins a virtual network. + +## EXAMPLES + +### Example 1: List outbound network dependency +```powershell +Get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint -Name 'integrationRuntime1' -ResourceGroupName 'testrg' -DataFactoryName 'newtestDataFactory1' +``` + +```output +Category EndPoint +-------- -------- +Azure Data Factory (Management) [{"DomainName":"wu.frontend.clouddatahub.net","EndpointDetails":[{"Port":443}]}] +Azure Storage (Management) [{"DomainName":"*.blob.core.windows.net","EndpointDetails":[{"Port":443}]},{"DomainName":"*.table.core.windows.net","EndpointDetails":[{"Port":443}]}] +Event Hub (Logging) [{"DomainName":"*.servicebus.windows.net","EndpointDetails":[{"Port":443}]}] +``` + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: IntegrationRuntimeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint, Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2, Version=1.13.1.0, Culture=neutral, PublicKeyToken=null]] + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime + +## RELATED LINKS + +[Get-AzDataFactoryV2IntegrationRuntime]() diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2LinkedService.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2LinkedService.md new file mode 100644 index 0000000000..e4be550126 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2LinkedService.md @@ -0,0 +1,214 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2linkedservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2LinkedService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2LinkedService.md +--- + +# Get-AzDataFactoryV2LinkedService + +## SYNOPSIS +Gets information about linked services in Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryV2LinkedService [[-Name] <String>] [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryV2LinkedService [[-Name] <String>] [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzDataFactoryV2LinkedService [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDataFactoryV2LinkedService cmdlet gets information about linked services in Azure Data Factory. +If you specify the name of a linked service, this cmdlet gets information about that linked service. +If you do not specify a name, this cmdlet gets information about all the linked services in the data factory. + +## EXAMPLES + +### Example 1: Get information about all linked services +```powershell +Get-AzDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" | Format-List +``` + +```output + LinkedServiceName : LinkedServiceCuratedWikiData + ResourceGroupName : ADF + DataFactoryName : WikiADF + Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService + + LinkedServiceName : LinkedServiceHDIStorage + ResourceGroupName : ADF + DataFactoryName : WikiADF + Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService + + LinkedServiceName : LinkedServiceWikipediaClickEvents + ResourceGroupName : ADF + DataFactoryName : WikiADF + Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService +``` + +This command gets information about all linked services in the data factory named WikiADF, and then passes the linked services to the Format-List cmdlet by using the pipeline operator. +That Windows PowerShell cmdlet formats the results. +For more information, type Get-Help Format-List. +You can use either one of the following ways: + +### Example 2: Get information about a specific linked service +```powershell +Get-AzDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceCuratedWikiData" +``` + +```output + LinkedServiceName : LinkedServiceCuratedWikiData + ResourceGroupName : ADF + DataFactoryName : WikiADF + Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService +``` + +This command gets information about the linked service named LinkedServiceCuratedWikiData in the data factory named WikiADF. + +### Example 3: Get information about a specific linked service by specifying the DataFactory parameter +```powershell +$DataFactory = Get-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "ContosoFactory" +Get-AzDataFactoryV2LinkedService -DataFactory $DataFactory | Format-Table -Property Name, DataFactoryName, ResourceGroupName +``` + +```output + Name DataFactoryName ResourceGroupName + ---- --------------- ----------------- + LinkedServiceCuratedWikiData ContosoFactory ADF +``` + +The first command uses the Get-AzDataFactoryV2 cmdlet to get the data factory named ContosoFactory, and then stores it in the $DataFactory variable. +The second command gets information about the linked service for the data factory stored in $DataFactory, and then passes that information to the Format-Table cmdlet by using the pipeline operator. +The Format-Table cmdlet formats the output as a dataset with the specified properties as dataset columns. + +## PARAMETERS + +### -DataFactory +Specifies a PSDataFactory object. +This cmdlet gets linked services that belong to the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet gets linked services that belong to the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the linked service about which to get information. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName, ByFactoryObject +Aliases: LinkedServiceName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet gets linked services that belong to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Set-AzDataFactoryV2LinkedService]() + +[Remove-AzDataFactoryV2LinkedService]() diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2Pipeline.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2Pipeline.md new file mode 100644 index 0000000000..65d72d7324 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2Pipeline.md @@ -0,0 +1,256 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2pipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2Pipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2Pipeline.md +--- + +# Get-AzDataFactoryV2Pipeline + +## SYNOPSIS +Gets information about pipelines in Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryV2Pipeline [[-Name] <String>] [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryV2Pipeline [[-Name] <String>] [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzDataFactoryV2Pipeline [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDataFactoryV2Pipeline cmdlet gets information about pipelines in Azure Data Factory. +If you specify the name of a pipeline, this cmdlet gets information about that pipeline. +If you do not specify a name, this cmdlet gets information about all the pipelines in the data factory. + +## EXAMPLES + +### Example 1: Get information about all pipelines +```powershell +Get-AzDataFactoryV2Pipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF" +``` + +```output + PipelineName : DPWikisample + ResourceGroupName : ADF + DataFactoryName : WikiADF + Activities : {MyWebActivity} + Parameters : {[url, Microsoft.Azure.Management.DataFactory.Models.ParameterSpecification]} + + PipelineName : DPTwittersample + ResourceGroupName : ADF + DataFactoryName : WikiADF + Activities : {MyCopyActivity_0_0, MyCopyActivity_1_0} + Parameters : {[OutputBlobName, Microsoft.Azure.Management.DataFactory.Models.ParameterSpecification]} +``` + +This command gets information about all pipelines in the data factory named WikiADF. +You can use either one of the following example commands. +The second one uses a DataFactory object as a parameter. + +### Example 2: Get information about a specific pipeline +```powershell +Get-AzDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" | Format-List +``` + +```output + PipelineName : DPWikisample + ResourceGroupName : ADF + DataFactoryName : WikiADF + Activities : {MyCopyActivity_0_0, MyCopyActivity_1_0} + Parameters : {[OutputBlobName, Microsoft.Azure.Management.DataFactory.Models.ParameterSpecification]} +``` + +This command gets information about the pipeline named DPWikisample in the data factory named WikiADF. +The command passes that information to the Format-List cmdlet by using the pipeline operator. +That Windows PowerShell cmdlet formats the results. +For more information, type Get-Help Format-List. + +### Example 3: Get the properties for a specific pipeline +```powershell +(Get-AzDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name DPWikisample -DataFactoryName "WikiADF").Activities +``` + +```output + Source : Microsoft.Azure.Management.DataFactory.Models.BlobSource + Sink : Microsoft.Azure.Management.DataFactory.Models.BlobSink + Translator : + EnableStaging : + StagingSettings : + ParallelCopies : + CloudDataMovementUnits : + EnableSkipIncompatibleRow : + RedirectIncompatibleRowSettings : + Inputs : {} + Outputs : {} + LinkedServiceName : + Policy : + Name : MyCopyActivity_0_0 + Description : + DependsOn : + + Source : Microsoft.Azure.Management.DataFactory.Models.BlobSource + Sink : Microsoft.Azure.Management.DataFactory.Models.BlobSink + Translator : + EnableStaging : + StagingSettings : + ParallelCopies : + CloudDataMovementUnits : + EnableSkipIncompatibleRow : + RedirectIncompatibleRowSettings : + Inputs : {} + Outputs : {} + LinkedServiceName : + Policy : + Name : MyCopyActivity_1_0 + Description : + DependsOn : {Microsoft.Azure.Management.DataFactory.Models.ActivityDependency} +``` + +This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the Activities property associated with that pipeline. + +### Example 4: Get information about inputs for the first activity +```powershell +(Get-AzDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF11").Activities[0].Inputs | Format-List +``` + +```output + ReferenceName : dsIn + Parameters : +``` + +This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the Activities property associated with that pipeline. +The command displays the Inputs property of the first element of the Activities array by using the Format-List cmdlet. + +## PARAMETERS + +### -DataFactory +Specifies a PSDataFactory object. +This cmdlet gets pipelines that belong to the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet gets pipelines that belong to the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the pipeline about which to get information. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName, ByFactoryObject +Aliases: PipelineName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet gets pipelines that belong to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Set-AzDataFactoryV2Pipeline]() + +[Remove-AzDataFactoryV2Pipeline]() + +[Invoke-AzDataFactoryV2Pipeline]() diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2PipelineRun.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2PipelineRun.md new file mode 100644 index 0000000000..6d934a9b84 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2PipelineRun.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2pipelinerun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2PipelineRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2PipelineRun.md +--- + +# Get-AzDataFactoryV2PipelineRun + +## SYNOPSIS +Gets information about pipeline runs. + +## SYNTAX + +### ByFactoryNameByRunId (Default) +``` +Get-AzDataFactoryV2PipelineRun [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-PipelineRunId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObjectByRunId +``` +Get-AzDataFactoryV2PipelineRun [-DataFactory] <PSDataFactory> [-PipelineRunId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObjectByPipeline +``` +Get-AzDataFactoryV2PipelineRun [-DataFactory] <PSDataFactory> [-LastUpdatedAfter] <DateTime> + [-LastUpdatedBefore] <DateTime> [[-PipelineName] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByFactoryNameByPipeline +``` +Get-AzDataFactoryV2PipelineRun [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-LastUpdatedAfter] <DateTime> [-LastUpdatedBefore] <DateTime> [[-PipelineName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactoryV2PipelineRun** command returns information about runs for the specified pipeline. If PipelineRunId is specified, it shows details for the run with that ID. If the PipelineRunId is not specified, then it shows information about all runs for the pipelines that happened between the values of LastUpdatedAfter and LastUpdatedBefore. + +## EXAMPLES + +### Example 1: Get information for a pipeline run +```powershell +Get-AzDataFactoryV2PipelineRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineRunId "61eb095a-fe23-4591-8a97-fade6c65ca72" +``` + +```output + ResourceGroupName : ADF + DataFactoryName : WikiADF + RunId : 61eb095a-fe23-4591-8a97-fade6c65ca72 + PipelineName : DPWikisample + LastUpdated : 9/14/2017 12:21:02 AM + Parameters : {[url, http://adfsamplewebapi.azurewebsites.net/api/execute/sample]} + RunStart : 9/14/2017 12:20:54 AM + RunEnd : 9/14/2017 12:21:02 AM + DurationInMs : 8246 + Status : Succeeded + Message : +``` + +This command gets details about the pipeline run with ID "61eb095a-fe23-4591-8a97-fade6c65ca72". + +## PARAMETERS + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObjectByRunId, ByFactoryObjectByPipeline +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryNameByRunId, ByFactoryNameByPipeline +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastUpdatedAfter +The time at or after which the pipeline run was updated in ISO8601 format. + +```yaml +Type: System.DateTime +Parameter Sets: ByFactoryObjectByPipeline, ByFactoryNameByPipeline +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastUpdatedBefore +The time at or before which the pipeline run was updated in ISO8601 format. + +```yaml +Type: System.DateTime +Parameter Sets: ByFactoryObjectByPipeline, ByFactoryNameByPipeline +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineName +The pipeline name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryObjectByPipeline, ByFactoryNameByPipeline +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PipelineRunId +The Run ID of the pipeline. + +```yaml +Type: System.String +Parameter Sets: ByFactoryNameByRunId, ByFactoryObjectByRunId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryNameByRunId, ByFactoryNameByPipeline +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipelineRun + +## NOTES + +## RELATED LINKS + +[Invoke-AzDataFactoryV2Pipeline]() + +[Get-AzDataFactoryV2ActivityRun]() + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2Trigger.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2Trigger.md new file mode 100644 index 0000000000..d8c2a96f1e --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2Trigger.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2trigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2Trigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2Trigger.md +--- + +# Get-AzDataFactoryV2Trigger + +## SYNOPSIS +Gets information about triggers in a data factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryV2Trigger [[-Name] <String>] [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryV2Trigger [[-Name] <String>] [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzDataFactoryV2Trigger [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactoryV2Trigger** cmdlet gets information about triggers in a data factory. If you specify the name of a trigger, the cmdlet gets information about that trigger. If you do not specify a name, the cmdlet gets information about all triggers in the data factory. + +## EXAMPLES + +### Example 1: Get information about all triggers +```powershell +Get-AzDataFactoryV2Trigger -ResourceGroupName "ADF" -DataFactoryName "WikiADF" +``` + +```output + TriggerName : ScheduledTrigger + ResourceGroupName : ADF + DataFactoryName : WikiADF + Properties : Microsoft.Azure.Management.DataFactory.Models.ScheduleTrigger + RuntimeState : Stopped + + TriggerName : ScheduledTrigger2 + ResourceGroupName : ADF + DataFactoryName : WikiADF + Properties : Microsoft.Azure.Management.DataFactory.Models.ScheduleTrigger + RuntimeState : Stopped +``` + +Gets a list of all triggers that have been created in the data factory "WikiADF". + +### Example 2: Get information about a specific trigger +```powershell +Get-AzDataFactoryV2Trigger -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -TriggerName "ScheduledTrigger" +``` + +```output + TriggerName : ScheduledTrigger + ResourceGroupName : ADF + DataFactoryName : WikiADF + Properties : Microsoft.Azure.Management.DataFactory.Models.ScheduleTrigger + RuntimeState : Stopped +``` + +Gets a single trigger called "ScheduledTrigger" in the data factory "WikiADF". + +## PARAMETERS + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName, ByFactoryObject +Aliases: TriggerName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger + +## NOTES + +## RELATED LINKS + +[Set-AzDataFactoryV2Trigger]() + +[Start-AzDataFactoryV2Trigger]() + +[Stop-AzDataFactoryV2Trigger]() + +[Remove-AzDataFactoryV2Trigger]() diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2TriggerRun.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2TriggerRun.md new file mode 100644 index 0000000000..b5a2634202 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2TriggerRun.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2triggerrun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2TriggerRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2TriggerRun.md +--- + +# Get-AzDataFactoryV2TriggerRun + +## SYNOPSIS +Returns information about trigger runs. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryV2TriggerRun [-Name] <String> [-TriggerRunStartedAfter] <DateTime> + [-TriggerRunStartedBefore] <DateTime> [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzDataFactoryV2TriggerRun [-Name] <String> [-TriggerRunStartedAfter] <DateTime> + [-TriggerRunStartedBefore] <DateTime> [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataFactoryV2TriggerRun** command returns detailed information about trigger runs for the specified trigger in the given timeframe. + +## EXAMPLES + +### Example 1: Get information about trigger run +```powershell +Get-AzDataFactoryV2TriggerRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -TriggerName "WikiTrigger" -TriggerRunStartedAfter "2017-09-01" -TriggerRunStartedBefore "2019-09-30" +``` + +```output + ResourceGroupName : ADF + DataFactoryName : WikiADF + TriggerName : WikiTrigger + TriggerRunId : 08586958400454144995526033731 + TriggerType : ScheduleTrigger + TriggerRunTimestamp : 9/18/2017 8:34:00 PM + Status : Succeeded +``` + +This command shows information about runs for "WikiTrigger" in the factory "WikiADF" that started between "2017-09-01" and "2019-09-30". + +## PARAMETERS + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TriggerName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TriggerRunStartedAfter +The time at or after which the trigger run started to execute in ISO8601 format. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerRunStartedBefore +The time at or before which the trigger run started to execute in ISO8601 format. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTriggerRun + +## NOTES + +## RELATED LINKS + +[Start-AzDataFactoryV2Trigger]() + +[Stop-AzDataFactoryV2Trigger]() + diff --git a/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2TriggerSubscriptionStatus.md b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2TriggerSubscriptionStatus.md new file mode 100644 index 0000000000..5c764f5806 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Get-AzDataFactoryV2TriggerSubscriptionStatus.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2triggersubscriptionstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2TriggerSubscriptionStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2TriggerSubscriptionStatus.md +--- + +# Get-AzDataFactoryV2TriggerSubscriptionStatus + +## SYNOPSIS +Get the status of the subscription for the event trigger to the specified external service events. + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzDataFactoryV2TriggerSubscriptionStatus [-Name] <String> [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObject +``` +Get-AzDataFactoryV2TriggerSubscriptionStatus [-InputObject] <PSTrigger> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzDataFactoryV2TriggerSubscriptionStatus [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +This command gets the status of the subscription for the event trigger to the specified external service events. The trigger can't be started until the returned status is "Enabled". + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataFactoryV2TriggerSubscriptionStatus -ResourceGroupName ADF -DataFactoryName WikiADF -Name Trigger1 +``` + +```output +TriggerName Status +----------- ------ +Trigger1 Enabled +``` + +This command will get the status of the subscribtion for BlobEnetTrigger1 trigger to the external service events. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The trigger object. + +```yaml +Type: PSTrigger +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: String +Parameter Sets: ByFactoryName +Aliases: TriggerName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTriggerSubscriptionStatus + +## NOTES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataFactory/Invoke-AzDataFactoryV2DataFlowDebugSessionCommand.md b/azps-10.1.0/Az.DataFactory/Invoke-AzDataFactoryV2DataFlowDebugSessionCommand.md new file mode 100644 index 0000000000..3ec848a340 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Invoke-AzDataFactoryV2DataFlowDebugSessionCommand.md @@ -0,0 +1,321 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/invoke-azdatafactoryv2dataflowdebugsessioncommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Invoke-AzDataFactoryV2DataFlowDebugSessionCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Invoke-AzDataFactoryV2DataFlowDebugSessionCommand.md +--- + +# Invoke-AzDataFactoryV2DataFlowDebugSessionCommand + +## SYNOPSIS +Invoke debug action in data flow debug session. + +## SYNTAX + +### ByFactoryName (Default) +``` +Invoke-AzDataFactoryV2DataFlowDebugSessionCommand [-SessionId] <String> [-Command] <String> + [-StreamName] <String> [[-RowLimit] <Int32>] [[-Expression] <String>] + [[-Columns] <System.Collections.Generic.List`1[System.String]>] [-AsJob] [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByFactoryObject +``` +Invoke-AzDataFactoryV2DataFlowDebugSessionCommand [-SessionId] <String> [-Command] <String> + [-StreamName] <String> [[-RowLimit] <Int32>] [[-Expression] <String>] + [[-Columns] <System.Collections.Generic.List`1[System.String]>] [-AsJob] [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Invoke-AzDataFactoryV2DataFlowDebugSessionCommand [-SessionId] <String> [-Command] <String> + [-StreamName] <String> [[-RowLimit] <Int32>] [[-Expression] <String>] + [[-Columns] <System.Collections.Generic.List`1[System.String]>] [-AsJob] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command executes data preview/stats preview/expression preview for different stream of data flow in debug session. +The PowerShell command sequence for data flow debug workflow should be: +1. Start-AzDataFactoryV2DataFlowDebugSession +1. Add-AzDataFactoryV2DataFlowDebugSessionPackage +1. Invoke-AzDataFactoryV2DataFlowDebugSessionCommand (repeat this step for different commands/targets, or repeat step 2-3 in order to change the package file) +1. Stop-AzDataFactoryV2DataFlowDebugSession + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> +```powershell +$result = Invoke-AzDataFactoryV2DataFlowDebugSessionCommand -ResourceGroupName adf -DataFactoryName WiKiADF -Command executePreviewQuery -SessionId fd76cd0d-8b37-4dc0-a370-3f9d43ac686d -StreamName source1 -RowLimit 100 -AsJob +$result + +Id Name PSJobTypeName State HasMoreData Location Command +-- ---- ------------- ----- ----------- -------- ------- +3 Long Running... AzureLongRun... Running True localhost Invoke-AzDataFactoryV2... + + +(After 2 minutes) + +$result + +Id Name PSJobTypeName State HasMoreData Location Command +-- ---- ------------- ----- ----------- -------- ------- +3 Long Running... AzureLongRun... Completed True localhost Invoke-AzDataFactoryV2... + +$output = ConvertFrom-Json($result.Output.Data) +$output.output + + { + "schema": "output(ResourceAgencyNum as string, PublicName as string)" , + "data": [["4445679354", "Syrian Refugee Information", 1], ["44456793", "Syrian Refugee Information", 1]] + } + + +``` + +This example invokes data preview command for debug session "fd76cd0d-8b37-4dc0-a370-3f9d43ac686d" in data factory "WiKiADF" and then convert the JSON output into readable string. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Columns +The columns list for data flow statistics preview. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Command +The data flow debug command. Optionals are executePreviewQuery, executeStatisticsQuery and executeExpressionQuery + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expression +The expression for data flow expression preview. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RowLimit +The row limit for data flow data preview. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionId +The data flow debug session ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamName +The stream name of data flow for debugging. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFlowDebugSessionCommandResult + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factoriesKeywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Start-AzDataFactoryV2DataFlowDebugSession](./Start-AzDataFactoryV2DataFlowDebugSession.md) + +[Get-AzDataFactoryV2DataFlowDebugSession](./Get-AzDataFactoryV2DataFlowDebugSession.md) + +[Add-AzDataFactoryV2DataFlowDebugSessionPackage](./Add-AzDataFactoryV2DataFlowDebugSessionPackage.md) + +[Stop-AzDataFactoryV2DataFlowDebugSession](./Stop-AzDataFactoryV2DataFlowDebugSession.md) diff --git a/azps-10.1.0/Az.DataFactory/Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade.md b/azps-10.1.0/Az.DataFactory/Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade.md new file mode 100644 index 0000000000..b9dc63dcfa --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/invoke-azdatafactoryv2integrationruntimeupgrade +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade.md +--- + +# Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade + +## SYNOPSIS +Upgrades self-hosted integration runtime. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade [-Name] <String> [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade [-InputObject] <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade** cmdlet upgrades self-hosted integration runtime if the new version is available. + +## EXAMPLES + +### Example 1: Upgrades a self-hosted integration runtime +```powershell +Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' +``` + +The cmdlet upgrades self-hosted integration runtime named 'test-selfhost-ir' in data factory 'test-df-eu2'. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: IntegrationRuntimeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### System.Void + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime + +## RELATED LINKS + +[Set-AzDataFactoryV2IntegrationRuntime]() +[Get-AzDataFactoryV2IntegrationRuntime]() + diff --git a/azps-10.1.0/Az.DataFactory/Invoke-AzDataFactoryV2Pipeline.md b/azps-10.1.0/Az.DataFactory/Invoke-AzDataFactoryV2Pipeline.md new file mode 100644 index 0000000000..ac69a894d4 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Invoke-AzDataFactoryV2Pipeline.md @@ -0,0 +1,291 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/invoke-azdatafactoryv2pipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Invoke-AzDataFactoryV2Pipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Invoke-AzDataFactoryV2Pipeline.md +--- + +# Invoke-AzDataFactoryV2Pipeline + +## SYNOPSIS + Invokes a pipeline to start a run for it. + +## SYNTAX + +### ByFactoryNameByParameterFile (Default) +``` +Invoke-AzDataFactoryV2Pipeline [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-PipelineName] <String> [[-ParameterFile] <String>] [[-ReferencePipelineRunId] <String>] [-IsRecovery] + [[-StartActivityName] <String>] [-StartFromFailure] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByPipelineObjectByParameterFile +``` +Invoke-AzDataFactoryV2Pipeline [-InputObject] <PSPipeline> [[-ParameterFile] <String>] + [[-ReferencePipelineRunId] <String>] [-IsRecovery] [[-StartActivityName] <String>] [-StartFromFailure] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByPipelineObjectByParameterObject +``` +Invoke-AzDataFactoryV2Pipeline [-InputObject] <PSPipeline> [[-Parameter] <Hashtable>] + [[-ReferencePipelineRunId] <String>] [-IsRecovery] [[-StartActivityName] <String>] [-StartFromFailure] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryNameByParameterObject +``` +Invoke-AzDataFactoryV2Pipeline [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-PipelineName] <String> [[-Parameter] <Hashtable>] [[-ReferencePipelineRunId] <String>] [-IsRecovery] + [[-StartActivityName] <String>] [-StartFromFailure] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzDataFactoryV2Pipeline** command starts a run on the specified pipeline and returns a ID for that run. This GUID can be passed to **Get-AzDataFactoryV2PipelineRun** or **Get-AzDataFactoryV2ActivityRun** to obtain further details about this run. + +## EXAMPLES + +### Example 1: Invoke a pipeline to start a run +```powershell +Invoke-AzDataFactoryV2Pipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineName "DPWikisample" +``` + +```output +867d9d9f-1efc-4fee-974d-d8e6320bfbcb +``` + +This command starts a run for "DPWikisample" pipeline in the "WikiADF" factory. + +### Example 2 + +Invokes a pipeline to start a run for it. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Invoke-AzDataFactoryV2Pipeline -DataFactoryName 'WikiADF' -Parameter <Hashtable> -PipelineName 'DPWikisample' -ResourceGroupName 'ADF' +``` + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryNameByParameterFile, ByFactoryNameByParameterObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline +Parameter Sets: ByPipelineObjectByParameterFile, ByPipelineObjectByParameterObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsRecovery +Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameter +Parameters for pipeline run. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByPipelineObjectByParameterObject, ByFactoryNameByParameterObject +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParameterFile +The name of the file with parameters for pipeline run. + +```yaml +Type: System.String +Parameter Sets: ByFactoryNameByParameterFile, ByPipelineObjectByParameterFile +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PipelineName +The pipeline name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryNameByParameterFile, ByFactoryNameByParameterObject +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReferencePipelineRunId +The pipeline run ID for rerun. If run ID is specified, the parameters of the specified run will be used to create a new run. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryNameByParameterFile, ByFactoryNameByParameterObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartActivityName +In recovery mode, the rerun will start from this activity. If not specified, all activities will run. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartFromFailure +Start rerun from failed activities flag. In recovery mode, if specified, the rerun will start from failed activities. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzDataFactoryV2PipelineRun]() + +[Get-AzDataFactoryV2ActivityRun]() + diff --git a/azps-10.1.0/Az.DataFactory/Invoke-AzDataFactoryV2TriggerRun.md b/azps-10.1.0/Az.DataFactory/Invoke-AzDataFactoryV2TriggerRun.md new file mode 100644 index 0000000000..9c035ea208 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Invoke-AzDataFactoryV2TriggerRun.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/invoke-azdatafactoryv2triggerrun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Invoke-AzDataFactoryV2TriggerRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Invoke-AzDataFactoryV2TriggerRun.md +--- + +# Invoke-AzDataFactoryV2TriggerRun + +## SYNOPSIS + Invokes another instance of a trigger run. + +## SYNTAX + +### ByFactoryNameByParameterFile (Default) +``` +Invoke-AzDataFactoryV2TriggerRun [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObject +``` +Invoke-AzDataFactoryV2TriggerRun [-InputObject] <PSTriggerRun> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryName +``` +Invoke-AzDataFactoryV2TriggerRun [-TriggerName] <String> [-TriggerRunId] <String> [-PassThru] + [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Invoke-AzDataFactoryV2TriggerRun [-TriggerName] <String> [-TriggerRunId] <String> [-PassThru] + [-DataFactory] <PSDataFactory> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzDataFactoryV2TriggerRun** command starts another instance of a trigger run with a new trigger run id. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzDataFactoryV2TriggerRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -TriggerName "testTumblingWindowTrigger" -TriggerRunId 08586002468005888497807248799CU16 +``` +Starts another instance of a trigger run with a new trigger run id, keeping the same windowStartTime and windowEndTime as the original trigger run. + +## PARAMETERS + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The information about the trigger run. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSTriggerRun +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified the cmdlet write true in case operation succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TriggerName +The trigger name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName, ByFactoryObject +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TriggerRunId +The Run ID of the trigger. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName, ByFactoryObject +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTriggerRun + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataFactory/New-AzDataFactory.md b/azps-10.1.0/Az.DataFactory/New-AzDataFactory.md new file mode 100644 index 0000000000..8c3916c28f --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/New-AzDataFactory.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 7B18FA1B-F616-4479-B2F0-620FC0E3E962 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactory.md +--- + +# New-AzDataFactory + +## SYNOPSIS +Creates a data factory. + +## SYNTAX + +``` +New-AzDataFactory [-Name] <String> [-Location] <String> [[-Tag] <Hashtable>] [-Force] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataFactory** cmdlet creates a data factory with the specified resource group name and location. +Perform these operations in the following order: +- Create a data factory. +- Create linked services. +- Create datasets. +- Create a pipeline. + +## EXAMPLES + +### Example 1: Create a data factory +```powershell +New-AzDataFactory -ResourceGroupName "ADF" -Name "WikiADF" -Location "WestUS" +``` + +```output +DataFactoryName : WikiADF +ResourceGroupName : ADF +Location : WestUS +Tags : {} +Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration +``` + +This command creates a data factory named WikiADF in the resource group named ADF in the WestUS location. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet replaces an existing data factory without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location for the data factory, such as WestUS or EastUS. +Only WestUS is currently supported. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the data factory to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet creates a data factory that belongs to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The tags of the data factory. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactory](./Get-AzDataFactory.md) + +[Remove-AzDataFactory](./Remove-AzDataFactory.md) + + diff --git a/azps-10.1.0/Az.DataFactory/New-AzDataFactoryDataset.md b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryDataset.md new file mode 100644 index 0000000000..48dcdbac4d --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryDataset.md @@ -0,0 +1,282 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 352A4B94-E433-413B-91D1-6AA347563959 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactorydataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryDataset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryDataset.md +--- + +# New-AzDataFactoryDataset + +## SYNOPSIS +Creates a dataset in Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +New-AzDataFactoryDataset [-DataFactoryName] <String> [[-Name] <String>] [-File] <String> [-Force] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByFactoryObject +``` +New-AzDataFactoryDataset [-DataFactory] <PSDataFactory> [[-Name] <String>] [-File] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataFactoryDataset** cmdlet creates a dataset in Azure Data Factory. +If you specify a name for a dataset that already exists, this cmdlet prompts you for confirmation before it replaces the dataset. +If you specify the *Force* parameter, the cmdlet replaces the existing dataset without confirmation. +Perform these operations in the following order: +- Create a data factory. +- Create linked services. +- Create datasets. +- Create a pipeline. +If a dataset with the same name already exists in the data factory, this cmdlet prompts you to confirm whether to overwrite the existing dataset with the new dataset. +If you confirm to overwrite the existing dataset, the dataset definition is also replaced. + +## EXAMPLES + +### Example 1: Create a dataset +```powershell +New-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -File "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json" +``` + +```output +DatasetName : DAWikipediaClickEvents +ResourceGroupName : ADF +DataFactoryName : WikiADF +Availability : Microsoft.DataFactories.Availability +Location : Microsoft.DataFactories.AzureBlobLocation +Policy : Microsoft.DataFactories.Policy +Structure : {} +``` + +This command creates a dataset named DA_WikipediaClickEvents in the data factory named WikiADF. +The command bases the dataset on information in the DAWikipediaClickEvents.json file. + +### Example 2: View availability for a new dataset +```powershell +$Dataset = New-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -File "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json" +$Dataset.Availability +``` + +```output +AnchorDateTime : +Frequency : Hour +Interval : 1 +Offset : +WaitOnExternal : Microsoft.DataFactories.WaitOnExternal +``` + +The first command creates a dataset named DA_WikipediaClickEvents, as in a previous example, and then assigns that dataset to the $Dataset variable. +The second command uses standard dot notation to display details about the Availability property of the dataset. + +### Example 3: View location for a new dataset +```powershell +$Dataset = New-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -File "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json" +$Dataset.Location +``` + +```output +BlobPath : wikidatagateway/wikisampledatain/ +FilenamePrefix : +Format : +LinkedServiceName : LinkedServiceWikipediaClickEvents +PartitionBy : {} +``` + +The first command creates a dataset named DA_WikipediaClickEvents, as in a previous example, and then assigns that dataset to the $Dataset variable. +The second command displays details about the Location property of the dataset. + +### Example 4: View validation rules for a new dataset +```powershell +$Dataset = New-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -File "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json" +$Dataset.Policy.Validation | Format-List $dataset.Location +``` + +```output +BlobPath : wikidatagateway/wikisampledatain/ +FilenamePrefix : +Format : +LinkedServiceName : LinkedServiceWikipediaClickEvents +PartitionBy : {} + +MinimumRows : +MinimumSizeMB : 1 +``` + +The first command creates a dataset named DA_WikipediaClickEvents, as in a previous example, and then assigns that dataset to the $Dataset variable. +The second command gets details about the validation rules for the dataset, and then passes them to the Format-List cmdlet by using the pipeline operator. +That Windows PowerShell cmdlet formats the results. +For more information, type `Get-Help Format-List`. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet creates a dataset in the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet creates a dataset in the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the dataset. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet replaces an existing dataset without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the dataset to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet creates a dataset in the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataset + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryDataset](./Get-AzDataFactoryDataset.md) + +[Remove-AzDataFactoryDataset](./Remove-AzDataFactoryDataset.md) + + diff --git a/azps-10.1.0/Az.DataFactory/New-AzDataFactoryEncryptValue.md b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryEncryptValue.md new file mode 100644 index 0000000000..d8644f405f --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryEncryptValue.md @@ -0,0 +1,323 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 5BF24BC2-DEB6-4830-BDEA-841BAB070388 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactoryencryptvalue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryEncryptValue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryEncryptValue.md +--- + +# New-AzDataFactoryEncryptValue + +## SYNOPSIS +Encrypts sensitive data. + +## SYNTAX + +### ByFactoryName (Default) +``` +New-AzDataFactoryEncryptValue [-DataFactoryName] <String> [[-Value] <SecureString>] [-GatewayName] <String> + [[-Credential] <PSCredential>] [[-Type] <String>] [[-NonCredentialValue] <String>] + [[-AuthenticationType] <String>] [[-Server] <String>] [[-Database] <String>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +New-AzDataFactoryEncryptValue [-DataFactory] <PSDataFactory> [[-Value] <SecureString>] [-GatewayName] <String> + [[-Credential] <PSCredential>] [[-Type] <String>] [[-NonCredentialValue] <String>] + [[-AuthenticationType] <String>] [[-Server] <String>] [[-Database] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataFactoryEncryptValue** cmdlet encrypts sensitive data, such as a password or a Microsoft SQL Server connection string, and returns an encrypted value. + +## EXAMPLES + +### Example 1: Encrypt a non-ODBC connection string +```powershell +$Value = ConvertTo-SecureString 'Data Source=ContosoServer;Initial Catalog=catalog;user id =user123;password=password123' -AsPlainText -Force +New-AzDataFactoryEncryptValue -GatewayName "WikiGateway" -DataFactoryName "WikiAdf" -Value $value -ResourceGroupName "ADF" -Type OnPremisesSqlLinkedService +``` + +The first command uses the ConvertTo-SecureString cmdlet to convert the specified connection string to a **SecureString** object, and then stores that object in the $Value variable. +For more information, type `Get-Help ConvertTo-SecureString`. +Allowed values: SQL Server or Oracle connection string. +The second command creates an encrypted value for the object stored in $Value for the specified data factory, gateway, resource group, and linked service type. + +### Example 2: Encrypt a non-ODBC connection string that uses Windows authentication. +```powershell +$Value = ConvertTo-SecureString 'Data Source=ContosoServer;Initial Catalog=catalog;Integrated Security=True' -AsPlainText -Force +$Credential = Get-Credential +New-AzDataFactoryEncryptValue -DataFactoryName "WikiADF" -GatewayName "WikiGateway" -ResourceGroupName "ADF" -Value $Value -Credential $Credential -Type OnPremisesSqlLinkedService +``` + +The first command uses **ConvertTo-SecureString** to convert the specified connection string to a secure string object, and then stores that object in the $Value variable. +The second command uses the Get-Credential cmdlet to collect the windows authentication (user name and password), and then stores that **PSCredential** object in the $Credential variable. +For more information, type `Get-Help Get-Credential`. +The third command creates an encrypted value for the object stored in $Value and $Credential for the specified data factory, gateway, resource group, and linked service type. + +### Example 3: Encrypt server name and credentials for File system linked service +```powershell +$Value = ConvertTo-SecureString '\\servername' -AsPlainText -Force +$Credential = Get-Credential +New-AzDataFactoryEncryptValue -DataFactoryName "WikiADF" -GatewayName "WikiGateway" -ResourceGroupName "ADF" -Value $Value -Credential $Credential -Type OnPremisesFileSystemLinkedService +``` + +The first command uses **ConvertTo-SecureString** to convert the specified string to a secure string, and then stores that object in the $Value variable. +The second command uses **Get-Credential** to collect the Windows authentication (user name and password), and then stores that **PSCredential** object in the $Credential variable. +The third command creates an encrypted value for the object stored in $Value and $Credential for the specified data factory, gateway, resource group, and linked service type. + +### Example 4: Encrypt credentials for HDFS linked service +```powershell +$UserName = ConvertTo-SecureString "domain\\username" -AsPlainText -Force +$Password = ConvertTo-SecureString "password" -AsPlainText -Force +$Credential = New-Object System.Management.Automation.PSCredential ($UserName, $Password) +New-AzDataFactoryEncryptValue -DataFactoryName "MyDataFactory" -ResourceGroupName "MyResourceGroup" -GatewayName "MyDataManagementGateway" -Type HdfsLinkedService -AuthenticationType Windows -Credential $Credential -NonCredentialValue "http://server01.com:50070/webhdfs/v1/user/username" +``` + +The **ConvertTo-SecureString** command converts the specified string to a secure string. +The **New-Object** command creates a PSCredential object using the secure username and password strings. +Instead, you could use the **Get-Credential** command to collect Windows authentication (user name and password), and then store the returned **PSCredential** object in the $credential variable as shown in previous examples. +The **New-AzDataFactoryEncryptValue** command creates an encrypted value for the object stored in $Credential for the specified data factory, gateway, resource group, and linked service type. + +### Example 5: Encrypt credentials for ODBC linked service +```powershell +$Content = ConvertTo-SecureString "UID=username@contoso;PWD=password;" -AsPlainText -Force +New-AzDataFactoryEncryptValue -ResourceGroupName $RGName -DataFactoryName $DFName -GatewayName $Gateway -Type OnPremisesOdbcLinkedService -AuthenticationType Basic -NonCredentialValue "Driver={SQL Server};Server=server01.database.contoso.net; Database=HDISScenarioTest;" -Value $content +``` + +The **ConvertTo-SecureString** command converts the specified string to a secure string. +The **New-AzDataFactoryEncryptValue** command creates an encrypted value for the object stored in $Value for the specified data factory, gateway, resource group, and linked service type. + +## PARAMETERS + +### -AuthenticationType +Specifies the type of authentication to be used to connect to the data source. +The acceptable values for this parameter are: +- Windows +- Basic +- Anonymous. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Windows, Basic, Anonymous + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Specifies the Windows authentication credentials (user name and password) to be used. +This cmdlet encrypts the credential data you specify here. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database +Specifies the database name of the linked service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet encrypts data for the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet encrypts data for the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayName +Specifies the name of the gateway. +This cmdlet encrypts data for the gateway that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NonCredentialValue +Specifies the non-credential part of the Open Database Connectivity (ODBC) connection string. +This parameter is applicable only for the ODBC linked service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet encrypts data for the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Server +Specifies the server name of the linked service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specifies the linked service type. +This cmdlet encrypts data for the linked service type that this parameter specifies. +The acceptable values for this parameter are: +- OnPremisesSqlLinkedService +- OnPremisesFileSystemLinkedService +- OnPremisesOracleLinkedService +- OnPremisesOdbcLinkedService +- OnPremisesPostgreSqlLinkedService +- OnPremisesTeradataLinkedService +- OnPremisesMySQLLinkedService +- OnPremisesDB2LinkedService +- OnPremisesSybaseLinkedService + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: OnPremisesSqlLinkedService, OnPremisesFileSystemLinkedService, OnPremisesOracleLinkedService, OnPremisesOdbcLinkedService, OnPremisesPostgreSqlLinkedService, OnPremisesTeradataLinkedService, OnPremisesMySQLLinkedService, OnPremisesDB2LinkedService, OnPremisesSybaseLinkedService, HdfsLinkedService + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Specifies the value to encrypt. +For an on-premises SQL Server linked service and an on-premises Oracle linked service, use a connection string. +For an on-premises ODBC linked service, use the credential part of the connection string. +For on premises file system linked service, if the file system is local to the gateway computer, use Local or localhost, and if the file system is on a server different from the gateway computer, use \\\\servername. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### System.String + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[New-AzDataFactoryEncryptValue](./New-AzDataFactoryEncryptValue.md) + + diff --git a/azps-10.1.0/Az.DataFactory/New-AzDataFactoryGateway.md b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryGateway.md new file mode 100644 index 0000000000..3324560ddc --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryGateway.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 4DCF54BA-CFFA-4555-8CA3-66B98F704EFB +online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactorygateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryGateway.md +--- + +# New-AzDataFactoryGateway + +## SYNOPSIS +Creates a gateway for an Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +New-AzDataFactoryGateway [-DataFactoryName] <String> [-Name] <String> [[-Description] <String>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +New-AzDataFactoryGateway [-DataFactory] <PSDataFactory> [-Name] <String> [[-Description] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataFactoryGateway** cmdlet creates a gateway in Azure Data Factory. + +## EXAMPLES + +### Example 1: Create a gateway +```powershell +New-AzDataFactoryGateway -ResourceGroupName "ADF" -Name "ContosoGateway" -DataFactoryName "WikiADF" -Description "my gateway" +``` + +```output +Name : ContosoGateway +Description : my gateway +Version : +Status : NeedRegistration +VersionStatus : None +CreateTime : 8/22/2014 1:40:34 AM +RegisterTime : +LastConnectTime : +ExpiryTime : +ProvisioningState : Succeeded +Key : ADF#40cbb3d9-2736-4794-a8a6-e6b839b4894f@a2d875ce-c9d7-4b8b-ad65-dd3ebbb9a940@8c0d1801-e863-44af-82e6-fb2f0c00f2ae@xz#Y9R0NhAeH3u7wgnrJyiWj4Y/QIhH4fFilIdzZgwsVQA= +``` + +This command creates a gateway named ContosoGateway in the data factory named WikiADF in the resource group named ADF. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet creates a gateway for the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet creates a gateway for the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the gateway to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet creates a gateway that belongs to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactoryGateway + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Remove-AzDataFactoryGateway](./Remove-AzDataFactoryGateway.md) + +[Set-AzDataFactoryGateway](./Set-AzDataFactoryGateway.md) + + diff --git a/azps-10.1.0/Az.DataFactory/New-AzDataFactoryGatewayAuthKey.md b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryGatewayAuthKey.md new file mode 100644 index 0000000000..2f0a6603f8 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryGatewayAuthKey.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactorygatewayauthkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryGatewayAuthKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryGatewayAuthKey.md +--- + +# New-AzDataFactoryGatewayAuthKey + +## SYNOPSIS +Creates auth key for an Azure Data Factory Gateway. + +## SYNTAX + +### ByFactoryName (Default) +``` +New-AzDataFactoryGatewayAuthKey [-DataFactoryName] <String> [-GatewayName] <String> [-KeyName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByFactoryObject +``` +New-AzDataFactoryGatewayAuthKey [-InputObject] <PSDataFactory> [-GatewayName] <String> [-KeyName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataFactoryGatewayAuthKey** cmdlet creates gateway auth key for a specified Azure Data Factory gateway. +You register the gateway with a cloud service by using this key. + +## EXAMPLES + +### Example 1: Creates a gateway auth key for Key1 +```powershell +New-AzDataFactoryGatewayAuthKey -ResourceGroupName ADFResource -GatewayName 'MyGateway' -DataFactoryName MyADF -KeyName key1 +``` + +```output +Key1 : DMG@632e739e-1053-4070-9102-8591f067526e@41fcbc45-c594-4152-a8f1-fcbcd6452aea@wu@BH0EV9hu/o2IYGQzfYYD203XhdS6Tty + fkYwYFbG6wBU= +Key2 : +``` + +This command creates a gateway auth key of Key1 for the data factory gateway named MyGateway. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayName +The data factory gateway name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The data factory object + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: DataFactory + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +The name of gateway auth key to be regenerated, either 'key1' or 'key2'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: key1, key2 + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactoryGatewayAuthKey + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[New-AzDataFactoryGateway](./New-AzDataFactoryGateway.md) +[Get-AzDataFactoryGatewayAuthKey](./Get-AzDataFactoryGatewayAuthKey.md) + diff --git a/azps-10.1.0/Az.DataFactory/New-AzDataFactoryHub.md b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryHub.md new file mode 100644 index 0000000000..7c8b54deb2 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryHub.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: B656B4C4-97DE-4F9F-937C-E115CB3F0E80 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactoryhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryHub.md +--- + +# New-AzDataFactoryHub + +## SYNOPSIS +Creates a hub for an Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +New-AzDataFactoryHub [-Name] <String> [-File] <String> [-Force] [-DataFactoryName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByFactoryObject +``` +New-AzDataFactoryHub [-Name] <String> [-File] <String> [-Force] [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataFactoryHub** cmdlet creates a hub for Azure Data Factory in the specified Azure resource group and in the specified data factory with the specified file definition. +After you create the hub, you can use it to store and manage linked services in a group, and you can add pipelines to the hub. + +## EXAMPLES + +### Example 1: Create a hub +```powershell +New-AzDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -Name "ContosoDataHub" -File "C:\Hub.json" +``` + +This command creates a hub named ContosoDataHub in the resource group ADFResourceGroup and the data factory named ADFDataFactory. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet creates a hub for the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet creates a hub for the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet replaces an existing hub without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the hub to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet creates a hub that belongs to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSHub + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryHub](./Get-AzDataFactoryHub.md) + +[Remove-AzDataFactoryHub](./Remove-AzDataFactoryHub.md) + + diff --git a/azps-10.1.0/Az.DataFactory/New-AzDataFactoryLinkedService.md b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryLinkedService.md new file mode 100644 index 0000000000..0ed83db0c3 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryLinkedService.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 8CD2BE3E-2FA1-4EAB-BC01-B1E1E3203FF1 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactorylinkedservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryLinkedService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryLinkedService.md +--- + +# New-AzDataFactoryLinkedService + +## SYNOPSIS +Links a data store or a cloud service to an Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +New-AzDataFactoryLinkedService [-DataFactoryName] <String> [[-Name] <String>] [-File] <String> [-Force] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByFactoryObject +``` +New-AzDataFactoryLinkedService [-DataFactory] <PSDataFactory> [[-Name] <String>] [-File] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataFactoryLinkedService** cmdlet links a data store or a cloud service to Azure Data Factory. +If you specify a name for a linked service that already exists, this cmdlet prompts you for confirmation before it replaces the linked service. +If you specify the *Force* parameter, the cmdlet replaces the existing linked service without confirmation. +Perform these operations in the following order: +- Create a data factory. +- Create linked services. +- Create datasets. +- Create a pipeline. + +## EXAMPLES + +### Example 1: Create a linked service +```powershell +New-AzDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceCuratedWikiData" -File "C:\\samples\\WikiSample\\LinkedServiceCuratedWikiData.json" | Format-List +``` + +```output +LinkedServiceName : LinkedServiceCuratedWikiData +ResourceGroupName : ADF +DataFactoryName : WikiADF +Properties : Microsoft.DataFactories.AzureStorageLinkedService +``` + +This command creates a linked service named LinkedServiceCuratedWikiData in the data factory named WikiADF. +This linked service links an Azure blob store specified in the file to the data factory named WikiADF. +The command passes the result to the Format-List cmdlet by using the pipeline operator. +That Windows PowerShell cmdlet formats the results. +For more information, type `Get-Help Format-List`. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet creates a linked service for the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet creates a linked service for the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the linked service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet replaces an existing linked service without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the linked service to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet creates a linked service for the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSLinkedService + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryLinkedService](./Get-AzDataFactoryLinkedService.md) + +[Remove-AzDataFactoryLinkedService](./Remove-AzDataFactoryLinkedService.md) + + diff --git a/azps-10.1.0/Az.DataFactory/New-AzDataFactoryPipeline.md b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryPipeline.md new file mode 100644 index 0000000000..28da64b33f --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryPipeline.md @@ -0,0 +1,230 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 30C1AF6C-A8DC-4CA0-9E5F-10641A29D0E8 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactorypipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryPipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryPipeline.md +--- + +# New-AzDataFactoryPipeline + +## SYNOPSIS +Creates a pipeline in Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +New-AzDataFactoryPipeline [[-Name] <String>] [-DataFactoryName] <String> [-File] <String> [-Force] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByFactoryObject +``` +New-AzDataFactoryPipeline [[-Name] <String>] [-DataFactory] <PSDataFactory> [-File] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataFactoryPipeline** cmdlet creates a pipeline in Azure Data Factory. +If you specify a name for a pipeline that already exists, the cmdlet prompts you for confirmation before it replaces the pipeline. +If you specify the *Force* parameter, the cmdlet replaces the existing pipeline without confirmation. +Perform these operations in the following order: +- Create a data factory. +- Create linked services. +- Create datasets. +- Create a pipeline. +If a pipeline with the same name already exists in the data factory, this cmdlet prompts you to confirm whether to overwrite the existing pipeline with the new pipeline. +If you confirm to overwrite the existing pipeline, the pipeline definition is also replaced. + +## EXAMPLES + +### Example 1: Create a pipeline +```powershell +New-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" -File "C:\DPWikisample.json" +``` + +```output +PipelineName : DPWikisample +ResourceGroupName : ADF +DataFactoryName : WikiADF11 +Properties : Microsoft.DataFactories.PipelineProperties +``` + +This command creates a pipeline named DPWikisample in the data factory named ADF. +The command bases the pipeline on information in the DPWikisample.json file. +This file includes information about activities such as Copy Activity and HDInsight Activity in the pipeline. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet creates a pipeline for the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet creates a pipeline for the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the pipeline. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet replaces an existing pipeline without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the pipeline to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet creates a pipeline for the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSPipeline + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryPipeline](./Get-AzDataFactoryPipeline.md) + +[Remove-AzDataFactoryPipeline](./Remove-AzDataFactoryPipeline.md) + +[Resume-AzDataFactoryPipeline](./Resume-AzDataFactoryPipeline.md) + +[Set-AzDataFactoryPipelineActivePeriod](./Set-AzDataFactoryPipelineActivePeriod.md) + +[Suspend-AzDataFactoryPipeline](./Suspend-AzDataFactoryPipeline.md) + + diff --git a/azps-10.1.0/Az.DataFactory/New-AzDataFactoryV2IntegrationRuntimeKey.md b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryV2IntegrationRuntimeKey.md new file mode 100644 index 0000000000..bc79d4a892 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryV2IntegrationRuntimeKey.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactoryv2integrationruntimekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryV2IntegrationRuntimeKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryV2IntegrationRuntimeKey.md +--- + +# New-AzDataFactoryV2IntegrationRuntimeKey + +## SYNOPSIS +Regenerate self-hosted integration runtime key. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +New-AzDataFactoryV2IntegrationRuntimeKey -KeyName <String> [-Force] [-Name] <String> + [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +New-AzDataFactoryV2IntegrationRuntimeKey -KeyName <String> [-Force] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +New-AzDataFactoryV2IntegrationRuntimeKey -KeyName <String> [-Force] [-InputObject] <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The cmdlet **New-AzDataFactoryV2IntegrationRuntimeKey** regenerates the integration runtime key with the key name specified by 'KeyName' parameter. The previous key will is invalid. + +## EXAMPLES + +### Example 1: Generate a new key for an integration runtime +```powershell +New-AzDataFactoryV2IntegrationRuntimeKey -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' -KeyName authKey2 +``` + +```output +AuthKey1 AuthKey2 +-------- -------- + IR@89895504-f647-48fd-8dd3-42fa556d67e3@*** +``` + +The cmdlet regenerates key 'authKey2' for integration runtime named 'test-selfhost-ir'. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +The authentication key name of the self-hosted integration runtime. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AuthKey1, AuthKey2 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: IntegrationRuntimeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntimeKeys + +## NOTES + +## RELATED LINKS + +[Get-AzDataFactoryV2IntegrationRuntimeKey]() diff --git a/azps-10.1.0/Az.DataFactory/New-AzDataFactoryV2LinkedServiceEncryptedCredential.md b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryV2LinkedServiceEncryptedCredential.md new file mode 100644 index 0000000000..5acf34b12f --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/New-AzDataFactoryV2LinkedServiceEncryptedCredential.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactoryv2linkedserviceencryptedcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryV2LinkedServiceEncryptedCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/New-AzDataFactoryV2LinkedServiceEncryptedCredential.md +--- + +# New-AzDataFactoryV2LinkedServiceEncryptedCredential + +## SYNOPSIS +Encrypt credential in linked service with specified integration runtime. + +## SYNTAX + +### ByFactoryName (Default) +``` +New-AzDataFactoryV2LinkedServiceEncryptedCredential [-IntegrationRuntimeName] <String> + [-DefinitionFile] <String> [-Force] [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +New-AzDataFactoryV2LinkedServiceEncryptedCredential [-IntegrationRuntimeName] <String> + [-DefinitionFile] <String> [-Force] [-DataFactory] <PSDataFactory> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDataFactoryV2LinkedServiceEncryptedCredential cmdlet encrypt credential in linked service with specified integration runtime. + +Please ensure the following prerequisites are met: +* **Remote access** option is enabled on the self-hosted integration runtime. +* Powershell 7.0 or higher is used to execute the cmdlet. + +## EXAMPLES + +### Example 1: Encrypt credentials in a linked service + +This command encrypts credential in file C:\samples\WikiSample\TaxiDemo1.json with the integration runtime named test-selfhost-ir. + +<!-- Aladdin Generated Example --> +```powershell +New-AzDataFactoryV2LinkedServiceEncryptedCredential -DataFactoryName WikiADF -DefinitionFile 'C:\samples\WikiSample\TaxiDemo1.json' -IntegrationRuntimeName 'test-selfhost-ir' -ResourceGroupName MyResourceGroup +``` + +## PARAMETERS + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntegrationRuntimeName +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactory.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactory.md new file mode 100644 index 0000000000..07be80d69c --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactory.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 3D2E9FAE-FE34-457A-BE95-BC61D025B07A +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactory.md +--- + +# Remove-AzDataFactory + +## SYNOPSIS +Removes a data factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzDataFactory [-Name] <String> [-Force] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Remove-AzDataFactory [-DataFactory] <PSDataFactory> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataFactory** cmdlet removes a data factory. + +## EXAMPLES + +### Example 1: Remove a data factory +```powershell +Remove-AzDataFactory -Name "WikiADF" -ResourceGroupName "ADF" +``` + +```output +Confirm +Are you sure you want to remove data factory 'WikiADF' in resource group 'ADF'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +True +``` + +This command removes the data factory named WikiADF from the resource group named ADF. +This command returns a value of $True. + +## PARAMETERS + +### -DataFactory +Specifies the **PSDataFactory** object to remove. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet removes a data factory without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the data factory to remove. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: DataFactoryName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet removes a data factory from the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +## OUTPUTS + +### System.Void + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactory](./Get-AzDataFactory.md) + +[New-AzDataFactory](./New-AzDataFactory.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryDataset.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryDataset.md new file mode 100644 index 0000000000..e0ba8b26d8 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryDataset.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 428BC568-A305-49AD-B6B8-B1BB5E9B822B +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactorydataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryDataset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryDataset.md +--- + +# Remove-AzDataFactoryDataset + +## SYNOPSIS +Removes a dataset from Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzDataFactoryDataset [-Force] [-DataFactoryName] <String> [-Name] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Remove-AzDataFactoryDataset [-Force] [-DataFactory] <PSDataFactory> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataFactoryDataset** cmdlet removes a dataset from Azure Data Factory. + +## EXAMPLES + +### Example 1: Remove a dataset +```powershell +Remove-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikiAggregatedData" +``` + +```output +Confirm +Are you sure you want to remove dataset 'DAWikiAggregatedData' in data factory 'WikiADF'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +True +``` + +This command removes the dataset named DAWikiAggregatedData from the data factory named WikiADF. +The command returns a value of $True. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet removes a dataset from the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet removes a dataset from the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet removes a dataset without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the dataset to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DatasetName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet removes a dataset from the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryDataset](./Get-AzDataFactoryDataset.md) + +[New-AzDataFactoryDataset](./New-AzDataFactoryDataset.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryGateway.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryGateway.md new file mode 100644 index 0000000000..2dd990d2ce --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryGateway.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: E1461540-DEAE-43C3-83DF-7DF3FE8D4EC0 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactorygateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryGateway.md +--- + +# Remove-AzDataFactoryGateway + +## SYNOPSIS +Removes a gateway from Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzDataFactoryGateway [-DataFactoryName] <String> [-Name] <String> [-Force] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Remove-AzDataFactoryGateway [-DataFactory] <PSDataFactory> [-Name] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataFactoryGateway** cmdlet removes the specified gateway from Azure Data Factory. + +## EXAMPLES + +### Example 1: Remove a gateway +```powershell +Remove-AzDataFactoryGateway -Name "ContosoGateway" -DataFactoryName "WikiADF" -ResourceGroupName "ADF" +``` + +```output +Confirm +Are you sure you want to remove gateway 'ContosoGateway' in data factory 'WikiADF'? + [Y] Yes [N] No [S] Suspend [?] Help (default is Y): Y +True +``` + +This command removes the gateway named ContosoGateway from the data factory named WikiADF. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet removes a gateway from the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet removes a gateway from the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet removes a gateway without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the gateway to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet removes a gateway that belongs to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryGateway](./Get-AzDataFactoryGateway.md) + +[New-AzDataFactoryGateway](./New-AzDataFactoryGateway.md) + +[Set-AzDataFactoryGateway](./Set-AzDataFactoryGateway.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryHub.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryHub.md new file mode 100644 index 0000000000..21e39bab88 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryHub.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 4C839730-B494-45BD-B5A1-F93B02AB4B2A +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactoryhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryHub.md +--- + +# Remove-AzDataFactoryHub + +## SYNOPSIS +Removes a hub from Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzDataFactoryHub [-Name] <String> [-Force] [-DataFactoryName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Remove-AzDataFactoryHub [-Name] <String> [-Force] [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataFactoryHub** cmdlet removes a hub from Azure Data Factory in the specified Azure resource group and in the specified data factory. +If you remove a hub, all linked services and pipelines in the hub are also removed. + +## EXAMPLES + +### Example 1: Remove a hub +```powershell +Remove-AzDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -Name "ContosoDataHub" +``` + +This command removes the hub named ContosoDataHub from the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet removes a hub from the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet removes a hub from the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet removes a hub without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the hub to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HubName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet removes a hub from the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +## OUTPUTS + +### System.Boolean + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryHub](./Get-AzDataFactoryHub.md) + +[New-AzDataFactoryHub](./New-AzDataFactoryHub.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryLinkedService.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryLinkedService.md new file mode 100644 index 0000000000..2aac06e867 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryLinkedService.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 9425D38D-5978-421F-A438-4463068C4628 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactorylinkedservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryLinkedService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryLinkedService.md +--- + +# Remove-AzDataFactoryLinkedService + +## SYNOPSIS +Removes a linked service from Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzDataFactoryLinkedService [-Force] [-DataFactoryName] <String> [-Name] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByFactoryObject +``` +Remove-AzDataFactoryLinkedService [-Force] [-DataFactory] <PSDataFactory> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataFactoryLinkedService** cmdlet removes a linked service from Azure Data Factory. + +## EXAMPLES + +### Example 1: Remove a linked service +```powershell +Remove-AzDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceTest" +``` + +```output +Confirm +Are you sure you want to remove linked service 'LinkedServiceTest' in data factory 'WikiADF'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +True +``` + +This command removes the linked service named LinkedServiceTest from the data factory named WikiADF. +This command returns a value of $True. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet removes a linked service from the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet removes a linked service from the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet removes a linked service without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the linked service to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LinkedServiceName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet removes a linked service from the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryLinkedService](./Get-AzDataFactoryLinkedService.md) + +[New-AzDataFactoryLinkedService](./New-AzDataFactoryLinkedService.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryPipeline.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryPipeline.md new file mode 100644 index 0000000000..626238669d --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryPipeline.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: E1E0919A-062B-4794-ADE7-E17133A40604 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactorypipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryPipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryPipeline.md +--- + +# Remove-AzDataFactoryPipeline + +## SYNOPSIS +Removes a pipeline from Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzDataFactoryPipeline [-Force] [-Name] <String> [-DataFactoryName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByFactoryObject +``` +Remove-AzDataFactoryPipeline [-Force] [-Name] <String> [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataFactoryPipeline** cmdlet removes a pipeline from Azure Data Factory. + +## EXAMPLES + +### Example 1: Remove a pipeline +```powershell +Remove-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" +``` + +```output +Confirm +Are you sure you want to remove pipeline 'DPWikisample' in data factory 'WikiADF'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +True +``` + +This cmdlet removes the pipeline named DPWikisample from the data factory named WikiADF. +The command returns a value of $True. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet removes a pipeline from the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet removes a pipeline from the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet removes a pipeline without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the pipeline to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PipelineName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet removes a pipeline from the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +## OUTPUTS + +### System.Void + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryPipeline](./Get-AzDataFactoryPipeline.md) + +[New-AzDataFactoryPipeline](./New-AzDataFactoryPipeline.md) + +[Resume-AzDataFactoryPipeline](./Resume-AzDataFactoryPipeline.md) + +[Set-AzDataFactoryPipelineActivePeriod](./Set-AzDataFactoryPipelineActivePeriod.md) + +[Suspend-AzDataFactoryPipeline](./Suspend-AzDataFactoryPipeline.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2.md new file mode 100644 index 0000000000..4ad463506f --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactoryv2 +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2.md +--- + +# Remove-AzDataFactoryV2 + +## SYNOPSIS +Removes a data factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzDataFactoryV2 [-ResourceGroupName] <String> [-Name] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Remove-AzDataFactoryV2 [-InputObject] <PSDataFactory> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzDataFactoryV2 [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzDataFactoryV2 cmdlet removes a data factory. + +## EXAMPLES + +### Example 1: Remove a data factory +```powershell +Remove-AzDataFactoryV2 -Name "WikiADF" -ResourceGroupName "ADF" +``` + +```output + Confirm + Are you sure you want to remove data factory 'WikiADF' in resource group 'ADF'? + [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y + True +``` + +This command removes the data factory named WikiADF from the resource group named ADF. +This command returns a value of $True. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the DataFactory object to remove. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the data factory to remove. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: DataFactoryName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet removes a data factory from the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryV2]() + +[Set-AzDataFactoryV2]() diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2DataFlow.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2DataFlow.md new file mode 100644 index 0000000000..2747ad9948 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2DataFlow.md @@ -0,0 +1,230 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactoryv2dataflow +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2DataFlow.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2DataFlow.md +--- + +# Remove-AzDataFactoryV2DataFlow + +## SYNOPSIS +Removes a data flow from Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzDataFactoryV2DataFlow [-Name] <String> [-Force] [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzDataFactoryV2DataFlow [-InputObject] <PSDataset> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzDataFactoryV2DataFlow [-Force] [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzDataFactoryV2DataFlow cmdlet removes a data flow from Azure Data Factory. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataFactoryV2DataFlow -ResourceGroupName adf -DataFactoryName WikiADF -DataFlowName "dataflow5" +``` + +```output +Confirm +Are you sure you want to remove data flow 'dataflow5' in data factory 'WikiADF'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +``` + +This command removes the data flow named dataflow5 from the data factory named WikiADF. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The data flow object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataset +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The data flow name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: DataFlowName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataset + +### System.String + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryV2DataFlow](./get-azdatafactoryv2dataflow.md) + +[Set-AzDataFactoryV2DataFlow](./set-azdatafactoryv2dataflow.md) + diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2Dataset.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2Dataset.md new file mode 100644 index 0000000000..177b1d4d0d --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2Dataset.md @@ -0,0 +1,214 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactoryv2dataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2Dataset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2Dataset.md +--- + +# Remove-AzDataFactoryV2Dataset + +## SYNOPSIS +Removes a dataset from Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzDataFactoryV2Dataset [-Name] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzDataFactoryV2Dataset [-InputObject] <PSDataset> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzDataFactoryV2Dataset [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzDataFactoryV2Dataset cmdlet removes a dataset from Azure Data Factory. + +## EXAMPLES + +### Example 1: Remove a dataset +```powershell +Remove-AzDataFactoryV2Dataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikiAggregatedData" +``` + +```output + Confirm + Are you sure you want to remove dataset 'DAWikiAggregatedData' in data factory 'WikiADF'? + [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y + True +``` + +This command removes the dataset named DAWikiAggregatedData from the data factory named WikiADF. +The command returns a value of $True. + +## PARAMETERS + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet removes a dataset from the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies a Dataset object to remove. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataset +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the dataset to remove. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: DatasetName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet removes a dataset from the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataset + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryV2Dataset]() + +[Set-AzDataFactoryV2Dataset]() diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2IntegrationRuntime.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2IntegrationRuntime.md new file mode 100644 index 0000000000..12bf8eb1b3 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2IntegrationRuntime.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactoryv2integrationruntime +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2IntegrationRuntime.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2IntegrationRuntime.md +--- + +# Remove-AzDataFactoryV2IntegrationRuntime + +## SYNOPSIS +Removes an integration runtime. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Remove-AzDataFactoryV2IntegrationRuntime [-LinkedDataFactoryName <String>] [-Force] [-Name] <String> + [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzDataFactoryV2IntegrationRuntime [-LinkedDataFactoryName <String>] [-Force] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Remove-AzDataFactoryV2IntegrationRuntime [-LinkedDataFactoryName <String>] [-Force] + [-InputObject] <PSIntegrationRuntime> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzDataFactoryV2IntegrationRuntime cmdlet removes a integration runtime. + +## EXAMPLES + +### Example 1: Remove a integration runtime +```powershell +Remove-AzDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df' -Name 'test-reserved-ir' -Confirm +``` + +This command removes the integration runtime named 'test-reserved-ir' from the data factory named 'test-df'. +This command returns a value of $True. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkedDataFactoryName +The linked data factory name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: IntegrationRuntimeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### System.Void + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime + +## RELATED LINKS + +[Set-AzDataFactoryV2IntegrationRuntime]() + +[Get-AzDataFactoryV2IntegrationRuntime]() + diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2IntegrationRuntimeNode.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2IntegrationRuntimeNode.md new file mode 100644 index 0000000000..d2781a4a76 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2IntegrationRuntimeNode.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactoryv2integrationruntimenode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2IntegrationRuntimeNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2IntegrationRuntimeNode.md +--- + +# Remove-AzDataFactoryV2IntegrationRuntimeNode + +## SYNOPSIS +Remove a node with the given name on an integration runtime. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Remove-AzDataFactoryV2IntegrationRuntimeNode -NodeName <String> [-Force] [-IntegrationRuntimeName] <String> + [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzDataFactoryV2IntegrationRuntimeNode -NodeName <String> [-Force] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Remove-AzDataFactoryV2IntegrationRuntimeNode -NodeName <String> [-Force] [-InputObject] <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzDataFactoryV2IntegrationRuntimeNode cmdlet removes a node in an integration runtime. + +## EXAMPLES + +### Example 1: Remove a node from an integration runtime + +Remove a node with the given name on an integration runtime. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Remove-AzDataFactoryV2IntegrationRuntimeNode -DataFactoryName 'test-df-eu2' -IntegrationRuntimeName 'test-selfhost-ir' -NodeName 'Node_1' -ResourceGroupName 'rg-test-dfv2' +``` + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntegrationRuntimeName +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeName +The integration runtime node name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2LinkedService.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2LinkedService.md new file mode 100644 index 0000000000..49c14f290c --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2LinkedService.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactoryv2linkedservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2LinkedService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2LinkedService.md +--- + +# Remove-AzDataFactoryV2LinkedService + +## SYNOPSIS +Removes a linked service from Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzDataFactoryV2LinkedService [-Name] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzDataFactoryV2LinkedService [-InputObject] <PSLinkedService> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzDataFactoryV2LinkedService [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzDataFactoryV2LinkedService cmdlet removes a linked service from Azure Data Factory. + +## EXAMPLES + +### Example 1: Remove a linked service +```powershell +Remove-AzDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceTest" +``` + +```output + Confirm + Are you sure you want to remove linked service 'LinkedServiceTest' in data factory 'WikiADF'? + [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y + True +``` + +This command removes the linked service named LinkedServiceTest from the data factory named WikiADF. +This command returns a value of $True. + +## PARAMETERS + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet removes a linked service from the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the LinkedService object to remove. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the linked service to remove. +Name of the linked service. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: LinkedServiceName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet removes a linked service from the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the linked service to remove. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryV2LinkedService]() + +[Set-AzDataFactoryV2LinkedService]() + diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2Pipeline.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2Pipeline.md new file mode 100644 index 0000000000..8749e3a3f7 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2Pipeline.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactoryv2pipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2Pipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2Pipeline.md +--- + +# Remove-AzDataFactoryV2Pipeline + +## SYNOPSIS +Removes a pipeline from Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzDataFactoryV2Pipeline [-Name] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzDataFactoryV2Pipeline [-InputObject] <PSPipeline> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzDataFactoryV2Pipeline [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzDataFactoryV2Pipeline cmdlet removes a pipeline from Azure Data Factory. + +## EXAMPLES + +### Example 1: Remove a pipeline +```powershell +Remove-AzDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" +``` + +```output + Confirm + Are you sure you want to remove pipeline 'DPWikisample' in data factory 'WikiADF'? + [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y + True +``` + +This cmdlet removes the pipeline named DPWikisample from the data factory named WikiADF. +The command returns a value of $True. + +## PARAMETERS + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet removes a pipeline from the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies a Pipeline object. +This cmdlet removes the pipeline that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the pipeline to remove. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: PipelineName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet removes a pipeline from the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the pipeline to remove. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryV2Pipeline]() + +[Set-AzDataFactoryV2Pipeline]() + +[Invoke-AzDataFactoryV2Pipeline]() + diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2Trigger.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2Trigger.md new file mode 100644 index 0000000000..ac5d032b48 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2Trigger.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactoryv2trigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2Trigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2Trigger.md +--- + +# Remove-AzDataFactoryV2Trigger + +## SYNOPSIS +Removes a trigger from a data factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzDataFactoryV2Trigger [-Name] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzDataFactoryV2Trigger [-InputObject] <PSTrigger> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzDataFactoryV2Trigger [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataFactoryV2Trigger** cmdlet removes a trigger from a data factory. If the _Force_ parameter is specified, the cmdlet doesn't prompt before removing the trigger. + +## EXAMPLES + +### Example 1: Remove a trigger +```powershell +Remove-AzDataFactoryV2Trigger -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "ScheduledTrigger" +``` + +```output +Confirm +Are you sure you want to remove trigger 'ScheduledTrigger' in data factory 'TestFactory'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +True +``` + +Remove a trigger called "ScheduledTrigger" from the data factory "WikiADF". + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Trigger object to remove. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: TriggerName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzDataFactoryV2Trigger]() + +[Set-AzDataFactoryV2Trigger]() + +[Start-AzDataFactoryV2Trigger]() + +[Stop-AzDataFactoryV2Trigger]() + diff --git a/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2TriggerSubscription.md b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2TriggerSubscription.md new file mode 100644 index 0000000000..d8adb8b8ac --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Remove-AzDataFactoryV2TriggerSubscription.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactoryv2triggersubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2TriggerSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Remove-AzDataFactoryV2TriggerSubscription.md +--- + +# Remove-AzDataFactoryV2TriggerSubscription + +## SYNOPSIS +Unsubscribe the event trigger to external service events. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzDataFactoryV2TriggerSubscription [-Name] <String> [-PassThru] [-Force] [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzDataFactoryV2TriggerSubscription [-InputObject] <PSTrigger> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzDataFactoryV2TriggerSubscription [-PassThru] [-Force] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command unsubscribes the event trigger to the specified external service events from the trigger defintion. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataFactoryV2TriggerSubscription -ResourceGroupName ADF -DataFactoryName WikiADF -Name Trigger1 +``` + +This command will unsubscribe BlobEnetTrigger1 trigger to the specified events from the trigger defintion. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The trigger object. + +```yaml +Type: PSTrigger +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: String +Parameter Sets: ByFactoryName +Aliases: TriggerName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If specified, cmdlet will return return true on successful delete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTriggerSubscriptionStatus + +## NOTES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataFactory/Resume-AzDataFactoryPipeline.md b/azps-10.1.0/Az.DataFactory/Resume-AzDataFactoryPipeline.md new file mode 100644 index 0000000000..47dc53d486 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Resume-AzDataFactoryPipeline.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: F522841A-4246-4028-A754-393D8DADD924 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/resume-azdatafactorypipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Resume-AzDataFactoryPipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Resume-AzDataFactoryPipeline.md +--- + +# Resume-AzDataFactoryPipeline + +## SYNOPSIS +Resumes a suspended pipeline in Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Resume-AzDataFactoryPipeline [-Name] <String> [-DataFactoryName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Resume-AzDataFactoryPipeline [-Name] <String> [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Resume-AzDataFactoryPipeline** cmdlet resumes a suspended pipeline in Azure Data Factory. + +## EXAMPLES + +### Example 1: Resume a pipeline +```powershell +Resume-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" +``` + +```output +Confirm +Are you sure you want to resume pipeline 'DPWikisample' in data factory 'WikiADF'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +True +``` + +This command resumes the pipeline named DPWikisample in the data factory named WikiADF. +Use the **Suspend-AzDataFactoryPipeline** cmdlet to suspend a pipeline. +The command returns a value of $True. + +### Example 2 + +Resumes a suspended pipeline in Data Factory. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Resume-AzDataFactoryPipeline -DataFactory $DataFactory -Name 'DPWikisample' +``` + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet resumes a pipeline that belongs to the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet resumes a pipeline that belongs to the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the pipeline to resume. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PipelineName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet resumes a pipeline that belongs to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +## OUTPUTS + +### System.Boolean + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryPipeline](./Get-AzDataFactoryPipeline.md) + +[New-AzDataFactoryPipeline](./New-AzDataFactoryPipeline.md) + +[Remove-AzDataFactoryPipeline](./Remove-AzDataFactoryPipeline.md) + +[Set-AzDataFactoryPipelineActivePeriod](./Set-AzDataFactoryPipelineActivePeriod.md) + +[Suspend-AzDataFactoryPipeline](./Suspend-AzDataFactoryPipeline.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Save-AzDataFactoryLog.md b/azps-10.1.0/Az.DataFactory/Save-AzDataFactoryLog.md new file mode 100644 index 0000000000..2f757a6da6 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Save-AzDataFactoryLog.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 5490BB24-127E-4C21-B85F-B70D817B659A +online version: https://learn.microsoft.com/powershell/module/az.datafactory/save-azdatafactorylog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Save-AzDataFactoryLog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Save-AzDataFactoryLog.md +--- + +# Save-AzDataFactoryLog + +## SYNOPSIS +Downloads log files from Azure HDInsight processing. + +## SYNTAX + +### ByFactoryName (Default) +``` +Save-AzDataFactoryLog [-DataFactoryName] <String> [-Id] <String> [-DownloadLogs] [[-Output] <String>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Save-AzDataFactoryLog [-DataFactory] <PSDataFactory> [-Id] <String> [-DownloadLogs] [[-Output] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Save-AzDataFactoryLog** cmdlet downloads log files associated with Azure HDInsight processing of Pig or Hive projects or for custom activities to your local hard drive. +You first run the Get-AzDataFactoryRun cmdlet to get an ID for an activity run for a data slice, and then use that ID to retrieve log files from the binary large object (BLOB) storage associated with the HDInsight cluster. +If you do not specify the *DownloadLogs* parameter, the cmdlet just returns the location of log files. +If you specify *DownloadLogs* without specifying an output directory (*Output* parameter), the log files are downloaded to the default Documents folder. +If you specify *DownloadLogs* along with an output folder (*Output*), the log files are downloaded to the specified folder. + +## EXAMPLES + +### Example 1: Save log files to a specific folder +```powershell +Save-AzDataFactoryLog -ResourceGroupName "ADF" -DataFactoryName "LogProcessingFactory" -Id "841b77c9-d56c-48d1-99a3-8c16c3e77d39" -DownloadLogs -Output "C:\Test" +``` + +This command saves log files for the activity run with the ID of 841b77c9-d56c-48d1-99a3-8c16c3e77d39 where the activity belongs to a pipeline in the data factory named LogProcessingFactory in the resource group named ADF. +The log files are saved to the C:\Test folder. + +### Example 2: Save log files to default Documents folder +```powershell +Save-AzDataFactoryLog -ResourceGroupName "ADF" -DataFactoryName "LogProcessingFactory" -Id "841b77c9-d56c-48d1-99a3-8c16c3e77d39" -DownloadLogs +``` + +This command saves log files to Documents folder (default). + +### Example 3: Get the location of log files +```powershell +Save-AzDataFactoryLog -ResourceGroupName "ADF" -DataFactoryName "LogProcessingFactory" -Id "841b77c9-d56c-48d1-99a3-8c16c3e77d39" +``` + +This command returns the location of log files. +Note that *DownloadLogs* is not specified. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet downloads log files for the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DownloadLogs +Indicates that this cmdlet downloads log files to your local computer. +If *Output* folder is not specified, files are saved to Documents folder under a subfolder. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the activity run for the data slice. +Use the Get-AzDataFactoryRun cmdlet to get an ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Output +Specifies the output folder in which the downloaded log files are saved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet creates a data factory that belongs to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSRunLogInfo + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryRun](./Get-AzDataFactoryRun.md) + +[Get-AzDataFactoryPipeline](./Get-AzDataFactoryPipeline.md) + +[New-AzDataFactoryPipeline](./New-AzDataFactoryPipeline.md) + +[Remove-AzDataFactoryPipeline](./Remove-AzDataFactoryPipeline.md) + +[Set-AzDataFactoryPipelineActivePeriod](./Set-AzDataFactoryPipelineActivePeriod.md) + +[Suspend-AzDataFactoryPipeline](./Suspend-AzDataFactoryPipeline.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryGateway.md b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryGateway.md new file mode 100644 index 0000000000..9887b2af19 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryGateway.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 663D27A3-0B51-48F5-81D0-8DDBC5A3A33C +online version: https://learn.microsoft.com/powershell/module/az.datafactory/set-azdatafactorygateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryGateway.md +--- + +# Set-AzDataFactoryGateway + +## SYNOPSIS +Sets the description for a gateway in Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Set-AzDataFactoryGateway [-DataFactoryName] <String> [-Name] <String> [-Description] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Set-AzDataFactoryGateway [-DataFactory] <PSDataFactory> [-Name] <String> [-Description] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataFactoryGateway** cmdlet sets the description for the specified gateway in Azure Data Factory. + +## EXAMPLES + +### Example 1: Set the description for a gateway +```powershell +Set-AzDataFactoryGateway -ResourceGroupName "ADF" -Name "ContosoGateway" -DataFactoryName "WikiADF" -Description "my gateway" +``` + +```output +Name : ContosoGateway +Description : my gateway +Version : 1.3.5338.1 +Status : Online +VersionStatus : UpToDate +CreateTime : 8/22/2014 1:31:09 AM +RegisterTime : 8/22/2014 1:31:37 AM +LastConnectTime : 8/22/2014 1:41:41 AM +ExpiryTime : +``` + +This command sets the description for the gateway named ContosoGateway in the data factory named WikiADF. +The Description parameter specifies the new description. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet sets the description for the gateway in the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet sets the description for the gateway in the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the gateway for which to set a description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet sets the description for a gateway that belongs to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactoryGateway + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryGateway](./Get-AzDataFactoryGateway.md) + +[New-AzDataFactoryGateway](./New-AzDataFactoryGateway.md) + +[Remove-AzDataFactoryGateway](./Remove-AzDataFactoryGateway.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryPipelineActivePeriod.md b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryPipelineActivePeriod.md new file mode 100644 index 0000000000..b7783e20b8 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryPipelineActivePeriod.md @@ -0,0 +1,262 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: D853A91F-95E7-4C36-AC0F-2C10DFCF68F8 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/set-azdatafactorypipelineactiveperiod +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryPipelineActivePeriod.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryPipelineActivePeriod.md +--- + +# Set-AzDataFactoryPipelineActivePeriod + +## SYNOPSIS +Configures the active period for data slices. + +## SYNTAX + +### ByFactoryName (Default) +``` +Set-AzDataFactoryPipelineActivePeriod [-PipelineName] <String> [-DataFactoryName] <String> + [-StartDateTime] <DateTime> [[-EndDateTime] <DateTime>] [-AutoResolve] [-ForceRecalculate] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByFactoryObject +``` +Set-AzDataFactoryPipelineActivePeriod [-PipelineName] <String> [-DataFactory] <PSDataFactory> + [-StartDateTime] <DateTime> [[-EndDateTime] <DateTime>] [-AutoResolve] [-ForceRecalculate] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataFactoryPipelineActivePeriod** cmdlet configures the active period for the data slices that are processed by a pipeline in Azure Data Factory. +If you use the Set-AzDataFactorySliceStatus cmdlet to modify the status of slices for a dataset, make sure that the start time and end time for a slice are in the active period of the pipeline. +After you create a pipeline, you can specify the period in which data processing occurs. +Specifying the active period for a pipeline defines the time duration in which the data slices are processed based on the **Availability** properties that were defined for each Data Factory dataset. + +## EXAMPLES + +### Example 1: Configure the active period +```powershell +Set-AzDataFactoryPipelineActivePeriod -ResourceGroupName "ADF" -PipelineName "DPWikisample" -DataFactoryName "WikiADF" -StartDateTime 2014-05-21T16:00:00Z -EndDateTime 2014-05-22T16:00:00Z +``` + +```output +Confirm +Are you sure you want to set pipeline 'DPWikisample' active period from '05/21/2014 16:00:00' to +'05/22/2014 16:00:00'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +True +``` + +This command configures the active period for the data slices that the pipeline named DPWikisample processes. +The command provides beginning and end points for the data slices as values. +The command returns a value of $True. + +## PARAMETERS + +### -AutoResolve +Indicates that this cmdlet uses auto resolve. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet modifies the active period for a pipeline that belongs to the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet modifies the active period for a pipeline that belongs to the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDateTime +Specifies the end of a time period as a **DateTime** object. +Data processing occurs or data slices are processed within this period. +For more information about **DateTime** objects, type `Get-Help Get-Date`. +*EndDateTime* must be specified in the ISO8601 format as in the following examples: +2015-01-01Z +2015-01-01T00:00:00Z +2015-01-01T00:00:00.000Z (UTC) +2015-01-01T00:00:00-08:00 (Pacific Standard Time) +The default time zone designator is UTC. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceRecalculate +Indicates that this cmdlet uses force recalculate. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineName +Specifies the name of the pipeline. +This cmdlet sets the active period for the pipeline that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet modifies the active period for a pipeline that belongs to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartDateTime +Specifies the start of a time period as a **DateTime** object. +Data processing occurs or data slices are processed within this period. +*StartDateTime* must be specified in the ISO8601 format. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +## OUTPUTS + +### System.Boolean + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[New-AzDataFactoryPipeline](./New-AzDataFactoryPipeline.md) + +[Set-AzDataFactorySliceStatus](./Set-AzDataFactorySliceStatus.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Set-AzDataFactorySliceStatus.md b/azps-10.1.0/Az.DataFactory/Set-AzDataFactorySliceStatus.md new file mode 100644 index 0000000000..5d8642e294 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Set-AzDataFactorySliceStatus.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 1D07222C-17D1-421C-8C9B-37043CBCF517 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/set-azdatafactoryslicestatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactorySliceStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactorySliceStatus.md +--- + +# Set-AzDataFactorySliceStatus + +## SYNOPSIS +Sets the status of slices for a dataset in Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Set-AzDataFactorySliceStatus [[-EndDateTime] <DateTime>] [-Status] <String> [[-UpdateType] <String>] + [-DataFactoryName] <String> [-DatasetName] <String> [-StartDateTime] <DateTime> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Set-AzDataFactorySliceStatus [[-EndDateTime] <DateTime>] [-Status] <String> [[-UpdateType] <String>] + [-DataFactory] <PSDataFactory> [-DatasetName] <String> [-StartDateTime] <DateTime> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataFactorySliceStatus** cmdlet sets the status of slices for a dataset in Azure Data Factory. + +## EXAMPLES + +### Example 1: Set the status of all slices +```powershell +Set-AzDataFactorySliceStatus -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-21T16:00:00Z -EndDateTime 2014-05-21T20:00:00Z -Status "Waiting" -UpdateType "UpstreamInPipeline" +``` + +```output +True +``` + +This command sets the status of all slices for the dataset named DAWikiAggregatedData to Waiting in the data factory named WikiADF. +The *UpdateType* parameter has a value of UpstreamInPipeline, and so the command sets the status of each slice for the dataset and all dependent datasets. +Dependent datasets are used as input datasets for activities in the pipeline. +This command returns a value of $True. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet modifies the status of slices that belong to the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet modifies the status of slices that belong to the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatasetName +Specifies the name of the dataset for which this cmdlet modifies slices. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDateTime +Specifies the end of a time period as a **DateTime** object. +This time is the end of a data slice. +For more information about **DateTime** objects, type `Get-Help Get-Date`. +*EndDateTime* must be specified in the ISO8601 format as in the following examples: +2015-01-01Z +2015-01-01T00:00:00Z +2015-01-01T00:00:00.000Z (UTC) +2015-01-01T00:00:00-08:00 (Pacific Standard Time) +The default time zone designator is UTC. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet modifies the status of slices that belong to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartDateTime +Specifies the start of a time period as a **DateTime** object. +This time is the beginning of a data slice. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Specifies a status to assign to the data slice. +The acceptable values for this parameter are: +- Waiting. +Data slice is waiting for validation against validation policies before being processed. +- Ready. +Data processing has completed and the data slice is ready. +- InProgress. +Data processing is in-progress. +- Failed. +Data processing failed. +- Skipped. +Skipped processing the data slice. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Failed, InProgress, Ready, Skipped, Waiting + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateType +Specifies the type of update to the slice. +The acceptable values for this parameter are: +- Individual. +Sets the status of each slice for the dataset in the specified time range. +- UpstreamInPipeline. +Sets the status of each slice for the dataset and all the dependent datasets, which are used as input datasets for activities in the pipeline. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Individual, UpstreamInPipeline + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactorySlice](./Get-AzDataFactorySlice.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2.md b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2.md new file mode 100644 index 0000000000..8d86dd9cd8 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2.md @@ -0,0 +1,669 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/set-azdatafactoryv2 +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2.md +--- + +# Set-AzDataFactoryV2 + +## SYNOPSIS +Creates a data factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Set-AzDataFactoryV2 [-ResourceGroupName] <String> [-Name] <String> [-IdentityType <String>] + [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>] + [-EncryptionVaultBaseUrl <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionUserAssignedIdentity <String>] [-Location] <String> [[-Tag] <Hashtable>] [-Force] + [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzDataFactoryV2 [-ResourceId] <String> [-IdentityType <String>] + [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>] + [-EncryptionVaultBaseUrl <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionUserAssignedIdentity <String>] [-Location] <String> [[-Tag] <Hashtable>] [-Force] + [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdFactoryRepoVstsConfig +``` +Set-AzDataFactoryV2 [-ResourceId] <String> [-IdentityType <String>] + [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>] + [-EncryptionVaultBaseUrl <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionUserAssignedIdentity <String>] [-Location] <String> [[-Tag] <Hashtable>] [-Force] + [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>] + -AccountName <String> -RepositoryName <String> -CollaborationBranch <String> -RootFolder <String> + [-LastCommitId <String>] -ProjectName <String> [-TenantId <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdFactoryRepoGitConfig +``` +Set-AzDataFactoryV2 [-ResourceId] <String> [-IdentityType <String>] + [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>] + [-EncryptionVaultBaseUrl <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionUserAssignedIdentity <String>] [-Location] <String> [[-Tag] <Hashtable>] [-Force] + [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>] + -AccountName <String> -RepositoryName <String> -CollaborationBranch <String> -RootFolder <String> + [-LastCommitId <String>] -HostName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByFactoryNameFactoryRepoGitConfig +``` +Set-AzDataFactoryV2 [-ResourceGroupName] <String> [-Name] <String> [-IdentityType <String>] + [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>] + [-EncryptionVaultBaseUrl <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionUserAssignedIdentity <String>] [-Location] <String> [[-Tag] <Hashtable>] [-Force] + [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>] + -AccountName <String> -RepositoryName <String> -CollaborationBranch <String> -RootFolder <String> + [-LastCommitId <String>] -HostName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByFactoryNameFactoryRepoVstsConfig +``` +Set-AzDataFactoryV2 [-ResourceGroupName] <String> [-Name] <String> [-IdentityType <String>] + [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>] + [-EncryptionVaultBaseUrl <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionUserAssignedIdentity <String>] [-Location] <String> [[-Tag] <Hashtable>] [-Force] + [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>] + -AccountName <String> -RepositoryName <String> -CollaborationBranch <String> -RootFolder <String> + [-LastCommitId <String>] -ProjectName <String> [-TenantId <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Set-AzDataFactoryV2 [-IdentityType <String>] + [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>] + [-EncryptionVaultBaseUrl <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionUserAssignedIdentity <String>] -InputObject <PSDataFactory> [[-Location] <String>] + [[-Tag] <Hashtable>] [-Force] + [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectFactoryRepoVstsConfig +``` +Set-AzDataFactoryV2 [-IdentityType <String>] + [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>] + [-EncryptionVaultBaseUrl <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionUserAssignedIdentity <String>] -InputObject <PSDataFactory> [[-Location] <String>] + [[-Tag] <Hashtable>] [-Force] + [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>] + [-AccountName <String>] [-RepositoryName <String>] [-CollaborationBranch <String>] [-RootFolder <String>] + [-LastCommitId <String>] -ProjectName <String> [-TenantId <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectFactoryRepoGitConfig +``` +Set-AzDataFactoryV2 [-IdentityType <String>] + [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>] + [-EncryptionVaultBaseUrl <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionUserAssignedIdentity <String>] -InputObject <PSDataFactory> [[-Location] <String>] + [[-Tag] <Hashtable>] [-Force] + [-GlobalParameterDefinition <System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification]>] + [-AccountName <String>] [-RepositoryName <String>] [-CollaborationBranch <String>] [-RootFolder <String>] + [-LastCommitId <String>] -HostName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataFactoryV2** cmdlet creates a data factory with the specified resource group name and location. +Perform these operations in the following order: + -- Create a data factory. + -- Create linked services. + -- Create datasets. + -- Create a pipeline. + +## EXAMPLES + +### Example 1: Create a data factory +```powershell +Set-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF" -Location "WestUS" +``` + +```output + DataFactoryName : WikiADF + DataFactoryId : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataFactory/factories/wikiadf + ResourceGroupName : ADF + Location : EastUS + Tags : {} + Identity : Microsoft.Azure.Management.DataFactory.Models.FactoryIdentity + ProvisioningState : Succeeded + RepoConfiguration : +``` + +### Example 2: Create a data factory with repo configuration details using an existing factory object. +```powershell +Get-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF" | Set-AzDataFactoryV2 -AccountName msdata -RepositoryName ADFRepo -CollaborationBranch master -RootFolder / -ProjectName "Azure Data Factory" +``` + +```output + DataFactoryName : WikiADF + DataFactoryId : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataFactory/factories/wikiadf + ResourceGroupName : ADF + Location : EastUS + Tags : {} + Identity : Microsoft.Azure.Management.DataFactory.Models.FactoryIdentity + ProvisioningState : Succeeded + RepoConfiguration : Microsoft.Azure.Management.DataFactory.Models.FactoryVSTSConfiguration +``` + +This command creates a data factory named WikiADF in the resource group named ADF in the EastUS location with Azure DevOps source control configuration. + +### Example 3: Create a data factory with GitHub repo configuration details using a new factory object. +```powershell +Set-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF" -Location 'EastUS' -HostName 'https://github.com' -AccountName msdata -RepositoryName ADFRepo -CollaborationBranch master -RootFolder / +``` + +```output + DataFactoryName : WikiADF + DataFactoryId : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataFactory/factories/wikiadf + ResourceGroupName : ADF + Location : EastUS + Tags : {} + Identity : Microsoft.Azure.Management.DataFactory.Models.FactoryIdentity + ProvisioningState : Succeeded + RepoConfiguration : Microsoft.Azure.Management.DataFactory.Models.FactoryGitHubConfiguration +``` + +This command creates a data factory named WikiADF in the resource group named ADF in the EastUS location with GitHub source control configuration.. + +## PARAMETERS + +### -AccountName +The account name for repo configuration. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdFactoryRepoVstsConfig, ByResourceIdFactoryRepoGitConfig, ByFactoryNameFactoryRepoGitConfig, ByFactoryNameFactoryRepoVstsConfig +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByInputObjectFactoryRepoVstsConfig, ByInputObjectFactoryRepoGitConfig +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollaborationBranch +The collaboration branch for repo configuration. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdFactoryRepoVstsConfig, ByResourceIdFactoryRepoGitConfig, ByFactoryNameFactoryRepoGitConfig, ByFactoryNameFactoryRepoVstsConfig +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByInputObjectFactoryRepoVstsConfig, ByInputObjectFactoryRepoGitConfig +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyName +The name of the key in Azure Key Vault to use as Customer Managed Key for encryption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyVersion +The version of the key used for CMK. If not provided, latest version will be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionUserAssignedIdentity +User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionVaultBaseUrl +The url of the Azure Key Vault used for encryption with CMK. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalParameterDefinition +The dictionary containing the global parameters of the data factory. + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,Microsoft.Azure.Management.DataFactory.Models.GlobalParameterSpecification] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +The host name for GitHub repo configuration. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdFactoryRepoGitConfig, ByFactoryNameFactoryRepoGitConfig, ByInputObjectFactoryRepoGitConfig +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The Identity type that will be associated with your DataFactory. Options are 'SystemAssigned', 'UserAssigned' or 'SystemAssigned,UserAssigned' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Whether or not public network access is allowed for the data factory. Options are 'Enabled' or 'Disabled' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByInputObject, ByInputObjectFactoryRepoVstsConfig, ByInputObjectFactoryRepoGitConfig +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LastCommitId +The last commit id for repo configuration. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdFactoryRepoVstsConfig, ByResourceIdFactoryRepoGitConfig, ByFactoryNameFactoryRepoGitConfig, ByFactoryNameFactoryRepoVstsConfig, ByInputObjectFactoryRepoVstsConfig, ByInputObjectFactoryRepoGitConfig +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The data factory is created in this region. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName, ByResourceId, ByResourceIdFactoryRepoVstsConfig, ByResourceIdFactoryRepoGitConfig, ByFactoryNameFactoryRepoGitConfig, ByFactoryNameFactoryRepoVstsConfig +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByInputObject, ByInputObjectFactoryRepoVstsConfig, ByInputObjectFactoryRepoGitConfig +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName, ByFactoryNameFactoryRepoGitConfig, ByFactoryNameFactoryRepoVstsConfig +Aliases: DataFactoryName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProjectName +The project name Azure DevOps for repo configuration. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdFactoryRepoVstsConfig, ByFactoryNameFactoryRepoVstsConfig, ByInputObjectFactoryRepoVstsConfig +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryName +The repository name for repo configuration. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdFactoryRepoVstsConfig, ByResourceIdFactoryRepoGitConfig, ByFactoryNameFactoryRepoGitConfig, ByFactoryNameFactoryRepoVstsConfig +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByInputObjectFactoryRepoVstsConfig, ByInputObjectFactoryRepoGitConfig +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName, ByFactoryNameFactoryRepoGitConfig, ByFactoryNameFactoryRepoVstsConfig +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of V2 data factory. + +```yaml +Type: System.String +Parameter Sets: ByResourceId, ByResourceIdFactoryRepoVstsConfig, ByResourceIdFactoryRepoGitConfig +Aliases: Id, DataFactoryId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RootFolder +The root folder for repo configuration. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdFactoryRepoVstsConfig, ByResourceIdFactoryRepoGitConfig, ByFactoryNameFactoryRepoGitConfig, ByFactoryNameFactoryRepoVstsConfig +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByInputObjectFactoryRepoVstsConfig, ByInputObjectFactoryRepoGitConfig +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags of the data factory. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByFactoryName, ByResourceId, ByResourceIdFactoryRepoVstsConfig, ByResourceIdFactoryRepoGitConfig, ByFactoryNameFactoryRepoGitConfig, ByFactoryNameFactoryRepoVstsConfig +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByInputObject, ByInputObjectFactoryRepoVstsConfig, ByInputObjectFactoryRepoGitConfig +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantId +The tenant id for Azure DevOps repo configuration. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdFactoryRepoVstsConfig, ByFactoryNameFactoryRepoVstsConfig, ByInputObjectFactoryRepoVstsConfig +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The dictionary containing the user assigned identities of the data factory. + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.Object] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryV2]() + +[Remove-AzDataFactoryV2]() diff --git a/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2DataFlow.md b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2DataFlow.md new file mode 100644 index 0000000000..43332c6634 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2DataFlow.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/set-azdatafactoryv2dataflow +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2DataFlow.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2DataFlow.md +--- + +# Set-AzDataFactoryV2DataFlow + +## SYNOPSIS +Creates a data flow in Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Set-AzDataFactoryV2DataFlow [-Name] <String> [-DefinitionFile] <String> [-Force] [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzDataFactoryV2DataFlow [-DefinitionFile] <String> [-Force] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzDataFactoryV2DataFlow cmdlet creates a data flow or updates an existing data flow in Azure Data Factory. + +## EXAMPLES + +### Example 1: Create a data flow +```powershell +Set-AzDataFactoryV2DataFlow -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "TaxiDemo1" -DefinitionFile "C:\\samples\\WikiSample\\TaxiDemo1.json" +``` + +```output +DataFlowName DataFactoryName ResourceGroupName Properties +------------ --------------- ----------------- ---------- +TaxiDemo1 WikiADF adf Microsoft.Azure.Management.DataFactory.Models.MappingDataFlow +``` + +This command creates a data flow named TaxiDemo1 in the data factory named WikiADF. +The command bases the data flow on information in the TaxiDemo1.json file. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The data flow name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: DataFlowName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFlow + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryV2DataFlow](./get-azdatafactoryv2dataflow.md) + +[Remove-AzDataFactoryV2DataFlow](./remove-azdatafactoryv2dataflow.md) diff --git a/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2Dataset.md b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2Dataset.md new file mode 100644 index 0000000000..998622a074 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2Dataset.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/set-azdatafactoryv2dataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2Dataset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2Dataset.md +--- + +# Set-AzDataFactoryV2Dataset + +## SYNOPSIS +Creates a dataset in Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Set-AzDataFactoryV2Dataset [-Name] <String> [-DefinitionFile] <String> [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzDataFactoryV2Dataset [-DefinitionFile] <String> [-ResourceId] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzDataFactoryV2Dataset cmdlet creates a dataset in Azure Data Factory. +If you specify a name for a dataset that already exists, this cmdlet prompts you for confirmation before it replaces the dataset. +If you specify the Force parameter, the cmdlet replaces the existing dataset without confirmation. +Perform these operations in the following order: + -- Create a data factory. + -- Create linked services. + -- Create datasets. + -- Create a pipeline. +If a dataset with the same name already exists in the data factory, this cmdlet prompts you to confirm whether to overwrite the existing dataset with the new dataset. +If you confirm to overwrite the existing dataset, the dataset definition is also replaced. + +## EXAMPLES + +### Example 1: Create a dataset +```powershell +Set-AzDataFactoryV2Dataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -DefinitionFile "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json" +``` + +```output + DatasetName : DAWikipediaClickEvents + ResourceGroupName : ADF + DataFactoryName : WikiADF + Structure : + Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset +``` + +This command creates a dataset named DA_WikipediaClickEvents in the data factory named WikiADF. +The command bases the dataset on information in the DAWikipediaClickEvents.json file. + +## PARAMETERS + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet creates a dataset in the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the dataset to create. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: DatasetName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet creates a dataset in the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataset + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryV2Dataset]() + +[Remove-AzDataFactoryV2Dataset]() diff --git a/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2IntegrationRuntime.md b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2IntegrationRuntime.md new file mode 100644 index 0000000000..e949742b52 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2IntegrationRuntime.md @@ -0,0 +1,720 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/set-azdatafactoryv2integrationruntime +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2IntegrationRuntime.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2IntegrationRuntime.md +--- + +# Set-AzDataFactoryV2IntegrationRuntime + +## SYNOPSIS +Updates an integration runtime. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Set-AzDataFactoryV2IntegrationRuntime [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-Name] <String> [-Type <String>] [-Description <String>] [-Location <String>] [-NodeSize <String>] + [-NodeCount <Int32>] [-CatalogServerEndpoint <String>] [-CatalogAdminCredential <PSCredential>] + [-CatalogPricingTier <String>] [-VNetId <String>] [-Subnet <String>] [-SubnetId <String>] + [-PublicIPs <String[]>] [-DataFlowComputeType <String>] [-DataFlowCoreCount <Int32>] + [-DataFlowTimeToLive <Int32>] [-SetupScriptContainerSasUri <String>] [-Edition <String>] + [-VNetInjectionMethod <String>] [-ExpressCustomSetup <ArrayList>] [-DataProxyIntegrationRuntimeName <String>] + [-DataProxyStagingLinkedServiceName <String>] [-DataProxyStagingPath <String>] + [-MaxParallelExecutionsPerNode <Int32>] [-LicenseType <String>] [-AuthKey <SecureString>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzDataFactoryV2IntegrationRuntime [-ResourceId] <String> [-Type <String>] [-Description <String>] + [-Location <String>] [-NodeSize <String>] [-NodeCount <Int32>] [-CatalogServerEndpoint <String>] + [-CatalogAdminCredential <PSCredential>] [-CatalogPricingTier <String>] [-VNetId <String>] [-Subnet <String>] + [-SubnetId <String>] [-PublicIPs <String[]>] [-DataFlowComputeType <String>] [-DataFlowCoreCount <Int32>] + [-DataFlowTimeToLive <Int32>] [-SetupScriptContainerSasUri <String>] [-Edition <String>] + [-VNetInjectionMethod <String>] [-ExpressCustomSetup <ArrayList>] [-DataProxyIntegrationRuntimeName <String>] + [-DataProxyStagingLinkedServiceName <String>] [-DataProxyStagingPath <String>] + [-MaxParallelExecutionsPerNode <Int32>] [-LicenseType <String>] [-AuthKey <SecureString>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByLinkedIntegrationRuntimeResourceId +``` +Set-AzDataFactoryV2IntegrationRuntime [-ResourceId] <String> [-Type <String>] [-Description <String>] + -SharedIntegrationRuntimeResourceId <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByLinkedIntegrationRuntimeName +``` +Set-AzDataFactoryV2IntegrationRuntime [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-Name] <String> [-Type <String>] [-Description <String>] -SharedIntegrationRuntimeResourceId <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Set-AzDataFactoryV2IntegrationRuntime [-InputObject] <PSIntegrationRuntime> [-Type <String>] + [-Description <String>] [-Location <String>] [-NodeSize <String>] [-NodeCount <Int32>] + [-CatalogServerEndpoint <String>] [-CatalogAdminCredential <PSCredential>] [-CatalogPricingTier <String>] + [-VNetId <String>] [-Subnet <String>] [-SubnetId <String>] [-PublicIPs <String[]>] + [-DataFlowComputeType <String>] [-DataFlowCoreCount <Int32>] [-DataFlowTimeToLive <Int32>] + [-SetupScriptContainerSasUri <String>] [-Edition <String>] [-VNetInjectionMethod <String>] + [-ExpressCustomSetup <ArrayList>] [-DataProxyIntegrationRuntimeName <String>] + [-DataProxyStagingLinkedServiceName <String>] [-DataProxyStagingPath <String>] + [-MaxParallelExecutionsPerNode <Int32>] [-LicenseType <String>] [-AuthKey <SecureString>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByLinkedIntegrationRuntimeObject +``` +Set-AzDataFactoryV2IntegrationRuntime [-InputObject] <PSIntegrationRuntime> [-Type <String>] + [-Description <String>] -SharedIntegrationRuntimeResourceId <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzDataFactoryV2IntegrationRuntime cmdlet updates an integration runtime with specific parameters. + +## EXAMPLES + +### Example 1: Update integration runtime description. +```powershell +Set-AzDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' ` + -Description 'New description' +``` + +```output + Id : /subscriptions/b3ee3a7f-7614-4644-ad07-afa832620b4b/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir + ResourceGroupName : rg-test-dfv2 + DataFactoryName : test-df-eu2 + Name : test-selfhost-ir + Description : New description +``` + +The cmdlet updates the description of integration runtime named 'test-selfhost-ir'. + +### Example 2: Share Self-hosted integration runtime. +```powershell +Set-AzDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' ` + -SharedIntegrationRuntimeResourceId '/subscriptions/b3ee3a7f-7614-4644-ad07-afa832620b4b/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir' -Type "SelfHosted" +``` + +```output + Id : /subscriptions/b3ee3a7f-7614-4644-ad07-afa832620b4b/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir + ResourceGroupName : rg-test-dfv2 + DataFactoryName : test-df-eu2 + Name : test-selfhost-ir + Description : New description +``` + +The cmdlet adds the ADF to use the shared integration runtime. When using `-SharedIntegrationRuntimeResourceId` parameter the `-Type` must also be included. Note that the data factory need to be granted permission to use the integration runtime before running cmdlet. + +### Example 3: Configure Self-Hosted IR as a proxy for Azure-SSIS IR in ADF. +```powershell +Set-AzDataFactoryV2IntegrationRuntime -ResourceGroupName testgroup ` + -DataFactoryName testdf ` + -Name SSISIRWithDataProxy ` + -DataProxyIntegrationRuntimeName proxySelfhostedIR ` + -DataProxyStagingLinkedServiceName AzureBlobStorage ` + -DataProxyStagingPath teststaging +``` + +```output + Location : EastUS + NodeSize : Standard_D8_v3 + NodeCount : 1 + MaxParallelExecutionsPerNode : 8 + CatalogServerEndpoint : + CatalogAdminUserName : + CatalogAdminPassword : + CatalogPricingTier : + VNetId : + Subnet : + SubnetId : + VNetInjectionMethod : Express + PublicIPs : + State : Initial + LicenseType : LicenseIncluded + SetupScriptContainerSasUri : + DataProxyIntegrationRuntimeName : proxySelfhostedIR + DataProxyStagingLinkedServiceName : AzureBlobStorage + DataProxyStagingPath : + Edition : Standard + Name : SSISIRWithDataProxy + Type : Managed + ResourceGroupName : testgroup + DataFactoryName : testdf + Description : + Id : /subscriptions/cb715d05-3337-4640-8c43-4f943c50d06e/resourceGroups/testgroup/providers/Microsoft.DataFactory/factories/testdf/integrationruntimes/SSISIRWithDataProxy +``` + +The cmdlet update Azure-SSIS integration runtime to use Self-hosted integration runtime as a data proxy. + +## PARAMETERS + +### -AuthKey +The authentication key of the self-hosted integration runtime. + +```yaml +Type: System.Security.SecureString +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CatalogAdminCredential +The catalog database administrator credential of the integration runtime. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CatalogPricingTier +The catalog database pricing tier of the integration runtime. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CatalogServerEndpoint +The catalog database server endpoint of the integration runtime. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByLinkedIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFlowComputeType +Compute type of the data flow cluster which will execute data flow job. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFlowCoreCount +Core count of the data flow cluster which will execute data flow job. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFlowTimeToLive +Time to live (in minutes) setting of the data flow cluster which will execute data flow job. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFlowEnableQuickReuse +To whether enable data flow cluster to be reused in the next dataflow activity. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataProxyIntegrationRuntimeName +The Self-Hosted Integration Runtime name which is used as a proxy + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataProxyStagingLinkedServiceName +The Azure Blob Storage Linked Service name that references the staging data store to be used when moving data between Self-Hosted and Azure-SSIS Integration Runtime + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataProxyStagingPath +The path in staging data store to be used when moving data between Self-Hosted and Azure-SSIS Integration Runtimes, a default container will be used if unspecified + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The integration runtime description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Edition +The edition for SSIS integration runtime which could be Standard or Enterprise, default is Standard if it is not specified. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: +Accepted values: Standard, Enterprise + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressCustomSetup +The express custom setup for SSIS integration runtime which could be used to setup configurations and 3rd party components without custom setup script. + +```yaml +Type: System.Collections.ArrayList +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject, ByLinkedIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LicenseType +The license type that you want to select for the SSIS IR. There are two types: LicenseIncluded or BasePrice. If you are qualified for the Azure Hybrid Use Benefit (AHUB) pricing, please select BasePrice. If not, please select LicenseIncluded. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: +Accepted values: LicenseIncluded, BasePrice + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The integration runtime location. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxParallelExecutionsPerNode +Maximum parallel execution count per node for a managed dedicated integration runtime. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByLinkedIntegrationRuntimeName +Aliases: IntegrationRuntimeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeCount +Target nodes count of the integration runtime. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeSize +The integration runtime node size. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIPs +The static public IP addresses which the integration runtime will use. + +```yaml +Type: System.String[] +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByLinkedIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId, ByLinkedIntegrationRuntimeResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SetupScriptContainerSasUri +The SAS URI of the Azure blob container that contains the custom setup script. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedIntegrationRuntimeResourceId +The resource id of the shared self-hosted integration runtime. + +```yaml +Type: System.String +Parameter Sets: ByLinkedIntegrationRuntimeResourceId, ByLinkedIntegrationRuntimeName, ByLinkedIntegrationRuntimeObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +The name of the subnet in the VNet. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: SubnetName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The ID of subnet, to which this Azure-SSIS integration runtime will be joined. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The integration runtime type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Managed, SelfHosted + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VNetId +The ID of the VNet that the integration runtime joins. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VNetInjectionMethod +The edition for SSIS integration runtime which could be Standard or Enterprise, default is Standard if it is not specified. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject +Aliases: +Accepted values: Standard, Express + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## NOTES + +## RELATED LINKS + +[Set-AzDataFactoryV2IntegrationRuntime]() diff --git a/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2LinkedService.md b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2LinkedService.md new file mode 100644 index 0000000000..377869ae6b --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2LinkedService.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/set-azdatafactoryv2linkedservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2LinkedService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2LinkedService.md +--- + +# Set-AzDataFactoryV2LinkedService + +## SYNOPSIS +Links a data store or a cloud service to Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Set-AzDataFactoryV2LinkedService [-Name] <String> [-DefinitionFile] <String> [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzDataFactoryV2LinkedService [-DefinitionFile] <String> [-ResourceId] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzDataFactoryV2LinkedService cmdlet links a data store or a cloud service to Azure Data Factory. +If you specify a name for a linked service that already exists, this cmdlet prompts you for confirmation before it replaces the linked service. +If you specify the Force parameter, the cmdlet replaces the existing linked service without confirmation. +Perform these operations in the following order: + -- Create a data factory. + -- Create linked services. + -- Create datasets. + -- Create a pipeline. + +## EXAMPLES + +### Example 1: Create a linked service +```powershell +Set-AzDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceCuratedWikiData" -File "C:\\samples\\WikiSample\\LinkedServiceCuratedWikiData.json" | Format-List +``` + +```output + LinkedServiceName : LinkedServiceCuratedWikiData + ResourceGroupName : ADF + DataFactoryName : WikiADF + Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService +``` + +This command creates a linked service named LinkedServiceCuratedWikiData in the data factory named WikiADF. +This linked service links an Azure blob store specified in the file to the data factory named WikiADF. +The command passes the result to the Format-List cmdlet by using the pipeline operator. +That Windows PowerShell cmdlet formats the results. +For more information, type Get-Help Format-List. + +## PARAMETERS + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet creates a linked service for the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the linked service to create. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: LinkedServiceName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet creates a linked service for the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryV2LinkedService]() + +[Remove-AzDataFactoryV2LinkedService]() diff --git a/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2Pipeline.md b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2Pipeline.md new file mode 100644 index 0000000000..64016099f0 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2Pipeline.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/set-azdatafactoryv2pipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2Pipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2Pipeline.md +--- + +# Set-AzDataFactoryV2Pipeline + +## SYNOPSIS +Creates a pipeline in Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Set-AzDataFactoryV2Pipeline [-Name] <String> [-DefinitionFile] <String> [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzDataFactoryV2Pipeline [-DefinitionFile] <String> [-ResourceId] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzDataFactoryV2Pipeline cmdlet creates a pipeline in Azure Data Factory. +If you specify a name for a pipeline that already exists, the cmdlet prompts you for confirmation before it replaces the pipeline. +If you specify the Force parameter, the cmdlet replaces the existing pipeline without confirmation. +Perform these operations in the following order: + -- Create a data factory. + -- Create linked services. + -- Create datasets. + -- Create a pipeline. +If a pipeline with the same name already exists in the data factory, this cmdlet prompts you to confirm whether to overwrite the existing pipeline with the new pipeline. +If you confirm to overwrite the existing pipeline, the pipeline definition is also replaced. + +## EXAMPLES + +### Example 1: Create a pipeline +```powershell +Set-AzDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" -File "C:\DPWikisample.json" +``` + +```output + PipelineName : DPWikisample + ResourceGroupName : ADF + DataFactoryName : WikiADF11 + Activities : {MyCopyActivity_0_0, MyCopyActivity_1_0} + Parameters : {[OutputBlobName, Microsoft.Azure.Management.DataFactory.Models.ParameterSpecification]} +``` + +This command creates a pipeline named DPWikisample in the data factory named ADF. +The command bases the pipeline on information in the DPWikisample.json file. +This file includes information about activities such as Copy Activity and HDInsight Activity in the pipeline. + +## PARAMETERS + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet creates a pipeline for the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet replaces an existing pipeline without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the pipeline to create. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: PipelineName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet creates a pipeline for the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryV2Pipeline]() + +[Remove-AzDataFactoryV2Pipeline]() + +[Invoke-AzDataFactoryV2Pipeline]() diff --git a/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2Trigger.md b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2Trigger.md new file mode 100644 index 0000000000..bf9b9f8774 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Set-AzDataFactoryV2Trigger.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/set-azdatafactoryv2trigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2Trigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Set-AzDataFactoryV2Trigger.md +--- + +# Set-AzDataFactoryV2Trigger + +## SYNOPSIS +Creates a trigger in a data factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Set-AzDataFactoryV2Trigger [-Name] <String> [-DefinitionFile] <String> [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzDataFactoryV2Trigger [-DefinitionFile] <String> [-ResourceId] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataFactoryV2Trigger** cmdlet creates a trigger in a data factory. If you specify a name for a trigger that already exists, the cmdlet prompts for confirmation before replacing the trigger. If you specify the _Force_ parameter, the cmdlet replaces the existing trigger without prompting for confirmation. Triggers are created in the 'Stopped' state, meaning that they don't immediately begin invoking pipelines that they reference. + +## EXAMPLES + +### Example 1: Create a trigger +```powershell +Set-AzDataFactoryV2Trigger -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "ScheduledTrigger" -DefinitionFile ".\scheduledTrigger.json" +``` + +```output + TriggerName : ScheduledTrigger + ResourceGroupName : ADF + DataFactoryName : WikiADF + Properties : Microsoft.Azure.Management.DataFactory.Models.ScheduleTrigger + RuntimeState : Stopped +``` + +Create a new trigger called "ScheduledTrigger" in the data factory "WikiADF". The trigger is created in the 'Stopped' state, meaning that it doesn't immediately start. A trigger can be started using the `Start-AzDataFactoryV2Trigger` cmdlet. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: TriggerName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger + +## NOTES + +## RELATED LINKS + +[Get-AzDataFactoryV2Trigger]() + +[Start-AzDataFactoryV2Trigger]() + +[Stop-AzDataFactoryV2Trigger]() + +[Remove-AzDataFactoryV2Trigger]() diff --git a/azps-10.1.0/Az.DataFactory/Start-AzDataFactoryV2DataFlowDebugSession.md b/azps-10.1.0/Az.DataFactory/Start-AzDataFactoryV2DataFlowDebugSession.md new file mode 100644 index 0000000000..92438dc63b --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Start-AzDataFactoryV2DataFlowDebugSession.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/start-azdatafactoryv2dataflowdebugsession +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Start-AzDataFactoryV2DataFlowDebugSession.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Start-AzDataFactoryV2DataFlowDebugSession.md +--- + +# Start-AzDataFactoryV2DataFlowDebugSession + +## SYNOPSIS +Starts a data flow debug session in Azure Data Factory + +## SYNTAX + +### ByFactoryName (Default) +``` +Start-AzDataFactoryV2DataFlowDebugSession [[-IntegrationRuntimeFile] <String>] [-AsJob] + [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Start-AzDataFactoryV2DataFlowDebugSession [[-IntegrationRuntimeFile] <String>] [-AsJob] + [-DataFactory] <PSDataFactory> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Start-AzDataFactoryV2DataFlowDebugSession [[-IntegrationRuntimeFile] <String>] [-AsJob] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This long running command starts a data flow debug session for the upcoming debug commands. This command can attach with an integration runtime definition to configure the size/type of debug session cluster. +The PowerShell command sequence for data flow debug workflow should be: +1. Start-AzDataFactoryV2DataFlowDebugSession +1. Add-AzDataFactoryV2DataFlowDebugSessionPackage +1. Invoke-AzDataFactoryV2DataFlowDebugSessionCommand (repeat this step for different commands/targets, or repeat step 2-3 in order to change the package file) +1. Stop-AzDataFactoryV2DataFlowDebugSession + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> +```powershell +$job = Start-AzDataFactoryV2DataFlowDebugSession -ResourceGroupName adf -DataFactoryName jikma0601sea -AsJob +$job + +Id Name PSJobTypeName State HasMoreData Location Command +-- ---- ------------- ----- ----------- -------- ------- +1 Long Running... AzureLongRun... Running True localhost Start-AzDataFactoryV2D... + +(After 5 minutes) + +$job + +Id Name PSJobTypeName State HasMoreData Location Command +-- ---- ------------- ----- ----------- -------- ------- +1 Long Running... AzureLongRun... Completed True localhost Start-AzDataFactoryV2D... + + +$job.Output + +SessionId Status +--------- ------ +550effe4-93a3-485c-8525-eaf25259efbd Succeeded + +``` + +Starts a debug session with AsJob flag. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntegrationRuntimeFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFlowDebugSession + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryV2DataFlowDebugSession](./Get-AzDataFactoryV2DataFlowDebugSession.md) + +[Add-AzDataFactoryV2DataFlowDebugSessionPackage](./Add-AzDataFactoryV2DataFlowDebugSessionPackage.md) + +[Invoke-AzDataFactoryV2DataFlowDebugSessionCommand](./Invoke-AzDataFactoryV2DataFlowDebugSessionCommand.md) + +[Stop-AzDataFactoryV2DataFlowDebugSession](./Stop-AzDataFactoryV2DataFlowDebugSession.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.DataFactory/Start-AzDataFactoryV2IntegrationRuntime.md b/azps-10.1.0/Az.DataFactory/Start-AzDataFactoryV2IntegrationRuntime.md new file mode 100644 index 0000000000..d54119ea32 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Start-AzDataFactoryV2IntegrationRuntime.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/start-azdatafactoryv2integrationruntime +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Start-AzDataFactoryV2IntegrationRuntime.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Start-AzDataFactoryV2IntegrationRuntime.md +--- + +# Start-AzDataFactoryV2IntegrationRuntime + +## SYNOPSIS +Starts a managed dedicated integration runtime. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Start-AzDataFactoryV2IntegrationRuntime [-Force] [-Name] <String> [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Start-AzDataFactoryV2IntegrationRuntime [-Force] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Start-AzDataFactoryV2IntegrationRuntime [-Force] [-InputObject] <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzDataFactoryV2IntegrationRuntime** cmdlet starts a managed dedicated integration runtime. The resource is provisioned and after the operation the state is 'Started'. + +## EXAMPLES + +### Example 1: Start an integration runtime +```powershell +Start-AzDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-dedicated-ir' -Force +``` + +```output + CreateTime : 9/11/2017 2:16:12 PM + Nodes : {tvm-1650185656_1-20170911t141751z} + OtherErrors : {} + LastOperation : + State : Started + Location : West US + NodeSize : Standard_D1_v2 + NodeCount : 1 + MaxParallelExecutionsPerNode : 1 + CatalogServerEndpoint : testsvr.database.windows.net + CatalogAdminUserName : admin + CatalogAdminPassword : ********** + CatalogPricingTier : S1 + VNetId : + Subnet : + SubnetId : + PublicIPs : + Id : /subscriptions/b3ee3a7f-7614-4644-ad07-afa832620b4b/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-dedicated-ir + ResourceGroupName : rg-test-dfv2 + DataFactoryName : test-df-eu2 + Name : test-dedicated-ir + Description : Reserved IR +``` + +This cmdlet starts a managed dedicated integration runtime named 'test-dedicated-ir'. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: IntegrationRuntimeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSManagedIntegrationRuntimeStatus + +## NOTES + +## RELATED LINKS + +[Stop-AzDataFactoryV2IntegrationRuntime]() diff --git a/azps-10.1.0/Az.DataFactory/Start-AzDataFactoryV2Trigger.md b/azps-10.1.0/Az.DataFactory/Start-AzDataFactoryV2Trigger.md new file mode 100644 index 0000000000..908d1aa006 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Start-AzDataFactoryV2Trigger.md @@ -0,0 +1,214 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/start-azdatafactoryv2trigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Start-AzDataFactoryV2Trigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Start-AzDataFactoryV2Trigger.md +--- + +# Start-AzDataFactoryV2Trigger + +## SYNOPSIS +Starts a trigger in a data factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Start-AzDataFactoryV2Trigger [-Name] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Start-AzDataFactoryV2Trigger [-InputObject] <PSTrigger> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Start-AzDataFactoryV2Trigger [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzDataFactoryV2Trigger** cmdlet starts a trigger in a data factory. If the trigger is in the 'Stopped' state, the cmdlet starts the trigger and it eventually invokes pipelines based on its definition. If the trigger is already in the 'Started' state, this cmdlet has no effect. If the Force parameter is specified, the cmdlet doesn't prompt before starting the trigger. + +## EXAMPLES + +### Example 1: Start a trigger +```powershell +Start-AzDataFactoryV2Trigger -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -TriggerName "ScheduledTrigger" +``` + +```output +Confirm +Are you sure you want to start trigger 'ScheduledTrigger' in data factory 'WikiADF'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +True +``` + +Starts a trigger called "ScheduledTrigger" in the data factory "WikiADF". + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Trigger object to start. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: TriggerName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger + +## NOTES + +## RELATED LINKS + +[Get-AzDataFactoryV2Trigger]() + +[Set-AzDataFactoryV2Trigger]() + +[Stop-AzDataFactoryV2Trigger]() + +[Remove-AzDataFactoryV2Trigger]() diff --git a/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2DataFlowDebugSession.md b/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2DataFlowDebugSession.md new file mode 100644 index 0000000000..40a32a7c38 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2DataFlowDebugSession.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/stop-azdatafactoryv2dataflowdebugsession +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Stop-AzDataFactoryV2DataFlowDebugSession.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Stop-AzDataFactoryV2DataFlowDebugSession.md +--- + +# Stop-AzDataFactoryV2DataFlowDebugSession + +## SYNOPSIS +Stops a data flow debug session in Azure Data Factory + +## SYNTAX + +### ByFactoryName (Default) +``` +Stop-AzDataFactoryV2DataFlowDebugSession [-SessionId] <String> [-PassThru] [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByFactoryObject +``` +Stop-AzDataFactoryV2DataFlowDebugSession [-SessionId] <String> [-PassThru] [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Stop-AzDataFactoryV2DataFlowDebugSession [-SessionId] <String> [-PassThru] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command stops the debug session, if not then the session will be automatically turned off according to Time To Live setting of the debug session. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzDataFactoryV2DataFlowDebugSession -ResourceGroupName adf -DataFactoryName WikiADF -SessionId fd76cd0d-8b37-4dc0-a370-3f9d43ac686d +``` + +```output +Confirm +Are you sure you want to stop data flow debug session 'fd76cd0d-8b37-4dc0-a370-3f9d43ac686d' in data factory 'WikiADF'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +``` +Stops a data flow debug session "fd76cd0d-8b37-4dc0-a370-3f9d43ac686d" in data factory "WikiADF" + +## PARAMETERS + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +If specified will write true in case operation succeeds. This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SessionId +The data flow debug session ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### System.Void + +### System.Boolean + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Start-AzDataFactoryV2DataFlowDebugSession](./Start-AzDataFactoryV2DataFlowDebugSession.md) + +[Get-AzDataFactoryV2DataFlowDebugSession](./Get-AzDataFactoryV2DataFlowDebugSession.md) + +[Add-AzDataFactoryV2DataFlowDebugSessionPackage](./Add-AzDataFactoryV2DataFlowDebugSessionPackage.md) + +[Invoke-AzDataFactoryV2DataFlowDebugSessionCommand](./Invoke-AzDataFactoryV2DataFlowDebugSessionCommand.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2IntegrationRuntime.md b/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2IntegrationRuntime.md new file mode 100644 index 0000000000..10a4e8eae8 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2IntegrationRuntime.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/stop-azdatafactoryv2integrationruntime +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Stop-AzDataFactoryV2IntegrationRuntime.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Stop-AzDataFactoryV2IntegrationRuntime.md +--- + +# Stop-AzDataFactoryV2IntegrationRuntime + +## SYNOPSIS +Stops a managed dedicated integration runtime. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Stop-AzDataFactoryV2IntegrationRuntime [-Force] [-Name] <String> [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Stop-AzDataFactoryV2IntegrationRuntime [-Force] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Stop-AzDataFactoryV2IntegrationRuntime [-Force] [-InputObject] <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzDataFactoryV2IntegrationRuntime** cmdlet stops a managed dedicated integration runtime in 'Started' state, which was started by the Start-AzDataFactoryV2IntegrationRuntime cmdlet. The resources are released and the state transfers to 'Stopped'. + +## EXAMPLES + +### Example 1: Stop a managed integration runtime that is in 'Started' state. +```powershell +Stop-AzDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df' -Name 'test-reserlved-ir' +``` + +The managed integration runtime 'test-reserlved-ir' is in 'Started' state. After running Stop-AzDataFactoryV2IntegrationRuntime cmdlet, the resources are released and the state transfers to 'Stopped'. + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: IntegrationRuntimeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### System.Void + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime + +## RELATED LINKS + +[Start-AzDataFactoryV2IntegrationRuntime]() diff --git a/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2PipelineRun.md b/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2PipelineRun.md new file mode 100644 index 0000000000..82340a1db9 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2PipelineRun.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/stop-azdatafactoryv2pipelinerun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Stop-AzDataFactoryV2PipelineRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Stop-AzDataFactoryV2PipelineRun.md +--- + +# Stop-AzDataFactoryV2PipelineRun + +## SYNOPSIS +Stops a pipeline run in a data factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Stop-AzDataFactoryV2PipelineRun [-PipelineRunId] <String> [-PassThru] [-ResourceGroupName] <String> + [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObject +``` +Stop-AzDataFactoryV2PipelineRun [-InputObject] <PSPipelineRun> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Stop-AzDataFactoryV2PipelineRun [-PipelineRunId] <String> [-PassThru] [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzDataFactoryV2PipelineRun** cmdlet stops a pipeline run in a data factory specified with the pipeline run ID. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzDataFactoryV2PipelineRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineRunId b9730a13-aa12-4926-a8b3-8e3a974ab0bd +``` + +```output +Confirm +Are you sure you want to stop pipeline run 'b9730a13-aa12-4926-a8b3-8e3a974ab0bd' in data factory 'WikiADF'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y + +true +``` + +This command stops the pipeline run with id b9730a13-aa12-4926-a8b3-8e3a974ab0bd in the factory WikiADF. + +## PARAMETERS + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Run ID of the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipelineRun +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified the cmdlet write true in case operation succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineRunId +The Run ID of the pipeline. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName, ByFactoryObject +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipelineRun + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2Trigger.md b/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2Trigger.md new file mode 100644 index 0000000000..0c15decd64 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2Trigger.md @@ -0,0 +1,214 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/stop-azdatafactoryv2trigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Stop-AzDataFactoryV2Trigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Stop-AzDataFactoryV2Trigger.md +--- + +# Stop-AzDataFactoryV2Trigger + +## SYNOPSIS +Stops a trigger in a data factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Stop-AzDataFactoryV2Trigger [-Name] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Stop-AzDataFactoryV2Trigger [-InputObject] <PSTrigger> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Stop-AzDataFactoryV2Trigger [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzDataFactoryV2Trigger** cmdlet stops a trigger in a data factory. If the trigger is in the 'Started' state, the cmdlet stops the trigger and no longer invokes pipelines. If the trigger is already in the 'Stopped' state, this cmdlet has no effect. If the Force parameter is specified, the cmdlet doesn't prompt before stopping the trigger. + +## EXAMPLES + +### Example 1: Stop a trigger +```powershell +Stop-AzDataFactoryV2Trigger -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -TriggerName "ScheduledTrigger" +``` + +```output +Confirm +Are you sure you want to stop trigger 'ScheduledTrigger' in data factory 'TestFactory'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +True +``` + +Stops a trigger called "ScheduledTrigger" in the data factory "WikiADF". + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Trigger object to start. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: TriggerName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger + +## NOTES + +## RELATED LINKS + +[Get-AzDataFactoryV2Trigger]() + +[Set-AzDataFactoryV2Trigger]() + +[Start-AzDataFactoryV2Trigger]() + +[Remove-AzDataFactoryV2Trigger]() diff --git a/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2TriggerRun.md b/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2TriggerRun.md new file mode 100644 index 0000000000..4bcf2a507e --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Stop-AzDataFactoryV2TriggerRun.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/stop-azdatafactoryv2triggerrun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Stop-AzDataFactoryV2TriggerRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Stop-AzDataFactoryV2TriggerRun.md +--- + +# Stop-AzDataFactoryV2TriggerRun + +## SYNOPSIS +Stops a trigger run in a data factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Stop-AzDataFactoryV2TriggerRun [-TriggerName] <String> [-TriggerRunId] <String> [-PassThru] + [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Stop-AzDataFactoryV2TriggerRun [-InputObject] <PSTriggerRun> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Stop-AzDataFactoryV2TriggerRun [-TriggerName] <String> [-TriggerRunId] <String> [-PassThru] + [-DataFactory] <PSDataFactory> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzDataFactoryV2TriggerRun** cmdlet stops a trigger run in a data factory specified with the trigger name and trigger run ID. +Currently only supported for TumblingWindowTriggers in WaitingOnDependency State. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzDataFactoryV2TriggerRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -TriggerName "testTumblingWindowTrigger" -TriggerRunId 08586002468005888497807248799CU16 +``` + +This command stops the trigger run with id '08586002468005888497807248799CU16' in the factory WikiADF. + +## PARAMETERS + +### -DataFactory +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The information about the trigger run. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSTriggerRun +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified the cmdlet write true in case operation succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TriggerName +The trigger name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName, ByFactoryObject +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TriggerRunId +The Run ID of the trigger. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName, ByFactoryObject +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTriggerRun + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataFactory/Suspend-AzDataFactoryPipeline.md b/azps-10.1.0/Az.DataFactory/Suspend-AzDataFactoryPipeline.md new file mode 100644 index 0000000000..5cb0d2cd63 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Suspend-AzDataFactoryPipeline.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml +Module Name: Az.DataFactory +ms.assetid: 1FF0B0F9-4B2C-46BC-8BED-12BE865E4480 +online version: https://learn.microsoft.com/powershell/module/az.datafactory/suspend-azdatafactorypipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Suspend-AzDataFactoryPipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Suspend-AzDataFactoryPipeline.md +--- + +# Suspend-AzDataFactoryPipeline + +## SYNOPSIS +Suspends a pipeline in Azure Data Factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Suspend-AzDataFactoryPipeline [-Name] <String> [-DataFactoryName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Suspend-AzDataFactoryPipeline [-Name] <String> [-DataFactory] <PSDataFactory> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Suspend-AzDataFactoryPipeline** cmdlet suspends a pipeline in Azure Data Factory. +You can resume the pipeline by using the Resume-AzDataFactoryPipeline cmdlet. + +## EXAMPLES + +### Example 1: Suspend a pipeline +```powershell +Suspend-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikiSample" -DataFactoryName "WikiADF" +``` + +```output +Confirm +Are you sure you want to suspend pipeline 'DPWikisample' in data factory 'WikiADF'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +True +``` + +This command suspends the pipeline named DPWikiSample in the data factory named WikiADF. +The command returns a value of $True. + +## PARAMETERS + +### -DataFactory +Specifies a **PSDataFactory** object. +This cmdlet suspends a pipeline that belongs to the data factory that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataFactoryName +Specifies the name of a data factory. +This cmdlet suspends a pipeline that belongs to the data factory that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the pipeline to suspend. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PipelineName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +This cmdlet suspends a pipeline that belongs to the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory + +## OUTPUTS + +### System.Boolean + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, data, factories + +## RELATED LINKS + +[Get-AzDataFactoryPipeline](./Get-AzDataFactoryPipeline.md) + +[New-AzDataFactoryPipeline](./New-AzDataFactoryPipeline.md) + +[Remove-AzDataFactoryPipeline](./Remove-AzDataFactoryPipeline.md) + +[Resume-AzDataFactoryPipeline](./Resume-AzDataFactoryPipeline.md) + +[Set-AzDataFactoryPipelineActivePeriod](./Set-AzDataFactoryPipelineActivePeriod.md) + + diff --git a/azps-10.1.0/Az.DataFactory/Sync-AzDataFactoryV2IntegrationRuntimeCredential.md b/azps-10.1.0/Az.DataFactory/Sync-AzDataFactoryV2IntegrationRuntimeCredential.md new file mode 100644 index 0000000000..d1029b8ea9 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Sync-AzDataFactoryV2IntegrationRuntimeCredential.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/sync-azdatafactoryv2integrationruntimecredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Sync-AzDataFactoryV2IntegrationRuntimeCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Sync-AzDataFactoryV2IntegrationRuntimeCredential.md +--- + +# Sync-AzDataFactoryV2IntegrationRuntimeCredential + +## SYNOPSIS +Synchronizes credentials among integration runtime nodes. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Sync-AzDataFactoryV2IntegrationRuntimeCredential [-Force] [-IntegrationRuntimeName] <String> + [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Sync-AzDataFactoryV2IntegrationRuntimeCredential [-Force] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Sync-AzDataFactoryV2IntegrationRuntimeCredential [-Force] [-InputObject] <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Sync-AzDataFactoryV2IntegrationRuntimeCredential** cmdlet synchronizes on-premises credentials among integration runtime nodes, which forces the credentials to be identical in all nodes. + +## EXAMPLES + +### Example 1: Sync an integration runtime credential + +Synchronizes credentials among integration runtime nodes. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Sync-AzDataFactoryV2IntegrationRuntimeCredential -DataFactoryName 'test-df-eu2' -IntegrationRuntimeName 'test-selfhost-ir' -ResourceGroupName 'rg-test-dfv2' +``` + +## PARAMETERS + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Runs the cmdlet without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntegrationRuntimeName +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what happens if the cmdlet runs, but doesn't run the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataFactory/Update-AzDataFactoryV2.md b/azps-10.1.0/Az.DataFactory/Update-AzDataFactoryV2.md new file mode 100644 index 0000000000..fa279d4ae8 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Update-AzDataFactoryV2.md @@ -0,0 +1,313 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/update-azdatafactoryv2 +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Update-AzDataFactoryV2.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Update-AzDataFactoryV2.md +--- + +# Update-AzDataFactoryV2 + +## SYNOPSIS +Updates the properties of a data factory. + +## SYNTAX + +### ByFactoryName (Default) +``` +Update-AzDataFactoryV2 [-ResourceGroupName] <String> [-Name] <String> [-IdentityType <String>] + [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>] + [-EncryptionVaultBaseUrl <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionUserAssignedIdentity <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Update-AzDataFactoryV2 [-IdentityType <String>] + [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>] + [-EncryptionVaultBaseUrl <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionUserAssignedIdentity <String>] [-InputObject] <PSDataFactory> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Update-AzDataFactoryV2 [-IdentityType <String>] + [-UserAssignedIdentity <System.Collections.Generic.IDictionary`2[System.String,System.Object]>] + [-EncryptionVaultBaseUrl <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionUserAssignedIdentity <String>] [-ResourceId] <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzDataFactoryV2** cmdlet updates tags or identity properties of a data factory. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF" -Tag @{myNewTagName = "myTagValue"} +``` + +```output +Confirm +Are you sure you want to update properties of the data factory 'WikiADF' in resource group 'ADF'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y + + +DataFactoryName : WikiADF +DataFactoryId : /subscriptions/1e42591f-1f0c-4c5a-b7f2-a268f6105ec5/resourceGroups/adf/providers/Microsoft.DataF + actory/factories/wikiadf +ResourceGroupName : ADF +Location : EastUS +Tags : {[myNewTagName, myTagValue]} +Identity : +ProvisioningState : Succeeded +``` + +This command updates the tags for the factory WikiADF to a dictionary containing a tag named myNewTagName with value myTagValue. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyName +The name of the key in Azure Key Vault to use as Customer Managed Key for encryption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyVersion +The version of the key used for CMK. If not provided, latest version will be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionUserAssignedIdentity +User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionVaultBaseUrl +The url of the Azure Key Vault used for encryption with CMK. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The Identity type that will be associated with your DataFactory. Options are 'SystemAssigned', 'UserAssigned' or 'SystemAssigned,UserAssigned' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Whether or not public network access is allowed for the data factory. Options are 'Enabled' or 'Disabled' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The data factory object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: DataFactoryName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The tags of the data factory. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The dictionary containing the user assigned identities of the data factory. + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.Object] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataFactory/Update-AzDataFactoryV2IntegrationRuntime.md b/azps-10.1.0/Az.DataFactory/Update-AzDataFactoryV2IntegrationRuntime.md new file mode 100644 index 0000000000..9ff98993c3 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Update-AzDataFactoryV2IntegrationRuntime.md @@ -0,0 +1,249 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/update-azdatafactoryv2integrationruntime +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Update-AzDataFactoryV2IntegrationRuntime.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Update-AzDataFactoryV2IntegrationRuntime.md +--- + +# Update-AzDataFactoryV2IntegrationRuntime + +## SYNOPSIS +Updates an integration runtime. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Update-AzDataFactoryV2IntegrationRuntime [-AutoUpdate <String>] [-AutoUpdateDelayOffset <TimeSpan>] + [-Name] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Update-AzDataFactoryV2IntegrationRuntime [-AutoUpdate <String>] [-AutoUpdateDelayOffset <TimeSpan>] + [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Update-AzDataFactoryV2IntegrationRuntime [-AutoUpdate <String>] [-AutoUpdateDelayOffset <TimeSpan>] + [-InputObject] <PSIntegrationRuntime> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzDataFactoryV2IntegrationRuntime** cmdlet updates integration runtime properties. Currently the cmdlet only supports updating 'AutoUpdate' and 'AutoUpdateDelayOffset' for self-hosted integration runtime. + +## EXAMPLES + +### Example 1: Updates an integration runtime +```powershell +$ts = New-TimeSpan -Hours 3 +Update-AzDataFactoryV2IntegrationRuntime ` + -ResourceGroupName 'rg-test-dfv2' ` + -DataFactoryName 'test-df-eu2' ` + -Name 'test-selfhost-ir' ` + -AutoUpdate Off ` + -AutoUpdateDelayOffset $ts +``` + +```output +Nodes : {Node_1} +CreateTime : 11/18/2017 2:45:38 PM +InternalChannelEncryption : +Version : 3.2.6519.3 +Capabilities : {[serviceBusConnected, True], [httpsPortEnabled, True], [credentialInSync, True], [connectedToResourceManager, True]...} +ScheduledUpdateDate : +UpdateDelayOffset : +LocalTimeZoneOffset : +AutoUpdate : Off +ServiceUrls : {wu.frontend.int.clouddatahub-int.net, *.servicebus.windows.net} +State : Online +Id : /subscriptions/41fcbc45-c594-4152-a8f1-fcbcd6452aea/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir +Type : SelfHosted +ResourceGroupName : rg-test-dfv2 +DataFactoryName : test-df-eu2 +Name : test-selfhost-ir +Description : New 2 description +``` + +The cmdlet updates self-hosted integration runtime named 'test-selfhost-ir'. + +## PARAMETERS + +### -AutoUpdate +Enable or disable the self-hosted integration runtime auto-update. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: On, Off + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoUpdateDelayOffset +The time in hour of the day for the self-hosted integration runtime auto-update. + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: IntegrationRuntimeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSSelfHostedIntegrationRuntimeStatus + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime + +## RELATED LINKS + +[Set-AzDataFactoryV2IntegrationRuntime]() +[Get-AzDataFactoryV2IntegrationRuntime]() + diff --git a/azps-10.1.0/Az.DataFactory/Update-AzDataFactoryV2IntegrationRuntimeNode.md b/azps-10.1.0/Az.DataFactory/Update-AzDataFactoryV2IntegrationRuntimeNode.md new file mode 100644 index 0000000000..bb82d26a16 --- /dev/null +++ b/azps-10.1.0/Az.DataFactory/Update-AzDataFactoryV2IntegrationRuntimeNode.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV2.dll-Help.xml +Module Name: Az.DataFactory +online version: https://learn.microsoft.com/powershell/module/az.datafactory/update-azdatafactoryv2integrationruntimenode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Update-AzDataFactoryV2IntegrationRuntimeNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataFactory/DataFactoryV2/help/Update-AzDataFactoryV2IntegrationRuntimeNode.md +--- + +# Update-AzDataFactoryV2IntegrationRuntimeNode + +## SYNOPSIS +Updates self-hosted integration runtime node. + +## SYNTAX + +### ByIntegrationRuntimeName (Default) +``` +Update-AzDataFactoryV2IntegrationRuntimeNode -Name <String> -ConcurrentJobsLimit <Int32> + [-IntegrationRuntimeName] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Update-AzDataFactoryV2IntegrationRuntimeNode -Name <String> -ConcurrentJobsLimit <Int32> [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationRuntimeObject +``` +Update-AzDataFactoryV2IntegrationRuntimeNode -Name <String> -ConcurrentJobsLimit <Int32> + [-InputObject] <PSIntegrationRuntime> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzDataFactoryV2IntegrationRuntimeNode** cmdlet updates properties of self-hosted integration runtime node in a data factory. Currently only supports updating 'ConcurrentJobsLimit'. + +## EXAMPLES + +### Example 1: Updates self-hosted integration runtime node +```powershell +Update-AzDataFactoryV2IntegrationRuntimeNode ` + -ResourceGroupName 'rg-test-dfv2' ` + -DataFactoryName 'test-df-eu2' ` + -IntegrationRuntimeName 'test-selfhost-ir' ` + -Name 'Node_1' ` + -ConcurrentJobsLimit 3 +``` + +The cmdlet updates 'ConcurrentJobsLimit' to 3 for node 'Node_1' in self-hosted integration runtime 'test-selfhost-ir'. + +## PARAMETERS + +### -ConcurrentJobsLimit +The number of concurrent jobs permitted to run on the integration runtime node. +Values between 1 and maxConcurrentJobs are allowed. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFactoryName +The data factory name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime +Parameter Sets: ByIntegrationRuntimeObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntegrationRuntimeName +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The integration runtime node name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationRuntimeName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.DataFactoryV2.Models.PSSelfHostedIntegrationRuntimeNode + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime + +## RELATED LINKS + +[Set-AzDataFactoryV2IntegrationRuntime]() +[Get-AzDataFactoryV2IntegrationRuntime]() + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Add-AzDataLakeAnalyticsDataSource.md b/azps-10.1.0/Az.DataLakeAnalytics/Add-AzDataLakeAnalyticsDataSource.md new file mode 100644 index 0000000000..a9df63884c --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Add-AzDataLakeAnalyticsDataSource.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: A38D8BF6-D302-4586-B7AF-4C80B546E96F +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/add-azdatalakeanalyticsdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Add-AzDataLakeAnalyticsDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Add-AzDataLakeAnalyticsDataSource.md +--- + +# Add-AzDataLakeAnalyticsDataSource + +## SYNOPSIS +Adds a data source to a Data Lake Analytics account. + +## SYNTAX + +### AddDataLakeStorageAccount +``` +Add-AzDataLakeAnalyticsDataSource [-Account] <String> [-DataLakeStore] <String> [[-ResourceGroupName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AddBlobStorageAccount +``` +Add-AzDataLakeAnalyticsDataSource [-Account] <String> [-Blob] <String> [-AccessKey] <String> + [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzDataLakeAnalyticsDataSource** cmdlet adds a data source to an Azure Data Lake Analytics account. + +## EXAMPLES + +### Example 1: Add a data source to an account +```powershell +Add-AzDataLakeAnalyticsDataSource -Account "ContosoAdlA" -DataLakeStore "ContosoAdlS" +``` + +This command adds a Data Lake Store data source to a Data Lake Analytics account. + +### Example 2 + +Adds a data source to a Data Lake Analytics account. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Add-AzDataLakeAnalyticsDataSource -AccessKey '...newaccesskey...' -Account 'ContosoAdlA' -Blob 'AzureStorage01' +``` + +## PARAMETERS + +### -AccessKey +Specifies the access key of the Azure Blob storage account to add. + +```yaml +Type: System.String +Parameter Sets: AddBlobStorageAccount +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Account +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Blob +Specifies the name of the Azure Blob Storage account to add. + +```yaml +Type: System.String +Parameter Sets: AddBlobStorageAccount +Aliases: AzureBlob + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataLakeStore +Specifies the name of the Azure Data Lake Store account to add. + +```yaml +Type: System.String +Parameter Sets: AddDataLakeStorageAccount +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of the Data Lake Analytics account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS + +[Remove-AzDataLakeAnalyticsDataSource](./Remove-AzDataLakeAnalyticsDataSource.md) + +[Set-AzDataLakeAnalyticsDataSource](./Set-AzDataLakeAnalyticsDataSource.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Add-AzDataLakeAnalyticsFirewallRule.md b/azps-10.1.0/Az.DataLakeAnalytics/Add-AzDataLakeAnalyticsFirewallRule.md new file mode 100644 index 0000000000..3da4050233 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Add-AzDataLakeAnalyticsFirewallRule.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/add-azdatalakeanalyticsfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Add-AzDataLakeAnalyticsFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Add-AzDataLakeAnalyticsFirewallRule.md +--- + +# Add-AzDataLakeAnalyticsFirewallRule + +## SYNOPSIS +Adds a firewall rule to a Data Lake Analytics account. + +## SYNTAX + +``` +Add-AzDataLakeAnalyticsFirewallRule [-Account] <String> [-Name] <String> [-StartIpAddress] <String> + [-EndIpAddress] <String> [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzDataLakeAnalyticsFirewallRule** cmdlet adds a firewall rule to an Azure Data Lake Analytics account. + +## EXAMPLES + +### Example 1: Add a firewall rule +```powershell +Add-AzDataLakeAnalyticsFirewallRule -Account "ContosoAdlAcct" -Name "My firewall rule" -StartIpAddress 127.0.0.1 -EndIpAddress 127.0.0.10 +``` + +This command adds the firewall rule named "my firewall rule" from account "ContosoAdlAcct" with the IP range: 127.0.0.1 - 127.0.0.10 + +## PARAMETERS + +### -Account +The Data Lake Analytics account to add the firewall rule to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIpAddress +The end of the valid ip range for the firewall rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which want to retrieve the account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartIpAddress +The start of the valid ip range for the firewall rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsFirewallRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Az.DataLakeAnalytics.md b/azps-10.1.0/Az.DataLakeAnalytics/Az.DataLakeAnalytics.md new file mode 100644 index 0000000000..428cf53569 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Az.DataLakeAnalytics.md @@ -0,0 +1,108 @@ +--- +Module Name: Az.DataLakeAnalytics +Module Guid: eca73aa1-a68f-4ceb-9775-70759316a57b +Download Help Link: https://learn.microsoft.com/powershell/module/az.datalakeanalytics +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Az.DataLakeAnalytics.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Az.DataLakeAnalytics.md +--- + +# Az.DataLakeAnalytics Module +## Description +The topics in this section document the Azure PowerShell cmdlets for Azure Data Lake Analytics in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.DataLakeAnalytics namespace. + +## Az.DataLakeAnalytics Cmdlets +### [Add-AzDataLakeAnalyticsDataSource](Add-AzDataLakeAnalyticsDataSource.md) +Adds a data source to a Data Lake Analytics account. + +### [Add-AzDataLakeAnalyticsFirewallRule](Add-AzDataLakeAnalyticsFirewallRule.md) +Adds a firewall rule to a Data Lake Analytics account. + +### [Get-AzDataLakeAnalyticsAccount](Get-AzDataLakeAnalyticsAccount.md) +Gets information about a Data Lake Analytics account. + +### [Get-AzDataLakeAnalyticsCatalogItem](Get-AzDataLakeAnalyticsCatalogItem.md) +Gets a Data Lake Analytics catalog item or types of items. + +### [Get-AzDataLakeAnalyticsCatalogItemAclEntry](Get-AzDataLakeAnalyticsCatalogItemAclEntry.md) +Gets an entry in the ACL of a catalog or catalog item in Data Lake Analytics. + +### [Get-AzDataLakeAnalyticsComputePolicy](Get-AzDataLakeAnalyticsComputePolicy.md) +Gets a Data Lake Analytics compute policy or list of compute policies. + +### [Get-AzDataLakeAnalyticsDataSource](Get-AzDataLakeAnalyticsDataSource.md) +Gets a Data Lake Analytics data source. + +### [Get-AzDataLakeAnalyticsFirewallRule](Get-AzDataLakeAnalyticsFirewallRule.md) +Retrieves a firewall rule or list of firewall rules from a Data Lake Analytics account. + +### [Get-AzDataLakeAnalyticsJob](Get-AzDataLakeAnalyticsJob.md) +Gets a Data Lake Analytics job. + +### [Get-AzDataLakeAnalyticsJobPipeline](Get-AzDataLakeAnalyticsJobPipeline.md) +Gets a Data Lake Analytics Job pipeline or pipelines. + +### [Get-AzDataLakeAnalyticsJobRecurrence](Get-AzDataLakeAnalyticsJobRecurrence.md) +Gets a Data Lake Analytics Job recurrence or recurrences. + +### [New-AzDataLakeAnalyticsAccount](New-AzDataLakeAnalyticsAccount.md) +Creates a Data Lake Analytics account. + +### [New-AzDataLakeAnalyticsCatalogCredential](New-AzDataLakeAnalyticsCatalogCredential.md) +Creates a new Azure Data Lake Analytics catalog credential. + +### [New-AzDataLakeAnalyticsComputePolicy](New-AzDataLakeAnalyticsComputePolicy.md) +Creates a Data Lake Analytics compute policy rule for a specific AAD entity. + +### [Remove-AzDataLakeAnalyticsAccount](Remove-AzDataLakeAnalyticsAccount.md) +Deletes a Data Lake Analytics account. + +### [Remove-AzDataLakeAnalyticsCatalogCredential](Remove-AzDataLakeAnalyticsCatalogCredential.md) +Deletes an Azure Data Lake Analytics credential. + +### [Remove-AzDataLakeAnalyticsCatalogItemAclEntry](Remove-AzDataLakeAnalyticsCatalogItemAclEntry.md) +Deletes an entry from the ACL of a catalog or catalog item in Data Lake Analytics. + +### [Remove-AzDataLakeAnalyticsComputePolicy](Remove-AzDataLakeAnalyticsComputePolicy.md) +Removes a specified Azure Data Lake Analytics compute policy + +### [Remove-AzDataLakeAnalyticsDataSource](Remove-AzDataLakeAnalyticsDataSource.md) +Removes a data source from a Data Lake Analytics account. + +### [Remove-AzDataLakeAnalyticsFirewallRule](Remove-AzDataLakeAnalyticsFirewallRule.md) +Removes a firewall rule from a Data Lake Analytics account. + +### [Set-AzDataLakeAnalyticsAccount](Set-AzDataLakeAnalyticsAccount.md) +Modifies a Data Lake Analytics account. + +### [Set-AzDataLakeAnalyticsCatalogCredential](Set-AzDataLakeAnalyticsCatalogCredential.md) +Modifies an Azure Data Lake Analytics catalog credential password. + +### [Set-AzDataLakeAnalyticsCatalogItemAclEntry](Set-AzDataLakeAnalyticsCatalogItemAclEntry.md) +Modifies an entry in the ACL of a catalog or catalog item in Data Lake Analytics. + +### [Set-AzDataLakeAnalyticsDataSource](Set-AzDataLakeAnalyticsDataSource.md) +Modifies the details of a data source of a Data Lake Analytics account. + +### [Set-AzDataLakeAnalyticsFirewallRule](Set-AzDataLakeAnalyticsFirewallRule.md) +Updates a firewall rule in a Data Lake Analytics account. + +### [Stop-AzDataLakeAnalyticsJob](Stop-AzDataLakeAnalyticsJob.md) +Cancels a job. + +### [Submit-AzDataLakeAnalyticsJob](Submit-AzDataLakeAnalyticsJob.md) +Submits a job. + +### [Test-AzDataLakeAnalyticsAccount](Test-AzDataLakeAnalyticsAccount.md) +Checks for the existence of a Data Lake Analytics account. + +### [Test-AzDataLakeAnalyticsCatalogItem](Test-AzDataLakeAnalyticsCatalogItem.md) +Checks for the existence of a catalog item. + +### [Update-AzDataLakeAnalyticsComputePolicy](Update-AzDataLakeAnalyticsComputePolicy.md) +Updates a Data Lake Analytics compute policy rule for a specific AAD entity. + +### [Wait-AzDataLakeAnalyticsJob](Wait-AzDataLakeAnalyticsJob.md) +Waits for a job to complete. + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsAccount.md b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsAccount.md new file mode 100644 index 0000000000..d613356eb6 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsAccount.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: 4EA01047-021C-4FA5-82F0-5102BA114BC2 +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/get-azdatalakeanalyticsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsAccount.md +--- + +# Get-AzDataLakeAnalyticsAccount + +## SYNOPSIS +Gets information about a Data Lake Analytics account. + +## SYNTAX + +### GetAllInSubscription (Default) +``` +Get-AzDataLakeAnalyticsAccount [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceGroup +``` +Get-AzDataLakeAnalyticsAccount [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetBySpecificAccount +``` +Get-AzDataLakeAnalyticsAccount [[-ResourceGroupName] <String>] [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeAnalyticsAccount** cmdlet gets information about an Azure Data Lake Analytics account. + +## EXAMPLES + +### Example 1: Get information about a Data Lake Analytics account +```powershell +Get-AzDataLakeAnalyticsAccount -Name "ContosoAdlAccount" +``` + +This command gets information about the account named ContosoAdlAccount. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Data Lake Analytics account. + +```yaml +Type: System.String +Parameter Sets: GetBySpecificAccount +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of the Data Lake Analytics account. + +```yaml +Type: System.String +Parameter Sets: GetByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetBySpecificAccount +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsAccount + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsAccountBasic + +## NOTES + +## RELATED LINKS + +[New-AzDataLakeAnalyticsAccount](./New-AzDataLakeAnalyticsAccount.md) + +[Remove-AzDataLakeAnalyticsAccount](./Remove-AzDataLakeAnalyticsAccount.md) + +[Set-AzDataLakeAnalyticsAccount](./Set-AzDataLakeAnalyticsAccount.md) + +[Test-AzDataLakeAnalyticsAccount](./Test-AzDataLakeAnalyticsAccount.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsCatalogItem.md b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsCatalogItem.md new file mode 100644 index 0000000000..ae0e6ff402 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsCatalogItem.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: A6899341-1E5E-4F8B-8D5D-5923B1223628 +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/get-azdatalakeanalyticscatalogitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsCatalogItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsCatalogItem.md +--- + +# Get-AzDataLakeAnalyticsCatalogItem + +## SYNOPSIS +Gets a Data Lake Analytics catalog item or types of items. + +## SYNTAX + +``` +Get-AzDataLakeAnalyticsCatalogItem [-Account] <String> [-ItemType] <CatalogItemType> + [[-Path] <CatalogPathInstance>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeAnalyticsCatalogItem** gets a specified Azure Data Lake Analytics catalog item, or gets catalog items of a specified type. + +## EXAMPLES + +### Example 1: Get a specified database +```powershell +Get-AzDataLakeAnalyticsCatalogItem -Account "contosoadla" -ItemType Database -Path "databaseName" +``` + +This command gets the specified database. + +### Example 2: Get tables in a specified database and schema +```powershell +Get-AzDataLakeAnalyticsCatalogItem -AccountName "contosoadla" -ItemType Table -Path "databaseName.schemaName" +``` + +This command gets a list of tables in the specified database. + +## PARAMETERS + +### -Account +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemType +Specifies the catalog item type of the item(s) being fetched or listed. +The acceptable values for this parameter are: +- Database +- Schema +- Assembly +- Table +- TableValuedFunction +- TableStatistics +- ExternalDataSource +- View +- Procedure +- Secret +- Credential +- Types +- TablePartition + +```yaml +Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+CatalogItemType +Parameter Sets: (All) +Aliases: +Accepted values: Database, Schema, Assembly, Table, TablePartition, TableValuedFunction, TableStatistics, ExternalDataSource, View, Procedure, Secret, Credential, Types, Package + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the multi-part path to the item to retrieve, or to the parent item of the items to list. +The parts of the path should be separated by a period (.). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+CatalogItemType + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance + +## OUTPUTS + +### Microsoft.Azure.Management.DataLake.Analytics.Models.CatalogItem + +## NOTES + +## RELATED LINKS + +[Test-AzDataLakeAnalyticsCatalogItem](./Test-AzDataLakeAnalyticsCatalogItem.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsCatalogItemAclEntry.md b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsCatalogItemAclEntry.md new file mode 100644 index 0000000000..5d669d58da --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsCatalogItemAclEntry.md @@ -0,0 +1,256 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/get-azdatalakeanalyticscatalogitemaclentry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsCatalogItemAclEntry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsCatalogItemAclEntry.md +--- + +# Get-AzDataLakeAnalyticsCatalogItemAclEntry + +## SYNOPSIS +Gets an entry in the ACL of a catalog or catalog item in Data Lake Analytics. + +## SYNTAX + +### GetCatalogAclEntry (Default) +``` +Get-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetCatalogAclEntryForUserOwner +``` +Get-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-UserOwner] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetCatalogAclEntryForGroupOwner +``` +Get-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-GroupOwner] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetCatalogItemAclEntry +``` +Get-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> -ItemType <String> -Path <CatalogPathInstance> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetCatalogItemAclEntryForUserOwner +``` +Get-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-UserOwner] -ItemType <String> + -Path <CatalogPathInstance> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetCatalogItemAclEntryForGroupOwner +``` +Get-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-GroupOwner] -ItemType <String> + -Path <CatalogPathInstance> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeAnalyticsCatalogItemAclEntry** cmdlet gets a list of entries (ACEs) in the access control list (ACL) of a catalog or catalog item in Data Lake Analytics. + +## EXAMPLES + +### Example 1: Get the ACL for a catalog +```powershell +Get-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" +``` + +```output +Type Id Permissions +---- -- ----------- +User 90a6f74b-fd73-490e-900a-c4f0f9694d02 Read +Group 902b155a-5601-4ca8-8178-ad3289211f88 ReadWrite +Other 00000000-0000-0000-0000-000000000000 None +``` + +This command gets the ACL for the catalog of the specified Data Lake Analytics account + +### Example 2: Get the ACL entry of user owner for a catalog +```powershell +Get-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -UserOwner +``` + +```output +Type Id Permissions +---- -- ----------- +UserOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc ReadWrite +``` + +This command gets ACL entry of the user owner for the catalog of the specified Data Lake Analytics account + +### Example 3: Get the ACL entry of group owner for a catalog +```powershell +Get-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -GroupOwner +``` + +```output +Type Id Permissions +---- -- ----------- +GroupOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc ReadWrite +``` + +This command gets ACL entry of the group owner for the catalog of the specified Data Lake Analytics account + +### Example 4: Get the ACL for a database +```powershell +Get-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -ItemType Database -Path "databaseName" +``` + +```output +Type Id Permissions +---- -- ----------- +User 90a6f74b-fd73-490e-900a-c4f0f9694d02 Read +Group 902b155a-5601-4ca8-8178-ad3289211f88 ReadWrite +Other 00000000-0000-0000-0000-000000000000 None +``` + +This command gets the ACL for the database of the specified Data Lake Analytics account + +### Example 5: Get the ACL entry of user owner for a database +```powershell +Get-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -UserOwner -ItemType Database -Path "databaseName" +``` + +```output +Type Id Permissions +---- -- ----------- +UserOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc ReadWrite +``` + +This command gets the ACL entry of the user owner for the database of the specified Data Lake Analytics account + +### Example 6: Get the ACL entry of group owner for a database +```powershell +Get-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -GroupOwner -ItemType Database -Path "databaseName" +``` + +```output +Type Id Permissions +---- -- ----------- +GroupOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc ReadWrite +``` + +This command gets the ACL entry of the group owner for the database of the specified Data Lake Analytics account + +## PARAMETERS + +### -Account +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupOwner +Get ACL entry of catalog for group owner + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetCatalogAclEntryForGroupOwner, GetCatalogItemAclEntryForGroupOwner +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemType +Specifies the type of the catalog or catalog item(s). The acceptable values for this parameter are: +- Catalog +- Database + +```yaml +Type: System.String +Parameter Sets: GetCatalogItemAclEntry, GetCatalogItemAclEntryForUserOwner, GetCatalogItemAclEntryForGroupOwner +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Analytics path of an catalog or catalog item. +The parts of the path should be separated by a period (.). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance +Parameter Sets: GetCatalogItemAclEntry, GetCatalogItemAclEntryForUserOwner, GetCatalogItemAclEntryForGroupOwner +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserOwner +Get ACL entry of catalog for user owner. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetCatalogAclEntryForUserOwner, GetCatalogItemAclEntryForUserOwner +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsAcl + +## NOTES + +## RELATED LINKS + +[U-SQL now offers database level access control](https://github.com/Azure/AzureDataLake/blob/master/docs/Release_Notes/2016/2016_08_01/USQL_Release_Notes_2016_08_01.md#u-sql-now-offers-database-level-access-control) + +[Remove-AzDataLakeAnalyticsCatalogItemAclEntry](Remove-AzDataLakeAnalyticsCatalogItemAclEntry.md) + +[Set-AzDataLakeAnalyticsCatalogItemAclEntry](Set-AzDataLakeAnalyticsCatalogItemAclEntry.md) diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsComputePolicy.md b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsComputePolicy.md new file mode 100644 index 0000000000..d639a1138d --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsComputePolicy.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/get-azdatalakeanalyticscomputepolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsComputePolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsComputePolicy.md +--- + +# Get-AzDataLakeAnalyticsComputePolicy + +## SYNOPSIS +Gets a Data Lake Analytics compute policy or list of compute policies. + +## SYNTAX + +``` +Get-AzDataLakeAnalyticsComputePolicy [-ResourceGroupName <String>] [-Account] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeAnalyticsComputePolicy** gets a specified Azure Data Lake Analytics compute policy or a list of policies. + +## EXAMPLES + +### Example 1: Get a specified compute policy +```powershell +Get-AzDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name myPolicy +``` + +This command gets the specified compute policy with name 'myPolicy' in account 'contosoadla'. + +### Example 2: Get a list of all compute policies in the account +```powershell +Get-AzDataLakeAnalyticsComputePolicy -AccountName "contosoadla" +``` + +This command gets a list of all compute policies in the account "contosoadla" + +## PARAMETERS + +### -Account +Name of the account to get the compute policy or policies from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the compute policy to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ComputePolicyName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which you the account exists. +Optional and will attempt to discover if not provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsComputePolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsDataSource.md b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsDataSource.md new file mode 100644 index 0000000000..0392384e19 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsDataSource.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: 0377C4E9-C1DC-49BA-BBC4-5598C83234F8 +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/get-azdatalakeanalyticsdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsDataSource.md +--- + +# Get-AzDataLakeAnalyticsDataSource + +## SYNOPSIS +Gets a Data Lake Analytics data source. + +## SYNTAX + +### GetAllDataSources (Default) +``` +Get-AzDataLakeAnalyticsDataSource [-Account] <String> [[-ResourceGroupName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetDataLakeStoreAccount +``` +Get-AzDataLakeAnalyticsDataSource [-Account] <String> [-DataLakeStore] <String> [[-ResourceGroupName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetBlobStorageAccount +``` +Get-AzDataLakeAnalyticsDataSource [-Account] <String> [-Blob] <String> [[-ResourceGroupName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeAnalyticsDataSource** cmdlet gets an Azure Data Lake Analytics data source. + +## EXAMPLES + +### Example 1: Get a data source from an account +```powershell +Get-AzDataLakeAnalyticsDataSource -AccountName "ContosoAdlA" -DataLakeStore "ContosoAdls" +``` + +This command gets a Data Lake Store data source named ContosoAdls from a Data Lake Analytics account. + +### Example 2: Get the list of Data Lake Store accounts in a Data Lake Analytics account +```powershell +Get-AzDataLakeAnalyticsDataSource -AccountName "ContosoAdlA" +``` + +This command gets all Data Lake Store accounts from a Data Lake Analytics account. + +## PARAMETERS + +### -Account +Specifies the Data Lake Analytics account that this cmdlet gets data sources. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Blob +Specifies the name of the Azure Blob Storage data source. + +```yaml +Type: System.String +Parameter Sets: GetBlobStorageAccount +Aliases: AzureBlob + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataLakeStore +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: GetDataLakeStoreAccount +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name that contains the data source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSStorageAccountInfo + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeStoreAccountInfo + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.AdlDataSource + +## NOTES + +## RELATED LINKS + +[Add-AzDataLakeAnalyticsDataSource](./Add-AzDataLakeAnalyticsDataSource.md) + +[Remove-AzDataLakeAnalyticsDataSource](./Remove-AzDataLakeAnalyticsDataSource.md) + +[Set-AzDataLakeAnalyticsDataSource](./Set-AzDataLakeAnalyticsDataSource.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsFirewallRule.md b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsFirewallRule.md new file mode 100644 index 0000000000..a59f081f2f --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsFirewallRule.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/get-azdatalakeanalyticsfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsFirewallRule.md +--- + +# Get-AzDataLakeAnalyticsFirewallRule + +## SYNOPSIS +Retrieves a firewall rule or list of firewall rules from a Data Lake Analytics account. + +## SYNTAX + +``` +Get-AzDataLakeAnalyticsFirewallRule [-Account] <String> [[-Name] <String>] [[-ResourceGroupName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeAnalyticsFirewallRule** cmdlet retrieves a firewall rule or list of firewall rules from an Azure Data Lake Analytics account. + +## EXAMPLES + +### Example 1: Get a firewall rule +```powershell +Get-AzDataLakeAnalyticsFirewallRule -Account "ContosoAdlAcct" -Name "My firewall rule" +``` + +This command gets the firewall rule named "my firewall rule" from account "ContosoAdlAcct" + +### Example 2: List all firewall rules +```powershell +Get-AzDataLakeAnalyticsFirewallRule -Account "ContosoAdlAcct" +``` + +This command gets all firewall rules from account "ContosoAdlAcct" + +## PARAMETERS + +### -Account +The Data Lake Analytics account to get the firewall rule from + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which want to retrieve the account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsFirewallRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsJob.md b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsJob.md new file mode 100644 index 0000000000..d6457c6fdb --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsJob.md @@ -0,0 +1,315 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: A0293D80-5935-4D2C-AF11-2837FEC95760 +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/get-azdatalakeanalyticsjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsJob.md +--- + +# Get-AzDataLakeAnalyticsJob + +## SYNOPSIS +Gets a Data Lake Analytics job. + +## SYNTAX + +### GetAllInResourceGroupAndAccount (Default) +``` +Get-AzDataLakeAnalyticsJob [-Account] <String> [[-Name] <String>] [[-Submitter] <String>] + [[-SubmittedAfter] <DateTimeOffset>] [[-SubmittedBefore] <DateTimeOffset>] [[-State] <JobState[]>] + [[-Result] <JobResult[]>] [-Top <Int32>] [-PipelineId <Guid>] [-RecurrenceId <Guid>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetBySpecificJobInformation +``` +Get-AzDataLakeAnalyticsJob [-Account] <String> [-JobId] <Guid> [[-Include] <ExtendedJobData>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeAnalyticsJob** cmdlet gets an Azure Data Lake Analytics job. +If you do not specify a job, this cmdlet gets all jobs. + +## EXAMPLES + +### Example 1: Get a specified job +```powershell +Get-AzDataLakeAnalyticsJob -Account "contosoadla" -JobId $JobID01 +``` + +This command gets the job with the specified ID. + +### Example 2: Get jobs submitted in the past week +```powershell +Get-AzDataLakeAnalyticsJob -Account "contosoadla" -SubmittedAfter (Get-Date).AddDays(-7) +``` + +This command gets jobs submitted in the past week. + +## PARAMETERS + +### -Account +Specifies the name of a Data Lake Analytics account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Include +Specifies options that indicate the type of additional information to retrieve about the job. +The acceptable values for this parameter are: +- None +- DebugInfo +- Statistics +- All + +```yaml +Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+ExtendedJobData +Parameter Sets: GetBySpecificJobInformation +Aliases: +Accepted values: None, All, DebugInfo, Statistics + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of the job to get. + +```yaml +Type: System.Guid +Parameter Sets: GetBySpecificJobInformation +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies a name to use to filter the job list results. +The acceptable values for this parameter are: +- None +- DebugInfo +- Statistics +- All + +```yaml +Type: System.String +Parameter Sets: GetAllInResourceGroupAndAccount +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PipelineId +An optional ID that indicates only jobs part of the specified pipeline should be returned. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: GetAllInResourceGroupAndAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecurrenceId +An optional ID that indicates only jobs part of the specified recurrence should be returned. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: GetAllInResourceGroupAndAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Result +Specifies a result filter for the job results. +The acceptable values for this parameter are: +- None +- Cancelled +- Failed +- Succeeded + +```yaml +Type: Microsoft.Azure.Management.DataLake.Analytics.Models.JobResult[] +Parameter Sets: GetAllInResourceGroupAndAccount +Aliases: +Accepted values: None, Succeeded, Cancelled, Failed + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies a state filter for the job results. +The acceptable values for this parameter are: +- Accepted +- New +- Compiling +- Scheduling +- Queued +- Starting +- Paused +- Running +- Ended + +```yaml +Type: Microsoft.Azure.Management.DataLake.Analytics.Models.JobState[] +Parameter Sets: GetAllInResourceGroupAndAccount +Aliases: +Accepted values: Accepted, Compiling, Ended, New, Queued, Running, Scheduling, Starting, Paused, WaitingForCapacity + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubmittedAfter +Specifies a date filter. +Use this parameter to filter the job list result to jobs submitted after the specified date. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: GetAllInResourceGroupAndAccount +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubmittedBefore +Specifies a date filter. +Use this parameter to filter the job list result to jobs submitted before the specified date. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: GetAllInResourceGroupAndAccount +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Submitter +Specifies the email address of a user. +Use this parameter to filter the job list results to jobs submitted by a specified user. + +```yaml +Type: System.String +Parameter Sets: GetAllInResourceGroupAndAccount +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +An optional value which indicates the number of jobs to return. Default value is 500 + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: GetAllInResourceGroupAndAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+ExtendedJobData + +### System.Nullable`1[[System.DateTimeOffset, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Management.DataLake.Analytics.Models.JobState[] + +### Microsoft.Azure.Management.DataLake.Analytics.Models.JobResult[] + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Management.DataLake.Analytics.Models.JobInformation + +## NOTES + +## RELATED LINKS + +[Stop-AzDataLakeAnalyticsJob](./Stop-AzDataLakeAnalyticsJob.md) + +[Submit-AzDataLakeAnalyticsJob](./Submit-AzDataLakeAnalyticsJob.md) + +[Wait-AzDataLakeAnalyticsJob](./Wait-AzDataLakeAnalyticsJob.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsJobPipeline.md b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsJobPipeline.md new file mode 100644 index 0000000000..ae011ffed3 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsJobPipeline.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/get-azdatalakeanalyticsjobpipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsJobPipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsJobPipeline.md +--- + +# Get-AzDataLakeAnalyticsJobPipeline + +## SYNOPSIS +Gets a Data Lake Analytics Job pipeline or pipelines. + +## SYNTAX + +### GetAllInAccount (Default) +``` +Get-AzDataLakeAnalyticsJobPipeline [-Account] <String> [-SubmittedAfter <DateTimeOffset>] + [-SubmittedBefore <DateTimeOffset>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetBySpecificJobPipeline +``` +Get-AzDataLakeAnalyticsJobPipeline [-Account] <String> [-PipelineId] <Guid> [-SubmittedAfter <DateTimeOffset>] + [-SubmittedBefore <DateTimeOffset>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeAnalyticsJobPipeline** gets a specified Azure Data Lake Analytics Job pipeline or a list of pipelines. + +## EXAMPLES + +### Example 1: Get a specified pipeline +```powershell +Get-AzDataLakeAnalyticsJobPipeline -Account "contosoadla" -PipelineId 83cb7ad2-3523-4b82-b909-d478b0d8aea3 +``` + +This command gets the specified pipeline with id '83cb7ad2-3523-4b82-b909-d478b0d8aea3' in account 'contosoadla'. + +### Example 2: Get a list of all pipelines in the account +```powershell +Get-AzDataLakeAnalyticsJobPipeline -AccountName "contosoadla" +``` + +This command gets a list of all pipelines in the account "contosoadla" + +## PARAMETERS + +### -Account +Name of the Data Lake Analytics account name under which want to retrieve the job pipeline. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineId +ID of the specific job pipeline to return information for. + +```yaml +Type: System.Guid +Parameter Sets: GetBySpecificJobPipeline +Aliases: Id + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SubmittedAfter +An optional filter which returns job pipeline(s) only submitted after the specified time. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubmittedBefore +An optional filter which returns job pipeline(s) only submitted before the specified time. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +### System.Nullable`1[[System.DateTimeOffset, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSJobPipelineInformation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsJobRecurrence.md b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsJobRecurrence.md new file mode 100644 index 0000000000..51e5a3f059 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Get-AzDataLakeAnalyticsJobRecurrence.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/get-azdatalakeanalyticsjobrecurrence +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsJobRecurrence.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Get-AzDataLakeAnalyticsJobRecurrence.md +--- + +# Get-AzDataLakeAnalyticsJobRecurrence + +## SYNOPSIS +Gets a Data Lake Analytics Job recurrence or recurrences. + +## SYNTAX + +### GetAllInAccount (Default) +``` +Get-AzDataLakeAnalyticsJobRecurrence [-Account] <String> [-SubmittedAfter <DateTimeOffset>] + [-SubmittedBefore <DateTimeOffset>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetBySpecificJobRecurrence +``` +Get-AzDataLakeAnalyticsJobRecurrence [-Account] <String> [-RecurrenceId] <Guid> + [-SubmittedAfter <DateTimeOffset>] [-SubmittedBefore <DateTimeOffset>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeAnalyticsJobRecurrence** gets a specified Azure Data Lake Analytics Job recurrence or a list of recurrence. + +## EXAMPLES + +### Example 1: Get a specified recurrence +```powershell +Get-AzDataLakeAnalyticsJobRecurrence -Account "contosoadla" -RecurrenceId 83cb7ad2-3523-4b82-b909-d478b0d8aea3 +``` + +This command gets the specified job recurrence with id '83cb7ad2-3523-4b82-b909-d478b0d8aea3' in account 'contosoadla'. + +### Example 2: Get a list of all recurrences in the account +```powershell +Get-AzDataLakeAnalyticsJobRecurrence -AccountName "contosoadla" +``` + +This command gets a list of all recurrences in the account "contosoadla" + +## PARAMETERS + +### -Account +Name of the Data Lake Analytics account name under which want to retrieve the job recurrence. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrenceId +ID of the specific job recurrence to return information for. + +```yaml +Type: System.Guid +Parameter Sets: GetBySpecificJobRecurrence +Aliases: Id + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SubmittedAfter +An optional filter which returns job recurrence(s) only submitted after the specified time. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubmittedBefore +An optional filter which returns job recurrence(s) only submitted before the specified time. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +### System.Nullable`1[[System.DateTimeOffset, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSJobRecurrenceInformation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeAnalytics/New-AzDataLakeAnalyticsAccount.md b/azps-10.1.0/Az.DataLakeAnalytics/New-AzDataLakeAnalyticsAccount.md new file mode 100644 index 0000000000..b3fe1db452 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/New-AzDataLakeAnalyticsAccount.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: 0A7CD695-6D14-4BC9-B960-0CAFE502B88B +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/new-azdatalakeanalyticsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/New-AzDataLakeAnalyticsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/New-AzDataLakeAnalyticsAccount.md +--- + +# New-AzDataLakeAnalyticsAccount + +## SYNOPSIS +Creates a Data Lake Analytics account. + +## SYNTAX + +``` +New-AzDataLakeAnalyticsAccount [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + [-DefaultDataLakeStore] <String> [[-Tag] <Hashtable>] [-MaxAnalyticsUnits <Int32>] [-MaxJobCount <Int32>] + [-QueryStoreRetention <Int32>] [-Tier <TierType>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataLakeAnalyticsAccount** cmdlet creates an Azure Data Lake Analytics account. + +## EXAMPLES + +### Example 1: Create a Data Lake Analytics account +```powershell +New-AzDataLakeAnalyticsAccount -Name "ContosoAdlAccount" -ResourceGroupName "ContosoOrg" -Location "East US 2" -DefaultDataLakeStore "ContosoAdlStore" +``` + +This command creates a Data Lake Analytics account named ContosoAdlAccount that uses the ContosoAdlStore Data Store, in the resource group named ContosoOrg. + +## PARAMETERS + +### -DefaultDataLakeStore +Specifies the name of the Data Lake Store account to set as the default data source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location at which to create the Data Lake Analytics account. +Only East US 2 is supported at this time. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxAnalyticsUnits +The optional maximum supported analytics units for this account. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: MaxDegreeOfParallelism + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxJobCount +The optional maximum supported jobs running under the account at the same time. If none is specified, defaults to 3 + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -QueryStoreRetention +The optional number of days that job metadata is retained. If none specified, the default is 30 days. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of the Data Lake Analytics account. +To create a resource group, use the New-AzResourceGroup cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A string,string dictionary of tags associated with this account + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tier +The desired commitment tier for this account to use. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Analytics.Models.TierType] +Parameter Sets: (All) +Aliases: +Accepted values: Consumption, Commitment100AUHours, Commitment500AUHours, Commitment1000AUHours, Commitment5000AUHours, Commitment10000AUHours, Commitment50000AUHours, Commitment100000AUHours, Commitment500000AUHours + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Analytics.Models.TierType, Microsoft.Azure.Management.DataLake.Analytics, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsAccount + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeAnalyticsAccount](./Get-AzDataLakeAnalyticsAccount.md) + +[Remove-AzDataLakeAnalyticsAccount](./Remove-AzDataLakeAnalyticsAccount.md) + +[Set-AzDataLakeAnalyticsAccount](./Set-AzDataLakeAnalyticsAccount.md) + +[Test-AzDataLakeAnalyticsAccount](./Test-AzDataLakeAnalyticsAccount.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/New-AzDataLakeAnalyticsCatalogCredential.md b/azps-10.1.0/Az.DataLakeAnalytics/New-AzDataLakeAnalyticsCatalogCredential.md new file mode 100644 index 0000000000..adcfeeb9a9 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/New-AzDataLakeAnalyticsCatalogCredential.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: BB6AF5A9-49BD-4A76-9F3F-44B62D2AB842 +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/new-azdatalakeanalyticscatalogcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/New-AzDataLakeAnalyticsCatalogCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/New-AzDataLakeAnalyticsCatalogCredential.md +--- + +# New-AzDataLakeAnalyticsCatalogCredential + +## SYNOPSIS +Creates a new Azure Data Lake Analytics catalog credential. + +## SYNTAX + +### CreateByHostNameAndPort (Default) +``` +New-AzDataLakeAnalyticsCatalogCredential [-Account] <String> [-DatabaseName] <String> + [-CredentialName] <String> [-Credential] <PSCredential> [-Uri] <Uri> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByFullURI +``` +New-AzDataLakeAnalyticsCatalogCredential [-Account] <String> [-DatabaseName] <String> + [-CredentialName] <String> [-Credential] <PSCredential> [-DatabaseHost] <String> [-Port] <Int32> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDataLakeAnalyticsCatalogCredential cmdlet creates a new credential to use in an Azure Data Lake Analytics catalog for connecting to external data sources. + +## EXAMPLES + +### Example 1: Create a credential for a catalog specifying host and port +```powershell +New-AzDataLakeAnalyticsCatalogCredential -AccountName "ContosoAdlAccount" ` + -DatabaseName "databaseName" ` + -CredentialName "exampleDbCred" ` + -Credential (Get-Credential) ` + -DatabaseHost "example.contoso.com" -Port 8080 +``` + +This command creates the specified credential for the specified account, database, host and port using https protocol. + +### Example 2: Create a credential for a catalog specifying full URI +```powershell +New-AzDataLakeAnalyticsCatalogCredential -AccountName "ContosoAdlAccount" ` + -DatabaseName "databaseName" ` + -CredentialName "exampleDbCred" ` + -Credential (Get-Credential) ` + -Uri "http://httpExample.contoso.com:8080" +``` + +This command creates the specified credential for the specified account, database and external data source URI. + +## PARAMETERS + +### -Account +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Credential +Specifies the user name and corresponding password of the credential. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CredentialName +Specifies the name and password of the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseHost +Specifies the host name of the external data source the credential can connect to in the format mydatabase.contoso.com. + +```yaml +Type: System.String +Parameter Sets: CreateByFullURI +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database in the Data Lake Analytics account that the credential will be stored in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Specifies the port number used to connect to the specified DatabaseHost using this credential. + +```yaml +Type: System.Int32 +Parameter Sets: CreateByFullURI +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Uri +Specifies the full Uniform Resource Identifier (URI) of the external data source this credential can connect to. + +```yaml +Type: System.Uri +Parameter Sets: CreateByHostNameAndPort +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.PSCredential + +### System.Uri + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Management.DataLake.Analytics.Models.USqlCredential + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeAnalytics/New-AzDataLakeAnalyticsComputePolicy.md b/azps-10.1.0/Az.DataLakeAnalytics/New-AzDataLakeAnalyticsComputePolicy.md new file mode 100644 index 0000000000..39aa4d5791 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/New-AzDataLakeAnalyticsComputePolicy.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/new-azdatalakeanalyticscomputepolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/New-AzDataLakeAnalyticsComputePolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/New-AzDataLakeAnalyticsComputePolicy.md +--- + +# New-AzDataLakeAnalyticsComputePolicy + +## SYNOPSIS +Creates a Data Lake Analytics compute policy rule for a specific AAD entity. + +## SYNTAX + +``` +New-AzDataLakeAnalyticsComputePolicy [-ResourceGroupName <String>] [-Account] <String> [-Name] <String> + [-ObjectId] <Guid> [-ObjectType] <String> [-MaxAnalyticsUnitsPerJob <Int32>] [-MinPriorityPerJob <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataLakeAnalyticsComputePolicy** creates the specified compute policy rule for a specific AAD entity in an Azure Data Lake Analytics account. + +## EXAMPLES + +### Example 1: Create a compute policy with only one rule +```powershell +New-AzDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name "myPolicy" -ObjectId 83cb7ad2-3523-4b82-b909-d478b0d8aea3 -ObjectType User -MaxAnalyticsUnitsPerJob 5 +``` + +This command creates a policy called "myPolicy" in account "contosoadla" for the user with id "83cb7ad2-3523-4b82-b909-d478b0d8aea3" that ensures they cannot submit any job with more than 5 analytics units. + +### Example 2: Create a compute policy with both rules set +```powershell +New-AzDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name "myPolicy" -ObjectId 83cb7ad2-3523-4b82-b909-d478b0d8aea3 -ObjectType User -MaxAnalyticsUnitsPerJob 5 -MinPriorityPerJob 100 +``` + +This command creates a policy called "myPolicy" in account "contosoadla" for the user with id "83cb7ad2-3523-4b82-b909-d478b0d8aea3" that ensures they cannot submit any job with more than 5 analytics units or with a priority lower than 100 + +## PARAMETERS + +### -Account +Name of the account to add the compute policy to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxAnalyticsUnitsPerJob +The maximum supported analytics units per job for this policy. +Either this, MinPriorityPerJob, or both parameters must be specified. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: MaxDegreeOfParallelismPerJob + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MinPriorityPerJob +The minimum supported priority per job for this policy. +Either this, MaxAnalyticsUnitsPerJob, or both parameters must be specified. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the compute policy to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ComputePolicyName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ObjectId +The Azure Active Directory object id for the user or group to apply the policy to. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ObjectType +The Azure Active Directory object type for the object ID passed in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: User, Group, ServicePrincipal + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which you the account exists. +Optional and will attempt to discover if not provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsComputePolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsAccount.md b/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsAccount.md new file mode 100644 index 0000000000..dcca05ee82 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsAccount.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: AEAD985C-F342-4B24-9BFD-6448436FE9BD +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/remove-azdatalakeanalyticsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Remove-AzDataLakeAnalyticsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Remove-AzDataLakeAnalyticsAccount.md +--- + +# Remove-AzDataLakeAnalyticsAccount + +## SYNOPSIS +Deletes a Data Lake Analytics account. + +## SYNTAX + +``` +Remove-AzDataLakeAnalyticsAccount [-Name] <String> [[-ResourceGroupName] <String>] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeAnalyticsAccount** cmdlet permanently deletes an Azure Data Lake Analytics account. + +## EXAMPLES + +### Example 1: Remove an account +```powershell +Remove-AzDataLakeAnalyticsAccount -Name "ContosoAdlAccount" +``` + +This command removes the specified Data Lake Analytics account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of the Data Lake Analytics account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeAnalyticsAccount](./Get-AzDataLakeAnalyticsAccount.md) + +[New-AzDataLakeAnalyticsAccount](./New-AzDataLakeAnalyticsAccount.md) + +[Set-AzDataLakeAnalyticsAccount](./Set-AzDataLakeAnalyticsAccount.md) + +[Test-AzDataLakeAnalyticsAccount](./Test-AzDataLakeAnalyticsAccount.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsCatalogCredential.md b/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsCatalogCredential.md new file mode 100644 index 0000000000..99aafa973e --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsCatalogCredential.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: C6BB6E4D-6009-4796-866B-17115FDFA06D +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/remove-azdatalakeanalyticscatalogcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Remove-AzDataLakeAnalyticsCatalogCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Remove-AzDataLakeAnalyticsCatalogCredential.md +--- + +# Remove-AzDataLakeAnalyticsCatalogCredential + +## SYNOPSIS +Deletes an Azure Data Lake Analytics credential. + +## SYNTAX + +``` +Remove-AzDataLakeAnalyticsCatalogCredential [-Account] <String> [-DatabaseName] <String> [-Name] <String> + [[-Password] <PSCredential>] [-Recurse] [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzDataLakeAnalyticsCatalogCredential cmdlet deletes an Azure Data Lake Analytics catalog credential. + +## EXAMPLES + +### Example 1: Remove a credential +```powershell +Remove-AzDataLakeAnalyticsCatalogCredential -AccountName "ContosoAdla" ` + -DatabaseName "DatabaseName" ` + -Name "CredName" +``` + +This command removes the specified Data Lake Analytics catalog credential. + +## PARAMETERS + +### -Account +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database that holds the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet does not wait for the operation to complete. +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The password for the credential. +This is required if the caller is not the owner of the account. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Recurse +Indicates that this delete operation should go through and also delete and drop all resources dependent on this credential. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.PSCredential + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsCatalogItemAclEntry.md b/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsCatalogItemAclEntry.md new file mode 100644 index 0000000000..539b2970cf --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsCatalogItemAclEntry.md @@ -0,0 +1,241 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/remove-azdatalakeanalyticscatalogitemaclentry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Remove-AzDataLakeAnalyticsCatalogItemAclEntry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Remove-AzDataLakeAnalyticsCatalogItemAclEntry.md +--- + +# Remove-AzDataLakeAnalyticsCatalogItemAclEntry + +## SYNOPSIS +Deletes an entry from the ACL of a catalog or catalog item in Data Lake Analytics. + +## SYNTAX + +### RemoveCatalogAclEntryForUser (Default) +``` +Remove-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-User] -ObjectId <Guid> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveCatalogItemAclEntryForUser +``` +Remove-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-User] -ObjectId <Guid> -ItemType <String> + -Path <CatalogPathInstance> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RemoveCatalogAclEntryForGroup +``` +Remove-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-Group] -ObjectId <Guid> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveCatalogItemAclEntryForGroup +``` +Remove-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-Group] -ObjectId <Guid> -ItemType <String> + -Path <CatalogPathInstance> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeAnalyticsCatalogItemAclEntry** cmdlet removes an entry (ACE) from the access control list (ACL) of a catalog or catalog item in Data Lake Analytics. + +## EXAMPLES + +### Example 1: Remove the user ACL for a catalog +```powershell +Remove-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -User -ObjectId (Get-AzADUser -Mail "PattiFuller@contoso.com").Id +``` + +This command removes the catalog ACL for Patti Fuller of the contosoadla account. + +### Example 2: Remove the user ACL for a database +```powershell +Remove-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -User -ObjectId (Get-AzADUser -Mail "PattiFuller@contoso.com").Id -ItemType Database -Path "databaseName" +``` + +This command removes the database ACL for Patti Fuller of the contosoadla account. + +## PARAMETERS + +### -Account +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Remove ACL entry of catalog for group. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RemoveCatalogAclEntryForGroup, RemoveCatalogItemAclEntryForGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemType +Specifies the type of the catalog or catalog item(s). The acceptable values for this parameter are: +- Catalog +- Database + +```yaml +Type: System.String +Parameter Sets: RemoveCatalogItemAclEntryForUser, RemoveCatalogItemAclEntryForGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ObjectId +The identity of the user to remove. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: Id, UserId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates a boolean response should be returned indicating the result of the delete operation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Analytics path of an catalog or catalog item. +The parts of the path should be separated by a period (.). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance +Parameter Sets: RemoveCatalogItemAclEntryForUser, RemoveCatalogItemAclEntryForGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -User +Remove ACL entry of catalog for user. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RemoveCatalogAclEntryForUser, RemoveCatalogItemAclEntryForUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[U-SQL now offers database level access control](https://github.com/Azure/AzureDataLake/blob/master/docs/Release_Notes/2016/2016_08_01/USQL_Release_Notes_2016_08_01.md#u-sql-now-offers-database-level-access-control) + +[Get-AzDataLakeAnalyticsCatalogItemAclEntry](Get-AzDataLakeAnalyticsCatalogItemAclEntry.md) + +[Set-AzDataLakeAnalyticsCatalogItemAclEntry](Set-AzDataLakeAnalyticsCatalogItemAclEntry.md) diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsComputePolicy.md b/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsComputePolicy.md new file mode 100644 index 0000000000..8b5de3b665 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsComputePolicy.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/remove-azdatalakeanalyticscomputepolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Remove-AzDataLakeAnalyticsComputePolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Remove-AzDataLakeAnalyticsComputePolicy.md +--- + +# Remove-AzDataLakeAnalyticsComputePolicy + +## SYNOPSIS +Removes a specified Azure Data Lake Analytics compute policy + +## SYNTAX + +``` +Remove-AzDataLakeAnalyticsComputePolicy [-ResourceGroupName <String>] [-Account] <String> [-Name] <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeAnalyticsComputePolicy** removes a specified Azure Data Lake Analytics compute policy. + +## EXAMPLES + +### Example 1: Remove a compute policy +```powershell +Remove-AzDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name myPolicy +``` + +This command removes the specified compute policy with name 'myPolicy' in account 'contosoadla'. + +## PARAMETERS + +### -Account +Name of the account to remove the compute policy from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the compute policy to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ComputePolicyName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Return true upon successful deletion. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which you the account exists. +Optional and will attempt to discover if not provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsDataSource.md b/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsDataSource.md new file mode 100644 index 0000000000..013dfd8e5e --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsDataSource.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: E0E2617F-F6F1-434E-AD7C-27D309C2C3DA +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/remove-azdatalakeanalyticsdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Remove-AzDataLakeAnalyticsDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Remove-AzDataLakeAnalyticsDataSource.md +--- + +# Remove-AzDataLakeAnalyticsDataSource + +## SYNOPSIS +Removes a data source from a Data Lake Analytics account. + +## SYNTAX + +### RemoveDataLakeStorageAccount +``` +Remove-AzDataLakeAnalyticsDataSource [-Account] <String> [-DataLakeStore] <String> [-Force] [-PassThru] + [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RemoveBlobStorageAccount +``` +Remove-AzDataLakeAnalyticsDataSource [-Account] <String> [-Blob] <String> [-Force] [-PassThru] + [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeAnalyticsDataSource** cmdlet removes a data source from an Azure Data Lake Analytics account. + +## EXAMPLES + +### Example 1: Remove a data source +```powershell +Remove-AzDataLakeAnalyticsDataSource -Account "ContosoAdlAccount" -Blob "AzureStorage01" +``` + +This command removes the data source named AzureStorage01 from the account named ContosoAdlAccount. + +## PARAMETERS + +### -Account +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Blob +Specifies the name of the AzureBlob Storage account to remove. + +```yaml +Type: System.String +Parameter Sets: RemoveBlobStorageAccount +Aliases: AzureBlob + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataLakeStore +Specifies the name of the AzureData Lake Store account to remove. + +```yaml +Type: System.String +Parameter Sets: RemoveDataLakeStorageAccount +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of the Data Lake Analytics account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Add-AzDataLakeAnalyticsDataSource](./Add-AzDataLakeAnalyticsDataSource.md) + +[Set-AzDataLakeAnalyticsDataSource](./Set-AzDataLakeAnalyticsDataSource.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsFirewallRule.md b/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsFirewallRule.md new file mode 100644 index 0000000000..594cf2addd --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Remove-AzDataLakeAnalyticsFirewallRule.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/remove-azdatalakeanalyticsfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Remove-AzDataLakeAnalyticsFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Remove-AzDataLakeAnalyticsFirewallRule.md +--- + +# Remove-AzDataLakeAnalyticsFirewallRule + +## SYNOPSIS +Removes a firewall rule from a Data Lake Analytics account. + +## SYNTAX + +``` +Remove-AzDataLakeAnalyticsFirewallRule [-Account] <String> [[-Name] <String>] [-PassThru] + [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeAnalyticsFirewallRule** cmdlet removes a firewall rule from an Azure Data Lake Analytics account. + +## EXAMPLES + +### Example 1: Remove a firewall rule +```powershell +Remove-AzDataLakeAnalyticsFirewallRule -Account "ContosoAdlAcct" -Name "My firewall rule" +``` + +This command removes the firewall rule named "my firewall rule" from account "ContosoAdlAcct" + +## PARAMETERS + +### -Account +The Data Lake Analytics account to remove the firewall rule from + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates a boolean response should be returned indicating the result of the delete operation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which want to retrieve the account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsAccount.md b/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsAccount.md new file mode 100644 index 0000000000..275ba6ab10 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsAccount.md @@ -0,0 +1,234 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: 8B10E476-F283-4BDC-BFAD-A33F8EC38341 +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/set-azdatalakeanalyticsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Set-AzDataLakeAnalyticsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Set-AzDataLakeAnalyticsAccount.md +--- + +# Set-AzDataLakeAnalyticsAccount + +## SYNOPSIS +Modifies a Data Lake Analytics account. + +## SYNTAX + +``` +Set-AzDataLakeAnalyticsAccount [-Name] <String> [[-Tag] <Hashtable>] [[-ResourceGroupName] <String>] + [-MaxAnalyticsUnits <Int32>] [-MaxJobCount <Int32>] [-QueryStoreRetention <Int32>] [-Tier <TierType>] + [-FirewallState <FirewallState>] [-AllowAzureIpState <FirewallAllowAzureIpsState>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeAnalyticsAccount** cmdlet modifies an Azure Data Lake Analytics account. + +## EXAMPLES + +### Example 1: Modify the data source of an account +```powershell +Set-AzDataLakeAnalyticsAccount -Name "ContosoAdlAcct" -Tag @{"stage"="production"} +``` + +This command changes the default data source and the Tags property of the account. + +### Example 2 + +Modifies a Data Lake Analytics account. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Set-AzDataLakeAnalyticsAccount -AllowAzureIpState Enabled -FirewallState Enabled -Name 'ContosoAdlAcct' -ResourceGroupName myresourcegroup +``` + +## PARAMETERS + +### -AllowAzureIpState +Optionally allow/block Azure originating IPs through the firewall. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Analytics.Models.FirewallAllowAzureIpsState] +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallState +Optionally enable/disable existing firewall rules. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Analytics.Models.FirewallState] +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxAnalyticsUnits +The optional maximum supported analytics units to update the account with. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: MaxDegreeOfParallelism + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxJobCount +The optional maximum supported jobs running under the account at the same time to set. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -QueryStoreRetention +The optional number of days that job metadata is retained to set in the account. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of the Data Lake Analytics account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A string,string dictionary of tags associated with this account that should replace the current set of tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tier +The desired commitment tier for this account to use. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Analytics.Models.TierType] +Parameter Sets: (All) +Aliases: +Accepted values: Consumption, Commitment100AUHours, Commitment500AUHours, Commitment1000AUHours, Commitment5000AUHours, Commitment10000AUHours, Commitment50000AUHours, Commitment100000AUHours, Commitment500000AUHours + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Analytics.Models.TierType, Microsoft.Azure.Management.DataLake.Analytics, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Analytics.Models.FirewallState, Microsoft.Azure.Management.DataLake.Analytics, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Analytics.Models.FirewallAllowAzureIpsState, Microsoft.Azure.Management.DataLake.Analytics, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsAccount + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeAnalyticsAccount](./Get-AzDataLakeAnalyticsAccount.md) + +[New-AzDataLakeAnalyticsAccount](./New-AzDataLakeAnalyticsAccount.md) + +[Remove-AzDataLakeAnalyticsAccount](./Remove-AzDataLakeAnalyticsAccount.md) + +[Test-AzDataLakeAnalyticsAccount](./Test-AzDataLakeAnalyticsAccount.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsCatalogCredential.md b/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsCatalogCredential.md new file mode 100644 index 0000000000..fb6b0caaf6 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsCatalogCredential.md @@ -0,0 +1,233 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: 75E4E0FB-35A8-47DA-B606-45E073D04625 +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/set-azdatalakeanalyticscatalogcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Set-AzDataLakeAnalyticsCatalogCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Set-AzDataLakeAnalyticsCatalogCredential.md +--- + +# Set-AzDataLakeAnalyticsCatalogCredential + +## SYNOPSIS +Modifies an Azure Data Lake Analytics catalog credential password. + +## SYNTAX + +### SetByHostNameAndPort (Default) +``` +Set-AzDataLakeAnalyticsCatalogCredential [-Account] <String> [-DatabaseName] <String> + [-CredentialName] <String> [-Credential] <PSCredential> [-NewPassword] <PSCredential> [-Uri] <Uri> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByFullURI +``` +Set-AzDataLakeAnalyticsCatalogCredential [-Account] <String> [-DatabaseName] <String> + [-CredentialName] <String> [-Credential] <PSCredential> [-NewPassword] <PSCredential> [-DatabaseHost] <String> + [-Port] <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzDataLakeAnalyticsCatalogCredential cmdlet modifies a credential password associated with an Azure Data Lake Analytics catalog. + +## EXAMPLES + +### Example 1: Modify a credential's password associated with an account +```powershell +Set-AzDataLakeAnalyticsCatalogCredential -AccountName "ContosoAdlAccount" ` + -DatabaseName "databaseName" ` + -CredentialName "credName" ` + -Credential (Get-Credential) ` + -NewPassword (Get-Credential) ` + -DatabaseHost "example.contoso.com" -Port 8080 +``` + +This command sets the credential password to the password specified in NewPassword. + +## PARAMETERS + +### -Account +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Credential +Specifies the name and current password of the credential to modify. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CredentialName +Specifies the name of the credential to modify + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseHost +Specifies the host name of the external data source the credential can connect to in the format mydatabase.contoso.com. + +```yaml +Type: System.String +Parameter Sets: SetByFullURI +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database in the Data Lake Analytics account holding the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewPassword +Specifies the new password for the credential + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Port +Specifies the port number used to connect to the specified DatabaseHost using this credential. + +```yaml +Type: System.Int32 +Parameter Sets: SetByFullURI +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Uri +Specifies the full Uniform Resource Identifier (URI) of the external data source this credential can connect to. + +```yaml +Type: System.Uri +Parameter Sets: SetByHostNameAndPort +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.PSCredential + +### System.Uri + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Management.DataLake.Analytics.Models.USqlCredential + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsCatalogItemAclEntry.md b/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsCatalogItemAclEntry.md new file mode 100644 index 0000000000..5217acd1c4 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsCatalogItemAclEntry.md @@ -0,0 +1,408 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/set-azdatalakeanalyticscatalogitemaclentry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Set-AzDataLakeAnalyticsCatalogItemAclEntry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Set-AzDataLakeAnalyticsCatalogItemAclEntry.md +--- + +# Set-AzDataLakeAnalyticsCatalogItemAclEntry + +## SYNOPSIS +Modifies an entry in the ACL of a catalog or catalog item in Data Lake Analytics. + +## SYNTAX + +### SetCatalogAclEntryForUser (Default) +``` +Set-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-User] -ObjectId <Guid> + -Permissions <PermissionType> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetCatalogItemAclEntryForUser +``` +Set-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-User] -ObjectId <Guid> -ItemType <String> + -Path <CatalogPathInstance> -Permissions <PermissionType> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetCatalogAclEntryForGroup +``` +Set-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-Group] -ObjectId <Guid> + -Permissions <PermissionType> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetCatalogItemAclEntryForGroup +``` +Set-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-Group] -ObjectId <Guid> -ItemType <String> + -Path <CatalogPathInstance> -Permissions <PermissionType> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetCatalogAclEntryForOther +``` +Set-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-Other] -Permissions <PermissionType> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetCatalogItemAclEntryForOther +``` +Set-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-Other] -ItemType <String> + -Path <CatalogPathInstance> -Permissions <PermissionType> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetCatalogAclEntryForUserOwner +``` +Set-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-UserOwner] -Permissions <PermissionType> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetCatalogItemAclEntryForUserOwner +``` +Set-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-UserOwner] -ItemType <String> + -Path <CatalogPathInstance> -Permissions <PermissionType> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetCatalogAclEntryForGroupOwner +``` +Set-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-GroupOwner] -Permissions <PermissionType> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetCatalogItemAclEntryForGroupOwner +``` +Set-AzDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-GroupOwner] -ItemType <String> + -Path <CatalogPathInstance> -Permissions <PermissionType> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeAnalyticsCatalogItemAclEntry** cmdlet adds or modifies an entry (ACE) in the access control list (ACL) of a catalog or catalog item in Data Lake Analytics. + +## EXAMPLES + +### Example 1: Modify user permissions for a catalog +```powershell +Set-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -User -ObjectId (Get-AzADUser -Mail "PattiFuller@contoso.com").Id -Permissions Read +``` + +```output +Type Id Permissions +---- -- ----------- +User 90a6f74b-fd73-490e-900a-c4f0f9694d02 Read +Group 902b155a-5601-4ca8-8178-ad3289211f88 ReadWrite +Other 00000000-0000-0000-0000-000000000000 None +User bd0b55bb-3a57-442a-b2f6-78c95c10ef86 Read +``` + +This command modifies the catalog ACE for Patti Fuller to have read permissions. + +### Example 2: Modify user Permissions for a database +```powershell +Set-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -User -ObjectId (Get-AzADUser -Mail "PattiFuller@contoso.com").Id -ItemType Database -Path "databaseName" -Permissions Read +``` + +```output +Type Id Permissions +---- -- ----------- +User 90a6f74b-fd73-490e-900a-c4f0f9694d02 Read +Group 902b155a-5601-4ca8-8178-ad3289211f88 ReadWrite +Other 00000000-0000-0000-0000-000000000000 None +User bd0b55bb-3a57-442a-b2f6-78c95c10ef86 Read +``` + +This command modifies the database ACE for Patti Fuller to have read permissions. + +### Example 3: Modify other permissions for a catalog +```powershell +Set-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -Other -Permissions Read +``` + +```output +Type Id Permissions +---- -- ----------- +User 90a6f74b-fd73-490e-900a-c4f0f9694d02 Read +Group 902b155a-5601-4ca8-8178-ad3289211f88 ReadWrite +Other 00000000-0000-0000-0000-000000000000 Read +User bd0b55bb-3a57-442a-b2f6-78c95c10ef86 Read +``` + +This command modifies the catalog ACE for other to have read permissions. + +### Example 4: Modify other Permissions for a database +```powershell +Set-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -Other -ItemType Database -Path "databaseName" -Permissions Read +``` + +```output +Type Id Permissions +---- -- ----------- +User 90a6f74b-fd73-490e-900a-c4f0f9694d02 Read +Group 902b155a-5601-4ca8-8178-ad3289211f88 ReadWrite +Other 00000000-0000-0000-0000-000000000000 Read +User bd0b55bb-3a57-442a-b2f6-78c95c10ef86 Read +``` + +### Example 5: Modify user owner permissions for a catalog +```powershell +Set-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -UserOwner -Permissions Read +``` + +```output +Type Id Permissions +---- -- ----------- +UserOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc Read +``` + +This command sets the owner permission for the account to Read. + +### Example 6: Modify user owner Permissions for a database +```powershell +Set-AzDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -UserOwner -ItemType Database -Path "databaseName" -Permissions Read +``` + +```output +Type Id Permissions +---- -- ----------- +GroupOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc Read +``` + +This command sets the owner permission for the database to Read. + +## PARAMETERS + +### -Account +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Set ACL entry of catalog for group. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetCatalogAclEntryForGroup, SetCatalogItemAclEntryForGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupOwner +Set ACL entry of catalog for group owner. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetCatalogAclEntryForGroupOwner, SetCatalogItemAclEntryForGroupOwner +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemType +Specifies the type of the catalog or catalog item(s). The acceptable values for this parameter are: +- Catalog +- Database + +```yaml +Type: System.String +Parameter Sets: SetCatalogItemAclEntryForUser, SetCatalogItemAclEntryForGroup, SetCatalogItemAclEntryForOther, SetCatalogItemAclEntryForUserOwner, SetCatalogItemAclEntryForGroupOwner +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ObjectId +The identity of the user to set. + +```yaml +Type: System.Guid +Parameter Sets: SetCatalogAclEntryForUser, SetCatalogItemAclEntryForUser, SetCatalogAclEntryForGroup, SetCatalogItemAclEntryForGroup +Aliases: Id, UserId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Other +Set ACL entry of catalog for other. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetCatalogAclEntryForOther, SetCatalogItemAclEntryForOther +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Analytics path of an catalog or catalog item. +The parts of the path should be separated by a period (.). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance +Parameter Sets: SetCatalogItemAclEntryForUser, SetCatalogItemAclEntryForGroup, SetCatalogItemAclEntryForOther, SetCatalogItemAclEntryForUserOwner, SetCatalogItemAclEntryForGroupOwner +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Permissions +Specifies the permissions for the ACE. +The acceptable values for this parameter are: +- None +- Read +- ReadWrite + +```yaml +Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+PermissionType +Parameter Sets: (All) +Aliases: +Accepted values: None, Read, ReadWrite + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -User +Set ACL entry of catalog for user. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetCatalogAclEntryForUser, SetCatalogItemAclEntryForUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserOwner +Set ACL entry of catalog for user owner. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetCatalogAclEntryForUserOwner, SetCatalogItemAclEntryForUserOwner +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+PermissionType + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsAcl + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeAnalyticsCatalogItemAclEntry](Get-AzDataLakeAnalyticsCatalogItemAclEntry.md) + +[Remove-AzDataLakeAnalyticsCatalogItemAclEntry](Remove-AzDataLakeAnalyticsCatalogItemAclEntry.md) + +[U-SQL now offers database level access control](https://github.com/Azure/AzureDataLake/blob/master/docs/Release_Notes/2016/2016_08_01/USQL_Release_Notes_2016_08_01.md#u-sql-now-offers-database-level-access-control) diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsDataSource.md b/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsDataSource.md new file mode 100644 index 0000000000..e454e16dad --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsDataSource.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: 2F28118E-6A34-4261-85BD-8CFDDC8A2707 +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/set-azdatalakeanalyticsdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Set-AzDataLakeAnalyticsDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Set-AzDataLakeAnalyticsDataSource.md +--- + +# Set-AzDataLakeAnalyticsDataSource + +## SYNOPSIS +Modifies the details of a data source of a Data Lake Analytics account. + +## SYNTAX + +``` +Set-AzDataLakeAnalyticsDataSource [-Account] <String> [-Blob] <String> [-AccessKey] <String> + [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeAnalyticsDataSource** cmdlet modifies the details of a data source of an Azure Data Lake Analytics account. + +## EXAMPLES + +### Example 1: Change the access key for a data source +```powershell +Set-AzDataLakeAnalyticsDataSource -Account "ContosoAdlAccount" -Blob "contosowasb" -AccessKey "...newaccesskey..." +``` + +This command changes the access key stored for an Azure Blob Storage data source. + +## PARAMETERS + +### -AccessKey +Specifies the new access key of the Azure Blob Storage data source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Account +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Blob +Specifies the name of the Azure Blob Storage data source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AzureBlob + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of the Data Lake Analytics account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Add-AzDataLakeAnalyticsDataSource](./Add-AzDataLakeAnalyticsDataSource.md) + +[Remove-AzDataLakeAnalyticsDataSource](./Remove-AzDataLakeAnalyticsDataSource.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsFirewallRule.md b/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsFirewallRule.md new file mode 100644 index 0000000000..853f7025ac --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Set-AzDataLakeAnalyticsFirewallRule.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/set-azdatalakeanalyticsfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Set-AzDataLakeAnalyticsFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Set-AzDataLakeAnalyticsFirewallRule.md +--- + +# Set-AzDataLakeAnalyticsFirewallRule + +## SYNOPSIS +Updates a firewall rule in a Data Lake Analytics account. + +## SYNTAX + +``` +Set-AzDataLakeAnalyticsFirewallRule [-Account] <String> [-Name] <String> [[-StartIpAddress] <String>] + [[-EndIpAddress] <String>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeAnalyticsFirewallRule** cmdlet updates a firewall rule in an Azure Data Lake Analytics account. + +## EXAMPLES + +### Example 1: Update a firewall rule +```powershell +Set-AzDataLakeAnalyticsFirewallRule -Account "ContosoAdlAcct" -Name "My firewall rule" -StartIpAddress 127.0.0.1 -EndIpAddress 127.0.0.10 +``` + +This command updates the firewall rule named "my firewall rule" in account "ContosoAdlAcct" to have the new IP range: 127.0.0.1 - 127.0.0.10 + +## PARAMETERS + +### -Account +The Data Lake Analytics account to update the firewall rule in + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIpAddress +The end of the valid ip range for the firewall rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which want to retrieve the account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartIpAddress +The start of the valid ip range for the firewall rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsFirewallRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Stop-AzDataLakeAnalyticsJob.md b/azps-10.1.0/Az.DataLakeAnalytics/Stop-AzDataLakeAnalyticsJob.md new file mode 100644 index 0000000000..424238896c --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Stop-AzDataLakeAnalyticsJob.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: 5EB9E134-C789-47A5-9AF8-CD4A475559C2 +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/stop-azdatalakeanalyticsjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Stop-AzDataLakeAnalyticsJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Stop-AzDataLakeAnalyticsJob.md +--- + +# Stop-AzDataLakeAnalyticsJob + +## SYNOPSIS +Cancels a job. + +## SYNTAX + +``` +Stop-AzDataLakeAnalyticsJob [-Account] <String> [-JobId] <Guid> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzDataLakeAnalyticsJob** cmdlet cancels an Azure Data Lake Analytics job. + +## EXAMPLES + +### Example 1: Cancel a job +```powershell +Stop-AzDataLakeAnalyticsJob -Account "ContosoAdlAccout" -JobId "a0a78d72-3fa8-4564-9b18-6becb3fda48a" +``` + +This command cancels the job with the specified ID. + +## PARAMETERS + +### -Account +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of the job to cancel. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Guid + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeAnalyticsJob](./Get-AzDataLakeAnalyticsJob.md) + +[Submit-AzDataLakeAnalyticsJob](./Submit-AzDataLakeAnalyticsJob.md) + +[Wait-AzDataLakeAnalyticsJob](./Wait-AzDataLakeAnalyticsJob.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Submit-AzDataLakeAnalyticsJob.md b/azps-10.1.0/Az.DataLakeAnalytics/Submit-AzDataLakeAnalyticsJob.md new file mode 100644 index 0000000000..80a829b6c9 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Submit-AzDataLakeAnalyticsJob.md @@ -0,0 +1,385 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: 0DB9595A-6C8B-4F3F-A707-2DB41D7C7470 +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/submit-azdatalakeanalyticsjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Submit-AzDataLakeAnalyticsJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Submit-AzDataLakeAnalyticsJob.md +--- + +# Submit-AzDataLakeAnalyticsJob + +## SYNOPSIS +Submits a job. + +## SYNTAX + +### SubmitUSqlJobWithScriptPath +``` +Submit-AzDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-ScriptPath] <String> [[-Runtime] <String>] + [[-CompileMode] <String>] [-CompileOnly] [[-AnalyticsUnits] <Int32>] [[-Priority] <Int32>] + [-ScriptParameter <IDictionary>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubmitUSqlJob +``` +Submit-AzDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-Script] <String> [[-Runtime] <String>] + [[-CompileMode] <String>] [-CompileOnly] [[-AnalyticsUnits] <Int32>] [[-Priority] <Int32>] + [-ScriptParameter <IDictionary>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubmitUSqlJobWithScriptPathAndRecurrence +``` +Submit-AzDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-ScriptPath] <String> [[-Runtime] <String>] + [[-CompileMode] <String>] [-CompileOnly] [[-AnalyticsUnits] <Int32>] [[-Priority] <Int32>] + [-ScriptParameter <IDictionary>] -RecurrenceId <Guid> [-RecurrenceName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubmitUSqlJobWithRecurrence +``` +Submit-AzDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-Script] <String> [[-Runtime] <String>] + [[-CompileMode] <String>] [-CompileOnly] [[-AnalyticsUnits] <Int32>] [[-Priority] <Int32>] + [-ScriptParameter <IDictionary>] -RecurrenceId <Guid> [-RecurrenceName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubmitUSqlJobWithScriptPathAndPipeline +``` +Submit-AzDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-ScriptPath] <String> [[-Runtime] <String>] + [[-CompileMode] <String>] [-CompileOnly] [[-AnalyticsUnits] <Int32>] [[-Priority] <Int32>] + [-ScriptParameter <IDictionary>] -RecurrenceId <Guid> [-RecurrenceName <String>] -PipelineId <Guid> + [-PipelineName <String>] [-PipelineUri <String>] [-RunId <Guid>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SubmitUSqlJobWithPipeline +``` +Submit-AzDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-Script] <String> [[-Runtime] <String>] + [[-CompileMode] <String>] [-CompileOnly] [[-AnalyticsUnits] <Int32>] [[-Priority] <Int32>] + [-ScriptParameter <IDictionary>] -RecurrenceId <Guid> [-RecurrenceName <String>] -PipelineId <Guid> + [-PipelineName <String>] [-PipelineUri <String>] [-RunId <Guid>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Submit-AzDataLakeAnalyticsJob** cmdlet submits an Azure Data Lake Analytics job. + +## EXAMPLES + +### Example 1: Submit a job +```powershell +Submit-AzDataLakeAnalyticsJob -Account "ContosoAdlAccount" -Name "New Job" -ScriptPath $LocalScriptPath -AnalyticsUnits 32 +``` + +This command submits a Data Lake Analytics job. + +### Example 2: Submit a job with script parameters +```powershell +$parameters = [ordered]@{} +$parameters["Department"] = "Sales" +$parameters["NumRecords"] = 1000 +$parameters["StartDateTime"] = (Get-Date).AddDays(-14) +Submit-AzDataLakeAnalyticsJob -Account "ContosoAdlAccount" -Name "New Job" -ScriptPath $LocalScriptPath -AnalyticsUnits 32 -ScriptParameter $parameters +``` + +U-SQL script parameters are prepended above the main script contents, e.g.: +DECLARE @Department string = "Sales"; +DECLARE @NumRecords int = 1000; +DECLARE @StartDateTime DateTime = new DateTime(2017, 12, 6, 0, 0, 0, 0); + +## PARAMETERS + +### -Account +Name of Data Lake Analytics account under which the job will be submitted. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AnalyticsUnits +The analytics units to use for this job. Typically, more analytics units dedicated to a script results in faster script execution time. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: DegreeOfParallelism + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CompileMode +The type of compilation to be done on this job. +Valid values: +- Semantic (Only performs semantic checks and necessary sanity checks) +- Full (Full compilation) +- SingleBox (Full compilation performed locally) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Semantic, Full, SingleBox + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CompileOnly +Indicates that the submission should only build the job and not execute if set to true. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The friendly name of the job to submit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PipelineId +An ID that indicates the submission of this job is a part of a set of recurring jobs and also associated with a job pipeline. + +```yaml +Type: System.Guid +Parameter Sets: SubmitUSqlJobWithScriptPathAndPipeline, SubmitUSqlJobWithPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PipelineName +An optional friendly name for the pipeline associated with this job. + +```yaml +Type: System.String +Parameter Sets: SubmitUSqlJobWithScriptPathAndPipeline, SubmitUSqlJobWithPipeline +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PipelineUri +An optional uri that links to the originating service associated with this pipeline. + +```yaml +Type: System.String +Parameter Sets: SubmitUSqlJobWithScriptPathAndPipeline, SubmitUSqlJobWithPipeline +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Priority +The priority of the job. If not specified, the priority is 1000. A lower number indicates a higher job priority. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecurrenceId +An ID that indicates the submission of this job is a part of a set of recurring jobs with the same recurrence ID. + +```yaml +Type: System.Guid +Parameter Sets: SubmitUSqlJobWithScriptPathAndRecurrence, SubmitUSqlJobWithRecurrence, SubmitUSqlJobWithScriptPathAndPipeline, SubmitUSqlJobWithPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecurrenceName +An optional friendly name for the recurrence correlation between jobs. + +```yaml +Type: System.String +Parameter Sets: SubmitUSqlJobWithScriptPathAndRecurrence, SubmitUSqlJobWithRecurrence, SubmitUSqlJobWithScriptPathAndPipeline, SubmitUSqlJobWithPipeline +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunId +An ID that identifies this specific run iteration of the pipeline. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: SubmitUSqlJobWithScriptPathAndPipeline, SubmitUSqlJobWithPipeline +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Runtime +Optionally set the version of the runtime to use for the job. If left unset, the default runtime is used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Script +Script to execute (written inline). + +```yaml +Type: System.String +Parameter Sets: SubmitUSqlJob, SubmitUSqlJobWithRecurrence, SubmitUSqlJobWithPipeline +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ScriptParameter +The script parameters for this job, as a dictionary of parameter names (string) to values (any combination of byte, sbyte, int, uint (or uint32), long, ulong (or uint64), float, double, decimal, short (or int16), ushort (or uint16), char, string, DateTime, bool, Guid, or byte[]). + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScriptPath +Path to the script file to submit. + +```yaml +Type: System.String +Parameter Sets: SubmitUSqlJobWithScriptPath, SubmitUSqlJobWithScriptPathAndRecurrence, SubmitUSqlJobWithScriptPathAndPipeline +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +### System.Int32 + +### System.Collections.IDictionary + +### System.Guid + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Management.DataLake.Analytics.Models.JobInformation + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeAnalyticsJob](./Get-AzDataLakeAnalyticsJob.md) + +[Stop-AzDataLakeAnalyticsJob](./Stop-AzDataLakeAnalyticsJob.md) + +[Wait-AzDataLakeAnalyticsJob](./Wait-AzDataLakeAnalyticsJob.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Test-AzDataLakeAnalyticsAccount.md b/azps-10.1.0/Az.DataLakeAnalytics/Test-AzDataLakeAnalyticsAccount.md new file mode 100644 index 0000000000..37cc0c05fc --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Test-AzDataLakeAnalyticsAccount.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: 0B52890D-102F-4C3C-9EF9-017F6ECA3E26 +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/test-azdatalakeanalyticsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Test-AzDataLakeAnalyticsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Test-AzDataLakeAnalyticsAccount.md +--- + +# Test-AzDataLakeAnalyticsAccount + +## SYNOPSIS +Checks for the existence of a Data Lake Analytics account. + +## SYNTAX + +``` +Test-AzDataLakeAnalyticsAccount [-Name] <String> [[-ResourceGroupName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzDataLakeAnalyticsAccount** cmdlet checks for the existence of a Data Lake Analytics account. + +## EXAMPLES + +### Example 1: Test whether an account exists +```powershell +Test-AzDataLakeAnalyticsAccount -Name "ContosoAdlAccount" +``` + +This command tests whether the account named ContosoAdlAccount exists. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name of the Data Lake Analytics account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeAnalyticsAccount](./Get-AzDataLakeAnalyticsAccount.md) + +[New-AzDataLakeAnalyticsAccount](./New-AzDataLakeAnalyticsAccount.md) + +[Set-AzDataLakeAnalyticsAccount](./Set-AzDataLakeAnalyticsAccount.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Test-AzDataLakeAnalyticsCatalogItem.md b/azps-10.1.0/Az.DataLakeAnalytics/Test-AzDataLakeAnalyticsCatalogItem.md new file mode 100644 index 0000000000..e637cc6bf5 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Test-AzDataLakeAnalyticsCatalogItem.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: ED17430D-4DAF-4B9E-937D-0F8A843DAB96 +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/test-azdatalakeanalyticscatalogitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Test-AzDataLakeAnalyticsCatalogItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Test-AzDataLakeAnalyticsCatalogItem.md +--- + +# Test-AzDataLakeAnalyticsCatalogItem + +## SYNOPSIS +Checks for the existence of a catalog item. + +## SYNTAX + +``` +Test-AzDataLakeAnalyticsCatalogItem [-Account] <String> [-ItemType] <CatalogItemType> + [-Path] <CatalogPathInstance> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzDataLakeAnalyticsCatalogItem** cmdlet checks for the existence of an Azure Data Lake Analytics catalog item. + +## EXAMPLES + +### Example 1: Test whether a catalog item exists +```powershell +Test-AzDataLakeAnalyticsCatalogItem -Account "ContosoAdlAccount" -ItemType Schema -Path "databaseName.schemaName" +``` + +This command tests whether a specified Schema item exists. + +## PARAMETERS + +### -Account +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemType +Specifies the catalog item type of the item to check. +The acceptable values for this parameter are: +- Database +- Schema +- Assembly +- Table +- TablePartition +- TableValuedFunction +- TableStatistics +- ExternalDataSource +- View +- Procedure +- Secret +- Credential +- Types + +```yaml +Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+CatalogItemType +Parameter Sets: (All) +Aliases: +Accepted values: Database, Schema, Assembly, Table, TablePartition, TableValuedFunction, TableStatistics, ExternalDataSource, View, Procedure, Secret, Credential, Types, Package + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the path to the item to fetch, or the path to the parent item of the items to list. + +```yaml +Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+CatalogItemType + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeAnalyticsCatalogItem](./Get-AzDataLakeAnalyticsCatalogItem.md) + + diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Update-AzDataLakeAnalyticsComputePolicy.md b/azps-10.1.0/Az.DataLakeAnalytics/Update-AzDataLakeAnalyticsComputePolicy.md new file mode 100644 index 0000000000..f70cb9ad5b --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Update-AzDataLakeAnalyticsComputePolicy.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/update-azdatalakeanalyticscomputepolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Update-AzDataLakeAnalyticsComputePolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Update-AzDataLakeAnalyticsComputePolicy.md +--- + +# Update-AzDataLakeAnalyticsComputePolicy + +## SYNOPSIS +Updates a Data Lake Analytics compute policy rule for a specific AAD entity. + +## SYNTAX + +``` +Update-AzDataLakeAnalyticsComputePolicy [-ResourceGroupName <String>] [-Account] <String> [-Name] <String> + [-MaxAnalyticsUnitsPerJob <Int32>] [-MinPriorityPerJob <Int32>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzDataLakeAnalyticsComputePolicy** updates the specified compute policy rule for a specific AAD entity in an Azure Data Lake Analytics account. + +## EXAMPLES + +### Example 1: update one rule in a compute policy +```powershell +Update-AzDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name "myPolicy" -MaxAnalyticsUnitsPerJob 5 +``` + +This command updates a policy called "myPolicy" in account "contosoadla" to ensure the user cannot submit any job with more than 5 analytics units. + +### Example 2: Create a compute policy with both rules update +```powershell +Update-AzDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name "myPolicy" -MaxAnalyticsUnitsPerJob 5 -MinPriorityPerJob 100 +``` + +This command creates a policy called "myPolicy" in account "contosoadla" to ensure the user cannot submit any job with more than 5 analytics units or with a priority lower than 100 + +## PARAMETERS + +### -Account +Name of the account to update the compute policy in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxAnalyticsUnitsPerJob +The maximum supported analytics units per job for this policy. Either this, MinPriorityPerJob, or both parameters must be specified. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: MaxDegreeOfParallelismPerJob + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MinPriorityPerJob +The minimum supported priority per job for this policy. Either this, MaxAnalyticsUnitsPerJob, or both parameters must be specified. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the compute policy to update. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ComputePolicyName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which you the account exists. +Optional and will attempt to discover if not provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsComputePolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeAnalytics/Wait-AzDataLakeAnalyticsJob.md b/azps-10.1.0/Az.DataLakeAnalytics/Wait-AzDataLakeAnalyticsJob.md new file mode 100644 index 0000000000..d89be60aea --- /dev/null +++ b/azps-10.1.0/Az.DataLakeAnalytics/Wait-AzDataLakeAnalyticsJob.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeAnalytics.dll-Help.xml +Module Name: Az.DataLakeAnalytics +ms.assetid: CE7B54BC-C493-49CE-93BD-346ED0B966A1 +online version: https://learn.microsoft.com/powershell/module/az.datalakeanalytics/wait-azdatalakeanalyticsjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Wait-AzDataLakeAnalyticsJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeAnalytics/DataLakeAnalytics/help/Wait-AzDataLakeAnalyticsJob.md +--- + +# Wait-AzDataLakeAnalyticsJob + +## SYNOPSIS +Waits for a job to complete. + +## SYNTAX + +``` +Wait-AzDataLakeAnalyticsJob [-Account] <String> [-JobId] <Guid> [[-WaitIntervalInSeconds] <Int32>] + [[-TimeoutInSeconds] <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Wait-AzDataLakeAnalyticsJob** cmdlet waits for an Azure Data Lake Analytics job to complete. + +## EXAMPLES + +### Example 1: Wait for a job to complete +```powershell +Wait-AzDataLakeAnalyticsJob -Account "ContosoAdlAccount" -JobId "a0a78d72-3fa8-4564-9b18-6becb3fda48a" +``` + +The following command waits for the job with the specified ID to complete. + +## PARAMETERS + +### -Account +Specifies the Data Lake Analytics account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of the job for which to wait. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -TimeoutInSeconds +Specifies the number of seconds to wait before exiting the wait operation. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WaitIntervalInSeconds +Specify the number of seconds that elapse between each check of the job state. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Management.DataLake.Analytics.Models.JobInformation + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeAnalyticsJob](./Get-AzDataLakeAnalyticsJob.md) + +[Stop-AzDataLakeAnalyticsJob](./Stop-AzDataLakeAnalyticsJob.md) + +[Submit-AzDataLakeAnalyticsJob](./Submit-AzDataLakeAnalyticsJob.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Add-AzDataLakeStoreFirewallRule.md b/azps-10.1.0/Az.DataLakeStore/Add-AzDataLakeStoreFirewallRule.md new file mode 100644 index 0000000000..5ad5b34571 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Add-AzDataLakeStoreFirewallRule.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: C6FD4734-720C-4C8C-9B58-EDB331DD6415 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/add-azdatalakestorefirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Add-AzDataLakeStoreFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Add-AzDataLakeStoreFirewallRule.md +--- + +# Add-AzDataLakeStoreFirewallRule + +## SYNOPSIS +Adds a firewall rule to the specified Data Lake Store account. + +## SYNTAX + +``` +Add-AzDataLakeStoreFirewallRule [-Account] <String> [-Name] <String> [-StartIpAddress] <String> + [-EndIpAddress] <String> [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzDataLakeStoreFirewallRule** cmdlet adds a firewall rule to the specified Data Lake Store account. + +## EXAMPLES + +### Example 1: Add a new firewall rule to a Data Lake Store account +```powershell +Add-AzDataLakeStoreFirewallRule -AccountName "ContosoADL" -Name MyRule -StartIpAddress "127.0.0.1" -EndIpAddress "127.0.0.2" +``` + +This creates a new firewall rule called "MyRule" in account "ContosoADL" with an IP range of 127.0.0.1 - 127.0.0.2 + +## PARAMETERS + +### -Account +The Data Lake Store account to add the firewall rule to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIpAddress +The end of the valid ip range for the firewall rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the firewall rule to add. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which the account to add the firewall rule is. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartIpAddress +The start of the valid ip range for the firewall rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreFirewallRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Add-AzDataLakeStoreItemContent.md b/azps-10.1.0/Az.DataLakeStore/Add-AzDataLakeStoreItemContent.md new file mode 100644 index 0000000000..afd9bdcc45 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Add-AzDataLakeStoreItemContent.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: B008028D-27FC-4469-BE71-54F7218C068B +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/add-azdatalakestoreitemcontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Add-AzDataLakeStoreItemContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Add-AzDataLakeStoreItemContent.md +--- + +# Add-AzDataLakeStoreItemContent + +## SYNOPSIS +Adds content to an item in a Data Lake Store. + +## SYNTAX + +``` +Add-AzDataLakeStoreItemContent [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Value] <Object> + [[-Encoding] <Encoding>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzDataLakeStoreItemContent** cmdlet adds content to an item in an Azure Data Lake Store. + +## EXAMPLES + +### Example 1: Add content to a file +```powershell +Add-AzDataLakeStoreItemContent -AccountName "ContosoADLS" -Path /abc/myFile.txt -Value "My content here" +``` + +This command adds content to the file myFile.txt. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Encoding +Specifies the encoding for the item to create. +The acceptable values for this parameter are: +- Unknown +- String +- Unicode +- Byte +- BigEndianUnicode +- UTF8 +- UTF7 +- Ascii +- Default +- Oem +- BigEndianUTF32 + +```yaml +Type: System.Text.Encoding +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the item to modify, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Specifies the content to add to the item. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### System.Object + +### System.Text.Encoding + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeStoreItemContent](./Get-AzDataLakeStoreItemContent.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Add-AzDataLakeStoreTrustedIdProvider.md b/azps-10.1.0/Az.DataLakeStore/Add-AzDataLakeStoreTrustedIdProvider.md new file mode 100644 index 0000000000..be915eccc4 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Add-AzDataLakeStoreTrustedIdProvider.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 5C788778-58A4-4798-AB66-1D3562BB9338 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/add-azdatalakestoretrustedidprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Add-AzDataLakeStoreTrustedIdProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Add-AzDataLakeStoreTrustedIdProvider.md +--- + +# Add-AzDataLakeStoreTrustedIdProvider + +## SYNOPSIS +Adds a trusted identity provider to the specified Data Lake Store account. + +## SYNTAX + +``` +Add-AzDataLakeStoreTrustedIdProvider [-Account] <String> [-Name] <String> [-ProviderEndpoint] <String> + [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzDataLakeStoreTrustedIdProvider** cmdlet adds a trusted identity provider to the specified Data Lake Store account. + +## EXAMPLES + +### Example 1: Add a trusted identity provider +```powershell +Add-AzDataLakeStoreTrustedIdProvider -AccountName "ContosoADL" -Name MyProvider -ProviderEndpoint "https://sts.windows.net/6b04908c-b91f-40ce-8024-7ee8a4fd6150" +``` + +Adds the provider "MyProvider" to account "ContosoADL" with the provider endpoint "https://sts.windows.net/6b04908c-b91f-40ce-8024-7ee8a4fd6150" + +## PARAMETERS + +### -Account +The name of the Data Lake Store account to add the specified trusted identity provider to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the trusted identity provider to add + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProviderEndpoint +The valid trusted provider endpoint in the format: https://sts.windows.net/\<provider identity\>" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which the account to add the trusted identity provider is. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreTrustedIdProvider + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Add-AzDataLakeStoreVirtualNetworkRule.md b/azps-10.1.0/Az.DataLakeStore/Add-AzDataLakeStoreVirtualNetworkRule.md new file mode 100644 index 0000000000..3d3cadbdd1 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Add-AzDataLakeStoreVirtualNetworkRule.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/add-azdatalakestorevirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Add-AzDataLakeStoreVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Add-AzDataLakeStoreVirtualNetworkRule.md +--- + +# Add-AzDataLakeStoreVirtualNetworkRule + +## SYNOPSIS +Adds a virtual network rule to the specified Data Lake Store account. + +## SYNTAX + +``` +Add-AzDataLakeStoreVirtualNetworkRule [-Account] <String> [-Name] <String> [-SubnetId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzDataLakeStoreVirtualNetworkRule** cmdlet adds a virtual network rule to the specified Data Lake Store account. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzDataLakeStoreVirtualNetworkRule -Account "dls" -Name "myVNET" -SubnetId "testId" +``` + +```output +ResourceGroupName : +AccountName : +VirtualNetworkRuleName : myVNET +VirtualNetworkSubnetId : /subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Network/virtualNetworks/myVNET/subnets/testId +IgnoreMissingVnetServiceEndpoint : +State : +``` + +This creates a new virtual network rule called "myVNET" in account "dls" with a subnet id "testId" + +## PARAMETERS + +### -Account +The Data Lake Store account to add the virtual network rule to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubnetId +The subnetId of the virtual network rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreVirtualNetworkRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Az.DataLakeStore.md b/azps-10.1.0/Az.DataLakeStore/Az.DataLakeStore.md new file mode 100644 index 0000000000..3dfa14ccb5 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Az.DataLakeStore.md @@ -0,0 +1,141 @@ +--- +Module Name: Az.DataLakeStore +Module Guid: 90dfd814-abce-4e1f-99b6-fe16760c079a +Download Help Link: https://learn.microsoft.com/powershell/module/az.datalakestore +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Az.DataLakeStore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Az.DataLakeStore.md +--- + +# Az.DataLakeStore Module +## Description +The topics in this section document the Azure PowerShell cmdlets for Azure Data Lake Store in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.DataLakeStore namespace. These cmdlets work only with Azure Data Lake Storage Gen1 accounts. + +## Az.DataLakeStore Cmdlets +### [Add-AzDataLakeStoreFirewallRule](Add-AzDataLakeStoreFirewallRule.md) +Adds a firewall rule to the specified Data Lake Store account. + +### [Add-AzDataLakeStoreItemContent](Add-AzDataLakeStoreItemContent.md) +Adds content to an item in a Data Lake Store. + +### [Add-AzDataLakeStoreTrustedIdProvider](Add-AzDataLakeStoreTrustedIdProvider.md) +Adds a trusted identity provider to the specified Data Lake Store account. + +### [Add-AzDataLakeStoreVirtualNetworkRule](Add-AzDataLakeStoreVirtualNetworkRule.md) +Adds a virtual network rule to the specified Data Lake Store account. + +### [Enable-AzDataLakeStoreKeyVault](Enable-AzDataLakeStoreKeyVault.md) +Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account. + +### [Export-AzDataLakeStoreChildItemProperty](Export-AzDataLakeStoreChildItemProperty.md) +Exports the properties (Disk usage and Acl) for the entire tree from the specified path to a output path + +### [Export-AzDataLakeStoreItem](Export-AzDataLakeStoreItem.md) +Downloads a file from Data Lake Store. + +### [Get-AzDataLakeStoreAccount](Get-AzDataLakeStoreAccount.md) +Gets details of a Data Lake Store account. + +### [Get-AzDataLakeStoreChildItem](Get-AzDataLakeStoreChildItem.md) +Gets the list of items in a folder in Data Lake Store. + +### [Get-AzDataLakeStoreChildItemSummary](Get-AzDataLakeStoreChildItemSummary.md) +Gets the summary of total size, files and directories contained in the path specified + +### [Get-AzDataLakeStoreFirewallRule](Get-AzDataLakeStoreFirewallRule.md) +Gets the specified firewall rules in the specified Data Lake Store. +If no firewall rule is specified, then lists all firewall rules for the account. + +### [Get-AzDataLakeStoreItem](Get-AzDataLakeStoreItem.md) +Gets the details of a file or folder in Data Lake Store. + +### [Get-AzDataLakeStoreItemAclEntry](Get-AzDataLakeStoreItemAclEntry.md) +Gets an entry in the ACL of a file or folder in Data Lake Store. + +### [Get-AzDataLakeStoreItemContent](Get-AzDataLakeStoreItemContent.md) +Gets the contents of a file in Data Lake Store. + +### [Get-AzDataLakeStoreItemOwner](Get-AzDataLakeStoreItemOwner.md) +Gets the owner of a file or folder in Data Lake Store. + +### [Get-AzDataLakeStoreItemPermission](Get-AzDataLakeStoreItemPermission.md) +Gets the permission octal of a file or folder in Data Lake Store. + +### [Get-AzDataLakeStoreTrustedIdProvider](Get-AzDataLakeStoreTrustedIdProvider.md) +Gets the specified trusted identity provider in the specified Data Lake Store. +If no provider is specified, then lists all providers for the account. + +### [Get-AzDataLakeStoreVirtualNetworkRule](Get-AzDataLakeStoreVirtualNetworkRule.md) +Gets the specified virtual network rules in the specified Data Lake Store. +If no virtual network rule is specified, then lists all virtual network rules for the account. + +### [Import-AzDataLakeStoreItem](Import-AzDataLakeStoreItem.md) +Uploads a local file or directory to a Data Lake Store. + +### [Join-AzDataLakeStoreItem](Join-AzDataLakeStoreItem.md) +Joins one or more files to create one file in Data Lake Store. + +### [Move-AzDataLakeStoreItem](Move-AzDataLakeStoreItem.md) +Moves or renames a file or folder in Data Lake Store. + +### [New-AzDataLakeStoreAccount](New-AzDataLakeStoreAccount.md) +Creates a new Data Lake Store account. + +### [New-AzDataLakeStoreItem](New-AzDataLakeStoreItem.md) +Creates a new file or folder in Data Lake Store. + +### [Remove-AzDataLakeStoreAccount](Remove-AzDataLakeStoreAccount.md) +Deletes a Data Lake Store account permanently. + +### [Remove-AzDataLakeStoreFirewallRule](Remove-AzDataLakeStoreFirewallRule.md) +Removes the specified firewall rule in the specified Data Lake Store. + +### [Remove-AzDataLakeStoreItem](Remove-AzDataLakeStoreItem.md) +Deletes a file or folder in Data Lake Store. + +### [Remove-AzDataLakeStoreItemAcl](Remove-AzDataLakeStoreItemAcl.md) +Clears the ACL of a file or folder in Data Lake Store. + +### [Remove-AzDataLakeStoreItemAclEntry](Remove-AzDataLakeStoreItemAclEntry.md) +Removes an entry from the ACL of a file or folder in Data Lake Store. + +### [Remove-AzDataLakeStoreTrustedIdProvider](Remove-AzDataLakeStoreTrustedIdProvider.md) +Removes the specified trusted identity provider in the specified Data Lake Store. + +### [Remove-AzDataLakeStoreVirtualNetworkRule](Remove-AzDataLakeStoreVirtualNetworkRule.md) +Removes the specified virtual network rule in the specified Data Lake Store. + +### [Set-AzDataLakeStoreAccount](Set-AzDataLakeStoreAccount.md) +Modifies a Data Lake Store account. + +### [Set-AzDataLakeStoreFirewallRule](Set-AzDataLakeStoreFirewallRule.md) +Modifies the specified firewall rule in the specified Data Lake Store. + +### [Set-AzDataLakeStoreItemAcl](Set-AzDataLakeStoreItemAcl.md) +Modifies the ACL of a file or folder in Data Lake Store. + +### [Set-AzDataLakeStoreItemAclEntry](Set-AzDataLakeStoreItemAclEntry.md) +Modifies an entry in the ACL of a file or folder in Data Lake Store. + +### [Set-AzDataLakeStoreItemExpiry](Set-AzDataLakeStoreItemExpiry.md) +Sets or removes the expire time for a file in an Azure Data Lake Store account. + +### [Set-AzDataLakeStoreItemOwner](Set-AzDataLakeStoreItemOwner.md) +Modifies the owner of a file or folder in Data Lake Store. + +### [Set-AzDataLakeStoreItemPermission](Set-AzDataLakeStoreItemPermission.md) +Modifies the permission octal of a file or folder in Data Lake Store. + +### [Set-AzDataLakeStoreTrustedIdProvider](Set-AzDataLakeStoreTrustedIdProvider.md) +Modifies the specified trusted identity provider in the specified Data Lake Store. + +### [Set-AzDataLakeStoreVirtualNetworkRule](Set-AzDataLakeStoreVirtualNetworkRule.md) +Modifies the specified virtual network rule in the specified Data Lake Store. + +### [Test-AzDataLakeStoreAccount](Test-AzDataLakeStoreAccount.md) +Tests the existence of a Data Lake Store account. + +### [Test-AzDataLakeStoreItem](Test-AzDataLakeStoreItem.md) +Tests the existence of a file or folder in Data Lake Store. + diff --git a/azps-10.1.0/Az.DataLakeStore/Enable-AzDataLakeStoreKeyVault.md b/azps-10.1.0/Az.DataLakeStore/Enable-AzDataLakeStoreKeyVault.md new file mode 100644 index 0000000000..6d0630287f --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Enable-AzDataLakeStoreKeyVault.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/enable-azdatalakestorekeyvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Enable-AzDataLakeStoreKeyVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Enable-AzDataLakeStoreKeyVault.md +--- + +# Enable-AzDataLakeStoreKeyVault + +## SYNOPSIS +Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account. + +## SYNTAX + +``` +Enable-AzDataLakeStoreKeyVault [-Account] <String> [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzDataLakeStoreKeyVault** cmdlet attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account. + +## EXAMPLES + +### Example 1: Enable the Key Vault for the ContosoADLS account +```powershell +Enable-AzDataLakeStoreKeyVault -Name "ContosoADLS" +``` + +This command attempts to enable the user managed Key Vault for the Data Lake Store account named ContosoADLS. + +## PARAMETERS + +### -Account +The Data Lake Store account to enable the user managed Key Vault for + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group associated with the account. If not specified will attempt to be discovered. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[New-AzDataLakeStoreAccount](./New-AzDataLakeStoreAccount.md) + +[Set-AzDataLakeStoreAccount](./Set-AzDataLakeStoreAccount.md) + diff --git a/azps-10.1.0/Az.DataLakeStore/Export-AzDataLakeStoreChildItemProperty.md b/azps-10.1.0/Az.DataLakeStore/Export-AzDataLakeStoreChildItemProperty.md new file mode 100644 index 0000000000..14ae2d913a --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Export-AzDataLakeStoreChildItemProperty.md @@ -0,0 +1,299 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/export-azdatalakestorechilditemproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Export-AzDataLakeStoreChildItemProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Export-AzDataLakeStoreChildItemProperty.md +--- + +# Export-AzDataLakeStoreChildItemProperty + +## SYNOPSIS +Exports the properties (Disk usage and Acl) for the entire tree from the specified path to a output path + +## SYNTAX + +### GetDiskUsage +``` +Export-AzDataLakeStoreChildItemProperty [-Account] <String> [-Path] <DataLakeStorePathInstance> + [-OutputPath] <String> [-SaveToAdl] [-IncludeFile] [-MaximumDepth <Int32>] [-Concurrency <Int32>] + [-GetDiskUsage] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### GetAllProperties +``` +Export-AzDataLakeStoreChildItemProperty [-Account] <String> [-Path] <DataLakeStorePathInstance> + [-OutputPath] <String> [-SaveToAdl] [-IncludeFile] [-MaximumDepth <Int32>] [-Concurrency <Int32>] + [-GetDiskUsage] [-GetAcl] [-HideConsistentAcl] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GetAclDump +``` +Export-AzDataLakeStoreChildItemProperty [-Account] <String> [-Path] <DataLakeStorePathInstance> + [-OutputPath] <String> [-SaveToAdl] [-IncludeFile] [-MaximumDepth <Int32>] [-Concurrency <Int32>] [-GetAcl] + [-HideConsistentAcl] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Export-AzDataLakeStoreChildItemProperty** is used to report the ADLS space usage or/and ACL usage for the given directory and it's sub directories and files. + +## EXAMPLES + +### Example 1: Get the disk usage and ACL usage for all subdirectories and files +```powershell +Export-AzDataLakeStoreChildItemProperty -Account ContosoADL -Path /a -OutputPath "C:\Users\contoso\Desktop\DumpFile.txt" -GetAcl -GetDiskUsage -IncludeFile +``` + +Get the disk usage and ACL usage for all subdirectories and files under /a. IncludeFile ensures the usage is reported for files also + +### Example 2: Get the ACL usage for all subdirectories and files with the consistent ACL hidden +```powershell +$fullAcl="user:contoso-userid:--x|user::rwx|other::---|group::rwx" +$newFullAcl = $fullAcl.Split("{|}"); +Set-AzDataLakeStoreItemAcl -Account ContosoADL -Path /a -Acl $newFullAcl -Recurse -Debug + +Export-AzDataLakeStoreChildItemProperty -Account ContosoADL -Path /a -OutputPath "C:\Users\contoso\Desktop\DumpFile.txt" -GetAcl -HideConsistentAcl -IncludeFile +``` + +Get the ACL usage for all subdirectories and files under /a. IncludeFile ensures the usage is reported for files also. HideconsistentAcl in this case will show the Acl of /a, not it's children since all of the children has same acl as /a. This flag skips the acl output of subtree if all it's acls are same as the root. + +## PARAMETERS + +### -Account +The Data Lake Store account to execute the filesystem operation in + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Concurrency +Indicates the number of files/directories processed in parallel. +Default will be computed as a best effort based on system specification. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GetAcl +Retrieves the acl starting from the root path + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetAllProperties, GetAclDump +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GetDiskUsage +Retrieves the disk usage starting from the root path + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetDiskUsage, GetAllProperties +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HideConsistentAcl +Do not show directory subtree if the ACLs are the same throughout the entire subtree. This makes it easier to see only the paths up to which the ACLs differ.For example if all files and folders under /a/b are the same, do not show the subtreeunder /a/b, and just output /a/b with 'True' in the Consistent ACL columnCannot be set if IncludeFiles is not set, because consistent Acl cannot be determined without retrieving acls for the files. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetAllProperties, GetAclDump +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludeFile +Show stats at file level (default is to show directory-level info only) + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaximumDepth +Maximum depth from the root directory till which disk usage or acl is displayed + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OutputPath +Path to output file. Can be a Local path or Adl Path. By default it is local. If SaveToAdl is specified then it is an ADL path in the same account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates a boolean response should be returned indicating the result of the delete operation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +The path in the specified Data Lake account that should be retrieve. +Can be a file or folder In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system. + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SaveToAdl +If passed then saves the dump file to ADL. +The DumpFile wil be a ADL path in that case + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### System.Management.Automation.SwitchParameter + +### System.Int32 + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Export-AzDataLakeStoreItem.md b/azps-10.1.0/Az.DataLakeStore/Export-AzDataLakeStoreItem.md new file mode 100644 index 0000000000..1686bb60bf --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Export-AzDataLakeStoreItem.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: B10B1F5D-5566-4129-9D42-05A6D3B72C9E +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/export-azdatalakestoreitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Export-AzDataLakeStoreItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Export-AzDataLakeStoreItem.md +--- + +# Export-AzDataLakeStoreItem + +## SYNOPSIS +Downloads a file from Data Lake Store. + +## SYNTAX + +### NoDiagnosticLogging (Default) +``` +Export-AzDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Destination] <String> + [-Recurse] [-Resume] [-Force] [-Concurrency <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### IncludeDiagnosticLogging +``` +Export-AzDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Destination] <String> + [-Recurse] [-Resume] [-Force] [-Concurrency <Int32>] [-DiagnosticLogLevel <LogLevel>] + -DiagnosticLogPath <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Export-AzDataLakeStoreItem** cmdlet downloads a file from Data Lake Store. + +## EXAMPLES + +### Example 1: Download an item from the Data Lake Store +```powershell +Export-AzDataLakeStoreItem -AccountName "ContosoADL" -Path /myFiles/TestSource.csv -Destination "C:\Test.csv" -Concurrency 4 +``` + +This command downloads the file TestSource.csv from the Data Lake Store to C:\Test.csv with a concurrency of 4. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Concurrency +Indicates the number of files or chunks to download in parallel. Default will be computed as a best effort based on system specifications. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +Specifies the local file path to which to download the file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiagnosticLogLevel +Optionally indicates the diagnostic log level to use to record events during the file or folder import. Default is Error. + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.LogLevel +Parameter Sets: IncludeDiagnosticLogging +Aliases: +Accepted values: Debug, Information, Error, None + +Required: False +Position: Named +Default value: Error +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiagnosticLogPath +Specifies the path for the diagnostic log to record events to during the file or folder import. + +```yaml +Type: System.String +Parameter Sets: IncludeDiagnosticLogging +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Indicates that this operation can overwrite the destination file if it already exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the path of the item to download from the Data Lake Store, starting from the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Recurse +Indicates that a folder download is recursive. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Resume +Indicates that the file(s) being copied are a continuation of a previous download. +This will cause the system to attempt to resume from the last file that was not fully downloaded. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### System.Management.Automation.SwitchParameter + +### System.Int32 + +### Microsoft.Azure.Commands.DataLakeStore.Models.LogLevel + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeStoreItem](./Get-AzDataLakeStoreItem.md) + +[Import-AzDataLakeStoreItem](./Import-AzDataLakeStoreItem.md) + +[Join-AzDataLakeStoreItem](./Join-AzDataLakeStoreItem.md) + +[Move-AzDataLakeStoreItem](./Move-AzDataLakeStoreItem.md) + +[New-AzDataLakeStoreItem](./New-AzDataLakeStoreItem.md) + +[Remove-AzDataLakeStoreItem](./Remove-AzDataLakeStoreItem.md) + +[Test-AzDataLakeStoreItem](./Test-AzDataLakeStoreItem.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreAccount.md b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreAccount.md new file mode 100644 index 0000000000..6ee51fd658 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreAccount.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 234D579E-B62D-4D70-8D2E-22AC0D9AC513 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/get-azdatalakestoreaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreAccount.md +--- + +# Get-AzDataLakeStoreAccount + +## SYNOPSIS +Gets details of a Data Lake Store account. + +## SYNTAX + +### GetAllInSubscription (Default) +``` +Get-AzDataLakeStoreAccount [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceGroup +``` +Get-AzDataLakeStoreAccount [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetBySpecificAccount +``` +Get-AzDataLakeStoreAccount [[-ResourceGroupName] <String>] [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeStoreAccount** cmdlet gets details of a Data Lake Store account. + +## EXAMPLES + +### Example 1: Get a Data Lake Store account +```powershell +Get-AzDataLakeStoreAccount -Name "ContosoADL" +``` + +This command gets the account named ContosoADL. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the account to get. + +```yaml +Type: System.String +Parameter Sets: GetBySpecificAccount +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Data Lake Store account to get. + +```yaml +Type: System.String +Parameter Sets: GetByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetBySpecificAccount +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.PSDataLakeStoreAccount + +## NOTES + +## RELATED LINKS + +[New-AzDataLakeStoreAccount](./New-AzDataLakeStoreAccount.md) + +[Remove-AzDataLakeStoreAccount](./Remove-AzDataLakeStoreAccount.md) + +[Set-AzDataLakeStoreAccount](./Set-AzDataLakeStoreAccount.md) + +[Test-AzDataLakeStoreAccount](./Test-AzDataLakeStoreAccount.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreChildItem.md b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreChildItem.md new file mode 100644 index 0000000000..cad38f25e1 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreChildItem.md @@ -0,0 +1,97 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: CC0E73BD-2063-4CA2-BBBA-1FB6AE04DADE +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/get-azdatalakestorechilditem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreChildItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreChildItem.md +--- + +# Get-AzDataLakeStoreChildItem + +## SYNOPSIS +Gets the list of items in a folder in Data Lake Store. + +## SYNTAX + +``` +Get-AzDataLakeStoreChildItem [-Account] <String> [-Path] <DataLakeStorePathInstance> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeStoreChildItem** cmdlet gets the list of items in a folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Get the child items for a folder +```powershell +Get-AzDataLakeStoreChildItem -AccountName "ContosoADL" -Path "/MyFiles/" +``` + +This command gets the child items for the MyFiles folder. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the folder, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItem + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreChildItemSummary.md b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreChildItemSummary.md new file mode 100644 index 0000000000..042a5a6734 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreChildItemSummary.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/get-azdatalakestorechilditemsummary +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreChildItemSummary.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreChildItemSummary.md +--- + +# Get-AzDataLakeStoreChildItemSummary + +## SYNOPSIS +Gets the summary of total size, files and directories contained in the path specified + +## SYNTAX + +``` +Get-AzDataLakeStoreChildItemSummary [-Account] <String> [-Path] <DataLakeStorePathInstance> + [-Concurrency <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeStoreChildItemSummary** retrieves the content summary for a given path. It recursively computes total number of files, directories and total size of all the files under the given path. + +## EXAMPLES + +### Example 1: Get the content summary of a folder +```powershell +Get-AzDataLakeStoreChildItemSummary -Account ContosoADL -Path /a -Concurrency 128 +``` + +It lists number of total directories, files and their size contained under /a. + +## PARAMETERS + +### -Account +The Data Lake Store account to execute the filesystem operation in + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Concurrency +Indicates the number of files/directories processed in parallel. +Default will be computed as a best effort based on system specification. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path in the specified Data Lake account that should be retrieve. +Can be a file or folder In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system. + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreChildItemSummary + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreDeletedItem.md b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreDeletedItem.md new file mode 100644 index 0000000000..c2a4abaefc --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreDeletedItem.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: BF0A5D64-AC93-48F5-AED2-C21CC8829053 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/get-azdatalakestoredeleteditem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreDeletedItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreDeletedItem.md +--- + +# Get-AzDataLakeStoreDeletedItem + +## SYNOPSIS +Searches for deleted entries in trash which match the filter. + +## SYNTAX + +``` +Get-AzDataLakeStoreDeletedItem [-Account] <String> [-Filter] <String> [-Count <Int32>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeStoreDeletedItem** cmdlet searches the deleted files or folders in Data Lake Store which match the given filter. +It displays the following attributes of the deleted items - OriginalPath, TrashDirPath, Type, CreationTime. +This could be a long running operation as it may have to search through millions of files in trash and could be run as a job. + Caution: Undeleting files is a best effort operation. There are no guarantees that a file can be restored once it is deleted. The use of this API is enabled via whitelisting. + If your ADL account is not whitelisted, then using this api will throw Not implemented exception. For further information and assistance please contact Microsoft support. + +## EXAMPLES + +### Example: Get details of a file from the Data Lake Store +```powershell +Get-AzDataLakeStoreDeletedItem -Account ml1ptrashtest -Filter test0/file_123 +``` + +```output +TrashDirPath OriginalPath Type CreationTime +------------ ------------ ---- ------------ +cd6ad5ce-792b-4812-8a33-8f9ed19eb532 adl://ml1ptrashtest.azuredatalake.com/test0/file_1230 FILE 2/8/2019 8:12:18 AM +356cfd42-39c7-451e-96cb-9f47883d91e2 adl://ml1ptrashtest.azuredatalake.com/test0/file_1232 FILE 2/8/2019 8:12:18 AM +e7b30ac8-2dbc-43a3-8ca6-2d420ac0c488 adl://ml1ptrashtest.azuredatalake.com/test0/file_1237 FILE 2/8/2019 8:12:18 AM +``` + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +Specifies the number of results the user wants to find. The query runs until it finds Count results or it searches through entire trash, whichever happens first. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Specifies the search query. A more specific value gives more relevant results. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Collections.Generic.List<Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreDeletedItem> + +## NOTES + +## RELATED LINKS + +[Restore-AzDataLakeStoreDeletedItem](./Restore-AzDataLakeStoreDeletedItem.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreFirewallRule.md b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreFirewallRule.md new file mode 100644 index 0000000000..2f42301e38 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreFirewallRule.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 7D27F7B1-BAF8-4A01-8BA7-A75A4CFAE370 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/get-azdatalakestorefirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreFirewallRule.md +--- + +# Get-AzDataLakeStoreFirewallRule + +## SYNOPSIS +Gets the specified firewall rules in the specified Data Lake Store. +If no firewall rule is specified, then lists all firewall rules for the account. + +## SYNTAX + +``` +Get-AzDataLakeStoreFirewallRule [-Account] <String> [[-Name] <String>] [[-ResourceGroupName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDataLakeStoreFirewallRule cmdlet gets the specified firewall rules in the specified Data Lake Store. +If no firewall rule is specified, then lists all firewall rules for the account. + +## EXAMPLES + +### Example 1: Retrieve a specific firewall rule +```powershell +Get-AzDataLakeStoreFirewallRule -AccountName "ContosoADL" -Name MyFirewallRule +``` + +Returns the firewall rule named "MyFirewallRule" from account "ContosoADL" + +### Example 2: List all firewall rules in an account +```powershell +Get-AzDataLakeStoreFirewallRule -AccountName "ContosoADL" +``` + +Returns all firewall rules in account "ContosoADL" + +## PARAMETERS + +### -Account +The Data Lake Store account to retrieve the firewall rule from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the firewall rule to retrieve + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which want to retrieve the specified account's specified firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreFirewallRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItem.md b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItem.md new file mode 100644 index 0000000000..2875b1982f --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItem.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: ECA70C6C-E0B0-445D-BCAD-041625FAC632 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/get-azdatalakestoreitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreItem.md +--- + +# Get-AzDataLakeStoreItem + +## SYNOPSIS +Gets the details of a file or folder in Data Lake Store. + +## SYNTAX + +``` +Get-AzDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeStoreItem** cmdlet gets the details of a file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Get details of a file from the Data Lake Store +```powershell +Get-AzDataLakeStoreItem -AccountName "ContosoADL" -Path "/MyFiles/Test.csv" +``` + +This command gets the details of the file Test.csv from the Data Lake Store. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path from which to get details of an item, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItem + +## NOTES + +## RELATED LINKS + +[Export-AzDataLakeStoreItem](./Export-AzDataLakeStoreItem.md) + +[Get-AzDataLakeStoreChildItem](./Get-AzDataLakeStoreChildItem.md) + +[Import-AzDataLakeStoreItem](./Import-AzDataLakeStoreItem.md) + +[Join-AzDataLakeStoreItem](./Join-AzDataLakeStoreItem.md) + +[Move-AzDataLakeStoreItem](./Move-AzDataLakeStoreItem.md) + +[New-AzDataLakeStoreItem](./New-AzDataLakeStoreItem.md) + +[Remove-AzDataLakeStoreItem](./Remove-AzDataLakeStoreItem.md) + +[Test-AzDataLakeStoreItem](./Test-AzDataLakeStoreItem.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItemAclEntry.md b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItemAclEntry.md new file mode 100644 index 0000000000..ebebf60a17 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItemAclEntry.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: DFE8C373-2BBA-4A4E-B4B1-926373E68FC4 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/get-azdatalakestoreitemaclentry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreItemAclEntry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreItemAclEntry.md +--- + +# Get-AzDataLakeStoreItemAclEntry + +## SYNOPSIS +Gets an entry in the ACL of a file or folder in Data Lake Store. + +## SYNTAX + +``` +Get-AzDataLakeStoreItemAclEntry [-Account] <String> [-Path] <DataLakeStorePathInstance> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeStoreItemAclEntry** cmdlet gets an entry (ACE) in the access control list (ACL) of a file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Get the ACL for a folder +```powershell +Get-AzDataLakeStoreItemAclEntry -AccountName 'ContosoADL' -Path '/' +``` + +This command gets the ACL for the root directory of the specified Data Lake Store account + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the item for which this cmdlet gets an ACE, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce + +## NOTES + +## RELATED LINKS + +[Remove-AzDataLakeStoreItemAclEntry](./Remove-AzDataLakeStoreItemAclEntry.md) + +[Set-AzDataLakeStoreItemAclEntry](./Set-AzDataLakeStoreItemAclEntry.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItemContent.md b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItemContent.md new file mode 100644 index 0000000000..6754aca757 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItemContent.md @@ -0,0 +1,261 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 15DFF66F-3D78-422B-BA40-71058DE66BA2 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/get-azdatalakestoreitemcontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreItemContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreItemContent.md +--- + +# Get-AzDataLakeStoreItemContent + +## SYNOPSIS +Gets the contents of a file in Data Lake Store. + +## SYNTAX + +### PreviewFileContent (Default) +``` +Get-AzDataLakeStoreItemContent [-Account] <String> [-Path] <DataLakeStorePathInstance> [[-Offset] <Int64>] + [[-Length] <Int64>] [[-Encoding] <Encoding>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### PreviewFileRowsFromHead +``` +Get-AzDataLakeStoreItemContent [-Account] <String> [-Path] <DataLakeStorePathInstance> [[-Head] <Int32>] + [[-Encoding] <Encoding>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PreviewFileRowsFromTail +``` +Get-AzDataLakeStoreItemContent [-Account] <String> [-Path] <DataLakeStorePathInstance> [[-Tail] <Int32>] + [[-Encoding] <Encoding>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeStoreItemContent** cmdlet gets the contents of a file in Data Lake Store. + +## EXAMPLES + +### Example 1: Get the contents of a file +```powershell +Get-AzDataLakeStoreItemContent -AccountName "ContosoADL" -Path "/MyFile.txt" +``` + +This command gets the contents of the file MyFile.txt in the ContosoADL account. + +### Example 2: Get the first two rows of a file +```powershell +Get-AzDataLakeStoreItemContent -AccountName "ContosoADL" -Path "/MyFile.txt" -Head 2 +``` + +This command gets the first two new line separated rows in the file MyFile.txt in the ContosoADL account. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Encoding +Specifies the encoding for the item to create. +The acceptable values for this parameter are: +- Unknown +- String +- Unicode +- Byte +- BigEndianUnicode +- UTF8 +- UTF7 +- Ascii +- Default +- Oem +- BigEndianUTF32 + +```yaml +Type: System.Text.Encoding +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PreviewFileContent +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Head +The number of rows (new line delimited) from the beginning of the file to preview. If no new line is encountered in the first 4mb of data, only that data will be returned. + +```yaml +Type: System.Int32 +Parameter Sets: PreviewFileRowsFromHead +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Length +Specifies the length, in bytes, of the content to get. + +```yaml +Type: System.Int64 +Parameter Sets: PreviewFileContent +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Offset +Specifies the number of bytes to skip in a file before getting content. + +```yaml +Type: System.Int64 +Parameter Sets: PreviewFileContent +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of a file, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tail +The number of rows (new line delimited) from the end of the file to preview. If no new line is encountered in the first 4mb of data, only that data will be returned. + +```yaml +Type: System.Int32 +Parameter Sets: PreviewFileRowsFromTail +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### System.Int32 + +### System.Int64 + +### System.Text.Encoding + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Byte + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItemOwner.md b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItemOwner.md new file mode 100644 index 0000000000..8c94c8122c --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItemOwner.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 335588D4-4D2C-4DBD-B6B2-B1227C4AF9A9 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/get-azdatalakestoreitemowner +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreItemOwner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreItemOwner.md +--- + +# Get-AzDataLakeStoreItemOwner + +## SYNOPSIS +Gets the owner of a file or folder in Data Lake Store. + +## SYNTAX + +``` +Get-AzDataLakeStoreItemOwner [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Type] <Owner> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeStoreItemOwner** cmdlet gets the owner of a file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Get the owner for a directory +```powershell +Get-AzDataLakeStoreItemOwner -AccountName "ContosoADL" -Path / -Type User +``` + +This command gets the user owner for the root directory of the ContosoADL account. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of an item, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Specifies the type of owner to get. +The acceptable values for this parameter are: User and Group. + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+Owner +Parameter Sets: (All) +Aliases: +Accepted values: User, Group + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+Owner + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Set-AzDataLakeStoreItemOwner](./Set-AzDataLakeStoreItemOwner.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItemPermission.md b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItemPermission.md new file mode 100644 index 0000000000..cbb6559581 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreItemPermission.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 476E889F-C763-4EFA-AFD6-B037BA6BA0A1 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/get-azdatalakestoreitempermission +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreItemPermission.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreItemPermission.md +--- + +# Get-AzDataLakeStoreItemPermission + +## SYNOPSIS +Gets the permission octal of a file or folder in Data Lake Store. + +## SYNTAX + +``` +Get-AzDataLakeStoreItemPermission [-Account] <String> [-Path] <DataLakeStorePathInstance> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeStoreItemPermission** cmdlet gets the permission octal of a file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Set the permission octal for a file +```powershell +Get-AzDataLakeStoreItemPermission -AccountName "ContosoADL" -Path "/file.txt" +``` + +This command gets the permission octal for a file. + +## PARAMETERS + +### -Account +Specifies the Data Lake Store account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the file or folder, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +## OUTPUTS + +### System.String + +## NOTES +* Alias: Get-AdlStoreItemPermission + +## RELATED LINKS + +[Set-AzDataLakeStoreItemPermission](./Set-AzDataLakeStoreItemPermission.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreTrustedIdProvider.md b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreTrustedIdProvider.md new file mode 100644 index 0000000000..c9e15a52d3 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreTrustedIdProvider.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: D79080D5-2785-4C46-86FD-FDAA11117D17 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/get-azdatalakestoretrustedidprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreTrustedIdProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreTrustedIdProvider.md +--- + +# Get-AzDataLakeStoreTrustedIdProvider + +## SYNOPSIS +Gets the specified trusted identity provider in the specified Data Lake Store. +If no provider is specified, then lists all providers for the account. + +## SYNTAX + +``` +Get-AzDataLakeStoreTrustedIdProvider [-Account] <String> [[-Name] <String>] [[-ResourceGroupName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeStoreTrustedIdProvider** cmdlet gets the specified trusted identity provider in the specified Data Lake Store. +If no provider is specified, then lists all providers for the account. + +## EXAMPLES + +### Example 1: Get a specific trusted identity provider +```powershell +Get-AzDataLakeStoreTrustedIdProvider -AccountName "ContosoADL" -Name MyProvider +``` + +Returns the provider named "MyProvider" from account "ContosoADL" + +### Example 2: List all providers in an account +```powershell +Get-AzDataLakeStoreTrustedIdProvider -AccountName "ContosoADL" +``` + +Lists all providers under the account "ContosoADL" + +## PARAMETERS + +### -Account +The Data Lake Store account to retrieve the trusted identity provider from + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the trusted identity provider to retrieve + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which want to retrieve the specified account's specified trusted identity provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreTrustedIdProvider + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreVirtualNetworkRule.md b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreVirtualNetworkRule.md new file mode 100644 index 0000000000..a315330ba9 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Get-AzDataLakeStoreVirtualNetworkRule.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/get-azdatalakestorevirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Get-AzDataLakeStoreVirtualNetworkRule.md +--- + +# Get-AzDataLakeStoreVirtualNetworkRule + +## SYNOPSIS +Gets the specified virtual network rules in the specified Data Lake Store. +If no virtual network rule is specified, then lists all virtual network rules for the account. + +## SYNTAX + +``` +Get-AzDataLakeStoreVirtualNetworkRule [-Account] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDataLakeStoreVirtualNetworkRule cmdlet gets the specified virtual network rules in the specified Data Lake Store. +If no virtual network rule is specified, then lists all virtual network rules for the account. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataLakeStoreVirtualNetworkRule -Account "dls" -Name "myVNET" +``` + +```output +ResourceGroupName : +AccountName : +VirtualNetworkRuleName : myVNET +VirtualNetworkSubnetId : /subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Network/virtualNetworks/myVNET/subnets/testId +IgnoreMissingVnetServiceEndpoint : +State : +``` + +Returns the virtual network rule named "myVNET" from account "dls" + +## PARAMETERS + +### -Account +The Data Lake Store account to get the virtual network rule from + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreVirtualNetworkRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Import-AzDataLakeStoreItem.md b/azps-10.1.0/Az.DataLakeStore/Import-AzDataLakeStoreItem.md new file mode 100644 index 0000000000..f48cb33d6f --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Import-AzDataLakeStoreItem.md @@ -0,0 +1,281 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 90630395-8747-4446-A879-323274811956 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/import-azdatalakestoreitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Import-AzDataLakeStoreItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Import-AzDataLakeStoreItem.md +--- + +# Import-AzDataLakeStoreItem + +## SYNOPSIS +Uploads a local file or directory to a Data Lake Store. + +## SYNTAX + +### NoDiagnosticLogging (Default) +``` +Import-AzDataLakeStoreItem [-Account] <String> [-Path] <String> [-Destination] <DataLakeStorePathInstance> + [-Recurse] [-Resume] [-ForceBinary] [-Force] [-Concurrency <Int32>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IncludeDiagnosticLogging +``` +Import-AzDataLakeStoreItem [-Account] <String> [-Path] <String> [-Destination] <DataLakeStorePathInstance> + [-Recurse] [-Resume] [-ForceBinary] [-Force] [-Concurrency <Int32>] [-DiagnosticLogLevel <LogLevel>] + -DiagnosticLogPath <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Import-AzDataLakeStoreItem** cmdlet uploads a local file or directory to a Data Lake Store. + +## EXAMPLES + +### Example 1: Upload a file +```powershell +Import-AzDataLakeStoreItem -AccountName "ContosoADL" -Path "C:\SrcFile.csv" -Destination "/MyFiles/File.csv" -Concurrency 4 +``` + +This command uploads the file SrcFile.csv and adds it to the MyFiles folder in the Data Lake Store as File.csv with a concurrency of 4. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Concurrency +Indicates the number of files or chunks to upload in parallel. Default will be computed as a best effort based on system specifications. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +Specifies the Data Lake Store path to which to upload a file or folder, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiagnosticLogLevel +Optionally indicates the diagnostic log level to use to record events during the file or folder import. Default is Error. + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.LogLevel +Parameter Sets: IncludeDiagnosticLogging +Aliases: +Accepted values: Debug, Information, Error, None + +Required: False +Position: Named +Default value: Error +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DiagnosticLogPath +Specifies the path for the diagnostic log to record events to during the file or folder import. + +```yaml +Type: System.String +Parameter Sets: IncludeDiagnosticLogging +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Indicates that this operation can overwrite the destination file if it already exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ForceBinary +Indicates that the file(s) being copied should be copied with no concern for new line preservation across appends. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the local path of the file or folder to upload. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Recurse +Indicates that this operation should upload all items in all subfolders. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Resume +Indicates that the file(s) being copied are a continuation of a previous upload. This will cause the system to attempt to resume from the last file that was not fully uploaded. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### System.Management.Automation.SwitchParameter + +### System.Int32 + +### Microsoft.Azure.Commands.DataLakeStore.Models.LogLevel + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeStoreItem](./Get-AzDataLakeStoreItem.md) + +[Export-AzDataLakeStoreItem](./Export-AzDataLakeStoreItem.md) + +[Join-AzDataLakeStoreItem](./Join-AzDataLakeStoreItem.md) + +[Move-AzDataLakeStoreItem](./Move-AzDataLakeStoreItem.md) + +[New-AzDataLakeStoreItem](./New-AzDataLakeStoreItem.md) + +[Remove-AzDataLakeStoreItem](./Remove-AzDataLakeStoreItem.md) + +[Test-AzDataLakeStoreItem](./Test-AzDataLakeStoreItem.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Join-AzDataLakeStoreItem.md b/azps-10.1.0/Az.DataLakeStore/Join-AzDataLakeStoreItem.md new file mode 100644 index 0000000000..b9e499103f --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Join-AzDataLakeStoreItem.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 4E9EA2E9-4BE2-4530-BC2B-D369C016CD8C +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/join-azdatalakestoreitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Join-AzDataLakeStoreItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Join-AzDataLakeStoreItem.md +--- + +# Join-AzDataLakeStoreItem + +## SYNOPSIS +Joins one or more files to create one file in Data Lake Store. + +## SYNTAX + +``` +Join-AzDataLakeStoreItem [-Account] <String> [-Paths] <DataLakeStorePathInstance[]> + [-Destination] <DataLakeStorePathInstance> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Join-AzDataLakeStoreItem** cmdlet joins one or more files to create one file in Data Lake Store. + +## EXAMPLES + +### Example 1: Join two items +```powershell +Join-AzDataLakeStoreItem -AccountName "ContosoADL" -Paths "/MyFiles/File01.txt","/MyFiles/File02.txt" -Destination "/MyFiles/CombinedFile.txt" +``` + +This command joins File01.txt and File02.txt to create the file CombinedFile.txt. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +Specifies the Data Lake Store path for the joined item, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Indicates that this operation can overwrite the destination file if it already exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Paths +Specifies an array of Data Lake Store paths of the files to combine, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance[] +Parameter Sets: (All) +Aliases: Path + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance[] + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeStoreItem](./Get-AzDataLakeStoreItem.md) + +[Export-AzDataLakeStoreItem](./Export-AzDataLakeStoreItem.md) + +[Import-AzDataLakeStoreItem](./Import-AzDataLakeStoreItem.md) + +[New-AzDataLakeStoreItem](./New-AzDataLakeStoreItem.md) + +[Remove-AzDataLakeStoreItem](./Remove-AzDataLakeStoreItem.md) + +[Test-AzDataLakeStoreItem](./Test-AzDataLakeStoreItem.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Move-AzDataLakeStoreItem.md b/azps-10.1.0/Az.DataLakeStore/Move-AzDataLakeStoreItem.md new file mode 100644 index 0000000000..8eb4439f6f --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Move-AzDataLakeStoreItem.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 00CCA9B8-7C57-4FC0-9BD1-5FC16010E820 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/move-azdatalakestoreitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Move-AzDataLakeStoreItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Move-AzDataLakeStoreItem.md +--- + +# Move-AzDataLakeStoreItem + +## SYNOPSIS +Moves or renames a file or folder in Data Lake Store. + +## SYNTAX + +``` +Move-AzDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> + [-Destination] <DataLakeStorePathInstance> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Move-AzDataLakeStoreItem** cmdlet moves or renames a file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Move and rename an item +```powershell +Move-AzDataLakeStoreItem -AccountName "ContosoADL" -Path "/Original/Path/File.txt" -Destination "/New/Path/RenamedFile.txt" +``` + +This command renames the item File.txt to RenamedFile.txt and moves it to a different folder. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +Specifies the Data Lake Store path to which to move the item, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Indicates that this operation can overwrite the destination file if it already exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the item to move or rename, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeStoreItem](./Get-AzDataLakeStoreItem.md) + +[Export-AzDataLakeStoreItem](./Export-AzDataLakeStoreItem.md) + +[Import-AzDataLakeStoreItem](./Import-AzDataLakeStoreItem.md) + +[New-AzDataLakeStoreItem](./New-AzDataLakeStoreItem.md) + +[Remove-AzDataLakeStoreItem](./Remove-AzDataLakeStoreItem.md) + +[Test-AzDataLakeStoreItem](./Test-AzDataLakeStoreItem.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/New-AzDataLakeStoreAccount.md b/azps-10.1.0/Az.DataLakeStore/New-AzDataLakeStoreAccount.md new file mode 100644 index 0000000000..1d1f929ac2 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/New-AzDataLakeStoreAccount.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 58AAA284-45A3-4360-B321-FBE0A3F5D7A9 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/new-azdatalakestoreaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/New-AzDataLakeStoreAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/New-AzDataLakeStoreAccount.md +--- + +# New-AzDataLakeStoreAccount + +## SYNOPSIS +Creates a new Data Lake Store account. + +## SYNTAX + +### UserOrSystemAssignedEncryption (Default) +``` +New-AzDataLakeStoreAccount [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + [[-DefaultGroup] <String>] [[-Tag] <Hashtable>] [[-Encryption] <EncryptionConfigType>] + [[-KeyVaultId] <String>] [[-KeyName] <String>] [[-KeyVersion] <String>] [-Tier <TierType>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DisableEncryption +``` +New-AzDataLakeStoreAccount [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + [[-DefaultGroup] <String>] [[-Tag] <Hashtable>] [-DisableEncryption] [-Tier <TierType>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataLakeStoreAccount** cmdlet creates a new Data Lake Store account. + +## EXAMPLES + +### Example 1: Create an account +```powershell +New-AzDataLakeStoreAccount -Name "ContosoADL" -ResourceGroupName "ContosoOrg" -Location "East US 2" +``` + +This command creates a Data Lake Store account named ContosoADL for the East US 2 location. + +## PARAMETERS + +### -DefaultGroup +Specifies the object ID of the AzureActive Directory group to use as the default group owner for new files and folders. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableEncryption +Indicates that the account will not have any form of encryption applied to it. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DisableEncryption +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Encryption +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Store.Models.EncryptionConfigType] +Parameter Sets: UserOrSystemAssignedEncryption +Aliases: +Accepted values: UserManaged, ServiceManaged + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyName +```yaml +Type: System.String +Parameter Sets: UserOrSystemAssignedEncryption +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyVaultId +```yaml +Type: System.String +Parameter Sets: UserOrSystemAssignedEncryption +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyVersion +```yaml +Type: System.String +Parameter Sets: UserOrSystemAssignedEncryption +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the location to use for the account. +The acceptable values for this parameter are: +- East US 2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the account to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specifies tags as key-value pairs. +You can use tags to identify a Data Lake Store account from other Azure resources. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tier +The desired commitment tier for this account to use. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Store.Models.TierType] +Parameter Sets: (All) +Aliases: +Accepted values: Consumption, Commitment1TB, Commitment10TB, Commitment100TB, Commitment500TB, Commitment1PB, Commitment5PB + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Store.Models.EncryptionConfigType, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Management.Automation.SwitchParameter + +### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Store.Models.TierType, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.PSDataLakeStoreAccount + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeStoreAccount](./Get-AzDataLakeStoreAccount.md) + +[Remove-AzDataLakeStoreAccount](./Remove-AzDataLakeStoreAccount.md) + +[Set-AzDataLakeStoreAccount](./Set-AzDataLakeStoreAccount.md) + +[Test-AzDataLakeStoreAccount](./Test-AzDataLakeStoreAccount.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/New-AzDataLakeStoreItem.md b/azps-10.1.0/Az.DataLakeStore/New-AzDataLakeStoreItem.md new file mode 100644 index 0000000000..672bc5d5fa --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/New-AzDataLakeStoreItem.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: A8222AB8-0003-4AC6-8114-294ABE8054CE +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/new-azdatalakestoreitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/New-AzDataLakeStoreItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/New-AzDataLakeStoreItem.md +--- + +# New-AzDataLakeStoreItem + +## SYNOPSIS +Creates a new file or folder in Data Lake Store. + +## SYNTAX + +``` +New-AzDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> [[-Value] <Object>] + [[-Encoding] <Encoding>] [-Folder] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataLakeStoreItem** cmdlet creates a new file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Create a new file and a new folder +```powershell +New-AzDataLakeStoreItem -AccountName "ContosoADL" -Path "/NewFile.txt" +New-AzDataLakeStoreItem -AccountName "ContosoADL" -Path "/NewFolder" -Folder +``` + +The first command creates the file NewFile.txt for the specified account. +The second command creates the folder NewFolder at the root folder. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Encoding +Specifies the encoding for the item to create. +The acceptable values for this parameter are: +- Unknown +- String +- Unicode +- Byte +- BigEndianUnicode +- UTF8 +- UTF7 +- Ascii +- Default +- Oem +- BigEndianUTF32 + +```yaml +Type: System.Text.Encoding +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Folder +Indicates that this operation creates a folder. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Indicates that this operation can overwrite the destination item if it already exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the item to create, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Specifies the content to add to the item you create. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### System.Object + +### System.Text.Encoding + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeStoreItem](./Get-AzDataLakeStoreItem.md) + +[Export-AzDataLakeStoreItem](./Export-AzDataLakeStoreItem.md) + +[Import-AzDataLakeStoreItem](./Import-AzDataLakeStoreItem.md) + +[New-AzDataLakeStoreItem](./New-AzDataLakeStoreItem.md) + +[Remove-AzDataLakeStoreItem](./Remove-AzDataLakeStoreItem.md) + +[Test-AzDataLakeStoreItem](./Test-AzDataLakeStoreItem.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreAccount.md b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreAccount.md new file mode 100644 index 0000000000..a4afb5427d --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreAccount.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 585D6C4D-EA80-4E6B-8C36-E7632430431F +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/remove-azdatalakestoreaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreAccount.md +--- + +# Remove-AzDataLakeStoreAccount + +## SYNOPSIS +Deletes a Data Lake Store account permanently. + +## SYNTAX + +``` +Remove-AzDataLakeStoreAccount [-Name] <String> [[-ResourceGroupName] <String>] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeStoreAccount** cmdlet deletes a Data Lake Store account permanently. + +## EXAMPLES + +### Example 1: Remove a Data Lake Store account +```powershell +Remove-AzDataLakeStoreAccount -Name "ContosoADL" +``` + +This command removes the account named ContosoADL from the Data Lake Store. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the account to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group that contains the account to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeStoreAccount](./Get-AzDataLakeStoreAccount.md) + +[New-AzDataLakeStoreAccount](./New-AzDataLakeStoreAccount.md) + +[Set-AzDataLakeStoreAccount](./Set-AzDataLakeStoreAccount.md) + +[Test-AzDataLakeStoreAccount](./Test-AzDataLakeStoreAccount.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreFirewallRule.md b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreFirewallRule.md new file mode 100644 index 0000000000..dbbb3c4b63 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreFirewallRule.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 6C7A7E1A-87A2-4F0D-9091-413C111F47F0 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/remove-azdatalakestorefirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreFirewallRule.md +--- + +# Remove-AzDataLakeStoreFirewallRule + +## SYNOPSIS +Removes the specified firewall rule in the specified Data Lake Store. + +## SYNTAX + +``` +Remove-AzDataLakeStoreFirewallRule [-Account] <String> [[-Name] <String>] [-PassThru] + [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeStoreFirewallRule** cmdlet removes the specified firewall rule in the specified Data Lake Store. + +## EXAMPLES + +### Example 1: Remove a firewall rule from an account +```powershell +Remove-AzDataLakeStoreFirewallRule -AccountName "ContosoADL" -Name MyFirewallRule +``` + +Removes firewall rule "MyFirewallRule" from account "ContosoADL" + +## PARAMETERS + +### -Account +The Data Lake Store account to update the firewall rule in + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the firewall rule to delete. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates a boolean response should be returned indicating the result of the delete operation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the account to remove the firewall rule from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreItem.md b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreItem.md new file mode 100644 index 0000000000..015f92de93 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreItem.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 164DC871-0F0C-4E71-A37A-2B85CE65C2C4 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/remove-azdatalakestoreitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreItem.md +--- + +# Remove-AzDataLakeStoreItem + +## SYNOPSIS +Deletes a file or folder in Data Lake Store. + +## SYNTAX + +``` +Remove-AzDataLakeStoreItem [-Account] <String> [-Paths] <DataLakeStorePathInstance[]> [-Recurse] [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeStoreItem** cmdlet deletes a file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Remove multiple items +```powershell +Remove-AzDataLakeStoreItem -AccountName "ContosoADL" -Paths "/File01.txt","/MyFiles/File.csv" +``` + +This command removes the files File01.txt and File.csv from the Data Lake Store. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Paths +Specifies an array of Data Lake Store paths of the files to remove, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Recurse +Indicates that this operation deletes all items in the target folder, including subfolders. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeStoreItem](./Get-AzDataLakeStoreItem.md) + +[Export-AzDataLakeStoreItem](./Export-AzDataLakeStoreItem.md) + +[Import-AzDataLakeStoreItem](./Import-AzDataLakeStoreItem.md) + +[Join-AzDataLakeStoreItem](./Join-AzDataLakeStoreItem.md) + +[New-AzDataLakeStoreItem](./New-AzDataLakeStoreItem.md) + +[Test-AzDataLakeStoreItem](./Test-AzDataLakeStoreItem.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreItemAcl.md b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreItemAcl.md new file mode 100644 index 0000000000..3905a17b83 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreItemAcl.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: D3E8A6A6-C6C5-46B0-914B-75088A6F6011 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/remove-azdatalakestoreitemacl +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreItemAcl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreItemAcl.md +--- + +# Remove-AzDataLakeStoreItemAcl + +## SYNOPSIS +Clears the ACL of a file or folder in Data Lake Store. + +## SYNTAX + +``` +Remove-AzDataLakeStoreItemAcl [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Default] [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeStoreItemAcl** cmdlet clears the access control list (ACL) of a file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Remove the ACL from a folder +```powershell +Remove-AzDataLakeStoreItemAcl -AccountName "ContosoADL" -Path "/" +``` + +This command removes the ACL for the root directory for the ContosoADL account. + +## PARAMETERS + +### -Account +Specifies the Data Lake Store account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Default +Indicates that the cmdlet removes the default ACL for a file or a folder. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates a boolean response should be returned indicating the result of the delete operation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the item, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES +* Alias: Remove-AdlStoreAcl + +## RELATED LINKS + +[Get-AzDataLakeStoreItemAclEntry](./Get-AzDataLakeStoreItemAclEntry.md) + +[Set-AzDataLakeStoreItemAcl](./Set-AzDataLakeStoreItemAcl.md) + +[Set-AzDataLakeStoreItemAclEntry](./Set-AzDataLakeStoreItemAclEntry.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreItemAclEntry.md b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreItemAclEntry.md new file mode 100644 index 0000000000..843d3710b0 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreItemAclEntry.md @@ -0,0 +1,291 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 33E7607E-C2BC-4F46-9038-91AC92041F00 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/remove-azdatalakestoreitemaclentry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreItemAclEntry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreItemAclEntry.md +--- + +# Remove-AzDataLakeStoreItemAclEntry + +## SYNOPSIS +Removes an entry from the ACL of a file or folder in Data Lake Store. + +## SYNTAX + +### RemoveByACLObject (Default) +``` +Remove-AzDataLakeStoreItemAclEntry [-Account] <String> [-Path] <DataLakeStorePathInstance> + [-Acl] <DataLakeStoreItemAce[]> [-PassThru] [-Recurse] [-Concurrency <Int32>] [-ShowProgress] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveSpecificACE +``` +Remove-AzDataLakeStoreItemAclEntry [-Account] <String> [-Path] <DataLakeStorePathInstance> [-AceType] <AceType> + [[-Id] <Guid>] [-Default] [-PassThru] [-Recurse] [-Concurrency <Int32>] [-ShowProgress] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeStoreItemAclEntry** cmdlet removes an entry (ACE) from the access control list (ACL) of a file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Remove a user entry +```powershell +Remove-AzDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -AceType User -Id (Get-AzADUser -Mail "PattiFuller@contoso.com").ObjectId +``` + +This command removes the user ACE for Patti Fuller from the ContosoADL account. + +### Example 2: Remove a user entry recursively +```powershell +Remove-AzDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -AceType User -Id (Get-AzADUser -Mail "PattiFuller@contoso.com").ObjectId -Recurse -Concurrency 128 +``` + +### Example 3: Remove permissions for an ACE recursively using Acl object +```powershell +$fullAcl="user:enterpriseObjectID:rwx,default:user:enterpriseObjectID:rwx" +$newFullAcl = $fullAcl.Split(",") +Remove-AzDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -Acl $newFullAcl -Recurse -Concurrency 128 -ShowProgress -Verbose +``` + +This command removes the user ACE for Patti Fuller from the root and recursively from all it's subdirectories and files for account ContosoADL. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AceType +Specifies the type of ACE to remove. +The acceptable values for this parameter are: +- User +- Group +- Mask +- Other + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+AceType +Parameter Sets: RemoveSpecificACE +Aliases: +Accepted values: User, Group, Mask, Other + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Acl +Specifies the ACL object that contains the entries to be removed. + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[] +Parameter Sets: RemoveByACLObject +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Concurrency +Number of files/directories processed in parallel. Optional: a reasonable default will be selected + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Default +Indicates that this operation removes the default ACE from the specified ACL. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RemoveSpecificACE +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the object ID of the AzureActive Directory user, group, or service principal for which to remove an ACE. + +```yaml +Type: System.Guid +Parameter Sets: RemoveSpecificACE +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates a boolean response should be returned indicating the result of the delete operation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the item from which to remove an ACE, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Recurse +Indicates the ACL to be removed recursively to the child subdirectories and files + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShowProgress +If passed then progress status is showed. Only applicable when recursive Acl remove is done. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[] + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+AceType + +### System.Guid + +### System.Management.Automation.SwitchParameter + +### System.Int32 + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Set-AzDataLakeStoreItemAclEntry](./Set-AzDataLakeStoreItemAclEntry.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreTrustedIdProvider.md b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreTrustedIdProvider.md new file mode 100644 index 0000000000..477ad7f696 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreTrustedIdProvider.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 30C10687-F172-4663-8D4A-F0DDEA5C3741 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/remove-azdatalakestoretrustedidprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreTrustedIdProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreTrustedIdProvider.md +--- + +# Remove-AzDataLakeStoreTrustedIdProvider + +## SYNOPSIS +Removes the specified trusted identity provider in the specified Data Lake Store. + +## SYNTAX + +``` +Remove-AzDataLakeStoreTrustedIdProvider [-Account] <String> [[-Name] <String>] [-PassThru] + [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeStoreTrustedIdProvider** cmdlet removes the specified trusted identity provider in the specified Data Lake Store. + +## EXAMPLES + +### Example 1: Remove a trusted identity provider. +```powershell +Remove-AzDataLakeStoreTrustedIdProvider -AccountName "ContosoADL" -Name MyProvider +``` + +Removes the provider "MyProvider" from account "ContosoADL" + +## PARAMETERS + +### -Account +The Data Lake Store account to remove the trusted identity provider from + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the trusted identity provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates a boolean response should be returned indicating the result of the delete operation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the account to remove the trusted identity provider from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreVirtualNetworkRule.md b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreVirtualNetworkRule.md new file mode 100644 index 0000000000..f642238374 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Remove-AzDataLakeStoreVirtualNetworkRule.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/remove-azdatalakestorevirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Remove-AzDataLakeStoreVirtualNetworkRule.md +--- + +# Remove-AzDataLakeStoreVirtualNetworkRule + +## SYNOPSIS +Removes the specified virtual network rule in the specified Data Lake Store. + +## SYNTAX + +``` +Remove-AzDataLakeStoreVirtualNetworkRule [-Account] <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeStoreVirtualNetworkRule** cmdlet removes the specified virtual network rule in the specified Data Lake Store. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataLakeStoreVirtualNetworkRule -Account "dls" -Name "myVNET" +``` + +Removes virtual network rule "myVNET" from account "dls" + +## PARAMETERS + +### -Account +The Data Lake Store account to update the virtual network rule in + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates a boolean response should be returned indicating the result of the delete operation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Restore-AzDataLakeStoreDeletedItem.md b/azps-10.1.0/Az.DataLakeStore/Restore-AzDataLakeStoreDeletedItem.md new file mode 100644 index 0000000000..2b23dfe6cb --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Restore-AzDataLakeStoreDeletedItem.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: D231E9A0-DC1E-411B-A87A-56A8C767F6C5 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/restore-azdatalakestoredeleteditem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Restore-AzDataLakeStoreDeletedItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Restore-AzDataLakeStoreDeletedItem.md +--- + +# Restore-AzDataLakeStoreDeletedItem + +## SYNOPSIS +Restore a deleted file or folder in Azure Data Lake. + +## SYNTAX + +### Default (Default) +``` +Restore-AzDataLakeStoreDeletedItem [-Account] <String> [-Path] <String> [-Destination] <String> + [-Type] <String> [-RestoreAction <String>] [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### InputObject +``` +Restore-AzDataLakeStoreDeletedItem [-Account] <String> [-DeletedItem] <DataLakeStoreDeletedItem> + [-RestoreAction <String>] [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzDataLakeStoreDeletedItem** cmdlet restores a deleted file or folder in Data Lake Store. Requires the path of deleted item in trash returned by Get-AzDataLakeStoreDeletedItem. +Caution: Undeleting files is a best effort operation. There are no guarantees that a file can be restored once it is deleted. The use of this API is enabled via whitelisting. +If your ADL account is not whitelisted, then using this api will throw Not implemented exception. For further information and assistance please contact Microsoft support. + +## EXAMPLES + +### Example 1: Restore a file from the Data Lake Store using -force option +```powershell +Restore-AzDataLakeStoreDeletedItem -Account ml1ptrashtest -Path 927e8fb1-a287-4353-b50e-3b4a39ae4088 -Destination adl://ml1ptrashtest.azuredatalake.com/test0/file_1230 -Type "file" -Force +``` +This command restores a file from the Data Lake Store using -force option + +### Example 2: Restore a file from Data Lake Store using user confirmation +```powershell +Restore-AzDataLakeStoreDeletedItem -Account ml1ptrashtest -Path 927e8fb1-a287-4353-b50e-3b4a39ae4088 -Destination adl://ml1ptrashtest.azuredatalake.com/test4/file_1115 -Type file +``` + +```output +Restore user data ? +From - 927e8fb1-a287-4353-b50e-3b4a39ae4088 +To - adl://ml1ptrashtest.azuredatalake.com/test4/file_1115 +Type - file +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +``` +This command restores a file from Data Lake Store using user confirmation + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedItem +The deleted item object. + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreDeletedItem +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Destination +The destination path to where the deleted file or folder should be restored. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return boolean true on success. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path of the deleted file or folder in trash. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestoreAction +Action to take on destination name conflicts - "copy" or "overwrite" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +The type of entry being restored - "file" or "folder" + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### None + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeStoreDeletedItem](./Get-AzDataLakeStoreDeletedItem.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreAccount.md b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreAccount.md new file mode 100644 index 0000000000..1695b99396 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreAccount.md @@ -0,0 +1,236 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 0EB5C25C-D0A1-4444-AEA2-C963D5069CFC +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/set-azdatalakestoreaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreAccount.md +--- + +# Set-AzDataLakeStoreAccount + +## SYNOPSIS +Modifies a Data Lake Store account. + +## SYNTAX + +``` +Set-AzDataLakeStoreAccount [-Name] <String> [[-DefaultGroup] <String>] [[-Tag] <Hashtable>] + [[-TrustedIdProviderState] <TrustedIdProviderState>] [[-FirewallState] <FirewallState>] + [[-ResourceGroupName] <String>] [-Tier <TierType>] [-AllowAzureIpState <FirewallAllowAzureIpsState>] + [-KeyVersion <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeStoreAccount** cmdlet modifies a Data Lake Store account. + +## EXAMPLES + +### Example 1: Add a tag to an account +```powershell +Set-AzDataLakeStoreAccount -Name "ContosoADL" -Tag @{"stage"="production"} +``` + +This command adds the specified tag to the Data Lake Store account named ContosoADL. + +### Example 2 + +Modifies a Data Lake Store account. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Set-AzDataLakeStoreAccount -FirewallState Enabled -Name 'ContosoADL' +``` + +## PARAMETERS + +### -AllowAzureIpState +Optionally allow/block Azure originating IPs through the firewall. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Store.Models.FirewallAllowAzureIpsState] +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultGroup +Specifies the ID of an AzureActive Directory group. +This group is the default group for files and folders that you create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallState +Optionally enable or disable existing firewall rules. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Store.Models.FirewallState] +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyVersion +If the encryption type is User assigned, the user can rotate their key version with this parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Data Lake Store account to modify. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specifies tags as key-value pairs. +You can use tags to identify a Data Lake Store account from other Azure resources. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tier +The desired commitment tier for this account to use. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Store.Models.TierType] +Parameter Sets: (All) +Aliases: +Accepted values: Consumption, Commitment1TB, Commitment10TB, Commitment100TB, Commitment500TB, Commitment1PB, Commitment5PB + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TrustedIdProviderState +Optionally enable or disable the existing trusted ID providers. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Store.Models.TrustedIdProviderState] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Store.Models.TrustedIdProviderState, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Store.Models.FirewallState, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Store.Models.TierType, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Store.Models.FirewallAllowAzureIpsState, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.PSDataLakeStoreAccount + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeStoreAccount](./Get-AzDataLakeStoreAccount.md) + +[New-AzDataLakeStoreAccount](./New-AzDataLakeStoreAccount.md) + +[Remove-AzDataLakeStoreAccount](./Remove-AzDataLakeStoreAccount.md) + +[Test-AzDataLakeStoreAccount](./Test-AzDataLakeStoreAccount.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreFirewallRule.md b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreFirewallRule.md new file mode 100644 index 0000000000..065da6fba6 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreFirewallRule.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 9983EA1E-2515-4F5D-8476-8D0EE9837E88 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/set-azdatalakestorefirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreFirewallRule.md +--- + +# Set-AzDataLakeStoreFirewallRule + +## SYNOPSIS +Modifies the specified firewall rule in the specified Data Lake Store. + +## SYNTAX + +``` +Set-AzDataLakeStoreFirewallRule [-Account] <String> [-Name] <String> [[-StartIpAddress] <String>] + [[-EndIpAddress] <String>] [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeStoreFirewallRule** cmdlet modifies the specified firewall rule in the specified Data Lake Store. + +## EXAMPLES + +### Example 1: Update the start and end IP range for a firewall rule +```powershell +Set-AzDataLakeStoreFirewallRule -AccountName "ContosoADL" -Name MyFirewallRule -StartIpAddress "127.0.0.1" -EndIpAddress "127.0.0.2" +``` + +Updates the firewall rule "MyFirewallRule" in account "ContosoADL" to have a range of 127.0.0.1 - 127.0.0.2 + +## PARAMETERS + +### -Account +The Data Lake Store account to update the firewall rule in + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIpAddress +The end of the valid ip range for the firewall rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the account to update the firewall rule for. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartIpAddress +The start of the valid ip range for the firewall rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreFirewallRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemAcl.md b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemAcl.md new file mode 100644 index 0000000000..d01e5ba3fd --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemAcl.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: FFB335D4-AE3E-4788-B6FD-9AFC36F52B61 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/set-azdatalakestoreitemacl +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreItemAcl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreItemAcl.md +--- + +# Set-AzDataLakeStoreItemAcl + +## SYNOPSIS +Modifies the ACL of a file or folder in Data Lake Store. + +## SYNTAX + +``` +Set-AzDataLakeStoreItemAcl [-Account] <String> [-Path] <DataLakeStorePathInstance> + [-Acl] <DataLakeStoreItemAce[]> [-PassThru] [-Recurse] [-Concurrency <Int32>] [-ShowProgress] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeStoreItemAcl** cmdlet modifies the access control list (ACL) of a file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Set the ACL for a file and a folder +```powershell +$ACL = Get-AzDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / +Set-AzDataLakeStoreItemAcl -AccountName "ContosoADL" -Path "/MyFiles/Test.txt" -Acl $ACL +``` + +The first command gets the ACL for the root directory of the ContosoADL account, and then stores it in the $ACL variable. +The second command sets the ACL for the file Test.txt to the one in $ACL. + +### Example 2: Set the ACL for folder recursively +```powershell +$ACL = Get-AzDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path /Folder1 +Set-AzDataLakeStoreItemAcl -AccountName "ContosoADL" -Path "/Folder2" -Acl $ACL -Recurse -Concurrency 128 +``` + +The first command gets the ACL for the directory Folder1 of the ContosoADL account, and then stores it in the $ACL variable. +The second command sets the ACL recursively to Folder2 and its sub directories and files to the one in $ACL. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Acl +Specifies an ACL for a file or a folder. + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Concurrency +Number of files/directories processed in parallel. Optional: a reasonable default will be selected. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates the resulting ACL should be returned. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the file or folder, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Recurse +Indicates the ACL to be set recursively to the child subdirectories and files + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShowProgress +If passed then progress status is showed. Only applicable when recursive Acl set is done. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[] + +### System.Management.Automation.SwitchParameter + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemAclEntry.md b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemAclEntry.md new file mode 100644 index 0000000000..2066436741 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemAclEntry.md @@ -0,0 +1,317 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 0671D833-8B3A-4480-A576-92F1A9E8CE92 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/set-azdatalakestoreitemaclentry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreItemAclEntry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreItemAclEntry.md +--- + +# Set-AzDataLakeStoreItemAclEntry + +## SYNOPSIS +Modifies an entry in the ACL of a file or folder in Data Lake Store. + +## SYNTAX + +### SetByACLObject (Default) +``` +Set-AzDataLakeStoreItemAclEntry [-Account] <String> [-Path] <DataLakeStorePathInstance> + [-Acl] <DataLakeStoreItemAce[]> [-PassThru] [-Recurse] [-Concurrency <Int32>] [-ShowProgress] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetSpecificACE +``` +Set-AzDataLakeStoreItemAclEntry [-Account] <String> [-Path] <DataLakeStorePathInstance> [-AceType] <AceType> + [[-Id] <Guid>] [-Permissions] <Permission> [-Default] [-PassThru] [-Recurse] [-Concurrency <Int32>] + [-ShowProgress] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeStoreItemAclEntry** cmdlet modifies an entry (ACE) in the access control list (ACL) of a file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Modify permissions for an ACE +```powershell +Set-AzDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -AceType User -Id (Get-AzADUser -Mail "PattiFuller@contoso.com").ObjectId -Permissions All +``` + +This command modifies the ACE for Patti Fuller to have all permissions. + +### Example 2: Modify permissions for an ACE recursively +```powershell +Set-AzDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -AceType User -Id (Get-AzADUser -Mail "PattiFuller@contoso.com").ObjectId -Permissions All -Recurse -Concurrency 128 +``` + +### Example 3: Modify permissions for an ACE recursively using Acl object +```powershell +$fullAcl="user:userid1:--x,default:user:userid1:--x" +$newFullAcl = $fullAcl.Split(",") +Set-AzDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -Acl $newFullAcl -Recurse -Concurrency 128 -ShowProgress -Verbose +``` + +This command recursively modifies the ACE for Patti Fuller to have all permissions to root and all its subdirectories and files. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AceType +Specifies the type of ACE to modify. +The acceptable values for this parameter are: +- User +- Group +- Mask +- Other + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+AceType +Parameter Sets: SetSpecificACE +Aliases: +Accepted values: User, Group, Mask, Other + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Acl +Specifies the ACL object that contains the entries to modify. + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[] +Parameter Sets: SetByACLObject +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Concurrency +Number of files/directories processed in parallel. Optional: a reasonable default will be selected + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Default +Indicates that this operation modifies the default ACE from the specified ACL. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetSpecificACE +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the object ID of the AzureActive Directory user, group, or service principal for which to modify an ACE. + +```yaml +Type: System.Guid +Parameter Sets: SetSpecificACE +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates the resulting ACL should be returned. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the item for which to modify an ACE, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Permissions +Specifies the permissions for the ACE. +The acceptable values for this parameter are: +- None +- Execute +- Write +- WriteExecute +- Read +- ReadExecute +- ReadWrite +- All + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+Permission +Parameter Sets: SetSpecificACE +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Recurse +Indicates the ACL to be modified recursively to the child subdirectories and files + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShowProgress +If passed then progress status is showed. Only applicable when recursive Acl modify is done. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[] + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+AceType + +### System.Guid + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+Permission + +### System.Management.Automation.SwitchParameter + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce + +## NOTES + +## RELATED LINKS + +[Remove-AzDataLakeStoreItemAclEntry](./Remove-AzDataLakeStoreItemAclEntry.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemExpiry.md b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemExpiry.md new file mode 100644 index 0000000000..1dd588c4e5 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemExpiry.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/set-azdatalakestoreitemexpiry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreItemExpiry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreItemExpiry.md +--- + +# Set-AzDataLakeStoreItemExpiry + +## SYNOPSIS +Sets or removes the expire time for a file in an Azure Data Lake Store account. + +## SYNTAX + +### SetAbsoluteNeverExpireExpiry (Default) +``` +Set-AzDataLakeStoreItemExpiry [-Account] <String> [-Path] <DataLakeStorePathInstance> + [[-Expiration] <DateTimeOffset>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetRelativeExpiry +``` +Set-AzDataLakeStoreItemExpiry [-Account] <String> [-Path] <DataLakeStorePathInstance> + [-RelativeFileExpiryOption] <PathRelativeExpiryOptions> [[-RelativeTime] <Int64>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeStoreItemExpiry** cmdlet sets or removes the expire time for a file in an Azure Data Lake Store account. + +## EXAMPLES + +### Example 1: Set the expiration time for a file +```powershell +Set-AzDataLakeStoreItemExpiry -AccountName "ContosoADL" -Path /myfile.txt -Expiration ([DateTimeOffset]::Now.AddHours(2)) +``` + +Sets expiration on the file myfile.txt in account ContosoADL to be two hours from now. +This will cause the file to expire (be marked for delete) in two hours. + +### Example 2: Remove the expiration on a file +```powershell +Set-AzDataLakeStoreItemExpiry -AccountName "ContosoADL" -Path /myfile.txt +``` + +Removes any expiration that was previously set on file 'myfile.txt' in account 'ContosoADL'. +This means the file will not automatically expire (be marked for delete) and will need to be manually deleted or set to expire again. + +### Example 3: Set expiration time for a file relative to now +```powershell +Set-AzDataLakeStoreItemExpiry -Account "ContosoADL" -Path /myfile.txt -RelativeFileExpiryOption RelativeToNow -RelativeTime 240000 +Set-AzDataLakeStoreItemExpiry -Account "ContosoADL" -Path /myfile.txt -RelativeFileExpiryOption RelativeToCreationDate -RelativeTime 240000 +``` + +The first command sets the expiration time of the file /myfile.txt 240 seconds relative to current time at server. +The second command sets the expiration time of the file /myfile.txt 240 seconds relative to creation time at server. + +## PARAMETERS + +### -Account +Specifies the Data Lake Store account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expiration +The absolute expiration time for the specified file. +If no value or set to MaxValue, the file will never expire. + +```yaml +Type: System.DateTimeOffset +Parameter Sets: SetAbsoluteNeverExpireExpiry +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the file item for which to set or remove expiry. + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RelativeFileExpiryOption +Relative expiry options. RelativeToNow or RelativeToCreationDate are current options + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+PathRelativeExpiryOptions +Parameter Sets: SetRelativeExpiry +Aliases: +Accepted values: RelativeToNow, RelativeToCreationDate + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RelativeTime +The relative time in milliseconds with respect to now or creation time + +```yaml +Type: System.Int64 +Parameter Sets: SetRelativeExpiry +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### System.DateTimeOffset + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+PathRelativeExpiryOptions + +### System.Int64 + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItem + +## NOTES +Alias: Set-AdlStoreItemExpiry + +## RELATED LINKS + +[Get-AzDataLakeStoreItem](./Get-AzDataLakeStoreItem.md) + diff --git a/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemOwner.md b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemOwner.md new file mode 100644 index 0000000000..4ec8a369e6 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemOwner.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 415C5854-FE03-4D4E-BE84-408EA5F95E34 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/set-azdatalakestoreitemowner +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreItemOwner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreItemOwner.md +--- + +# Set-AzDataLakeStoreItemOwner + +## SYNOPSIS +Modifies the owner of a file or folder in Data Lake Store. + +## SYNTAX + +``` +Set-AzDataLakeStoreItemOwner [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Type] <Owner> + [-Id] <Guid> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeStoreItemOwner** cmdlet modifies the owner of a file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Set the owner for an item +```powershell +Set-AzDataLakeStoreItemOwner -AccountName "ContosoADL" -Path / -Type User -Id (Get-AzADUser -Mail "PattiFuller@contoso.com").ObjectId +``` + +This command sets the owner for the root directory to Patti Fuller. + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the object ID of the AzureActive Directory user, group, or service principal to use as the owner. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates the resulting updated owner should be returned. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the item to modify, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Specifies the type of owner to set. +The acceptable values for this parameter are: User and Group. + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+Owner +Parameter Sets: (All) +Aliases: +Accepted values: User, Group + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+Owner + +### System.Guid + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeStoreItemOwner](./Get-AzDataLakeStoreItemOwner.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemPermission.md b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemPermission.md new file mode 100644 index 0000000000..41600a59b5 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreItemPermission.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 6ACE045E-67AD-40FE-86E4-450AF522F174 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/set-azdatalakestoreitempermission +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreItemPermission.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreItemPermission.md +--- + +# Set-AzDataLakeStoreItemPermission + +## SYNOPSIS +Modifies the permission octal of a file or folder in Data Lake Store. + +## SYNTAX + +``` +Set-AzDataLakeStoreItemPermission [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Permission] <Int32> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeStoreItemPermission** cmdlet modifies the permission octal of a file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Set the permission octal for an item +```powershell +Set-AzDataLakeStoreItemPermission -AccountName "ContosoADL" -Path "/file.txt" -Permission 0770 +``` + +This command sets the permission octal for a file to 0770, which translates to clearing the sticky bit, setting read/write/execute permissions for the owner of the file, setting read/write/execute permissions for the owning group of the file, and clearing read/write/execute permissions for other. + +## PARAMETERS + +### -Account +Specifies the Data Lake Store account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the file or folder, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Permission +The permissions to set for the file or folder, expressed as an octal (e.g. +'777') + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### System.Int32 + +## OUTPUTS + +### System.Boolean + +## NOTES +* Alias: Set-AdlStoreItemPermission + +## RELATED LINKS + +[Get-AzDataLakeStoreItemPermission](./Get-AzDataLakeStoreItemPermission.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreTrustedIdProvider.md b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreTrustedIdProvider.md new file mode 100644 index 0000000000..bf0234bce8 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreTrustedIdProvider.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: BDEF8BAA-0C64-465D-9ED4-6FEFC1E850CC +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/set-azdatalakestoretrustedidprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreTrustedIdProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreTrustedIdProvider.md +--- + +# Set-AzDataLakeStoreTrustedIdProvider + +## SYNOPSIS +Modifies the specified trusted identity provider in the specified Data Lake Store. + +## SYNTAX + +``` +Set-AzDataLakeStoreTrustedIdProvider [-Account] <String> [-Name] <String> [-ProviderEndpoint] <String> + [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeStoreTrustedIdProvider** cmdlet modifies the specified trusted identity provider in the specified Data Lake Store. + +## EXAMPLES + +### Example 1: Update a Trusted Identity Provider Endpoint +```powershell +Set-AzDataLakeStoreTrustedIdProvider -AccountName "ContosoADL" -Name MyProvider -ProviderEndpoint "https://sts.windows.net/6b04908c-b91f-40ce-8024-7ee8a4fd6150" +``` + +This updates the provider endpoint for firewall rule "MyProvider" in account "ContosoADL" to "https://sts.windows.net/6b04908c-b91f-40ce-8024-7ee8a4fd6150" + +## PARAMETERS + +### -Account +The Data Lake Store account to add the trusted identity provider to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the trusted identity provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProviderEndpoint +The valid trusted provider endpoint in the format: https://sts.windows.net/\<provider identity\> + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the account to update the trusted identity provider for. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreTrustedIdProvider + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreVirtualNetworkRule.md b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreVirtualNetworkRule.md new file mode 100644 index 0000000000..e3348a02ea --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Set-AzDataLakeStoreVirtualNetworkRule.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/set-azdatalakestorevirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Set-AzDataLakeStoreVirtualNetworkRule.md +--- + +# Set-AzDataLakeStoreVirtualNetworkRule + +## SYNOPSIS +Modifies the specified virtual network rule in the specified Data Lake Store. + +## SYNTAX + +``` +Set-AzDataLakeStoreVirtualNetworkRule [-Account] <String> [-Name] <String> [-SubnetId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeStoreVirtualNetworkRule** cmdlet modifies the specified virtual network rule in the specified Data Lake Store. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDataLakeStoreVirtualNetworkRule -Account "dls" -Name "myVNET" -SubnetId "updatedId" +``` + +```output +ResourceGroupName : +AccountName : +VirtualNetworkRuleName : myVNET +VirtualNetworkSubnetId : /subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Network/virtualNetworks/myVNET/subnets/updatedId +IgnoreMissingVnetServiceEndpoint : +State : +``` + +Updates the subnet id of virtual network rule "myVNET" in account "dls" to "updatedId" + +## PARAMETERS + +### -Account +The Data Lake Store account to update the virtual network rule in + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubnetId +The start of the valid ip range for the virtual network rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreVirtualNetworkRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataLakeStore/Test-AzDataLakeStoreAccount.md b/azps-10.1.0/Az.DataLakeStore/Test-AzDataLakeStoreAccount.md new file mode 100644 index 0000000000..208f0831c4 --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Test-AzDataLakeStoreAccount.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 613DE097-65E0-4F08-839D-F9B53F772382 +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/test-azdatalakestoreaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Test-AzDataLakeStoreAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Test-AzDataLakeStoreAccount.md +--- + +# Test-AzDataLakeStoreAccount + +## SYNOPSIS +Tests the existence of a Data Lake Store account. + +## SYNTAX + +``` +Test-AzDataLakeStoreAccount [-Name] <String> [[-ResourceGroupName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzDataLakeStoreAccount** cmdlet tests the existence of a Data Lake Store account. + +## EXAMPLES + +### Example 1: Test an account +```powershell +Test-AzDataLakeStoreAccount -Name "ContosoADL" +``` + +This command tests whether the account named ContosoADL exists. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Data Lake Store account to test. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the account to test. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzDataLakeStoreAccount](./Get-AzDataLakeStoreAccount.md) + +[New-AzDataLakeStoreAccount](./New-AzDataLakeStoreAccount.md) + +[Remove-AzDataLakeStoreAccount](./Remove-AzDataLakeStoreAccount.md) + +[Set-AzDataLakeStoreAccount](./Set-AzDataLakeStoreAccount.md) + + diff --git a/azps-10.1.0/Az.DataLakeStore/Test-AzDataLakeStoreItem.md b/azps-10.1.0/Az.DataLakeStore/Test-AzDataLakeStoreItem.md new file mode 100644 index 0000000000..ae7f453adf --- /dev/null +++ b/azps-10.1.0/Az.DataLakeStore/Test-AzDataLakeStoreItem.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataLakeStore.dll-Help.xml +Module Name: Az.DataLakeStore +ms.assetid: 0937A390-6AC2-4611-AA6C-99936AC0ABFD +online version: https://learn.microsoft.com/powershell/module/az.datalakestore/test-azdatalakestoreitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Test-AzDataLakeStoreItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataLakeStore/DataLakeStore/help/Test-AzDataLakeStoreItem.md +--- + +# Test-AzDataLakeStoreItem + +## SYNOPSIS +Tests the existence of a file or folder in Data Lake Store. + +## SYNTAX + +``` +Test-AzDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> [[-PathType] <PathType>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzDataLakeStoreItem** cmdlet tests the existence of a file or folder in Data Lake Store. + +## EXAMPLES + +### Example 1: Test a file +```powershell +Test-AzDataLakeStoreItem -AccountName "ContosoADL" -Path "/MyFiles/Test.csv" +``` + +This command tests whether the file Test.csv exists in the ContosoADL account. + +### Example 2 + +Tests the existence of a file or folder in Data Lake Store. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Test-AzDataLakeStoreItem -Account 'ContosoADL' -Path '/MyFiles/Test.csv' -PathType Any +``` + +## PARAMETERS + +### -Account +Specifies the name of the Data Lake Store account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the Data Lake Store path of the item to test, starting with the root directory (/). + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PathType +Specifies the type of item to test. +The acceptable values for this parameter are: +- Any +- File +- Folder + +```yaml +Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+PathType +Parameter Sets: (All) +Aliases: +Accepted values: Any, File, Folder + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance + +### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+PathType + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Export-AzDataLakeStoreItem](./Export-AzDataLakeStoreItem.md) + +[Get-AzDataLakeStoreItem](./Get-AzDataLakeStoreItem.md) + +[Import-AzDataLakeStoreItem](./Import-AzDataLakeStoreItem.md) + +[Join-AzDataLakeStoreItem](./Join-AzDataLakeStoreItem.md) + +[Move-AzDataLakeStoreItem](./Move-AzDataLakeStoreItem.md) + +[Remove-AzDataLakeStoreItem](./Remove-AzDataLakeStoreItem.md) + + diff --git a/azps-10.1.0/Az.DataMigration/Az.DataMigration.md b/azps-10.1.0/Az.DataMigration/Az.DataMigration.md new file mode 100644 index 0000000000..2b74d5ac37 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Az.DataMigration.md @@ -0,0 +1,162 @@ +--- +Module Name: Az.DataMigration +Module Guid: 150d9544-6348-4373-806f-10cd0b4de4cb +Download Help Link: https://learn.microsoft.com/powershell/module/az.datamigration +Help Version: 0.1.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Az.DataMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Az.DataMigration.md +--- + +# Az.DataMigration Module +## Description +{{Azure DataMigration Service Module}} + +## Az.DataMigration Cmdlets +### [Get-AzDataMigrationAssessment](Get-AzDataMigrationAssessment.md) +Start assessment on SQL Server instance(s) + +### [Get-AzDataMigrationPerformanceDataCollection](Get-AzDataMigrationPerformanceDataCollection.md) +Collect performance data for given SQL Server instance(s) + +### [Get-AzDataMigrationProject](Get-AzDataMigrationProject.md) +Retrieves the properties of an Azure Database Migration Service (classic) project. + +### [Get-AzDataMigrationService](Get-AzDataMigrationService.md) +Retrieves the properties associated with an instance of the Azure Database Migration Service (classic). + +### [Get-AzDataMigrationSkuRecommendation](Get-AzDataMigrationSkuRecommendation.md) +Gives SKU recommendations for Azure SQL offerings + +### [Get-AzDataMigrationSqlService](Get-AzDataMigrationSqlService.md) +Retrieve the Database Migration Service. + +### [Get-AzDataMigrationSqlServiceAuthKey](Get-AzDataMigrationSqlServiceAuthKey.md) +Retrieve the List of Authentication Keys for Self Hosted Integration Runtime. + +### [Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric](Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric.md) +Retrieve the registered Integration Runtime nodes and their monitoring data for a given Database Migration Service + +### [Get-AzDataMigrationSqlServiceMigration](Get-AzDataMigrationSqlServiceMigration.md) +Retrieve the List of database migrations attached to the service. + +### [Get-AzDataMigrationTask](Get-AzDataMigrationTask.md) +Retrieves the PSProjectTask object associated with an Azure Database Migration Service (classic) migration task. + +### [Get-AzDataMigrationToSqlDb](Get-AzDataMigrationToSqlDb.md) +Retrieve the specified database migration for a given SQL Db. + +### [Get-AzDataMigrationToSqlManagedInstance](Get-AzDataMigrationToSqlManagedInstance.md) +Retrieve the specified database migration for a given SQL Managed Instance. + +### [Get-AzDataMigrationToSqlVM](Get-AzDataMigrationToSqlVM.md) +Retrieve the specified database migration for a given SQL VM. + +### [Invoke-AzDataMigrationCommand](Invoke-AzDataMigrationCommand.md) +Creates a new command to be executed on an existing DMS (classic) task. + +### [Invoke-AzDataMigrationCutoverToSqlManagedInstance](Invoke-AzDataMigrationCutoverToSqlManagedInstance.md) +Initiate cutover for in-progress online database migration to SQL Managed Instance. + +### [Invoke-AzDataMigrationCutoverToSqlVM](Invoke-AzDataMigrationCutoverToSqlVM.md) +Initiate cutover for in-progress online database migration to SQL VM. + +### [New-AzDataMigrationAzureActiveDirectoryApp](New-AzDataMigrationAzureActiveDirectoryApp.md) +Create a new instance DataMigration Azure ActiveDirectory Application details. + +### [New-AzDataMigrationConnectionInfo](New-AzDataMigrationConnectionInfo.md) +Creates a new Connection Info object specifying the server type and name for connection. + +### [New-AzDataMigrationDatabaseInfo](New-AzDataMigrationDatabaseInfo.md) +Creates the DatabaseInfo object for the Azure Database Migration Service, which specifies the database source for migration. + +### [New-AzDataMigrationFileShare](New-AzDataMigrationFileShare.md) +Creates the FileShare object for the Azure Database Migration Service (classic), which specifies the local network share to take the source database backups to. + +### [New-AzDataMigrationLoginsMigration](New-AzDataMigrationLoginsMigration.md) +Migrate logins from the source Sql Servers to the target Azure Sql Servers. + +### [New-AzDataMigrationMongoDbCollectionSetting](New-AzDataMigrationMongoDbCollectionSetting.md) +Creates collection setting for migration according for the mongoDb migration + +### [New-AzDataMigrationMongoDbDatabaseSetting](New-AzDataMigrationMongoDbDatabaseSetting.md) +Creates database setting for migration for the mongoDb migration + +### [New-AzDataMigrationProject](New-AzDataMigrationProject.md) +Creates a new Azure Database Migration Service (classic) project. + +### [New-AzDataMigrationSelectedDBObject](New-AzDataMigrationSelectedDBObject.md) +Creates a database input object that contains information about source and target databases for migration. + +### [New-AzDataMigrationService](New-AzDataMigrationService.md) +Creates a new instance of the Azure Database Migration Service (classic). + +### [New-AzDataMigrationSqlServerSchema](New-AzDataMigrationSqlServerSchema.md) +Migrate Sql Server Schema from the source Sql Servers to the target Azure Sql Servers. + +### [New-AzDataMigrationSqlService](New-AzDataMigrationSqlService.md) +Create or Update Database Migration Service. + +### [New-AzDataMigrationSqlServiceAuthKey](New-AzDataMigrationSqlServiceAuthKey.md) +Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime. + +### [New-AzDataMigrationSyncSelectedDBObject](New-AzDataMigrationSyncSelectedDBObject.md) +Creates a database info object specific to the sync scenario to be used for a migration task. + +### [New-AzDataMigrationTask](New-AzDataMigrationTask.md) +Creates and starts a data migration task in the Azure Database Migration Service (classic). + +### [New-AzDataMigrationTdeCertificateMigration](New-AzDataMigrationTdeCertificateMigration.md) +Migrate TDE certificate(s) from source SQL Server to the target Azure SQL Server. + +### [New-AzDataMigrationToSqlDb](New-AzDataMigrationToSqlDb.md) +Create a new database migration to a given SQL Db. + +### [New-AzDataMigrationToSqlManagedInstance](New-AzDataMigrationToSqlManagedInstance.md) +Create a new database migration to a given SQL Managed Instance. + +### [New-AzDataMigrationToSqlVM](New-AzDataMigrationToSqlVM.md) +Create a new database migration to a given SQL VM. + +### [Register-AzDataMigrationIntegrationRuntime](Register-AzDataMigrationIntegrationRuntime.md) +Registers Sql Migration Service on Integration Runtime + +### [Remove-AzDataMigrationProject](Remove-AzDataMigrationProject.md) +Removes an Azure Database Migration Service (classic) project from Azure. + +### [Remove-AzDataMigrationService](Remove-AzDataMigrationService.md) +Removes an instance of the Azure Database Migration Service (classic) from Azure. + +### [Remove-AzDataMigrationSqlService](Remove-AzDataMigrationSqlService.md) +Delete Database Migration Service. + +### [Remove-AzDataMigrationSqlServiceNode](Remove-AzDataMigrationSqlServiceNode.md) +Delete the integration runtime node. + +### [Remove-AzDataMigrationTask](Remove-AzDataMigrationTask.md) +Removes an Azure Database Migration Service (classic) task from Azure. + +### [Remove-AzDataMigrationToSqlDb](Remove-AzDataMigrationToSqlDb.md) +Remove the specified database migration for a given SQL Db. + +### [Start-AzDataMigrationService](Start-AzDataMigrationService.md) +Starts an instance of the Azure Database Migration Service (classic) in a stopped state. + +### [Stop-AzDataMigrationService](Stop-AzDataMigrationService.md) +Stops an instance of the Azure Database Migration Service (classic) that is in a running state. + +### [Stop-AzDataMigrationTask](Stop-AzDataMigrationTask.md) +Stops an Azure Database Migration Service (classic) task that is in a running state. + +### [Stop-AzDataMigrationToSqlDb](Stop-AzDataMigrationToSqlDb.md) +Stop in-progress database migration to SQL Db. + +### [Stop-AzDataMigrationToSqlManagedInstance](Stop-AzDataMigrationToSqlManagedInstance.md) +Stop in-progress database migration to SQL Managed Instance. + +### [Stop-AzDataMigrationToSqlVM](Stop-AzDataMigrationToSqlVM.md) +Stop in-progress database migration to SQL VM. + +### [Update-AzDataMigrationSqlService](Update-AzDataMigrationSqlService.md) +Update Database Migration Service. + diff --git a/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationAssessment.md b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationAssessment.md new file mode 100644 index 0000000000..b4225418b6 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationAssessment.md @@ -0,0 +1,154 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/get-azdatamigrationassessment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationAssessment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationAssessment.md +--- + +# Get-AzDataMigrationAssessment + +## SYNOPSIS +Start assessment on SQL Server instance(s) + +## SYNTAX + +### CommandLine (Default) +``` +Get-AzDataMigrationAssessment -ConnectionString <String[]> [-OutputFolder <String>] [-Overwrite] [-PassThru] + [<CommonParameters>] +``` + +### ConfigFile +``` +Get-AzDataMigrationAssessment -ConfigFilePath <String> [-PassThru] [<CommonParameters>] +``` + +## DESCRIPTION +Start assessment on SQL Server instance(s) + +## EXAMPLES + +### Example 1: Run SQL Assessment on given SQL Server using connection string +```powershell +Get-AzDataMigrationAssessment -ConnectionString "Data Source=LabServer.database.net;Initial Catalog=master;Integrated Security=False;User Id=User;Password=password" -OutputFolder "C:\AssessmentOutput" -Overwrite +``` + +```output +Starting SQL assessment... +Progress: 100%; Issues Found: 100; Objects Assessed: 500/500; Status: Completed; Total time: 00:01:50.000. + +Finishing SQL assessment... +Assessment report saved to C:\Users\user\AppData\Local\Microsoft\SqlAssessment\SqlAssessmentReport.json. +Event and Error Logs Folder Path: C:\Users\user\AppData\Local\Microsoft\SqlAssessment\Logs +``` + +This command runs SQL Assessment on given SQL Server using the connection string. + +### Example 2: Run SQL Assessment on given SQL Server using assessment config file +```powershell +Get-AzDataMigrationAssessment -ConfigFilePath "C:\Users\user\document\config.json" +``` + +```output +Starting SQL assessment... +Progress: 100%; Issues Found: 100; Objects Assessed: 550/550; Status: Completed; Total time: 00:01:50.000. + +Finishing SQL assessment... +Assessment report saved to C:\Users\user\AppData\Local\Microsoft\SqlAssessment\SqlAssessmentReport.json. +Event and Error Logs Folder Path: C:\Users\user\AppData\Local\Microsoft\SqlAssessment\Logs +``` + +This command runs SQL Assessment on given SQL Server using assessment config file. + +## PARAMETERS + +### -ConfigFilePath +Path of the ConfigFile + +```yaml +Type: System.String +Parameter Sets: ConfigFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionString +Sql Server Connection Strings + +```yaml +Type: System.String[] +Parameter Sets: CommandLine +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFolder +Output folder to store assessment report + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overwrite +Enable this parameter to overwrite the existing assessment report + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationPerformanceDataCollection.md b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationPerformanceDataCollection.md new file mode 100644 index 0000000000..c950c8e3cf --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationPerformanceDataCollection.md @@ -0,0 +1,263 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/get-azdatamigrationperformancedatacollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationPerformanceDataCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationPerformanceDataCollection.md +--- + +# Get-AzDataMigrationPerformanceDataCollection + +## SYNOPSIS +Collect performance data for given SQL Server instance(s) + +## SYNTAX + +### CommandLine (Default) +``` +Get-AzDataMigrationPerformanceDataCollection -SqlConnectionStrings <String[]> [-OutputFolder <String>] + [-PerfQueryInterval <String>] [-StaticQueryInterval <String>] [-NumberOfIterations <String>] [-Time <Int64>] + [-PassThru] [<CommonParameters>] +``` + +### ConfigFile +``` +Get-AzDataMigrationPerformanceDataCollection [-Time <Int64>] -ConfigFilePath <String> [-PassThru] + [<CommonParameters>] +``` + +## DESCRIPTION +Collect performance data for given SQL Server instance(s) + +## EXAMPLES + +### Example 1: Run Performance Data Collection on given SQL Server using connection string +```powershell +Get-AzDataMigrationPerformanceDataCollection -SqlConnectionStrings "Data Source=AALAB03-2K8.REDMOND.CORP.MICROSOFT.COM;Initial Catalog=master;Integrated Security=False;User Id=dummyUserId;Password=dummyPassword" -NumberOfIterations 2 +``` + +```output +Connecting to the SQL server(s)... +Starting data collection... +Press the Enter key to stop the data collection at any time... + +Security Warning: The negotiated TLS 1.0 is an insecure protocol and is supported for backward compatibility only. The recommended protocol version is TLS 1.2 and later. +Security Warning: The negotiated TLS 1.0 is an insecure protocol and is supported for backward compatibility only. The recommended protocol version is TLS 1.2 and later. +Security Warning: The negotiated TLS 1.0 is an insecure protocol and is supported for backward compatibility only. The recommended protocol version is TLS 1.2 and later. +UTC 2022-02-03 07:04:50, Server AALAB03-2K8: + Performance data query iteration: 1 of 2, collected 349 data points. +UTC 2022-02-03 07:04:52, Server AALAB03-2K8: + Collected static configuration data, and saved to C:\Users\vmanhas\AppData\Local\Microsoft\SqlAssessment. +Security Warning: The negotiated TLS 1.0 is an insecure protocol and is supported for backward compatibility only. The recommended protocol version is TLS 1.2 and later. +UTC 2022-02-03 07:05:44, Server AALAB03-2K8: + Performance data query iteration: 2 of 2, collected 347 data points. +UTC 2022-02-03 07:07:13, Server AALAB03-2K8: + Aggregated 696 raw data points to 263 performance counters, and saved to C:\Users\vmanhas\AppData\Local\Microsoft\SqlAssessment. +UTC 2022-02-03 07:07:16, Server AALAB03-2K8: + Performance data query iteration: 1 of 2, collected 349 data points. + +Event and Error Logs Folder Path: C:\Users\vmanhas\AppData\Local\Microsoft\SqlAssessment\Logs +``` + +This command runs Performance Data Collection on given SQL Server using the connection string. + +### Example 2: Run Performance Data Collection on given SQL Server using assessment config file +```powershell +Get-AzDataMigrationPerformanceDataCollection -ConfigFilePath "C:\Users\user\document\config.json" +``` + +```output +Connecting to the SQL server(s)... +Starting data collection... +Press the Enter key to stop the data collection at any time... + +Security Warning: The negotiated TLS 1.0 is an insecure protocol and is supported for backward compatibility only. The recommended protocol version is TLS 1.2 and later. +Security Warning: The negotiated TLS 1.0 is an insecure protocol and is supported for backward compatibility only. The recommended protocol version is TLS 1.2 and later. +Security Warning: The negotiated TLS 1.0 is an insecure protocol and is supported for backward compatibility only. The recommended protocol version is TLS 1.2 and later. +UTC 2022-02-03 07:04:50, Server AALAB03-2K8: + Performance data query iteration: 1 of 2, collected 349 data points. +UTC 2022-02-03 07:04:52, Server AALAB03-2K8: + Collected static configuration data, and saved to C:\Users\vmanhas\AppData\Local\Microsoft\SqlAssessment. +Security Warning: The negotiated TLS 1.0 is an insecure protocol and is supported for backward compatibility only. The recommended protocol version is TLS 1.2 and later. +UTC 2022-02-03 07:05:44, Server AALAB03-2K8: + Performance data query iteration: 2 of 2, collected 347 data points. +UTC 2022-02-03 07:07:13, Server AALAB03-2K8: + Aggregated 696 raw data points to 263 performance counters, and saved to C:\Users\vmanhas\AppData\Local\Microsoft\SqlAssessment. +UTC 2022-02-03 07:07:16, Server AALAB03-2K8: + Performance data query iteration: 1 of 2, collected 349 data points. + +Event and Error Logs Folder Path: C:\Users\vmanhas\AppData\Local\Microsoft\SqlAssessment\Logs +``` + +This command runs Performance Data Collection on given SQL Server using the config file. + +### Example 3: Run Performance Data Collection on given SQL Server that stops after a specified time +```powershell +Get-AzDataMigrationPerformanceDataCollection -ConfigFilePath "C:\Users\user\document\config.json" -Time 120 +``` + +```output +Connecting to the SQL server(s)... +Starting data collection... +Press the Enter key to stop the data collection at any time... + +Security Warning: The negotiated TLS 1.0 is an insecure protocol and is supported for backward compatibility only. The recommended protocol version is TLS 1.2 and later. +Security Warning: The negotiated TLS 1.0 is an insecure protocol and is supported for backward compatibility only. The recommended protocol version is TLS 1.2 and later. +Security Warning: The negotiated TLS 1.0 is an insecure protocol and is supported for backward compatibility only. The recommended protocol version is TLS 1.2 and later. +UTC 2022-02-03 07:04:50, Server AALAB03-2K8: + Performance data query iteration: 1 of 2, collected 349 data points. +UTC 2022-02-03 07:04:52, Server AALAB03-2K8: + Collected static configuration data, and saved to C:\Users\vmanhas\AppData\Local\Microsoft\SqlAssessment. +Security Warning: The negotiated TLS 1.0 is an insecure protocol and is supported for backward compatibility only. The recommended protocol version is TLS 1.2 and later. +UTC 2022-02-03 07:05:44, Server AALAB03-2K8: + Performance data query iteration: 2 of 2, collected 347 data points. +UTC 2022-02-03 07:07:13, Server AALAB03-2K8: + Aggregated 696 raw data points to 263 performance counters, and saved to C:\Users\vmanhas\AppData\Local\Microsoft\SqlAssessment. +UTC 2022-02-03 07:07:16, Server AALAB03-2K8: + Performance data query iteration: 1 of 2, collected 349 data points. + +Event and Error Logs Folder Path: C:\Users\vmanhas\AppData\Local\Microsoft\SqlAssessment\Logs +``` + +This command runs Performance Data Collection on given SQL Server that stops after a specified time. + +## PARAMETERS + +### -ConfigFilePath +Path of the ConfigFile + +```yaml +Type: System.String +Parameter Sets: ConfigFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfIterations +Number of iterations of performance data collection to perform before persisting to file. +For example, with default values, performance data will be persisted every 30 seconds * 20 iterations = 10 minutes. +(Default: 20, Minimum: 2) + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFolder +Folder which data and result reports will be written to/read from. + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PerfQueryInterval +Interval at which to query performance data, in seconds. +(Default: 30) + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlConnectionStrings +Sql Server Connection Strings + +```yaml +Type: System.String[] +Parameter Sets: CommandLine +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticQueryInterval +Interval at which to query and persist static configuration data, in seconds. +(Default: 3600) + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Time +Duration of time in seconds for which you want to collect performance data + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationProject.md b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationProject.md new file mode 100644 index 0000000000..af32d50db9 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationProject.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/Get-AzDataMigrationProject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationProject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationProject.md +--- + +# Get-AzDataMigrationProject + +## SYNOPSIS +Retrieves the properties of an Azure Database Migration Service (classic) project. + +## SYNTAX + +### ComponentNameParameterSet (Default) +``` +Get-AzDataMigrationProject -ResourceGroupName <String> -ServiceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ComponentObjectParameterSet +``` +Get-AzDataMigrationProject [-InputObject] <PSDataMigrationService> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzDataMigrationProject [-ResourceId] <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDataMigrationProject cmdlet retrieves the properties of an Azure Database Migration project. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataMigrationProject -ServiceName testService -Name testProject -ResourceGroupName testResourceGroup +``` + +The above example retrieves Azure Database Migration project named TestProject in the resource group called testResourceGroup and under service called testService + +### Example 2 +```powershell +Get-AzDataMigrationProject -InputObject $myService +``` + +The above example retrieves the Azure Database Migration project based on PSProject object input parameter passed in. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSDataMigrationService Object. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService +Parameter Sets: ComponentObjectParameterSet +Aliases: DataMigrationService + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ProjectName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +DataMigrationService Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +Database Migration Service Name. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSProject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationService.md b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationService.md new file mode 100644 index 0000000000..851be0ebb0 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationService.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/Get-AzDataMigrationService +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationService.md +--- + +# Get-AzDataMigrationService + +## SYNOPSIS +Retrieves the properties associated with an instance of the Azure Database Migration Service (classic). + +## SYNTAX + +### ResourceGroupSet (Default) +``` +Get-AzDataMigrationService [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzDataMigrationService [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ServiceNameGroupSet +``` +Get-AzDataMigrationService [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDataMigrationService cmdlet retrieves the properties associated with an instance of the Azure Database Migration Service (classic) based on Service name and Azure Resource Group name as input parameters. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataMigrationService -ResourceGroupName testResourceGroup -Name testService +``` + +The above example retrieves the properties of the Azure Database Migration Service (classic) instance called testService. + +### Example 2 +```powershell +Get-AzDataMigrationService -ResourceGroupName testResourceGroup +``` + +The above example retrieves Azure Database Migration Services (classic) in the resource group called testResourceGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Azure Database Migration Service (classic). + +```yaml +Type: System.String +Parameter Sets: ServiceNameGroupSet +Aliases: ServiceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ServiceNameGroupSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +DataMigrationService Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSkuRecommendation.md b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSkuRecommendation.md new file mode 100644 index 0000000000..f4f6902c7d --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSkuRecommendation.md @@ -0,0 +1,344 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/get-azdatamigrationskurecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationSkuRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationSkuRecommendation.md +--- + +# Get-AzDataMigrationSkuRecommendation + +## SYNOPSIS +Gives SKU recommendations for Azure SQL offerings + +## SYNTAX + +### CommandLine (Default) +``` +Get-AzDataMigrationSkuRecommendation [-OutputFolder <String>] [-TargetPlatform <String>] + [-TargetSqlInstance <String>] [-TargetPercentile <String>] [-ScalingFactor <String>] [-StartTime <String>] + [-EndTime <String>] [-Overwrite] [-DisplayResult] [-ElasticStrategy] [-DatabaseAllowList <String>] + [-DatabaseDenyList <String>] [-PassThru] [<CommonParameters>] +``` + +### ConfigFile +``` +Get-AzDataMigrationSkuRecommendation -ConfigFilePath <String> [-PassThru] [<CommonParameters>] +``` + +## DESCRIPTION +Gives SKU recommendations for Azure SQL offerings + +## EXAMPLES + +### Example 1: Run SKU Recommendation on given SQL Server using connection string +```powershell +Get-AzDataMigrationSkuRecommendation -DisplayResult +``` + +```output +Starting SKU recommendation... + +Performing aggregation for instance AALAB03-2K8... +Aggregation complete. Calculating SKU recommendations... +Instance name: AALAB03-2K8 +SKU recommendation: Azure SQL Managed Instance: +Compute: Gen5 - GeneralPurpose - 4 cores +Storage: 64 GB +Recommendation reasons: + According to the performance data collected, we estimate that your SQL server instance has a requirement for 0.16 vCores of CPU. For greater flexibility, based on your scaling factor of 100.00%, we are making a recommendation based on 0.16 vCores. Based on all the other factors, including memory, storage, and IO, this is the smallest compute sizing that will satisfy all of your needs. + This SQL Server instance requires 0.44 GB of memory, which is within this SKU's limit of 20.40 GB. + This SQL Server instance requires 32.37 GB of storage for data files. We recommend provisioning 64 GB of storage, which is the closest valid amount that can be provisioned that meets your requirement. + This SQL Server instance requires 0.00 MB/second of combined read/write IO throughput. This is a relatively idle instance, so IO latency is not considered. + Assuming the database uses the Full Recovery Model, this SQL Server instance requires 1 IOPS for data and log files. + This is the most cost-efficient offering among all the performance eligible SKUs. + + +Finishing SKU recommendations... +Event and Error Logs Folder Path: C:\Users\vmanhas\AppData\Local\Microsoft\SqlAssessment\Logs +``` + +This command runs Run SKU Recommendation on given SQL Server using the connection string. + +### Example 2: Run Run SKU Recommendation on given SQL Server using assessment config file +```powershell +Get-AzDataMigrationSkuRecommendation -ConfigFilePath "C:\Users\user\document\config.json" +``` + +```output +Starting SKU recommendation... + +Performing aggregation for instance AALAB03-2K8... +Aggregation complete. Calculating SKU recommendations... +Instance name: AALAB03-2K8 +SKU recommendation: Azure SQL Managed Instance: +Compute: Gen5 - GeneralPurpose - 4 cores +Storage: 64 GB +Recommendation reasons: + According to the performance data collected, we estimate that your SQL server instance has a requirement for 0.16 vCores of CPU. For greater flexibility, based on your scaling factor of 100.00%, we are making a recommendation based on 0.16 vCores. Based on all the other factors, including memory, storage, and IO, this is the smallest compute sizing that will satisfy all of your needs. + This SQL Server instance requires 0.44 GB of memory, which is within this SKU's limit of 20.40 GB. + This SQL Server instance requires 32.37 GB of storage for data files. We recommend provisioning 64 GB of storage, which is the closest valid amount that can be provisioned that meets your requirement. + This SQL Server instance requires 0.00 MB/second of combined read/write IO throughput. This is a relatively idle instance, so IO latency is not considered. + Assuming the database uses the Full Recovery Model, this SQL Server instance requires 1 IOPS for data and log files. + This is the most cost-efficient offering among all the performance eligible SKUs. + + +Finishing SKU recommendations... +Event and Error Logs Folder Path: C:\Users\vmanhas\AppData\Local\Microsoft\SqlAssessment\Logs +``` + +This command runs Run SKU Recommendation on given SQL Server using the config file. + +## PARAMETERS + +### -ConfigFilePath +Path of the ConfigFile + +```yaml +Type: System.String +Parameter Sets: ConfigFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseAllowList +Optional. +Space separated list of names of databases to be allowed for SKU recommendation consideration while excluding all others. +Only set one of the following or neither: databaseAllowList, databaseDenyList. +How to pass - "Database1 Database2" (Default: null) + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseDenyList +Optional. +Space separated list of names of databases to not be considered for SKU recommendation. +Only set one of the following or neither: databaseAllowList, databaseDenyList. +How to pass - "Database1 Database2" (Default: null) + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayResult +Optional. +Whether or not to print the SKU recommendation results to the console. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticStrategy +Optional. +Whether or not to use the elastic strategy for SKU recommendations based on resource usage profiling. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +Optional. +UTC end time of performance data points to consider during aggregation, in YYYY-MM-DD HH:MM format. +Only used for baseline (non-elastic) strategy. +(Default: all data points collected will be considered) + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFolder +Folder which data and result reports will be written to/read from. +The value here must be the same as the one used in PerfDataCollection + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overwrite +Optional. +Whether or not to overwrite any existing SKU recommendation reports. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScalingFactor +Optional. +Scaling (comfort) factor used during SKU recommendation. +For example, if it is determined that there is a 4 vCore CPU requirement with a scaling factor of 150%, then the true CPU requirement will be 6 vCores. +(Default: 100) + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Optional. +UTC start time of performance data points to consider during aggregation, in YYYY-MM-DD HH:MM format. +Only used for baseline (non-elastic) strategy. +(Default: all data points collected will be considered) + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetPercentile +Optional. +Percentile of data points to be used during aggregation of the performance data. +Only used for baseline (non-elastic) strategy. +(Default: 95) + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetPlatform +Optional. +Target platform for SKU recommendation: either AzureSqlDatabase, AzureSqlManagedInstance, AzureSqlVirtualMachine, or Any. +If Any is selected, then SKU recommendations for all three target platforms will be evaluated, and the best fit will be returned. +(Default: Any) + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSqlInstance +Optional. +Name of the SQL instance that SKU recommendation will be targeting. +(Default: outputFolder will be scanned for files created by the PerfDataCollection action, and recommendations will be provided for every instance found) + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSqlService.md b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSqlService.md new file mode 100644 index 0000000000..fbae511e30 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSqlService.md @@ -0,0 +1,213 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/get-azdatamigrationsqlservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationSqlService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationSqlService.md +--- + +# Get-AzDataMigrationSqlService + +## SYNOPSIS +Retrieve the Database Migration Service. + +## SYNTAX + +### List1 (Default) +``` +Get-AzDataMigrationSqlService [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-PassThru] + [<CommonParameters>] +``` + +### Get +``` +Get-AzDataMigrationSqlService -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### List +``` +Get-AzDataMigrationSqlService -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDataMigrationSqlService -InputObject <IDataMigrationIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve the Database Migration Service. + +## EXAMPLES + +### Example 1: Get the details of a given Sql Migration Service +```powershell +Get-AzDataMigrationSqlService -ResourceGroupName "MyResourceGroup" -SqlMigrationServiceName "MySqlMigrationService" +``` + +```output +Location Name Type ProvisioningState IntegrationRuntimeState +-------- ---- ---- ----------------- ----------------------- +eastus2 MySqlMigrationService Microsoft.DataMigration/sqlMigrationServices Succeeded Online +``` + +This command gets the details of a given Sql Migration Service. + +### Example 2: Get all Sql Migration Services in a given Resource Group +```powershell +Get-AzDataMigrationSqlService -ResourceGroupName "MyResourceGroup" +``` + +```output +Location Name Type ProvisioningState IntegrationRuntimeState +-------- ---- ---- ----------------- ----------------------- +eastus MySqlMigrationService1 Microsoft.DataMigration/sqlMigrationServices Succeeded +eastus2 MySqlMigrationService Microsoft.DataMigration/sqlMigrationServices Succeeded +``` + +This command gets all Sql Migration Services in a given Resource Group. + +### Example 3: Get all Sql Migration Services in a given Subscription +```powershell +Get-AzDataMigrationSqlService +``` + +```output +Location Name Type ProvisioningState IntegrationRuntimeState +-------- ---- ---- ----------------- ----------------------- +eastus MySqlMigrationService1 Microsoft.DataMigration/sqlMigrationServices Succeeded +eastus2 MySqlMigrationService Microsoft.DataMigration/sqlMigrationServices Succeeded +uksouth MySqlMigrationService-UK Microsoft.DataMigration/sqlMigrationServices Succeeded +``` + +This command gets all Sql Migration Services in a given Subscription. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SQL Migration Service. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SqlMigrationServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: List1, Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.ISqlMigrationService + +## 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 <IDataMigrationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ManagedInstanceName <String>]`: + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlDbInstanceName <String>]`: + - `[SqlMigrationServiceName <String>]`: Name of the SQL Migration Service. + - `[SqlVirtualMachineName <String>]`: + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + - `[TargetDbName <String>]`: The name of the target database. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSqlServiceAuthKey.md b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSqlServiceAuthKey.md new file mode 100644 index 0000000000..e61d280abb --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSqlServiceAuthKey.md @@ -0,0 +1,164 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/get-azdatamigrationsqlserviceauthkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationSqlServiceAuthKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationSqlServiceAuthKey.md +--- + +# Get-AzDataMigrationSqlServiceAuthKey + +## SYNOPSIS +Retrieve the List of Authentication Keys for Self Hosted Integration Runtime. + +## SYNTAX + +``` +Get-AzDataMigrationSqlServiceAuthKey -ResourceGroupName <String> -SqlMigrationServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve the List of Authentication Keys for Self Hosted Integration Runtime. + +## EXAMPLES + +### Example 1: Get the AuthKeys for a given Sql Migration Service +```powershell +Get-AzDataMigrationSqlServiceAuthKey -ResourceGroupName "MyResourceGroup" -SqlMigrationServiceName "MySqlMigrationService" +``` + +```output +AuthKey1 AuthKey2 +-------- -------- +IR@abcd1-efgh2-jklmn3-opqr4@mysqlms@eastus@stuv5/wxyz6= IR@abcd6-efgh5-jklmn4-opqr3@mysqlms@eastus@stuv2/wxyz1= +``` + +This command gets the AuthKeys for a given Sql Migration Service. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlMigrationServiceName +Name of the SQL Migration Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.IAuthenticationKeys + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric.md b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric.md new file mode 100644 index 0000000000..07cac681aa --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric.md @@ -0,0 +1,179 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/get-azdatamigrationsqlserviceintegrationruntimemetric +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric.md +--- + +# Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric + +## SYNOPSIS +Retrieve the registered Integration Runtime nodes and their monitoring data for a given Database Migration Service + +## SYNTAX + +``` +Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric -ResourceGroupName <String> + -SqlMigrationServiceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve the registered Integration Runtime nodes and their monitoring data for a given Database Migration Service + +## EXAMPLES + +### Example 1: Get the registered Integration Runtime nodes and their monitoring data for a given Sql Migration Service +```powershell +Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric -ResourceGroupName "MyResourceGroup" -SqlMigrationServiceName "MySqlMigrationService" | Select-Object * +``` + +```output +Name Node +---- ---- +default-ir {WIN-AKLAB} +``` + +This command gets the registered Integration Runtime nodes and their monitoring data for a given Sql Migration Service. + +### Example 2: Print the monitoring data for each Integration Runtime node +```powershell +$item = Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric -ResourceGroupName "MyResourceGroup" -SqlMigrationServiceName "MySqlMigrationService" +$item.Node[0] +``` + +```output +AvailableMemoryInMb ConcurrentJobsLimit ConcurrentJobsRunning CpuUtilization MaxConcurrentJob NodeName ReceivedByte SentByte +------------------- ------------------- --------------------- -------------- ---------------- -------- ------------ -------- +200138 20 0 8 WIN-AKLAB 9.33309006690979 5.433871746063232 +``` + +First command gets the node monitoring data of a Sql Migration Service. +Second command is then used to print the monitoring data for each node. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlMigrationServiceName +Name of the SQL Migration Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.IIntegrationRuntimeMonitoringData + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSqlServiceMigration.md b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSqlServiceMigration.md new file mode 100644 index 0000000000..7ebfd9c37c --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationSqlServiceMigration.md @@ -0,0 +1,134 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/get-azdatamigrationsqlservicemigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationSqlServiceMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationSqlServiceMigration.md +--- + +# Get-AzDataMigrationSqlServiceMigration + +## SYNOPSIS +Retrieve the List of database migrations attached to the service. + +## SYNTAX + +``` +Get-AzDataMigrationSqlServiceMigration -ResourceGroupName <String> -SqlMigrationServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve the List of database migrations attached to the service. + +## EXAMPLES + +### Example 1: Get the list of database migrations attached to a given Sql Migration Service +```powershell +Get-AzDataMigrationSqlServiceMigration -ResourceGroupName "MyResourceGroup" -SqlMigrationServiceName "MySqlMigrationService" +``` + +```output +Name Type Kind ProvisioningState MigrationStatus +---- ---- ---- ----------------- --------------- +MyDatabase Microsoft.DataMigration/databaseMigrations SqlMi Succeeded InProgress +MyDatabaseSqlMi Microsoft.DataMigration/databaseMigrations SqlMi Succeeded Succeeded +MyDatabaseSqlVM Microsoft.DataMigration/databaseMigrations SqlVm Succeeded Succeeded +``` + +This command gets the list of database migrations attached to a given Sql Migration service. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlMigrationServiceName +Name of the SQL Migration Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.IDatabaseMigration + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationTask.md b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationTask.md new file mode 100644 index 0000000000..68ac0df44c --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationTask.md @@ -0,0 +1,307 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/Get-AzDataMigrationTask +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationTask.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationTask.md +--- + +# Get-AzDataMigrationTask + +## SYNOPSIS +Retrieves the PSProjectTask object associated with an Azure Database Migration Service (classic) migration task. + +## SYNTAX + +### ListByComponent (Default) +``` +Get-AzDataMigrationTask -ResourceGroupName <String> -ServiceName <String> -ProjectName <String> + [-TaskType <TaskTypeEnum>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListByInputObject +``` +Get-AzDataMigrationTask [-InputObject] <PSProject> [-TaskType <TaskTypeEnum>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObject +``` +Get-AzDataMigrationTask [-InputObject] <PSProject> -Name <String> [-Expand] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObjectResultType +``` +Get-AzDataMigrationTask [-InputObject] <PSProject> -Name <String> [-Expand] -ResultType <ResultTypeEnum> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListByResourceId +``` +Get-AzDataMigrationTask [-ResourceId] <String> [-TaskType <TaskTypeEnum>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceId +``` +Get-AzDataMigrationTask [-ResourceId] <String> -Name <String> [-Expand] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdResultType +``` +Get-AzDataMigrationTask [-ResourceId] <String> -Name <String> [-Expand] -ResultType <ResultTypeEnum> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByComponent +``` +Get-AzDataMigrationTask -ResourceGroupName <String> -ServiceName <String> -ProjectName <String> + [-Name <String>] [-Expand] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByComponentResultType +``` +Get-AzDataMigrationTask -ResourceGroupName <String> -ServiceName <String> -ProjectName <String> -Name <String> + [-Expand] -ResultType <ResultTypeEnum> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDataMigrationTask cmdlet retrieves the properties associated with an Azure Database Migration Service (classic) migration task. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataMigrationTask -TaskName myTestTask -ServiceName myTestService -ProjectName MyTestProject -ResourceGroupName MyResourceGroup -Expand +``` + +The above example illustrates the use of Get-AzDataMigrationTask cmdlet to retrieve the properties associated with an Azure Database Migration Service (classic) migration task based on task name passed in as input parameter + +### Example 2 +```powershell +Get-AzDataMigrationTask -Project $myProject +``` + +The above example illustrates the use of Get-AzDataMigrationTask cmdlet to retrieve all of the migration tasks associated with PSProject object passed in as input parameter + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Expand output + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetByInputObject, GetByResourceId, GetByComponent +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetByInputObjectResultType, GetByResourceIdResultType, GetByComponentResultType +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSProject Object. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.PSProject +Parameter Sets: ListByInputObject +Aliases: Project + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.PSProject +Parameter Sets: GetByInputObject, GetByInputObjectResultType +Aliases: Project + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the task. + +```yaml +Type: System.String +Parameter Sets: GetByInputObject, GetByInputObjectResultType, GetByResourceId, GetByResourceIdResultType, GetByComponentResultType +Aliases: TaskName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByComponent +Aliases: TaskName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the project. + +```yaml +Type: System.String +Parameter Sets: ListByComponent, GetByComponent, GetByComponentResultType +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ListByComponent, GetByComponent, GetByComponentResultType +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Project Resource Id. + +```yaml +Type: System.String +Parameter Sets: ListByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByResourceId, GetByResourceIdResultType +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResultType +Expand output of given result type. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.ResultTypeEnum +Parameter Sets: GetByInputObjectResultType, GetByResourceIdResultType, GetByComponentResultType +Aliases: +Accepted values: MigrationLevelOutput, DatabaseLevelOutput, TableLevelOutput, MigrationValidationOutput, MigrationValidationDatabaseLevelOutput, LoginLevelOutput, AgentJobLevelOutput, Command + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Database Migration Service Name. + +```yaml +Type: System.String +Parameter Sets: ListByComponent, GetByComponent, GetByComponentResultType +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TaskType +Filter by TaskType. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.DataMigration.Models.TaskTypeEnum] +Parameter Sets: ListByComponent, ListByInputObject, ListByResourceId +Aliases: +Accepted values: MigrateSqlServerSqlDb, ConnectToSourceSqlServer, ConnectToTargetSqlDb, GetUserTablesSql, ConnectToTargetSqlDbMi, MigrateSqlServerSqlDbMi, ValidateSqlServerSqlDbMi, MigrateSqlServerSqlDbSync, ConnectToSourceSqlServerSync, ConnectToTargetSqlSync, GetUserTablesSqlSync, ValidateSqlServerSqlDbSync, ConnectToSourceMongoDb, ConnectToTargetMongoDb, MigrateMongoDb, ValidateMongoDbMigration, ConnectToTargetSqlDbMiSync, ValidateSqlServerSqlDbMiSync, MigrateSqlServerSqlDbMiSync + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSProject + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSProjectTask + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationToSqlDb.md b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationToSqlDb.md new file mode 100644 index 0000000000..72b501df92 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationToSqlDb.md @@ -0,0 +1,232 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/get-azdatamigrationtosqldb +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationToSqlDb.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationToSqlDb.md +--- + +# Get-AzDataMigrationToSqlDb + +## SYNOPSIS +Retrieve the specified database migration for a given SQL Db. + +## SYNTAX + +### Get (Default) +``` +Get-AzDataMigrationToSqlDb -ResourceGroupName <String> -SqlDbInstanceName <String> [-SubscriptionId <String[]>] + -TargetDbName <String> [-Expand <String>] [-MigrationOperationId <String>] [-DefaultProfile <PSObject>] + [-PassThru] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDataMigrationToSqlDb -InputObject <IDataMigrationIdentity> [-Expand <String>] + [-MigrationOperationId <String>] [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve the specified database migration for a given SQL Db. + +## EXAMPLES + +### Example 1: Get the details of a given Database Migration to a SQL DB +```powershell +Get-AzDataMigrationToSqlDb -ResourceGroupName "myRG" -SqlDbInstanceName "mySqlDb" -TargetDbName "mydb1" +``` + +```output +Name Kind ProvisioningState MigrationStatus +---- ---- ----------------- --------------- +mydb1 SqlDb Succeeded InProgress +``` + +Get the details of a given Database Migration to a SQL DB + +### Example 2: Get the expanded details of a given Database Migration to a SQL DB +```powershell +$dbMigration = Get-AzDataMigrationToSqlDb -ResourceGroupName "myRG" -SqlDbInstanceName "mySqlDb" -TargetDbName "mydb1" -Expand MigrationStatusDetails +$dbMigration.MigrationStatusDetailMigrationState +``` + +```output +MonitorMigration +``` + +Get the expanded details of a given Database Migration to a SQL DB + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Complete migration details be included in the response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MigrationOperationId +Optional migration operation ID. +If this is provided, then details of migration operation for that ID are retrieved. +If not provided (default), then details related to most recent or current operation are retrieved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlDbInstanceName +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.IDatabaseMigrationSqlDb + +## 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 <IDataMigrationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ManagedInstanceName <String>]`: + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlDbInstanceName <String>]`: + - `[SqlMigrationServiceName <String>]`: Name of the SQL Migration Service. + - `[SqlVirtualMachineName <String>]`: + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + - `[TargetDbName <String>]`: The name of the target database. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationToSqlManagedInstance.md b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationToSqlManagedInstance.md new file mode 100644 index 0000000000..6d8fec939c --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationToSqlManagedInstance.md @@ -0,0 +1,234 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/get-azdatamigrationtosqlmanagedinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationToSqlManagedInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationToSqlManagedInstance.md +--- + +# Get-AzDataMigrationToSqlManagedInstance + +## SYNOPSIS +Retrieve the specified database migration for a given SQL Managed Instance. + +## SYNTAX + +### Get (Default) +``` +Get-AzDataMigrationToSqlManagedInstance -ManagedInstanceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] -TargetDbName <String> [-Expand <String>] [-MigrationOperationId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDataMigrationToSqlManagedInstance -InputObject <IDataMigrationIdentity> [-Expand <String>] + [-MigrationOperationId <String>] [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve the specified database migration for a given SQL Managed Instance. + +## EXAMPLES + +### Example 1: Get the details of a given Database Migration to a SQL Managed Instance +```powershell +Get-AzDataMigrationToSqlManagedInstance -ResourceGroupName "MyResourceGroup" -ManagedInstanceName "MyManagedInstance" -TargetDbName "MyDatabase" +``` + +```output +Name Type Kind ProvisioningState MigrationStatus +---- ---- ---- ----------------- --------------- +MyDatabase Microsoft.DataMigration/databaseMigrations SqlMi Succeeded Succeeded +``` + +This command gets the details of a given Database Migration to a SQL Managed Instance. + +### Example 2: Get the expanded details of a given Database Migration to a SQL Managed Instance +```powershell +$miMigration = Get-AzDataMigrationToSqlManagedInstance -ResourceGroupName "MyResourceGroup" -ManagedInstanceName "MyManagedInstance" -TargetDbName "MyDatabase" -Expand MigrationStatusDetails +$miMigration.MigrationStatusDetail +``` + +```output +BlobContainerName CompleteRestoreErrorMessage CurrentRestoringFilename FileUploadBlockingError +----------------- --------------------------- ------------------------ ----------------------- +2673894b-451c-41cv-ae2b-58a8eefe3546 AdventureWorks.bak +``` + +This command gets the expanded details of a given Database Migration to a SQL Managed Instance. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Complete migration details be included in the response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagedInstanceName +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationOperationId +Optional migration operation ID. +If this is provided, then details of migration operation for that ID are retrieved. +If not provided (default), then details related to most recent or current operation are retrieved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.IDatabaseMigrationSqlMi + +## 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 <IDataMigrationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ManagedInstanceName <String>]`: + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlDbInstanceName <String>]`: + - `[SqlMigrationServiceName <String>]`: Name of the SQL Migration Service. + - `[SqlVirtualMachineName <String>]`: + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + - `[TargetDbName <String>]`: The name of the target database. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationToSqlVM.md b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationToSqlVM.md new file mode 100644 index 0000000000..3359b6faf3 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Get-AzDataMigrationToSqlVM.md @@ -0,0 +1,234 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/get-azdatamigrationtosqlvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationToSqlVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Get-AzDataMigrationToSqlVM.md +--- + +# Get-AzDataMigrationToSqlVM + +## SYNOPSIS +Retrieve the specified database migration for a given SQL VM. + +## SYNTAX + +### Get (Default) +``` +Get-AzDataMigrationToSqlVM -ResourceGroupName <String> -SqlVirtualMachineName <String> + [-SubscriptionId <String[]>] -TargetDbName <String> [-Expand <String>] [-MigrationOperationId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDataMigrationToSqlVM -InputObject <IDataMigrationIdentity> [-Expand <String>] + [-MigrationOperationId <String>] [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve the specified database migration for a given SQL VM. + +## EXAMPLES + +### Example 1: Get the details of a given Database Migration to a SQL Virtual Machine +```powershell +Get-AzDataMigrationToSqlVM -ResourceGroupName "MyResourceGroup" -SqlVirtualMachineName "MySqlVM" -TargetDbName "MyDatabase" +``` + +```output +Name Type Kind ProvisioningState MigrationStatus +---- ---- ---- ----------------- --------------- +MyDatabase Microsoft.DataMigration/databaseMigrations SqlVm Succeeded Succeeded +``` + +This command gets the details of a given Database Migration to a SQL Virtual Machine. + +### Example 2: Get the expanded details of a given Database Migration to a SQL Virtual Machine +```powershell +$vmMigration = Get-AzDataMigrationToSqlVM -ResourceGroupName "MyResouceGroup" -SqlVirtualMachineName "MySqlVM" -TargetDbName "MyDatabase" -Expand MigrationStatusDetails +$vmMigration.MigrationStatusDetail +``` + +```output +BlobContainerName CompleteRestoreErrorMessage CurrentRestoringFilename FileUploadBlockingError +----------------- --------------------------- ------------------------ ----------------------- +2673894b-451c-41cv-ae2b-58a8eefe3546 AdventureWorks.bak +``` + +This command gets the expanded details of a given Database Migration to a SQL Virtual Machine. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Complete migration details be included in the response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MigrationOperationId +Optional migration operation ID. +If this is provided, then details of migration operation for that ID are retrieved. +If not provided (default), then details related to most recent or current operation are retrieved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVirtualMachineName +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.IDatabaseMigrationSqlVM + +## 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 <IDataMigrationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ManagedInstanceName <String>]`: + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlDbInstanceName <String>]`: + - `[SqlMigrationServiceName <String>]`: Name of the SQL Migration Service. + - `[SqlVirtualMachineName <String>]`: + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + - `[TargetDbName <String>]`: The name of the target database. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Invoke-AzDataMigrationCommand.md b/azps-10.1.0/Az.DataMigration/Invoke-AzDataMigrationCommand.md new file mode 100644 index 0000000000..83ee1e715b --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Invoke-AzDataMigrationCommand.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/Invoke-AzDataMigrationCommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Invoke-AzDataMigrationCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Invoke-AzDataMigrationCommand.md +--- + +# Invoke-AzDataMigrationCommand + +## SYNOPSIS +Creates a new command to be executed on an existing DMS (classic) task. + +## SYNTAX + +``` +Invoke-AzDataMigrationCommand -CommandType <CommandTypeEnum> -ResourceGroupName <String> -ServiceName <String> + -ProjectName <String> -TaskName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The Invoke-AzDataMigrationCommand cmdlet creates a new command task to be run on an existing migration task. + +## EXAMPLES + +### Example 1 +```powershell +$command = Invoke-AzDataMigrationCommand -CommandType CompleteSqlDBSync -ResourceGroupName $rg.ResourceGroupName -ServiceName $service.Name -ProjectName $projectName -TaskName $taskName +``` + +The above examples uses the Invoke-AzDataMigrationCommand cmdlet to create a command for an existing service, project, and task + +## PARAMETERS + +### -CommandType +Command Type. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.CommandTypeEnum +Parameter Sets: (All) +Aliases: +Accepted values: CompleteSqlDBSync, CancelMongoDB, RestartMongoDB, FinishMongoDB, CompleteSqlMiSync + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +Database Migration Service Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TaskName +The name of the task the command is run on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.DataMigration.Models.CommandProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Invoke-AzDataMigrationCutoverToSqlManagedInstance.md b/azps-10.1.0/Az.DataMigration/Invoke-AzDataMigrationCutoverToSqlManagedInstance.md new file mode 100644 index 0000000000..fdbfb029cb --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Invoke-AzDataMigrationCutoverToSqlManagedInstance.md @@ -0,0 +1,226 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/invoke-azdatamigrationcutovertosqlmanagedinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Invoke-AzDataMigrationCutoverToSqlManagedInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Invoke-AzDataMigrationCutoverToSqlManagedInstance.md +--- + +# Invoke-AzDataMigrationCutoverToSqlManagedInstance + +## SYNOPSIS +Initiate cutover for in-progress online database migration to SQL Managed Instance. + +## SYNTAX + +``` +Invoke-AzDataMigrationCutoverToSqlManagedInstance -ManagedInstanceName <String> -ResourceGroupName <String> + -TargetDbName <String> [-SubscriptionId <String>] -MigrationOperationId <String> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Initiate cutover for in-progress online database migration to SQL Managed Instance. + +## EXAMPLES + +### Example 1: Initiate cutover for the specified in-progress online migration to SQL Managed Instance +```powershell +$miMigration = Get-AzDataMigrationToSqlManagedInstance -ResourceGroupName "MyResourceGroup" -ManagedInstanceName "MyManagedInstance" -TargetDbName "MyDatabase" +Invoke-AzDataMigrationCutoverToSqlManagedInstance -ResourceGroupName "MyResourceGroup" -ManagedInstanceName "MyManagedInstance" -TargetDbName "MyDatabase" -MigrationOperationId $miMigration.MigrationOperationId +Get-AzDataMigrationToSqlManagedInstance -InputObject $miMigration +``` + +```output +Name Type Kind ProvisioningState MigrationStatus +---- ---- ---- ----------------- --------------- +MyDatabase Microsoft.DataMigration/databaseMigrations SqlMi Completing Completing +``` + +This command initiates cutover for the specified in-progress online migration to SQL Managed Instance. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedInstanceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationOperationId +ID tracking migration operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Invoke-AzDataMigrationCutoverToSqlVM.md b/azps-10.1.0/Az.DataMigration/Invoke-AzDataMigrationCutoverToSqlVM.md new file mode 100644 index 0000000000..3dc8c1f522 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Invoke-AzDataMigrationCutoverToSqlVM.md @@ -0,0 +1,226 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/invoke-azdatamigrationcutovertosqlvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Invoke-AzDataMigrationCutoverToSqlVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Invoke-AzDataMigrationCutoverToSqlVM.md +--- + +# Invoke-AzDataMigrationCutoverToSqlVM + +## SYNOPSIS +Initiate cutover for in-progress online database migration to SQL VM. + +## SYNTAX + +``` +Invoke-AzDataMigrationCutoverToSqlVM -ResourceGroupName <String> -SqlVirtualMachineName <String> + -TargetDbName <String> [-SubscriptionId <String>] -MigrationOperationId <String> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Initiate cutover for in-progress online database migration to SQL VM. + +## EXAMPLES + +### Example 1: Initiate cutover for the specified in-progress online migration to SQL Virtual Machine +```powershell +$vmMigration = Get-AzDataMigrationToSqlVM -ResourceGroupName "MyResourceGroup" -SqlVirtualMachineName "MySqlVM" -TargetDbName "MyDatabase" +Invoke-AzDataMigrationCutoverToSqlVM -ResourceGroupName "MyResourceGroup" -SqlVirtualMachineName "MySqlVM" -TargetDbName "MyDatabase" -MigrationOperationId $vmMigration.MigrationOperationId +Get-AzDataMigrationToSqlVM -InputObject $vmMigration +``` + +```output +Name Type Kind ProvisioningState MigrationStatus +---- ---- ---- ----------------- --------------- +MyDatabase Microsoft.DataMigration/databaseMigrations SqlVm Completing Completing +``` + +This command initiates cutover for the specified in-progress online migration to SQL Virtual Machine. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationOperationId +ID tracking migration operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVirtualMachineName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationAzureActiveDirectoryApp.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationAzureActiveDirectoryApp.md new file mode 100644 index 0000000000..5055f25843 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationAzureActiveDirectoryApp.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/New-AzDataMigrationAzureActiveDirectoryApp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationAzureActiveDirectoryApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationAzureActiveDirectoryApp.md +--- + +# New-AzDataMigrationAzureActiveDirectoryApp + +## SYNOPSIS +Create a new instance DataMigration Azure ActiveDirectory Application details. + +## SYNTAX + +``` +New-AzDataMigrationAzureActiveDirectoryApp -ApplicationId <String> -AppKey <SecureString> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new instance DataMigration Azure ActiveDirectory Application details. + +## EXAMPLES + +### Example 1 +```powershell +$secpasswd = ConvertTo-SecureString "Your Secret Key Here" -AsPlainText -Force +New-AzDataMigrationAzureActiveDirectoryApp -ApplicationId "Your AppId/Service Principal ID here" -AppKey $secpasswd +``` + +```output +ApplicationId : "Your AppId/Service Principal Id here" +AppKey : System.Security.SecureString +TenantId : "Tenant Id" +``` + +## PARAMETERS + +### -AppKey +Azure Active Directory Key + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +Azure Active Directory Application Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSAzureActiveDirectoryApp + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationConnectionInfo.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationConnectionInfo.md new file mode 100644 index 0000000000..ad44c20e1e --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationConnectionInfo.md @@ -0,0 +1,80 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/New-AzDataMigrationConnectionInfo +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationConnectionInfo.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationConnectionInfo.md +--- + +# New-AzDataMigrationConnectionInfo + +## SYNOPSIS +Creates a new Connection Info object specifying the server type and name for connection. + +## SYNTAX + +``` +New-AzDataMigrationConnectionInfo -ServerType <ServerTypeEnum> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDataMigrationConnectionInfo cmdlet creates new a Connection Info object specifying the server type for connection. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataMigrationConnectionInfo -ServerType SQL +``` + +The preceding example creates a new Connection Info object providing SQL as ServerType parameter. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerType +Enum that describes server type to connect to. Currently supported values are SQL for SQL Server, Azure SQL Managed Instance, MongoDb, CosmosDb and Azure SQL Database. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.ServerTypeEnum +Parameter Sets: (All) +Aliases: +Accepted values: SQL, MongoDb, SQLMI + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.DataMigration.Models.ConnectionInfo + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationDatabaseInfo.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationDatabaseInfo.md new file mode 100644 index 0000000000..34eab9ebe2 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationDatabaseInfo.md @@ -0,0 +1,80 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/New-AzDataMigrationDatabaseInfo +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationDatabaseInfo.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationDatabaseInfo.md +--- + +# New-AzDataMigrationDatabaseInfo + +## SYNOPSIS +Creates the DatabaseInfo object for the Azure Database Migration Service, which specifies the database source for migration. + +## SYNTAX + +``` +New-AzDataMigrationDatabaseInfo -SourceDatabaseName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDataMigrationDatabaseInfo cmdlet creates the DatabaseInfo object that specifies the source database instance to be migrated. Database name is taken in as input parameter. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataMigrationDatabaseInfo -SourceDatabaseName 'AdventureWorks2016' +``` + +The preceding example creates a new DatabaseInfo object for the source database **AdventureWorks2016**. +This script assumes that you are already logged into your Azure account. You can confirm your login status by using the Get-AzSubscription cmdlet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDatabaseName +Source Database Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SourceDBName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.DataMigration.Models.DatabaseInfo + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationFileShare.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationFileShare.md new file mode 100644 index 0000000000..9862e2c19d --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationFileShare.md @@ -0,0 +1,98 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/New-AzDataMigrationFileShare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationFileShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationFileShare.md +--- + +# New-AzDataMigrationFileShare + +## SYNOPSIS +Creates the FileShare object for the Azure Database Migration Service (classic), which specifies the local network share to take the source database backups to. + +## SYNTAX + +``` +New-AzDataMigrationFileShare -Path <String> -Credential <PSCredential> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDataMigrationFileShare cmdlet creates the FileShare object that specifies the local network share that Azure Database Migration Service (classic) can take source database backups to. The service account running source SQL Server instance must have write privileges on this network share. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataMigrationFileShare -Path $fileSharePath -Credential $fileShareCred +``` + +```output +UserName Password Path +-------- -------- ---- +domain\user testadmin123 \\fileshare\folder1 +``` + +## PARAMETERS + +### -Credential +Credentials to access the file share. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +File share path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.DataMigration.Models.MigrateSqlServerSqlDbDatabaseInput + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationLoginsMigration.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationLoginsMigration.md new file mode 100644 index 0000000000..69f566ba34 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationLoginsMigration.md @@ -0,0 +1,243 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/new-azdatamigrationloginsmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationLoginsMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationLoginsMigration.md +--- + +# New-AzDataMigrationLoginsMigration + +## SYNOPSIS +Migrate logins from the source Sql Servers to the target Azure Sql Servers. + +## SYNTAX + +### ConfigFile (Default) +``` +New-AzDataMigrationLoginsMigration -ConfigFilePath <String> [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CommandLine +``` +New-AzDataMigrationLoginsMigration -SourceSqlConnectionString <String[]> -TargetSqlConnectionString <String> + [-CSVFilePath <String>] [-ListOfLogin <String[]>] [-OutputFolder <String>] [-AADDomainName <String>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Migrate logins from the source Sql Servers to the target Azure Sql Servers. + +## EXAMPLES + +### Example 1: Run Migrate logins from the source Sql Servers to the target Azure Sql Servers using Parameters +```powershell +New-AzDataMigrationLoginsMigration -SourceSqlConnectionString "data source=servername;user id=userid;password=;initial catalog=master;TrustServerCertificate=True" -TargetSqlConnectionString "data source=servername;user id=userid;password=;initial catalog=master;TrustServerCertificate=True" -CSVFilePath "C:\CSVFile" -ListOfLogin "loginname1" "loginname2" -OutputFolder "C:\OutputFolder" -AADDomainName "AADDomainName" +``` + +```output +Starting Logins migration... +Starting server roles migration... +Starting user-login mappings... +Starting server role mappings... +Restoring permissions for logins... +Restoring permissions for server roles... +Login migration process complete. +``` + +This command runs Run SKU Recommendation on given SQL Server using the connection string. + +### Example 2: Run Migrate logins from the source Sql Servers to the target Azure Sql Servers using config file +```powershell +New-AzDataMigrationLoginsMigration -ConfigFilePath "C:\Users\user\document\config.json" +``` + +```output +Starting Logins migration... +Starting server roles migration... +Starting user-login mappings... +Starting server role mappings... +Restoring permissions for logins... +Restoring permissions for server roles... +Login migration process complete. +``` + +This command runs Run Migrate logins from the source Sql Servers to the target Azure Sql Servers using config file. + +## PARAMETERS + +### -AADDomainName +Optional. +Required if Windows logins are included in the list of logins to be migrated. +(Default: empty string). + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigFilePath +Path of the ConfigFile + +```yaml +Type: System.String +Parameter Sets: ConfigFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CSVFilePath +Optional. +Location of CSV file of logins. +Use only one parameter between this and listOfLogin. + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListOfLogin +Optional. +List of logins in string format. +If large number of logins need to be migrated, use CSV file option. + +```yaml +Type: System.String[] +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFolder +Optional. +Default: %LocalAppData%/Microsoft/SqlLoginMigrations) Folder where logs will be written. + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionString +Required. +Connection string(s) for the source SQL instance(s), using the formal connection string format. + +```yaml +Type: System.String[] +Parameter Sets: CommandLine +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSqlConnectionString +Required. +Connection string(s) for the target SQL instance(s), using the formal connection string format. + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationMongoDbCollectionSetting.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationMongoDbCollectionSetting.md new file mode 100644 index 0000000000..29de6b0fc3 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationMongoDbCollectionSetting.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/New-AzDataMigrationMongoDbCollectionSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationMongoDbCollectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationMongoDbCollectionSetting.md +--- + +# New-AzDataMigrationMongoDbCollectionSetting + +## SYNOPSIS +Creates collection setting for migration according for the mongoDb migration + +## SYNTAX + +``` +New-AzDataMigrationMongoDbCollectionSetting [-TargetRequestUnit <Int32>] [-CanDelete] [-UniqueShard] + [-ShardKey <String>] [-DefaultProfile <IAzureContextContainer>] -Name <String> [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDataMigrationMongoDbCollectionSetting cmdlet creates the migration setting object that specifies the throughput and delete behavior. +The output the cmdlet is key value pair with name of the collection, and value of the setting. The output is used in assembling +the database level settings for migration. + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$x = New-AzDataMigrationMongoDbCollectionSetting -Name myCollection -TargetRequestUnit 1000 -CanDelete -ShardKey "_id:-1,age:1,name" +$x + +Name Setting +---- ------- +myCollection Microsoft.Azure.Management.DataMigration.Models.MongoDbCollectionSettings + +$x.Setting + +CanDelete ShardKey TargetRUs +--------- -------- --------- + True Microsoft.Azure.Management.DataMigration.Models.MongoDbShardKeySetting 1000 +``` + +## PARAMETERS + +### -CanDelete +Whether the target data is supposed to be deleted, if the switch is set, it will be cleaned up at migration + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: Clean + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the collection + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CollectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShardKey +The comma separated list of the shard keys. For mongoDb target, +you can specify shard key order of "ShardKeyName:Order", +where order is 1, -1 or empty for hashed, for example "_id,email:-1". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetRequestUnit +The dedicated collection request unit value. If not set, that collection uses shared database RU. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: RU + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UniqueShard +Whether to create a unique key for the shard key + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: Unique + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.MongoDbCollectionSetting> + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationMongoDbDatabaseSetting.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationMongoDbDatabaseSetting.md new file mode 100644 index 0000000000..a7769fc775 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationMongoDbDatabaseSetting.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/new-azdatamigrationmongodbdatabasesetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationMongoDbDatabaseSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationMongoDbDatabaseSetting.md +--- + +# New-AzDataMigrationMongoDbDatabaseSetting + +## SYNOPSIS +Creates database setting for migration for the mongoDb migration + +## SYNTAX + +``` +New-AzDataMigrationMongoDbDatabaseSetting -Name <String> [-TargetRequestUnit <Int32>] + [-CollectionSetting <MongoDbCollectionSetting[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDataMigrationMongoDbDatabaseSetting cmdlet creates the migration setting object that specifies the throughput and delete behavior. +The output is a key value pair with name of collection and value of the setting, which can be used in invoking the migration task. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataMigrationMongoDbDatabaseSetting -Name mycollection -RU 1000 -CollectionSetting @($coll1, $coll2) +``` + +```output +Name Setting +---- ------- +test Microsoft.Azure.Management.DataMigration.Models.MongoDbDatabaseSettings +``` + +## PARAMETERS + +### -CollectionSetting +The collection settings for the databases, refer to: New-AzureRmDmsMongoCollectionSetting + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.MongoDb.MongoDbCollectionSetting[] +Parameter Sets: (All) +Aliases: Coll + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the database + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DatabaseName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetRequestUnit +The dedicated database level request unit value. If not set, that collection uses shared database RU. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: RU + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.MongoDbDatabaseSetting + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationProject.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationProject.md new file mode 100644 index 0000000000..9f1e0bf1d9 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationProject.md @@ -0,0 +1,280 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/New-AzDataMigrationProject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationProject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationProject.md +--- + +# New-AzDataMigrationProject + +## SYNOPSIS +Creates a new Azure Database Migration Service (classic) project. + +## SYNTAX + +### ComponentNameParameterSet (Default) +``` +New-AzDataMigrationProject -ResourceGroupName <String> -ServiceName <String> -Location <String> -Name <String> + -SourceType <String> -TargetType <String> [-SourceConnection <ConnectionInfo>] + [-TargetConnection <ConnectionInfo>] [-DatabaseInfo <DatabaseInfo[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ComponentObjectParameterSet +``` +New-AzDataMigrationProject [-InputObject] <PSDataMigrationService> -Location <String> -Name <String> + -SourceType <String> -TargetType <String> [-SourceConnection <ConnectionInfo>] + [-TargetConnection <ConnectionInfo>] [-DatabaseInfo <DatabaseInfo[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +New-AzDataMigrationProject [-ResourceId] <String> -Location <String> -Name <String> -SourceType <String> + -TargetType <String> [-SourceConnection <ConnectionInfo>] [-TargetConnection <ConnectionInfo>] + [-DatabaseInfo <DatabaseInfo[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDataMigrationProject cmdlet creates a new Azure Database Migration Service (classic) project. This cmdlet takes in all necessary parameters, such as the name of the Azure Resource Group, the name of Azure Data Migration Service in which new project is to be created, the region in which the project is to be created, the unique name of the new project, the source and target connection objects, and the target type object, as input for the list of databases to migrate. Use the New-AzDataMigrationConnectionInfo cmdlet to create a new ConnectionInfo object for both the source and target connections. The list of Microsoft.Azure.Management.DataMigration.Models.DatabaseInfo is expected for selected databases; this object can be created by using New-AzDataMigrationDatabaseInfo cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataMigrationProject -ResourceGroupName MyResourceGroup -ServiceName TestService -ProjectName MyDMSProject -Location "central us" -SourceType SQL -TargetType SQLDB -SourceConnection $sourceConnInfo -TargetConnection $targetConnInfo -DatabaseInfo $dbList +``` + +The above example shows how to create new project named MyDMSProject located in Central US region under the Azure Database Migration Service (classic) instance named TestService. + +## PARAMETERS + +### -DatabaseInfo +Database Infos. + +```yaml +Type: Microsoft.Azure.Management.DataMigration.Models.DatabaseInfo[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSDataMigrationService Object. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService +Parameter Sets: ComponentObjectParameterSet +Aliases: DataMigrationService + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the Azure Database Migration Service (classic) instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ProjectName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +DataMigrationService Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Azure Database Migration Service (classic) instance. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceConnection +Source Connection Info. + +```yaml +Type: Microsoft.Azure.Management.DataMigration.Models.ConnectionInfo +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceType +Source platform type for project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetConnection +Target connection information. + +```yaml +Type: Microsoft.Azure.Management.DataMigration.Models.ConnectionInfo +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetType +Target platform type for project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSProject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSelectedDBObject.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSelectedDBObject.md new file mode 100644 index 0000000000..f9a895f1e8 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSelectedDBObject.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/New-AzDataMigrationSelectedDBObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationSelectedDBObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationSelectedDBObject.md +--- + +# New-AzDataMigrationSelectedDBObject + +## SYNOPSIS +Creates a database input object that contains information about source and target databases for migration. + +## SYNTAX + +### MigrateSqlServerSqlDb (Default) +``` +New-AzDataMigrationSelectedDBObject -SourceDatabaseName <String> -TargetDatabaseName <String> + [-MigrateSqlServerSqlDb] [-MakeSourceDbReadOnly] + [-TableMap <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### MigrateSqlServerSqlDbMi +``` +New-AzDataMigrationSelectedDBObject -SourceDatabaseName <String> -TargetDatabaseName <String> + [-MigrateSqlServerSqlDbMi] [-BackupFileShare <FileShare>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDataMigrationSelectedDB cmdlet creates a database info object that contains information about source and target databases, as well as the table mappings, for migration. This cmdlet can be used as a parameter with the New-AzDataMigrationTask cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataMigrationSelectedDBObject -MigrateSqlServerSqlDb -Name "HR" -TargetDatabaseName "HR_PSTEST" -TableMap $tableMap +``` + +```output +Name TargetDatabaseName MakeSourceDbReadOnly TableMap +---- ------------------ -------------------- -------- +HR HR_PSTEST False {[HR.COUNTRIES, HR.COUNTRIES]} +``` + +### Example 2 +```powershell +New-AzDataMigrationSelectedDBObject -MigrateSqlServerSqlDbMi -Name "HR" -TargetDatabaseName "HR_PSTEST" -BackupFileShare $backupFileShare +``` + +```output +Name RestoreDatabaseName BackupFileShare +---- ------------------- --------------- +HR HRTest Microsoft.Azure.Management.DataMigration.Models.FileShare +``` + +## PARAMETERS + +### -BackupFileShare +File share where the source server database files for this database should be backed up. +Use this setting to override file share information for each database. +Use fully qualified domain name for the server. + +```yaml +Type: Microsoft.Azure.Management.DataMigration.Models.FileShare +Parameter Sets: MigrateSqlServerSqlDbMi +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeSourceDbReadOnly +Set Database to readonly before migration + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: MigrateSqlServerSqlDb +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateSqlServerSqlDb +Set migration type to SQL Server to SQL DB Migration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: MigrateSqlServerSqlDb +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateSqlServerSqlDbMi +Set migration type to SQL Server to SQL DB MI Migration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: MigrateSqlServerSqlDbMi +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDatabaseName +The name of the source database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableMap +mapping of source to target tables + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: MigrateSqlServerSqlDb +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDatabaseName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.DataMigration.Models.FileShare + +## OUTPUTS + +### Microsoft.Azure.Management.DataMigration.Models.MigrateSqlServerSqlDbDatabaseInput + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationService.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationService.md new file mode 100644 index 0000000000..3100052403 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationService.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/New-AzDataMigrationService +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationService.md +--- + +# New-AzDataMigrationService + +## SYNOPSIS +Creates a new instance of the Azure Database Migration Service (classic). + +## SYNTAX + +``` +New-AzDataMigrationService -ResourceGroupName <String> -Name <String> -Location <String> -Sku <String> + -VirtualSubnetId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDataMigrationService cmdlet creates a new instance of the Azure Database Migration Service (classic). This cmdlet takes in name of existing Azure Resource Group, the unique name for the new instance of the Azure Database Migration Service to be created, the region in which the instance is provisioned, the name of the DMS Worker SKU, and the name of the Azure Virtual Subnet on which the service is to reside. There is no parameter for subscription name, because it is expected for the user to specify the default subscription of the Azure login session or execute Get-AzSubscription -SubscriptionName "MySubscription" | Select-AzSubscription to select another subscription. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataMigrationService -ResourceGroupName myResourceGroup -Name TestService -Location "Central US" -Sku Basic_2vCores -VirtualSubnetId $virtualSubNetId +``` + +The above example shows how to create a new instance of the Azure Database Migration Service (classic) named TestService in Central US region. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the Azure Database Migration Service (classic) instance to be created, which corresponds to an Azure region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure Database Migration Service (classic) Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The sku for the Azure Database Migration Service (classic) instance. Possible values currently are Standard_1vCores, Standard_2vCores, Standard_4vCores, Premium_4vCores. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualSubnetId +The name of the subnet under the specified virtual network to use for the Azure Database Migration Service (classic) instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSqlServerSchema.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSqlServerSchema.md new file mode 100644 index 0000000000..935f742b98 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSqlServerSchema.md @@ -0,0 +1,292 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/new-azdatamigrationsqlserverschema +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationSqlServerSchema.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationSqlServerSchema.md +--- + +# New-AzDataMigrationSqlServerSchema + +## SYNOPSIS +Migrate Sql Server Schema from the source Sql Servers to the target Azure Sql Servers. + +## SYNTAX + +### ConfigFile (Default) +``` +New-AzDataMigrationSqlServerSchema -ConfigFilePath <String> [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CommandLine +``` +New-AzDataMigrationSqlServerSchema -Action <String> -SourceConnectionString <String> + -TargetConnectionString <String> [-InputScriptFilePath <String>] [-OutputFolder <String>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Migrate Sql Server Schema from the source Sql Servers to the target Azure Sql Servers. + +## EXAMPLES + +### Example 1: Run Migrate database objects from the source SQL Server to the target Azure SQL Database using Parameters +```powershell +New-AzDataMigrationSqlServerSchema -Action "MigrateSchema" -SourceConnectionString "Server=;Initial Catalog=;User ID=;Password=" -TargetConnectionString "Server=;Initial Catalog=;User ID=;Password=" +``` + +```output +Starting schema migration... + +Total number of object collected: 35 +Total elapsed time: 00:00:08.8905823 +DDL triggers: 4 +Full text catalogs: 2 +Plan guides: 2 +Roles: 1 +Schemas: 5 +Stored procedures: 5 +Tables: 10 +User defined functions: 4 +Users: 2 + +The number of scripted objects: 55 +Progress: 100% +Total elapsed time: 00:00:39.9983180 + +The number of deployed script batches: 110/110 +Progress: 100% +Total elapsed time: 00:00:05.6789103 +``` + +This command runs Run SqlServerSchema Migrations on given SQL Server using the connection string. + +### Example 2: Run Generate TSQL schema script from the source SQL Server using Parameters +```powershell +New-AzDataMigrationSqlServerSchema -Action "GenerateScript" -SourceConnectionString "Server=;Initial Catalog=;User ID=;Password=" -TargetConnectionString "Server=;Initial Catalog=;User ID=;Password=" -OutputFolder "C:\OutputFolder" +``` + +```output +Starting schema script generation... + +Total number of object collected: 35 +Total elapsed time: 00:00:07.3789860 +DDL triggers: 4 +Full text catalogs: 2 +Plan guides: 2 +Roles: 1 +Schemas: 5 +Stored procedures: 5 +Tables: 10 +User defined functions: 4 +Users: 2 + +The number of scripted objects: 55 +Progress: 100% +Total elapsed time: 00:00:40.9745837 +``` + +This command runs Run Generate TSQL schema script on given SQL Server using the connection string. + +### Example 3: Run Deploy TSQL script to the target Azure SQL Database using Parameters +```powershell +New-AzDataMigrationSqlServerSchema -Action "DeploySchema" -SourceConnectionString "Server=;Initial Catalog=;User ID=;Password=" -TargetConnectionString "Server=;Initial Catalog=;User ID=;Password=" -InputScriptFilePath "C:\OutputFolder\script.sql" +``` + +```output +Starting schema deployment... + +The number of deployed script batches: 110/110 +Progress: 100% +Total elapsed time: 00:00:05.7519257 +``` + +This command runs Deploy TSQL script to the target Azure SQL Database on given SQL Server using the connection string. + +### Example 4: Run Migrate database objects from the source SQL Server to the target Azure SQL Database using ConfigFile +```powershell +New-AzDataMigrationSqlServerSchema -ConfigFilePath "C:\configfile.json" +``` + +```output +configfile.json example: +{ + "Action": "GenerateScript", + "sourceConnectionString": "Server=;Initial Catalog=;User ID=;Password=", + "targetConnectionString": "Server=;Initial Catalog=;User ID=;Password=", + "inputScriptFilePath": "C:\OutputFolder\script.sql", + "outputFolder": "C:\OutputFolder\script.sql" +} + +Starting schema deployment... + +The number of deployed script batches: 110/110 +Progress: 100% +Total elapsed time: 00:00:05.7519257 +``` + +This command runs Run SqlServerSchema Command from the source Sql Servers to the target Azure Sql Servers using config file. + +## PARAMETERS + +### -Action +Required. +Select one schema migration action. +The valid values are: MigrateSchema, GenerateScript, DeploySchema. +MigrateSchema is to migrate the database objects to Azure SQL Database target. +GenerateScript is to generate an editable TSQL schema script that can be used to run on the target to deploy the objects. +DeploySchema is to run the TSQL script generated from -GenerateScript action on the target to deploy the objects. + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigFilePath +Path of the ConfigFile + +```yaml +Type: System.String +Parameter Sets: ConfigFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputScriptFilePath +Optional. +Location of an editable TSQL schema script. +Use this parameter only with DeploySchema Action. + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFolder +Optional. +Default: %LocalAppData%/Microsoft/SqlSchemaMigrations) Folder where logs will be written and the generated TSQL schema script by GenerateScript Action. + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceConnectionString +Required. +Connection string for the source SQL instance, using the formal connection string format. + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetConnectionString +Required. +Connection string for the target SQL instance, using the formal connection string format. + +```yaml +Type: System.String +Parameter Sets: CommandLine +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSqlService.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSqlService.md new file mode 100644 index 0000000000..21bd4ef664 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSqlService.md @@ -0,0 +1,224 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/new-azdatamigrationsqlservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationSqlService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationSqlService.md +--- + +# New-AzDataMigrationSqlService + +## SYNOPSIS +Create or Update Database Migration Service. + +## SYNTAX + +``` +New-AzDataMigrationSqlService -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Location <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create or Update Database Migration Service. + +## EXAMPLES + +### Example 1: Create a Sql Migration Service in a given Resource Group +```powershell +New-AzDataMigrationSqlService -ResourceGroupName "MyResourceGroup" -SqlMigrationServiceName "MySqlMigrationService" -Location "eastus2" +``` + +```output +Location Name Type ProvisioningState IntegrationRuntimeState +-------- ---- ---- ----------------- ----------------------- +eastus2 MySqlMigrationService Microsoft.DataMigration/sqlMigrationServices Succeeded NeedRegistration +``` + +This command creates a Sql Migration Service in a given Resource Group. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the SQL Migration Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SqlMigrationServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Dictionary of \<string\> + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.ISqlMigrationService + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSqlServiceAuthKey.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSqlServiceAuthKey.md new file mode 100644 index 0000000000..ec3dda1b89 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSqlServiceAuthKey.md @@ -0,0 +1,210 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/new-azdatamigrationsqlserviceauthkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationSqlServiceAuthKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationSqlServiceAuthKey.md +--- + +# New-AzDataMigrationSqlServiceAuthKey + +## SYNOPSIS +Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime. + +## SYNTAX + +``` +New-AzDataMigrationSqlServiceAuthKey -ResourceGroupName <String> -SqlMigrationServiceName <String> + [-SubscriptionId <String>] [-AuthKey1 <String>] [-AuthKey2 <String>] [-KeyName <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime. + +## EXAMPLES + +### Example 1: Regenerate AuthKeys for a given Sql Migration Service +```powershell +New-AzDataMigrationSqlServiceAuthKey -ResourceGroupName "MyResourceGroup" -SqlMigrationServiceName "MySqlMigrationService" -KeyName AuthKey2 +``` + +```output +AuthKey1 AuthKey2 KeyName +-------- -------- ------- + IR@abcd7-efgh8-jklmn9-opqr10@mysqlms@eastus@stuv2/wxyz1= +``` + +This command regenerate the AuthKeys for a given Sql Migration Service. +Here we have regenerated AuthKey2. + +## PARAMETERS + +### -AuthKey1 +The first authentication key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthKey2 +The second authentication key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +The name of authentication key to generate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlMigrationServiceName +Name of the SQL Migration Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.IRegenAuthKeys + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSyncSelectedDBObject.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSyncSelectedDBObject.md new file mode 100644 index 0000000000..e62f6e8634 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationSyncSelectedDBObject.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/New-AzDataMigrationSyncSelectedDBObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationSyncSelectedDBObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationSyncSelectedDBObject.md +--- + +# New-AzDataMigrationSyncSelectedDBObject + +## SYNOPSIS +Creates a database info object specific to the sync scenario to be used for a migration task. + +## SYNTAX + +``` +New-AzDataMigrationSyncSelectedDBObject -TargetDatabaseName <String> -SchemaName <String> -TableMap <Hashtable> + [-MigrationSetting <Hashtable>] [-SourceSetting <Hashtable>] [-TargetSetting <Hashtable>] + -SourceDatabaseName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION + +The New-AzDataMigrationSyncSelectedDB cmdlet creates a database info object specific to the sync scenario which contains information about source and target databases. + +## EXAMPLES + +### Example 1 +```powershell +$tableMap = New-Object 'system.collections.hashtable' +$tableMap.Add("dbo.TestTable1", "dbo.TestTable1") +$tableMap.Add("dbo.TestTable2","dbo.TestTable2") + +$selectedDbs = New-AzDataMigrationSyncSelectedDBObject ` + -TargetDatabaseName DatabaseName ` + -SchemaName dbo ` + -TableMap $tableMap ` + -SourceDatabaseName DatabaseName +``` + +This example creates a database metadata object describing the migrating settings for $DatabaseName to database $DatabaseName. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationSetting +Migration settings which tune the migration behavior + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchemaName +Schema name to be migrated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDatabaseName +The name of the source database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSetting +Source settings to tune source endpoint migration behavior + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableMap +Mapping of source to target tables + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDatabaseName +The name of the target database + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSetting +Target settings to tune target endpoint migration behavior + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.DataMigration.Models.MigrateSqlServerSqlDbSyncTaskInput + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationTask.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationTask.md new file mode 100644 index 0000000000..b8b0a106c5 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationTask.md @@ -0,0 +1,233 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/New-AzDataMigrationTask +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationTask.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationTask.md +--- + +# New-AzDataMigrationTask + +## SYNOPSIS +Creates and starts a data migration task in the Azure Database Migration Service (classic). + +## SYNTAX + +### ComponentNameParameterSet (Default) +``` +New-AzDataMigrationTask -TaskType <TaskTypeEnum> -ResourceGroupName <String> -ServiceName <String> + -ProjectName <String> [-Wait] -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ComponentObjectParameterSet +``` +New-AzDataMigrationTask [-InputObject] <PSProject> -TaskType <TaskTypeEnum> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +New-AzDataMigrationTask [-ResourceId] <String> -TaskType <TaskTypeEnum> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDataMigrationTask cmdlet creates data migration task. This cmdlet takes in parameters for Task Type enumerator, Azure Resource Group, name of associated Azure Database Migration Service (classic) and Project as input. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataMigrationTask -TaskType MigrateSqlServerSqlDb -ResourceGroupName myResourceGroup -ServiceName TestService -ProjectName myDMSProject -TaskName MyMigrationTask +``` + +This example script shows how to create a new Data Migration Task named MyMigrationTask in the project named myDMSProject and service named TestService. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSProject Object. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.PSProject +Parameter Sets: ComponentObjectParameterSet +Aliases: Project + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the task. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TaskName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the project. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Project Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +Azure Database Migration Service (classic) Name. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TaskType +Task Type. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.TaskTypeEnum +Parameter Sets: (All) +Aliases: +Accepted values: MigrateSqlServerSqlDb, ConnectToSourceSqlServer, ConnectToTargetSqlDb, GetUserTablesSql, ConnectToTargetSqlDbMi, MigrateSqlServerSqlDbMi, ValidateSqlServerSqlDbMi, MigrateSqlServerSqlDbSync, ConnectToSourceSqlServerSync, ConnectToTargetSqlSync, GetUserTablesSqlSync, ValidateSqlServerSqlDbSync, ConnectToSourceMongoDb, ConnectToTargetMongoDb, MigrateMongoDb, ValidateMongoDbMigration, ConnectToTargetSqlDbMiSync, ValidateSqlServerSqlDbMiSync, MigrateSqlServerSqlDbMiSync + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Whether to wait for task to finish. If the flag is set, checks every one seconds till the task finishes and return to user the task properties where output or error can be inspected. + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSProject + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSProjectTask + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationTdeCertificateMigration.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationTdeCertificateMigration.md new file mode 100644 index 0000000000..456d9a6e39 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationTdeCertificateMigration.md @@ -0,0 +1,241 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/new-azdatamigrationtdecertificatemigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationTdeCertificateMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationTdeCertificateMigration.md +--- + +# New-AzDataMigrationTdeCertificateMigration + +## SYNOPSIS +Migrate TDE certificate(s) from source SQL Server to the target Azure SQL Server. + +## SYNTAX + +``` +New-AzDataMigrationTdeCertificateMigration -SourceSqlConnectionString <SecureString> + -TargetSubscriptionId <String> -TargetResourceGroupName <String> -TargetManagedInstanceName <String> + -NetworkSharePath <String> -NetworkShareDomain <String> -DatabaseName <String[]> + [-NetworkShareUserName <String>] [-NetworkSharePassword <SecureString>] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Migrate TDE certificate(s) from source SQL Server to the target Azure SQL Server. + +## EXAMPLES + +### Example 1: Run TDE certificate migration from a source SQL Server to a target Azure SQL Server. +```powershell +New-AzDataMigrationTdeCertificateMigration -SourceSqlConnectionString "data source=servername;user id=userid;password=;initial catalog=master;TrustServerCertificate=True" -TargetSubscriptionId "00000000-0000-0000-0000-000000000000" -TargetResourceGroupName "ResourceGroupName" -TargetManagedInstanceName "TargetManagedInstanceName" -NetworkSharePath "\\NetworkShare\Folder" -NetworkShareDomain "NetworkShare" -NetworkShareUserName "NetworkShareUserName" -NetworkSharePassword "NetworkSharePassword" -DatabaseName "TdeDb_0", "TdeDb_1", "TdeDb_2" +``` + +```output +Beginning TDE certificate migration +TdeDb_0: TDE certificate migrated successfully. +TdeDb_1: TDE certificate migrated successfully. +TdeDb_2: TDE certificate migrated successfully. +Certificate migration completed +``` + +This command runs TDE certificate migration from a source SQL Server to a target Azure SQL Server. + +## PARAMETERS + +### -DatabaseName +Source database name. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkShareDomain +Network share domain. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSharePassword +Network share password. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSharePath +Network share path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkShareUserName +Network share user name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionString +Required. +Connection string for the source SQL instance, using the formal connection string format. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetManagedInstanceName +Name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +Resource group name of the target Azure SQL server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSubscriptionId +Subscription Id of the target Azure SQL server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationToSqlDb.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationToSqlDb.md new file mode 100644 index 0000000000..e412beb1ac --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationToSqlDb.md @@ -0,0 +1,503 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/new-azdatamigrationtosqldb +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationToSqlDb.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationToSqlDb.md +--- + +# New-AzDataMigrationToSqlDb + +## SYNOPSIS +Create a new database migration to a given SQL Db. + +## SYNTAX + +``` +New-AzDataMigrationToSqlDb -ResourceGroupName <String> -SqlDbInstanceName <String> -TargetDbName <String> + [-SubscriptionId <String>] [-Kind <ResourceType>] [-MigrationService <String>] [-Scope <String>] + [-SourceDatabaseName <String>] [-SourceSqlConnectionAuthentication <String>] + [-SourceSqlConnectionDataSource <String>] [-SourceSqlConnectionEncryptConnection] + [-SourceSqlConnectionPassword <SecureString>] [-SourceSqlConnectionTrustServerCertificate] + [-SourceSqlConnectionUserName <String>] [-TableList <String[]>] [-TargetDatabaseCollation <String>] + [-TargetSqlConnectionAuthentication <String>] [-TargetSqlConnectionDataSource <String>] + [-TargetSqlConnectionEncryptConnection] [-TargetSqlConnectionPassword <SecureString>] + [-TargetSqlConnectionTrustServerCertificate] [-TargetSqlConnectionUserName <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new database migration to a given SQL Db. + +## EXAMPLES + +### Example 1: Start a Database Migration from the on-premise Source Sql Server to target Sql Db +```powershell +$sourcePassword = ConvertTo-SecureString "pass123" -AsPlainText -Force +$targetPassword = ConvertTo-SecureString "pass123" -AsPlainText -Force +New-AzDataMigrationToSqlDb -ResourceGroupName myRG -SqlDbInstanceName "mysqldb" -MigrationService "/subscriptions/1111-2222-3333-4444/resourceGroups/myRG/providers/Microsoft.DataMigration/SqlMigrationServices/myDMS" -TargetSqlConnectionAuthentication "SqlAuthentication" -TargetSqlConnectionDataSource "mydb.windows.net" -TargetSqlConnectionPassword $targetPassword -TargetSqlConnectionUserName "user" -SourceSqlConnectionAuthentication "SqlAuthentication" -SourceSqlConnectionDataSource "xyz.MICROSOFT.COM" -SourceSqlConnectionUserName "user1" -SourceSqlConnectionPassword $sourcePassword -SourceDatabaseName "sourcedb" -TargetDbName "mydb1" -Scope "/subscriptions/1111-2222-3333-4444/resourceGroups/myRG/providers/Microsoft.Sql/servers/mysqldb" +``` + +```output +Name Kind ProvisioningState MigrationStatus +----- ---- ----------------- --------------- +mydb1 SqlDb Succeeded InProgress +``` + +Start a Database Migration from the on-premise Source Sql Server to target Sql Db + +### Example 2: Start a Database Migration with some selcted tables from the on-premise Source Sql Server to target Sql Db +```powershell +$sourcePassword = ConvertTo-SecureString "pass123" -AsPlainText -Force +$targetPassword = ConvertTo-SecureString "pass123" -AsPlainText -Force +New-AzDataMigrationToSqlDb -ResourceGroupName myRG -SqlDbInstanceName "mysqldb" -MigrationService "/subscriptions/1111-2222-3333-4444/resourceGroups/myRG/providers/Microsoft.DataMigration/SqlMigrationServices/myDMS" -TargetSqlConnectionAuthentication "SqlAuthentication" -TargetSqlConnectionDataSource "mydb.windows.net" -TargetSqlConnectionPassword $targetPassword -TargetSqlConnectionUserName "user" -SourceSqlConnectionAuthentication "SqlAuthentication" -SourceSqlConnectionDataSource "xyz.MICROSOFT.COM" -SourceSqlConnectionUserName "user1" -SourceSqlConnectionPassword $sourcePassword -SourceDatabaseName "sourcedb" -TargetDbName "mydb1" -Scope "/subscriptions/1111-2222-3333-4444/resourceGroups/myRG/providers/Microsoft.Sql/servers/mysqldb" -TableList "table_1" +``` + +```output +Name Kind ProvisioningState MigrationStatus +----- ---- ----------------- --------------- +mydb1 SqlDb Succeeded InProgress +``` + +Start a Database Migration with some selcted tables from the on-premise Source Sql Server to target Sql Db + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Support.ResourceType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationService +Resource Id of the Migration Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Resource Id of the target resource (SQL VM or SQL Managed Instance) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDatabaseName +Name of the source database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionAuthentication +Authentication type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionDataSource +Data source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionEncryptConnection +Whether to encrypt connection or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionPassword +Password to connect to source SQL. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionTrustServerCertificate +Whether to trust server certificate or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionUserName +User name to connect to source SQL. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlDbInstanceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableList +List of tables to copy. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDatabaseCollation +Database collation to be used for the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSqlConnectionAuthentication +Authentication type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSqlConnectionDataSource +Data source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSqlConnectionEncryptConnection +Whether to encrypt connection or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSqlConnectionPassword +Password to connect to source SQL. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSqlConnectionTrustServerCertificate +Whether to trust server certificate or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSqlConnectionUserName +User name to connect to source SQL. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.IDatabaseMigrationSqlDb + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationToSqlManagedInstance.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationToSqlManagedInstance.md new file mode 100644 index 0000000000..1da4b7d833 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationToSqlManagedInstance.md @@ -0,0 +1,538 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/new-azdatamigrationtosqlmanagedinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationToSqlManagedInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationToSqlManagedInstance.md +--- + +# New-AzDataMigrationToSqlManagedInstance + +## SYNOPSIS +Create a new database migration to a given SQL Managed Instance. + +## SYNTAX + +``` +New-AzDataMigrationToSqlManagedInstance -ManagedInstanceName <String> -ResourceGroupName <String> + -TargetDbName <String> [-SubscriptionId <String>] [-AzureBlobAccountKey <String>] + [-AzureBlobContainerName <String>] [-AzureBlobStorageAccountResourceId <String>] + [-FileSharePassword <SecureString>] [-FileSharePath <String>] [-FileShareUsername <String>] + [-Kind <ResourceType>] [-MigrationService <String>] [-Offline] [-OfflineConfigurationLastBackupName <String>] + [-Scope <String>] [-SourceDatabaseName <String>] [-SourceSqlConnectionAuthentication <String>] + [-SourceSqlConnectionDataSource <String>] [-SourceSqlConnectionEncryptConnection] + [-SourceSqlConnectionPassword <SecureString>] [-SourceSqlConnectionTrustServerCertificate] + [-SourceSqlConnectionUserName <String>] [-StorageAccountKey <String>] [-StorageAccountResourceId <String>] + [-TargetDatabaseCollation <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new database migration to a given SQL Managed Instance. + +## EXAMPLES + +### Example 1: Start a Database Migration from the on-premise Source Sql Server to target Managed Instance +```powershell +$sourcePassword = ConvertTo-SecureString "pass123" -AsPlainText -Force +$filesharePassword = ConvertTo-SecureString "pass123" -AsPlainText -Force +New-AzDataMigrationToSqlManagedInstance -ResourceGroupName "MyResourceGroup" -ManagedInstanceName "MyManagedInstance" -TargetDbName "MyDb" -Kind "SqlMI" -Scope "/subscriptions/0000-1111-2222-3333-4444/resourceGroups/MyResourceGroup/providers/Microsoft.Sql/managedInstances/MyManagedInstance" -MigrationService "/subscriptions/0000-1111-2222-3333-4444/resourceGroups/MyRG/providers/Microsoft.DataMigration/SqlMigrationServices/MySqlMigrationService" -StorageAccountResourceId "/subscriptions/0000-1111-2222-3333-4444/resourceGroups/MyResourceGroup/providers/Microsoft.Storage/storageAccounts/MyStorageAccount" -StorageAccountKey "aaaaacccccoouunntkkkkeeeyyy" -FileSharePath "\\filesharepath.com\SharedBackup\MyBackUps" -FileShareUsername "filesharepath\User" -FileSharePassword $filesharePassword -SourceSqlConnectionAuthentication "SqlAuthentication" -SourceSqlConnectionDataSource "LabServer.database.net" -SourceSqlConnectionUserName "User" -SourceSqlConnectionPassword $sourcePassword -SourceDatabaseName "AdventureWorks" +``` + +```output +Name Type Kind ProvisioningState MigrationStatus +---- ---- ---- ----------------- --------------- +MyDb Microsoft.DataMigration/databaseMigrations SqlMi Succeeded InProgress +``` + +This command starts a Database Migration from the Source Sql Server to target Managed Instance. +This example is for online migration. +To make it offline add -Offline to the parameters. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobAccountKey +Storage Account Key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobContainerName +Blob container name where backups are stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobStorageAccountResourceId +Resource Id of the storage account where backups are stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSharePassword +Password for username to access file share location. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSharePath +Location as SMB share or local drive where backups are placed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileShareUsername +Username to access the file share location for backups. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Support.ResourceType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedInstanceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationService +Resource Id of the Migration Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Offline +Offline migration + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfflineConfigurationLastBackupName +Last backup name for offline migration. +This is optional for migrations from file share. +If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Resource Id of the target resource (SQL VM or SQL Managed Instance) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDatabaseName +Name of the source database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionAuthentication +Authentication type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionDataSource +Data source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionEncryptConnection +Whether to encrypt connection or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionPassword +Password to connect to source SQL. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionTrustServerCertificate +Whether to trust server certificate or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionUserName +User name to connect to source SQL. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountKey +Storage Account Key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Resource Id of the storage account copying backups. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDatabaseCollation +Database collation to be used for the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.IDatabaseMigrationSqlMi + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/New-AzDataMigrationToSqlVM.md b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationToSqlVM.md new file mode 100644 index 0000000000..bc51f01cee --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/New-AzDataMigrationToSqlVM.md @@ -0,0 +1,543 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/new-azdatamigrationtosqlvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationToSqlVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/New-AzDataMigrationToSqlVM.md +--- + +# New-AzDataMigrationToSqlVM + +## SYNOPSIS +Create a new database migration to a given SQL VM. + +## SYNTAX + +``` +New-AzDataMigrationToSqlVM -ResourceGroupName <String> -SqlVirtualMachineName <String> -TargetDbName <String> + [-SubscriptionId <String>] [-AzureBlobAccountKey <String>] [-AzureBlobContainerName <String>] + [-AzureBlobStorageAccountResourceId <String>] [-FileSharePassword <SecureString>] [-FileSharePath <String>] + [-FileShareUsername <String>] [-Kind <ResourceType>] [-MigrationService <String>] [-Offline] + [-OfflineConfigurationLastBackupName <String>] [-Scope <String>] [-SourceDatabaseName <String>] + [-SourceSqlConnectionAuthentication <String>] [-SourceSqlConnectionDataSource <String>] + [-SourceSqlConnectionEncryptConnection] [-SourceSqlConnectionPassword <SecureString>] + [-SourceSqlConnectionTrustServerCertificate] [-SourceSqlConnectionUserName <String>] + [-StorageAccountKey <String>] [-StorageAccountResourceId <String>] [-TargetDatabaseCollation <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new database migration to a given SQL VM. + +## EXAMPLES + +### Example 1: Start a Database Migration from the on-premise Source Sql Server to target Sql VM +```powershell +$sourcePassword = ConvertTo-SecureString "pass123" -AsPlainText -Force +$filesharePassword = ConvertTo-SecureString "pass123" -AsPlainText -Force + +New-AzDataMigrationToSqlVM -ResourceGroupName "MyResourceGroup" -SqlVirtualMachineName "MyVM" -TargetDbName "MyDb" -Kind "SqlVm" -Scope "/subscriptions/0000-1111-2222-3333-4444/resourceGroups/MyResourceGroup/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachine/MyVM" -MigrationService "/subscriptions/0000-1111-2222-3333-4444/resourceGroups/MyResourceGroup/providers/Microsoft.DataMigration/SqlMigrationServices/MySqlMigrationService" -StorageAccountResourceId "/subscriptions/0000-1111-2222-3333-4444/resourceGroups/MyResourceGroup/providers/Microsoft.Storage/storageAccounts/MyStorageAccount" -StorageAccountKey "aaaaaccccoooouuunnntttkkkeeeyy" -FileSharePath "\\filesharepath.com\SharedBackup\MyBackUps" -FileShareUsername "filesharepath\User" -FileSharePassword $filesharePassword -SourceSqlConnectionAuthentication "SqlAuthentication" -SourceSqlConnectionDataSource "LabServer.database.net" -SourceSqlConnectionUserName "User" -SourceSqlConnectionPassword $sourcePassword -SourceDatabaseName "AdventureWorks" +``` + +```output +Name Type Kind ProvisioningState MigrationStatus +---- ---- ---- ----------------- --------------- +MyDb Microsoft.DataMigration/databaseMigrations SqlVm Succeeded InProgress +``` + +This command starts a Database Migration from the Source Sql Server to target Sql VM. +This example is for online migration. +To make it offline add -Offline to the parameters. + +Note : +Create a new database migration to a given SQL VM. +Note - For the Scope parameter, use the Scope of the SQL VM (/subscriptions/111-222/resourceGroups/myRG/providers/Microsoft.SqlVirtualMachine/SqlVirtualMachines/xyz-SqlVM) and not the Compute SQL VM (/subscriptions/111-222/resourceGroups/myRG/providers/Microsoft.Compute/virtualMachines/xyz-SqlVM) + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobAccountKey +Storage Account Key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobContainerName +Blob container name where backups are stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobStorageAccountResourceId +Resource Id of the storage account where backups are stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSharePassword +Password for username to access file share location. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSharePath +Location as SMB share or local drive where backups are placed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileShareUsername +Username to access the file share location for backups. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Support.ResourceType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationService +Resource Id of the Migration Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Offline +Offline migration + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfflineConfigurationLastBackupName +Last backup name for offline migration. +This is optional for migrations from file share. +If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Resource Id of the target resource (SQL VM). +For the Scope parameter, use the Scope of the SQL VM (/subscriptions/111-222/resourceGroups/myRG/providers/Microsoft.SqlVirtualMachine/SqlVirtualMachines/xyz-SqlVM) and not the Compute SQL VM (/subscriptions/111-222/resourceGroups/myRG/providers/Microsoft.Compute/virtualMachines/xyz-SqlVM) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDatabaseName +Name of the source database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionAuthentication +Authentication type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionDataSource +Data source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionEncryptConnection +Whether to encrypt connection or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionPassword +Password to connect to source SQL. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionTrustServerCertificate +Whether to trust server certificate or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSqlConnectionUserName +User name to connect to source SQL. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVirtualMachineName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountKey +Storage Account Key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Resource Id of the storage account copying backups. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDatabaseCollation +Database collation to be used for the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.IDatabaseMigrationSqlVM + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Register-AzDataMigrationIntegrationRuntime.md b/azps-10.1.0/Az.DataMigration/Register-AzDataMigrationIntegrationRuntime.md new file mode 100644 index 0000000000..e6cd3dd3e1 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Register-AzDataMigrationIntegrationRuntime.md @@ -0,0 +1,145 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/register-azdatamigrationintegrationruntime +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Register-AzDataMigrationIntegrationRuntime.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Register-AzDataMigrationIntegrationRuntime.md +--- + +# Register-AzDataMigrationIntegrationRuntime + +## SYNOPSIS +Registers Sql Migration Service on Integration Runtime + +## SYNTAX + +``` +Register-AzDataMigrationIntegrationRuntime -AuthKey <String> [-IntegrationRuntimePath <String>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Registers Sql Migration Service on Integration Runtime + +## EXAMPLES + +### Example 1: Register Sql Migration Service on Self Hosted Integration Runtime +```powershell +$authKeys = Get-AzDataMigrationSqlServiceAuthKey -ResourceGroupName "MyResourceGroup" -SqlMigrationServiceName "MySqlMigrationService" +Register-AzDataMigrationIntegrationRuntime -AuthKey $authKeys.AuthKey1 +``` + +```output +Start to register IR with key: IR@abcd1-efgh2-jklmn3-opqr4@mysqlms@eastus@stuv5/wxyz6= +Integration Runtime registration is successful! +``` + +This command registers Sql Migration Service on Self Hosted Integration Runtime. + +### Example 2: Install Integration Runtime and register a Sql Migration Service on it +```powershell +$authKeys = Get-AzDataMigrationSqlServiceAuthKey -ResourceGroupName "MyResourceGroup" -SqlMigrationServiceName "MySqlMigrationService" +Register-AzDataMigrationIntegrationRuntime -AuthKey $authKeys.AuthKey1 -IntegrationRuntimePath "C:\Users\user\Downloads\IntegrationRuntime.msi" +``` + +```output +Start Gateway installation +Succeed to install gateway +Start to register IR with key: IR@abcd1-efgh2-jklmn3-opqr4@mysqlms@eastus@stuv5/wxyz6= +Integration Runtime registration is successful! +``` + +This command installs Integration Runtime and registers a Sql Migration Service on it. + +## PARAMETERS + +### -AuthKey +AuthKey of Sql Migration Service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntegrationRuntimePath +Path of SHIR msi + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationProject.md b/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationProject.md new file mode 100644 index 0000000000..31e394901e --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationProject.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/Remove-AzDataMigrationProject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Remove-AzDataMigrationProject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Remove-AzDataMigrationProject.md +--- + +# Remove-AzDataMigrationProject + +## SYNOPSIS +Removes an Azure Database Migration Service (classic) project from Azure. + +## SYNTAX + +### ComponentNameParameterSet (Default) +``` +Remove-AzDataMigrationProject -ResourceGroupName <String> -ServiceName <String> -Name <String> [-Force] + [-DeleteRunningTask] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ComponentObjectParameterSet +``` +Remove-AzDataMigrationProject [-InputObject] <PSProject> [-Force] [-DeleteRunningTask] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzDataMigrationProject [-ResourceId] <String> [-Force] [-DeleteRunningTask] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzDataMigrationProject cmdlet removes an Azure Database Migration Service (classic) project from Azure. Supplying the DeleteRunningTask parameter removes all of the Azure Database Migration Service (classic) tasks associated with the project that is being removed. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataMigrationProject -ResourceGroupName myResourceGroup -ServiceName myDMService -ProjectName myDMProject +``` + +The above example removes the Azure Database Migration Service (classic) project called myDMProject from Azure based on name as input parameter + +### Example 2 +```powershell +Remove-AzDataMigrationProject -InputObject $myDMSProject +``` + +The above example removes the Azure Database Migration Service (classic) project based on PSProject object as input parameter. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteRunningTask +Delete any running task + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSProject Object. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.PSProject +Parameter Sets: ComponentObjectParameterSet +Aliases: Project + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the project. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: ProjectName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an true/false. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Project Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +Azure Database Migration Service (classic) Name. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSProject + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationService.md b/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationService.md new file mode 100644 index 0000000000..c9cdec2ed8 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationService.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/Remove-AzDataMigrationService +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Remove-AzDataMigrationService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Remove-AzDataMigrationService.md +--- + +# Remove-AzDataMigrationService + +## SYNOPSIS +Removes an instance of the Azure Database Migration Service (classic) from Azure. + +## SYNTAX + +### ComponentNameParameterSet (Default) +``` +Remove-AzDataMigrationService -ResourceGroupName <String> -Name <String> [-Force] [-DeleteRunningTask] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ComponentObjectParameterSet +``` +Remove-AzDataMigrationService [-InputObject] <PSDataMigrationService> [-Force] [-DeleteRunningTask] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzDataMigrationService [-ResourceId] <String> [-Force] [-DeleteRunningTask] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzDataMigrationService cmdlet removes an instance of the Azure Database Migration Service (classic) from Azure. Supplying the DeleteRunningTask parameter removes all of the Azure Database Migration Service (classic) tasks associated with the service that is being removed. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataMigrationService -ResourceGroupName MyResourceGroup -ServiceName TestService +``` + +The above example removes an instance of the Azure Database Migration Service (classic) named TestService that is contained in an Azure Resource Group named MyResourceGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteRunningTask +Delete any running task + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSDataMigrationService Object. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService +Parameter Sets: ComponentObjectParameterSet +Aliases: DataMigrationService + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Azure Database Migration Service (classic). + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an true/false. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +DataMigrationService Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationSqlService.md b/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationSqlService.md new file mode 100644 index 0000000000..7afd66b188 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationSqlService.md @@ -0,0 +1,227 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/remove-azdatamigrationsqlservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Remove-AzDataMigrationSqlService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Remove-AzDataMigrationSqlService.md +--- + +# Remove-AzDataMigrationSqlService + +## SYNOPSIS +Delete Database Migration Service. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDataMigrationSqlService -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDataMigrationSqlService -InputObject <IDataMigrationIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete Database Migration Service. + +## EXAMPLES + +### Example 1: Delete the Sql Migration Service +```powershell +Remove-AzDataMigrationSqlService -ResourceGroupName "MyResourceGroup" -Name "MySqlMigrationService" +``` + +This command deletes the specified Sql Migration Service. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SQL Migration Service. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SqlMigrationServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDataMigrationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ManagedInstanceName <String>]`: + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlDbInstanceName <String>]`: + - `[SqlMigrationServiceName <String>]`: Name of the SQL Migration Service. + - `[SqlVirtualMachineName <String>]`: + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + - `[TargetDbName <String>]`: The name of the target database. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationSqlServiceNode.md b/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationSqlServiceNode.md new file mode 100644 index 0000000000..fa1e11d58b --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationSqlServiceNode.md @@ -0,0 +1,234 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/remove-azdatamigrationsqlservicenode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Remove-AzDataMigrationSqlServiceNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Remove-AzDataMigrationSqlServiceNode.md +--- + +# Remove-AzDataMigrationSqlServiceNode + +## SYNOPSIS +Delete the integration runtime node. + +## SYNTAX + +### DeleteExpanded (Default) +``` +Remove-AzDataMigrationSqlServiceNode -ResourceGroupName <String> -SqlMigrationServiceName <String> + [-SubscriptionId <String>] [-IntegrationRuntimeName <String>] [-NodeName <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentityExpanded +``` +Remove-AzDataMigrationSqlServiceNode -InputObject <IDataMigrationIdentity> [-IntegrationRuntimeName <String>] + [-NodeName <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the integration runtime node. + +## EXAMPLES + +### Example 1: Remove the specified Intergration Runtime Node for a Sql Migration Service +```powershell +Remove-AzDataMigrationSqlServiceNode -ResourceGroupName "MyResourceGroup" -SqlMigrationServiceName "MySqlMigrationService" -NodeName "WIN-AKLAB" | Select-Object * +``` + +```output +Name Node +---- ---- +default-ir {} +``` + +This command removes the specified Intergration Runtime Node for the given Sql Migration Service. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity +Parameter Sets: DeleteViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntegrationRuntimeName +The name of integration runtime. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeName +The name of node to delete. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: DeleteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlMigrationServiceName +Name of the SQL Migration Service. + +```yaml +Type: System.String +Parameter Sets: DeleteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: DeleteExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.IDeleteNode + +## 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 <IDataMigrationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ManagedInstanceName <String>]`: + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlDbInstanceName <String>]`: + - `[SqlMigrationServiceName <String>]`: Name of the SQL Migration Service. + - `[SqlVirtualMachineName <String>]`: + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + - `[TargetDbName <String>]`: The name of the target database. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationTask.md b/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationTask.md new file mode 100644 index 0000000000..0b2ea6fc8c --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationTask.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/Remove-AzDataMigrationTask +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Remove-AzDataMigrationTask.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Remove-AzDataMigrationTask.md +--- + +# Remove-AzDataMigrationTask + +## SYNOPSIS +Removes an Azure Database Migration Service (classic) task from Azure. + +## SYNTAX + +### ComponentNameParameterSet (Default) +``` +Remove-AzDataMigrationTask -ResourceGroupName <String> -ServiceName <String> -ProjectName <String> + -Name <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ComponentObjectParameterSet +``` +Remove-AzDataMigrationTask [-InputObject] <PSProjectTask> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzDataMigrationTask [-ResourceId] <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzDataMigrationTask cmdlet removes an Azure Database Migration Service (classic) task from Azure. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataMigrationTask -TaskName TestTask -ProjectName myTestProject -ServiceName MyTestService -ResourceGroupName MyResourceGroup +``` + +The preceding example removes an Azure Database Migration Service (classic) task named TestTask from Azure based on task name parameter. + +### Example 2 +```powershell +Remove-AzDataMigrationTask -InputObject $TestTask +``` + +The preceding example removes an Azure Database Migration Service (classic) task based on PSProjectTask object passed in. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSProjectTask Object. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.PSProjectTask +Parameter Sets: ComponentObjectParameterSet +Aliases: ProjectTask + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the task. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: TaskName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an true/false. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the project. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Project Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +Azure Database Migration Service (classic) Name. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSProjectTask + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationToSqlDb.md b/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationToSqlDb.md new file mode 100644 index 0000000000..a64d05af91 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Remove-AzDataMigrationToSqlDb.md @@ -0,0 +1,266 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/remove-azdatamigrationtosqldb +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Remove-AzDataMigrationToSqlDb.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Remove-AzDataMigrationToSqlDb.md +--- + +# Remove-AzDataMigrationToSqlDb + +## SYNOPSIS +Remove the specified database migration for a given SQL Db. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDataMigrationToSqlDb -ResourceGroupName <String> -SqlDbInstanceName <String> + [-SubscriptionId <String>] -TargetDbName <String> [-Force] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDataMigrationToSqlDb -InputObject <IDataMigrationIdentity> [-Force] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove the specified database migration for a given SQL Db. + +## EXAMPLES + +### Example 1: Delete the SQL DB Database Migration resource. +```powershell +Remove-AzDataMigrationToSqlDb -ResourceGroupName myRG -SqlDbInstanceName sqldb -TargetDbName myDB +``` + +Delete the SQL DB Database Migration resource. + +### Example 2: Delete the SQL DB Database Migration resource even if it is in progress +```powershell +Remove-AzDataMigrationToSqlDb -ResourceGroupName myRG -SqlDbInstanceName sqldb -TargetDbName myDB -Force +``` + +Forcibly deletes an ongoing Migration to SQL DB by adding the optional "Force" parameter + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Optional force delete boolean. +If this is provided as true, migration will be deleted even if active. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlDbInstanceName +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDataMigrationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ManagedInstanceName <String>]`: + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlDbInstanceName <String>]`: + - `[SqlMigrationServiceName <String>]`: Name of the SQL Migration Service. + - `[SqlVirtualMachineName <String>]`: + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + - `[TargetDbName <String>]`: The name of the target database. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Start-AzDataMigrationService.md b/azps-10.1.0/Az.DataMigration/Start-AzDataMigrationService.md new file mode 100644 index 0000000000..16fa006502 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Start-AzDataMigrationService.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/Start-AzDataMigrationService +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Start-AzDataMigrationService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Start-AzDataMigrationService.md +--- + +# Start-AzDataMigrationService + +## SYNOPSIS +Starts an instance of the Azure Database Migration Service (classic) in a stopped state. + +## SYNTAX + +### ComponentNameParameterSet (Default) +``` +Start-AzDataMigrationService -ResourceGroupName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ComponentObjectParameterSet +``` +Start-AzDataMigrationService [-InputObject] <PSDataMigrationService> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Start-AzDataMigrationService [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Start-AzDataMigrationService cmdlet starts an instance of the Azure Database Migration Service (classic) in a stopped state. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzDataMigrationService -ResourceGroupName MyResourceGroup -ServiceName TestService +``` + +The above example starts an Azure Database Migration Service (classic) instance named Test Service in a stopped state based on service name passed in as input + +### Example 2 +```powershell +Start-AzDataMigrationService -InputObject $TestService +``` + +The above example starts an Azure Database Migration Service (classic) instance based on PSDataMigrationService passed in as input parameter + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSDataMigrationService Object. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService +Parameter Sets: ComponentObjectParameterSet +Aliases: DataMigrationService + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure Database Migration Service (classic) Name. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an true/false. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +DataMigrationService Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationService.md b/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationService.md new file mode 100644 index 0000000000..6bcb83aa06 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationService.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/Stop-AzDataMigrationService +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Stop-AzDataMigrationService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Stop-AzDataMigrationService.md +--- + +# Stop-AzDataMigrationService + +## SYNOPSIS +Stops an instance of the Azure Database Migration Service (classic) that is in a running state. + +## SYNTAX + +### ComponentNameParameterSet (Default) +``` +Stop-AzDataMigrationService -ResourceGroupName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ComponentObjectParameterSet +``` +Stop-AzDataMigrationService [-InputObject] <PSDataMigrationService> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Stop-AzDataMigrationService [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Stop-AzDataMigrationService cmdlet stops an instance of the Azure Database Migration Service (classic) that is in a running state. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzDataMigrationService -ResourceGroupName MyResourceGroup -ServiceName TestService +``` + +The above example stops an instance of the Azure Database Migration Service (classic) called TestService based on service name passed in as input parameter + +### Example 2 +```powershell +Stop-AzDataMigrationService -InputObject $TestService +``` + +The above example stops an instance of the Azure Database Migration Service (classic) based on PSDataMigrationService object passed as input parameter. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSDataMigrationService Object. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService +Parameter Sets: ComponentObjectParameterSet +Aliases: DataMigrationService + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure Database Migration Service (classic) Name. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an true/false. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +DataMigrationService Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationTask.md b/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationTask.md new file mode 100644 index 0000000000..54c19e852a --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationTask.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.dll-Help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/Stop-AzDataMigrationTask +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Stop-AzDataMigrationTask.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Stop-AzDataMigrationTask.md +--- + +# Stop-AzDataMigrationTask + +## SYNOPSIS +Stops an Azure Database Migration Service (classic) task that is in a running state. + +## SYNTAX + +### ComponentNameParameterSet (Default) +``` +Stop-AzDataMigrationTask -ResourceGroupName <String> -ServiceName <String> -ProjectName <String> -Name <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ComponentObjectParameterSet +``` +Stop-AzDataMigrationTask [-InputObject] <PSProjectTask> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Stop-AzDataMigrationTask [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Stop-AzDataMigrationTask cmdlet stops database migration activity in running state. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzDataMigrationTask -ResourceGroupName MyResourceGroup -ServiceName TestService -ProjectName myDMSProject -Name myDMSTask +``` + +Above example stops Azure Database Migration Service (classic) task named myDMSTask associated with project myDMSProject and Azure Database Migration Service instance named TestService + +### Example 2 +```powershell +Stop-AzDataMigrationTask -InputObject $MyDMSTask +``` + +Above example stops Azure Database Migration Service (classic) task passed in as input parameter PSProjectTask object + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSProjectTask Object. + +```yaml +Type: Microsoft.Azure.Commands.DataMigration.Models.PSProjectTask +Parameter Sets: ComponentObjectParameterSet +Aliases: ProjectTask + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the task. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: TaskName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an true/false. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the project. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group . + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ProjectTask Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +Azure Database Migration Service (classic) Name. + +```yaml +Type: System.String +Parameter Sets: ComponentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DataMigration.Models.PSProjectTask + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationToSqlDb.md b/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationToSqlDb.md new file mode 100644 index 0000000000..8c9199dc62 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationToSqlDb.md @@ -0,0 +1,227 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/stop-azdatamigrationtosqldb +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Stop-AzDataMigrationToSqlDb.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Stop-AzDataMigrationToSqlDb.md +--- + +# Stop-AzDataMigrationToSqlDb + +## SYNOPSIS +Stop in-progress database migration to SQL Db. + +## SYNTAX + +``` +Stop-AzDataMigrationToSqlDb -ResourceGroupName <String> -SqlDbInstanceName <String> -TargetDbName <String> + [-SubscriptionId <String>] -MigrationOperationId <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Stop in-progress database migration to SQL Db. + +## EXAMPLES + +### Example 1: Stop in-progress migration to SQL DB +```powershell +$dbMigration = Get-AzDataMigrationToSqlDb -ResourceGroupName "myRG" -SqlDbInstanceName "mySqlDb" -TargetDbName "mydb1" +Stop-AzDataMigrationToSqlDb -ResourceGroupName "myRG" -SqlDbInstanceName "mySqlDb" -TargetDbName "mydb1" -MigrationOperationId $dbMigration.MigrationOperationId + +Get-AzDataMigrationToSqlDb -InputObject $dbMigration +``` + +```output +Name Type Kind ProvisioningState MigrationStatus +---- ---- ---- ----------------- --------------- +mydb1 Microsoft.DataMigration/databaseMigrations SqlDb Canceling Canceling +``` + +This command stops the in-progress migration to SQL Managed Instance. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationOperationId +ID tracking migration operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlDbInstanceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationToSqlManagedInstance.md b/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationToSqlManagedInstance.md new file mode 100644 index 0000000000..8b74a8b041 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationToSqlManagedInstance.md @@ -0,0 +1,226 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/stop-azdatamigrationtosqlmanagedinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Stop-AzDataMigrationToSqlManagedInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Stop-AzDataMigrationToSqlManagedInstance.md +--- + +# Stop-AzDataMigrationToSqlManagedInstance + +## SYNOPSIS +Stop in-progress database migration to SQL Managed Instance. + +## SYNTAX + +``` +Stop-AzDataMigrationToSqlManagedInstance -ManagedInstanceName <String> -ResourceGroupName <String> + -TargetDbName <String> [-SubscriptionId <String>] -MigrationOperationId <String> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Stop in-progress database migration to SQL Managed Instance. + +## EXAMPLES + +### Example 1: Stop in-progress migration to SQL Managed Instance +```powershell +$miMigration = Get-AzDataMigrationToSqlManagedInstance -ResourceGroupName "MyResourceGroup" -ManagedInstanceName "MyManagedInstance" -TargetDbName "MyDatabase" +Stop-AzDataMigrationToSqlManagedInstance -ResourceGroupName "MyResourceGroup" -ManagedInstanceName "MyManagedInstance" -TargetDbName "MyDatabase" -MigrationOperationId $miMigration.MigrationOperationId +Get-AzDataMigrationToSqlManagedInstance -InputObject $miMigration +``` + +```output +Name Type Kind ProvisioningState MigrationStatus +---- ---- ---- ----------------- --------------- +MyDatabase Microsoft.DataMigration/databaseMigrations SqlMi Canceling Canceling +``` + +This command stops the in-progress migration to SQL Managed Instance. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedInstanceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationOperationId +ID tracking migration operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationToSqlVM.md b/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationToSqlVM.md new file mode 100644 index 0000000000..b84ee50939 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Stop-AzDataMigrationToSqlVM.md @@ -0,0 +1,226 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/stop-azdatamigrationtosqlvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Stop-AzDataMigrationToSqlVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Stop-AzDataMigrationToSqlVM.md +--- + +# Stop-AzDataMigrationToSqlVM + +## SYNOPSIS +Stop in-progress database migration to SQL VM. + +## SYNTAX + +``` +Stop-AzDataMigrationToSqlVM -ResourceGroupName <String> -SqlVirtualMachineName <String> -TargetDbName <String> + [-SubscriptionId <String>] -MigrationOperationId <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Stop in-progress database migration to SQL VM. + +## EXAMPLES + +### Example 1: Stop in-progress migration to SQL Virtual Machine +```powershell +$vmMigration = Get-AzDataMigrationToSqlVM -ResourceGroupName "MyResourceGroup" -SqlVirtualMachineName "MySqlVM" -TargetDbName "MyDatabase" +Stop-AzDataMigrationToSqlVM -ResourceGroupName "MyResourceGroup" -SqlVirtualMachineName "MySqlVM" -TargetDbName "MyDatabase" -MigrationOperationId $vmMigration.MigrationOperationId +Get-AzDataMigrationToSqlVM -InputObject $vmMigration +``` + +```output +Name Type Kind ProvisioningState MigrationStatus +---- ---- ---- ----------------- --------------- +MyDatabase Microsoft.DataMigration/databaseMigrations SqlVm Canceling Canceling +``` + +This command stops the in-progress migration to SQL Virtual Machine. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationOperationId +ID tracking migration operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVirtualMachineName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataMigration/Update-AzDataMigrationSqlService.md b/azps-10.1.0/Az.DataMigration/Update-AzDataMigrationSqlService.md new file mode 100644 index 0000000000..9b21cec6c0 --- /dev/null +++ b/azps-10.1.0/Az.DataMigration/Update-AzDataMigrationSqlService.md @@ -0,0 +1,263 @@ +--- +external help file: Az.DataMigration-help.xml +Module Name: Az.DataMigration +online version: https://learn.microsoft.com/powershell/module/az.datamigration/update-azdatamigrationsqlservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Update-AzDataMigrationSqlService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataMigration/DataMigration/help/Update-AzDataMigrationSqlService.md +--- + +# Update-AzDataMigrationSqlService + +## SYNOPSIS +Update Database Migration Service. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDataMigrationSqlService -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDataMigrationSqlService -InputObject <IDataMigrationIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update Database Migration Service. + +## EXAMPLES + +### Example 1: Update tag of SQL Migration Service +```powershell +Update-AzDataMigrationSqlService -ResourceGroupName "MyResourceGroup" -SqlMigrationServiceName "MySqlMigrationService" -Tag @{Tag="Service"} +``` + +```output +Location Name Type ProvisioningState IntegrationRuntimeState +-------- ---- ---- ----------------- ----------------------- +eastus2 MySqlMS Microsoft.DataMigration/sqlMigrationServices Succeeded Online +``` + +This command updates tag of SQL Migration Service. + +### Example 2: Update tag of SQL Migration Service using InputObject +```powershell +$mySqlMS = Get-AzDataMigrationSqlService -ResourceGroupName "MyResourceGroup" -SqlMigrationServiceName "MySqlMigrationService" +Update-AzDataMigrationSqlService -InputObject $mySqlMS -Tag @{Tag="Service"} +``` + +```output +Location Name Type ProvisioningState IntegrationRuntimeState +-------- ---- ---- ----------------- ----------------------- +eastus2 MySqlMS Microsoft.DataMigration/sqlMigrationServices Succeeded Online +``` + +This command updates tag of SQL Migration Service using InputObject. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SQL Migration Service. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: SqlMigrationServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Dictionary of \<string\> + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.IDataMigrationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataMigration.Models.Api20220330Preview.ISqlMigrationService + +## 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 <IDataMigrationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ManagedInstanceName <String>]`: + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlDbInstanceName <String>]`: + - `[SqlMigrationServiceName <String>]`: Name of the SQL Migration Service. + - `[SqlVirtualMachineName <String>]`: + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + - `[TargetDbName <String>]`: The name of the target database. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataProtection/Az.DataProtection.md b/azps-10.1.0/Az.DataProtection/Az.DataProtection.md new file mode 100644 index 0000000000..d96bcc0563 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Az.DataProtection.md @@ -0,0 +1,145 @@ +--- +Module Name: Az.DataProtection +Module Guid: 0796af7c-0a7c-417f-8d0d-19f9179dac7a +Download Help Link: https://learn.microsoft.com/powershell/module/az.dataprotection +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Az.DataProtection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Az.DataProtection.md +--- + +# Az.DataProtection Module +## Description +Microsoft Azure PowerShell: DataProtection cmdlets + +## Az.DataProtection Cmdlets +### [Backup-AzDataProtectionBackupInstanceAdhoc](Backup-AzDataProtectionBackupInstanceAdhoc.md) +Trigger adhoc backup + +### [Edit-AzDataProtectionPolicyRetentionRuleClientObject](Edit-AzDataProtectionPolicyRetentionRuleClientObject.md) +Adds or removes Retention Rule to existing Policy + +### [Edit-AzDataProtectionPolicyTagClientObject](Edit-AzDataProtectionPolicyTagClientObject.md) +Adds or removes schedule tag in an existing backup policy. + +### [Edit-AzDataProtectionPolicyTriggerClientObject](Edit-AzDataProtectionPolicyTriggerClientObject.md) +Updates Backup schedule of an existing backup policy. + +### [Find-AzDataProtectionRestorableTimeRange](Find-AzDataProtectionRestorableTimeRange.md) +Finds the valid recovery point in time ranges for the restore. + +### [Get-AzDataProtectionBackupInstance](Get-AzDataProtectionBackupInstance.md) +Gets a backup instance with name in a backup vault + +### [Get-AzDataProtectionBackupPolicy](Get-AzDataProtectionBackupPolicy.md) +Gets a backup policy belonging to a backup vault + +### [Get-AzDataProtectionBackupVault](Get-AzDataProtectionBackupVault.md) +Returns resource collection belonging to a subscription. + +### [Get-AzDataProtectionJob](Get-AzDataProtectionJob.md) +Gets a job with id in a backup vault + +### [Get-AzDataProtectionOperation](Get-AzDataProtectionOperation.md) +Returns the list of available operations. + +### [Get-AzDataProtectionOperationStatus](Get-AzDataProtectionOperationStatus.md) +Gets the operation status for a resource. + +### [Get-AzDataProtectionPolicyTemplate](Get-AzDataProtectionPolicyTemplate.md) +Gets default policy template for a selected datasource type. + +### [Get-AzDataProtectionRecoveryPoint](Get-AzDataProtectionRecoveryPoint.md) +Gets a Recovery Point using recoveryPointId for a Datasource. + +### [Get-AzDataProtectionResourceGuard](Get-AzDataProtectionResourceGuard.md) +Returns a ResourceGuard belonging to a resource group. + +### [Initialize-AzDataProtectionBackupInstance](Initialize-AzDataProtectionBackupInstance.md) +Initializes Backup instance Request object for configuring backup + +### [Initialize-AzDataProtectionRestoreRequest](Initialize-AzDataProtectionRestoreRequest.md) +Initializes Restore Request object for triggering restore on a protected backup instance. + +### [New-AzDataProtectionBackupConfigurationClientObject](New-AzDataProtectionBackupConfigurationClientObject.md) +Creates new backup configuration object + +### [New-AzDataProtectionBackupInstance](New-AzDataProtectionBackupInstance.md) +Configures Backup for supported azure resources + +### [New-AzDataProtectionBackupPolicy](New-AzDataProtectionBackupPolicy.md) +Creates a new backup policy in a given backup vault + +### [New-AzDataProtectionBackupVault](New-AzDataProtectionBackupVault.md) +Creates or updates a BackupVault resource belonging to a resource group. + +### [New-AzDataProtectionBackupVaultStorageSettingObject](New-AzDataProtectionBackupVaultStorageSettingObject.md) +Get Backup Vault storage setting object + +### [New-AzDataProtectionPolicyTagCriteriaClientObject](New-AzDataProtectionPolicyTagCriteriaClientObject.md) +Creates a new criteria object + +### [New-AzDataProtectionPolicyTriggerScheduleClientObject](New-AzDataProtectionPolicyTriggerScheduleClientObject.md) +Creates new Schedule object + +### [New-AzDataProtectionResourceGuard](New-AzDataProtectionResourceGuard.md) +Creates a resource guard under a resource group + +### [New-AzDataProtectionRestoreConfigurationClientObject](New-AzDataProtectionRestoreConfigurationClientObject.md) +Creates new restore configuration object + +### [New-AzDataProtectionRetentionLifeCycleClientObject](New-AzDataProtectionRetentionLifeCycleClientObject.md) +Creates new Lifecycle object + +### [Remove-AzDataProtectionBackupInstance](Remove-AzDataProtectionBackupInstance.md) +Delete a backupInstances + +### [Remove-AzDataProtectionBackupPolicy](Remove-AzDataProtectionBackupPolicy.md) +Deletes a backup policy belonging to a backup vault + +### [Remove-AzDataProtectionBackupVault](Remove-AzDataProtectionBackupVault.md) +Deletes a BackupVault resource from the resource group. + +### [Remove-AzDataProtectionResourceGuard](Remove-AzDataProtectionResourceGuard.md) +Deletes a ResourceGuard resource from the resource group. + +### [Resume-AzDataProtectionBackupInstanceProtection](Resume-AzDataProtectionBackupInstanceProtection.md) +This operation will resume protection for a stopped backup instance + +### [Search-AzDataProtectionBackupInstanceInAzGraph](Search-AzDataProtectionBackupInstanceInAzGraph.md) +Searches for Backup instances in Azure Resource Graph and retrieves the expected entries + +### [Search-AzDataProtectionJobInAzGraph](Search-AzDataProtectionJobInAzGraph.md) +Searches for Backup Jobs in Azure Resource Graph and retrieves the expected entries + +### [Set-AzDataProtectionMSIPermission](Set-AzDataProtectionMSIPermission.md) +Grants required permissions to the backup vault and other resources for configure backup and restore scenarios + +### [Start-AzDataProtectionBackupInstanceRestore](Start-AzDataProtectionBackupInstanceRestore.md) +Triggers restore for a BackupInstance + +### [Stop-AzDataProtectionBackupInstanceProtection](Stop-AzDataProtectionBackupInstanceProtection.md) +This operation will stop protection of a backup instance and data will be held forever + +### [Suspend-AzDataProtectionBackupInstanceBackup](Suspend-AzDataProtectionBackupInstanceBackup.md) +This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever) + +### [Sync-AzDataProtectionBackupInstance](Sync-AzDataProtectionBackupInstance.md) +Sync backup instance again in case of failure\r\nThis action will retry last failed operation and will bring backup instance to valid state + +### [Test-AzDataProtectionBackupInstanceReadiness](Test-AzDataProtectionBackupInstanceReadiness.md) +Validate whether adhoc backup will be successful or not + +### [Test-AzDataProtectionBackupInstanceRestore](Test-AzDataProtectionBackupInstanceRestore.md) +Validates if Restore can be triggered for a DataSource + +### [Update-AzDataProtectionBackupInstanceAssociatedPolicy](Update-AzDataProtectionBackupInstanceAssociatedPolicy.md) +Updates associated policy for a given backup instance + +### [Update-AzDataProtectionBackupVault](Update-AzDataProtectionBackupVault.md) +Updates a BackupVault resource belonging to a resource group. +For example, updating tags for a resource. + +### [Update-AzDataProtectionResourceGuard](Update-AzDataProtectionResourceGuard.md) +Updates a resource guard belonging to a resource group + diff --git a/azps-10.1.0/Az.DataProtection/Backup-AzDataProtectionBackupInstanceAdhoc.md b/azps-10.1.0/Az.DataProtection/Backup-AzDataProtectionBackupInstanceAdhoc.md new file mode 100644 index 0000000000..017a69d3eb --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Backup-AzDataProtectionBackupInstanceAdhoc.md @@ -0,0 +1,285 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/backup-azdataprotectionbackupinstanceadhoc +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Backup-AzDataProtectionBackupInstanceAdhoc.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Backup-AzDataProtectionBackupInstanceAdhoc.md +--- + +# Backup-AzDataProtectionBackupInstanceAdhoc + +## SYNOPSIS +Trigger adhoc backup + +## SYNTAX + +### BackupExpanded (Default) +``` +Backup-AzDataProtectionBackupInstanceAdhoc -BackupInstanceName <String> -ResourceGroupName <String> + -VaultName <String> -BackupRuleOptionRuleName <String> [-SubscriptionId <String>] + [-TriggerOptionRetentionTagOverride <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### BackupViaIdentityExpanded +``` +Backup-AzDataProtectionBackupInstanceAdhoc -InputObject <IDataProtectionIdentity> + -BackupRuleOptionRuleName <String> [-TriggerOptionRetentionTagOverride <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Trigger adhoc backup + +## EXAMPLES + +### Example 1: Backup a protected backup instance +```powershell +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "MyResourceGroup" -VaultName "MyVault" +Backup-AzDataProtectionBackupInstanceAdhoc -BackupInstanceName $instance.Name -ResourceGroupName "MyResourceGroup" -SubscriptionId "xxxx-xxx-xxxx" -VaultName "MyVault" -BackupRuleOptionRuleName "BackupWeekly" -TriggerOptionRetentionTagOverride "Default" +``` + +This Command Triggers Backup for a given backup instance. + +### Example 2: Backup a protected backup instance +```powershell +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "MyResourceGroup" -VaultName "MyVault" +$policy = Get-AzDataProtectionBackupPolicy -SubscriptionId $sub -VaultName "MyVault" -ResourceGroupName "MyResourceGroup" | Where-Object {$_.Name -eq "policyName"} +$backupJob = Backup-AzDataProtectionBackupInstanceAdhoc -BackupInstanceName $instance.Name -ResourceGroupName "MyResourceGroup" -SubscriptionId "xxxx-xxx-xxxx" -VaultName "MyVault" -BackupRuleOptionRuleName $policy.Property.PolicyRule[0].Name -TriggerOptionRetentionTagOverride $policy.Property.PolicyRule[0].Trigger.TaggingCriterion[0].TagInfoTagName +$jobid = $backupJob.JobId.Split("/")[-1] +$jobstatus = "InProgress" +while($jobstatus -ne "Completed") +{ + Start-Sleep -Seconds 10 + $currentjob = Get-AzDataProtectionJob -Id $jobid -SubscriptionId $sub -ResourceGroupName $rgName -VaultName $vaultName + $jobstatus = $currentjob.Status +} +``` + +This Command Triggers Backup for a given backup instance using protection policy used to protect the backup instance. +Then we track the backup job in a loop until it's completed. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupInstanceName +The name of the backup instance. + +```yaml +Type: System.String +Parameter Sets: BackupExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRuleOptionRuleName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: BackupExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: BackupExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerOptionRetentionTagOverride +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: BackupExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IOperationJobExtendedInfo + +## 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 <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md b/azps-10.1.0/Az.DataProtection/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md new file mode 100644 index 0000000000..4d500b7611 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/edit-azdataprotectionpolicyretentionruleclientobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md +--- + +# Edit-AzDataProtectionPolicyRetentionRuleClientObject + +## SYNOPSIS +Adds or removes Retention Rule to existing Policy + +## SYNTAX + +### RemoveRetention (Default) +``` +Edit-AzDataProtectionPolicyRetentionRuleClientObject -Name <RetentionRuleName> -Policy <IBackupPolicy> + -RemoveRule [<CommonParameters>] +``` + +### AddRetention +``` +Edit-AzDataProtectionPolicyRetentionRuleClientObject -IsDefault <Boolean> -LifeCycles <ISourceLifeCycle[]> + -Name <RetentionRuleName> -Policy <IBackupPolicy> [-OverwriteLifeCycle <Boolean?>] [<CommonParameters>] +``` + +## DESCRIPTION +Adds or removes Retention Rule to existing Policy + +## EXAMPLES + +### Example 1: Add Weekly Retention Rule +```powershell +$pol = Get-AzDataProtectionPolicyTemplate +$lifecycle = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore OperationalStore -SourceRetentionDurationType Weeks -SourceRetentionDurationCount 5 +Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $pol -Name Weekly -LifeCycles $lifecycle -IsDefault $false +``` + +```output +DatasourceType ObjectType +-------------- ---------- +{Microsoft.Compute/disks} BackupPolicy +``` + +The first command gets the default policy template. +The second command creates a weekly lifecycle object. +The third command adds a weekly retention rule to the default policy. + +### Example 2: Remove Weekly Retention Rule +```powershell +Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $pol -Name Weekly -RemoveRule +``` + +```output +DatasourceType ObjectType +-------------- ---------- +{Microsoft.Compute/disks} BackupPolicy +``` + +This command removes weekly retention rule if it exists in given backup policy. + +## PARAMETERS + +### -IsDefault +Specifies if retention rule is default retention rule. + +```yaml +Type: System.Boolean +Parameter Sets: AddRetention +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LifeCycles +Life cycles associated with the retention rule. +To construct, see NOTES section for LIFECYCLES properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.ISourceLifeCycle[] +Parameter Sets: AddRetention +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Retention Rule Name + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.RetentionRuleName +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverwriteLifeCycle +Specifies whether to modify an existing LifeCycle. + +```yaml +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: AddRetention +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Backup Policy Object +To construct, see NOTES section for POLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupPolicy +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveRule +Specifies whether to remove the retention rule. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RemoveRetention +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupPolicy + +## 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. + + +`LIFECYCLES <ISourceLifeCycle[]>`: Life cycles associated with the retention rule. + - `DeleteAfterDuration <String>`: Duration of deletion after given timespan + - `DeleteAfterObjectType <String>`: Type of the specific object - used for deserializing + - `SourceDataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `SourceDataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `[TargetDataStoreCopySetting <ITargetCopySetting[]>]`: + - `CopyAfterObjectType <String>`: Type of the specific object - used for deserializing + - `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + +`POLICY <IBackupPolicy>`: Backup Policy Object + - `DatasourceType <String[]>`: Type of datasource for the backup management + - `ObjectType <String>`: + - `PolicyRule <IBasePolicyRule[]>`: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc + - `Name <String>`: + - `ObjectType <String>`: + - `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `TriggerObjectType <String>`: Type of the specific object - used for deserializing + - `Lifecycle <ISourceLifeCycle[]>`: + - `DeleteAfterDuration <String>`: Duration of deletion after given timespan + - `DeleteAfterObjectType <String>`: Type of the specific object - used for deserializing + - `SourceDataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `SourceDataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `[TargetDataStoreCopySetting <ITargetCopySetting[]>]`: + - `CopyAfterObjectType <String>`: Type of the specific object - used for deserializing + - `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `[BackupParameterObjectType <String>]`: Type of the specific object - used for deserializing + - `[IsDefault <Boolean?>]`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Edit-AzDataProtectionPolicyTagClientObject.md b/azps-10.1.0/Az.DataProtection/Edit-AzDataProtectionPolicyTagClientObject.md new file mode 100644 index 0000000000..1b8f574288 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Edit-AzDataProtectionPolicyTagClientObject.md @@ -0,0 +1,176 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/edit-azdataprotectionpolicytagclientobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Edit-AzDataProtectionPolicyTagClientObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Edit-AzDataProtectionPolicyTagClientObject.md +--- + +# Edit-AzDataProtectionPolicyTagClientObject + +## SYNOPSIS +Adds or removes schedule tag in an existing backup policy. + +## SYNTAX + +### RemoveTag (Default) +``` +Edit-AzDataProtectionPolicyTagClientObject -Name <TagName> -Policy <IBackupPolicy> -RemoveRule + [<CommonParameters>] +``` + +### updateTag +``` +Edit-AzDataProtectionPolicyTagClientObject -Criteria <IScheduleBasedBackupCriteria[]> -Name <TagName> + -Policy <IBackupPolicy> [<CommonParameters>] +``` + +## DESCRIPTION +Adds or removes schedule tag in an existing backup policy. + +## EXAMPLES + +### Example 1: Add Weekly tag to Backup Policy +```powershell +$criteria = New-AzDataProtectionPolicyTagCriteriaClientObject -AbsoluteCriteria FirstOfWeek +Edit-AzDataProtectionPolicyTagClientObject -Policy $pol -Name Weekly -Criteria $criteria +``` + +```output +DatasourceType ObjectType +-------------- ---------- +{Microsoft.Compute/disks} BackupPolicy +``` + +This command adds a weekly tag to given backup policy + +### Example 2: Remove Weeky tag from Backup Policy +```powershell +Edit-AzDataProtectionPolicyTagClientObject -Policy $pol -Name Weekly -RemoveRule +``` + +```output +DatasourceType ObjectType +-------------- ---------- +{Microsoft.Compute/disks} BackupPolicy +``` + +This command removes Weekly tag from backup policy. + +## PARAMETERS + +### -Criteria +Criterias to be associated with the schedule tag. +To construct, see NOTES section for CRITERIA properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IScheduleBasedBackupCriteria[] +Parameter Sets: updateTag +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Schedule tag. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.TagName +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Backup Policy Object. +To construct, see NOTES section for POLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupPolicy +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveRule +Specify whether to remove the tag from the given policy object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RemoveTag +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupPolicy + +## 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. + + +`CRITERIA <IScheduleBasedBackupCriteria[]>`: Criterias to be associated with the schedule tag. + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[AbsoluteCriterion <AbsoluteMarker[]>]`: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum + - `[DaysOfMonth <IDay[]>]`: This is day of the month from 1 to 28 other wise last of month + - `[Date <Int32?>]`: Date of the month + - `[IsLast <Boolean?>]`: Whether Date is last date of month + - `[DaysOfTheWeek <DayOfWeek[]>]`: It should be Sunday/Monday/T..../Saturday + - `[MonthsOfYear <Month[]>]`: It should be January/February/....../December + - `[ScheduleTime <DateTime[]>]`: List of schedule times for backup + - `[WeeksOfTheMonth <WeekNumber[]>]`: It should be First/Second/Third/Fourth/Last + +`POLICY <IBackupPolicy>`: Backup Policy Object. + - `DatasourceType <String[]>`: Type of datasource for the backup management + - `ObjectType <String>`: + - `PolicyRule <IBasePolicyRule[]>`: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc + - `Name <String>`: + - `ObjectType <String>`: + - `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `TriggerObjectType <String>`: Type of the specific object - used for deserializing + - `Lifecycle <ISourceLifeCycle[]>`: + - `DeleteAfterDuration <String>`: Duration of deletion after given timespan + - `DeleteAfterObjectType <String>`: Type of the specific object - used for deserializing + - `SourceDataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `SourceDataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `[TargetDataStoreCopySetting <ITargetCopySetting[]>]`: + - `CopyAfterObjectType <String>`: Type of the specific object - used for deserializing + - `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `[BackupParameterObjectType <String>]`: Type of the specific object - used for deserializing + - `[IsDefault <Boolean?>]`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Edit-AzDataProtectionPolicyTriggerClientObject.md b/azps-10.1.0/Az.DataProtection/Edit-AzDataProtectionPolicyTriggerClientObject.md new file mode 100644 index 0000000000..12f3707a0d --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Edit-AzDataProtectionPolicyTriggerClientObject.md @@ -0,0 +1,135 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/edit-azdataprotectionpolicytriggerclientobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Edit-AzDataProtectionPolicyTriggerClientObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Edit-AzDataProtectionPolicyTriggerClientObject.md +--- + +# Edit-AzDataProtectionPolicyTriggerClientObject + +## SYNOPSIS +Updates Backup schedule of an existing backup policy. + +## SYNTAX + +### RemoveBackupSchedule (Default) +``` +Edit-AzDataProtectionPolicyTriggerClientObject -Policy <IBackupPolicy> -RemoveSchedule [<CommonParameters>] +``` + +### ModifyBackupSchedule +``` +Edit-AzDataProtectionPolicyTriggerClientObject -Policy <IBackupPolicy> -Schedule <String[]> + [<CommonParameters>] +``` + +## DESCRIPTION +Updates Backup schedule of an existing backup policy. + +## EXAMPLES + +### Example 1: Add Daily schedule to Azure Backup rule. +```powershell +$schedule = New-AzDataProtectionPolicyTriggerScheduleClientObject -ScheduleDays (Get-Date) -IntervalType Daily -IntervalCount 1 +Edit-AzDataProtectionPolicyTriggerClientObject -Policy $pol -Schedule $schedule +``` + +```output +DatasourceType ObjectType +-------------- ---------- +{Microsoft.Compute/disks} BackupPolicy +``` + +This command updates backup schedule of given policy to daily backup. + +## PARAMETERS + +### -Policy +Backup Policy object. +To construct, see NOTES section for POLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupPolicy +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSchedule +Specifies whether to remove the backup Schedule. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RemoveBackupSchedule +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schedule +Schedule to be associated to backup policy. + +```yaml +Type: System.String[] +Parameter Sets: ModifyBackupSchedule +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupPolicy + +## 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. + + +`POLICY <IBackupPolicy>`: Backup Policy object. + - `DatasourceType <String[]>`: Type of datasource for the backup management + - `ObjectType <String>`: + - `PolicyRule <IBasePolicyRule[]>`: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc + - `Name <String>`: + - `ObjectType <String>`: + - `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `TriggerObjectType <String>`: Type of the specific object - used for deserializing + - `Lifecycle <ISourceLifeCycle[]>`: + - `DeleteAfterDuration <String>`: Duration of deletion after given timespan + - `DeleteAfterObjectType <String>`: Type of the specific object - used for deserializing + - `SourceDataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `SourceDataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `[TargetDataStoreCopySetting <ITargetCopySetting[]>]`: + - `CopyAfterObjectType <String>`: Type of the specific object - used for deserializing + - `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `[BackupParameterObjectType <String>]`: Type of the specific object - used for deserializing + - `[IsDefault <Boolean?>]`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Find-AzDataProtectionRestorableTimeRange.md b/azps-10.1.0/Az.DataProtection/Find-AzDataProtectionRestorableTimeRange.md new file mode 100644 index 0000000000..3a98696dd6 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Find-AzDataProtectionRestorableTimeRange.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/find-azdataprotectionrestorabletimerange +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Find-AzDataProtectionRestorableTimeRange.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Find-AzDataProtectionRestorableTimeRange.md +--- + +# Find-AzDataProtectionRestorableTimeRange + +## SYNOPSIS +Finds the valid recovery point in time ranges for the restore. + +## SYNTAX + +``` +Find-AzDataProtectionRestorableTimeRange -BackupInstanceName <String> -ResourceGroupName <String> + -VaultName <String> -SourceDataStoreType <RestoreSourceDataStoreType> [-SubscriptionId <String>] + [-EndTime <String>] [-StartTime <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Finds the valid recovery point in time ranges for the restore. + +## EXAMPLES + +### Example 1: Fetch valid restorable time ranges for a BackupInstance +```powershell +$startTime = (Get-Date).AddDays(-30).ToString("yyyy-MM-ddTHH:mm:ss.0000000Z") +$endTime = (Get-Date).AddDays(0).ToString("yyyy-MM-ddTHH:mm:ss.0000000Z") +$instances = Search-AzDataProtectionBackupInstanceInAzGraph -Subscription "subscriptionId" -DatasourceType AzureBlob -ResourceGroup "rgName" -Vault "vaultName" +$pointInTimeRange = Find-AzDataProtectionRestorableTimeRange -BackupInstanceName $instances[0].BackupInstanceName -ResourceGroupName "rgName" -SubscriptionId "subscriptionId" -VaultName "vaultName" -SourceDataStoreType OperationalStore -StartTime $startTime -EndTime $endTime +$pointInTimeRange.RestorableTimeRange | Format-List +``` + +```output +EndTime : 2021-04-24T08:57:36.4149422Z +ObjectType : RestorableTimeRange +StartTime : 2021-03-25T14:27:31.0000000Z +``` + +Set $startTime and $endTime. +Fetch the backup instance. +Fetch valid time ranges for Backup Instance $instance[0]. +Dispaly RestorableTimeRange, note that this can be multiple dicrete ranges. + +## PARAMETERS + +### -BackupInstanceName +The name of the backup instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +End time for the List Restore Ranges request. +ISO 8601 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDataStoreType +Gets or sets the type of the source data store. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.RestoreSourceDataStoreType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Start time for the List Restore Ranges request. +ISO 8601 format. + +```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. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IAzureBackupFindRestorableTimeRangesResponseResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionBackupInstance.md b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionBackupInstance.md new file mode 100644 index 0000000000..c8adc5b0e5 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionBackupInstance.md @@ -0,0 +1,198 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/get-azdataprotectionbackupinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionBackupInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionBackupInstance.md +--- + +# Get-AzDataProtectionBackupInstance + +## SYNOPSIS +Gets a backup instance with name in a backup vault + +## SYNTAX + +### List (Default) +``` +Get-AzDataProtectionBackupInstance -ResourceGroupName <String> -VaultName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDataProtectionBackupInstance -Name <String> -ResourceGroupName <String> -VaultName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDataProtectionBackupInstance -InputObject <IDataProtectionIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a backup instance with name in a backup vault + +## EXAMPLES + +### Example 1: Get all the backup instances protected in a specified backup vault. +```powershell +Get-AzDataProtectionBackupInstance -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "MyResourceGroup" -VaultName "MyVault" +``` + +```output +Name Type BackupInstanceName +---- ---- ------------------ +sarathdisk-sarathdisk-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft.DataProtection/backupVaults/backupInstances sarathdisk-sarathdisk-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +sarathdisk2-sarathdisk2-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxcc Microsoft.DataProtection/backupVaults/backupInstances sarathdisk2-sarathdisk2-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +``` + +This command gets all the backup instances in a vault. + +### Example 2: Get a backup instance by name. +```powershell +Get-AzDataProtectionBackupInstance -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "MyResourceGroup" -VaultName "MyVault" -Name "BackupInstanceName" +``` + +```output +Name Type BackupInstanceName +---- ---- ------------------ +sarathdisk-sarathdisk-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft.DataProtection/backupVaults/backupInstances sarathdisk-sarathdisk-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +``` + +This command gets a specific backup instance protected in a backup vault. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the backup instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: BackupInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupInstanceResource + +## 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 <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionBackupPolicy.md b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionBackupPolicy.md new file mode 100644 index 0000000000..ed4f09ea7d --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionBackupPolicy.md @@ -0,0 +1,198 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/get-azdataprotectionbackuppolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionBackupPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionBackupPolicy.md +--- + +# Get-AzDataProtectionBackupPolicy + +## SYNOPSIS +Gets a backup policy belonging to a backup vault + +## SYNTAX + +### List (Default) +``` +Get-AzDataProtectionBackupPolicy -ResourceGroupName <String> -VaultName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDataProtectionBackupPolicy -Name <String> -ResourceGroupName <String> -VaultName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDataProtectionBackupPolicy -InputObject <IDataProtectionIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a backup policy belonging to a backup vault + +## EXAMPLES + +### Example 1: Get all backup policies in a backup vault. +```powershell +Get-AzDataProtectionBackupPolicy -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "MyResourceGroup" -VaultName "MyVault" +``` + +```output +Name Type +---- ---- +DiskPolicy1 Microsoft.DataProtection/backupVaults/backupPolicies +DiskDailyPolicy Microsoft.DataProtection/backupVaults/backupPolicies +``` + +This command gets backup policies created in a given backup vault. + +### Example 2: Get backup policy by Name +```powershell +Get-AzDataProtectionBackupPolicy -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "MyResourceGroup" -VaultName "MyVault" -Name "MyPolicy" +``` + +```output +Name Type +---- ---- +MyPolicy Microsoft.DataProtection/backupVaults/backupPolicies +``` + +This command gets a backup policy by name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: BackupPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBaseBackupPolicyResource + +## 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 <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionBackupVault.md b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionBackupVault.md new file mode 100644 index 0000000000..0900c07a2f --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionBackupVault.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/get-azdataprotectionbackupvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionBackupVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionBackupVault.md +--- + +# Get-AzDataProtectionBackupVault + +## SYNOPSIS +Returns resource collection belonging to a subscription. + +## SYNTAX + +### Get (Default) +``` +Get-AzDataProtectionBackupVault [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get1 +``` +Get-AzDataProtectionBackupVault -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get2 +``` +Get-AzDataProtectionBackupVault -ResourceGroupName <String> -VaultName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDataProtectionBackupVault -InputObject <IDataProtectionIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns resource collection belonging to a subscription. + +## EXAMPLES + +### Example 1: Get all backup vaults in a given subscription +```powershell +Get-AzDataProtectionBackupVault +``` + +```output +ETag IdentityPrincipalId IdentityTenantId IdentityType Location Name Type +---- ------------------- ---------------- ------------ -------- ---- ---- + xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx SystemAssigned westus adigupt-backupcenter-ga-Vault Microsoft.DataProtection/backupVault + xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx SystemAssigned westcentralus BC-Usability-Vault-WCUS Microsoft.DataProtection/backupVault + xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx SystemAssigned centraluseuap NilayBackupVault Microsoft.DataProtection/backupVault + xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx SystemAssigned centraluseuap dpprunnervaultus Microsoft.DataProtection/backupVault +``` + +This command gets all backup vaults in current subscription context. +Provide SubscriptionId parameter to retrieve backup vaults in a different subscription. + +### Example 2: Get all backup vaults in a given resource Group. +```powershell +Get-AzDataProtectionBackupVault -SubscriptionId "xxxx-xxx-xxxx" -ResourceGroupName sarath-rg +``` + +```output +ETag IdentityPrincipalId IdentityTenantId IdentityType Location Name Type +---- ------------------- ---------------- ------------ -------- ---- ---- + xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx SystemAssigned centraluseuap sarath-dppvault Microsoft.DataProtection/backupVaults + xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx SystemAssigned centraluseuap sarath-vault Microsoft.DataProtection/backupVaults +``` + +This command gets all backup vaults in a given resource group. + +### Example 3: Get a specific vault. +```powershell +Get-AzDataProtectionBackupVault -SubscriptionId "xxxx-xxx-xxxx" -ResourceGroupName sarath-rg -VaultName sarath-vault +``` + +```output +ETag IdentityPrincipalId IdentityTenantId IdentityType Location Name Type +---- ------------------- ---------------- ------------ -------- ---- ---- + xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx SystemAssigned centraluseuap sarath-vault Microsoft.DataProtection/backupVaults +``` + +This command gets a specific vault by given vault name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get1, Get2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, Get1, Get2 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: Get2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupVaultResource + +## 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 <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionJob.md b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionJob.md new file mode 100644 index 0000000000..6d4f0439b3 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionJob.md @@ -0,0 +1,204 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/get-azdataprotectionjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionJob.md +--- + +# Get-AzDataProtectionJob + +## SYNOPSIS +Gets a job with id in a backup vault + +## SYNTAX + +### List (Default) +``` +Get-AzDataProtectionJob -ResourceGroupName <String> -VaultName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDataProtectionJob -Id <String> -ResourceGroupName <String> -VaultName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDataProtectionJob -InputObject <IDataProtectionIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a job with id in a backup vault + +## EXAMPLES + +### Example 1: Get All backup Jobs in a backup vault +```powershell +Get-AzDataProtectionJob -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName sarath-rg -VaultName sarath-vault +``` + +```output +Name Type +---- ---- +a6a4879d-f914-4174-b129-0e27da8a4fb0 Microsoft.DataProtection/backupVaults/backupJobs +1a402664-a245-4a9d-8bb5-a6bafbb40d26 Microsoft.DataProtection/backupVaults/backupJobs +672564f7-1f91-46e2-a0ca-4fb1dc977a1c Microsoft.DataProtection/backupVaults/backupJobs +1653a7b4-8ce4-457e-8084-dc1c9d9e4106 Microsoft.DataProtection/backupVaults/backupJobs +9f21c438-ca0d-45c1-88fe-79f08a8342c7 Microsoft.DataProtection/backupVaults/backupJobs +736bab4d-480f-49f8-92ea-57c5ff203c33 Microsoft.DataProtection/backupVaults/backupJobs +``` + +This command gets all the backup jobs in a given backup vault. + +### Example 2: Get a single Job +```powershell +Get-AzDataProtectionJob -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName sarath-rg -VaultName sarath-vault -Id 4abaea8c-f53a-4bb1-9963-59f96b597165 +``` + +```output +Name Type +---- ---- +4abaea8c-f53a-4bb1-9963-59f96b597165 Microsoft.DataProtection/backupVaults/backupJobs +``` + +This command returns a single job entity with given Id. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The Job ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: JobId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IAzureBackupJobResource + +## 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 <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionOperation.md b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionOperation.md new file mode 100644 index 0000000000..d12f9c1c1b --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionOperation.md @@ -0,0 +1,122 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/get-azdataprotectionoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionOperation.md +--- + +# Get-AzDataProtectionOperation + +## SYNOPSIS +Returns the list of available operations. + +## SYNTAX + +``` +Get-AzDataProtectionOperation [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns the list of available operations. + +## EXAMPLES + +### Example 1: Get the list of of available operations +```powershell +Get-AzDataProtectionOperation +``` + +```output +IsDataAction Name Origin +------------ ---- ------ + Microsoft.DataProtection/locations/getBackupStatus/action user + Microsoft.DataProtection/backupVaults/backupInstances/write user + Microsoft.DataProtection/backupVaults/backupInstances/delete user + Microsoft.DataProtection/backupVaults/backupInstances/read user + Microsoft.DataProtection/backupVaults/backupInstances/read user + Microsoft.DataProtection/backupVaults/backupInstances/backup/action user + Microsoft.DataProtection/backupVaults/backupInstances/sync/action user + Microsoft.DataProtection/backupVaults/backupInstances/operationResults/read user + Microsoft.DataProtection/backupVaults/backupInstances/stopProtection/action user + Microsoft.DataProtection/backupVaults/backupInstances/suspendBackups/action user + Microsoft.DataProtection/backupVaults/backupInstances/resumeProtection/action user + Microsoft.DataProtection/backupVaults/backupInstances/resumeBackups/action user + Microsoft.DataProtection/backupVaults/backupInstances/validateRestore/action user + Microsoft.DataProtection/backupVaults/backupInstances/restore/action user + Microsoft.DataProtection/backupVaults/backupPolicies/write user + Microsoft.DataProtection/backupVaults/backupPolicies/delete user + Microsoft.DataProtection/backupVaults/backupPolicies/read user + Microsoft.DataProtection/backupVaults/backupPolicies/read user + Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read user + Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read user + Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/write user + Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete user + Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/unlockDelete/action user + Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read user + Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read user + Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges/action user + Microsoft.DataProtection/backupVaults/write user + Microsoft.DataProtection/backupVaults/read user + Microsoft.DataProtection/backupVaults/delete user + Microsoft.DataProtection/backupVaults/operationResults/read user + Microsoft.DataProtection/locations/checkNameAvailability/action user + Microsoft.DataProtection/backupVaults/read user + Microsoft.DataProtection/backupVaults/read user + Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write user + Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read user + Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/delete user + Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read user + Microsoft.DataProtection/subscriptions/providers/resourceGuards/read user + Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write user + Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read user + Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read user + Microsoft.DataProtection/subscriptions/providers/locations/checkFeatureSupport/action user + Microsoft.DataProtection/locations/operationStatus/read user + Microsoft.DataProtection/backupVaults/operationStatus/read user + Microsoft.DataProtection/subscriptions/resourceGroups/providers/operationStatus/read user + Microsoft.DataProtection/locations/operationResults/read user + Microsoft.DataProtection/backupVaults/validateForBackup/action user + Microsoft.DataProtection/backupVaults/backupJobs/read user + Microsoft.RecoveryServices/Vaults/backupJobs/read user + Microsoft.DataProtection/register/action user + Microsoft.DataProtection/unregister/action user + Microsoft.DataProtection/operations/read user +``` + +The above command gets the list of available operations. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IClientDiscoveryValueForSingleApi + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionOperationStatus.md b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionOperationStatus.md new file mode 100644 index 0000000000..c87f57140e --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionOperationStatus.md @@ -0,0 +1,171 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/get-azdataprotectionoperationstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionOperationStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionOperationStatus.md +--- + +# Get-AzDataProtectionOperationStatus + +## SYNOPSIS +Gets the operation status for a resource. + +## SYNTAX + +### Get (Default) +``` +Get-AzDataProtectionOperationStatus -Location <String> -OperationId <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDataProtectionOperationStatus -InputObject <IDataProtectionIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the operation status for a resource. + +## EXAMPLES + +### Example 1: Get operation status for a long running operation +```powershell +$operationResponse = Test-AzDataProtectionBackupInstanceReadiness -ResourceGroupName $resourceGroupName -VaultName $vaultName -SubscriptionId $subId -BackupInstance $backupInstanceClientObject.Property -NoWait +$operationId = $operationResponse.Target.Split("/")[-1].Split("?")[0] +Get-AzDataProtectionOperationStatus -OperationId $operationId -Location $vault.Location -SubscriptionId $subId +While((Get-AzDataProtectionOperationStatus -OperationId $operationId -Location $vault.Location -SubscriptionId $subId).Status -eq "Inprogress"){ + Start-Sleep -Seconds 10 +} +``` + +```output +EndTime Name StartTime Status +------- ---- --------- ------ +5/6/2023 11:44:42 AM N2E2NGU0YzItMzZjNC00MDUwLTlmZGYtMGNlZTFjMmI4MWRhO2U3MjRiMGExLTM3NGItNGYwYS05ZDRlLTQxZWQ5Nzg5MzhkZg== 5/6/2023 11:44:21 AM Succeeded +``` + +First command fetches the operation response for a long running operation, using the the parameter -NoWait. +This is to run the operation in async mode. +Second command splits the operationResponse to get the operationId. +Third command fetches the operation status in async way. +Fourth command fetches the operation status in a loop until it succeeds, while waiting 10 seconds before each iteration. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Azure region where the operation is triggered. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationId +Operation Id to track the operation status. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IOperationResource + +## 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 <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionPolicyTemplate.md b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionPolicyTemplate.md new file mode 100644 index 0000000000..0027dab98d --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionPolicyTemplate.md @@ -0,0 +1,71 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/get-azdataprotectionpolicytemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionPolicyTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionPolicyTemplate.md +--- + +# Get-AzDataProtectionPolicyTemplate + +## SYNOPSIS +Gets default policy template for a selected datasource type. + +## SYNTAX + +``` +Get-AzDataProtectionPolicyTemplate -DatasourceType <DatasourceTypes> [<CommonParameters>] +``` + +## DESCRIPTION +Gets default policy template for a selected datasource type. + +## EXAMPLES + +### Example 1: Get Azure Disk default policy template +```powershell +Get-AzDataProtectionPolicyTemplate -DatasourceType AzureDisk +``` + +```output +DatasourceType ObjectType +-------------- ---------- +{Microsoft.Compute/disks} BackupPolicy +``` + +This command returns a default policy template for a given datasource type. +Use this policy template to create a new policy. + +## PARAMETERS + +### -DatasourceType +Datasource Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DatasourceTypes +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupPolicy + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionRecoveryPoint.md b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionRecoveryPoint.md new file mode 100644 index 0000000000..fe3e4183a0 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionRecoveryPoint.md @@ -0,0 +1,252 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/get-azdataprotectionrecoverypoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionRecoveryPoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionRecoveryPoint.md +--- + +# Get-AzDataProtectionRecoveryPoint + +## SYNOPSIS +Gets a Recovery Point using recoveryPointId for a Datasource. + +## SYNTAX + +### List (Default) +``` +Get-AzDataProtectionRecoveryPoint [-BackupInstanceName <String>] [-ResourceGroupName <String>] + [-SubscriptionId <String[]>] [-VaultName <String>] [-DefaultProfile <PSObject>] [-EndTime <DateTime>] + [-StartTime <DateTime>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDataProtectionRecoveryPoint -BackupInstanceName <String> -Id <String> -ResourceGroupName <String> + -VaultName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDataProtectionRecoveryPoint -InputObject <IDataProtectionIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Recovery Point using recoveryPointId for a Datasource. + +## EXAMPLES + +### Example 1: Get all recovery points of a given backup instance +```powershell +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName sarath-rg -VaultName sarath-vault +Get-AzDataProtectionRecoveryPoint -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName sarath-rg -VaultName sarath-vault -BackupInstanceName $instance[2].Name +``` + +```output +Name Type +---- ---- +aded40a562134f97b732f30d0b486fef Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints +f458438d5ebb4098adbf67e9655cb624 Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints +515ba70e49d34b2bbff033dcc08593fe Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints +e61293fdd1064fbdb4f42b7f5927a927 Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints +aecc362b85484f4eb905bb05ef445e3e Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints +dc814d61a9624c36a1f9d635bc0b80f0 Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints +``` + +This command lists all available recovery points of a given backup instance + +### Example 2: Get recovery point with given recovery point id. +```powershell +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName sarath-rg -VaultName sarath-vault +Get-AzDataProtectionRecoveryPoint -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName sarath-rg -VaultName sarath-vault -BackupInstanceName $instance[2].Name -Id 892e5c5014dc4a96807d22924f5745c9 +``` + +```output +Name Type +---- ---- +892e5c5014dc4a96807d22924f5745c9 Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints +``` + +This command returns a recovery point with given id. + +## PARAMETERS + +### -BackupInstanceName +The name of the backup instance. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +End Time filter for recovery points + +```yaml +Type: System.DateTime +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RecoveryPointId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Start Time filter for recovery points + +```yaml +Type: System.DateTime +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IAzureBackupRecoveryPointResource + +### System.Management.Automation.PSObject + +## 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 <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionResourceGuard.md b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionResourceGuard.md new file mode 100644 index 0000000000..0743364a50 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Get-AzDataProtectionResourceGuard.md @@ -0,0 +1,185 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/get-azdataprotectionresourceguard +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionResourceGuard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Get-AzDataProtectionResourceGuard.md +--- + +# Get-AzDataProtectionResourceGuard + +## SYNOPSIS +Returns a ResourceGuard belonging to a resource group. + +## SYNTAX + +### Get1 (Default) +``` +Get-AzDataProtectionResourceGuard -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDataProtectionResourceGuard -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDataProtectionResourceGuard -InputObject <IDataProtectionIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns a ResourceGuard belonging to a resource group. + +## EXAMPLES + +### Example 1: Fetch a resource guard with a particular Name +```powershell +Get-AzDataProtectionResourceGuard -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "RGName" -Name "ResourceGuardName" +``` + +```output +ETag Id IdentityPrincipalId IdentityTenantId IdentityType Location Name +---- -- ------------------- ---------------- ------------ -------- ---- + /subscriptions/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RGName/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardName centraluseuap ResourceGuardName +``` + +Gets a resource guard under a resource group with name "ResourceGuardName" + +### Example 2: Fetch all the resource guards under a resource group +```powershell +Get-AzDataProtectionResourceGuard -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "RGName" +``` + +```output +ETag Id IdentityPrincipalId IdentityTenantId IdentityType Location Name Type +---- -- ------------------- ---------------- ------------ -------- ---- ---- + /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/RGName/providers/Microsoft.DataProtection/resourceGuards/rguard1 centraluseuap rguard1 Microsoft.DataProtection/resourceGuards + /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/RGName/providers/Microsoft.DataProtection/resourceGuards/rguard2 centraluseuap rguard2 Microsoft.DataProtection/resourceGuards + /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RGName/providers/Microsoft.DataProtection/resourceGuards/rguard3 centraluseuap rguard3 Microsoft.DataProtection/resourceGuards + /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RGName/providers/Microsoft.DataProtection/resourceGuards/rguard4 centraluseuap rguard4 Microsoft.DataProtection/resourceGuards +``` + +Gets all resource guards under a resource group + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of ResourceGuard + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, Get1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, Get1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IResourceGuardResource + +## 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 <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Initialize-AzDataProtectionBackupInstance.md b/azps-10.1.0/Az.DataProtection/Initialize-AzDataProtectionBackupInstance.md new file mode 100644 index 0000000000..b06813e81b --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Initialize-AzDataProtectionBackupInstance.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/initialize-azdataprotectionbackupinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Initialize-AzDataProtectionBackupInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Initialize-AzDataProtectionBackupInstance.md +--- + +# Initialize-AzDataProtectionBackupInstance + +## SYNOPSIS +Initializes Backup instance Request object for configuring backup + +## SYNTAX + +``` +Initialize-AzDataProtectionBackupInstance -DatasourceLocation <String> -DatasourceType <DatasourceTypes> + [-BackupConfiguration <IBackupDatasourceParameters>] [-DatasourceId <String>] [-FriendlyName <String>] + [-PolicyId <String>] [-SecretStoreType <SecretStoreTypes>] [-SecretStoreURI <String>] + [-SnapshotResourceGroupId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Initializes Backup instance Request object for configuring backup + +## EXAMPLES + +### Example 1: Initialize Backup instance object for Azure Disk +```powershell +$policy = Get-AzDataProtectionBackupPolicy -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName sarath-rg -VaultName sarath-vault +$AzureDiskId = "/subscriptions/{subscription}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/disks/{diskname}" +$instance = Initialize-AzDataProtectionBackupInstance -DatasourceType AzureDisk -DatasourceLocation westus -DatasourceId $AzureDiskId -PolicyId $policy[0].Id +$instance.Property.PolicyInfo.PolicyParameter.DataStoreParametersList[0].ResourceGroupId = "/subscriptions/{subscription}/resourceGroups/{snapshotResourceGroup}" +$instance +``` + +```output +Name Type BackupInstanceName +---- ---- ------------------ + sarath-disk3-sarath-disk3-af697a80-e2bc-49f1-af6c-22f6c4d68405 +``` + +The First command gets all the policies in a given vault. +The second command stores azure disk's resource id in $AzureDiskId +variable. +The third command returns a backup instance resource for Azure Disk. +The fourth command sets the snapshot resource group field. +This object can now be used to configure backup for the given disk. + +### Example 2: Initialize Backup instance object for AzureKubernetesService +```powershell +$policy = Get-AzDataProtectionBackupPolicy -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" -ResourceGroupName "resourceGroupName" | where {$_.Name -eq "policyName"} +$sourceClusterId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.ContainerService/managedClusters/aks-cluster" +$snapshotResourceGroupId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName" +$backupConfig = New-AzDataProtectionBackupConfigurationClientObject -SnapshotVolume $true -IncludeClusterScopeResource $true -DatasourceType AzureKubernetesService -LabelSelector "x=y","foo=bar" +$backupInstance = Initialize-AzDataProtectionBackupInstance -DatasourceType AzureKubernetesService -DatasourceLocation "eastus" -PolicyId $policy.Id -DatasourceId $sourceClusterId -SnapshotResourceGroupId $snapshotResourceGroupId -FriendlyName "aks-cluster-friendlyName" -BackupConfiguration $backupConfig +$instance +``` + +```output +Name BackupInstanceName +---- ------------------ + aks-cluster-aks-cluster-ed68435e-069t-4b4a-9d84-d0c194800fc2 +``` + +The First command gets the AzureKubernetesService policy in a given vault. +The second, third command initializes the AKS cluster and snapshot resource group Id. +The fourth command backup configuration object needed for AzureKubernetesService. +The fifth command initializes the client object for backup instance. +This object can now be used to configure backup using New-AzDataProtectionBackupInstance after all necessary permissions are assigned with Set-AzDataProtectionMSIPermission command. + +## PARAMETERS + +### -BackupConfiguration +Backup configuration for backup. +Use this parameter to configure protection for AzureKubernetesService. +To construct, see NOTES section for BACKUPCONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupDatasourceParameters +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatasourceId +ID of the datasource to be protected + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatasourceLocation +Location of the Datasource to be protected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatasourceType +Datasource Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DatasourceTypes +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Friendly name for backup instance + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +Policy Id to be assiciated to Datasource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretStoreType +Secret store type for secret store authentication of data source. +This parameter is only supported for AzureDatabaseForPostgreSQL currently. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SecretStoreTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretStoreURI +Secret uri for secret store authentication of data source. +This parameter is only supported for AzureDatabaseForPostgreSQL currently. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnapshotResourceGroupId +Sanpshot Resource Group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupInstanceResource + +## 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. + + +`BACKUPCONFIGURATION <IBackupDatasourceParameters>`: Backup configuration for backup. Use this parameter to configure protection for AzureKubernetesService. + - `ObjectType <String>`: Type of the specific object - used for deserializing + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Initialize-AzDataProtectionRestoreRequest.md b/azps-10.1.0/Az.DataProtection/Initialize-AzDataProtectionRestoreRequest.md new file mode 100644 index 0000000000..0202c6a8cf --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Initialize-AzDataProtectionRestoreRequest.md @@ -0,0 +1,523 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/initialize-azdataprotectionrestorerequest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Initialize-AzDataProtectionRestoreRequest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Initialize-AzDataProtectionRestoreRequest.md +--- + +# Initialize-AzDataProtectionRestoreRequest + +## SYNOPSIS +Initializes Restore Request object for triggering restore on a protected backup instance. + +## SYNTAX + +### AlternateLocationFullRecovery (Default) +``` +Initialize-AzDataProtectionRestoreRequest -DatasourceType <DatasourceTypes> -RestoreLocation <String> + -RestoreType <RestoreTargetType> -SourceDataStore <DataStoreType> -TargetResourceId <String> + [-PointInTime <DateTime>] [-RecoveryPoint <String>] [-RehydrationDuration <String>] + [-RehydrationPriority <String>] [-RestoreConfiguration <KubernetesClusterRestoreCriteria>] + [-SecretStoreType <SecretStoreTypes>] [-SecretStoreURI <String>] [<CommonParameters>] +``` + +### AlternateLocationILR +``` +Initialize-AzDataProtectionRestoreRequest -DatasourceType <DatasourceTypes> -ItemLevelRecovery + -RestoreLocation <String> -RestoreType <RestoreTargetType> -SourceDataStore <DataStoreType> + -TargetResourceId <String> [-ContainersList <String[]>] [-RecoveryPoint <String>] + [-RestoreConfiguration <KubernetesClusterRestoreCriteria>] [<CommonParameters>] +``` + +### OriginalLocationFullRecovery +``` +Initialize-AzDataProtectionRestoreRequest -BackupInstance <BackupInstanceResource> + -DatasourceType <DatasourceTypes> -RestoreLocation <String> -RestoreType <RestoreTargetType> + -SourceDataStore <DataStoreType> [-PointInTime <DateTime>] [-RecoveryPoint <String>] + [-RehydrationDuration <String>] [-RehydrationPriority <String>] + [-RestoreConfiguration <KubernetesClusterRestoreCriteria>] [-SecretStoreType <SecretStoreTypes>] + [-SecretStoreURI <String>] [<CommonParameters>] +``` + +### OriginalLocationILR +``` +Initialize-AzDataProtectionRestoreRequest -BackupInstance <BackupInstanceResource> + -DatasourceType <DatasourceTypes> -ItemLevelRecovery -RestoreLocation <String> + -RestoreType <RestoreTargetType> -SourceDataStore <DataStoreType> [-ContainersList <String[]>] + [-FromPrefixPattern <String[]>] [-PointInTime <DateTime>] [-RecoveryPoint <String>] + [-RehydrationDuration <String>] [-RehydrationPriority <String>] + [-RestoreConfiguration <KubernetesClusterRestoreCriteria>] [-SecretStoreType <SecretStoreTypes>] + [-SecretStoreURI <String>] [-ToPrefixPattern <String[]>] [<CommonParameters>] +``` + +### RestoreAsFiles +``` +Initialize-AzDataProtectionRestoreRequest -DatasourceType <DatasourceTypes> -FileNamePrefix <String> + -RestoreLocation <String> -RestoreType <RestoreTargetType> -SourceDataStore <DataStoreType> + -TargetContainerURI <String> [-RecoveryPoint <String>] [-RehydrationDuration <String>] + [-RehydrationPriority <String>] [-SecretStoreType <SecretStoreTypes>] [-SecretStoreURI <String>] + [-TargetResourceIdForRestoreAsFile <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Initializes Restore Request object for triggering restore on a protected backup instance. + +## EXAMPLES + +### Example 1: Get restore request object for Protected Azure Disk Backup instance +```powershell +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "sarath-rg" -VaultName "sarath-vault" +$rp = Get-AzDataProtectionRecoveryPoint -SubscriptionId "xxx-xxx-xxx" -ResourceGroupName "sarath-rg" -VaultName "sarath-vault" -BackupInstanceName $instance.Name +Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureDisk -SourceDataStore OperationalStore -RestoreLocation "westus" -RestoreType AlternateLocation -TargetResourceId "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/disks/{DiskName}" -RecoveryPoint "892e5c5014dc4a96807d22924f5745c9" +``` + +```output +ObjectType RestoreTargetInfoObjectType RestoreTargetInfoRecoveryOption RestoreTargetInfoRestoreLocation SourceDataStoreType RecoveryPointI + d +---------- --------------------------- ------------------------------- -------------------------------- ------------------- -------------- +AzureBackupRecoveryPointBasedRestoreRequest RestoreTargetInfo FailIfExists westus OperationalStore 892e5c5014dc4a96807d22924f5745c9 +``` + +This command initialized a restore request object which can be used to trigger restore. + +### Example 2: Get restore request object for Protected Azure Blob Backup instance +```powershell +$startTime = (Get-Date).AddDays(-30).ToString("yyyy-MM-ddTHH:mm:ss.0000000Z") +$endTime = (Get-Date).AddDays(0).ToString("yyyy-MM-ddTHH:mm:ss.0000000Z") +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "rgName" -VaultName "vaultName" +$pointInTimeRange = Find-AzDataProtectionRestorableTimeRange -BackupInstanceName $instance[0].BackupInstanceName -ResourceGroupName "rgName" -SubscriptionId "subscriptionId" -VaultName "vaultName" -SourceDataStoreType OperationalStore -StartTime $startTime -EndTime $endTime +Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureBlob -SourceDataStore OperationalStore -RestoreLocation $vault.Location -RestoreType OriginalLocation -BackupInstance $instance[0] -PointInTime (Get-Date -Date $pointInTimeRange.RestorableTimeRange.EndTime) +``` + +```output +ObjectType RestoreTargetInfoObjectType RestoreTargetInfoRecoveryOption RestoreTargetInfoRestoreLocation SourceDataStoreType RecoveryPointTime +---------- --------------------------- ------------------------------- -------------------------------- ------------------- ----------------- +AzureBackupRecoveryTimeBasedRestoreRequest restoreTargetInfo FailIfExists eastus2euap OperationalStore 2021-04-24T13:32:41.7018481Z +``` + +This command initialized a restore request object which can be used to trigger restore for Blobs. + +### Example 3: Get restore request object for Item Level recovery for containers under protected AzureBlob Backup instance +```powershell +$startTime = (Get-Date).AddDays(-30).ToString("yyyy-MM-ddTHH:mm:ss.0000000Z") +$endTime = (Get-Date).AddDays(0).ToString("yyyy-MM-ddTHH:mm:ss.0000000Z") +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "rgName" -VaultName "vaultName" +$pointInTimeRange = Find-AzDataProtectionRestorableTimeRange -BackupInstanceName $instance[0].BackupInstanceName -ResourceGroupName "rgName" -SubscriptionId "subscriptionId" -VaultName "vaultName" -SourceDataStoreType OperationalStore -StartTime $startTime -EndTime $endTime +Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureBlob -SourceDataStore OperationalStore -RestoreLocation $vault.Location -RestoreType OriginalLocation -BackupInstance $instances[0] -PointInTime (Get-Date).AddDays(-1) -ItemLevelRecovery -ContainersList "containerName1","containerName2" +``` + +```output +ObjectType RestoreTargetInfoObjectType RestoreTargetInfoRecoveryOption RestoreTargetInfoRestoreLocation SourceDataStoreType RecoveryPointTime +---------- --------------------------- ------------------------------- -------------------------------- ------------------- ----------------- +AzureBackupRecoveryTimeBasedRestoreRequest itemLevelRestoreTargetInfo FailIfExists eastus2euap OperationalStore 2021-04-23T02:47:02.9500000Z +``` + +This command initialized a restore request object which can be used to trigger Item Level Recovery at container level for Blobs. + +### Example 4: Get restore request object for Item Level recovery for containers/prefixMatch under protected AzureBlob Backup instance +```powershell +$startTime = (Get-Date).AddDays(-30).ToString("yyyy-MM-ddTHH:mm:ss.0000000Z") +$endTime = (Get-Date).AddDays(0).ToString("yyyy-MM-ddTHH:mm:ss.0000000Z") +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "rgName" -VaultName "vaultName" +$pointInTimeRange = Find-AzDataProtectionRestorableTimeRange -BackupInstanceName $instance[0].BackupInstanceName -ResourceGroupName "rgName" -SubscriptionId "subscriptionId" -VaultName "vaultName" -SourceDataStoreType OperationalStore -StartTime $startTime -EndTime $endTime +Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureBlob -SourceDataStore OperationalStore -RestoreLocation $vault.Location -RestoreType OriginalLocation -BackupInstance $instances[0] -PointInTime (Get-Date).AddDays(-1) -ItemLevelRecovery -FromPrefixPattern "container1/aaa","container1/ccc", "container2/aab", "container3" -ToPrefixPattern "container1/bbb","container1/ddd", "container2/abc", "container3-0" +``` + +```output +ObjectType RestoreTargetInfoObjectType RestoreTargetInfoRecoveryOption RestoreTargetInfoRestoreLocation SourceDataStoreType RecoveryPointTime +---------- --------------------------- ------------------------------- -------------------------------- ------------------- ----------------- +AzureBackupRecoveryTimeBasedRestoreRequest itemLevelRestoreTargetInfo FailIfExists eastus2euap OperationalStore 2021-04-23T02:47:02.9500000Z +``` + +This command initialized a restore request object which can be used to trigger Item Level Recovery at blobs level based on name prefixes under Blob containers. + +The above restoreRequest restore the following containers/blobs: + +FromPrefix ToPrefix +"container1/aaa" "container1/bbb" (restores all blobs matched in this Prefix range) +"container1/ccc" "container1/ddd" +"container2/aab" "container2/abc" +"container3" "container3-0" (restores whole container3) + +Note: The ranges shouldn't overlap with each other. +Reference: https://learn.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata + +## PARAMETERS + +### -BackupInstance +Backup Instance object to trigger original localtion restore. +To construct, see NOTES section for BACKUPINSTANCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.BackupInstanceResource +Parameter Sets: OriginalLocationFullRecovery, OriginalLocationILR +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainersList +Container names for Item Level Recovery. + +```yaml +Type: System.String[] +Parameter Sets: AlternateLocationILR, OriginalLocationILR +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatasourceType +Datasource Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DatasourceTypes +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileNamePrefix +File name to be prefixed to the restored backup data. + +```yaml +Type: System.String +Parameter Sets: RestoreAsFiles +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromPrefixPattern +Minimum matching value for Item Level Recovery. + +```yaml +Type: System.String[] +Parameter Sets: OriginalLocationILR +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemLevelRecovery +Switch parameter to enable item level recovery. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AlternateLocationILR, OriginalLocationILR +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PointInTime +Point In Time for restore. + +```yaml +Type: System.DateTime +Parameter Sets: AlternateLocationFullRecovery, OriginalLocationFullRecovery, OriginalLocationILR +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPoint +Id of the recovery point to be restored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RehydrationDuration +Rehydration duration for the archived recovery point to stay rehydrated, default value for rehydration duration is 15. + +```yaml +Type: System.String +Parameter Sets: AlternateLocationFullRecovery, OriginalLocationFullRecovery, OriginalLocationILR, RestoreAsFiles +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RehydrationPriority +Rehydration priority for archived recovery point. +This parameter is mandatory for rehydrate restore of archived points. + +```yaml +Type: System.String +Parameter Sets: AlternateLocationFullRecovery, OriginalLocationFullRecovery, OriginalLocationILR, RestoreAsFiles +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreConfiguration +Restore configuration for restore. +Use this parameter to restore with AzureKubernetesService. +To construct, see NOTES section for RESTORECONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.KubernetesClusterRestoreCriteria +Parameter Sets: AlternateLocationFullRecovery, AlternateLocationILR, OriginalLocationFullRecovery, OriginalLocationILR +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreLocation +Target Restore Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreType +Restore Target Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.RestoreTargetType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretStoreType +Secret store type for secret store authentication of data source. +This parameter is only supported for AzureDatabaseForPostgreSQL currently. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SecretStoreTypes +Parameter Sets: AlternateLocationFullRecovery, OriginalLocationFullRecovery, OriginalLocationILR, RestoreAsFiles +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretStoreURI +Secret uri for secret store authentication of data source. +This parameter is only supported for AzureDatabaseForPostgreSQL currently. + +```yaml +Type: System.String +Parameter Sets: AlternateLocationFullRecovery, OriginalLocationFullRecovery, OriginalLocationILR, RestoreAsFiles +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDataStore +DataStore Type of the Recovery point + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DataStoreType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetContainerURI +Target storage account container Id to which backup data will be restored as files. + +```yaml +Type: System.String +Parameter Sets: RestoreAsFiles +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceId +Specify the target resource ID for restoring backup data in an alternate location. +For instance, provide the target database ARM ID that you want to restore to, for workloadType AzureDatabaseForPostgreSQL. + +```yaml +Type: System.String +Parameter Sets: AlternateLocationFullRecovery, AlternateLocationILR +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceIdForRestoreAsFile +Target storage account container ARM Id to which backup data will be restored as files. +This parameter is required for restoring as files to another subscription. + +```yaml +Type: System.String +Parameter Sets: RestoreAsFiles +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ToPrefixPattern +Maximum matching value for Item Level Recovery. + +```yaml +Type: System.String[] +Parameter Sets: OriginalLocationILR +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IAzureBackupRestoreRequest + +## 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. + + +`BACKUPINSTANCE <BackupInstanceResource>`: Backup Instance object to trigger original localtion restore. + - `[Property <IBackupInstance>]`: BackupInstanceResource properties + - `DataSourceInfo <IDatasource>`: Gets or sets the data source information. + - `ResourceId <String>`: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. + - `[ObjectType <String>]`: Type of Datasource object, used to initialize the right inherited type + - `[ResourceLocation <String>]`: Location of datasource. + - `[ResourceName <String>]`: Unique identifier of the resource in the context of parent. + - `[ResourceType <String>]`: Resource Type of Datasource. + - `[ResourceUri <String>]`: Uri of the resource. + - `[Type <String>]`: DatasourceType of the resource. + - `ObjectType <String>`: + - `PolicyInfo <IPolicyInfo>`: Gets or sets the policy information. + - `PolicyId <String>`: + - `[PolicyParameter <IPolicyParameters>]`: Policy parameters for the backup instance + - `[BackupDatasourceParametersList <IBackupDatasourceParameters[]>]`: Gets or sets the Backup Data Source Parameters + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[DataStoreParametersList <IDataStoreParameters[]>]`: Gets or sets the DataStore Parameters + - `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[DataSourceSetInfo <IDatasourceSet>]`: Gets or sets the data source set information. + - `ResourceId <String>`: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. + - `[DatasourceType <String>]`: DatasourceType of the resource. + - `[ObjectType <String>]`: Type of Datasource object, used to initialize the right inherited type + - `[ResourceLocation <String>]`: Location of datasource. + - `[ResourceName <String>]`: Unique identifier of the resource in the context of parent. + - `[ResourceType <String>]`: Resource Type of Datasource. + - `[ResourceUri <String>]`: Uri of the resource. + - `[DatasourceAuthCredentials <IAuthCredentials>]`: Credentials to use to authenticate with data source provider. + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[FriendlyName <String>]`: Gets or sets the Backup Instance friendly name. + - `[ValidationType <ValidationType?>]`: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. + - `[Tag <IDppProxyResourceTags>]`: Proxy Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +`RESTORECONFIGURATION <KubernetesClusterRestoreCriteria>`: Restore configuration for restore. Use this parameter to restore with AzureKubernetesService. + - `IncludeClusterScopeResource <Boolean>`: Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore. + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[ConflictPolicy <ExistingResourcePolicy?>]`: Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore. + - `[ExcludedNamespace <String[]>]`: Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore. + - `[ExcludedResourceType <String[]>]`: Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore. + - `[IncludedNamespace <String[]>]`: Gets or sets the include namespaces property. This property sets the namespaces to be included during restore. + - `[IncludedResourceType <String[]>]`: Gets or sets the include resource types property. This property sets the resource types to be included during restore. + - `[LabelSelector <String[]>]`: Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore. + - `[NamespaceMapping <IKubernetesClusterRestoreCriteriaNamespaceMappings>]`: Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[PersistentVolumeRestoreMode <PersistentVolumeRestoreMode?>]`: Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupConfigurationClientObject.md b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupConfigurationClientObject.md new file mode 100644 index 0000000000..265de636f9 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupConfigurationClientObject.md @@ -0,0 +1,260 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/new-azdataprotectionbackupconfigurationclientobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionBackupConfigurationClientObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionBackupConfigurationClientObject.md +--- + +# New-AzDataProtectionBackupConfigurationClientObject + +## SYNOPSIS +Creates new backup configuration object + +## SYNTAX + +``` +New-AzDataProtectionBackupConfigurationClientObject -DatasourceType <DatasourceTypes> + [-ExcludedNamespace <String[]>] [-ExcludedResourceType <String[]>] [-IncludeAllContainer] + [-IncludeClusterScopeResource <Boolean?>] [-IncludedNamespace <String[]>] [-IncludedResourceType <String[]>] + [-LabelSelector <String[]>] [-SnapshotVolume <Boolean?>] [-StorageAccountName <String>] + [-StorageAccountResourceGroupName <String>] [-VaultedBackupContainer <String[]>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates new backup configuration object + +## EXAMPLES + +### Example 1: Create a BackupConfiguration for configuring protection with AzureKubernetesService +```powershell +$backupConfig = New-AzDataProtectionBackupConfigurationClientObject -SnapshotVolume $true -IncludeClusterScopeResource $true -DatasourceType AzureKubernetesService -LabelSelector "key=val","foo=bar" -ExcludedNamespace "excludeNS1","excludeNS2" +``` + +```output +ObjectType ExcludedNamespace ExcludedResourceType IncludeClusterScopeResource IncludedNamespace IncludedResourceType LabelSelector SnapshotVolume +---------- ----------------- -------------------- --------------------------- ----------------- -------------------- ------------- -------------- +KubernetesClusterBackupDatasourceParameters {excludeNS1, excludeNS2} True {key=val, foo=bar} True +``` + +This command can be used to create a backup configuration client object used for configuring backup for a Kubernetes cluster + +### Example 2: Create a BackupConfiguration to select specific containers for configuring vaulted backups for AzureBlob. +```powershell +$storageAccount = Get-AzStorageAccount -ResourceGroupName $resourceGroupName -Name $storageAccountName +$containers=Get-AzStorageContainer -Context $storageAccount.Context +$backupConfig = New-AzDataProtectionBackupConfigurationClientObject -DatasourceType AzureBlob -VaultedBackupContainer $containers.Name[1,3,4] +``` + +```output +ObjectType ContainersList +---------- -------------- +BlobBackupDatasourceParameters {conabb, conwxy, conzzz} +``` + +This command can be used to create a backup configuration client object used for configuring backup for vaulted Blob backup containers. + +## PARAMETERS + +### -DatasourceType +Datasource Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DatasourceTypes +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedNamespace +List of namespaces to be excluded from backup + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedResourceType +List of resource types to be excluded from backup + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAllContainer +Switch parameter to include all containers to be backed up inside the VaultStore. +Use this parameter for DatasourceType AzureBlob. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeClusterScopeResource +Boolean parameter to decide whether cluster scope resources are included for backup. +By default this is taken as true. + +```yaml +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedNamespace +List of namespaces to be included for backup + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedResourceType +List of resource types to be included for backup + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabelSelector +List of labels for internal filtering for backup + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnapshotVolume +Boolean parameter to decide whether snapshot volumes are included for backup. +By default this is taken as true. + +```yaml +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage account where the Datasource is present. +Use this parameter for DatasourceType AzureBlob. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceGroupName +Storage account resource group name where the Datasource is present. +Use this parameter for DatasourceType AzureBlob. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultedBackupContainer +List of containers to be backed up inside the VaultStore. +Use this parameter for DatasourceType AzureBlob. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupInstance.md b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupInstance.md new file mode 100644 index 0000000000..6603fb95da --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupInstance.md @@ -0,0 +1,335 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/new-azdataprotectionbackupinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionBackupInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionBackupInstance.md +--- + +# New-AzDataProtectionBackupInstance + +## SYNOPSIS +Configures Backup for supported azure resources + +## SYNTAX + +``` +New-AzDataProtectionBackupInstance -BackupInstance <IBackupInstanceResource> -ResourceGroupName <String> + -VaultName <String> [-AsJob] [-DefaultProfile <PSObject>] [-NoWait] [-SubscriptionId <String>] + [-Tag <Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Configures Backup for supported azure resources + +## EXAMPLES + +### Example 1: Configure backup of an azure disk in a backup vault. +```powershell +$sub = "xxxx-xxx-xx" +$DiskId = "/subscriptions/{subscription}/resourceGroups/{resourcegroup}/providers/Microsoft.Compute/disks/{diskname}" +$policy = Get-AzDataProtectionBackupPolicy -SubscriptionId $sub -ResourceGroupName sarath-rg -VaultName sarath-vault -Name "MyPolicy" +$instance = Initialize-AzDataProtectionBackupInstance -DatasourceType AzureDisk -DatasourceLocation $vault.Location -PolicyId $policy.Id -DatasourceId $DiskId +$instance.Property.PolicyInfo.PolicyParameter.DataStoreParametersList[0].ResourceGroupId = "/subscriptions/{subscription}/resourceGroups/{resourceGroup}" +New-AzDataProtectionBackupInstance -SubscriptionId $sub -ResourceGroupName sarath-rg -VaultName sarath-vault -BackupInstance $instance +``` + +```output +Name Type BackupInstanceName +---- ---- ------------------ +sarathdisk-sarathdisk-3df6ac08-9496-4839-8fb5-8b78e594f166 Microsoft.DataProtection/backupVaults/backupInstances sarathdisk-sarathdisk-3df6ac08-9496-4839-8fb5-8b78e594f166 +``` + +The third command gets the policy with which disk will be backed up. +The fourth command initializes the backup instance request. +The last command configures backup of the given azure disk in the backup vault. + +### Example 2: Configure protection for AzureDatabaseForPostgreSQL database in a backup vault (using secret store authentication). +```powershell +$sub = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +$dataSourceId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroupName/providers/Microsoft.DBforPostgreSQL/servers/OssServerName/databases/DBName" +$secretURI = "https://oss-keyvault.vault.azure.net/secrets/oss-secret" +$vault = Get-AzDataProtectionBackupVault -SubscriptionId $sub -ResourceGroupName "ResourceGroupName" -VaultName $vaultName +$policy = Get-AzDataProtectionBackupPolicy -SubscriptionId $sub -ResourceGroupName "ResourceGroupName" -VaultName "vaultName" -Name "MyPolicy" +$instance = Initialize-AzDataProtectionBackupInstance -DatasourceType AzureDatabaseForPostgreSQL -DatasourceLocation $vault.Location -PolicyId $policy.Id -DatasourceId $dataSourceId -SecretStoreURI $secretURI -SecretStoreType AzureKeyVault +New-AzDataProtectionBackupInstance -SubscriptionId $sub -ResourceGroupName "ResourceGroupName" -VaultName "vaultName" -BackupInstance $instance +``` + +```output +Name Type BackupInstanceName +---- ---- ------------------ +xyz-postgresql-wus-empdb10-xxxxxxxx-xxxx-xxxx-a3ba-be75108d8b21 Microsoft.DataProtection/backupVaults/backupInstances xyz-postgresql-wus-empdb10-xxxxxxxx-xxxx-xxxx-a3ba-be75108d8b21 +``` + +The third command initializes the secretURI for secret store authentication. + +The fifth command gets the policy with which database will be protected. +The sixth command initializes the backup instance request object. +The last command configures backup of the given $dataSourceId in the backup vault. + +### Example 3: Configure protection for AzureKubernetesService cluster in a backup vault +```powershell +$policy = Get-AzDataProtectionBackupPolicy -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" -ResourceGroupName "resourceGroupName" | where {$_.Name -eq "policyName"} +$sourceClusterId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.ContainerService/managedClusters/aks-cluster" +$snapshotResourceGroupId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName" +$backupConfig = New-AzDataProtectionBackupConfigurationClientObject -SnapshotVolume $true -IncludeClusterScopeResource $true -DatasourceType AzureKubernetesService -LabelSelector "x=y","foo=bar" +$backupInstance = Initialize-AzDataProtectionBackupInstance -DatasourceType AzureKubernetesService -DatasourceLocation "eastus" -PolicyId $policy.Id -DatasourceId $sourceClusterId -SnapshotResourceGroupId $snapshotResourceGroupId -FriendlyName "aks-cluster-friendlyName" -BackupConfiguration $backupConfig +Set-AzDataProtectionMSIPermission -BackupInstance $backupInstance -VaultResourceGroup "resourceGroupName" -VaultName "vaultName" -PermissionsScope "ResourceGroup" +$tag= @{"Owner"="BIOwnerName";"Foo"="Bar";"A"="B"} +$biCreate = New-AzDataProtectionBackupInstance -ResourceGroupName "ResourceGroupName" -VaultName "vaultName" -BackupInstance $backupInstance -SubscriptionId $sub -Tag $tag +$biCreate +``` + +```output +Name BackupInstanceName +---- ------------------ +aks-cluster-aks-cluster-117bd668-4t5h-4f3a-947c-ea71304cb4d7 aks-cluster-aks-cluster-117bd668-4t5h-4f3a-947c-ea71304cb4d7 +``` + +The First command gets the AzureKubernetesService policy in a given vault. +The second, third command initializes the AKS cluster and snapshot resource group Id. +The fourth command backup configuration object needed for AzureKubernetesService. +The fifth command initializes the client object for backup instance. +The sixth command assigns the necessary permissions for configure backup. + +The sevnth and eight command initializes custom tags and configure backup finally by creating a backup instance. + +### Example 4: Configure protection for AzureBlob with vault policy +```powershell +$vault = Get-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" +$pol = Get-AzDataProtectionBackupPolicy -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" -ResourceGroupName "resourceGroupName" | Where { $_.Name -match "vaultedPolicyName" } +$backupConfig = New-AzDataProtectionBackupConfigurationClientObject -DatasourceType AzureBlob -IncludeAllContainer -StorageAccountResourceGroupName "resourceGroupName" -StorageAccountName "storageAcountName" +$backupInstanceClientObject = Initialize-AzDataProtectionBackupInstance -DatasourceType AzureBlob -DatasourceLocation $vault.Location -PolicyId $pol[0].Id -DatasourceId "storageAccId" -BackupConfiguration $backupConfig +Set-AzDataProtectionMSIPermission -VaultResourceGroup "resourceGroupName" -VaultName "vaultName" -BackupInstance $backupInstanceClientObject -PermissionsScope ResourceGroup +$operationResponse = Test-AzDataProtectionBackupInstanceReadiness -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -BackupInstance $backupInstanceClientObject.Property -NoWait +$operationId = $operationResponse.Target.Split("/")[-1].Split("?")[0] +While((Get-AzDataProtectionOperationStatus -OperationId $operationId -Location $vault.Location -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx").Status -eq "Inprogress"){ + Start-Sleep -Seconds 10 +} +$backupnstanceCreate = New-AzDataProtectionBackupInstance -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -BackupInstance $backupInstanceClientObject +``` + +```output +Name BackupInstanceName +---- ------------------ +blobeuspstestsa-blobeuspstestsa-64f7399a-b024-4d61-8f16-c424c5fd2564 blobeuspstestsa-blobeuspstestsa-64f7399a-b024-4d61-8f16-c424c5fd2564 +``` + +The first command gets the backup vault. +The second command get the vaultedPolicy. +The third command defines a BackupConfiguration object so as to include all containers for vaulted backup. +Check examples for New-AzDataProtectionBackupConfigurationClientObject cmdlet to see how to select specific containers for backup. +Th fourth command initializes the backup instance. +The fifth command assigns the necessary permissions for configure backup. +The sixth command validates if the backup instance object is valid for configure protection (validate backup). +This command runs in async way using parameter -NoWait. +Next we fetch the operation in a while loop until it succeeds. +The last command is used to configure protection for the backup instance. + +## PARAMETERS + +### -AsJob + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupInstance +Backup instance request object which will be used to configure backup +To construct, see NOTES section for BACKUPINSTANCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupInstanceResource +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group of the backup vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id of the vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Name of the backup vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## 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. + + +`BACKUPINSTANCE <IBackupInstanceResource>`: Backup instance request object which will be used to configure backup + - `[Tag <IDppProxyResourceTags>]`: Proxy Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[Property <IBackupInstance>]`: BackupInstanceResource properties + - `DataSourceInfo <IDatasource>`: Gets or sets the data source information. + - `ResourceId <String>`: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. + - `[ObjectType <String>]`: Type of Datasource object, used to initialize the right inherited type + - `[ResourceLocation <String>]`: Location of datasource. + - `[ResourceName <String>]`: Unique identifier of the resource in the context of parent. + - `[ResourceType <String>]`: Resource Type of Datasource. + - `[ResourceUri <String>]`: Uri of the resource. + - `[Type <String>]`: DatasourceType of the resource. + - `ObjectType <String>`: + - `PolicyInfo <IPolicyInfo>`: Gets or sets the policy information. + - `PolicyId <String>`: + - `[PolicyParameter <IPolicyParameters>]`: Policy parameters for the backup instance + - `[BackupDatasourceParametersList <IBackupDatasourceParameters[]>]`: Gets or sets the Backup Data Source Parameters + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[DataStoreParametersList <IDataStoreParameters[]>]`: Gets or sets the DataStore Parameters + - `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[DataSourceSetInfo <IDatasourceSet>]`: Gets or sets the data source set information. + - `ResourceId <String>`: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. + - `[DatasourceType <String>]`: DatasourceType of the resource. + - `[ObjectType <String>]`: Type of Datasource object, used to initialize the right inherited type + - `[ResourceLocation <String>]`: Location of datasource. + - `[ResourceName <String>]`: Unique identifier of the resource in the context of parent. + - `[ResourceType <String>]`: Resource Type of Datasource. + - `[ResourceUri <String>]`: Uri of the resource. + - `[DatasourceAuthCredentials <IAuthCredentials>]`: Credentials to use to authenticate with data source provider. + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[FriendlyName <String>]`: Gets or sets the Backup Instance friendly name. + - `[ValidationType <ValidationType?>]`: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupPolicy.md b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupPolicy.md new file mode 100644 index 0000000000..626ad8d065 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupPolicy.md @@ -0,0 +1,362 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/new-azdataprotectionbackuppolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionBackupPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionBackupPolicy.md +--- + +# New-AzDataProtectionBackupPolicy + +## SYNOPSIS +Creates a new backup policy in a given backup vault + +## SYNTAX + +``` +New-AzDataProtectionBackupPolicy -Name <String> -Policy <IBackupPolicy> -ResourceGroupName <String> + -VaultName <String> [-DefaultProfile <PSObject>] [-SubscriptionId <String>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new backup policy in a given backup vault + +## EXAMPLES + +### Example 1: Create a default policy +```powershell +$defaultPol = Get-AzDataProtectionPolicyTemplate -DatasourceType AzureDisk +New-AzDataProtectionBackupPolicy -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName sarath-rg -VaultName sarath-vault -Name "MyPolicy" -Policy $defaultPol +``` + +```output +Name Type +---- ---- +MyPolicy Microsoft.DataProtection/backupVaults/backupPolicies +``` + +This command creates a default policy for Azure disk datasource type. + +### Example 2: Create a policy for AzureDatabaseForPostgreSQL, this example covers a sophisticated policy using powerShell +```powershell +$defaultPol = Get-AzDataProtectionPolicyTemplate -DatasourceType AzureDatabaseForPostgreSQL +$lifeCycleVault = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore VaultStore -SourceRetentionDurationType Months -SourceRetentionDurationCount 3 -TargetDataStore ArchiveStore -CopyOption CopyOnExpiryOption +$lifeCycleArchive = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore ArchiveStore -SourceRetentionDurationType Months -SourceRetentionDurationCount 6 +Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $defaultPol -Name Default -LifeCycles $lifeCycleVault, $lifeCycleArchive -IsDefault $true +$schDates = @( +( + (Get-Date -Year 2021 -Month 08 -Day 18 -Hour 10 -Minute 0 -Second 0) +), +( + (Get-Date -Year 2021 -Month 08 -Day 22 -Hour 10 -Minute 0 -Second 0) +)) + +$trigger = New-AzDataProtectionPolicyTriggerScheduleClientObject -ScheduleDays $schDates -IntervalType Weekly -IntervalCount 1 +Edit-AzDataProtectionPolicyTriggerClientObject -Schedule $trigger -Policy $defaultPol +$lifeCycleVault = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore VaultStore -SourceRetentionDurationType Months -SourceRetentionDurationCount 6 -TargetDataStore ArchiveStore -CopyOption CopyOnExpiryOption +$lifeCycleArchive = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore ArchiveStore -SourceRetentionDurationType Months -SourceRetentionDurationCount 12 +Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $defaultPol -Name Monthly -LifeCycles $lifeCycleVault, $lifeCycleArchive -IsDefault $false +$tagCriteria = New-AzDataProtectionPolicyTagCriteriaClientObject -AbsoluteCriteria FirstOfMonth +Edit-AzDataProtectionPolicyTagClientObject -Policy $defaultPol -Name Monthly -Criteria $tagCriteria +New-AzDataProtectionBackupPolicy -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -Name "newOSSPolicy" -Policy $defaultPol +``` + +```output +Name Type +---- ---- +MyPolicy Microsoft.DataProtection/backupVaults/backupPolicies +``` + +The first command gets the default policy template for AzureDatabaseForPostgreSQL. +The second, third commands create two different backup lifecycles for vault and archive store respectively. +The backup stays in vaultstore for 3 Months, and then copies on expiry to the Archive store and stays there till 6 months. +The fourth command updates the policy object with lifecycles created. +The fifth, sixth commands create the custom schedule object for the backup policy, twice weekly starting from $schDates. +The seventh command updates the policy object with custom schedule. +The eighth, ninth, tenth commands update the Monthly retention rule with custom lifecycles. +The eleventh, twelth commands create a tag criteria for Monthly policy. +Tag criteria needs to be added for each custom retention rule (automatically added for default retention rule). +The last command creates the policy. + +### Example 3: Create a policy for AzureKubernetesService +```powershell +$defaultPol = Get-AzDataProtectionPolicyTemplate -DatasourceType AzureKubernetesService +$schDate = @( +( + (Get-Date -Year 2023 -Month 03 -Day 18 -Hour 16 -Minute 0 -Second 0) +)) +$trigger = New-AzDataProtectionPolicyTriggerScheduleClientObject -ScheduleDays $schDate -IntervalType Daily -IntervalCount 1 +Edit-AzDataProtectionPolicyTriggerClientObject -Schedule $trigger -Policy $defaultPol +$lifeCycleDaily = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore OperationalStore -SourceRetentionDurationType Days -SourceRetentionDurationCount 8 +$lifeCycleWeekly = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore OperationalStore -SourceRetentionDurationType Weeks -SourceRetentionDurationCount 9 +Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $defaultPol -Name Daily -LifeCycles $lifeCycleDaily -IsDefault $false +Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $defaultPol -Name Weekly -LifeCycles $lifeCycleWeekly -IsDefault $false +$tagCriteriaDaily = New-AzDataProtectionPolicyTagCriteriaClientObject -AbsoluteCriteria FirstOfDay +Edit-AzDataProtectionPolicyTagClientObject -Policy $defaultPol -Name Daily -Criteria $tagCriteriaDaily +$tagCriteriaWeekly = New-AzDataProtectionPolicyTagCriteriaClientObject -AbsoluteCriteria FirstOfWeek +Edit-AzDataProtectionPolicyTagClientObject -Policy $defaultPol -Name Weekly -Criteria $tagCriteriaWeekly +$newPolicy = New-AzDataProtectionBackupPolicy -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -Name "newAKSPolicy" -Policy $defaultPol -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +```output +Name Type +---- ---- +newAKSPolicy Microsoft.DataProtection/backupVaults/backupPolicies +``` + +The first command gets the default policy template for AzureKubernetesService. +The second, third commands create the custom schedule object for the backup policy, Daily starting from $schDate. +The fourth command updates the policy object with custom schedule. +The fifth, sixth commands create two backup lifecycles for daily and weekly recovery points. +The seventh, eight commands update the policy object with lifecycles created. +Next we create FirstOfDay, FirstOfWeek tag criteria and update the policy. +The last command creates the policy. + +### Example 4: Create a operational policy for AzureBlob +```powershell +$defaultPol = Get-AzDataProtectionPolicyTemplate -DatasourceType AzureBlob +Edit-AzDataProtectionPolicyTriggerClientObject -Policy $defaultPol -RemoveSchedule +$lifeCycleOperationalTier = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore OperationalStore -SourceRetentionDurationType Days -SourceRetentionDurationCount 30 +Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $defaultPol -Name Default -LifeCycles $lifeCycleOperationalTier -IsDefault $true -OverwriteLifeCycle $true +$opPolicy = New-AzDataProtectionBackupPolicy -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -Name "operationalPolicyName" -Policy $defaultPol +``` + +```output +Name Type +---- ---- +operationalPolicyName Microsoft.DataProtection/backupVaults/backupPolicies +``` + +The first command gets the default policy template for AzureBlob. +Policy template is by default vaulted policy. +The second command removes the vaulted policy schedule since we are creating operational policy. +The third command creates a operational store lifecycle for 30 Days. +The fourth command overwrites the vault lifecycle with operational store lifecycle. +The last command creates the operational store policy. + +### Example 4: Create a vaulted policy for AzureBlob +```powershell +$defaultPol = Get-AzDataProtectionPolicyTemplate -DatasourceType AzureBlob +$lifeCycleVaultTierWeekly = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore VaultStore -SourceRetentionDurationType Weeks -SourceRetentionDurationCount 4 +Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $defaultPol -Name Weekly -LifeCycles $lifeCycleVaultTierWeekly -IsDefault $false +$tagCriteria = New-AzDataProtectionPolicyTagCriteriaClientObject -AbsoluteCriteria FirstOfWeek +Edit-AzDataProtectionPolicyTagClientObject -Policy $defaultPol -Name Weekly -Criteria $tagCriteria +$vaultedPolicy = New-AzDataProtectionBackupPolicy -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -Name "vaultedPolicyName" -Policy $defaultPol +``` + +```output +Name Type +---- ---- +vaultedPolicyName Microsoft.DataProtection/backupVaults/backupPolicies +``` + +The first command gets the default vaulted policy template for AzureBlob. +The second command defines a weekly lifecycle in vault store. +The third command updates the defaultPol object with weekly lifecycle. +The third and fourth command defines and updates the defaultPol with weekly tag criteria. +The last command creates the vault store policy. + +### Example 5: Create a operational and vaulted policy for AzureBlob +```powershell +$defaultPol = Get-AzDataProtectionPolicyTemplate -DatasourceType AzureBlob +$lifeCycleOperationalTier = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore OperationalStore -SourceRetentionDurationType Days -SourceRetentionDurationCount 30 +Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $defaultPol -Name Default -LifeCycles $lifeCycleOperationalTier -IsDefault $true -OverwriteLifeCycle $false +$lifeCycleVaultTierWeekly = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore VaultStore -SourceRetentionDurationType Weeks -SourceRetentionDurationCount 7 +Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $defaultPol -Name Weekly -LifeCycles $lifeCycleVaultTierWeekly -IsDefault $false +$tagCriteria = New-AzDataProtectionPolicyTagCriteriaClientObject -AbsoluteCriteria FirstOfWeek +Edit-AzDataProtectionPolicyTagClientObject -Policy $defaultPol -Name Weekly -Criteria $tagCriteria +$lifeCycleVaultTierMonthly = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore VaultStore -SourceRetentionDurationType Months -SourceRetentionDurationCount 5 +Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $defaultPol -Name Monthly -LifeCycles $lifeCycleVaultTierMonthly -IsDefault $false +$tagCriteria = New-AzDataProtectionPolicyTagCriteriaClientObject -AbsoluteCriteria FirstOfMonth +Edit-AzDataProtectionPolicyTagClientObject -Policy $defaultPol -Name Monthly -Criteria $tagCriteria +$lifeCycleVaultTierYearly = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore VaultStore -SourceRetentionDurationType Years -SourceRetentionDurationCount 1 +Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $defaultPol -Name Yearly -LifeCycles $lifeCycleVaultTierYearly -IsDefault $false +$tagCriteria = New-AzDataProtectionPolicyTagCriteriaClientObject -AbsoluteCriteria FirstOfYear +Edit-AzDataProtectionPolicyTagClientObject -Policy $defaultPol -Name Yearly -Criteria $tagCriteria +$scheduleDate = Get-Date +$trigger = New-AzDataProtectionPolicyTriggerScheduleClientObject -ScheduleDays $scheduleDate -IntervalType Weekly -IntervalCount 1 +Edit-AzDataProtectionPolicyTriggerClientObject -Schedule $trigger -Policy $defaultPol +$defaultPol.PolicyRule[0].Trigger.ScheduleRepeatingTimeInterval[0] = "R/2023-05-09T02:30:00+01:00/P1W" +$timeZone = Get-TimeZone -ListAvailable | Where-Object { $_.Id -match "Europe" } +$defaultPol.PolicyRule[0].Trigger.ScheduleTimeZone = $timeZone[0].Id +$operationalVaultedPolicy = New-AzDataProtectionBackupPolicy -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -Name "operationalVaultedPolicyName" -Policy $defaultPol +``` + +```output +Name Type +---- ---- +operationalVaultedPolicyName Microsoft.DataProtection/backupVaults/backupPolicies +``` + +The first command gets the default vaulted policy template for AzureBlob. +The second to fifteenth command defines and updates the Operational, vaulted weekly, monthly, yearly lifecycle and tagcriteria. +Next we define a trigger object with schedule time and timzone, set it to 2:30 AM West Europe standard time. +The last command creates the hybrid AzureBlob policy. + +## PARAMETERS + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Policy Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Policy Request Object +To construct, see NOTES section for POLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupPolicy +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBaseBackupPolicyResource + +## 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. + + +`POLICY <IBackupPolicy>`: Policy Request Object + - `DatasourceType <String[]>`: Type of datasource for the backup management + - `ObjectType <String>`: + - `PolicyRule <IBasePolicyRule[]>`: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc + - `Name <String>`: + - `ObjectType <String>`: + - `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `TriggerObjectType <String>`: Type of the specific object - used for deserializing + - `Lifecycle <ISourceLifeCycle[]>`: + - `DeleteAfterDuration <String>`: Duration of deletion after given timespan + - `DeleteAfterObjectType <String>`: Type of the specific object - used for deserializing + - `SourceDataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `SourceDataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `[TargetDataStoreCopySetting <ITargetCopySetting[]>]`: + - `CopyAfterObjectType <String>`: Type of the specific object - used for deserializing + - `DataStoreObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `[BackupParameterObjectType <String>]`: Type of the specific object - used for deserializing + - `[IsDefault <Boolean?>]`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupVault.md b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupVault.md new file mode 100644 index 0000000000..675526cc71 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupVault.md @@ -0,0 +1,364 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/new-azdataprotectionbackupvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionBackupVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionBackupVault.md +--- + +# New-AzDataProtectionBackupVault + +## SYNOPSIS +Creates or updates a BackupVault resource belonging to a resource group. + +## SYNTAX + +``` +New-AzDataProtectionBackupVault -Location <String> -ResourceGroupName <String> + -StorageSetting <IStorageSetting[]> -VaultName <String> [-AsJob] + [-AzureMonitorAlertsForAllJobFailure <AlertsState>] + [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>] [-DefaultProfile <PSObject>] + [-ETag <String>] [-IdentityType <String>] [-ImmutabilityState <ImmutabilityState>] [-NoWait] + [-SoftDeleteRetentionDurationInDay <Double>] [-SoftDeleteState <SoftDeleteState>] [-SubscriptionId <String>] + [-Tag <Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a BackupVault resource belonging to a resource group. + +## EXAMPLES + +### Example 1: Create a new backup vault +```powershell +$sub = "xxxx-xxxx-xxxxx" +$storagesetting = New-AzDataProtectionBackupVaultStorageSettingObject -DataStoreType VaultStore -Type LocallyRedundant +New-AzDataProtectionBackupVault -SubscriptionId $sub -ResourceGroupName sarath-rg -VaultName "MyVault" -StorageSetting $storagesetting -Location westus +``` + +```output +ETag IdentityPrincipalId IdentityTenantId IdentityType Location Name Type +---- ------------------- ---------------- ------------ -------- ---- ---- + westus MyVault Microsoft.DataProtection/backupVaults +``` + +This command creates a new backup vault. + +### Example 2: Create a new backup vault with ImmutabilityState, CrossSubscriptionRestoreState, soft delete settings +```powershell +$sub = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +$storagesetting = New-AzDataProtectionBackupVaultStorageSettingObject -DataStoreType VaultStore -Type LocallyRedundant +New-AzDataProtectionBackupVault -SubscriptionId $sub -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -Location westus -StorageSetting $storagesetting -CrossSubscriptionRestoreState Enabled -ImmutabilityState Unlocked -SoftDeleteRetentionDurationInDay 100 -SoftDeleteState On +``` + +```output +ETag IdentityPrincipalId IdentityTenantId IdentityType Location Name Type +---- ------------------- ---------------- ------------ -------- ---- ---- + westus MyVault Microsoft.DataProtection/backupVaults +``` + +This command creates a new backup vault while setting Immutability state, cross subscription restore state, soft delete settings of the vault at creation time. + +## PARAMETERS + +### -AsJob + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureMonitorAlertsForAllJobFailure +Parameter to Enable or Disable built-in azure monitor alerts for job failures. +Security alerts cannot be disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.AlertsState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CrossSubscriptionRestoreState +Cross subscription restore state of the vault. +Allowed values are Disabled, Enabled, PermanentlyDisabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.CrossSubscriptionRestoreState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETag +Optional ETag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identityType which can be either SystemAssigned or None. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutabilityState +Immutability state of the vault. +Allowed values are Disabled, Unlocked, Locked. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.ImmutabilityState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name of the backup vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeleteRetentionDurationInDay +Soft delete retention duration in days + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeleteState +Soft delete state of the vault. +Allowed values are Off, On, AlwaysOn + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SoftDeleteState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSetting +Storage Settings of the vault. +Use New-AzDataProtectionBackupVaultStorageSetting Cmdlet to Create. +To construct, see NOTES section for STORAGESETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IStorageSetting[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id of the vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Name of the backup vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Management.Automation.PSObject + +## 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. + + +`STORAGESETTING <IStorageSetting[]>`: Storage Settings of the vault. Use New-AzDataProtectionBackupVaultStorageSetting Cmdlet to Create. + - `[DatastoreType <StorageSettingStoreTypes?>]`: Gets or sets the type of the datastore. + - `[Type <StorageSettingTypes?>]`: Gets or sets the type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupVaultStorageSettingObject.md b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupVaultStorageSettingObject.md new file mode 100644 index 0000000000..6a51a284a5 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionBackupVaultStorageSettingObject.md @@ -0,0 +1,86 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/new-azdataprotectionbackupvaultstoragesettingobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionBackupVaultStorageSettingObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionBackupVaultStorageSettingObject.md +--- + +# New-AzDataProtectionBackupVaultStorageSettingObject + +## SYNOPSIS +Get Backup Vault storage setting object + +## SYNTAX + +``` +New-AzDataProtectionBackupVaultStorageSettingObject -DataStoreType <DataStoreType> -Type <StorageSettingType> + [<CommonParameters>] +``` + +## DESCRIPTION +Get Backup Vault storage setting object + +## EXAMPLES + +### Example 1: Create a new vault storage setting object +```powershell +New-AzDataProtectionBackupVaultStorageSettingObject -Type GeoRedundant -DataStoreType VaultStore +``` + +```output +DatastoreType Type +------------- ---- +VaultStore GeoRedundant +``` + +This command creates a new vault storage setting object which is used to create a backup vault. + +## PARAMETERS + +### -DataStoreType +DataStore Type of the vault + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DataStoreType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Storage Type of the vault + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.StorageSettingType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/New-AzDataProtectionPolicyTagCriteriaClientObject.md b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionPolicyTagCriteriaClientObject.md new file mode 100644 index 0000000000..ef1402e9ef --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionPolicyTagCriteriaClientObject.md @@ -0,0 +1,173 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/new-azdataprotectionpolicytagcriteriaclientobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionPolicyTagCriteriaClientObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionPolicyTagCriteriaClientObject.md +--- + +# New-AzDataProtectionPolicyTagCriteriaClientObject + +## SYNOPSIS +Creates a new criteria object + +## SYNTAX + +### ScheduleCriteria (Default) +``` +New-AzDataProtectionPolicyTagCriteriaClientObject [-DaysOfWeek <DaysOfWeek[]>] + [-MonthsOfYear <MonthsOfYear[]>] [-ScheduleTimes <DateTime[]>] [-WeeksOfMonth <WeeksOfMonth[]>] + [<CommonParameters>] +``` + +### AbsoluteCriteria +``` +New-AzDataProtectionPolicyTagCriteriaClientObject -AbsoluteCriteria <AbsoluteTagCriteria> [<CommonParameters>] +``` + +### MonthlyCriteria +``` +New-AzDataProtectionPolicyTagCriteriaClientObject -DaysOfMonth <String[]> [-MonthsOfYear <MonthsOfYear[]>] + [-ScheduleTimes <DateTime[]>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new criteria object + +## EXAMPLES + +### Example 1: Create a tag with absolute criteria +```powershell +New-AzDataProtectionPolicyTagCriteriaClientObject -AbsoluteCriteria FirstOfDay +``` + +```output +ObjectType AbsoluteCriterion DaysOfTheWeek MonthsOfYear ScheduleTime WeeksOfTheMonth +---------- ----------------- ------------- ------------ ------------ --------------- +ScheduleBasedBackupCriteria {FirstOfDay} +``` + +This command creates a criteria object with absolute criteria. + +### Example 2: create a tag with weekly criteria +```powershell +New-AzDataProtectionPolicyTagCriteriaClientObject -DaysOfWeek @("Sunday", "Monday") +``` + +```output +ObjectType AbsoluteCriterion DaysOfTheWeek MonthsOfYear ScheduleTime WeeksOfTheMonth +---------- ----------------- ------------- ------------ ------------ --------------- +ScheduleBasedBackupCriteria {Sunday, Monday} +``` + +This command creates a critetia object with weekly criteria + +## PARAMETERS + +### -AbsoluteCriteria +Absolute criteria + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.AbsoluteTagCriteria +Parameter Sets: AbsoluteCriteria +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaysOfMonth +Days of the month. +Allowed values are 1 to 28 and Last + +```yaml +Type: System.String[] +Parameter Sets: MonthlyCriteria +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaysOfWeek +Days of the week + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DaysOfWeek[] +Parameter Sets: ScheduleCriteria +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonthsOfYear +Months of the year. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.MonthsOfYear[] +Parameter Sets: MonthlyCriteria, ScheduleCriteria +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleTimes +Schedule times. + +```yaml +Type: System.DateTime[] +Parameter Sets: MonthlyCriteria, ScheduleCriteria +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeeksOfMonth +Weeks of the month. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.WeeksOfMonth[] +Parameter Sets: ScheduleCriteria +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IScheduleBasedBackupCriteria + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/New-AzDataProtectionPolicyTriggerScheduleClientObject.md b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionPolicyTriggerScheduleClientObject.md new file mode 100644 index 0000000000..d0936ee419 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionPolicyTriggerScheduleClientObject.md @@ -0,0 +1,112 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/new-azdataprotectionpolicytriggerscheduleclientobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionPolicyTriggerScheduleClientObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionPolicyTriggerScheduleClientObject.md +--- + +# New-AzDataProtectionPolicyTriggerScheduleClientObject + +## SYNOPSIS +Creates new Schedule object + +## SYNTAX + +``` +New-AzDataProtectionPolicyTriggerScheduleClientObject -IntervalCount <Int32> -IntervalType <BackupFrequency> + -ScheduleDays <DateTime[]> [<CommonParameters>] +``` + +## DESCRIPTION +Creates new Schedule object + +## EXAMPLES + +### Example 1: Create a daily schedule object +```powershell +$date = Get-Date +New-AzDataProtectionPolicyTriggerScheduleClientObject -ScheduleDays $date -IntervalType Daily -IntervalCount 1 +``` + +```output +R/2021-03-03T12:49:55+05:30/P1D +``` + +This command creates a daily schedule for Azure Backup Rule + +### Example 2: Create an hourly schedule object +```powershell +$date = Get-Date +New-AzDataProtectionPolicyTriggerScheduleClientObject -ScheduleDays $date -IntervalType Hourly -IntervalCount 4 +``` + +```output +R/2021-03-03T12:49:55+05:30/PT4H +``` + +This command creates an hourly scheudle for Azure Backup Rule. + +## PARAMETERS + +### -IntervalCount +Frequency of the backup. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntervalType +Freuquency of the backup. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.BackupFrequency +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleDays +Days with which backup will be scheduled. + +```yaml +Type: System.DateTime[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.String[] + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/New-AzDataProtectionResourceGuard.md b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionResourceGuard.md new file mode 100644 index 0000000000..02ed5d8a3e --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionResourceGuard.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/new-azdataprotectionresourceguard +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionResourceGuard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionResourceGuard.md +--- + +# New-AzDataProtectionResourceGuard + +## SYNOPSIS +Creates a resource guard under a resource group + +## SYNTAX + +``` +New-AzDataProtectionResourceGuard -Location <String> -Name <String> -ResourceGroupName <String> + [-DefaultProfile <PSObject>] [-ETag <String>] [-IdentityType <String>] [-SubscriptionId <String>] + [-Tag <Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a resource guard under a resource group + +## EXAMPLES + +### Example 1: Create a new resource guard +```powershell +New-AzDataProtectionResourceGuard -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "mua-rg" -Name "mua-resource-guard" -Location "centraluseuap" +``` + +```output +ETag Id IdentityPrincipalId IdentityTenantId IdentityType Location Name +---- -- ------------------- ---------------- ------------ -------- ---- + /subscriptions/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/mua-rg/providers/Microsoft.DataProtection/resourceGuards/mua-resource-guard centraluseuap mua-resource-guard +``` + +The above command is used to create a resource guard "mua-resource-guard" under resource group "mua-rg" in location "centraluseuap" + +## PARAMETERS + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETag +Optional ETag + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The IdentityType to be added to the resource guard, example: SystemAssigned, None + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the resource guard + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the resource guard + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name of the resource guard + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id of the resource guard + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IResourceGuardResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/New-AzDataProtectionRestoreConfigurationClientObject.md b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionRestoreConfigurationClientObject.md new file mode 100644 index 0000000000..d80f33069f --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionRestoreConfigurationClientObject.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/new-azdataprotectionrestoreconfigurationclientobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionRestoreConfigurationClientObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionRestoreConfigurationClientObject.md +--- + +# New-AzDataProtectionRestoreConfigurationClientObject + +## SYNOPSIS +Creates new restore configuration object + +## SYNTAX + +``` +New-AzDataProtectionRestoreConfigurationClientObject -DatasourceType <DatasourceTypes> + [-ConflictPolicy <String>] [-ExcludedNamespace <String[]>] [-ExcludedResourceType <String[]>] + [-IncludeClusterScopeResource <Boolean?>] [-IncludedNamespace <String[]>] [-IncludedResourceType <String[]>] + [-LabelSelector <String[]>] [-NamespaceMapping <KubernetesClusterRestoreCriteriaNamespaceMappings>] + [-PersistentVolumeRestoreMode <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates new restore configuration object + +## EXAMPLES + +### Example 1: Create a RestoreConfiguration for restoring with AzureKubernetesService +```powershell +$restoreConfig = New-AzDataProtectionRestoreConfigurationClientObject -DatasourceType AzureKubernetesService -PersistentVolumeRestoreMode RestoreWithVolumeData -IncludeClusterScopeResource $true -NamespaceMapping @{"sourcenamespace1"="targetnamespace1";"sourcenamespace2"="targetnamespace2"} -ExcludedNamespace "excludeNS1","excludeNS2" +``` + +```output +ObjectType ConflictPolicy ExcludedNamespace ExcludedResourceType IncludeClusterScopeResource IncludedNamespace IncludedResourceType LabelSelector PersistentVolumeRestoreMode +---------- -------------- ----------------- -------------------- --------------------------- ----------------- -------------------- ------------- --------------------------- +KubernetesClusterRestoreCriteria Skip {excludeNS1, excludeNS2} True RestoreWithVolumeData +``` + +This command can be used to create a restore configuration client object used for Kubernetes cluster restore + +## PARAMETERS + +### -ConflictPolicy +Conflict policy for restore. +Allowed values are Skip, Patch. +Default value is Skip + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatasourceType +Datasource Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DatasourceTypes +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedNamespace +List of namespaces to be excluded for restore + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedResourceType +List of resource types to be excluded for restore + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeClusterScopeResource +Boolean parameter to decide whether cluster scope resources are included for restore. +By default this is taken as true. + +```yaml +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedNamespace +List of namespaces to be included for restore + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedResourceType +List of resource types to be included for restore + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabelSelector +List of labels for internal filtering for restore + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceMapping +Namespaces mapping from source namespaces to target namespaces to resolve namespace naming conflicts in the target cluster. +To construct, see NOTES section for NAMESPACEMAPPING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.KubernetesClusterRestoreCriteriaNamespaceMappings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PersistentVolumeRestoreMode +Restore mode for persistent volumes. +Allowed values are RestoreWithVolumeData, RestoreWithoutVolumeData. +Default value is RestoreWithVolumeData + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Management.Automation.PSObject + +## 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. + + +`NAMESPACEMAPPING <KubernetesClusterRestoreCriteriaNamespaceMappings>`: Namespaces mapping from source namespaces to target namespaces to resolve namespace naming conflicts in the target cluster. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/New-AzDataProtectionRetentionLifeCycleClientObject.md b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionRetentionLifeCycleClientObject.md new file mode 100644 index 0000000000..0f6a96c572 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/New-AzDataProtectionRetentionLifeCycleClientObject.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/new-azdataprotectionretentionlifecycleclientobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionRetentionLifeCycleClientObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/New-AzDataProtectionRetentionLifeCycleClientObject.md +--- + +# New-AzDataProtectionRetentionLifeCycleClientObject + +## SYNOPSIS +Creates new Lifecycle object + +## SYNTAX + +``` +New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore <DataStoreType> + -SourceRetentionDurationCount <Int32> -SourceRetentionDurationType <DurationType> [-CopyOption <CopyOption>] + [-TargetDataStore <DataStoreType>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates new Lifecycle object + +## EXAMPLES + +### Example 1: Create a daily retention lifecycle +```powershell +New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore OperationalStore -SourceRetentionDurationType Days -SourceRetentionDurationCount 30 +``` + +```output +DeleteAfterDuration : P30D +DeleteAfterObjectType : AbsoluteDeleteOption +SourceDataStoreObjectType : DataStoreInfoBase +SourceDataStoreType : OperationalStore +TargetDataStoreCopySetting : +``` + +This command creates a lifecycle object which stores the backup data in operational store for 30 days. + +### Example 2: Create a weekly retention lifecycle. +```powershell +New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore OperationalStore -SourceRetentionDurationType Weeks -SourceRetentionDurationCount 20 +``` + +```output +DeleteAfterDuration : P20W +DeleteAfterObjectType : AbsoluteDeleteOption +SourceDataStoreObjectType : DataStoreInfoBase +SourceDataStoreType : OperationalStore +TargetDataStoreCopySetting : +``` + +This command creates a lifecycle object which stores the backup data in operational store for 20 weeks. + +## PARAMETERS + +### -CopyOption +CopyOption + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.CopyOption +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDataStore +Source Datastore + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DataStoreType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceRetentionDurationCount +Retention Duration Count + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceRetentionDurationType +Retention Duration Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DurationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDataStore +Target Datastore + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DataStoreType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.ISourceLifeCycle + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Remove-AzDataProtectionBackupInstance.md b/azps-10.1.0/Az.DataProtection/Remove-AzDataProtectionBackupInstance.md new file mode 100644 index 0000000000..270d28333f --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Remove-AzDataProtectionBackupInstance.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/remove-azdataprotectionbackupinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Remove-AzDataProtectionBackupInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Remove-AzDataProtectionBackupInstance.md +--- + +# Remove-AzDataProtectionBackupInstance + +## SYNOPSIS +Delete a backupInstances + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDataProtectionBackupInstance -Name <String> -ResourceGroupName <String> -VaultName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDataProtectionBackupInstance -InputObject <IDataProtectionIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a backupInstances + +## EXAMPLES + +### Example 1: Delete a protected backup instance +```powershell +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "MyResourceGroup" -VaultName "MyVault" +Remove-AzDataProtectionBackupInstance -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "MyResourceGroup" -VaultName "MyVault" -Name $instance[0].name +``` + +This command stops backup and deletes backup data of a given protected backup instance. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the backup instance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: BackupInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Remove-AzDataProtectionBackupPolicy.md b/azps-10.1.0/Az.DataProtection/Remove-AzDataProtectionBackupPolicy.md new file mode 100644 index 0000000000..a1eb2ff12d --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Remove-AzDataProtectionBackupPolicy.md @@ -0,0 +1,219 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/remove-azdataprotectionbackuppolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Remove-AzDataProtectionBackupPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Remove-AzDataProtectionBackupPolicy.md +--- + +# Remove-AzDataProtectionBackupPolicy + +## SYNOPSIS +Deletes a backup policy belonging to a backup vault + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDataProtectionBackupPolicy -Name <String> -ResourceGroupName <String> -VaultName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDataProtectionBackupPolicy -InputObject <IDataProtectionIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a backup policy belonging to a backup vault + +## EXAMPLES + +### Example 1: Delete an existing policy +```powershell +$policy = Get-AzDataProtectionBackupPolicy -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "MyResourceGroup" -VaultName "MyVault" +Remove-AzDataProtectionBackupPolicy -Name $policy[0].name -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "MyResourceGroup" -VaultName "MyVault" +``` + +this command deletes an existing policy. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: BackupPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Remove-AzDataProtectionBackupVault.md b/azps-10.1.0/Az.DataProtection/Remove-AzDataProtectionBackupVault.md new file mode 100644 index 0000000000..e2a0faa735 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Remove-AzDataProtectionBackupVault.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/remove-azdataprotectionbackupvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Remove-AzDataProtectionBackupVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Remove-AzDataProtectionBackupVault.md +--- + +# Remove-AzDataProtectionBackupVault + +## SYNOPSIS +Deletes a BackupVault resource from the resource group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDataProtectionBackupVault -ResourceGroupName <String> -VaultName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDataProtectionBackupVault -InputObject <IDataProtectionIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a BackupVault resource from the resource group. + +## EXAMPLES + +### Example 1: Delete a backup vault. +```powershell +Remove-AzDataProtectionBackupVault -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "MyResourceGroup" -VaultName "MyVault" +``` + +This command deletes an existing vault. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Remove-AzDataProtectionResourceGuard.md b/azps-10.1.0/Az.DataProtection/Remove-AzDataProtectionResourceGuard.md new file mode 100644 index 0000000000..d1545873a3 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Remove-AzDataProtectionResourceGuard.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/remove-azdataprotectionresourceguard +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Remove-AzDataProtectionResourceGuard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Remove-AzDataProtectionResourceGuard.md +--- + +# Remove-AzDataProtectionResourceGuard + +## SYNOPSIS +Deletes a ResourceGuard resource from the resource group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDataProtectionResourceGuard -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDataProtectionResourceGuard -InputObject <IDataProtectionIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a ResourceGuard resource from the resource group. + +## EXAMPLES + +### Example 1: Delete a resource guard +```powershell +Remove-AzDataProtectionResourceGuard -Name "ResourceGuardName" -ResourceGroupName "ResourceGroupName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +This command is used to delete the resource guard under a resource group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of ResourceGuard + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Resume-AzDataProtectionBackupInstanceProtection.md b/azps-10.1.0/Az.DataProtection/Resume-AzDataProtectionBackupInstanceProtection.md new file mode 100644 index 0000000000..4019c2a029 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Resume-AzDataProtectionBackupInstanceProtection.md @@ -0,0 +1,249 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/resume-azdataprotectionbackupinstanceprotection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Resume-AzDataProtectionBackupInstanceProtection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Resume-AzDataProtectionBackupInstanceProtection.md +--- + +# Resume-AzDataProtectionBackupInstanceProtection + +## SYNOPSIS +This operation will resume protection for a stopped backup instance + +## SYNTAX + +### Resume (Default) +``` +Resume-AzDataProtectionBackupInstanceProtection -BackupInstanceName <String> -ResourceGroupName <String> + -VaultName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ResumeViaIdentity +``` +Resume-AzDataProtectionBackupInstanceProtection -InputObject <IDataProtectionIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +This operation will resume protection for a stopped backup instance + +## EXAMPLES + +### Example 1: Resume protection for a backup instance for which the protection state is ProtectionStopped +```powershell +Resume-AzDataProtectionBackupInstanceProtection -BackupInstanceName $backupInstance.BackupInstanceName -ResourceGroupName "rgName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" +``` + +The above command can be used to resume protection for a stopped or suspended backup instance + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupInstanceName +The name of the backup instance. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: ResumeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Search-AzDataProtectionBackupInstanceInAzGraph.md b/azps-10.1.0/Az.DataProtection/Search-AzDataProtectionBackupInstanceInAzGraph.md new file mode 100644 index 0000000000..8bda81d62c --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Search-AzDataProtectionBackupInstanceInAzGraph.md @@ -0,0 +1,168 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/search-azdataprotectionbackupinstanceinazgraph +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Search-AzDataProtectionBackupInstanceInAzGraph.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Search-AzDataProtectionBackupInstanceInAzGraph.md +--- + +# Search-AzDataProtectionBackupInstanceInAzGraph + +## SYNOPSIS +Searches for Backup instances in Azure Resource Graph and retrieves the expected entries + +## SYNTAX + +``` +Search-AzDataProtectionBackupInstanceInAzGraph -DatasourceType <DatasourceTypes> -Subscription <String[]> + [-ProtectionStatus <ProtectionStatus[]>] [-ResourceGroup <String[]>] [-Vault <String[]>] [<CommonParameters>] +``` + +## DESCRIPTION +Searches for Backup instances in Azure Resource Graph and retrieves the expected entries + +## EXAMPLES + +### Example 1: Get all protected azure disk backup instance in a given subscription +```powershell +Search-AzDataProtectionBackupInstanceInAzGraph -Subscription "xxxx-xxx-xxx" -DatasourceType AzureDisk +``` + +```output +Name Type +---- ---- +ContosoDemoVM_DataDisk_0-ContosoDemoVM_DataDisk_0-5f7b2a1f-f1ab-4abe-aadf-e7dc48238157 microsoft.dataprotection/backupvaults/backupinstance +ContosoDemoVM_OsDisk_1_84b542ec38a447cea-ContosoDemoVM_OsDisk_1_84b542ec38a447cea-9bdcbd90-3555-4651-93b8-8265e1b5c07a microsoft.dataprotection/backupvaults/backupinstance +DataDisk1-DataDisk1-0c71e6bf-9289-483c-8e27-aa6c0df60078 microsoft.dataprotection/backupvaults/backupinstance +rraj-StandardHDD-rraj-StandardHDD-85d0a3f4-7fa8-46c7-bf83-0dee27eac08e microsoft.dataprotection/backupvaults/backupinstance +sakaarhotfixtest_disk1_86d713f7b80e493b9-sakaarhotfixtest_disk1_86d713f7b80e493b9-be214c89-c07d-41f0-8362-b78d58d5506f microsoft.dataprotection/backupvaults/backupinstance +pracdisk-pracdisk-643fac7d-0816-4056-8908-d0ef8b63b047 microsoft.dataprotection/backupvaults/backupinstance +test1-test1-59f95871-de81-4051-95e7-ee6c4e5b30e0 microsoft.dataprotection/backupvaults/backupinstance +anubhwus-test-anubhwus-test-5fe6ce14-fbd2-4641-80d0-f8f8b254601d microsoft.dataprotection/backupvaults/backupinstance +``` + +This command gets all protected azure disk backup instance in a given subscription + +### Example 2: Get all protected azure disk backup instance in a given resource group list +```powershell +Search-AzDataProtectionBackupInstanceInAzGraph -Subscription "xxxx-xxx-xxx" -DatasourceType AzureDisk -ResourceGroup @("sarath-rg", "sarath-rg2") +``` + +```output +Name Type BackupInstanceName +---- ---- ------------------ +sarath-disk3-sarath-disk3-dbb8c2d0-bdbf-448c-9664-ea74df26d4a8 microsoft.dataprotection/backupvaults/backupinstances sarath-disk3-sarath-disk3-dbb8c2d0-bdbf-448c-9664-ea7 +sarathdisk-sarathdisk-3df6ac08-9496-4839-8fb5-8b78e594f166 microsoft.dataprotection/backupvaults/backupinstances sarathdisk-sarathdisk-3df6ac08-9496-4839-8fb5-8b78e59 +sarathdisk2-sarathdisk2-b0bf31ab-c9c5-407f-98a2-3ad6bad4305a microsoft.dataprotection/backupvaults/backupinstances sarathdisk2-sarathdisk2-b0bf31ab-c9c5-407f-98a2-3ad6b +``` + +This commands gets all protected azure disk backup instance in a given set of resource groups + +### Example 3: Get all protected azure disk backup instance in a given resource group list with protection state 'ProtectionConfigured' +```powershell +Search-AzDataProtectionBackupInstanceInAzGraph -Subscription "xxxx-xxx-xxx" -DatasourceType AzureDisk -ResourceGroup @("sarath-rg", "sarath-rg2") -ProtectionStatus ProtectionConfigured +``` + +```output +Name Type BackupInstanceName +---- ---- ------------------ +sarath-disk3-sarath-disk3-dbb8c2d0-bdbf-448c-9664-ea74df26d4a8 microsoft.dataprotection/backupvaults/backupinstances sarath-disk3-sarath-disk3-dbb8c2d0-bdbf-448c-9664-ea7 +sarathdisk-sarathdisk-3df6ac08-9496-4839-8fb5-8b78e594f166 microsoft.dataprotection/backupvaults/backupinstances sarathdisk-sarathdisk-3df6ac08-9496-4839-8fb5-8b78e59 +sarathdisk2-sarathdisk2-b0bf31ab-c9c5-407f-98a2-3ad6bad4305a microsoft.dataprotection/backupvaults/backupinstances sarathdisk2-sarathdisk2-b0bf31ab-c9c5-407f-98a2-3ad6b +``` + +This commands gets all protected azure disk backup instance in a given set of resource groups with protection status as ProtectionConfigured + +## PARAMETERS + +### -DatasourceType +Datasource Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DatasourceTypes +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionStatus +Protection Status of the item + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.ProtectionStatus[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +Resource Group of Vault + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subscription +Subscription of Vault + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vault +Name of the vault + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Search-AzDataProtectionJobInAzGraph.md b/azps-10.1.0/Az.DataProtection/Search-AzDataProtectionJobInAzGraph.md new file mode 100644 index 0000000000..80b940571d --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Search-AzDataProtectionJobInAzGraph.md @@ -0,0 +1,196 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/search-azdataprotectionjobinazgraph +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Search-AzDataProtectionJobInAzGraph.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Search-AzDataProtectionJobInAzGraph.md +--- + +# Search-AzDataProtectionJobInAzGraph + +## SYNOPSIS +Searches for Backup Jobs in Azure Resource Graph and retrieves the expected entries + +## SYNTAX + +``` +Search-AzDataProtectionJobInAzGraph -DatasourceType <DatasourceTypes> -Subscription <String[]> + [-EndTime <DateTime>] [-Operation <JobOperation[]>] [-ResourceGroup <String[]>] [-StartTime <DateTime>] + [-Status <JobStatus[]>] [-Vault <String[]>] [<CommonParameters>] +``` + +## DESCRIPTION +Searches for Backup Jobs in Azure Resource Graph and retrieves the expected entries + +## EXAMPLES + +### Example 1: Get all jobs in a certain time range +```powershell +$endtime = Get-Date +$starttime = $endtime.AddHours(-5) +Search-AzDataProtectionJobInAzGraph -Subscription "xxx-xxx-xxx" -ResourceGroup sarath-rg -Vault sarath-vault -DatasourceType AzureDisk -StartTime $starttime -EndTime $endtime +``` + +```output +Name Type +---- ---- +1c1d56c2-b21a-4038-ba46-3c1a0089e66a microsoft.dataprotection/backupvaults/backupjobs +79f2804d-a39d-487e-91b5-f2eceffcbb7a microsoft.dataprotection/backupvaults/backupjobs +96238abd-6ff3-48e0-8c07-0eabd6928a17 microsoft.dataprotection/backupvaults/backupjobs +``` + +This command gets all jobs in a vault in last 5 hours. + +### Example 2: Get all jobs of a certain operation type +```powershell +Search-AzDataProtectionJobInAzGraph -Subscription "xxxx-xxx-xxx" -ResourceGroup sarath-rg -Vault sarath-vault -DatasourceType AzureDisk -Operation OnDemandBackup +``` + +```output +Name Type +---- ---- +11bc277d-9448-446a-9e79-4721858524d6 microsoft.dataprotection/backupvaults/backupjobs +16d7b56a-e169-41d1-aa10-cafcc19c8e12 microsoft.dataprotection/backupvaults/backupjobs +1b0b17e3-398f-4265-9d03-ffc1e21fa73a microsoft.dataprotection/backupvaults/backupjobs +``` + +This command gets all ondemand backup jobs in a vault. + +## PARAMETERS + +### -DatasourceType +Datasource Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.DatasourceTypes +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +End Time filter for the Backup Job + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operation +Operation filter for the backup job + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.JobOperation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +Resource Group of Vault + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Start Time filter for the backup Job + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Status filter for the backup job + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.JobStatus[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subscription +Subscription of Vault + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vault +Name of the vault + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Set-AzDataProtectionMSIPermission.md b/azps-10.1.0/Az.DataProtection/Set-AzDataProtectionMSIPermission.md new file mode 100644 index 0000000000..f06102c495 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Set-AzDataProtectionMSIPermission.md @@ -0,0 +1,306 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/set-azdataprotectionmsipermission +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Set-AzDataProtectionMSIPermission.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Set-AzDataProtectionMSIPermission.md +--- + +# Set-AzDataProtectionMSIPermission + +## SYNOPSIS +Grants required permissions to the backup vault and other resources for configure backup and restore scenarios + +## SYNTAX + +### SetPermissionsForBackup (Default) +``` +Set-AzDataProtectionMSIPermission -BackupInstance <IBackupInstanceResource> -PermissionsScope <String> + -VaultName <String> -VaultResourceGroup <String> [-KeyVaultId <String>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### SetPermissionsForRestore +``` +Set-AzDataProtectionMSIPermission -PermissionsScope <String> -RestoreRequest <IAzureBackupRestoreRequest> + -SnapshotResourceGroupId <String> -VaultName <String> -VaultResourceGroup <String> [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Grants required permissions to the backup vault and other resources for configure backup and restore scenarios + +## EXAMPLES + +### Example 1: Grant Permissions for Azure Disks +```powershell +Set-AzDataProtectionMSIPermission -BackupInstance $instance -VaultResourceGroup "VaultRG" -VaultName "Vaultname" -PermissionsScope "ResourceGroup" + +``` + +```output +Assigning Disk Backup Reader permission to the backup vault +Assigned Disk Backup Reader permission to the backup vault +Assigning Disk Snapshot Contributor permission to the backup vault +Assigned Disk Snapshot Contributor permission to the backup vault +Waiting for 60 seconds for roles to propagate +``` + +The above command is used to assign permissions to the backup vault "Vaultname" under resource group "VaultRG" at the "Resource Group" scope of the disk. + +### Example 2: Grant Permissions for Azure Blobs +```powershell +Set-AzDataProtectionMSIPermission -BackupInstance $instance -VaultResourceGroup "VaultRG" -VaultName "Vaultname" -PermissionsScope "Subscription" +``` + +```output +Assigning Storage Account Backup Contributor permission to the backup vault +Assigned Storage Account Backup Contributor permission to the backup vault +Waiting for 60 seconds for roles to propagate +``` + +The above command is used to assign permissions to the backup vault "Vaultname" under resource group "VaultRG" at the "Subscription" scope of the blob. + +### Example 3: Grant Permissions for Azure Database For PostgreSQL +```powershell +Set-AzDataProtectionMSIPermission -KeyVaultId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/Sqlrg/providers/Microsoft.KeyVault/vaults/testkeyvault" -BackupInstance $instance -VaultResourceGroup "VaultRG" -VaultName "Vaultname" -PermissionsScope "Resource" + +``` + +```output +Confirm +Are you sure you want to perform this action? +Performing the operation " + 1.'Allow All Azure services' under network connectivity in the Postgres Server + 2.'Allow Trusted Azure services' under network connectivity in the Key vault" on target "KeyVault: oss-pstest-keyvault and PostgreSQLServer: oss-pstest-server". +[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A +Assigning Reader permission to the backup vault +Assigned Reader permission to the backup vault +Waiting for 60 seconds for roles to propagate +``` + +The above command is used to assign permissions to the backup vault "Vaultname" under resource group "VaultRG" at the "Resource" scope of the Azure Database For PostgreSQL. +It takes an additional KeyVaultId parameter to assign the necessary permissions to the backup vault on the keyvault. + +### Example 4: Grant missing permissions to configure backup for AzureKubernetesService +```powershell +Set-AzDataProtectionMSIPermission -BackupInstance $backupInstance -VaultResourceGroup "resourceGroupName" -VaultName "vaultName" -PermissionsScope "ResourceGroup" +``` + +```output +Confirm +Are you sure you want to perform this action? +Performing the operation "Allow Contributor permission over snapshot resource group" on target +"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.ContainerService/managedClusters/aks-cluster". +[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y +Assigned Contributor permission to DataSource with Id /subscriptions/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.ContainerService/managedClusters/aks-cluster over snapshot resource group with Id /subscriptions/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/snapshotResourceGroup +Assigned Reader permission to the backup vault over snapshot resource group with Id /subscriptions/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/snapshotResourceGroup +Required permission Reader is already assigned to backup vault over DataSource with Id /subscriptions/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.ContainerService/managedClusters/aks-cluster +Waiting for 60 seconds for roles to propagate +``` + +The above command is used to assign permissions to the backup vault "VaultName" under resource group "resourceGroupName" at the "ResourceGroup" scope. + +## PARAMETERS + +### -BackupInstance +Backup instance request object which will be used to configure backup +To construct, see NOTES section for BACKUPINSTANCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupInstanceResource +Parameter Sets: SetPermissionsForBackup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultId +ID of the keyvault + +```yaml +Type: System.String +Parameter Sets: SetPermissionsForBackup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionsScope +Scope at which the permissions need to be granted + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreRequest +Restore request object which will be used for restore +To construct, see NOTES section for RESTOREREQUEST properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IAzureBackupRestoreRequest +Parameter Sets: SetPermissionsForRestore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnapshotResourceGroupId +Sanpshot Resource Group + +```yaml +Type: System.String +Parameter Sets: SetPermissionsForRestore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Name of the backup vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultResourceGroup +Resource group of the backup vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## 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. + + +`BACKUPINSTANCE <IBackupInstanceResource>`: Backup instance request object which will be used to configure backup + - `[Tag <IDppProxyResourceTags>]`: Proxy Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[Property <IBackupInstance>]`: BackupInstanceResource properties + - `DataSourceInfo <IDatasource>`: Gets or sets the data source information. + - `ResourceId <String>`: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. + - `[ObjectType <String>]`: Type of Datasource object, used to initialize the right inherited type + - `[ResourceLocation <String>]`: Location of datasource. + - `[ResourceName <String>]`: Unique identifier of the resource in the context of parent. + - `[ResourceType <String>]`: Resource Type of Datasource. + - `[ResourceUri <String>]`: Uri of the resource. + - `[Type <String>]`: DatasourceType of the resource. + - `ObjectType <String>`: + - `PolicyInfo <IPolicyInfo>`: Gets or sets the policy information. + - `PolicyId <String>`: + - `[PolicyParameter <IPolicyParameters>]`: Policy parameters for the backup instance + - `[BackupDatasourceParametersList <IBackupDatasourceParameters[]>]`: Gets or sets the Backup Data Source Parameters + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[DataStoreParametersList <IDataStoreParameters[]>]`: Gets or sets the DataStore Parameters + - `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[DataSourceSetInfo <IDatasourceSet>]`: Gets or sets the data source set information. + - `ResourceId <String>`: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. + - `[DatasourceType <String>]`: DatasourceType of the resource. + - `[ObjectType <String>]`: Type of Datasource object, used to initialize the right inherited type + - `[ResourceLocation <String>]`: Location of datasource. + - `[ResourceName <String>]`: Unique identifier of the resource in the context of parent. + - `[ResourceType <String>]`: Resource Type of Datasource. + - `[ResourceUri <String>]`: Uri of the resource. + - `[DatasourceAuthCredentials <IAuthCredentials>]`: Credentials to use to authenticate with data source provider. + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[FriendlyName <String>]`: Gets or sets the Backup Instance friendly name. + - `[ValidationType <ValidationType?>]`: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. + +`RESTOREREQUEST <IAzureBackupRestoreRequest>`: Restore request object which will be used for restore + - `ObjectType <String>`: + - `RestoreTargetInfo <IRestoreTargetInfoBase>`: Gets or sets the restore target information. + - `ObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `[RestoreLocation <String>]`: Target Restore region + - `SourceDataStoreType <SourceDataStoreType>`: Gets or sets the type of the source data store. + - `[SourceResourceId <String>]`: Fully qualified Azure Resource Manager ID of the datasource which is being recovered. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Start-AzDataProtectionBackupInstanceRestore.md b/azps-10.1.0/Az.DataProtection/Start-AzDataProtectionBackupInstanceRestore.md new file mode 100644 index 0000000000..81a0deba07 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Start-AzDataProtectionBackupInstanceRestore.md @@ -0,0 +1,428 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/start-azdataprotectionbackupinstancerestore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Start-AzDataProtectionBackupInstanceRestore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Start-AzDataProtectionBackupInstanceRestore.md +--- + +# Start-AzDataProtectionBackupInstanceRestore + +## SYNOPSIS +Triggers restore for a BackupInstance + +## SYNTAX + +### Trigger (Default) +``` +Start-AzDataProtectionBackupInstanceRestore -BackupInstanceName <String> -ResourceGroupName <String> + -VaultName <String> -Parameter <IAzureBackupRestoreRequest> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### TriggerExpanded +``` +Start-AzDataProtectionBackupInstanceRestore -BackupInstanceName <String> -ResourceGroupName <String> + -VaultName <String> -ObjectType <String> -RestoreTargetInfo <IRestoreTargetInfoBase> + -SourceDataStoreType <SourceDataStoreType> [-SubscriptionId <String>] [-SourceResourceId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Triggers restore for a BackupInstance + +## EXAMPLES + +### Example 1: Trigger restore for a protected azure disk. +```powershell +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxx-xxx-xxx" -ResourceGroupName "sarath-rg" -VaultName "sarath-vault" +$rp = Get-AzDataProtectionRecoveryPoint -SubscriptionId "xxx-xxx-xxx" -ResourceGroupName "sarath-rg" -VaultName "sarath-vault" -BackupInstanceName $instance.Name +$restoreRequest = Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureDisk -SourceDataStore OperationalStore -RestoreLocation "westus" -RestoreType AlternateLocation -TargetResourceId "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/disks/{DiskName}" -RecoveryPoint $rp[0].name +Start-AzDataProtectionBackupInstanceRestore -BackupInstanceName $instance.BackupInstanceName -ResourceGroupName sarath-rg -VaultName sarath-vault -SubscriptionId "xxx-xxx-xxx" -Parameter $restorerequest +``` + + + +### Example 2: Trigger restore as DB for protected AzureDatabaseForPostgreSQL using secret store. +```powershell +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" +$rp = Get-AzDataProtectionRecoveryPoint -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -BackupInstanceName $instance.Name +$targetResourceId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.DBforPostgreSQL/servers/serverName/databases/targetDbName" +$secretURI = "https://oss-keyvault.vault.azure.net/secrets/oss-secret" +$restoreRequest = Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureDatabaseForPostgreSQL -SourceDataStore VaultStore -RestoreLocation "westus" -RestoreType AlternateLocation -TargetResourceId $targetResourceId -RecoveryPoint $rp[0].Property.RecoveryPointId -SecretStoreURI $secretURI -SecretStoreType AzureKeyVault +$restoreJob = Start-AzDataProtectionBackupInstanceRestore -BackupInstanceName $instance.BackupInstanceName -ResourceGroupName resourceGroupName -VaultName vaultName -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Parameter $restorerequest +$jobid = $restoreJob.JobId.Split("/")[-1] +$jobstatus = "InProgress" +while($jobstatus -ne "Completed") +{ + Start-Sleep -Seconds 10 + $currentjob = Get-AzDataProtectionJob -Id $jobid -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" + $jobstatus = $currentjob.Status +} +``` + +The first, second commands fetch the instance and recovery point for the instance. +The third command initializes the $targetResourceId with the Id of target postgre database (targetDbName should be the new database name). +The fourth command initializes the secret URI. +The fifth, sixth command initializes and triggers the restore request for AzureDatabaseForPostgreSQL with secret store. +The seventh, eight, ninth commands track the restore job to completion. + +### Example 3: Trigger restore as files for protected AzureDatabaseForPostgreSQL. +```powershell +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" +$rp = Get-AzDataProtectionRecoveryPoint -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -BackupInstanceName $instance.Name +$targetContainerURI = "https://targetStorageAccount.blob.core.windows.net/targetContainerName" +$fileNamePrefix = "restore_as_files_12345" +$restoreRequest = Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureDatabaseForPostgreSQL -SourceDataStore VaultStore -RestoreLocation "westus" -RestoreType RestoreAsFiles -RecoveryPoint $rp[0].Property.RecoveryPointId -TargetContainerURI $targetContainerURI -FileNamePrefix $fileNamePrefix +$restoreJob = Start-AzDataProtectionBackupInstanceRestore -BackupInstanceName $instance.BackupInstanceName -ResourceGroupName resourceGroupName -VaultName vaultName -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Parameter $restorerequest +$jobid = $restoreJob.JobId.Split("/")[-1] +$jobstatus = "InProgress" +while($jobstatus -ne "Completed") +{ + Start-Sleep -Seconds 10 + $currentjob = Get-AzDataProtectionJob -Id $jobid -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" + $jobstatus = $currentjob.Status +} +``` + +The first, second commands fetch the instance and recovery point for the instance. +The third command initializes the $targetContainerURI with the Id of target storage account container. +The fourth command initializes the file name prefix for restore. +The fifth, sixth command initializes and triggers the restore request for AzureDatabaseForPostgreSQL with secret store. +The seventh, eight, ninth commands track the restore job to completion. + +### Example 4: Trigger restore as Files for protected AzureKubernetesService. +```powershell +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" | Where { $_.Name -match "aks-cluster-name" } +$rp = Get-AzDataProtectionRecoveryPoint -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -BackupInstanceName $instance.Name +$aksRestoreCriteria = New-AzDataProtectionRestoreConfigurationClientObject -DatasourceType AzureKubernetesService -PersistentVolumeRestoreMode RestoreWithVolumeData -IncludeClusterScopeResource $true -NamespaceMapping @{"sourceNamespace1"="targetNamespace1";"sourceNamespace2"="targetNamespace2"} +$snapshotResourceGroupId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/snapshotResourceGroup" +$aksOLRRestoreRequest = Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureKubernetesService -SourceDataStore OperationalStore -RestoreLocation eastus -RestoreType OriginalLocation -RecoveryPoint $rps[0].Property.RecoveryPointId -RestoreConfiguration $aksRestoreCriteria -BackupInstance $instance + +Set-AzDataProtectionMSIPermission -VaultResourceGroup "resourceGroupName" -VaultName "vaultName" -PermissionsScope "ResourceGroup" -RestoreRequest $aksOLRRestoreRequest -SnapshotResourceGroupId $snapshotResourceGroupId +$validateRestore = Test-AzDataProtectionBackupInstanceRestore -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -RestoreRequest $aksOLRRestoreRequest -Name $instance.BackupInstanceName +$restoreJob = Start-AzDataProtectionBackupInstanceRestore -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -BackupInstanceName $instance.BackupInstanceName -Parameter $aksOLRRestoreRequest +``` + +The first, second commands fetch the instance and recovery point for the instance. +The third command initializes the Restore Configuration client object used to initialize restore request client object. +The fourth command initializes the snapshot resource group Id. +The fifth command initializes the restore request object for AzureKubernetesService restore. +The sixth command assigns the permissions to the backup vault and target AKS cluster necessary for triggering the restore for AzureKubernetesService. +The last command triggers the restore for AzureKubernetesService. + +### Example 5: Trigger restore for vaulted blobs. +```powershell +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" | Where { $_.Name -match "storageAcountName" } +$rp = Get-AzDataProtectionRecoveryPoint -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -BackupInstanceName $instance.Name +$backedUpContainers = $instance.Property.PolicyInfo.PolicyParameter.BackupDatasourceParametersList[0].ContainersList +$restoreReq = Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureBlob -SourceDataStore VaultStore -RestoreLocation "vaultLocation" -RecoveryPoint $rp[0].Name -ItemLevelRecovery -RestoreType AlternateLocation -TargetResourceId "targetStorageAccountId" -ContainersList $backedUpContainers[0,1] +Test-AzDataProtectionBackupInstanceRestore -Name $instance[0].Name -ResourceGroupName "resourceGroupName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" -RestoreRequest $restoreReq +$restoreJob = Start-AzDataProtectionBackupInstanceRestore -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -BackupInstanceName $instance.BackupInstanceName -Parameter $restoreReq +``` + +The first, second commands fetch the instance and recovery point for the instance. +The third command fetches the containers which are protected with vaulted policy. +The fourth command initializes the restore request object for AzureBlob restore. +The fifth command triggers validate before restore. +The last command triggers the restore for vaulted blob containers. + +### Example 6: Trigger cross subscription restore for vaulted blobs. +```powershell +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" | Where { $_.Name -match "storageAcountName" } +$rp = Get-AzDataProtectionRecoveryPoint -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -BackupInstanceName $instance.Name +$backedUpContainers = $instance.Property.PolicyInfo.PolicyParameter.BackupDatasourceParametersList[0].ContainersList +$targetCrossSubscriptionStorageAccountId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/targetStorageAccount" +$restoreReqCSR = Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureBlob -SourceDataStore VaultStore -RestoreLocation "vaultLocation" -RecoveryPoint $rp[0].Name -ItemLevelRecovery -RestoreType AlternateLocation -TargetResourceId $targetCrossSubscriptionStorageAccountId -ContainersList $backedUpContainers[0,1] +Test-AzDataProtectionBackupInstanceRestore -Name $instance[0].Name -ResourceGroupName "resourceGroupName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" -RestoreRequest $restoreReqCSR +$restoreJobCSR = Start-AzDataProtectionBackupInstanceRestore -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -BackupInstanceName $instance.BackupInstanceName -Parameter $restoreReqCSR +``` + +The first, second commands fetch the instance and recovery point for the instance. +The third command fetches the containers which are protected with vaulted policy. +The fourth command initializes the target cross subscription storage account Id. +The fifth command initializes the restore request object for cross subscription AzureBlob restore. +The sixth command triggers validate before restore. +The last command triggers cross subscription restore for vaulted blob containers. + +### Example 7: Trigger cross subscription restore as files for AzureDatabaseForPostgreSQL. +```powershell +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" | Where { $_.Property.DataSourceInfo.ResourceType -match "Postgre" } +$rp = Get-AzDataProtectionRecoveryPoint -BackupInstanceName $instance[0].BackupInstanceName -ResourceGroupName "resourceGroupName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" +$targetResourceArmId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/crossSubResourceGroupName/providers/Microsoft.Storage/storageAccounts/akneemasaecy/blobServices/default/containers/oss-csr-container" +$targetContainerURI = "https://akneemasaecy.blob.core.windows.net/oss-csr-container" +$fileNamePrefix = "oss-csr-pstest-restoreasfiles" +$ossRestoreReqFiles = Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureDatabaseForPostgreSQL -SourceDataStore VaultStore -RestoreLocation "vaultLocation" -RestoreType RestoreAsFiles -RecoveryPoint $rp[0].Property.RecoveryPointId -TargetContainerURI $targetContainerURI -FileNamePrefix $fileNamePrefix -TargetResourceIdForRestoreAsFile $targetContainerArmId +$validateRestore = Test-AzDataProtectionBackupInstanceRestore -Name $instance[0].Name -ResourceGroupName "resourceGroupName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" -RestoreRequest $ossRestoreReqFiles +$restoreJobCSR = Start-AzDataProtectionBackupInstanceRestore -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -BackupInstanceName $instance.BackupInstanceName -Parameter $ossRestoreReqFiles +$jobid = $restoreJobCSR.JobId.Split("/")[-1] +$jobstatus = "InProgress" +while($jobstatus -ne "Completed") +{ + Start-Sleep -Seconds 10 + $currentjob = Get-AzDataProtectionJob -Id $jobid -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" + $jobstatus = $currentjob.Status +} +``` + +The first, second commands fetch the backup instance and recovery point for the backup instance. +The third command initializes the ARM Id for target container. +This parameter is needed for cross sub restore for AzureDatabaseForPostgreSQL and not needed for same susbscription restore. +The fourth, fifth command initializes targetContainerURI and fileNamePrefix for restore. +The sixth command initializes the restore request object for AzureDatabaseForPostgreSQL restore. +The seventh command triggers validate before restore. +The last command triggers the cross subscription restore as files for AzureDatabaseForPostgreSQL. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupInstanceName +The name of the backup instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectType +. + +```yaml +Type: System.String +Parameter Sets: TriggerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Azure backup restore request +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IAzureBackupRestoreRequest +Parameter Sets: Trigger +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreTargetInfo +Gets or sets the restore target information. +To construct, see NOTES section for RESTORETARGETINFO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IRestoreTargetInfoBase +Parameter Sets: TriggerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDataStoreType +Gets or sets the type of the source data store. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SourceDataStoreType +Parameter Sets: TriggerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceResourceId +Fully qualified Azure Resource Manager ID of the datasource which is being recovered. + +```yaml +Type: System.String +Parameter Sets: TriggerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IAzureBackupRestoreRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IOperationJobExtendedInfo + +## 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. + + +`PARAMETER <IAzureBackupRestoreRequest>`: Azure backup restore request + - `ObjectType <String>`: + - `RestoreTargetInfo <IRestoreTargetInfoBase>`: Gets or sets the restore target information. + - `ObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `[RestoreLocation <String>]`: Target Restore region + - `SourceDataStoreType <SourceDataStoreType>`: Gets or sets the type of the source data store. + - `[SourceResourceId <String>]`: Fully qualified Azure Resource Manager ID of the datasource which is being recovered. + +`RESTORETARGETINFO <IRestoreTargetInfoBase>`: Gets or sets the restore target information. + - `ObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `[RestoreLocation <String>]`: Target Restore region + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Stop-AzDataProtectionBackupInstanceProtection.md b/azps-10.1.0/Az.DataProtection/Stop-AzDataProtectionBackupInstanceProtection.md new file mode 100644 index 0000000000..436c5997ea --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Stop-AzDataProtectionBackupInstanceProtection.md @@ -0,0 +1,249 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/stop-azdataprotectionbackupinstanceprotection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Stop-AzDataProtectionBackupInstanceProtection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Stop-AzDataProtectionBackupInstanceProtection.md +--- + +# Stop-AzDataProtectionBackupInstanceProtection + +## SYNOPSIS +This operation will stop protection of a backup instance and data will be held forever + +## SYNTAX + +### Stop (Default) +``` +Stop-AzDataProtectionBackupInstanceProtection -BackupInstanceName <String> -ResourceGroupName <String> + -VaultName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzDataProtectionBackupInstanceProtection -InputObject <IDataProtectionIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +This operation will stop protection of a backup instance and data will be held forever + +## EXAMPLES + +### Example 1: Stop protection for a backup instance +```powershell +Stop-AzDataProtectionBackupInstanceProtection -ResourceGroupName "rgName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" -BackupInstanceName $backupInstance.BackupInstanceName +``` + +The above command can be used to stop protection of a backup instance + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupInstanceName +The name of the backup instance. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Suspend-AzDataProtectionBackupInstanceBackup.md b/azps-10.1.0/Az.DataProtection/Suspend-AzDataProtectionBackupInstanceBackup.md new file mode 100644 index 0000000000..d2f50225fb --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Suspend-AzDataProtectionBackupInstanceBackup.md @@ -0,0 +1,249 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/suspend-azdataprotectionbackupinstancebackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Suspend-AzDataProtectionBackupInstanceBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Suspend-AzDataProtectionBackupInstanceBackup.md +--- + +# Suspend-AzDataProtectionBackupInstanceBackup + +## SYNOPSIS +This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever) + +## SYNTAX + +### Suspend (Default) +``` +Suspend-AzDataProtectionBackupInstanceBackup -BackupInstanceName <String> -ResourceGroupName <String> + -VaultName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### SuspendViaIdentity +``` +Suspend-AzDataProtectionBackupInstanceBackup -InputObject <IDataProtectionIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever) + +## EXAMPLES + +### Example 1: Suspend backups for a backup instance +```powershell +Suspend-AzDataProtectionBackupInstanceBackup -ResourceGroupName "rgName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" -BackupInstanceName $backupInstance.BackupInstanceName +``` + +The above command can be used to stop backups of a backup instance, this will move the backup instance to a suspended state. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupInstanceName +The name of the backup instance. + +```yaml +Type: System.String +Parameter Sets: Suspend +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: SuspendViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Suspend +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Suspend +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: Suspend +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Sync-AzDataProtectionBackupInstance.md b/azps-10.1.0/Az.DataProtection/Sync-AzDataProtectionBackupInstance.md new file mode 100644 index 0000000000..c7994e9279 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Sync-AzDataProtectionBackupInstance.md @@ -0,0 +1,222 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/sync-azdataprotectionbackupinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Sync-AzDataProtectionBackupInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Sync-AzDataProtectionBackupInstance.md +--- + +# Sync-AzDataProtectionBackupInstance + +## SYNOPSIS +Sync backup instance again in case of failure\r\nThis action will retry last failed operation and will bring backup instance to valid state + +## SYNTAX + +``` +Sync-AzDataProtectionBackupInstance -Name <String> -ResourceGroupName <String> -VaultName <String> + [-SubscriptionId <String>] [-SyncType <SyncType>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Sync backup instance again in case of failure\r\nThis action will retry last failed operation and will bring backup instance to valid state + +## EXAMPLES + +### Example 1: Sync backup instance again in case of failure +```powershell +Sync-AzDataProtectionBackupInstance -ResourceGroupName "rgName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "vaultName" -BackupInstanceName $backupInstance.BackupInstanceName +``` + +The above command is used to sync backup instance again in case of failure. +This action will retry last failed operation and will bring backup instance to valid state. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the backup instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BackupInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncType +Field indicating sync type e.g. +to sync only in case of failure or in all cases + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SyncType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Test-AzDataProtectionBackupInstanceReadiness.md b/azps-10.1.0/Az.DataProtection/Test-AzDataProtectionBackupInstanceReadiness.md new file mode 100644 index 0000000000..8f365bcc86 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Test-AzDataProtectionBackupInstanceReadiness.md @@ -0,0 +1,237 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/test-azdataprotectionbackupinstancereadiness +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Test-AzDataProtectionBackupInstanceReadiness.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Test-AzDataProtectionBackupInstanceReadiness.md +--- + +# Test-AzDataProtectionBackupInstanceReadiness + +## SYNOPSIS +Validate whether adhoc backup will be successful or not + +## SYNTAX + +``` +Test-AzDataProtectionBackupInstanceReadiness -ResourceGroupName <String> -VaultName <String> + -BackupInstance <IBackupInstance> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Validate whether adhoc backup will be successful or not + +## EXAMPLES + +### Example 1: Test the backup instance +```powershell +$vault = Get-AzDataProtectionBackupVault -ResourceGroupName "resourceGroupName" -VaultName "vaultName" +$diskBackupPolicy = Get-AzDataProtectionBackupPolicy -ResourceGroupName "resourceGroupName" -VaultName $vault.Name -Name "diskBackupPolicy" +$diskId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/rgName/providers/Microsoft.Compute/disks/test-disk" +$snapshotRG = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rgName" +$instance = Initialize-AzDataProtectionBackupInstance -SnapshotResourceGroupId $Snapshotrg -DatasourceType AzureDisk -DatasourceLocation $vault.Location -PolicyId $diskBackupPolicy[0].Id -DatasourceId $diskId +Test-AzDataProtectionBackupInstanceReadiness -ResourceGroupName "resourceGroupName" -VaultName $vault.Name -BackupInstance $instance[0].Property +``` + +The first command gets the backup vault. +The second command gets the disk policy. +Next we initialize $diskId and $snapshotRG variables with disk and snapshot ARM Ids. +The fifth line runs the Initialize command to create a client side backup instance object. +Finally we trigger the Test-AzDataProtectionBackupInstanceReadiness command to validate whether the backup instance is ready for configuring backup or not, the command will fail or pass accordingly. +This command can be use to check whether the backup vault has all the necessary permissions to configure backup. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupInstance +Backup Instance +To construct, see NOTES section for BACKUPINSTANCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupInstance +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IOperationJobExtendedInfo + +## 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. + + +`BACKUPINSTANCE <IBackupInstance>`: Backup Instance + - `DataSourceInfo <IDatasource>`: Gets or sets the data source information. + - `ResourceId <String>`: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. + - `[ObjectType <String>]`: Type of Datasource object, used to initialize the right inherited type + - `[ResourceLocation <String>]`: Location of datasource. + - `[ResourceName <String>]`: Unique identifier of the resource in the context of parent. + - `[ResourceType <String>]`: Resource Type of Datasource. + - `[ResourceUri <String>]`: Uri of the resource. + - `[Type <String>]`: DatasourceType of the resource. + - `ObjectType <String>`: + - `PolicyInfo <IPolicyInfo>`: Gets or sets the policy information. + - `PolicyId <String>`: + - `[PolicyParameter <IPolicyParameters>]`: Policy parameters for the backup instance + - `[BackupDatasourceParametersList <IBackupDatasourceParameters[]>]`: Gets or sets the Backup Data Source Parameters + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[DataStoreParametersList <IDataStoreParameters[]>]`: Gets or sets the DataStore Parameters + - `DataStoreType <DataStoreTypes>`: type of datastore; Operational/Vault/Archive + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[DataSourceSetInfo <IDatasourceSet>]`: Gets or sets the data source set information. + - `ResourceId <String>`: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. + - `[DatasourceType <String>]`: DatasourceType of the resource. + - `[ObjectType <String>]`: Type of Datasource object, used to initialize the right inherited type + - `[ResourceLocation <String>]`: Location of datasource. + - `[ResourceName <String>]`: Unique identifier of the resource in the context of parent. + - `[ResourceType <String>]`: Resource Type of Datasource. + - `[ResourceUri <String>]`: Uri of the resource. + - `[DatasourceAuthCredentials <IAuthCredentials>]`: Credentials to use to authenticate with data source provider. + - `ObjectType <String>`: Type of the specific object - used for deserializing + - `[FriendlyName <String>]`: Gets or sets the Backup Instance friendly name. + - `[ValidationType <ValidationType?>]`: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Test-AzDataProtectionBackupInstanceRestore.md b/azps-10.1.0/Az.DataProtection/Test-AzDataProtectionBackupInstanceRestore.md new file mode 100644 index 0000000000..1f97c99e8d --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Test-AzDataProtectionBackupInstanceRestore.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/test-azdataprotectionbackupinstancerestore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Test-AzDataProtectionBackupInstanceRestore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Test-AzDataProtectionBackupInstanceRestore.md +--- + +# Test-AzDataProtectionBackupInstanceRestore + +## SYNOPSIS +Validates if Restore can be triggered for a DataSource + +## SYNTAX + +``` +Test-AzDataProtectionBackupInstanceRestore -Name <String> -ResourceGroupName <String> + -RestoreRequest <IAzureBackupRestoreRequest> -VaultName <String> [-AsJob] [-DefaultProfile <PSObject>] + [-NoWait] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Validates if Restore can be triggered for a DataSource + +## EXAMPLES + +### Example 1: Test the backup instance object for restore operation +```powershell +$instances = Get-AzDataProtectionBackupInstance -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "testResourceGroup" -VaultName "testVault" +$pointInTimeRange = Find-AzDataProtectionRestorableTimeRange -BackupInstanceName $instances[0].BackupInstanceName -ResourceGroupName "testResourceGroup" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "testVault" -SourceDataStoreType OperationalStore -StartTime (Get-Date).AddDays(-30).ToString("yyyy-MM-ddTHH:mm:ss.0000000Z") -EndTime (Get-Date).AddDays(0).ToString("yyyy-MM-ddTHH:mm:ss.0000000Z") +$vault = Get-AzDataProtectionBackupVault -ResourceGroupName "testResourceGroup" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "testVault" +$RestoreRequestObject = Initialize-AzDataProtectionRestoreRequest -DatasourceType AzureBlob -SourceDataStore OperationalStore -RestoreLocation $vault.Location -RestoreType OriginalLocation -BackupInstance $instances[0] -PointInTime (Get-Date -Date $pointInTimeRange.RestorableTimeRange.EndTime) +$validateRestore = Test-AzDataProtectionBackupInstanceRestore -Name $instances[0].Name -ResourceGroupName "testResourceGroup" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -VaultName "testVault" -RestoreRequest $RestoreRequestObject +``` + +The command tests the restore request object is valid for restore + +## PARAMETERS + +### -AsJob + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the backup instance + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group where the backup vault is present + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreRequest +Restore request object for which to validate +To construct, see NOTES section for RESTOREREQUEST properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IAzureBackupRestoreRequest +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id of the backup vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IOperationJobExtendedInfo + +## 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. + + +`RESTOREREQUEST <IAzureBackupRestoreRequest>`: Restore request object for which to validate + - `ObjectType <String>`: + - `RestoreTargetInfo <IRestoreTargetInfoBase>`: Gets or sets the restore target information. + - `ObjectType <String>`: Type of Datasource object, used to initialize the right inherited type + - `[RestoreLocation <String>]`: Target Restore region + - `SourceDataStoreType <SourceDataStoreType>`: Gets or sets the type of the source data store. + - `[SourceResourceId <String>]`: Fully qualified Azure Resource Manager ID of the datasource which is being recovered. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Update-AzDataProtectionBackupInstanceAssociatedPolicy.md b/azps-10.1.0/Az.DataProtection/Update-AzDataProtectionBackupInstanceAssociatedPolicy.md new file mode 100644 index 0000000000..b20f1a1290 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Update-AzDataProtectionBackupInstanceAssociatedPolicy.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/update-azdataprotectionbackupinstanceassociatedpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Update-AzDataProtectionBackupInstanceAssociatedPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Update-AzDataProtectionBackupInstanceAssociatedPolicy.md +--- + +# Update-AzDataProtectionBackupInstanceAssociatedPolicy + +## SYNOPSIS +Updates associated policy for a given backup instance + +## SYNTAX + +``` +Update-AzDataProtectionBackupInstanceAssociatedPolicy -BackupInstanceName <String> -PolicyId <String> + -ResourceGroupName <String> -VaultName <String> [-AsJob] [-DefaultProfile <PSObject>] [-NoWait] + [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates associated policy for a given backup instance + +## EXAMPLES + +### Example 1: Update Associated policy of a backup instance +```powershell +$sub = "xxxx-xxxx-xxxx" +$instance = Get-AzDataProtectionBackupInstance -SubscriptionId $sub -ResourceGroupName sarath-rg -VaultName sarath-vault +$policy = Get-AzDataProtectionBackupPolicy -SubscriptionId $sub -ResourceGroupName sarath-rg -VaultName sarath-vault +Update-AzDataProtectionBackupInstanceAssociatedPolicy -SubscriptionId $sub -ResourceGroupName sarath-rg -VaultName sarath-vault -BackupInstanceName $instance[0].Name -PolicyId $policy[1].Id +``` + +```output +Name Type BackupInstanceName +---- ---- ------------------ +sarathdisk2-sarathdisk2-2ba3c708-3648-45e2-809d-9f75e66d404f Microsoft.DataProtection/backupVaults/backupInstances sarathdisk2-sarathdisk2-2ba3c708-3648-45e2-809d-9f75e66 +``` + +This command updates the associated policy of a backup instance + +## PARAMETERS + +### -AsJob + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupInstanceName +Unique Name of protected backup instance + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +Id of the Policy to be associated with the backup instance + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group of the backup vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id of the vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Name of the backup vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupInstanceResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Update-AzDataProtectionBackupVault.md b/azps-10.1.0/Az.DataProtection/Update-AzDataProtectionBackupVault.md new file mode 100644 index 0000000000..9dd7561ba6 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Update-AzDataProtectionBackupVault.md @@ -0,0 +1,374 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/update-azdataprotectionbackupvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Update-AzDataProtectionBackupVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Update-AzDataProtectionBackupVault.md +--- + +# Update-AzDataProtectionBackupVault + +## SYNOPSIS +Updates a BackupVault resource belonging to a resource group. +For example, updating tags for a resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDataProtectionBackupVault -ResourceGroupName <String> -VaultName <String> [-SubscriptionId <String>] + [-AzureMonitorAlertsForAllJobFailure <AlertsState>] + [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>] [-IdentityType <String>] + [-ImmutabilityState <ImmutabilityState>] [-SoftDeleteRetentionDurationInDay <Double>] + [-SoftDeleteState <SoftDeleteState>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDataProtectionBackupVault -InputObject <IDataProtectionIdentity> + [-AzureMonitorAlertsForAllJobFailure <AlertsState>] + [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>] [-IdentityType <String>] + [-ImmutabilityState <ImmutabilityState>] [-SoftDeleteRetentionDurationInDay <Double>] + [-SoftDeleteState <SoftDeleteState>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a BackupVault resource belonging to a resource group. +For example, updating tags for a resource. + +## EXAMPLES + +### Example 1: Add tags to an existing backup vault +```powershell +$tag = @{"Owner"="sarath";"Purpose"="AzureBackupTesting"} +Update-AzDataProtectionBackupVault -SubscriptionId "xxx-xxx-xxx" -ResourceGroupName sarath-rg -VaultName sarath-vault -Tag $tag +``` + +```output +ETag IdentityPrincipalId IdentityTenantId IdentityType Location Name Type +---- ------------------- ---------------- ------------ -------- ---- ---- + 2ca1d5f7-38b3-4b61-aa45-8147d7e0edbc 72f988bf-86f1-41af-91ab-2d7cd011db47 SystemAssigned centraluseuap sarath-vault Microsoft.DataProtection/backupVaults +``` + +The first command creates a new tag hashtable with tags and their values. +The second command adds the given tags to the backup vault. + +### Example 2: Disable Azure monitor alerts for job failures +```powershell +Update-AzDataProtectionBackupVault -ResourceGroupName "rgName" -VaultName "vaultName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -AzureMonitorAlertsForAllJobFailure 'Disabled' +``` + +```output +Name Location Type IdentityType +---- -------- ---- ------------ +vaultName southeastasia Microsoft.DataProtection/backupVaults SystemAssigned +``` + +This command disables the monitor alerts for all the job failures for the backup vault. +Allowed values are: Enabled, Disabled. +Note that by default this setting is enabled. + +### Example 3: Update vault ImmutabilityState, CrossSubscriptionRestoreState, soft delete settings +```powershell +Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CrossSubscriptionRestoreState Disabled -ImmutabilityState Disabled -SoftDeleteRetentionDurationInDay 99 -SoftDeleteState Off +``` + +```output +Name Location Type IdentityType +---- -------- ---- ------------ +vaultName southeastasia Microsoft.DataProtection/backupVaults SystemAssigned +``` + +This command is used to modify Immutability state, cross subscription restore state, soft delete settings of the vault. +These parameters are optional and can be used independently. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureMonitorAlertsForAllJobFailure +Parameter to Enable or Disable built-in azure monitor alerts for job failures. +Security alerts cannot be disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.AlertsState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CrossSubscriptionRestoreState +Cross subscription restore state of the vault. +Allowed values are Disabled, Enabled, PermanentlyDisabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.CrossSubscriptionRestoreState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identityType which can be either SystemAssigned or None + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutabilityState +Immutability state of the vault. +Allowed values are Disabled, Unlocked, Locked. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.ImmutabilityState +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.DataProtection.Models.IDataProtectionIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeleteRetentionDurationInDay +Soft delete retention duration in days. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeleteState +Soft delete state of the vault. +Allowed values are Off, On, AlwaysOn. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SoftDeleteState +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. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +The name of the backup vault. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.IDataProtectionIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupVaultResource + +## 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 <IDataProtectionIdentity>`: Identity Parameter + - `[BackupInstanceName <String>]`: The name of the backup instance. + - `[BackupPolicyName <String>]`: + - `[Id <String>]`: Resource identity path + - `[JobId <String>]`: The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[OperationId <String>]`: + - `[RecoveryPointId <String>]`: + - `[RequestName <String>]`: + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceGuardsName <String>]`: The name of ResourceGuard + - `[SubscriptionId <String>]`: The ID of the target subscription. The value must be an UUID. + - `[VaultName <String>]`: The name of the backup vault. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataProtection/Update-AzDataProtectionResourceGuard.md b/azps-10.1.0/Az.DataProtection/Update-AzDataProtectionResourceGuard.md new file mode 100644 index 0000000000..833803cbf8 --- /dev/null +++ b/azps-10.1.0/Az.DataProtection/Update-AzDataProtectionResourceGuard.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.DataProtection +online version: https://learn.microsoft.com/powershell/module/az.dataprotection/update-azdataprotectionresourceguard +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Update-AzDataProtectionResourceGuard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataProtection/help/Update-AzDataProtectionResourceGuard.md +--- + +# Update-AzDataProtectionResourceGuard + +## SYNOPSIS +Updates a resource guard belonging to a resource group + +## SYNTAX + +``` +Update-AzDataProtectionResourceGuard -Name <String> -ResourceGroupName <String> + [-CriticalOperationExclusionList <String[]>] [-DefaultProfile <PSObject>] [-ETag <String>] + [-IdentityType <String>] [-SubscriptionId <String>] [-Tag <Hashtable>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates a resource guard belonging to a resource group + +## EXAMPLES + +### Example 1: Update a resource guard +```powershell +$resourceGuard = Get-AzDataProtectionResourceGuard -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "rgName" -Name "resGuardName" +$criticalOperations = $resourceGuard.ResourceGuardOperation.VaultCriticalOperation +$operationsToBeExcluded = $criticalOperations | Where-Object { $_ -match "backupSecurityPIN/action" -or $_ -match "backupInstances/delete" } +Update-AzDataProtectionResourceGuard -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "rgName" -Name $resourceGuard.Name -CriticalOperationExclusionList $operationsToBeExcluded +``` + +```output +ETag Id IdentityPrincipalId IdentityTenantId IdentityType Location Name +---- -- ------------------- ---------------- ------------ -------- ---- + /subscriptions/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/mua-rg/providers/Microsoft.DataProtection/resourceGuards/mua-resource-guard centraluseuap mua-resource-guard +``` + +The first command is used to fetch the resource guard to be updated. +The second and third command is used to fecth the critical operations user want to update. + +The fourth command is used to exclude some critical operations from the resource guard + +## PARAMETERS + +### -CriticalOperationExclusionList +List of critical operations which are not protected by this resourceGuard. +Supported values are DeleteProtection, UpdateProtection, UpdatePolicy, GetSecurityPin + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETag +Optional ETag + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identityType to be updated in resource guard, example: SystemAssigned, None + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the resource guard + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name of the resource guard + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id of the resource guard + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IResourceGuardResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DataShare/Az.DataShare.md b/azps-10.1.0/Az.DataShare/Az.DataShare.md new file mode 100644 index 0000000000..950f8b8f52 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Az.DataShare.md @@ -0,0 +1,123 @@ +--- +Module Name: Az.DataShare +Module Guid: fe925c54-a246-4a80-89ed-b8768f5dc3cd +Download Help Link: https://learn.microsoft.com/powershell/module/az.datashare +Help Version: 0.1.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Az.DataShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Az.DataShare.md +--- + +# Az.DataShare Module +## Description +Azure Data Share is a first party resource provider that enables customers to easily and securely share big data with other organizations in Azure, with centralized management, monitoring and governance. + +## Az.DataShare Cmdlets +### [Get-AzDataShare](Get-AzDataShare.md) +Get information about Data Shares. + +### [Get-AzDataShareAccount](Get-AzDataShareAccount.md) +Gets information about DataShare Accounts + +### [Get-AzDataShareDataSet](Get-AzDataShareDataSet.md) +Gets information about Data Sets in Azure data share. + +### [Get-AzDataShareDataSetMapping](Get-AzDataShareDataSetMapping.md) +Gets information about dataset mappings in share subscription + +### [Get-AzDataShareInvitation](Get-AzDataShareInvitation.md) +Gets information invitation of data share. + +### [Get-AzDataShareProviderShareSubscription](Get-AzDataShareProviderShareSubscription.md) +Gets information about consumer share subscriptions on provider side. + +### [Get-AzDataShareReceivedInvitation](Get-AzDataShareReceivedInvitation.md) +Gets information about consumer invitations. + +### [Get-AzDataShareSourceDataSet](Get-AzDataShareSourceDataSet.md) +Gets information about source data sets in share subscription. + +### [Get-AzDataShareSubscription](Get-AzDataShareSubscription.md) +Gets information about share subscription in data share account. + +### [Get-AzDataShareSubscriptionSynchronization](Get-AzDataShareSubscriptionSynchronization.md) +Gets information about synchronization runs in share subscription. + +### [Get-AzDataShareSubscriptionSynchronizationDetail](Get-AzDataShareSubscriptionSynchronizationDetail.md) +Gets information about synchonization details for share subscription. + +### [Get-AzDataShareSynchronization](Get-AzDataShareSynchronization.md) +Gets information about synchronization setting for a share. + +### [Get-AzDataShareSynchronizationDetail](Get-AzDataShareSynchronizationDetail.md) +Gets information about synchronization details for a share. + +### [Get-AzDataShareSynchronizationSetting](Get-AzDataShareSynchronizationSetting.md) +Gets information about synchronization setting on a share. + +### [Get-AzDataShareTrigger](Get-AzDataShareTrigger.md) +Gets information about a trigger in share subscription. + +### [Grant-AzDataShareSubscriptionAccess](Grant-AzDataShareSubscriptionAccess.md) +Grants a revoked share subscription access to source share + +### [New-AzDataShare](New-AzDataShare.md) +Creates a azure data share. + +### [New-AzDataShareAccount](New-AzDataShareAccount.md) +Creates new data share account + +### [New-AzDataShareDataSet](New-AzDataShareDataSet.md) +Adds data sets to azure data share. + +### [New-AzDataShareDataSetMapping](New-AzDataShareDataSetMapping.md) +Creates data set mapping for share subscription. + +### [New-AzDataShareInvitation](New-AzDataShareInvitation.md) +Creates an invitation for share. + +### [New-AzDataShareSubscription](New-AzDataShareSubscription.md) +Creates a new share subscription. + +### [New-AzDataShareSynchronizationSetting](New-AzDataShareSynchronizationSetting.md) +Creates Synchronization setting for a share. + +### [New-AzDataShareTrigger](New-AzDataShareTrigger.md) +Creates a trigger for share subscription. + +### [Remove-AzDataShare](Remove-AzDataShare.md) +Removes a data share. + +### [Remove-AzDataShareAccount](Remove-AzDataShareAccount.md) +Removes a datashare account + +### [Remove-AzDataShareDataSet](Remove-AzDataShareDataSet.md) +Removes a dataset mapping + +### [Remove-AzDataShareDataSetMapping](Remove-AzDataShareDataSetMapping.md) +Removes a dataset mapping + +### [Remove-AzDataShareInvitation](Remove-AzDataShareInvitation.md) +removes an invitation + +### [Remove-AzDataShareSubscription](Remove-AzDataShareSubscription.md) +removes a share subscription + +### [Remove-AzDataShareSynchronizationSetting](Remove-AzDataShareSynchronizationSetting.md) +removes a synchronization setting + +### [Remove-AzDataShareTrigger](Remove-AzDataShareTrigger.md) +removes a trigger + +### [Revoke-AzDataShareSubscriptionAccess](Revoke-AzDataShareSubscriptionAccess.md) +Revokes share subscription access to source share + +### [Set-AzDataShare](Set-AzDataShare.md) +Updates an existing data share + +### [Start-AzDataShareSubscriptionSynchronization](Start-AzDataShareSubscriptionSynchronization.md) +Initiates synchronization for a share subscription. A share subscription can be specified through its resource id or its name. + +### [Stop-AzDataShareSubscriptionSynchronization](Stop-AzDataShareSubscriptionSynchronization.md) +Stops ongoing synchronization for a share subscription. A share subscription can be specified through its resource id or its name. + diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShare.md b/azps-10.1.0/Az.DataShare/Get-AzDataShare.md new file mode 100644 index 0000000000..29a60bc2c2 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShare.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatashare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShare.md +--- + +# Get-AzDataShare + +## SYNOPSIS +Get information about Data Shares. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShare -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzDataShare -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShare** cmdlet gets information about data shares in an Azure data share account. +If you specify the name of a data share, this cmdlet gets information about that data share. +If you do not specify a name, this cmdlet gets information about all of the data shares in an Azure data share account. + +## EXAMPLES + +### Example 1 : Get a specific data share +```powershell +Get-AzDataShare -ResourceGroupName "ADS" -AccountName "WikiAdsAccount" -Name "AdsShare" +``` + +```output +Name : AdsShare +Id : /subscriptions/f3ead1ff-d0ab-4cf4-9a5a-86f1661d4685/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAdsAccount/shares/AdsShare +Type : Microsoft.DataShare/shares +CreatedAt : 6/11/2019 12:00:00 AM +CreatedBy : Contoso ADS +ShareKind : CopyBased +Description : Example of description +ProvisioningState : Succeeded +Terms : This should not be shared +``` + +This command displays information about data share AdsShare in the Azure data share account WikiAdsAccount and resource group ADS. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data share name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data share + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShare + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareAccount.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareAccount.md new file mode 100644 index 0000000000..d5d0d58a3e --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareAccount.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatashareaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareAccount.md +--- + +# Get-AzDataShareAccount + +## SYNOPSIS +Gets information about DataShare Accounts + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShareAccount [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceGroupParameterSet +``` +Get-AzDataShareAccount -ResourceGroupName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzDataShareAccount -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareAccount** cmdlet gets information about datashare accounts in an Azure subscription / resource group. +If you specify the name of an account, this cmdlet gets information about that datshare account. +If you do not specify a name, this cmdlet gets information about all of the datashare accounts in an Azure subscription / resource group. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareAccount -ResourceGroupName "ADS" +``` + +```output +DataShareAccountName : WikiADS +ResourceGroupName : ADS +Location : WestUS +ProvisioningState : Succeeded +Tags : {} +Identity : Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSIdentity +Type : Microsoft.DataShare/accounts +Id : /subscriptions/4834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiADS +DataShareAccountName : WikiADS2 +ResourceGroupName : ADS +Location : westus +ProvisioningState : Succeeded +Tags : {} +Identity : Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSIdentity +Type : Microsoft.DataShare/accounts +Id : /subscriptions/4834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiADS +``` + +This command displays information about all datashare accounts in the Azure subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data share account name. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data share account. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareAccount + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareDataSet.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareDataSet.md new file mode 100644 index 0000000000..3a060fa01d --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareDataSet.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatasharedataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareDataSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareDataSet.md +--- + +# Get-AzDataShareDataSet + +## SYNOPSIS +Gets information about Data Sets in Azure data share. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShareDataSet -ResourceGroupName <String> -AccountName <String> -ShareName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzDataShareDataSet -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareDataSet** cmdlet gets information about data sets added in a share in an Azure data share account. If you specify the name of data set, this cmdlet gets information about the data set. If you do not specify a name, this cmdlet gets information about all the data sets in a share.I + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareDataSet -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareName "AdsShare" -Name "AdsDataSet" +``` + +```output +ContainerName : AdsContainer +DataSetId : d2411889-5357-4ca8-8d65-9363e46ef2ed +ResourceGroup : ADS +SubscriptionId : 1834da9b-787a-44f6-ae81-60707ab8c957 +StorageAccount : AdsStorage +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/shelltest/shares/share4/dataSets/AdsDataSet +Name : AdsDataSet +Type : Microsoft.DataShare/DataSets +``` + +This command displays information about data set AdsDataSet in share AdsShare in Azure data share account WikiAdsAccount and resource group ADS. + +## PARAMETERS + +### -AccountName +Azure data share account name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data set name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data set. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareName +Azure data share name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareDataSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareDataSetMapping.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareDataSetMapping.md new file mode 100644 index 0000000000..523131f47f --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareDataSetMapping.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatasharedatasetmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareDataSetMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareDataSetMapping.md +--- + +# Get-AzDataShareDataSetMapping + +## SYNOPSIS +Gets information about dataset mappings in share subscription + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShareDataSetMapping -ResourceGroupName <String> -AccountName <String> -ShareSubscriptionName <String> + [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzDataShareDataSetMapping -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareDataSetMapping** cmdlet gets information about a particular dataset mapping if the name is specified. Otherwise, it gets information about all the dataset mappings in a share subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareDataSetMapping -ResourceGroupName "ADS" -AccountName "WikiAdsAccount" -ShareSubscriptionName "WikiADS" +``` + +```output +ContainerName : testing +Prefix : providercontainer +DataSetId : 372899d4-5e67-4c85-bc60-21168b484424 +ResourceGroup : ADS +SubscriptionId : 4834da9b-787a-44f6-ae81-60707ab8c957 +StorageAccount : storageaccount +DataSetMappingStatus : Ok +Id : /subscriptions/4834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAdsAccount/shareSubscriptions/WikiADS/dataSetMappings/dsm +Name : dsm +Type : Microsoft.DataShare/DataSetMappings +``` + + This command displays information about all dataset mappings in the share subscription. + +## PARAMETERS + +### -AccountName +The name of the Azure storage account that is the source of the data being shared. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data set mapping name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of azure data share account. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data set mapping. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareSubscriptionName +Azure data share subscription name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareDataSetMapping + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareInvitation.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareInvitation.md new file mode 100644 index 0000000000..5773df7b17 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareInvitation.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatashareinvitation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareInvitation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareInvitation.md +--- + +# Get-AzDataShareInvitation + +## SYNOPSIS +Gets information invitation of data share. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShareInvitation -ResourceGroupName <String> -AccountName <String> -ShareName <String> + [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzDataShareInvitation -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareInvitation** cmdlet gets information on invitations added in data share. If you specify the name of the invitation, this cmdlet gets information about the invitation. If you do not specify a name, this cmdlet gets information about all the invitations in a share. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareInvitation -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareName "AdsShare" -Name "AdsInvitation" +``` + +```output +InvitationId : 167e06ff-567f-4bc7-be0c-645a6de710f3 +InvitationStatus : Pending +Sender : adsprovider@microsoft.com +SentAt : 7/8/2019 10:47:10 PM +TargetEmail : adstest@microsoft.com +TargetObjectId : +TargetTenantId : +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAds/shares/AdsShare/invitations/AdsInvitation +Name : AdsInvitation +Type : Microsoft.DataShare/Invitations +``` + +This commands provides information about invitation AdsInvitation present in data share AdsShare. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data share invitation name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data share invitation + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareName +Azure data share name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShare + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareProviderShareSubscription.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareProviderShareSubscription.md new file mode 100644 index 0000000000..954728e734 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareProviderShareSubscription.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatashareprovidersharesubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareProviderShareSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareProviderShareSubscription.md +--- + +# Get-AzDataShareProviderShareSubscription + +## SYNOPSIS +Gets information about consumer share subscriptions on provider side. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShareProviderShareSubscription -ResourceGroupName <String> -AccountName <String> -ShareName <String> + [-ShareSubscriptionId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByProviderShareSubscriptionIdParameterSet +``` +Get-AzDataShareProviderShareSubscription [-ShareSubscriptionId <String>] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareProviderSubscription** cmdlet gets information about consumer share subscriptions on provider side. If you specify the share subscrption id, this cmdlet gets information about the share subscription. If you do not specify the share subscription id, this cmdlet gets information about all the consumer share subscriptions in associated with the share. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareProviderShareSubscription -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareName "AdsShare" -ShareSubscriptionId "/subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAds/shares/AdsShare/shareSubscriptions/505c3500-b2ff-46ab-96bf-50f5ec89d75a" +``` + +```output +Company : ADS Test +CreatedAt : 6/30/2019 12:42:12 AM +CreatedBy : adstest@microsoft.com +SharedAt : 6/30/2019 12:41:37 AM +SharedBy : adsprovider@microsoft.com +ShareSubscriptionObjectId : 505c3500-b2ff-46ab-96bf-50f5ec89d75a +ShareSubscriptionStatus : Active +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAds/shares/AdsShare/shareSubscriptions/505c3500-b2ff-46ab-96bf-50f5ec89d75a +Name : AdsShareSubscription +Type : Microsoft.DataShare/ShareSubscriptions +``` + +This commands provides information about consumer share subscription associated with share AdsShare in data share account WikiAds. + +## PARAMETERS + +### -AccountName +Azure DataShare Account name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the Azure DataShare Account. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the share + +```yaml +Type: System.String +Parameter Sets: ByProviderShareSubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareName +Azure DataShare name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareSubscriptionId +The id of consumer share subscription + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareProviderShareSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareReceivedInvitation.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareReceivedInvitation.md new file mode 100644 index 0000000000..3a6d123214 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareReceivedInvitation.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatasharereceivedinvitation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareReceivedInvitation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareReceivedInvitation.md +--- + +# Get-AzDataShareReceivedInvitation + +## SYNOPSIS +Gets information about consumer invitations. + +## SYNTAX + +``` +Get-AzDataShareReceivedInvitation [-Location <String>] [-InvitationId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareReceivedInvitation** cmdlet provides information about all the invitations that the consumer has receieved. If you provide location or invitation id, this cmdlet provides information about invitation in particular location or having invitation id. Otherwise, it provides a list of invitations sent to the consumer. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareReceivedInvitation -location "westus" +``` + +```output +DataSetCount : 3 +InvitationId : 167e06ff-567f-4bc7-be0c-645a6de710f3 +InvitationStatus : Pending +Location : westus +RespondedAt : +Sender : adsprovider@microsoft.com +SenderCompanyName : ADS Test +SentAt : 7/8/2019 10:47:10 PM +ShareName : AdsShare +Description : Some description +Terms : Some terms of use +Id : /providers/Microsoft.DataShare/consumerInvitations/167e06ff-567f-4bc7-be0c-645a6de710f3 +Name : AdsInvitation +Type : Microsoft.DataShare/consumerInvitations +``` + +This commant provides information about consumer invitations. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InvitationId +Azure dataShare invitation id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Azure data share invitation location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShare + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareSourceDataSet.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareSourceDataSet.md new file mode 100644 index 0000000000..4fc9d007e0 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareSourceDataSet.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatasharesourcedataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSourceDataSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSourceDataSet.md +--- + +# Get-AzDataShareSourceDataSet + +## SYNOPSIS +Gets information about source data sets in share subscription. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShareSourceDataSet -ResourceGroupName <String> -AccountName <String> -ShareSubscriptionName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzDataShareSourceDataSet -ShareSubscriptionResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareSourceDataSet** cmdlet provides information about the source data sets in the share subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareSourceDataSet -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareSubscriptionName "AdsShareSubscription" +``` + +```output +DataSetId : 63116d3f-515a-47a2-9b18-d981b16a9d21 +DataSetName : filesystem1 +DataSetType : Blob +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAds/shareSubscriptions/AdsShareSubscription/consumerSourceDataSets/AdsDataSets +Name : AdsDataSets +Type : Microsoft.DataShare/ConsumerSourceDataSet +``` + +Gets datasets available in the source share + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareSubscriptionName +Azure data share subscription name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareSubscriptionResourceId +Azure data share subscription resource id + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSourceDataSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareSubscription.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareSubscription.md new file mode 100644 index 0000000000..adb9f52333 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareSubscription.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatasharesubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSubscription.md +--- + +# Get-AzDataShareSubscription + +## SYNOPSIS +Gets information about share subscription in data share account. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShareSubscription -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzDataShareSubscription -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareSubscription** cmdlet provides information about share subscription in a data share account. If share subscription name is provided, the cmdlet gives information about the particular share subscription. Otherwise, the cmdlet provides a list of share subscriptions in the data share account. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareSubscription -ResourceGroupName "ADS" -AccountName "WikiAds" -Name "AdsShareSubscription" +``` + +```output +CreatedAt : 7/9/2019 12:32:53 AM +CreatedBy : adstest@microsoft.com +InvitationId : 0c14f5b6-0e22-49ab-8043-d6edad51db13 +ProvisioningState : Succeeded +ShareName : AdsShare +ShareSender : adsprovider@microsoft.com +ShareSenderCompanyName : ADS Test +ShareDescription : Ads description +ShareTerms : Ads terms of use +ShareSubscriptionStatus : Active +ShareKind : CopyBased +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAds/shareSubscriptions/AdsShareSubscription +Name : AdsShareSubscription +Type : Microsoft.DataShare/ShareSubscriptions +``` + +This command provides information about share subscription AdsShareSubscription in data share account WikiAds. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data share subscription name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data share subscription + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareSubscriptionSynchronization.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareSubscriptionSynchronization.md new file mode 100644 index 0000000000..f69e81db49 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareSubscriptionSynchronization.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatasharesubscriptionsynchronization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSubscriptionSynchronization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSubscriptionSynchronization.md +--- + +# Get-AzDataShareSubscriptionSynchronization + +## SYNOPSIS +Gets information about synchronization runs in share subscription. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShareSubscriptionSynchronization -ResourceGroupName <String> -AccountName <String> + -ShareSubscriptionName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzDataShareSubscriptionSynchronization -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareSubscriptionSynchronization** cmdlet provides informaiton about all synchronization runs in a share subscription under a data share account on the consumer. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareSubscriptionSynchronization -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareSubscriptionName "AdsShareSubscription" +``` + +```output +durationMs : 83660 +endTime : 7/10/2019 9:01:23 AM +message : +startTime : 7/10/2019 9:00:04 AM +status : Succeeded +synchronizationId : b087e1a5-9144-4e1d-86d1-2a4adcf551d4 +``` + +This command provides information about all the synchronization runs for a share subscription AdsShareSubscription under data share account WikiAds. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure data share subscription resource id + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareSubscriptionName +Azure data share subscription name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSubscriptionSynchronization + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareSubscriptionSynchronizationDetail.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareSubscriptionSynchronizationDetail.md new file mode 100644 index 0000000000..a410070c37 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareSubscriptionSynchronizationDetail.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatasharesubscriptionsynchronizationdetail +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSubscriptionSynchronizationDetail.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSubscriptionSynchronizationDetail.md +--- + +# Get-AzDataShareSubscriptionSynchronizationDetail + +## SYNOPSIS +Gets information about synchonization details for share subscription. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShareSubscriptionSynchronizationDetail -ResourceGroupName <String> -AccountName <String> + -ShareSubscriptionName <String> -SynchronizationId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzDataShareSubscriptionSynchronizationDetail -SynchronizationId <String> -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareSubscriptionSynchronizationDetail** cmdlet provides details of the synchronization initiated for a share subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareSubscriptionSynchronizationDetail -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareSubscriptionName "AdsShareSubscription" -SynchronizationId "a6ee5c8d-0ce0-485e-b2f2-966b187dc6c7" +``` + +```output +DataSetId : d2411889-5357-4ca8-8d65-9363e46ef2ed +DataSetType : BlobFolder +EndTime : 7/8/2019 10:24:27 PM +StartTime : 7/8/2019 10:23:09 PM +Status : Succeeded +DurationMs : 78870 +FilesRead : 1 +FilesWritten : 1 +SizeRead : 2779935 +SizeWritten : 2779935 +Name : 16d5161b-2b3f-4d90-b074-13ad7121bcc7 +Message : +``` + +This command provides information about synchronization initiated for share subscription AdsShareSubscription under data share account WikiAds. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure data share subscription resource id + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareSubscriptionName +Azure data share subscription name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SynchronizationId +Synchronization id of share subscription synchronization + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSynchronizationDetail + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareSynchronization.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareSynchronization.md new file mode 100644 index 0000000000..2257326f7f --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareSynchronization.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatasharesynchronization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSynchronization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSynchronization.md +--- + +# Get-AzDataShareSynchronization + +## SYNOPSIS +Gets information about synchronization setting for a share. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShareSynchronization -ResourceGroupName <String> -AccountName <String> -ShareName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzDataShareSynchronization -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareSynchronization** cmdlet provides information about all the synchronization setting present in a share under a data share account. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareSynchronization -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareName "AdsShare" +``` + +```output +Company : ADS Test +DurationMs : 107013 +EndTime : 7/8/2019 11:53:18 PM +Message : +StartTime : 7/8/2019 11:51:34 PM +Status : Succeeded +SynchronizationId : e6dc7080-6589-4628-8b50-8fc31b460089 +``` + +This commands provides information about all synchronization settings present in share AdsShare in data share account WikiAds. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure data share resource id + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareName +Azure data share name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSynchronization + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareSynchronizationDetail.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareSynchronizationDetail.md new file mode 100644 index 0000000000..c300790de6 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareSynchronizationDetail.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatasharesynchronizationdetail +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSynchronizationDetail.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSynchronizationDetail.md +--- + +# Get-AzDataShareSynchronizationDetail + +## SYNOPSIS +Gets information about synchronization details for a share. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShareSynchronizationDetail -ResourceGroupName <String> -AccountName <String> -ShareName <String> + -SynchronizationId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzDataShareSynchronizationDetail -SynchronizationId <String> -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareSynchronizationDetail** cmdlet provides details of the synchronization initiated for a share. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareSynchronizationDetail -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareName "AdsShare" -SynchronizationId "02a17faa-4498-45ee-a884-162180af9251" +``` + +```output +DataSetId : d2411889-5357-4ca8-8d65-9363e46ef2ed +DataSetType : BlobFolder +EndTime : 7/8/2019 10:24:27 PM +StartTime : 7/8/2019 10:23:09 PM +Status : Succeeded +DurationMs : 78870 +FilesRead : 1 +FilesWritten : 1 +SizeRead : 2779935 +SizeWritten : 2779935 +Name : 16d5161b-2b3f-4d90-b074-13ad7121bcc7 +Message : +``` + +This command provides information about the synchronization details of all the data sets corresponding to the provided synchronization id. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure data share resource id + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareName +Azure data share name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SynchronizationId +Synchronization id of share synchronization + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSynchronizationDetail + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareSynchronizationSetting.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareSynchronizationSetting.md new file mode 100644 index 0000000000..ad478ab97c --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareSynchronizationSetting.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatasharesynchronizationsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSynchronizationSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareSynchronizationSetting.md +--- + +# Get-AzDataShareSynchronizationSetting + +## SYNOPSIS +Gets information about synchronization setting on a share. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShareSynchronizationSetting -ResourceGroupName <String> -AccountName <String> -ShareName <String> + [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzDataShareSynchronizationSetting -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareSynchronizationSetting** cmdlet provides information about synchronization enabled on a share. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareSynchronizationSetting -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareName "AdsShare" -Name "ShareSynchronization" +``` + +```output +RecurrenceInterval : Day +SynchronizationTime : 7/9/2019 9:00:00 AM +ProvisioningState : Succeeded +CreatedAt : 7/10/2019 12:01:08 AM +CreatedBy : ADS Test +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft. + DataShare/accounts/WikiAds/shares/AdShare/synchronizationSettings/ShareSynchronization +Name : ShareSynchronization +Type : Microsoft.DataShare/SynchronizationSettings +``` + +This command provides information about synchronization ShareSynchronization enabled on share AdsShare under data share account WikiAds. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name for Synchronization Setting + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name of azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data share synchronization setting + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareName +Azure data share name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSynchronizationSetting + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Get-AzDataShareTrigger.md b/azps-10.1.0/Az.DataShare/Get-AzDataShareTrigger.md new file mode 100644 index 0000000000..00eecee299 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Get-AzDataShareTrigger.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/get-azdatasharetrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Get-AzDataShareTrigger.md +--- + +# Get-AzDataShareTrigger + +## SYNOPSIS +Gets information about a trigger in share subscription. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzDataShareTrigger -ResourceGroupName <String> -AccountName <String> -ShareSubscriptionName <String> + [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzDataShareTrigger -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataShareTrigger** cmdlet gets information about trigger for share subscription under data share account. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDataShareTrigger -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareSubscriptionName "AdsShareSubscription" -Name "AdsTrigger" +``` + +```output +CreatedAt : 7/10/2019 12:16:34 AM +CreatedBy : Ads test +ProvisioningState : Succeeded +RecurrenceInterval : Day +SynchronizationMode : Incremental +SynchronizationTime : 7/9/2019 9:00:00 AM +TriggerStatus : Active +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAds/shareSubscriptions/AdsShareSubscription/triggers/AdsTrigger +Name : AdsTrigger +Type : Microsoft.DataShare/Triggers +``` + +This command gets information about trigger AdsTrigger for share subscription AdsShareSubscription under data share account WikiAds. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data share trigger name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the trigger + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareSubscriptionName +Azure data share subscription name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareTrigger + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Grant-AzDataShareSubscriptionAccess.md b/azps-10.1.0/Az.DataShare/Grant-AzDataShareSubscriptionAccess.md new file mode 100644 index 0000000000..79c1caddea --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Grant-AzDataShareSubscriptionAccess.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/grant-azdatasharesubscriptionaccess +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Grant-AzDataShareSubscriptionAccess.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Grant-AzDataShareSubscriptionAccess.md +--- + +# Grant-AzDataShareSubscriptionAccess + +## SYNOPSIS +Grants a revoked share subscription access to source share + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Grant-AzDataShareSubscriptionAccess -ResourceGroupName <String> -AccountName <String> [-ShareName <String>] + -ShareSubscriptionId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByProviderShareSubscriptionIdParameterSet +``` +Grant-AzDataShareSubscriptionAccess -ShareSubscriptionId <String> -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Grant-AzDataShareSubscriptionAccess** cmdlet grants a share subscription access to source share + +## EXAMPLES + +### Example 1 +```powershell +Grant-AzDataShareSubscriptionAccess -ResourceGroupName "ADS" -AccountName "WikiAdsAccount" -ShareName "AdsShare" -ShareSubscriptionId 8ee6e6fd-b4a1-49a4-bb66-f187f38e0e12 +``` + +```output +Company : ADS +CreatedAt : 6/15/2019 1:02:28 AM +CreatedBy : abc@microsoft.com +SharedAt : 6/15/2019 12:08:48 AM +SharedBy : abc@microsoft.com +ShareSubscriptionObjectId : 8ee6e6fd-b4a1-49a4-bb66-f187f38e0e12 +ShareSubscriptionStatus : Active +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAdsAccount/shares/AdsShare/shareSubscriptions/8ee6e6fd-b4a1-49a4-bb66-f187f38e0e12 +Name : AdsShare +Type : Microsoft.DataShare/ShareSubscriptions +``` + +Grants access to share subscription identified by id 8ee6e6fd-b4a1-49a4-bb66-f187f38e0e12 + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data share + +```yaml +Type: System.String +Parameter Sets: ByProviderShareSubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareName +Azure data share name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareSubscriptionId +The share subscription id of the provider share subscription + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareProviderShareSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/New-AzDataShare.md b/azps-10.1.0/Az.DataShare/New-AzDataShare.md new file mode 100644 index 0000000000..292a1c70a0 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/New-AzDataShare.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/new-azdatashare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShare.md +--- + +# New-AzDataShare + +## SYNOPSIS +Creates a azure data share. + +## SYNTAX + +``` +New-AzDataShare -ResourceGroupName <String> -AccountName <String> -Name <String> [-Description <String>] + [-TermsOfUse <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataShare** cmdlet creates a data share within a specified azure data share account by providing the resource group name, account name, share name and share kind. Description and terms of use are optional parameters that can be set while creating the data share. + +## EXAMPLES + +### Example 1 : Create a data share +```powershell +New-AzDataShare -ResourceGroupName "ADS" -AccountName "WikiAdsAccount" -Name "AdsShare" -Description "Example of description" -TermsOfUse "This should not be shared" +``` + +```output +Name : AdsShare +Id : /subscriptions/f3ead1ff-d0ab-4cf4-9a5a-86f1661d4685/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAdsAccount/shares/AdsShare +Type : Microsoft.DataShare/shares +CreatedAt : 6/11/2019 12:00:00 AM +CreatedBy : Contoso ADS +ShareKind : CopyBased +Description : Example of description +ProvisioningState : Succeeded +Terms : This should not be shared +``` + +This command creates a data share named AdsShare of kind CopyBased in data share account WikiAdsAccount under resource group ADS with description and terms of use. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of azure data share + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data share name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TermsOfUse +Terms of use for azure data share + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShare + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/New-AzDataShareAccount.md b/azps-10.1.0/Az.DataShare/New-AzDataShareAccount.md new file mode 100644 index 0000000000..bceda3454f --- /dev/null +++ b/azps-10.1.0/Az.DataShare/New-AzDataShareAccount.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/new-azdatashareaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareAccount.md +--- + +# New-AzDataShareAccount + +## SYNOPSIS +Creates new data share account + +## SYNTAX + +``` +New-AzDataShareAccount -ResourceGroupName <String> -Name <String> -Location <String> [-Tag <Hashtable>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +**New-AzDataShareAccount** cmdlet creates a datashare account in the specified Azure resource group. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataShareAccount -ResourceGroupName "ADS" -Name "WikiADS" -Location "WestUS" +``` + +```output +DataShareAccountName : WikiADS +ResourceGroupName : ADS +Location : WestUS +ProvisioningState : Succeeded +Tags : {} +Identity : Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSIdentity +Type : Microsoft.DataShare/accounts +Id : /subscriptions/4834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiADS +``` + +Creates an account named "WikiADS" in resource group "ADS" + +## PARAMETERS + +### -AsJob +{{Fill AsJob Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location in which to create the data share account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data share account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account will be created in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to associate with the azure data share account. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareAccount + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/New-AzDataShareDataSet.md b/azps-10.1.0/Az.DataShare/New-AzDataShareDataSet.md new file mode 100644 index 0000000000..34acbe357a --- /dev/null +++ b/azps-10.1.0/Az.DataShare/New-AzDataShareDataSet.md @@ -0,0 +1,292 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/new-azdatasharedataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareDataSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareDataSet.md +--- + +# New-AzDataShareDataSet + +## SYNOPSIS +Adds data sets to azure data share. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzDataShareDataSet [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByBlobDataSetParamaterSet +``` +New-AzDataShareDataSet -ResourceGroupName <String> -AccountName <String> -ShareName <String> -Name <String> + -StorageAccountResourceId <String> -Container <String> [-FilePath <String>] [-FolderPath <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByAdlsGen2DataSetParameterSet +``` +New-AzDataShareDataSet -ResourceGroupName <String> -AccountName <String> -ShareName <String> -Name <String> + -StorageAccountResourceId <String> -FileSystem <String> [-FilePath <String>] [-FolderPath <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByAdlsGen1DataSetParameterSet +``` +New-AzDataShareDataSet -ResourceGroupName <String> -AccountName <String> -ShareName <String> -Name <String> + -StorageAccountResourceId <String> [-FileName <String>] -AdlsGen1FolderPath <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataShareDataSet** cmdlet add data sets in azure data share of data share account. You can add data sets of type Blob, ADLS Gen2 and ADLS Gen1. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataShareDataSet -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareName "AdsShare" -Name "AdsDataSet" -StorageAccountResourceId "/subscriptions/271cc6ec-e5fe-4813-83bd-8f3b04973e38/resourceGroups/ADS/providers/Microsoft.Storage/storageAccounts/AdsStorage" -Container "AdsContainer" +``` + +```output +ContainerName : AdsContainer +DataSetId : d2411889-5357-4ca8-8d65-9363e46ef2ed +ResourceGroup : ADS +SubscriptionId : 1834da9b-787a-44f6-ae81-60707ab8c957 +StorageAccount : AdsStorage +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/shelltest/shares/share4/dataSets/AdsDataSet +Name : AdsDataSet +Type : Microsoft.DataShare/DataSets +``` + +This command adds a dataset named AdsDataSet of type blob container to azure data share AdsShare. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet, ByAdlsGen1DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdlsGen1FolderPath +Azure storage ADLS gen1 folder path + +```yaml +Type: System.String +Parameter Sets: ByAdlsGen1DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Azure storage account container name + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileName +Azure storage ADLS gen1 file name + +```yaml +Type: System.String +Parameter Sets: ByAdlsGen1DataSetParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +Azure storage file path + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +Azure ADLS gen2 file system name + +```yaml +Type: System.String +Parameter Sets: ByAdlsGen2DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FolderPath +Azure storage folder path + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data set name + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet, ByAdlsGen1DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet, ByAdlsGen1DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +Azure data share name + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet, ByAdlsGen1DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Azure storage account resourceId + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet, ByAdlsGen1DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareDataSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/New-AzDataShareDataSetMapping.md b/azps-10.1.0/Az.DataShare/New-AzDataShareDataSetMapping.md new file mode 100644 index 0000000000..6e81fffe91 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/New-AzDataShareDataSetMapping.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/new-azdatasharedatasetmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareDataSetMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareDataSetMapping.md +--- + +# New-AzDataShareDataSetMapping + +## SYNOPSIS +Creates data set mapping for share subscription. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzDataShareDataSetMapping [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByBlobDataSetParamaterSet +``` +New-AzDataShareDataSetMapping -ResourceGroupName <String> -AccountName <String> -ShareSubscriptionName <String> + -Name <String> -StorageAccountResourceId <String> -DataSetId <String> -Container <String> [-FilePath <String>] + [-FolderPath <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByAdlsGen2DataSetParameterSet +``` +New-AzDataShareDataSetMapping -ResourceGroupName <String> -AccountName <String> -ShareSubscriptionName <String> + -Name <String> -StorageAccountResourceId <String> -DataSetId <String> -FileSystem <String> + [-FilePath <String>] [-FolderPath <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataShareDataSetMapping** cmdlet creates a data set mapping between the source data sets and sink storage account in share subscription. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataShareDataSetMapping -ResourceGroupName "ADS" -AccountName "WikiAdsAccount" -ShareSubscriptionName "AdsShareSubscription" -Name "AdsDataSetMapping" -StorageAccountResourceId "/subscriptions/271cc6ec-e5fe-4813-83bd-8f3b04973e38/resourceGroups/ADS/providers/Microsoft.Storage/storageAccounts/AdsStorage" -Container "AdsContainer" +``` + +```output +ContainerName : AdsContainer +DataSetId : 372899d4-5e67-4c85-bc60-21168b484424 +ResourceGroup : ADS +SubscriptionId : 4834da9b-787a-44f6-ae81-60707ab8c957 +StorageAccount : AdsStorage +DataSetMappingStatus : Ok +Id : /subscriptions/4834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAdsAccount/shareSubscriptions/AdsShareSubscription/dataSetMappings/AdsDataSetMapping +Name : AdsDataSetMapping +Type : Microsoft.DataShare/DataSetMappings +``` + +This command creates a data set mapping AdsDataSetMapping to storage account AdsStorage for share subscription AdsShareSubscription in data share account WikiAdsAccount. + +## PARAMETERS + +### -AccountName +The name of the Azure storage account that is the source of the data being shared. + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Azure storage account container name + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataSetId +Consumer data set id + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +Azure storage file path + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +Azure ADLS gen2 file system name + +```yaml +Type: System.String +Parameter Sets: ByAdlsGen2DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FolderPath +Azure storage folder path + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data set mapping name + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareSubscriptionName +Azure data share subscription name + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Azure Storage Account ResourceId that is the source of the data being shared. + +```yaml +Type: System.String +Parameter Sets: ByBlobDataSetParamaterSet, ByAdlsGen2DataSetParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareDataSetMapping + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/New-AzDataShareInvitation.md b/azps-10.1.0/Az.DataShare/New-AzDataShareInvitation.md new file mode 100644 index 0000000000..e0b8dc02ac --- /dev/null +++ b/azps-10.1.0/Az.DataShare/New-AzDataShareInvitation.md @@ -0,0 +1,226 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/new-azdatashareinvitation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareInvitation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareInvitation.md +--- + +# New-AzDataShareInvitation + +## SYNOPSIS +Creates an invitation for share. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzDataShareInvitation [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInvitationEmailParameterSet +``` +New-AzDataShareInvitation -ResourceGroupName <String> -AccountName <String> -ShareName <String> -Name <String> + -TargetEmail <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInvitationTenantParameterSet +``` +New-AzDataShareInvitation -ResourceGroupName <String> -AccountName <String> -ShareName <String> -Name <String> + -TargetObjectId <String> -TargetTenantId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataShareInvitation** cmdlet sends an invitation to the target consumer with information about the provider share. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataShareInvitation -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareName "AdsShare" -Name "AdsInvitation" -TargetEmail "adstest@microsoft.com" +``` + +```output +InvitationId : 167e06ff-567f-4bc7-be0c-645a6de710f3 +InvitationStatus : Pending +Sender : adsprovider@microsoft.com +SentAt : 7/8/2019 10:47:10 PM +TargetEmail : adstest@microsoft.com +TargetObjectId : +TargetTenantId : +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/ providers/Microsoft.DataShare/accounts/WikiAds/shares/AdsShare/invitations/AdsInvitation +Name : AdsInvitation +Type : Microsoft.DataShare/Invitations +``` + +This command creates an invitation AdsInvitation for share AdsShare and sends it to target email adstest@microsoft.com. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByInvitationEmailParameterSet, ByInvitationTenantParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data share invitation name + +```yaml +Type: System.String +Parameter Sets: ByInvitationEmailParameterSet, ByInvitationTenantParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByInvitationEmailParameterSet, ByInvitationTenantParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +Azure data share name + +```yaml +Type: System.String +Parameter Sets: ByInvitationEmailParameterSet, ByInvitationTenantParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetEmail +Target email id + +```yaml +Type: System.String +Parameter Sets: ByInvitationEmailParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectId +Target object id + +```yaml +Type: System.String +Parameter Sets: ByInvitationTenantParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetTenantId +Target tenant id + +```yaml +Type: System.String +Parameter Sets: ByInvitationTenantParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareInvitation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/New-AzDataShareSubscription.md b/azps-10.1.0/Az.DataShare/New-AzDataShareSubscription.md new file mode 100644 index 0000000000..24eb6b8834 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/New-AzDataShareSubscription.md @@ -0,0 +1,188 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/new-azdatasharesubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareSubscription.md +--- + +# New-AzDataShareSubscription + +## SYNOPSIS +Creates a new share subscription. + +## SYNTAX + +``` +New-AzDataShareSubscription -ResourceGroupName <String> -AccountName <String> -Name <String> + -InvitationId <String> -SourceShareLocation <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataShareSubscription** cmdlet creates a share subscription in specified data share account and invitation id. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataShareSubscription -ResourceGroupName "ADS" -AccountName "WikiAds" -Name "AdsShareSubscription" -InvitationId "167e06ff-567f-4bc7-be0c-645a6de710f3" +``` + +```output +CreatedAt : 6/30/2019 12:42:12 AM +CreatedBy : adstest@microsoft.com +InvitationId : 167e06ff-567f-4bc7-be0c-645a6de710f3 +ProvisioningState : Succeeded +ShareName : AdsShare +ShareSender : adsprovider@microsoft.com +ShareSenderCompanyName : ADS Company +ShareDescription : Test description +ShareTerms : Test terms of use +ShareSubscriptionStatus : Active +ShareKind : CopyBased +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAds/shareSubscriptions/AdsShareSubscription +Name : AdsShareSubscription +Type : Microsoft.DataShare/ShareSubscriptions +``` + +This commands creates a new share subscription AdsShareSubscription for invitaionId under data share account WikiAds. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InvitationId +Azure data share invitationId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data share subscription name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceShareLocation +Azure data share location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShare + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/New-AzDataShareSynchronizationSetting.md b/azps-10.1.0/Az.DataShare/New-AzDataShareSynchronizationSetting.md new file mode 100644 index 0000000000..ea096f331d --- /dev/null +++ b/azps-10.1.0/Az.DataShare/New-AzDataShareSynchronizationSetting.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/new-azdatasharesynchronizationsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareSynchronizationSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareSynchronizationSetting.md +--- + +# New-AzDataShareSynchronizationSetting + +## SYNOPSIS +Creates Synchronization setting for a share. + +## SYNTAX + +``` +New-AzDataShareSynchronizationSetting -ResourceGroupName <String> -AccountName <String> -ShareName <String> + -Name <String> -RecurrenceInterval <String> -SynchronizationTime <DateTime> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataShareSynchronizationSetting** creates a synchronization setting for share in share account for a recurrence interval of either daily or hourly at a particular time. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataShareSynchronizationSetting -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareName "AdsShare" -Name "ShareSynchronization" -RecurrenceInterval "Day" -SynchronizationTime 9:00 +``` + +```output +RecurrenceInterval : Day +SynchronizationTime : 7/9/2019 9:00:00 AM +ProvisioningState : Succeeded +CreatedAt : 7/10/2019 12:01:08 AM +CreatedBy : Ads Company +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAds/shares/AdsShare/synchronizationSettings/ShareSynchronization +Name : ShareSynchronization +Type : Microsoft.DataShare/SynchronizationSettings +``` + +This commands creates a synchronization setting on Daily recurrence interval at 9:00 am for share AdsShare in data share account WikiAds. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Synchronization setting name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrenceInterval +The recurrence interval for the synchronization setting (Day or Hour) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name of azure data share account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +Azure data share name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SynchronizationTime +The start time of the scheduled synchronization setting + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSynchronizationSetting + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/New-AzDataShareTrigger.md b/azps-10.1.0/Az.DataShare/New-AzDataShareTrigger.md new file mode 100644 index 0000000000..22b3a7d3f5 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/New-AzDataShareTrigger.md @@ -0,0 +1,214 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/new-azdatasharetrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/New-AzDataShareTrigger.md +--- + +# New-AzDataShareTrigger + +## SYNOPSIS +Creates a trigger for share subscription. + +## SYNTAX + +``` +New-AzDataShareTrigger -ResourceGroupName <String> -AccountName <String> [-ShareSubscriptionName <String>] + -Name <String> -RecurrenceInterval <String> -SynchronizationTime <DateTime> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataShareTrigger** cmdlet creates a trigger for share subscription for the specified recurrence interval and synchronization time under azure data share account. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDataShareTrigger -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareSubscriptionName "AdsShareSubscription" -Name "AdsTrigger" -RecurrenceInterval "Day" -SynchronizationTime "9:00" +``` + +```output +CreatedAt : 7/10/2019 12:16:34 AM +CreatedBy : Ads test +ProvisioningState : Succeeded +RecurrenceInterval : Day +SynchronizationMode : Incremental +SynchronizationTime : 7/9/2019 9:00:00 AM +TriggerStatus : Active +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAds/shareSubscriptions/AdsShareSubscription/triggers/AdsTrigger +Name : AdsTrigger +Type : Microsoft.DataShare/Triggers +``` + +This command creates a new trigger AdsTrigger for share subscription AdsShareSubscription with a daily recurrence interval of 9 am. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +{{Fill AsJob Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure data share trigger name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrenceInterval +The recurrence interval for the trigger (Day or Hour) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareSubscriptionName +Azure data share subscription name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SynchronizationTime +The start time of the scheduled synchronization for the trigger + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareInvitation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Remove-AzDataShare.md b/azps-10.1.0/Az.DataShare/Remove-AzDataShare.md new file mode 100644 index 0000000000..e7627635ca --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Remove-AzDataShare.md @@ -0,0 +1,310 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/remove-azdatashare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShare.md +--- + +# Remove-AzDataShare + +## SYNOPSIS +Removes a data share. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzDataShare -ResourceGroupName <String> -AccountName <String> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzDataShare -ResourceId <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzDataShare -InputObject <PSDataShare> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataShare** cmdlet removes a data share. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataShare -ResourceGroupName "ADS" -AccountName "WikiAds" -Name "AdsShare" +``` + +```output +Are you sure you want to remove data share "AdsShare"? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +``` + +This commands removes the data share named AdsShare from the azure data share account WikiAds. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +{{Fill AsJob Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure data share object` +``yaml +Type: PSDataShare +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShare +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure data share name + +yaml +Type: String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return object (if specified). + +yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +yaml +Type: String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the Azure data share + +yaml +Type: String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False + + + + +yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShare +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShare + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Remove-AzDataShareAccount.md b/azps-10.1.0/Az.DataShare/Remove-AzDataShareAccount.md new file mode 100644 index 0000000000..b205b8177b --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Remove-AzDataShareAccount.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/remove-azdatashareaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareAccount.md +--- + +# Remove-AzDataShareAccount + +## SYNOPSIS +Removes a datashare account + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzDataShareAccount -ResourceGroupName <String> -Name <String> [-PassThru] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzDataShareAccount -ResourceId <String> [-PassThru] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzDataShareAccount -InputObject <PSDataShareAccount> [-PassThru] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataShareAccount** cmdlet removes a datashare account. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataShareAccount -Name "WikiADS" -ResourceGroupName "ADS" +``` + +```output +Confirm +Are you sure you want to remove datashare account 'WikiADS' in resource group 'ADS'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +True +``` + +This command removes the datashare account named WikiADS from the resource group named ADS. +This command returns a value of $True. + +## PARAMETERS + +### -AsJob +{{Fill AsJob Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +{{Fill Force Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The azure data share account object. + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareAccount +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure data share account name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return object (if specified). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of azure data share account. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data share account. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareAccount + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Remove-AzDataShareDataSet.md b/azps-10.1.0/Az.DataShare/Remove-AzDataShareDataSet.md new file mode 100644 index 0000000000..06f3944838 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Remove-AzDataShareDataSet.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/remove-azdatasharedataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareDataSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareDataSet.md +--- + +# Remove-AzDataShareDataSet + +## SYNOPSIS +Removes a dataset mapping + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzDataShareDataSet -ResourceGroupName <String> -AccountName <String> -ShareName <String> -Name <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzDataShareDataSet -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzDataShareDataSet -InputObject <PSDataShareDataSet> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataShareDataSet** cmdlet removes a dataset. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataShareDataSet -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareName "AdsShare" -Name "DS" +``` + +```output +Are you sure you want to remove dataset mapping "DS"? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +``` + +This commands removes the dataset named DS from share WikiAds. + +## PARAMETERS + +### -AccountName +Azure data share account name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The azure data set object. + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareDataSet +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure data set name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Return object (if specified). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data set. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareName +Azure data share name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareDataSet + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Remove-AzDataShareDataSetMapping.md b/azps-10.1.0/Az.DataShare/Remove-AzDataShareDataSetMapping.md new file mode 100644 index 0000000000..34ec44a932 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Remove-AzDataShareDataSetMapping.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/remove-azdatasharedatasetmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareDataSetMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareDataSetMapping.md +--- + +# Remove-AzDataShareDataSetMapping + +## SYNOPSIS +Removes a dataset mapping + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzDataShareDataSetMapping -ResourceGroupName <String> -AccountName <String> + -ShareSubscriptionName <String> -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzDataShareDataSetMapping -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzDataShareDataSetMapping -InputObject <PSDataShareDataSetMapping> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataShareDataSetMapping** cmdlet removes a dataset mappings. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataShareDataSetMapping -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareSubscriptionName "AdsShareSubscription" -Name "DSM" +``` + +```output +Are you sure you want to remove dataset mapping "DSM"? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +``` + +This commands removes the dataset named DSM from sharesubscription WikiAds. + +## PARAMETERS + +### -AccountName +The name of the Azure storage account that is the source of the data being shared. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The azure data set mapping object + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareDataSetMapping +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure data set mapping name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return object (if specified). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data set mapping + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareSubscriptionName +Azure data share subscription name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareDataSetMapping + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Remove-AzDataShareInvitation.md b/azps-10.1.0/Az.DataShare/Remove-AzDataShareInvitation.md new file mode 100644 index 0000000000..5df535d642 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Remove-AzDataShareInvitation.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/remove-azdatashareinvitation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareInvitation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareInvitation.md +--- + +# Remove-AzDataShareInvitation + +## SYNOPSIS +removes an invitation + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzDataShareInvitation -ResourceGroupName <String> -AccountName <String> -ShareName <String> + -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzDataShareInvitation -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzDataShareInvitation -InputObject <PSDataShareInvitation> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataShareInvitation** cmdlet removes a datashare invitation. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataShareInvitation -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareName "AdsShare" -Name "ADSInvite" +``` + +```output +Are you sure you want to remove dataset mapping "ADSInvite"? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +``` + +This commands removes an invitation named ADSInvite from share AdsShare. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure data share invitation object + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareInvitation +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure data share invitation name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return object (if specified). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data share invitation + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareName +Azure data share name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareInvitation + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Remove-AzDataShareSubscription.md b/azps-10.1.0/Az.DataShare/Remove-AzDataShareSubscription.md new file mode 100644 index 0000000000..4ba690bc12 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Remove-AzDataShareSubscription.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/remove-azdatasharesubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareSubscription.md +--- + +# Remove-AzDataShareSubscription + +## SYNOPSIS +removes a share subscription + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzDataShareSubscription -ResourceGroupName <String> -AccountName <String> -Name <String> [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzDataShareSubscription -ResourceId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzDataShareSubscription -InputObject <PSDataShareSubscription> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataShareSubscription** cmdlet removes a share subscription + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataShareSubscription -ResourceGroupName "ADS" -AccountName "WikiAds" -Name "AdsShareSubscription" +``` + +```output +Are you sure you want to remove sharesubscription "AdsShareSubscription"? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +``` + +This commands removes a sharesubscription named AdsShareSubscription from account WikiAds. + +## PARAMETERS + +### -AccountName +Azure data share account name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +{{Fill AsJob Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure data share subscription object + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSubscription +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure data share subscription name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return object (if specified). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data share subscription + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSubscription + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Remove-AzDataShareSynchronizationSetting.md b/azps-10.1.0/Az.DataShare/Remove-AzDataShareSynchronizationSetting.md new file mode 100644 index 0000000000..1c59f3cc92 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Remove-AzDataShareSynchronizationSetting.md @@ -0,0 +1,237 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/remove-azdatasharesynchronizationsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareSynchronizationSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareSynchronizationSetting.md +--- + +# Remove-AzDataShareSynchronizationSetting + +## SYNOPSIS +removes a synchronization setting + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzDataShareSynchronizationSetting -ResourceGroupName <String> -AccountName <String> -ShareName <String> + -Name <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzDataShareSynchronizationSetting -ResourceId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzDataShareSynchronizationSetting -InputObject <PSDataShareSynchronizationSetting> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataShareSynchronizationSetting** cmdlet removes a datashare synchronization setting + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataShareSynchronizationSetting -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareName "AdsShare" -Name "AdsShareSynchronizationSetting" +``` + +```output +Are you sure you want to remove synchronization-setting "AdsShareSynchronizationSetting"? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +``` + +This commands removes a synchronization setting named AdsShareSynchronizationSetting from share AdsShare. + +## PARAMETERS + +### -AccountName +Azure Data Share Account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +{{Fill AsJob Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Azure Data Share Synchronization setting. + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSynchronizationSetting +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Synchronization setting name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return object (if specified). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the synchronization setting + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareName +Azure data share name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSynchronizationSetting + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Remove-AzDataShareTrigger.md b/azps-10.1.0/Az.DataShare/Remove-AzDataShareTrigger.md new file mode 100644 index 0000000000..1c8c34b11d --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Remove-AzDataShareTrigger.md @@ -0,0 +1,237 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/remove-azdatasharetrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Remove-AzDataShareTrigger.md +--- + +# Remove-AzDataShareTrigger + +## SYNOPSIS +removes a trigger + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzDataShareTrigger -ResourceGroupName <String> -AccountName <String> [-ShareSubscriptionName <String>] + -Name <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzDataShareTrigger -ResourceId <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzDataShareTrigger -InputObject <PSDataShareTrigger> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataShareTrigger** cmdlet removes a datashare trigger + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDataShareTrigger -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareSubscriptionName "AdsShareSubscription" -Name "AdsTrigger" +``` + +```output +Are you sure you want to remove trigger "AdsTrigger"? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +``` + +This commands removes a trigger named AdsTrigger from share subscription AdsShareSubscription. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +{{Fill AsJob Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure data share trigger object + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareTrigger +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure data share trigger name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return object (if specified). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of azure data share trigger + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareSubscriptionName +Azure data share subscription name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareTrigger + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Revoke-AzDataShareSubscriptionAccess.md b/azps-10.1.0/Az.DataShare/Revoke-AzDataShareSubscriptionAccess.md new file mode 100644 index 0000000000..e06f873b65 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Revoke-AzDataShareSubscriptionAccess.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/revoke-azdatasharesubscriptionaccess +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Revoke-AzDataShareSubscriptionAccess.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Revoke-AzDataShareSubscriptionAccess.md +--- + +# Revoke-AzDataShareSubscriptionAccess + +## SYNOPSIS +Revokes share subscription access to source share + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Revoke-AzDataShareSubscriptionAccess -ResourceGroupName <String> -AccountName <String> [-ShareName <String>] + -ShareSubscriptionId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByProviderShareSubscriptionIdParameterSet +``` +Revoke-AzDataShareSubscriptionAccess -ShareSubscriptionId <String> -ResourceId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Revoke-AzDataShareSubscriptionAccess** cmdlet grants a share subscription access to source share + +## EXAMPLES + +### Example 1 +```powershell +Revoke-AzDataShareSubscriptionAccess -ResourceGroupName "ADS" -AccountName "WikiAdsAccount" -ShareName "AdsShare" -ShareSubscriptionId 8ee6e6fd-b4a1-49a4-bb66-f187f38e0e12 +``` + +```output +Company : ADS +CreatedAt : 6/15/2019 1:02:28 AM +CreatedBy : abc@microsoft.com +SharedAt : 6/15/2019 12:08:48 AM +SharedBy : abc@microsoft.com +ShareSubscriptionObjectId : 8ee6e6fd-b4a1-49a4-bb66-f187f38e0e12 +ShareSubscriptionStatus : Revoked +Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAdsAccount/shares/AdsShare/shareSubscriptions/8ee6e6fd-b4a1-49a4-bb66-f187f38e0e12 +Name : AdsShare +Type : Microsoft.DataShare/ShareSubscriptions +``` + +Revokes access of share subscription identified by id 8ee6e6fd-b4a1-49a4-bb66-f187f38e0e12 + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +{{Fill AsJob Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data share + +```yaml +Type: System.String +Parameter Sets: ByProviderShareSubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareName +Azure data share name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareSubscriptionId +The share subscription id of the provider share subscription + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareProviderShareSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Set-AzDataShare.md b/azps-10.1.0/Az.DataShare/Set-AzDataShare.md new file mode 100644 index 0000000000..8d11601e78 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Set-AzDataShare.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/set-azdatashare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Set-AzDataShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Set-AzDataShare.md +--- + +# Set-AzDataShare + +## SYNOPSIS +Updates an existing data share + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Set-AzDataShare -ResourceGroupName <String> -AccountName <String> -Name <String> [-Description <String>] + [-TermsOfUse <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Set-AzDataShare -ResourceId <String> [-Description <String>] [-TermsOfUse <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Set-AzDataShare -InputObject <PSDataShare> [-Description <String>] [-TermsOfUse <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataShare** cmdlet updates a data share that exists within a specified azure data share account. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDataShare -ResourceGroupName "ADS" -AccountName "WikiAdsAccount" -Name "AdsShare" -Description "Updated description" -TermsOfUse "Updated terms" +``` + +```output +Name : AdsShare +Id : /subscriptions/f3ead1ff-d0ab-4cf4-9a5a-86f1661d4685/resourceGroups/ADS/providers/Microsoft.DataShare/accounts/WikiAdsAccount/shares/AdsShare +Type : Microsoft.DataShare/shares +CreatedAt : 6/11/2019 12:00:00 AM +CreatedBy : Contoso ADS +ShareKind : CopyBased +Description : Updated description +ProvisioningState : Succeeded +Terms : Updated terms +``` + +This command updates an existing data share named AdsShare + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of Data Share + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure data share object + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShare +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure data share name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure data share + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TermsOfUse +Terms of Use for Data Share + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShare + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShare + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Start-AzDataShareSubscriptionSynchronization.md b/azps-10.1.0/Az.DataShare/Start-AzDataShareSubscriptionSynchronization.md new file mode 100644 index 0000000000..60157a4990 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Start-AzDataShareSubscriptionSynchronization.md @@ -0,0 +1,230 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/start-azdatasharesubscriptionsynchronization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Start-AzDataShareSubscriptionSynchronization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Start-AzDataShareSubscriptionSynchronization.md +--- + +# Start-AzDataShareSubscriptionSynchronization + +## SYNOPSIS +Initiates synchronization for a share subscription. A share subscription can be specified through its resource id or its name. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Start-AzDataShareSubscriptionSynchronization -ResourceGroupName <String> -AccountName <String> + -ShareSubscriptionName <String> -SynchronizationMode <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Start-AzDataShareSubscriptionSynchronization -SynchronizationMode <String> -ResourceId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Start-AzDataShareSubscriptionSynchronization -InputObject <PSDataShareSubscription> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzDataShareSubscriptionSynchronization** cmdlet initiates synchronization for a share subscription + +## EXAMPLES + +### Example 1 +```powershell +Start-AzDataShareSubscriptionSynchronization -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareSubscriptionName "AdsShareSubscription" -SynchronizationMode Incremental +``` + +```output +Confirm +AdsShareSubscription +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y + +durationMs : 231869 +endTime : 7/9/2019 11:44:41 PM +message : +startTime : 7/9/2019 11:40:53 PM +status : Succeeded +synchronizationId : 20a4416b-b33b-4539-a908-71dc8ef698fb +``` + +This commands initiates synchronization for a sharesubscription named AdsShareSubscription in account WikiAds. + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +{{Fill AsJob Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure data share subscription object + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSubscription +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure share subscription + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareSubscriptionName +Azure data share subscription name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SynchronizationMode +Synchronization mode (FullSync or Incremental) + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSubscription + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSubscriptionSynchronization + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DataShare/Stop-AzDataShareSubscriptionSynchronization.md b/azps-10.1.0/Az.DataShare/Stop-AzDataShareSubscriptionSynchronization.md new file mode 100644 index 0000000000..def30244c1 --- /dev/null +++ b/azps-10.1.0/Az.DataShare/Stop-AzDataShareSubscriptionSynchronization.md @@ -0,0 +1,230 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DataShare.dll-Help.xml +Module Name: Az.DataShare +online version: https://learn.microsoft.com/powershell/module/az.datashare/stop-azdatasharesubscriptionsynchronization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Stop-AzDataShareSubscriptionSynchronization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DataShare/DataShare/help/Stop-AzDataShareSubscriptionSynchronization.md +--- + +# Stop-AzDataShareSubscriptionSynchronization + +## SYNOPSIS +Stops ongoing synchronization for a share subscription. A share subscription can be specified through its resource id or its name. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Stop-AzDataShareSubscriptionSynchronization -ResourceGroupName <String> -AccountName <String> + -ShareSubscriptionName <String> -SynchronizationId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Stop-AzDataShareSubscriptionSynchronization -SynchronizationId <String> -ResourceId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Stop-AzDataShareSubscriptionSynchronization -InputObject <PSDataShareSubscription> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzDataShareSubscriptionSynchronization** cmdlet stops ongoing synchronization for a share subscription + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzDataShareSubscriptionSynchronization -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareSubscriptionName "AdsShareSubscription" -SynchronizationId 20a4416b-b33b-4539-a908-71dc8ef698fb +``` + +```output +Confirm +AdsShareSubscription +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y + +durationMs : 231869 +endTime : +message : +startTime : 7/9/2019 11:40:53 PM +status : Canceled +synchronizationId : 20a4416b-b33b-4539-a908-71dc8ef698fb +``` + +Stops ongoing synchronization identified by id - 20a4416b-b33b-4539-a908-71dc8ef698fb + +## PARAMETERS + +### -AccountName +Azure data share account name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +{{Fill AsJob Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure data share subscription object + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSubscription +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the azure data share account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the azure share subscription + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareSubscriptionName +Azure data share subscription name + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SynchronizationId +Synchronization id that needs to be stopped + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSubscription + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DataShare.Models.PSDataShareSubscriptionSynchronization + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Databricks/Az.Databricks.md b/azps-10.1.0/Az.Databricks/Az.Databricks.md new file mode 100644 index 0000000000..a909dcebc3 --- /dev/null +++ b/azps-10.1.0/Az.Databricks/Az.Databricks.md @@ -0,0 +1,59 @@ +--- +Module Name: Az.Databricks +Module Guid: fd603f36-03d8-47f4-9f7c-c13a78761936 +Download Help Link: https://learn.microsoft.com/powershell/module/az.databricks +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Az.Databricks.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Az.Databricks.md +--- + +# Az.Databricks Module +## Description +Microsoft Azure PowerShell: Databricks cmdlets + +## Az.Databricks Cmdlets +### [Get-AzDatabricksAccessConnector](Get-AzDatabricksAccessConnector.md) +Gets an azure databricks accessConnector. + +### [Get-AzDatabricksOutboundNetworkDependenciesEndpoint](Get-AzDatabricksOutboundNetworkDependenciesEndpoint.md) +Gets the list of endpoints that VNET Injected Workspace calls Azure Databricks Control Plane. +You must configure outbound access with these endpoints. +For more information, see https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr + +### [Get-AzDatabricksVNetPeering](Get-AzDatabricksVNetPeering.md) +Gets the workspace vNet Peering. + +### [Get-AzDatabricksWorkspace](Get-AzDatabricksWorkspace.md) +Gets the workspace. + +### [New-AzDatabricksAccessConnector](New-AzDatabricksAccessConnector.md) +Creates or updates azure databricks accessConnector. + +### [New-AzDatabricksVNetPeering](New-AzDatabricksVNetPeering.md) +Creates vNet Peering for workspace. + +### [New-AzDatabricksWorkspace](New-AzDatabricksWorkspace.md) +Creates a new workspace. + +### [New-AzDatabricksWorkspaceProviderAuthorizationObject](New-AzDatabricksWorkspaceProviderAuthorizationObject.md) +Create an in-memory object for WorkspaceProviderAuthorization. + +### [Remove-AzDatabricksAccessConnector](Remove-AzDatabricksAccessConnector.md) +Deletes the azure databricks accessConnector. + +### [Remove-AzDatabricksVNetPeering](Remove-AzDatabricksVNetPeering.md) +Deletes the workspace vNetPeering. + +### [Remove-AzDatabricksWorkspace](Remove-AzDatabricksWorkspace.md) +Deletes the workspace. + +### [Update-AzDatabricksAccessConnector](Update-AzDatabricksAccessConnector.md) +Updates an azure databricks accessConnector. + +### [Update-AzDatabricksVNetPeering](Update-AzDatabricksVNetPeering.md) +Update vNet Peering for workspace. + +### [Update-AzDatabricksWorkspace](Update-AzDatabricksWorkspace.md) +Updates a workspace. + diff --git a/azps-10.1.0/Az.Databricks/Get-AzDatabricksAccessConnector.md b/azps-10.1.0/Az.Databricks/Get-AzDatabricksAccessConnector.md new file mode 100644 index 0000000000..648339fc08 --- /dev/null +++ b/azps-10.1.0/Az.Databricks/Get-AzDatabricksAccessConnector.md @@ -0,0 +1,195 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/az.databricks/get-azdatabricksaccessconnector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Get-AzDatabricksAccessConnector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Get-AzDatabricksAccessConnector.md +--- + +# Get-AzDatabricksAccessConnector + +## SYNOPSIS +Gets an azure databricks accessConnector. + +## SYNTAX + +### List1 (Default) +``` +Get-AzDatabricksAccessConnector [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDatabricksAccessConnector -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDatabricksAccessConnector -InputObject <IDatabricksIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzDatabricksAccessConnector -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets an azure databricks accessConnector. + +## EXAMPLES + +### Example 1: List all access connectors under a subscription. +```powershell +Get-AzDatabricksAccessConnector +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps-databricks-accessconnector azps_test_gp_db +``` + +This command lists all access connectors under a subscription. + +### Example 2: List all access connectors under a resource group. +```powershell +Get-AzDatabricksAccessConnector -ResourceGroupName azps_test_gp_db +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps-databricks-accessconnector azps_test_gp_db +``` + +This command lists all access connectors under a resource group. + +### Example 3: Get a access connectors by name. +```powershell +Get-AzDatabricksAccessConnector -ResourceGroupName azps_test_gp_db -Name azps-databricks-accessconnector +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps-databricks-accessconnector azps_test_gp_db +``` + +This command gets a access connectors by name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the azure databricks accessConnector. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20221001Preview.IAccessConnector + +## 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 <IDatabricksIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of the azure databricks accessConnector. + - `[GroupId <String>]`: The name of the private link resource + - `[Id <String>]`: Resource identity path + - `[PeeringName <String>]`: The name of the workspace vNet peering. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Databricks/Get-AzDatabricksOutboundNetworkDependenciesEndpoint.md b/azps-10.1.0/Az.Databricks/Get-AzDatabricksOutboundNetworkDependenciesEndpoint.md new file mode 100644 index 0000000000..7ced11c631 --- /dev/null +++ b/azps-10.1.0/Az.Databricks/Get-AzDatabricksOutboundNetworkDependenciesEndpoint.md @@ -0,0 +1,129 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/az.databricks/get-azdatabricksoutboundnetworkdependenciesendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Get-AzDatabricksOutboundNetworkDependenciesEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Get-AzDatabricksOutboundNetworkDependenciesEndpoint.md +--- + +# Get-AzDatabricksOutboundNetworkDependenciesEndpoint + +## SYNOPSIS +Gets the list of endpoints that VNET Injected Workspace calls Azure Databricks Control Plane. +You must configure outbound access with these endpoints. +For more information, see https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr + +## SYNTAX + +``` +Get-AzDatabricksOutboundNetworkDependenciesEndpoint -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the list of endpoints that VNET Injected Workspace calls Azure Databricks Control Plane. +You must configure outbound access with these endpoints. +For more information, see https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr + +## EXAMPLES + +### Example 1: Gets the list of endpoints that VNET Injected Workspace calls Azure Databricks Control Plane. +```powershell +Get-AzDatabricksOutboundNetworkDependenciesEndpoint -ResourceGroupName azps_test_gp_db -WorkspaceName azps-databricks-workspace-t2 +``` + +```output +Category +-------- +Webapp +Control Plane NAT +Extended infrastructure +Azure Storage +Azure My SQL +Azure Servicebus +``` + +This command gets the list of endpoints that VNET Injected Workspace calls Azure Databricks Control Plane. +You must configure outbound access with these endpoints. +For more information, see https://learn.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20230201.IOutboundEnvironmentEndpoint + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Databricks/Get-AzDatabricksVNetPeering.md b/azps-10.1.0/Az.Databricks/Get-AzDatabricksVNetPeering.md new file mode 100644 index 0000000000..4a19c18042 --- /dev/null +++ b/azps-10.1.0/Az.Databricks/Get-AzDatabricksVNetPeering.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/az.databricks/get-azdatabricksvnetpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Get-AzDatabricksVNetPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Get-AzDatabricksVNetPeering.md +--- + +# Get-AzDatabricksVNetPeering + +## SYNOPSIS +Gets the workspace vNet Peering. + +## SYNTAX + +### List (Default) +``` +Get-AzDatabricksVNetPeering -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDatabricksVNetPeering -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDatabricksVNetPeering -InputObject <IDatabricksIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the workspace vNet Peering. + +## EXAMPLES + +### Example 1: List all vnet peering under a databricks. +```powershell +Get-AzDatabricksVNetPeering -WorkspaceName azps-databricks-workspace-t1 -ResourceGroupName azps_test_gp_db +``` + +```output +Name ResourceGroupName +---- ----------------- +vnet-peering-t1 azps_test_gp_db +``` + +This command lists all vnet peering under a databricks. + +### Example 2: Get a vnet peering. +```powershell +Get-AzDatabricksVNetPeering -WorkspaceName azps-databricks-workspace-t1 -ResourceGroupName azps_test_gp_db -Name vnet-peering-t1 +``` + +```output +Name ResourceGroupName +---- ----------------- +vnet-peering-t1 azps_test_gp_db +``` + +This command gets a vnet peering. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the workspace vNet peering. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20230201.IVirtualNetworkPeering + +## 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 <IDatabricksIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of the azure databricks accessConnector. + - `[GroupId <String>]`: The name of the private link resource + - `[Id <String>]`: Resource identity path + - `[PeeringName <String>]`: The name of the workspace vNet peering. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Databricks/Get-AzDatabricksWorkspace.md b/azps-10.1.0/Az.Databricks/Get-AzDatabricksWorkspace.md new file mode 100644 index 0000000000..cd0edcfb75 --- /dev/null +++ b/azps-10.1.0/Az.Databricks/Get-AzDatabricksWorkspace.md @@ -0,0 +1,198 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/az.databricks/get-azdatabricksworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Get-AzDatabricksWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Get-AzDatabricksWorkspace.md +--- + +# Get-AzDatabricksWorkspace + +## SYNOPSIS +Gets the workspace. + +## SYNTAX + +### List1 (Default) +``` +Get-AzDatabricksWorkspace [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDatabricksWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDatabricksWorkspace -InputObject <IDatabricksIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzDatabricksWorkspace -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the workspace. + +## EXAMPLES + +### Example 1: Get a Databricks workspace with name. +```powershell +Get-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t3 +``` + +```output +Name ResourceGroupName Location Managed Resource Group ID +---- ----------------- -------- ------------------------- +azps-databricks-workspace-t3 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t3 +``` + +This command gets a Databricks workspace in a resource group. + +### Example 2: List all Databricks workspaces in a subscription. +```powershell +Get-AzDatabricksWorkspace +``` + +```output +Name ResourceGroupName Location Managed Resource Group ID +---- ----------------- -------- ------------------------- +azps-databricks-workspace-t1 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t1 +azps-databricks-workspace-t2 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t2 +azps-databricks-workspace-t3 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t3 +``` + +This command lists all Databricks workspaces in a subscription. + +### Example 3: List all Databricks workspaces in a resource group. +```powershell +Get-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db +``` + +```output +Name ResourceGroupName Location Managed Resource Group ID +---- ----------------- -------- ------------------------- +azps-databricks-workspace-t1 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t1 +azps-databricks-workspace-t2 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t2 +azps-databricks-workspace-t3 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t3 +``` + +This command lists all Databricks workspaces in a resource group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20230201.IWorkspace + +## 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 <IDatabricksIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of the azure databricks accessConnector. + - `[GroupId <String>]`: The name of the private link resource + - `[Id <String>]`: Resource identity path + - `[PeeringName <String>]`: The name of the workspace vNet peering. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Databricks/New-AzDatabricksAccessConnector.md b/azps-10.1.0/Az.Databricks/New-AzDatabricksAccessConnector.md new file mode 100644 index 0000000000..73e839e993 --- /dev/null +++ b/azps-10.1.0/Az.Databricks/New-AzDatabricksAccessConnector.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/az.databricks/new-azdatabricksaccessconnector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/New-AzDatabricksAccessConnector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/New-AzDatabricksAccessConnector.md +--- + +# New-AzDatabricksAccessConnector + +## SYNOPSIS +Creates or updates azure databricks accessConnector. + +## SYNTAX + +``` +New-AzDatabricksAccessConnector -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-IdentityType <ManagedServiceIdentityType>] [-Tag <Hashtable>] + [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates azure databricks accessConnector. + +## EXAMPLES + +### Example 1: Creates or updates azure databricks accessConnector. +```powershell +New-AzDatabricksAccessConnector -ResourceGroupName azps_test_gp_db -Name azps-databricks-accessconnector -Location eastus -IdentityType 'SystemAssigned' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps-databricks-accessconnector azps_test_gp_db +``` + +This command creates or updates azure databricks accessConnector. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the azure databricks accessConnector. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20221001Preview.IAccessConnector + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Databricks/New-AzDatabricksVNetPeering.md b/azps-10.1.0/Az.Databricks/New-AzDatabricksVNetPeering.md new file mode 100644 index 0000000000..e0505c4343 --- /dev/null +++ b/azps-10.1.0/Az.Databricks/New-AzDatabricksVNetPeering.md @@ -0,0 +1,320 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/az.databricks/new-azdatabricksvnetpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/New-AzDatabricksVNetPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/New-AzDatabricksVNetPeering.md +--- + +# New-AzDatabricksVNetPeering + +## SYNOPSIS +Creates vNet Peering for workspace. + +## SYNTAX + +``` +New-AzDatabricksVNetPeering -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-AllowForwardedTraffic] [-AllowGatewayTransit] [-AllowVirtualNetworkAccess] + [-DatabricksAddressSpacePrefix <String[]>] [-DatabricksVirtualNetworkId <String>] + [-RemoteAddressSpacePrefix <String[]>] [-RemoteVirtualNetworkId <String>] [-UseRemoteGateway] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates vNet Peering for workspace. + +## EXAMPLES + +### Example 1: Create a vnet peering for databricks. +```powershell +New-AzDatabricksVNetPeering -Name vnet-peering-t1 -WorkspaceName azps-databricks-workspace-t1 -ResourceGroupName azps_test_gp_db -RemoteVirtualNetworkId '/subscriptions/{subId}/resourceGroups/azps_test_gp_db/providers/Microsoft.Network/virtualNetworks/azps-VNnet-t1' +``` + +```output +Name ResourceGroupName +---- ----------------- +vnet-peering-t1 azps_test_gp_db +``` + +This command creates a vnet peering for databricks. + +## PARAMETERS + +### -AllowForwardedTraffic +Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGatewayTransit +If gateway links can be used in remote virtual networking to link to this virtual network. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowVirtualNetworkAccess +Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabricksAddressSpacePrefix +A list of address blocks reserved for this virtual network in CIDR notation. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabricksVirtualNetworkId +The Id of the databricks virtual network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the workspace vNet peering. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteAddressSpacePrefix +A list of address blocks reserved for this virtual network in CIDR notation. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteVirtualNetworkId +The Id of the remote virtual network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseRemoteGateway +If remote gateways can be used on this virtual network. +If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. +Only one peering can have this flag set to true. +This flag cannot be set if virtual network already has a gateway. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20230201.IVirtualNetworkPeering + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Databricks/New-AzDatabricksWorkspace.md b/azps-10.1.0/Az.Databricks/New-AzDatabricksWorkspace.md new file mode 100644 index 0000000000..551ae648ef --- /dev/null +++ b/azps-10.1.0/Az.Databricks/New-AzDatabricksWorkspace.md @@ -0,0 +1,752 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/az.databricks/new-azdatabricksworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/New-AzDatabricksWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/New-AzDatabricksWorkspace.md +--- + +# New-AzDatabricksWorkspace + +## SYNOPSIS +Creates a new workspace. + +## SYNTAX + +``` +New-AzDatabricksWorkspace -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-AmlWorkspaceId <String>] [-Authorization <IWorkspaceProviderAuthorization[]>] + [-EnableNoPublicIP] [-EncryptionKeyName <String>] [-EncryptionKeySource <KeySource>] + [-EncryptionKeyVaultUri <String>] [-EncryptionKeyVersion <String>] [-LoadBalancerBackendPoolName <String>] + [-LoadBalancerId <String>] [-ManagedDiskKeyVaultPropertiesKeyName <String>] + [-ManagedDiskKeyVaultPropertiesKeyVaultUri <String>] [-ManagedDiskKeyVaultPropertiesKeyVersion <String>] + [-ManagedDiskRotationToLatestKeyVersionEnabled] [-ManagedResourceGroupName <String>] + [-ManagedServicesKeyVaultPropertiesKeyName <String>] [-ManagedServicesKeyVaultPropertiesKeyVaultUri <String>] + [-ManagedServicesKeyVaultPropertiesKeyVersion <String>] [-NatGatewayName <String>] [-PrepareEncryption] + [-PrivateSubnetName <String>] [-PublicIPName <String>] [-PublicNetworkAccess <PublicNetworkAccess>] + [-PublicSubnetName <String>] [-RequiredNsgRule <RequiredNsgRules>] [-RequireInfrastructureEncryption] + [-Sku <String>] [-SkuTier <String>] [-StorageAccountName <String>] [-StorageAccountSku <String>] + [-Tag <Hashtable>] [-UiDefinitionUri <String>] [-VirtualNetworkId <String>] [-VnetAddressPrefix <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new workspace. + +## EXAMPLES + +### Example 1: Create a Databricks workspace. +```powershell +New-AzDatabricksWorkspace -Name azps-databricks-workspace-t1 -ResourceGroupName azps_test_gp_db -Location eastus -ManagedResourceGroupName azps_test_gp_kv_t1 -Sku Premium +``` + +```output +Name ResourceGroupName Location Managed Resource Group ID +---- ----------------- -------- ------------------------- +azps-databricks-workspace-t1 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t1 +``` + +This command creates a Databricks workspace. + +### Example 2: Create a Databricks workspace with a customized virtual network. +```powershell +$dlg = New-AzDelegation -Name dbrdl -ServiceName "Microsoft.Databricks/workspaces" +$rdpRule = New-AzNetworkSecurityRuleConfig -Name azps-network-security-rule -Description "Allow RDP" -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 +$networkSecurityGroup = New-AzNetworkSecurityGroup -ResourceGroupName azps_test_gp_db -Location eastus -Name azps-network-security-group -SecurityRules $rdpRule +$kvSubnet = New-AzVirtualNetworkSubnetConfig -Name azps-vnetwork-sub-kv -AddressPrefix "110.0.1.0/24" -ServiceEndpoint "Microsoft.KeyVault" +$priSubnet = New-AzVirtualNetworkSubnetConfig -Name azps-vnetwork-sub-pri -AddressPrefix "110.0.2.0/24" -NetworkSecurityGroup $networkSecurityGroup -Delegation $dlg +$pubSubnet = New-AzVirtualNetworkSubnetConfig -Name azps-vnetwork-sub-pub -AddressPrefix "110.0.3.0/24" -NetworkSecurityGroup $networkSecurityGroup -Delegation $dlg +$testVN = New-AzVirtualNetwork -Name azps-virtual-network -ResourceGroupName azps_test_gp_db -Location eastus -AddressPrefix "110.0.0.0/16" -Subnet $kvSubnet,$priSubnet,$pubSubnet +$vNetResId = (Get-AzVirtualNetwork -Name azps-virtual-network -ResourceGroupName azps_test_gp_db).Subnets[0].Id +$ruleSet = New-AzKeyVaultNetworkRuleSetObject -DefaultAction Allow -Bypass AzureServices -IpAddressRange "110.0.1.0/24" -VirtualNetworkResourceId $vNetResId +New-AzKeyVault -ResourceGroupName azps_test_gp_db -VaultName azps-keyvault -NetworkRuleSet $ruleSet -Location eastus -Sku 'Premium' -EnablePurgeProtection +New-AzDatabricksWorkspace -Name azps-databricks-workspace-t2 -ResourceGroupName azps_test_gp_db -Location eastus -ManagedResourceGroupName azps_test_gp_kv_t2 -VirtualNetworkId $testVN.Id -PrivateSubnetName $priSubnet.Name -PublicSubnetName $pubSubnet.Name -Sku Premium +``` + +```output +Name ResourceGroupName Location Managed Resource Group ID +---- ----------------- -------- ------------------------- +azps-databricks-workspace-t2 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t2 +``` + +This command creates a Databricks workspace with customized virtual network in a resource group. + +### Example 3: Create a Databricks workspace with enable encryption. +```powershell +New-AzDatabricksWorkspace -Name azps-databricks-workspace-t3 -ResourceGroupName azps_test_gp_db -Location eastus -PrepareEncryption -ManagedResourceGroupName azps_test_gp_kv_t3 -Sku premium +``` + +```output +Name ResourceGroupName Location Managed Resource Group ID +---- ----------------- -------- ------------------------- +azps-databricks-workspace-t3 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t3 +``` + +This command creates a Databricks workspace and sets it to prepare for encryption. +Please refer to the examples of Update-AzDatabricksWorkspace for more settings to encryption. + +## PARAMETERS + +### -AmlWorkspaceId +The value which should be used for this field. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +The workspace provider authorizations. +To construct, see NOTES section for AUTHORIZATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20230201.IWorkspaceProviderAuthorization[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNoPublicIP +The value which should be used for this field. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyName +The name of KeyVault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeySource +The encryption keySource (provider). +Possible values (case-insensitive): Default, Microsoft.Keyvault + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.KeySource +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyVaultUri +The Uri of KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyVersion +The version of KeyVault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerBackendPoolName +The value which should be used for this field. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerId +The value which should be used for this field. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedDiskKeyVaultPropertiesKeyName +The name of KeyVault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedDiskKeyVaultPropertiesKeyVaultUri +The URI of KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedDiskKeyVaultPropertiesKeyVersion +The version of KeyVault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedDiskRotationToLatestKeyVersionEnabled +Indicate whether the latest key version should be automatically used for Managed Disk Encryption. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedResourceGroupName +The managed resource group Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedServicesKeyVaultPropertiesKeyName +The name of KeyVault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedServicesKeyVaultPropertiesKeyVaultUri +The Uri of KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedServicesKeyVaultPropertiesKeyVersion +The version of KeyVault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NatGatewayName +The value which should be used for this field. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrepareEncryption +The value which should be used for this field. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateSubnetName +The value which should be used for this field. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIPName +The value which should be used for this field. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +The network access type for accessing workspace. +Set value to disabled to access workspace only via private link. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicSubnetName +The value which should be used for this field. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredNsgRule +Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. +Supported values are 'AllRules' and 'NoAzureDatabricksRules'. +'NoAzureServiceRules' value is for internal use only. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.RequiredNsgRules +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireInfrastructureEncryption +The value which should be used for this field. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SKU name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +The SKU tier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The value which should be used for this field. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountSku +The value which should be used for this field. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiDefinitionUri +The blob URI where the UI definition file is located. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkId +The value which should be used for this field. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetAddressPrefix +The value which should be used for this field. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20230201.IWorkspace + +## 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. + + +`AUTHORIZATION <IWorkspaceProviderAuthorization[]>`: The workspace provider authorizations. + - `PrincipalId <String>`: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. + - `RoleDefinitionId <String>`: The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Databricks/New-AzDatabricksWorkspaceProviderAuthorizationObject.md b/azps-10.1.0/Az.Databricks/New-AzDatabricksWorkspaceProviderAuthorizationObject.md new file mode 100644 index 0000000000..b51a039724 --- /dev/null +++ b/azps-10.1.0/Az.Databricks/New-AzDatabricksWorkspaceProviderAuthorizationObject.md @@ -0,0 +1,89 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/Az.Databricks/new-AzDatabricksWorkspaceProviderAuthorizationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/New-AzDatabricksWorkspaceProviderAuthorizationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/New-AzDatabricksWorkspaceProviderAuthorizationObject.md +--- + +# New-AzDatabricksWorkspaceProviderAuthorizationObject + +## SYNOPSIS +Create an in-memory object for WorkspaceProviderAuthorization. + +## SYNTAX + +``` +New-AzDatabricksWorkspaceProviderAuthorizationObject -PrincipalId <String> -RoleDefinitionId <String> + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for WorkspaceProviderAuthorization. + +## EXAMPLES + +### Example 1: Create an in-memory object for WorkspaceProviderAuthorization. +```powershell +New-AzDatabricksWorkspaceProviderAuthorizationObject -PrincipalId 024d7367-0890-4ad3-8140-e37374722820 -RoleDefinitionId 2124844c-7e23-48cc-bc52-a3af25f7a4ae +``` + +```output +PrincipalId RoleDefinitionId +----------- ---------------- +024d7367-0890-4ad3-8140-e37374722820 2124844c-7e23-48cc-bc52-a3af25f7a4ae +``` + +Create an in-memory object for WorkspaceProviderAuthorization. + +## PARAMETERS + +### -PrincipalId +The provider's principal identifier. +This is the identity that the provider will use to call ARM to manage the workspace resources. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +The provider's role definition identifier. +This role will define all the permissions that the provider must have on the workspace's container resource group. +This role definition cannot have permission to delete the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20230201.WorkspaceProviderAuthorization + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Databricks/Remove-AzDatabricksAccessConnector.md b/azps-10.1.0/Az.Databricks/Remove-AzDatabricksAccessConnector.md new file mode 100644 index 0000000000..d449dd22f8 --- /dev/null +++ b/azps-10.1.0/Az.Databricks/Remove-AzDatabricksAccessConnector.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/az.databricks/remove-azdatabricksaccessconnector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Remove-AzDatabricksAccessConnector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Remove-AzDatabricksAccessConnector.md +--- + +# Remove-AzDatabricksAccessConnector + +## SYNOPSIS +Deletes the azure databricks accessConnector. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDatabricksAccessConnector -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDatabricksAccessConnector -InputObject <IDatabricksIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the azure databricks accessConnector. + +## EXAMPLES + +### Example 1: Deletes the azure databricks accessConnector. +```powershell +Remove-AzDatabricksAccessConnector -ResourceGroupName azps_test_gp_db -Name azps-databricks-accessconnector +``` + +This command deletes the azure databricks accessConnector. + +### Example 2: Deletes the azure databricks accessConnector by pipeline. +```powershell +Get-AzDatabricksAccessConnector -ResourceGroupName azps_test_gp_db -Name azps-databricks-accessconnector | Remove-AzDatabricksAccessConnector +``` + +This command deletes the azure databricks accessConnector by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the azure databricks accessConnector. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDatabricksIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of the azure databricks accessConnector. + - `[GroupId <String>]`: The name of the private link resource + - `[Id <String>]`: Resource identity path + - `[PeeringName <String>]`: The name of the workspace vNet peering. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Databricks/Remove-AzDatabricksVNetPeering.md b/azps-10.1.0/Az.Databricks/Remove-AzDatabricksVNetPeering.md new file mode 100644 index 0000000000..cbb775dd6f --- /dev/null +++ b/azps-10.1.0/Az.Databricks/Remove-AzDatabricksVNetPeering.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/az.databricks/remove-azdatabricksvnetpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Remove-AzDatabricksVNetPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Remove-AzDatabricksVNetPeering.md +--- + +# Remove-AzDatabricksVNetPeering + +## SYNOPSIS +Deletes the workspace vNetPeering. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDatabricksVNetPeering -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDatabricksVNetPeering -InputObject <IDatabricksIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the workspace vNetPeering. + +## EXAMPLES + +### Example 1: Remove a vnet peering of databricks by name. +```powershell +Remove-AzDatabricksVNetPeering -Name vnet-peering-t1 -WorkspaceName azps-databricks-workspace-t1 -ResourceGroupName azps_test_gp_db +``` + +This command removes a vnet peering of databricks by name. + +### Example 2: Remove a vnet peering of databricks by object. +```powershell +Get-AzDatabricksVNetPeering -Name vnet-peering-t1 -WorkspaceName azps-databricks-workspace-t1 -ResourceGroupName azps_test_gp_db | Remove-AzDatabricksVNetPeering +``` + +This command removes a vnet peering of databricks by object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the workspace vNet peering. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDatabricksIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of the azure databricks accessConnector. + - `[GroupId <String>]`: The name of the private link resource + - `[Id <String>]`: Resource identity path + - `[PeeringName <String>]`: The name of the workspace vNet peering. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Databricks/Remove-AzDatabricksWorkspace.md b/azps-10.1.0/Az.Databricks/Remove-AzDatabricksWorkspace.md new file mode 100644 index 0000000000..5be93ac539 --- /dev/null +++ b/azps-10.1.0/Az.Databricks/Remove-AzDatabricksWorkspace.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/az.databricks/remove-azdatabricksworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Remove-AzDatabricksWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Remove-AzDatabricksWorkspace.md +--- + +# Remove-AzDatabricksWorkspace + +## SYNOPSIS +Deletes the workspace. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDatabricksWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDatabricksWorkspace -InputObject <IDatabricksIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the workspace. + +## EXAMPLES + +### Example 1: Remove a Databricks workspace. +```powershell +Remove-AzDatabricksWorkspace -Name azps-databricks-workspace -ResourceGroupName azps_test_gp_db +``` + +This command removes a Databricks workspace from a resource group. + +### Example 2: Remove a Databricks workspace by object. +```powershell +Get-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t3 | Remove-AzDatabricksWorkspace +``` + +This command removes a Databricks workspace from a resource group. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDatabricksIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of the azure databricks accessConnector. + - `[GroupId <String>]`: The name of the private link resource + - `[Id <String>]`: Resource identity path + - `[PeeringName <String>]`: The name of the workspace vNet peering. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Databricks/Update-AzDatabricksAccessConnector.md b/azps-10.1.0/Az.Databricks/Update-AzDatabricksAccessConnector.md new file mode 100644 index 0000000000..120563c2e0 --- /dev/null +++ b/azps-10.1.0/Az.Databricks/Update-AzDatabricksAccessConnector.md @@ -0,0 +1,281 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/az.databricks/update-azdatabricksaccessconnector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Update-AzDatabricksAccessConnector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Update-AzDatabricksAccessConnector.md +--- + +# Update-AzDatabricksAccessConnector + +## SYNOPSIS +Updates an azure databricks accessConnector. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDatabricksAccessConnector -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDatabricksAccessConnector -InputObject <IDatabricksIdentity> + [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an azure databricks accessConnector. + +## EXAMPLES + +### Example 1: Updates an azure databricks accessConnector. +```powershell +Update-AzDatabricksAccessConnector -ResourceGroupName azps_test_gp_db -Name azps-databricks-accessconnector -Tag @{'key'='value'} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps-databricks-accessconnector azps_test_gp_db +``` + +This command updates an azure databricks accessConnector. + +### Example 2: Updates an azure databricks accessConnector by pipeline. +```powershell +Get-AzDatabricksAccessConnector -ResourceGroupName azps_test_gp_db -Name azps-databricks-accessconnector | Update-AzDatabricksAccessConnector -Tag @{'key'='value'} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps-databricks-accessconnector azps_test_gp_db +``` + +This command updates an azure databricks accessConnector by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the azure databricks accessConnector. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20221001Preview.IAccessConnector + +## 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 <IDatabricksIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of the azure databricks accessConnector. + - `[GroupId <String>]`: The name of the private link resource + - `[Id <String>]`: Resource identity path + - `[PeeringName <String>]`: The name of the workspace vNet peering. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Databricks/Update-AzDatabricksVNetPeering.md b/azps-10.1.0/Az.Databricks/Update-AzDatabricksVNetPeering.md new file mode 100644 index 0000000000..6123db4993 --- /dev/null +++ b/azps-10.1.0/Az.Databricks/Update-AzDatabricksVNetPeering.md @@ -0,0 +1,381 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/az.databricks/update-azdatabricksvnetpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Update-AzDatabricksVNetPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Update-AzDatabricksVNetPeering.md +--- + +# Update-AzDatabricksVNetPeering + +## SYNOPSIS +Update vNet Peering for workspace. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDatabricksVNetPeering -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-AllowForwardedTraffic <Boolean>] [-AllowGatewayTransit <Boolean>] + [-AllowVirtualNetworkAccess <Boolean>] [-DatabricksAddressSpacePrefix <String[]>] + [-DatabricksVirtualNetworkId <String>] [-RemoteAddressSpacePrefix <String[]>] + [-RemoteVirtualNetworkId <String>] [-UseRemoteGateway <Boolean>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDatabricksVNetPeering -InputObject <IDatabricksIdentity> [-AllowForwardedTraffic <Boolean>] + [-AllowGatewayTransit <Boolean>] [-AllowVirtualNetworkAccess <Boolean>] + [-DatabricksAddressSpacePrefix <String[]>] [-DatabricksVirtualNetworkId <String>] + [-RemoteAddressSpacePrefix <String[]>] [-RemoteVirtualNetworkId <String>] [-UseRemoteGateway <Boolean>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update vNet Peering for workspace. + +## EXAMPLES + +### Example 1: Update AllowForwardedTraffic of vnet peering. +```powershell +Update-AzDatabricksVNetPeering -Name vnet-peering-t1 -WorkspaceName azps-databricks-workspace-t1 -ResourceGroupName azps_test_gp_db -AllowForwardedTraffic $True +``` + +```output +Name ResourceGroupName +---- ----------------- +vnet-peering-t1 azps_test_gp_db +``` + +This command updates AllowForwardedTraffic of vnet peering. + +### Example 2: Update AllowForwardedTraffic of vnet peering by object. +```powershell +Get-AzDatabricksVNetPeering -WorkspaceName azps-databricks-workspace-t1 -ResourceGroupName azps_test_gp_db -Name vnet-peering-t1 | Update-AzDatabricksVNetPeering -AllowGatewayTransit $true +``` + +```output +Name ResourceGroupName +---- ----------------- +vnet-peering-t1 azps_test_gp_db +``` + +This command updates AllowForwardedTraffic of vnet peering by object. + +## PARAMETERS + +### -AllowForwardedTraffic +[System.Management.Automation.SwitchParameter] +Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGatewayTransit +[System.Management.Automation.SwitchParameter] +If gateway links can be used in remote virtual networking to link to this virtual network. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowVirtualNetworkAccess +[System.Management.Automation.SwitchParameter] +Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabricksAddressSpacePrefix +A list of address blocks reserved for this virtual network in CIDR notation. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabricksVirtualNetworkId +The Id of the databricks virtual network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the VNetPeering. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: PeeringName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteAddressSpacePrefix +A list of address blocks reserved for this virtual network in CIDR notation. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteVirtualNetworkId +The Id of the remote virtual network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseRemoteGateway +[System.Management.Automation.SwitchParameter] +If remote gateways can be used on this virtual network. +If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. +Only one peering can have this flag set to true. +This flag cannot be set if virtual network already has a gateway. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20230201.IVirtualNetworkPeering + +## 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 <IDatabricksIdentity>`: Identity parameter. + - `[ConnectorName <String>]`: The name of the azure databricks accessConnector. + - `[GroupId <String>]`: The name of the private link resource + - `[Id <String>]`: Resource identity path + - `[PeeringName <String>]`: The name of the workspace vNet peering. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Databricks/Update-AzDatabricksWorkspace.md b/azps-10.1.0/Az.Databricks/Update-AzDatabricksWorkspace.md new file mode 100644 index 0000000000..10a38649b4 --- /dev/null +++ b/azps-10.1.0/Az.Databricks/Update-AzDatabricksWorkspace.md @@ -0,0 +1,608 @@ +--- +external help file: +Module Name: Az.Databricks +online version: https://learn.microsoft.com/powershell/module/az.databricks/update-azdatabricksworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Update-AzDatabricksWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Databricks/help/Update-AzDatabricksWorkspace.md +--- + +# Update-AzDatabricksWorkspace + +## SYNOPSIS +Updates a workspace. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDatabricksWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AmlWorkspaceId <String>] [-Authorization <IWorkspaceProviderAuthorization[]>] [-EncryptionKeyName <String>] + [-EncryptionKeySource <KeySource>] [-EncryptionKeyVaultUri <String>] [-EncryptionKeyVersion <String>] + [-KeyVaultKeyName <String>] [-KeyVaultKeyVersion <String>] [-KeyVaultUri <String>] + [-ManagedDiskKeyVaultPropertiesKeyName <String>] [-ManagedDiskKeyVaultPropertiesKeyVaultUri <String>] + [-ManagedDiskKeyVaultPropertiesKeyVersion <String>] [-ManagedDiskRotationToLatestKeyVersionEnabled] + [-ManagedServicesKeyVaultPropertiesKeyName <String>] [-ManagedServicesKeyVaultPropertiesKeyVaultUri <String>] + [-ManagedServicesKeyVaultPropertiesKeyVersion <String>] [-PrepareEncryption] + [-RequiredNsgRule <RequiredNsgRules>] [-SkuTier <String>] [-Tag <Hashtable>] [-UiDefinitionUri <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDatabricksWorkspace -InputObject <IDatabricksIdentity> [-AmlWorkspaceId <String>] + [-Authorization <IWorkspaceProviderAuthorization[]>] [-EncryptionKeyName <String>] + [-EncryptionKeySource <KeySource>] [-EncryptionKeyVaultUri <String>] [-EncryptionKeyVersion <String>] + [-KeyVaultKeyName <String>] [-KeyVaultKeyVersion <String>] [-KeyVaultUri <String>] + [-ManagedDiskKeyVaultPropertiesKeyName <String>] [-ManagedDiskKeyVaultPropertiesKeyVaultUri <String>] + [-ManagedDiskKeyVaultPropertiesKeyVersion <String>] [-ManagedDiskRotationToLatestKeyVersionEnabled] + [-ManagedServicesKeyVaultPropertiesKeyName <String>] [-ManagedServicesKeyVaultPropertiesKeyVaultUri <String>] + [-ManagedServicesKeyVaultPropertiesKeyVersion <String>] [-PrepareEncryption] + [-RequiredNsgRule <RequiredNsgRules>] [-SkuTier <String>] [-Tag <Hashtable>] [-UiDefinitionUri <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a workspace. + +## EXAMPLES + +### Example 1: Updates the tags of a Databricks workspace. +```powershell +Get-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t1 | Update-AzDatabricksWorkspace -Tag @{"key"="value"} +``` + +```output +Name ResourceGroupName Location Managed Resource Group ID +---- ----------------- -------- ------------------------- +azps-databricks-workspace-t1 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t1 +``` + +This command updates the tags of a Databricks workspace. + +### Example 2: Enable encryption on a Databricks workspace. +```powershell +Update-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t2 -PrepareEncryption +$updWsp = Get-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t2 +Set-AzKeyVaultAccessPolicy -VaultName azps-keyvault -ObjectId $updWsp.StorageAccountIdentityPrincipalId -PermissionsToKeys wrapkey,unwrapkey,get +Update-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t2 -EncryptionKeySource 'Microsoft.KeyVault' -EncryptionKeyVaultUri https://azps-keyvault.vault.azure.net/ -EncryptionKeyName azps-k1 -EncryptionKeyVersion a563a8021cba47109d93bd6d690621a7 +``` + +```output +Name ResourceGroupName Location Managed Resource Group ID +---- ----------------- -------- ------------------------- +azps-databricks-workspace-t2 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t2 +``` + +Enabling encryption on a Databricks workspace takes three steps: +1.Please make sure that KeyVault has Purge protection enabled. +2.Update the workspace with `-PrepareEncryption` (if it was not created so). +3.Find `StorageAccountIdentityPrincipalId` in the output of the last step and grant key permissions to the principal. +4.Update the workspace again to fill in information about the encryption key: + - `-EncryptionKeySource` + - `-EncryptionKeyVaultUri` + - `-EncryptionKeyName` + - `-EncryptionKeyVersion` + +### Example 3: Disable encryption on a Databricks workspace. +```powershell +Update-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t3 -EncryptionKeySource 'Default' +``` + +```output +Name ResourceGroupName Location Managed Resource Group ID +---- ----------------- -------- ------------------------- +azps-databricks-workspace-t3 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t3 +``` + +To disable encryption, simply set `-EncryptionKeySource` to `'Default'`. + +### Example 4: Update NsgRule of the Databricks workspace. +```powershell +Update-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t2 -RequiredNsgRule 'AllRules' +``` + +```output +Name ResourceGroupName Location Managed Resource Group ID +---- ----------------- -------- ------------------------- +azps-databricks-workspace-t2 azps_test_gp_db eastus /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t2 +``` + +This command updates NsgRule of the Databricks workspace. + +## PARAMETERS + +### -AmlWorkspaceId +The value which should be used for this field. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +The workspace provider authorizations. +To construct, see NOTES section for AUTHORIZATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20230201.IWorkspaceProviderAuthorization[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyName +The name of Key Vault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeySource +The encryption keySource (provider). +Possible values (case-insensitive): Default, Microsoft.Keyvault + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.KeySource +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyVaultUri +The URI (DNS name) of the Key Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyVersion +The version of KeyVault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyVaultKeyName +The name of KeyVault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultKeyVersion +The version of KeyVault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultUri +The Uri of KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedDiskKeyVaultPropertiesKeyName +The name of KeyVault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedDiskKeyVaultPropertiesKeyVaultUri +The URI of KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedDiskKeyVaultPropertiesKeyVersion +The version of KeyVault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedDiskRotationToLatestKeyVersionEnabled +Indicate whether the latest key version should be automatically used for Managed Disk Encryption. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedServicesKeyVaultPropertiesKeyName +The name of KeyVault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedServicesKeyVaultPropertiesKeyVaultUri +The Uri of KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedServicesKeyVaultPropertiesKeyVersion +The version of KeyVault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrepareEncryption +Prepare the workspace for encryption. +Enables the Managed Identity for managed storage account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredNsgRule +Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. +Supported values are 'AllRules' and 'NoAzureDatabricksRules'. +'NoAzureServiceRules' value is for internal use only. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.RequiredNsgRules +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +The SKU tier. + +```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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiDefinitionUri +The blob URI where the UI definition file is located. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IDatabricksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20230201.IWorkspace + +## 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. + + +`AUTHORIZATION <IWorkspaceProviderAuthorization[]>`: The workspace provider authorizations. + - `PrincipalId <String>`: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. + - `RoleDefinitionId <String>`: The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. + +`INPUTOBJECT <IDatabricksIdentity>`: Identity parameter. + - `[ConnectorName <String>]`: The name of the azure databricks accessConnector. + - `[GroupId <String>]`: The name of the private link resource + - `[Id <String>]`: Resource identity path + - `[PeeringName <String>]`: The name of the workspace vNet peering. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/Az.Datadog.md b/azps-10.1.0/Az.Datadog/Az.Datadog.md new file mode 100644 index 0000000000..41fc0b5e34 --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Az.Datadog.md @@ -0,0 +1,69 @@ +--- +Module Name: Az.Datadog +Module Guid: 41d5c7d4-9068-4baf-9995-db228e7600b3 +Download Help Link: https://learn.microsoft.com/powershell/module/az.datadog +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Az.Datadog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Az.Datadog.md +--- + +# Az.Datadog Module +## Description +Microsoft Azure PowerShell: Datadog cmdlets + +## Az.Datadog Cmdlets +### [Get-AzDatadogMarketplaceAgreement](Get-AzDatadogMarketplaceAgreement.md) +List Datadog marketplace agreements in the subscription. + +### [Get-AzDatadogMonitor](Get-AzDatadogMonitor.md) +Get the properties of a specific monitor resource. + +### [Get-AzDatadogMonitorApiKey](Get-AzDatadogMonitorApiKey.md) +List the api keys for a given monitor resource. + +### [Get-AzDatadogMonitorDefaultKey](Get-AzDatadogMonitorDefaultKey.md) +Get the default api key. + +### [Get-AzDatadogMonitorHost](Get-AzDatadogMonitorHost.md) +List the hosts for a given monitor resource. + +### [Get-AzDatadogMonitorLinkedResource](Get-AzDatadogMonitorLinkedResource.md) +List all Azure resources associated to the same Datadog organization as the target resource. + +### [Get-AzDatadogMonitorMonitoredResource](Get-AzDatadogMonitorMonitoredResource.md) +List the resources currently being monitored by the Datadog monitor resource. + +### [Get-AzDatadogSingleSignOnConfiguration](Get-AzDatadogSingleSignOnConfiguration.md) +Gets the datadog single sign-on resource for the given Monitor. + +### [Get-AzDatadogTagRule](Get-AzDatadogTagRule.md) +Get a tag rule set for a given monitor resource. + +### [New-AzDatadogFilteringTagObject](New-AzDatadogFilteringTagObject.md) +Create a in-memory object for FilteringTag + +### [New-AzDatadogMarketplaceAgreement](New-AzDatadogMarketplaceAgreement.md) +Create Datadog marketplace agreement in the subscription. + +### [New-AzDatadogMonitor](New-AzDatadogMonitor.md) +Create a monitor resource. + +### [New-AzDatadogSingleSignOnConfiguration](New-AzDatadogSingleSignOnConfiguration.md) +Configures single-sign-on for this resource. + +### [New-AzDatadogTagRule](New-AzDatadogTagRule.md) +Create or update a tag rule set for a given monitor resource. + +### [Remove-AzDatadogMonitor](Remove-AzDatadogMonitor.md) +Delete a monitor resource. + +### [Set-AzDatadogMonitorDefaultKey](Set-AzDatadogMonitorDefaultKey.md) +Set the default api key. + +### [Update-AzDatadogMonitor](Update-AzDatadogMonitor.md) +Update a monitor resource. + +### [Update-AzDatadogMonitorSetPasswordLink](Update-AzDatadogMonitorSetPasswordLink.md) +Refresh the set password link and return a latest one. + diff --git a/azps-10.1.0/Az.Datadog/Get-AzDatadogMarketplaceAgreement.md b/azps-10.1.0/Az.Datadog/Get-AzDatadogMarketplaceAgreement.md new file mode 100644 index 0000000000..7afed04de4 --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Get-AzDatadogMarketplaceAgreement.md @@ -0,0 +1,87 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/get-azdatadogmarketplaceagreement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMarketplaceAgreement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMarketplaceAgreement.md +--- + +# Get-AzDatadogMarketplaceAgreement + +## SYNOPSIS +List Datadog marketplace agreements in the subscription. + +## SYNTAX + +``` +Get-AzDatadogMarketplaceAgreement [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +List Datadog marketplace agreements in the subscription. + +## EXAMPLES + +### Example 1: List Datadog marketplace agreements in the subscription +```powershell +Get-AzDatadogMarketplaceAgreement +``` + +```output +Name Type +---- ---- +marketplace Microsoft.Datadog/agreements +Datadog Microsoft.Datadog/agreements +``` + +This command lists Datadog marketplace agreements in the subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IDatadogAgreementResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitor.md b/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitor.md new file mode 100644 index 0000000000..4fe8e286fc --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitor.md @@ -0,0 +1,204 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/get-azdatadogmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMonitor.md +--- + +# Get-AzDatadogMonitor + +## SYNOPSIS +Get the properties of a specific monitor resource. + +## SYNTAX + +### List (Default) +``` +Get-AzDatadogMonitor [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDatadogMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDatadogMonitor -InputObject <IDatadogIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzDatadogMonitor -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the properties of a specific monitor resource. + +## EXAMPLES + +### Example 1: List all monitor resources under a subscription +```powershell +Get-AzDatadogMonitor +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap Datadog microsoft.Datadog/monitors +``` + +This command lists all monitor resources under a subscription. + +### Example 2: List monitor resources under a resource group +```powershell +Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap Datadog microsoft.Datadog/monitors +``` + +This command lists all monitor resources under a resource group. + +### Example 3: Get the properties of a specific monitor resource +```powershell +Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap Datadog microsoft.Datadog/monitors +``` + +This command gets the properties of a specific monitor resource. + +### Example 4: Get the properties of a specific monitor resource by pipeline +```powershell +Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog | Get-AzDatadogMonitor +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap Datadog microsoft.Datadog/monitors +``` + +This command gets the properties of a specific monitor resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IDatadogMonitorResource + +## 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 `<IDatadogIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Configuration name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Rule set name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorApiKey.md b/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorApiKey.md new file mode 100644 index 0000000000..28ff812344 --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorApiKey.md @@ -0,0 +1,148 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/get-azdatadogmonitorapikey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMonitorApiKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMonitorApiKey.md +--- + +# Get-AzDatadogMonitorApiKey + +## SYNOPSIS +List the api keys for a given monitor resource. + +## SYNTAX + +``` +Get-AzDatadogMonitorApiKey -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List the api keys for a given monitor resource. + +## EXAMPLES + +### Example 1: List the api keys for a given monitor resource +```powershell +Get-AzDatadogMonitorApiKey -ResourceGroupName azure-rg-Datadog -Name Datadog +``` + +```output +Created CreatedBy Key Name +------- --------- --- ---- +2021-05-24 07:25:35 user@microsoft.com xxxxxxxxxxxx Azure Admin User API Key +``` + +This command lists the api keys for a given monitor resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IDatadogApiKey + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorDefaultKey.md b/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorDefaultKey.md new file mode 100644 index 0000000000..b6a47fcc3f --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorDefaultKey.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/get-azdatadogmonitordefaultkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMonitorDefaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMonitorDefaultKey.md +--- + +# Get-AzDatadogMonitorDefaultKey + +## SYNOPSIS +Get the default api key. + +## SYNTAX + +### Get (Default) +``` +Get-AzDatadogMonitorDefaultKey -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDatadogMonitorDefaultKey -InputObject <IDatadogIdentity> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Get the default api key. + +## EXAMPLES + +### Example 1: Get the default api key +```powershell +Get-AzDatadogMonitorDefaultKey -ResourceGroupName azure-rg-Datadog -Name Datadog +``` + +```output +Created CreatedBy Key Name +------- --------- --- ---- + xxxxxxxxxxxxx +``` + +This command gets the default api key. + +### Example 2: Get the default api key by pipeline +```powershell +Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog | Get-AzDatadogMonitorDefaultKey +``` + +```output +Created CreatedBy Key Name +------- --------- --- ---- + xxxxxxxxxxxxx +``` + +This command gets the default api key by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IDatadogApiKey + +## 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 `<IDatadogIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Configuration name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Rule set name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorHost.md b/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorHost.md new file mode 100644 index 0000000000..80ed3d889e --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorHost.md @@ -0,0 +1,142 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/get-azdatadogmonitorhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMonitorHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMonitorHost.md +--- + +# Get-AzDatadogMonitorHost + +## SYNOPSIS +List the hosts for a given monitor resource. + +## SYNTAX + +``` +Get-AzDatadogMonitorHost -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List the hosts for a given monitor resource. + +## EXAMPLES + +### Example 1: List the hosts for a given monitor resource +```powershell +Get-AzDatadogMonitorHost -ResourceGroupName azure-rg-Datadog -Name Datadog +``` + +This command lists the hosts for a given monitor resource + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IDatadogHost + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorLinkedResource.md b/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorLinkedResource.md new file mode 100644 index 0000000000..efd9661e23 --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorLinkedResource.md @@ -0,0 +1,156 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/get-azdatadogmonitorlinkedresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMonitorLinkedResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMonitorLinkedResource.md +--- + +# Get-AzDatadogMonitorLinkedResource + +## SYNOPSIS +List all Azure resources associated to the same Datadog organization as the target resource. + +## SYNTAX + +``` +Get-AzDatadogMonitorLinkedResource -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List all Azure resources associated to the same Datadog organization as the target resource. + +## EXAMPLES + +### Example 1: List all Azure resources associated to the same Datadog organization as the target resource +```powershell +Get-AzDatadogMonitorLinkedResource -ResourceGroupName azure-rg-Datadog -Name lucasDatadog +``` + +```output +Id +-- +/SUBSCRIPTIONS/xxxxxxxxxxxxxx-xxxxxxx-xxxxxx/RESOURCEGROUPS/EUAP-ACR-01266F2538192A/PROVIDERS/MICROSOFT.Datadog/MONITORS/LIFTR-ACR-0126693370263 +/SUBSCRIPTIONS/xxxxxxxxxxxxxx-xxxxxxx-xxxxxx/RESOURCEGROUPS/PROD-SUB-01278F01924690/PROVIDERS/MICROSOFT.Datadog/MONITORS/SUB01273EE24900C6832 +/SUBSCRIPTIONS/xxxxxxxxxxxxxx-xxxxxxx-xxxxxx/RESOURCEGROUPS/CREATE-SSO-E4E2467832A/PROVIDERS/MICROSOFT.Datadog/MONITORS/LIFTR-CREATE-SSO-53326702 +/SUBSCRIPTIONS/xxxxxxxxxxxxxx-xxxxxxx-xxxxxx/RESOURCEGROUPS/PROD-MUL-ACR-01277F790629/PROVIDERS/MICROSOFT.Datadog/MONITORS/LIFTR-ACR1-A3C8604150D +/SUBSCRIPTIONS/xxxxxxxxxxxxxx-xxxxxxx-xxxxxx/RESOURCEGROUPS/CREATE-68A6706056D95/PROVIDERS/MICROSOFT.Datadog/MONITORS/LIFTR-CREATE-2E312735B8 +/SUBSCRIPTIONS/xxxxxxxxxxxxxx-xxxxxxx-xxxxxx/RESOURCEGROUPS/PROD-MUL-ACR-01279F943670/PROVIDERS/MICROSOFT.Datadog/MONITORS/LIFTR-ACR2-D46323262B4 +/SUBSCRIPTIONS/xxxxxxxxxxxxxx-xxxxxxx-xxxxxx/RESOURCEGROUPS/CREATE-8288834488516/PROVIDERS/MICROSOFT.Datadog/MONITORS/LIFTR-CREATE-C7585255D1 +/SUBSCRIPTIONS/xxxxxxxxxxxxxx-xxxxxxx-xxxxxx/RESOURCEGROUPS/CREATE-SSO-6E6618601FF/PROVIDERS/MICROSOFT.Datadog/MONITORS/LIFTR-CREATE-SSO-C5065109 +/SUBSCRIPTIONS/xxxxxxxxxxxxxx-xxxxxxx-xxxxxx/RESOURCEGROUPS/PROD-MUL-ACR-012774705865/PROVIDERS/MICROSOFT.Datadog/MONITORS/LIFTR-ACR2-E2560749186 +``` + +This command lists all Azure resources associated to the same Datadog organization as the target resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.ILinkedResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorMonitoredResource.md b/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorMonitoredResource.md new file mode 100644 index 0000000000..b266500bb4 --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Get-AzDatadogMonitorMonitoredResource.md @@ -0,0 +1,142 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/get-azdatadogmonitormonitoredresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMonitorMonitoredResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogMonitorMonitoredResource.md +--- + +# Get-AzDatadogMonitorMonitoredResource + +## SYNOPSIS +List the resources currently being monitored by the Datadog monitor resource. + +## SYNTAX + +``` +Get-AzDatadogMonitorMonitoredResource -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List the resources currently being monitored by the Datadog monitor resource. + +## EXAMPLES + +### Example 1: List the resources currently being monitored by the Datadog monitor resource +```powershell +Get-AzDatadogMonitorMonitoredResource -ResourceGroupName azure-rg-Datadog -Name Datadog +``` + +This command lists the resources currently being monitored by the Datadog monitor resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IMonitoredResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/Get-AzDatadogSingleSignOnConfiguration.md b/azps-10.1.0/Az.Datadog/Get-AzDatadogSingleSignOnConfiguration.md new file mode 100644 index 0000000000..e85a212d54 --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Get-AzDatadogSingleSignOnConfiguration.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/get-azdatadogsinglesignonconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogSingleSignOnConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogSingleSignOnConfiguration.md +--- + +# Get-AzDatadogSingleSignOnConfiguration + +## SYNOPSIS +Gets the datadog single sign-on resource for the given Monitor. + +## SYNTAX + +### List (Default) +``` +Get-AzDatadogSingleSignOnConfiguration -MonitorName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDatadogSingleSignOnConfiguration -MonitorName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDatadogSingleSignOnConfiguration -InputObject <IDatadogIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the datadog single sign-on resource for the given Monitor. + +## EXAMPLES + +### Example 1: List the Datadog single sign-on resource for the given Monitor +```powershell +Get-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog +``` + +```output +Name Type +---- ---- +default microsoft.Datadog/monitors/singlesignonconfigurations +``` + +This command lists the Datadog single sign-on resource for the given Monitor. + +### Example 2: Gets the Datadog single sign-on resource for the given Monitor +```powershell +Get-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' +``` + +```output +Name Type +---- ---- +default microsoft.Datadog/monitors/singlesignonconfigurations +``` + +This command gets the Datadog single sign-on resource for the given Monitor. + +### Example 3: Gets the Datadog single sign-on resource for the given Monitor by pipeline +```powershell +New-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' -SingleSignOnState Enable -EnterpriseAppId 00000000-0000-0000-0000-000000000000 | Get-AzDatadogSingleSignOnConfiguration +``` + +```output +Name Type +---- ---- +default microsoft.Datadog/monitors/singlesignonconfigurations +``` + +This command gets the Datadog single sign-on resource for the given Monitor by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Configuration name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IDatadogSingleSignOnResource + +## 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 `<IDatadogIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Configuration name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Rule set name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/Get-AzDatadogTagRule.md b/azps-10.1.0/Az.Datadog/Get-AzDatadogTagRule.md new file mode 100644 index 0000000000..19aa92f276 --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Get-AzDatadogTagRule.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/get-azdatadogtagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Get-AzDatadogTagRule.md +--- + +# Get-AzDatadogTagRule + +## SYNOPSIS +Get a tag rule set for a given monitor resource. + +## SYNTAX + +### List (Default) +``` +Get-AzDatadogTagRule -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDatadogTagRule -MonitorName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDatadogTagRule -InputObject <IDatadogIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a tag rule set for a given monitor resource. + +## EXAMPLES + +### Example 1: List all tag rules set for a given monitor resource +```powershell +Get-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog +``` + +```output +Name Type +---- ---- +default microsoft.Datadog/monitors/tagrules +``` + +This command lists all tag rules set for a given monitor resource. + +### Example 2: Get a tag rule set for a given monitor resource +```powershell +Get-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' +``` + +```output +Name Type +---- ---- +default microsoft.Datadog/monitors/tagrules +``` + +This command gets a tag rule set for a given monitor resource. + +### Example 3: Get a tag rule set for a given monitor resource by pipeline +```powershell +Get-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' | Get-AzDatadogTagRule +``` + +```output +Name Type +---- ---- +default microsoft.Datadog/monitors/tagrules +``` + +This command gets a tag rule set for a given monitor resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Rule set name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IMonitoringTagRules + +## 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 `<IDatadogIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Configuration name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Rule set name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/New-AzDatadogFilteringTagObject.md b/azps-10.1.0/Az.Datadog/New-AzDatadogFilteringTagObject.md new file mode 100644 index 0000000000..fe3d75b29f --- /dev/null +++ b/azps-10.1.0/Az.Datadog/New-AzDatadogFilteringTagObject.md @@ -0,0 +1,95 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.Datadog/new-AzDatadogFilteringTagObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/New-AzDatadogFilteringTagObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/New-AzDatadogFilteringTagObject.md +--- + +# New-AzDatadogFilteringTagObject + +## SYNOPSIS +Create a in-memory object for FilteringTag + +## SYNTAX + +``` +New-AzDatadogFilteringTagObject [-Action <TagAction>] [-Name <String>] [-Value <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for FilteringTag + +## EXAMPLES + +### Example 1: Create a in-memory object for FilteringTag +```powershell +New-AzDatadogFilteringTagObject -Action "Include" -Value "Prod" -Name "Environment" +``` + +This command Create a in-memory object for FilteringTag. + +## PARAMETERS + +### -Action +Valid actions for a filtering tag. +Exclusion takes priority over inclusion. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Support.TagAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name (also known as the key) of the tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The value of the tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.FilteringTag + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/New-AzDatadogMarketplaceAgreement.md b/azps-10.1.0/Az.Datadog/New-AzDatadogMarketplaceAgreement.md new file mode 100644 index 0000000000..f784bcbbe9 --- /dev/null +++ b/azps-10.1.0/Az.Datadog/New-AzDatadogMarketplaceAgreement.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/new-azdatadogmarketplaceagreement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/New-AzDatadogMarketplaceAgreement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/New-AzDatadogMarketplaceAgreement.md +--- + +# New-AzDatadogMarketplaceAgreement + +## SYNOPSIS +Create Datadog marketplace agreement in the subscription. + +## SYNTAX + +``` +New-AzDatadogMarketplaceAgreement [-SubscriptionId <String>] [-Accepted] [-LicenseTextLink <String>] + [-Plan <String>] [-PrivacyPolicyLink <String>] [-Product <String>] [-Publisher <String>] + [-RetrieveDatetime <DateTime>] [-Signature <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create Datadog marketplace agreement in the subscription. + +## EXAMPLES + +### Example 1: Create Datadog marketplace agreement in the subscription +```powershell +New-AzDatadogMarketplaceAgreement -Accepted +``` + +```output +Name Type +---- ---- +default microsoft.Datadog/agreements +``` + +This command creates Datadog marketplace agreement in the subscription. + +## PARAMETERS + +### -Accepted +If any version of the terms have been accepted, otherwise false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseTextLink +Link to HTML with Microsoft and Publisher terms. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Plan +Plan identifier string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyPolicyLink +Link to the privacy policy of the publisher. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Product +Product identifier string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Publisher +Publisher identifier string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetrieveDatetime +Date and time in UTC of when the terms were accepted. +This is empty if Accepted is false. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Signature +Terms signature. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IDatadogAgreementResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/New-AzDatadogMonitor.md b/azps-10.1.0/Az.Datadog/New-AzDatadogMonitor.md new file mode 100644 index 0000000000..6fc005c40f --- /dev/null +++ b/azps-10.1.0/Az.Datadog/New-AzDatadogMonitor.md @@ -0,0 +1,393 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/new-azdatadogmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/New-AzDatadogMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/New-AzDatadogMonitor.md +--- + +# New-AzDatadogMonitor + +## SYNOPSIS +Create a monitor resource. + +## SYNTAX + +``` +New-AzDatadogMonitor -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-IdentityType <ManagedIdentityTypes>] [-MonitoringStatus <MonitoringStatus>] [-OrganizationApiKey <String>] + [-OrganizationApplicationKey <String>] [-OrganizationEnterpriseAppId <String>] + [-OrganizationLinkingAuthCode <String>] [-OrganizationLinkingClientId <String>] + [-OrganizationRedirectUri <String>] [-SkuName <String>] [-Tag <Hashtable>] [-UserInfoEmailAddress <String>] + [-UserInfoName <String>] [-UserInfoPhoneNumber <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a monitor resource. + +## EXAMPLES + +### Example 1: Create a monitor resource +```powershell +New-AzDatadogMonitor -ResourceGroupName azure-rg-test -Name Datadog-pwsh01 -SkuName 'drawdown_testing_20200904_Monthly' -Location 'eastus2euap' -UserInfoEmailAddress 'xxxx@microsoft.com' -UserInfoName 'user' -UserInfoPhoneNumber 'xxxxxxxxxxxx' -IdentityType SystemAssigned +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap Datadog-pwsh01 microsoft.Datadog/monitors +``` + +This command creates a monitor resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Identity type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Support.ManagedIdentityTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoringStatus +Flag specifying if the resource monitoring is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Support.MonitoringStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationApiKey +Api key associated to the Datadog organization. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationApplicationKey +Application key associated to the Datadog organization. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationEnterpriseAppId +The Id of the Enterprise App used for Single sign on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationLinkingAuthCode +The auth code used to linking to an existing datadog organization. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationLinkingClientId +The client_id from an existing in exchange for an auth token to link organization. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationRedirectUri +The redirect uri for linking. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Dictionary of \<string\> + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoEmailAddress +Email of the user used by Datadog for contacting them if needed + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoName +Name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoPhoneNumber +Phone number of the user used by Datadog for contacting them if needed + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IDatadogMonitorResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/New-AzDatadogSingleSignOnConfiguration.md b/azps-10.1.0/Az.Datadog/New-AzDatadogSingleSignOnConfiguration.md new file mode 100644 index 0000000000..6e355b5f14 --- /dev/null +++ b/azps-10.1.0/Az.Datadog/New-AzDatadogSingleSignOnConfiguration.md @@ -0,0 +1,276 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/new-azdatadogsinglesignonconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/New-AzDatadogSingleSignOnConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/New-AzDatadogSingleSignOnConfiguration.md +--- + +# New-AzDatadogSingleSignOnConfiguration + +## SYNOPSIS +Configures single-sign-on for this resource. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzDatadogSingleSignOnConfiguration -MonitorName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-EnterpriseAppId <String>] [-SingleSignOnState <SingleSignOnStates>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzDatadogSingleSignOnConfiguration -InputObject <IDatadogIdentity> [-EnterpriseAppId <String>] + [-SingleSignOnState <SingleSignOnStates>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Configures single-sign-on for this resource. + +## EXAMPLES + +### Example 1: Configures single-sign-on for Data monitor resource +```powershell +New-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' -SingleSignOnState Enable -EnterpriseAppId 00000000-0000-0000-0000-000000000000 +``` + +```output +Name Type +---- ---- +default microsoft.Datadog/monitors/singlesignonconfigurations +``` + +This command configures single-sign-on for Data monitor resource. + +### Example 2: Configures single-sign-on for Data monitor resource by pipeline +```powershell +Get-AzDatadogSingleSignOnConfiguration -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' | New-AzDatadogSingleSignOnConfiguration -SingleSignOnState Disable -EnterpriseAppId 00000000-0000-0000-0000-000000000000 +``` + +```output +Name Type +---- ---- +default microsoft.Datadog/monitors/singlesignonconfigurations +``` + +This command configures single-sign-on for Data monitor resource by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnterpriseAppId +The Id of the Enterprise App used for Single sign-on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Configuration name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnState +Various states of the SSO resource + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Support.SingleSignOnStates +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. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IDatadogSingleSignOnResource + +## 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 `<IDatadogIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Configuration name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Rule set name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/New-AzDatadogTagRule.md b/azps-10.1.0/Az.Datadog/New-AzDatadogTagRule.md new file mode 100644 index 0000000000..c1434d3306 --- /dev/null +++ b/azps-10.1.0/Az.Datadog/New-AzDatadogTagRule.md @@ -0,0 +1,318 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/new-azdatadogtagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/New-AzDatadogTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/New-AzDatadogTagRule.md +--- + +# New-AzDatadogTagRule + +## SYNOPSIS +Create or update a tag rule set for a given monitor resource. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzDatadogTagRule -MonitorName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-LogRuleFilteringTag <IFilteringTag[]>] [-LogRuleSendAadLog] + [-LogRuleSendResourceLog] [-LogRuleSendSubscriptionLog] [-MetricRuleFilteringTag <IFilteringTag[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzDatadogTagRule -InputObject <IDatadogIdentity> [-LogRuleFilteringTag <IFilteringTag[]>] + [-LogRuleSendAadLog] [-LogRuleSendResourceLog] [-LogRuleSendSubscriptionLog] + [-MetricRuleFilteringTag <IFilteringTag[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a tag rule set for a given monitor resource. + +## EXAMPLES + +### Example 1: Create or update a tag rule set for a given monitor resource +```powershell +$ftobjArray = @() +$ftobjArray += New-AzDatadogFilteringTagObject -Action "Include" -Value "Prod" -Name "Environment" +$ftobjArray += New-AzDatadogFilteringTagObject -Action "Exclude" -Value "Dev" -Name "Environment" +New-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'test' -LogRuleFilteringTag $ftobjArray +``` + +```output +Name Type +---- ---- +default microsoft.Datadog/monitors/tagrules +``` + +This command creates or updates a tag rule set for a given monitor resource. + +### Example 2: Create or update a tag rule set for a given monitor resource by pipeline +```powershell +$ftobjArray = @() +$ftobjArray += New-AzDatadogFilteringTagObject -Action "Include" -Value "Prod" -Name "Environment" +$ftobjArray += New-AzDatadogFilteringTagObject -Action "Exclude" -Value "Dev" -Name "Environment" +Get-AzDatadogTagRule -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Name 'default' | New-AzDatadogTagRule -LogRuleFilteringTag $ftobjArray +``` + +```output +Name Type +---- ---- +default microsoft.Datadog/monitors/tagrules +``` + +This command creates or updates a tag rule set for a given monitor resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LogRuleFilteringTag +List of filtering tags to be used for capturing logs. +This only takes effect if SendResourceLogs flag is enabled. +If empty, all resources will be captured. +If only Exclude action is specified, the rules will apply to the list of all available resources. +If Include actions are specified, the rules will only include resources with the associated tags. +To construct, see NOTES section for LOGRULEFILTERINGTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IFilteringTag[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendAadLog +Flag specifying if AAD logs should be sent for the Monitor resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendResourceLog +Flag specifying if Azure resource logs should be sent for the Monitor resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendSubscriptionLog +Flag specifying if Azure subscription logs should be sent for the Monitor resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricRuleFilteringTag +List of filtering tags to be used for capturing metrics. +If empty, all resources will be captured. +If only Exclude action is specified, the rules will apply to the list of all available resources. +If Include actions are specified, the rules will only include resources with the associated tags. +To construct, see NOTES section for METRICRULEFILTERINGTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IFilteringTag[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Rule set name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IMonitoringTagRules + +## 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 `<IDatadogIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Configuration name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Rule set name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +LOGRULEFILTERINGTAG <IFilteringTag[]>: List of filtering tags to be used for capturing logs. This only takes effect if SendResourceLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. + - `[Action <TagAction?>]`: Valid actions for a filtering tag. Exclusion takes priority over inclusion. + - `[Name <String>]`: The name (also known as the key) of the tag. + - `[Value <String>]`: The value of the tag. + +METRICRULEFILTERINGTAG <IFilteringTag[]>: List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. + - `[Action <TagAction?>]`: Valid actions for a filtering tag. Exclusion takes priority over inclusion. + - `[Name <String>]`: The name (also known as the key) of the tag. + - `[Value <String>]`: The value of the tag. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/Remove-AzDatadogMonitor.md b/azps-10.1.0/Az.Datadog/Remove-AzDatadogMonitor.md new file mode 100644 index 0000000000..6c361c3734 --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Remove-AzDatadogMonitor.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/remove-azdatadogmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Remove-AzDatadogMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Remove-AzDatadogMonitor.md +--- + +# Remove-AzDatadogMonitor + +## SYNOPSIS +Delete a monitor resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDatadogMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDatadogMonitor -InputObject <IDatadogIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a monitor resource. + +## EXAMPLES + +### Example 1: Delete a monitor resource +```powershell +Remove-AzDatadogMonitor -ResourceGroupName azure-rg-test -Name Datadog-portal03 +``` + +This command deletes a monitor resource. + +### Example 2: Delete a monitor resource by pipeline +```powershell +Get-AzDatadogMonitor -ResourceGroupName azure-rg-test -Name Datadog-portal02 | Remove-AzDatadogMonitor +``` + +This command deletes a monitor resource by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IDatadogIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Configuration name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Rule set name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/Set-AzDatadogMonitorDefaultKey.md b/azps-10.1.0/Az.Datadog/Set-AzDatadogMonitorDefaultKey.md new file mode 100644 index 0000000000..f8973e0c32 --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Set-AzDatadogMonitorDefaultKey.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/set-azdatadogmonitordefaultkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Set-AzDatadogMonitorDefaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Set-AzDatadogMonitorDefaultKey.md +--- + +# Set-AzDatadogMonitorDefaultKey + +## SYNOPSIS +Set the default api key. + +## SYNTAX + +``` +Set-AzDatadogMonitorDefaultKey -MonitorName <String> -ResourceGroupName <String> -Key <String> + [-SubscriptionId <String>] [-CreatedAt <String>] [-CreatedBy <String>] [-Name <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Set the default api key. + +## EXAMPLES + +### Example 1: Set the default api key for monitor resource +```powershell +Set-AzDatadogMonitorDefaultKey -ResourceGroupName azure-rg-Datadog -MonitorName Datadog -Key 'xxxxxxxxxxxxxxxxxxxxxx' +``` + +```output +Created CreatedBy Key Name +------- --------- --- ---- + xxxxxxxxxxxxxxxxxxxxxx +``` + +This command sets the default api key for monitor resource. + +## PARAMETERS + +### -CreatedAt +The time of creation of the API key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreatedBy +The user that created the API key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Key +The value of the API key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the API key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/Update-AzDatadogMonitor.md b/azps-10.1.0/Az.Datadog/Update-AzDatadogMonitor.md new file mode 100644 index 0000000000..c17b006aa7 --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Update-AzDatadogMonitor.md @@ -0,0 +1,276 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/update-azdatadogmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Update-AzDatadogMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Update-AzDatadogMonitor.md +--- + +# Update-AzDatadogMonitor + +## SYNOPSIS +Update a monitor resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDatadogMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-MonitoringStatus <MonitoringStatus>] [-SkuName <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDatadogMonitor -InputObject <IDatadogIdentity> [-MonitoringStatus <MonitoringStatus>] + [-SkuName <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Update a monitor resource. + +## EXAMPLES + +### Example 1: Update a monitor resource +```powershell +Update-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog -Tag @{'key1'='value1'; 'key2'='value2'} +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap Datadog microsoft.Datadog/monitors +``` + +This command updates a monitor resource. + +### Example 2: Update a monitor resource by pipeline +```powershell +Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog | Update-AzDatadogMonitor -Tag @{'key1'='value1'; 'key2'='value2'} +``` + +```output +Location Name Type +-------- ---- ---- +eastus2euap Datadog microsoft.Datadog/monitors +``` + +This command updates a monitor resource by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitoringStatus +Flag specifying if the resource monitoring is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Support.MonitoringStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The new tags of the monitor resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.Api20210301.IDatadogMonitorResource + +## 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 `<IDatadogIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Configuration name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Rule set name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Datadog/Update-AzDatadogMonitorSetPasswordLink.md b/azps-10.1.0/Az.Datadog/Update-AzDatadogMonitorSetPasswordLink.md new file mode 100644 index 0000000000..a0a175421d --- /dev/null +++ b/azps-10.1.0/Az.Datadog/Update-AzDatadogMonitorSetPasswordLink.md @@ -0,0 +1,195 @@ +--- +external help file: +Module Name: Az.Datadog +online version: https://learn.microsoft.com/powershell/module/az.datadog/update-azdatadogmonitorsetpasswordlink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Update-AzDatadogMonitorSetPasswordLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Datadog/help/Update-AzDatadogMonitorSetPasswordLink.md +--- + +# Update-AzDatadogMonitorSetPasswordLink + +## SYNOPSIS +Refresh the set password link and return a latest one. + +## SYNTAX + +### Refresh (Default) +``` +Update-AzDatadogMonitorSetPasswordLink -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RefreshViaIdentity +``` +Update-AzDatadogMonitorSetPasswordLink -InputObject <IDatadogIdentity> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Refresh the set password link and return a latest one. + +## EXAMPLES + +### Example 1: Refresh the set password link and return a latest one +```powershell +Update-AzDatadogMonitorSetPasswordLink -ResourceGroupName azure-rg-Datadog -Name Datadog +``` + +```output +https://us3.Datadoghq.com/account/reset_password/xxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +This command refresh the set password link and return a latest one. + +### Example 2: Refresh the set password link and return a latest one by pipeline +```powershell +Get-AzDatadogMonitor -ResourceGroupName azure-rg-Datadog -Name Datadog | Update-AzDatadogMonitorSetPasswordLink +``` + +```output +https://us3.Datadoghq.com/account/reset_password/xxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +This command refresh the set password link and return a latest one by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity +Parameter Sets: RefreshViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Refresh +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Datadog.Models.IDatadogIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IDatadogIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Configuration name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Rule set name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DedicatedHsm/Az.DedicatedHsm.md b/azps-10.1.0/Az.DedicatedHsm/Az.DedicatedHsm.md new file mode 100644 index 0000000000..83a3e2fd10 --- /dev/null +++ b/azps-10.1.0/Az.DedicatedHsm/Az.DedicatedHsm.md @@ -0,0 +1,31 @@ +--- +Module Name: Az.DedicatedHsm +Module Guid: 841c2fad-e8c0-4924-b9b9-9d27d0f40b48 +Download Help Link: https://learn.microsoft.com/powershell/module/az.dedicatedhsm +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DedicatedHsm/help/Az.DedicatedHsm.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DedicatedHsm/help/Az.DedicatedHsm.md +--- + +# Az.DedicatedHsm Module +## Description +Microsoft Azure PowerShell: DedicatedHsm cmdlets + +## Az.DedicatedHsm Cmdlets +### [Get-AzDedicatedHsm](Get-AzDedicatedHsm.md) +Gets the specified Azure dedicated HSM. + +### [Get-AzDedicatedHsmOutboundNetworkDependencyEndpoint](Get-AzDedicatedHsmOutboundNetworkDependencyEndpoint.md) +Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource. +The operation returns properties of each egress endpoint. + +### [New-AzDedicatedHsm](New-AzDedicatedHsm.md) +Create or Update a dedicated HSM in the specified subscription. + +### [Remove-AzDedicatedHsm](Remove-AzDedicatedHsm.md) +Deletes the specified Azure Dedicated HSM. + +### [Update-AzDedicatedHsm](Update-AzDedicatedHsm.md) +Update a dedicated HSM in the specified subscription. + diff --git a/azps-10.1.0/Az.DedicatedHsm/Get-AzDedicatedHsm.md b/azps-10.1.0/Az.DedicatedHsm/Get-AzDedicatedHsm.md new file mode 100644 index 0000000000..580f6371ac --- /dev/null +++ b/azps-10.1.0/Az.DedicatedHsm/Get-AzDedicatedHsm.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: Az.DedicatedHsm +online version: https://learn.microsoft.com/powershell/module/az.dedicatedhsm/get-azdedicatedhsm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DedicatedHsm/help/Get-AzDedicatedHsm.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DedicatedHsm/help/Get-AzDedicatedHsm.md +--- + +# Get-AzDedicatedHsm + +## SYNOPSIS +Gets the specified Azure dedicated HSM. + +## SYNTAX + +### List1 (Default) +``` +Get-AzDedicatedHsm [-SubscriptionId <String[]>] [-Top <Int32>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzDedicatedHsm -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDedicatedHsm -InputObject <IDedicatedHsmIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzDedicatedHsm -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Top <Int32>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the specified Azure dedicated HSM. + +## EXAMPLES + +### Example 1: Get all Dedicated HSM under a subscription +```powershell +Get-AzDedicatedHsm +``` + +```output +Name Provisioning State SKU Location +---- ------------------ --- -------- +hsm-7t2xaf Succeeded SafeNet Luna Network HSM A790 eastus +yeminghsm Succeeded SafeNet Luna Network HSM A790 eastus +``` + +This command gets all Dedicated HSM under a subscription + +### Example 2: Get all Dedicated HSM under a resource group. +```powershell +Get-AzDedicatedHsm -ResourceGroupName dedicatedhsm-rg-n359cz +``` + +```output +Name Provisioning State SKU Location +---- ------------------ --- -------- +hsm-7t2xaf Succeeded SafeNet Luna Network HSM A790 eastus +``` + +This command gets all Dedicated HSM under a resource group. + +### Example 3: Get a Dedicated HSM by name +```powershell +Get-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName dedicatedhsm-rg-n359cz +``` + +```output +Name Provisioning State SKU Location +---- ------------------ --- -------- +hsm-7t2xaf Succeeded SafeNet Luna Network HSM A790 eastus +``` + +This command gets a Dedicated HSM by name. + +### Example 4: Get a Dedicated HSM by object +```powershell +$hsm = New-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Location eastus -Sku "SafeNet Luna Network HSM A790" -StampId stamp1 -SubnetId "/subscriptions/xxxx-xxxx-xxx-xxx/resourceGroups/dedicatedhsm-rg-n359cz/providers/Microsoft.Network/virtualNetworks/vnetq30la9/subnets/hsmsubnet" -NetworkInterface @{PrivateIPAddress = '10.2.1.120' } +Get-AzDedicatedHsm -InputObject $hsm +``` + +```output +Name Provisioning State SKU Location +---- ------------------ --- -------- +hsm-n7wfxi Succeeded SafeNet Luna Network HSM A790 eastus +``` + +This command gets a Dedicated HSM by object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DedicatedHsm.Models.IDedicatedHsmIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the dedicated HSM. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Resource Group to which the dedicated hsm belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Maximum number of results to return. + +```yaml +Type: System.Int32 +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DedicatedHsm.Models.IDedicatedHsmIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DedicatedHsm.Models.Api20211130.IDedicatedHsm + +## 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 `<IDedicatedHsmIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[Name <String>]`: Name of the dedicated Hsm + - `[ResourceGroupName <String>]`: The name of the Resource Group to which the resource belongs. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DedicatedHsm/Get-AzDedicatedHsmOutboundNetworkDependencyEndpoint.md b/azps-10.1.0/Az.DedicatedHsm/Get-AzDedicatedHsmOutboundNetworkDependencyEndpoint.md new file mode 100644 index 0000000000..7babcdab14 --- /dev/null +++ b/azps-10.1.0/Az.DedicatedHsm/Get-AzDedicatedHsmOutboundNetworkDependencyEndpoint.md @@ -0,0 +1,114 @@ +--- +external help file: +Module Name: Az.DedicatedHsm +online version: https://learn.microsoft.com/powershell/module/az.dedicatedhsm/get-azdedicatedhsmoutboundnetworkdependencyendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DedicatedHsm/help/Get-AzDedicatedHsmOutboundNetworkDependencyEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DedicatedHsm/help/Get-AzDedicatedHsmOutboundNetworkDependencyEndpoint.md +--- + +# Get-AzDedicatedHsmOutboundNetworkDependencyEndpoint + +## SYNOPSIS +Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource. +The operation returns properties of each egress endpoint. + +## SYNTAX + +``` +Get-AzDedicatedHsmOutboundNetworkDependencyEndpoint -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource. +The operation returns properties of each egress endpoint. + +## EXAMPLES + +### Example 1: Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource. +```powershell +Get-AzDedicatedHsmOutboundNetworkDependencyEndpoint -Name dedicatedHsmName01 -ResourceGroupName resourceGroup +``` + +This command gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource. +The operation returns properties of each egress endpoint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the dedicated HSM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Resource Group to which the dedicated hsm belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DedicatedHsm.Models.Api20211130.IOutboundEnvironmentEndpoint + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DedicatedHsm/New-AzDedicatedHsm.md b/azps-10.1.0/Az.DedicatedHsm/New-AzDedicatedHsm.md new file mode 100644 index 0000000000..cb1944b8eb --- /dev/null +++ b/azps-10.1.0/Az.DedicatedHsm/New-AzDedicatedHsm.md @@ -0,0 +1,332 @@ +--- +external help file: +Module Name: Az.DedicatedHsm +online version: https://learn.microsoft.com/powershell/module/az.dedicatedhsm/new-azdedicatedhsm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DedicatedHsm/help/New-AzDedicatedHsm.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DedicatedHsm/help/New-AzDedicatedHsm.md +--- + +# New-AzDedicatedHsm + +## SYNOPSIS +Create or Update a dedicated HSM in the specified subscription. + +## SYNTAX + +``` +New-AzDedicatedHsm -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-ManagementNetworkInterface <INetworkInterface[]>] [-ManagementSubnetId <String>] + [-NetworkInterface <INetworkInterface[]>] [-Sku <SkuName>] [-StampId <String>] [-SubnetId <String>] + [-Tag <Hashtable>] [-Zone <String[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or Update a dedicated HSM in the specified subscription. + +## EXAMPLES + +### Example 1: Create a Dedicated HSM into an existing virtual network +```powershell +New-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Location eastus -Sku "SafeNet Luna Network HSM A790" -StampId stamp1 -SubnetId "/subscriptions/xxxx-xxxx-xxx-xxx/resourceGroups/dedicatedhsm-rg-n359cz/providers/Microsoft.Network/virtualNetworks/vnetq30la9/subnets/hsmsubnet" -NetworkInterface @{PrivateIPAddress = '10.2.1.120' } +``` + +```output +Name Provisioning State SKU Location +---- ------------------ --- -------- +hsm-n7wfxi Succeeded SafeNet Luna Network HSM A790 eastus +``` + +This command creates a Dedicated HSM into an existing virtual network. + +**NOTE:** Currently `New-AzDedicatedHsm` has a limitation that it returns before the HSM is fully provisioned on Azure. +Therefore after creating a new HSM, please query its state by `Get-AzDedicatedHsm` and make sure its `Provisioning State` is `Succeeded` before using it. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The supported Azure location where the dedicated HSM should be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementNetworkInterface +Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. +To construct, see NOTES section for MANAGEMENTNETWORKINTERFACE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DedicatedHsm.Models.Api20211130.INetworkInterface[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementSubnetId +The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the dedicated Hsm + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterface +Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. +To construct, see NOTES section for NETWORKINTERFACE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DedicatedHsm.Models.Api20211130.INetworkInterface[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Resource Group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +SKU of the dedicated HSM + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DedicatedHsm.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StampId +This field will be used when RP does not support Availability zones. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +The Dedicated Hsm zones. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DedicatedHsm.Models.Api20211130.IDedicatedHsm + +## 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. + + +MANAGEMENTNETWORKINTERFACE <INetworkInterface[]>: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. + - `[PrivateIPAddress <String>]`: Private Ip address of the interface + +NETWORKINTERFACE <INetworkInterface[]>: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. + - `[PrivateIPAddress <String>]`: Private Ip address of the interface + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DedicatedHsm/Remove-AzDedicatedHsm.md b/azps-10.1.0/Az.DedicatedHsm/Remove-AzDedicatedHsm.md new file mode 100644 index 0000000000..487756f71f --- /dev/null +++ b/azps-10.1.0/Az.DedicatedHsm/Remove-AzDedicatedHsm.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.DedicatedHsm +online version: https://learn.microsoft.com/powershell/module/az.dedicatedhsm/remove-azdedicatedhsm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DedicatedHsm/help/Remove-AzDedicatedHsm.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DedicatedHsm/help/Remove-AzDedicatedHsm.md +--- + +# Remove-AzDedicatedHsm + +## SYNOPSIS +Deletes the specified Azure Dedicated HSM. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDedicatedHsm -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDedicatedHsm -InputObject <IDedicatedHsmIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified Azure Dedicated HSM. + +## EXAMPLES + +### Example 1: Remove a Dedicated HSM by name +```powershell +Remove-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName lucas-manual-test +``` + +This commnad removes a hardware security module(HSM) by name. + +### Example 2: Remove a Dedicated HSM by object +```powershell +$hsm = Get-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName dedicatedhsm-rg-n359cz +Remove-AzDedicatedHsm -InputObject $hsm +``` + +This commnad removes a Dedicated HSM by object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DedicatedHsm.Models.IDedicatedHsmIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the dedicated HSM to delete + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Resource Group to which the dedicated HSM belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DedicatedHsm.Models.IDedicatedHsmIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IDedicatedHsmIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[Name <String>]`: Name of the dedicated Hsm + - `[ResourceGroupName <String>]`: The name of the Resource Group to which the resource belongs. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DedicatedHsm/Update-AzDedicatedHsm.md b/azps-10.1.0/Az.DedicatedHsm/Update-AzDedicatedHsm.md new file mode 100644 index 0000000000..842184339e --- /dev/null +++ b/azps-10.1.0/Az.DedicatedHsm/Update-AzDedicatedHsm.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.DedicatedHsm +online version: https://learn.microsoft.com/powershell/module/az.dedicatedhsm/update-azdedicatedhsm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DedicatedHsm/help/Update-AzDedicatedHsm.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DedicatedHsm/help/Update-AzDedicatedHsm.md +--- + +# Update-AzDedicatedHsm + +## SYNOPSIS +Update a dedicated HSM in the specified subscription. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDedicatedHsm -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDedicatedHsm -InputObject <IDedicatedHsmIdentity> [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a dedicated HSM in the specified subscription. + +## EXAMPLES + +### Example 1: Update the parameter tag of the Dedicated HSM by name +```powershell +Update-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Tag @{'key1' = '1'; 'key2' = 2; 'key3' = 3} +``` + +```output +Name Provisioning State SKU Location +---- ------------------ --- -------- +hsm-n7wfxi Succeeded SafeNet Luna Network HSM A790 eastus +``` + +This command updates the parameter tag of the Dedicated HSM by name + +### Example 2: Update the parameter tag of the Dedicated HSM by object +```powershell +$hsm = Get-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz +Update-AzDedicatedHsm -InputObject $hsm -Tag @{'key1' = '1'; 'key2' = 2; 'key3' = 3} +``` + +```output +Name Provisioning State SKU Location +---- ------------------ --- -------- +hsm-n7wfxi Succeeded SafeNet Luna Network HSM A790 eastus +``` + +This command updates the parameter tag of the Dedicated HSM by object + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DedicatedHsm.Models.IDedicatedHsmIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the dedicated HSM + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Resource Group to which the server belongs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DedicatedHsm.Models.IDedicatedHsmIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DedicatedHsm.Models.Api20211130.IDedicatedHsm + +## 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 `<IDedicatedHsmIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[Name <String>]`: Name of the dedicated Hsm + - `[ResourceGroupName <String>]`: The name of the Resource Group to which the resource belongs. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DeploymentManager/Az.DeploymentManager.md b/azps-10.1.0/Az.DeploymentManager/Az.DeploymentManager.md new file mode 100644 index 0000000000..ab07e30d3e --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Az.DeploymentManager.md @@ -0,0 +1,87 @@ +--- +Module Name: Az.DeploymentManager +Module Guid: F022ED20-7D3B-4BF4-88AF-F97CC50484DA +Download Help Link: {{ Update Download Link }} +Help Version: 0.9.0 +Locale: {{ Update Locale }} +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Az.DeploymentManager.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Az.DeploymentManager.md +--- + +# Az.DeploymentManager Module +## Description +Cmdlets to interact with the Azure Deployment Manager service. + +## Az.DeploymentManager Cmdlets +### [Get-AzDeploymentManagerArtifactSource](Get-AzDeploymentManagerArtifactSource.md) +Gets the Artifact source. + +### [Get-AzDeploymentManagerRollout](Get-AzDeploymentManagerRollout.md) +Gets the rollout. + +### [Get-AzDeploymentManagerService](Get-AzDeploymentManagerService.md) +Gets the service. + +### [Get-AzDeploymentManagerServiceTopology](Get-AzDeploymentManagerServiceTopology.md) +Gets the service topology. + +### [Get-AzDeploymentManagerServiceUnit](Get-AzDeploymentManagerServiceUnit.md) +Gets the service unit. + +### [Get-AzDeploymentManagerStep](Get-AzDeploymentManagerStep.md) +Gets the step. + +### [New-AzDeploymentManagerArtifactSource](New-AzDeploymentManagerArtifactSource.md) +Creates an artifact source. + +### [New-AzDeploymentManagerService](New-AzDeploymentManagerService.md) +Creates a service under the specified service topology. + +### [New-AzDeploymentManagerServiceTopology](New-AzDeploymentManagerServiceTopology.md) +Creates a service topology. + +### [New-AzDeploymentManagerServiceUnit](New-AzDeploymentManagerServiceUnit.md) +Creates a service unit under the specified service and service topology. + +### [New-AzDeploymentManagerStep](New-AzDeploymentManagerStep.md) +Creates a step. + +### [Remove-AzDeploymentManagerArtifactSource](Remove-AzDeploymentManagerArtifactSource.md) +Deletes the specified artifact source. + +### [Remove-AzDeploymentManagerRollout](Remove-AzDeploymentManagerRollout.md) +Deletes the rollout. + +### [Remove-AzDeploymentManagerService](Remove-AzDeploymentManagerService.md) +Deletes the service.. All service units created under a service need to be deleted before deleting the service. + +### [Remove-AzDeploymentManagerServiceTopology](Remove-AzDeploymentManagerServiceTopology.md) +Deletes the service topology. All services created under a service topology need to be deleted before deleting the service topology. + +### [Remove-AzDeploymentManagerServiceUnit](Remove-AzDeploymentManagerServiceUnit.md) +Deletes the service unit. + +### [Remove-AzDeploymentManagerStep](Remove-AzDeploymentManagerStep.md) +Deletes the step. + +### [Restart-AzDeploymentManagerRollout](Restart-AzDeploymentManagerRollout.md) +Restarts a failed rollout. + +### [Set-AzDeploymentManagerArtifactSource](Set-AzDeploymentManagerArtifactSource.md) +Updates the artifacts source. + +### [Set-AzDeploymentManagerService](Set-AzDeploymentManagerService.md) +Updates the service. + +### [Set-AzDeploymentManagerServiceTopology](Set-AzDeploymentManagerServiceTopology.md) +Updates the service topology. + +### [Set-AzDeploymentManagerServiceUnit](Set-AzDeploymentManagerServiceUnit.md) +Updates the service unit. + +### [Set-AzDeploymentManagerStep](Set-AzDeploymentManagerStep.md) +Updates the step. + +### [Stop-AzDeploymentManagerRollout](Stop-AzDeploymentManagerRollout.md) +Stops the rollout. + diff --git a/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerArtifactSource.md b/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerArtifactSource.md new file mode 100644 index 0000000000..b5a275f615 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerArtifactSource.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/get-azdeploymentmanagerartifactsource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Get-AzDeploymentManagerArtifactSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Get-AzDeploymentManagerArtifactSource.md +--- + +# Get-AzDeploymentManagerArtifactSource + +## SYNOPSIS + +Gets the Artifact source. + +## SYNTAX + +### Interactive (Default) +``` +Get-AzDeploymentManagerArtifactSource [-ResourceGroupName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzDeploymentManagerArtifactSource [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### InputObject +``` +Get-AzDeploymentManagerArtifactSource [-InputObject] <PSArtifactSource> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDeploymentManagerArtifactSource** cmdlet gets an artifact source, and returns an object that represents that artifact source. +Specify the artifact source by its name and resource group name. Alternately, you can provide the ArtifactSource object or the ResourceId. + +## EXAMPLES + +### Example 1: Get an artifact source +```powershell +Get-AzDeploymentManagerArtifactSource -ResourceGroupName "ContosoResourceGroup" -Name "ContosoArtifactSource" +``` + +This command gets an artifact source named ContosoArtifactSource in ContosoResourceGroup. + +### Example 2: Get an artifact source using the resource identifier +```powershell +Get-AzDeploymentManagerArtifactSource -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/artifactSources/ContosoArtifactSource" +``` + +This command gets an artifact source named ContosoArtifactSource in ContosoResourceGroup. + +### Example 3: Get an artifact source using an object returned by New-AzDeploymentManagerArtifactSource +```powershell +Get-AzDeploymentManagerArtifactSource -InputObject $artifactSourceObject +``` + +This command gets an artifact source whose name and ResourceGroup match the Name and ResourceGroupName properties of the $artifactSourceObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Artifact Source object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the artifact source. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerRollout.md b/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerRollout.md new file mode 100644 index 0000000000..492ebd15c3 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerRollout.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/get-azdeploymentmanagerrollout +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Get-AzDeploymentManagerRollout.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Get-AzDeploymentManagerRollout.md +--- + +# Get-AzDeploymentManagerRollout + +## SYNOPSIS +Gets the rollout. + +## SYNTAX + +### Interactive (Default) +``` +Get-AzDeploymentManagerRollout [-ResourceGroupName] <String> [[-Name] <String>] [-RetryAttempt <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzDeploymentManagerRollout [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### InputObject +``` +Get-AzDeploymentManagerRollout [-InputObject] <PSRollout> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDeploymentManagerRollout** cmdlet gets a rollout, and returns an object that represents that rollout with all the detailed information on the progress of the rollout. +Specify the rollout by its name and resource group name. Alternately, you can provide the Rollout object or the ResourceId. + +The returned rollout object contains the services, service units and steps that have been deployed and the ones in progress. Those that are yet to be deployed are not in the response. + +## EXAMPLES + +### Example 1 Get the rollout +```powershell +Get-AzDeploymentManagerRollout -ResourceGroupName ContosoResourceGroup -Name ContosoRollout +``` + +This command gets a rollout named ContosoRollout in the ContosoResourceGroup. + +### Example 2 Get and display the rollout details +```powershell +Get-AzDeploymentManagerRollout -ResourceGroupName ContosoResourceGroup -Name ContosoRollout -Verbose +``` + +This command gets a rollout named ContosoRollout in the ContosoResourceGroup. +The -Verbose switch displays all the rollout details hierarchically; showing the Services, the ServiceUnits and the steps under each ServiceUnit and contextual information for each step for a holistic view of the rollout. + +### Example 3: Get a rollout using the resource identifier +```powershell +Get-AzDeploymentManagerRollout -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/rollouts/ContosoRollout" +``` + +This command gets a rollout named ContosoRollout in the ContosoResourceGroup. + +### Example 4: Get a rollout using the rollout object. +```powershell +Get-AzDeploymentManagerRollout -InputObject $rolloutObject +``` + +This command gets a rollout whose name and ResourceGroup match the Name and ResourceGroupName properties of the $rolloutObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Rollout object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the rollout. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetryAttempt +The retry attempt of the rollout. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: Interactive +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerService.md b/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerService.md new file mode 100644 index 0000000000..29a42d5fe6 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerService.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/get-azdeploymentmanagerservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Get-AzDeploymentManagerService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Get-AzDeploymentManagerService.md +--- + +# Get-AzDeploymentManagerService + +## SYNOPSIS +Gets the service. + +## SYNTAX + +### Interactive (Default) +``` +Get-AzDeploymentManagerService [-ResourceGroupName] <String> [-ServiceTopologyName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByServiceTopologyObject +``` +Get-AzDeploymentManagerService [-ResourceGroupName] <String> [[-Name] <String>] + [-ServiceTopologyObject] <PSServiceTopologyResource> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByServiceTopologyResourceId +``` +Get-AzDeploymentManagerService [-ResourceGroupName] <String> [[-Name] <String>] + [-ServiceTopologyResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzDeploymentManagerService [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### InputObject +``` +Get-AzDeploymentManagerService [-InputObject] <PSServiceResource> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDeploymentManagerService** cmdlet gets a service under a service topology, and returns an object that represents that service. +Specify the service by its name, service topology it is in and the resource group name. Alternately, you can provide the Service object or the ResourceId. + +You can modify this object locally, and then apply changes to the service by using the Set-AzDeploymentManagerService cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDeploymentManagerService -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -Name ContosoService1 +``` + +This command gets a service named ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 2: Get a service using the resource identifier. +```powershell +Get-AzDeploymentManagerService -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/serviceTopologies/ContosoServiceTopology/services/ContosoService1" +``` + +This command gets a service named ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 3: Get a service using the service object. +```powershell +Get-AzDeploymentManagerService -InputObject $serviceObject +``` + +This command gets a service whose name, service topology name and ResourceGroup match the Name, ServiceTopologyName and ResourceGroupName properties of the $serviceObject, respectively. + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Service object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the service. + +```yaml +Type: System.String +Parameter Sets: Interactive, ByServiceTopologyObject, ByServiceTopologyResourceId +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive, ByServiceTopologyObject, ByServiceTopologyResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceTopologyName +The name of the service topology. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyObject +The service topology object in which the service should be created. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: ByServiceTopologyObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyResourceId +The service topology resource identifier in which the service should be created. + +```yaml +Type: System.String +Parameter Sets: ByServiceTopologyResourceId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerServiceTopology.md b/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerServiceTopology.md new file mode 100644 index 0000000000..d1f92769b5 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerServiceTopology.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/get-azdeploymentmanagerservicetopology +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Get-AzDeploymentManagerServiceTopology.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Get-AzDeploymentManagerServiceTopology.md +--- + +# Get-AzDeploymentManagerServiceTopology + +## SYNOPSIS +Gets the service topology. + +## SYNTAX + +### Interactive (Default) +``` +Get-AzDeploymentManagerServiceTopology [-ResourceGroupName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzDeploymentManagerServiceTopology [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### InputObject +``` +Get-AzDeploymentManagerServiceTopology [-InputObject] <PSServiceTopologyResource> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDeploymentManagerServiceTopology** cmdlet gets a service topology. + +You can modify this object locally, and then apply changes to the topology by using the Set-AzDeploymentManagerServiceTopology cmdlet. +Specify the service topology by its name and the resource group name. Alternately, you can provide the ServiceTopology object or the ResourceId. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDeploymentManagerServiceTopology -ResourceGroupName ContosoResourceGroup -Name ContosoServiceTopology +``` + +This command gets a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 2: Get a service topology using the resource identifier. +```powershell +Get-AzDeploymentManagerServiceTopology -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/serviceTopologies/ContosoServiceTopology" +``` + +This command gets a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 3: Get a service topology using the service topology object. +```powershell +Get-AzDeploymentManagerService -InputObject $serviceTopologyObject +``` + +This command gets a service topology whose name and ResourceGroup match the Name and ResourceGroupName properties of the $serviceTopologyObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Service topology resource object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the service topology. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerServiceUnit.md b/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerServiceUnit.md new file mode 100644 index 0000000000..539a7ee09f --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerServiceUnit.md @@ -0,0 +1,272 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/get-azdeploymentmanagerserviceunit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Get-AzDeploymentManagerServiceUnit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Get-AzDeploymentManagerServiceUnit.md +--- + +# Get-AzDeploymentManagerServiceUnit + +## SYNOPSIS +Gets the service unit. + +## SYNTAX + +### Interactive (Default) +``` +Get-AzDeploymentManagerServiceUnit [-ResourceGroupName] <String> [-ServiceTopologyName] <String> + [-ServiceName] <String> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByServiceObject +``` +Get-AzDeploymentManagerServiceUnit [-ResourceGroupName] <String> [[-Name] <String>] + [-ServiceObject] <PSServiceResource> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByServiceResourceId +``` +Get-AzDeploymentManagerServiceUnit [-ResourceGroupName] <String> [[-Name] <String>] + [-ServiceResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTopologyObjectAndServiceName +``` +Get-AzDeploymentManagerServiceUnit [-ResourceGroupName] <String> [-ServiceName] <String> [[-Name] <String>] + [-ServiceTopologyObject] <PSServiceTopologyResource> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTopologyResourceAndServiceName +``` +Get-AzDeploymentManagerServiceUnit [-ResourceGroupName] <String> [-ServiceName] <String> [[-Name] <String>] + [-ServiceTopologyResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzDeploymentManagerServiceUnit [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### InputObject +``` +Get-AzDeploymentManagerServiceUnit [-InputObject] <PSServiceUnitResource> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDeploymentManagerServiceUnit** cmdlet gets a service unit in a service. + +Specify the service unit by its name, the service under which it was defined, the service topology name and the resource group name. Alternately, you can provide the ServiceUnit object or the ResourceId. + +You can modify this object locally, and then apply changes to the service unit by using the Set-AzDeploymentManagerServiceUnit cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDeploymentManagerServiceUnit -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -ServiceName ContosoService1 -Name ContosoService1Storage +``` + +This command gets a service unit named ContosoService1Storage under a service ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 2: Get a service unit using the resource identifier. +```powershell +Get-AzDeploymentManagerServiceUnit -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/serviceTopologies/ContosoServiceTopology/services/ContosoService1/serviceUnits/ContosoService1Storage" +``` + +This command gets a service unit named ContosoService1Storage under a service ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 3: Get a service unit using the service unit object. +```powershell +Get-AzDeploymentManagerServiceUnit -InputObject $serviceUnitObject +``` + +This command gets a service unit whose name, service name, service topology name and ResourceGroup match the Name, ServiceName, ServiceTopologyName and ResourceGroupName properties of the $serviceUnitObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Service unit resource object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the service unit. + +```yaml +Type: System.String +Parameter Sets: Interactive, ByServiceObject, ByServiceResourceId, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive, ByServiceObject, ByServiceResourceId, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +The name of the service the service unit is part of. + +```yaml +Type: System.String +Parameter Sets: Interactive, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceObject +The service object in which the service unit should be created. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource +Parameter Sets: ByServiceObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceResourceId +The service resource identifier in which the service unit should be created. + +```yaml +Type: System.String +Parameter Sets: ByServiceResourceId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyName +The name of the service topology the service unit is part of. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyObject +The service topology object in which the service unit should be created. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: ByTopologyObjectAndServiceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyResourceId +The service topology resource identifier in which the service unit should be created. + +```yaml +Type: System.String +Parameter Sets: ByTopologyResourceAndServiceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerStep.md b/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerStep.md new file mode 100644 index 0000000000..e57193e039 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Get-AzDeploymentManagerStep.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/get-azdeploymentmanagerstep +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Get-AzDeploymentManagerStep.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Get-AzDeploymentManagerStep.md +--- + +# Get-AzDeploymentManagerStep + +## SYNOPSIS +Gets the step. + +## SYNTAX + +### Interactive (Default) +``` +Get-AzDeploymentManagerStep [-ResourceGroupName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzDeploymentManagerStep [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### InputObject +``` +Get-AzDeploymentManagerStep [-InputObject] <PSStepResource> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDeploymentManagerStep** cmdlet gets a step, and returns an object that represents that step. +Specify the step by its name and resource group name. Alternately, you can provide the Step object or the ResourceId. + +You can modify this object locally, and then apply changes to the artifact source by using the Set-AzDeploymentManagerStep cmdlet. + +## EXAMPLES + +### Example 1: Get a step +```powershell +New-AzDeploymentManagerStep -ResourceGroupName ContosoResourceGroup -Name ContosoService1WaitStep +``` + +This command gets a step named ContosoService1WaitStep in ContosoResourceGroup. + +### Example 2: Get a step using the resource identifier +```powershell +Get-AzDeploymentManagerStep -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/steps/ContosoService1WaitStep" +``` + +This command gets a step named ContosoService1WaitStep in ContosoResourceGroup. + +### Example 3: Get a step using an object returned by New-AzDeploymentManagerStep +```powershell +Get-AzDeploymentManagerStep -InputObject $stepObject +``` + + This command gets a step whose name and ResourceGroup match the Name and ResourceGroupName properties of the $stepObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The step resource object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the step. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerArtifactSource.md b/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerArtifactSource.md new file mode 100644 index 0000000000..dafa16f0c8 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerArtifactSource.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/new-azdeploymentmanagerartifactsource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/New-AzDeploymentManagerArtifactSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/New-AzDeploymentManagerArtifactSource.md +--- + +# New-AzDeploymentManagerArtifactSource + +## SYNOPSIS +Creates an artifact source. + +## SYNTAX + +``` +New-AzDeploymentManagerArtifactSource -ResourceGroupName <String> -Name <String> -Location <String> + -SasUri <String> [-Tag <Hashtable>] [-ArtifactRoot <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDeploymentManagerArtifactSource** cmdlet creates an artifact source. +Specify the *Name*, *ResourceGroupName* and required properties. + +You can modify the returned object locally and then apply the changes to the artifact source by using the Set-AzDeploymentManagerArtifactSource cmdlet. + +The cmdlet returns an ArtifactSource object that has a ResourceId which can be referenced in the New-AzDeploymentManagerServiceTopology cmdlet so that artifacts required for a ServiceUnit resource, the Template and Parameters files, can be referenced from this location. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDeploymentManagerArtifactSource -ResourceGroupName ContosoResourceGroup -Name ContosoArtifactSource -Location "Central US" -SasUri "https://ContosoStorage.blob.core.windows.net/ContosoArtifacts?sasParameters" +``` + +Creates an artifact source in the ContosoResourceGroup with the name ContosoArtifactSource with Central US as the location of the resource. The SasUri property provides an Azure Storage SAS Uri to the storage container where the artifacts are stored. + +## PARAMETERS + +### -ArtifactRoot +The optional directory offset under the storage container for the artifacts. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the artifact source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SasUri +The SAS Uri to the Azure storage container where the artifacts are stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerService.md b/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerService.md new file mode 100644 index 0000000000..e16aa18645 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerService.md @@ -0,0 +1,249 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/new-azdeploymentmanagerservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/New-AzDeploymentManagerService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/New-AzDeploymentManagerService.md +--- + +# New-AzDeploymentManagerService + +## SYNOPSIS +Creates a service under the specified service topology. + +## SYNTAX + +### Interactive (Default) +``` +New-AzDeploymentManagerService [-ResourceGroupName] <String> [-ServiceTopologyName] <String> -Name <String> + -Location <String> -TargetLocation <String> -TargetSubscriptionId <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByServiceTopologyObject +``` +New-AzDeploymentManagerService [-ResourceGroupName] <String> -Name <String> -Location <String> + -TargetLocation <String> -TargetSubscriptionId <String> [-ServiceTopologyObject] <PSServiceTopologyResource> + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByServiceTopologyResourceId +``` +New-AzDeploymentManagerService [-ResourceGroupName] <String> -Name <String> -Location <String> + -TargetLocation <String> -TargetSubscriptionId <String> [-ServiceTopologyId] <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDeploymentManagerService** cmdlet creates a service under a service topology, and returns an object that represents that service. +Specify the service by its name, service topology it is in and the resource group name. + +The cmdlet returns a Service object. You can modify this object locally, and then apply changes to the service by using the Set-AzDeploymentManagerService cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDeploymentManagerService -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -Name ContosoService1 -Location "Central US" -TargetLocation "East US" -TargetSubscriptionId XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +``` + +Creates a new service with name ContosoService1 under service topology ContosoServiceTopology in Resource Group ContosoResourceGroup, in the location Central US. The TargetLocation property indicates that the service ContosoService1 should be deployed to the East US region in the subscription specified. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyId +The service topology resource identifier in which the service should be created. + +```yaml +Type: System.String +Parameter Sets: ByServiceTopologyResourceId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyName +The name of the service topology this service belongs to. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyObject +The service topology object in which the service should be created. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: ByServiceTopologyObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetLocation +Determines the location where resources under the service would be deployed to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSubscriptionId +Determines the subscription to which resources under the service would be deployed to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerServiceTopology.md b/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerServiceTopology.md new file mode 100644 index 0000000000..84d18dfc94 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerServiceTopology.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/new-azdeploymentmanagerservicetopology +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/New-AzDeploymentManagerServiceTopology.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/New-AzDeploymentManagerServiceTopology.md +--- + +# New-AzDeploymentManagerServiceTopology + +## SYNOPSIS +Creates a service topology. + +## SYNTAX + +``` +New-AzDeploymentManagerServiceTopology -ResourceGroupName <String> -Name <String> -Location <String> + [-ArtifactSourceId <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDeploymentManagerServiceTopology** cmdlet creates a service topology. + +You can modify the returned ServiceTopology object locally, and then apply changes to the topology by using the Set-AzDeploymentManagerServiceTopology cmdlet. +The returned object + +The returned object has a ResourceId field which can be referenced in a rollout resource to indicate that the services declared in this service topology would be deployed in the rollout. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDeploymentManagerServiceTopology -ResourceGroupName ContosoResourceGroup -Name ContosoServiceTopology -Location "Central US" -ArtifactSourceId "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/artifactSources/ContosoArtifactSource" +``` + +This cmdlet creates a new service topology in the resource group ContosoResourceGroup with the name ContosoServiceTopology and in location Central US. The artifact source ResourceId indicates that the artifacts required for the service unit definitions in this topology need to be read from the specified artifact source. + +### Example 2 +```powershell +New-AzDeploymentManagerServiceTopology -ResourceGroupName ContosoResourceGroup -Name ContosoServiceTopology -Location "Central US" +``` + +This cmdlet creates a new service topology in the resource group ContosoResourceGroup with the name ContosoServiceTopology and in location Central US. The absence of an artifact source reference indicates that the artifacts required for the service unit definitions in this topology would be provided as absolute SAS URIs in the service unit. + +## PARAMETERS + +### -ArtifactSourceId +The identifier of the artifact source, where the artifacts that make up the topology are stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the topology. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the topology. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerServiceUnit.md b/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerServiceUnit.md new file mode 100644 index 0000000000..7611e29322 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerServiceUnit.md @@ -0,0 +1,407 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/new-azdeploymentmanagerserviceunit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/New-AzDeploymentManagerServiceUnit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/New-AzDeploymentManagerServiceUnit.md +--- + +# New-AzDeploymentManagerServiceUnit + +## SYNOPSIS +Creates a service unit under the specified service and service topology. + +## SYNTAX + +### ByTopologyAndServiceNames (Default) +``` +New-AzDeploymentManagerServiceUnit [-ResourceGroupName] <String> [-ServiceTopologyName] <String> + [-ServiceName] <String> [-Name] <String> -Location <String> -TargetResourceGroup <String> + -DeploymentMode <String> [-ParametersUri <String>] [-TemplateUri <String>] + [-TemplateArtifactSourceRelativePath <String>] [-ParametersArtifactSourceRelativePath <String>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTopologyObjectAndServiceName +``` +New-AzDeploymentManagerServiceUnit [-ResourceGroupName] <String> [-ServiceName] <String> [-Name] <String> + -Location <String> -TargetResourceGroup <String> -DeploymentMode <String> [-ParametersUri <String>] + [-TemplateUri <String>] [-TemplateArtifactSourceRelativePath <String>] + [-ParametersArtifactSourceRelativePath <String>] [-Tag <Hashtable>] + [-ServiceTopologyObject] <PSServiceTopologyResource> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTopologyResourceAndServiceName +``` +New-AzDeploymentManagerServiceUnit [-ResourceGroupName] <String> [-ServiceName] <String> [-Name] <String> + -Location <String> -TargetResourceGroup <String> -DeploymentMode <String> [-ParametersUri <String>] + [-TemplateUri <String>] [-TemplateArtifactSourceRelativePath <String>] + [-ParametersArtifactSourceRelativePath <String>] [-Tag <Hashtable>] [-ServiceTopologyResourceId] <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByServiceObject +``` +New-AzDeploymentManagerServiceUnit [-ResourceGroupName] <String> [-Name] <String> -Location <String> + -TargetResourceGroup <String> -DeploymentMode <String> [-ParametersUri <String>] [-TemplateUri <String>] + [-TemplateArtifactSourceRelativePath <String>] [-ParametersArtifactSourceRelativePath <String>] + [-Tag <Hashtable>] [-ServiceObject] <PSServiceResource> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByServiceResourceId +``` +New-AzDeploymentManagerServiceUnit [-ResourceGroupName] <String> [-Name] <String> -Location <String> + -TargetResourceGroup <String> -DeploymentMode <String> [-ParametersUri <String>] [-TemplateUri <String>] + [-TemplateArtifactSourceRelativePath <String>] [-ParametersArtifactSourceRelativePath <String>] + [-Tag <Hashtable>] [-ServiceResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDeploymentManagerServiceUnit** cmdlet creates a service under a service in a service topology, and returns an object that represents that service unit. +Specify the service unit by its name, service name, service topology it is in and the resource group name. + +The cmdlet returns a ServiceUnit object. You can modify this object locally, and then apply changes to the service by using the Set-AzDeploymentManagerService cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDeploymentManagerServiceUnit -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -ServiceName ContosoService2 -Name ContosoService2Storage -Location "Central US" -TargetResourceGroup service2ResourceGroup -DeploymentMode Incremental -TemplateArtifactSourceRelativePath "Templates/Service2.Storage.json" -ParametersArtifactSourceRelativePath "Parameters/Service2Storage.Parameters.json" +``` + +This cmdlet creates a new service unit with name ContosoService2Storage in the ContosoResourceGroup under the service ContosoService2 in topology ContosoServiceTopology, in the location Central US. The Template and parameters files are defined as relative paths into the artifact source location referenced in the Service Topology ContosoServiceTopology. The resources defined in this template are to be deployed into the target resource group service2ResourceGroup with the deployment mode set to Incremental. + +### Example 2 +```powershell +New-AzDeploymentManagerServiceUnit -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology1 -ServiceName ContosoService2 -Name ContosoService2Storage -Location "Central US" -TargetResourceGroup service2ResourceGroup -DeploymentMode Complete -TemplateUri "https://ContosoStorage.blob.core.windows.net/ContosoArtifacts/Templates/Service2.Storage.json?sasParameters" -ParametersUri "https://ContosoStorage.blob.core.windows.net/ContosoArtifacts/Parameters/Service2Storage.Parameters.json?sasParameters" +``` + +This cmdlet creates a new service unit with name ContosoService2Storage in the ContosoResourceGroup under the service ContosoService2 in topology ContosoServiceTopology, in the location Central US. The Template and parameters references are provided as SAS Uri's as artifact source ResourceId was not provided in the Service Topology ContosoServiceTopology1. The resources defined in this template are to be deployed into the target resource group service2ResourceGroup with the deployment mode set to Complete. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentMode +The deployment mode to use when deploying the resources in the service unit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Incremental, Complete + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the service unit resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service unit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParametersArtifactSourceRelativePath +The path to the parameters file relative to the artifact source. +Requires ArtifactSource to be referenced in ServiceTopology. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParametersUri +The SAS Uri to the parameters file. +If ArtifactSourceId was referenced in the ServiceTopology, specify relative path using ParametersArtifactSourceRelativePath. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the service this service unit is a part of. + +```yaml +Type: System.String +Parameter Sets: ByTopologyAndServiceNames, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceObject +The service object in which the service unit should be created. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource +Parameter Sets: ByServiceObject +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceResourceId +The service resource identifier in which the service unit should be created. + +```yaml +Type: System.String +Parameter Sets: ByServiceResourceId +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyName +The name of the service topology this service unit is a part of. + +```yaml +Type: System.String +Parameter Sets: ByTopologyAndServiceNames +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyObject +The service topology object in which the service unit should be created. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: ByTopologyObjectAndServiceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyResourceId +The service topology resource identifier in which the service unit should be created. + +```yaml +Type: System.String +Parameter Sets: ByTopologyResourceAndServiceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceGroup +Determines the location where resources under the service unit would be deployed to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateArtifactSourceRelativePath +The path to the template file relative to the artifact source. +Requires ArtifactSource to be referenced in ServiceTopology. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateUri +The SAS Uri to the template file. +If ArtifactSourceId was referenced in the ServiceTopology, specify relative path using TemplateArtifactSourceRelativePath. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerStep.md b/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerStep.md new file mode 100644 index 0000000000..ea7461860d --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/New-AzDeploymentManagerStep.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/new-azdeploymentmanagerstep +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/New-AzDeploymentManagerStep.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/New-AzDeploymentManagerStep.md +--- + +# New-AzDeploymentManagerStep + +## SYNOPSIS +Creates a step. + +## SYNTAX + +### Wait (Default) +``` +New-AzDeploymentManagerStep -ResourceGroupName <String> -Name <String> -Location <String> -Duration <String> + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HealthCheckFile +``` +New-AzDeploymentManagerStep -ResourceGroupName <String> -Name <String> -Location <String> + -HealthCheckPropertiesFile <String> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### HealthCheckObject +``` +New-AzDeploymentManagerStep -ResourceGroupName <String> -Name <String> -Location <String> + -HealthCheckProperties <PSHealthCheckStepProperties> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDeploymentManagerStep** cmdlet creates a deployment step that can be referenced in rollouts. +Specify the *Name*, *ResourceGroupName* and required properties. + +You can modify the returned object locally and then apply the changes to the step by using the Set-AzDeploymentManagerStep cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDeploymentManagerStep -ResourceGroupName ContosoResourceGroup -Name ContosoService1WaitStep -Location "Central US" -Duration PT20M +``` + +Creates a step in the ContosoResourceGroup with the name ContosoService1WaitStep with Central US as the location of the resource. The Duration property provides the duration the rollout will wait before running the next step. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Duration +The duration to wait in ISO 8601 format. +E.g.: PT30M, PT1H + +```yaml +Type: System.String +Parameter Sets: Wait +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthCheckProperties +The health check properties. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSHealthCheckStepProperties +Parameter Sets: HealthCheckObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthCheckPropertiesFile +The path to the file where health check properties are defined. + +```yaml +Type: System.String +Parameter Sets: HealthCheckFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the step. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerArtifactSource.md b/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerArtifactSource.md new file mode 100644 index 0000000000..f8f2b4fa16 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerArtifactSource.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/remove-azdeploymentmanagerartifactsource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Remove-AzDeploymentManagerArtifactSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Remove-AzDeploymentManagerArtifactSource.md +--- + +# Remove-AzDeploymentManagerArtifactSource + +## SYNOPSIS +Deletes the specified artifact source. + +## SYNTAX + +### Interactive (Default) +``` +Remove-AzDeploymentManagerArtifactSource [-ResourceGroupName] <String> [-Name] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzDeploymentManagerArtifactSource [-ResourceId] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzDeploymentManagerArtifactSource [-InputObject] <PSArtifactSource> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDeploymentManagerArtifactSource** cmdlet deletes an artifact source +Specify the artifact source by its name and resource group name. Alternately, you can provide the ArtifactSource object or the ResourceId. + +## EXAMPLES + +### Example 1: Delete an artifact source +```powershell +Remove-AzDeploymentManagerArtifactSource -ResourceGroupName "ContosoResourceGroup" -Name "ContosoArtifactSource" +``` + +This command deletes an artifact source named ContosoArtifactSource in ContosoResourceGroup. + +### Example 2: Delete an artifact source using the resource identifier +```powershell +Remove-AzDeploymentManagerArtifactSource -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/artifactSources/ContosoArtifactSource" +``` + +This command deletes an artifact source named ContosoArtifactSource in ContosoResourceGroup. + +### Example 3: Delete an artifact source using an object +```powershell +Remove-AzDeploymentManagerArtifactSource -InputObject $artifactSourceObject +``` + +This command deletes an artifact source whose name and ResourceGroup match the Name and ResourceGroupName properties of the $artifactSourceObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The artifact source to be removed. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the artifact source. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerRollout.md b/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerRollout.md new file mode 100644 index 0000000000..c3cd0029ba --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerRollout.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/remove-azdeploymentmanagerrollout +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Remove-AzDeploymentManagerRollout.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Remove-AzDeploymentManagerRollout.md +--- + +# Remove-AzDeploymentManagerRollout + +## SYNOPSIS +Deletes the rollout. + +## SYNTAX + +### Interactive (Default) +``` +Remove-AzDeploymentManagerRollout [-ResourceGroupName] <String> [-Name] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzDeploymentManagerRollout [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzDeploymentManagerRollout [-InputObject] <PSRollout> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDeploymentManagerRollout** cmdlet deletes a rollout in a terminal state. +Specify the rollout by its name and resource group name. Alternately, you can provide the Rollout object or the ResourceId. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDeploymentManagerRollout -ResourceGroupName ContosoResourceGroup -Name ContosoRollout +``` + +This command deletes a rollout named ContosoRollout in the ContosoResourceGroup. + +### Example 2: Delete a rollout using the resource identifier +```powershell +Remove-AzDeploymentManagerRollout -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/rollouts/ContosoRollout" +``` + +This command deletes a rollout named ContosoRollout in the ContosoResourceGroup. + +### Example 3: Delete a rollout using the rollout object. +```powershell +Remove-AzDeploymentManagerRollout -InputObject $rolloutObject +``` + +This command deletes a rollout whose name and ResourceGroup match the Name and ResourceGroupName properties of the $rolloutObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The resource to be removed. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the rollout. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerService.md b/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerService.md new file mode 100644 index 0000000000..9c275b707d --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerService.md @@ -0,0 +1,258 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/remove-azdeploymentmanagerservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Remove-AzDeploymentManagerService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Remove-AzDeploymentManagerService.md +--- + +# Remove-AzDeploymentManagerService + +## SYNOPSIS +Deletes the service.. All service units created under a service need to be deleted before deleting the service. + +## SYNTAX + +### Interactive (Default) +``` +Remove-AzDeploymentManagerService [-ResourceGroupName] <String> [-ServiceTopologyName] <String> + [-Name] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByServiceTopologyObject +``` +Remove-AzDeploymentManagerService [-Name] <String> [-ServiceTopologyObject] <PSServiceTopologyResource> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByServiceTopologyResourceId +``` +Remove-AzDeploymentManagerService [-Name] <String> [-ServiceTopologyResourceId] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzDeploymentManagerService [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzDeploymentManagerService [-InputObject] <PSServiceResource> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDeploymentManagerService** cmdlet deletes a service under a service topology. +Specify the service by its name, service topology it is in and the resource group name. Alternately, you can provide the Service object or the ResourceId. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDeploymentManagerService -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -Name ContosoService1 +``` + +This command deletes a service named ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 2: Delete a service using the resource identifier. +```powershell +Remove-AzDeploymentManagerService -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/serviceTopologies/ContosoServiceTopology/services/ContosoService1" +``` + +This command deletes a service named ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 3: Delete a service using the service object. +```powershell +Remove-AzDeploymentManagerService -InputObject $serviceObject +``` + +This command deletes a service whose name, service topology name and ResourceGroup match the Name, ServiceTopologyName and ResourceGroupName properties of the $serviceObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Service object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the service. + +```yaml +Type: System.String +Parameter Sets: Interactive, ByServiceTopologyObject, ByServiceTopologyResourceId +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceTopologyName +The name of the service topology. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyObject +The service topology object in which the service should be created. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: ByServiceTopologyObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyResourceId +The service topology resource identifier in which the service should be created. + +```yaml +Type: System.String +Parameter Sets: ByServiceTopologyResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerServiceTopology.md b/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerServiceTopology.md new file mode 100644 index 0000000000..94e5991168 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerServiceTopology.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/remove-azdeploymentmanagerservicetopology +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Remove-AzDeploymentManagerServiceTopology.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Remove-AzDeploymentManagerServiceTopology.md +--- + +# Remove-AzDeploymentManagerServiceTopology + +## SYNOPSIS +Deletes the service topology. All services created under a service topology need to be deleted before deleting the service topology. + +## SYNTAX + +### Interactive (Default) +``` +Remove-AzDeploymentManagerServiceTopology [-ResourceGroupName] <String> [-Name] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzDeploymentManagerServiceTopology [-ResourceId] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzDeploymentManagerServiceTopology [-InputObject] <PSServiceTopologyResource> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDeploymentManagerServiceTopology** cmdlet deletes a service topology. + +Specify the service topology by its name and the resource group name. Alternately, you can provide the ServiceTopology object or the ResourceId. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDeploymentManagerServiceTopology -ResourceGroupName ContosoResourceGroup -Name ContosoServiceTopology +``` + +This command deletes a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 2: Delete a service topology using the resource identifier. +```powershell +Remove-AzDeploymentManagerServiceTopology -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/serviceTopologies/ContosoServiceTopology" +``` + +This command deletes a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 3: Delete a service topology using the service topology object. +```powershell +Remove-AzDeploymentManagerService -InputObject $serviceTopologyObject +``` + +This command deletes a service topology whose name and ResourceGroup match the Name and ResourceGroupName properties of the $serviceTopologyObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The resource to be removed. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the service topology. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerServiceUnit.md b/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerServiceUnit.md new file mode 100644 index 0000000000..ba7f189729 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerServiceUnit.md @@ -0,0 +1,318 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/remove-azdeploymentmanagerserviceunit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Remove-AzDeploymentManagerServiceUnit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Remove-AzDeploymentManagerServiceUnit.md +--- + +# Remove-AzDeploymentManagerServiceUnit + +## SYNOPSIS +Deletes the service unit. + +## SYNTAX + +### Interactive (Default) +``` +Remove-AzDeploymentManagerServiceUnit [-ResourceGroupName] <String> [-ServiceTopologyName] <String> + [-ServiceName] <String> [-Name] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByTopologyObjectAndServiceName +``` +Remove-AzDeploymentManagerServiceUnit [-ServiceName] <String> [-Name] <String> + [-ServiceTopologyObject] <PSServiceTopologyResource> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTopologyResourceAndServiceName +``` +Remove-AzDeploymentManagerServiceUnit [-ServiceName] <String> [-Name] <String> + [-ServiceTopologyResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByServiceObject +``` +Remove-AzDeploymentManagerServiceUnit [-Name] <String> [-ServiceObject] <PSServiceResource> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByServiceResourceId +``` +Remove-AzDeploymentManagerServiceUnit [-Name] <String> [-ServiceResourceId] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzDeploymentManagerServiceUnit [-ResourceId] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzDeploymentManagerServiceUnit [-InputObject] <PSServiceUnitResource> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDeploymentManagerServiceUnit** cmdlet deletes a service unit in a service. + +Specify the service unit by its name, the service under which it was defined, the service topology name and the resource group name. Alternately, you can provide the ServiceUnit object or the ResourceId. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDeploymentManagerServiceUnit -ResourceGroupName ContosoResourceGroup -ServiceTopologyName ContosoServiceTopology -ServiceName ContosoService1 -Name ContosoService1Storage +``` + +This command deletes a service unit named ContosoService1Storage under a service ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 2: Delete a service unit using the resource identifier. +```powershell +Remove-AzDeploymentManagerServiceUnit -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/serviceTopologies/ContosoServiceTopology/services/ContosoService1/serviceUnits/ContosoService1Storage" +``` + +This command gets a service unit named ContosoService1Storage under a service ContosoService1 in a service topology named ContosoServiceTopology in the ContosoResourceGroup. + +### Example 3: Delete a service unit using the service unit object. +```powershell +Remove-AzDeploymentManagerServiceUnit -InputObject $serviceUnitObject +``` + +This command deletes a service unit whose name, service name, service topology name and ResourceGroup match the Name, ServiceName, ServiceTopologyName and ResourceGroupName properties of the $serviceUnitObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Service unit resource object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the service unit. + +```yaml +Type: System.String +Parameter Sets: Interactive, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName, ByServiceObject, ByServiceResourceId +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +The name of the service the service unit is part of. + +```yaml +Type: System.String +Parameter Sets: Interactive, ByTopologyObjectAndServiceName, ByTopologyResourceAndServiceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceObject +The service object in which the service unit should be created. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource +Parameter Sets: ByServiceObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceResourceId +The service resource identifier in which the service unit should be created. + +```yaml +Type: System.String +Parameter Sets: ByServiceResourceId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyName +The name of the service topology the service unit is part of. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyObject +The service topology object in which the service unit should be created. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: ByTopologyObjectAndServiceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTopologyResourceId +The service topology resource identifier in which the service unit should be created. + +```yaml +Type: System.String +Parameter Sets: ByTopologyResourceAndServiceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerStep.md b/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerStep.md new file mode 100644 index 0000000000..5cdde32395 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Remove-AzDeploymentManagerStep.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/remove-azdeploymentmanagerstep +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Remove-AzDeploymentManagerStep.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Remove-AzDeploymentManagerStep.md +--- + +# Remove-AzDeploymentManagerStep + +## SYNOPSIS +Deletes the step. + +## SYNTAX + +### Interactive (Default) +``` +Remove-AzDeploymentManagerStep [-ResourceGroupName] <String> [-Name] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzDeploymentManagerStep [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzDeploymentManagerStep [-InputObject] <PSStepResource> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDeploymentManagerStep** cmdlet deletes a step. +Specify the step by its name and the resource group name. Alternately, you can provide the Step object or the ResourceId. + +## EXAMPLES + +### Example 1: Remove a step +```powershell +Remove-AzDeploymentManagerStep -ResourceGroupName ContosoResourceGroup -Name ContosoService1WaitStep +``` + +This command deletes a step named ContosoService1WaitStep in ContosoResourceGroup. + +### Example 2: Remove a step using the resource identifier +```powershell +Remove-AzDeploymentManagerStep -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/steps/ContosoService1WaitStep" +``` + +This command deletes a step named ContosoService1WaitStep in ContosoResourceGroup. + +### Example 3: Remove a step using an object returned by New-AzDeploymentManagerStep +```powershell +Remove-AzDeploymentManagerStep -InputObject $stepObject +``` + + This command deletes a step whose name and ResourceGroup match the Name and ResourceGroupName properties of the $stepObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The step to be removed. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the step. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Restart-AzDeploymentManagerRollout.md b/azps-10.1.0/Az.DeploymentManager/Restart-AzDeploymentManagerRollout.md new file mode 100644 index 0000000000..727eb6fa67 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Restart-AzDeploymentManagerRollout.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/restart-azdeploymentmanagerrollout +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Restart-AzDeploymentManagerRollout.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Restart-AzDeploymentManagerRollout.md +--- + +# Restart-AzDeploymentManagerRollout + +## SYNOPSIS +Restarts a failed rollout. + +## SYNTAX + +### Interactive (Default) +``` +Restart-AzDeploymentManagerRollout [-ResourceGroupName] <String> [-Name] <String> [-SkipSucceeded] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Restart-AzDeploymentManagerRollout [-ResourceId] <String> [-SkipSucceeded] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Restart-AzDeploymentManagerRollout [-InputObject] <PSRollout> [-SkipSucceeded] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Restart-AzDeploymentManagerRollout** cmdlet restarts a failed rollout, and returns an object that represents that rollout with all the detailed information on the progress of the rollout. +Specify the rollout by its name and resource group name. Alternately, you can provide the Rollout object or the ResourceId. +Optional parameter SkipSucceeded allows you to skip all the succeeded steps in the previous run of the rollout. + +## EXAMPLES + +### Example 1 +```powershell +Restart-AzDeploymentManagerRollout -ResourceGroupName ContosoResourceGroup -Name ContosoRollout -SkipSucceeded +``` + +This command restarts a rollout named ContosoRollout in the ContosoResourceGroup. The SkipSucceeded flag indicates that all the steps that already ran successfully should be skipped and the rollout should continue execution from where it last failed. + +### Example 2: Restart a rollout using the resource identifier +```powershell +Restart-AzDeploymentManagerRollout -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/rollouts/ContosoRollout" +``` + +This command restarts a rollout named ContosoRollout in the ContosoResourceGroup. + +### Example 3: Restart a rollout using the rollout object. +```powershell +Get-AzDeploymentManagerRollout -InputObject $rolloutObject +``` + +This command restarts a rollout whose name and ResourceGroup match the Name and ResourceGroupName properties of the $rolloutObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The resource to be removed. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the rollout. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipSucceeded +Skip steps that succeeded in the previous run of the rollout. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerArtifactSource.md b/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerArtifactSource.md new file mode 100644 index 0000000000..dbf39d61b3 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerArtifactSource.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/set-azdeploymentmanagerartifactsource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Set-AzDeploymentManagerArtifactSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Set-AzDeploymentManagerArtifactSource.md +--- + +# Set-AzDeploymentManagerArtifactSource + +## SYNOPSIS +Updates the artifacts source. + +## SYNTAX + +``` +Set-AzDeploymentManagerArtifactSource [-InputObject] <PSArtifactSource> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDeploymentManagerArtifactSource** cmdlet updates an artifact source with the specified artifact source object. +The cmdlet returns the updated ArtifactSource object. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDeploymentManagerArtifactSource -InputObject $artifactSourceObject +``` + +This command updates an artifact source whose name and ResourceGroup match the Name and ResourceGroupName properties of the $artifactSourceObject, respectively. +The artifact source would be updated to the properties set in the $artifactSourceObject. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The artifact source object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSArtifactSource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerService.md b/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerService.md new file mode 100644 index 0000000000..0f3ee21370 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerService.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/set-azdeploymentmanagerservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Set-AzDeploymentManagerService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Set-AzDeploymentManagerService.md +--- + +# Set-AzDeploymentManagerService + +## SYNOPSIS +Updates the service. + +## SYNTAX + +``` +Set-AzDeploymentManagerService [-InputObject] <PSServiceResource> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDeploymentManagerService** cmdlet updates a service with the specified service object. +The cmdlet returns the updated service object. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDeploymentManagerService -InputObject $serviceObject +``` + +This command updates a service whose name, service topology name and ResourceGroup match the Name, ServiceTopologyName and ResourceGroupName properties of the $serviceObject, respectively. +The service would be updated to the properties set in the $serviceObject. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The service object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerServiceTopology.md b/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerServiceTopology.md new file mode 100644 index 0000000000..5dc6568202 --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerServiceTopology.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/set-azdeploymentmanagerservicetopology +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Set-AzDeploymentManagerServiceTopology.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Set-AzDeploymentManagerServiceTopology.md +--- + +# Set-AzDeploymentManagerServiceTopology + +## SYNOPSIS +Updates the service topology. + +## SYNTAX + +``` +Set-AzDeploymentManagerServiceTopology [-InputObject] <PSServiceTopologyResource> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDeploymentManagerServiceTopology** cmdlet updates a service topology with the specified service topology object. +The cmdlet returns the updated service topology object. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDeploymentManagerService -InputObject $serviceTopologyObject +``` + +This command updates a service topology whose name and ResourceGroup match the Name and ResourceGroupName properties of the $serviceTopologyObject, respectively. +The command returns the updated service topology object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The service topology object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceTopologyResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerServiceUnit.md b/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerServiceUnit.md new file mode 100644 index 0000000000..a59db2198a --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerServiceUnit.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/set-azdeploymentmanagerserviceunit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Set-AzDeploymentManagerServiceUnit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Set-AzDeploymentManagerServiceUnit.md +--- + +# Set-AzDeploymentManagerServiceUnit + +## SYNOPSIS +Updates the service unit. + +## SYNTAX + +``` +Set-AzDeploymentManagerServiceUnit [-InputObject] <PSServiceUnitResource> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDeploymentManagerServiceUnit** cmdlet updates a service unit with the specified service unit object. +The cmdlet returns the updated service unit object. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDeploymentManagerServiceUnit -InputObject $serviceUnitObject +``` + +This command updates a service unit whose name, service name, service topology name and ResourceGroup match the Name, ServiceName, ServiceTopologyName and ResourceGroupName properties of the $serviceUnitObject, respectively. +The command returns the updated service unit object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The service unit object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSServiceUnitResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerStep.md b/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerStep.md new file mode 100644 index 0000000000..378130964f --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Set-AzDeploymentManagerStep.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/set-azdeploymentmanagerstep +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Set-AzDeploymentManagerStep.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Set-AzDeploymentManagerStep.md +--- + +# Set-AzDeploymentManagerStep + +## SYNOPSIS +Updates the step. + +## SYNTAX + +``` +Set-AzDeploymentManagerStep [-InputObject] <PSStepResource> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDeploymentManagerStep** cmdlet updates a step with the specified step object. +The cmdlet returns the updated step object. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDeploymentManagerStep -InputObject $stepObject +``` + +This command updates a step whose name and ResourceGroup match the Name and ResourceGroupName properties of the $stepObject, respectively. +The step would be updated to the properties set in the $stepObject. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The step object. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSStepResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeploymentManager/Stop-AzDeploymentManagerRollout.md b/azps-10.1.0/Az.DeploymentManager/Stop-AzDeploymentManagerRollout.md new file mode 100644 index 0000000000..5413ed414a --- /dev/null +++ b/azps-10.1.0/Az.DeploymentManager/Stop-AzDeploymentManagerRollout.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeploymentManager.dll-Help.xml +Module Name: Az.DeploymentManager +online version: https://learn.microsoft.com/powershell/module/az.deploymentmanager/stop-azdeploymentmanagerrollout +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Stop-AzDeploymentManagerRollout.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeploymentManager/DeploymentManager/help/Stop-AzDeploymentManagerRollout.md +--- + +# Stop-AzDeploymentManagerRollout + +## SYNOPSIS +Stops the rollout. + +## SYNTAX + +### Interactive (Default) +``` +Stop-AzDeploymentManagerRollout [-ResourceGroupName] <String> [-Name] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Stop-AzDeploymentManagerRollout [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Stop-AzDeploymentManagerRollout [-InputObject] <PSRollout> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzDeploymentManagerRollout** cmdlet stops a rollout in progress and returns an object that represents the current state of the rollout. +Specify the rollout by its name and resource group name. Alternately, you can provide the Rollout object or the ResourceId. + +Note that once a rollout is stopped, it cannot be resumed or restarted. You can only create a new rollout. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzDeploymentManagerRollout -ResourceGroupName ContosoResourceGroup -Name ContosoRollout +``` + +This command stops a rollout named ContosoRollout in the ContosoResourceGroup. + +### Example 2: Stop a rollout using the resource identifier +```powershell +Restart-AzDeploymentManagerRollout -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/rollouts/ContosoRollout" +``` + +This command stops a rollout named ContosoRollout in the ContosoResourceGroup. + +### Example 3: Stop a rollout using the rollout object. +```powershell +Get-AzDeploymentManagerRollout -InputObject $rolloutObject +``` + +This command stops a rollout whose name and ResourceGroup match the Name and ResourceGroupName properties of the $rolloutObject, respectively. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The rollout to be removed. + +```yaml +Type: Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the rollout. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout + +## OUTPUTS + +### Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DesktopVirtualization/Az.DesktopVirtualization.md b/azps-10.1.0/Az.DesktopVirtualization/Az.DesktopVirtualization.md new file mode 100644 index 0000000000..c6cc2af336 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Az.DesktopVirtualization.md @@ -0,0 +1,150 @@ +--- +Module Name: Az.DesktopVirtualization +Module Guid: 4cbade8e-48e0-42f8-a847-7872d0006d54 +Download Help Link: https://learn.microsoft.com/powershell/module/az.desktopvirtualization +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Az.DesktopVirtualization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Az.DesktopVirtualization.md +--- + +# Az.DesktopVirtualization Module +## Description +Microsoft Azure PowerShell: DesktopVirtualization cmdlets + +## Az.DesktopVirtualization Cmdlets +### [Disconnect-AzWvdUserSession](Disconnect-AzWvdUserSession.md) +Disconnect a userSession. + +### [Expand-AzWvdMsixImage](Expand-AzWvdMsixImage.md) +Expands and Lists MSIX packages in an Image, given the Image Path. + +### [Get-AzWvdApplication](Get-AzWvdApplication.md) +Get an application. + +### [Get-AzWvdApplicationGroup](Get-AzWvdApplicationGroup.md) +Get an application group. + +### [Get-AzWvdDesktop](Get-AzWvdDesktop.md) +Get a desktop. + +### [Get-AzWvdHostPool](Get-AzWvdHostPool.md) +Get a host pool. + +### [Get-AzWvdHostPoolRegistrationToken](Get-AzWvdHostPoolRegistrationToken.md) +Registration token of the host pool. + +### [Get-AzWvdMsixPackage](Get-AzWvdMsixPackage.md) +Get a msixpackage. + +### [Get-AzWvdRegistrationInfo](Get-AzWvdRegistrationInfo.md) +Get the Windows virtual desktop registration info. + +### [Get-AzWvdScalingPlan](Get-AzWvdScalingPlan.md) +Get a scaling plan. + +### [Get-AzWvdScalingPlanPooledSchedule](Get-AzWvdScalingPlanPooledSchedule.md) +Get a ScalingPlanPooledSchedule. + +### [Get-AzWvdSessionHost](Get-AzWvdSessionHost.md) +Get a session host. + +### [Get-AzWvdStartMenuItem](Get-AzWvdStartMenuItem.md) +List start menu items in the given application group. + +### [Get-AzWvdUserSession](Get-AzWvdUserSession.md) +Get a userSession. + +### [Get-AzWvdWorkspace](Get-AzWvdWorkspace.md) +Get a workspace. + +### [New-AzWvdApplication](New-AzWvdApplication.md) +Create or update an application. + +### [New-AzWvdApplicationGroup](New-AzWvdApplicationGroup.md) +Create or update an applicationGroup. + +### [New-AzWvdHostPool](New-AzWvdHostPool.md) +Create or update a host pool. + +### [New-AzWvdMsixPackage](New-AzWvdMsixPackage.md) +Create or update a MSIX package. + +### [New-AzWvdRegistrationInfo](New-AzWvdRegistrationInfo.md) +Create Windows virtual desktop registration info. + +### [New-AzWvdScalingPlan](New-AzWvdScalingPlan.md) +Create or update a scaling plan. + +### [New-AzWvdScalingPlanPooledSchedule](New-AzWvdScalingPlanPooledSchedule.md) +Create or update a ScalingPlanPooledSchedule. + +### [New-AzWvdWorkspace](New-AzWvdWorkspace.md) +Create or update a workspace. + +### [Register-AzWvdApplicationGroup](Register-AzWvdApplicationGroup.md) +Register a Windows virtual desktop application group. + +### [Remove-AzWvdApplication](Remove-AzWvdApplication.md) +Remove an application. + +### [Remove-AzWvdApplicationGroup](Remove-AzWvdApplicationGroup.md) +Remove an applicationGroup. + +### [Remove-AzWvdHostPool](Remove-AzWvdHostPool.md) +Remove a host pool. + +### [Remove-AzWvdMsixPackage](Remove-AzWvdMsixPackage.md) +Remove an MSIX Package. + +### [Remove-AzWvdRegistrationInfo](Remove-AzWvdRegistrationInfo.md) +Remove the Windows virtual desktop registration info. + +### [Remove-AzWvdScalingPlan](Remove-AzWvdScalingPlan.md) +Remove a scaling plan. + +### [Remove-AzWvdScalingPlanPooledSchedule](Remove-AzWvdScalingPlanPooledSchedule.md) +Remove a ScalingPlanPooledSchedule. + +### [Remove-AzWvdSessionHost](Remove-AzWvdSessionHost.md) +Remove a SessionHost. + +### [Remove-AzWvdUserSession](Remove-AzWvdUserSession.md) +Remove a userSession. + +### [Remove-AzWvdWorkspace](Remove-AzWvdWorkspace.md) +Remove a workspace. + +### [Send-AzWvdUserSessionMessage](Send-AzWvdUserSessionMessage.md) +Send a message to a user. + +### [Unregister-AzWvdApplicationGroup](Unregister-AzWvdApplicationGroup.md) +Unregister the Windows virtual desktop application group. + +### [Update-AzWvdApplication](Update-AzWvdApplication.md) +Update an application. + +### [Update-AzWvdApplicationGroup](Update-AzWvdApplicationGroup.md) +Update an applicationGroup. + +### [Update-AzWvdDesktop](Update-AzWvdDesktop.md) +Update a desktop. + +### [Update-AzWvdHostPool](Update-AzWvdHostPool.md) +Update a host pool. + +### [Update-AzWvdMsixPackage](Update-AzWvdMsixPackage.md) +Update an MSIX Package. + +### [Update-AzWvdScalingPlan](Update-AzWvdScalingPlan.md) +Update a scaling plan. + +### [Update-AzWvdScalingPlanPooledSchedule](Update-AzWvdScalingPlanPooledSchedule.md) +Update a ScalingPlanPooledSchedule. + +### [Update-AzWvdSessionHost](Update-AzWvdSessionHost.md) +Update a session host. + +### [Update-AzWvdWorkspace](Update-AzWvdWorkspace.md) +Update a workspace. + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Disconnect-AzWvdUserSession.md b/azps-10.1.0/Az.DesktopVirtualization/Disconnect-AzWvdUserSession.md new file mode 100644 index 0000000000..354ddc9707 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Disconnect-AzWvdUserSession.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/disconnect-azwvdusersession +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Disconnect-AzWvdUserSession.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Disconnect-AzWvdUserSession.md +--- + +# Disconnect-AzWvdUserSession + +## SYNOPSIS +Disconnect a userSession. + +## SYNTAX + +### Disconnect (Default) +``` +Disconnect-AzWvdUserSession -HostPoolName <String> -Id <String> -ResourceGroupName <String> + -SessionHostName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### DisconnectViaIdentity +``` +Disconnect-AzWvdUserSession -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Disconnect a userSession. + +## EXAMPLES + +### Example 1: Disconnect a Windows Virtual Desktop UserSession by name +```powershell +Disconnect-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName -Id 2 +``` + +This command disconnects a Windows Virtual Desktop UserSession in a Session Host. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: Disconnect +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The name of the user session within the specified session host + +```yaml +Type: System.String +Parameter Sets: Disconnect +Aliases: UserSessionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: DisconnectViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Disconnect +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionHostName +The name of the session host within the specified host pool + +```yaml +Type: System.String +Parameter Sets: Disconnect +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Disconnect +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Expand-AzWvdMsixImage.md b/azps-10.1.0/Az.DesktopVirtualization/Expand-AzWvdMsixImage.md new file mode 100644 index 0000000000..187d34a8c4 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Expand-AzWvdMsixImage.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/expand-azwvdmsiximage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Expand-AzWvdMsixImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Expand-AzWvdMsixImage.md +--- + +# Expand-AzWvdMsixImage + +## SYNOPSIS +Expands and Lists MSIX packages in an Image, given the Image Path. + +## SYNTAX + +### ExpandExpanded (Default) +``` +Expand-AzWvdMsixImage -HostPoolName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Uri <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Expand +``` +Expand-AzWvdMsixImage -HostPoolName <String> -ResourceGroupName <String> -MsixImageUri <IMsixImageUri> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ExpandViaIdentity +``` +Expand-AzWvdMsixImage -InputObject <IDesktopVirtualizationIdentity> -MsixImageUri <IMsixImageUri> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ExpandViaIdentityExpanded +``` +Expand-AzWvdMsixImage -InputObject <IDesktopVirtualizationIdentity> [-Uri <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Expands and Lists MSIX packages in an Image, given the Image Path. + +## EXAMPLES + +### Example 1: Expands specified Image Path and retrieves Package metadata found in AppxManifest.xml +```powershell +Expand-AzWvdMsixImage -HostPoolName HostPoolName ` + -ResourceGroupName resourceGroupName ` + -SubscriptionId SubscriptionId ` + -Uri ImagePathURI +``` + +```output +Name Type +---- ---- +HostPoolName/extractmsiximage Microsoft.DesktopVirtualization/hostpools/extractmsiximage +``` + +This command returns Metadata of MSIX Package found in the given Image Path. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: Expand, ExpandExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: ExpandViaIdentity, ExpandViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MsixImageUri +Represents URI referring to MSIX Image +To construct, see NOTES section for MSIXIMAGEURI properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IMsixImageUri +Parameter Sets: Expand, ExpandViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Expand, ExpandExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Expand, ExpandExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +URI to Image + +```yaml +Type: System.String +Parameter Sets: ExpandExpanded, ExpandViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IMsixImageUri + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IExpandMsixImage + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +`MSIXIMAGEURI <IMsixImageUri>`: Represents URI referring to MSIX Image + - `[Uri <String>]`: URI to Image + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdApplication.md b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdApplication.md new file mode 100644 index 0000000000..8b833d668c --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdApplication.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvdapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdApplication.md +--- + +# Get-AzWvdApplication + +## SYNOPSIS +Get an application. + +## SYNTAX + +### List (Default) +``` +Get-AzWvdApplication -GroupName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-InitialSkip <Int32>] [-IsDescending] [-PageSize <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWvdApplication -GroupName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWvdApplication -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get an application. + +## EXAMPLES + +### Example 1: Get a Windows Virtual Desktop Application by name +```powershell +Get-AzWvdApplication -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name ApplicationName +``` + +```output +Name Type +---- ---- +ApplicationGroupName/ApplicationName Microsoft.DesktopVirtualization/applicationgroups/applications +``` + +This command gets a Windows Virtual Desktop Application in an applicaton Group. + +### Example 2: List Windows Virtual Desktop Applications +```powershell +Get-AzWvdApplication -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName +``` + +```output +Name Type +---- ---- +ApplicationGroupName/ApplicationName1 Microsoft.DesktopVirtualization/applicationgroups/applications +ApplicationGroupName/ApplicationName2 Microsoft.DesktopVirtualization/applicationgroups/applications +``` + +This command Lists Windows Virtual Desktop Applications in an applicaton Group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +The name of the application group + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: ApplicationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialSkip +Initial number of items to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsDescending +Indicates whether the collection is descending. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the application within the specified application group + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ApplicationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of items per page. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IApplication + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdApplicationGroup.md b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdApplicationGroup.md new file mode 100644 index 0000000000..1fdf1d1143 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdApplicationGroup.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvdapplicationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdApplicationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdApplicationGroup.md +--- + +# Get-AzWvdApplicationGroup + +## SYNOPSIS +Get an application group. + +## SYNTAX + +### List1 (Default) +``` +Get-AzWvdApplicationGroup [-SubscriptionId <String[]>] [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzWvdApplicationGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWvdApplicationGroup -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzWvdApplicationGroup -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Filter <String>] + [-InitialSkip <Int32>] [-IsDescending] [-PageSize <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get an application group. + +## EXAMPLES + +### Example 1: Get a Windows Virtual Desktop ApplicationGroup by name +```powershell +Get-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName -Name ApplicationGroupName +``` + +```output +Location Name Type +-------- ---- ---- +eastus ApplicationGroupName Microsoft.DesktopVirtualization/applicationgroups +``` + +This command gets a Windows Virtual Desktop ApplicationGroup in a Resource Group. + +### Example 2: List Windows Virtual Desktop ApplicationGroups +```powershell +Get-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName +``` + +```output +Location Name Type +-------- ---- ---- +eastus ApplicationGroupName1 Microsoft.DesktopVirtualization/applicationgroups +eastus ApplicationGroupName2 Microsoft.DesktopVirtualization/applicationgroups +``` + +This command lists a Windows Virtual Desktop ApplicationGroups in a Resource Group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +OData filter expression. +Valid properties for filtering are applicationGroupType. + +```yaml +Type: System.String +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialSkip +Initial number of items to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsDescending +Indicates whether the collection is descending. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the application group + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ApplicationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of items per page. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IApplicationGroup + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdDesktop.md b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdDesktop.md new file mode 100644 index 0000000000..8477ab1ece --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdDesktop.md @@ -0,0 +1,242 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvddesktop +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdDesktop.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdDesktop.md +--- + +# Get-AzWvdDesktop + +## SYNOPSIS +Get a desktop. + +## SYNTAX + +### List (Default) +``` +Get-AzWvdDesktop -ApplicationGroupName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-InitialSkip <Int32>] [-IsDescending] [-PageSize <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWvdDesktop -ApplicationGroupName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWvdDesktop -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a desktop. + +## EXAMPLES + +### Example 1: Get a Windows Virtual Desktop Desktop by name +```powershell +Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name DesktopName +``` + +```output +Name Type +---- ---- +ApplicationGroupName/DesktopName Microsoft.DesktopVirtualization/applicationgroups/desktops +``` + +This command gets a Windows Virtual Desktop Desktop in an applicaton Group. + +### Example 2: List Windows Virtual Desktop Desktops +```powershell +Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName +``` + +```output +Name Type +---- ---- +ApplicationGroupName/DesktopName Microsoft.DesktopVirtualization/applicationgroups/desktops +``` + +This command listsWindows Virtual Desktop Desktops in an applicaton Group. + +## PARAMETERS + +### -ApplicationGroupName +The name of the application group + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialSkip +Initial number of items to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsDescending +Indicates whether the collection is descending. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the desktop within the specified desktop group + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DesktopName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of items per page. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IDesktop + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdHostPool.md b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdHostPool.md new file mode 100644 index 0000000000..caffbbc066 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdHostPool.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvdhostpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdHostPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdHostPool.md +--- + +# Get-AzWvdHostPool + +## SYNOPSIS +Get a host pool. + +## SYNTAX + +### List1 (Default) +``` +Get-AzWvdHostPool [-SubscriptionId <String[]>] [-InitialSkip <Int32>] [-IsDescending] [-PageSize <Int32>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWvdHostPool -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWvdHostPool -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzWvdHostPool -ResourceGroupName <String> [-SubscriptionId <String[]>] [-InitialSkip <Int32>] + [-IsDescending] [-PageSize <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a host pool. + +## EXAMPLES + +### Example 1: Get a Windows Virtual Desktop HostPool by name +```powershell +Get-AzWvdHostPool -ResourceGroupName ResourceGroupName -Name HostPoolName +``` + +```output +Location Name Type +-------- ---- ---- +eastus HostPoolName Microsoft.DesktopVirtualization/hostpools +``` + +This command gets a Windows Virtual Desktop HostPool in a Resource Group. + +### Example 2: List Windows Virtual Desktop HostPools +```powershell +Get-AzWvdHostPool -ResourceGroupName ResourceGroupName +``` + +```output +Location Name Type +-------- ---- ---- +eastus HostPoolName1 Microsoft.DesktopVirtualization/hostpools +eastus HostPoolName2 Microsoft.DesktopVirtualization/hostpools +``` + +This command lists a Windows Virtual Desktop HostPools in a Resource Group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialSkip +Initial number of items to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List, List1 +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.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsDescending +Indicates whether the collection is descending. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: HostPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of items per page. + +```yaml +Type: System.Int32 +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IHostPool + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdHostPoolRegistrationToken.md b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdHostPoolRegistrationToken.md new file mode 100644 index 0000000000..1d15a8ad3d --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdHostPoolRegistrationToken.md @@ -0,0 +1,194 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvdhostpoolregistrationtoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdHostPoolRegistrationToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdHostPoolRegistrationToken.md +--- + +# Get-AzWvdHostPoolRegistrationToken + +## SYNOPSIS +Registration token of the host pool. + +## SYNTAX + +### Retrieve (Default) +``` +Get-AzWvdHostPoolRegistrationToken -HostPoolName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RetrieveViaIdentity +``` +Get-AzWvdHostPoolRegistrationToken -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Registration token of the host pool. + +## EXAMPLES + +### Example 1: Get Windows Virtual Desktop registration token information by HostPoolName +```powershell +Get-AzWvdHostPoolRegistrationToken -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName +``` + +```output +ExpirationTime RegistrationTokenOperation Token +-------------- -------------------------- ----- +4/1/2020 10:19:33 PM None eyJhbGciOiJSUzI1NiIsImtpZCI6IkMyRjU1RUYxNzg0MEFCNzkzMDk2RUYzRjdEMkNBRDk0NThGNDhEOTQiLCJ0eXAiOiJKV1QifQ.eyJSZWdpc3RyYXRpb25JZCI6IjU5NGJjZWUwLTk5MjQtNDg3ZC1iOW... +``` + +This command gets Windows Virtual Desktop registration token information from a HostPool. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: Retrieve +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: RetrieveViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Retrieve +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Retrieve +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IRegistrationInfo + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdMsixPackage.md b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdMsixPackage.md new file mode 100644 index 0000000000..c32ede4719 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdMsixPackage.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvdmsixpackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdMsixPackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdMsixPackage.md +--- + +# Get-AzWvdMsixPackage + +## SYNOPSIS +Get a msixpackage. + +## SYNTAX + +### List (Default) +``` +Get-AzWvdMsixPackage -HostPoolName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-InitialSkip <Int32>] [-IsDescending] [-PageSize <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWvdMsixPackage -FullName <String> -HostPoolName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWvdMsixPackage -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a msixpackage. + +## EXAMPLES + +### Example 1: Get a MSIX Package by Name +```powershell +Get-AzWvdMsixPackage -HostPoolName HostPoolName -ResourceGroupName ResourceGroupName -SubscriptionId SubscriptionId -FullName PackageFullName +``` + +```output +Name Type +---- ---- +HostPoolName/MSIXPackage_FullName Microsoft.DesktopVirtualization/hostpools/msixpackages +``` + +This command gets a MSIX Package in a HostPool. + +### Example 2: List MSIX Packages +```powershell +Get-AzWvdMsixPackage -HostPoolName HostPoolName -ResourceGroupName ResourceGroupName -SubscriptionId SubscriptionId +``` + +```output +Name Type +---- ---- +HostPoolName/MSIXPackage_FullName1 Microsoft.DesktopVirtualization/hostpools/msixpackages +HostPoolName/MSIXPackage_FullName2 Microsoft.DesktopVirtualization/hostpools/msixpackages +HostPoolName/MSIXPackage_FullName3 Microsoft.DesktopVirtualization/hostpools/msixpackages +``` + +This command Lists MSIX Packages in a HostPool. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullName +The version specific package full name of the MSIX package within specified hostpool + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: MsixPackageFullName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialSkip +Initial number of items to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsDescending +Indicates whether the collection is descending. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of items per page. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IMsixPackage + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdRegistrationInfo.md b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdRegistrationInfo.md new file mode 100644 index 0000000000..76f57085e5 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdRegistrationInfo.md @@ -0,0 +1,130 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvdregistrationinfo +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdRegistrationInfo.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdRegistrationInfo.md +--- + +# Get-AzWvdRegistrationInfo + +## SYNOPSIS +Get the Windows virtual desktop registration info. + +## SYNTAX + +``` +Get-AzWvdRegistrationInfo -HostPoolName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the Windows virtual desktop registration info. + +## EXAMPLES + +### Example 1: Get Existing Registration Info from Hostpool +```powershell +Get-AzWvdRegistrationInfo -ResourceGroupName rgName -HostPoolName hpName +``` + +```output +ExpirationTime RegistrationTokenOperation Token +-------------- -------------------------- ----- +5/10/2023 12:00:00 PM None <base64 encoded string> + +``` + +Retrieves Registration Info for the chosen hostpool. + +### Example 2: Get Empty Registration Info from HostPool +```powershell +Get-AzWvdRegistrationInfo -ResourceGroupName rgName -HostPoolname hpName +``` + +```output +ExpirationTime RegistrationTokenOperation Token +-------------- -------------------------- ----- + None +``` + +Returns an empty Registration Info for the chosen Hostpool if the Hostpool doesn't have any Registration Info. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +Host Pool Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.RegistrationInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdScalingPlan.md b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdScalingPlan.md new file mode 100644 index 0000000000..9a3a7dfcc2 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdScalingPlan.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvdscalingplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdScalingPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdScalingPlan.md +--- + +# Get-AzWvdScalingPlan + +## SYNOPSIS +Get a scaling plan. + +## SYNTAX + +### List1 (Default) +``` +Get-AzWvdScalingPlan [-SubscriptionId <String[]>] [-InitialSkip <Int32>] [-IsDescending] [-PageSize <Int32>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWvdScalingPlan -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWvdScalingPlan -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzWvdScalingPlan -ResourceGroupName <String> [-SubscriptionId <String[]>] [-InitialSkip <Int32>] + [-IsDescending] [-PageSize <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List2 +``` +Get-AzWvdScalingPlan -HostPoolName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-InitialSkip <Int32>] [-IsDescending] [-PageSize <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a scaling plan. + +## EXAMPLES + +### Example 1: Get a Windows Virtual Desktop Scaling Plan by name +```powershell +Get-AzWvdScalingPlan -ResourceGroupName ResourceGroupName -Name scalingPlan1 +``` + +```output +Location Name Type +-------- ---- ---- +westcentralus scalingPlan1 Microsoft.DesktopVirtualization/scalingplans +``` + +This command gets a Windows Virtual Desktop Scaling Plan in a Resource Group. + +### Example 2: List Windows Virtual Desktop Scaling Plans +```powershell +Get-AzWvdScalingPlan -ResourceGroupName ResourceGroupName +``` + +```output +Location Name Type +-------- ---- ---- +westcentralus scalingPlan1 Microsoft.DesktopVirtualization/scalingplans +westcentralus scalingPlan2 Microsoft.DesktopVirtualization/scalingplans +``` + +This command lists all the Windows Virtual Desktop Scaling Plans in a Resource Group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialSkip +Initial number of items to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List, List1, List2 +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.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsDescending +Indicates whether the collection is descending. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List, List1, List2 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the scaling plan. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ScalingPlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of items per page. + +```yaml +Type: System.Int32 +Parameter Sets: List, List1, List2 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1, List2 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IScalingPlan + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdScalingPlanPooledSchedule.md b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdScalingPlanPooledSchedule.md new file mode 100644 index 0000000000..59014674e4 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdScalingPlanPooledSchedule.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvdscalingplanpooledschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdScalingPlanPooledSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdScalingPlanPooledSchedule.md +--- + +# Get-AzWvdScalingPlanPooledSchedule + +## SYNOPSIS +Get a ScalingPlanPooledSchedule. + +## SYNTAX + +### List (Default) +``` +Get-AzWvdScalingPlanPooledSchedule -ResourceGroupName <String> -ScalingPlanName <String> + [-SubscriptionId <String[]>] [-InitialSkip <Int32>] [-IsDescending] [-PageSize <Int32>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWvdScalingPlanPooledSchedule -ResourceGroupName <String> -ScalingPlanName <String> + -ScalingPlanScheduleName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWvdScalingPlanPooledSchedule -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a ScalingPlanPooledSchedule. + +## EXAMPLES + +### Example 1: Get a Scaling Plan Pooled Schedule +```powershell +Get-AzWvdScalingPlanPooledSchedule -ResourceGroupName rgName -ScalingPlanName scalingPlan1 +``` + +```output +Name +---- +scalingPlan1/weekdays_schedule +scalingPlan1/PooledSchedule1 +``` + +Gets an existing ScalingPlanPooledSchedule. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialSkip +Initial number of items to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsDescending +Indicates whether the collection is descending. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of items per page. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScalingPlanName +The name of the scaling plan. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScalingPlanScheduleName +The name of the ScalingPlanSchedule + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IScalingPlanPooledSchedule + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdSessionHost.md b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdSessionHost.md new file mode 100644 index 0000000000..812b223e24 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdSessionHost.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvdsessionhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdSessionHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdSessionHost.md +--- + +# Get-AzWvdSessionHost + +## SYNOPSIS +Get a session host. + +## SYNTAX + +### List (Default) +``` +Get-AzWvdSessionHost -HostPoolName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-InitialSkip <Int32>] [-IsDescending] [-PageSize <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWvdSessionHost -HostPoolName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWvdSessionHost -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a session host. + +## EXAMPLES + +### Example 1: Get a Windows Virtual Desktop SessionHost by name +```powershell +Get-AzWvdSessionHost -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -Name SessionHostName +``` + +```output +Name Type +---- ---- +HostPoolName/SessionHostName Microsoft.DesktopVirtualization/hostpools/sessionhosts +``` + +This command gets a Windows Virtual Desktop SessionHost in a Host Pool. + +### Example 2: List Windows Virtual Desktop SessionHosts +```powershell +Get-AzWvdSessionHost -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName +``` + +```output +Name Type +---- ---- +HostPoolName/SessionHostName1 Microsoft.DesktopVirtualization/hostpools/sessionhosts +HostPoolName/SessionHostName2 Microsoft.DesktopVirtualization/hostpools/sessionhosts +``` + +This command lists a Windows Virtual Desktop SessionHosts in a Host Pool. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialSkip +Initial number of items to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsDescending +Indicates whether the collection is descending. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the session host within the specified host pool + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SessionHostName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of items per page. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.ISessionHost + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdStartMenuItem.md b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdStartMenuItem.md new file mode 100644 index 0000000000..3d3aea6fec --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdStartMenuItem.md @@ -0,0 +1,166 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvdstartmenuitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdStartMenuItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdStartMenuItem.md +--- + +# Get-AzWvdStartMenuItem + +## SYNOPSIS +List start menu items in the given application group. + +## SYNTAX + +``` +Get-AzWvdStartMenuItem -ApplicationGroupName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-InitialSkip <Int32>] [-IsDescending] [-PageSize <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List start menu items in the given application group. + +## EXAMPLES + +### Example 2: List Windows Virtual Desktop Start Menu Items +```powershell +Get-AzWvdStartMenuItem -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName +``` + +```output +Name Type +---- ---- +ApplicationGroupName/Character Map Microsoft.DesktopVirtualization/applicationgroups/startmenuitems +ApplicationGroupName/Defragment and Optimize Drives Microsoft.DesktopVirtualization/applicationgroups/startmenuitems +ApplicationGroupName/Disk Cleanup Microsoft.DesktopVirtualization/applicationgroups/startmenuitems +ApplicationGroupName/Internet Explorer Microsoft.DesktopVirtualization/applicationgroups/startmenuitems +``` + +This command Lists Windows Virtual Desktop Start Menu Items in an applicaton Group. + +## PARAMETERS + +### -ApplicationGroupName +The name of the application group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialSkip +Initial number of items to skip. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDescending +Indicates whether the collection is descending. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of items per page. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IStartMenuItem + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdUserSession.md b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdUserSession.md new file mode 100644 index 0000000000..e4b03ecee3 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdUserSession.md @@ -0,0 +1,296 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvdusersession +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdUserSession.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdUserSession.md +--- + +# Get-AzWvdUserSession + +## SYNOPSIS +Get a userSession. + +## SYNTAX + +### List (Default) +``` +Get-AzWvdUserSession -HostPoolName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Filter <String>] [-InitialSkip <Int32>] [-IsDescending] [-PageSize <Int32>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzWvdUserSession -HostPoolName <String> -Id <String> -ResourceGroupName <String> -SessionHostName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWvdUserSession -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzWvdUserSession -HostPoolName <String> -ResourceGroupName <String> -SessionHostName <String> + [-SubscriptionId <String[]>] [-InitialSkip <Int32>] [-IsDescending] [-PageSize <Int32>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a userSession. + +## EXAMPLES + +### Example 1: Get a Windows Virtual Desktop UserSession by name +```powershell +Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName -Id 2 +``` + +```output +Name Type +---- ---- +HostPoolName/SessionHostName/2 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions +``` + +This command gets a Windows Virtual Desktop UserSession in a Session Host. + +### Example 2: List Windows Virtual Desktop UserSessions +```powershell +Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName +``` + +```output +Name Type +---- ---- +HostPoolName/SessionHostName/2 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions +HostPoolName/SessionHostName/3 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions +``` + +This command lists a Windows Virtual Desktop UserSessions in a Session Host. + +### Example 3: List Windows Virtual Desktop UserSessions in host pool +```powershell +Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName +``` + +```output +Name Type +---- ---- +HostPoolName/SessionHostName/2 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions +HostPoolName/SessionHostName/3 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions +``` + +This command lists a Windows Virtual Desktop UserSessions in a Session Host in a host pool. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +OData filter expression. +Valid properties for filtering are userprincipalname and sessionstate. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: Get, List, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The name of the user session within the specified session host + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: UserSessionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialSkip +Initial number of items to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List, List1 +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.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsDescending +Indicates whether the collection is descending. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of items per page. + +```yaml +Type: System.Int32 +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionHostName +The name of the session host within the specified host pool + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IUserSession + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdWorkspace.md b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdWorkspace.md new file mode 100644 index 0000000000..e00fa9514a --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Get-AzWvdWorkspace.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvdworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Get-AzWvdWorkspace.md +--- + +# Get-AzWvdWorkspace + +## SYNOPSIS +Get a workspace. + +## SYNTAX + +### List1 (Default) +``` +Get-AzWvdWorkspace [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWvdWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWvdWorkspace -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzWvdWorkspace -ResourceGroupName <String> [-SubscriptionId <String[]>] [-InitialSkip <Int32>] + [-IsDescending] [-PageSize <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a workspace. + +## EXAMPLES + +### Example 1: Get a Windows Virtual Desktop Workspace by name +```powershell +Get-AzWvdWorkspace -ResourceGroupName ResourceGroupName -Name WorkspaceName +``` + +```output +Location Name Type +-------- ---- ---- +eastus WorkspaceName Microsoft.DesktopVirtualization/workspaces +``` + +This command gets a Windows Virtual Desktop Workspace in a Resource Group. + +### Example 2: List Windows Virtual Desktop Workspaces +```powershell +Get-AzWvdWorkspace -ResourceGroupName ResourceGroupName +``` + +```output +Location Name Type +-------- ---- ---- +eastus WorkspaceName1 Microsoft.DesktopVirtualization/workspaces +eastus WorkspaceName2 Microsoft.DesktopVirtualization/workspaces +``` + +This command lists a Windows Virtual Desktop Workspaces in a Resource Group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialSkip +Initial number of items to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsDescending +Indicates whether the collection is descending. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of items per page. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IWorkspace + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdApplication.md b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdApplication.md new file mode 100644 index 0000000000..aeae59f696 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdApplication.md @@ -0,0 +1,364 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/new-azwvdapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdApplication.md +--- + +# New-AzWvdApplication + +## SYNOPSIS +Create or update an application. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzWvdApplication -CommandLineSetting <CommandLineSetting> -GroupName <String> -Name <String> + -ResourceGroupName <String> [-Description <String>] [-FriendlyName <String>] [-ShowInPortal] + [-SubscriptionId <String>] [-ApplicationType <RemoteApplicationType>] [-CommandLineArgument <String>] + [-FilePath <String>] [-IconIndex <Int32>] [-IconPath <String>] [-MsixPackageApplicationId <String>] + [-MsixPackageFamilyName <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### AppAlias +``` +New-AzWvdApplication -AppAlias <String> -CommandLineSetting <CommandLineSetting> -GroupName <String> + -Name <String> -ResourceGroupName <String> [-Description <String>] [-FriendlyName <String>] [-ShowInPortal] + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update an application. + +## EXAMPLES + +### Example 1: Create a Windows Virtual Desktop Application +```powershell +New-AzWvdApplication -ResourceGroupName ResourceGroupName ` + -GroupName ApplicationGroupName ` + -Name ApplicationName ` + -FilePath 'C:\windows\system32\mspaint.exe' ` + -FriendlyName 'Friendly name' ` + -Description 'Description' ` + -IconIndex 0 ` + -IconPath 'C:\windows\system32\mspaint.exe' ` + -CommandLineSetting 'Allow' ` + -ShowInPortal:$true +``` + +```output +Name Type +---- ---- +ApplicationGroupName/ApplicationName Microsoft.DesktopVirtualization/applicationgroups/applications +``` + +This command creates a Windows Virtual Desktop Application in an applicaton Group. + +## PARAMETERS + +### -AppAlias +App Alias from start menu item + +```yaml +Type: System.String +Parameter Sets: AppAlias +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationType +Resource Type of Application. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.RemoteApplicationType +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandLineArgument +Command Line Arguments for Application. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandLineSetting +Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.CommandLineSetting +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of Application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +Specifies a path for the executable file for the application. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Friendly name of Application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +The name of the application group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IconIndex +Index of the icon. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IconPath +Path to icon. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsixPackageApplicationId +Specifies the package application Id for MSIX applications + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsixPackageFamilyName +Specifies the package family name for MSIX applications + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the application within the specified application group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowInPortal +Specifies whether to show the RemoteApp program in the RD Web Access server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IApplication + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdApplicationGroup.md b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdApplicationGroup.md new file mode 100644 index 0000000000..a29696e3ce --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdApplicationGroup.md @@ -0,0 +1,477 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/new-azwvdapplicationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdApplicationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdApplicationGroup.md +--- + +# New-AzWvdApplicationGroup + +## SYNOPSIS +Create or update an applicationGroup. + +## SYNTAX + +``` +New-AzWvdApplicationGroup -Name <String> -ResourceGroupName <String> + -ApplicationGroupType <ApplicationGroupType> -HostPoolArmPath <String> [-SubscriptionId <String>] + [-Description <String>] [-FriendlyName <String>] [-IdentityType <ResourceIdentityType>] [-Kind <String>] + [-Location <String>] [-ManagedBy <String>] [-PlanName <String>] [-PlanProduct <String>] + [-PlanPromotionCode <String>] [-PlanPublisher <String>] [-PlanVersion <String>] [-SkuCapacity <Int32>] + [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update an applicationGroup. + +## EXAMPLES + +### Example 1: Create a Windows Virtual Desktop ApplicationGroup by name +```powershell +New-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName ` + -Name ApplicationGroupName ` + -Location 'eastus' ` + -FriendlyName 'Friendly Name' ` + -Description 'Description' ` + -HostPoolArmPath '/subscriptions/SubscriptionId/resourcegroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName' ` + -ApplicationGroupType 'RemoteApp' +``` + +```output +Location Name Type +-------- ---- ---- +eastus ApplicationGroupName Microsoft.DesktopVirtualization/applicationgroups +``` + +This command creates a Windows Virtual Desktop ApplicationGroup in a Resource Group. + +### Example 2: Create a Windows Virtual Desktop ApplicationGroup by name +```powershell +New-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName ` + -Name ApplicationGroupName ` + -Location 'eastus' ` + -FriendlyName 'Friendly Name' ` + -Description 'Description' ` + -HostPoolArmPath '/subscriptions/SubscriptionId/resourcegroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName' ` + -ApplicationGroupType 'Desktop' +``` + +```output +Location Name Type +-------- ---- ---- +eastus ApplicationGroupName Microsoft.DesktopVirtualization/applicationgroups +``` + +This command creates a Windows Virtual Desktop ApplicationGroup in a Resource Group. + +## PARAMETERS + +### -ApplicationGroupType +Resource Type of ApplicationGroup. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.ApplicationGroupType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of ApplicationGroup. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Friendly name of ApplicationGroup. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolArmPath +HostPool arm path of ApplicationGroup. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. +ApiApps are a kind of Microsoft.Web/sites type. +If supported, the resource provider must validate and persist this value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedBy +The fully qualified resource ID of the resource that manages this resource. +Indicates if this resource is managed by another Azure resource. +If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the application group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanName +A user defined name of the 3rd Party Artifact that is being procured. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanProduct +The 3rd Party artifact that is being procured. +E.g. +NewRelic. +Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanPromotionCode +A publisher provided promotion code as provisioned in Data Market for the said product/artifact. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanPublisher +The publisher of the 3rd Party Artifact that is being bought. +E.g. +NewRelic + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanVersion +The version of the desired product/artifact. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SkuTier +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IApplicationGroup + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdHostPool.md b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdHostPool.md new file mode 100644 index 0000000000..acca6729b7 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdHostPool.md @@ -0,0 +1,842 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/new-azwvdhostpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdHostPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdHostPool.md +--- + +# New-AzWvdHostPool + +## SYNOPSIS +Create or update a host pool. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzWvdHostPool -HostPoolType <HostPoolType> -LoadBalancerType <LoadBalancerType> -Name <String> + -PreferredAppGroupType <PreferredAppGroupType> -ResourceGroupName <String> [-Location <String>] + [-SubscriptionId <String>] [-AgentUpdateMaintenanceWindow <IMaintenanceWindowProperties[]>] + [-AgentUpdateMaintenanceWindowTimeZone <String>] [-AgentUpdateType <SessionHostComponentUpdateType>] + [-AgentUpdateUseSessionHostLocalTime] [-CustomRdpProperty <String>] [-Description <String>] + [-ExpirationTime <DateTime>] [-FriendlyName <String>] [-IdentityType <ResourceIdentityType>] [-Kind <String>] + [-ManagedBy <String>] [-MaxSessionLimit <Int32>] + [-PersonalDesktopAssignmentType <PersonalDesktopAssignmentType>] [-PlanName <String>] [-PlanProduct <String>] + [-PlanPromotionCode <String>] [-PlanPublisher <String>] [-PlanVersion <String>] + [-RegistrationInfoToken <String>] [-RegistrationTokenOperation <RegistrationTokenOperation>] [-Ring <Int32>] + [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] + [-SsoadfsAuthority <String>] [-SsoClientId <String>] [-SsoClientSecretKeyVaultPath <String>] + [-SsoSecretType <SsoSecretType>] [-StartVMOnConnect] [-Tag <Hashtable>] [-ValidationEnvironment] + [-VMTemplate <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### FullSenerioCreate +``` +New-AzWvdHostPool -HostPoolType <HostPoolType> -LoadBalancerType <LoadBalancerType> -Location <String> + -Name <String> -PreferredAppGroupType <PreferredAppGroupType> -ResourceGroupName <String> + [-DesktopAppGroupName <String>] [-SubscriptionId <String>] [-WorkspaceName <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a host pool. + +## EXAMPLES + +### Example 1: Create a Windows Virtual Desktop HostPool by name +```powershell +New-AzWvdHostPool -ResourceGroupName ResourceGroupName ` + -Name HostPoolName ` + -Location 'eastus' ` + -HostPoolType 'Pooled' ` + -LoadBalancerType 'DepthFirst' ` + -RegistrationTokenOperation 'Update' ` + -ExpirationTime $((Get-Date).ToUniversalTime().AddDays(1).ToString('yyyy-MM-ddTHH:mm:ss.fffffffZ')) ` + -Description 'Description' ` + -FriendlyName 'Friendly Name' ` + -MaxSessionLimit 5 ` + -VMTemplate $null ` + -SsoClientId $null ` + -SsoClientSecretKeyVaultPath $null ` + -SsoSecretType $null ` + -SsoadfsAuthority $null ` + -CustomRdpProperty $null ` + -Ring $null ` + -ValidationEnvironment:$false +``` + +```output +Location Name Type +-------- ---- ---- +eastus HostPoolName Microsoft.DesktopVirtualization/hostpools +``` + +This command creates a Windows Virtual Desktop HostPool in a Resource Group. + +### Example 2: Create a Windows Virtual Desktop HostPool by name +```powershell +New-AzWvdHostPool -ResourceGroupName ResourceGroupName ` + -Name HostPoolName ` + -Location 'eastus' ` + -HostPoolType 'Personal' ` + -LoadBalancerType 'Persistent' ` + -RegistrationTokenOperation 'Update' ` + -ExpirationTime $((Get-Date).ToUniversalTime().AddDays(1).ToString('yyyy-MM-ddTHH:mm:ss.fffffffZ')) ` + -Description 'Description' ` + -FriendlyName 'Friendly Name' ` + -MaxSessionLimit 5 ` + -VMTemplate $null ` + -SsoClientId $null ` + -SsoClientSecretKeyVaultPath $null ` + -SsoSecretType $null ` + -SsoadfsAuthority $null ` + -CustomRdpProperty $null ` + -Ring $null ` + -ValidationEnvironment:$false +``` + +```output +Location Name Type +-------- ---- ---- +eastus HostPoolName Microsoft.DesktopVirtualization/hostpools +``` + +This command creates a Windows Virtual Desktop HostPool in a Resource Group. + +## PARAMETERS + +### -AgentUpdateMaintenanceWindow +List of maintenance windows. +Maintenance windows are 2 hours long. +To construct, see NOTES section for AGENTUPDATEMAINTENANCEWINDOW properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IMaintenanceWindowProperties[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentUpdateMaintenanceWindowTimeZone +Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyidview=net-5.0. +Must be set if useLocalTime is true. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentUpdateType +The type of maintenance for session host components. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SessionHostComponentUpdateType +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentUpdateUseSessionHostLocalTime +Whether to use localTime of the virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomRdpProperty +Custom rdp property of HostPool. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of HostPool. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesktopAppGroupName +Desktop App Group Name + +```yaml +Type: System.String +Parameter Sets: FullSenerioCreate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationTime +Expiration time of registration token. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Friendly name of HostPool. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolType +HostPool type for desktop. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.HostPoolType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.ResourceIdentityType +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. +ApiApps are a kind of Microsoft.Web/sites type. +If supported, the resource provider must validate and persist this value. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerType +The type of the load balancer. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.LoadBalancerType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedBy +The fully qualified resource ID of the resource that manages this resource. +Indicates if this resource is managed by another Azure resource. +If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSessionLimit +The max session limit of HostPool. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HostPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PersonalDesktopAssignmentType +PersonalDesktopAssignment type for HostPool. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.PersonalDesktopAssignmentType +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanName +A user defined name of the 3rd Party Artifact that is being procured. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanProduct +The 3rd Party artifact that is being procured. +E.g. +NewRelic. +Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanPromotionCode +A publisher provided promotion code as provisioned in Data Market for the said product/artifact. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanPublisher +The publisher of the 3rd Party Artifact that is being bought. +E.g. +NewRelic + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanVersion +The version of the desired product/artifact. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredAppGroupType +The type of preferred application group type, default to Desktop Application Group + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.PreferredAppGroupType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationInfoToken +The registration token base64 encoded string. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationTokenOperation +The type of resetting the token. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.RegistrationTokenOperation +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ring +The ring number of HostPool. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SkuTier +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SsoadfsAuthority +URL to customer ADFS server for signing WVD SSO certificates. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SsoClientId +ClientId for the registered Relying Party used to issue WVD SSO certificates. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SsoClientSecretKeyVaultPath +Path to Azure KeyVault storing the secret used for communication to ADFS. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SsoSecretType +The type of single sign on Secret Type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SsoSecretType +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartVMOnConnect +The flag to turn on/off StartVMOnConnect feature. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationEnvironment +Is validation environment. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMTemplate +VM template for sessionhosts configuration within hostpool. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Workspace Name + +```yaml +Type: System.String +Parameter Sets: FullSenerioCreate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IHostPool + +## 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. + + +`AGENTUPDATEMAINTENANCEWINDOW <IMaintenanceWindowProperties[]>`: List of maintenance windows. Maintenance windows are 2 hours long. + - `[DayOfWeek <DayOfWeek?>]`: Day of the week. + - `[Hour <Int32?>]`: The update start hour of the day. (0 - 23) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdMsixPackage.md b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdMsixPackage.md new file mode 100644 index 0000000000..4cc8046d28 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdMsixPackage.md @@ -0,0 +1,408 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/new-azwvdmsixpackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdMsixPackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdMsixPackage.md +--- + +# New-AzWvdMsixPackage + +## SYNOPSIS +Create or update a MSIX package. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzWvdMsixPackage -FullName <String> -HostPoolName <String> -ResourceGroupName <String> + [-DisplayName <String>] [-ImagePath <String>] [-IsActive] [-IsRegularRegistration] [-SubscriptionId <String>] + [-LastUpdated <DateTime>] [-PackageApplication <IMsixPackageApplications[]>] + [-PackageDependency <IMsixPackageDependencies[]>] [-PackageFamilyName <String>] [-PackageName <String>] + [-PackageRelativePath <String>] [-Version <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### PackageAlias +``` +New-AzWvdMsixPackage -HostPoolName <String> -PackageAlias <String> -ResourceGroupName <String> + [-DisplayName <String>] [-ImagePath <String>] [-IsActive] [-IsRegularRegistration] [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a MSIX package. + +## EXAMPLES + +### Example 1: Creates New MSIX Package in the HostPool via Package Alias +```powershell +New-AzWvdMsixPackage -HostPoolName HostPoolName ` + -ResourceGroupName resourceGroupName ` + -SubscriptionId SubscriptionId ` + -PackageAlias packagealias ` + -ImagePath ImagePathURI +``` + +This command adds MSIX package from specified image path to HostPool + +### Example 2: Creates New MSIX Package in the HostPool +```powershell +$apps = "<PackagedApplication>" +$deps = "<PackageDependencies>" +New-AzWvdMsixPackage -FullName PackageFullName ` + -HostPoolName HostPoolName ` + -ResourceGroupName ResourceGroupName ` + -SubscriptionId SubscriptionId ` + -DisplayName displayname ` + -ImagePath imageURI ` + -IsActive:$false ` + -IsRegularRegistration:$false ` + -LastUpdated datelastupdated ` + -PackageApplication $apps ` + -PackageDependency $deps ` + -PackageFamilyName packagefamilyname ` + -PackageName packagename ` + -PackageRelativePath packagerelativepath ` + -Version packageversion +``` + +```output +Name Type +---- ---- +HotPoolName/PackageFullName Microsoft.DesktopVirtualization/hostpools/msixpackages + +``` + +This command adds MSIX Package in the specified HostPool + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +User friendly Name to be displayed in the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullName +The version specific package full name of the MSIX package within specified hostpool + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: MsixPackageFullName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImagePath +VHD/CIM image path on Network Share. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsActive +Make this version of the package the active one across the hostpool. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsRegularRegistration +Specifies how to register Package in feed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastUpdated +Date Package was last updated, found in the appxmanifest.xml. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageAlias +Package Alias from extract MSIX Image + +```yaml +Type: System.String +Parameter Sets: PackageAlias +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageApplication +List of package applications. + +To construct, see NOTES section for PACKAGEAPPLICATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IMsixPackageApplications[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageDependency +List of package dependencies. + +To construct, see NOTES section for PACKAGEDEPENDENCY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IMsixPackageDependencies[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageFamilyName +Package Family Name from appxmanifest.xml. +Contains Package Name and Publisher name. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageName +Package Name from appxmanifest.xml. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageRelativePath +Relative Path to the package inside the image. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Package Version found in the appxmanifest.xml. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IMsixPackage + +## 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. + + +`PACKAGEAPPLICATION <IMsixPackageApplications[]>`: List of package applications. + - `[AppId <String>]`: Package Application Id, found in appxmanifest.xml. + - `[AppUserModelId <String>]`: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. + - `[Description <String>]`: Description of Package Application. + - `[FriendlyName <String>]`: User friendly name. + - `[IconImageName <String>]`: User friendly name. + - `[RawIcon <Byte[]>]`: the icon a 64 bit string as a byte array. + - `[RawPng <Byte[]>]`: the icon a 64 bit string as a byte array. + +`PACKAGEDEPENDENCY <IMsixPackageDependencies[]>`: List of package dependencies. + - `[DependencyName <String>]`: Name of package dependency. + - `[MinVersion <String>]`: Dependency version required. + - `[Publisher <String>]`: Name of dependency publisher. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdRegistrationInfo.md b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdRegistrationInfo.md new file mode 100644 index 0000000000..34424b0258 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdRegistrationInfo.md @@ -0,0 +1,162 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/new-azwvdregistrationinfo +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdRegistrationInfo.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdRegistrationInfo.md +--- + +# New-AzWvdRegistrationInfo + +## SYNOPSIS +Create Windows virtual desktop registration info. + +## SYNTAX + +``` +New-AzWvdRegistrationInfo -ExpirationTime <String> -HostPoolName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create Windows virtual desktop registration info. + +## EXAMPLES + +### Example 1: Create a Registration Info for a HostPool +```powershell +New-AzWvdRegistrationInfo -ResourceGroupName rgName -HostPoolName hpName -ExpirationTime "2050-02-14 12:00" +``` + +```output +ExpirationTime RegistrationTokenOperation Token +-------------- -------------------------- ----- +02/14/2050 12:00:00 PM Update <base64 encoded string> +``` + +Creates a new Registration Info object for the selected HostPool + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationTime +Expiration Time + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +Host Pool Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IRegistrationInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdScalingPlan.md b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdScalingPlan.md new file mode 100644 index 0000000000..aa16180d8d --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdScalingPlan.md @@ -0,0 +1,568 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/new-azwvdscalingplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdScalingPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdScalingPlan.md +--- + +# New-AzWvdScalingPlan + +## SYNOPSIS +Create or update a scaling plan. + +## SYNTAX + +``` +New-AzWvdScalingPlan -Name <String> -ResourceGroupName <String> -TimeZone <String> [-SubscriptionId <String>] + [-Description <String>] [-ExclusionTag <String>] [-FriendlyName <String>] + [-HostPoolReference <IScalingHostPoolReference[]>] [-HostPoolType <ScalingHostPoolType>] + [-IdentityType <ResourceIdentityType>] [-Kind <String>] [-Location <String>] [-ManagedBy <String>] + [-PlanName <String>] [-PlanProduct <String>] [-PlanPromotionCode <String>] [-PlanPublisher <String>] + [-PlanVersion <String>] [-Schedule <IScalingSchedule[]>] [-SkuCapacity <Int32>] [-SkuFamily <String>] + [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a scaling plan. + +## EXAMPLES + +### Example 1: Create a Windows Virtual Desktop Scaling Plan +```powershell +New-AzWvdScalingPlan ` + -ResourceGroupName ResourceGroupName ` + -Name 'scalingPlan1' ` + -Location 'westcentralus' ` + -Description 'Description' ` + -FriendlyName 'Friendly Name' ` + -HostPoolType 'Pooled' ` + -TimeZone '(UTC-08:00) Pacific Time (US & Canada)' ` + -Schedule @( + @{ + 'name' = 'Work Week'; + 'daysOfWeek' = @('Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'); + 'rampUpStartTime' = '1900-01-01T06:00:00Z'; + 'rampUpLoadBalancingAlgorithm' = 'BreadthFirst'; + 'rampUpMinimumHostsPct' = 20; + 'rampUpCapacityThresholdPct' = 20; + 'peakStartTime' = '1900-01-01T08:00:00Z'; + 'peakLoadBalancingAlgorithm' = 'DepthFirst'; + 'RampDownStartTime' = '1900-01-01T18:00:00Z'; + 'rampDownLoadBalancingAlgorithm' = 'BreadthFirst'; + 'rampDownMinimumHostsPct' = 20; + 'rampDownCapacityThresholdPct' = 20; + 'rampDownForceLogoffUser' = $true; + 'rampDownWaitTimeMinute' = 30; + 'rampDownNotificationMessage' = 'Log out now, please.'; + 'rampDownStopHostsWhen' = 'ZeroSessions'; + 'offPeakStartTime' = '1900-01-01T20:00:00Z'; + 'offPeakLoadBalancingAlgorithm' = 'DepthFirst'; + } + ) ` + -HostPoolReference @( + @{ + 'hostPoolArmPath' = '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName'; + 'scalingPlanEnabled' = $false; + } + ) +``` + +```output +Location Name Type +-------- ---- ---- +westcentralus scalingPlan1 Microsoft.DesktopVirtualization/scalingplans +``` + +This command creates a new Windows Virtual Desktop Scaling Plan in a Resource Group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of scaling plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionTag +Exclusion tag for scaling plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +User friendly name of scaling plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolReference +List of ScalingHostPoolReference definitions. +To construct, see NOTES section for HOSTPOOLREFERENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IScalingHostPoolReference[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolType +HostPool type for desktop. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.ScalingHostPoolType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. +ApiApps are a kind of Microsoft.Web/sites type. +If supported, the resource provider must validate and persist this value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedBy +The fully qualified resource ID of the resource that manages this resource. +Indicates if this resource is managed by another Azure resource. +If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the scaling plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ScalingPlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanName +A user defined name of the 3rd Party Artifact that is being procured. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanProduct +The 3rd Party artifact that is being procured. +E.g. +NewRelic. +Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanPromotionCode +A publisher provided promotion code as provisioned in Data Market for the said product/artifact. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanPublisher +The publisher of the 3rd Party Artifact that is being bought. +E.g. +NewRelic + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanVersion +The version of the desired product/artifact. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schedule +List of ScalingPlanPooledSchedule definitions. +To construct, see NOTES section for SCHEDULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IScalingSchedule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SkuTier +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeZone +Timezone of the scaling plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IScalingPlan + +## 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. + + +`HOSTPOOLREFERENCE <IScalingHostPoolReference[]>`: List of ScalingHostPoolReference definitions. + - `[HostPoolArmPath <String>]`: Arm path of referenced hostpool. + - `[ScalingPlanEnabled <Boolean?>]`: Is the scaling plan enabled for this hostpool. + +`SCHEDULE <IScalingSchedule[]>`: List of ScalingPlanPooledSchedule definitions. + - `[DaysOfWeek <String[]>]`: Set of days of the week on which this schedule is active. + - `[Name <String>]`: Name of the ScalingPlanPooledSchedule. + - `[OffPeakLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm?>]`: Load balancing algorithm for off-peak period. + - `[OffPeakStartTimeHour <Int32?>]`: The hour. + - `[OffPeakStartTimeMinute <Int32?>]`: The minute. + - `[PeakLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm?>]`: Load balancing algorithm for peak period. + - `[PeakStartTimeHour <Int32?>]`: The hour. + - `[PeakStartTimeMinute <Int32?>]`: The minute. + - `[RampDownCapacityThresholdPct <Int32?>]`: Capacity threshold for ramp down period. + - `[RampDownForceLogoffUser <Boolean?>]`: Should users be logged off forcefully from hosts. + - `[RampDownLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm?>]`: Load balancing algorithm for ramp down period. + - `[RampDownMinimumHostsPct <Int32?>]`: Minimum host percentage for ramp down period. + - `[RampDownNotificationMessage <String>]`: Notification message for users during ramp down period. + - `[RampDownStartTimeHour <Int32?>]`: The hour. + - `[RampDownStartTimeMinute <Int32?>]`: The minute. + - `[RampDownStopHostsWhen <StopHostsWhen?>]`: Specifies when to stop hosts during ramp down period. + - `[RampDownWaitTimeMinute <Int32?>]`: Number of minutes to wait to stop hosts during ramp down period. + - `[RampUpCapacityThresholdPct <Int32?>]`: Capacity threshold for ramp up period. + - `[RampUpLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm?>]`: Load balancing algorithm for ramp up period. + - `[RampUpMinimumHostsPct <Int32?>]`: Minimum host percentage for ramp up period. + - `[RampUpStartTimeHour <Int32?>]`: The hour. + - `[RampUpStartTimeMinute <Int32?>]`: The minute. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdScalingPlanPooledSchedule.md b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdScalingPlanPooledSchedule.md new file mode 100644 index 0000000000..0ab86785c6 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdScalingPlanPooledSchedule.md @@ -0,0 +1,511 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/new-azwvdscalingplanpooledschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdScalingPlanPooledSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdScalingPlanPooledSchedule.md +--- + +# New-AzWvdScalingPlanPooledSchedule + +## SYNOPSIS +Create or update a ScalingPlanPooledSchedule. + +## SYNTAX + +``` +New-AzWvdScalingPlanPooledSchedule -ResourceGroupName <String> -ScalingPlanName <String> + -ScalingPlanScheduleName <String> [-SubscriptionId <String>] [-DaysOfWeek <DayOfWeek[]>] + [-OffPeakLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>] [-OffPeakStartTimeHour <Int32>] + [-OffPeakStartTimeMinute <Int32>] [-PeakLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>] + [-PeakStartTimeHour <Int32>] [-PeakStartTimeMinute <Int32>] [-RampDownCapacityThresholdPct <Int32>] + [-RampDownForceLogoffUser] [-RampDownLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>] + [-RampDownMinimumHostsPct <Int32>] [-RampDownNotificationMessage <String>] [-RampDownStartTimeHour <Int32>] + [-RampDownStartTimeMinute <Int32>] [-RampDownStopHostsWhen <StopHostsWhen>] [-RampDownWaitTimeMinute <Int32>] + [-RampUpCapacityThresholdPct <Int32>] [-RampUpLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>] + [-RampUpMinimumHostsPct <Int32>] [-RampUpStartTimeHour <Int32>] [-RampUpStartTimeMinute <Int32>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a ScalingPlanPooledSchedule. + +## EXAMPLES + +### Example 1: Create a Scaling Plan Pooled Schedule +```powershell +New-AzWvdScalingPlanPooledSchedule -ResourceGroupName rgName ` + -ScalingPlanName spName ` + -ScalingPlanScheduleName scheduleName ` + -daysOfWeek @('Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday') ` + -rampUpStartTimeHour 6 ` + -rampUpStartTimeMinute 30 ` + -rampUpLoadBalancingAlgorithm BreadthFirst ` + -rampUpMinimumHostsPct 20 ` + -rampUpCapacityThresholdPct 20 ` + -peakStartTimeHour 8 ` + -peakStartTimeMinute 30 ` + -peakLoadBalancingAlgorithm DepthFirst ` + -RampDownStartTimeHour 16 ` + -RampDownStartTimeMinute 0 ` + -rampDownLoadBalancingAlgorithm BreadthFirst ` + -rampDownMinimumHostsPct 20 ` + -rampDownCapacityThresholdPct 20 ` + -rampDownForceLogoffUser:$true ` + -rampDownWaitTimeMinute 30 ` + -rampDownNotificationMessage "Log out now, please." ` + -rampDownStopHostsWhen ZeroSessions ` + -offPeakStartTimeHour 22 ` + -offPeakStartTimeMinute 45 ` + -offPeakLoadBalancingAlgorithm DepthFirst +``` + +```output +Name +---- +scalingplan1/PooledSchedule1 +``` + +Add a Scaling Plan Pooled Schedule to an existing Scaling Plan. + +## PARAMETERS + +### -DaysOfWeek +Set of days of the week on which this schedule is active. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.DayOfWeek[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OffPeakLoadBalancingAlgorithm +Load balancing algorithm for off-peak period. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SessionHostLoadBalancingAlgorithm +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OffPeakStartTimeHour +The hour. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OffPeakStartTimeMinute +The minute. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeakLoadBalancingAlgorithm +Load balancing algorithm for peak period. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SessionHostLoadBalancingAlgorithm +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeakStartTimeHour +The hour. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeakStartTimeMinute +The minute. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownCapacityThresholdPct +Capacity threshold for ramp down period. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownForceLogoffUser +Should users be logged off forcefully from hosts. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownLoadBalancingAlgorithm +Load balancing algorithm for ramp down period. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SessionHostLoadBalancingAlgorithm +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownMinimumHostsPct +Minimum host percentage for ramp down period. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownNotificationMessage +Notification message for users during ramp down period. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownStartTimeHour +The hour. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownStartTimeMinute +The minute. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownStopHostsWhen +Specifies when to stop hosts during ramp down period. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.StopHostsWhen +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownWaitTimeMinute +Number of minutes to wait to stop hosts during ramp down period. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampUpCapacityThresholdPct +Capacity threshold for ramp up period. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampUpLoadBalancingAlgorithm +Load balancing algorithm for ramp up period. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SessionHostLoadBalancingAlgorithm +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampUpMinimumHostsPct +Minimum host percentage for ramp up period. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampUpStartTimeHour +The hour. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampUpStartTimeMinute +The minute. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScalingPlanName +The name of the scaling plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScalingPlanScheduleName +The name of the ScalingPlanSchedule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IScalingPlanPooledSchedule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdWorkspace.md b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdWorkspace.md new file mode 100644 index 0000000000..3bf608e828 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/New-AzWvdWorkspace.md @@ -0,0 +1,460 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/new-azwvdworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/New-AzWvdWorkspace.md +--- + +# New-AzWvdWorkspace + +## SYNOPSIS +Create or update a workspace. + +## SYNTAX + +``` +New-AzWvdWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-ApplicationGroupReference <String[]>] [-Description <String>] [-FriendlyName <String>] + [-IdentityType <ResourceIdentityType>] [-Kind <String>] [-Location <String>] [-ManagedBy <String>] + [-PlanName <String>] [-PlanProduct <String>] [-PlanPromotionCode <String>] [-PlanPublisher <String>] + [-PlanVersion <String>] [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] + [-SkuTier <SkuTier>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a workspace. + +## EXAMPLES + +### Example 1: Create a Windows Virtual Desktop Workspace by name +```powershell +New-AzWvdWorkspace -ResourceGroupName ResourceGroupName ` + -Name WorkspaceName ` + -Location 'eastus' ` + -FriendlyName 'Friendly Name' ` + -ApplicationGroupReference $null ` + -Description 'Description' +``` + +```output +Location Name Type +-------- ---- ---- +eastus WorkspaceName Microsoft.DesktopVirtualization/workspaces +``` + +This command creates a Windows Virtual Desktop Workspace in a Resource Group. + +### Example 2: Create a Windows Virtual Desktop Workspace by name +```powershell +New-AzWvdWorkspace -ResourceGroupName ResourceGroupName ` + -Name WorkspaceName ` + -Location 'eastus' ` + -FriendlyName 'Friendly Name' ` + -ApplicationGroupReference "/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/ApplicationGroupName1","/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/ApplicationGroupName2" ` + -Description 'Description' +``` + +```output +Location Name Type +-------- ---- ---- +eastus WorkspaceName Microsoft.DesktopVirtualization/workspaces +``` + +This command creates a Windows Virtual Desktop Workspace in a Resource Group. + +## PARAMETERS + +### -ApplicationGroupReference +List of applicationGroup resource Ids. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of Workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Friendly name of Workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. +ApiApps are a kind of Microsoft.Web/sites type. +If supported, the resource provider must validate and persist this value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedBy +The fully qualified resource ID of the resource that manages this resource. +Indicates if this resource is managed by another Azure resource. +If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanName +A user defined name of the 3rd Party Artifact that is being procured. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanProduct +The 3rd Party artifact that is being procured. +E.g. +NewRelic. +Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanPromotionCode +A publisher provided promotion code as provisioned in Data Market for the said product/artifact. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanPublisher +The publisher of the 3rd Party Artifact that is being bought. +E.g. +NewRelic + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanVersion +The version of the desired product/artifact. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SkuTier +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IWorkspace + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Register-AzWvdApplicationGroup.md b/azps-10.1.0/Az.DesktopVirtualization/Register-AzWvdApplicationGroup.md new file mode 100644 index 0000000000..5e4a87f1b5 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Register-AzWvdApplicationGroup.md @@ -0,0 +1,165 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/register-azwvdapplicationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Register-AzWvdApplicationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Register-AzWvdApplicationGroup.md +--- + +# Register-AzWvdApplicationGroup + +## SYNOPSIS +Register a Windows virtual desktop application group. + +## SYNTAX + +``` +Register-AzWvdApplicationGroup -ApplicationGroupPath <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Register a Windows virtual desktop application group. + +## EXAMPLES + +### Example 1: Register an Application Group +```powershell +Register-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName ` + -WorkspaceName WorkspaceName ` + -ApplicationGroupPath '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/ApplicationGroupName' +``` + +```output +Location Name Type +-------- ---- ---- +eastus WorkspaceName Microsoft.DesktopVirtualization/workspaces +``` + +This command registers an Application Group to a workspace + +## PARAMETERS + +### -ApplicationGroupPath +ApplicationGroupPath Path + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Workspace Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IWorkspace + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdApplication.md b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdApplication.md new file mode 100644 index 0000000000..71770c4700 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdApplication.md @@ -0,0 +1,218 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/remove-azwvdapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdApplication.md +--- + +# Remove-AzWvdApplication + +## SYNOPSIS +Remove an application. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWvdApplication -GroupName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWvdApplication -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove an application. + +## EXAMPLES + +### Example 1: Delete a Windows Virtual Desktop Application by name +```powershell +Remove-AzWvdApplication -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name ApplicationName +``` + +This command deletes a Windows Virtual Desktop Application in an applicaton Group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +The name of the application group + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ApplicationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the application within the specified application group + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ApplicationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdApplicationGroup.md b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdApplicationGroup.md new file mode 100644 index 0000000000..d436b327b8 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdApplicationGroup.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/remove-azwvdapplicationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdApplicationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdApplicationGroup.md +--- + +# Remove-AzWvdApplicationGroup + +## SYNOPSIS +Remove an applicationGroup. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWvdApplicationGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWvdApplicationGroup -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove an applicationGroup. + +## EXAMPLES + +### Example 1: Delete a Windows Virtual Desktop ApplicationGroup by name +```powershell +Remove-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName -Name ApplicationGroupName +``` + +This command deletes a Windows Virtual Desktop ApplicationGroup in a Resource Group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the application group + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ApplicationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdHostPool.md b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdHostPool.md new file mode 100644 index 0000000000..4684185275 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdHostPool.md @@ -0,0 +1,218 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/remove-azwvdhostpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdHostPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdHostPool.md +--- + +# Remove-AzWvdHostPool + +## SYNOPSIS +Remove a host pool. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWvdHostPool -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Force] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWvdHostPool -InputObject <IDesktopVirtualizationIdentity> [-Force] [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a host pool. + +## EXAMPLES + +### Example 1: Delete a Windows Virtual Desktop HostPool by name +```powershell +Remove-AzWvdHostPool -ResourceGroupName ResourceGroupName -Name HostPoolName +``` + +This command deletes a Windows Virtual Desktop HostPool in a Resource Group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force flag to delete sessionHost. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: HostPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdMsixPackage.md b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdMsixPackage.md new file mode 100644 index 0000000000..b7d8b7d14e --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdMsixPackage.md @@ -0,0 +1,218 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/remove-azwvdmsixpackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdMsixPackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdMsixPackage.md +--- + +# Remove-AzWvdMsixPackage + +## SYNOPSIS +Remove an MSIX Package. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWvdMsixPackage -FullName <String> -HostPoolName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWvdMsixPackage -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove an MSIX Package. + +## EXAMPLES + +### Example 1: Delete MSIX Package by Package Full Name +```powershell +Remove-AzWvdMsixPackage -HostPoolName HostPoolName -ResourceGroupName ResourceGroupName -SubscriptionId SubscriptionId -FullName PackageFullName +``` + +This command deletes a MSIX Package in a HostPool + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullName +The version specific package full name of the MSIX package within specified hostpool + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: MsixPackageFullName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdRegistrationInfo.md b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdRegistrationInfo.md new file mode 100644 index 0000000000..88315d0c66 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdRegistrationInfo.md @@ -0,0 +1,139 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/remove-azwvdregistrationinfo +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdRegistrationInfo.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdRegistrationInfo.md +--- + +# Remove-AzWvdRegistrationInfo + +## SYNOPSIS +Remove the Windows virtual desktop registration info. + +## SYNTAX + +``` +Remove-AzWvdRegistrationInfo -HostPoolName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove the Windows virtual desktop registration info. + +## EXAMPLES + +### Example 1: Remove Registration Info +```powershell +Remove-AzWvdRegistrationInfo -resourceGroupName rgName -hostpoolName hpName +``` + +Removes Registration Info from a HostPool + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +Host Pool Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +help foo 1 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdScalingPlan.md b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdScalingPlan.md new file mode 100644 index 0000000000..ee2dfbb9bf --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdScalingPlan.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/remove-azwvdscalingplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdScalingPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdScalingPlan.md +--- + +# Remove-AzWvdScalingPlan + +## SYNOPSIS +Remove a scaling plan. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWvdScalingPlan -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWvdScalingPlan -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a scaling plan. + +## EXAMPLES + +### Example 1: Delete a Windows Virtual Desktop Scaling Plan by name +```powershell +Remove-AzWvdScalingPlan -ResourceGroupName ResourceGroupName -Name scalingPlan1 +``` + +This command deletes a Windows Virtual Desktop Scaling Plan in a Resource Group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the scaling plan. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ScalingPlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdScalingPlanPooledSchedule.md b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdScalingPlanPooledSchedule.md new file mode 100644 index 0000000000..c8ed143c3a --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdScalingPlanPooledSchedule.md @@ -0,0 +1,219 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/remove-azwvdscalingplanpooledschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdScalingPlanPooledSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdScalingPlanPooledSchedule.md +--- + +# Remove-AzWvdScalingPlanPooledSchedule + +## SYNOPSIS +Remove a ScalingPlanPooledSchedule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWvdScalingPlanPooledSchedule -ResourceGroupName <String> -ScalingPlanName <String> + -ScalingPlanScheduleName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWvdScalingPlanPooledSchedule -InputObject <IDesktopVirtualizationIdentity> + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a ScalingPlanPooledSchedule. + +## EXAMPLES + +### Example 1: Delete a Pooled Schedule +```powershell +Remove-AzWvdScalingPlanPooledSchedule -ResourceGroupName rgName -ScalingPlanName spName -ScalingPlanScheduleName scheduleName +``` + +Remove a Pooled Schedule from a Scaling Plan + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScalingPlanName +The name of the scaling plan. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScalingPlanScheduleName +The name of the ScalingPlanSchedule + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdSessionHost.md b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdSessionHost.md new file mode 100644 index 0000000000..d73b66ee0d --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdSessionHost.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/remove-azwvdsessionhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdSessionHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdSessionHost.md +--- + +# Remove-AzWvdSessionHost + +## SYNOPSIS +Remove a SessionHost. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWvdSessionHost -HostPoolName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Force] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWvdSessionHost -InputObject <IDesktopVirtualizationIdentity> [-Force] [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a SessionHost. + +## EXAMPLES + +### Example 1: Delete a Windows Virtual Desktop SessionHost by name +```powershell +Remove-AzWvdSessionHost -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -Name SessionHostName +``` + +This command deletes a Windows Virtual Desktop SessionHost in a Host Pool. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force flag to force sessionHost deletion even when userSession exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the session host within the specified host pool + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SessionHostName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdUserSession.md b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdUserSession.md new file mode 100644 index 0000000000..0f2c769932 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdUserSession.md @@ -0,0 +1,249 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/remove-azwvdusersession +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdUserSession.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdUserSession.md +--- + +# Remove-AzWvdUserSession + +## SYNOPSIS +Remove a userSession. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWvdUserSession -HostPoolName <String> -Id <String> -ResourceGroupName <String> + -SessionHostName <String> [-SubscriptionId <String>] [-Force] [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWvdUserSession -InputObject <IDesktopVirtualizationIdentity> [-Force] [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a userSession. + +## EXAMPLES + +### Example 1: Delete a Windows Virtual Desktop UserSession by name +```powershell +Remove-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName -Id 2 +``` + +This command deletes a Windows Virtual Desktop UserSession in a Session Host. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specify to force userSession deletion. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The name of the user session within the specified session host + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: UserSessionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionHostName +The name of the session host within the specified host pool + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdWorkspace.md b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdWorkspace.md new file mode 100644 index 0000000000..d4dcb50004 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Remove-AzWvdWorkspace.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/remove-azwvdworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Remove-AzWvdWorkspace.md +--- + +# Remove-AzWvdWorkspace + +## SYNOPSIS +Remove a workspace. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWvdWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWvdWorkspace -InputObject <IDesktopVirtualizationIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a workspace. + +## EXAMPLES + +### Example 1: Delete a Windows Virtual Desktop Workspace by name +```powershell +Remove-AzWvdWorkspace -ResourceGroupName ResourceGroupName -Name WorkspaceName +``` + +This command deletes a Windows Virtual Desktop Workspace in a Resource Group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Send-AzWvdUserSessionMessage.md b/azps-10.1.0/Az.DesktopVirtualization/Send-AzWvdUserSessionMessage.md new file mode 100644 index 0000000000..c7b206a3d0 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Send-AzWvdUserSessionMessage.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/send-azwvdusersessionmessage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Send-AzWvdUserSessionMessage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Send-AzWvdUserSessionMessage.md +--- + +# Send-AzWvdUserSessionMessage + +## SYNOPSIS +Send a message to a user. + +## SYNTAX + +### SendExpanded (Default) +``` +Send-AzWvdUserSessionMessage -HostPoolName <String> -ResourceGroupName <String> -SessionHostName <String> + -UserSessionId <String> [-SubscriptionId <String>] [-MessageBody <String>] [-MessageTitle <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### SendViaIdentityExpanded +``` +Send-AzWvdUserSessionMessage -InputObject <IDesktopVirtualizationIdentity> [-MessageBody <String>] + [-MessageTitle <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Send a message to a user. + +## EXAMPLES + +### Example 1: Send a message to UserSession +```powershell +Send-AzWvdUserSessionMessage -ResourceGroupName ResourceGroupName ` + -HostPoolName HostPoolName ` + -SessionHostName SessionHostName ` + -UserSessionId 4 ` + -MessageBody 'Some Message' ` + -MessageTitle 'Some Title' +``` + +This command sends a message to a UserSession. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: SendExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: SendViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MessageBody +Body of message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageTitle +Title of message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SendExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionHostName +The name of the session host within the specified host pool + +```yaml +Type: System.String +Parameter Sets: SendExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SendExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSessionId +The name of the user session within the specified session host + +```yaml +Type: System.String +Parameter Sets: SendExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Unregister-AzWvdApplicationGroup.md b/azps-10.1.0/Az.DesktopVirtualization/Unregister-AzWvdApplicationGroup.md new file mode 100644 index 0000000000..328e8be2c6 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Unregister-AzWvdApplicationGroup.md @@ -0,0 +1,159 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/unregister-azwvdapplicationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Unregister-AzWvdApplicationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Unregister-AzWvdApplicationGroup.md +--- + +# Unregister-AzWvdApplicationGroup + +## SYNOPSIS +Unregister the Windows virtual desktop application group. + +## SYNTAX + +``` +Unregister-AzWvdApplicationGroup -ApplicationGroupPath <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Unregister the Windows virtual desktop application group. + +## EXAMPLES + +### Example 1: Unregister an Application Group +```powershell +Unregister-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName ` + -WorkspaceName WorkspaceName ` + -ApplicationGroupPath '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/ApplicationGroupName' +``` + +This command unregisters an Application Group from a Workspace + +## PARAMETERS + +### -ApplicationGroupPath +ResourceGroupName Path + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Workspace Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IWorkspace + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdApplication.md b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdApplication.md new file mode 100644 index 0000000000..54e3d7d6d5 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdApplication.md @@ -0,0 +1,406 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/update-azwvdapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdApplication.md +--- + +# Update-AzWvdApplication + +## SYNOPSIS +Update an application. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWvdApplication -GroupName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-ApplicationType <RemoteApplicationType>] [-CommandLineArgument <String>] + [-CommandLineSetting <CommandLineSetting>] [-Description <String>] [-FilePath <String>] + [-FriendlyName <String>] [-IconIndex <Int32>] [-IconPath <String>] [-MsixPackageApplicationId <String>] + [-MsixPackageFamilyName <String>] [-ShowInPortal] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWvdApplication -InputObject <IDesktopVirtualizationIdentity> + [-ApplicationType <RemoteApplicationType>] [-CommandLineArgument <String>] + [-CommandLineSetting <CommandLineSetting>] [-Description <String>] [-FilePath <String>] + [-FriendlyName <String>] [-IconIndex <Int32>] [-IconPath <String>] [-MsixPackageApplicationId <String>] + [-MsixPackageFamilyName <String>] [-ShowInPortal] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update an application. + +## EXAMPLES + +### Example 1: Update a Windows Virtual Desktop Application +```powershell +Update-AzWvdApplication -ResourceGroupName ResourceGroupName ` + -GroupName ApplicationGroupName ` + -Name ApplicationName ` + -FilePath 'C:\windows\system32\mspaint.exe' ` + -FriendlyName 'Friendly name' ` + -Description 'Description' ` + -IconIndex 0 ` + -IconPath 'C:\windows\system32\mspaint.exe' ` + -CommandLineSetting 'Allow' ` + -ShowInPortal:$true +``` + +```output +Name Type +---- ---- +ApplicationGroupName/ApplicationName Microsoft.DesktopVirtualization/applicationgroups/applications +``` + +This command updates a Windows Virtual Desktop Application in an applicaton Group. + +## PARAMETERS + +### -ApplicationType +Resource Type of Application. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.RemoteApplicationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandLineArgument +Command Line Arguments for Application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandLineSetting +Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.CommandLineSetting +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of Application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +Specifies a path for the executable file for the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Friendly name of Application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +The name of the application group + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ApplicationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IconIndex +Index of the icon. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IconPath +Path to icon. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MsixPackageApplicationId +Specifies the package application Id for MSIX applications + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsixPackageFamilyName +Specifies the package family name for MSIX applications + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the application within the specified application group + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ApplicationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowInPortal +Specifies whether to show the RemoteApp program in the RD Web Access server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +tags to be updated + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IApplication + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdApplicationGroup.md b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdApplicationGroup.md new file mode 100644 index 0000000000..ecb2d2aa50 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdApplicationGroup.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/update-azwvdapplicationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdApplicationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdApplicationGroup.md +--- + +# Update-AzWvdApplicationGroup + +## SYNOPSIS +Update an applicationGroup. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWvdApplicationGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Description <String>] [-FriendlyName <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWvdApplicationGroup -InputObject <IDesktopVirtualizationIdentity> [-Description <String>] + [-FriendlyName <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Update an applicationGroup. + +## EXAMPLES + +### Example 1: Create a Windows Virtual Desktop ApplicationGroup by name +```powershell +New-AzWvdApplicationGroup -ResourceGroupName ResourceGroupName ` + -Name ApplicationGroupName ` + -FriendlyName 'Friendly Name' ` + -Description 'Description' +``` + +```output +Location Name Type +-------- ---- ---- +eastus ApplicationGroupName Microsoft.DesktopVirtualization/applicationgroups +``` + +This command creates a Windows Virtual Desktop ApplicationGroup in a Resource Group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of ApplicationGroup. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Friendly name of ApplicationGroup. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the application group + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ApplicationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +tags to be updated + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IApplicationGroup + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdDesktop.md b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdDesktop.md new file mode 100644 index 0000000000..321f0972ae --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdDesktop.md @@ -0,0 +1,260 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/update-azwvddesktop +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdDesktop.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdDesktop.md +--- + +# Update-AzWvdDesktop + +## SYNOPSIS +Update a desktop. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWvdDesktop -ApplicationGroupName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Description <String>] [-FriendlyName <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWvdDesktop -InputObject <IDesktopVirtualizationIdentity> [-Description <String>] + [-FriendlyName <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Update a desktop. + +## EXAMPLES + +### Example 1: Update a Windows Virtual Desktop Desktop +```powershell +Update-AzWvdDesktop -ResourceGroupName ResourceGroupName ` + -ApplicationGroupName ApplicationGroupName ` + -Name DesktopName ` + -FriendlyName 'Friendly name' ` + -Description 'Description' +``` + +```output +Name Type +---- ---- +ApplicationGroupName/DesktopName Microsoft.DesktopVirtualization/applicationgroups/desktops +``` + +This command updates a Windows Virtual Desktop Desktop in an applicaton Group. + +## PARAMETERS + +### -ApplicationGroupName +The name of the application group + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of Desktop. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Friendly name of Desktop. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the desktop within the specified desktop group + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: DesktopName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +tags to be updated + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IDesktop + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdHostPool.md b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdHostPool.md new file mode 100644 index 0000000000..600adac278 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdHostPool.md @@ -0,0 +1,557 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/update-azwvdhostpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdHostPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdHostPool.md +--- + +# Update-AzWvdHostPool + +## SYNOPSIS +Update a host pool. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWvdHostPool -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AgentUpdateMaintenanceWindow <IMaintenanceWindowPatchProperties[]>] + [-AgentUpdateMaintenanceWindowTimeZone <String>] [-AgentUpdateType <SessionHostComponentUpdateType>] + [-AgentUpdateUseSessionHostLocalTime] [-CustomRdpProperty <String>] [-Description <String>] + [-FriendlyName <String>] [-LoadBalancerType <LoadBalancerType>] [-MaxSessionLimit <Int32>] + [-PersonalDesktopAssignmentType <PersonalDesktopAssignmentType>] + [-PreferredAppGroupType <PreferredAppGroupType>] [-RegistrationInfoExpirationTime <DateTime>] + [-RegistrationInfoRegistrationTokenOperation <RegistrationTokenOperation>] [-Ring <Int32>] + [-SsoadfsAuthority <String>] [-SsoClientId <String>] [-SsoClientSecretKeyVaultPath <String>] + [-SsoSecretType <SsoSecretType>] [-StartVMOnConnect] [-Tag <Hashtable>] [-ValidationEnvironment] + [-VMTemplate <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWvdHostPool -InputObject <IDesktopVirtualizationIdentity> + [-AgentUpdateMaintenanceWindow <IMaintenanceWindowPatchProperties[]>] + [-AgentUpdateMaintenanceWindowTimeZone <String>] [-AgentUpdateType <SessionHostComponentUpdateType>] + [-AgentUpdateUseSessionHostLocalTime] [-CustomRdpProperty <String>] [-Description <String>] + [-FriendlyName <String>] [-LoadBalancerType <LoadBalancerType>] [-MaxSessionLimit <Int32>] + [-PersonalDesktopAssignmentType <PersonalDesktopAssignmentType>] + [-PreferredAppGroupType <PreferredAppGroupType>] [-RegistrationInfoExpirationTime <DateTime>] + [-RegistrationInfoRegistrationTokenOperation <RegistrationTokenOperation>] [-Ring <Int32>] + [-SsoadfsAuthority <String>] [-SsoClientId <String>] [-SsoClientSecretKeyVaultPath <String>] + [-SsoSecretType <SsoSecretType>] [-StartVMOnConnect] [-Tag <Hashtable>] [-ValidationEnvironment] + [-VMTemplate <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a host pool. + +## EXAMPLES + +### Example 1: Update a Windows Virtual Desktop HostPool by name +```powershell +Update-AzWvdHostPool -ResourceGroupName ResourceGroupName ` + -Name HostPoolName ` + -LoadBalancerType 'BreadthFirst' ` + -Description 'Description' ` + -FriendlyName 'Friendly Name' ` + -MaxSessionLimit 6 ` + -CustomRdpProperty $null ` + -Ring $null ` + -ValidationEnvironment:$false +``` + +```output +Location Name Type +-------- ---- ---- +eastus HostPoolName Microsoft.DesktopVirtualization/hostpools +``` + +This command updates a Windows Virtual Desktop HostPool in a Resource Group. + +## PARAMETERS + +### -AgentUpdateMaintenanceWindow +List of maintenance windows. +Maintenance windows are 2 hours long. +To construct, see NOTES section for AGENTUPDATEMAINTENANCEWINDOW properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IMaintenanceWindowPatchProperties[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentUpdateMaintenanceWindowTimeZone +Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyidview=net-5.0. +Must be set if useLocalTime is true. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentUpdateType +The type of maintenance for session host components. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SessionHostComponentUpdateType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentUpdateUseSessionHostLocalTime +Whether to use localTime of the virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomRdpProperty +Custom rdp property of HostPool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of HostPool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Friendly name of HostPool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LoadBalancerType +The type of the load balancer. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.LoadBalancerType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSessionLimit +The max session limit of HostPool. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: HostPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PersonalDesktopAssignmentType +PersonalDesktopAssignment type for HostPool. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.PersonalDesktopAssignmentType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredAppGroupType +The type of preferred application group type, default to Desktop Application Group + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.PreferredAppGroupType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationInfoExpirationTime +Expiration time of registration token. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationInfoRegistrationTokenOperation +The type of resetting the token. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.RegistrationTokenOperation +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ring +The ring number of HostPool. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SsoadfsAuthority +URL to customer ADFS server for signing WVD SSO certificates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SsoClientId +ClientId for the registered Relying Party used to issue WVD SSO certificates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SsoClientSecretKeyVaultPath +Path to Azure KeyVault storing the secret used for communication to ADFS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SsoSecretType +The type of single sign on Secret Type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SsoSecretType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartVMOnConnect +The flag to turn on/off StartVMOnConnect feature. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +tags to be updated + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationEnvironment +Is validation environment. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMTemplate +VM template for sessionhosts configuration within hostpool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IHostPool + +## 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. + + +`AGENTUPDATEMAINTENANCEWINDOW <IMaintenanceWindowPatchProperties[]>`: List of maintenance windows. Maintenance windows are 2 hours long. + - `[DayOfWeek <DayOfWeek?>]`: Day of the week. + - `[Hour <Int32?>]`: The update start hour of the day. (0 - 23) + +`INPUTOBJECT <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdMsixPackage.md b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdMsixPackage.md new file mode 100644 index 0000000000..d99062714d --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdMsixPackage.md @@ -0,0 +1,261 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/update-azwvdmsixpackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdMsixPackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdMsixPackage.md +--- + +# Update-AzWvdMsixPackage + +## SYNOPSIS +Update an MSIX Package. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWvdMsixPackage -FullName <String> -HostPoolName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DisplayName <String>] [-IsActive] [-IsRegularRegistration] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWvdMsixPackage -InputObject <IDesktopVirtualizationIdentity> [-DisplayName <String>] [-IsActive] + [-IsRegularRegistration] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update an MSIX Package. + +## EXAMPLES + +### Example 1: Update a MSIX Package +```powershell +Update-AzWvdMsixPackage -HostPoolName HostPoolName ` + -ResourceGroupName ResourceGroupName ` + -SubscriptionId SubscriptionId ` + -displayName 'Updated-display-Name' ` + -IsRegularRegistration:$False ` + -IsActive:$True +``` + +```output +Name Type +---- ---- +HostPoolName/MSIXPackage_FullName1 Microsoft.DesktopVirtualization/hostpools/msixpackages +``` + +This command updates a MSIX Package in a HostPool. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display name for MSIX Package. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullName +The version specific package full name of the MSIX package within specified hostpool + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: MsixPackageFullName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsActive +Set a version of the package to be active across hostpool. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsRegularRegistration +Set Registration mode. +Regular or Delayed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IMsixPackage + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdScalingPlan.md b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdScalingPlan.md new file mode 100644 index 0000000000..9854aa557b --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdScalingPlan.md @@ -0,0 +1,371 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/update-azwvdscalingplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdScalingPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdScalingPlan.md +--- + +# Update-AzWvdScalingPlan + +## SYNOPSIS +Update a scaling plan. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWvdScalingPlan -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Description <String>] [-ExclusionTag <String>] [-FriendlyName <String>] + [-HostPoolReference <IScalingHostPoolReference[]>] [-Schedule <IScalingSchedule[]>] [-Tag <Hashtable>] + [-TimeZone <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWvdScalingPlan -InputObject <IDesktopVirtualizationIdentity> [-Description <String>] + [-ExclusionTag <String>] [-FriendlyName <String>] [-HostPoolReference <IScalingHostPoolReference[]>] + [-Schedule <IScalingSchedule[]>] [-Tag <Hashtable>] [-TimeZone <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a scaling plan. + +## EXAMPLES + +### Example 1: Update a Windows Virtual Desktop Scaling Plan by name +```powershell +Update-AzWvdScalingPlan ` + -ResourceGroupName ResourceGroupName ` + -Name 'scalingPlan1' ` + -Description 'Description' ` + -FriendlyName 'Friendly Name' ` + -TimeZone '(UTC-08:00) Pacific Time (US & Canada)' ` + -Schedule @( + @{ + 'name' = 'Work Week'; + 'daysOfWeek' = @('Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'); + 'rampUpStartTime' = '1900-01-01T06:00:00Z'; + 'rampUpLoadBalancingAlgorithm' = 'BreadthFirst'; + 'rampUpMinimumHostsPct' = 20; + 'rampUpCapacityThresholdPct' = 20; + 'peakStartTime' = '1900-01-01T08:00:00Z'; + 'peakLoadBalancingAlgorithm' = 'DepthFirst'; + 'RampDownStartTime' = '1900-01-01T18:00:00Z'; + 'rampDownLoadBalancingAlgorithm' = 'BreadthFirst'; + 'rampDownMinimumHostsPct' = 20; + 'rampDownCapacityThresholdPct' = 20; + 'rampDownForceLogoffUser' = $true; + 'rampDownWaitTimeMinute' = 30; + 'rampDownNotificationMessage' = 'Log out now, please.'; + 'rampDownStopHostsWhen' = 'ZeroSessions'; + 'offPeakStartTime' = '1900-01-01T20:00:00Z'; + 'offPeakLoadBalancingAlgorithm' = 'DepthFirst'; + } + ) ` + -HostPoolReference @( + @{ + 'hostPoolArmPath' = '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName1'; + 'scalingPlanEnabled' = $false; + }, + @{ + 'hostPoolArmPath' = '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName2'; + 'scalingPlanEnabled' = $false; + } + + ) +``` + +```output +Location Name Type +-------- ---- ---- +westcentralus scalingPlan1 Microsoft.DesktopVirtualization/scalingplans +``` + +This command updates a Windows Virtual Desktop Scaling Plan in a Resource Group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of scaling plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionTag +Exclusion tag for scaling plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +User friendly name of scaling plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolReference +List of ScalingHostPoolReference definitions. +To construct, see NOTES section for HOSTPOOLREFERENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IScalingHostPoolReference[] +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.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the scaling plan. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ScalingPlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schedule +List of ScalingSchedule definitions. +To construct, see NOTES section for SCHEDULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IScalingSchedule[] +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +tags to be updated + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeZone +Timezone of the scaling plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IScalingPlan + +## 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. + + +`HOSTPOOLREFERENCE <IScalingHostPoolReference[]>`: List of ScalingHostPoolReference definitions. + - `[HostPoolArmPath <String>]`: Arm path of referenced hostpool. + - `[ScalingPlanEnabled <Boolean?>]`: Is the scaling plan enabled for this hostpool. + +`INPUTOBJECT <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +`SCHEDULE <IScalingSchedule[]>`: List of ScalingSchedule definitions. + - `[DaysOfWeek <String[]>]`: Set of days of the week on which this schedule is active. + - `[Name <String>]`: Name of the ScalingPlanPooledSchedule. + - `[OffPeakLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm?>]`: Load balancing algorithm for off-peak period. + - `[OffPeakStartTimeHour <Int32?>]`: The hour. + - `[OffPeakStartTimeMinute <Int32?>]`: The minute. + - `[PeakLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm?>]`: Load balancing algorithm for peak period. + - `[PeakStartTimeHour <Int32?>]`: The hour. + - `[PeakStartTimeMinute <Int32?>]`: The minute. + - `[RampDownCapacityThresholdPct <Int32?>]`: Capacity threshold for ramp down period. + - `[RampDownForceLogoffUser <Boolean?>]`: Should users be logged off forcefully from hosts. + - `[RampDownLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm?>]`: Load balancing algorithm for ramp down period. + - `[RampDownMinimumHostsPct <Int32?>]`: Minimum host percentage for ramp down period. + - `[RampDownNotificationMessage <String>]`: Notification message for users during ramp down period. + - `[RampDownStartTimeHour <Int32?>]`: The hour. + - `[RampDownStartTimeMinute <Int32?>]`: The minute. + - `[RampDownStopHostsWhen <StopHostsWhen?>]`: Specifies when to stop hosts during ramp down period. + - `[RampDownWaitTimeMinute <Int32?>]`: Number of minutes to wait to stop hosts during ramp down period. + - `[RampUpCapacityThresholdPct <Int32?>]`: Capacity threshold for ramp up period. + - `[RampUpLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm?>]`: Load balancing algorithm for ramp up period. + - `[RampUpMinimumHostsPct <Int32?>]`: Minimum host percentage for ramp up period. + - `[RampUpStartTimeHour <Int32?>]`: The hour. + - `[RampUpStartTimeMinute <Int32?>]`: The minute. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdScalingPlanPooledSchedule.md b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdScalingPlanPooledSchedule.md new file mode 100644 index 0000000000..7fbf6124ea --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdScalingPlanPooledSchedule.md @@ -0,0 +1,565 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/update-azwvdscalingplanpooledschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdScalingPlanPooledSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdScalingPlanPooledSchedule.md +--- + +# Update-AzWvdScalingPlanPooledSchedule + +## SYNOPSIS +Update a ScalingPlanPooledSchedule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWvdScalingPlanPooledSchedule -ResourceGroupName <String> -ScalingPlanName <String> + -ScalingPlanScheduleName <String> [-SubscriptionId <String>] [-DaysOfWeek <DayOfWeek[]>] + [-OffPeakLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>] [-OffPeakStartTimeHour <Int32>] + [-OffPeakStartTimeMinute <Int32>] [-PeakLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>] + [-PeakStartTimeHour <Int32>] [-PeakStartTimeMinute <Int32>] [-RampDownCapacityThresholdPct <Int32>] + [-RampDownForceLogoffUser] [-RampDownLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>] + [-RampDownMinimumHostsPct <Int32>] [-RampDownNotificationMessage <String>] [-RampDownStartTimeHour <Int32>] + [-RampDownStartTimeMinute <Int32>] [-RampDownStopHostsWhen <StopHostsWhen>] [-RampDownWaitTimeMinute <Int32>] + [-RampUpCapacityThresholdPct <Int32>] [-RampUpLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>] + [-RampUpMinimumHostsPct <Int32>] [-RampUpStartTimeHour <Int32>] [-RampUpStartTimeMinute <Int32>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWvdScalingPlanPooledSchedule -InputObject <IDesktopVirtualizationIdentity> + [-DaysOfWeek <DayOfWeek[]>] [-OffPeakLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>] + [-OffPeakStartTimeHour <Int32>] [-OffPeakStartTimeMinute <Int32>] + [-PeakLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>] [-PeakStartTimeHour <Int32>] + [-PeakStartTimeMinute <Int32>] [-RampDownCapacityThresholdPct <Int32>] [-RampDownForceLogoffUser] + [-RampDownLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>] [-RampDownMinimumHostsPct <Int32>] + [-RampDownNotificationMessage <String>] [-RampDownStartTimeHour <Int32>] [-RampDownStartTimeMinute <Int32>] + [-RampDownStopHostsWhen <StopHostsWhen>] [-RampDownWaitTimeMinute <Int32>] + [-RampUpCapacityThresholdPct <Int32>] [-RampUpLoadBalancingAlgorithm <SessionHostLoadBalancingAlgorithm>] + [-RampUpMinimumHostsPct <Int32>] [-RampUpStartTimeHour <Int32>] [-RampUpStartTimeMinute <Int32>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a ScalingPlanPooledSchedule. + +## EXAMPLES + +### Example 1: Update a ScalingPlanPooledSchedule +```powershell +Update-AzWvdScalingPlanPooledSchedule -ResourceGroupName rgName ` + -ScalingPlanName spName ` + -ScalingPlanScheduleName scheduleName ` + -daysOfWeek @('Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday') ` + -rampUpStartTimeHour 6 ` + -rampUpStartTimeMinute 30 ` + -rampUpLoadBalancingAlgorithm BreadthFirst ` + -rampUpMinimumHostsPct 20 ` + -rampUpCapacityThresholdPct 20 ` + -peakStartTimeHour 8 ` + -peakStartTimeMinute 30 ` + -peakLoadBalancingAlgorithm DepthFirst ` + -RampDownStartTimeHour 16 ` + -RampDownStartTimeMinute 0 ` + -rampDownLoadBalancingAlgorithm BreadthFirst ` + -rampDownMinimumHostsPct 20 ` + -rampDownCapacityThresholdPct 20 ` + -rampDownForceLogoffUser:$true ` + -rampDownWaitTimeMinute 30 ` + -rampDownNotificationMessage "Log out now, please." ` + -rampDownStopHostsWhen ZeroSessions ` + -offPeakStartTimeHour 22 ` + -offPeakStartTimeMinute 45 ` + -offPeakLoadBalancingAlgorithm DepthFirst +``` + +```output +Name +---- +spName/scheduleName +``` + +Updates an existing PooledSchedule in a Scaling Plan. + +## PARAMETERS + +### -DaysOfWeek +Set of days of the week on which this schedule is active. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.DayOfWeek[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OffPeakLoadBalancingAlgorithm +Load balancing algorithm for off-peak period. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SessionHostLoadBalancingAlgorithm +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OffPeakStartTimeHour +The hour. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OffPeakStartTimeMinute +The minute. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeakLoadBalancingAlgorithm +Load balancing algorithm for peak period. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SessionHostLoadBalancingAlgorithm +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeakStartTimeHour +The hour. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeakStartTimeMinute +The minute. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownCapacityThresholdPct +Capacity threshold for ramp down period. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownForceLogoffUser +Should users be logged off forcefully from hosts. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownLoadBalancingAlgorithm +Load balancing algorithm for ramp down period. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SessionHostLoadBalancingAlgorithm +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownMinimumHostsPct +Minimum host percentage for ramp down period. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownNotificationMessage +Notification message for users during ramp down period. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownStartTimeHour +The hour. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownStartTimeMinute +The minute. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownStopHostsWhen +Specifies when to stop hosts during ramp down period. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.StopHostsWhen +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampDownWaitTimeMinute +Number of minutes to wait to stop hosts during ramp down period. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampUpCapacityThresholdPct +Capacity threshold for ramp up period. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampUpLoadBalancingAlgorithm +Load balancing algorithm for ramp up period. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.SessionHostLoadBalancingAlgorithm +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampUpMinimumHostsPct +Minimum host percentage for ramp up period. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampUpStartTimeHour +The hour. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RampUpStartTimeMinute +The minute. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScalingPlanName +The name of the scaling plan. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScalingPlanScheduleName +The name of the ScalingPlanSchedule + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IScalingPlanPooledSchedule + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdSessionHost.md b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdSessionHost.md new file mode 100644 index 0000000000..88e3ed3ea4 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdSessionHost.md @@ -0,0 +1,274 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/update-azwvdsessionhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdSessionHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdSessionHost.md +--- + +# Update-AzWvdSessionHost + +## SYNOPSIS +Update a session host. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWvdSessionHost -HostPoolName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Force] [-AllowNewSession] [-AssignedUser <String>] [-FriendlyName <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWvdSessionHost -InputObject <IDesktopVirtualizationIdentity> [-Force] [-AllowNewSession] + [-AssignedUser <String>] [-FriendlyName <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Update a session host. + +## EXAMPLES + +### Example 1: Update a Windows Virtual Desktop SessionHost by name +```powershell +Update-AzWvdSessionHost -ResourceGroupName ResourceGroupName ` + -HostPoolName HostPoolName ` + -Name SessionHostName ` + -AllowNewSession:$false +``` + +```output +Name Type +---- ---- +HostPoolName/SessionHostName Microsoft.DesktopVirtualization/hostpools/sessionhosts +``` + +This command updates a Windows Virtual Desktop SessionHost in a Host Pool. + +## PARAMETERS + +### -AllowNewSession +Allow a new session. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignedUser +User assigned to SessionHost. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force flag to update assign, unassign or reassign personal desktop. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Friendly name of SessionHost + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPoolName +The name of the host pool within the specified resource group + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the session host within the specified host pool + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: SessionHostName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.ISessionHost + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdWorkspace.md b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdWorkspace.md new file mode 100644 index 0000000000..4125098f41 --- /dev/null +++ b/azps-10.1.0/Az.DesktopVirtualization/Update-AzWvdWorkspace.md @@ -0,0 +1,260 @@ +--- +external help file: +Module Name: Az.DesktopVirtualization +online version: https://learn.microsoft.com/powershell/module/az.desktopvirtualization/update-azwvdworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DesktopVirtualization/help/Update-AzWvdWorkspace.md +--- + +# Update-AzWvdWorkspace + +## SYNOPSIS +Update a workspace. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWvdWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-ApplicationGroupReference <String[]>] [-Description <String>] [-FriendlyName <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWvdWorkspace -InputObject <IDesktopVirtualizationIdentity> [-ApplicationGroupReference <String[]>] + [-Description <String>] [-FriendlyName <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a workspace. + +## EXAMPLES + +### Example 1: Update a Windows Virtual Desktop Workspace by name +```powershell +Update-AzWvdWorkspace -ResourceGroupName ResourceGroupName ` + -Name WorkspaceName ` + -FriendlyName 'Friendly Name' ` + -ApplicationGroupReference "/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/ApplicationGroupName1","/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/applicationGroups/ApplicationGroupName2" ` + -Description 'Description' +``` + +```output +Location Name Type +-------- ---- ---- +eastus WorkspaceName Microsoft.DesktopVirtualization/workspaces +``` + +This command updates a Windows Virtual Desktop Workspace in a Resource Group. + +## PARAMETERS + +### -ApplicationGroupReference +List of applicationGroup links. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of Workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Friendly name of Workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +tags to be updated + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api202209.IWorkspace + +## 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 <IDesktopVirtualizationIdentity>`: Identity Parameter + - `[ApplicationGroupName <String>]`: The name of the application group + - `[ApplicationName <String>]`: The name of the application within the specified application group + - `[DesktopName <String>]`: The name of the desktop within the specified desktop group + - `[HostPoolName <String>]`: The name of the host pool within the specified resource group + - `[Id <String>]`: Resource identity path + - `[MsixPackageFullName <String>]`: The version specific package full name of the MSIX package within specified hostpool + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScalingPlanName <String>]`: The name of the scaling plan. + - `[ScalingPlanScheduleName <String>]`: The name of the ScalingPlanSchedule + - `[SessionHostName <String>]`: The name of the session host within the specified host pool + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[UserSessionId <String>]`: The name of the user session within the specified session host + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DevSpaces/Az.DevSpaces.md b/azps-10.1.0/Az.DevSpaces/Az.DevSpaces.md new file mode 100644 index 0000000000..fdc217e31e --- /dev/null +++ b/azps-10.1.0/Az.DevSpaces/Az.DevSpaces.md @@ -0,0 +1,27 @@ +--- +Module Name: Az.DevSpaces +Module Guid: 4ff83407-3957-414b-9855-6808a10e8955 +Download Help Link: https://learn.microsoft.com/powershell/module/az.devspaces +Help Version: 0.0.1.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevSpaces/DevSpaces/help/Az.DevSpaces.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevSpaces/DevSpaces/help/Az.DevSpaces.md +--- + +# Az.DevSpaces Module +## Description +Commands to interact with Azure DevSpaces Controller. + +## Az.DevSpaces Cmdlets +### [Get-AzDevSpacesController](Get-AzDevSpacesController.md) +Get or list Azure DevSpaces controller. + +### [New-AzDevSpacesController](New-AzDevSpacesController.md) +Create a new Azure DevSpaces controller. + +### [Remove-AzDevSpacesController](Remove-AzDevSpacesController.md) +Delete a DevSpaces controller. + +### [Update-AzDevSpacesController](Update-AzDevSpacesController.md) +Update the DevSpaces controller to add tags. + diff --git a/azps-10.1.0/Az.DevSpaces/Get-AzDevSpacesController.md b/azps-10.1.0/Az.DevSpaces/Get-AzDevSpacesController.md new file mode 100644 index 0000000000..e73e03dfdf --- /dev/null +++ b/azps-10.1.0/Az.DevSpaces/Get-AzDevSpacesController.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevSpaces.dll-Help.xml +Module Name: Az.DevSpaces +online version: https://learn.microsoft.com/powershell/module/az.devspaces/get-azdevspacescontroller +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevSpaces/DevSpaces/help/Get-AzDevSpacesController.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevSpaces/DevSpaces/help/Get-AzDevSpacesController.md +--- + +# Get-AzDevSpacesController + +## SYNOPSIS +Get or list Azure DevSpaces controller. + +## SYNTAX + +### ListDevSpacesControllerParameterSet (Default) +``` +Get-AzDevSpacesController [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### DevSpacesControllerNameParameterSet +``` +Get-AzDevSpacesController [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list Azure DevSpaces controller. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDevSpacesController +``` + +```output +Name Resource Group Location Provisioning State +---------- -------------- -------- ------------------ +devSpaceControllerName devSpaceResourceGroup eastus Succeeded +``` + +List all controllers in a subscription. + +### Example 2 +```powershell +Get-AzDevSpacesController -ResourceGroupName devSpaceResourceGroup -Name devSpaceControllerName +``` + +```output +Name Resource Group Location Provisioning State +---------- -------------- -------- ------------------ +devSpaceControllerName devSpaceResourceGroup eastus Succeeded +``` + +Get a DevSpaces controllers in a subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +DevSpaces controller name. + +```yaml +Type: System.String +Parameter Sets: DevSpacesControllerNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: ListDevSpacesControllerParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: DevSpacesControllerNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DevSpaces.Models.PSController + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DevSpaces/New-AzDevSpacesController.md b/azps-10.1.0/Az.DevSpaces/New-AzDevSpacesController.md new file mode 100644 index 0000000000..531f44af76 --- /dev/null +++ b/azps-10.1.0/Az.DevSpaces/New-AzDevSpacesController.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevSpaces.dll-Help.xml +Module Name: Az.DevSpaces +online version: https://learn.microsoft.com/powershell/module/az.devspaces/new-azdevspacescontroller +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevSpaces/DevSpaces/help/New-AzDevSpacesController.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevSpaces/DevSpaces/help/New-AzDevSpacesController.md +--- + +# New-AzDevSpacesController + +## SYNOPSIS +Create a new Azure DevSpaces controller. + +## SYNTAX + +``` +New-AzDevSpacesController [-ResourceGroupName] <String> [-Name] <String> [-TargetResourceGroupName] <String> + [-TargetClusterName] <String> [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new Azure DevSpaces controller. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDevSpacesController -ResourceGroupName devSpaceResourceGroup -Name devSpaceControllerName -TargetResourceGroupName clusterResourceGroup -TargetClusterName clusterName +``` + +```output +Name Resource Group Location Provisioning State +---------- -------------- -------- ------------------ +devSpaceControllerName devSpaceResourceGroup eastus Succeeded +``` + +Create a DevSpaces controller in resourcegroup devSpaceResourceGroup with a name devSpaceName. Use clusterName cluster as a target for this controller. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +DevSpaces Controller Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetClusterName +Target Cluster Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +Target Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.DevSpaces.Models.PSController + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DevSpaces/Remove-AzDevSpacesController.md b/azps-10.1.0/Az.DevSpaces/Remove-AzDevSpacesController.md new file mode 100644 index 0000000000..da7f9f90e7 --- /dev/null +++ b/azps-10.1.0/Az.DevSpaces/Remove-AzDevSpacesController.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevSpaces.dll-Help.xml +Module Name: Az.DevSpaces +online version: https://learn.microsoft.com/powershell/module/az.devspaces/remove-azdevspacescontroller +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevSpaces/DevSpaces/help/Remove-AzDevSpacesController.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevSpaces/DevSpaces/help/Remove-AzDevSpacesController.md +--- + +# Remove-AzDevSpacesController + +## SYNOPSIS +Delete a DevSpaces controller. + +## SYNTAX + +### DevSpacesControllerNameParameterSet (Default) +``` +Remove-AzDevSpacesController [-ResourceGroupName] <String> [-Name] <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzDevSpacesController -ResourceId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzDevSpacesController -InputObject <PSController> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a DevSpaces controller. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDevSpacesController -ResourceGroupName devSpaceResourceGroup -Name devSpaceControllerName +``` + +Delete a DevSpaces controller named devSpaceControllerName. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +A PSController object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.DevSpaces.Models.PSController +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +DevSpaces controller name. + +```yaml +Type: System.String +Parameter Sets: DevSpacesControllerNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true if delete is successful + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: DevSpacesControllerNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The DevSpaces resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DevSpaces.Models.PSController + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DevSpaces/Update-AzDevSpacesController.md b/azps-10.1.0/Az.DevSpaces/Update-AzDevSpacesController.md new file mode 100644 index 0000000000..eb9aae3a13 --- /dev/null +++ b/azps-10.1.0/Az.DevSpaces/Update-AzDevSpacesController.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevSpaces.dll-Help.xml +Module Name: Az.DevSpaces +online version: https://learn.microsoft.com/powershell/module/az.devspaces/update-azdevspacescontroller +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevSpaces/DevSpaces/help/Update-AzDevSpacesController.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevSpaces/DevSpaces/help/Update-AzDevSpacesController.md +--- + +# Update-AzDevSpacesController + +## SYNOPSIS +Update the DevSpaces controller to add tags. + +## SYNTAX + +### DevSpacesControllerNameParameterSet (Default) +``` +Update-AzDevSpacesController [-ResourceGroupName] <String> [-Name] <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Update-AzDevSpacesController -ResourceId <String> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Update-AzDevSpacesController -InputObject <PSController> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update the DevSpaces controller to add tags. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzDevSpacesController -ResourceGroupName devSpaceResourceGroup -Name devSpaceControllerName -Tag @{ tagKey="tagValue"} +``` + +```output +Name Resource Group Location Provisioning State +---------- -------------- -------- ------------------ +devSpaceControllerName devSpaceResourceGroup eastus Succeeded +``` + +Tag a DevSpaces controller. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +A PSController object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.DevSpaces.Models.PSController +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +DevSpaces controller name. + +```yaml +Type: System.String +Parameter Sets: DevSpacesControllerNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name + +```yaml +Type: System.String +Parameter Sets: DevSpacesControllerNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The DevSpaces resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.DevSpaces.Models.PSController + +## OUTPUTS + +### Microsoft.Azure.Commands.DevSpaces.Models.PSController + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DevTestLabs/Az.DevTestLabs.md b/azps-10.1.0/Az.DevTestLabs/Az.DevTestLabs.md new file mode 100644 index 0000000000..0c24bbdcd6 --- /dev/null +++ b/azps-10.1.0/Az.DevTestLabs/Az.DevTestLabs.md @@ -0,0 +1,45 @@ +--- +Module Name: Az.DevTestLabs +Module Guid: be2ca175-bfb9-4601-b01c-4de13eb2105c +Download Help Link: https://learn.microsoft.com/powershell/module/az.devtestlabs +Help Version: 4.0.4.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Az.DevTestLabs.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Az.DevTestLabs.md +--- + +# Az.DevTestLabs Module +## Description +This topic displays help topics for the DevTest Labs feature in Azure App Service cmdlets. + +## Az.DevTestLabs Cmdlets +### [Get-AzDtlAllowedVMSizesPolicy](Get-AzDtlAllowedVMSizesPolicy.md) +Gets the allowed virtual machine sizes policy of a lab in DevTest Labs. + +### [Get-AzDtlAutoShutdownPolicy](Get-AzDtlAutoShutdownPolicy.md) +Gets the auto shutdown policy of a lab in DevTest Labs. + +### [Get-AzDtlAutoStartPolicy](Get-AzDtlAutoStartPolicy.md) +Gets the auto start policy of a lab in DevTest Labs. + +### [Get-AzDtlVMsPerLabPolicy](Get-AzDtlVMsPerLabPolicy.md) +Gets the virtual machines per lab policy of a lab in DevTest Labs. + +### [Get-AzDtlVMsPerUserPolicy](Get-AzDtlVMsPerUserPolicy.md) +Gets the virtual machines per user policy of a lab in DevTest Labs. + +### [Set-AzDtlAllowedVMSizesPolicy](Set-AzDtlAllowedVMSizesPolicy.md) +Sets the allowed virtual machine sizes policy of a lab in DevTest Labs. + +### [Set-AzDtlAutoShutdownPolicy](Set-AzDtlAutoShutdownPolicy.md) +Sets the auto shutdown policy of a lab DevTest Labs. + +### [Set-AzDtlAutoStartPolicy](Set-AzDtlAutoStartPolicy.md) +Sets the auto start policy of a lab in DevTest Labs. + +### [Set-AzDtlVMsPerLabPolicy](Set-AzDtlVMsPerLabPolicy.md) +Sets the virtual machines per lab policy of a lab in DevTest Labs. + +### [Set-AzDtlVMsPerUserPolicy](Set-AzDtlVMsPerUserPolicy.md) +Sets the virtual machines per user policy of a lab in DevTest Labs. + diff --git a/azps-10.1.0/Az.DevTestLabs/Get-AzDtlAllowedVMSizesPolicy.md b/azps-10.1.0/Az.DevTestLabs/Get-AzDtlAllowedVMSizesPolicy.md new file mode 100644 index 0000000000..ed52102266 --- /dev/null +++ b/azps-10.1.0/Az.DevTestLabs/Get-AzDtlAllowedVMSizesPolicy.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevTestLabs.dll-Help.xml +Module Name: Az.DevTestLabs +ms.assetid: 869167AA-54F8-4A1C-AC08-5555A63EE1BC +online version: https://learn.microsoft.com/powershell/module/az.devtestlabs/get-azdtlallowedvmsizespolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Get-AzDtlAllowedVMSizesPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Get-AzDtlAllowedVMSizesPolicy.md +--- + +# Get-AzDtlAllowedVMSizesPolicy + +## SYNOPSIS +Gets the allowed virtual machine sizes policy of a lab in DevTest Labs. + +## SYNTAX + +``` +Get-AzDtlAllowedVMSizesPolicy [-LabName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDtlAllowedVMSizesPolicy** cmdlet gets the allowed virtual machine sizes policy, which allows you to specify a list of virtual machine sizes allowed in the lab. +The cmdlet returns the enabled or disabled status of the policy and a list of all the allowed virtual machine sizes that you have set in the specified policy. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDtlAllowedVMSizesPolicy -LabName debtestlab -ResourceGroupName yuzhi-rg +``` + +```output +Name : AllowedVmSizesInLab +Type : Microsoft.DevTestLab/labs/policySets/policies +Tags : +Id : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourcegroups/yuzhi-rg/providers/microsoft.devtestlab/labs/debte + stlab/policysets/default/policies/allowedvmsizesinlab +Location : +Fact Name : LabVmSize +Threshold : ["Basic_A0"] +Evaluator Type : AllowedValuesPolicy +Description : +Status : Enabled +Provisioning State : +``` +Gets the allowed virtual machine sizes policy of a lab in DevTest Labs. + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +Specifies the name of the lab for which this cmdlet gets virtual machines size policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the lab belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DevTestLabs.Models.PSPolicy + +## NOTES + +## RELATED LINKS + +[Set-AzDtlAllowedVMSizesPolicy](./Set-AzDtlAllowedVMSizesPolicy.md) + + diff --git a/azps-10.1.0/Az.DevTestLabs/Get-AzDtlAutoShutdownPolicy.md b/azps-10.1.0/Az.DevTestLabs/Get-AzDtlAutoShutdownPolicy.md new file mode 100644 index 0000000000..d140eaae43 --- /dev/null +++ b/azps-10.1.0/Az.DevTestLabs/Get-AzDtlAutoShutdownPolicy.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevTestLabs.dll-Help.xml +Module Name: Az.DevTestLabs +ms.assetid: 52DD0511-915F-4144-B47F-E4B7AF403AA5 +online version: https://learn.microsoft.com/powershell/module/az.devtestlabs/get-azdtlautoshutdownpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Get-AzDtlAutoShutdownPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Get-AzDtlAutoShutdownPolicy.md +--- + +# Get-AzDtlAutoShutdownPolicy + +## SYNOPSIS +Gets the auto shutdown policy of a lab in DevTest Labs. + +## SYNTAX + +``` +Get-AzDtlAutoShutdownPolicy [-LabName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDtlAutoShutdownPolicy** cmdlet gets the auto shutdown policy of a lab, which allows you to automatically shut down all the virtual machines in a lab at a specified time of the day. +The cmdlet returns whether the status of the policy is enabled, and the time of day that you have set to automatically shut down the lab virtual machines. + +## EXAMPLES + +### Example 1 + +Gets the auto shutdown policy of a lab in DevTest Labs. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzDtlAutoShutdownPolicy -LabName <String> -ResourceGroupName MyResourceGroup +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +Specifies the name of the lab for which this cmdlet gets the auto shutdown policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the lab belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DevTestLabs.Models.PSSchedule + +## NOTES + +## RELATED LINKS + +[Set-AzDtlAutoShutdownPolicy](./Set-AzDtlAutoShutdownPolicy.md) + + diff --git a/azps-10.1.0/Az.DevTestLabs/Get-AzDtlAutoStartPolicy.md b/azps-10.1.0/Az.DevTestLabs/Get-AzDtlAutoStartPolicy.md new file mode 100644 index 0000000000..7c8acc42a7 --- /dev/null +++ b/azps-10.1.0/Az.DevTestLabs/Get-AzDtlAutoStartPolicy.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevTestLabs.dll-Help.xml +Module Name: Az.DevTestLabs +ms.assetid: 9FD4DB8C-B242-4F9A-92E5-0B3EDED00521 +online version: https://learn.microsoft.com/powershell/module/az.devtestlabs/get-azdtlautostartpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Get-AzDtlAutoStartPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Get-AzDtlAutoStartPolicy.md +--- + +# Get-AzDtlAutoStartPolicy + +## SYNOPSIS +Gets the auto start policy of a lab in DevTest Labs. + +## SYNTAX + +``` +Get-AzDtlAutoStartPolicy [-LabName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDtlAutoStartPolicy** cmdlet gets the auto start policy of a lab which schedules lab virtual machines for automatic start. +The cmdlet returns the enabled or disabled status of the policy and the days of the week and time of day that you have set to allow lab virtual machines to be scheduled for automatic start. + +## EXAMPLES + +### Example 1 + +Gets the auto start policy of a lab in DevTest Labs. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzDtlAutoStartPolicy -LabName <String> -ResourceGroupName MyResourceGroup +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +Specifies the name of the lab for which this cmdlet gets the auto start policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the lab belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DevTestLabs.Models.PSSchedule + +## NOTES + +## RELATED LINKS + +[Set-AzDtlAutoStartPolicy](./Set-AzDtlAutoStartPolicy.md) + + diff --git a/azps-10.1.0/Az.DevTestLabs/Get-AzDtlVMsPerLabPolicy.md b/azps-10.1.0/Az.DevTestLabs/Get-AzDtlVMsPerLabPolicy.md new file mode 100644 index 0000000000..1ce92d478c --- /dev/null +++ b/azps-10.1.0/Az.DevTestLabs/Get-AzDtlVMsPerLabPolicy.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevTestLabs.dll-Help.xml +Module Name: Az.DevTestLabs +ms.assetid: A3F653C7-6F9D-4B2B-81F8-0A012D80ECC7 +online version: https://learn.microsoft.com/powershell/module/az.devtestlabs/get-azdtlvmsperlabpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Get-AzDtlVMsPerLabPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Get-AzDtlVMsPerLabPolicy.md +--- + +# Get-AzDtlVMsPerLabPolicy + +## SYNOPSIS +Gets the virtual machines per lab policy of a lab in DevTest Labs. + +## SYNTAX + +``` +Get-AzDtlVMsPerLabPolicy [-LabName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDtlVMsPerLabPolicy** cmdlet gets the virtual machines per lab policy of a lab, which allows you set the total number of virtual machines allowed in a lab. +The cmdlet returns the enabled or disabled status of the policy, and the total number of virtual machines allowed in the lab that you have set in the policy. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDtlVMsPerLabPolicy -LabName debtestlab -ResourceGroupName yuzhi-rg +``` + +```output +Name : MaxVmsAllowedPerLab +Type : Microsoft.DevTestLab/labs/policySets/policies +Tags : +Id : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourcegroups/yuzhi-rg/providers/microsoft.devtestlab/labs/debte + stlab/policysets/default/policies/maxvmsallowedperlab +Location : +Fact Name : LabVmCount +Threshold : 1 +Evaluator Type : MaxValuePolicy +Description : +Status : Enabled +Provisioning State : +``` +Gets the virtual machines per lab policy of a lab in DevTest Labs. + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +Specifies the name of the lab for which this cmdlet gets the virtual machines. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the lab belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DevTestLabs.Models.PSPolicy + +## NOTES + +## RELATED LINKS + +[Set-AzDtlVMsPerLabPolicy](./Set-AzDtlVMsPerLabPolicy.md) + + diff --git a/azps-10.1.0/Az.DevTestLabs/Get-AzDtlVMsPerUserPolicy.md b/azps-10.1.0/Az.DevTestLabs/Get-AzDtlVMsPerUserPolicy.md new file mode 100644 index 0000000000..4e534375eb --- /dev/null +++ b/azps-10.1.0/Az.DevTestLabs/Get-AzDtlVMsPerUserPolicy.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevTestLabs.dll-Help.xml +Module Name: Az.DevTestLabs +ms.assetid: 5029179A-99A5-4350-A8E5-D15ABA59CC93 +online version: https://learn.microsoft.com/powershell/module/az.devtestlabs/get-azdtlvmsperuserpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Get-AzDtlVMsPerUserPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Get-AzDtlVMsPerUserPolicy.md +--- + +# Get-AzDtlVMsPerUserPolicy + +## SYNOPSIS +Gets the virtual machines per user policy of a lab in DevTest Labs. + +## SYNTAX + +``` +Get-AzDtlVMsPerUserPolicy [-LabName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDtlVMsPerUserPolicy** cmdlet gets the virtual machines per user policy of a lab, which allows you to set the maximum number of virtual machines allowed per user. +The cmdlet returns the enabled or disabled status of the policy and the maximum number of virtual machines allowed per user that you have set in the policy. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDtlVMsPerUserPolicy -LabName debtestlab -ResourceGroupName yuzhi-rg +``` + +```output +Name : MaxVmsAllowedPerUser +Type : Microsoft.DevTestLab/labs/policySets/policies +Tags : +Id : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourcegroups/yuzhi-rg/providers/microsoft.devtestlab/labs/debte + stlab/policysets/default/policies/maxvmsallowedperuser +Location : +Fact Name : UserOwnedLabVmCount +Threshold : 1 +Evaluator Type : MaxValuePolicy +Description : +Status : Enabled +Provisioning State : +``` +Gets the virtual machines per user policy of a lab in DevTest Labs. + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +Specifies the name of the lab for which this cmdlet gets the virtual machine per user policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the lab belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DevTestLabs.Models.PSPolicy + +## NOTES + +## RELATED LINKS + +[Set-AzDtlVMsPerUserPolicy](./Set-AzDtlVMsPerUserPolicy.md) + + diff --git a/azps-10.1.0/Az.DevTestLabs/Set-AzDtlAllowedVMSizesPolicy.md b/azps-10.1.0/Az.DevTestLabs/Set-AzDtlAllowedVMSizesPolicy.md new file mode 100644 index 0000000000..b8ad3c3d32 --- /dev/null +++ b/azps-10.1.0/Az.DevTestLabs/Set-AzDtlAllowedVMSizesPolicy.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevTestLabs.dll-Help.xml +Module Name: Az.DevTestLabs +ms.assetid: AAABDD1D-71BF-409C-B50B-9BE861D84229 +online version: https://learn.microsoft.com/powershell/module/az.devtestlabs/set-azdtlallowedvmsizespolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Set-AzDtlAllowedVMSizesPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Set-AzDtlAllowedVMSizesPolicy.md +--- + +# Set-AzDtlAllowedVMSizesPolicy + +## SYNOPSIS +Sets the allowed virtual machine sizes policy of a lab in DevTest Labs. + +## SYNTAX + +### Enable (Default) +``` +Set-AzDtlAllowedVMSizesPolicy [[-VmSizes] <String[]>] [-Enable] [-LabName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Disable +``` +Set-AzDtlAllowedVMSizesPolicy [[-VmSizes] <String[]>] [-Disable] [-LabName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDtlAllowedVMSizesPolicy** cmdlet sets the allowed virtual machine sizes policy, which specifies a list of virtual machine sizes allowed in a lab. +The cmdlet uses the specified resource group and name of the lab to set the policy. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDtlAllowedVMSizesPolicy -LabName debtestlab -ResourceGroupName yuzhi-rg +``` + +```output +Name : AllowedVmSizesInLab +Type : Microsoft.DevTestLab/labs/policySets/policies +Tags : +Id : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourcegroups/yuzhi-rg/providers/microsoft.devtestlab/labs/debte + stlab/policysets/default/policies/allowedvmsizesinlab +Location : +Fact Name : LabVmSize +Threshold : ["Basic_A0"] +Evaluator Type : AllowedValuesPolicy +Description : +Status : Enabled +Provisioning State : +``` +Sets the allowed virtual machine sizes policy of a lab in DevTest Labs. + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disable +Indicates that this cmdlet disables the policy. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Disable +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Indicates that this cmdlet enables the policy. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Enable +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +Specifies the name of the lab for which this cmdlet sets the virtual machine sizes policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the lab belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VmSizes +Specifies, as a string array, the list of virtual machine sizes allowed in the lab. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DevTestLabs.Models.PSPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzDtlAllowedVMSizesPolicy](./Get-AzDtlAllowedVMSizesPolicy.md) + + diff --git a/azps-10.1.0/Az.DevTestLabs/Set-AzDtlAutoShutdownPolicy.md b/azps-10.1.0/Az.DevTestLabs/Set-AzDtlAutoShutdownPolicy.md new file mode 100644 index 0000000000..220a521b2c --- /dev/null +++ b/azps-10.1.0/Az.DevTestLabs/Set-AzDtlAutoShutdownPolicy.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevTestLabs.dll-Help.xml +Module Name: Az.DevTestLabs +ms.assetid: 8AAD9309-5763-4903-AF6A-1E50310146C0 +online version: https://learn.microsoft.com/powershell/module/az.devtestlabs/set-azdtlautoshutdownpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Set-AzDtlAutoShutdownPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Set-AzDtlAutoShutdownPolicy.md +--- + +# Set-AzDtlAutoShutdownPolicy + +## SYNOPSIS +Sets the auto shutdown policy of a lab DevTest Labs. + +## SYNTAX + +### Enable (Default) +``` +Set-AzDtlAutoShutdownPolicy [[-Time] <DateTime>] [-Enable] [-LabName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Disable +``` +Set-AzDtlAutoShutdownPolicy [[-Time] <DateTime>] [-Disable] [-LabName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDtlAutoShutdownPolicy** cmdlet sets the auto shutdown policy of a lab, which automatically shuts down all the virtual machines in the lab at a specified time of the day. +The cmdlet uses the specified resource group and name of the lab to set the policy. + +## EXAMPLES + +### Example 1 + +Sets the auto shutdown policy of a lab DevTest Labs. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Set-AzDtlAutoShutdownPolicy -Enable -LabName <String> -ResourceGroupName MyResourceGroup -Time <DateTime> +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disable +Indicates that the cmdlet disables the policy in the lab. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Disable +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Indicates that the cmdlet enables the policy in the lab. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Enable +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +Specifies the name of the lab for which this cmdlet sets the auto shutdown policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the lab belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Time +Specifies the time, as a **DateTime** object, for when the virtual machines in the lab must shut down. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DevTestLabs.Models.PSSchedule + +## NOTES + +## RELATED LINKS + +[Get-AzDtlAutoShutdownPolicy](./Get-AzDtlAutoShutdownPolicy.md) + + diff --git a/azps-10.1.0/Az.DevTestLabs/Set-AzDtlAutoStartPolicy.md b/azps-10.1.0/Az.DevTestLabs/Set-AzDtlAutoStartPolicy.md new file mode 100644 index 0000000000..7230c738d5 --- /dev/null +++ b/azps-10.1.0/Az.DevTestLabs/Set-AzDtlAutoStartPolicy.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevTestLabs.dll-Help.xml +Module Name: Az.DevTestLabs +ms.assetid: 3FADEC2E-4A2B-46EB-8A94-CF48D717C7FC +online version: https://learn.microsoft.com/powershell/module/az.devtestlabs/set-azdtlautostartpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Set-AzDtlAutoStartPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Set-AzDtlAutoStartPolicy.md +--- + +# Set-AzDtlAutoStartPolicy + +## SYNOPSIS +Sets the auto start policy of a lab in DevTest Labs. + +## SYNTAX + +### Enable (Default) +``` +Set-AzDtlAutoStartPolicy [[-Time] <DateTime>] [[-Days] <DayOfWeek[]>] [-Enable] [-LabName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Disable +``` +Set-AzDtlAutoStartPolicy [[-Time] <DateTime>] [[-Days] <DayOfWeek[]>] [-Disable] [-LabName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDtlAutoStartPolicy** cmdlet sets the auto start policy of a lab, which allows lab virtual machines to be scheduled for automatic start. +The cmdlet uses the specified resource group and name of the lab to set the policy. + +## EXAMPLES + +### Example 1 + +Sets the auto start policy of a lab in DevTest Labs. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Set-AzDtlAutoStartPolicy -Days Sunday -Enable -LabName <String> -ResourceGroupName MyResourceGroup -Time <DateTime> +``` + +## PARAMETERS + +### -Days +Specifies, as an array, the days of the week for when the virtual machines of the lab must be started. + +```yaml +Type: System.DayOfWeek[] +Parameter Sets: (All) +Aliases: +Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disable +Indicates that this cmdlet disables the policy for the virtual machines in the lab. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Disable +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Indicates that this cmdlet enables the policy for the virtual machines in the lab. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Enable +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +Specifies the name of the lab for which this cmdlet sets the automatic start policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the lab belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Time +Specifies the time when the virtual machines of the lab must be started. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DevTestLabs.Models.PSSchedule + +## NOTES + +## RELATED LINKS + +[Get-AzDtlAutoStartPolicy](./Get-AzDtlAutoStartPolicy.md) + + diff --git a/azps-10.1.0/Az.DevTestLabs/Set-AzDtlVMsPerLabPolicy.md b/azps-10.1.0/Az.DevTestLabs/Set-AzDtlVMsPerLabPolicy.md new file mode 100644 index 0000000000..eafd6d2bde --- /dev/null +++ b/azps-10.1.0/Az.DevTestLabs/Set-AzDtlVMsPerLabPolicy.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevTestLabs.dll-Help.xml +Module Name: Az.DevTestLabs +ms.assetid: D2A7ECF6-E2B1-4BD5-BEA6-C9EC0C7377BA +online version: https://learn.microsoft.com/powershell/module/az.devtestlabs/set-azdtlvmsperlabpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Set-AzDtlVMsPerLabPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Set-AzDtlVMsPerLabPolicy.md +--- + +# Set-AzDtlVMsPerLabPolicy + +## SYNOPSIS +Sets the virtual machines per lab policy of a lab in DevTest Labs. + +## SYNTAX + +### Enable (Default) +``` +Set-AzDtlVMsPerLabPolicy [[-MaxVMs] <Int32>] [-Enable] [-LabName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Disable +``` +Set-AzDtlVMsPerLabPolicy [[-MaxVMs] <Int32>] [-Disable] [-LabName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDtlVMsPerLabPolicy** cmdlet sets the virtual machines per lab policy of a lab, which sets the total number of virtual machines allowed in a lab. +The cmdlet uses the specified resource group and name of the lab to set the policy. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDtlVMsPerLabPolicy -LabName debtestlab -ResourceGroupName yuzhi-rg +``` + +```output +Name : MaxVmsAllowedPerLab +Type : Microsoft.DevTestLab/labs/policySets/policies +Tags : +Id : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourcegroups/yuzhi-rg/providers/microsoft.devtestlab/labs/debte + stlab/policysets/default/policies/maxvmsallowedperlab +Location : +Fact Name : LabVmCount +Threshold : 1 +Evaluator Type : MaxValuePolicy +Description : +Status : Enabled +Provisioning State : +``` +Sets the virtual machines per lab policy of a lab in DevTest Labs. + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disable +Indicates that this cmdlet disables the policy of the lab. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Disable +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Indicates that this cmdlet enables the policy of the lab. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Enable +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +Specifies the name of the lab for which this cmdlet sets the virtual machines per lab policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxVMs +Specifies the maximum number of virtual machines that can be created in the lab. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the lab belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DevTestLabs.Models.PSPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzDtlVMsPerLabPolicy](./Get-AzDtlVMsPerLabPolicy.md) + + diff --git a/azps-10.1.0/Az.DevTestLabs/Set-AzDtlVMsPerUserPolicy.md b/azps-10.1.0/Az.DevTestLabs/Set-AzDtlVMsPerUserPolicy.md new file mode 100644 index 0000000000..fad14ee611 --- /dev/null +++ b/azps-10.1.0/Az.DevTestLabs/Set-AzDtlVMsPerUserPolicy.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DevTestLabs.dll-Help.xml +Module Name: Az.DevTestLabs +ms.assetid: D00E04D9-C91F-4F89-8867-0A026C274F27 +online version: https://learn.microsoft.com/powershell/module/az.devtestlabs/set-azdtlvmsperuserpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Set-AzDtlVMsPerUserPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DevTestLabs/DevTestLabs/help/Set-AzDtlVMsPerUserPolicy.md +--- + +# Set-AzDtlVMsPerUserPolicy + +## SYNOPSIS +Sets the virtual machines per user policy of a lab in DevTest Labs. + +## SYNTAX + +### Enable (Default) +``` +Set-AzDtlVMsPerUserPolicy [[-MaxVMs] <Int32>] [-Enable] [-LabName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Disable +``` +Set-AzDtlVMsPerUserPolicy [[-MaxVMs] <Int32>] [-Disable] [-LabName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDtlVMsPerUserPolicy** cmdlet sets the virtual machines per user policy of a lab, which sets the maximum number of virtual machines allowed per user. +The cmdlet uses the specified resource group and name of the lab to set the policy. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzDtlVMsPerUserPolicy -LabName debtestlab -ResourceGroupName yuzhi-rg +``` + +```output +Name : MaxVmsAllowedPerUser +Type : Microsoft.DevTestLab/labs/policySets/policies +Tags : +Id : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourcegroups/yuzhi-rg/providers/microsoft.devtestlab/labs/debte + stlab/policysets/default/policies/maxvmsallowedperuser +Location : +Fact Name : UserOwnedLabVmCount +Threshold : 1 +Evaluator Type : MaxValuePolicy +Description : +Status : Enabled +Provisioning State : +``` +Sets the virtual machines per user policy of a lab in DevTest Labs. + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disable +Indicates that this cmdlet disables the policy for the lab. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Disable +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Indicates that this cmdlet enables the policy for the lab. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Enable +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +Specifies the name of the lab for which this cmdlet sets the virtual machines per user policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxVMs +Specifies the maximum number of virtual machines that can be created in the lab. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the lab belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.DevTestLabs.Models.PSPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzDtlVMsPerUserPolicy](./Get-AzDtlVMsPerUserPolicy.md) + + diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceAccessPolicy.md b/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceAccessPolicy.md new file mode 100644 index 0000000000..b912123bb2 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceAccessPolicy.md @@ -0,0 +1,226 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/add-aziotdeviceprovisioningserviceaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceAccessPolicy.md +--- + +# Add-AzIoTDeviceProvisioningServiceAccessPolicy + +## SYNOPSIS +Add a new shared access policy in an Azure IoT Hub device provisioning service. + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIoTDeviceProvisioningServiceAccessPolicy [-ResourceGroupName] <String> [-Name] <String> + [-KeyName] <String> [-Permissions] <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIoTDeviceProvisioningServiceAccessPolicy [-DpsObject] <PSProvisioningServiceDescription> + [-KeyName] <String> [-Permissions] <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIoTDeviceProvisioningServiceAccessPolicy [-ResourceId] <String> [-KeyName] <String> + [-Permissions] <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -Permissions "ServiceConfig", "EnrollmentWrite" +``` + +```output +ResourceGroupName : myresourcegroup +Name : myiotdps +KeyName : mypolicy +PrimaryKey : hyZJm8W7rra9O7eKhkLu9m/CIPPt9x1NXVMbMJa1rvg= +SecondaryKey : vbIwGCBQCIbS5BKFKdddM6uZHLhNTuz9r8CZYgmTmpY= +Rights : ServiceConfig, EnrollmentWrite +``` + +Add a new shared access policy in an Azure IoT Hub device provisioning service with EnrollmentWrite and ServiceConfig rights. + +### Example 2 +```powershell +Add-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy2" -Permissions "EnrollmentRead" +``` + +```output +KeyName Rights +------- ------ +mypolicy1 ServiceConfig, EnrollmentWrite +mypolicy2 EnrollmentRead +``` + +Add a new shared access policy in an Azure IoT Hub device provisioning service with EnrollmentRead right. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +IoT Device Provisioning Service access policy key name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permissions +IoT Device Provisioning Service access policy permissions + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: ServiceConfig, EnrollmentRead, EnrollmentWrite, DeviceConnect, RegistrationStatusRead, RegistrationStatusWrite + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceCertificate.md b/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceCertificate.md new file mode 100644 index 0000000000..67b136087e --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceCertificate.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/add-aziotdeviceprovisioningservicecertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceCertificate.md +--- + +# Add-AzIoTDeviceProvisioningServiceCertificate + +## SYNOPSIS +Create/update an Azure IoT Hub Device Provisioning Service certificate. + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIoTDeviceProvisioningServiceCertificate [-ResourceGroupName] <String> [-Name] <String> + [-CertificateName] <String> [-Path] <String> [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIoTDeviceProvisioningServiceCertificate [-InputObject] <PSCertificateResponse> + [-CertificateName] <String> [-Path] <String> [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIoTDeviceProvisioningServiceCertificate [-ResourceId] <String> [-CertificateName] <String> + [-Path] <String> [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Uploads a new certificate or to replace the existing certificate with the same name. +For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/how-to-verify-certificates. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" +``` + +```output +Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate +ResourceGroupName : myresourcegroup +Name : myiotdps +CertificateName : mycertificate +Subject : CN=mycertificate +Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 +Status : Unverified +Expiry : 1/01/2027 16:01 +Created : 1/01/2017 16:01 +Etag : AAAAAAFpGcA= +``` + +Upload a CA certificate CER file to an Azure IoT Hub device provisioning service. + +### Example 2 +```powershell +Add-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" -Etag "AAAAAAFpGcA=" +``` + +```output +Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiothub/certificates/mycertificate +ResourceGroupName : myresourcegroup +Name : myiotdps +CertificateName : mycertificate +Subject : CN=mycertificate +Thumbprint : 38303FC7371EC13DDE3E18D712C8414EE50969C7 +Status : Unverified +Expiry : 1/01/2027 16:01 +Created : 1/01/2017 16:01 +Etag : AAAAAAFpObE= +``` + +Updates a CA certificate in an IoT hub device provisioning service by uploading a new CER file. + +## PARAMETERS + +### -CertificateName +Name of the Iot device provisioning service certificate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Etag of the Certificate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IoT Device Provisioning Service Certificate Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +base-64 representation of X509 certificate .cer file or .pem file path + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Certificate Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceEnrollment.md b/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceEnrollment.md new file mode 100644 index 0000000000..3a2b1235e2 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceEnrollment.md @@ -0,0 +1,552 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/add-aziotdeviceprovisioningserviceenrollment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceEnrollment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceEnrollment.md +--- + +# Add-AzIoTDeviceProvisioningServiceEnrollment + +## SYNOPSIS +Create a device enrollment record. + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIoTDeviceProvisioningServiceEnrollment [-ResourceGroupName] <String> [-DpsName] <String> + -RegistrationId <String> -AttestationType <PSAttestationMechanismType> [-DeviceId <String>] + [-EndorsementKey <String>] [-StorageRootKey <String>] [-PrimaryKey <String>] [-SecondaryKey <String>] + [-PrimaryCertificate <String>] [-SecondaryCertificate <String>] [-RootCertificate] [-PrimaryCAName <String>] + [-SecondaryCAName <String>] [-ReprovisionPolicy <PSReprovisionType>] [-EdgeEnabled] [-Tag <Hashtable>] + [-Desired <Hashtable>] [-AllocationPolicy <PSAllocationPolicy>] [-ProvisioningStatus <PSProvisioningStatus>] + [-IotHubHostName <String>] [-IotHub <String[]>] [-WebhookUrl <String>] [-ApiVersion <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIoTDeviceProvisioningServiceEnrollment [-DpsObject] <PSProvisioningServiceDescription> + -RegistrationId <String> -AttestationType <PSAttestationMechanismType> [-DeviceId <String>] + [-EndorsementKey <String>] [-StorageRootKey <String>] [-PrimaryKey <String>] [-SecondaryKey <String>] + [-PrimaryCertificate <String>] [-SecondaryCertificate <String>] [-RootCertificate] [-PrimaryCAName <String>] + [-SecondaryCAName <String>] [-ReprovisionPolicy <PSReprovisionType>] [-EdgeEnabled] [-Tag <Hashtable>] + [-Desired <Hashtable>] [-AllocationPolicy <PSAllocationPolicy>] [-ProvisioningStatus <PSProvisioningStatus>] + [-IotHubHostName <String>] [-IotHub <String[]>] [-WebhookUrl <String>] [-ApiVersion <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIoTDeviceProvisioningServiceEnrollment [-ResourceId] <String> -RegistrationId <String> + -AttestationType <PSAttestationMechanismType> [-DeviceId <String>] [-EndorsementKey <String>] + [-StorageRootKey <String>] [-PrimaryKey <String>] [-SecondaryKey <String>] [-PrimaryCertificate <String>] + [-SecondaryCertificate <String>] [-RootCertificate] [-PrimaryCAName <String>] [-SecondaryCAName <String>] + [-ReprovisionPolicy <PSReprovisionType>] [-EdgeEnabled] [-Tag <Hashtable>] [-Desired <Hashtable>] + [-AllocationPolicy <PSAllocationPolicy>] [-ProvisioningStatus <PSProvisioningStatus>] + [-IotHubHostName <String>] [-IotHub <String[]>] [-WebhookUrl <String>] [-ApiVersion <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a device enrollment in an Azure IoT Hub Device Provisioning Service. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AttestationType SymmetricKey +``` + +Create an enrollment with attestation type SymmetricKey + +### Example 2 +```powershell +Add-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AttestationType Tpm -EndorsementKey "endorementkey" +``` + +Create an enrollment with TPM attestation. + +### Example 3 +```powershell +Add-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AttestationType X509 -PrimaryCertificate "D:/primary.cer" +``` + +Create an enrollment with attestation type X509 + +### Example 4 +```powershell +$tag = @{} +$tag.Add("environment","test") +$desired = @{} +$desired.add("version_dps", "dps1") +Add-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AttestationType SymmetricKey -tag $tag -Desired $desired +``` + +Create an enrollment with attestation type SymmetricKey and initial twin state. + +## PARAMETERS + +### -AllocationPolicy +Type of allocation for device assigned to the Hub. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSAllocationPolicy +Parameter Sets: (All) +Aliases: +Accepted values: Hashed, GeoLatency, Static, Custom + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiVersion +The API version of the provisioning service in the custom allocation request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttestationType +Attestation Mechanism. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSAttestationMechanismType +Parameter Sets: (All) +Aliases: +Accepted values: None, Tpm, X509, SymmetricKey + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Desired +Initial twin desired properties. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +IoT Hub Device ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsName +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -EdgeEnabled +Flag indicating edge enablement. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndorsementKey +TPM endorsement key for a TPM device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHub +Host name of target IoT Hub. +Use space-separated list for multiple IoT Hubs. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHubHostName +Host name of the target IoT Hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryCAName +The name of the primary root CA certificate. +If attestation with a root CA certificate is desired then a root ca name must be provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryCertificate +The path to the file containing the primary certificate. +Base-64 representation of X509 certificate .cer file or .pem file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryKey +The primary symmetric shared access key stored in base64 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisioningStatus +Enable or disable enrollment entry. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningStatus +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationId +Individual enrollment registration id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReprovisionPolicy +Device data to be handled on re-provision to different Iot Hub. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSReprovisionType +Parameter Sets: (All) +Aliases: +Accepted values: reprovisionandmigratedata, reprovisionandresetdata, never + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RootCertificate +Allows to create X509attestation using root certificates. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryCAName +The name of the secondary root CA certificate. +If attestation with a root CA certificate is desired then a root ca name must be provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryCertificate +The path to the file containing the secondary certificate. +Base-64 representation of X509 certificate .cer file or .pem file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryKey +The secondary symmetric shared access key stored in base64 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageRootKey +TPM storage root key for a TPM device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Initial twin tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebhookUrl +The webhook URL used for custom allocation requests. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIndividualEnrollment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceEnrollmentGroup.md b/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceEnrollmentGroup.md new file mode 100644 index 0000000000..438644a9c3 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceEnrollmentGroup.md @@ -0,0 +1,497 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/add-aziotdeviceprovisioningserviceenrollmentgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceEnrollmentGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceEnrollmentGroup.md +--- + +# Add-AzIoTDeviceProvisioningServiceEnrollmentGroup + +## SYNOPSIS +Create a device enrollment group. + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIoTDeviceProvisioningServiceEnrollmentGroup [-ResourceGroupName] <String> [-DpsName] <String> + -Name <String> -AttestationType <PSAttestationMechanismType> [-PrimaryKey <String>] [-SecondaryKey <String>] + [-PrimaryCertificate <String>] [-SecondaryCertificate <String>] [-RootCertificate] [-PrimaryCAName <String>] + [-SecondaryCAName <String>] [-ReprovisionPolicy <PSReprovisionType>] [-EdgeEnabled] [-Tag <Hashtable>] + [-Desired <Hashtable>] [-AllocationPolicy <PSAllocationPolicy>] [-ProvisioningStatus <PSProvisioningStatus>] + [-IotHubHostName <String>] [-IotHub <String[]>] [-WebhookUrl <String>] [-ApiVersion <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIoTDeviceProvisioningServiceEnrollmentGroup [-DpsObject] <PSProvisioningServiceDescription> + -Name <String> -AttestationType <PSAttestationMechanismType> [-PrimaryKey <String>] [-SecondaryKey <String>] + [-PrimaryCertificate <String>] [-SecondaryCertificate <String>] [-RootCertificate] [-PrimaryCAName <String>] + [-SecondaryCAName <String>] [-ReprovisionPolicy <PSReprovisionType>] [-EdgeEnabled] [-Tag <Hashtable>] + [-Desired <Hashtable>] [-AllocationPolicy <PSAllocationPolicy>] [-ProvisioningStatus <PSProvisioningStatus>] + [-IotHubHostName <String>] [-IotHub <String[]>] [-WebhookUrl <String>] [-ApiVersion <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIoTDeviceProvisioningServiceEnrollmentGroup [-ResourceId] <String> -Name <String> + -AttestationType <PSAttestationMechanismType> [-PrimaryKey <String>] [-SecondaryKey <String>] + [-PrimaryCertificate <String>] [-SecondaryCertificate <String>] [-RootCertificate] [-PrimaryCAName <String>] + [-SecondaryCAName <String>] [-ReprovisionPolicy <PSReprovisionType>] [-EdgeEnabled] [-Tag <Hashtable>] + [-Desired <Hashtable>] [-AllocationPolicy <PSAllocationPolicy>] [-ProvisioningStatus <PSProvisioningStatus>] + [-IotHubHostName <String>] [-IotHub <String[]>] [-WebhookUrl <String>] [-ApiVersion <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create an enrollment group in an Azure IoT Hub Device Provisioning Service. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -AttestationType SymmetricKey +``` + +Create an enrollment with attestation type SymmetricKey + +### Example 2 +```powershell +Add-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -AttestationType X509 -PrimaryCertificate "D:/primary.cer" +``` + +Create an enrollment with attestation type X509 + +### Example 3 +```powershell +$tag = @{} +$tag.Add("environment","test") +$desired = @{} +$desired.add("version_dps", "dps1") +Add-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -AttestationType SymmetricKey -tag $tag -Desired $desired +``` + +Create an enrollment with attestation type SymmetricKey and initial twin state. + +## PARAMETERS + +### -AllocationPolicy +Type of allocation for device assigned to the Hub. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSAllocationPolicy +Parameter Sets: (All) +Aliases: +Accepted values: Hashed, GeoLatency, Static, Custom + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiVersion +The API version of the provisioning service in the custom allocation request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttestationType +Attestation Mechanism. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSAttestationMechanismType +Parameter Sets: (All) +Aliases: +Accepted values: None, Tpm, X509, SymmetricKey + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Desired +Initial twin desired properties. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsName +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -EdgeEnabled +Flag indicating edge enablement. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHub +Host name of target IoT Hub. +Use space-separated list for multiple IoT Hubs. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHubHostName +Host name of the target IoT Hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the enrollment group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryCAName +The name of the primary root CA certificate. +If attestation with a root CA certificate is desired then a root ca name must be provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryCertificate +The path to the file containing the primary certificate. +Base-64 representation of X509 certificate .cer file or .pem file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryKey +The primary symmetric shared access key stored in base64 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisioningStatus +Enable or disable enrollment entry. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningStatus +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReprovisionPolicy +Device data to be handled on re-provision to different Iot Hub. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSReprovisionType +Parameter Sets: (All) +Aliases: +Accepted values: reprovisionandmigratedata, reprovisionandresetdata, never + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RootCertificate +Allows to create X509attestation using root certificates. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryCAName +The name of the secondary root CA certificate. +If attestation with a root CA certificate is desired then a root ca name must be provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryCertificate +The path to the file containing the secondary certificate. +Base-64 representation of X509 certificate .cer file or .pem file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryKey +The secondary symmetric shared access key stored in base64 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Initial twin tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebhookUrl +The webhook URL used for custom allocation requests. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSEnrollmentGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceLinkedHub.md b/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceLinkedHub.md new file mode 100644 index 0000000000..ccb92b5f5d --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Add-AzIoTDeviceProvisioningServiceLinkedHub.md @@ -0,0 +1,259 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/add-aziotdeviceprovisioningservicelinkedhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceLinkedHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceLinkedHub.md +--- + +# Add-AzIoTDeviceProvisioningServiceLinkedHub + +## SYNOPSIS +Linked IoT hub to an Azure IoT Hub device provisioning service. + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIoTDeviceProvisioningServiceLinkedHub [-ResourceGroupName] <String> [-Name] <String> + [-IotHubConnectionString] <String> [-IotHubLocation] <String> [-AllocationWeight <Int32>] + [-ApplyAllocationPolicy] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIoTDeviceProvisioningServiceLinkedHub [-DpsObject] <PSProvisioningServiceDescription> + [-IotHubConnectionString] <String> [-IotHubLocation] <String> [-AllocationWeight <Int32>] + [-ApplyAllocationPolicy] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIoTDeviceProvisioningServiceLinkedHub [-ResourceId] <String> [-IotHubConnectionString] <String> + [-IotHubLocation] <String> [-AllocationWeight <Int32>] [-ApplyAllocationPolicy] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -IotHubConnectionString $hubConnectionString -IotHubLocation "eastus" +``` + +```output +ResourceGroupName : myresourcegroup +Name : myiotdps +LinkedHubName : myiothub.azure-devices.net +ConnectionString : HostName=myiothub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=**** +AllocationWeight : +ApplyAllocationPolicy : +Location : eastus +``` + +Linked IoT hub to an Azure IoT Hub device provisioning service. + +### Example 2 +```powershell +Add-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -IotHubConnectionString $hubConnectionString -IotHubLocation "eastus" -AllocationWeight 10 -ApplyAllocationPolicy +``` + +```output +LinkedHubName Location AllocationWeight ApplyAllocationPolicy +------------- -------- ---------------- --------------------- +myiothub1.azure-devices.net eastus 2 true +myiothub2.azure-devices.net westus2 10 false +``` + +Linked IoT hub to an Azure IoT Hub device provisioning service with AllocationWeight and ApplyAllocationPolicy. + +## PARAMETERS + +### -AllocationWeight +Allocation weight of the IoT Hub + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyAllocationPolicy +A boolean indicating whether to apply allocation policy to the IoT Hub + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubConnectionString +Connection String of the Iot Hub resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHubLocation +Location of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitions + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Az.DeviceProvisioningServices.md b/azps-10.1.0/Az.DeviceProvisioningServices/Az.DeviceProvisioningServices.md new file mode 100644 index 0000000000..bb5494f78c --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Az.DeviceProvisioningServices.md @@ -0,0 +1,96 @@ +--- +Module Name: Az.DeviceProvisioningServices +Module Guid: a9f5b86f-63be-4e7a-8e16-c8c7c36cae40 +Download Help Link: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Az.DeviceProvisioningServices.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Az.DeviceProvisioningServices.md +--- + +# Az.DeviceProvisioningServices Module +## Description +Commands for Managing Azure IoT Hub Device Provisioning Service. + +## Az.DeviceProvisioningServices Cmdlets +### [Add-AzIoTDeviceProvisioningServiceAccessPolicy](Add-AzIoTDeviceProvisioningServiceAccessPolicy.md) +Add a new shared access policy in an Azure IoT Hub device provisioning service. + +### [Add-AzIoTDeviceProvisioningServiceCertificate](Add-AzIoTDeviceProvisioningServiceCertificate.md) +Create/update an Azure IoT Hub Device Provisioning Service certificate. + +### [Add-AzIoTDeviceProvisioningServiceEnrollment](Add-AzIoTDeviceProvisioningServiceEnrollment.md) +Create a device enrollment record. + +### [Add-AzIoTDeviceProvisioningServiceEnrollmentGroup](Add-AzIoTDeviceProvisioningServiceEnrollmentGroup.md) +Create a device enrollment group. + +### [Add-AzIoTDeviceProvisioningServiceLinkedHub](Add-AzIoTDeviceProvisioningServiceLinkedHub.md) +Linked IoT hub to an Azure IoT Hub device provisioning service. + +### [Get-AzIoTDeviceProvisioningService](Get-AzIoTDeviceProvisioningService.md) +List all or show details of Azure IoT Hub device provisioning services. + +### [Get-AzIoTDeviceProvisioningServiceAccessPolicy](Get-AzIoTDeviceProvisioningServiceAccessPolicy.md) +List all or show details of shared access policies in an Azure IoT Hub device provisioning service. + +### [Get-AzIoTDeviceProvisioningServiceCertificate](Get-AzIoTDeviceProvisioningServiceCertificate.md) +Lists all certificates or a particular certificate contained within an Azure IoT Hub Device Provisioning Service. + +### [Get-AzIoTDeviceProvisioningServiceEnrollment](Get-AzIoTDeviceProvisioningServiceEnrollment.md) +Get a device enrollment record. + +### [Get-AzIoTDeviceProvisioningServiceEnrollmentGroup](Get-AzIoTDeviceProvisioningServiceEnrollmentGroup.md) +Get a device enrollment group. + +### [Get-AzIoTDeviceProvisioningServiceLinkedHub](Get-AzIoTDeviceProvisioningServiceLinkedHub.md) +List all or show details of linked IoT hubs in an Azure IoT Hub device provisioning service. + +### [Get-AzIoTDeviceProvisioningServiceRegistration](Get-AzIoTDeviceProvisioningServiceRegistration.md) +Gets the device registration state. + +### [New-AzIoTDeviceProvisioningService](New-AzIoTDeviceProvisioningService.md) +Create an Azure IoT Hub device provisioning service. + +### [New-AzIoTDeviceProvisioningServiceCertificateVerificationCode](New-AzIoTDeviceProvisioningServiceCertificateVerificationCode.md) +Generate a verification code for an Azure IoT Hub Device Provisioning Service certificate. + +### [Remove-AzIoTDeviceProvisioningService](Remove-AzIoTDeviceProvisioningService.md) +Delete an Azure IoT Hub device provisioning service. + +### [Remove-AzIoTDeviceProvisioningServiceAccessPolicy](Remove-AzIoTDeviceProvisioningServiceAccessPolicy.md) +Delete a shared access policies in an Azure IoT Hub device provisioning service. + +### [Remove-AzIoTDeviceProvisioningServiceCertificate](Remove-AzIoTDeviceProvisioningServiceCertificate.md) +Delete an Azure IoT Hub Device Provisioning Service certificate. + +### [Remove-AzIoTDeviceProvisioningServiceEnrollment](Remove-AzIoTDeviceProvisioningServiceEnrollment.md) +Delete a device enrollment record. + +### [Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup](Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup.md) +Delete a device enrollment group. + +### [Remove-AzIoTDeviceProvisioningServiceLinkedHub](Remove-AzIoTDeviceProvisioningServiceLinkedHub.md) +Delete a linked IoT hub in an Azure IoT Hub device provisioning service. + +### [Remove-AzIoTDeviceProvisioningServiceRegistration](Remove-AzIoTDeviceProvisioningServiceRegistration.md) +Deletes the device registration. + +### [Set-AzIoTDeviceProvisioningServiceCertificate](Set-AzIoTDeviceProvisioningServiceCertificate.md) +Verify an Azure IoT Hub Device Provisioning Service certificate. + +### [Set-AzIoTDeviceProvisioningServiceEnrollment](Set-AzIoTDeviceProvisioningServiceEnrollment.md) +Update a device enrollment record. + +### [Set-AzIoTDeviceProvisioningServiceEnrollmentGroup](Set-AzIoTDeviceProvisioningServiceEnrollmentGroup.md) +Update a device enrollment group. + +### [Update-AzIoTDeviceProvisioningService](Update-AzIoTDeviceProvisioningService.md) +Update an Azure IoT Hub device provisioning service. + +### [Update-AzIoTDeviceProvisioningServiceAccessPolicy](Update-AzIoTDeviceProvisioningServiceAccessPolicy.md) +Update a shared access policy in an Azure IoT Hub device provisioning service. + +### [Update-AzIoTDeviceProvisioningServiceLinkedHub](Update-AzIoTDeviceProvisioningServiceLinkedHub.md) +Update a linked IoT hub in an Azure IoT Hub device provisioning service. + diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningService.md b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningService.md new file mode 100644 index 0000000000..6a2aecb450 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningService.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningService.md +--- + +# Get-AzIoTDeviceProvisioningService + +## SYNOPSIS +List all or show details of Azure IoT Hub device provisioning services. + +## SYNTAX + +### ListIotDpsByResourceGroup (Default) +``` +Get-AzIoTDeviceProvisioningService [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetIotDpsByName +``` +Get-AzIoTDeviceProvisioningService -ResourceGroupName <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIoTDeviceProvisioningService +``` + +```output +ResourceGroupName Name Location ServiceOperationsHostName IotHubs AllocationPolicy Tags State +----------------- ---- -------- ------------------------- ------- ---------------- ---- ----- +myresourcegroup0 myiotdps0 eastus myiotdps0.azure-devices-provisioning.net 0 Static 0 Active +myresourcegroup1 myiotdps1 eastus myiotdps1.azure-devices-provisioning.net 4 Hashed 0 Active +myresourcegroup1 myiotdps2 westus myiotdps2.azure-devices-provisioning.net 4 GeoLatency 0 Active +``` + +List all Azure IoT Hub device provisioning services in a subscription. + +### Example 2 +```powershell +Get-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" +``` + +```output +ResourceGroupName Name Location ServiceOperationsHostName IotHubs AllocationPolicy Tags State +----------------- ---- -------- ------------------------- ------- ---------------- ---- ----- +myresourcegroup myiotdps1 eastus myiotdps1.azure-devices-provisioning.net 1 Hashed 0 Active +myresourcegroup myiotdps2 westus myiotdps2.azure-devices-provisioning.net 4 GeoLatency 0 Active +``` + +List all Azure IoT Hub device provisioning services in the resource group 'myresourcegroup'. + +### Example 3 +```powershell +Get-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" +``` + +```output +ResourceGroupName : myresourcegroup +Name : myiotdps +Location : eastus +Type : Microsoft.Devices/provisioningServices +ServiceOperationsHostName : myiotdps.azure-devices-provisioning.net +IotHubs : 0 +State : Active +AllocationPolicy : Hashed +Tags : {} +SkuName : S1 +SkuTier : Standard +Etag : AAAAAAAT52k= +``` + +Show details of an Azure IoT Hub device provisioning service 'myiotdps'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: GetIotDpsByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ListIotDpsByResourceGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetIotDpsByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceAccessPolicy.md b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceAccessPolicy.md new file mode 100644 index 0000000000..a66c09cb5e --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceAccessPolicy.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningserviceaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceAccessPolicy.md +--- + +# Get-AzIoTDeviceProvisioningServiceAccessPolicy + +## SYNOPSIS +List all or show details of shared access policies in an Azure IoT Hub device provisioning service. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIoTDeviceProvisioningServiceAccessPolicy [-ResourceGroupName] <String> [-Name] <String> + [-KeyName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIoTDeviceProvisioningServiceAccessPolicy [-DpsObject] <PSProvisioningServiceDescription> + [-KeyName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIoTDeviceProvisioningServiceAccessPolicy [-ResourceId] <String> [-KeyName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" +``` + +```output +KeyName Rights +------- ------ +mypolicy1 ServiceConfig, DeviceConnect, EnrollmentWrite +mypolicy2 EnrollmentWrite +``` + +List all shared access policies in "myiotdps". + +### Example 2 +```powershell +Get-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" +``` + +```output +ResourceGroupName : myresourcegroup +Name : myiotdps +KeyName : mypolicy +PrimaryKey : hyZJm8W7rra9O7eKhkLu9m/CIPPt9x1NXVMbMJa1rvg= +SecondaryKey : vbIwGCBQCIbS5BKFKdddM6uZHLhNTuz9r8CZYgmTmpY= +Rights : ServiceConfig, DeviceConnect, EnrollmentWrite +``` + +Show details of shared access policy "mypolicy" in an Azure IoT Hub device provisioning service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +IoT Device Provisioning Service access policy key name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceCertificate.md b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceCertificate.md new file mode 100644 index 0000000000..f98f56899d --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceCertificate.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningservicecertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceCertificate.md +--- + +# Get-AzIoTDeviceProvisioningServiceCertificate + +## SYNOPSIS +Lists all certificates or a particular certificate contained within an Azure IoT Hub Device Provisioning Service. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIoTDeviceProvisioningServiceCertificate [-ResourceGroupName] <String> [-Name] <String> + [-CertificateName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIoTDeviceProvisioningServiceCertificate [-DpsObject] <PSProvisioningServiceDescription> + [-CertificateName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIoTDeviceProvisioningServiceCertificate [-ResourceId] <String> [-CertificateName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/how-to-verify-certificates. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" +``` + +```output +Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate +ResourceGroupName : myresourcegroup +Name : myiotdps +CertificateName : mycertificate +Subject : CN=mycertificate +Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 +Status : Unverified +Expiry : 1/01/2027 16:01 +Created : 1/01/2017 16:01 +Etag : AAAAAAFpGcA= +``` + +Show details about "mycertificate" in an Azure IoT Hub device provisioning service. + +### Example 2 +```powershell +Get-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" | Get-AzIoTDeviceProvisioningServiceCertificate +``` + +```output +ResourceGroupName Name CertificateName Status Expiry +----------------- ---- --------------- ------ ------ +myresourcegroup myiotdps mycert1 Unverified 12/04/2027 13:12 +myresourcegroup myiotdps mycert2 Unverified 12/04/2027 13:12 +``` + +List all certificates in "myiotdps" using pipeline. + +## PARAMETERS + +### -CertificateName +Name of the Certificate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceEnrollment.md b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceEnrollment.md new file mode 100644 index 0000000000..dc4d3d05c7 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceEnrollment.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningserviceenrollment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceEnrollment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceEnrollment.md +--- + +# Get-AzIoTDeviceProvisioningServiceEnrollment + +## SYNOPSIS +Get a device enrollment record. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIoTDeviceProvisioningServiceEnrollment [-ResourceGroupName] <String> [-DpsName] <String> + [-RegistrationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIoTDeviceProvisioningServiceEnrollment [-DpsObject] <PSProvisioningServiceDescription> + [-RegistrationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIoTDeviceProvisioningServiceEnrollment [-ResourceId] <String> [-RegistrationId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get device enrollment details or List device enrollments in an Azure IoT Hub Device Provisioning Service. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" +``` + +Get device enrollment details in an Azure IoT Hub Device Provisioning Service. + +### Example 2 +```powershell +Get-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" +``` + +List device enrollments in an Azure IoT Hub Device Provisioning Service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsName +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RegistrationId +Individual enrollment registration id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIndividualEnrollment + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIndividualEnrollments[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceEnrollmentGroup.md b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceEnrollmentGroup.md new file mode 100644 index 0000000000..272e509fa5 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceEnrollmentGroup.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningserviceenrollmentgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceEnrollmentGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceEnrollmentGroup.md +--- + +# Get-AzIoTDeviceProvisioningServiceEnrollmentGroup + +## SYNOPSIS +Get a device enrollment group. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIoTDeviceProvisioningServiceEnrollmentGroup [-ResourceGroupName] <String> [-DpsName] <String> + [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIoTDeviceProvisioningServiceEnrollmentGroup [-DpsObject] <PSProvisioningServiceDescription> + [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIoTDeviceProvisioningServiceEnrollmentGroup [-ResourceId] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the details of an enrollment group or list all enrollment groups in an Azure IoT Hub Device Provisioning Service. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" +``` + +Get device enrollment group in an Azure IoT Hub Device Provisioning Service. + +### Example 2 +```powershell +Get-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" +``` + +List all device enrollment groups in an Azure IoT Hub Device Provisioning Service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsName +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the enrollment group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSEnrollmentGroup + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSEnrollmentGroups[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceLinkedHub.md b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceLinkedHub.md new file mode 100644 index 0000000000..063f798403 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceLinkedHub.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningservicelinkedhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceLinkedHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceLinkedHub.md +--- + +# Get-AzIoTDeviceProvisioningServiceLinkedHub + +## SYNOPSIS +List all or show details of linked IoT hubs in an Azure IoT Hub device provisioning service. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIoTDeviceProvisioningServiceLinkedHub [-ResourceGroupName] <String> [-Name] <String> + [-LinkedHubName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIoTDeviceProvisioningServiceLinkedHub [-DpsObject] <PSProvisioningServiceDescription> + [-LinkedHubName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIoTDeviceProvisioningServiceLinkedHub [-ResourceId] <String> [-LinkedHubName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" +``` + +```output +LinkedHubName Location AllocationWeight ApplyAllocationPolicy +------------- -------- ---------------- --------------------- +myiothub1.azure-devices.net eastus 2 +myiothub2.azure-devices.net westus2 true +``` + +List all linked IoT hubs in "myiotdps". + +### Example 2 +```powershell +Get-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub1" +``` + +```output +ResourceGroupName : myresourcegroup +Name : myiotdps +LinkedHubName : myiothub1.azure-devices.net +ConnectionString : HostName=myiothub1.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=**** +AllocationWeight : 2 +ApplyAllocationPolicy : +Location : eastus +``` + +Show details of linked IoT hub "myiothub1" in an Azure IoT Hub device provisioning service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkedHubName +Host name of linked IoT Hub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitions + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceRegistration.md b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceRegistration.md new file mode 100644 index 0000000000..a44a934c57 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Get-AzIoTDeviceProvisioningServiceRegistration.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningserviceregistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceRegistration.md +--- + +# Get-AzIoTDeviceProvisioningServiceRegistration + +## SYNOPSIS +Gets the device registration state. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIoTDeviceProvisioningServiceRegistration [-ResourceGroupName] <String> [-DpsName] <String> + [-RegistrationId <String>] [-EnrollmentId <String>] [-Query <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIoTDeviceProvisioningServiceRegistration [-DpsObject] <PSProvisioningServiceDescription> + [-RegistrationId <String>] [-EnrollmentId <String>] [-Query <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIoTDeviceProvisioningServiceRegistration [-ResourceId] <String> [-RegistrationId <String>] + [-EnrollmentId <String>] [-Query <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the device registration state or the registration state of devices under the enrollmentGroup in an Azure IoT Hub Device Provisioning Service. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIoTDeviceProvisioningServiceRegistration -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" +``` + +Get the device registration state details in an Azure IoT Hub Device Provisioning Service. + +### Example 2 +```powershell +Get-AzIoTDeviceProvisioningServiceRegistration -ResourceGroupName "myresourcegroup" -DpsName "mydps" -EnrollmentId "grp-enroll1" +``` + +List all the registration state of devices in this enrollmentGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsName +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -EnrollmentId +ID of enrollment group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Sql query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationId +ID of device registration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSDeviceRegistrationState + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSDeviceRegistrationStates[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/New-AzIoTDeviceProvisioningService.md b/azps-10.1.0/Az.DeviceProvisioningServices/New-AzIoTDeviceProvisioningService.md new file mode 100644 index 0000000000..23e794ed62 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/New-AzIoTDeviceProvisioningService.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/new-aziotdeviceprovisioningservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/New-AzIoTDeviceProvisioningService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/New-AzIoTDeviceProvisioningService.md +--- + +# New-AzIoTDeviceProvisioningService + +## SYNOPSIS +Create an Azure IoT Hub device provisioning service. + +## SYNTAX + +``` +New-AzIoTDeviceProvisioningService [-ResourceGroupName] <String> [-Name] <String> [-Location <String>] + [-AllocationPolicy <String>] [-SkuName <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps. + +## EXAMPLES + +### Example 1 +```powershell +$tags = @{} +$tags.Add('key1','value1') +New-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -Tag $tags +``` + +```output +ResourceGroupName : myresourcegroup +Name : myiotdps +Location : westus +Type : Microsoft.Devices/provisioningServices +ServiceOperationsHostName : myiotdps.azure-devices-provisioning.net +IotHubs : 0 +State : Active +AllocationPolicy : Hashed +Tags : {[key1, value1]} +SkuName : S1 +SkuTier : Standard +Etag : AAAAAAAT52k= +``` + +Create an Azure IoT Hub device provisioning service with the standard pricing tier S1 and tags, in the region of the resource group. + +### Example 2 +```powershell +New-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -Location "eastus" +``` + +```output +ResourceGroupName : myresourcegroup +Name : myiotdps +Location : eastus +Type : Microsoft.Devices/provisioningServices +ServiceOperationsHostName : myiotdps.azure-devices-provisioning.net +IotHubs : 0 +State : Active +AllocationPolicy : Hashed +Tags : {} +SkuName : S1 +SkuTier : Standard +Etag : AAAAAAAPoOk= +``` + +Create an Azure IoT Hub device provisioning service with the standard pricing tier S1, in the 'eastus' region. + +## PARAMETERS + +### -AllocationPolicy +IoT Device Provisioning Service Allocation policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Hashed, GeoLatency, Static + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Sku + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: S1 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +IoT Device Provisioning Service instance tags. Property bag in key-value pairs in the form of a hash table. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/New-AzIoTDeviceProvisioningServiceCertificateVerificationCode.md b/azps-10.1.0/Az.DeviceProvisioningServices/New-AzIoTDeviceProvisioningServiceCertificateVerificationCode.md new file mode 100644 index 0000000000..4ae66a1494 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/New-AzIoTDeviceProvisioningServiceCertificateVerificationCode.md @@ -0,0 +1,237 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/new-aziotdeviceprovisioningservicecertificateverificationcode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/New-AzIoTDeviceProvisioningServiceCertificateVerificationCode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/New-AzIoTDeviceProvisioningServiceCertificateVerificationCode.md +--- + +# New-AzIoTDeviceProvisioningServiceCertificateVerificationCode + +## SYNOPSIS +Generate a verification code for an Azure IoT Hub Device Provisioning Service certificate. + +## SYNTAX + +### ResourceSet (Default) +``` +New-AzIoTDeviceProvisioningServiceCertificateVerificationCode [-ResourceGroupName] <String> [-Name] <String> + [-CertificateName] <String> [-Etag] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +New-AzIoTDeviceProvisioningServiceCertificateVerificationCode [-InputObject] <PSCertificateResponse> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +New-AzIoTDeviceProvisioningServiceCertificateVerificationCode [-ResourceId] <String> [-Etag] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This verification code is used to complete the proof of possession step for a certificate. Use this verification code as the CN of a new certificate signed with the root certificates private key. +For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/how-to-verify-certificates. + +## EXAMPLES + +### Example 1 +```powershell +New-AzIoTDeviceProvisioningServiceCertificateVerificationCode -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Etag "AAAAAAFPazE=" +``` + +```output +Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate +ResourceGroupName : myresourcegroup +Name : myiotdps +CertificateName : mycertificate +Subject : CN=mycertificate +Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 +VerificationCode : A901A843EFF75419AC1F0EB460E85DF153092A0547AA30F5 +Status : Unverified +Expiry : 1/01/2027 16:01 +Created : 1/01/2017 16:01 +Etag : AAAAAAFpGcA= +``` + +Generate a verification code for "mycertificate". + +### Example 2 +```powershell +Get-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" | New-AzIoTDeviceProvisioningServiceCertificateVerificationCode +``` + +```output +Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate +ResourceGroupName : myresourcegroup +Name : myiotdps +CertificateName : mycertificate +Subject : CN=mycertificate +Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 +VerificationCode : A901A843EFF75419AC1F0EB460E85DF153092A0547AA30F5 +Status : Unverified +Expiry : 1/01/2027 16:01 +Created : 1/01/2017 16:01 +Etag : AAAAAAFpGcA= +``` + +Generate a verification code for "mycertificate" using pipeline. + +## PARAMETERS + +### -CertificateName +Name of the Iot device provisioning service certificate + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Etag of the Certificate + +```yaml +Type: System.String +Parameter Sets: ResourceSet, ResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IoT Device Provisioning Service Certificate Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Certificate Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSVerificationCodeResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningService.md b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningService.md new file mode 100644 index 0000000000..0cf96d5211 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningService.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningService.md +--- + +# Remove-AzIoTDeviceProvisioningService + +## SYNOPSIS +Delete an Azure IoT Hub device provisioning service. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIoTDeviceProvisioningService [-ResourceGroupName] <String> [-Name] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIoTDeviceProvisioningService [-InputObject] <PSProvisioningServiceDescription> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIoTDeviceProvisioningService [-ResourceId] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -PassThru +``` + +```output +True +``` + +Delete an Azure IoT Hub device provisioning service 'myiotdps'. + +### Example 2 +```powershell +Get-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" | Remove-AzIoTDeviceProvisioningService +``` + +Delete an Azure IoT Hub device provisioning service 'myiotdps' using pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceAccessPolicy.md b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceAccessPolicy.md new file mode 100644 index 0000000000..77b8426390 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceAccessPolicy.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningserviceaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceAccessPolicy.md +--- + +# Remove-AzIoTDeviceProvisioningServiceAccessPolicy + +## SYNOPSIS +Delete a shared access policies in an Azure IoT Hub device provisioning service. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIoTDeviceProvisioningServiceAccessPolicy [-ResourceGroupName] <String> [-Name] <String> + [-KeyName] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIoTDeviceProvisioningServiceAccessPolicy + [-InputObject] <PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIoTDeviceProvisioningServiceAccessPolicy [-ResourceId] <String> [-KeyName] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -PassThru +``` + +```output +True +``` + +Delete shared access policy "mypolicy" in an Azure IoT Hub device provisioning service. + +### Example 2 +```powershell +Get-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" | Remove-AzIoTDeviceProvisioningServiceAccessPolicy +``` + +Delete shared access policy "mypolicy" in an Azure IoT Hub device provisioning service using pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +IoT Device Provisioning Service access policy key name + +```yaml +Type: System.String +Parameter Sets: ResourceSet, ResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceCertificate.md b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceCertificate.md new file mode 100644 index 0000000000..20fd9cc4d8 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceCertificate.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningservicecertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceCertificate.md +--- + +# Remove-AzIoTDeviceProvisioningServiceCertificate + +## SYNOPSIS +Delete an Azure IoT Hub Device Provisioning Service certificate. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIoTDeviceProvisioningServiceCertificate [-ResourceGroupName] <String> [-Name] <String> + [-CertificateName] <String> [-Etag] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIoTDeviceProvisioningServiceCertificate [-InputObject] <PSCertificateResponse> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIoTDeviceProvisioningServiceCertificate [-ResourceId] <String> [-Etag] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/how-to-verify-certificates. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Etag "AAAAAAFPazE=" -PassThru +``` + +```output +True +``` + +Delete "mycertificate" in an Azure IoT Hub device provisioning service. + +## PARAMETERS + +### -CertificateName +Name of the Certificate + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Etag of the Certificate + +```yaml +Type: System.String +Parameter Sets: ResourceSet, ResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IoT Device Provisioning Service Certificate Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Certificate Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceEnrollment.md b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceEnrollment.md new file mode 100644 index 0000000000..dba88fdb98 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceEnrollment.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningserviceenrollment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceEnrollment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceEnrollment.md +--- + +# Remove-AzIoTDeviceProvisioningServiceEnrollment + +## SYNOPSIS +Delete a device enrollment record. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIoTDeviceProvisioningServiceEnrollment [-ResourceGroupName] <String> [-DpsName] <String> + [-RegistrationId <String>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIoTDeviceProvisioningServiceEnrollment [-DpsObject] <PSProvisioningServiceDescription> + [-RegistrationId <String>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIoTDeviceProvisioningServiceEnrollment [-ResourceId] <String> [-RegistrationId <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a device enrollment in an Azure IoT Hub Device Provisioning Service. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -Passthru +``` + +Delete a specified enrollment record. + +### Example 2 +```powershell +Remove-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Passthru +``` + +Delete all enrollment records. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsName +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Allows to return the boolean object. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationId +Individual enrollment registration id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup.md b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup.md new file mode 100644 index 0000000000..d562c615b8 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningserviceenrollmentgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup.md +--- + +# Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup + +## SYNOPSIS +Delete a device enrollment group. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup [-ResourceGroupName] <String> [-DpsName] <String> + [-Name <String>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup [-DpsObject] <PSProvisioningServiceDescription> + [-Name <String>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup [-ResourceId] <String> [-Name <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete an enrollment group in an Azure IoT Hub Device Provisioning Service. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -Passthru +``` + +Delete a specified enrollment group. + +### Example 2 +```powershell +Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Passthru +``` + +Delete all enrollment groups. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsName +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the enrollment group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Allows to return the boolean object. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceLinkedHub.md b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceLinkedHub.md new file mode 100644 index 0000000000..81f48ab41e --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceLinkedHub.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningservicelinkedhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceLinkedHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceLinkedHub.md +--- + +# Remove-AzIoTDeviceProvisioningServiceLinkedHub + +## SYNOPSIS +Delete a linked IoT hub in an Azure IoT Hub device provisioning service. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIoTDeviceProvisioningServiceLinkedHub [-ResourceGroupName] <String> [-Name] <String> + [-LinkedHubName] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIoTDeviceProvisioningServiceLinkedHub [-InputObject] <PSIotHubDefinitionDescription> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIoTDeviceProvisioningServiceLinkedHub [-ResourceId] <String> [-LinkedHubName] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub" -PassThru +``` + +```output +True +``` + +Delete linked IoT hub "myiothub" in an Azure IoT Hub device provisioning service. + +### Example 2 +```powershell +Get-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub" | Remove-AzIoTDeviceProvisioningServiceLinkedHub +``` + +Delete linked IoT hub "myiothub" in an Azure IoT Hub device provisioning service using pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkedHubName +Host name of linked IoT Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet, ResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceRegistration.md b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceRegistration.md new file mode 100644 index 0000000000..7a88a2b499 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Remove-AzIoTDeviceProvisioningServiceRegistration.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningserviceregistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceRegistration.md +--- + +# Remove-AzIoTDeviceProvisioningServiceRegistration + +## SYNOPSIS +Deletes the device registration. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIoTDeviceProvisioningServiceRegistration [-ResourceGroupName] <String> [-DpsName] <String> + -RegistrationId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIoTDeviceProvisioningServiceRegistration [-DpsObject] <PSProvisioningServiceDescription> + -RegistrationId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIoTDeviceProvisioningServiceRegistration [-ResourceId] <String> -RegistrationId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a device registration in an Azure IoT Hub Device Provisioning Service. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIoTDeviceProvisioningServiceRegistration -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -Passthru +``` + +Delete a device registration in an Azure IoT Hub Device Provisioning Service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsName +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Allows to return the boolean object. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationId +ID of device registration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Set-AzIoTDeviceProvisioningServiceCertificate.md b/azps-10.1.0/Az.DeviceProvisioningServices/Set-AzIoTDeviceProvisioningServiceCertificate.md new file mode 100644 index 0000000000..9562c315b7 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Set-AzIoTDeviceProvisioningServiceCertificate.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/set-aziotdeviceprovisioningservicecertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceCertificate.md +--- + +# Set-AzIoTDeviceProvisioningServiceCertificate + +## SYNOPSIS +Verify an Azure IoT Hub Device Provisioning Service certificate. + +## SYNTAX + +### ResourceSet (Default) +``` +Set-AzIoTDeviceProvisioningServiceCertificate [-ResourceGroupName] <String> [-Name] <String> + [-CertificateName] <String> [-Etag] <String> [-Path] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Set-AzIoTDeviceProvisioningServiceCertificate [-InputObject] <PSCertificateResponse> [-Path] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzIoTDeviceProvisioningServiceCertificate [-ResourceId] <String> [-Etag] <String> [-Path] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Verify a certificate by uploading a verification certificate containing the verification code obtained by calling generate-verification-code. This is the last step in the proof of possession process. +For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/how-to-verify-certificates + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" -Etag "AAAAAAFpGcA=" +``` + +```output +Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate +ResourceGroupName : myresourcegroup +Name : myiotdps +CertificateName : mycertificate +Subject : CN=mycertificate +Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 +Status : Verified +Expiry : 1/01/2027 16:01 +Created : 1/01/2017 16:01 +Etag : AAAAAAFpGcA= +``` + +Verify ownership of the "mycertificate" private key. + +### Example 2 +```powershell +Get-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" | Set-AzIoTDeviceProvisioningServiceCertificate -Path "c:\mycertificate.cer" +``` + +```output +Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate +ResourceGroupName : myresourcegroup +Name : myiotdps +CertificateName : mycertificate +Subject : CN=mycertificate +Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 +Status : Verified +Expiry : 1/01/2027 16:01 +Created : 1/01/2017 16:01 +Etag : AAAAAAFpGcA= +``` + +Verify ownership of the "mycertificate" private key using pipeline. + +## PARAMETERS + +### -CertificateName +Name of the Iot device provisioning service certificate + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Etag of the Certificate + +```yaml +Type: System.String +Parameter Sets: ResourceSet, ResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IoT Device Provisioning Service Certificate Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +base-64 representation of X509 certificate .cer file or .pem file path + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Certificate Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Set-AzIoTDeviceProvisioningServiceEnrollment.md b/azps-10.1.0/Az.DeviceProvisioningServices/Set-AzIoTDeviceProvisioningServiceEnrollment.md new file mode 100644 index 0000000000..315c6cc377 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Set-AzIoTDeviceProvisioningServiceEnrollment.md @@ -0,0 +1,529 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/set-aziotdeviceprovisioningserviceenrollment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceEnrollment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceEnrollment.md +--- + +# Set-AzIoTDeviceProvisioningServiceEnrollment + +## SYNOPSIS +Update a device enrollment record. + +## SYNTAX + +### ResourceSet (Default) +``` +Set-AzIoTDeviceProvisioningServiceEnrollment [-ResourceGroupName] <String> [-DpsName] <String> + -RegistrationId <String> [-DeviceId <String>] [-ReprovisionPolicy <PSReprovisionType>] + [-EdgeEnabled <Boolean>] [-Tag <Hashtable>] [-Desired <Hashtable>] [-AllocationPolicy <PSAllocationPolicy>] + [-ProvisioningStatus <PSProvisioningStatus>] [-IotHubHostName <String>] [-IotHub <String[]>] + [-WebhookUrl <String>] [-ApiVersion <String>] [-EndorsementKey <String>] [-StorageRootKey <String>] + [-PrimaryKey <String>] [-SecondaryKey <String>] [-PrimaryCertificate <String>] + [-SecondaryCertificate <String>] [-RootCertificate] [-PrimaryCAName <String>] [-SecondaryCAName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Set-AzIoTDeviceProvisioningServiceEnrollment [-DpsObject] <PSProvisioningServiceDescription> + -RegistrationId <String> [-DeviceId <String>] [-ReprovisionPolicy <PSReprovisionType>] + [-EdgeEnabled <Boolean>] [-Tag <Hashtable>] [-Desired <Hashtable>] [-AllocationPolicy <PSAllocationPolicy>] + [-ProvisioningStatus <PSProvisioningStatus>] [-IotHubHostName <String>] [-IotHub <String[]>] + [-WebhookUrl <String>] [-ApiVersion <String>] [-EndorsementKey <String>] [-StorageRootKey <String>] + [-PrimaryKey <String>] [-SecondaryKey <String>] [-PrimaryCertificate <String>] + [-SecondaryCertificate <String>] [-RootCertificate] [-PrimaryCAName <String>] [-SecondaryCAName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzIoTDeviceProvisioningServiceEnrollment [-ResourceId] <String> -RegistrationId <String> + [-DeviceId <String>] [-ReprovisionPolicy <PSReprovisionType>] [-EdgeEnabled <Boolean>] [-Tag <Hashtable>] + [-Desired <Hashtable>] [-AllocationPolicy <PSAllocationPolicy>] [-ProvisioningStatus <PSProvisioningStatus>] + [-IotHubHostName <String>] [-IotHub <String[]>] [-WebhookUrl <String>] [-ApiVersion <String>] + [-EndorsementKey <String>] [-StorageRootKey <String>] [-PrimaryKey <String>] [-SecondaryKey <String>] + [-PrimaryCertificate <String>] [-SecondaryCertificate <String>] [-RootCertificate] [-PrimaryCAName <String>] + [-SecondaryCAName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Update a device enrollment in an Azure IoT Hub Device Provisioning Service. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AllocationPolicy Hashed -IotHub "hub1","hub2" +``` + +Update allocation policy and hubs for an enrollment record. + +### Example 2 +```powershell +$tag = @{} +$tag.Add("environment","updatedenv") +$desired = @{} +$desired.add("version_dps", "updateddps") +Set-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -tag $tag -Desired $desired +``` + +Update an enrollment's initial twin state. + +### Example 3 +```powershell +Set-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -PrimaryCertificate ".\primaryCertificate.cer" -SecondaryCertificate ".\secondaryCertificate.cer" +``` + +Update a symmetric key enrollment's primary and secondary certificates + +## PARAMETERS + +### -AllocationPolicy +Type of allocation for device assigned to the Hub. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSAllocationPolicy +Parameter Sets: (All) +Aliases: +Accepted values: Hashed, GeoLatency, Static, Custom + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiVersion +The API version of the provisioning service in the custom allocation request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Desired +Initial twin desired properties. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +IoT Hub Device ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsName +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -EdgeEnabled +Flag indicating edge enablement. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndorsementKey +TPM endorsement key for a TPM device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHub +Host name of target IoT Hub. +Use space-separated list for multiple IoT Hubs. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHubHostName +Host name of the target IoT Hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryCAName +The name of the primary root CA certificate. +If attestation with a root CA certificate is desired then a root ca name must be provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryCertificate +The path to the file containing the primary certificate. +Base-64 representation of X509 certificate .cer file or .pem file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryKey +The primary symmetric shared access key stored in base64 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisioningStatus +Enable or disable enrollment entry. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningStatus +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationId +Individual enrollment registration id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReprovisionPolicy +Device data to be handled on re-provision to different Iot Hub. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSReprovisionType +Parameter Sets: (All) +Aliases: +Accepted values: reprovisionandmigratedata, reprovisionandresetdata, never + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RootCertificate +Switch to update X509attestation using root certificates. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryCAName +The name of the secondary root CA certificate. +If attestation with a root CA certificate is desired then a root ca name must be provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryCertificate +The path to the file containing the secondary certificate. +Base-64 representation of X509 certificate .cer file or .pem file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryKey +The secondary symmetric shared access key stored in base64 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageRootKey +TPM storage root key for a TPM device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Initial twin tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebhookUrl +The webhook URL used for custom allocation requests. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIndividualEnrollment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Set-AzIoTDeviceProvisioningServiceEnrollmentGroup.md b/azps-10.1.0/Az.DeviceProvisioningServices/Set-AzIoTDeviceProvisioningServiceEnrollmentGroup.md new file mode 100644 index 0000000000..4f31aa7232 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Set-AzIoTDeviceProvisioningServiceEnrollmentGroup.md @@ -0,0 +1,481 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/set-aziotdeviceprovisioningserviceenrollmentgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceEnrollmentGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceEnrollmentGroup.md +--- + +# Set-AzIoTDeviceProvisioningServiceEnrollmentGroup + +## SYNOPSIS +Update a device enrollment group. + +## SYNTAX + +### ResourceSet (Default) +``` +Set-AzIoTDeviceProvisioningServiceEnrollmentGroup [-ResourceGroupName] <String> [-DpsName] <String> + -Name <String> [-ReprovisionPolicy <PSReprovisionType>] [-EdgeEnabled <Boolean>] [-Tag <Hashtable>] + [-Desired <Hashtable>] [-AllocationPolicy <PSAllocationPolicy>] [-ProvisioningStatus <PSProvisioningStatus>] + [-IotHubHostName <String>] [-IotHub <String[]>] [-WebhookUrl <String>] [-ApiVersion <String>] + [-PrimaryKey <String>] [-SecondaryKey <String>] [-PrimaryCertificate <String>] + [-SecondaryCertificate <String>] [-RootCertificate] [-PrimaryCAName <String>] [-SecondaryCAName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Set-AzIoTDeviceProvisioningServiceEnrollmentGroup [-DpsObject] <PSProvisioningServiceDescription> + -Name <String> [-ReprovisionPolicy <PSReprovisionType>] [-EdgeEnabled <Boolean>] [-Tag <Hashtable>] + [-Desired <Hashtable>] [-AllocationPolicy <PSAllocationPolicy>] [-ProvisioningStatus <PSProvisioningStatus>] + [-IotHubHostName <String>] [-IotHub <String[]>] [-WebhookUrl <String>] [-ApiVersion <String>] + [-PrimaryKey <String>] [-SecondaryKey <String>] [-PrimaryCertificate <String>] + [-SecondaryCertificate <String>] [-RootCertificate] [-PrimaryCAName <String>] [-SecondaryCAName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzIoTDeviceProvisioningServiceEnrollmentGroup [-ResourceId] <String> -Name <String> + [-ReprovisionPolicy <PSReprovisionType>] [-EdgeEnabled <Boolean>] [-Tag <Hashtable>] [-Desired <Hashtable>] + [-AllocationPolicy <PSAllocationPolicy>] [-ProvisioningStatus <PSProvisioningStatus>] + [-IotHubHostName <String>] [-IotHub <String[]>] [-WebhookUrl <String>] [-ApiVersion <String>] + [-PrimaryKey <String>] [-SecondaryKey <String>] [-PrimaryCertificate <String>] + [-SecondaryCertificate <String>] [-RootCertificate] [-PrimaryCAName <String>] [-SecondaryCAName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update an enrollment group in an Azure IoT Hub Device Provisioning Service. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -AllocationPolicy Hashed -IotHub "hub1","hub2" +``` + +Update allocation policy and hubs for an enrollment group. + +### Example 2 +```powershell +$tag = @{} +$tag.Add("environment","updatedenv") +$desired = @{} +$desired.add("version_dps", "updateddps") +Set-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -tag $tag -Desired $desired +``` + +Update an enrollment group's initial twin state. + +### Example 3 +```powershell +Set-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -PrimaryKey "newPrimaryKey" -SecondaryKey "newSecondaryKey" +``` + +Update a symmetric key enrollment group's primary and secondary keys + +## PARAMETERS + +### -AllocationPolicy +Type of allocation for device assigned to the Hub. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSAllocationPolicy +Parameter Sets: (All) +Aliases: +Accepted values: Hashed, GeoLatency, Static, Custom + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiVersion +The API version of the provisioning service in the custom allocation request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Desired +Initial twin desired properties. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsName +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpsObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -EdgeEnabled +Flag indicating edge enablement. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHub +Host name of target IoT Hub. +Use space-separated list for multiple IoT Hubs. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHubHostName +Host name of the target IoT Hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the enrollment group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryCAName +The name of the primary root CA certificate. +If attestation with a root CA certificate is desired then a root ca name must be provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryCertificate +The path to the file containing the primary certificate. +Base-64 representation of X509 certificate .cer file or .pem file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryKey +The primary symmetric shared access key stored in base64 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisioningStatus +Enable or disable enrollment entry. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningStatus +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReprovisionPolicy +Device data to be handled on re-provision to different Iot Hub. + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSReprovisionType +Parameter Sets: (All) +Aliases: +Accepted values: reprovisionandmigratedata, reprovisionandresetdata, never + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RootCertificate +Allows to create X509attestation using root certificates. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryCAName +The name of the secondary root CA certificate. +If attestation with a root CA certificate is desired then a root ca name must be provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryCertificate +The path to the file containing the secondary certificate. +Base-64 representation of X509 certificate .cer file or .pem file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryKey +The secondary symmetric shared access key stored in base64 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Initial twin tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebhookUrl +The webhook URL used for custom allocation requests. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSEnrollmentGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Update-AzIoTDeviceProvisioningService.md b/azps-10.1.0/Az.DeviceProvisioningServices/Update-AzIoTDeviceProvisioningService.md new file mode 100644 index 0000000000..0ae073e01c --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Update-AzIoTDeviceProvisioningService.md @@ -0,0 +1,296 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/update-aziotdeviceprovisioningservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningService.md +--- + +# Update-AzIoTDeviceProvisioningService + +## SYNOPSIS +Update an Azure IoT Hub device provisioning service. + +## SYNTAX + +### ResourceUpdateSet (Default) +``` +Update-AzIoTDeviceProvisioningService [-ResourceGroupName] <String> [-Name] <String> [-Tag] <Hashtable> + [-Reset] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectUpdateSet +``` +Update-AzIoTDeviceProvisioningService [-InputObject] <PSProvisioningServiceDescription> [-Tag] <Hashtable> + [-Reset] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectCreateUpdateSet +``` +Update-AzIoTDeviceProvisioningService [-InputObject] <PSProvisioningServiceDescription> + [-AllocationPolicy] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdUpdateSet +``` +Update-AzIoTDeviceProvisioningService [-ResourceId] <String> [-Tag] <Hashtable> [-Reset] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdCreateUpdateSet +``` +Update-AzIoTDeviceProvisioningService [-ResourceId] <String> [-AllocationPolicy] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceCreateUpdateSet +``` +Update-AzIoTDeviceProvisioningService [-ResourceGroupName] <String> [-Name] <String> + [-AllocationPolicy] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -AllocationPolicy "GeoLatency" +``` + +```output +ResourceGroupName : myresourcegroup +Name : myiotdps +Type : Microsoft.Devices/provisioningServices +ServiceOperationsHostName : myiotdps.azure-devices-provisioning.net +IotHubs : 0 +State : Active +AllocationPolicy : GeoLatency +Tags : {} +SkuName : S1 +SkuTier : Standard +Etag : AAAAAAAT52k= +``` + +Update Allocation Policy to "GeoLatency" of an Azure IoT Hub device provisioning service "myiotdps". + +### Example 2 +```powershell +$tag = @{} +$tag.Add("key1","Value1") +Update-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -Tag $tag +``` + +```output +ResourceGroupName : myresourcegroup +Name : myiotdps +Type : Microsoft.Devices/provisioningServices +ServiceOperationsHostName : myiotdps.azure-devices-provisioning.net +IotHubs : 0 +State : Active +AllocationPolicy : Hashed +Tags : {['key1','Value1']} +SkuName : S1 +SkuTier : Standard +Etag : AAAAAAAPoOk= +``` + +Add tags to an Azure IoT Hub device provisioning service "myiotdps". + +### Example 3 +```powershell +$tag = @{} +$tag.Add("key1","Value1") +Get-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" | Update-AzIoTDeviceProvisioningService -Tag $tag -Reset +``` + +```output +ResourceGroupName : myresourcegroup +Name : myiotdps +Type : Microsoft.Devices/provisioningServices +ServiceOperationsHostName : myiotdps.azure-devices-provisioning.net +IotHubs : 0 +State : Active +AllocationPolicy : Hashed +Tags : {['key1','Value1']} +SkuName : S1 +SkuTier : Standard +Etag : AAAAAAAS1dY= +``` + +Delete Tag and add new tags to an Azure IoT Hub device provisioning service "myiotdps" using pipeline. + +## PARAMETERS + +### -AllocationPolicy +IoT Device Provisioning Service Allocation policy + +```yaml +Type: System.String +Parameter Sets: InputObjectCreateUpdateSet, ResourceIdCreateUpdateSet, ResourceCreateUpdateSet +Aliases: +Accepted values: Hashed, GeoLatency, Static + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription +Parameter Sets: InputObjectUpdateSet, InputObjectCreateUpdateSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceUpdateSet, ResourceCreateUpdateSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reset +Reset IoT Device Provisioning Service Tags + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ResourceUpdateSet, InputObjectUpdateSet, ResourceIdUpdateSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceUpdateSet, ResourceCreateUpdateSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdUpdateSet, ResourceIdCreateUpdateSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +IoT Device Provisioning Service Tag collection + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ResourceUpdateSet, InputObjectUpdateSet, ResourceIdUpdateSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Update-AzIoTDeviceProvisioningServiceAccessPolicy.md b/azps-10.1.0/Az.DeviceProvisioningServices/Update-AzIoTDeviceProvisioningServiceAccessPolicy.md new file mode 100644 index 0000000000..33e286daff --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Update-AzIoTDeviceProvisioningServiceAccessPolicy.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/update-aziotdeviceprovisioningserviceaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningServiceAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningServiceAccessPolicy.md +--- + +# Update-AzIoTDeviceProvisioningServiceAccessPolicy + +## SYNOPSIS +Update a shared access policy in an Azure IoT Hub device provisioning service. + +## SYNTAX + +### ResourceSet (Default) +``` +Update-AzIoTDeviceProvisioningServiceAccessPolicy [-ResourceGroupName] <String> [-Name] <String> + [-KeyName] <String> [-Permissions] <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Update-AzIoTDeviceProvisioningServiceAccessPolicy + [-InputObject] <PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription> [-Permissions] <String[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Update-AzIoTDeviceProvisioningServiceAccessPolicy [-ResourceId] <String> [-KeyName] <String> + [-Permissions] <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -Permissions "EnrollmentWrite" +``` + +```output +ResourceGroupName : myresourcegroup +Name : myiotdps +KeyName : mypolicy +PrimaryKey : hyZJm8W7rra9O7eKhkLu9m/CIPPt9x1NXVMbMJa1rvg= +SecondaryKey : vbIwGCBQCIbS5BKFKdddM6uZHLhNTuz9r8CZYgmTmpY= +Rights : EnrollmentWrite +``` + +Update access policy "mypolicy" in an Azure IoT Hub device provisioning service with EnrollmentWrite right. + +### Example 2 +```powershell +Get-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" | Update-AzIoTDeviceProvisioningServiceAccessPolicy -Permissions "EnrollmentWrite" +``` + +```output +ResourceGroupName : myresourcegroup +Name : myiotdps +KeyName : mypolicy +PrimaryKey : hyZJm8W7rra9O7eKhkLu9m/CIPPt9x1NXVMbMJa1rvg= +SecondaryKey : vbIwGCBQCIbS5BKFKdddM6uZHLhNTuz9r8CZYgmTmpY= +Rights : EnrollmentWrite +``` + +Update access policy "mypolicy" in an Azure IoT Hub device provisioning service with EnrollmentWrite right using pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +IoT Device Provisioning Service access policy key name + +```yaml +Type: System.String +Parameter Sets: ResourceSet, ResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permissions +IoT Device Provisioning Service access policy permissions + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: ServiceConfig, EnrollmentRead, EnrollmentWrite, DeviceConnect, RegistrationStatusRead, RegistrationStatusWrite + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceProvisioningServices/Update-AzIoTDeviceProvisioningServiceLinkedHub.md b/azps-10.1.0/Az.DeviceProvisioningServices/Update-AzIoTDeviceProvisioningServiceLinkedHub.md new file mode 100644 index 0000000000..68d7018f33 --- /dev/null +++ b/azps-10.1.0/Az.DeviceProvisioningServices/Update-AzIoTDeviceProvisioningServiceLinkedHub.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml +Module Name: Az.DeviceProvisioningServices +online version: https://learn.microsoft.com/powershell/module/az.deviceprovisioningservices/update-aziotdeviceprovisioningservicelinkedhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningServiceLinkedHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningServiceLinkedHub.md +--- + +# Update-AzIoTDeviceProvisioningServiceLinkedHub + +## SYNOPSIS +Update a linked IoT hub in an Azure IoT Hub device provisioning service. + +## SYNTAX + +### ResourceSet (Default) +``` +Update-AzIoTDeviceProvisioningServiceLinkedHub [-ResourceGroupName] <String> [-Name] <String> + [-LinkedHubName] <String> [-AllocationWeight <Int32>] [-ApplyAllocationPolicy] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Update-AzIoTDeviceProvisioningServiceLinkedHub [-InputObject] <PSIotHubDefinitionDescription> + [-AllocationWeight <Int32>] [-ApplyAllocationPolicy] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Update-AzIoTDeviceProvisioningServiceLinkedHub [-ResourceId] <String> [-LinkedHubName] <String> + [-AllocationWeight <Int32>] [-ApplyAllocationPolicy] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub" -AllocationWeight 10 -ApplyAllocationPolicy +``` + +```output +ResourceGroupName : myresourcegroup +Name : myiotdps +LinkedHubName : myiothub.azure-devices.net +ConnectionString : HostName=myiothub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=**** +AllocationWeight : 10 +ApplyAllocationPolicy : True +Location : eastus +``` + +Update linked IoT hub "myiothub.azure-devices.net" in an Azure IoT Hub device provisioning service. + +## PARAMETERS + +### -AllocationWeight +Allocation weight of the IoT Hub + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyAllocationPolicy +Apply allocation policy to the IoT Hub + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IoT Device Provisioning Service Object + +```yaml +Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkedHubName +Host name of linked IoT Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet, ResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT Device Provisioning Service + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IoT Device Provisioning Service Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.DeviceUpdate/Az.DeviceUpdate.md b/azps-10.1.0/Az.DeviceUpdate/Az.DeviceUpdate.md new file mode 100644 index 0000000000..beffdce547 --- /dev/null +++ b/azps-10.1.0/Az.DeviceUpdate/Az.DeviceUpdate.md @@ -0,0 +1,45 @@ +--- +Module Name: Az.DeviceUpdate +Module Guid: 47841c04-1681-4e5e-884e-afb3faf25061 +Download Help Link: https://learn.microsoft.com/powershell/module/az.deviceupdate +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Az.DeviceUpdate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Az.DeviceUpdate.md +--- + +# Az.DeviceUpdate Module +## Description +Microsoft Azure PowerShell: DeviceUpdate cmdlets + +## Az.DeviceUpdate Cmdlets +### [Get-AzDeviceUpdateAccount](Get-AzDeviceUpdateAccount.md) +Returns account details for the given account name. + +### [Get-AzDeviceUpdateInstance](Get-AzDeviceUpdateInstance.md) +Returns instance details for the given instance and account name. + +### [New-AzDeviceUpdateAccount](New-AzDeviceUpdateAccount.md) +Creates or updates Account. + +### [New-AzDeviceUpdateCheckNameAvailabilityRequestObject](New-AzDeviceUpdateCheckNameAvailabilityRequestObject.md) +Create an in-memory object for CheckNameAvailabilityRequest. + +### [New-AzDeviceUpdateInstance](New-AzDeviceUpdateInstance.md) +Creates or updates instance. + +### [Remove-AzDeviceUpdateAccount](Remove-AzDeviceUpdateAccount.md) +Deletes account. + +### [Remove-AzDeviceUpdateInstance](Remove-AzDeviceUpdateInstance.md) +Deletes instance. + +### [Test-AzDeviceUpdateNameAvailability](Test-AzDeviceUpdateNameAvailability.md) +Checks ADU resource name availability. + +### [Update-AzDeviceUpdateAccount](Update-AzDeviceUpdateAccount.md) +Updates account's patchable properties + +### [Update-AzDeviceUpdateInstance](Update-AzDeviceUpdateInstance.md) +Updates instance's tags. + diff --git a/azps-10.1.0/Az.DeviceUpdate/Get-AzDeviceUpdateAccount.md b/azps-10.1.0/Az.DeviceUpdate/Get-AzDeviceUpdateAccount.md new file mode 100644 index 0000000000..0649fd5e5a --- /dev/null +++ b/azps-10.1.0/Az.DeviceUpdate/Get-AzDeviceUpdateAccount.md @@ -0,0 +1,193 @@ +--- +external help file: +Module Name: Az.DeviceUpdate +online version: https://learn.microsoft.com/powershell/module/az.deviceupdate/get-azdeviceupdateaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Get-AzDeviceUpdateAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Get-AzDeviceUpdateAccount.md +--- + +# Get-AzDeviceUpdateAccount + +## SYNOPSIS +Returns account details for the given account name. + +## SYNTAX + +### List (Default) +``` +Get-AzDeviceUpdateAccount [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDeviceUpdateAccount -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDeviceUpdateAccount -InputObject <IDeviceUpdateIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzDeviceUpdateAccount -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns account details for the given account name. + +## EXAMPLES + +### Example 1: Returns account details for the SubscriptionId. +```powershell +Get-AzDeviceUpdateAccount +``` + +```output +Name Location Sku ResourceGroupName +---- -------- --- ----------------- +azpstest-account eastus Standard azpstest_gp +``` + +Returns account details for the SubscriptionId. + +### Example 2: Returns account details for the given account name. +```powershell +Get-AzDeviceUpdateAccount -Name azpstest-account -ResourceGroupName azpstest_gp +``` + +```output +Name Location Sku ResourceGroupName +---- -------- --- ----------------- +azpstest-account eastus Standard azpstest_gp +``` + +Returns account details for the given account name. + +### Example 3: Returns account details for the Resource Group Name. +```powershell +Get-AzDeviceUpdateAccount -ResourceGroupName azpstest_gp +``` + +```output +Name Location Sku ResourceGroupName +---- -------- --- ----------------- +azpstest-account eastus Standard azpstest_gp +``` + +Returns account details for the Resource Group Name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.IDeviceUpdateIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Account name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.IDeviceUpdateIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.Api20221001.IAccount + +## 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 <IDeviceUpdateIdentity>`: Identity Parameter + - `[AccountName <String>]`: Account name. + - `[GroupId <String>]`: The group ID of the private link resource. + - `[Id <String>]`: Resource identity path + - `[InstanceName <String>]`: Instance name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[PrivateEndpointConnectionProxyId <String>]`: The ID of the private endpoint connection proxy object. + - `[ResourceGroupName <String>]`: The resource group name. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DeviceUpdate/Get-AzDeviceUpdateInstance.md b/azps-10.1.0/Az.DeviceUpdate/Get-AzDeviceUpdateInstance.md new file mode 100644 index 0000000000..1fd087c76b --- /dev/null +++ b/azps-10.1.0/Az.DeviceUpdate/Get-AzDeviceUpdateInstance.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.DeviceUpdate +online version: https://learn.microsoft.com/powershell/module/az.deviceupdate/get-azdeviceupdateinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Get-AzDeviceUpdateInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Get-AzDeviceUpdateInstance.md +--- + +# Get-AzDeviceUpdateInstance + +## SYNOPSIS +Returns instance details for the given instance and account name. + +## SYNTAX + +### List (Default) +``` +Get-AzDeviceUpdateInstance -AccountName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDeviceUpdateInstance -AccountName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDeviceUpdateInstance -InputObject <IDeviceUpdateIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns instance details for the given instance and account name. + +## EXAMPLES + +### Example 1: Returns instance details for the account name. +```powershell +Get-AzDeviceUpdateInstance -AccountName azpstest-account -ResourceGroupName azpstest_gp +``` + +```output +AccountName Name Location ResourceGroupName +----------- ---- -------- ----------------- +azpstest-account azpstest-instance eastus azpstest_gp +``` + +Returns instance details for the account name. + +### Example 2: Returns instance details for the given instance and account name. +```powershell +Get-AzDeviceUpdateInstance -AccountName azpstest-account -ResourceGroupName azpstest_gp -Name azpstest-instance +``` + +```output +AccountName Name Location ResourceGroupName +----------- ---- -------- ----------------- +azpstest-account azpstest-instance eastus azpstest_gp +``` + +Returns instance details for the given instance and account name. + +## PARAMETERS + +### -AccountName +Account name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.IDeviceUpdateIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Instance name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: InstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.IDeviceUpdateIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.Api20221001.IInstance + +## 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 <IDeviceUpdateIdentity>`: Identity Parameter + - `[AccountName <String>]`: Account name. + - `[GroupId <String>]`: The group ID of the private link resource. + - `[Id <String>]`: Resource identity path + - `[InstanceName <String>]`: Instance name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[PrivateEndpointConnectionProxyId <String>]`: The ID of the private endpoint connection proxy object. + - `[ResourceGroupName <String>]`: The resource group name. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DeviceUpdate/New-AzDeviceUpdateAccount.md b/azps-10.1.0/Az.DeviceUpdate/New-AzDeviceUpdateAccount.md new file mode 100644 index 0000000000..598b2cac4b --- /dev/null +++ b/azps-10.1.0/Az.DeviceUpdate/New-AzDeviceUpdateAccount.md @@ -0,0 +1,305 @@ +--- +external help file: +Module Name: Az.DeviceUpdate +online version: https://learn.microsoft.com/powershell/module/az.deviceupdate/new-azdeviceupdateaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/New-AzDeviceUpdateAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/New-AzDeviceUpdateAccount.md +--- + +# New-AzDeviceUpdateAccount + +## SYNOPSIS +Creates or updates Account. + +## SYNTAX + +``` +New-AzDeviceUpdateAccount -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-IdentityType <ManagedServiceIdentityType>] + [-PrivateEndpointConnection <IPrivateEndpointConnection[]>] [-PublicNetworkAccess <PublicNetworkAccess>] + [-Sku <Sku>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates Account. + +## EXAMPLES + +### Example 1: Creates or updates Account. +```powershell +New-AzDeviceUpdateAccount -Name azpstest-account -ResourceGroupName azpstest_gp -Location eastus -IdentityType 'SystemAssigned' -PublicNetworkAccess 'Enabled' -Sku 'Standard' +``` + +```output +Name Location Sku ResourceGroupName +---- -------- --- ----------------- +azpstest-account eastus Standard azpstest_gp +``` + +Creates or updates Account. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateEndpointConnection +List of private endpoint connections associated with the account. +To construct, see NOTES section for PRIVATEENDPOINTCONNECTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.Api20221001.IPrivateEndpointConnection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Whether or not public network access is allowed for the account. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +Device Update Sku + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Support.Sku +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.Api20221001.IAccount + +## 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. + + +`PRIVATEENDPOINTCONNECTION <IPrivateEndpointConnection[]>`: List of private endpoint connections associated with the account. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[GroupId <String[]>]`: Array of group IDs. + - `[PrivateLinkServiceConnectionStateActionsRequired <String>]`: A message indicating if changes on the service provider require any updates on the consumer. + - `[PrivateLinkServiceConnectionStateDescription <String>]`: The reason for approval/rejection of the connection. + - `[PrivateLinkServiceConnectionStateStatus <PrivateEndpointServiceConnectionStatus?>]`: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DeviceUpdate/New-AzDeviceUpdateCheckNameAvailabilityRequestObject.md b/azps-10.1.0/Az.DeviceUpdate/New-AzDeviceUpdateCheckNameAvailabilityRequestObject.md new file mode 100644 index 0000000000..0f68375118 --- /dev/null +++ b/azps-10.1.0/Az.DeviceUpdate/New-AzDeviceUpdateCheckNameAvailabilityRequestObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.DeviceUpdate +online version: https://learn.microsoft.com/powershell/module/az.DeviceUpdate/new-AzDeviceUpdateCheckNameAvailabilityRequestObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/New-AzDeviceUpdateCheckNameAvailabilityRequestObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/New-AzDeviceUpdateCheckNameAvailabilityRequestObject.md +--- + +# New-AzDeviceUpdateCheckNameAvailabilityRequestObject + +## SYNOPSIS +Create an in-memory object for CheckNameAvailabilityRequest. + +## SYNTAX + +``` +New-AzDeviceUpdateCheckNameAvailabilityRequestObject [-Name <String>] [-Type <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for CheckNameAvailabilityRequest. + +## EXAMPLES + +### Example 1: Check name availability request. +```powershell +New-AzDeviceUpdateCheckNameAvailabilityRequestObject -Name azpstest-account -Type "Microsoft.DeviceUpdate/accounts" +``` + +```output +Name +---- +azpstest-account +``` + +Check name availability request. + +## PARAMETERS + +### -Name +The name of the resource for which availability needs to be checked. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.Api30.CheckNameAvailabilityRequest + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DeviceUpdate/New-AzDeviceUpdateInstance.md b/azps-10.1.0/Az.DeviceUpdate/New-AzDeviceUpdateInstance.md new file mode 100644 index 0000000000..8bbe4dde09 --- /dev/null +++ b/azps-10.1.0/Az.DeviceUpdate/New-AzDeviceUpdateInstance.md @@ -0,0 +1,285 @@ +--- +external help file: +Module Name: Az.DeviceUpdate +online version: https://learn.microsoft.com/powershell/module/az.deviceupdate/new-azdeviceupdateinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/New-AzDeviceUpdateInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/New-AzDeviceUpdateInstance.md +--- + +# New-AzDeviceUpdateInstance + +## SYNOPSIS +Creates or updates instance. + +## SYNTAX + +``` +New-AzDeviceUpdateInstance -AccountName <String> -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-DiagnosticStoragePropertyConnectionString <String>] + [-DiagnosticStoragePropertyResourceId <String>] [-EnableDiagnostic] [-IotHubId <String[]>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates instance. + +## EXAMPLES + +### Example 1: Creates or updates instance. +```powershell +New-AzDeviceUpdateInstance -AccountName azpstest-account -Name azpstest-instance -ResourceGroupName azpstest_gp -Location eastus -IotHubId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/azpstest_gp/providers/Microsoft.Devices/IotHubs/azpstest-iothub" -EnableDiagnostic:$false -DiagnosticStoragePropertyResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/azpstest_gp/providers/Microsoft.Storage/storageAccounts/azpsteststorageaccount" -DiagnosticStoragePropertyConnectionString "De******et" +``` + +```output +AccountName Name Location ResourceGroupName +----------- ---- -------- ----------------- +azpstest-account azpstest-instance eastus azpstest_gp +``` + +Creates or updates instance. + +## PARAMETERS + +### -AccountName +Account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticStoragePropertyConnectionString +ConnectionString of the diagnostic storage account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticStoragePropertyResourceId +ResourceId of the diagnostic storage account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDiagnostic +Enables or Disables the diagnostic logs collection + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHubId +List of IoT Hubs associated with the account. +To construct, see NOTES section for IOTHUB properties and create a hash table. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Instance name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: InstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.Api20221001.IInstance + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DeviceUpdate/Remove-AzDeviceUpdateAccount.md b/azps-10.1.0/Az.DeviceUpdate/Remove-AzDeviceUpdateAccount.md new file mode 100644 index 0000000000..3cded86bd7 --- /dev/null +++ b/azps-10.1.0/Az.DeviceUpdate/Remove-AzDeviceUpdateAccount.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.DeviceUpdate +online version: https://learn.microsoft.com/powershell/module/az.deviceupdate/remove-azdeviceupdateaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Remove-AzDeviceUpdateAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Remove-AzDeviceUpdateAccount.md +--- + +# Remove-AzDeviceUpdateAccount + +## SYNOPSIS +Deletes account. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDeviceUpdateAccount -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDeviceUpdateAccount -InputObject <IDeviceUpdateIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes account. + +## EXAMPLES + +### Example 1: Deletes account. +```powershell +Remove-AzDeviceUpdateAccount -Name azpstest-account -ResourceGroupName azpstest_gp +``` + +Deletes account. + +### Example 2: Deletes account. +```powershell +Get-AzDeviceUpdateAccount -Name azpstest-account -ResourceGroupName azpstest_gp | Remove-AzDeviceUpdateAccount +``` + +Deletes account. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.IDeviceUpdateIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Account name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.IDeviceUpdateIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDeviceUpdateIdentity>`: Identity Parameter + - `[AccountName <String>]`: Account name. + - `[GroupId <String>]`: The group ID of the private link resource. + - `[Id <String>]`: Resource identity path + - `[InstanceName <String>]`: Instance name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[PrivateEndpointConnectionProxyId <String>]`: The ID of the private endpoint connection proxy object. + - `[ResourceGroupName <String>]`: The resource group name. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DeviceUpdate/Remove-AzDeviceUpdateInstance.md b/azps-10.1.0/Az.DeviceUpdate/Remove-AzDeviceUpdateInstance.md new file mode 100644 index 0000000000..110845f617 --- /dev/null +++ b/azps-10.1.0/Az.DeviceUpdate/Remove-AzDeviceUpdateInstance.md @@ -0,0 +1,249 @@ +--- +external help file: +Module Name: Az.DeviceUpdate +online version: https://learn.microsoft.com/powershell/module/az.deviceupdate/remove-azdeviceupdateinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Remove-AzDeviceUpdateInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Remove-AzDeviceUpdateInstance.md +--- + +# Remove-AzDeviceUpdateInstance + +## SYNOPSIS +Deletes instance. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDeviceUpdateInstance -AccountName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDeviceUpdateInstance -InputObject <IDeviceUpdateIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes instance. + +## EXAMPLES + +### Example 1: Deletes instance. +```powershell +Remove-AzDeviceUpdateInstance -AccountName azpstest-account -ResourceGroupName azpstest_gp -Name azpstest-instance +``` + +Deletes instance. + +### Example 2: Deletes instance. +```powershell +Get-AzDeviceUpdateInstance -AccountName azpstest-account -ResourceGroupName azpstest_gp -Name azpstest-instance | Remove-AzDeviceUpdateInstance +``` + +Deletes instance. + +## PARAMETERS + +### -AccountName +Account name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.IDeviceUpdateIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Instance name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: InstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.IDeviceUpdateIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDeviceUpdateIdentity>`: Identity Parameter + - `[AccountName <String>]`: Account name. + - `[GroupId <String>]`: The group ID of the private link resource. + - `[Id <String>]`: Resource identity path + - `[InstanceName <String>]`: Instance name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[PrivateEndpointConnectionProxyId <String>]`: The ID of the private endpoint connection proxy object. + - `[ResourceGroupName <String>]`: The resource group name. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DeviceUpdate/Test-AzDeviceUpdateNameAvailability.md b/azps-10.1.0/Az.DeviceUpdate/Test-AzDeviceUpdateNameAvailability.md new file mode 100644 index 0000000000..b217023a02 --- /dev/null +++ b/azps-10.1.0/Az.DeviceUpdate/Test-AzDeviceUpdateNameAvailability.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.DeviceUpdate +online version: https://learn.microsoft.com/powershell/module/az.deviceupdate/test-azdeviceupdatenameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Test-AzDeviceUpdateNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Test-AzDeviceUpdateNameAvailability.md +--- + +# Test-AzDeviceUpdateNameAvailability + +## SYNOPSIS +Checks ADU resource name availability. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzDeviceUpdateNameAvailability [-SubscriptionId <String>] [-Name <String>] [-Type <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Check +``` +Test-AzDeviceUpdateNameAvailability -Request <ICheckNameAvailabilityRequest> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CheckViaIdentity +``` +Test-AzDeviceUpdateNameAvailability -InputObject <IDeviceUpdateIdentity> + -Request <ICheckNameAvailabilityRequest> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzDeviceUpdateNameAvailability -InputObject <IDeviceUpdateIdentity> [-Name <String>] [-Type <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Checks ADU resource name availability. + +## EXAMPLES + +### Example 1: Checks ADU resource name availability. +```powershell +$data = New-AzDeviceUpdateCheckNameAvailabilityRequestObject -Name azpstest-account -Type "Microsoft.DeviceUpdate/accounts" +Test-AzDeviceUpdateNameAvailability -Request $data +``` + +```output +Message NameAvailable Reason +------- ------------- ------ + True +``` + +Checks ADU resource name availability. + +### Example 2: Checks ADU resource name availability. +```powershell +Test-AzDeviceUpdateNameAvailability -Name azpstest-account -Type "Microsoft.DeviceUpdate/accounts" +``` + +```output +Message NameAvailable Reason +------- ------------- ------ + True +``` + +Checks ADU resource name availability. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.IDeviceUpdateIdentity +Parameter Sets: CheckViaIdentity, CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the resource for which availability needs to be checked. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +The check availability request body. +To construct, see NOTES section for REQUEST properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.Api30.ICheckNameAvailabilityRequest +Parameter Sets: Check, CheckViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Check, CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The resource type. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.Api30.ICheckNameAvailabilityRequest + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.IDeviceUpdateIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.Api30.ICheckNameAvailabilityResponse + +## 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 <IDeviceUpdateIdentity>`: Identity Parameter + - `[AccountName <String>]`: Account name. + - `[GroupId <String>]`: The group ID of the private link resource. + - `[Id <String>]`: Resource identity path + - `[InstanceName <String>]`: Instance name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[PrivateEndpointConnectionProxyId <String>]`: The ID of the private endpoint connection proxy object. + - `[ResourceGroupName <String>]`: The resource group name. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +`REQUEST <ICheckNameAvailabilityRequest>`: The check availability request body. + - `[Name <String>]`: The name of the resource for which availability needs to be checked. + - `[Type <String>]`: The resource type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DeviceUpdate/Update-AzDeviceUpdateAccount.md b/azps-10.1.0/Az.DeviceUpdate/Update-AzDeviceUpdateAccount.md new file mode 100644 index 0000000000..3e75f4c4e5 --- /dev/null +++ b/azps-10.1.0/Az.DeviceUpdate/Update-AzDeviceUpdateAccount.md @@ -0,0 +1,296 @@ +--- +external help file: +Module Name: Az.DeviceUpdate +online version: https://learn.microsoft.com/powershell/module/az.deviceupdate/update-azdeviceupdateaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Update-AzDeviceUpdateAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Update-AzDeviceUpdateAccount.md +--- + +# Update-AzDeviceUpdateAccount + +## SYNOPSIS +Updates account's patchable properties + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDeviceUpdateAccount -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IdentityType <ManagedServiceIdentityType>] [-Location <String>] [-Tag <Hashtable>] + [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDeviceUpdateAccount -InputObject <IDeviceUpdateIdentity> [-IdentityType <ManagedServiceIdentityType>] + [-Location <String>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates account's patchable properties + +## EXAMPLES + +### Example 1: Updates account's patchable properties +```powershell +Update-AzDeviceUpdateAccount -Name azpstest-account -ResourceGroupName azpstest_gp -IdentityType 'SystemAssigned' -Tag @{"abc"="123"} +``` + +```output +Name Location Sku ResourceGroupName +---- -------- --- ----------------- +azpstest-account eastus Standard azpstest_gp +``` + +Updates account's patchable properties + +### Example 2: Updates account's patchable properties +```powershell +Get-AzDeviceUpdateAccount -Name azpstest-account -ResourceGroupName azpstest_gp | Update-AzDeviceUpdateAccount -IdentityType 'SystemAssigned' -Tag @{"abc"="123"} +``` + +```output +Name Location Sku ResourceGroupName +---- -------- --- ----------------- +azpstest-account eastus Standard azpstest_gp +``` + +Updates account's patchable properties + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Support.ManagedServiceIdentityType +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.DeviceUpdate.Models.IDeviceUpdateIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Account name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +List of key value pairs that describe the resource. +This will overwrite the existing tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.IDeviceUpdateIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.Api20221001.IAccount + +## 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 <IDeviceUpdateIdentity>`: Identity Parameter + - `[AccountName <String>]`: Account name. + - `[GroupId <String>]`: The group ID of the private link resource. + - `[Id <String>]`: Resource identity path + - `[InstanceName <String>]`: Instance name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[PrivateEndpointConnectionProxyId <String>]`: The ID of the private endpoint connection proxy object. + - `[ResourceGroupName <String>]`: The resource group name. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DeviceUpdate/Update-AzDeviceUpdateInstance.md b/azps-10.1.0/Az.DeviceUpdate/Update-AzDeviceUpdateInstance.md new file mode 100644 index 0000000000..92b398241b --- /dev/null +++ b/azps-10.1.0/Az.DeviceUpdate/Update-AzDeviceUpdateInstance.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.DeviceUpdate +online version: https://learn.microsoft.com/powershell/module/az.deviceupdate/update-azdeviceupdateinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Update-AzDeviceUpdateInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DeviceUpdate/help/Update-AzDeviceUpdateInstance.md +--- + +# Update-AzDeviceUpdateInstance + +## SYNOPSIS +Updates instance's tags. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDeviceUpdateInstance -AccountName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDeviceUpdateInstance -InputObject <IDeviceUpdateIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates instance's tags. + +## EXAMPLES + +### Example 1: Updates instance's tags. +```powershell +Update-AzDeviceUpdateInstance -AccountName azpstest-account -ResourceGroupName azpstest_gp -Name azpstest-instance -Tag @{"abc"="123"} +``` + +```output +AccountName Name Location ResourceGroupName +----------- ---- -------- ----------------- +azpstest-account azpstest-instance eastus azpstest_gp +``` + +Updates instance's tags. + +### Example 2: Updates instance's tags. +```powershell +Get-AzDeviceUpdateInstance -AccountName azpstest-account -ResourceGroupName azpstest_gp -Name azpstest-instance | Update-AzDeviceUpdateInstance -Tag @{"abc"="123"} +``` + +```output +AccountName Name Location ResourceGroupName +----------- ---- -------- ----------------- +azpstest-account azpstest-instance eastus azpstest_gp +``` + +Updates instance's tags. + +## PARAMETERS + +### -AccountName +Account name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.IDeviceUpdateIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Instance name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: InstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +List of key value pairs that describe the resource. +This will overwrite the existing tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.IDeviceUpdateIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DeviceUpdate.Models.Api20221001.IInstance + +## 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 <IDeviceUpdateIdentity>`: Identity Parameter + - `[AccountName <String>]`: Account name. + - `[GroupId <String>]`: The group ID of the private link resource. + - `[Id <String>]`: Resource identity path + - `[InstanceName <String>]`: Instance name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[PrivateEndpointConnectionProxyId <String>]`: The ID of the private endpoint connection proxy object. + - `[ResourceGroupName <String>]`: The resource group name. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/Az.DigitalTwins.md b/azps-10.1.0/Az.DigitalTwins/Az.DigitalTwins.md new file mode 100644 index 0000000000..700e4d88ae --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/Az.DigitalTwins.md @@ -0,0 +1,61 @@ +--- +Module Name: Az.DigitalTwins +Module Guid: 938cd822-353e-462c-a393-a2871ae2f354 +Download Help Link: https://learn.microsoft.com/powershell/module/az.digitaltwins +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Az.DigitalTwins.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Az.DigitalTwins.md +--- + +# Az.DigitalTwins Module +## Description +Microsoft Azure PowerShell: DigitalTwins cmdlets + +## Az.DigitalTwins Cmdlets +### [Get-AzDigitalTwinsEndpoint](Get-AzDigitalTwinsEndpoint.md) +Get DigitalTwinsInstances Endpoint. + +### [Get-AzDigitalTwinsInstance](Get-AzDigitalTwinsInstance.md) +Get DigitalTwinsInstances resource. + +### [Get-AzDigitalTwinsPrivateEndpointConnection](Get-AzDigitalTwinsPrivateEndpointConnection.md) +Get private endpoint connection properties for the given private endpoint. + +### [Get-AzDigitalTwinsPrivateLinkResource](Get-AzDigitalTwinsPrivateLinkResource.md) +Get the specified private link resource for the given Digital Twin. + +### [Get-AzDigitalTwinsTimeSeriesDatabaseConnection](Get-AzDigitalTwinsTimeSeriesDatabaseConnection.md) +Get the description of an existing time series database connection. + +### [New-AzDigitalTwinsEndpoint](New-AzDigitalTwinsEndpoint.md) +Create or update DigitalTwinsInstance endpoint. + +### [New-AzDigitalTwinsInstance](New-AzDigitalTwinsInstance.md) +Create or update the metadata of a DigitalTwinsInstance. +The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance. + +### [New-AzDigitalTwinsPrivateEndpointConnection](New-AzDigitalTwinsPrivateEndpointConnection.md) +Update the status of a private endpoint connection with the given name. + +### [New-AzDigitalTwinsTimeSeriesDatabaseConnection](New-AzDigitalTwinsTimeSeriesDatabaseConnection.md) +Create or update a time series database connection. + +### [Remove-AzDigitalTwinsEndpoint](Remove-AzDigitalTwinsEndpoint.md) +Delete a DigitalTwinsInstance endpoint. + +### [Remove-AzDigitalTwinsInstance](Remove-AzDigitalTwinsInstance.md) +Delete a DigitalTwinsInstance. + +### [Remove-AzDigitalTwinsPrivateEndpointConnection](Remove-AzDigitalTwinsPrivateEndpointConnection.md) +Delete private endpoint connection with the specified name. + +### [Remove-AzDigitalTwinsTimeSeriesDatabaseConnection](Remove-AzDigitalTwinsTimeSeriesDatabaseConnection.md) +Delete a time series database connection. + +### [Test-AzDigitalTwinsInstanceNameAvailability](Test-AzDigitalTwinsInstanceNameAvailability.md) +Check if a DigitalTwinsInstance name is available. + +### [Update-AzDigitalTwinsInstance](Update-AzDigitalTwinsInstance.md) +Update metadata of DigitalTwinsInstance. + diff --git a/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsEndpoint.md b/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsEndpoint.md new file mode 100644 index 0000000000..78c3afa5d3 --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsEndpoint.md @@ -0,0 +1,193 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/get-azdigitaltwinsendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Get-AzDigitalTwinsEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Get-AzDigitalTwinsEndpoint.md +--- + +# Get-AzDigitalTwinsEndpoint + +## SYNOPSIS +Get DigitalTwinsInstances Endpoint. + +## SYNTAX + +### List (Default) +``` +Get-AzDigitalTwinsEndpoint -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDigitalTwinsEndpoint -EndpointName <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDigitalTwinsEndpoint -InputObject <IDigitalTwinsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get DigitalTwinsInstances Endpoint. + +## EXAMPLES + +### Example 1: List AzDigitalTwinsEndpoint in ResourceGroup +```powershell +Get-AzDigitalTwinsEndpoint -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance +``` + +```output +Name EndpointType AuthenticationType ResourceGroupName +---- ------------ ------------------ ----------------- +azps-dt-eh EventHub KeyBased azps_test_group +azps-dt-eg EventGrid KeyBased azps_test_group +azps-dt-sb ServiceBus KeyBased azps_test_group +``` + +List all AzDigitalTwinsEndpoints by ResourceGroupName + +### Example 2: Get AzDigitalTwinsEndpoint by EndpointName +```powershell +Get-AzDigitalTwinsEndpoint -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -EndpointName azps-dt-eh +``` + +```output +Name EndpointType AuthenticationType ResourceGroupName +---- ------------ ------------------ ----------------- +azps-dt-eh EventHub KeyBased azps_test_group +``` + +Get AzDigitalTwinsEndpoint by EndpointName in ResourceGroup + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of Endpoint Resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IDigitalTwinsEndpointResource + +## 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 <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsInstance.md b/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsInstance.md new file mode 100644 index 0000000000..790e5e433d --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsInstance.md @@ -0,0 +1,195 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/get-azdigitaltwinsinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Get-AzDigitalTwinsInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Get-AzDigitalTwinsInstance.md +--- + +# Get-AzDigitalTwinsInstance + +## SYNOPSIS +Get DigitalTwinsInstances resource. + +## SYNTAX + +### List (Default) +``` +Get-AzDigitalTwinsInstance [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDigitalTwinsInstance -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDigitalTwinsInstance -InputObject <IDigitalTwinsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzDigitalTwinsInstance -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get DigitalTwinsInstances resource. + +## EXAMPLES + +### Example 1: List DigitalTwinsInstances resource. +```powershell +Get-AzDigitalTwinsInstance +``` + +```output +Name Location ResourceGroupName +---- -------- ----------------- +azps-dt eastus azps_test_group +azps-digitaltwin-instance eastus azps_test_group +``` + +List DigitalTwinsInstances resource. + +### Example 2: Get DigitalTwinsInstances resource by ResourceGroup. +```powershell +Get-AzDigitalTwinsInstance -ResourceGroupName azps_test_group +``` + +```output +Name Location ResourceGroupName +---- -------- ----------------- +azps-digitaltwins-instance eastus azps_test_group +``` + +Get DigitalTwinsInstances resource by ResourceGroup. + +### Example 3: Get DigitalTwinsInstances resource by Instance Name. +```powershell +Get-AzDigitalTwinsInstance -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance +``` + +```output +Name Location ResourceGroupName +---- -------- ----------------- +azps-digitaltwins-instance eastus azps_test_group +``` + +Get DigitalTwinsInstances resource by Instance Name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IDigitalTwinsDescription + +## 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 <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsPrivateEndpointConnection.md b/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsPrivateEndpointConnection.md new file mode 100644 index 0000000000..fe932a2be0 --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsPrivateEndpointConnection.md @@ -0,0 +1,191 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/get-azdigitaltwinsprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Get-AzDigitalTwinsPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Get-AzDigitalTwinsPrivateEndpointConnection.md +--- + +# Get-AzDigitalTwinsPrivateEndpointConnection + +## SYNOPSIS +Get private endpoint connection properties for the given private endpoint. + +## SYNTAX + +### List (Default) +``` +Get-AzDigitalTwinsPrivateEndpointConnection -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDigitalTwinsPrivateEndpointConnection -Name <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDigitalTwinsPrivateEndpointConnection -InputObject <IDigitalTwinsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get private endpoint connection properties for the given private endpoint. + +## EXAMPLES + +### Example 1: List private endpoint connection properties for the digital twins instance. +```powershell +Get-AzDigitalTwinsPrivateEndpointConnection -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance +``` + +```output +Name GroupId PrivateLinkServiceConnectionStateStatus ResourceGroupName +---- ------- --------------------------------------- ----------------- +11c903a5-7b8a-4b86-812d-03f007dca6df {API} Approved azps_test_group +``` + +List private endpoint connection properties for the digital twins instance. + +### Example 2: Get private endpoint connection properties for the given private endpoint. +```powershell +Get-AzDigitalTwinsPrivateEndpointConnection -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -Name "11c903a5-7b8a-4b86-812d-03f007dca6df" +``` + +```output +Name GroupId PrivateLinkServiceConnectionStateStatus ResourceGroupName +---- ------- --------------------------------------- ----------------- +11c903a5-7b8a-4b86-812d-03f007dca6df {API} Approved azps_test_group +``` + +Get private endpoint connection properties for the given private endpoint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PrivateEndpointConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IPrivateEndpointConnection + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsPrivateLinkResource.md b/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsPrivateLinkResource.md new file mode 100644 index 0000000000..c040970619 --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsPrivateLinkResource.md @@ -0,0 +1,191 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/get-azdigitaltwinsprivatelinkresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Get-AzDigitalTwinsPrivateLinkResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Get-AzDigitalTwinsPrivateLinkResource.md +--- + +# Get-AzDigitalTwinsPrivateLinkResource + +## SYNOPSIS +Get the specified private link resource for the given Digital Twin. + +## SYNTAX + +### List (Default) +``` +Get-AzDigitalTwinsPrivateLinkResource -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDigitalTwinsPrivateLinkResource -ResourceGroupName <String> -ResourceId <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDigitalTwinsPrivateLinkResource -InputObject <IDigitalTwinsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the specified private link resource for the given Digital Twin. + +## EXAMPLES + +### Example 1: Get the specified private link resource for the given Digital Twin. +```powershell +Get-AzDigitalTwinsPrivateLinkResource -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance +``` + +```output +GroupId Name ResourceGroupName +------- ---- ----------------- +API API azps_test_group +``` + +Get the specified private link resource for the given Digital Twin. + +### Example 2: Get the specified private link resource for the given Digital Twin. +```powershell +Get-AzDigitalTwinsPrivateLinkResource -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -ResourceId API +``` + +```output +GroupId Name ResourceGroupName +------- ---- ----------------- +API API azps_test_group +``` + +Get the specified private link resource for the given Digital Twin. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The name of the private link resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IGroupIdInformation + +## 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 <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsTimeSeriesDatabaseConnection.md b/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsTimeSeriesDatabaseConnection.md new file mode 100644 index 0000000000..4cef8aa176 --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/Get-AzDigitalTwinsTimeSeriesDatabaseConnection.md @@ -0,0 +1,191 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/get-azdigitaltwinstimeseriesdatabaseconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Get-AzDigitalTwinsTimeSeriesDatabaseConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Get-AzDigitalTwinsTimeSeriesDatabaseConnection.md +--- + +# Get-AzDigitalTwinsTimeSeriesDatabaseConnection + +## SYNOPSIS +Get the description of an existing time series database connection. + +## SYNTAX + +### List (Default) +``` +Get-AzDigitalTwinsTimeSeriesDatabaseConnection -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDigitalTwinsTimeSeriesDatabaseConnection -Name <String> -ResourceGroupName <String> + -ResourceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDigitalTwinsTimeSeriesDatabaseConnection -InputObject <IDigitalTwinsIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the description of an existing time series database connection. + +## EXAMPLES + +### Example 1: List description of an existing time series database connection. +```powershell +Get-AzDigitalTwinsTimeSeriesDatabaseConnection -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance +``` + +```output +Name ConnectionType ProvisioningState ResourceGroupName +---- -------------- ----------------- ----------------- +azps-tsdc AzureDataExplorer Succeed azps_test_group +``` + +List description of an existing time series database connection. + +### Example 2: Get the description of an existing time series database connection. +```powershell +Get-AzDigitalTwinsTimeSeriesDatabaseConnection -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -Name azps-tsdc +``` + +```output +Name ConnectionType ProvisioningState ResourceGroupName +---- -------------- ----------------- ----------------- +azps-tsdc AzureDataExplorer Succeed azps_test_group +``` + +Get the description of an existing time series database connection. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of time series database connection. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: TimeSeriesDatabaseConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.ITimeSeriesDatabaseConnection + +## 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 <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/New-AzDigitalTwinsEndpoint.md b/azps-10.1.0/Az.DigitalTwins/New-AzDigitalTwinsEndpoint.md new file mode 100644 index 0000000000..f4e278616b --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/New-AzDigitalTwinsEndpoint.md @@ -0,0 +1,414 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/new-azdigitaltwinsendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/New-AzDigitalTwinsEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/New-AzDigitalTwinsEndpoint.md +--- + +# New-AzDigitalTwinsEndpoint + +## SYNOPSIS +Create or update DigitalTwinsInstance endpoint. + +## SYNTAX + +### EventHub (Default) +``` +New-AzDigitalTwinsEndpoint -EndpointName <String> -ResourceGroupName <String> -ResourceName <String> + -ConnectionStringPrimaryKey <String> -EndpointType <EndpointType> [-SubscriptionId <String>] + [-AuthenticationType <AuthenticationType>] [-ConnectionStringSecondaryKey <String>] + [-DeadLetterSecret <String>] [-DeadLetterUri <String>] [-EndpointDescription <IDigitalTwinsEndpointResource>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### EventGrid +``` +New-AzDigitalTwinsEndpoint -EndpointName <String> -ResourceGroupName <String> -ResourceName <String> + -AccessKey1 <String> -EndpointType <EndpointType> -TopicEndpoint <String> [-SubscriptionId <String>] + [-AuthenticationType <AuthenticationType>] [-DeadLetterSecret <String>] [-DeadLetterUri <String>] + [-EndpointDescription <IDigitalTwinsEndpointResource>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ServiceBus +``` +New-AzDigitalTwinsEndpoint -EndpointName <String> -ResourceGroupName <String> -ResourceName <String> + -EndpointType <EndpointType> -PrimaryConnectionString <String> [-SubscriptionId <String>] + [-AuthenticationType <AuthenticationType>] [-DeadLetterSecret <String>] [-DeadLetterUri <String>] + [-EndpointDescription <IDigitalTwinsEndpointResource>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update DigitalTwinsInstance endpoint. + +## EXAMPLES + +### Example 1: Create an AzDigitalTwinsEndpoint for Eventhub +```powershell +New-AzDigitalTwinsEndpoint -EndpointName azps-dt-eh -EndpointType EventHub -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -connectionStringPrimaryKey 'Endpoint=sb://azps-eventhubs.servicebus.windows.net/;SharedAccessKeyName=abc123;SharedAccessKey=******;EntityPath=azps-eh' -AuthenticationType 'KeyBased' +``` + +```output +Name EndpointType AuthenticationType ResourceGroupName +---- ------------ ------------------ ----------------- +azps-dt-eh EventHub KeyBased azps_test_group +``` + +Create an AzDigitalTwinsEndpoint for Eventhub by connectionStringPrimaryKey + +### Example 2: Create an AzDigitalTwinsEndpoint for EventGrid +```powershell +New-AzDigitalTwinsEndpoint -EndpointName azps-dt-eg -EndpointType EventGrid -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -TopicEndpoint 'https://azps-eventgrid.eastus-1.eventgrid.azure.net/api/events' -AccessKey1 '******=' -AuthenticationType 'KeyBased' +``` + +```output +Name EndpointType AuthenticationType ResourceGroupName +---- ------------ ------------------ ----------------- +azps-dt-eg EventGrid KeyBased azps_test_group +``` + +Create an AzDigitalTwinsEndpoint for Eventhub by TopicEndpoint and accessKey1 + +### Example 3: Create an AzDigitalTwinsEndpoint for ServiceBus +```powershell +New-AzDigitalTwinsEndpoint -EndpointName azps-dt-sb -EndpointType ServiceBus -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -PrimaryConnectionString "Endpoint=sb://azps-servicebus.servicebus.windows.net/;SharedAccessKeyName=abc123;SharedAccessKey=******;EntityPath=azps-sb" -AuthenticationType 'KeyBased' +``` + +```output +Name EndpointType AuthenticationType ResourceGroupName +---- ------------ ------------------ ----------------- +azps-dt-sb ServiceBus KeyBased azps_test_group +``` + +Create an AzDigitalTwinsEndpoint for ServicBus by PrimaryConnectionString + +## PARAMETERS + +### -AccessKey1 +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: EventGrid +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationType +Specifies the authentication type being used for connecting to the endpoint. +Defaults to 'KeyBased'. +If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). +If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Support.AuthenticationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionStringPrimaryKey +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: EventHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionStringSecondaryKey +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: EventHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeadLetterSecret +Dead letter storage secret for key-based authentication. +Will be obfuscated during read. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeadLetterUri +Dead letter storage URL for identity-based authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDescription +DigitalTwinsInstance endpoint resource. +To construct, see NOTES section for ENDPOINTDESCRIPTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IDigitalTwinsEndpointResource +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -EndpointName +Name of Endpoint Resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointType +The type of Digital Twins endpoint + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Support.EndpointType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryConnectionString +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: ServiceBus +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicEndpoint +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: EventGrid +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IDigitalTwinsEndpointResource + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IDigitalTwinsEndpointResource + +## 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. + + +`ENDPOINTDESCRIPTION <IDigitalTwinsEndpointResource>`: DigitalTwinsInstance endpoint resource. + - `EndpointType <EndpointType>`: The type of Digital Twins endpoint + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[AuthenticationType <AuthenticationType?>]`: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. + - `[DeadLetterSecret <String>]`: Dead letter storage secret for key-based authentication. Will be obfuscated during read. + - `[DeadLetterUri <String>]`: Dead letter storage URL for identity-based authentication. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/New-AzDigitalTwinsInstance.md b/azps-10.1.0/Az.DigitalTwins/New-AzDigitalTwinsInstance.md new file mode 100644 index 0000000000..b0a2236fd4 --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/New-AzDigitalTwinsInstance.md @@ -0,0 +1,314 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/new-azdigitaltwinsinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/New-AzDigitalTwinsInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/New-AzDigitalTwinsInstance.md +--- + +# New-AzDigitalTwinsInstance + +## SYNOPSIS +Create or update the metadata of a DigitalTwinsInstance. +The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzDigitalTwinsInstance -ResourceGroupName <String> -ResourceName <String> -Location <String> + [-SubscriptionId <String>] [-IdentityType <DigitalTwinsIdentityType>] + [-PrivateEndpointConnection <IPrivateEndpointConnection[]>] [-PublicNetworkAccess <PublicNetworkAccess>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzDigitalTwinsInstance -InputObject <IDigitalTwinsIdentity> -Location <String> + [-IdentityType <DigitalTwinsIdentityType>] [-PrivateEndpointConnection <IPrivateEndpointConnection[]>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update the metadata of a DigitalTwinsInstance. +The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance. + +## EXAMPLES + +### Example 1: Create or update the metadata of a DigitalTwinsInstance. +```powershell +New-AzDigitalTwinsInstance -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -Location eastus -IdentityType 'SystemAssigned' -PublicNetworkAccess 'Enabled' +``` + +```output +Name Location ResourceGroupName +---- -------- ----------------- +azps-digitaltwins-instance eastus azps_test_group +``` + +Create or update the metadata of a DigitalTwinsInstance. +The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The type of Managed Identity used by the DigitalTwinsInstance. +Only SystemAssigned is supported. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Support.DigitalTwinsIdentityType +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.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateEndpointConnection +The private endpoint connections. +To construct, see NOTES section for PRIVATEENDPOINTCONNECTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IPrivateEndpointConnection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Public network access for the DigitalTwinsInstance. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IDigitalTwinsDescription + +## 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 <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +`PRIVATEENDPOINTCONNECTION <IPrivateEndpointConnection[]>`: The private endpoint connections. + - `[GroupId <String[]>]`: The list of group ids for the private endpoint connection. + - `[PrivateLinkServiceConnectionStateActionsRequired <String>]`: Actions required for a private endpoint connection. + - `[PrivateLinkServiceConnectionStateDescription <String>]`: The description for the current state of a private endpoint connection. + - `[PrivateLinkServiceConnectionStateStatus <PrivateLinkServiceConnectionStatus?>]`: The status of a private endpoint connection. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/New-AzDigitalTwinsPrivateEndpointConnection.md b/azps-10.1.0/Az.DigitalTwins/New-AzDigitalTwinsPrivateEndpointConnection.md new file mode 100644 index 0000000000..b4eb2f13be --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/New-AzDigitalTwinsPrivateEndpointConnection.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/new-azdigitaltwinsprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/New-AzDigitalTwinsPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/New-AzDigitalTwinsPrivateEndpointConnection.md +--- + +# New-AzDigitalTwinsPrivateEndpointConnection + +## SYNOPSIS +Update the status of a private endpoint connection with the given name. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzDigitalTwinsPrivateEndpointConnection -Name <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String>] [-GroupId <String[]>] [-PrivateLinkServiceConnectionStateActionsRequired <String>] + [-PrivateLinkServiceConnectionStateDescription <String>] + [-PrivateLinkServiceConnectionStateStatus <PrivateLinkServiceConnectionStatus>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzDigitalTwinsPrivateEndpointConnection -InputObject <IDigitalTwinsIdentity> [-GroupId <String[]>] + [-PrivateLinkServiceConnectionStateActionsRequired <String>] + [-PrivateLinkServiceConnectionStateDescription <String>] + [-PrivateLinkServiceConnectionStateStatus <PrivateLinkServiceConnectionStatus>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update the status of a private endpoint connection with the given name. + +## EXAMPLES + +### Example 1: Update the status of a private endpoint connection with the given name. +```powershell +New-AzDigitalTwinsPrivateEndpointConnection -Name "11c903a5-7b8a-4b86-812d-03f007dca6df" -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -PrivateLinkServiceConnectionStateStatus 'Approved' -PrivateLinkServiceConnectionStateDescription "Approved by johndoe@company.com." +``` + +```output +Name GroupId PrivateLinkServiceConnectionStateStatus ResourceGroupName +---- ------- --------------------------------------- ----------------- +11c903a5-7b8a-4b86-812d-03f007dca6df {API} Approved azps_test_group +``` + +Update the status of a private endpoint connection with the given name. +Please Create a Private Endpoint in `Azure Digital Twins` -\> `Networking` -\> `Private endpoint connections`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +The list of group ids for the private endpoint connection. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: PrivateEndpointConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkServiceConnectionStateActionsRequired +Actions required for a private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkServiceConnectionStateDescription +The description for the current state of a private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkServiceConnectionStateStatus +The status of a private endpoint connection. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Support.PrivateLinkServiceConnectionStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IPrivateEndpointConnection + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/New-AzDigitalTwinsTimeSeriesDatabaseConnection.md b/azps-10.1.0/Az.DigitalTwins/New-AzDigitalTwinsTimeSeriesDatabaseConnection.md new file mode 100644 index 0000000000..044069dcdd --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/New-AzDigitalTwinsTimeSeriesDatabaseConnection.md @@ -0,0 +1,373 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/new-azdigitaltwinstimeseriesdatabaseconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/New-AzDigitalTwinsTimeSeriesDatabaseConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/New-AzDigitalTwinsTimeSeriesDatabaseConnection.md +--- + +# New-AzDigitalTwinsTimeSeriesDatabaseConnection + +## SYNOPSIS +Create or update a time series database connection. + +## SYNTAX + +### Create (Default) +``` +New-AzDigitalTwinsTimeSeriesDatabaseConnection -Name <String> -ResourceGroupName <String> + -ResourceName <String> -AdxDatabaseName <String> -AdxEndpointUri <String> -AdxResourceId <String> + -AdxTableName <String> -EventHubEndpointUri <String> -EventHubEntityPath <String> + -EventHubNamespaceResourceId <String> [-SubscriptionId <String>] + [-TimeSeriesDatabaseConnectionDescription <ITimeSeriesDatabaseConnection>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentity +``` +New-AzDigitalTwinsTimeSeriesDatabaseConnection -InputObject <IDigitalTwinsIdentity> -AdxDatabaseName <String> + -AdxEndpointUri <String> -AdxResourceId <String> -AdxTableName <String> -EventHubEndpointUri <String> + -EventHubEntityPath <String> -EventHubNamespaceResourceId <String> + [-TimeSeriesDatabaseConnectionDescription <ITimeSeriesDatabaseConnection>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a time series database connection. + +## EXAMPLES + +### Example 1: Create or update a time series database connection. +```powershell +New-AzDigitalTwinsTimeSeriesDatabaseConnection -Name azps-tsdc -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -AdxDatabaseName "azpsadec1database" -AdxEndpointUri "https://azpsdataexplorer.eastus.kusto.windows.net" -AdxResourceId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/azps_test_group/providers/Microsoft.Kusto/clusters/azpsdataexplorer" -AdxTableName "azpsadec1database-table" -EventHubEndpointUri "sb://azps-eventhubs.servicebus.windows.net/" -EventHubEntityPath "azps-eventhubs" -EventHubNamespaceResourceId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/azps_test_group/providers/Microsoft.EventHub/namespaces/azps-eventhubs" +``` + +```output +Name ConnectionType ProvisioningState ResourceGroupName +---- -------------- ----------------- ----------------- +azps-tsdc AzureDataExplorer Succeed azps_test_group +``` + +Create or update a time series database connection. + +## PARAMETERS + +### -AdxDatabaseName +The name of the Azure Data Explorer database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdxEndpointUri +The URI of the Azure Data Explorer endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdxResourceId +The resource ID of the Azure Data Explorer cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdxTableName +The name of the Azure Data Explorer table. +Defaults to AdtPropertyEvents. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubEndpointUri +The URL of the EventHub namespace for identity-based authentication. +It must include the protocol sb:// + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubEntityPath +The EventHub name in the EventHub namespace for identity-based authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubNamespaceResourceId +The resource ID of the EventHub namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of time series database connection. + +```yaml +Type: System.String +Parameter Sets: Create +Aliases: TimeSeriesDatabaseConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: Create +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeSeriesDatabaseConnectionDescription +Describes a time series database connection resource. +To construct, see NOTES section for TIMESERIESDATABASECONNECTIONDESCRIPTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.ITimeSeriesDatabaseConnection +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.ITimeSeriesDatabaseConnection + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.ITimeSeriesDatabaseConnection + +## 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 <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +`TIMESERIESDATABASECONNECTIONDESCRIPTION <ITimeSeriesDatabaseConnection>`: Describes a time series database connection resource. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/Remove-AzDigitalTwinsEndpoint.md b/azps-10.1.0/Az.DigitalTwins/Remove-AzDigitalTwinsEndpoint.md new file mode 100644 index 0000000000..a9a9bca3cd --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/Remove-AzDigitalTwinsEndpoint.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/remove-azdigitaltwinsendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Remove-AzDigitalTwinsEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Remove-AzDigitalTwinsEndpoint.md +--- + +# Remove-AzDigitalTwinsEndpoint + +## SYNOPSIS +Delete a DigitalTwinsInstance endpoint. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDigitalTwinsEndpoint -EndpointName <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDigitalTwinsEndpoint -InputObject <IDigitalTwinsIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a DigitalTwinsInstance endpoint. + +## EXAMPLES + +### Example 1: Delete the azDigitalTwinsEndPoint by EndPointName. +```powershell +Remove-AzDigitalTwinsEndpoint -EndpointName azps-dt-eg -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance +``` + +Delete the azDigitalTwinsEndPoint by EndPointName ResourceGroupName and ResourceName. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of Endpoint Resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IDigitalTwinsEndpointResource + +## 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 <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/Remove-AzDigitalTwinsInstance.md b/azps-10.1.0/Az.DigitalTwins/Remove-AzDigitalTwinsInstance.md new file mode 100644 index 0000000000..91fd10bfca --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/Remove-AzDigitalTwinsInstance.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/remove-azdigitaltwinsinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Remove-AzDigitalTwinsInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Remove-AzDigitalTwinsInstance.md +--- + +# Remove-AzDigitalTwinsInstance + +## SYNOPSIS +Delete a DigitalTwinsInstance. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDigitalTwinsInstance -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDigitalTwinsInstance -InputObject <IDigitalTwinsIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a DigitalTwinsInstance. + +## EXAMPLES + +### Example 1: Remove an AzDigitalTwinsInstance by name. +```powershell +Remove-AzDigitalTwinsInstance -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance +``` + +This command removes an AzDigitalTwinsInstance by name. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IDigitalTwinsDescription + +## 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 <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/Remove-AzDigitalTwinsPrivateEndpointConnection.md b/azps-10.1.0/Az.DigitalTwins/Remove-AzDigitalTwinsPrivateEndpointConnection.md new file mode 100644 index 0000000000..87ff43a41f --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/Remove-AzDigitalTwinsPrivateEndpointConnection.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/remove-azdigitaltwinsprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Remove-AzDigitalTwinsPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Remove-AzDigitalTwinsPrivateEndpointConnection.md +--- + +# Remove-AzDigitalTwinsPrivateEndpointConnection + +## SYNOPSIS +Delete private endpoint connection with the specified name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDigitalTwinsPrivateEndpointConnection -Name <String> -ResourceGroupName <String> + -ResourceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDigitalTwinsPrivateEndpointConnection -InputObject <IDigitalTwinsIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete private endpoint connection with the specified name. + +## EXAMPLES + +### Example 1: Delete private endpoint connection with the specified name. +```powershell +Remove-AzDigitalTwinsPrivateEndpointConnection -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -Name "11c903a5-7b8a-4b86-812d-03f007dca6df" +``` + +Delete private endpoint connection with the specified name. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: PrivateEndpointConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/Remove-AzDigitalTwinsTimeSeriesDatabaseConnection.md b/azps-10.1.0/Az.DigitalTwins/Remove-AzDigitalTwinsTimeSeriesDatabaseConnection.md new file mode 100644 index 0000000000..781c3e227c --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/Remove-AzDigitalTwinsTimeSeriesDatabaseConnection.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/remove-azdigitaltwinstimeseriesdatabaseconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Remove-AzDigitalTwinsTimeSeriesDatabaseConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Remove-AzDigitalTwinsTimeSeriesDatabaseConnection.md +--- + +# Remove-AzDigitalTwinsTimeSeriesDatabaseConnection + +## SYNOPSIS +Delete a time series database connection. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDigitalTwinsTimeSeriesDatabaseConnection -Name <String> -ResourceGroupName <String> + -ResourceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDigitalTwinsTimeSeriesDatabaseConnection -InputObject <IDigitalTwinsIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a time series database connection. + +## EXAMPLES + +### Example 1: Delete a time series database connection. +```powershell +Remove-AzDigitalTwinsTimeSeriesDatabaseConnection -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -Name azps-tsdc +``` + +Delete a time series database connection. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of time series database connection. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: TimeSeriesDatabaseConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.ITimeSeriesDatabaseConnection + +## 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 <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/Test-AzDigitalTwinsInstanceNameAvailability.md b/azps-10.1.0/Az.DigitalTwins/Test-AzDigitalTwinsInstanceNameAvailability.md new file mode 100644 index 0000000000..9c2f1fc751 --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/Test-AzDigitalTwinsInstanceNameAvailability.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/test-azdigitaltwinsinstancenameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Test-AzDigitalTwinsInstanceNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Test-AzDigitalTwinsInstanceNameAvailability.md +--- + +# Test-AzDigitalTwinsInstanceNameAvailability + +## SYNOPSIS +Check if a DigitalTwinsInstance name is available. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzDigitalTwinsInstanceNameAvailability -Location <String> -Name <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzDigitalTwinsInstanceNameAvailability -InputObject <IDigitalTwinsIdentity> -Name <String> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Check if a DigitalTwinsInstance name is available. + +## EXAMPLES + +### Example 1: Check if a DigitalTwinsInstance name is available. +```powershell +Test-AzDigitalTwinsInstanceNameAvailability -Location westus2 -Name testName +``` + +```output +Message NameAvailable Reason +------- ------------- ------ +'testName' is available. True +``` + +Check if a DigitalTwinsInstance name is available. + +### Example 2: Check if a DigitalTwinsInstance name is not available. +```powershell +Test-AzDigitalTwinsInstanceNameAvailability -Location westus2 -Name !testName +``` + +```output +Message NameAvailable Reason +------- ------------- ------ +'!testName' must be between 3 and 63 characters. Alphanumerics and hyphens are allowed. Value must start and end with an alphanumeric. False Invalid +``` + +Check if a DigitalTwinsInstance name is not available. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Location of DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.ICheckNameResult + +## 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 <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DigitalTwins/Update-AzDigitalTwinsInstance.md b/azps-10.1.0/Az.DigitalTwins/Update-AzDigitalTwinsInstance.md new file mode 100644 index 0000000000..7e66a4688b --- /dev/null +++ b/azps-10.1.0/Az.DigitalTwins/Update-AzDigitalTwinsInstance.md @@ -0,0 +1,279 @@ +--- +external help file: +Module Name: Az.DigitalTwins +online version: https://learn.microsoft.com/powershell/module/az.digitaltwins/update-azdigitaltwinsinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Update-AzDigitalTwinsInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DigitalTwins/help/Update-AzDigitalTwinsInstance.md +--- + +# Update-AzDigitalTwinsInstance + +## SYNOPSIS +Update metadata of DigitalTwinsInstance. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDigitalTwinsInstance -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String>] + [-IdentityType <DigitalTwinsIdentityType>] [-PublicNetworkAccess <PublicNetworkAccess>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDigitalTwinsInstance -InputObject <IDigitalTwinsIdentity> [-IdentityType <DigitalTwinsIdentityType>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update metadata of DigitalTwinsInstance. + +## EXAMPLES + +### Example 1: Update metadata of DigitalTwinsInstance. +```powershell +Update-AzDigitalTwinsInstance -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -Tag @{"abc"="123"} +``` + +```output +Name Location ResourceGroupName +---- -------- ----------------- +azps-digitaltwins-instance eastus azps_test_group +``` + +Update metadata of DigitalTwinsInstance. + +### Example 2: Update the AzDigitalTwinsInstance by another AzDigitalTwinsInstance. +```powershell +Get-AzDigitalTwinsInstance -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance | Update-AzDigitalTwinsInstance -Tag @{"1234"="abcd"} +``` + +```output +Name Location ResourceGroupName +---- -------- ----------------- +azps-digitaltwins-instance eastus azps_test_group +``` + +Update the AzDigitalTwinsInstance by another AzDigitalTwinsInstance. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The type of Managed Identity used by the DigitalTwinsInstance. +Only SystemAssigned is supported. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Support.DigitalTwinsIdentityType +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.DigitalTwins.Models.IDigitalTwinsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Public network access for the DigitalTwinsInstance. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the DigitalTwinsInstance. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Instance patch properties + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IDigitalTwinsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IDigitalTwinsDescription + +## 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 <IDigitalTwinsIdentity>`: Identity Parameter + - `[EndpointName <String>]`: Name of Endpoint Resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Location of DigitalTwinsInstance. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the DigitalTwinsInstance. + - `[ResourceId <String>]`: The name of the private link resource. + - `[ResourceName <String>]`: The name of the DigitalTwinsInstance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[TimeSeriesDatabaseConnectionName <String>]`: Name of time series database connection. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/Az.DiskPool.md b/azps-10.1.0/Az.DiskPool/Az.DiskPool.md new file mode 100644 index 0000000000..9ec07b440b --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/Az.DiskPool.md @@ -0,0 +1,74 @@ +--- +Module Name: Az.DiskPool +Module Guid: 4ef9a257-25da-4db7-832b-0c44a0e44cf0 +Download Help Link: https://learn.microsoft.com/powershell/module/az.diskpool +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Az.DiskPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Az.DiskPool.md +--- + +# Az.DiskPool Module +## Description +Microsoft Azure PowerShell: DiskPool cmdlets + +## Az.DiskPool Cmdlets +### [Get-AzDiskPool](Get-AzDiskPool.md) +Get a Disk pool. + +### [Get-AzDiskPoolIscsiTarget](Get-AzDiskPoolIscsiTarget.md) +Get an iSCSI Target. + +### [Get-AzDiskPoolOutboundNetworkDependencyEndpoint](Get-AzDiskPoolOutboundNetworkDependencyEndpoint.md) +Gets the network endpoints of all outbound dependencies of a Disk Pool + +### [Get-AzDiskPoolResourceSku](Get-AzDiskPoolResourceSku.md) +Lists available StoragePool resources and skus in an Azure location. + +### [Get-AzDiskPoolZone](Get-AzDiskPoolZone.md) +Lists available Disk Pool Skus in an Azure location. + +### [Invoke-AzDiskPoolRedeployment](Invoke-AzDiskPoolRedeployment.md) +Upgrade replaces the underlying virtual machine hosts one at a time. +This operation can take 10-15 minutes to complete. +This is expected service behavior. + +### [New-AzDiskPool](New-AzDiskPool.md) +Create or Update Disk pool. +This create or update operation can take 15 minutes to complete. +This is expected service behavior. + +### [New-AzDiskPoolAclObject](New-AzDiskPoolAclObject.md) +Create a in-memory object for Acl + +### [New-AzDiskPoolIscsiLunObject](New-AzDiskPoolIscsiLunObject.md) +Create a in-memory object for IscsiLun + +### [New-AzDiskPoolIscsiTarget](New-AzDiskPoolIscsiTarget.md) +Create or Update an iSCSI Target. + +### [Remove-AzDiskPool](Remove-AzDiskPool.md) +Delete a Disk pool; attached disks are not affected. +This delete operation can take 10 minutes to complete. +This is expected service behavior. + +### [Remove-AzDiskPoolIscsiTarget](Remove-AzDiskPoolIscsiTarget.md) +Delete an iSCSI Target. + +### [Start-AzDiskPool](Start-AzDiskPool.md) +The operation to start a Disk Pool. +This start operation can take 10 minutes to complete. +This is expected service behavior. + +### [Stop-AzDiskPool](Stop-AzDiskPool.md) +Shuts down the Disk Pool and releases the compute resources. +You are not billed for the compute resources that this Disk Pool uses. +This operation can take 10 minutes to complete. +This is expected service behavior. + +### [Update-AzDiskPool](Update-AzDiskPool.md) +Update a Disk pool. + +### [Update-AzDiskPoolIscsiTarget](Update-AzDiskPoolIscsiTarget.md) +Update an iSCSI Target. + diff --git a/azps-10.1.0/Az.DiskPool/Get-AzDiskPool.md b/azps-10.1.0/Az.DiskPool/Get-AzDiskPool.md new file mode 100644 index 0000000000..7aae4dc6a2 --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/Get-AzDiskPool.md @@ -0,0 +1,206 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/get-azdiskpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Get-AzDiskPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Get-AzDiskPool.md +--- + +# Get-AzDiskPool + +## SYNOPSIS +Get a Disk pool. + +## SYNTAX + +### List (Default) +``` +Get-AzDiskPool [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDiskPool -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDiskPool -InputObject <IDiskPoolIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzDiskPool -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a Disk pool. + +## EXAMPLES + +### Example 1: List all Disk Pools in a resource group +```powershell +Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test' +``` + +```output +Name Location Status ProvisioningState AvailabilityZone +---- -------- ------ ----------------- ---------------- +disk-pool-1 eastus2euap Running Succeeded {3} +disk-pool-5 eastus2euap Running Succeeded {3} +``` + +This command lists all Disk Pools in a resource group + +### Example 2: Get a Disk Pool +```powershell +Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test' -Name 'disk-pool-1' +``` + +```output +Name Location Status ProvisioningState AvailabilityZone +---- -------- ------ ----------------- ---------------- +disk-pool-1 eastus2euap Running Succeeded {3} +``` + +This command gets a Disk Pool. + +### Example 3: List all Disk Pools under a subscription +```powershell +Get-AzDiskPool +``` + +```output +Name Location Status ProvisioningState AvailabilityZone +---- -------- ------ ----------------- ---------------- +disk-pool-1 eastus2euap Running Succeeded {3} +disk-pool-5 eastus2euap Running Succeeded {3} +``` + +This command lists all the Disk Pools in a subscription. + +### Example 4: Get a Disk Pool by object +```powershell +New-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' -Location 'westeurope' -SkuName 'Standard' -SkuTier 'Standard' -SubnetId '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Network/virtualNetworks/disk-pool-vnet/subnets/default' -AvailabilityZone "1" | Get-AzDiskPool +``` + +```output +Name Location Status ProvisioningState AvailabilityZone +---- -------- ------ ----------------- ---------------- +disk-pool-1 eastus2euap Running Succeeded {3} +``` + +This command gets a Disk Pool by object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Disk Pool. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DiskPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IDiskPool + +## 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 `<IDiskPoolIdentity>`: Identity Parameter + - `[DiskPoolName <String>]`: The name of the Disk Pool. + - `[Id <String>]`: Resource identity path + - `[IscsiTargetName <String>]`: The name of the iSCSI Target. + - `[Location <String>]`: The location of the resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/Get-AzDiskPoolIscsiTarget.md b/azps-10.1.0/Az.DiskPool/Get-AzDiskPoolIscsiTarget.md new file mode 100644 index 0000000000..027128f45d --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/Get-AzDiskPoolIscsiTarget.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/get-azdiskpooliscsitarget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Get-AzDiskPoolIscsiTarget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Get-AzDiskPoolIscsiTarget.md +--- + +# Get-AzDiskPoolIscsiTarget + +## SYNOPSIS +Get an iSCSI Target. + +## SYNTAX + +### List (Default) +``` +Get-AzDiskPoolIscsiTarget -DiskPoolName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDiskPoolIscsiTarget -DiskPoolName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDiskPoolIscsiTarget -InputObject <IDiskPoolIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get an iSCSI Target. + +## EXAMPLES + +### Example 1: List iSCSI targets in a Disk Pool +```powershell +Get-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5' +``` + +```output +Name Type +---- ---- +target0 Microsoft.StoragePool/diskPools/iscsiTargets +``` + +This command lists all iSCSI targets in a Disk Pool. + +### Example 2: Get an iSCSI target +```powershell +Get-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5' -Name 'target0' +``` + +```output +Name Type +---- ---- +target0 Microsoft.StoragePool/diskPools/iscsiTargets +``` + +This command gets an iSCSI target. + +### Example 3: Get an iSCSI target by object +```powershell +New-AzDiskPoolIscsiTarget -DiskPoolName 'disk-pool-5' -Name 'target1' -ResourceGroupName 'storagepool-rg-test' -AclMode 'Dynamic' | Get-AzDiskPoolIscsiTarget +``` + +```output +Name Type +---- ---- +target1 Microsoft.StoragePool/diskPools/iscsiTargets +``` + +This command gets an iSCSI target by object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskPoolName +The name of the Disk Pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the iSCSI Target. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: IscsiTargetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IIscsiTarget + +## 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 `<IDiskPoolIdentity>`: Identity Parameter + - `[DiskPoolName <String>]`: The name of the Disk Pool. + - `[Id <String>]`: Resource identity path + - `[IscsiTargetName <String>]`: The name of the iSCSI Target. + - `[Location <String>]`: The location of the resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/Get-AzDiskPoolOutboundNetworkDependencyEndpoint.md b/azps-10.1.0/Az.DiskPool/Get-AzDiskPoolOutboundNetworkDependencyEndpoint.md new file mode 100644 index 0000000000..dfb5c552f9 --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/Get-AzDiskPoolOutboundNetworkDependencyEndpoint.md @@ -0,0 +1,155 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/get-azdiskpooloutboundnetworkdependencyendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Get-AzDiskPoolOutboundNetworkDependencyEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Get-AzDiskPoolOutboundNetworkDependencyEndpoint.md +--- + +# Get-AzDiskPoolOutboundNetworkDependencyEndpoint + +## SYNOPSIS +Gets the network endpoints of all outbound dependencies of a Disk Pool + +## SYNTAX + +``` +Get-AzDiskPoolOutboundNetworkDependencyEndpoint -DiskPoolName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the network endpoints of all outbound dependencies of a Disk Pool + +## EXAMPLES + +### Example 1: List network dependency endpoints for a Disk pool +```powershell +Get-AzDiskPoolOutboundNetworkDependencyEndpoint -DiskPoolName disk-pool-1 -ResourceGroupName storagepool-rg-test | Format-Table -Wrap +``` + +```output +Category Endpoint +-------- -------- +Microsoft Event Hub {{ + "domainName": "evhns-rp-prod-eus2euap.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }} +Microsoft Service Bus {{ + "domainName": "sb-rp-prod-eus2euap.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }} +Microsoft Storage {{ + "domainName": "strpprodeus2euap.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, { + "domainName": "stbsprodeus2euap.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }} +Microsoft Apt Mirror {{ + "domainName": "azure.archive.ubuntu.com", + "endpointDetails": [ + { + "port": 443 + } + ] + }} +``` + +The command lists all outbound network dependency endpoints for a Disk pool. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskPoolName +The name of the Disk Pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IOutboundEnvironmentEndpoint + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/Get-AzDiskPoolResourceSku.md b/azps-10.1.0/Az.DiskPool/Get-AzDiskPoolResourceSku.md new file mode 100644 index 0000000000..ffdffb52ab --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/Get-AzDiskPoolResourceSku.md @@ -0,0 +1,103 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/get-azdiskpoolresourcesku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Get-AzDiskPoolResourceSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Get-AzDiskPoolResourceSku.md +--- + +# Get-AzDiskPoolResourceSku + +## SYNOPSIS +Lists available StoragePool resources and skus in an Azure location. + +## SYNTAX + +``` +Get-AzDiskPoolResourceSku -Location <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Lists available StoragePool resources and skus in an Azure location. + +## EXAMPLES + +### Example 1: Lists all resources and skus in a location +```powershell +Get-AzDiskPoolResourceSku -Location AustraliaEast +``` + +```output +ApiVersion Name ResourceType Tier +---------- ---- ------------ ---- +2021-08-01 Standard_S1 diskPools Standard +2021-08-01 Premium_P1 diskPools Premium +2021-08-01 Basic_B1 diskPools Basic +``` + +The command lists all resources and skus in a location. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IResourceSkuInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/Get-AzDiskPoolZone.md b/azps-10.1.0/Az.DiskPool/Get-AzDiskPoolZone.md new file mode 100644 index 0000000000..1b6c53e8da --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/Get-AzDiskPoolZone.md @@ -0,0 +1,103 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/get-azdiskpoolzone +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Get-AzDiskPoolZone.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Get-AzDiskPoolZone.md +--- + +# Get-AzDiskPoolZone + +## SYNOPSIS +Lists available Disk Pool Skus in an Azure location. + +## SYNTAX + +``` +Get-AzDiskPoolZone -Location <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Lists available Disk Pool Skus in an Azure location. + +## EXAMPLES + +### Example 1: List availability zones for a location +```powershell +Get-AzDiskPoolZone -Location eastus +``` + +```output +SkuName SkuTier AvailabilityZone AdditionalCapability +------- ------- ---------------- -------------------- +Basic Basic {3, 1, 2} +Standard Standard {3, 1, 2} +Premium Premium {3, 1, 2} +``` + +The command lists all availability zones for a location. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IDiskPoolZoneInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/Invoke-AzDiskPoolRedeployment.md b/azps-10.1.0/Az.DiskPool/Invoke-AzDiskPoolRedeployment.md new file mode 100644 index 0000000000..4db2b16a76 --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/Invoke-AzDiskPoolRedeployment.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/invoke-azdiskpoolredeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Invoke-AzDiskPoolRedeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Invoke-AzDiskPoolRedeployment.md +--- + +# Invoke-AzDiskPoolRedeployment + +## SYNOPSIS +Upgrade replaces the underlying virtual machine hosts one at a time. +This operation can take 10-15 minutes to complete. +This is expected service behavior. + +## SYNTAX + +### Redeploy (Default) +``` +Invoke-AzDiskPoolRedeployment -DiskPoolName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RedeployViaIdentity +``` +Invoke-AzDiskPoolRedeployment -InputObject <IDiskPoolIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Upgrade replaces the underlying virtual machine hosts one at a time. +This operation can take 10-15 minutes to complete. +This is expected service behavior. + +## EXAMPLES + +### Example 1: Redeploy a Disk Pool +```powershell +Invoke-AzDiskPoolRedeployment -DiskPoolName 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' +``` + +This command redeploys a Disk Pool. + +### Example 2: Redeploy a Disk Pool by object +```powershell +Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test' -Name 'disk-pool-1' | Invoke-AzDiskPoolRedeployment +``` + +This command redeploys a Disk Pool by object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskPoolName +The name of the Disk Pool. + +```yaml +Type: System.String +Parameter Sets: Redeploy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity +Parameter Sets: RedeployViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Redeploy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Redeploy +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IDiskPoolIdentity>`: Identity Parameter + - `[DiskPoolName <String>]`: The name of the Disk Pool. + - `[Id <String>]`: Resource identity path + - `[IscsiTargetName <String>]`: The name of the iSCSI Target. + - `[Location <String>]`: The location of the resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/New-AzDiskPool.md b/azps-10.1.0/Az.DiskPool/New-AzDiskPool.md new file mode 100644 index 0000000000..09fd1e92f1 --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/New-AzDiskPool.md @@ -0,0 +1,337 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/new-azdiskpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/New-AzDiskPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/New-AzDiskPool.md +--- + +# New-AzDiskPool + +## SYNOPSIS +Create or Update Disk pool. +This create or update operation can take 15 minutes to complete. +This is expected service behavior. + +## SYNTAX + +``` +New-AzDiskPool -Name <String> -ResourceGroupName <String> -Location <String> -SkuName <String> + -SubnetId <String> [-SubscriptionId <String>] [-AdditionalCapability <String[]>] + [-AvailabilityZone <String[]>] [-DiskId <String[]>] [-ManagedBy <String>] [-ManagedByExtended <String[]>] + [-SkuTier <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or Update Disk pool. +This create or update operation can take 15 minutes to complete. +This is expected service behavior. + +## EXAMPLES + +### Example 1: Create a Disk Pool +```powershell +New-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' -Location 'eastus2euap' -SkuName 'Standard' -SkuTier 'Standard' -SubnetId '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Network/virtualNetworks/disk-pool-vnet/subnets/default' -AvailabilityZone "1" +``` + +```output +Name Location Status ProvisioningState AvailabilityZone +---- -------- ------ ----------------- ---------------- +disk-pool-1 eastus2euap Running Succeeded {3} +``` + +This command creates a Disk Pool. + +## PARAMETERS + +### -AdditionalCapability +List of additional capabilities for a Disk Pool. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityZone +Logical zone for Disk Pool resource; example: ["1"]. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskId +List of Azure Managed Disks to attach to a Disk Pool. +To construct, see NOTES section for DISK properties and create a hash table. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedBy +Azure resource id. +Indicates if this resource is managed by another Azure resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedByExtended +List of Azure resource ids that manage this resource. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Disk Pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DiskPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Sku name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +Sku tier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Azure Resource ID of a Subnet for the Disk Pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IDiskPool + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/New-AzDiskPoolAclObject.md b/azps-10.1.0/Az.DiskPool/New-AzDiskPoolAclObject.md new file mode 100644 index 0000000000..a6538af6b8 --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/New-AzDiskPoolAclObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.DiskPool/new-AzDiskPoolAclObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/New-AzDiskPoolAclObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/New-AzDiskPoolAclObject.md +--- + +# New-AzDiskPoolAclObject + +## SYNOPSIS +Create a in-memory object for Acl + +## SYNTAX + +``` +New-AzDiskPoolAclObject -InitiatorIqn <String> -MappedLun <String[]> [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for Acl + +## EXAMPLES + +### Example 1: Create an acl object +```powershell +New-AzDiskPoolAclObject -InitiatorIqn 'iqn.2021-05.com.microsoft:target0' -MappedLun @('lun0') +``` + +```output +InitiatorIqn MappedLun +------------ --------- +iqn.2021-05.com.microsoft:target0 {lun0} +``` + +This command creates an acl object. + +## PARAMETERS + +### -InitiatorIqn +iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MappedLun +List of LUN names mapped to the ACL. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.Acl + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/New-AzDiskPoolIscsiLunObject.md b/azps-10.1.0/Az.DiskPool/New-AzDiskPoolIscsiLunObject.md new file mode 100644 index 0000000000..4674a6255e --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/New-AzDiskPoolIscsiLunObject.md @@ -0,0 +1,79 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.DiskPool/new-AzDiskPoolIscsiLunObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/New-AzDiskPoolIscsiLunObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/New-AzDiskPoolIscsiLunObject.md +--- + +# New-AzDiskPoolIscsiLunObject + +## SYNOPSIS +Create a in-memory object for IscsiLun + +## SYNTAX + +``` +New-AzDiskPoolIscsiLunObject -ManagedDiskAzureResourceId <String> -Name <String> [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for IscsiLun + +## EXAMPLES + +### Example 1: Create an iSCSI lun object +```powershell +New-AzDiskPoolIscsiLunObject -ManagedDiskAzureResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Compute/disks/disk-pool-disk-1" -Name 'lun0' +``` + +This command creates an iSCSI lun object. + +## PARAMETERS + +### -ManagedDiskAzureResourceId +Azure Resource ID of the Managed Disk. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +User defined name for iSCSI LUN; example: "lun0". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IscsiLun + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/New-AzDiskPoolIscsiTarget.md b/azps-10.1.0/Az.DiskPool/New-AzDiskPoolIscsiTarget.md new file mode 100644 index 0000000000..c3c26fd7d2 --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/New-AzDiskPoolIscsiTarget.md @@ -0,0 +1,301 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/new-azdiskpooliscsitarget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/New-AzDiskPoolIscsiTarget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/New-AzDiskPoolIscsiTarget.md +--- + +# New-AzDiskPoolIscsiTarget + +## SYNOPSIS +Create or Update an iSCSI Target. + +## SYNTAX + +``` +New-AzDiskPoolIscsiTarget -DiskPoolName <String> -Name <String> -ResourceGroupName <String> + -AclMode <IscsiTargetAclMode> [-SubscriptionId <String>] [-Lun <IIscsiLun[]>] [-ManagedBy <String>] + [-ManagedByExtended <String[]>] [-StaticAcl <IAcl[]>] [-TargetIqn <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or Update an iSCSI Target. + +## EXAMPLES + +### Example 1: Create an iSCSI target +```powershell +New-AzDiskPoolIscsiTarget -DiskPoolName 'disk-pool-1' -Name 'target1' -ResourceGroupName 'storagepool-rg-test' -AclMode 'Dynamic' +``` + +```output +Name Type +---- ---- +target1 Microsoft.StoragePool/diskPools/iscsiTargets +``` + +This command creates an iSCSI target. + +## PARAMETERS + +### -AclMode +Mode for Target connectivity. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Support.IscsiTargetAclMode +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskPoolName +The name of the Disk Pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lun +List of LUNs to be exposed through iSCSI Target. +To construct, see NOTES section for LUN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IIscsiLun[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedBy +Azure resource id. +Indicates if this resource is managed by another Azure resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedByExtended +List of Azure resource ids that manage this resource. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the iSCSI Target. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IscsiTargetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticAcl +Access Control List (ACL) for an iSCSI Target; defines LUN masking policy +To construct, see NOTES section for STATICACL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IAcl[] +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetIqn +iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IIscsiTarget + +## 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. + + +LUN <IIscsiLun[]>: List of LUNs to be exposed through iSCSI Target. + - `ManagedDiskAzureResourceId <String>`: Azure Resource ID of the Managed Disk. + - `Name <String>`: User defined name for iSCSI LUN; example: "lun0" + +STATICACL <IAcl[]>: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy + - `InitiatorIqn <String>`: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". + - `MappedLun <String[]>`: List of LUN names mapped to the ACL. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/Remove-AzDiskPool.md b/azps-10.1.0/Az.DiskPool/Remove-AzDiskPool.md new file mode 100644 index 0000000000..8e99e4ad58 --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/Remove-AzDiskPool.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/remove-azdiskpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Remove-AzDiskPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Remove-AzDiskPool.md +--- + +# Remove-AzDiskPool + +## SYNOPSIS +Delete a Disk pool; attached disks are not affected. +This delete operation can take 10 minutes to complete. +This is expected service behavior. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDiskPool -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDiskPool -InputObject <IDiskPoolIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a Disk pool; attached disks are not affected. +This delete operation can take 10 minutes to complete. +This is expected service behavior. + +## EXAMPLES + +### Example 1: Delete a Disk Pool +```powershell +Remove-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' +``` + +This command deletes a Disk Pool. + +### Example 2: Delete a Disk Pool by object +```powershell +Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test' -Name 'disk-pool-1' | Remove-AzDiskPool +``` + +This command deletes a Disk Pool by object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Disk Pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DiskPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IDiskPoolIdentity>`: Identity Parameter + - `[DiskPoolName <String>]`: The name of the Disk Pool. + - `[Id <String>]`: Resource identity path + - `[IscsiTargetName <String>]`: The name of the iSCSI Target. + - `[Location <String>]`: The location of the resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/Remove-AzDiskPoolIscsiTarget.md b/azps-10.1.0/Az.DiskPool/Remove-AzDiskPoolIscsiTarget.md new file mode 100644 index 0000000000..66a6372eeb --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/Remove-AzDiskPoolIscsiTarget.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/remove-azdiskpooliscsitarget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Remove-AzDiskPoolIscsiTarget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Remove-AzDiskPoolIscsiTarget.md +--- + +# Remove-AzDiskPoolIscsiTarget + +## SYNOPSIS +Delete an iSCSI Target. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDiskPoolIscsiTarget -DiskPoolName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDiskPoolIscsiTarget -InputObject <IDiskPoolIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete an iSCSI Target. + +## EXAMPLES + +### Example 1: Remove an iSCSI target +```powershell +Remove-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5' -Name 'target0' +``` + +This command removes an iSCSI target. + +### Example 2: Remove an iSCSI target by object +```powershell +Get-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5' -Name 'target0' | Remove-AzDiskPoolIscsiTarget +``` + +This command removes an iSCSI target by object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskPoolName +The name of the Disk Pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the iSCSI Target. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: IscsiTargetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IDiskPoolIdentity>`: Identity Parameter + - `[DiskPoolName <String>]`: The name of the Disk Pool. + - `[Id <String>]`: Resource identity path + - `[IscsiTargetName <String>]`: The name of the iSCSI Target. + - `[Location <String>]`: The location of the resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/Start-AzDiskPool.md b/azps-10.1.0/Az.DiskPool/Start-AzDiskPool.md new file mode 100644 index 0000000000..2184992f7a --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/Start-AzDiskPool.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/start-azdiskpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Start-AzDiskPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Start-AzDiskPool.md +--- + +# Start-AzDiskPool + +## SYNOPSIS +The operation to start a Disk Pool. +This start operation can take 10 minutes to complete. +This is expected service behavior. + +## SYNTAX + +### Start (Default) +``` +Start-AzDiskPool -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzDiskPool -InputObject <IDiskPoolIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to start a Disk Pool. +This start operation can take 10 minutes to complete. +This is expected service behavior. + +## EXAMPLES + +### Example 1: Start a Disk Pool +```powershell +Start-AzDiskPool -DiskPoolName 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' +``` + +This command starts a Disk Pool. + +### Example 2: Start a Disk Pool by object +```powershell +Get-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' | Start-AzDiskPool +``` + +This command starts a Disk Pool by object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Disk Pool. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: DiskPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IDiskPoolIdentity>`: Identity Parameter + - `[DiskPoolName <String>]`: The name of the Disk Pool. + - `[Id <String>]`: Resource identity path + - `[IscsiTargetName <String>]`: The name of the iSCSI Target. + - `[Location <String>]`: The location of the resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/Stop-AzDiskPool.md b/azps-10.1.0/Az.DiskPool/Stop-AzDiskPool.md new file mode 100644 index 0000000000..a25d78f798 --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/Stop-AzDiskPool.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/stop-azdiskpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Stop-AzDiskPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Stop-AzDiskPool.md +--- + +# Stop-AzDiskPool + +## SYNOPSIS +Shuts down the Disk Pool and releases the compute resources. +You are not billed for the compute resources that this Disk Pool uses. +This operation can take 10 minutes to complete. +This is expected service behavior. + +## SYNTAX + +### Deallocate (Default) +``` +Stop-AzDiskPool -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeallocateViaIdentity +``` +Stop-AzDiskPool -InputObject <IDiskPoolIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Shuts down the Disk Pool and releases the compute resources. +You are not billed for the compute resources that this Disk Pool uses. +This operation can take 10 minutes to complete. +This is expected service behavior. + +## EXAMPLES + +### Example 1: Stop a Disk Pool +```powershell +Stop-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' +``` + +This command deallocates a Disk Pool. + +### Example 2: Stop a Disk Pool by object +```powershell +Get-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' | Stop-AzDiskPool +``` + +This command deallocates a Disk Pool by object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity +Parameter Sets: DeallocateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Disk Pool. + +```yaml +Type: System.String +Parameter Sets: Deallocate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Deallocate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Deallocate +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IDiskPoolIdentity>`: Identity Parameter + - `[DiskPoolName <String>]`: The name of the Disk Pool. + - `[Id <String>]`: Resource identity path + - `[IscsiTargetName <String>]`: The name of the iSCSI Target. + - `[Location <String>]`: The location of the resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/Update-AzDiskPool.md b/azps-10.1.0/Az.DiskPool/Update-AzDiskPool.md new file mode 100644 index 0000000000..60a36c4324 --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/Update-AzDiskPool.md @@ -0,0 +1,323 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/update-azdiskpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Update-AzDiskPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Update-AzDiskPool.md +--- + +# Update-AzDiskPool + +## SYNOPSIS +Update a Disk pool. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDiskPool -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-DiskId <String[]>] + [-ManagedBy <String>] [-ManagedByExtended <String[]>] [-SkuName <String>] [-SkuTier <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDiskPool -InputObject <IDiskPoolIdentity> [-DiskId <String[]>] [-ManagedBy <String>] + [-ManagedByExtended <String[]>] [-SkuName <String>] [-SkuTier <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a Disk pool. + +## EXAMPLES + +### Example 1: Update a Disk Pool +```powershell +Update-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' -DiskId @() +``` + +```output +Name Location Status ProvisioningState AvailabilityZone +---- -------- ------ ----------------- ---------------- +disk-pool-1 eastus2euap Running Succeeded {3} +``` + +This command updates a Disk Pool. + +### Example 2: Update a Disk Pool by object +```powershell +Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test' -Name 'disk-pool-1' | Update-AzDiskPool -DiskId @() +``` + +```output +Name Location Status ProvisioningState AvailabilityZone +---- -------- ------ ----------------- ---------------- +disk-pool-1 eastus2euap Running Succeeded {3} +``` + +This command updates a Disk Pool by object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskId +List of Azure Managed Disks to attach to a Disk Pool. +To construct, see NOTES section for DISK properties and create a hash table. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagedBy +Azure resource id. +Indicates if this resource is managed by another Azure resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedByExtended +List of Azure resource ids that manage this resource. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Disk Pool. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: DiskPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Sku name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +Sku tier + +```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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IDiskPool + +## 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 `<IDiskPoolIdentity>`: Identity Parameter + - `[DiskPoolName <String>]`: The name of the Disk Pool. + - `[Id <String>]`: Resource identity path + - `[IscsiTargetName <String>]`: The name of the iSCSI Target. + - `[Location <String>]`: The location of the resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DiskPool/Update-AzDiskPoolIscsiTarget.md b/azps-10.1.0/Az.DiskPool/Update-AzDiskPoolIscsiTarget.md new file mode 100644 index 0000000000..5d1297096c --- /dev/null +++ b/azps-10.1.0/Az.DiskPool/Update-AzDiskPoolIscsiTarget.md @@ -0,0 +1,320 @@ +--- +external help file: +Module Name: Az.DiskPool +online version: https://learn.microsoft.com/powershell/module/az.diskpool/update-azdiskpooliscsitarget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Update-AzDiskPoolIscsiTarget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DiskPool/help/Update-AzDiskPoolIscsiTarget.md +--- + +# Update-AzDiskPoolIscsiTarget + +## SYNOPSIS +Update an iSCSI Target. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDiskPoolIscsiTarget -DiskPoolName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Lun <IIscsiLun[]>] [-ManagedBy <String>] [-ManagedByExtended <String[]>] + [-StaticAcl <IAcl[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDiskPoolIscsiTarget -InputObject <IDiskPoolIdentity> [-Lun <IIscsiLun[]>] [-ManagedBy <String>] + [-ManagedByExtended <String[]>] [-StaticAcl <IAcl[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update an iSCSI Target. + +## EXAMPLES + +### Example 1: Update an iSCSI target +```powershell +$lun0 = New-AzDiskPoolIscsiLunObject -ManagedDiskAzureResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Compute/disks/disk1" -Name "lun0" +Update-AzDiskPoolIscsiTarget -Name 'target0' -DiskPoolName 'disk-pool-5' -ResourceGroupName 'storagepool-rg-test' -Lun @($lun0) +``` + +```output +Name Type +---- ---- +target0 Microsoft.StoragePool/diskPools/iscsiTargets +``` + +This command updates an iSCSI target. + +### Example 2: Update an iSCSI target by object +```powershell +$lun0 = New-AzDiskPoolIscsiLunObject -ManagedDiskAzureResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Compute/disks/disk1" -Name "lun0" +Get-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5' -Name 'target0' | Update-AzDiskPoolIscsiTarget -Lun @($lun0) +``` + +```output +Name Type +---- ---- +target0 Microsoft.StoragePool/diskPools/iscsiTargets +``` + +This command updates an iSCSI target by object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskPoolName +The name of the Disk Pool. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Lun +List of LUNs to be exposed through iSCSI Target. +To construct, see NOTES section for LUN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IIscsiLun[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedBy +Azure resource id. +Indicates if this resource is managed by another Azure resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedByExtended +List of Azure resource ids that manage this resource. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the iSCSI Target. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: IscsiTargetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticAcl +Access Control List (ACL) for an iSCSI Target; defines LUN masking policy +To construct, see NOTES section for STATICACL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IAcl[] +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.IDiskPoolIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DiskPool.Models.Api20210801.IIscsiTarget + +## 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 `<IDiskPoolIdentity>`: Identity Parameter + - `[DiskPoolName <String>]`: The name of the Disk Pool. + - `[Id <String>]`: Resource identity path + - `[IscsiTargetName <String>]`: The name of the iSCSI Target. + - `[Location <String>]`: The location of the resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +LUN <IIscsiLun[]>: List of LUNs to be exposed through iSCSI Target. + - `ManagedDiskAzureResourceId <String>`: Azure Resource ID of the Managed Disk. + - `Name <String>`: User defined name for iSCSI LUN; example: "lun0" + +STATICACL <IAcl[]>: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy + - `InitiatorIqn <String>`: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". + - `MappedLun <String[]>`: List of LUN names mapped to the ACL. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Dns/Add-AzDnsRecordConfig.md b/azps-10.1.0/Az.Dns/Add-AzDnsRecordConfig.md new file mode 100644 index 0000000000..84150bd055 --- /dev/null +++ b/azps-10.1.0/Az.Dns/Add-AzDnsRecordConfig.md @@ -0,0 +1,469 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml +Module Name: Az.Dns +ms.assetid: CD119EBE-E1A4-4E9D-B3BA-FDAF89BF0DDB +online version: https://learn.microsoft.com/powershell/module/az.dns/add-azdnsrecordconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Add-AzDnsRecordConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Add-AzDnsRecordConfig.md +--- + +# Add-AzDnsRecordConfig + +## SYNOPSIS +Adds a DNS record to a local record set object. + +## SYNTAX + +### A +``` +Add-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Ipv4Address <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AAAA +``` +Add-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Ipv6Address <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NS +``` +Add-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Nsdname <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### MX +``` +Add-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Exchange <String> -Preference <UInt16> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PTR +``` +Add-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Ptrdname <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### TXT +``` +Add-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Value <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SRV +``` +Add-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Priority <UInt16> -Target <String> -Port <UInt16> + -Weight <UInt16> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### CNAME +``` +Add-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Cname <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### Caa +``` +Add-AzDnsRecordConfig -RecordSet <DnsRecordSet> -CaaFlags <Byte> -CaaTag <String> -CaaValue <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzDnsRecordConfig** cmdlet adds a Domain Name System (DNS) record to a **RecordSet** object. +The **RecordSet** object is an offline object, and changes to it do not change the DNS responses until after you run the Set-AzDnsRecordSet cmdlet to persist the change to the Microsoft Azure DNS service. +SOA records are created when a DNS zone is created, and are removed when the DNS zone is deleted. +You cannot add or remove SOA records, but you can edit them. +You can pass the **RecordSet** object to this cmdlet as a parameter or by using the pipeline operator. + +## EXAMPLES + +### Example 1: Add an A record to a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name www -RecordType A -ResourceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 +Set-AzDnsRecordSet -RecordSet $RecordSet + +# You can also pipe the above sequence: + +Get-AzDnsRecordSet -Name www -RecordType A -ResourceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzDnsRecordSet +``` + +This example adds an A record to an existing record set. + +### Example 2: Add an AAAA record to a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name www -RecordType AAAA -ResourceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 +Set-AzDnsRecordSet -RecordSet $RecordSet + +# You can also pipe the above sequence: + +Get-AzDnsRecordSet -Name www -RecordType AAAA -ResourceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzDnsRecordSet +``` + +This example adds an AAAA record to an existing record set. + +### Example 3: Add a CNAME record to a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name www -RecordType CNAME -ResourceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com +Set-AzDnsRecordSet -RecordSet $RecordSet + +# You can also pipe the above sequence: + +Get-AzDnsRecordSet -Name www -RecordType CNAME -ResourceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Cname contoso.com | Set-AzDnsRecordSet +``` + +This example adds a CNAME record to an existing record set. +Because a CNAME record set can contain at most one record, it must initially be an empty record set, or existing records must be removed using Remove-AzDnsRecordConfig. + +### Example 4: Add an MX record to a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "@" -RecordType MX -ResourceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet +Set-AzDnsRecordSet -RecordSet $RecordSet + +# You can also pipe the above sequence: + +Get-AzDnsRecordSet -Name "@" -RecordType MX -ResourceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzDnsRecordSet +``` + +This example adds an MX record to an existing record set. +The record name "@" indicates a record set at the zone apex. + +### Example 5: Add an NS record to a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name abc -RecordType NS -ResourceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -Nsdname ns1.myzone.com -RecordSet $RecordSet +Set-AzDnsRecordSet -RecordSet $RecordSet + +# You can also pipe the above sequence: + +Get-AzDnsRecordSet -Name abc -RecordType NS -ResourceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Nsdname ns1.myzone.com | Set-AzDnsRecordSet +``` + +This example adds an NS record to an existing record set. + +### Example 6: Add a PTR record to a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name 4 -RecordType PTR -ResourceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa +Add-AzDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet +Set-AzDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzDnsRecordSet -Name 4 -RecordType PTR -ResourceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa | Add-AzDnsRecordConfig -Ptrdname www.contoso.com | Set-AzDnsRecordSet +``` + +This example adds a PTR record to an existing record set. + +### Example 7: Add an SRV record to a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name _sip._tcp -RecordType SRV -ResourceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -RecordSet $RecordSet -Priority 0 -Weight 5 -Port 8080 -Target target.example.com +Set-AzDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzDnsRecordSet -Name _sip._tcp -RecordType SRV -ResourceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzDnsRecordSet +``` + +This example adds an SRV record to an existing record set. + +### Example 8: Add a TXT record to a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name text -RecordType TXT -ResourceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" +Set-AzDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzDnsRecordSet -Name text -RecordType TXT -ResourceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Value "This is a TXT Record" | Set-AzDnsRecordSet +``` + +This example adds a TXT record to an existing record set. + +## PARAMETERS + +### -CaaFlags +The flags for the CAA record to add. Must be a number between 0 and 255. + +```yaml +Type: System.Byte +Parameter Sets: Caa +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CaaTag +The tag field of the CAA record to add. + +```yaml +Type: System.String +Parameter Sets: Caa +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CaaValue +The value field for the CAA record to add. + +```yaml +Type: System.String +Parameter Sets: Caa +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Cname +Specifies the domain name for a canonical name (CNAME) record. + +```yaml +Type: System.String +Parameter Sets: CNAME +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exchange +Specifies the mail exchange server name for a mail exchange (MX) record. + +```yaml +Type: System.String +Parameter Sets: MX +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Ipv4Address +Specifies an IPv4 address for an A record. + +```yaml +Type: System.String +Parameter Sets: A +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Ipv6Address +Specifies an IPv6 address for an AAAA record. + +```yaml +Type: System.String +Parameter Sets: AAAA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Nsdname +Specifies the name server name for a name server (NS) record. + +```yaml +Type: System.String +Parameter Sets: NS +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Port +Specifies the port for a service (SRV) record. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Preference +Specifies the preference for an MX record. + +```yaml +Type: System.UInt16 +Parameter Sets: MX +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Priority +Specifies the priority for an SRV record. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Ptrdname +Specifies the target domain name of a pointer resource (PTR) record. + +```yaml +Type: System.String +Parameter Sets: PTR +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecordSet +Specifies the **RecordSet** object to edit. + +```yaml +Type: Microsoft.Azure.Commands.Dns.DnsRecordSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Target +Specifies the target for an SRV record. + +```yaml +Type: System.String +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Specifies the value for a TXT record. + +```yaml +Type: System.String +Parameter Sets: TXT +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Weight +Specifies the weight for an SRV record. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Dns.DnsRecordSet + +### System.String + +### System.UInt16 + +### System.Byte + +## OUTPUTS + +### Microsoft.Azure.Commands.Dns.DnsRecordSet + +## NOTES + +## RELATED LINKS + +[Get-AzDnsRecordSet](./Get-AzDnsRecordSet.md) + +[Remove-AzDnsRecordConfig](./Remove-AzDnsRecordConfig.md) + +[Set-AzDnsRecordSet](./Set-AzDnsRecordSet.md) diff --git a/azps-10.1.0/Az.Dns/Az.DNS.md b/azps-10.1.0/Az.Dns/Az.DNS.md new file mode 100644 index 0000000000..03ea35c5ee --- /dev/null +++ b/azps-10.1.0/Az.Dns/Az.DNS.md @@ -0,0 +1,48 @@ +--- +Module Name: Az.Dns +Module Guid: 5e5ed8bc-27bf-4380-9de1-4b22ba0920b2 +Download Help Link: https://learn.microsoft.com/powershell/module/az.dns +Help Version: 4.1.2.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Az.DNS.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Az.DNS.md +--- + +# Az.Dns Module +## Description +This topic displays help topics for the Azure DNS Cmdlets. + +## Az.Dns Cmdlets +### [Add-AzDnsRecordConfig](Add-AzDnsRecordConfig.md) +Adds a DNS record to a local record set object. + +### [Get-AzDnsRecordSet](Get-AzDnsRecordSet.md) +Gets a DNS record set. + +### [Get-AzDnsZone](Get-AzDnsZone.md) +Gets a DNS zone. + +### [New-AzDnsRecordConfig](New-AzDnsRecordConfig.md) +Creates a new DNS record local object. + +### [New-AzDnsRecordSet](New-AzDnsRecordSet.md) +Creates a DNS record set. + +### [New-AzDnsZone](New-AzDnsZone.md) +Creates a new DNS zone. + +### [Remove-AzDnsRecordConfig](Remove-AzDnsRecordConfig.md) +Removes a DNS record from a local record set object. + +### [Remove-AzDnsRecordSet](Remove-AzDnsRecordSet.md) +Deletes a record set. + +### [Remove-AzDnsZone](Remove-AzDnsZone.md) +Removes a DNS zone from a resource group. + +### [Set-AzDnsRecordSet](Set-AzDnsRecordSet.md) +Updates a DNS record set. + +### [Set-AzDnsZone](Set-AzDnsZone.md) +Updates the properties of a DNS zone. + diff --git a/azps-10.1.0/Az.Dns/Get-AzDnsRecordSet.md b/azps-10.1.0/Az.Dns/Get-AzDnsRecordSet.md new file mode 100644 index 0000000000..357377a70f --- /dev/null +++ b/azps-10.1.0/Az.Dns/Get-AzDnsRecordSet.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml +Module Name: Az.Dns +ms.assetid: 40179CF3-7896-4C45-BC18-4CB653B245B6 +online version: https://learn.microsoft.com/powershell/module/az.dns/get-azdnsrecordset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Get-AzDnsRecordSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Get-AzDnsRecordSet.md +--- + +# Get-AzDnsRecordSet + +## SYNOPSIS +Gets a DNS record set. + +## SYNTAX + +### Fields +``` +Get-AzDnsRecordSet [-Name <String>] -ZoneName <String> -ResourceGroupName <String> [-RecordType <RecordType>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Object +``` +Get-AzDnsRecordSet [-Name <String>] -Zone <DnsZone> [-RecordType <RecordType>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDnsRecordSet** cmdlet gets the Domain Name System (DNS) record set with the specified name and type, in the specified zone. +If you do not specify the *Name* or *RecordType* parameters, this cmdlet returns all record sets of the specified type in the zone. +If you specify the *RecordType* parameter but not the *Name* parameter, this cmdlet returns all record sets of the specified record type. +You can use the pipeline operator to pass a **DnsZone** object to this cmdlet, or you can pass a **DnsZone** object as the *Zone* parameter, or alternatively you can specify the zone and resource group by name. + +## EXAMPLES + +### Example 1: Get record sets with a specified name and type +```powershell +$RecordSet = Get-AzDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -Name "www" -RecordType A +``` + +This command gets the record set of record type A named www in the specified resource group and zone, and then stores it in the $RecordSet variable. +Because the *Name* and *RecordType* parameters are specified, only one **RecordSet** object is returned. + +### Example 2: Get record sets of a specified type +```powershell +$RecordSets = Get-AzDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -RecordType A +``` + +This command gets an array of all record sets of record type A in the zone named myzone.com in the resource group named MyResourceGroup, and then stores them in the $RecordSets variable. + +### Example 3: Get all record sets in a zone +```powershell +$RecordSets = Get-AzDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +``` + +This command gets an array of all record sets in the zone named myzone.com in the resource group named MyResourceGroup, and then stores them in the $RecordSets variable. + +### Example 4: Get all record sets in a zone, using a DnsZone object +```powershell +$Zone = Get-AzDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" +$RecordSets = Get-AzDnsRecordSet -Zone $Zone +``` + +This example is equivalent to Example 3 above. +This time, the zone is specified using a zone object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the **RecordSet** to get. +If you do not specify the *Name* parameter, all record sets of the specified type are returned. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: Object +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecordType +Specifies the type of DNS record that this cmdlet gets. +Valid values are: +- A +- AAAA +- CNAME +- MX +- NS +- PTR +- SOA +- SRV +- TXT +If you do not specify the *RecordType* parameter, you must also omit the *Name* parameter. +This cmdlet then returns all record sets in the zone (of all names and types). + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Dns.Models.RecordType] +Parameter Sets: (All) +Aliases: +Accepted values: A, AAAA, CAA, CNAME, MX, NS, PTR, SOA, SRV, TXT + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group that contains the DNS zone. +The zone name must also be specified, using the *ZoneName* parameter. +Alternatively, you can specify the zone and resource group by passing in a **DnsZone** object using the *Zone* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +Specifies the DNS zone that contains the record set that this cmdlet gets. +Alternatively, you can specify the zone using the *ZoneName* and *ResourceGroupName* parameters. + +```yaml +Type: Microsoft.Azure.Commands.Dns.DnsZone +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ZoneName +Specifies the name of the DNS zone that contains the record set to get. +The resource group containing the zone must also be specified, using the *ResourceGroupName* parameter. +Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the *Zone* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Dns.DnsZone + +### System.Nullable`1[[Microsoft.Azure.Management.Dns.Models.RecordType, Microsoft.Azure.Management.Dns, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Dns.DnsRecordSet + +## NOTES + +## RELATED LINKS + +[New-AzDnsRecordSet](./New-AzDnsRecordSet.md) + +[Remove-AzDnsRecordSet](./Remove-AzDnsRecordSet.md) + +[Set-AzDnsRecordSet](./Set-AzDnsRecordSet.md) + + diff --git a/azps-10.1.0/Az.Dns/Get-AzDnsZone.md b/azps-10.1.0/Az.Dns/Get-AzDnsZone.md new file mode 100644 index 0000000000..3a8d05499e --- /dev/null +++ b/azps-10.1.0/Az.Dns/Get-AzDnsZone.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml +Module Name: Az.Dns +ms.assetid: B831ABE6-348C-4DD6-9295-18D23A1FDF63 +online version: https://learn.microsoft.com/powershell/module/az.dns/get-azdnszone +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Get-AzDnsZone.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Get-AzDnsZone.md +--- + +# Get-AzDnsZone + +## SYNOPSIS +Gets a DNS zone. + +## SYNTAX + +### Default (Default) +``` +Get-AzDnsZone [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroup +``` +Get-AzDnsZone [-Name <String>] -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDnsZone** cmdlet gets a Domain Name System (DNS) zone from the specified resource group. +If you specify the *Name* parameter, a single **DnsZone** object is returned. +If you do not specify the *Name* parameter, an array containing all of the zones in the specified resource group is returned. +You can use the **DnsZone** object to update the zone, for example you can add **RecordSet** objects to it. + +## EXAMPLES + +### Example 1: Get a zone +```powershell +$Zone = Get-AzDnsZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com" +``` + +This example gets the DNS zone named myzone.com from the specified resource group, and then stores it in the $Zone variable. + +### Example 2: Get all of the zones in a resource group +```powershell +$Zones = Get-AzDnsZone -ResourceGroupName "MyResourceGroup" +``` + +This example gets all of the DNS zones in the specified resource group, and then stores it in the $Zones variable. + +### Example 3: Get all of the zones in a subscription +```powershell +$Zones = Get-AzDnsZone +``` + +This example gets all of the DNS zones in the current Azure subscription, and then stores them in the $Zones variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the DNS zone to get. +If you do not specify a value for the *Name* parameter, this cmdlet gets all DNS zones in the specified resource group. +If you also omit the *ResourceGroupName* parameter, this cmdlet gets all DNS zones in the current Azure subscription. + +```yaml +Type: System.String +Parameter Sets: ResourceGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the DNS zone to get. +If you do not specify the *ResourceGroupName*, then you must also omit the *Name* parameter. +In this case, this cmdlet gets all DNS zones in the current Azure subscription. + +```yaml +Type: System.String +Parameter Sets: ResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Dns.DnsZone + +## NOTES + +## RELATED LINKS + +[New-AzDnsZone](./New-AzDnsZone.md) + +[Remove-AzDnsZone](./Remove-AzDnsZone.md) + +[Set-AzDnsZone](./Set-AzDnsZone.md) diff --git a/azps-10.1.0/Az.Dns/New-AzDnsRecordConfig.md b/azps-10.1.0/Az.Dns/New-AzDnsRecordConfig.md new file mode 100644 index 0000000000..f8a760f719 --- /dev/null +++ b/azps-10.1.0/Az.Dns/New-AzDnsRecordConfig.md @@ -0,0 +1,445 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml +Module Name: Az.Dns +ms.assetid: AD97BCAF-69BA-4C16-8B57-AB243D796B71 +online version: https://learn.microsoft.com/powershell/module/az.dns/new-azdnsrecordconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/New-AzDnsRecordConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/New-AzDnsRecordConfig.md +--- + +# New-AzDnsRecordConfig + +## SYNOPSIS +Creates a new DNS record local object. + +## SYNTAX + +### A +``` +New-AzDnsRecordConfig -Ipv4Address <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Aaaa +``` +New-AzDnsRecordConfig -Ipv6Address <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Ns +``` +New-AzDnsRecordConfig -Nsdname <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Mx +``` +New-AzDnsRecordConfig -Exchange <String> -Preference <UInt16> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### Ptr +``` +New-AzDnsRecordConfig -Ptrdname <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Txt +``` +New-AzDnsRecordConfig -Value <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Srv +``` +New-AzDnsRecordConfig -Priority <UInt16> -Target <String> -Port <UInt16> -Weight <UInt16> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### CName +``` +New-AzDnsRecordConfig -Cname <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Caa +``` +New-AzDnsRecordConfig -CaaFlags <Byte> -CaaTag <String> -CaaValue <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDnsRecordConfig** cmdlet creates a local **DnsRecord** object. +An array of these objects is passed to the New-AzDnsRecordSet cmdlet using the *DnsRecords* parameter to specify the records to create in the record set. + +## EXAMPLES + +### Example 1: Create a RecordSet of type A +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -IPv4Address 1.2.3.4 +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records + +# When creating a RecordSet containing a single record, the above sequence can also be condensed into a single line: + +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzDnsRecordConfig -IPv4Address 1.2.3.4) + +# To create a record set containing multiple records, use New-AzDnsRecordConfig to add each record to the $Records array, +# then call New-AzDnsRecordSet, as follows: + +$Records = @() +$Records += New-AzDnsRecordConfig -IPv4Address 1.2.3.4 +$Records += New-AzDnsRecordConfig -IPv4Address 5.6.7.8 +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This example creates a **RecordSet** named www in the zone myzone.com. +The record set is of type A and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. + +### Example 2: Create a RecordSet of type AAAA +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Ipv6Address 2001:db8::1 +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This example creates a **RecordSet** named www in the zone myzone.com. +The record set is of type AAAA and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 3: Create a RecordSet of type CNAME +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Cname www.contoso.com +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This example creates a **RecordSet** named www in the zone myzone.com. +The record set is of type CNAME and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 4: Create a RecordSet of type MX +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This command creates a **RecordSet** named www in the zone myzone.com. +The record set is of type MX and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 5: Create a RecordSet of type NS +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Nsdname ns1-01.azure-dns.com +$RecordSet = New-AzDnsRecordSet -Name "ns1" -RecordType NS -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This command creates a **RecordSet** named ns1 in the zone myzone.com. +The record set is of type NS and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 6: Create a RecordSet of type PTR +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Ptrdname www.contoso.com +$RecordSet = New-AzDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" -DnsRecords $Records +``` + +This command creates a **RecordSet** named 4 in the zone 3.2.1.in-addr.arpa. +The record set is of type PTR and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 7: Create a RecordSet of type SRV +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com +$RecordSet = New-AzDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This command creates a **RecordSet** named _sip._tcp in the zone myzone.com. +The record set is of type SRV and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record, pointing to the IP address 2001.2.3.4. +The service (sip) and the protocol (tcp) are specified as part of the record set name, not as part of the record data. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 8: Create a RecordSet of type TXT +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Value "This is a TXT Record" +$RecordSet = New-AzDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This command creates a **RecordSet** named text in the zone myzone.com. +The record set is of type TXT and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +## PARAMETERS + +### -CaaFlags +The flags for the CAA record to add. Must be a number between 0 and 255. + +```yaml +Type: System.Byte +Parameter Sets: Caa +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CaaTag +The tag field of the CAA record to add. + +```yaml +Type: System.String +Parameter Sets: Caa +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CaaValue +The value field for the CAA record to add. + +```yaml +Type: System.String +Parameter Sets: Caa +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Cname +Specifies the domain name for a canonical name (CNAME) record. + +```yaml +Type: System.String +Parameter Sets: CName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exchange +Specifies the mail exchange server name for a mail exchange (MX) record. + +```yaml +Type: System.String +Parameter Sets: Mx +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Ipv4Address +Specifies an IPv4 address for an A record. + +```yaml +Type: System.String +Parameter Sets: A +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Ipv6Address +Specifies an IPv6 address for an AAAA record. + +```yaml +Type: System.String +Parameter Sets: Aaaa +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Nsdname +Specifies the name server name for a name server (NS) record. + +```yaml +Type: System.String +Parameter Sets: Ns +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Port +Specifies the port for a service (SRV) record. + +```yaml +Type: System.UInt16 +Parameter Sets: Srv +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Preference +Specifies the preference for an MX record. + +```yaml +Type: System.UInt16 +Parameter Sets: Mx +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Priority +Specifies the priority for an SRV record. + +```yaml +Type: System.UInt16 +Parameter Sets: Srv +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Ptrdname +Specifies the target domain name of a pointer resource (PTR) record. + +```yaml +Type: System.String +Parameter Sets: Ptr +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Target +Specifies the target for an SRV record. + +```yaml +Type: System.String +Parameter Sets: Srv +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Specifies the value for a TXT record. + +```yaml +Type: System.String +Parameter Sets: Txt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Weight +Specifies the weight for an SRV record. + +```yaml +Type: System.UInt16 +Parameter Sets: Srv +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.UInt16 + +### System.Byte + +## OUTPUTS + +### Microsoft.Azure.Commands.Dns.DnsRecordBase + +## NOTES + +## RELATED LINKS + +[Add-AzDnsRecordConfig](./Add-AzDnsRecordConfig.md) + +[New-AzDnsRecordSet](./New-AzDnsRecordSet.md) + +[Remove-AzDnsRecordConfig](./Remove-AzDnsRecordConfig.md) diff --git a/azps-10.1.0/Az.Dns/New-AzDnsRecordSet.md b/azps-10.1.0/Az.Dns/New-AzDnsRecordSet.md new file mode 100644 index 0000000000..8c31ae17b6 --- /dev/null +++ b/azps-10.1.0/Az.Dns/New-AzDnsRecordSet.md @@ -0,0 +1,474 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml +Module Name: Az.Dns +ms.assetid: 45DF71E0-77E1-4D20-AD09-2C06680F659F +online version: https://learn.microsoft.com/powershell/module/az.dns/new-azdnsrecordset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/New-AzDnsRecordSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/New-AzDnsRecordSet.md +--- + +# New-AzDnsRecordSet + +## SYNOPSIS +Creates a DNS record set. + +## SYNTAX + +### Fields (Default) +``` +New-AzDnsRecordSet -Name <String> -ZoneName <String> -ResourceGroupName <String> -Ttl <UInt32> + -RecordType <RecordType> [-Metadata <Hashtable>] [-DnsRecords <DnsRecordBase[]>] [-Overwrite] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AliasFields +``` +New-AzDnsRecordSet -Name <String> -ZoneName <String> -ResourceGroupName <String> [-Ttl <UInt32>] + -RecordType <RecordType> -TargetResourceId <String> [-Metadata <Hashtable>] [-DnsRecords <DnsRecordBase[]>] + [-Overwrite] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Object +``` +New-AzDnsRecordSet -Name <String> -Zone <DnsZone> -Ttl <UInt32> -RecordType <RecordType> + [-Metadata <Hashtable>] [-DnsRecords <DnsRecordBase[]>] [-Overwrite] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AliasObject +``` +New-AzDnsRecordSet -Name <String> -Zone <DnsZone> [-Ttl <UInt32>] -RecordType <RecordType> + -TargetResourceId <String> [-Metadata <Hashtable>] [-DnsRecords <DnsRecordBase[]>] [-Overwrite] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDnsRecordSet** cmdlet creates a new Domain Name System (DNS) record set with the specified name and type in the specified zone. +A **RecordSet** object is a set of DNS records with the same name and type. +Note that the name is relative to the zone and not the fully qualified name. +The *DnsRecords* parameter specifies the records in the record set. +This parameter takes an array of DNS records, constructed using New-AzDnsRecordConfig. +You can use the pipeline operator to pass a **DnsZone** object to this cmdlet, or you can pass a **DnsZone** object as the *Zone* parameter, or alternatively you can specify the zone by name. +You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. +If a matching **RecordSet** already exists (same name and record type), you must specify the *Overwrite* parameter, otherwise the cmdlet will not create a new **RecordSet** . + +## EXAMPLES + +### Example 1: Create a RecordSet of type A +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -IPv4Address 1.2.3.4 +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records + +# When creating a RecordSet containing a single record, the above sequence can also be condensed into a single line: + +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzDnsRecordConfig -IPv4Address 1.2.3.4) + +# To create a record set containing multiple records, use New-AzDnsRecordConfig to add each record to the $Records array, +# then call New-AzDnsRecordSet, as follows: + +$Records = @() +$Records += New-AzDnsRecordConfig -IPv4Address 1.2.3.4 +$Records += New-AzDnsRecordConfig -IPv4Address 5.6.7.8 +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This example creates a **RecordSet** named www in the zone myzone.com. +The record set is of type A and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. + +### Example 2: Create a RecordSet of type AAAA +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Ipv6Address 2001:db8::1 +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This example creates a **RecordSet** named www in the zone myzone.com. +The record set is of type AAAA and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 3: Create a RecordSet of type CNAME +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Cname www.contoso.com +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This example creates a **RecordSet** named www in the zone myzone.com. +The record set is of type CNAME and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 4: Create a RecordSet of type MX +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 +$RecordSet = New-AzDnsRecordSet -Name "mail" -RecordType MX -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This command creates a **RecordSet** named www in the zone myzone.com. +The record set is of type MX and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 5: Create a RecordSet of type NS +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Nsdname ns1-01.azure-dns.com +$RecordSet = New-AzDnsRecordSet -Name "ns1" -RecordType NS -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This command creates a **RecordSet** named ns1 in the zone myzone.com. +The record set is of type NS and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 6: Create a RecordSet of type PTR +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Ptrdname www.contoso.com +$RecordSet = New-AzDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" -DnsRecords $Records +``` + +This command creates a **RecordSet** named 4 in the zone 3.2.1.in-addr.arpa. +The record set is of type PTR and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 7: Create a RecordSet of type SRV +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com +$RecordSet = New-AzDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This command creates a **RecordSet** named _sip._tcp in the zone myzone.com. +The record set is of type SRV and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record, pointing to the IP address 2001.2.3.4. +The service (sip) and the protocol (tcp) are specified as part of the record set name, not as part of the record data. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 8: Create a RecordSet of type TXT +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Value "This is a TXT Record" +$RecordSet = New-AzDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This command creates a **RecordSet** named text in the zone myzone.com. +The record set is of type TXT and has a TTL of 1 hour (3600 seconds). +It contains a single DNS record. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 9: Create a RecordSet at the zone apex +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Ipv4Address 1.2.3.4 +$RecordSet = New-AzDnsRecordSet -Name "@" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This command creates a **RecordSet** at the apex (or root) of the zone myzone.com. +To do this, the record set name is specified as "@" (including the double-quotes). +You cannot create CNAME records at the apex of a zone. +This is a constraint of the DNS standards; it is not a limitation of Azure DNS. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 10: Create a wildcard Record Set +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Ipv4Address 1.2.3.4 +$RecordSet = New-AzDnsRecordSet -Name "*" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +``` + +This command creates a **RecordSet** named * in the zone myzone.com. +This is a wildcard record set. +To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 11: Create an empty record set +```powershell +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords @() +``` + +This command creates a **RecordSet** named www in the zone myzone.com. +The record set is of type A and has a TTL of 1 hour (3600 seconds). +This is an empty record set, which acts as a placeholder to which you can later add records. + +### Example 12: Create a record set and suppress all confirmation +```powershell +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzDnsRecordConfig -Ipv4Address 1.2.3.4) -Confirm:$False -Overwrite +``` + +This command creates a **RecordSet**. +The *Overwrite* parameter ensures that this record set overwrites any pre-existing record set with the same name and type (existing records in that record set are lost). +The *Confirm* parameter with a value of $False suppresses the confirmation prompt. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsRecords +Specifies the array of DNS records to include in the record set. +You can use the New-AzDnsRecordConfig cmdlet to create DNS record objects. +See the examples for more information. + +```yaml +Type: Microsoft.Azure.Commands.Dns.DnsRecordBase[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Metadata +Specifies an array of metadata to associate with the RecordSet. +Metadata is specified using name-value pairs that are represented as hash tables, for example @{"dept"="shopping";"env"="production"}. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the **RecordSet** to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Overwrite +Indicates that this cmdlet overwrites the specified **RecordSet** if it already exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordType +Specifies the type of DNS record to create. +Valid values are: +- A +- AAAA +- CNAME +- MX +- NS +- PTR +- SRV +- TXT +SOA records are created automatically when the zone is created and cannot be created manually. + +```yaml +Type: Microsoft.Azure.Management.Dns.Models.RecordType +Parameter Sets: (All) +Aliases: +Accepted values: A, AAAA, CAA, CNAME, MX, NS, PTR, SOA, SRV, TXT + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group that contains the DNS zone. +You must also specify the *ZoneName* parameter to specify the zone name. +Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the *Zone* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields, AliasFields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceId +Alias Target Resource Id. + +```yaml +Type: System.String +Parameter Sets: AliasFields, AliasObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ttl +Specifies the Time to Live (TTL) for the DNS RecordSet. + +```yaml +Type: System.UInt32 +Parameter Sets: Fields, Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.UInt32 +Parameter Sets: AliasFields, AliasObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +Specifies the DnsZone in which to create the **RecordSet**. +Alternatively, you can specify the zone using the *ZoneName* and *ResourceGroupName* parameters. + +```yaml +Type: Microsoft.Azure.Commands.Dns.DnsZone +Parameter Sets: Object, AliasObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ZoneName +Specifies the name of the zone in which to create the **RecordSet**. +You must also specify the resource group containing the zone using the *ResourceGroupName* parameter. +Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the *Zone* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields, AliasFields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Dns.DnsZone + +### System.UInt32 + +### Microsoft.Azure.Management.Dns.Models.RecordType + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Dns.DnsRecordBase[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Dns.DnsRecordSet + +## NOTES +You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. +By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. +If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. +If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. + +## RELATED LINKS + +[Add-AzDnsRecordConfig](./Add-AzDnsRecordConfig.md) + +[Get-AzDnsRecordSet](./Get-AzDnsRecordSet.md) + +[New-AzDnsRecordConfig](./New-AzDnsRecordConfig.md) + +[Remove-AzDnsRecordSet](./Remove-AzDnsRecordSet.md) + +[Set-AzDnsRecordSet](./Set-AzDnsRecordSet.md) diff --git a/azps-10.1.0/Az.Dns/New-AzDnsZone.md b/azps-10.1.0/Az.Dns/New-AzDnsZone.md new file mode 100644 index 0000000000..eaef2c9442 --- /dev/null +++ b/azps-10.1.0/Az.Dns/New-AzDnsZone.md @@ -0,0 +1,351 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml +Module Name: Az.Dns +ms.assetid: B78F3E8B-C7D2-458C-AB23-06F584FE97E0 +online version: https://learn.microsoft.com/powershell/module/az.dns/new-azdnszone +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/New-AzDnsZone.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/New-AzDnsZone.md +--- + +# New-AzDnsZone + +## SYNOPSIS +Creates a new DNS zone. + +## SYNTAX + +### Ids (Default) +``` +New-AzDnsZone -Name <String> -ResourceGroupName <String> [-ZoneType <ZoneType>] [-ParentZoneId <String>] + [-Tag <Hashtable>] [-RegistrationVirtualNetworkId <System.Collections.Generic.List`1[System.String]>] + [-ResolutionVirtualNetworkId <System.Collections.Generic.List`1[System.String]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Names +``` +New-AzDnsZone -Name <String> -ResourceGroupName <String> [-ZoneType <ZoneType>] [-ParentZoneName <String>] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Objects +``` +New-AzDnsZone -Name <String> -ResourceGroupName <String> [-ZoneType <ZoneType>] [-ParentZone <DnsZone>] + [-Tag <Hashtable>] + [-RegistrationVirtualNetwork <System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference]>] + [-ResolutionVirtualNetwork <System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDnsZone** cmdlet creates a new Domain Name System (DNS) zone in the specified +resource group. You must specify a unique DNS zone name for the *Name* parameter or the cmdlet will +return an error. After the zone is created, use the New-AzDnsRecordSet cmdlet to create record +sets in the zone. +You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control +whether the cmdlet prompts you for confirmation. + +## EXAMPLES + +### Example 1: Create a DNS zone +```powershell +$Zone = New-AzDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" +``` + +This command creates a new DNS zone named myzone.com in the specified resource group, and then +stores it in the $Zone variable. + +### Example 2: Create a Private DNS zone by specifying virtual network IDs +```powershell +$ResVirtualNetworkId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testresgroup/providers/Microsoft.Network/virtualNetworks/resvnet" +$Zone = New-AzDnsZone -Name "myprivatezone.com" -ResourceGroupName "MyResourceGroup" -ZoneType Private -ResolutionVirtualNetworkId @($ResVirtualNetworkId) +``` + +This command creates a new Private DNS zone named myprivatezone.com in the specified resource group with +an associated resolution virtual network (specifying its ID), and then stores it in the $Zone variable. + +### Example 3: Create a Private DNS zone by specifying virtual network objects +```powershell +$ResVirtualNetwork = Get-AzVirtualNetwork -Name "resvnet" -ResourceGroupName "testresgroup" +$Zone = New-AzDnsZone -Name "myprivatezone.com" -ResourceGroupName "MyResourceGroup" -ZoneType Private -ResolutionVirtualNetwork @($ResVirtualNetwork) +``` + +This command creates a new Private DNS zone named myprivatezone.com in the specified resource group with +an associated resolution virtual network (referred to by $ResVirtualNetwork variable), and then stores it +in the $Zone variable. + +### Example 4: Create a DNS zone with delegation by specifying parent zone name +```powershell +$Zone = New-AzDnsZone -Name "mychild.zone.com" -ResourceGroupName "MyResourceGroup" -ParentZoneName "zone.com" +``` + +This command creates a new child DNS zone named mychild.zone.com in the specified resource group and stores +in the $Zone variable. +It also adds delegation in the parent DNS zone named zone.com residing in the same subscription and resource group as child zone. + +### Example 5: Create a DNS zone with delegation by specifying parent zone id +```powershell +$Zone = New-AzDnsZone -Name "mychild.zone.com" -ResourceGroupName "MyResourceGroup" -ParentZoneId "/subscriptions/**67e2/resourceGroups/other-rg/providers/Microsoft.Network/dnszones/zone.com" +``` + +This command creates a new child DNS zone named mychild.zone.com in the specified resource group and stores +in the $Zone variable. +It also adds delegation in the parent DNS zone named zone.com in resource group other-rg provided subscription is same as that of child zone created. + +### Example 6: Create a DNS zone with delegation by specifying parent zone object +```powershell +$PZone = New-AzDnsZone -Name "zone.com" -ResourceGroupName "MyResourceGroup" +$Zone = New-AzDnsZone -Name "mychild.zone.com" -ResourceGroupName "MyResourceGroup" -ParentZone @($PZone) +``` + +This command creates a new child DNS zone named mychild.zone.com in the specified resource group and stores +in the $Zone variable. +It also adds delegation in the parent DNS zone named zone.com as passed in the ParentZone object + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the DNS zone to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentZone +The full name of the parent zone to add delegation (without a terminating dot). + +```yaml +Type: Microsoft.Azure.Commands.Dns.DnsZone +Parameter Sets: Objects +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentZoneId +The resource id of the parent zone to add delegation (without a terminating dot). + +```yaml +Type: System.String +Parameter Sets: Ids +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentZoneName +The full name of the parent zone to add delegation (without a terminating dot). + +```yaml +Type: System.String +Parameter Sets: Names +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RegistrationVirtualNetwork +The list of virtual networks that will register virtual machine hostnames records in this DNS zone, only available for private zones. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference] +Parameter Sets: Objects +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RegistrationVirtualNetworkId +The list of virtual network IDs that will register virtual machine hostnames records in this DNS zone, only available for private zones. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: Ids +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResolutionVirtualNetwork +The list of virtual networks able to resolve records in this DNS zone, only available for private zones. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference] +Parameter Sets: Objects +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResolutionVirtualNetworkId +The list of virtual network IDs able to resolve records in this DNS zone, only available for private zones. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: Ids +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group in which to create the zone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ZoneType +The type of the zone, Public or Private. Zones without a type or with a type of Public are made available on the public DNS serving plane for use in the DNS hierarchy. Zones with a type of Private are only visible from with the set of associated virtual networks (this feature is in preview). This property cannot be changed for a zone. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Dns.Models.ZoneType] +Parameter Sets: (All) +Aliases: +Accepted values: Public, Private + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Management.Dns.Models.ZoneType, Microsoft.Azure.Management.Dns, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.Collections.Hashtable + +### System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference, Microsoft.Azure.PowerShell.Clients.Network, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Dns.DnsZone + +## NOTES +You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. +By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. +If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. +If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. + +## RELATED LINKS + +[Get-AzDnsZone](./Get-AzDnsZone.md) + +[New-AzDnsRecordSet](./New-AzDnsRecordSet.md) + +[Remove-AzDnsZone](./Remove-AzDnsZone.md) diff --git a/azps-10.1.0/Az.Dns/Remove-AzDnsRecordConfig.md b/azps-10.1.0/Az.Dns/Remove-AzDnsRecordConfig.md new file mode 100644 index 0000000000..c3328c9d1f --- /dev/null +++ b/azps-10.1.0/Az.Dns/Remove-AzDnsRecordConfig.md @@ -0,0 +1,484 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml +Module Name: Az.Dns +ms.assetid: D1A2326C-CD41-45A6-B37A-FC6176193B01 +online version: https://learn.microsoft.com/powershell/module/az.dns/remove-azdnsrecordconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Remove-AzDnsRecordConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Remove-AzDnsRecordConfig.md +--- + +# Remove-AzDnsRecordConfig + +## SYNOPSIS +Removes a DNS record from a local record set object. + +## SYNTAX + +### A +``` +Remove-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Ipv4Address <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AAAA +``` +Remove-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Ipv6Address <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NS +``` +Remove-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Nsdname <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### MX +``` +Remove-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Exchange <String> -Preference <UInt16> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PTR +``` +Remove-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Ptrdname <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### TXT +``` +Remove-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Value <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SRV +``` +Remove-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Priority <UInt16> -Target <String> -Port <UInt16> + -Weight <UInt16> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### CNAME +``` +Remove-AzDnsRecordConfig -RecordSet <DnsRecordSet> -Cname <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### Caa +``` +Remove-AzDnsRecordConfig -RecordSet <DnsRecordSet> -CaaFlags <Byte> -CaaTag <String> -CaaValue <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDnsRecordConfig** cmdlet removes a Domain Name System (DNS) record from a record set. +The **RecordSet** object is an offline object, and changes to it do not change the DNS responses until after you run the Set-AzDnsRecordSet cmdlet to persist the change to the Microsoft Azure DNS service. +To remove a record, all the fields for that record type must match exactly. +You cannot add or remove SOA records. +SOA records are automatically created when a DNS zone is created and automatically deleted when the DNS zone is deleted. +You can pass the **RecordSet** object to this cmdlet as a parameter or by using the pipeline operator. + +## EXAMPLES + +### Example 1: Remove an A record from a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 +Set-AzDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzDnsRecordSet +``` + +This example removes an A record from an existing record set. +If this is the only record in the record set, the result will be an empty record set. +To remove a record set entirely, see Remove-AzDnsRecordSet. + +### Example 2: Remove an AAAA record from a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 +Set-AzDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzDnsRecordSet +``` + +This example removes an AAAA record from an existing record set. +If this is the only record in the record set, the result will be an empty record set. +To remove a record set entirely, see Remove-AzDnsRecordSet. + +### Example 3: Remove a CNAME record from a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com +Set-AzDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Cname contoso.com | Set-AzDnsRecordSet +``` + +This example removes a CNAME record from an existing record set. +Because a CNAME record set can contain at most one record, the result is an empty record set. + +### Example 4: Remove an MX record from a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "@" -RecordType MX -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet +Set-AzDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzDnsRecordSet -Name "@" -RecordType MX -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzDnsRecordSet +``` + +This example removes an MX record from an existing record set. +The record name "@" indicates a record set at the zone apex. +If this is the only record in the record set, the result is an empty record set. +To remove a record set entirely, see Remove-AzDnsRecordSet. + +### Example 5: Remove an NS record from a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "abc" -RecordType NS -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -Nsdname ns1.myzone.com -RecordSet $RecordSet +Set-AzDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzDnsRecordSet -Name "abc" -RecordType NS -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Nsdname "ns1.myzone.com" | Set-AzDnsRecordSet +``` + +This example removes an NS record from an existing record set. +If this is the only record in the record set, the result is an empty record set. +To remove a record set entirely, see Remove-AzDnsRecordSet. + +### Example 6: Remove a PTR record from a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -ZoneName 3.2.1.in-addr.arpa +Remove-AzDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet +Set-AzDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -ZoneName "3.2.1.in-addr.arpa" | Remove-AzDnsRecordConfig -Ptrdname www.contoso.com | Set-AzDnsRecordSet +``` + +This example removes a PTR record from an existing record set. +If this is the only record in the record set, the result is an empty record set. +To remove a record set entirely, see Remove-AzDnsRecordSet. + +### Example 7: Remove an SRV record from a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -RecordSet $RecordSet -Priority 0 -Weight 5 -Port 8080 -Target target.example.com +Set-AzDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzDnsRecordSet +``` + +This example removes an SRV record from an existing record set. +If this is the only record in the record set, the result is an empty record set. +To remove a record set entirely, see Remove-AzDnsRecordSet. + +### Example 8: Remove a TXT record from a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" +Set-AzDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Value "This is a TXT Record" | Set-AzDnsRecordSet +``` + +This example removes a TXT record from an existing record set. +If this is the only record in the record set, the result is an empty record set. +To remove a record set entirely, see Remove-AzDnsRecordSet. + +## PARAMETERS + +### -CaaFlags +The flags for the CAA record to add. Must be a number between 0 and 255. + +```yaml +Type: System.Byte +Parameter Sets: Caa +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CaaTag +The tag field of the CAA record to add. + +```yaml +Type: System.String +Parameter Sets: Caa +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CaaValue +The value field for the CAA record to add. + +```yaml +Type: System.String +Parameter Sets: Caa +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Cname +Specifies the domain name for a canonical name (CNAME) record. + +```yaml +Type: System.String +Parameter Sets: CNAME +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exchange +Specifies the mail exchange server name for a mail exchange (MX) record. + +```yaml +Type: System.String +Parameter Sets: MX +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Ipv4Address +Specifies an IPv4 address for an A record. + +```yaml +Type: System.String +Parameter Sets: A +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Ipv6Address +Specifies an IPv6 address for an AAAA record. + +```yaml +Type: System.String +Parameter Sets: AAAA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Nsdname +Specifies the name server for a name server (NS) record. + +```yaml +Type: System.String +Parameter Sets: NS +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Port +Specifies the port for a service (SRV) record. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Preference +Specifies the preference for an MX record. + +```yaml +Type: System.UInt16 +Parameter Sets: MX +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Priority +Specifies the priority for an SRV record. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Ptrdname +Specifies the target domain name of a pointer (PTR) record. + +```yaml +Type: System.String +Parameter Sets: PTR +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecordSet +Specifies the **RecordSet** object that contains the record to remove. + +```yaml +Type: Microsoft.Azure.Commands.Dns.DnsRecordSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Target +Specifies the target for an SRV record. + +```yaml +Type: System.String +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Specifies the value for a TXT record. + +```yaml +Type: System.String +Parameter Sets: TXT +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Weight +Specifies the weight for an SRV record. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Dns.DnsRecordSet + +### System.String + +### System.UInt16 + +### System.Byte + +## OUTPUTS + +### Microsoft.Azure.Commands.Dns.DnsRecordSet + +## NOTES + +## RELATED LINKS + +[Add-AzDnsRecordConfig](./Add-AzDnsRecordConfig.md) + +[Get-AzDnsRecordSet](./Get-AzDnsRecordSet.md) + +[Set-AzDnsRecordSet](./Set-AzDnsRecordSet.md) diff --git a/azps-10.1.0/Az.Dns/Remove-AzDnsRecordSet.md b/azps-10.1.0/Az.Dns/Remove-AzDnsRecordSet.md new file mode 100644 index 0000000000..d344e33956 --- /dev/null +++ b/azps-10.1.0/Az.Dns/Remove-AzDnsRecordSet.md @@ -0,0 +1,292 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml +Module Name: Az.Dns +ms.assetid: 505562A4-30BC-44E7-94EF-579763B8D794 +online version: https://learn.microsoft.com/powershell/module/az.dns/remove-azdnsrecordset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Remove-AzDnsRecordSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Remove-AzDnsRecordSet.md +--- + +# Remove-AzDnsRecordSet + +## SYNOPSIS +Deletes a record set. + +## SYNTAX + +### Fields +``` +Remove-AzDnsRecordSet -Name <String> -RecordType <RecordType> -ZoneName <String> -ResourceGroupName <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Mixed +``` +Remove-AzDnsRecordSet -Name <String> -RecordType <RecordType> -Zone <DnsZone> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Object +``` +Remove-AzDnsRecordSet -RecordSet <DnsRecordSet> [-Overwrite] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDnsRecordSet** cmdlet deletes the specified record set from the specified zone. +You cannot delete SOA or name server (NS) records that are automatically created at the zone apex. +You can pass a **RecordSet** object to this cmdlet by using the pipeline operator or as a parameter. +To identify a record set by name and type without using a **RecordSet** object, you must pass the zone as a **DnsZone** object to this cmdlet by using the pipeline operator or as a parameter, or alternatively you can specify the *ZoneName* and *ResourceGroupName* parameters. +You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. +When specifying the record set using a **RecordSet** object, the record set is not deleted if it has been changed in Azure DNS since the local **RecordSet** object was retrieved. +This provides protection for concurrent changes. +You can suppress this by using the *Overwrite* parameter, which deletes the record set regardless of concurrent changes. + +## EXAMPLES + +### Example 1: Remove a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "www" -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordSet -RecordSet $RecordSet +``` + +The first command gets the specified record set, and then stores it in the $RecordSet variable.The second command removes the record set in $RecordSet. + +### Example 2: Remove a record set and suppress all confirmation +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" +Remove-AzDnsRecordSet -RecordSet $RecordSet -Confirm:$False -Overwrite + +# Alternatively, the record set can be removed as follows. In this case, +# because the record set is specified by name rather than by object, the +# Overwrite parameter is not applicable. + +Remove-AzDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" -Confirm:$False +``` + +The first command gets the specified record set. +The second command deletes the record set, even if it has changed in the meantime. +Confirmation prompts are suppressed. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the **RecordSet** to remove. +When specifying the record set by name, the DNS zone must be specified using either the *Zone* parameter or the *ZoneName* and *ResourceGroupName* parameters. +Alternatively, the record set can be specified using a **RecordSet** object, passed using the *RecordSet* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields, Mixed +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overwrite +When specifying the record set using a **RecordSet** object, the record set is not deleted if it has been changed in Azure DNS since the local **RecordSet** object was retrieved. +This provides protection for concurrent changes. +This can be suppressed using the *Overwrite* parameter, which deletes the record set regardless of concurrent changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Object +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordSet +Specifies the **RecordSet** object to remove. +Alternatively, the record set can be specified using the *Name* and *Zone* parameters, or using the *Name*, *ZoneName*, and *ResourceGroupName* parameters. + +```yaml +Type: Microsoft.Azure.Commands.Dns.DnsRecordSet +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RecordType +Specifies the type of DNS record. +Valid values are: +- A +- AAAA +- CNAME +- MX +- NS +- PTR +- SRV +- TXT +SOA records are deleted automatically when the zone is deleted. +You cannot manually delete SOA records. + +```yaml +Type: Microsoft.Azure.Management.Dns.Models.RecordType +Parameter Sets: Fields, Mixed +Aliases: +Accepted values: A, AAAA, CAA, CNAME, MX, NS, PTR, SOA, SRV, TXT + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group that contains the DNS zone that contains the **RecordSet** to delete. +This parameter is applicable only when the record set and DNS zone are specified using the *Name* and *ZoneName* parameters. +Alternatively, you can specify the record set using either the *RecordSet* parameter, or the *Name* and *Zone* parameters. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +Specifies the DNS zone that contains the **RecordSet** to delete. +This parameter is applicable only when specifying the record set using the *Name* parameter. +Alternatively, you can specify the record set using either the *RecordSet* parameter, or the *Name*, *ZoneName*, and *ResourceGroupName* parameters. + +```yaml +Type: Microsoft.Azure.Commands.Dns.DnsZone +Parameter Sets: Mixed +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ZoneName +Specifies the name of the zone that contains the **RecordSet** to delete. +You must also specify the *Name* and *ResourceGroupName* parameters. +Alternatively, the record set can be specified using either the *RecordSet* parameter, or the *Name* and *Zone* parameters. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Management.Dns.Models.RecordType + +### System.String + +### Microsoft.Azure.Commands.Dns.DnsZone + +### Microsoft.Azure.Commands.Dns.DnsRecordSet + +## OUTPUTS + +### System.Boolean + +## NOTES +You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. +By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. +If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. +If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. + +## RELATED LINKS + +[Get-AzDnsRecordSet](./Get-AzDnsRecordSet.md) + +[New-AzDnsRecordSet](./New-AzDnsRecordSet.md) + +[Set-AzDnsRecordSet](./Set-AzDnsRecordSet.md) diff --git a/azps-10.1.0/Az.Dns/Remove-AzDnsZone.md b/azps-10.1.0/Az.Dns/Remove-AzDnsZone.md new file mode 100644 index 0000000000..24fada4c5f --- /dev/null +++ b/azps-10.1.0/Az.Dns/Remove-AzDnsZone.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml +Module Name: Az.Dns +ms.assetid: A8E230A0-5057-40BC-81CD-6D397A503A84 +online version: https://learn.microsoft.com/powershell/module/az.dns/remove-azdnszone +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Remove-AzDnsZone.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Remove-AzDnsZone.md +--- + +# Remove-AzDnsZone + +## SYNOPSIS +Removes a DNS zone from a resource group. + +## SYNTAX + +### Fields +``` +Remove-AzDnsZone -Name <String> -ResourceGroupName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Object +``` +Remove-AzDnsZone -Zone <DnsZone> [-Overwrite] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDnsZone** cmdlet permanently deletes a Domain Name System (DNS) zone from a specified resource group. +All record sets contained in the zone are also deleted. +You can pass a **DnsZone** object using the *Name* parameter or by using the pipeline operator, or alternatively you can specify the *ZoneName* and *ResourceGroupName* parameters. +You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. +When specifying the zone using a **DnsZone** object (passed via the pipeline or *Zone* parameter), the zone is not deleted if it has been changed in Azure DNS since the local **DnsZone** object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). +This provides protection for concurrent zone changes. +This can be suppressed using the *Overwrite* parameter, which deletes the zone regardless of concurrent changes. + +## EXAMPLES + +### Example 1: Remove a zone +```powershell +Remove-AzDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" +``` + +This command removes the zone named myzone.com from the resource group named MyResourceGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the DNS zone that this cmdlet removes. +You must also specify the *ResourceGroupName* parameter. +Alternatively, you can specify the DNS zone using the *Zone* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Overwrite +When specifying the zone using a **DnsZone** object (passed via the pipeline or *Zone* parameter), the zone is not deleted if it has been changed in Azure DNS since the local **DnsZone** object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). +This provides protection for concurrent zone changes. +This can be suppressed using the *Overwrite* parameter, which deletes the zone regardless of concurrent changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Object +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +passthru + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the zone to remove. +You must also specify the *ZoneName* parameter. +Alternatively, you can specify the DNS zone using a **DnsZone** object, passed via either the pipeline or the *Zone* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +Specifies the DNS zone to delete. +The **DnsZone** object passed can also be passed via the pipeline. +Alternatively, you can specify the DNS zone to delete by using the *ZoneName* and *ResourceGroupName* parameters. + +```yaml +Type: Microsoft.Azure.Commands.Dns.DnsZone +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Dns.DnsZone + +## OUTPUTS + +### System.Boolean + +## NOTES +Due to the potentially high impact of deleting a DNS zone, by default, this cmdlet prompts for confirmation if the $ConfirmPreference Windows PowerShell variable has any value other than None. +If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. +If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. + +## RELATED LINKS + +[Get-AzDnsZone](./Get-AzDnsZone.md) + +[New-AzDnsZone](./New-AzDnsZone.md) + +[Set-AzDnsZone](./Set-AzDnsZone.md) diff --git a/azps-10.1.0/Az.Dns/Set-AzDnsRecordSet.md b/azps-10.1.0/Az.Dns/Set-AzDnsRecordSet.md new file mode 100644 index 0000000000..1261abfd27 --- /dev/null +++ b/azps-10.1.0/Az.Dns/Set-AzDnsRecordSet.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml +Module Name: Az.Dns +ms.assetid: 99E6C4DD-11AF-4DC0-848B-39811240BE06 +online version: https://learn.microsoft.com/powershell/module/az.dns/set-azdnsrecordset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Set-AzDnsRecordSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Set-AzDnsRecordSet.md +--- + +# Set-AzDnsRecordSet + +## SYNOPSIS +Updates a DNS record set. + +## SYNTAX + +``` +Set-AzDnsRecordSet -RecordSet <DnsRecordSet> [-Overwrite] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDnsRecordSet** cmdlet updates a record set in the Azure DNS service from a local **RecordSet** object. +You can pass a **RecordSet** object as a parameter or by using the pipeline operator. +You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. +The record set is not updated if it has been changed in Azure DNS since the local **RecordSet** object was retrieved. +This provides protection for concurrent changes. +You can suppress this behavior using the *Overwrite* parameter, which updates the record set regardless of concurrent changes. + +## EXAMPLES + +### Example 1: Update a record set +```powershell +$RecordSet = Get-AzDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A +Add-AzDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 172.16.0.0 +Add-AzDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 172.31.255.255 +Set-AzDnsRecordSet -RecordSet $RecordSet + +# These cmdlets can also be piped: + +Get-AzDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A | Add-AzDnsRecordConfig -Ipv4Address 172.16.0.0 | Add-AzDnsRecordConfig -Ipv4Address 172.31.255.255 | Set-AzDnsRecordSet +``` + +The first command uses the Get-AzDnsRecordSet cmdlet to get the specified record set, and then stores it in the $RecordSet variable. +The second and third commands are off-line operations to add two A records to the record set. +The final command uses the **Set-AzDnsRecordSet** cmdlet to commit the update. + +### Example 2: Update an SOA record +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "@" -RecordType SOA -Zone $Zone +$RecordSet.Records[0].Email = "admin.myzone.com" +Set-AzDnsRecordSet -RecordSet $RecordSet +``` + +The first command uses the **Get-AzDnsRecordset** cmdlet to get the specified record set, and then stores it in the $RecordSet variable. +The second command updates the specified SOA record in $RecordSet. +The final command uses the **Set-AzDnsRecordSet** cmdlet to propagate the update in $RecordSet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overwrite +Indicates to update the record set regardless of concurrent changes. +The record set will not be updated if it has been changed in Azure DNS since the local **RecordSet** object was retrieved. +This provides protection for concurrent changes. +To suppress this behavior, you can use the *Overwrite* parameter, which results in the record set being updated regardless of concurrent changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordSet +Specifies the **RecordSet** to update. + +```yaml +Type: Microsoft.Azure.Commands.Dns.DnsRecordSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Dns.DnsRecordSet + +## OUTPUTS + +### Microsoft.Azure.Commands.Dns.DnsRecordSet + +## NOTES +You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. +By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. +If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. +If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. + +## RELATED LINKS + +[Get-AzDnsRecordSet](./Get-AzDnsRecordSet.md) + +[New-AzDnsRecordSet](./New-AzDnsRecordSet.md) + +[Remove-AzDnsRecordSet](./Remove-AzDnsRecordSet.md) diff --git a/azps-10.1.0/Az.Dns/Set-AzDnsZone.md b/azps-10.1.0/Az.Dns/Set-AzDnsZone.md new file mode 100644 index 0000000000..883d8b1982 --- /dev/null +++ b/azps-10.1.0/Az.Dns/Set-AzDnsZone.md @@ -0,0 +1,312 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml +Module Name: Az.Dns +ms.assetid: E37ADC54-A37B-41BF-BE94-9E4052C234BB +online version: https://learn.microsoft.com/powershell/module/az.dns/set-azdnszone +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Set-AzDnsZone.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Dns/Dns/help/Set-AzDnsZone.md +--- + +# Set-AzDnsZone + +## SYNOPSIS +Updates the properties of a DNS zone. + +## SYNTAX + +### Fields (Default) +``` +Set-AzDnsZone -Name <String> -ResourceGroupName <String> [-Tag <Hashtable>] + [-RegistrationVirtualNetworkId <System.Collections.Generic.List`1[System.String]>] + [-ResolutionVirtualNetworkId <System.Collections.Generic.List`1[System.String]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FieldsObjects +``` +Set-AzDnsZone -Name <String> -ResourceGroupName <String> [-Tag <Hashtable>] + [-RegistrationVirtualNetwork <System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference]>] + [-ResolutionVirtualNetwork <System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Object +``` +Set-AzDnsZone -Zone <DnsZone> [-Overwrite] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDnsZone** cmdlet updates the specified DNS zone in the Azure DNS service. +This cmdlet does not update the record sets in the zone. +You can pass a **DnsZone** object as a parameter or by using the pipeline operator, or +alternatively you can specify the *ZoneName* and *ResourceGroupName* parameters. +You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control +whether the cmdlet prompts you for confirmation. +When passing a DNS zone as an object (using the Zone object or via the pipeline), it is not updated +if it has been changed in Azure DNS since the local DnsZone object was retrieved. This provides +protection for concurrent changes. You can suppress this behavior with the *Overwrite* parameter, +which updates the zone regardless of concurrent changes. + +## EXAMPLES + +### Example 1: Update a DNS zone +```powershell +$Zone = Get-AzDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" +$Zone.Tags = @(@{"Name"="Dept"; "Value"="Electrical"}) +Set-AzDnsZone -Zone $Zone +``` + +The first command gets the zone named myzone.com from the specified resource group, and then stores +it in the $Zone variable. +The second command updates the tags for $Zone. +The final command commits the change. + +### Example 2: Update tags for a zone +```powershell +Set-AzDNSZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com" -Tag @(@{"Name"="Dept"; "Value"="Electrical"}) +``` + +This command updates the tags for the zone named myzone.com without first explicitly getting the +zone. + +### Example 3: Associating a private zone with a virtual network by specifying its ID +```powershell +$vnet = Get-AzVirtualNetwork -ResourceGroupName "MyResourceGroup" -Name "myvnet" +Set-AzDNSZone -ResourceGroupName "MyResourceGroup" -Name "myprivatezone.com" -RegistrationVirtualNetworkId @($vnet.Id) +``` + +This command associates the Private DNS zone myprivatezone.com with the virtual network myvnet as a registration network +by specifying its ID. + +### Example 4: Associating a private zone with a virtual network by specifying the network object. +```powershell +$vnet = Get-AzVirtualNetwork -ResourceGroupName "MyResourceGroup" -Name "myvnet" +Set-AzDNSZone -ResourceGroupName "MyResourceGroup" -Name "myprivatezone.com" -RegistrationVirtualNetwork @($vnet) +``` + +This command associates the Private DNS zone myprivatezone.com with the virtual network myvnet as a registration network +by passing the virtual network object represented by $vnet variable to the Set-AzDnsZone cmdlet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the DNS zone to update. + +```yaml +Type: System.String +Parameter Sets: Fields, FieldsObjects +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Overwrite +When passing a DNS zone as an object (using the Zone object or via the pipeline), it is not updated +if it has been changed in Azure DNS since the local DnsZone object was retrieved. This provides +protection for concurrent changes. You can suppress this behavior with the *Overwrite* parameter, +which updates the zone regardless of concurrent changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Object +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationVirtualNetwork +The list of virtual networks that will register virtual machine hostnames records in this DNS zone, only available for private zones. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference] +Parameter Sets: FieldsObjects +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RegistrationVirtualNetworkId +The list of virtual network IDs that will register virtual machine hostnames records in this DNS zone, only available for private zones. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: Fields +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResolutionVirtualNetwork +The list of virtual networks able to resolve records in this DNS zone, only available for private zones. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference] +Parameter Sets: FieldsObjects +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResolutionVirtualNetworkId +The list of virtual network IDs able to resolve records in this DNS zone, only available for private zones. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: Fields +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the zone to update. +You must also specify the ZoneName parameter. +Alternatively, you can specify the zone using a DnsZone object with the *Zone* parameter or the pipeline. + +```yaml +Type: System.String +Parameter Sets: Fields, FieldsObjects +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: Fields, FieldsObjects +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +Specifies the DNS zone to update. +Alternatively, you can specify the zone using the *ZoneName* and *ResourceGroupName* parameters. + +```yaml +Type: Microsoft.Azure.Commands.Dns.DnsZone +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference, Microsoft.Azure.PowerShell.Clients.Network, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### Microsoft.Azure.Commands.Dns.DnsZone + +## OUTPUTS + +### Microsoft.Azure.Commands.Dns.DnsZone + +## NOTES +You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. +By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. +If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. +If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. + +## RELATED LINKS + +[Get-AzDnsZone](./Get-AzDnsZone.md) + +[New-AzDnsZone](./New-AzDnsZone.md) + +[Remove-AzDnsZone](./Remove-AzDnsZone.md) diff --git a/azps-10.1.0/Az.DnsResolver/Az.DnsResolver.md b/azps-10.1.0/Az.DnsResolver/Az.DnsResolver.md new file mode 100644 index 0000000000..83080ad216 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Az.DnsResolver.md @@ -0,0 +1,100 @@ +--- +Module Name: Az.DnsResolver +Module Guid: 88e239b3-f615-4018-adf3-f0952a0f46a8 +Download Help Link: https://learn.microsoft.com/powershell/module/az.dnsresolver +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Az.DnsResolver.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Az.DnsResolver.md +--- + +# Az.DnsResolver Module +## Description +Microsoft Azure PowerShell: DnsResolver cmdlets + +## Az.DnsResolver Cmdlets +### [Get-AzDnsForwardingRuleset](Get-AzDnsForwardingRuleset.md) +Gets a DNS forwarding ruleset properties. + +### [Get-AzDnsForwardingRulesetForwardingRule](Get-AzDnsForwardingRulesetForwardingRule.md) +Gets properties of a forwarding rule in a DNS forwarding ruleset. + +### [Get-AzDnsForwardingRulesetVirtualNetworkLink](Get-AzDnsForwardingRulesetVirtualNetworkLink.md) +Gets properties of a virtual network link to a DNS forwarding ruleset. + +### [Get-AzDnsResolver](Get-AzDnsResolver.md) +Gets properties of a DNS resolver. + +### [Get-AzDnsResolverInboundEndpoint](Get-AzDnsResolverInboundEndpoint.md) +Gets properties of an inbound endpoint for a DNS resolver. + +### [Get-AzDnsResolverOutboundEndpoint](Get-AzDnsResolverOutboundEndpoint.md) +Gets properties of an outbound endpoint for a DNS resolver. + +### [New-AzDnsForwardingRuleset](New-AzDnsForwardingRuleset.md) +Creates or updates a DNS forwarding ruleset. + +### [New-AzDnsForwardingRulesetForwardingRule](New-AzDnsForwardingRulesetForwardingRule.md) +Creates or updates a forwarding rule in a DNS forwarding ruleset. + +### [New-AzDnsForwardingRulesetVirtualNetworkLink](New-AzDnsForwardingRulesetVirtualNetworkLink.md) +Creates or updates a virtual network link to a DNS forwarding ruleset. + +### [New-AzDnsResolver](New-AzDnsResolver.md) +Creates or updates a DNS resolver. + +### [New-AzDnsResolverInboundEndpoint](New-AzDnsResolverInboundEndpoint.md) +Creates or updates an inbound endpoint for a DNS resolver. + +### [New-AzDnsResolverIPConfigurationObject](New-AzDnsResolverIPConfigurationObject.md) +Create a in-memory object for IPConfiguration + +### [New-AzDnsResolverOutboundEndpoint](New-AzDnsResolverOutboundEndpoint.md) +Creates or updates an outbound endpoint for a DNS resolver. + +### [New-AzDnsResolverTargetDnsServerObject](New-AzDnsResolverTargetDnsServerObject.md) +Create a in-memory object for Target DNS server + +### [Remove-AzDnsForwardingRuleset](Remove-AzDnsForwardingRuleset.md) +Deletes a DNS forwarding ruleset. +WARNING: This operation cannot be undone. +All forwarding rules within the ruleset will be deleted. + +### [Remove-AzDnsForwardingRulesetForwardingRule](Remove-AzDnsForwardingRulesetForwardingRule.md) +Deletes a forwarding rule in a DNS forwarding ruleset. +WARNING: This operation cannot be undone. + +### [Remove-AzDnsForwardingRulesetVirtualNetworkLink](Remove-AzDnsForwardingRulesetVirtualNetworkLink.md) +Deletes a virtual network link to a DNS forwarding ruleset. +WARNING: This operation cannot be undone. + +### [Remove-AzDnsResolver](Remove-AzDnsResolver.md) +Deletes a DNS resolver. +WARNING: This operation cannot be undone. + +### [Remove-AzDnsResolverInboundEndpoint](Remove-AzDnsResolverInboundEndpoint.md) +Deletes an inbound endpoint for a DNS resolver. +WARNING: This operation cannot be undone. + +### [Remove-AzDnsResolverOutboundEndpoint](Remove-AzDnsResolverOutboundEndpoint.md) +Deletes an outbound endpoint for a DNS resolver. +WARNING: This operation cannot be undone. + +### [Update-AzDnsForwardingRuleset](Update-AzDnsForwardingRuleset.md) +Updates a DNS forwarding ruleset. + +### [Update-AzDnsForwardingRulesetForwardingRule](Update-AzDnsForwardingRulesetForwardingRule.md) +Updates a forwarding rule in a DNS forwarding ruleset. + +### [Update-AzDnsForwardingRulesetVirtualNetworkLink](Update-AzDnsForwardingRulesetVirtualNetworkLink.md) +Updates a virtual network link to a DNS forwarding ruleset. + +### [Update-AzDnsResolver](Update-AzDnsResolver.md) +Updates a DNS resolver. + +### [Update-AzDnsResolverInboundEndpoint](Update-AzDnsResolverInboundEndpoint.md) +Updates an inbound endpoint for a DNS resolver. + +### [Update-AzDnsResolverOutboundEndpoint](Update-AzDnsResolverOutboundEndpoint.md) +Updates an outbound endpoint for a DNS resolver. + diff --git a/azps-10.1.0/Az.DnsResolver/Get-AzDnsForwardingRuleset.md b/azps-10.1.0/Az.DnsResolver/Get-AzDnsForwardingRuleset.md new file mode 100644 index 0000000000..ea7f5d6cf5 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Get-AzDnsForwardingRuleset.md @@ -0,0 +1,287 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/get-azdnsforwardingruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Get-AzDnsForwardingRuleset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Get-AzDnsForwardingRuleset.md +--- + +# Get-AzDnsForwardingRuleset + +## SYNOPSIS +Gets a DNS forwarding ruleset properties. + +## SYNTAX + +### List1 (Default) +``` +Get-AzDnsForwardingRuleset [-SubscriptionId <String[]>] [-Top <Int32>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzDnsForwardingRuleset -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDnsForwardingRuleset -InputObject <IDnsResolverIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzDnsForwardingRuleset -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Top <Int32>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List2 +``` +Get-AzDnsForwardingRuleset -ResourceGroupName <String> -VirtualNetworkName <String> + [-SubscriptionId <String[]>] [-Top <Int32>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a DNS forwarding ruleset properties. + +## EXAMPLES + +### Example 1: List all DNS forwarding rulesets in a subscription +```powershell +Get-AzDnsForwardingRuleset -SubscriptionId 0e5a46b1-de0b-4ec3-a5d7-dda908b4e076 +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "04005592-0000-0800-0000-60e7ec170000" +westus2 pw-dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "08009ec9-0000-0800-0000-60e383b70000" +westus2 pw-dnsForwardingRuleset1 Microsoft.Network/dnsForwardingRulesets "08007ccc-0000-0800-0000-60e3846a0000" +eastus2 dnsforwardingruleset-test-eastus2-main-syn-outbound-primary-0 Microsoft.Network/dnsForwardingRulesets "4f006bb2-0000-0200-0000-60e7ef240000" +eastus2 dnsforwardingruleset-test-eastus2-main-syn-outbound-secondary-0 Microsoft.Network/dnsForwardingRulesets "4f006db2-0000-0200-0000-60e7ef240000" +``` + +This command gets all DNS forwarding ruleset under the subscription. + +### Example 2: Get single DNS forwarding ruleset by name +```powershell +Get-AzDnsForwardingRuleset -Name dnsForwardingRuleset -ResourceGroupName sampleRG +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "04005592-0000-0800-0000-60e7ec170000" +``` + +This command gets single DNS forwarding ruleset by name. + +### Example 3: List all DNS forwarding ruleset under the resource group +```powershell +Get-AzDnsForwardingRuleset -ResourceGroupName sampleRG +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "04005592-0000-0800-0000-60e7ec170000" +westus2 pw-dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "08009ec9-0000-0800-0000-60e383b70000" +westus2 pw-dnsForwardingRuleset1 Microsoft.Network/dnsForwardingRulesets "08007ccc-0000-0800-0000-60e3846a0000" +``` + +This command gets all DNS forwarding ruleset under the resource group. + +### Example 4: List all DNS forwarding ruleset under the virtual network +```powershell +Get-AzDnsForwardingRuleset -ResourceGroupName sampleRG -VirtualNetworkName virtualnetwork-test +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "04005592-0000-0800-0000-60e7ec170000" +``` + +This command gets all DNS forwarding ruleset under the virtual network. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the DNS forwarding ruleset. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DnsForwardingRulesetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1, List2 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +The maximum number of results to return. +If not specified, returns up to 100 results. + +```yaml +Type: System.Int32 +Parameter Sets: List, List1, List2 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkName +The name of the virtual network. + +```yaml +Type: System.String +Parameter Sets: List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IDnsForwardingRuleset + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IVirtualNetworkDnsForwardingRuleset + +## 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 <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Get-AzDnsForwardingRulesetForwardingRule.md b/azps-10.1.0/Az.DnsResolver/Get-AzDnsForwardingRulesetForwardingRule.md new file mode 100644 index 0000000000..1c3b6c8b60 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Get-AzDnsForwardingRulesetForwardingRule.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/get-azdnsforwardingrulesetforwardingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Get-AzDnsForwardingRulesetForwardingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Get-AzDnsForwardingRulesetForwardingRule.md +--- + +# Get-AzDnsForwardingRulesetForwardingRule + +## SYNOPSIS +Gets properties of a forwarding rule in a DNS forwarding ruleset. + +## SYNTAX + +### List (Default) +``` +Get-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDnsForwardingRulesetForwardingRule -InputObject <IDnsResolverIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets properties of a forwarding rule in a DNS forwarding ruleset. + +## EXAMPLES + +### Example 1: List all forwarding rule under the resource +```powershell +Get-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName DnsResolverName -ResourceGroupName sampleRG +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 dnsForwardingRule Microsoft.Network/dnsForwardingRulesets/forwardingRule "04005592-0000-0800-0000-60e7ec170000" +westus2 pw-dnsForwardingRule Microsoft.Network/dnsForwardingRulesets/forwardingRule "08009ec9-0000-0800-0000-60e383b70000" +``` + +This command gets all forwarding rule under the resource. + +### Example 1: Get forwarding rule by name +```powershell +Get-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName DnsResolverName -ResourceGroupName sampleRG -Name forwardingRule +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 dnsForwardingRule Microsoft.Network/dnsForwardingRulesets/forwardingRule "04005592-0000-0800-0000-60e7ec170000" +``` + +This command gets a forwarding rule by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsForwardingRulesetName +The name of the DNS forwarding ruleset. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the forwarding rule. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ForwardingRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +The maximum number of results to return. +If not specified, returns up to 100 results. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IForwardingRule + +## 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 <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Get-AzDnsForwardingRulesetVirtualNetworkLink.md b/azps-10.1.0/Az.DnsResolver/Get-AzDnsForwardingRulesetVirtualNetworkLink.md new file mode 100644 index 0000000000..9d62554915 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Get-AzDnsForwardingRulesetVirtualNetworkLink.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/get-azdnsforwardingrulesetvirtualnetworklink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Get-AzDnsForwardingRulesetVirtualNetworkLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Get-AzDnsForwardingRulesetVirtualNetworkLink.md +--- + +# Get-AzDnsForwardingRulesetVirtualNetworkLink + +## SYNOPSIS +Gets properties of a virtual network link to a DNS forwarding ruleset. + +## SYNTAX + +### List (Default) +``` +Get-AzDnsForwardingRulesetVirtualNetworkLink -DnsForwardingRulesetName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDnsForwardingRulesetVirtualNetworkLink -DnsForwardingRulesetName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDnsForwardingRulesetVirtualNetworkLink -InputObject <IDnsResolverIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets properties of a virtual network link to a DNS forwarding ruleset. + +## EXAMPLES + +### Example 1: List virtual network links under a DNS forwarding ruleset +```powershell +Get-AzDnsForwardingRulesetVirtualNetworkLink -DnsForwardingRulesetName pstestdnsresolvername -ResourceGroupName powershell-test-rg +``` + +```output +Name Type Etag +---- ---- ---- +samplevnetLink1 Microsoft.Network/dnsForwardingRuleset/virtualNetworkLinks "0b008451-0000-0800-0000-60402b960000" +samplevnetLink2 Microsoft.Network/dnsForwardingRuleset/virtualNetworkLinks "0b0071aa-0000-0800-0000-60406a2d0000" +``` + +This command gets all virtual network link by name + +### Example 2: Get single virtual network link by name +```powershell +Get-AzDnsForwardingRulesetVirtualNetworkLink -DnsForwardingRulesetName pstestdnsresolvername -Name samplevnetLink1 -ResourceGroupName powershell-test-rg +``` + +```output +Name Type Etag +---- ---- ---- +samplevnetLink1 Microsoft.Network/dnsForwardingRuleset/virtualNetworkLinks "0b008451-0000-0800-0000-60402b960000" +``` + +This command gets single virtual network link by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsForwardingRulesetName +The name of the DNS forwarding ruleset. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network link. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: VirtualNetworkLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +The maximum number of results to return. +If not specified, returns up to 100 results. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IVirtualNetworkLink + +## 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 <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Get-AzDnsResolver.md b/azps-10.1.0/Az.DnsResolver/Get-AzDnsResolver.md new file mode 100644 index 0000000000..022a1fc847 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Get-AzDnsResolver.md @@ -0,0 +1,291 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/get-azdnsresolver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Get-AzDnsResolver.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Get-AzDnsResolver.md +--- + +# Get-AzDnsResolver + +## SYNOPSIS +Gets properties of a DNS resolver. + +## SYNTAX + +### List1 (Default) +``` +Get-AzDnsResolver [-SubscriptionId <String[]>] [-Top <Int32>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzDnsResolver -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDnsResolver -InputObject <IDnsResolverIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzDnsResolver -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Top <Int32>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List2 +``` +Get-AzDnsResolver -ResourceGroupName <String> -VirtualNetworkName <String> [-SubscriptionId <String[]>] + [-Top <Int32>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Gets properties of a DNS resolver. + +## EXAMPLES + +### Example 1: List all DNS Resolvers under the subscription +```powershell +Get-AzDnsResolver -SubscriptionId 0e5a46b1-de0b-4ec3-a5d7-dda908b4e076 +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 dnsresolvertestresolver2422 Microsoft.Network/dnsResolvers "8b002671-0000-0800-0000-60386dc10000" +westus2 dnsresolvertestresolver2654 Microsoft.Network/dnsResolvers "8b000f71-0000-0800-0000-60386cc40000" +westus2 dnsresolvertestresolver8416 Microsoft.Network/dnsResolvers "94008a5e-0000-0800-0000-603972f20000" +westus2 dnsresolvertestresolver5036 Microsoft.Network/dnsResolvers "8b002f71-0000-0800-0000-60386df80000" +westus2 dnsresolvertestresolver3718 Microsoft.Network/dnsResolvers "00009b95-0000-0800-0000-603e8b210000" +westus2 dnsresolvertestresolver2758 Microsoft.Network/dnsResolvers "8b00da70-0000-0800-0000-60386b4f0000" +westus2 dnsresolvertestresolver7108 Microsoft.Network/dnsResolvers "00008e95-0000-0800-0000-603e8aee0000" +westus2 dnsresolvertestresolver7639 Microsoft.Network/dnsResolvers "8b00b670-0000-0800-0000-60386b010000" +westus2 dnsresolvertestresolver5912 Microsoft.Network/dnsResolvers "8a00557f-0000-0800-0000-603853bc0000" +westus2 dnsresolvertestguli01 Microsoft.Network/dnsResolvers "48009f1b-0000-0800-0000-60302ec40000" +westus2 dnsresolvertestresolver9892 Microsoft.Network/dnsResolvers "47008640-0000-0800-0000-60300f220000" +``` + +This command gets all DNS Resolvers under the subscription. + +### Example 2: List all DNS Resolvers under the resource group +```powershell +Get-AzDnsResolver -ResourceGroupName powershell-test-rg +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 psdnsresolvername33nmy1fz Microsoft.Network/dnsResolvers "0000c2d4-0000-0800-0000-604013880000" +westus2 psdnsresolvername34dp19g6 Microsoft.Network/dnsResolvers "0000c9d4-0000-0800-0000-604013990000" +westus2 psdnsresolvername35m3jf0n Microsoft.Network/dnsResolvers "0000d0d4-0000-0800-0000-604013a80000" +``` + +This command gets all DNS Resolvers under the resource group. + +### Example 3: Get single DNS Resolver by name +```powershell +Get-AzDnsResolver -ResourceGroupName powershell-test-rg -Name psdnsresolvername33nmy1fz +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 psdnsresolvername33nmy1fz Microsoft.Network/dnsResolvers "0000c2d4-0000-0800-0000-604013880000" +``` + +This command gets single DNS Resolver by name. + +### Example 4: List all DNS Resolvers under the virtual network +```powershell +Get-AzDnsResolver -ResourceGroupName powershell-test-rg -VirtualNetworkName virtualnetwork-test +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 psdnsresolvername33nmy1fz Microsoft.Network/dnsResolvers "0000c2d4-0000-0800-0000-604013880000" +``` + +This command gets single DNS Resolver by virtual network. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DnsResolverName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1, List2 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +The maximum number of results to return. +If not specified, returns up to 100 results. + +```yaml +Type: System.Int32 +Parameter Sets: List, List1, List2 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkName +The name of the virtual network. + +```yaml +Type: System.String +Parameter Sets: List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IDnsResolver + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.ISubResource + +## 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 <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Get-AzDnsResolverInboundEndpoint.md b/azps-10.1.0/Az.DnsResolver/Get-AzDnsResolverInboundEndpoint.md new file mode 100644 index 0000000000..1b7f22900d --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Get-AzDnsResolverInboundEndpoint.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/get-azdnsresolverinboundendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Get-AzDnsResolverInboundEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Get-AzDnsResolverInboundEndpoint.md +--- + +# Get-AzDnsResolverInboundEndpoint + +## SYNOPSIS +Gets properties of an inbound endpoint for a DNS resolver. + +## SYNTAX + +### List (Default) +``` +Get-AzDnsResolverInboundEndpoint -DnsResolverName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDnsResolverInboundEndpoint -DnsResolverName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDnsResolverInboundEndpoint -InputObject <IDnsResolverIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets properties of an inbound endpoint for a DNS resolver. + +## EXAMPLES + +### Example 1: List Inbound Endpoints under a DNS Resolver +```powershell +Get-AzDnsResolverInboundEndpoint -DnsResolverName pstestdnsresolvername -ResourceGroupName powershell-test-rg +``` + +```output +Name Type Etag +---- ---- ---- +sampleInboundEndpoint Microsoft.Network/dnsResolvers/inboundEndpoints "0b008451-0000-0800-0000-60402b960000" +sampleInboundEndpoint1 Microsoft.Network/dnsResolvers/inboundEndpoints "0b0071aa-0000-0800-0000-60406a2d0000" +``` + +This command lists Inbound Endpoints under a DNS Resolver + +### Example 2: Get single Inbound Endpoint by name +```powershell +Get-AzDnsResolverInboundEndpoint -DnsResolverName pstestdnsresolvername -Name sampleInboundEndpoint -ResourceGroupName powershell-test-rg +``` + +```output +Name Type Etag +---- ---- ---- +sampleInboundEndpoint Microsoft.Network/dnsResolvers/inboundEndpoints "0b008451-0000-0800-0000-60402b960000" +``` + +This command gets single Inbound Endpoint by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsResolverName +The name of the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the inbound endpoint for the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: InboundEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +The maximum number of results to return. +If not specified, returns up to 100 results. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IInboundEndpoint + +## 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 <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Get-AzDnsResolverOutboundEndpoint.md b/azps-10.1.0/Az.DnsResolver/Get-AzDnsResolverOutboundEndpoint.md new file mode 100644 index 0000000000..873a46dcd3 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Get-AzDnsResolverOutboundEndpoint.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/get-azdnsresolveroutboundendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Get-AzDnsResolverOutboundEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Get-AzDnsResolverOutboundEndpoint.md +--- + +# Get-AzDnsResolverOutboundEndpoint + +## SYNOPSIS +Gets properties of an outbound endpoint for a DNS resolver. + +## SYNTAX + +### List (Default) +``` +Get-AzDnsResolverOutboundEndpoint -DnsResolverName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDnsResolverOutboundEndpoint -DnsResolverName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDnsResolverOutboundEndpoint -InputObject <IDnsResolverIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets properties of an outbound endpoint for a DNS resolver. + +## EXAMPLES + +### Example 1: List all outbound endpoints under the DNS resolver in a resource group +```powershell +Get-AzDnsResolverOutboundEndpoint -DnsResolverName sampleResolver -ResourceGroupName sampleResourceGroup +``` + +```output +Name Type Etag +---- ---- ---- +sampleOutbound Microsoft.Network/dnsResolvers/outboundEndpoints "0a001a28-0000-0800-0000-60e3846a0000" +sampleOutbound2 Microsoft.Network/dnsResolvers/outboundEndpoints "0a001a27-0000-0800-0000-60e3846a0000" +``` + +This command gets all outbound endpoints under the DNS resolver in a resource group. + +### Example 2: Get single outbound endpoint by name +```powershell +Get-AzDnsResolverOutboundEndpoint -DnsResolverName sampleResolver -Name sampleOutbound -ResourceGroupName sampleResourceGroup +``` + +```output +Name Type Etag +---- ---- ---- +sampleOutbound Microsoft.Network/dnsResolvers/outboundEndpoints "0a001a28-0000-0800-0000-60e3846a0000" +``` + +This command gets an outbound endpoint under the DNS resolver in a resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsResolverName +The name of the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the outbound endpoint for the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: OutboundEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +The maximum number of results to return. +If not specified, returns up to 100 results. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IOutboundEndpoint + +## 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 <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/New-AzDnsForwardingRuleset.md b/azps-10.1.0/Az.DnsResolver/New-AzDnsForwardingRuleset.md new file mode 100644 index 0000000000..4d28766e56 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/New-AzDnsForwardingRuleset.md @@ -0,0 +1,282 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/new-azdnsforwardingruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsForwardingRuleset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsForwardingRuleset.md +--- + +# New-AzDnsForwardingRuleset + +## SYNOPSIS +Creates or updates a DNS forwarding ruleset. + +## SYNTAX + +``` +New-AzDnsForwardingRuleset -Name <String> -ResourceGroupName <String> + -DnsResolverOutboundEndpoint <ISubResource[]> -Location <String> [-SubscriptionId <String>] + [-IfMatch <String>] [-IfNoneMatch <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a DNS forwarding ruleset. + +## EXAMPLES + +### Example 1: Create a DNS forwarding ruleset +```powershell +New-AzDnsResolverOutboundEndpoint -DnsResolverName sampleResolver -Name sampleOutboundEndpoint -ResourceGroupName sampleRG -SubscriptionId ea40042d-63d8-4d02-9261-fb31450e6c67 -SubnetId "/subscriptions/0e5a46b1-de0b-4ec3-a5d7-dda908b4e076/resourceGroups/powershell-test-08b4e076/resourceGroups/sampleRG/providers/Microsoft.Network/virtualNetworks/psvirtualnetworkname16y71mjc/subnets/test-subnet" -Location westus2 +New-AzDnsForwardingRuleset -Name dnsForwardingRuleset -ResourceGroupName sampleRG -Location westus2 -DnsResolverOutboundEndpoint @{id = "/subscriptions/ea40042d-63d8-4d02-9261-fb31450e6c64/resourceGroups/sampleRG/providers/Microsoft.Network/dnsResolvers/sampleResolver/outboundEndpoints/sampleOutboundEndpoint";} +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "04005592-0000-0800-0000-60e7ec170000" +``` + +This cmdlet creates a DNS forwarding ruleset. + +### Example 2: Create a DNS forwarding ruleset with tag +```powershell +New-AzDnsResolverOutboundEndpoint -DnsResolverName sampleResolver -Name sampleOutboundEndpoint -ResourceGroupName sampleRG -SubscriptionId ea40042d-63d8-4d02-9261-fb31450e6c67 -SubnetId "/subscriptions/0e5a46b1-de0b-4ec3-a5d7-dda908b4e076/resourceGroups/powershell-test-08b4e076/resourceGroups/sampleRG/providers/Microsoft.Network/virtualNetworks/psvirtualnetworkname16y71mjc/subnets/test-subnet" -Location westus2 +New-AzDnsForwardingRuleset -Name dnsForwardingRuleset -ResourceGroupName sampleRG -Location westus2 -DnsResolverOutboundEndpoint @{id = "/subscriptions/ea40042d-63d8-4d02-9261-fb31450e6c64/resourceGroups/sampleRG/providers/Microsoft.Network/dnsResolvers/sampleResolver/outboundEndpoints/sampleOutboundEndpoint";} -Tag @{"key0" = "value0"} +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "04005592-0000-0800-0000-60e7ec170000" +``` + +This cmdlet creates a DNS forwarding ruleset.} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsResolverOutboundEndpoint +The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers. +To construct, see NOTES section for DNSRESOLVEROUTBOUNDENDPOINT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.ISubResource[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. +Other values will be ignored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the DNS forwarding ruleset. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DnsForwardingRulesetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IDnsForwardingRuleset + +## 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. + + +`DNSRESOLVEROUTBOUNDENDPOINT <ISubResource[]>`: The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers. + - `Id <String>`: Resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/New-AzDnsForwardingRulesetForwardingRule.md b/azps-10.1.0/Az.DnsResolver/New-AzDnsForwardingRulesetForwardingRule.md new file mode 100644 index 0000000000..222f15ecc2 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/New-AzDnsForwardingRulesetForwardingRule.md @@ -0,0 +1,284 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/new-azdnsforwardingrulesetforwardingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsForwardingRulesetForwardingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsForwardingRulesetForwardingRule.md +--- + +# New-AzDnsForwardingRulesetForwardingRule + +## SYNOPSIS +Creates or updates a forwarding rule in a DNS forwarding ruleset. + +## SYNTAX + +``` +New-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName <String> -Name <String> + -ResourceGroupName <String> -DomainName <String> -TargetDnsServer <ITargetDnsServer[]> + [-SubscriptionId <String>] [-IfMatch <String>] [-IfNoneMatch <String>] + [-ForwardingRuleState <ForwardingRuleState>] [-Metadata <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a forwarding rule in a DNS forwarding ruleset. + +## EXAMPLES + +### Example 1: Create a forwarding rule. +```powershell +$targetIPConfig = New-AzDnsResolverIPConfigurationObject -PrivateIPAddress 10.0.0.3 -PrivateIPAllocationMethod Dynamic -SubnetId /subscriptions/ea40042d-63d8-4d02-9261-fb31450e6c67/resourceGroups/sampleRG/providers/Microsoft.Network/virtualNetworks/vnet-hub/subnets/test-subnet +New-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName dnsForwardingRuleset -Name sampleForwardingRule -ResourceGroupName sampleRG -TargetDnsServer $targetIPConfig +``` + +```output +Name Type Etag +---- ---- ---- +sampleForwardingRule Microsoft.Network/dnsForwardingRuleset/forwardingRule "0b008451-0000-0800-0000-60402b960000" +``` + +This cmdlet creates a forwarding rule. + +### Example 2: Create a forwarding rule with tag +```powershell +$targetIPConfig = New-AzDnsResolverIPConfigurationObject -PrivateIPAddress 10.0.0.3 -PrivateIPAllocationMethod Dynamic -SubnetId /subscriptions/ea40042d-63d8-4d02-9261-fb31450e6c67/resourceGroups/sampleRG/providers/Microsoft.Network/virtualNetworks/vnet-hub/subnets/test-subnet +New-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName dnsForwardingRuleset -Name sampleForwardingRule -ResourceGroupName sampleRG -TargetDnsServer $targetIPConfig -Metadata @{"key0" = "value0"} +``` + +```output +Name Type Etag +---- ---- ---- +sampleForwardingRule Microsoft.Network/dnsForwardingRuleset/forwardingRule "0b008451-0000-0800-0000-60402b960000" +``` + +This cmdlet creates a forwarding rule with tag. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsForwardingRulesetName +The name of the DNS forwarding ruleset. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +The domain name for the forwarding rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingRuleState +The state of forwarding rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Support.ForwardingRuleState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. +Other values will be ignored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Metadata attached to the forwarding rule. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the forwarding rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ForwardingRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDnsServer +DNS servers to forward the DNS query to. +To construct, see NOTES section for TARGETDNSSERVER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.ITargetDnsServer[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IForwardingRule + +## 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. + + +`TARGETDNSSERVER <ITargetDnsServer[]>`: DNS servers to forward the DNS query to. + - `IPAddress <String>`: DNS server IP address. + - `[Port <Int32?>]`: DNS server port. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/New-AzDnsForwardingRulesetVirtualNetworkLink.md b/azps-10.1.0/Az.DnsResolver/New-AzDnsForwardingRulesetVirtualNetworkLink.md new file mode 100644 index 0000000000..3167e055f3 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/New-AzDnsForwardingRulesetVirtualNetworkLink.md @@ -0,0 +1,271 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/new-azdnsforwardingrulesetvirtualnetworklink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsForwardingRulesetVirtualNetworkLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsForwardingRulesetVirtualNetworkLink.md +--- + +# New-AzDnsForwardingRulesetVirtualNetworkLink + +## SYNOPSIS +Creates or updates a virtual network link to a DNS forwarding ruleset. + +## SYNTAX + +``` +New-AzDnsForwardingRulesetVirtualNetworkLink -DnsForwardingRulesetName <String> -Name <String> + -ResourceGroupName <String> -VirtualNetworkId <String> [-SubscriptionId <String>] [-IfMatch <String>] + [-IfNoneMatch <String>] [-Metadata <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a virtual network link to a DNS forwarding ruleset. + +## EXAMPLES + +### Example 1: Create a virtual network link +```powershell +New-AzDnsForwardingRulesetVirtualNetworkLink -DnsForwardingRulesetName dnsForwardingRuleset -Name sampleVnetLink -ResourceGroupName sampleRG -VirtualNetworkId "/subscriptions/ea40042d-63d8-4d02-9261-fb31450e6c64/resourceGroups/sampleRG/providers/Microsoft.Network/virtualNetworks/vnet-hub" +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 sampleVnetLink Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks "0a009902-0000-0800-0000-60e378030000" +``` + +This cmdlet creates a virtual network link. + +### Example 2: Create a virtual network link with metadata +```powershell +New-AzDnsForwardingRulesetVirtualNetworkLink -DnsForwardingRulesetName dnsForwardingRuleset -Name sampleVnetLink -ResourceGroupName sampleRG -VirtualNetworkId "/subscriptions/ea40042d-63d8-4d02-9261-fb31450e6c64/resourceGroups/sampleRG/providers/Microsoft.Network/virtualNetworks/vnet-hub" -Metadata @{"key0" = "value0"} +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 sampleVnetLink Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks "0a009902-0000-0800-0000-60e378030000" +``` + +This cmdlet creates a virtual network link with metadata. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsForwardingRulesetName +The name of the DNS forwarding ruleset. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. +Other values will be ignored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Metadata attached to the virtual network link. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VirtualNetworkLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IVirtualNetworkLink + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/New-AzDnsResolver.md b/azps-10.1.0/Az.DnsResolver/New-AzDnsResolver.md new file mode 100644 index 0000000000..769ee96828 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/New-AzDnsResolver.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/new-azdnsresolver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsResolver.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsResolver.md +--- + +# New-AzDnsResolver + +## SYNOPSIS +Creates or updates a DNS resolver. + +## SYNTAX + +``` +New-AzDnsResolver -Name <String> -ResourceGroupName <String> -Location <String> -VirtualNetworkId <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-IfNoneMatch <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a DNS resolver. + +## EXAMPLES + +### Example 1: Create a DNS resolver +```powershell +New-AzDnsResolver -Name sampleResolver -ResourceGroupName powershell-test-rg -VirtualNetworkId /subscriptions/0e5a46b1-de0b-4ec3-a5d7-dda908b4e076/resourceGroups/powershell-test-08b4e076/resourceGroups/powershell-test-rg/providers/Microsoft.Network/virtualNetworks/psvirtualnetworkname16y71mjc -Location westus2 +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 sampleResolver Microsoft.Network/dnsResolvers "000027d5-0000-0800-0000-6040150e0000" +``` + +This cmdlet creates a DNS resolver. + +### Example 2: Create a DNS resolver with tag +```powershell +New-AzDnsResolver -Name sampleResolver -ResourceGroupName powershell-test-rg -VirtualNetworkId /subscriptions/0e5a46b1-de0b-4ec3-a5d7-dda908b4e076/resourceGroups/powershell-test-rg/providers/Microsoft.Network/virtualNetworks/psvirtualnetworkname16y71mjc -Location westus2 -Tag @{"key0" = "value0"} +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 sampleResolver Microsoft.Network/dnsResolvers "00008cd5-0000-0800-0000-604016c90000" +``` + +This cmdlet creates a DNS resolver with tag. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. +Other values will be ignored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DnsResolverName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IDnsResolver + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/New-AzDnsResolverIPConfigurationObject.md b/azps-10.1.0/Az.DnsResolver/New-AzDnsResolverIPConfigurationObject.md new file mode 100644 index 0000000000..b8747863db --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/New-AzDnsResolverIPConfigurationObject.md @@ -0,0 +1,101 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/new-azdnsresolveripconfigurationobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsResolverIPConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsResolverIPConfigurationObject.md +--- + +# New-AzDnsResolverIPConfigurationObject + +## SYNOPSIS +Create a in-memory object for IPConfiguration + +## SYNTAX + +``` +New-AzDnsResolverIPConfigurationObject [-PrivateIPAddress <String>] + [-PrivateIPAllocationMethod <IPAllocationMethod>] [-SubnetId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for IPConfiguration + +## EXAMPLES + +### Example 1: Create an IPConfiguration +```powershell +New-AzDnsResolverIPConfigurationObject -PrivateIPAddress 1.1.2.12 -PrivateIPAllocationMethod Dynamic -SubnetId /subscriptions/0e5a46b1-de0b-4ec3-a5d7-dda908b4e076/resourceGroups/powershell-test-rg/providers/Microsoft.Network/virtualNetworks/psvirtualnetworkname44yqt9mb/subnets/pssubnetname44c6v0lr +``` + +```output +PrivateIPAddress PrivateIPAllocationMethod +---------------- ------------------------- +1.1.2.12 Dynamic +``` + +This command creates an IPConfiguration + +## PARAMETERS + +### -PrivateIPAddress +Private IP address of the IP configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIPAllocationMethod +Private IP address allocation method. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Support.IPAllocationMethod +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IPConfiguration + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/New-AzDnsResolverInboundEndpoint.md b/azps-10.1.0/Az.DnsResolver/New-AzDnsResolverInboundEndpoint.md new file mode 100644 index 0000000000..e72d21d5c6 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/New-AzDnsResolverInboundEndpoint.md @@ -0,0 +1,299 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/new-azdnsresolverinboundendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsResolverInboundEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsResolverInboundEndpoint.md +--- + +# New-AzDnsResolverInboundEndpoint + +## SYNOPSIS +Creates or updates an inbound endpoint for a DNS resolver. + +## SYNTAX + +``` +New-AzDnsResolverInboundEndpoint -DnsResolverName <String> -Name <String> -ResourceGroupName <String> + -IPConfiguration <IIPConfiguration[]> -Location <String> [-SubscriptionId <String>] [-IfMatch <String>] + [-IfNoneMatch <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an inbound endpoint for a DNS resolver. + +## EXAMPLES + +### Example 1: Create an Inbound Endpoint for DNS Resolver +```powershell +$ipConfiguration = New-AzDnsResolverIPConfigurationObject -PrivateIPAllocationMethod Dynamic -SubnetId /subscriptions/0e5a46b1-de0b-4ec3-a5d7-dda908b4e076/resourceGroups/powershell-test-rg/providers/Microsoft.Network/virtualNetworks/psvirtualnetworkname31ur3isx/subnets/pssubnetname311tqweg + +New-AzDnsResolverInboundEndpoint -DnsResolverName pstestdnsresolvername -Name sampleInboundEndpoint -ResourceGroupName powershell-test-rg -IPConfiguration $ipConfiguration +``` + +```output +Name Type Etag +---- ---- ---- +sampleInboundEndpoint Microsoft.Network/dnsResolvers/inboundEndpoints "0b008451-0000-0800-0000-60402b960000" +``` + +This command creates an Inbound Endpoint for DNS Resolver. + +### Example 2: Create an Inbound Endpoint for DNS Resolver with Tag +```powershell +New-AzDnsResolverInboundEndpoint -DnsResolverName pstestdnsresolvername -Name sampleInboundEndpoint1 -ResourceGroupName powershell-test-rg -IPConfiguration $ipConfiguration -Tag @{"key0" = "value0"} +``` + +```output +Name Type Etag +---- ---- ---- +sampleInboundEndpoint1 Microsoft.Network/dnsResolvers/inboundEndpoints "0b0071aa-0000-0800-0000-60406a2d0000" +``` + +This command creates an Inbound Endpoint for DNS Resolver with Tag. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsResolverName +The name of the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. +Other values will be ignored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPConfiguration +IP configurations for the inbound endpoint. +To construct, see NOTES section for IPCONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IIPConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the inbound endpoint for the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: InboundEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IInboundEndpoint + +## 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. + + +`IPCONFIGURATION <IIPConfiguration[]>`: IP configurations for the inbound endpoint. + - `SubnetId <String>`: Resource ID. + - `[PrivateIPAddress <String>]`: Private IP address of the IP configuration. + - `[PrivateIPAllocationMethod <IPAllocationMethod?>]`: Private IP address allocation method. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/New-AzDnsResolverOutboundEndpoint.md b/azps-10.1.0/Az.DnsResolver/New-AzDnsResolverOutboundEndpoint.md new file mode 100644 index 0000000000..b10d640242 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/New-AzDnsResolverOutboundEndpoint.md @@ -0,0 +1,285 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/new-azdnsresolveroutboundendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsResolverOutboundEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsResolverOutboundEndpoint.md +--- + +# New-AzDnsResolverOutboundEndpoint + +## SYNOPSIS +Creates or updates an outbound endpoint for a DNS resolver. + +## SYNTAX + +``` +New-AzDnsResolverOutboundEndpoint -DnsResolverName <String> -Name <String> -ResourceGroupName <String> + -Location <String> -SubnetId <String> [-SubscriptionId <String>] [-IfMatch <String>] [-IfNoneMatch <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an outbound endpoint for a DNS resolver. + +## EXAMPLES + +### Example 1: Create an outbound endpoint +```powershell +New-AzDnsResolverOutboundEndpoint -DnsResolverName sampleResolver -Name sampleOutboundEndpoint -ResourceGroupName powershell-test-rg -SubscriptionId ea40042d-63d8-4d02-9261-fb31450e6c67 -SubnetId "/subscriptions/0e5a46b1-de0b-4ec3-a5d7-dda908b4e076/resourceGroups/powershell-test-08b4e076/resourceGroups/powershell-test-rg/providers/Microsoft.Network/virtualNetworks/psvirtualnetworkname16y71mjc/subnets/test-subnet" -Location westus2 +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 sampleOutboundEndpoint Microsoft.Network/dnsResolvers/outboundEndpoints "0a009902-0000-0800-0000-60e378030000" +``` + +This cmdlet creates an outbound endpoint. + +### Example 2: Create an outbound endpoint with tag +```powershell +New-AzDnsResolverOutboundEndpoint -DnsResolverName sampleResolver -Name sampleOutboundEndpoint -ResourceGroupName powershell-test-rg -SubscriptionId ea40042d-63d8-4d02-9261-fb31450e6c67 -SubnetId "/subscriptions/0e5a46b1-de0b-4ec3-a5d7-dda908b4e076/resourceGroups/powershell-test-08b4e076/resourceGroups/powershell-test-rg/providers/Microsoft.Network/virtualNetworks/psvirtualnetworkname16y71mjc/subnets/test-subnet" -Location westus2 -Tag @{"key0" = "value0"} +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 sampleOutboundEndpoint Microsoft.Network/dnsResolvers/outboundEndpoints "0a009902-0000-0800-0000-60e378030000" +``` + +This cmdlet creates an outbound endpoint. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsResolverName +The name of the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. +Other values will be ignored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the outbound endpoint for the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: OutboundEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IOutboundEndpoint + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/New-AzDnsResolverTargetDnsServerObject.md b/azps-10.1.0/Az.DnsResolver/New-AzDnsResolverTargetDnsServerObject.md new file mode 100644 index 0000000000..7208bae1a7 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/New-AzDnsResolverTargetDnsServerObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/new-azdnsresolvertargetdnsserverobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsResolverTargetDnsServerObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/New-AzDnsResolverTargetDnsServerObject.md +--- + +# New-AzDnsResolverTargetDnsServerObject + +## SYNOPSIS +Create a in-memory object for Target DNS server + +## SYNTAX + +``` +New-AzDnsResolverTargetDnsServerObject [-IPAddress <String>] [-Port <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for Target DNS server + +## EXAMPLES + +### Example 1: Create an Target DNS server +```powershell +New-AzDnsResolverIPConfigurationObject -PrivateIPAddress 10.0.0.3 -PrivateIPAllocationMethod Dynamic -SubnetId /subscriptions/ea40042d-63d8-4d02-9261-fb31450e6c67/resourceGroups/sampleRG/providers/Microsoft.Network/virtualNetworks/vnet-hub/subnets/test-subnet +``` + +```output +PrivateIPAddress PrivateIPAllocationMethod +---------------- ------------------------- +1.1.2.12 Dynamic +``` + +This command creates an target DNS server. + +## PARAMETERS + +### -IPAddress +DNS server IP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +DNS server port. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.TargetDnsServer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Remove-AzDnsForwardingRuleset.md b/azps-10.1.0/Az.DnsResolver/Remove-AzDnsForwardingRuleset.md new file mode 100644 index 0000000000..54fd18dd90 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Remove-AzDnsForwardingRuleset.md @@ -0,0 +1,259 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/remove-azdnsforwardingruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Remove-AzDnsForwardingRuleset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Remove-AzDnsForwardingRuleset.md +--- + +# Remove-AzDnsForwardingRuleset + +## SYNOPSIS +Deletes a DNS forwarding ruleset. +WARNING: This operation cannot be undone. +All forwarding rules within the ruleset will be deleted. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDnsForwardingRuleset -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IfMatch <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDnsForwardingRuleset -InputObject <IDnsResolverIdentity> [-IfMatch <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a DNS forwarding ruleset. +WARNING: This operation cannot be undone. +All forwarding rules within the ruleset will be deleted. + +## EXAMPLES + +### Example 1: Remove an DNS forwarding ruleset by name. +```powershell +Remove-AzDnsForwardingRuleset -Name dnsForwardingRulset -ResourceGroupName sampleRG +``` + +This command removes a DNS forwarding ruleset by name. + +### Example 2: Remove a DNS forwarding ruleset by identity +```powershell +$dnsResolverDnsForwardingRulesetObject = Get-AzDnsForwardingRuleset -Name dnsForwardingRuleset -ResourceGroupName sampleRG +Remove-AzDnsForwardingRuleset -InputObject $dnsResolverDnsForwardingRulesetObject +``` + +This command removes a DNS forwarding ruleset by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the DNS forwarding ruleset. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DnsForwardingRulesetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Remove-AzDnsForwardingRulesetForwardingRule.md b/azps-10.1.0/Az.DnsResolver/Remove-AzDnsForwardingRulesetForwardingRule.md new file mode 100644 index 0000000000..7af72a755a --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Remove-AzDnsForwardingRulesetForwardingRule.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/remove-azdnsforwardingrulesetforwardingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Remove-AzDnsForwardingRulesetForwardingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Remove-AzDnsForwardingRulesetForwardingRule.md +--- + +# Remove-AzDnsForwardingRulesetForwardingRule + +## SYNOPSIS +Deletes a forwarding rule in a DNS forwarding ruleset. +WARNING: This operation cannot be undone. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-IfMatch <String>] [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDnsForwardingRulesetForwardingRule -InputObject <IDnsResolverIdentity> [-IfMatch <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a forwarding rule in a DNS forwarding ruleset. +WARNING: This operation cannot be undone. + +## EXAMPLES + +### Example 1: Remove forwarding rule by name +```powershell +Remove-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName sampleForwardingRuleset -Name sampleForwardingRule -ResourceGroupName powershell-test-rg +``` + +This command removes forwarding rule by name + +### Example 2: Remove forwarding rule via identity +```powershell +$inputobject = Get-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName DnsResolverName -ResourceGroupName sampleRG -Name forwardingRule + +Remove-AzDnsForwardingRulesetForwardingRule -InputObject $inputObject +``` + +This command removes forwarding rule via identity + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsForwardingRulesetName +The name of the DNS forwarding ruleset. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the forwarding rule. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ForwardingRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Remove-AzDnsForwardingRulesetVirtualNetworkLink.md b/azps-10.1.0/Az.DnsResolver/Remove-AzDnsForwardingRulesetVirtualNetworkLink.md new file mode 100644 index 0000000000..c2dc7ce0d1 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Remove-AzDnsForwardingRulesetVirtualNetworkLink.md @@ -0,0 +1,272 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/remove-azdnsforwardingrulesetvirtualnetworklink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Remove-AzDnsForwardingRulesetVirtualNetworkLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Remove-AzDnsForwardingRulesetVirtualNetworkLink.md +--- + +# Remove-AzDnsForwardingRulesetVirtualNetworkLink + +## SYNOPSIS +Deletes a virtual network link to a DNS forwarding ruleset. +WARNING: This operation cannot be undone. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDnsForwardingRulesetVirtualNetworkLink -DnsForwardingRulesetName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-IfMatch <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDnsForwardingRulesetVirtualNetworkLink -InputObject <IDnsResolverIdentity> [-IfMatch <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a virtual network link to a DNS forwarding ruleset. +WARNING: This operation cannot be undone. + +## EXAMPLES + +### Example 1: Remove an virtual network link by name. +```powershell +Remove-AzDnsForwardingRulesetVirtualNetworkLink -DnsForwardingRulesetName dnsForwardingRuleset -Name sampleVnetLink -ResourceGroupName sampleRG +``` + +This command removes an virtual network link by name. + +### Example 2: Remove an virtual network link by identity +```powershell +$inputObject = Get-AzDnsForwardingRulesetVirtualNetworkLink -DnsForwardingRulesetName pstestdnsresolvername -Name samplevnetLink1 -ResourceGroupName powershell-test-rg +Remove-AzDnsForwardingRulesetVirtualNetworkLink -InputObject $inputObject +``` + +This command removes an virtual network link by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsForwardingRulesetName +The name of the DNS forwarding ruleset. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network link. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: VirtualNetworkLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Remove-AzDnsResolver.md b/azps-10.1.0/Az.DnsResolver/Remove-AzDnsResolver.md new file mode 100644 index 0000000000..9c772f5f55 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Remove-AzDnsResolver.md @@ -0,0 +1,256 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/remove-azdnsresolver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Remove-AzDnsResolver.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Remove-AzDnsResolver.md +--- + +# Remove-AzDnsResolver + +## SYNOPSIS +Deletes a DNS resolver. +WARNING: This operation cannot be undone. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDnsResolver -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-IfMatch <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDnsResolver -InputObject <IDnsResolverIdentity> [-IfMatch <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a DNS resolver. +WARNING: This operation cannot be undone. + +## EXAMPLES + +### Example 1: Remove a DNS Resolver by name +```powershell +Remove-AzDnsResolver -ResourceGroupName powershell-test-rg -Name psdnsresolvername33nmy1fz +``` + +This command removes a DNS Resolver by name. + +### Example 2: Remove a DNS Resolver by identity +```powershell +$dnsResolverObject = Get-AzDnsResolver -ResourceGroupName powershell-test-rg -Name psdnsresolvername33nmy1fz +Remove-AzDnsResolver -InputObject $dnsResolverObject +``` + +This command removes a DNS Resolver by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DnsResolverName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Remove-AzDnsResolverInboundEndpoint.md b/azps-10.1.0/Az.DnsResolver/Remove-AzDnsResolverInboundEndpoint.md new file mode 100644 index 0000000000..4e7f43997e --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Remove-AzDnsResolverInboundEndpoint.md @@ -0,0 +1,273 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/remove-azdnsresolverinboundendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Remove-AzDnsResolverInboundEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Remove-AzDnsResolverInboundEndpoint.md +--- + +# Remove-AzDnsResolverInboundEndpoint + +## SYNOPSIS +Deletes an inbound endpoint for a DNS resolver. +WARNING: This operation cannot be undone. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDnsResolverInboundEndpoint -DnsResolverName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDnsResolverInboundEndpoint -InputObject <IDnsResolverIdentity> [-IfMatch <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an inbound endpoint for a DNS resolver. +WARNING: This operation cannot be undone. + +## EXAMPLES + +### Example 1: Remove Inbound Endpoint by name +```powershell +Remove-AzDnsResolverInboundEndpoint -DnsResolverName pstestdnsresolvername -Name sampleInboundEndpoint -ResourceGroupName powershell-test-rg +``` + +This command removes Inbound Endpoint by name + +### Example 2: Remove Inbound Endpoint via identity +```powershell +$inputobject = Get-AzDnsResolverInboundEndpoint -DnsResolverName pstestdnsresolvername -Name sampleInboundEndpoint -ResourceGroupName powershell-test-rg + +Remove-AzDnsResolverInboundEndpoint -InputObject $inputObject +``` + +This command removes Inbound Endpoint via identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsResolverName +The name of the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the inbound endpoint for the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: InboundEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Remove-AzDnsResolverOutboundEndpoint.md b/azps-10.1.0/Az.DnsResolver/Remove-AzDnsResolverOutboundEndpoint.md new file mode 100644 index 0000000000..5abd48e372 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Remove-AzDnsResolverOutboundEndpoint.md @@ -0,0 +1,272 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/remove-azdnsresolveroutboundendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Remove-AzDnsResolverOutboundEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Remove-AzDnsResolverOutboundEndpoint.md +--- + +# Remove-AzDnsResolverOutboundEndpoint + +## SYNOPSIS +Deletes an outbound endpoint for a DNS resolver. +WARNING: This operation cannot be undone. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDnsResolverOutboundEndpoint -DnsResolverName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDnsResolverOutboundEndpoint -InputObject <IDnsResolverIdentity> [-IfMatch <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an outbound endpoint for a DNS resolver. +WARNING: This operation cannot be undone. + +## EXAMPLES + +### Example 1: Remove an outbound endpoint by name. +```powershell +Remove-AzDnsResolverOutboundEndpoint -DnsResolverName sampleResolver -ResourceGroupName powershell-test-rg -Name psdnsresolvername33nmy1fz +``` + +This command removes an outbound endpoint by name. + +### Example 2: Remove an outbound endpoint by identity +```powershell +$inputObject = Get-AzDnsResolverOutboundEndpoint -DnsResolverName sampleResolver -Name sampleOutbound -ResourceGroupName sampleResourceGroup +Remove-AzDnsResolverOutboundEndpoint -InputObject $inputObject +``` + +This command removes an outbound endpoint by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsResolverName +The name of the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the outbound endpoint for the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: OutboundEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Update-AzDnsForwardingRuleset.md b/azps-10.1.0/Az.DnsResolver/Update-AzDnsForwardingRuleset.md new file mode 100644 index 0000000000..1dc2f3c90a --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Update-AzDnsForwardingRuleset.md @@ -0,0 +1,287 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/update-azdnsforwardingruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Update-AzDnsForwardingRuleset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Update-AzDnsForwardingRuleset.md +--- + +# Update-AzDnsForwardingRuleset + +## SYNOPSIS +Updates a DNS forwarding ruleset. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDnsForwardingRuleset -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IfMatch <String>] [-DnsResolverOutboundEndpoint <ISubResource[]>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDnsForwardingRuleset -InputObject <IDnsResolverIdentity> [-IfMatch <String>] + [-DnsResolverOutboundEndpoint <ISubResource[]>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a DNS forwarding ruleset. + +## EXAMPLES + +### Example 1: Update DNS Forwarding ruleset by name (adding tag) +```powershell +Update-AzDnsForwardingRuleset -Name dnsForwardingRuleset -ResourceGroupName sampleRG -Tag @{"key0" = "value0"} +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "04005592-0000-0800-0000-60e7ec170000" +``` + +This command updates DNS Forwarding ruleset by name (adding tag) + +### Example 2: Updates an existing DNS Forwarding ruleset by identity +```powershell +$inputObject = Get-AzDnsForwardingRuleset -ResourceGroupName powershell-test-rg -Name dnsForwardingRuleset +Update-AzDnsForwardingRuleset -InputObject $inputObject -Tag @{"key0" = "value0"} +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 dnsForwardingRuleset Microsoft.Network/dnsForwardingRulesets "04005592-0000-0800-0000-60e7ec170000" +``` + +This command updates DNS Forwarding ruleset via identity (adding tag) + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsResolverOutboundEndpoint +The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers. +To construct, see NOTES section for DNSRESOLVEROUTBOUNDENDPOINT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.ISubResource[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the DNS forwarding ruleset. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: DnsForwardingRulesetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags for DNS Resolver. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IDnsForwardingRuleset + +## 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. + + +`DNSRESOLVEROUTBOUNDENDPOINT <ISubResource[]>`: The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers. + - `Id <String>`: Resource ID. + +`INPUTOBJECT <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Update-AzDnsForwardingRulesetForwardingRule.md b/azps-10.1.0/Az.DnsResolver/Update-AzDnsForwardingRulesetForwardingRule.md new file mode 100644 index 0000000000..aeb768ffd5 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Update-AzDnsForwardingRulesetForwardingRule.md @@ -0,0 +1,289 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/update-azdnsforwardingrulesetforwardingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Update-AzDnsForwardingRulesetForwardingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Update-AzDnsForwardingRulesetForwardingRule.md +--- + +# Update-AzDnsForwardingRulesetForwardingRule + +## SYNOPSIS +Updates a forwarding rule in a DNS forwarding ruleset. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-IfMatch <String>] + [-ForwardingRuleState <ForwardingRuleState>] [-Metadata <Hashtable>] [-TargetDnsServer <ITargetDnsServer[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDnsForwardingRulesetForwardingRule -InputObject <IDnsResolverIdentity> [-IfMatch <String>] + [-ForwardingRuleState <ForwardingRuleState>] [-Metadata <Hashtable>] [-TargetDnsServer <ITargetDnsServer[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a forwarding rule in a DNS forwarding ruleset. + +## EXAMPLES + +### Example 1: Update forwarding rule by name (adding metadata) +```powershell +Update-AzDnsForwardingRulesetForwardingRule -DnsForwardingRulesetName dnsForwardingRuleset -Name sampleForwardingRule -ResourceGroupName sampleRG -Metadata @{"key0" = "value0"} +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 forwardingRule Microsoft.Network/dnsForwardingRulesets/forwardingRule "04005592-0000-0800-0000-60e7ec170000" +``` + +This command updates forwarding rule by name (adding metadata) + +### Example 2: Updates a forwarding rule by identity +```powershell +$inputObject = Get-AzDnsForwardingRulesetForwardingRule -ResourceGroupName powershell-test-rg -DnsForwardingRulesetName dnsForwardingRuleset -Name sampleForwardingRule +Update-AzDnsForwardingRulesetForwardingRule -InputObject $inputObject -Metadata @{"value0" = "value1"} +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 forwardingRule Microsoft.Network/dnsForwardingRulesets/forwardingRule "04005592-0000-0800-0000-60e7ec170000" +``` + +This command updates forwarding rule via identity (adding metadata) + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsForwardingRulesetName +The name of the DNS forwarding ruleset. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingRuleState +The state of forwarding rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Support.ForwardingRuleState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Metadata +Metadata attached to the forwarding rule. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the forwarding rule. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ForwardingRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDnsServer +DNS servers to forward the DNS query to. +To construct, see NOTES section for TARGETDNSSERVER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.ITargetDnsServer[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IForwardingRule + +## 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 <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +`TARGETDNSSERVER <ITargetDnsServer[]>`: DNS servers to forward the DNS query to. + - `IPAddress <String>`: DNS server IP address. + - `[Port <Int32?>]`: DNS server port. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Update-AzDnsForwardingRulesetVirtualNetworkLink.md b/azps-10.1.0/Az.DnsResolver/Update-AzDnsForwardingRulesetVirtualNetworkLink.md new file mode 100644 index 0000000000..4ea2ff04ca --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Update-AzDnsForwardingRulesetVirtualNetworkLink.md @@ -0,0 +1,283 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/update-azdnsforwardingrulesetvirtualnetworklink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Update-AzDnsForwardingRulesetVirtualNetworkLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Update-AzDnsForwardingRulesetVirtualNetworkLink.md +--- + +# Update-AzDnsForwardingRulesetVirtualNetworkLink + +## SYNOPSIS +Updates a virtual network link to a DNS forwarding ruleset. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDnsForwardingRulesetVirtualNetworkLink -DnsForwardingRulesetName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-IfMatch <String>] [-Metadata <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDnsForwardingRulesetVirtualNetworkLink -InputObject <IDnsResolverIdentity> [-IfMatch <String>] + [-Metadata <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates a virtual network link to a DNS forwarding ruleset. + +## EXAMPLES + +### Example 1: Update virtual network link by name (adding metadata) +```powershell +Update-AzDnsForwardingRulesetVirtualNetworkLink -DnsForwardingRulesetName sampleDnsForwardingRuleset -Name sampleVnetLink -Metadata @{"value0" = "value1"} +``` + +```output +Name Type Etag +---- ---- ---- +sampleVnetLink Microsoft.Network/dnsForwardingRuleset/virtualNetworkLinks "02001eab-0000-0800-0000-60e792500000" +``` + +This command updates virtual network link by name (adding metadata) + +### Example 2: Update virtual network link via identity (adding metadata) +```powershell +$inputObject = Get-AzDnsForwardingRulesetVirtualNetworkLink -DnsForwardingRulesetName pstestdnsresolvername -Name samplevnetLink1 -ResourceGroupName powershell-test-rg +Update-AzDnsForwardingRulesetVirtualNetworkLink -InputObject $inputObject -Metadata @{"value0" = "value1"} +``` + +```output +Name Type Etag +---- ---- ---- +sampleVnetLink Microsoft.Network/dnsForwardingRuleset/virtualNetworkLinks "02001eab-0000-0800-0000-60e792500000" +``` + +This command updates virtual network link via identity (adding metadata) + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsForwardingRulesetName +The name of the DNS forwarding ruleset. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Metadata +Metadata attached to the virtual network link. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network link. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: VirtualNetworkLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IVirtualNetworkLink + +## 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 <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Update-AzDnsResolver.md b/azps-10.1.0/Az.DnsResolver/Update-AzDnsResolver.md new file mode 100644 index 0000000000..37bc26a401 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Update-AzDnsResolver.md @@ -0,0 +1,266 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/update-azdnsresolver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Update-AzDnsResolver.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Update-AzDnsResolver.md +--- + +# Update-AzDnsResolver + +## SYNOPSIS +Updates a DNS resolver. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDnsResolver -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-IfMatch <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDnsResolver -InputObject <IDnsResolverIdentity> [-IfMatch <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a DNS resolver. + +## EXAMPLES + +### Example 1: Update an existing DNS Resolver by name +```powershell +Update-AzDnsResolver -ResourceGroupName powershell-test-rg -Name psdnsresolvername33nmy1fz -Tag @{"key0" = "value0"} +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 psdnsresolvername33nmy1fz Microsoft.Network/dnsResolvers "0000efd6-0000-0800-0000-60401c7c0000" +``` + +This command updates an existing DNS Resolver by name ( adding tag ). + +### Example 2: Updates an existing DNS Resolver by identity +```powershell +$dnsResolverObject = Get-AzDnsResolver -ResourceGroupName powershell-test-rg -Name psdnsresolvername33nmy1fz +Update-AzDnsResolver -InputObject $dnsResolverObject -Tag @{} +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +westus2 psdnsresolvername33nmy1fz Microsoft.Network/dnsResolvers "0000efd6-0000-0800-0000-60401c7c0000" +``` + +This command updates an existing DNS Resolver by identity ( removing tag ). + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: DnsResolverName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags for DNS Resolver. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IDnsResolver + +## 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 <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Update-AzDnsResolverInboundEndpoint.md b/azps-10.1.0/Az.DnsResolver/Update-AzDnsResolverInboundEndpoint.md new file mode 100644 index 0000000000..8218143921 --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Update-AzDnsResolverInboundEndpoint.md @@ -0,0 +1,282 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/update-azdnsresolverinboundendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Update-AzDnsResolverInboundEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Update-AzDnsResolverInboundEndpoint.md +--- + +# Update-AzDnsResolverInboundEndpoint + +## SYNOPSIS +Updates an inbound endpoint for a DNS resolver. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDnsResolverInboundEndpoint -DnsResolverName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDnsResolverInboundEndpoint -InputObject <IDnsResolverIdentity> [-IfMatch <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an inbound endpoint for a DNS resolver. + +## EXAMPLES + +### Example 1: Update Inbound Endpoint by name (adding tag) +```powershell +Update-AzDnsResolverInboundEndpoint -DnsResolverName pstestdnsresolvername -Name sampleInboundEndpoint -ResourceGroupName powershell-test-rg -Tag @{"value0" = "value1"} +``` + +```output +Name Type Etag +---- ---- ---- +sampleInboundEndpoint Microsoft.Network/dnsResolvers/inboundEndpoints "0c000868-0000-0800-0000-604112230000" +``` + +This command updates Inbound Endpoint by name (adding tag) + +### Example 2: Update Inbound Endpoint via identity (adding tag) +```powershell +$inputobject = Get-AzDnsResolverInboundEndpoint -DnsResolverName pstestdnsresolvername -Name sampleInboundEndpoint -ResourceGroupName powershell-test-rg +Update-AzDnsResolverInboundEndpoint -InputObject $inputobject -Tag @{"value0" = "value1"} +``` + +```output +Name Type Etag +---- ---- ---- +sampleInboundEndpoint Microsoft.Network/dnsResolvers/inboundEndpoints "0c00e768-0000-0800-0000-604112af0000" +``` + +This command updates Inbound Endpoint via identity (adding tag) + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsResolverName +The name of the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the inbound endpoint for the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: InboundEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags for inbound endpoint. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IInboundEndpoint + +## 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 <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DnsResolver/Update-AzDnsResolverOutboundEndpoint.md b/azps-10.1.0/Az.DnsResolver/Update-AzDnsResolverOutboundEndpoint.md new file mode 100644 index 0000000000..91d5f67a6d --- /dev/null +++ b/azps-10.1.0/Az.DnsResolver/Update-AzDnsResolverOutboundEndpoint.md @@ -0,0 +1,282 @@ +--- +external help file: +Module Name: Az.DnsResolver +online version: https://learn.microsoft.com/powershell/module/az.dnsresolver/update-azdnsresolveroutboundendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Update-AzDnsResolverOutboundEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DnsResolver/help/Update-AzDnsResolverOutboundEndpoint.md +--- + +# Update-AzDnsResolverOutboundEndpoint + +## SYNOPSIS +Updates an outbound endpoint for a DNS resolver. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDnsResolverOutboundEndpoint -DnsResolverName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDnsResolverOutboundEndpoint -InputObject <IDnsResolverIdentity> [-IfMatch <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an outbound endpoint for a DNS resolver. + +## EXAMPLES + +### Example 1: Update Outbound Endpoint by name (adding tag) +```powershell +Update-AzDnsResolverOutboundEndpoint -DnsResolverName sampleResolver -Name sampleOutbound -ResourceGroupName sampleResourceGroup -Tag @{"value0" = "value1"} +``` + +```output +Name Type Etag +---- ---- ---- +sampleOutbound Microsoft.Network/dnsResolvers/outboundEndpoints "02001eab-0000-0800-0000-60e792500000" +``` + +This command updates Outbound Endpoint by name (adding tag) + +### Example 2: Update Outbound Endpoint via identity (adding tag) +```powershell +$inputObject = Get-AzDnsResolverOutboundEndpoint -DnsResolverName sampleResolver -Name sampleOutbound -ResourceGroupName sampleResourceGroup +Update-AzDnsResolverOutboundEndpoint -InputObject $inputObject -Tag @{"value0" = "value1"} +``` + +```output +Name Type Etag +---- ---- ---- +sampleOutbound Microsoft.Network/dnsResolvers/outboundEndpoints "02001eab-0000-0800-0000-60e792500000" +``` + +This command updates Outbound Endpoint via identity (adding tag) + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsResolverName +The name of the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the resource. +Omit this value to always overwrite the current resource. +Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the outbound endpoint for the DNS resolver. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: OutboundEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags for outbound endpoint. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.IDnsResolverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DnsResolver.Models.Api20220701.IOutboundEndpoint + +## 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 <IDnsResolverIdentity>`: Identity Parameter + - `[DnsForwardingRulesetName <String>]`: The name of the DNS forwarding ruleset. + - `[DnsResolverName <String>]`: The name of the DNS resolver. + - `[ForwardingRuleName <String>]`: The name of the forwarding rule. + - `[Id <String>]`: Resource identity path + - `[InboundEndpointName <String>]`: The name of the inbound endpoint for the DNS resolver. + - `[OutboundEndpointName <String>]`: The name of the outbound endpoint for the DNS resolver. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkLinkName <String>]`: The name of the virtual network link. + - `[VirtualNetworkName <String>]`: The name of the virtual network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/Az.DynatraceObservability.md b/azps-10.1.0/Az.DynatraceObservability/Az.DynatraceObservability.md new file mode 100644 index 0000000000..84b5941dee --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Az.DynatraceObservability.md @@ -0,0 +1,66 @@ +--- +Module Name: Az.DynatraceObservability +Module Guid: f889aadf-56ba-485c-8077-283219e39439 +Download Help Link: https://learn.microsoft.com/powershell/module/az.dynatraceobservability +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Az.DynatraceObservability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Az.DynatraceObservability.md +--- + +# Az.DynatraceObservability Module +## Description +Microsoft Azure PowerShell: DynatraceObservability cmdlets + +## Az.DynatraceObservability Cmdlets +### [Get-AzDynatraceMonitor](Get-AzDynatraceMonitor.md) +Get a MonitorResource + +### [Get-AzDynatraceMonitorAppService](Get-AzDynatraceMonitorAppService.md) +Gets list of App Services with Dynatrace PaaS OneAgent enabled + +### [Get-AzDynatraceMonitoredResource](Get-AzDynatraceMonitoredResource.md) +List the resources currently being monitored by the Dynatrace monitor resource. + +### [Get-AzDynatraceMonitorHost](Get-AzDynatraceMonitorHost.md) +List the compute resources currently being monitored by the Dynatrace resource. + +### [Get-AzDynatraceMonitorLinkableEnv](Get-AzDynatraceMonitorLinkableEnv.md) +Gets all the Dynatrace environments that a user can link a azure resource to + +### [Get-AzDynatraceMonitorSSOConfig](Get-AzDynatraceMonitorSSOConfig.md) +Get a DynatraceSingleSignOnResource + +### [Get-AzDynatraceMonitorSSODetail](Get-AzDynatraceMonitorSSODetail.md) +Gets the SSO configuration details from the partner. + +### [Get-AzDynatraceMonitorTagRule](Get-AzDynatraceMonitorTagRule.md) +Get a TagRule + +### [Get-AzDynatraceMonitorVMHostPayload](Get-AzDynatraceMonitorVMHostPayload.md) +Returns the payload that needs to be passed in the request body for installing Dynatrace agent on a VM. + +### [New-AzDynatraceMonitor](New-AzDynatraceMonitor.md) +Create a MonitorResource + +### [New-AzDynatraceMonitorFilteringTagObject](New-AzDynatraceMonitorFilteringTagObject.md) +Create an in-memory object for FilteringTag. + +### [New-AzDynatraceMonitorSSOConfig](New-AzDynatraceMonitorSSOConfig.md) +Create a DynatraceSingleSignOnResource + +### [New-AzDynatraceMonitorTagRule](New-AzDynatraceMonitorTagRule.md) +Create a TagRule + +### [Remove-AzDynatraceMonitor](Remove-AzDynatraceMonitor.md) +Delete a MonitorResource + +### [Remove-AzDynatraceMonitorTagRule](Remove-AzDynatraceMonitorTagRule.md) +Delete a TagRule + +### [Update-AzDynatraceMonitor](Update-AzDynatraceMonitor.md) +Update a MonitorResource + +### [Update-AzDynatraceMonitorTagRule](Update-AzDynatraceMonitorTagRule.md) +Update a TagRule + diff --git a/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitor.md b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitor.md new file mode 100644 index 0000000000..6cb3b8185c --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitor.md @@ -0,0 +1,206 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/get-azdynatracemonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitor.md +--- + +# Get-AzDynatraceMonitor + +## SYNOPSIS +Get a MonitorResource + +## SYNTAX + +### List (Default) +``` +Get-AzDynatraceMonitor [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDynatraceMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDynatraceMonitor -InputObject <IDynatraceObservabilityIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzDynatraceMonitor -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a MonitorResource + +## EXAMPLES + +### Example 1: List all dynatrace monitors under a subsciption +```powershell +Get-AzDynatraceMonitor +``` + +```output +Name ProvisioningState Location MonitoringStatus SingleSignOnPropertyAadDomain +---- ----------------- -------- ---------------- ----------------------------- +dyob-pwsh01 Succeeded eastus2euap Enabled {mpliftrlogz20210811outlook.onmicrosoft.com} +``` + +This command lists all dynatrace monitors under a subsciption. + +### Example 2: List all dynatrace monitors under the resource group +```powershell +Get-AzDynatraceMonitor -ResourceGroupName dyobrg +``` + +```output +Name ProvisioningState Location MonitoringStatus SingleSignOnPropertyAadDomain +---- ----------------- -------- ---------------- ----------------------------- +dyob-pwsh01 Succeeded eastus2euap Enabled {mpliftrlogz20210811outlook.onmicrosoft.com} +``` + +This command lists all dynatrace monitors under the resource group + +### Example 3: Get a dynatrace monitor +```powershell +Get-AzDynatraceMonitor -ResourceGroupName dyobrg -Name dyob-pwsh01 +``` + +```output +Name ProvisioningState Location MonitoringStatus SingleSignOnPropertyAadDomain +---- ----------------- -------- ---------------- ----------------------------- +dyob-pwsh01 Succeeded eastus2euap Enabled {mpliftrlogz20210811outlook.onmicrosoft.com} +``` + +This command gets a dynatrace monitor. + +### Example 4: Get a dynatrace monitor by pipeline +```powershell +New-AzDynatraceMonitor -ResourceGroupName dyobrg -Name dyob-pwsh01 -Location eastus2euap -UserFirstName 'First' -UserLastName 'Last' -UserEmailAddress 'xxxx@microsoft.com' -PlanUsageType "COMMITTED" -PlanBillingCycle "Monthly" -PlanDetail "azureportalintegration_privatepreview@TIDhjdtn7tfnxcy" -SingleSignOnAadDomain "xxxx.onmicrosoft.com" | Get-AzDynatraceMonitor +``` + +```output +Name ProvisioningState Location MonitoringStatus SingleSignOnPropertyAadDomain +---- ----------------- -------- ---------------- ----------------------------- +dyob-pwsh01 Succeeded eastus2euap Enabled {mpliftrlogz20210811outlook.onmicrosoft.com} +``` + +This command gets a dynatrace monitor by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.IMonitorResource + +## 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 <IDynatraceObservabilityIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Single Sign On Configuration Name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Monitor resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorAppService.md b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorAppService.md new file mode 100644 index 0000000000..552c0262db --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorAppService.md @@ -0,0 +1,112 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/get-azdynatracemonitorappservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorAppService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorAppService.md +--- + +# Get-AzDynatraceMonitorAppService + +## SYNOPSIS +Gets list of App Services with Dynatrace PaaS OneAgent enabled + +## SYNTAX + +``` +Get-AzDynatraceMonitorAppService -MonitorName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets list of App Services with Dynatrace PaaS OneAgent enabled + +## EXAMPLES + +### Example 1: Gets list of App Services with Dynatrace PaaS OneAgent enabled +```powershell +Get-AzDynatraceMonitorAppService -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 +``` + +This command gets list of App Services with Dynatrace PaaS OneAgent enabled. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.IAppServiceInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorHost.md b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorHost.md new file mode 100644 index 0000000000..319da58a05 --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorHost.md @@ -0,0 +1,112 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/get-azdynatracemonitorhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorHost.md +--- + +# Get-AzDynatraceMonitorHost + +## SYNOPSIS +List the compute resources currently being monitored by the Dynatrace resource. + +## SYNTAX + +``` +Get-AzDynatraceMonitorHost -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List the compute resources currently being monitored by the Dynatrace resource. + +## EXAMPLES + +### Example 1: List the compute resources currently being monitored by the Dynatrace resource +```powershell +Get-AzDynatraceMonitorHost -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 +``` + +This command lists the compute resources currently being monitored by the Dynatrace resource. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.IVMInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorLinkableEnv.md b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorLinkableEnv.md new file mode 100644 index 0000000000..9cd9851235 --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorLinkableEnv.md @@ -0,0 +1,158 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/get-azdynatracemonitorlinkableenv +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorLinkableEnv.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorLinkableEnv.md +--- + +# Get-AzDynatraceMonitorLinkableEnv + +## SYNOPSIS +Gets all the Dynatrace environments that a user can link a azure resource to + +## SYNTAX + +``` +Get-AzDynatraceMonitorLinkableEnv -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Region <String>] [-TenantId <String>] [-UserPrincipal <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets all the Dynatrace environments that a user can link a azure resource to + +## EXAMPLES + +### Example 1: Gets all the Dynatrace environments that a user can link a azure resource +```powershell +Get-AzDynatraceMonitorLinkableEnv -ResourceGroupName dyobrg -Name dyob-pwsh01 -Region 'East US' -UserPrincipal 'user@microsoft.com' -TenantId 'xxxxxxxx-xxxxx-xxxx-xxxx-xxxxx' +``` + +This command gets all the Dynatrace environments that a user can link a azure resource. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Region +Azure region in which we want to link the environment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +Tenant Id of the user in which they want to link the environment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipal +user principal id of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.ILinkableEnvironmentResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorSSOConfig.md b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorSSOConfig.md new file mode 100644 index 0000000000..412acbb08f --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorSSOConfig.md @@ -0,0 +1,169 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/get-azdynatracemonitorssoconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorSSOConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorSSOConfig.md +--- + +# Get-AzDynatraceMonitorSSOConfig + +## SYNOPSIS +Get a DynatraceSingleSignOnResource + +## SYNTAX + +### Get (Default) +``` +Get-AzDynatraceMonitorSSOConfig -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDynatraceMonitorSSOConfig -InputObject <IDynatraceObservabilityIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a DynatraceSingleSignOnResource + +## EXAMPLES + +### Example 1: Get a dynatrace SingleSignOn resource +```powershell +Get-AzDynatraceMonitorSSOConfig -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 +``` + +```output +Name ResourceGroupName ProvisioningState SingleSignOnState SingleSignOnUrl +---- ----------------- ----------------- ----------------- --------------- +default dyobrg Succeeded Initial +``` + +This command gets a dynatrace SingleSignOn resource. + +### Example 2: Get a dynatrace SingleSignOn resource by pipeline +```powershell +New-AzDynatraceMonitorSSOConfig -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 -AadDomain "mpliftrlogz20210811outlook.onmicrosoft.com" | Get-AzDynatraceMonitorSSOConfig +``` + +```output +Name ResourceGroupName ProvisioningState SingleSignOnState SingleSignOnUrl +---- ----------------- ----------------- ----------------- --------------- +default dyobrg Succeeded Initial +``` + +This command gets a dynatrace SingleSignOn resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.IDynatraceSingleSignOnResource + +## 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 <IDynatraceObservabilityIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Single Sign On Configuration Name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Monitor resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorSSODetail.md b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorSSODetail.md new file mode 100644 index 0000000000..b8c0b1d03a --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorSSODetail.md @@ -0,0 +1,148 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/get-azdynatracemonitorssodetail +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorSSODetail.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorSSODetail.md +--- + +# Get-AzDynatraceMonitorSSODetail + +## SYNOPSIS +Gets the SSO configuration details from the partner. + +## SYNTAX + +``` +Get-AzDynatraceMonitorSSODetail -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-UserPrincipal <String>] [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the SSO configuration details from the partner. + +## EXAMPLES + +### Example 1: Gets the SSO configuration details from the partner +```powershell +Get-AzDynatraceMonitorSSODetail -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 -UserPrincipal "user@microsoft.com" +``` + +```output +AadDomain AdminUser IsSsoEnabled MetadataUrl SingleSignOnUrl +--------- --------- ------------ ----------- --------------- +{} {v-diya@microsoft.com} Disabled +``` + +This command gets the SSO configuration details from the partner. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipal +user principal id of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.ISsoDetailsResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorTagRule.md b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorTagRule.md new file mode 100644 index 0000000000..0f294ffbb8 --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorTagRule.md @@ -0,0 +1,170 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/get-azdynatracemonitortagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorTagRule.md +--- + +# Get-AzDynatraceMonitorTagRule + +## SYNOPSIS +Get a TagRule + +## SYNTAX + +### Get (Default) +``` +Get-AzDynatraceMonitorTagRule -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDynatraceMonitorTagRule -InputObject <IDynatraceObservabilityIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a TagRule + +## EXAMPLES + +### Example 1: Get a tag rule of the dynatrace monitor +```powershell +Get-AzDynatraceMonitorTagRule -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 +``` + +```output +Name ResourceGroupName ProvisioningState LogRuleSendAadLog +---- ----------------- ----------------- ----------------- +default dyobrg Succeeded Disabled +``` + +This command gets a tag rule of the dynatrace monitor. + +### Example 2: Get a tag rule of the dynatrace monitor by pipeline +```powershell +$tagFilter = New-AzDynatraceMonitorFilteringTagObject -Action 'Include' -Name 'Environment' -Value 'Prod' +New-AzDynatraceMonitorTagRule -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 -LogRuleFilteringTag $tagFilter | Get-AzDynatraceMonitorTagRule +``` + +```output +Name ResourceGroupName ProvisioningState LogRuleSendAadLog +---- ----------------- ----------------- ----------------- +default dyobrg Succeeded Disabled +``` + +This command gets a tag rule of the dynatrace monitor by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.ITagRule + +## 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 <IDynatraceObservabilityIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Single Sign On Configuration Name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Monitor resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorVMHostPayload.md b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorVMHostPayload.md new file mode 100644 index 0000000000..6987e5a89b --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitorVMHostPayload.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/get-azdynatracemonitorvmhostpayload +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorVMHostPayload.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitorVMHostPayload.md +--- + +# Get-AzDynatraceMonitorVMHostPayload + +## SYNOPSIS +Returns the payload that needs to be passed in the request body for installing Dynatrace agent on a VM. + +## SYNTAX + +``` +Get-AzDynatraceMonitorVMHostPayload -MonitorName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns the payload that needs to be passed in the request body for installing Dynatrace agent on a VM. + +## EXAMPLES + +### Example 1: Get the payload that needs to be passed in the request body for installing Dynatrace agent on a VM +```powershell +Get-AzDynatraceMonitorVMHostPayload -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 +``` + +```output +EnvironmentId IngestionKey +------------- ------------ +ihx78752 dt0c01.C3A5JBXDZ4C3SCZDRBJ3D23I.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +This coammnd gets the payload that needs to be passed in the request body for installing Dynatrace agent on a VM. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.IVMExtensionPayload + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitoredResource.md b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitoredResource.md new file mode 100644 index 0000000000..423690dfee --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Get-AzDynatraceMonitoredResource.md @@ -0,0 +1,112 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/get-azdynatracemonitoredresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitoredResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Get-AzDynatraceMonitoredResource.md +--- + +# Get-AzDynatraceMonitoredResource + +## SYNOPSIS +List the resources currently being monitored by the Dynatrace monitor resource. + +## SYNTAX + +``` +Get-AzDynatraceMonitoredResource -MonitorName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List the resources currently being monitored by the Dynatrace monitor resource. + +## EXAMPLES + +### Example 1: List the resources currently being monitored by the Dynatrace monitor resource +```powershell +Get-AzDynatraceMonitoredResource -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 +``` + +This command lists the resources currently being monitored by the Dynatrace monitor resource. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.IMonitoredResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/New-AzDynatraceMonitor.md b/azps-10.1.0/Az.DynatraceObservability/New-AzDynatraceMonitor.md new file mode 100644 index 0000000000..ed1e2ac350 --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/New-AzDynatraceMonitor.md @@ -0,0 +1,580 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/new-azdynatracemonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/New-AzDynatraceMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/New-AzDynatraceMonitor.md +--- + +# New-AzDynatraceMonitor + +## SYNOPSIS +Create a MonitorResource + +## SYNTAX + +``` +New-AzDynatraceMonitor -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-AccountId <String>] [-AccountRegionId <String>] [-EnvironmentId <String>] + [-EnvironmentIngestionKey <String>] [-EnvironmentLandingUrl <String>] + [-EnvironmentLogsIngestionEndpoint <String>] [-EnvironmentUserId <String>] + [-IdentityType <ManagedIdentityType>] [-MarketplaceSubscriptionStatus <MarketplaceSubscriptionStatus>] + [-MonitoringStatus <MonitoringStatus>] [-PlanBillingCycle <String>] [-PlanDetail <String>] + [-PlanEffectiveDate <DateTime>] [-PlanUsageType <String>] [-SingleSignOnAadDomain <String[]>] + [-SingleSignOnEnterpriseAppId <String>] [-SingleSignOnState <SingleSignOnStates>] [-SingleSignOnUrl <String>] + [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] [-UserCountry <String>] [-UserEmailAddress <String>] + [-UserFirstName <String>] [-UserLastName <String>] [-UserPhoneNumber <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a MonitorResource + +## EXAMPLES + +### Example 1: Create a dynatrace monitor +```powershell +New-AzDynatraceMonitor -ResourceGroupName dyobrg -Name dyob-pwsh02 -Location eastus2euap -UserFirstName 'Lucas' -UserLastName 'Yao' -UserEmailAddress 'v-diya@microsoft.com' -PlanUsageType "COMMITTED" -PlanBillingCycle "Monthly" -PlanDetail "azureportalintegration_privatepreview@TIDhjdtn7tfnxcy" -SingleSignOnAadDomain "mpliftrlogz20210811outlook.onmicrosoft.com" +``` + +```output +Name ProvisioningState Location MonitoringStatus SingleSignOnPropertyAadDomain +---- ----------------- -------- ---------------- ----------------------------- +dyob-pwsh02 Succeeded eastus2euap Enabled {mpliftrlogz20210811outlook.onmicrosoft.com} +``` + +This command creates a dynatrace monitor. + +## PARAMETERS + +### -AccountId +Account Id of the account this environment is linked to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountRegionId +Region in which the account 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 +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentId +Id of the environment created + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentIngestionKey +Ingestion key of the environment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentLandingUrl +Landing URL for Dynatrace environment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentLogsIngestionEndpoint +Ingestion endpoint used for sending logs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentUserId +User id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The type of managed identity assigned to this resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.ManagedIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceSubscriptionStatus +Marketplace subscription status. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.MarketplaceSubscriptionStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoringStatus +Status of the monitor. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.MonitoringStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanBillingCycle +different billing cycles like MONTHLY/WEEKLY. +this could be enum + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDetail +plan id as published by Dynatrace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanEffectiveDate +date when plan was applied + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanUsageType +different usage type like PAYG/COMMITTED. +this could be enum + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnAadDomain +array of Aad(azure active directory) domains + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnEnterpriseAppId +Version of the Dynatrace agent installed on the VM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnState +State of Single Sign On + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.SingleSignOnStates +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnUrl +The login URL specific to this Dynatrace Environment + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The identities assigned to this resource by the user. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserCountry +Country of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEmailAddress +Email of the user used by Dynatrace for contacting them if needed + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserFirstName +First Name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLastName +Last Name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPhoneNumber +Phone number of the user used by Dynatrace for contacting them if needed + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.IMonitorResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/New-AzDynatraceMonitorFilteringTagObject.md b/azps-10.1.0/Az.DynatraceObservability/New-AzDynatraceMonitorFilteringTagObject.md new file mode 100644 index 0000000000..db4bdc570a --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/New-AzDynatraceMonitorFilteringTagObject.md @@ -0,0 +1,102 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/new-azdynatracemonitorfilteringtagobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/New-AzDynatraceMonitorFilteringTagObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/New-AzDynatraceMonitorFilteringTagObject.md +--- + +# New-AzDynatraceMonitorFilteringTagObject + +## SYNOPSIS +Create an in-memory object for FilteringTag. + +## SYNTAX + +``` +New-AzDynatraceMonitorFilteringTagObject [-Action <TagAction>] [-Name <String>] [-Value <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for FilteringTag. + +## EXAMPLES + +### Example 1: Create an in-memory object for FilteringTag +```powershell +New-AzDynatraceMonitorFilteringTagObject -Action 'Include' -Name 'Environment' -Value 'Prod' +``` + +```output +Action Name Value +------ ---- ----- +Include Environment Prod +``` + +This command creates an in-memory object for FilteringTag. + +## PARAMETERS + +### -Action +Valid actions for a filtering tag. +Exclusion takes priority over inclusion. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.TagAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name (also known as the key) of the tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The value of the tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.FilteringTag + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/New-AzDynatraceMonitorSSOConfig.md b/azps-10.1.0/Az.DynatraceObservability/New-AzDynatraceMonitorSSOConfig.md new file mode 100644 index 0000000000..6172ec0d47 --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/New-AzDynatraceMonitorSSOConfig.md @@ -0,0 +1,241 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/new-azdynatracemonitorssoconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/New-AzDynatraceMonitorSSOConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/New-AzDynatraceMonitorSSOConfig.md +--- + +# New-AzDynatraceMonitorSSOConfig + +## SYNOPSIS +Create a DynatraceSingleSignOnResource + +## SYNTAX + +``` +New-AzDynatraceMonitorSSOConfig -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AadDomain <String[]>] [-EnterpriseAppId <String>] [-SingleSignOnState <SingleSignOnStates>] + [-SingleSignOnUrl <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a DynatraceSingleSignOnResource + +## EXAMPLES + +### Example 1: Create a dynatrace SingleSignOn resource +```powershell +New-AzDynatraceMonitorSSOConfig -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 -AadDomain "mpliftrlogz20210811outlook.onmicrosoft.com" +``` + +```output +Name ProvisioningState SingleSignOnState SingleSignOnUrl +---- ----------------- ----------------- --------------- +default Succeeded Initial +``` + +This command create a dynatrace SingleSignOn resource. + +## PARAMETERS + +### -AadDomain +array of Aad(azure active directory) domains + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnterpriseAppId +Version of the Dynatrace agent installed on the VM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnState +State of Single Sign On + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.SingleSignOnStates +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnUrl +The login URL specific to this Dynatrace Environment + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.IDynatraceSingleSignOnResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/New-AzDynatraceMonitorTagRule.md b/azps-10.1.0/Az.DynatraceObservability/New-AzDynatraceMonitorTagRule.md new file mode 100644 index 0000000000..fe1591a4fa --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/New-AzDynatraceMonitorTagRule.md @@ -0,0 +1,281 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/new-azdynatracemonitortagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/New-AzDynatraceMonitorTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/New-AzDynatraceMonitorTagRule.md +--- + +# New-AzDynatraceMonitorTagRule + +## SYNOPSIS +Create a TagRule + +## SYNTAX + +``` +New-AzDynatraceMonitorTagRule -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-LogRuleFilteringTag <IFilteringTag[]>] [-LogRuleSendAadLog <SendAadLogsStatus>] + [-LogRuleSendActivityLog <SendActivityLogsStatus>] [-LogRuleSendSubscriptionLog <SendSubscriptionLogsStatus>] + [-MetricRuleFilteringTag <IFilteringTag[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a TagRule + +## EXAMPLES + +### Example 1: Create a tag rule for the dynatrace monitor +```powershell +$tagFilter = New-AzDynatraceMonitorFilteringTagObject -Action 'Include' -Name 'Environment' -Value 'Prod' +New-AzDynatraceMonitorTagRule -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 -LogRuleFilteringTag $tagFilter +``` + +```output +Name ResourceGroupName ProvisioningState LogRuleSendAadLog +---- ----------------- ----------------- ----------------- +default dyobrg Succeeded Disabled +``` + +This command create a tag rule for the dynatrace monitor. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleFilteringTag +List of filtering tags to be used for capturing logs. +This only takes effect if SendActivityLogs flag is enabled. +If empty, all resources will be captured.If only Exclude action is specified, the rules will apply to the list of all available resources. +If Include actions are specified, the rules will only include resources with the associated tags. +To construct, see NOTES section for LOGRULEFILTERINGTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.IFilteringTag[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendAadLog +Flag specifying if AAD logs should be sent for the Monitor resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.SendAadLogsStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendActivityLog +Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.SendActivityLogsStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendSubscriptionLog +Flag specifying if subscription logs should be sent for the Monitor resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.SendSubscriptionLogsStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricRuleFilteringTag +List of filtering tags to be used for capturing metrics. +If empty, all resources will be captured. +If only Exclude action is specified, the rules will apply to the list of all available resources. +If Include actions are specified, the rules will only include resources with the associated tags. +To construct, see NOTES section for METRICRULEFILTERINGTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.IFilteringTag[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.ITagRule + +## 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. + + +`LOGRULEFILTERINGTAG <IFilteringTag[]>`: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured.If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. + - `[Action <TagAction?>]`: Valid actions for a filtering tag. Exclusion takes priority over inclusion. + - `[Name <String>]`: The name (also known as the key) of the tag. + - `[Value <String>]`: The value of the tag. + +`METRICRULEFILTERINGTAG <IFilteringTag[]>`: List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. + - `[Action <TagAction?>]`: Valid actions for a filtering tag. Exclusion takes priority over inclusion. + - `[Name <String>]`: The name (also known as the key) of the tag. + - `[Value <String>]`: The value of the tag. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/Remove-AzDynatraceMonitor.md b/azps-10.1.0/Az.DynatraceObservability/Remove-AzDynatraceMonitor.md new file mode 100644 index 0000000000..7a47c9dc9e --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Remove-AzDynatraceMonitor.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/remove-azdynatracemonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Remove-AzDynatraceMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Remove-AzDynatraceMonitor.md +--- + +# Remove-AzDynatraceMonitor + +## SYNOPSIS +Delete a MonitorResource + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDynatraceMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDynatraceMonitor -InputObject <IDynatraceObservabilityIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a MonitorResource + +## EXAMPLES + +### Example 1: Remove a dynatrace monitor +```powershell +Remove-AzDynatraceMonitor -ResourceGroupName dyobrg -Name dyob-pwsh02 +``` + +This command removes a dynatrace monitor. + +### Example 2: Remove a dynatrace monitor by pipeline +```powershell +Get-AzDynatraceMonitor -ResourceGroupName dyobrg -Name dyob-pwsh02 | Remove-AzDynatraceMonitor +``` + +This command removes a dynatrace monitor by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDynatraceObservabilityIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Single Sign On Configuration Name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Monitor resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/Remove-AzDynatraceMonitorTagRule.md b/azps-10.1.0/Az.DynatraceObservability/Remove-AzDynatraceMonitorTagRule.md new file mode 100644 index 0000000000..47e3f6e261 --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Remove-AzDynatraceMonitorTagRule.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/remove-azdynatracemonitortagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Remove-AzDynatraceMonitorTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Remove-AzDynatraceMonitorTagRule.md +--- + +# Remove-AzDynatraceMonitorTagRule + +## SYNOPSIS +Delete a TagRule + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDynatraceMonitorTagRule -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDynatraceMonitorTagRule -InputObject <IDynatraceObservabilityIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a TagRule + +## EXAMPLES + +### Example 1: Remove a tag rule for the dynatrace monitor +```powershell +Remove-AzDynatraceMonitorTagRule -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 +``` + +This command removes a tag rule for the dynatrace monitor + +### Example 2: Remove a tag rule for the dynatrace monitor by pipeline +```powershell +Get-AzDynatraceMonitorTagRule -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 | Remove-AzDynatraceMonitorTagRule +``` + +This command remove a tag rule for the dynatrace monitor by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +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 <IDynatraceObservabilityIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Single Sign On Configuration Name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Monitor resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/Update-AzDynatraceMonitor.md b/azps-10.1.0/Az.DynatraceObservability/Update-AzDynatraceMonitor.md new file mode 100644 index 0000000000..5af02addeb --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Update-AzDynatraceMonitor.md @@ -0,0 +1,562 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/update-azdynatracemonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Update-AzDynatraceMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Update-AzDynatraceMonitor.md +--- + +# Update-AzDynatraceMonitor + +## SYNOPSIS +Update a MonitorResource + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDynatraceMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AccountId <String>] [-AccountRegionId <String>] [-EnvironmentId <String>] + [-EnvironmentIngestionKey <String>] [-EnvironmentLandingUrl <String>] + [-EnvironmentLogsIngestionEndpoint <String>] [-EnvironmentUserId <String>] + [-MarketplaceSubscriptionStatus <MarketplaceSubscriptionStatus>] [-MonitoringStatus <MonitoringStatus>] + [-PlanBillingCycle <String>] [-PlanDetail <String>] [-PlanEffectiveDate <DateTime>] [-PlanUsageType <String>] + [-SingleSignOnAadDomain <String[]>] [-SingleSignOnEnterpriseAppId <String>] + [-SingleSignOnState <SingleSignOnStates>] [-SingleSignOnUrl <String>] [-Tag <Hashtable>] + [-UserCountry <String>] [-UserEmailAddress <String>] [-UserFirstName <String>] [-UserLastName <String>] + [-UserPhoneNumber <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDynatraceMonitor -InputObject <IDynatraceObservabilityIdentity> [-AccountId <String>] + [-AccountRegionId <String>] [-EnvironmentId <String>] [-EnvironmentIngestionKey <String>] + [-EnvironmentLandingUrl <String>] [-EnvironmentLogsIngestionEndpoint <String>] [-EnvironmentUserId <String>] + [-MarketplaceSubscriptionStatus <MarketplaceSubscriptionStatus>] [-MonitoringStatus <MonitoringStatus>] + [-PlanBillingCycle <String>] [-PlanDetail <String>] [-PlanEffectiveDate <DateTime>] [-PlanUsageType <String>] + [-SingleSignOnAadDomain <String[]>] [-SingleSignOnEnterpriseAppId <String>] + [-SingleSignOnState <SingleSignOnStates>] [-SingleSignOnUrl <String>] [-Tag <Hashtable>] + [-UserCountry <String>] [-UserEmailAddress <String>] [-UserFirstName <String>] [-UserLastName <String>] + [-UserPhoneNumber <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a MonitorResource + +## EXAMPLES + +### Example 1: Update a dynatrace monitor +```powershell +Update-AzDynatraceMonitor -ResourceGroupName dyobrg -Name dyob-pwsh02 -Tag @{'key' = 'test'} +``` + +```output +Name ProvisioningState Location MonitoringStatus SingleSignOnPropertyAadDomain +---- ----------------- -------- ---------------- ----------------------------- +dyob-pwsh02 Succeeded eastus2euap Enabled {mpliftrlogz20210811outlook.onmicrosoft.com} +``` + +This command updates a dynatrace monitor. + +### Example 2: Update a dynatrace monitor by pipeline +```powershell +Get-AzDynatraceMonitor -ResourceGroupName dyobrg -Name dyob-pwsh02 | Update-AzDynatraceMonitor -Tag @{'key' = 'test'} +``` + +```output +Name ProvisioningState Location MonitoringStatus SingleSignOnPropertyAadDomain +---- ----------------- -------- ---------------- ----------------------------- +dyob-pwsh02 Succeeded eastus2euap Enabled {mpliftrlogz20210811outlook.onmicrosoft.com} +``` + +This command updates a dynatrace monitor by pipeline. + +## PARAMETERS + +### -AccountId +Account Id of the account this environment is linked to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountRegionId +Region in which the account 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 +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentId +Id of the environment created + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentIngestionKey +Ingestion key of the environment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentLandingUrl +Landing URL for Dynatrace environment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentLogsIngestionEndpoint +Ingestion endpoint used for sending logs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentUserId +User id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MarketplaceSubscriptionStatus +Marketplace subscription status. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.MarketplaceSubscriptionStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoringStatus +Status of the monitor. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.MonitoringStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanBillingCycle +different billing cycles like MONTHLY/WEEKLY. +this could be enum + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDetail +plan id as published by Dynatrace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanEffectiveDate +date when plan was applied + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanUsageType +different usage type like PAYG/COMMITTED. +this could be enum + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnAadDomain +array of Aad(azure active directory) domains + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnEnterpriseAppId +Version of the Dynatrace agent installed on the VM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnState +State of Single Sign On + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.SingleSignOnStates +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnUrl +The login URL specific to this Dynatrace Environment + +```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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserCountry +Country of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEmailAddress +Email of the user used by Dynatrace for contacting them if needed + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserFirstName +First Name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLastName +Last Name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPhoneNumber +Phone number of the user used by Dynatrace for contacting them if needed + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.IMonitorResource + +## 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 <IDynatraceObservabilityIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Single Sign On Configuration Name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Monitor resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.DynatraceObservability/Update-AzDynatraceMonitorTagRule.md b/azps-10.1.0/Az.DynatraceObservability/Update-AzDynatraceMonitorTagRule.md new file mode 100644 index 0000000000..68cca625f5 --- /dev/null +++ b/azps-10.1.0/Az.DynatraceObservability/Update-AzDynatraceMonitorTagRule.md @@ -0,0 +1,301 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/update-azdynatracemonitortagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Update-AzDynatraceMonitorTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/DynatraceObservability/help/Update-AzDynatraceMonitorTagRule.md +--- + +# Update-AzDynatraceMonitorTagRule + +## SYNOPSIS +Update a TagRule + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDynatraceMonitorTagRule -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-LogRuleFilteringTag <IFilteringTag[]>] [-LogRuleSendAadLog <SendAadLogsStatus>] + [-LogRuleSendActivityLog <SendActivityLogsStatus>] [-LogRuleSendSubscriptionLog <SendSubscriptionLogsStatus>] + [-MetricRuleFilteringTag <IFilteringTag[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDynatraceMonitorTagRule -InputObject <IDynatraceObservabilityIdentity> + [-LogRuleFilteringTag <IFilteringTag[]>] [-LogRuleSendAadLog <SendAadLogsStatus>] + [-LogRuleSendActivityLog <SendActivityLogsStatus>] [-LogRuleSendSubscriptionLog <SendSubscriptionLogsStatus>] + [-MetricRuleFilteringTag <IFilteringTag[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Update a TagRule + +## EXAMPLES + +### Example 1: Update a tag rule for the dynatrace monitor +```powershell +$tagFilter = New-AzDynatraceMonitorFilteringTagObject -Action 'Include' -Name 'Environment' -Value 'Prod' +Update-AzDynatraceMonitorTagRule -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 -LogRuleFilteringTag $tagFilter +``` + +```output +Name ResourceGroupName ProvisioningState LogRuleSendAadLog +---- ----------------- ----------------- ----------------- +default dyobrg Succeeded Disabled +``` + +This command updates a tag rule for the dynatrace monitor. + +### Example 2: Update a tag rule for the dynatrace monitor by pipeline +```powershell +$tagFilter = New-AzDynatraceMonitorFilteringTagObject -Action 'Include' -Name 'Environment' -Value 'Prod' +Get-AzDynatraceMonitorTagRule -ResourceGroupName dyobrg -MonitorName dyob-pwsh01 | Update-AzDynatraceMonitorTagRule -LogRuleFilteringTag $tagFilter +``` + +```output +Name ResourceGroupName ProvisioningState LogRuleSendAadLog +---- ----------------- ----------------- ----------------- +default dyobrg Succeeded Disabled +``` + +This command updates a tag rule for the dynatrace monitor by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LogRuleFilteringTag +List of filtering tags to be used for capturing logs. +This only takes effect if SendActivityLogs flag is enabled. +If empty, all resources will be captured.If only Exclude action is specified, the rules will apply to the list of all available resources. +If Include actions are specified, the rules will only include resources with the associated tags. +To construct, see NOTES section for LOGRULEFILTERINGTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.IFilteringTag[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendAadLog +Flag specifying if AAD logs should be sent for the Monitor resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.SendAadLogsStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendActivityLog +Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.SendActivityLogsStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendSubscriptionLog +Flag specifying if subscription logs should be sent for the Monitor resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Support.SendSubscriptionLogsStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricRuleFilteringTag +List of filtering tags to be used for capturing metrics. +If empty, all resources will be captured. +If only Exclude action is specified, the rules will apply to the list of all available resources. +If Include actions are specified, the rules will only include resources with the associated tags. +To construct, see NOTES section for METRICRULEFILTERINGTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.IFilteringTag[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.Api20210901.ITagRule + +## 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 <IDynatraceObservabilityIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: Single Sign On Configuration Name + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: Monitor resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`LOGRULEFILTERINGTAG <IFilteringTag[]>`: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured.If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. + - `[Action <TagAction?>]`: Valid actions for a filtering tag. Exclusion takes priority over inclusion. + - `[Name <String>]`: The name (also known as the key) of the tag. + - `[Value <String>]`: The value of the tag. + +`METRICRULEFILTERINGTAG <IFilteringTag[]>`: List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. + - `[Action <TagAction?>]`: Valid actions for a filtering tag. Exclusion takes priority over inclusion. + - `[Name <String>]`: The name (also known as the key) of the tag. + - `[Value <String>]`: The value of the tag. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/Az.EdgeOrder.md b/azps-10.1.0/Az.EdgeOrder/Az.EdgeOrder.md new file mode 100644 index 0000000000..8f53e4de8f --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/Az.EdgeOrder.md @@ -0,0 +1,77 @@ +--- +Module Name: Az.EdgeOrder +Module Guid: ffbed74a-2473-42d2-95fc-73adffd13d49 +Download Help Link: https://learn.microsoft.com/powershell/module/az.edgeorder +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Az.EdgeOrder.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Az.EdgeOrder.md +--- + +# Az.EdgeOrder Module +## Description +Microsoft Azure PowerShell: EdgeOrder cmdlets + +## Az.EdgeOrder Cmdlets +### [Get-AzEdgeOrder](Get-AzEdgeOrder.md) +Gets an order. + +### [Get-AzEdgeOrderAddress](Get-AzEdgeOrderAddress.md) +Gets information about the specified address. + +### [Get-AzEdgeOrderConfiguration](Get-AzEdgeOrderConfiguration.md) +This method provides the list of configurations for the given product family, product line and product under subscription. + +### [Get-AzEdgeOrderItem](Get-AzEdgeOrderItem.md) +Gets an order item. + +### [Get-AzEdgeOrderProductFamily](Get-AzEdgeOrderProductFamily.md) +This method provides the list of product families for the given subscription. + +### [Get-AzEdgeOrderProductFamilyMetadata](Get-AzEdgeOrderProductFamilyMetadata.md) +This method provides the list of product families metadata for the given subscription. + +### [Invoke-AzEdgeOrderItemCancellation](Invoke-AzEdgeOrderItemCancellation.md) +Cancel order item. + +### [Invoke-AzEdgeOrderReturnOrderItem](Invoke-AzEdgeOrderReturnOrderItem.md) +Return order item. + +### [New-AzEdgeOrderAddress](New-AzEdgeOrderAddress.md) +Creates a new address with the specified parameters. +Existing address can be updated with this API + +### [New-AzEdgeOrderContactDetailsObject](New-AzEdgeOrderContactDetailsObject.md) +Create an in-memory object for ContactDetails. + +### [New-AzEdgeOrderFilterablePropertyObject](New-AzEdgeOrderFilterablePropertyObject.md) +Create an in-memory object for FilterableProperty. + +### [New-AzEdgeOrderHierarchyInformationObject](New-AzEdgeOrderHierarchyInformationObject.md) +Create an in-memory object for HierarchyInformation. + +### [New-AzEdgeOrderItem](New-AzEdgeOrderItem.md) +Creates an order item. +Existing order item cannot be updated with this api and should instead be updated with the Update order item API. + +### [New-AzEdgeOrderOrderItemDetailsObject](New-AzEdgeOrderOrderItemDetailsObject.md) +Create an in-memory object for OrderItemDetails. + +### [New-AzEdgeOrderPreferencesObject](New-AzEdgeOrderPreferencesObject.md) +Create an in-memory object for Preferences. + +### [New-AzEdgeOrderShippingAddressObject](New-AzEdgeOrderShippingAddressObject.md) +Create an in-memory object for ShippingAddress. + +### [Remove-AzEdgeOrderAddress](Remove-AzEdgeOrderAddress.md) +Deletes an address. + +### [Remove-AzEdgeOrderItem](Remove-AzEdgeOrderItem.md) +Deletes an order item. + +### [Update-AzEdgeOrderAddress](Update-AzEdgeOrderAddress.md) +Updates the properties of an existing address. + +### [Update-AzEdgeOrderItem](Update-AzEdgeOrderItem.md) +Updates the properties of an existing order item. + diff --git a/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrder.md b/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrder.md new file mode 100644 index 0000000000..7b814c46fc --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrder.md @@ -0,0 +1,152 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/get-azedgeorder +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Get-AzEdgeOrder.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Get-AzEdgeOrder.md +--- + +# Get-AzEdgeOrder + +## SYNOPSIS +Gets an order. + +## SYNTAX + +### List (Default) +``` +Get-AzEdgeOrder [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzEdgeOrder -Location <String> -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzEdgeOrder -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an order. + +## EXAMPLES + +### Example 1: Get order details +```powershell +$order = Get-AzEdgeOrder -Name pwOrderItem11 -SubscriptionId "SubscriptionId" -Location "eastus" -ResourceGroupName "resourceGroupName" +$order | Format-List +``` + +```output +CurrentStageDisplayName : +CurrentStageName : Placed +CurrentStageStartTime : 11/16/2021 10:35:00 AM +CurrentStageStatus : Succeeded +Id : /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwOrderItem11 +Name : pwOrderItem11 +OrderItemId : {/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/orderItems/examplePowershell} +OrderStageHistory : {, } +SystemData : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20.SystemData +Type : Microsoft.EdgeOrder/orders +``` + +Get order details + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The name of Azure region. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the order + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: OrderName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IOrderResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderAddress.md b/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderAddress.md new file mode 100644 index 0000000000..4b292403b4 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderAddress.md @@ -0,0 +1,174 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/get-azedgeorderaddress +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Get-AzEdgeOrderAddress.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Get-AzEdgeOrderAddress.md +--- + +# Get-AzEdgeOrderAddress + +## SYNOPSIS +Gets information about the specified address. + +## SYNTAX + +### List (Default) +``` +Get-AzEdgeOrderAddress [-SubscriptionId <String[]>] [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzEdgeOrderAddress -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzEdgeOrderAddress -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Filter <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified address. + +## EXAMPLES + +### Example 1: Get address details +```powershell +$address = Get-AzEdgeOrderAddress -SubscriptionId SubscriptionId -ResourceGroupName "resourceGroupName" +$address | Format-List +``` + +```output +AddressValidationStatus : Valid +ContactDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ContactDetails +Id : /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/addresses/pwvalidaddress +Location : eastus +Name : pwvalidaddress +ShippingAddress : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ShippingAddress +SystemData : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20.SystemData +Tag : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20.TrackedResourceTags +Type : Microsoft.EdgeOrder/addresses + +AddressValidationStatus : Valid +ContactDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ContactDetails +Id : /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/addresses/pwvalidaddress215 +Location : eastus +Name : pwvalidaddress215 +ShippingAddress : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ShippingAddress +SystemData : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20.SystemData +Tag : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20.TrackedResourceTags +Type : Microsoft.EdgeOrder/addresses + +AddressValidationStatus : Valid +ContactDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ContactDetails +Id : /subscriptions/"SubscriptionId"/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestPwAddress +Location : eastus +Name : TestPwAddress +ShippingAddress : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ShippingAddress +SystemData : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20.SystemData +Tag : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20.TrackedResourceTags +Type : Microsoft.EdgeOrder/addresses +``` + +Get address details + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +$filter is supported to filter based on shipping address properties. +Filter supports only equals operation. + +```yaml +Type: System.String +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the address Resource within the specified resource group. +address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AddressName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IAddressResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderConfiguration.md b/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderConfiguration.md new file mode 100644 index 0000000000..d567a3f26a --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderConfiguration.md @@ -0,0 +1,180 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/get-azedgeorderconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Get-AzEdgeOrderConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Get-AzEdgeOrderConfiguration.md +--- + +# Get-AzEdgeOrderConfiguration + +## SYNOPSIS +This method provides the list of configurations for the given product family, product line and product under subscription. + +## SYNTAX + +``` +Get-AzEdgeOrderConfiguration -ConfigurationFilter <IConfigurationFilters[]> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +This method provides the list of configurations for the given product family, product line and product under subscription. + +## EXAMPLES + +### Example 1: Get configuration details +```powershell +$configuration = Get-AzEdgeOrderConfiguration -SubscriptionId SubscriptionId -ConfigurationFilter @(@{"HierarchyInformation"=$HierarchyInformation; "FilterableProperty"= @($filterableProperty)}) +$filterableProperty = New-AzEdgeOrderFilterablePropertyObject -Type "ShipToCountries" -SupportedValue @("US") +$HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" +$configuration = Get-AzEdgeOrderConfiguration -SubscriptionId SubscriptionId -ConfigurationFilter @(@{"HierarchyInformation"=$HierarchyInformation; "FilterableProperty"= @($filterableProperty)}) +$configuration +``` + +```output +AvailabilityInformationAvailabilityStage : Available +AvailabilityInformationDisabledReason : None +AvailabilityInformationDisabledReasonMessage : +CostInformationBillingInfoUrl : https://aka.ms/edgeHWcenter-pricinglink-custom +CostInformationBillingMeterDetail : {RentalFee, ShippingFee} +DescriptionAttribute : {} +DescriptionKeyword : {GPU} +DescriptionLink : {} +DescriptionLongDescription : +DescriptionShortDescription : +DescriptionType : Base +DimensionDepth : 2 +DimensionHeight : 15 +DimensionLength : 50 +DimensionLengthHeightUnit : IN +DimensionWeight : 50 +DimensionWeightUnit : LBS +DimensionWidth : 5 +DisplayName : Azure Stack Edge Pro - 2 GPU +FilterableProperty : {Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.FilterableProperty} +HierarchyInformation : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.HierarchyInformation +ImageInformation : {} +Specification : {Usable compute, Usable memory, Usable storage} +``` + +This command get insights of selected configuration. +Make sure you run registerProvider on Microsoft.EdgeOrder before running this command. + +## PARAMETERS + +### -ConfigurationFilter +Holds details about product hierarchy information and filterable property. +To construct, see NOTES section for CONFIGURATIONFILTER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IConfigurationFilters[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IConfiguration + +## 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. + + +CONFIGURATIONFILTER <IConfigurationFilters[]>: Holds details about product hierarchy information and filterable property. + - `HierarchyInformation <IHierarchyInformation>`: Product hierarchy information + - `[ConfigurationName <String>]`: Represents configuration name that uniquely identifies configuration + - `[ProductFamilyName <String>]`: Represents product family name that uniquely identifies product family + - `[ProductLineName <String>]`: Represents product line name that uniquely identifies product line + - `[ProductName <String>]`: Represents product name that uniquely identifies product + - `[FilterableProperty <IFilterableProperty[]>]`: Filters specific to product + - `SupportedValue <String[]>`: Values to be filtered. + - `Type <SupportedFilterTypes>`: Type of product filter. + +CUSTOMERSUBSCRIPTIONDETAIL `<ICustomerSubscriptionDetails>`: Customer subscription properties. Clients can display available products to unregistered customers by explicitly passing subscription details + - `QuotaId <String>`: Quota ID of a subscription + - `[LocationPlacementId <String>]`: Location placement Id of a subscription + - `[RegisteredFeature <ICustomerSubscriptionRegisteredFeatures[]>]`: List of registered feature flags for subscription + - `[Name <String>]`: Name of subscription registered feature + - `[State <String>]`: State of subscription registered feature + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderItem.md b/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderItem.md new file mode 100644 index 0000000000..464cab9fa6 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderItem.md @@ -0,0 +1,176 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/get-azedgeorderitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Get-AzEdgeOrderItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Get-AzEdgeOrderItem.md +--- + +# Get-AzEdgeOrderItem + +## SYNOPSIS +Gets an order item. + +## SYNTAX + +### List (Default) +``` +Get-AzEdgeOrderItem [-SubscriptionId <String[]>] [-Expand <String>] [-Filter <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzEdgeOrderItem -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Expand <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzEdgeOrderItem -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Expand <String>] + [-Filter <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets an order item. + +## EXAMPLES + +### Example 1: Get orderItem details +```powershell +$orderItem = Get-AzEdgeOrderItem -Name examplePowershell -SubscriptionId "SubscriptionId" -ResourceGroupName "resourceGroupName" +$ordderItem | Format-List +``` + +```output +ForwardAddressContactDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ContactDetails +ForwardAddressShippingAddress : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ShippingAddress +ForwardAddressValidationStatus : Valid +Id : /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/orderItems/OrderItem-211115074927900249117427 +Location : eastus +Name : OrderItem-211115074927900249117427 +OrderId : /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/Order-211115074927650235470998 +OrderItemDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.OrderItemDetails +ReturnAddressContactDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ContactDetails +ReturnAddressShippingAddress : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ShippingAddress +ReturnAddressValidationStatus : Valid +StartTime : 11/15/2021 7:49:29 AM +SystemData : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20.SystemData +Tag : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20.TrackedResourceTags +Type : Microsoft.EdgeOrder/orderItems +``` + +Get orderItem details + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +$expand is supported on device details, forward shipping details and reverse shipping details parameters. +Each of these can be provided as a comma separated list. +Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +$filter is supported to filter based on order id. +Filter supports only equals operation. + +```yaml +Type: System.String +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the order item + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: OrderItemName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IOrderItemResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderProductFamily.md b/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderProductFamily.md new file mode 100644 index 0000000000..e2feda2116 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderProductFamily.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/get-azedgeorderproductfamily +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Get-AzEdgeOrderProductFamily.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Get-AzEdgeOrderProductFamily.md +--- + +# Get-AzEdgeOrderProductFamily + +## SYNOPSIS +This method provides the list of product families for the given subscription. + +## SYNTAX + +``` +Get-AzEdgeOrderProductFamily -FilterableProperty <Hashtable> [-SubscriptionId <String[]>] [-Expand <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +This method provides the list of product families for the given subscription. + +## EXAMPLES + +### Example 1: Get details of specific productFamilies +```powershell +$familyDetails = Get-AzEdgeOrderProductFamily -SubscriptionId SubscriptionId -FilterableProperty @{"azurestackedge"=@($filterableProperty)} -Expand "configurations" +$familyDetails.ProductLine.Product.Configuration.HierarchyInformation +``` + +```output +ConfigurationName ProductFamilyName ProductLineName ProductName +----------------- ----------------- --------------- ----------- +edgep_high azurestackedge azurestackedge azurestackedgegpu +edgepr_base azurestackedge azurestackedge azurestackedgepror +edgemr_mini azurestackedge azurestackedge azurestackedgeminir +``` + +This command get insights of filtered family. +Make sure you run registerProvider on Microsoft.EdgeOrder before running this command. +You can run Get-AzEdgeOrderConfiguration to get details of each configuration + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +$expand is supported on configurations parameter for product, which provides details on the configurations for the product. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterableProperty +Dictionary of filterable properties on product family. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IProductFamily + +## 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. + + +CUSTOMERSUBSCRIPTIONDETAIL `<ICustomerSubscriptionDetails>`: Customer subscription properties. Clients can display available products to unregistered customers by explicitly passing subscription details + - `QuotaId <String>`: Quota ID of a subscription + - `[LocationPlacementId <String>]`: Location placement Id of a subscription + - `[RegisteredFeature <ICustomerSubscriptionRegisteredFeatures[]>]`: List of registered feature flags for subscription + - `[Name <String>]`: Name of subscription registered feature + - `[State <String>]`: State of subscription registered feature + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderProductFamilyMetadata.md b/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderProductFamilyMetadata.md new file mode 100644 index 0000000000..12fcbe23f1 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/Get-AzEdgeOrderProductFamilyMetadata.md @@ -0,0 +1,123 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/get-azedgeorderproductfamilymetadata +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Get-AzEdgeOrderProductFamilyMetadata.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Get-AzEdgeOrderProductFamilyMetadata.md +--- + +# Get-AzEdgeOrderProductFamilyMetadata + +## SYNOPSIS +This method provides the list of product families metadata for the given subscription. + +## SYNTAX + +``` +Get-AzEdgeOrderProductFamilyMetadata [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +This method provides the list of product families metadata for the given subscription. + +## EXAMPLES + +### Example 1: Gets available product families on procured subscription +```powershell +$productFamilyMeta = Get-AzEdgeOrderProductFamilyMetadata -SubscriptionId SubscriptionId +$productFamilyMeta.HierarchyInformation +``` + +```output +ConfigurationName ProductFamilyName ProductLineName ProductName +----------------- ----------------- --------------- ----------- + azurestackedge + azurestackhub +``` + +This command gets product families available on procured subscription. + +Make sure registerProvider on Microsoft.EdgeOrder is done before running this command. + +To get details of any family use Get-AzEdgeOrderProductFamily command + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IProductFamiliesMetadataDetails + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/Invoke-AzEdgeOrderItemCancellation.md b/azps-10.1.0/Az.EdgeOrder/Invoke-AzEdgeOrderItemCancellation.md new file mode 100644 index 0000000000..db57199e6a --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/Invoke-AzEdgeOrderItemCancellation.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/invoke-azedgeorderitemcancellation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Invoke-AzEdgeOrderItemCancellation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Invoke-AzEdgeOrderItemCancellation.md +--- + +# Invoke-AzEdgeOrderItemCancellation + +## SYNOPSIS +Cancel order item. + +## SYNTAX + +### CancelExpanded (Default) +``` +Invoke-AzEdgeOrderItemCancellation -Name <String> -ResourceGroupName <String> -Reason <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CancelViaIdentityExpanded +``` +Invoke-AzEdgeOrderItemCancellation -InputObject <IEdgeOrderIdentity> -Reason <String> + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Cancel order item. + +## EXAMPLES + +### Example 1: Cancel orderItem +```powershell +Invoke-AzEdgeOrderItemCancellation -Name "examplePowershell" -ResourceGroupName "resourceGroupName" -Reason "Test Job" -SubscriptionId SubscriptionId +``` + +Invoke orderItem cancellation + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.IEdgeOrderIdentity +Parameter Sets: CancelViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the order item + +```yaml +Type: System.String +Parameter Sets: CancelExpanded +Aliases: OrderItemName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reason +Reason for cancellation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CancelExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: CancelExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.IEdgeOrderIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IEdgeOrderIdentity>`: Identity Parameter + - `[AddressName <String>]`: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OrderItemName <String>]`: The name of the order item + - `[OrderName <String>]`: The name of the order + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/Invoke-AzEdgeOrderReturnOrderItem.md b/azps-10.1.0/Az.EdgeOrder/Invoke-AzEdgeOrderReturnOrderItem.md new file mode 100644 index 0000000000..98bf30ec85 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/Invoke-AzEdgeOrderReturnOrderItem.md @@ -0,0 +1,326 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/invoke-azedgeorderreturnorderitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Invoke-AzEdgeOrderReturnOrderItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Invoke-AzEdgeOrderReturnOrderItem.md +--- + +# Invoke-AzEdgeOrderReturnOrderItem + +## SYNOPSIS +Return order item. + +## SYNTAX + +### ReturnExpanded (Default) +``` +Invoke-AzEdgeOrderReturnOrderItem -OrderItemName <String> -ResourceGroupName <String> -ReturnReason <String> + [-SubscriptionId <String>] [-ReturnAddressContactDetail <IContactDetails>] + [-ReturnAddressShippingAddress <IShippingAddress>] [-ServiceTag <String>] [-ShippingBoxRequired] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ReturnViaIdentityExpanded +``` +Invoke-AzEdgeOrderReturnOrderItem -InputObject <IEdgeOrderIdentity> -ReturnReason <String> + [-ReturnAddressContactDetail <IContactDetails>] [-ReturnAddressShippingAddress <IShippingAddress>] + [-ServiceTag <String>] [-ShippingBoxRequired] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Return order item. + +## EXAMPLES + +### Example 1: Command to initiate orderItem return +```powershell +Invoke-AzEdgeOrderReturnOrderItem -OrderItemName "OrderItem-211115074927900249117427" -ResourceGroupName "resourceGroupName" -ReturnReason "Test Order Return" -SubscriptionId "SubscriptionId" +``` + +Invoke orderItem return + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.IEdgeOrderIdentity +Parameter Sets: ReturnViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderItemName +The name of the order item + +```yaml +Type: System.String +Parameter Sets: ReturnExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: ReturnExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressContactDetail +Contact details for the address +To construct, see NOTES section for RETURNADDRESSCONTACTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IContactDetails +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressShippingAddress +Shipping details for the address +To construct, see NOTES section for RETURNADDRESSSHIPPINGADDRESS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IShippingAddress +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnReason +Return Reason. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTag +Service tag (located on the bottom-right corner of the device) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingBoxRequired +Shipping Box required + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: ReturnExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.IEdgeOrderIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IEdgeOrderIdentity>`: Identity Parameter + - `[AddressName <String>]`: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OrderItemName <String>]`: The name of the order item + - `[OrderName <String>]`: The name of the order + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +RETURNADDRESSCONTACTDETAIL `<IContactDetails>`: Contact details for the address + - `ContactName <String>`: Contact name of the person. + - `EmailList <String[]>`: List of Email-ids to be notified about job progress. + - `Phone <String>`: Phone number of the contact person. + - `[Mobile <String>]`: Mobile number of the contact person. + - `[PhoneExtension <String>]`: Phone extension number of the contact person. + +RETURNADDRESSSHIPPINGADDRESS `<IShippingAddress>`: Shipping details for the address + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderAddress.md b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderAddress.md new file mode 100644 index 0000000000..314a043e40 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderAddress.md @@ -0,0 +1,289 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/new-azedgeorderaddress +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderAddress.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderAddress.md +--- + +# New-AzEdgeOrderAddress + +## SYNOPSIS +Creates a new address with the specified parameters. +Existing address can be updated with this API + +## SYNTAX + +``` +New-AzEdgeOrderAddress -Name <String> -ResourceGroupName <String> -ContactDetail <IContactDetails> + -Location <String> [-SubscriptionId <String>] [-ShippingAddress <IShippingAddress>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new address with the specified parameters. +Existing address can be updated with this API + +## EXAMPLES + +### Example 1: Create a new address +```powershell +$contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName ContactName -EmailList @("emailId") -Phone Phone +$ShippingDetails = New-AzEdgeOrderShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +$DebugPreference = "Continue" +# You can use `$DebugPreference = "Continue"`, with any example/usecase to get exact details of error in below format when creation command fails. +# { +# "Error": { +# "Code": "StaticValidationGenericCountryCodeHasInvalidLength", +# "Message": "The attribute country code does not meet length constraints.\r\nEnter a value with 2 characters for country code.", +# "Details": [ +# null +# ], +# "Target": null +# } +# } +$address = New-AzEdgeOrderAddress -Name "TestPwAddress" -ResourceGroupName "resourceGroupName" -ContactDetail $contactDetail -SubscriptionId SubscriptionId -ShippingAddress $ShippingDetails -Location "eastus" +$address | Format-List +``` + +```output +AddressValidationStatus : Valid +ContactDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ContactDetails +Id : /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestPwAddress +Location : eastus +Name : TestPwAddress +ShippingAddress : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ShippingAddress +SystemData : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20.SystemData +Tag : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20.TrackedResourceTags +Type : Microsoft.EdgeOrder/addresses +``` + +Creates a new address. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactDetail +Contact details for the address +To construct, see NOTES section for CONTACTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IContactDetails +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the address Resource within the specified resource group. +address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AddressName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingAddress +Shipping details for the address +To construct, see NOTES section for SHIPPINGADDRESS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IShippingAddress +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IAddressResource + +## 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. + + +CONTACTDETAIL `<IContactDetails>`: Contact details for the address + - `ContactName <String>`: Contact name of the person. + - `EmailList <String[]>`: List of Email-ids to be notified about job progress. + - `Phone <String>`: Phone number of the contact person. + - `[Mobile <String>]`: Mobile number of the contact person. + - `[PhoneExtension <String>]`: Phone extension number of the contact person. + +SHIPPINGADDRESS `<IShippingAddress>`: Shipping details for the address + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderContactDetailsObject.md b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderContactDetailsObject.md new file mode 100644 index 0000000000..95f8f73795 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderContactDetailsObject.md @@ -0,0 +1,133 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.EdgeOrder/new-AzEdgeOrderContactDetailsObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderContactDetailsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderContactDetailsObject.md +--- + +# New-AzEdgeOrderContactDetailsObject + +## SYNOPSIS +Create an in-memory object for ContactDetails. + +## SYNTAX + +``` +New-AzEdgeOrderContactDetailsObject -ContactName <String> -EmailList <String[]> -Phone <String> + [-Mobile <String>] [-PhoneExtension <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ContactDetails. + +## EXAMPLES + +### Example 1: Contact details object +```powershell +$contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName ContactName -EmailList @("emailId") -Phone Phone +``` + +```output +ContactName : random +EmailList : {"emailId"} +Mobile : +Phone : 1234567890 +PhoneExtension : +``` + +Creates a in-memory contact details object + +## PARAMETERS + +### -ContactName +Contact name of the person. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailList +List of Email-ids to be notified about job progress. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mobile +Mobile number of the contact person. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Phone +Phone number of the contact person. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneExtension +Phone extension number of the contact person. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ContactDetails + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderFilterablePropertyObject.md b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderFilterablePropertyObject.md new file mode 100644 index 0000000000..09ef64956c --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderFilterablePropertyObject.md @@ -0,0 +1,86 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.EdgeOrder/new-AzEdgeOrderFilterablePropertyObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderFilterablePropertyObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderFilterablePropertyObject.md +--- + +# New-AzEdgeOrderFilterablePropertyObject + +## SYNOPSIS +Create an in-memory object for FilterableProperty. + +## SYNTAX + +``` +New-AzEdgeOrderFilterablePropertyObject -SupportedValue <String[]> -Type <SupportedFilterTypes> + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for FilterableProperty. + +## EXAMPLES + +### Example 1: Filterable property object +```powershell +$filterableProperty = New-AzEdgeOrderFilterablePropertyObject -Type "ShipToCountries" -SupportedValue @("US") +$filterableProperty | Format-List +``` + +```output +SupportedValue : {US} +Type : ShipToCountries +``` + +ShipToCountries is mandatory filterable type, SupportedValue can be list of 2 letter valid ISO country codes. + +## PARAMETERS + +### -SupportedValue +Values to be filtered. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of product filter. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Support.SupportedFilterTypes +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.FilterableProperty + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderHierarchyInformationObject.md b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderHierarchyInformationObject.md new file mode 100644 index 0000000000..553d6ea087 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderHierarchyInformationObject.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.EdgeOrder/new-AzEdgeOrderHierarchyInformationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderHierarchyInformationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderHierarchyInformationObject.md +--- + +# New-AzEdgeOrderHierarchyInformationObject + +## SYNOPSIS +Create an in-memory object for HierarchyInformation. + +## SYNTAX + +``` +New-AzEdgeOrderHierarchyInformationObject [-ConfigurationName <String>] [-ProductFamilyName <String>] + [-ProductLineName <String>] [-ProductName <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for HierarchyInformation. + +## EXAMPLES + +### Example 1: Creates hierarchy information object +```powershell +$HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" +$HierarchyInformation | Format-List +``` + +```output +ConfigurationName : EdgeP_High +ProductFamilyName : azurestackedge +ProductLineName : azurestackedge +ProductName : azurestackedgegpu +``` + +Creates a in-memory hierarchy information object + +## PARAMETERS + +### -ConfigurationName +Represents configuration name that uniquely identifies configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProductFamilyName +Represents product family name that uniquely identifies product family. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProductLineName +Represents product line name that uniquely identifies product line. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProductName +Represents product name that uniquely identifies product. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.HierarchyInformation + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderItem.md b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderItem.md new file mode 100644 index 0000000000..f698cc6395 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderItem.md @@ -0,0 +1,370 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/new-azedgeorderitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderItem.md +--- + +# New-AzEdgeOrderItem + +## SYNOPSIS +Creates an order item. +Existing order item cannot be updated with this api and should instead be updated with the Update order item API. + +## SYNTAX + +``` +New-AzEdgeOrderItem -Name <String> -ResourceGroupName <String> -ForwardAddressContactDetail <IContactDetails> + -Location <String> -OrderId <String> -OrderItemDetail <IOrderItemDetails> [-SubscriptionId <String>] + [-ForwardShippingAddress <IShippingAddress>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an order item. +Existing order item cannot be updated with this api and should instead be updated with the Update order item API. + +## EXAMPLES + +### Example 1: Creates a new orderItem +```powershell +$contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName ContactName -EmailList @("emailId") -Phone Phone +$ShippingDetails = New-AzEdgeOrderShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +$HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" +$details = New-AzEdgeOrderOrderItemDetailsObject -OrderItemType "Purchase" -ProductDetail @{"HierarchyInformation"=$HierarchyInformation} +$orderItem = New-AzEdgeOrderItem -Name "examplePowershell" -ResourceGroupName ResourceGroup -ForwardAddressContactDetail $contactDetail -Location "eastus" -OrderId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwOrderItem11" -OrderItemDetail $details -SubscriptionId SubscriptionId -ForwardShippingAddress $ShippingDetails + +$orderItem = New-AzEdgeOrderItem -Name "examplePowershell" -ResourceGroupName "resourceGroupName" -ForwardAddressContactDetail $contactDetail -Location "eastus" -OrderId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwOrderItem11" -OrderItemDetail $details -SubscriptionId SubscriptionId -ForwardShippingAddress $ShippingDetails +$DebugPreference = "Continue" +# You can use `$DebugPreference = "Continue"`, with any example/usecase to get exact details of error in below format when creation command fails. +# { +# "Error": { +# "Code": "StaticValidationGenericCountryCodeHasInvalidLength", +# "Message": "The attribute country code does not meet length constraints.\r\nEnter a value with 2 characters for country code.", +# "Details": [ +# null +# ], +# "Target": null +# } +# } +$orderItem = New-AzEdgeOrderItem -Name "examplePowershell" -ResourceGroupName "resourceGroupName" -ForwardAddressContactDetail $contactDetail -Location "eastus" -OrderId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwOrderItem11" -OrderItemDetail $details -SubscriptionId SubscriptionId -ForwardShippingAddress $ShippingDetails +$orderItem | Format-List +``` + +```output +ForwardAddressContactDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ContactDetails +ForwardAddressShippingAddress : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ShippingAddress +ForwardAddressValidationStatus : Valid +Id : /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/orderItems/examplePowershell +Location : eastus +Name : examplePowershell +OrderId : /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwOrderItem11 +OrderItemDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.OrderItemDetails +ReturnAddressContactDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ContactDetails +ReturnAddressShippingAddress : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ShippingAddress +ReturnAddressValidationStatus : +StartTime : 11/16/2021 10:34:51 AM +SystemData : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20.SystemData +Tag : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20.TrackedResourceTags +Type : Microsoft.EdgeOrder/orderItems + +``` + +Creates a new orderItem. + +### Example 2: Creates a new orderItem with preference set for transport, encryption and management resource +```powershell +$contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName "ContactName2" -EmailList $env.EmailList -Phone $env.Phone +$ShippingDetails = New-AzEdgeOrderShippingAddressObject -StreetAddress1 $env.StreetAddress1 -StateOrProvince $env.StateOrProvince -Country $env.Country -City $env.City -PostalCode $env.PostalCode -AddressType $env.AddressType +$HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" +$preference = New-AzEdgeOrderPreferencesObject -EncryptionPreference @{DoubleEncryptionStatus = "Disabled"} -TransportPreference @{PreferredShipmentType = "MicrosoftManaged"} -ManagementResourcePreference @{PreferredManagementResourceId = "/subscriptions/managementSubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/1GPUtest"} +$details = New-AzEdgeOrderOrderItemDetailsObject -OrderItemType "Purchase" -ProductDetail @{"HierarchyInformation"=$HierarchyInformation} -Preference $preference +New-AzEdgeOrderItem -Name "OrderItemNameWithPref" -ResourceGroupName "resourceGroupName" -ForwardAddressContactDetail $contactDetail -Location "eastus" -OrderId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwPrefOrder" -OrderItemDetail $details -SubscriptionId $env.SubscriptionId -ForwardShippingAddress $ShippingDetails +``` + +```output +Location Name Type +-------- ---- ---- +eastus OrderItemNameWithPref Microsoft.EdgeOrder/orderItems +``` + +Creates a new orderItem with preference set for transport, encryption and management resource + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardAddressContactDetail +Contact details for the address +To construct, see NOTES section for FORWARDADDRESSCONTACTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IContactDetails +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardShippingAddress +Shipping details for the address +To construct, see NOTES section for FORWARDSHIPPINGADDRESS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IShippingAddress +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the order item + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: OrderItemName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderId +Id of the order to which order item belongs to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderItemDetail +Represents order item details. +To construct, see NOTES section for ORDERITEMDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IOrderItemDetails +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IOrderItemResource + +## 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. + + +FORWARDADDRESSCONTACTDETAIL `<IContactDetails>`: Contact details for the address + - `ContactName <String>`: Contact name of the person. + - `EmailList <String[]>`: List of Email-ids to be notified about job progress. + - `Phone <String>`: Phone number of the contact person. + - `[Mobile <String>]`: Mobile number of the contact person. + - `[PhoneExtension <String>]`: Phone extension number of the contact person. + +FORWARDSHIPPINGADDRESS `<IShippingAddress>`: Shipping details for the address + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +ORDERITEMDETAIL `<IOrderItemDetails>`: Represents order item details. + - `OrderItemType <OrderItemType>`: Order item type. + - `ProductDetail <IProductDetails>`: Unique identifier for configuration. + - `HierarchyInformation <IHierarchyInformation>`: Hierarchy of the product which uniquely identifies the product + - `[ConfigurationName <String>]`: Represents configuration name that uniquely identifies configuration + - `[ProductFamilyName <String>]`: Represents product family name that uniquely identifies product family + - `[ProductLineName <String>]`: Represents product line name that uniquely identifies product line + - `[ProductName <String>]`: Represents product name that uniquely identifies product + - `[NotificationEmailList <String[]>]`: Additional notification email list + - `[Preference <IPreferences>]`: Customer notification Preferences + - `[EncryptionPreference <IEncryptionPreferences>]`: Preferences related to the Encryption. + - `[DoubleEncryptionStatus <DoubleEncryptionStatus?>]`: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. + - `[ManagementResourcePreference <IManagementResourcePreferences>]`: Preferences related to the Management resource. + - `[PreferredManagementResourceId <String>]`: Customer preferred Management resource ARM ID + - `[NotificationPreference <INotificationPreference[]>]`: Notification preferences. + - `SendNotification <Boolean>`: Notification is required or not. + - `StageName <NotificationStageName>`: Name of the stage. + - `[TransportPreference <ITransportPreferences>]`: Preferences related to the shipment logistics of the order. + - `PreferredShipmentType <TransportShipmentTypes>`: Indicates Shipment Logistics type that the customer preferred. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderOrderItemDetailsObject.md b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderOrderItemDetailsObject.md new file mode 100644 index 0000000000..5e8e6e81b7 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderOrderItemDetailsObject.md @@ -0,0 +1,136 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.EdgeOrder/new-AzEdgeOrderOrderItemDetailsObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderOrderItemDetailsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderOrderItemDetailsObject.md +--- + +# New-AzEdgeOrderOrderItemDetailsObject + +## SYNOPSIS +Create an in-memory object for OrderItemDetails. + +## SYNTAX + +``` +New-AzEdgeOrderOrderItemDetailsObject -OrderItemType <OrderItemType> -ProductDetail <IProductDetails> + [-NotificationEmailList <String[]>] [-Preference <IPreferences>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for OrderItemDetails. + +## EXAMPLES + +### Example 1: Creates orderItemDetails object. +```powershell +$HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" +$details = New-AzEdgeOrderOrderItemDetailsObject -OrderItemType "Purchase" -ProductDetail @{"HierarchyInformation"=$HierarchyInformation} +``` + +Create an in-memory object for OrderItemDetails. + +## PARAMETERS + +### -NotificationEmailList +Additional notification email list. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderItemType +Order item type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Support.OrderItemType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Preference +Customer notification Preferences. +To construct, see NOTES section for PREFERENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IPreferences +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProductDetail +Unique identifier for configuration. +To construct, see NOTES section for PRODUCTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IProductDetails +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.OrderItemDetails + +## 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. + + +PREFERENCE `<IPreferences>`: Customer notification Preferences. + - `[EncryptionPreference <IEncryptionPreferences>]`: Preferences related to the Encryption. + - `[DoubleEncryptionStatus <DoubleEncryptionStatus?>]`: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. + - `[ManagementResourcePreference <IManagementResourcePreferences>]`: Preferences related to the Management resource. + - `[PreferredManagementResourceId <String>]`: Customer preferred Management resource ARM ID + - `[NotificationPreference <INotificationPreference[]>]`: Notification preferences. + - `SendNotification <Boolean>`: Notification is required or not. + - `StageName <NotificationStageName>`: Name of the stage. + - `[TransportPreference <ITransportPreferences>]`: Preferences related to the shipment logistics of the order. + - `PreferredShipmentType <TransportShipmentTypes>`: Indicates Shipment Logistics type that the customer preferred. + +PRODUCTDETAIL `<IProductDetails>`: Unique identifier for configuration. + - `HierarchyInformation <IHierarchyInformation>`: Hierarchy of the product which uniquely identifies the product + - `[ConfigurationName <String>]`: Represents configuration name that uniquely identifies configuration + - `[ProductFamilyName <String>]`: Represents product family name that uniquely identifies product family + - `[ProductLineName <String>]`: Represents product line name that uniquely identifies product line + - `[ProductName <String>]`: Represents product name that uniquely identifies product + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderPreferencesObject.md b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderPreferencesObject.md new file mode 100644 index 0000000000..c0d2a4ee8b --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderPreferencesObject.md @@ -0,0 +1,134 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.EdgeOrder/new-AzEdgeOrderPreferencesObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderPreferencesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderPreferencesObject.md +--- + +# New-AzEdgeOrderPreferencesObject + +## SYNOPSIS +Create an in-memory object for Preferences. + +## SYNTAX + +``` +New-AzEdgeOrderPreferencesObject [-EncryptionPreference <IEncryptionPreferences>] + [-ManagementResourcePreference <IManagementResourcePreferences>] + [-NotificationPreference <INotificationPreference[]>] [-TransportPreference <ITransportPreferences>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for Preferences. + +## EXAMPLES + +### Example 1: Create a preference object +```powershell +$preference = New-AzEdgeOrderPreferencesObject -EncryptionPreference @{DoubleEncryptionStatus = "Disabled"} -TransportPreference @{PreferredShipmentType = "MicrosoftManaged"} -ManagementResourcePreference @{PreferredManagementResourceId = "/subscriptions/managementSubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/1GPUtest"} +``` + +Creates a in-memory preference object to set transport, encryption and management resource preference. + +## PARAMETERS + +### -EncryptionPreference +Preferences related to the Encryption. +To construct, see NOTES section for ENCRYPTIONPREFERENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IEncryptionPreferences +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementResourcePreference +Preferences related to the Management resource. +To construct, see NOTES section for MANAGEMENTRESOURCEPREFERENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IManagementResourcePreferences +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationPreference +Notification preferences. +To construct, see NOTES section for NOTIFICATIONPREFERENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.INotificationPreference[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportPreference +Preferences related to the shipment logistics of the order. +To construct, see NOTES section for TRANSPORTPREFERENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ITransportPreferences +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.Preferences + +## 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. + + +ENCRYPTIONPREFERENCE `<IEncryptionPreferences>`: Preferences related to the Encryption. + - `[DoubleEncryptionStatus <DoubleEncryptionStatus?>]`: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. + +MANAGEMENTRESOURCEPREFERENCE `<IManagementResourcePreferences>`: Preferences related to the Management resource. + - `[PreferredManagementResourceId <String>]`: Customer preferred Management resource ARM ID + +NOTIFICATIONPREFERENCE <INotificationPreference[]>: Notification preferences. + - `SendNotification <Boolean>`: Notification is required or not. + - `StageName <NotificationStageName>`: Name of the stage. + +TRANSPORTPREFERENCE `<ITransportPreferences>`: Preferences related to the shipment logistics of the order. + - `PreferredShipmentType <TransportShipmentTypes>`: Indicates Shipment Logistics type that the customer preferred. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderShippingAddressObject.md b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderShippingAddressObject.md new file mode 100644 index 0000000000..b7190c6cd2 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/New-AzEdgeOrderShippingAddressObject.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.EdgeOrder/new-AzEdgeOrderShippingAddressObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderShippingAddressObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/New-AzEdgeOrderShippingAddressObject.md +--- + +# New-AzEdgeOrderShippingAddressObject + +## SYNOPSIS +Create an in-memory object for ShippingAddress. + +## SYNTAX + +``` +New-AzEdgeOrderShippingAddressObject -Country <String> -StreetAddress1 <String> [-AddressType <AddressType>] + [-City <String>] [-CompanyName <String>] [-PostalCode <String>] [-StateOrProvince <String>] + [-StreetAddress2 <String>] [-StreetAddress3 <String>] [-ZipExtendedCode <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ShippingAddress. + +## EXAMPLES + +### Example 1: Creates shipping address object +```powershell +$ShippingDetails = New-AzEdgeOrderShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" + +$ShippingDetails | Format-List +``` + +```output +AddressType : Commercial +City : San Francisco +CompanyName : +Country : US +PostalCode : 94107 +StateOrProvince : CA +StreetAddress1 : 101 TOWNSEND ST +StreetAddress2 : +StreetAddress3 : +ZipExtendedCode : +``` + +Creates a in-memory shipping address object + +## PARAMETERS + +### -AddressType +Type of address. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Support.AddressType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -City +Name of the City. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +Name of the company. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Country +Name of the Country. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostalCode +Postal code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StateOrProvince +Name of the State or Province. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreetAddress1 +Street Address line 1. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreetAddress2 +Street Address line 2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreetAddress3 +Street Address line 3. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZipExtendedCode +Extended Zip Code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ShippingAddress + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/Remove-AzEdgeOrderAddress.md b/azps-10.1.0/Az.EdgeOrder/Remove-AzEdgeOrderAddress.md new file mode 100644 index 0000000000..ecd644e606 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/Remove-AzEdgeOrderAddress.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/remove-azedgeorderaddress +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Remove-AzEdgeOrderAddress.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Remove-AzEdgeOrderAddress.md +--- + +# Remove-AzEdgeOrderAddress + +## SYNOPSIS +Deletes an address. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzEdgeOrderAddress -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzEdgeOrderAddress -InputObject <IEdgeOrderIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an address. + +## EXAMPLES + +### Example 1: Delete address +```powershell +Remove-AzEdgeOrderAddress -Name "TestPwAddress" -ResourceGroupName "resourceGroupName" -SubscriptionId SubscriptionId +``` + +Delete Address + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.IEdgeOrderIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the address Resource within the specified resource group. +address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AddressName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.IEdgeOrderIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IEdgeOrderIdentity>`: Identity Parameter + - `[AddressName <String>]`: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OrderItemName <String>]`: The name of the order item + - `[OrderName <String>]`: The name of the order + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/Remove-AzEdgeOrderItem.md b/azps-10.1.0/Az.EdgeOrder/Remove-AzEdgeOrderItem.md new file mode 100644 index 0000000000..c7138fe5c6 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/Remove-AzEdgeOrderItem.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/remove-azedgeorderitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Remove-AzEdgeOrderItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Remove-AzEdgeOrderItem.md +--- + +# Remove-AzEdgeOrderItem + +## SYNOPSIS +Deletes an order item. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzEdgeOrderItem -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzEdgeOrderItem -InputObject <IEdgeOrderIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an order item. + +## EXAMPLES + +### Example 1: Delete orderItem +```powershell +Remove-AzEdgeOrderItem -Name "examplePowershell" -ResourceGroupName "resourceGroupName" -SubscriptionId SubscriptionId +``` + +Delete orderItem. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.IEdgeOrderIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the order item + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: OrderItemName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.IEdgeOrderIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IEdgeOrderIdentity>`: Identity Parameter + - `[AddressName <String>]`: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OrderItemName <String>]`: The name of the order item + - `[OrderName <String>]`: The name of the order + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/Update-AzEdgeOrderAddress.md b/azps-10.1.0/Az.EdgeOrder/Update-AzEdgeOrderAddress.md new file mode 100644 index 0000000000..ac89f3c92d --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/Update-AzEdgeOrderAddress.md @@ -0,0 +1,299 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/update-azedgeorderaddress +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Update-AzEdgeOrderAddress.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Update-AzEdgeOrderAddress.md +--- + +# Update-AzEdgeOrderAddress + +## SYNOPSIS +Updates the properties of an existing address. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzEdgeOrderAddress -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-ContactDetail <IContactDetails>] [-ShippingAddress <IShippingAddress>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzEdgeOrderAddress -InputObject <IEdgeOrderIdentity> [-ContactDetail <IContactDetails>] + [-ShippingAddress <IShippingAddress>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the properties of an existing address. + +## EXAMPLES + +### Example 1: Update address details +```powershell +$contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName "ContactName2" -EmailList @("emailId") -Phone Phone +$DebugPreference = "Continue" +# You can use `$DebugPreference = "Continue"`, with any example/usecase to get exact details of error in below format when update command fails. +# { +# "Error": { +# "Code": "StaticValidationGenericCountryCodeHasInvalidLength", +# "Message": "The attribute country code does not meet length constraints.\r\nEnter a value with 2 characters for country code.", +# "Details": [ +# null +# ], +# "Target": null +# } +# } +$updatedContactInAddress = Update-AzEdgeOrderAddress -Name "TestPwAddress" -ResourceGroupName "resourceGroupName" -SubscriptionId SubscriptionId -ContactDetail $contactDetail -ShippingAddress $ShippingDetails +$updatedContactInAddress.ContactDetail.ContactName +``` + +```output +ContactName2 +``` + +Update address details. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactDetail +Contact details for the address +To construct, see NOTES section for CONTACTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IContactDetails +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.IEdgeOrderIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the address Resource within the specified resource group. +address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: AddressName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingAddress +Shipping details for the address +To construct, see NOTES section for SHIPPINGADDRESS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IShippingAddress +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The list of key value pairs that describe the resource. +These tags can be used in viewing and grouping this resource (across resource groups). + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.IEdgeOrderIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IAddressResource + +## 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. + + +CONTACTDETAIL `<IContactDetails>`: Contact details for the address + - `ContactName <String>`: Contact name of the person. + - `EmailList <String[]>`: List of Email-ids to be notified about job progress. + - `Phone <String>`: Phone number of the contact person. + - `[Mobile <String>]`: Mobile number of the contact person. + - `[PhoneExtension <String>]`: Phone extension number of the contact person. + +INPUTOBJECT `<IEdgeOrderIdentity>`: Identity Parameter + - `[AddressName <String>]`: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OrderItemName <String>]`: The name of the order item + - `[OrderName <String>]`: The name of the order + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +SHIPPINGADDRESS `<IShippingAddress>`: Shipping details for the address + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EdgeOrder/Update-AzEdgeOrderItem.md b/azps-10.1.0/Az.EdgeOrder/Update-AzEdgeOrderItem.md new file mode 100644 index 0000000000..5525846ff2 --- /dev/null +++ b/azps-10.1.0/Az.EdgeOrder/Update-AzEdgeOrderItem.md @@ -0,0 +1,347 @@ +--- +external help file: +Module Name: Az.EdgeOrder +online version: https://learn.microsoft.com/powershell/module/az.edgeorder/update-azedgeorderitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Update-AzEdgeOrderItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EdgeOrder/help/Update-AzEdgeOrderItem.md +--- + +# Update-AzEdgeOrderItem + +## SYNOPSIS +Updates the properties of an existing order item. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzEdgeOrderItem -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-ForwardAddressContactDetail <IContactDetails>] [-ForwardAddressShippingAddress <IShippingAddress>] + [-NotificationEmailList <String[]>] [-Preference <IPreferences>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzEdgeOrderItem -InputObject <IEdgeOrderIdentity> [-ForwardAddressContactDetail <IContactDetails>] + [-ForwardAddressShippingAddress <IShippingAddress>] [-NotificationEmailList <String[]>] + [-Preference <IPreferences>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the properties of an existing order item. + +## EXAMPLES + +### Example 1: Update orderItem +```powershell +$contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName "ContactName2" -EmailList @("emailId") -Phone Phone +$DebugPreference = "Continue" +# You can use `$DebugPreference = "Continue"`, with any example/usecase to get exact details of error in below format when update command fails. +# { +# "Error": { +# "Code": "StaticValidationGenericCountryCodeHasInvalidLength", +# "Message": "The attribute country code does not meet length constraints.\r\nEnter a value with 2 characters for country code.", +# "Details": [ +# null +# ], +# "Target": null +# } +# } +$updatedOrderItem = Update-AzEdgeOrderItem -Name "examplePowershell" -ResourceGroupName "resourceGroupName" -SubscriptionId SubscriptionId -ForwardAddressContactDetail $contactDetail + +$updatedOrderItem.ForwardAddressContactDetail | Format-List +``` + +```output +ContactName : ContactName2 +EmailList : {useremailId} +Mobile : +Phone : 1234567891 +PhoneExtension : +``` + +Update orderItem details. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardAddressContactDetail +Contact details for the address +To construct, see NOTES section for FORWARDADDRESSCONTACTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IContactDetails +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardAddressShippingAddress +Shipping details for the address +To construct, see NOTES section for FORWARDADDRESSSHIPPINGADDRESS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IShippingAddress +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.EdgeOrder.Models.IEdgeOrderIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the order item + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: OrderItemName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEmailList +Additional notification email list. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Preference +Customer preference. +To construct, see NOTES section for PREFERENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IPreferences +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The list of key value pairs that describe the resource. +These tags can be used in viewing and grouping this resource (across resource groups). + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.IEdgeOrderIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.IOrderItemResource + +## 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. + + +FORWARDADDRESSCONTACTDETAIL `<IContactDetails>`: Contact details for the address + - `ContactName <String>`: Contact name of the person. + - `EmailList <String[]>`: List of Email-ids to be notified about job progress. + - `Phone <String>`: Phone number of the contact person. + - `[Mobile <String>]`: Mobile number of the contact person. + - `[PhoneExtension <String>]`: Phone extension number of the contact person. + +FORWARDADDRESSSHIPPINGADDRESS `<IShippingAddress>`: Shipping details for the address + - `Country <String>`: Name of the Country. + - `StreetAddress1 <String>`: Street Address line 1. + - `[AddressType <AddressType?>]`: Type of address. + - `[City <String>]`: Name of the City. + - `[CompanyName <String>]`: Name of the company. + - `[PostalCode <String>]`: Postal code. + - `[StateOrProvince <String>]`: Name of the State or Province. + - `[StreetAddress2 <String>]`: Street Address line 2. + - `[StreetAddress3 <String>]`: Street Address line 3. + - `[ZipExtendedCode <String>]`: Extended Zip Code. + +INPUTOBJECT `<IEdgeOrderIdentity>`: Identity Parameter + - `[AddressName <String>]`: The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OrderItemName <String>]`: The name of the order item + - `[OrderName <String>]`: The name of the order + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +PREFERENCE `<IPreferences>`: Customer preference. + - `[EncryptionPreference <IEncryptionPreferences>]`: Preferences related to the Encryption. + - `[DoubleEncryptionStatus <DoubleEncryptionStatus?>]`: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. + - `[ManagementResourcePreference <IManagementResourcePreferences>]`: Preferences related to the Management resource. + - `[PreferredManagementResourceId <String>]`: Customer preferred Management resource ARM ID + - `[NotificationPreference <INotificationPreference[]>]`: Notification preferences. + - `SendNotification <Boolean>`: Notification is required or not. + - `StageName <NotificationStageName>`: Name of the stage. + - `[TransportPreference <ITransportPreferences>]`: Preferences related to the shipment logistics of the order. + - `PreferredShipmentType <TransportShipmentTypes>`: Indicates Shipment Logistics type that the customer preferred. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Elastic/Az.Elastic.md b/azps-10.1.0/Az.Elastic/Az.Elastic.md new file mode 100644 index 0000000000..7e84c3d78c --- /dev/null +++ b/azps-10.1.0/Az.Elastic/Az.Elastic.md @@ -0,0 +1,51 @@ +--- +Module Name: Az.Elastic +Module Guid: ac429574-aa9e-48ba-b46c-129fe2b846d2 +Download Help Link: https://learn.microsoft.com/powershell/module/az.elastic +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Az.Elastic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Az.Elastic.md +--- + +# Az.Elastic Module +## Description +Microsoft Azure PowerShell: Elastic cmdlets + +## Az.Elastic Cmdlets +### [Get-AzElasticDeploymentInfo](Get-AzElasticDeploymentInfo.md) +Fetch information regarding Elastic cloud deployment corresponding to the Elastic monitor resource. + +### [Get-AzElasticDetailVMIngestion](Get-AzElasticDetailVMIngestion.md) +List the vm ingestion details that will be monitored by the Elastic monitor resource. + +### [Get-AzElasticMonitor](Get-AzElasticMonitor.md) +Get the properties of a specific monitor resource. + +### [Get-AzElasticMonitoredResource](Get-AzElasticMonitoredResource.md) +List the resources currently being monitored by the Elastic monitor resource. + +### [Get-AzElasticTagRule](Get-AzElasticTagRule.md) +Get a tag rule set for a given monitor resource. + +### [Get-AzElasticVMHost](Get-AzElasticVMHost.md) +List the vm resources currently being monitored by the Elastic monitor resource. + +### [New-AzElasticFilteringTagObject](New-AzElasticFilteringTagObject.md) +Create a in-memory object for FilteringTag + +### [New-AzElasticMonitor](New-AzElasticMonitor.md) +Create a monitor resource. + +### [New-AzElasticTagRule](New-AzElasticTagRule.md) +Create or update a tag rule set for a given monitor resource. + +### [Remove-AzElasticMonitor](Remove-AzElasticMonitor.md) +Delete a monitor resource. + +### [Update-AzElasticMonitor](Update-AzElasticMonitor.md) +Update a monitor resource. + +### [Update-AzElasticVMCollection](Update-AzElasticVMCollection.md) +Update the vm details that will be monitored by the Elastic monitor resource. + diff --git a/azps-10.1.0/Az.Elastic/Get-AzElasticDeploymentInfo.md b/azps-10.1.0/Az.Elastic/Get-AzElasticDeploymentInfo.md new file mode 100644 index 0000000000..bebe073beb --- /dev/null +++ b/azps-10.1.0/Az.Elastic/Get-AzElasticDeploymentInfo.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.Elastic +online version: https://learn.microsoft.com/powershell/module/az.elastic/get-azelasticdeploymentinfo +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Get-AzElasticDeploymentInfo.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Get-AzElasticDeploymentInfo.md +--- + +# Get-AzElasticDeploymentInfo + +## SYNOPSIS +Fetch information regarding Elastic cloud deployment corresponding to the Elastic monitor resource. + +## SYNTAX + +``` +Get-AzElasticDeploymentInfo -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Fetch information regarding Elastic cloud deployment corresponding to the Elastic monitor resource. + +## EXAMPLES + +### Example 1: Fetch information regarding Elastic cloud deployment corresponding to the Elastic monitor resource +```powershell +Get-AzElasticDeploymentInfo -ResourceGroupName elastic-rg-3eytki -Name elastic-rhqz1v +``` + +```output +DiskCapacity MemoryCapacity Status Version +------------ -------------- ------ ------- +491520 16384 Healthy 7.14.1 +``` + +This command fetches information regarding Elastic cloud deployment corresponding to the Elastic monitor resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the Elastic resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.Api20200701.IDeploymentInfoResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Elastic/Get-AzElasticDetailVMIngestion.md b/azps-10.1.0/Az.Elastic/Get-AzElasticDetailVMIngestion.md new file mode 100644 index 0000000000..caa7165ae2 --- /dev/null +++ b/azps-10.1.0/Az.Elastic/Get-AzElasticDetailVMIngestion.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.Elastic +online version: https://learn.microsoft.com/powershell/module/az.elastic/get-azelasticdetailvmingestion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Get-AzElasticDetailVMIngestion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Get-AzElasticDetailVMIngestion.md +--- + +# Get-AzElasticDetailVMIngestion + +## SYNOPSIS +List the vm ingestion details that will be monitored by the Elastic monitor resource. + +## SYNTAX + +### Details (Default) +``` +Get-AzElasticDetailVMIngestion -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DetailsViaIdentity +``` +Get-AzElasticDetailVMIngestion -InputObject <IElasticIdentity> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List the vm ingestion details that will be monitored by the Elastic monitor resource. + +## EXAMPLES + +### Example 1: List the vm ingestion details that will be monitored by the Elastic monitor resource +```powershell +Get-AzElasticDetailVMIngestion -ResourceGroupName elastic-rg-3eytki -Name elastic-rhqz1v +``` + +```output +CloudId IngestionKey +------- ------------ +elastic-rhqz1v:xxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxx +``` + +This command lists the vm ingestion details that will be monitored by the Elastic monitor resource. + +### Example 2: List the vm ingestion details that will be monitored by the Elastic monitor resource by pipeline +```powershell +Get-AzElasticMonitor -ResourceGroupName elastic-rg-3eytki -Name elastic-rhqz1v | Get-AzElasticDetailVMIngestion +``` + +```output +CloudId IngestionKey +------- ------------ +elastic-rhqz1v:xxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxx +``` + +This command lists the vm ingestion details that will be monitored by the Elastic monitor resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.IElasticIdentity +Parameter Sets: DetailsViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Details +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the Elastic resource belongs. + +```yaml +Type: System.String +Parameter Sets: Details +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: Details +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.IElasticIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.Api20200701.IVMIngestionDetailsResponse + +## 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 `<IElasticIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group to which the Elastic resource belongs. + - `[RuleSetName <String>]`: Tag Rule Set resource name + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Elastic/Get-AzElasticMonitor.md b/azps-10.1.0/Az.Elastic/Get-AzElasticMonitor.md new file mode 100644 index 0000000000..97546c34d6 --- /dev/null +++ b/azps-10.1.0/Az.Elastic/Get-AzElasticMonitor.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: Az.Elastic +online version: https://learn.microsoft.com/powershell/module/az.elastic/get-azelasticmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Get-AzElasticMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Get-AzElasticMonitor.md +--- + +# Get-AzElasticMonitor + +## SYNOPSIS +Get the properties of a specific monitor resource. + +## SYNTAX + +### List (Default) +``` +Get-AzElasticMonitor [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzElasticMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzElasticMonitor -InputObject <IElasticIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzElasticMonitor -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the properties of a specific monitor resource. + +## EXAMPLES + +### Example 1: List all elastic monitors under a subscription +```powershell +Get-AzElasticMonitor +``` + +```output +Name SkuName MonitoringStatus Location ResourceGroupName +---- ------- ---------------- -------- ----------------- +kk-elastictest02 ess-monthly-consumption_Monthly Enabled westus2 kk-rg +kk-elastictest03 ess-monthly-consumption_Monthly Enabled westus2 kk-rg +wusDeployValidate ess-monthly-consumption_Monthly Enabled westus2 poshett-rg +poshett-WestUS2-01 staging_Monthly Enabled westus2 poshett-rg +hashahdemo01 staging_Monthly Enabled westus2 test-sub +``` + +This command lists all elastic monitors under a subscription. + +### Example 2: List all elastic monitors under a resource group +```powershell +Get-AzElasticMonitor -ResourceGroupName azure-elastic-test +``` + +```output +Name SkuName MonitoringStatus Location ResourceGroupName +---- ------- ---------------- -------- ----------------- +elastic-portal01 ess-monthly-consumption_Monthly Enabled westus2 azure-elastic-test +elastic-portal02 ess-monthly-consumption_Monthly Enabled westus2 azure-elastic-test +elastic-pwsh01 ess-monthly-consumption_Monthly Enabled westus2 azure-elastic-test +elastic-pwsh02 ess-monthly-consumption_Monthly Enabled westus2 azure-elastic-test +``` + +This command lists all elastic monitors under a resource group. + +### Example 3: Get the properties of a specific monitor resource +```powershell +Get-AzElasticMonitor -ResourceGroupName azure-elastic-test -Name elastic-pwsh02 +``` + +```output +Name SkuName MonitoringStatus Location ResourceGroupName +---- ------- ---------------- -------- ----------------- +elastic-pwsh02 ess-monthly-consumption_Monthly Enabled westus2 azure-elastic-test +``` + +This command gets the properties of a specific monitor resource. + +### Example 4: Get the properties of a specific monitor resource by pipeline +```powershell +New-AzElasticMonitor -ResourceGroupName azps-elastic-test -Name elastic-pwsh02 -Location "westus2" -Sku "ess-monthly-consumption_Monthly" -UserInfoEmailAddress 'xxx@microsoft.com' | Get-AzElasticMonitor +``` + +```output +Name SkuName MonitoringStatus Location ResourceGroupName +---- ------- ---------------- -------- ----------------- +elastic-pwsh02 ess-monthly-consumption_Monthly Enabled westus2 azure-elastic-test +``` + +This command gets the properties of a specific monitor resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.IElasticIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the Elastic resource belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.IElasticIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.Api20200701.IElasticMonitorResource + +## 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 `<IElasticIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group to which the Elastic resource belongs. + - `[RuleSetName <String>]`: Tag Rule Set resource name + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Elastic/Get-AzElasticMonitoredResource.md b/azps-10.1.0/Az.Elastic/Get-AzElasticMonitoredResource.md new file mode 100644 index 0000000000..9663146bf4 --- /dev/null +++ b/azps-10.1.0/Az.Elastic/Get-AzElasticMonitoredResource.md @@ -0,0 +1,143 @@ +--- +external help file: +Module Name: Az.Elastic +online version: https://learn.microsoft.com/powershell/module/az.elastic/get-azelasticmonitoredresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Get-AzElasticMonitoredResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Get-AzElasticMonitoredResource.md +--- + +# Get-AzElasticMonitoredResource + +## SYNOPSIS +List the resources currently being monitored by the Elastic monitor resource. + +## SYNTAX + +``` +Get-AzElasticMonitoredResource -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List the resources currently being monitored by the Elastic monitor resource. + +## EXAMPLES + +### Example 1: List the resources currently being monitored by the Elastic monitor resource +```powershell +Get-AzElasticMonitoredResource -ResourceGroupName azure-elastic-test -Name elastic-pwsh02 +``` + +This command lists the resources currently being monitored by the Elastic monitor resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the Elastic resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.Api20200701.IMonitoredResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Elastic/Get-AzElasticTagRule.md b/azps-10.1.0/Az.Elastic/Get-AzElasticTagRule.md new file mode 100644 index 0000000000..74de58e2a3 --- /dev/null +++ b/azps-10.1.0/Az.Elastic/Get-AzElasticTagRule.md @@ -0,0 +1,167 @@ +--- +external help file: +Module Name: Az.Elastic +online version: https://learn.microsoft.com/powershell/module/az.elastic/get-azelastictagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Get-AzElasticTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Get-AzElasticTagRule.md +--- + +# Get-AzElasticTagRule + +## SYNOPSIS +Get a tag rule set for a given monitor resource. + +## SYNTAX + +### Get (Default) +``` +Get-AzElasticTagRule -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzElasticTagRule -InputObject <IElasticIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a tag rule set for a given monitor resource. + +## EXAMPLES + +### Example 1: Get a tag rule set for a given monitor resource +```powershell +Get-AzElasticTagRule -ResourceGroupName azure-elastic-test -MonitorName elastic-pwsh02 +``` + +```output +Name ProvisioningState ResourceGroupName +---- ----------------- ----------------- +default Succeeded azure-elastic-test +``` + +This command gets a tag rule set for a given monitor resource. + +### Example 2: Get a tag rule set for a given monitor resource by pipeline +```powershell +New-AzElasticTagRule -ResourceGroupName azps-elastic-test -MonitorName elastic-pwsh02 | Get-AzElasticTagRule +``` + +```output +Name ProvisioningState ResourceGroupName +---- ----------------- ----------------- +default Succeeded azure-elastic-test +``` + +This command gets a tag rule set for a given monitor resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.IElasticIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the Elastic resource belongs. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.IElasticIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.Api20200701.IMonitoringTagRules + +## 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 `<IElasticIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group to which the Elastic resource belongs. + - `[RuleSetName <String>]`: Tag Rule Set resource name + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Elastic/Get-AzElasticVMHost.md b/azps-10.1.0/Az.Elastic/Get-AzElasticVMHost.md new file mode 100644 index 0000000000..e18f70c927 --- /dev/null +++ b/azps-10.1.0/Az.Elastic/Get-AzElasticVMHost.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.Elastic +online version: https://learn.microsoft.com/powershell/module/az.elastic/get-azelasticvmhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Get-AzElasticVMHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Get-AzElasticVMHost.md +--- + +# Get-AzElasticVMHost + +## SYNOPSIS +List the vm resources currently being monitored by the Elastic monitor resource. + +## SYNTAX + +``` +Get-AzElasticVMHost -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List the vm resources currently being monitored by the Elastic monitor resource. + +## EXAMPLES + +### Example 1: List the vm resources currently being monitored by the Elastic monitor resource +```powershell +Get-AzElasticVMHost -ResourceGroupName azure-elastic-test -Name elastic-pwsh02 +``` + +```output +VMResourceId +------------ +/subscriptions/xxxxxx-xxxxx-xxxx-xxxxxx/resourceGroups/vidhi-rg/providers/Microsoft.Compute/virtualMachines/vidhi-linuxOS +``` + +This command lists the vm resources currently being monitored by the Elastic monitor resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the Elastic resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.Api20200701.IVMResources + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Elastic/New-AzElasticFilteringTagObject.md b/azps-10.1.0/Az.Elastic/New-AzElasticFilteringTagObject.md new file mode 100644 index 0000000000..1c56ebfd55 --- /dev/null +++ b/azps-10.1.0/Az.Elastic/New-AzElasticFilteringTagObject.md @@ -0,0 +1,101 @@ +--- +external help file: +Module Name: Az.Elastic +online version: https://learn.microsoft.com/powershell/module/az.Elastic/new-AzElasticFilteringTagObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/New-AzElasticFilteringTagObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/New-AzElasticFilteringTagObject.md +--- + +# New-AzElasticFilteringTagObject + +## SYNOPSIS +Create a in-memory object for FilteringTag + +## SYNTAX + +``` +New-AzElasticFilteringTagObject [-Action <TagAction>] [-Name <String>] [-Value <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for FilteringTag + +## EXAMPLES + +### Example 1: Create a in-memory object for FilteringTag used when creating tag rules +```powershell +$ft = New-AzElasticFilteringTagObject -Action Include -Name key -Value '1' +New-AzElasticTagRule -ResourceGroupName azure-elastic-test -MonitorName elastic-pwsh02 -LogRuleFilteringTag $ft +``` + +```output +Name Type +---- ---- +default microsoft.elastic/monitors/tagrules +``` + +This command creates a in-memory object for FilteringTag used when creating tag rules + +## PARAMETERS + +### -Action +Valid actions for a filtering tag. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Elastic.Support.TagAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name (also known as the key) of the tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The value of the tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.Api20200701.FilteringTag + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Elastic/New-AzElasticMonitor.md b/azps-10.1.0/Az.Elastic/New-AzElasticMonitor.md new file mode 100644 index 0000000000..04058bd8de --- /dev/null +++ b/azps-10.1.0/Az.Elastic/New-AzElasticMonitor.md @@ -0,0 +1,393 @@ +--- +external help file: +Module Name: Az.Elastic +online version: https://learn.microsoft.com/powershell/module/az.elastic/new-azelasticmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/New-AzElasticMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/New-AzElasticMonitor.md +--- + +# New-AzElasticMonitor + +## SYNOPSIS +Create a monitor resource. + +## SYNTAX + +``` +New-AzElasticMonitor -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-CompanyInfoBusiness <String>] [-CompanyInfoCountry <String>] [-CompanyInfoDomain <String>] + [-CompanyInfoEmployeesNumber <String>] [-CompanyInfoState <String>] [-IdentityType <ManagedIdentityTypes>] + [-MonitoringStatus <MonitoringStatus>] [-Sku <String>] [-Tag <Hashtable>] [-UserInfoCompanyName <String>] + [-UserInfoEmailAddress <String>] [-UserInfoFirstName <String>] [-UserInfoLastName <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a monitor resource. + +## EXAMPLES + +### Example 1: Create a monitor resource +```powershell +New-AzElasticMonitor -ResourceGroupName azps-elastic-test -Name elastic-pwsh02 -Location "westus2" -Sku "ess-monthly-consumption_Monthly" -UserInfoEmailAddress 'xxx@microsoft.com' +``` + +```output +Name SkuName MonitoringStatus Location ResourceGroupName +---- ------- ---------------- -------- ----------------- +elastic-pwsh02 ess-monthly-consumption_Monthly Enabled westus2 azure-elastic-test +``` + +This command creates a monitor resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyInfoBusiness +Business of the company + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyInfoCountry +Country of the company location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyInfoDomain +Domain of the company + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyInfoEmployeesNumber +Number of employees in the company + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyInfoState +State of the company location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Managed identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Elastic.Support.ManagedIdentityTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the monitor resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoringStatus +Flag specifying if the resource monitoring is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Elastic.Support.MonitoringStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the Elastic resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +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 Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags of the monitor resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoCompanyName +Company name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoEmailAddress +Email of the user used by Elastic for contacting them if needed + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoFirstName +First name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoLastName +Last name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.Api20200701.IElasticMonitorResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Elastic/New-AzElasticTagRule.md b/azps-10.1.0/Az.Elastic/New-AzElasticTagRule.md new file mode 100644 index 0000000000..e8244cd15c --- /dev/null +++ b/azps-10.1.0/Az.Elastic/New-AzElasticTagRule.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.Elastic +online version: https://learn.microsoft.com/powershell/module/az.elastic/new-azelastictagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/New-AzElasticTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/New-AzElasticTagRule.md +--- + +# New-AzElasticTagRule + +## SYNOPSIS +Create or update a tag rule set for a given monitor resource. + +## SYNTAX + +``` +New-AzElasticTagRule -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-LogRuleFilteringTag <IFilteringTag[]>] [-LogRuleSendAadLog] [-LogRuleSendActivityLog] + [-LogRuleSendSubscriptionLog] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a tag rule set for a given monitor resource. + +## EXAMPLES + +### Example 1: Create or update a tag rule set for a given monitor resource +```powershell +New-AzElasticTagRule -ResourceGroupName azps-elastic-test -MonitorName elastic-pwsh02 -LogRuleSendActivityLog +``` + +```output +Name ProvisioningState ResourceGroupName +---- ----------------- ----------------- +default Succeeded azps-elastic-test +``` + +This command creates or updates a tag rule set for a given monitor resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleFilteringTag +List of filtering tags to be used for capturing logs. +This only takes effect if SendActivityLogs flag is enabled. +If empty, all resources will be captured. +If only Exclude action is specified, the rules will apply to the list of all available resources. +If Include actions are specified, the rules will only include resources with the associated tags. +To construct, see NOTES section for LOGRULEFILTERINGTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.Api20200701.IFilteringTag[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendAadLog +Flag specifying if AAD logs should be sent for the Monitor resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendActivityLog +Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendSubscriptionLog +Flag specifying if subscription logs should be sent for the Monitor resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the Elastic resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.Api20200701.IMonitoringTagRules + +## 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. + + +LOGRULEFILTERINGTAG <IFilteringTag[]>: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. + - `[Action <TagAction?>]`: Valid actions for a filtering tag. + - `[Name <String>]`: The name (also known as the key) of the tag. + - `[Value <String>]`: The value of the tag. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Elastic/Remove-AzElasticMonitor.md b/azps-10.1.0/Az.Elastic/Remove-AzElasticMonitor.md new file mode 100644 index 0000000000..72ec244fbc --- /dev/null +++ b/azps-10.1.0/Az.Elastic/Remove-AzElasticMonitor.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.Elastic +online version: https://learn.microsoft.com/powershell/module/az.elastic/remove-azelasticmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Remove-AzElasticMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Remove-AzElasticMonitor.md +--- + +# Remove-AzElasticMonitor + +## SYNOPSIS +Delete a monitor resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzElasticMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzElasticMonitor -InputObject <IElasticIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a monitor resource. + +## EXAMPLES + +### Example 1: Delete a monitor resource +```powershell +Remove-AzElasticMonitor -ResourceGroupName azure-elastic-test -Name elastic-pwsh02 +``` + +This command delete a monitor resource. + +### Example 2: Delete a monitor resource by pipeline +```powershell +Get-AzElasticMonitor -ResourceGroupName azure-elastic-test -Name elastic-pwsh03 | Remove-AzElasticMonitor +``` + +This command delete a monitor resource by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.IElasticIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the Elastic resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.IElasticIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IElasticIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group to which the Elastic resource belongs. + - `[RuleSetName <String>]`: Tag Rule Set resource name + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Elastic/Update-AzElasticMonitor.md b/azps-10.1.0/Az.Elastic/Update-AzElasticMonitor.md new file mode 100644 index 0000000000..d69ffe5520 --- /dev/null +++ b/azps-10.1.0/Az.Elastic/Update-AzElasticMonitor.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.Elastic +online version: https://learn.microsoft.com/powershell/module/az.elastic/update-azelasticmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Update-AzElasticMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Update-AzElasticMonitor.md +--- + +# Update-AzElasticMonitor + +## SYNOPSIS +Update a monitor resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzElasticMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzElasticMonitor -InputObject <IElasticIdentity> [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a monitor resource. + +## EXAMPLES + +### Example 1: Update a monitor resource +```powershell +Update-AzElasticMonitor -ResourceGroupName lucas-elastic-test -Name elastic-pwsh02 -Tag @{'key01' = '1'; 'key2' = '2'; 'key3' = '3'} +``` + +```output +Name SkuName MonitoringStatus Location ResourceGroupName +---- ------- ---------------- -------- ----------------- +elastic-pwsh02 ess-monthly-consumption_Monthly Enabled westus2 azure-elastic-test +``` + +This command updates a monitor resource. + +### Example 2: Update a monitor resource by pipeline +```powershell +Get-AzElasticMonitor -ResourceGroupName lucas-elastic-test -Name elastic-pwsh02 | Update-AzElasticMonitor -Tag @{'key01' = '1'; 'key2' = '2'; 'key3' = '3'} +``` + +```output +Name SkuName MonitoringStatus Location ResourceGroupName +---- ------- ---------------- -------- ----------------- +elastic-pwsh02 ess-monthly-consumption_Monthly Enabled westus2 azure-elastic-test +``` + +This command updates a monitor resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.IElasticIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the Elastic resource belongs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +elastic monitor resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.IElasticIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.Api20200701.IElasticMonitorResource + +## 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 `<IElasticIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group to which the Elastic resource belongs. + - `[RuleSetName <String>]`: Tag Rule Set resource name + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Elastic/Update-AzElasticVMCollection.md b/azps-10.1.0/Az.Elastic/Update-AzElasticVMCollection.md new file mode 100644 index 0000000000..08f1479c24 --- /dev/null +++ b/azps-10.1.0/Az.Elastic/Update-AzElasticVMCollection.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.Elastic +online version: https://learn.microsoft.com/powershell/module/az.elastic/update-azelasticvmcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Update-AzElasticVMCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Elastic/help/Update-AzElasticVMCollection.md +--- + +# Update-AzElasticVMCollection + +## SYNOPSIS +Update the vm details that will be monitored by the Elastic monitor resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzElasticVMCollection -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-OperationName <OperationName>] [-VMResourceId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzElasticVMCollection -InputObject <IElasticIdentity> [-OperationName <OperationName>] + [-VMResourceId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update the vm details that will be monitored by the Elastic monitor resource. + +## EXAMPLES + +### Example 1: Update the vm details that will be monitored by the Elastic monitor resource +```powershell +Update-AzElasticVMCollection -ResourceGroupName lucas-elastic-test -Name elastic-pwsh02 -OperationName Add -VMResourceId '/subscriptions/xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxx/resourceGroups/VIDHI-RG/providers/Microsoft.Compute/virtualMachines/vidhi-linuxOS' +``` + +This command updates the vm details that will be monitored by the Elastic monitor resource + +### Example 2: Update the vm details that will be monitored by the Elastic monitor resource by pipeline +```powershell +Get-AzElasticMonitor -ResourceGroupName lucas-elastic-test -Name elastic-pwsh02 | Update-AzElasticVMCollection -OperationName Delete -VMResourceId '/subscriptions/xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxx/resourceGroups/VIDHI-RG/providers/Microsoft.Compute/virtualMachines/vidhi-linuxOS' +``` + +This command updates the vm details that will be monitored by the Elastic monitor resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.IElasticIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationName +Operation to be performed for given VM. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Elastic.Support.OperationName +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to which the Elastic resource belongs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMResourceId +ARM id of the VM resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Elastic.Models.IElasticIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IElasticIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group to which the Elastic resource belongs. + - `[RuleSetName <String>]`: Tag Rule Set resource name + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/Add-AzElasticSanVolumeGroupNetworkRule.md b/azps-10.1.0/Az.ElasticSan/Add-AzElasticSanVolumeGroupNetworkRule.md new file mode 100644 index 0000000000..f3bd73c32d --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/Add-AzElasticSanVolumeGroupNetworkRule.md @@ -0,0 +1,268 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/add-azelasticsanvolumegroupnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Add-AzElasticSanVolumeGroupNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Add-AzElasticSanVolumeGroupNetworkRule.md +--- + +# Add-AzElasticSanVolumeGroupNetworkRule + +## SYNOPSIS +Add a list of virtual network rules to a VolumeGroup + +## SYNTAX + +### NetworkRuleObject (Default) +``` +Add-AzElasticSanVolumeGroupNetworkRule -ElasticSanName <String> -ResourceGroupName <String> + -VolumeGroupName <String> -NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### NetworkRuleResourceId +``` +Add-AzElasticSanVolumeGroupNetworkRule -ElasticSanName <String> -ResourceGroupName <String> + -VolumeGroupName <String> -NetworkAclsVirtualNetworkResourceId <String[]> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Add a list of virtual network rules to a VolumeGroup + +## EXAMPLES + +### Example 1: Add network rules to a volume group by NetworkAclsVirtualNetworkRule objects +```powershell +$virtualNetworkRule1 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1" -Action Allow +$virtualNetworkRule2 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2" -Action Allow + +Add-AzElasticSanVolumeGroupNetworkRule -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -NetworkAclsVirtualNetworkRule $virtualNetworkRule1,$virtualNetworkRule2 +``` + +```output +Action State VirtualNetworkResourceId +------ ----- ------------------------ +Allow /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1 +Allow /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2 +``` + +This example creates two NetworkAclsVirtualNetworkRule objects using virtual network resource Ids, and then adds the network rules to a volume group. +The command outputs all the network rule objects in the volume group after the addition operation. + +### Example 2: Add network rules to a volume group by resource Ids +```powershell +$virtualNetworkResourceId1 = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1" +$virtualNetworkResourceId2 = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2" + +Add-AzElasticSanVolumeGroupNetworkRule -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -NetworkAclsVirtualNetworkResourceId $virtualNetworkResourceId1,$virtualNetworkResourceId2 +``` + +```output +Action State VirtualNetworkResourceId +------ ----- ------------------------ +Allow /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1 +Allow /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2 +``` + +This example adds two virtual network rules to a volume group using the network rule resource Ids. +The command outputs all the network rule objects in the volume group after the addition operation. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkAclsVirtualNetworkResourceId +The list of virtual network rule resource Ids. +To construct, see NOTES section for NETWORKACLSVIRTUALNETWORKRULE properties and create a hash table. + +```yaml +Type: System.String[] +Parameter Sets: NetworkRuleResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkAclsVirtualNetworkRule +The list of virtual network rules. +To construct, see NOTES section for NETWORKACLSVIRTUALNETWORKRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVirtualNetworkRule[] +Parameter Sets: NetworkRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeGroupName +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVirtualNetworkRule[] + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.VirtualNetworkRule[] + +## 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. + + +`NETWORKACLSVIRTUALNETWORKRULE <IVirtualNetworkRule[]>`: The list of virtual network rules. + - `VirtualNetworkResourceId <String>`: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + - `[Action <Action?>]`: The action of virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/Az.ElasticSan.md b/azps-10.1.0/Az.ElasticSan/Az.ElasticSan.md new file mode 100644 index 0000000000..25b3e181e4 --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/Az.ElasticSan.md @@ -0,0 +1,63 @@ +--- +Module Name: Az.ElasticSan +Module Guid: ed90c36c-f150-4ad2-96ae-57e0ebb0a376 +Download Help Link: https://learn.microsoft.com/powershell/module/az.elasticsan +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Az.ElasticSan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Az.ElasticSan.md +--- + +# Az.ElasticSan Module +## Description +Microsoft Azure PowerShell: ElasticSan cmdlets + +## Az.ElasticSan Cmdlets +### [Add-AzElasticSanVolumeGroupNetworkRule](Add-AzElasticSanVolumeGroupNetworkRule.md) +Add a list of virtual network rules to a VolumeGroup + +### [Get-AzElasticSan](Get-AzElasticSan.md) +Get either a list of Elastic SANs from a subscription or a resource group, or get a single Elastic SAN. + +### [Get-AzElasticSanSkuList](Get-AzElasticSanSkuList.md) +List all the available Skus in the region and information related to them + +### [Get-AzElasticSanVolume](Get-AzElasticSanVolume.md) +Get either a list of all volumes from a volume group or get a single volume from a volume group. + +### [Get-AzElasticSanVolumeGroup](Get-AzElasticSanVolumeGroup.md) +Get either a list of all volume groups from an Elastic SAN or get a single volume group from an Elastic SAN. + +### [New-AzElasticSan](New-AzElasticSan.md) +Create ElasticSan. + +### [New-AzElasticSanVirtualNetworkRuleObject](New-AzElasticSanVirtualNetworkRuleObject.md) +Create an in-memory object for VirtualNetworkRule. + +### [New-AzElasticSanVolume](New-AzElasticSanVolume.md) +Create a Volume. + +### [New-AzElasticSanVolumeGroup](New-AzElasticSanVolumeGroup.md) +Create a Volume Group. + +### [Remove-AzElasticSan](Remove-AzElasticSan.md) +Delete a Elastic San. + +### [Remove-AzElasticSanVolume](Remove-AzElasticSanVolume.md) +Delete an Volume. + +### [Remove-AzElasticSanVolumeGroup](Remove-AzElasticSanVolumeGroup.md) +Delete an VolumeGroup. + +### [Remove-AzElasticSanVolumeGroupNetworkRule](Remove-AzElasticSanVolumeGroupNetworkRule.md) +Remove a list of virtual network rules from a VolumeGroup + +### [Update-AzElasticSan](Update-AzElasticSan.md) +Update a Elastic San. + +### [Update-AzElasticSanVolume](Update-AzElasticSanVolume.md) +Update an Volume. + +### [Update-AzElasticSanVolumeGroup](Update-AzElasticSanVolumeGroup.md) +Update an VolumeGroup. + diff --git a/azps-10.1.0/Az.ElasticSan/Get-AzElasticSan.md b/azps-10.1.0/Az.ElasticSan/Get-AzElasticSan.md new file mode 100644 index 0000000000..3b04ef7f25 --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/Get-AzElasticSan.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/get-azelasticsan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Get-AzElasticSan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Get-AzElasticSan.md +--- + +# Get-AzElasticSan + +## SYNOPSIS +Get either a list of Elastic SANs from a subscription or a resource group, or get a single Elastic SAN. + +## SYNTAX + +### List (Default) +``` +Get-AzElasticSan [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzElasticSan -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzElasticSan -InputObject <IElasticSanIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzElasticSan -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get either a list of Elastic SANs from a subscription or a resource group, or get a single Elastic SAN. + +## EXAMPLES + +### Example 1: Get all Elastic SANs in a subscription +```powershell +Get-AzElasticSan +``` + +```output +AvailabilityZone : +BaseSizeTiB : 1 +ExtendedCapacitySizeTiB : 6 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup + /providers/Microsoft.ElasticSan/elasticSans/myelasticsan1 +Location : eastus +Name : myelasticsan1 +ProvisioningState : Succeeded +SkuName : Premium_LRS +SkuTier : +SystemDataCreatedAt : 9/19/2022 9:50:25 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/19/2022 9:50:25 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +TotalIops : 5000 +TotalMBps : 80 +TotalSizeTiB : 7 +TotalVolumeSizeGiB : 0 +Type : Microsoft.ElasticSan/ElasticSans +VolumeGroupCount : 0 + +AvailabilityZone : +BaseSizeTiB : 1 +ExtendedCapacitySizeTiB : 6 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micr + osoft.ElasticSan/elasticSans/myelasticsan2 +Location : eastus +Name : myelasticsan2 +ProvisioningState : Succeeded +SkuName : Premium_LRS +SkuTier : +SystemDataCreatedAt : 8/18/2022 8:42:21 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/18/2022 8:42:21 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +TotalIops : 5000 +TotalMBps : 80 +TotalSizeTiB : 7 +TotalVolumeSizeGiB : 100 +Type : Microsoft.ElasticSan/ElasticSans +VolumeGroupCount : 7 +``` + +This command gets all the Elastic SANs in a subscription. + +### Example 2: Get all Elastic Sans in a resource group +```powershell +Get-AzElasticSan -ResourceGroupName myresourcegroup +``` + +```output +AvailabilityZone : +BaseSizeTiB : 1 +ExtendedCapacitySizeTiB : 6 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup + /providers/Microsoft.ElasticSan/elasticSans/myelasticsan1 +Location : eastus +Name : myelasticsan1 +ProvisioningState : Succeeded +SkuName : Premium_LRS +SkuTier : +SystemDataCreatedAt : 9/19/2022 9:50:25 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/19/2022 9:50:25 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +TotalIops : 5000 +TotalMBps : 80 +TotalSizeTiB : 7 +TotalVolumeSizeGiB : 0 +Type : Microsoft.ElasticSan/ElasticSans +VolumeGroupCount : 0 + +AvailabilityZone : +BaseSizeTiB : 1 +ExtendedCapacitySizeTiB : 6 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micr + osoft.ElasticSan/elasticSans/myelasticsan2 +Location : eastus +Name : myelasticsan2 +ProvisioningState : Succeeded +SkuName : Premium_LRS +SkuTier : +SystemDataCreatedAt : 8/18/2022 8:42:21 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/18/2022 8:42:21 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +TotalIops : 5000 +TotalMBps : 80 +TotalSizeTiB : 7 +TotalVolumeSizeGiB : 100 +Type : Microsoft.ElasticSan/ElasticSans +VolumeGroupCount : 7 +``` + +This command gets all Elastic SANs in a resource group. + +### Example 3: Get a specific Elastic SAN +```powershell +Get-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan +``` + +```output +AvailabilityZone : +BaseSizeTiB : 1 +ExtendedCapacitySizeTiB : 6 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micr + osoft.ElasticSan/elasticSans/myelasticsan +Location : eastus +Name : myelasticsan +ProvisioningState : Succeeded +SkuName : Premium_LRS +SkuTier : +SystemDataCreatedAt : 8/18/2022 8:42:21 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/18/2022 8:42:21 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +TotalIops : 5000 +TotalMBps : 80 +TotalSizeTiB : 7 +TotalVolumeSizeGiB : 100 +Type : Microsoft.ElasticSan/ElasticSans +VolumeGroupCount : 7 +``` + +This command gets a specific Elastic SAN. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ElasticSanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IElasticSan + +## 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 <IElasticSanIdentity>`: Identity Parameter + - `[ElasticSanName <String>]`: The name of the ElasticSan. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VolumeGroupName <String>]`: The name of the VolumeGroup. + - `[VolumeName <String>]`: The name of the Volume. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/Get-AzElasticSanSkuList.md b/azps-10.1.0/Az.ElasticSan/Get-AzElasticSanSkuList.md new file mode 100644 index 0000000000..04e1ec9b18 --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/Get-AzElasticSanSkuList.md @@ -0,0 +1,103 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/get-azelasticsanskulist +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Get-AzElasticSanSkuList.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Get-AzElasticSanSkuList.md +--- + +# Get-AzElasticSanSkuList + +## SYNOPSIS +List all the available Skus in the region and information related to them + +## SYNTAX + +``` +Get-AzElasticSanSkuList [-SubscriptionId <String[]>] [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +List all the available Skus in the region and information related to them + +## EXAMPLES + +### Example 1: Get all the available Skus +```powershell +Get-AzElasticSanSkuList +``` + +```output +Location Name ResourceType Tier +-------- ---- ------------ ---- +{eastus} Premium_LRS elasticSans Premium +{eastus2} Premium_LRS elasticSans Premium +``` + +This command gets all the available Skus. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Specify $filter='location eq \<location\>' to filter on location. + +```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. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ISkuInformation + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/Get-AzElasticSanVolume.md b/azps-10.1.0/Az.ElasticSan/Get-AzElasticSanVolume.md new file mode 100644 index 0000000000..4c31bc627d --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/Get-AzElasticSanVolume.md @@ -0,0 +1,256 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/get-azelasticsanvolume +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Get-AzElasticSanVolume.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Get-AzElasticSanVolume.md +--- + +# Get-AzElasticSanVolume + +## SYNOPSIS +Get either a list of all volumes from a volume group or get a single volume from a volume group. + +## SYNTAX + +### List (Default) +``` +Get-AzElasticSanVolume -ElasticSanName <String> -ResourceGroupName <String> -VolumeGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzElasticSanVolume -ElasticSanName <String> -Name <String> -ResourceGroupName <String> + -VolumeGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzElasticSanVolume -InputObject <IElasticSanIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get either a list of all volumes from a volume group or get a single volume from a volume group. + +## EXAMPLES + +### Example 1: Get all volumes in a volume group +```powershell +Get-AzElasticSanVolume -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup +``` + +```output +CreationDataCreateSource : +CreationDataSourceUri : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup/volumes/myvolume1 +Name : myvolume1 +SizeGiB : 120 +StorageTargetIqn : iqn.2022-09.net.windows.core.blob.ElasticSan.es-3ibot5m2r3y0:myvolume1 +StorageTargetPortalHostname : es-3ibot5m2r3y0.z1.blob.storage.azure.net +StorageTargetPortalPort : 3260 +StorageTargetProvisioningState : Succeeded +StorageTargetStatus : Running +SystemDataCreatedAt : 9/19/2022 2:39:28 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/19/2022 2:39:28 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +Type : Microsoft.ElasticSan/ElasticSans +VolumeId : abababab-abab-abab-abab-abababababab + +CreationDataCreateSource : +CreationDataSourceUri : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup/volumes/myvolume2 +Name : myvolume2 +SizeGiB : 100 +StorageTargetIqn : iqn.2022-09.net.windows.core.blob.ElasticSan.es-3ibot5m2r3y0:myvolume2 +StorageTargetPortalHostname : es-3ibot5m2r3y0.z1.blob.storage.azure.net +StorageTargetPortalPort : 3260 +StorageTargetProvisioningState : Succeeded +StorageTargetStatus : Running +SystemDataCreatedAt : 9/19/2022 2:39:28 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/19/2022 2:39:28 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +Type : Microsoft.ElasticSan/ElasticSans +VolumeId : cdcdcdcd-cdcd-cdcd-cdcd-cdcdcdcdcdcd +``` + +This command gets all the volumes in a volume group. + +### Example 2: Get a specific volume +```powershell +Get-AzElasticSanVolume -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -Name myvolume +``` + +```output +CreationDataCreateSource : +CreationDataSourceUri : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup/volumes/myvolume +Name : myvolume +SizeGiB : 100 +StorageTargetIqn : iqn.2022-09.net.windows.core.blob.ElasticSan.es-3ibot5m2r3y0:myvolume +StorageTargetPortalHostname : es-3ibot5m2r3y0.z1.blob.storage.azure.net +StorageTargetPortalPort : 3260 +StorageTargetProvisioningState : Succeeded +StorageTargetStatus : Running +SystemDataCreatedAt : 9/19/2022 2:39:28 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/19/2022 2:39:28 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +Type : Microsoft.ElasticSan/ElasticSans +VolumeId : abababab-abab-abab-abab-abababababab +``` + +This command gets a specific volume. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Volume. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeGroupName +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolume + +## 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 <IElasticSanIdentity>`: Identity Parameter + - `[ElasticSanName <String>]`: The name of the ElasticSan. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VolumeGroupName <String>]`: The name of the VolumeGroup. + - `[VolumeName <String>]`: The name of the Volume. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/Get-AzElasticSanVolumeGroup.md b/azps-10.1.0/Az.ElasticSan/Get-AzElasticSanVolumeGroup.md new file mode 100644 index 0000000000..43dbbdfa77 --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/Get-AzElasticSanVolumeGroup.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/get-azelasticsanvolumegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Get-AzElasticSanVolumeGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Get-AzElasticSanVolumeGroup.md +--- + +# Get-AzElasticSanVolumeGroup + +## SYNOPSIS +Get either a list of all volume groups from an Elastic SAN or get a single volume group from an Elastic SAN. + +## SYNTAX + +### List (Default) +``` +Get-AzElasticSanVolumeGroup -ElasticSanName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzElasticSanVolumeGroup -ElasticSanName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzElasticSanVolumeGroup -InputObject <IElasticSanIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get either a list of all volume groups from an Elastic SAN or get a single volume group from an Elastic SAN. + +## EXAMPLES + +### Example 1: Get all volume groups in an Elastic SAN +```powershell +Get-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan +``` + +```output +Encryption : EncryptionAtRestWithPlatformKey +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup1 +Name : myvolumegroup1 +NetworkAclsVirtualNetworkRule : +ProtocolType : iSCSI +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/18/2022 8:43:35 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/18/2022 8:43:35 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +Type : Microsoft.ElasticSan/ElasticSans + +Encryption : EncryptionAtRestWithPlatformKey +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup2 +Name : myvolumegroup2 +NetworkAclsVirtualNetworkRule : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet3, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet4, + /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2} +ProtocolType : iSCSI +ProvisioningState : Succeeded +SystemDataCreatedAt : 9/20/2022 2:37:33 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/20/2022 2:37:33 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +Type : Microsoft.ElasticSan/ElasticSans +``` + +This command gets all the volume groups in the Elastic SAN myelasticsan. + +### Example 2: Get a specific volume group +```powershell +Get-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -Name myvolumegroup +``` + +```output +Encryption : EncryptionAtRestWithPlatformKey +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup +Name : myvolumegroup +NetworkAclsVirtualNetworkRule : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2} +ProtocolType : iSCSI +ProvisioningState : Succeeded +SystemDataCreatedAt : 9/19/2022 7:05:47 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/19/2022 7:05:47 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +Type : Microsoft.ElasticSan/ElasticSans +``` + +This command gets a specific volume group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: VolumeGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolumeGroup + +## 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 <IElasticSanIdentity>`: Identity Parameter + - `[ElasticSanName <String>]`: The name of the ElasticSan. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VolumeGroupName <String>]`: The name of the VolumeGroup. + - `[VolumeName <String>]`: The name of the Volume. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/New-AzElasticSan.md b/azps-10.1.0/Az.ElasticSan/New-AzElasticSan.md new file mode 100644 index 0000000000..0811db13f1 --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/New-AzElasticSan.md @@ -0,0 +1,391 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/new-azelasticsan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/New-AzElasticSan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/New-AzElasticSan.md +--- + +# New-AzElasticSan + +## SYNOPSIS +Create ElasticSan. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzElasticSan -Name <String> -ResourceGroupName <String> -BaseSizeTiB <Int64> + -ExtendedCapacitySizeTiB <Int64> -SkuName <SkuName> [-SubscriptionId <String>] [-AvailabilityZone <String[]>] + [-Location <String>] [-SkuTier <SkuTier>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzElasticSan -Name <String> -ResourceGroupName <String> -Parameter <IElasticSan> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CreateViaIdentity +``` +New-AzElasticSan -InputObject <IElasticSanIdentity> -Parameter <IElasticSan> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzElasticSan -InputObject <IElasticSanIdentity> -BaseSizeTiB <Int64> -ExtendedCapacitySizeTiB <Int64> + -SkuName <SkuName> [-AvailabilityZone <String[]>] [-Location <String>] [-SkuTier <SkuTier>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create ElasticSan. + +## EXAMPLES + +### Example 1: Create an Elastic SAN +```powershell +New-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan -BaseSizeTib 1 -ExtendedCapacitySizeTib 6 -Location eastus -SkuName 'Premium_LRS' -Tag @{tag1="value1";tag2="value2"} +``` + +```output +AvailabilityZone : +BaseSizeTiB : 1 +ExtendedCapacitySizeTiB : 6 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan +Location : eastus +Name : myelasticsan +ProvisioningState : Succeeded +SkuName : Premium_LRS +SkuTier : +SystemDataCreatedAt : 9/19/2022 9:47:26 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/19/2022 9:47:26 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +TotalIops : 5000 +TotalMBps : 80 +TotalSizeTiB : 7 +TotalVolumeSizeGiB : 0 +Type : Microsoft.ElasticSan/ElasticSans +VolumeGroupCount : 0 +``` + +This command creates an Elastic SAN. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityZone +Logical zone for Elastic San resource; example: ["1"]. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BaseSizeTiB +Base size of the Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedCapacitySizeTiB +Extended size of the Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: ElasticSanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Response for ElasticSan request. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IElasticSan +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The sku name. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Support.SkuName +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +The sku tier. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Support.SkuTier +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Azure resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IElasticSan + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IElasticSan + +## 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 <IElasticSanIdentity>`: Identity Parameter + - `[ElasticSanName <String>]`: The name of the ElasticSan. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VolumeGroupName <String>]`: The name of the VolumeGroup. + - `[VolumeName <String>]`: The name of the Volume. + +`PARAMETER <IElasticSan>`: Response for ElasticSan request. + - `BaseSizeTiB <Int64>`: Base size of the Elastic San appliance in TiB. + - `ExtendedCapacitySizeTiB <Int64>`: Extended size of the Elastic San appliance in TiB. + - `SkuName <SkuName>`: The sku name. + - `[Location <String>]`: The geo-location where the resource lives. + - `[Tag <IResourceTags>]`: Azure resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AvailabilityZone <String[]>]`: Logical zone for Elastic San resource; example: ["1"]. + - `[SkuTier <SkuTier?>]`: The sku tier. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/New-AzElasticSanVirtualNetworkRuleObject.md b/azps-10.1.0/Az.ElasticSan/New-AzElasticSanVirtualNetworkRuleObject.md new file mode 100644 index 0000000000..0312d8c0cb --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/New-AzElasticSanVirtualNetworkRuleObject.md @@ -0,0 +1,86 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/Az.ElasticSan/new-AzElasticSanVirtualNetworkRuleObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/New-AzElasticSanVirtualNetworkRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/New-AzElasticSanVirtualNetworkRuleObject.md +--- + +# New-AzElasticSanVirtualNetworkRuleObject + +## SYNOPSIS +Create an in-memory object for VirtualNetworkRule. + +## SYNTAX + +``` +New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId <String> [-Action <Action>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for VirtualNetworkRule. + +## EXAMPLES + +### Example 1: Create a virtual network rule object +```powershell +New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1" -Action Allow +``` + +```output +Action State VirtualNetworkResourceId +------ ----- ------------------------ +Allow /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1 +``` + +This command creates a new virtual network rule object using the virtual network resource Id. + +## PARAMETERS + +### -Action +The action of virtual network rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Support.Action +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkResourceId +Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.VirtualNetworkRule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/New-AzElasticSanVolume.md b/azps-10.1.0/Az.ElasticSan/New-AzElasticSanVolume.md new file mode 100644 index 0000000000..91f29f8449 --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/New-AzElasticSanVolume.md @@ -0,0 +1,372 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/new-azelasticsanvolume +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/New-AzElasticSanVolume.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/New-AzElasticSanVolume.md +--- + +# New-AzElasticSanVolume + +## SYNOPSIS +Create a Volume. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzElasticSanVolume -ElasticSanName <String> -Name <String> -ResourceGroupName <String> + -VolumeGroupName <String> [-SubscriptionId <String>] [-CreationDataCreateSource <VolumeCreateOption>] + [-CreationDataSourceUri <String>] [-SizeGiB <Int64>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzElasticSanVolume -ElasticSanName <String> -Name <String> -ResourceGroupName <String> + -VolumeGroupName <String> -Parameter <IVolume> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentity +``` +New-AzElasticSanVolume -InputObject <IElasticSanIdentity> -Parameter <IVolume> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzElasticSanVolume -InputObject <IElasticSanIdentity> [-CreationDataCreateSource <VolumeCreateOption>] + [-CreationDataSourceUri <String>] [-SizeGiB <Int64>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a Volume. + +## EXAMPLES + +### Example 1: Create a volume +```powershell +New-AzElasticSanVolume -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -Name myvolumegroup -SizeGib 100 -CreationDataSourceUri 'https://abc.com' -Tag @{tag1="value1";tag2="value2"} +``` + +```output +CreationDataCreateSource : +CreationDataSourceUri : https://abc.com +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup/volumes/myvolume +Name : myvolume +SizeGiB : 100 +StorageTargetIqn : iqn.2022-09.net.windows.core.blob.ElasticSan.es-3ibot5m2r3y0:myvolume +StorageTargetPortalHostname : es-3ibot5m2r3y0.z1.blob.storage.azure.net +StorageTargetPortalPort : 3260 +StorageTargetProvisioningState : Succeeded +StorageTargetStatus : Running +SystemDataCreatedAt : 9/19/2022 2:39:28 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/19/2022 2:39:28 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +Type : Microsoft.ElasticSan/ElasticSans +VolumeId : abababab-abab-abab-abab-abababababab +``` + +This command creates a volume. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreationDataCreateSource +This enumerates the possible sources of a volume creation. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Support.VolumeCreateOption +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreationDataSourceUri +If createOption is Copy, this is the ARM id of the source snapshot or disk. +If createOption is Restore, this is the ARM-like id of the source disk restore point. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Volume. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Response for Volume request. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolume +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SizeGiB +Volume size. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Azure resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeGroupName +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolume + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolume + +## 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 <IElasticSanIdentity>`: Identity Parameter + - `[ElasticSanName <String>]`: The name of the ElasticSan. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VolumeGroupName <String>]`: The name of the VolumeGroup. + - `[VolumeName <String>]`: The name of the Volume. + +`PARAMETER <IVolume>`: Response for Volume request. + - `[Tag <IResourceTags>]`: Azure resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[CreationDataCreateSource <VolumeCreateOption?>]`: This enumerates the possible sources of a volume creation. + - `[CreationDataSourceUri <String>]`: If createOption is Copy, this is the ARM id of the source snapshot or disk. If createOption is Restore, this is the ARM-like id of the source disk restore point. + - `[SizeGiB <Int64?>]`: Volume size. + - `[StorageTargetStatus <OperationalStatus?>]`: Operational status of the iSCSI Target. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/New-AzElasticSanVolumeGroup.md b/azps-10.1.0/Az.ElasticSan/New-AzElasticSanVolumeGroup.md new file mode 100644 index 0000000000..c6e9e6e9fb --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/New-AzElasticSanVolumeGroup.md @@ -0,0 +1,389 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/new-azelasticsanvolumegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/New-AzElasticSanVolumeGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/New-AzElasticSanVolumeGroup.md +--- + +# New-AzElasticSanVolumeGroup + +## SYNOPSIS +Create a Volume Group. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzElasticSanVolumeGroup -ElasticSanName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Encryption <EncryptionType>] + [-NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]>] [-ProtocolType <StorageTargetType>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzElasticSanVolumeGroup -ElasticSanName <String> -Name <String> -ResourceGroupName <String> + -Parameter <IVolumeGroup> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentity +``` +New-AzElasticSanVolumeGroup -InputObject <IElasticSanIdentity> -Parameter <IVolumeGroup> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzElasticSanVolumeGroup -InputObject <IElasticSanIdentity> [-Encryption <EncryptionType>] + [-NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]>] [-ProtocolType <StorageTargetType>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a Volume Group. + +## EXAMPLES + +### Example 1: Create a volume group with network rule objects +```powershell +$virtualNetworkRule1 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1" -Action Allow +$virtualNetworkRule2 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2" -Action Allow + +New-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -Name myvolumegroup -ProtocolType 'Iscsi' -Tag @{tag1="value1";tag2="value2"} -NetworkAclsVirtualNetworkRule $virtualNetworkRule1,$virtualNetworkRule2 +``` + +```output +Encryption : EncryptionAtRestWithPlatformKey +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup +Name : myvolumegroup +NetworkAclsVirtualNetworkRule : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2} +ProtocolType : iSCSI +ProvisioningState : Succeeded +SystemDataCreatedAt : 9/19/2022 7:05:47 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/19/2022 7:05:47 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +Type : Microsoft.ElasticSan/ElasticSans +``` + +This example creates two VirtualNetworkRule objects and then input the objects and other variables to create a volume group. + +### Example 2: Create a volume group with network rule JSON input +```powershell +New-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -Name myvolumegroup -ProtocolType 'Iscsi' -Tag @{tag1="value1";tag2="value2"} ` + -NetworkAclsVirtualNetworkRule ( + @{VirtualNetworkResourceId="/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1"; + Action="Allow"}, + @{VirtualNetworkResourceId="/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2"; + Action="Allow"}) +``` + +```output +Encryption : EncryptionAtRestWithPlatformKey +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup +Name : myvolumegroup +NetworkAclsVirtualNetworkRule : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2} +ProtocolType : iSCSI +ProvisioningState : Succeeded +SystemDataCreatedAt : 9/19/2022 7:05:47 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/19/2022 7:05:47 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +Type : Microsoft.ElasticSan/ElasticSans +``` + +This command creates a volume group with the NetworkAclsVirtualNetworkRule input in json format. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Encryption +Type of encryption + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Support.EncryptionType +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +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.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: VolumeGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkAclsVirtualNetworkRule +The list of virtual network rules. +To construct, see NOTES section for NETWORKACLSVIRTUALNETWORKRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVirtualNetworkRule[] +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Response for Volume Group request. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolumeGroup +Parameter Sets: Create, CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProtocolType +Type of storage target + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Support.StorageTargetType +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Azure resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolumeGroup + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolumeGroup + +## 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 <IElasticSanIdentity>`: Identity Parameter + - `[ElasticSanName <String>]`: The name of the ElasticSan. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VolumeGroupName <String>]`: The name of the VolumeGroup. + - `[VolumeName <String>]`: The name of the Volume. + +`NETWORKACLSVIRTUALNETWORKRULE <IVirtualNetworkRule[]>`: The list of virtual network rules. + - `VirtualNetworkResourceId <String>`: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + - `[Action <Action?>]`: The action of virtual network rule. + +`PARAMETER <IVolumeGroup>`: Response for Volume Group request. + - `[Tag <IResourceTags>]`: Azure resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[Encryption <EncryptionType?>]`: Type of encryption + - `[NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]>]`: The list of virtual network rules. + - `VirtualNetworkResourceId <String>`: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + - `[Action <Action?>]`: The action of virtual network rule. + - `[ProtocolType <StorageTargetType?>]`: Type of storage target + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/Remove-AzElasticSan.md b/azps-10.1.0/Az.ElasticSan/Remove-AzElasticSan.md new file mode 100644 index 0000000000..4265b170c2 --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/Remove-AzElasticSan.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/remove-azelasticsan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Remove-AzElasticSan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Remove-AzElasticSan.md +--- + +# Remove-AzElasticSan + +## SYNOPSIS +Delete a Elastic San. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzElasticSan -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzElasticSan -InputObject <IElasticSanIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a Elastic San. + +## EXAMPLES + +### Example 1: Remove a specific Elastic SAN +```powershell +Remove-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan +``` + +This command removes a specific Elastic SAN. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ElasticSanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IElasticSanIdentity>`: Identity Parameter + - `[ElasticSanName <String>]`: The name of the ElasticSan. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VolumeGroupName <String>]`: The name of the VolumeGroup. + - `[VolumeName <String>]`: The name of the Volume. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/Remove-AzElasticSanVolume.md b/azps-10.1.0/Az.ElasticSan/Remove-AzElasticSanVolume.md new file mode 100644 index 0000000000..93de87c62c --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/Remove-AzElasticSanVolume.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/remove-azelasticsanvolume +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Remove-AzElasticSanVolume.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Remove-AzElasticSanVolume.md +--- + +# Remove-AzElasticSanVolume + +## SYNOPSIS +Delete an Volume. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzElasticSanVolume -ElasticSanName <String> -Name <String> -ResourceGroupName <String> + -VolumeGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzElasticSanVolume -InputObject <IElasticSanIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete an Volume. + +## EXAMPLES + +### Example 1: Remove a volume +```powershell +Remove-AzElasticSanVolume -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -Name myvolume +``` + +This command removes a volume. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Volume. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeGroupName +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IElasticSanIdentity>`: Identity Parameter + - `[ElasticSanName <String>]`: The name of the ElasticSan. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VolumeGroupName <String>]`: The name of the VolumeGroup. + - `[VolumeName <String>]`: The name of the Volume. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/Remove-AzElasticSanVolumeGroup.md b/azps-10.1.0/Az.ElasticSan/Remove-AzElasticSanVolumeGroup.md new file mode 100644 index 0000000000..b318d3d187 --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/Remove-AzElasticSanVolumeGroup.md @@ -0,0 +1,242 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/remove-azelasticsanvolumegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Remove-AzElasticSanVolumeGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Remove-AzElasticSanVolumeGroup.md +--- + +# Remove-AzElasticSanVolumeGroup + +## SYNOPSIS +Delete an VolumeGroup. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzElasticSanVolumeGroup -ElasticSanName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzElasticSanVolumeGroup -InputObject <IElasticSanIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete an VolumeGroup. + +## EXAMPLES + +### Example 1: Remove a volume group +```powershell +Remove-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -Name myvolumegroup +``` + +This command removes a specific volume group. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: VolumeGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IElasticSanIdentity>`: Identity Parameter + - `[ElasticSanName <String>]`: The name of the ElasticSan. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VolumeGroupName <String>]`: The name of the VolumeGroup. + - `[VolumeName <String>]`: The name of the Volume. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/Remove-AzElasticSanVolumeGroupNetworkRule.md b/azps-10.1.0/Az.ElasticSan/Remove-AzElasticSanVolumeGroupNetworkRule.md new file mode 100644 index 0000000000..df6432514a --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/Remove-AzElasticSanVolumeGroupNetworkRule.md @@ -0,0 +1,277 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/remove-azelasticsanvolumegroupnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Remove-AzElasticSanVolumeGroupNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Remove-AzElasticSanVolumeGroupNetworkRule.md +--- + +# Remove-AzElasticSanVolumeGroupNetworkRule + +## SYNOPSIS +Remove a list of virtual network rules from a VolumeGroup + +## SYNTAX + +### NetworkRuleObject (Default) +``` +Remove-AzElasticSanVolumeGroupNetworkRule -ElasticSanName <String> -ResourceGroupName <String> + -VolumeGroupName <String> -NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### NetworkRuleResourceId +``` +Remove-AzElasticSanVolumeGroupNetworkRule -ElasticSanName <String> -ResourceGroupName <String> + -VolumeGroupName <String> -NetworkAclsVirtualNetworkResourceId <String[]> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a list of virtual network rules from a VolumeGroup + +## EXAMPLES + +### Example 1: Remove network rules by NetworkAclsVirtualNetworkRule objects +```powershell +# Initialze network rule objects +$virtualNetworkRule1 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1" -Action Allow +$virtualNetworkRule2 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2" -Action Allow +$virtualNetworkRule3 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet3" -Action Allow +# Add the network rule objects to the volume group +$rules = Add-AzElasticSanVolumeGroupNetworkRule -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -NetworkAclsVirtualNetworkRule $virtualNetworkRule1,$virtualNetworkRule2,$virtualNetworkRule3 + +# Remove some of the network rules from the volume group +Remove-AzElasticSanVolumeGroupNetworkRule -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -NetworkAclsVirtualNetworkRule $virtualNetworkRule1,$virtualNetworkRule2 +``` + +```output +Action State VirtualNetworkResourceId +------ ----- ------------------------ +Allow /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet3 +``` + +This example adds 3 network rules to a volume group, and then remove 2 of the network rules from the volume group by inputting network rule objects. +The command outputs all the network rule objects left in the volume group after the removal. + +### Example 2: Remove network rules by network rule resource Ids +```powershell +$virtualNetworkRule1 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1" -Action Allow +$virtualNetworkRule2 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2" -Action Allow +$virtualNetworkRule3 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet3" -Action Allow +$virtualNetworkRuleResourceId1 = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1" +$virtualNetworkRuleResourceId2 = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2" +# Update the volume group to contain the network rules +$volGroup = Update-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -Name myvolumegroup -NetworkAclsVirtualNetworkRule $virtualNetworkRule1,$virtualNetworkRule2,$virtualNetworkRule3 + +# Remove some of the network rules from the volume group +Remove-AzElasticSanVolumeGroupNetworkRule -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -NetworkAclsVirtualNetworkResourceId $virtualNetworkRuleResourceId1,$virtualNetworkRuleResourceId2 +``` + +```output +Action State VirtualNetworkResourceId +------ ----- ------------------------ +Allow /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet3 +``` + +This example adds 3 network rules to a volume group, and then remove 2 of the network rules from the volume group by inputting network rule resource Ids. +The command outputs all the network rule objects left in the volume group after the removal. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkAclsVirtualNetworkResourceId +The list of virtual network rule resource Ids. +To construct, see NOTES section for NETWORKACLSVIRTUALNETWORKRULE properties and create a hash table. + +```yaml +Type: System.String[] +Parameter Sets: NetworkRuleResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkAclsVirtualNetworkRule +The list of virtual network rules. +To construct, see NOTES section for NETWORKACLSVIRTUALNETWORKRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVirtualNetworkRule[] +Parameter Sets: NetworkRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeGroupName +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVirtualNetworkRule[] + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.VirtualNetworkRule[] + +## 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. + + +`NETWORKACLSVIRTUALNETWORKRULE <IVirtualNetworkRule[]>`: The list of virtual network rules. + - `VirtualNetworkResourceId <String>`: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + - `[Action <Action?>]`: The action of virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/Update-AzElasticSan.md b/azps-10.1.0/Az.ElasticSan/Update-AzElasticSan.md new file mode 100644 index 0000000000..7525f2bb6c --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/Update-AzElasticSan.md @@ -0,0 +1,320 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/update-azelasticsan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Update-AzElasticSan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Update-AzElasticSan.md +--- + +# Update-AzElasticSan + +## SYNOPSIS +Update a Elastic San. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzElasticSan -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-BaseSizeTiB <Int64>] [-ExtendedCapacitySizeTiB <Int64>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Update +``` +Update-AzElasticSan -Name <String> -ResourceGroupName <String> -Parameter <IElasticSanUpdate> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzElasticSan -InputObject <IElasticSanIdentity> -Parameter <IElasticSanUpdate> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzElasticSan -InputObject <IElasticSanIdentity> [-BaseSizeTiB <Int64>] + [-ExtendedCapacitySizeTiB <Int64>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a Elastic San. + +## EXAMPLES + +### Example 1: Update an Elastic SAN +```powershell +$elasticSan = Update-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan -BaseSizeTib 64 -ExtendedCapacitySizeTib 128 -Tag @{"tag3" = "value3"} +``` + +```output +AvailabilityZone : +BaseSizeTiB : 64 +ExtendedCapacitySizeTiB : 128 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan +Location : eastus +Name : myelasticsan +ProvisioningState : Succeeded +SkuName : Premium_LRS +SkuTier : +SystemDataCreatedAt : 8/16/2022 4:59:54 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/16/2022 4:59:54 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +TotalIops : 320000 +TotalMBps : 5120 +TotalSizeTiB : 192 +TotalVolumeSizeGiB : 0 +Type : Microsoft.ElasticSan/ElasticSans +VolumeGroupCount : 0 +``` + +This command updates the BaseSizeTib, ExtendedCapacitySizeTib, and Tag properties of an Elastic SAN. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BaseSizeTiB +Base size of the Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedCapacitySizeTiB +Extended size of the Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +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.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: ElasticSanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Response for ElasticSan update request. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IElasticSanUpdate +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Update tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IElasticSanUpdate + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IElasticSan + +## 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 <IElasticSanIdentity>`: Identity Parameter + - `[ElasticSanName <String>]`: The name of the ElasticSan. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VolumeGroupName <String>]`: The name of the VolumeGroup. + - `[VolumeName <String>]`: The name of the Volume. + +`PARAMETER <IElasticSanUpdate>`: Response for ElasticSan update request. + - `[BaseSizeTiB <Int64?>]`: Base size of the Elastic San appliance in TiB. + - `[ExtendedCapacitySizeTiB <Int64?>]`: Extended size of the Elastic San appliance in TiB. + - `[Tag <IElasticSanUpdateTags>]`: Update tags + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/Update-AzElasticSanVolume.md b/azps-10.1.0/Az.ElasticSan/Update-AzElasticSanVolume.md new file mode 100644 index 0000000000..4ca7b1fcfc --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/Update-AzElasticSanVolume.md @@ -0,0 +1,330 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/update-azelasticsanvolume +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Update-AzElasticSanVolume.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Update-AzElasticSanVolume.md +--- + +# Update-AzElasticSanVolume + +## SYNOPSIS +Update an Volume. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzElasticSanVolume -ElasticSanName <String> -Name <String> -ResourceGroupName <String> + -VolumeGroupName <String> [-SubscriptionId <String>] [-SizeGiB <Int64>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Update +``` +Update-AzElasticSanVolume -ElasticSanName <String> -Name <String> -ResourceGroupName <String> + -VolumeGroupName <String> -Parameter <IVolumeUpdate> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzElasticSanVolume -InputObject <IElasticSanIdentity> -Parameter <IVolumeUpdate> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzElasticSanVolume -InputObject <IElasticSanIdentity> [-SizeGiB <Int64>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update an Volume. + +## EXAMPLES + +### Example 1: Update an Elastic SAN volume +```powershell +$volume = Update-AzElasticSanVolume -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -Name myvolume -Tag @{tag3 = "value3"} -SizeGib 120 +``` + +```output +CreationDataCreateSource : +CreationDataSourceUri : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup/volumes/myvolume +Name : myvolume +SizeGiB : 120 +StorageTargetIqn : iqn.2022-09.net.windows.core.blob.ElasticSan.es-3ibot5m2r3y0:myvolume +StorageTargetPortalHostname : es-3ibot5m2r3y0.z1.blob.storage.azure.net +StorageTargetPortalPort : 3260 +StorageTargetProvisioningState : Succeeded +StorageTargetStatus : Running +SystemDataCreatedAt : 9/19/2022 2:39:28 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/19/2022 2:39:28 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +Type : Microsoft.ElasticSan/ElasticSans +VolumeId : abababab-abab-abab-abab-abababababab +``` + +This command updates the SizeGib and Tag properties of a volume. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Volume. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Response for Volume request. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolumeUpdate +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SizeGiB +Volume size. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeGroupName +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolumeUpdate + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolume + +## 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 <IElasticSanIdentity>`: Identity Parameter + - `[ElasticSanName <String>]`: The name of the ElasticSan. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VolumeGroupName <String>]`: The name of the VolumeGroup. + - `[VolumeName <String>]`: The name of the Volume. + +`PARAMETER <IVolumeUpdate>`: Response for Volume request. + - `[SizeGiB <Int64?>]`: Volume size. + - `[Tag <IVolumeUpdateTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ElasticSan/Update-AzElasticSanVolumeGroup.md b/azps-10.1.0/Az.ElasticSan/Update-AzElasticSanVolumeGroup.md new file mode 100644 index 0000000000..b09e2dea18 --- /dev/null +++ b/azps-10.1.0/Az.ElasticSan/Update-AzElasticSanVolumeGroup.md @@ -0,0 +1,384 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/update-azelasticsanvolumegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Update-AzElasticSanVolumeGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ElasticSan/help/Update-AzElasticSanVolumeGroup.md +--- + +# Update-AzElasticSanVolumeGroup + +## SYNOPSIS +Update an VolumeGroup. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzElasticSanVolumeGroup -ElasticSanName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Encryption <EncryptionType>] + [-NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]>] [-ProtocolType <StorageTargetType>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Update +``` +Update-AzElasticSanVolumeGroup -ElasticSanName <String> -Name <String> -ResourceGroupName <String> + -Parameter <IVolumeGroupUpdate> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzElasticSanVolumeGroup -InputObject <IElasticSanIdentity> -Parameter <IVolumeGroupUpdate> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzElasticSanVolumeGroup -InputObject <IElasticSanIdentity> [-Encryption <EncryptionType>] + [-NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]>] [-ProtocolType <StorageTargetType>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update an VolumeGroup. + +## EXAMPLES + +### Example 1: Update a volume group +```powershell +$virtualNetworkRule1 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1" -Action Allow +$virtualNetworkRule2 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2" -Action Allow + +Update-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -Name myvolumegroup -ProtocolType 'Iscsi' -NetworkAclsVirtualNetworkRule $virtualNetworkRule1,$virtualNetworkRule2 +``` + +```output +Encryption : EncryptionAtRestWithPlatformKey +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup +Name : myvolumegroup +NetworkAclsVirtualNetworkRule : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2} +ProtocolType : iSCSI +ProvisioningState : Succeeded +SystemDataCreatedAt : 9/19/2022 7:05:47 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/19/2022 7:05:47 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +Type : Microsoft.ElasticSan/ElasticSans +``` + +This example updates the protocol type and virtual network rules of a volume gorup + +### Example 2: Update a volume group virtual network rule with JSON input +```powershell +Update-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -Name myvolumegroup -ProtocolType 'Iscsi' -Tag @{tag1="value1";tag2="value2"} ` + -NetworkAclsVirtualNetworkRule ( + @{VirtualNetworkResourceId="/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1"; + Action="Allow"}, + @{VirtualNetworkResourceId="/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2"; + Action="Allow"}) +``` + +```output +Encryption : EncryptionAtRestWithPlatformKey +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup +Name : myvolumegroup +NetworkAclsVirtualNetworkRule : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2} +ProtocolType : iSCSI +ProvisioningState : Succeeded +SystemDataCreatedAt : 9/19/2022 7:05:47 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 9/19/2022 7:05:47 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +Type : Microsoft.ElasticSan/ElasticSans +``` + +This example updates the protocol type, virtual network rules, and tag of a volume group. +It takes in the virtual network rules in JSON format. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Encryption +Type of encryption + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Support.EncryptionType +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +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.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: VolumeGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkAclsVirtualNetworkRule +The list of virtual network rules. +To construct, see NOTES section for NETWORKACLSVIRTUALNETWORKRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVirtualNetworkRule[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Volume Group request. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolumeGroupUpdate +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProtocolType +Type of storage target + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Support.StorageTargetType +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolumeGroupUpdate + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.IVolumeGroup + +## 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 <IElasticSanIdentity>`: Identity Parameter + - `[ElasticSanName <String>]`: The name of the ElasticSan. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VolumeGroupName <String>]`: The name of the VolumeGroup. + - `[VolumeName <String>]`: The name of the Volume. + +`NETWORKACLSVIRTUALNETWORKRULE <IVirtualNetworkRule[]>`: The list of virtual network rules. + - `VirtualNetworkResourceId <String>`: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + - `[Action <Action?>]`: The action of virtual network rule. + +`PARAMETER <IVolumeGroupUpdate>`: Volume Group request. + - `[Encryption <EncryptionType?>]`: Type of encryption + - `[NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]>]`: The list of virtual network rules. + - `VirtualNetworkResourceId <String>`: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + - `[Action <Action?>]`: The action of virtual network rule. + - `[ProtocolType <StorageTargetType?>]`: Type of storage target + - `[Tag <IVolumeGroupUpdateTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.EventGrid/Az.EventGrid.md b/azps-10.1.0/Az.EventGrid/Az.EventGrid.md new file mode 100644 index 0000000000..7b47be637d --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Az.EventGrid.md @@ -0,0 +1,192 @@ +--- +Module Name: Az.EventGrid +Module Guid: 53BF7132-5BB4-46EB-AC05-61A49A6CD5EB +Download Help Link: https://learn.microsoft.com/powershell/module/az.eventgrid +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Az.EventGrid.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Az.EventGrid.md +--- + +# Az.EventGrid Module +## Description +This topic displays help for the Azure Event Grid PowerShell resource manager cmdlets. + +## Az.EventGrid Cmdlets +### [Enable-AzEventGridPartnerTopic](Enable-AzEventGridPartnerTopic.md) +Enables an Event Grid partner topic. + +### [Get-AzEventGridChannel](Get-AzEventGridChannel.md) +Gets the details of an Event Grid channel or gets a list of all Event Grid channels in a given partner namespace. + +### [Get-AzEventGridDomain](Get-AzEventGridDomain.md) +Gets the details of an Event Grid domain, or gets a list of all Event Grid domains in the current Azure subscription. + +### [Get-AzEventGridDomainKey](Get-AzEventGridDomainKey.md) +Gets the shared access keys used to publish events to an Event Grid domain. + +### [Get-AzEventGridDomainTopic](Get-AzEventGridDomainTopic.md) +Gets the details of an Event Grid domain topic, or gets a list of all Event Grid domain topics under specific Event Grid domain in the current Azure subscription. + +### [Get-AzEventGridFullUrlForPartnerTopicEventSubscription](Get-AzEventGridFullUrlForPartnerTopicEventSubscription.md) +Gets the full URL for partner topic event subscription + +### [Get-AzEventGridFullUrlForSystemTopicEventSubscription](Get-AzEventGridFullUrlForSystemTopicEventSubscription.md) +Gets the full URL for system topic event subscription + +### [Get-AzEventGridPartnerConfiguration](Get-AzEventGridPartnerConfiguration.md) +Gets the details of an Event Grid partner configuration, or gets a lost of partner configurations in the current Azure subscription. + +### [Get-AzEventGridPartnerNamespace](Get-AzEventGridPartnerNamespace.md) +Gets the details of an Event Grid partner namespace, or lists partner namespaces at the scope of the current Azure subscription or specified resource group. + +### [Get-AzEventGridPartnerNamespaceKey](Get-AzEventGridPartnerNamespaceKey.md) +Gets the details of an Event Grid partner namespace key. + +### [Get-AzEventGridPartnerRegistration](Get-AzEventGridPartnerRegistration.md) +Gets the details of an Event Grid partner registration, or gets a list of Event Grid partner registrations. + +### [Get-AzEventGridPartnerTopic](Get-AzEventGridPartnerTopic.md) +Gets the details of an Event Grid partner topic, or gets a list of Event Grid partner topics. + +### [Get-AzEventGridPartnerTopicEventSubscription](Get-AzEventGridPartnerTopicEventSubscription.md) +Gets the details of an event subscription, or gets a list of all event subscriptions for a given Azure Event Grid partner topic. + +### [Get-AzEventGridPartnerTopicEventSubscriptionDeliveryAttribute](Get-AzEventGridPartnerTopicEventSubscriptionDeliveryAttribute.md) +Gets the delivery attributes for partner topic event subscription + +### [Get-AzEventGridSubscription](Get-AzEventGridSubscription.md) +Gets the details of an event subscription, or gets a list of all event subscriptions in the current Azure subscription. + +### [Get-AzEventGridSystemTopic](Get-AzEventGridSystemTopic.md) +Gets the details of an Event Grid system topic, or gets a list of all Event Grid system topics in the current Azure subscription. + +### [Get-AzEventGridSystemTopicEventSubscription](Get-AzEventGridSystemTopicEventSubscription.md) +Gets the details of an event subscription, or gets a list of all event subscriptions for a given Azure Eventgrid system topic. + +### [Get-AzEventGridSystemTopicEventSubscriptionDeliveryAttribute](Get-AzEventGridSystemTopicEventSubscriptionDeliveryAttribute.md) +Gets the delivery attributes for system topic event subscription + +### [Get-AzEventGridTopic](Get-AzEventGridTopic.md) +Gets the details of an Event Grid topic, or gets a list of all Event Grid topics in the current Azure subscription. + +### [Get-AzEventGridTopicKey](Get-AzEventGridTopicKey.md) +Gets the shared access keys used to publish events to an Event Grid topic. + +### [Get-AzEventGridTopicType](Get-AzEventGridTopicType.md) +Gets the details about the topic types supported by Azure Event Grid. + +### [Get-AzEventGridVerifiedPartner](Get-AzEventGridVerifiedPartner.md) +Gets the details of a specific Event Grid verified partner or gets the details of all verified partners in the current azure subscription. + +### [Grant-AzEventGridPartnerConfiguration](Grant-AzEventGridPartnerConfiguration.md) +Grants access to a partner for the specified partner configuration. + +### [New-AzEventGridChannel](New-AzEventGridChannel.md) +Creates a new Event Grid channel. + +### [New-AzEventGridDomain](New-AzEventGridDomain.md) +Creates a new Azure Event Grid Domain. + +### [New-AzEventGridDomainKey](New-AzEventGridDomainKey.md) +Regenerates the shared access key for an Azure Event Grid Domain. + +### [New-AzEventGridDomainTopic](New-AzEventGridDomainTopic.md) +Creates a new Azure Event Grid Domain Topic. + +### [New-AzEventGridPartnerConfiguration](New-AzEventGridPartnerConfiguration.md) +Creates a new Event Grid partner configuration. + +### [New-AzEventGridPartnerNamespace](New-AzEventGridPartnerNamespace.md) +Creates a new Event Grid partner namespace. + +### [New-AzEventGridPartnerNamespaceKey](New-AzEventGridPartnerNamespaceKey.md) +Regenerates the shared access key for an Azure Event Grid partner namespace. + +### [New-AzEventGridPartnerRegistration](New-AzEventGridPartnerRegistration.md) +Creates a new Event Grid partner registration. + +### [New-AzEventGridPartnerTopic](New-AzEventGridPartnerTopic.md) +Creates a new Azure Event Grid Partner Topic. + +### [New-AzEventGridPartnerTopicEventSubscription](New-AzEventGridPartnerTopicEventSubscription.md) +Creates a new Azure Event Grid Event Subscription to a Partner topic. + +### [New-AzEventGridSubscription](New-AzEventGridSubscription.md) +Creates a new Azure Event Grid Event Subscription to a topic, Azure resource, Azure subscription or Resource Group. + +### [New-AzEventGridSystemTopic](New-AzEventGridSystemTopic.md) +Creates a new Azure Event Grid System Topic. + +### [New-AzEventGridSystemTopicEventSubscription](New-AzEventGridSystemTopicEventSubscription.md) +Creates a new Azure Event Grid Event Subscription to a System topic. + +### [New-AzEventGridTopic](New-AzEventGridTopic.md) +Creates a new Azure Event Grid Topic. + +### [New-AzEventGridTopicKey](New-AzEventGridTopicKey.md) +Regenerates the shared access key for an Azure Event Grid Topic. + +### [Remove-AzEventGridChannel](Remove-AzEventGridChannel.md) +Removes an Azure Event Grid Channel. + +### [Remove-AzEventGridDomain](Remove-AzEventGridDomain.md) +Removes an Azure Event Grid Domain. + +### [Remove-AzEventGridDomainTopic](Remove-AzEventGridDomainTopic.md) +Removes an Azure Event Grid Domain Topic. + +### [Remove-AzEventGridPartnerConfiguration](Remove-AzEventGridPartnerConfiguration.md) +Removes an Azure Event Grid Partner Configuration. + +### [Remove-AzEventGridPartnerNamespace](Remove-AzEventGridPartnerNamespace.md) +Removes an Azure Event Grid Partner Namespace. + +### [Remove-AzEventGridPartnerRegistration](Remove-AzEventGridPartnerRegistration.md) +Removes an Azure Event Grid Partner Registration. + +### [Remove-AzEventGridPartnerTopic](Remove-AzEventGridPartnerTopic.md) +Removes an Azure Event Grid Partner Topic. + +### [Remove-AzEventGridPartnerTopicEventSubscription](Remove-AzEventGridPartnerTopicEventSubscription.md) +Removes an Azure Event Grid partner topic event subscription. + +### [Remove-AzEventGridSubscription](Remove-AzEventGridSubscription.md) +Removes an Azure Event Grid event subscription. + +### [Remove-AzEventGridSystemTopic](Remove-AzEventGridSystemTopic.md) +Removes an Azure Event Grid System Topic. + +### [Remove-AzEventGridSystemTopicEventSubscription](Remove-AzEventGridSystemTopicEventSubscription.md) +Removes an Azure Event Grid system topic event subscription. + +### [Remove-AzEventGridTopic](Remove-AzEventGridTopic.md) +Removes an Azure Event Grid Topic. + +### [Revoke-AzEventGridPartnerConfiguration](Revoke-AzEventGridPartnerConfiguration.md) +Revokes access to a partner in a partner configuration. + +### [Set-AzEventGridTopic](Set-AzEventGridTopic.md) +Sets the properties of an Event Grid topic. + +### [Update-AzEventGridChannel](Update-AzEventGridChannel.md) +Updates the properties of an Event Grid channel. + +### [Update-AzEventGridPartnerConfiguration](Update-AzEventGridPartnerConfiguration.md) +Updates the details of an Event Grid partner configuration. + +### [Update-AzEventGridPartnerTopic](Update-AzEventGridPartnerTopic.md) +Updates the properties of an Event Grid partner topic. + +### [Update-AzEventGridPartnerTopicEventSubscription](Update-AzEventGridPartnerTopicEventSubscription.md) +Update the properties of an Event Grid System partner event subscription. + +### [Update-AzEventGridSubscription](Update-AzEventGridSubscription.md) +Update the properties of an Event Grid event subscription. + +### [Update-AzEventGridSystemTopic](Update-AzEventGridSystemTopic.md) +Updates the properties of an Event Grid System topic. + +### [Update-AzEventGridSystemTopicEventSubscription](Update-AzEventGridSystemTopicEventSubscription.md) +Update the properties of an Event Grid System topic event subscription. + diff --git a/azps-10.1.0/Az.EventGrid/Enable-AzEventGridPartnerTopic.md b/azps-10.1.0/Az.EventGrid/Enable-AzEventGridPartnerTopic.md new file mode 100644 index 0000000000..dd3573859e --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Enable-AzEventGridPartnerTopic.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/enable-azeventgridpartnertopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Enable-AzEventGridPartnerTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Enable-AzEventGridPartnerTopic.md +--- + +# Enable-AzEventGridPartnerTopic + +## SYNOPSIS +Enables an Event Grid partner topic. + +## SYNTAX + +### PartnerTopicNameParameterSet (Default) +``` +Enable-AzEventGridPartnerTopic [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PartnerTopicInputObjectParameterSet +``` +Enable-AzEventGridPartnerTopic [-InputObject] <PSPartnerTopic> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Enable-AzEventGridPartnerTopic cmdlets enables a specific Event Grid partner topic. + +## EXAMPLES + +### Example 1 +Enables the Event Grid partner topic \`PartnerTopic1\` in resource group \`MyResourceGroupName\`. + +```powershell +Enable-AzEventGridPartnerTopic -ResourceGroup MyResourceGroupName -Name PartnerTopic1 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PartnerTopic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSPartnerTopic +Parameter Sets: PartnerTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Event Grid partner topic name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: PartnerTopicName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerTopic + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerTopic + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridChannel.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridChannel.md new file mode 100644 index 0000000000..c63cb30b19 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridChannel.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridchannel +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridChannel.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridChannel.md +--- + +# Get-AzEventGridChannel + +## SYNOPSIS +Gets the details of an Event Grid channel or gets a list of all Event Grid channels in a given partner namespace. + +## SYNTAX + +### ChannelListByPartnerNamespaceParameterSet (Default) +``` +Get-AzEventGridChannel -ResourceGroupName <String> -PartnerNamespaceName <String> [-ODataQuery <String>] + [-Top <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ChannelNameParameterSet +``` +Get-AzEventGridChannel -ResourceGroupName <String> -PartnerNamespaceName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NextLinkParameterSet +``` +Get-AzEventGridChannel -NextLink <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzEventGridChannel cmdlet gets either the detauls of a specified Event Grid channel, or a list of all Event Grid channels in the specified Event Grid partner namespace. +If the channel name is provided, the details of a single Event Grid channel is returned. +If the channel name is not provided, a list of domains is returned. The number of elements returned in this list is controlled by the Top parameter. If the Top value is not specified or $null, the list will contain all the domains items returned at once. Otherwise, Top will indicate the maximum number of elements to be returned in the list. +If more channels are still available, the value in NextLink should be used in the next call to get the next page of channels. +Finally, ODataQuery parameter is used to perform filtering for the search results. The filtering query follows OData syntax using the Name property only. The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridChannel -ResourceGroup MyResourceGroupName -PartnerNamespaceName PartnerNamespace1 -Name Channel1 +``` + +Gets the details of Event Grid channel \`Channel1\` in partner namespace \`PartnerNameSpace1\` in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +Get-AzEventGridChannel -ResourceGroup MyResourceGroupName -PartnerNamespaceName PartnerNameSpace1 +``` + +Lists the details of Event Grid channels in partner namespace \`PartnerNameSpace1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Event Grid channel. + +```yaml +Type: System.String +Parameter Sets: ChannelNameParameterSet +Aliases: ChannelName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextLink +The link for the next page of resources to be obtained. +This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried. + +```yaml +Type: System.String +Parameter Sets: NextLinkParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +The OData query used for filtering the list results. +Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.String +Parameter Sets: ChannelListByPartnerNamespaceParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerNamespaceName +Event Grid partner namespace name. + +```yaml +Type: System.String +Parameter Sets: ChannelListByPartnerNamespaceParameterSet, ChannelNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ChannelListByPartnerNamespaceParameterSet, ChannelNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +The maximum number of resources to be obtained. +Valid value is between 1 and 100. +If top value is specified and more results are still available, the result will contain a link to the next page to be queried in NextLink. +If the Top value is not specified, the full list of resources will be returned at once. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ChannelListByPartnerNamespaceParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSChannelListInstance + +### Microsoft.Azure.Commands.EventGrid.Models.PSChannel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridDomain.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridDomain.md new file mode 100644 index 0000000000..31b731e127 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridDomain.md @@ -0,0 +1,355 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgriddomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridDomain.md +--- + +# Get-AzEventGridDomain + +## SYNOPSIS +Gets the details of an Event Grid domain, or gets a list of all Event Grid domains in the current Azure subscription. + +## SYNTAX + +### ResourceGroupNameParameterSet (Default) +``` +Get-AzEventGridDomain [[-ResourceGroupName] <String>] [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DomainNameParameterSet +``` +Get-AzEventGridDomain [-ResourceGroupName] <String> [-Name] <String> [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +Get-AzEventGridDomain [-ResourceId] <String> [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NextLinkParameterSet +``` +Get-AzEventGridDomain [-NextLink <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzEventGridDomain cmdlet gets either the details of a specified Event Grid domain, or a list of all Event Grid domains in the current Azure subscription. +If the domain name is provided, the details of a single Event Grid domain is returned. +If the domain name is not provided, a list of domains is returned. The number of elements returned in this list is controlled by the Top parameter. If the Top value is not specified or $null, the list will contain all the domains items returned at once. Otherwise, Top will indicate the maximum number of elements to be returned in the list. +If more domains are still available, the value in NextLink should be used in the next call to get the next page of domains. +Finally, ODataQuery parameter is used to perform filtering for the search results. The filtering query follows OData syntax using the Name property only. The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +## EXAMPLES + +### Example 1 + +Gets the details of Event Grid domain \`Domain1\` in resource group \`MyResourceGroupName\`. + +```powershell +Get-AzEventGridDomain -ResourceGroup MyResourceGroupName -Name Domain1 +``` + +```output +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +Id : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname/providers/Microsoft.EventGrid/domains/domain1 +Type : Microsoft.EventGrid/domains +Location : westus2 +Endpoint : https://domain1.westus2-1.eventgrid.azure.net/api/events +ProvisioningState : Succeeded +Tags : {[Tag1, Value1], [Tag2, Value2]} +``` + +### Example 2 + +Gets the details of Event Grid domain \`Domain1\` in resource group \`MyResourceGroupName\` using ResourceId option. + +```powershell +Get-AzEventGridDomain -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1" +``` + +```output +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +Id : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname/providers/Microsoft.EventGrid/domains/domain1 +Type : Microsoft.EventGrid/domains +Location : westus2 +Endpoint : https://domain1.westus2-1.eventgrid.azure.net/api/events +ProvisioningState : Succeeded +Tags : {[Tag1, Value1], [Tag2, Value2]} +``` + +### Example 3 + +List all the Event Grid domains in resource group \`MyResourceGroupName\` without pagination (all domains are returned in one shot) + +```powershell +$result=Get-AzEventGridDomain -ResourceGroup MyResourceGroupName +Write-Output $result.PsDomainsList +``` + +```output +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +Id : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname/providers/Microsoft.EventGrid/domains/domain1 +Type : Microsoft.EventGrid/domains +Location : westus2 +Endpoint : https://domain1.westus2-1.eventgrid.azure.net/api/events +ProvisioningState : Succeeded +Tags : {[Tag1, Value1], [Tag2, Value2]} + +ResourceGroupName : MyResourceGroupName +DomainName : Domain2 +Id : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname/providers/Microsoft.EventGrid/domains/domain2 +Type : Microsoft.EventGrid/domains +Location : westus2 +Endpoint : https://domain2.westus2-1.eventgrid.azure.net/api/events +ProvisioningState : Succeeded +Tags : + +ResourceGroupName : MyResourceGroupName +DomainName : Domain3 +Id : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname/providers/Microsoft.EventGrid/domains/domain3 +Type : Microsoft.EventGrid/domains +Location : westus2 +Endpoint : https://domain3.westus2-1.eventgrid.azure.net/api/events +ProvisioningState : Succeeded +Tags : {[Tag3, Value3], [Tag4, Value4]} + +ResourceGroupName : MyResourceGroupName +DomainName : Domain4 +Id : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname/providers/Microsoft.EventGrid/domains/domain4 +Type : Microsoft.EventGrid/domains +Location : westus2 +Endpoint : https://domain4.westus2-1.eventgrid.azure.net/api/events +ProvisioningState : Succeeded +Tags : +``` + +### Example 4 + +List the Event Grid domains (if any) in resource group \`MyResourceGroupName\` that satisfies the $odataFilter query 10 domains at a time. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of domains, user is expected to re-call Get-AzEventGridDomain and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +```powershell +$total = 0 +$odataFilter = "Name ne 'ABCD'" +$result = Get-AzEventGridDomain -ResourceGroup MyResourceGroupName -Top 10 -ODataQuery $odataFilter +$total += $result.Count +while ($null -ne $result.NextLink) + { + $result = Get-AzEventGridDomain -NextLink $result.NextLink + $total += $result.Count + } + +Write-Output "Total number of domains is $Total" +``` + +### Example 5 + +List all the Event Grid domains in Azure Subscription without pagination (all domains are returned in one shot) + +```powershell +$result=Get-AzEventGridDomain +Write-Output $result.PsDomainsList +``` + +```output +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +Id : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname1/providers/Microsoft.EventGrid/domains/domain1 +Type : Microsoft.EventGrid/domains +Location : westus2 +Endpoint : https://domain1.westus2-1.eventgrid.azure.net/api/events +ProvisioningState : Succeeded +Tags : {[Tag1, Value1], [Tag2, Value2]} + +ResourceGroupName : MyResourceGroupName +DomainName : Domain2 +Id : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname1/providers/Microsoft.EventGrid/domains/domain2 +Type : Microsoft.EventGrid/domains +Location : westus2 +Endpoint : https://domain2.westus2-1.eventgrid.azure.net/api/events +ProvisioningState : Succeeded +Tags : + +ResourceGroupName : MyResourceGroupName +DomainName : Domain3 +Id : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname2/providers/Microsoft.EventGrid/domains/domain3 +Type : Microsoft.EventGrid/domains +Location : westus2 +Endpoint : https://domain3.westus2-1.eventgrid.azure.net/api/events +ProvisioningState : Succeeded +Tags : {[Tag3, Value3], [Tag4, Value4]} + +ResourceGroupName : MyResourceGroupName +DomainName : Domain4 +Id : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname3/providers/Microsoft.EventGrid/domains/domain4 +Type : Microsoft.EventGrid/domains +Location : westus2 +Endpoint : https://domain4.westus2-1.eventgrid.azure.net/api/events +ProvisioningState : Succeeded +Tags : +``` + +### Example 6 + +List the Event Grid domains (if any) in Azure Subscription that satisfies the $odataFilter query 20 domains at a time. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of domains, user is expected to re-call Get-AzEventGridDomain and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +```powershell +$total = 0 +$odataFilter = "Contains(Name, 'ABCD')" +$result = Get-AzEventGridDomain -Top 20 -ODataQuery $odataFilter +$total += $result.Count +while ($null -ne $result.NextLink) + { + $result = Get-AzEventGridDomain -NextLink $result.NextLink + $total += $result.Count + } +Write-Output "Total number of domains is $Total" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +EventGrid domain name. + +```yaml +Type: System.String +Parameter Sets: DomainNameParameterSet +Aliases: DomainName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextLink +The link for the next page of resources to be obtained. +This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried. + +```yaml +Type: System.String +Parameter Sets: NextLinkParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +The OData query used for filtering the list results. +Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, DomainNameParameterSet, ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: ResourceGroup + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: DomainNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Identifier representing the Event Grid Domain. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +The maximum number of resources to be obtained. +Valid value is between 1 and 100. +If top value is specified and more results are still available, the result will contain a link to the next page to be queried in NextLink. +If the Top value is not specified, the full list of resources will be returned at once. + +```yaml +Type: System.Int32 +Parameter Sets: ResourceGroupNameParameterSet, DomainNameParameterSet, ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomain + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomainListInstance + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridDomainKey.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridDomainKey.md new file mode 100644 index 0000000000..51e79d3ceb --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridDomainKey.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgriddomainkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridDomainKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridDomainKey.md +--- + +# Get-AzEventGridDomainKey + +## SYNOPSIS +Gets the shared access keys used to publish events to an Event Grid domain. + +## SYNTAX + +### DomainNameParameterSet (Default) +``` +Get-AzEventGridDomainKey [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DomainInputObjectParameterSet +``` +Get-AzEventGridDomainKey [-DomainObject] <PSDomain> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +Get-AzEventGridDomainKey [-DomainResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the shared access keys used to publish events to an Event Grid domain. + +## EXAMPLES + +### Example 1 + +Gets the shared access keys of Event Grid domain \`Domain1\` in resource group \`MyResourceGroupName\`. + +```powershell +Get-AzEventGridDomainKey -ResourceGroup MyResourceGroupName -Name Domain1 +``` + +```output +Key1 Key2 +---- ---- +<Key1 value> <Key 2 value> +``` + +### Example 2 + +Gets the shared access keys of Event Grid domain \`Domain1\` in resource group \`MyResourceGroupName\`. + +```powershell +Get-AzEventGridDomain -ResourceGroup MyResourceGroupName -Name Domain1 | Get-AzEventGridDomainKey +``` + +```output +Key1 Key2 +---- ---- +<Key1 value> <Key 2 value> +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainObject +EventGrid Domain object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSDomain +Parameter Sets: DomainInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DomainResourceId +Resource Identifier representing the Event Grid Domain. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +EventGrid domain name. + +```yaml +Type: System.String +Parameter Sets: DomainNameParameterSet +Aliases: DomainName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DomainNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomain + +## OUTPUTS + +### Microsoft.Azure.Management.EventGrid.Models.DomainSharedAccessKeys + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridDomainTopic.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridDomainTopic.md new file mode 100644 index 0000000000..ae8f80b060 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridDomainTopic.md @@ -0,0 +1,302 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgriddomaintopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridDomainTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridDomainTopic.md +--- + +# Get-AzEventGridDomainTopic + +## SYNOPSIS +Gets the details of an Event Grid domain topic, or gets a list of all Event Grid domain topics under specific Event Grid domain in the current Azure subscription. + +## SYNTAX + +### DomainTopicNameParameterSet (Default) +``` +Get-AzEventGridDomainTopic [-ResourceGroupName] <String> [-DomainName] <String> [-Name <String>] + [-ODataQuery <String>] [-Top <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdDomainTopicParameterSet +``` +Get-AzEventGridDomainTopic [-ResourceId] <String> [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NextLinkParameterSet +``` +Get-AzEventGridDomainTopic [-NextLink <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzEventGridDomainTopic cmdlet gets either the details of a specified Event Grid domain topic, or a list of all Event Grid domain topics under a specific domain in the current Azure subscription. +If the domain topic name is provided, the details of a single Event Grid domain topic is returned. +If the domain topic name is not provided, a list of domain topics under the specified domain name is returned. The number of elements returned in this list is controlled by the Top parameter. If the Top value is not specified or $null, the list will contain all the domain topics items. Otherwise, Top will indicate the maximum number of elements to be returned in the list. +If more domain topics are still available, the value in NextLink should be used in the next call to get the next page of domain topics. +Finally, ODataQuery parameter is used to perform filtering for the search results. The filtering query follows OData syntax using the Name property only. The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +## EXAMPLES + +### Example 1 + +Gets the details of Event Grid domain topic \`DomainTopic1\` under Event Grid domain \`Domain1\` in resource group \`MyResourceGroupName\`. + +```powershell +Get-AzEventGridDomainTopic -ResourceGroup MyResourceGroupName -DomainName Domain1 -DomainTopicName DomainTopic1 +``` + +```output +ResourceGroupName : MyResourceGroupName +DomainName : DomainTopic1 +DomainTopicName : Topic1 +Id : /subscriptions/20902276-e53b-4421-8565-f57bcad74f6e/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1/topics/DomainTopic1 +Type : Microsoft.EventGrid/domains/topics +ProvisioningState : Succeeded +``` + +### Example 2 + +Gets the details of Event Grid domain topic \`DomainTopic1\` under Event Grid domain \`Domain1\` in resource group \`MyResourceGroupName\` using the ResourceId option. + +```powershell +Get-AzEventGridDomainTopic -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1/topics/DomainTopic1" +``` + +```output +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +DomainTopicName : DomainTopic1 +Id : /subscriptions/20902276-e53b-4421-8565-f57bcad74f6e/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1/topics/DomainTopic1 +Type : Microsoft.EventGrid/domains/topics +ProvisioningState : Succeeded +``` + +### Example 3 + +List all the Event Grid domain topics under Event Grid domain \`Domain1\` in resource group \`MyResourceGroupName\` without pagination (all results are returned in one shot). + +```powershell +$result=Get-AzEventGridDomainTopic -ResourceGroup MyResourceGroupName -DomainName Domain1 +Write-Output $result.PsDomainTopicsList +``` + +```output +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +DomainTopicName : DomainTopic1 +Id : /subscriptions/20902276-e53b-4421-8565-f57bcad74f6e/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1/topics/DomainTopic1 +Type : Microsoft.EventGrid/domains/topics +ProvisioningState : Succeeded + + +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +DomainTopicName : DomainTopic2 +Id : /subscriptions/20902276-e53b-4421-8565-f57bcad74f6e/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1/topics/DomainTopic2 +Type : Microsoft.EventGrid/domains/topics +ProvisioningState : Succeeded + + +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +DomainTopicName : DomainTopic3 +Id : /subscriptions/20902276-e53b-4421-8565-f57bcad74f6e/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1/topics/DomainTopic3 +Type : Microsoft.EventGrid/domains/topics +ProvisioningState : Succeeded +``` + +### Example 4 + +List all the Event Grid domain topics under Event Grid domain \`Domain1\` in resource group \`MyResourceGroupName\` without pagination (all results are returned in one shot) using ResourceId option + +```powershell +$result=Get-AzEventGridDomainTopic -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1" +Write-Output $result.PsDomainTopicsList +``` + +```output +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +DomainTopicName : DomainTopic1 +Id : /subscriptions/20902276-e53b-4421-8565-f57bcad74f6e/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1/topics/DomainTopic1 +Type : Microsoft.EventGrid/domains/topics +ProvisioningState : Succeeded + + +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +DomainTopicName : DomainTopic2 +Id : /subscriptions/20902276-e53b-4421-8565-f57bcad74f6e/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1/topics/DomainTopic2 +Type : Microsoft.EventGrid/domains/topics +ProvisioningState : Succeeded + + +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +DomainTopicName : DomainTopic3 +Id : /subscriptions/20902276-e53b-4421-8565-f57bcad74f6e/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1/topics/DomainTopic3 +Type : Microsoft.EventGrid/domains/topics +ProvisioningState : Succeeded +``` + +### Example 5 + +List the Event Grid domain topics (if any) under domain \`Domain1\` in resource group \`MyResourceGroupName\` that satisfies the $odataFilter query 10 domain topics at a time. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of domain topics, user is expected to re-call Get-AzEventGridDomainTopic and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +```powershell +$total = 0 +$odataFilter = "Name ne 'ABCD'" +$result = Get-AzEventGridDomainTopic -ResourceGroup MyResourceGroupName -DomainName Domain1 -Top 10 -ODataQuery $odataFilter +$total += $result.Count +while ($result.NextLink -ne $Null) + { + $result = Get-AzEventGridDomainTopic -NextLink $result.NextLink + $total += $result.Count + } + +Write-Output "Total number of domain topics is $Total" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +EventGrid domain name. + +```yaml +Type: System.String +Parameter Sets: DomainTopicNameParameterSet +Aliases: Domain + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +EventGrid domain topic name. + +```yaml +Type: System.String +Parameter Sets: DomainTopicNameParameterSet +Aliases: DomainTopicName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextLink +The link for the next page of resources to be obtained. This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried. + +```yaml +Type: System.String +Parameter Sets: NextLinkParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +The OData query used for filtering the list results. Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.String +Parameter Sets: DomainTopicNameParameterSet, ResourceIdDomainTopicParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DomainTopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Identifier representing the Event Grid Domain or Grid Domain Topic. + +```yaml +Type: System.String +Parameter Sets: ResourceIdDomainTopicParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +The OData query used for filtering the list results. Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.Int32 +Parameter Sets: DomainTopicNameParameterSet, ResourceIdDomainTopicParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomainTopic + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomainTopicListInstance + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridFullUrlForPartnerTopicEventSubscription.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridFullUrlForPartnerTopicEventSubscription.md new file mode 100644 index 0000000000..f50bfb8ea3 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridFullUrlForPartnerTopicEventSubscription.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridfullurlforpartnertopiceventsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridFullUrlForPartnerTopicEventSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridFullUrlForPartnerTopicEventSubscription.md +--- + +# Get-AzEventGridFullUrlForPartnerTopicEventSubscription + +## SYNOPSIS +Gets the full URL for partner topic event subscription + +## SYNTAX + +### PartnerTopicEventSubscriptionParameterSet (Default) +``` +Get-AzEventGridFullUrlForPartnerTopicEventSubscription -Name <String> -ResourceGroupName <String> + -PartnerTopicName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdPartnerTopicEventSubscriptionParameterSet +``` +Get-AzEventGridFullUrlForPartnerTopicEventSubscription [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the full endpoint URL if it is a webhook based event subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridFullUrlForPartnerTopicEventSubscription -ResourceGroupName MyResourceGroupName -PartnerTopicName Topic1 -EventSubscriptionName EventSubscription1 +``` + +Gets the full endpoint URL for event subscription \`EventSubscription1\` created for partner topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +EventGrid event subscription name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet +Aliases: EventSubscriptionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerTopicName +Event Grid partner topic name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Identifier representing the Event Grid Event Subscription. + +```yaml +Type: System.String +Parameter Sets: ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridFullUrlForSystemTopicEventSubscription.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridFullUrlForSystemTopicEventSubscription.md new file mode 100644 index 0000000000..06ac7f9ad0 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridFullUrlForSystemTopicEventSubscription.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridfullurlforsystemtopiceventsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridFullUrlForSystemTopicEventSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridFullUrlForSystemTopicEventSubscription.md +--- + +# Get-AzEventGridFullUrlForSystemTopicEventSubscription + +## SYNOPSIS +Gets the full URL for system topic event subscription + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +Get-AzEventGridFullUrlForSystemTopicEventSubscription [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SystemTopicEventSuscriptionParameterSet +``` +Get-AzEventGridFullUrlForSystemTopicEventSubscription -EventSubscriptionName <String> + -ResourceGroupName <String> -SystemTopicName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the full endpoint URL if it is a webhook based event subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridFullUrlForSystemTopicEventSubscription -ResourceGroupName MyResourceGroupName -SystemTopicName Topic1 -EventSubscriptionName EventSubscription1 +``` + +Gets the full endpoint URL for event subscription \`EventSubscription1\` created for system topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSubscriptionName +EventGrid event subscription name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SystemTopicName +EventGrid topic name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerConfiguration.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerConfiguration.md new file mode 100644 index 0000000000..800926e865 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerConfiguration.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridpartnerconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerConfiguration.md +--- + +# Get-AzEventGridPartnerConfiguration + +## SYNOPSIS +Gets the details of an Event Grid partner configuration, or gets a lost of partner configurations in the current Azure subscription. + +## SYNTAX + +### ResourceGroupNameParameterSet (Default) +``` +Get-AzEventGridPartnerConfiguration [-ResourceGroupName <String>] [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NextLinkParameterSet +``` +Get-AzEventGridPartnerConfiguration -NextLink <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION + The Get-AzEventGridPartnerConfiguration cmdlet gets the details of a partner configuration under a specified resource group, or a list of partner configurations in the current Azure subscriptions. + If the resource group name is provided, the details of a single Event Grid partner configuration is returned. + If the resource group name is not provided, a list of partner configurations is returned. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridPartnerConfiguration -ResourceGroupName ResourceGroup1 +``` + +Gets the details of the partner configuration in resource group \`ResourceGroup1\`. + +### Example 2 +```powershell +Get-AzEventGridPartnerConfiguration -Top 5 +``` + +Lists the details of the first five partner configurations in the current Azure subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextLink +The link for the next page of resources to be obtained. +This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried. + +```yaml +Type: System.String +Parameter Sets: NextLinkParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +The OData query used for filtering the list results. +Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +The maximum number of resources to be obtained. +Valid value is between 1 and 100. +If top value is specified and more results are still available, the result will contain a link to the next page to be queried in NextLink. +If the Top value is not specified, the full list of resources will be returned at once. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ResourceGroupNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfigurationListInstance + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerNamespace.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerNamespace.md new file mode 100644 index 0000000000..bd913a16cf --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerNamespace.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridpartnernamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerNamespace.md +--- + +# Get-AzEventGridPartnerNamespace + +## SYNOPSIS +Gets the details of an Event Grid partner namespace, or lists partner namespaces at the scope of the current Azure subscription or specified resource group. + +## SYNTAX + +### PartnerNamespaceListBySubscriptionParameterSet (Default) +``` +Get-AzEventGridPartnerNamespace [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupNameParameterSet +``` +Get-AzEventGridPartnerNamespace -ResourceGroupName <String> [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PartnerNamespaceNameParameterSet +``` +Get-AzEventGridPartnerNamespace -ResourceGroupName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NextLinkParameterSet +``` +Get-AzEventGridPartnerNamespace -NextLink <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzEventGridPartnerNamespace cmdlet gets either the details of a specified Event Grid partner namespace, or lists partner namespaces. +If the partner namespace name is provided, the details of a single Event Grid partner namespace is returned. +If the partner namespace name is not provided but the resource group name is provided, a list of partner namespaces at the resource group scope is returned. +If neither the partner namespace name or the resource group name are provided, a list of partner namespaces at the current Azure subscription scope is returned. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridPartnerNamespace -ResourceGroup MyResourceGroupName -Name PartnerNamespace1 +``` + +Gets the details of Event Grid partner namespace \`PartnerNamespace1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Event Grid partner namespace name. + +```yaml +Type: System.String +Parameter Sets: PartnerNamespaceNameParameterSet +Aliases: PartnerNamespaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextLink +The link for the next page of resources to be obtained. +This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried. + +```yaml +Type: System.String +Parameter Sets: NextLinkParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +The OData query used for filtering the list results. +Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.String +Parameter Sets: PartnerNamespaceListBySubscriptionParameterSet, ResourceGroupNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, PartnerNamespaceNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +The maximum number of resources to be obtained. +Valid value is between 1 and 100. +If top value is specified and more results are still available, the result will contain a link to the next page to be queried in NextLink. +If the Top value is not specified, the full list of resources will be returned at once. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: PartnerNamespaceListBySubscriptionParameterSet, ResourceGroupNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerNamespaceListInstance + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerNamespace + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerNamespaceKey.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerNamespaceKey.md new file mode 100644 index 0000000000..c861847685 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerNamespaceKey.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridpartnernamespacekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerNamespaceKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerNamespaceKey.md +--- + +# Get-AzEventGridPartnerNamespaceKey + +## SYNOPSIS +Gets the details of an Event Grid partner namespace key. + +## SYNTAX + +### PartnerNamespaceNameParameterSet (Default) +``` +Get-AzEventGridPartnerNamespaceKey -ResourceGroupName <String> -PartnerNamespaceName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PartnerNamespaceInputObjectParameterSet +``` +Get-AzEventGridPartnerNamespaceKey -InputObject <PSPartnerNamespace> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzEventGridPartnerNamespaceKey cmdlet gets the details of an Event Grid partner namespace key. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridPartnerNamespaceKey -ResourceGroupName MyResourceGroupName -PartnerNamespaceName PartnerNamespace1 +``` + +Gets the details of the keys for Event Grid partner namespace \`PartnerNamespace1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PartnerNamespace object + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSPartnerNamespace +Parameter Sets: PartnerNamespaceInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerNamespaceName +Event Grid partner namespace name. + +```yaml +Type: System.String +Parameter Sets: PartnerNamespaceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PartnerNamespaceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerNamespace + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerNamespaceListInstance + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerNamespace + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerRegistration.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerRegistration.md new file mode 100644 index 0000000000..6f8a4bbfa5 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerRegistration.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridpartnerregistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerRegistration.md +--- + +# Get-AzEventGridPartnerRegistration + +## SYNOPSIS +Gets the details of an Event Grid partner registration, or gets a list of Event Grid partner registrations. + +## SYNTAX + +### ResourceGroupNameParameterSet (Default) +``` +Get-AzEventGridPartnerRegistration [-ResourceGroupName <String>] [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PartnerRegistrationNameParameterSet +``` +Get-AzEventGridPartnerRegistration -ResourceGroupName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NextLinkParameterSet +``` +Get-AzEventGridPartnerRegistration [-NextLink <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzEventGridPartnerRegistration cmdlet either gets the details of a specified Event Grid partner registration, or a list of all partner registrations at either the specified resource group or current Azure subscription scope. +If the partner registration name is provided, the details of a single partner registration is returned. +If the partner registration name is not provided but the resource group name is provided, a list of partner registrations is returned. +If neither the partner registration name or the resource group name is provided, a list of partner registrations in the current Azure subscription is returned. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridPartnerRegistration -ResourceGroupName MyResourceGroupName -Name PartnerRegistration1 +``` + +Gets the details of Event Grid partner registration \`PartnerRegistration1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Event Grid partner registration name. + +```yaml +Type: System.String +Parameter Sets: PartnerRegistrationNameParameterSet +Aliases: PartnerRegistrationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextLink +The link for the next page of resources to be obtained. +This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried. + +```yaml +Type: System.String +Parameter Sets: NextLinkParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +The OData query used for filtering the list results. +Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: ResourceGroup + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: PartnerRegistrationNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +The maximum number of resources to be obtained. +Valid value is between 1 and 100. +If top value is specified and more results are still available, the result will contain a link to the next page to be queried in NextLink. +If the Top value is not specified, the full list of resources will be returned at once. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ResourceGroupNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerRegistrationListInstance + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerRegistration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerTopic.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerTopic.md new file mode 100644 index 0000000000..2b1b538288 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerTopic.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridpartnertopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerTopic.md +--- + +# Get-AzEventGridPartnerTopic + +## SYNOPSIS +Gets the details of an Event Grid partner topic, or gets a list of Event Grid partner topics. + +## SYNTAX + +### ResourceGroupNameParameterSet (Default) +``` +Get-AzEventGridPartnerTopic [-ResourceGroupName <String>] [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PartnerTopicNameParameterSet +``` +Get-AzEventGridPartnerTopic -ResourceGroupName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NextLinkParameterSet +``` +Get-AzEventGridPartnerTopic -NextLink <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzEventGridPartnerTopic cmdlet either gets the details of a specified Event Grid partner topic, or a list of Event Grid partner topics. +If the partner topic name is provided, the details of a single partner topic is returned. +If the partner topic name is not provided but the resource group name is provided, a list of partner topics a the resource group scope is returned. +If neither the partner topic name or the resource group name is provided, a list of partner topics in the current Azure subscription is returned. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridPartnerTopic -ResourceGroupName MyResourceGroupName -Name PartnerTopic1 +``` + +Gets the details of Event Grid partner topic \`PartnerTopic1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Event Grid partner topic name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: PartnerTopicName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextLink +The link for the next page of resources to be obtained. +This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried. + +```yaml +Type: System.String +Parameter Sets: NextLinkParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +The OData query used for filtering the list results. +Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: ResourceGroup + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +The maximum number of resources to be obtained. +Valid value is between 1 and 100. +If top value is specified and more results are still available, the result will contain a link to the next page to be queried in NextLink. +If the Top value is not specified, the full list of resources will be returned at once. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ResourceGroupNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerTopic + +### Microsoft.Azure.Commands.EventGrid.Models.PSSytemTopicListInstance + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerTopicEventSubscription.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerTopicEventSubscription.md new file mode 100644 index 0000000000..d10137af1f --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerTopicEventSubscription.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridpartnertopiceventsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerTopicEventSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerTopicEventSubscription.md +--- + +# Get-AzEventGridPartnerTopicEventSubscription + +## SYNOPSIS +Gets the details of an event subscription, or gets a list of all event subscriptions for a given Azure Event Grid partner topic. + +## SYNTAX + +### PartnerTopicNameParameterSet (Default) +``` +Get-AzEventGridPartnerTopicEventSubscription -ResourceGroupName <String> -PartnerTopicName <String> + [-IncludeFullEndpointUrl] [-ODataQuery <String>] [-Top <Int32>] [-NextLink <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PartnerTopicEventSubscriptionParameterSet +``` +Get-AzEventGridPartnerTopicEventSubscription -Name <String> -ResourceGroupName <String> + -PartnerTopicName <String> [-IncludeFullEndpointUrl] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdPartnerTopicEventSubscriptionParameterSet +``` +Get-AzEventGridPartnerTopicEventSubscription [-ResourceId] <String> [-IncludeFullEndpointUrl] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzEventGridPartnerTopicEventSubscription cmdlet gets either the details of a specified Event Grid partner topic subscription, or a list of all Event Grid partner topic subscriptions for a given Azure Eventgrid partner topic. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridPartnerTopicEventSubscription -ResourceGroupName MyResourceGroupName -PartnerTopicName Topic1 -EventSubscriptionName EventSubscription1 +``` + +Gets the details of event subscription \`EventSubscription1\` created for partner topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +Get-AzEventGridPartnerTopicEventSubscription -ResourceGroupName MyResourceGroupName -PartnerTopicName Topic1 -EventSubscriptionName EventSubscription1 -IncludeFullEndpointUrl +``` + +Gets the details of event subscription \`EventSubscription1\` created for partner topic \`Topic1\` in resource group \`MyResourceGroupName\`, including the full endpoint URL if it is a webhook based event subscription. + +### Example 3 +```powershell +Get-AzEventGridPartnerTopicEventSubscription -ResourceGroupName MyResourceGroupName -PartnerTopicName Topic1 +``` + +Get a list of all the event subscriptions created for partner topic \`Topic1\` in resource group \`MyResourceGroupName\` without pagination. + +### Example 4 +```powershell +$odataFilter = "Name ne 'ABCD'" +Get-AzEventGridPartnerTopicEventSubscription -ResourceGroupName MyResourceGroupName -PartnerTopicName Topic1 -Top 10 -ODataQuery $odataFilter +Get-AzEventGridPartnerTopicEventSubscription -ResourceGroupName MyResourceGroupName -PartnerTopicName Topic1 -NextLink $result.NextLink +``` + +List the first 10 event subscriptions (if any) created for partner topic \`Topic1\` in resource group \`MyResourceGroupName\` that satisfies the $odataFilter query. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of event subscriptions, user is expected to re-call Get-AzEventGridPartnerTopicEventSubscription and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeFullEndpointUrl +If specified, include the full endpoint URL of the event subscription destination in the response. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +EventGrid event subscription name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet +Aliases: EventSubscriptionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextLink +The link for the next page of resources to be obtained. +This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +The OData query used for filtering the list results. +Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerTopicName +Event Grid partner topic name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet, PartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet, PartnerTopicEventSubscriptionParameterSet +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Identifier representing the Event Grid Event Subscription. + +```yaml +Type: System.String +Parameter Sets: ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +The maximum number of resources to be obtained. +Valid value is between 1 and 100. +If top value is specified and more results are still available, the result will contain a link to the next page to be queried in NextLink. +If the Top value is not specified, the full list of resources will be returned at once. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: PartnerTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription + +### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscriptionListInstance + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerTopicEventSubscriptionDeliveryAttribute.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerTopicEventSubscriptionDeliveryAttribute.md new file mode 100644 index 0000000000..fb34424446 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridPartnerTopicEventSubscriptionDeliveryAttribute.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridpartnertopiceventsubscriptiondeliveryattribute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerTopicEventSubscriptionDeliveryAttribute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridPartnerTopicEventSubscriptionDeliveryAttribute.md +--- + +# Get-AzEventGridPartnerTopicEventSubscriptionDeliveryAttribute + +## SYNOPSIS +Gets the delivery attributes for partner topic event subscription + +## SYNTAX + +### PartnerTopicNameParameterSet (Default) +``` +Get-AzEventGridPartnerTopicEventSubscriptionDeliveryAttribute [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### PartnerTopicEventSubscriptionParameterSet +``` +Get-AzEventGridPartnerTopicEventSubscriptionDeliveryAttribute -Name <String> -ResourceGroupName <String> + -PartnerTopicName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdPartnerTopicEventSubscriptionParameterSet +``` +Get-AzEventGridPartnerTopicEventSubscriptionDeliveryAttribute [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the list of delivery attributes for partner topic event subscription + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridPartnerTopicEventSubscriptionDeliveryAttribute -ResourceGroupName MyResourceGroupName -PartnerTopicName Topic1 -EventSubscriptionName EventSubscription1 +``` + +Gets the list of delivery attributest for event subscription \`EventSubscription1\` created for partner topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +EventGrid event subscription name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet +Aliases: EventSubscriptionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerTopicName +Event Grid partner topic name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Identifier representing the Event Grid Event Subscription. + +```yaml +Type: System.String +Parameter Sets: ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PsDeliveryAttribute + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridSubscription.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridSubscription.md new file mode 100644 index 0000000000..63aa60a41a --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridSubscription.md @@ -0,0 +1,480 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridSubscription.md +--- + +# Get-AzEventGridSubscription + +## SYNOPSIS +Gets the details of an event subscription, or gets a list of all event subscriptions in the current Azure subscription. + +## SYNTAX + +### EventSubscriptionTopicNameParameterSet (Default) +``` +Get-AzEventGridSubscription [-EventSubscriptionName <String>] [-ResourceGroupName <String>] + [-TopicName <String>] [-IncludeFullEndpointUrl] [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +Get-AzEventGridSubscription [-EventSubscriptionName <String>] [-ResourceId] <String> [-IncludeFullEndpointUrl] + [-ODataQuery <String>] [-Top <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### EventSubscriptionDomainNameParameterSet +``` +Get-AzEventGridSubscription [-EventSubscriptionName <String>] [-ResourceGroupName <String>] + [-DomainName <String>] [-DomainTopicName <String>] [-IncludeFullEndpointUrl] [-ODataQuery <String>] + [-Top <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### EventSubscriptionTopicTypeNameParameterSet +``` +Get-AzEventGridSubscription [-ResourceGroupName <String>] [-TopicTypeName <String>] [-Location <String>] + [-IncludeFullEndpointUrl] [-ODataQuery <String>] [-Top <Int32>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### EventSubscriptionCustomTopicInputObjectParameterSet +``` +Get-AzEventGridSubscription [-InputObject] <PSTopic> [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### EventSubscriptionDomainInputObjectParameterSet +``` +Get-AzEventGridSubscription [-DomainInputObject] <PSDomain> [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### EventSubscriptionDomainTopicInputObjectParameterSet +``` +Get-AzEventGridSubscription [-DomainTopicInputObject] <PSDomainTopic> [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NextLinkParameterSet +``` +Get-AzEventGridSubscription [-NextLink <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzEventGridSubscription cmdlet gets either the details of a specified Event Grid subscription, or a list of all Event Grid subscriptions in the current Azure subscription or resource group. +If the event subscription name is provided, the details of a single Event Grid subscription is returned. +If the event subscription name is not provided, a list of all event subscriptions is returned. The number of elements returned in this list is controlled by the Top parameter. If the Top value is not specified or $null, the list will contain all the event subscription items. Otherwise, Top will indicate the maximum number of elements to be returned in the list. +If more event subscriptions are still available, the value in NextLink should be used in the next call to get the next page of event subscriptions. +Finally, ODataQuery parameter is used to perform filtering for the search results. The filtering query follows OData syntax using the Name property only. The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 -EventSubscriptionName EventSubscription1 +``` + +Gets the details of event subscription \`EventSubscription1\` created for topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 -EventSubscriptionName EventSubscription1 -IncludeFullEndpointUrl +``` + +Gets the details of event subscription \`EventSubscription1\` created for topic \`Topic1\` in resource group \`MyResourceGroupName\`, including the full endpoint URL if it is a webhook based event subscription. + +### Example 3 +```powershell +Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 +``` + +Get a list of all the event subscriptions created for topic \`Topic1\` in resource group \`MyResourceGroupName\` without pagination. + +### Example 4 +```powershell +$odataFilter = "Name ne 'ABCD'" +Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 -Top 10 -ODataQuery $odataFilter +Get-AzEventGridSubscription $result.NextLink +``` + +List the first 10 event subscriptions (if any) created for topic \`Topic1\` in resource group \`MyResourceGroupName\` that satisfies the $odataFilter query. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of event subscriptions, user is expected to re-call Get-AzEventGridSubscription and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +### Example 5 +```powershell +Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -EventSubscriptionName EventSubscription1 +``` + +Gets the details of event subscription \`EventSubscription1\` created for resource group \`MyResourceGroupName\`. + +### Example 6 +```powershell +Get-AzEventGridSubscription -EventSubscriptionName EventSubscription1 +``` + +Gets the details of event subscription \`EventSubscription1\` created for the currently selected Azure subscription. + +### Example 7 +```powershell +Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName +``` + +Gets the list of all global event subscriptions created under the resource group \`MyResourceGroupName\` without pagination. + +### Example 8 +```powershell +$odataFilter = "Name ne 'ABCD'" +Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -Top 5 -ODataQuery $odataFilter +Get-AzEventGridSubscription $result.NextLink +``` + +List the first 5 event subscriptions (if any) created under resource group \`MyResourceGroupName\` that satisfies the $odataFilter query. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of event subscriptions, user is expected to re-call Get-AzEventGridSubscription and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +### Example 9 +```powershell +Get-AzEventGridSubscription +``` + +Gets the list of all global event subscriptions created under the currently selected Azure subscription without pagination. + +### Example 10 +```powershell +$odataFilter = "Name ne 'ABCD'" +Get-AzEventGridSubscription -Top 15 -ODataQuery $odataFilter +Get-AzEventGridSubscription $result.NextLink +``` + +List the first 15 global event subscriptions (if any) created under the currently selected Azure subscription that satisfies the $odataFilter query. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of event subscriptions, user is expected to re-call Get-AzEventGridSubscription and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +### Example 11 +```powershell +Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -Location westus2 +``` + +Gets the list of all regional event subscriptions created under resource group \`MyResourceGroupName\` in the specified location \`westus2\` without pagination. + +### Example 12 +```powershell +$odataFilter = "Name ne 'ABCD'" +Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -Location westus2 -Top 15 -ODataQuery $odataFilter +Get-AzEventGridSubscription $result.NextLink +``` + +List the first 15 regional event subscriptions (if any) created under resource group \`MyResourceGroupName\` in the specified location \`westus2\` that satisfies the $odataFilter query. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of event subscriptions, user is expected to re-call Get-AzEventGridSubscription and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +### Example 13 +```powershell +Get-AzEventGridSubscription -ResourceId "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.EventHub/namespaces/$namespaceName" +``` + +Gets the list of all event subscriptions created for the specified EventHub namespace without pagination. + +### Example 14 +```powershell +$odataFilter = "Name ne 'ABCD'" +Get-AzEventGridSubscription -ResourceId "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.EventHub/namespaces/$namespaceName" -Top 25 -ODataQuery $odataFilter +Get-AzEventGridSubscription $result.NextLink +``` + +List the first 25 event subscriptions (if any) created for the specified EventHub namespace that satisfies the $odataFilter query. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of event subscriptions, user is expected to re-call Get-AzEventGridSubscription and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +### Example 15 +```powershell +Get-AzEventGridSubscription -TopicTypeName "Microsoft.EventHub.Namespaces" -Location $location +``` + +Gets the list of all event subscriptions created for the specified topic type (EventHub namespaces) in the specified location without pagination. + +### Example 16 +```powershell +$odataFilter = "Name ne 'ABCD'" +Get-AzEventGridSubscription -TopicTypeName "Microsoft.EventHub.Namespaces" -Location $location -Top 15 -ODataQuery $odataFilter +Get-AzEventGridSubscription $result.NextLink +``` + +List the first 15 event subscriptions (if any) created for the specified topic type (EventHub namespaces) in the specified location that satisfies the $odataFilter query. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of event subscriptions, user is expected to re-call Get-AzEventGridSubscription and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +### Example 17 +```powershell +Get-AzEventGridSubscription -TopicTypeName "Microsoft.Resources.ResourceGroups" -ResourceGroupName MyResourceGroupName +``` + +Gets the list of all event subscriptions created for the specific resource group without pagination. + +### Example 18 +```powershell +$odataFilter = "Name ne 'ABCD'" +Get-AzEventGridSubscription -TopicTypeName "Microsoft.Resources.ResourceGroups" -ResourceGroupName MyResourceGroupName -Top 100 -ODataQuery $odataFilter +Get-AzEventGridSubscription $result.NextLink +``` + +List the first 100 event subscriptions (if any) created for the specific resource group that satisfies the $odataFilter query. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of event subscriptions, user is expected to re-call Get-AzEventGridSubscription and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainInputObject +EventGrid Domain object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSDomain +Parameter Sets: EventSubscriptionDomainInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DomainName +EventGrid domain name. + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionDomainNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DomainTopicInputObject +EventGrid Domain Topic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSDomainTopic +Parameter Sets: EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DomainTopicName +EventGrid domain topic name. + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionDomainNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EventSubscriptionName +The name of the event subscription + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionTopicNameParameterSet, ResourceIdEventSubscriptionParameterSet, EventSubscriptionDomainNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludeFullEndpointUrl +Include the full endpoint URL of the event subscription destination. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EventSubscriptionTopicNameParameterSet, ResourceIdEventSubscriptionParameterSet, EventSubscriptionDomainNameParameterSet, EventSubscriptionTopicTypeNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +EventGrid Topic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Location + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionTopicTypeNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextLink +The link for the next page of resources to be obtained. This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried. + +```yaml +Type: System.String +Parameter Sets: NextLinkParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +The OData query used for filtering the list results. Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionTopicNameParameterSet, ResourceIdEventSubscriptionParameterSet, EventSubscriptionDomainNameParameterSet, EventSubscriptionTopicTypeNameParameterSet, EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionTopicNameParameterSet, EventSubscriptionDomainNameParameterSet, EventSubscriptionTopicTypeNameParameterSet +Aliases: ResourceGroup + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Identifier of the resource to which event subscriptions have been created. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +The OData query used for filtering the list results. Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: EventSubscriptionTopicNameParameterSet, ResourceIdEventSubscriptionParameterSet, EventSubscriptionDomainNameParameterSet, EventSubscriptionTopicTypeNameParameterSet, EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TopicName +EventGrid Topic Name. + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TopicTypeName +TopicType name + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionTopicTypeNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSTopic + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomain + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomainTopic + +### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridSystemTopic.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridSystemTopic.md new file mode 100644 index 0000000000..ae7c71eeda --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridSystemTopic.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridsystemtopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridSystemTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridSystemTopic.md +--- + +# Get-AzEventGridSystemTopic + +## SYNOPSIS +Gets the details of an Event Grid system topic, or gets a list of all Event Grid system topics in the current Azure subscription. + +## SYNTAX + +### ResourceGroupNameParameterSet (Default) +``` +Get-AzEventGridSystemTopic [-ResourceGroupName <String>] [-ODataQuery <String>] [-Top <Int32>] + [-NextLink <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SystemTopicNameParameterSet +``` +Get-AzEventGridSystemTopic [-ResourceGroupName <String>] [-Name <String>] [-ODataQuery <String>] [-Top <Int32>] + [-NextLink <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzEventGridSystemTopic cmdlet gets either the details of a specified Event Grid System Topic, or a list of all Event Grid topics in the current Azure subscription. +If the topic name is provided, the details of a single Event Grid Topic is returned. +If the topic name is not provided, a list of topics is returned. The number of elements returned in this list is controlled by the Top parameter. If the Top value is not specified or $null, the list will contain all the topics items. Otherwise, Top will indicate the maximum number of elements to be returned in the list. +If more topics are still available, the value in NextLink should be used in the next call to get the next page of topics. +Finally, ODataQuery parameter is used to perform filtering for the search results. The filtering query follows OData syntax using the Name property only. The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridSystemTopic -ResourceGroup MyResourceGroupName -Name Topic1 +``` + +Gets the details of Event Grid System topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +Get-AzEventGridSystemTopic -ResourceGroup MyResourceGroupName +``` + +List all the Event Grid System topics in resource group \`MyResourceGroupName\` without pagination. + +### Example 3 +```powershell +$odataFilter = "Name ne 'ABCD'" +$result = Get-AzEventGridSystemTopic -ResourceGroup MyResourceGroupName -Top 10 -ODataQuery $odataFilter +Get-AzEventGridSystemTopic $result.NextLink +``` + +List the first 10 Event Grid System topics (if any) in resource group \`MyResourceGroupName\` that satisfies the $odataFilter query. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of topics, user is expected to re-call Get-AzEventGridSystemTopic and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +### Example 4 +```powershell +Get-AzEventGridSystemTopic +``` + +List all the Event Grid topics in the subscription without pagination. + +### Example 5 +```powershell +$odataFilter = "Name ne 'ABCD'" +$result = Get-AzEventGridSystemTopic -Top 10 -ODataQuery $odataFilter +Get-AzEventGridSystemTopic $result.NextLink +``` + +List the first 10 Event Grid System topics (if any) in the subscription that satisfies the $odataFilter query. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of topics, user is expected to re-call Get-AzEventGridSystemTopic and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +EventGrid topic name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicNameParameterSet +Aliases: SystemTopicName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextLink +The link for the next page of resources to be obtained. +This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +The OData query used for filtering the list results. +Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +The maximum number of resources to be obtained. +Valid value is between 1 and 100. +If top value is specified and more results are still available, the result will contain a link to the next page to be queried in NextLink. +If the Top value is not specified, the full list of resources will be returned at once. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSSystemTopic + +### Microsoft.Azure.Commands.EventGrid.Models.PSSytemTopicListInstance + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridSystemTopicEventSubscription.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridSystemTopicEventSubscription.md new file mode 100644 index 0000000000..76536854ab --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridSystemTopicEventSubscription.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridsystemtopiceventsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridSystemTopicEventSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridSystemTopicEventSubscription.md +--- + +# Get-AzEventGridSystemTopicEventSubscription + +## SYNOPSIS +Gets the details of an event subscription, or gets a list of all event subscriptions for a given Azure Eventgrid system topic. + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +Get-AzEventGridSystemTopicEventSubscription [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SystemTopicEventSuscriptionParameterSet +``` +Get-AzEventGridSystemTopicEventSubscription [-EventSubscriptionName <String>] -ResourceGroupName <String> + -SystemTopicName <String> [-IncludeFullEndpointUrl] [-ODataQuery <String>] [-Top <Int32>] [-NextLink <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzEventGridSystemTopicEventSubscription cmdlet gets either the details of a specified Event Grid sytem topic subscription, or a list of all Event Grid sytem topic subscriptions for a given Azure Eventgrid system topic. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridSystemTopicEventSubscription -ResourceGroupName MyResourceGroupName -SystemTopicName Topic1 -EventSubscriptionName EventSubscription1 +``` + +Gets the details of event subscription \`EventSubscription1\` created for system topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +Get-AzEventGridSystemTopicEventSubscription -ResourceGroupName MyResourceGroupName -SystemTopicName Topic1 -EventSubscriptionName EventSubscription1 -IncludeFullEndpointUrl +``` + +Gets the details of event subscription \`EventSubscription1\` created for system topic \`Topic1\` in resource group \`MyResourceGroupName\`, including the full endpoint URL if it is a webhook based event subscription. + +### Example 3 +```powershell +Get-AzEventGridSystemTopicEventSubscription -ResourceGroupName MyResourceGroupName -SystemTopicName Topic1 +``` + +Get a list of all the event subscriptions created for system topic \`Topic1\` in resource group \`MyResourceGroupName\` without pagination. + +### Example 4 +```powershell +$odataFilter = "Name ne 'ABCD'" +Get-AzEventGridSystemTopicEventSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 -Top 10 -ODataQuery $odataFilter +Get-AzEventGridSystemTopicEventSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 $result.NextLink +``` + +List the first 10 event subscriptions (if any) created for system topic \`Topic1\` in resource group \`MyResourceGroupName\` that satisfies the $odataFilter query. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of event subscriptions, user is expected to re-call Get-AzEventGridSystemTopicEventSubscription and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSubscriptionName +EventGrid event subscription name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludeFullEndpointUrl +If specified, include the full endpoint URL of the event subscription destination in the response. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextLink +The link for the next page of resources to be obtained. +This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +The OData query used for filtering the list results. +Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SystemTopicName +EventGrid topic name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +The maximum number of resources to be obtained. +Valid value is between 1 and 100. +If top value is specified and more results are still available, the result will contain a link to the next page to be queried in NextLink. +If the Top value is not specified, the full list of resources will be returned at once. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription + +### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscriptionListInstance + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridSystemTopicEventSubscriptionDeliveryAttribute.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridSystemTopicEventSubscriptionDeliveryAttribute.md new file mode 100644 index 0000000000..ddd811f585 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridSystemTopicEventSubscriptionDeliveryAttribute.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridsystemtopiceventsubscriptiondeliveryattribute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridSystemTopicEventSubscriptionDeliveryAttribute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridSystemTopicEventSubscriptionDeliveryAttribute.md +--- + +# Get-AzEventGridSystemTopicEventSubscriptionDeliveryAttribute + +## SYNOPSIS +Gets the delivery attributes for system topic event subscription + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +Get-AzEventGridSystemTopicEventSubscriptionDeliveryAttribute [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SystemTopicEventSuscriptionParameterSet +``` +Get-AzEventGridSystemTopicEventSubscriptionDeliveryAttribute -EventSubscriptionName <String> + -ResourceGroupName <String> -SystemTopicName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the list of delivery attributes for system topic event subscription + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridSystemTopicEventSubscriptionDeliveryAttribute -ResourceGroupName MyResourceGroupName -SystemTopicName Topic1 -EventSubscriptionName EventSubscription1 +``` + +Gets the list of delivery attributest for event subscription \`EventSubscription1\` created for system topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSubscriptionName +EventGrid event subscription name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SystemTopicName +EventGrid topic name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PsDeliveryAttribute + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridTopic.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridTopic.md new file mode 100644 index 0000000000..31fac74cea --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridTopic.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridtopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridTopic.md +--- + +# Get-AzEventGridTopic + +## SYNOPSIS +Gets the details of an Event Grid topic, or gets a list of all Event Grid topics in the current Azure subscription. + +## SYNTAX + +### ResourceGroupNameParameterSet (Default) +``` +Get-AzEventGridTopic [[-ResourceGroupName] <String>] [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### TopicNameParameterSet +``` +Get-AzEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +Get-AzEventGridTopic [-ResourceId] <String> [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NextLinkParameterSet +``` +Get-AzEventGridTopic [-NextLink <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzEventGridTopic cmdlet gets either the details of a specified Event Grid Topic, or a list of all Event Grid topics in the current Azure subscription. +If the topic name is provided, the details of a single Event Grid Topic is returned. +If the topic name is not provided, a list of topics is returned. The number of elements returned in this list is controlled by the Top parameter. If the Top value is not specified or $null, the list will contain all the topics items. Otherwise, Top will indicate the maximum number of elements to be returned in the list. +If more topics are still available, the value in NextLink should be used in the next call to get the next page of topics. +Finally, ODataQuery parameter is used to perform filtering for the search results. The filtering query follows OData syntax using the Name property only. The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 +``` + +Gets the details of Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +Get-AzEventGridTopic -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/topics/Topic1" +``` + +Gets the details of Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +### Example 3 +```powershell +Get-AzEventGridTopic -ResourceGroup MyResourceGroupName +``` + +List all the Event Grid topics in resource group \`MyResourceGroupName\` without pagination. + +### Example 4 +```powershell +$odataFilter = "Name ne 'ABCD'" +$result = Get-AzEventGridTopic -ResourceGroup MyResourceGroupName -Top 10 -ODataQuery $odataFilter +Get-AzEventGridTopic $result.NextLink +``` + +List the first 10 Event Grid topics (if any) in resource group \`MyResourceGroupName\` that satisfies the $odataFilter query. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of topics, user is expected to re-call Get-AzEventGridTopic and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +### Example 5 +```powershell +Get-AzEventGridTopic +``` + +List all the Event Grid topics in the subscription without pagination. + +### Example 6 +```powershell +$odataFilter = "Name ne 'ABCD'" +$result = Get-AzEventGridTopic -Top 10 -ODataQuery $odataFilter +Get-AzEventGridTopic $result.NextLink +``` + +List the first 10 Event Grid topics (if any) in the subscription that satisfies the $odataFilter query. If more results are available, the $result.NextLink will not be $null. In order to get next page(s) of topics, user is expected to re-call Get-AzEventGridTopic and uses result.NextLink obtained from the previous call. Caller should stop when result.NextLink becomes $null. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +EventGrid Topic Name. + +```yaml +Type: System.String +Parameter Sets: TopicNameParameterSet +Aliases: TopicName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextLink +The link for the next page of resources to be obtained. This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried. + +```yaml +Type: System.String +Parameter Sets: NextLinkParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +The OData query used for filtering the list results. Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, TopicNameParameterSet, ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: ResourceGroup + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: TopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Identifier representing the Event Grid Topic. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +The maximum number of resources to be obtained. Valid value is between 1 and 100. If top value is specified and more results are still available, the result will contain a link to the next page to be queried in NextLink. If the Top value is not specified, the full list of resources will be returned at once. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ResourceGroupNameParameterSet, TopicNameParameterSet, ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSTopic + +### Microsoft.Azure.Commands.EventGrid.Models.PSTopicListInstance + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridTopicKey.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridTopicKey.md new file mode 100644 index 0000000000..58b05f02c7 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridTopicKey.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridtopickey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridTopicKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridTopicKey.md +--- + +# Get-AzEventGridTopicKey + +## SYNOPSIS +Gets the shared access keys used to publish events to an Event Grid topic. + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +Get-AzEventGridTopicKey [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### TopicInputObjectParameterSet +``` +Get-AzEventGridTopicKey [-InputObject] <PSTopic> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +Get-AzEventGridTopicKey [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the shared access keys used to publish events to an Event Grid topic. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridTopicKey -ResourceGroup MyResourceGroupName -Name Topic1 +``` + +Gets the shared access keys of Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +Get-AzEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 | Get-AzEventGridTopicKey +``` + +Gets the shared access keys of Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +EventGrid Topic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic +Parameter Sets: TopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +EventGrid Topic Name. + +```yaml +Type: System.String +Parameter Sets: TopicNameParameterSet +Aliases: TopicName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: TopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Identifier representing the Event Grid Topic. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSTopic + +## OUTPUTS + +### Microsoft.Azure.Management.EventGrid.Models.TopicSharedAccessKeys + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridTopicType.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridTopicType.md new file mode 100644 index 0000000000..b7967d5a01 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridTopicType.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridtopictype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridTopicType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridTopicType.md +--- + +# Get-AzEventGridTopicType + +## SYNOPSIS +Gets the details about the topic types supported by Azure Event Grid. + +## SYNTAX + +``` +Get-AzEventGridTopicType [-Name <String>] [-IncludeEventTypeData] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the details of topic types supported by Azure Event Grid. +If a topic type name is specified, details about that topic type are returned. +If a topic type name is not specified, details about all topic types are returned. +If IncludeEventTypes is specified, information about event types supported by each topic type is included in the response. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridTopicType +``` + +Gets a list of the topic types. + +### Example 2 +```powershell +Get-AzEventGridTopicType -Name "Microsoft.Storage.StorageAccounts" +``` + +Gets information about the StorageAccounts topic type. + +### Example 3 +```powershell +Get-AzEventGridTopicType -Name "Microsoft.Storage.StorageAccounts" -IncludeEventTypeData +``` + +Gets information about the StorageAccounts topic type, including the event types supported by StorageAccounts. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeEventTypeData +If specified, the response will include the event types supported by a topic type. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +EventGrid Topic Type Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSTopicTypeInfoListInstance + +### Microsoft.Azure.Commands.EventGrid.Models.PSTopicTypeInfo + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Get-AzEventGridVerifiedPartner.md b/azps-10.1.0/Az.EventGrid/Get-AzEventGridVerifiedPartner.md new file mode 100644 index 0000000000..e956b9bb93 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Get-AzEventGridVerifiedPartner.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/get-azeventgridverifiedpartner +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridVerifiedPartner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Get-AzEventGridVerifiedPartner.md +--- + +# Get-AzEventGridVerifiedPartner + +## SYNOPSIS +Gets the details of a specific Event Grid verified partner or gets the details of all verified partners in the current azure subscription. + +## SYNTAX + +### VerifiedPartnerNameParameterSet (Default) +``` +Get-AzEventGridVerifiedPartner [-Name <String>] [-ODataQuery <String>] [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NextLinkParameterSet +``` +Get-AzEventGridVerifiedPartner [-NextLink <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzEventGridVerifiedPartners will get the detail of a specific verified partner or gets the details of all verified partners in the current Azure subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzEventGridVerifiedPartner -Name VerifiedPartner1 +``` + +Gets the details of verified partner \`VerifiedPartner1\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +EventGrid Verified Partner Name. + +```yaml +Type: System.String +Parameter Sets: VerifiedPartnerNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextLink +The link for the next page of resources to be obtained. +This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried. + +```yaml +Type: System.String +Parameter Sets: NextLinkParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +The OData query used for filtering the list results. +Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT. + +```yaml +Type: System.String +Parameter Sets: VerifiedPartnerNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +The maximum number of resources to be obtained. +Valid value is between 1 and 100. +If top value is specified and more results are still available, the result will contain a link to the next page to be queried in NextLink. +If the Top value is not specified, the full list of resources will be returned at once. + +```yaml +Type: System.Int32 +Parameter Sets: VerifiedPartnerNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSVerifiedPartnerListInstance + +### Microsoft.Azure.Commands.EventGrid.Models.PSVerifiedPartner + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Grant-AzEventGridPartnerConfiguration.md b/azps-10.1.0/Az.EventGrid/Grant-AzEventGridPartnerConfiguration.md new file mode 100644 index 0000000000..cbd0a4f3a9 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Grant-AzEventGridPartnerConfiguration.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/grant-azeventgridpartnerconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Grant-AzEventGridPartnerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Grant-AzEventGridPartnerConfiguration.md +--- + +# Grant-AzEventGridPartnerConfiguration + +## SYNOPSIS +Grants access to a partner for the specified partner configuration. + +## SYNTAX + +### ResourceGroupNameParameterSet (Default) +``` +Grant-AzEventGridPartnerConfiguration [-ResourceGroupName] <String> [[-PartnerRegistrationImmutableId] <Guid>] + [[-PartnerName] <String>] [[-AuthorizationExpirationTime] <DateTime>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PartnerConfigurationInputObjectParameterSet +``` +Grant-AzEventGridPartnerConfiguration [-InputObject] <PSPartnerConfiguration> + [[-PartnerRegistrationImmutableId] <Guid>] [[-PartnerName] <String>] + [[-AuthorizationExpirationTime] <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The Grant-AzEventGridPartnerConfiguration cmdlet grants access to a partner for the specific partner configuration based on either the partner registration immutable ID or the partner name. +At least one of the partner registration immutable ID and the partner name is required. + +## EXAMPLES + +### Example 1 +```powershell +Grant-AzEventGridPartnerConfiguration -ResourceGroup MyResourceGroupName -PartnerRegistrationImmutableId 23e0092b-f336-4833-9ab3-9353a15650fc +``` + +Grants access to a partner based on the partner ID for the partner configuration in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -AuthorizationExpirationTime +Expiration time of the partner authorization. +If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. +If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. +If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PartnerConfiguration object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfiguration +Parameter Sets: PartnerConfigurationInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerName +Parter name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerRegistrationImmutableId +Immutable id of the corresponding partner registration + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfiguration + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridChannel.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridChannel.md new file mode 100644 index 0000000000..3f6499b122 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridChannel.md @@ -0,0 +1,259 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgridchannel +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridChannel.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridChannel.md +--- + +# New-AzEventGridChannel + +## SYNOPSIS +Creates a new Event Grid channel. + +## SYNTAX + +``` +New-AzEventGridChannel [-ResourceGroupName] <String> [-PartnerNamespaceName] <String> [-Name] <String> + [-ChannelType] <String> [-PartnerTopicSource <String>] [-MessageForActivation <String>] + [-PartnerTopicName <String>] [-EventTypeKind <String>] [-InlineEvent <Hashtable>] + [-ExpirationTimeIfNotActivatedUtc <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Event Grid channel based in the provided channel type. + +## EXAMPLES + +### Example 1 +```powershell +New-AzEventGridChannel -ResourceGroupName MyResourceGroupName -PartnerNamespaceName PartnerNamespace1 -Name Channel1 -ChannelType PartnerTopic -PartnerTopicSource PartnerTopicSource1 -PartnerTopicName PartnerTopic1 +``` + +Creates an Event Grid channel \`Channel\` under the partner namespace \`PartnerNamespace\` under the resource group \`MyResourceGroupName\`. +The channel will be of type PartnerTopic and the partner topic \`PartnerTopic1\` will be created with the specified source. + +## PARAMETERS + +### -ChannelType +The type of the event channel which represents the direction flow of events. +Possible values include: 'PartnerTopic' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: PartnerTopic + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventTypeKind +The kind of event type used. +Possible values include: 'Inline' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpirationTimeIfNotActivatedUtc +Expiration time of the partner topic. +If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InlineEvent +Hashtable representing information on inline events. +The inline event keys are of type string which represents the name of the event.The inline event values are Hashtables containing the optional keys description, displayName, documentationUrl, and dataSchemaUrl which define the information about the inline event. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: +Accepted values: Inline + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MessageForActivation +Context or helpful message that can be used during the approval process by the subscriber. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the Event Grid channel. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ChannelName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerNamespaceName +Event Grid partner namespace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerTopicName +Event Grid partner topic name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerTopicSource +Source information provided by the publisher to determine the scope or context from which the events are originating. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSChannel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridDomain.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridDomain.md new file mode 100644 index 0000000000..ba20f47edb --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridDomain.md @@ -0,0 +1,363 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgriddomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridDomain.md +--- + +# New-AzEventGridDomain + +## SYNOPSIS +Creates a new Azure Event Grid Domain. + +## SYNTAX + +``` +New-AzEventGridDomain [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> [-Tag <Hashtable>] + [-InputSchema <String>] [-InputMappingField <Hashtable>] [-InputMappingDefaultValue <Hashtable>] + [-InboundIpRule <Hashtable>] [-PublicNetworkAccess <String>] [-DisableLocalAuth] + [-AutoCreateTopicWithFirstSubscription] [-AutoDeleteTopicWithLastSubscription] [-IdentityType <String>] + [-IdentityId <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Azure Event Grid Domain. Once the domain is created, an application can publish events to the topic endpoint. + +## EXAMPLES + +### Example 1 + +Creates an Event Grid domain \`Domain1\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\`. + +```powershell +New-AzEventGridDomain -ResourceGroupName MyResourceGroupName -Name Domain1 -Location westus2 +``` + +```output +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +Id : /subscriptions/<Azure Subscription Id>/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/domain1 +Type : Microsoft.EventGrid/domains +Location : westus2 +Endpoint : https://domain1.westus2-1.eventgrid.azure.net/api/events +ProvisioningState : Succeeded +Tags : +``` + +### Example 2 + +Creates an Event Grid domain \`Domain1\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\` with the specified tags "Department" and "Environment". + +```powershell +New-AzEventGridDomain -ResourceGroupName MyResourceGroupName -Name Domain1 -Location westus2 -Tag @{ Department="Finance"; Environment="Test" } +``` + +```output +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +Id : /subscriptions/<Azure Subscription Id>/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/domain1 +Type : Microsoft.EventGrid/domains +Location : westus2 +Endpoint : https://domain1.westus2-1.eventgrid.azure.net/api/events +ProvisioningState : Succeeded +Tags : {[Department, Finance], [Environment, Test]} +``` + +### Example 3 + +Creates an Event Grid domain \`Domain1\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\` \`SystemAssigned\` identity type. + +```powershell +New-AzEventGridDomain -ResourceGroupName MyResourceGroupName -Name Domain1 -Location westus2 -IdentityType "SystemAssigned" +``` + +### Example 4 + +Creates an Event Grid domain \`Domain1\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\` \`UserAssigned\` identity type with given identity ids. + +```powershell +$id1 = '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName' +$id2 = '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName' + +New-AzEventGridDomain -ResourceGroupName MyResourceGroupName -Name Domain1 -Location westus2 -IdentityType "UserAssigned" -IdentityId $id1,$id2 +``` + +## PARAMETERS + +### -AutoCreateTopicWithFirstSubscription +Switch param to auto create topic with first subscription + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutoDeleteTopicWithLastSubscription +Switch param to auto delete topic with last subscription + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Switch param to disable local auth. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityId +The list of user assigned identities + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityType +Different identity types. Could be either of following 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InboundIpRule +Hashtable which represents list of inbound IP rules. Each rule specifies the IP Address in CIDR notation e.g., 10.0.0.0/8 along with the corresponding Action to be performed based on the match or no match of the IpMask. Possible Action values include Allow only + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputMappingDefaultValue +Hashtable which represents the input mapping fields with default value in space separated key = value format. Allowed key names are: subject, eventtype, and dataversion. This is used when InputSchemaHelp is customeventschema only. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputMappingField +Hashtable which represents the input mapping fields in space separated key = value format. Allowed key names are: id, topic, eventtime, subject, eventtype, and dataversion. This is used when InputSchemaHelp is customeventschema only. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputSchema +The schema of the input events for the topic. Allowed values are: eventgridschema, customeventschema, or cloudeventv01Schema. Default value is eventgridschema. Note that if customeventschema is specified, then InputMappingField or/and InputMappingDefaultValue parameters need to be specified as well. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: EventGridSchema, CustomEventSchema, CloudEventSchemaV1_0 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +The location of the domain. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +EventGrid domain name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DomainName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring InboundIpRule parameters. Allowed values are disabled and enabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: enabled, disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Hashtable which represents resource Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomain + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridDomainKey.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridDomainKey.md new file mode 100644 index 0000000000..53fa6a769b --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridDomainKey.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgriddomainkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridDomainKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridDomainKey.md +--- + +# New-AzEventGridDomainKey + +## SYNOPSIS +Regenerates the shared access key for an Azure Event Grid Domain. + +## SYNTAX + +### DomainNameParameterSet (Default) +``` +New-AzEventGridDomainKey [-ResourceGroupName] <String> [-DomainName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DomainInputObjectParameterSet +``` +New-AzEventGridDomainKey [-Name] <String> [-DomainInputObject] <PSDomain> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +New-AzEventGridDomainKey [-Name] <String> [-DomainResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerates the shared access key for an Azure Event Grid Domain. + +## EXAMPLES + +### Example 1 + +Regenerate the key corresponding to key \'key1'\ of Event Grid domain \`Domain1\` in resource group \`MyResourceGroupName\`. + +```powershell +New-AzEventGridDomainKey -ResourceGroupName MyResourceGroupName -DomainName Domain1 -Name key1 +``` + +```output +Key1 Key2 +---- ---- +<New Value for Key1> <Old Value for Key2> +``` + +### Example 2 + +Regenerate the key corresponding to key \'key1'\ of Event Grid domain \`Domain1\` in resource group \`MyResourceGroupName\`. + +```powershell +Get-AzEventGridDomain -ResourceGroupName MyResourceGroupName -Name Domain1 | New-AzEventGridTopicKey -KeyName "key1" +``` + +```output +Key1 Key2 +---- ---- +<New Value for Key1> <Old Value for Key2> +``` + +### Example 3 + +Regenerate the key corresponding to key \'key2'\ of Event Grid domain \`Domain1\` in resource group \`MyResourceGroupName\` using its full resource Id. + +```powershell +New-AzEventGridDomainKey -DomainResourceId /subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1 -KeyName Key2 +``` + +```output +Key1 Key2 +---- ---- +<Old Value for Key1> <New Value for Key2> +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainInputObject +EventGrid Domain object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSDomain +Parameter Sets: DomainInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DomainName +EventGrid domain name. + +```yaml +Type: System.String +Parameter Sets: DomainNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DomainResourceId +Resource Identifier representing the Event Grid Domain. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the key that needs to be regenerated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: KeyName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DomainNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomain + +## OUTPUTS + +### Microsoft.Azure.Management.EventGrid.Models.DomainSharedAccessKeys + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridDomainTopic.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridDomainTopic.md new file mode 100644 index 0000000000..5a694d749c --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridDomainTopic.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgriddomaintopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridDomainTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridDomainTopic.md +--- + +# New-AzEventGridDomainTopic + +## SYNOPSIS +Creates a new Azure Event Grid Domain Topic. + +## SYNTAX + +``` +New-AzEventGridDomainTopic [-ResourceGroupName] <String> [-DomainName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Azure Event Grid Domain Topic. + +## EXAMPLES + +### Example 1 + +Creates an Event Grid Domain Topic \`Topic1\` in Domain \`Domain1\` under resource group \`MyResourceGroupName\`. + +```powershell +New-AzEventGridDomainTopic -ResourceGroupName MyResourceGroupName -DomainName Domain1 -Name Topic1 +``` + +```output +ResourceGroupName : MyResourceGroupName +DomainName : Domain1 +DomainTopicName : topic1 +Id : /subscriptions/<Azure Subscription Id>/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1/topics/topic1 +Type : Microsoft.EventGrid/domains/topics +ProvisioningState : Succeeded +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +EventGrid domain name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Domain + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +EventGrid domain topic name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DomainTopicName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomainTopic + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerConfiguration.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerConfiguration.md new file mode 100644 index 0000000000..1b43c25156 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerConfiguration.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgridpartnerconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridPartnerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridPartnerConfiguration.md +--- + +# New-AzEventGridPartnerConfiguration + +## SYNOPSIS +Creates a new Event Grid partner configuration. + +## SYNTAX + +``` +New-AzEventGridPartnerConfiguration [-ResourceGroupName] <String> [-Tag <Hashtable>] + [-MaxExpirationTimeInDays <Int32>] [-AuthorizedPartner <Hashtable[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new partner configuration. + +## EXAMPLES + +### Example 1 +```powershell +New-AzEventGridPartnerConfiguration -ResourceGroupName MyResourceGroupName -MaxExpirationTimeInDays 14 +``` + +Creates a new partner configuration under the resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -AuthorizedPartner +Array of HashTables where each HashTable is the details of an authorized partner. +Each HashTable has the following key-value info: partnerName, partnerRegistrationImmutableId, and authorizationExpirationTimeInUtc. +At least one key is required. +The partnerName is a String, partnerRegistrationImmutableId is a Guid, and authorizationExpirationTimeInUtc is a DateTime. + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxExpirationTimeInDays +Expiration time in days used to validate the authorization expiration time for each authorized partner. +If this parameter is not specified, the default is 7 days. +Otherwise, allowed values are between 1 and 365 days. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Hashtable which represents resource Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Collections.Hashtable[] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerNamespace.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerNamespace.md new file mode 100644 index 0000000000..6471e4d5ba --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerNamespace.md @@ -0,0 +1,280 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgridpartnernamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridPartnerNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridPartnerNamespace.md +--- + +# New-AzEventGridPartnerNamespace + +## SYNOPSIS +Creates a new Event Grid partner namespace. + +## SYNTAX + +``` +New-AzEventGridPartnerNamespace [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + [-Tag <Hashtable>] [-PrivateEndpointConnection <PSPrivateEndpointConnection[]>] + [-InboundIpRule <PSInboundIpRule[]>] [-PartnerRegistrationFullyQualifiedId <String>] [-Endpoint <String>] + [-PublicNetworkAccess <String>] [-DisableLocalAuth <Boolean>] [-PartnerTopicRoutingMode <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Event Grid partner namespace. + +## EXAMPLES + +### Example 1 +```powershell +New-AzEventGridPartnerNamespace -ResourceGroupName MyResourceGroupName -Name PartnerNamespace1 -Location westus2 -PartnerRegistrationFullyQualifiedId 23e0092b-f336-4833-9ab3-9353a15650fc +``` + +Creates a new Event Grid partner namespace \`PartnerNamespace1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Switch param to disable local auth. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Endpoint +Endpoint for the partner namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InboundIpRule +Array of PSInboundIpRule which represents list of inbound IP rules. +Each rule specifies the IP Address in CIDR notation e.g., 10.0.0.0/8 along with the corresponding Action to be performed based on the match or no match of the IpMask. +Possible Action values include Allow only + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSInboundIpRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Location of the partner namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Event Grid partner namespace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PartnerNamespaceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerRegistrationFullyQualifiedId +Fully qualified ARM Id of the partner registration that should be associated with this partner namespace. +This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerTopicRoutingMode +Determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. +If none is specified, source attribute routing will be used to match the partner topic. +Possible values include: 'SourceEventAttribute', 'ChannelNameHeader' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: SourceEventAttribute, ChannelNameHeader + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateEndpointConnection +List of PSPrivateEndointConnection representing information about the private endpoint connections. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSPrivateEndpointConnection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +This determines if traffic is allowed over public network. +By default it is enabled. +You can further restrict to specific IPs by configuring InboundIpRule parameters. +Allowed values are disabled and enabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Hashtable which represents resource Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.EventGrid.Models.PSPrivateEndpointConnection[] + +### Microsoft.Azure.Commands.EventGrid.Models.PSInboundIpRule[] + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerNamespace + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerNamespaceKey.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerNamespaceKey.md new file mode 100644 index 0000000000..ca83d8c5cb --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerNamespaceKey.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgridpartnernamespacekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridPartnerNamespaceKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridPartnerNamespaceKey.md +--- + +# New-AzEventGridPartnerNamespaceKey + +## SYNOPSIS +Regenerates the shared access key for an Azure Event Grid partner namespace. + +## SYNTAX + +### PartnerNamespaceNameParameterSet (Default) +``` +New-AzEventGridPartnerNamespaceKey [-ResourceGroupName] <String> [-PartnerNamespaceName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PartnerNamespaceInputObjectParameterSet +``` +New-AzEventGridPartnerNamespaceKey [-Name] <String> -InputObject <PSPartnerNamespace> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerates the shared access key for an Azure Event Grid partner namespace. + +## EXAMPLES + +### Example 1 +```powershell +New-AzEventGridPartnerNamespaceKey -ResourceGroupName MyResourceGroupName -PartnerNamespaceName PartnerNamespace1 -Name key1 +``` + +Regenerate the key corresponding to key \`key1\` of Event Grid partner namespace \`PartnerNamespace1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PartnerNamespace object + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSPartnerNamespace +Parameter Sets: PartnerNamespaceInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the shared access key for the partner namespace. +Either key1 or key2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: KeyName +Accepted values: key1, key2 + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerNamespaceName +Event Grid partner namespace name. + +```yaml +Type: System.String +Parameter Sets: PartnerNamespaceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PartnerNamespaceNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerNamespace + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerNamespace + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerRegistration.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerRegistration.md new file mode 100644 index 0000000000..e21cbe7b6b --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerRegistration.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgridpartnerregistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridPartnerRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridPartnerRegistration.md +--- + +# New-AzEventGridPartnerRegistration + +## SYNOPSIS +Creates a new Event Grid partner registration. + +## SYNTAX + +``` +New-AzEventGridPartnerRegistration [-ResourceGroupName] <String> [-Name] <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzEventGridPartnerRegistration cmdlet creates a new Event Grid partner registration. + +## EXAMPLES + +### Example 1 +```powershell +New-AzEventGridPartnerRegistration -ResourceGroupName MyResourceGroupName -Name PartnerRegistration1 +``` + +Creates a new Event Grid partner registration \`PartnerRegistration1\` in the resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Event Grid partner registration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PartnerRegistrationName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Hashtable which represents resource Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerRegistration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerTopic.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerTopic.md new file mode 100644 index 0000000000..be8706a8ed --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerTopic.md @@ -0,0 +1,316 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgridpartnertopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridPartnerTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridPartnerTopic.md +--- + +# New-AzEventGridPartnerTopic + +## SYNOPSIS +Creates a new Azure Event Grid Partner Topic. + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +New-AzEventGridPartnerTopic [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### PartnerTopicNameParameterSet +``` +New-AzEventGridPartnerTopic -ResourceGroupName <String> -Name <String> -Source <String> [-Location <String>] + [-IdentityType <String>] [-IdentityId <String[]>] [-Tag <Hashtable>] + [-PartnerTopicFriendlyDescription <String>] [-MessageForActivation <String>] + [-ExpirationTimeIfNotActivatedUtc <DateTime>] [-PartnerRegistrationImmutableId <Guid>] + [-EventTypeKind <String>] [-InlineEvent <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Azure Event Partner Topic. + +## EXAMPLES + +### Example 1 +```powershell +New-AzEventGridPartnerTopic -ResourceGroupName MyResourceGroupName -Name PartnerTopic1 -Source ContosoCorp.Accounts.User1 -Location westus2 -PartnerRegistrationImmutableId 23e0092b-f336-4833-9ab3-9353a15650fc +``` + +Creates a new Event Grid partner topic \`PartnerTopic\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventTypeKind +The kind of event type used. +Possible values include: 'Inline' + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: +Accepted values: Inline + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpirationTimeIfNotActivatedUtc +Expiration time of the partner topic. +If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: PartnerTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityId +The list of user assigned identities + +```yaml +Type: System.String[] +Parameter Sets: PartnerTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityType +Different identity types. +Could be either of following 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: +Accepted values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InlineEvent +Hashtable representing information on inline events. +The inline event keys are of type string which represents the name of the event.The inline event values are Hashtables containing the optional keys description, displayName, documentationUrl, and dataSchemaUrl which define the information about the inline event. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: PartnerTopicNameParameterSet +Aliases: +Accepted values: Inline + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +The location of the topic. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MessageForActivation +Context or helpful message that can be used during the approval process by the subscriber. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +EventGrid topic name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: PartnerTopicName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerRegistrationImmutableId +Immutable id of the corresponding partner registration + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: PartnerTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerTopicFriendlyDescription +Hashtable which represents resource Tags. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Source +Source for a system topic + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Hashtable which represents resource Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: PartnerTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Collections.Hashtable + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerTopic + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerTopicEventSubscription.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerTopicEventSubscription.md new file mode 100644 index 0000000000..010881731c --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridPartnerTopicEventSubscription.md @@ -0,0 +1,505 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgridpartnertopiceventsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridPartnerTopicEventSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridPartnerTopicEventSubscription.md +--- + +# New-AzEventGridPartnerTopicEventSubscription + +## SYNOPSIS +Creates a new Azure Event Grid Event Subscription to a Partner topic. + +## SYNTAX + +``` +New-AzEventGridPartnerTopicEventSubscription -Name <String> -ResourceGroupName <String> + -PartnerTopicName <String> [-AzureActiveDirectoryApplicationIdOrUri <String>] + [-AzureActiveDirectoryTenantId <String>] [-DeadLetterEndpoint <String>] + [-DeliveryAttributeMapping <Hashtable[]>] [-Endpoint <String>] [-EndpointType <String>] + [-DeliverySchema <String>] [-EventTtl <Int32>] [-ExpirationDate <DateTime>] [-Label <String[]>] + [-MaxDeliveryAttempt <Int32>] [-MaxEventsPerBatch <Int32>] [-PreferredBatchSizeInKiloByte <Int32>] + [-StorageQueueMessageTtl <Int64>] [-AdvancedFilter <Hashtable[]>] [-AdvancedFilteringOnArray] + [-IncludedEventType <String[]>] [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] + [-SubjectCaseSensitive] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new event subscription to an Azure Event Grid Partner topic. + +## EXAMPLES + +### Example 1 +```powershell +New-AzEventGridPartnerTopicEventSubscription -ResourceGroup MyResourceGroup -PartnerTopicName Topic1 -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 +``` + +Creates a new event subscription \`EventSubscription1\` to an Azure Event Grid Partner topic \`Topic1\` in resource group \`MyResourceGroupName\` with the webhook destination endpoint `https://requestb.in/19qlscd1`. This event subscription uses default filters. + +### Example 2 +```powershell +$includedEventTypes = "Microsoft.Resources.ResourceWriteFailure", "Microsoft.Resources.ResourceWriteSuccess" +$labels = "Finance", "HR" +New-AzEventGridPartnerTopicEventSubscription -ResourceGroup MyResourceGroup -PartnerTopicName Topic1 -EventSubscriptionName EventSubscription1 -Endpoint https://requestb.in/19qlscd1 -SubjectBeginsWith "TestPrefix" -SubjectEndsWith "TestSuffix" -IncludedEventType $includedEventTypes -Label $labels +``` + +Creates a new event subscription \`EventSubscription1\` to Sytem Topic \`Topic1\` in resource group \`MyResourceGroup\` with the webhook destination endpoint `https://requestb.in/19qlscd1`. This event subscription specifies the additional filters for event types and subject, and only events matching those filters will be delivered to the destination endpoint. + +### Example 3 +```powershell +New-AzEventGridPartnerTopicEventSubscription -ResourceGroup MyResourceGroup -PartnerTopicName Topic1 -EventSubscriptionName EventSubscription1 -EndpointType "eventhub" -Endpoint "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" +``` + +Creates a new event subscription \`EventSubscription1\` to Sytem Topic \`Topic1\` in resource group \`MyResourceGroup\` with the specified event hub as the destination for events. This event subscription uses default filters. + +## PARAMETERS + +### -AdvancedFilter +Advanced filter that specifies an array of multiple Hashtable values that are used for the attribute-based filtering. +Each Hashtable value has the following keys-value info: Operation, Key and Value or Values. +Operator can be one of the following values: NumberIn, NumberNotIn, NumberLessThan, NumberGreaterThan, NumberLessThanOrEquals, NumberGreaterThanOrEquals, BoolEquals, StringIn, StringNotIn, StringBeginsWith, StringEndsWith or StringContains. +Key represents the payload property where the advanced filtering policies are applied. +Finally, Value or Values represent the value or set of values to be matched. +This can be a single value of the corresponding type or an array of values. +As an example of the advanced filter parameters: $AdvancedFilters=@($AdvFilter1, $AdvFilter2) where $AdvFilter1=@{operator="NumberIn"; key="Data.Key1"; Values=@(1,2)} and $AdvFilter2=@{operator="StringBringsWith"; key="Subject"; Values=@("SubjectPrefix1","SubjectPrefix2")} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AdvancedFilteringOnArray +The presence of this parameter denotes that advanced filtering on arrays is enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureActiveDirectoryApplicationIdOrUri +The Azure Active Directory (AAD) Application Id or Uri to get the access token that will be included as the bearer token in delivery requests.Applicable only for webhook as a destination. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureActiveDirectoryTenantId +The Azure Active Directory (AAD) Tenant Id to get the access token that will be included as the bearer token in delivery requests.Applicable only for webhook as a destination. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DeadLetterEndpoint +The endpoint used for storing undelivered events. +Specify the Azure resource ID of a Storage blob container. +For example: /subscriptions/\[SubscriptionId\]/resourceGroups/\[ResourceGroupName\]/providers/Microsoft.Storage/storageAccounts/\[StorageAccountName\]/blobServices/default/containers/\[ContainerName\]. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryAttributeMapping +The delivery attribute mappings for this system topic event subscription. +Each delivery attribute mapping should contain following two mandatory fields : Name and Type. +The Type can either be 'Static' or 'Dynamic'. +If the type is 'Static' then properties 'Value' and 'IsSecret' are required. +If the type is 'Dynamic' then property 'SourceField' is required. +An example of the DynamicAttributeMapping parameters: $DeliveryAttributeMapping=@($DeliveryAttributeMapping1, $DeliveryAttributeMapping2) where $DeliveryAttributeMapping1=@{Name="Name1"; Type="Static"; Values="value"; IsSecret="false"} and $DeliveryAttributeMapping2=@{Name="Name2"; Type="Dynamic"; SourceField="data.prop1"} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DeliverySchema +The schema to be used when delivering events to the destination. +The possible values are: eventgridschema, CustomInputSchema, or cloudeventv01schema. +Default value is CustomInputSchema. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Endpoint +Event subscription destination endpoint. +This can be a webhook URL, or the Azure resource ID of an EventHub, storage queue, hybridconnection, servicebusqueue, servicebustopic or azurefunction. +For example, the resource ID for a hybrid connection takes the following form: /subscriptions/\[Azure Subscription ID\]/resourceGroups/\[ResourceGroupName\]/providers/Microsoft.Relay/namespaces/\[NamespaceName\]/hybridConnections/\[HybridConnectionName\]. +It is expected that the destination endpoint to be created and available for use before executing any Event Grid cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EndpointType +Endpoint Type. +This can be webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic or azurefunction. +Default value is webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EventTtl +The time in minutes for the event delivery. +This value must be between 1 and 1440 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpirationDate +Determines the expiration DateTime for the event subscription after which event subscription will retire. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludedEventType +Filter that specifies a list of event types to include. +If not specified, all event types (for the custom topics and domains) or default event types (for other topic types) will be included. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Label +Labels for the event subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxDeliveryAttempt +The maximum number of attempts to deliver the event. +This value must be between 1 and 30. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxEventsPerBatch +The maximum number of events in a batch. +This value must be between 1 and 5000. +This parameter is valid when Endpint Type is webhook only. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +EventGrid event subscription name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: EventSubscriptionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerTopicName +Event Grid partner topic name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PreferredBatchSizeInKiloByte +The preferred batch size in kilobytes. +This value must be between 1 and 1024. +This parameter is valid when Endpint Type is webhook only. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageQueueMessageTtl +The time in milliseconds for time to live of a storage queue message + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectBeginsWith +Filter that specifies that only events matching the specified subject prefix will be included. +If not specified, events with all subject prefixes will be included. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectCaseSensitive +Filter that specifies that the subject field should be compared in a case sensitive manner. +If not specified, subject will be compared in a case insensitive manner. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectEndsWith +Filter that specifies that only events matching the specified subject suffix will be included. +If not specified, events with all subject suffixes will be included. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Int32 + +### System.DateTime + +### System.Int64 + +### System.Collections.Hashtable[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridSubscription.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridSubscription.md new file mode 100644 index 0000000000..3ac46d6f8a --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridSubscription.md @@ -0,0 +1,921 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgridsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridSubscription.md +--- + +# New-AzEventGridSubscription + +## SYNOPSIS +Creates a new Azure Event Grid Event Subscription to a topic, Azure resource, Azure subscription or Resource Group. + +## SYNTAX + +### ResourceGroupNameParameterSet (Default) +``` +New-AzEventGridSubscription [-EventSubscriptionName] <String> [-Endpoint] <String> + [[-ResourceGroupName] <String>] [-EndpointType <String>] [-SubjectBeginsWith <String>] + [-SubjectEndsWith <String>] [-SubjectCaseSensitive] [-IncludedEventType <String[]>] [-Label <String[]>] + [-EventTtl <Int32>] [-MaxDeliveryAttempt <Int32>] [-DeliverySchema <String>] [-DeadLetterEndpoint <String>] + [-ExpirationDate <DateTime>] [-AdvancedFilter <Hashtable[]>] [-MaxEventsPerBatch <Int32>] + [-PreferredBatchSizeInKiloByte <Int32>] [-AzureActiveDirectoryTenantId <String>] + [-AzureActiveDirectoryApplicationIdOrUri <String>] [-AdvancedFilteringOnArray] + [-DeliveryAttributeMapping <Hashtable[]>] [-StorageQueueMessageTtl <Int64>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +New-AzEventGridSubscription [-ResourceId] <String> [-EventSubscriptionName] <String> [-Endpoint] <String> + [-EndpointType <String>] [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] [-SubjectCaseSensitive] + [-IncludedEventType <String[]>] [-Label <String[]>] [-EventTtl <Int32>] [-MaxDeliveryAttempt <Int32>] + [-DeliverySchema <String>] [-DeadLetterEndpoint <String>] [-ExpirationDate <DateTime>] + [-AdvancedFilter <Hashtable[]>] [-MaxEventsPerBatch <Int32>] [-PreferredBatchSizeInKiloByte <Int32>] + [-AzureActiveDirectoryTenantId <String>] [-AzureActiveDirectoryApplicationIdOrUri <String>] + [-AdvancedFilteringOnArray] [-DeliveryAttributeMapping <Hashtable[]>] [-StorageQueueMessageTtl <Int64>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EventSubscriptionCustomTopicInputObjectParameterSet +``` +New-AzEventGridSubscription [-InputObject] <PSTopic> [-EventSubscriptionName] <String> [-Endpoint] <String> + [-EndpointType <String>] [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] [-SubjectCaseSensitive] + [-IncludedEventType <String[]>] [-Label <String[]>] [-EventTtl <Int32>] [-MaxDeliveryAttempt <Int32>] + [-DeliverySchema <String>] [-DeadLetterEndpoint <String>] [-ExpirationDate <DateTime>] + [-AdvancedFilter <Hashtable[]>] [-MaxEventsPerBatch <Int32>] [-PreferredBatchSizeInKiloByte <Int32>] + [-AzureActiveDirectoryTenantId <String>] [-AzureActiveDirectoryApplicationIdOrUri <String>] + [-AdvancedFilteringOnArray] [-DeliveryAttributeMapping <Hashtable[]>] [-StorageQueueMessageTtl <Int64>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EventSubscriptionDomainInputObjectParameterSet +``` +New-AzEventGridSubscription [-DomainInputObject] <PSDomain> [-EventSubscriptionName] <String> + [-Endpoint] <String> [-EndpointType <String>] [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] + [-SubjectCaseSensitive] [-IncludedEventType <String[]>] [-Label <String[]>] [-EventTtl <Int32>] + [-MaxDeliveryAttempt <Int32>] [-DeliverySchema <String>] [-DeadLetterEndpoint <String>] + [-ExpirationDate <DateTime>] [-AdvancedFilter <Hashtable[]>] [-MaxEventsPerBatch <Int32>] + [-PreferredBatchSizeInKiloByte <Int32>] [-AzureActiveDirectoryTenantId <String>] + [-AzureActiveDirectoryApplicationIdOrUri <String>] [-AdvancedFilteringOnArray] + [-DeliveryAttributeMapping <Hashtable[]>] [-StorageQueueMessageTtl <Int64>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EventSubscriptionDomainTopicInputObjectParameterSet +``` +New-AzEventGridSubscription [-DomainTopicInputObject] <PSDomainTopic> [-EventSubscriptionName] <String> + [-Endpoint] <String> [-EndpointType <String>] [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] + [-SubjectCaseSensitive] [-IncludedEventType <String[]>] [-Label <String[]>] [-EventTtl <Int32>] + [-MaxDeliveryAttempt <Int32>] [-DeliverySchema <String>] [-DeadLetterEndpoint <String>] + [-ExpirationDate <DateTime>] [-AdvancedFilter <Hashtable[]>] [-MaxEventsPerBatch <Int32>] + [-PreferredBatchSizeInKiloByte <Int32>] [-AzureActiveDirectoryTenantId <String>] + [-AzureActiveDirectoryApplicationIdOrUri <String>] [-AdvancedFilteringOnArray] + [-DeliveryAttributeMapping <Hashtable[]>] [-StorageQueueMessageTtl <Int64>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CustomTopicEventSubscriptionParameterSet +``` +New-AzEventGridSubscription [-EventSubscriptionName] <String> [-Endpoint] <String> + [-ResourceGroupName] <String> [-TopicName] <String> [-EndpointType <String>] [-SubjectBeginsWith <String>] + [-SubjectEndsWith <String>] [-SubjectCaseSensitive] [-IncludedEventType <String[]>] [-Label <String[]>] + [-EventTtl <Int32>] [-MaxDeliveryAttempt <Int32>] [-DeliverySchema <String>] [-DeadLetterEndpoint <String>] + [-ExpirationDate <DateTime>] [-AdvancedFilter <Hashtable[]>] [-MaxEventsPerBatch <Int32>] + [-PreferredBatchSizeInKiloByte <Int32>] [-AzureActiveDirectoryTenantId <String>] + [-AzureActiveDirectoryApplicationIdOrUri <String>] [-AdvancedFilteringOnArray] + [-DeliveryAttributeMapping <Hashtable[]>] [-StorageQueueMessageTtl <Int64>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DomainEventSubscriptionParameterSet +``` +New-AzEventGridSubscription [-EventSubscriptionName] <String> [-Endpoint] <String> + [-ResourceGroupName] <String> [-DomainName] <String> [-EndpointType <String>] [-SubjectBeginsWith <String>] + [-SubjectEndsWith <String>] [-SubjectCaseSensitive] [-IncludedEventType <String[]>] [-Label <String[]>] + [-EventTtl <Int32>] [-MaxDeliveryAttempt <Int32>] [-DeliverySchema <String>] [-DeadLetterEndpoint <String>] + [-ExpirationDate <DateTime>] [-AdvancedFilter <Hashtable[]>] [-MaxEventsPerBatch <Int32>] + [-PreferredBatchSizeInKiloByte <Int32>] [-AzureActiveDirectoryTenantId <String>] + [-AzureActiveDirectoryApplicationIdOrUri <String>] [-AdvancedFilteringOnArray] + [-DeliveryAttributeMapping <Hashtable[]>] [-StorageQueueMessageTtl <Int64>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DomainTopicEventSubscriptionParameterSet +``` +New-AzEventGridSubscription [-EventSubscriptionName] <String> [-Endpoint] <String> + [-ResourceGroupName] <String> [-DomainName] <String> -DomainTopicName <String> [-EndpointType <String>] + [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] [-SubjectCaseSensitive] + [-IncludedEventType <String[]>] [-Label <String[]>] [-EventTtl <Int32>] [-MaxDeliveryAttempt <Int32>] + [-DeliverySchema <String>] [-DeadLetterEndpoint <String>] [-ExpirationDate <DateTime>] + [-AdvancedFilter <Hashtable[]>] [-MaxEventsPerBatch <Int32>] [-PreferredBatchSizeInKiloByte <Int32>] + [-AzureActiveDirectoryTenantId <String>] [-AzureActiveDirectoryApplicationIdOrUri <String>] + [-AdvancedFilteringOnArray] [-DeliveryAttributeMapping <Hashtable[]>] [-StorageQueueMessageTtl <Int64>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new event subscription to an Azure Event Grid topic, a supported Azure resource, an Azure subscription or Resource Group. +To create an event subscription to the currently selected Azure subscription, specify the event subscription name and the destination endpoint. +To create an event subscription to a resource group, specify the resource group name in addition to the event subscription name and the destination endpoint. +To create an event subscription to an Azure Event Grid topic, specify the topic name as well. +To create an event subscription to a supported Azure resource, specify the full resource ID of the resource. To view the list of supported types, run the Get-AzEventGridTopicType cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +New-AzEventGridSubscription -ResourceGroup MyResourceGroup -TopicName Topic1 -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 +``` + +Creates a new event subscription \`EventSubscription1\` to an Azure Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\` with the webhook destination endpoint `https://requestb.in/19qlscd1`. This event subscription uses default filters. + +### Example 2 +```powershell +New-AzEventGridSubscription -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 +``` + +Creates a new event subscription \`EventSubscription1\` to a resource group \`MyResourceGroupName\` with the webhook destination endpoint `https://requestb.in/19qlscd1`. This event subscription uses default filters. + +### Example 3 +```powershell +New-AzEventGridSubscription -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 +``` + +Creates a new event subscription \`EventSubscription1\` to the currently selected Azure subscription with the webhook destination endpoint `https://requestb.in/19qlscd1`. This event subscription uses default filters. + +### Example 4 +```powershell +$includedEventTypes = "Microsoft.Resources.ResourceWriteFailure", "Microsoft.Resources.ResourceWriteSuccess" +$labels = "Finance", "HR" +New-AzEventGridSubscription -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 -SubjectBeginsWith "TestPrefix" -SubjectEndsWith "TestSuffix" -IncludedEventType $includedEventTypes -Label $labels +``` + +Creates a new event subscription \`EventSubscription1\` to the currently selected Azure subscription with the webhook destination endpoint `https://requestb.in/19qlscd1`. This event subscription specifies the additional filters for event types and subject, and only events matching those filters will be delivered to the destination endpoint. + +### Example 5 +```powershell +New-AzEventGridSubscription -EventSubscriptionName EventSubscription1 -EndpointType "eventhub" -Endpoint "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" +``` + +Creates a new event subscription \`EventSubscription1\` to the currently selected Azure subscription with the specified event hub as the destination for events. This event subscription uses default filters. + +### Example 6 +```powershell +New-AzEventGridSubscription -ResourceId "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace" -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 +``` + +Creates a new event subscription \`EventSubscription1\` to an EventHub namespace with the specified webhook destination endpoint `https://requestb.in/19qlscd1`. This event subscription uses default filters. + +## PARAMETERS + +### -AdvancedFilter +Advanced filter that specifies an array of multiple Hashtable values that are used for the attribute-based filtering. Each Hashtable value has the following keys-value info: Operation, Key and Value or Values. Operator can be one of the following values: NumberIn, NumberNotIn, NumberLessThan, NumberGreaterThan, NumberLessThanOrEquals, NumberGreaterThanOrEquals, BoolEquals, StringIn, StringNotIn, StringBeginsWith, StringEndsWith or StringContains. Key represents the payload property where the advanced filtering policies are applied. Finally, Value or Values represent the value or set of values to be matched. This can be a single value of the corresponding type or an array of values. As an example of the advanced filter parameters: $AdvancedFilters=@($AdvFilter1, $AdvFilter2) where $AdvFilter1=@{operator="NumberIn"; key="Data.Key1"; Values=@(1,2)} and $AdvFilter2=@{operator="StringBringsWith"; key="Subject"; Values=@("SubjectPrefix1","SubjectPrefix2")} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdvancedFilteringOnArray +The presence of this parameter denotes that advanced filtering on arrays is enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureActiveDirectoryApplicationIdOrUri +The Azure Active Directory (AAD) Application Id or Uri to get the access token that will be included as the bearer token in delivery requests.Applicable only for webhook as a destination. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: AliasAadAppIdUri + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: AliasAadAppIdUri + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureActiveDirectoryTenantId +The Azure Active Directory (AAD) Tenant Id to get the access token that will be included as the bearer token in delivery requests.Applicable only for webhook as a destination. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: AliasAadTenantId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: AliasAadTenantId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DeadLetterEndpoint +The endpoint used for storing undelivered events. Specify the Azure resource ID of a Storage blob container. For example: /subscriptions/[SubscriptionId]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Storage/storageAccounts/[StorageAccountName]/blobServices/default/containers/[ContainerName]. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryAttributeMapping +The delivery attribute mappings for this system topic event subscription. +Each delivery attribute mapping should contain following two mandatory fields : Name and Type. +The Type can either be 'Static' or 'Dynamic'. +If the type is 'Static' then properties 'Value' and 'IsSecret' are required. +If the type is 'Dynamic' then property 'SourceField' is required. +An example of the DynamicAttributeMapping parameters: $DeliveryAttributeMapping=@($DeliveryAttributeMapping1, $DeliveryAttributeMapping2) where $DeliveryAttributeMapping1=@{Name="Name1"; Type="Static"; Values="value"; IsSecret="false"} and $DeliveryAttributeMapping2=@{Name="Name2"; Type="Dynamic"; SourceField="data.prop1"} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DeliverySchema +The schema to be used when delivering events to the destination. The possible values are: eventgridschema, CustomInputSchema, or cloudeventv01schema. Default value is CustomInputSchema. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: +Accepted values: EventGridSchema, CustomInputSchema, CloudEventSchemaV1_0 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: +Accepted values: EventGridSchema, CustomInputSchema, CloudEventSchemaV1_0 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DomainInputObject +EventGrid Domain object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSDomain +Parameter Sets: EventSubscriptionDomainInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DomainName +The name of the Event Grid domain to which the event subscription should be created. + +```yaml +Type: System.String +Parameter Sets: DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DomainTopicInputObject +EventGrid Domain Topic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSDomainTopic +Parameter Sets: EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DomainTopicName +The name of the domain topic to which the event subscription should be created. + +```yaml +Type: System.String +Parameter Sets: DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Endpoint +Event subscription destination endpoint. +This can be a webhook URL, or the Azure resource ID of an EventHub, storage queue, hybridconnection or servicebusqueue. For example, the resource ID for a hybrid connection takes the following form: /subscriptions/[Azure Subscription ID]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Relay/namespaces/[NamespaceName]/hybridConnections/[HybridConnectionName]. It is expected that the destination endpoint to be created and available for use before executing any Event Grid cmdlets. + + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet, EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EndpointType +Endpoint Type. +This can be webhook, eventhub, storagequeue, hybridconnection or servicebusqueue. Default value is webhook. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: +Accepted values: webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic, azurefunction + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: +Accepted values: webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic, azurefunction + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EventSubscriptionName +The name of the event subscription + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EventTtl +The time in minutes for the event delivery. This value must be between 1 and 1440 + +```yaml +Type: System.Int32 +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Int32 +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpirationDate +Determines the expiration DateTime for the event subscription after which event subscription will retire. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedEventType +Filter that specifies a list of event types to include.If not specified, all event types will be included. + +```yaml +Type: System.String[] +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String[] +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +EventGrid Topic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Label +Labels for the event subscription + +```yaml +Type: System.String[] +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String[] +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxDeliveryAttempt +The maximum number of attempts to deliver the event. This value must be between 1 and 30 + +```yaml +Type: System.Int32 +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Int32 +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxEventsPerBatch +The maximum number of events in a batch. This value must be between 1 and 5000. This parameter is valid when Endpint Type is webhook only. + +```yaml +Type: System.Int32 +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Int32 +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PreferredBatchSizeInKiloByte +The preferred batch size in kilobytes. This value must be between 1 and 1024. This parameter is valid when Endpint Type is webhook only. + +```yaml +Type: System.Int32 +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Int32 +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the topic. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: ResourceGroup + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: ResourceGroup + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The identifier of the resource to which the event subscription should be created. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageQueueMessageTtl +The time in milliseconds for time to live of a storage queue message + +```yaml +Type: System.Int64 +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Int64 +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectBeginsWith +Filter that specifies that only events matching the specified subject prefix will be included. +If not specified, events with all subject prefixes will be included. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectCaseSensitive +Filter that specifies that the subject field should be compared in a case sensitive manner. +If not specified, subject will be compared in a case insensitive manner. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectEndsWith +Filter that specifies that only events matching the specified subject suffix will be included. +If not specified, events with all subject suffixes will be included. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TopicName +The name of the topic to which the event subscription should be created. + +```yaml +Type: System.String +Parameter Sets: CustomTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSTopic + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomain + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomainTopic + +### System.String[] + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridSystemTopic.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridSystemTopic.md new file mode 100644 index 0000000000..7f733d8b8d --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridSystemTopic.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgridsystemtopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridSystemTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridSystemTopic.md +--- + +# New-AzEventGridSystemTopic + +## SYNOPSIS +Creates a new Azure Event Grid System Topic. + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +New-AzEventGridSystemTopic [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SystemTopicNameParameterSet +``` +New-AzEventGridSystemTopic -ResourceGroupName <String> -Name <String> -Source <String> -TopicType <String> + [-Location <String>] [-IdentityType <String>] [-IdentityId <String[]>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Azure Event Grid System Topic. Once the system topic is created, an azure service application can publish events to the system topic. + +## EXAMPLES + +### Example 1 +```powershell +New-AzEventGridSystemTopic -ResourceGroupName MyResourceGroupName -Name Topic1 -Source ServiceBusNamespaceResourceId -TopicType 'Microsoft.ServiceBus.Namespaces' -Location westus2 +``` + +Creates an Event Grid System topic \`Topic1\` for the Azure ServiceBus namespace with resource id \`ServiceBusNamespaceResourceId\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +New-AzEventGridSystemTopic -ResourceGroupName MyResourceGroupName -Name Topic1 -Source ServiceBusNamespaceResourceId -TopicType 'Microsoft.ServiceBus.Namespaces' -Location westus2 -Tag @{ Department="Finance"; Environment="Test" } +``` + +Creates an Event Grid System topic \`Topic1\` for the Azure ServiceBus namespace with resource id \`ServiceBusNamespaceResourceId\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\` with the specified tags "Department" and "Environment". + +### Example 3 +```powershell +$id1 = '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName' +$id2 = '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName' + +New-AzEventGridSystemTopic -ResourceGroupName MyResourceGroupName -Name Topic1 -Source ServiceBusNamespaceResourceId -TopicType 'Microsoft.ServiceBus.Namespaces' -Location westus2 -IdentityType "UserAssigned" -IdentityId $id1,$id2 +``` + +Creates an Event Grid System topic \`Topic1\` for the Azure ServiceBus namespace with resource id \`ServiceBusNamespaceResourceId\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\` with \`UserAssigned\` identity type with given identity ids. + +### Example 4 +```powershell +New-AzEventGridSystemTopic -ResourceGroupName MyResourceGroupName -Name Topic1 -Source ServiceBusNamespaceResourceId -TopicType 'Microsoft.ServiceBus.Namespaces' -Location westus2 -IdentityType "SystemAssigned" +``` + +Creates an Event Grid System topic \`Topic1\` for the Azure ServiceBus namespace with resource id \`ServiceBusNamespaceResourceId\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\` with \`SystemAssigned\` identity type. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityId +The list of user assigned identities + +```yaml +Type: System.String[] +Parameter Sets: SystemTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityType +Different identity types. +Could be either of following 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' + +```yaml +Type: System.String +Parameter Sets: SystemTopicNameParameterSet +Aliases: +Accepted values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +The location of the topic. + +```yaml +Type: System.String +Parameter Sets: SystemTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +EventGrid topic name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SystemTopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Source +Source for a system topic + +```yaml +Type: System.String +Parameter Sets: SystemTopicNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Hashtable which represents resource Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SystemTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TopicType +EventGrid topic type name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSSystemTopic + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridSystemTopicEventSubscription.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridSystemTopicEventSubscription.md new file mode 100644 index 0000000000..204156de65 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridSystemTopicEventSubscription.md @@ -0,0 +1,512 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgridsystemtopiceventsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridSystemTopicEventSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridSystemTopicEventSubscription.md +--- + +# New-AzEventGridSystemTopicEventSubscription + +## SYNOPSIS +Creates a new Azure Event Grid Event Subscription to a System topic. + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +New-AzEventGridSystemTopicEventSubscription [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SystemTopicEventSuscriptionParameterSet +``` +New-AzEventGridSystemTopicEventSubscription -EventSubscriptionName <String> -ResourceGroupName <String> + -SystemTopicName <String> [-AzureActiveDirectoryApplicationIdOrUri <String>] + [-AzureActiveDirectoryTenantId <String>] [-DeadLetterEndpoint <String>] + [-DeliveryAttributeMapping <Hashtable[]>] [-Endpoint <String>] [-EndpointType <String>] + [-DeliverySchema <String>] [-EventTtl <Int32>] [-ExpirationDate <DateTime>] [-Label <String[]>] + [-MaxDeliveryAttempt <Int32>] [-MaxEventsPerBatch <Int32>] [-PreferredBatchSizeInKiloByte <Int32>] + [-StorageQueueMessageTtl <Int64>] [-AdvancedFilter <Hashtable[]>] [-AdvancedFilteringOnArray] + [-IncludedEventType <String[]>] [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] + [-SubjectCaseSensitive] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new event subscription to an Azure Event Grid System topic. + +## EXAMPLES + +### Example 1 +```powershell +New-AzEventGridSystemTopicEventSubscription -ResourceGroupName MyResourceGroup -SystemTopicName Topic1 -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 +``` + +Creates a new event subscription \`EventSubscription1\` to an Azure Event Grid System topic \`Topic1\` in resource group \`MyResourceGroupName\` with the webhook destination endpoint `https://requestb.in/19qlscd1`. This event subscription uses default filters. + +### Example 2 +```powershell +$includedEventTypes = "Microsoft.Resources.ResourceWriteFailure", "Microsoft.Resources.ResourceWriteSuccess" +$labels = "Finance", "HR" +New-AzEventGridSystemTopicEventSubscription -ResourceGroupName MyResourceGroup -SystemTopicName Topic1 -EventSubscriptionName EventSubscription1 -Endpoint https://requestb.in/19qlscd1 -SubjectBeginsWith "TestPrefix" -SubjectEndsWith "TestSuffix" -IncludedEventType $includedEventTypes -Label $labels +``` + +Creates a new event subscription \`EventSubscription1\` to Sytem Topic \`Topic1\` in resource group \`MyResourceGroup\` with the webhook destination endpoint `https://requestb.in/19qlscd1`. This event subscription specifies the additional filters for event types and subject, and only events matching those filters will be delivered to the destination endpoint. + +### Example 3 +```powershell +New-AzEventGridSystemTopicEventSubscription -ResourceGroupName MyResourceGroup -SystemTopicName Topic1 -EventSubscriptionName EventSubscription1 -EndpointType "eventhub" -Endpoint "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" +``` + +Creates a new event subscription \`EventSubscription1\` to Sytem Topic \`Topic1\` in resource group \`MyResourceGroup\` with the specified event hub as the destination for events. This event subscription uses default filters. + +## PARAMETERS + +### -AdvancedFilter +Advanced filter that specifies an array of multiple Hashtable values that are used for the attribute-based filtering. +Each Hashtable value has the following keys-value info: Operation, Key and Value or Values. +Operator can be one of the following values: NumberIn, NumberNotIn, NumberLessThan, NumberGreaterThan, NumberLessThanOrEquals, NumberGreaterThanOrEquals, BoolEquals, StringIn, StringNotIn, StringBeginsWith, StringEndsWith or StringContains. +Key represents the payload property where the advanced filtering policies are applied. +Finally, Value or Values represent the value or set of values to be matched. +This can be a single value of the corresponding type or an array of values. +As an example of the advanced filter parameters: $AdvancedFilters=@($AdvFilter1, $AdvFilter2) where $AdvFilter1=@{operator="NumberIn"; key="Data.Key1"; Values=@(1,2)} and $AdvFilter2=@{operator="StringBringsWith"; key="Subject"; Values=@("SubjectPrefix1","SubjectPrefix2")} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AdvancedFilteringOnArray +The presence of this parameter denotes that advanced filtering on arrays is enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureActiveDirectoryApplicationIdOrUri +The Azure Active Directory (AAD) Application Id or Uri to get the access token that will be included as the bearer token in delivery requests.Applicable only for webhook as a destination. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureActiveDirectoryTenantId +The Azure Active Directory (AAD) Tenant Id to get the access token that will be included as the bearer token in delivery requests.Applicable only for webhook as a destination. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DeadLetterEndpoint +The endpoint used for storing undelivered events. +Specify the Azure resource ID of a Storage blob container. +For example: /subscriptions/\[SubscriptionId\]/resourceGroups/\[ResourceGroupName\]/providers/Microsoft.Storage/storageAccounts/\[StorageAccountName\]/blobServices/default/containers/\[ContainerName\]. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryAttributeMapping +The delivery attribute mappings for this system topic event subscription. +Each delivery attribute mapping should contain following two mandatory fields : Name and Type. +The Type can either be 'Static' or 'Dynamic'. +If the type is 'Static' then properties 'Value' and 'IsSecret' are required. +If the type is 'Dynamic' then property 'SourceField' is required. +An example of the DynamicAttributeMapping parameters: $DeliveryAttributeMapping=@($DeliveryAttributeMapping1, $DeliveryAttributeMapping2) where $DeliveryAttributeMapping1=@{Name="Name1"; Type="Static"; Values="value"; IsSecret="false"} and $DeliveryAttributeMapping2=@{Name="Name2"; Type="Dynamic"; SourceField="data.prop1"} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DeliverySchema +The schema to be used when delivering events to the destination. +The possible values are: eventgridschema, CustomInputSchema, or cloudeventv01schema. +Default value is CustomInputSchema. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Endpoint +Event subscription destination endpoint. +This can be a webhook URL, or the Azure resource ID of an EventHub, storage queue, hybridconnection, servicebusqueue, servicebustopic or azurefunction. +For example, the resource ID for a hybrid connection takes the following form: /subscriptions/\[Azure Subscription ID\]/resourceGroups/\[ResourceGroupName\]/providers/Microsoft.Relay/namespaces/\[NamespaceName\]/hybridConnections/\[HybridConnectionName\]. +It is expected that the destination endpoint to be created and available for use before executing any Event Grid cmdlets. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EndpointType +Endpoint Type. +This can be webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic or azurefunction. +Default value is webhook. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EventSubscriptionName +EventGrid event subscription name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EventTtl +The time in minutes for the event delivery. +This value must be between 1 and 1440 + +```yaml +Type: System.Int32 +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpirationDate +Determines the expiration DateTime for the event subscription after which event subscription will retire. + +```yaml +Type: System.DateTime +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludedEventType +Filter that specifies a list of event types to include. +If not specified, all event types (for the custom topics and domains) or default event types (for other topic types) will be included. + +```yaml +Type: System.String[] +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Label +Labels for the event subscription. + +```yaml +Type: System.String[] +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxDeliveryAttempt +The maximum number of attempts to deliver the event. +This value must be between 1 and 30. + +```yaml +Type: System.Int32 +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxEventsPerBatch +The maximum number of events in a batch. +This value must be between 1 and 5000. +This parameter is valid when Endpint Type is webhook only. + +```yaml +Type: System.Int32 +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PreferredBatchSizeInKiloByte +The preferred batch size in kilobytes. +This value must be between 1 and 1024. +This parameter is valid when Endpint Type is webhook only. + +```yaml +Type: System.Int32 +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageQueueMessageTtl +The time in milliseconds for time to live of a storage queue message + +```yaml +Type: System.Int64 +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectBeginsWith +Filter that specifies that only events matching the specified subject prefix will be included. +If not specified, events with all subject prefixes will be included. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectCaseSensitive +Filter that specifies that the subject field should be compared in a case sensitive manner. +If not specified, subject will be compared in a case insensitive manner. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectEndsWith +Filter that specifies that only events matching the specified subject suffix will be included. +If not specified, events with all subject suffixes will be included. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SystemTopicName +EventGrid topic name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Int32 + +### System.DateTime + +### System.Int64 + +### System.Collections.Hashtable[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridTopic.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridTopic.md new file mode 100644 index 0000000000..2819c14f48 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridTopic.md @@ -0,0 +1,291 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgridtopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridTopic.md +--- + +# New-AzEventGridTopic + +## SYNOPSIS +Creates a new Azure Event Grid Topic. + +## SYNTAX + +``` +New-AzEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> [-Tag <Hashtable>] + [-InputSchema <String>] [-InputMappingField <Hashtable>] [-InputMappingDefaultValue <Hashtable>] + [-InboundIpRule <Hashtable>] [-IdentityType <String>] [-IdentityId <String[]>] [-PublicNetworkAccess <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Azure Event Grid Topic. Once the topic is created, an application can publish events to the topic endpoint. + +## EXAMPLES + +### Example 1 +```powershell +New-AzEventGridTopic -ResourceGroupName MyResourceGroupName -Name Topic1 -Location westus2 +``` + +Creates an Event Grid topic \`Topic1\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +New-AzEventGridTopic -ResourceGroupName MyResourceGroupName -Name Topic1 -Location westus2 -Tag @{ Department="Finance"; Environment="Test" } +``` + +Creates an Event Grid topic \`Topic1\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\` with the specified tags "Department" and "Environment". + +### Example 3 +```powershell +New-AzEventGridTopic -ResourceGroupName MyResourceGroupName -Name Topic1 -Location westus2 -IdentityType "SystemAssigned" +``` + +Creates an Event Grid topic \`Topic1\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\` with \`SystemAssigned\` identity type. + +### Example 4 +```powershell +$id1 = '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName' +$id2 = '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName' + +New-AzEventGridTopic -ResourceGroupName MyResourceGroupName -Name Topic1 -Location westus2 -IdentityType "UserAssigned" -IdentityId $id1,$id2 +``` + +Creates an Event Grid topic \`Topic1\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\` with \`UserAssigned\` identity type with given identity ids. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityId +The list of user assigned identities + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityType +Different identity types. Could be either of following 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InboundIpRule +Hashtable which represents list of inbound IP rules. Each rule specifies the IP Address in CIDR notation e.g., 10.0.0.0/8 along with the corresponding Action to be performed based on the match or no match of the IpMask. Possible Action values include Allow only + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputMappingDefaultValue +Hashtable which represents the input mapping fields with default value in space separated key = value format. Allowed key names are: subject, eventtype, and dataversion. This is used when InputSchemaHelp is customeventschema only. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputMappingField +Hashtable which represents the input mapping fields in space separated key = value format. Allowed key names are: id, topic, eventtime, subject, eventtype, and dataversion. This is used when InputSchemaHelp is customeventschema only. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputSchema +The schema of the input events for the topic. Allowed values are: eventgridschema, customeventschema, or cloudeventv01Schema. Default value is eventgridschema. Note that if customeventschema is specified, then InputMappingField or/and InputMappingDefaultValue parameters need to be specified as well. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: EventGridSchema, CustomEventSchema, CloudEventSchemaV1_0 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +The location of the topic + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the topic. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TopicName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring InboundIpRule parameters. Allowed values are disabled and enabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: enabled, disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group in which the topic should be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Hashtables which represents resource Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSTopic + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/New-AzEventGridTopicKey.md b/azps-10.1.0/Az.EventGrid/New-AzEventGridTopicKey.md new file mode 100644 index 0000000000..2696c72f3b --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/New-AzEventGridTopicKey.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/new-azeventgridtopickey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridTopicKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/New-AzEventGridTopicKey.md +--- + +# New-AzEventGridTopicKey + +## SYNOPSIS +Regenerates the shared access key for an Azure Event Grid Topic. + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +New-AzEventGridTopicKey [-ResourceGroupName] <String> [-TopicName] <String> [-KeyName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### TopicInputObjectParameterSet +``` +New-AzEventGridTopicKey [-KeyName] <String> [-InputObject] <PSTopic> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +New-AzEventGridTopicKey [-KeyName] <String> [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerates the shared access key for an Azure Event Grid Topic. + +## EXAMPLES + +### Example 1 +```powershell +New-AzEventGridTopicKey -ResourceGroup MyResourceGroupName -TopicName Topic1 -KeyName key1 +``` + +Regenerate the key corresponding to key \'key1'\ of Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +Get-AzEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 | New-AzEventGridTopicKey -KeyName "key1" +``` + +Regenerate the key corresponding to key \'key1'\ of Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +EventGrid Topic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic +Parameter Sets: TopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +The name of the key that needs to be regenerated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: TopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Identifier representing the Event Grid Topic. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TopicName +The name of the topic. + +```yaml +Type: System.String +Parameter Sets: TopicNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSTopic + +## OUTPUTS + +### Microsoft.Azure.Management.EventGrid.Models.TopicSharedAccessKeys + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Remove-AzEventGridChannel.md b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridChannel.md new file mode 100644 index 0000000000..5b6736b0df --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridChannel.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/remove-azeventgridchannel +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridChannel.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridChannel.md +--- + +# Remove-AzEventGridChannel + +## SYNOPSIS +Removes an Azure Event Grid Channel. + +## SYNTAX + +### ChannelNameParameterSet (Default) +``` +Remove-AzEventGridChannel [-ResourceGroupName] <String> [-PartnerNamespaceName] <String> [-Name] <String> + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ChannelInputObjectParameterSet +``` +Remove-AzEventGridChannel [-InputObject] <PSChannel> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure Event Grid Channel. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzEventGridChannel -ResourceGroupName MyResourceGroupName -Name Channel1 +``` + +Removes the Event Grid Channel \`Channel1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. +By default, this cmdlet prompts you to confirm that you want to delete the resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Channel object + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSChannel +Parameter Sets: ChannelInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the Event Grid channel. + +```yaml +Type: System.String +Parameter Sets: ChannelNameParameterSet +Aliases: ChannelName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerNamespaceName +Event Grid partner namespace name. + +```yaml +Type: System.String +Parameter Sets: ChannelNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ChannelNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSChannel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Remove-AzEventGridDomain.md b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridDomain.md new file mode 100644 index 0000000000..bd64087bde --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridDomain.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/remove-azeventgriddomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridDomain.md +--- + +# Remove-AzEventGridDomain + +## SYNOPSIS +Removes an Azure Event Grid Domain. + +## SYNTAX + +### DomainNameParameterSet (Default) +``` +Remove-AzEventGridDomain [-ResourceGroupName] <String> [-Name] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +Remove-AzEventGridDomain [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DomainInputObjectParameterSet +``` +Remove-AzEventGridDomain [-InputObject] <PSDomain> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure Event Grid Domain. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzEventGridDomain -ResourceGroupName MyResourceGroupName -Name Domain1 +``` + +Removes the Event Grid Domain \`Domain1\` in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +Get-AzResource -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/Domains/Domain1" | Remove-AzEventGridDomain +``` + +Removes the Event Grid Domain \`Domain1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +EventGrid Domain object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSDomain +Parameter Sets: DomainInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +EventGrid domain name. + +```yaml +Type: System.String +Parameter Sets: DomainNameParameterSet +Aliases: DomainName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DomainNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Identifier representing the Event Grid Domain. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomain + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Remove-AzEventGridDomainTopic.md b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridDomainTopic.md new file mode 100644 index 0000000000..a5ab5a96e7 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridDomainTopic.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/remove-azeventgriddomaintopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridDomainTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridDomainTopic.md +--- + +# Remove-AzEventGridDomainTopic + +## SYNOPSIS +Removes an Azure Event Grid Domain Topic. + +## SYNTAX + +### DomainTopicNameParameterSet (Default) +``` +Remove-AzEventGridDomainTopic [-ResourceGroupName] <String> [-DomainName] <String> [-Name] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdDomainTopicParameterSet +``` +Remove-AzEventGridDomainTopic [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DomainTopicInputObjectParameterSet +``` +Remove-AzEventGridDomainTopic [-InputObject] <PSDomainTopic> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure Event Grid Domain Topic. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzEventGridDomainTopic -ResourceGroupName MyResourceGroupName -DomainName Domain1 -Name Topic1 +``` + +Removes the Event Grid Domain Topic \`Topic1\` under Domain \`Domain1\` in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +Get-AzResource -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1/topics/Topic1" | Remove-AzEventGridDomainTopic +``` + +Removes the Event Grid Domain Topic \`Topic1\` under Domain \`Domain1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +EventGrid domain name. + +```yaml +Type: System.String +Parameter Sets: DomainTopicNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +EventGrid Domain Topic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSDomainTopic +Parameter Sets: DomainTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +EventGrid domain topic name. + +```yaml +Type: System.String +Parameter Sets: DomainTopicNameParameterSet +Aliases: DomainTopicName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DomainTopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Identifier representing the Event Grid Domain Topic. + +```yaml +Type: System.String +Parameter Sets: ResourceIdDomainTopicParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomainTopic + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerConfiguration.md b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerConfiguration.md new file mode 100644 index 0000000000..ae2b8ba84b --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerConfiguration.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/remove-azeventgridpartnerconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridPartnerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridPartnerConfiguration.md +--- + +# Remove-AzEventGridPartnerConfiguration + +## SYNOPSIS +Removes an Azure Event Grid Partner Configuration. + +## SYNTAX + +### ResourceGroupNameParameterSet (Default) +``` +Remove-AzEventGridPartnerConfiguration [-ResourceGroupName] <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PartnerConfigurationInputObjectParameterSet +``` +Remove-AzEventGridPartnerConfiguration [-InputObject] <PSPartnerConfiguration> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure Event Grid Partner Configuration. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzEventGridPartnerConfiguration -ResourceGroupName MyResourceGroupName +``` + +Removes the Event Grid partner configuration in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. +By default, this cmdlet prompts you to confirm that you want to delete the resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PartnerConfiguration object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfiguration +Parameter Sets: PartnerConfigurationInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfiguration + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerNamespace.md b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerNamespace.md new file mode 100644 index 0000000000..5cbe3cc6b0 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerNamespace.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/remove-azeventgridpartnernamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridPartnerNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridPartnerNamespace.md +--- + +# Remove-AzEventGridPartnerNamespace + +## SYNOPSIS +Removes an Azure Event Grid Partner Namespace. + +## SYNTAX + +### PartnerNamespaceNameParameterSet (Default) +``` +Remove-AzEventGridPartnerNamespace [-ResourceGroupName] <String> [-Name] <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PartnerNamespaceInputObjectParameterSet +``` +Remove-AzEventGridPartnerNamespace [-InputObject] <PSPartnerNamespace> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure Event Grid Partner Namespace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzEventGridPartnerNamespace -ResourceGroupName MyResourceGroupName -Name PartnerNamespace1 +``` + +Removes the Event Grid partner namespace \`PartnerNamespace1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. +By default, this cmdlet prompts you to confirm that you want to delete the resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PartnerNamespace object + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSPartnerNamespace +Parameter Sets: PartnerNamespaceInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Event Grid partner namespace name. + +```yaml +Type: System.String +Parameter Sets: PartnerNamespaceNameParameterSet +Aliases: PartnerNamespaceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PartnerNamespaceNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerNamespace + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerRegistration.md b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerRegistration.md new file mode 100644 index 0000000000..7c3c0ba30e --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerRegistration.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/remove-azeventgridpartnerregistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridPartnerRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridPartnerRegistration.md +--- + +# Remove-AzEventGridPartnerRegistration + +## SYNOPSIS +Removes an Azure Event Grid Partner Registration. + +## SYNTAX + +### PartnerRegistrationNameParameterSet (Default) +``` +Remove-AzEventGridPartnerRegistration [-ResourceGroupName] <String> [-Name] <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PartnerRegistrationInputObjectParameterSet +``` +Remove-AzEventGridPartnerRegistration [-InputObject] <PSPartnerRegistration> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure Event Grid Partner Registration. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzEventGridPartnerRegistration -ResourceGroupName MyResourceGroupName -Name PartnerRegistration1 +``` + +Removes the Event Grid partner registration \`PartnerRegistration1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. +By default, this cmdlet prompts you to confirm that you want to delete the resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PartnerRegistration object + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSPartnerRegistration +Parameter Sets: PartnerRegistrationInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Event Grid partner registration name. + +```yaml +Type: System.String +Parameter Sets: PartnerRegistrationNameParameterSet +Aliases: PartnerRegistrationName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PartnerRegistrationNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerRegistration + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerTopic.md b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerTopic.md new file mode 100644 index 0000000000..d179a7c19c --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerTopic.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/remove-azeventgridpartnertopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridPartnerTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridPartnerTopic.md +--- + +# Remove-AzEventGridPartnerTopic + +## SYNOPSIS +Removes an Azure Event Grid Partner Topic. + +## SYNTAX + +### PartnerTopicNameParameterSet (Default) +``` +Remove-AzEventGridPartnerTopic [-ResourceGroupName] <String> [-Name] <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PartnerTopicInputObjectParameterSet +``` +Remove-AzEventGridPartnerTopic [-InputObject] <PSPartnerTopic> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure Event Grid Partner Topic. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzEventGridPartnerTopic -ResourceGroupName MyResourceGroupName -Name PartnerTopic1 +``` + +Removes the Event Grid Partner Topic \`PartnerTopic1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. +By default, this cmdlet prompts you to confirm that you want to delete the resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PartnerTopic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSPartnerTopic +Parameter Sets: PartnerTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Event Grid partner topic name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: PartnerTopicName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerTopic + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerTopicEventSubscription.md b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerTopicEventSubscription.md new file mode 100644 index 0000000000..26ce223f17 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridPartnerTopicEventSubscription.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/remove-azeventgridpartnertopiceventsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridPartnerTopicEventSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridPartnerTopicEventSubscription.md +--- + +# Remove-AzEventGridPartnerTopicEventSubscription + +## SYNOPSIS +Removes an Azure Event Grid partner topic event subscription. + +## SYNTAX + +### PartnerTopicNameParameterSet (Default) +``` +Remove-AzEventGridPartnerTopicEventSubscription [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PartnerTopicEventSubscriptionParameterSet +``` +Remove-AzEventGridPartnerTopicEventSubscription -Name <String> -ResourceGroupName <String> + -PartnerTopicName <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceIdPartnerTopicEventSubscriptionParameterSet +``` +Remove-AzEventGridPartnerTopicEventSubscription [-ResourceId] <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure Event Grid event subscription for an Azure Event Grid partner topic. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzEventGridPartnerTopicEventSubscription -ResourceGroup MyResourceGroup -PartnerTopicName Topic1 -EventSubscriptionName EventSubscription1 +``` + +Removes the event subscription \`EventSubscription1\` to an Azure Event Grid partner topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. +By default, this cmdlet prompts you to confirm that you want to delete the resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +EventGrid event subscription name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet +Aliases: EventSubscriptionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerTopicName +Event Grid partner topic name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Identifier representing the Event Grid Event Subscription. + +```yaml +Type: System.String +Parameter Sets: ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Remove-AzEventGridSubscription.md b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridSubscription.md new file mode 100644 index 0000000000..b27c625eb6 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridSubscription.md @@ -0,0 +1,354 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/remove-azeventgridsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridSubscription.md +--- + +# Remove-AzEventGridSubscription + +## SYNOPSIS +Removes an Azure Event Grid event subscription. + +## SYNTAX + +### ResourceGroupNameParameterSet (Default) +``` +Remove-AzEventGridSubscription [-EventSubscriptionName] <String> [[-ResourceGroupName] <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +Remove-AzEventGridSubscription [-ResourceId] <String> [-EventSubscriptionName] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EventSubscriptionCustomTopicInputObjectParameterSet +``` +Remove-AzEventGridSubscription [-InputObject] <PSTopic> [-EventSubscriptionName] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EventSubscriptionDomainInputObjectParameterSet +``` +Remove-AzEventGridSubscription [-DomainInputObject] <PSDomain> [-EventSubscriptionName] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EventSubscriptionDomainTopicInputObjectParameterSet +``` +Remove-AzEventGridSubscription [-DomainTopicInputObject] <PSDomainTopic> [-EventSubscriptionName] <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### TopicNameParameterSet +``` +Remove-AzEventGridSubscription [-EventSubscriptionName] <String> [-ResourceGroupName] <String> + [-TopicName] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DomainNameParameterSet +``` +Remove-AzEventGridSubscription [-EventSubscriptionName] <String> [-ResourceGroupName] <String> + [-DomainName] <String> [-DomainTopicName <String>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DomainEventSubscriptionParameterSet +``` +Remove-AzEventGridSubscription [-EventSubscriptionName] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DomainTopicEventSubscriptionParameterSet +``` +Remove-AzEventGridSubscription [-EventSubscriptionName] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure Event Grid event subscription for an Azure Event Grid topic, a resource, an Azure subscription or resource group. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzEventGridSubscription -ResourceGroup MyResourceGroup -TopicName Topic1 -EventSubscriptionName EventSubscription1 +``` + +Removes the event subscription \`EventSubscription1\` to an Azure Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +Remove-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -EventSubscriptionName EventSubscription1 +``` + +Removes the event subscription \`EventSubscription1\` to a resource group \`MyResourceGroupName\`. + +### Example 3 +```powershell +Remove-AzEventGridSubscription -EventSubscriptionName EventSubscription1 +``` + +Removes the event subscription \`EventSubscription1\` to the default Azure subscription. + +### Example 4 +```powershell +Get-AzResource -ResourceId "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.EventHub/namespaces/$namespaceName" | Remove-AzEventGridSubscription -EventSubscriptionName EventSubscription1 +``` + +Removes the event subscription \`EventSubscription1\` to an Event Hub namespace. + +### Example 5 +```powershell +Get-AzEventGridTopic -ResourceGroup MyResourceGroup -TopicName Topic1 | Remove-AzEventGridSubscription -EventSubscriptionName EventSubscription1 +``` + +Removes the event subscription \`EventSubscription1\` to an Event Grid Topic. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainInputObject +EventGrid Domain object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSDomain +Parameter Sets: EventSubscriptionDomainInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DomainName +EventGrid domain name. + +```yaml +Type: System.String +Parameter Sets: DomainNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DomainTopicInputObject +EventGrid Domain Topic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSDomainTopic +Parameter Sets: EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DomainTopicName +EventGrid domain topic name. + +```yaml +Type: System.String +Parameter Sets: DomainNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EventSubscriptionName +Name of the event subscription that needs to be removed. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, TopicNameParameterSet, DomainNameParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet, EventSubscriptionDomainInputObjectParameterSet, EventSubscriptionDomainTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +EventGrid Topic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns the status of the Remove operation. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: ResourceGroup + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: TopicNameParameterSet, DomainNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Identifier of the resource whose event subscription needs to be removed. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TopicName +Event Grid Topic Name. + +```yaml +Type: System.String +Parameter Sets: TopicNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSTopic + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomain + +### Microsoft.Azure.Commands.EventGrid.Models.PSDomainTopic + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Remove-AzEventGridSystemTopic.md b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridSystemTopic.md new file mode 100644 index 0000000000..5d04588768 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridSystemTopic.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/remove-azeventgridsystemtopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridSystemTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridSystemTopic.md +--- + +# Remove-AzEventGridSystemTopic + +## SYNOPSIS +Removes an Azure Event Grid System Topic. + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +Remove-AzEventGridSystemTopic [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SystemTopicNameParameterSet +``` +Remove-AzEventGridSystemTopic -ResourceGroupName <String> -Name <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +Remove-AzEventGridSystemTopic -ResourceId <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### TopicInputObjectParameterSet +``` +Remove-AzEventGridSystemTopic -InputObject <PSSystemTopic> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure Event Grid System Topic either by using name of system topic or by piping system topic object. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzEventGridSystemTopic -ResourceGroupName MyResourceGroupName -Name Topic1 +``` + +Removes the Event Grid System topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +Get-AzResource -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/systemTopics/Topic1" | Remove-AzEventGridSystemTopic +``` + +Removes the Event Grid System topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. By default, this cmdlet prompts you to confirm that you want to delete the resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +EventGrid Topic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSSystemTopic +Parameter Sets: TopicInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +EventGrid topic name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicNameParameterSet +Aliases: SystemTopicName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns the status of the Remove operation. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SystemTopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +EventGrid System Topic ResourceID. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSSystemTopic + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Remove-AzEventGridSystemTopicEventSubscription.md b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridSystemTopicEventSubscription.md new file mode 100644 index 0000000000..d6d89092fe --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridSystemTopicEventSubscription.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/remove-azeventgridsystemtopiceventsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridSystemTopicEventSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridSystemTopicEventSubscription.md +--- + +# Remove-AzEventGridSystemTopicEventSubscription + +## SYNOPSIS +Removes an Azure Event Grid system topic event subscription. + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +Remove-AzEventGridSystemTopicEventSubscription [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SystemTopicEventSuscriptionParameterSet +``` +Remove-AzEventGridSystemTopicEventSubscription -EventSubscriptionName <String> -ResourceGroupName <String> + -SystemTopicName <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure Event Grid event subscription for an Azure Event Grid system topic. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzEventGridSystemTopicEventSubscription -ResourceGroup MyResourceGroup -SystemTopicName Topic1 -EventSubscriptionName EventSubscription1 +``` + +Removes the event subscription \`EventSubscription1\` to an Azure Event Grid system topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSubscriptionName +EventGrid event subscription name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. +By default, this cmdlet prompts you to confirm that you want to delete the resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns the status of the Remove operation. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SystemTopicName +EventGrid topic name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Remove-AzEventGridTopic.md b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridTopic.md new file mode 100644 index 0000000000..0fa36c1705 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Remove-AzEventGridTopic.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/remove-azeventgridtopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Remove-AzEventGridTopic.md +--- + +# Remove-AzEventGridTopic + +## SYNOPSIS +Removes an Azure Event Grid Topic. + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +Remove-AzEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +Remove-AzEventGridTopic [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### TopicInputObjectParameterSet +``` +Remove-AzEventGridTopic [-InputObject] <PSTopic> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure Event Grid Topic. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzEventGridTopic -ResourceGroupName MyResourceGroupName -Name Topic1 +``` + +Removes the Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +### Example 2 +```powershell +Get-AzResource -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/topics/Topic1" | Remove-AzEventGridTopic +``` + +Removes the Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +EventGrid Topic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic +Parameter Sets: TopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +EventGrid Topic Name. + +```yaml +Type: System.String +Parameter Sets: TopicNameParameterSet +Aliases: TopicName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns the status of the Remove operation. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: TopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +EventGrid Topic ResourceID. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSTopic + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Revoke-AzEventGridPartnerConfiguration.md b/azps-10.1.0/Az.EventGrid/Revoke-AzEventGridPartnerConfiguration.md new file mode 100644 index 0000000000..76266879e4 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Revoke-AzEventGridPartnerConfiguration.md @@ -0,0 +1,188 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/revoke-azeventgridpartnerconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Revoke-AzEventGridPartnerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Revoke-AzEventGridPartnerConfiguration.md +--- + +# Revoke-AzEventGridPartnerConfiguration + +## SYNOPSIS +Revokes access to a partner in a partner configuration. + +## SYNTAX + +### ResourceGroupNameParameterSet (Default) +``` +Revoke-AzEventGridPartnerConfiguration [-ResourceGroupName] <String> [-PartnerRegistrationImmutableId <Guid>] + [-PartnerName <String>] [-AuthorizationExpirationTime <DateTime>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PartnerConfigurationInputObjectParameterSet +``` +Revoke-AzEventGridPartnerConfiguration [-InputObject] <PSPartnerConfiguration> + [-PartnerRegistrationImmutableId <Guid>] [-PartnerName <String>] [-AuthorizationExpirationTime <DateTime>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Revoke-AzEventGridPartnerConfiguration revokes access to a partner in a partner configuration using either the partner registration immutable ID or the partner name. At least one of these two parameters is required. + +## EXAMPLES + +### Example 1 +```powershell +Revoke-AzEventGridPartnerConfiguration -ResourceGroupName MyResourceGroupName -PartnerName Contoso.Finance +``` + +Revokes access for partner name \`Contoso.Finance\` for the partner configuration in resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -AuthorizationExpirationTime +Expiration time of the partner authorization. +If this timer expires, any request from this partner to create, update or delete resources in subscriber's context will fail. +If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. +If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PartnerConfiguration object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfiguration +Parameter Sets: PartnerConfigurationInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerName +Parter name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerRegistrationImmutableId +Immutable id of the corresponding partner registration + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfiguration + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Set-AzEventGridTopic.md b/azps-10.1.0/Az.EventGrid/Set-AzEventGridTopic.md new file mode 100644 index 0000000000..03a20007a8 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Set-AzEventGridTopic.md @@ -0,0 +1,289 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/set-azeventgridtopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Set-AzEventGridTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Set-AzEventGridTopic.md +--- + +# Set-AzEventGridTopic + +## SYNOPSIS +Sets the properties of an Event Grid topic. + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +Set-AzEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [-Tag] <Hashtable> + [-InboundIpRule] <Hashtable> [-IdentityType <String>] [-IdentityId <String[]>] [-PublicNetworkAccess] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +Set-AzEventGridTopic [-ResourceId] <String> [-Tag] <Hashtable> [-InboundIpRule] <Hashtable> + [-IdentityType <String>] [-IdentityId <String[]>] [-PublicNetworkAccess] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### TopicInputObjectParameterSet +``` +Set-AzEventGridTopic [-InputObject] <PSTopic> [[-Tag] <Hashtable>] [[-InboundIpRule] <Hashtable>] + [-IdentityType <String>] [-IdentityId <String[]>] [[-PublicNetworkAccess] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets the properties of an Event Grid topic. This can be used to replace the tags of an Event Grid topic. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 -Tag @{ Department="Finance"; Environment="Test" } +``` + +Sets the properties of the Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\` to replace the tags with the specified tags "Department" and "Environment". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityId +The list of user assigned identities + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityType +Different identity types. Could be either of following 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InboundIpRule +Hashtable which represents list of inbound IP rules. Each rule specifies the IP Address in CIDR notation e.g., 10.0.0.0/8 along with the corresponding Action to be performed based on the match or no match of the IpMask. Possible Action values include Allow only + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: TopicNameParameterSet, ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: TopicInputObjectParameterSet +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +EventGrid Topic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic +Parameter Sets: TopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +EventGrid Topic Name. + +```yaml +Type: System.String +Parameter Sets: TopicNameParameterSet +Aliases: TopicName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring InboundIpRule parameters. Allowed values are disabled and enabled. + +```yaml +Type: System.String +Parameter Sets: TopicNameParameterSet, ResourceIdEventSubscriptionParameterSet +Aliases: +Accepted values: enabled, disabled + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: TopicInputObjectParameterSet +Aliases: +Accepted values: enabled, disabled + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: TopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +EventGrid Topic ResourceID. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Hashtables which represents resource Tag. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: TopicNameParameterSet, ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: TopicInputObjectParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSTopic + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSTopic + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Update-AzEventGridChannel.md b/azps-10.1.0/Az.EventGrid/Update-AzEventGridChannel.md new file mode 100644 index 0000000000..98e48d1597 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Update-AzEventGridChannel.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/update-azeventgridchannel +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridChannel.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridChannel.md +--- + +# Update-AzEventGridChannel + +## SYNOPSIS +Updates the properties of an Event Grid channel. + +## SYNTAX + +### ChannelNameParameterSet (Default) +``` +Update-AzEventGridChannel [-ResourceGroupName] <String> [-PartnerNamespaceName] <String> [-Name] <String> + [-EventTypeKind <String>] [-InlineEvent <Hashtable>] [-ExpirationTimeIfNotActivatedUtc <DateTime>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ChannelInputObjectParameterSet +``` +Update-AzEventGridChannel [-InputObject] <PSChannel> [-EventTypeKind <String>] [-InlineEvent <Hashtable>] + [-ExpirationTimeIfNotActivatedUtc <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the properties of an Event Grid channel. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzEventGridChannel -ResourceGroupName MyResourceGroupName -PartnerNamespaceName PartnerNamespace1 -Name Channel1 -ExpirationTimeIfNotActivatedUtc (Get-Date).AddDays(8) +``` + +Updates the Event Grid channel so partner topics will expire 8 days from the current time if not activated. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventTypeKind +The kind of event type used. +Possible values include: 'Inline' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpirationTimeIfNotActivatedUtc +Expiration time of the partner topic. +If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InlineEvent +Hashtable representing information on inline events. +The inline event keys are of type string which represents the name of the event.The inline event values are Hashtables containing the optional keys description, displayName, documentationUrl, and dataSchemaUrl which define the information about the inline event. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: +Accepted values: Inline + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Channel object + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSChannel +Parameter Sets: ChannelInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the Event Grid channel. + +```yaml +Type: System.String +Parameter Sets: ChannelNameParameterSet +Aliases: ChannelName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerNamespaceName +Event Grid partner namespace name. + +```yaml +Type: System.String +Parameter Sets: ChannelNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ChannelNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSChannel + +### System.Collections.Hashtable + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSChannel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Update-AzEventGridPartnerConfiguration.md b/azps-10.1.0/Az.EventGrid/Update-AzEventGridPartnerConfiguration.md new file mode 100644 index 0000000000..b001a2c501 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Update-AzEventGridPartnerConfiguration.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/update-azeventgridpartnerconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridPartnerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridPartnerConfiguration.md +--- + +# Update-AzEventGridPartnerConfiguration + +## SYNOPSIS +Updates the details of an Event Grid partner configuration. + +## SYNTAX + +### ResourceGroupNameParameterSet (Default) +``` +Update-AzEventGridPartnerConfiguration [-ResourceGroupName] <String> [-Tag <Hashtable>] + [-MaxExpirationTimeInDays <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### PartnerConfigurationInputObjectParameterSet +``` +Update-AzEventGridPartnerConfiguration [-InputObject] <PSPartnerConfiguration> [-Tag <Hashtable>] + [-MaxExpirationTimeInDays <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the details of an Event Grid partner configuration. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzEventGridPartnerConfiguration -ResourceGroupName MyResourceGroupName -MaxExpirationTimeInDays 8 +``` + +Updates the maximum expiration time in days property of the partner configuration in the resource group \`MyResourceGroupName\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PartnerConfiguration object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfiguration +Parameter Sets: PartnerConfigurationInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxExpirationTimeInDays +Expiration time in days used to validate the authorization expiration time for each authorized partner. +If this parameter is not specified, the default is 7 days. +Otherwise, allowed values are between 1 and 365 days. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Hashtable which represents resource Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfiguration + +### System.Collections.Hashtable + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Update-AzEventGridPartnerTopic.md b/azps-10.1.0/Az.EventGrid/Update-AzEventGridPartnerTopic.md new file mode 100644 index 0000000000..9d48276c80 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Update-AzEventGridPartnerTopic.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/update-azeventgridpartnertopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridPartnerTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridPartnerTopic.md +--- + +# Update-AzEventGridPartnerTopic + +## SYNOPSIS +Updates the properties of an Event Grid partner topic. + +## SYNTAX + +### PartnerTopicNameParameterSet (Default) +``` +Update-AzEventGridPartnerTopic [-ResourceGroupName] <String> [-Name] <String> [-Tag <Hashtable>] + [-IdentityType <String>] [-IdentityId <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### PartnerTopicInputObjectParameterSet +``` +Update-AzEventGridPartnerTopic [-InputObject] <PSPartnerTopic> [-Tag <Hashtable>] [-IdentityType <String>] + [-IdentityId <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the properties of an Event Grid partner topic. Can be used to update the identity and tags of a partner topic. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzEventGridPartnerTopic -ResourceGroup MyResourceGroupName -Name Topic1 -Tag @{ Department="Finance"; Environment="Test" } +``` + +Sets the properties of the Event Grid Partner topic \`Topic1\` in resource group \`MyResourceGroupName\` to replace the tags with the specified tags "Department" and "Environment". + +### Example 2 +```powershell +Update-AzEventGridPartnerTopic -ResourceGroup MyResourceGroupName -Name Topic1 -IdentityType "SystemAssigned" +``` + +Sets the properties of the Event Grid Partner topic \`Topic1\` in resource group \`MyResourceGroupName\` to change identity type to \`SystemAssigned\`. + +### Example 3 +```powershell +$id1 = '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName' +$id2 = '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName' + +Update-AzEventGridPartnerTopic -ResourceGroup MyResourceGroupName -Name Topic1 -IdentityType "UserAssigned" -IdentityId $id1,$id2 +``` + +Sets the properties of the Event Grid Partner topic \`Topic1\` in resource group \`MyResourceGroupName\` to change identity type to \`UserAssigned\` with given identity ids. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityId +The list of user assigned identities + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityType +Different identity types. +Could be either of following 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +PartnerTopic object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSPartnerTopic +Parameter Sets: PartnerTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Event Grid partner topic name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: PartnerTopicName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Hashtable which represents resource Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerTopic + +### System.Collections.Hashtable + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSPartnerTopic + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Update-AzEventGridPartnerTopicEventSubscription.md b/azps-10.1.0/Az.EventGrid/Update-AzEventGridPartnerTopicEventSubscription.md new file mode 100644 index 0000000000..dea35ba437 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Update-AzEventGridPartnerTopicEventSubscription.md @@ -0,0 +1,400 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/update-azeventgridpartnertopiceventsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridPartnerTopicEventSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridPartnerTopicEventSubscription.md +--- + +# Update-AzEventGridPartnerTopicEventSubscription + +## SYNOPSIS +Update the properties of an Event Grid System partner event subscription. + +## SYNTAX + +### PartnerTopicNameParameterSet (Default) +``` +Update-AzEventGridPartnerTopicEventSubscription [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### PartnerTopicEventSubscriptionParameterSet +``` +Update-AzEventGridPartnerTopicEventSubscription -Name <String> -ResourceGroupName <String> + -PartnerTopicName <String> [-DeadLetterEndpoint <String>] [-DeliveryAttributeMapping <Hashtable[]>] + [-Endpoint <String>] [-EndpointType <String>] [-Label <String[]>] [-StorageQueueMessageTtl <Int64>] + [-AdvancedFilter <Hashtable[]>] [-AdvancedFilteringOnArray] [-IncludedEventType <String[]>] + [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] [-SubjectCaseSensitive] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdPartnerTopicEventSubscriptionParameterSet +``` +Update-AzEventGridPartnerTopicEventSubscription [-ResourceId] <String> [-DeadLetterEndpoint <String>] + [-DeliveryAttributeMapping <Hashtable[]>] [-Endpoint <String>] [-EndpointType <String>] [-Label <String[]>] + [-StorageQueueMessageTtl <Int64>] [-AdvancedFilter <Hashtable[]>] [-AdvancedFilteringOnArray] + [-IncludedEventType <String[]>] [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] + [-SubjectCaseSensitive] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update the properties of an Event Grid partner topic event subscription. This can be used to update the filter, destination, or labels of an existing event subscription. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzEventGridPartnerTopicEventSubscription -EventSubscriptionName ES1 -PartnerTopicName Topic1 -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/1kxxoui1 +``` + +Updates the endpoint of the event subscription \`ES1\` for system topic \`Topic1\` in resource group \`MyResourceGroupName\` to \`https://requestb.in/1kxxoui1\` + +### Example 2 +```powershell +$labels = "Finance", "HR" +Update-AzEventGridPartnerTopicEventSubscription -EventSubscriptionName ES1 -PartnerTopicName Topic1 -ResourceGroup MyResourceGroupName -Label $labels +``` + +Updates the properties of the event subscription \`ES1\` for system topic \`Topic1\` in \`MyResourceGroupName\` with the new labels $labels. + +### Example 3 +```powershell +Update-AzEventGridPartnerTopicEventSubscription -EventSubscriptionName ES1 -PartnerTopicName Topic1 -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/1kxxoui1 -SubjectEndsWith "jpg" +``` + +Updates the properties of the event subscription \`ES1\` for system topic \`Topic1\` in \`MyResourceGroupName\` with new endpoint \`https://requestb.in/1kxxoui1\` and the new SubjectEndsWith filter as \`jpg\` + +## PARAMETERS + +### -AdvancedFilter +Advanced filter that specifies an array of multiple Hashtable values that are used for the attribute-based filtering. +Each Hashtable value has the following keys-value info: Operation, Key and Value or Values. +Operator can be one of the following values: NumberIn, NumberNotIn, NumberLessThan, NumberGreaterThan, NumberLessThanOrEquals, NumberGreaterThanOrEquals, BoolEquals, StringIn, StringNotIn, StringBeginsWith, StringEndsWith or StringContains. +Key represents the payload property where the advanced filtering policies are applied. +Finally, Value or Values represent the value or set of values to be matched. +This can be a single value of the corresponding type or an array of values. +As an example of the advanced filter parameters: $AdvancedFilters=@($AdvFilter1, $AdvFilter2) where $AdvFilter1=@{operator="NumberIn"; key="Data.Key1"; Values=@(1,2)} and $AdvFilter2=@{operator="StringBringsWith"; key="Subject"; Values=@("SubjectPrefix1","SubjectPrefix2")} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: PartnerTopicEventSubscriptionParameterSet, ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AdvancedFilteringOnArray +The presence of this parameter denotes that advanced filtering on arrays is enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PartnerTopicEventSubscriptionParameterSet, ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DeadLetterEndpoint +The endpoint used for storing undelivered events. +Specify the Azure resource ID of a Storage blob container. +For example: /subscriptions/\[SubscriptionId\]/resourceGroups/\[ResourceGroupName\]/providers/Microsoft.Storage/storageAccounts/\[StorageAccountName\]/blobServices/default/containers/\[ContainerName\]. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet, ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryAttributeMapping +The delivery attribute mappings for this system topic event subscription. +Each delivery attribute mapping should contain following two mandatory fields : Name and Type. +The Type can either be 'Static' or 'Dynamic'. +If the type is 'Static' then properties 'Value' and 'IsSecret' are required. +If the type is 'Dynamic' then property 'SourceField' is required. +An example of the DynamicAttributeMapping parameters: $DeliveryAttributeMapping=@($DeliveryAttributeMapping1, $DeliveryAttributeMapping2) where $DeliveryAttributeMapping1=@{Name="Name1"; Type="Static"; Values="value"; IsSecret="false"} and $DeliveryAttributeMapping2=@{Name="Name2"; Type="Dynamic"; SourceField="data.prop1"} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: PartnerTopicEventSubscriptionParameterSet, ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Endpoint +Event subscription destination endpoint. +This can be a webhook URL, or the Azure resource ID of an EventHub, storage queue, hybridconnection, servicebusqueue, servicebustopic or azurefunction. +For example, the resource ID for a hybrid connection takes the following form: /subscriptions/\[Azure Subscription ID\]/resourceGroups/\[ResourceGroupName\]/providers/Microsoft.Relay/namespaces/\[NamespaceName\]/hybridConnections/\[HybridConnectionName\]. +It is expected that the destination endpoint to be created and available for use before executing any Event Grid cmdlets. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet, ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EndpointType +Endpoint Type. +This can be webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic or azurefunction. +Default value is webhook. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet, ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludedEventType +Filter that specifies a list of event types to include. +If not specified, all event types (for the custom topics and domains) or default event types (for other topic types) will be included. + +```yaml +Type: System.String[] +Parameter Sets: PartnerTopicEventSubscriptionParameterSet, ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Label +Labels for the event subscription. + +```yaml +Type: System.String[] +Parameter Sets: PartnerTopicEventSubscriptionParameterSet, ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +EventGrid event subscription name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet +Aliases: EventSubscriptionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerTopicName +Event Grid partner topic name. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Identifier representing the Event Grid Event Subscription. + +```yaml +Type: System.String +Parameter Sets: ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageQueueMessageTtl +The time in milliseconds for time to live of a storage queue message + +```yaml +Type: System.Int64 +Parameter Sets: PartnerTopicEventSubscriptionParameterSet, ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectBeginsWith +Filter that specifies that only events matching the specified subject prefix will be included. +If not specified, events with all subject prefixes will be included. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet, ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectCaseSensitive +Filter that specifies that the subject field should be compared in a case sensitive manner. +If not specified, subject will be compared in a case insensitive manner. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PartnerTopicEventSubscriptionParameterSet, ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectEndsWith +Filter that specifies that only events matching the specified subject suffix will be included. +If not specified, events with all subject suffixes will be included. + +```yaml +Type: System.String +Parameter Sets: PartnerTopicEventSubscriptionParameterSet, ResourceIdPartnerTopicEventSubscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Int64 + +### System.Collections.Hashtable[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Update-AzEventGridSubscription.md b/azps-10.1.0/Az.EventGrid/Update-AzEventGridSubscription.md new file mode 100644 index 0000000000..c060a54fb0 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Update-AzEventGridSubscription.md @@ -0,0 +1,552 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/update-azeventgridsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridSubscription.md +--- + +# Update-AzEventGridSubscription + +## SYNOPSIS +Update the properties of an Event Grid event subscription. + +## SYNTAX + +### ResourceGroupNameParameterSet (Default) +``` +Update-AzEventGridSubscription [-EventSubscriptionName] <String> [[-ResourceGroupName] <String>] + [-EndpointType <String>] [-Endpoint <String>] [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] + [-IncludedEventType <String[]>] [-Label <String[]>] [-ExpirationDate <DateTime>] + [-AdvancedFilter <Hashtable[]>] [-DeliveryAttributeMapping <Hashtable[]>] [-EventTtl <Int32>] + [-MaxDeliveryAttempt <Int32>] [-DeadLetterEndpoint <String>] [-MaxEventsPerBatch <Int32>] + [-PreferredBatchSizeInKiloByte <Int32>] [-AzureActiveDirectoryApplicationIdOrUri <String>] + [-AzureActiveDirectoryTenantId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdEventSubscriptionParameterSet +``` +Update-AzEventGridSubscription [-ResourceId] <String> [-EventSubscriptionName] <String> + [-EndpointType <String>] [-Endpoint <String>] [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] + [-IncludedEventType <String[]>] [-Label <String[]>] [-ExpirationDate <DateTime>] + [-AdvancedFilter <Hashtable[]>] [-DeliveryAttributeMapping <Hashtable[]>] [-EventTtl <Int32>] + [-MaxDeliveryAttempt <Int32>] [-DeadLetterEndpoint <String>] [-MaxEventsPerBatch <Int32>] + [-PreferredBatchSizeInKiloByte <Int32>] [-AzureActiveDirectoryApplicationIdOrUri <String>] + [-AzureActiveDirectoryTenantId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### EventSubscriptionCustomTopicInputObjectParameterSet +``` +Update-AzEventGridSubscription [-InputObject] <PSEventSubscription> [-EndpointType <String>] + [-Endpoint <String>] [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] [-IncludedEventType <String[]>] + [-Label <String[]>] [-ExpirationDate <DateTime>] [-AdvancedFilter <Hashtable[]>] + [-DeliveryAttributeMapping <Hashtable[]>] [-EventTtl <Int32>] [-MaxDeliveryAttempt <Int32>] + [-DeadLetterEndpoint <String>] [-MaxEventsPerBatch <Int32>] [-PreferredBatchSizeInKiloByte <Int32>] + [-AzureActiveDirectoryApplicationIdOrUri <String>] [-AzureActiveDirectoryTenantId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CustomTopicEventSubscriptionParameterSet +``` +Update-AzEventGridSubscription [-EventSubscriptionName] <String> [-ResourceGroupName] <String> + [-TopicName] <String> [-EndpointType <String>] [-Endpoint <String>] [-SubjectBeginsWith <String>] + [-SubjectEndsWith <String>] [-IncludedEventType <String[]>] [-Label <String[]>] [-ExpirationDate <DateTime>] + [-AdvancedFilter <Hashtable[]>] [-DeliveryAttributeMapping <Hashtable[]>] [-EventTtl <Int32>] + [-MaxDeliveryAttempt <Int32>] [-DeadLetterEndpoint <String>] [-MaxEventsPerBatch <Int32>] + [-PreferredBatchSizeInKiloByte <Int32>] [-AzureActiveDirectoryApplicationIdOrUri <String>] + [-AzureActiveDirectoryTenantId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DomainEventSubscriptionParameterSet +``` +Update-AzEventGridSubscription [-EventSubscriptionName] <String> [-ResourceGroupName] <String> + [-DomainName] <String> [-EndpointType <String>] [-Endpoint <String>] [-SubjectBeginsWith <String>] + [-SubjectEndsWith <String>] [-IncludedEventType <String[]>] [-Label <String[]>] [-ExpirationDate <DateTime>] + [-AdvancedFilter <Hashtable[]>] [-DeliveryAttributeMapping <Hashtable[]>] [-EventTtl <Int32>] + [-MaxDeliveryAttempt <Int32>] [-DeadLetterEndpoint <String>] [-MaxEventsPerBatch <Int32>] + [-PreferredBatchSizeInKiloByte <Int32>] [-AzureActiveDirectoryApplicationIdOrUri <String>] + [-AzureActiveDirectoryTenantId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DomainTopicEventSubscriptionParameterSet +``` +Update-AzEventGridSubscription [-EventSubscriptionName] <String> [-ResourceGroupName] <String> + [-DomainName] <String> [-DomainTopicName] <String> [-EndpointType <String>] [-Endpoint <String>] + [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] [-IncludedEventType <String[]>] [-Label <String[]>] + [-ExpirationDate <DateTime>] [-AdvancedFilter <Hashtable[]>] [-DeliveryAttributeMapping <Hashtable[]>] + [-EventTtl <Int32>] [-MaxDeliveryAttempt <Int32>] [-DeadLetterEndpoint <String>] [-MaxEventsPerBatch <Int32>] + [-PreferredBatchSizeInKiloByte <Int32>] [-AzureActiveDirectoryApplicationIdOrUri <String>] + [-AzureActiveDirectoryTenantId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Update the properties of an Event Grid event subscription. This can be used to update the filter, destination, or labels of an existing event subscription. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzEventGridSubscription -EventSubscriptionName ES1 -TopicName Topic1 -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/1kxxoui1 +``` + +Updates the endpoint of the event subscription \`ES1\` for topic \`Topic1\` in resource group \`MyResourceGroupName\` to \`https://requestb.in/1kxxoui1\` + +### Example 2 +```powershell +Get-AzEventGridSubscription -EventSubscriptionName ES1 -TopicName Topic1 -ResourceGroup MyResourceGroupName | Update-AzEventGridSubscription -Endpoint https://requestb.in/1kxxoui1 +``` + +Updates the endpoint of the event subscription \`ES1\` for topic \`Topic1\` in resource group \`MyResourceGroupName\` to \`https://requestb.in/1kxxoui1\` + +### Example 3 +```powershell +Update-AzEventGridSubscription -EventSubscriptionName ES1 -ResourceId "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace" -Endpoint https://requestb.in/1kxxoui1 -SubjectEndsWith "jpg" +``` + +Updates the properties of the event subscription \`ES1\` for the EventHub namespace ContosoNamespace with the new endpoint as \`https://requestb.in/1kxxoui1\` and the new SubjectEndsWith filter as \`jpg\` + +### Example 4 +```powershell +$labels = "Finance", "HR" +Update-AzEventGridSubscription -EventSubscriptionName ES1 -ResourceGroup MyResourceGroupName -Label $labels +``` + +Updates the properties of the event subscription \`ES1\` for the resource group \`MyResourceGroupName\` with the new labels $labels. + +## PARAMETERS + +### -AdvancedFilter +Advanced filter that specifies an array of multiple Hashtable values that are used for the attribute-based filtering. Each Hashtable value has the following keys-value info: Operation, Key and Value or Values. Operator can be one of the following values: NumberIn, NumberNotIn, NumberLessThan, NumberGreaterThan, NumberLessThanOrEquals, NumberGreaterThanOrEquals, BoolEquals, StringIn, StringNotIn, StringBeginsWith, StringEndsWith or StringContains. Key represents the payload property where the advanced filtering policies are applied. Finally, Value or Values represent the value or set of values to be matched. This can be a single value of the corresponding type or an array of values. As an example of the advanced filter parameters: $AdvancedFilters=@($AdvFilter1, $AdvFilter2) where $AdvFilter1=@{operator="NumberIn"; key="Data.Key1"; Values=@(1,2)} and $AdvFilter2=@{operator="StringBeginsWith"; key="Subject"; Values=@("SubjectPrefix1","SubjectPrefix2")} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureActiveDirectoryApplicationIdOrUri +The Azure Active Directory (AAD) Application Id or Uri to get the access token that will be included as the bearer token in delivery requests.Applicable only for webhook as a destination. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AliasAadAppIdUri + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureActiveDirectoryTenantId +The Azure Active Directory (AAD) Tenant Id to get the access token that will be included as the bearer token in delivery requests.Applicable only for webhook as a destination. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AliasAadTenantId + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeadLetterEndpoint +The endpoint used for storing undelivered events. Specify the Azure resource ID of a Storage blob container. For example: /subscriptions/[SubscriptionId]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Storage/storageAccounts/[StorageAccountName]/blobServices/default/containers/[ContainerName]. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryAttributeMapping +The delivery attribute mappings for this system topic event subscription. +Each delivery attribute mapping should contain following two mandatory fields : Name and Type. +The Type can either be 'Static' or 'Dynamic'. +If the type is 'Static' then properties 'Value' and 'IsSecret' are required. +If the type is 'Dynamic' then property 'SourceField' is required. +An example of the DynamicAttributeMapping parameters: $DeliveryAttributeMapping=@($DeliveryAttributeMapping1, $DeliveryAttributeMapping2) where $DeliveryAttributeMapping1=@{Name="Name1"; Type="Static"; Values="value"; IsSecret="false"} and $DeliveryAttributeMapping2=@{Name="Name2"; Type="Dynamic"; SourceField="data.prop1"} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +The name of the domain to which the event subscription should be created. + +```yaml +Type: System.String +Parameter Sets: DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DomainTopicName +The name of the domain topic to which the event subscription should be created. + +```yaml +Type: System.String +Parameter Sets: DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Endpoint +Event subscription destination endpoint. +This can be a webhook URL, or the Azure resource ID of an EventHub, storage queue, hybridconnection or servicebusqueue. For example, the resource ID for a hybrid connection takes the following form: /subscriptions/[Azure Subscription ID]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Relay/namespaces/[NamespaceName]/hybridConnections/[HybridConnectionName]. It is expected that the destination endpoint to be created and available for use before executing any Event Grid cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointType +Endpoint Type. +This can be webhook, eventhub, storagequeue, hybridconnection or servicebusqueue. Default value is webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic, azurefunction + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSubscriptionName +The name of the event subscription + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EventTtl +The time in minutes for the event delivery. This value must be between 1 and 1440 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDate +Determines the expiration DateTime for the event subscription after which event subscription will retire. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedEventType +Filter that specifies a list of event types to include.If not specified, all event types will be included. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +EventGridSubscription object. + +```yaml +Type: Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription +Parameter Sets: EventSubscriptionCustomTopicInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Label +Labels for the event subscription + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxDeliveryAttempt +The maximum number of attempts to deliver the event. This value must be between 1 and 30 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxEventsPerBatch +The maximum number of events in a batch. This value must be between 1 and 5000. This parameter is valid when Endpint Type is webhook only. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredBatchSizeInKiloByte +The preferred batch size in kilobytes. This value must be between 1 and 1024. This parameter is valid when Endpint Type is webhook only. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the topic. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupNameParameterSet +Aliases: ResourceGroup + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: CustomTopicEventSubscriptionParameterSet, DomainEventSubscriptionParameterSet, DomainTopicEventSubscriptionParameterSet +Aliases: ResourceGroup + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The identifier of the resource to which the event subscription was created. + +```yaml +Type: System.String +Parameter Sets: ResourceIdEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectBeginsWith +Filter that specifies that only events matching the specified subject prefix will be included. +If not specified, events with all subject prefixes will be included. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectEndsWith +Filter that specifies that only events matching the specified subject suffix will be included. +If not specified, events with all subject suffixes will be included. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The name of the topic to which the event subscription should be created. + +```yaml +Type: System.String +Parameter Sets: CustomTopicEventSubscriptionParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Update-AzEventGridSystemTopic.md b/azps-10.1.0/Az.EventGrid/Update-AzEventGridSystemTopic.md new file mode 100644 index 0000000000..7e86207c88 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Update-AzEventGridSystemTopic.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/update-azeventgridsystemtopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridSystemTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridSystemTopic.md +--- + +# Update-AzEventGridSystemTopic + +## SYNOPSIS +Updates the properties of an Event Grid System topic. + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +Update-AzEventGridSystemTopic [-IdentityId <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SystemTopicNameParameterSet +``` +Update-AzEventGridSystemTopic -ResourceGroupName <String> -Name <String> [-IdentityType <String>] + [-IdentityId <String[]>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the properties of an Event Grid System topic. Can be used to update the identity and tags of a system topic + +## EXAMPLES + +### Example 1 +```powershell +Update-AzEventGridSystemTopic -ResourceGroup MyResourceGroupName -Name Topic1 -Tag @{ Department="Finance"; Environment="Test" } +``` + +Sets the properties of the Event Grid System topic \`Topic1\` in resource group \`MyResourceGroupName\` to replace the tags with the specified tags "Department" and "Environment". + +### Example 2 +```powershell +Update-AzEventGridSystemTopic -ResourceGroup MyResourceGroupName -Name Topic1 -IdentityType "SystemAssigned" +``` + +Sets the properties of the Event Grid System topic \`Topic1\` in resource group \`MyResourceGroupName\` to change identity type to \`SystemAssigned\`. + +### Example 3 +```powershell +$id1 = '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName' +$id2 = '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName' + +Update-AzEventGridSystemTopic -ResourceGroup MyResourceGroupName -Name Topic1 -IdentityType "UserAssigned" -IdentityId $id1,$id2 +``` + +Sets the properties of the Event Grid System topic \`Topic1\` in resource group \`MyResourceGroupName\` to change identity type to \`UserAssigned\` with given identity ids. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityId +List of user assigned Identity Ids + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityType +Hashtable which represents resource Tags. + +```yaml +Type: System.String +Parameter Sets: SystemTopicNameParameterSet +Aliases: +Accepted values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +EventGrid topic name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicNameParameterSet +Aliases: SystemTopicName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SystemTopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Hashtable which represents resource Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SystemTopicNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSSystemTopic + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventGrid/Update-AzEventGridSystemTopicEventSubscription.md b/azps-10.1.0/Az.EventGrid/Update-AzEventGridSystemTopicEventSubscription.md new file mode 100644 index 0000000000..0e31fdca09 --- /dev/null +++ b/azps-10.1.0/Az.EventGrid/Update-AzEventGridSystemTopicEventSubscription.md @@ -0,0 +1,376 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml +Module Name: Az.EventGrid +online version: https://learn.microsoft.com/powershell/module/az.eventgrid/update-azeventgridsystemtopiceventsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridSystemTopicEventSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventGrid/EventGrid/help/Update-AzEventGridSystemTopicEventSubscription.md +--- + +# Update-AzEventGridSystemTopicEventSubscription + +## SYNOPSIS +Update the properties of an Event Grid System topic event subscription. + +## SYNTAX + +### TopicNameParameterSet (Default) +``` +Update-AzEventGridSystemTopicEventSubscription [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SystemTopicEventSuscriptionParameterSet +``` +Update-AzEventGridSystemTopicEventSubscription -EventSubscriptionName <String> -ResourceGroupName <String> + -SystemTopicName <String> [-DeadLetterEndpoint <String>] [-DeliveryAttributeMapping <Hashtable[]>] + [-Endpoint <String>] [-EndpointType <String>] [-Label <String[]>] [-StorageQueueMessageTtl <Int64>] + [-AdvancedFilter <Hashtable[]>] [-AdvancedFilteringOnArray] [-IncludedEventType <String[]>] + [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] [-SubjectCaseSensitive] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update the properties of an Event Grid System topic event subscription. This can be used to update the filter, destination, or labels of an existing event subscription. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzEventGridSystemTopicEventSubscription -EventSubscriptionName ES1 -SystemTopicName Topic1 -ResourceGroupName MyResourceGroupName -Endpoint https://requestb.in/1kxxoui1 +``` + +Updates the endpoint of the event subscription \`ES1\` for system topic \`Topic1\` in resource group \`MyResourceGroupName\` to \`https://requestb.in/1kxxoui1\` + +### Example 2 +```powershell +$labels = "Finance", "HR" +Update-AzEventGridSystemTopicEventSubscription -EventSubscriptionName ES1 -SystemTopicName Topic1 -ResourceGroupName MyResourceGroupName -Label $labels +``` + +Updates the properties of the event subscription \`ES1\` for system topic \`Topic1\` in \`MyResourceGroupName\` with the new labels $labels. + +### Example 3 +```powershell +Update-AzEventGridSystemTopicEventSubscription -EventSubscriptionName ES1 -SystemTopicName Topic1 -ResourceGroupName MyResourceGroupName -Endpoint https://requestb.in/1kxxoui1 -SubjectEndsWith "jpg" +``` + +Updates the properties of the event subscription \`ES1\` for system topic \`Topic1\` in \`MyResourceGroupName\` with new endpoint \`https://requestb.in/1kxxoui1\` and the new SubjectEndsWith filter as \`jpg\` + +## PARAMETERS + +### -AdvancedFilter +Advanced filter that specifies an array of multiple Hashtable values that are used for the attribute-based filtering. +Each Hashtable value has the following keys-value info: Operation, Key and Value or Values. +Operator can be one of the following values: NumberIn, NumberNotIn, NumberLessThan, NumberGreaterThan, NumberLessThanOrEquals, NumberGreaterThanOrEquals, BoolEquals, StringIn, StringNotIn, StringBeginsWith, StringEndsWith or StringContains. +Key represents the payload property where the advanced filtering policies are applied. +Finally, Value or Values represent the value or set of values to be matched. +This can be a single value of the corresponding type or an array of values. +As an example of the advanced filter parameters: $AdvancedFilters=@($AdvFilter1, $AdvFilter2) where $AdvFilter1=@{operator="NumberIn"; key="Data.Key1"; Values=@(1,2)} and $AdvFilter2=@{operator="StringBringsWith"; key="Subject"; Values=@("SubjectPrefix1","SubjectPrefix2")} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AdvancedFilteringOnArray +The presence of this parameter denotes that advanced filtering on arrays is enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DeadLetterEndpoint +The endpoint used for storing undelivered events. +Specify the Azure resource ID of a Storage blob container. +For example: /subscriptions/\[SubscriptionId\]/resourceGroups/\[ResourceGroupName\]/providers/Microsoft.Storage/storageAccounts/\[StorageAccountName\]/blobServices/default/containers/\[ContainerName\]. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryAttributeMapping +The delivery attribute mappings for this system topic event subscription. +Each delivery attribute mapping should contain following two mandatory fields : Name and Type. +The Type can either be 'Static' or 'Dynamic'. +If the type is 'Static' then properties 'Value' and 'IsSecret' are required. +If the type is 'Dynamic' then property 'SourceField' is required. +An example of the DynamicAttributeMapping parameters: $DeliveryAttributeMapping=@($DeliveryAttributeMapping1, $DeliveryAttributeMapping2) where $DeliveryAttributeMapping1=@{Name="Name1"; Type="Static"; Values="value"; IsSecret="false"} and $DeliveryAttributeMapping2=@{Name="Name2"; Type="Dynamic"; SourceField="data.prop1"} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Endpoint +Event subscription destination endpoint. +This can be a webhook URL, or the Azure resource ID of an EventHub, storage queue, hybridconnection, servicebusqueue, servicebustopic or azurefunction. +For example, the resource ID for a hybrid connection takes the following form: /subscriptions/\[Azure Subscription ID\]/resourceGroups/\[ResourceGroupName\]/providers/Microsoft.Relay/namespaces/\[NamespaceName\]/hybridConnections/\[HybridConnectionName\]. +It is expected that the destination endpoint to be created and available for use before executing any Event Grid cmdlets. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EndpointType +Endpoint Type. +This can be webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic or azurefunction. +Default value is webhook. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EventSubscriptionName +EventGrid event subscription name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludedEventType +Filter that specifies a list of event types to include. +If not specified, all event types (for the custom topics and domains) or default event types (for other topic types) will be included. + +```yaml +Type: System.String[] +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Label +Labels for the event subscription. + +```yaml +Type: System.String[] +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageQueueMessageTtl +The time in milliseconds for time to live of a storage queue message + +```yaml +Type: System.Int64 +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectBeginsWith +Filter that specifies that only events matching the specified subject prefix will be included. +If not specified, events with all subject prefixes will be included. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectCaseSensitive +Filter that specifies that the subject field should be compared in a case sensitive manner. +If not specified, subject will be compared in a case insensitive manner. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectEndsWith +Filter that specifies that only events matching the specified subject suffix will be included. +If not specified, events with all subject suffixes will be included. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SystemTopicName +EventGrid topic name. + +```yaml +Type: System.String +Parameter Sets: SystemTopicEventSuscriptionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Int64 + +### System.Collections.Hashtable[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Approve-AzEventHubPrivateEndpointConnection.md b/azps-10.1.0/Az.EventHub/Approve-AzEventHubPrivateEndpointConnection.md new file mode 100644 index 0000000000..19ceaf42de --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Approve-AzEventHubPrivateEndpointConnection.md @@ -0,0 +1,246 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/approve-azeventhubprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Approve-AzEventHubPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Approve-AzEventHubPrivateEndpointConnection.md +--- + +# Approve-AzEventHubPrivateEndpointConnection + +## SYNOPSIS +Approves an EventHub PrivateEndpointConnection + +## SYNTAX + +### SetExpanded (Default) +``` +Approve-AzEventHubPrivateEndpointConnection -NamespaceName <String> -ResourceGroupName <String> + [-Name <String>] [-SubscriptionId <String>] [-Description <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Approve-AzEventHubPrivateEndpointConnection -InputObject <IEventHubIdentity> [-Description <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +## DESCRIPTION +Approves an EventHub PrivateEndpointConnection + +## EXAMPLES + +### Example 1: Approve an Event Hub Namespace Private Endpoint Connection +```powershell +Approve-AzEventHubPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name 00000000000 +``` + +```output +ConnectionState : Approved +Description : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/privateEndpointConnections/00000000000 +Location : Australia East +Name : 00000000000 +PrivateEndpointId : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/privateEndpointName +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +``` + +Approves private endpoint connection `00000000000` on EventHub namespace `myNamespace`. + +### Example 2: Approve an Event Hub Namespace Private Endpoint Connection using InputObject +```powershell +$privateEndpoint = Get-AzEventHubPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name 00000000000 +Approve-AzEventHubPrivateEndpointConnection -InputObject $privateEndpoint +``` + +```output +ConnectionState : Approved +Description : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/privateEndpointConnections/00000000000 +Location : Australia East +Name : 00000000000 +PrivateEndpointId : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/privateEndpointName +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +``` + +Approves private endpoint connection `00000000000` on EventHub namespace `myNamespace` using InputObject parameter set. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +PrivateEndpoint information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Private Endpoint Connection + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IPrivateEndpointConnection + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IEventHubIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Az.EventHub.md b/azps-10.1.0/Az.EventHub/Az.EventHub.md new file mode 100644 index 0000000000..ce8a9c5a57 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Az.EventHub.md @@ -0,0 +1,165 @@ +--- +Module Name: Az.EventHub +Module Guid: 5728d353-7ad5-42d8-b00a-46aaecf07b91 +Download Help Link: https://learn.microsoft.com/powershell/module/az.eventhub +Help Version: 4.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Az.EventHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Az.EventHub.md +--- + +# Az.EventHub Module +## Description +This topic displays help for the Azure Event Hub PowerShell resource manager cmdlets. + +## Az.EventHub Cmdlets +### [Approve-AzEventHubPrivateEndpointConnection](Approve-AzEventHubPrivateEndpointConnection.md) +Approves an EventHub PrivateEndpointConnection + +### [Deny-AzEventHubPrivateEndpointConnection](Deny-AzEventHubPrivateEndpointConnection.md) +Denies an EventHub PrivateEndpointConnection + +### [Get-AzEventHub](Get-AzEventHub.md) +Gets an Event Hubs description for the specified Event Hub. + +### [Get-AzEventHubApplicationGroup](Get-AzEventHubApplicationGroup.md) +Gets an ApplicationGroup for a Namespace. + +### [Get-AzEventHubAuthorizationRule](Get-AzEventHubAuthorizationRule.md) +Gets an EventHub Authorization Rule + +### [Get-AzEventHubCluster](Get-AzEventHubCluster.md) +Gets the resource description of the specified Event Hubs Cluster. + +### [Get-AzEventHubClusterNamespace](Get-AzEventHubClusterNamespace.md) +List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster. + +### [Get-AzEventHubClustersAvailableRegion](Get-AzEventHubClustersAvailableRegion.md) +List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region. + +### [Get-AzEventHubConsumerGroup](Get-AzEventHubConsumerGroup.md) +Gets a description for the specified consumer group. + +### [Get-AzEventHubGeoDRConfiguration](Get-AzEventHubGeoDRConfiguration.md) +Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace + +### [Get-AzEventHubKey](Get-AzEventHubKey.md) +Gets an EventHub SAS key + +### [Get-AzEventHubNamespace](Get-AzEventHubNamespace.md) +Gets the description of the specified namespace. + +### [Get-AzEventHubNetworkRuleSet](Get-AzEventHubNetworkRuleSet.md) +Gets NetworkRuleSet for a Namespace. + +### [Get-AzEventHubPrivateEndpointConnection](Get-AzEventHubPrivateEndpointConnection.md) +Gets a description for the specified Private Endpoint Connection name. + +### [Get-AzEventHubPrivateLink](Get-AzEventHubPrivateLink.md) +Gets lists of resources that supports Privatelinks. + +### [Get-AzEventHubSchemaGroup](Get-AzEventHubSchemaGroup.md) +Gets the details of an EventHub schema group. + +### [New-AzEventHub](New-AzEventHub.md) +Creates or updates a new Event Hub as a nested resource within a Namespace. + +### [New-AzEventHubApplicationGroup](New-AzEventHubApplicationGroup.md) +Creates or updates an ApplicationGroup for a Namespace. + +### [New-AzEventHubAuthorizationRule](New-AzEventHubAuthorizationRule.md) +Creates an EventHub Authorization Rule + +### [New-AzEventHubAuthorizationRuleSASToken](New-AzEventHubAuthorizationRuleSASToken.md) +Generates a SAS token for Azure eventhub authorization rule of namespace/eventhub. + +### [New-AzEventHubCluster](New-AzEventHubCluster.md) +Creates or updates an instance of an Event Hubs Cluster. + +### [New-AzEventHubConsumerGroup](New-AzEventHubConsumerGroup.md) +Creates or updates an Event Hubs consumer group as a nested resource within a Namespace. + +### [New-AzEventHubGeoDRConfiguration](New-AzEventHubGeoDRConfiguration.md) +Creates or updates a new Alias(Disaster Recovery configuration) + +### [New-AzEventHubIPRuleConfig](New-AzEventHubIPRuleConfig.md) +Constructs an INwRuleSetIPRules object that can be fed as input to Set-AzEventHubNetworkRuleSet + +### [New-AzEventHubKey](New-AzEventHubKey.md) +Regenerates an EventHub SAS key + +### [New-AzEventHubKeyVaultPropertiesObject](New-AzEventHubKeyVaultPropertiesObject.md) +Create an in-memory object for KeyVaultProperties. + +### [New-AzEventHubNamespace](New-AzEventHubNamespace.md) +Creates an EventHub Namespace + +### [New-AzEventHubSchemaGroup](New-AzEventHubSchemaGroup.md) +Creates or Updates an EventHub schema group. + +### [New-AzEventHubThrottlingPolicyConfig](New-AzEventHubThrottlingPolicyConfig.md) +Constructs an IThrottlingPolicy object that can be fed as input to New-AzEventHubApplicationGroup or Set-AzEventHubApplicationGroup + +### [New-AzEventHubVirtualNetworkRuleConfig](New-AzEventHubVirtualNetworkRuleConfig.md) +Constructs an INwRuleSetVirtualNetworkRules object that can be fed as input to Set-AzEventHubNetworkRuleSet + +### [Remove-AzEventHub](Remove-AzEventHub.md) +Deletes an Event Hub from the specified Namespace and resource group. + +### [Remove-AzEventHubApplicationGroup](Remove-AzEventHubApplicationGroup.md) +Deletes an ApplicationGroup for a Namespace. + +### [Remove-AzEventHubAuthorizationRule](Remove-AzEventHubAuthorizationRule.md) +Removes an EventHub Authorization Rule + +### [Remove-AzEventHubCluster](Remove-AzEventHubCluster.md) +Deletes an existing Event Hubs Cluster. +This operation is idempotent. + +### [Remove-AzEventHubConsumerGroup](Remove-AzEventHubConsumerGroup.md) +Deletes a consumer group from the specified Event Hub and resource group. + +### [Remove-AzEventHubGeoDRConfiguration](Remove-AzEventHubGeoDRConfiguration.md) +Deletes an Alias(Disaster Recovery configuration) + +### [Remove-AzEventHubNamespace](Remove-AzEventHubNamespace.md) +Deletes an existing namespace. +This operation also removes all associated resources under the namespace. + +### [Remove-AzEventHubPrivateEndpointConnection](Remove-AzEventHubPrivateEndpointConnection.md) +Deletes an existing namespace. +This operation also removes all associated resources under the namespace. + +### [Remove-AzEventHubSchemaGroup](Remove-AzEventHubSchemaGroup.md) +Deletes an EventHub schema group. + +### [Set-AzEventHub](Set-AzEventHub.md) +Updates an EventHub Entity + +### [Set-AzEventHubApplicationGroup](Set-AzEventHubApplicationGroup.md) +Sets an EventHub Application Group + +### [Set-AzEventHubAuthorizationRule](Set-AzEventHubAuthorizationRule.md) +Sets an EventHub Authorization Rule + +### [Set-AzEventHubCluster](Set-AzEventHubCluster.md) +Sets an EventHub Cluster + +### [Set-AzEventHubConsumerGroup](Set-AzEventHubConsumerGroup.md) +Sets an EventHub Consumer Group + +### [Set-AzEventHubGeoDRConfigurationBreakPair](Set-AzEventHubGeoDRConfigurationBreakPair.md) +This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces + +### [Set-AzEventHubGeoDRConfigurationFailOver](Set-AzEventHubGeoDRConfigurationFailOver.md) +Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace + +### [Set-AzEventHubNamespace](Set-AzEventHubNamespace.md) +Updates an EventHub Namespace + +### [Set-AzEventHubNetworkRuleSet](Set-AzEventHubNetworkRuleSet.md) +Sets an EventHub Namespace Network Rule Set + +### [Test-AzEventHubName](Test-AzEventHubName.md) +Checks availability of a namespace name or disaster recovery alias. + diff --git a/azps-10.1.0/Az.EventHub/Deny-AzEventHubPrivateEndpointConnection.md b/azps-10.1.0/Az.EventHub/Deny-AzEventHubPrivateEndpointConnection.md new file mode 100644 index 0000000000..8bd97475c5 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Deny-AzEventHubPrivateEndpointConnection.md @@ -0,0 +1,248 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/deny-azeventhubprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Deny-AzEventHubPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Deny-AzEventHubPrivateEndpointConnection.md +--- + +# Deny-AzEventHubPrivateEndpointConnection + +## SYNOPSIS +Denies an EventHub PrivateEndpointConnection + +## SYNTAX + +### SetExpanded (Default) +``` +Deny-AzEventHubPrivateEndpointConnection -NamespaceName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String>] [-Description <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Deny-AzEventHubPrivateEndpointConnection -InputObject <IEventHubIdentity> [-Description <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +## DESCRIPTION +Denies an EventHub PrivateEndpointConnection + +## EXAMPLES + +### Example 1: Reject an Event Hub Namespace Private Endpoint Connection +```powershell +Deny-AzEventHubPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name 00000000000 +``` + +```output +ConnectionState : Rejected +Description : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/privateEndpointC + onnections/00000000000 +Location : Australia East +Name : 00000000000 +PrivateEndpointId : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +``` + +Rejects private endpoint connection `00000000000` on EventHub namespace `myNamespace`. + +### Example 2: Reject an Event Hub Namespace Private Endpoint Connection using InputObject +```powershell +$privateEndpoint = Get-AzEventHubPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name 00000000000 +Deny-AzEventHubPrivateEndpointConnection -InputObject $privateEndpoint +``` + +```output +ConnectionState : Rejected +Description : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/privateEndpointC + onnections/00000000000 +Location : Australia East +Name : 00000000000 +PrivateEndpointId : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +``` + +Rejects private endpoint connection `00000000000` on EventHub namespace `myNamespace` using InputObject parameter set. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +PrivateEndpoint information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Private Endpoint Connection + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IPrivateEndpointConnection + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IEventHubIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHub.md b/azps-10.1.0/Az.EventHub/Get-AzEventHub.md new file mode 100644 index 0000000000..7671115fe2 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHub.md @@ -0,0 +1,249 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHub.md +--- + +# Get-AzEventHub + +## SYNOPSIS +Gets an Event Hubs description for the specified Event Hub. + +## SYNTAX + +### List (Default) +``` +Get-AzEventHub -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Skip <Int32>] + [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzEventHub -Name <String> -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzEventHub -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets an Event Hubs description for the specified Event Hub. + +## EXAMPLES + +### Example 1: Get an EventHub entity +```powershell +Get-AzEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myEventHub +``` + +```output +ArchiveNameFormat : Active +BlobContainer : +CaptureEnabled : +CleanupPolicy : Compact +CreatedAt : 4/25/2023 4:05:57 AM +DataLakeAccountName : +DataLakeFolderPath : +DataLakeSubscriptionId : +DestinationName : +Encoding : Microsoft.EventHub/namespaces/eventhubs +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub +IntervalInSeconds : est [Az.EventHub]> +Location : eastus +MessageRetentionInDay : 9223372036854775807 +Name : myEventntHub +PartitionCount : 4 +PartitionId : {0, 1, 2, 3} +ResourceGroupName : myResourceGroup +RetentionTimeInHour : +SizeLimitInBytes : +SkipEmptyArchive : +Status : Active +StorageAccountResourceId : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TombstoneRetentionTimeInHour : +Type : Microsoft.EventHub/namespaces/eventhubs +UpdatedAt : 4/25/2023 4:05:58 AM +``` + +Gets details of eventhub entity `myEventHub` from namespace `myNamespace`. + +### Example 2: List All EventHubs in a namespace +```powershell +Get-AzEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +Lists all EventHub entities from namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Event Hub name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: EventHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +May be used to limit the number of results to the most recent N usageDetails. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skip is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IEventhub + +## 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 <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHubApplicationGroup.md b/azps-10.1.0/Az.EventHub/Get-AzEventHubApplicationGroup.md new file mode 100644 index 0000000000..f0416dcda1 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHubApplicationGroup.md @@ -0,0 +1,205 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubapplicationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubApplicationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubApplicationGroup.md +--- + +# Get-AzEventHubApplicationGroup + +## SYNOPSIS +Gets an ApplicationGroup for a Namespace. + +## SYNTAX + +### List (Default) +``` +Get-AzEventHubApplicationGroup -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzEventHubApplicationGroup -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzEventHubApplicationGroup -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an ApplicationGroup for a Namespace. + +## EXAMPLES + +### Example 1: Get an application group from an EventHub namespace +```powershell +Get-AzEventHubApplicationGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAppGroup +``` + +```output +ClientAppGroupIdentifier : NamespaceSASKeyName=RootManageSharedAccessKey +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/applicationGroups/ + myAppGroup +IsEnabled : True +Location : Central US +Name : myAppGroup +Policy : {{ + "name": "throttlingPolicy1", + "type": "ThrottlingPolicy", + "rateLimitThreshold": 10000, + "metricId": "OutgoingMessages" + }, { + "name": "throttlingPolicy2", + "type": "ThrottlingPolicy", + "rateLimitThreshold": 11111, + "metricId": "OutgoingBytes" + }} +ResourceGroupName : myResourceGroup +``` + +Gets details of application group `myAppGroup` from namespace `myNamespace`. + +### Example 2: Lists all application groups in an EventHub namespace +```powershell +Get-AzEventHubApplicationGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +Lists all application groups from namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Application Group name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ApplicationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IApplicationGroup + +## 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 <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHubAuthorizationRule.md b/azps-10.1.0/Az.EventHub/Get-AzEventHubAuthorizationRule.md new file mode 100644 index 0000000000..7280b2e9c9 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHubAuthorizationRule.md @@ -0,0 +1,237 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubAuthorizationRule.md +--- + +# Get-AzEventHubAuthorizationRule + +## SYNOPSIS +Gets an EventHub Authorization Rule + +## SYNTAX + +### GetExpandedNamespace (Default) +``` +Get-AzEventHubAuthorizationRule -NamespaceName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetExpandedEntity +``` +Get-AzEventHubAuthorizationRule -NamespaceName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String[]>] -EventHubName <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetExpandedAlias +``` +Get-AzEventHubAuthorizationRule -NamespaceName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String[]>] -AliasName <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentityExpanded +``` +Get-AzEventHubAuthorizationRule -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an EventHub Authorization Rule + +## EXAMPLES + +### Example 1: Get an EventHub Namespace Authorization Rule +```powershell +Get-AzEventHubAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAuthRule +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/authorizationRules + /myAuthRule +Location : Central US +Name : myAuthRule +ResourceGroupName : myResourceGroup +Rights : {Listen, Manage, Send} +``` + +Gets details of authorization rule `myAuthRule` of EventHub namespace `myNamespace`. + +### Example 2: Get an EventHub entity authorization rule +```powershell +Get-AzEventHubAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name myAuthRule +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub/authorizationRules + /myAuthRule +Location : Central US +Name : myAuthRule +ResourceGroupName : myResourceGroup +Rights : {Listen, Manage, Send} +``` + +Gets details of authorization rule `myAuthRule` of EventHub entity `myEventHub` from namespace `myNamespace`. + +## PARAMETERS + +### -AliasName +The name of the Disaster Recovery alias + +```yaml +Type: System.String +Parameter Sets: GetExpandedAlias +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the EventHub entity. + +```yaml +Type: System.String +Parameter Sets: GetExpandedEntity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: GetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Authorization Rule + +```yaml +Type: System.String +Parameter Sets: GetExpandedNamespace, GetExpandedEntity, GetExpandedAlias +Aliases: AuthorizationRuleName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: GetExpandedNamespace, GetExpandedEntity, GetExpandedAlias +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: GetExpandedNamespace, GetExpandedEntity, GetExpandedAlias +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: GetExpandedNamespace, GetExpandedEntity, GetExpandedAlias +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IAuthorizationRule + +## 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 <IEventHubIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHubCluster.md b/azps-10.1.0/Az.EventHub/Get-AzEventHubCluster.md new file mode 100644 index 0000000000..7519952adf --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHubCluster.md @@ -0,0 +1,180 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubCluster.md +--- + +# Get-AzEventHubCluster + +## SYNOPSIS +Gets the resource description of the specified Event Hubs Cluster. + +## SYNTAX + +### List (Default) +``` +Get-AzEventHubCluster [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzEventHubCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzEventHubCluster -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzEventHubCluster -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the resource description of the specified Event Hubs Cluster. + +## EXAMPLES + +### Example 1: Get an EventHub cluster +```powershell +Get-AzEventHubCluster -ResourceGroupName myResourceGroup -Name DefaultCluster-11 +``` + +```output +Capacity : 1 +CreatedAt : 2022-08-29T09:38:30.453Z +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/clusters/DefaultCluster-11 +Location : australiaeast +MetricId : PROD-00-000 +Name : DefaultCluster-11 +ResourceGroupName : myResourceGroup +SkuName : Dedicated +Status : +SupportsScaling : False +Tag : {} +``` + +Gets details of EventHubs dedicated cluster by the name `DefaultCluster-11`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Event Hubs Cluster. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.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 <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHubClusterNamespace.md b/azps-10.1.0/Az.EventHub/Get-AzEventHubClusterNamespace.md new file mode 100644 index 0000000000..4770adcdf8 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHubClusterNamespace.md @@ -0,0 +1,118 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubclusternamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubClusterNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubClusterNamespace.md +--- + +# Get-AzEventHubClusterNamespace + +## SYNOPSIS +List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster. + +## SYNTAX + +``` +Get-AzEventHubClusterNamespace -ClusterName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster. + +## EXAMPLES + +### Example 1: List all Namespace ID's in a cluster +```powershell +Get-AzEventHubClusterNamespace -ResourceGroupName myResourceGroup -ClusterName DefaultCluster-11 +``` + +```output +Id +-- +/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace1 +/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace2 +``` + +Lists ID's of all namespaces created in EventHubs dedicated cluster `DefaultCluster-11`. + +## PARAMETERS + +### -ClusterName +The name of the Event Hubs Cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IEhNamespaceIdContainer + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHubClustersAvailableRegion.md b/azps-10.1.0/Az.EventHub/Get-AzEventHubClustersAvailableRegion.md new file mode 100644 index 0000000000..f560612e5a --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHubClustersAvailableRegion.md @@ -0,0 +1,81 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubclustersavailableregion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubClustersAvailableRegion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubClustersAvailableRegion.md +--- + +# Get-AzEventHubClustersAvailableRegion + +## SYNOPSIS +List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region. + +## SYNTAX + +``` +Get-AzEventHubClustersAvailableRegion [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region. + +## EXAMPLES + +### Example 1: Get all available regions for cluster creation +```powershell +Get-AzEventHubClustersAvailableRegion +``` + +Lists all regions that are available for cluster creation. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IAvailableCluster + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHubConsumerGroup.md b/azps-10.1.0/Az.EventHub/Get-AzEventHubConsumerGroup.md new file mode 100644 index 0000000000..0b9f124073 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHubConsumerGroup.md @@ -0,0 +1,240 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubconsumergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubConsumerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubConsumerGroup.md +--- + +# Get-AzEventHubConsumerGroup + +## SYNOPSIS +Gets a description for the specified consumer group. + +## SYNTAX + +### List (Default) +``` +Get-AzEventHubConsumerGroup -EventHubName <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-Skip <Int32>] [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzEventHubConsumerGroup -EventHubName <String> -Name <String> -NamespaceName <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzEventHubConsumerGroup -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a description for the specified consumer group. + +## EXAMPLES + +### Example 1: Get an EventHub consumer group +```powershell +Get-AzEventHubConsumerGroup -Name '$Default' -NamespaceName myNamespace -ResourceGroupName myResourceGroup -EventHubName myEventHub +``` + +```output +CreatedAt : 9/13/2022 9:20:47 AM +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace + /eventhubs/eh1/consumergroups/$Default +Location : australiaeast +Name : $Default +ResourceGroupName : myResourceGroup +UpdatedAt : 9/13/2022 9:20:47 AM +UserMetadata : +``` + +Gets default consumer group of eventhub entity `myEventHub`. + +### Example 2: List all consumer groups in an EventHub entity +```powershell +Get-AzEventHubConsumerGroup -NamespaceName myNamespace -ResourceGroupName myResourceGroup -EventHubName myEventHub +``` + +Lists all consumer groups in entity `myEventHub` from namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The Event Hub name + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The consumer group name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ConsumerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +May be used to limit the number of results to the most recent N usageDetails. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skip is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IConsumerGroup + +## 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 <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHubGeoDRConfiguration.md b/azps-10.1.0/Az.EventHub/Get-AzEventHubGeoDRConfiguration.md new file mode 100644 index 0000000000..2afb676e76 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHubGeoDRConfiguration.md @@ -0,0 +1,189 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubgeodrconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubGeoDRConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubGeoDRConfiguration.md +--- + +# Get-AzEventHubGeoDRConfiguration + +## SYNOPSIS +Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace + +## SYNTAX + +### List (Default) +``` +Get-AzEventHubGeoDRConfiguration -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzEventHubGeoDRConfiguration -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzEventHubGeoDRConfiguration -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace + +## EXAMPLES + +### Example 1: Get the disaster recovery configuration details of an eventhubs namespace +```powershell +Get-AzEventHubGeoDRConfiguration -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAlias +``` + +```output +AlternateName : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/disasterRecoveryConfigs/myAlias +Location : +Name : myalias +PartnerNamespace : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/mySecondaryNamespace +PendingReplicationOperationsCount : 0 +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +Role : Primary +``` + +Gets disaster recovery configuration details of alias `myAlias` created for namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Disaster Recovery configuration name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IArmDisasterRecovery + +## 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 <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHubKey.md b/azps-10.1.0/Az.EventHub/Get-AzEventHubKey.md new file mode 100644 index 0000000000..c8e8703acb --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHubKey.md @@ -0,0 +1,227 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubKey.md +--- + +# Get-AzEventHubKey + +## SYNOPSIS +Gets an EventHub SAS key + +## SYNTAX + +### GetExpandedNamespace (Default) +``` +Get-AzEventHubKey -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +### GetExpandedAlias +``` +Get-AzEventHubKey -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] -AliasName <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [<CommonParameters>] +``` + +### GetExpandedEntity +``` +Get-AzEventHubKey -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] -EventHubName <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an EventHub SAS key + +## EXAMPLES + +### Example 1: Get keys of an EventHub Namespace authorization rule +```powershell +Get-AzEventHubKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name RootManageSharedAccessKey +``` + +```output +AliasPrimaryConnectionString : +AliasSecondaryConnectionString : +KeyName : RootManageSharedAccessKey +PrimaryConnectionString : 000000000000 +PrimaryKey : 000000000000 +SecondaryConnectionString : {ConnectionString} +SecondaryKey : {ConnectionString} +``` + +Gets keys of authorization rule `RootManageSharedAccessKey` of EventHub namespace `myNamespace`. + +### Example 2: Get keys of an EventHub Entity authorization rule +```powershell +Get-AzEventHubKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name RootManageSharedAccessKey +``` + +```output +AliasPrimaryConnectionString : +AliasSecondaryConnectionString : +KeyName : RootManageSharedAccessKey +PrimaryConnectionString : 000000000000 +PrimaryKey : 000000000000 +SecondaryConnectionString : {ConnectionString} +SecondaryKey : {ConnectionString} +``` + +Gets keys of authorization rule `RootManageSharedAccessKey` of EventHub entity `myEventHub` from namespace `myNamespace`. + +## PARAMETERS + +### -AliasName +The name of the Disaster Recovery alias + +```yaml +Type: System.String +Parameter Sets: GetExpandedAlias +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the EventHub entity. + +```yaml +Type: System.String +Parameter Sets: GetExpandedEntity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Authorization Rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AuthorizationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IAccessKeys + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHubNamespace.md b/azps-10.1.0/Az.EventHub/Get-AzEventHubNamespace.md new file mode 100644 index 0000000000..20fc5d6960 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHubNamespace.md @@ -0,0 +1,219 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubnamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubNamespace.md +--- + +# Get-AzEventHubNamespace + +## SYNOPSIS +Gets the description of the specified namespace. + +## SYNTAX + +### List (Default) +``` +Get-AzEventHubNamespace [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzEventHubNamespace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzEventHubNamespace -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzEventHubNamespace -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the description of the specified namespace. + +## EXAMPLES + +### Example 1: Get an EventHub namespace +```powershell +Get-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace +``` + +```output +AlternateName : +ClusterArmId : +CreatedAt : 11/17/2022 3:14:09 PM +DisableLocalAuth : True +EnableAutoInflate : True +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +IdentityType : +KafkaEnabled : True +KeySource : +KeyVaultProperty : +Location : South Central US +MaximumThroughputUnit : 0 +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : 000000000000000000 +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Standard +SkuTier : Standard +Status : Active +Tag : { + } +TenantId : 00000000000 +Type : Microsoft.EventHub/Namespaces +UpdatedAt : 11/17/2022 3:21:19 PM +UserAssignedIdentity : { + } +ZoneRedundant : True +``` + +Gets details of an EventHub namespace `myNamespace` in resource group `myResourceGroup`. + +### Example 2: List all EventHub namespaces in a resource group +```powershell +Get-AzEventHubNamespace -ResourceGroupName myResourceGroup +``` + +Lists all EventHub namespaces under resource group `myResourceGroup`. + +### Example 3: List all EventHub namespaces in a subscription +```powershell +Get-AzEventHubNamespace +``` + +Lists all EventHub namespaces in the current subscription context. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Namespace name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: NamespaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IEhNamespace + +## NOTES + +ALIASES + +Get-AzEventHubNamespaceV2 + +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 <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHubNetworkRuleSet.md b/azps-10.1.0/Az.EventHub/Get-AzEventHubNetworkRuleSet.md new file mode 100644 index 0000000000..32e4ed525b --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHubNetworkRuleSet.md @@ -0,0 +1,174 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubnetworkruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubNetworkRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubNetworkRuleSet.md +--- + +# Get-AzEventHubNetworkRuleSet + +## SYNOPSIS +Gets NetworkRuleSet for a Namespace. + +## SYNTAX + +### Get (Default) +``` +Get-AzEventHubNetworkRuleSet -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzEventHubNetworkRuleSet -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzEventHubNetworkRuleSet -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets NetworkRuleSet for a Namespace. + +## EXAMPLES + +### Example 1: Gets the network rule set of an EventHub namespace +```powershell +Get-AzEventHubNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +```output +DefaultAction : Allow +IPRule : {} +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/networkRuleSets/default +Location : Central US +Name : default +PublicNetworkAccess : Enabled +ResourceGroupName : myResourceGroup +VirtualNetworkRule : +``` + +Gets the network rule set of EventHub namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.INetworkRuleSet + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.INetworkRuleSetListResult + +## 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 <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHubPrivateEndpointConnection.md b/azps-10.1.0/Az.EventHub/Get-AzEventHubPrivateEndpointConnection.md new file mode 100644 index 0000000000..6cca9094f2 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHubPrivateEndpointConnection.md @@ -0,0 +1,196 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubPrivateEndpointConnection.md +--- + +# Get-AzEventHubPrivateEndpointConnection + +## SYNOPSIS +Gets a description for the specified Private Endpoint Connection name. + +## SYNTAX + +### List (Default) +``` +Get-AzEventHubPrivateEndpointConnection -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzEventHubPrivateEndpointConnection -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzEventHubPrivateEndpointConnection -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a description for the specified Private Endpoint Connection name. + +## EXAMPLES + +### Example 1: Get an Event Hub Namespace Private Endpoint Connection +```powershell +Get-AzEventHubPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name 00000000000 +``` + +```output +ConnectionState : Approved +Description : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/privateEndpointC + onnections/00000000000 +Location : Australia East +Name : 00000000000 +PrivateEndpointId : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/privateEndpointName +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +``` + +Gets details of private endpoint connection `00000000000` created under EventHub namespace `myNamespace`. + +### Example 2: List all private endpoint connections on an EventHub namespace +```powershell +Get-AzEventHubPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +Lists all private endpoint connections of EventHub namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The PrivateEndpointConnection name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PrivateEndpointConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IPrivateEndpointConnection + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHubPrivateLink.md b/azps-10.1.0/Az.EventHub/Get-AzEventHubPrivateLink.md new file mode 100644 index 0000000000..67fe0e32d5 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHubPrivateLink.md @@ -0,0 +1,120 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubprivatelink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubPrivateLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubPrivateLink.md +--- + +# Get-AzEventHubPrivateLink + +## SYNOPSIS +Gets lists of resources that supports Privatelinks. + +## SYNTAX + +``` +Get-AzEventHubPrivateLink -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets lists of resources that supports Privatelinks. + +## EXAMPLES + +### Example 1: Get private links associated with an EventHub namespace +```powershell +Get-AzEventHubPrivateLink -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +```output +GroupId : namespace +Id : subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/privateLinkResources/namespace +Name : namespace +RequiredMember : {namespace} +RequiredZoneName : {privatelink.servicebus.windows.net} +Type : Microsoft.EventHub/namespaces/privateLinkResources +``` + +Gets private link resources available on EventHubs namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IPrivateLinkResourcesListResult + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Get-AzEventHubSchemaGroup.md b/azps-10.1.0/Az.EventHub/Get-AzEventHubSchemaGroup.md new file mode 100644 index 0000000000..172dc91152 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Get-AzEventHubSchemaGroup.md @@ -0,0 +1,227 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubschemagroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubSchemaGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Get-AzEventHubSchemaGroup.md +--- + +# Get-AzEventHubSchemaGroup + +## SYNOPSIS +Gets the details of an EventHub schema group. + +## SYNTAX + +### List (Default) +``` +Get-AzEventHubSchemaGroup -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Skip <Int32>] [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzEventHubSchemaGroup -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzEventHubSchemaGroup -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the details of an EventHub schema group. + +## EXAMPLES + +### Example 1: Get details of a schema group from an EventHub namespace +```powershell +Get-AzEventHubSchemaGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name mySchemaGroup +``` + +```output +CreatedAtUtc : 9/14/2022 6:05:47 AM +ETag : {etag} +GroupProperty : { + } +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/schemagroups/mySchemaGroup +Location : Central US +Name : mySchemaGroup +ResourceGroupName : myResourceGroup +SchemaCompatibility : None +SchemaType : Avro +``` + +Gets details of schema group `mySchemaGroup` from EventHub namespace `myNamespace`. + +### Example 2: List all schema groups in an EventHub namespace +```powershell +Get-AzEventHubSchemaGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +Lists all schema groups created within EventHub namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Schema Group name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SchemaGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +May be used to limit the number of results to the most recent N usageDetails. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skip is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.ISchemaGroup + +## 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 <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHub.md b/azps-10.1.0/Az.EventHub/New-AzEventHub.md new file mode 100644 index 0000000000..6aecdf9cb9 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHub.md @@ -0,0 +1,488 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHub.md +--- + +# New-AzEventHub + +## SYNOPSIS +Creates or updates a new Event Hub as a nested resource within a Namespace. + +## SYNTAX + +``` +New-AzEventHub -Name <String> -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-ArchiveNameFormat <String>] [-BlobContainer <String>] [-CaptureEnabled] + [-CleanupPolicy <CleanupPolicyRetentionDescription>] [-DestinationName <String>] + [-Encoding <EncodingCaptureDescription>] [-IntervalInSeconds <Int32>] [-PartitionCount <Int64>] + [-RetentionTimeInHour <Int64>] [-SizeLimitInBytes <Int32>] [-SkipEmptyArchive] [-Status <EntityStatus>] + [-StorageAccountResourceId <String>] [-TombstoneRetentionTimeInHour <Int32>] [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a new Event Hub as a nested resource within a Namespace. + +## EXAMPLES + +### Example 1: Create an EventHub entity +```powershell +New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -RetentionTimeInHour 168 -PartitionCount 5 -CleanupPolicy Delete +``` + +```output +ArchiveNameFormat : +BlobContainer : +CaptureEnabled : +CleanupPolicy : Delete +CreatedAt : 4/25/2023 3:55:45 AM +DataLakeAccountName : +DataLakeFolderPath : +DataLakeSubscriptionId : +DestinationName : +Encoding : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub +IntervalInSeconds : +Location : eastus +MessageRetentionInDay : 7 +Name : myEventHub +PartitionCount : 5 +PartitionId : {0, 1, 2, 3�} +ResourceGroupName : myResourceGroup +RetentionTimeInHour : 168 +SizeLimitInBytes : +SkipEmptyArchive : +Status : Active +StorageAccountResourceId : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TombstoneRetentionTimeInHour : +Type : Microsoft.EventHub/namespaces/eventhubs +UpdatedAt : 4/25/2023 3:55:46 AM +``` + +Creates a new eventhub entity `myEventHub` on namespace `myNamespace` with CleaupPolicy `Delete`. + +### Example 2: Create EventHub with Capture Enabled +```powershell +New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -ArchiveNameFormat "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" -BlobContainer container -CaptureEnabled -DestinationName EventHubArchive.AzureBlockBlob -Encoding Avro -IntervalInSeconds 600 -SizeLimitInBytes 11000000 -SkipEmptyArchive -StorageAccountResourceId "/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount -CleanupPolicy Delete" +``` + +```output +ArchiveNameFormat : {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} +BlobContainer : container +CaptureEnabled : true +CreatedAt : 9/1/2022 5:55:46 AM +DataLakeAccountName : +DataLakeFolderPath : +DataLakeSubscriptionId : +DestinationName : +Encoding : Avro +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myFirstEventHub +IntervalInSeconds : 600 +Location : centralus +MessageRetentionInDays : 6 +Name : myFirstEventHub +PartitionCount : 5 +PartitionId : {0} +ResourceGroupName : myResourceGroup +RetentionTimeInHour : 24 +SizeLimitInBytes : 11000000 +SkipEmptyArchive : true +Status : Active +``` + +Creates a new eventhub entity `myEventHub` on namespace `myNamespace` with capture enabled. + +### Example 3: Create an EventHub entity +```powershell +New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -CleanupPolicy Compact +``` + +```output +ArchiveNameFormat : +BlobContainer : +CaptureEnabled : +CleanupPolicy : Compact +CreatedAt : 4/25/2023 4:05:57 AM +DataLakeAccountName : +DataLakeFolderPath : +DataLakeSubscriptionId : +DestinationName : +Encoding : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub +IntervalInSeconds : +Location : eastus +MessageRetentionInDay : 9223372036854775807 +Name : myEventHub +PartitionCount : 4 +PartitionId : {0, 1, 2, 3} +ResourceGroupName : myResourceGroup +RetentionTimeInHour : +SizeLimitInBytes : +SkipEmptyArchive : +Status : Active +StorageAccountResourceId : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TombstoneRetentionTimeInHour : +Type : Microsoft.EventHub/namespaces/eventhubs +UpdatedAt : 4/25/2023 4:05:58 AM +``` + +Creates a new eventhub entity `myEventHub` on namespace `myNamespace` with CleaupPolicy `Compact`. + +## PARAMETERS + +### -ArchiveNameFormat +Blob naming convention for archive, e.g. +{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. +Here all the parameters (Namespace,EventHub .. +etc) are mandatory irrespective of order + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobContainer +Blob container Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CaptureEnabled +A value that indicates whether capture description is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CleanupPolicy +Enumerates the possible values for cleanup policy + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.CleanupPolicyRetentionDescription +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationName +Name for capture destination + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Encoding +Enumerates the possible values for the encoding format of capture description. +Note: 'AvroDeflate' will be deprecated in New API Version + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.EncodingCaptureDescription +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntervalInSeconds +The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Event Hub name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: EventHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionCount +Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionTimeInHour +Number of hours to retain the events for this Event Hub. +This value is only used when cleanupPolicy is Delete. +If cleanupPolicy is Compaction the returned value of this property is Long.MaxValue + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SizeLimitInBytes +The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipEmptyArchive +A value that indicates whether to Skip Empty Archives + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Enumerates the possible values for the status of the Event Hub. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.EntityStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Resource id of the storage account to be used to create the blobs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TombstoneRetentionTimeInHour +Number of hours to retain the tombstone markers of a compacted Event Hub. +This value is only used when cleanupPolicy is Compaction. +Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IEventhub + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHubApplicationGroup.md b/azps-10.1.0/Az.EventHub/New-AzEventHubApplicationGroup.md new file mode 100644 index 0000000000..77fda65681 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHubApplicationGroup.md @@ -0,0 +1,237 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubapplicationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubApplicationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubApplicationGroup.md +--- + +# New-AzEventHubApplicationGroup + +## SYNOPSIS +Creates or updates an ApplicationGroup for a Namespace. + +## SYNTAX + +``` +New-AzEventHubApplicationGroup -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-ClientAppGroupIdentifier <String>] [-IsEnabled] + [-Policy <IApplicationGroupPolicy[]>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an ApplicationGroup for a Namespace. + +## EXAMPLES + +### Example 1: Create an application group with 2 Throttling policies +```powershell +$t1 = New-AzEventHubThrottlingPolicyConfig -Name t1 -MetricId IncomingMessages -RateLimitThreshold 10000 +$t2 = New-AzEventHubThrottlingPolicyConfig -Name t2 -MetricId OutgoingBytes -RateLimitThreshold 20000 +New-AzEventHubApplicationGroup -NamespaceName myNamespace -ResourceGroupName myResourceGroup -Name myAppGroup -ClientAppGroupIdentifier NamespaceSASKeyName=a -Policy $t1,$t2 +``` + +```output +ClientAppGroupIdentifier : NamespaceSASKeyName=a +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/applicationGroups/ + myAppGroup +IsEnabled : True +Location : Central US +Name : myAppGroup +Policy : {{ + "name": "t1", + "type": "ThrottlingPolicy", + "rateLimitThreshold": 10000, + "metricId": "IncomingMessages" + }, { + "name": "t2", + "type": "ThrottlingPolicy", + "rateLimitThreshold": 20000, + "metricId": "OutgoingBytes" + }} +ResourceGroupName : myResourceGroup +``` + +Creates a new application group `myAppGroup` on namespace `myNamespace` with 2 throttling policies. + +## PARAMETERS + +### -ClientAppGroupIdentifier +The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsEnabled +Determines if Application Group is allowed to create connection with namespace or not. +Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Application Group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +List of group policies that define the behavior of application group. +The policies can support resource governance scenarios such as limiting ingress or egress traffic. +To construct, see NOTES section for POLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IApplicationGroupPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IApplicationGroup + +## 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. + + +`POLICY <IApplicationGroupPolicy[]>`: List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic. + - `Name <String>`: The Name of this policy + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHubAuthorizationRule.md b/azps-10.1.0/Az.EventHub/New-AzEventHubAuthorizationRule.md new file mode 100644 index 0000000000..5cb6e797c5 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHubAuthorizationRule.md @@ -0,0 +1,248 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubAuthorizationRule.md +--- + +# New-AzEventHubAuthorizationRule + +## SYNOPSIS +Creates an EventHub Authorization Rule + +## SYNTAX + +### NewExpandedNamespace (Default) +``` +New-AzEventHubAuthorizationRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Rights <AccessRights[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewExpandedEntity +``` +New-AzEventHubAuthorizationRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -EventHubName <String> [-Rights <AccessRights[]>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an EventHub Authorization Rule + +## EXAMPLES + +### Example 1: Create an authorization rule for an EventHub namespace +```powershell +New-AzEventHubAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAuthRule -Rights @('Manage', 'Send', 'Listen') +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/authorizationRules/myAuthRule +Location : Central US +Name : myAuthRule +ResourceGroupName : myResourceGroup +Rights : {Listen, Manage, Send} +``` + +Creates a new authorization rule `myAuthRule` on namespace `myNamespace`. + +### Example 2: Create an authorization rule for an EventHub entity +```powershell +New-AzEventHubAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name myAuthRule -Rights @('Manage', 'Send', 'Listen') +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub/authorizationRules/myAuthRule +Location : Central US +Name : myAuthRule +ResourceGroupName : myResourceGroup +Rights : {Listen, Manage, Send} +``` + +Creates a new authorization rule `myAuthRule` on EventHubs entity `myEventHub` from namespace `myNamespace`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the EventHub entity. + +```yaml +Type: System.String +Parameter Sets: NewExpandedEntity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Authorization Rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AuthorizationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rights +The rights associated with the rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.AccessRights[] +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IAuthorizationRule + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHubAuthorizationRuleSASToken.md b/azps-10.1.0/Az.EventHub/New-AzEventHubAuthorizationRuleSASToken.md new file mode 100644 index 0000000000..394b902481 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHubAuthorizationRuleSASToken.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.EventHub.dll-Help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubauthorizationrulesastoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubAuthorizationRuleSASToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubAuthorizationRuleSASToken.md +--- + +# New-AzEventHubAuthorizationRuleSASToken + +## SYNOPSIS +Generates a SAS token for Azure eventhub authorization rule of namespace/eventhub. + +## SYNTAX + +``` +New-AzEventHubAuthorizationRuleSASToken [-AuthorizationRuleId] <String> [-KeyType] <String> + [-ExpiryTime] <DateTime> [-StartTime <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzEventHubAuthorizationRuleSASToken cmdlet generates a Shared Access Signature (SAS) token for an Azure Eventhub Namesapce or Azure Eventhub + +## EXAMPLES + +### Example 1 +```powershell +$StartTime = Get-Date +$EndTime = $StartTime.AddHours(2.0) +$SasToken = New-AzEventHubAuthorizationRuleSASToken -AuthorizationRuleId $updatedAuthRule.Id -KeyType Primary -ExpiryTime $EndTime -StartTime $StartTime +``` + +Generate SAS token for the given authorixation rule for Namespace with start and expiry time.. + +### Example 2 +```powershell +$StartTime = Get-Date +$EndTime = $StartTime.AddHours(2.0) +$SasToken = New-AzEventHubAuthorizationRuleSASToken -AuthorizationRuleId $updatedAuthRule.Id -KeyType Primary -ExpiryTime $EndTime +``` + +Generate SAS token for the given authorixation rule for Namespace with expiry time. + +## PARAMETERS + +### -AuthorizationRuleId +ARM ResourceId of the Authoraization Rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Expiry Time + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyType +Key Type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +Start Time + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +## OUTPUTS + +### Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessSignatureAttributes + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHubCluster.md b/azps-10.1.0/Az.EventHub/New-AzEventHubCluster.md new file mode 100644 index 0000000000..9254f6d5f9 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHubCluster.md @@ -0,0 +1,268 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubCluster.md +--- + +# New-AzEventHubCluster + +## SYNOPSIS +Creates or updates an instance of an Event Hubs Cluster. + +## SYNTAX + +``` +New-AzEventHubCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Capacity <Int32>] + [-Location <String>] [-SupportsScaling] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an instance of an Event Hubs Cluster. + +## EXAMPLES + +### Example 1: Create a self-serve cluster +```powershell +New-AzEventHubCluster -ResourceGroupName myResourceGroup -Name myEventHubsCluster -Location "eastasia" -SupportsScaling -Capacity 2 +``` + +```output +Capacity : 2 +CreatedAt : 2022-08-29T09:38:30.453Z +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/clusters/myEventHubsCluster +Location : australiaeast +MetricId : PROD-00-000 +Name : myEventHubsCluster +ResourceGroupName : myResourceGroup +SkuName : Dedicated +Status : +SupportsScaling : True +Tag : {} +``` + +Creates a self-serve dedicated cluster `myEventHubsCluster` with 2 capacity units. + +### Example 2: Create an EventHubs dedicated cluster of Capacity 1CU +```powershell +New-AzEventHubCluster -ResourceGroupName myResourceGroup -Name myEventHubsCluster -Location "eastasia" +``` + +```output +Capacity : 1 +CreatedAt : 2022-08-29T09:38:30.453Z +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/clusters/myEventHubsCluster +Location : australiaeast +MetricId : PROD-00-000 +Name : myEventHubsCluster +ResourceGroupName : myResourceGroup +SkuName : Dedicated +Status : +SupportsScaling : +Tag : {} +``` + +Create a EventHubs dedicated cluster `myEventHubsCluster` in Australia East. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Capacity +The quantity of Event Hubs Cluster Capacity Units contained in this cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -Name +The name of the Event Hubs Cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportsScaling +A value that indicates whether Scaling is Supported. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.ICluster + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHubConsumerGroup.md b/azps-10.1.0/Az.EventHub/New-AzEventHubConsumerGroup.md new file mode 100644 index 0000000000..3181abb1c6 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHubConsumerGroup.md @@ -0,0 +1,201 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubconsumergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubConsumerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubConsumerGroup.md +--- + +# New-AzEventHubConsumerGroup + +## SYNOPSIS +Creates or updates an Event Hubs consumer group as a nested resource within a Namespace. + +## SYNTAX + +``` +New-AzEventHubConsumerGroup -EventHubName <String> -Name <String> -NamespaceName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-UserMetadata <String>] [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an Event Hubs consumer group as a nested resource within a Namespace. + +## EXAMPLES + +### Example 1: Create an EventHub ConsumerGroup +```powershell +New-AzEventHubConsumerGroup -Name myConsumerGroup -NamespaceName myNamespace -ResourceGroupName myResourceGroup -EventHubName myEventHub -UserMetadata "Test ConsumerGroup" +``` + +```output +CreatedAt : 9/13/2022 9:20:47 AM +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace + /eventhubs/eh1/consumergroups/myConsumerGroup +Location : australiaeast +Name : myConsumerGroup +ResourceGroupName : myResourceGroup +UpdatedAt : 9/13/2022 9:20:47 AM +UserMetadata : Test ConsumerGroup +``` + +Creates a new consumer group `myConsumerGroup` for EventHubs entity `myEventHub`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The Event Hub name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The consumer group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConsumerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserMetadata +User Metadata is a placeholder to store user-defined string data with maximum length 1024. +e.g. +it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IConsumerGroup + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHubGeoDRConfiguration.md b/azps-10.1.0/Az.EventHub/New-AzEventHubGeoDRConfiguration.md new file mode 100644 index 0000000000..001b3cf9f3 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHubGeoDRConfiguration.md @@ -0,0 +1,201 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubgeodrconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubGeoDRConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubGeoDRConfiguration.md +--- + +# New-AzEventHubGeoDRConfiguration + +## SYNOPSIS +Creates or updates a new Alias(Disaster Recovery configuration) + +## SYNTAX + +``` +New-AzEventHubGeoDRConfiguration -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AlternateName <String>] [-PartnerNamespace <String>] [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a new Alias(Disaster Recovery configuration) + +## EXAMPLES + +### Example 1: Create a disaster recovery +```powershell +New-AzEventHubGeoDRConfiguration -Name myAlias -ResourceGroupName myResourceGroup -NamespaceName myPrimaryNamespace -PartnerNamespace /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/mySecondaryNamespace +``` + +```output +AlternateName : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myPrimaryNamespace/disasterRecoveryCon + figs/myAlias +Location : +Name : myAlias +PartnerNamespace : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/mySecondaryNamespace +PendingReplicationOperationsCount : +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +Role : Primary +``` + +Creates a Disaster Recovery configuration which sets `mySecondaryNamespace` as secondary to `myPrimaryNamespace`. + +## PARAMETERS + +### -AlternateName +Alternate name specified when alias and namespace names are same. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Disaster Recovery configuration name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerNamespace +ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IArmDisasterRecovery + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHubIPRuleConfig.md b/azps-10.1.0/Az.EventHub/New-AzEventHubIPRuleConfig.md new file mode 100644 index 0000000000..c2b940ba2d --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHubIPRuleConfig.md @@ -0,0 +1,84 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubipruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubIPRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubIPRuleConfig.md +--- + +# New-AzEventHubIPRuleConfig + +## SYNOPSIS +Constructs an INwRuleSetIPRules object that can be fed as input to Set-AzEventHubNetworkRuleSet + +## SYNTAX + +``` +New-AzEventHubIPRuleConfig -IPMask <String> [-Action <NetworkRuleIPAction>] [<CommonParameters>] +``` + +## DESCRIPTION +Constructs an INwRuleSetIPRules object that can be fed as input to Set-AzEventHubNetworkRuleSet + +## EXAMPLES + +### Example 1: Constructs an INwRuleSetIPRules object +```powershell +New-AzEventHubIPRuleConfig -IPMask 3.3.3.3 -Action Allow +``` + +```output +Action IPMask +------ ------ +Allow 1.1.1.1 +``` + +Please refer examples for Set-AzEventHubNetworkRuleSet to know more. + +## PARAMETERS + +### -Action +The IP Filter Action + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.NetworkRuleIPAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPMask +IP Mask + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.INwRuleSetIPRules + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHubKey.md b/azps-10.1.0/Az.EventHub/New-AzEventHubKey.md new file mode 100644 index 0000000000..e9cf6f736e --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHubKey.md @@ -0,0 +1,263 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubKey.md +--- + +# New-AzEventHubKey + +## SYNOPSIS +Regenerates an EventHub SAS key + +## SYNTAX + +### NewExpandedNamespace (Default) +``` +New-AzEventHubKey -Name <String> -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-KeyType <KeyType>] [-KeyValue <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### NewExpandedEntity +``` +New-AzEventHubKey -Name <String> -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + -EventHubName <String> [-KeyType <KeyType>] [-KeyValue <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerates an EventHub SAS key + +## EXAMPLES + +### Example 1: Regenerate Primary Key of an EventHub Namespace +```powershell +New-AzEventHubKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name rootmanagesharedaccesskey -KeyType PrimaryKey +``` + +```output +KeyName : RootManageSharedAccessKey +PrimaryConnectionString : {primaryConnectionString} +PrimaryKey : {primaryKey} +SecondaryConnectionString : {secondaryConnectionString} +SecondaryKey : {secondaryKey} +``` + +Regenerate primary key of authorization rule `rootmanagesharedaccesskey` on EventHub Namespace `myNamespace`. + +### Example 2: Regenerate Secondary Key of an EventHub Entity +```powershell +New-AzEventHubKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name rootmanagesharedaccesskey -KeyType SecondaryKey +``` + +```output +KeyName : RootManageSharedAccessKey +PrimaryConnectionString : {primaryConnectionString} +PrimaryKey : {primaryKey} +SecondaryConnectionString : {secondaryConnectionString} +SecondaryKey : {secondaryKey} +``` + +Regenerate secondary key of authorization rule `rootmanagesharedaccesskey` on EventHub entity `myEventHub` on EventHub Namespace `myNamespace`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the EventHub entity. + +```yaml +Type: System.String +Parameter Sets: NewExpandedEntity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyType +The access key to regenerate. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.KeyType +Parameter Sets: (All) +Aliases: RegenerateKey + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyValue +Optional, if the key value provided, is set for KeyType or autogenerated Key value set for keyType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Authorization Rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AuthorizationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IAccessKeys + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHubKeyVaultPropertiesObject.md b/azps-10.1.0/Az.EventHub/New-AzEventHubKeyVaultPropertiesObject.md new file mode 100644 index 0000000000..72ac2c0c35 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHubKeyVaultPropertiesObject.md @@ -0,0 +1,111 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/Az.EventHub/new-AzEventHubKeyVaultPropertiesObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubKeyVaultPropertiesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubKeyVaultPropertiesObject.md +--- + +# New-AzEventHubKeyVaultPropertiesObject + +## SYNOPSIS +Create an in-memory object for KeyVaultProperties. + +## SYNTAX + +``` +New-AzEventHubKeyVaultPropertiesObject [-KeyName <String>] [-KeyVaultUri <String>] [-KeyVersion <String>] + [-UserAssignedIdentity <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for KeyVaultProperties. + +## EXAMPLES + +### Example 1: Construct an in-memory KeyVaultProperties object +```powershell +New-AzEventHubKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://testkeyvault.vault.azure.net +``` + +Creates an in-memory object of type `IKeyVaultProperties`. +An array of `IKeyVaultProperties` can be fed as +input to `KeyVaultProperty` parameter of New-AzEventHubNamespaceV2 and Set-AzEventHubNamespaceV2 to enable encryption. + +## PARAMETERS + +### -KeyName +Name of the Key from KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultUri +Uri of KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVersion +Key Version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +ARM ID of user Identity selected for encryption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.KeyVaultProperties + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHubNamespace.md b/azps-10.1.0/Az.EventHub/New-AzEventHubNamespace.md new file mode 100644 index 0000000000..9f7803c122 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHubNamespace.md @@ -0,0 +1,566 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubnamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubNamespace.md +--- + +# New-AzEventHubNamespace + +## SYNOPSIS +Creates an EventHub Namespace + +## SYNTAX + +``` +New-AzEventHubNamespace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + -Location <String> [-AlternateName <String>] [-ClusterArmId <String>] [-DisableLocalAuth] + [-RequireInfrastructureEncryption] [-ZoneRedundant] [-KeyVaultProperty <IKeyVaultProperties[]>] + [-IdentityType <ManagedServiceIdentityType>] [-UserAssignedIdentityId <String[]>] [-EnableAutoInflate] + [-MaximumThroughputUnit <Int64>] [-MinimumTlsVersion <String>] [-SkuName <SkuName>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-SkuCapacity <Int64>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an EventHub Namespace + +## EXAMPLES + +### Example 1: Create a new EventHub namespace with UserAssignedIdentity Encryption +```powershell +$keyVaultProperty1 = New-AzEventHubKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$keyVaultProperty2 = New-AzEventHubKeyVaultPropertiesObject -KeyName key2 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" + +New-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity","/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" -KeyVaultProperty $keyVaultProperty1,$keyVaultProperty2 +``` + +```output +AlternateName : +ClusterArmId : +CreatedAt : 11/17/2022 2:56:32 PM +DisableLocalAuth : False +EnableAutoInflate : False +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +IdentityType : UserAssigned +KafkaEnabled : True +KeySource : Microsoft.KeyVault +KeyVaultProperty : {{ + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key1", + "keyVaultUri": "https://testkeyvault.vault.azure.net/", + "keyVersion": "" + }, { + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key2", + "keyVaultUri": "https://testkeyvault.vault.azure.net/", + "keyVersion": "" + }} +Location : North Europe +MaximumThroughputUnit : 0 +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : False +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Premium +SkuTier : Premium +Status : Active +Tag : { + } +TenantId : +Type : Microsoft.EventHub/Namespaces +UpdatedAt : 11/17/2022 3:03:50 PM +UserAssignedIdentity : { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + }, + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + } + } +ZoneRedundant : True +``` + +Creates a new Premium EventHub namespace with UserAssignedIdentity encryption + +### Example 2: Create a new EventHub namespace with System Assigned Identity enabled +```powershell +New-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType SystemAssigned +``` + +```output +AlternateName : +ClusterArmId : +CreatedAt : 11/17/2022 3:14:09 PM +DisableLocalAuth : False +EnableAutoInflate : False +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +IdentityType : SystemAssigned +KafkaEnabled : True +KeySource : +KeyVaultProperty : +Location : North Europe +MaximumThroughputUnit : 0 +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : 000000000000000000 +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Premium +SkuTier : Premium +Status : Active +Tag : { + } +TenantId : 00000000000 +Type : Microsoft.EventHub/Namespaces +UpdatedAt : 11/17/2022 3:21:19 PM +UserAssignedIdentity : { + } +ZoneRedundant : True +``` + +Create an EventHub namespace with SystemAssigned identity. + +### Example 3: Create a new Standard EventHub namespace with AutoInflate enabled +```powershell +New-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuCapacity 10 -MaximumThroughputUnit 18 -SkuName Standard -Location southcentralus -Tag @{k1='v1'; k2='v2'} -EnableAutoInflate -DisableLocalAuth +``` + +```output +AlternateName : +ClusterArmId : +CreatedAt : 11/17/2022 3:14:09 PM +DisableLocalAuth : True +EnableAutoInflate : True +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +IdentityType : +KafkaEnabled : True +KeySource : +KeyVaultProperty : +Location : South Central US +MaximumThroughputUnit : 0 +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : 000000000000000000 +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Standard +SkuTier : Standard +Status : Active +Tag : { + } +TenantId : 00000000000 +Type : Microsoft.EventHub/Namespaces +UpdatedAt : 11/17/2022 3:21:19 PM +UserAssignedIdentity : { + } +ZoneRedundant : True +``` + +Create a standard EventHub namespace `myNamespace` with Auto Inflate enabled. + +## PARAMETERS + +### -AlternateName +Alternate name specified when alias and namespace names are same + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterArmId +Cluster ARM ID of the Namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +This property disables SAS authentication for the Event Hubs namespace. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoInflate +Value that indicates whether AutoInflate is enabled for eventhub namespace. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultProperty +Properties to configure Encryption +To construct, see NOTES section for KEYVAULTPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IKeyVaultProperties[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Cluster ARM ID of the Namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumThroughputUnit +Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. +( '0' if AutoInflateEnabled = true) + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +The minimum TLS version for the cluster to support, e.g. +'1.2' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of EventHub namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +This determines if traffic is allowed over public network. +By default it is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireInfrastructureEncryption +Enable Infrastructure Encryption (Double Encryption) + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. +The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The minimum TLS version for the cluster to support, e.g. +'1.2' + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.SkuName +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag of EventHub Namespace. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +Properties for User Assigned Identities + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IEhNamespace + +## NOTES + +ALIASES + +New-AzEventHubNamespaceV2 + +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. + + +`KEYVAULTPROPERTY <IKeyVaultProperties[]>`: Properties to configure Encryption + - `[KeyName <String>]`: Name of the Key from KeyVault + - `[KeyVaultUri <String>]`: Uri of KeyVault + - `[KeyVersion <String>]`: Key Version + - `[UserAssignedIdentity <String>]`: ARM ID of user Identity selected for encryption + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHubSchemaGroup.md b/azps-10.1.0/Az.EventHub/New-AzEventHubSchemaGroup.md new file mode 100644 index 0000000000..84c9c23a8e --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHubSchemaGroup.md @@ -0,0 +1,216 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubschemagroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubSchemaGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubSchemaGroup.md +--- + +# New-AzEventHubSchemaGroup + +## SYNOPSIS +Creates or Updates an EventHub schema group. + +## SYNTAX + +``` +New-AzEventHubSchemaGroup -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-GroupProperty <Hashtable>] [-SchemaCompatibility <SchemaCompatibility>] + [-SchemaType <SchemaType>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or Updates an EventHub schema group. + +## EXAMPLES + +### Example 1: Create EventHub schema group +```powershell +$schemaGroup = New-AzEventHubSchemaGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name mySchemaGroup -SchemaCompatibility Backward -SchemaType Avro +``` + +```output +CreatedAtUtc : 9/14/2022 6:05:47 AM +ETag : {etag} +GroupProperty : { + } +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/schemagroups/mySchemaGroup +Location : Central US +Name : mySchemaGroup +ResourceGroupName : myResourceGroup +SchemaCompatibility : Backward +SchemaType : Avro +``` + +Create a new schema group `mySchemaGroup` for namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupProperty +dictionary object for SchemaGroup group properties + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Schema Group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SchemaGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchemaCompatibility +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.SchemaCompatibility +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchemaType +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.SchemaType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.ISchemaGroup + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHubThrottlingPolicyConfig.md b/azps-10.1.0/Az.EventHub/New-AzEventHubThrottlingPolicyConfig.md new file mode 100644 index 0000000000..917f33f72f --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHubThrottlingPolicyConfig.md @@ -0,0 +1,100 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubthrottlingpolicyconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubThrottlingPolicyConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubThrottlingPolicyConfig.md +--- + +# New-AzEventHubThrottlingPolicyConfig + +## SYNOPSIS +Constructs an IThrottlingPolicy object that can be fed as input to New-AzEventHubApplicationGroup or Set-AzEventHubApplicationGroup + +## SYNTAX + +``` +New-AzEventHubThrottlingPolicyConfig -Name <String> -RateLimitThreshold <Int64> -MetricId <MetricId> + [<CommonParameters>] +``` + +## DESCRIPTION +Constructs an IThrottlingPolicy object that can be fed as input to New-AzEventHubApplicationGroup or Set-AzEventHubApplicationGroup + +## EXAMPLES + +### Example 1: Constructs an IThrottlingPolicy object +```powershell +New-AzEventHubThrottlingPolicyConfig -Name t1 -RateLimitThreshold 10000 -MetricId IncomingBytes +``` + +```output +MetricId Name RateLimitThreshold Type +-------- ---- ------------------ ---- +IncomingBytes t1 10000 ThrottlingPolicy +``` + +Please refer examples for Set-AzEventHubApplicationGroup to know more. + +## PARAMETERS + +### -MetricId +Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.MetricId +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Throttling Policy Config + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RateLimitThreshold +The Threshold limit above which the application group will be throttled.Rate limit is always per second. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IThrottlingPolicy + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/New-AzEventHubVirtualNetworkRuleConfig.md b/azps-10.1.0/Az.EventHub/New-AzEventHubVirtualNetworkRuleConfig.md new file mode 100644 index 0000000000..6e3bc0a1d1 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/New-AzEventHubVirtualNetworkRuleConfig.md @@ -0,0 +1,85 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubvirtualnetworkruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubVirtualNetworkRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/New-AzEventHubVirtualNetworkRuleConfig.md +--- + +# New-AzEventHubVirtualNetworkRuleConfig + +## SYNOPSIS +Constructs an INwRuleSetVirtualNetworkRules object that can be fed as input to Set-AzEventHubNetworkRuleSet + +## SYNTAX + +``` +New-AzEventHubVirtualNetworkRuleConfig -SubnetId <String> [-IgnoreMissingVnetServiceEndpoint] + [<CommonParameters>] +``` + +## DESCRIPTION +Constructs an INwRuleSetVirtualNetworkRules object that can be fed as input to Set-AzEventHubNetworkRuleSet + +## EXAMPLES + +### Example 1: Constructs an INwRuleSetVirtualNetworkRules object +```powershell +New-AzEventHubVirtualNetworkRuleConfig -SubnetId /subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default +``` + +```output +IgnoreMissingVnetServiceEndpoint SubnetId +-------------------------------- -------- + /subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default +``` + +Please refer examples for Set-AzEventHubNetworkRuleSet to know more. + +## PARAMETERS + +### -IgnoreMissingVnetServiceEndpoint +Resource ID of Virtual Network Subnet + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Resource ID of Virtual Network Subnet + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.INwRuleSetVirtualNetworkRules + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Remove-AzEventHub.md b/azps-10.1.0/Az.EventHub/Remove-AzEventHub.md new file mode 100644 index 0000000000..21c7246a80 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Remove-AzEventHub.md @@ -0,0 +1,217 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/remove-azeventhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHub.md +--- + +# Remove-AzEventHub + +## SYNOPSIS +Deletes an Event Hub from the specified Namespace and resource group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzEventHub -Name <String> -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzEventHub -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an Event Hub from the specified Namespace and resource group. + +## EXAMPLES + +### Example 1: Remove an EventHub entity from an EventHub Namespace +```powershell +Remove-AzEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myEventHub +``` + +Deletes event hub entity `myEventHub` from namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Event Hub name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: EventHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Remove-AzEventHubApplicationGroup.md b/azps-10.1.0/Az.EventHub/Remove-AzEventHubApplicationGroup.md new file mode 100644 index 0000000000..dff2b6bb84 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Remove-AzEventHubApplicationGroup.md @@ -0,0 +1,217 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/remove-azeventhubapplicationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubApplicationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubApplicationGroup.md +--- + +# Remove-AzEventHubApplicationGroup + +## SYNOPSIS +Deletes an ApplicationGroup for a Namespace. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzEventHubApplicationGroup -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzEventHubApplicationGroup -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an ApplicationGroup for a Namespace. + +## EXAMPLES + +### Example 1: Remove an application group from an EventHub Namespace +```powershell +Remove-AzEventHubApplicationGroup -NamespaceName myNamespace -ResourceGroupName myResourceGroup -Name myAppGroup +``` + +Deletes application group `myAppGroup` from namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Application Group name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ApplicationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Remove-AzEventHubAuthorizationRule.md b/azps-10.1.0/Az.EventHub/Remove-AzEventHubAuthorizationRule.md new file mode 100644 index 0000000000..781cb09407 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Remove-AzEventHubAuthorizationRule.md @@ -0,0 +1,261 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/remove-azeventhubauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubAuthorizationRule.md +--- + +# Remove-AzEventHubAuthorizationRule + +## SYNOPSIS +Removes an EventHub Authorization Rule + +## SYNTAX + +### RemoveExpandedNamespace (Default) +``` +Remove-AzEventHubAuthorizationRule -NamespaceName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RemoveExpandedEntity +``` +Remove-AzEventHubAuthorizationRule -NamespaceName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String>] -EventHubName <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### RemoveViaIdentityExpanded +``` +Remove-AzEventHubAuthorizationRule -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an EventHub Authorization Rule + +## EXAMPLES + +### Example 1: Remove authorization rule from an EventHub namespace +```powershell +Remove-AzEventHubAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAuthRule +``` + +Deletes authorization rule `myAuthRule` from EventHub namespace `myNamespace`. + +### Example 2: Remove authorization rule from an EventHub entity +```powershell +Remove-AzEventHubAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name myAuthRule +``` + +Deletes authorization rule `myAuthRule` from EventHub entity `myEventHub` on namespace `myNamespace`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the EventHub entity. + +```yaml +Type: System.String +Parameter Sets: RemoveExpandedEntity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: RemoveViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Authorization Rule + +```yaml +Type: System.String +Parameter Sets: RemoveExpandedNamespace, RemoveExpandedEntity +Aliases: AuthorizationRuleName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: RemoveExpandedNamespace, RemoveExpandedEntity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: RemoveExpandedNamespace, RemoveExpandedEntity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: RemoveExpandedNamespace, RemoveExpandedEntity +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IAuthorizationRule + +## 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 <IEventHubIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Remove-AzEventHubCluster.md b/azps-10.1.0/Az.EventHub/Remove-AzEventHubCluster.md new file mode 100644 index 0000000000..ddc1716c49 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Remove-AzEventHubCluster.md @@ -0,0 +1,234 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/remove-azeventhubcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubCluster.md +--- + +# Remove-AzEventHubCluster + +## SYNOPSIS +Deletes an existing Event Hubs Cluster. +This operation is idempotent. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzEventHubCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzEventHubCluster -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing Event Hubs Cluster. +This operation is idempotent. + +## EXAMPLES + +### Example 1: Remove EventHubs dedicated cluster +```powershell +Remove-AzEventHubCluster -ResourceGroupName myResourceGroup -Name myEventHubsCluster +``` + +Removes EventHubs dedicated cluster by the name `myEventHubsCluster`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Event Hubs Cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Remove-AzEventHubConsumerGroup.md b/azps-10.1.0/Az.EventHub/Remove-AzEventHubConsumerGroup.md new file mode 100644 index 0000000000..1deca6df86 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Remove-AzEventHubConsumerGroup.md @@ -0,0 +1,233 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/remove-azeventhubconsumergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubConsumerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubConsumerGroup.md +--- + +# Remove-AzEventHubConsumerGroup + +## SYNOPSIS +Deletes a consumer group from the specified Event Hub and resource group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzEventHubConsumerGroup -EventHubName <String> -Name <String> -NamespaceName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzEventHubConsumerGroup -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a consumer group from the specified Event Hub and resource group. + +## EXAMPLES + +### Example 1: Remove an EventHub consumer group +```powershell +Remove-AzEventHubConsumerGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name myConsumerGroup +``` + +Deletes consumer group `myConsumerGroup` from EventHub entity `myEventHub` on namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The Event Hub name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The consumer group name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ConsumerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Remove-AzEventHubGeoDRConfiguration.md b/azps-10.1.0/Az.EventHub/Remove-AzEventHubGeoDRConfiguration.md new file mode 100644 index 0000000000..8b6653df85 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Remove-AzEventHubGeoDRConfiguration.md @@ -0,0 +1,217 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/remove-azeventhubgeodrconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubGeoDRConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubGeoDRConfiguration.md +--- + +# Remove-AzEventHubGeoDRConfiguration + +## SYNOPSIS +Deletes an Alias(Disaster Recovery configuration) + +## SYNTAX + +### Delete (Default) +``` +Remove-AzEventHubGeoDRConfiguration -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzEventHubGeoDRConfiguration -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an Alias(Disaster Recovery configuration) + +## EXAMPLES + +### Example 1: Remove Disaster Recovery Config from an EventHub namespace +```powershell +Remove-AzEventHubGeoDRConfiguration -Name myAlias -ResourceGroupName myResourceGroup -NamespaceName myPrimaryNamespace +``` + +Deletes alias `myAlias` from EventHub namespace `myPrimaryNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Disaster Recovery configuration name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Remove-AzEventHubNamespace.md b/azps-10.1.0/Az.EventHub/Remove-AzEventHubNamespace.md new file mode 100644 index 0000000000..622c8fe953 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Remove-AzEventHubNamespace.md @@ -0,0 +1,244 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/remove-azeventhubnamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubNamespace.md +--- + +# Remove-AzEventHubNamespace + +## SYNOPSIS +Deletes an existing namespace. +This operation also removes all associated resources under the namespace. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzEventHubNamespace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzEventHubNamespace -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing namespace. +This operation also removes all associated resources under the namespace. + +## EXAMPLES + +### Example 1: Delete an EventHub namespace +```powershell +Remove-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace +``` + +Deletes an EventHub namespace `myNamespace` under resource group `myResourceGroup`. + +### Example 2: Delete an EventHub namespace using InputObject parameter set +```powershell +$namespace = Get-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace +Remove-AzEventHubNamespace -InputObject $namespace +``` + +Deletes an EventHub namespace `myNamespace` under resource group `myResourceGroup` using InputObject parameter set. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: NamespaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +Remove-AzEventHubNamespaceV2 + +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 <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Remove-AzEventHubPrivateEndpointConnection.md b/azps-10.1.0/Az.EventHub/Remove-AzEventHubPrivateEndpointConnection.md new file mode 100644 index 0000000000..8ce46cb59f --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Remove-AzEventHubPrivateEndpointConnection.md @@ -0,0 +1,250 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/remove-azeventhubprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubPrivateEndpointConnection.md +--- + +# Remove-AzEventHubPrivateEndpointConnection + +## SYNOPSIS +Deletes an existing namespace. +This operation also removes all associated resources under the namespace. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzEventHubPrivateEndpointConnection -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzEventHubPrivateEndpointConnection -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing namespace. +This operation also removes all associated resources under the namespace. + +## EXAMPLES + +### Example 1: Remove a private endpoint connection from an eventhub namespace +```powershell +Remove-AzEventHubPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name 00000000000 +``` + +Deletes private endpoint connection `00000000000` from an event hub namespace `myNamespace`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The PrivateEndpointConnection name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: PrivateEndpointConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Remove-AzEventHubSchemaGroup.md b/azps-10.1.0/Az.EventHub/Remove-AzEventHubSchemaGroup.md new file mode 100644 index 0000000000..c38bfb214f --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Remove-AzEventHubSchemaGroup.md @@ -0,0 +1,217 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/remove-azeventhubschemagroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubSchemaGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Remove-AzEventHubSchemaGroup.md +--- + +# Remove-AzEventHubSchemaGroup + +## SYNOPSIS +Deletes an EventHub schema group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzEventHubSchemaGroup -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzEventHubSchemaGroup -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an EventHub schema group. + +## EXAMPLES + +### Example 1: Remove a Schema Group from an EventHub namespace +```powershell +Remove-AzEventHubSchemaGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name mySchemaGroup +``` + +Deletes a schema group `mySchemaGroup` from EventHub namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Schema Group name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SchemaGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The Namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group within the azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IEventHubIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Set-AzEventHub.md b/azps-10.1.0/Az.EventHub/Set-AzEventHub.md new file mode 100644 index 0000000000..959ae8b7cf --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Set-AzEventHub.md @@ -0,0 +1,505 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/set-azeventhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHub.md +--- + +# Set-AzEventHub + +## SYNOPSIS +Updates an EventHub Entity + +## SYNTAX + +### SetExpanded (Default) +``` +Set-AzEventHub -Name <String> -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-CaptureEnabled] [-Encoding <EncodingCaptureDescription>] [-IntervalInSeconds <Int32>] + [-SizeLimitInBytes <Int32>] [-SkipEmptyArchive] [-RetentionTimeInHour <Int64>] + [-TombstoneRetentionTimeInHour <Int32>] [-Status <EntityStatus>] [-DestinationName <String>] + [-StorageAccountResourceId <String>] [-ArchiveNameFormat <String>] [-BlobContainer <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzEventHub -InputObject <IEventHubIdentity> [-CaptureEnabled] [-Encoding <EncodingCaptureDescription>] + [-IntervalInSeconds <Int32>] [-SizeLimitInBytes <Int32>] [-SkipEmptyArchive] [-RetentionTimeInHour <Int64>] + [-TombstoneRetentionTimeInHour <Int32>] [-Status <EntityStatus>] [-DestinationName <String>] + [-StorageAccountResourceId <String>] [-ArchiveNameFormat <String>] [-BlobContainer <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an EventHub Entity + +## EXAMPLES + +### Example 1: Set capture on an existing EventHub entity +```powershell +Set-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -ArchiveNameFormat "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" -BlobContainer container -CaptureEnabled -DestinationName EventHubArchive.AzureBlockBlob -Encoding Avro -IntervalInSeconds 600 -SizeLimitInBytes 11000000 -SkipEmptyArchive -StorageAccountResourceId "/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" +``` + +```output +ArchiveNameFormat : {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} +BlobContainer : container +CaptureEnabled : True +CleanupPolicy : Delete +CreatedAt : 1/1/0001 12:00:00 AM +DataLakeAccountName : +DataLakeFolderPath : +DataLakeSubscriptionId : +DestinationName : EventHubArchive.AzureBlockBlob +Encoding : Avro +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/namespace3/eventhubs/myEventHub +IntervalInSeconds : 600 +Location : eastus +MessageRetentionInDay : 7 +Name : myEventHub +PartitionCount : 5 +PartitionId : {} +ResourceGroupName : myResourceGroup +RetentionTimeInHour : 168 +SizeLimitInBytes : 11000000 +SkipEmptyArchive : True +Status : Active +StorageAccountResourceId : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TombstoneRetentionTimeInHour : +Type : Microsoft.EventHub/namespaces/eventhubs +UpdatedAt : 1/1/0001 12:00:00 AM +``` + +Updates EventHub entity `myEventHub` from namespace `myNamespace` to enable capture on it. + +### Example 2: Update EventHub EventHub entity using InputObject parameter set +```powershell +$eventhub = Get-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace +Set-AzEventHub -InputObject $eventhub -RetentionTimeInHour 72 +``` + +```output +ArchiveNameFormat : {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} +BlobContainer : container1entHub]> +CaptureEnabled : True +CleanupPolicy : Delete +CreatedAt : 1/1/0001 12:00:00 AM +DataLakeAccountName : +DataLakeFolderPath : +DataLakeSubscriptionId : +DestinationName : EventHubArchive.AzureBlockBlob +Encoding : Avro +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub +IntervalInSeconds : 600 +Location : eastus +MessageRetentionInDay : 3 +Name : myEventHub +PartitionCount : 5 +PartitionId : {} +ResourceGroupName : myResourceGroup +RetentionTimeInHour : 72 +SizeLimitInBytes : 11000000 +SkipEmptyArchive : True +Status : Active +StorageAccountResourceId : /subscriptions/subscriptionId/resourceGroups/myResourcegroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount + 1 +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TombstoneRetentionTimeInHour : +Type : Microsoft.EventHub/namespaces/eventhubs +UpdatedAt : 1/1/0001 12:00:00 AM +``` + +Updates `RetentionTimeInHour` in EventHub entity `myEventHub` to 72 hours. + +## PARAMETERS + +### -ArchiveNameFormat +Blob naming convention for archive, e.g. +{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. +Here all the parameters (Namespace,EventHub .. +etc) are mandatory irrespective of order + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobContainer +Blob container Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CaptureEnabled +A value that indicates whether capture description is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationName +Name for capture destination + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Encoding +Enumerates the possible values for the encoding format of capture description. +Note: 'AvroDeflate' will be deprecated in New API Version + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.EncodingCaptureDescription +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.EventHub.Models.IEventHubIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntervalInSeconds +The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of EventHub Entity. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: EventHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionTimeInHour +Number of hours to retain the events for this Event Hub. +This value is only used when cleanupPolicy is Delete. +If cleanupPolicy is Compaction the returned value of this property is Long.MaxValue + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SizeLimitInBytes +The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipEmptyArchive +A value that indicates whether to Skip Empty Archives + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Enumerates the possible values for the status of the Event Hub. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.EntityStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Resource id of the storage account to be used to create the blobs + +```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. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TombstoneRetentionTimeInHour +Number of hours to retain the tombstone markers of a compacted Event Hub. +This value is only used when cleanupPolicy is Compaction. +Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IEventhub + +## 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 <IEventHubIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Set-AzEventHubApplicationGroup.md b/azps-10.1.0/Az.EventHub/Set-AzEventHubApplicationGroup.md new file mode 100644 index 0000000000..32fe664367 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Set-AzEventHubApplicationGroup.md @@ -0,0 +1,356 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/set-azeventhubapplicationgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubApplicationGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubApplicationGroup.md +--- + +# Set-AzEventHubApplicationGroup + +## SYNOPSIS +Sets an EventHub Application Group + +## SYNTAX + +### SetExpanded (Default) +``` +Set-AzEventHubApplicationGroup -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-ClientAppGroupIdentifier <String>] [-IsEnabled] + [-Policy <IApplicationGroupPolicy[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzEventHubApplicationGroup -InputObject <IEventHubIdentity> [-ClientAppGroupIdentifier <String>] + [-IsEnabled] [-Policy <IApplicationGroupPolicy[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets an EventHub Application Group + +## EXAMPLES + +### Example 1: Add throttling policies to an Application Group +```powershell +$t3 = New-AzEventHubThrottlingPolicyConfig -Name t3 -MetricId OutgoingMessages -RateLimitThreshold 12000 +$appGroup = Get-AzEventHubApplicationGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAppGroup +$appGroup.Policy += $t3 +Set-AzEventHubApplicationGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAppGroup -Policy $appGroup.Policy +``` + +```output +ClientAppGroupIdentifier : NamespaceSASKeyName=a +Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/applicationGroups/ + myAppGroup +IsEnabled : True +Location : Central US +Name : myAppGroup +Policy : {{ + "name": "t1", + "type": "ThrottlingPolicy", + "rateLimitThreshold": 10000, + "metricId": "IncomingMessages" + }, { + "name": "t2", + "type": "ThrottlingPolicy", + "rateLimitThreshold": 20000, + "metricId": "OutgoingBytes" + }, { + "name": "t3", + "type": "ThrottlingPolicy", + "rateLimitThreshold": 12000, + "metricId": "OutgoingMessages" + }} +ResourceGroupName : myResourceGroup +``` + +`-Policy` takes an array of Policy objects. +It represents the entire set of throttling policies defined on the appplication group and not just the one. +If you want to add or remove throttling policies, the right way to do it is to get the application group and query the Policy data member of the object returned as shown above. + +### Example 2: Update application group using InputObject parameter set +```powershell +$appGroup = Get-AzEventHubApplicationGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAppGroup +Set-AzEventHubApplicationGroup -InputObject $appGroup -IsEnabled:$false +``` + +```output +ClientAppGroupIdentifier : NamespaceSASKeyName=a +Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/applicationGroups/ + myAppGroup +IsEnabled : False +Location : Central US +Name : myAppGroup +Policy : {{ + "name": "t1", + "type": "ThrottlingPolicy", + "rateLimitThreshold": 10000, + "metricId": "IncomingMessages" + }, { + "name": "t2", + "type": "ThrottlingPolicy", + "rateLimitThreshold": 20000, + "metricId": "OutgoingBytes" + }, { + "name": "t3", + "type": "ThrottlingPolicy", + "rateLimitThreshold": 12000, + "metricId": "OutgoingMessages" + }} +ResourceGroupName : myResourceGroup +``` + +Disables application group `myAppGroup`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientAppGroupIdentifier +The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsEnabled +Determines if Application Group is allowed to create connection with namespace or not. +Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the Application Group. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: ApplicationGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +List of group policies that define the behavior of application group. +The policies can support resource governance scenarios such as limiting ingress or egress traffic. +To construct, see NOTES section for POLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IApplicationGroupPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IApplicationGroupPolicy[] + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +### System.Management.Automation.SwitchParameter + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IApplicationGroup + +## 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 <IEventHubIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`POLICY <IApplicationGroupPolicy[]>`: List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic. + - `Name <String>`: The Name of this policy + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Set-AzEventHubAuthorizationRule.md b/azps-10.1.0/Az.EventHub/Set-AzEventHubAuthorizationRule.md new file mode 100644 index 0000000000..8c30cadff2 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Set-AzEventHubAuthorizationRule.md @@ -0,0 +1,292 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/set-azeventhubauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubAuthorizationRule.md +--- + +# Set-AzEventHubAuthorizationRule + +## SYNOPSIS +Sets an EventHub Authorization Rule + +## SYNTAX + +### SetExpandedNamespace (Default) +``` +Set-AzEventHubAuthorizationRule -NamespaceName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String>] -Rights <AccessRights[]> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetExpandedEntity +``` +Set-AzEventHubAuthorizationRule -NamespaceName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String>] -EventHubName <String> -Rights <AccessRights[]> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzEventHubAuthorizationRule -InputObject <IEventHubIdentity> -Rights <AccessRights[]> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets an EventHub Authorization Rule + +## EXAMPLES + +### Example 1: Update an authorization rule for an EventHub namespace +```powershell +Set-AzEventHubAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAuthRule -Rights @('Manage', 'Send', 'Listen') +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/authorizationRules/myAuthRule +Location : Central US +Name : myAuthRule +ResourceGroupName : myResourceGroup +Rights : {Listen, Manage, Send} +``` + +Updates authorization rule `myAuthRule` on namespace `myNamespace`. + +### Example 2: Update an authorization rule for an EventHub entity +```powershell +Set-AzEventHubAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name myAuthRule -Rights @('Manage', 'Send', 'Listen') +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub/authorizationRules/myAuthRule +Location : Central US +Name : myAuthRule +ResourceGroupName : myResourceGroup +Rights : {Listen, Manage, Send} +``` + +Updates authorization rule `myAuthRule` on EventHubs entity `myEventHub` from namespace `myNamespace`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the EventHub entity. + +```yaml +Type: System.String +Parameter Sets: SetExpandedEntity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Authorization Rule + +```yaml +Type: System.String +Parameter Sets: SetExpandedNamespace, SetExpandedEntity +Aliases: AuthorizationRuleName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: SetExpandedNamespace, SetExpandedEntity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpandedNamespace, SetExpandedEntity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rights +The rights associated with the rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.AccessRights[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SetExpandedNamespace, SetExpandedEntity +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IAuthorizationRule + +## 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 <IEventHubIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Set-AzEventHubCluster.md b/azps-10.1.0/Az.EventHub/Set-AzEventHubCluster.md new file mode 100644 index 0000000000..d70e069422 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Set-AzEventHubCluster.md @@ -0,0 +1,287 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/set-azeventhubcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubCluster.md +--- + +# Set-AzEventHubCluster + +## SYNOPSIS +Sets an EventHub Cluster + +## SYNTAX + +### SetExpanded (Default) +``` +Set-AzEventHubCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Capacity <Int32>] + [-Tag <ITrackedResourceTags>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzEventHubCluster -InputObject <IEventHubIdentity> [-Capacity <Int32>] [-Tag <ITrackedResourceTags>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets an EventHub Cluster + +## EXAMPLES + +### Example 1: Update EventHubs dedicated cluster +```powershell +Set-AzEventHubCluster -ResourceGroupName myResourceGroup -Name myCluster -Capacity 3 +``` + +```output +Capacity : 3 +CreatedAt : 2022-08-29T09:38:30.453Z +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/clusters/myCluster +Location : australiaeast +MetricId : PROD-00-000 +Name : myCluster +ResourceGroupName : myResourceGroup +SkuName : Dedicated +Status : +SupportsScaling : False +Tag : {} +``` + +Updates the capacity of an EventHubs dedicated cluster to 3. + +### Example 2: Update EventHubs dedicated cluster using InputObject parameter set +```powershell +$cluster = Get-AzEventHubCluster -ResourceGroupName myResourceGroup -Name myCluster +Set-AzEventHubCluster -InputObject $cluster -Capacity 3 +``` + +```output +Capacity : 3 +CreatedAt : 2022-08-29T09:38:30.453Z +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/clusters/myCluster +Location : australiaeast +MetricId : PROD-00-000 +Name : myCluster +ResourceGroupName : myResourceGroup +SkuName : Dedicated +Status : +SupportsScaling : False +Tag : {} +``` + +Updates the capacity of an EventHubs dedicated cluster to 3. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Capacity +The quantity of Event Hubs Cluster Capacity Units contained in this cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the EventHub Dedicated Cluster + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. +To construct, see NOTES section for TAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api10.ITrackedResourceTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.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 <IEventHubIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`TAG <ITrackedResourceTags>`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Set-AzEventHubConsumerGroup.md b/azps-10.1.0/Az.EventHub/Set-AzEventHubConsumerGroup.md new file mode 100644 index 0000000000..1498f74950 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Set-AzEventHubConsumerGroup.md @@ -0,0 +1,294 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/set-azeventhubconsumergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubConsumerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubConsumerGroup.md +--- + +# Set-AzEventHubConsumerGroup + +## SYNOPSIS +Sets an EventHub Consumer Group + +## SYNTAX + +### SetExpanded (Default) +``` +Set-AzEventHubConsumerGroup -Name <String> -NamespaceName <String> -EventHubName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] -UserMetadata <String> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzEventHubConsumerGroup -InputObject <IEventHubIdentity> -UserMetadata <String> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets an EventHub Consumer Group + +## EXAMPLES + +### Example 1: Update EventHub Consumer Group +```powershell +Set-AzEventHubConsumerGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name myConsumerGroup -UserMetadata "Example Metadata" +``` + +```output +CreatedAt : 9/13/2022 9:20:47 AM +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace + /eventhubs/eh1/consumergroups/myConsumerGroup +Location : australiaeast +Name : myConsumerGroup +ResourceGroupName : myResourceGroup +UpdatedAt : 9/13/2022 9:20:47 AM +UserMetadata : Example Metadata +``` + +Updates consumer group `myConsumerGroup` created under EventHub entity `myEventHub`. + +### Example 2: Update EventHub Consumer Group using InputObject parameter set +```powershell +$consumerGroup = Get-AzEventHubConsumerGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name myConsumerGroup +Set-AzEventHubConsumerGroup -InputObject $consumerGroup -UserMetadata "Example Metadata" +``` + +```output +CreatedAt : 9/13/2022 9:20:47 AM +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace + /eventhubs/eh1/consumergroups/myConsumerGroup +Location : australiaeast +Name : myConsumerGroup +ResourceGroupName : myResourceGroup +UpdatedAt : 9/13/2022 9:20:47 AM +UserMetadata : Example Metadata +``` + +Updates consumer group `myConsumerGroup` created under EventHub entity `myEventHub`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of EventHub + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Consumer Group. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: ConsumerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserMetadata +User Metadata is a placeholder to store user-defined string data with maximum length 1024. +e.g. +it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IConsumerGroup + +## 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 <IEventHubIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Set-AzEventHubGeoDRConfigurationBreakPair.md b/azps-10.1.0/Az.EventHub/Set-AzEventHubGeoDRConfigurationBreakPair.md new file mode 100644 index 0000000000..fcb63b5b99 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Set-AzEventHubGeoDRConfigurationBreakPair.md @@ -0,0 +1,232 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/set-azeventhubgeodrconfigurationbreakpair +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubGeoDRConfigurationBreakPair.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubGeoDRConfigurationBreakPair.md +--- + +# Set-AzEventHubGeoDRConfigurationBreakPair + +## SYNOPSIS +This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces + +## SYNTAX + +### Break (Default) +``` +Set-AzEventHubGeoDRConfigurationBreakPair -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BreakViaIdentity +``` +Set-AzEventHubGeoDRConfigurationBreakPair -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces + +## EXAMPLES + +### Example 1: Break Pairing between Primary and Secondary namespace +```powershell +Set-AzEventHubGeoDRConfigurationBreakPair -ResourceGroupName myResourceGroup -NamespaceName myPrimaryNamespace -Name myAlias +``` + +Break Pairing between primary namespace `myPrimaryNamespace` and it's secondary namespace. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: BreakViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Consumer Group. + +```yaml +Type: System.String +Parameter Sets: Break +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: Break +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Break +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Break +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IEventHubIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Set-AzEventHubGeoDRConfigurationFailOver.md b/azps-10.1.0/Az.EventHub/Set-AzEventHubGeoDRConfigurationFailOver.md new file mode 100644 index 0000000000..06a9a73ff0 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Set-AzEventHubGeoDRConfigurationFailOver.md @@ -0,0 +1,232 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/set-azeventhubgeodrconfigurationfailover +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubGeoDRConfigurationFailOver.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubGeoDRConfigurationFailOver.md +--- + +# Set-AzEventHubGeoDRConfigurationFailOver + +## SYNOPSIS +Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace + +## SYNTAX + +### Fail (Default) +``` +Set-AzEventHubGeoDRConfigurationFailOver -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### FailViaIdentity +``` +Set-AzEventHubGeoDRConfigurationFailOver -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace + +## EXAMPLES + +### Example 1: Fail Over to secondary namespace of an alias +```powershell +Set-AzEventHubGeoDRConfigurationFailOver -ResourceGroupName myResourceGroup -NamespaceName mySecondaryNamespace -Name myAlias +``` + +Fails over to `mySecondaryNamespace` which is secondary namespace of alias `myAlias`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: FailViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Consumer Group. + +```yaml +Type: System.String +Parameter Sets: Fail +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: Fail +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Fail +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Fail +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IEventHubIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Set-AzEventHubNamespace.md b/azps-10.1.0/Az.EventHub/Set-AzEventHubNamespace.md new file mode 100644 index 0000000000..73e1b2d0b6 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Set-AzEventHubNamespace.md @@ -0,0 +1,730 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/set-azeventhubnamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubNamespace.md +--- + +# Set-AzEventHubNamespace + +## SYNOPSIS +Updates an EventHub Namespace + +## SYNTAX + +### SetExpanded (Default) +``` +Set-AzEventHubNamespace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AlternateName <String>] [-DisableLocalAuth] [-KeyVaultProperty <IKeyVaultProperties[]>] + [-RequireInfrastructureEncryption] [-IdentityType <ManagedServiceIdentityType>] + [-UserAssignedIdentityId <String[]>] [-EnableAutoInflate] [-MaximumThroughputUnit <Int32>] + [-MinimumTlsVersion <String>] [-PublicNetworkAccess <PublicNetworkAccess>] [-SkuCapacity <Int32>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzEventHubNamespace -InputObject <IEventHubIdentity> [-AlternateName <String>] [-DisableLocalAuth] + [-KeyVaultProperty <IKeyVaultProperties[]>] [-RequireInfrastructureEncryption] + [-IdentityType <ManagedServiceIdentityType>] [-UserAssignedIdentityId <String[]>] [-EnableAutoInflate] + [-MaximumThroughputUnit <Int32>] [-MinimumTlsVersion <String>] [-PublicNetworkAccess <PublicNetworkAccess>] + [-SkuCapacity <Int32>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates an EventHub Namespace + +## EXAMPLES + +### Example 1: Add a ManagedIdentity to an EventHub namespace +```powershell +$eventHubNamespace = Get-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace + +$identityId = $eventHubNamespace.UserAssignedIdentity.Keys + +$identityId += "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" + +Set-AzEventHubNamespace -InputObject $eventHubNamespace -UserAssignedIdentityId $identityId +``` + +```output +AlternateName : +ClusterArmId : +CreatedAt : 11/17/2022 2:56:32 PM +DisableLocalAuth : False +EnableAutoInflate : False +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +IdentityType : UserAssigned +KafkaEnabled : True +KeySource : Microsoft.KeyVault +KeyVaultProperty : {{ + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key1", + "keyVaultUri": "https://testkeyvault.vault.azure.net/", + "keyVersion": "" + }, { + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key2", + "keyVaultUri": "https://testkeyvault.vault.azure.net/", + "keyVersion": "" + }, { + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key3", + "keyVaultUri": "https://testkeyvault.vault.azure.net/", + "keyVersion": "" + }} +Location : North Europe +MaximumThroughputUnit : 0 +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : False +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Premium +SkuTier : Premium +Status : Active +Tag : { + } +TenantId : +Type : Microsoft.EventHub/Namespaces +UpdatedAt : 11/17/2022 3:03:50 PM +UserAssignedIdentity : { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + }, + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + } + } +ZoneRedundant : True +``` + +The output type of New and Set cmdlets `IEhNamespace` has a property named `UserAssignedIdentity` which is a hashtable. +The keys +of this hastable are the resource ID's of the managed identities the namespace is part of. +To add or remove an IdentityId, extract the +keys from the hashtable, which would result in an array of strings which can then be queried and fed as input to set cmdlet as shown above. + +### Example 2: Add a KeyVaultProperty to an existing EventHub Namespace +```powershell +$eventHubNamespace = Get-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace + +$newKeyVaultProperty = New-AzEventHubKeyVaultPropertiesObject -KeyName key3 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + +$eventHubNamespace.KeyVaultProperty += $newKeyVaultProperty + +Set-AzEventHubNamespace -InputObject $eventHubNamespace -KeyVaultProperty $eventHubNamespace.KeyVaultProperty +``` + +```output +AlternateName : +ClusterArmId : +CreatedAt : 11/17/2022 2:56:32 PM +DisableLocalAuth : False +EnableAutoInflate : False +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +IdentityType : UserAssigned +KafkaEnabled : True +KeySource : Microsoft.KeyVault +KeyVaultProperty : {{ + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key1", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }, { + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key2", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }, { + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key3", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }} +Location : North Europe +MaximumThroughputUnit : 0 +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : False +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Premium +SkuTier : Premium +Status : Active +Tag : { + } +TenantId : +Type : Microsoft.EventHub/Namespaces +UpdatedAt : 11/17/2022 3:03:50 PM +UserAssignedIdentity : { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + }, + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + } + } +ZoneRedundant : True +``` + +Adds a new KeyVaultProperty to EventHub namespace `myNamespace`. + +### Example 3: Remove a KeyVaultProperty from an existing EventHub Namespace +```powershell +$eventHubNamespace = Get-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace + +# Remove the last KeyVaultProperty from the list of KeyVaultProperties +$eventHubNamespace.KeyVaultProperty = $eventHubNamespace.KeyVaultProperty | Where-Object { $_ -ne $eventHubNamespace.KeyVaultProperty[2] } + +Set-AzEventHubNamespace -InputObject $eventHubNamespace -KeyVaultProperty $eventHubNamespace.KeyVaultProperty +``` + +```output +AlternateName : +ClusterArmId : +CreatedAt : 11/17/2022 2:56:32 PM +DisableLocalAuth : False +EnableAutoInflate : False +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +IdentityType : UserAssigned +KafkaEnabled : True +KeySource : Microsoft.KeyVault +KeyVaultProperty : {{ + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key1", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }, { + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key2", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }} +Location : North Europe +MaximumThroughputUnit : 0 +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : False +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Premium +SkuTier : Premium +Status : Active +Tag : { + } +TenantId : +Type : Microsoft.EventHub/Namespaces +UpdatedAt : 11/17/2022 3:03:50 PM +UserAssignedIdentity : { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + }, + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + } + } +ZoneRedundant : True +``` + +Removes a new KeyVaultProperty to EventHub namespace `myNamespace`. + +### Example 4: Set DisableLocalAuth to true on an existing EventHub namespace +```powershell +Set-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace -DisableLocalAuth +``` + +```output +AlternateName : +ClusterArmId : +CreatedAt : 11/17/2022 2:56:32 PM +DisableLocalAuth : False +EnableAutoInflate : False +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +IdentityType : UserAssigned +KafkaEnabled : True +KeySource : Microsoft.KeyVault +KeyVaultProperty : {{ + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key1", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }, { + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key2", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }} +Location : North Europe +MaximumThroughputUnit : 0 +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : False +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Premium +SkuTier : Premium +Status : Active +Tag : { + } +TenantId : +Type : Microsoft.EventHub/Namespaces +UpdatedAt : 11/17/2022 3:03:50 PM +UserAssignedIdentity : { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + }, + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + } + } +ZoneRedundant : True +``` + +Sets `DisableLocalAuth` to true on an EventHub namespace `myNamespace`. + +### Example 5: # Create a namespace with UserAssignedIdentity and use Set-Az cmdlet to set IdentityType to None. +```powershell +$eventHubNamespace = New-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$eventHubNamespace = Set-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace -IdentityType None -UserAssignedIdentityId @() +``` + +```output +AlternateName : +ClusterArmId : +CreatedAt : 11/21/2022 3:21:29 PM +DisableLocalAuth : False +EnableAutoInflate : False +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/provide + rs/Microsoft.EventHub/namespaces/myNamespace +IdentityType : +KafkaEnabled : True +KeySource : +KeyVaultProperty : +Location : North Europe +MaximumThroughputUnit : 0 +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Premium +SkuTier : Premium +Status : Active +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : { + } +TenantId : +Type : Microsoft.EventHub/Namespaces +UpdatedAt : 11/21/2022 3:31:03 PM +UserAssignedIdentity : { + } +ZoneRedundant : True +``` + +Created a namespace with UserAssignedIdentity and use Set-Az cmdlet to set IdentityType to None. + +## PARAMETERS + +### -AlternateName +Alternate name specified when alias and namespace names are same + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +This property disables SAS authentication for the Event Hubs namespace. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoInflate +Value that indicates whether AutoInflate is enabled for eventhub namespace. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.ManagedServiceIdentityType +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.EventHub.Models.IEventHubIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyVaultProperty +Properties to configure Encryption +To construct, see NOTES section for KEYVAULTPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IKeyVaultProperties[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumThroughputUnit +Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. +( '0' if AutoInflateEnabled = true) + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +The minimum TLS version for the cluster to support, e.g. +'1.2' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of EventHub namespace. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +This determines if traffic is allowed over public network. +By default it is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireInfrastructureEncryption +Enable Infrastructure Encryption (Double Encryption) + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. +The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. + +```yaml +Type: System.Int32 +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. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag of EventHub Namespace. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +Properties for User Assigned Identities + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.IEhNamespace + +## NOTES + +ALIASES + +Set-AzEventHubNamespaceV2 + +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 <IEventHubIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`KEYVAULTPROPERTY <IKeyVaultProperties[]>`: Properties to configure Encryption + - `[KeyName <String>]`: Name of the Key from KeyVault + - `[KeyVaultUri <String>]`: Uri of KeyVault + - `[KeyVersion <String>]`: Key Version + - `[UserAssignedIdentity <String>]`: ARM ID of user Identity selected for encryption + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Set-AzEventHubNetworkRuleSet.md b/azps-10.1.0/Az.EventHub/Set-AzEventHubNetworkRuleSet.md new file mode 100644 index 0000000000..5e19c778ad --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Set-AzEventHubNetworkRuleSet.md @@ -0,0 +1,387 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/set-azeventhubnetworkruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubNetworkRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Set-AzEventHubNetworkRuleSet.md +--- + +# Set-AzEventHubNetworkRuleSet + +## SYNOPSIS +Sets an EventHub Namespace Network Rule Set + +## SYNTAX + +### SetExpanded (Default) +``` +Set-AzEventHubNetworkRuleSet -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-TrustedServiceAccessEnabled] [-DefaultAction <DefaultAction>] + [-IPRule <INwRuleSetIPRules[]>] [-VirtualNetworkRule <INwRuleSetVirtualNetworkRules[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzEventHubNetworkRuleSet -InputObject <IEventHubIdentity> [-PublicNetworkAccess <PublicNetworkAccess>] + [-TrustedServiceAccessEnabled] [-DefaultAction <DefaultAction>] [-IPRule <INwRuleSetIPRules[]>] + [-VirtualNetworkRule <INwRuleSetVirtualNetworkRules[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets an EventHub Namespace Network Rule Set + +## EXAMPLES + +### Example 1: Add IP Rules and Virtual Network Rules to a Network Rule Set +```powershell +$ipRule1 = New-AzEventHubIPRuleConfig -IPMask 2.2.2.2 -Action Allow +$ipRule2 = New-AzEventHubIPRuleConfig -IPMask 3.3.3.3 -Action Allow +$virtualNetworkRule1 = New-AzEventHubVirtualNetworkRuleConfig -SubnetId '/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default' +$networkRuleSet = Get-AzEventHubNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace +$networkRuleSet.IPRule += $ipRule1 +$networkRuleSet.IPRule += $ipRule2 +$networkRuleSet.VirtualNetworkRule += $virtualNetworkRule1 +Set-AzEventHubNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -IPRule $ipRule1,$ipRule2 -VirtualNetworkRule $virtualNetworkRule1,$virtualNetworkRule2,$virtualNetworkRule3 +``` + +```output +DefaultAction : Deny +IPRule : {{ + "ipMask": "1.1.1.1", + "action": "Allow" + }, { + "ipMask": "2.2.2.2", + "action": "Allow" + }, { + "ipMask": "3.3.3.3", + "action": "Allow" + }} +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/networkRuleSets/ + default +Location : Australia East +Name : default +PublicNetworkAccess : Enabled +ResourceGroupName : Default-EventHub-6229 +TrustedServiceAccessEnabled : +Type : Microsoft.EventHub/Namespaces/NetworkRuleSets +VirtualNetworkRule : {{ + "subnet": { + "id": "/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default" + }, + "ignoreMissingVnetServiceEndpoint": false + },{ + "subnet": { + "id": "/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/mySubnet" + }, + "ignoreMissingVnetServiceEndpoint": false + }} +``` + +Appends virtual network rules and IPRules to the existing rules. + +### Example 2: Enable Trusted Service Access on a namespace +```powershell +Set-AzEventHubNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TrustedServiceAccessEnabled +``` + +```output +DefaultAction : Deny +IPRule : {{ + "ipMask": "1.1.1.1", + "action": "Allow" + }, { + "ipMask": "2.2.2.2", + "action": "Allow" + }, { + "ipMask": "3.3.3.3", + "action": "Allow" + }} +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/networkRuleSets/ + default +Location : Australia East +Name : default +PublicNetworkAccess : Enabled +ResourceGroupName : myResourceGroup +TrustedServiceAccessEnabled : True +Type : Microsoft.EventHub/Namespaces/NetworkRuleSets +VirtualNetworkRule : {{ + "subnet": { + "id": "/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default" + }, + "ignoreMissingVnetServiceEndpoint": false + },{ + "subnet": { + "id": "/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/mySubnet" + }, + "ignoreMissingVnetServiceEndpoint": false + }} +``` + +Enabled Trusted Service Access on the eventhub namespace `myNamespace`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAction +Default Action for Network Rule Set + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.DefaultAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IPRule +List of IpRules +To construct, see NOTES section for IPRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.INwRuleSetIPRules[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +This determines if traffic is allowed over public network. +By default it is enabled. +If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedServiceAccessEnabled +Value that indicates whether Trusted Service Access is Enabled or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRule +List of VirtualNetwork Rules +To construct, see NOTES section for VIRTUALNETWORKRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.INwRuleSetVirtualNetworkRules[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.INetworkRuleSet + +## 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 <IEventHubIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[ApplicationGroupName <String>]`: The Application Group name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ClusterName <String>]`: The name of the Event Hubs Cluster. + - `[ConsumerGroupName <String>]`: The consumer group name + - `[EventHubName <String>]`: The Event Hub name + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The Namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[ResourceAssociationName <String>]`: The ResourceAssociation Name + - `[ResourceGroupName <String>]`: Name of the resource group within the azure subscription. + - `[SchemaGroupName <String>]`: The Schema Group name + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`IPRULE <INwRuleSetIPRules[]>`: List of IpRules + - `[Action <NetworkRuleIPAction?>]`: The IP Filter Action + - `[IPMask <String>]`: IP Mask + +`VIRTUALNETWORKRULE <INwRuleSetVirtualNetworkRules[]>`: List of VirtualNetwork Rules + - `[IgnoreMissingVnetServiceEndpoint <Boolean?>]`: Value that indicates whether to ignore missing Vnet Service Endpoint + - `[SubnetId <String>]`: Resource ID of Virtual Network Subnet + +## RELATED LINKS diff --git a/azps-10.1.0/Az.EventHub/Test-AzEventHubName.md b/azps-10.1.0/Az.EventHub/Test-AzEventHubName.md new file mode 100644 index 0000000000..8ed1ad0ac4 --- /dev/null +++ b/azps-10.1.0/Az.EventHub/Test-AzEventHubName.md @@ -0,0 +1,180 @@ +--- +external help file: Az.EventHub-help.xml +Module Name: Az.EventHub +online version: https://learn.microsoft.com/powershell/module/az.eventhub/test-azeventhubname +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Test-AzEventHubName.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/EventHub/EventHub/help/Test-AzEventHubName.md +--- + +# Test-AzEventHubName + +## SYNOPSIS +Checks availability of a namespace name or disaster recovery alias. + +## SYNTAX + +### NamespaceAvailability (Default) +``` +Test-AzEventHubName -NamespaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [<CommonParameters>] +``` + +### AliasAvailability +``` +Test-AzEventHubName -NamespaceName <String> [-SubscriptionId <String>] -AliasName <String> + -ResourceGroupName <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +## DESCRIPTION +Checks availability of a namespace name or disaster recovery alias. + +## EXAMPLES + +### Example 1: Check the availability of an EventHub namespace name +```powershell +Test-AzEventHubName -NamespaceName myNamespace +``` + +```output +Message NameAvailable Reason +------- ------------- ------ +The specified name is not available. For more information visit https://aka.ms/eventhubsarmexceptions. False NameInUse +``` + +Checks the availability of namespace name `myNamespace`. + +### Example 2: Check the availability of an EventHub Geo Disaster Recovery Alias +```powershell +Test-AzEventHubName -NamespaceName myNamespace -ResourceGroupName myResourceGroup -AliasName myAlias +``` + +```output +Message NameAvailable Reason +------- ------------- ------ +The specified name is not available. For more information visit https://aka.ms/eventhubsarmexceptions. False NameInUse +``` + +Checks the availability of alias name `myAlias` on namespace `myNamepace`. + +## PARAMETERS + +### -AliasName +The name of Disaster Recovery Config alias. + +```yaml +Type: System.String +Parameter Sets: AliasAvailability +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of EventHub namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource + +```yaml +Type: System.String +Parameter Sets: AliasAvailability +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api20221001Preview.ICheckNameAvailabilityResult + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FluidRelay/Az.FluidRelay.md b/azps-10.1.0/Az.FluidRelay/Az.FluidRelay.md new file mode 100644 index 0000000000..f774bcba28 --- /dev/null +++ b/azps-10.1.0/Az.FluidRelay/Az.FluidRelay.md @@ -0,0 +1,39 @@ +--- +Module Name: Az.FluidRelay +Module Guid: 5b50d9cb-6a6c-43c3-9cbf-24c0c7233926 +Download Help Link: https://learn.microsoft.com/powershell/module/az.fluidrelay +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Az.FluidRelay.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Az.FluidRelay.md +--- + +# Az.FluidRelay Module +## Description +Microsoft Azure PowerShell: FluidRelay cmdlets + +## Az.FluidRelay Cmdlets +### [Get-AzFluidRelayContainer](Get-AzFluidRelayContainer.md) +Get a Fluid Relay container. + +### [Get-AzFluidRelayServer](Get-AzFluidRelayServer.md) +Get a Fluid Relay server. + +### [Get-AzFluidRelayServerKey](Get-AzFluidRelayServerKey.md) +Get primary and secondary key for this server. + +### [New-AzFluidRelayServer](New-AzFluidRelayServer.md) +Create or Update a Fluid Relay server. + +### [New-AzFluidRelayServerKey](New-AzFluidRelayServerKey.md) +Regenerate the primary or secondary key for this server. + +### [Remove-AzFluidRelayContainer](Remove-AzFluidRelayContainer.md) +Delete a Fluid Relay container. + +### [Remove-AzFluidRelayServer](Remove-AzFluidRelayServer.md) +Delete a Fluid Relay server. + +### [Update-AzFluidRelayServer](Update-AzFluidRelayServer.md) +Update a Fluid Relay server. + diff --git a/azps-10.1.0/Az.FluidRelay/Get-AzFluidRelayContainer.md b/azps-10.1.0/Az.FluidRelay/Get-AzFluidRelayContainer.md new file mode 100644 index 0000000000..3c583115e5 --- /dev/null +++ b/azps-10.1.0/Az.FluidRelay/Get-AzFluidRelayContainer.md @@ -0,0 +1,189 @@ +--- +external help file: +Module Name: Az.FluidRelay +online version: https://learn.microsoft.com/powershell/module/az.fluidrelay/get-azfluidrelaycontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Get-AzFluidRelayContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Get-AzFluidRelayContainer.md +--- + +# Get-AzFluidRelayContainer + +## SYNOPSIS +Get a Fluid Relay container. + +## SYNTAX + +### List (Default) +``` +Get-AzFluidRelayContainer -FluidRelayServerName <String> -ResourceGroup <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzFluidRelayContainer -FluidRelayServerName <String> -Name <String> -ResourceGroup <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzFluidRelayContainer -InputObject <IFluidRelayIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a Fluid Relay container. + +## EXAMPLES + +### Example 1: List Fluid Relay container. +```powershell +Get-AzFluidRelayContainer -FluidRelayServerName azps-fluidrelay -ResourceGroup azpstest-gp +``` + +```output +Name CreationTime LastAccessTime ResourceGroupName +---- ------------ -------------- ----------------- +eb4dd5f6-531f-44e1-86e3-759d39d1010c 2022-06-16 02:35:16 AM 2022-06-16 02:58:55 AM azpstest-gp +5affba7d-d288-42c9-9ed2-6d50fbf7ec98 2022-06-16 03:22:45 AM azpstest-gp +``` + +List Fluid Relay container. +Read and execute this document [Quickstart: Dice roller](https://learn.microsoft.com/en-us/azure/azure-fluid-relay/quickstarts/quickstart-dice-roll) to complete setup of the environment. + +### Example 2:Get a Fluid Relay container. +```powershell +Get-AzFluidRelayContainer -FluidRelayServerName azps-fluidrelay -ResourceGroup azpstest-gp -Name eb4dd5f6-531f-44e1-86e3-759d39d1010c +``` + +```output +Name CreationTime LastAccessTime ResourceGroupName +---- ------------ -------------- ----------------- +eb4dd5f6-531f-44e1-86e3-759d39d1010c 2022-06-16 02:35:16 AM 2022-06-16 02:58:55 AM azpstest-gp +``` + +Get a Fluid Relay container. +Read and execute this document [Quickstart: Dice roller](https://learn.microsoft.com/en-us/azure/azure-fluid-relay/quickstarts/quickstart-dice-roll) to complete setup of the environment. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FluidRelayServerName +The Fluid Relay server resource name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.IFluidRelayIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Fluid Relay container resource name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: FluidRelayContainerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +The resource group containing the resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription id (GUID) for this resource. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.IFluidRelayIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.Api20220601.IFluidRelayContainer + +## 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 `<IFluidRelayIdentity>`: Identity Parameter + - `[FluidRelayContainerName <String>]`: The Fluid Relay container resource name. + - `[FluidRelayServerName <String>]`: The Fluid Relay server resource name. + - `[Id <String>]`: Resource identity path + - `[ResourceGroup <String>]`: The resource group containing the resource. + - `[SubscriptionId <String>]`: The subscription id (GUID) for this resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.FluidRelay/Get-AzFluidRelayServer.md b/azps-10.1.0/Az.FluidRelay/Get-AzFluidRelayServer.md new file mode 100644 index 0000000000..33a78d773b --- /dev/null +++ b/azps-10.1.0/Az.FluidRelay/Get-AzFluidRelayServer.md @@ -0,0 +1,189 @@ +--- +external help file: +Module Name: Az.FluidRelay +online version: https://learn.microsoft.com/powershell/module/az.fluidrelay/get-azfluidrelayserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Get-AzFluidRelayServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Get-AzFluidRelayServer.md +--- + +# Get-AzFluidRelayServer + +## SYNOPSIS +Get a Fluid Relay server. + +## SYNTAX + +### List (Default) +``` +Get-AzFluidRelayServer [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzFluidRelayServer -Name <String> -ResourceGroup <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzFluidRelayServer -InputObject <IFluidRelayIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzFluidRelayServer -ResourceGroup <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a Fluid Relay server. + +## EXAMPLES + +### Example 1: List Fluid Relay server. +```powershell +Get-AzFluidRelayServer +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westus2 azps-fluidrelay azpstest-gp +``` + +List Fluid Relay server. + +### Example 2: List Fluid Relay server by ResourceGroup. +```powershell +Get-AzFluidRelayServer -ResourceGroup azpstest-gp +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westus2 azps-fluidrelay azpstest-gp +``` + +List Fluid Relay server. + +### Example 3: Get a Fluid Relay server by ResourceGroup. +```powershell +Get-AzFluidRelayServer -Name azps-fluidrelay -ResourceGroup azpstest-gp +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westus2 azps-fluidrelay azpstest-gp +``` + +Get a Fluid Relay server. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.IFluidRelayIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Fluid Relay server resource name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: FluidRelayServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +The resource group containing the resource. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription id (GUID) for this resource. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.IFluidRelayIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.Api20220601.IFluidRelayServer + +## 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 `<IFluidRelayIdentity>`: Identity Parameter + - `[FluidRelayContainerName <String>]`: The Fluid Relay container resource name. + - `[FluidRelayServerName <String>]`: The Fluid Relay server resource name. + - `[Id <String>]`: Resource identity path + - `[ResourceGroup <String>]`: The resource group containing the resource. + - `[SubscriptionId <String>]`: The subscription id (GUID) for this resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.FluidRelay/Get-AzFluidRelayServerKey.md b/azps-10.1.0/Az.FluidRelay/Get-AzFluidRelayServerKey.md new file mode 100644 index 0000000000..28e4e4eb49 --- /dev/null +++ b/azps-10.1.0/Az.FluidRelay/Get-AzFluidRelayServerKey.md @@ -0,0 +1,147 @@ +--- +external help file: +Module Name: Az.FluidRelay +online version: https://learn.microsoft.com/powershell/module/az.fluidrelay/get-azfluidrelayserverkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Get-AzFluidRelayServerKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Get-AzFluidRelayServerKey.md +--- + +# Get-AzFluidRelayServerKey + +## SYNOPSIS +Get primary and secondary key for this server. + +## SYNTAX + +``` +Get-AzFluidRelayServerKey -FluidRelayServerName <String> -ResourceGroup <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Get primary and secondary key for this server. + +## EXAMPLES + +### Example 1: Get primary and secondary key for this server. +```powershell +Get-AzFluidRelayServerKey -FluidRelayServerName azps-fluidrelay -ResourceGroup azpstest-gp +``` + +```output + Key1 Key2 + ---- ---- +System.Security.SecureString System.Security.SecureString +``` + +Get primary and secondary key for this server. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FluidRelayServerName +The Fluid Relay server resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +The resource group containing the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription id (GUID) for this resource. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.Api20220601.IFluidRelayServerKeys + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.FluidRelay/New-AzFluidRelayServer.md b/azps-10.1.0/Az.FluidRelay/New-AzFluidRelayServer.md new file mode 100644 index 0000000000..659940339a --- /dev/null +++ b/azps-10.1.0/Az.FluidRelay/New-AzFluidRelayServer.md @@ -0,0 +1,292 @@ +--- +external help file: +Module Name: Az.FluidRelay +online version: https://learn.microsoft.com/powershell/module/az.fluidrelay/new-azfluidrelayserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/New-AzFluidRelayServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/New-AzFluidRelayServer.md +--- + +# New-AzFluidRelayServer + +## SYNOPSIS +Create or Update a Fluid Relay server. + +## SYNTAX + +``` +New-AzFluidRelayServer -Name <String> -ResourceGroup <String> -Location <String> [-SubscriptionId <String>] + [-CustomerManagedKeyEncryptionKeyUrl <String>] [-IdentityType <ResourceIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-KeyEncryptionKeyIdentityType <CmkIdentityType>] + [-KeyEncryptionKeyIdentityUserAssignedIdentityResourceId <String>] [-ProvisioningState <ProvisioningState>] + [-Storagesku <StorageSku>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or Update a Fluid Relay server. + +## EXAMPLES + +### Example 1: Create or Update a Fluid Relay server. +```powershell +New-AzFluidRelayServer -Name azps-fluidrelay -ResourceGroup azpstest-gp -Location westus2 -Storagesku 'basic' -ProvisioningState 'Succeeded' -IdentityUserAssignedIdentity @{"/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/azpstest-gp/providers/Microsoft.ManagedIdentity/userAssignedIdentities/azpstest-uami" = @{};} -IdentityType 'UserAssigned' -KeyEncryptionKeyIdentityUserAssignedIdentityResourceId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/azpstest-gp/providers/Microsoft.ManagedIdentity/userAssignedIdentities/azpstest-uami" -KeyEncryptionKeyIdentityType 'SystemAssigned' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westus2 azps-fluidrelay azpstest-gp +``` + +Create or Update a Fluid Relay server. + +## PARAMETERS + +### -CustomerManagedKeyEncryptionKeyUrl +key encryption key Url, with or without a version. +Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. +Key auto rotation is enabled by providing a key uri without version. +Otherwise, customer is responsible for rotating the key. +The keyEncryptionKeyIdentity(either SystemAssigned or UserAssigned) should have permission to access this key url. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +The list of user identities associated with the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyIdentityType +Values can be SystemAssigned or UserAssigned + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Support.CmkIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyIdentityUserAssignedIdentityResourceId +user assigned identity to use for accessing key encryption key Url. +Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/\<resource group\>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. +Mutually exclusive with identityType systemAssignedIdentity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Fluid Relay server resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FluidRelayServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisioningState +Provision states for FluidRelay RP + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Support.ProvisioningState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +The resource group containing the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Storagesku +Sku of the storage associated with the resource + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Support.StorageSku +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription id (GUID) for this resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.Api20220601.IFluidRelayServer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.FluidRelay/New-AzFluidRelayServerKey.md b/azps-10.1.0/Az.FluidRelay/New-AzFluidRelayServerKey.md new file mode 100644 index 0000000000..cece3dfd11 --- /dev/null +++ b/azps-10.1.0/Az.FluidRelay/New-AzFluidRelayServerKey.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.FluidRelay +online version: https://learn.microsoft.com/powershell/module/az.fluidrelay/new-azfluidrelayserverkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/New-AzFluidRelayServerKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/New-AzFluidRelayServerKey.md +--- + +# New-AzFluidRelayServerKey + +## SYNOPSIS +Regenerate the primary or secondary key for this server. + +## SYNTAX + +### RegenerateExpanded (Default) +``` +New-AzFluidRelayServerKey -FluidRelayServerName <String> -ResourceGroup <String> -KeyName <KeyName> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RegenerateViaIdentityExpanded +``` +New-AzFluidRelayServerKey -InputObject <IFluidRelayIdentity> -KeyName <KeyName> [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerate the primary or secondary key for this server. + +## EXAMPLES + +### Example 1: Regenerate the primary or secondary key for this server. +```powershell +New-AzFluidRelayServerKey -FluidRelayServerName azps-fluidrelay -ResourceGroup azpstest-gp -KeyName 'key2' +``` + +```output + Key1 Key2 + ---- ---- +System.Security.SecureString System.Security.SecureString +``` + +Regenerate the primary or secondary key for this server. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FluidRelayServerName +The Fluid Relay server resource name. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.IFluidRelayIdentity +Parameter Sets: RegenerateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +The key to regenerate. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Support.KeyName +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +The resource group containing the resource. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription id (GUID) for this resource. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.IFluidRelayIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.Api20220601.IFluidRelayServerKeys + +## 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 `<IFluidRelayIdentity>`: Identity Parameter + - `[FluidRelayContainerName <String>]`: The Fluid Relay container resource name. + - `[FluidRelayServerName <String>]`: The Fluid Relay server resource name. + - `[Id <String>]`: Resource identity path + - `[ResourceGroup <String>]`: The resource group containing the resource. + - `[SubscriptionId <String>]`: The subscription id (GUID) for this resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.FluidRelay/Remove-AzFluidRelayContainer.md b/azps-10.1.0/Az.FluidRelay/Remove-AzFluidRelayContainer.md new file mode 100644 index 0000000000..af81c35b15 --- /dev/null +++ b/azps-10.1.0/Az.FluidRelay/Remove-AzFluidRelayContainer.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.FluidRelay +online version: https://learn.microsoft.com/powershell/module/az.fluidrelay/remove-azfluidrelaycontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Remove-AzFluidRelayContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Remove-AzFluidRelayContainer.md +--- + +# Remove-AzFluidRelayContainer + +## SYNOPSIS +Delete a Fluid Relay container. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzFluidRelayContainer -FluidRelayServerName <String> -Name <String> -ResourceGroup <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzFluidRelayContainer -InputObject <IFluidRelayIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a Fluid Relay container. + +## EXAMPLES + +### Example 1: Delete a Fluid Relay container. +```powershell +Remove-AzFluidRelayContainer -FluidRelayServerName azps-fluidrelay -ResourceGroup azpstest-gp -Name eb4dd5f6-531f-44e1-86e3-759d39d1010c +``` + +Delete a Fluid Relay container. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FluidRelayServerName +The Fluid Relay server resource name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.IFluidRelayIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Fluid Relay container resource name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: FluidRelayContainerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +The resource group containing the resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription id (GUID) for this resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.IFluidRelayIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IFluidRelayIdentity>`: Identity Parameter + - `[FluidRelayContainerName <String>]`: The Fluid Relay container resource name. + - `[FluidRelayServerName <String>]`: The Fluid Relay server resource name. + - `[Id <String>]`: Resource identity path + - `[ResourceGroup <String>]`: The resource group containing the resource. + - `[SubscriptionId <String>]`: The subscription id (GUID) for this resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.FluidRelay/Remove-AzFluidRelayServer.md b/azps-10.1.0/Az.FluidRelay/Remove-AzFluidRelayServer.md new file mode 100644 index 0000000000..61a3419e2a --- /dev/null +++ b/azps-10.1.0/Az.FluidRelay/Remove-AzFluidRelayServer.md @@ -0,0 +1,193 @@ +--- +external help file: +Module Name: Az.FluidRelay +online version: https://learn.microsoft.com/powershell/module/az.fluidrelay/remove-azfluidrelayserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Remove-AzFluidRelayServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Remove-AzFluidRelayServer.md +--- + +# Remove-AzFluidRelayServer + +## SYNOPSIS +Delete a Fluid Relay server. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzFluidRelayServer -Name <String> -ResourceGroup <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzFluidRelayServer -InputObject <IFluidRelayIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a Fluid Relay server. + +## EXAMPLES + +### Example 1: Delete a Fluid Relay server. +```powershell +Remove-AzFluidRelayServer -Name key1 -ResourceGroup jinpei-gp +``` + +Delete a Fluid Relay server. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.IFluidRelayIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Fluid Relay server resource name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: FluidRelayServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +The resource group containing the resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription id (GUID) for this resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.IFluidRelayIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IFluidRelayIdentity>`: Identity Parameter + - `[FluidRelayContainerName <String>]`: The Fluid Relay container resource name. + - `[FluidRelayServerName <String>]`: The Fluid Relay server resource name. + - `[Id <String>]`: Resource identity path + - `[ResourceGroup <String>]`: The resource group containing the resource. + - `[SubscriptionId <String>]`: The subscription id (GUID) for this resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.FluidRelay/Update-AzFluidRelayServer.md b/azps-10.1.0/Az.FluidRelay/Update-AzFluidRelayServer.md new file mode 100644 index 0000000000..0df48b333b --- /dev/null +++ b/azps-10.1.0/Az.FluidRelay/Update-AzFluidRelayServer.md @@ -0,0 +1,301 @@ +--- +external help file: +Module Name: Az.FluidRelay +online version: https://learn.microsoft.com/powershell/module/az.fluidrelay/update-azfluidrelayserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Update-AzFluidRelayServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FluidRelay/help/Update-AzFluidRelayServer.md +--- + +# Update-AzFluidRelayServer + +## SYNOPSIS +Update a Fluid Relay server. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzFluidRelayServer -Name <String> -ResourceGroup <String> [-SubscriptionId <String>] + [-CustomerManagedKeyEncryptionKeyUrl <String>] [-IdentityType <ResourceIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-KeyEncryptionKeyIdentityType <CmkIdentityType>] + [-KeyEncryptionKeyIdentityUserAssignedIdentityResourceId <String>] [-Location <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzFluidRelayServer -InputObject <IFluidRelayIdentity> [-CustomerManagedKeyEncryptionKeyUrl <String>] + [-IdentityType <ResourceIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] + [-KeyEncryptionKeyIdentityType <CmkIdentityType>] + [-KeyEncryptionKeyIdentityUserAssignedIdentityResourceId <String>] [-Location <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a Fluid Relay server. + +## EXAMPLES + +### Example 1: Update a Fluid Relay server. +```powershell +Update-AzFluidRelayServer -Name azps-fluidrelay -ResourceGroup azpstest-gp -KeyEncryptionKeyIdentityUserAssignedIdentityResourceId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/azpstest-gp/providers/Microsoft.ManagedIdentity/userAssignedIdentities/azpstest-uami" -KeyEncryptionKeyIdentityType 'SystemAssigned' -Tag @{"Category"="sales"} -IdentityUserAssignedIdentity @{"/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/azpstest-gp/providers/Microsoft.ManagedIdentity/userAssignedIdentities/azpstest-uami" = @{};} -IdentityType 'UserAssigned' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westus2 azps-fluidrelay azpstest-gp +``` + +Update a Fluid Relay server. + +## PARAMETERS + +### -CustomerManagedKeyEncryptionKeyUrl +key encryption key Url, with or without a version. +Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. +Key auto rotation is enabled by providing a key uri without version. +Otherwise, customer is responsible for rotating the key. +The keyEncryptionKeyIdentity(either SystemAssigned or UserAssigned) should have permission to access this key url. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +The list of user identities associated with the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.IFluidRelayIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyIdentityType +Values can be SystemAssigned or UserAssigned + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Support.CmkIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyIdentityUserAssignedIdentityResourceId +user assigned identity to use for accessing key encryption key Url. +Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/\<resource group\>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. +Mutually exclusive with identityType systemAssignedIdentity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Fluid Relay server resource name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: FluidRelayServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +The resource group containing the resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription id (GUID) for this resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.IFluidRelayIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.FluidRelay.Models.Api20220601.IFluidRelayServer + +## 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 `<IFluidRelayIdentity>`: Identity Parameter + - `[FluidRelayContainerName <String>]`: The Fluid Relay container resource name. + - `[FluidRelayServerName <String>]`: The Fluid Relay server resource name. + - `[Id <String>]`: Resource identity path + - `[ResourceGroup <String>]`: The resource group containing the resource. + - `[SubscriptionId <String>]`: The subscription id (GUID) for this resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.FrontDoor/Az.FrontDoor.md b/azps-10.1.0/Az.FrontDoor/Az.FrontDoor.md new file mode 100644 index 0000000000..8070d73499 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Az.FrontDoor.md @@ -0,0 +1,117 @@ +--- +Module Name: Az.FrontDoor +Module Guid: 91832aaa-dc11-4583-8239-adb7df531604 +Download Help Link: https://learn.microsoft.com/powershell/module/az.frontdoor +Help Version: 0.1.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Az.FrontDoor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Az.FrontDoor.md +--- + +# Az.FrontDoor Module +## Description +The topics in this section document the Azure PowerShell cmdlets for Azure Front Door Service in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.FrontDoor namespace. + +## Az.FrontDoor Cmdlets +### [Disable-AzFrontDoorCustomDomainHttps](Disable-AzFrontDoorCustomDomainHttps.md) +Disable HTTPS for a custom domain + +### [Enable-AzFrontDoorCustomDomainHttps](Enable-AzFrontDoorCustomDomainHttps.md) +Enable HTTPS for a custom domain using Front Door managed certificate or using own certificate from Azure Key Vault. + +### [Get-AzFrontDoor](Get-AzFrontDoor.md) +Get Front Door load balancer + +### [Get-AzFrontDoorFrontendEndpoint](Get-AzFrontDoorFrontendEndpoint.md) +Get a front door frontend endpoint. + +### [Get-AzFrontDoorRulesEngine](Get-AzFrontDoorRulesEngine.md) +Get Rules Engine configurations. + +### [Get-AzFrontDoorWafManagedRuleSetDefinition](Get-AzFrontDoorWafManagedRuleSetDefinition.md) +Get WAF managed rule set definitions + +### [Get-AzFrontDoorWafPolicy](Get-AzFrontDoorWafPolicy.md) +Get WAF policy + +### [New-AzFrontDoor](New-AzFrontDoor.md) +Create a new Azure Front Door load balancer + +### [New-AzFrontDoorBackendObject](New-AzFrontDoorBackendObject.md) +Create a PSBackend object + +### [New-AzFrontDoorBackendPoolObject](New-AzFrontDoorBackendPoolObject.md) +Create a PSBackendPool object for Front Door creation + +### [New-AzFrontDoorBackendPoolsSettingObject](New-AzFrontDoorBackendPoolsSettingObject.md) +Create a PSBackendPoolsSetting object for Front Door creation. + +### [New-AzFrontDoorFrontendEndpointObject](New-AzFrontDoorFrontendEndpointObject.md) +Create a PSFrontendEndpoint Object for Front Door creation + +### [New-AzFrontDoorHeaderActionObject](New-AzFrontDoorHeaderActionObject.md) +Create PSHeaderAction object. + +### [New-AzFrontDoorHealthProbeSettingObject](New-AzFrontDoorHealthProbeSettingObject.md) +Create a PSHealthProbeSetting object for Front Door creation + +### [New-AzFrontDoorLoadBalancingSettingObject](New-AzFrontDoorLoadBalancingSettingObject.md) +Create a PSLoadBalancingSetting object for Front Door creation + +### [New-AzFrontDoorRoutingRuleObject](New-AzFrontDoorRoutingRuleObject.md) +Create a PSRoutingRuleObject for Front Door creation + +### [New-AzFrontDoorRulesEngine](New-AzFrontDoorRulesEngine.md) +Create a new rules engine configuration for a specified front door. + +### [New-AzFrontDoorRulesEngineActionObject](New-AzFrontDoorRulesEngineActionObject.md) +Create a PSRulesEngineAction object for creating a rules engine rule. + +### [New-AzFrontDoorRulesEngineMatchConditionObject](New-AzFrontDoorRulesEngineMatchConditionObject.md) +Create a PSRulesEngineMatchCondition object for creating a rules engine rule. + +### [New-AzFrontDoorRulesEngineRuleObject](New-AzFrontDoorRulesEngineRuleObject.md) +Create a PSRulesEngineRule object for Rules Engine creation. + +### [New-AzFrontDoorWafCustomRuleObject](New-AzFrontDoorWafCustomRuleObject.md) +Create CustomRule Object for WAF policy creation + +### [New-AzFrontDoorWafManagedRuleExclusionObject](New-AzFrontDoorWafManagedRuleExclusionObject.md) +Create managed rule exclusion object for WAF managed rule sets, groups, or rules. + +### [New-AzFrontDoorWafManagedRuleObject](New-AzFrontDoorWafManagedRuleObject.md) +Create ManagedRule Object for WAF policy creation + +### [New-AzFrontDoorWafManagedRuleOverrideObject](New-AzFrontDoorWafManagedRuleOverrideObject.md) +Create managed rule override object + +### [New-AzFrontDoorWafMatchConditionObject](New-AzFrontDoorWafMatchConditionObject.md) +Create MatchCondition Object for WAF policy creation + +### [New-AzFrontDoorWafPolicy](New-AzFrontDoorWafPolicy.md) +Create WAF policy + +### [New-AzFrontDoorWafRuleGroupOverrideObject](New-AzFrontDoorWafRuleGroupOverrideObject.md) +Create RuleGroupOverride Object for WAF policy creation + +### [Remove-AzFrontDoor](Remove-AzFrontDoor.md) +Remove Front Door load balancer + +### [Remove-AzFrontDoorContent](Remove-AzFrontDoorContent.md) +Remove contents in Front Door + +### [Remove-AzFrontDoorRulesEngine](Remove-AzFrontDoorRulesEngine.md) +Remove Rules Engine from Front Door + +### [Remove-AzFrontDoorWafPolicy](Remove-AzFrontDoorWafPolicy.md) +Remove WAF policy + +### [Set-AzFrontDoor](Set-AzFrontDoor.md) +Update a Front Door load balancer + +### [Set-AzFrontDoorRulesEngine](Set-AzFrontDoorRulesEngine.md) +Update a Rules Engine. + +### [Update-AzFrontDoorWafPolicy](Update-AzFrontDoorWafPolicy.md) +Update WAF policy + diff --git a/azps-10.1.0/Az.FrontDoor/Disable-AzFrontDoorCustomDomainHttps.md b/azps-10.1.0/Az.FrontDoor/Disable-AzFrontDoorCustomDomainHttps.md new file mode 100644 index 0000000000..c9186ac681 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Disable-AzFrontDoorCustomDomainHttps.md @@ -0,0 +1,260 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/disable-azfrontdoorcustomdomainhttps +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Disable-AzFrontDoorCustomDomainHttps.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Disable-AzFrontDoorCustomDomainHttps.md +--- + +# Disable-AzFrontDoorCustomDomainHttps + +## SYNOPSIS +Disable HTTPS for a custom domain + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Disable-AzFrontDoorCustomDomainHttps -ResourceGroupName <String> -FrontDoorName <String> + -FrontendEndpointName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Disable-AzFrontDoorCustomDomainHttps -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Disable-AzFrontDoorCustomDomainHttps -InputObject <PSFrontendEndpoint> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzFrontDoorCustomDomainHttps** disables HTTPS for a custom domain. + +## EXAMPLES + +### Example 1: Disable HTTPS for a custom domain with FrontDoorName and ResourceGroupName. +```powershell +Disable-AzFrontDoorCustomDomainHttps -ResourceGroupName "resourcegroup1" -FrontDoorName "frontdoor1" -FrontendEndpointName "frontendpointname1-custom-xyz" +``` + +```output +HostName : frontendpointname1.custom.xyz +SessionAffinityEnabledState : Disabled +SessionAffinityTtlSeconds : 0 +WebApplicationFirewallPolicyLink : +Backends : +CustomHttpsProvisioningState : Disabling +CustomHttpsProvisioningSubstate : DeletingCertificate +CertificateSource : FrontDoor +ProtocolType : ServerNameIndication +Vault : +SecretName : +SecretVersion : +CertificateType : +ResourceState : Enabled +Id : /subscriptions/{guid}/resourcegroups/resourcegroup1 + /providers/Microsoft.Network/frontdoors/frontdoor1/frontendendpoints/frontendpointname1-custom-xyz +Name : frontendpointname1-custom-xyz +Type : Microsoft.Network/frontdoors/frontendendpoints +``` + +Disable HTTPS for a custom domain "frontendpointname1-custom-xyz" with FrontDoorName as "frontdoor1" and ResourceGroupName as "resourcegroup1". + +### Example 2: Disable HTTPS for a custom domain with PSFrontendEndpoint object. +```powershell +Get-AzFrontDoorFrontendEndpoint -ResourceGroupName "resourcegroup1" -FrontDoorName "frontdoor1" -Name "frontendpointname1-custom-xyz" | Disable-AzFrontDoorCustomDomainHttps -InputObject $frontendEndpointObj +``` + +```output +HostName : frontendpointname1.custom.xyz +SessionAffinityEnabledState : Disabled +SessionAffinityTtlSeconds : 0 +WebApplicationFirewallPolicyLink : +Backends : +CustomHttpsProvisioningState : Disabling +CustomHttpsProvisioningSubstate : DeletingCertificate +CertificateSource : FrontDoor +ProtocolType : ServerNameIndication +Vault : +SecretName : +SecretVersion : +CertificateType : +ResourceState : Enabled +Id : /subscriptions/{guid}/resourcegroups/resourcegroup1 + /providers/Microsoft.Network/frontdoors/frontdoor1/frontendendpoints/frontendpointname1-custom-xyz +Name : frontendpointname1-custom-xyz +Type : Microsoft.Network/frontdoors/frontendendpoints +``` + +Disable HTTPS for a custom domain with PSFrontendEndpoint object. + +### Example 3: Disable HTTPS for a custom domain with ResourceId. +```powershell +Disable-AzFrontDoorCustomDomainHttps -ResourceId $resourceId +``` + +```output +HostName : frontendpointname1.custom.xyz +SessionAffinityEnabledState : Disabled +SessionAffinityTtlSeconds : 0 +WebApplicationFirewallPolicyLink : +Backends : +CustomHttpsProvisioningState : Disabling +CustomHttpsProvisioningSubstate : DeletingCertificate +CertificateSource : FrontDoor +ProtocolType : ServerNameIndication +Vault : +SecretName : +SecretVersion : +CertificateType : +ResourceState : Enabled +Id : /subscriptions/{guid}/resourcegroups/resourcegroup1 + /providers/Microsoft.Network/frontdoors/frontdoor1/frontendendpoints/frontendpointname1-custom-xyz +Name : frontendpointname1-custom-xyz +Type : Microsoft.Network/frontdoors/frontendendpoints +``` + +Disable HTTPS for a custom domain "frontendpointname1-custom-xyz" with ResourceId as $resourceId. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontDoorName +The name of the Front Door. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendEndpointName +Frontend endpoint name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Frontend endpoint object to update. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group to which the Front Door belongs. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id of the Front Door endpoint to disable https + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FrontDoor/Enable-AzFrontDoorCustomDomainHttps.md b/azps-10.1.0/Az.FrontDoor/Enable-AzFrontDoorCustomDomainHttps.md new file mode 100644 index 0000000000..9f397c151e --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Enable-AzFrontDoorCustomDomainHttps.md @@ -0,0 +1,404 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/enable-azfrontdoorcustomdomainhttps +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Enable-AzFrontDoorCustomDomainHttps.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Enable-AzFrontDoorCustomDomainHttps.md +--- + +# Enable-AzFrontDoorCustomDomainHttps + +## SYNOPSIS +Enable HTTPS for a custom domain using Front Door managed certificate or using own certificate from Azure Key Vault. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Enable-AzFrontDoorCustomDomainHttps -ResourceGroupName <String> -FrontDoorName <String> + -FrontendEndpointName <String> [-MinimumTlsVersion <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFieldsWithVaultParameterSet +``` +Enable-AzFrontDoorCustomDomainHttps -ResourceGroupName <String> -FrontDoorName <String> + -FrontendEndpointName <String> -VaultId <String> -SecretName <String> [-SecretVersion <String>] + [-MinimumTlsVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Enable-AzFrontDoorCustomDomainHttps -ResourceId <String> [-MinimumTlsVersion <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdWithVaultParameterSet +``` +Enable-AzFrontDoorCustomDomainHttps -ResourceId <String> -VaultId <String> -SecretName <String> + [-SecretVersion <String>] [-MinimumTlsVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Enable-AzFrontDoorCustomDomainHttps -InputObject <PSFrontendEndpoint> [-MinimumTlsVersion <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectWithVaultParameterSet +``` +Enable-AzFrontDoorCustomDomainHttps -InputObject <PSFrontendEndpoint> -VaultId <String> -SecretName <String> + [-SecretVersion <String>] [-MinimumTlsVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzFrontDoorCustomDomainHttps** enables HTTPS for a custom domain. + +## EXAMPLES + +### Example 1: Enable HTTPS for a custom domain with FrontDoorName and ResourceGroupName using Front Door managed certificate. +```powershell +Enable-AzFrontDoorCustomDomainHttps -ResourceGroupName "resourcegroup1" -FrontDoorName "frontdoor1" -FrontendEndpointName "frontendpointname1-custom-xyz" -MinimumTlsVersion "1.2" +``` + +```output +HostName : frontendpointname1.custom.xyz +SessionAffinityEnabledState : Disabled +SessionAffinityTtlSeconds : 0 +WebApplicationFirewallPolicyLink : +Backends : +CustomHttpsProvisioningState : Enabling +CustomHttpsProvisioningSubstate : SubmittingDomainControlValidationRequest +CertificateSource : FrontDoor +ProtocolType : ServerNameIndication +MinimumTlsVersion : 1.2 +Vault : +SecretName : +SecretVersion : +CertificateType : +ResourceState : Enabled +Id : /subscriptions/{guid}/resourcegroups/resourcegroup1 + /providers/Microsoft.Network/frontdoors/frontdoor1/frontendendpoints/frontendpointname1-custom-xyz +Name : frontendpointname1-custom-xyz +Type : Microsoft.Network/frontdoors/frontendendpoints +``` + +Enable HTTPS for a custom domain "frontendpointname1-custom-xyz" that is part of Front Door "frontdoor1" in resource group "resourcegroup1" using Front Door managed certificate. + +### Example 2: Enable HTTPS for a custom domain with FrontDoorName and ResourceGroupName using customer's own certificate in Key Vault with the specific version. +```powershell +$vaultId = (Get-AzKeyVault -VaultName $vaultName).ResourceId +Enable-AzFrontDoorCustomDomainHttps -ResourceGroupName "resourcegroup1" -FrontDoorName "frontdoor1" -FrontendEndpointName "frontendpointname1-custom-xyz" -VaultId $vaultId -secretName $secretName -SecretVersion $secretVersion -MinimumTlsVersion "1.0" +``` + +```output +HostName : frontendpointname1.custom.xyz +SessionAffinityEnabledState : Disabled +SessionAffinityTtlSeconds : 0 +WebApplicationFirewallPolicyLink : +Backends : +CustomHttpsProvisioningState : Enabling +CustomHttpsProvisioningSubstate : SubmittingDomainControlValidationRequest +CertificateSource : AzureKeyVault +ProtocolType : ServerNameIndication +MinimumTlsVersion : 1.0 +Vault : +SecretName : +SecretVersion : +CertificateType : +ResourceState : Enabled +Id : /subscriptions/{guid}/resourcegroups/resourcegroup1 + /providers/Microsoft.Network/frontdoors/frontdoor1/frontendendpoints/frontendpointname1-custom-xyz +Name : frontendpointname1-custom-xyz +Type : Microsoft.Network/frontdoors/frontendendpoints +``` + +Enable HTTPS for a custom domain "frontendpointname1-custom-xyz" that is part of Front Door "frontdoor1" in resource group "resourcegroup1" using customer's own certificate in Key Vault with the specific version. + +### Example 3: Enable HTTPS for a custom domain with PSFrontendEndpoint object using Front Door managed certificate. +```powershell +Get-AzFrontDoorFrontendEndpoint -ResourceGroupName "resourcegroup1" -FrontDoorName "frontdoor1" -Name "frontendpointname1-custom-xyz" | Enable-AzFrontDoorCustomDomainHttps +``` + +```output +HostName : frontendpointname1.custom.xyz +SessionAffinityEnabledState : Disabled +SessionAffinityTtlSeconds : 0 +WebApplicationFirewallPolicyLink : +Backends : +CustomHttpsProvisioningState : Enabling +CustomHttpsProvisioningSubstate : SubmittingDomainControlValidationRequest +CertificateSource : FrontDoor +ProtocolType : ServerNameIndication +MinimumTlsVersion : 1.2 +Vault : +SecretName : +SecretVersion : +CertificateType : +ResourceState : Enabled +Id : /subscriptions/{guid}/resourcegroups/resourcegroup1 + /providers/Microsoft.Network/frontdoors/frontdoor1/frontendendpoints/frontendpointname1-custom-xyz +Name : frontendpointname1-custom-xyz +Type : Microsoft.Network/frontdoors/frontendendpoints +``` + +Enable HTTPS for a custom domain with PSFrontendEndpoint object using Front Door managed certificate. + +### Example 4: Enable HTTPS for a custom domain with resource id using Front Door managed certificate. +```powershell +Enable-AzFrontDoorCustomDomainHttps -ResourceId $resourceId +``` + +```output +HostName : frontendpointname1.custom.xyz +SessionAffinityEnabledState : Disabled +SessionAffinityTtlSeconds : 0 +WebApplicationFirewallPolicyLink : +Backends : +CustomHttpsProvisioningState : Enabling +CustomHttpsProvisioningSubstate : SubmittingDomainControlValidationRequest +CertificateSource : FrontDoor +ProtocolType : ServerNameIndication +MinimumTlsVersion : 1.2 +Vault : +SecretName : +SecretVersion : +CertificateType : +ResourceState : Enabled +Id : /subscriptions/{guid}/resourcegroups/resourcegroup1 + /providers/Microsoft.Network/frontdoors/frontdoor1/frontendendpoints/frontendpointname1-custom-xyz +Name : frontendpointname1-custom-xyz +Type : Microsoft.Network/frontdoors/frontendendpoints +``` + +Enable HTTPS for a custom domain "frontendpointname1-custom-xyz" with resource id $resourceId using Front Door managed certificate. + +### Example 5: Enable HTTPS for a custom domain with FrontDoorName and ResourceGroupName using customer's own certificate in Key Vault with the latest version to enable certificate auto-rotation. +```powershell +$vaultId = (Get-AzKeyVault -VaultName $vaultName).ResourceId +Enable-AzFrontDoorCustomDomainHttps -ResourceGroupName "resourcegroup1" -FrontDoorName "frontdoor1" -FrontendEndpointName "frontendpointname1-custom-xyz" -VaultId $vaultId -secretName $secretName -MinimumTlsVersion "1.0" +``` + +```output +HostName : frontendpointname1.custom.xyz +SessionAffinityEnabledState : Disabled +SessionAffinityTtlSeconds : 0 +WebApplicationFirewallPolicyLink : +Backends : +CustomHttpsProvisioningState : Enabling +CustomHttpsProvisioningSubstate : SubmittingDomainControlValidationRequest +CertificateSource : AzureKeyVault +ProtocolType : ServerNameIndication +MinimumTlsVersion : 1.0 +Vault : +SecretName : +SecretVersion : +CertificateType : +ResourceState : Enabled +Id : /subscriptions/{guid}/resourcegroups/resourcegroup1 + /providers/Microsoft.Network/frontdoors/frontdoor1/frontendendpoints/frontendpointname1-custom-xyz +Name : frontendpointname1-custom-xyz +Type : Microsoft.Network/frontdoors/frontendendpoints +``` + +Enable HTTPS for a custom domain "frontendpointname1-custom-xyz" that is part of Front Door "frontdoor1" in resource group "resourcegroup1" using customer's own certificate in Key Vault with the the latest version to enable certificate auto-rotation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontDoorName +The name of the Front Door. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByFieldsWithVaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendEndpointName +Frontend endpoint name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByFieldsWithVaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Frontend endpoint object to update. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint +Parameter Sets: ByObjectParameterSet, ByObjectWithVaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +The minimum TLS version required from the clients to establish an SSL handshake with Front Door. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group to which the Front Door belongs. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByFieldsWithVaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id of the Front Door endpoint to enable https + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet, ByResourceIdWithVaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecretName +The name of the Key Vault secret representing the full certificate PFX + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithVaultParameterSet, ByResourceIdWithVaultParameterSet, ByObjectWithVaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretVersion +The version of the Key Vault secret representing the full certificate PFX. +If not specified, the 'Latest' version will always been used and the deployed certificate will be automatically rotated to the latest version when a newer version of the certificate is available. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithVaultParameterSet, ByResourceIdWithVaultParameterSet, ByObjectWithVaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +The Key Vault id containing the SSL certificate + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithVaultParameterSet, ByResourceIdWithVaultParameterSet, ByObjectWithVaultParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoor.md b/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoor.md new file mode 100644 index 0000000000..1baa528322 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoor.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/get-azfrontdoor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Get-AzFrontDoor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Get-AzFrontDoor.md +--- + +# Get-AzFrontDoor + +## SYNOPSIS +Get Front Door load balancer + +## SYNTAX + +``` +Get-AzFrontDoor [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzFrontDoor** cmdletGet gets all existing Front Doors (Classic Tier only) in the current subscription that matches provided information. + +## EXAMPLES + +### Example 1: Get all FrontDoors in the current subscription. +```powershell +Get-AzFrontDoor +``` + +```output +FriendlyName : frontdoor1 +FrontDoorId : {guid} +RoutingRules : {routingrule1} +BackendPools : {backendpool1} +HealthProbeSettings : {healthProbeSetting1} +LoadBalancingSettings : {loadbalancingsetting1} +FrontendEndpoints : {frontendendpoint1} +EnabledState : Enabled +ResourceState : Enabled +ProvisioningState : Succeeded +Cname : +Tags : {tag1, tag2} +Id : /subscriptions/{guid}/resourcegroups/{guid1}/providers/M + icrosoft.Network/frontdoors/frontdoor1 +Name : frontdoor1 +Type : Microsoft.Network/frontdoor1 + +FriendlyName : frontdoor1 +FrontDoorId : {guid} +RoutingRules : {routingrule1} +BackendPools : {backendpool1} +HealthProbeSettings : {healthProbeSetting1} +LoadBalancingSettings : {loadbalancingsetting1} +FrontendEndpoints : {frontendendpoint1} +EnabledState : Enabled +ResourceState : Enabled +ProvisioningState : Succeeded +Cname : +Tags : {tag1, tag2} +Id : /subscriptions/{guid}/resourcegroups/{guid2}/providers/M + icrosoft.Network/frontdoors/frontdoor1 +Name : frontdoor1 +Type : Microsoft.Network/frontdoor1 +``` + +Get all FrontDoors in the current subscription. + +### Example 2: Get all FrontDoors in resource group "rg1" in the current subscription. +```powershell +Get-AzFrontDoor -ResourceGroupName "rg1" +``` + +```output +FriendlyName : frontdoor1 +FrontDoorId : {guid} +RoutingRules : {routingrule1} +BackendPools : {backendpool1} +HealthProbeSettings : {healthProbeSetting1} +LoadBalancingSettings : {loadbalancingsetting1} +FrontendEndpoints : {frontendendpoint1} +EnabledState : Enabled +ResourceState : Enabled +ProvisioningState : Succeeded +Cname : +Tags : {tag1, tag2} +Id : /subscriptions/{guid}/resourcegroups/rg1/providers/M + icrosoft.Network/frontdoors/frontdoor1 +Name : frontdoor1 +Type : Microsoft.Network/frontdoor1 + +FriendlyName : frontdoor2 +FrontDoorId : {guid} +RoutingRules : {routingrule1} +BackendPools : {backendpool1} +HealthProbeSettings : {healthProbeSetting1} +LoadBalancingSettings : {loadbalancingsetting1} +FrontendEndpoints : {frontendendpoint1} +EnabledState : Enabled +ResourceState : Enabled +ProvisioningState : Succeeded +Cname : +Tags : {tag1, tag2} +Id : /subscriptions/{guid}/resourcegroups/rg1/providers/M + icrosoft.Network/frontdoors/frontdoor1 +Name : frontdoor1 +Type : Microsoft.Network/frontdoor1 +``` + +Get all FrontDoors in resource group "rg1" in the current subscription. + +### Example 3: Get the FrontDoors in resource group "rg1" with name "frontDoor1" in the current subscription. +```powershell +Get-AzFrontDoor -ResourceGroupName "rg1" -Name "frontDoor1" +``` + +```output +FriendlyName : frontdoor1 +FrontDoorId : {guid} +RoutingRules : {routingrule1} +BackendPools : {backendpool1} +HealthProbeSettings : {healthProbeSetting1} +LoadBalancingSettings : {loadbalancingsetting1} +FrontendEndpoints : {frontendendpoint1} +EnabledState : Enabled +ResourceState : Enabled +ProvisioningState : Succeeded +Cname : +Tags : {tag1, tag2} +Id : /subscriptions/{guid}/resourcegroups/rg1/providers/M + icrosoft.Network/frontdoors/frontdoor1 +Name : frontdoor1 +Type : Microsoft.Network/frontdoor1 +``` + +Get the FrontDoors in resource group "rg1" with name "frontDoor1" in the current subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Front Door name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoor](./New-AzFrontDoor.md) +[Set-AzFrontDoor](./Set-AzFrontDoor.md) +[Remove-AzFrontDoor](./Remove-AzFrontDoor.md) diff --git a/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoorFrontendEndpoint.md b/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoorFrontendEndpoint.md new file mode 100644 index 0000000000..1ca7f937e8 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoorFrontendEndpoint.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/get-azfrontdoorfrontendendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Get-AzFrontDoorFrontendEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Get-AzFrontDoorFrontendEndpoint.md +--- + +# Get-AzFrontDoorFrontendEndpoint + +## SYNOPSIS +Get a front door frontend endpoint. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzFrontDoorFrontendEndpoint -ResourceGroupName <String> -FrontDoorName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Get-AzFrontDoorFrontendEndpoint [-Name <String>] -FrontDoorObject <PSFrontDoor> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzFrontDoorFrontendEndpoint -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzFrontDoorFrontendEndpoint** cmdlet gets all existing frontend endpoints in the current Front Door resource that matches provided information. + +## EXAMPLES + +### Example 1: Get all frontend endpoints in Front Door "frontdoor1" which is part of resource group "rg1". +```powershell +Get-AzFrontDoorFrontendEndpoint -ResourceGroupName "rg1" -FrontDoorName "frontdoor1" +``` + +```output +HostName : frontdoor1.azurefd.net +SessionAffinityEnabledState : Disabled +SessionAffinityTtlSeconds : 0 +WebApplicationFirewallPolicyLink : +Backends : +CustomHttpsProvisioningState : Disabled +CustomHttpsProvisioningSubstate : None +CertificateSource : +ProtocolType : +Vault : +SecretName : +SecretVersion : +CertificateType : +ResourceState : Enabled +Id : /subscriptions/{guid}/resourcegroups/resourcegroup1 + /providers/Microsoft.Network/frontdoors/frontdoor1/frontendendpoints/frontdoor1-azurefd-net +Name : frontdoor1-azurefd-net +Type : Microsoft.Network/frontdoors/frontendendpoints + +HostName : frontendpointname1.custom.xyz +SessionAffinityEnabledState : Disabled +SessionAffinityTtlSeconds : 0 +WebApplicationFirewallPolicyLink : +Backends : +CustomHttpsProvisioningState : Disabled +CustomHttpsProvisioningSubstate : None +CertificateSource : +ProtocolType : +Vault : +SecretName : +SecretVersion : +CertificateType : +ResourceState : Enabled +Id : /subscriptions/{guid}/resourcegroups/resourcegroup1 + /providers/Microsoft.Network/frontdoors/frontdoor1/frontendendpoints/frontendpointname1-custom-xyz +Name : frontendpointname1-custom-xyz +Type : Microsoft.Network/frontdoors/frontendendpoints +``` + +Get all frontend endpoints in Front Door "frontdoor1" which is part of resource group "rg1". + +### Example 2: Get frontend endpoint with name "frontdoor1-azurefd-net" in Front Door "frontdoor1" which is part of resource group "rg1" +```powershell +Get-AzFrontDoorFrontendEndpoint -ResourceGroupName "rg1" -FrontDoorName "frontdoor1" -Name "frontdoor1-azurefd-net" +``` + +```output +HostName : frontdoor1.azurefd.net +SessionAffinityEnabledState : Disabled +SessionAffinityTtlSeconds : 0 +WebApplicationFirewallPolicyLink : +Backends : +CustomHttpsProvisioningState : Disabled +CustomHttpsProvisioningSubstate : None +CertificateSource : +ProtocolType : +Vault : +SecretName : +SecretVersion : +CertificateType : +ResourceState : Enabled +Id : /subscriptions/{guid}/resourcegroups/resourcegroup1 + /providers/Microsoft.Network/frontdoors/frontdoor1/frontendendpoints/frontdoor1-azurefd-net +Name : frontdoor1-azurefd-net +Type : Microsoft.Network/frontdoors/frontendendpoints +``` + +Get frontend endpoint with name "frontdoor1-azurefd-net" in Front Door "frontdoor1" which is part of resource group "rg1" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontDoorName +Front Door name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontDoorObject +The FrontDoor object. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Frontend endpoint name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id of the Front Door + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoorRulesEngine.md b/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoorRulesEngine.md new file mode 100644 index 0000000000..3de247e21f --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoorRulesEngine.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/get-azfrontdoorrulesengine +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Get-AzFrontDoorRulesEngine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Get-AzFrontDoorRulesEngine.md +--- + +# Get-AzFrontDoorRulesEngine + +## SYNOPSIS +Get Rules Engine configurations. + +## SYNTAX + +``` +Get-AzFrontDoorRulesEngine -ResourceGroupName <String> -FrontDoorName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzFrontDoorRulesEngine** cmdlet gets a specific rules engine configuration or gets all rules engine configurations associated with a Front Door. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzFrontDoorRulesEngine -ResourceGroupName $resourceGroupName -FrontDoorName $frontDoorName -Name rulesengine3 +``` + +```output +Name RulesEngineRules +---- ---------------- +rulesEngine3 {rules1} +``` + +Get specific rules engine configuration. + +### Example 2 + +```powershell +Get-AzFrontDoorRulesEngine -ResourceGroupName $resourceGroupName -FrontDoorName $frontDoorName +``` + +```output +Name RulesEngineRules +---- ---------------- +rulesEngine1 {Rule1} +rulesEngine2 {Rule1} +rulesEngine3 {rules1} +``` + +Get all rules engine configurations in a front door. + +### Example 3 + +```powershell +Get-AzFrontDoorRulesEngine -ResourceGroupName $resourceGroupName -FrontDoorName $frontDoorName -Name nonexistent +``` + +```output +Get-AzFrontDoorRulesEngine : Rules Engine with name 'nonexistent' in Front Door 'frontDoorName' is not found. +At line:1 char:1 ++ Get-AzFrontDoorRulesEngine -ResourceGroupName $resourceGroupName -FrontD ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ++ CategoryInfo : CloseError: (:) [Get-AzFrontDoorRulesEngine], PSArgumentException ++ FullyQualifiedErrorId : Microsoft.Azure.Commands.FrontDoor.Cmdlets.GetFrontDoorRulesEngine +``` + +Expected output when getting a nonexistent rules engine. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontDoorName +Front Door name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Rules engine name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name that the Front Door will be created in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngine + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoorWafManagedRuleSetDefinition.md b/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoorWafManagedRuleSetDefinition.md new file mode 100644 index 0000000000..9f30704497 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoorWafManagedRuleSetDefinition.md @@ -0,0 +1,76 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/get-azfrontdoorwafmanagedrulesetdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Get-AzFrontDoorWafManagedRuleSetDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Get-AzFrontDoorWafManagedRuleSetDefinition.md +--- + +# Get-AzFrontDoorWafManagedRuleSetDefinition + +## SYNOPSIS +Get WAF managed rule set definitions + +## SYNTAX + +``` +Get-AzFrontDoorWafManagedRuleSetDefinition [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the list of WAF managed rule set definitions to use as reference + +## EXAMPLES + +### Example 1 +```powershell +Get-AzFrontDoorWafManagedRuleSetDefinition +``` + +```output +ProvisioningState RuleSetType RuleSetVersion RuleGroups +----------------- ----------- -------------- ---------- +Succeeded DefaultRuleSet 1.0 {PROTOCOL-ATTACK, LFI, RFI, RCE...} +Succeeded Microsoft_BotManagerRuleSet 1.0 {BadBots, GoodBots, UnknownBots} +Succeeded DefaultRuleSet preview-0.1 {LFI, RFI, RCE, PHP...} +Succeeded BotProtection preview-0.1 {KnownBadBots} +``` + +Get WAF managed rule set definitions. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSManagedRuleSetDefinition + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoorWafManagedRuleObject](./New-AzFrontDoorWafManagedRuleObject.md) +[New-AzFrontDoorWafManagedRuleOverrideObject](./New-AzFrontDoorWafManagedRuleOverrideObject.md) +[New-AzFrontDoorWafRuleGroupOverrideObject](./New-AzFrontDoorWafRuleGroupOverrideObject.md) diff --git a/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoorWafPolicy.md b/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoorWafPolicy.md new file mode 100644 index 0000000000..4c984a1739 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Get-AzFrontDoorWafPolicy.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/get-azfrontdoorwafpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Get-AzFrontDoorWafPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Get-AzFrontDoorWafPolicy.md +--- + +# Get-AzFrontDoorWafPolicy + +## SYNOPSIS +Get WAF policy + +## SYNTAX + +``` +Get-AzFrontDoorWafPolicy -ResourceGroupName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzFrontDoorWafPolicy** cmdletGet gets WAF policy in a resource group under the current subscription + +## EXAMPLES + +### Example 1 +```powershell +Get-AzFrontDoorWafPolicy -Name $policyName -ResourceGroupName $resourceGroupName +``` + +```output +Name PolicyMode PolicyEnabledState CustomBlockResponseStatusCode RedirectUrl +---- ---------- ------------------ ----------------------------- ----------- +{policyName} Prevention Enabled 403 https://www.bing.com/ +``` + +Get a WAF policy called $policyName in $resourceGroupName + +### Example 2 +```powershell +Get-AzFrontDoorWafPolicy -ResourceGroupName $resourceGroupName +``` + +```output +Name PolicyMode PolicyEnabledState CustomBlockResponseStatusCode RedirectUrl +---- ---------- ------------------ ----------------------------- ----------- +{policyName} Prevention Disabled +{policyName} Detection Enabled 403 https://www.bing.com/ +{policyName} Detection Enabled 404 +``` + +Get all WAF policy in $resourceGroupName + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +FireWallPolicy name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoorWafPolicy](./New-AzFrontDoorWafPolicy.md) +[Update-AzFrontDoorWafPolicy](./Update-AzFrontDoorWafPolicy.md) +[Remove-AzFrontDoorWafPolicy](./Remove-AzFrontDoorWafPolicy.md) diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoor.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoor.md new file mode 100644 index 0000000000..af2770ae8d --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoor.md @@ -0,0 +1,301 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoor.md +--- + +# New-AzFrontDoor + +## SYNOPSIS +Create a new Azure Front Door load balancer + +## SYNTAX + +### ByFieldsWithBackendPoolsSettingParameterSet (Default) +``` +New-AzFrontDoor -ResourceGroupName <String> -Name <String> -RoutingRule <PSRoutingRule[]> + -BackendPool <PSBackendPool[]> -FrontendEndpoint <PSFrontendEndpoint[]> + -LoadBalancingSetting <PSLoadBalancingSetting[]> -HealthProbeSetting <PSHealthProbeSetting[]> + [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] [-BackendPoolsSetting <PSBackendPoolsSetting>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFieldsWithCertificateNameCheckParameterSet +``` +New-AzFrontDoor -ResourceGroupName <String> -Name <String> -RoutingRule <PSRoutingRule[]> + -BackendPool <PSBackendPool[]> -FrontendEndpoint <PSFrontendEndpoint[]> + -LoadBalancingSetting <PSLoadBalancingSetting[]> -HealthProbeSetting <PSHealthProbeSetting[]> + [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] [-DisableCertificateNameCheck] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFrontDoor** cmdlet creates a new Azure Front Door load balancer in the specified resource group under current subscription + +## EXAMPLES + +### Example 1: Create a Front Door based on given parameters. +```powershell +New-AzFrontDoor -Name "frontDoor1" -ResourceGroupName "rg1" -RoutingRule $routingrule1 -BackendPool $backendpool1 -FrontendEndpoint $frontendEndpoint1 -LoadBalancingSetting $loadBalancingSetting1 -HealthProbeSetting $healthProbeSetting1 -BackendPoolsSetting $backendPoolsSetting1 +``` + +```output +FriendlyName : frontdoor1 +RoutingRules : {routingrule1} +BackendPools : {backendpool1} +BackendPoolsSetting : {backendPoolsSetting1} +EnforceCertificateNameCheck : {backendPoolsSetting1.EnforceCertificateNameCheck} +HealthProbeSettings : {healthProbeSetting1} +LoadBalancingSettings : {loadbalancingsetting1} +FrontendEndpoints : {frontendendpoint1} +EnabledState : Enabled +ResourceState : Enabled +ProvisioningState : Succeeded +Cname : +Tags : {tag1, tag2} +Id : /subscriptions/{guid}/resourcegroups/rg1/providers/Microsoft.Network/frontdoors/frontdoor1 +Name : frontdoor1 +Type : Microsoft.Network/frontdoors +``` + +Create a Front Door based on given parameters. + +## PARAMETERS + +### -BackendPool +Backendpools available to routing rule. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSBackendPool[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendPoolsSetting +Settings for all backendPools + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSBackendPoolsSetting +Parameter Sets: ByFieldsWithBackendPoolsSettingParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableCertificateNameCheck +Whether to disable certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByFieldsWithCertificateNameCheckParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +EnabledState of the Front Door load balancer. +Default value is Enabled + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendEndpoint +Frontend endpoints available to routing rule. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthProbeSetting +Health probe settings associated with this Front Door instance. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSHealthProbeSetting[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancingSetting +Load balancing settings associated with this Front Door instance. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSLoadBalancingSetting[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Front Door name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name that the Front Door will be created in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingRule +Routing rules associated with this FrontDoor + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSRoutingRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags associate with the FrontDoor. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor +## NOTES + +## RELATED LINKS + +[Get-AzFrontDoor](./Get-AzFrontDoor.md) +[Set-AzFrontDoor](./Set-AzFrontDoor.md) +[Remove-AzFrontDoor](./Remove-AzFrontDoor.md) +[New-AzFrontDoorRoutingRuleObject](./New-AzFrontDoorRoutingRuleObject.md) +[New-AzFrontDoorHealthProbeSettingObject](./New-AzFrontDoorHealthProbeSettingObject.md) +[New-AzFrontDoorLoadBalancingSettingObject](./New-AzFrontDoorLoadBalancingSettingObject.md) +[New-AzFrontDoorFrontendEndpointObject](./New-AzFrontDoorFrontendEndpointObject.md) +[New-AzFrontDoorBackendPoolObject](./New-AzFrontDoorBackendPoolObject.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorBackendObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorBackendObject.md new file mode 100644 index 0000000000..b9cec4d89c --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorBackendObject.md @@ -0,0 +1,254 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorbackendobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorBackendObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorBackendObject.md +--- + +# New-AzFrontDoorBackendObject + +## SYNOPSIS +Create a PSBackend object + +## SYNTAX + +``` +New-AzFrontDoorBackendObject -Address <String> [-HttpPort <Int32>] [-HttpsPort <Int32>] [-Priority <Int32>] + [-Weight <Int32>] [-EnabledState <PSEnabledState>] [-BackendHostHeader <String>] [-PrivateLinkAlias <String>] + [-PrivateLinkResourceId <String>] [-PrivateLinkLocation <String>] [-PrivateLinkApprovalMessage <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a PSBackend object for Front Door creation + +## EXAMPLES + +### Example 1 +```powershell +New-AzFrontDoorBackendObject -Address "contoso1.azurewebsites.net" +``` + +```output +Address : contoso1.azurewebsites.net +HttpPort : 80 +HttpsPort : 443 +Priority : 1 +Weight : 50 +BackendHostHeader : +EnabledState : Enabled +``` + +Create a PSBackend object for Front Door creation + +## PARAMETERS + +### -Address +Location of the backend (IP address or FQDN) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendHostHeader +The value to use as the host header sent to the backend. +Default value is the backend address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Whether to enable use of this backend. +Default value is Enabled + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPort +The HTTP TCP port number. +Must be between 1 and 65535. +Default value is 80. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsPort +The HTTPS TCP port number. +Must be between 1 and 65535. +Default value is 443 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Priority to use for load balancing. +Must be between 1 and 5. +Default value is 1 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkAlias +The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkApprovalMessage +A custom message to be included in the approval request to connect to the Private Link + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkLocation +The Location of Private Link resource. Location is required when PrivateLinkResourceId is set + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkResourceId +The Resource ID of the Private Link. Populating this optional field indicates that this backend is 'Private' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Weight +Weight of this endpoint for load balancing purposes. +Must be between 1 and 1000. +Default value is 50 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSBackend + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoorBackendPoolObject](./New-AzFrontDoorBackendPoolObject.md) diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorBackendPoolObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorBackendPoolObject.md new file mode 100644 index 0000000000..82edc220f0 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorBackendPoolObject.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorbackendpoolobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorBackendPoolObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorBackendPoolObject.md +--- + +# New-AzFrontDoorBackendPoolObject + +## SYNOPSIS +Create a PSBackendPool object for Front Door creation + +## SYNTAX + +``` +New-AzFrontDoorBackendPoolObject -ResourceGroupName <String> -Name <String> -FrontDoorName <String> + -Backend <PSBackend[]> -LoadBalancingSettingsName <String> -HealthProbeSettingsName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a PSBackendPool object for Front Door creation + +## EXAMPLES + +### Example 1 +```powershell +New-AzFrontDoorBackendPoolObject -Name "backendpool1" -FrontDoorName $Name -ResourceGroupName $resourceGroupName -Backend $backend1 -HealthProbeSettingsName "healthProbeSetting1" -LoadBalancingSettingsName "loadBalancingSetting1" +``` + +```output +Backends : {Microsoft.Azure.Commands.FrontDoor.Models.PSBackend} +LoadBalancingSettingRef : /subscriptions/{subid}/resourceGroups/{resourceGroupName}/providers + /Microsoft.Network/frontDoors/frontdoor5/LoadBalancingSettings/loadBalancingSetting1 +HealthProbeSettingRef : /subscriptions/{subid}/resourceGroups/{resourceGroupName}/providers + /Microsoft.Network/frontDoors/frontdoor5/HealthProbeSettings/healthProbeSetting1 +EnabledState : Enabled +ResourceState : +Id : +Name : backendpool1 +Type : +``` + +Create a PSBackendPool object for Front Door creation + +## PARAMETERS + +### -Backend +The set of backends for this pool. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSBackend[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontDoorName +The name of the Front Door to which this routing rule belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthProbeSettingsName +The name of the health probe settings for this backend pool + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancingSettingsName +The name of the load balancing settings for this backend pool + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +BackendPool name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name that the RoutingRule will be created in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSBackendPool + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoor](./New-AzFrontDoor.md) +[Set-AzFrontDoor](./Set-AzFrontDoor.md) +[New-AzFrontDoorBackendObject](./New-AzFrontDoorBackendObject.md) diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorBackendPoolsSettingObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorBackendPoolsSettingObject.md new file mode 100644 index 0000000000..6809c43295 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorBackendPoolsSettingObject.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorbackendpoolssettingobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorBackendPoolsSettingObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorBackendPoolsSettingObject.md +--- + +# New-AzFrontDoorBackendPoolsSettingObject + +## SYNOPSIS +Create a PSBackendPoolsSetting object for Front Door creation. + +## SYNTAX + +``` +New-AzFrontDoorBackendPoolsSettingObject [-EnforceCertificateNameCheck <PSEnabledState>] + [-SendRecvTimeoutInSeconds <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFrontDoorBackendPoolsSettingObject** cmdlet creates a new PSBackendPoolsSettings object for Front Door creation. + +## EXAMPLES + +### Example 1: Create BackendPoolsSettings object using defaults +```powershell +New-AzFrontDoorBackendPoolsSettingObject +``` + +```output +EnforceCertificateNameCheck : Enabled +SendRecvTimeoutInSeconds : 30 +Id : +Name : +Type : +``` + +### Example 2: Create BackendPoolsSettings object with user specified values +```powershell +New-AzFrontDoorBackendPoolsSettingObject -SendRecvTimeoutInSeconds 60 -EnforceCertificateNameCheck Enabled +``` + +```output +EnforceCertificateNameCheck : Enabled +SendRecvTimeoutInSeconds : 60 +Id : +Name : +Type : +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforceCertificateNameCheck +Whether to enforce certificate name check on HTTPS requests to all backend pools. +No effect on non-HTTPS requests. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendRecvTimeoutInSeconds +Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSBackendPoolsSetting + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorFrontendEndpointObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorFrontendEndpointObject.md new file mode 100644 index 0000000000..1925f5fd7b --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorFrontendEndpointObject.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorfrontendendpointobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorFrontendEndpointObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorFrontendEndpointObject.md +--- + +# New-AzFrontDoorFrontendEndpointObject + +## SYNOPSIS +Create a PSFrontendEndpoint Object for Front Door creation + +## SYNTAX + +``` +New-AzFrontDoorFrontendEndpointObject -Name <String> -HostName <String> + [-SessionAffinityEnabledState <PSEnabledState>] [-SessionAffinityTtlInSeconds <Int32>] + [-WebApplicationFirewallPolicyLink <String>] [-CertificateSource <String>] [-MinimumTlsVersion <String>] + [-ProtocolType <String>] [-Vault <String>] [-SecretName <String>] [-SecretVersion <String>] + [-CertificateType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a PSFrontendEndpoint Object for Front Door creation + +## EXAMPLES + +### Example 1 +```powershell +New-AzFrontDoorFrontendEndpointObject -Name "frontendendpoint1" -HostName "frontendendpoint1" +``` + +```output +HostName : frontendendpoint1 +SessionAffinityEnabledState : Disabled +SessionAffinityTtlSeconds : 0 +WebApplicationFirewallPolicyLink : +Backends : +CustomHttpsProvisioningState : +CustomHttpsProvisioningSubstate : +CertificateSource : +MinimumTlsVersion : 1.2 +Vault : +SecretName : +SecretVersion : +CertificateType : +ResourceState : +Id : +Name : frontendendpoint1 +Type : +ProtocolType : ServerNameIndication +``` + +Create a PSFrontendEndpoint Object for Front Door creation. + +## PARAMETERS + +### -CertificateSource +The source of the SSL certificate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateType +the type of the certificate used for secure connections to a frontendEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +The host name of the frontendEndpoint. +Must be a domain name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +The minimum TLS version required from the clients to establish an SSL handshake with Front Door. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Frontend endpoint name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtocolType +The TLS extension protocol that is used for secure delivery + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretName +The name of the Key Vault secret representing the full certificate PFX + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretVersion +The version of the Key Vault secret representing the full certificate PFX + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionAffinityEnabledState +Whether to allow session affinity on this host. +Default value is Disabled + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionAffinityTtlInSeconds +The TTL to use in seconds for session affinity, if applicable. +Default value is 0 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vault +The Key Vault containing the SSL certificate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApplicationFirewallPolicyLink +The resource id of Web Application Firewall policy for each host (if applicable) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint +## NOTES + +## RELATED LINKS + +[New-AzFrontDoor](./New-AzFrontDoor.md) +[Set-AzFrontDoor](./Set-AzFrontDoor.md) diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorHeaderActionObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorHeaderActionObject.md new file mode 100644 index 0000000000..4c2638276d --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorHeaderActionObject.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorheaderactionobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorHeaderActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorHeaderActionObject.md +--- + +# New-AzFrontDoorHeaderActionObject + +## SYNOPSIS +Create PSHeaderAction object. + +## SYNTAX + +``` +New-AzFrontDoorHeaderActionObject -HeaderName <String> -HeaderActionType <PSHeaderActionType> [-Value <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates PSHeaderAction object for the creation of PSRulesEngineAction object. + +## EXAMPLES + +### Example 1 +```powershell +New-AzFrontDoorHeaderActionObject -HeaderName headername -HeaderActionType Append +``` + +```output +HeaderName HeaderActionType Value +---------- ---------------- ----- +headername Append +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderActionType +Which type of manipulation to apply to the header. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSHeaderActionType +Parameter Sets: (All) +Aliases: +Accepted values: Append, Delete, Overwrite + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderName +The name of the header this action will apply to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The value to update the given header name with. +This value is not used if the actionType is Delete. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSHeaderAction + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorHealthProbeSettingObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorHealthProbeSettingObject.md new file mode 100644 index 0000000000..e59d0e0981 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorHealthProbeSettingObject.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorhealthprobesettingobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorHealthProbeSettingObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorHealthProbeSettingObject.md +--- + +# New-AzFrontDoorHealthProbeSettingObject + +## SYNOPSIS +Create a PSHealthProbeSetting object for Front Door creation + +## SYNTAX + +``` +New-AzFrontDoorHealthProbeSettingObject -Name <String> [-Path <String>] [-Protocol <PSProtocol>] + [-IntervalInSeconds <Int32>] [-HealthProbeMethod <String>] [-EnabledState <PSEnabledState>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a PSHealthProbeSetting object for Front Door creation + +## EXAMPLES + +### Example 1 +```powershell +New-AzFrontDoorHealthProbeSettingObject -Name "healthProbeSetting1" +``` + +```output +Path : / +Protocol : Http +IntervalInSeconds : 30 +ResourceState : +HealthProbeMethod : Head +EnabledState : Enabled +Id : +Name : healthProbeSetting1 +Type : +``` + +Note: HealthProbeMethod setting is not case sensitive. + +Create a PSHealthProbeSetting object for Front Door creation + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthProbeMethod +Configures which HTTP method to use to probe the backends defined under backendPools. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntervalInSeconds +The number of seconds between health probes. +Default value is 30 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Health probe setting name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path to use for the health probe. +Default is / + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol scheme to use for this probe +Default value is HTTP + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSProtocol +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSHealthProbeSetting +## NOTES + +## RELATED LINKS + +[New-AzFrontDoor](./New-AzFrontDoor.md) +[Set-AzFrontDoor](./Set-AzFrontDoor.md) diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorLoadBalancingSettingObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorLoadBalancingSettingObject.md new file mode 100644 index 0000000000..310cc7b981 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorLoadBalancingSettingObject.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorloadbalancingsettingobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorLoadBalancingSettingObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorLoadBalancingSettingObject.md +--- + +# New-AzFrontDoorLoadBalancingSettingObject + +## SYNOPSIS +Create a PSLoadBalancingSetting object for Front Door creation + +## SYNTAX + +``` +New-AzFrontDoorLoadBalancingSettingObject -Name <String> [-SampleSize <Int32>] + [-SuccessfulSamplesRequired <Int32>] [-AdditionalLatencyInMilliseconds <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a PSLoadBalancingSetting object for Front Door creation + +## EXAMPLES + +### Example 1 +```powershell +New-AzFrontDoorLoadBalancingSettingObject -Name "loadbalancingsetting1" +``` + +```output +SampleSize : 4 +AdditionalLatencyMilliseconds : 0 +SuccessfulSamplesRequired : 2 +ResourceState : +Id : +Name : loadbalancingsetting1 +Type : +``` + +Create a PSLoadBalancingSetting object for Front Door creation + +## PARAMETERS + +### -AdditionalLatencyInMilliseconds +The additional latency in milliseconds for probes to fall into the lowest latency bucket. +Default value is 0 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +health probe setting name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SampleSize +The number of samples to consider for load balancing decisions. +Default value is 4 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuccessfulSamplesRequired +The number of samples within the sample period that must succeed +Default value is 2 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSLoadBalancingSetting + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoor](./New-AzFrontDoor.md) +[Set-AzFrontDoor](./Set-AzFrontDoor.md) diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRoutingRuleObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRoutingRuleObject.md new file mode 100644 index 0000000000..ed2457fa6e --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRoutingRuleObject.md @@ -0,0 +1,429 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorroutingruleobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorRoutingRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorRoutingRuleObject.md +--- + +# New-AzFrontDoorRoutingRuleObject + +## SYNOPSIS +Create a PSRoutingRuleObject for Front Door creation + +## SYNTAX + +### ByFieldsWithForwardingParameterSet (Default) +``` +New-AzFrontDoorRoutingRuleObject -ResourceGroupName <String> -FrontDoorName <String> -Name <String> + -FrontendEndpointName <String[]> -BackendPoolName <String> [-AcceptedProtocol <PSProtocol[]>] + [-PatternToMatch <String[]>] [-CustomForwardingPath <String>] [-ForwardingProtocol <String>] + [-EnableCaching <Boolean>] [-QueryParameterStripDirective <String>] [-DynamicCompression <PSEnabledState>] + [-EnabledState <PSEnabledState>] [-RulesEngineName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByFieldsWithRedirectParameterSet +``` +New-AzFrontDoorRoutingRuleObject -ResourceGroupName <String> -FrontDoorName <String> -Name <String> + -FrontendEndpointName <String[]> [-AcceptedProtocol <PSProtocol[]>] [-PatternToMatch <String[]>] + [-RedirectType <String>] [-RedirectProtocol <String>] [-CustomHost <String>] [-CustomPath <String>] + [-CustomFragment <String>] [-CustomQueryString <String>] [-EnabledState <PSEnabledState>] + [-RulesEngineName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a PSRoutingRuleObject for Front Door creation + +## EXAMPLES + +### Example 1: Create a PSRoutingRuleObject for Front Door creation with a forwarding rule +```powershell +New-AzFrontDoorRoutingRuleObject -Name $routingRuleName -FrontDoorName $frontDoorName -ResourceGroupName $rgname -FrontendEndpointName "frontendEndpoint1" -BackendPoolName "backendPool1" +``` + +```output +FrontendEndpointIds : {/subscriptions/{subid}/resourceGroups/{rgname}/pro + viders/Microsoft.Network/frontDoors/{frontdoorname}/FrontendEndpoints/frontendEndpoint1} +AcceptedProtocols : {Http, Https} +PatternsToMatch : {/*} +HealthProbeSettings : +RouteConfiguration : Microsoft.Azure.Commands.FrontDoor.Models.PSForwardingConfiguration +EnabledState : Enabled +ResourceState : +Id : +Name : {routingRuleName} +Type : +``` + +### Example 2: Create a PSRoutingRuleObject for Front Door creation with a redirect rule +```powershell +$customHost = "www.contoso.com" +$customPath = "/images/contoso.png" +$queryString = "field1=value1&field2=value2" +$destinationFragment = "section-header-2" +New-AzFrontDoorRoutingRuleObject -Name $routingRuleName -FrontDoorName $frontDoorName -ResourceGroupName $rgname -FrontendEndpointName "frontendEndpoint1" -CustomHost $customHost -CustomPath $customPath -CustomQueryString $queryString -CustomFragment $destinationFragment +``` + +```output +FrontendEndpointIds : {/subscriptions/{subid}/resourceGroups/{rgname}/pro + viders/Microsoft.Network/frontDoors/{frontdoorname}/FrontendEndpoints/frontendEndpoint1} +AcceptedProtocols : {Http, Https} +PatternsToMatch : {/*} +HealthProbeSettings : +RouteConfiguration : Microsoft.Azure.Commands.FrontDoor.Models.PSRedirectConfiguration +EnabledState : Enabled +ResourceState : +Id : +Name : {routingRuleName} +Type : +``` + +Create a PSRoutingRuleObject for Front Door creation + +## PARAMETERS + +### -AcceptedProtocol +Protocol schemes to match for this rule. +Default value is {Https, Http} + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSProtocol[] +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendPoolName +Resource id of the BackendPool which this rule routes to + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomForwardingPath +The custom path used to rewrite resource paths matched by this rule. +Leave empty to use incoming path. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomFragment +Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithRedirectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomHost +Host to redirect. Leave empty to use the incoming host as the destination host. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithRedirectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomPath +The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithRedirectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomQueryString +The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in `<key>=<value>` format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithRedirectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DynamicCompression +Whether to enable dynamic compression for cached content when caching is enabled. +Default value is Enabled + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCaching +Whether to enable caching for this route. +Default value is false + +```yaml +Type: System.Boolean +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Whether to enable use of this rule. +Default value is Enabled + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingProtocol +The protocol this rule will use when forwarding traffic to backends +Default value is MatchRequest. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontDoorName +The name of the Front Door to which this routing rule belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendEndpointName +The names of Frontend endpoints associated with this rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +RoutingRule name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PatternToMatch +The route patterns of the rule, Must not have any * except possibly after the final / at the end of the path. +Default value is /* + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryParameterStripDirective +The treatment of URL query terms when forming the cache key. +Default value is StripAll + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectProtocol +The protocol of the destination to where the traffic is redirected. Default value is MatchRequest + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithRedirectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectType +The redirect type the rule will use when redirecting traffic. Default Value is Moved + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithRedirectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name that the RoutingRule will be created in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RulesEngineName +A reference to a specific Rules Engine Configuration to apply to this route. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSRoutingRule + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoor](./New-AzFrontDoor.md) +[Set-AzFrontDoor](./Set-AzFrontDoor.md) diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRulesEngine.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRulesEngine.md new file mode 100644 index 0000000000..8655057b87 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRulesEngine.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorrulesengine +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorRulesEngine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorRulesEngine.md +--- + +# New-AzFrontDoorRulesEngine + +## SYNOPSIS +Create a new rules engine configuration for a specified front door. + +## SYNTAX + +``` +New-AzFrontDoorRulesEngine -ResourceGroupName <String> -FrontDoorName <String> -Name <String> + [-Rule <PSRulesEngineRule[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a new rules engine configuration for a specified front door. + +Use cmdlet "New-AzFrontDoorRulesEngineRule" to construct rules engine rules to pass into the "-Rules" parameter of this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +New-AzFrontDoorRulesEngine -ResourceGroupName $resourceGroupName -FrontDoorName $frontDoorName -Name myRulesEngine -Rule $rulesEngineRule1 +``` + +```output +Name RulesEngineRules +---- ---------------- +myRulesEngine {rules1} +``` + +Create a new rules engine configuration for specified front door. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontDoorName +Front Door name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Rules engine name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name that the Front Door will be created in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +A list of rules that define a particular Rules Engine Configuration. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngineRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngine + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRulesEngineActionObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRulesEngineActionObject.md new file mode 100644 index 0000000000..f2ac4f32fb --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRulesEngineActionObject.md @@ -0,0 +1,416 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorrulesengineactionobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorRulesEngineActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorRulesEngineActionObject.md +--- + +# New-AzFrontDoorRulesEngineActionObject + +## SYNOPSIS +Create a PSRulesEngineAction object for creating a rules engine rule. + +## SYNTAX + +### ByFieldsWithRegularActionParameterSet (Default) +``` +New-AzFrontDoorRulesEngineActionObject + [-RequestHeaderAction <System.Collections.Generic.List`1[Microsoft.Azure.Commands.FrontDoor.Models.PSHeaderAction]>] + [-ResponseHeaderAction <System.Collections.Generic.List`1[Microsoft.Azure.Commands.FrontDoor.Models.PSHeaderAction]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFieldsWithForwardingParameterSet +``` +New-AzFrontDoorRulesEngineActionObject + [-RequestHeaderAction <System.Collections.Generic.List`1[Microsoft.Azure.Commands.FrontDoor.Models.PSHeaderAction]>] + [-ResponseHeaderAction <System.Collections.Generic.List`1[Microsoft.Azure.Commands.FrontDoor.Models.PSHeaderAction]>] + [-CustomForwardingPath <String>] [-ForwardingProtocol <String>] -ResourceGroupName <String> + -FrontDoorName <String> -BackendPoolName <String> [-EnableCaching <Boolean>] + [-QueryParameterStripDirective <String>] [-DynamicCompression <PSEnabledState>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFieldsWithRedirectParameterSet +``` +New-AzFrontDoorRulesEngineActionObject + [-RequestHeaderAction <System.Collections.Generic.List`1[Microsoft.Azure.Commands.FrontDoor.Models.PSHeaderAction]>] + [-ResponseHeaderAction <System.Collections.Generic.List`1[Microsoft.Azure.Commands.FrontDoor.Models.PSHeaderAction]>] + [-RedirectType <String>] [-RedirectProtocol <String>] [-CustomHost <String>] [-CustomPath <String>] + [-CustomFragment <String>] [-CustomQueryString <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a PSRulesEngineAction object for creating a rules engine rule. + +Use cmdlet "New-AzFrontDoorHeaderActionObject" to create PSHeaderObjects to pass into the parameters "-RequestHeaderActions" and "-ResponseHeaderActions". + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> +```powershell +$headerActions = New-AzFrontDoorHeaderActionObject -HeaderActionType "Append" -HeaderName "X-Content-Type-Options" -Value "nosniff" +$headerActions + +HeaderName HeaderActionType Value +---------- ---------------- ----- +X-Content-Type-Options Append nosniff + +$rulesEngineAction = New-AzFrontDoorRulesEngineActionObject -ResponseHeaderAction $headerActions +$rulesEngineAction + +RequestHeaderActions ResponseHeaderActions RouteConfigurationOverride +-------------------- --------------------- -------------------------- +{} {X-Content-Type-Options} + +``` + +Create a rules engine action that append response header value and show how to view the properties of the rules engine action created. + +### Example 2 +<!-- Skip: Output cannot be splitted from code --> +```powershell +$rulesEngineAction = New-AzFrontDoorRulesEngineActionObject -RequestHeaderAction $headerActions -ForwardingProtocol HttpsOnly -BackendPoolName mybackendpool -ResourceGroupName Jessicl-Test-RG -FrontDoorName jessicl-test-myappfrontend -QueryParameterStripDirective StripNone -DynamicCompression Disabled -EnableCaching $true +$rulesEngineAction + +RequestHeaderAction ResponseHeaderAction RouteConfigurationOverride +------------------- -------------------- -------------------------- +{headeraction1, headeraction2} {} Microsoft.Azure.Commands.FrontDoor.Models.PSForwardingConfiguration + +$rulesEngineAction.RequestHeaderAction + +HeaderName HeaderActionType Value +---------- ---------------- ----- +headeraction1 Overwrite +headeraction2 Append + +$rulesEngineAction.ResponseHeaderAction +$rulesEngineAction.RouteConfigurationOverride + +CustomForwardingPath : +ForwardingProtocol : HttpsOnly +BackendPoolId : /subscriptions/47f4bc68-6fe4-43a2-be8b-dfd0e290efa2/resourceGroups/myresourcegroup/provi + ders/Microsoft.Network/frontDoors/myfrontdoor/BackendPools/mybackendpool +QueryParameterStripDirective : StripNone +DynamicCompression : Disabled +EnableCaching : True +``` + +Create a rules engine action that forwards the requests to a speicific backend pool and show how to view the properties of the rules engine action created. + +### Example 3 +<!-- Skip: Output cannot be splitted from code --> +```powershell +$rulesEngineAction = New-AzFrontDoorRulesEngineActionObject -RedirectType Moved -RedirectProtocol MatchRequest -CustomHost www.contoso.com +$rulesEngineAction + +RequestHeaderActions ResponseHeaderActions RouteConfigurationOverride +-------------------- --------------------- -------------------------- +{} {} Microsoft.Azure.Commands.FrontDoor.Models.PSRedirectConfiguration + +$rulesEngineAction.RouteConfigurationOverride + +RedirectType : Moved +RedirectProtocol : MatchRequest +CustomHost : www.contoso.com +CustomPath : +CustomFragment : +CustomQueryString : + +``` + +Create a rules engine action that redirects the requests to another host and show how to view the properties of the rules engine action created. + + +## PARAMETERS + +### -BackendPoolName +The name of the BackendPool which this rule routes to + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomForwardingPath +The custom path used to rewrite resource paths matched by this rule. +Leave empty to use incoming path. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomFragment +Fragment to add to the redirect URL. +Fragment is the part of the URL that comes after #. +Do not include the #. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithRedirectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomHost +Host to redirect. +Leave empty to use the incoming host as the destination host. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithRedirectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomPath +The full path to redirect. +Path cannot be empty and must start with /. +Leave empty to use the incoming path as destination path. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithRedirectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomQueryString +The set of query strings to be placed in the redirect URL. +Setting this value would replace any existing query string; leave empty to preserve the incoming query string. +Query string must be in \<key\>=\<value\> format. +The first ? +and & will be added automatically so do not include them in the front, but do separate multiple query strings with &. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithRedirectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DynamicCompression +Whether to enable dynamic compression for cached content. +Default value is Enabled + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCaching +Whether to enable caching for this route. +Default value is false + +```yaml +Type: System.Boolean +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingProtocol +The protocol this rule will use when forwarding traffic to backends. +Default value is MatchRequest + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontDoorName +The name of the Front Door to which this routing rule belongs. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryParameterStripDirective +The treatment of URL query terms when forming the cache key. +Default value is StripAll + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectProtocol +The protocol of the destination to where the traffic is redirected. +Default value is MatchRequest + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithRedirectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectType +The redirect type the rule will use when redirecting traffic. +Default Value is Moved + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithRedirectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestHeaderAction +A list of header actions to apply from the request from AFD to the origin. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.FrontDoor.Models.PSHeaderAction] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name that the RoutingRule will be created in. + +```yaml +Type: System.String +Parameter Sets: ByFieldsWithForwardingParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseHeaderAction +A list of header actions to apply from the response from AFD to the client. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.FrontDoor.Models.PSHeaderAction] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngineAction + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRulesEngineMatchConditionObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRulesEngineMatchConditionObject.md new file mode 100644 index 0000000000..0256b0e141 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRulesEngineMatchConditionObject.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorrulesenginematchconditionobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorRulesEngineMatchConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorRulesEngineMatchConditionObject.md +--- + +# New-AzFrontDoorRulesEngineMatchConditionObject + +## SYNOPSIS +Create a PSRulesEngineMatchCondition object for creating a rules engine rule. + +## SYNTAX + +``` +New-AzFrontDoorRulesEngineMatchConditionObject -MatchVariable <PSRulesEngineMatchVariable> + -MatchValue <String[]> [-Selector <String>] [-Operator <PSRulesEngineOperator>] [-NegateCondition <Boolean>] + [-Transform <PSTransform[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a PSRulesEngineMatchCondition object for creating a rules engine rule. + +## EXAMPLES + +### Example 1 +```powershell +New-AzFrontDoorRulesEngineMatchConditionObject -MatchVariable RequestHeader -Operator Equal -MatchValue allowoverride -Transform "LowerCase", "UpperCase"-Selector Rules-Engine-Route-Forward -NegateCondition $false +``` + +```output +RulesEngineMatchVariable : RequestHeader +RulesEngineMatchValue : {allowoverride} +Selector : Rules-Engine-Route-Forward +RulesEngineOperator : Equal +NegateCondition : False +Transform : {Lowercase, Uppercase} +``` + +Greate a new PSRulesEngineMatchCondition object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchValue +Match values to match against. +The operator will apply to each value in here with OR semantics. +If any of them match the variable with the given operator this match condition is considered a match. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchVariable +Match Variable. +Possible values are IsMobile, RemoteAddr, RequestMethod, QueryString, PostArg, RequestUri, RequestPath, RequestFileName, RequestfilenameExtension, RequestHeader, RequestBody, RequestScheme + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngineMatchVariable +Parameter Sets: (All) +Aliases: +Accepted values: IsMobile, RemoteAddr, RequestMethod, QueryString, PostArgs, RequestUri, RequestPath, RequestFilename, RequestFilenameExtension, RequestHeader, RequestBody, RequestScheme + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NegateCondition +Describes if this is negate condition or not + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operator +Describes operator to apply to the match condition. +Possible values are Any, IPMatch, GeoMatch, Equal, Contains, LessThan, GreaterThan, LessThanOrEqual, GreaterThanOrEqual, BeginsWith, EndsWith. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngineOperator +Parameter Sets: (All) +Aliases: +Accepted values: Any, IPMatch, GeoMatch, Equal, Contains, LessThan, GreaterThan, LessThanOrEqual, GreaterThanOrEqual, BeginsWith, EndsWith + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Selector +Name of selector in RequestHeader or RequestBody to be matched + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Transform +List of what transforms are applied before matching. Possible individual transform values are Lowercase, Uppercase, Trim, UrlDecode, UrlEncode, RemoveNulls. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSTransform[] +Parameter Sets: (All) +Aliases: +Accepted values: Lowercase, Uppercase, Trim, UrlDecode, UrlEncode, RemoveNulls + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngineMatchCondition + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRulesEngineRuleObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRulesEngineRuleObject.md new file mode 100644 index 0000000000..87fdaaca61 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorRulesEngineRuleObject.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorrulesengineruleobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorRulesEngineRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorRulesEngineRuleObject.md +--- + +# New-AzFrontDoorRulesEngineRuleObject + +## SYNOPSIS +Create a PSRulesEngineRule object for Rules Engine creation. + +## SYNTAX + +``` +New-AzFrontDoorRulesEngineRuleObject -Name <String> -Priority <Int32> -Action <PSRulesEngineAction> + [-MatchProcessingBehavior <PSMatchProcessingBehavior>] [-MatchCondition <PSRulesEngineMatchCondition[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a PSRulesEngineRule object for Rules Engine creation. + +Use cmdlet "New-AzFrontDoorRulesEngineActionObject" to create PSRulesEngineAction object to pass into the "-Action" parameter. +Use cmdlet "New-AzFrontDoorRulesEngineMatchConditionObject" to create PSRulesEngineMatchCondition object to pass into the "-MatchCondition" parameter. + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> +```powershell +New-AzFrontDoorRulesEngineRuleObject -Name rules1 -Priority 0 -Action $rulesEngineAction -MatchProcessingBehavior Stop -MatchCondition $rulesEngineMatchCondition + +Name : rules1 +Priority : 0 +MatchProcessingBehavior : Stop +MatchCondition : {Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngineMatchCondition} +Action : Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngineAction + + +$rulesEngineRule1.Action + +RequestHeaderActions ResponseHeaderActions RouteConfigurationOverride +-------------------- --------------------- -------------------------- +{headeraction1, headeraction2} {} Microsoft.Azure.Commands.FrontDoor.Models.PSForwardingConfiguration + +$rulesEngineRule1.MatchCondition[0] + +RulesEngineMatchVariable : RequestHeader +RulesEngineMatchValue : {allowoverride} +Selector : Rules-Engine-Route-Forward +RulesEngineOperator : Equal +NegateCondition : False +Transforms : {Lowercase, Uppercase} +``` + +Create new PSRulesEngineRule object and demonstrate how to see the subfields. + +### Example 2 +```powershell +New-AzFrontDoorRulesEngineRuleObject -Name rules1 -Priority -1 +``` + +```output +New-AzFrontDoorRulesEngineRuleObject : Cannot validate argument on parameter 'Priority'. The -1 argument is less than the minimum allowed range of 0. Supply an argument that is greater than or equal to 0 and then try the command again. +At line:1 char:81 ++ ... ule1 = New-AzFrontDoorRulesEngineRuleObject -Name rules1 -Priority -1 ++ ~~ ++ CategoryInfo : InvalidData: (:) [New-AzFrontDoorRulesEngineRuleObject], ParameterBindingValidationException ++ FullyQualifiedErrorId : ParameterArgumentValidationError,Microsoft.Azure.Commands.FrontDoor.Cmdlets.NewFrontDoorRulesEngineRuleObject +``` + +Expect output when passing in invalid priority value. + +## PARAMETERS + +### -Action +Actions to perform on the request and response if all of the match conditions are met. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngineAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchCondition +A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngineMatchCondition[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchProcessingBehavior +If this rule is a match should the rules engine continue running the remaining rules or stop. +Possible values are Continue and Stop. +If not present, defaults to Continue. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSMatchProcessingBehavior +Parameter Sets: (All) +Aliases: +Accepted values: Continue, Stop + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +A name to refer to this specific rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +A priority assigned to this rule. +Cannot be negative. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngineRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafCustomRuleObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafCustomRuleObject.md new file mode 100644 index 0000000000..7c553ae5c9 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafCustomRuleObject.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorwafcustomruleobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafCustomRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafCustomRuleObject.md +--- + +# New-AzFrontDoorWafCustomRuleObject + +## SYNOPSIS +Create CustomRule Object for WAF policy creation + +## SYNTAX + +``` +New-AzFrontDoorWafCustomRuleObject -Name <String> -RuleType <String> -MatchCondition <PSMatchCondition[]> + -Action <String> -Priority <Int32> [-RateLimitDurationInMinutes <Int32>] [-RateLimitThreshold <Int32>] + [-EnabledState <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create CustomRule Object for WAF policy creation + +## EXAMPLES + +### Example 1 +```powershell +New-AzFrontDoorWafCustomRuleObject -Name "Rule1" -RuleType MatchRule -MatchCondition $matchCondition1 -Action Block -Priority 2 +``` + +```output +Name RuleType Action Priority RateLimitDurationInMinutes +---- -------- ------ -------- -------------------------- +Rule1 MatchRule Block 2 1 +``` + +Create a CustomRule Object + +## PARAMETERS + +### -Action +Type of Actions. +Possible values include: 'Allow', 'Block', 'Log' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Enabled State. Possible values include: 'Enabled', 'Disabled'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchCondition +List of match conditions. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSMatchCondition[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Describes priority of the rule. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RateLimitDurationInMinutes +Rate limit duration. Default - 1 minute + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RateLimitThreshold +Rate limit threshold + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleType +Type of the rule. +Possible values include: 'MatchRule', 'RateLimitRule' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSCustomRule + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoorWafPolicy](./New-AzFrontDoorWafPolicy.md) +[Update-AzFrontDoorWafPolicy](./Update-AzFrontDoorWafPolicy.md) diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafManagedRuleExclusionObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafManagedRuleExclusionObject.md new file mode 100644 index 0000000000..9de435ae86 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafManagedRuleExclusionObject.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorwafmanagedruleexclusionobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafManagedRuleExclusionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafManagedRuleExclusionObject.md +--- + +# New-AzFrontDoorWafManagedRuleExclusionObject + +## SYNOPSIS +Create managed rule exclusion object for WAF managed rule sets, groups, or rules. + +## SYNTAX + +``` +New-AzFrontDoorWafManagedRuleExclusionObject -Variable <String> -Operator <String> [-Selector <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create managed rule exclusion object for WAF managed rule sets, groups, or rules. + +## EXAMPLES + +### Example 1 +```powershell +New-AzFrontDoorWafManagedRuleExclusionObject -Variable QueryStringArgNames -Operator Equals -Selector "ParameterName" +``` + +```output +MatchVariable SelectorMatchOperator Selector +------------- --------------------- -------- +QueryStringArgNames Equals ParameterName +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operator +Operator to use when matching the selector, EqualsAny means no selector (all match variables of the specified type) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Selector +Selector pattern to match using the operator (if the operator is not EqualsAny) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Variable +Match variable. Possible values are RequestHeaderNames, RequestCookieNames, QueryStringArgNames, RequestBodyPostArgNames. +For example, QueryStringArgNames is an exclusion of GET parameters matching the selector with the given operator. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSManagedRuleExclusion + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoorWafManagedRuleOverrideObject](./New-AzFrontDoorWafManagedRuleOverrideObject.md) +[New-AzFrontDoorWafRuleGroupOverrideObject](./New-AzFrontDoorWafRuleGroupOverrideObject.md) +[New-AzFrontDoorWafManagedRuleObject](./New-AzFrontDoorWafManagedRuleObject.md) diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafManagedRuleObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafManagedRuleObject.md new file mode 100644 index 0000000000..0f1e85e18c --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafManagedRuleObject.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorwafmanagedruleobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafManagedRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafManagedRuleObject.md +--- + +# New-AzFrontDoorWafManagedRuleObject + +## SYNOPSIS +Create ManagedRule Object for WAF policy creation + +## SYNTAX + +``` +New-AzFrontDoorWafManagedRuleObject -Type <String> -Version <String> [-Action <String>] + [-RuleGroupOverride <PSAzureRuleGroupOverride[]>] [-Exclusion <PSManagedRuleExclusion[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create ManagedRule Object for WAF policy creation + +## EXAMPLES + +### Example 1 +```powershell +$ruleOverride1 = New-AzFrontDoorWafManagedRuleOverrideObject -RuleId "942250" -Action Log +$ruleOverride2 = New-AzFrontDoorWafManagedRuleOverrideObject -RuleId "942251" -Action Log +$override1 = New-AzFrontDoorWafRuleGroupOverrideObject -RuleGroupName SQLI -ManagedRuleOverride $ruleOverride1,$ruleOverride2 + +$ruleOverride3 = New-AzFrontDoorWafManagedRuleOverrideObject -RuleId "941280" -Action Log +$override2 = New-AzFrontDoorWafRuleGroupOverrideObject -RuleGroupName XSS -ManagedRuleOverride $ruleOverride3 + +New-AzFrontDoorWafManagedRuleObject -Type DefaultRuleSet -Version "preview-0.1" -RuleGroupOverride $override1,$override2 +``` + +```output +RuleGroupOverrides RuleSetType RuleSetVersion +------------------ ----------- -------------- +{SQLI, XSS} DefaultRuleSet preview-0.1 +``` + +Create a ManagedRule Object + +## PARAMETERS + +### -Action +Rule Set Action. Possible values include: 'Allow', 'Block', 'Log', 'Redirect'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exclusion +Exclusion + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSManagedRuleExclusion[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleGroupOverride +List of azure managed provider override configuration + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSAzureRuleGroupOverride[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of the ruleset + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version of the ruleset + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSAzureManagedRule + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoorWafPolicy](./New-AzFrontDoorWafPolicy.md) +[Update-AzFrontDoorWafPolicy](./Update-AzFrontDoorWafPolicy.md) +[New-AzFrontDoorWafRuleGroupOverrideObject](./New-AzFrontDoorWafRuleGroupOverrideObject.md) diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafManagedRuleOverrideObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafManagedRuleOverrideObject.md new file mode 100644 index 0000000000..58bb523890 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafManagedRuleOverrideObject.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorwafmanagedruleoverrideobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafManagedRuleOverrideObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafManagedRuleOverrideObject.md +--- + +# New-AzFrontDoorWafManagedRuleOverrideObject + +## SYNOPSIS +Create managed rule override object + +## SYNTAX + +``` +New-AzFrontDoorWafManagedRuleOverrideObject -RuleId <String> [-Action <String>] [-Disabled] + [-Exclusion <PSManagedRuleExclusion[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create PSAzureManagedRuleOverride Object for managed WAF rule group override object creation. + +## EXAMPLES + +### Example 1 +Create a managed rule override object for rule 942250 (which is in SQLI group). + +```powershell +New-AzFrontDoorWafManagedRuleOverrideObject -RuleId "942250" -Action Log +``` + +```output +RuleId EnabledState Action +------ ------------ ------ +942250 Enabled Log +``` + +## PARAMETERS + +### -Action +Override Action + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +Disabled state + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exclusion +Exclusion + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSManagedRuleExclusion[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Rule ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSAzureManagedRuleOverride + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoorWafRuleGroupOverrideObject](./New-AzFrontDoorWafRuleGroupOverrideObject.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafMatchConditionObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafMatchConditionObject.md new file mode 100644 index 0000000000..0d39971670 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafMatchConditionObject.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorwafmatchconditionobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafMatchConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafMatchConditionObject.md +--- + +# New-AzFrontDoorWafMatchConditionObject + +## SYNOPSIS +Create MatchCondition Object for WAF policy creation + +## SYNTAX + +``` +New-AzFrontDoorWafMatchConditionObject -MatchVariable <String> -OperatorProperty <String> + [-MatchValue <String[]>] [-Selector <String>] [-NegateCondition <Boolean>] [-Transform <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create MatchCondition Object for WAF policy creation + +## EXAMPLES + +### Example 1 +```powershell +New-AzFrontDoorWafMatchConditionObject -MatchVariable RequestHeader -OperatorProperty Contains -Selector "User-Agent" -MatchValue "Windows" +``` + +```output +MatchVariable OperatorProperty MatchValue Selector NegateCondition Transform +------------- ---------------- ---------- -------- --------------- --------- +RequestHeader Contains {Windows} User-Agent False +``` + +### Example 2 +```powershell +New-AzFrontDoorWafMatchConditionObject -MatchVariable RequestHeader -OperatorProperty Contains -Selector "User-Agent" -MatchValue "WINDOWS" -Transform Uppercase +``` + +```output +MatchVariable OperatorProperty MatchValue Selector NegateCondition Transform +------------- ---------------- ---------- -------- --------------- --------- +RequestHeader Contains {WINDOWS} User-Agent False {Uppercase} +``` + +Create a MatchCondition object + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchValue +Match value. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchVariable +Match Variable. +Possible values include: 'RemoteAddr', 'RequestMethod', 'QueryString', 'PostArgs','RequestUri', 'RequestHeader', 'RequestBody', 'SocketAddr' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NegateCondition +Describes if this is negate condition or not +Default value is false + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperatorProperty +Describes operator to be matched. +Possible values include: 'Any', 'IPMatch', 'GeoMatch', 'Equal', 'Contains', 'LessThan', 'GreaterThan', 'LessThanOrEqual', 'GreaterThanOrEqual', 'BeginsWith', 'EndsWith', 'RegEx' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Selector +Name of selector in RequestHeader or RequestBody to be matched + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Transform +Transforms to apply. Possible values include: 'Lowercase', 'Uppercase', 'Trim', 'UrlDecode', 'UrlEncode', 'RemoveNulls'. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSMatchCondition + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoorWafCustomRuleObject](./New-AzFrontDoorWafCustomRuleObject.md) diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafPolicy.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafPolicy.md new file mode 100644 index 0000000000..8f16e9511d --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafPolicy.md @@ -0,0 +1,292 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorwafpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafPolicy.md +--- + +# New-AzFrontDoorWafPolicy + +## SYNOPSIS +Create WAF policy + +## SYNTAX + +``` +New-AzFrontDoorWafPolicy -ResourceGroupName <String> -Name <String> [-EnabledState <PSEnabledState>] + [-Mode <String>] [-Customrule <PSCustomRule[]>] [-ManagedRule <PSManagedRule[]>] [-RedirectUrl <String>] + [-CustomBlockResponseStatusCode <Int32>] [-CustomBlockResponseBody <String>] [-RequestBodyCheck <String>] + [-Tag <Hashtable>] [-Sku <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFrontDoorWafPolicy** cmdlet creates a new Azure WAF policy in the specified resource group under current subscription + +## EXAMPLES + +### Example 1: Create WAF policy +```powershell +New-AzFrontDoorWafPolicy -Name $policyName -ResourceGroupName $resourceGroupName -Customrule $customRule1,$customRule2 -ManagedRule $managedRule1 -EnabledState Enabled -Mode Prevention -RedirectUrl "https://www.bing.com/" -CustomBlockResponseStatusCode 405 -CustomBlockResponseBody "<html><head><title>You are blocked!</title></head><body></body></html>" +``` + +```output +Name PolicyMode PolicyEnabledState RedirectUrl +---- ---------- ------------------ ----------- +{policyName} Prevention Enabled https://www.bing.com/ +``` + +Create WAF policy + +## PARAMETERS + +### -CustomBlockResponseBody +Custom Response Body + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomBlockResponseStatusCode +Custom Response Status Code + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Customrule +Custom rules inside the policy + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSCustomRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Whether the policy is in enabled state or disabled state. +Possible values include: 'Disabled', 'Enabled' + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedRule +Managed rules inside the policy + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSManagedRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Describes if it is in detection mode or prevention mode at policy level. +Possible values include:'Prevention', 'Detection' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApplicationFireWallPolicy name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectUrl +Redirect URL + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestBodyCheck +Defines if the body should be inspected by managed rules. Possible values include: 'Enabled', 'Disabled' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags associate with the FrontDoor WAF Policy. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +Sets Sku. Possible values include: 'Classic_AzureFrontDoor', 'Standard_AzureFrontDoor', 'Premium_AzureFrontDoor' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy + +## NOTES + +## RELATED LINKS + +[Update-AzFrontDoorWafPolicy](./Update-AzFrontDoorWafPolicy.md) +[Get-AzFrontDoorWafPolicy](./Get-AzFrontDoorWafPolicy.md) +[Remove-AzFrontDoorWafPolicy](./Remove-AzFrontDoorWafPolicy.md) +[New-AzFrontDoorWafManagedRuleObject](./New-AzFrontDoorWafManagedRuleObject.md) +[New-AzFrontDoorWafCustomRuleObject](./New-AzFrontDoorWafManagedRuleObject.md) diff --git a/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafRuleGroupOverrideObject.md b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafRuleGroupOverrideObject.md new file mode 100644 index 0000000000..1dcd92c456 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/New-AzFrontDoorWafRuleGroupOverrideObject.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/new-azfrontdoorwafrulegroupoverrideobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafRuleGroupOverrideObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/New-AzFrontDoorWafRuleGroupOverrideObject.md +--- + +# New-AzFrontDoorWafRuleGroupOverrideObject + +## SYNOPSIS +Create RuleGroupOverride Object for WAF policy creation + +## SYNTAX + +``` +New-AzFrontDoorWafRuleGroupOverrideObject -RuleGroupName <String> + [-ManagedRuleOverride <PSAzureManagedRuleOverride[]>] [-Exclusion <PSManagedRuleExclusion[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Create RuleGroupOverride Object for WAF policy creation + +## EXAMPLES + +### Example 1 +```powershell +$ruleOverride1 = New-AzFrontDoorWafManagedRuleOverrideObject -RuleId "942250" -Action Log +$ruleOverride2 = New-AzFrontDoorWafManagedRuleOverrideObject -RuleId "942251" -Action Log + +New-AzFrontDoorWafRuleGroupOverrideObject -RuleGroupName SQLI -ManagedRuleOverride $ruleOverride1,$ruleOverride2 +``` + +```output +RuleGroupName ManagedRuleOverrides +------------- -------------------- +SQLI {942250, 942251} +``` + +Create a RuleGroupOverride Object + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exclusion +Exclusion + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSManagedRuleExclusion[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedRuleOverride +Rule override list + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSAzureManagedRuleOverride[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleGroupName +Rule Group Name for which these overrides apply + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSAzureRuleGroupOverride + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoorWafManagedRuleObject](./New-AzFrontDoorWafManagedRuleObject.md) diff --git a/azps-10.1.0/Az.FrontDoor/Remove-AzFrontDoor.md b/azps-10.1.0/Az.FrontDoor/Remove-AzFrontDoor.md new file mode 100644 index 0000000000..4a5cf7bd28 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Remove-AzFrontDoor.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/remove-azfrontdoor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Remove-AzFrontDoor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Remove-AzFrontDoor.md +--- + +# Remove-AzFrontDoor + +## SYNOPSIS +Remove Front Door load balancer + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzFrontDoor -ResourceGroupName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzFrontDoor -InputObject <PSFrontDoor> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzFrontDoor -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzFrontDoor** cmdlet removes a Front Door load balancer under the current subscription + +## EXAMPLES + +### Example 1: Remove "frontdoor1" in resource group "rg1" under the current subscription. +```powershell +Remove-AzFrontDoor -Name "frontdoor1" -ResourceGroupName "rg1" +``` + +Remove "frontdoor1" in resource group "rg1" under the current subscription. + +### Example 2: Remove all FrontDoors in resource group "rg1" under the current subscription. +```powershell +Get-AzFrontDoor -ResourceGroupName "rg1" | Remove-AzFrontDoor +``` + +Remove all FrontDoors in resource group "rg1" under the current subscription. + +### Example 3: Remove all FrontDoors under the current subscription. +```powershell +Get-AzFrontDoor | Remove-AzFrontDoor +``` + +Remove all FrontDoors under the current subscription. + +### Example 4: Remove all FrontDoors with name "frontdoor1" under the current subscription. +```powershell +Remove-AzFrontDoor -Name "frontdoor1" | Remove-AzFrontDoor +``` + +Remove all FrontDoors with name "frontdoor1" under the current subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Front Door object to delete. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Front Door to delete. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return object (if specified). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group to which the Front Door belongs. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id of the Front Door to delete + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoor](./New-AzFrontDoor.md) +[Get-AzFrontDoor](./Get-AzFrontDoor.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.FrontDoor/Remove-AzFrontDoorContent.md b/azps-10.1.0/Az.FrontDoor/Remove-AzFrontDoorContent.md new file mode 100644 index 0000000000..757cc68e5a --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Remove-AzFrontDoorContent.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/remove-azfrontdoorcontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Remove-AzFrontDoorContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Remove-AzFrontDoorContent.md +--- + +# Remove-AzFrontDoorContent + +## SYNOPSIS +Remove contents in Front Door + +## SYNTAX + +``` +Remove-AzFrontDoorContent -ResourceGroupName <String> -Name <String> -ContentPath <String[]> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove-AzFrontDoorContent purges cached contents in a Front Door + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzFrontDoorContent -ResourceGroupName $ResourceGroupName -Name $FrontDoorName -ContentPath "/*" +``` + +## PARAMETERS + +### -ContentPath +The paths to the content to be purged. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Front Door name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return object (if specified). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the Front Door + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FrontDoor/Remove-AzFrontDoorRulesEngine.md b/azps-10.1.0/Az.FrontDoor/Remove-AzFrontDoorRulesEngine.md new file mode 100644 index 0000000000..7f5d8bb8f2 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Remove-AzFrontDoorRulesEngine.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/remove-azfrontdoorrulesengine +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Remove-AzFrontDoorRulesEngine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Remove-AzFrontDoorRulesEngine.md +--- + +# Remove-AzFrontDoorRulesEngine + +## SYNOPSIS +Remove Rules Engine from Front Door + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzFrontDoorRulesEngine -ResourceGroupName <String> -FrontDoorName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzFrontDoorRulesEngine -InputObject <PSRulesEngine> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzFrontDoorRulesEngine -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove Rules Engine from Front Door + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzFrontDoorRulesEngine -ResourceGroupName $resourceGroupName -FrontDoorName $frontDoorName -Name $rulesEngine.Name -PassThru +``` + +```output +True +``` + +Remove rules engine configuration. + +### Example 2 +```powershell +Remove-AzFrontDoorRulesEngine -ResourceGroupName $resourceGroupName -FrontDoorName $frontDoorName -Name nonexistentRulesEngine +``` + +```output +Remove-AzFrontDoorRulesEngine : Rules Engine with name 'nonexistentRulesEngine' in Front Door 'frontDoorName' in the resource group 'resourceGroupName' does not exist. +At line:1 char:1 ++ Remove-AzFrontDoorRulesEngine -ResourceGroupName resourceGroupName -Fro ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ++ CategoryInfo : CloseError: (:) [Remove-AzFrontDoorRulesEngine], PSArgumentException ++ FullyQualifiedErrorId : Microsoft.Azure.Commands.FrontDoor.Cmdlets.RemoveFrontDoorRulesEngine +``` + +Expected outcome when removing a nonexistent rules engine configuration. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontDoorName +Front Door name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Rules Engine object to update. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngine +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Rules engine name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return object (if specified). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name that the Front Door will be created in. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id of the RulesEngine to update + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngine + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FrontDoor/Remove-AzFrontDoorWafPolicy.md b/azps-10.1.0/Az.FrontDoor/Remove-AzFrontDoorWafPolicy.md new file mode 100644 index 0000000000..dc3a380a4c --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Remove-AzFrontDoorWafPolicy.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/remove-azfrontdoorwafpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Remove-AzFrontDoorWafPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Remove-AzFrontDoorWafPolicy.md +--- + +# Remove-AzFrontDoorWafPolicy + +## SYNOPSIS +Remove WAF policy + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzFrontDoorWafPolicy -ResourceGroupName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzFrontDoorWafPolicy -InputObject <PSPolicy> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzFrontDoorWafPolicy -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzFrontDoorWafPolicy** cmdlet removes a WAF policy under the current subscription + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzFrontDoorWafPolicy -Name $policyName -ResourceGroupName $resourceGroupName +``` + +Remove the WAF policy called $policyName in $resourceGroupName. + +### Example 2 +```powershell +Get-AzFrontDoorWafPolicy -ResourceGroupName $resourceGroupName | Remove-AzFrontDoorWafPolicy +``` + +Remove all WAF policy in $resourceGroupName. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The WAF policy object to delete. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the WAF policy to delete. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return object (if specified). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group to which the WAF policy belongs. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id of the WAF policy to delete + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoorWafPolicy](./New-AzFrontDoorWafPolicy.md) +[Get-AzFrontDoorWafPolicy](./Get-AzFrontDoorWafPolicy.md) diff --git a/azps-10.1.0/Az.FrontDoor/Set-AzFrontDoor.md b/azps-10.1.0/Az.FrontDoor/Set-AzFrontDoor.md new file mode 100644 index 0000000000..84a1813afc --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Set-AzFrontDoor.md @@ -0,0 +1,473 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/set-azfrontdoor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Set-AzFrontDoor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Set-AzFrontDoor.md +--- + +# Set-AzFrontDoor + +## SYNOPSIS +Update a Front Door load balancer + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Set-AzFrontDoor -ResourceGroupName <String> -Name <String> [-RoutingRule <PSRoutingRule[]>] + [-BackendPool <PSBackendPool[]>] [-FrontendEndpoint <PSFrontendEndpoint[]>] + [-LoadBalancingSetting <PSLoadBalancingSetting[]>] [-HealthProbeSetting <PSHealthProbeSetting[]>] + [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByFieldsWithCertificateNameCheckParameterSet +``` +Set-AzFrontDoor -ResourceGroupName <String> -Name <String> [-RoutingRule <PSRoutingRule[]>] + [-BackendPool <PSBackendPool[]>] [-FrontendEndpoint <PSFrontendEndpoint[]>] + [-LoadBalancingSetting <PSLoadBalancingSetting[]>] [-HealthProbeSetting <PSHealthProbeSetting[]>] + [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] [-DisableCertificateNameCheck] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFieldsWithBackendPoolsSettingParameterSet +``` +Set-AzFrontDoor -ResourceGroupName <String> -Name <String> [-RoutingRule <PSRoutingRule[]>] + [-BackendPool <PSBackendPool[]>] [-FrontendEndpoint <PSFrontendEndpoint[]>] + [-LoadBalancingSetting <PSLoadBalancingSetting[]>] [-HealthProbeSetting <PSHealthProbeSetting[]>] + [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] -BackendPoolsSetting <PSBackendPoolsSetting> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Set-AzFrontDoor -InputObject <PSFrontDoor> [-RoutingRule <PSRoutingRule[]>] [-BackendPool <PSBackendPool[]>] + [-FrontendEndpoint <PSFrontendEndpoint[]>] [-LoadBalancingSetting <PSLoadBalancingSetting[]>] + [-HealthProbeSetting <PSHealthProbeSetting[]>] [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectWithCertificateNameCheckParameterSet +``` +Set-AzFrontDoor -InputObject <PSFrontDoor> [-RoutingRule <PSRoutingRule[]>] [-BackendPool <PSBackendPool[]>] + [-FrontendEndpoint <PSFrontendEndpoint[]>] [-LoadBalancingSetting <PSLoadBalancingSetting[]>] + [-HealthProbeSetting <PSHealthProbeSetting[]>] [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] + [-DisableCertificateNameCheck] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectWithBackendPoolsSettingParameterSet +``` +Set-AzFrontDoor -InputObject <PSFrontDoor> [-RoutingRule <PSRoutingRule[]>] [-BackendPool <PSBackendPool[]>] + [-FrontendEndpoint <PSFrontendEndpoint[]>] [-LoadBalancingSetting <PSLoadBalancingSetting[]>] + [-HealthProbeSetting <PSHealthProbeSetting[]>] [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] + -BackendPoolsSetting <PSBackendPoolsSetting> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Set-AzFrontDoor -ResourceId <String> [-RoutingRule <PSRoutingRule[]>] [-BackendPool <PSBackendPool[]>] + [-FrontendEndpoint <PSFrontendEndpoint[]>] [-LoadBalancingSetting <PSLoadBalancingSetting[]>] + [-HealthProbeSetting <PSHealthProbeSetting[]>] [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdWithCertificateNameCheckParameterSet +``` +Set-AzFrontDoor -ResourceId <String> [-RoutingRule <PSRoutingRule[]>] [-BackendPool <PSBackendPool[]>] + [-FrontendEndpoint <PSFrontendEndpoint[]>] [-LoadBalancingSetting <PSLoadBalancingSetting[]>] + [-HealthProbeSetting <PSHealthProbeSetting[]>] [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] + [-DisableCertificateNameCheck] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdWithBackendPoolsSettingParameterSet +``` +Set-AzFrontDoor -ResourceId <String> [-RoutingRule <PSRoutingRule[]>] [-BackendPool <PSBackendPool[]>] + [-FrontendEndpoint <PSFrontendEndpoint[]>] [-LoadBalancingSetting <PSLoadBalancingSetting[]>] + [-HealthProbeSetting <PSHealthProbeSetting[]>] [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] + -BackendPoolsSetting <PSBackendPoolsSetting> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzFrontDoor** cmdlet updates a Front Door load balancer. If input parameters are not provided, old parameters from the existing Front Door will be used. + +## EXAMPLES + +### Example 1: update an existing Front Door with FrontDoorName and ResourceGroupName. +```powershell +Set-AzFrontDoor -Name "frontDoor1" -ResourceGroupName "resourceGroup1" -RoutingRule $routingrule1 -BackendPool $backendpool1 -FrontendEndpoint $frontendEndpoint1 -LoadBalancingSetting $loadBalancingSetting1 -HealthProbeSetting $healthProbeSetting1 -BackendPoolsSetting $backendPoolsSetting1 +``` + +```output +FriendlyName : frontdoor1 +RoutingRules : {routingrule1} +BackendPools : {backendpool1} +BackendPoolsSetting : {backendPoolsSetting1} +EnforceCertificateNameCheck : {backendPoolsSetting1.EnforceCertificateNameCheck} +HealthProbeSettings : {healthProbeSetting1} +LoadBalancingSettings : {loadbalancingsetting1} +FrontendEndpoints : {frontendendpoint1} +EnabledState : Enabled +ResourceState : Enabled +ProvisioningState : Succeeded +Cname : +Tags : {tag1, tag2} +Id : /subscriptions/{guid}/resourcegroups/{guid}/providers/Microsoft.Network/frontdoors/frontdoor1 +Name : frontdoor1 +Type : Microsoft.Network/frontdoors +``` + +update an existing FrontDoor. + +### Example 2: update an existing Front Door with PSFrontDoor object. +```powershell +Set-AzFrontDoor -InputObject $frontDoor1 -RoutingRule $routingrule1 -BackendPool $backendpool1 -FrontendEndpoint $frontendEndpoint1 -LoadBalancingSetting $loadBalancingSetting1 -HealthProbeSetting $healthProbeSetting1 -BackendPoolsSetting $backendPoolsSetting1 +``` + +```output +FriendlyName : frontdoor1 +RoutingRules : {routingrule1} +BackendPools : {backendpool1} +BackendPoolsSetting : {backendPoolsSetting1} +EnforceCertificateNameCheck : {backendPoolsSetting1.EnforceCertificateNameCheck} +HealthProbeSettings : {healthProbeSetting1} +LoadBalancingSettings : {loadbalancingsetting1} +FrontendEndpoints : {frontendendpoint1} +EnabledState : Enabled +ResourceState : Enabled +ProvisioningState : Succeeded +Cname : +Tags : {tag1, tag2} +Id : /subscriptions/{guid}/resourcegroups/{guid}/providers/Microsoft.Network/frontdoors/frontdoor1 +Name : frontdoor1 +Type : Microsoft.Network/frontdoor1 +``` + +update an existing FrontDoor. + +### Example 3: update an existing Front Door with ResourceId +```powershell +Set-AzFrontDoor -ResourceId $resourceId -RoutingRule $routingrule1 -BackendPool $backendpool1 -FrontendEndpoint $frontendEndpoint1 -LoadBalancingSetting $loadBalancingSetting1 -HealthProbeSetting $healthProbeSetting1 -BackendPoolsSetting $backendPoolsSetting1 +``` + +```output +FriendlyName : frontdoor1 +RoutingRules : {routingrule1} +BackendPools : {backendpool1} +BackendPoolsSetting : {backendPoolsSetting1} +EnforceCertificateNameCheck : {backendPoolsSetting1.EnforceCertificateNameCheck} +HealthProbeSettings : {healthProbeSetting1} +LoadBalancingSettings : {loadbalancingsetting1} +FrontendEndpoints : {frontendendpoint1} +EnabledState : Enabled +ResourceState : Enabled +ProvisioningState : Succeeded +Cname : +Tags : {tag1, tag2} +Id : /subscriptions/{guid}/resourcegroups/{guid}/providers/Microsoft.Network/frontdoors/frontdoor1 +Name : frontdoor1 +Type : Microsoft.Network/frontdoor1 +``` + +update an existing FrontDoor. + +### Example 4: update BackendPoolSetting property EnforceCertificateNameCheck of an existing Front Door with -DisableCertificateNameCheck switch parameter +Front Door to be updated can be identified using FrontoorName and ResourceGroupName, PSFrontDoor object, or ResourceId. (See above 3 examples for example) +The below example uses PSFrontDoor object. + +```powershell +Set-AzFrontDoor -InputObject $frontDoor1 -RoutingRule $routingrule1 -BackendPool $backendpool1 -FrontendEndpoint $frontendEndpoint1 -LoadBalancingSetting $loadBalancingSetting1 -HealthProbeSetting $healthProbeSetting1 -DisableCertificateNameCheck +``` + +```output +FriendlyName : frontdoor1 +RoutingRules : {routingrule1} +BackendPools : {backendpool1} +BackendPoolsSetting : {PSBackendPoolsSetting object with EnforceCertificateNameCheck is set to Disabled} +EnforceCertificateNameCheck : Disabled +HealthProbeSettings : {healthProbeSetting1} +LoadBalancingSettings : {loadbalancingsetting1} +FrontendEndpoints : {frontendendpoint1} +EnabledState : Enabled +ResourceState : Enabled +ProvisioningState : Succeeded +Cname : +Tags : {tag1, tag2} +Id : /subscriptions/{guid}/resourcegroups/{guid}/providers/Microsoft.Network/frontdoors/frontdoor1 +Name : frontdoor1 +Type : Microsoft.Network/frontdoor1 +``` + +update an existing FrontDoor. + +## PARAMETERS + +### -BackendPool +Backendpools available to routing rule. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSBackendPool[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendPoolsSetting +Settings for all backendPools. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSBackendPoolsSetting +Parameter Sets: ByFieldsWithBackendPoolsSettingParameterSet, ByObjectWithBackendPoolsSettingParameterSet, ByResourceIdWithBackendPoolsSettingParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableCertificateNameCheck +Whether to disable certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByFieldsWithCertificateNameCheckParameterSet, ByObjectWithCertificateNameCheckParameterSet, ByResourceIdWithCertificateNameCheckParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Operational status of the Front Door load balancer. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendEndpoint +Frontend endpoints available to routing rule. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthProbeSetting +Health probe settings associated with this Front Door instance. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSHealthProbeSetting[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Front Door object to update. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor +Parameter Sets: ByObjectParameterSet, ByObjectWithCertificateNameCheckParameterSet, ByObjectWithBackendPoolsSettingParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LoadBalancingSetting +Load balancing settings associated with this Front Door instance. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSLoadBalancingSetting[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Front Door to update. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByFieldsWithCertificateNameCheckParameterSet, ByFieldsWithBackendPoolsSettingParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group to which the Front Door belongs. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByFieldsWithCertificateNameCheckParameterSet, ByFieldsWithBackendPoolsSettingParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id of the Front Door to update + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet, ByResourceIdWithCertificateNameCheckParameterSet, ByResourceIdWithBackendPoolsSettingParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoutingRule +Routing rules associated with this FrontDoor + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSRoutingRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags associate with the FrontDoor. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor +### System.String +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor +## NOTES + +## RELATED LINKS + +[New-AzFrontDoor](./New-AzFrontDoor.md) +[Get-AzFrontDoor](./Get-AzFrontDoor.md) +[Remove-AzFrontDoor](./Remove-AzFrontDoor.md) +[New-AzFrontDoorRoutingRuleObject](./New-AzFrontDoorRoutingRuleObject.md) +[New-AzFrontDoorHealthProbeSettingObject](./New-AzFrontDoorHealthProbeSettingObject.md) +[New-AzFrontDoorLoadBalancingSettingObject](./New-AzFrontDoorLoadBalancingSettingObject.md) +[New-AzFrontDoorFrontendEndpointObject](./New-AzFrontDoorFrontendEndpointObject.md) +[New-AzFrontDoorBackendPoolObject](./New-AzFrontDoorBackendPoolObject.md) diff --git a/azps-10.1.0/Az.FrontDoor/Set-AzFrontDoorRulesEngine.md b/azps-10.1.0/Az.FrontDoor/Set-AzFrontDoorRulesEngine.md new file mode 100644 index 0000000000..a84e492a86 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Set-AzFrontDoorRulesEngine.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/set-azfrontdoorrulesengine +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Set-AzFrontDoorRulesEngine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Set-AzFrontDoorRulesEngine.md +--- + +# Set-AzFrontDoorRulesEngine + +## SYNOPSIS +Update a Rules Engine. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Set-AzFrontDoorRulesEngine -ResourceGroupName <String> -FrontDoorName <String> -Name <String> + [-Rule <PSRulesEngineRule[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Set-AzFrontDoorRulesEngine -InputObject <PSRulesEngine> [-Rule <PSRulesEngineRule[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Set-AzFrontDoorRulesEngine -ResourceId <String> [-Rule <PSRulesEngineRule[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update a Rules Engine. + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> +```powershell +Get-AzFrontDoorRulesEngine -ResourceGroupName $resourceGroupName -FrontDoorName $frontDoorName -Name myRulesEngine + +Name RulesEngineRules +---- ---------------- +myRulesEngine {rules1} + +$rulesEngineRule2 = New-AzFrontDoorRulesEngineRuleObject -Name rules2 -Priority 3 -Action $rulesEngineAction +Set-AzFrontDoorRulesEngine -ResourceGroupName $resourceGroupName -FrontDoorName $frontDoorName -Name myRulesEngine -Rule $rulesEngineRule1, $rulesEngineRule2 + +Name RulesEngineRules +---- ---------------- +myRulesEngine {rules1, rules2} +``` + +Get an existing rules engine configuration and add another rules engine rule to it. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontDoorName +Front Door name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Rules Engine object to update. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngine +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Rules engine name. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name that the Front Door will be created in. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id of the RulesEngine to update + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Rule +A list of rules that define a particular Rules Engine Configuration. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngineRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngine + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngine + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.FrontDoor/Update-AzFrontDoorWafPolicy.md b/azps-10.1.0/Az.FrontDoor/Update-AzFrontDoorWafPolicy.md new file mode 100644 index 0000000000..9a9992d111 --- /dev/null +++ b/azps-10.1.0/Az.FrontDoor/Update-AzFrontDoorWafPolicy.md @@ -0,0 +1,343 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml +Module Name: Az.FrontDoor +online version: https://learn.microsoft.com/powershell/module/az.frontdoor/update-azfrontdoorwafpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Update-AzFrontDoorWafPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/FrontDoor/FrontDoor/help/Update-AzFrontDoorWafPolicy.md +--- + +# Update-AzFrontDoorWafPolicy + +## SYNOPSIS +Update WAF policy + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Update-AzFrontDoorWafPolicy -ResourceGroupName <String> -Name <String> [-EnabledState <PSEnabledState>] + [-Mode <String>] [-Customrule <PSCustomRule[]>] [-ManagedRule <PSManagedRule[]>] [-RedirectUrl <String>] + [-CustomBlockResponseStatusCode <Int32>] [-CustomBlockResponseBody <String>] [-RequestBodyCheck <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzFrontDoorWafPolicy -InputObject <PSPolicy> [-EnabledState <PSEnabledState>] [-Mode <String>] + [-Customrule <PSCustomRule[]>] [-ManagedRule <PSManagedRule[]>] [-RedirectUrl <String>] + [-CustomBlockResponseStatusCode <Int32>] [-CustomBlockResponseBody <String>] [-RequestBodyCheck <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzFrontDoorWafPolicy -ResourceId <String> [-EnabledState <PSEnabledState>] [-Mode <String>] + [-Customrule <PSCustomRule[]>] [-ManagedRule <PSManagedRule[]>] [-RedirectUrl <String>] + [-CustomBlockResponseStatusCode <Int32>] [-CustomBlockResponseBody <String>] [-RequestBodyCheck <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzFrontDoorWafPolicy** cmdlet updates an existing WAF policy. If input parameters are not provided, old parameters from the existing WAF policy will be used. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzFrontDoorWafPolicy -Name $policyName -ResourceGroupName $resourceGroupName -CustomBlockResponseStatusCode 403 +``` + +```output +Name PolicyMode PolicyEnabledState CustomBlockResponseStatusCode RedirectUrl +---- ---------- ------------------ ----------------------------- ----------- +{policyName} Prevention Enabled 403 https://www.bing.com/ +``` + +Update an existing WAF policy custom status code. + +### Example 2 +```powershell +Update-AzFrontDoorWafPolicy -Name $policyName -ResourceGroupName $resourceGroupName -Mode Detection +``` + +```output +Name PolicyMode PolicyEnabledState CustomBlockResponseStatusCode RedirectUrl +---- ---------- ------------------ ----------------------------- ----------- +{policyName} Detection Enabled 403 https://www.bing.com/ +``` + +Update an existing WAF policy mode. + +### Example 3 +```powershell +Update-AzFrontDoorWafPolicy -Name $policyName -ResourceGroupName $resourceGroupName -Mode Detection -EnabledState Disabled +``` + +```output +Name PolicyMode PolicyEnabledState CustomBlockResponseStatusCode RedirectUrl +---- ---------- ------------------ ----------------------------- ----------- +{policyName} Detection Disabled 403 https://www.bing.com/ +``` + +Update an existing WAF policy enabled state and mode. + +### Example 4 +```powershell +Get-AzFrontDoorWafPolicy -ResourceGroupName $resourceGroupName | Update-AzFrontDoorWafPolicy -Mode Detection -EnabledState Disabled +``` + +Update all WAF policies in $resourceGroupName + +## PARAMETERS + +### -CustomBlockResponseBody +Custom Response Body + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomBlockResponseStatusCode +Custom Response Status Code + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Customrule +Custom rules inside the policy + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSCustomRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Whether the policy is in enabled state or disabled state. +Possible values include: 'Disabled', 'Enabled' + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The FireWallPolicy object to update. + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagedRule +Managed rules inside the policy + +```yaml +Type: Microsoft.Azure.Commands.FrontDoor.Models.PSManagedRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Describes if it is in detection mode or prevention mode at policy level. +Possible values include:'Prevention', 'Detection' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the FireWallPolicy to update. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectUrl +Redirect URL + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestBodyCheck +Defines if the body should be inspected by managed rules. Possible values include: 'Enabled', 'Disabled' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group to which the FireWallPolicy belongs. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id of the FireWallPolicy to update + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy + +## NOTES + +## RELATED LINKS + +[New-AzFrontDoorWafPolicy](./New-AzFrontDoorWafPolicy.md) +[Get-AzFrontDoorWafPolicy](./Get-AzFrontDoorWafPolicy.md) +[New-AzFrontDoorWafManagedRuleObject](./New-AzFrontDoorWafManagedRuleObject.md) +[New-AzFrontDoorWafCustomRuleObject](./New-AzFrontDoorWafManagedRuleObject.md) diff --git a/azps-10.1.0/Az.Functions/Az.Functions.md b/azps-10.1.0/Az.Functions/Az.Functions.md new file mode 100644 index 0000000000..2b7ad04f34 --- /dev/null +++ b/azps-10.1.0/Az.Functions/Az.Functions.md @@ -0,0 +1,60 @@ +--- +Module Name: Az.Functions +Module Guid: eafced71-8742-4a2c-5afd-13117428dd90 +Download Help Link: https://learn.microsoft.com/powershell/module/az.functions +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Az.Functions.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Az.Functions.md +--- + +# Az.Functions Module +## Description +Microsoft Azure PowerShell - Azure Functions service cmdlets for Azure Resource Manager in Windows PowerShell and PowerShell Core.\n\nFor information on Azure Functions, please visit the following: https://learn.microsoft.com/azure/azure-functions/ + +## Az.Functions Cmdlets +### [Get-AzFunctionApp](Get-AzFunctionApp.md) +Gets function apps in a subscription. + +### [Get-AzFunctionAppAvailableLocation](Get-AzFunctionAppAvailableLocation.md) +Gets the location where a function app for the given os and plan type is available. + +### [Get-AzFunctionAppPlan](Get-AzFunctionAppPlan.md) +Get function apps plans in a subscription. + +### [Get-AzFunctionAppSetting](Get-AzFunctionAppSetting.md) +Gets app settings for a function app. + +### [New-AzFunctionApp](New-AzFunctionApp.md) +Creates a function app. + +### [New-AzFunctionAppPlan](New-AzFunctionAppPlan.md) +Creates a function app service plan. + +### [Remove-AzFunctionApp](Remove-AzFunctionApp.md) +Deletes a function app. + +### [Remove-AzFunctionAppPlan](Remove-AzFunctionAppPlan.md) +Deletes a function app plan. + +### [Remove-AzFunctionAppSetting](Remove-AzFunctionAppSetting.md) +Removes app settings from a function app. + +### [Restart-AzFunctionApp](Restart-AzFunctionApp.md) +Restarts a function app. + +### [Start-AzFunctionApp](Start-AzFunctionApp.md) +Starts a function app. + +### [Stop-AzFunctionApp](Stop-AzFunctionApp.md) +Stops a function app. + +### [Update-AzFunctionApp](Update-AzFunctionApp.md) +Updates a function app. + +### [Update-AzFunctionAppPlan](Update-AzFunctionAppPlan.md) +Updates a function app service plan. + +### [Update-AzFunctionAppSetting](Update-AzFunctionAppSetting.md) +Adds or updates app settings in a function app. + diff --git a/azps-10.1.0/Az.Functions/Get-AzFunctionApp.md b/azps-10.1.0/Az.Functions/Get-AzFunctionApp.md new file mode 100644 index 0000000000..57503a43e4 --- /dev/null +++ b/azps-10.1.0/Az.Functions/Get-AzFunctionApp.md @@ -0,0 +1,217 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/get-azfunctionapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Get-AzFunctionApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Get-AzFunctionApp.md +--- + +# Get-AzFunctionApp + +## SYNOPSIS +Gets function apps in a subscription. + +## SYNTAX + +### GetAll (Default) +``` +Get-AzFunctionApp [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ByLocation +``` +Get-AzFunctionApp -Location <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### ByName +``` +Get-AzFunctionApp -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ByResourceGroupName +``` +Get-AzFunctionApp -ResourceGroupName <String> [-SubscriptionId <String[]>] [-IncludeSlot] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets function apps in a subscription. + +## EXAMPLES + +### Example 1: Get all function apps. +```powershell +Get-AzFunctionApp +``` + +```output +Name Status OSType Runtime Location AppServicePlan ResourceGroupName SubscriptionId +---- ------ ------ ------- -------- -------------- ----------------- -------------- +Functions1-Windows-DoNet Running Windows DotNet Central US CentralUSPlan Functions-West-Europe-Win fe16564a-d943-4bf8-8c28-cf01708c3f8b +Functions1-Windows-Java Running Windows Java West Europe Premium1-WE Functions-West-Europe1 fe16564a-d943-4bf8-8c28-cf01708c3f8b +``` + + + +### Example 2: Get function apps by name. +```powershell +Get-AzFunctionApp -ResourceGroupName Functions-West-Europe-Win -Name Functions1-Windows-DoNet +``` + +```output +Name Status OSType Runtime Location AppServicePlan ResourceGroupName SubscriptionId +---- ------ ------ ------- -------- -------------- ----------------- -------------- +Functions1-Windows-DoNet Running Windows DotNet Central US CentralUSPlan Functions-West-Europe-Win fe16564a-d943-4bf8-8c28-cf01708c3f8b +``` + + + +### Example 3: Get function apps by resource group name. +```powershell +Get-AzFunctionApp -ResourceGroupName Functions-West-Europe-Win +``` + +```output +Name Status OSType Runtime Location AppServicePlan ResourceGroupName SubscriptionId +---- ------ ------ ------- -------- -------------- ----------------- -------------- +Functions1-Windows-DoNet Running Windows DotNet Central US CentralUSPlan Functions-West-Europe-Win fe16564a-d943-4bf8-8c28-cf01708c3f8b +``` + + + +### Example 4: Get function apps for the given subscriptions. +```powershell +Get-AzFunctionApp -SubscriptionId fe16564a-d943-4bf8-8c28-cf01708c3f8b +``` + +```output +Name Status OSType Runtime Location AppServicePlan ResourceGroupName SubscriptionId +---- ------ ------ ------- -------- -------------- ----------------- -------------- +Functions1-Windows-DoNet Running Windows DotNet Central US CentralUSPlan Functions-West-Europe-Win fe16564a-d943-4bf8-8c28-cf01708c3f8b +``` + + + +### Example 5: Get function apps by location. +```powershell +Get-AzFunctionApp -Location "Central US" +``` + +```output +Name Status OSType Runtime Location AppServicePlan ResourceGroupName SubscriptionId +---- ------ ------ ------- -------- -------------- ----------------- -------------- +Functions1-Windows-DoNet Running Windows DotNet Central US CentralUSPlan Functions-West-Europe-Win fe16564a-d943-4bf8-8c28-cf01708c3f8b +``` + + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSlot +Use to specify whether to include deployment slots in results. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByResourceGroupName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the function app. + +```yaml +Type: System.String +Parameter Sets: ByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the function app. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByName, ByResourceGroupName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/Get-AzFunctionAppAvailableLocation.md b/azps-10.1.0/Az.Functions/Get-AzFunctionAppAvailableLocation.md new file mode 100644 index 0000000000..8389c96871 --- /dev/null +++ b/azps-10.1.0/Az.Functions/Get-AzFunctionAppAvailableLocation.md @@ -0,0 +1,229 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/get-azfunctionappavailablelocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Get-AzFunctionAppAvailableLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Get-AzFunctionAppAvailableLocation.md +--- + +# Get-AzFunctionAppAvailableLocation + +## SYNOPSIS +Gets the location where a function app for the given os and plan type is available. + +## SYNTAX + +``` +Get-AzFunctionAppAvailableLocation [[-SubscriptionId] <String[]>] [[-PlanType] <String>] [[-OSType] <String>] + [[-DefaultProfile] <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the location where a function app for the given os and plan type is available. + +## EXAMPLES + +### Example 1: Get the locations where Premium is available for Windows. If no parameters are specified, PlanType is set to 'Premium' and OSType is set to 'Windows'. +```powershell +Get-AzFunctionAppAvailableLocation +``` + +```output +Name +---- +Central US +North Europe +West Europe +Southeast Asia +East Asia +West US +East US +Japan West +Japan East +East US 2 +North Central US +South Central US +Brazil South +Australia East +Australia Southeast +East Asia (Stage) +West India +South India +Canada Central +West US 2 +UK West +UK South +East US 2 EUAP +Central US EUAP +Korea Central +France Central +Australia Central 2 +Australia Central +Germany West Central +Norway East +``` + +This command gets the locations where Premium is available for Windows. + +### Example 2: Get the locations where Premium is available for Linux. +```powershell +Get-AzFunctionAppAvailableLocation -PlanType Premium -OSType Linux +``` + +```output +Name +---- +Central US +North Europe +West Europe +Southeast Asia +East Asia +West US +East US +Japan West +Japan East +East US 2 +North Central US +South Central US +Brazil South +Australia East +Australia Southeast +West India +Canada Central +West Central US +West US 2 +UK West +UK South +Central US EUAP +Korea Central +France Central +Norway East +``` + +This command gets the locations where Premium is available for Linux. + +### Example 3: Get the locations where Consumption is available for Windows. +```powershell +Get-AzFunctionAppAvailableLocation -PlanType Consumption -OSType Windows +``` + +```output +Name +---- +Central US +North Europe +West Europe +Southeast Asia +East Asia +West US +East US +Japan West +Japan East +East US 2 +North Central US +South Central US +Brazil South +Australia East +Australia Southeast +East Asia (Stage) +Central India +West India +South India +Canada Central +Canada East +West Central US +West US 2 +UK West +UK South +East US 2 EUAP +Central US EUAP +Korea Central +France Central +Australia Central 2 +Australia Central +South Africa North +Switzerland North +Germany West Central +``` + +This command gets the locations where Consumption is available for Windows. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSType +The OS type for the service plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanType +The plan type. +Valid inputs: Consumption or Premium + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IGeoRegion + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/Get-AzFunctionAppPlan.md b/azps-10.1.0/Az.Functions/Get-AzFunctionAppPlan.md new file mode 100644 index 0000000000..f44dfec7d6 --- /dev/null +++ b/azps-10.1.0/Az.Functions/Get-AzFunctionAppPlan.md @@ -0,0 +1,196 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/get-azfunctionappplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Get-AzFunctionAppPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Get-AzFunctionAppPlan.md +--- + +# Get-AzFunctionAppPlan + +## SYNOPSIS +Get function apps plans in a subscription. + +## SYNTAX + +### GetAll (Default) +``` +Get-AzFunctionAppPlan [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ByLocation +``` +Get-AzFunctionAppPlan -Location <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### ByName +``` +Get-AzFunctionAppPlan -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ByResourceGroupName +``` +Get-AzFunctionAppPlan [-ResourceGroupName <String>] [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get function apps plans in a subscription. + +## EXAMPLES + +### Example 1: Get all function app plans. +```powershell +Get-AzFunctionAppPlan +``` + +```output +Name WorkerType SkuTier SkuName Location ResourceGroupName SubscriptionId +---- ---------- ------- ------- -------- ----------------- -------------- +Func99-West-Europe-Linux-Premium Linux ElasticPremium EP1 West Europe Func99-West-Europe-Linux-Premium fe16564a-d943-4bf8-8c28-cf01708c3f8b +Func99-West-Europe-Windows-Premium Windows ElasticPremium EP1 West Europe Func99-West-Europe-Win-Premium fe16564a-d943-4bf8-8c28-cf01708c3f8b +Func99-Windows-Premium1680894595 Windows ElasticPremium EP1 West Europe Func99-West-Europe-Win-Premium fe16564a-d943-4bf8-8c28-cf01708c3f8b +Func99-Windows-Premium428118799 Windows ElasticPremium EP1 West Europe Func99-West-Europe-Win-Premium fe16564a-d943-4bf8-8c28-cf01708c3f8b +Func99-Windows-Premium677505437 Windows ElasticPremium EP1 West Europe Func99-West-Europe-Win-Premium fe16564a-d943-4bf8-8c28-cf01708c3f8b +Func99-Windows-Premium711892854 Windows ElasticPremium EP1 West Europe Func99-West-Europe-Win-Premium fe16564a-d943-4bf8-8c28-cf01708c3f8b +Func99-Windows-Premium819994758 Windows ElasticPremium EP1 West Europe Func99-West-Europe-Win-Premium fe16564a-d943-4bf8-8c28-cf01708c3f8b +``` + +This command gets all function app plans. + +### Example 2: Get function app plans by resource group name. +```powershell +Get-AzFunctionAppPlan -ResourceGroupName "West Europe" +``` + +```output +Name WorkerType SkuTier SkuName Location ResourceGroupName SubscriptionId +---- ---------- ------- ------- -------- ----------------- -------------- +Func99-West-Europe-Linux-Premium Linux ElasticPremium EP1 West Europe Func99-West-Europe-Linux-Premium fe16564a-d943-4bf8-8c28-cf01708c3f8b +Func99-West-Europe-Windows-Premium Windows ElasticPremium EP1 West Europe Func99-West-Europe-Win-Premium fe16564a-d943-4bf8-8c28-cf01708c3f8b +Func99-Windows-Premium1680894595 Windows ElasticPremium EP1 West Europe Func99-West-Europe-Win-Premium fe16564a-d943-4bf8-8c28-cf01708c3f8b +``` + +This command gets function app plans by resource group name. + +### Example 3: Get function app plans for the given subscriptions. +```powershell +Get-AzFunctionAppPlan -SubscriptionId fe16564a-d943-4bf8-8c28-cf01708c3f8z +``` + +```output +Name WorkerType SkuTier SkuName Location ResourceGroupName SubscriptionId +---- ---------- ------- ------- -------- ----------------- -------------- +Func99-West-Europe-Windows-Premium Windows ElasticPremium EP1 West Europe Func99-West-Europe-Win-Premium fe16564a-d943-4bf8-8c28-cf01708c3f8z +``` + +This command gets function app plans for the given subscriptions. + +### Example 4: Get function app plans by location. +```powershell +Get-AzFunctionAppPlan -Location "Central US" +``` + +```output +Name WorkerType SkuTier SkuName Location ResourceGroupName SubscriptionId +---- ---------- ------- ------- -------- ----------------- -------------- +Func99-West-Europe-Windows-Premium Windows ElasticPremium EP1 Central US Func99-West-Europe-Win-Premium 3r16564a-d943-4bf8-8c28-cf01708c3f8b +``` + +This command gets function app plans by location. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the function app plan. + +```yaml +Type: System.String +Parameter Sets: ByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The service plan name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByName, ByResourceGroupName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IAppServicePlan + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/Get-AzFunctionAppSetting.md b/azps-10.1.0/Az.Functions/Get-AzFunctionAppSetting.md new file mode 100644 index 0000000000..1dba3af277 --- /dev/null +++ b/azps-10.1.0/Az.Functions/Get-AzFunctionAppSetting.md @@ -0,0 +1,328 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/get-azfunctionappsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Get-AzFunctionAppSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Get-AzFunctionAppSetting.md +--- + +# Get-AzFunctionAppSetting + +## SYNOPSIS +Gets app settings for a function app. + +## SYNTAX + +### ByName (Default) +``` +Get-AzFunctionAppSetting -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ByObjectInput +``` +Get-AzFunctionAppSetting -InputObject <ISite> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets app settings for a function app. + +## EXAMPLES + +### Example 1: Get the app settings of a function app. +```powershell +Get-AzFunctionAppSetting -Name MyAppName -ResourceGroupName MyResourceGroupName +``` + +This command gets the app settings of a function app. + +## PARAMETERS + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite +Parameter Sets: ByObjectInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the function app. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IStringDictionary + +## 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 <ISite>`: + - `Location <String>`: Resource Location. + - `[Kind <String>]`: Kind of resource. + - `[Tag <IResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[ClientAffinityEnabled <Boolean?>]`: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. + - `[ClientCertEnabled <Boolean?>]`: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. + - `[ClientCertExclusionPath <String>]`: client certificate authentication comma-separated exclusion paths + - `[CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]`: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[CloningInfoCloneCustomHostName <Boolean?>]`: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. + - `[CloningInfoCloneSourceControl <Boolean?>]`: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. + - `[CloningInfoConfigureLoadBalancing <Boolean?>]`: <code>true</code> to configure load balancing for source and destination app. + - `[CloningInfoCorrelationId <String>]`: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. + - `[CloningInfoHostingEnvironment <String>]`: App Service Environment. + - `[CloningInfoOverwrite <Boolean?>]`: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. + - `[CloningInfoSourceWebAppId <String>]`: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. + - `[CloningInfoSourceWebAppLocation <String>]`: Location of source app ex: West US or North Europe + - `[CloningInfoTrafficManagerProfileId <String>]`: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. + - `[CloningInfoTrafficManagerProfileName <String>]`: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. + - `[Config <ISiteConfig>]`: Configuration of the app. + - `[AcrUseManagedIdentityCred <Boolean?>]`: Flag to use Managed Identity Creds for ACR pull + - `[AcrUserManagedIdentityId <String>]`: If using user managed identity, the user managed identity ClientId + - `[ActionMinProcessExecutionTime <String>]`: Minimum time the process must execute before taking the action + - `[ActionType <AutoHealActionType?>]`: Predefined action to be taken. + - `[AlwaysOn <Boolean?>]`: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. + - `[ApiDefinitionUrl <String>]`: The URL of the API definition. + - `[ApiManagementConfigId <String>]`: APIM-Api Identifier. + - `[AppCommandLine <String>]`: App command line to launch. + - `[AppSetting <INameValuePair[]>]`: Application settings. + - `[Name <String>]`: Pair name. + - `[Value <String>]`: Pair value. + - `[AutoHealEnabled <Boolean?>]`: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. + - `[AutoSwapSlotName <String>]`: Auto-swap slot name. + - `[ConnectionString <IConnStringInfo[]>]`: Connection strings. + - `[ConnectionString <String>]`: Connection string value. + - `[Name <String>]`: Name of connection string. + - `[Type <ConnectionStringType?>]`: Type of database. + - `[CorAllowedOrigin <String[]>]`: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. + - `[CorSupportCredentials <Boolean?>]`: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. + - `[CustomActionExe <String>]`: Executable to be run. + - `[CustomActionParameter <String>]`: Parameters for the executable. + - `[DefaultDocument <String[]>]`: Default documents. + - `[DetailedErrorLoggingEnabled <Boolean?>]`: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. + - `[DocumentRoot <String>]`: Document root. + - `[DynamicTagsJson <String>]`: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. + - `[ExperimentRampUpRule <IRampUpRule[]>]`: List of ramp-up rules. + - `[ActionHostName <String>]`: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. + - `[ChangeDecisionCallbackUrl <String>]`: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ + - `[ChangeIntervalInMinute <Int32?>]`: Specifies interval in minutes to reevaluate ReroutePercentage. + - `[ChangeStep <Double?>]`: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. + - `[MaxReroutePercentage <Double?>]`: Specifies upper boundary below which ReroutePercentage will stay. + - `[MinReroutePercentage <Double?>]`: Specifies lower boundary above which ReroutePercentage will stay. + - `[Name <String>]`: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. + - `[ReroutePercentage <Double?>]`: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. + - `[FtpsState <FtpsState?>]`: State of FTP / FTPS service + - `[HandlerMapping <IHandlerMapping[]>]`: Handler mappings. + - `[Argument <String>]`: Command-line arguments to be passed to the script processor. + - `[Extension <String>]`: Requests with this extension will be handled using the specified FastCGI application. + - `[ScriptProcessor <String>]`: The absolute path to the FastCGI application. + - `[HealthCheckPath <String>]`: Health check path + - `[Http20Enabled <Boolean?>]`: Http20Enabled: configures a web site to allow clients to connect over http2.0 + - `[HttpLoggingEnabled <Boolean?>]`: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. + - `[IPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for main. + - `[Action <String>]`: Allow or Deny access for this IP range. + - `[Description <String>]`: IP restriction rule description. + - `[IPAddress <String>]`: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. + - `[Name <String>]`: IP restriction rule name. + - `[Priority <Int32?>]`: Priority of IP restriction rule. + - `[SubnetMask <String>]`: Subnet mask for the range of IP addresses the restriction is valid for. + - `[SubnetTrafficTag <Int32?>]`: (internal) Subnet traffic tag + - `[Tag <IPFilterTag?>]`: Defines what this IP filter will be used for. This is to support IP filtering on proxies. + - `[VnetSubnetResourceId <String>]`: Virtual network resource id + - `[VnetTrafficTag <Int32?>]`: (internal) Vnet traffic tag + - `[IsPushEnabled <Boolean?>]`: Gets or sets a flag indicating whether the Push endpoint is enabled. + - `[JavaContainer <String>]`: Java container. + - `[JavaContainerVersion <String>]`: Java container version. + - `[JavaVersion <String>]`: Java version. + - `[LimitMaxDiskSizeInMb <Int64?>]`: Maximum allowed disk size usage in MB. + - `[LimitMaxMemoryInMb <Int64?>]`: Maximum allowed memory usage in MB. + - `[LimitMaxPercentageCpu <Double?>]`: Maximum allowed CPU usage percentage. + - `[LinuxFxVersion <String>]`: Linux App Framework and version + - `[LoadBalancing <SiteLoadBalancing?>]`: Site load balancing. + - `[LocalMySqlEnabled <Boolean?>]`: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. + - `[LogsDirectorySizeLimit <Int32?>]`: HTTP logs directory size limit. + - `[MachineKeyDecryption <String>]`: Algorithm used for decryption. + - `[MachineKeyDecryptionKey <String>]`: Decryption key. + - `[MachineKeyValidation <String>]`: MachineKey validation. + - `[MachineKeyValidationKey <String>]`: Validation key. + - `[ManagedPipelineMode <ManagedPipelineMode?>]`: Managed pipeline mode. + - `[ManagedServiceIdentityId <Int32?>]`: Managed Service Identity Id + - `[MinTlsVersion <SupportedTlsVersions?>]`: MinTlsVersion: configures the minimum version of TLS required for SSL requests + - `[NetFrameworkVersion <String>]`: .NET Framework version. + - `[NodeVersion <String>]`: Version of Node.js. + - `[NumberOfWorker <Int32?>]`: Number of workers. + - `[PhpVersion <String>]`: Version of PHP. + - `[PowerShellVersion <String>]`: Version of PowerShell. + - `[PreWarmedInstanceCount <Int32?>]`: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans + - `[PublishingUsername <String>]`: Publishing user name. + - `[PushKind <String>]`: Kind of resource. + - `[PythonVersion <String>]`: Version of Python. + - `[RemoteDebuggingEnabled <Boolean?>]`: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. + - `[RemoteDebuggingVersion <String>]`: Remote debugging version. + - `[RequestCount <Int32?>]`: Request Count. + - `[RequestTimeInterval <String>]`: Time interval. + - `[RequestTracingEnabled <Boolean?>]`: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. + - `[RequestTracingExpirationTime <DateTime?>]`: Request tracing expiration time. + - `[ScmIPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for scm. + - `[ScmIPSecurityRestrictionsUseMain <Boolean?>]`: IP security restrictions for scm to use main. + - `[ScmType <ScmType?>]`: SCM type. + - `[SlowRequestCount <Int32?>]`: Request Count. + - `[SlowRequestTimeInterval <String>]`: Time interval. + - `[SlowRequestTimeTaken <String>]`: Time taken. + - `[TagWhitelistJson <String>]`: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. + - `[TagsRequiringAuth <String>]`: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. + - `[TracingOption <String>]`: Tracing options. + - `[TriggerPrivateBytesInKb <Int32?>]`: A rule based on private bytes. + - `[TriggerStatusCode <IStatusCodesBasedTrigger[]>]`: A rule based on status codes. + - `[Count <Int32?>]`: Request Count. + - `[Status <Int32?>]`: HTTP status code. + - `[SubStatus <Int32?>]`: Request Sub Status. + - `[TimeInterval <String>]`: Time interval. + - `[Win32Status <Int32?>]`: Win32 error code. + - `[Use32BitWorkerProcess <Boolean?>]`: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. + - `[VirtualApplication <IVirtualApplication[]>]`: Virtual applications. + - `[PhysicalPath <String>]`: Physical path. + - `[PreloadEnabled <Boolean?>]`: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. + - `[VirtualDirectory <IVirtualDirectory[]>]`: Virtual directories for virtual application. + - `[PhysicalPath <String>]`: Physical path. + - `[VirtualPath <String>]`: Path to virtual application. + - `[VirtualPath <String>]`: Virtual path. + - `[VnetName <String>]`: Virtual Network name. + - `[WebSocketsEnabled <Boolean?>]`: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. + - `[WindowsFxVersion <String>]`: Xenon App Framework and version + - `[XManagedServiceIdentityId <Int32?>]`: Explicit Managed Service Identity Id + - `[ContainerSize <Int32?>]`: Size of the function container. + - `[DailyMemoryTimeQuota <Int32?>]`: Maximum allowed daily memory-time quota (applicable on dynamic apps only). + - `[Enabled <Boolean?>]`: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). + - `[HostNameSslState <IHostNameSslState[]>]`: Hostname SSL states are used to manage the SSL bindings for app's hostnames. + - `[HostType <HostType?>]`: Indicates whether the hostname is a standard or repository hostname. + - `[Name <String>]`: Hostname. + - `[SslState <SslState?>]`: SSL type. + - `[Thumbprint <String>]`: SSL certificate thumbprint. + - `[ToUpdate <Boolean?>]`: Set to <code>true</code> to update existing hostname. + - `[VirtualIP <String>]`: Virtual IP address assigned to the hostname if IP based SSL is enabled. + - `[HostNamesDisabled <Boolean?>]`: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. + - `[HostingEnvironmentProfileId <String>]`: Resource ID of the App Service Environment. + - `[HttpsOnly <Boolean?>]`: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests + - `[HyperV <Boolean?>]`: Hyper-V sandbox. + - `[IdentityType <ManagedServiceIdentityType?>]`: Type of managed service identity. + - `[IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]`: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} + - `[(Any) <IComponents1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties>]`: This indicates any property can be added to this object. + - `[IsXenon <Boolean?>]`: Obsolete: Hyper-V sandbox. + - `[RedundancyMode <RedundancyMode?>]`: Site redundancy mode + - `[Reserved <Boolean?>]`: <code>true</code> if reserved; otherwise, <code>false</code>. + - `[ScmSiteAlsoStopped <Boolean?>]`: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. + - `[ServerFarmId <String>]`: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/New-AzFunctionApp.md b/azps-10.1.0/Az.Functions/New-AzFunctionApp.md new file mode 100644 index 0000000000..e83aaf7319 --- /dev/null +++ b/azps-10.1.0/Az.Functions/New-AzFunctionApp.md @@ -0,0 +1,486 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/new-azfunctionapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/New-AzFunctionApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/New-AzFunctionApp.md +--- + +# New-AzFunctionApp + +## SYNOPSIS +Creates a function app. + +## SYNTAX + +### Consumption (Default) +``` +New-AzFunctionApp -Location <String> -Name <String> -ResourceGroupName <String> -Runtime <String> + -StorageAccountName <String> [-ApplicationInsightsKey <String>] [-ApplicationInsightsName <String>] + [-AppSetting <Hashtable>] [-DisableApplicationInsights] [-FunctionsVersion <String>] [-IdentityID <String[]>] + [-IdentityType <ManagedServiceIdentityType>] [-OSType <String>] [-PassThru] [-RuntimeVersion <String>] + [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### ByAppServicePlan +``` +New-AzFunctionApp -Name <String> -PlanName <String> -ResourceGroupName <String> -Runtime <String> + -StorageAccountName <String> [-ApplicationInsightsKey <String>] [-ApplicationInsightsName <String>] + [-AppSetting <Hashtable>] [-DisableApplicationInsights] [-FunctionsVersion <String>] [-IdentityID <String[]>] + [-IdentityType <ManagedServiceIdentityType>] [-OSType <String>] [-PassThru] [-RuntimeVersion <String>] + [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### CustomDockerImage +``` +New-AzFunctionApp -DockerImageName <String> -Name <String> -PlanName <String> -ResourceGroupName <String> + -StorageAccountName <String> [-ApplicationInsightsKey <String>] [-ApplicationInsightsName <String>] + [-AppSetting <Hashtable>] [-DisableApplicationInsights] [-DockerRegistryCredential <PSCredential>] + [-IdentityID <String[]>] [-IdentityType <ManagedServiceIdentityType>] [-PassThru] [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a function app. + +## EXAMPLES + +### Example 1: Create a consumption PowerShell function app in Central US. +```powershell +New-AzFunctionApp -Name MyUniqueFunctionAppName ` + -ResourceGroupName MyResourceGroupName ` + -Location centralUS ` + -StorageAccountName MyStorageAccountName ` + -Runtime PowerShell +``` + +This command creates a consumption PowerShell function app in Central US. + +### Example 2: Create a PowerShell function app which will be hosted in a service plan. +```powershell +New-AzFunctionApp -Name MyUniqueFunctionAppName ` + -ResourceGroupName MyResourceGroupName ` + -PlanName MyPlanName ` + -StorageAccountName MyStorageAccountName ` + -Runtime PowerShell +``` + +This command creates a PowerShell function app which will be hosted in a service plan. + +### Example 3: Create a function app using a using a private ACR image. +```powershell +New-AzFunctionApp -Name MyUniqueFunctionAppName ` + -ResourceGroupName MyResourceGroupName ` + -PlanName MyPlanName ` + -StorageAccountName MyStorageAccountName ` + -DockerImageName myacr.azurecr.io/myimage:tag +``` + +This command creates a function app using a using a private ACR image. + +## PARAMETERS + +### -ApplicationInsightsKey +Instrumentation key of App Insights to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppInsightsKey + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationInsightsName +Name of the existing App Insights project to be added to the function app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppInsightsName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppSetting +Function app settings. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Runs the cmdlet as a background job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableApplicationInsights +Disable creating application insights resource during the function app creation. +No logs will be available. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: DisableAppInsights + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DockerImageName +Linux only. +Container image name from Docker Registry, e.g. +publisher/image-name:tag. + +```yaml +Type: System.String +Parameter Sets: CustomDockerImage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DockerRegistryCredential +The container registry user name and password. +Required for private registries. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: CustomDockerImage +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunctionsVersion +The Functions version. + +```yaml +Type: System.String +Parameter Sets: ByAppServicePlan, Consumption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityID +Specifies the list of user identities associated with the function app. + The user identity references will be ARM resource ids in the form: + '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Specifies the type of identity used for the function app. + The acceptable values for this parameter are: + - SystemAssigned + - UserAssigned + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Functions.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location for the consumption plan. + +```yaml +Type: System.String +Parameter Sets: Consumption +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the function app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. +In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSType +The OS to host the function app. + +```yaml +Type: System.String +Parameter Sets: ByAppServicePlan, Consumption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanName +The name of the service plan. + +```yaml +Type: System.String +Parameter Sets: ByAppServicePlan, CustomDockerImage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Runtime +The function runtime. + +```yaml +Type: System.String +Parameter Sets: ByAppServicePlan, Consumption +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuntimeVersion +The function runtime. + +```yaml +Type: System.String +Parameter Sets: ByAppServicePlan, Consumption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/New-AzFunctionAppPlan.md b/azps-10.1.0/Az.Functions/New-AzFunctionAppPlan.md new file mode 100644 index 0000000000..aa6a46d642 --- /dev/null +++ b/azps-10.1.0/Az.Functions/New-AzFunctionAppPlan.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/new-azfunctionappplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/New-AzFunctionAppPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/New-AzFunctionAppPlan.md +--- + +# New-AzFunctionAppPlan + +## SYNOPSIS +Creates a function app service plan. + +## SYNTAX + +``` +New-AzFunctionAppPlan -Location <String> -Name <String> -ResourceGroupName <String> -Sku <String> + -WorkerType <String> [-SubscriptionId <String>] [-MaximumWorkerCount <Int32>] [-MinimumWorkerCount <Int32>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a function app service plan. + +## EXAMPLES + +### Example 1: Create a Windows premium app plan in West Europe with burst out capability up to 10 instances. +```powershell +New-AzFunctionAppPlan -ResourceGroupName MyResourceGroupName ` + -Name MyPremiumPlan ` + -Location WestEurope ` + -MinimumWorkerCount 1 ` + -MaximumWorkerCount 10 ` + -Sku EP1 ` + -WorkerType Windows +``` + +This command creates a Windows premium app plan in West Europe with burst out capability up to 10 instances. + +## PARAMETERS + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location for the consumption plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumWorkerCount +The maximum number of workers for the app service plan. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: MaxBurst + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumWorkerCount +The minimum number of workers for the app service plan. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: MinInstances + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the App Service plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The plan sku. +Valid inputs are: EP1, EP2, EP3 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkerType +The worker type for the plan. +Valid inputs are: Windows or Linux. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IAppServicePlan + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/Remove-AzFunctionApp.md b/azps-10.1.0/Az.Functions/Remove-AzFunctionApp.md new file mode 100644 index 0000000000..6de03f1779 --- /dev/null +++ b/azps-10.1.0/Az.Functions/Remove-AzFunctionApp.md @@ -0,0 +1,365 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/remove-azfunctionapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Remove-AzFunctionApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Remove-AzFunctionApp.md +--- + +# Remove-AzFunctionApp + +## SYNOPSIS +Deletes a function app. + +## SYNTAX + +### ByName (Default) +``` +Remove-AzFunctionApp -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Force] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ByObjectInput +``` +Remove-AzFunctionApp -InputObject <ISite> [-Force] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a function app. + +## EXAMPLES + +### Example 1: Get a function app by name and delete it. +```powershell +Get-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName | Remove-AzFunctionApp -Force +``` + +This command gets a function app by name and delete it. + +### Example 2: Delete a function app by name. +```powershell +Remove-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName -Force +``` + +This command deletes a function app by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the cmdlet to remove the function app without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite +Parameter Sets: ByObjectInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of function app. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISite>`: + - `Location <String>`: Resource Location. + - `[Kind <String>]`: Kind of resource. + - `[Tag <IResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[ClientAffinityEnabled <Boolean?>]`: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. + - `[ClientCertEnabled <Boolean?>]`: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. + - `[ClientCertExclusionPath <String>]`: client certificate authentication comma-separated exclusion paths + - `[CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]`: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[CloningInfoCloneCustomHostName <Boolean?>]`: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. + - `[CloningInfoCloneSourceControl <Boolean?>]`: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. + - `[CloningInfoConfigureLoadBalancing <Boolean?>]`: <code>true</code> to configure load balancing for source and destination app. + - `[CloningInfoCorrelationId <String>]`: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. + - `[CloningInfoHostingEnvironment <String>]`: App Service Environment. + - `[CloningInfoOverwrite <Boolean?>]`: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. + - `[CloningInfoSourceWebAppId <String>]`: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. + - `[CloningInfoSourceWebAppLocation <String>]`: Location of source app ex: West US or North Europe + - `[CloningInfoTrafficManagerProfileId <String>]`: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. + - `[CloningInfoTrafficManagerProfileName <String>]`: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. + - `[Config <ISiteConfig>]`: Configuration of the app. + - `[AcrUseManagedIdentityCred <Boolean?>]`: Flag to use Managed Identity Creds for ACR pull + - `[AcrUserManagedIdentityId <String>]`: If using user managed identity, the user managed identity ClientId + - `[ActionMinProcessExecutionTime <String>]`: Minimum time the process must execute before taking the action + - `[ActionType <AutoHealActionType?>]`: Predefined action to be taken. + - `[AlwaysOn <Boolean?>]`: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. + - `[ApiDefinitionUrl <String>]`: The URL of the API definition. + - `[ApiManagementConfigId <String>]`: APIM-Api Identifier. + - `[AppCommandLine <String>]`: App command line to launch. + - `[AppSetting <INameValuePair[]>]`: Application settings. + - `[Name <String>]`: Pair name. + - `[Value <String>]`: Pair value. + - `[AutoHealEnabled <Boolean?>]`: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. + - `[AutoSwapSlotName <String>]`: Auto-swap slot name. + - `[ConnectionString <IConnStringInfo[]>]`: Connection strings. + - `[ConnectionString <String>]`: Connection string value. + - `[Name <String>]`: Name of connection string. + - `[Type <ConnectionStringType?>]`: Type of database. + - `[CorAllowedOrigin <String[]>]`: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. + - `[CorSupportCredentials <Boolean?>]`: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. + - `[CustomActionExe <String>]`: Executable to be run. + - `[CustomActionParameter <String>]`: Parameters for the executable. + - `[DefaultDocument <String[]>]`: Default documents. + - `[DetailedErrorLoggingEnabled <Boolean?>]`: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. + - `[DocumentRoot <String>]`: Document root. + - `[DynamicTagsJson <String>]`: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. + - `[ExperimentRampUpRule <IRampUpRule[]>]`: List of ramp-up rules. + - `[ActionHostName <String>]`: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. + - `[ChangeDecisionCallbackUrl <String>]`: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ + - `[ChangeIntervalInMinute <Int32?>]`: Specifies interval in minutes to reevaluate ReroutePercentage. + - `[ChangeStep <Double?>]`: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. + - `[MaxReroutePercentage <Double?>]`: Specifies upper boundary below which ReroutePercentage will stay. + - `[MinReroutePercentage <Double?>]`: Specifies lower boundary above which ReroutePercentage will stay. + - `[Name <String>]`: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. + - `[ReroutePercentage <Double?>]`: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. + - `[FtpsState <FtpsState?>]`: State of FTP / FTPS service + - `[HandlerMapping <IHandlerMapping[]>]`: Handler mappings. + - `[Argument <String>]`: Command-line arguments to be passed to the script processor. + - `[Extension <String>]`: Requests with this extension will be handled using the specified FastCGI application. + - `[ScriptProcessor <String>]`: The absolute path to the FastCGI application. + - `[HealthCheckPath <String>]`: Health check path + - `[Http20Enabled <Boolean?>]`: Http20Enabled: configures a web site to allow clients to connect over http2.0 + - `[HttpLoggingEnabled <Boolean?>]`: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. + - `[IPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for main. + - `[Action <String>]`: Allow or Deny access for this IP range. + - `[Description <String>]`: IP restriction rule description. + - `[IPAddress <String>]`: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. + - `[Name <String>]`: IP restriction rule name. + - `[Priority <Int32?>]`: Priority of IP restriction rule. + - `[SubnetMask <String>]`: Subnet mask for the range of IP addresses the restriction is valid for. + - `[SubnetTrafficTag <Int32?>]`: (internal) Subnet traffic tag + - `[Tag <IPFilterTag?>]`: Defines what this IP filter will be used for. This is to support IP filtering on proxies. + - `[VnetSubnetResourceId <String>]`: Virtual network resource id + - `[VnetTrafficTag <Int32?>]`: (internal) Vnet traffic tag + - `[IsPushEnabled <Boolean?>]`: Gets or sets a flag indicating whether the Push endpoint is enabled. + - `[JavaContainer <String>]`: Java container. + - `[JavaContainerVersion <String>]`: Java container version. + - `[JavaVersion <String>]`: Java version. + - `[LimitMaxDiskSizeInMb <Int64?>]`: Maximum allowed disk size usage in MB. + - `[LimitMaxMemoryInMb <Int64?>]`: Maximum allowed memory usage in MB. + - `[LimitMaxPercentageCpu <Double?>]`: Maximum allowed CPU usage percentage. + - `[LinuxFxVersion <String>]`: Linux App Framework and version + - `[LoadBalancing <SiteLoadBalancing?>]`: Site load balancing. + - `[LocalMySqlEnabled <Boolean?>]`: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. + - `[LogsDirectorySizeLimit <Int32?>]`: HTTP logs directory size limit. + - `[MachineKeyDecryption <String>]`: Algorithm used for decryption. + - `[MachineKeyDecryptionKey <String>]`: Decryption key. + - `[MachineKeyValidation <String>]`: MachineKey validation. + - `[MachineKeyValidationKey <String>]`: Validation key. + - `[ManagedPipelineMode <ManagedPipelineMode?>]`: Managed pipeline mode. + - `[ManagedServiceIdentityId <Int32?>]`: Managed Service Identity Id + - `[MinTlsVersion <SupportedTlsVersions?>]`: MinTlsVersion: configures the minimum version of TLS required for SSL requests + - `[NetFrameworkVersion <String>]`: .NET Framework version. + - `[NodeVersion <String>]`: Version of Node.js. + - `[NumberOfWorker <Int32?>]`: Number of workers. + - `[PhpVersion <String>]`: Version of PHP. + - `[PowerShellVersion <String>]`: Version of PowerShell. + - `[PreWarmedInstanceCount <Int32?>]`: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans + - `[PublishingUsername <String>]`: Publishing user name. + - `[PushKind <String>]`: Kind of resource. + - `[PythonVersion <String>]`: Version of Python. + - `[RemoteDebuggingEnabled <Boolean?>]`: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. + - `[RemoteDebuggingVersion <String>]`: Remote debugging version. + - `[RequestCount <Int32?>]`: Request Count. + - `[RequestTimeInterval <String>]`: Time interval. + - `[RequestTracingEnabled <Boolean?>]`: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. + - `[RequestTracingExpirationTime <DateTime?>]`: Request tracing expiration time. + - `[ScmIPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for scm. + - `[ScmIPSecurityRestrictionsUseMain <Boolean?>]`: IP security restrictions for scm to use main. + - `[ScmType <ScmType?>]`: SCM type. + - `[SlowRequestCount <Int32?>]`: Request Count. + - `[SlowRequestTimeInterval <String>]`: Time interval. + - `[SlowRequestTimeTaken <String>]`: Time taken. + - `[TagWhitelistJson <String>]`: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. + - `[TagsRequiringAuth <String>]`: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. + - `[TracingOption <String>]`: Tracing options. + - `[TriggerPrivateBytesInKb <Int32?>]`: A rule based on private bytes. + - `[TriggerStatusCode <IStatusCodesBasedTrigger[]>]`: A rule based on status codes. + - `[Count <Int32?>]`: Request Count. + - `[Status <Int32?>]`: HTTP status code. + - `[SubStatus <Int32?>]`: Request Sub Status. + - `[TimeInterval <String>]`: Time interval. + - `[Win32Status <Int32?>]`: Win32 error code. + - `[Use32BitWorkerProcess <Boolean?>]`: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. + - `[VirtualApplication <IVirtualApplication[]>]`: Virtual applications. + - `[PhysicalPath <String>]`: Physical path. + - `[PreloadEnabled <Boolean?>]`: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. + - `[VirtualDirectory <IVirtualDirectory[]>]`: Virtual directories for virtual application. + - `[PhysicalPath <String>]`: Physical path. + - `[VirtualPath <String>]`: Path to virtual application. + - `[VirtualPath <String>]`: Virtual path. + - `[VnetName <String>]`: Virtual Network name. + - `[WebSocketsEnabled <Boolean?>]`: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. + - `[WindowsFxVersion <String>]`: Xenon App Framework and version + - `[XManagedServiceIdentityId <Int32?>]`: Explicit Managed Service Identity Id + - `[ContainerSize <Int32?>]`: Size of the function container. + - `[DailyMemoryTimeQuota <Int32?>]`: Maximum allowed daily memory-time quota (applicable on dynamic apps only). + - `[Enabled <Boolean?>]`: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). + - `[HostNameSslState <IHostNameSslState[]>]`: Hostname SSL states are used to manage the SSL bindings for app's hostnames. + - `[HostType <HostType?>]`: Indicates whether the hostname is a standard or repository hostname. + - `[Name <String>]`: Hostname. + - `[SslState <SslState?>]`: SSL type. + - `[Thumbprint <String>]`: SSL certificate thumbprint. + - `[ToUpdate <Boolean?>]`: Set to <code>true</code> to update existing hostname. + - `[VirtualIP <String>]`: Virtual IP address assigned to the hostname if IP based SSL is enabled. + - `[HostNamesDisabled <Boolean?>]`: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. + - `[HostingEnvironmentProfileId <String>]`: Resource ID of the App Service Environment. + - `[HttpsOnly <Boolean?>]`: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests + - `[HyperV <Boolean?>]`: Hyper-V sandbox. + - `[IdentityType <ManagedServiceIdentityType?>]`: Type of managed service identity. + - `[IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]`: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} + - `[(Any) <IComponents1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties>]`: This indicates any property can be added to this object. + - `[IsXenon <Boolean?>]`: Obsolete: Hyper-V sandbox. + - `[RedundancyMode <RedundancyMode?>]`: Site redundancy mode + - `[Reserved <Boolean?>]`: <code>true</code> if reserved; otherwise, <code>false</code>. + - `[ScmSiteAlsoStopped <Boolean?>]`: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. + - `[ServerFarmId <String>]`: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/Remove-AzFunctionAppPlan.md b/azps-10.1.0/Az.Functions/Remove-AzFunctionAppPlan.md new file mode 100644 index 0000000000..9b7b81f6e4 --- /dev/null +++ b/azps-10.1.0/Az.Functions/Remove-AzFunctionAppPlan.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/remove-azfunctionappplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Remove-AzFunctionAppPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Remove-AzFunctionAppPlan.md +--- + +# Remove-AzFunctionAppPlan + +## SYNOPSIS +Deletes a function app plan. + +## SYNTAX + +### ByName (Default) +``` +Remove-AzFunctionAppPlan -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Force] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ByObjectInput +``` +Remove-AzFunctionAppPlan -InputObject <IAppServicePlan> [-Force] [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a function app plan. + +## EXAMPLES + +### Example 1: Get a function app plan by name and delete it. +```powershell +Get-AzFunctionAppPlan -Name MyAppName -ResourceGroupName MyResourceGroupName | Remove-AzFunctionAppPlan -Force +``` + +This command gets a function app plan by name and deletes it. + +### Example 2: Delete a function app plan by name. +```powershell +Remove-AzFunctionAppPlan -Name MyAppName -ResourceGroupName MyResourceGroupName -Force +``` + +This command deletes a function app plan by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the cmdlet to remove the function app plan without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IAppServicePlan +Parameter Sets: ByObjectInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of function app. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IAppServicePlan + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IAppServicePlan>`: + - `Location <String>`: Resource Location. + - `[Kind <String>]`: Kind of resource. + - `[Tag <IResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[Capacity <Int32?>]`: Current number of instances assigned to the resource. + - `[FreeOfferExpirationTime <DateTime?>]`: The time when the server farm free offer expires. + - `[HostingEnvironmentProfileId <String>]`: Resource ID of the App Service Environment. + - `[HyperV <Boolean?>]`: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. + - `[IsSpot <Boolean?>]`: If <code>true</code>, this App Service Plan owns spot instances. + - `[IsXenon <Boolean?>]`: Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. + - `[MaximumElasticWorkerCount <Int32?>]`: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan + - `[PerSiteScaling <Boolean?>]`: If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan. + - `[Reserved <Boolean?>]`: If Linux app service plan <code>true</code>, <code>false</code> otherwise. + - `[SkuCapability <ICapability[]>]`: Capabilities of the SKU, e.g., is traffic manager enabled? + - `[Name <String>]`: Name of the SKU capability. + - `[Reason <String>]`: Reason of the SKU capability. + - `[Value <String>]`: Value of the SKU capability. + - `[SkuCapacityDefault <Int32?>]`: Default number of workers for this App Service plan SKU. + - `[SkuCapacityMaximum <Int32?>]`: Maximum number of workers for this App Service plan SKU. + - `[SkuCapacityMinimum <Int32?>]`: Minimum number of workers for this App Service plan SKU. + - `[SkuCapacityScaleType <String>]`: Available scale configurations for an App Service plan. + - `[SkuFamily <String>]`: Family code of the resource SKU. + - `[SkuLocation <String[]>]`: Locations of the SKU. + - `[SkuName <String>]`: Name of the resource SKU. + - `[SkuSize <String>]`: Size specifier of the resource SKU. + - `[SkuTier <String>]`: Service tier of the resource SKU. + - `[SpotExpirationTime <DateTime?>]`: The time when the server farm expires. Valid only if it is a spot server farm. + - `[TargetWorkerCount <Int32?>]`: Scaling worker count. + - `[TargetWorkerSizeId <Int32?>]`: Scaling worker size ID. + - `[WorkerTierName <String>]`: Target worker tier assigned to the App Service plan. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/Remove-AzFunctionAppSetting.md b/azps-10.1.0/Az.Functions/Remove-AzFunctionAppSetting.md new file mode 100644 index 0000000000..f5716a1bc1 --- /dev/null +++ b/azps-10.1.0/Az.Functions/Remove-AzFunctionAppSetting.md @@ -0,0 +1,358 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/remove-azfunctionappsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Remove-AzFunctionAppSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Remove-AzFunctionAppSetting.md +--- + +# Remove-AzFunctionAppSetting + +## SYNOPSIS +Removes app settings from a function app. + +## SYNTAX + +### ByName (Default) +``` +Remove-AzFunctionAppSetting -Name <String> -ResourceGroupName <String> -AppSettingName <String[]> + [-SubscriptionId <String>] [-Force] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ByObjectInput +``` +Remove-AzFunctionAppSetting -AppSettingName <String[]> -InputObject <ISite> [-Force] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Removes app settings from a function app. + +## EXAMPLES + +### Example 1: Remove app settings in a function app. +```powershell +Remove-AzFunctionAppSetting -Name MyAppName -ResourceGroupName MyResourceGroupName -AppSettingName "MyAppSetting1", "MyAppSetting2" +``` + +This command removes app settings in a function app. + +## PARAMETERS + +### -AppSettingName +List of function app settings to be removed from the function app. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the cmdlet to remove function app setting without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite +Parameter Sets: ByObjectInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the function app. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IStringDictionary + +## 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 <ISite>`: + - `Location <String>`: Resource Location. + - `[Kind <String>]`: Kind of resource. + - `[Tag <IResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[ClientAffinityEnabled <Boolean?>]`: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. + - `[ClientCertEnabled <Boolean?>]`: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. + - `[ClientCertExclusionPath <String>]`: client certificate authentication comma-separated exclusion paths + - `[CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]`: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[CloningInfoCloneCustomHostName <Boolean?>]`: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. + - `[CloningInfoCloneSourceControl <Boolean?>]`: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. + - `[CloningInfoConfigureLoadBalancing <Boolean?>]`: <code>true</code> to configure load balancing for source and destination app. + - `[CloningInfoCorrelationId <String>]`: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. + - `[CloningInfoHostingEnvironment <String>]`: App Service Environment. + - `[CloningInfoOverwrite <Boolean?>]`: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. + - `[CloningInfoSourceWebAppId <String>]`: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. + - `[CloningInfoSourceWebAppLocation <String>]`: Location of source app ex: West US or North Europe + - `[CloningInfoTrafficManagerProfileId <String>]`: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. + - `[CloningInfoTrafficManagerProfileName <String>]`: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. + - `[Config <ISiteConfig>]`: Configuration of the app. + - `[AcrUseManagedIdentityCred <Boolean?>]`: Flag to use Managed Identity Creds for ACR pull + - `[AcrUserManagedIdentityId <String>]`: If using user managed identity, the user managed identity ClientId + - `[ActionMinProcessExecutionTime <String>]`: Minimum time the process must execute before taking the action + - `[ActionType <AutoHealActionType?>]`: Predefined action to be taken. + - `[AlwaysOn <Boolean?>]`: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. + - `[ApiDefinitionUrl <String>]`: The URL of the API definition. + - `[ApiManagementConfigId <String>]`: APIM-Api Identifier. + - `[AppCommandLine <String>]`: App command line to launch. + - `[AppSetting <INameValuePair[]>]`: Application settings. + - `[Name <String>]`: Pair name. + - `[Value <String>]`: Pair value. + - `[AutoHealEnabled <Boolean?>]`: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. + - `[AutoSwapSlotName <String>]`: Auto-swap slot name. + - `[ConnectionString <IConnStringInfo[]>]`: Connection strings. + - `[ConnectionString <String>]`: Connection string value. + - `[Name <String>]`: Name of connection string. + - `[Type <ConnectionStringType?>]`: Type of database. + - `[CorAllowedOrigin <String[]>]`: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. + - `[CorSupportCredentials <Boolean?>]`: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. + - `[CustomActionExe <String>]`: Executable to be run. + - `[CustomActionParameter <String>]`: Parameters for the executable. + - `[DefaultDocument <String[]>]`: Default documents. + - `[DetailedErrorLoggingEnabled <Boolean?>]`: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. + - `[DocumentRoot <String>]`: Document root. + - `[DynamicTagsJson <String>]`: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. + - `[ExperimentRampUpRule <IRampUpRule[]>]`: List of ramp-up rules. + - `[ActionHostName <String>]`: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. + - `[ChangeDecisionCallbackUrl <String>]`: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ + - `[ChangeIntervalInMinute <Int32?>]`: Specifies interval in minutes to reevaluate ReroutePercentage. + - `[ChangeStep <Double?>]`: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. + - `[MaxReroutePercentage <Double?>]`: Specifies upper boundary below which ReroutePercentage will stay. + - `[MinReroutePercentage <Double?>]`: Specifies lower boundary above which ReroutePercentage will stay. + - `[Name <String>]`: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. + - `[ReroutePercentage <Double?>]`: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. + - `[FtpsState <FtpsState?>]`: State of FTP / FTPS service + - `[HandlerMapping <IHandlerMapping[]>]`: Handler mappings. + - `[Argument <String>]`: Command-line arguments to be passed to the script processor. + - `[Extension <String>]`: Requests with this extension will be handled using the specified FastCGI application. + - `[ScriptProcessor <String>]`: The absolute path to the FastCGI application. + - `[HealthCheckPath <String>]`: Health check path + - `[Http20Enabled <Boolean?>]`: Http20Enabled: configures a web site to allow clients to connect over http2.0 + - `[HttpLoggingEnabled <Boolean?>]`: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. + - `[IPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for main. + - `[Action <String>]`: Allow or Deny access for this IP range. + - `[Description <String>]`: IP restriction rule description. + - `[IPAddress <String>]`: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. + - `[Name <String>]`: IP restriction rule name. + - `[Priority <Int32?>]`: Priority of IP restriction rule. + - `[SubnetMask <String>]`: Subnet mask for the range of IP addresses the restriction is valid for. + - `[SubnetTrafficTag <Int32?>]`: (internal) Subnet traffic tag + - `[Tag <IPFilterTag?>]`: Defines what this IP filter will be used for. This is to support IP filtering on proxies. + - `[VnetSubnetResourceId <String>]`: Virtual network resource id + - `[VnetTrafficTag <Int32?>]`: (internal) Vnet traffic tag + - `[IsPushEnabled <Boolean?>]`: Gets or sets a flag indicating whether the Push endpoint is enabled. + - `[JavaContainer <String>]`: Java container. + - `[JavaContainerVersion <String>]`: Java container version. + - `[JavaVersion <String>]`: Java version. + - `[LimitMaxDiskSizeInMb <Int64?>]`: Maximum allowed disk size usage in MB. + - `[LimitMaxMemoryInMb <Int64?>]`: Maximum allowed memory usage in MB. + - `[LimitMaxPercentageCpu <Double?>]`: Maximum allowed CPU usage percentage. + - `[LinuxFxVersion <String>]`: Linux App Framework and version + - `[LoadBalancing <SiteLoadBalancing?>]`: Site load balancing. + - `[LocalMySqlEnabled <Boolean?>]`: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. + - `[LogsDirectorySizeLimit <Int32?>]`: HTTP logs directory size limit. + - `[MachineKeyDecryption <String>]`: Algorithm used for decryption. + - `[MachineKeyDecryptionKey <String>]`: Decryption key. + - `[MachineKeyValidation <String>]`: MachineKey validation. + - `[MachineKeyValidationKey <String>]`: Validation key. + - `[ManagedPipelineMode <ManagedPipelineMode?>]`: Managed pipeline mode. + - `[ManagedServiceIdentityId <Int32?>]`: Managed Service Identity Id + - `[MinTlsVersion <SupportedTlsVersions?>]`: MinTlsVersion: configures the minimum version of TLS required for SSL requests + - `[NetFrameworkVersion <String>]`: .NET Framework version. + - `[NodeVersion <String>]`: Version of Node.js. + - `[NumberOfWorker <Int32?>]`: Number of workers. + - `[PhpVersion <String>]`: Version of PHP. + - `[PowerShellVersion <String>]`: Version of PowerShell. + - `[PreWarmedInstanceCount <Int32?>]`: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans + - `[PublishingUsername <String>]`: Publishing user name. + - `[PushKind <String>]`: Kind of resource. + - `[PythonVersion <String>]`: Version of Python. + - `[RemoteDebuggingEnabled <Boolean?>]`: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. + - `[RemoteDebuggingVersion <String>]`: Remote debugging version. + - `[RequestCount <Int32?>]`: Request Count. + - `[RequestTimeInterval <String>]`: Time interval. + - `[RequestTracingEnabled <Boolean?>]`: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. + - `[RequestTracingExpirationTime <DateTime?>]`: Request tracing expiration time. + - `[ScmIPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for scm. + - `[ScmIPSecurityRestrictionsUseMain <Boolean?>]`: IP security restrictions for scm to use main. + - `[ScmType <ScmType?>]`: SCM type. + - `[SlowRequestCount <Int32?>]`: Request Count. + - `[SlowRequestTimeInterval <String>]`: Time interval. + - `[SlowRequestTimeTaken <String>]`: Time taken. + - `[TagWhitelistJson <String>]`: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. + - `[TagsRequiringAuth <String>]`: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. + - `[TracingOption <String>]`: Tracing options. + - `[TriggerPrivateBytesInKb <Int32?>]`: A rule based on private bytes. + - `[TriggerStatusCode <IStatusCodesBasedTrigger[]>]`: A rule based on status codes. + - `[Count <Int32?>]`: Request Count. + - `[Status <Int32?>]`: HTTP status code. + - `[SubStatus <Int32?>]`: Request Sub Status. + - `[TimeInterval <String>]`: Time interval. + - `[Win32Status <Int32?>]`: Win32 error code. + - `[Use32BitWorkerProcess <Boolean?>]`: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. + - `[VirtualApplication <IVirtualApplication[]>]`: Virtual applications. + - `[PhysicalPath <String>]`: Physical path. + - `[PreloadEnabled <Boolean?>]`: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. + - `[VirtualDirectory <IVirtualDirectory[]>]`: Virtual directories for virtual application. + - `[PhysicalPath <String>]`: Physical path. + - `[VirtualPath <String>]`: Path to virtual application. + - `[VirtualPath <String>]`: Virtual path. + - `[VnetName <String>]`: Virtual Network name. + - `[WebSocketsEnabled <Boolean?>]`: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. + - `[WindowsFxVersion <String>]`: Xenon App Framework and version + - `[XManagedServiceIdentityId <Int32?>]`: Explicit Managed Service Identity Id + - `[ContainerSize <Int32?>]`: Size of the function container. + - `[DailyMemoryTimeQuota <Int32?>]`: Maximum allowed daily memory-time quota (applicable on dynamic apps only). + - `[Enabled <Boolean?>]`: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). + - `[HostNameSslState <IHostNameSslState[]>]`: Hostname SSL states are used to manage the SSL bindings for app's hostnames. + - `[HostType <HostType?>]`: Indicates whether the hostname is a standard or repository hostname. + - `[Name <String>]`: Hostname. + - `[SslState <SslState?>]`: SSL type. + - `[Thumbprint <String>]`: SSL certificate thumbprint. + - `[ToUpdate <Boolean?>]`: Set to <code>true</code> to update existing hostname. + - `[VirtualIP <String>]`: Virtual IP address assigned to the hostname if IP based SSL is enabled. + - `[HostNamesDisabled <Boolean?>]`: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. + - `[HostingEnvironmentProfileId <String>]`: Resource ID of the App Service Environment. + - `[HttpsOnly <Boolean?>]`: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests + - `[HyperV <Boolean?>]`: Hyper-V sandbox. + - `[IdentityType <ManagedServiceIdentityType?>]`: Type of managed service identity. + - `[IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]`: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} + - `[(Any) <IComponents1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties>]`: This indicates any property can be added to this object. + - `[IsXenon <Boolean?>]`: Obsolete: Hyper-V sandbox. + - `[RedundancyMode <RedundancyMode?>]`: Site redundancy mode + - `[Reserved <Boolean?>]`: <code>true</code> if reserved; otherwise, <code>false</code>. + - `[ScmSiteAlsoStopped <Boolean?>]`: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. + - `[ServerFarmId <String>]`: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/Restart-AzFunctionApp.md b/azps-10.1.0/Az.Functions/Restart-AzFunctionApp.md new file mode 100644 index 0000000000..d52135b927 --- /dev/null +++ b/azps-10.1.0/Az.Functions/Restart-AzFunctionApp.md @@ -0,0 +1,365 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/restart-azfunctionapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Restart-AzFunctionApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Restart-AzFunctionApp.md +--- + +# Restart-AzFunctionApp + +## SYNOPSIS +Restarts a function app. + +## SYNTAX + +### RestartByName (Default) +``` +Restart-AzFunctionApp -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Force] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ByObjectInput +``` +Restart-AzFunctionApp -InputObject <ISite> [-Force] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Restarts a function app. + +## EXAMPLES + +### Example 1: Get a function app by name and restart it. +```powershell +Get-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName | Restart-AzFunctionApp -Force +``` + +This command gets a function app by name and restarts it. + +### Example 2: Restart a function app by name. +```powershell +Restart-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName -Force +``` + +This command restarts a function app by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the cmdlet to restart the function app without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite +Parameter Sets: ByObjectInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of function app. + +```yaml +Type: System.String +Parameter Sets: RestartByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: RestartByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: RestartByName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISite>`: + - `Location <String>`: Resource Location. + - `[Kind <String>]`: Kind of resource. + - `[Tag <IResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[ClientAffinityEnabled <Boolean?>]`: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. + - `[ClientCertEnabled <Boolean?>]`: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. + - `[ClientCertExclusionPath <String>]`: client certificate authentication comma-separated exclusion paths + - `[CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]`: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[CloningInfoCloneCustomHostName <Boolean?>]`: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. + - `[CloningInfoCloneSourceControl <Boolean?>]`: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. + - `[CloningInfoConfigureLoadBalancing <Boolean?>]`: <code>true</code> to configure load balancing for source and destination app. + - `[CloningInfoCorrelationId <String>]`: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. + - `[CloningInfoHostingEnvironment <String>]`: App Service Environment. + - `[CloningInfoOverwrite <Boolean?>]`: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. + - `[CloningInfoSourceWebAppId <String>]`: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. + - `[CloningInfoSourceWebAppLocation <String>]`: Location of source app ex: West US or North Europe + - `[CloningInfoTrafficManagerProfileId <String>]`: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. + - `[CloningInfoTrafficManagerProfileName <String>]`: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. + - `[Config <ISiteConfig>]`: Configuration of the app. + - `[AcrUseManagedIdentityCred <Boolean?>]`: Flag to use Managed Identity Creds for ACR pull + - `[AcrUserManagedIdentityId <String>]`: If using user managed identity, the user managed identity ClientId + - `[ActionMinProcessExecutionTime <String>]`: Minimum time the process must execute before taking the action + - `[ActionType <AutoHealActionType?>]`: Predefined action to be taken. + - `[AlwaysOn <Boolean?>]`: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. + - `[ApiDefinitionUrl <String>]`: The URL of the API definition. + - `[ApiManagementConfigId <String>]`: APIM-Api Identifier. + - `[AppCommandLine <String>]`: App command line to launch. + - `[AppSetting <INameValuePair[]>]`: Application settings. + - `[Name <String>]`: Pair name. + - `[Value <String>]`: Pair value. + - `[AutoHealEnabled <Boolean?>]`: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. + - `[AutoSwapSlotName <String>]`: Auto-swap slot name. + - `[ConnectionString <IConnStringInfo[]>]`: Connection strings. + - `[ConnectionString <String>]`: Connection string value. + - `[Name <String>]`: Name of connection string. + - `[Type <ConnectionStringType?>]`: Type of database. + - `[CorAllowedOrigin <String[]>]`: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. + - `[CorSupportCredentials <Boolean?>]`: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. + - `[CustomActionExe <String>]`: Executable to be run. + - `[CustomActionParameter <String>]`: Parameters for the executable. + - `[DefaultDocument <String[]>]`: Default documents. + - `[DetailedErrorLoggingEnabled <Boolean?>]`: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. + - `[DocumentRoot <String>]`: Document root. + - `[DynamicTagsJson <String>]`: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. + - `[ExperimentRampUpRule <IRampUpRule[]>]`: List of ramp-up rules. + - `[ActionHostName <String>]`: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. + - `[ChangeDecisionCallbackUrl <String>]`: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ + - `[ChangeIntervalInMinute <Int32?>]`: Specifies interval in minutes to reevaluate ReroutePercentage. + - `[ChangeStep <Double?>]`: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. + - `[MaxReroutePercentage <Double?>]`: Specifies upper boundary below which ReroutePercentage will stay. + - `[MinReroutePercentage <Double?>]`: Specifies lower boundary above which ReroutePercentage will stay. + - `[Name <String>]`: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. + - `[ReroutePercentage <Double?>]`: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. + - `[FtpsState <FtpsState?>]`: State of FTP / FTPS service + - `[HandlerMapping <IHandlerMapping[]>]`: Handler mappings. + - `[Argument <String>]`: Command-line arguments to be passed to the script processor. + - `[Extension <String>]`: Requests with this extension will be handled using the specified FastCGI application. + - `[ScriptProcessor <String>]`: The absolute path to the FastCGI application. + - `[HealthCheckPath <String>]`: Health check path + - `[Http20Enabled <Boolean?>]`: Http20Enabled: configures a web site to allow clients to connect over http2.0 + - `[HttpLoggingEnabled <Boolean?>]`: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. + - `[IPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for main. + - `[Action <String>]`: Allow or Deny access for this IP range. + - `[Description <String>]`: IP restriction rule description. + - `[IPAddress <String>]`: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. + - `[Name <String>]`: IP restriction rule name. + - `[Priority <Int32?>]`: Priority of IP restriction rule. + - `[SubnetMask <String>]`: Subnet mask for the range of IP addresses the restriction is valid for. + - `[SubnetTrafficTag <Int32?>]`: (internal) Subnet traffic tag + - `[Tag <IPFilterTag?>]`: Defines what this IP filter will be used for. This is to support IP filtering on proxies. + - `[VnetSubnetResourceId <String>]`: Virtual network resource id + - `[VnetTrafficTag <Int32?>]`: (internal) Vnet traffic tag + - `[IsPushEnabled <Boolean?>]`: Gets or sets a flag indicating whether the Push endpoint is enabled. + - `[JavaContainer <String>]`: Java container. + - `[JavaContainerVersion <String>]`: Java container version. + - `[JavaVersion <String>]`: Java version. + - `[LimitMaxDiskSizeInMb <Int64?>]`: Maximum allowed disk size usage in MB. + - `[LimitMaxMemoryInMb <Int64?>]`: Maximum allowed memory usage in MB. + - `[LimitMaxPercentageCpu <Double?>]`: Maximum allowed CPU usage percentage. + - `[LinuxFxVersion <String>]`: Linux App Framework and version + - `[LoadBalancing <SiteLoadBalancing?>]`: Site load balancing. + - `[LocalMySqlEnabled <Boolean?>]`: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. + - `[LogsDirectorySizeLimit <Int32?>]`: HTTP logs directory size limit. + - `[MachineKeyDecryption <String>]`: Algorithm used for decryption. + - `[MachineKeyDecryptionKey <String>]`: Decryption key. + - `[MachineKeyValidation <String>]`: MachineKey validation. + - `[MachineKeyValidationKey <String>]`: Validation key. + - `[ManagedPipelineMode <ManagedPipelineMode?>]`: Managed pipeline mode. + - `[ManagedServiceIdentityId <Int32?>]`: Managed Service Identity Id + - `[MinTlsVersion <SupportedTlsVersions?>]`: MinTlsVersion: configures the minimum version of TLS required for SSL requests + - `[NetFrameworkVersion <String>]`: .NET Framework version. + - `[NodeVersion <String>]`: Version of Node.js. + - `[NumberOfWorker <Int32?>]`: Number of workers. + - `[PhpVersion <String>]`: Version of PHP. + - `[PowerShellVersion <String>]`: Version of PowerShell. + - `[PreWarmedInstanceCount <Int32?>]`: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans + - `[PublishingUsername <String>]`: Publishing user name. + - `[PushKind <String>]`: Kind of resource. + - `[PythonVersion <String>]`: Version of Python. + - `[RemoteDebuggingEnabled <Boolean?>]`: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. + - `[RemoteDebuggingVersion <String>]`: Remote debugging version. + - `[RequestCount <Int32?>]`: Request Count. + - `[RequestTimeInterval <String>]`: Time interval. + - `[RequestTracingEnabled <Boolean?>]`: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. + - `[RequestTracingExpirationTime <DateTime?>]`: Request tracing expiration time. + - `[ScmIPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for scm. + - `[ScmIPSecurityRestrictionsUseMain <Boolean?>]`: IP security restrictions for scm to use main. + - `[ScmType <ScmType?>]`: SCM type. + - `[SlowRequestCount <Int32?>]`: Request Count. + - `[SlowRequestTimeInterval <String>]`: Time interval. + - `[SlowRequestTimeTaken <String>]`: Time taken. + - `[TagWhitelistJson <String>]`: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. + - `[TagsRequiringAuth <String>]`: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. + - `[TracingOption <String>]`: Tracing options. + - `[TriggerPrivateBytesInKb <Int32?>]`: A rule based on private bytes. + - `[TriggerStatusCode <IStatusCodesBasedTrigger[]>]`: A rule based on status codes. + - `[Count <Int32?>]`: Request Count. + - `[Status <Int32?>]`: HTTP status code. + - `[SubStatus <Int32?>]`: Request Sub Status. + - `[TimeInterval <String>]`: Time interval. + - `[Win32Status <Int32?>]`: Win32 error code. + - `[Use32BitWorkerProcess <Boolean?>]`: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. + - `[VirtualApplication <IVirtualApplication[]>]`: Virtual applications. + - `[PhysicalPath <String>]`: Physical path. + - `[PreloadEnabled <Boolean?>]`: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. + - `[VirtualDirectory <IVirtualDirectory[]>]`: Virtual directories for virtual application. + - `[PhysicalPath <String>]`: Physical path. + - `[VirtualPath <String>]`: Path to virtual application. + - `[VirtualPath <String>]`: Virtual path. + - `[VnetName <String>]`: Virtual Network name. + - `[WebSocketsEnabled <Boolean?>]`: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. + - `[WindowsFxVersion <String>]`: Xenon App Framework and version + - `[XManagedServiceIdentityId <Int32?>]`: Explicit Managed Service Identity Id + - `[ContainerSize <Int32?>]`: Size of the function container. + - `[DailyMemoryTimeQuota <Int32?>]`: Maximum allowed daily memory-time quota (applicable on dynamic apps only). + - `[Enabled <Boolean?>]`: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). + - `[HostNameSslState <IHostNameSslState[]>]`: Hostname SSL states are used to manage the SSL bindings for app's hostnames. + - `[HostType <HostType?>]`: Indicates whether the hostname is a standard or repository hostname. + - `[Name <String>]`: Hostname. + - `[SslState <SslState?>]`: SSL type. + - `[Thumbprint <String>]`: SSL certificate thumbprint. + - `[ToUpdate <Boolean?>]`: Set to <code>true</code> to update existing hostname. + - `[VirtualIP <String>]`: Virtual IP address assigned to the hostname if IP based SSL is enabled. + - `[HostNamesDisabled <Boolean?>]`: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. + - `[HostingEnvironmentProfileId <String>]`: Resource ID of the App Service Environment. + - `[HttpsOnly <Boolean?>]`: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests + - `[HyperV <Boolean?>]`: Hyper-V sandbox. + - `[IdentityType <ManagedServiceIdentityType?>]`: Type of managed service identity. + - `[IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]`: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} + - `[(Any) <IComponents1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties>]`: This indicates any property can be added to this object. + - `[IsXenon <Boolean?>]`: Obsolete: Hyper-V sandbox. + - `[RedundancyMode <RedundancyMode?>]`: Site redundancy mode + - `[Reserved <Boolean?>]`: <code>true</code> if reserved; otherwise, <code>false</code>. + - `[ScmSiteAlsoStopped <Boolean?>]`: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. + - `[ServerFarmId <String>]`: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/Start-AzFunctionApp.md b/azps-10.1.0/Az.Functions/Start-AzFunctionApp.md new file mode 100644 index 0000000000..ff062027f0 --- /dev/null +++ b/azps-10.1.0/Az.Functions/Start-AzFunctionApp.md @@ -0,0 +1,350 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/start-azfunctionapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Start-AzFunctionApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Start-AzFunctionApp.md +--- + +# Start-AzFunctionApp + +## SYNOPSIS +Starts a function app. + +## SYNTAX + +### StartByName (Default) +``` +Start-AzFunctionApp -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ByObjectInput +``` +Start-AzFunctionApp -InputObject <ISite> [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Starts a function app. + +## EXAMPLES + +### Example 1: Get a function app by name and start it. +```powershell +Get-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName | Start-AzFunctionApp +``` + +This command gets a function app by name and starts it. + +### Example 2: Start a function app by name. +```powershell +Start-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName +``` + +This command starts a function app by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite +Parameter Sets: ByObjectInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of function app. + +```yaml +Type: System.String +Parameter Sets: StartByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: StartByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: StartByName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISite>`: + - `Location <String>`: Resource Location. + - `[Kind <String>]`: Kind of resource. + - `[Tag <IResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[ClientAffinityEnabled <Boolean?>]`: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. + - `[ClientCertEnabled <Boolean?>]`: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. + - `[ClientCertExclusionPath <String>]`: client certificate authentication comma-separated exclusion paths + - `[CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]`: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[CloningInfoCloneCustomHostName <Boolean?>]`: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. + - `[CloningInfoCloneSourceControl <Boolean?>]`: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. + - `[CloningInfoConfigureLoadBalancing <Boolean?>]`: <code>true</code> to configure load balancing for source and destination app. + - `[CloningInfoCorrelationId <String>]`: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. + - `[CloningInfoHostingEnvironment <String>]`: App Service Environment. + - `[CloningInfoOverwrite <Boolean?>]`: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. + - `[CloningInfoSourceWebAppId <String>]`: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. + - `[CloningInfoSourceWebAppLocation <String>]`: Location of source app ex: West US or North Europe + - `[CloningInfoTrafficManagerProfileId <String>]`: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. + - `[CloningInfoTrafficManagerProfileName <String>]`: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. + - `[Config <ISiteConfig>]`: Configuration of the app. + - `[AcrUseManagedIdentityCred <Boolean?>]`: Flag to use Managed Identity Creds for ACR pull + - `[AcrUserManagedIdentityId <String>]`: If using user managed identity, the user managed identity ClientId + - `[ActionMinProcessExecutionTime <String>]`: Minimum time the process must execute before taking the action + - `[ActionType <AutoHealActionType?>]`: Predefined action to be taken. + - `[AlwaysOn <Boolean?>]`: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. + - `[ApiDefinitionUrl <String>]`: The URL of the API definition. + - `[ApiManagementConfigId <String>]`: APIM-Api Identifier. + - `[AppCommandLine <String>]`: App command line to launch. + - `[AppSetting <INameValuePair[]>]`: Application settings. + - `[Name <String>]`: Pair name. + - `[Value <String>]`: Pair value. + - `[AutoHealEnabled <Boolean?>]`: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. + - `[AutoSwapSlotName <String>]`: Auto-swap slot name. + - `[ConnectionString <IConnStringInfo[]>]`: Connection strings. + - `[ConnectionString <String>]`: Connection string value. + - `[Name <String>]`: Name of connection string. + - `[Type <ConnectionStringType?>]`: Type of database. + - `[CorAllowedOrigin <String[]>]`: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. + - `[CorSupportCredentials <Boolean?>]`: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. + - `[CustomActionExe <String>]`: Executable to be run. + - `[CustomActionParameter <String>]`: Parameters for the executable. + - `[DefaultDocument <String[]>]`: Default documents. + - `[DetailedErrorLoggingEnabled <Boolean?>]`: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. + - `[DocumentRoot <String>]`: Document root. + - `[DynamicTagsJson <String>]`: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. + - `[ExperimentRampUpRule <IRampUpRule[]>]`: List of ramp-up rules. + - `[ActionHostName <String>]`: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. + - `[ChangeDecisionCallbackUrl <String>]`: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ + - `[ChangeIntervalInMinute <Int32?>]`: Specifies interval in minutes to reevaluate ReroutePercentage. + - `[ChangeStep <Double?>]`: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. + - `[MaxReroutePercentage <Double?>]`: Specifies upper boundary below which ReroutePercentage will stay. + - `[MinReroutePercentage <Double?>]`: Specifies lower boundary above which ReroutePercentage will stay. + - `[Name <String>]`: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. + - `[ReroutePercentage <Double?>]`: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. + - `[FtpsState <FtpsState?>]`: State of FTP / FTPS service + - `[HandlerMapping <IHandlerMapping[]>]`: Handler mappings. + - `[Argument <String>]`: Command-line arguments to be passed to the script processor. + - `[Extension <String>]`: Requests with this extension will be handled using the specified FastCGI application. + - `[ScriptProcessor <String>]`: The absolute path to the FastCGI application. + - `[HealthCheckPath <String>]`: Health check path + - `[Http20Enabled <Boolean?>]`: Http20Enabled: configures a web site to allow clients to connect over http2.0 + - `[HttpLoggingEnabled <Boolean?>]`: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. + - `[IPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for main. + - `[Action <String>]`: Allow or Deny access for this IP range. + - `[Description <String>]`: IP restriction rule description. + - `[IPAddress <String>]`: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. + - `[Name <String>]`: IP restriction rule name. + - `[Priority <Int32?>]`: Priority of IP restriction rule. + - `[SubnetMask <String>]`: Subnet mask for the range of IP addresses the restriction is valid for. + - `[SubnetTrafficTag <Int32?>]`: (internal) Subnet traffic tag + - `[Tag <IPFilterTag?>]`: Defines what this IP filter will be used for. This is to support IP filtering on proxies. + - `[VnetSubnetResourceId <String>]`: Virtual network resource id + - `[VnetTrafficTag <Int32?>]`: (internal) Vnet traffic tag + - `[IsPushEnabled <Boolean?>]`: Gets or sets a flag indicating whether the Push endpoint is enabled. + - `[JavaContainer <String>]`: Java container. + - `[JavaContainerVersion <String>]`: Java container version. + - `[JavaVersion <String>]`: Java version. + - `[LimitMaxDiskSizeInMb <Int64?>]`: Maximum allowed disk size usage in MB. + - `[LimitMaxMemoryInMb <Int64?>]`: Maximum allowed memory usage in MB. + - `[LimitMaxPercentageCpu <Double?>]`: Maximum allowed CPU usage percentage. + - `[LinuxFxVersion <String>]`: Linux App Framework and version + - `[LoadBalancing <SiteLoadBalancing?>]`: Site load balancing. + - `[LocalMySqlEnabled <Boolean?>]`: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. + - `[LogsDirectorySizeLimit <Int32?>]`: HTTP logs directory size limit. + - `[MachineKeyDecryption <String>]`: Algorithm used for decryption. + - `[MachineKeyDecryptionKey <String>]`: Decryption key. + - `[MachineKeyValidation <String>]`: MachineKey validation. + - `[MachineKeyValidationKey <String>]`: Validation key. + - `[ManagedPipelineMode <ManagedPipelineMode?>]`: Managed pipeline mode. + - `[ManagedServiceIdentityId <Int32?>]`: Managed Service Identity Id + - `[MinTlsVersion <SupportedTlsVersions?>]`: MinTlsVersion: configures the minimum version of TLS required for SSL requests + - `[NetFrameworkVersion <String>]`: .NET Framework version. + - `[NodeVersion <String>]`: Version of Node.js. + - `[NumberOfWorker <Int32?>]`: Number of workers. + - `[PhpVersion <String>]`: Version of PHP. + - `[PowerShellVersion <String>]`: Version of PowerShell. + - `[PreWarmedInstanceCount <Int32?>]`: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans + - `[PublishingUsername <String>]`: Publishing user name. + - `[PushKind <String>]`: Kind of resource. + - `[PythonVersion <String>]`: Version of Python. + - `[RemoteDebuggingEnabled <Boolean?>]`: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. + - `[RemoteDebuggingVersion <String>]`: Remote debugging version. + - `[RequestCount <Int32?>]`: Request Count. + - `[RequestTimeInterval <String>]`: Time interval. + - `[RequestTracingEnabled <Boolean?>]`: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. + - `[RequestTracingExpirationTime <DateTime?>]`: Request tracing expiration time. + - `[ScmIPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for scm. + - `[ScmIPSecurityRestrictionsUseMain <Boolean?>]`: IP security restrictions for scm to use main. + - `[ScmType <ScmType?>]`: SCM type. + - `[SlowRequestCount <Int32?>]`: Request Count. + - `[SlowRequestTimeInterval <String>]`: Time interval. + - `[SlowRequestTimeTaken <String>]`: Time taken. + - `[TagWhitelistJson <String>]`: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. + - `[TagsRequiringAuth <String>]`: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. + - `[TracingOption <String>]`: Tracing options. + - `[TriggerPrivateBytesInKb <Int32?>]`: A rule based on private bytes. + - `[TriggerStatusCode <IStatusCodesBasedTrigger[]>]`: A rule based on status codes. + - `[Count <Int32?>]`: Request Count. + - `[Status <Int32?>]`: HTTP status code. + - `[SubStatus <Int32?>]`: Request Sub Status. + - `[TimeInterval <String>]`: Time interval. + - `[Win32Status <Int32?>]`: Win32 error code. + - `[Use32BitWorkerProcess <Boolean?>]`: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. + - `[VirtualApplication <IVirtualApplication[]>]`: Virtual applications. + - `[PhysicalPath <String>]`: Physical path. + - `[PreloadEnabled <Boolean?>]`: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. + - `[VirtualDirectory <IVirtualDirectory[]>]`: Virtual directories for virtual application. + - `[PhysicalPath <String>]`: Physical path. + - `[VirtualPath <String>]`: Path to virtual application. + - `[VirtualPath <String>]`: Virtual path. + - `[VnetName <String>]`: Virtual Network name. + - `[WebSocketsEnabled <Boolean?>]`: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. + - `[WindowsFxVersion <String>]`: Xenon App Framework and version + - `[XManagedServiceIdentityId <Int32?>]`: Explicit Managed Service Identity Id + - `[ContainerSize <Int32?>]`: Size of the function container. + - `[DailyMemoryTimeQuota <Int32?>]`: Maximum allowed daily memory-time quota (applicable on dynamic apps only). + - `[Enabled <Boolean?>]`: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). + - `[HostNameSslState <IHostNameSslState[]>]`: Hostname SSL states are used to manage the SSL bindings for app's hostnames. + - `[HostType <HostType?>]`: Indicates whether the hostname is a standard or repository hostname. + - `[Name <String>]`: Hostname. + - `[SslState <SslState?>]`: SSL type. + - `[Thumbprint <String>]`: SSL certificate thumbprint. + - `[ToUpdate <Boolean?>]`: Set to <code>true</code> to update existing hostname. + - `[VirtualIP <String>]`: Virtual IP address assigned to the hostname if IP based SSL is enabled. + - `[HostNamesDisabled <Boolean?>]`: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. + - `[HostingEnvironmentProfileId <String>]`: Resource ID of the App Service Environment. + - `[HttpsOnly <Boolean?>]`: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests + - `[HyperV <Boolean?>]`: Hyper-V sandbox. + - `[IdentityType <ManagedServiceIdentityType?>]`: Type of managed service identity. + - `[IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]`: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} + - `[(Any) <IComponents1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties>]`: This indicates any property can be added to this object. + - `[IsXenon <Boolean?>]`: Obsolete: Hyper-V sandbox. + - `[RedundancyMode <RedundancyMode?>]`: Site redundancy mode + - `[Reserved <Boolean?>]`: <code>true</code> if reserved; otherwise, <code>false</code>. + - `[ScmSiteAlsoStopped <Boolean?>]`: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. + - `[ServerFarmId <String>]`: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/Stop-AzFunctionApp.md b/azps-10.1.0/Az.Functions/Stop-AzFunctionApp.md new file mode 100644 index 0000000000..b37b7327a0 --- /dev/null +++ b/azps-10.1.0/Az.Functions/Stop-AzFunctionApp.md @@ -0,0 +1,365 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/stop-azfunctionapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Stop-AzFunctionApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Stop-AzFunctionApp.md +--- + +# Stop-AzFunctionApp + +## SYNOPSIS +Stops a function app. + +## SYNTAX + +### StopByName (Default) +``` +Stop-AzFunctionApp -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Force] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ByObjectInput +``` +Stop-AzFunctionApp -InputObject <ISite> [-Force] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Stops a function app. + +## EXAMPLES + +### Example 1: Get a function app by name and stop it. +```powershell +Get-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName | Stop-AzFunctionApp -Force +``` + +This command gets a function app by name and stops it. + +### Example 2: Stop a function app by name. +```powershell +Stop-AzFunctionApp -Name MyAppName -ResourceGroupName MyResourceGroupName -Force +``` + +This command stops a function app by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the cmdlet to stop the function app without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite +Parameter Sets: ByObjectInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of function app. + +```yaml +Type: System.String +Parameter Sets: StopByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: StopByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: StopByName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISite>`: + - `Location <String>`: Resource Location. + - `[Kind <String>]`: Kind of resource. + - `[Tag <IResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[ClientAffinityEnabled <Boolean?>]`: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. + - `[ClientCertEnabled <Boolean?>]`: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. + - `[ClientCertExclusionPath <String>]`: client certificate authentication comma-separated exclusion paths + - `[CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]`: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[CloningInfoCloneCustomHostName <Boolean?>]`: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. + - `[CloningInfoCloneSourceControl <Boolean?>]`: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. + - `[CloningInfoConfigureLoadBalancing <Boolean?>]`: <code>true</code> to configure load balancing for source and destination app. + - `[CloningInfoCorrelationId <String>]`: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. + - `[CloningInfoHostingEnvironment <String>]`: App Service Environment. + - `[CloningInfoOverwrite <Boolean?>]`: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. + - `[CloningInfoSourceWebAppId <String>]`: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. + - `[CloningInfoSourceWebAppLocation <String>]`: Location of source app ex: West US or North Europe + - `[CloningInfoTrafficManagerProfileId <String>]`: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. + - `[CloningInfoTrafficManagerProfileName <String>]`: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. + - `[Config <ISiteConfig>]`: Configuration of the app. + - `[AcrUseManagedIdentityCred <Boolean?>]`: Flag to use Managed Identity Creds for ACR pull + - `[AcrUserManagedIdentityId <String>]`: If using user managed identity, the user managed identity ClientId + - `[ActionMinProcessExecutionTime <String>]`: Minimum time the process must execute before taking the action + - `[ActionType <AutoHealActionType?>]`: Predefined action to be taken. + - `[AlwaysOn <Boolean?>]`: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. + - `[ApiDefinitionUrl <String>]`: The URL of the API definition. + - `[ApiManagementConfigId <String>]`: APIM-Api Identifier. + - `[AppCommandLine <String>]`: App command line to launch. + - `[AppSetting <INameValuePair[]>]`: Application settings. + - `[Name <String>]`: Pair name. + - `[Value <String>]`: Pair value. + - `[AutoHealEnabled <Boolean?>]`: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. + - `[AutoSwapSlotName <String>]`: Auto-swap slot name. + - `[ConnectionString <IConnStringInfo[]>]`: Connection strings. + - `[ConnectionString <String>]`: Connection string value. + - `[Name <String>]`: Name of connection string. + - `[Type <ConnectionStringType?>]`: Type of database. + - `[CorAllowedOrigin <String[]>]`: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. + - `[CorSupportCredentials <Boolean?>]`: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. + - `[CustomActionExe <String>]`: Executable to be run. + - `[CustomActionParameter <String>]`: Parameters for the executable. + - `[DefaultDocument <String[]>]`: Default documents. + - `[DetailedErrorLoggingEnabled <Boolean?>]`: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. + - `[DocumentRoot <String>]`: Document root. + - `[DynamicTagsJson <String>]`: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. + - `[ExperimentRampUpRule <IRampUpRule[]>]`: List of ramp-up rules. + - `[ActionHostName <String>]`: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. + - `[ChangeDecisionCallbackUrl <String>]`: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ + - `[ChangeIntervalInMinute <Int32?>]`: Specifies interval in minutes to reevaluate ReroutePercentage. + - `[ChangeStep <Double?>]`: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. + - `[MaxReroutePercentage <Double?>]`: Specifies upper boundary below which ReroutePercentage will stay. + - `[MinReroutePercentage <Double?>]`: Specifies lower boundary above which ReroutePercentage will stay. + - `[Name <String>]`: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. + - `[ReroutePercentage <Double?>]`: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. + - `[FtpsState <FtpsState?>]`: State of FTP / FTPS service + - `[HandlerMapping <IHandlerMapping[]>]`: Handler mappings. + - `[Argument <String>]`: Command-line arguments to be passed to the script processor. + - `[Extension <String>]`: Requests with this extension will be handled using the specified FastCGI application. + - `[ScriptProcessor <String>]`: The absolute path to the FastCGI application. + - `[HealthCheckPath <String>]`: Health check path + - `[Http20Enabled <Boolean?>]`: Http20Enabled: configures a web site to allow clients to connect over http2.0 + - `[HttpLoggingEnabled <Boolean?>]`: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. + - `[IPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for main. + - `[Action <String>]`: Allow or Deny access for this IP range. + - `[Description <String>]`: IP restriction rule description. + - `[IPAddress <String>]`: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. + - `[Name <String>]`: IP restriction rule name. + - `[Priority <Int32?>]`: Priority of IP restriction rule. + - `[SubnetMask <String>]`: Subnet mask for the range of IP addresses the restriction is valid for. + - `[SubnetTrafficTag <Int32?>]`: (internal) Subnet traffic tag + - `[Tag <IPFilterTag?>]`: Defines what this IP filter will be used for. This is to support IP filtering on proxies. + - `[VnetSubnetResourceId <String>]`: Virtual network resource id + - `[VnetTrafficTag <Int32?>]`: (internal) Vnet traffic tag + - `[IsPushEnabled <Boolean?>]`: Gets or sets a flag indicating whether the Push endpoint is enabled. + - `[JavaContainer <String>]`: Java container. + - `[JavaContainerVersion <String>]`: Java container version. + - `[JavaVersion <String>]`: Java version. + - `[LimitMaxDiskSizeInMb <Int64?>]`: Maximum allowed disk size usage in MB. + - `[LimitMaxMemoryInMb <Int64?>]`: Maximum allowed memory usage in MB. + - `[LimitMaxPercentageCpu <Double?>]`: Maximum allowed CPU usage percentage. + - `[LinuxFxVersion <String>]`: Linux App Framework and version + - `[LoadBalancing <SiteLoadBalancing?>]`: Site load balancing. + - `[LocalMySqlEnabled <Boolean?>]`: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. + - `[LogsDirectorySizeLimit <Int32?>]`: HTTP logs directory size limit. + - `[MachineKeyDecryption <String>]`: Algorithm used for decryption. + - `[MachineKeyDecryptionKey <String>]`: Decryption key. + - `[MachineKeyValidation <String>]`: MachineKey validation. + - `[MachineKeyValidationKey <String>]`: Validation key. + - `[ManagedPipelineMode <ManagedPipelineMode?>]`: Managed pipeline mode. + - `[ManagedServiceIdentityId <Int32?>]`: Managed Service Identity Id + - `[MinTlsVersion <SupportedTlsVersions?>]`: MinTlsVersion: configures the minimum version of TLS required for SSL requests + - `[NetFrameworkVersion <String>]`: .NET Framework version. + - `[NodeVersion <String>]`: Version of Node.js. + - `[NumberOfWorker <Int32?>]`: Number of workers. + - `[PhpVersion <String>]`: Version of PHP. + - `[PowerShellVersion <String>]`: Version of PowerShell. + - `[PreWarmedInstanceCount <Int32?>]`: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans + - `[PublishingUsername <String>]`: Publishing user name. + - `[PushKind <String>]`: Kind of resource. + - `[PythonVersion <String>]`: Version of Python. + - `[RemoteDebuggingEnabled <Boolean?>]`: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. + - `[RemoteDebuggingVersion <String>]`: Remote debugging version. + - `[RequestCount <Int32?>]`: Request Count. + - `[RequestTimeInterval <String>]`: Time interval. + - `[RequestTracingEnabled <Boolean?>]`: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. + - `[RequestTracingExpirationTime <DateTime?>]`: Request tracing expiration time. + - `[ScmIPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for scm. + - `[ScmIPSecurityRestrictionsUseMain <Boolean?>]`: IP security restrictions for scm to use main. + - `[ScmType <ScmType?>]`: SCM type. + - `[SlowRequestCount <Int32?>]`: Request Count. + - `[SlowRequestTimeInterval <String>]`: Time interval. + - `[SlowRequestTimeTaken <String>]`: Time taken. + - `[TagWhitelistJson <String>]`: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. + - `[TagsRequiringAuth <String>]`: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. + - `[TracingOption <String>]`: Tracing options. + - `[TriggerPrivateBytesInKb <Int32?>]`: A rule based on private bytes. + - `[TriggerStatusCode <IStatusCodesBasedTrigger[]>]`: A rule based on status codes. + - `[Count <Int32?>]`: Request Count. + - `[Status <Int32?>]`: HTTP status code. + - `[SubStatus <Int32?>]`: Request Sub Status. + - `[TimeInterval <String>]`: Time interval. + - `[Win32Status <Int32?>]`: Win32 error code. + - `[Use32BitWorkerProcess <Boolean?>]`: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. + - `[VirtualApplication <IVirtualApplication[]>]`: Virtual applications. + - `[PhysicalPath <String>]`: Physical path. + - `[PreloadEnabled <Boolean?>]`: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. + - `[VirtualDirectory <IVirtualDirectory[]>]`: Virtual directories for virtual application. + - `[PhysicalPath <String>]`: Physical path. + - `[VirtualPath <String>]`: Path to virtual application. + - `[VirtualPath <String>]`: Virtual path. + - `[VnetName <String>]`: Virtual Network name. + - `[WebSocketsEnabled <Boolean?>]`: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. + - `[WindowsFxVersion <String>]`: Xenon App Framework and version + - `[XManagedServiceIdentityId <Int32?>]`: Explicit Managed Service Identity Id + - `[ContainerSize <Int32?>]`: Size of the function container. + - `[DailyMemoryTimeQuota <Int32?>]`: Maximum allowed daily memory-time quota (applicable on dynamic apps only). + - `[Enabled <Boolean?>]`: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). + - `[HostNameSslState <IHostNameSslState[]>]`: Hostname SSL states are used to manage the SSL bindings for app's hostnames. + - `[HostType <HostType?>]`: Indicates whether the hostname is a standard or repository hostname. + - `[Name <String>]`: Hostname. + - `[SslState <SslState?>]`: SSL type. + - `[Thumbprint <String>]`: SSL certificate thumbprint. + - `[ToUpdate <Boolean?>]`: Set to <code>true</code> to update existing hostname. + - `[VirtualIP <String>]`: Virtual IP address assigned to the hostname if IP based SSL is enabled. + - `[HostNamesDisabled <Boolean?>]`: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. + - `[HostingEnvironmentProfileId <String>]`: Resource ID of the App Service Environment. + - `[HttpsOnly <Boolean?>]`: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests + - `[HyperV <Boolean?>]`: Hyper-V sandbox. + - `[IdentityType <ManagedServiceIdentityType?>]`: Type of managed service identity. + - `[IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]`: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} + - `[(Any) <IComponents1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties>]`: This indicates any property can be added to this object. + - `[IsXenon <Boolean?>]`: Obsolete: Hyper-V sandbox. + - `[RedundancyMode <RedundancyMode?>]`: Site redundancy mode + - `[Reserved <Boolean?>]`: <code>true</code> if reserved; otherwise, <code>false</code>. + - `[ScmSiteAlsoStopped <Boolean?>]`: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. + - `[ServerFarmId <String>]`: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/Update-AzFunctionApp.md b/azps-10.1.0/Az.Functions/Update-AzFunctionApp.md new file mode 100644 index 0000000000..089ab14510 --- /dev/null +++ b/azps-10.1.0/Az.Functions/Update-AzFunctionApp.md @@ -0,0 +1,496 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/update-azfunctionapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Update-AzFunctionApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Update-AzFunctionApp.md +--- + +# Update-AzFunctionApp + +## SYNOPSIS +Updates a function app. + +## SYNTAX + +### ByName (Default) +``` +Update-AzFunctionApp -Name <String> -ResourceGroupName <String> [-ApplicationInsightsKey <String>] + [-ApplicationInsightsName <String>] [-Force] [-IdentityID <String[]>] + [-IdentityType <ManagedServiceIdentityType>] [-PlanName <String>] [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ByObjectInput +``` +Update-AzFunctionApp -InputObject <ISite> [-ApplicationInsightsKey <String>] + [-ApplicationInsightsName <String>] [-Force] [-IdentityID <String[]>] + [-IdentityType <ManagedServiceIdentityType>] [-PlanName <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a function app. + +## EXAMPLES + +### Example 1: Update function app hosting plan. +```powershell +Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -PlanName NewPlanName -Force +``` + +This command updates function app hosting plan. + +### Example 2: Set a SystemAssigned managed identity for a function app. +```powershell +Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -IdentityType SystemAssigned -Force +``` + +This command sets a SystemAssigned managed identity for a function app. + +### Example 3: Update function app Application Insights. +```powershell +Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -ApplicationInsightsName ApplicationInsightsProjectName -Force +``` + +This command updates function app Application Insights. + +### Example 3: Remove managed identity from a function app. +```powershell +Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -IdentityType None -Force +``` + +This command removes a managed identity from a function app. + +## PARAMETERS + +### -ApplicationInsightsKey +Instrumentation key of App Insights to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppInsightsKey + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationInsightsName +Name of the existing App Insights project to be added to the function app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppInsightsName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Runs the cmdlet as a background job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the cmdlet to update the function app without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityID +Specifies the list of user identities associated with the function app. + The user identity references will be ARM resource ids in the form: + '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Specifies the type of identity used for the function app. + The type 'None' will remove any identities from the function app. +The acceptable values for this parameter are: + - SystemAssigned + - UserAssigned + - None + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Functions.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite +Parameter Sets: ByObjectInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the function app. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Starts the operation and returns immediately, before the operation is completed. +In order to determine if the operation has successfully been completed, use some other mechanism. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanName +The name of the service plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite + +## 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 <ISite>`: + - `Location <String>`: Resource Location. + - `[Kind <String>]`: Kind of resource. + - `[Tag <IResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[ClientAffinityEnabled <Boolean?>]`: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. + - `[ClientCertEnabled <Boolean?>]`: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. + - `[ClientCertExclusionPath <String>]`: client certificate authentication comma-separated exclusion paths + - `[CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]`: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[CloningInfoCloneCustomHostName <Boolean?>]`: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. + - `[CloningInfoCloneSourceControl <Boolean?>]`: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. + - `[CloningInfoConfigureLoadBalancing <Boolean?>]`: <code>true</code> to configure load balancing for source and destination app. + - `[CloningInfoCorrelationId <String>]`: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. + - `[CloningInfoHostingEnvironment <String>]`: App Service Environment. + - `[CloningInfoOverwrite <Boolean?>]`: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. + - `[CloningInfoSourceWebAppId <String>]`: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. + - `[CloningInfoSourceWebAppLocation <String>]`: Location of source app ex: West US or North Europe + - `[CloningInfoTrafficManagerProfileId <String>]`: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. + - `[CloningInfoTrafficManagerProfileName <String>]`: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. + - `[Config <ISiteConfig>]`: Configuration of the app. + - `[AcrUseManagedIdentityCred <Boolean?>]`: Flag to use Managed Identity Creds for ACR pull + - `[AcrUserManagedIdentityId <String>]`: If using user managed identity, the user managed identity ClientId + - `[ActionMinProcessExecutionTime <String>]`: Minimum time the process must execute before taking the action + - `[ActionType <AutoHealActionType?>]`: Predefined action to be taken. + - `[AlwaysOn <Boolean?>]`: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. + - `[ApiDefinitionUrl <String>]`: The URL of the API definition. + - `[ApiManagementConfigId <String>]`: APIM-Api Identifier. + - `[AppCommandLine <String>]`: App command line to launch. + - `[AppSetting <INameValuePair[]>]`: Application settings. + - `[Name <String>]`: Pair name. + - `[Value <String>]`: Pair value. + - `[AutoHealEnabled <Boolean?>]`: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. + - `[AutoSwapSlotName <String>]`: Auto-swap slot name. + - `[ConnectionString <IConnStringInfo[]>]`: Connection strings. + - `[ConnectionString <String>]`: Connection string value. + - `[Name <String>]`: Name of connection string. + - `[Type <ConnectionStringType?>]`: Type of database. + - `[CorAllowedOrigin <String[]>]`: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. + - `[CorSupportCredentials <Boolean?>]`: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. + - `[CustomActionExe <String>]`: Executable to be run. + - `[CustomActionParameter <String>]`: Parameters for the executable. + - `[DefaultDocument <String[]>]`: Default documents. + - `[DetailedErrorLoggingEnabled <Boolean?>]`: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. + - `[DocumentRoot <String>]`: Document root. + - `[DynamicTagsJson <String>]`: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. + - `[ExperimentRampUpRule <IRampUpRule[]>]`: List of ramp-up rules. + - `[ActionHostName <String>]`: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. + - `[ChangeDecisionCallbackUrl <String>]`: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ + - `[ChangeIntervalInMinute <Int32?>]`: Specifies interval in minutes to reevaluate ReroutePercentage. + - `[ChangeStep <Double?>]`: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. + - `[MaxReroutePercentage <Double?>]`: Specifies upper boundary below which ReroutePercentage will stay. + - `[MinReroutePercentage <Double?>]`: Specifies lower boundary above which ReroutePercentage will stay. + - `[Name <String>]`: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. + - `[ReroutePercentage <Double?>]`: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. + - `[FtpsState <FtpsState?>]`: State of FTP / FTPS service + - `[HandlerMapping <IHandlerMapping[]>]`: Handler mappings. + - `[Argument <String>]`: Command-line arguments to be passed to the script processor. + - `[Extension <String>]`: Requests with this extension will be handled using the specified FastCGI application. + - `[ScriptProcessor <String>]`: The absolute path to the FastCGI application. + - `[HealthCheckPath <String>]`: Health check path + - `[Http20Enabled <Boolean?>]`: Http20Enabled: configures a web site to allow clients to connect over http2.0 + - `[HttpLoggingEnabled <Boolean?>]`: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. + - `[IPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for main. + - `[Action <String>]`: Allow or Deny access for this IP range. + - `[Description <String>]`: IP restriction rule description. + - `[IPAddress <String>]`: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. + - `[Name <String>]`: IP restriction rule name. + - `[Priority <Int32?>]`: Priority of IP restriction rule. + - `[SubnetMask <String>]`: Subnet mask for the range of IP addresses the restriction is valid for. + - `[SubnetTrafficTag <Int32?>]`: (internal) Subnet traffic tag + - `[Tag <IPFilterTag?>]`: Defines what this IP filter will be used for. This is to support IP filtering on proxies. + - `[VnetSubnetResourceId <String>]`: Virtual network resource id + - `[VnetTrafficTag <Int32?>]`: (internal) Vnet traffic tag + - `[IsPushEnabled <Boolean?>]`: Gets or sets a flag indicating whether the Push endpoint is enabled. + - `[JavaContainer <String>]`: Java container. + - `[JavaContainerVersion <String>]`: Java container version. + - `[JavaVersion <String>]`: Java version. + - `[LimitMaxDiskSizeInMb <Int64?>]`: Maximum allowed disk size usage in MB. + - `[LimitMaxMemoryInMb <Int64?>]`: Maximum allowed memory usage in MB. + - `[LimitMaxPercentageCpu <Double?>]`: Maximum allowed CPU usage percentage. + - `[LinuxFxVersion <String>]`: Linux App Framework and version + - `[LoadBalancing <SiteLoadBalancing?>]`: Site load balancing. + - `[LocalMySqlEnabled <Boolean?>]`: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. + - `[LogsDirectorySizeLimit <Int32?>]`: HTTP logs directory size limit. + - `[MachineKeyDecryption <String>]`: Algorithm used for decryption. + - `[MachineKeyDecryptionKey <String>]`: Decryption key. + - `[MachineKeyValidation <String>]`: MachineKey validation. + - `[MachineKeyValidationKey <String>]`: Validation key. + - `[ManagedPipelineMode <ManagedPipelineMode?>]`: Managed pipeline mode. + - `[ManagedServiceIdentityId <Int32?>]`: Managed Service Identity Id + - `[MinTlsVersion <SupportedTlsVersions?>]`: MinTlsVersion: configures the minimum version of TLS required for SSL requests + - `[NetFrameworkVersion <String>]`: .NET Framework version. + - `[NodeVersion <String>]`: Version of Node.js. + - `[NumberOfWorker <Int32?>]`: Number of workers. + - `[PhpVersion <String>]`: Version of PHP. + - `[PowerShellVersion <String>]`: Version of PowerShell. + - `[PreWarmedInstanceCount <Int32?>]`: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans + - `[PublishingUsername <String>]`: Publishing user name. + - `[PushKind <String>]`: Kind of resource. + - `[PythonVersion <String>]`: Version of Python. + - `[RemoteDebuggingEnabled <Boolean?>]`: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. + - `[RemoteDebuggingVersion <String>]`: Remote debugging version. + - `[RequestCount <Int32?>]`: Request Count. + - `[RequestTimeInterval <String>]`: Time interval. + - `[RequestTracingEnabled <Boolean?>]`: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. + - `[RequestTracingExpirationTime <DateTime?>]`: Request tracing expiration time. + - `[ScmIPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for scm. + - `[ScmIPSecurityRestrictionsUseMain <Boolean?>]`: IP security restrictions for scm to use main. + - `[ScmType <ScmType?>]`: SCM type. + - `[SlowRequestCount <Int32?>]`: Request Count. + - `[SlowRequestTimeInterval <String>]`: Time interval. + - `[SlowRequestTimeTaken <String>]`: Time taken. + - `[TagWhitelistJson <String>]`: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. + - `[TagsRequiringAuth <String>]`: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. + - `[TracingOption <String>]`: Tracing options. + - `[TriggerPrivateBytesInKb <Int32?>]`: A rule based on private bytes. + - `[TriggerStatusCode <IStatusCodesBasedTrigger[]>]`: A rule based on status codes. + - `[Count <Int32?>]`: Request Count. + - `[Status <Int32?>]`: HTTP status code. + - `[SubStatus <Int32?>]`: Request Sub Status. + - `[TimeInterval <String>]`: Time interval. + - `[Win32Status <Int32?>]`: Win32 error code. + - `[Use32BitWorkerProcess <Boolean?>]`: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. + - `[VirtualApplication <IVirtualApplication[]>]`: Virtual applications. + - `[PhysicalPath <String>]`: Physical path. + - `[PreloadEnabled <Boolean?>]`: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. + - `[VirtualDirectory <IVirtualDirectory[]>]`: Virtual directories for virtual application. + - `[PhysicalPath <String>]`: Physical path. + - `[VirtualPath <String>]`: Path to virtual application. + - `[VirtualPath <String>]`: Virtual path. + - `[VnetName <String>]`: Virtual Network name. + - `[WebSocketsEnabled <Boolean?>]`: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. + - `[WindowsFxVersion <String>]`: Xenon App Framework and version + - `[XManagedServiceIdentityId <Int32?>]`: Explicit Managed Service Identity Id + - `[ContainerSize <Int32?>]`: Size of the function container. + - `[DailyMemoryTimeQuota <Int32?>]`: Maximum allowed daily memory-time quota (applicable on dynamic apps only). + - `[Enabled <Boolean?>]`: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). + - `[HostNameSslState <IHostNameSslState[]>]`: Hostname SSL states are used to manage the SSL bindings for app's hostnames. + - `[HostType <HostType?>]`: Indicates whether the hostname is a standard or repository hostname. + - `[Name <String>]`: Hostname. + - `[SslState <SslState?>]`: SSL type. + - `[Thumbprint <String>]`: SSL certificate thumbprint. + - `[ToUpdate <Boolean?>]`: Set to <code>true</code> to update existing hostname. + - `[VirtualIP <String>]`: Virtual IP address assigned to the hostname if IP based SSL is enabled. + - `[HostNamesDisabled <Boolean?>]`: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. + - `[HostingEnvironmentProfileId <String>]`: Resource ID of the App Service Environment. + - `[HttpsOnly <Boolean?>]`: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests + - `[HyperV <Boolean?>]`: Hyper-V sandbox. + - `[IdentityType <ManagedServiceIdentityType?>]`: Type of managed service identity. + - `[IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]`: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} + - `[(Any) <IComponents1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties>]`: This indicates any property can be added to this object. + - `[IsXenon <Boolean?>]`: Obsolete: Hyper-V sandbox. + - `[RedundancyMode <RedundancyMode?>]`: Site redundancy mode + - `[Reserved <Boolean?>]`: <code>true</code> if reserved; otherwise, <code>false</code>. + - `[ScmSiteAlsoStopped <Boolean?>]`: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. + - `[ServerFarmId <String>]`: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/Update-AzFunctionAppPlan.md b/azps-10.1.0/Az.Functions/Update-AzFunctionAppPlan.md new file mode 100644 index 0000000000..eefd5d715b --- /dev/null +++ b/azps-10.1.0/Az.Functions/Update-AzFunctionAppPlan.md @@ -0,0 +1,314 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/update-azfunctionappplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Update-AzFunctionAppPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Update-AzFunctionAppPlan.md +--- + +# Update-AzFunctionAppPlan + +## SYNOPSIS +Updates a function app service plan. + +## SYNTAX + +### ByName (Default) +``` +Update-AzFunctionAppPlan -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Force] + [-MaximumWorkerCount <Int32>] [-MinimumWorkerCount <Int32>] [-Sku <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ByObjectInput +``` +Update-AzFunctionAppPlan -InputObject <IAppServicePlan> [-Force] [-MaximumWorkerCount <Int32>] + [-MinimumWorkerCount <Int32>] [-Sku <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a function app service plan. + +## EXAMPLES + +### Example 1: Update an app service plan to EP2 sku with twenty maximum workers. +```powershell +Update-AzFunctionAppPlan -ResourceGroupName MyResourceGroupName ` + -Name MyPremiumPlan ` + -MaximumWorkerCount 20 ` + -Sku EP2 ` + -Force +``` + +This command updates an app service plan to EP2 sku with twenty maximum workers. + +## PARAMETERS + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the cmdlet to update the function app plan without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IAppServicePlan +Parameter Sets: ByObjectInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaximumWorkerCount +The maximum number of workers for the app service plan. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: MaxBurst + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumWorkerCount +The minimum number of workers for the app service plan. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: MinInstances + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the App Service plan. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The plan sku. +Valid inputs are: EP1, EP2, EP3 + +```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 Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IAppServicePlan + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IAppServicePlan + +## 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 <IAppServicePlan>`: + - `Location <String>`: Resource Location. + - `[Kind <String>]`: Kind of resource. + - `[Tag <IResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[Capacity <Int32?>]`: Current number of instances assigned to the resource. + - `[FreeOfferExpirationTime <DateTime?>]`: The time when the server farm free offer expires. + - `[HostingEnvironmentProfileId <String>]`: Resource ID of the App Service Environment. + - `[HyperV <Boolean?>]`: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. + - `[IsSpot <Boolean?>]`: If <code>true</code>, this App Service Plan owns spot instances. + - `[IsXenon <Boolean?>]`: Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. + - `[MaximumElasticWorkerCount <Int32?>]`: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan + - `[PerSiteScaling <Boolean?>]`: If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan. + - `[Reserved <Boolean?>]`: If Linux app service plan <code>true</code>, <code>false</code> otherwise. + - `[SkuCapability <ICapability[]>]`: Capabilities of the SKU, e.g., is traffic manager enabled? + - `[Name <String>]`: Name of the SKU capability. + - `[Reason <String>]`: Reason of the SKU capability. + - `[Value <String>]`: Value of the SKU capability. + - `[SkuCapacityDefault <Int32?>]`: Default number of workers for this App Service plan SKU. + - `[SkuCapacityMaximum <Int32?>]`: Maximum number of workers for this App Service plan SKU. + - `[SkuCapacityMinimum <Int32?>]`: Minimum number of workers for this App Service plan SKU. + - `[SkuCapacityScaleType <String>]`: Available scale configurations for an App Service plan. + - `[SkuFamily <String>]`: Family code of the resource SKU. + - `[SkuLocation <String[]>]`: Locations of the SKU. + - `[SkuName <String>]`: Name of the resource SKU. + - `[SkuSize <String>]`: Size specifier of the resource SKU. + - `[SkuTier <String>]`: Service tier of the resource SKU. + - `[SpotExpirationTime <DateTime?>]`: The time when the server farm expires. Valid only if it is a spot server farm. + - `[TargetWorkerCount <Int32?>]`: Scaling worker count. + - `[TargetWorkerSizeId <Int32?>]`: Scaling worker size ID. + - `[WorkerTierName <String>]`: Target worker tier assigned to the App Service plan. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Functions/Update-AzFunctionAppSetting.md b/azps-10.1.0/Az.Functions/Update-AzFunctionAppSetting.md new file mode 100644 index 0000000000..9bf160393b --- /dev/null +++ b/azps-10.1.0/Az.Functions/Update-AzFunctionAppSetting.md @@ -0,0 +1,359 @@ +--- +external help file: +Module Name: Az.Functions +online version: https://learn.microsoft.com/powershell/module/az.functions/update-azfunctionappsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Update-AzFunctionAppSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Functions/help/Update-AzFunctionAppSetting.md +--- + +# Update-AzFunctionAppSetting + +## SYNOPSIS +Adds or updates app settings in a function app. + +## SYNTAX + +### ByName (Default) +``` +Update-AzFunctionAppSetting -Name <String> -ResourceGroupName <String> -AppSetting <Hashtable> + [-SubscriptionId <String>] [-Force] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ByObjectInput +``` +Update-AzFunctionAppSetting -AppSetting <Hashtable> -InputObject <ISite> [-Force] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Adds or updates app settings in a function app. + +## EXAMPLES + +### Example 1: Add a new app setting in a function app. +```powershell +Update-AzFunctionAppSetting -Name MyAppName -ResourceGroupName MyResourceGroupName -AppSetting @{"Name1" = "Value1"} +``` + +This command adds a new app setting in a function app. + +## PARAMETERS + +### -AppSetting +Hashtable with keys and values describe the app settings to be added or updated in the function app. +For example: @{"myappsetting"="123"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the cmdlet to update function app setting without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite +Parameter Sets: ByObjectInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the function app. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IStringDictionary + +## 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 <ISite>`: + - `Location <String>`: Resource Location. + - `[Kind <String>]`: Kind of resource. + - `[Tag <IResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[ClientAffinityEnabled <Boolean?>]`: <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. + - `[ClientCertEnabled <Boolean?>]`: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. + - `[ClientCertExclusionPath <String>]`: client certificate authentication comma-separated exclusion paths + - `[CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]`: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[CloningInfoCloneCustomHostName <Boolean?>]`: <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. + - `[CloningInfoCloneSourceControl <Boolean?>]`: <code>true</code> to clone source control from source app; otherwise, <code>false</code>. + - `[CloningInfoConfigureLoadBalancing <Boolean?>]`: <code>true</code> to configure load balancing for source and destination app. + - `[CloningInfoCorrelationId <String>]`: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. + - `[CloningInfoHostingEnvironment <String>]`: App Service Environment. + - `[CloningInfoOverwrite <Boolean?>]`: <code>true</code> to overwrite destination app; otherwise, <code>false</code>. + - `[CloningInfoSourceWebAppId <String>]`: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. + - `[CloningInfoSourceWebAppLocation <String>]`: Location of source app ex: West US or North Europe + - `[CloningInfoTrafficManagerProfileId <String>]`: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. + - `[CloningInfoTrafficManagerProfileName <String>]`: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. + - `[Config <ISiteConfig>]`: Configuration of the app. + - `[AcrUseManagedIdentityCred <Boolean?>]`: Flag to use Managed Identity Creds for ACR pull + - `[AcrUserManagedIdentityId <String>]`: If using user managed identity, the user managed identity ClientId + - `[ActionMinProcessExecutionTime <String>]`: Minimum time the process must execute before taking the action + - `[ActionType <AutoHealActionType?>]`: Predefined action to be taken. + - `[AlwaysOn <Boolean?>]`: <code>true</code> if Always On is enabled; otherwise, <code>false</code>. + - `[ApiDefinitionUrl <String>]`: The URL of the API definition. + - `[ApiManagementConfigId <String>]`: APIM-Api Identifier. + - `[AppCommandLine <String>]`: App command line to launch. + - `[AppSetting <INameValuePair[]>]`: Application settings. + - `[Name <String>]`: Pair name. + - `[Value <String>]`: Pair value. + - `[AutoHealEnabled <Boolean?>]`: <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. + - `[AutoSwapSlotName <String>]`: Auto-swap slot name. + - `[ConnectionString <IConnStringInfo[]>]`: Connection strings. + - `[ConnectionString <String>]`: Connection string value. + - `[Name <String>]`: Name of connection string. + - `[Type <ConnectionStringType?>]`: Type of database. + - `[CorAllowedOrigin <String[]>]`: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. + - `[CorSupportCredentials <Boolean?>]`: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. + - `[CustomActionExe <String>]`: Executable to be run. + - `[CustomActionParameter <String>]`: Parameters for the executable. + - `[DefaultDocument <String[]>]`: Default documents. + - `[DetailedErrorLoggingEnabled <Boolean?>]`: <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. + - `[DocumentRoot <String>]`: Document root. + - `[DynamicTagsJson <String>]`: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. + - `[ExperimentRampUpRule <IRampUpRule[]>]`: List of ramp-up rules. + - `[ActionHostName <String>]`: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. + - `[ChangeDecisionCallbackUrl <String>]`: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ + - `[ChangeIntervalInMinute <Int32?>]`: Specifies interval in minutes to reevaluate ReroutePercentage. + - `[ChangeStep <Double?>]`: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>. + - `[MaxReroutePercentage <Double?>]`: Specifies upper boundary below which ReroutePercentage will stay. + - `[MinReroutePercentage <Double?>]`: Specifies lower boundary above which ReroutePercentage will stay. + - `[Name <String>]`: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. + - `[ReroutePercentage <Double?>]`: Percentage of the traffic which will be redirected to <code>ActionHostName</code>. + - `[FtpsState <FtpsState?>]`: State of FTP / FTPS service + - `[HandlerMapping <IHandlerMapping[]>]`: Handler mappings. + - `[Argument <String>]`: Command-line arguments to be passed to the script processor. + - `[Extension <String>]`: Requests with this extension will be handled using the specified FastCGI application. + - `[ScriptProcessor <String>]`: The absolute path to the FastCGI application. + - `[HealthCheckPath <String>]`: Health check path + - `[Http20Enabled <Boolean?>]`: Http20Enabled: configures a web site to allow clients to connect over http2.0 + - `[HttpLoggingEnabled <Boolean?>]`: <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. + - `[IPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for main. + - `[Action <String>]`: Allow or Deny access for this IP range. + - `[Description <String>]`: IP restriction rule description. + - `[IPAddress <String>]`: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. + - `[Name <String>]`: IP restriction rule name. + - `[Priority <Int32?>]`: Priority of IP restriction rule. + - `[SubnetMask <String>]`: Subnet mask for the range of IP addresses the restriction is valid for. + - `[SubnetTrafficTag <Int32?>]`: (internal) Subnet traffic tag + - `[Tag <IPFilterTag?>]`: Defines what this IP filter will be used for. This is to support IP filtering on proxies. + - `[VnetSubnetResourceId <String>]`: Virtual network resource id + - `[VnetTrafficTag <Int32?>]`: (internal) Vnet traffic tag + - `[IsPushEnabled <Boolean?>]`: Gets or sets a flag indicating whether the Push endpoint is enabled. + - `[JavaContainer <String>]`: Java container. + - `[JavaContainerVersion <String>]`: Java container version. + - `[JavaVersion <String>]`: Java version. + - `[LimitMaxDiskSizeInMb <Int64?>]`: Maximum allowed disk size usage in MB. + - `[LimitMaxMemoryInMb <Int64?>]`: Maximum allowed memory usage in MB. + - `[LimitMaxPercentageCpu <Double?>]`: Maximum allowed CPU usage percentage. + - `[LinuxFxVersion <String>]`: Linux App Framework and version + - `[LoadBalancing <SiteLoadBalancing?>]`: Site load balancing. + - `[LocalMySqlEnabled <Boolean?>]`: <code>true</code> to enable local MySQL; otherwise, <code>false</code>. + - `[LogsDirectorySizeLimit <Int32?>]`: HTTP logs directory size limit. + - `[MachineKeyDecryption <String>]`: Algorithm used for decryption. + - `[MachineKeyDecryptionKey <String>]`: Decryption key. + - `[MachineKeyValidation <String>]`: MachineKey validation. + - `[MachineKeyValidationKey <String>]`: Validation key. + - `[ManagedPipelineMode <ManagedPipelineMode?>]`: Managed pipeline mode. + - `[ManagedServiceIdentityId <Int32?>]`: Managed Service Identity Id + - `[MinTlsVersion <SupportedTlsVersions?>]`: MinTlsVersion: configures the minimum version of TLS required for SSL requests + - `[NetFrameworkVersion <String>]`: .NET Framework version. + - `[NodeVersion <String>]`: Version of Node.js. + - `[NumberOfWorker <Int32?>]`: Number of workers. + - `[PhpVersion <String>]`: Version of PHP. + - `[PowerShellVersion <String>]`: Version of PowerShell. + - `[PreWarmedInstanceCount <Int32?>]`: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans + - `[PublishingUsername <String>]`: Publishing user name. + - `[PushKind <String>]`: Kind of resource. + - `[PythonVersion <String>]`: Version of Python. + - `[RemoteDebuggingEnabled <Boolean?>]`: <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. + - `[RemoteDebuggingVersion <String>]`: Remote debugging version. + - `[RequestCount <Int32?>]`: Request Count. + - `[RequestTimeInterval <String>]`: Time interval. + - `[RequestTracingEnabled <Boolean?>]`: <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. + - `[RequestTracingExpirationTime <DateTime?>]`: Request tracing expiration time. + - `[ScmIPSecurityRestriction <IIPSecurityRestriction[]>]`: IP security restrictions for scm. + - `[ScmIPSecurityRestrictionsUseMain <Boolean?>]`: IP security restrictions for scm to use main. + - `[ScmType <ScmType?>]`: SCM type. + - `[SlowRequestCount <Int32?>]`: Request Count. + - `[SlowRequestTimeInterval <String>]`: Time interval. + - `[SlowRequestTimeTaken <String>]`: Time taken. + - `[TagWhitelistJson <String>]`: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. + - `[TagsRequiringAuth <String>]`: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. + - `[TracingOption <String>]`: Tracing options. + - `[TriggerPrivateBytesInKb <Int32?>]`: A rule based on private bytes. + - `[TriggerStatusCode <IStatusCodesBasedTrigger[]>]`: A rule based on status codes. + - `[Count <Int32?>]`: Request Count. + - `[Status <Int32?>]`: HTTP status code. + - `[SubStatus <Int32?>]`: Request Sub Status. + - `[TimeInterval <String>]`: Time interval. + - `[Win32Status <Int32?>]`: Win32 error code. + - `[Use32BitWorkerProcess <Boolean?>]`: <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. + - `[VirtualApplication <IVirtualApplication[]>]`: Virtual applications. + - `[PhysicalPath <String>]`: Physical path. + - `[PreloadEnabled <Boolean?>]`: <code>true</code> if preloading is enabled; otherwise, <code>false</code>. + - `[VirtualDirectory <IVirtualDirectory[]>]`: Virtual directories for virtual application. + - `[PhysicalPath <String>]`: Physical path. + - `[VirtualPath <String>]`: Path to virtual application. + - `[VirtualPath <String>]`: Virtual path. + - `[VnetName <String>]`: Virtual Network name. + - `[WebSocketsEnabled <Boolean?>]`: <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. + - `[WindowsFxVersion <String>]`: Xenon App Framework and version + - `[XManagedServiceIdentityId <Int32?>]`: Explicit Managed Service Identity Id + - `[ContainerSize <Int32?>]`: Size of the function container. + - `[DailyMemoryTimeQuota <Int32?>]`: Maximum allowed daily memory-time quota (applicable on dynamic apps only). + - `[Enabled <Boolean?>]`: <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). + - `[HostNameSslState <IHostNameSslState[]>]`: Hostname SSL states are used to manage the SSL bindings for app's hostnames. + - `[HostType <HostType?>]`: Indicates whether the hostname is a standard or repository hostname. + - `[Name <String>]`: Hostname. + - `[SslState <SslState?>]`: SSL type. + - `[Thumbprint <String>]`: SSL certificate thumbprint. + - `[ToUpdate <Boolean?>]`: Set to <code>true</code> to update existing hostname. + - `[VirtualIP <String>]`: Virtual IP address assigned to the hostname if IP based SSL is enabled. + - `[HostNamesDisabled <Boolean?>]`: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. + - `[HostingEnvironmentProfileId <String>]`: Resource ID of the App Service Environment. + - `[HttpsOnly <Boolean?>]`: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests + - `[HyperV <Boolean?>]`: Hyper-V sandbox. + - `[IdentityType <ManagedServiceIdentityType?>]`: Type of managed service identity. + - `[IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]`: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} + - `[(Any) <IComponents1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties>]`: This indicates any property can be added to this object. + - `[IsXenon <Boolean?>]`: Obsolete: Hyper-V sandbox. + - `[RedundancyMode <RedundancyMode?>]`: Site redundancy mode + - `[Reserved <Boolean?>]`: <code>true</code> if reserved; otherwise, <code>false</code>. + - `[ScmSiteAlsoStopped <Boolean?>]`: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. + - `[ServerFarmId <String>]`: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.GuestConfiguration/Az.GuestConfiguration.md b/azps-10.1.0/Az.GuestConfiguration/Az.GuestConfiguration.md new file mode 100644 index 0000000000..d90e8c7323 --- /dev/null +++ b/azps-10.1.0/Az.GuestConfiguration/Az.GuestConfiguration.md @@ -0,0 +1,27 @@ +--- +Module Name: Az.GuestConfiguration +Module Guid: f2042330-dd50-496f-aac0-69f27fd54f2a +Download Help Link: https://learn.microsoft.com/powershell/module/az.guestconfiguration +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/GuestConfiguration/help/Az.GuestConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/GuestConfiguration/help/Az.GuestConfiguration.md +--- + +# Az.GuestConfiguration Module +## Description +Microsoft Azure PowerShell: GuestConfiguration cmdlets + +## Az.GuestConfiguration Cmdlets +### [Get-AzGuestConfigurationAssignment](Get-AzGuestConfigurationAssignment.md) +Get information about a guest configuration assignment + +### [Get-AzGuestConfigurationAssignmentReport](Get-AzGuestConfigurationAssignmentReport.md) +Get a report for the guest configuration assignment, by reportId. + +### [New-AzGuestConfigurationAssignment](New-AzGuestConfigurationAssignment.md) +Creates an association between a VM and guest configuration + +### [Remove-AzGuestConfigurationAssignment](Remove-AzGuestConfigurationAssignment.md) +Delete a guest configuration assignment + diff --git a/azps-10.1.0/Az.GuestConfiguration/Get-AzGuestConfigurationAssignment.md b/azps-10.1.0/Az.GuestConfiguration/Get-AzGuestConfigurationAssignment.md new file mode 100644 index 0000000000..d259940548 --- /dev/null +++ b/azps-10.1.0/Az.GuestConfiguration/Get-AzGuestConfigurationAssignment.md @@ -0,0 +1,287 @@ +--- +external help file: +Module Name: Az.GuestConfiguration +online version: https://learn.microsoft.com/powershell/module/az.guestconfiguration/get-azguestconfigurationassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/GuestConfiguration/help/Get-AzGuestConfigurationAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/GuestConfiguration/help/Get-AzGuestConfigurationAssignment.md +--- + +# Get-AzGuestConfigurationAssignment + +## SYNOPSIS +Get information about a guest configuration assignment + +## SYNTAX + +### List (Default) +``` +Get-AzGuestConfigurationAssignment [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-PassThru] + [<CommonParameters>] +``` + +### Get +``` +Get-AzGuestConfigurationAssignment -Name <String> -ResourceGroupName <String> -VMName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get1 +``` +Get-AzGuestConfigurationAssignment -MachineName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get2 +``` +Get-AzGuestConfigurationAssignment -Name <String> -ResourceGroupName <String> -VmssName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzGuestConfigurationAssignment -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### List2 +``` +Get-AzGuestConfigurationAssignment -ResourceGroupName <String> -VMName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List3 +``` +Get-AzGuestConfigurationAssignment -MachineName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List4 +``` +Get-AzGuestConfigurationAssignment -ResourceGroupName <String> -VmssName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get information about a guest configuration assignment + +## EXAMPLES + +### Example 1: Get a specific guest configuration assignment +```powershell +Get-AzGuestConfigurationAssignment -ResourceGroupName test-rg -VMName test-vm -GuestConfigurationAssignmentName test-assignment +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westcentralus test-assignment test-rg +``` + +Get a specific guest configuration assignment + +### Example 2: List guest configuration assignments for a VM +```powershell +Get-AzGuestConfigurationAssignment -ResourceGroupName test-rg -VMName test-vm +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westcentralus test-assignment test-rg +``` + +List guest configuration assignments for a VM + +### Example 3: List guest configuration assignments for a VMSS +```powershell +Get-AzGuestConfigurationAssignment -ResourceGroupName test-rg -VmssName test-vmss +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westcentralus test-assignment test-rg +``` + +List guest configuration assignments for a VMSS + +### Example 4: List guest configuration assignments for a ARC machine +```powershell +Get-AzGuestConfigurationAssignment -ResourceGroupName test-rg -MachineName test-machine +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westcentralus test-assignment test-rg +``` + +List guest configuration assignments for a ARC machine + +### Example 5: List guest configuration assignments for a resource group +```powershell +Get-AzGuestConfigurationAssignment -ResourceGroupName test-rg +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westcentralus test-assignment1 test-rg +westcentralus test-assignment2 test-rg +``` + +List guest configuration assignments for a resource group + +### Example 6: List guest configuration assignments for a subscription +```powershell +Get-AzGuestConfigurationAssignment -SubscriptionId xxxxx-xxxx-xxxxx-xxx +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westcentralus test-assignment1 test-rg +westcentralus test-assignment2 test-rg +``` + +List guest configuration assignments for a subscription + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineName +The name of the ARC machine. + +```yaml +Type: System.String +Parameter Sets: Get1, List3 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The guest configuration assignment name. + +```yaml +Type: System.String +Parameter Sets: Get, Get1, Get2 +Aliases: GuestConfigurationAssignmentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: Get, Get1, Get2, List1, List2, List3, List4 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName +The name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: Get, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmssName +The name of the virtual machine scale set. + +```yaml +Type: System.String +Parameter Sets: Get2, List4 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.Api20220125.IGuestConfigurationAssignment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.GuestConfiguration/Get-AzGuestConfigurationAssignmentReport.md b/azps-10.1.0/Az.GuestConfiguration/Get-AzGuestConfigurationAssignmentReport.md new file mode 100644 index 0000000000..2cbc8dd478 --- /dev/null +++ b/azps-10.1.0/Az.GuestConfiguration/Get-AzGuestConfigurationAssignmentReport.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.GuestConfiguration +online version: https://learn.microsoft.com/powershell/module/az.guestconfiguration/get-azguestconfigurationassignmentreport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/GuestConfiguration/help/Get-AzGuestConfigurationAssignmentReport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/GuestConfiguration/help/Get-AzGuestConfigurationAssignmentReport.md +--- + +# Get-AzGuestConfigurationAssignmentReport + +## SYNOPSIS +Get a report for the guest configuration assignment, by reportId. + +## SYNTAX + +### List (Default) +``` +Get-AzGuestConfigurationAssignmentReport -GuestConfigurationAssignmentName <String> + -ResourceGroupName <String> -VMName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzGuestConfigurationAssignmentReport -GuestConfigurationAssignmentName <String> -ReportId <String> + -ResourceGroupName <String> -VMName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get1 +``` +Get-AzGuestConfigurationAssignmentReport -GuestConfigurationAssignmentName <String> -MachineName <String> + -ReportId <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get2 +``` +Get-AzGuestConfigurationAssignmentReport -Name <String> -ReportId <String> -ResourceGroupName <String> + -VmssName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzGuestConfigurationAssignmentReport -GuestConfigurationAssignmentName <String> -MachineName <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List2 +``` +Get-AzGuestConfigurationAssignmentReport -Name <String> -ResourceGroupName <String> -VmssName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a report for the guest configuration assignment, by reportId. + +## EXAMPLES + +### Example 1: Get a report by ReportId for a guest configuration assignment +```powershell +Get-AzGuestConfigurationAssignmentReport -GuestConfigurationAssignmentName test-assignment -ResourceGroupName test-rg -VMName test-vm -ReportId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/test-vm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/test-assignment/reports/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +Get a report by ReportId for a guest configuration assignment + +### Example 2: List reports for a guest configuration assignment +```powershell +Get-AzGuestConfigurationAssignmentReport -GuestConfigurationAssignmentName test-assignment -ResourceGroupName test-rg -VMName test-vm +``` + +List reports for a guest configuration assignment + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestConfigurationAssignmentName +The guest configuration assignment name. + +```yaml +Type: System.String +Parameter Sets: Get, Get1, List, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineName +The name of the ARC machine. + +```yaml +Type: System.String +Parameter Sets: Get1, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The guest configuration assignment name. + +```yaml +Type: System.String +Parameter Sets: Get2, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportId +The GUID for the guest configuration assignment report. + +```yaml +Type: System.String +Parameter Sets: Get, Get1, Get2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName +The name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmssName +The name of the virtual machine scale set. + +```yaml +Type: System.String +Parameter Sets: Get2, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.Api20220125.IGuestConfigurationAssignmentReport + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.GuestConfiguration/New-AzGuestConfigurationAssignment.md b/azps-10.1.0/Az.GuestConfiguration/New-AzGuestConfigurationAssignment.md new file mode 100644 index 0000000000..265771aab0 --- /dev/null +++ b/azps-10.1.0/Az.GuestConfiguration/New-AzGuestConfigurationAssignment.md @@ -0,0 +1,394 @@ +--- +external help file: +Module Name: Az.GuestConfiguration +online version: https://learn.microsoft.com/powershell/module/az.guestconfiguration/new-azguestconfigurationassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/GuestConfiguration/help/New-AzGuestConfigurationAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/GuestConfiguration/help/New-AzGuestConfigurationAssignment.md +--- + +# New-AzGuestConfigurationAssignment + +## SYNOPSIS +Creates an association between a VM and guest configuration + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzGuestConfigurationAssignment -GuestConfigurationAssignmentName <String> -ResourceGroupName <String> + -VMName <String> -GuestConfigurationContentHash <String> -GuestConfigurationContentUri <String> + -GuestConfigurationName <String> -GuestConfigurationVersion <String> [-SubscriptionId <String>] + [-Context <String>] [-GuestConfigurationAssignmentType <AssignmentType>] [-GuestConfigurationKind <Kind>] + [-GuestConfigurationParameter <IConfigurationParameter[]>] + [-GuestConfigurationProtectedParameter <IConfigurationParameter[]>] [-Location <String>] [-Name <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateExpanded1 +``` +New-AzGuestConfigurationAssignment -GuestConfigurationAssignmentName <String> -MachineName <String> + -ResourceGroupName <String> -GuestConfigurationContentHash <String> -GuestConfigurationContentUri <String> + -GuestConfigurationName <String> -GuestConfigurationVersion <String> [-SubscriptionId <String>] + [-Context <String>] [-GuestConfigurationAssignmentType <AssignmentType>] [-GuestConfigurationKind <Kind>] + [-GuestConfigurationParameter <IConfigurationParameter[]>] + [-GuestConfigurationProtectedParameter <IConfigurationParameter[]>] [-Location <String>] [-Name <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an association between a VM and guest configuration + +## EXAMPLES + +### Example 1: Create an association between a VM and guest configuration +```powershell +New-AzGuestConfigurationAssignment -GuestConfigurationAssignmentName test-assignment -ResourceGroupName test-rg -VMName test-vm -GuestConfigurationName test-config -GuestConfigurationVersion "1.0.0.3" -GuestConfigurationContentUri "https://thisisfake/package" -GuestConfigurationContentHash "123contenthash" +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westcentralus test-assignment test-rg +``` + +Create an association between a VM and guest configuration + +### Example 2: Create an association between a ARC machine and guest configuration +```powershell +New-AzGuestConfigurationAssignment -GuestConfigurationAssignmentName test-assignment -ResourceGroupName test-rg -MachineName test-machine -GuestConfigurationName test-config -GuestConfigurationVersion "1.0.0.3" -GuestConfigurationContentUri "https://thisisfake/package" -GuestConfigurationContentHash "123contenthash" +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westcentralus test-assignment test-rg +``` + +Create an association between a ARC machine and guest configuration + +## PARAMETERS + +### -Context +The source which initiated the guest configuration assignment. +Ex: Azure Policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestConfigurationAssignmentName +Name of the guest configuration assignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestConfigurationAssignmentType +Specifies the assignment type and execution of the configuration. +Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Support.AssignmentType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestConfigurationContentHash +Combined hash of the guest configuration package and configuration parameters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestConfigurationContentUri +Uri of the storage where guest configuration package is uploaded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestConfigurationKind +Kind of the guest configuration. +For example:DSC + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestConfigurationName +Name of the guest configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestConfigurationParameter +The configuration parameters for the guest configuration. +To construct, see NOTES section for GUESTCONFIGURATIONPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.Api20220125.IConfigurationParameter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestConfigurationProtectedParameter +The protected configuration parameters for the guest configuration. +To construct, see NOTES section for GUESTCONFIGURATIONPROTECTEDPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.Api20220125.IConfigurationParameter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestConfigurationVersion +Version of the guest configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Region where the VM is located. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineName +The name of the ARC machine. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the guest configuration assignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName +The name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.Api20220125.IGuestConfigurationAssignment + +## 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. + + +GUESTCONFIGURATIONPARAMETER <IConfigurationParameter[]>: The configuration parameters for the guest configuration. + - `[Name <String>]`: Name of the configuration parameter. + - `[Value <String>]`: Value of the configuration parameter. + +GUESTCONFIGURATIONPROTECTEDPARAMETER <IConfigurationParameter[]>: The protected configuration parameters for the guest configuration. + - `[Name <String>]`: Name of the configuration parameter. + - `[Value <String>]`: Value of the configuration parameter. + +LATESTASSIGNMENTREPORTRESOURCE <IAssignmentReportResource[]>: The list of resources for which guest configuration assignment compliance is checked. + - `[Reason <IAssignmentReportResourceComplianceReason[]>]`: Compliance reason and reason code for a resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.GuestConfiguration/Remove-AzGuestConfigurationAssignment.md b/azps-10.1.0/Az.GuestConfiguration/Remove-AzGuestConfigurationAssignment.md new file mode 100644 index 0000000000..705a3a80e5 --- /dev/null +++ b/azps-10.1.0/Az.GuestConfiguration/Remove-AzGuestConfigurationAssignment.md @@ -0,0 +1,272 @@ +--- +external help file: +Module Name: Az.GuestConfiguration +online version: https://learn.microsoft.com/powershell/module/az.guestconfiguration/remove-azguestconfigurationassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/GuestConfiguration/help/Remove-AzGuestConfigurationAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/GuestConfiguration/help/Remove-AzGuestConfigurationAssignment.md +--- + +# Remove-AzGuestConfigurationAssignment + +## SYNOPSIS +Delete a guest configuration assignment + +## SYNTAX + +### Delete (Default) +``` +Remove-AzGuestConfigurationAssignment -Name <String> -ResourceGroupName <String> -VMName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Delete1 +``` +Remove-AzGuestConfigurationAssignment -MachineName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Delete2 +``` +Remove-AzGuestConfigurationAssignment -Name <String> -ResourceGroupName <String> -VmssName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzGuestConfigurationAssignment -InputObject <IGuestConfigurationIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a guest configuration assignment + +## EXAMPLES + +### Example 1: Delete a guest configuration assignment +```powershell +Remove-AzGuestConfigurationAssignment -ResourceGroupName test-rg -VMName test-vm -Name test-assignment -PassThru +``` + +```output +True +``` + +Delete a guest configuration assignment named test-assignment + +### Example 2: Delete a guest configuration assignment by piping +```powershell +Get-AzGuestConfigurationAssignment -ResourceGroupName test-rg -VMName test-vm -Name test-assignment | Remove-AzGuestConfigurationAssignment -PassThru +``` + +```output +True +``` + +Delete a guest configuration assignment named test-assignment by piping + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.IGuestConfigurationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MachineName +The name of the ARC machine. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the guest configuration assignment + +```yaml +Type: System.String +Parameter Sets: Delete, Delete1, Delete2 +Aliases: GuestConfigurationAssignmentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: Delete, Delete1, Delete2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete, Delete1, Delete2 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName +The name of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmssName +The name of the virtual machine scale set. + +```yaml +Type: System.String +Parameter Sets: Delete2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.IGuestConfigurationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.Models.Api20220125.IGuestConfigurationAssignment + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IGuestConfigurationIdentity>`: Identity Parameter + - `[GuestConfigurationAssignmentName <String>]`: Name of the guest configuration assignment. + - `[Id <String>]`: Resource identity path + - `[MachineName <String>]`: The name of the ARC machine. + - `[Name <String>]`: The guest configuration assignment name. + - `[ReportId <String>]`: The GUID for the guest configuration assignment report. + - `[ResourceGroupName <String>]`: The resource group name. + - `[SubscriptionId <String>]`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VMName <String>]`: The name of the virtual machine. + - `[VmssName <String>]`: The name of the virtual machine scale set. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HDInsight/Add-AzHDInsightClusterIdentity.md b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightClusterIdentity.md new file mode 100644 index 0000000000..53ded600de --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightClusterIdentity.md @@ -0,0 +1,230 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: A40AB6AB-D3CB-4A6C-B614-0B22085759DA +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/add-azhdinsightclusteridentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightClusterIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightClusterIdentity.md +--- + +# Add-AzHDInsightClusterIdentity + +## SYNOPSIS +Adds a cluster identity to a cluster configuration object. + +## SYNTAX + +### CertificateFilePath (Default) +``` +Add-AzHDInsightClusterIdentity [-Config] <AzureHDInsightConfig> [-ObjectId] <Guid> + [-CertificateFilePath] <String> [-CertificatePassword] <String> [[-AadTenantId] <Guid>] + [[-ApplicationId] <Guid>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### CertificateFileContents +``` +Add-AzHDInsightClusterIdentity [-Config] <AzureHDInsightConfig> [-ObjectId] <Guid> + [-CertificateFileContents] <Byte[]> [-CertificatePassword] <String> [[-AadTenantId] <Guid>] + [[-ApplicationId] <Guid>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzHDInsightClusterIdentity** cmdlet adds a cluster identity to the Azure HDInsight configuration object created by the New-AzHDInsightClusterConfig cmdlet. + +## EXAMPLES + +### Example 1: Add Cluster Identity info to the cluster configuration object +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value +$storageContainer = "container001" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Cluster Identity values +$tenantId = (Get-AzContext).Tenant.TenantId +$objectId = "<Azure AD Service Principal Object ID>" +$applicationId = "<Azure AD Service Principal Application ID>" +$certificateFilePath = "<Path to Azure AD Service Principal Certificate>" +$certificatePassword = "<Password for Azure AD Service Principal Certificate>" + +# Create the cluster +New-AzHDInsightClusterConfig ` + | Add-AzHDInsightClusterIdentity ` + -AadTenantId $tenantId ` + -ObjectId $objectId ` + -ApplicationId $applicationId ` + -CertificateFilePath $certificateFilePath ` + -CertificatePassword $certificatePassword ` + | New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -OSType Linux ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageAccountContainer +``` + +This command adds Cluster Identity info to the cluster named your-hadoop-001, allowing the cluster to access Azure Data Lake Store. + +## PARAMETERS + +### -AadTenantId +Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +The Service Principal Application Id for accessing Azure Data Lake. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateFileContents +Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store. + +```yaml +Type: System.Byte[] +Parameter Sets: CertificateFileContents +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateFilePath +Specifies the file path to the certificate that will be used to authenticate as the Service Principal. +The cluster will use this when accessing Azure Data Lake Store. + +```yaml +Type: System.String +Parameter Sets: CertificateFilePath +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificatePassword +Specifies the password for the certificate that will be used to authenticate as the Service Principal. +The cluster will use this when accessing Azure Data Lake Store. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Config +Specifies the HDInsight cluster configuration object that this cmdlet modifies. +This object is created by the New-AzHDInsightClusterConfig cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +Specifies the Azure AD object ID (a GUID) of the Azure AD Service Principal that represents the cluster. +The cluster will use this when accessing Azure Data Lake Store. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +### System.Guid + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## NOTES + +## RELATED LINKS + +[New-AzHDInsightClusterConfig](./New-AzHDInsightClusterConfig.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Add-AzHDInsightComponentVersion.md b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightComponentVersion.md new file mode 100644 index 0000000000..7c073d6e5e --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightComponentVersion.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 774848C9-47A1-4C43-B6FA-B3C0C3C76470 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/add-azhdinsightcomponentversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightComponentVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightComponentVersion.md +--- + +# Add-AzHDInsightComponentVersion + +## SYNOPSIS +Adds a version for a service running in a cluster to a cluster configuration object. + +## SYNTAX + +``` +Add-AzHDInsightComponentVersion [-Config] <AzureHDInsightConfig> [-ComponentName] <String> + [-ComponentVersion] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The Add-AzHDInsightComponentVersion cmdlet adds a version for a service running in a cluster to the Azure HDInsight configuration object created by the New-AzHDInsightClusterConfig cmdlet. + +## EXAMPLES + +### Example 1: Add a version for Spark to the cluster configuration object. +```powershell + # Primary storage account info + $storageAccountResourceGroupName = "Group" + $storageAccountName = "yourstorageacct001" + $storageAccountResourceId = "yourstorageaccountresourceid" + $storageAccountKey = Get-AzStorageAccountKey ` + -ResourceGroupName $storageAccountResourceGroupName ` + -Name $storageAccountName | ForEach-Object{ $_.Key1 } + $storageContainer = "container001" + + # Cluster configuration info + $location = "East US 2" + $clusterResourceGroupName = "Group" + $clusterName = "your-spark-001" + $clusterCreds = Get-Credential + $sshClusterCreds = Get-Credential + + # If the cluster's resource group doesn't exist yet, run: + # New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + + # Create the cluster + New-AzHDInsightClusterConfig ` + | Add-AzHDInsightComponentVersion ` + -ComponentName "Spark" ` + -ComponentVersion "2.0" ` + | New-AzHDInsightCluster ` + -ClusterType Spark ` + -OSType Linux ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer ` + -SshCredential $sshCredentials ` + -Version "3.5" +``` + +This command adds the version of Spark to the HDInsight cluster named 'your-spark-001'. + +## PARAMETERS + +### -ComponentName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComponentVersion +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Config +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/Add-AzHDInsightConfigValue.md b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightConfigValue.md new file mode 100644 index 0000000000..1a104b060c --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightConfigValue.md @@ -0,0 +1,395 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 4C3CF283-DD4F-4D2A-ABEC-84AC7B005D6A +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/add-azhdinsightconfigvalue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightConfigValue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightConfigValue.md +--- + +# Add-AzHDInsightConfigValue + +## SYNOPSIS +Adds a Hadoop configuration value customization and/or a Hive shared library customization to a cluster configuration object. + +## SYNTAX + +``` +Add-AzHDInsightConfigValue [-Config] <AzureHDInsightConfig> [-Core <Hashtable>] [-HiveSite <Hashtable>] + [-HiveEnv <Hashtable>] [-OozieSite <Hashtable>] [-OozieEnv <Hashtable>] [-WebHCat <Hashtable>] + [-HBaseSite <Hashtable>] [-HBaseEnv <Hashtable>] [-Storm <Hashtable>] [-Yarn <Hashtable>] + [-MapRed <Hashtable>] [-Tez <Hashtable>] [-Hdfs <Hashtable>] [-RServer <Hashtable>] + [-SparkDefaults <Hashtable>] [-SparkThriftConf <Hashtable>] [-Spark2Defaults <Hashtable>] + [-Spark2ThriftConf <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzHDInsightConfigValue** cmdlet adds a Hadoop configuration value customization, such as core-site.xml or hive-site.xml, and/or a Hive shared library customization to the HDInsight configuration object created by the New-AzHDInsightClusterConfig cmdlet. + +## EXAMPLES + +### Example 1: Add a custom configuration value to the cluster configuration object +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value + +$storageContainer = "container001" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Config values +$coreConfigs = @{"io.file.buffer.size"="300000"} +$mapRedConfigs = @{"mapred.map.max.attempts"="2"} + +# Create the cluster +New-AzHDInsightClusterConfig ` + | Add-AzHDInsightConfigValue ` + -Core $coreConfigs ` + -MapRed $mapRedConfigs ` + | New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -OSType Windows ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageAccountContainer +``` + +This command adds a Hadoop configuration value to the cluster named your-hadoop-001. + +## PARAMETERS + +### -Config +Specifies the HDInsight cluster configuration object that this cmdlet modifies. +This object is created by the New-AzHDInsightClusterConfig cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Core +Specifies the Core Site configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HBaseEnv +Specifies the HBase Env configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HBaseSite +Specifies the HBase Site configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Hdfs +Specifies the HDFS configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiveEnv +Specifies the Hive Env configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiveSite +Specifies the Hive Site configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MapRed +Specifies the MapRed Site configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OozieEnv +Specifies the Oozie Env configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OozieSite +Specifies the Oozie Site configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RServer +Specifies the RServer configurations. Valid only for RServer clusters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Spark2Defaults +Specifies the Spark2 Defaults configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Spark2ThriftConf +Specifies the Spark2 Thrift SparkConf configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkDefaults +Specifies the Spark Defaults configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkThriftConf +Specifies the Spark Thrift SparkConf configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Storm +Specifies the Storm Site configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tez +Specifies the Tez Site configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebHCat +Specifies the WebHCat Site configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Yarn +Specifies the YARN Site configurations of this HDInsight cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## NOTES + +## RELATED LINKS + +[New-AzHDInsightClusterConfig](./New-AzHDInsightClusterConfig.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Add-AzHDInsightMetastore.md b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightMetastore.md new file mode 100644 index 0000000000..0b2b0319d7 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightMetastore.md @@ -0,0 +1,246 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 8BD3B8BD-DC87-4A94-9FCA-611D11D5E065 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/add-azhdinsightmetastore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightMetastore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightMetastore.md +--- + +# Add-AzHDInsightMetastore + +## SYNOPSIS +Adds a SQL Database to serve as a Hive or Oozie metastore to a cluster configuration object. + +## SYNTAX + +``` +Add-AzHDInsightMetastore [-Config] <AzureHDInsightConfig> [-MetastoreType] <AzureHDInsightMetastoreType> + [-SqlAzureServerName] <String> [-DatabaseName] <String> [-Credential] <PSCredential> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzHDInsightMetastore** cmdlet adds a Hive or Oozie metastore to the HDInsight configuration object created by the New-AzHDInsightClusterConfig cmdlet. +A metastore is a SQL Database that can used to store metadata for Hive, Oozie, or both. + +## EXAMPLES + +### Example 1: Add a SQL database metastore to the cluster configuration object +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value + + +$storageContainer = "container001" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Hive metastore info +$hiveSqlServer = "your-sqlserver-001" +$hiveDb = "your-sqldb-001" +$hiveCreds = Get-Credential + +# Oozie metastore info +$oozieSqlServer = "your-sqlserver-001" +$oozieDb = "your-sqldb-002" +$oozieCreds = Get-Credential + +# Create the cluster +New-AzHDInsightClusterConfig ` + | Add-AzHDInsightMetastore ` + -SqlAzureServerName "$oozieSqlServer.database.contoso.net" ` + -DatabaseName $oozieDb ` + -Credential $oozieCreds ` + -MetastoreType OozieMetastore ` + | Add-AzHDInsightMetastore ` + -SqlAzureServerName "$hiveSqlServer.database.contoso.net" ` + -DatabaseName $hiveDb ` + -Credential $hiveCreds ` + -MetastoreType HiveMetastore ` + | New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -OSType Windows ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer +``` + +This command adds a SQL database metastore to the cluster named your-hadoop-001. + +### Example 2: Add a custom Ambari database to the cluster configuration object +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value + + +$storageContainer = "container001" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Custom Amari database info +$ambariSqlServer = "your-sqlserver-001" +$ambariDb = "your-sqldb-003" +$ambariCreds = Get-Credential + +# Create the cluster +New-AzHDInsightClusterConfig ` + | Add-AzHDInsightMetastore ` + -SqlAzureServerName "$ambariSqlServer.database.contoso.net" ` + -DatabaseName $ambariDb ` + -Credential $ambariCreds ` + -MetastoreType AmbariDatabase ` + | New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -OSType Windows ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer +``` + +This command adds a custom Ambari database to the cluster named your-hadoop-002. + +## PARAMETERS + +### -Config +Specifies the HDInsight cluster configuration object that this cmdlet modifies. +This object is created by the **New-AzHDInsightClusterConfig** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Credential +Specifies the credentials to use for the AzureSQL Server database. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the database on the AzureSQL Server instance to use for this metastore. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetastoreType +Specifies the type of metastore. +Possible values are HiveMetastore or OozieMetastore. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightMetastoreType +Parameter Sets: (All) +Aliases: +Accepted values: HiveMetastore, OozieMetastore, AmbariDatabase + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlAzureServerName +Specifies the AzureSQL Server instance to use for this metastore. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## NOTES + +## RELATED LINKS + +[New-AzHDInsightClusterConfig](./New-AzHDInsightClusterConfig.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Add-AzHDInsightScriptAction.md b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightScriptAction.md new file mode 100644 index 0000000000..deedcafb06 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightScriptAction.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 8F0634BD-D817-4365-B6D1-924DC36AE4C9 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/add-azhdinsightscriptaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightScriptAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightScriptAction.md +--- + +# Add-AzHDInsightScriptAction + +## SYNOPSIS +Adds a script action to a cluster configuration object. + +## SYNTAX + +``` +Add-AzHDInsightScriptAction [-Config] <AzureHDInsightConfig> [-NodeType] <ClusterNodeType> [-Uri] <Uri> + [-Name] <String> [[-Parameters] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzHDInsightScriptAction** cmdlet adds script actions to the HDInsight configuration object created by the New-AzHDInsightClusterConfig cmdlet. +Script actions provide functionality that is used to install additional software or to change the configuration of applications that run on a Hadoop cluster by using Windows PowerShell or Bash scripts (for Windows or Linux clusters, respectively). +A script action runs on the cluster nodes when HDInsight clusters are deployed, and they run after nodes in the cluster complete HDInsight configuration. +The script action runs under system administrator account privileges and provides full access rights to the cluster nodes. +You can provide each cluster with a list of script actions to run in a specified sequence. + +## EXAMPLES + +### Example 1: Add a script action to the cluster configuration object +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value + + +$storageContainer = "container001" + +# Script action info +$scriptActionName = "<script action name>" +$scriptActionURI = "<script action URI>" +$scriptActionParameters = "<script action parameters>" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Create the cluster +New-AzHDInsightClusterConfig ` + | Add-AzHDInsightScriptAction ` + -Name $scriptActionName ` + -Uri $scriptActionURI ` + -Parameters $scriptActionParameters ` + -NodeType Worker ` + | Add-AzHDInsightScriptAction ` + -Name $scriptActionName ` + -Uri $scriptActionURI ` + -Parameters $scriptActionParameters ` + -NodeType Head ` + | New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -OSType Windows ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer +``` + +This command adds a script action for the Head and Worker nodes of the your-hadoop-001 cluster, to be run at the end of cluster creation. + +## PARAMETERS + +### -Config +Specifies the HDInsight cluster configuration object that this cmdlet modifies. +This object is created by the **New-AzHDInsightClusterConfig** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the script action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeType +Specifies the node type on which to run the script action. +The acceptable values for this parameter are: +- HeadNode +- WorkerNode +- ZookeeperNode + +```yaml +Type: Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType +Parameter Sets: (All) +Aliases: +Accepted values: HeadNode, WorkerNode, ZookeeperNode, EdgeNode + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameters +Specifies the parameters for the script action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +Specifies the public URI for the script action (a PowerShell or Bash script). + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## NOTES + +## RELATED LINKS + +[New-AzHDInsightClusterConfig](./New-AzHDInsightClusterConfig.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Add-AzHDInsightSecurityProfile.md b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightSecurityProfile.md new file mode 100644 index 0000000000..01045b3adc --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightSecurityProfile.md @@ -0,0 +1,230 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: FB37494B-4035-45B7-88AB-DF33CEEF0D0A +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/add-azhdinsightsecurityprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightSecurityProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightSecurityProfile.md +--- + +# Add-AzHDInsightSecurityProfile + +## SYNOPSIS +Adds a security profile to a cluster configuration object. + +## SYNTAX + +``` +Add-AzHDInsightSecurityProfile [-Config] <AzureHDInsightConfig> -DomainResourceId <String> + -DomainUserCredential <PSCredential> [-OrganizationalUnitDN <String>] -LdapsUrls <String[]> + [-ClusterUsersGroupDNs <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Security profile is used to create a secure cluster by kerberizing it. +Security profile contains configuration related joining the cluster to Active Directory Domain. + +## EXAMPLES + +### Example 1: Add security profile to the cluster configuration object +```powershell +#Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value + +$storageContainer = "container001" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +#Security profile info +$domain="sampledomain.onmicrosoft.com" +$domainUser="sample.user@sampledomain.onmicrosoft.com" +$domainPassword=ConvertTo-SecureString "domainPassword" -AsPlainText -Force +$domainUserCredential=New-Object System.Management.Automation.PSCredential($domainUser, $domainPassword) +$organizationalUnitDN="ou=testunitdn" +$ldapsUrls=("ldaps://sampledomain.onmicrosoft.com:636","ldaps://sampledomain.onmicrosoft.com:389") +$clusterUsersGroupDNs=("groupdn1","groupdn2") + +# Create the cluster +New-AzHDInsightClusterConfig ` + | Add-AzHDInsightSecurityProfile ` + -DomainResourceId $domain ` + -DomainUserCredential $domainUserCredential ` + -OrganizationalUnitDN $organizationalUnitDN ` + -LdapsUrls $ldapsUrls ` + -ClusterUsersGroupDNs $clusterUsersGroupDNs ` + | New-AzHDInsightCluster ` + -ClusterType Spark ` + -OSType Linux ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer +``` + +This command adds a security profile value to the cluster named your-hadoop-001. + +## PARAMETERS + +### -ClusterUsersGroupDNs +Distinguished names of the Active Directory groups that will be available in Ambari and Ranger + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Config +Specifies the HDInsight cluster configuration object that this cmdlet modifies. +This object is created by the New-AzHDInsightClusterConfig cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainResourceId +Active Directory domain resource id for the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainUserCredential +A domain user account credential with sufficient permissions for creating the cluster. +Username should be in user@domain format + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapsUrls +Urls of one or multiple LDAPS servers for the Active Directory + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnitDN +Distinguished name of the organizational unit in the Active directory where user and computer accounts will be 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. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightSecurityProfile +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/Add-AzHDInsightStorage.md b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightStorage.md new file mode 100644 index 0000000000..f9834905ab --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Add-AzHDInsightStorage.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 2C2AF43D-18BF-4036-A355-FC27E406B18A +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/add-azhdinsightstorage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightStorage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Add-AzHDInsightStorage.md +--- + +# Add-AzHDInsightStorage + +## SYNOPSIS +Adds an Azure Storage key to a cluster configuration object. + +## SYNTAX + +``` +Add-AzHDInsightStorage [-Config] <AzureHDInsightConfig> [-StorageAccountName] <String> + [-StorageAccountKey] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzHDInsightStorage** cmdlet adds an Azure Storage account entry to the Azure HDInsight configuration object created by the New-AzHDInsightClusterConfig cmdlet. + +## EXAMPLES + +### Example 1: Add an Azure storage key to the cluster configuration object +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value + + +$storageContainer = "container001" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Second storage account info +$secondStorageAccountResourceGroupName = "Group" +$secondStorageAccountName = "yourstorageacct002" +$secondStorageAccountKey = Get-AzStorageAccountKey ` +-ResourceGroupName $secondStorageAccountResourceGroupName ` + -Name $secondStorageAccountName | ForEach-Object{ $_.Key1 } + +# Create the cluster +New-AzHDInsightClusterConfig ` + | Add-AzHDInsightStorage ` + -StorageAccountName "$secondStorageAccountName.blob.core.contoso.net" ` + -StorageAccountKey $key2 ` + | New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -OSType Windows ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer +``` + +This command adds an blob storage account entry to the HDInsight configuration named your-hadoop-001. + +## PARAMETERS + +### -Config +Specifies the HDInsight cluster configuration object that this cmdlet modifies. +This object is created by the **New-AzHDInsightClusterConfig** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountKey +Specifies the storage account key for the storage account to be added to the new cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +Specifies the storage account name for the storage account to be added to the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## NOTES + +## RELATED LINKS + +[New-AzHDInsightClusterConfig](./New-AzHDInsightClusterConfig.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Az.HDInsight.md b/azps-10.1.0/Az.HDInsight/Az.HDInsight.md new file mode 100644 index 0000000000..9ccea83753 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Az.HDInsight.md @@ -0,0 +1,159 @@ +--- +Module Name: Az.HDInsight +Module Guid: 3fd1475f-cb23-4ffb-bf08-33d94b7d1acb +Download Help Link: https://learn.microsoft.com/powershell/module/az.hdinsight +Help Version: 4.1.2.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Az.HDInsight.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Az.HDInsight.md +--- + +# Az.HDInsight Module +## Description +The topics in this section document the Azure PowerShell cmdlets for Microsoft Azure HDInsight in the Azure Resource Manager (ARM) framework. These cmdlets are used to manage HDInsight clusters and the jobs that run on them. The cmdlets exist in the Microsoft.Azure.Commands.HDInsight namespace. + +## Az.HDInsight Cmdlets +### [Add-AzHDInsightClusterIdentity](Add-AzHDInsightClusterIdentity.md) +Adds a cluster identity to a cluster configuration object. + +### [Add-AzHDInsightComponentVersion](Add-AzHDInsightComponentVersion.md) +Adds a version for a service running in a cluster to a cluster configuration object. + +### [Add-AzHDInsightConfigValue](Add-AzHDInsightConfigValue.md) +Adds a Hadoop configuration value customization and/or a Hive shared library customization to a cluster configuration object. + +### [Add-AzHDInsightMetastore](Add-AzHDInsightMetastore.md) +Adds a SQL Database to serve as a Hive or Oozie metastore to a cluster configuration object. + +### [Add-AzHDInsightScriptAction](Add-AzHDInsightScriptAction.md) +Adds a script action to a cluster configuration object. + +### [Add-AzHDInsightSecurityProfile](Add-AzHDInsightSecurityProfile.md) +Adds a security profile to a cluster configuration object. + +### [Add-AzHDInsightStorage](Add-AzHDInsightStorage.md) +Adds an Azure Storage key to a cluster configuration object. + +### [Disable-AzHDInsightAzureMonitor](Disable-AzHDInsightAzureMonitor.md) +Disables Azure Monitor in a specified HDInsight cluster. + +### [Disable-AzHDInsightMonitoring](Disable-AzHDInsightMonitoring.md) +Disables the Classic Azure Monitor logs integration on an HDInsight cluster and relevant logs will stop flowing to the monitoring workspace specified during enable. + +### [Enable-AzHDInsightAzureMonitor](Enable-AzHDInsightAzureMonitor.md) +Enables Azure Monitor in a specified HDInsight cluster. + +### [Enable-AzHDInsightMonitoring](Enable-AzHDInsightMonitoring.md) +Enables the Classic Azure Monitor logs integration on an HDInsight cluster and relevant logs will be sent to the monitoring workspace specified during enable. + +### [Get-AzHDInsightAzureMonitor](Get-AzHDInsightAzureMonitor.md) +Gets the azure monitor status of a specified HDInsight cluster. + +### [Get-AzHDInsightCluster](Get-AzHDInsightCluster.md) +Gets and lists all of the Azure HDInsight clusters associated with the current subscription or a specified resource group, or retrieves a specific cluster. + +### [Get-AzHDInsightClusterAutoscaleConfiguration](Get-AzHDInsightClusterAutoscaleConfiguration.md) +Gets the autoscale configuration of HDInsight cluster. + +### [Get-AzHDInsightHost](Get-AzHDInsightHost.md) +Lists the hosts of the HDInsight cluster. + +### [Get-AzHDInsightJob](Get-AzHDInsightJob.md) +Gets the list of jobs from a cluster and lists them in reverse chronological order, or retrieves a specific job. + +### [Get-AzHDInsightJobOutput](Get-AzHDInsightJobOutput.md) +Gets the log output for a job from the storage account associated with a specified cluster. + +### [Get-AzHDInsightMonitoring](Get-AzHDInsightMonitoring.md) +Gets the status of the Classic Azure Monitor logs integration on an HDInsight cluster. + +### [Get-AzHDInsightPersistedScriptAction](Get-AzHDInsightPersistedScriptAction.md) +Gets the persisted script actions for a cluster and lists them in chronological order, or gets details for a specified persisted script action. + +### [Get-AzHDInsightProperty](Get-AzHDInsightProperty.md) +Gets properties about the HDInsight service, such as available locations and capacity. + +### [Get-AzHDInsightScriptActionHistory](Get-AzHDInsightScriptActionHistory.md) +Gets the script action history for a cluster and lists it in reverse chronological order, or gets details of a previously executed script action. + +### [Invoke-AzHDInsightHiveJob](Invoke-AzHDInsightHiveJob.md) +Submits a Hive query to an HDInsight cluster and retrieves query results in one operation. + +### [New-AzHDInsightCluster](New-AzHDInsightCluster.md) +Creates an Azure HDInsight cluster in the specified resource group for the current subscription. + +### [New-AzHDInsightClusterAutoscaleConfiguration](New-AzHDInsightClusterAutoscaleConfiguration.md) +Creates a non-persisted object that describes the autoscale configuration of an Azure HDInsight cluster. + +### [New-AzHDInsightClusterAutoscaleScheduleCondition](New-AzHDInsightClusterAutoscaleScheduleCondition.md) +Creates Schedule-based autoscale condition. + +### [New-AzHDInsightClusterConfig](New-AzHDInsightClusterConfig.md) +Creates a non-persisted cluster configuration object that describes an Azure HDInsight cluster configuration. + +### [New-AzHDInsightHiveJobDefinition](New-AzHDInsightHiveJobDefinition.md) +Creates a Hive job object. + +### [New-AzHDInsightIPConfiguration](New-AzHDInsightIPConfiguration.md) +Creates the IP configuration of private link configuration. + +### [New-AzHDInsightMapReduceJobDefinition](New-AzHDInsightMapReduceJobDefinition.md) +Creates a MapReduce job object. + +### [New-AzHDInsightPigJobDefinition](New-AzHDInsightPigJobDefinition.md) +Creates a Pig job object. + +### [New-AzHDInsightPrivateLinkConfiguration](New-AzHDInsightPrivateLinkConfiguration.md) +Creates the private link configuration of the HDInsight cluster. + +### [New-AzHDInsightSqoopJobDefinition](New-AzHDInsightSqoopJobDefinition.md) +Creates a Sqoop job object. + +### [New-AzHDInsightStreamingMapReduceJobDefinition](New-AzHDInsightStreamingMapReduceJobDefinition.md) +Creates a Streaming MapReduce job object. + +### [Remove-AzHDInsightCluster](Remove-AzHDInsightCluster.md) +Removes the specified HDInsight cluster from the current subscription. + +### [Remove-AzHDInsightClusterAutoscaleConfiguration](Remove-AzHDInsightClusterAutoscaleConfiguration.md) +Removes the autoscale configuration of the HDInsight cluster. + +### [Remove-AzHDInsightPersistedScriptAction](Remove-AzHDInsightPersistedScriptAction.md) +Removes an persisted script action from an HDInsight cluster. + +### [Restart-AzHDInsightHost](Restart-AzHDInsightHost.md) +Restarts the specific hosts of HDInsight cluster. + +### [Set-AzHDInsightClusterAutoscaleConfiguration](Set-AzHDInsightClusterAutoscaleConfiguration.md) +Sets the autoscale configuration of an Azure HDInsight cluster. + +### [Set-AzHDInsightClusterDiskEncryptionKey](Set-AzHDInsightClusterDiskEncryptionKey.md) +Rotates the disk encryption key of the specified HDInsight cluster. + +### [Set-AzHDInsightClusterSize](Set-AzHDInsightClusterSize.md) +Sets the number of Worker nodes in a specified cluster. + +### [Set-AzHDInsightDefaultStorage](Set-AzHDInsightDefaultStorage.md) +Sets the default Storage account setting in a cluster configuration object. + +### [Set-AzHDInsightGatewayCredential](Set-AzHDInsightGatewayCredential.md) +Sets the gateway HTTP credentials of an Azure HDInsight cluster. + +### [Set-AzHDInsightPersistedScriptAction](Set-AzHDInsightPersistedScriptAction.md) +Sets a previously executed script action to be a persisted script action. + +### [Start-AzHDInsightJob](Start-AzHDInsightJob.md) +Starts a defined Azure HDInsight job on a specified cluster. + +### [Stop-AzHDInsightJob](Stop-AzHDInsightJob.md) +Stops a specified running job on a cluster. + +### [Submit-AzHDInsightScriptAction](Submit-AzHDInsightScriptAction.md) +Submits a new script action to an Azure HDInsight cluster. + +### [Use-AzHDInsightCluster](Use-AzHDInsightCluster.md) +Selects a cluster to be used with the Invoke-RmAzureHDInsightHiveJob cmdlet. + +### [Wait-AzHDInsightJob](Wait-AzHDInsightJob.md) +Waits for the completion or failure of a specified job. + diff --git a/azps-10.1.0/Az.HDInsight/Disable-AzHDInsightAzureMonitor.md b/azps-10.1.0/Az.HDInsight/Disable-AzHDInsightAzureMonitor.md new file mode 100644 index 0000000000..19f2d93a81 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Disable-AzHDInsightAzureMonitor.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/disable-azhdinsightazuremonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Disable-AzHDInsightAzureMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Disable-AzHDInsightAzureMonitor.md +--- + +# Disable-AzHDInsightAzureMonitor + +## SYNOPSIS +Disables Azure Monitor in a specified HDInsight cluster. + +## SYNTAX + +### DisableByNameParameterSet (Default) +``` +Disable-AzHDInsightAzureMonitor [[-ResourceGroupName] <String>] [-ClusterName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DisableByResourceIdParameterSet +``` +Disable-AzHDInsightAzureMonitor [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### DisableByInputObjectParameterSet +``` +Disable-AzHDInsightAzureMonitor [-InputObject] <AzureHDInsightCluster> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet **Disable-AzHDInsightAzureMonitor** disables Azure Monitor in a specified HDInsight cluster. + +## EXAMPLES + +### Example 1 +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$resourceGroupName = "Group" +Disable-AzHDInsightAzureMonitor -ClusterName $clusterName -ResourceGroupName $resourceGroupName +``` + +This cmdlet disables the azure monitor in a specified HDInsight cluster. + +### Example 2 +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$cluster=Get-AzHDInsightCluster -ClusterName $clusterName +$cluster | Disable-AzHDInsightAzureMonitor +``` + +This cmdlet disables the azure monitor in a specified HDInsight cluster with pipeline. + +## PARAMETERS + +### -ClusterName +Gets or sets the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: DisableByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gets or sets the input object. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster +Parameter Sets: DisableByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Gets or sets the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DisableByNameParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Gets or sets the resource id. + +```yaml +Type: System.String +Parameter Sets: DisableByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Enable-AzHDInsightAzureMonitor](./Enable-AzHDInsightAzureMonitor.md) +[Get-AzHDInsightAzureMonitor](./Get-AzHDInsightAzureMonitor.md) diff --git a/azps-10.1.0/Az.HDInsight/Disable-AzHDInsightMonitoring.md b/azps-10.1.0/Az.HDInsight/Disable-AzHDInsightMonitoring.md new file mode 100644 index 0000000000..4b763415da --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Disable-AzHDInsightMonitoring.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/disable-azhdinsightmonitoring +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Disable-AzHDInsightMonitoring.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Disable-AzHDInsightMonitoring.md +--- + +# Disable-AzHDInsightMonitoring + +## SYNOPSIS +Disables the Classic Azure Monitor logs integration on an HDInsight cluster and relevant logs will stop flowing to the monitoring workspace specified during enable. + +## SYNTAX + +``` +Disable-AzHDInsightMonitoring [-Name] <String> [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzHDInsightMonitoring** cmdlet disables the Classic Azure Monitor logs integration on an HDInsight cluster. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzHDInsightMonitoring -Name testcluster +``` + +```output +True +``` + +Monitoring will be disabled on the HDInsight cluster and relevant logs will stop flowing to the monitoring workspace. + +### Example 2 +```powershell +Disable-AzHDInsightMonitoring -Name testcluster -ResourceGroupName testrg +``` + +```output +True +``` + +Monitoring will be disabled on the HDInsight cluster and relevant logs will stop flowing to the monitoring workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the cluster to disable Monitoring. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/Enable-AzHDInsightAzureMonitor.md b/azps-10.1.0/Az.HDInsight/Enable-AzHDInsightAzureMonitor.md new file mode 100644 index 0000000000..ac7f1ac1b9 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Enable-AzHDInsightAzureMonitor.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/enable-azhdinsightazuremonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Enable-AzHDInsightAzureMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Enable-AzHDInsightAzureMonitor.md +--- + +# Enable-AzHDInsightAzureMonitor + +## SYNOPSIS +Enables Azure Monitor in a specified HDInsight cluster. + +## SYNTAX + +### EnableByNameParameterSet (Default) +``` +Enable-AzHDInsightAzureMonitor [[-ResourceGroupName] <String>] [-ClusterName] <String> [-WorkspaceId] <String> + [-PrimaryKey] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EnableByResourceIdParameterSet +``` +Enable-AzHDInsightAzureMonitor [-ResourceId] <String> [-WorkspaceId] <String> [-PrimaryKey] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EnableByInputObjectParameterSet +``` +Enable-AzHDInsightAzureMonitor [-InputObject] <AzureHDInsightCluster> [-WorkspaceId] <String> + [-PrimaryKey] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet **Enable-AzHDInsightAzureMonitor** enables Azure Monitor in a specified HDInsight cluster. + +## EXAMPLES + +### Example 1 +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$resourceGroupName = "Group" +$workspaceId = "your-workspace-id" +$primaryKey = "your-primary-key" +Enable-AzHDInsightAzureMonitor -ClusterName $clusterName -ResourceGroupName $resourceGroupName -WorkspaceId $workspaceId -PrimaryKey $primaryKey +``` + +This cmdlet enables the azure monitor in a specified HDInsight cluster. + +### Example 2 +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$cluster=Get-AzHDInsightCluster -ClusterName $clusterName +$workspaceId = "your-workspace-id" +$primaryKey = "your-primary-key" +$cluster | Enable-AzHDInsightAzureMonitor -WorkspaceId $workspaceId -PrimaryKey $primaryKey +``` + +This cmdlet enables the azure monitor in a specified HDInsight cluster with pipeline. + +## PARAMETERS + +### -ClusterName +Gets or sets the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: EnableByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gets or sets the input object. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster +Parameter Sets: EnableByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrimaryKey +Gets to sets the primary key of the Log Analytics workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Gets or sets the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: EnableByNameParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Gets or sets the resource id. + +```yaml +Type: System.String +Parameter Sets: EnableByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceId +Gets or sets the ID of the Log Analytics workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Disable-AzHDInsightAzureMonitor](./Disable-AzHDInsightAzureMonitor.md) +[Get-AzHDInsightAzureMonitor](./Get-AzHDInsightAzureMonitor.md) diff --git a/azps-10.1.0/Az.HDInsight/Enable-AzHDInsightMonitoring.md b/azps-10.1.0/Az.HDInsight/Enable-AzHDInsightMonitoring.md new file mode 100644 index 0000000000..4f16c31a18 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Enable-AzHDInsightMonitoring.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/enable-azhdinsightmonitoring +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Enable-AzHDInsightMonitoring.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Enable-AzHDInsightMonitoring.md +--- + +# Enable-AzHDInsightMonitoring + +## SYNOPSIS +Enables the Classic Azure Monitor logs integration on an HDInsight cluster and relevant logs will be sent to the monitoring workspace specified during enable. + +## SYNTAX + +``` +Enable-AzHDInsightMonitoring [-Name] <String> [-WorkspaceId] <String> [-PrimaryKey] <String> + [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzHDInsightMonitoring** cmdlet enables the Classic Azure Monitor logs integration on an HDInsight cluster. + +## EXAMPLES + +### Example 1 +```powershell +Enable-AzHDInsightMonitoring -Name testcluster -WorkspaceId 1d364e89-bb71-4503-aa3d-a23535aea7bd -PrimaryKey 'key for workspace 1d364e89-bb71-4503-aa3d-a23535aea7bd' +``` + +```output +True +``` + +Monitoring will be enabled on the HDInsight cluster and relevant logs will be sent to the monitoring workspace with id 1d364e89-bb71-4503-aa3d-a23535aea7bd + +### Example 2 +```powershell +Enable-AzHDInsightMonitoring -Name testcluster -ResourceGroupName testrg -WorkspaceId 1d364e89-bb71-4503-aa3d-a23535aea7bd -PrimaryKey 'key for workspace 1d364e89-bb71-4503-aa3d-a23535aea7bd' +``` + +```output +True +``` + +Monitoring will be enabled on the HDInsight cluster and relevant logs will be sent to the monitoring workspace with id 1d364e89-bb71-4503-aa3d-a23535aea7bd + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the cluster to enable monitoring. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrimaryKey +The primary key of the monitoring workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceId +The id of the monitoring workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/Get-AzHDInsightAzureMonitor.md b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightAzureMonitor.md new file mode 100644 index 0000000000..7dcfc16ea1 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightAzureMonitor.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/get-azhdinsightazuremonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightAzureMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightAzureMonitor.md +--- + +# Get-AzHDInsightAzureMonitor + +## SYNOPSIS +Gets the azure monitor status of a specified HDInsight cluster. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzHDInsightAzureMonitor [[-ResourceGroupName] <String>] [-ClusterName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzHDInsightAzureMonitor [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzHDInsightAzureMonitor [-InputObject] <AzureHDInsightCluster> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHDInsightAzureMonitor** cmdlet gets the azure monitor status of a specified HDInsight cluster. + +## EXAMPLES + +### Example 1 +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$resourceGroupName = "Group" +Get-AzHDInsightAzureMonitor -ClusterName $clusterName -ResourceGroupName $resourceGroupName +``` + +This cmdlet gets the azure monitor status of a specified HDInsight cluster. + +### Example 2 +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$cluster=Get-AzHDInsightCluster -ClusterName $clusterName +$cluster | Get-AzHDInsightAzureMonitor +``` + +This cmdlet gets the azure monitor with pipeline. + +## PARAMETERS + +### -ClusterName +Gets or sets the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gets or sets the input object. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Gets or sets the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Gets or sets the resource id. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightMonitoring + +## NOTES + +## RELATED LINKS + +[Enable-AzHDInsightAzureMonitor](./Enable-AzHDInsightAzureMonitor.md) +[Disable-AzHDInsightAzureMonitor](./Disable-AzHDInsightAzureMonitor.md) diff --git a/azps-10.1.0/Az.HDInsight/Get-AzHDInsightCluster.md b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightCluster.md new file mode 100644 index 0000000000..14407d1f84 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightCluster.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: FA154E07-EA26-4688-986E-C53C3A9E4F06 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/get-azhdinsightcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightCluster.md +--- + +# Get-AzHDInsightCluster + +## SYNOPSIS +Gets and lists all of the Azure HDInsight clusters associated with the current subscription or a specified resource group, or retrieves a specific cluster. + +## SYNTAX + +``` +Get-AzHDInsightCluster [[-ResourceGroupName] <String>] [[-ClusterName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHDInsightCluster** cmdlet lists the Azure HDInsight service clusters for the current subscription. +Use the *ClusterName* parameter to get details for a specific cluster. + +## EXAMPLES + +### Example 1: List all Azure HDInsight clusters +```powershell +Get-AzHDInsightCluster +``` + +This command lists all the Azure HDInsight clusters. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster + +## NOTES + +## RELATED LINKS + +[Remove-AzHDInsightCluster](./Remove-AzHDInsightCluster.md) + +[Use-AzHDInsightCluster](./Use-AzHDInsightCluster.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Get-AzHDInsightClusterAutoscaleConfiguration.md b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightClusterAutoscaleConfiguration.md new file mode 100644 index 0000000000..635f214c3a --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightClusterAutoscaleConfiguration.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 8CD55A33-5964-409A-BDA5-EDAE9A21E0C1 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/get-azhdinsightclusterautoscaleconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightClusterAutoscaleConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightClusterAutoscaleConfiguration.md +--- + +# Get-AzHDInsightClusterAutoscaleConfiguration + +## SYNOPSIS +Gets the autoscale configuration of HDInsight cluster. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzHDInsightClusterAutoscaleConfiguration [[-ResourceGroupName] <String>] [-ClusterName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzHDInsightClusterAutoscaleConfiguration [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzHDInsightClusterAutoscaleConfiguration [-InputObject] <AzureHDInsightCluster> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHDInsightClusterAutoscaleConfiguration** cmdlet gets the autoscale configuration of HDInsight cluster. + +## EXAMPLES + +### Example 1: Get the autoscale configuration of HDInsight cluster. +```powershell +$clusterResourceGroup="group" +$clusterName="MyCluster" +Get-AzHDInsightClusterAutoscaleConfiguration -ResourceGroupName $clusterResourceGroup -ClusterName $clusterName +``` + +This command gets the autoscale configuration of HDInsight cluster. + +## PARAMETERS + +### -ClusterName +Gets or sets the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gets or sets the input object. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Gets or sets the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Gets or sets the resource id. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightAutoscale + +## NOTES + +## RELATED LINKS + +[New-AzHDInsightClusterAutoscaleConfiguration](./New-AzHDInsightClusterAutoscaleConfiguration.md) +[Set-AzHDInsightClusterAutoscaleConfiguration](./Set-AzHDInsightClusterAutoscaleConfiguration.md) +[Remove-AzHDInsightClusterAutoscaleConfiguration](./Remove-AzHDInsightClusterAutoscaleConfiguration.md) diff --git a/azps-10.1.0/Az.HDInsight/Get-AzHDInsightHost.md b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightHost.md new file mode 100644 index 0000000000..d61002e6e8 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightHost.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/get-azhdinsighthost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightHost.md +--- + +# Get-AzHDInsightHost + +## SYNOPSIS +Lists the hosts of the HDInsight cluster. + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Get-AzHDInsightHost [[-ResourceGroupName] <String>] [-ClusterName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Get-AzHDInsightHost [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Get-AzHDInsightHost [-InputObject] <AzureHDInsightCluster> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHDInsightHost** cmdlet lists the hosts of the HDInsight cluster. + +## EXAMPLES + +### Example 1 +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +Get-AzHDInsightHost -ClusterName $clusterName +``` + +This command lists of cluster' hosts with cluster name. + +### Example 2 +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$cluster=Get-AzHDInsightCluster -ClusterName $clusterName +$cluster | Get-AzHDInsightHost +``` + +This command lists of cluster' hosts with pipeline. + +## PARAMETERS + +### -ClusterName +Gets or sets the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gets or sets the input object. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Gets or sets the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Gets or sets the resource id. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightHostInfo + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/Get-AzHDInsightJob.md b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightJob.md new file mode 100644 index 0000000000..8a40829a30 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightJob.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: AFE90092-8B25-4897-8D3A-3E732CC5CBA6 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/get-azhdinsightjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightJob.md +--- + +# Get-AzHDInsightJob + +## SYNOPSIS +Gets the list of jobs from a cluster and lists them in reverse chronological order, or retrieves a specific job. + +## SYNTAX + +``` +Get-AzHDInsightJob [-ClusterName] <String> [-HttpCredential] <PSCredential> [[-JobId] <String>] + [-NumOfJobs <Int32>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHDInsightJob** cmdlet gets recent jobs for a specified Azure HDInsight cluster in reverse chronological order, with the most recent job at the top of the list. +Get a specific job by providing the *JobId* parameter. + +## EXAMPLES + +### Example 1: Get recent jobs for a specified Azure HDInsight cluster +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# Hive job details +$statusFolder = "tempStatusFolder/" +$query = "SHOW TABLES" + +New-AzHDInsightHiveJobDefinition -StatusFolder $statusFolder ` + -Query $query ` + | Start-AzHDInsightJob -ClusterName $clusterName ` + -ClusterCredential $clusterCreds ` + | Get-AzHDInsightJob -ClusterName $clusterName ` + -ClusterCredential $clusterCreds +``` + +This command gets all recent jobs for the cluster named your-hadoop-001. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpCredential +Specifies the cluster login (HTTP) credentials for the cluster. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: ClusterCredential + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId +Specifies the job ID of the job to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumOfJobs +Specifies the number of jobs to retrieve. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightJob + +## NOTES + +## RELATED LINKS + +[New-AzHDInsightHiveJobDefinition](./New-AzHDInsightHiveJobDefinition.md) + +[Start-AzHDInsightJob](./Start-AzHDInsightJob.md) + +[Stop-AzHDInsightJob](./Stop-AzHDInsightJob.md) + +[Wait-AzHDInsightJob](./Wait-AzHDInsightJob.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Get-AzHDInsightJobOutput.md b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightJobOutput.md new file mode 100644 index 0000000000..dbe5ea317c --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightJobOutput.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 5871C962-27D7-4EC8-927E-D4CAE5F23C58 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/get-azhdinsightjoboutput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightJobOutput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightJobOutput.md +--- + +# Get-AzHDInsightJobOutput + +## SYNOPSIS +Gets the log output for a job from the storage account associated with a specified cluster. + +## SYNTAX + +``` +Get-AzHDInsightJobOutput [-ClusterName] <String> [-JobId] <String> [[-DefaultContainer] <String>] + [[-DefaultStorageAccountName] <String>] [[-DefaultStorageAccountKey] <String>] + [-HttpCredential] <PSCredential> [-ResourceGroupName <String>] [-DisplayOutputType <JobDisplayOutputType>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHDInsightJobOutput** cmdlet gets the log output for a job from the Storage account associated with an Azure HDInsight cluster. + +## EXAMPLES + +### Example 1: Get the log output for a job +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# Hive job details +$statusFolder = "<status folder>" +$query = "<query here>" + +New-AzHDInsightHiveJobDefinition -StatusFolder $statusFolder ` + -Query $query ` + | Start-AzHDInsightJob ` + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds ` + | Get-AzHDInsightJobOutput ` + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds +``` + +This command gets the log output from the cluster named your-hadoop-001. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultContainer +Specifies the default container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultStorageAccountKey +Specifies the default Storage account key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultStorageAccountName +Specifies the default Storage account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayOutputType +Specifies the job output type being requested. +The acceptable values for this parameter are: +- StandardOutput +- StandardError + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.Job.JobDisplayOutputType +Parameter Sets: (All) +Aliases: +Accepted values: StandardOutput, StandardError + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpCredential +Specifies the cluster login (HTTP) credentials for the cluster. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: ClusterCredential + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId +Specifies the job ID of the job whose output will be fetched. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[New-AzHDInsightHiveJobDefinition](./New-AzHDInsightHiveJobDefinition.md) + +[Start-AzHDInsightJob](./Start-AzHDInsightJob.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Get-AzHDInsightMonitoring.md b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightMonitoring.md new file mode 100644 index 0000000000..6c820df394 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightMonitoring.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/get-azhdinsightmonitoring +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightMonitoring.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightMonitoring.md +--- + +# Get-AzHDInsightMonitoring + +## SYNOPSIS +Gets the status of the Classic Azure Monitor logs integration on an HDInsight cluster. + +## SYNTAX + +``` +Get-AzHDInsightMonitoring [-Name] <String> [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHDInsightMonitoring** cmdlet gets the status of the Classic Azure Monitor logs integration on an HDInsight cluster. If monitoring is enabled then it will also return the log analytics workspace id. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzHDInsightMonitoring -Name testcluster +``` + +```output +{'ClusterMonitoringEnabled':'true', 'workspaceId':'1d364e89-bb71-4503-aa3d-a23535aea7bd'} +``` + +Monitoring is enabled on the cluster because the ClusterMonitoringEnabled property is true. The monitoring workspace id where the logs are flowing is 1d364e89-bb71-4503-aa3d-a23535aea7bd + +### Example 2 +```powershell +Get-AzHDInsightMonitoring -Name testcluster -ResourceGroupName testrg +``` + +```output +{'ClusterMonitoringEnabled':'true', 'workspaceId':'1d364e89-bb71-4503-aa3d-a23535aea7bd'} +``` + +Monitoring is enabled on the cluster because the ClusterMonitoringEnabled property is true. The monitoring workspace id where the logs are flowing is 1d364e89-bb71-4503-aa3d-a23535aea7bd + +### Example 3 +```powershell +Get-AzHDInsightMonitoring -Name testcluster +``` + +```output +{'ClusterMonitoringEnabled':'false', 'workspaceId': null} +``` + +Monitoring is disabled on the cluster because the ClusterMonitoringEnabled property is false. + +### Example 4 +```powershell +Get-AzHDInsightMonitoring -Name testcluster -ResourceGroupName testrg +``` + +```output +{'ClusterMonitoringEnabled':'false', 'workspaceId': null} +``` + +Monitoring is disabled on the cluster because the ClusterMonitoringEnabled property is false. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the cluster to get the status of monitoring. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightMonitoring + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/Get-AzHDInsightPersistedScriptAction.md b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightPersistedScriptAction.md new file mode 100644 index 0000000000..87749c4637 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightPersistedScriptAction.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 2B7C1B83-EEEA-4BD1-9E9B-1F3070295995 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/get-azhdinsightpersistedscriptaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightPersistedScriptAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightPersistedScriptAction.md +--- + +# Get-AzHDInsightPersistedScriptAction + +## SYNOPSIS +Gets the persisted script actions for a cluster and lists them in chronological order, or gets details for a specified persisted script action. + +## SYNTAX + +``` +Get-AzHDInsightPersistedScriptAction [-ClusterName] <String> [[-Name] <String>] [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHDInsightPersistedScriptAction** cmdlet gets the persisted script actions for an Azure HDInsight cluster and lists them in chronological order, or gets details for a specified persisted script action. + +## EXAMPLES + +### Example 1: Get the persisted script actions on a cluster +```powershell +Get-AzHDInsightPersistedScriptAction -ClusterName "your-hadoop-001" +``` + +This command gets persisted script actions on the cluster named your-hadoop-001. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the persisted script action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightRuntimeScriptAction + +## NOTES + +## RELATED LINKS + +[Remove-AzHDInsightPersistedScriptAction](./Remove-AzHDInsightPersistedScriptAction.md) + +[Set-AzHDInsightPersistedScriptAction](./Set-AzHDInsightPersistedScriptAction.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Get-AzHDInsightProperty.md b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightProperty.md new file mode 100644 index 0000000000..02ee7e3f95 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightProperty.md @@ -0,0 +1,77 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 606C5453-F841-4574-95F8-5CC29A4186E1 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/get-azhdinsightproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightProperty.md +--- + +# Get-AzHDInsightProperty + +## SYNOPSIS +Gets properties about the HDInsight service, such as available locations and capacity. + +## SYNTAX + +``` +Get-AzHDInsightProperty [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHDInsightProperty** cmdlet gets properties specific to Azure HDInsight, such as the list of available locations, HDInsight cluster versions, and available compute capacity. + +## EXAMPLES + +### Example 1: Get the properties of an Azure HDInsight cluster +```powershell +Get-AzHDInsightProperty -Location "East US 2" +``` + +This command gets properties from an HDInsight service from location East US 2. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location for which to fetch HDInsight properties. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### Microsoft.Azure.Management.HDInsight.Models.AzureHDInsightCapabilities +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/Get-AzHDInsightScriptActionHistory.md b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightScriptActionHistory.md new file mode 100644 index 0000000000..cf0727c712 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Get-AzHDInsightScriptActionHistory.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: CE690DB0-0CD4-4841-B219-C208173D4730 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/get-azhdinsightscriptactionhistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightScriptActionHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Get-AzHDInsightScriptActionHistory.md +--- + +# Get-AzHDInsightScriptActionHistory + +## SYNOPSIS +Gets the script action history for a cluster and lists it in reverse chronological order, or gets details of a previously executed script action. + +## SYNTAX + +``` +Get-AzHDInsightScriptActionHistory [-ClusterName] <String> [[-ScriptExecutionId] <Int64>] + [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHDInsightScriptActionHistory** cmdlet gets the script action history for an Azure HDInsight cluster and lists it in reverse chronological order, or gets details of a previously executed script action. + +## EXAMPLES + +### Example 1: Get the history of script actions executions for a cluster +```powershell +Get-AzHDInsightScriptActionHistory -ClusterName "your-hadoop-001" +``` + +This command gets the history of script actions for the cluster your-hadoop-001. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptExecutionId +Specifies the execution ID of the executed script action. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightRuntimeScriptActionDetail + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/Invoke-AzHDInsightHiveJob.md b/azps-10.1.0/Az.HDInsight/Invoke-AzHDInsightHiveJob.md new file mode 100644 index 0000000000..346dcfd39a --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Invoke-AzHDInsightHiveJob.md @@ -0,0 +1,266 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 3C6DCC81-82F7-4044-AFBC-4EE1BCC306F2 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/invoke-azhdinsighthivejob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Invoke-AzHDInsightHiveJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Invoke-AzHDInsightHiveJob.md +--- + +# Invoke-AzHDInsightHiveJob + +## SYNOPSIS +Submits a Hive query to an HDInsight cluster and retrieves query results in one operation. + +## SYNTAX + +``` +Invoke-AzHDInsightHiveJob [-Arguments <String[]>] [-Files <String[]>] [-StatusFolder <String>] + [-Defines <Hashtable>] [-File <String>] [-JobName <String>] [-Query <String>] [-RunAsFileJob] + [-DefaultContainer <String>] [-DefaultStorageAccountName <String>] [-DefaultStorageAccountKey <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzHDInsightHiveJob** cmdlet submits a Hive query to an Azure HDInsight cluster and retrieves query results in one operation. +Use the Use-AzHDInsightCluster cmdlet before calling **Invoke-AzHDInsightHiveJob** to specify which cluster will be used for the query. + +## EXAMPLES + +### Example 1: Submit a Hive query to an Azure HDInsight cluster +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value + + +$storageContainer = "container001" + +# Cluster info +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# Hive job details +$statusFolder = "tempStatusFolder/" +$query = "SHOW TABLES" + +Use-AzHDInsightCluster ` + -ClusterCredential $clusterCreds ` + -ClusterName $clusterName + +Invoke-AzHDInsightHiveJob -StatusFolder $statusFolder ` + -Query $query ` + -DefaultContainer $storageContainer ` + -DefaultStorageAccountName "$storageAccountName.blob.core.windows.net" ` + -DefaultStorageAccountKey $storageAccountKey +``` + +This command submits the query SHOW TABLES to the cluster named your-hadoop-001. + +## PARAMETERS + +### -Arguments +Specifies an array of arguments for the job. +The arguments are passed as command-line arguments to each task. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultContainer +Specifies the name of the default container in the default Azure Storage account that an HDInsight cluster uses. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultStorageAccountKey +Specifies the account key for the default storage account that the HDInsight cluster uses. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultStorageAccountName +Specifies the name of the default storage account that the HDInsight cluster uses. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Defines +Specifies Hadoop configuration values to set when a job runs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +Specifies the path to a file in Azure Storage that contains the query to run. +You can use this parameter instead of the *Query* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Files +Specifies a collection of files that are required for a Hive job. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +Specifies the name of a Hive job. +If you do not specify this parameter, this cmdlet uses the default value: "Hive: \<first 100 characters of Query\>". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Specifies the Hive query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunAsFileJob +Indicates that this cmdlet creates a file in the default Azure storage account in which to store a query. +This cmdlet submits the job that references this file as a script to run. +You can use this functionality to handle special characters such as percent sign (%) that would fail on a job submission through Templeton, because Templeton interprets a query with a percent sign as a URL parameter. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusFolder +Specifies the location of the folder that contains standard outputs and error outputs for a job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Use-AzHDInsightCluster](./Use-AzHDInsightCluster.md) + + diff --git a/azps-10.1.0/Az.HDInsight/New-AzHDInsightCluster.md b/azps-10.1.0/Az.HDInsight/New-AzHDInsightCluster.md new file mode 100644 index 0000000000..955cb1bff5 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/New-AzHDInsightCluster.md @@ -0,0 +1,1571 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 691AC991-3249-487C-A0DF-C579ED7D00E7 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/new-azhdinsightcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightCluster.md +--- + +# New-AzHDInsightCluster + +## SYNOPSIS +Creates an Azure HDInsight cluster in the specified resource group for the current subscription. + +## SYNTAX + +### Default (Default) +``` +New-AzHDInsightCluster [-Location] <String> [-ResourceGroupName] <String> [-ClusterName] <String> + [-ClusterSizeInNodes] <Int32> [-HttpCredential] <PSCredential> [[-StorageAccountResourceId] <String>] + [[-StorageAccountKey] <String>] [-StorageAccountType <StorageType>] [-Config <AzureHDInsightConfig>] + [-OozieMetastore <AzureHDInsightMetastore>] [-HiveMetastore <AzureHDInsightMetastore>] + [-AmbariDatabase <AzureHDInsightMetastore>] + [-AdditionalStorageAccounts <System.Collections.Generic.Dictionary`2[System.String,System.String]>] + [-Configurations <System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]]>] + [-ScriptActions <System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]]>] + [-StorageContainer <String>] [-StorageRootPath <String>] [-StorageFileSystem <String>] [-Version <String>] + [-HeadNodeSize <String>] [-WorkerNodeSize <String>] [-EdgeNodeSize <String>] + [-KafkaManagementNodeSize <String>] [-ZookeeperNodeSize <String>] [-ClusterType <String>] + [-ComponentVersion <System.Collections.Generic.Dictionary`2[System.String,System.String]>] + [-VirtualNetworkId <String>] [-SubnetName <String>] [-OSType <String>] [-ClusterTier <String>] + [-SshCredential <PSCredential>] [-SshPublicKey <String>] [-ObjectId <Guid>] [-ApplicationId <Guid>] + [-CertificatePassword <String>] [-AadTenantId <Guid>] [-SecurityProfile <AzureHDInsightSecurityProfile>] + [-DisksPerWorkerNode <Int32>] [-MinSupportedTlsVersion <String>] [-AssignedIdentity <String>] + [-StorageAccountManagedIdentity <String>] [-EncryptionAlgorithm <String>] [-EncryptionKeyName <String>] + [-EncryptionKeyVersion <String>] [-EncryptionVaultUri <String>] [-EncryptionInTransit <Boolean>] + [-EncryptionAtHost <Boolean>] [-AutoscaleConfiguration <AzureHDInsightAutoscale>] [-EnableIDBroker] + [-KafkaClientGroupId <String>] [-KafkaClientGroupName <String>] [-ResourceProviderConnection <String>] + [-PrivateLink <String>] [-EnableComputeIsolation] [-ComputeIsolationHostSku <String>] [-Zone <String[]>] + [-PrivateLinkConfiguration <AzureHDInsightPrivateLinkConfiguration[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### CertificateFilePath +``` +New-AzHDInsightCluster [-Location] <String> [-ResourceGroupName] <String> [-ClusterName] <String> + [-ClusterSizeInNodes] <Int32> [-HttpCredential] <PSCredential> [[-StorageAccountResourceId] <String>] + [[-StorageAccountKey] <String>] [-StorageAccountType <StorageType>] [-Config <AzureHDInsightConfig>] + [-OozieMetastore <AzureHDInsightMetastore>] [-HiveMetastore <AzureHDInsightMetastore>] + [-AmbariDatabase <AzureHDInsightMetastore>] + [-AdditionalStorageAccounts <System.Collections.Generic.Dictionary`2[System.String,System.String]>] + [-Configurations <System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]]>] + [-ScriptActions <System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]]>] + [-StorageContainer <String>] [-StorageRootPath <String>] [-StorageFileSystem <String>] [-Version <String>] + [-HeadNodeSize <String>] [-WorkerNodeSize <String>] [-EdgeNodeSize <String>] + [-KafkaManagementNodeSize <String>] [-ZookeeperNodeSize <String>] [-ClusterType <String>] + [-ComponentVersion <System.Collections.Generic.Dictionary`2[System.String,System.String]>] + [-VirtualNetworkId <String>] [-SubnetName <String>] [-OSType <String>] [-ClusterTier <String>] + [-SshCredential <PSCredential>] [-SshPublicKey <String>] [-ObjectId <Guid>] [-ApplicationId <Guid>] + [-CertificateFilePath <String>] [-CertificatePassword <String>] [-AadTenantId <Guid>] + [-SecurityProfile <AzureHDInsightSecurityProfile>] [-DisksPerWorkerNode <Int32>] + [-MinSupportedTlsVersion <String>] [-AssignedIdentity <String>] [-StorageAccountManagedIdentity <String>] + [-EncryptionAlgorithm <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionVaultUri <String>] [-EncryptionInTransit <Boolean>] [-EncryptionAtHost <Boolean>] + [-AutoscaleConfiguration <AzureHDInsightAutoscale>] [-EnableIDBroker] [-KafkaClientGroupId <String>] + [-KafkaClientGroupName <String>] [-ResourceProviderConnection <String>] [-PrivateLink <String>] + [-EnableComputeIsolation] [-ComputeIsolationHostSku <String>] [-Zone <String[]>] + [-PrivateLinkConfiguration <AzureHDInsightPrivateLinkConfiguration[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### CertificateFileContents +``` +New-AzHDInsightCluster [-Location] <String> [-ResourceGroupName] <String> [-ClusterName] <String> + [-ClusterSizeInNodes] <Int32> [-HttpCredential] <PSCredential> [[-StorageAccountResourceId] <String>] + [[-StorageAccountKey] <String>] [-StorageAccountType <StorageType>] [-Config <AzureHDInsightConfig>] + [-OozieMetastore <AzureHDInsightMetastore>] [-HiveMetastore <AzureHDInsightMetastore>] + [-AmbariDatabase <AzureHDInsightMetastore>] + [-AdditionalStorageAccounts <System.Collections.Generic.Dictionary`2[System.String,System.String]>] + [-Configurations <System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]]>] + [-ScriptActions <System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]]>] + [-StorageContainer <String>] [-StorageRootPath <String>] [-StorageFileSystem <String>] [-Version <String>] + [-HeadNodeSize <String>] [-WorkerNodeSize <String>] [-EdgeNodeSize <String>] + [-KafkaManagementNodeSize <String>] [-ZookeeperNodeSize <String>] [-ClusterType <String>] + [-ComponentVersion <System.Collections.Generic.Dictionary`2[System.String,System.String]>] + [-VirtualNetworkId <String>] [-SubnetName <String>] [-OSType <String>] [-ClusterTier <String>] + [-SshCredential <PSCredential>] [-SshPublicKey <String>] [-ObjectId <Guid>] [-ApplicationId <Guid>] + [-CertificateFileContents <Byte[]>] [-CertificatePassword <String>] [-AadTenantId <Guid>] + [-SecurityProfile <AzureHDInsightSecurityProfile>] [-DisksPerWorkerNode <Int32>] + [-MinSupportedTlsVersion <String>] [-AssignedIdentity <String>] [-StorageAccountManagedIdentity <String>] + [-EncryptionAlgorithm <String>] [-EncryptionKeyName <String>] [-EncryptionKeyVersion <String>] + [-EncryptionVaultUri <String>] [-EncryptionInTransit <Boolean>] [-EncryptionAtHost <Boolean>] + [-AutoscaleConfiguration <AzureHDInsightAutoscale>] [-EnableIDBroker] [-KafkaClientGroupId <String>] + [-KafkaClientGroupName <String>] [-ResourceProviderConnection <String>] [-PrivateLink <String>] + [-EnableComputeIsolation] [-ComputeIsolationHostSku <String>] [-Zone <String[]>] + [-PrivateLinkConfiguration <AzureHDInsightPrivateLinkConfiguration[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzHDInsightCluster creates an Azure HDInsight cluster by using the specified parameters or by using a configuration object that is created by using the New-AzHDInsightClusterConfig cmdlet. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /servicePrincipals/{id} + +## EXAMPLES + +### Example 1: Create an Azure HDInsight cluster +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = Get-AzStorageAccountKey ` + -ResourceGroupName $storageAccountResourceGroupName ` + -Name $storageAccountName | Where-Object {$_.KeyName -eq "key1"} | ForEach-Object{$_.Value} +$storageContainer = "container002" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Create the cluster +New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer ` + -SshCredential $clusterCreds +``` + +This command creates a cluster in the current subscription. + +### Example 2: Create cluster with customer-managed key disk encryption +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = Get-AzStorageAccountKey ` + -ResourceGroupName $storageAccountResourceGroupName ` + -Name $storageAccountName | Where-Object {$_.KeyName -eq "key1"} | ForEach-Object{$_.Value} +$storageContainer = "container002" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-cmk-cluster" +$clusterCreds = Get-Credential + +# Customer-managed Key info +$assignedIdentity = "your-ami-resource-id" +$encryptionKeyName = "new-key" +$encryptionVaultUri = "https://MyKeyVault.vault.azure.net" +$encryptionKeyVersion = "00000000000000000000000000000000" + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Create the cluster +New-AzHDInsightCluster ` + -ClusterType Spark ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer ` + -SshCredential $clusterCreds ` + -AssignedIdentity $assignedIdentity ` + -EncryptionKeyName $encryptionKeyName ` + -EncryptionVaultUri $encryptionVaultUri ` + -EncryptionKeyVersion $encryptionKeyVersion +``` + +### Example 3: Create an Azure HDInsight cluster which enables encryption in transit +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = Get-AzStorageAccountKey ` + -ResourceGroupName $storageAccountResourceGroupName ` + -Name $storageAccountName | Where-Object {$_.KeyName -eq "key1"} | ForEach-Object{$_.Value} +$storageContainer = "container002" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Create the cluster +New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer ` + -SshCredential $clusterCreds ` + -EncryptionInTransit $true +``` + +### Example 4: Create an Azure HDInsight cluster with relay outbound and private link feature +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = Get-AzStorageAccountKey ` + -ResourceGroupName $storageAccountResourceGroupName ` + -Name $storageAccountName | Where-Object {$_.KeyName -eq "key1"} | ForEach-Object{$_.Value} +$storageContainer = "container002" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Virtual network info +$virtualNetworkId="yourvnetresourceid" +$subnetName="yoursubnetname" + +# Create the cluster +New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer ` + -SshCredential $clusterCreds ` + -VirtualNetworkId $virtualNetworkId -SubnetName $subnetName ` + -ResourceProviderConnection Outbound -PrivateLink Enabled +``` + +### Example 5: Create an Azure HDInsight cluster which enables encryption at host +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = Get-AzStorageAccountKey ` + -ResourceGroupName $storageAccountResourceGroupName ` + -Name $storageAccountName | Where-Object {$_.KeyName -eq "key1"} | ForEach-Object{$_.Value} +$storageContainer = "container002" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Create the cluster +New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer ` + -SshCredential $clusterCreds ` + -EncryptionAtHost $true +``` + +### Example 6: Create an Azure HDInsight cluster which enables autoscale. +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = Get-AzStorageAccountKey ` + -ResourceGroupName $storageAccountResourceGroupName ` + -Name $storageAccountName | Where-Object {$_.KeyName -eq "key1"} | ForEach-Object{$_.Value} +$storageContainer = "container002" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Create autoscale configuration +$autoscaleConfiguration=New-AzHDInsightClusterAutoscaleConfiguration ` + -MinWorkerNodeCount 3 -MaxWorkerNodeCount 5 + +# Create the cluster +New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer ` + -SshCredential $clusterCreds ` + -AutoscaleConfiguration $autoscaleConfiguration +``` + +### Example 7: Create an Azure HDInsight cluster with Kafka Rest Proxy. +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = Get-AzStorageAccountKey ` + -ResourceGroupName $storageAccountResourceGroupName ` + -Name $storageAccountName | Where-Object {$_.KeyName -eq "key1"} | ForEach-Object{$_.Value} +$storageContainer = "container002" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Kafka Rest Proxy configuration info +$kafkaClientGroupName = "yourclientgroupname" +$kafkaClientGroupId = "yourclientgroupid" +$kafkaManagementNodeSize = "Standard_D4_v2" +$disksPerWorkerNode = 2 + +# Create the cluster +New-AzHDInsightCluster ` + -ClusterType Kafka ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer ` + -SshCredential $clusterCreds ` + -KafkaClientGroupId $kafkaClientGroupId -KafkaClientGroupName $kafkaClientGroupName ` + -KafkaManagementNodeSize $kafkaManagementNodeSize -DisksPerWorkerNode $disksPerWorkerNode +``` + +### Example 8: Create an Azure HDInsight cluster with Azure Data Lake Gen2 storage. +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageManagedIdentity = "yourstorageusermanagedidentity" +$storageFileSystem = "filesystem01" +$storageAccountType = "AzureDataLakeStorageGen2" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Create the cluster +New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -ClusterSizeInNodes 3 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountManagedIdentity $storageManagedIdentity ` + -StorageFileSystem $storageFileSystem ` + -StorageAccountType $storageAccountType ` + -SshCredential $clusterCreds +``` + +### Example 9: Create an Azure HDInsight cluster with Enterprise Security Package(ESP) and Enable HDInsight ID Broker. +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountKey = "yourstorageaccountaccesskey" +$storageContainer = "yourcontainer01" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# ESP configuration +$domainResourceId = "your Azure AD Domin Service resource id" +$domainUser = "yourdomainuser" +$domainPassword = "yourdoaminpasswd" +$domainPassword = ConvertTo-SecureString $domainPassword -AsPlainText -Force +$domainCredential = New-Object System.Management.Automation.PSCredential($domainUser, $domainPassword) +$clusterUserGroupDns = "dominusergroup" +$ldapUrls = "ldaps://{your domain name}:636" + +$clusterTier = "Premium" +$vnetId = "yourvnetid" +$subnetName = "yoursubnetname" +$assignedIdentity = "your user managed assigned identity resourcee id" + +#Create security profile +$config= New-AzHDInsightClusterConfig|Add-AzHDInsightSecurityProfile -DomainResourceId $domainResourceId -DomainUserCredential $domainCredential -LdapsUrls $ldapUrls -ClusterUsersGroupDNs $clusterUserGroupDns + +# Create the cluster +New-AzHDInsightCluster ` + -ClusterTier $clusterTier ` + -ClusterType Hadoop ` + -ClusterSizeInNodes 3 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer ` + -SshCredential $clusterCreds ` + -VirtualNetworkId $vnetId -SubnetName $subnetName ` + -AssignedIdentity $assignedIdentity ` + -SecurityProfile $config.SecurityProfile -EnableIDBroker +``` + +### Example 10: Create an Azure HDInsight cluster which enables compute isolation. +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = Get-AzStorageAccountKey ` + -ResourceGroupName $storageAccountResourceGroupName ` + -Name $storageAccountName | Where-Object {$_.KeyName -eq "key1"} | ForEach-Object{$_.Value} +$storageContainer = "container002" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential +$workerNodeSize="Standard_E16S_V3" # here is just an example +$headNodeSize="Standard_E8S_V3" +$zookeeperNodeSize="Standard_E2S_V3" + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Create the cluster +New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -ClusterSizeInNodes 4 ` + -WorkerNodeSize $workerNodeSize ` + -HeadNodeSize $headNodeSize ` + -ZookeeperNodeSize $zookeeperNodeSize ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer ` + -SshCredential $clusterCreds ` + -EnableComputeIsolation +``` + +### Example 11: Create an Azure HDInsight cluster with private link configuration feature +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = Get-AzStorageAccountKey ` + -ResourceGroupName $storageAccountResourceGroupName ` + -Name $storageAccountName | Where-Object {$_.KeyName -eq "key1"} | ForEach-Object{$_.Value} +$storageContainer = "container002" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Virtual network info +$virtualNetworkId="yourvnetresourceid" +$subnetName="yoursubnetname" + +$ipConfigName="ipconfig" +$privateIPAllocationMethod="dynamic" # the only supported IP allocation method for private link IP configuration is dynamic +$subnetId=$vnetId+"/subnets/"+$subnetName +# Create Private IP configuration +$ipConfiguration= New-AzHDInsightIPConfiguration -Name $ipConfigName -PrivateIPAllocationMethod $privateIPAllocationMethod -SubnetId $subnetId -Primary + +$privateLinkConfigurationName="plconfig" +$groupId="headnode" +# Create private link configuration +$privateLinkConfiguration= New-AzHDInsightPrivateLinkConfiguration -Name $privateLinkConfigurationName -GroupId $groupId -IPConfiguration $ipConfiguration + +# Create the cluster +New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer ` + -SshCredential $clusterCreds ` + -VirtualNetworkId $virtualNetworkId -SubnetName $subnetName ` + -ResourceProviderConnection Outbound -PrivateLink Enabled -PrivateLinkConfiguration $privateLinkConfiguration +``` + +### Example 12: Create an Azure HDInsight cluster availability feature +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageacct001" +$storageAccountKey = Get-AzStorageAccountKey ` + -ResourceGroupName $storageAccountResourceGroupName ` + -Name $storageAccountName | Where-Object {$_.KeyName -eq "key1"} | ForEach-Object{$_.Value} +$storageContainer = "container002" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Virtual network info +$virtualNetworkId="yourvnetresourceid" +$subnetName="yoursubnetname" + +$databaseUserName="yourusername" +$databasePassword="******" +$databasePassword=ConvertTo-SecureString $databasePassword -AsPlainText -Force + +$sqlserverCredential=New-Object System.Management.Automation.PSCredential($databaseUserName, $databasePassword) +$sqlserver="yoursqlserver.database.windows.net" +$ambariDatabase="ambaridb" +$hiveDatabase ="hivedb" +$oozieDatabase = "ooziedb" + +# availability zone feature requires customer ambari database, hive metatastore and oozie metastore +# Create Ambari database +$config=New-AzHDInsightClusterConfig|Add-AzHDInsightMetastore ` +-SqlAzureServerName $sqlserver -DatabaseName $ambariDatabase ` +-Credential $sqlserverCredential -MetastoreType AmbariDatabase + +# Create Hive metastore +$config=$config|Add-AzHDInsightMetastore ` +-SqlAzureServerName $sqlserver -DatabaseName $hiveDatabase ` +-Credential $sqlserverCredential -MetastoreType HiveMetastore + +# Create Oozie metastore +$config=$config|Add-AzHDInsightMetastore ` +-SqlAzureServerName $sqlserver -DatabaseName $oozieDatabase ` +-Credential $sqlserverCredential -MetastoreType OozieMetastore + +# availability zones +$zones="1" + +# Create the cluster +New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer ` + -SshCredential $clusterCreds ` + -VirtualNetworkId $virtualNetworkId -SubnetName $subnetName ` + -AmbariDatabase $config.AmbariDatabase -HiveMetastore $config.HiveMetastore -OozieMetastore $config.OozieMetastore -Zone $zones +``` + +## PARAMETERS + +### -AadTenantId +Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdditionalStorageAccounts +Specifies the additional Azure Storage accounts for the cluster. +You can alternatively use the Add-AzHDInsightStorage cmdlet. + +```yaml +Type: System.Collections.Generic.Dictionary`2[System.String,System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AmbariDatabase +Gets or sets the database for ambari. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightMetastore +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +Gets or sets the Service Principal Application Id for accessing Azure Data Lake. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignedIdentity +Gets or sets the assigned identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleConfiguration +Gets or sets the autoscale configuration + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightAutoscale +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateFileContents +Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store. + +```yaml +Type: System.Byte[] +Parameter Sets: CertificateFileContents +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateFilePath +Specifies the file path to the certificate that will be used to authenticate as the Service Principal. +The cluster will use this when accessing Azure Data Lake Store. + +```yaml +Type: System.String +Parameter Sets: CertificateFilePath +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificatePassword +Specifies the password for the certificate that will be used to authenticate as the Service Principal. +The cluster will use this when accessing Azure Data Lake Store. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterSizeInNodes +Specifies the number of Worker nodes for the cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterTier +Specifies the HDInsight cluster tier. +By default, this is Standard. +The Premium tier can only be used with Linux clusters, and it enables the use of some new features. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Standard, Premium + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +Specifies the type of cluster to create. +Options are: Hadoop, HBase, Storm, Spark, INTERACTIVEHIVE, Kafka, and RServer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComponentVersion +```yaml +Type: System.Collections.Generic.Dictionary`2[System.String,System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeIsolationHostSku +Gets or sets the dedicated host sku for compute isolation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Config +Specifies the cluster object to be used to create the cluster. +This object can be created by using the New-AzHDInsightClusterConfig cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Configurations +Specifies the configurations of this HDInsight cluster. +You can alternatively use the Add-AzHDInsightConfigValues cmdlet. + +```yaml +Type: System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisksPerWorkerNode +Specifies the number of disks for worker node role in the cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeNodeSize +Specifies the size of the virtual machine for the edge node. Use Get-AzVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for RServer clusters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableComputeIsolation +Enables HDInsight compute isolation feature. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableIDBroker +Enables HDInsight Identity Broker feature. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionAlgorithm +Gets or sets the encryption algorithm. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: RSA-OAEP, RSA-OAEP-256, RSA1_5 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionAtHost +Gets or sets the flag which indicates whether enable encryption at host or not. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionInTransit +Gets or sets the flag which indicates whether enable encryption in transit or not. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyName +Gets or sets the encryption key name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyVersion +Gets or sets the encryption key version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionVaultUri +Gets or sets the encryption vault uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeadNodeSize +Specifies the size of the virtual machine for the Head node. +Use Get-AzVMSize for acceptable VM sizes, and see HDInsight's pricing page. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiveMetastore +Specifies the SQL Database to store Hive metadata. +You can alternatively use the Add-AzHDInsightMetastore cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightMetastore +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpCredential +Specifies the cluster login (HTTP) credentials for the cluster. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KafkaClientGroupId +Gets or sets the client group id for Kafka Rest Proxy access. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KafkaClientGroupName +Gets or sets the client group name for Kafka Rest Proxy access. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KafkaManagementNodeSize +Gets or sets the size of the Kafka Management Node. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location for the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinSupportedTlsVersion +Gets or sets the minimal supported TLS version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +Specifies the Azure AD object ID (a GUID) of the Azure AD Service Principal that represents the cluster. +The cluster will use this when accessing Azure Data Lake Store. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OozieMetastore +Specifies the SQL Database to store Oozie metadata. +You can alternatively use the Add-AzHDInsightMetastore cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightMetastore +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSType +Specifies the operating system for the cluster. +Options are: Windows, Linux + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Linux + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLink +Gets or sets the private link type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkConfiguration +Gets or sets the private link configuration. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightPrivateLinkConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceProviderConnection +Gets or sets the resource provider connection type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Inbound, Outbound + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptActions +Specifies the script actions to run on the cluster at the end of cluster creation. +You can alternatively use Add-AzHDInsightScriptAction. + +```yaml +Type: System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]] +Parameter Sets: (All) +Aliases: +Accepted values: HeadNode, WorkerNode, ZookeeperNode, EdgeNode + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityProfile +Specifies the security related properties used to create a secure cluster. +You can alternatively use the Add-AzHDInsightSecurityProfile cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightSecurityProfile +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshCredential +Specifies the SSH credential to be used for SSH connections. +This is only for Linux clusters. + +```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 +``` + +### -SshPublicKey +Specifies the public key to be used for SSH connections. +This is only for Linux clusters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountKey +Gets or sets the Storage Account Access Key for the Storage Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountManagedIdentity +Gets or sets the storage account managed identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Gets or sets the Storage Resource Id for the Storage Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountType +Gets or sets the type of the storage account. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.HDInsight.Models.Management.StorageType] +Parameter Sets: (All) +Aliases: +Accepted values: AzureStorage, AzureDataLakeStore, AzureDataLakeStorageGen2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainer +Gets or sets the StorageContainer name for the default Azure Storage Account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageFileSystem +Gets or sets the file system for the default Azure Data Lake Storage Gen2 account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageRootPath +Gets or sets the path to the root of the cluster in the default Data Lake Store Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetName +Gets or sets the subnet name for this HDInsight cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Specifies the HDI version of the HDInsight cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkId +Specifies the ID of the virtual network into which to provision the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkerNodeSize +Specifies the size of the virtual machine for the Worker node. +Use Get-AzVMSize for acceptable VM sizes, and see HDInsight's pricing page. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +Gets or sets the availability zones. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZookeeperNodeSize +Specifies the size of the virtual machine for the Zookeeper node. +Use Get-AzVMSize for acceptable VM sizes, and see HDInsight's pricing page. +This parameter is valid only for HBase or Storm clusters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + +## RELATED LINKS + +[New-AzHDInsightClusterConfig](./New-AzHDInsightClusterConfig.md) + diff --git a/azps-10.1.0/Az.HDInsight/New-AzHDInsightClusterAutoscaleConfiguration.md b/azps-10.1.0/Az.HDInsight/New-AzHDInsightClusterAutoscaleConfiguration.md new file mode 100644 index 0000000000..7fbacef887 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/New-AzHDInsightClusterAutoscaleConfiguration.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 86276DF3-95E2-405F-BA46-F188B7AE3B9B +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/new-azhdinsightclusterautoscaleconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightClusterAutoscaleConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightClusterAutoscaleConfiguration.md +--- + +# New-AzHDInsightClusterAutoscaleConfiguration + +## SYNOPSIS +Creates a non-persisted object that describes the autoscale configuration of an Azure HDInsight cluster. + +## SYNTAX + +### LoadAutoscaleParameterSet (Default) +``` +New-AzHDInsightClusterAutoscaleConfiguration -MinWorkerNodeCount <Int32> -MaxWorkerNodeCount <Int32> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ScheduleAutoscaleParameterSet +``` +New-AzHDInsightClusterAutoscaleConfiguration -TimeZone <String> + -Condition <System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightAutoscaleCondition]> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The cmdlet **New-AzHDInsightClusterAutoscaleConfiguration** creates a non-persisted object that describes the autoscale configuration of an Azure HDInsight cluster. + +## EXAMPLES + +### Example 1: Create an object which describes Load-based autoscale configuration +```powershell +New-AzHDInsightClusterAutoscaleConfiguration -MinWorkerNodeCount 3 -MaxWorkerNodeCount 5 +``` + +This command creates an object which describes Load-based autoscale configuration. + +### Example 2: Create an object which describes Schedule-based autoscale configuration +```powershell +# Create an autoscale condition firstly +$condition=New-AzHDInsightClusterAutoscaleScheduleCondition -Day Monday -Time 09:00 -WorkerNodeCount 5 +New-AzHDInsightClusterAutoscaleConfiguration -TimeZone ([System.TimeZoneInfo]::Local).Id ` + -Condition $condition +``` + +This command creates an object which describes Schedule-based autoscale configuration. + +## PARAMETERS + +### -Condition +Gets or sets the condition of schedule-based autoscale. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightAutoscaleCondition] +Parameter Sets: ScheduleAutoscaleParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxWorkerNodeCount +Gets or sets the maximal workernode count of load-based autoscale. + +```yaml +Type: System.Int32 +Parameter Sets: LoadAutoscaleParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinWorkerNodeCount +Gets or sets the minimal workernode count of load-based autoscale. + +```yaml +Type: System.Int32 +Parameter Sets: LoadAutoscaleParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeZone +Gets or sets the time zone of schedule-based autoscale. + +```yaml +Type: System.String +Parameter Sets: ScheduleAutoscaleParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightAutoscale + +## NOTES + +## RELATED LINKS + +[Set-AzHDInsightClusterAutoscaleConfiguration](./Set-AzHDInsightClusterAutoscaleConfiguration.md) +[Get-AzHDInsightClusterAutoscaleConfiguration](./Get-AzHDInsightClusterAutoscaleConfiguration.md) +[Remove-AzHDInsightClusterAutoscaleConfiguration](./Remove-AzHDInsightClusterAutoscaleConfiguration.md) diff --git a/azps-10.1.0/Az.HDInsight/New-AzHDInsightClusterAutoscaleScheduleCondition.md b/azps-10.1.0/Az.HDInsight/New-AzHDInsightClusterAutoscaleScheduleCondition.md new file mode 100644 index 0000000000..9db0f87053 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/New-AzHDInsightClusterAutoscaleScheduleCondition.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 86276DF3-95E2-405F-BA46-F188B7AE3B9B +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/new-azhdinsightclusterautoscaleschedulecondition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightClusterAutoscaleScheduleCondition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightClusterAutoscaleScheduleCondition.md +--- + +# New-AzHDInsightClusterAutoscaleScheduleCondition + +## SYNOPSIS +Creates Schedule-based autoscale condition. + +## SYNTAX + +``` +New-AzHDInsightClusterAutoscaleScheduleCondition -Time <DateTime> -WorkerNodeCount <Int32> + -Day <AzureHDInsightDaysOfWeek[]> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzHDInsightClusterAutoscaleScheduleCondition** cmdlet creates Schedule-based autoscale condition. + +## EXAMPLES + +### Example 1 +```powershell +New-AzHDInsightClusterAutoscaleScheduleCondition -Time 09:00 -WorkerNodeCount 5 -Day Monday,Wednesday +``` + +This command creates a condition where cluster autoscale to 5 worker nodes at 09:00 every Monday, Wednesday. + +### Example 2: Enable Schedule-based autoscale of a cluster with autoscale condition. +```powershell +# create a autoscale condition +$condition=New-AzHDInsightClusterAutoscaleScheduleCondition -Time 09:00 -WorkerNodeCount 5 -Day Monday,Wednesday + +# Set the cluster autoscale configuration +$clusterResourceGroup="group" +$clusterName="MyCluster" +Set-AzHDInsightClusterAutoscaleConfiguration -ResourceGroupName $clusterResourceGroup -ClusterName $clusterName -Schedule -TimeZone "Pacific Standard Time" -Condition $condition +``` + +This command creates a condition where cluster autoscale to 5 worker nodes at 09:00 every Monday, Wednesday. + +## PARAMETERS + +### -Day +Gets or sets the days of Autoscale schedule condition. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightDaysOfWeek[] +Parameter Sets: (All) +Aliases: +Accepted values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Time +Gets or sets the time of Autoscale schedule condition. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkerNodeCount +Gets or sets the schedule workernode count of Autoscale schedule condition. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightAutoscaleCondition + +## NOTES + +## RELATED LINKS + +[New-AzHDInsightClusterAutoscaleConfiguration](./New-AzHDInsightClusterAutoscaleConfiguration.md) +[Set-AzHDInsightClusterAutoscaleConfiguration](./Set-AzHDInsightClusterAutoscaleConfiguration.md) diff --git a/azps-10.1.0/Az.HDInsight/New-AzHDInsightClusterConfig.md b/azps-10.1.0/Az.HDInsight/New-AzHDInsightClusterConfig.md new file mode 100644 index 0000000000..81b1dafa54 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/New-AzHDInsightClusterConfig.md @@ -0,0 +1,509 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 2C06626F-E5A9-48C2-AEA2-B448AD254C2E +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/new-azhdinsightclusterconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightClusterConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightClusterConfig.md +--- + +# New-AzHDInsightClusterConfig + +## SYNOPSIS +Creates a non-persisted cluster configuration object that describes an Azure HDInsight cluster configuration. + +## SYNTAX + +``` +New-AzHDInsightClusterConfig [-StorageAccountResourceId <String>] [-StorageAccountKey <String>] + [-StorageAccountType <StorageType>] [-OozieMetastore <AzureHDInsightMetastore>] + [-HiveMetastore <AzureHDInsightMetastore>] [-HeadNodeSize <String>] [-WorkerNodeSize <String>] + [-EdgeNodeSize <String>] [-ZookeeperNodeSize <String>] [-ClusterType <String>] [-ClusterTier <String>] + [-ObjectId <Guid>] [-ApplicationId <Guid>] [-CertificateFileContents <Byte[]>] [-CertificateFilePath <String>] + [-CertificatePassword <String>] [-AadTenantId <Guid>] [-MinSupportedTlsVersion <String>] + [-AssignedIdentity <String>] [-EncryptionAlgorithm <String>] [-EncryptionKeyName <String>] + [-EncryptionKeyVersion <String>] [-EncryptionVaultUri <String>] [-EncryptionInTransit <Boolean>] + [-EncryptionAtHost <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzHDInsightClusterConfig** cmdlet creates a non-persisted object that describes an Azure HDInsight cluster configuration. + +## EXAMPLES + +### Example 1: Create a cluster configuration object +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageaccountname" +$storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value + + +$storageContainer = "container002" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Create the cluster +New-AzHDInsightClusterConfig ` + | Add-AzHDInsightStorage ` + -StorageAccountName "$secondStorageAccountName.blob.core.contoso.net" ` + -StorageAccountKey $key2 ` + | New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -OSType Windows ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $storageAccountKey ` + -StorageContainer $storageContainer +``` + +This command creates a cluster configuration object. + +## PARAMETERS + +### -AadTenantId +Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +Gets or sets the Service Principal Application Id for accessing Azure Data Lake. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignedIdentity +Gets or sets the assigned identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateFileContents +Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store. + +```yaml +Type: System.Byte[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateFilePath +Specifies the file path to the certificate that will be used to authenticate as the Service Principal. +The cluster will use this when accessing Azure Data Lake Store. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificatePassword +Specifies the password for the certificate that will be used to authenticate as the Service Principal. +The cluster will use this when accessing Azure Data Lake Store. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterTier +Specifies the HDInsight cluster tier. +The acceptable values for this parameter are: +- Standard +- Premium +The default value is Standard. +The Premium tier can only be used with Linux clusters, and it enables the use of some new features. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Standard, Premium + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +Specifies the type of cluster to create. +The acceptable values for this parameter are: +- Hadoop +- HBase +- Storm +- Spark +- INTERACTIVEHIVE +- Kafka +- RServer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeNodeSize +Specifies the size of the virtual machine for the edge node. Use Get-AzVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for RServer clusters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionAlgorithm +Gets or sets the encryption algorithm. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: RSA-OAEP, RSA-OAEP-256, RSA1_5 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionAtHost +Gets or sets the flag which indicates whether enable encryption at host or not. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionInTransit +Gets or sets the flag which indicates whether enable encryption in transit or not. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyName +Gets or sets the encryption key name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyVersion +Gets or sets the encryption key version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionVaultUri +Gets or sets the encryption vault uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeadNodeSize +Specifies the size of the virtual machine for the Head node. +Use Get-AzVMSize for acceptable VM sizes, and see HDInsight's pricing page. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiveMetastore +Specifies the metastore to store Hive metadata. +You can alternatively use the Add-AzHDInsightMetastore cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightMetastore +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinSupportedTlsVersion +Gets or sets the minimal supported TLS version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +Specifies the Azure AD object ID (a GUID) of the Azure AD Service Principal that represents the cluster. +The cluster will use this when accessing Azure Data Lake Store. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OozieMetastore +Specifies the metastore to store Oozie metadata. +You can alternatively use the **Add-AzHDInsightMetastore** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightMetastore +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountKey +Gets or sets the storage account access key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Gets or sets the storage account resource id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountType +Gets or sets the type of the default storage account. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.Management.StorageType +Parameter Sets: (All) +Aliases: +Accepted values: AzureStorage, AzureDataLakeStore, AzureDataLakeStorageGen2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkerNodeSize +Specifies the size of the virtual machine for the Worker node. +Use Get-AzVMSize for acceptable VM sizes, and see HDInsight's pricing page. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZookeeperNodeSize +Specifies the size of the virtual machine for the Zookeeper node. +Use Get-AzVMSize for acceptable VM sizes, and see HDInsight's pricing page. +This parameter is valid only for HBase or Storm clusters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## NOTES + +## RELATED LINKS + +[Add-AzHDInsightStorage](./Add-AzHDInsightStorage.md) + + diff --git a/azps-10.1.0/Az.HDInsight/New-AzHDInsightHiveJobDefinition.md b/azps-10.1.0/Az.HDInsight/New-AzHDInsightHiveJobDefinition.md new file mode 100644 index 0000000000..8f58730622 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/New-AzHDInsightHiveJobDefinition.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 580D3388-4E18-4E67-866F-1FCF5E54AB3A +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/new-azhdinsighthivejobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightHiveJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightHiveJobDefinition.md +--- + +# New-AzHDInsightHiveJobDefinition + +## SYNOPSIS +Creates a Hive job object. + +## SYNTAX + +``` +New-AzHDInsightHiveJobDefinition [-Arguments <String[]>] [-Files <String[]>] [-StatusFolder <String>] + [-Defines <Hashtable>] [-File <String>] [-JobName <String>] [-Query <String>] [-RunAsFileJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzHDInsightHiveJobDefinition** cmdlet defines a Hive job object for use with an Azure HDInsight cluster. + +## EXAMPLES + +### Example 1: Create a Hive job definition +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# Hive job details +$statusFolder = "<status folder>" +$query = "SHOW TABLES" + +New-AzHDInsightHiveJobDefinition -StatusFolder $statusFolder ` + -Query $query ` + | Start-AzHDInsightJob ` + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds +``` + +This command creates a Hive job definition. + +## PARAMETERS + +### -Arguments +Specifies an array of arguments for the job. +The arguments are passed as command-line arguments to each task. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Defines +Specifies Hadoop configuration values to set for when the job runs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +Specifies the path to a file that contains the query to run. +The file must be available on the storage account associated with the cluster. +You can use this parameter instead of the *Query* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Files +Specifies a collection of files that are associated with a Hive job. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +Specifies the name of the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Specifies the Hive query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunAsFileJob +Indicates that this cmdlet creates a file in the default Azure storage account in which to store a query. +This cmdlet submits the job that references this file as a script to run. +You can use this functionality to handle special characters such as percent sign (%) that would fail on a job submission through Templeton, because Templeton interprets a query with a percent sign as a URL parameter. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusFolder +Specifies the location of the folder that contains standard outputs and error outputs for a job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightHiveJobDefinition + +## NOTES + +## RELATED LINKS + +[Start-AzHDInsightJob](./Start-AzHDInsightJob.md) + + diff --git a/azps-10.1.0/Az.HDInsight/New-AzHDInsightIPConfiguration.md b/azps-10.1.0/Az.HDInsight/New-AzHDInsightIPConfiguration.md new file mode 100644 index 0000000000..c18e74015d --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/New-AzHDInsightIPConfiguration.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/new-azhdinsightipconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightIPConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightIPConfiguration.md +--- + +# New-AzHDInsightIPConfiguration + +## SYNOPSIS +Creates the IP configuration of private link configuration. + +## SYNTAX + +``` +New-AzHDInsightIPConfiguration [-Name <String>] [-Primary] [-PrivateIPAddress <String>] + [-PrivateIPAllocationMethod <String>] [-SubnetId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet **New-AzHDInsightIPConfiguration** creates the ip configuration in memeory. + +## EXAMPLES + +### Example 1 +```powershell +$vnetId="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet" +$subnetName="default" +$ipConfigName="ipconfig" +$privateIPAllocationMethod="dynamic" +$subnetId=$vnetId+"/subnets/"+$subnetName +# Create Private IP configuration +$ipConfiguration= New-AzHDInsightIPConfiguration -Name $ipConfigName -PrivateIPAllocationMethod $privateIPAllocationMethod -SubnetId $subnetId -Primary +``` + +This creates the ip configuration object in memory. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets the ip configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Primary +Gets or sets the flag indicates whether this IP configuration is primary for the corresponding NIC. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIPAddress +Gets or sets the private ip address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIPAllocationMethod +Gets or sets the private ip allocation method. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: dynamic, static + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Gets or sets the subnet resource id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightIPConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/New-AzHDInsightMapReduceJobDefinition.md b/azps-10.1.0/Az.HDInsight/New-AzHDInsightMapReduceJobDefinition.md new file mode 100644 index 0000000000..8b155938fa --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/New-AzHDInsightMapReduceJobDefinition.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 6BF6F9A7-BED3-4CCE-9E0A-46ECBFF55DA9 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/new-azhdinsightmapreducejobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightMapReduceJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightMapReduceJobDefinition.md +--- + +# New-AzHDInsightMapReduceJobDefinition + +## SYNOPSIS +Creates a MapReduce job object. + +## SYNTAX + +``` +New-AzHDInsightMapReduceJobDefinition [-Arguments <String[]>] [-Files <String[]>] [-StatusFolder <String>] + -ClassName <String> [-Defines <Hashtable>] -JarFile <String> [-JobName <String>] [-LibJars <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzHDInsightMapReduceJobDefinition** cmdlet defines a new MapReduce job for use with an Azure HDInsight cluster. + +## EXAMPLES + +### Example 1: Create a MapReduce job definition +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +New-AzHDInsightMapReduceJobDefinition -StatusFolder $statusFolder ` + -ClassName $className ` + -JarFile $jarFilePath ` + | Start-AzHDInsightJob ` + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds +``` + +This command creates a MapReduce job definition. + +## PARAMETERS + +### -Arguments +Specifies an array of arguments for the job. +The arguments are passed as command-line arguments to each task. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassName +Specifies the job class in the JAR file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Defines +Specifies Hadoop configuration values to set for when the job runs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Files +Specifies a collection of files that are associated with a Hive job. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JarFile +Specifies the JAR file to use for the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +Specifies the name of the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LibJars +Specifies the lib JARS for the job. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusFolder +Specifies the location of the folder that contains standard outputs and error outputs for a job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightMapReduceJobDefinition + +## NOTES + +## RELATED LINKS + +[Start-AzHDInsightJob](./Start-AzHDInsightJob.md) + + diff --git a/azps-10.1.0/Az.HDInsight/New-AzHDInsightPigJobDefinition.md b/azps-10.1.0/Az.HDInsight/New-AzHDInsightPigJobDefinition.md new file mode 100644 index 0000000000..535cbc99eb --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/New-AzHDInsightPigJobDefinition.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: B9BA5FD1-A4F8-4E24-8FCB-847649B82AB6 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/new-azhdinsightpigjobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightPigJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightPigJobDefinition.md +--- + +# New-AzHDInsightPigJobDefinition + +## SYNOPSIS +Creates a Pig job object. + +## SYNTAX + +``` +New-AzHDInsightPigJobDefinition [-Arguments <String[]>] [-Files <String[]>] [-StatusFolder <String>] + [-File <String>] [-Query <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzHDInsightPigJobDefinition** cmdlet defines a Pig job object for use with an Azure HDInsight cluster. + +## EXAMPLES + +### Example 1: Create a Pig job definition +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# Pig job details +$statusFolder = "tempStatusFolder/" +$query = "SHOW TABLES" + +New-AzHDInsightPigJobDefinition -StatusFolder $statusFolder ` + -Query $query ` + | Start-AzHDInsightJob ` + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds +``` + +This command creates a Pig job definition. + +## PARAMETERS + +### -Arguments +Specifies an array of arguments for the job. +The arguments are passed as command-line arguments to each task. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +Specifies the path to a file that contains the query to run. +The file must be available on the storage account associated with the cluster. +You can use this parameter instead of the *Query* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Files +Specifies a collection of files that are associated with a Hive job. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Specifies the Pig query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusFolder +Specifies the location of the folder that contains standard outputs and error outputs for a job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightPigJobDefinition + +## NOTES + +## RELATED LINKS + +[Start-AzHDInsightJob](./Start-AzHDInsightJob.md) + + diff --git a/azps-10.1.0/Az.HDInsight/New-AzHDInsightPrivateLinkConfiguration.md b/azps-10.1.0/Az.HDInsight/New-AzHDInsightPrivateLinkConfiguration.md new file mode 100644 index 0000000000..a12d68236b --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/New-AzHDInsightPrivateLinkConfiguration.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/new-azhdinsightprivatelinkconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightPrivateLinkConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightPrivateLinkConfiguration.md +--- + +# New-AzHDInsightPrivateLinkConfiguration + +## SYNOPSIS +Creates the private link configuration of the HDInsight cluster. + +## SYNTAX + +``` +New-AzHDInsightPrivateLinkConfiguration [-Name <String>] [-GroupId <String>] + [-IpConfiguration <AzureHDInsightIPConfiguration[]>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet **New-AzHDInsightPrivateLinkConfiguration** creates the private link configuration in memeory + +## EXAMPLES + +### Example 1 +```powershell +$vnetId="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet" +$subnetName="default" +$ipConfigName="ipconfig" +$privateIPAllocationMethod="dynamic" +$subnetId=$vnetId+"/subnets/"+$subnetName +# Create Private IP configuration +$ipConfiguration= New-AzHDInsightIPConfiguration -Name $ipConfigName -PrivateIPAllocationMethod $privateIPAllocationMethod -SubnetId $subnetId -Primary + +$privateLinkConfigurationName="plconfig" +$groupId="headnode" +# Create private link configuration +$privateLinkConfiguration= New-AzHDInsightPrivateLinkConfiguration -Name $privateLinkConfigurationName -GroupId $groupId -IPConfiguration $ipConfiguration +``` + +This cmdlet creates the private link configuration in memory. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +Gets or sets the group id of the private link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfiguration +Gets or sets the ip configurations of the private link. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightIPConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets the private link configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightPrivateLinkConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/New-AzHDInsightSqoopJobDefinition.md b/azps-10.1.0/Az.HDInsight/New-AzHDInsightSqoopJobDefinition.md new file mode 100644 index 0000000000..4b61ad6a72 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/New-AzHDInsightSqoopJobDefinition.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 4ED47646-542B-4983-B46B-B603BE33D499 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/new-azhdinsightsqoopjobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightSqoopJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightSqoopJobDefinition.md +--- + +# New-AzHDInsightSqoopJobDefinition + +## SYNOPSIS +Creates a Sqoop job object. + +## SYNTAX + +``` +New-AzHDInsightSqoopJobDefinition [-Files <String[]>] [-StatusFolder <String>] [-File <String>] + [-Command <String>] [-LibDir <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzHDInsightSqoopJobDefinition** cmdlet defines a Sqoop job object for use with an Azure HDInsight cluster. + +## EXAMPLES + +### Example 1: Create a Sqoop job definition +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +New-AzHDInsightSqoopJobDefinition -StatusFolder $statusFolder ` + -Command $sqoopCommand ` + | Start-AzHDInsightJob -ClusterName $clusterName ` + -ClusterCredential $clusterCreds +``` + +This command creates a Sqoop job definition. + +## PARAMETERS + +### -Command +Specifies the Sqoop command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +Specifies the path to a file that contains the query to run. +The file must be available on the Storage account associated with the cluster. +You can use this parameter instead of the *Query* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Files +Specifies a collection of files that are associated with a Hive job. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LibDir +Specifies the library directory for the Sqoop job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusFolder +Specifies the location of the folder that contains standard outputs and error outputs for a job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightSqoopJobDefinition + +## NOTES + +## RELATED LINKS + +[Start-AzHDInsightJob](./Start-AzHDInsightJob.md) + + diff --git a/azps-10.1.0/Az.HDInsight/New-AzHDInsightStreamingMapReduceJobDefinition.md b/azps-10.1.0/Az.HDInsight/New-AzHDInsightStreamingMapReduceJobDefinition.md new file mode 100644 index 0000000000..befeb5bbdc --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/New-AzHDInsightStreamingMapReduceJobDefinition.md @@ -0,0 +1,234 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 17CB76E7-2F91-4EFE-9DA3-F083F02235E1 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/new-azhdinsightstreamingmapreducejobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightStreamingMapReduceJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/New-AzHDInsightStreamingMapReduceJobDefinition.md +--- + +# New-AzHDInsightStreamingMapReduceJobDefinition + +## SYNOPSIS +Creates a Streaming MapReduce job object. + +## SYNTAX + +``` +New-AzHDInsightStreamingMapReduceJobDefinition [-Arguments <String[]>] [-File <String>] [-Files <String[]>] + [-StatusFolder <String>] [-CommandEnvironment <Hashtable>] [-Defines <Hashtable>] -InputPath <String> + [-Mapper <String>] [-OutputPath <String>] [-Reducer <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzHDInsightStreamingMapReduceJobDefinition** cmdlet defines a Streaming MapReduce job object for use with an Azure HDInsight cluster. + +## EXAMPLES + +### Example 1: Create a Streaming MapReduce job definition +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# Streaming MapReduce job details +$statusFolder = "tempStatusFolder/" +$query = "SHOW TABLES" + +New-AzHDInsightStreamingMapReduceJobDefinition -StatusFolder $statusFolder -File $query ` + | Start-AzHDInsightJob ` + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds +``` + +This command creates a Streaming MapReduce job definition. + +## PARAMETERS + +### -Arguments +Specifies an array of arguments for the job. +The arguments are passed as command-line arguments to each task. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandEnvironment +Specifies an array of command-line environment variables to set when a job runs on worker nodes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Defines +Specifies Hadoop configuration values to set for when the job runs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +Specifies the path to a file that contains a query to run. +You can use this parameter instead of the *Query* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Files +Specifies a collection of files that are associated with a Hive job. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputPath +Specifies the path to the input files. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mapper +Specifies a Mapper file name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputPath +Specifies the path for the job output. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reducer +Specifies a Reducer file name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusFolder +Specifies the location of the folder that contains standard outputs and error outputs for a job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightStreamingMapReduceJobDefinition + +## NOTES + +## RELATED LINKS + +[Start-AzHDInsightJob](./Start-AzHDInsightJob.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Remove-AzHDInsightCluster.md b/azps-10.1.0/Az.HDInsight/Remove-AzHDInsightCluster.md new file mode 100644 index 0000000000..b06fb52919 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Remove-AzHDInsightCluster.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 87B3C102-0A8C-4FFA-8429-594D2360AC32 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/remove-azhdinsightcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Remove-AzHDInsightCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Remove-AzHDInsightCluster.md +--- + +# Remove-AzHDInsightCluster + +## SYNOPSIS +Removes the specified HDInsight cluster from the current subscription. + +## SYNTAX + +``` +Remove-AzHDInsightCluster [-ClusterName] <String> [-ResourceGroupName <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzHDInsightCluster** cmdlet removes the specified HDInsight service cluster from a subscription. +This operation also deletes any data stored in the Hadoop Distributed File System (HDFS) on the cluster. +Data stored in the associated Azure Storage account is not deleted. +Data stored in external metastores is not deleted. + +## EXAMPLES + +### Example 1: Delete an Azure HDInsight cluster +```powershell +Remove-AzHDInsightCluster -ClusterName "your-hadoop-001" +``` + +This command removes the cluster named your-hadoop-001. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +If PassThru is present, output the result + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### System.Boolean +## NOTES + +## RELATED LINKS + +[Get-AzHDInsightCluster](./Get-AzHDInsightCluster.md) + +[Use-AzHDInsightCluster](./Use-AzHDInsightCluster.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Remove-AzHDInsightClusterAutoscaleConfiguration.md b/azps-10.1.0/Az.HDInsight/Remove-AzHDInsightClusterAutoscaleConfiguration.md new file mode 100644 index 0000000000..b286ec5189 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Remove-AzHDInsightClusterAutoscaleConfiguration.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 5B1D72ED-7A1C-4360-B256-0066CC366E28 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/remove-azhdinsightclusterautoscaleconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Remove-AzHDInsightClusterAutoscaleConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Remove-AzHDInsightClusterAutoscaleConfiguration.md +--- + +# Remove-AzHDInsightClusterAutoscaleConfiguration + +## SYNOPSIS +Removes the autoscale configuration of the HDInsight cluster. + +## SYNTAX + +### RemoveByNameParameterSet (Default) +``` +Remove-AzHDInsightClusterAutoscaleConfiguration [[-ResourceGroupName] <String>] [-ClusterName] <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByResourceIdParameterSet +``` +Remove-AzHDInsightClusterAutoscaleConfiguration [-ResourceId] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObjectParameterSet +``` +Remove-AzHDInsightClusterAutoscaleConfiguration [-InputObject] <AzureHDInsightCluster> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzHDInsightClusterAutoscaleConfiguration** cmdlet removes the autoscale configuration of the HDInsight cluster. + +## EXAMPLES + +### Example 1: Remove the autoscale configuration of the HDInsight cluster. +```powershell +$clusterResourceGroup="group" +$clusterName="MyCluster" +Remove-AzHDInsightClusterAutoscaleConfiguration -ResourceGroupName $clusterResourceGroup -ClusterName $clusterName +``` + +This command removes the autoscale configuration of the HDInsight cluster. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Gets or sets the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gets or sets the input object. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster +Parameter Sets: RemoveByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Gets or sets the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Gets or sets the resource id. + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzHDInsightClusterAutoscaleConfiguration](./New-AzHDInsightClusterAutoscaleConfiguration.md) +[Set-AzHDInsightClusterAutoscaleConfiguration](./Set-AzHDInsightClusterAutoscaleConfiguration.md) +[Get-AzHDInsightClusterAutoscaleConfiguration](./Get-AzHDInsightClusterAutoscaleConfiguration.md) diff --git a/azps-10.1.0/Az.HDInsight/Remove-AzHDInsightPersistedScriptAction.md b/azps-10.1.0/Az.HDInsight/Remove-AzHDInsightPersistedScriptAction.md new file mode 100644 index 0000000000..7dc53c118f --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Remove-AzHDInsightPersistedScriptAction.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 08D1D6AC-D064-4E2D-9C22-0B65E7BE4DA7 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/remove-azhdinsightpersistedscriptaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Remove-AzHDInsightPersistedScriptAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Remove-AzHDInsightPersistedScriptAction.md +--- + +# Remove-AzHDInsightPersistedScriptAction + +## SYNOPSIS +Removes an persisted script action from an HDInsight cluster. + +## SYNTAX + +``` +Remove-AzHDInsightPersistedScriptAction [-ClusterName] <String> [-Name] <String> [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzHDInsightPersistedScriptAction** cmdlet removes a persisted script action from the specified Azure HDInsight cluster's list of persisted script actions. +The removed script will no longer be executed when the cluster is scaled up. + +## EXAMPLES + +### Example 1: Remove a script action from the list of persisted script actions on a cluster +```powershell +Remove-AzHDInsightPersistedScriptAction ` + -ClusterName "your-hadoop-001" ` + -Name "Scriptaction" +``` + +This command removes the script action named Scriptaction from the list of persisted script actions on the specified cluster. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the persisted script action to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzHDInsightPersistedScriptAction](./Get-AzHDInsightPersistedScriptAction.md) + +[Set-AzHDInsightPersistedScriptAction](./Set-AzHDInsightPersistedScriptAction.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Restart-AzHDInsightHost.md b/azps-10.1.0/Az.HDInsight/Restart-AzHDInsightHost.md new file mode 100644 index 0000000000..52f8a4d591 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Restart-AzHDInsightHost.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/restart-azhdinsighthost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Restart-AzHDInsightHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Restart-AzHDInsightHost.md +--- + +# Restart-AzHDInsightHost + +## SYNOPSIS +Restarts the specific hosts of HDInsight cluster. + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Restart-AzHDInsightHost [[-ResourceGroupName] <String>] [-ClusterName] <String> [-Name] <String[]> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByAzureHDInsightHostInfoParameterSet +``` +Restart-AzHDInsightHost [[-ResourceGroupName] <String>] [-ClusterName] <String> + [-AzureHDInsightHostInfo] <AzureHDInsightHostInfo[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This **Restart-AzHDInsightHost** cmdlet restart the specific hosts of HDInsight cluster. + +## EXAMPLES + +### Example 1 +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +Restart-AzHDInsightHost -ClusterName $clusterName -Name wn0, wn1 +``` + +This command restarts two hosts of the cluster: worknode1, worknode2. + +### Example 2 +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$worknode1= Get-AzHDInsightHost -ClusterName $clusterName | Where-Object {$_.Name -like "wn1*"} +$worknode1 | Restart-AzHDInsightHost -ClusterName $clusterName +``` + +This command shows how to cooperate with the cmdlet 'Get-AzHDInsightHost'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureHDInsightHostInfo +Gets or sets the name of the host. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightHostInfo[] +Parameter Sets: SetByAzureHDInsightHostInfoParameterSet +Aliases: Host + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ClusterName +Gets or sets the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the host. + +```yaml +Type: System.String[] +Parameter Sets: SetByNameParameterSet +Aliases: HostName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Gets or sets the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightHostInfo[] + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/Set-AzHDInsightClusterAutoscaleConfiguration.md b/azps-10.1.0/Az.HDInsight/Set-AzHDInsightClusterAutoscaleConfiguration.md new file mode 100644 index 0000000000..e72ab8982f --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Set-AzHDInsightClusterAutoscaleConfiguration.md @@ -0,0 +1,359 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 1C3B7A57-D645-498C-98F4-DAE9B782123E +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/set-azhdinsightclusterautoscaleconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Set-AzHDInsightClusterAutoscaleConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Set-AzHDInsightClusterAutoscaleConfiguration.md +--- + +# Set-AzHDInsightClusterAutoscaleConfiguration + +## SYNOPSIS +Sets the autoscale configuration of an Azure HDInsight cluster. + +## SYNTAX + +### LoadAutoscaleByNameParameterSet (Default) +``` +Set-AzHDInsightClusterAutoscaleConfiguration [[-ResourceGroupName] <String>] [-ClusterName] <String> + [-MinWorkerNodeCount <Int32>] [-MaxWorkerNodeCount <Int32>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ScheduleAutoscaleByNameParameterSet +``` +Set-AzHDInsightClusterAutoscaleConfiguration [[-ResourceGroupName] <String>] [-ClusterName] <String> + [-TimeZone <String>] + [-Condition <System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightAutoscaleCondition]>] + [-Schedule] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AutoscaleConfigurationByNameParameterSet +``` +Set-AzHDInsightClusterAutoscaleConfiguration [[-ResourceGroupName] <String>] [-ClusterName] <String> + -AutoscaleConfiguration <AzureHDInsightAutoscale> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### LoadAutoscaleByResourceIdParameterSet +``` +Set-AzHDInsightClusterAutoscaleConfiguration [-ResourceId] <String> [-MinWorkerNodeCount <Int32>] + [-MaxWorkerNodeCount <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ScheduleAutoscaleByResourceIdParameterSet +``` +Set-AzHDInsightClusterAutoscaleConfiguration [-ResourceId] <String> [-TimeZone <String>] + [-Condition <System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightAutoscaleCondition]>] + [-Schedule] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AutoscaleConfigurationByResourceIdParameterSet +``` +Set-AzHDInsightClusterAutoscaleConfiguration [-ResourceId] <String> + -AutoscaleConfiguration <AzureHDInsightAutoscale> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### LoadAutoscaleByInputObjectParameterSet +``` +Set-AzHDInsightClusterAutoscaleConfiguration [-InputObject] <AzureHDInsightCluster> + [-MinWorkerNodeCount <Int32>] [-MaxWorkerNodeCount <Int32>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ScheduleAutoscaleByInputObjectParameterSet +``` +Set-AzHDInsightClusterAutoscaleConfiguration [-InputObject] <AzureHDInsightCluster> [-TimeZone <String>] + [-Condition <System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightAutoscaleCondition]>] + [-Schedule] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AutoscaleConfigurationByInputObjectParameterSet +``` +Set-AzHDInsightClusterAutoscaleConfiguration [-InputObject] <AzureHDInsightCluster> + -AutoscaleConfiguration <AzureHDInsightAutoscale> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet **Set-AzHDInsightClusterAutoscaleConfiguration** sets the autoscale configuration of an Azure HDInsight cluster. + +## EXAMPLES + +### Example 1: Set the Load-based autoscale configuration of the HDInsight cluster +```powershell +$clusterResourceGroup="group" +$clusterName="MyCluster" +Set-AzHDInsightClusterAutoscaleConfiguration -ResourceGroupName $clusterResourceGroup ` + -ClusterName $clusterName -MinWorkerNodeCount 3 -MaxWorkerNodeCount 5 +``` + +This command sets the Load-based autoscale configuration of an Azure HDInsight cluster. + +### Example 2: Set the Schedule-based autoscale of the HDInsight cluster +```powershell +# Create autoscale conditions +$condition1=New-AzHDInsightClusterAutoscaleScheduleCondition -Time 09:00 -WorkerNodeCount 5 -Day Monday,Wednesday +$condition2=New-AzHDInsightClusterAutoscaleScheduleCondition -Time 09:00 -WorkerNodeCount 4 -Day Friday + +# Set autoscale configuration +$clusterResourceGroup="group" +$clusterName="MyCluster" +Set-AzHDInsightClusterAutoscaleConfiguration -ResourceGroupName $clusterResourceGroup -ClusterName $clusterName -Schedule -TimeZone "Pacific Standard Time" -Condition $condition1,$condition2 +``` + +This command sets the Schedule-based autoscale configuration of the HDInsight cluster. + +### Example 3: Set the autoscale configuration of the HDInsight cluster based another cluster which has set autoscale configuration +```powershell +# Get the autoscale configuration of another cluster. +$clusterResourceGroup="group" +$anotherClusterName="anotherClusterName" +$autoscaleConfig=Get-AzHDInsightClusterAutoscaleConfiguration -ResourceGroupName $clusterResourceGroup -ClusterName $anotherClusterName + +# Set autoscale configuration +$clusterResourceGroup="group" +$clusterName="MyCluster" +Set-AzHDInsightClusterAutoscaleConfiguration -ResourceGroupName $clusterResourceGroup -ClusterName $clusterName ` + -AutoscaleConfiguration $autoscaleConfig +``` + +This command sets the autoscale configuration of the HDInsight cluster based another cluster. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleConfiguration +Gets or sets the autoscale configuration + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightAutoscale +Parameter Sets: AutoscaleConfigurationByNameParameterSet, AutoscaleConfigurationByResourceIdParameterSet, AutoscaleConfigurationByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Gets or sets the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: LoadAutoscaleByNameParameterSet, ScheduleAutoscaleByNameParameterSet, AutoscaleConfigurationByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Condition +Gets or sets the condition of schedule-based autoscale. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightAutoscaleCondition] +Parameter Sets: ScheduleAutoscaleByNameParameterSet, ScheduleAutoscaleByResourceIdParameterSet, ScheduleAutoscaleByInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gets or sets the input object. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster +Parameter Sets: LoadAutoscaleByInputObjectParameterSet, ScheduleAutoscaleByInputObjectParameterSet, AutoscaleConfigurationByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaxWorkerNodeCount +Gets or sets the maximal workernode count of load-based autoscale. + +```yaml +Type: System.Int32 +Parameter Sets: LoadAutoscaleByNameParameterSet, LoadAutoscaleByResourceIdParameterSet, LoadAutoscaleByInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinWorkerNodeCount +Gets or sets the minimal workernode count of load-based autoscale. + +```yaml +Type: System.Int32 +Parameter Sets: LoadAutoscaleByNameParameterSet, LoadAutoscaleByResourceIdParameterSet, LoadAutoscaleByInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Gets or sets the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: LoadAutoscaleByNameParameterSet, ScheduleAutoscaleByNameParameterSet, AutoscaleConfigurationByNameParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Gets or sets the resource id. + +```yaml +Type: System.String +Parameter Sets: LoadAutoscaleByResourceIdParameterSet, ScheduleAutoscaleByResourceIdParameterSet, AutoscaleConfigurationByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Schedule +Set schedule-based parameters + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ScheduleAutoscaleByNameParameterSet, ScheduleAutoscaleByResourceIdParameterSet, ScheduleAutoscaleByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeZone +Gets or sets the time zone of schedule-based autoscale. + +```yaml +Type: System.String +Parameter Sets: ScheduleAutoscaleByNameParameterSet, ScheduleAutoscaleByResourceIdParameterSet, ScheduleAutoscaleByInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightAutoscale + +## NOTES + +## RELATED LINKS + +[New-AzHDInsightClusterAutoscaleConfiguration](./New-AzHDInsightClusterAutoscaleConfiguration.md) +[Get-AzHDInsightClusterAutoscaleConfiguration](./Get-AzHDInsightClusterAutoscaleConfiguration.md) +[Remove-AzHDInsightClusterAutoscaleConfiguration](./Remove-AzHDInsightClusterAutoscaleConfiguration.md) diff --git a/azps-10.1.0/Az.HDInsight/Set-AzHDInsightClusterDiskEncryptionKey.md b/azps-10.1.0/Az.HDInsight/Set-AzHDInsightClusterDiskEncryptionKey.md new file mode 100644 index 0000000000..d74ee83f54 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Set-AzHDInsightClusterDiskEncryptionKey.md @@ -0,0 +1,237 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 5141D84C-3C58-42B9-890F-C3C9049BC1C5 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/set-azhdinsightclusterdiskencryptionkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Set-AzHDInsightClusterDiskEncryptionKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Set-AzHDInsightClusterDiskEncryptionKey.md +--- + +# Set-AzHDInsightClusterDiskEncryptionKey + +## SYNOPSIS +Rotates the disk encryption key of the specified HDInsight cluster. + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Set-AzHDInsightClusterDiskEncryptionKey [-ResourceGroupName] <String> [-Name] <String> + -EncryptionKeyName <String> -EncryptionKeyVersion <String> -EncryptionVaultUri <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Set-AzHDInsightClusterDiskEncryptionKey [-ResourceId] <String> -EncryptionKeyName <String> + -EncryptionKeyVersion <String> -EncryptionVaultUri <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Set-AzHDInsightClusterDiskEncryptionKey [-InputObject] <AzureHDInsightCluster> -EncryptionKeyName <String> + -EncryptionKeyVersion <String> -EncryptionVaultUri <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Rotate the disk encryption key of the specified HDInsight cluster. For this operation, the cluster must have access to both the current key and the intended new key, otherwise the rotate key operation will fail. + +## EXAMPLES + +### Example 1 +```powershell + # Cluster configuration info + $clusterResourceGroupName = "Group" + $clusterName = "your-cmk-cluster" + +Set-AzHDInsightClusterDiskEncryptionKey ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -EncryptionKeyName new-key ` + -EncryptionVaultUri https://MyKeyVault.vault.azure.net ` + -EncryptionKeyVersion 00000000000000000000000000000000 +``` + +### Example 2 +```powershell + # Cluster configuration info + $clusterName = "your-cmk-cluster" + +$cluster= Get-AzHDInsightCluster -ClusterName $clusterName +$cluster | Set-AzHDInsightClusterDiskEncryptionKey ` + -EncryptionKeyName new-key ` + -EncryptionVaultUri https://MyKeyVault.vault.azure.net ` + -EncryptionKeyVersion 00000000000000000000000000000000 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyName +Gets or sets the encryption key name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyVersion +Gets or sets the encryption key version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionVaultUri +Gets or sets the encryption vault uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Gets or sets the input object. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Gets or sets the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Gets or sets the resource id. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.HDInsight.Models.Cluster + +## NOTES + +## RELATED LINKS + +[Customer-managed key disk encryption](https://learn.microsoft.com/azure/hdinsight/disk-encryption) diff --git a/azps-10.1.0/Az.HDInsight/Set-AzHDInsightClusterSize.md b/azps-10.1.0/Az.HDInsight/Set-AzHDInsightClusterSize.md new file mode 100644 index 0000000000..0e0752335a --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Set-AzHDInsightClusterSize.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: A9A8C4B9-6346-4186-9D73-3A56437BFB2F +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/set-azhdinsightclustersize +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Set-AzHDInsightClusterSize.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Set-AzHDInsightClusterSize.md +--- + +# Set-AzHDInsightClusterSize + +## SYNOPSIS +Sets the number of Worker nodes in a specified cluster. + +## SYNTAX + +``` +Set-AzHDInsightClusterSize [-ClusterName] <String> [-TargetInstanceCount] <Int32> [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzHDInsightClusterSize** cmdlet sets the number of Worker nodes in a specified Azure HDInsight cluster. + +## EXAMPLES + +### Example 1: Set the size of a specified cluster +```powershell +Set-AzHDInsightClusterSize -ClusterName "your-hadoop-001" -TargetInstanceCount 6 +``` + +This command sets the size of the cluster named your-hadoop-001. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetInstanceCount +Specifies the desired number of Worker nodes in the cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.HDInsight.Models.Cluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/Set-AzHDInsightDefaultStorage.md b/azps-10.1.0/Az.HDInsight/Set-AzHDInsightDefaultStorage.md new file mode 100644 index 0000000000..6b9a03990a --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Set-AzHDInsightDefaultStorage.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 37E41DA2-B65B-4AA2-B6AB-F93CCA881C72 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/set-azhdinsightdefaultstorage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Set-AzHDInsightDefaultStorage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Set-AzHDInsightDefaultStorage.md +--- + +# Set-AzHDInsightDefaultStorage + +## SYNOPSIS +Sets the default Storage account setting in a cluster configuration object. + +## SYNTAX + +``` +Set-AzHDInsightDefaultStorage [-Config] <AzureHDInsightConfig> [-StorageAccountResourceId] <String> + [[-StorageAccountKey] <String>] [-StorageAccountType <StorageType>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzHDInsightDefaultStorage** cmdlet sets the default Storage account setting in the Azure HDInsight cluster configuration object created by the New-AzHDInsightClusterConfig cmdlet. + +## EXAMPLES + +### Example 1: Set the default storage account for the cluster configuration object +```powershell +# Primary storage account info +$storageAccountResourceGroupName = "Group" +$storageAccountResourceId = "yourstorageaccountresourceid" +$storageAccountName = "yourstorageaccountname" +$storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value + + +$storageType = "AzureStorage" + +# Cluster configuration info +$location = "East US 2" +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-002" +$clusterCreds = Get-Credential + +# If the cluster's resource group doesn't exist yet, run: +# New-AzResourceGroup -Name $clusterResourceGroupName -Location $location + +# Create the cluster +New-AzHDInsightClusterConfig ` + | Set-AzHDInsightDefaultStorage ` + -StorageAccountResourceId $storageAccountResourceId ` + -StorageAccountKey $key2 ` + -StorageAccountType $storageType ` + | New-AzHDInsightCluster ` + -ClusterType Hadoop ` + -OSType Windows ` + -ClusterSizeInNodes 4 ` + -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds ` + -Location $location +``` + +This command sets the default Storage account for a cluster configuration object. + +## PARAMETERS + +### -Config +Specifies the HDInsight cluster configuration object that this cmdlet modifies. +This object is created by the **New-AzHDInsightClusterConfig** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountKey +Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The storage account name for the storage account to be added to the new cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountType +Gets or sets the type of the default storage account. Defaults to AzureStorage + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.HDInsight.Models.Management.StorageType] +Parameter Sets: (All) +Aliases: +Accepted values: AzureStorage, AzureDataLakeStore, AzureDataLakeStorageGen2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/Set-AzHDInsightGatewayCredential.md b/azps-10.1.0/Az.HDInsight/Set-AzHDInsightGatewayCredential.md new file mode 100644 index 0000000000..9a4d7d8e03 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Set-AzHDInsightGatewayCredential.md @@ -0,0 +1,226 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/set-azhdinsightgatewaycredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Set-AzHDInsightGatewayCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Set-AzHDInsightGatewayCredential.md +--- + +# Set-AzHDInsightGatewayCredential + +## SYNOPSIS +Sets the gateway HTTP credentials of an Azure HDInsight cluster. + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Set-AzHDInsightGatewayCredential [-Name] <String> [-HttpCredential] <PSCredential> + [-ResourceGroupName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Set-AzHDInsightGatewayCredential [-HttpCredential] <PSCredential> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] -InputObject <AzureHDInsightCluster> [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Set-AzHDInsightGatewayCredential [-HttpCredential] <PSCredential> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] -ResourceId <String> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzHDInsightGatewayCredential** cmdlet sets gateway credential of an Azure HDInsight cluster. + +## EXAMPLES + +### Example 1 +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +Set-AzHDInsightGatewayCredential ` + -ClusterName $clusterName ` + -HttpCredential $clusterCreds +``` + +This command sets gateway credential of the cluster named your-hadoop-001 by name parameter set. + +### Example 2 +```powershell +Set-AzHDInsightGatewayCredential ` + -ResourceId "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/your-hadoop-001" ` + -HttpCredential $clusterCreds +``` + +This command sets gateway credential of the cluster named your-hadoop-001 by ResourceId parameter set. + +### Example 3 +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +Get-AzHDInsightCluster -ClusterName $clusterName | Set-AzHDInsightGatewayCredential ` + -HttpCredential $clusterCreds +``` + +This command sets gateway credential of the cluster named your-hadoop-001 by InputObject parameter set. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpCredential +Gets or sets the login for the cluster's user. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Gets or sets the input object. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: ClusterName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Gets or sets the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Gets or sets the resource id. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightGatewaySettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HDInsight/Set-AzHDInsightPersistedScriptAction.md b/azps-10.1.0/Az.HDInsight/Set-AzHDInsightPersistedScriptAction.md new file mode 100644 index 0000000000..eb0cfc2ba3 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Set-AzHDInsightPersistedScriptAction.md @@ -0,0 +1,122 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 92F21752-4FB6-4162-B542-DA25ACA3340B +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/set-azhdinsightpersistedscriptaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Set-AzHDInsightPersistedScriptAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Set-AzHDInsightPersistedScriptAction.md +--- + +# Set-AzHDInsightPersistedScriptAction + +## SYNOPSIS +Sets a previously executed script action to be a persisted script action. + +## SYNTAX + +``` +Set-AzHDInsightPersistedScriptAction [-ClusterName] <String> [-ScriptExecutionId] <Int64> + [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzHDInsightPersistedScriptAction** cmdlet sets a previously executed script action to be a persisted script action. +The specified script action must have previously succeeded. +The script action will run each time the Azure HDInsight cluster is scaled up. + +## EXAMPLES + +### Example 1: Set a previously successful script action to be persisted, or run on cluster scale up +```powershell +Set-AzHDInsightPersistedScriptAction ` + -ClusterName "your-hadoop-001" ` + -ScriptExecutionId "<id>" +``` + +This command sets a previously successful script action to be a persisted script action. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptExecutionId +Specifies the execution ID of the script action to promote to persisted. +This script action must have succeeded in order to be promoted. +You can find the script action execution ID using Get-AzHDInsightScriptActionHistory. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzHDInsightPersistedScriptAction](./Get-AzHDInsightPersistedScriptAction.md) + +[Remove-AzHDInsightPersistedScriptAction](./Remove-AzHDInsightPersistedScriptAction.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Start-AzHDInsightJob.md b/azps-10.1.0/Az.HDInsight/Start-AzHDInsightJob.md new file mode 100644 index 0000000000..d26eeb1045 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Start-AzHDInsightJob.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 0225C7CA-74B4-4ACC-870C-9539DF6ECC47 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/start-azhdinsightjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Start-AzHDInsightJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Start-AzHDInsightJob.md +--- + +# Start-AzHDInsightJob + +## SYNOPSIS +Starts a defined Azure HDInsight job on a specified cluster. + +## SYNTAX + +``` +Start-AzHDInsightJob [-ClusterName] <String> [-JobDefinition] <AzureHDInsightJobDefinition> + [-HttpCredential] <PSCredential> [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzHDInsightJob** cmdlet starts a defined Azure HDInsight job on a specified cluster. +This can be a MapReduce job, a Streaming MapReduce job, a Hive job, or a Pig job. + +## EXAMPLES + +### Example 1: Start a job on the specified cluster +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# Hive job details +$statusFolder = "tempStatusFolder/" +$query = "SHOW TABLES" + +New-AzHDInsightHiveJobDefinition -StatusFolder $statusFolder ` + -Query $query ` + | Start-AzHDInsightJob ` + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds +``` + +This command starts a job on the cluster named your-hadoop-001. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpCredential +Specifies the cluster login (HTTP) credentials for the cluster. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: ClusterCredential + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobDefinition +Specifies the job to start on the Azure HDInsight cluster. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightJobDefinition +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightJobDefinition + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightJob + +## NOTES + +## RELATED LINKS + +[Get-AzHDInsightJob](./Get-AzHDInsightJob.md) + +[New-AzHDInsightHiveJobDefinition](./New-AzHDInsightHiveJobDefinition.md) + +[Stop-AzHDInsightJob](./Stop-AzHDInsightJob.md) + +[Wait-AzHDInsightJob](./Wait-AzHDInsightJob.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Stop-AzHDInsightJob.md b/azps-10.1.0/Az.HDInsight/Stop-AzHDInsightJob.md new file mode 100644 index 0000000000..22934b17b6 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Stop-AzHDInsightJob.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: FD27C755-9AAF-42DA-8425-1661C92B6C68 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/stop-azhdinsightjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Stop-AzHDInsightJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Stop-AzHDInsightJob.md +--- + +# Stop-AzHDInsightJob + +## SYNOPSIS +Stops a specified running job on a cluster. + +## SYNTAX + +``` +Stop-AzHDInsightJob [-ClusterName] <String> [-JobId] <String> [-HttpCredential] <PSCredential> + [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzHDInsightJob** cmdlet stops a specified running job on an Azure HDInsight cluster. + +## EXAMPLES + +### Example 1: Stop a job on the specified cluster +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential +Stop-AzHDInsightJob ` + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds ` + -JobId $jobId +``` + +This command stops a job on the cluster named your-hadoop-001. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpCredential +Specifies the cluster login (HTTP) credentials for the cluster. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: ClusterCredential + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId +Specifies the job ID of the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightJob + +## NOTES + +## RELATED LINKS + +[Get-AzHDInsightJob](./Get-AzHDInsightJob.md) + +[Start-AzHDInsightJob](./Start-AzHDInsightJob.md) + +[Wait-AzHDInsightJob](./Wait-AzHDInsightJob.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Submit-AzHDInsightScriptAction.md b/azps-10.1.0/Az.HDInsight/Submit-AzHDInsightScriptAction.md new file mode 100644 index 0000000000..6d47c78525 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Submit-AzHDInsightScriptAction.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 15C5D659-472B-41DD-806A-A0A175434EE3 +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/submit-azhdinsightscriptaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Submit-AzHDInsightScriptAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Submit-AzHDInsightScriptAction.md +--- + +# Submit-AzHDInsightScriptAction + +## SYNOPSIS +Submits a new script action to an Azure HDInsight cluster. + +## SYNTAX + +``` +Submit-AzHDInsightScriptAction [-ClusterName] <String> [-Name] <String> [-Uri] <Uri> + [-NodeTypes] <RuntimeScriptActionClusterNodeType[]> [[-Parameters] <String>] [[-ApplicationName] <String>] + [-PersistOnSuccess] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Submit-AzHDInsightScriptAction** cmdlet submits a new script action to an Azure HDInsight cluster. +Use *PersistOnSuccess* to have the script action run each time the cluster is scaled up, as long as the script action initially succeeds. + +## EXAMPLES + +### Example 1: Submit a new script action to a running HDInsight cluster +```powershell +Submit-AzHDInsightScriptAction ` + -ClusterName "your-hadoop-001" ` + -Name "scriptaction" ` + -Uri "<script action URI>" ` + -NodeTypes Worker -PersistOnSuccess +``` + +This command submits a script action to a running HDInsight cluster. + +## PARAMETERS + +### -ApplicationName +Specifies the application name for the script action. +When *ApplicationName* is specified, *PersistOnSuccess* should be set to False, nodes must contain only edgenode, and script action count should equal 1. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the script action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeTypes +Specifies the node types on which to run the script action. + +```yaml +Type: Microsoft.Azure.Commands.HDInsight.Models.Management.RuntimeScriptActionClusterNodeType[] +Parameter Sets: (All) +Aliases: +Accepted values: HeadNode, WorkerNode, ZookeeperNode, EdgeNode + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameters +Specifies the parameters for the script action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PersistOnSuccess +Indicates that the script action should run each time the cluster is scaled up. +This switch parameter is ignored if the script action initially fails. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +Specifies the public URI for the script action (a PowerShell or Bash script). + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Uri + +### Microsoft.Azure.Commands.HDInsight.Models.Management.RuntimeScriptActionClusterNodeType[] + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightRuntimeScriptActionOperationResource + +## NOTES + +## RELATED LINKS + +[Add-AzHDInsightScriptAction](./Add-AzHDInsightScriptAction.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Use-AzHDInsightCluster.md b/azps-10.1.0/Az.HDInsight/Use-AzHDInsightCluster.md new file mode 100644 index 0000000000..ff275a813b --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Use-AzHDInsightCluster.md @@ -0,0 +1,122 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 92E876FE-AA7B-43AA-915F-D02AC5CEF0CA +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/use-azhdinsightcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Use-AzHDInsightCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Use-AzHDInsightCluster.md +--- + +# Use-AzHDInsightCluster + +## SYNOPSIS +Selects a cluster to be used with the Invoke-RmAzureHDInsightHiveJob cmdlet. + +## SYNTAX + +``` +Use-AzHDInsightCluster [-ClusterName] <String> [-HttpCredential] <PSCredential> [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Use-AzHDInsightCluster** cmdlet selects the Azure HDInsight cluster for the Invoke-AzHDInsightHiveJob cmdlet to use to submit Hive jobs. + +## EXAMPLES + +### Example 1: Select a cluster for Hive query submission +```powershell +# Cluster info +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +Use-AzHDInsightCluster ` + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds +``` + +This command selects a cluster for a Hive query submission. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpCredential +Specifies the cluster login (HTTP) credentials for the cluster. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: ClusterCredential + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzHDInsightCluster](./Get-AzHDInsightCluster.md) + +[Remove-AzHDInsightCluster](./Remove-AzHDInsightCluster.md) + + diff --git a/azps-10.1.0/Az.HDInsight/Wait-AzHDInsightJob.md b/azps-10.1.0/Az.HDInsight/Wait-AzHDInsightJob.md new file mode 100644 index 0000000000..9932f2cd03 --- /dev/null +++ b/azps-10.1.0/Az.HDInsight/Wait-AzHDInsightJob.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HDInsight.dll-Help.xml +Module Name: Az.HDInsight +ms.assetid: 677E19F2-CC6C-4C16-B1FD-3A15D0FF1ECA +online version: https://learn.microsoft.com/powershell/module/az.hdinsight/wait-azhdinsightjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Wait-AzHDInsightJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HDInsight/HDInsight/help/Wait-AzHDInsightJob.md +--- + +# Wait-AzHDInsightJob + +## SYNOPSIS +Waits for the completion or failure of a specified job. + +## SYNTAX + +``` +Wait-AzHDInsightJob [-ClusterName] <String> [-JobId] <String> [-HttpCredential] <PSCredential> + [-ResourceGroupName <String>] [-TimeoutInSeconds <Int32>] [-WaitIntervalInSeconds <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Wait-AzHDInsightJob** cmdlet awaits the completion or failure of an Azure HDInsight job. + +## EXAMPLES + +### Example 1: Wait for the completion or failure of a job +```powershell +# Cluster info +$clusterResourceGroupName = "Group" +$clusterName = "your-hadoop-001" +$clusterCreds = Get-Credential + +# Hive job details +$statusFolder = "tempStatusFolder/" +$query = "SHOW TABLES" + +New-AzHDInsightHiveJobDefinition -StatusFolder $statusFolder ` + -Query $query ` + | Start-AzHDInsightJob -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds ` + | Wait-AzHDInsightJob -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds +``` + +This command waits for the completion or failure of a job. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpCredential +Specifies the cluster login (HTTP) credentials for the cluster. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: ClusterCredential + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId +Specifies the job ID of the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutInSeconds +The total time to wait for job completion, in seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitIntervalInSeconds +The time to wait between job status checks, in seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightJob + +## NOTES + +## RELATED LINKS + +[Get-AzHDInsightJob](./Get-AzHDInsightJob.md) + +[Start-AzHDInsightJob](./Start-AzHDInsightJob.md) + +[Stop-AzHDInsightJob](./Stop-AzHDInsightJob.md) + + diff --git a/azps-10.1.0/Az.HPCCache/Az.HPCCache.md b/azps-10.1.0/Az.HPCCache/Az.HPCCache.md new file mode 100644 index 0000000000..b835c03c9b --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/Az.HPCCache.md @@ -0,0 +1,54 @@ +--- +Module Name: Az.HPCCache +Module Guid: 6470f56b-378e-48f4-b60f-954c01bf1822 +Download Help Link: https://learn.microsoft.com/powershell/module/az.hpccache +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Az.HPCCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Az.HPCCache.md +--- + +# Az.HPCCache Module +## Description +HPC Cache + +## Az.HPCCache Cmdlets +### [Get-AzHpcCache](Get-AzHpcCache.md) +Gets a cache(s). + +### [Get-AzHpcCacheSku](Get-AzHpcCacheSku.md) +Gets all SKUs available in subscription. + +### [Get-AzHpcCacheStorageTarget](Get-AzHpcCacheStorageTarget.md) +Get HPC cache storage target(s). + +### [Get-AzHpcCacheUsageModel](Get-AzHpcCacheUsageModel.md) +Gets all usageModels for NFS Storage Target. + +### [New-AzHpcCache](New-AzHpcCache.md) +Creates a HPC Cache. + +### [New-AzHpcCacheStorageTarget](New-AzHpcCacheStorageTarget.md) +Creates a Storage Target. + +### [Remove-AzHpcCache](Remove-AzHpcCache.md) +Removes a HPC Cache. + +### [Remove-AzHpcCacheStorageTarget](Remove-AzHpcCacheStorageTarget.md) +Removes a Storage Target. + +### [Set-AzHpcCache](Set-AzHpcCache.md) +Updates tags on a HPC Cache. + +### [Set-AzHpcCacheStorageTarget](Set-AzHpcCacheStorageTarget.md) +Updates a Storage Target. + +### [Start-AzHpcCache](Start-AzHpcCache.md) +Starts HPC cache. + +### [Stop-AzHpcCache](Stop-AzHpcCache.md) +Stops HPC cache. + +### [Update-AzHpcCache](Update-AzHpcCache.md) +Updates a HPC Cache. + diff --git a/azps-10.1.0/Az.HPCCache/Get-AzHpcCache.md b/azps-10.1.0/Az.HPCCache/Get-AzHpcCache.md new file mode 100644 index 0000000000..5cf58c3e72 --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/Get-AzHpcCache.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.dll-Help.xml +Module Name: Az.HPCCache +online version: https://learn.microsoft.com/powershell/module/az.hpccache/get-azhpccache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Get-AzHpcCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Get-AzHpcCache.md +--- + +# Get-AzHpcCache + +## SYNOPSIS +Gets a cache(s). + +## SYNTAX + +``` +Get-AzHpcCache [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHpcCache** cmdlet gets a single cache, cache(s) in a specific resource group, or subscription wide list of caches. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzHpcCache -ResourceGroupName rgtest -CacheName cachetest +``` + +### Example 2 +```powershell +Get-AzHpcCache -ResourceGroupName rgtest +``` + +### Example 3 +```powershell +Get-AzHpcCache +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of specific cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CacheName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which you want to list cache(s). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HPCCache.Models.PSHPCCache + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HPCCache/Get-AzHpcCacheSku.md b/azps-10.1.0/Az.HPCCache/Get-AzHpcCacheSku.md new file mode 100644 index 0000000000..9ce323edb8 --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/Get-AzHpcCacheSku.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.dll-Help.xml +Module Name: Az.HPCCache +online version: https://learn.microsoft.com/powershell/module/az.hpccache/get-azhpccachesku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Get-AzHpcCacheSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Get-AzHpcCacheSku.md +--- + +# Get-AzHpcCacheSku + +## SYNOPSIS +Gets all SKUs available in subscription. + +## SYNTAX + +``` +Get-AzHpcCacheSku [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHpcCacheSku** cmdlet returns a list of SKUs available in subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzHpcCacheSku +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.HPCCache.PSSku + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HPCCache/Get-AzHpcCacheStorageTarget.md b/azps-10.1.0/Az.HPCCache/Get-AzHpcCacheStorageTarget.md new file mode 100644 index 0000000000..2b4304ef98 --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/Get-AzHpcCacheStorageTarget.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.dll-Help.xml +Module Name: Az.HPCCache +online version: https://learn.microsoft.com/powershell/module/az.hpccache/get-azhpccachestoragetarget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Get-AzHpcCacheStorageTarget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Get-AzHpcCacheStorageTarget.md +--- + +# Get-AzHpcCacheStorageTarget + +## SYNOPSIS +Get HPC cache storage target(s). + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzHpcCacheStorageTarget -ResourceGroupName <String> -CacheName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzHpcCacheStorageTarget -CacheId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Get-AzHpcCacheStorageTarget -CacheObject <PSHPCCache> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHpcCacheStorageTarget** cmdlet gets storage target(s) that exist on cache. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzHpcCacheStorageTarget -ResourceGroupName rgTest -CacheName cacheTest +``` + +### Example 2 +```powershell +Get-AzHpcCacheStorageTarget -ResourceGroupName rgTest -CacheName cacheTest -StorageTargetName stTest +``` + +## PARAMETERS + +### -CacheId +The resource id of the Cache + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CacheName +Name of cache. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CacheObject +The cache object to start. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.Models.PSHPCCache +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of storage target. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: StorageTargetName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group cache is in. + + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HPCCache.Models.PSHpcStorageTarget + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HPCCache/Get-AzHpcCacheUsageModel.md b/azps-10.1.0/Az.HPCCache/Get-AzHpcCacheUsageModel.md new file mode 100644 index 0000000000..6abf745539 --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/Get-AzHpcCacheUsageModel.md @@ -0,0 +1,62 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.dll-Help.xml +Module Name: Az.HPCCache +online version: https://learn.microsoft.com/powershell/module/az.hpccache/get-azhpccacheusagemodels +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Get-AzHpcCacheUsageModel.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Get-AzHpcCacheUsageModel.md +--- + +# Get-AzHpcCacheUsageModel + +## SYNOPSIS +Gets all usageModels for NFS Storage Target. + +## SYNTAX + +``` +Get-AzHpcCacheUsageModel [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzHpcCacheUsageModel** cmdlet returns a list of usage models for NFS Storage Target. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzHpcCacheUsageModel +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HPCCache.Models.PSHpcUsageModels + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HPCCache/New-AzHpcCache.md b/azps-10.1.0/Az.HPCCache/New-AzHpcCache.md new file mode 100644 index 0000000000..9596dd7851 --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/New-AzHpcCache.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.dll-Help.xml +Module Name: Az.HPCCache +online version: https://learn.microsoft.com/powershell/module/az.hpccache/new-azhpccache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/New-AzHpcCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/New-AzHpcCache.md +--- + +# New-AzHpcCache + +## SYNOPSIS +Creates a HPC Cache. + +## SYNTAX + +``` +New-AzHpcCache -ResourceGroupName <String> -Name <String> -Sku <String> -SubnetUri <String> -CacheSize <Int32> + -Location <String> [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzHpcCache** cmdlet creates a Azure HPC Cache. + +## EXAMPLES + +### Example 1 +```powershell +New-AzHpcCache -ResourceGroupName testRG -CacheName testCache -Sku Standard_2G -SubnetUri /subscriptions/<subid>/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/defauly-tip1-test2 -cacheSize 3072 -Location eastus -Tag @{"tag1" = "value1"; "tag2" = "value2"} +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CacheSize +CacheSize. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CacheName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which you want to create cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Sku. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubnetUri +SubnetURI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The tags to associate with HPC Cache. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HPCCache.Models.PSHPCCache + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HPCCache/New-AzHpcCacheStorageTarget.md b/azps-10.1.0/Az.HPCCache/New-AzHpcCacheStorageTarget.md new file mode 100644 index 0000000000..7cfd785af5 --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/New-AzHpcCacheStorageTarget.md @@ -0,0 +1,271 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.dll-Help.xml +Module Name: Az.HPCCache +online version: https://learn.microsoft.com/powershell/module/az.hpccache/new-azhpccachestoragetarget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/New-AzHpcCacheStorageTarget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/New-AzHpcCacheStorageTarget.md +--- + +# New-AzHpcCacheStorageTarget + +## SYNOPSIS +Creates a Storage Target. + +## SYNTAX + +### ClfsParameterSet (Default) +``` +New-AzHpcCacheStorageTarget -ResourceGroupName <String> -CacheName <String> -Name <String> [-CLFS] + [-StorageContainerID <String>] [-Junction <Hashtable[]>] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NfsParameterSet +``` +New-AzHpcCacheStorageTarget -ResourceGroupName <String> -CacheName <String> -Name <String> [-NFS] + [-HostName <String>] [-UsageModel <String>] [-Junction <Hashtable[]>] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzHpcCacheStorageTarget** cmdlet adds a Storage Target to Azure HPC Cache. + +## EXAMPLES + +### Example 1 +```powershell +New-AzHpcCacheStorageTarget -ResourceGroupName testRG -CacheName testCache -StorageTargetName testST -CLFS -StorageContainerID "/subscriptions/testsub/resourceGroups/testRG/providers/Microsoft.Storage/storageAccounts/testdstorageaccount/blobServices/default/containers/testcontainer" -Junction @(@{"namespacePath"="/msazure";"targetPath"="/";"nfsExport"="/"}) +``` + +### Example 2 +```powershell +New-AzHpcCacheStorageTarget -ResourceGroupName testRG -CacheName testCache -StorageTargetName testST -NFS -UsageModel "READ_HEAVY_INFREQ" -Junction @(@{"namespacePath"="/msazure";"targetPath"="/";"nfsExport"="/"}) +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CacheName +Name of cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CLFS +Update CLFS Storage Target type. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ClfsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. By default, this cmdlet prompts you to confirm that you want to flush the cache. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +NFS host name. + +```yaml +Type: System.String +Parameter Sets: NfsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Junction +Junction. + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of storage target. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageTargetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NFS +Update NFS Storage Target type. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NfsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +"Name of resource group under which you want to create storage target for given cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageContainerID +StorageContainerID + +```yaml +Type: System.String +Parameter Sets: ClfsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsageModel +NFS usage model. + +```yaml +Type: System.String +Parameter Sets: NfsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HPCCache.Models.PsHpcStorageTarget + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HPCCache/Remove-AzHpcCache.md b/azps-10.1.0/Az.HPCCache/Remove-AzHpcCache.md new file mode 100644 index 0000000000..1ea949f229 --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/Remove-AzHpcCache.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.dll-Help.xml +Module Name: Az.HPCCache +online version: https://learn.microsoft.com/powershell/module/az.hpccache/remove-azhpccache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Remove-AzHpcCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Remove-AzHpcCache.md +--- + +# Remove-AzHpcCache + +## SYNOPSIS +Removes a HPC Cache. + +## SYNTAX + +``` +Remove-AzHpcCache -ResourceGroupName <String> -Name <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzHpcCache** cmdlet removes a Azure HPC Cache. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzHpcCache -ResourceGroupName testRG -CacheName testCache +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. By default, this cmdlet prompts you to confirm that you want to remove the cache. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CacheName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which you want to remove cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HPCCache/Remove-AzHpcCacheStorageTarget.md b/azps-10.1.0/Az.HPCCache/Remove-AzHpcCacheStorageTarget.md new file mode 100644 index 0000000000..e58eecc5cf --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/Remove-AzHpcCacheStorageTarget.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.dll-Help.xml +Module Name: Az.HPCCache +online version: https://learn.microsoft.com/powershell/module/az.hpccache/remove-azhpccachestoragetarget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Remove-AzHpcCacheStorageTarget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Remove-AzHpcCacheStorageTarget.md +--- + +# Remove-AzHpcCacheStorageTarget + +## SYNOPSIS +Removes a Storage Target. + +## SYNTAX + +``` +Remove-AzHpcCacheStorageTarget -ResourceGroupName <String> -CacheName <String> -Name <String> [-Force] + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzHpcCacheStorageTarget** cmdlet removes a Storage Target from Azure HPC Cache. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzHpcCacheStorageTarget -ResourceGroupName testRG -CacheName testCache -StorageTargetName testST +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CacheName +Name of cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. By default, this cmdlet prompts you to confirm that you want to remove the storage target. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of storage target. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageTargetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which you want to remove storage target from cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HPCCache/Set-AzHpcCache.md b/azps-10.1.0/Az.HPCCache/Set-AzHpcCache.md new file mode 100644 index 0000000000..0d363ff154 --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/Set-AzHpcCache.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.dll-Help.xml +Module Name: Az.HPCCache +online version: https://learn.microsoft.com/powershell/module/az.hpccache/set-azhpccache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Set-AzHpcCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Set-AzHpcCache.md +--- + +# Set-AzHpcCache + +## SYNOPSIS +Updates tags on a HPC Cache. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Set-AzHpcCache -ResourceGroupName <String> -Name <String> [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Set-AzHpcCache -InputObject <PSHPCCache> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzHpcCache** cmdlet updates an Azure HPC Cache tags. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzHpcCache -ResourceGroupName testRG -CacheName testCache -Tag @{"tag3" = "value1"; "tag4" = "value2"} +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The cache object to update. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.Models.PSHPCCache +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of cache. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: CacheName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which you want to update cache. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The tags to associate with HPC Cache. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HPCCache.Models.PSHPCCache + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HPCCache/Set-AzHpcCacheStorageTarget.md b/azps-10.1.0/Az.HPCCache/Set-AzHpcCacheStorageTarget.md new file mode 100644 index 0000000000..829ed2a412 --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/Set-AzHpcCacheStorageTarget.md @@ -0,0 +1,226 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.dll-Help.xml +Module Name: Az.HPCCache +online version: https://learn.microsoft.com/powershell/module/az.hpccache/set-azhpccachestoragetarget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Set-AzHpcCacheStorageTarget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Set-AzHpcCacheStorageTarget.md +--- + +# Set-AzHpcCacheStorageTarget + +## SYNOPSIS +Updates a Storage Target. + +## SYNTAX + +### ClfsParameterSet (Default) +``` +Set-AzHpcCacheStorageTarget -ResourceGroupName <String> -CacheName <String> -Name <String> [-CLFS] + [-Junction <Hashtable[]>] [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### NfsParameterSet +``` +Set-AzHpcCacheStorageTarget -ResourceGroupName <String> -CacheName <String> -Name <String> [-NFS] + [-Junction <Hashtable[]>] [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzHpcCacheStorageTarget** cmdlet updates a Storage Target attached to Azure HPC cache. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzHpcCacheStorageTarget -ResourceGroupName testRG -CacheName testCache -StorageTargetName testST -CLFS -Junction @(@{"namespacePath"="/msazure";"targetPath"="/";"nfsExport"="/"}) +``` + +### Example 2 +```powershell +Set-AzHpcCacheStorageTarget -ResourceGroupName testRG -CacheName testCache -StorageTargetName testST -NFS -Junction @(@{"namespacePath"="/msazure";"targetPath"="/";"nfsExport"="/export"}) +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CacheName +Name of cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CLFS +Update CLFS Storage Target type. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ClfsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. By default, this cmdlet prompts you to confirm that you want to flush the cache. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Junction +Junction. + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of storage target. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageTargetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NFS +Update NFS Storage Target type. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NfsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which you want to update storage target. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HPCCache.Models.PsHpcStorageTarget + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HPCCache/Start-AzHpcCache.md b/azps-10.1.0/Az.HPCCache/Start-AzHpcCache.md new file mode 100644 index 0000000000..88ad76afd3 --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/Start-AzHpcCache.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.dll-Help.xml +Module Name: Az.HPCCache +online version: https://learn.microsoft.com/powershell/module/az.hpccache/start-azhpccache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Start-AzHpcCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Start-AzHpcCache.md +--- + +# Start-AzHpcCache + +## SYNOPSIS +Starts HPC cache. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Start-AzHpcCache -ResourceGroupName <String> -Name <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Start-AzHpcCache -ResourceId <String> [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Start-AzHpcCache -InputObject <PSHPCCache> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzHpcCache** cmdlet starts a Azure HPC Cache. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzHpcCache -ResourceGroupName testRG -CacheName testCache +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. By default, this cmdlet prompts you to confirm that you want to start the cache. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The cache object to start. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.Models.PSHPCCache +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of cache. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: CacheName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which you want to start cache. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the Cache + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HPCCache/Stop-AzHpcCache.md b/azps-10.1.0/Az.HPCCache/Stop-AzHpcCache.md new file mode 100644 index 0000000000..7648c55d0c --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/Stop-AzHpcCache.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.dll-Help.xml +Module Name: Az.HPCCache +online version: https://learn.microsoft.com/powershell/module/az.hpccache/stop-azhpccache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Stop-AzHpcCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Stop-AzHpcCache.md +--- + +# Stop-AzHpcCache + +## SYNOPSIS +Stops HPC cache. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Stop-AzHpcCache -ResourceGroupName <String> -Name <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Stop-AzHpcCache -ResourceId <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Stop-AzHpcCache -InputObject <PSHPCCache> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzHpcCache** cmdlet stops a Azure HPC Cache. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzHpcCache -ResourceGroupName testRG -CacheName testCache +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. By default, this cmdlet prompts you to confirm that you want to stop the cache. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The cache object to stop. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.Models.PSHPCCache +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of cache. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: CacheName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which you want to stop cache. + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the Cache + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HPCCache/Update-AzHpcCache.md b/azps-10.1.0/Az.HPCCache/Update-AzHpcCache.md new file mode 100644 index 0000000000..fea6dd43aa --- /dev/null +++ b/azps-10.1.0/Az.HPCCache/Update-AzHpcCache.md @@ -0,0 +1,245 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.dll-Help.xml +Module Name: Az.HPCCache +online version: https://learn.microsoft.com/powershell/module/az.hpccache/update-azhpccache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Update-AzHpcCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HPCCache/HPCCache/help/Update-AzHpcCache.md +--- + +# Update-AzHpcCache + +## SYNOPSIS +Updates a HPC Cache. + +## SYNTAX + +### FlushParameterSet (Default) +``` +Update-AzHpcCache -ResourceGroupName <String> -Name <String> [-Flush] [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzHpcCache -ResourceGroupName <String> -Name <String> -ResourceId <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpgradeParameterSet +``` +Update-AzHpcCache -ResourceGroupName <String> -Name <String> [-Upgrade] [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzHpcCache -ResourceGroupName <String> -Name <String> -InputObject <PSHPCCache> [-Force] [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzHpcCache** cmdlet updates a Azure HPC Cache. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzHpcCache -ResourceGroupName testRG -CacheName testCache +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Flush +Flushes HPC Cache. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FlushParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. By default, this cmdlet prompts you to confirm that you want to update the cache. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The cache object to update. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HPCCache.Models.PSHPCCache +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CacheName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group under which you want to update cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the Cache + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Upgrade +Upgrade HpcCache. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpgradeParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.HanaOnAzure/Az.HanaOnAzure.md b/azps-10.1.0/Az.HanaOnAzure/Az.HanaOnAzure.md new file mode 100644 index 0000000000..cc56bef40a --- /dev/null +++ b/azps-10.1.0/Az.HanaOnAzure/Az.HanaOnAzure.md @@ -0,0 +1,36 @@ +--- +Module Name: Az.HanaOnAzure +Module Guid: 79ad50da-e6b5-4703-885a-d36974a4d9b9 +Download Help Link: https://learn.microsoft.com/powershell/module/az.hanaonazure +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/Az.HanaOnAzure.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/Az.HanaOnAzure.md +--- + +# Az.HanaOnAzure Module +## Description +Microsoft Azure PowerShell: HanaOn cmdlets + +## Az.HanaOnAzure Cmdlets +### [Get-AzSapMonitor](Get-AzSapMonitor.md) +Gets properties of a SAP monitor for the specified subscription, resource group, and resource name. + +### [Get-AzSapMonitorProviderInstance](Get-AzSapMonitorProviderInstance.md) +Gets properties of a provider instance for the specified subscription, resource group, SapMonitor name, and resource name. + +### [New-AzSapMonitor](New-AzSapMonitor.md) +Creates a SAP monitor for the specified subscription, resource group, and resource name. + +### [New-AzSapMonitorProviderInstance](New-AzSapMonitorProviderInstance.md) +Creates a provider instance for the specified subscription, resource group, SapMonitor name, and resource name. + +### [Remove-AzSapMonitor](Remove-AzSapMonitor.md) +Deletes a SAP monitor with the specified subscription, resource group, and monitor name. + +### [Remove-AzSapMonitorProviderInstance](Remove-AzSapMonitorProviderInstance.md) +Deletes a provider instance for the specified subscription, resource group, SapMonitor name, and resource name. + +### [Update-AzSapMonitor](Update-AzSapMonitor.md) +Patches the Tags field of a SAP monitor for the specified subscription, resource group, and monitor name. + diff --git a/azps-10.1.0/Az.HanaOnAzure/Get-AzSapMonitor.md b/azps-10.1.0/Az.HanaOnAzure/Get-AzSapMonitor.md new file mode 100644 index 0000000000..93d4a87099 --- /dev/null +++ b/azps-10.1.0/Az.HanaOnAzure/Get-AzSapMonitor.md @@ -0,0 +1,204 @@ +--- +external help file: +Module Name: Az.HanaOnAzure +online version: https://learn.microsoft.com/powershell/module/az.hanaonazure/get-azsapmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/Get-AzSapMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/Get-AzSapMonitor.md +--- + +# Get-AzSapMonitor + +## SYNOPSIS +Gets properties of a SAP monitor for the specified subscription, resource group, and resource name. + +## SYNTAX + +### List (Default) +``` +Get-AzSapMonitor [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSapMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSapMonitor -InputObject <IHanaOnAzureIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets properties of a SAP monitor for the specified subscription, resource group, and resource name. + +## EXAMPLES + +### Example 1: Get all SAP monitors under a subscription +```powershell +Get-AzSapMonitor +``` + +```output +Location Name Type +-------- ---- ---- +westus2 ps-sapmonitor-t01 Microsoft.HanaOnAzure/sapMonitors +westus2 ps-spamonitor-t01 Microsoft.HanaOnAzure/sapMonitors +``` + +This command gets SAP monitors under a subscription. + +### Example 2: Get a SAP monitor by name +```powershell +Get-AzSapMonitor -ResourceGroupName nancyc-hn1 -Name ps-spamonitor-t01 +``` + +```output +Location Name Type +-------- ---- ---- +westus2 ps-spamonitor-t01 Microsoft.HanaOnAzure/sapMonitors +``` + +This command gets a SAP monitor by name. + +### Example 3: Get a SAP monitor by object +```powershell +$sap = Get-AzSapMonitor -ResourceGroupName nancyc-hn1 -Name ps-spamonitor-t01 +Get-AzSapMonitor -InputObject $sap +``` + +```output +Location Name Type +-------- ---- ---- +westus2 ps-spamonitor-t01 Microsoft.HanaOnAzure/sapMonitors +``` + +This command gets a SAP monitor by object. + +### Example 4: Get a SAP monitor by pipeline +```powershell +@{Id='/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/nancyc-hn1/providers/Microsoft.HanaOnAzure/sapMonitors/ps-spamonitor-t01'} | Get-AzSapMonitor +``` + +```output +Location Name Type +-------- ---- ---- +westus2 ps-spamonitor-t01 Microsoft.HanaOnAzure/sapMonitors +``` + +This command gets a SAP monitor by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.IHanaOnAzureIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SapMonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.IHanaOnAzureIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.Api20200207Preview.ISapMonitor + +## 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 `<IHanaOnAzureIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the deleted vault. + - `[OperationKind <AccessPolicyUpdateKind?>]`: Name of the operation + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: Name of the resource group. + - `[ResourceName <String>]`: The name of the identity resource. + - `[SapMonitorName <String>]`: Name of the SAP monitor resource. + - `[Scope <String>]`: The resource provider scope of the resource. Parent resource being extended by Managed Identities. + - `[SubscriptionId <String>]`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VaultName <String>]`: Name of the vault + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HanaOnAzure/Get-AzSapMonitorProviderInstance.md b/azps-10.1.0/Az.HanaOnAzure/Get-AzSapMonitorProviderInstance.md new file mode 100644 index 0000000000..e4f9dc60cb --- /dev/null +++ b/azps-10.1.0/Az.HanaOnAzure/Get-AzSapMonitorProviderInstance.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.HanaOnAzure +online version: https://learn.microsoft.com/powershell/module/az.hanaonazure/get-azsapmonitorproviderinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/Get-AzSapMonitorProviderInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/Get-AzSapMonitorProviderInstance.md +--- + +# Get-AzSapMonitorProviderInstance + +## SYNOPSIS +Gets properties of a provider instance for the specified subscription, resource group, SapMonitor name, and resource name. + +## SYNTAX + +### List (Default) +``` +Get-AzSapMonitorProviderInstance -ResourceGroupName <String> -SapMonitorName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSapMonitorProviderInstance -Name <String> -ResourceGroupName <String> -SapMonitorName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSapMonitorProviderInstance -InputObject <IHanaOnAzureIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets properties of a provider instance for the specified subscription, resource group, SapMonitor name, and resource name. + +## EXAMPLES + +### Example 1: Get all instances under a SAP monitor +```powershell +Get-AzSapMonitorProviderInstance -ResourceGroupName nancyc-hn1 -SapMonitorName ps-spamonitor-t01 +``` + +```output +Name Type +---- ---- +ps-sapmonitorins-t01 Microsoft.HanaOnAzure/sapMonitors/providerInstances +ps-sapmonitorins-t02 Microsoft.HanaOnAzure/sapMonitors/providerInstances +``` + +This command gets all instances under a SAP monitor. + +### Example 2: Get an instances of SAP monitor by name +```powershell +Get-AzSapMonitorProviderInstance -ResourceGroupName nancyc-hn1 -SapMonitorName ps-spamonitor-t01 -Name ps-sapmonitorins-t02 +``` + +```output +Name Type +---- ---- +ps-sapmonitorins-t02 Microsoft.HanaOnAzure/sapMonitors/providerInstances +``` + +This command gets an instances of SAP monitor by name. + +### Example 3: Get an instances of SAP monitor by object +```powershell +$sapIns = Get-AzSapMonitorProviderInstance -ResourceGroupName nancyc-hn1 -SapMonitorName ps-spamonitor-t01 -Name ps-sapmonitorins-t02 +Get-AzSapMonitorProviderInstance -InputObject $sapIns +``` + +```output +Name Type +---- ---- +ps-sapmonitorins-t02 Microsoft.HanaOnAzure/sapMonitors/providerInstances +``` + +This command gets an instances of SAP monitor by object. + +### Example 4: Get an instances of SAP monitor by pipeline +```powershell +@{Id = "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/nancyc-hn1/providers/Microsoft.HanaOnAzure/sapMonitors/ps-spamonitor-t01/providerInstances/ps-sapmonitorins-t02"} | Get-AzSapMonitorProviderInstance +``` + +```output +Name Type +---- ---- +ps-sapmonitorins-t02 Microsoft.HanaOnAzure/sapMonitors/providerInstances +``` + +This command gets an instances of SAP monitor by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.IHanaOnAzureIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the provider instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ProviderInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapMonitorName +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.IHanaOnAzureIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.Api20200207Preview.IProviderInstance + +## 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 `<IHanaOnAzureIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the deleted vault. + - `[OperationKind <AccessPolicyUpdateKind?>]`: Name of the operation + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: Name of the resource group. + - `[ResourceName <String>]`: The name of the identity resource. + - `[SapMonitorName <String>]`: Name of the SAP monitor resource. + - `[Scope <String>]`: The resource provider scope of the resource. Parent resource being extended by Managed Identities. + - `[SubscriptionId <String>]`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VaultName <String>]`: Name of the vault + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HanaOnAzure/New-AzSapMonitor.md b/azps-10.1.0/Az.HanaOnAzure/New-AzSapMonitor.md new file mode 100644 index 0000000000..7af554ffdf --- /dev/null +++ b/azps-10.1.0/Az.HanaOnAzure/New-AzSapMonitor.md @@ -0,0 +1,288 @@ +--- +external help file: +Module Name: Az.HanaOnAzure +online version: https://learn.microsoft.com/powershell/module/az.hanaonazure/new-azsapmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/New-AzSapMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/New-AzSapMonitor.md +--- + +# New-AzSapMonitor + +## SYNOPSIS +Creates a SAP monitor for the specified subscription, resource group, and resource name. + +## SYNTAX + +``` +New-AzSapMonitor -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-EnableCustomerAnalytic] [-LogAnalyticsWorkspaceId <String>] [-LogAnalyticsWorkspaceResourceId <String>] + [-LogAnalyticsWorkspaceSharedKey <String>] [-MonitorSubnetResourceId <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a SAP monitor for the specified subscription, resource group, and resource name. + +## EXAMPLES + +### Example 1: New SAP monitor +```powershell +$Workspace = New-AzOperationalInsightsWorkspace -ResourceGroupName nancyc-hn1 -Name sapmonitor-test -Location westus2 -Sku "Standard" +$WorkspaceKey = Get-AzOperationalInsightsWorkspaceSharedKey -ResourceGroupName nancyc-hn1 -Name sapmonitor-test +New-AzSapMonitor -Name ps-sapmonitor-t01 -ResourceGroupName nancyc-hn1 -Location westus2 -EnableCustomerAnalytic -MonitorSubnetResourceId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/nancyc-hn1/providers/Microsoft.Network/virtualNetworks/vnet-sap/subnets/subnet-admin" -LogAnalyticsWorkspaceSharedKey $WorkspaceKey.PrimarySharedKey -LogAnalyticsWorkspaceId $Workspace.CustomerId -LogAnalyticsWorkspaceResourceId $Workspace.ResourceId +``` + +```output +Location Name Type +-------- ---- ---- +westus2 ps-sapmonitor-t01 Microsoft.HanaOnAzure/sapMonitors +``` + +This command creates a SAP monitor. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCustomerAnalytic +The value indicating whether to send analytics to Microsoft + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticsWorkspaceId +The workspace ID of the log analytics workspace to be used for monitoring + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticsWorkspaceResourceId +The ARM ID of the Log Analytics Workspace that is used for monitoring + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticsWorkspaceSharedKey +The shared key of the log analytics workspace that is used for monitoring + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorSubnetResourceId +The subnet which the SAP monitor will be deployed in. +It should be the same subnet of HANA database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SapMonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.Api20200207Preview.ISapMonitor + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HanaOnAzure/New-AzSapMonitorProviderInstance.md b/azps-10.1.0/Az.HanaOnAzure/New-AzSapMonitorProviderInstance.md new file mode 100644 index 0000000000..ec54115856 --- /dev/null +++ b/azps-10.1.0/Az.HanaOnAzure/New-AzSapMonitorProviderInstance.md @@ -0,0 +1,429 @@ +--- +external help file: +Module Name: Az.HanaOnAzure +online version: https://learn.microsoft.com/powershell/module/az.hanaonazure/new-azsapmonitorproviderinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/New-AzSapMonitorProviderInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/New-AzSapMonitorProviderInstance.md +--- + +# New-AzSapMonitorProviderInstance + +## SYNOPSIS +Creates a provider instance for the specified subscription, resource group, SapMonitor name, and resource name. + +## SYNTAX + +### ByString (Default) +``` +New-AzSapMonitorProviderInstance -Name <String> -ResourceGroupName <String> -SapMonitorName <String> + -HanaDatabaseName <String> -HanaDatabasePassword <SecureString> -HanaDatabaseSqlPort <Int32> + -HanaDatabaseUsername <String> -HanaHostname <String> -ProviderType <String> [-SubscriptionId <String>] + [-Metadata <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### ByDict +``` +New-AzSapMonitorProviderInstance -Name <String> -ResourceGroupName <String> -SapMonitorName <String> + -InstanceProperty <Hashtable> -ProviderType <String> [-SubscriptionId <String>] [-Metadata <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ByKeyVault +``` +New-AzSapMonitorProviderInstance -Name <String> -ResourceGroupName <String> -SapMonitorName <String> + -HanaDatabaseName <String> -HanaDatabasePasswordKeyVaultResourceId <String> + -HanaDatabasePasswordSecretId <String> -HanaDatabaseSqlPort <Int32> -HanaDatabaseUsername <String> + -HanaHostname <String> -ProviderType <String> [-SubscriptionId <String>] [-Metadata <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a provider instance for the specified subscription, resource group, SapMonitor name, and resource name. + +## EXAMPLES + +### Example 1: Create an instance of SAP monitor by string for HANA +```powershell +New-AzSapMonitorProviderInstance -ResourceGroupName nancyc-hn1 -Name ps-sapmonitorins-t01 -SapMonitorName yemingmonitor -ProviderType SapHana -HanaHostname 'hdb1-0' -HanaDatabaseName 'SYSTEMDB' -HanaDatabaseSqlPort 30015 -HanaDatabaseUsername SYSTEM -HanaDatabasePassword (ConvertTo-SecureString "Manager1" -AsPlainText -Force) +``` + +```output +Name Type +---- ---- +ps-sapmonitorins-t01 Microsoft.HanaOnAzure/sapMonitors/providerInstances +``` + +This command creates an instance of SAP monitor by string for HANA. + +### Example 2: Create an instance of SAP monitor by key vault for HANA +```powershell +New-AzSapMonitorProviderInstance -ResourceGroupName nancyc-hn1 -SapMonitorName sapMonitor-vayh7q-test -ProviderType SapHana -HanaHostname 'hdb1-0' -HanaDatabaseName 'SYSTEMDB' -HanaDatabaseSqlPort 30015 -HanaDatabaseUsername SYSTEM -HanaDatabasePasswordSecretId https://kv-9gosjc-test.vault.azure.net/secrets/hanaPassword/bf516d1dfcc144138e5cf55114f3344b -HanaDatabasePasswordKeyVaultResourceId /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/costmanagement-rg-8p50xe/providers/Microsoft.KeyVault/vaults/kv-9gosjc-test -Name sapins-kv-test +``` + +```output +Name Type +---- ---- +sapins-kv-test Microsoft.HanaOnAzure/sapMonitors/providerInstances +``` + +This command creates an instance of SAP monitor by key vault for HANA. + +### Example 3: Create an instance of SAP monitor by dictionary for PrometheusHaCluster +```powershell +New-AzSapMonitorProviderInstance -ResourceGroupName donaliu-HN1 -Name dolauli-instance-promclt -SapMonitorName dolauli-test04 -ProviderType PrometheusHaCluster -InstanceProperty @{prometheusUrl='http://10.4.1.10:9664/metrics'} +``` + +```output +Name Type +---- ---- +dolauli-instance-promclt Microsoft.HanaOnAzure/sapMonitors/providerInstances +``` + +This command creates an instance of SAP monitor by dictionary for PrometheusHaCluster. + +### Example 4: Create an instance of SAP monitor by dictionary for PrometheusOS +```powershell +New-AzSapMonitorProviderInstance -ResourceGroupName donaliu-HN1 -Name dolauli-instance-prom -SapMonitorName dolauli-test04 -ProviderType PrometheusOS -InstanceProperty @{prometheusUrl='http://10.3.1.6:9100/metrics'} +``` + +```output +Name Type +---- ---- +dolauli-instance-prom Microsoft.HanaOnAzure/sapMonitors/providerInstances +``` + +This command creates an instance of SAP monitor by dictionary for PrometheusOS. + +### Example 5: Create an instance of SAP monitor by dictionary for MsSqlServer +```powershell +New-AzSapMonitorProviderInstance -ResourceGroupName donaliu-HN1 -Name dolauli-instance-ms -SapMonitorName dolauli-test04 -ProviderType MsSqlServer -InstanceProperty @{sqlHostname="10.4.8.90";sqlPort=1433;sqlUsername="AMFSS";sqlPassword="fakepassword"} +``` + +```output +Name Type +---- ---- +dolauli-instance-ms Microsoft.HanaOnAzure/sapMonitors/providerInstances +``` + +This command creates an instance of SAP monitor by dictionary for MsSqlServer. + +### Example 6: Create an instance of SAP monitor by dictionary for SapHana +```powershell +New-AzSapMonitorProviderInstance -ResourceGroupName donaliu-HN1 -Name dolauli-instance-hana -SapMonitorName dolauli-test04 -ProviderType SapHana -InstanceProperty @{hanaHostname="10.1.2.6";hanaDbName="SYSTEMDB";hanaDbSqlPort=30113;hanaDbUsername="SYSTEM"; hanaDbPassword="Manager1"} +``` + +```output +Name Type +---- ---- +dolauli-instance-hana Microsoft.HanaOnAzure/sapMonitors/providerInstances +``` + +This command creates an instance of SAP monitor by dictionary for SapHana. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HanaDatabaseName +The database name of SAP HANA instance. + +```yaml +Type: System.String +Parameter Sets: ByKeyVault, ByString +Aliases: HanaDbName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HanaDatabasePassword +The password of the database of SAP HANA instance. + +```yaml +Type: System.Security.SecureString +Parameter Sets: ByString +Aliases: HanaDbPassword + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HanaDatabasePasswordKeyVaultResourceId +Resource ID of the Key Vault that contains the HANA credentials. + +```yaml +Type: System.String +Parameter Sets: ByKeyVault +Aliases: HanaDbPasswordKeyVaultId, KeyVaultId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HanaDatabasePasswordSecretId +Secret identifier to the Key Vault secret that contains the HANA credentials. + +```yaml +Type: System.String +Parameter Sets: ByKeyVault +Aliases: HanaDbPasswordSecretId, SecretId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HanaDatabaseSqlPort +The SQL port of the database of SAP HANA instance. + +```yaml +Type: System.Int32 +Parameter Sets: ByKeyVault, ByString +Aliases: HanaDbSqlPort + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HanaDatabaseUsername +The username of the database of SAP HANA instance. + +```yaml +Type: System.String +Parameter Sets: ByKeyVault, ByString +Aliases: HanaDbUsername + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HanaHostname +The hostname of SAP HANA instance. + +```yaml +Type: System.String +Parameter Sets: ByKeyVault, ByString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceProperty +The property of HANA instance. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByDict +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +A JSON string containing metadata of the provider instance. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the provider instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ProviderInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderType +The type of provider instance. +Supported values are: "SapHana". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapMonitorName +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.Api20200207Preview.IProviderInstance + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HanaOnAzure/Remove-AzSapMonitor.md b/azps-10.1.0/Az.HanaOnAzure/Remove-AzSapMonitor.md new file mode 100644 index 0000000000..3291614c66 --- /dev/null +++ b/azps-10.1.0/Az.HanaOnAzure/Remove-AzSapMonitor.md @@ -0,0 +1,237 @@ +--- +external help file: +Module Name: Az.HanaOnAzure +online version: https://learn.microsoft.com/powershell/module/az.hanaonazure/remove-azsapmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/Remove-AzSapMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/Remove-AzSapMonitor.md +--- + +# Remove-AzSapMonitor + +## SYNOPSIS +Deletes a SAP monitor with the specified subscription, resource group, and monitor name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSapMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSapMonitor -InputObject <IHanaOnAzureIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a SAP monitor with the specified subscription, resource group, and monitor name. + +## EXAMPLES + +### Example 1: Remove a SAP monitor by name +```powershell +Remove-AzSapMonitor -ResourceGroupName nancyc-hn1 -Name ps-sapmonitor-t02 +``` + +This command removes a SAP monitor by name. + +### Example 2: Remove a SAP monitor by object +```powershell +$sap = Get-AzSapMonitor -ResourceGroupName nancyc-hn1 -Name ps-sapmonitor-t01 +Remove-AzSapMonitor -InputObject $sap +``` + +This command removes a SAP monitor by object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.IHanaOnAzureIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SapMonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.IHanaOnAzureIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IHanaOnAzureIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the deleted vault. + - `[OperationKind <AccessPolicyUpdateKind?>]`: Name of the operation + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: Name of the resource group. + - `[ResourceName <String>]`: The name of the identity resource. + - `[SapMonitorName <String>]`: Name of the SAP monitor resource. + - `[Scope <String>]`: The resource provider scope of the resource. Parent resource being extended by Managed Identities. + - `[SubscriptionId <String>]`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VaultName <String>]`: Name of the vault + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HanaOnAzure/Remove-AzSapMonitorProviderInstance.md b/azps-10.1.0/Az.HanaOnAzure/Remove-AzSapMonitorProviderInstance.md new file mode 100644 index 0000000000..e897bd3d62 --- /dev/null +++ b/azps-10.1.0/Az.HanaOnAzure/Remove-AzSapMonitorProviderInstance.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.HanaOnAzure +online version: https://learn.microsoft.com/powershell/module/az.hanaonazure/remove-azsapmonitorproviderinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/Remove-AzSapMonitorProviderInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/Remove-AzSapMonitorProviderInstance.md +--- + +# Remove-AzSapMonitorProviderInstance + +## SYNOPSIS +Deletes a provider instance for the specified subscription, resource group, SapMonitor name, and resource name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSapMonitorProviderInstance -Name <String> -ResourceGroupName <String> -SapMonitorName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSapMonitorProviderInstance -InputObject <IHanaOnAzureIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a provider instance for the specified subscription, resource group, SapMonitor name, and resource name. + +## EXAMPLES + +### Example 1: Remove instance of SAP monitor by name +```powershell +Remove-AzSapMonitorProviderInstance -ResourceGroupName nancyc-hn1 -SapMonitorName ps-spamonitor-t01 -Name ps-sapmonitorins-t02 +``` + +This command removes instance of SAP monitor by name. + +### Example 2: Remove instance of SAP monitor by object +```powershell +$sapIns = Get-AzSapMonitorProviderInstance -ResourceGroupName nancyc-hn1 -SapMonitorName ps-spamonitor-t01 -Name ps-sapmonitorins-t01 +Remove-AzSapMonitorProviderInstance -InputObject $sapIns +``` + +This command removes instance of SAP monitor by object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.IHanaOnAzureIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the provider instance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ProviderInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapMonitorName +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.IHanaOnAzureIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IHanaOnAzureIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the deleted vault. + - `[OperationKind <AccessPolicyUpdateKind?>]`: Name of the operation + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: Name of the resource group. + - `[ResourceName <String>]`: The name of the identity resource. + - `[SapMonitorName <String>]`: Name of the SAP monitor resource. + - `[Scope <String>]`: The resource provider scope of the resource. Parent resource being extended by Managed Identities. + - `[SubscriptionId <String>]`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VaultName <String>]`: Name of the vault + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HanaOnAzure/Update-AzSapMonitor.md b/azps-10.1.0/Az.HanaOnAzure/Update-AzSapMonitor.md new file mode 100644 index 0000000000..b801225aaf --- /dev/null +++ b/azps-10.1.0/Az.HanaOnAzure/Update-AzSapMonitor.md @@ -0,0 +1,219 @@ +--- +external help file: +Module Name: Az.HanaOnAzure +online version: https://learn.microsoft.com/powershell/module/az.hanaonazure/update-azsapmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/Update-AzSapMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HanaOnAzure/help/Update-AzSapMonitor.md +--- + +# Update-AzSapMonitor + +## SYNOPSIS +Patches the Tags field of a SAP monitor for the specified subscription, resource group, and monitor name. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSapMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSapMonitor -InputObject <IHanaOnAzureIdentity> [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Patches the Tags field of a SAP monitor for the specified subscription, resource group, and monitor name. + +## EXAMPLES + +### Example 1: Update a SAP monitor by name +```powershell +Update-AzSapMonitor -ResourceGroupName nancyc-hn1 -Name ps-spamonitor-t01 -Tag @{'key'=1;'key2'=2; 'key3'=3} +``` + +```output +Location Name Type +-------- ---- ---- +westus2 ps-spamonitor-t01 Microsoft.HanaOnAzure/sapMonitors +``` + +This commands updates a SAP monitor by name. + +### Example 2: Update a SAP monitor by object +```powershell +$sap = Get-AzSapMonitor -ResourceGroupName nancyc-hn1 -Name ps-sapmonitor-t01 +Update-AzSapMonitor -InputObject $sap -Tag @{'key'=1;'key2'=2; 'key3'=3} +``` + +```output +Location Name Type +-------- ---- ---- +westus2 ps-sapmonitor-t01 Microsoft.HanaOnAzure/sapMonitors +``` + +This commands updates a SAP monitor by object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.IHanaOnAzureIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: SapMonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags field of the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.IHanaOnAzureIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HanaOnAzure.Models.Api20200207Preview.ISapMonitor + +## 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 `<IHanaOnAzureIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location of the deleted vault. + - `[OperationKind <AccessPolicyUpdateKind?>]`: Name of the operation + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: Name of the resource group. + - `[ResourceName <String>]`: The name of the identity resource. + - `[SapMonitorName <String>]`: Name of the SAP monitor resource. + - `[Scope <String>]`: The resource provider scope of the resource. Parent resource being extended by Managed Identities. + - `[SubscriptionId <String>]`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[VaultName <String>]`: Name of the vault + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthBot/Az.HealthBot.md b/azps-10.1.0/Az.HealthBot/Az.HealthBot.md new file mode 100644 index 0000000000..db22ae2a7d --- /dev/null +++ b/azps-10.1.0/Az.HealthBot/Az.HealthBot.md @@ -0,0 +1,27 @@ +--- +Module Name: Az.HealthBot +Module Guid: 8a970870-ddd1-49d0-9886-3a92149e1078 +Download Help Link: https://learn.microsoft.com/powershell/module/az.healthbot +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthBot/help/Az.HealthBot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthBot/help/Az.HealthBot.md +--- + +# Az.HealthBot Module +## Description +Microsoft Azure PowerShell: HealthBot cmdlets + +## Az.HealthBot Cmdlets +### [Get-AzHealthBot](Get-AzHealthBot.md) +Get a HealthBot. + +### [New-AzHealthBot](New-AzHealthBot.md) +Create a new HealthBot. + +### [Remove-AzHealthBot](Remove-AzHealthBot.md) +Delete a HealthBot. + +### [Update-AzHealthBot](Update-AzHealthBot.md) +Patch a HealthBot. + diff --git a/azps-10.1.0/Az.HealthBot/Get-AzHealthBot.md b/azps-10.1.0/Az.HealthBot/Get-AzHealthBot.md new file mode 100644 index 0000000000..34dd2e6144 --- /dev/null +++ b/azps-10.1.0/Az.HealthBot/Get-AzHealthBot.md @@ -0,0 +1,204 @@ +--- +external help file: +Module Name: Az.HealthBot +online version: https://learn.microsoft.com/powershell/module/az.healthbot/get-azhealthbot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthBot/help/Get-AzHealthBot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthBot/help/Get-AzHealthBot.md +--- + +# Get-AzHealthBot + +## SYNOPSIS +Get a HealthBot. + +## SYNTAX + +### List1 (Default) +``` +Get-AzHealthBot [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzHealthBot -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzHealthBot -InputObject <IHealthBotIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzHealthBot -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a HealthBot. + +## EXAMPLES + +### Example 1: Get all HealthBot +```powershell +Get-AzHealthBot +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Type +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- +eastus yourihealthbot 2020/12/29 5:54:14 test@microsoft.com User 2020/12/29 5:54:19 ********-****-****-****-********** Application Microsoft.HealthBot/healthBots +eastus yourihealthbotmemory 2020/12/29 6:54:32 test@microsoft.com User 2020/12/29 6:54:36 ********-****-****-****-********** Application Microsoft.HealthBot/healthBots +``` + +Get all HealthBot + +### Example 2: Get all HealthBot by ResourceGroupName +```powershell +Get-AzHealthBot -ResourceGroupName youriTest +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Type +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- +eastus yourihealthbot 2020/12/29 5:54:14 test@microsoft.com User 2020/12/29 5:54:19 ********-****-****-****-********** Application Microsoft.HealthBot/healthBots +eastus yourihealthbotmemory 2020/12/29 6:54:32 test@microsoft.com User 2020/12/29 6:54:36 ********-****-****-****-********** Application Microsoft.HealthBot/healthBots +``` + +Get all HealthBot by ResourceGroupName + +### Example 3: Get HealthBot by ResourceGroupName and Name +```powershell +Get-AzHealthBot -ResourceGroupName youriTest -name yourihealthbot +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Type +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- +eastus yourihealthbot 2020/12/29 5:54:14 test@microsoft.com User 2020/12/29 5:54:19 ********-****-****-****-********** Application Microsoft.HealthBot/healthBots +``` + +Get HealthBot by ResourceGroupName and Name + +### Example 4: Get HealthBot by InputObject +```powershell +$getAzHealthBot = Get-AzHealthBot -ResourceGroupName youriTest -name yourihealthbot +Get-AzHealthBot -InputObject $getAzHealthBot +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Type +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- +eastus yourihealthbot 2020/12/29 5:54:14 test@microsoft.com User 2020/12/29 5:54:19 ********-****-****-****-********** Application Microsoft.HealthBot/healthBots +``` + +Get HealthBot by InputObject + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthBot.Models.IHealthBotIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Bot resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: BotName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Bot resource group in the user subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthBot.Models.IHealthBotIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthBot.Models.Api20201208.IHealthBot + +## 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 `<IHealthBotIdentity>`: Identity Parameter + - `[BotName <String>]`: The name of the Bot resource. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the Bot resource group in the user subscription. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthBot/New-AzHealthBot.md b/azps-10.1.0/Az.HealthBot/New-AzHealthBot.md new file mode 100644 index 0000000000..d67d2e1b22 --- /dev/null +++ b/azps-10.1.0/Az.HealthBot/New-AzHealthBot.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.HealthBot +online version: https://learn.microsoft.com/powershell/module/az.healthbot/new-azhealthbot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthBot/help/New-AzHealthBot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthBot/help/New-AzHealthBot.md +--- + +# New-AzHealthBot + +## SYNOPSIS +Create a new HealthBot. + +## SYNTAX + +``` +New-AzHealthBot -Name <String> -ResourceGroupName <String> -Location <String> -Sku <SkuName> + [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new HealthBot. + +## EXAMPLES + +### Example 1: Create new HealthBot +```powershell +New-AzHealthBot -Name yourihealthbot1 -ResourceGroupName youriTest -Location eastus -Sku F0 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Type +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- +eastus yourihealthbot 2020/12/29 8:19:10 test@microsoft.com User 2020/12/29 8:19:14 6db4d6bb-6649-4dc2-84b7-0b5c6894031e Application Microsoft.Heal… +``` + +Create new HealthBot By default + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Bot resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BotName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Bot resource group in the user subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the HealthBot SKU + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthBot.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthBot.Models.Api20201208.IHealthBot + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthBot/Remove-AzHealthBot.md b/azps-10.1.0/Az.HealthBot/Remove-AzHealthBot.md new file mode 100644 index 0000000000..1085fe8115 --- /dev/null +++ b/azps-10.1.0/Az.HealthBot/Remove-AzHealthBot.md @@ -0,0 +1,230 @@ +--- +external help file: +Module Name: Az.HealthBot +online version: https://learn.microsoft.com/powershell/module/az.healthbot/remove-azhealthbot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthBot/help/Remove-AzHealthBot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthBot/help/Remove-AzHealthBot.md +--- + +# Remove-AzHealthBot + +## SYNOPSIS +Delete a HealthBot. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzHealthBot -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzHealthBot -InputObject <IHealthBotIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a HealthBot. + +## EXAMPLES + +### Example 1: Delete HealthBot by ResourceGroupName and Name +```powershell +Remove-AzHealthBot -Name yourihealthbot -ResourceGroupName youriTest +``` + +Delete HealthBot by ResourceGroupName and Name + +### Example 2: Delete HealthBot by InputObject +```powershell +$gethealthbot = Get-AzHealthBot -Name yourihealthbot1 -ResourceGroupName youriTest +Remove-AzHealthBot -InputObject $gethealthbot +``` + +Delete HealthBot by InputObject + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthBot.Models.IHealthBotIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Bot resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: BotName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Bot resource group in the user subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthBot.Models.IHealthBotIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IHealthBotIdentity>`: Identity Parameter + - `[BotName <String>]`: The name of the Bot resource. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the Bot resource group in the user subscription. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthBot/Update-AzHealthBot.md b/azps-10.1.0/Az.HealthBot/Update-AzHealthBot.md new file mode 100644 index 0000000000..b28b7182ba --- /dev/null +++ b/azps-10.1.0/Az.HealthBot/Update-AzHealthBot.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.HealthBot +online version: https://learn.microsoft.com/powershell/module/az.healthbot/update-azhealthbot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthBot/help/Update-AzHealthBot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthBot/help/Update-AzHealthBot.md +--- + +# Update-AzHealthBot + +## SYNOPSIS +Patch a HealthBot. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzHealthBot -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Sku <SkuName>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzHealthBot -InputObject <IHealthBotIdentity> [-Sku <SkuName>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Patch a HealthBot. + +## EXAMPLES + +### Example 1: update HealthBot by Resourcegroupname and Name +```powershell +Update-AzHealthBot -ResourceGroupName youriTest -Name yourihealthbot -Sku S1 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Type +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- +eastus yourihealthbot 2020/12/29 8:19:10 test@microsoft.com User 2020/12/30 6:12:33 test@microsoft.com User Microsoft.HealthBot/health… +``` + +update HealthBot by Resourcegroupname and Name + +### Example 2: update HealthBot by InputObject +```powershell +$getHealth = Get-AzHealthBot -ResourceGroupName youriTest -Name yourihealthbot +Update-AzHealthBot -InputObject $getHealth -Sku F0 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Type +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- +eastus yourihealthbot 2020/12/29 8:19:10 test@microsoft.com User 2020/12/30 6:12:33 test@microsoft.com User Microsoft.HealthBot/health… +``` + +update HealthBot by InputObject + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthBot.Models.IHealthBotIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Bot resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: BotName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Bot resource group in the user subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the HealthBot SKU + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthBot.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags for a HealthBot. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthBot.Models.IHealthBotIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthBot.Models.Api20201208.IHealthBot + +## 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 `<IHealthBotIdentity>`: Identity Parameter + - `[BotName <String>]`: The name of the Bot resource. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the Bot resource group in the user subscription. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Az.HealthcareApis.md b/azps-10.1.0/Az.HealthcareApis/Az.HealthcareApis.md new file mode 100644 index 0000000000..ebea896cca --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Az.HealthcareApis.md @@ -0,0 +1,90 @@ +--- +Module Name: Az.HealthcareApis +Module Guid: de3f478d-0227-4782-85cf-62fb649b685a +Download Help Link: https://learn.microsoft.com/powershell/module/az.healthcareapis +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Az.HealthcareApis.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Az.HealthcareApis.md +--- + +# Az.HealthcareApis Module +## Description +Microsoft Azure PowerShell: HealthcareApis cmdlets + +## Az.HealthcareApis Cmdlets +### [Get-AzHealthcareApisService](Get-AzHealthcareApisService.md) +Get the metadata of a service instance. + +### [Get-AzHealthcareApisWorkspace](Get-AzHealthcareApisWorkspace.md) +Gets the properties of the specified workspace. + +### [Get-AzHealthcareDicomService](Get-AzHealthcareDicomService.md) +Gets the properties of the specified DICOM Service. + +### [Get-AzHealthcareFhirDestination](Get-AzHealthcareFhirDestination.md) +Lists all FHIR destinations for the given IoT Connector + +### [Get-AzHealthcareFhirService](Get-AzHealthcareFhirService.md) +Gets the properties of the specified FHIR Service. + +### [Get-AzHealthcareIotConnector](Get-AzHealthcareIotConnector.md) +Gets the properties of the specified IoT Connector. + +### [Get-AzHealthcareIotConnectorFhirDestination](Get-AzHealthcareIotConnectorFhirDestination.md) +Gets the properties of the specified Iot Connector FHIR destination. + +### [New-AzHealthcareApisService](New-AzHealthcareApisService.md) +Create or update the metadata of a service instance. + +### [New-AzHealthcareApisWorkspace](New-AzHealthcareApisWorkspace.md) +Creates or updates a workspace resource with the specified parameters. + +### [New-AzHealthcareDicomService](New-AzHealthcareDicomService.md) +Creates or updates a DICOM Service resource with the specified parameters. + +### [New-AzHealthcareFhirService](New-AzHealthcareFhirService.md) +Creates or updates a FHIR Service resource with the specified parameters. + +### [New-AzHealthcareIotConnector](New-AzHealthcareIotConnector.md) +Creates or updates an IoT Connector resource with the specified parameters. + +### [New-AzHealthcareIotConnectorFhirDestination](New-AzHealthcareIotConnectorFhirDestination.md) +Creates or updates an IoT Connector FHIR destination resource with the specified parameters. + +### [Remove-AzHealthcareApisService](Remove-AzHealthcareApisService.md) +Delete a service instance. + +### [Remove-AzHealthcareApisWorkspace](Remove-AzHealthcareApisWorkspace.md) +Deletes a specified workspace. + +### [Remove-AzHealthcareDicomService](Remove-AzHealthcareDicomService.md) +Deletes a DICOM Service. + +### [Remove-AzHealthcareFhirService](Remove-AzHealthcareFhirService.md) +Deletes a FHIR Service. + +### [Remove-AzHealthcareIotConnector](Remove-AzHealthcareIotConnector.md) +Deletes an IoT Connector. + +### [Remove-AzHealthcareIotConnectorFhirDestination](Remove-AzHealthcareIotConnectorFhirDestination.md) +Deletes an IoT Connector FHIR destination. + +### [Test-AzHealthcareServiceNameAvailability](Test-AzHealthcareServiceNameAvailability.md) +Check if a service instance name is available. + +### [Update-AzHealthcareApisService](Update-AzHealthcareApisService.md) +Update the metadata of a service instance. + +### [Update-AzHealthcareApisWorkspace](Update-AzHealthcareApisWorkspace.md) +Patch workspace details. + +### [Update-AzHealthcareDicomService](Update-AzHealthcareDicomService.md) +Patch DICOM Service details. + +### [Update-AzHealthcareFhirService](Update-AzHealthcareFhirService.md) +Patch FHIR Service details. + +### [Update-AzHealthcareIotConnector](Update-AzHealthcareIotConnector.md) +Patch an IoT Connector. + diff --git a/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareApisService.md b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareApisService.md new file mode 100644 index 0000000000..2a84950d3f --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareApisService.md @@ -0,0 +1,198 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/get-azhealthcareapisservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareApisService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareApisService.md +--- + +# Get-AzHealthcareApisService + +## SYNOPSIS +Get the metadata of a service instance. + +## SYNTAX + +### List (Default) +``` +Get-AzHealthcareApisService [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzHealthcareApisService -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzHealthcareApisService -InputObject <IHealthcareApisIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzHealthcareApisService -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the metadata of a service instance. + +## EXAMPLES + +### Example 1: List the metadata of service instance. +```powershell +Get-AzHealthcareApisService +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +eastus2 azpsapiservice fhir azps_test_group +``` + +List the metadata of service instance. + +### Example 2: List the metadata of service instance by resource group. +```powershell +Get-AzHealthcareApisService -ResourceGroupName azps_test_group +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +eastus2 azpsapiservice fhir azps_test_group +``` + +List the metadata of service instance by resource group. + +### Example 3: Get the metadata of a service instance. +```powershell +Get-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +eastus2 azpsapiservice fhir azps_test_group +``` + +Get the metadata of a service instance. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the service instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IServicesDescription + +## 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 `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareApisWorkspace.md b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareApisWorkspace.md new file mode 100644 index 0000000000..e5f6d82033 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareApisWorkspace.md @@ -0,0 +1,200 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/get-azhealthcareapisworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareApisWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareApisWorkspace.md +--- + +# Get-AzHealthcareApisWorkspace + +## SYNOPSIS +Gets the properties of the specified workspace. + +## SYNTAX + +### List (Default) +``` +Get-AzHealthcareApisWorkspace [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzHealthcareApisWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzHealthcareApisWorkspace -InputObject <IHealthcareApisIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzHealthcareApisWorkspace -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the specified workspace. + +## EXAMPLES + +### Example 1: List the properties. +```powershell +Get-AzHealthcareApisWorkspace +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws azps_test_group +eastus2 azpshcws02 azps_test_group +``` + +List the properties. + +### Example 2: Gets the properties of the specified workspace. +```powershell +Get-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws azps_test_group +``` + +Gets the properties of the specified workspace. + +### Example 3: List the properties of the resource group. +```powershell +Get-AzHealthcareApisWorkspace -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws azps_test_group +eastus2 azpshcws02 azps_test_group +``` + +List the properties of the specified resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IWorkspace + +## 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 `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareDicomService.md b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareDicomService.md new file mode 100644 index 0000000000..b0e2b2618f --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareDicomService.md @@ -0,0 +1,195 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/get-azhealthcaredicomservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareDicomService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareDicomService.md +--- + +# Get-AzHealthcareDicomService + +## SYNOPSIS +Gets the properties of the specified DICOM Service. + +## SYNTAX + +### List (Default) +``` +Get-AzHealthcareDicomService -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzHealthcareDicomService -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzHealthcareDicomService -InputObject <IHealthcareApisIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the specified DICOM Service. + +## EXAMPLES + +### Example 1: List the properties of the specified workspace. +```powershell +Get-AzHealthcareDicomService -ResourceGroupName azps_test_group -WorkspaceName azpshcws +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws/azpsdicom azps_test_group +``` + +List the properties of the specified workspace. + +### Example 2: Gets the properties of the specified DICOM Service. +```powershell +Get-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws/azpsdicom azps_test_group +``` + +Gets the properties of the specified DICOM Service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of DICOM Service resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DicomServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IDicomService + +## 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 `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareFhirDestination.md b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareFhirDestination.md new file mode 100644 index 0000000000..2b47aace30 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareFhirDestination.md @@ -0,0 +1,131 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/get-azhealthcarefhirdestination +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareFhirDestination.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareFhirDestination.md +--- + +# Get-AzHealthcareFhirDestination + +## SYNOPSIS +Lists all FHIR destinations for the given IoT Connector + +## SYNTAX + +``` +Get-AzHealthcareFhirDestination -IotConnectorName <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all FHIR destinations for the given IoT Connector + +## EXAMPLES + +### Example 1: Lists all FHIR destinations for the given IoT Connector +```powershell +Get-AzHealthcareFhirDestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws/azpsiotconnector/azpsfhirdestination azps_test_group +``` + +Lists all FHIR destinations for the given IoT Connector + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotConnectorName +The name of IoT Connector resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IIotFhirDestination + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareFhirService.md b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareFhirService.md new file mode 100644 index 0000000000..232fb3ce01 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareFhirService.md @@ -0,0 +1,195 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/get-azhealthcarefhirservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareFhirService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareFhirService.md +--- + +# Get-AzHealthcareFhirService + +## SYNOPSIS +Gets the properties of the specified FHIR Service. + +## SYNTAX + +### List (Default) +``` +Get-AzHealthcareFhirService -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzHealthcareFhirService -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzHealthcareFhirService -InputObject <IHealthcareApisIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the specified FHIR Service. + +## EXAMPLES + +### Example 1: List the properties of the specified FHIR Service. +```powershell +Get-AzHealthcareFhirService -ResourceGroupName azps_test_group -WorkspaceName azpshcws +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +eastus2 azpshcws/azpsfhirservice fhir-R4 azps_test_group +``` + +List the properties of the specified FHIR Service. + +### Example 2: Gets the properties of the specified FHIR Service. +```powershell +Get-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +eastus2 azpshcws/azpsfhirservice fhir-R4 azps_test_group +``` + +Gets the properties of the specified FHIR Service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of FHIR Service resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: FhirServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IFhirService + +## 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 `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareIotConnector.md b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareIotConnector.md new file mode 100644 index 0000000000..80e813d8e2 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareIotConnector.md @@ -0,0 +1,195 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/get-azhealthcareiotconnector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareIotConnector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareIotConnector.md +--- + +# Get-AzHealthcareIotConnector + +## SYNOPSIS +Gets the properties of the specified IoT Connector. + +## SYNTAX + +### List (Default) +``` +Get-AzHealthcareIotConnector -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzHealthcareIotConnector -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzHealthcareIotConnector -InputObject <IHealthcareApisIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the specified IoT Connector. + +## EXAMPLES + +### Example 1: List the properties of the specified IoT Connector. +```powershell +Get-AzHealthcareIotConnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws/azpsiotconnector azps_test_group +``` + +List the properties of the specified IoT Connector. + +### Example 2: Gets the properties of the specified IoT Connector. +```powershell +Get-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws/azpsiotconnector azps_test_group +``` + +Gets the properties of the specified IoT Connector. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of IoT Connector resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: IotConnectorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IIotConnector + +## 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 `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareIotConnectorFhirDestination.md b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareIotConnectorFhirDestination.md new file mode 100644 index 0000000000..8c7b249925 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Get-AzHealthcareIotConnectorFhirDestination.md @@ -0,0 +1,192 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/get-azhealthcareiotconnectorfhirdestination +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareIotConnectorFhirDestination.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Get-AzHealthcareIotConnectorFhirDestination.md +--- + +# Get-AzHealthcareIotConnectorFhirDestination + +## SYNOPSIS +Gets the properties of the specified Iot Connector FHIR destination. + +## SYNTAX + +### Get (Default) +``` +Get-AzHealthcareIotConnectorFhirDestination -FhirDestinationName <String> -IotConnectorName <String> + -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzHealthcareIotConnectorFhirDestination -InputObject <IHealthcareApisIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the specified Iot Connector FHIR destination. + +## EXAMPLES + +### Example 1: Gets the properties of the specified Iot Connector FHIR destination. +```powershell +Get-AzHealthcareIotConnectorFhirDestination -FhirDestinationName azpsfhirdestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws/azpsiotconnector/azpsfhirdestination azps_test_group +``` + +Gets the properties of the specified Iot Connector FHIR destination. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FhirDestinationName +The name of IoT Connector FHIR destination resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotConnectorName +The name of IoT Connector resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IIotFhirDestination + +## 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 `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareApisService.md b/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareApisService.md new file mode 100644 index 0000000000..a2d257f1c9 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareApisService.md @@ -0,0 +1,520 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/new-azhealthcareapisservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/New-AzHealthcareApisService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/New-AzHealthcareApisService.md +--- + +# New-AzHealthcareApisService + +## SYNOPSIS +Create or update the metadata of a service instance. + +## SYNTAX + +``` +New-AzHealthcareApisService -Name <String> -ResourceGroupName <String> -CosmosOfferThroughput <Int32> + -Kind <Kind> -Location <String> [-SubscriptionId <String>] + [-AccessPolicyObjectId <IServiceAccessPolicyEntry[]>] [-AcrConfigurationLoginServer <String[]>] + [-AcrConfigurationOciArtifact <IServiceOciArtifactEntry[]>] [-AllowCorsCredential] [-Audience <String>] + [-Authority <String>] [-CorsHeader <String[]>] [-CorsMaxAge <Int32>] [-CorsMethod <String[]>] + [-CorsOrigin <String[]>] [-CosmosKeyVaultKeyUri <String>] [-EnableSmartProxy] [-Etag <String>] + [-ExportStorageAccountName <String>] [-IdentityType <ManagedServiceIdentityType>] + [-PrivateEndpointConnection <IPrivateEndpointConnection[]>] [-PublicNetworkAccess <PublicNetworkAccess>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update the metadata of a service instance. + +## EXAMPLES + +### Example 1: Create or update the metadata of a service instance. +```powershell +New-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice -Kind 'fhir' -Location eastus2 -CosmosOfferThroughput 400 +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +eastus2 azpsapiservice fhir azps_test_group +``` + +Create or update the metadata of a service instance. + +## PARAMETERS + +### -AccessPolicyObjectId +The access policies of the service instance. +To construct, see NOTES section for ACCESSPOLICYOBJECTID properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IServiceAccessPolicyEntry[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcrConfigurationLoginServer +The list of the ACR login servers. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcrConfigurationOciArtifact +The list of Open Container Initiative (OCI) artifacts. +To construct, see NOTES section for ACRCONFIGURATIONOCIARTIFACT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IServiceOciArtifactEntry[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCorsCredential +If credentials are allowed via CORS. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Audience +The audience url for the service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authority +The authority url for the service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorsHeader +The headers to be allowed via CORS. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorsMaxAge +The max age to be allowed via CORS. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorsMethod +The methods to be allowed via CORS. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorsOrigin +The origins to be allowed via CORS. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CosmosKeyVaultKeyUri +The URI of the customer-managed key for the backing database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CosmosOfferThroughput +The provisioned throughput for the backing database. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSmartProxy +If the SMART on FHIR proxy is enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +An etag associated with the resource, used for optimistic concurrency when editing it. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportStorageAccountName +The name of the default export storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of identity being specified, currently SystemAssigned and None are allowed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +The kind of the service. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateEndpointConnection +The list of private endpoint connections that are set up for this resource. +To construct, see NOTES section for PRIVATEENDPOINTCONNECTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api10.IPrivateEndpointConnection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Control permission for data plane traffic coming from public networks while private endpoint is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IServicesDescription + +## 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. + + +ACCESSPOLICYOBJECTID <IServiceAccessPolicyEntry[]>: The access policies of the service instance. + - `ObjectId <String>`: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. + +ACRCONFIGURATIONOCIARTIFACT <IServiceOciArtifactEntry[]>: The list of Open Container Initiative (OCI) artifacts. + - `[Digest <String>]`: The artifact digest. + - `[ImageName <String>]`: The artifact name. + - `[LoginServer <String>]`: The Azure Container Registry login server. + +PRIVATEENDPOINTCONNECTION <IPrivateEndpointConnection[]>: The list of private endpoint connections that are set up for this resource. + - `[PrivateLinkServiceConnectionStateActionsRequired <String>]`: A message indicating if changes on the service provider require any updates on the consumer. + - `[PrivateLinkServiceConnectionStateDescription <String>]`: The reason for approval/rejection of the connection. + - `[PrivateLinkServiceConnectionStateStatus <PrivateEndpointServiceConnectionStatus?>]`: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareApisWorkspace.md b/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareApisWorkspace.md new file mode 100644 index 0000000000..4f1cc26705 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareApisWorkspace.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/new-azhealthcareapisworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/New-AzHealthcareApisWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/New-AzHealthcareApisWorkspace.md +--- + +# New-AzHealthcareApisWorkspace + +## SYNOPSIS +Creates or updates a workspace resource with the specified parameters. + +## SYNTAX + +``` +New-AzHealthcareApisWorkspace -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-Etag <String>] [-PublicNetworkAccess <PublicNetworkAccess>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a workspace resource with the specified parameters. + +## EXAMPLES + +### Example 1: Creates or update a workspace resource with the specified parameters. +```powershell +New-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group -Location eastus2 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws azps_test_group +``` + +Creates or update a workspace resource with the specified parameters. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +An etag associated with the resource, used for optimistic concurrency when editing it. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Control permission for data plane traffic coming from public networks while private endpoint is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IWorkspace + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareDicomService.md b/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareDicomService.md new file mode 100644 index 0000000000..20d5f6c9ea --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareDicomService.md @@ -0,0 +1,286 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/new-azhealthcaredicomservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/New-AzHealthcareDicomService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/New-AzHealthcareDicomService.md +--- + +# New-AzHealthcareDicomService + +## SYNOPSIS +Creates or updates a DICOM Service resource with the specified parameters. + +## SYNTAX + +``` +New-AzHealthcareDicomService -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + -Location <String> [-SubscriptionId <String>] [-Etag <String>] [-IdentityType <ServiceManagedIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-PublicNetworkAccess <PublicNetworkAccess>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a DICOM Service resource with the specified parameters. + +## EXAMPLES + +### Example 1: Creates or updates a DICOM Service resource with the specified parameters. +```powershell +New-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws -Location eastus2 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws/azpsdicom azps_test_group +``` + +Creates or updates a DICOM Service resource with the specified parameters. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +An etag associated with the resource, used for optimistic concurrency when editing it. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of identity being specified, currently SystemAssigned and None are allowed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.ServiceManagedIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of DICOM Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DicomServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Control permission for data plane traffic coming from public networks while private endpoint is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IDicomService + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareFhirService.md b/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareFhirService.md new file mode 100644 index 0000000000..64cc50319c --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareFhirService.md @@ -0,0 +1,533 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/new-azhealthcarefhirservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/New-AzHealthcareFhirService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/New-AzHealthcareFhirService.md +--- + +# New-AzHealthcareFhirService + +## SYNOPSIS +Creates or updates a FHIR Service resource with the specified parameters. + +## SYNTAX + +``` +New-AzHealthcareFhirService -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + -Kind <FhirServiceKind> -Location <String> [-SubscriptionId <String>] + [-AccessPolicyObjectId <IFhirServiceAccessPolicyEntry[]>] [-AcrConfigurationLoginServer <String[]>] + [-AcrConfigurationOciArtifact <IServiceOciArtifactEntry[]>] [-AllowCorsCredential] [-Audience <String>] + [-Authority <String>] [-CorsHeader <String[]>] [-CorsMaxAge <Int32>] [-CorsMethod <String[]>] + [-CorsOrigin <String[]>] [-EnableSmartProxy] [-Etag <String>] [-ExportStorageAccountName <String>] + [-IdentityType <ServiceManagedIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] + [-PublicNetworkAccess <PublicNetworkAccess>] + [-ResourceVersionPolicyConfigurationDefault <FhirResourceVersionPolicy>] + [-ResourceVersionPolicyConfigurationResourceTypeOverride <Hashtable>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a FHIR Service resource with the specified parameters. + +## EXAMPLES + +### Example 1: Creates or updates a FHIR Service resource with the specified parameters. +```powershell +New-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws -Location eastus2 -Kind 'fhir-R4' -Authority "https://login.microsoftonline.com/{DirectoryID}" -Audience "https://azpshcws-{FhirServiceName}.fhir.azurehealthcareapis.com" +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +eastus2 azpshcws/azpsfhirservice fhir-R4 azps_test_group +``` + +Creates or updates a FHIR Service resource with the specified parameters. + +## PARAMETERS + +### -AccessPolicyObjectId +Fhir Service access policies. +To construct, see NOTES section for ACCESSPOLICYOBJECTID properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IFhirServiceAccessPolicyEntry[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcrConfigurationLoginServer +The list of the Azure container registry login servers. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcrConfigurationOciArtifact +The list of Open Container Initiative (OCI) artifacts. +To construct, see NOTES section for ACRCONFIGURATIONOCIARTIFACT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IServiceOciArtifactEntry[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCorsCredential +If credentials are allowed via CORS. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Audience +The audience url for the service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authority +The authority url for the service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorsHeader +The headers to be allowed via CORS. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorsMaxAge +The max age to be allowed via CORS. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorsMethod +The methods to be allowed via CORS. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorsOrigin +The origins to be allowed via CORS. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSmartProxy +If the SMART on FHIR proxy is enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +An etag associated with the resource, used for optimistic concurrency when editing it. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportStorageAccountName +The name of the default export storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of identity being specified, currently SystemAssigned and None are allowed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.ServiceManagedIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +The kind of the service. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.FhirServiceKind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of FHIR Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FhirServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Control permission for data plane traffic coming from public networks while private endpoint is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceVersionPolicyConfigurationDefault +The default value for tracking history across all resources. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.FhirResourceVersionPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceVersionPolicyConfigurationResourceTypeOverride +A list of FHIR Resources and their version policy overrides. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IFhirService + +## 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. + + +ACCESSPOLICYOBJECTID <IFhirServiceAccessPolicyEntry[]>: Fhir Service access policies. + - `ObjectId <String>`: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. + +ACRCONFIGURATIONOCIARTIFACT <IServiceOciArtifactEntry[]>: The list of Open Container Initiative (OCI) artifacts. + - `[Digest <String>]`: The artifact digest. + - `[ImageName <String>]`: The artifact name. + - `[LoginServer <String>]`: The Azure Container Registry login server. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareIotConnector.md b/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareIotConnector.md new file mode 100644 index 0000000000..bbea966242 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareIotConnector.md @@ -0,0 +1,335 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/new-azhealthcareiotconnector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/New-AzHealthcareIotConnector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/New-AzHealthcareIotConnector.md +--- + +# New-AzHealthcareIotConnector + +## SYNOPSIS +Creates or updates an IoT Connector resource with the specified parameters. + +## SYNTAX + +``` +New-AzHealthcareIotConnector -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + -DeviceMappingContent <Hashtable> -IngestionEndpointConfigurationConsumerGroup <String> + -IngestionEndpointConfigurationEventHubName <String> + -IngestionEndpointConfigurationFullyQualifiedEventHubNamespace <String> -Location <String> + [-SubscriptionId <String>] [-Etag <String>] [-IdentityType <ServiceManagedIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an IoT Connector resource with the specified parameters. + +## EXAMPLES + +### Example 1: Creates or updates an IoT Connector resource with the specified parameters. +```powershell +$arr = @() +New-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws -Location eastus2 -IngestionEndpointConfigurationConsumerGroup "sajob-01-portal_input-01_consumer_group" -IngestionEndpointConfigurationEventHubName "sajob01portaleventhub" -IngestionEndpointConfigurationFullyQualifiedEventHubNamespace "sdk-Namespace-4761.servicebus.windows.net" -DeviceMappingContent @{"templateType"="CollectionContent";"template"=$arr} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws/azpsiotconnector azps_test_group +``` + +Creates or updates an IoT Connector resource with the specified parameters. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceMappingContent +The mapping. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +An etag associated with the resource, used for optimistic concurrency when editing it. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of identity being specified, currently SystemAssigned and None are allowed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.ServiceManagedIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngestionEndpointConfigurationConsumerGroup +Consumer group of the event hub to connected to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngestionEndpointConfigurationEventHubName +Event Hub name to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngestionEndpointConfigurationFullyQualifiedEventHubNamespace +Fully qualified namespace of the Event Hub to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of IoT Connector resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IotConnectorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IIotConnector + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareIotConnectorFhirDestination.md b/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareIotConnectorFhirDestination.md new file mode 100644 index 0000000000..6011498896 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/New-AzHealthcareIotConnectorFhirDestination.md @@ -0,0 +1,286 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/new-azhealthcareiotconnectorfhirdestination +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/New-AzHealthcareIotConnectorFhirDestination.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/New-AzHealthcareIotConnectorFhirDestination.md +--- + +# New-AzHealthcareIotConnectorFhirDestination + +## SYNOPSIS +Creates or updates an IoT Connector FHIR destination resource with the specified parameters. + +## SYNTAX + +``` +New-AzHealthcareIotConnectorFhirDestination -FhirDestinationName <String> -IotConnectorName <String> + -ResourceGroupName <String> -WorkspaceName <String> -FhirMappingContent <Hashtable> + -FhirServiceResourceId <String> -Location <String> + -ResourceIdentityResolutionType <IotIdentityResolutionType> [-SubscriptionId <String>] [-Etag <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an IoT Connector FHIR destination resource with the specified parameters. + +## EXAMPLES + +### Example 1: Creates or updates an IoT Connector FHIR destination resource with the specified parameters. +```powershell +$arr = @() +New-AzHealthcareIotConnectorFhirDestination -FhirDestinationName azpsfhirdestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws -FhirServiceResourceId "/subscriptions/{SubscriptionId}/resourceGroups/azps_test_group/providers/Microsoft.HealthcareApis/workspaces/azpshcws/fhirservices/azpsfhirservice" -ResourceIdentityResolutionType 'Create' -Location eastus2 -FhirMappingContent @{"templateType"="CollectionFhirTemplate";"template"=$arr} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws/azpsiotconnector/azpsfhirdestination azps_test_group +``` + +Creates or updates an IoT Connector FHIR destination resource with the specified parameters. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +An etag associated with the resource, used for optimistic concurrency when editing it. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FhirDestinationName +The name of IoT Connector FHIR destination resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FhirMappingContent +The mapping. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FhirServiceResourceId +Fully qualified resource id of the FHIR service to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotConnectorName +The name of IoT Connector resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceIdentityResolutionType +Determines how resource identity is resolved on the destination. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.IotIdentityResolutionType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IIotFhirDestination + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareApisService.md b/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareApisService.md new file mode 100644 index 0000000000..aa19b73b9f --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareApisService.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/remove-azhealthcareapisservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Remove-AzHealthcareApisService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Remove-AzHealthcareApisService.md +--- + +# Remove-AzHealthcareApisService + +## SYNOPSIS +Delete a service instance. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzHealthcareApisService -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzHealthcareApisService -InputObject <IHealthcareApisIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a service instance. + +## EXAMPLES + +### Example 1: Delete a service instance. +```powershell +Remove-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice +``` + +Delete a service instance. + +### Example 2: Delete a service instance. +```powershell +Get-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice | Remove-AzHealthcareApisService +``` + +Delete a service instance. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the service instance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareApisWorkspace.md b/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareApisWorkspace.md new file mode 100644 index 0000000000..9705dbed71 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareApisWorkspace.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/remove-azhealthcareapisworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Remove-AzHealthcareApisWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Remove-AzHealthcareApisWorkspace.md +--- + +# Remove-AzHealthcareApisWorkspace + +## SYNOPSIS +Deletes a specified workspace. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzHealthcareApisWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzHealthcareApisWorkspace -InputObject <IHealthcareApisIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a specified workspace. + +## EXAMPLES + +### Example 1: Deletes a specified workspace. +```powershell +Remove-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group +``` + +Deletes a specified workspace. + +### Example 2: Deletes a specified workspace. +```powershell +Get-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group | Remove-AzHealthcareApisWorkspace +``` + +Deletes a specified workspace. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareDicomService.md b/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareDicomService.md new file mode 100644 index 0000000000..5ebbfc16a0 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareDicomService.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/remove-azhealthcaredicomservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Remove-AzHealthcareDicomService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Remove-AzHealthcareDicomService.md +--- + +# Remove-AzHealthcareDicomService + +## SYNOPSIS +Deletes a DICOM Service. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzHealthcareDicomService -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzHealthcareDicomService -InputObject <IHealthcareApisIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a DICOM Service. + +## EXAMPLES + +### Example 1: Delete +```powershell +Remove-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws +``` + +Deletes a DICOM Service. + +### Example 2: DeleteViaIdentity +```powershell +Get-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Remove-AzHealthcareDicomService +``` + +Deletes a DICOM Service. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of DICOM Service resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DicomServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareFhirService.md b/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareFhirService.md new file mode 100644 index 0000000000..b78db2cc7a --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareFhirService.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/remove-azhealthcarefhirservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Remove-AzHealthcareFhirService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Remove-AzHealthcareFhirService.md +--- + +# Remove-AzHealthcareFhirService + +## SYNOPSIS +Deletes a FHIR Service. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzHealthcareFhirService -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzHealthcareFhirService -InputObject <IHealthcareApisIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a FHIR Service. + +## EXAMPLES + +### Example 1: Deletes a FHIR Service. +```powershell +Remove-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws +``` + +Deletes a FHIR Service. + +### Example 2: Deletes a FHIR Service. +```powershell +Get-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Remove-AzHealthcareFhirService +``` + +Deletes a FHIR Service. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of FHIR Service resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: FhirServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareIotConnector.md b/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareIotConnector.md new file mode 100644 index 0000000000..f99271bb98 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareIotConnector.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/remove-azhealthcareiotconnector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Remove-AzHealthcareIotConnector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Remove-AzHealthcareIotConnector.md +--- + +# Remove-AzHealthcareIotConnector + +## SYNOPSIS +Deletes an IoT Connector. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzHealthcareIotConnector -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzHealthcareIotConnector -InputObject <IHealthcareApisIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an IoT Connector. + +## EXAMPLES + +### Example 1: Deletes an IoT Connector. +```powershell +Remove-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws +``` + +Deletes an IoT Connector. + +### Example 2: Deletes an IoT Connector. +```powershell +Get-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Remove-AzHealthcareIotConnector +``` + +Deletes an IoT Connector. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of IoT Connector resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: IotConnectorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareIotConnectorFhirDestination.md b/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareIotConnectorFhirDestination.md new file mode 100644 index 0000000000..f8cc5d9640 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Remove-AzHealthcareIotConnectorFhirDestination.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/remove-azhealthcareiotconnectorfhirdestination +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Remove-AzHealthcareIotConnectorFhirDestination.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Remove-AzHealthcareIotConnectorFhirDestination.md +--- + +# Remove-AzHealthcareIotConnectorFhirDestination + +## SYNOPSIS +Deletes an IoT Connector FHIR destination. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzHealthcareIotConnectorFhirDestination -FhirDestinationName <String> -IotConnectorName <String> + -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzHealthcareIotConnectorFhirDestination -InputObject <IHealthcareApisIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an IoT Connector FHIR destination. + +## EXAMPLES + +### Example 1: Deletes an IoT Connector FHIR destination. +```powershell +Remove-AzHealthcareIotConnectorFhirDestination -FhirDestinationName azpsfhirdestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws +``` + +Deletes an IoT Connector FHIR destination. + +### Example 2: Deletes an IoT Connector FHIR destination. +```powershell +Get-AzHealthcareIotConnectorFhirDestination -FhirDestinationName azpsfhirdestination -IotConnectorName azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Remove-AzHealthcareIotConnectorFhirDestination +``` + +Deletes an IoT Connector FHIR destination. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FhirDestinationName +The name of IoT Connector FHIR destination resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotConnectorName +The name of IoT Connector resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Test-AzHealthcareServiceNameAvailability.md b/azps-10.1.0/Az.HealthcareApis/Test-AzHealthcareServiceNameAvailability.md new file mode 100644 index 0000000000..5be701dc4b --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Test-AzHealthcareServiceNameAvailability.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/test-azhealthcareservicenameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Test-AzHealthcareServiceNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Test-AzHealthcareServiceNameAvailability.md +--- + +# Test-AzHealthcareServiceNameAvailability + +## SYNOPSIS +Check if a service instance name is available. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzHealthcareServiceNameAvailability -Name <String> -Type <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Check +``` +Test-AzHealthcareServiceNameAvailability -CheckNameAvailabilityInput <ICheckNameAvailabilityParameters> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CheckViaIdentity +``` +Test-AzHealthcareServiceNameAvailability -InputObject <IHealthcareApisIdentity> + -CheckNameAvailabilityInput <ICheckNameAvailabilityParameters> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzHealthcareServiceNameAvailability -InputObject <IHealthcareApisIdentity> -Name <String> -Type <String> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Check if a service instance name is available. + +## EXAMPLES + +### Example 1: Check if a service instance name is available. +```powershell +Test-AzHealthcareServiceNameAvailability -Name azpsdicom -Type Microsoft.HealthcareApis/services +``` + +```output +Message NameAvailable Reason +------- ------------- ------ + True +``` + +Check if a service instance name is available. + +## PARAMETERS + +### -CheckNameAvailabilityInput +Input values. +To construct, see NOTES section for CHECKNAMEAVAILABILITYINPUT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.ICheckNameAvailabilityParameters +Parameter Sets: Check, CheckViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: CheckViaIdentity, CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the service instance to check. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: Check, CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The fully qualified resource type which includes provider namespace. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.ICheckNameAvailabilityParameters + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IServicesNameAvailabilityInfo + +## 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. + + +CHECKNAMEAVAILABILITYINPUT `<ICheckNameAvailabilityParameters>`: Input values. + - `Name <String>`: The name of the service instance to check. + - `Type <String>`: The fully qualified resource type which includes provider namespace. + +INPUTOBJECT `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareApisService.md b/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareApisService.md new file mode 100644 index 0000000000..1034b92c7f --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareApisService.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/update-azhealthcareapisservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Update-AzHealthcareApisService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Update-AzHealthcareApisService.md +--- + +# Update-AzHealthcareApisService + +## SYNOPSIS +Update the metadata of a service instance. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzHealthcareApisService -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzHealthcareApisService -InputObject <IHealthcareApisIdentity> + [-PublicNetworkAccess <PublicNetworkAccess>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update the metadata of a service instance. + +## EXAMPLES + +### Example 1: Update the metadata of a service instance. +```powershell +Update-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice -Tag @{"abc"="123"} +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +eastus2 azpsapiservice fhir azps_test_group +``` + +Update the metadata of a service instance. + +### Example 2: Update the metadata of a service instance. +```powershell +Get-AzHealthcareApisService -ResourceGroupName azps_test_group -Name azpsapiservice | Update-AzHealthcareApisService -Tag @{"abc"="123"} +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +eastus2 azpsapiservice fhir azps_test_group +``` + +Update the metadata of a service instance. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the service instance. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Control permission for data plane traffic coming from public networks while private endpoint is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Instance tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IServicesDescription + +## 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 `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareApisWorkspace.md b/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareApisWorkspace.md new file mode 100644 index 0000000000..8d10634b3b --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareApisWorkspace.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/update-azhealthcareapisworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Update-AzHealthcareApisWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Update-AzHealthcareApisWorkspace.md +--- + +# Update-AzHealthcareApisWorkspace + +## SYNOPSIS +Patch workspace details. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzHealthcareApisWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzHealthcareApisWorkspace -InputObject <IHealthcareApisIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Patch workspace details. + +## EXAMPLES + +### Example 1: Patch workspace details. +```powershell +Update-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group -Tag @{"abc"="123"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws azps_test_group +``` + +Patch workspace details. + +### Example 2: Patch workspace details. +```powershell +Get-AzHealthcareApisWorkspace -Name azpshcws -ResourceGroupName azps_test_group | Update-AzHealthcareApisWorkspace -Tag @{"abc"="123"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws azps_test_group +``` + +Patch workspace details. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IWorkspace + +## 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 `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareDicomService.md b/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareDicomService.md new file mode 100644 index 0000000000..d723be2187 --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareDicomService.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/update-azhealthcaredicomservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Update-AzHealthcareDicomService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Update-AzHealthcareDicomService.md +--- + +# Update-AzHealthcareDicomService + +## SYNOPSIS +Patch DICOM Service details. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzHealthcareDicomService -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-IdentityType <ServiceManagedIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzHealthcareDicomService -InputObject <IHealthcareApisIdentity> + [-IdentityType <ServiceManagedIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Patch DICOM Service details. + +## EXAMPLES + +### Example 1: Patch DICOM Service details. +```powershell +Update-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws -Tag @{"123"="abc"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws/azpsdicom azps_test_group +``` + +Patch DICOM Service details. + +### Example 2: Patch DICOM Service details. +```powershell +Get-AzHealthcareDicomService -Name azpsdicom -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Update-AzHealthcareDicomService -Tag @{"123"="abc"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws/azpsdicom azps_test_group +``` + +Patch DICOM Service details. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of identity being specified, currently SystemAssigned and None are allowed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.ServiceManagedIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of DICOM Service resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: DicomServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IDicomService + +## 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 `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareFhirService.md b/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareFhirService.md new file mode 100644 index 0000000000..011a0592af --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareFhirService.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/update-azhealthcarefhirservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Update-AzHealthcareFhirService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Update-AzHealthcareFhirService.md +--- + +# Update-AzHealthcareFhirService + +## SYNOPSIS +Patch FHIR Service details. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzHealthcareFhirService -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-IdentityType <ServiceManagedIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzHealthcareFhirService -InputObject <IHealthcareApisIdentity> + [-IdentityType <ServiceManagedIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Patch FHIR Service details. + +## EXAMPLES + +### Example 1: Patch FHIR Service details. +```powershell +Update-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws -Tag @{"123"="abc"} +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +eastus2 azpshcws/azpsfhirservice fhir-R4 azps_test_group +``` + +Patch FHIR Service details. + +### Example 2: Patch FHIR Service details. +```powershell +Get-AzHealthcareFhirService -Name azpsfhirservice -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Update-AzHealthcareFhirService -Tag @{"123"="abc"} +``` + +```output +Location Name Kind ResourceGroupName +-------- ---- ---- ----------------- +eastus2 azpshcws/azpsfhirservice fhir-R4 azps_test_group +``` + +Patch FHIR Service details. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of identity being specified, currently SystemAssigned and None are allowed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.ServiceManagedIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of FHIR Service resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: FhirServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IFhirService + +## 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 `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareIotConnector.md b/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareIotConnector.md new file mode 100644 index 0000000000..374403b17e --- /dev/null +++ b/azps-10.1.0/Az.HealthcareApis/Update-AzHealthcareIotConnector.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.HealthcareApis +online version: https://learn.microsoft.com/powershell/module/az.healthcareapis/update-azhealthcareiotconnector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Update-AzHealthcareIotConnector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/HealthcareApis/help/Update-AzHealthcareIotConnector.md +--- + +# Update-AzHealthcareIotConnector + +## SYNOPSIS +Patch an IoT Connector. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzHealthcareIotConnector -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-IdentityType <ServiceManagedIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzHealthcareIotConnector -InputObject <IHealthcareApisIdentity> + [-IdentityType <ServiceManagedIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Patch an IoT Connector. + +## EXAMPLES + +### Example 1: Patch an IoT Connector. +```powershell +Update-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws -Tag @{"123"="abc"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws/azpsiotconnector azps_test_group +``` + +Patch an IoT Connector. + +### Example 2: Patch an IoT Connector. +```powershell +Get-AzHealthcareIotConnector -Name azpsiotconnector -ResourceGroupName azps_test_group -WorkspaceName azpshcws | Update-AzHealthcareIotConnector -Tag @{"123"="abc"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpshcws/azpsiotconnector azps_test_group +``` + +Patch an IoT Connector. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of identity being specified, currently SystemAssigned and None are allowed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Support.ServiceManagedIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of IoT Connector resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: IotConnectorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the service instance. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of workspace resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.IHealthcareApisIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HealthcareApis.Models.Api20211101.IIotConnector + +## 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 `<IHealthcareApisIdentity>`: Identity Parameter + - `[DicomServiceName <String>]`: The name of DICOM Service resource. + - `[FhirDestinationName <String>]`: The name of IoT Connector FHIR destination resource. + - `[FhirServiceName <String>]`: The name of FHIR Service resource. + - `[GroupName <String>]`: The name of the private link resource group. + - `[Id <String>]`: Resource identity path + - `[IotConnectorName <String>]`: The name of IoT Connector resource. + - `[LocationName <String>]`: The location of the operation. + - `[OperationResultId <String>]`: The ID of the operation result to get. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group that contains the service instance. + - `[ResourceName <String>]`: The name of the service instance. + - `[SubscriptionId <String>]`: The subscription identifier. + - `[WorkspaceName <String>]`: The name of workspace resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImageBuilder/Az.ImageBuilder.md b/azps-10.1.0/Az.ImageBuilder/Az.ImageBuilder.md new file mode 100644 index 0000000000..32f2ecbebf --- /dev/null +++ b/azps-10.1.0/Az.ImageBuilder/Az.ImageBuilder.md @@ -0,0 +1,45 @@ +--- +Module Name: Az.ImageBuilder +Module Guid: bdedc683-d9b6-41ea-b310-d068b8c72305 +Download Help Link: https://learn.microsoft.com/powershell/module/az.imagebuilder +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/Az.ImageBuilder.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/Az.ImageBuilder.md +--- + +# Az.ImageBuilder Module +## Description +Microsoft Azure PowerShell: ImageBuilder cmdlets + +## Az.ImageBuilder Cmdlets +### [Get-AzImageBuilderTemplate](Get-AzImageBuilderTemplate.md) +Get information about a virtual machine image template + +### [Get-AzImageBuilderTemplateRunOutput](Get-AzImageBuilderTemplateRunOutput.md) +Get the specified run output for the specified image template resource + +### [New-AzImageBuilderTemplate](New-AzImageBuilderTemplate.md) +Create or update a virtual machine image template + +### [New-AzImageBuilderTemplateCustomizerObject](New-AzImageBuilderTemplateCustomizerObject.md) +Create an in-memory object for ImageTemplateCustomizer. + +### [New-AzImageBuilderTemplateDistributorObject](New-AzImageBuilderTemplateDistributorObject.md) +Create an in-memory object for ImageTemplateDistributor. + +### [New-AzImageBuilderTemplateSourceObject](New-AzImageBuilderTemplateSourceObject.md) +Create an in-memory object for ImageTemplateSource. + +### [New-AzImageBuilderTemplateValidatorObject](New-AzImageBuilderTemplateValidatorObject.md) +Create an in-memory object for ImageTemplateValidator. + +### [Remove-AzImageBuilderTemplate](Remove-AzImageBuilderTemplate.md) +Delete a virtual machine image template + +### [Start-AzImageBuilderTemplate](Start-AzImageBuilderTemplate.md) +Create artifacts from a existing image template + +### [Stop-AzImageBuilderTemplate](Stop-AzImageBuilderTemplate.md) +Cancel the long running image build based on the image template + diff --git a/azps-10.1.0/Az.ImageBuilder/Get-AzImageBuilderTemplate.md b/azps-10.1.0/Az.ImageBuilder/Get-AzImageBuilderTemplate.md new file mode 100644 index 0000000000..2a76ad7701 --- /dev/null +++ b/azps-10.1.0/Az.ImageBuilder/Get-AzImageBuilderTemplate.md @@ -0,0 +1,197 @@ +--- +external help file: +Module Name: Az.ImageBuilder +online version: https://learn.microsoft.com/powershell/module/az.imagebuilder/get-azimagebuildertemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/Get-AzImageBuilderTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/Get-AzImageBuilderTemplate.md +--- + +# Get-AzImageBuilderTemplate + +## SYNOPSIS +Get information about a virtual machine image template + +## SYNTAX + +### List (Default) +``` +Get-AzImageBuilderTemplate [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzImageBuilderTemplate -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzImageBuilderTemplate -InputObject <IImageBuilderIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzImageBuilderTemplate -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get information about a virtual machine image template + +## EXAMPLES + +### Example 1: List all template under a subscription +```powershell +Get-AzImageBuilderTemplate +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +eastus bez-test-img-temp +eastus bez-test-img-temp12 +eastus bez-test-img-temp13 +eastus test-img-temp +``` + +This command lists all template under a subscription. + +### Example 2: List all template under a resource group +```powershell +Get-AzImageBuilderTemplate -ResourceGroupName bez-rg +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +eastus bez-test-img-temp +eastus bez-test-img-temp12 +eastus bez-test-img-temp13 +eastus test-img-temp +``` + +This command lists all template under a resource group. + +### Example 3: Get a template under a resource group +```powershell +Get-AzImageBuilderTemplate -Name test-img-temp -ResourceGroupName bez-rg +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------ +eastus test-img-temp +``` + +This command gets a template under a resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.IImageBuilderIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the image Template + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ImageTemplateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription Id forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.IImageBuilderIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.IImageTemplate + +## 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 <IImageBuilderIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ImageTemplateName <String>]`: The name of the image Template + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[RunOutputName <String>]`: The name of the run output + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImageBuilder/Get-AzImageBuilderTemplateRunOutput.md b/azps-10.1.0/Az.ImageBuilder/Get-AzImageBuilderTemplateRunOutput.md new file mode 100644 index 0000000000..560d52f510 --- /dev/null +++ b/azps-10.1.0/Az.ImageBuilder/Get-AzImageBuilderTemplateRunOutput.md @@ -0,0 +1,188 @@ +--- +external help file: +Module Name: Az.ImageBuilder +online version: https://learn.microsoft.com/powershell/module/az.imagebuilder/get-azimagebuildertemplaterunoutput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/Get-AzImageBuilderTemplateRunOutput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/Get-AzImageBuilderTemplateRunOutput.md +--- + +# Get-AzImageBuilderTemplateRunOutput + +## SYNOPSIS +Get the specified run output for the specified image template resource + +## SYNTAX + +### List (Default) +``` +Get-AzImageBuilderTemplateRunOutput -ImageTemplateName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzImageBuilderTemplateRunOutput -ImageTemplateName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzImageBuilderTemplateRunOutput -InputObject <IImageBuilderIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the specified run output for the specified image template resource + +## EXAMPLES + +### Example 1: List all run results under a template +```powershell +Get-AzImageBuilderTemplateRunOutput -ImageTemplateName test-img-temp -ResourceGroupName bez-rg +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +testrunoutput bez-rg +``` + +This command lists all run results under a template. + +### Example 2: Get a run result under a template +```powershell +Get-AzImageBuilderTemplateRunOutput -ImageTemplateName test-img-temp -ResourceGroupName bez-rg -Name runout-template-name-u7gjq +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +runout-template-name-u7gjq +``` + +This command gets a run result under a template. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageTemplateName +The name of the image Template + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.IImageBuilderIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the run output + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RunOutputName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription Id forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.IImageBuilderIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.IRunOutput + +## 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 <IImageBuilderIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ImageTemplateName <String>]`: The name of the image Template + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[RunOutputName <String>]`: The name of the run output + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplate.md b/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplate.md new file mode 100644 index 0000000000..1b03041feb --- /dev/null +++ b/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplate.md @@ -0,0 +1,606 @@ +--- +external help file: +Module Name: Az.ImageBuilder +online version: https://learn.microsoft.com/powershell/module/az.imagebuilder/new-azimagebuildertemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/New-AzImageBuilderTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/New-AzImageBuilderTemplate.md +--- + +# New-AzImageBuilderTemplate + +## SYNOPSIS +Create or update a virtual machine image template + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzImageBuilderTemplate -Name <String> -ResourceGroupName <String> -Customize <IImageTemplateCustomizer[]> + -Distribute <IImageTemplateDistributor[]> -Location <String> -Source <IImageTemplateSource> + -UserAssignedIdentityId <String> [-SubscriptionId <String>] [-BuildTimeoutInMinute <Int32>] + [-StagingResourceGroup <String>] [-Tag <Hashtable>] [-ValidateContinueDistributeOnFailure] + [-ValidateSourceValidationOnly] [-Validator <IImageTemplateInVMValidator[]>] [-VMProfileOsdiskSizeGb <Int32>] + [-VMProfileUserAssignedIdentity <String[]>] [-VMProfileVmsize <String>] [-VnetConfigProxyVMSize <String>] + [-VnetConfigSubnetId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CreateViaJsonString +``` +New-AzImageBuilderTemplate -Name <String> -ResourceGroupName <String> -JsonString <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### JsonTemplatePath +``` +New-AzImageBuilderTemplate -Name <String> -ResourceGroupName <String> -JsonTemplatePath <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a virtual machine image template + +## EXAMPLES + +### Example 1: Create a virtual machine image template +```powershell +# Create a platform image source +$source = New-AzImageBuilderTemplateSourceObject -PlatformImageSource -Publisher 'Canonical' -Offer 'UbuntuServer' -Sku '18.04-LTS' -Version 'latest' +# Create a shell customizer +$customizer = New-AzImageBuilderTemplateCustomizerObject -ShellCustomizer -Name 'CheckSumCompareShellScript' -ScriptUri 'https://raw.githubusercontent.com/danielsollondon/azvmimagebuilder/master/quickquickstarts/customizeScript2.sh' -Sha256Checksum 'ade4c5214c3c675e92c66e2d067a870c5b81b9844b3de3cc72c49ff36425fc93' +# Create a shared image distributor +$distributor = New-AzImageBuilderTemplateDistributorObject -SharedImageDistributor -ArtifactTag @{tag='dis-share'} -GalleryImageId '/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/bez-rg/providers/Microsoft.Compute/galleries/bez_gallery/images/bez-image' -ReplicationRegion 'eastus2' -RunOutputName 'runoutput-01' -ExcludeFromLatest $false +# the userAssignedIdentity should have access permissions to the image above +$userAssignedIdentity = '/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourcegroups/bez-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/bez-id' +# Create a virtual machine image template +New-AzImageBuilderTemplate -Name bez-test-img-temp -ResourceGroupName bez-rg -Location eastus -UserAssignedIdentityId $userAssignedIdentity -Source $source -Customize $customizer -Distribute $distributor +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +eastus bez-test-img-temp +``` + +This commands creates a virtual machine image template. + +### Example 2: Create a virtual machine image template via Json file +```powershell +# request_body.json +# { +# "location": "eastus", +# "properties": { +# "source": { +# "type": "PlatformImage", +# "publisher": "Canonical", +# "offer": "UbuntuServer", +# "sku": "18.04-LTS", +# "version": "latest" +# }, +# "customize": [ +# { +# "type": "Shell", +# "name": "CheckSumCompareShellScript", +# "scriptUri": "https://raw.githubusercontent.com/danielsollondon/azvmimagebuilder/master/quickquickstarts/customizeScript2.sh", +# "sha256Checksum": "ade4c5214c3c675e92c66e2d067a870c5b81b9844b3de3cc72c49ff36425fc93" +# } +# ], +# "distribute": [ +# { +# "type": "SharedImage", +# "runOutputName": "runoutput-01", +# "artifactTags": { +# "tag": "dis-share" +# }, +# "galleryImageId": "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/bez-rg/providers/Microsoft.Compute/galleries/bez_gallery/images/bez-image", +# "replicationRegions": [ +# "eastus2" +# ], +# "excludeFromLatest": false +# } +# ] +# }, +# "identity": { +# "type": "UserAssigned", +# "userAssignedIdentities": { +# "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourcegroups/bez-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/bez-id": {} +# } +# } +# } +New-AzImageBuilderTemplate -Name bez-test-img-temp12 -ResourceGroupName bez-rg -JsonTemplatePath ./request_body.json +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +eastus bez-test-img-temp12 +``` + +This commands creates a virtual machine image template via Json file. + +### Example 3: Create a virtual machine image template via Json string +```powershell +New-AzImageBuilderTemplate -Name bez-test-img-temp13 -ResourceGroupName bez-rg -JsonString '{ + "location": "eastus", + "properties": { + "source": { + "type": "PlatformImage", + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "latest" + }, + "customize": [ + { + "type": "Shell", + "name": "CheckSumCompareShellScript", + "scriptUri": "https://raw.githubusercontent.com/danielsollondon/azvmimagebuilder/master/quickquickstarts/customizeScript2.sh", + "sha256Checksum": "ade4c5214c3c675e92c66e2d067a870c5b81b9844b3de3cc72c49ff36425fc93" + } + ], + "distribute": [ + { + "type": "SharedImage", + "runOutputName": "runoutput-01", + "artifactTags": { + "tag": "dis-share" + }, + "galleryImageId": "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/bez-rg/providers/Microsoft.Compute/galleries/bez_gallery/images/bez-image", + "replicationRegions": [ + "eastus2" + ], + "excludeFromLatest": false + } + ] + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourcegroups/bez-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/bez-id": {} + } + } +}' +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +eastus bez-test-img-temp12 +``` + +This commands creates a virtual machine image template via Json stri. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BuildTimeoutInMinute + + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Customize +To construct, see NOTES section for CUSTOMIZE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.IImageTemplateCustomizer[] +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Distribute +To construct, see NOTES section for DISTRIBUTE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.IImageTemplateDistributor[] +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string. + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonTemplatePath + + +```yaml +Type: System.String +Parameter Sets: JsonTemplatePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the image Template + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ImageTemplateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +To construct, see NOTES section for SOURCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.IImageTemplateSource +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StagingResourceGroup + + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription Id forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag + + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId + + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidateContinueDistributeOnFailure + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidateSourceValidationOnly + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Validator +To construct, see NOTES section for VALIDATOR properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.IImageTemplateInVMValidator[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMProfileOsdiskSizeGb + + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMProfileUserAssignedIdentity + + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMProfileVmsize + + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetConfigProxyVMSize + + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetConfigSubnetId + + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.IImageTemplate + +## 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. + + +`CUSTOMIZE <IImageTemplateCustomizer[]>`: + - `Type <String>`: The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer + - `[Name <String>]`: Friendly Name to provide context on what this customization step does + +`DISTRIBUTE <IImageTemplateDistributor[]>`: + - `RunOutputName <String>`: The name to be used for the associated RunOutput. + - `Type <String>`: Type of distribution. + - `[ArtifactTag <IImageTemplateDistributorArtifactTags>]`: Tags that will be applied to the artifact once it has been created/updated by the distributor. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +`SOURCE <IImageTemplateSource>`: + - `Type <String>`: Specifies the type of source image you want to start with. + +`VALIDATOR <IImageTemplateInVMValidator[]>`: + - `Type <String>`: The type of validation you want to use on the Image. For example, "Shell" can be shell validation + - `[Name <String>]`: Friendly Name to provide context on what this validation step does + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplateCustomizerObject.md b/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplateCustomizerObject.md new file mode 100644 index 0000000000..81de647e41 --- /dev/null +++ b/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplateCustomizerObject.md @@ -0,0 +1,459 @@ +--- +external help file: +Module Name: Az.ImageBuilder +online version: https://learn.microsoft.com/powershell/module/az.ImageBuilder/new-azimagebuildertemplatecustomizerobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/New-AzImageBuilderTemplateCustomizerObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/New-AzImageBuilderTemplateCustomizerObject.md +--- + +# New-AzImageBuilderTemplateCustomizerObject + +## SYNOPSIS +Create an in-memory object for ImageTemplateCustomizer. + +## SYNTAX + +### FileCustomizer (Default) +``` +New-AzImageBuilderTemplateCustomizerObject -FileCustomizer [-Destination <String>] [-Name <String>] + [-Sha256Checksum <String>] [-SourceUri <String>] [<CommonParameters>] +``` + +### PowerShellCustomizer +``` +New-AzImageBuilderTemplateCustomizerObject -PowerShellCustomizer [-Inline <String[]>] [-Name <String>] + [-RunAsSystem <Boolean>] [-RunElevated <Boolean>] [-ScriptUri <String>] [-Sha256Checksum <String>] + [-ValidExitCode <Int32[]>] [<CommonParameters>] +``` + +### RestartCustomizer +``` +New-AzImageBuilderTemplateCustomizerObject -RestartCustomizer [-Name <String>] [-RestartCheckCommand <String>] + [-RestartCommand <String>] [-RestartTimeout <String>] [<CommonParameters>] +``` + +### ShellCustomizer +``` +New-AzImageBuilderTemplateCustomizerObject -ShellCustomizer [-Inline <String[]>] [-Name <String>] + [-ScriptUri <String>] [-Sha256Checksum <String>] [<CommonParameters>] +``` + +### WindowsUpdateCustomizer +``` +New-AzImageBuilderTemplateCustomizerObject -WindowsUpdateCustomizer [-Filter <String[]>] [-Name <String>] + [-SearchCriterion <String>] [-UpdateLimit <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ImageTemplateCustomizer. + +## EXAMPLES + +### Example 1: Create a windows update customizer +```powershell +New-AzImageBuilderTemplateCustomizerObject -WindowsUpdateCustomizer -Name 'WindUpdate' -Filter ("BrowseOnly", "IsInstalled") -SearchCriterion "BrowseOnly=0 and IsInstalled=0" -UpdateLimit 100 +``` + +```output +Name Filter SearchCriterion UpdateLimit +---- ------ --------------- ----------- +WindUpdate {BrowseOnly, IsInstalled} BrowseOnly=0 and IsInstalled=0 100 +``` + +This command creates a windows update customizer. + +### Example 2: Create a file customizer +```powershell +New-AzImageBuilderTemplateCustomizerObject -FileCustomizer -Name 'filecus' -Destination 'c:\\buildArtifacts\\index.html' -SourceUri 'https://github.com/danielsollondon/azvmimagebuilder/blob/master/quickquickstarts/exampleArtifacts/buildArtifacts/index.html' +``` + +```output +Name Destination Sha256Checksum SourceUri +---- ----------- -------------- --------- +filecus c:\\buildArtifacts\\index.html https://github.com/danielsollondon/azvmimagebuilder/blob/master/quickquickstarts/exampleArtifacts/buildArtifacts/index.html +``` + +This command creates a file customizer. + +### Example 3: Create a powershell customizer +```powershell +New-AzImageBuilderTemplateCustomizerObject -PowerShellCustomizer -Name settingUpMgmtAgtPath -RunElevated $false -Inline "mkdir c:\\buildActions", "echo Azure-Image-Builder-Was-Here > c:\\buildActions\\buildActionsOutput.txt" +``` + +```output +Name Inline RunAsSystem +---- ------ ----------- +settingUpMgmtAgtPath {mkdir c:\\buildActions, echo Azure-Image-Builder-Was-Here > c:\\buildActions\\buildActionsOutput.txt} +``` + +This command creates a powershell customizer. + +### Example 4: Create a restart customizer +```powershell +New-AzImageBuilderTemplateCustomizerObject -RestartCustomizer -Name 'restcus' -RestartCommand 'shutdown /f /r /t 0 /c \"packer restart\"' -RestartCheckCommand 'powershell -command "& {Write-Output "restarted."}"' -RestartTimeout '10m' +``` + +```output +Name RestartCheckCommand RestartCommand RestartTimeout +---- ------------------- -------------- -------------- +restcus powershell -command "& {Write-Output "restarted."}" shutdown /f /r /t 0 /c \"packer restart\" 10m +``` + +This command creates a restart customizer. + +### Example 5: Create a shell customizer +```powershell +New-AzImageBuilderTemplateCustomizerObject -ShellCustomizer -Name downloadBuildArtifacts -ScriptUri "https://raw.githubusercontent.com/danielsollondon/azvmimagebuilder/master/quickquickstarts/customizeScript2.sh" +``` + +```output +Name Inline ScriptUri +---- ------ --------- +downloadBuildArtifacts https://raw.githubusercontent.com/danielsollondon/azvmimagebuilder/master/quickquickstarts/cus… +``` + +This command creates a shell customizer. + +## PARAMETERS + +### -Destination +The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM. + +```yaml +Type: System.String +Parameter Sets: FileCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileCustomizer +Uploads files to VMs (Linux, Windows). +Corresponds to Packer file provisioner. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FileCustomizer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Array of filters to select updates to apply. +Omit or specify empty array to use the default (no filter). +Refer to above link for examples and detailed description of this field. + +```yaml +Type: System.String[] +Parameter Sets: WindowsUpdateCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Inline +Array of PowerShell commands to execute. + +```yaml +Type: System.String[] +Parameter Sets: PowerShellCustomizer, ShellCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Friendly Name to provide context on what this customization step does. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PowerShellCustomizer +Runs the specified PowerShell on the VM (Windows). +Corresponds to Packer powershell provisioner. +Exactly one of 'scriptUri' or 'inline' can be specified. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PowerShellCustomizer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestartCheckCommand +Command to check if restart succeeded [Default: '']. + +```yaml +Type: System.String +Parameter Sets: RestartCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestartCommand +Command to execute the restart [Default: 'shutdown /r /f /t 0 /c "packer restart"']. + +```yaml +Type: System.String +Parameter Sets: RestartCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestartCustomizer +Reboots a VM and waits for it to come back online (Windows). +Corresponds to Packer windows-restart provisioner + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RestartCustomizer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestartTimeout +Restart timeout specified as a string of magnitude and unit, e.g. +'5m' (5 minutes) or '2h' (2 hours) [Default: '5m']. + +```yaml +Type: System.String +Parameter Sets: RestartCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunAsSystem +If specified, the PowerShell script will be run with elevated privileges using the Local System user. +Can only be true when the runElevated field above is set to true. + +```yaml +Type: System.Boolean +Parameter Sets: PowerShellCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunElevated +If specified, the PowerShell script will be run with elevated privileges. + +```yaml +Type: System.Boolean +Parameter Sets: PowerShellCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptUri +URI of the PowerShell script to be run for customizing. +It can be a github link, SAS URI for Azure Storage, etc. + +```yaml +Type: System.String +Parameter Sets: PowerShellCustomizer, ShellCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchCriterion +Criteria to search updates. +Omit or specify empty string to use the default (search all). +Refer to above link for examples and detailed description of this field. + +```yaml +Type: System.String +Parameter Sets: WindowsUpdateCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sha256Checksum +SHA256 checksum of the file provided in the sourceUri field above. + +```yaml +Type: System.String +Parameter Sets: FileCustomizer, PowerShellCustomizer, ShellCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShellCustomizer +Runs a shell script during the customization phase (Linux). +Corresponds to Packer shell provisioner. +Exactly one of 'scriptUri' or 'inline' can be specified. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ShellCustomizer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceUri +The URI of the file to be uploaded for customizing the VM. +It can be a github link, SAS URI for Azure Storage, etc. + +```yaml +Type: System.String +Parameter Sets: FileCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateLimit +Maximum number of updates to apply at a time. +Omit or specify 0 to use the default (1000). + +```yaml +Type: System.Int32 +Parameter Sets: WindowsUpdateCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidExitCode +Valid exit codes for the PowerShell script. +[Default: 0]. + +```yaml +Type: System.Int32[] +Parameter Sets: PowerShellCustomizer +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowsUpdateCustomizer +Installs Windows Updates. +Corresponds to Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update) + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WindowsUpdateCustomizer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.ImageTemplateFileCustomizer + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.ImageTemplatePowerShellCustomizer + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.ImageTemplateRestartCustomizer + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.ImageTemplateShellCustomizer + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.ImageTemplateWindowsUpdateCustomizer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplateDistributorObject.md b/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplateDistributorObject.md new file mode 100644 index 0000000000..900b1cf053 --- /dev/null +++ b/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplateDistributorObject.md @@ -0,0 +1,276 @@ +--- +external help file: +Module Name: Az.ImageBuilder +online version: https://learn.microsoft.com/powershell/module/az.ImageBuilder/new-azimagebuildertemplatedistributorobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/New-AzImageBuilderTemplateDistributorObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/New-AzImageBuilderTemplateDistributorObject.md +--- + +# New-AzImageBuilderTemplateDistributorObject + +## SYNOPSIS +Create an in-memory object for ImageTemplateDistributor. + +## SYNTAX + +### VhdDistributor (Default) +``` +New-AzImageBuilderTemplateDistributorObject -RunOutputName <String> -VhdDistributor + [-ArtifactTag <IImageTemplateDistributorArtifactTags>] [<CommonParameters>] +``` + +### ManagedImageDistributor +``` +New-AzImageBuilderTemplateDistributorObject -ImageId <String> -Location <String> -ManagedImageDistributor + -RunOutputName <String> [-ArtifactTag <IImageTemplateDistributorArtifactTags>] [<CommonParameters>] +``` + +### SharedImageDistributor +``` +New-AzImageBuilderTemplateDistributorObject -GalleryImageId <String> -ReplicationRegion <String[]> + -RunOutputName <String> -SharedImageDistributor [-ArtifactTag <IImageTemplateDistributorArtifactTags>] + [-ExcludeFromLatest <Boolean>] [-StorageAccountType <SharedImageStorageAccountType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ImageTemplateDistributor. + +## EXAMPLES + +### Example 1: Create a managed image distributor +```powershell +New-AzImageBuilderTemplateDistributorObject -ManagedImageDistributor -ArtifactTag @{tag='lucasManage'} -ImageId /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/wyunchi-imagebuilder/providers/Microsoft.Compute/images/lucas-linux-imageshare -RunOutputName luacas-runout -Location eastus +``` + +```output +RunOutputName ImageId +------------- ------- +luacas-runout /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/wyunchi-imagebuilder/providers/Microsoft.Co… +``` + +This command creates a managed image distributor. + +### Example 2: Create a VHD distributor +```powershell +New-AzImageBuilderTemplateDistributorObject -ArtifactTag @{tag='vhd'} -VhdDistributor -RunOutputName image-vhd +``` + +```output +RunOutputName +------------- +image-vhd +``` + +This command creates a VHD distributor. + +### Example 3: Create a shared image distributor +```powershell +New-AzImageBuilderTemplateDistributorObject -SharedImageDistributor -ArtifactTag @{tag='dis-share'} -GalleryImageId '/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/wyunchi-imagebuilder/providers/Microsoft.Compute/galleries/myimagegallery/images/lcuas-linux-share' -ReplicationRegion eastus2 -RunOutputName 'outname' -ExcludeFromLatest $false +``` + +```output +RunOutputName ExcludeFromLatest GalleryImageId +------------- ----------------- -------------- +outname False /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/wyunchi-imagebuilder/prov… +``` + +This command creates a shared image distributor. + +## PARAMETERS + +### -ArtifactTag +Tags that will be applied to the artifact once it has been created/updated by the distributor. +To construct, see NOTES section for ARTIFACTTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.IImageTemplateDistributorArtifactTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeFromLatest +Flag that indicates whether created image version should be excluded from latest. +Omit to use the default (false). + +```yaml +Type: System.Boolean +Parameter Sets: SharedImageDistributor +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GalleryImageId +Resource Id of the Shared Image Gallery image. + +```yaml +Type: System.String +Parameter Sets: SharedImageDistributor +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageId +Resource Id of the Managed Disk Image. + +```yaml +Type: System.String +Parameter Sets: ManagedImageDistributor +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Azure location for the image, should match if image already exists. + +```yaml +Type: System.String +Parameter Sets: ManagedImageDistributor +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedImageDistributor +Distribute as a Managed Disk Image. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ManagedImageDistributor +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationRegion +A list of regions that the image will be replicated to. + +```yaml +Type: System.String[] +Parameter Sets: SharedImageDistributor +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunOutputName +The name to be used for the associated RunOutput. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedImageDistributor +Distribute via Shared Image Gallery. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SharedImageDistributor +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountType +Storage account type to be used to store the shared image. +Omit to use the default (Standard_LRS). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Support.SharedImageStorageAccountType +Parameter Sets: SharedImageDistributor +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VhdDistributor +Distribute via VHD in a storage account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: VhdDistributor +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.ImageTemplateManagedImageDistributor + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.ImageTemplateSharedImageDistributor + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.ImageTemplateVhdDistributor + +## 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. + + +`ARTIFACTTAG <IImageTemplateDistributorArtifactTags>`: Tags that will be applied to the artifact once it has been created/updated by the distributor. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplateSourceObject.md b/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplateSourceObject.md new file mode 100644 index 0000000000..d1c805d84c --- /dev/null +++ b/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplateSourceObject.md @@ -0,0 +1,281 @@ +--- +external help file: +Module Name: Az.ImageBuilder +online version: https://learn.microsoft.com/powershell/module/az.ImageBuilder/new-azimagebuildertemplatesourceobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/New-AzImageBuilderTemplateSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/New-AzImageBuilderTemplateSourceObject.md +--- + +# New-AzImageBuilderTemplateSourceObject + +## SYNOPSIS +Create an in-memory object for ImageTemplateSource. + +## SYNTAX + +### PlatformImageSource (Default) +``` +New-AzImageBuilderTemplateSourceObject -PlatformImageSource [-Offer <String>] [-PlanInfoPlanName <String>] + [-PlanInfoPlanProduct <String>] [-PlanInfoPlanPublisher <String>] [-Publisher <String>] [-Sku <String>] + [-Version <String>] [<CommonParameters>] +``` + +### ManagedImageSource +``` +New-AzImageBuilderTemplateSourceObject -ImageId <String> -ManagedImageSource [<CommonParameters>] +``` + +### SharedImageVersionSource +``` +New-AzImageBuilderTemplateSourceObject -ImageVersionId <String> -SharedImageVersionSource [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ImageTemplateSource. + +## EXAMPLES + +### Example 1: Create a managed image source +```powershell +$imageid = '/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/wyunchi-imagebuilder/providers/Microsoft.Compute/images/test-linux-image' +New-AzImageBuilderTemplateSourceObject -ManagedImageSource -ImageId $imageid +``` + +```output +ImageId +------- +/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/wyunchi-imagebuilder/providers/Microsoft.Compute/images/test-linux-… +``` + +This command creates a managed image source. + +### Example 2: Create a shared image source +```powershell +New-AzImageBuilderTemplateSourceObject -SharedImageVersionSource -ImageVersionId /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/wyunchi-imagebuilder/providers/Microsoft.Compute/galleries/lucasimagegallery/images/myimagedefinition/versions/1.0.0 +``` + +```output +ImageVersionId +-------------- +/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/wyunchi-imagebuilder/providers/Microsoft.Compute/gallerie… +``` + +This command creates a shared image source. + +### Example 3: Create a platfrom image source +```powershell +New-AzImageBuilderTemplateSourceObject -PlatformImageSource -Publisher 'Canonical' -Offer 'UbuntuServer' -Sku '18.04-LTS' -Version 'latest' +``` + +```output +ExactVersion Offer Publisher Sku Version +------------ ----- --------- --- ------- + UbuntuServer Canonical 18.04-LTS latest +``` + +This command creates a platfrom image source. + +## PARAMETERS + +### -ImageId +ARM resource id of the managed image in customer subscription. + +```yaml +Type: System.String +Parameter Sets: ManagedImageSource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageVersionId +ARM resource id of the image version in the shared image gallery. + +```yaml +Type: System.String +Parameter Sets: SharedImageVersionSource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedImageSource +Describes an image source that is a managed image in customer subscription. +This image must reside in the same subscription and region as the Image Builder template. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ManagedImageSource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Offer +Image offer from the [Azure Gallery Images](https://learn.microsoft.com/en-us/rest/api/compute/virtualmachineimages). + +```yaml +Type: System.String +Parameter Sets: PlatformImageSource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanInfoPlanName +Name of the purchase plan. + +```yaml +Type: System.String +Parameter Sets: PlatformImageSource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanInfoPlanProduct +Product of the purchase plan. + +```yaml +Type: System.String +Parameter Sets: PlatformImageSource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanInfoPlanPublisher +Publisher of the purchase plan. + +```yaml +Type: System.String +Parameter Sets: PlatformImageSource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlatformImageSource +Describes an image source from [Azure Gallery Images](https://learn.microsoft.com/en-us/rest/api/compute/virtualmachineimages). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PlatformImageSource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Publisher +Image Publisher in [Azure Gallery Images](https://learn.microsoft.com/en-us/rest/api/compute/virtualmachineimages). + +```yaml +Type: System.String +Parameter Sets: PlatformImageSource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedImageVersionSource +Describes an image source that is an image version in a shared image gallery. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SharedImageVersionSource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +Image sku from the [Azure Gallery Images](https://learn.microsoft.com/en-us/rest/api/compute/virtualmachineimages). + +```yaml +Type: System.String +Parameter Sets: PlatformImageSource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Image version from the [Azure Gallery Images](https://learn.microsoft.com/en-us/rest/api/compute/virtualmachineimages). +If 'latest' is specified here, the version is evaluated when the image build takes place, not when the template is submitted. + +```yaml +Type: System.String +Parameter Sets: PlatformImageSource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.ImageTemplateManagedImageSource + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.ImageTemplatePlatformImageSource + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.ImageTemplateSharedImageVersionSource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplateValidatorObject.md b/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplateValidatorObject.md new file mode 100644 index 0000000000..702eeae89e --- /dev/null +++ b/azps-10.1.0/Az.ImageBuilder/New-AzImageBuilderTemplateValidatorObject.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.ImageBuilder +online version: https://learn.microsoft.com/powershell/module/az.ImageBuilder/new-azimagebuildertemplatevalidatorobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/New-AzImageBuilderTemplateValidatorObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/New-AzImageBuilderTemplateValidatorObject.md +--- + +# New-AzImageBuilderTemplateValidatorObject + +## SYNOPSIS +Create an in-memory object for ImageTemplateValidator. + +## SYNTAX + +### PowerShellValidator (Default) +``` +New-AzImageBuilderTemplateValidatorObject -PowerShellValidator [-Inline <String[]>] [-Name <String>] + [-RunAsSystem <Boolean>] [-RunElevated <Boolean>] [-ScriptUri <String>] [-Sha256Checksum <String>] + [-ValidExitCode <Int32[]>] [<CommonParameters>] +``` + +### ShellValidator +``` +New-AzImageBuilderTemplateValidatorObject -ShellValidator [-Inline <String[]>] [-Name <String>] + [-ScriptUri <String>] [-Sha256Checksum <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ImageTemplateValidator. + +## EXAMPLES + +### Example 1: Create a PowerShell validator +```powershell +New-AzImageBuilderTemplateValidatorObject -PowerShellValidator -Name PowerShellValidator -ScriptUri "https://example.com/path/to/script.sh" +``` + +```output +Name Inline RunAsSystem RunElevated ScriptUri Sha256Checksum ValidExitCode +---- ------ ----------- ----------- --------- -------------- ------------- +PowerShellValidator https://example.com/path/to/script.sh +``` + +This command creates a powershell validator. + +### Example 2: Create a Shell validator +```powershell +New-AzImageBuilderTemplateValidatorObject -ShellValidator -Name ShellValidator -ScriptUri "https://example.com/path/to/script.sh" +``` + +```output +Name Inline ScriptUri Sha256Checksum +---- ------ --------- -------------- +ShellValidator https://example.com/path/to/script.sh +``` + +This command creates a shell validator. + +## PARAMETERS + +### -Inline +Array of PowerShell commands to execute. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Friendly Name to provide context on what this validation step does. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PowerShellValidator +Runs the specified PowerShell script during the validation phase (Windows). +Corresponds to Packer powershell provisioner. +Exactly one of 'scriptUri' or 'inline' can be specified. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PowerShellValidator +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunAsSystem +If specified, the PowerShell script will be run with elevated privileges using the Local System user. +Can only be true when the runElevated field above is set to true. + +```yaml +Type: System.Boolean +Parameter Sets: PowerShellValidator +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunElevated +If specified, the PowerShell script will be run with elevated privileges. + +```yaml +Type: System.Boolean +Parameter Sets: PowerShellValidator +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptUri +URI of the PowerShell script to be run for validation. +It can be a github link, Azure Storage URI, etc. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sha256Checksum +SHA256 checksum of the power shell script provided in the scriptUri field above. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShellValidator +Runs the specified shell script during the validation phase (Linux). +Corresponds to Packer shell provisioner. +Exactly one of 'scriptUri' or 'inline' can be specified. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ShellValidator +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidExitCode +Valid exit codes for the PowerShell script. +[Default: 0]. + +```yaml +Type: System.Int32[] +Parameter Sets: PowerShellValidator +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.ImageTemplatePowerShellValidator + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.Api20220214.ImageTemplateShellValidator + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImageBuilder/Remove-AzImageBuilderTemplate.md b/azps-10.1.0/Az.ImageBuilder/Remove-AzImageBuilderTemplate.md new file mode 100644 index 0000000000..f94b13bbc0 --- /dev/null +++ b/azps-10.1.0/Az.ImageBuilder/Remove-AzImageBuilderTemplate.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.ImageBuilder +online version: https://learn.microsoft.com/powershell/module/az.imagebuilder/remove-azimagebuildertemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/Remove-AzImageBuilderTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/Remove-AzImageBuilderTemplate.md +--- + +# Remove-AzImageBuilderTemplate + +## SYNOPSIS +Delete a virtual machine image template + +## SYNTAX + +### Delete (Default) +``` +Remove-AzImageBuilderTemplate -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzImageBuilderTemplate -InputObject <IImageBuilderIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a virtual machine image template + +## EXAMPLES + +### Example 1: Remove a image template +```powershell +Remove-AzImageBuilderTemplate -Name bez-test-img-temp13 -ResourceGroupName bez-rg +``` + +This command removes a image template. + +### Example 2: Remove a image template +```powershell +Get-AzImageBuilderTemplate -Name bez-test-img-temp13 -ResourceGroupName bez-rg | Remove-AzImageBuilderTemplate +``` + +This command removes a image template. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.IImageBuilderIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the image Template + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ImageTemplateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription Id forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.IImageBuilderIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IImageBuilderIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ImageTemplateName <String>]`: The name of the image Template + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[RunOutputName <String>]`: The name of the run output + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImageBuilder/Start-AzImageBuilderTemplate.md b/azps-10.1.0/Az.ImageBuilder/Start-AzImageBuilderTemplate.md new file mode 100644 index 0000000000..a5722d5f6e --- /dev/null +++ b/azps-10.1.0/Az.ImageBuilder/Start-AzImageBuilderTemplate.md @@ -0,0 +1,237 @@ +--- +external help file: +Module Name: Az.ImageBuilder +online version: https://learn.microsoft.com/powershell/module/az.imagebuilder/start-azimagebuildertemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/Start-AzImageBuilderTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/Start-AzImageBuilderTemplate.md +--- + +# Start-AzImageBuilderTemplate + +## SYNOPSIS +Create artifacts from a existing image template + +## SYNTAX + +### Run (Default) +``` +Start-AzImageBuilderTemplate -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RunViaIdentity +``` +Start-AzImageBuilderTemplate -InputObject <IImageBuilderIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create artifacts from a existing image template + +## EXAMPLES + +### Example 1: Start an image template +```powershell +Start-AzImageBuilderTemplate -Name bez-test-img-temp12 -ResourceGroupName bez-rg +``` + +```output +Id Name PSJobTypeName State HasMoreData Location Command +-- ---- ------------- ----- ----------- -------- ------- +1 Start-AzImageB… Running True localhost Start-AzImageBuilderTemp… +``` + +This command starts an image template. + +### Example 2: Start an image template +```powershell +Get-AzImageBuilderTemplate -Name bez-test-img-temp12 -ResourceGroupName bez-rg | Start-AzImageBuilderTemplate +``` + +This command starts an image template. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.IImageBuilderIdentity +Parameter Sets: RunViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the image Template + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: ImageTemplateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription Id forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.IImageBuilderIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IImageBuilderIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ImageTemplateName <String>]`: The name of the image Template + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[RunOutputName <String>]`: The name of the run output + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImageBuilder/Stop-AzImageBuilderTemplate.md b/azps-10.1.0/Az.ImageBuilder/Stop-AzImageBuilderTemplate.md new file mode 100644 index 0000000000..206c995559 --- /dev/null +++ b/azps-10.1.0/Az.ImageBuilder/Stop-AzImageBuilderTemplate.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.ImageBuilder +online version: https://learn.microsoft.com/powershell/module/az.imagebuilder/stop-azimagebuildertemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/Stop-AzImageBuilderTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImageBuilder/help/Stop-AzImageBuilderTemplate.md +--- + +# Stop-AzImageBuilderTemplate + +## SYNOPSIS +Cancel the long running image build based on the image template + +## SYNTAX + +### Cancel (Default) +``` +Stop-AzImageBuilderTemplate -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CancelViaIdentity +``` +Stop-AzImageBuilderTemplate -InputObject <IImageBuilderIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Cancel the long running image build based on the image template + +## EXAMPLES + +### Example 1: Stop image template creation +```powershell +Stop-AzImageBuilderTemplate -Name bez-test-img-temp12 -ResourceGroupName bez-rg +``` + +This command stops image template creation. + +### Example 2: Stop image template creation +```powershell +Get-AzImageBuilderTemplate -Name bez-test-img-temp12 -ResourceGroupName bez-rg | Stop-AzImageBuilderTemplate +``` + +This command stops image template creation. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.IImageBuilderIdentity +Parameter Sets: CancelViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the image Template + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: ImageTemplateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription Id forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.IImageBuilderIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IImageBuilderIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ImageTemplateName <String>]`: The name of the image Template + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[RunOutputName <String>]`: The name of the run output + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImportExport/Az.ImportExport.md b/azps-10.1.0/Az.ImportExport/Az.ImportExport.md new file mode 100644 index 0000000000..d63f39293a --- /dev/null +++ b/azps-10.1.0/Az.ImportExport/Az.ImportExport.md @@ -0,0 +1,40 @@ +--- +Module Name: Az.ImportExport +Module Guid: 47cfc32b-a3bc-46e1-935e-11a63032bb86 +Download Help Link: https://learn.microsoft.com/powershell/module/az.importexport +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/Az.ImportExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/Az.ImportExport.md +--- + +# Az.ImportExport Module +## Description +Microsoft Azure PowerShell: ImportExport cmdlets + +## Az.ImportExport Cmdlets +### [Get-AzImportExport](Get-AzImportExport.md) +Gets information about an existing job. + +### [Get-AzImportExportBitLockerKey](Get-AzImportExportBitLockerKey.md) +Returns the BitLocker Keys for all drives in the specified job. + +### [Get-AzImportExportLocation](Get-AzImportExportLocation.md) +Returns the details about a location to which you can ship the disks associated with an import or export job. +A location is an Azure region. + +### [New-AzImportExport](New-AzImportExport.md) +Creates a new job or updates an existing job in the specified subscription. + +### [New-AzImportExportDriveListObject](New-AzImportExportDriveListObject.md) +Create a DriverList Object for ImportExport. + +### [Remove-AzImportExport](Remove-AzImportExport.md) +Deletes an existing job. +Only jobs in the Creating or Completed states can be deleted. + +### [Update-AzImportExport](Update-AzImportExport.md) +Updates specific properties of a job. +You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. +It can also be used to cancel an existing job. + diff --git a/azps-10.1.0/Az.ImportExport/Get-AzImportExport.md b/azps-10.1.0/Az.ImportExport/Get-AzImportExport.md new file mode 100644 index 0000000000..9813c052d6 --- /dev/null +++ b/azps-10.1.0/Az.ImportExport/Get-AzImportExport.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.ImportExport +online version: https://learn.microsoft.com/powershell/module/az.importexport/get-azimportexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/Get-AzImportExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/Get-AzImportExport.md +--- + +# Get-AzImportExport + +## SYNOPSIS +Gets information about an existing job. + +## SYNTAX + +### List (Default) +``` +Get-AzImportExport [-SubscriptionId <String[]>] [-Filter <String>] [-Top <Int64>] [-AcceptLanguage <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzImportExport -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-AcceptLanguage <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzImportExport -InputObject <IImportExportIdentity> [-AcceptLanguage <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzImportExport -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Filter <String>] [-Top <Int64>] + [-AcceptLanguage <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about an existing job. + +## EXAMPLES + +### Example 1: Get ImportExport job with default context +```powershell +Get-AzImportExport +``` + +```output +Location Name Type +-------- ---- ---- +East US test-job Microsoft.ImportExport/jobs +``` + +This cmdlet gets ImportExport job with default context. + +### Example 2: Get ImportExport job by resource group and job name +```powershell +Get-AzImportExport -Name test-job -ResourceGroupName ImportTestRG +``` + +```output +Location Name Type +-------- ---- ---- +East US test-job Microsoft.ImportExport/jobs +``` + +This cmdlet gets ImportExport job by resource group and job name. + +### Example 3: Lists all the ImportExport jobs in specified resource group +```powershell +Get-AzImportExport -ResourceGroupName ImportTestRG +``` + +```output +Location Name Type +-------- ---- ---- +East US test-job Microsoft.ImportExport/jobs +``` + +This cmdlet lists all the ImportExport jobs in specified resource group. + +### Example 4: Get ImportExport job by identity +```powershell +$Id = "/subscriptions/<SubscriptionId>/resourceGroups/ImportTestRG/providers/Microsoft.ImportExport/jobs/test-job" +Get-AzImportExport -InputObject $Id +``` + +```output +Location Name Type +-------- ---- ---- +East US test-job Microsoft.ImportExport/jobs +``` + +This cmdlet lists gets ImportExport job by identity. + +## PARAMETERS + +### -AcceptLanguage +Specifies the preferred language for the response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Can be used to restrict the results to certain conditions. + +```yaml +Type: System.String +Parameter Sets: List, List1 +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.ImportExport.Models.IImportExportIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the import/export job. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name uniquely identifies the resource group within the user subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID for the Azure user. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +An integer value that specifies how many jobs at most should be returned. +The value cannot exceed 100. + +```yaml +Type: System.Int64 +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.IImportExportIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.Api202101.IJobResponse + +## 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 <IImportExportIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[JobName <String>]`: The name of the import/export job. + - `[LocationName <String>]`: The name of the location. For example, West US or westus. + - `[ResourceGroupName <String>]`: The resource group name uniquely identifies the resource group within the user subscription. + - `[SubscriptionId <String>]`: The subscription ID for the Azure user. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImportExport/Get-AzImportExportBitLockerKey.md b/azps-10.1.0/Az.ImportExport/Get-AzImportExportBitLockerKey.md new file mode 100644 index 0000000000..42e94c1715 --- /dev/null +++ b/azps-10.1.0/Az.ImportExport/Get-AzImportExportBitLockerKey.md @@ -0,0 +1,131 @@ +--- +external help file: +Module Name: Az.ImportExport +online version: https://learn.microsoft.com/powershell/module/az.importexport/get-azimportexportbitlockerkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/Get-AzImportExportBitLockerKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/Get-AzImportExportBitLockerKey.md +--- + +# Get-AzImportExportBitLockerKey + +## SYNOPSIS +Returns the BitLocker Keys for all drives in the specified job. + +## SYNTAX + +``` +Get-AzImportExportBitLockerKey -JobName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-AcceptLanguage <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns the BitLocker Keys for all drives in the specified job. + +## EXAMPLES + +### Example 1: List all BitLocker Keys in specified ImportExport job +```powershell +Get-AzImportExportBitLockerKey -JobName test-job -ResourceGroupName ImportTestRG +``` + +```output +BitLockerKey DriveId +------------ ------- +238810-662376-448998-450120-652806-203390-606320-483076 9CA995BA +``` + +This cmdlet lists all BitLocker Keys in specified ImportExport job. + +## PARAMETERS + +### -AcceptLanguage +Specifies the preferred language for the response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The name of the import/export job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name uniquely identifies the resource group within the user subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID for the Azure user. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.Api202101.IDriveBitLockerKey + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImportExport/Get-AzImportExportLocation.md b/azps-10.1.0/Az.ImportExport/Get-AzImportExportLocation.md new file mode 100644 index 0000000000..7c60493b16 --- /dev/null +++ b/azps-10.1.0/Az.ImportExport/Get-AzImportExportLocation.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: Az.ImportExport +online version: https://learn.microsoft.com/powershell/module/az.importexport/get-azimportexportlocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/Get-AzImportExportLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/Get-AzImportExportLocation.md +--- + +# Get-AzImportExportLocation + +## SYNOPSIS +Returns the details about a location to which you can ship the disks associated with an import or export job. +A location is an Azure region. + +## SYNTAX + +### List (Default) +``` +Get-AzImportExportLocation [-AcceptLanguage <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzImportExportLocation -Name <String> [-AcceptLanguage <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzImportExportLocation -InputObject <IImportExportIdentity> [-AcceptLanguage <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns the details about a location to which you can ship the disks associated with an import or export job. +A location is an Azure region. + +## EXAMPLES + +### Example 1: Get all Azure region location details with default context +```powershell +Get-AzImportExportLocation +``` + +```output +Name Type +---- ---- +Australia East Microsoft.ImportExport/locations +Australia Southeast Microsoft.ImportExport/locations +Brazil South Microsoft.ImportExport/locations +Canada Central Microsoft.ImportExport/locations +Canada East Microsoft.ImportExport/locations +... +West Central US Microsoft.ImportExport/locations +West Europe Microsoft.ImportExport/locations +West India Microsoft.ImportExport/locations +West US Microsoft.ImportExport/locations +West US 2 Microsoft.ImportExport/locations +``` + +This cmdlet gets all Azure region location details with default context. + +### Example 2: Get Azure region location details by location name +```powershell +Get-AzImportExportLocation -Name eastus +``` + +```output +Name Type +---- ---- +East US Microsoft.ImportExport/locations +``` + +This cmdlet gets Azure region location details by location name. + +### Example 3: Get Azure region location details by identity +```powershell +$Id = "/providers/Microsoft.ImportExport/locations/eastus" +Get-AzImportExportLocation -InputObject $Id +``` + +```output +Name Type +---- ---- +East US Microsoft.ImportExport/locations +``` + +This cmdlet lists gets Azure region location details by identity. + +## PARAMETERS + +### -AcceptLanguage +Specifies the preferred language for the response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.IImportExportIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the location. +For example, West US or westus. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: LocationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.IImportExportIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.Api202101.ILocation + +## 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 <IImportExportIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[JobName <String>]`: The name of the import/export job. + - `[LocationName <String>]`: The name of the location. For example, West US or westus. + - `[ResourceGroupName <String>]`: The resource group name uniquely identifies the resource group within the user subscription. + - `[SubscriptionId <String>]`: The subscription ID for the Azure user. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImportExport/New-AzImportExport.md b/azps-10.1.0/Az.ImportExport/New-AzImportExport.md new file mode 100644 index 0000000000..3589bbaed4 --- /dev/null +++ b/azps-10.1.0/Az.ImportExport/New-AzImportExport.md @@ -0,0 +1,911 @@ +--- +external help file: +Module Name: Az.ImportExport +online version: https://learn.microsoft.com/powershell/module/az.importexport/new-azimportexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/New-AzImportExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/New-AzImportExport.md +--- + +# New-AzImportExport + +## SYNOPSIS +Creates a new job or updates an existing job in the specified subscription. + +## SYNTAX + +``` +New-AzImportExport -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AcceptLanguage <String>] [-ClientTenantId <String>] [-BackupDriveManifest] [-BlobListBlobPath <String[]>] + [-BlobListBlobPathPrefix <String[]>] [-CancelRequested] [-DeliveryPackageCarrierName <String>] + [-DeliveryPackageDriveCount <Int64>] [-DeliveryPackageShipDate <String>] + [-DeliveryPackageTrackingNumber <String>] [-DiagnosticsPath <String>] [-DriveList <IDriveStatus[]>] + [-EncryptionKeyKekType <EncryptionKekType>] [-EncryptionKeyKekUrl <String>] + [-EncryptionKeyKekVaultId <String>] [-ExportBlobListBlobPath <String>] [-IncompleteBlobListUri <String>] + [-JobType <String>] [-Location <String>] [-LogLevel <String>] [-PercentComplete <Int64>] + [-ProvisioningState <String>] [-ReturnAddressCity <String>] [-ReturnAddressCountryOrRegion <String>] + [-ReturnAddressEmail <String>] [-ReturnAddressPhone <String>] [-ReturnAddressPostalCode <String>] + [-ReturnAddressRecipientName <String>] [-ReturnAddressStateOrProvince <String>] + [-ReturnAddressStreetAddress1 <String>] [-ReturnAddressStreetAddress2 <String>] + [-ReturnPackageCarrierName <String>] [-ReturnPackageDriveCount <Int64>] [-ReturnPackageShipDate <String>] + [-ReturnPackageTrackingNumber <String>] [-ReturnShippingCarrierAccountNumber <String>] + [-ReturnShippingCarrierName <String>] [-ShippingInformationCity <String>] + [-ShippingInformationCountryOrRegion <String>] [-ShippingInformationPhone <String>] + [-ShippingInformationPostalCode <String>] [-ShippingInformationRecipientName <String>] + [-ShippingInformationStateOrProvince <String>] [-ShippingInformationStreetAddress1 <String>] + [-ShippingInformationStreetAddress2 <String>] [-State <String>] [-StorageAccountId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new job or updates an existing job in the specified subscription. + +## EXAMPLES + +### Example 1: Create a new ImportExport job +```powershell +$driveList = @( @{ DriveId = "9CA995BA"; BitLockerKey = "238810-662376-448998-450120-652806-203390-606320-483076"; ManifestFile = "\\DriveManifest.xml"; ManifestHash = "109B21108597EF36D5785F08303F3638"; DriveHeaderHash = "" }) +New-AzImportExport -Name test-job -ResourceGroupName ImportTestRG -Location eastus -StorageAccountId "/subscriptions/<SubscriptionId>/resourcegroups/ImportTestRG/providers/Microsoft.Storage/storageAccounts/teststorageforimport" -JobType Import -ReturnAddressRecipientName "Some name" -ReturnAddressStreetAddress1 "Street1" -ReturnAddressCity "Redmond" -ReturnAddressStateOrProvince "WA" -ReturnAddressPostalCode "98008" -ReturnAddressCountryOrRegion "USA" -ReturnAddressPhone "4250000000" -ReturnAddressEmail test@contoso.com -DiagnosticsPath "waimportexport" -BackupDriveManifest -DriveList $driveList +``` + +```output +Location Name Type +-------- ---- ---- +eastus test-job Microsoft.ImportExport/jobs +``` + +These cmdlets create a new ImportExport job. + +## PARAMETERS + +### -AcceptLanguage +Specifies the preferred language for the response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupDriveManifest +Default value is false. +Indicates whether the manifest files on the drives should be copied to block blobs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobListBlobPath +A collection of blob-path strings. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobListBlobPathPrefix +A collection of blob-prefix strings. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CancelRequested +Indicates whether a request has been submitted to cancel the job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientTenantId +The tenant ID of the client making the request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryPackageCarrierName +The name of the carrier that is used to ship the import or export drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryPackageDriveCount +The number of drives included in the package. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryPackageShipDate +The date when the package is shipped. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryPackageTrackingNumber +The tracking number of the package. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiagnosticsPath +The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DriveList +List of up to ten drives that comprise the job. +The drive list is a required element for an import job; it is not specified for export jobs. +To construct, see NOTES section for DRIVELIST properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.Api202101.IDriveStatus[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyKekType +The type of kek encryption key + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Support.EncryptionKekType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyKekUrl +Specifies the url for kek encryption key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyKekVaultId +Specifies the keyvault resource id for kek encryption key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportBlobListBlobPath +The relative URI to the block blob that contains the list of blob paths or blob path prefixes as defined above, beginning with the container name. +If the blob is in root container, the URI must begin with $root. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncompleteBlobListUri +A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. +If all blobs were exported successfully, then this element is not included in the response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobType +The type of job + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the supported Azure location where the job should be created + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogLevel +Default value is Error. +Indicates whether error logging or verbose logging will be enabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the import/export job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PercentComplete +Overall percentage completed for the job. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisioningState +Specifies the provisioning state of the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name uniquely identifies the resource group within the user subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressCity +The city name to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressCountryOrRegion +The country or region to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressEmail +Email address of the recipient of the returned drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressPhone +Phone number of the recipient of the returned drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressPostalCode +The postal code to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressRecipientName +The name of the recipient who will receive the hard drives when they are returned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressStateOrProvince +The state or province to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressStreetAddress1 +The first line of the street address to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressStreetAddress2 +The second line of the street address to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnPackageCarrierName +The name of the carrier that is used to ship the import or export drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnPackageDriveCount +The number of drives included in the package. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnPackageShipDate +The date when the package is shipped. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnPackageTrackingNumber +The tracking number of the package. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnShippingCarrierAccountNumber +The customer's account number with the carrier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnShippingCarrierName +The carrier's name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingInformationCity +The city name to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingInformationCountryOrRegion +The country or region to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingInformationPhone +Phone number of the recipient of the returned drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingInformationPostalCode +The postal code to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingInformationRecipientName +The name of the recipient who will receive the hard drives when they are returned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingInformationStateOrProvince +The state or province to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingInformationStreetAddress1 +The first line of the street address to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShippingInformationStreetAddress2 +The second line of the street address to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Current state of the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountId +The resource identifier of the storage account where data will be imported to or exported from. + +```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 subscription ID for the Azure user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specifies the tags that will be assigned to the job. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.Api202101.IJobResponse + +## 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. + + +`DRIVELIST <IDriveStatus[]>`: List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs. + - `[BitLockerKey <String>]`: The BitLocker key used to encrypt the drive. + - `[BytesSucceeded <Int64?>]`: Bytes successfully transferred for the drive. + - `[CopyStatus <String>]`: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. + - `[DriveHeaderHash <String>]`: The drive header hash value. + - `[DriveId <String>]`: The drive's hardware serial number, without spaces. + - `[ErrorLogUri <String>]`: A URI that points to the blob containing the error log for the data transfer operation. + - `[ManifestFile <String>]`: The relative path of the manifest file on the drive. + - `[ManifestHash <String>]`: The Base16-encoded MD5 hash of the manifest file on the drive. + - `[ManifestUri <String>]`: A URI that points to the blob containing the drive manifest file. + - `[PercentComplete <Int64?>]`: Percentage completed for the drive. + - `[State <DriveState?>]`: The drive's current state. + - `[VerboseLogUri <String>]`: A URI that points to the blob containing the verbose log for the data transfer operation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImportExport/New-AzImportExportDriveListObject.md b/azps-10.1.0/Az.ImportExport/New-AzImportExportDriveListObject.md new file mode 100644 index 0000000000..92d4b764f1 --- /dev/null +++ b/azps-10.1.0/Az.ImportExport/New-AzImportExportDriveListObject.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.ImportExport +online version: https://learn.microsoft.com/powershell/module/az.importexport/new-AzImportExportDriveListObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/New-AzImportExportDriveListObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/New-AzImportExportDriveListObject.md +--- + +# New-AzImportExportDriveListObject + +## SYNOPSIS +Create a DriverList Object for ImportExport. + +## SYNTAX + +``` +New-AzImportExportDriveListObject [-BitLockerKey <String>] [-BytesSucceeded <Int64>] [-CopyStatus <String>] + [-DriveHeaderHash <String>] [-DriveId <String>] [-ErrorLogUri <String>] [-ManifestFile <String>] + [-ManifestHash <String>] [-ManifestUri <String>] [-PercentComplete <Int32>] [-State <DriveState>] + [-VerboseLogUri <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a DriverList Object for ImportExport. + +## EXAMPLES + +### Example 1: Create a new DriveList for ImportExport job +```powershell +$driveList = New-AzImportExportDriveListObject -DriveId "9CA995BA" -BitLockerKey "238810-662376-448998-450120-652806-203390-606320-483076" -ManifestFile "\\DriveManifest.xml" -ManifestHash "109B21108597EF36D5785F08303F3638" +New-AzImportExport -Name test-job -ResourceGroupName ImportTestRG -Location eastus -StorageAccountId "/subscriptions/<SubscriptionId>/resourcegroups/ImportTestRG/providers/Microsoft.Storage/storageAccounts/teststorageforimport" -JobType Import -ReturnAddressRecipientName "Some name" -ReturnAddressStreetAddress1 "Street1" -ReturnAddressCity "Redmond" -ReturnAddressStateOrProvince "WA" -ReturnAddressPostalCode "98008" -ReturnAddressCountryOrRegion "USA" -ReturnAddressPhone "4250000000" -ReturnAddressEmail test@contoso.com -DiagnosticsPath "waimportexport" -BackupDriveManifest -DriveList $driveList +``` + +```output +Location Name Type +-------- ---- ---- +eastus test-job Microsoft.ImportExport/jobs +``` + +These cmdlets create a new DriveList for ImportExport job. + +## PARAMETERS + +### -BitLockerKey +The BitLocker key used to encrypt the drive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BytesSucceeded +Bytes successfully transferred for the drive. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyStatus +Detailed status about the data transfer process. +This field is not returned in the response until the drive is in the Transferring state. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DriveHeaderHash +The drive header hash value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DriveId +The drive's hardware serial number, without spaces. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ErrorLogUri +A URI that points to the blob containing the error log for the data transfer operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManifestFile +The relative path of the manifest file on the drive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManifestHash +The Base16-encoded MD5 hash of the manifest file on the drive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManifestUri +A URI that points to the blob containing the drive manifest file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PercentComplete +Percentage completed for the drive. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The drive's current state. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Support.DriveState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VerboseLogUri +A URI that points to the blob containing the verbose log for the data transfer operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.Api202101.IDriveStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImportExport/Remove-AzImportExport.md b/azps-10.1.0/Az.ImportExport/Remove-AzImportExport.md new file mode 100644 index 0000000000..78ea22fa7a --- /dev/null +++ b/azps-10.1.0/Az.ImportExport/Remove-AzImportExport.md @@ -0,0 +1,217 @@ +--- +external help file: +Module Name: Az.ImportExport +online version: https://learn.microsoft.com/powershell/module/az.importexport/remove-azimportexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/Remove-AzImportExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/Remove-AzImportExport.md +--- + +# Remove-AzImportExport + +## SYNOPSIS +Deletes an existing job. +Only jobs in the Creating or Completed states can be deleted. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzImportExport -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AcceptLanguage <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzImportExport -InputObject <IImportExportIdentity> [-AcceptLanguage <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing job. +Only jobs in the Creating or Completed states can be deleted. + +## EXAMPLES + +### Example 1: Remove ImportExport job by resourceGroup and server name +```powershell +Remove-AzImportExport -Name test-job -ResourceGroupName ImportTestRG +``` + +This cmdlet removes ImportExport job by resourceGroup and server name. + +### Example 2: Remove ImportExport job by identity +```powershell +Get-AzImportExport -Name test-job -ResourceGroupName ImportTestRG | Remove-AzImportExport +``` + +These cmdlet removes ImportExport job by identity. + +## PARAMETERS + +### -AcceptLanguage +Specifies the preferred language for the response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.IImportExportIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the import/export job. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name uniquely identifies the resource group within the user subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID for the Azure user. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.IImportExportIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IImportExportIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[JobName <String>]`: The name of the import/export job. + - `[LocationName <String>]`: The name of the location. For example, West US or westus. + - `[ResourceGroupName <String>]`: The resource group name uniquely identifies the resource group within the user subscription. + - `[SubscriptionId <String>]`: The subscription ID for the Azure user. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ImportExport/Update-AzImportExport.md b/azps-10.1.0/Az.ImportExport/Update-AzImportExport.md new file mode 100644 index 0000000000..1bd27a453d --- /dev/null +++ b/azps-10.1.0/Az.ImportExport/Update-AzImportExport.md @@ -0,0 +1,563 @@ +--- +external help file: +Module Name: Az.ImportExport +online version: https://learn.microsoft.com/powershell/module/az.importexport/update-azimportexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/Update-AzImportExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ImportExport/help/Update-AzImportExport.md +--- + +# Update-AzImportExport + +## SYNOPSIS +Updates specific properties of a job. +You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. +It can also be used to cancel an existing job. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzImportExport -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AcceptLanguage <String>] [-BackupDriveManifest] [-CancelRequested] [-DeliveryPackageCarrierName <String>] + [-DeliveryPackageDriveCount <Int64>] [-DeliveryPackageShipDate <String>] + [-DeliveryPackageTrackingNumber <String>] [-DriveList <IDriveStatus[]>] [-LogLevel <String>] + [-ReturnAddressCity <String>] [-ReturnAddressCountryOrRegion <String>] [-ReturnAddressEmail <String>] + [-ReturnAddressPhone <String>] [-ReturnAddressPostalCode <String>] [-ReturnAddressRecipientName <String>] + [-ReturnAddressStateOrProvince <String>] [-ReturnAddressStreetAddress1 <String>] + [-ReturnAddressStreetAddress2 <String>] [-ReturnShippingCarrierAccountNumber <String>] + [-ReturnShippingCarrierName <String>] [-State <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzImportExport -InputObject <IImportExportIdentity> [-AcceptLanguage <String>] [-BackupDriveManifest] + [-CancelRequested] [-DeliveryPackageCarrierName <String>] [-DeliveryPackageDriveCount <Int64>] + [-DeliveryPackageShipDate <String>] [-DeliveryPackageTrackingNumber <String>] [-DriveList <IDriveStatus[]>] + [-LogLevel <String>] [-ReturnAddressCity <String>] [-ReturnAddressCountryOrRegion <String>] + [-ReturnAddressEmail <String>] [-ReturnAddressPhone <String>] [-ReturnAddressPostalCode <String>] + [-ReturnAddressRecipientName <String>] [-ReturnAddressStateOrProvince <String>] + [-ReturnAddressStreetAddress1 <String>] [-ReturnAddressStreetAddress2 <String>] + [-ReturnShippingCarrierAccountNumber <String>] [-ReturnShippingCarrierName <String>] [-State <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates specific properties of a job. +You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. +It can also be used to cancel an existing job. + +## EXAMPLES + +### Example 1: Update ImportExport job by resource group and server name +```powershell +Update-AzImportExport -Name test-job -ResourceGroupName ImportTestRG -DeliveryPackageCarrierName pwsh -DeliveryPackageTrackingNumber pwsh20200000 +``` + +```output +Location Name Type +-------- ---- ---- +East US test-job Microsoft.ImportExport/jobs +``` + +This cmdlet updates ImportExport job by resource group and server name. + +### Example 2: Update ImportExport job by identity. +```powershell +Get-AzImportExport -Name test-job -ResourceGroupName ImportTestRG | Update-AzImportExport -CancelRequested +``` + +```output +Location Name Type +-------- ---- ---- +East US test-job Microsoft.ImportExport/jobs +``` + +This cmdlet updates ImportExport job by identity. + +## PARAMETERS + +### -AcceptLanguage +Specifies the preferred language for the response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupDriveManifest +Indicates whether the manifest files on the drives should be copied to block blobs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CancelRequested +If specified, the value must be true. +The service will attempt to cancel the job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryPackageCarrierName +The name of the carrier that is used to ship the import or export drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryPackageDriveCount +The number of drives included in the package. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryPackageShipDate +The date when the package is shipped. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeliveryPackageTrackingNumber +The tracking number of the package. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DriveList +List of drives that comprise the job. +To construct, see NOTES section for DRIVELIST properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.Api202101.IDriveStatus[] +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.ImportExport.Models.IImportExportIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LogLevel +Indicates whether error logging or verbose logging is enabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the import/export job. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name uniquely identifies the resource group within the user subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressCity +The city name to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressCountryOrRegion +The country or region to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressEmail +Email address of the recipient of the returned drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressPhone +Phone number of the recipient of the returned drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressPostalCode +The postal code to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressRecipientName +The name of the recipient who will receive the hard drives when they are returned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressStateOrProvince +The state or province to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressStreetAddress1 +The first line of the street address to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnAddressStreetAddress2 +The second line of the street address to use when returning the drives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnShippingCarrierAccountNumber +The customer's account number with the carrier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnShippingCarrierName +The carrier's name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +If specified, the value must be Shipping, which tells the Import/Export service that the package for the job has been shipped. +The ReturnAddress and DeliveryPackage properties must have been set either in this request or in a previous request, otherwise the request will fail. + +```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 subscription ID for the Azure user. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specifies the tags that will be assigned to the job. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.IImportExportIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.Api202101.IJobResponse + +## 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. + + +`DRIVELIST <IDriveStatus[]>`: List of drives that comprise the job. + - `[BitLockerKey <String>]`: The BitLocker key used to encrypt the drive. + - `[BytesSucceeded <Int64?>]`: Bytes successfully transferred for the drive. + - `[CopyStatus <String>]`: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. + - `[DriveHeaderHash <String>]`: The drive header hash value. + - `[DriveId <String>]`: The drive's hardware serial number, without spaces. + - `[ErrorLogUri <String>]`: A URI that points to the blob containing the error log for the data transfer operation. + - `[ManifestFile <String>]`: The relative path of the manifest file on the drive. + - `[ManifestHash <String>]`: The Base16-encoded MD5 hash of the manifest file on the drive. + - `[ManifestUri <String>]`: A URI that points to the blob containing the drive manifest file. + - `[PercentComplete <Int64?>]`: Percentage completed for the drive. + - `[State <DriveState?>]`: The drive's current state. + - `[VerboseLogUri <String>]`: A URI that points to the blob containing the verbose log for the data transfer operation. + +`INPUTOBJECT <IImportExportIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[JobName <String>]`: The name of the import/export job. + - `[LocationName <String>]`: The name of the location. For example, West US or westus. + - `[ResourceGroupName <String>]`: The resource group name uniquely identifies the resource group within the user subscription. + - `[SubscriptionId <String>]`: The subscription ID for the Azure user. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.IotCentral/Az.IotCentral.md b/azps-10.1.0/Az.IotCentral/Az.IotCentral.md new file mode 100644 index 0000000000..05733d9521 --- /dev/null +++ b/azps-10.1.0/Az.IotCentral/Az.IotCentral.md @@ -0,0 +1,27 @@ +--- +Module Name: Az.IotCentral +Module Guid: df9fc69a-c019-403a-9013-eefa7eb5e27a +Download Help Link: https://learn.microsoft.com/powershell/module/az.iotcentral +Help Version: 0.1.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotCentral/IotCentral/help/Az.IotCentral.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotCentral/IotCentral/help/Az.IotCentral.md +--- + +# Az.IotCentral Module +## Description +Provides CRUD Management for IoT Central Applications. + +## Az.IotCentral Cmdlets +### [Get-AzIotCentralApp](Get-AzIotCentralApp.md) +Gets properties for either one or several IoT Central Applications. + +### [New-AzIotCentralApp](New-AzIotCentralApp.md) +Creates a new IoT Central Application. + +### [Remove-AzIotCentralApp](Remove-AzIotCentralApp.md) +Deletes an IoT Central Application. + +### [Set-AzIotCentralApp](Set-AzIotCentralApp.md) +Updates the metadata for an IoT Central Application. + diff --git a/azps-10.1.0/Az.IotCentral/Get-AzIotCentralApp.md b/azps-10.1.0/Az.IotCentral/Get-AzIotCentralApp.md new file mode 100644 index 0000000000..77cd201f03 --- /dev/null +++ b/azps-10.1.0/Az.IotCentral/Get-AzIotCentralApp.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotCentral.dll-Help.xml +Module Name: Az.IotCentral +online version: https://learn.microsoft.com/powershell/module/az.iotcentral/get-aziotcentralapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotCentral/IotCentral/help/Get-AzIotCentralApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotCentral/IotCentral/help/Get-AzIotCentralApp.md +--- + +# Get-AzIotCentralApp + +## SYNOPSIS +Gets properties for either one or several IoT Central Applications. + +## SYNTAX + +### ListIotCentralAppsParameterSet (Default) +``` +Get-AzIotCentralApp [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### InteractiveIotCentralParameterSet +``` +Get-AzIotCentralApp [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzIotCentralApp -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the metadata for either a specific IoT Central Application, or all the applications in a Resource Group or Subscription, depending on Parameter Set. + +## EXAMPLES + +### Example 1 Get Specific IoT Central Application. +```powershell +Get-AzIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" +``` + +```output +ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft + .IoTCentral/IoTApps/MyAppResourceName +Name : MyAppResourceName +Type : Microsoft.IoTCentral/IoTApps +Location : westus +Tag : {[key, val]} +Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo +ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +DisplayName : My Custom Display Name +Subdomain : MyAppSubdomain +Template : iotc-default@1.0.0 +SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +ResourceGroupName : MyResourceGroupName +Identity : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity +``` +Gets the metadata for the specified IoT Central Application. +### Example 2 Get IoT Central Applications in Subscription. +```powershell +Get-AzIotCentralApp +``` + +```output +ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft + .IoTCentral/IoTApps/MyAppResourceName +Name : MyAppResourceName +Type : Microsoft.IoTCentral/IoTApps +Location : westus +Tag : {[key, val]} +Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo +ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +DisplayName : My Custom Display Name +Subdomain : MyAppSubdomain +Template : iotc-default@1.0.0 +SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +ResourceGroupName : MyResourceGroupName +Identity : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity + +ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName2/providers/Microsoft + .IoTCentral/IoTApps/MyAppResourceName2 +Name : MyAppResourceName2 +Type : Microsoft.IoTCentral/IoTApps +Location : westus +Tag : {[key, val]} +Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo +ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +DisplayName : My Custom Display Name 2 +Subdomain : MyAppSubdomain2 +Template : iotc-default@1.0.0 +SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +ResourceGroupName : MyResourceGroupName2 +Identity : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity +``` +Gets the metadata for all the IoT Central Applications in the current Subscription. +### Example 3 Get IoT Central Applications in Resource Group. +```powershell +Get-AzIotCentralApp -ResourceGroupName "MyResourceGroupName" +``` + +```output +ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft + .IoTCentral/IoTApps/MyAppResourceName +Name : MyAppResourceName +Type : Microsoft.IoTCentral/IoTApps +Location : westus +Tag : {[key, val]} +Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo +ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +DisplayName : My Custom Display Name +Subdomain : MyAppSubdomain +Template : iotc-default@1.0.0 +SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +ResourceGroupName : MyResourceGroupName +Identity : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity + +ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft + .IoTCentral/IoTApps/MyAppResourceName2 +Name : MyAppResourceName2 +Type : Microsoft.IoTCentral/IoTApps +Location : westus +Tag : {[key, val]} +Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo +ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +DisplayName : My Custom Display Name 2 +Subdomain : MyAppSubdomain2 +Template : iotc-default@1.0.0 +SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +ResourceGroupName : MyResourceGroupName +Identity : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity +``` +Gets the metadata for all IoT Central Applications in the provided Resource Group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Central Application Resource. + +```yaml +Type: System.String +Parameter Sets: InteractiveIotCentralParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group. + +```yaml +Type: System.String +Parameter Sets: ListIotCentralAppsParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: InteractiveIotCentralParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Iot Central Application Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralApp + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotCentral/New-AzIotCentralApp.md b/azps-10.1.0/Az.IotCentral/New-AzIotCentralApp.md new file mode 100644 index 0000000000..9bb4a4a352 --- /dev/null +++ b/azps-10.1.0/Az.IotCentral/New-AzIotCentralApp.md @@ -0,0 +1,293 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotCentral.dll-Help.xml +Module Name: Az.IotCentral +online version: https://learn.microsoft.com/powershell/module/az.iotcentral/new-aziotcentralapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotCentral/IotCentral/help/New-AzIotCentralApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotCentral/IotCentral/help/New-AzIotCentralApp.md +--- + +# New-AzIotCentralApp + +## SYNOPSIS +Creates a new IoT Central Application. + +## SYNTAX + +``` +New-AzIotCentralApp [-Subdomain] <String> [-DisplayName <String>] [-Template <String>] [-Sku <String>] [-Identity <String>] + [-Location <String>] [-Tag <Hashtable>] [-AsJob] [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new IoT Central Application with the provided properties and metadata. For an introduction to IoT Central, see https://learn.microsoft.com/azure/iot-central/. + +## EXAMPLES + +### Example 1 Create simple IoT Central Application. +```powershell +New-AzIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" -Subdomain "MyAppSubdomain" +``` + +```output +ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft + .IoTCentral/IoTApps/MyAppResourceName +Name : MyAppResourceName +Type : Microsoft.IoTCentral/IoTApps +Location : westus +Tag : +Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo +ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +DisplayName : MyAppResourceName +Subdomain : MyAppSubdomain +Template : iotc-default@1.0.0 +SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +ResourceGroupName : MyResourceGroupName +Identity : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity +``` +Create an IoT Central application in the standard pricing tier ST2, in the region of the resource group. + +### Example 2 Create simple IoT Central Application. +```powershell +New-AzIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" -Subdomain "MyAppSubdomain" -Sku "ST2" -DisplayName "My Custom Display Name" -Template "iotc-default" -Location "westus" +``` + +```output +ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft + .IoTCentral/IoTApps/MyAppResourceName +Name : MyAppResourceName +Type : Microsoft.IoTCentral/IoTApps +Location : westus +Tag : +Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo +ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +DisplayName : My Custom Display Name +Subdomain : MyAppSubdomain +Template : iotc-default@1.0.0 +SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +ResourceGroupName : MyResourceGroupName +Identity : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity +``` +Create an IoT Central application with the standard pricing tier ST2 in the 'westus' region, with a custom display name, based on the iotc-default template. + +## PARAMETERS + +### -AsJob +Run cmdlet as a job in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Custom display name for the IoT Central application. +Default is resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Location of your IoT Central application. +Default is the location of target resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Central Application Resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +Pricing tier for IoT Central applications. +Default value is ST2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Subdomain +Subdomain for the IoT Central URL. +Each application must have a unique subdomain. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Iot Central Application Resource Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Template +IoT Central application template name. +Default is a custom application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Identity +The type of managed identity for the IoT Central application. +Default value is None. System-assigned managed identities are supported. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralApp + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotCentral/Remove-AzIotCentralApp.md b/azps-10.1.0/Az.IotCentral/Remove-AzIotCentralApp.md new file mode 100644 index 0000000000..667350abba --- /dev/null +++ b/azps-10.1.0/Az.IotCentral/Remove-AzIotCentralApp.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotCentral.dll-Help.xml +Module Name: Az.IotCentral +online version: https://learn.microsoft.com/powershell/module/az.iotcentral/remove-aziotcentralapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotCentral/IotCentral/help/Remove-AzIotCentralApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotCentral/IotCentral/help/Remove-AzIotCentralApp.md +--- + +# Remove-AzIotCentralApp + +## SYNOPSIS +Deletes an IoT Central Application. + +## SYNTAX + +### ResourceIdParameterSet (Default) +``` +Remove-AzIotCentralApp [-PassThru] -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzIotCentralApp [-PassThru] -InputObject <PSIotCentralApp> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InteractiveIotCentralParameterSet +``` +Remove-AzIotCentralApp [-PassThru] [-AsJob] [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing IoT Central Application. + +## EXAMPLES + +### Example 1 Delete and IoT Central Application +```powershell +Remove-AzIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" +``` + +Deletes the provided IoT Central Application. + +## PARAMETERS + +### -AsJob +Run cmdlet as a job in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Iot Central Application Input Object. + +```yaml +Type: Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralApp +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Central Application Resource. + +```yaml +Type: System.String +Parameter Sets: InteractiveIotCentralParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group. + +```yaml +Type: System.String +Parameter Sets: InteractiveIotCentralParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Iot Central Application Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralApp + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotCentral/Set-AzIotCentralApp.md b/azps-10.1.0/Az.IotCentral/Set-AzIotCentralApp.md new file mode 100644 index 0000000000..38c7fa85df --- /dev/null +++ b/azps-10.1.0/Az.IotCentral/Set-AzIotCentralApp.md @@ -0,0 +1,324 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotCentral.dll-Help.xml +Module Name: Az.IotCentral +online version: https://learn.microsoft.com/powershell/module/az.iotcentral/set-aziotcentralapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotCentral/IotCentral/help/Set-AzIotCentralApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotCentral/IotCentral/help/Set-AzIotCentralApp.md +--- + +# Set-AzIotCentralApp + +## SYNOPSIS +Updates the metadata for an IoT Central Application. + +## SYNTAX + +### ResourceIdParameterSet (Default) +``` +Set-AzIotCentralApp [-DisplayName <String>] [-Subdomain <String>] [-Tag <Hashtable>] [-Sku <String>] [-Identity <String>] + -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Set-AzIotCentralApp [-DisplayName <String>] [-Subdomain <String>] [-Tag <Hashtable>] [-Sku <String>] [-Identity <String>] + -InputObject <PSIotCentralApp> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InteractiveIotCentralParameterSet +``` +Set-AzIotCentralApp [-DisplayName <String>] [-Subdomain <String>] [-Tag <Hashtable>] [-Sku <String>] [-Identity <String>] [-AsJob] + [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Update the metadata for an IoT Central Application. + +## EXAMPLES + +### Example 1 Update Display Name +```powershell +Set-AzIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" -DisplayName "My New Custom Display Name" +``` + +```output +ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft + .IoTCentral/IoTApps/MyAppResourceName +Name : MyAppResourceName +Type : Microsoft.IoTCentral/IoTApps +Location : westus +Tag : +Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo +ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +DisplayName : My New Custom Display Name +Subdomain : MyAppSubdomain +Template : iotc-default@1.0.0 +SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +ResourceGroupName : MyResourceGroupName +Identity : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity +``` +Update the Display name on an existing IoT Central Application. +### Example 2 Update Subdomain +```powershell +Set-AzIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" -Subdomain "new-subdomain" +``` + +```output +ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft + .IoTCentral/IoTApps/MyAppResourceName +Name : MyAppResourceName +Type : Microsoft.IoTCentral/IoTApps +Location : westus +Tag : +Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo +ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +DisplayName : Display Name +Subdomain : new-subdomain +Template : iotc-default@1.0.0 +SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +ResourceGroupName : MyResourceGroupName +Identity : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity +``` +Update the Display name on an existing IoT Central Application. +### Example 3 Update App Sku Info +```powershell +Set-AzIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" -Sku "ST2" +``` + +```output +ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft + .IoTCentral/IoTApps/MyAppResourceName +Name : MyAppResourceName +Type : Microsoft.IoTCentral/IoTApps +Location : westus +Tag : +Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo +ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +DisplayName : Display Name +Subdomain : MyAppSubdomain +Template : iotc-default@1.0.0 +SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +ResourceGroupName : MyResourceGroupName +Identity : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity +``` +Update the sku on an existing IoT Central Application. +## PARAMETERS + +### -AsJob +Run cmdlet as a job in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Custom Display Name of the Iot Central Application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Iot Central Application Input Object. + +```yaml +Type: Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralApp +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Central Application Resource. + +```yaml +Type: System.String +Parameter Sets: InteractiveIotCentralParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group. + +```yaml +Type: System.String +Parameter Sets: InteractiveIotCentralParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Iot Central Application Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Pricing tier for IoT Central applications. +Default value is ST2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Subdomain +Subdomain of the IoT Central Application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Iot Central Application Resource Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The type of managed identity for the IoT Central application. +Default value is None. System-assigned managed identities are supported. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralApp + +## OUTPUTS + +### Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralApp + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Add-AzIotHubCertificate.md b/azps-10.1.0/Az.IotHub/Add-AzIotHubCertificate.md new file mode 100644 index 0000000000..53908f369b --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Add-AzIotHubCertificate.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/add-aziothubcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubCertificate.md +--- + +# Add-AzIotHubCertificate + +## SYNOPSIS +Create/update an Azure IoT Hub certificate. + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIotHubCertificate [-ResourceGroupName] <String> [-Name] <String> [-CertificateName] <String> + [-Path] <String> [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIotHubCertificate [-InputObject] <PSCertificateDescription> [-Path] <String> [-Etag <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIotHubCertificate [-ResourceId] <String> [-Path] <String> [-Etag <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Uploads a new certificate or to replace the existing certificate with the same name. +For a detailed explanation of CA certificates in Azure IoT Hub, see https://learn.microsoft.com/azure/iot-hub/iot-hub-x509ca-overview + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIotHubCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" +``` + +```output +Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/IotHubs/myiothub/certificates/mycertificate +ResourceGroupName : myresourcegroup +Name : myiothub +CertificateName : mycertificate +Subject : CN=mycertificate +Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 +Status : Unverified +Expiry : 1/01/2027 16:01 +Created : 1/01/2017 16:01 +Etag : AAAAAAFpGcA= +``` + +Uploads a CA certificate CER file to an IoT hub. + +### Example 2 +```powershell +Add-AzIotHubCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" -Etag "AAAAAAFPazE=" +``` + +```output +Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/IotHubs/myiothub/certificates/mycertificate +ResourceGroupName : myresourcegroup +Name : myiothub +CertificateName : mycertificate +Subject : CN=mycertificate +Thumbprint : 38303FC7371EC13DDE3E18D712C8414EE50969C7 +Status : Unverified +Expiry : 1/01/2027 16:01 +Created : 1/01/2017 16:01 +Etag : AAAAAAFpObE= +``` + +Updates a CA certificate in an IoT hub by uploading a new CER file. + +## PARAMETERS + +### -CertificateName +Name of the Certificate + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Etag of the Certificate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Certificate Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +base-64 representation of X509 certificate .cer file or .pem file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Certificate Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Add-AzIotHubConfiguration.md b/azps-10.1.0/Az.IotHub/Add-AzIotHubConfiguration.md new file mode 100644 index 0000000000..1088c32cb1 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Add-AzIotHubConfiguration.md @@ -0,0 +1,306 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/add-aziothubconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubConfiguration.md +--- + +# Add-AzIotHubConfiguration + +## SYNOPSIS +Add an IoT automatic device management configuration in a target IoT Hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIotHubConfiguration [-ResourceGroupName] <String> [-IotHubName] <String> -Name <String> + [-DeviceContent <Hashtable>] [-Priority <Int32>] [-TargetCondition <String>] [-Metric <Hashtable>] + [-Label <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIotHubConfiguration [-InputObject] <PSIotHub> -Name <String> [-DeviceContent <Hashtable>] + [-Priority <Int32>] [-TargetCondition <String>] [-Metric <Hashtable>] [-Label <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIotHubConfiguration [-ResourceId] <String> -Name <String> [-DeviceContent <Hashtable>] + [-Priority <Int32>] [-TargetCondition <String>] [-Metric <Hashtable>] [-Label <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Configuration content is json and slighty varies based on device or module intent. +Device configurations are in the form of {"deviceContent":{...}} +Module configurations are in the form of {"moduleContent":{...}} +Configurations can be defined with user provided metrics for on demand evaluation. +User metrics are json and in the form of {"queries":{...}} or {"metrics":{"queries":{...}}}. + +Note: Target condition for modules must start with "from devices.modules where". See https://learn.microsoft.com/azure/iot-hub/iot-hub-automatic-device-management for more information. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1" +``` + +Create a device configuration with default metadata. + +### Example 2 +```powershell +Add-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1" -Priority 3 -TargetCondition "tags.building=9 and tags.environment='test'" +``` + +Create a device configuration with a priority of 3 that applies on condition when a device is tagged in building 9 and the environment is 'test'. + +### Example 3 +```powershell +$metrics = @{} +$metrics.add("query1", "select deviceId from devices where tags.location='US'") +Add-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1" -Metric $metrics +``` + +Create a device configuration with user metrics. + +### Example 4 +```powershell +$labels = @{} +$labels.add("key0","value0") +$labels.add("key1","value1") +Add-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1" -Label $labels +``` + +Create a device configuration with labels. + +### Example 5 +```powershell +$prop = @{} +$prop.add("Location", "US") +$content = @{} +$content.add("properties.desired.Region", $prop) +Add-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1" -DeviceContent $content +``` + +Create a device configuration with content. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceContent +Configuration for IotHub devices. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +Map of labels to be applied to target configuration. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metric +Queries collection for configuration metrics definition. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Identifier for the configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Weight of the device configuration in case of competing rules (highest wins). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetCondition +Target condition in which a device configuration applies to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Add-AzIotHubDeployment.md b/azps-10.1.0/Az.IotHub/Add-AzIotHubDeployment.md new file mode 100644 index 0000000000..2a6cc5f319 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Add-AzIotHubDeployment.md @@ -0,0 +1,298 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/add-aziothubdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubDeployment.md +--- + +# Add-AzIotHubDeployment + +## SYNOPSIS +Add an IoT Edge deployment in a target IoT Hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIotHubDeployment [-ResourceGroupName] <String> [-IotHubName] <String> -Name <String> + [-ModulesContent <Hashtable>] [-Priority <Int32>] [-TargetCondition <String>] [-Metric <Hashtable>] + [-Label <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIotHubDeployment [-InputObject] <PSIotHub> -Name <String> [-ModulesContent <Hashtable>] + [-Priority <Int32>] [-TargetCondition <String>] [-Metric <Hashtable>] [-Label <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIotHubDeployment [-ResourceId] <String> -Name <String> [-ModulesContent <Hashtable>] [-Priority <Int32>] + [-TargetCondition <String>] [-Metric <Hashtable>] [-Label <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Edge deployments can be created with user defined metrics for on demand evaluation. +See https://learn.microsoft.com/azure/iot-edge/module-deployment-monitoring for more information. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIotHubDeployment -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "deploy1" +``` + +Create an Edge deployment with default metadata. + +### Example 2 +```powershell +Add-AzIotHubDeployment -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "deploy1" -Priority 3 -TargetCondition "tags.building=9 and tags.environment='test'" +``` + +Create an Edge deployment with a priority of 3 that applies on condition when a device is tagged in building 9 and the environment is 'test'. + +### Example 2 +```powershell +$metrics = @{} +$metrics.add("query1", "select deviceId from devices where tags.location='US'") +Add-AzIotHubDeployment -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "deploy1" -Metric $metrics +``` + +Create an Edge deployment with user metrics. + +### Example 3 +```powershell +$labels = @{} +$labels.add("key0","value0") +$labels.add("key1","value1") +Add-AzIotHubDeployment -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "deploy1" -Label $labels +``` + +Create an Edge deployment with labels. + +### Example 4 +```powershell +$content = Get-Content "C:/Edge/modules.json" | ConvertFrom-Json -AsHashtable +Add-AzIotHubDeployment -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "deploy1" -ModulesContent $content -TargetCondition "from devices.modules where tags.environment='test'" +``` + +Create an Edge deployment with content. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +Map of labels to be applied to target deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metric +Queries collection for IoT Edge deployment metrics definition. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModulesContent +Deployment content of modules for IoT Edge devices. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Identifier for the deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Weight of deployment in case of competing rules (highest wins). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetCondition +Target condition in which an Edge deployment applies to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDeployment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Add-AzIotHubDevice.md b/azps-10.1.0/Az.IotHub/Add-AzIotHubDevice.md new file mode 100644 index 0000000000..726ec5acd3 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Add-AzIotHubDevice.md @@ -0,0 +1,349 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/add-aziothubdevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubDevice.md +--- + +# Add-AzIotHubDevice + +## SYNOPSIS +Create a device in an IoT Hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIotHubDevice [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-AuthMethod <PSDeviceAuthType>] [-Status <PSDeviceStatus>] [-StatusReason <String>] [-EdgeEnabled] + [-Children <String[]>] [-ParentDeviceId <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIotHubDevice [-InputObject] <PSIotHub> [-DeviceId] <String> [-AuthMethod <PSDeviceAuthType>] + [-Status <PSDeviceStatus>] [-StatusReason <String>] [-EdgeEnabled] [-Children <String[]>] + [-ParentDeviceId <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIotHubDevice [-ResourceId] <String> [-DeviceId] <String> [-AuthMethod <PSDeviceAuthType>] + [-Status <PSDeviceStatus>] [-StatusReason <String>] [-EdgeEnabled] [-Children <String[]>] + [-ParentDeviceId <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a device with different authorization type in an IoT Hub. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIotHubDevice -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -AuthMethod "shared_private_key" -EdgeEnabled +``` + +Create an edge enabled IoT device with default authorization (shared private key). + +### Example 2 +```powershell +Add-AzIotHubDevice -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice2" -AuthMethod "x509_ca" -Status Disabled -StatusReason "Some Reason" +``` + +Create an IoT device with root CA authorization with disabled status and reason. + +### Example 3 +```powershell +Add-AzIotHubDevice -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -AuthMethod "shared_private_key" -EdgeEnabled -Children device1,device2 +``` + +Create an edge enabled IoT device and add child devices to it. + +### Example 4 +```powershell +Add-AzIotHubDevice -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -AuthMethod "shared_private_key" -ParentDeviceId parentDevice1 +``` + +Create an IoT device and set its parent device. + +## PARAMETERS + +### -AuthMethod +The authorization type an entity is to be created with. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSDeviceAuthType +Parameter Sets: (All) +Aliases: +Accepted values: shared_private_key, x509_thumbprint, x509_ca + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Children +Add child device list (comma separated) includes only non-edge devices. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeEnabled +Flag indicating edge enablement. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrites the non-edge device's parent device. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryThumbprint +Explicit self-signed certificate thumbprint to use for primary key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentDeviceId +Id of edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryThumbprint +Explicit self-signed certificate thumbprint to use for secondary key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Set device status upon creation. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSDeviceStatus +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusReason +Description for device status. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDevice + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Add-AzIotHubDeviceChildren.md b/azps-10.1.0/Az.IotHub/Add-AzIotHubDeviceChildren.md new file mode 100644 index 0000000000..72d70a2cdd --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Add-AzIotHubDeviceChildren.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/add-aziothubdevicechildren +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubDeviceChildren.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubDeviceChildren.md +--- + +# Add-AzIotHubDeviceChildren + +## SYNOPSIS +Add non-edge devices as a children to the edge device. + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIotHubDeviceChildren [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-Children] <String[]> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIotHubDeviceChildren [-InputObject] <PSIotHub> [-DeviceId] <String> [-Children] <String[]> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIotHubDeviceChildren [-ResourceId] <String> [-DeviceId] <String> [-Children] <String[]> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Add specified comma-separated list of non edge device ids as children of specified edge device. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIotHubDeviceChildren -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Children device1,device2 +``` + +```output +DeviceId ChildrenDeviceId +-------- ---------------- +myDevice1 {device1, device2} +``` + +Add non-edge devices as a children to the edge device. + +### Example 2 +```powershell +Add-AzIotHubDeviceChildren -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice2" -Children "device1,device2" -Force +``` + +```output +DeviceId ChildrenDeviceId +-------- ---------------- +myDevice2 {device1, device2} +``` + +Add non-edge devices as a children to the edge device irrespectively the non-edge device is already a child of other edge device. + +## PARAMETERS + +### -Children +Child device list (comma separated) includes only non-edge devices. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Id of edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrites the non-edge device's parent device. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDeviceChildren + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Add-AzIotHubEventHubConsumerGroup.md b/azps-10.1.0/Az.IotHub/Add-AzIotHubEventHubConsumerGroup.md new file mode 100644 index 0000000000..96d1fc3bf3 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Add-AzIotHubEventHubConsumerGroup.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/add-aziothubeventhubconsumergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubEventHubConsumerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubEventHubConsumerGroup.md +--- + +# Add-AzIotHubEventHubConsumerGroup + +## SYNOPSIS +Creates an eventhub consumer group. + +## SYNTAX + +``` +Add-AzIotHubEventHubConsumerGroup [-ResourceGroupName] <String> [-Name] <String> + [-EventHubConsumerGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a consumer group in the Eventhub associated with the specified IotHub. + +## EXAMPLES + +### Example 1: Add a consumer group to the telemetry eventhub +```powershell +Add-AzIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubConsumerGroupName "myconsumergroup" +``` + +Adds a new consumergroup named "myconsumergroup" to the eventhub for telemetry events in the iothub named "myiothub" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubConsumerGroupName +Name of the EventHub ConsumerGroup that you want to add. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Add-AzIotHubKey.md b/azps-10.1.0/Az.IotHub/Add-AzIotHubKey.md new file mode 100644 index 0000000000..9591b49d67 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Add-AzIotHubKey.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/add-aziothubkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubKey.md +--- + +# Add-AzIotHubKey + +## SYNOPSIS +Creates an IotHub Key. + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIotHubKey [-ResourceGroupName] <String> [-Name] <String> [-KeyName] <String> [-PrimaryKey <String>] + [-SecondaryKey <String>] -Rights <PSAccessRights> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIotHubKey [-HubId] <String> [-KeyName] <String> [-PrimaryKey <String>] [-SecondaryKey <String>] + -Rights <PSAccessRights> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a Key for the provided IotHub. +KeyNames are not unique and need to be managed carefully. + +## EXAMPLES + +### Example 1 Add a Key to an IotHub +```powershell +Add-AzIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "newkey" -PrimaryKey "primarykey" -SecondaryKey "secondarykey" -Rights RegistryRead +``` + +Creates a key named "mykey" for the iothub "myiothub" with RegistryRead permissions. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyName +Name of the Key + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IotHub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrimaryKey +The primary key + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Rights +The permissions for this IOTHub + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSAccessRights +Parameter Sets: (All) +Aliases: +Accepted values: RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryKey +The Secondary Key + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSSharedAccessSignatureAuthorizationRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Add-AzIotHubMessageEnrichment.md b/azps-10.1.0/Az.IotHub/Add-AzIotHubMessageEnrichment.md new file mode 100644 index 0000000000..134bf41e6a --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Add-AzIotHubMessageEnrichment.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/add-aziothubmessageenrichment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubMessageEnrichment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubMessageEnrichment.md +--- + +# Add-AzIotHubMessageEnrichment + +## SYNOPSIS +Creates a message enrichment for chosen endpoints in your IoT Hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIotHubMessageEnrichment [-ResourceGroupName] <String> [-Name] <String> [-Key] <String> -Value <String> + -Endpoint <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIotHubMessageEnrichment [-InputObject] <PSIotHub> [-Key] <String> -Value <String> -Endpoint <String[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIotHubMessageEnrichment [-ResourceId] <String> [-Key] <String> -Value <String> -Endpoint <String[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Add up to 10 message enrichments per IoT Hub. These are added as application properties to messages sent to chosen endpoint(s). +To know more, see https://learn.microsoft.com/azure/iot-hub/iot-hub-message-enrichments-overview + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIotHubMessageEnrichment -ResourceGroupName "myresourcegroup" -Name "myiothub" -Key "newKey" -Value "newValue" -Endpoint endpoint1,endpoint2 +``` + +```output +Key : newKey +Value : newValue +Endpoint(s) : { endpoint1, endpoint2 } +``` + +Add a new enrichment with key "newKey" and value "newValue". This new enrichment is applied to "endpoint1" and "endpoint2" endpoints. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +Endpoint(s) to apply enrichments to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Key +The enrichment's key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +The enrichment's value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSEnrichmentMetadata + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Add-AzIotHubModule.md b/azps-10.1.0/Az.IotHub/Add-AzIotHubModule.md new file mode 100644 index 0000000000..2cd21676b4 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Add-AzIotHubModule.md @@ -0,0 +1,262 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/add-aziothubmodule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubModule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubModule.md +--- + +# Add-AzIotHubModule + +## SYNOPSIS +Create a module on a target IoT device in an IoT Hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIotHubModule [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> [-ModuleId] <String> + [-AuthMethod <PSDeviceAuthType>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIotHubModule [-InputObject] <PSIotHub> [-DeviceId] <String> [-ModuleId] <String> + [-AuthMethod <PSDeviceAuthType>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIotHubModule [-ResourceId] <String> [-DeviceId] <String> [-ModuleId] <String> + [-AuthMethod <PSDeviceAuthType>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a module on a target IoT device with different authorization type in an IoT Hub. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIoTHubModule -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" -AuthMethod shared_private_key +``` + +```output +ModuleId : myModule1 +DeviceId : myDevice1 +GenerationId : 637148941292917073 +ETag : "NzIyMDI4MTk3" +LastActivityTime : 1/1/0001 12:00:00 AM +ConnectionState : Disconnected +ConnectionStateUpdatedTime : 1/1/0001 12:00:00 AM +CloudToDeviceMessageCount : 0 +Authentication : Sas +ManagedBy : +``` + +Create a module on a target IoT device with default authorization (shared private key). + +## PARAMETERS + +### -AuthMethod +The authorization type an entity is to be created with. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSDeviceAuthType +Parameter Sets: (All) +Aliases: +Accepted values: shared_private_key, x509_thumbprint, x509_ca + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +Target Module Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryThumbprint +Explicit self-signed certificate thumbprint to use for primary key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryThumbprint +Explicit self-signed certificate thumbprint to use for secondary key. + +```yaml +Type:System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSModule + +## NOTES + +## RELATED LINKS \ No newline at end of file diff --git a/azps-10.1.0/Az.IotHub/Add-AzIotHubRoute.md b/azps-10.1.0/Az.IotHub/Add-AzIotHubRoute.md new file mode 100644 index 0000000000..668699d2ae --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Add-AzIotHubRoute.md @@ -0,0 +1,257 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/add-aziothubroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubRoute.md +--- + +# Add-AzIotHubRoute + +## SYNOPSIS +Create a route in IoT Hub + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIotHubRoute [-ResourceGroupName] <String> [-Name] <String> [-RouteName] <String> + -Source <PSRoutingSource> -EndpointName <String> [-Condition <String>] [-Enabled] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIotHubRoute [-InputObject] <PSIotHub> [-RouteName] <String> -Source <PSRoutingSource> + -EndpointName <String> [-Condition <String>] [-Enabled] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIotHubRoute [-ResourceId] <String> [-RouteName] <String> -Source <PSRoutingSource> -EndpointName <String> + [-Condition <String>] [-Enabled] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a route to send specific data source and condition to a desired endpoint. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -Source DeviceMessages -EndpointName E1 +``` + +```output +RouteName : R1 +DataSource : DeviceMessages +EndpointNames : E1 +Condition : +IsEnabled : False +``` + +Create a new route "R1". + +## PARAMETERS + +### -Condition +Condition that is evaluated to apply the routing rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Enable route + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the routing endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteName +Name of the Route + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Source of the route + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingSource +Parameter Sets: (All) +Aliases: +Accepted values: Invalid, DeviceMessages, TwinChangeEvents, DeviceLifecycleEvents, DeviceJobLifecycleEvents, DigitalTwinChangeEvents + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteMetadata + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Add-AzIotHubRoutingEndpoint.md b/azps-10.1.0/Az.IotHub/Add-AzIotHubRoutingEndpoint.md new file mode 100644 index 0000000000..d19fd632d0 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Add-AzIotHubRoutingEndpoint.md @@ -0,0 +1,313 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/add-aziothubroutingendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubRoutingEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Add-AzIotHubRoutingEndpoint.md +--- + +# Add-AzIotHubRoutingEndpoint + +## SYNOPSIS +Add an endpoint to your IoT Hub + +## SYNTAX + +### ResourceSet (Default) +``` +Add-AzIotHubRoutingEndpoint [-ResourceGroupName] <String> [-Name] <String> [-EndpointName] <String> + -EndpointType <PSEndpointType> -EndpointResourceGroup <String> -EndpointSubscriptionId <String> + -ConnectionString <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Add-AzIotHubRoutingEndpoint [-InputObject] <PSIotHub> [-EndpointName] <String> -EndpointType <PSEndpointType> + -EndpointResourceGroup <String> -EndpointSubscriptionId <String> -ConnectionString <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzIotHubRoutingEndpoint [-ResourceId] <String> [-EndpointName] <String> -EndpointType <PSEndpointType> + -EndpointResourceGroup <String> -EndpointSubscriptionId <String> -ConnectionString <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Add a new endpoint in your IoT Hub. To learn about the endpoints that are supported, see https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-endpoints + +## EXAMPLES + +### Example 1 +```powershell +Add-AzIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointName E2 -EndpointType EventHub -EndpointResourceGroup resourcegroup1 -EndpointSubscriptionId 91d12343-a3de-345d-b2ea-135792468abc -ConnectionString 'Endpoint=sb://myeventhub1.servicebus.windows.net/;SharedAccessKeyName=access1;SharedAccessKey=*****=;EntityPath=event11' +``` + +```output +ResourceGroupName : resourcegroup1 +SubscriptionId : 91d12343-a3de-345d-b2ea-135792468abc +EndpointName : E2 +ConnectionString : Endpoint=sb://myeventhub1.servicebus.windows.net:5671/;SharedAccessKeyName=iothubroutes_myeventhub1;SharedAccessKey=****;EntityPath=event1 +``` + +Add a new endpoint "E2" of type EventHub to an "myiothub" IoT Hub. + +### Example 2 +```powershell +Add-AzIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointName S1 -EndpointType AzureStorageContainer -EndpointResourceGroup resourcegroup1 -EndpointSubscriptionId 91d12343-a3de-345d-b2ea-135792468abc -ConnectionString 'DefaultEndpointsProtocol=https;AccountName=mystorage1;AccountKey=*****;EndpointSuffix=core.windows.net' -ContainerName container -Encoding json +``` + +```output +ResourceGroupName : resourcegroup1 +SubscriptionId : 91d12343-a3de-345d-b2ea-135792468abc +EndpointName : S1 +ContainerName : container +ConnectionString : DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=mystorage1;AccountKey=**** +FileNameFormat : {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm} +BatchFrequencyInSeconds : 300 +MaxChunkSizeInBytes : 314572800 +Encoding : json +``` + +Add a new endpoint "S1" of type AzureStorageContainer to an "myiothub" IoT Hub. + +## PARAMETERS + +### -ConnectionString +Connection string of the Routing Endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the Routing Endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointResourceGroup +Resource group of the Endpoint resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointSubscriptionId +SubscriptionId of the Endpoint resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointType +Type of the Routing Endpoint + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSEndpointType +Parameter Sets: (All) +Aliases: +Accepted values: EventHub, ServiceBusQueue, ServiceBusTopic, AzureStorageContainer + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Name of the storage container + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Encoding +Select the format in which you want to route your data in. You can select JSON or AVRO. The default is set to AVRO. + +```yaml +Type:System.String +Parameter Sets: (All) +Aliases: +Accepted values: JSON, AVRO + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingEventHubEndpoint + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusQueueEndpoint + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusTopicEndpoint + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingStorageContainerEndpoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Az.IotHub.md b/azps-10.1.0/Az.IotHub/Az.IotHub.md new file mode 100644 index 0000000000..2fbbeb2fbc --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Az.IotHub.md @@ -0,0 +1,237 @@ +--- +Module Name: Az.IotHub +Module Guid: 51a3a993-fe39-4f8f-a437-2cb751584af5 +Download Help Link: https://learn.microsoft.com/powershell/module/az.iothub +Help Version: 3.1.2.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Az.IotHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Az.IotHub.md +--- + +# Az.IotHub Module +## Description +Commands for Managing Azure IotHubs + +## Az.IotHub Cmdlets +### [Add-AzIotHubCertificate](Add-AzIotHubCertificate.md) +Create/update an Azure IoT Hub certificate. + +### [Add-AzIotHubConfiguration](Add-AzIotHubConfiguration.md) +Add an IoT automatic device management configuration in a target IoT Hub. + +### [Add-AzIotHubDeployment](Add-AzIotHubDeployment.md) +Add an IoT Edge deployment in a target IoT Hub. + +### [Add-AzIotHubDevice](Add-AzIotHubDevice.md) +Create a device in an IoT Hub. + +### [Add-AzIotHubDeviceChildren](Add-AzIotHubDeviceChildren.md) +Add non-edge devices as a children to the edge device. + +### [Add-AzIotHubEventHubConsumerGroup](Add-AzIotHubEventHubConsumerGroup.md) +Creates an eventhub consumer group. + +### [Add-AzIotHubKey](Add-AzIotHubKey.md) +Creates an IotHub Key. + +### [Add-AzIotHubMessageEnrichment](Add-AzIotHubMessageEnrichment.md) +Creates a message enrichment for chosen endpoints in your IoT Hub. + +### [Add-AzIotHubModule](Add-AzIotHubModule.md) +Create a module on a target IoT device in an IoT Hub. + +### [Add-AzIotHubRoute](Add-AzIotHubRoute.md) +Create a route in IoT Hub + +### [Add-AzIotHubRoutingEndpoint](Add-AzIotHubRoutingEndpoint.md) +Add an endpoint to your IoT Hub + +### [Get-AzIotHub](Get-AzIotHub.md) +Gets information about the IotHubs in a subscription. + +### [Get-AzIotHubCertificate](Get-AzIotHubCertificate.md) +Lists all certificates or a particular certificate contained within an Azure IoT Hub. + +### [Get-AzIotHubCertificateVerificationCode](Get-AzIotHubCertificateVerificationCode.md) +Generates a verification code for an Azure IoT Hub certificate. + +### [Get-AzIotHubConfiguration](Get-AzIotHubConfiguration.md) +Lists all or a particular IoT automatic device management configuration. + +### [Get-AzIotHubConnectionString](Get-AzIotHubConnectionString.md) +Gets the IotHub connectionstrings. + +### [Get-AzIotHubDeployment](Get-AzIotHubDeployment.md) +Lists all or a particular IoT Edge deployment. + +### [Get-AzIotHubDevice](Get-AzIotHubDevice.md) +Lists all devices or a particular device contained within an Azure IoT Hub. + +### [Get-AzIotHubDeviceChildren](Get-AzIotHubDeviceChildren.md) +Print comma-separated list of assigned child devices. + +### [Get-AzIotHubDeviceConnectionString](Get-AzIotHubDeviceConnectionString.md) +Get the connection string of a target IoT device in an Iot Hub. + +### [Get-AzIotHubDeviceParent](Get-AzIotHubDeviceParent.md) +Get the parent device of the specified device. + +### [Get-AzIotHubDeviceTwin](Get-AzIotHubDeviceTwin.md) +Gets a device twin. + +### [Get-AzIotHubDistributedTracing](Get-AzIotHubDistributedTracing.md) +Get the distributed tracing settings for a device. + +### [Get-AzIotHubEventHubConsumerGroup](Get-AzIotHubEventHubConsumerGroup.md) +Gets all the eventhub consumergroups. + +### [Get-AzIotHubJob](Get-AzIotHubJob.md) +Gets the information about an IotHub job. + +### [Get-AzIotHubKey](Get-AzIotHubKey.md) +Gets an IotHub Key. + +### [Get-AzIotHubMessageEnrichment](Get-AzIotHubMessageEnrichment.md) +Lists all message enrichments or a particular message enrichment for your IoT Hub. + +### [Get-AzIotHubModule](Get-AzIotHubModule.md) +Get the details of an IoT device module or list modules located on an IoT device in an IoT Hub. + +### [Get-AzIotHubModuleConnectionString](Get-AzIotHubModuleConnectionString.md) +Get the connection string of a target IoT device module in an Iot Hub. + +### [Get-AzIotHubModuleTwin](Get-AzIotHubModuleTwin.md) +Gets an IoT device module twin. + +### [Get-AzIotHubQuotaMetric](Get-AzIotHubQuotaMetric.md) +Gets the Quota Metrics for an IotHub. + +### [Get-AzIotHubRegistryStatistic](Get-AzIotHubRegistryStatistic.md) +Gets the RegistryStatistics for an IotHub. + +### [Get-AzIotHubRoute](Get-AzIotHubRoute.md) +Get information about the route in IoT Hub + +### [Get-AzIotHubRoutingEndpoint](Get-AzIotHubRoutingEndpoint.md) +Get information on all the endpoints for your IoT Hub + +### [Get-AzIotHubValidSku](Get-AzIotHubValidSku.md) +Gets all valid skus that this IotHub can transition to. + +### [Invoke-AzIotHubConfigurationMetricsQuery](Invoke-AzIotHubConfigurationMetricsQuery.md) +Invoke an IoT device configuration metric query. + +### [Invoke-AzIotHubDeploymentMetricsQuery](Invoke-AzIotHubDeploymentMetricsQuery.md) +Invoke an IoT Edge deployment metric query. + +### [Invoke-AzIotHubDeviceMethod](Invoke-AzIotHubDeviceMethod.md) +Invoke a direct method on a device. + +### [Invoke-AzIotHubManualFailover](Invoke-AzIotHubManualFailover.md) +Invoke failover process for the IoT Hub to the geo-paired disaster recovery region. + +### [Invoke-AzIotHubModuleMethod](Invoke-AzIotHubModuleMethod.md) +Invoke an Edge module method. + +### [Invoke-AzIotHubQuery](Invoke-AzIotHubQuery.md) +Query an IoT Hub using a powerful SQL-like language. + +### [New-AzIotHub](New-AzIotHub.md) +Creates a new IotHub. + +### [New-AzIotHubExportDevice](New-AzIotHubExportDevice.md) +Creates a new export devices job. + +### [New-AzIotHubImportDevice](New-AzIotHubImportDevice.md) +Creates a new import devices job. + +### [New-AzIotHubKey](New-AzIotHubKey.md) +Generate an Azure IoT Hub key. + +### [New-AzIotHubSasToken](New-AzIotHubSasToken.md) +Generate a SAS token for a target IoT Hub, device or module. + +### [Remove-AzIotHub](Remove-AzIotHub.md) +Deletes an IotHub. + +### [Remove-AzIotHubCertificate](Remove-AzIotHubCertificate.md) +Deletes an Azure IoT Hub certificate. + +### [Remove-AzIotHubConfiguration](Remove-AzIotHubConfiguration.md) +Delete an IoT device configuration. + +### [Remove-AzIotHubDeployment](Remove-AzIotHubDeployment.md) +Delete an IoT Edge deployment. + +### [Remove-AzIotHubDevice](Remove-AzIotHubDevice.md) +Delete an IoT Hub device. + +### [Remove-AzIotHubDeviceChildren](Remove-AzIotHubDeviceChildren.md) +Remove non edge devices as children from specified edge device. + +### [Remove-AzIotHubEventHubConsumerGroup](Remove-AzIotHubEventHubConsumerGroup.md) +Deletes an eventhub consumergroup. + +### [Remove-AzIotHubKey](Remove-AzIotHubKey.md) +Removes an IotHub Key. + +### [Remove-AzIotHubMessageEnrichment](Remove-AzIotHubMessageEnrichment.md) +Delete a message enrichment in your IoT hub. + +### [Remove-AzIotHubModule](Remove-AzIotHubModule.md) +Delete module(s) on a target IoT device in an IoT Hub. + +### [Remove-AzIotHubRoute](Remove-AzIotHubRoute.md) +Delete a route in IoT Hub + +### [Remove-AzIotHubRoutingEndpoint](Remove-AzIotHubRoutingEndpoint.md) +Delete an endpoint for your IoT Hub + +### [Send-AzIotHubDevice2CloudMessage](Send-AzIotHubDevice2CloudMessage.md) +Send device-to-cloud message. + +### [Set-AzIotHub](Set-AzIotHub.md) +Updates the properties of an IotHub. + +### [Set-AzIotHubConfiguration](Set-AzIotHubConfiguration.md) +Update the mutable fields of the configuration registration. + +### [Set-AzIotHubDeployment](Set-AzIotHubDeployment.md) +Update the mutable fields of IoT Edge deployment. + +### [Set-AzIotHubDevice](Set-AzIotHubDevice.md) +Update an IoT Hub device. + +### [Set-AzIotHubDeviceParent](Set-AzIotHubDeviceParent.md) +Set the parent device of the specified device. + +### [Set-AzIotHubDistributedTracing](Set-AzIotHubDistributedTracing.md) +Update the distributed tracing options for a device. + +### [Set-AzIotHubEdgeModule](Set-AzIotHubEdgeModule.md) +Set edge modules on a single edge device. + +### [Set-AzIotHubMessageEnrichment](Set-AzIotHubMessageEnrichment.md) +Update a message enrichment in your IoT hub. + +### [Set-AzIotHubModule](Set-AzIotHubModule.md) +Update a module on a target IoT device in an IoT Hub. + +### [Set-AzIotHubRoute](Set-AzIotHubRoute.md) +Update a route in IoT Hub + +### [Set-AzIotHubVerifiedCertificate](Set-AzIotHubVerifiedCertificate.md) +Verifies an Azure IoT Hub certificate. + +### [Test-AzIotHubRoute](Test-AzIotHubRoute.md) +Test routes in IoT Hub + +### [Update-AzIotHub](Update-AzIotHub.md) +Update an Azure IoT Hub. + +### [Update-AzIotHubDeviceTwin](Update-AzIotHubDeviceTwin.md) +Updates tags and desired properties of a device twin. + +### [Update-AzIotHubModuleTwin](Update-AzIotHubModuleTwin.md) +Updates tags and desired properties of an IoT device module twin. + diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHub.md b/azps-10.1.0/Az.IotHub/Get-AzIotHub.md new file mode 100644 index 0000000000..2d79f2ad3e --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHub.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHub.md +--- + +# Get-AzIotHub + +## SYNOPSIS +Gets information about the IotHubs in a subscription. + +## SYNTAX + +### ListIotHubsByResourceGroup (Default) +``` +Get-AzIotHub [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetIotHubByName +``` +Get-AzIotHub [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the IotHubs in a subscription. +You can view all IotHub instances in a subscription, or filter your results by a resource group or a particular IotHub Name. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHub +``` + +Gets all the IotHubs in the subscription. + +### Example 2 +```powershell +Get-AzIotHub -ResourceGroupName "myresourcegroup" +``` + +Gets all the IotHubs in the subscription belonging to the resourcegroup named "myresourcegroup". + +### Example 3 +```powershell +Get-AzIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +Gets information about the IotHub named "myiothub". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IotHub + +```yaml +Type: System.String +Parameter Sets: GetIotHubByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the ResourceGroup + +```yaml +Type: System.String +Parameter Sets: ListIotHubsByResourceGroup +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetIotHubByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubCertificate.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubCertificate.md new file mode 100644 index 0000000000..89f98a9647 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubCertificate.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubCertificate.md +--- + +# Get-AzIotHubCertificate + +## SYNOPSIS +Lists all certificates or a particular certificate contained within an Azure IoT Hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubCertificate [-ResourceGroupName] <String> [-Name] <String> [-CertificateName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubCertificate [-InputObject] <PSIotHub> [-CertificateName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubCertificate [-ResourceId] <String> [-CertificateName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +For a detailed explanation of CA certificates in Azure IoT Hub, see https://learn.microsoft.com/azure/iot-hub/iot-hub-x509ca-overview + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +```output +ResourceGroupName Name CertificateName Status Expiry +----------------- ---- --------------- ------ ------ +myresourcegroup myiothub3 mycert1 Unverified 12/04/2027 13:12 +myresourcegroup myiothub mycert2 Unverified 12/04/2027 13:12 +``` + +List all certificates in MyIotHub + +### Example 2 +```powershell +Get-AzIotHubCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate" +``` + +```output +Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/IotHubs/myiothub/certificates/mycertificate +ResourceGroupName : myresourcegroup +Name : myiothub +CertificateName : mycertificate +Subject : CN=mycertificate +Thumbprint : 38303FC7371EC13DDE3E18D712C8414EE50969C7 +Status : Unverified +Expiry : 1/01/2027 16:01 +Created : 1/01/2017 16:01 +Etag : AAAAAAFpObE= +``` + +Show details about MyCertificate + +## PARAMETERS + +### -CertificateName +Name of the Certificate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubCertificateVerificationCode.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubCertificateVerificationCode.md new file mode 100644 index 0000000000..a048b5f8a3 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubCertificateVerificationCode.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubcertificateverificationcode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubCertificateVerificationCode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubCertificateVerificationCode.md +--- + +# Get-AzIotHubCertificateVerificationCode + +## SYNOPSIS +Generates a verification code for an Azure IoT Hub certificate. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubCertificateVerificationCode [-ResourceGroupName] <String> [-Name] <String> + [-CertificateName] <String> [-Etag] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubCertificateVerificationCode [-InputObject] <PSCertificateDescription> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubCertificateVerificationCode [-ResourceId] <String> [-Etag] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This verification code is used to complete the proof of possession step for a certificate. Use this verification code as the CN of a new certificate signed with the root certificates private key. +For a detailed explanation of CA certificates in Azure IoT Hub, see https://learn.microsoft.com/azure/iot-hub/iot-hub-x509ca-overview + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubCertificateVerificationCode -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate" -Etag "AAAAAAFPazE=" +``` + +```output +Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/IotHubs/myiothub/certificates/mycertificate +ResourceGroupName : myresourcegroup +Name : myiothub +CertificateName : mycertificate +Subject : CN=mycertificate +Thumbprint : 38303FC7371EC13DDE3E18D712C8414EE50969C7 +VerificationCode : 47292AB6260DB02CCD2D07C601B7303DD49858B6 +Status : Unverified +Expiry : 1/01/2027 16:01 +Created : 1/01/2017 16:01 +Etag : AAAAAAFpObE= +``` + +Generates a verification code for MyCertificate + +## PARAMETERS + +### -CertificateName +Name of the Certificate + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Etag of the Certificate + +```yaml +Type: System.String +Parameter Sets: ResourceSet, ResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Certificate Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Certificate Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateWithNonceDescription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubConfiguration.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubConfiguration.md new file mode 100644 index 0000000000..569458f694 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubConfiguration.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubConfiguration.md +--- + +# Get-AzIotHubConfiguration + +## SYNOPSIS +Lists all or a particular IoT automatic device management configuration. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubConfiguration [-ResourceGroupName] <String> [-IotHubName] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubConfiguration [-InputObject] <PSIotHub> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubConfiguration [-ResourceId] <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the details of an IoT automatic device management configuration or list IoT automatic device management configurations in an IoT Hub. +See https://learn.microsoft.com/azure/iot-hub/iot-hub-automatic-device-management for more information. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1" +``` + +Get the details of an IoT automatic device management configuration. + +### Example 2 +```powershell +Get-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" +``` + +List IoT automatic device management configurations in an IoT Hub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Identifier for the configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSConfiguration + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSConfigurations[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubConnectionString.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubConnectionString.md new file mode 100644 index 0000000000..efd0676da4 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubConnectionString.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubconnectionstring +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubConnectionString.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubConnectionString.md +--- + +# Get-AzIotHubConnectionString + +## SYNOPSIS +Gets the IotHub connectionstrings. + +## SYNTAX + +``` +Get-AzIotHubConnectionString [-ResourceGroupName] <String> [-Name] <String> [[-KeyName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the IotHub connectionstrings. +You can either get connectionstrings for all the keys or filter them by a specific key name. + +## EXAMPLES + +### Example 1 Get All IotHub connectionstrings +```powershell +Get-AzIotHubConnectionString -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +Gets the connectionstrings for all keys for the iothub named "myiothub" + +### Example 2 Get the IotHub connectionstrings for a specific key +```powershell +Get-AzIotHubConnectionString -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "mykey" +``` + +Gets the connectionstrings for the key named "mykey" for the iothub named "myiothub" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +Name of the Key + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IotHub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSSharedAccessSignatureAuthorizationRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubDeployment.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubDeployment.md new file mode 100644 index 0000000000..1486a498ed --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubDeployment.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDeployment.md +--- + +# Get-AzIotHubDeployment + +## SYNOPSIS +Lists all or a particular IoT Edge deployment. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubDeployment [-ResourceGroupName] <String> [-IotHubName] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubDeployment [-InputObject] <PSIotHub> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubDeployment [-ResourceId] <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the details of an IoT Edge deployment or List IoT Edge deployments in an IoT Hub. +See https://learn.microsoft.com/azure/iot-edge/module-deployment-monitoring for more information. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubDeployment -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "deploy1" +``` + +Get the details of an IoT Edge deployment. + +### Example 2 +```powershell +Get-AzIotHubDeployment -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" +``` + +List all IoT Edge deployments in an IoT Hub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Identifier for the deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDeployment + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDeployments[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubDevice.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubDevice.md new file mode 100644 index 0000000000..da1029b136 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubDevice.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubdevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDevice.md +--- + +# Get-AzIotHubDevice + +## SYNOPSIS +Lists all devices or a particular device contained within an Azure IoT Hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubDevice [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubDevice [-InputObject] <PSIotHub> [-DeviceId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubDevice [-ResourceId] <String> [-DeviceId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the details of an Iot Hub device or list all devices in an Iot Hub. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubDevice -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" +``` + +```output +Device Id Status Connection State Authentication Edge Enabled Last Activity Time +--------- ------ ---------------- -------------- ------------ ------------------ +device1 Enabled Disconnected CertificateAuthority True 1/1/0001 12:00:00 AM +device2 Disabled Disconnected Sas False 1/1/0001 12:00:00 AM +device3 Enabled Disconnected SelfSigned False 1/1/0001 12:00:00 AM +``` + +Show all devices in an Iot Hub. + +### Example 2 +```powershell +Get-AzIotHubDevice -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" +``` + +```output +DeviceId : myDevice1 +GenerationId : 637148941292917073 +ETag : "NzIyMDI4MTk3" +LastActivityTime : 1/1/0001 12:00:00 AM +ConnectionState : Disconnected +ConnectionStateUpdatedTime : 1/1/0001 12:00:00 AM +Status : Disabled +StatusReason : Reason1 +StatusUpdatedTime : 1/17/2020 10:15:04 PM +CloudToDeviceMessageCount : 0 +Authentication : Sas +EdgeEnabled : False +DeviceScope : +``` + +Get the details of an IoT Hub device. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDevice + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDevices[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubDeviceChildren.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubDeviceChildren.md new file mode 100644 index 0000000000..539b47c23e --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubDeviceChildren.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubdevicechildren +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDeviceChildren.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDeviceChildren.md +--- + +# Get-AzIotHubDeviceChildren + +## SYNOPSIS +Print comma-separated list of assigned child devices. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubDeviceChildren [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubDeviceChildren [-InputObject] <PSIotHub> [-DeviceId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubDeviceChildren [-ResourceId] <String> [-DeviceId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Show all assigned non-edge devices as comma-separated list of all edge devices or specified device. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubDeviceChildren -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" +``` + +```output +DeviceId ChildrenDeviceId +-------- ---------------- +myDevice1 {device1, device2} +``` + +Show all assigned non-edge devices as comma-separated list. + +### Example 2 +```powershell +Get-AzIotHubDeviceChildren -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" +``` + +```output +DeviceId ChildrenDeviceId +-------- ---------------- +myDevice1 {device1, device2} +myDevice2 {device3, device4, device5} +``` + +Show all assigned non-edge devices as comma-separated list of all edge devices. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Id of edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDeviceChildren + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDevicesChildren[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubDeviceConnectionString.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubDeviceConnectionString.md new file mode 100644 index 0000000000..688916fbd2 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubDeviceConnectionString.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubdeviceconnectionstring +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDeviceConnectionString.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDeviceConnectionString.md +--- + +# Get-AzIotHubDeviceConnectionString + +## SYNOPSIS +Get the connection string of a target IoT device in an Iot Hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubDeviceConnectionString [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId <String>] + [-KeyType <PSKeyType>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubDeviceConnectionString [-InputObject] <PSIotHub> [-DeviceId <String>] [-KeyType <PSKeyType>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubDeviceConnectionString [-ResourceId] <String> [-DeviceId <String>] [-KeyType <PSKeyType>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +List connection string of all devices or a target IoT device contained within an Azure IoT Hub. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubDeviceConnectionString -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" +``` + +```output +Device Id Connection String +--------- ----------------- +device1 HostName=myiothub.azure-devices.net;DeviceId=device1;SharedAccessKey=/X4y****** +device2 HostName=myiothub.azure-devices.net;DeviceId=device2;x509=true +``` + +Show all devices connection string in an Iot Hub. + +### Example 2 +```powershell +Get-AzIotHubDeviceConnectionString -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "device1" -KeyType secondary +``` + +```output +Device Id Connection String +--------- ----------------- +device1 HostName=myiothub.azure-devices.net;DeviceId=device1;SharedAccessKey=/X4y****** +``` + +Get the secondary connection string of an IoT device. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyType +Shared access policy key type for auth. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSKeyType +Parameter Sets: (All) +Aliases: +Accepted values: primary, secondary + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDeviceConnectionString + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubDeviceParent.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubDeviceParent.md new file mode 100644 index 0000000000..7feb214edd --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubDeviceParent.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubdeviceparent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDeviceParent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDeviceParent.md +--- + +# Get-AzIotHubDeviceParent + +## SYNOPSIS +Get the parent device of the specified device. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubDeviceParent [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubDeviceParent [-InputObject] <PSIotHub> [-DeviceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubDeviceParent [-ResourceId] <String> [-DeviceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the parent device of the specified non-edge device. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubDeviceParent -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" +``` + +```output +DeviceId : myParentDevice1 +GenerationId : 637148941292917073 +ETag : "NzIyMDI4MTk3" +LastActivityTime : 1/1/0001 12:00:00 AM +ConnectionState : Disconnected +ConnectionStateUpdatedTime : 1/1/0001 12:00:00 AM +Status : Enabled +StatusReason : +StatusUpdatedTime : 1/17/2020 10:15:04 PM +CloudToDeviceMessageCount : 0 +Authentication : Sas +EdgeEnabled : True +DeviceScope : ms-azure-iot-edge://myParentDevice1-637176526047419634 +``` + +Get the parent device of the specified non-edge device. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Id of non-edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDevice + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubDeviceTwin.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubDeviceTwin.md new file mode 100644 index 0000000000..494150b123 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubDeviceTwin.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubdevicetwin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDeviceTwin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDeviceTwin.md +--- + +# Get-AzIotHubDeviceTwin + +## SYNOPSIS +Gets a device twin. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubDeviceTwin [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubDeviceTwin [-InputObject] <PSIotHub> [-DeviceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubDeviceTwin [-ResourceId] <String> [-DeviceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a device twin. See https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubDeviceTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" +``` + +Returns the device twin object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDeviceTwin + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubDistributedTracing.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubDistributedTracing.md new file mode 100644 index 0000000000..e7248eb2af --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubDistributedTracing.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubdistributedtracing +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDistributedTracing.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubDistributedTracing.md +--- + +# Get-AzIotHubDistributedTracing + +## SYNOPSIS +Get the distributed tracing settings for a device. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubDistributedTracing [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubDistributedTracing [-InputObject] <PSIotHub> [-DeviceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubDistributedTracing [-ResourceId] <String> [-DeviceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the distributed tracing settings for a device. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubDistributedTracing -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" +``` + +```output +DeviceId : mydevice1 +Sampling Mode : Enabled +Sampling Rate : 22% +IsSynced : False +``` + +Get the distributed tracing settings for a device. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDeviceTracing + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubEventHubConsumerGroup.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubEventHubConsumerGroup.md new file mode 100644 index 0000000000..ee193ae783 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubEventHubConsumerGroup.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubeventhubconsumergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubEventHubConsumerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubEventHubConsumerGroup.md +--- + +# Get-AzIotHubEventHubConsumerGroup + +## SYNOPSIS +Gets all the eventhub consumergroups. + +## SYNTAX + +``` +Get-AzIotHubEventHubConsumerGroup [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets all the eventhub consumergroups for the different EventHubs used by IotHub. + +## EXAMPLES + +### Example 1 Gets all the eventhub consumergroups for the telemetry eventhub +```powershell +Get-AzIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +Gets all the eventhub consumergroups for the telemetry eventhub for the iothub named myiothub + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IotHub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSEventHubConsumerGroupInfo + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubJob.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubJob.md new file mode 100644 index 0000000000..b6eec202ba --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubJob.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubJob.md +--- + +# Get-AzIotHubJob + +## SYNOPSIS +Gets the information about an IotHub job. + +## SYNTAX + +``` +Get-AzIotHubJob [-ResourceGroupName] <String> [-Name] <String> [[-JobId] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the information about an IotHub Job. +An IotHub Job gets created when an import or export operation is initialized using the New-AzIotHubExportDevices or New-AzIotHubImportDevices commands. +You can either list all the jobs or filter the jobs by the Job Identifier. + +## EXAMPLES + +### Example 1 List all Jobs +```powershell +Get-AzIotHubJob -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +Gets all the jobs for the IotHub named "myiothub" + +### Example 2 Get a specific Job +```powershell +Get-AzIotHubJob -ResourceGroupName "myresourcegroup" -Name "myiothub" -JobId 3630fc31-4caa-43e8-a232-ea0577221cb2 +``` + +Gets information about the job with the identifier "3630fc31-4caa-43e8-a232-ea0577221cb2" for the IotHub named "myiothub" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId +The Job Identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubJobResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubKey.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubKey.md new file mode 100644 index 0000000000..2d9a855a40 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubKey.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubKey.md +--- + +# Get-AzIotHubKey + +## SYNOPSIS +Gets an IotHub Key. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubKey [-ResourceGroupName] <String> [-Name] <String> [[-KeyName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubKey [-HubId] <String> [[-KeyName] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an IotHub Key. +You can either list all Keys or filter the list by a specific Key Name. + +## EXAMPLES + +### Example 1 Get all Keys +```powershell +Get-AzIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +Gets all the Keys for the IotHub named "myiothub" + +### Example 2 Get information for a specific Key +```powershell +Get-AzIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "iothubowner" +``` + +Gets the information for a key named "iothubowner" for the IotHub named "myiothub" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyName +Name of the Key + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT hub. + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSSharedAccessSignatureAuthorizationRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubMessageEnrichment.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubMessageEnrichment.md new file mode 100644 index 0000000000..abd08a6c07 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubMessageEnrichment.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubmessageenrichment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubMessageEnrichment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubMessageEnrichment.md +--- + +# Get-AzIotHubMessageEnrichment + +## SYNOPSIS +Lists all message enrichments or a particular message enrichment for your IoT Hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubMessageEnrichment [-ResourceGroupName] <String> [-Name] <String> [-Key <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubMessageEnrichment [-InputObject] <PSIotHub> [-Key <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubMessageEnrichment [-ResourceId] <String> [-Key <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +For a detailed explanation of message enrichments in Azure IoT Hub, see https://learn.microsoft.com/azure/iot-hub/iot-hub-message-enrichments-overview + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubMessageEnrichment -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +```output +Key Value Endpoint(s) +--- ----- ----------- +key1 value1 {endpoint1, endpoint2} +key2 value2 {endpoint3, endpoint4} +``` + +List all message enrichments in MyIotHub + +### Example 2 +```powershell +Get-AzIotHubMessageEnrichment -ResourceGroupName "myresourcegroup" -Name "myiothub" -Key "newKey" +``` + +```output +Key : key1 +Value : value1 +Endpoint(s) : {endpoint1, endpoint2} +``` + +Show details about "newKey" message enrichment. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Key +The enrichment's key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSEnrichmentMetadata + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSEnrichmentProperties[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubModule.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubModule.md new file mode 100644 index 0000000000..316c569945 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubModule.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubmodule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubModule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubModule.md +--- + +# Get-AzIotHubModule + +## SYNOPSIS +Get the details of an IoT device module or list modules located on an IoT device in an IoT Hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubModule [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-ModuleId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubModule [-InputObject] <PSIotHub> [-DeviceId] <String> [-ModuleId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubModule [-ResourceId] <String> [-DeviceId] <String> [-ModuleId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the details of an IoT device module or list modules located on an IoT device in an IoT Hub. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubModule -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" +``` + +```output +ModuleId : myModule1 +DeviceId : myDevice1 +GenerationId : 637148941292917073 +ETag : "NzIyMDI4MTk3" +LastActivityTime : 1/1/0001 12:00:00 AM +ConnectionState : Disconnected +ConnectionStateUpdatedTime : 1/1/0001 12:00:00 AM +CloudToDeviceMessageCount : 0 +Authentication : Sas +ManagedBy : +``` + +Get the details of an IoT device module in an IoT Hub. + +### Example 2 +```powershell +Get-AzIotHubModule -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" +``` + +```output +Module Id Device Id Connection State Authentication Last Activity Time +--------- --------- ---------------- -------------- ------------------ +module1 myDevice1 Disconnected Sas 1/1/0001 12:00:00 AM +module2 myDevice1 Disconnected Sas 1/1/0001 12:00:00 AM +``` + +Show all modules located on an IoT device in an IoT Hub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +Target Module Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSModule + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSModules[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubModuleConnectionString.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubModuleConnectionString.md new file mode 100644 index 0000000000..bffb6629c1 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubModuleConnectionString.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubmoduleconnectionstring +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubModuleConnectionString.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubModuleConnectionString.md +--- + +# Get-AzIotHubModuleConnectionString + +## SYNOPSIS +Get the connection string of a target IoT device module in an Iot Hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubModuleConnectionString [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-ModuleId <String>] [-KeyType <PSKeyType>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubModuleConnectionString [-InputObject] <PSIotHub> [-DeviceId] <String> [-ModuleId <String>] + [-KeyType <PSKeyType>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubModuleConnectionString [-ResourceId] <String> [-DeviceId] <String> [-ModuleId <String>] + [-KeyType <PSKeyType>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +List connection string of all modules or a specified module of a target IoT device contained within an Azure IoT Hub. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubModuleConnectionString -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Deviceid "myDevice1" +``` + +```output +Module Id Connection String +--------- ----------------- +module1 HostName=myiothub.azure-devices.net;DeviceId=myDevice1;ModuleId=module1;SharedAccessKey=/X4yj****** +module2 HostName=myiothub.azure-devices.net;DeviceId=myDevice1;ModuleId=module2;x509=true +``` + +Show all modules connection string of a target IoT device in an Iot Hub. + +### Example 2 +```powershell +Get-AzIotHubModuleConnectionString -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "module1" -KeyType secondary +``` + +```output +Module Id Connection String +--------- ----------------- +module1 HostName=myiothub.azure-devices.net;DeviceId=myDevice1;ModuleId=module1;SharedAccessKey=/X4yj****** +``` + +Get the secondary module connection string of a target IoT device in an Iot Hub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyType +Shared access policy key type for auth. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSKeyType +Parameter Sets: (All) +Aliases: +Accepted values: primary, secondary + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +Target Module Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSModuleConnectionString + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubModuleTwin.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubModuleTwin.md new file mode 100644 index 0000000000..3891b109cc --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubModuleTwin.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubmoduletwin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubModuleTwin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubModuleTwin.md +--- + +# Get-AzIotHubModuleTwin + +## SYNOPSIS +Gets an IoT device module twin. + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubModuleTwin [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + -ModuleId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubModuleTwin [-InputObject] <PSIotHub> [-DeviceId] <String> -ModuleId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubModuleTwin [-ResourceId] <String> [-DeviceId] <String> -ModuleId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets an IoT device module twin. See https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-module-twins for more information. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubModuleTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" +``` + +Returns the device module twin object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +Target Module Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSModuleTwin + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubQuotaMetric.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubQuotaMetric.md new file mode 100644 index 0000000000..a78c7d1332 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubQuotaMetric.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubquotametric +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubQuotaMetric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubQuotaMetric.md +--- + +# Get-AzIotHubQuotaMetric + +## SYNOPSIS +Gets the Quota Metrics for an IotHub. + +## SYNTAX + +``` +Get-AzIotHubQuotaMetric [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the Quota Metrics for an IotHub. + +## EXAMPLES + +### Example 1 Get the Quota Metrics +```powershell +Get-AzIotHubQuotaMetric -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +Gets the Quota Metric information for the IotHub named "myiothub" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubQuotaMetric + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubRegistryStatistic.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubRegistryStatistic.md new file mode 100644 index 0000000000..f41a247a43 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubRegistryStatistic.md @@ -0,0 +1,95 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubregistrystatistic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubRegistryStatistic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubRegistryStatistic.md +--- + +# Get-AzIotHubRegistryStatistic + +## SYNOPSIS +Gets the RegistryStatistics for an IotHub. + +## SYNTAX + +``` +Get-AzIotHubRegistryStatistic [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the RegistryStatistics for an IotHub. +This provides information about the number of total, enabled and disabled devices in an IotHub. + +## EXAMPLES + +### Example 1 Get the RegistryStatistics +```powershell +Get-AzIotHubRegistryStatistic -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +Gets the RegistryStatistics for the IotHub named "myiothub" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubRegistryStatistics + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubRoute.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubRoute.md new file mode 100644 index 0000000000..0941048cac --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubRoute.md @@ -0,0 +1,178 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubRoute.md +--- + +# Get-AzIotHubRoute + +## SYNOPSIS +Get information about the route in IoT Hub + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubRoute [-ResourceGroupName] <String> [-Name] <String> [-RouteName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubRoute [-InputObject] <PSIotHub> [-RouteName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubRoute [-ResourceId] <String> [-RouteName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get information on the route.You can get all routes from an IoT Hub, get routes to a type of endpoint or get routes to a specific endpoint. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +```output +RouteName DataSource EndpointNames IsEnabled +--------- ---------- ------------- --------- +R1 DeviceMessages events False +R2 TwinChangeEvents E1 True +``` + +Get all route from "myiothub" IoT Hub. + +### Example 2 +```powershell +Get-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 +``` + +```output +RouteName : R1 +DataSource : DeviceMessages +EndpointNames : events +Condition : true +IsEnabled : False +``` + +Get route information from "myiothub" IoT Hub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteName +Name of the Route + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteMetadata + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteProperties[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubRoutingEndpoint.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubRoutingEndpoint.md new file mode 100644 index 0000000000..27ef608186 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubRoutingEndpoint.md @@ -0,0 +1,236 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubroutingendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubRoutingEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubRoutingEndpoint.md +--- + +# Get-AzIotHubRoutingEndpoint + +## SYNOPSIS +Get information on all the endpoints for your IoT Hub + +## SYNTAX + +### ResourceSet (Default) +``` +Get-AzIotHubRoutingEndpoint [-ResourceGroupName] <String> [-Name] <String> [-EndpointType <PSEndpointType>] + [-EndpointName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectSet +``` +Get-AzIotHubRoutingEndpoint [-InputObject] <PSIotHub> [-EndpointType <PSEndpointType>] [-EndpointName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzIotHubRoutingEndpoint [-ResourceId] <String> [-EndpointType <PSEndpointType>] [-EndpointName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get information on the endpoint. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +```output +Name EndpointType AzureResource +---- ------------ ------------- +E1 EventHub resourcegroup1/event1 +E2 EventHub resourcegroup1/event2 +S1 AzureStorageContainer mystorage1/container +``` + +Get all the endpoints from "myiothub" IoT Hub. + +### Example 2 +```powershell +Get-AzIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointType EventHub +``` + +```output +ResourceGroupName SubscriptionId EndpointName +----------------- -------------- ------------ +resourcegroup1 91d12343-a3de-345d-b2ea-135792468abc E1 +resourcegroup1 91d12343-a3de-345d-b2ea-135792468abc E2 +``` + +Get all the endpoints of type EventHub from "myiothub" IoT Hub. + +### Example 3 +```powershell +Get-AzIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointType EventHub +``` + +```output +ResourceGroupName : resourcegroup1 +SubscriptionId : 91d12343-a3de-345d-b2ea-135792468abc +EndpointName : E1 +ConnectionString : Endpoint=sb://myeventhub1.servicebus.windows.net:5671/;SharedAccessKeyName=iothubroutes_myeventhub1;SharedAccessKey=****;EntityPath=event1 +``` + +Get all the endpoints of type EventHub from "myiothub" IoT Hub. + +### Example 4 +```powershell +Get-AzIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointName E1 +``` + +```output +ResourceGroupName : resourcegroup1 +SubscriptionId : 91d12343-a3de-345d-b2ea-135792468abc +EndpointName : E1 +ConnectionString : Endpoint=sb://myeventhub1.servicebus.windows.net:5671/;SharedAccessKeyName=iothubroutes_myeventhub1;SharedAccessKey=****;EntityPath=event1 +``` + +Get an endpoint information from "myiothub" IoT Hub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the Routing Endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointType +Type of the Routing Endpoint + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSEndpointType +Parameter Sets: (All) +Aliases: +Accepted values: EventHub, ServiceBusQueue, ServiceBusTopic, AzureStorageContainer + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingEventHubEndpoint + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingEventHubProperties, Microsoft.Azure.PowerShell.Cmdlets.IotHub, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusQueueEndpoint + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusQueueEndpointProperties[] + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusTopicEndpoint + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusTopicEndpointProperties[] + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingStorageContainerEndpoint + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingStorageContainerProperties[] + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingCustomEndpoint[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Get-AzIotHubValidSku.md b/azps-10.1.0/Az.IotHub/Get-AzIotHubValidSku.md new file mode 100644 index 0000000000..2e840084e3 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Get-AzIotHubValidSku.md @@ -0,0 +1,96 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/get-aziothubvalidsku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubValidSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Get-AzIotHubValidSku.md +--- + +# Get-AzIotHubValidSku + +## SYNOPSIS +Gets all valid skus that this IotHub can transition to. + +## SYNTAX + +``` +Get-AzIotHubValidSku [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets all the valid skus that this IotHub can transition to. +An IotHub cannot transition between free and the paid skus and vice versa. +You will have to delete and recreate the iothub if you want to achieve this. + +## EXAMPLES + +### Example 1 Get the valid skus +```powershell +Get-AzIotHubValidSku -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +Gets a list of all skus for the IotHub named "myiothub" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IoT hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubSkuDescription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Invoke-AzIotHubConfigurationMetricsQuery.md b/azps-10.1.0/Az.IotHub/Invoke-AzIotHubConfigurationMetricsQuery.md new file mode 100644 index 0000000000..adca81e20f --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Invoke-AzIotHubConfigurationMetricsQuery.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/invoke-aziothubconfigurationmetricsquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Invoke-AzIotHubConfigurationMetricsQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Invoke-AzIotHubConfigurationMetricsQuery.md +--- + +# Invoke-AzIotHubConfigurationMetricsQuery + +## SYNOPSIS +Invoke an IoT device configuration metric query. + +## SYNTAX + +### ResourceSet (Default) +``` +Invoke-AzIotHubConfigurationMetricsQuery [-ResourceGroupName] <String> [-IotHubName] <String> -Name <String> + -MetricName <String> [-MetricType <PSConfigurationMetricType>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Invoke-AzIotHubConfigurationMetricsQuery [-InputObject] <PSIotHub> -Name <String> -MetricName <String> + [-MetricType <PSConfigurationMetricType>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Invoke-AzIotHubConfigurationMetricsQuery [-ResourceId] <String> -Name <String> -MetricName <String> + [-MetricType <PSConfigurationMetricType>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Evaluate a target custom or system metric defined in an IoT device configuration. +There are pre-defined system metrics which are calculated by Iot Hub and cannot be customized. +- "Targeted" specifies the number of device twins that match the target condition. +- "Applied" specified the number of device twins that have been modified by the configuration. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzIotHubConfigurationMetricsQuery -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "myConfig1" -MetricName "warningLimit" +``` + +Evaluate the custom defined 'warningLimit' metric. + +### Example 2 +```powershell +Invoke-AzIotHubConfigurationMetricsQuery -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "myConfig1" -MetricName "applied" -MetricType "system" +``` + +Evaluate the system 'applied' metric. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricName +Target metric for evaluation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricType +Indicates which metric collection should be used to lookup a metric. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSConfigurationMetricType +Parameter Sets: (All) +Aliases: +Accepted values: Custom, System + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Identifier for the configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSConfigurationMetricsResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Invoke-AzIotHubDeploymentMetricsQuery.md b/azps-10.1.0/Az.IotHub/Invoke-AzIotHubDeploymentMetricsQuery.md new file mode 100644 index 0000000000..454cf3a726 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Invoke-AzIotHubDeploymentMetricsQuery.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/invoke-aziothubdeploymentmetricsquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Invoke-AzIotHubDeploymentMetricsQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Invoke-AzIotHubDeploymentMetricsQuery.md +--- + +# Invoke-AzIotHubDeploymentMetricsQuery + +## SYNOPSIS +Invoke an IoT Edge deployment metric query. + +## SYNTAX + +### ResourceSet (Default) +``` +Invoke-AzIotHubDeploymentMetricsQuery [-ResourceGroupName] <String> [-IotHubName] <String> -Name <String> + -MetricName <String> [-MetricType <PSConfigurationMetricType>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Invoke-AzIotHubDeploymentMetricsQuery [-InputObject] <PSIotHub> -Name <String> -MetricName <String> + [-MetricType <PSConfigurationMetricType>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Invoke-AzIotHubDeploymentMetricsQuery [-ResourceId] <String> -Name <String> -MetricName <String> + [-MetricType <PSConfigurationMetricType>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Evaluate a target custom or system metric defined in an IoT Edge deployment. +There are pre-defined system metrics which are calculated by Iot Hub and cannot be customized. +- "Targeted" shows the IoT Edge devices that match the deployment targeting condition. +- "Applied" shows the targeted IoT Edge devices that are not targeted by another deployment of higher priority. +- "Reporting Success" shows the IoT Edge devices that have reported that the modules have been deployed successfully. +- "Reporting Failure" shows the IoT Edge devices that have reported that one or more modules haven't been deployed successfully. + To further investigate the error, connect remotely to those devices and view the log files. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzIotHubDeploymentMetricsQuery -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "myDeploy1" -MetricName "warningLimit" +``` + +Evaluate the custom defined 'warningLimit' metric. + +### Example 2 +```powershell +Invoke-AzIotHubDeploymentMetricsQuery -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "myDeploy1" -MetricName "Reporting Success" -MetricType "system" +``` + +Evaluate the system 'Reporting Success' metric. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricName +Target metric for evaluation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricType +Indicates which metric collection should be used to lookup a metric. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSConfigurationMetricType +Parameter Sets: (All) +Aliases: +Accepted values: Custom, System + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Identifier for the deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSConfigurationMetricsResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Invoke-AzIotHubDeviceMethod.md b/azps-10.1.0/Az.IotHub/Invoke-AzIotHubDeviceMethod.md new file mode 100644 index 0000000000..4632108267 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Invoke-AzIotHubDeviceMethod.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/invoke-aziothubdevicemethod +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Invoke-AzIotHubDeviceMethod.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Invoke-AzIotHubDeviceMethod.md +--- + +# Invoke-AzIotHubDeviceMethod + +## SYNOPSIS +Invoke a direct method on a device. + +## SYNTAX + +### ResourceSet (Default) +``` +Invoke-AzIotHubDeviceMethod [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + -Name <String> [-Payload <String>] [-ResponseTimeOut <Int32>] [-ConnectionTimeOut <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Invoke-AzIotHubDeviceMethod [-InputObject] <PSIotHub> [-DeviceId] <String> -Name <String> [-Payload <String>] + [-ResponseTimeOut <Int32>] [-ConnectionTimeOut <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Invoke-AzIotHubDeviceMethod [-ResourceId] <String> [-DeviceId] <String> -Name <String> [-Payload <String>] + [-ResponseTimeOut <Int32>] [-ConnectionTimeOut <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Invoke a direct method on a device. See https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzIotHubDeviceMethod -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Name "methodName" -ResponseTimeOut 20 -ConnectionTimeOut 15 +``` + +Invoke a device method. + +## PARAMETERS + +### -ConnectionTimeOut +Number of seconds to wait until a connection is successfully made. +Default is 10. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the method to invoke on this device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Payload +The payload for the method to invoke on this device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResponseTimeOut +Number of seconds to wait until a result is received from the direct method. +Default is 10. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSCloudToDeviceMethodResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Invoke-AzIotHubManualFailover.md b/azps-10.1.0/Az.IotHub/Invoke-AzIotHubManualFailover.md new file mode 100644 index 0000000000..14022a23b9 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Invoke-AzIotHubManualFailover.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/invoke-aziothubmanualfailover +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Invoke-AzIotHubManualFailover.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Invoke-AzIotHubManualFailover.md +--- + +# Invoke-AzIotHubManualFailover + +## SYNOPSIS +Invoke failover process for the IoT Hub to the geo-paired disaster recovery region. + +## SYNTAX + +### ResourceSet (Default) +``` +Invoke-AzIotHubManualFailover [-ResourceGroupName] <String> [-Name] <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Invoke-AzIotHubManualFailover [-InputObject] <PSIotHub> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Invoke-AzIotHubManualFailover [-ResourceId] <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +It will trigger the failover your IoT hub to the secondary location. This action will cause down time and telemetry loss to your solution. +This is a long running operation and could take several minutes to finish. Please exercise with caution when using it. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzIotHubManualFailover -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +Initiating failover process of "myiothub" IoT Hub. + +### Example 2 +```powershell +Invoke-AzIotHubManualFailover -ResourceGroupName "myresourcegroup" -Name "myiothub" -AsJob +``` + +Initiating failover process of "myiothub" IoT Hub in the background. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Iot Hub Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Allows to return the boolean object. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Iot Hub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Invoke-AzIotHubModuleMethod.md b/azps-10.1.0/Az.IotHub/Invoke-AzIotHubModuleMethod.md new file mode 100644 index 0000000000..b903f0614e --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Invoke-AzIotHubModuleMethod.md @@ -0,0 +1,266 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/invoke-aziothubmodulemethod +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Invoke-AzIotHubModuleMethod.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Invoke-AzIotHubModuleMethod.md +--- + +# Invoke-AzIotHubModuleMethod + +## SYNOPSIS +Invoke an Edge module method. + +## SYNTAX + +### ResourceSet (Default) +``` +Invoke-AzIotHubModuleMethod [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-ModuleId] <String> -Name <String> [-Payload <String>] [-ResponseTimeOut <Int32>] + [-ConnectionTimeOut <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Invoke-AzIotHubModuleMethod [-InputObject] <PSIotHub> [-DeviceId] <String> [-ModuleId] <String> -Name <String> + [-Payload <String>] [-ResponseTimeOut <Int32>] [-ConnectionTimeOut <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Invoke-AzIotHubModuleMethod [-ResourceId] <String> [-DeviceId] <String> [-ModuleId] <String> -Name <String> + [-Payload <String>] [-ResponseTimeOut <Int32>] [-ConnectionTimeOut <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Invoke an Edge module method. See https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzIotHubModuleMethod -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" -Name "methodName" -Payload "method-input" -ResponseTimeOut 20 -ConnectionTimeOut 15 +``` + +Invoke an Edge module method. + +## PARAMETERS + +### -ConnectionTimeOut +Number of seconds to wait until a connection is successfully made. +Default is 10. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +Target device's module id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the method to invoke on this device module. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Payload +The payload for the method to invoke on this device module. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResponseTimeOut +Number of seconds to wait until a result is received from the direct method. +Default is 10. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSCloudToDeviceMethodResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Invoke-AzIotHubQuery.md b/azps-10.1.0/Az.IotHub/Invoke-AzIotHubQuery.md new file mode 100644 index 0000000000..4cdca1b7ec --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Invoke-AzIotHubQuery.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/invoke-aziothubquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Invoke-AzIotHubQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Invoke-AzIotHubQuery.md +--- + +# Invoke-AzIotHubQuery + +## SYNOPSIS +Query an IoT Hub using a powerful SQL-like language. + +## SYNTAX + +### ResourceSet (Default) +``` +Invoke-AzIotHubQuery [-ResourceGroupName] <String> [-IotHubName] <String> [-Query] <String> [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Invoke-AzIotHubQuery [-InputObject] <PSIotHub> [-Query] <String> [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Invoke-AzIotHubQuery [-ResourceId] <String> [-Query] <String> [-Top <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Query an IoT Hub using a powerful SQL-like language to retrieve information regarding device and module twins, jobs and message routing. +See https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzIotHubQuery -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Query "select * from devices" +``` + +Query all device twin data in an Azure IoT Hub. + +### Example 2 +```powershell +Invoke-AzIotHubQuery -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Query "select * from devices.modules where devices.deviceId = 'myDevice1'" -Top 2 +``` + +Query top 2 module twin data on a target device. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +User query to be executed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +Maximum number of elements to return. +By default query has no cap. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/New-AzIotHub.md b/azps-10.1.0/Az.IotHub/New-AzIotHub.md new file mode 100644 index 0000000000..a006e5198d --- /dev/null +++ b/azps-10.1.0/Az.IotHub/New-AzIotHub.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/new-aziothub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/New-AzIotHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/New-AzIotHub.md +--- + +# New-AzIotHub + +## SYNOPSIS +Creates a new IotHub. + +## SYNTAX + +``` +New-AzIotHub -ResourceGroupName <String> -Name <String> -SkuName <PSIotHubSku> -Units <Int64> + -Location <String> [-Properties <PSIotHubInputProperties>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new IotHub. +You can create the IotHub with either the default properties or specify the input properties. + +## EXAMPLES + +### Example 1 Create a new IotHub with default properties +```powershell +$tags = @{} +$tags.Add('key1','value1') +New-AzIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" -SkuName "S1" -Units 1 -Location "northeurope" -Tag $tags +``` + +Creates a new IotHub named "myiothub" of the sku "S1", capacity 1 and location "northeurope" included with Tags. + +### Example 2 Create a new IotHub with the MaxDeliveryCount of the CloudToDevice Queue set to 20 +```powershell +New-AzIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" -SkuName "S1" -Units 1 -Location "northeurope" -Properties $properties +``` + +Creates a new IotHub named "myiothub" of the sku "S1", capacity 1 and location "northeurope" with advanced input properties represented by $properties. +$psCloudToDeviceProperties = New-Object Microsoft.Azure.Commands.Management.IotHub.Models.PSCloudToDeviceProperties -Property @{MaxDeliveryCount=20} $properties = New-Object Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubInputProperties -Property @{CloudToDevice=$psCloudToDeviceProperties} New-AzIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" -SkuName "S1" -Units 1 -Location "northeurope" -Properties $properties + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location where the IoT hub needs to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IotHub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Properties +Properties of the IoT hub. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubInputProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuName +Name of the sku + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubSku +Parameter Sets: (All) +Aliases: +Accepted values: F1, S1, S2, S3, B1, B2, B3 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +IoT hub instance tags. Property bag in key-value pairs in the form of a hash table. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Units +Number of units + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/New-AzIotHubExportDevice.md b/azps-10.1.0/Az.IotHub/New-AzIotHubExportDevice.md new file mode 100644 index 0000000000..0da8fc952e --- /dev/null +++ b/azps-10.1.0/Az.IotHub/New-AzIotHubExportDevice.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/new-aziothubexportdevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/New-AzIotHubExportDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/New-AzIotHubExportDevice.md +--- + +# New-AzIotHubExportDevice + +## SYNOPSIS +Creates a new export devices job. + +## SYNTAX + +``` +New-AzIotHubExportDevice [-ResourceGroupName] <String> [-Name] <String> [-ExportBlobContainerUri] <String> + [-ExcludeKeys] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new export devices job for the IotHub. +This will export all the devices to the specified container. +Refer to the following article on how to generate the SAS URI. +https://learn.microsoft.com/azure/iot-hub/iot-hub-bulk-identity-mgmt#get-the-container-sas-uri . + +## EXAMPLES + +### Example 1 Issue an export device request. +```powershell +New-AzIotHubExportDevice -ResourceGroupName "myresourcegroup" -Name "myiothub" -ExportBlobContainerUri "https://mystorageaccount.blob.core.windows.net/mystoragecontainer?sv=2015-04-05&ss=bfqt&sr=c&srt=sco&sp=rwdl&se=2016-10-27T04:01:48Z&st=2016-10-26T20:01:48Z&spr=https&sig=QqpIhHsIMF8hNuFO%3D" -ExcludeKeys +``` + +Creates a new export device request for the IotHub "myiothub" excluding the keys. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeKeys +Allows to export devices without keys. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportBlobContainerUri +The Uri to export the blob to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IotHub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubJobResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/New-AzIotHubImportDevice.md b/azps-10.1.0/Az.IotHub/New-AzIotHubImportDevice.md new file mode 100644 index 0000000000..34abab3b78 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/New-AzIotHubImportDevice.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/new-aziothubimportdevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/New-AzIotHubImportDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/New-AzIotHubImportDevice.md +--- + +# New-AzIotHubImportDevice + +## SYNOPSIS +Creates a new import devices job. + +## SYNTAX + +``` +New-AzIotHubImportDevice [-ResourceGroupName] <String> [-Name] <String> [-InputBlobContainerUri] <String> + [-OutputBlobContainerUri] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new import devices job for the IotHub. +This will import all the devices to the IotHub from the specified container. +Refer to the following article on how to generate the SAS URI. +https://learn.microsoft.com/azure/iot-hub/iot-hub-bulk-identity-mgmt#get-the-container-sas-uri . + +## EXAMPLES + +### Example 1 +```powershell +New-AzIotHubImportDevice -ResourceGroupName "myresourcegroup" -Name "myiothub" -InputBlobContainerUri "https://mystorageaccount.blob.core.windows.net/mystoragecontainer?sv=2015-04-05&ss=bfqt&sr=c&srt=sco&sp=rwdl&se=2016-10-27T04:01:48Z&st=2016-10-26T20:01:48Z&spr=https&sig=QqpIhHsIMF8hNuFO%3D" -OutputBlobContainerUri "https://mystorageaccount.blob.core.windows.net/?sv=2015-04-05&ss=bfqt&sr=c&srt=sco&sp=rwdl&se=2016-10-27T04:01:48Z&st=2016-10-26T20:01:48Z&spr=https&sig=QqpIhHsIMF8hNuFO%3D" +``` + +Creates a new import device request for the IotHub "myiothub". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputBlobContainerUri +Input Blob Container Uri for FileUpload + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IotHub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OutputBlobContainerUri +The Uri to write the output to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubJobResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/New-AzIotHubKey.md b/azps-10.1.0/Az.IotHub/New-AzIotHubKey.md new file mode 100644 index 0000000000..298a96eb28 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/New-AzIotHubKey.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/new-aziothubkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/New-AzIotHubKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/New-AzIotHubKey.md +--- + +# New-AzIotHubKey + +## SYNOPSIS +Generate an Azure IoT Hub key. + +## SYNTAX + +### ResourceSet (Default) +``` +New-AzIotHubKey [-ResourceGroupName] <String> [-Name] <String> [-KeyName] <String> [-RenewKey] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +New-AzIotHubKey [-HubId] <String> [-KeyName] <String> [-RenewKey] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Generate an Azure IoT Hub key. + +## EXAMPLES + +### Example 1 Regenerate primary key +```powershell +New-AzIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "testKey" -RenewKey "primary" +``` + +```output +KeyName PrimaryKey SecondaryKey Rights +------- ---------- ------------ ------ +test SXSdm31aT+i3939xSnA191f8g3uRhIUCTsO26b9s/nE= 6JqGKGUTL0mhQwvcOeIRT7OnT6noK/tie6jBY77sJTE= ServiceConnect +``` + +Regenerated primary key for the authorization policy "testKey" of an azure iot hub. + +### Example 2 Swapping keys +```powershell +New-AzIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "testKey" -RenewKey "swap" +``` + +```output +KeyName PrimaryKey SecondaryKey Rights +------- ---------- ------------ ------ +test 6JqGKGUTL0mhQwvcOeIRT7OnT6noK/tie6jBY77sJTE= SXSdm31aT+i3939xSnA191f8g3uRhIUCTsO26b9s/nE= ServiceConnect +``` + +Swapping keys for the authorization policy "testKey" of an azure iot hub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyName +Name of the Key + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the IotHub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RenewKey +Regenerate Key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSSharedAccessSignatureAuthorizationRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/New-AzIotHubSasToken.md b/azps-10.1.0/Az.IotHub/New-AzIotHubSasToken.md new file mode 100644 index 0000000000..04f48b60d9 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/New-AzIotHubSasToken.md @@ -0,0 +1,272 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/new-aziothubsastoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/New-AzIotHubSasToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/New-AzIotHubSasToken.md +--- + +# New-AzIotHubSasToken + +## SYNOPSIS +Generate a SAS token for a target IoT Hub, device or module. + +## SYNTAX + +### ResourceSet (Default) +``` +New-AzIotHubSasToken [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId <String>] + [-ModuleId <String>] [-KeyName <String>] [-KeyType <PSKeyType>] [-Duration <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +New-AzIotHubSasToken [-InputObject] <PSIotHub> [-DeviceId <String>] [-ModuleId <String>] [-KeyName <String>] + [-KeyType <PSKeyType>] [-Duration <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +New-AzIotHubSasToken [-ResourceId] <String> [-DeviceId <String>] [-ModuleId <String>] [-KeyName <String>] + [-KeyType <PSKeyType>] [-Duration <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +For device SAS tokens, the policy parameter is used to access the the device registry only. Therefore the policy should have read access to the registry. +For IoT Hub tokens the policy is part of the SAS. + +## EXAMPLES + +### Example 1 +```powershell +New-AzIotHubSasToken -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" +``` + +Generate an IoT Hub SAS token using the iothubowner policy and primary key. + +### Example 2 +```powershell +New-AzIotHubSasToken -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -KeyName "registryRead" -KeyType "secondary" +``` + +Generate an IoT Hub SAS token using the registryRead policy and secondary key. + +### Example 3 +```powershell +New-AzIotHubSasToken -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" +``` + +Generate a device SAS token using the iothubowner policy to access the {iothub_name} device registry. + +### Example 4 +```powershell +New-AzIotHubSasToken -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" +``` + +Generate a module SAS token using the iothubowner policy to access the {iothub_name} device registry. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Duration +Future expiry (in seconds) of the token to be generated. +Default is 3600. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +Access key name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyType +Access key type. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSKeyType +Parameter Sets: (All) +Aliases: +Accepted values: primary, secondary + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +Target Module Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Remove-AzIotHub.md b/azps-10.1.0/Az.IotHub/Remove-AzIotHub.md new file mode 100644 index 0000000000..4d24c84573 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Remove-AzIotHub.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/remove-aziothub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHub.md +--- + +# Remove-AzIotHub + +## SYNOPSIS +Deletes an IotHub. + +## SYNTAX + +``` +Remove-AzIotHub [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an IotHub. + +## EXAMPLES + +### Example 1 Remove an IotHub +```powershell +Remove-AzIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +Removes an IotHub named "myiothub" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IotHub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Remove-AzIotHubCertificate.md b/azps-10.1.0/Az.IotHub/Remove-AzIotHubCertificate.md new file mode 100644 index 0000000000..534abd4b7c --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Remove-AzIotHubCertificate.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/remove-aziothubcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubCertificate.md +--- + +# Remove-AzIotHubCertificate + +## SYNOPSIS +Deletes an Azure IoT Hub certificate. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIotHubCertificate [-ResourceGroupName] <String> [-Name] <String> [-CertificateName] <String> + [-Etag] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIotHubCertificate [-InputObject] <PSCertificateDescription> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIotHubCertificate [-ResourceId] <String> [-Etag] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +For a detailed explanation of CA certificates in Azure IoT Hub, see https://learn.microsoft.com/azure/iot-hub/iot-hub-x509ca-overview + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIotHubCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate" -Etag "AAAAAAFPazE=" +``` + +Deletes MyCertificate + +## PARAMETERS + +### -CertificateName +Name of the Certificate + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Etag of the Certificate + +```yaml +Type: System.String +Parameter Sets: ResourceSet, ResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Certificate Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Certificate Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Remove-AzIotHubConfiguration.md b/azps-10.1.0/Az.IotHub/Remove-AzIotHubConfiguration.md new file mode 100644 index 0000000000..a604745809 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Remove-AzIotHubConfiguration.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/remove-aziothubconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubConfiguration.md +--- + +# Remove-AzIotHubConfiguration + +## SYNOPSIS +Delete an IoT device configuration. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIotHubConfiguration [-ResourceGroupName] <String> [-IotHubName] <String> [-Name <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIotHubConfiguration [-InputObject] <PSIotHub> [-Name <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIotHubConfiguration [-ResourceId] <String> [-Name <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +See https://learn.microsoft.com/azure/iot-hub/iot-hub-automatic-device-management for more information. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1" +``` + +Delete an IoT device configuration. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Identifier for the configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Allows to return the boolean object. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Remove-AzIotHubDeployment.md b/azps-10.1.0/Az.IotHub/Remove-AzIotHubDeployment.md new file mode 100644 index 0000000000..de74827de5 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Remove-AzIotHubDeployment.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/remove-aziothubdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubDeployment.md +--- + +# Remove-AzIotHubDeployment + +## SYNOPSIS +Delete an IoT Edge deployment. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIotHubDeployment [-ResourceGroupName] <String> [-IotHubName] <String> [-Name <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIotHubDeployment [-InputObject] <PSIotHub> [-Name <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIotHubDeployment [-ResourceId] <String> [-Name <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +See https://learn.microsoft.com/azure/iot-edge/module-deployment-monitoring for more information. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIotHubDeployment -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "deploy1" +``` + +Delete an IoT Edge deployment. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Identifier for the deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Allows to return the boolean object. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Remove-AzIotHubDevice.md b/azps-10.1.0/Az.IotHub/Remove-AzIotHubDevice.md new file mode 100644 index 0000000000..5b1e19a49f --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Remove-AzIotHubDevice.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/remove-aziothubdevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubDevice.md +--- + +# Remove-AzIotHubDevice + +## SYNOPSIS +Delete an IoT Hub device. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIotHubDevice [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIotHubDevice [-InputObject] <PSIotHub> [-DeviceId <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIotHubDevice [-ResourceId] <String> [-DeviceId <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete all devices or a specific device from an Iot Hub. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIotHubDevice -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" +``` + +Delete all Iot Hub devices. + +### Example 2 +```powershell +Remove-AzIotHubDevice -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -PassThru +``` + +```output +True +``` + +Delete an Iot Hub device. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Allows to return the boolean object. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Remove-AzIotHubDeviceChildren.md b/azps-10.1.0/Az.IotHub/Remove-AzIotHubDeviceChildren.md new file mode 100644 index 0000000000..095f8b0e87 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Remove-AzIotHubDeviceChildren.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/remove-aziothubdevicechildren +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubDeviceChildren.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubDeviceChildren.md +--- + +# Remove-AzIotHubDeviceChildren + +## SYNOPSIS +Remove non edge devices as children from specified edge device. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIotHubDeviceChildren [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-Children <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIotHubDeviceChildren [-InputObject] <PSIotHub> [-DeviceId] <String> [-Children <String[]>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIotHubDeviceChildren [-ResourceId] <String> [-DeviceId] <String> [-Children <String[]>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove all or mentioned non-edge devices as children specified edge device. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIotHubDeviceChildren -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Children device1,device2 -Passthru +``` + +```output +True +``` + +Remove mentioned devices as children of specified device. + +### Example 2 +```powershell +Remove-AzIotHubDeviceChildren -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Passthru +``` + +```output +True +``` + +Remove all non-edge devices as children specified edge device. + +## PARAMETERS + +### -Children +Child device list (comma separated) includes only non-edge devices. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Id of edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Allows to return the boolean object. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Remove-AzIotHubEventHubConsumerGroup.md b/azps-10.1.0/Az.IotHub/Remove-AzIotHubEventHubConsumerGroup.md new file mode 100644 index 0000000000..5c2d2f0306 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Remove-AzIotHubEventHubConsumerGroup.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/remove-aziothubeventhubconsumergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubEventHubConsumerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubEventHubConsumerGroup.md +--- + +# Remove-AzIotHubEventHubConsumerGroup + +## SYNOPSIS +Deletes an eventhub consumergroup. + +## SYNTAX + +``` +Remove-AzIotHubEventHubConsumerGroup [-ResourceGroupName] <String> [-Name] <String> + [-EventHubConsumerGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an eventhub consumergroup. + +## EXAMPLES + +### Example 1 Remove eventhub consumergroup from the telemetry eventhub +```powershell +Remove-AzIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubConsumerGroupName myconsumergroup +``` + +Removes the consumergroup named myconsumergroup from the IotHub named "myiothub" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubConsumerGroupName +EventHub ConsumerGroup Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the IotHub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Remove-AzIotHubKey.md b/azps-10.1.0/Az.IotHub/Remove-AzIotHubKey.md new file mode 100644 index 0000000000..e1faf0fee9 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Remove-AzIotHubKey.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/remove-aziothubkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubKey.md +--- + +# Remove-AzIotHubKey + +## SYNOPSIS +Removes an IotHub Key. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIotHubKey [-ResourceGroupName] <String> [-Name] <String> [-KeyName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIotHubKey [-HubId] <String> [-KeyName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an IotHub Key. +If there are multiple keys with the same name the first one in the list is removed. + +## EXAMPLES + +### Example 1 Delete an IotHub +```powershell +Remove-AzIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "iothubowner1" +``` + +Removes the key named iothubowner1 from the IotHub named "myiothub" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyName +Name of the Key + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the IotHub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSSharedAccessSignatureAuthorizationRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Remove-AzIotHubMessageEnrichment.md b/azps-10.1.0/Az.IotHub/Remove-AzIotHubMessageEnrichment.md new file mode 100644 index 0000000000..4d4aa177fc --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Remove-AzIotHubMessageEnrichment.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/remove-aziothubmessageenrichment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubMessageEnrichment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubMessageEnrichment.md +--- + +# Remove-AzIotHubMessageEnrichment + +## SYNOPSIS +Delete a message enrichment in your IoT hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIotHubMessageEnrichment [-ResourceGroupName] <String> [-Name] <String> [-Key <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIotHubMessageEnrichment [-InputObject] <PSIotHub> [-Key <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIotHubMessageEnrichment [-ResourceId] <String> [-Key <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +For a detailed explanation of message enrichments in Azure IoT Hub, see https://learn.microsoft.com/azure/iot-hub/iot-hub-message-enrichments-overview + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIotHubMessageEnrichment -ResourceGroupName "myresourcegroup" -Name "myiothub" -Key "newKey" -Passthru +``` + +```output +True +``` + +Deletes "newKey" message enrichment. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Key +The enrichment's key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Allows to return the boolean object. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Remove-AzIotHubModule.md b/azps-10.1.0/Az.IotHub/Remove-AzIotHubModule.md new file mode 100644 index 0000000000..1203d723fd --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Remove-AzIotHubModule.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/remove-aziothubmodule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubModule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubModule.md +--- + +# Remove-AzIotHubModule + +## SYNOPSIS +Delete module(s) on a target IoT device in an IoT Hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIotHubModule [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-ModuleId <String>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIotHubModule [-InputObject] <PSIotHub> [-DeviceId] <String> [-ModuleId <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIotHubModule [-ResourceId] <String> [-DeviceId] <String> [-ModuleId <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete module(s) on a target IoT device in an IoT Hub. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIotHubModule -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" -PassThru +``` + +```output +True +``` + +Delete an Iot device module. + +### Example 2 +```powershell +Remove-AzIotHubModule -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -PassThru +``` + +```output +True +``` + +Delete all Iot device modules. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +Target Module Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Allows to return the boolean object. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Remove-AzIotHubRoute.md b/azps-10.1.0/Az.IotHub/Remove-AzIotHubRoute.md new file mode 100644 index 0000000000..7dfcc2c3c3 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Remove-AzIotHubRoute.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/remove-aziothubroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubRoute.md +--- + +# Remove-AzIotHubRoute + +## SYNOPSIS +Delete a route in IoT Hub + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIotHubRoute [-ResourceGroupName] <String> [-Name] <String> [-RouteName <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIotHubRoute [-InputObject] <PSIotHub> [-RouteName <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIotHubRoute [-ResourceId] <String> [-RouteName <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a routes to an endpoint + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -PassThru +``` + +```output +True +``` + +Delete route "R1" from "myiothub" IoT Hub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Allows to return the boolean object. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteName +Name of the Route + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Remove-AzIotHubRoutingEndpoint.md b/azps-10.1.0/Az.IotHub/Remove-AzIotHubRoutingEndpoint.md new file mode 100644 index 0000000000..22a28a4799 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Remove-AzIotHubRoutingEndpoint.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/remove-aziothubroutingendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubRoutingEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Remove-AzIotHubRoutingEndpoint.md +--- + +# Remove-AzIotHubRoutingEndpoint + +## SYNOPSIS +Delete an endpoint for your IoT Hub + +## SYNTAX + +### ResourceSet (Default) +``` +Remove-AzIotHubRoutingEndpoint [-ResourceGroupName] <String> [-Name] <String> [-EndpointName <String>] + [-EndpointType <PSEndpointType>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Remove-AzIotHubRoutingEndpoint [-InputObject] <PSIotHub> [-EndpointName <String>] + [-EndpointType <PSEndpointType>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzIotHubRoutingEndpoint [-ResourceId] <String> [-EndpointName <String>] [-EndpointType <PSEndpointType>] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete an endpoint. Remember to delete any routes that use this endpoint. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointName E2 -PassThru +``` + +```output +True +``` + +Delete endpoint "E2" from "myiothub" IoT Hub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the Routing Endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointType +Type of the Routing Endpoint + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSEndpointType +Parameter Sets: (All) +Aliases: +Accepted values: EventHub, ServiceBusQueue, ServiceBusTopic, AzureStorageContainer + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Allows to return the boolean object. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Send-AzIotHubDevice2CloudMessage.md b/azps-10.1.0/Az.IotHub/Send-AzIotHubDevice2CloudMessage.md new file mode 100644 index 0000000000..4a18525a44 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Send-AzIotHubDevice2CloudMessage.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/send-aziothubdevice2cloudmessage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Send-AzIotHubDevice2CloudMessage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Send-AzIotHubDevice2CloudMessage.md +--- + +# Send-AzIotHubDevice2CloudMessage + +## SYNOPSIS +Send device-to-cloud message. + +## SYNTAX + +### ResourceSet (Default) +``` +Send-AzIotHubDevice2CloudMessage [-ResourceGroupName] <String> [-IotHubName] <String> -DeviceId <String> + -Message <String> [-TransportType <PSTransportType>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Send-AzIotHubDevice2CloudMessage [-InputObject] <PSIotHub> -DeviceId <String> -Message <String> + [-TransportType <PSTransportType>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Send-AzIotHubDevice2CloudMessage [-ResourceId] <String> -DeviceId <String> -Message <String> + [-TransportType <PSTransportType>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The command supports sending messages with application and system properties. + +## EXAMPLES + +### Example 1 +```powershell +Send-AzIotHubDevice2CloudMessage -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Message "Ping from PS" +``` + +Sending device to cloud message using default transport type. + +### Example 2 +```powershell +Send-AzIotHubDevice2CloudMessage -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Message "Ping from PS" -TransportType Mqtt +``` + +Sending an mqtt device to cloud message. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Message +Message body to send to IoT Hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Allows to return the boolean object. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TransportType +Transport type to use. +Default is Amqp. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSTransportType +Parameter Sets: (All) +Aliases: +Accepted values: Amqp, Http1, Amqp_WebSocket_Only, Amqp_Tcp_Only, Mqtt, Mqtt_WebSocket_Only, Mqtt_Tcp_Only + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Set-AzIotHub.md b/azps-10.1.0/Az.IotHub/Set-AzIotHub.md new file mode 100644 index 0000000000..4897fff2e1 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Set-AzIotHub.md @@ -0,0 +1,368 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/set-aziothub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHub.md +--- + +# Set-AzIotHub + +## SYNOPSIS +Updates the properties of an IotHub. + +## SYNTAX + +### UpdateSku (Default) +``` +Set-AzIotHub -ResourceGroupName <String> -Name <String> -SkuName <PSIotHubSku> [-Units <Int64>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateEventHubEndpointProperties +``` +Set-AzIotHub -ResourceGroupName <String> -Name <String> -EventHubRetentionTimeInDays <Int64> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateFileUploadProperties +``` +Set-AzIotHub -ResourceGroupName <String> -Name <String> [-FileUploadStorageConnectionString <String>] + [-FileUploadContainerName <String>] [-FileUploadSasUriTtl <TimeSpan>] [-FileUploadNotificationTtl <TimeSpan>] + [-FileUploadNotificationMaxDeliveryCount <Int32>] -EnableFileUploadNotifications <Boolean> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateCloudToDeviceProperties +``` +Set-AzIotHub -ResourceGroupName <String> -Name <String> -CloudToDevice <PSCloudToDeviceProperties> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateRoutingProperties +``` +Set-AzIotHub -ResourceGroupName <String> -Name <String> [-RoutingProperties <PSRoutingProperties>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateRouteProperties +``` +Set-AzIotHub -ResourceGroupName <String> -Name <String> + [-Routes <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteMetadata]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateFallbackRouteProperty +``` +Set-AzIotHub -ResourceGroupName <String> -Name <String> [-FallbackRoute <PSFallbackRouteMetadata>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the properties of an IotHub. + +## EXAMPLES + +### Example 1 Update the sku +```powershell +Set-AzIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" -SkuName S1 -Units 5 +``` + +Update the sku to S1 and units to 5 for the IotHub named "myiothub" + +### Example 2 Update the eventhub properties +```powershell +Set-AzIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubRetentionTimeInDays 4 +``` + +Update the retention time of telemetry in days to 4 for the IotHub named "myiothub" + +## PARAMETERS + +### -CloudToDevice +The properties for the cloud to device command queue. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSCloudToDeviceProperties +Parameter Sets: UpdateCloudToDeviceProperties +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFileUploadNotifications +Flag that specifies whether notifications should be enabled for file upload. + +```yaml +Type: System.Boolean +Parameter Sets: UpdateFileUploadProperties +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubRetentionTimeInDays +Retention time in days. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateEventHubEndpointProperties +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FallbackRoute +Fallback Route for Routing + +```yaml +Type: Microsoft.Azure.Management.IotHub.Models.PSFallbackRouteMetadata +Parameter Sets: UpdateFallbackRouteProperty +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileUploadContainerName +The name of the container to upload the files to. + +```yaml +Type: System.String +Parameter Sets: UpdateFileUploadProperties +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileUploadNotificationMaxDeliveryCount +The maximum delivery count for file upload notifications. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: UpdateFileUploadProperties +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileUploadNotificationTtl +Time to live value for the messages in the file upload notification queue. + +```yaml +Type: System.TimeSpan +Parameter Sets: UpdateFileUploadProperties +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileUploadSasUriTtl +Time to live for the for the SAS Uri thats generated for file upload. + +```yaml +Type: System.TimeSpan +Parameter Sets: UpdateFileUploadProperties +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileUploadStorageConnectionString +The storage connection string to upload the files to. + +```yaml +Type: System.String +Parameter Sets: UpdateFileUploadProperties +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the IotHub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Routes +Routes to be added for Routing + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteMetadata] +Parameter Sets: UpdateRouteProperties +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingProperties +The Routing properties for routing messages to external endpoints + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingProperties +Parameter Sets: UpdateRoutingProperties +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name of the Sku. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubSku +Parameter Sets: UpdateSku +Aliases: +Accepted values: F1, S1, S2, S3, B1, B2, B3 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Units +Number of Units + +```yaml +Type: System.Int64 +Parameter Sets: UpdateSku +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Set-AzIotHubConfiguration.md b/azps-10.1.0/Az.IotHub/Set-AzIotHubConfiguration.md new file mode 100644 index 0000000000..ff0c8eb864 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Set-AzIotHubConfiguration.md @@ -0,0 +1,276 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/set-aziothubconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubConfiguration.md +--- + +# Set-AzIotHubConfiguration + +## SYNOPSIS +Update the mutable fields of the configuration registration. + +## SYNTAX + +### ResourceSet (Default) +``` +Set-AzIotHubConfiguration [-ResourceGroupName] <String> [-IotHubName] <String> [-Name] <String> + [-Priority <Int32>] [-TargetCondition <String>] [-Metric <Hashtable>] [-Label <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Set-AzIotHubConfiguration [-InputObject] <PSIotHub> [-Name] <String> [-Priority <Int32>] + [-TargetCondition <String>] [-Metric <Hashtable>] [-Label <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzIotHubConfiguration [-ResourceId] <String> [-Name] <String> [-Priority <Int32>] + [-TargetCondition <String>] [-Metric <Hashtable>] [-Label <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update specified properties of an IoT automatic device management configuration. +Note: Configuration content is immutable. Configuration properties that can be updated are 'labels', 'metrics', 'priority' and 'targetCondition'. +See https://learn.microsoft.com/azure/iot-hub/iot-hub-automatic-device-management for more information. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1" -Priority 7 -TargetCondition "tags.building=3 and tags.environment='dev'" +``` + +Alter the priority of a device configuration and update its target condition + +### Example 2 +```powershell +$labels = @{} +$labels.add("key0","value0") +$metrics = @{} +$metrics.add("query1", "select deviceId from devices where tags.location='US'") +Set-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1" -Label $labels -Metric $metrics +``` + +Update the metrics and labels of a device configuration + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Allows configuration object to be replaced even if it was updated since it was retrieved last time. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +Map of labels to be applied to target configuration. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metric +Queries collection for configuration metrics definition. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Identifier for the configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Weight of the device configuration in case of competing rules (highest wins). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetCondition +Target condition in which a device configuration applies to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Set-AzIotHubDeployment.md b/azps-10.1.0/Az.IotHub/Set-AzIotHubDeployment.md new file mode 100644 index 0000000000..c43244671e --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Set-AzIotHubDeployment.md @@ -0,0 +1,276 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/set-aziothubdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubDeployment.md +--- + +# Set-AzIotHubDeployment + +## SYNOPSIS +Update the mutable fields of IoT Edge deployment. + +## SYNTAX + +### ResourceSet (Default) +``` +Set-AzIotHubDeployment [-ResourceGroupName] <String> [-IotHubName] <String> -Name <String> [-Priority <Int32>] + [-TargetCondition <String>] [-Metric <Hashtable>] [-Label <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Set-AzIotHubDeployment [-InputObject] <PSIotHub> -Name <String> [-Priority <Int32>] [-TargetCondition <String>] + [-Metric <Hashtable>] [-Label <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzIotHubDeployment [-ResourceId] <String> -Name <String> [-Priority <Int32>] [-TargetCondition <String>] + [-Metric <Hashtable>] [-Label <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update specified properties of an IoT Edge deployment. +Note: Configuration content is immutable. Configuration properties that can be updated are 'labels', 'metrics', 'priority' and 'targetCondition'. +See https://learn.microsoft.com/azure/iot-edge/module-deployment-monitoring for more information. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIotHubDeployment -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "deploy1" -Priority 7 -TargetCondition "tags.building=3 and tags.environment='dev'" +``` + +Alter the priority of IoT Edge deployment and update its target condition. + +### Example 2 +```powershell +$labels = @{} +$labels.add("key0","value0") +$metrics = @{} +$metrics.add("query1", "select deviceId from devices where tags.location='US'") +Set-AzIotHubDeployment -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "deploy1" -Label $labels -Metric $metrics +``` + +Update the metrics and labels of IoT Edge deployment. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Allows deployment object to be replaced even if it was updated since it was retrieved last time. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +Map of labels to be applied to target deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metric +Queries collection for IoT Edge deployment metrics definition. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Identifier for the deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Weight of deployment in case of competing rules (highest wins). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetCondition +Target condition in which an Edge deployment applies to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDeployment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Set-AzIotHubDevice.md b/azps-10.1.0/Az.IotHub/Set-AzIotHubDevice.md new file mode 100644 index 0000000000..39b541c3f2 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Set-AzIotHubDevice.md @@ -0,0 +1,329 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/set-aziothubdevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubDevice.md +--- + +# Set-AzIotHubDevice + +## SYNOPSIS +Update an IoT Hub device. + +## SYNTAX + +### ResourceSetForStatus (Default) +``` +Set-AzIotHubDevice [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-Status <PSDeviceStatus>] [-StatusReason <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectSetForAuth +``` +Set-AzIotHubDevice [-InputObject] <PSIotHub> [-DeviceId] <String> [-AuthMethod <PSDeviceAuthType>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSetForStatus +``` +Set-AzIotHubDevice [-InputObject] <PSIotHub> [-DeviceId] <String> [-Status <PSDeviceStatus>] + [-StatusReason <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSetForEdgeEnabled +``` +Set-AzIotHubDevice [-InputObject] <PSIotHub> [-DeviceId] <String> [-EdgeEnabled <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceSetForAuth +``` +Set-AzIotHubDevice [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-AuthMethod <PSDeviceAuthType>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceSetForEdgeEnabled +``` +Set-AzIotHubDevice [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-EdgeEnabled <Boolean>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSetForAuth +``` +Set-AzIotHubDevice [-ResourceId] <String> [-DeviceId] <String> [-AuthMethod <PSDeviceAuthType>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSetForStatus +``` +Set-AzIotHubDevice [-ResourceId] <String> [-DeviceId] <String> [-Status <PSDeviceStatus>] + [-StatusReason <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSetForEdgeEnabled +``` +Set-AzIotHubDevice [-ResourceId] <String> [-DeviceId] <String> [-EdgeEnabled <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update an IoT Hub device. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIotHubDevice -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -EdgeEnabled $true +``` + +Turn on edge capabilities for device. + +### Example 2 +```powershell +Set-AzIotHubDevice -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Status Disabled +``` + +Disable device status. + +### Example 3 +```powershell +Set-AzIotHubDevice -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -AuthMethod "x509_ca" +``` + +Update authorization type of an Iot Hub device. + +## PARAMETERS + +### -AuthMethod +The authorization type an entity is to be created with. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSDeviceAuthType +Parameter Sets: InputObjectSetForAuth, ResourceSetForAuth, ResourceIdSetForAuth +Aliases: +Accepted values: shared_private_key, x509_thumbprint, x509_ca + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeEnabled +Flag indicating edge enablement. + +```yaml +Type: System.Boolean +Parameter Sets: InputObjectSetForEdgeEnabled, ResourceSetForEdgeEnabled, ResourceIdSetForEdgeEnabled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSetForAuth, InputObjectSetForStatus, InputObjectSetForEdgeEnabled +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSetForStatus, ResourceSetForAuth, ResourceSetForEdgeEnabled +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryThumbprint +Explicit self-signed certificate thumbprint to use for primary key. + +```yaml +Type: System.String +Parameter Sets: InputObjectSetForAuth, ResourceSetForAuth, ResourceIdSetForAuth +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSetForStatus, ResourceSetForAuth, ResourceSetForEdgeEnabled +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSetForAuth, ResourceIdSetForStatus, ResourceIdSetForEdgeEnabled +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryThumbprint +Explicit self-signed certificate thumbprint to use for secondary key. + +```yaml +Type: System.String +Parameter Sets: InputObjectSetForAuth, ResourceSetForAuth, ResourceIdSetForAuth +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Set device status upon creation. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSDeviceStatus +Parameter Sets: ResourceSetForStatus, InputObjectSetForStatus, ResourceIdSetForStatus +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusReason +Description for device status. + +```yaml +Type: System.String +Parameter Sets: ResourceSetForStatus, InputObjectSetForStatus, ResourceIdSetForStatus +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDevice + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Set-AzIotHubDeviceParent.md b/azps-10.1.0/Az.IotHub/Set-AzIotHubDeviceParent.md new file mode 100644 index 0000000000..7567cd759d --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Set-AzIotHubDeviceParent.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/set-aziothubdeviceparent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubDeviceParent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubDeviceParent.md +--- + +# Set-AzIotHubDeviceParent + +## SYNOPSIS +Set the parent device of the specified device. + +## SYNTAX + +### ResourceSet (Default) +``` +Set-AzIotHubDeviceParent [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-ParentDeviceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Set-AzIotHubDeviceParent [-InputObject] <PSIotHub> [-DeviceId] <String> [-ParentDeviceId] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzIotHubDeviceParent [-ResourceId] <String> [-DeviceId] <String> [-ParentDeviceId] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Set the parent device of the specified non-edge device. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIotHubDeviceParent -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ParentDeviceId "myParentDevice1" +``` + +```output +DeviceId : myDevice1 +GenerationId : 637148941292917073 +ETag : "NzIyMDI4MTk3" +LastActivityTime : 1/1/0001 12:00:00 AM +ConnectionState : Disconnected +ConnectionStateUpdatedTime : 1/1/0001 12:00:00 AM +Status : Enabled +StatusReason : +StatusUpdatedTime : 1/17/2020 10:15:04 PM +CloudToDeviceMessageCount : 0 +Authentication : Sas +EdgeEnabled : False +DeviceScope : ms-azure-iot-edge://myParentDevice1-637176526047419634 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Id of non-edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrites the non-edge device's parent device. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentDeviceId +Id of edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDevice + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Set-AzIotHubDistributedTracing.md b/azps-10.1.0/Az.IotHub/Set-AzIotHubDistributedTracing.md new file mode 100644 index 0000000000..09e2eb6ff1 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Set-AzIotHubDistributedTracing.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/set-aziothubdistributedtracing +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubDistributedTracing.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubDistributedTracing.md +--- + +# Set-AzIotHubDistributedTracing + +## SYNOPSIS +Update the distributed tracing options for a device. + +## SYNTAX + +### ResourceSet (Default) +``` +Set-AzIotHubDistributedTracing [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-SamplingMode] <PSDistributedTracingSamplingMode> [-SamplingRate <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Set-AzIotHubDistributedTracing [-InputObject] <PSIotHub> [-DeviceId] <String> + [-SamplingMode] <PSDistributedTracingSamplingMode> [-SamplingRate <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzIotHubDistributedTracing [-ResourceId] <String> [-DeviceId] <String> + [-SamplingMode] <PSDistributedTracingSamplingMode> [-SamplingRate <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update the distributed tracing options for a device. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIotHubDistributedTracing -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -SamplingMode Enabled -SamplingRate 22 +``` + +```output +DeviceId : mydevice1 +Sampling Mode : Enabled +Sampling Rate : 22% +IsSynced : False +``` + +Update the distributed tracing options for a device. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SamplingMode +Turns sampling for distributed tracing enable and disable. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSDistributedTracingSamplingMode +Parameter Sets: (All) +Aliases: Mode +Accepted values: Disabled, Enabled + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamplingRate +Controls the amount of messages sampled for adding trace context. +This value is a percentage. +Only values from 0 to 100 (inclusive) are permitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Rate + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSDeviceTracing + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Set-AzIotHubEdgeModule.md b/azps-10.1.0/Az.IotHub/Set-AzIotHubEdgeModule.md new file mode 100644 index 0000000000..8acbc71468 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Set-AzIotHubEdgeModule.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/set-aziothubedgemodule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubEdgeModule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubEdgeModule.md +--- + +# Set-AzIotHubEdgeModule + +## SYNOPSIS +Set edge modules on a single edge device. + +## SYNTAX + +### ResourceSet (Default) +``` +Set-AzIotHubEdgeModule [-ResourceGroupName] <String> [-IotHubName] <String> -DeviceId <String> + -ModulesContent <Hashtable> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Set-AzIotHubEdgeModule [-InputObject] <PSIotHub> -DeviceId <String> -ModulesContent <Hashtable> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzIotHubEdgeModule [-ResourceId] <String> -DeviceId <String> -ModulesContent <Hashtable> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Applies the provided modules configuration content to the specified edge device. +Note: Upon execution the command will output the collection of modules applied to the device. + +## EXAMPLES + +### Example 1 +```powershell +$content = Get-Content "C:/Edge/modules.json" | ConvertFrom-Json -AsHashtable +Set-AzIotHubEdgeModule -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myEdgeDevice1" -ModulesContent $content +``` + +Test edge modules while in development by setting modules on a target device. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Edge Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModulesContent +Configuration content of modules for IoT Edge devices. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSModules[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Set-AzIotHubMessageEnrichment.md b/azps-10.1.0/Az.IotHub/Set-AzIotHubMessageEnrichment.md new file mode 100644 index 0000000000..35e5762997 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Set-AzIotHubMessageEnrichment.md @@ -0,0 +1,236 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/set-aziothubmessageenrichment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubMessageEnrichment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubMessageEnrichment.md +--- + +# Set-AzIotHubMessageEnrichment + +## SYNOPSIS +Update a message enrichment in your IoT hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Set-AzIotHubMessageEnrichment [-ResourceGroupName] <String> [-Name] <String> [-Key] <String> [-Value <String>] + [-Endpoint <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Set-AzIotHubMessageEnrichment [-InputObject] <PSIotHub> [-Key] <String> [-Value <String>] + [-Endpoint <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzIotHubMessageEnrichment [-ResourceId] <String> [-Key] <String> [-Value <String>] [-Endpoint <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +For a detailed explanation of message enrichments in Azure IoT Hub, see https://learn.microsoft.com/azure/iot-hub/iot-hub-message-enrichments-overview + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIotHubMessageEnrichment -ResourceGroupName "myresourcegroup" -Name "myiothub" -Key "newKey" -Value "updatedValue" +``` + +```output +Key : newKey +Value : updatedValue +Endpoint(s) : {endpoint1, endpoint2} +``` + +Updates enrichment's value to "updatedValue" for the key "newKey". +For a detailed explanation of message enrichments in Azure IoT Hub, see https://learn.microsoft.com/azure/iot-hub/iot-hub-message-enrichments-overview + +### Example 2 +```powershell +Set-AzIotHubMessageEnrichment -ResourceGroupName "myresourcegroup" -Name "myiothub" -Key "newKey" -Endpoint endpoint1,endpoint2,endpoint3 +``` + +```output +Key : newKey +Value : value1 +Endpoint(s) : {endpoint1, endpoint2, endpoint3} +``` + +Updates enrichment's endpoint to "endpoint1, endpoint2, endpoint3" for the key "newKey". +For a detailed explanation of message enrichments in Azure IoT Hub, see https://learn.microsoft.com/azure/iot-hub/iot-hub-message-enrichments-overview + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +Endpoint(s) to apply enrichments to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Key +The enrichment's key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +The enrichment's value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSEnrichmentMetadata + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Set-AzIotHubModule.md b/azps-10.1.0/Az.IotHub/Set-AzIotHubModule.md new file mode 100644 index 0000000000..5294940109 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Set-AzIotHubModule.md @@ -0,0 +1,262 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/set-aziothubmodule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubModule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubModule.md +--- + +# Set-AzIotHubModule + +## SYNOPSIS +Update a module on a target IoT device in an IoT Hub. + +## SYNTAX + +### ResourceSet (Default) +``` +Set-AzIotHubModule [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> [-ModuleId] <String> + [-AuthMethod <PSDeviceAuthType>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Set-AzIotHubModule [-InputObject] <PSIotHub> [-DeviceId] <String> [-ModuleId] <String> + [-AuthMethod <PSDeviceAuthType>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzIotHubModule [-ResourceId] <String> [-DeviceId] <String> [-ModuleId] <String> + [-AuthMethod <PSDeviceAuthType>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Update a module on a target IoT device in an IoT Hub. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIotHubModule -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" -AuthMethod "shared_private_key" +``` + +```output +ModuleId : myModule1 +DeviceId : myDevice1 +GenerationId : 637148941292917073 +ETag : "NzIyMDI4MTk3" +LastActivityTime : 1/1/0001 12:00:00 AM +ConnectionState : Disconnected +ConnectionStateUpdatedTime : 1/1/0001 12:00:00 AM +CloudToDeviceMessageCount : 0 +Authentication : Sas +ManagedBy : +``` + +Update authorization type of an Iot device module. + +## PARAMETERS + +### -AuthMethod +The authorization type an entity is to be created with. + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSDeviceAuthType +Parameter Sets: (All) +Aliases: +Accepted values: shared_private_key, x509_thumbprint, x509_ca + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +Target Module Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryThumbprint +Explicit self-signed certificate thumbprint to use for primary key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryThumbprint +Explicit self-signed certificate thumbprint to use for secondary key. + +```yaml +Type:System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSModule + +## NOTES + +## RELATED LINKS \ No newline at end of file diff --git a/azps-10.1.0/Az.IotHub/Set-AzIotHubRoute.md b/azps-10.1.0/Az.IotHub/Set-AzIotHubRoute.md new file mode 100644 index 0000000000..53dc4d6e73 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Set-AzIotHubRoute.md @@ -0,0 +1,287 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/set-aziothubroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubRoute.md +--- + +# Set-AzIotHubRoute + +## SYNOPSIS +Update a route in IoT Hub + +## SYNTAX + +### ResourceSet (Default) +``` +Set-AzIotHubRoute [-ResourceGroupName] <String> [-Name] <String> [-RouteName] <String> + [-Source <PSRoutingSource>] [-EndpointName <String>] [-Condition <String>] [-Enabled] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Set-AzIotHubRoute [-InputObject] <PSIotHub> [-RouteName] <String> [-Source <PSRoutingSource>] + [-EndpointName <String>] [-Condition <String>] [-Enabled] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzIotHubRoute [-ResourceId] <String> [-RouteName] <String> [-Source <PSRoutingSource>] + [-EndpointName <String>] [-Condition <String>] [-Enabled] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Edit a route. You can update all the fields in a route including the data source, endpoint, routing query and also enable or disable the route. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -Source TwinChangeEvents +``` + +```output +RouteName : R1 +DataSource : TwinChangeEvents +EndpointNames : events +Condition : true +IsEnabled : False +``` + +Updating the route information. + +### Example 2 +```powershell +Set-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -EndpointName E1 +``` + +```output +RouteName : R1 +DataSource : TwinChangeEvents +EndpointNames : E1 +Condition : true +IsEnabled : False +``` + +Updating the route information. + +### Example 3 +```powershell +Set-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -Enabled +``` + +```output +RouteName : R1 +DataSource : TwinChangeEvents +EndpointNames : E1 +Condition : true +IsEnabled : True +``` + +Updating the route information. + +## PARAMETERS + +### -Condition +Condition that is evaluated to apply the routing rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Enable route + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Name of the routing endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteName +Name of the Route + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Source of the route + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingSource] +Parameter Sets: (All) +Aliases: +Accepted values: Invalid, DeviceMessages, TwinChangeEvents, DeviceLifecycleEvents, DeviceJobLifecycleEvents, DigitalTwinChangeEvents + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteMetadata + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Set-AzIotHubVerifiedCertificate.md b/azps-10.1.0/Az.IotHub/Set-AzIotHubVerifiedCertificate.md new file mode 100644 index 0000000000..1a279d1767 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Set-AzIotHubVerifiedCertificate.md @@ -0,0 +1,230 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/set-aziothubverifiedcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubVerifiedCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Set-AzIotHubVerifiedCertificate.md +--- + +# Set-AzIotHubVerifiedCertificate + +## SYNOPSIS +Verifies an Azure IoT Hub certificate. + +## SYNTAX + +### ResourceSet (Default) +``` +Set-AzIotHubVerifiedCertificate [-ResourceGroupName] <String> [-Name] <String> [-CertificateName] <String> + [-Etag] <String> [-Path] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectSet +``` +Set-AzIotHubVerifiedCertificate [-InputObject] <PSCertificateDescription> [-Path] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzIotHubVerifiedCertificate [-ResourceId] <String> [-Etag] <String> [-Path] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Verifies a certificate by uploading a verification certificate containing the verification code obtained by cmdlet Get-AzIotHubCertificateVerificationCode. This is the last step in the proof of possession process. +For a detailed explanation of CA certificates in Azure IoT Hub, see https://learn.microsoft.com/azure/iot-hub/iot-hub-x509ca-overview + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIotHubVerifiedCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate" -Path "c:\myverifiedcertificate.cer" -Etag "AAAAAAFPazE=" +``` + +```output +Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/IotHubs/myiothub/certificates/mycertificate +ResourceGroupName : myresourcegroup +Name : myiothub +CertificateName : mycertificate +Subject : CN=mycertificate +Thumbprint : 38303FC7371EC13DDE3E18D712C8414EE50969C7 +Status : Verified +Expiry : 1/01/2027 16:01 +Created : 1/01/2017 16:01 +Etag : AAAAAAFpObE= +``` + +Verifies ownership of the MyCertificate private key. + +## PARAMETERS + +### -CertificateName +Name of the Certificate + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Etag of the Certificate + +```yaml +Type: System.String +Parameter Sets: ResourceSet, ResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Certificate Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +base-64 representation of X509 certificate .cer file or .pem file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Certificate Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Test-AzIotHubRoute.md b/azps-10.1.0/Az.IotHub/Test-AzIotHubRoute.md new file mode 100644 index 0000000000..7de68af5d8 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Test-AzIotHubRoute.md @@ -0,0 +1,308 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/test-aziothubroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Test-AzIotHubRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Test-AzIotHubRoute.md +--- + +# Test-AzIotHubRoute + +## SYNOPSIS +Test routes in IoT Hub + +## SYNTAX + +### ResourceSet (Default) +``` +Test-AzIotHubRoute [-Body <String>] [-AppProperty <Hashtable>] [-SystemProperty <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectTestRouteSet +``` +Test-AzIotHubRoute [-InputObject] <PSIotHub> [-RouteName] <String> [-Body <String>] [-AppProperty <Hashtable>] + [-SystemProperty <Hashtable>] [-ShowError] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectTestAllRouteSet +``` +Test-AzIotHubRoute [-InputObject] <PSIotHub> [-Source] <PSRoutingSource> [-Body <String>] + [-AppProperty <Hashtable>] [-SystemProperty <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### TestRouteSet +``` +Test-AzIotHubRoute [-ResourceGroupName] <String> [-Name] <String> [-RouteName] <String> [-Body <String>] + [-AppProperty <Hashtable>] [-SystemProperty <Hashtable>] [-ShowError] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### TestAllRouteSet +``` +Test-AzIotHubRoute [-ResourceGroupName] <String> [-Name] <String> [-Source] <PSRoutingSource> [-Body <String>] + [-AppProperty <Hashtable>] [-SystemProperty <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdTestRouteSet +``` +Test-AzIotHubRoute [-ResourceId] <String> [-RouteName] <String> [-Body <String>] [-AppProperty <Hashtable>] + [-SystemProperty <Hashtable>] [-ShowError] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdTestAllRouteSet +``` +Test-AzIotHubRoute [-ResourceId] <String> [-Source] <PSRoutingSource> [-Body <String>] + [-AppProperty <Hashtable>] [-SystemProperty <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Test a specific route. + +## EXAMPLES + +### Example 1 +```powershell +Test-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -Source DeviceMessages +``` + +```output +RouteName DataSource EndpointNames IsEnabled +--------- ---------- ------------- --------- +R1 DeviceMessages events True +R5 DeviceMessages E1 True +``` + +Test all route with source "DeviceMessages". + +### Example 2 +```powershell +Test-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 +``` + +```output +Result : true +``` + +Test a specific route. + +### Example 3 +```powershell +Test-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -ShowError +``` + +```output +ErrorMessage Severity LocationStartLine LocationStartColumn LocationEndLine LocationEndColumn +------------ -------- ----------------- ------------------- --------------- ----------------- +Syntax error. error 1 29 1 30 +``` + +Test a specific route and showing the reason of failure. + +### Example 4 +```powershell +$ap = @{} +$ap.add("key0","value0") +$sp = @{} +$sp.add("key1", "value1") +Test-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -AppProperty $ap -SystemProperty $sp +``` + +```output +Result : true +``` + +Test a specific route with AppProperty and SystemProperty. + +## PARAMETERS + +### -AppProperty +App properties of the route message + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +Body of the route message + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub Object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectTestRouteSet, InputObjectTestAllRouteSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: TestRouteSet, TestAllRouteSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: TestRouteSet, TestAllRouteSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdTestRouteSet, ResourceIdTestAllRouteSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteName +Name of the Route + +```yaml +Type: System.String +Parameter Sets: InputObjectTestRouteSet, TestRouteSet, ResourceIdTestRouteSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowError +Show detailed error, if exist + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: InputObjectTestRouteSet, TestRouteSet, ResourceIdTestRouteSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Source of the route + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingSource +Parameter Sets: InputObjectTestAllRouteSet, TestAllRouteSet, ResourceIdTestAllRouteSet +Aliases: +Accepted values: Invalid, DeviceMessages, TwinChangeEvents, DeviceLifecycleEvents, DeviceJobLifecycleEvents, DigitalTwinChangeEvents + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemProperty +System properties of the route message + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSTestRouteResult + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteCompilationError + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteProperties[] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Update-AzIotHub.md b/azps-10.1.0/Az.IotHub/Update-AzIotHub.md new file mode 100644 index 0000000000..4db3f17dd8 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Update-AzIotHub.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/update-aziothub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Update-AzIotHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Update-AzIotHub.md +--- + +# Update-AzIotHub + +## SYNOPSIS +Update an Azure IoT Hub. + +## SYNTAX + +``` +Update-AzIotHub -ResourceGroupName <String> -Name <String> -Tag <Hashtable> [-Reset] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +You can update the tags properties of an IotHub. + +## EXAMPLES + +### Example 1 +```powershell +$updatedTag = @{} +$updatedTag.add("key0","value0") +Update-AzIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" -Tag $updatedTag +``` + +```output +Id : /subscriptions/91d1xxxx-xxxx-xxxx-xxxx-xxxxxxxxddc0/resourceGroups/myresourcegroup/providers/Microsoft.De + vices/IotHubs/myiothub +Name : myiothub +Type : Microsoft.Devices/IotHubs +Location : East US +Tags : {[key0, value0]} +Properties : Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubProperties +Sku : Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubSkuInfo +``` + +Update tags of an IoT Hub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Reset +Reset IoTHub Tags + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +IoTHub Tag collection + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Update-AzIotHubDeviceTwin.md b/azps-10.1.0/Az.IotHub/Update-AzIotHubDeviceTwin.md new file mode 100644 index 0000000000..b231d26fbb --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Update-AzIotHubDeviceTwin.md @@ -0,0 +1,257 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/update-aziothubdevicetwin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Update-AzIotHubDeviceTwin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Update-AzIotHubDeviceTwin.md +--- + +# Update-AzIotHubDeviceTwin + +## SYNOPSIS +Updates tags and desired properties of a device twin. + +## SYNTAX + +### ResourceSet (Default) +``` +Update-AzIotHubDeviceTwin [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + [-Tag <Hashtable>] [-Desired <Hashtable>] [-Partial] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Update-AzIotHubDeviceTwin [-InputObject] <PSIotHub> [-DeviceId] <String> [-Tag <Hashtable>] + [-Desired <Hashtable>] [-Partial] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Update-AzIotHubDeviceTwin [-ResourceId] <String> [-DeviceId] <String> [-Tag <Hashtable>] [-Desired <Hashtable>] + [-Partial] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates or replaces a device twin. See https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzIotHubDeviceTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Tag $updatedTag -Desired $updatedDesired -Partial +``` + +Returns the updated device twin object. + +### Example 2 +```powershell +Update-AzIotHubDeviceTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Desired $updatedDesired -Partial +``` + +Returns the device twin object with updated desired properties. + +### Example 3 +```powershell +Update-AzIotHubDeviceTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Tag $updatedTag -Partial +``` + +Returns the device twin object with updated tags property. + +### Example 4 +```powershell +$updatedTag = @{} +$updatedTag.add("key0","value0") +$updatedDesired =@{} +$updatedDesired.add("desiredkey","desiredvalue") +Update-AzIotHubDeviceTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Tag $updatedTag -Desired $updatedDesired +``` + +Returns the replaced device twin object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Desired +Add or update the desired property in a device twin. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partial +Allows to only partially update the tags and desired properties of a device twin. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Add or update the tags property in a device twin. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.IotHub/Update-AzIotHubModuleTwin.md b/azps-10.1.0/Az.IotHub/Update-AzIotHubModuleTwin.md new file mode 100644 index 0000000000..dd5e109c84 --- /dev/null +++ b/azps-10.1.0/Az.IotHub/Update-AzIotHubModuleTwin.md @@ -0,0 +1,269 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.IotHub.dll-Help.xml +Module Name: Az.IotHub +online version: https://learn.microsoft.com/powershell/module/az.iothub/update-aziothubmoduletwin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Update-AzIotHubModuleTwin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/IotHub/IotHub/help/Update-AzIotHubModuleTwin.md +--- + +# Update-AzIotHubModuleTwin + +## SYNOPSIS +Updates tags and desired properties of an IoT device module twin. + +## SYNTAX + +### ResourceSet (Default) +``` +Update-AzIotHubModuleTwin [-ResourceGroupName] <String> [-IotHubName] <String> [-DeviceId] <String> + -ModuleId <String> [-Tag <Hashtable>] [-Desired <Hashtable>] [-Partial] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSet +``` +Update-AzIotHubModuleTwin [-InputObject] <PSIotHub> [-DeviceId] <String> -ModuleId <String> [-Tag <Hashtable>] + [-Desired <Hashtable>] [-Partial] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +Update-AzIotHubModuleTwin [-ResourceId] <String> [-DeviceId] <String> -ModuleId <String> [-Tag <Hashtable>] + [-Desired <Hashtable>] [-Partial] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates or replaces a device twin. See https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-module-twins for more information. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzIotHubModuleTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" -Tag $updatedTag -Desired $updatedDesired -Partial +``` + +Returns the updated device module twin object. + +### Example 2 +```powershell +Update-AzIotHubModuleTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" -Desired $updatedDesired -Partial +``` + +Returns the device module twin object with updated desired properties. + +### Example 3 +```powershell +Update-AzIotHubModuleTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" -Tag $updatedTag -Partial +``` + +Returns the device module twin object with updated tags property. + +### Example 4 +```powershell +Update-AzIotHubModuleTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" -Tag $updatedTag -Desired $updatedDesired +``` + +Returns the replaced device module twin object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Desired +Add or update the desired property in a module twin. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceId +Target Device Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +IotHub object + +```yaml +Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub +Parameter Sets: InputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubName +Name of the Iot Hub + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +Target Module Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Partial +Allows to only partially update the tags and desired properties of a module twin. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group + +```yaml +Type: System.String +Parameter Sets: ResourceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IotHub Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Add or update the tags property in a module twin. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.IotHub.Models.PSModuleTwin + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultCertificate.md b/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultCertificate.md new file mode 100644 index 0000000000..f724d07cfc --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultCertificate.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 89299823-3382-402D-9458-519466748051 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/add-azkeyvaultcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Add-AzKeyVaultCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Add-AzKeyVaultCertificate.md +--- + +# Add-AzKeyVaultCertificate + +## SYNOPSIS +Adds a certificate to a key vault. + +## SYNTAX + +``` +Add-AzKeyVaultCertificate [-VaultName] <String> [-Name] <String> + [-CertificatePolicy] <PSKeyVaultCertificatePolicy> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzKeyVaultCertificate** cmdlet starts the process of enrolling for a certificate in a key vault in Azure Key Vault. + +## EXAMPLES + +### Example 1: Add a certificate +<!-- Skip: Output cannot be splitted from code --> +```powershell +$Policy = New-AzKeyVaultCertificatePolicy -SecretContentType "application/x-pkcs12" -SubjectName "CN=contoso.com" -IssuerName "Self" -ValidityInMonths 6 -ReuseKeyOnRenewal +Add-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01" -CertificatePolicy $Policy + +Status : inProgress +CancellationRequested : False +CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC73w3VRBOlgJ5Od1PjDh+2ytngNZp+ZP4fkuX8K1Ti5LA6Ih7eWx1fgAN/iTb6l + 5K6LvAIJvsTNVePMNxfSdaEIJ70Inm45wVU4A/kf+UxQWAYVMsBrLtDFWxnVhzf6n7RGYke6HLBj3j5ASb9g+olSs6eON25ibF0t+u6JC+sIR0LmVGar9Q0eZys1rdfzJBIKq+laOM7z2pJijb5ANqve9 + i7rH5mnhQk4V8WsRstOhYR9jgLqSSxokDoeaBClIOidSBYqVc1yNv4ASe1UWUCR7ZK6OQXiecNWSWPmgWEyawu6AR9eb1YotCr2ScheMOCxlm3103luitxrd8A7kMjAgMBAAGgSzBJBgkqhkiG9w0BCQ4 + xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAIHhsDJV37PKi8hor5eQf7+Tct1preIvSwqV0NF6Uo7O6 + YnC9Py7Wp7CHfKzuqeptUk2Tsu7B5dHB+o9Ypeeqw8fWhTN0GFGRKO7WjZQlDqL+lRNcjlFSaP022oIP0kmvVhBcmZqRQlALXccAaxEclFA/3y/aNj2gwWeKpH/pwAkZ39zMEzpQCaRfnQk7e3l4MV8cf + eC2HPYdRWkXxAeDcNPxBuVmKy49AzYvly+APNVDU3v66gxl3fIKrGRsKi2Cp/nO5rBxG2h8t+0Za4l/HJ7ZWR9wKbd/xg7JhdZZFVBxMHYzw8KQ0ys13x8HY+PXU92Y7yD3uC2Rcj+zbAf+Kg== +ErrorCode : +ErrorMessage : + +Get-AzKeyVaultCertificateOperation -VaultName "ContosoKV01" -Name "TestCert01" +Status : completed +CancellationRequested : False +CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC73w3VRBOlgJ5Od1PjDh+2ytngNZp+ZP4fkuX8K1Ti5LA6Ih7eWx1fgAN/iTb6l + 5K6LvAIJvsTNVePMNxfSdaEIJ70Inm45wVU4A/kf+UxQWAYVMsBrLtDFWxnVhzf6n7RGYke6HLBj3j5ASb9g+olSs6eON25ibF0t+u6JC+sIR0LmVGar9Q0eZys1rdfzJBIKq+laOM7z2pJijb5ANqve9 + i7rH5mnhQk4V8WsRstOhYR9jgLqSSxokDoeaBClIOidSBYqVc1yNv4ASe1UWUCR7ZK6OQXiecNWSWPmgWEyawu6AR9eb1YotCr2ScheMOCxlm3103luitxrd8A7kMjAgMBAAGgSzBJBgkqhkiG9w0BCQ4 + xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAIHhsDJV37PKi8hor5eQf7+Tct1preIvSwqV0NF6Uo7O6 + YnC9Py7Wp7CHfKzuqeptUk2Tsu7B5dHB+o9Ypeeqw8fWhTN0GFGRKO7WjZQlDqL+lRNcjlFSaP022oIP0kmvVhBcmZqRQlALXccAaxEclFA/3y/aNj2gwWeKpH/pwAkZ39zMEzpQCaRfnQk7e3l4MV8cf + eC2HPYdRWkXxAeDcNPxBuVmKy49AzYvly+APNVDU3v66gxl3fIKrGRsKi2Cp/nO5rBxG2h8t+0Za4l/HJ7ZWR9wKbd/xg7JhdZZFVBxMHYzw8KQ0ys13x8HY+PXU92Y7yD3uC2Rcj+zbAf+Kg== +ErrorCode : +ErrorMessage : + +Get-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01" + +Name : testCert01 +Certificate : [Subject] + CN=contoso.com + + [Issuer] + CN=contoso.com + + [Serial Number] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + [Not Before] + 2/8/2016 3:11:45 PM + + [Not After] + 8/8/2016 4:21:45 PM + + [Thumbprint] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + +Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +Tags : +Enabled : True +Created : 2/8/2016 11:21:45 PM +Updated : 2/8/2016 11:21:45 PM +``` + +The first command uses the New-AzKeyVaultCertificatePolicy cmdlet to create a certificate policy, and then stores it in the $Policy variable. +The second command uses **Add-AzKeyVaultCertificate** to start the process to create a certificate. +The third command uses the Get-AzKeyVaultCertificateOperation cmdlet to poll the operation to verify that it's complete. +The final command uses the Get-AzKeyVaultCertificate cmdlet to get the certificate. + +## PARAMETERS + +### -CertificatePolicy +Specifies a **KeyVaultCertificatePolicy** object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the certificate to add. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CertificateName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultCertificate](./Get-AzKeyVaultCertificate.md) + +[Import-AzKeyVaultCertificate](./Import-AzKeyVaultCertificate.md) + +[Remove-AzKeyVaultCertificate](./Remove-AzKeyVaultCertificate.md) diff --git a/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultCertificateContact.md b/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultCertificateContact.md new file mode 100644 index 0000000000..8fc19293a9 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultCertificateContact.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 2D3021B3-12C5-4797-8BF2-800E3CEAC56C +online version: https://learn.microsoft.com/powershell/module/az.keyvault/add-azkeyvaultcertificatecontact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Add-AzKeyVaultCertificateContact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Add-AzKeyVaultCertificateContact.md +--- + +# Add-AzKeyVaultCertificateContact + +## SYNOPSIS +Adds a contact for certificate notifications. + +## SYNTAX + +### Interactive (Default) +``` +Add-AzKeyVaultCertificateContact [-VaultName] <String> [-EmailAddress] <String[]> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObject +``` +Add-AzKeyVaultCertificateContact [-InputObject] <PSKeyVault> [-EmailAddress] <String[]> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Add-AzKeyVaultCertificateContact [-ResourceId] <String> [-EmailAddress] <String[]> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzKeyVaultCertificateContact** cmdlet adds a contact for a key vault for certificate notifications in Azure Key Vault. +The contact receives updates about events such as certificate close to expiry, certificate renewed, and so on. +These events are determined by the certificate policy. + +## EXAMPLES + +### Example 1: Add a key vault certificate contact +```powershell +Add-AzKeyVaultCertificateContact -VaultName "ContosoKV01" -EmailAddress "patti.fuller@contoso.com" -PassThru +``` + +```output +Email VaultName +----- --------- +patti.fuller@contoso.com ContosoKV01 +``` + +This command adds Patti Fuller as a certificate contact for the ContosoKV01 key vault and returns the list of contacts for the "ContosoKV01" vault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddress +Specifies the email address of the contact. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +KeyVault Resource Id. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateContact + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultCertificateContact](./Get-AzKeyVaultCertificateContact.md) + +[Remove-AzKeyVaultCertificateContact](./Remove-AzKeyVaultCertificateContact.md) + diff --git a/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultKey.md b/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultKey.md new file mode 100644 index 0000000000..e61fadc5ca --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultKey.md @@ -0,0 +1,889 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 846F781C-73A3-4BBE-ABD9-897371109FBE +online version: https://learn.microsoft.com/powershell/module/az.keyvault/add-azkeyvaultkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Add-AzKeyVaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Add-AzKeyVaultKey.md +--- + +# Add-AzKeyVaultKey + +## SYNOPSIS +Creates a key in a key vault or imports a key into a key vault. + +## SYNTAX + +### InteractiveCreate (Default) +``` +Add-AzKeyVaultKey [-VaultName] <String> [-Name] <String> -Destination <String> [-Disable] [-KeyOps <String[]>] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-Size <Int32>] [-KeyType <String>] + [-Exportable] [-Immutable] [-ReleasePolicyPath <String>] [-UseDefaultCVMPolicy] + [-CurveName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InteractiveImport +``` +Add-AzKeyVaultKey [-VaultName] <String> [-Name] <String> -KeyFilePath <String> + [-KeyFilePassword <SecureString>] [-Destination <String>] [-Disable] [-KeyOps <String[]>] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-KeyType <String>] [-CurveName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HsmInteractiveCreate +``` +Add-AzKeyVaultKey -HsmName <String> [-Name] <String> [-Disable] [-KeyOps <String[]>] [-Expires <DateTime>] + [-NotBefore <DateTime>] [-Tag <Hashtable>] [-Size <Int32>] -KeyType <String> [-CurveName <String>] + [-Exportable] [-Immutable] [-ReleasePolicyPath <String>] [-UseDefaultCVMPolicy] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HsmInteractiveImport +``` +Add-AzKeyVaultKey -HsmName <String> [-Name] <String> -KeyFilePath <String> [-KeyFilePassword <SecureString>] + [-Disable] [-KeyOps <String[]>] [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectCreate +``` +Add-AzKeyVaultKey [-InputObject] <PSKeyVault> [-Name] <String> -Destination <String> [-Disable] + [-KeyOps <String[]>] [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-Size <Int32>] + [-Exportable] [-Immutable] [-ReleasePolicyPath <String>] [-UseDefaultCVMPolicy] + [-KeyType <String>] [-CurveName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectImport +``` +Add-AzKeyVaultKey [-InputObject] <PSKeyVault> [-Name] <String> -KeyFilePath <String> + [-KeyFilePassword <SecureString>] [-Destination <String>] [-Disable] [-KeyOps <String[]>] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-KeyType <String>] [-CurveName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HsmInputObjectCreate +``` +Add-AzKeyVaultKey [-HsmObject] <PSManagedHsm> [-Name] <String> [-Disable] [-KeyOps <String[]>] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-Size <Int32>] -KeyType <String> + [-CurveName <String>] [-Exportable] [-Immutable] [-ReleasePolicyPath <String>] [-UseDefaultCVMPolicy] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HsmInputObjectImport +``` +Add-AzKeyVaultKey [-HsmObject] <PSManagedHsm> [-Name] <String> -KeyFilePath <String> + [-KeyFilePassword <SecureString>] [-Disable] [-KeyOps <String[]>] [-Expires <DateTime>] + [-NotBefore <DateTime>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdCreate +``` +Add-AzKeyVaultKey [-ResourceId] <String> [-Name] <String> -Destination <String> [-Disable] [-KeyOps <String[]>] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-Size <Int32>] [-KeyType <String>] + [-Exportable] [-Immutable] [-ReleasePolicyPath <String>] [-UseDefaultCVMPolicy] + [-CurveName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdImport +``` +Add-AzKeyVaultKey [-ResourceId] <String> [-Name] <String> -KeyFilePath <String> + [-KeyFilePassword <SecureString>] [-Destination <String>] [-Disable] [-KeyOps <String[]>] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-KeyType <String>] [-CurveName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HsmResourceIdCreate +``` +Add-AzKeyVaultKey -HsmResourceId <String> [-Name] <String> [-Disable] [-KeyOps <String[]>] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-Size <Int32>] -KeyType <String> + [-CurveName <String>] [-Exportable] [-Immutable] [-ReleasePolicyPath <String>] [-UseDefaultCVMPolicy] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HsmResourceIdImport +``` +Add-AzKeyVaultKey -HsmResourceId <String> [-Name] <String> -KeyFilePath <String> + [-KeyFilePassword <SecureString>] [-Disable] [-KeyOps <String[]>] [-Expires <DateTime>] + [-NotBefore <DateTime>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzKeyVaultKey** cmdlet creates a key in a key vault in Azure Key Vault, or imports a key into a key vault. +Use this cmdlet to add keys by using any of the following methods: +- Create a key in a hardware security module (HSM) in the Key Vault service. +- Create a key in software in the Key Vault service. +- Import a key from your own hardware security module (HSM) to HSMs in the Key Vault service. +- Import a key from a .pfx file on your computer. +- Import a key from a .pfx file on your computer to hardware security modules (HSMs) in the Key Vault service. +For any of these operations, you can provide key attributes or accept default settings. +If you create or import a key that has the same name as an existing key in your key vault, the +original key is updated with the values that you specify for the new key. You can access the +previous values by using the version-specific URI for that version of the key. To learn about key +versions and the URI structure, see [About Keys and Secrets](http://go.microsoft.com/fwlink/?linkid=518560) +in the Key Vault REST API documentation. +Note: To import a key from your own hardware security module, you must first generate a BYOK +package (a file with a .byok file name extension) by using the Azure Key Vault BYOK toolset. For +more information, see +[How to Generate and Transfer HSM-Protected Keys for Azure Key Vault](http://go.microsoft.com/fwlink/?LinkId=522252). +As a best practice, back up your key after it is created or updated, by using the +Backup-AzKeyVaultKey cmdlet. There is no undelete functionality, so if you accidentally delete +your key or delete it and then change your mind, the key is not recoverable unless you have a +backup of it that you can restore. + +## EXAMPLES + +### Example 1: Create a key +```powershell +Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITSoftware' -Destination 'Software' +``` + +```output +Vault/HSM Name : contoso +Name : ITSoftware +Key Type : RSA +Key Size : 2048 +Curve Name : +Version : 67da57e9cadf48a2ad8d366b115843ab +Id : https://contoso.vault.azure.net:443/keys/ITSoftware/67da57e9cadf48a2ad8d366b115843ab +Enabled : True +Expires : +Not Before : +Created : 5/21/2018 11:10:58 PM +Updated : 5/21/2018 11:10:58 PM +Purge Disabled : False +Tags : +``` + +This command creates a software-protected key named ITSoftware in the key vault named Contoso. + +### Example 2: Create an EC key +```powershell +Add-AzKeyVaultKey -VaultName test-kv -Name test-key -Destination Software -KeyType EC +``` + +```output +Vault/HSM Name : test-kv +Name : test-key +Key Type : EC +Key Size : +Curve Name : P-256 +Version : 4da74af2b4fd47d6b1aa0b05c9a2ed13 +Id : https://test-kv.vault.azure.net:443/keys/test-key/4da74af2b4fd47d6b1aa0b05c9a2ed13 +Enabled : True +Expires : +Not Before : +Created : 8/24/2021 6:38:34 AM +Updated : 8/24/2021 6:38:34 AM +Recovery Level : Recoverable+Purgeable +Tags : +``` + +This command creates a software-protected EC key named test-key in the key vault named test-kv. Its curve name is P-256 by default. + +### Example 3: Create an HSM-protected key +```powershell +Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITHsm' -Destination 'HSM' +``` + +```output +Vault Name : contoso +Name : ITHsm +Version : 67da57e9cadf48a2ad8d366b115843ab +Id : https://contoso.vault.azure.net:443/keys/ITSoftware/67da57e9cadf48a2ad8d366b115843ab +Enabled : True +Expires : +Not Before : +Created : 5/21/2018 11:10:58 PM +Updated : 5/21/2018 11:10:58 PM +Purge Disabled : False +Tags : +``` + +This command creates an HSM-protected key in the key vault named Contoso. + +### Example 4: Create a key with non-default values +```powershell +$KeyOperations = 'decrypt', 'verify' +$Expires = (Get-Date).AddYears(2).ToUniversalTime() +$NotBefore = (Get-Date).ToUniversalTime() +$Tags = @{'Severity' = 'high'; 'Accounting' = "true"} +Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITHsmNonDefault' -Destination 'HSM' -Expires $Expires -NotBefore $NotBefore -KeyOps $KeyOperations -Disable -Tag $Tags +``` + +```output +Vault/HSM Name : contoso +Name : ITHsmNonDefault +Key Type : RSA +Key Size : 2048 +Version : 929bfc14db84439b823ffd1bedadaf5f +Id : https://contoso.vault.azure.net:443/keys/ITHsmNonDefault/929bfc14db84439b823ffd1bedadaf5f +Enabled : False +Expires : 5/21/2020 11:12:43 PM +Not Before : 5/21/2018 11:12:50 PM +Created : 5/21/2018 11:13:17 PM +Updated : 5/21/2018 11:13:17 PM +Purge Disabled : False +Tags : Name Value + Severity high + Accounting true +``` + +The first command stores the values decrypt and verify in the $KeyOperations variable. +The second command creates a **DateTime** object, defined in UTC, by using the **Get-Date** cmdlet. +That object specifies a time two years in the future. The command stores that date in the $Expires +variable. For more information, type `Get-Help Get-Date`. +The third command creates a **DateTime** object by using the **Get-Date** cmdlet. That object +specifies current UTC time. The command stores that date in the $NotBefore variable. +The final command creates a key named ITHsmNonDefault that is an HSM-protected key. The command +specifies values for allowed key operations stored $KeyOperations. The command specifies times for +the *Expires* and *NotBefore* parameters created in the previous commands, and tags for high +severity and IT. The new key is disabled. You can enable it by using the **Set-AzKeyVaultKey** +cmdlet. + +### Example 5: Import an HSM-protected key +```powershell +Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITByok' -KeyFilePath 'C:\Contoso\ITByok.byok' -Destination 'HSM' +``` + +```output +Vault Name : contoso +Name : ITByok +Version : 67da57e9cadf48a2ad8d366b115843ab +Id : https://contoso.vault.azure.net:443/keys/ITByok/67da57e9cadf48a2ad8d366b115843ab +Enabled : True +Expires : +Not Before : +Created : 5/21/2018 11:10:58 PM +Updated : 5/21/2018 11:10:58 PM +Purge Disabled : False +Tags : +``` + +This command imports the key named ITByok from the location that the *KeyFilePath* parameter +specifies. The imported key is an HSM-protected key. +To import a key from your own hardware security module, you must first generate a BYOK package (a file with a .byok file name extension) by using the Azure Key Vault BYOK toolset. +For more information, see +[How to Generate and Transfer HSM-Protected Keys for Azure Key Vault](http://go.microsoft.com/fwlink/?LinkId=522252). + +### Example 6: Import a software-protected key +```powershell +$Password = ConvertTo-SecureString -String 'Password' -AsPlainText -Force +Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITPfx' -KeyFilePath 'C:\Contoso\ITPfx.pfx' -KeyFilePassword $Password +``` + +```output +Vault Name : contoso +Name : ITPfx +Version : 67da57e9cadf48a2ad8d366b115843ab +Id : https://contoso.vault.azure.net:443/keys/ITPfx/67da57e9cadf48a2ad8d366b115843ab +Enabled : True +Expires : +Not Before : +Created : 5/21/2018 11:10:58 PM +Updated : 5/21/2018 11:10:58 PM +Purge Disabled : False +Tags : +``` + +The first command converts a string into a secure string by using the **ConvertTo-SecureString** +cmdlet, and then stores that string in the $Password variable. For more information, type `Get-Help +ConvertTo-SecureString`. +The second command creates a software password in the Contoso key vault. The command specifies the +location for the key and the password stored in $Password. + +### Example 7: Import a key and assign attributes +```powershell +$Password = ConvertTo-SecureString -String 'password' -AsPlainText -Force +$Expires = (Get-Date).AddYears(2).ToUniversalTime() +$Tags = @{ 'Severity' = 'high'; 'Accounting' = "true" } +Add-AzKeyVaultKey -VaultName 'contoso' -Name 'ITPfxToHSM' -Destination 'HSM' -KeyFilePath 'C:\Contoso\ITPfx.pfx' -KeyFilePassword $Password -Expires $Expires -Tag $Tags +``` + +```output +Vault Name : contoso +Name : ITPfxToHSM +Version : 929bfc14db84439b823ffd1bedadaf5f +Id : https://contoso.vault.azure.net:443/keys/ITPfxToHSM/929bfc14db84439b823ffd1bedadaf5f +Enabled : True +Expires : 5/21/2020 11:12:43 PM +Not Before : +Created : 5/21/2018 11:13:17 PM +Updated : 5/21/2018 11:13:17 PM +Purge Disabled : False +Tags : Name Value + Severity high + Accounting true +``` + +The first command converts a string into a secure string by using the **ConvertTo-SecureString** +cmdlet, and then stores that string in the $Password variable. +The second command creates a **DateTime** object by using the **Get-Date** cmdlet, and then stores +that object in the $Expires variable. +The third command creates the $tags variable to set tags for high severity and IT. +The final command imports a key as an HSM key from the specified location. The command specifies +the expiration time stored in $Expires and password stored in $Password, and applies the tags +stored in $tags. + +### Example 8: Generate a Key Exchange Key (KEK) for "bring your own key" (BYOK) feature + +```powershell +$key = Add-AzKeyVaultKey -VaultName $vaultName -Name $keyName -Destination HSM -Size 2048 -KeyOps "import" +``` + +Generates a key (referred to as a Key Exchange Key (KEK)). The KEK must be an RSA-HSM key that has only the import key operation. Only Key Vault Premium SKU supports RSA-HSM keys. +For more details please refer to https://learn.microsoft.com/azure/key-vault/keys/hsm-protected-keys + +### Example 9: Create a secure key in managed hsm + +```powershell +<# release_policy_template.json +{ + "anyOf": [ + { + "allOf": [ + { + "claim": "<claim name>", + "equals": "<value to match>" + } + ], + "authority": "<issuer>" + } + ], + "version": "1.0.0" +} +#> +Add-AzKeyVaultKey -HsmName testmhsm -Name test-key -KeyType RSA -Exportable -ReleasePolicyPath release_policy.json +``` + +```output +Vault/HSM Name : testmhsm +Name : test-key +Key Type : RSA +Key Size : 2048 +Curve Name : +Version : ed6b026bf0a605042006635713d33ef6 +Id : https://testmhsm.managedhsm.azure.net:443/keys/test-key/ed6b026bf0a605042006635713d33ef6 +Enabled : True +Expires : +Not Before : +Created : 6/2/2022 7:14:37 AM +Updated : 6/2/2022 7:14:37 AM +Recovery Level : Recoverable+Purgeable +Release Policy : + Content Type : application/json; charset=utf-8 + Policy Content : {"anyOf":[{"allOf":[{"claim":"x-ms-sgx-is-debuggable","equals":"true"}],"authority":"htt + ps://sharedeus.eus.attest.azure.net/"}],"version":"1.0.0"} + Immutable : False + + +Tags : +``` + +Create a secure key in managed hsm named testmhsm. Its name is test-key and type is RSA. + +### Example 10: Add a key for a Confidential VM to a key vault. +```powershell +New-AzKeyVault -Name $keyVaultName -Location $location -ResourceGroupName $resourceGroupName -Sku Premium -EnablePurgeProtection -EnabledForDiskEncryption; +$cvmAgent = Get-AzADServicePrincipal -ApplicationId 'bf7b6499-ff71-4aa2-97a4-f372087be7f0'; +Set-AzKeyVaultAccessPolicy -VaultName $keyVaultName -ResourceGroupName $resourceGroupName -ObjectId $cvmAgent.id -PermissionsToKeys get,release; + +$keySize = 3072; +Add-AzKeyVaultKey -VaultName $keyVaultName -Name $keyName -Size $keySize -KeyOps wrapKey,unwrapKey -KeyType RSA -Destination HSM -Exportable -UseDefaultCVMPolicy; + +``` + +```output +Vault/HSM Name : <Vault Name> +Name : <Key Name> +Key Type : RSA +Key Size : 3072 +Curve Name : +Version : <Version> +Id : <Id> +Enabled : True +Expires : +Not Before : +Created : 9/9/2022 8:36:00 PM +Updated : 9/9/2022 8:36:00 PM +Recovery Level : Recoverable +Release Policy : + Content Type : application/json; charset=utf-8 + Policy Content : <Policy Content> + Immutable : False +Tags : + +``` + +## PARAMETERS + +### -CurveName +Specifies the curve name of elliptic curve cryptography, this value is valid when KeyType is EC. + +```yaml +Type: System.String +Parameter Sets: InteractiveCreate, InteractiveImport, HsmInteractiveCreate, InputObjectCreate, InputObjectImport, HsmInputObjectCreate, ResourceIdCreate, ResourceIdImport, HsmResourceIdCreate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +Specifies whether to add the key as a software-protected key or an HSM-protected key in the Key Vault service. +Valid values are: HSM and Software. +Note: To use HSM as your destination, you must have a key vault that supports HSMs. For more +information about the service tiers and capabilities for Azure Key Vault, see the +[Azure Key Vault Pricing website](http://go.microsoft.com/fwlink/?linkid=512521). +This parameter is required when you create a new key. If you import a key by using the +*KeyFilePath* parameter, this parameter is optional: +- If you do not specify this parameter, and this cmdlet imports a key that has .byok file name +extension, it imports that key as an HSM-protected key. The cmdlet cannot import that key as +software-protected key. +- If you do not specify this parameter, and this cmdlet imports a key that has a .pfx file name +extension, it imports the key as a software-protected key. + +```yaml +Type: System.String +Parameter Sets: InteractiveCreate, InputObjectCreate, ResourceIdCreate +Aliases: +Accepted values: HSM, Software + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: InteractiveImport, InputObjectImport, ResourceIdImport +Aliases: +Accepted values: HSM, Software + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disable +Indicates that the key you are adding is set to an initial state of disabled. Any attempt to use +the key will fail. Use this parameter if you are preloading keys that you intend to enable later. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expires +Specifies the expiration time, as a **DateTime** object, for the key that this cmdlet adds. This +parameter uses Coordinated Universal Time (UTC). To obtain a **DateTime** object, use the +**Get-Date** cmdlet. For more information, type `Get-Help Get-Date`. If you do not specify this +parameter, the key does not expire. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exportable +Indicates if the private key can be exported. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: InteractiveCreate, InputObjectCreate, ResourceIdCreate, HsmInteractiveCreate, HsmInputObjectCreate, HsmResourceIdCreate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +HSM name. Cmdlet constructs the FQDN of a managed HSM based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: HsmInteractiveCreate, HsmInteractiveImport +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmObject +HSM object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm +Parameter Sets: HsmInputObjectCreate, HsmInputObjectImport +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -HsmResourceId +Resource ID of the HSM. + +```yaml +Type: System.String +Parameter Sets: HsmResourceIdCreate, HsmResourceIdImport +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Immutable +Sets the release policy as immutable state. Once marked immutable, this flag cannot be reset and the policy cannot be changed under any circumstances. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: InteractiveCreate, InputObjectCreate, ResourceIdCreate, HsmInteractiveCreate, HsmInputObjectCreate, HsmResourceIdCreate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Vault object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: InputObjectCreate, InputObjectImport +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyFilePassword +Specifies a password for the imported file as a **SecureString** object. To obtain a +**SecureString** object, use the **ConvertTo-SecureString** cmdlet. For more information, type +`Get-Help ConvertTo-SecureString`. You must specify this password to import a file with a .pfx file +name extension. + +```yaml +Type: System.Security.SecureString +Parameter Sets: InteractiveImport, HsmInteractiveImport, InputObjectImport, HsmInputObjectImport, ResourceIdImport, HsmResourceIdImport +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyFilePath +Specifies the path of a local file that contains key material that this cmdlet imports. +The valid file name extensions are .byok and .pfx. +- If the file is a .byok file, the key is automatically protected by HSMs after the import and you +cannot override this default. +- If the file is a .pfx file, the key is automatically protected by software after the import. To +override this default, set the *Destination* parameter to HSM so that the key is HSM-protected. +When you specify this parameter, the *Destination* parameter is optional. + +```yaml +Type: System.String +Parameter Sets: InteractiveImport, HsmInteractiveImport, InputObjectImport, HsmInputObjectImport, ResourceIdImport, HsmResourceIdImport +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyOps +Specifies an array of operations that can be performed by using the key that this cmdlet adds. +If you do not specify this parameter, all operations can be performed. +The acceptable values for this parameter are a comma-separated list of key operations as defined by +the [JSON Web Key (JWK) specification](http://go.microsoft.com/fwlink/?LinkID=613300): +- encrypt +- decrypt +- wrapKey +- unwrapKey +- sign +- verify +- import (for KEK only, see example 7) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyType +Specifies the key type of this key. When importing BYOK keys, it defaults to 'RSA'. + +```yaml +Type: System.String +Parameter Sets: InteractiveCreate, InteractiveImport, InputObjectCreate, InputObjectImport, ResourceIdCreate, ResourceIdImport +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: HsmInteractiveCreate, HsmInputObjectCreate, HsmResourceIdCreate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the key to add to the key vault. This cmdlet constructs the fully qualified +domain name (FQDN) of a key based on the name that this parameter specifies, the name of the key +vault, and your current environment. The name must be a string of 1 through 63 characters in length +that contains only 0-9, a-z, A-Z, and - (the dash symbol). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: KeyName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotBefore +Specifies the time, as a **DateTime** object, before which the key cannot be used. This parameter +uses UTC. To obtain a **DateTime** object, use the **Get-Date** cmdlet. If you do not specify this +parameter, the key can be used immediately. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReleasePolicyPath +A path to a file containing JSON policy definition. The policy rules under which a key can be exported. + +```yaml +Type: System.String +Parameter Sets: InteractiveCreate, InputObjectCreate, ResourceIdCreate, HsmInteractiveCreate, HsmInputObjectCreate, HsmResourceIdCreate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Vault Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdCreate, ResourceIdImport +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Size +RSA key size, in bits. If not specified, the service will provide a safe default. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: InteractiveCreate, HsmInteractiveCreate, InputObjectCreate, HsmInputObjectCreate, ResourceIdCreate, HsmResourceIdCreate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDefaultCVMPolicy +Specifies to use default policy under which the key can be exported for CVM disk encryption. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: InteractiveCreate, InputObjectCreate, ResourceIdCreate, HsmInteractiveCreate, HsmInputObjectCreate, HsmResourceIdCreate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault to which this cmdlet adds the key. This cmdlet constructs the +FQDN of a key vault based on the name that this parameter specifies and your current environment. + +```yaml +Type: System.String +Parameter Sets: InteractiveCreate, InteractiveImport +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey + +## NOTES + +## RELATED LINKS + +[Backup-AzKeyVaultKey](./Backup-AzKeyVaultKey.md) + +[Get-AzKeyVaultKey](./Get-AzKeyVaultKey.md) + +[Remove-AzKeyVaultKey](./Remove-AzKeyVaultKey.md) diff --git a/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultManagedStorageAccount.md b/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultManagedStorageAccount.md new file mode 100644 index 0000000000..de116ce70e --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultManagedStorageAccount.md @@ -0,0 +1,281 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/add-azkeyvaultmanagedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Add-AzKeyVaultManagedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Add-AzKeyVaultManagedStorageAccount.md +--- + +# Add-AzKeyVaultManagedStorageAccount + +## SYNOPSIS +Adds an existing Azure Storage Account to the specified key vault for its keys to be managed by the Key Vault service. + +## SYNTAX + +``` +Add-AzKeyVaultManagedStorageAccount [-VaultName] <String> [-AccountName] <String> [-AccountResourceId] <String> + [-ActiveKeyName] <String> [-DisableAutoRegenerateKey] [-RegenerationPeriod <TimeSpan>] [-Disable] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets up an existing Azure Storage Account with Key Vault for Storage Account keys to be managed by +Key Vault. The Storage Account must already exist. The Storage Keys are never exposed to caller. +Key Vault auto regenerates and switches the active key based on the regeneration period. See [Azure Key Vault managed storage account - PowerShell](https://learn.microsoft.com/azure/key-vault/key-vault-overview-storage-keys-powershell) for an overview of this feature. + +## EXAMPLES + +### Example 1: Set an Azure Storage Account with Key Vault to manage its keys +```powershell +$storage = Get-AzStorageAccount -ResourceGroupName "mystorageResourceGroup" -StorageAccountName "mystorage" +$servicePrincipal = Get-AzADServicePrincipal -ServicePrincipalName cfa8b339-82a2-471a-a3c9-0fc0be7a4093 +New-AzRoleAssignment -ObjectId $servicePrincipal.Id -RoleDefinitionName 'Storage Account Key Operator Service Role' -Scope $storage.Id +$userPrincipalId = $(Get-AzADUser -SearchString "developer@contoso.com").Id +Set-AzKeyVaultAccessPolicy -VaultName $keyVaultName -ObjectId $userPrincipalId -PermissionsToStorage get, set +$regenerationPeriod = [System.Timespan]::FromDays(90) +Add-AzKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -AccountResourceId '/subscriptions/<subscription id>/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount' -ActiveKeyName 'key1' -RegenerationPeriod $regenerationPeriod +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount +Vault Name : myvault +AccountName : mystorageaccount +Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St + orage/storageAccounts/mystorageaccount +Active Key Name : key1 +Auto Regenerate Key : True +Regeneration Period : 90.00:00:00 +Enabled : True +Created : 5/21/2018 11:55:58 PM +Updated : 5/21/2018 11:55:58 PM +Tags : +``` + +Sets a Storage Account with Key Vault for its keys to be managed by Key Vault. The active key set +is 'key1'. This key will be used to generate sas tokens. Key Vault will regenerate 'key2' key after +the regeneration period from the time of this command and set it as the active key. This auto +regeneration process will continue between 'key1' and 'key2' with a gap of 90 days. + +### Example 2: Set a Classic Azure Storage Account with Key Vault to manage its keys +```powershell +$regenerationPeriod = [System.Timespan]::FromDays(90) +Add-AzKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -AccountResourceId '/subscriptions/<subscription id>/resourceGroups/myresourcegroup/providers/Microsoft.ClassicStorage/storageAccounts/mystorageaccount' -ActiveKeyName 'Primary' -RegenerationPeriod $regenerationPeriod +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount +Vault Name : myvault +AccountName : mystorageaccount +Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myvault/providers/Microsoft.Cl + assicStorage/storageAccounts/mystorageaccount +Active Key Name : Primary +Auto Regenerate Key : True +Regeneration Period : 90.00:00:00 +Enabled : True +Created : 5/21/2018 11:55:58 PM +Updated : 5/21/2018 11:55:58 PM +Tags : +``` + +Sets a Classic Storage Account with Key Vault for its keys to be managed by Key Vault. The active +key set is 'Primary'. This key will be used to generate sas tokens. Key Vault will regenerate +'Secondary' key after the regeneration period from the time of this command and set it as the +active key. This auto regeneration process will continue between 'Primary' and 'Secondary' with a +gap of 90 days. + +## PARAMETERS + +### -AccountName +Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account +name from vault name, currently selected environment and manged storage account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AccountResourceId +Azure resource id of the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountResourceId + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ActiveKeyName +Name of the storage account key that must be used for generating sas tokens. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disable +Disables the use of managed storage account's key for generation of sas tokens. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAutoRegenerateKey +Auto regenerate key. If true, then the managed storage account's inactive key gets auto regenerated +and becomes the new active key after the regeneration period. If false, then the keys of managed +storage account are not auto regenerated. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegenerationPeriod +Regeneration period. If auto regenerate key is enabled, this value specifies the timespan after +which managed storage account's inactive keygets auto regenerated and becomes the new active key. + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.TimeSpan, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccount + +## NOTES + +## RELATED LINKS + +[Az.KeyVault](/powershell/module/az.keyvault) diff --git a/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultNetworkRule.md b/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultNetworkRule.md new file mode 100644 index 0000000000..ec0e33daca --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Add-AzKeyVaultNetworkRule.md @@ -0,0 +1,281 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/add-azkeyvaultnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Add-AzKeyVaultNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Add-AzKeyVaultNetworkRule.md +--- + +# Add-AzKeyVaultNetworkRule + +## SYNOPSIS +Adds a rule meant to restrict access to a key vault based on the client's internet address. + +## SYNTAX + +### ByVaultName (Default) +``` +Add-AzKeyVaultNetworkRule [-VaultName] <String> [[-ResourceGroupName] <String>] [-IpAddressRange <String[]>] + [-VirtualNetworkResourceId <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ByInputObject +``` +Add-AzKeyVaultNetworkRule [-InputObject] <PSKeyVault> [-IpAddressRange <String[]>] + [-VirtualNetworkResourceId <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ByResourceId +``` +Add-AzKeyVaultNetworkRule [-ResourceId] <String> [-IpAddressRange <String[]>] + [-VirtualNetworkResourceId <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzKeyVaultNetworkRule** cmdlet grants or restricts access to a key vault to a set of caller designated by their IP addresses or the virtual network to which they belong. The rule has the potential to restrict access for other users, applications, or security groups which have been granted permissions via the access policy. + +Please note that any IP range inside `10.0.0.0-10.255.255.255` (private IP addresses) cannot be used to add network rules. + +## EXAMPLES + +### Example 1 +```powershell +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -ServiceEndpoint Microsoft.KeyVault +$virtualNetwork = New-AzVirtualNetwork -Name myVNet -ResourceGroupName myRG -Location westus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet +$myNetworkResId = (Get-AzVirtualNetwork -Name myVNet -ResourceGroupName myRG).Subnets[0].Id +Add-AzKeyVaultNetworkRule -VaultName myvault -IpAddressRange "124.56.78.0/24" -VirtualNetworkResourceId $myNetworkResId -PassThru +``` + +```output +Vault Name : myvault +Resource Group Name : myRG +Location : westus +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myRG/providers + /Microsoft.KeyVault/vaults/myvault +Vault URI : https://myvault.vault.azure.net/ +Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +SKU : Standard +Enabled For Deployment? : True +Enabled For Template Deployment? : True +Enabled For Disk Encryption? : False +Soft Delete Enabled? : True +Access Policies : + Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Application ID : + Display Name : User Name (username@microsoft.com) + Permissions to Keys : get, create, delete, list, update, + import, backup, restore, recover + Permissions to Secrets : get, list, set, delete, backup, + restore, recover + Permissions to Certificates : get, delete, list, create, import, + update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers, + setissuers, recover + Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list, + listsas, regeneratekey, set, setsas, update + + +Network Rule Set : + Default Action : Allow + Bypass : AzureServices + IP Rules : 124.56.78.0/24 + Virtual Network Rules : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx- + xxxxxxxxxxxxx/resourcegroups/myRG/providers/microsoft.network/virtualnetworks/myvn + et/subnets/frontendsubnet + +Tags : +``` + +This command adds a network rule to the specified vault, allowing access to the specified IP address from the virtual network identified by $myNetworkResId. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IpAddressRange +Specifies allowed network IP address range of network rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns the updated key vault object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group associated with the key vault whose network rule is being modified. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +KeyVault Resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault whose network rule is being modified. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkResourceId +Specifies allowed virtual network resource identifier of network rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Az.KeyVault.md b/azps-10.1.0/Az.KeyVault/Az.KeyVault.md new file mode 100644 index 0000000000..4985838bb4 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Az.KeyVault.md @@ -0,0 +1,240 @@ +--- +Module Name: Az.KeyVault +Module Guid: D48CF693-4125-4D2D-8790-1514F44CE325 +Download Help Link: https://learn.microsoft.com/powershell/module/az.keyvault +Help Version: 4.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Az.KeyVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Az.KeyVault.md +--- + +# Az.KeyVault Module +## Description +This topic displays help topics for the Azure Key Vault Cmdlets. + +## Az.KeyVault Cmdlets +### [Add-AzKeyVaultCertificate](Add-AzKeyVaultCertificate.md) +Adds a certificate to a key vault. + +### [Add-AzKeyVaultCertificateContact](Add-AzKeyVaultCertificateContact.md) +Adds a contact for certificate notifications. + +### [Add-AzKeyVaultKey](Add-AzKeyVaultKey.md) +Creates a key in a key vault or imports a key into a key vault. + +### [Add-AzKeyVaultManagedStorageAccount](Add-AzKeyVaultManagedStorageAccount.md) +Adds an existing Azure Storage Account to the specified key vault for its keys to be managed by the Key Vault service. + +### [Add-AzKeyVaultNetworkRule](Add-AzKeyVaultNetworkRule.md) +Adds a rule meant to restrict access to a key vault based on the client's internet address. + +### [Backup-AzKeyVault](Backup-AzKeyVault.md) +Fully backup a managed HSM. + +### [Backup-AzKeyVaultCertificate](Backup-AzKeyVaultCertificate.md) +Backs up a certificate in a key vault. + +### [Backup-AzKeyVaultKey](Backup-AzKeyVaultKey.md) +Backs up a key in a key vault. + +### [Backup-AzKeyVaultManagedStorageAccount](Backup-AzKeyVaultManagedStorageAccount.md) +Backs up a KeyVault-managed storage account. + +### [Backup-AzKeyVaultSecret](Backup-AzKeyVaultSecret.md) +Backs up a secret in a key vault. + +### [Export-AzKeyVaultSecurityDomain](Export-AzKeyVaultSecurityDomain.md) +Exports the security domain data of a managed HSM. + +### [Get-AzKeyVault](Get-AzKeyVault.md) +Gets key vaults. + +### [Get-AzKeyVaultCertificate](Get-AzKeyVaultCertificate.md) +Gets a certificate from a key vault. + +### [Get-AzKeyVaultCertificateContact](Get-AzKeyVaultCertificateContact.md) +Gets contacts that are registered for certificate notifications for a key vault. + +### [Get-AzKeyVaultCertificateIssuer](Get-AzKeyVaultCertificateIssuer.md) +Gets a certificate issuer for a key vault. + +### [Get-AzKeyVaultCertificateOperation](Get-AzKeyVaultCertificateOperation.md) +Gets the status of a certificate operation. + +### [Get-AzKeyVaultCertificatePolicy](Get-AzKeyVaultCertificatePolicy.md) +Gets the policy for a certificate in a key vault. + +### [Get-AzKeyVaultKey](Get-AzKeyVaultKey.md) +Gets Key Vault keys. Please notes that detailed information about a key, like key type or key size, only available when querying a specific key version. + +### [Get-AzKeyVaultManagedHsm](Get-AzKeyVaultManagedHsm.md) +Get managed HSMs. + +### [Get-AzKeyVaultManagedStorageAccount](Get-AzKeyVaultManagedStorageAccount.md) +Gets Key Vault managed Azure Storage Accounts. + +### [Get-AzKeyVaultManagedStorageSasDefinition](Get-AzKeyVaultManagedStorageSasDefinition.md) +Gets Key Vault managed Storage SAS Definitions. + +### [Get-AzKeyVaultRoleAssignment](Get-AzKeyVaultRoleAssignment.md) +Get or list role assignments of a managed HSM. Use respective parameters to list assignments to a specific user or a role definition. + +### [Get-AzKeyVaultRoleDefinition](Get-AzKeyVaultRoleDefinition.md) +List role definitions of a given managed HSM at a given scope. + +### [Get-AzKeyVaultSecret](Get-AzKeyVaultSecret.md) +Gets the secrets in a key vault. + +### [Import-AzKeyVaultCertificate](Import-AzKeyVaultCertificate.md) +Imports a certificate to a key vault. + +### [Import-AzKeyVaultSecurityDomain](Import-AzKeyVaultSecurityDomain.md) +Imports previously exported security domain data to a managed HSM. + +### [Invoke-AzKeyVaultKeyOperation](Invoke-AzKeyVaultKeyOperation.md) +Performs operation like "Encrypt", "Decrypt", "Wrap" or "Unwrap" using a specified key stored in a key vault or managed hsm. + +### [New-AzKeyVault](New-AzKeyVault.md) +Creates a key vault. + +### [New-AzKeyVaultCertificateAdministratorDetail](New-AzKeyVaultCertificateAdministratorDetail.md) +Creates an in-memory certificate administrator details object. + +### [New-AzKeyVaultCertificateOrganizationDetail](New-AzKeyVaultCertificateOrganizationDetail.md) +Creates an in-memory certificate organization details object. + +### [New-AzKeyVaultCertificatePolicy](New-AzKeyVaultCertificatePolicy.md) +Creates an in-memory certificate policy object. + +### [New-AzKeyVaultManagedHsm](New-AzKeyVaultManagedHsm.md) +Creates a managed HSM. + +### [New-AzKeyVaultNetworkRuleSetObject](New-AzKeyVaultNetworkRuleSetObject.md) +Create an object representing the network rule settings. + +### [New-AzKeyVaultRoleAssignment](New-AzKeyVaultRoleAssignment.md) +Assigns the specified RBAC role to the specified principal, at the specified scope. + +### [New-AzKeyVaultRoleDefinition](New-AzKeyVaultRoleDefinition.md) +Creates a custom role definition on an HSM. + +### [Remove-AzKeyVault](Remove-AzKeyVault.md) +Deletes a key vault. + +### [Remove-AzKeyVaultAccessPolicy](Remove-AzKeyVaultAccessPolicy.md) +Removes all permissions for a user or application from a key vault. + +### [Remove-AzKeyVaultCertificate](Remove-AzKeyVaultCertificate.md) +Removes a certificate from a key vault. + +### [Remove-AzKeyVaultCertificateContact](Remove-AzKeyVaultCertificateContact.md) +Deletes a contact that is registered for certificate notifications from a key vault. + +### [Remove-AzKeyVaultCertificateIssuer](Remove-AzKeyVaultCertificateIssuer.md) +Deletes a certificate issuer from a key vault. + +### [Remove-AzKeyVaultCertificateOperation](Remove-AzKeyVaultCertificateOperation.md) +Deletes a certificate operation from a key vault. + +### [Remove-AzKeyVaultKey](Remove-AzKeyVaultKey.md) +Deletes a key in a key vault. + +### [Remove-AzKeyVaultManagedHsm](Remove-AzKeyVaultManagedHsm.md) +Deletes a managed HSM. + +### [Remove-AzKeyVaultManagedStorageAccount](Remove-AzKeyVaultManagedStorageAccount.md) +Removes a Key Vault managed Azure Storage Account and all associated SAS definitions. + +### [Remove-AzKeyVaultManagedStorageSasDefinition](Remove-AzKeyVaultManagedStorageSasDefinition.md) +Removes a Key Vault managed Azure Storage SAS definitions. + +### [Remove-AzKeyVaultNetworkRule](Remove-AzKeyVaultNetworkRule.md) +Removes a network rule from a key vault. + +### [Remove-AzKeyVaultRoleAssignment](Remove-AzKeyVaultRoleAssignment.md) +Removes a role assignment to the specified principal who is assigned to a particular role at a particular scope. + +### [Remove-AzKeyVaultRoleDefinition](Remove-AzKeyVaultRoleDefinition.md) +Removes a custom role definition from an HSM. + +### [Remove-AzKeyVaultSecret](Remove-AzKeyVaultSecret.md) +Deletes a secret in a key vault. + +### [Restore-AzKeyVault](Restore-AzKeyVault.md) +Fully restores a managed HSM from backup. + +### [Restore-AzKeyVaultCertificate](Restore-AzKeyVaultCertificate.md) +Restores a certificate in a key vault from a backup file. + +### [Restore-AzKeyVaultKey](Restore-AzKeyVaultKey.md) +Creates a key in a key vault from a backed-up key. + +### [Restore-AzKeyVaultManagedStorageAccount](Restore-AzKeyVaultManagedStorageAccount.md) +Restores a managed storage account in a key vault from a backup file. + +### [Restore-AzKeyVaultSecret](Restore-AzKeyVaultSecret.md) +Creates a secret in a key vault from a backed-up secret. + +### [Set-AzKeyVaultAccessPolicy](Set-AzKeyVaultAccessPolicy.md) +Grants or modifies existing permissions for a user, application, or security group to perform operations with a key vault. + +### [Set-AzKeyVaultCertificateIssuer](Set-AzKeyVaultCertificateIssuer.md) +Sets a certificate issuer in a key vault. + +### [Set-AzKeyVaultCertificatePolicy](Set-AzKeyVaultCertificatePolicy.md) +Creates or updates the policy for a certificate in a key vault. + +### [Set-AzKeyVaultManagedStorageSasDefinition](Set-AzKeyVaultManagedStorageSasDefinition.md) +Sets a Shared Access Signature (SAS) definition with Key Vault for a given Key Vault managed Azure Storage Account. + +### [Set-AzKeyVaultSecret](Set-AzKeyVaultSecret.md) +Creates or updates a secret in a key vault. + +### [Stop-AzKeyVaultCertificateOperation](Stop-AzKeyVaultCertificateOperation.md) +Cancels a certificate operation in key vault. + +### [Undo-AzKeyVaultCertificateRemoval](Undo-AzKeyVaultCertificateRemoval.md) +Recovers a deleted certificate in a key vault into an active state. + +### [Undo-AzKeyVaultKeyRemoval](Undo-AzKeyVaultKeyRemoval.md) +Recovers a deleted key in a key vault into an active state. + +### [Undo-AzKeyVaultManagedStorageAccountRemoval](Undo-AzKeyVaultManagedStorageAccountRemoval.md) +Recovers a previously deleted KeyVault-managed storage account. + +### [Undo-AzKeyVaultManagedStorageSasDefinitionRemoval](Undo-AzKeyVaultManagedStorageSasDefinitionRemoval.md) +Recovers a previously deleted KeyVault-managed storage SAS definition. + +### [Undo-AzKeyVaultRemoval](Undo-AzKeyVaultRemoval.md) +Recovers a deleted key vault into an active state. + +### [Undo-AzKeyVaultManagedHsmRemoval](./Undo-AzKeyVaultManagedHsmRemoval.md) +Recovers a deleted HSM into an active state. + +### [Undo-AzKeyVaultSecretRemoval](Undo-AzKeyVaultSecretRemoval.md) +Recovers a deleted secret in a key vault into an active state. + +### [Update-AzKeyVault](Update-AzKeyVault.md) +Update the state of an Azure key vault. + +### [Update-AzKeyVaultCertificate](Update-AzKeyVaultCertificate.md) +Modifies editable attributes of a certificate. + +### [Update-AzKeyVaultKey](Update-AzKeyVaultKey.md) +Updates the attributes of a key in a key vault. + +### [Update-AzKeyVaultManagedHsm](Update-AzKeyVaultManagedHsm.md) +Update the state of an Azure managed HSM. + +### [Update-AzKeyVaultManagedStorageAccount](Update-AzKeyVaultManagedStorageAccount.md) +Update editable attributes of a Key Vault managed Azure Storage Account. + +### [Update-AzKeyVaultManagedStorageAccountKey](Update-AzKeyVaultManagedStorageAccountKey.md) +Regenerates the specified key of Key Vault managed Azure Storage Account. + +### [Update-AzKeyVaultNetworkRuleSet](Update-AzKeyVaultNetworkRuleSet.md) +Updates the network rule set on a key vault. + +### [Update-AzKeyVaultSecret](Update-AzKeyVaultSecret.md) +Updates attributes of a secret in a key vault. + diff --git a/azps-10.1.0/Az.KeyVault/Backup-AzKeyVault.md b/azps-10.1.0/Az.KeyVault/Backup-AzKeyVault.md new file mode 100644 index 0000000000..24eb17a37d --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Backup-AzKeyVault.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/backup-azkeyvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Backup-AzKeyVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Backup-AzKeyVault.md +--- + +# Backup-AzKeyVault + +## SYNOPSIS +Fully backup a managed HSM. + +## SYNTAX + +### InteractiveStorageName (Default) +``` +Backup-AzKeyVault [-HsmName] <String> -StorageAccountName <String> -StorageContainerName <String> + -SasToken <SecureString> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InteractiveStorageUri +``` +Backup-AzKeyVault [-HsmName] <String> -StorageContainerUri <Uri> -SasToken <SecureString> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectStorageUri +``` +Backup-AzKeyVault -StorageContainerUri <Uri> -SasToken <SecureString> -HsmObject <PSManagedHsm> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectStorageName +``` +Backup-AzKeyVault -StorageAccountName <String> -StorageContainerName <String> -SasToken <SecureString> + -HsmObject <PSManagedHsm> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Fully backup a managed HSM to a storage account. +Use `Restore-AzKeyVault` to restore the backup. + +## EXAMPLES + +### Example 1 +```powershell +$sasToken = ConvertTo-SecureString -AsPlainText -Force "?sv=2019-12-12&ss=bfqt&srt=sco&sp=rwdlacupx&se=2020-10-12T14:42:19Z&st=2020-10-12T06:42:19Z&spr=https&sig=******" + +Backup-AzKeyVault -HsmName myHsm -StorageContainerUri "https://{accountName}.blob.core.windows.net/{containerName}" -SasToken $sasToken +``` + +```output +https://{accountName}.blob.core.windows.net/{containerName}/{backupFolder} +``` + +The cmdlet will create a folder (typically named `mhsm-{name}-{timestamp}`) in the storage container, store the backup in that folder and output the folder URI. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +Name of the HSM. + +```yaml +Type: System.String +Parameter Sets: InteractiveStorageName, InteractiveStorageUri +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmObject +Managed HSM object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm +Parameter Sets: InputObjectStorageUri, InputObjectStorageName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SasToken +The shared access signature (SAS) token to authenticate the storage account. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +Name of the storage account where the backup is going to be stored. + +```yaml +Type: System.String +Parameter Sets: InteractiveStorageName, InputObjectStorageName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerName +Name of the blob container where the backup is going to be stored. + +```yaml +Type: System.String +Parameter Sets: InteractiveStorageName, InputObjectStorageName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerUri +URI of the storage container where the backup is going to be stored. + +```yaml +Type: System.Uri +Parameter Sets: InteractiveStorageUri, InputObjectStorageUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Backup-AzKeyVaultCertificate.md b/azps-10.1.0/Az.KeyVault/Backup-AzKeyVaultCertificate.md new file mode 100644 index 0000000000..4928f52e3b --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Backup-AzKeyVaultCertificate.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/backup-azkeyvaultcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Backup-AzKeyVaultCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Backup-AzKeyVaultCertificate.md +--- + +# Backup-AzKeyVaultCertificate + +## SYNOPSIS +Backs up a certificate in a key vault. + +## SYNTAX + +### ByCertificateName (Default) +``` +Backup-AzKeyVaultCertificate [-VaultName] <String> [-Name] <String> [[-OutputFile] <String>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByCertificate +``` +Backup-AzKeyVaultCertificate [-InputObject] <PSKeyVaultCertificateIdentityItem> [[-OutputFile] <String>] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Backup-AzKeyVaultCertificate** cmdlet backs up a specified certificate in a key vault by downloading it and storing it in a file. +If the certificate has multiple versions, all its versions will be included in the backup. +Because the downloaded content is encrypted, it cannot be used outside of Azure Key Vault. +You can restore a backed-up certificate to any key vault in the subscription that it was backed up from, as long as the vault is in the same Azure geography. +Typical reasons to use this cmdlet are: +- You want to retain an offline copy of the certificate in case you accidentally delete the original from the vault. + +- You created a certificate using Key Vault and now want to clone the object into a different Azure region, so that you can use it from all instances of your distributed application. +Use the **Backup-AzKeyVaultCertificate** cmdlet to retrieve the certificate in encrypted format and then use the **Restore-AzKeyVaultCertificate** cmdlet +and specify a key vault in the second region. + +## EXAMPLES + +### Example 1: Back up a certificate with an automatically generated file name +```powershell +Backup-AzKeyVaultCertificate -VaultName 'mykeyvault' -Name 'mycert' +``` + +```output +C:\Users\username\mykeyvault-mycert-1527029447.01191 +``` + +This command retrieves the certificate named MyCert from the key vault named MyKeyVault and saves a backup of that certificate to a file that is automatically named for you, and displays the file name. + +### Example 2: Back up a certificate to a specified file name +```powershell +Backup-AzKeyVaultCertificate -VaultName 'MyKeyVault' -Name 'MyCert' -OutputFile 'C:\Backup.blob' +``` + +```output +C:\Backup.blob +``` + +This command retrieves the certificate named MyCert from the key vault named MyKeyVault and saves a backup of that certificate to a file named Backup.blob. + +### Example 3: Back up a previously retrieved certificate to a specified file name, overwriting the destination file without prompting. +```powershell +$cert = Get-AzKeyVaultCertificate -VaultName 'MyKeyVault' -Name 'MyCert' +Backup-AzKeyVaultCertificate -Certificate $cert -OutputFile 'C:\Backup.blob' -Force +``` + +```output +C:\Backup.blob +``` + +This command creates a backup of the certificate named $cert.Name in the vault named $cert.VaultName to a file named Backup.blob, silently overwriting the file if it exists already. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrite the given file if it exists + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Secret to be backed up, pipelined in from the output of a retrieval call. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem +Parameter Sets: ByCertificate +Aliases: Certificate + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Secret name. +Cmdlet constructs the FQDN of a secret from vault name, currently selected environment and secret name. + +```yaml +Type: System.String +Parameter Sets: ByCertificateName +Aliases: SecretName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFile +Output file. +The output file to store the backup of the certificate. +If not specified, a default filename will be generated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: ByCertificateName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Backup-AzKeyVaultKey.md b/azps-10.1.0/Az.KeyVault/Backup-AzKeyVaultKey.md new file mode 100644 index 0000000000..c57f7b2333 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Backup-AzKeyVaultKey.md @@ -0,0 +1,245 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: A82392AA-B12B-443E-8704-7CF5A9F8ED58 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/backup-azkeyvaultkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Backup-AzKeyVaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Backup-AzKeyVaultKey.md +--- + +# Backup-AzKeyVaultKey + +## SYNOPSIS +Backs up a key in a key vault. + +## SYNTAX + +### ByKeyName (Default) +``` +Backup-AzKeyVaultKey [-VaultName] <String> [-Name] <String> [[-OutputFile] <String>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HsmByKeyName +``` +Backup-AzKeyVaultKey -HsmName <String> [-Name] <String> [[-OutputFile] <String>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByKey +``` +Backup-AzKeyVaultKey [-InputObject] <PSKeyVaultKeyIdentityItem> [[-OutputFile] <String>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Backup-AzKeyVaultKey** cmdlet backs up a specified key in a key vault by downloading it and storing it in a file. +If there are multiple versions of the key, all versions are included in the backup. +Because the downloaded content is encrypted, it cannot be used outside of Azure Key Vault. +You can restore a backed-up key to any key vault in the subscription that it was backed up from. +Typical reasons to use this cmdlet are: +- You want to escrow a copy of your key, so that you have an offline copy in case you accidentally delete your key in your key vault. + +- You created a key using Key Vault and now want to clone the key into a different Azure region, so that you can use it from all instances of your distributed application. +Use the **Backup-AzKeyVaultKey** cmdlet to retrieve the key in encrypted format and then use the Restore-AzKeyVaultKey cmdlet and specify a key vault in the second region. + +## EXAMPLES + +### Example 1: Back up a key with an automatically generated file name +```powershell +Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' +``` + +```output +C:\Users\username\mykeyvault-mykey-1527029447.01191 +``` + +This command retrieves the key named MyKey from the key vault named MyKeyVault and saves a backup of that key to a file that is automatically named for you, and displays the file name. + +### Example 2: Back up a key to a specified file name +```powershell +Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob' +``` + +```output +C:\Backup.blob +``` + +This command retrieves the key named MyKey from the key vaultnamed MyKeyVault and saves a backup of that key to a file named Backup.blob. + +### Example 3: Back up a previously retrieved key to a specified file name, overwriting the destination file without prompting. +```powershell +$key = Get-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' +Backup-AzKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force +``` + +```output +C:\Backup.blob +``` + +This command creates a backup of the key named $key.Name in the vault named $key.VaultName to a file named Backup.blob, silently overwriting the file if it exists already. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrite the given file if it exists + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +HSM name. Cmdlet constructs the FQDN of a managed HSM based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: HsmByKeyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Key bundle to back up, pipelined in from the output of a retrieval call. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem +Parameter Sets: ByKey +Aliases: Key + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the key to back up. + +```yaml +Type: System.String +Parameter Sets: ByKeyName, HsmByKeyName +Aliases: KeyName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFile +Specifies the output file in which the backup blob is stored. +If you do not specify this parameter, this cmdlet generates a file name for you. +If you specify the name of an existing output file, the operation will not complete and returns an error message that the backup file already exists. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault that contains the key to back up. + +```yaml +Type: System.String +Parameter Sets: ByKeyName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Add-AzKeyVaultKey](./Add-AzKeyVaultKey.md) + +[Get-AzKeyVaultKey](./Get-AzKeyVaultKey.md) + +[Remove-AzKeyVaultKey](./Remove-AzKeyVaultKey.md) + +[Restore-AzKeyVaultKey](./Restore-AzKeyVaultKey.md) + diff --git a/azps-10.1.0/Az.KeyVault/Backup-AzKeyVaultManagedStorageAccount.md b/azps-10.1.0/Az.KeyVault/Backup-AzKeyVaultManagedStorageAccount.md new file mode 100644 index 0000000000..ace66496cb --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Backup-AzKeyVaultManagedStorageAccount.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/backup-azkeyvaultmanagedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Backup-AzKeyVaultManagedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Backup-AzKeyVaultManagedStorageAccount.md +--- + +# Backup-AzKeyVaultManagedStorageAccount + +## SYNOPSIS +Backs up a KeyVault-managed storage account. + +## SYNTAX + +### ByStorageAccountName (Default) +``` +Backup-AzKeyVaultManagedStorageAccount [-VaultName] <String> [-Name] <String> [[-OutputFile] <String>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByStorageAccount +``` +Backup-AzKeyVaultManagedStorageAccount [-InputObject] <PSKeyVaultManagedStorageAccountIdentityItem> + [[-OutputFile] <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Backup-AzKeyVaultManagedStorageAccount** cmdlet backs up a specified managed storage account in a key vault by downloading it and storing it in a file. +Because the downloaded content is encrypted, it cannot be used outside of Azure Key Vault. +You can restore a backed-up storage account to any key vault in the subscription that it was backed up from, as long as the vault is in the same Azure geography. +Typical reasons to use this cmdlet are: +- You want to retain an offline copy of the storage account in case you accidentally delete the original from the vault. + +- You created a managed storage account using Key Vault and now want to clone the object into a different Azure region, so that you can use it from all instances of your distributed application. +Use the **Backup-AzKeyVaultManagedStorageAccount** cmdlet to retrieve the managed storage account in encrypted format and then use the **Restore-AzKeyVaultManagedStorageAccount** cmdlet +and specify a key vault in the second region. + +## EXAMPLES + +### Example 1: Back up a managed storage account with an automatically generated file name +```powershell +Backup-AzKeyVaultManagedStorageAccount -VaultName 'MyKeyVault' -Name 'MyMSAK' +``` + +```output +C:\Users\username\mykeyvault-mymsak-1527029447.01191 +``` + +This command retrieves the managed storage account named MyMSAK from the key vault named MyKeyVault and saves a backup of that managed storage account to a file that is automatically named for you, and displays the file name. + +### Example 2: Back up a managed storage account to a specified file name +```powershell +Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyMSAK' -OutputFile 'C:\Backup.blob' +``` + +```output +C:\Backup.blob +``` + +This command retrieves the managed storage account named MyMSAK from the key vault named MyKeyVault and saves a backup of that managed storage account to a file named Backup.blob. + +### Example 3: Back up a previously retrieved managed storage account to a specified file name, overwriting the destination file without prompting. +```powershell +$msak = Get-AzKeyVaultManagedStorageAccount -VaultName 'MyKeyVault' -Name 'MyMSAK' +Backup-AzKeyVaultManagedStorageAccount -StorageAccount $msak -OutputFile 'C:\Backup.blob' -Force +``` + +```output +C:\Backup.blob +``` + +This command creates a backup of the managed storage account named $msak.Name in the vault named $msak.VaultName to a file named Backup.blob, silently overwriting the file if it exists already. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrite the given file if it exists + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Storage account bundle to be backed up, pipelined in from the output of a retrieval call. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem +Parameter Sets: ByStorageAccount +Aliases: StorageAccount + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Secret name. +Cmdlet constructs the FQDN of a secret from vault name, currently selected environment and secret name. + +```yaml +Type: System.String +Parameter Sets: ByStorageAccountName +Aliases: StorageAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFile +Output file. +The output file to store the storage account backup. +If not specified, a default filename will be generated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: ByStorageAccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Backup-AzKeyVaultSecret.md b/azps-10.1.0/Az.KeyVault/Backup-AzKeyVaultSecret.md new file mode 100644 index 0000000000..fbbcdb8e85 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Backup-AzKeyVaultSecret.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 80AAA327-77C6-4372-9461-FFED5A15E678 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/backup-azkeyvaultsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Backup-AzKeyVaultSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Backup-AzKeyVaultSecret.md +--- + +# Backup-AzKeyVaultSecret + +## SYNOPSIS +Backs up a secret in a key vault. + +## SYNTAX + +### BySecretName (Default) +``` +Backup-AzKeyVaultSecret [-VaultName] <String> [-Name] <String> [[-OutputFile] <String>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BySecret +``` +Backup-AzKeyVaultSecret [-InputObject] <PSKeyVaultSecretIdentityItem> [[-OutputFile] <String>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Backup-AzKeyVaultSecret** cmdlet backs up a specified secret in a key vault by downloading it and storing it in a file. +If there are multiple versions of the secret, all versions are included in the backup. +Because the downloaded content is encrypted, it cannot be used outside of Azure Key Vault. +You can restore a backed-up secret to any key vault in the subscription that it was backed up from. +Typical reasons to use this cmdlet are: +- You want to escrow a copy of your secret, so that you have an offline copy in case you accidentally delete your secret in your key vault. +- You added a secret to a key vault and now want to clone the secret into a different Azure region, so that you can use it from all instances of your distributed application. Use the Backup-AzKeyVaultSecret cmdlet to retrieve the secret in encrypted format and then use the Restore-AzKeyVaultSecret cmdlet and specify a key vault in the second region. (Note that the regions must belong to the same geography.) + +## EXAMPLES + +### Example 1: Back up a secret with an automatically generated file name +```powershell +Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' +``` + +```output +C:\Users\username\mykeyvault-mysecret-1527029447.01191 +``` + +This command retrieves the secret named MySecret from the key vault named MyKeyVault and saves a backup of that secret to a file that is automatically named for you, and displays the file name. + +### Example 2: Back up a secret to a specified file name, overwriting the existing file without prompting +```powershell +Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force +``` + +```output +C:\Backup.blob +``` + +This command retrieves the secret named MySecret from the key vaultnamed MyKeyVault and saves a backup of that secret to a file named Backup.blob. + +### Example 3: Back up a secret previously retrieved to a specified file name +```powershell +$secret = Get-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' +Backup-AzKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob' +``` + +```output +C:\Backup.blob +``` + +This command uses the $secret object's vault name and name to retrieves the secret and saves its backup to a file named Backup.blob. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Prompts you for confirmation before overwriting the output file, if that exists. + +```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 +``` + +### -InputObject +Secret to be backed up, pipelined in from the output of a retrieval call. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem +Parameter Sets: BySecret +Aliases: Secret + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the secret to back up. + +```yaml +Type: System.String +Parameter Sets: BySecretName +Aliases: SecretName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFile +Specifies the output file in which the backup blob is stored. +If you do not specify this parameter, this cmdlet generates a file name for you. +If you specify the name of an existing output file, the operation will not complete and returns an error message that the backup file already exists. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault that contains the secret to back up. + +```yaml +Type: System.String +Parameter Sets: BySecretName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Set-AzKeyVaultSecret](./Set-AzKeyVaultSecret.md) + +[Get-AzKeyVaultSecret](./Get-AzKeyVaultSecret.md) + +[Remove-AzKeyVaultSecret](./Remove-AzKeyVaultSecret.md) + +[Restore-AzKeyVaultSecret](./Restore-AzKeyVaultSecret.md) + diff --git a/azps-10.1.0/Az.KeyVault/Export-AzKeyVaultSecurityDomain.md b/azps-10.1.0/Az.KeyVault/Export-AzKeyVaultSecurityDomain.md new file mode 100644 index 0000000000..b01bef7ddb --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Export-AzKeyVaultSecurityDomain.md @@ -0,0 +1,226 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/export-azkeyvaultsecuritydomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Export-AzKeyVaultSecurityDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Export-AzKeyVaultSecurityDomain.md +--- + +# Export-AzKeyVaultSecurityDomain + +## SYNOPSIS +Exports the security domain data of a managed HSM. + +## SYNTAX + +### ByName (Default) +``` +Export-AzKeyVaultSecurityDomain -Certificates <String[]> -OutputPath <String> [-Force] [-PassThru] + -Quorum <Int32> -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ByInputObject +``` +Export-AzKeyVaultSecurityDomain -Certificates <String[]> -OutputPath <String> [-Force] [-PassThru] + -Quorum <Int32> -InputObject <PSKeyVaultIdentityItem> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Exports the security domain data of a managed HSM for importing on another HSM. + +## EXAMPLES + +### Example 1 +```powershell +Export-AzKeyVaultSecurityDomain -Name testmhsm -Certificates sd1.cer, sd2.cer, sd3.cer -OutputPath sd.ps.json -Quorum 2 +``` + +This command retrieves the managed HSM named testmhsm and saves a backup of that managed HSM security domain to the specified output file. + +## PARAMETERS + +### -Certificates +Paths to the certificates that are used to encrypt the security domain data. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specify whether to overwrite existing file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Object representing a managed HSM. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultIdentityItem +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the managed HSM. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: HsmName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputPath +Specify the path where security domain data will be downloaded to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +When specified, a boolean will be returned when cmdlet succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quorum +The minimum number of shares required to decrypt the security domain for recovery. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultIdentityItem + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVault.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVault.md new file mode 100644 index 0000000000..a47fad5ab2 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVault.md @@ -0,0 +1,351 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: A7C287C4-E9FD-407A-91BD-EFA17C33FC8B +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVault.md +--- + +# Get-AzKeyVault + +## SYNOPSIS +Gets key vaults. + +## SYNTAX + +### GetVaultByName (Default) +``` +Get-AzKeyVault [[-VaultName] <String>] [[-ResourceGroupName] <String>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ByDeletedVault +``` +Get-AzKeyVault [-VaultName] <String> [-Location] <String> [-InRemovedState] + [-DefaultProfile <IAzureContextContainer>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ListAllDeletedVaultsInSubscription +``` +Get-AzKeyVault [-InRemovedState] [-DefaultProfile <IAzureContextContainer>] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzKeyVault** cmdlet gets information about the key vaults in a subscription. You can +view all key vaults instances in a subscription, or filter your results by a resource group or a +particular key vault. +Note that although specifying the resource group is optional for this cmdlet when you get a single +key vault, you should do so for better performance. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /directoryObjects/{id} +- GET /users/{id} +- GET /servicePrincipals/{id} +- GET /groups/{id} + +## EXAMPLES + +### Example 1: Get all key vaults in your current subscription +```powershell +Get-AzKeyVault +``` + +```output +Vault Name : myvault1 +Resource Group Name : myrg +Location : westus +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.Ke + yVault/vaults/myvault1 +Tags : + + +Vault Name : myvault2 +Resource Group Name : myrg1 +Location : westus +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke + yVault/vaults/myvault2 +Tags : + +Vault Name : myvault3 +Resource Group Name : myrg1 +Location : westus +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke + yVault/vaults/myvault3 +Tags : +``` + +This command gets all the key vaults in your current subscription. + +### Example 2: Get a specific key vault +```powershell +Get-AzKeyVault -VaultName 'myvault' +``` + +```output +Vault Name : myvault +Resource Group Name : myrg +Location : westus +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers + /Microsoft.KeyVault/vaults/myvault +Vault URI : https://myvault.vault.azure.net/ +Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +SKU : Standard +Enabled For Deployment? : True +Enabled For Template Deployment? : True +Enabled For Disk Encryption? : False +Soft Delete Enabled? : True +Access Policies : + Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Application ID : + Display Name : User Name (username@microsoft.com) + Permissions to Keys : get, create, delete, list, update, + import, backup, restore, recover + Permissions to Secrets : get, list, set, delete, backup, + restore, recover + Permissions to Certificates : get, delete, list, create, import, + update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers, + setissuers, recover + Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list, + listsas, regeneratekey, set, setsas, update + +Tags : +``` + +This command gets the key vault named myvault in your current subscription. + +### Example 3: Get key vaults in a resource group +```powershell +Get-AzKeyVault -ResourceGroupName 'myrg1' +``` + +```output +Vault Name : myvault2 +Resource Group Name : myrg1 +Location : westus +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke + yVault/vaults/myvault2 +Tags : + +Vault Name : myvault3 +Resource Group Name : myrg1 +Location : westus +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke + yVault/vaults/myvault3 +Tags : +``` + +This command gets all the key vaults in the resource group named ContosoPayRollResourceGroup. + +### Example 4: Get all deleted key vaults in your current subscription +```powershell +Get-AzKeyVault -InRemovedState +``` + +```output +Vault Name : myvault4 +Location : westus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.KeyVault/locations/westu + s/deletedVaults/myvault4 +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.K + eyVault/vaults/myvault4 +Deletion Date : 5/24/2018 9:33:24 PM +Scheduled Purge Date : 8/22/2018 9:33:24 PM +Tags : +``` + +This command gets all the deleted key vaults in your current subscription. + +### Example 5: Get a deleted key vault +```powershell +Get-AzKeyVault -VaultName 'myvault4' -Location 'westus' -InRemovedState +``` + +```output +Vault Name : myvault4 +Location : westus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.KeyVault/locations/westu + s/deletedVaults/myvault4 +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.K + eyVault/vaults/myvault4 +Deletion Date : 5/24/2018 9:33:24 PM +Scheduled Purge Date : 8/22/2018 9:33:24 PM +Tags : +``` + +This command gets the deleted key vault information named myvault4 in your current +subscription and in westus region. + +### Example 6: Get key vaults using filtering +```powershell +Get-AzKeyVault -VaultName 'myvault*' +``` + +```output +Vault Name : myvault2 +Resource Group Name : myrg1 +Location : westus +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke + yVault/vaults/myvault2 +Tags : + +Vault Name : myvault3 +Resource Group Name : myrg1 +Location : westus +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke + yVault/vaults/myvault3 +Tags : +``` + +This command gets all the key vaults in the subscription that start with "myvault". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InRemovedState +Specifies whether to show the previously deleted vaults in the output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByDeletedVault, ListAllDeletedVaultsInSubscription +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the deleted vault. + +```yaml +Type: System.String +Parameter Sets: ByDeletedVault +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group associated with the key vault or key vaults being queried. + +```yaml +Type: System.String +Parameter Sets: GetVaultByName +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: GetVaultByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault. + +```yaml +Type: System.String +Parameter Sets: GetVaultByName +Aliases: Name + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: ByDeletedVault +Aliases: Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultIdentityItem + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVault + +## NOTES + +## RELATED LINKS + +[New-AzKeyVault](./New-AzKeyVault.md) + +[Remove-AzKeyVault](./Remove-AzKeyVault.md) diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificate.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificate.md new file mode 100644 index 0000000000..9ad832c5cd --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificate.md @@ -0,0 +1,408 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 363FA51E-D075-4800-A4BE-BFF63FD25C90 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultCertificate.md +--- + +# Get-AzKeyVaultCertificate + +## SYNOPSIS +Gets a certificate from a key vault. + +## SYNTAX + +### ByName (Default) +``` +Get-AzKeyVaultCertificate [-VaultName] <String> [[-Name] <String>] [-InRemovedState] [-IncludePending] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByCertificateNameAndVersion +``` +Get-AzKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-Version] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByCertificateAllVersions +``` +Get-AzKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-IncludeVersions] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByNameInputObject +``` +Get-AzKeyVaultCertificate [-InputObject] <PSKeyVault> [[-Name] <String>] [-InRemovedState] [-IncludePending] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByCertificateNameAndVersionInputObject +``` +Get-AzKeyVaultCertificate [-InputObject] <PSKeyVault> [-Name] <String> [-Version] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByCertificateAllVersionsInputObject +``` +Get-AzKeyVaultCertificate [-InputObject] <PSKeyVault> [-Name] <String> [-IncludeVersions] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByNameResourceId +``` +Get-AzKeyVaultCertificate [-ResourceId] <String> [[-Name] <String>] [-InRemovedState] [-IncludePending] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByCertificateNameAndVersionResourceId +``` +Get-AzKeyVaultCertificate [-ResourceId] <String> [-Name] <String> [-Version] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByCertificateAllVersionsResourceId +``` +Get-AzKeyVaultCertificate [-ResourceId] <String> [-Name] <String> [-IncludeVersions] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzKeyVaultCertificate** cmdlet gets the specified certificate or the versions of a certificate from a key vault in Azure Key Vault. + +## EXAMPLES + +### Example 1: Get a certificate +```powershell +Get-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01" +``` + +```output +Name : testCert01 +Certificate : [Subject] + CN=contoso.com + + [Issuer] + CN=contoso.com + + [Serial Number] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + [Not Before] + 2/8/2016 3:11:45 PM + + [Not After] + 8/8/2016 4:21:45 PM + + [Thumbprint] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + +KeyId : https://contoso.vault.azure.net:443/keys/TestCert01/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +SecretId : https://contoso.vault.azure.net:443/secrets/TestCert01/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +Tags : +Enabled : True +Created : 2/8/2016 11:21:45 PM +Updated : 2/8/2016 11:21:45 PM +``` + +This command gets the certificate named `TestCert01` from the key vault named `ContosoKV01` + +### Example 2: Get cert and save it as pfx +```powershell +$CertBase64 = Get-AzKeyVaultSecret -VaultName $vaultName -Name $certName -AsPlainText +$CertBytes = [Convert]::FromBase64String($CertBase64) +Set-Content -Path cert.pfx -Value $CertBytes -AsByteStream +``` + +This command gets the certificate named `$certName` from the key vault named `$vaultName`. These commands access secret `$certName` and then save the content as a pfx file. + +### Example 3: Get all the certificates that have been deleted but not purged for this key vault. +```powershell +Get-AzKeyVaultCertificate -VaultName 'contoso' -InRemovedState +``` + +```output +DeletedDate : 5/24/2018 6:08:32 PM +Enabled : True +Expires : 11/24/2018 6:08:13 PM +NotBefore : 5/24/2018 5:58:13 PM +Created : 5/24/2018 6:08:13 PM +Updated : 5/24/2018 6:08:13 PM +Tags : +VaultName : contoso +Name : test1 +Version : +Id : https://contoso.vault.azure.net:443/certificates/test1 + +ScheduledPurgeDate : 8/22/2018 6:10:47 PM +DeletedDate : 5/24/2018 6:10:47 PM +Enabled : True +Expires : 11/24/2018 6:09:44 PM +NotBefore : 5/24/2018 5:59:44 PM +Created : 5/24/2018 6:09:44 PM +Updated : 5/24/2018 6:09:44 PM +Tags : +VaultName : contoso +Name : test2 +Version : +Id : https://contoso.vault.azure.net:443/certificates/test2 +``` + +This command gets all the certificates that have been previously deleted, but not purged, in the key vault named Contoso. + +### Example 4: Gets the certificate MyCert that has been deleted but not purged for this key vault. +```powershell +Get-AzKeyVaultCertificate -VaultName 'contoso' -Name 'test1' -InRemovedState +``` + +```output +Certificate : [Subject] + CN=contoso.com + + [Issuer] + CN=contoso.com + + [Serial Number] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + [Not Before] + 5/24/2018 10:58:13 AM + + [Not After] + 11/24/2018 10:08:13 AM + + [Thumbprint] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + +KeyId : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334 +SecretId : https://contoso.vault.azure.net:443/secrets/test1/7fe415d5518240c1a6fce89986b8d334 +Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +RecoveryLevel : Recoverable+Purgeable +ScheduledPurgeDate : 8/22/2018 6:08:32 PM +DeletedDate : 5/24/2018 6:08:32 PM +Enabled : True +Expires : 11/24/2018 6:08:13 PM +NotBefore : 5/24/2018 5:58:13 PM +Created : 5/24/2018 6:08:13 PM +Updated : 5/24/2018 6:08:13 PM +Tags : +VaultName : contoso +Name : test1 +Version : 7fe415d5518240c1a6fce89986b8d334 +Id : https://contoso.vault.azure.net:443/certificates/test1/7fe415d5518240c1a6fce89986b8d334 +``` + +This command gets the certificate named 'MyCert' that has been previously deleted, but not purged, in the key vault named Contoso. +This command will return metadata such as the deletion date, and the scheduled purging date of this deleted certificate. + +### Example 5: List certificates using filtering +```powershell +Get-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "test*" +``` + +```output +Enabled : True +Expires : 8/5/2019 2:39:25 AM +NotBefore : 2/5/2019 2:29:25 AM +Created : 2/5/2019 2:39:25 AM +Updated : 2/5/2019 2:39:25 AM +Tags : +VaultName : ContosoKV01 +Name : test1 +Version : +Id : https://ContosoKV01.vault.azure.net:443/certificates/test1 + +Enabled : True +Expires : 8/5/2019 2:39:25 AM +NotBefore : 2/5/2019 2:29:25 AM +Created : 2/5/2019 2:39:25 AM +Updated : 2/5/2019 2:39:25 AM +Tags : +VaultName : ContosoKV01 +Name : test2 +Version : +Id : https://ContosoKV01.vault.azure.net:443/certificates/test2 +``` +This command gets all certificates starting with "test" from the key vault named ContosoKV01. + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePending +Specifies whether to include pending certificates in the output + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByName, ByNameInputObject, ByNameResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeVersions +Indicates that this operation gets all versions of the certificate. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByCertificateAllVersions, ByCertificateAllVersionsInputObject, ByCertificateAllVersionsResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByNameInputObject, ByCertificateNameAndVersionInputObject, ByCertificateAllVersionsInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InRemovedState +Specifies whether to include previously deleted certificates in the output + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByName, ByNameInputObject, ByNameResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the certificate to get. + +```yaml +Type: System.String +Parameter Sets: ByName, ByNameInputObject, ByNameResourceId +Aliases: CertificateName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: ByCertificateNameAndVersion, ByCertificateAllVersions, ByCertificateNameAndVersionInputObject, ByCertificateAllVersionsInputObject, ByCertificateNameAndVersionResourceId, ByCertificateAllVersionsResourceId +Aliases: CertificateName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceId +KeyVault Resource Id. + +```yaml +Type: System.String +Parameter Sets: ByNameResourceId, ByCertificateNameAndVersionResourceId, ByCertificateAllVersionsResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault. + +```yaml +Type: System.String +Parameter Sets: ByName, ByCertificateNameAndVersion, ByCertificateAllVersions +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Specifies the version of a certificate. + +```yaml +Type: System.String +Parameter Sets: ByCertificateNameAndVersion, ByCertificateNameAndVersionInputObject, ByCertificateNameAndVersionResourceId +Aliases: CertificateVersion + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultCertificate + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultCertificateIdentityItem + +## NOTES + +## RELATED LINKS + +[Add-AzKeyVaultCertificate](./Add-AzKeyVaultCertificate.md) + +[Import-AzKeyVaultCertificate](./Import-AzKeyVaultCertificate.md) + +[Remove-AzKeyVaultCertificate](./Remove-AzKeyVaultCertificate.md) diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificateContact.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificateContact.md new file mode 100644 index 0000000000..33a2e2a9ff --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificateContact.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 200C68A3-A79C-4517-8E5D-8128F6C73A5C +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultcertificatecontact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultCertificateContact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultCertificateContact.md +--- + +# Get-AzKeyVaultCertificateContact + +## SYNOPSIS +Gets contacts that are registered for certificate notifications for a key vault. + +## SYNTAX + +### VaultName (Default) +``` +Get-AzKeyVaultCertificateContact [-VaultName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByInputObject +``` +Get-AzKeyVaultCertificateContact [-InputObject] <PSKeyVault> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzKeyVaultCertificateContact [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzKeyVaultCertificateContact** cmdlet gets contacts that are registered for certificate notifications for a key vault in Azure Key Vault. + +## EXAMPLES + +### Example 1: Get all certificate contacts +```powershell +$Contacts = Get-AzKeyVaultCertificateContact -VaultName "Contoso" +``` + +```output +Email VaultName +----- --------- +username@microsoft.com Contoso +username1@microsoft.com Contoso +``` + +This command gets all of the contacts for the certificate objects in the Contoso key vault, and then stores them in the $Contacts variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceId +KeyVault Id. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault. + +```yaml +Type: System.String +Parameter Sets: VaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateContact + +## NOTES + +## RELATED LINKS + +[Add-AzKeyVaultCertificateContact](./Add-AzKeyVaultCertificateContact.md) + +[Remove-AzKeyVaultCertificateContact](./Remove-AzKeyVaultCertificateContact.md) + diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificateIssuer.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificateIssuer.md new file mode 100644 index 0000000000..dba1696561 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificateIssuer.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 5F856280-C561-47B5-AA96-27E34C86D604 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultcertificateissuer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultCertificateIssuer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultCertificateIssuer.md +--- + +# Get-AzKeyVaultCertificateIssuer + +## SYNOPSIS +Gets a certificate issuer for a key vault. + +## SYNTAX + +### ByName (Default) +``` +Get-AzKeyVaultCertificateIssuer [-VaultName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObject +``` +Get-AzKeyVaultCertificateIssuer [-InputObject] <PSKeyVault> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzKeyVaultCertificateIssuer [-ResourceId] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzKeyVaultCertificateIssuer** cmdlet gets a specified certificate issuer or all certificate issuers for a key vault in Azure Key Vault. + +## EXAMPLES + +### Example 1: Get a certificate issuer +```powershell +Get-AzKeyVaultCertificateIssuer -VaultName "Contosokv01" -Name "TestIssuer01" +``` + +```output +AccountId : 555 +ApiKey : +OrganizationDetails : Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOrganizationDetails +Name : TestIssuer01 +IssuerProvider : Test +VaultName : Contosokv01 +``` + +This command gets the certificate issuer named TestIssuer01. + +### Example 2: List certificate issuers using filtering +```powershell +Get-AzKeyVaultCertificateIssuer -VaultName "Contosokv01" -Name "test*" +``` + +```output +AccountId : 555 +ApiKey : +OrganizationDetails : Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOrganizationDetails +Name : TestIssuer01 +IssuerProvider : Test +VaultName : Contosokv01 + +AccountId : 555 +ApiKey : +OrganizationDetails : Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOrganizationDetails +Name : TestIssuer02 +IssuerProvider : Test +VaultName : Contosokv01 +``` + +This command gets the certificate issuers that start with "test". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the certificate issuer to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IssuerName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceId +KeyVault Resource Id. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuerIdentityItem + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuer + +## NOTES + +## RELATED LINKS + +[Remove-AzKeyVaultCertificateIssuer](./Remove-AzKeyVaultCertificateIssuer.md) + +[Set-AzKeyVaultCertificateIssuer](./Set-AzKeyVaultCertificateIssuer.md) + + diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificateOperation.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificateOperation.md new file mode 100644 index 0000000000..e599dac40e --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificateOperation.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 0743C43D-2A1F-4950-B0F3-1FED4014EEC5 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultcertificateoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultCertificateOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultCertificateOperation.md +--- + +# Get-AzKeyVaultCertificateOperation + +## SYNOPSIS +Gets the status of a certificate operation. + +## SYNTAX + +### ByName (Default) +``` +Get-AzKeyVaultCertificateOperation [-VaultName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObject +``` +Get-AzKeyVaultCertificateOperation [-InputObject] <PSKeyVaultCertificateIdentityItem> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzKeyVaultCertificateOperation** cmdlet gets the status of a certificate operation. + +## EXAMPLES + +### Example 1: Get the status of a certificate operation +```powershell +Get-AzKeyVaultCertificateOperation -VaultName "contosoKV01" -Name "TestCert01" +``` + +```output +Id : https://contosoKV01.vault.azure.net/certificates/TestCert01/pending +Status : inProgress +StatusDetails : Pending certificate created. Certificate request is in progress. This may take some time + based on the issuer provider. Please check again later. +RequestId : 32a63e80568442a2892dafb9f7cf366t +Target : +Issuer : Self +CancellationRequested : False +CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC73w3VRBOlgJ5Od1PjDh+2ytngNZp+ZP4fkuX8K1Ti5LA6Ih7eWx1fgAN/iTb6l + 5K6LvAIJvsTNVePMNxfSdaEIJ70Inm45wVU4A/kf+UxQWAYVMsBrLtDFWxnVhzf6n7RGYke6HLBj3j5ASb9g+olSs6eON25ibF0t+u6JC+sIR0LmVGar9Q0eZys1rdfzJBIKq+laOM7z2pJijb5ANqve9 + i7rH5mnhQk4V8WsRstOhYR9jgLqSSxokDoeaBClIOidSBYqVc1yNv4ASe1UWUCR7ZK6OQXiecNWSWPmgWEyawu6AR9eb1YotCr2ScheMOCxlm3103luitxrd8A7kMjAgMBAAGgSzBJBgkqhkiG9w0BCQ4 + xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAIHhsDJV37PKi8hor5eQf7+Tct1preIvSwqV0NF6Uo7O6 + YnC9Py7Wp7CHfKzuqeptUk2Tsu7B5dHB+o9Ypeeqw8fWhTN0GFGRKO7WjZQlDqL+lRNcjlFSaP022oIP0kmvVhBcmZqRQlALXccAaxEclFA/3y/aNj2gwWeKpH/pwAkZ39zMEzpQCaRfnQk7e3l4MV8cf + eC2HPYdRWkXxAeDcNPxBuVmKy49AzYvly+APNVDU3v66gxl3fIKrGRsKi2Cp/nO5rBxG2h8t+0Za4l/HJ7ZWR9wKbd/xg7JhdZZFVBxMHYzw8KQ0ys13x8HY+PXU92Y7yD3uC2Rcj+zbAf+Kg== +ErrorCode : +ErrorMessage : +Name : +VaultName : +``` + +This command gets the status of the certificate operation for TestCert01 on the ContosoKV01 key vault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Certificate Object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a certificate. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: CertificateName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation + +## NOTES + +## RELATED LINKS + +[Remove-AzKeyVaultCertificateOperation](./Remove-AzKeyVaultCertificateOperation.md) + +[Stop-AzKeyVaultCertificateOperation](./Stop-AzKeyVaultCertificateOperation.md) + diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificatePolicy.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificatePolicy.md new file mode 100644 index 0000000000..9aa20b8745 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultCertificatePolicy.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 0729687C-3104-4136-A80D-16BAEBD6B76C +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultcertificatepolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultCertificatePolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultCertificatePolicy.md +--- + +# Get-AzKeyVaultCertificatePolicy + +## SYNOPSIS +Gets the policy for a certificate in a key vault. + +## SYNTAX + +### VaultAndCertName (Default) +``` +Get-AzKeyVaultCertificatePolicy [-VaultName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObject +``` +Get-AzKeyVaultCertificatePolicy [-InputObject] <PSKeyVaultCertificateIdentityItem> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzKeyVaultCertificatePolicy** cmdlet gets the policy for a certificate in a key vault in Azure Key Vault. + +## EXAMPLES + +### Example 1: Get a certificate policy +```powershell +Get-AzKeyVaultCertificatePolicy -VaultName "ContosoKV01" -Name "TestCert01" +``` + +```output +SecretContentType : application/x-pkcs12 +Kty : RSA +KeySize : 2048 +Exportable : True +ReuseKeyOnRenewal : True +SubjectName : CN=contoso.com +DnsNames : +Ekus : {1.3.6.1.5.5.7.3.1, 1.3.6.1.5.5.7.3.2} +ValidityInMonths : 6 +IssuerName : Self +CertificateType : +RenewAtNumberOfDaysBeforeExpiry : +RenewAtPercentageLifetime : 80 +EmailAtNumberOfDaysBeforeExpiry : +EmailAtPercentageLifetime : +Enabled : True +Created : 2/8/2016 11:10:29 PM +Updated : 2/8/2016 11:10:29 PM +``` + +This command gets the certificate policy for TestCert01 certificate in the ContosoKV01 key vault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Certificate Object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a certificate. + +```yaml +Type: System.String +Parameter Sets: VaultAndCertName +Aliases: CertificateName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault. + +```yaml +Type: System.String +Parameter Sets: VaultAndCertName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy + +## NOTES + +## RELATED LINKS + +[New-AzKeyVaultCertificatePolicy](./New-AzKeyVaultCertificatePolicy.md) + +[Set-AzKeyVaultCertificatePolicy](./Set-AzKeyVaultCertificatePolicy.md) + diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultKey.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultKey.md new file mode 100644 index 0000000000..db9e5970ae --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultKey.md @@ -0,0 +1,559 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 2BE34AE1-06FA-4F66-8FDB-CED22C2E0978 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultKey.md +--- + +# Get-AzKeyVaultKey + +## SYNOPSIS +Gets Key Vault keys. Please notes that detailed information about a key, like key type or key size, only available when querying a specific key version. + +## SYNTAX + +### ByVaultName (Default) +``` +Get-AzKeyVaultKey [-VaultName] <String> [[-Name] <String>] [-InRemovedState] [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByKeyName +``` +Get-AzKeyVaultKey [-VaultName] <String> [-Name] <String> [-Version] <String> [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByKeyVersions +``` +Get-AzKeyVaultKey [-VaultName] <String> [-Name] <String> [-IncludeVersions] [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### HsmByKeyName +``` +Get-AzKeyVaultKey -HsmName <String> [-Name] <String> [-Version] <String> [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### HsmByVaultName +``` +Get-AzKeyVaultKey -HsmName <String> [[-Name] <String>] [-InRemovedState] [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### HsmByKeyVersions +``` +Get-AzKeyVaultKey -HsmName <String> [-Name] <String> [-IncludeVersions] [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObjectVaultName +``` +Get-AzKeyVaultKey [-InputObject] <PSKeyVault> [[-Name] <String>] [-InRemovedState] [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObjectKeyName +``` +Get-AzKeyVaultKey [-InputObject] <PSKeyVault> [-Name] <String> [-Version] <String> [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObjectKeyVersions +``` +Get-AzKeyVaultKey [-InputObject] <PSKeyVault> [-Name] <String> [-IncludeVersions] [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### HsmByInputObjectVaultName +``` +Get-AzKeyVaultKey [-HsmObject] <PSManagedHsm> [[-Name] <String>] [-InRemovedState] [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### HsmByInputObjectKeyName +``` +Get-AzKeyVaultKey [-HsmObject] <PSManagedHsm> [-Name] <String> [-Version] <String> [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### HsmByInputObjectKeyVersions +``` +Get-AzKeyVaultKey [-HsmObject] <PSManagedHsm> [-Name] <String> [-IncludeVersions] [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdVaultName +``` +Get-AzKeyVaultKey -ResourceId <String> [[-Name] <String>] [-InRemovedState] [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdKeyName +``` +Get-AzKeyVaultKey -ResourceId <String> [-Name] <String> [-Version] <String> [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdKeyVersions +``` +Get-AzKeyVaultKey -ResourceId <String> [-Name] <String> [-IncludeVersions] [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### HsmByResourceIdVaultName +``` +Get-AzKeyVaultKey -HsmResourceId <String> [[-Name] <String>] [-InRemovedState] [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### HsmByResourceIdKeyName +``` +Get-AzKeyVaultKey -HsmResourceId <String> [-Name] <String> [-Version] <String> [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### HsmByResourceIdKeyVersions +``` +Get-AzKeyVaultKey -HsmResourceId <String> [-Name] <String> [-IncludeVersions] [-OutFile <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzKeyVaultKey** cmdlet gets Azure Key Vault keys. +This cmdlet gets a specific **Microsoft.Azure.Commands.KeyVault.Models.KeyBundle** or a list of all **KeyBundle** objects in a key vault or by version. + +## EXAMPLES + +### Example 1: Get all the keys in a key vault +```powershell +Get-AzKeyVaultKey -VaultName 'contoso' +``` + +```output +Vault/HSM Name : contoso +Name : test1 +Version : +Id : https://contoso.vault.azure.net:443/keys/test1 +Enabled : True +Expires : 11/24/2018 6:08:13 PM +Not Before : 5/24/2018 5:58:13 PM +Created : 5/24/2018 6:08:13 PM +Updated : 5/24/2018 6:08:13 PM +Purge Disabled : False +Tags : + +Vault Name : contoso +Name : test2 +Version : +Id : https://contoso.vault.azure.net:443/keys/test2 +Enabled : True +Expires : 11/24/2018 6:09:44 PM +Not Before : 5/24/2018 5:59:44 PM +Created : 5/24/2018 6:09:44 PM +Updated : 5/24/2018 6:09:44 PM +Purge Disabled : False +Tags : +``` + +This command gets all the keys in the key vault named Contoso. + +### Example 2: Get the current version of a key +```powershell +Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1' +``` + +```output +Vault/HSM Name : contoso +Name : test1 +Key Type : RSA +Key Size : 2048 +Version : 7fe415d5518240c1a6fce89986b8d334 +Id : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334 +Enabled : True +Expires : 11/24/2018 6:08:13 PM +Not Before : 5/24/2018 5:58:13 PM +Created : 5/24/2018 6:08:13 PM +Updated : 5/24/2018 6:08:13 PM +Purge Disabled : False +Tags : +``` + +This command gets the current version of the key named test1 in the key vault named Contoso. + +### Example 3: Get all versions of a key +```powershell +Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -IncludeVersions +``` + +```output +Vault/HSM Name : contoso +Name : test1 +Version : 7fe415d5518240c1a6fce89986b8d334 +Id : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334 +Enabled : True +Expires : 11/24/2018 6:08:13 PM +Not Before : 5/24/2018 5:58:13 PM +Created : 5/24/2018 6:08:13 PM +Updated : 5/24/2018 6:08:13 PM +Purge Disabled : False +Tags : + +Vault/HSM Name : contoso +Name : test1 +Version : e4e95940e669407fbdb4298bc21a3e1d +Id : https://contoso.vault.azure.net:443/keys/test1/e4e95940e669407fbdb4298bc21a3e1d +Enabled : False +Expires : 11/24/2018 6:08:08 PM +Not Before : 5/24/2018 5:58:08 PM +Created : 5/24/2018 6:08:08 PM +Updated : 5/24/2018 6:08:08 PM +Purge Disabled : False +Tags : +``` + +This command gets all versions the key named ITPfx in the key vault named Contoso. + +### Example 4: Get a specific version of a key +```powershell +Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -Version 'e4e95940e669407fbdb4298bc21a3e1d' +``` + +```output +Vault/HSM Name : contoso +Name : test1 +Key Type : RSA +Key Size : 2048 +Version : e4e95940e669407fbdb4298bc21a3e1d +Id : https://contoso.vault.azure.net:443/keys/test1/e4e95940e669407fbdb4298bc21a3e1d +Enabled : False +Expires : 11/24/2018 6:08:08 PM +Not Before : 5/24/2018 5:58:08 PM +Created : 5/24/2018 6:08:08 PM +Updated : 5/24/2018 6:08:08 PM +Purge Disabled : False +Tags : +``` + +This command gets a specific version of the key named test1 in the key vault named Contoso. +After running this command, you can inspect various properties of the key by navigating the $Key object. + +### Example 5: Get all the keys that have been deleted but not purged for this key vault +```powershell +Get-AzKeyVaultKey -VaultName 'contoso' -InRemovedState +``` + +```output +Vault/HSM Name : contoso +Name : test3 +Id : https://contoso.vault.azure.net:443/keys/test3 +Deleted Date : 5/24/2018 8:32:42 PM +Scheduled Purge Date : 8/22/2018 8:32:42 PM +Enabled : True +Expires : +Not Before : +Created : 5/24/2018 8:32:27 PM +Updated : 5/24/2018 8:32:27 PM +Purge Disabled : False +Tags : +``` + +This command gets all the keys that have been previously deleted, but not purged, in the key vault named Contoso. + +### Example 6: Gets the key ITPfx that has been deleted but not purged for this key vault. +```powershell +Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test3' -InRemovedState +``` + +```output +Vault/HSM Name : contoso +Name : test3 +Id : https://contoso.vault.azure.net:443/keys/test3/1af807cc331a49d0b52b7c75e1b2366e +Deleted Date : 5/24/2018 8:32:42 PM +Scheduled Purge Date : 8/22/2018 8:32:42 PM +Enabled : True +Expires : +Not Before : +Created : 5/24/2018 8:32:27 PM +Updated : 5/24/2018 8:32:27 PM +Purge Disabled : False +Tags : +``` + +This command gets the key test3 that has been previously deleted, but not purged, in the key vault named Contoso. +This command will return metadata such as the deletion date, and the scheduled purging date of this deleted key. + +### Example 7: Get all the keys in a key vault using filtering +```powershell +Get-AzKeyVaultKey -VaultName 'contoso' -KeyName "test*" +``` + +```output +Vault/HSM Name : contoso +Name : test1 +Version : +Id : https://contoso.vault.azure.net:443/keys/test1 +Enabled : True +Expires : 11/24/2018 6:08:13 PM +Not Before : 5/24/2018 5:58:13 PM +Created : 5/24/2018 6:08:13 PM +Updated : 5/24/2018 6:08:13 PM +Purge Disabled : False +Tags : + +Vault/HSM Name : contoso +Name : test2 +Version : +Id : https://contoso.vault.azure.net:443/keys/test2 +Enabled : True +Expires : 11/24/2018 6:09:44 PM +Not Before : 5/24/2018 5:59:44 PM +Created : 5/24/2018 6:09:44 PM +Updated : 5/24/2018 6:09:44 PM +Purge Disabled : False +Tags : +``` + +This command gets all the keys in the key vault named Contoso that start with "test". + +### Example 8: Download a public key as a .pem file + +```powershell +$path = "D:\public.pem" +Get-AzKeyVaultKey -VaultName $vaultName -KeyName $keyName -OutFile $path +``` + +You can download the public key of a RSA key by specifying the `-OutFile` parameter. +This is one step of importing HSM-protected keys to Azure Key Vault. See https://learn.microsoft.com/azure/key-vault/keys/hsm-protected-keys + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +HSM name. Cmdlet constructs the FQDN of a managed HSM based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: HsmByKeyName, HsmByVaultName, HsmByKeyVersions +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmObject +HSM object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm +Parameter Sets: HsmByInputObjectVaultName, HsmByInputObjectKeyName, HsmByInputObjectKeyVersions +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -HsmResourceId +HSM Resource Id. + +```yaml +Type: System.String +Parameter Sets: HsmByResourceIdVaultName, HsmByResourceIdKeyName, HsmByResourceIdKeyVersions +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludeVersions +Indicates that this cmdlet gets all versions of a key. +The current version of a key is the first one on the list. +If you specify this parameter you must also specify the *Name* and *VaultName* parameters. +If you do not specify the *IncludeVersions* parameter, this cmdlet gets the current version of the key with the specified *Name*. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByKeyVersions, HsmByKeyVersions, ByInputObjectKeyVersions, HsmByInputObjectKeyVersions, ByResourceIdKeyVersions, HsmByResourceIdKeyVersions +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByInputObjectVaultName, ByInputObjectKeyName, ByInputObjectKeyVersions +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InRemovedState +Specifies whether to show the previously deleted keys in the output + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByVaultName, HsmByVaultName, ByInputObjectVaultName, HsmByInputObjectVaultName, ByResourceIdVaultName, HsmByResourceIdVaultName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the key bundle to get. + +```yaml +Type: System.String +Parameter Sets: ByVaultName, HsmByVaultName, ByInputObjectVaultName, HsmByInputObjectVaultName, ByResourceIdVaultName, HsmByResourceIdVaultName +Aliases: KeyName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: ByKeyName, ByKeyVersions, HsmByKeyName, HsmByKeyVersions, ByInputObjectKeyName, ByInputObjectKeyVersions, HsmByInputObjectKeyName, HsmByInputObjectKeyVersions, ByResourceIdKeyName, ByResourceIdKeyVersions, HsmByResourceIdKeyName, HsmByResourceIdKeyVersions +Aliases: KeyName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -OutFile +Specifies the output file for which this cmdlet saves the key. The public key is saved in PEM format by default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +KeyVault Resource Id. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdVaultName, ByResourceIdKeyName, ByResourceIdKeyVersions +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault from which this cmdlet gets keys. +This cmdlet constructs the fully qualified domain name (FQDN) of a key vault based on the name that this parameter specifies and your selected environment. + +```yaml +Type: System.String +Parameter Sets: ByVaultName, ByKeyName, ByKeyVersions +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Specifies the key version. +This cmdlet constructs the FQDN of a key based on the key vault name, your currently selected environment, the key name, and the key version. + +```yaml +Type: System.String +Parameter Sets: ByKeyName, HsmByKeyName, ByInputObjectKeyName, HsmByInputObjectKeyName, ByResourceIdKeyName, HsmByResourceIdKeyName +Aliases: KeyVersion + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultKeyIdentityItem + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultKey + +## NOTES + +## RELATED LINKS + +[Add-AzKeyVaultKey](./Add-AzKeyVaultKey.md) + +[Remove-AzKeyVaultKey](./Remove-AzKeyVaultKey.md) + +[Undo-AzKeyVaultKeyRemoval](./Undo-AzKeyVaultKeyRemoval.md) diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultKeyRotationPolicy.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultKeyRotationPolicy.md new file mode 100644 index 0000000000..137af24666 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultKeyRotationPolicy.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultkeyrotationpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultKeyRotationPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultKeyRotationPolicy.md +--- + +# Get-AzKeyVaultKeyRotationPolicy + +## SYNOPSIS +Gets the key rotation policy for the specified key in Key Vault. + +## SYNTAX + +### ByVaultName (Default) +``` +Get-AzKeyVaultKeyRotationPolicy [-VaultName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByKeyInputObject +``` +Get-AzKeyVaultKeyRotationPolicy [-InputObject] <PSKeyVaultKeyIdentityItem> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet requires the keys/get permission. It returns key rotation policy for the specified key. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzKeyVaultKeyRotationPolicy -VaultName test-kv -Name test-key +``` + +```output +Id : +VaultName : test-kv +KeyName : test-key +LifetimeActions : {[Action: Notify, TimeAfterCreate: , TimeBeforeExpiry: P30D]} +ExpiresIn : +CreatedOn : +UpdatedOn : +``` + +This cmdlet gets the key rotation policy for test-kv. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Key object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem +Parameter Sets: ByKeyInputObject +Aliases: Key + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Key name. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: KeyName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyRotationPolicy + +## NOTES + +## RELATED LINKS + +[Set-AzKeyVaultKeyRotationPolicy.md](./Set-AzKeyVaultKeyRotationPolicy.md) + +[Invoke-AzKeyVaultKeyRotation.md](./Invoke-AzKeyVaultKeyRotation.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultManagedHsm.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultManagedHsm.md new file mode 100644 index 0000000000..1d70124bc0 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultManagedHsm.md @@ -0,0 +1,259 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultmanagedhsm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultManagedHsm.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultManagedHsm.md +--- + +# Get-AzKeyVaultManagedHsm + +## SYNOPSIS +Get managed HSMs. + +## SYNTAX + +### GetManagedHsm +``` +Get-AzKeyVaultManagedHsm [[-Name] <String>] [[-ResourceGroupName] <String>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### GetDeletedManagedHsm +``` +Get-AzKeyVaultManagedHsm [-Name] <String> [-Location] <String> [-InRemovedState] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ListDeletedManagedHsms +``` +Get-AzKeyVaultManagedHsm [-InRemovedState] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzKeyVaultManagedHsm** cmdlet gets information about the managed HSMs in a subscription. You can +view all managed HSMs instances in a subscription, or filter your results by a resource group or a +particular managed HSM. +Note that although specifying the resource group is optional for this cmdlet when you get a single +managed HSM, you should do so for better performance. + +## EXAMPLES + +### Example 1: Get all managed HSMs in your current subscription +```powershell +Get-AzKeyVaultManagedHsm +``` + +```output +Name Resource Group Name Location SKU +---- ------------------- -------- --- +myhsm myrg1 eastus2euap StandardB1 +``` + +This command gets all managed HSMs in your current subscription. + +### Example 2: Get a specific managed HSM +```powershell +Get-AzKeyVaultManagedHsm -Name 'myhsm' +``` + +```output +Name Resource Group Name Location SKU +---- ------------------- -------- --- +myhsm myrg1 eastus2euap StandardB1 +``` + +This command gets the managed HSM named myhsm in your current subscription. + +### Example 3: Get managed HSMs in a resource group +```powershell +Get-AzKeyVaultManagedHsm -ResourceGroupName 'myrg1' +``` + +```output +Name Resource Group Name Location SKU +---- ------------------- -------- --- +myhsm myrg1 eastus2euap StandardB1 +``` + +This command gets all managed HSMs in the resource group named myrg1. + +### Example 4: Get managed HSMs using filtering +```powershell +Get-AzKeyVaultManagedHsm -Name 'myhsm*' +``` + +```output +Name Resource Group Name Location SKU +---- ------------------- -------- --- +myhsm myrg1 eastus2euap StandardB1 +``` + +This command gets all managed HSMs in the subscription that start with "myhsm". + +### Example 5: List deleted managed HSMs +```powershell +Get-AzKeyVaultManagedHsm -InRemovedState +``` +```output +Name Location DeletionDate ScheduledPurgeDate Purge Protection Enabled? +---- -------- ------------ ------------------ ------------------------- +xxxxxxxx-mhsm-4op2n2g4xe eastus2 12/30/2021 2:29:00 AM 3/30/2022 2:29:00 AM True +xxxxxxx-mhsm-ertopo7tnxa westus 12/29/2021 11:48:42 PM 3/29/2022 11:48:42 PM True +xxxxxxx-mhsm-gg66fgctz67 westus 12/29/2021 11:48:42 PM 3/29/2022 11:48:42 PM False +xxxxxxx-mhsm-2m5jiop6mfo westcentralus 12/30/2021 12:26:14 AM 3/30/2022 12:26:14 AM True +``` + +This command gets all deleted managed HSMs in current subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InRemovedState +Specifies whether to show the previously deleted managed HSM pool in the output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetDeletedManagedHsm, ListDeletedManagedHsms +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the deleted managed HSM pool. + +```yaml +Type: System.String +Parameter Sets: GetDeletedManagedHsm +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +HSM name. Cmdlet constructs the FQDN of a HSM based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: GetManagedHsm +Aliases: HsmName + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: GetDeletedManagedHsm +Aliases: HsmName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the resource group associated with the managed HSM being queried. + +```yaml +Type: System.String +Parameter Sets: GetManagedHsm +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specifies the key and optional value of the specified tag to filter the list of managed HSMs by. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedManagedHsm + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultIdentityItem + +## NOTES + +## RELATED LINKS + +[New-AzKeyVaultManagedHsm](./New-AzKeyVaultManagedHsm.md) + +[Remove-AzKeyVaultManagedHsm](./Remove-AzKeyVaultManagedHsm.md) + +[Update-AzKeyVaultManagedHsm](./Update-AzKeyVaultManagedHsm.md) + +[Undo-AzKeyVaultManagedHsmRemoval](./Undo-AzKeyVaultManagedHsmRemoval.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultManagedStorageAccount.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultManagedStorageAccount.md new file mode 100644 index 0000000000..23f3269adb --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultManagedStorageAccount.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultmanagedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultManagedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultManagedStorageAccount.md +--- + +# Get-AzKeyVaultManagedStorageAccount + +## SYNOPSIS +Gets Key Vault managed Azure Storage Accounts. + +## SYNTAX + +### ByAccountName (Default) +``` +Get-AzKeyVaultManagedStorageAccount [-VaultName] <String> [[-AccountName] <String>] [-InRemovedState] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObject +``` +Get-AzKeyVaultManagedStorageAccount [-InputObject] <PSKeyVault> [-InRemovedState] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzKeyVaultManagedStorageAccount [-ResourceId] <String> [-InRemovedState] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Key Vault managed Azure Storage Account if the name of the account is specified and the account keys are managed by the specified vault. If the account name is not specified, then all the accounts whose keys are managed by specified vault are listed. + +## EXAMPLES + +### Example 1: List all Key Vault managed Storage Accounts +```powershell +Get-AzKeyVaultManagedStorageAccount -VaultName 'myvault' +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount +Vault Name : myvault +AccountName : mystorageaccount +Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St + orage/storageAccounts/mystorageaccount +Enabled : True +Created : 4/25/2018 1:50:32 AM +Updated : 4/25/2018 1:50:32 AM +Tags : +``` + +Lists all the accounts whose keys are managed by vault 'myvault' + +### Example 2: Get a Key Vault managed Storage Account +```powershell +Get-AzKeyVaultManagedStorageAccount -VaultName 'myvault' -Name 'mystorageaccount' +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount +Vault Name : myvault +AccountName : mystorageaccount +Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/maddie1/providers/Microsoft.St + orage/storageAccounts/mystorageaccount +Active Key Name : key2 +Auto Regenerate Key : False +Regeneration Period : 90.00:00:00 +Enabled : True +Created : 4/25/2018 1:50:32 AM +Updated : 4/25/2018 1:50:32 AM +Tags : +``` + +Gets the details of Key Vault managed Storage Account of 'mystorageaccount' if its keys are managed by vault 'myvault' + +### Example 3: List all Key Vault managed Storage Accounts using filtering +```powershell +Get-AzKeyVaultManagedStorageAccount -VaultName 'myvault' -Name "test*" +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/test1 +Vault Name : myvault +AccountName : test1 +Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St + orage/storageAccounts/test1 +Enabled : True +Created : 4/25/2018 1:50:32 AM +Updated : 4/25/2018 1:50:32 AM +Tags : + +Id : https://myvault.vault.azure.net:443/storage/test2 +Vault Name : myvault +AccountName : test2 +Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St + orage/storageAccounts/test2 +Enabled : True +Created : 4/25/2018 1:50:32 AM +Updated : 4/25/2018 1:50:32 AM +Tags : +``` + +Lists all the accounts whose keys are managed by vault 'myvault' that start with "test" + +## PARAMETERS + +### -AccountName +Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected environment and manged storage account name. + +```yaml +Type: System.String +Parameter Sets: ByAccountName +Aliases: StorageAccountName, Name + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Vault object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InRemovedState +Specifies whether to show the previously deleted storage accounts in the output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Vault resource id. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: ByAccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccount + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageAccountIdentityItem + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageAccount + +## NOTES + +## RELATED LINKS + +[Azure PowerShell Key Vault cmdlets](/powershell/module/az.keyvault/) + diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultManagedStorageSasDefinition.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultManagedStorageSasDefinition.md new file mode 100644 index 0000000000..8bbb4b84d8 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultManagedStorageSasDefinition.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultmanagedstoragesasdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultManagedStorageSasDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultManagedStorageSasDefinition.md +--- + +# Get-AzKeyVaultManagedStorageSasDefinition + +## SYNOPSIS +Gets Key Vault managed Storage SAS Definitions. + +## SYNTAX + +### ByDefinitionName (Default) +``` +Get-AzKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [[-Name] <String>] + [-InRemovedState] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObject +``` +Get-AzKeyVaultManagedStorageSasDefinition [-InputObject] <PSKeyVaultManagedStorageAccountIdentityItem> + [[-Name] <String>] [-InRemovedState] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Key Vault managed Storage SAS Definition if the name of the definition is specified. If the definition name is not specified, then all the SAS definitions associated with the specified Key Vault managed Storage Account in the vault are listed. + +## EXAMPLES + +### Example 1: List all Key Vault managed Storage SAS Definitions +```powershell +Get-AzKeyVaultManagedStorageSasDefinition -VaultName 'myvault' -AccountName 'mystorageaccount' +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount/sas/accountsas +Vault Name : myvault +AccountName : mystorageaccount +Name : accountsas +Enabled : True +Created : 5/24/2018 9:11:08 PM +Updated : 5/24/2018 9:11:08 PM +Tags : +``` + +Lists all the SAS definitions associated with Key Vault managed Storage Account 'mystorageaccount' managed by vault 'myvault' + +### Example 2: Get a Key Vault managed Storage Account +```powershell +Get-AzKeyVaultManagedStorageSasDefinition -VaultName 'myvault' -AccountName 'mystorageaccount' -Name 'accountsas' +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount/sas/accountsas +Secret Id : https://myvault.vault.azure.net/secrets/mystorageaccount-accountsas +Vault Name : myvault +AccountName : mystorageaccount +Name : accountsas +Parameter : +Enabled : True +Created : 5/24/2018 9:11:08 PM +Updated : 5/24/2018 9:11:08 PM +Tags : +``` + +Gets the details of SAS Definition 'accountsas' associated with Key Vault managed Storage Account 'mystorageaccount' managed by vault 'myvault'. + +### Example 3: List all Key Vault managed Storage SAS Definitions using filtering +```powershell +Get-AzKeyVaultManagedStorageSasDefinition -VaultName 'myvault' -AccountName 'mystorageaccount' -Name "account*" +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount/sas/accountsas1 +Vault Name : myvault +AccountName : mystorageaccount +Name : accountsas1 +Enabled : True +Created : 5/24/2018 9:11:08 PM +Updated : 5/24/2018 9:11:08 PM +Tags : + +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount/sas/accountsas2 +Vault Name : myvault +AccountName : mystorageaccount +Name : accountsas2 +Enabled : True +Created : 5/24/2018 9:11:08 PM +Updated : 5/24/2018 9:11:08 PM +Tags : +``` + +Lists all the SAS definitions associated with Key Vault managed Storage Account 'mystorageaccount' managed by vault 'myvault' that start with "account". + +## PARAMETERS + +### -AccountName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: ByDefinitionName +Aliases: StorageAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +ManagedStorageAccount object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InRemovedState +Specifies whether to show the previously deleted storage sas definitions in the output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Storage sas definition name. +Cmdlet constructs the FQDN of a storage sas definition from vault name, currently selected environment, storage account name and sas definition name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SasDefinitionName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: ByDefinitionName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageSasDefinitionIdentityItem + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageSasDefinition + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageSasDefinition + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageSasDefinitionIdentityItem + +## NOTES + +## RELATED LINKS + +[Remove-AzKeyVaultManagedStorageSasDefinition](./Remove-AzKeyVaultManagedStorageSasDefinition.md) + +[Set-AzKeyVaultManagedStorageSasDefinition](./Set-AzKeyVaultManagedStorageSasDefinition.md) + +[Undo-AzKeyVaultManagedStorageSasDefinitionRemoval](./Undo-AzKeyVaultManagedStorageSasDefinitionRemoval.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultRandomNumber.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultRandomNumber.md new file mode 100644 index 0000000000..4f52e87144 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultRandomNumber.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultrandomnumber +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultRandomNumber.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultRandomNumber.md +--- + +# Get-AzKeyVaultRandomNumber + +## SYNOPSIS +Get the requested number of bytes containing random values from a managed HSM. + +## SYNTAX + +### GetByHsmName (Default) +``` +Get-AzKeyVaultRandomNumber [-DefaultProfile <IAzureContextContainer>] [-HsmName] <String> -Count <Int32> + [-AsBase64String] [<CommonParameters>] +``` + +### GetByHsmResourceId +``` +Get-AzKeyVaultRandomNumber [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] -Count <Int32> + [-AsBase64String] [<CommonParameters>] +``` + +### GetByHsmInputObject +``` +Get-AzKeyVaultRandomNumber [-DefaultProfile <IAzureContextContainer>] [-InputObject] <PSManagedHsm> + -Count <Int32> [-AsBase64String] [<CommonParameters>] +``` + +## DESCRIPTION +Get the requested number of bytes containing random values from a managed HSM. + +## EXAMPLES + +### Example 1: Get requested number of random bytes by managed HSM name +```powershell +Get-AzKeyVaultRandomNumber -HsmName testmhsm -Count 10 +``` + +```output +158 +171 +96 +142 +109 +28 +1 +85 +178 +201 +``` + +This command gets 10 random bytes from managed HSM "testmhsm" + +### Example 2: Get random number as base64 string by piping +```powershell +Get-AzKeyVaultManagedHsm -HsmName bezmhsm2022 | Get-AzKeyVaultRandomNumber -Count 10 -AsBase64String +``` + +```output +G1CsEqa9yUp/EA== +``` + +This command gets 10 random bytes as base-64 string from managed HSM "testmhsm" + +### Example 3: Get random number by resource id +```powershell +Get-AzKeyVaultRandomNumber -ResourceId /subscriptions/0b1fxxxx-xxxx-xxxx-aec3-xxxx72f09590/resourceGroups/test-rg/provders/Microsoft.KeyVault/managedHSMs/testhsm -Count 10 +``` + +```output +158 +171 +96 +142 +109 +28 +1 +85 +178 +201 +``` + +This command gets 10 random bytes from managed HSM with specified resource id + +## PARAMETERS + +### -AsBase64String +If specified, return random number as base-64 digit. +By default, this command retruns random number as byte array. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +The requested number of random bytes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +HSM name. Cmdlet constructs the FQDN of a managed HSM based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: GetByHsmName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +HSM object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm +Parameter Sets: GetByHsmInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceId +HSM resource id. + +```yaml +Type: System.String +Parameter Sets: GetByHsmResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm + +## OUTPUTS + +### System.String + +### System.Byte + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultRoleAssignment.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultRoleAssignment.md new file mode 100644 index 0000000000..21aff69a1d --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultRoleAssignment.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultRoleAssignment.md +--- + +# Get-AzKeyVaultRoleAssignment + +## SYNOPSIS +Get or list role assignments of a managed HSM. Use respective parameters to list assignments to a specific user or a role definition. + +## SYNTAX + +### List (Default) +``` +Get-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] [-RoleDefinitionName <String>] + [-RoleDefinitionId <String>] [-ObjectId <String>] [-SignInName <String>] [-ApplicationId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByName +``` +Get-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] -RoleAssignmentName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Use the `Get-AzKeyVaultRoleAssignment` command to list all role assignments that are effective on a scope. +Without any parameters, this command returns all the role assignments made under the managed HSM. +This list can be filtered using filtering parameters for principal, role and scope. +The subject of the assignment must be specified. +To specify a user, use SignInName or Azure AD ObjectId parameters. +To specify a security group, use Azure AD ObjectId parameter. +And to specify an Azure AD application, use ApplicationId or ObjectId parameters. +The role that is being assigned must be specified using the RoleDefinitionName or RoleDefinitionId parameter. +The scope at which access is being granted may be specified. It defaults to "/". + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /directoryObjects/{id} +- GET /users/{id} +- GET /servicePrincipals/{id} +- GET /groups/{id} + +## EXAMPLES + +### Example 1 +```powershell +Get-AzKeyVaultRoleAssignment -HsmName myHsm +``` + +```output +RoleDefinitionName DisplayName ObjectType Scope +------------------ ----------- ---------- ----- +Managed HSM Administrator User 1 (user1@microsoft.com) User / +Managed HSM Crypto Auditor User 2 (user2@microsoft.com) User /keys +Managed HSM Backup User 2 (user2@microsoft.com) User / +Managed HSM Administrator User 2 (user2@microsoft.com) User / +``` + +This example lists all role assignments of "myHsm" on all the scope. + +### Example 2 +```powershell +Get-AzKeyVaultRoleAssignment -HsmName myHsm -SignInName user1@microsoft.com -Scope "/keys" +``` + +```output +RoleDefinitionName DisplayName ObjectType Scope +------------------ ----------- ---------- ----- +Managed HSM Crypto Auditor User 1 (user1@microsoft.com) User /keys +Managed HSM Backup User 1 (user1@microsoft.com) User /keys +``` + +This example lists all role assignments of "myHsm" on "/keys" scope and filters the result by user sign-in name. + +## PARAMETERS + +### -ApplicationId +The app SPN. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: SPN, ServicePrincipalName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +Name of the HSM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The user or group object id. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: Id, PrincipalId + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleAssignmentName +Name of the role assignment. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +Role Id the principal is assigned to. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: RoleId + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionName +Name of the RBAC role to assign the principal with. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: RoleName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Scope at which the role assignment or definition applies to, e.g., '/' or '/keys' or '/keys/{keyName}'. +'/' is used when omitted. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignInName +The user SignInName. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: Email, UserPrincipalName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultRoleAssignment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultRoleDefinition.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultRoleDefinition.md new file mode 100644 index 0000000000..877903065c --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultRoleDefinition.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultRoleDefinition.md +--- + +# Get-AzKeyVaultRoleDefinition + +## SYNOPSIS +List role definitions of a given managed HSM at a given scope. + +## SYNTAX + +### Interactive (Default) +``` +Get-AzKeyVaultRoleDefinition [-HsmName] <String> [-Scope <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### CustomOnly +``` +Get-AzKeyVaultRoleDefinition [-HsmName] <String> [-Scope <String>] [-Custom] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByName +``` +Get-AzKeyVaultRoleDefinition [-HsmName] <String> [-Scope <String>] -RoleDefinitionName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +List role definitions of a given managed HSM at a given scope. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzKeyVaultRoleDefinition -HsmName myHsm -Scope "/keys" +``` + +```output +RoleName Description Permissions +-------- ----------- ----------- +Managed HSM Administrator 1 permission(s) +Managed HSM Crypto Officer 1 permission(s) +Managed HSM Crypto User 1 permission(s) +Managed HSM Policy Administrator 1 permission(s) +Managed HSM Crypto Auditor 1 permission(s) +Managed HSM Crypto Service Encryption 1 permission(s) +Managed HSM Backup 1 permission(s) +``` + +The example lists all the roles at "/keys" scope. + +### Example 2 +<!-- Skip: Output cannot be splitted from code --> +```powershell +$backupRole = Get-AzKeyVaultRoleDefinition -HsmName myHsm -RoleDefinitionName "Managed HSM Backup User" + +$backupRole.Permissions + +Actions NotActions DataActions NotDataActions +------- ---------- ----------- -------------- +0 action(s) 0 action(s) 3 action(s) 0 action(s) + +$backupRole.Permissions.DataActions + +Microsoft.KeyVault/managedHsm/backup/start/action +Microsoft.KeyVault/managedHsm/backup/status/action +Microsoft.KeyVault/managedHsm/keys/backup/action +``` + +The example gets the "Managed HSM Backup" role and inspects its permissions. + +### Example 3 +```powershell +Get-AzKeyVaultRoleDefinition -HsmName myHsm -Custom +``` + +This example lists all the custom role definitions belong to "myHsm". + +## PARAMETERS + +### -Custom +If specified, only displays the custom created roles in the directory. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CustomOnly +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +Name of the HSM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionName +Name of the role definition to get. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: RoleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Scope at which the role assignment or definition applies to, e.g., '/' or '/keys' or '/keys/{keyName}'. +'/' is used when omitted. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultRoleDefinition + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultSecret.md b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultSecret.md new file mode 100644 index 0000000000..e23f89e541 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Get-AzKeyVaultSecret.md @@ -0,0 +1,487 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 8C9B33EE-10DE-4803-B76D-FE9FC2AC3372 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/get-azkeyvaultsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Get-AzKeyVaultSecret.md +--- + +# Get-AzKeyVaultSecret + +## SYNOPSIS +Gets the secrets in a key vault. + +## SYNTAX + +### ByVaultName (Default) +``` +Get-AzKeyVaultSecret [-VaultName] <String> [[-Name] <String>] [-InRemovedState] [-AsPlainText] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### BySecretName +``` +Get-AzKeyVaultSecret [-VaultName] <String> [-Name] <String> [-Version] <String> [-AsPlainText] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### BySecretVersions +``` +Get-AzKeyVaultSecret [-VaultName] <String> [-Name] <String> [-IncludeVersions] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObjectVaultName +``` +Get-AzKeyVaultSecret [-InputObject] <PSKeyVault> [[-Name] <String>] [-InRemovedState] [-AsPlainText] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObjectSecretName +``` +Get-AzKeyVaultSecret [-InputObject] <PSKeyVault> [-Name] <String> [-Version] <String> [-AsPlainText] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObjectSecretVersions +``` +Get-AzKeyVaultSecret [-InputObject] <PSKeyVault> [-Name] <String> [-IncludeVersions] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdVaultName +``` +Get-AzKeyVaultSecret [-ResourceId] <String> [[-Name] <String>] [-InRemovedState] [-AsPlainText] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdSecretName +``` +Get-AzKeyVaultSecret [-ResourceId] <String> [-Name] <String> [-Version] <String> [-AsPlainText] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdSecretVersions +``` +Get-AzKeyVaultSecret [-ResourceId] <String> [-Name] <String> [-IncludeVersions] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzKeyVaultSecret** cmdlet gets secrets in a key vault. +This cmdlet gets a specific secret or all the secrets in a key vault. + +## EXAMPLES + +### Example 1: Get all current versions of all secrets in a key vault +```powershell +Get-AzKeyVaultSecret -VaultName 'Contoso' +``` + +```output +Vault Name : contoso +Name : secret1 +Version : +Id : https://contoso.vault.azure.net:443/secrets/secret1 +Enabled : True +Expires : 4/6/2018 3:59:43 PM +Not Before : +Created : 4/5/2018 11:46:28 PM +Updated : 4/6/2018 11:30:17 PM +Content Type : +Tags : + +Vault Name : contoso +Name : secret2 +Version : +Id : https://contoso.vault.azure.net:443/secrets/secret2 +Enabled : True +Expires : +Not Before : +Created : 4/11/2018 11:45:06 PM +Updated : 4/11/2018 11:45:06 PM +Content Type : +Tags : +``` + +This command gets the current versions of all secrets in the key vault named Contoso. + +### Example 2: Get all versions of a specific secret +```powershell +Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -IncludeVersions +``` + +```output +Vault Name : contoso +Name : secret1 +Version : 7128133570f84a71b48d7d0550deb74c +Id : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c +Enabled : True +Expires : 4/6/2018 3:59:43 PM +Not Before : +Created : 4/5/2018 11:46:28 PM +Updated : 4/6/2018 11:30:17 PM +Content Type : +Tags : + +Vault Name : contoso +Name : secret1 +Version : 5d1a74ba2c454439886fb8509b6cab3c +Id : https://contoso.vault.azure.net:443/secrets/secret1/5d1a74ba2c454439886fb8509b6cab3c +Enabled : True +Expires : +Not Before : +Created : 4/5/2018 11:44:50 PM +Updated : 4/5/2018 11:44:50 PM +Content Type : +Tags : +``` + +This command gets all versions of the secret named secret1 in the key vault named Contoso. + +### Example 3: Get the current version of a specific secret +```powershell +Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' +``` + +```output +Vault Name : contoso +Name : secret1 +Version : 7128133570f84a71b48d7d0550deb74c +Id : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c +Enabled : True +Expires : 4/6/2018 3:59:43 PM +Not Before : +Created : 4/5/2018 11:46:28 PM +Updated : 4/6/2018 11:30:17 PM +Content Type : +Tags : +``` + +This command gets the current version of the secret named secret1 in the key vault named Contoso. + +### Example 4: Get a specific version of a specific secret +```powershell +Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -Version '5d1a74ba2c454439886fb8509b6cab3c' +``` + +```output +Vault Name : contoso +Name : secret1 +Version : 5d1a74ba2c454439886fb8509b6cab3c +Id : https://contoso.vault.azure.net:443/secrets/secret1/5d1a74ba2c454439886fb8509b6cab3c +Enabled : True +Expires : +Not Before : +Created : 4/5/2018 11:44:50 PM +Updated : 4/5/2018 11:44:50 PM +Content Type : +Tags : +``` + +This command gets a specific version of the secret named secret1 in the key vault named Contoso. + +### Example 5: Get the plain text value of the current version of a specific secret +```powershell +$secretText = Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -AsPlainText +``` + +The cmdlet returns the secret as a string when `-AsPlainText` is applied. + +**Note:** When listing secrets, i.e. not providing `-Name`, the `-AsPlainText` is ignored. + +### Example 6: Get all the secrets that have been deleted but not purged for this key vault. +```powershell +Get-AzKeyVaultSecret -VaultName 'Contoso' -InRemovedState +``` + +```output +Vault Name : contoso +Name : secret1 +Id : https://contoso.vault.azure.net:443/secrets/secret1 +Deleted Date : 4/4/2018 8:51:58 PM +Scheduled Purge Date : 7/3/2018 8:51:58 PM +Enabled : True +Expires : +Not Before : +Created : 4/4/2018 8:51:03 PM +Updated : 4/4/2018 8:51:03 PM +Content Type : +Tags : + +Vault Name : contoso +Name : secret2 +Id : https://contoso.vault.azure.net:443/secrets/secret2 +Deleted Date : 5/7/2018 7:56:34 PM +Scheduled Purge Date : 8/5/2018 7:56:34 PM +Enabled : True +Expires : +Not Before : +Created : 4/6/2018 8:39:15 PM +Updated : 4/6/2018 10:11:24 PM +Content Type : +Tags : +``` + +This command gets all the secrets that have been previously deleted, but not purged, in the key vault named Contoso. + +### Example 7: Gets the secret ITSecret that has been deleted but not purged for this key vault. +```powershell +Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -InRemovedState +``` + +```output +Vault Name : contoso +Name : secret1 +Version : 689d23346e9c42a2a64f4e3d75094dcc +Id : https://contoso.vault.azure.net:443/secrets/secret1/689d23346e9c42a2a64f4e3d75094dcc +Deleted Date : 4/4/2018 8:51:58 PM +Scheduled Purge Date : 7/3/2018 8:51:58 PM +Enabled : True +Expires : +Not Before : +Created : 4/4/2018 8:51:03 PM +Updated : 4/4/2018 8:51:03 PM +Content Type : +Tags : +``` + +This command gets the secret 'secret1' that has been previously deleted, but not purged, in the key vault named Contoso. +This command will return metadata such as the deletion date, and the scheduled purging date of this deleted secret. + +### Example 8: Get all current versions of all secrets in a key vault using filtering +```powershell +Get-AzKeyVaultSecret -VaultName 'Contoso' -Name "secret*" +``` + +```output +Vault Name : contoso +Name : secret1 +Version : +Id : https://contoso.vault.azure.net:443/secrets/secret1 +Enabled : True +Expires : 4/6/2018 3:59:43 PM +Not Before : +Created : 4/5/2018 11:46:28 PM +Updated : 4/6/2018 11:30:17 PM +Content Type : +Tags : + +Vault Name : contoso +Name : secret2 +Version : +Id : https://contoso.vault.azure.net:443/secrets/secret2 +Enabled : True +Expires : +Not Before : +Created : 4/11/2018 11:45:06 PM +Updated : 4/11/2018 11:45:06 PM +Content Type : +Tags : +``` + +This command gets the current versions of all secrets in the key vault named Contoso that start with "secret". + +### Example 9: Get a secret in Azure Key Vault by command Get-Secret in module Microsoft.PowerShell.SecretManagement +```powershell +# Install module Microsoft.PowerShell.SecretManagement +Install-Module Microsoft.PowerShell.SecretManagement -Repository PSGallery -AllowPrerelease +# Register vault for Secret Management +Register-SecretVault -Name AzKeyVault -ModuleName Az.KeyVault -VaultParameters @{ AZKVaultName = 'test-kv'; SubscriptionId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' } +# Set secret for vault AzKeyVault +$secure = ConvertTo-SecureString -String "Password" -AsPlainText -Force +Set-Secret -Vault AzKeyVault -Name secureSecret -SecureStringSecret $secure +Get-Secret -Vault AzKeyVault -Name secureSecret -AsPlainText +``` + +```output +Password +``` + +This example Gets a secret named `secureSecret` in Azure Key Vault named `test-kv` by command `Get-Secret` in module `Microsoft.PowerShell.SecretManagement`. + +## PARAMETERS + +### -AsPlainText +When set, the cmdlet will convert secret in secure string to the decrypted plaintext string as output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByVaultName, BySecretName, ByInputObjectVaultName, ByInputObjectSecretName, ByResourceIdVaultName, ByResourceIdSecretName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeVersions +Indicates that this cmdlet gets all versions of a secret. +The current version of a secret is the first one on the list. +If you specify this parameter you must also specify the *Name* and *VaultName* parameters. +If you do not specify the *IncludeVersions* parameter, this cmdlet gets the current version of the secret with the specified *Name*. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BySecretVersions, ByInputObjectSecretVersions, ByResourceIdSecretVersions +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault Object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByInputObjectVaultName, ByInputObjectSecretName, ByInputObjectSecretVersions +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InRemovedState +Specifies whether to show the previously deleted secrets in the output + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByVaultName, ByInputObjectVaultName, ByResourceIdVaultName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the secret to get. + +```yaml +Type: System.String +Parameter Sets: ByVaultName, ByInputObjectVaultName, ByResourceIdVaultName +Aliases: SecretName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: BySecretName, BySecretVersions, ByInputObjectSecretName, ByInputObjectSecretVersions, ByResourceIdSecretName, ByResourceIdSecretVersions +Aliases: SecretName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceId +KeyVault Resource Id. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdVaultName, ByResourceIdSecretName, ByResourceIdSecretVersions +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault to which the secret belongs. +This cmdlet constructs the fully qualified domain name (FQDN) of a key vault based on the name that this parameter specifies and your current environment. + +```yaml +Type: System.String +Parameter Sets: ByVaultName, BySecretName, BySecretVersions +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Specifies the secret version. +This cmdlet constructs the FQDN of a secret based on the key vault name, your currently selected environment, the secret name, and the secret version. + +```yaml +Type: System.String +Parameter Sets: BySecretName, ByInputObjectSecretName, ByResourceIdSecretName +Aliases: SecretVersion + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecret + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultSecretIdentityItem + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultSecret + +## NOTES + +## RELATED LINKS + +[Remove-AzKeyVaultSecret](./Remove-AzKeyVaultSecret.md) + +[Undo-AzKeyVaultSecretRemoval](./Undo-AzKeyVaultSecretRemoval.md) + +[Set-AzKeyVaultSecret](./Set-AzKeyVaultSecret.md) + diff --git a/azps-10.1.0/Az.KeyVault/Import-AzKeyVaultCertificate.md b/azps-10.1.0/Az.KeyVault/Import-AzKeyVaultCertificate.md new file mode 100644 index 0000000000..086af1614c --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Import-AzKeyVaultCertificate.md @@ -0,0 +1,399 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: D4188DC6-A8AB-4B45-9781-94B74C338C63 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/import-azkeyvaultcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Import-AzKeyVaultCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Import-AzKeyVaultCertificate.md +--- + +# Import-AzKeyVaultCertificate + +## SYNOPSIS +Imports a certificate to a key vault. + +## SYNTAX + +### ImportCertificateFromFile (Default) +``` +Import-AzKeyVaultCertificate [-VaultName] <String> [-Name] <String> -FilePath <String> + [-Password <SecureString>] [-PolicyPath <String>] [-PolicyObject <PSKeyVaultCertificatePolicy>] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ImportWithPrivateKeyFromString +``` +Import-AzKeyVaultCertificate [-VaultName] <String> [-Name] <String> -CertificateString <String> + [-ContentType <String>] [-Password <SecureString>] [-PolicyPath <String>] + [-PolicyObject <PSKeyVaultCertificatePolicy>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ImportWithPrivateKeyFromCollection +``` +Import-AzKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-PolicyPath <String>] + [-PolicyObject <PSKeyVaultCertificatePolicy>] [-CertificateCollection] <X509Certificate2Collection> + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Import-AzKeyVaultCertificate** cmdlet imports a certificate into a key vault. +You can create the certificate to import by using one of the following methods: +- Use `Add-AzKeyVaultCertificate` to create a certificate signing request and submit it to a certificate authority. See https://learn.microsoft.com/azure/key-vault/certificates/create-certificate-signing-request +- Use an existing certificate package file, such as a .pfx or .p12 file, which contains both the certificate and private key. + +## EXAMPLES + +### Example 1: Import a key vault certificate +```powershell +$Password = ConvertTo-SecureString -String "123" -AsPlainText -Force +Import-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "ImportCert01" -FilePath "C:\Users\contosoUser\Desktop\import.pfx" -Password $Password +``` + +```output +Name : importCert01 +Certificate : [Subject] + CN=contoso.com + + [Issuer] + CN=contoso.com + + [Serial Number] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + [Not Before] + 2/8/2016 3:11:45 PM + + [Not After] + 8/8/2016 4:21:45 PM + + [Thumbprint] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + +Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +Tags : +Enabled : True +Created : 2/8/2016 11:50:43 PM +Updated : 2/8/2016 11:50:43 PM +``` + +The first command uses the ConvertTo-SecureString cmdlet to create a secure password, and then +stores it in the $Password variable. +The second command imports the certificate named ImportCert01 into the CosotosoKV01 key vault. + +### Example 2: Import a key vault certificate by CertificateString +```powershell +$Password = ConvertTo-SecureString -String "123" -AsPlainText -Force +$Base64String = [System.Convert]::ToBase64String([System.IO.File]::ReadAllBytes("import.pfx")) +Import-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "ImportCert01" -CertificateString $Base64String -Password $Password +``` + +```output +Name : importCert01 +Certificate : [Subject] + CN=contoso.com + + [Issuer] + CN=contoso.com + + [Serial Number] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + [Not Before] + 2/8/2016 3:11:45 PM + + [Not After] + 8/8/2016 4:21:45 PM + + [Thumbprint] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + +Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +Tags : +Enabled : True +Created : 2/8/2016 11:50:43 PM +Updated : 2/8/2016 11:50:43 PM +``` + +The first command uses the ConvertTo-SecureString cmdlet to create a secure password, and then +stores it in the $Password variable. +The second command reads a certificate as a Base64 encoded representation. +The third command imports the certificate named ImportCert01 into the CosotosoKV01 key vault. + +### Example 3: Import a key vault certificate with PolicyFile +```powershell +$Password = ConvertTo-SecureString -String "123" -AsPlainText -Force +Import-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "ImportCert01" -FilePath "C:\Users\contosoUser\Desktop\import.pfx" -Password $Password -PolicyPath "C:\Users\contosoUser\Desktop\policy.json" +``` + +```output +Name : importCert01 +Certificate : [Subject] + CN=contoso.com + + [Issuer] + CN=contoso.com + + [Serial Number] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + [Not Before] + 2/8/2016 3:11:45 PM + + [Not After] + 8/8/2016 4:21:45 PM + + [Thumbprint] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + +KeyId : https://ContosoKV01.vault.azure.net/keys/ImportCert01/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +SecretId : https://ContosoKV01.vault.azure.net/secrets/ImportCert01/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +Policy : + Secret Content Type: application/x-pkcs12 + Issuer Name : Unknown + Created On : 3/22/2023 6:00:52 AM + Updated On : 4/27/2023 9:52:53 AM + ... +RecoveryLevel : Recoverable+Purgeable +Enabled : True +Expires : 6/9/2023 6:20:26 AM +NotBefore : 3/11/2023 6:20:26 AM +Created : 4/24/2023 9:05:51 AM +Updated : 4/24/2023 9:05:51 AM +Tags : {} +VaultName : ContosoKV01 +Name : ImportCert01 +Version : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +Id : https://ContosoKV01.vault.azure.net/certificates/ImportCert01/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +``` + +The first command uses the ConvertTo-SecureString cmdlet to create a secure password, and then +stores it in the $Password variable. +The second command imports the certificate named ImportCert01 into the CosotosoKV01 key vault with +a policy defined by file. + +## PARAMETERS + +### -CertificateCollection +Specifies the certificate collection to add to a key vault. + +```yaml +Type: System.Security.Cryptography.X509Certificates.X509Certificate2Collection +Parameter Sets: ImportWithPrivateKeyFromCollection +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertificateString +Base64 encoded representation of the certificate object to import. This certificate needs to contain the private key. + +```yaml +Type: System.String +Parameter Sets: ImportWithPrivateKeyFromString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentType +Specifies the type of the certificate to be imported. Regards certificate string as PFX format by default. + +```yaml +Type: System.String +Parameter Sets: ImportWithPrivateKeyFromString +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +Specifies the path of the certificate file that this cmdlet imports. + +```yaml +Type: System.String +Parameter Sets: ImportCertificateFromFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the certificate name. This cmdlet constructs the fully qualified domain name (FQDN) of a +certificate from key vault name, currently selected environment, and certificate name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CertificateName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Password +Specifies the password for a certificate file. + +```yaml +Type: System.Security.SecureString +Parameter Sets: ImportCertificateFromFile, ImportWithPrivateKeyFromString +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyObject +An in-memory object to specify management policy for the certificate. Mutual-exclusive to PolicyPath. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PolicyPath +A file path to specify management policy for the certificate that contains JSON encoded policy definition. Mutual-exclusive to PolicyObject. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the key vault name into which this cmdlet imports certificates. +This cmdlet constructs the fully qualified domain name (FQDN) of a key vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Security.Cryptography.X509Certificates.X509Certificate2Collection + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate + +## NOTES + +## RELATED LINKS + +[Remove-AzKeyVaultCertificate](./Remove-AzKeyVaultCertificate.md) + +[Creating and merging CSR in Key Vault](https://learn.microsoft.com/azure/key-vault/certificates/create-certificate-signing-request) diff --git a/azps-10.1.0/Az.KeyVault/Import-AzKeyVaultSecurityDomain.md b/azps-10.1.0/Az.KeyVault/Import-AzKeyVaultSecurityDomain.md new file mode 100644 index 0000000000..a071e526fe --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Import-AzKeyVaultSecurityDomain.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/import-azkeyvaultsecuritydomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Import-AzKeyVaultSecurityDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Import-AzKeyVaultSecurityDomain.md +--- + +# Import-AzKeyVaultSecurityDomain + +## SYNOPSIS +Imports previously exported security domain data to a managed HSM. + +## SYNTAX + +### ByName (Default) +``` +Import-AzKeyVaultSecurityDomain -Keys <KeyPath[]> -SecurityDomainPath <String> [-PassThru] -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ByInputObject +``` +Import-AzKeyVaultSecurityDomain -Keys <KeyPath[]> -SecurityDomainPath <String> [-PassThru] + -InputObject <PSKeyVaultIdentityItem> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet imports previously exported security domain data to a managed HSM. + +## EXAMPLES + +### Example 1 +```powershell +$keys = @{PublicKey = "sd1.cer"; PrivateKey = "sd1.key"}, @{PublicKey = "sd2.cer"; PrivateKey = "sd2.key"}, @{PublicKey = "sd3.cer"; PrivateKey = "sd3.key"} +Import-AzKeyVaultSecurityDomain -Name testmhsm -Keys $keys -SecurityDomainPath sd.ps.json +``` + +First, the keys need be provided to decrypt the security domain data. +Then, The **Import-AzKeyVaultSecurityDomain** command restores previous backed up security domain data to a managed HSM using these keys. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Object representing a managed HSM. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultIdentityItem +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Keys +Information about the keys that are used to decrypt the security domain data. +See examples for how it is constructed. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.SecurityDomain.Models.KeyPath[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the managed HSM. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: HsmName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +When specified, a boolean will be returned when cmdlet succeeds. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityDomainPath +Specify the path to the encrypted security domain data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Path + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultIdentityItem + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Invoke-AzKeyVaultKeyOperation.md b/azps-10.1.0/Az.KeyVault/Invoke-AzKeyVaultKeyOperation.md new file mode 100644 index 0000000000..5c4f616a55 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Invoke-AzKeyVaultKeyOperation.md @@ -0,0 +1,291 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/invoke-azkeyvaultkeyoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Invoke-AzKeyVaultKeyOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Invoke-AzKeyVaultKeyOperation.md +--- + +# Invoke-AzKeyVaultKeyOperation + +## SYNOPSIS +Performs operation like "Encrypt", "Decrypt", "Wrap" or "Unwrap" using a specified key stored in a key vault or managed hsm. + +## SYNTAX + +### ByVaultName (Default) +``` +Invoke-AzKeyVaultKeyOperation -Operation <String> -Algorithm <String> -Value <SecureString> + [-VaultName] <String> [-Name] <String> [-Version <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByHsmName +``` +Invoke-AzKeyVaultKeyOperation -Operation <String> -Algorithm <String> -Value <SecureString> [-HsmName] <String> + [-Name] <String> [-Version <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByKeyInputObject +``` +Invoke-AzKeyVaultKeyOperation -Operation <String> -Algorithm <String> -Value <SecureString> + [-InputObject] <PSKeyVaultKeyIdentityItem> [-Version <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Invoke-AzKeyVaultKeyOperation cmdlet supports +1. Encrypting an arbitrary sequence of bytes using an encryption key. +2. Decrypting a single block of encrypted data. +3. Wrapping a symmetric key using a specified key. +4. Unwrapping a symmetric key using the specified key that was initially used for wrapping that key. + +## EXAMPLES + +### Example 1: Encrypts using an encryption key +```powershell +$result = Invoke-AzKeyVaultKeyOperation -Operation Encrypt -Algorithm RSA1_5 -VaultName test-kv -Name test-key -Value (ConvertTo-SecureString -String "test" -AsPlainText -Force) +$result | Format-List +``` + +```output +KeyId : https://test-kv.vault.azure.net/keys/test-key/bd8b77352a2443d4983bd70e9f660bc6 +Result : iVlA6rHicEm6F9vtU3jARzxWughOcRK9htj4UMy0ijd4a4hHwYrSy4lSXhiQTKSMpX+Qv3NTaz/fKNWdSoudCAwv2ZX/pYlSqZmDoAHzjUc + 4wDQAAVZAUvOxHcpCQf3CrlvQK3XfsZeddeiD9laiUU3iB2Ivh3trX0G/Y29gL54THKsmlwXh5mBhxcXHaUv0erDzEVAGnC73FHlJoHCTdm + 7eUMWvsnfhtd/BhcuBb/CeMy1QzHgoBTrByWms4KsTODBEZt41aVkdYxJDREsC8X6a/1vp9EeV+7jm3sZLl+Dm7XOpUjbR+/BUU7HKaw09i + BRQJGhXf7oyZOf3g6EPEQ== +Algorithm : RSA1_5 +``` + +Encrypts string "test" using test-key stored in test-kv. The `Result` is encrypted result in Base64 string format. + +### Example 2: Decrypt encrypted data +```powershell +$result +$result = Invoke-AzKeyVaultKeyOperation -Operation Decrypt -Algorithm RSA1_5 -VaultName test-kv -Name test-key -Value (ConvertTo-SecureString -String $result.Result -AsPlainText -Force) +$result | Format-List +``` + +```output +KeyId : https://test-kv.vault.azure.net/keys/test-key/bd8b77352a2443d4983bd70e9f660bc6 +Result : test +Algorithm : RSA1_5 +``` + +Decrypts encrypted data that is encrypted using test-key stored in test-kv. The `Result` is a plain string. + +### Example 3: Wraps a symmetric key using a specified key +```powershell +$result = Invoke-AzKeyVaultKeyOperation -Operation Wrap -Algorithm RSA1_5 -VaultName test-kv -Name test-key -Value (ConvertTo-SecureString -String "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo" -AsPlainText -Force) + +$result | Format-List +``` + +```output +KeyId : https://test-kv.vault.azure.net/keys/test-key/375cdf20252043b79c8ca0c57b6c7679 +Result : imHceWcmB5jufcz+qS+HwaXOvPiaeOQ2dF1Bh+2DByuw+AOyoL3wtwDSilP5BlR3DAB3byj4hlUqkEKcoHJpOGnU53mWeV0yhL+Wx0O4T9n + +e54Gtv/sfJD0CcMg+89mssi7hgU0u1IaaowzgSmP7ViRrSVGu8FniAR6hdf7j0JL7ON8IIFMy/+7yq00aJs/dspcESGjcZDry5pLzYphel + x7VAEbjuv1TuiHwu8cJYH/GsvROErOQbQ+aKcKlYTMzZRGdCA07xXltvFrTiCIvzeKE/lTJVIHH/Nv4aRne/ENRC2cx92r9XFhEBID6o5Td + kN09Wdjejo8nLDRw9XbtQ== +Algorithm : RSA1_5 +``` + +Wraps a symmetric key using key named test-key stored in test-kv. The `Result` is wrapped result in Base64 string format. + +### Example 4: Unwraps a symmetric key using a specified key +```powershell +Invoke-AzKeyVaultKeyOperation -Operation Unwrap -Algorithm RSA1_5 -VaultName test-kv -Name test-key -Value (ConvertTo-SecureString -String $result.Result -AsPlainText -Force) +``` + +```output +KeyId : https://test-kv.vault.azure.net/keys/test-key/375cdf20252043b79c8ca0c57b6c7679 +Result : ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo +Algorithm : RSA1_5 +``` + +Unwraps a symmetric key using a specified key test-key stored in test-kv. The `Result` is a plain string. + +## PARAMETERS + +### -Algorithm +Algorithm identifier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: EncryptionAlgorithm, WrapAlgorithm + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +HSM name. + +```yaml +Type: System.String +Parameter Sets: ByHsmName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Key object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem +Parameter Sets: ByKeyInputObject +Aliases: Key + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Key name. + +```yaml +Type: System.String +Parameter Sets: ByVaultName, ByHsmName +Aliases: KeyName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operation +Algorithm identifier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The value to be operated + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Key version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: KeyVersion + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyOperationResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Invoke-AzKeyVaultKeyRotation.md b/azps-10.1.0/Az.KeyVault/Invoke-AzKeyVaultKeyRotation.md new file mode 100644 index 0000000000..bfc4dcc06a --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Invoke-AzKeyVaultKeyRotation.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/invoke-azkeyvaultkeyrotation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Invoke-AzKeyVaultKeyRotation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Invoke-AzKeyVaultKeyRotation.md +--- + +# Invoke-AzKeyVaultKeyRotation + +## SYNOPSIS +Creates a new key version in Key Vault, stores it, then returns the new key. + +## SYNTAX + +### ByVaultName (Default) +``` +Invoke-AzKeyVaultKeyRotation [-VaultName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByKeyInputObject +``` +Invoke-AzKeyVaultKeyRotation [-InputObject] <PSKeyVaultKeyIdentityItem> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The cmdlet will rotate the key based on the key policy. It requires the keys/rotate permission. It will returns a new version of the rotate key. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzKeyVaultKeyRotation -VaultName test-kv -Name test-key +``` + +```output +Vault/HSM Name : test-kv +Name : test-key +Key Type : RSA +Key Size : 2048 +Curve Name : +Version : xxxxxxxxxxxxxx4939xxxxxxxxxxxxxxxx +Id : https://test-kv.vault.azure.net:443/keys/test-key/xxxxxxxxxxxxxx4939xxxxxxxxxxxxxxxx +Enabled : True +Expires : +Not Before : +Created : 12/10/2021 2:57:58 AM +Updated : 12/10/2021 2:57:58 AM +Recovery Level : Recoverable+Purgeable +Tags : +``` + +This cmdlet creates a new key version for test-key. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Key object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem +Parameter Sets: ByKeyInputObject +Aliases: Key + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Key name. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: KeyName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultKeyRotationPolicy.md](./Get-AzKeyVaultKeyRotationPolicy.md) + +[Set-AzKeyVaultKeyRotationPolicy.md](./Set-AzKeyVaultKeyRotationPolicy.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.KeyVault/New-AzKeyVault.md b/azps-10.1.0/Az.KeyVault/New-AzKeyVault.md new file mode 100644 index 0000000000..865cea61f6 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/New-AzKeyVault.md @@ -0,0 +1,454 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 4C40DAC9-5C0B-4AFD-9BDB-D407E0B9F701 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/new-azkeyvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVault.md +--- + +# New-AzKeyVault + +## SYNOPSIS +Creates a key vault. + +## SYNTAX + +``` +New-AzKeyVault [-Name] <String> [-ResourceGroupName] <String> [-Location] <String> [-EnabledForDeployment] + [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-EnablePurgeProtection] + [-EnableRbacAuthorization] [-SoftDeleteRetentionInDays <Int32>] [-PublicNetworkAccess <String>] + [-Sku <String>] [-Tag <Hashtable>] [-NetworkRuleSet <PSKeyVaultNetworkRuleSet>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzKeyVault** cmdlet creates a key vault in the specified resource group. This cmdlet +also grants permissions to the currently logged on user to add, remove, or list keys and secrets in +the key vault. +Note: If you see the error **The subscription is not registered to use namespace +'Microsoft.KeyVault'** when you try to create your new key vault, run +**Register-AzResourceProvider -ProviderNamespace "Microsoft.KeyVault"** and then rerun your +**New-AzKeyVault** command. For more information, see Register-AzResourceProvider. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /directoryObjects/{id} +- GET /users/{id} +- GET /servicePrincipals/{id} +- GET /groups/{id} +- GET /me + +## EXAMPLES + +### Example 1: Create a Standard key vault +```powershell +New-AzKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -Location 'East US' +``` + +```output +Vault Name : contoso03vault +Resource Group Name : group14 +Location : East US +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/group14/providers + /Microsoft.KeyVault/vaults/contoso03vault +Vault URI : https://contoso03vault.vault.azure.net/ +Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +SKU : Standard +Enabled For Deployment? : +Enabled For Template Deployment? : +Enabled For Disk Encryption? : +Soft Delete Enabled? : True +Access Policies : + Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Application ID : + Display Name : User Name (username@microsoft.com) + Permissions to Keys : all + Permissions to Secrets : all + Permissions to Certificates : all + Permissions to (Key Vault Managed) Storage : all + +Network Rule Set : + Default Action : Allow + Bypass : AzureServices + IP Rules : + Virtual Network Rules : + +Tags : +``` + +This command creates a key vault named Contoso03Vault, in the Azure region East US. The command +adds the key vault to the resource group named Group14. Because the command does not specify a +value for the *SKU* parameter, it creates a Standard key vault. + +### Example 2: Create a Premium key vault +```powershell +New-AzKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -Location 'East US' -Sku 'Premium' +``` + +```output +Vault Name : contoso03vault +Resource Group Name : group14 +Location : East US +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/group14/providers + /Microsoft.KeyVault/vaults/contoso03vault +Vault URI : https://contoso03vault.vault.azure.net/ +Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +SKU : Premium +Enabled For Deployment? : False +Enabled For Template Deployment? : False +Enabled For Disk Encryption? : False +Soft Delete Enabled? : +Access Policies : + Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Application ID : + Display Name : User Name (username@microsoft.com) + Permissions to Keys : all + Permissions to Secrets : all + Permissions to Certificates : all + Permissions to (Key Vault Managed) Storage : all + +Network Rule Set : + Default Action : Allow + Bypass : AzureServices + IP Rules : + Virtual Network Rules : + +Tags : +``` + +This command creates a key vault, just like the previous example. However, it specifies a value of +Premium for the *SKU* parameter to create a Premium key vault. + +### Example 3 +```powershell +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "110.0.1.0/24" -ServiceEndpoint Microsoft.KeyVault +$virtualNetwork = New-AzVirtualNetwork -Name myVNet -ResourceGroupName myRG -Location westus -AddressPrefix "110.0.0.0/16" -Subnet $frontendSubnet +$myNetworkResId = (Get-AzVirtualNetwork -Name myVNet -ResourceGroupName myRG).Subnets[0].Id +$ruleSet = New-AzKeyVaultNetworkRuleSetObject -DefaultAction Allow -Bypass AzureServices -IpAddressRange "110.0.1.0/24" -VirtualNetworkResourceId $myNetworkResId +New-AzKeyVault -ResourceGroupName "myRg" -VaultName "myVault" -NetworkRuleSet $ruleSet -Location westus +``` + +```output +Vault Name : myVault +Resource Group Name : myRg +Location : East US +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myRg/providers + /Microsoft.KeyVault/vaults/myVault +Vault URI : https://myVault.vault.azure.net/ +Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +SKU : Premium +Enabled For Deployment? : False +Enabled For Template Deployment? : False +Enabled For Disk Encryption? : False +Soft Delete Enabled? : +Access Policies : + Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Application ID : + Display Name : User Name (username@microsoft.com) + Permissions to Keys : all + Permissions to Secrets : all + Permissions to Certificates : all + Permissions to (Key Vault Managed) Storage : all + +Network Rule Set : + Default Action : Allow + Bypass : AzureServices + IP Rules : 110.0.1.0/24 + Virtual Network Rules : /subscriptions/0b1f6471-1bf0-4dda-ae + c3-cb9272f09590/resourcegroups/myRg/providers/microsoft.network/virtualnetworks + /myvnet/subnets/frontendsubnet + +Tags : +``` +Creating a key vault and specifies network rules to allow access to the specified IP address from the virtual network identified by $myNetworkResId. See `New-AzKeyVaultNetworkRuleSetObject` for more information. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledForDeployment +Enables the Microsoft.Compute resource provider to retrieve secrets from this key vault when this +key vault is referenced in resource creation, for example when creating a virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnabledForDiskEncryption +Enables the Azure disk encryption service to get secrets and unwrap keys from this key vault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnabledForTemplateDeployment +Enables Azure Resource Manager to get secrets from this key vault when this key vault is referenced in a template deployment. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnablePurgeProtection +If specified, protection against immediate deletion is enabled for this vault; requires soft delete to be enabled as well. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableRbacAuthorization +If specified, enables to authorize data actions by Role Based Access Control (RBAC), and then the access policies specified in vault properties will be ignored. Note that management actions are always authorized with RBAC. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the Azure region in which to create the key vault. Use the command [Get-AzLocation](/powershell/module/az.resources/get-azlocation) to see your choices. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name of the key vault to create. The name can be any combination of letters, digits, or hyphens. The name must start and end with a letter or digit. The name must be universally unique. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VaultName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkRuleSet +Specifies the network rule set of the vault. It governs the accessibility of the key vault from specific network locations. Created by `New-AzKeyVaultNetworkRuleSetObject`. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultNetworkRuleSet +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Specifies whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules. By default, we will enable public network access. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an existing resource group in which to create the key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Specifies the SKU of the key vault instance. For information about which features are available for each SKU, see the Azure Key Vault Pricing website (https://go.microsoft.com/fwlink/?linkid=512521). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SoftDeleteRetentionInDays +Specifies how long deleted resources are retained, and how long until a vault or an object in the deleted state can be purged. The default is 90 days. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVault](./Get-AzKeyVault.md) + +[Remove-AzKeyVault](./Remove-AzKeyVault.md) diff --git a/azps-10.1.0/Az.KeyVault/New-AzKeyVaultCertificateAdministratorDetail.md b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultCertificateAdministratorDetail.md new file mode 100644 index 0000000000..6f294b4dc8 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultCertificateAdministratorDetail.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 775AB0E8-EC3C-4F96-8AF8-51C1DFEEF082 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/new-azkeyvaultcertificateadministratordetail +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultCertificateAdministratorDetail.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultCertificateAdministratorDetail.md +--- + +# New-AzKeyVaultCertificateAdministratorDetail + +## SYNOPSIS +Creates an in-memory certificate administrator details object. + +## SYNTAX + +``` +New-AzKeyVaultCertificateAdministratorDetail [-FirstName <String>] [-LastName <String>] + [-EmailAddress <String>] [-PhoneNumber <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzKeyVaultCertificateAdministratorDetail** cmdlet creates an in-memory certificate administrator details object. + +## EXAMPLES + +### Example 1: Create a certificate administrator details object +```powershell +$AdminDetails = New-AzKeyVaultCertificateAdministratorDetail -FirstName "Patti" -LastName "Fuller" -EmailAddress "patti.fuller@contoso.com" -PhoneNumber "5553334444" +$AdminDetails +``` + +```output +FirstName LastName EmailAddress PhoneNumber +--------- -------- ------------ ----------- +Patti Fuller patti.fuller@contoso.com 5553334444 +``` + +This command creates an in-memory certificate administrator details object, and then stores it in the $AdminDetails variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddress +Specifies the email address for the certificate administrator. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FirstName +Specifies the first name of the certificate administrator. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LastName +Specifies the last name of the certificate administrator. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PhoneNumber +Specifies the phone number of the certificate administrator. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateAdministratorDetails + +## NOTES + +## RELATED LINKS + +[New-AzKeyVaultCertificateOrganizationDetail](./New-AzKeyVaultCertificateOrganizationDetail.md) + diff --git a/azps-10.1.0/Az.KeyVault/New-AzKeyVaultCertificateOrganizationDetail.md b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultCertificateOrganizationDetail.md new file mode 100644 index 0000000000..8b834272f1 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultCertificateOrganizationDetail.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 0E1C05B0-8CF6-4C03-AA05-B13A4059A280 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/new-azkeyvaultcertificateorganizationdetail +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultCertificateOrganizationDetail.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultCertificateOrganizationDetail.md +--- + +# New-AzKeyVaultCertificateOrganizationDetail + +## SYNOPSIS +Creates an in-memory certificate organization details object. + +## SYNTAX + +``` +New-AzKeyVaultCertificateOrganizationDetail [-Id <String>] + [-AdministratorDetails <System.Collections.Generic.List`1[Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateAdministratorDetails]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzKeyVaultCertificateOrganizationDetail** cmdlet creates an in-memory certificate organization details object. + +## EXAMPLES + +### Example 1: Create an organization details object +```powershell +$AdminDetails = New-AzKeyVaultCertificateAdministratorDetail -FirstName "Patti" -LastName "Fuller" -EmailAddress "Patti.Fuller@contoso.com" -PhoneNumber "1234567890" +New-AzKeyVaultCertificateOrganizationDetail -AdministratorDetails $AdminDetails +``` + +```output +Id AdministratorDetails +-- -------------------- + {Patti} +``` + +The first command creates a certificate administrator details object, and then stores it in the $AdminDetails variable. +The second command creates a certificate organization details object, and then stores it in the $OrgDetails variable. + +## PARAMETERS + +### -AdministratorDetails +Specifies the certificate organization administrators. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateAdministratorDetails] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the identifier for the organization. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateAdministratorDetails, Microsoft.Azure.PowerShell.Cmdlets.KeyVault, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOrganizationDetails + +## NOTES + +## RELATED LINKS + +[New-AzKeyVaultCertificateAdministratorDetail](./New-AzKeyVaultCertificateAdministratorDetail.md) + diff --git a/azps-10.1.0/Az.KeyVault/New-AzKeyVaultCertificatePolicy.md b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultCertificatePolicy.md new file mode 100644 index 0000000000..92458c123c --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultCertificatePolicy.md @@ -0,0 +1,520 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 25E0F0E9-BF8C-49DF-87BA-31E2103A29A9 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/new-azkeyvaultcertificatepolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultCertificatePolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultCertificatePolicy.md +--- + +# New-AzKeyVaultCertificatePolicy + +## SYNOPSIS +Creates an in-memory certificate policy object. + +## SYNTAX + +### SubjectName (Default) +``` +New-AzKeyVaultCertificatePolicy [-IssuerName] <String> [-SubjectName] <String> + [-RenewAtNumberOfDaysBeforeExpiry <Int32>] [-RenewAtPercentageLifetime <Int32>] [-SecretContentType <String>] + [-ReuseKeyOnRenewal] [-Disabled] + [-KeyUsage <System.Collections.Generic.List`1[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags]>] + [-Ekus <System.Collections.Generic.List`1[System.String]>] [-ValidityInMonths <Int32>] + [-CertificateType <String>] [-EmailAtNumberOfDaysBeforeExpiry <Int32>] [-EmailAtPercentageLifetime <Int32>] + [-KeyType <String>] [-KeySize <Int32>] [-KeyNotExportable] [-CertificateTransparency <Boolean>] + [-Curve <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DNSNames +``` +New-AzKeyVaultCertificatePolicy [-IssuerName] <String> [[-SubjectName] <String>] + [-DnsName] <System.Collections.Generic.List`1[System.String]> [-RenewAtNumberOfDaysBeforeExpiry <Int32>] + [-RenewAtPercentageLifetime <Int32>] [-SecretContentType <String>] [-ReuseKeyOnRenewal] [-Disabled] + [-KeyUsage <System.Collections.Generic.List`1[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags]>] + [-Ekus <System.Collections.Generic.List`1[System.String]>] [-ValidityInMonths <Int32>] + [-CertificateType <String>] [-EmailAtNumberOfDaysBeforeExpiry <Int32>] [-EmailAtPercentageLifetime <Int32>] + [-KeyType <String>] [-KeySize <Int32>] [-KeyNotExportable] [-CertificateTransparency <Boolean>] + [-Curve <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzKeyVaultCertificatePolicy** cmdlet creates an in-memory certificate policy object for Azure Key Vault. + +## EXAMPLES + +### Example 1: Create a certificate policy +```powershell +New-AzKeyVaultCertificatePolicy -SecretContentType "application/x-pkcs12" -SubjectName "CN=contoso.com" -IssuerName "Self" -ValidityInMonths 6 -ReuseKeyOnRenewal +``` + +```output +SecretContentType : application/x-pkcs12 +Kty : +KeySize : 2048 +Curve : +Exportable : +ReuseKeyOnRenewal : True +SubjectName : CN=contoso.com +DnsNames : +KeyUsage : +Ekus : +ValidityInMonths : 6 +IssuerName : Self +CertificateType : +RenewAtNumberOfDaysBeforeExpiry : +RenewAtPercentageLifetime : +EmailAtNumberOfDaysBeforeExpiry : +EmailAtPercentageLifetime : +CertificateTransparency : +Enabled : True +Created : +Updated : +``` + +This command creates a certificate policy that is valid for six months and reuses the key to renew the certificate. + +### Example 2 + +Creates an in-memory certificate policy object. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +New-AzKeyVaultCertificatePolicy -IssuerName 'Self' -KeyType RSA -RenewAtNumberOfDaysBeforeExpiry <Int32> -SecretContentType application/x-pkcs12 -SubjectName 'CN=contoso.com' -ValidityInMonths 6 +``` + +### Example 3: Create a Subject Alternate Name (or SAN) certificate + +```powershell +New-AzKeyVaultCertificatePolicy -SecretContentType "application/x-pkcs12" -SubjectName "CN=contoso.com" -DnsName "contoso.com","support.contoso.com","docs.contoso.com" -IssuerName "Self" +``` + +```output +SecretContentType : application/x-pkcs12 +Kty : RSA +KeySize : 2048 +Curve : +Exportable : +ReuseKeyOnRenewal : False +SubjectName : CN=contoso.com +DnsNames : {contoso.com, support.contoso.com, docs.contoso.com} +KeyUsage : +Ekus : +ValidityInMonths : +IssuerName : Self +CertificateType : +RenewAtNumberOfDaysBeforeExpiry : +RenewAtPercentageLifetime : +EmailAtNumberOfDaysBeforeExpiry : +EmailAtPercentageLifetime : +CertificateTransparency : +Enabled : True +Created : +Updated : +``` + +This example creates a SAN certificate with 3 DNS names. + +## PARAMETERS + +### -CertificateTransparency +Indicates whether certificate transparency is enabled for this certificate/issuer; if not specified, the default is 'true' + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CertificateType +Specifies the type of certificate to the issuer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Curve +Specifies the elliptic curve name of the key of the certificate. +The acceptable values for this parameter are: +- P-256 +- P-384 +- P-521 +- P-256K +- SECP256K1 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: P-256, P-384, P-521, P-256K, SECP256K1 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +Indicates that the certificate policy is disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DnsName +Specifies the DNS names in the certificate. Subject Alternative Names (SANs) can be specified as DNS names. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: DNSNames +Aliases: DnsNames + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Ekus +Specifies the enhanced key usages (EKUs) in the certificate. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EmailAtNumberOfDaysBeforeExpiry +Specifies how many days before expiry the automatic notification process begins. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EmailAtPercentageLifetime +Specifies the percentage of the lifetime after which the automatic process for the notification begins. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IssuerName +Specifies the name of the issuer for the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyNotExportable +Indicates that the key is not exportable. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeySize +Specifies the key size of the certificate. +The acceptable values for this parameter are: +- 2048 +- 3072 +- 4096 +- 256 +- 384 +- 521 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Accepted values: 2048, 3072, 4096, 256, 384, 521 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyType +Specifies the key type of the key that backs the certificate. +The acceptable values for this parameter are: +- RSA +- RSA-HSM +- EC +- EC-HSM + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: RSA, RSA-HSM, EC, EC-HSM + +Required: False +Position: Named +Default value: RSA +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyUsage +Specifies the key usages in the certificate. + +```yaml +Type: System.Collections.Generic.List`1[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags] +Parameter Sets: (All) +Aliases: +Accepted values: None, EncipherOnly, CrlSign, KeyCertSign, KeyAgreement, DataEncipherment, KeyEncipherment, NonRepudiation, DigitalSignature, DecipherOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RenewAtNumberOfDaysBeforeExpiry +Specifies the number of days before expiry after which the automatic process for certificate renewal begins. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RenewAtPercentageLifetime +Specifies the percentage of the lifetime after which the automatic process for certificate renewal begins. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReuseKeyOnRenewal +Indicates that the certificate reuse the key during renewal. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecretContentType +Specifies the content type of the new key vault secret. +The acceptable values for this parameter are: +- application/x-pkcs12 +- application/x-pem-file + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: application/x-pkcs12, application/x-pem-file + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectName +Specifies the subject name of the certificate. + +> [!NOTE] +> If you must use a comma (,) or a period (.) within a property in the `SubjectName` parameter, +> you must enclose the property field in quotation marks. For example, you may use O="Contoso, Ltd." in the Organization Name field. + +```yaml +Type: System.String +Parameter Sets: SubjectName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: DNSNames +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ValidityInMonths +Specifies the number of months the certificate is valid. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Management.Automation.SwitchParameter + +### System.Collections.Generic.List`1[[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags, System.Security.Cryptography.X509Certificates, Version=4.2.1.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]] + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultCertificatePolicy](./Get-AzKeyVaultCertificatePolicy.md) + +[Set-AzKeyVaultCertificatePolicy](./Set-AzKeyVaultCertificatePolicy.md) + diff --git a/azps-10.1.0/Az.KeyVault/New-AzKeyVaultManagedHsm.md b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultManagedHsm.md new file mode 100644 index 0000000000..e636ea1865 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultManagedHsm.md @@ -0,0 +1,308 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/new-azkeyvaultmanagedhsm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultManagedHsm.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultManagedHsm.md +--- + +# New-AzKeyVaultManagedHsm + +## SYNOPSIS +Creates a managed HSM. + +## SYNTAX + +``` +New-AzKeyVaultManagedHsm [-Name] <String> [-ResourceGroupName] <String> [-Location] <String> + [-Administrator] <String[]> [-Sku <String>] [-SoftDeleteRetentionInDays <Int32>] + [-PublicNetworkAccess <String>] [-EnablePurgeProtection] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzKeyVaultManagedHsm** cmdlet creates a managed HSM in the specified resource group. To add, +remove, or list keys in the managed HSM, user should: +1. grant permissions by adding user ID to Administrator; +2. add role assignment for user like "Managed HSM Crypto User" and so on; +3. back up security domain data of a managed HSM using `Export-AzKeyVaultSecurityDomain`. + +## EXAMPLES + +### Example 1: Create a StandardB1 managed HSM +```powershell +New-AzKeyVaultManagedHsm -Name 'myhsm' -ResourceGroupName 'myrg1' -Location 'eastus2euap' -Administrator "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +```output +Name Resource Group Name Location SKU +---- ------------------- -------- --- +myhsm myrg1 eastus2euap StandardB1 +``` + +This command creates a managed HSM named myhsm in the location eastus2euap. The command +adds the managed HSM to the resource group named myrg1. Because the command does not specify a +value for the *SKU* parameter, it creates a Standard_B1 managed HSM. + +### Example 2: Create a CustomB32 managed HSM +```powershell +New-AzKeyVaultManagedHsm -Name 'myhsm' -ResourceGroupName 'myrg1' -Location 'eastus2euap' -Administrator "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Sku 'CustomB32' +``` + +```output +Name Resource Group Name Location SKU + +---- ------------------- -------- --- +myhsm myrg1 eastus2euap CustomB32 +``` + +This command creates a managed HSM, just like the previous example. However, it specifies a value of +CustomB32 for the *SKU* parameter to create a CustomB32 managed HSM. + +## PARAMETERS + +### -Administrator +Initial administrator object id for this managed HSM pool. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePurgeProtection +specifying whether protection against purge is enabled for this managed HSM pool. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the Azure region in which to create the key vault. +Use the command Get-AzResourceProvider with the ProviderNamespace parameter to see your choices. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name of the managed HSM to create. +The name can be any combination of letters, digits, or hyphens. +The name must start and end with a letter or digit. +The name must be universally unique. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HsmName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Controls permission for data plane traffic coming from public networks while private endpoint is enabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an existing resource group in which to create the key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Specifies the SKU of the managed HSM instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SoftDeleteRetentionInDays +Specifies how long the deleted managed hsm pool is retained, and how long until the managed hsm pool in the deleted state can be purged. The default is 90 days. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultManagedHsm](./Get-AzKeyVaultManagedHsm.md) + +[Remove-AzKeyVaultManagedHsm](./Remove-AzKeyVaultManagedHsm.md) + +[Update-AzKeyVaultManagedHsm](./Update-AzKeyVaultManagedHsm.md) + +[Undo-AzKeyVaultManagedHsmRemoval](./Undo-AzKeyVaultManagedHsmRemoval.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.KeyVault/New-AzKeyVaultNetworkRuleSetObject.md b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultNetworkRuleSetObject.md new file mode 100644 index 0000000000..fab6f4d84d --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultNetworkRuleSetObject.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/new-azkeyvaultnetworkrulesetobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultNetworkRuleSetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultNetworkRuleSetObject.md +--- + +# New-AzKeyVaultNetworkRuleSetObject + +## SYNOPSIS +Create an object representing the network rule settings. + +## SYNTAX + +``` +New-AzKeyVaultNetworkRuleSetObject [-DefaultAction <PSKeyVaultNetworkRuleDefaultActionEnum>] + [-Bypass <PSKeyVaultNetworkRuleBypassEnum>] [-IpAddressRange <String[]>] + [-VirtualNetworkResourceId <String[]>] [-DefaultProfile <IAzureContextContainer>] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an object representing the network rule settings that can be used when creating a vault. + +## EXAMPLES + +### Example 1 +```powershell +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "110.0.1.0/24" -ServiceEndpoint Microsoft.KeyVault +$virtualNetwork = New-AzVirtualNetwork -Name myVNet -ResourceGroupName myRG -Location westus -AddressPrefix "110.0.0.0/16" -Subnet $frontendSubnet +$myNetworkResId = (Get-AzVirtualNetwork -Name myVNet -ResourceGroupName myRG).Subnets[0].Id +$ruleSet = New-AzKeyVaultNetworkRuleSetObject -DefaultAction Allow -Bypass AzureServices -IpAddressRange "110.0.1.0/24" -VirtualNetworkResourceId $myNetworkResId +New-AzKeyVault -ResourceGroupName "myRg" -VaultName "myVault" -NetworkRuleSet $ruleSet +``` + +Creating a new vault and specifies network rules to allow access to the specified IP address from the virtual network identified by $myNetworkResId. + +## PARAMETERS + +### -Bypass +Specifies bypass of network rule. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultNetworkRuleBypassEnum +Parameter Sets: (All) +Aliases: +Accepted values: None, AzureServices + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAction +Specifies default action of network rule. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultNetworkRuleDefaultActionEnum +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddressRange +Specifies allowed network IP address range of network rule. + +```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 subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkResourceId +Specifies allowed virtual network resource identifier of network rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultNetworkRuleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/New-AzKeyVaultRoleAssignment.md b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultRoleAssignment.md new file mode 100644 index 0000000000..2022b5e663 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultRoleAssignment.md @@ -0,0 +1,259 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/new-azkeyvaultroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultRoleAssignment.md +--- + +# New-AzKeyVaultRoleAssignment + +## SYNOPSIS +Assigns the specified RBAC role to the specified principal, at the specified scope. + +## SYNTAX + +### DefinitionNameSignInName (Default) +``` +New-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] -RoleDefinitionName <String> + -SignInName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DefinitionNameApplicationId +``` +New-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] -RoleDefinitionName <String> + -ApplicationId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DefinitionNameObjectId +``` +New-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] -RoleDefinitionName <String> + -ObjectId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DefinitionIdApplicationId +``` +New-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] -RoleDefinitionId <String> + -ApplicationId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DefinitionIdObjectId +``` +New-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] -RoleDefinitionId <String> + -ObjectId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DefinitionIdSignInName +``` +New-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] -RoleDefinitionId <String> + -SignInName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use the `New-AzKeyVaultRoleAssignment` command to grant access. +Access is granted by assigning the appropriate RBAC role to them at the right scope. +The subject of the assignment must be specified. +To specify a user, use SignInName or Azure AD ObjectId parameters. +To specify a security group, use Azure AD ObjectId parameter. +And to specify an Azure AD application, use ApplicationId or ObjectId parameters. +The role that is being assigned must be specified using the RoleDefinitionName pr RoleDefinitionId parameter. The scope at which access is being granted may be specified. It defaults to the selected subscription. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /directoryObjects/{id} +- GET /users/{id} +- GET /servicePrincipals/{id} +- GET /servicePrincipals +- GET /groups/{id} + +## EXAMPLES + +### Example 1 +```powershell +New-AzKeyVaultRoleAssignment -HsmName bez-hsm -RoleDefinitionName "Managed Hsm Crypto User" -ObjectId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +``` + +This example assigns role "Managed Hsm Crypto User" to user "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" at top scope. If user wants to perform operations on keys. "Managed Hsm Crypto *" role is required for that user. + +### Example 2 +```powershell +New-AzKeyVaultRoleAssignment -HsmName myHsm -RoleDefinitionName "Managed HSM Policy Administrator" -SignInName user1@microsoft.com +``` + +```output +RoleDefinitionName DisplayName ObjectType Scope +------------------ ----------- ---------- ----- +Managed HSM Policy Administrator User 1 (user1@microsoft.com) User / +``` + +This example assigns role "Managed HSM Policy Administrator" to user "user1@microsoft.com" at top scope. + +## PARAMETERS + +### -ApplicationId +The app SPN. + +```yaml +Type: System.String +Parameter Sets: DefinitionNameApplicationId, DefinitionIdApplicationId +Aliases: SPN, ServicePrincipalName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +Name of the HSM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The user or group object id. + +```yaml +Type: System.String +Parameter Sets: DefinitionNameObjectId, DefinitionIdObjectId +Aliases: Id, PrincipalId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +Role Id the principal is assigned to. + +```yaml +Type: System.String +Parameter Sets: DefinitionIdApplicationId, DefinitionIdObjectId, DefinitionIdSignInName +Aliases: RoleId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionName +Name of the RBAC role to assign the principal with. + +```yaml +Type: System.String +Parameter Sets: DefinitionNameSignInName, DefinitionNameApplicationId, DefinitionNameObjectId +Aliases: RoleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Scope at which the role assignment or definition applies to, e.g., '/' or '/keys' or '/keys/{keyName}'. +'/' is used when omitted. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignInName +The user SignInName. + +```yaml +Type: System.String +Parameter Sets: DefinitionNameSignInName, DefinitionIdSignInName +Aliases: Email, UserPrincipalName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultRoleAssignment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/New-AzKeyVaultRoleDefinition.md b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultRoleDefinition.md new file mode 100644 index 0000000000..ad24e4e61f --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/New-AzKeyVaultRoleDefinition.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/new-azkeyvaultroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/New-AzKeyVaultRoleDefinition.md +--- + +# New-AzKeyVaultRoleDefinition + +## SYNOPSIS +Creates a custom role definition on an HSM. + +## SYNTAX + +### InputObject (Default) +``` +New-AzKeyVaultRoleDefinition [-HsmName] <String> [-Scope <String>] [-Role] <PSKeyVaultRoleDefinition> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputFile +``` +New-AzKeyVaultRoleDefinition [-HsmName] <String> [-Scope <String>] [-InputFile] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The `New-AzKeyVaultRoleDefinition` cmdlet creates a custom role in Azure Role-Based Access Control of an Azure KeyVault managed HSM. + +Provide either a JSON role definition file or a `PSKeyVaultRoleDefinition` object as input. +First, use the `Get-AzKeyVaultRoleDefinition` command to generate a baseline role definition object. +Then, modify its properties as required. +Finally, use this command to create a custom role using role definition. + +## EXAMPLES + +### Example 1 +```powershell +$role = Get-AzKeyVaultRoleDefinition -HsmName myHsm -RoleDefinitionName 'Managed HSM Crypto User' +$role.Name = $null +$role.RoleName = "my custom role" +$role.Description = "description for my role" +$role.Permissions[0].DataActions = @("Microsoft.KeyVault/managedHsm/roleAssignments/write/action", "Microsoft.KeyVault/managedHsm/roleAssignments/delete/action") # todo +New-AzKeyVaultRoleDefinition -HsmName myHsm -Role $role +``` + +This example uses the predefined "Managed HSM Crypto User" role as a template to create a custom role. + +### Example 2 +```powershell +Get-AzKeyVaultRoleDefinition -HsmName myHsm -RoleDefinitionName 'Managed HSM Crypto User' | ConvertTo-Json -Depth 9 > C:\Temp\roleDefinition.json +# Edit roleDefinition.json. Make sure to clear "Name" so as not to overwrite an existing role. +New-AzKeyVaultRoleDefinition -HsmName myHsm -InputFile C:\Temp\roleDefinition.json +``` + +This example uses a JSON file as the input of the custom role. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +Name of the HSM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +File name containing a single role definition. + +```yaml +Type: System.String +Parameter Sets: InputFile +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +A role definition object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultRoleDefinition +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Scope at which the role assignment or definition applies to, e.g., '/' or '/keys' or '/keys/{keyName}'. +'/' is used when omitted. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultRoleDefinition + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVault.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVault.md new file mode 100644 index 0000000000..71b1d3d954 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVault.md @@ -0,0 +1,323 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 7A929BA8-02D9-4BBE-AFF3-B8781F8DDAD9 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVault.md +--- + +# Remove-AzKeyVault + +## SYNOPSIS +Deletes a key vault. + +## SYNTAX + +### ByAvailableVault (Default) +``` +Remove-AzKeyVault [-VaultName] <String> [[-ResourceGroupName] <String>] [[-Location] <String>] [-Force] + [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ByDeletedVault +``` +Remove-AzKeyVault [-VaultName] <String> [-Location] <String> [-InRemovedState] [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### InputObjectByAvailableVault +``` +Remove-AzKeyVault [-InputObject] <PSKeyVault> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### InputObjectByDeletedVault +``` +Remove-AzKeyVault [-InputObject] <PSKeyVault> [-InRemovedState] [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ResourceIdByAvailableVault +``` +Remove-AzKeyVault [-ResourceId] <String> [[-Location] <String>] [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ResourceIdByDeletedVault +``` +Remove-AzKeyVault [-ResourceId] <String> [-Location] <String> [-InRemovedState] [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzKeyVault** cmdlet deletes the specified key vault. +It also deletes all keys and secrets contained in that instance. +Note that although specifying the resource group is optional for this cmdlet, you should so for better performance. + +## EXAMPLES + +### Example 1: Remove a key vault +```powershell +Remove-AzKeyVault -VaultName "Contoso03Vault" -PassThru +``` + +```output +True +``` + +This command removes the key vault named Contoso03Vault from your current subscription. + +### Example 2: Remove a key vault from a specified resource group +```powershell +Remove-AzKeyVault -Name "Contoso03Vault" -ResourceGroupName "Group14" -PassThru +``` + +```output +True +``` + +This command removes the key vault named Contoso03Vault from the named resource group. +If you do not specify the resource group name, the cmdlet searches for the named key vault to delete in your current subscription. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. +By default, this cmdlet prompts you to confirm that you want to delete the key vault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Key Vault object to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: InputObjectByAvailableVault, InputObjectByDeletedVault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InRemovedState +Remove the previously deleted vault permanently. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByDeletedVault, InputObjectByDeletedVault, ResourceIdByDeletedVault +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the deleted vault. + +```yaml +Type: System.String +Parameter Sets: ByAvailableVault, ResourceIdByAvailableVault +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByDeletedVault, ResourceIdByDeletedVault +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: ByAvailableVault +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +KeyVault Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdByAvailableVault, ResourceIdByDeletedVault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault to remove. + +```yaml +Type: System.String +Parameter Sets: ByAvailableVault, ByDeletedVault +Aliases: Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run.Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVault](./Get-AzKeyVault.md) + +[New-AzKeyVault](./New-AzKeyVault.md) diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultAccessPolicy.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultAccessPolicy.md new file mode 100644 index 0000000000..e3fd9a7360 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultAccessPolicy.md @@ -0,0 +1,486 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: AE7B103B-23ED-4A66-A0DC-14FB0DF38FA8 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvaultaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultAccessPolicy.md +--- + +# Remove-AzKeyVaultAccessPolicy + +## SYNOPSIS +Removes all permissions for a user or application from a key vault. + +## SYNTAX + +### ByUserPrincipalName (Default) +``` +Remove-AzKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -UserPrincipalName <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ByObjectId +``` +Remove-AzKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -ObjectId <String> + [-ApplicationId <Guid>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ByServicePrincipalName +``` +Remove-AzKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] + -ServicePrincipalName <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ByEmail +``` +Remove-AzKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -EmailAddress <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ForVault +``` +Remove-AzKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] [-EnabledForDeployment] + [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### InputObjectByObjectId +``` +Remove-AzKeyVaultAccessPolicy [-InputObject] <PSKeyVault> -ObjectId <String> [-ApplicationId <Guid>] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### InputObjectByServicePrincipalName +``` +Remove-AzKeyVaultAccessPolicy [-InputObject] <PSKeyVault> -ServicePrincipalName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### InputObjectByUserPrincipalName +``` +Remove-AzKeyVaultAccessPolicy [-InputObject] <PSKeyVault> -UserPrincipalName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### InputObjectByEmail +``` +Remove-AzKeyVaultAccessPolicy [-InputObject] <PSKeyVault> -EmailAddress <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### InputObjectForVault +``` +Remove-AzKeyVaultAccessPolicy [-InputObject] <PSKeyVault> [-EnabledForDeployment] + [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ResourceIdByObjectId +``` +Remove-AzKeyVaultAccessPolicy [-ResourceId] <String> -ObjectId <String> [-ApplicationId <Guid>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ResourceIdByServicePrincipalName +``` +Remove-AzKeyVaultAccessPolicy [-ResourceId] <String> -ServicePrincipalName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ResourceIdByUserPrincipalName +``` +Remove-AzKeyVaultAccessPolicy [-ResourceId] <String> -UserPrincipalName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ResourceIdByEmail +``` +Remove-AzKeyVaultAccessPolicy [-ResourceId] <String> -EmailAddress <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ResourceIdForVault +``` +Remove-AzKeyVaultAccessPolicy [-ResourceId] <String> [-EnabledForDeployment] [-EnabledForTemplateDeployment] + [-EnabledForDiskEncryption] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzKeyVaultAccessPolicy** cmdlet removes all permissions for a user or application or for all users and applications from a key vault. +Even if you remove all permissions, the owner of the Azure subscription that contains the key vault can add permissions to the key vault. +Note that although specifying the resource group is optional for this cmdlet, you should do so for better performance. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /directoryObjects/{id} +- GET /users/{id} +- GET /users +- GET /servicePrincipals/{id} +- GET /servicePrincipals +- GET /groups/{id} + +## EXAMPLES + +### Example 1: Remove permissions for a user +```powershell +Remove-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PassThru +``` + +```output +Vault Name : Contoso03Vault +Resource Group Name : myrg +Location : westus +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers + /Microsoft.KeyVault/vaults/contoso03vault +Vault URI : https://contoso03vault.vault.azure.net/ +Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +SKU : Standard +Enabled For Deployment? : False +Enabled For Template Deployment? : False +Enabled For Disk Encryption? : False +Soft Delete Enabled? : +Access Policies : + Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Application ID : + Display Name : User Name (username@microsoft.com) + Permissions to Keys : + Permissions to Secrets : + Permissions to Certificates : get, create + Permissions to (Key Vault Managed) Storage : + + +Network Rule Set : + Default Action : Allow + Bypass : AzureServices + IP Rules : + Virtual Network Rules : + +Tags : +``` + +This command removes all the permissions that a user PattiFuller@contoso.com has on the key vault named Contoso03Vault. If -PassThru is specified, the KeyVault object is returned. + +### Example 2: Remove permissions for an application +```powershell +Remove-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ServicePrincipalName 'http://payroll.contoso.com' +``` + +This command removes all the permissions that an application has on the key vault named Contoso03Vault. +This example identifies the application by using the service principal name registered in Azure Active Directory, `http://payroll.contoso.com`. + +### Example 3: Remove permissions for an application by using its object ID +```powershell +Remove-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ObjectID 34595082-9346-41b6-8d6b-295a2808b8db +``` + +This command removes all the permissions that an application has on the key vault named Contoso03Vault. +This example identifies the application by the object ID of the service principal. + +### Example 4: Remove permissions for the Microsoft.Compute resource provider +```powershell +Remove-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -EnabledForDeployment +``` + +This command removes permission for the Microsoft.Compute resource provider to get secrets from the Contoso03Vault. + +## PARAMETERS + +### -ApplicationId +Specifies the ID of application whose permissions should be removed + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: ByObjectId, InputObjectByObjectId, ResourceIdByObjectId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddress +Specifies the user email address of the user whose access you want to remove. + +```yaml +Type: System.String +Parameter Sets: ByEmail, InputObjectByEmail, ResourceIdByEmail +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledForDeployment +If specified, disables the retrieval of secrets from this key vault by the Microsoft.Compute resource provider when referenced in resource creation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ForVault, InputObjectForVault, ResourceIdForVault +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledForDiskEncryption +If specified, disables the retrieval of secrets from this key vault by Azure Disk Encryption. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ForVault, InputObjectForVault, ResourceIdForVault +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledForTemplateDeployment +If specified, disables the retrieval of secrets from this key vault by Azure Resource Manager when referenced in templates. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ForVault, InputObjectForVault, ResourceIdForVault +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Key Vault object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: InputObjectByObjectId, InputObjectByServicePrincipalName, InputObjectByUserPrincipalName, InputObjectByEmail, InputObjectForVault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ObjectId +Specifies the object ID of the user or service principal in Azure Active Directory for which to remove permissions. + +```yaml +Type: System.String +Parameter Sets: ByObjectId, InputObjectByObjectId, ResourceIdByObjectId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group associated with the key vault whose access policy is being modified. +If not specified, this cmdlet searches for the key vault in the current subscription. + +```yaml +Type: System.String +Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmail, ForVault +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +KeyVault Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdByObjectId, ResourceIdByServicePrincipalName, ResourceIdByUserPrincipalName, ResourceIdByEmail, ResourceIdForVault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServicePrincipalName +Specifies the service principal name of the application whose permissions you want to remove. +Specify the application ID, also known as client ID, registered for the application in Azure Active Directory. + +```yaml +Type: System.String +Parameter Sets: ByServicePrincipalName, InputObjectByServicePrincipalName, ResourceIdByServicePrincipalName +Aliases: SPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserPrincipalName +Specifies the user principal name of the user whose access you want to remove. + +```yaml +Type: System.String +Parameter Sets: ByUserPrincipalName, InputObjectByUserPrincipalName, ResourceIdByUserPrincipalName +Aliases: UPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault. +This cmdlet removes permissions for the key vault that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmail, ForVault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +## NOTES + +## RELATED LINKS + +[Set-AzKeyVaultAccessPolicy](./Set-AzKeyVaultAccessPolicy.md) + diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultCertificate.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultCertificate.md new file mode 100644 index 0000000000..a46b1247d7 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultCertificate.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 34985F06-4D8D-463B-B113-972666D18485 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvaultcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultCertificate.md +--- + +# Remove-AzKeyVaultCertificate + +## SYNOPSIS +Removes a certificate from a key vault. + +## SYNTAX + +### ByVaultNameAndName (Default) +``` +Remove-AzKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-InRemovedState] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObject +``` +Remove-AzKeyVaultCertificate [-InputObject] <PSKeyVaultCertificateIdentityItem> [-InRemovedState] [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzKeyVaultCertificate** cmdlet removes a certificate from a key vault. + +## EXAMPLES + +### Example 1: Remove a certificate +```powershell +Remove-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "SelfSigned01" -PassThru -Force +``` + +```output +Certificate : [Subject] + CN=contoso.com + + [Issuer] + CN=contoso.com + + [Serial Number] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + [Not Before] + 4/11/2018 4:28:39 PM + + [Not After] + 10/11/2018 4:38:39 PM + + [Thumbprint] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + +KeyId : https://contosokv01.vault.azure.net:443/keys/selfsigned01/968c3920884a435abf8faea11f565456 +SecretId : https://contosokv01.vault.azure.net:443/secrets/selfsigned01/968c3920884a435abf8faea11f565456 +Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +RecoveryLevel : Purgeable +ScheduledPurgeDate : +DeletedDate : +Enabled : True +Expires : 10/11/2018 11:38:39 PM +NotBefore : 4/11/2018 11:28:39 PM +Created : 4/11/2018 11:38:39 PM +Updated : 4/11/2018 11:38:39 PM +Tags : +VaultName : ContosoKV01 +Name : SelfSigned01 +Version : 968c3920884a435abf8faea11f565456 +Id : https://contosokv01.vault.azure.net:443/certificates/selfsigned01/968c3920884a435abf8faea11f565456 +``` + +This command removes the certificate named SelfSigned01 from the key vault named ContosoKV01. +This command specifies the *Force* parameter. +Therefore, the cmdlet does not prompt you for confirmation. + +### Example 2: Purge the deleted certificate from the key vault permanently +```powershell +Remove-AzKeyVaultCertificate -VaultName 'Contoso' -Name 'MyCert' -InRemovedState +``` + +This command permanently removes the certificate named 'MyCert' from the key vault named 'Contoso'. +Executing this cmdlet requires the 'purge' permission, which must have been previously and explicitly granted to the user on this key vault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Certificate Object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem +Parameter Sets: ByObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InRemovedState +If present, removes the previously deleted certificate permanently + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the certificate that this cmdlet removes from a key vault. +This cmdlet constructs the fully qualified domain name (FQDN) of a certificate based on the name that this parameter specifies, the name of the key vault, and your current environment. + +```yaml +Type: System.String +Parameter Sets: ByVaultNameAndName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault from which this cmdlet removes a certificate. +This cmdlet constructs the FQDN of a key vault based on the name that this parameter specifies and your current environment. + +```yaml +Type: System.String +Parameter Sets: ByVaultNameAndName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run.Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultCertificate + +## NOTES + +## RELATED LINKS + +[Add-AzKeyVaultCertificate](./Add-AzKeyVaultCertificate.md) + +[Get-AzKeyVaultCertificate](./Get-AzKeyVaultCertificate.md) + +[Import-AzKeyVaultCertificate](./Import-AzKeyVaultCertificate.md) + +[Undo-AzKeyVaultCertificateRemoval](./Undo-AzKeyVaultCertificateRemoval.md) diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultCertificateContact.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultCertificateContact.md new file mode 100644 index 0000000000..bb9160143f --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultCertificateContact.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 35FAA57F-B2BD-4E43-8238-12F7A8269E4D +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvaultcertificatecontact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultCertificateContact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultCertificateContact.md +--- + +# Remove-AzKeyVaultCertificateContact + +## SYNOPSIS +Deletes a contact that is registered for certificate notifications from a key vault. + +## SYNTAX + +### ByName (Default) +``` +Remove-AzKeyVaultCertificateContact [-VaultName] <String> [-EmailAddress] <String[]> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObject +``` +Remove-AzKeyVaultCertificateContact [-InputObject] <PSKeyVault> [-EmailAddress] <String[]> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzKeyVaultCertificateContact [-ResourceId] <String> [-EmailAddress] <String[]> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzKeyVaultCertificateContact** cmdlet deletes a contact that is registered for certificate notifications from a key vault. + +## EXAMPLES + +### Example 1: Remove a certificate contact +```powershell +Remove-AzKeyVaultCertificateContact -VaultName "Contoso01" -EmailAddress "patti.fuller@contoso.com" -PassThru +``` + +```output +Email VaultName +----- --------- +user1@microsoft.com mvault2 +user2@microsoft.com mvault2 +user3@microsoft.com mvault2 +user4@microsoft.com mvault2 +``` + +This command removes Patti Fuller as a certificate contact for the Contoso01 key vault. If PassThru is specified, the cmdlet returns the list of remaining certificate contacts. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddress +Specifies the email address of the contact to remove. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +KeyVault Resource Id. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateContact + +## NOTES + +## RELATED LINKS + +[Add-AzKeyVaultCertificateContact](./Add-AzKeyVaultCertificateContact.md) + +[Get-AzKeyVaultCertificateContact](./Get-AzKeyVaultCertificateContact.md) + diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultCertificateIssuer.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultCertificateIssuer.md new file mode 100644 index 0000000000..e8e27115fe --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultCertificateIssuer.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: FC14F6BF-BD8F-45E0-9CAA-A937E5E56288 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvaultcertificateissuer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultCertificateIssuer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultCertificateIssuer.md +--- + +# Remove-AzKeyVaultCertificateIssuer + +## SYNOPSIS +Deletes a certificate issuer from a key vault. + +## SYNTAX + +### Default (Default) +``` +Remove-AzKeyVaultCertificateIssuer [-VaultName] <String> [-Name] <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzKeyVaultCertificateIssuer [-InputObject] <PSKeyVaultCertificateIssuerIdentityItem> [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzKeyVaultCertificateIssuer** cmdlet deletes a certificate issuer from a key vault. + +## EXAMPLES + +### Example 1: Remove a certificate issuer +```powershell +Remove-AzKeyVaultCertificateIssuer -VaultName "ContosoKV01" -Name "TestIssuer01" -Force +``` + +```output +AccountId : +ApiKey : +OrganizationDetails : +Name : TestIssuer01 +IssuerProvider : test +VaultName : ContosoKV01 +``` + +This command removes the certificate issuer named TestIssuer01 from the ContosoKV01 key vault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Certificate Issuer Object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuerIdentityItem +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the issuer to remove. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: IssuerName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run.Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuerIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuer + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultCertificateIssuer](./Get-AzKeyVaultCertificateIssuer.md) + +[Set-AzKeyVaultCertificateIssuer](./Set-AzKeyVaultCertificateIssuer.md) + + diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultCertificateOperation.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultCertificateOperation.md new file mode 100644 index 0000000000..461a57ce5d --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultCertificateOperation.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 2659C06A-AE5B-4F7B-B9EF-069A74E12560 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvaultcertificateoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultCertificateOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultCertificateOperation.md +--- + +# Remove-AzKeyVaultCertificateOperation + +## SYNOPSIS +Deletes a certificate operation from a key vault. + +## SYNTAX + +### Default +``` +Remove-AzKeyVaultCertificateOperation [-VaultName] <String> [-Name] <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzKeyVaultCertificateOperation [-InputObject] <PSKeyVaultCertificateOperation> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzKeyVaultCertificateOperation** cmdlet deletes a certificate operation from a key vault. + +## EXAMPLES + +### Example 1: Remove a certificate operation +```powershell +Remove-AzKeyVaultCertificateOperation -VaultName "ContosoKV01" -Name "TestCert01" -Force +``` + +```output +Id : https://contosokv01.vault.azure.net/certificates/testcert01/pending +Status : completed +StatusDetails : +RequestId : f5dfd2ae486149a594dc98e800dceaaa +Target : https://contosokv01.vault.azure.net/certificates/testcert01 +Issuer : Self +CancellationRequested : False +CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC73w3VRBOlgJ5Od1PjDh+2ytngNZp+ZP4fkuX8K1Ti5LA6Ih7eWx1fgAN/iTb6l + 5K6LvAIJvsTNVePMNxfSdaEIJ70Inm45wVU4A/kf+UxQWAYVMsBrLtDFWxnVhzf6n7RGYke6HLBj3j5ASb9g+olSs6eON25ibF0t+u6JC+sIR0LmVGar9Q0eZys1rdfzJBIKq+laOM7z2pJijb5ANqve9 + i7rH5mnhQk4V8WsRstOhYR9jgLqSSxokDoeaBClIOidSBYqVc1yNv4ASe1UWUCR7ZK6OQXiecNWSWPmgWEyawu6AR9eb1YotCr2ScheMOCxlm3103luitxrd8A7kMjAgMBAAGgSzBJBgkqhkiG9w0BCQ4 + xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAIHhsDJV37PKi8hor5eQf7+Tct1preIvSwqV0NF6Uo7O6 + YnC9Py7Wp7CHfKzuqeptUk2Tsu7B5dHB+o9Ypeeqw8fWhTN0GFGRKO7WjZQlDqL+lRNcjlFSaP022oIP0kmvVhBcmZqRQlALXccAaxEclFA/3y/aNj2gwWeKpH/pwAkZ39zMEzpQCaRfnQk7e3l4MV8cf + eC2HPYdRWkXxAeDcNPxBuVmKy49AzYvly+APNVDU3v66gxl3fIKrGRsKi2Cp/nO5rBxG2h8t+0Za4l/HJ7ZWR9wKbd/xg7JhdZZFVBxMHYzw8KQ0ys13x8HY+PXU92Y7yD3uC2Rcj+zbAf+Kg== + == +ErrorCode : +ErrorMessage : +Name : +VaultName : +``` + +This command removes the certificate operation named TestCert01 from the ContosoKV01 key vault without prompting for confirmation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Operation object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a certificate. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: CertificateName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run.Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultCertificateOperation](./Get-AzKeyVaultCertificateOperation.md) + +[Stop-AzKeyVaultCertificateOperation](./Stop-AzKeyVaultCertificateOperation.md) + diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultKey.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultKey.md new file mode 100644 index 0000000000..8c677207bd --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultKey.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 817BF177-519F-47BA-86CF-4591FB402E2Dl +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvaultkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultKey.md +--- + +# Remove-AzKeyVaultKey + +## SYNOPSIS +Deletes a key in a key vault. + +## SYNTAX + +### ByVaultName (Default) +``` +Remove-AzKeyVaultKey [-VaultName] <String> [-Name] <String> [-Force] [-PassThru] [-InRemovedState] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HsmByVaultName +``` +Remove-AzKeyVaultKey -HsmName <String> [-Name] <String> [-Force] [-PassThru] [-InRemovedState] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzKeyVaultKey [-InputObject] <PSKeyVaultKeyIdentityItem> [-Force] [-PassThru] [-InRemovedState] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzKeyVaultKey cmdlet deletes a key in a key vault. +If the key was accidentally deleted the key can be recovered using Undo-AzKeyVaultKeyRemoval by a user with special 'recover' permissions. +This cmdlet has a value of high for the **ConfirmImpact** property. + +## EXAMPLES + +### Example 1: Remove a key from a key vault +```powershell +Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -PassThru +``` + +```output +Vault Name : contoso +Name : key2 +Id : https://contoso.vault.azure.net:443/keys/itsoftware/fdad15793ba0437e960497908ef9eb32 +Deleted Date : 5/24/2018 11:28:25 PM +Scheduled Purge Date : 8/22/2018 11:28:25 PM +Enabled : False +Expires : 10/11/2018 11:32:49 PM +Not Before : 4/11/2018 11:22:49 PM +Created : 4/12/2018 10:16:38 PM +Updated : 4/12/2018 10:16:38 PM +Purge Disabled : False +Tags : +``` + +This command removes the key named ITSoftware from the key vault named Contoso. + +### Example 2: Remove a key without user confirmation +```powershell +Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Force +``` + +This command removes the key named ITSoftware from the key vault named Contoso. +The command specifies the *Force* parameter, and, therefore, the cmdlet does not prompt you for confirmation. + +### Example 3: Purge a deleted key from the key vault permanently +```powershell +Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -InRemovedState +``` + +This command removes the key named ITSoftware from the key vault named Contoso permanently. +Executing this cmdlet requires the 'purge' permission, which must have been previously and explicitly granted to the user for this key vault. + +### Example 4: Remove keys by using the pipeline operator +```powershell +Get-AzKeyVaultKey -VaultName 'Contoso' | Where-Object {$_.Attributes.Enabled -eq $False} | Remove-AzKeyVaultKey +``` + +This command gets all the keys in the key vault named Contoso, and passes them to the **Where-Object** cmdlet by using the pipeline operator. +That cmdlet passes the keys that have a value of $False for the **Enabled** attribute to the current cmdlet. +That cmdlet removes those keys. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +HSM name. Cmdlet constructs the FQDN of a managed HSM based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: HsmByVaultName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyBundle Object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InRemovedState +Remove the previously deleted key permanently. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the key to remove. +This cmdlet constructs the fully qualified domain name (FQDN) of a key based on the name that this parameter specifies, the name of the key vault, and your current environment. + +```yaml +Type: System.String +Parameter Sets: ByVaultName, HsmByVaultName +Aliases: KeyName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey** object. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault from which to remove the key. +This cmdlet constructs the FQDN of a key vault based on the name that this parameter specifies and your current environment. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run.Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultKey + +## NOTES + +## RELATED LINKS + +[Add-AzKeyVaultKey](./Add-AzKeyVaultKey.md) + +[Get-AzKeyVaultKey](./Get-AzKeyVaultKey.md) + +[Undo-AzKeyVaultKeyRemoval](./Undo-AzKeyVaultKeyRemoval.md) + diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultManagedHsm.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultManagedHsm.md new file mode 100644 index 0000000000..056aa9f633 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultManagedHsm.md @@ -0,0 +1,325 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvaultmanagedhsm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultManagedHsm.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultManagedHsm.md +--- + +# Remove-AzKeyVaultManagedHsm + +## SYNOPSIS +Deletes/Purges a managed HSM. + +## SYNTAX + +### RemoveManagedHsmByName (Default) +``` +Remove-AzKeyVaultManagedHsm [-Name] <String> [[-ResourceGroupName] <String>] [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### RemoveDeletedManagedHsmByName +``` +Remove-AzKeyVaultManagedHsm [-Name] <String> [-Location] <String> [-InRemovedState] [-Force] [-AsJob] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### RemoveManagedHsmByInputObject +``` +Remove-AzKeyVaultManagedHsm [-InputObject] <PSManagedHsm> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### RemoveDeletedManagedHsmByInputObject +``` +Remove-AzKeyVaultManagedHsm [-InputObject] <PSManagedHsm> [-InRemovedState] [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### RemoveManagedHsmByResourceId +``` +Remove-AzKeyVaultManagedHsm [-ResourceId] <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### RemoveDeletedManagedHsmByResourceId +``` +Remove-AzKeyVaultManagedHsm [-ResourceId] <String> [-Location] <String> [-InRemovedState] [-Force] [-AsJob] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzKeyVaultManagedHsm** cmdlet deletes the specified managed HSM. +It also deletes all keys contained in that instance. +Note that although specifying the resource group is optional for this cmdlet, you should so for better performance. + +## EXAMPLES + +### Example 1: Remove a managed HSM +```powershell +Remove-AzKeyVaultManagedHsm -HsmName 'myhsm' -Force +``` + +```output +True +``` + +This command removes the managed HSM named myhsm from your current subscription. + +### Example 2: Remove a managed hsm from a specified resource group +```powershell +Remove-AzKeyVaultManagedHsm -HsmName 'myhsm' -ResourceGroupName "myrg1" -PassThru +``` + +```output +True +``` + +This command removes the managed HSM named myhsm from the resource group named myrg1. +If you do not specify the resource group name, the cmdlet searches for the named managed HSM to delete in your current subscription. + +### Example 3: Purge a deleted managed hsm +```powershell +Remove-AzKeyVaultManagedHsm -Name 'myhsm' -Location "eastus" -Force -PassThru +``` + +```output +True +``` + +This command purges the managed HSM named myhsm located at eastus. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet does not prompt you for confirmation. +By default, this cmdlet prompts you to confirm that you want to delete the managed HSM. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Managed HSM object to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm +Parameter Sets: RemoveManagedHsmByInputObject, RemoveDeletedManagedHsmByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InRemovedState +Remove the previously deleted managed HSM pool permanently. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RemoveDeletedManagedHsmByName, RemoveDeletedManagedHsmByInputObject, RemoveDeletedManagedHsmByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the deleted managed HSM pool. + +```yaml +Type: System.String +Parameter Sets: RemoveDeletedManagedHsmByName, RemoveDeletedManagedHsmByResourceId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the managed HSM to remove. + +```yaml +Type: System.String +Parameter Sets: RemoveManagedHsmByName, RemoveDeletedManagedHsmByName +Aliases: HsmName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of resource group for Azure managed HSM to remove. + +```yaml +Type: System.String +Parameter Sets: RemoveManagedHsmByName +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ManagedHsm Resource Id. + +```yaml +Type: System.String +Parameter Sets: RemoveManagedHsmByResourceId, RemoveDeletedManagedHsmByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultManagedHsm](./Get-AzKeyVaultManagedHsm.md) + +[New-AzKeyVaultManagedHsm](./New-AzKeyVaultManagedHsm.md) + +[Update-AzKeyVaultManagedHsm](./Update-AzKeyVaultManagedHsm.md) + +[Undo-AzKeyVaultManagedHsmRemoval](./Undo-AzKeyVaultManagedHsmRemoval.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultManagedStorageAccount.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultManagedStorageAccount.md new file mode 100644 index 0000000000..3b6daced9e --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultManagedStorageAccount.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvaultmanagedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultManagedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultManagedStorageAccount.md +--- + +# Remove-AzKeyVaultManagedStorageAccount + +## SYNOPSIS +Removes a Key Vault managed Azure Storage Account and all associated SAS definitions. + +## SYNTAX + +### ByDefinitionName (Default) +``` +Remove-AzKeyVaultManagedStorageAccount [-VaultName] <String> [-AccountName] <String> [-InRemovedState] [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzKeyVaultManagedStorageAccount [-InputObject] <PSKeyVaultManagedStorageAccountIdentityItem> + [-InRemovedState] [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Disassociates an Azure Storage Account from Key Vault. This does not remove an Azure Storage Account but removes the account keys from being managed by Azure Key Vault. All associated Key Vault managed Storage SAS definitions are also removed. + +## EXAMPLES + +### Example 1: Remove a Key Vault managed Azure Storage Account and all associated SAS definitions. +```powershell +Remove-AzKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -PassThru +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount +Vault Name : myvault +AccountName : mystorageaccount +Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St + orage/storageAccounts/mystorageaccount +Enabled : True +Created : 4/25/2018 1:50:32 AM +Updated : 4/25/2018 1:50:32 AM +Tags : +``` + +Disassociates Azure Storage Account 'mystorageaccount' from Key Vault 'myvault' and stops Key Vault from managing its keys. The account 'mystorageaccount' will not be removed. All Key Vault managed Storage SAS definitions associated with this account will be removed. + +### Example 2: Remove a Key Vault managed Azure Storage Account and all associated SAS definitions without user confirmation. +```powershell +Remove-AzKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -PassThru -Force +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount +Vault Name : myvault +AccountName : mystorageaccount +Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St + orage/storageAccounts/mystorageaccount +Enabled : True +Created : 4/25/2018 1:50:32 AM +Updated : 4/25/2018 1:50:32 AM +Tags : +``` + +Disassociates Azure Storage Account 'mystorageaccount' from Key Vault 'myvault' and stops Key Vault from managing its keys. The account 'mystorageaccount' will not be removed. All Key Vault managed Storage SAS definitions associated with this account will be removed. + +### Example 3: Permanently delete (purge) a Key Vault managed Azure Storage Account and all associated SAS definitions from a soft-delete-enabled vault. +```powershell +Remove-AzKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' +Get-AzKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -InRemovedState +Remove-AzKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -InRemovedState +``` + +The example assumes that soft-delete is enabled for this vault. Verify whether that is the case by examining the vault properties, or the RecoveryLevel attribute of an entity in the vault. +The first cmdlet disassociates Azure Storage Account 'mystorageaccount' from Key Vault 'myvault' and stops Key Vault from managing its keys. The account 'mystorageaccount' will not be removed. All Key Vault managed Storage SAS definitions associated with this account will be removed. +The second cmdlet verifies that the storage account is in a deleted, but recoverable state. Reaching this state may require some time, please allow ~30s before attempting. +The third cmdlet permanently removes the storage account - recovery will no longer be possible. + +## PARAMETERS + +### -AccountName +Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected environment and manged storage account name. + +```yaml +Type: System.String +Parameter Sets: ByDefinitionName +Aliases: StorageAccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +ManagedStorageAccount object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InRemovedState +Permanently remove the previously deleted managed storage account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Cmdlet does not return an object by default. +If this switch is specified, cmdlet returns the managed storage account that was deleted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: ByDefinitionName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageAccount + +## NOTES + +## RELATED LINKS + +[Azure Key Vault PowerShell cmdlets](/powershell/module/az.keyvault/) diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultManagedStorageSasDefinition.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultManagedStorageSasDefinition.md new file mode 100644 index 0000000000..b6aa047f68 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultManagedStorageSasDefinition.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvaultmanagedstoragesasdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultManagedStorageSasDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultManagedStorageSasDefinition.md +--- + +# Remove-AzKeyVaultManagedStorageSasDefinition + +## SYNOPSIS +Removes a Key Vault managed Azure Storage SAS definitions. + +## SYNTAX + +### ByDefinitionName (Default) +``` +Remove-AzKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzKeyVaultManagedStorageSasDefinition [-InputObject] <PSKeyVaultManagedStorageSasDefinitionIdentityItem> + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes a Key Vault managed Azure Storage SAS definitions. This also removes the secret used to get the SAS token per this SAS definition. + +## EXAMPLES + +### Example 1: Remove a Key Vault managed Azure Storage SAS definition. +```powershell +Remove-AzKeyVaultManagedStorageSasDefinition -VaultName 'myvault' -AccountName 'mystorageaccount' -Name 'mysasdef' -PassThru +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount/sas/mysasdef +Vault Name : myvault +AccountName : mystorageaccount +Name : mysasdef +Enabled : True +Created : 5/24/2018 9:11:08 PM +Updated : 5/24/2018 9:11:08 PM +Tags : +``` + +Removes a Key Vault managed Storage SAS definition 'mysasdef' associated with the account 'mystorageaccount' in vault 'myvault'. + +### Example 2: Remove a Key Vault managed Azure Storage SAS definition without user confirmation. +```powershell +Remove-AzKeyVaultManagedStorageSasDefinition -VaultName 'myvault' -AccountName 'mystorageaccount' -Name 'mysasdef' -PassThru -Force +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount/sas/mysasdef +Vault Name : myvault +AccountName : mystorageaccount +Name : mysasdef +Enabled : True +Created : 5/24/2018 9:11:08 PM +Updated : 5/24/2018 9:11:08 PM +Tags : +``` + +Removes a Key Vault managed Storage SAS definition 'mysasdef' associated with the account 'mystorageaccount' in vault 'myvault'. + +## PARAMETERS + +### -AccountName +Storage account name. +Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected environment and storage account name. + +```yaml +Type: System.String +Parameter Sets: ByDefinitionName +Aliases: StorageAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +ManagedStorageSasDefinition object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageSasDefinitionIdentityItem +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Storage sas definition name. +Cmdlet constructs the FQDN of a storage sas definition from vault name, currently selected environment, storage account name and sas definition name. + +```yaml +Type: System.String +Parameter Sets: ByDefinitionName +Aliases: SasDefinitionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Cmdlet does not return an object by default. +If this switch is specified, cmdlet returns the managed storage account that was deleted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: ByDefinitionName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageSasDefinitionIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageSasDefinition + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultManagedStorageSasDefinition](./Get-AzKeyVaultManagedStorageSasDefinition.md) + +[Set-AzKeyVaultManagedStorageSasDefinition](./Set-AzKeyVaultManagedStorageSasDefinition.md) + +[Undo-AzKeyVaultManagedStorageSasDefinitionRemoval](./Undo-AzKeyVaultManagedStorageSasDefinitionRemoval.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultNetworkRule.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultNetworkRule.md new file mode 100644 index 0000000000..7698903289 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultNetworkRule.md @@ -0,0 +1,275 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvaultnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultNetworkRule.md +--- + +# Remove-AzKeyVaultNetworkRule + +## SYNOPSIS +Removes a network rule from a key vault. + +## SYNTAX + +### ByVaultName (Default) +``` +Remove-AzKeyVaultNetworkRule [-VaultName] <String> [[-ResourceGroupName] <String>] [-IpAddressRange <String[]>] + [-VirtualNetworkResourceId <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzKeyVaultNetworkRule [-InputObject] <PSKeyVault> [-IpAddressRange <String[]>] + [-VirtualNetworkResourceId <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzKeyVaultNetworkRule [-ResourceId] <String> [-IpAddressRange <String[]>] + [-VirtualNetworkResourceId <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Removes a network rule from a key vault. + +## EXAMPLES + +### Example 1 +```powershell +$myNetworkResId = (Get-AzVirtualNetwork -Name myVNetName -ResourceGroupName myRG).Subnets[0].Id +Remove-AzKeyVaultNetworkRule -VaultName myVault -IpAddressRange "10.0.0.1/26" -VirtualNetworkResourceId $myNetworkResId -PassThru +``` + +```output +Vault Name : myVault +Resource Group Name : myrg +Location : West US +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers + /Microsoft.KeyVault/vaults/myvault +Vault URI : https://myvault.vault.azure.net/ +Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +SKU : Standard +Enabled For Deployment? : False +Enabled For Template Deployment? : False +Enabled For Disk Encryption? : False +Soft Delete Enabled? : +Access Policies : + Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Application ID : + Display Name : User Name (username@microsoft.com) + Permissions to Keys : get, create, delete, list, update, + import, backup, restore, recover + Permissions to Secrets : get, list, set, delete, backup, + restore, recover + Permissions to Certificates : get, delete, list, create, import, + update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers, + setissuers, recover, backup, restore + Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list, + listsas, regeneratekey, set, setsas, update, recover, backup, restore + + +Network Rule Set : + Default Action : Allow + Bypass : AzureServices + IP Rules : + Virtual Network Rules : + +Tags : +``` + +This command removes a network rule from the specified vault, provided a rule is found matching the specified IP address and the virtual network resource identifier. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IpAddressRange +Specifies allowed network IP address range of network rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns the updated key vault object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group associated with the key vault whose network rule is being modified. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +KeyVault Resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault whose network rule is being modified. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkResourceId +Specifies allowed virtual network resource identifier of network rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultRoleAssignment.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultRoleAssignment.md new file mode 100644 index 0000000000..62ad383ab2 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultRoleAssignment.md @@ -0,0 +1,307 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvaultroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultRoleAssignment.md +--- + +# Remove-AzKeyVaultRoleAssignment + +## SYNOPSIS +Removes a role assignment to the specified principal who is assigned to a particular role at a particular scope. + +## SYNTAX + +### DefinitionNameSignInName (Default) +``` +Remove-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] -RoleDefinitionName <String> + -SignInName <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DefinitionNameApplicationId +``` +Remove-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] -RoleDefinitionName <String> + -ApplicationId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DefinitionNameObjectId +``` +Remove-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] -RoleDefinitionName <String> + -ObjectId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DefinitionIdApplicationId +``` +Remove-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] -RoleDefinitionId <String> + -ApplicationId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DefinitionIdObjectId +``` +Remove-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] -RoleDefinitionId <String> + -ObjectId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DefinitionIdSignInName +``` +Remove-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] -RoleDefinitionId <String> + -SignInName <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RemoveByNameParameterSet +``` +Remove-AzKeyVaultRoleAssignment [-HsmName] <String> [-Scope <String>] [-PassThru] -RoleAssignmentName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzKeyVaultRoleAssignment [-Scope <String>] [-PassThru] -InputObject <PSKeyVaultRoleAssignment> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use the `Remove-AzKeyVaultRoleAssignment` cmdlet to revoke access to any principal at given scope and given role. The object of the assignment i.e. the principal MUST be specified. The principal can be a user (use SignInName or ObjectId parameters to identify a user), security group (use ObjectId parameter to identify a group) or service principal (use ApplicationId or ObjectId parameters to identify a ServicePrincipal. The role that the principal is assigned to MUST be specified using the RoleDefinitionName or RoleDefinitionId parameter. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /users/{id} +- GET /servicePrincipals + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzKeyVaultRoleAssignment -HsmName myHsm -RoleDefinitionName "Managed HSM Policy Administrator" -SignInName user1@microsoft.com -Scope "/keys" +``` + +This example revokes "Managed HSM Policy Administrator" role of "user1@microsoft.com" at "/keys" scope. + +### Example 2 +```powershell +Get-AzKeyVaultRoleAssignment -HsmName myHsm -SignInName user1@microsoft.com | Remove-AzKeyVaultRoleAssignment +``` + +This example revokes all roles of "user1@microsoft.com" at all scopes. + +## PARAMETERS + +### -ApplicationId +The app SPN. + +```yaml +Type: System.String +Parameter Sets: DefinitionNameApplicationId, DefinitionIdApplicationId +Aliases: SPN, ServicePrincipalName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +Name of the HSM. + +```yaml +Type: System.String +Parameter Sets: DefinitionNameSignInName, DefinitionNameApplicationId, DefinitionNameObjectId, DefinitionIdApplicationId, DefinitionIdObjectId, DefinitionIdSignInName, RemoveByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Role assignment object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultRoleAssignment +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ObjectId +The user or group object id. + +```yaml +Type: System.String +Parameter Sets: DefinitionNameObjectId, DefinitionIdObjectId +Aliases: Id, PrincipalId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return true when the HSM is restored. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleAssignmentName +Name of the role assignment. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +Role Id the principal is assigned to. + +```yaml +Type: System.String +Parameter Sets: DefinitionIdApplicationId, DefinitionIdObjectId, DefinitionIdSignInName +Aliases: RoleId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionName +Name of the RBAC role to assign the principal with. + +```yaml +Type: System.String +Parameter Sets: DefinitionNameSignInName, DefinitionNameApplicationId, DefinitionNameObjectId +Aliases: RoleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Scope at which the role assignment or definition applies to, e.g., '/' or '/keys' or '/keys/{keyName}'. +'/' is used when omitted. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignInName +The user SignInName. + +```yaml +Type: System.String +Parameter Sets: DefinitionNameSignInName, DefinitionIdSignInName +Aliases: Email, UserPrincipalName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultRoleAssignment + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultRoleAssignment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultRoleDefinition.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultRoleDefinition.md new file mode 100644 index 0000000000..e58bbe37e4 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultRoleDefinition.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvaultroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultRoleDefinition.md +--- + +# Remove-AzKeyVaultRoleDefinition + +## SYNOPSIS +Removes a custom role definition from an HSM. + +## SYNTAX + +### ByName (Default) +``` +Remove-AzKeyVaultRoleDefinition [-HsmName] <String> [-Scope <String>] -RoleName <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzKeyVaultRoleDefinition [-HsmName] <String> [-Scope <String>] -InputObject <PSKeyVaultRoleDefinition> + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The `Remove-AzKeyVaultRoleDefinition` cmdlet deletes a custom role in Azure Role-Based Access Control of Azure KeyVault managed HSM. +Provide the `-RoleName` parameter of an existing custom role or a role object to delete that custom role. +By default, `Remove-AzKeyVaultRoleDefinition` prompts you for confirmation. +To suppress the prompt, use the `-Force` parameter. + +## EXAMPLES + +### Example 1 + +```powershell +Remove-AzKeyVaultRoleDefinition -HsmName myHsm -RoleName "my role" +``` + +This example removes a custom role named "my role". + +### Example 2 + +```powershell +$role = Get-AzKeyVaultRoleDefinition -HsmName myHsm -RoleName "my role" +$role | Remove-AzKeyVaultRoleDefinition -HsmName myHsm -Force +``` + +This example removes a custom role named "my role" by piping the role object. It also suppress the prompt by `-Force`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirm. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +Name of the HSM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The object representing the role definition to be removed. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultRoleDefinition +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +This cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleName +Name of the role definition to get. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: RoleDefinitionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Scope at which the role assignment or definition applies to, e.g., '/' or '/keys' or '/keys/{keyName}'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultRoleDefinition + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultSecret.md b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultSecret.md new file mode 100644 index 0000000000..6dc8745bf6 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Remove-AzKeyVaultSecret.md @@ -0,0 +1,272 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/remove-azkeyvaultsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Remove-AzKeyVaultSecret.md +--- + +# Remove-AzKeyVaultSecret + +## SYNOPSIS +Deletes a secret in a key vault. + +## SYNTAX + +### ByVaultName (Default) +``` +Remove-AzKeyVaultSecret [-VaultName] <String> [-Name] <String> [-Force] [-PassThru] [-InRemovedState] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzKeyVaultSecret [-InputObject] <PSKeyVaultSecretIdentityItem> [-Force] [-PassThru] [-InRemovedState] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzKeyVaultSecret cmdlet deletes a secret in a key vault. +If the secret was accidentally deleted the secret can be recovered using Undo-AzKeyVaultSecretRemoval by a user with special 'recover' permissions. +This cmdlet has a value of high for the **ConfirmImpact** property. + +## EXAMPLES + +### Example 1: Remove a secret from a key vault +```powershell +Remove-AzKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -PassThru +``` + +```output +Vault Name : Contoso +Name : FinanceSecret +Version : f622abc7b1394092812f1eb0f85dc91c +Id : https://contoso.vault.azure.net:443/secrets/financesecret/f622abc7b1394092812f1eb0f85dc91c +Deleted Date : 5/25/2018 4:45:34 PM +Scheduled Purge Date : 8/23/2018 4:45:34 PM +Enabled : True +Expires : +Not Before : +Created : 4/19/2018 5:56:02 PM +Updated : 4/26/2018 7:48:40 PM +Content Type : +Tags : +``` + +This command removes the secret named FinanceSecret from the key vault named Contoso.' + +### Example 2: Remove a secret from a key vault without user confirmation +```powershell +Remove-AzKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -PassThru -Force +``` + +```output +Vault Name : Contoso +Name : FinanceSecret +Version : f622abc7b1394092812f1eb0f85dc91c +Id : https://contoso.vault.azure.net:443/secrets/financesecret/f622abc7b1394092812f1eb0f85dc91c +Deleted Date : 5/25/2018 4:45:34 PM +Scheduled Purge Date : 8/23/2018 4:45:34 PM +Enabled : True +Expires : +Not Before : +Created : 4/19/2018 5:56:02 PM +Updated : 4/26/2018 7:48:40 PM +Content Type : +Tags : +``` + +This command removes the secret named FinanceSecret from the key vault named Contoso. +The command specifies the *Force* and *Confirm* parameters, and, therefore, the cmdlet does not prompt you for confirmation. + +### Example 3: Remove a secret in Azure Key Vault by command Remove-Secret in module Microsoft.PowerShell.SecretManagement +```powershell +# Install module Microsoft.PowerShell.SecretManagement +Install-Module Microsoft.PowerShell.SecretManagement -Repository PSGallery -AllowPrerelease +# Register vault for Secret Management +Register-SecretVault -Name AzKeyVault -ModuleName Az.KeyVault -VaultParameters @{ AZKVaultName = 'test-kv'; SubscriptionId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' } +# Set secret for vault AzKeyVault +$secure = ConvertTo-SecureString -String "Password" -AsPlainText -Force +Set-Secret -Vault AzKeyVault -Name secureSecret -SecureStringSecret $secure +Remove-Secret -Vault AzKeyVault -Name secureSecret +``` + +```output +None +``` + +This example removes a secret named `secureSecret` in Azure Key Vault `test-kv` by command `Remove-Secret` in module `Microsoft.PowerShell.SecretManagement`. + + +### Example 4: Purge deleted secret from the key vault permanently +```powershell +Remove-AzKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -InRemovedState +``` + +This command removes the secret named FinanceSecret from the key vault named Contoso permanently. +Executing this cmdlet requires the 'purge' permission, which must have been previously and explicitly granted to the user for this key vault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Key Vault Secret Object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InRemovedState +If present, removes the previously deleted secret permanently. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a secret. +This cmdlet constructs the fully qualified domain name (FQDN) of a secret based on the name that this parameter specifies, the name of the key vault, and your current environment. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: SecretName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Microsoft.Azure.Commands.KeyVault.Models.Secret** object. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault to which the secret belongs. +This cmdlet constructs the FQDN of a key vault based on the name that this parameter specifies and your current environment. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run.Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultSecret + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultSecret](./Get-AzKeyVaultSecret.md) + +[Set-AzKeyVaultSecret](./Set-AzKeyVaultSecret.md) + +[Undo-AzKeyVaultSecretRemoval](./Undo-AzKeyVaultSecretRemoval.md) + diff --git a/azps-10.1.0/Az.KeyVault/Restore-AzKeyVault.md b/azps-10.1.0/Az.KeyVault/Restore-AzKeyVault.md new file mode 100644 index 0000000000..c76db134d3 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Restore-AzKeyVault.md @@ -0,0 +1,257 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/restore-azkeyvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Restore-AzKeyVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Restore-AzKeyVault.md +--- + +# Restore-AzKeyVault + +## SYNOPSIS +Fully restores a managed HSM from backup. + +## SYNTAX + +### InteractiveStorageName (Default) +``` +Restore-AzKeyVault -BackupFolder <String> [-KeyName <String>] [-PassThru] [-HsmName] <String> + -StorageAccountName <String> -StorageContainerName <String> -SasToken <SecureString> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InteractiveStorageUri +``` +Restore-AzKeyVault -BackupFolder <String> [-KeyName <String>] [-PassThru] [-HsmName] <String> + -StorageContainerUri <Uri> -SasToken <SecureString> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectStorageUri +``` +Restore-AzKeyVault -BackupFolder <String> [-KeyName <String>] [-PassThru] -StorageContainerUri <Uri> + -SasToken <SecureString> -HsmObject <PSManagedHsm> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectStorageName +``` +Restore-AzKeyVault -BackupFolder <String> [-KeyName <String>] [-PassThru] -StorageAccountName <String> + -StorageContainerName <String> -SasToken <SecureString> -HsmObject <PSManagedHsm> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Fully restores a managed HSM from a backup stored in a storage account. +Use `Backup-AzKeyVault` to backup. + +## EXAMPLES + +### Example 1 +```powershell +$sasToken = ConvertTo-SecureString -AsPlainText -Force "?sv=2019-12-12&ss=bfqt&srt=sco&sp=rwdlacupx&se=2020-10-12T14:42:19Z&st=2020-10-12T06:42:19Z&spr=https&sig=******" +Restore-AzKeyVault -HsmName myHsm -StorageContainerUri "https://{accountName}.blob.core.windows.net/{containerName}" -BackupFolder "mhsm-myHsm-2020101308504935" -SasToken $sasToken +``` + +The example restores a backup stored in a folder named "mhsm-myHsm-2020101308504935" of a storage container "https://{accountName}.blob.core.windows.net/{containerName}". + +## PARAMETERS + +### -BackupFolder +Folder name of the backup, e.g. +'mhsm-*-2020101309020403'. +It can also be nested such as 'backups/mhsm-*-2020101309020403'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +Name of the HSM. + +```yaml +Type: System.String +Parameter Sets: InteractiveStorageName, InteractiveStorageUri +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmObject +Managed HSM object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm +Parameter Sets: InputObjectStorageUri, InputObjectStorageName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +Key name to restore. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return true when the HSM is restored. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SasToken +The shared access signature (SAS) token to authenticate the storage account. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +Name of the storage account where the backup is going to be stored. + +```yaml +Type: System.String +Parameter Sets: InteractiveStorageName, InputObjectStorageName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerName +Name of the blob container where the backup is going to be stored. + +```yaml +Type: System.String +Parameter Sets: InteractiveStorageName, InputObjectStorageName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerUri +URI of the storage container where the backup is going to be stored. + +```yaml +Type: System.Uri +Parameter Sets: InteractiveStorageUri, InputObjectStorageUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Restore-AzKeyVaultCertificate.md b/azps-10.1.0/Az.KeyVault/Restore-AzKeyVaultCertificate.md new file mode 100644 index 0000000000..8e2a24866c --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Restore-AzKeyVaultCertificate.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/restore-azkeyvaultcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Restore-AzKeyVaultCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Restore-AzKeyVaultCertificate.md +--- + +# Restore-AzKeyVaultCertificate + +## SYNOPSIS +Restores a certificate in a key vault from a backup file. + +## SYNTAX + +### ByVaultName (Default) +``` +Restore-AzKeyVaultCertificate [-VaultName] <String> [-InputFile] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Restore-AzKeyVaultCertificate [-InputObject] <PSKeyVault> [-InputFile] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Restore-AzKeyVaultCertificate [-ResourceId] <String> [-InputFile] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzKeyVaultCertificate** cmdlet creates a certificate in the specified key vault from a backup file. +This certificate is a replica of the backed-up certificate in the input file and has the same name as the original certificate. +If the key vault already contains a certificate by the same name, this cmdlet fails instead of overwriting the original certificate. +If the backup contains multiple versions of a certificate, all versions are restored. +The key vault that you restore the certificate into can be different from the key vault that you backed up the certificate from. +However, the key vault must use the same subscription and be in an Azure region in the same geography (for example, North America). +See the Microsoft Azure Trust Center (https://azure.microsoft.com/support/trust-center/) for the mapping of Azure regions to geographies. + +## EXAMPLES + +### Example 1: Restore a backed-up certificate +```powershell +Restore-AzKeyVaultCertificate -VaultName 'MyKeyVault' -InputFile "C:\Backup.blob" +``` + +```output +Certificate : [Subject] + CN=contoso.com + + [Issuer] + CN=contoso.com + + [Serial Number] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + [Not Before] + 5/25/2018 3:47:41 AM + + [Not After] + 11/25/2018 2:57:41 AM + + [Thumbprint] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + +KeyId : https://mykeyvault.vault.azure.net:443/keys/cert1/bd406f6d6b3a41a1a1c633494d8c3c3a +SecretId : https://mykeyvault.vault.azure.net:443/secrets/cert1/bd406f6d6b3a41a1a1c633494d8c3c3a +Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +RecoveryLevel : Purgeable +Enabled : True +Expires : 11/25/2018 10:57:41 AM +NotBefore : 5/25/2018 10:47:41 AM +Created : 5/25/2018 10:57:41 AM +Updated : 5/25/2018 10:57:41 AM +Tags : +VaultName : MyKeyVault +Name : cert1 +Version : bd406f6d6b3a41a1a1c633494d8c3c3a +Id : https://mykeyvault.vault.azure.net:443/certificates/cert1/bd406f6d6b3a41a1a1c633494d8c3c3a +``` + +This command restores a certificate, including all of its versions, from the backup file named Backup.blob into the key vault named MyKeyVault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +Input file. +The input file containing the backed-up blob + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceId +KeyVault Resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Restore-AzKeyVaultKey.md b/azps-10.1.0/Az.KeyVault/Restore-AzKeyVaultKey.md new file mode 100644 index 0000000000..91c1b85a6d --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Restore-AzKeyVaultKey.md @@ -0,0 +1,263 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: C4E7ACDF-22FB-4D49-93B3-69E787B7E0CD +online version: https://learn.microsoft.com/powershell/module/az.keyvault/restore-azkeyvaultkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Restore-AzKeyVaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Restore-AzKeyVaultKey.md +--- + +# Restore-AzKeyVaultKey + +## SYNOPSIS +Creates a key in a key vault from a backed-up key. + +## SYNTAX + +### ByVaultName (Default) +``` +Restore-AzKeyVaultKey [-VaultName] <String> [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HsmByVaultName +``` +Restore-AzKeyVaultKey -HsmName <String> [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Restore-AzKeyVaultKey [-InputObject] <PSKeyVault> [-InputFile] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HsmByInputObject +``` +Restore-AzKeyVaultKey [-HsmObject] <PSManagedHsm> [-InputFile] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Restore-AzKeyVaultKey [-ResourceId] <String> [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HsmByResourceId +``` +Restore-AzKeyVaultKey -HsmResourceId <String> [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzKeyVaultKey** cmdlet creates a key in the specified key vault. +This key is a replica of the backed-up key in the input file and has the same name as the original key. +If the key vault already has a key by the same name, this cmdlet fails instead of overwriting the original key. +If the backup contains multiple versions of a key, all versions are restored. +The key vault that you restore the key into can be different from the key vault that you backed up the key from. +However, the key vault must use the same subscription and be in an Azure region in the same geography (for example, North America). +See the Microsoft Azure Trust Center (https://azure.microsoft.com/support/trust-center/) for the mapping of Azure regions to geographies. + +## EXAMPLES + +### Example 1: Restore a backed-up key +```powershell +Restore-AzKeyVaultKey -VaultName 'MyKeyVault' -InputFile "C:\Backup.blob" +``` + +```output +Vault Name : MyKeyVault +Name : key1 +Version : 394f9379a47a4e2086585468de6c7ae5 +Id : https://mykeyvault.vault.azure.net:443/keys/key1/394f9379a47a4e2086585468de6c7ae5 +Enabled : True +Expires : +Not Before : +Created : 4/6/2018 11:31:36 PM +Updated : 4/6/2018 11:35:04 PM +Purge Disabled : False +Tags : +``` + +This command restores a key, including all of its versions, from the backup file named Backup.blob into the key vault named MyKeyVault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +HSM name. Cmdlet constructs the FQDN of a managed HSM based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: HsmByVaultName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmObject +HSM object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm +Parameter Sets: HsmByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -HsmResourceId +Hsm Resource Id + +```yaml +Type: System.String +Parameter Sets: HsmByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputFile +Specifies the input file that contains the backup of the key to restore. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceId +KeyVault Resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault into which to restore the key. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey + +## NOTES + +## RELATED LINKS + +[Add-AzKeyVaultKey](./Add-AzKeyVaultKey.md) + +[Backup-AzKeyVaultKey](./Backup-AzKeyVaultKey.md) + +[Get-AzKeyVaultKey](./Get-AzKeyVaultKey.md) + +[Remove-AzKeyVaultKey](./Remove-AzKeyVaultKey.md) + diff --git a/azps-10.1.0/Az.KeyVault/Restore-AzKeyVaultManagedStorageAccount.md b/azps-10.1.0/Az.KeyVault/Restore-AzKeyVaultManagedStorageAccount.md new file mode 100644 index 0000000000..b177aaf8d0 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Restore-AzKeyVaultManagedStorageAccount.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/restore-azkeyvaultmanagedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Restore-AzKeyVaultManagedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Restore-AzKeyVaultManagedStorageAccount.md +--- + +# Restore-AzKeyVaultManagedStorageAccount + +## SYNOPSIS +Restores a managed storage account in a key vault from a backup file. + +## SYNTAX + +### ByVaultName (Default) +``` +Restore-AzKeyVaultManagedStorageAccount [-VaultName] <String> [-InputFile] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Restore-AzKeyVaultManagedStorageAccount [-InputObject] <PSKeyVault> [-InputFile] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Restore-AzKeyVaultManagedStorageAccount [-ResourceId] <String> [-InputFile] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzKeyVaultManagedStorageAccount** cmdlet creates a managed storage account in the specified key vault from a backup file. +This managed storage account is a replica of the backed-up managed storage account in the input file and has the same name as the original. +If the key vault already contains a managed storage account by the same name, this cmdlet fails instead of overwriting the original. +The key vault that you restore the managed storage account into can be different from the key vault that you backed up the managed storage account from. +However, the key vault must use the same subscription and be in an Azure region in the same geography (for example, North America). +See the Microsoft Azure Trust Center (https://azure.microsoft.com/support/trust-center/) for the mapping of Azure regions to geographies. + +## EXAMPLES + +### Example 1: Restore a backed-up managed storage account +```powershell +Restore-AzKeyVaultManagedStorageAccount -VaultName 'MyKeyVault' -InputFile "C:\Backup.blob" +``` + +```output +Id : https://mykeyvault.vault.azure.net:443/storage/mystorageaccount +Vault Name : MyKeyVault +AccountName : mystorageaccount +Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St + orage/storageAccounts/mystorageaccount +Active Key Name : key1 +Auto Regenerate Key : True +Regeneration Period : 90.00:00:00 +Enabled : True +Created : 5/21/2018 11:55:58 PM +Updated : 5/21/2018 11:55:58 PM +Tags : +``` + +This command restores a managed storage account, including all of its versions, from the backup file named Backup.blob into the key vault named MyKeyVault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +Input file. +The input file containing the backed-up blob + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceId +KeyVault Resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccount + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Restore-AzKeyVaultSecret.md b/azps-10.1.0/Az.KeyVault/Restore-AzKeyVaultSecret.md new file mode 100644 index 0000000000..1ad834ee42 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Restore-AzKeyVaultSecret.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 70DB088D-4AF5-406B-8D66-118A0F766041 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/restore-azkeyvaultsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Restore-AzKeyVaultSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Restore-AzKeyVaultSecret.md +--- + +# Restore-AzKeyVaultSecret + +## SYNOPSIS +Creates a secret in a key vault from a backed-up secret. + +## SYNTAX + +### ByVaultName (Default) +``` +Restore-AzKeyVaultSecret [-VaultName] <String> [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Restore-AzKeyVaultSecret [-InputObject] <PSKeyVault> [-InputFile] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Restore-AzKeyVaultSecret [-ResourceId] <String> [-InputFile] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzKeyVaultSecret** cmdlet creates a secret in the specified key vault. +This secret is a replica of the backed-up secret in the input file and has the same name as the original secret. +If the key vault already has a secret by the same name, this cmdlet fails instead of overwriting the original secret. +If the backup contains multiple versions of a secret, all versions are restored. +The key vault that you restore the secret into can be different from the key vault that you backed up the secret from. +However, the key vault must use the same subscription and be in an Azure region in the same geography (for example, North America). +See the Microsoft Azure Trust Center (https://azure.microsoft.com/support/trust-center/) for the mapping of Azure regions to geographies. + +## EXAMPLES + +### Example 1: Restore a backed-up secret +```powershell +Restore-AzKeyVaultSecret -VaultName 'contoso' -InputFile "C:\Backup.blob" +``` + +```output +Vault Name : contoso +Name : secret1 +Version : 7128133570f84a71b48d7d0550deb74c +Id : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c +Enabled : True +Expires : 4/6/2018 3:59:43 PM +Not Before : +Created : 4/5/2018 11:46:28 PM +Updated : 4/6/2018 11:30:17 PM +Content Type : +Tags : +``` + +This command restores a secret, including all of its versions, from the backup file named Backup.blob into the key vault named contoso. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +Specifies the input file that contains the backup of the secret to restore. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceId +KeyVault Resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault into which to restore the secret. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecret + +## NOTES + +## RELATED LINKS + +[Set-AzKeyVaultSecret](./Set-AzKeyVaultSecret.md) + +[Backup-AzKeyVaultSecret](./Backup-AzKeyVaultSecret.md) + +[Get-AzKeyVaultSecret](./Get-AzKeyVaultSecret.md) + +[Remove-AzKeyVaultSecret](./Remove-AzKeyVaultSecret.md) + diff --git a/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultAccessPolicy.md b/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultAccessPolicy.md new file mode 100644 index 0000000000..5d32fc8a3d --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultAccessPolicy.md @@ -0,0 +1,731 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 636FAD5B-8C39-4E5C-8978-6845C6B89BC0 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/set-azkeyvaultaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Set-AzKeyVaultAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Set-AzKeyVaultAccessPolicy.md +--- + +# Set-AzKeyVaultAccessPolicy + +## SYNOPSIS +Grants or modifies existing permissions for a user, application, or security group to perform operations with a key vault. + +## SYNTAX + +### ByUserPrincipalName (Default) +``` +Set-AzKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -UserPrincipalName <String> + [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] + [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ByObjectId +``` +Set-AzKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -ObjectId <String> + [-ApplicationId <Guid>] [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] + [-PermissionsToCertificates <String[]>] [-PermissionsToStorage <String[]>] [-BypassObjectIdValidation] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ByServicePrincipalName +``` +Set-AzKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -ServicePrincipalName <String> + [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] + [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ByEmailAddress +``` +Set-AzKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -EmailAddress <String> + [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] + [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ForVault +``` +Set-AzKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] [-EnabledForDeployment] + [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### InputObjectByObjectId +``` +Set-AzKeyVaultAccessPolicy [-InputObject] <PSKeyVaultIdentityItem> -ObjectId <String> [-ApplicationId <Guid>] + [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] + [-PermissionsToStorage <String[]>] [-BypassObjectIdValidation] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### InputObjectByServicePrincipalName +``` +Set-AzKeyVaultAccessPolicy [-InputObject] <PSKeyVaultIdentityItem> -ServicePrincipalName <String> + [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] + [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +### InputObjectByUserPrincipalName +``` +Set-AzKeyVaultAccessPolicy [-InputObject] <PSKeyVaultIdentityItem> -UserPrincipalName <String> + [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] + [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +### InputObjectByEmailAddress +``` +Set-AzKeyVaultAccessPolicy [-InputObject] <PSKeyVaultIdentityItem> -EmailAddress <String> + [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] + [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +### InputObjectForVault +``` +Set-AzKeyVaultAccessPolicy [-InputObject] <PSKeyVaultIdentityItem> [-EnabledForDeployment] + [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ResourceIdByObjectId +``` +Set-AzKeyVaultAccessPolicy [-ResourceId] <String> -ObjectId <String> [-ApplicationId <Guid>] + [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] + [-PermissionsToStorage <String[]>] [-BypassObjectIdValidation] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ResourceIdByServicePrincipalName +``` +Set-AzKeyVaultAccessPolicy [-ResourceId] <String> -ServicePrincipalName <String> + [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] + [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +### ResourceIdByUserPrincipalName +``` +Set-AzKeyVaultAccessPolicy [-ResourceId] <String> -UserPrincipalName <String> [-PermissionsToKeys <String[]>] + [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] [-PermissionsToStorage <String[]>] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ResourceIdByEmailAddress +``` +Set-AzKeyVaultAccessPolicy [-ResourceId] <String> -EmailAddress <String> [-PermissionsToKeys <String[]>] + [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] [-PermissionsToStorage <String[]>] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ResourceIdForVault +``` +Set-AzKeyVaultAccessPolicy [-ResourceId] <String> [-EnabledForDeployment] [-EnabledForTemplateDeployment] + [-EnabledForDiskEncryption] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzKeyVaultAccessPolicy** cmdlet grants or modifies existing permissions for a user, application, or security group to perform the specified operations with a key vault. It does not modify the permissions that other users, applications, or security groups have on the key vault. +If you are setting permissions for a security group, this operation affects only users in that security group. +The following directories must all be the same Azure directory: +- The default directory of the Azure subscription in which the key vault resides. +- The Azure directory that contains the user or application group that you are granting permissions to. +Examples of scenarios when these conditions are not met and this cmdlet will not work are: +- Authorizing a user from a different organization to manage your key vault. +Each organization has its own directory. +- Your Azure account has multiple directories. +If you register an application in a directory other than the default directory, you cannot authorize that application to use your key vault. +The application must be in the default directory. +Note that although specifying the resource group is optional for this cmdlet, you should do so for better performance. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /directoryObjects/{id} +- GET /users/{id} +- GET /users +- GET /servicePrincipals/{id} +- GET /servicePrincipals +- GET /groups/{id} + +> [!NOTE] +> When using a service principal to grant access policy permissions, you must use the `-BypassObjectIdValidation` parameter. + +## EXAMPLES + +### Example 1: Grant permissions to a user for a key vault and modify the permissions +<!-- Skip: Output cannot be splitted from code --> +```powershell +Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToKeys create,import,delete,list -PermissionsToSecrets set,delete -PassThru + +Vault Name : Contoso03Vault +Resource Group Name : myrg +Location : westus +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers + /Microsoft.KeyVault/vaults/contoso03vault +Vault URI : https://contoso03vault.vault.azure.net/ +Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +SKU : Standard +Enabled For Deployment? : True +Enabled For Template Deployment? : False +Enabled For Disk Encryption? : False +Soft Delete Enabled? : True +Access Policies : + Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Application ID : + Display Name : User Name (username@microsoft.com) + Permissions to Keys : create, import, delete, list + Permissions to Secrets : set, delete + Permissions to Certificates : + Permissions to (Key Vault Managed) Storage : + +Tags : + +Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToSecrets set,delete,get -PassThru + +Vault Name : Contoso03Vault +Resource Group Name : myrg +Location : westus +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers + /Microsoft.KeyVault/vaults/contoso03vault +Vault URI : https://contoso03vault.vault.azure.net/ +Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +SKU : Standard +Enabled For Deployment? : True +Enabled For Template Deployment? : False +Enabled For Disk Encryption? : False +Soft Delete Enabled? : True +Access Policies : + Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Application ID : + Display Name : User Name (username@microsoft.com) + Permissions to Keys : create, import, delete, list + Permissions to Secrets : set, delete, get + Permissions to Certificates : + Permissions to (Key Vault Managed) Storage : + +Tags : + +Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToKeys @() -PassThru + +Vault Name : Contoso03Vault +Resource Group Name : myrg +Location : westus +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers + /Microsoft.KeyVault/vaults/contoso03vault +Vault URI : https://contoso03vault.vault.azure.net/ +Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +SKU : Standard +Enabled For Deployment? : True +Enabled For Template Deployment? : False +Enabled For Disk Encryption? : False +Soft Delete Enabled? : True +Access Policies : + Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Application ID : + Display Name : User Name (username@microsoft.com) + Permissions to Keys : + Permissions to Secrets : set, delete, get + Permissions to Certificates : + Permissions to (Key Vault Managed) Storage : + +Tags : +``` + +The first command grants permissions for a user in your Azure Active Directory, PattiFuller@contoso.com, to perform operations on keys and secrets with a key vault named Contoso03Vault. The *PassThru* parameter results in the updated object being returned by the cmdlet. +The second command modifies the permissions that were granted to PattiFuller@contoso.com in the first command, to now allow getting secrets in addition to setting and deleting them. The permissions to key operations remain unchanged after this command. +The final command further modifies the existing permissions for PattiFuller@contoso.com to remove all permissions to key operations. The permissions to secret operations remain unchanged after this command. + +### Example 2: Grant permissions for an application service principal to read and write secrets +```powershell +Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ServicePrincipalName 'http://payroll.contoso.com' -PermissionsToSecrets Get,Set +``` + +This command grants permissions for an application for a key vault named Contoso03Vault. +The *ServicePrincipalName* parameter specifies the application. The application must be registered in your Azure Active Directory. The value of the *ServicePrincipalName* parameter must be either the service principal name of the application or the application ID GUID. +This example specifies the service principal name `http://payroll.contoso.com`, and the command grants the application permissions to read and write secrets. + +### Example 3: Grant permissions for an application using its object ID +```powershell +Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ObjectId 34595082-9346-41b6-8d6b-295a2808b8db -PermissionsToSecrets Get,Set +``` + +This command grants the application permissions to read and write secrets. +This example specifies the application using the object ID of the service principal of the application. + +### Example 4: Grant permissions for a user principal name +```powershell +Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToSecrets Get,List,Set +``` + +This command grants get, list, and set permissions for the specified user principal name for access to secrets. + +### Example 5: Enable secrets to be retrieved from a key vault by the Microsoft.Compute resource provider +```powershell +Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -EnabledForDeployment +``` + +This command grants the permissions for secrets to be retrieved from the Contoso03Vault key vault by the Microsoft.Compute resource provider. + +### Example 6: Grant permissions to a security group +```powershell +Get-AzADGroup +Set-AzKeyVaultAccessPolicy -VaultName 'myownvault' -ObjectId (Get-AzADGroup -SearchString 'group2')[0].Id -PermissionsToKeys get, set -PermissionsToSecrets get, set +``` + +The first command uses the Get-AzADGroup cmdlet to get all Active Directory groups. From the output, you see 3 groups returned, named **group1**, **group2**, and **group3**. Multiple groups can have the same name but always have a unique ObjectId. When more than one group that has the same name is returned, use the ObjectId in the output to identify the one you want to use. +You then use the output of this command with Set-AzKeyVaultAccessPolicy to grant permissions to group2 for your key vault, named **myownvault**. This example enumerates the groups named 'group2' inline in the same command line. +There may be multiple groups in the returned list that are named 'group2'. +This example picks the first one, indicated by index \[0\] in the returned list. + +### Example 7: Grant Azure Information Protection access to the customer-managed tenant key (BYOK) +```powershell +Set-AzKeyVaultAccessPolicy -VaultName 'Contoso04Vault' -ServicePrincipalName 'MyServicePrincipal' -PermissionsToKeys decrypt,sign,get +``` + +This command authorizes Azure Information Protection to use a customer-managed key (the bring your own key, or "BYOK" scenario) as the Azure Information Protection tenant key. +When you run this command, specify your own key vault name but you must specify the *ServicePrincipalName* parameter and specify the permissions in the example. + +## PARAMETERS + +### -ApplicationId +For future use. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: ByObjectId, InputObjectByObjectId, ResourceIdByObjectId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassObjectIdValidation +Enables you to specify an object ID without validating that the object exists in Azure Active Directory. +Use this parameter only if you want to grant access to your key vault to an object ID that refers to a delegated security group from another Azure tenant. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByObjectId, InputObjectByObjectId, ResourceIdByObjectId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddress +Specifies the user email address of the user to whom to grant permissions. +This email address must exist in the directory associated with the current subscription and be unique. + +```yaml +Type: System.String +Parameter Sets: ByEmailAddress, InputObjectByEmailAddress, ResourceIdByEmailAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledForDeployment +Enables the Microsoft.Compute resource provider to retrieve secrets from this key vault when this key vault is referenced in resource creation, for example when creating a virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ForVault, InputObjectForVault, ResourceIdForVault +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledForDiskEncryption +Enables the Azure disk encryption service to get secrets and unwrap keys from this key vault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ForVault, InputObjectForVault, ResourceIdForVault +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledForTemplateDeployment +Enables Azure Resource Manager to get secrets from this key vault when this key vault is referenced in a template deployment. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ForVault, InputObjectForVault, ResourceIdForVault +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Key Vault Object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultIdentityItem +Parameter Sets: InputObjectByObjectId, InputObjectByServicePrincipalName, InputObjectByUserPrincipalName, InputObjectByEmailAddress, InputObjectForVault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ObjectId +Specifies the object ID of the user or service principal in Azure Active Directory for which to grant permissions. Its value is in the format of GUID. + +```yaml +Type: System.String +Parameter Sets: ByObjectId, InputObjectByObjectId, ResourceIdByObjectId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionsToCertificates +Specifies an array of certificate permissions to grant to a user or service principal. +'All' will grant all the permissions except 'Purge' +The acceptable values for this parameter: +- All +- Get +- List +- Delete +- Create +- Import +- Update +- Managecontacts +- Getissuers +- Listissuers +- Setissuers +- Deleteissuers +- Manageissuers +- Recover +- Backup +- Restore +- Purge + +```yaml +Type: System.String[] +Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmailAddress, InputObjectByObjectId, InputObjectByServicePrincipalName, InputObjectByUserPrincipalName, InputObjectByEmailAddress, ResourceIdByObjectId, ResourceIdByServicePrincipalName, ResourceIdByUserPrincipalName, ResourceIdByEmailAddress +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionsToKeys +Specifies an array of key operation permissions to grant to a user or service principal. +'All' will grant all the permissions except 'Purge' +The acceptable values for this parameter: +- All +- Decrypt +- Encrypt +- UnwrapKey +- WrapKey +- Verify +- Sign +- Get +- List +- Update +- Create +- Import +- Delete +- Backup +- Restore +- Recover +- Purge +- Rotate + +```yaml +Type: System.String[] +Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmailAddress, InputObjectByObjectId, InputObjectByServicePrincipalName, InputObjectByUserPrincipalName, InputObjectByEmailAddress, ResourceIdByObjectId, ResourceIdByServicePrincipalName, ResourceIdByUserPrincipalName, ResourceIdByEmailAddress +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionsToSecrets +Specifies an array of secret operation permissions to grant to a user or service principal. +'All' will grant all the permissions except 'Purge' +The acceptable values for this parameter: +- All +- Get +- List +- Set +- Delete +- Backup +- Restore +- Recover +- Purge + +```yaml +Type: System.String[] +Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmailAddress, InputObjectByObjectId, InputObjectByServicePrincipalName, InputObjectByUserPrincipalName, InputObjectByEmailAddress, ResourceIdByObjectId, ResourceIdByServicePrincipalName, ResourceIdByUserPrincipalName, ResourceIdByEmailAddress +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionsToStorage +Specifies managed storage account and SaS-definition operation permissions to grant to a user or service principal. +'All' will grant all the permissions except 'Purge' +The acceptable values for this parameter: +- all +- get +- list +- delete +- set +- update +- regeneratekey +- getsas +- listsas +- deletesas +- setsas +- recover +- backup +- restore +- purge + +```yaml +Type: System.String[] +Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmailAddress, InputObjectByObjectId, InputObjectByServicePrincipalName, InputObjectByUserPrincipalName, InputObjectByEmailAddress, ResourceIdByObjectId, ResourceIdByServicePrincipalName, ResourceIdByUserPrincipalName, ResourceIdByEmailAddress +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmailAddress, ForVault +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Key Vault Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdByObjectId, ResourceIdByServicePrincipalName, ResourceIdByUserPrincipalName, ResourceIdByEmailAddress, ResourceIdForVault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServicePrincipalName +Specifies the service principal name of the application to which to grant permissions. +Specify the application ID, also known as client ID, registered for the application in AzureActive Directory. The application with the service principal name that this parameter specifies must be registered in the Azure directory that contains your current subscription. + +```yaml +Type: System.String +Parameter Sets: ByServicePrincipalName, InputObjectByServicePrincipalName, ResourceIdByServicePrincipalName +Aliases: SPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserPrincipalName +Specifies the user principal name of the user to whom to grant permissions. +This user principal name must exist in the directory associated with the current subscription. + +```yaml +Type: System.String +Parameter Sets: ByUserPrincipalName, InputObjectByUserPrincipalName, ResourceIdByUserPrincipalName +Aliases: UPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault. +This cmdlet modifies the access policy for the key vault that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmailAddress, ForVault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultIdentityItem + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVault](./Get-AzKeyVault.md) + +[Remove-AzKeyVaultAccessPolicy](./Remove-AzKeyVaultAccessPolicy.md) + diff --git a/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultCertificateIssuer.md b/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultCertificateIssuer.md new file mode 100644 index 0000000000..1bf9a551d3 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultCertificateIssuer.md @@ -0,0 +1,246 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 4C2C77F7-ECE4-4106-8AF1-256A496A977B +online version: https://learn.microsoft.com/powershell/module/az.keyvault/set-azkeyvaultcertificateissuer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Set-AzKeyVaultCertificateIssuer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Set-AzKeyVaultCertificateIssuer.md +--- + +# Set-AzKeyVaultCertificateIssuer + +## SYNOPSIS +Sets a certificate issuer in a key vault. + +## SYNTAX + +### Expanded (Default) +``` +Set-AzKeyVaultCertificateIssuer [-VaultName] <String> [-Name] <String> -IssuerProvider <String> + [-AccountId <String>] [-ApiKey <SecureString>] + [-OrganizationDetails <PSKeyVaultCertificateOrganizationDetails>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByValue +``` +Set-AzKeyVaultCertificateIssuer [-VaultName] <String> [-Name] <String> + -InputObject <PSKeyVaultCertificateIssuerIdentityItem> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzKeyVaultCertificateIssuer cmdlet sets a certificate issuer in a key vault. + +## EXAMPLES + +### Example 1: Set a certificate issuer +```powershell +$AdminDetails = New-AzKeyVaultCertificateAdministratorDetail -FirstName user -LastName name -EmailAddress username@microsoft.com +$OrgDetails = New-AzKeyVaultCertificateOrganizationDetail -AdministratorDetails $AdminDetails +$Password = ConvertTo-SecureString -String P@ssw0rd -AsPlainText -Force +Set-AzKeyVaultCertificateIssuer -VaultName "Contosokv01" -Name "TestIssuer01" -IssuerProvider "Test" -AccountId "555" -ApiKey $Password -OrganizationDetails $OrgDetails -PassThru +``` + +```output +AccountId : 555 +ApiKey : +OrganizationDetails : Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOrganizationDetails +Name : TestIssuer01 +IssuerProvider : Test +VaultName : Contosokv01 +``` + +This command sets the properties for a certificate issuer. + +## PARAMETERS + +### -AccountId +Specifies the account ID for the certificate issuer. + +```yaml +Type: System.String +Parameter Sets: Expanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiKey +Specifies the API key for the certificate issuer. + +```yaml +Type: System.Security.SecureString +Parameter Sets: Expanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the certificate issuer to set. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuerIdentityItem +Parameter Sets: ByValue +Aliases: Issuer + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IssuerProvider +Specifies the type of certificate issuer. + +```yaml +Type: System.String +Parameter Sets: Expanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Issuer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IssuerName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationDetails +Organization details to be used with the issuer. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOrganizationDetails +Parameter Sets: Expanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOrganizationDetails + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuerIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultCertificateIssuer](./Get-AzKeyVaultCertificateIssuer.md) + +[Remove-AzKeyVaultCertificateIssuer](./Remove-AzKeyVaultCertificateIssuer.md) + diff --git a/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultCertificatePolicy.md b/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultCertificatePolicy.md new file mode 100644 index 0000000000..cf0c5cd47e --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultCertificatePolicy.md @@ -0,0 +1,526 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 28BC1B99-946C-4A8D-9581-4D5CC0BCEF8B +online version: https://learn.microsoft.com/powershell/module/az.keyvault/set-azkeyvaultcertificatepolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Set-AzKeyVaultCertificatePolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Set-AzKeyVaultCertificatePolicy.md +--- + +# Set-AzKeyVaultCertificatePolicy + +## SYNOPSIS +Creates or updates the policy for a certificate in a key vault. + +## SYNTAX + +### ExpandedRenewPercentage (Default) +``` +Set-AzKeyVaultCertificatePolicy [-VaultName] <String> [-Name] <String> [-RenewAtPercentageLifetime <Int32>] + [-SecretContentType <String>] [-ReuseKeyOnRenewal <Boolean>] [-Disabled] [-SubjectName <String>] + [-DnsName <System.Collections.Generic.List`1[System.String]>] + [-KeyUsage <System.Collections.Generic.List`1[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags]>] + [-Ekus <System.Collections.Generic.List`1[System.String]>] [-ValidityInMonths <Int32>] [-IssuerName <String>] + [-CertificateType <String>] [-EmailAtNumberOfDaysBeforeExpiry <Int32>] [-EmailAtPercentageLifetime <Int32>] + [-KeyType <String>] [-KeySize <Int32>] [-KeyNotExportable] [-CertificateTransparency <Boolean>] [-PassThru] + [-Curve <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByValue +``` +Set-AzKeyVaultCertificatePolicy [-VaultName] <String> [-Name] <String> + [-InputObject] <PSKeyVaultCertificatePolicy> [-EmailAtNumberOfDaysBeforeExpiry <Int32>] + [-EmailAtPercentageLifetime <Int32>] [-KeyType <String>] [-KeySize <Int32>] + [-CertificateTransparency <Boolean>] [-PassThru] [-Curve <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ExpandedRenewNumber +``` +Set-AzKeyVaultCertificatePolicy [-VaultName] <String> [-Name] <String> -RenewAtNumberOfDaysBeforeExpiry <Int32> + [-SecretContentType <String>] [-ReuseKeyOnRenewal <Boolean>] [-Disabled] [-SubjectName <String>] + [-DnsName <System.Collections.Generic.List`1[System.String]>] + [-KeyUsage <System.Collections.Generic.List`1[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags]>] + [-Ekus <System.Collections.Generic.List`1[System.String]>] [-ValidityInMonths <Int32>] [-IssuerName <String>] + [-CertificateType <String>] [-EmailAtNumberOfDaysBeforeExpiry <Int32>] [-EmailAtPercentageLifetime <Int32>] + [-KeyType <String>] [-KeySize <Int32>] [-KeyNotExportable] [-CertificateTransparency <Boolean>] [-PassThru] + [-Curve <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzKeyVaultCertificatePolicy** cmdlet creates or updates the policy for a certificate in a key vault. + +## EXAMPLES + +### Example 1: Set a certificate policy +```powershell +Set-AzKeyVaultCertificatePolicy -VaultName "ContosoKV01" -Name "TestCert01" -SecretContentType "application/x-pkcs12" -SubjectName "CN=contoso.com" -IssuerName "Self" -ValidityInMonths 6 -ReuseKeyOnRenewal $True -PassThru +``` + +```output +SecretContentType : application/x-pkcs12 +Kty : +KeySize : 2048 +Curve : +Exportable : +ReuseKeyOnRenewal : True +SubjectName : CN=contoso.com +DnsNames : +KeyUsage : +Ekus : +ValidityInMonths : 6 +IssuerName : Self +CertificateType : +RenewAtNumberOfDaysBeforeExpiry : +RenewAtPercentageLifetime : +EmailAtNumberOfDaysBeforeExpiry : +EmailAtPercentageLifetime : +CertificateTransparency : +Enabled : True +Created : +Updated : +``` + +This command sets the policy for the TestCert01 certificate in the ContosoKV01 key vault. + +## PARAMETERS + +### -CertificateTransparency +Indicates whether certificate transparency is enabled for this certificate/issuer; if not specified, the default is 'true'. +`-IssuerName` needs to be specified when setting this property. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateType +Specifies the type of certificate to the issuer. + +```yaml +Type: System.String +Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Curve +Specifies the elliptic curve name of the key of the certificate. +The acceptable values for this parameter are: +- P-256 +- P-384 +- P-521 +- P-256K +- SECP256K1 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: P-256, P-384, P-521, P-256K, SECP256K1 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +Indicates that the certificate policy is disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsName +Specifies the subject name of the certificate. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber +Aliases: DnsNames + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ekus +Specifies the enhanced key usages (EKUs) in the certificate. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAtNumberOfDaysBeforeExpiry +Specifies the number of days before expiration when automatic renewal should start. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAtPercentageLifetime +Specifies the percentage of the lifetime after which the automatic process for the notification begins. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the certificate policy. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy +Parameter Sets: ByValue +Aliases: CertificatePolicy + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -IssuerName +Specifies the name of the issuer for this certificate. + +```yaml +Type: System.String +Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyNotExportable +Indicates that the key is not exportable. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeySize +Specifies the key size of the certificate. +The acceptable values for this parameter are: +- 2048 +- 3072 +- 4096 +- 256 +- 384 +- 521 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Accepted values: 2048, 3072, 4096, 256, 384, 521 + +Required: False +Position: Named +Default value: 2048 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyType +Specifies the key type of the key that backs the certificate. +The acceptable values for this parameter are: +- RSA +- RSA-HSM +- EC +- EC-HSM + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: RSA, RSA-HSM, EC, EC-HSM + +Required: False +Position: Named +Default value: RSA +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyUsage +Specifies the key usages in the certificate. + +```yaml +Type: System.Collections.Generic.List`1[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags] +Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber +Aliases: +Accepted values: None, EncipherOnly, CrlSign, KeyCertSign, KeyAgreement, DataEncipherment, KeyEncipherment, NonRepudiation, DigitalSignature, DecipherOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CertificateName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RenewAtNumberOfDaysBeforeExpiry +Specifies the number of days before expiry after which the automatic process for certificate renewal begins. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ExpandedRenewNumber +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RenewAtPercentageLifetime +Specifies the percentage of the lifetime after which the automatic process for certificate renewal begins. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ExpandedRenewPercentage +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReuseKeyOnRenewal +Indicates that the certificate reuse the key during renewal. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretContentType +Specifies the content type of the new key vault secret. +The acceptable values for this parameter are: +- application/x-pkcs12 +- application/x-pem-file + +```yaml +Type: System.String +Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber +Aliases: +Accepted values: application/x-pkcs12, application/x-pem-file + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectName +Specifies the subject name of the certificate. + +```yaml +Type: System.String +Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidityInMonths +Specifies the number of months the certificate is valid. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultCertificatePolicy](./Get-AzKeyVaultCertificatePolicy.md) + +[New-AzKeyVaultCertificatePolicy](./New-AzKeyVaultCertificatePolicy.md) + diff --git a/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultKeyRotationPolicy.md b/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultKeyRotationPolicy.md new file mode 100644 index 0000000000..6cc3ad311a --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultKeyRotationPolicy.md @@ -0,0 +1,325 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/set-azkeyvaultkeyrotationpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Set-AzKeyVaultKeyRotationPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Set-AzKeyVaultKeyRotationPolicy.md +--- + +# Set-AzKeyVaultKeyRotationPolicy + +## SYNOPSIS +Sets the key rotation policy for the specified key in Key Vault. + +## SYNTAX + +### ByVaultName (Default) +``` +Set-AzKeyVaultKeyRotationPolicy [-VaultName] <String> [-Name] <String> [-ExpiresIn <String>] + [-KeyRotationLifetimeAction <PSKeyRotationLifetimeAction[]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByRotationPolicyFileViaVaultName +``` +Set-AzKeyVaultKeyRotationPolicy [-VaultName] <String> [-Name] <String> -PolicyPath <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByKeyInputObject +``` +Set-AzKeyVaultKeyRotationPolicy [-InputObject] <PSKeyVaultKeyIdentityItem> [-ExpiresIn <String>] + [-KeyRotationLifetimeAction <PSKeyRotationLifetimeAction[]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByRotationPolicyFileViaKeyInputObject +``` +Set-AzKeyVaultKeyRotationPolicy [-InputObject] <PSKeyVaultKeyIdentityItem> -PolicyPath <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByKeyRotationPolicyInputObject +``` +Set-AzKeyVaultKeyRotationPolicy [-KeyRotationPolicy] <PSKeyRotationPolicy> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet requires the key update permission. It returns a key rotation policy for the specified key. + +## EXAMPLES + +### Example 1: Sets key rotation policy by JSON file +```powershell +<# +rotation_policy.json +{ + "lifetimeActions": [ + { + "trigger": { + "timeAfterCreate": "P18M", + "timeBeforeExpiry": null + }, + "action": { + "type": "Rotate" + } + }, + { + "trigger": { + "timeBeforeExpiry": "P30D" + }, + "action": { + "type": "Notify" + } + } + ], + "attributes": { + "expiryTime": "P2Y" + } + } +#> +Set-AzKeyVaultKeyRotationPolicy -VaultName test-kv -Name test-key -PolicyPath rotation_policy.json +``` + +```output +Id : https://test-kv.vault.azure.net/keys/test-key/rotationpolicy +VaultName : test-kv +KeyName : test-keyAM +00:00 +LifetimeActions : {[Action: Notify, TimeAfterCreate: , TimeBeforeExpiry: P30D]} +ExpiresIn : P2Y +CreatedOn : 12/10/2021 3:21:51 AM +00:00 +UpdatedOn : 6/9/2022 7:43:27 +``` + +These commands set the rotation policy of key `test-key` by JSON file. + +### Example 2: Sets key rotation policy expiry time +```powershell +Set-AzKeyVaultKeyRotationPolicy -VaultName test-kv -Name test-key -ExpiresIn P2Y +``` + +```output +Id : https://test-kv.vault.azure.net/keys/test-key/rotationpolicy +VaultName : test-kv +KeyName : test-keyAM +00:00 +LifetimeActions : {[Action: Notify, TimeAfterCreate: , TimeBeforeExpiry: P30D]} +ExpiresIn : P2Y +CreatedOn : 12/10/2021 3:21:51 AM +00:00 +UpdatedOn : 6/9/2022 7:43:27 +``` + +These commands set the expiry time will be applied on the new key version of `test-key` as 2 years. + +### Example 3: Sets key rotation policy via piping +```powershell +Get-AzKeyVaultKey -VaultName test-kv -Name test-key | Set-AzKeyVaultKeyRotationPolicy -KeyRotationLifetimeAction @{Action = "Rotate"; TimeBeforeExpiry = "P18M"} +``` + +```output +Id : https://test-kv.vault.azure.net/keys/test-key/rotationpolicy +VaultName : test-kv +KeyName : test-key +LifetimeActions : {[Action: Rotate, TimeAfterCreate: , TimeBeforeExpiry: P18M], [Action: Notify, TimeAfterCreate: , + TimeBeforeExpiry: P30D]} +ExpiresIn : P2Y +CreatedOn : 12/10/2021 3:21:51 AM +00:00 +UpdatedOn : 6/9/2022 8:10:43 AM +00:00 +``` + +These commands set the duration before expiry to attempt to rotate `test-key` as 18 months. + +### Example 4: Copy key rotation policy to another key via PSKeyRotationPolicy object +```powershell +$policy = Get-AzKeyVaultKeyRotationPolicy -VaultName test-kv -Name test-key1 +$policy.KeyName = "test-key2" +$policy | Set-AzKeyVaultKeyRotationPolicy +``` + +```output +Id : https://test-kv.vault.azure.net/keys/test-key2/rotationpolicy +VaultName : test-kv +KeyName : test-key2 +LifetimeActions : {[Action: Rotate, TimeAfterCreate: , TimeBeforeExpiry: P18M], [Action: Notify, TimeAfterCreate: , + TimeBeforeExpiry: P30D]} +ExpiresIn : P2Y +CreatedOn : 6/9/2022 8:26:35 AM +00:00 +UpdatedOn : 6/9/2022 8:26:35 AM +00:00 +``` + +These commands copy the key rotation policy `test-key1` to key `test-key2`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiresIn +The expiryTime will be applied on the new key version. It should be at least 28 days. It will be in ISO 8601 Format. Examples: 90 days: P90D, 3 months: P3M, 48 hours: PT48H, 1 year and 10 days: P1Y10D. + +```yaml +Type: System.String +Parameter Sets: ByVaultName, ByKeyInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Key object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem +Parameter Sets: ByKeyInputObject, SetByRotationPolicyFileViaKeyInputObject +Aliases: Key + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyRotationLifetimeAction +PSKeyRotationLifetimeAction object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyRotationLifetimeAction[] +Parameter Sets: ByVaultName, ByKeyInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyRotationPolicy +PSKeyRotationPolicy object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyRotationPolicy +Parameter Sets: ByKeyRotationPolicyInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Key name. + +```yaml +Type: System.String +Parameter Sets: ByVaultName, SetByRotationPolicyFileViaVaultName +Aliases: KeyName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyPath +A path to the rotation policy file that contains JSON policy definition. + +```yaml +Type: System.String +Parameter Sets: SetByRotationPolicyFileViaVaultName, SetByRotationPolicyFileViaKeyInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. + +```yaml +Type: System.String +Parameter Sets: ByVaultName, SetByRotationPolicyFileViaVaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyRotationPolicy + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyRotationPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultKeyRotationPolicy](./Get-AzKeyVaultKeyRotationPolicy.md) + +[Invoke-AzKeyVaultKeyRotation](./Invoke-AzKeyVaultKeyRotation.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultManagedStorageSasDefinition.md b/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultManagedStorageSasDefinition.md new file mode 100644 index 0000000000..fd9d202726 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultManagedStorageSasDefinition.md @@ -0,0 +1,268 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/set-azkeyvaultmanagedstoragesasdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Set-AzKeyVaultManagedStorageSasDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Set-AzKeyVaultManagedStorageSasDefinition.md +--- + +# Set-AzKeyVaultManagedStorageSasDefinition + +## SYNOPSIS +Sets a Shared Access Signature (SAS) definition with Key Vault for a given Key Vault managed Azure Storage Account. + +## SYNTAX + +### Default (Default) +``` +Set-AzKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> + [-TemplateUri] <String> [-SasType] <String> [-Disable] [-Tag <Hashtable>] -ValidityPeriod <TimeSpan> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Set-AzKeyVaultManagedStorageSasDefinition [-InputObject] <PSKeyVaultManagedStorageAccountIdentityItem> + [-Name] <String> [-TemplateUri] <String> [-SasType] <String> [-Disable] [-Tag <Hashtable>] + -ValidityPeriod <TimeSpan> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Sets a Shared Access Signature (SAS) definition with a given Key Vault managed Azure Storage +Account. This also sets a secret which can be used to get the SAS token per this SAS definition. +SAS token is generated using these parameters and the active key of the Key Vault managed Azure +Storage Account. + +## EXAMPLES + +### Example 1: Set an account-type SAS definition, and obtain a current SAS token based on it +```powershell +$sa = Get-AzStorageAccount -Name mysa -ResourceGroupName myrg +$kv = Get-AzKeyVault -VaultName mykv +Add-AzKeyVaultManagedStorageAccount -VaultName $kv.VaultName -AccountName $sa.StorageAccountName -AccountResourceId $sa.Id -ActiveKeyName key1 -RegenerationPeriod ([System.Timespan]::FromDays(180)) +$sctx = New-AzStorageContext -StorageAccountName $sa.StorageAccountName -Protocol Https -StorageAccountKey Key1 +$start = [System.DateTime]::Now.AddDays(-1) +$end = [System.DateTime]::Now.AddMonths(1) +$at = "sv=2018-03-28&ss=bfqt&srt=sco&sp=rw&spr=https" +$sas = Set-AzKeyVaultManagedStorageSasDefinition -AccountName $sa.StorageAccountName -VaultName $kv.VaultName -Name accountsas -TemplateUri $at -SasType 'account' -ValidityPeriod ([System.Timespan]::FromDays(30)) +Get-AzKeyVaultSecret -VaultName $kv.VaultName -Name $sas.Sid.Substring($sas.Sid.LastIndexOf('/')+1) +``` + +Sets an account SAS definition 'accountsas' on a KeyVault-managed storage account 'mysa' in vault 'mykv'. Specifically, the sequence above performs the following: + - gets a (pre-existing) storage account + - gets a (pre-existing) key vault + - adds a KeyVault-managed storage account to the vault, setting Key1 as the active key, and with a regeneration period of 180 days + - sets a storage context for the specified storage account, with Key1 + - creates an account SAS token for services Blob, File, Table and Queue, for resource types Service, Container and Object, with all permissions, over https and with the specified start and end dates + - sets a KeyVault-managed storage SAS definition in the vault, with the template uri as the SAS token created above, of SAS type 'account' and valid for 30 days + - retrieves the actual access token from the KeyVault secret corresponding to the SAS definition + +## PARAMETERS + +### -AccountName +Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account +name from vault name, currently selected environment and manged storage account name. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: StorageAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disable +Disables the use of sas definition for generation of sas token. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +ManagedStorageAccount object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Storage sas definition name. Cmdlet constructs the FQDN of a storage sas definition from vault +name, currently selected environment, storage account name and sas definition name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SasDefinitionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SasType +Storage SAS type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateUri +Storage SAS definition template uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidityPeriod +Validity period that will get used to set the expiry time of sas token from the time it gets generated + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageSasDefinition + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultManagedStorageSasDefinition](./Get-AzKeyVaultManagedStorageSasDefinition.md) + +[Remove-AzKeyVaultManagedStorageSasDefinition](./Remove-AzKeyVaultManagedStorageSasDefinition.md) + +[Undo-AzKeyVaultManagedStorageSasDefinitionRemoval](./Undo-AzKeyVaultManagedStorageSasDefinitionRemoval.md) diff --git a/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultSecret.md b/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultSecret.md new file mode 100644 index 0000000000..0e255884ba --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Set-AzKeyVaultSecret.md @@ -0,0 +1,326 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 9FC72DE9-46BB-4CB5-9880-F53756DBE012 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/set-azkeyvaultsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Set-AzKeyVaultSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Set-AzKeyVaultSecret.md +--- + +# Set-AzKeyVaultSecret + +## SYNOPSIS +Creates or updates a secret in a key vault. + +## SYNTAX + +### Default (Default) +``` +Set-AzKeyVaultSecret [-VaultName] <String> [-Name] <String> [-SecretValue] <SecureString> [-Disable] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-ContentType <String>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Set-AzKeyVaultSecret [-InputObject] <PSKeyVaultSecretIdentityItem> [-SecretValue] <SecureString> [-Disable] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-ContentType <String>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzKeyVaultSecret** cmdlet creates or updates a secret in a key vault in Azure Key +Vault. If the secret does not exist, this cmdlet creates it. If the secret already exists, this +cmdlet creates a new version of that secret. + +## EXAMPLES + +### Example 1: Modify the value of a secret using default attributes +```powershell +$Secret = ConvertTo-SecureString -String 'Password' -AsPlainText -Force +Set-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -SecretValue $Secret +``` + +```output +Vault Name : Contoso +Name : ITSecret +Version : 8b5c0cb0326e4350bd78200fac932b51 +Id : https://contoso.vault.azure.net:443/secrets/ITSecret/8b5c0cb0326e4350bd78200fac932b51 +Enabled : True +Expires : +Not Before : +Created : 5/25/2018 6:39:30 PM +Updated : 5/25/2018 6:39:30 PM +Content Type : +Tags : +``` + +The first command converts a string into a secure string by using the **ConvertTo-SecureString** +cmdlet, and then stores that string in the $Secret variable. For more information, type `Get-Help +ConvertTo-SecureString`. +The second command modifies value of the secret named ITSecret in the key vault named Contoso. The +secret value becomes the value stored in $Secret. + +### Example 2: Modify the value of a secret using custom attributes +```powershell +$Secret = ConvertTo-SecureString -String 'Password' -AsPlainText -Force +$Expires = (Get-Date).AddYears(2).ToUniversalTime() +$NBF =(Get-Date).ToUniversalTime() +$Tags = @{ 'Severity' = 'medium'; 'IT' = 'true'} +$ContentType = 'txt' +Set-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -SecretValue $Secret -Expires $Expires -NotBefore $NBF -ContentType $ContentType -Disable -Tags $Tags +``` + +```output +Vault Name : Contoso +Name : ITSecret +Version : a2c150be3ea24dd6b8286986e6364851 +Id : https://contoso.vault.azure.net:443/secrets/ITSecret/a2c150be3ea24dd6b8286986e6364851 +Enabled : False +Expires : 5/25/2020 6:40:00 PM +Not Before : 5/25/2018 6:40:05 PM +Created : 5/25/2018 6:41:22 PM +Updated : 5/25/2018 6:41:22 PM +Content Type : txt +Tags : Name Value + Severity medium + IT true +``` + +The first command converts a string into a secure string by using the **ConvertTo-SecureString** +cmdlet, and then stores that string in the $Secret variable. For more information, type `Get-Help +ConvertTo-SecureString`. +The next commands define custom attributes for the expiry date, tags, and context type, and store +the attributes in variables. +The final command modifies values of the secret named ITSecret in the key vault named Contoso, by +using the values specified previously as variables. + +### Example 3: Create a secret in azure key vault by command Set-Secret in module Microsoft.PowerShell.SecretManagement +```powershell +# Install module Microsoft.PowerShell.SecretManagement +Install-Module Microsoft.PowerShell.SecretManagement -Repository PSGallery -AllowPrerelease +# Register vault for Secret Management +Register-SecretVault -Name AzKeyVault -ModuleName Az.KeyVault -VaultParameters @{ AZKVaultName = 'test-kv'; SubscriptionId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' } +# Set secret for vault AzKeyVault +$secure = ConvertTo-SecureString -String "Password" -AsPlainText -Force +Set-Secret -Name secureSecret -SecureStringSecret $secure -Vault AzKeyVault +``` + +```output +None +``` + +This example sets a secret named `secureSecret` in azure key vault `test-kv` by command `Set-Secret` in module `Microsoft.PowerShell.SecretManagement`. + +## PARAMETERS + +### -ContentType +Specifies the content type of a secret. +To delete the existing content type, specify an empty string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disable +Indicates that this cmdlet disables a secret. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expires +Specifies the expiration time, as a **DateTime** object, for the secret that this cmdlet updates. +This parameter uses Coordinated Universal Time (UTC). To obtain a **DateTime** object, use the +**Get-Date** cmdlet. For more information, type `Get-Help Get-Date`. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Secret object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a secret to modify. This cmdlet constructs the fully qualified domain name +(FQDN) of a secret based on the name that this parameter specifies, the name of the key vault, and +your current environment. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: SecretName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotBefore +Specifies the time, as a **DateTime** object, before which the secret cannot be used. This +parameter uses UTC. To obtain a **DateTime** object, use the **Get-Date** cmdlet. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretValue +Specifies the value for the secret as a **SecureString** object. To obtain a **SecureString** +object, use the **ConvertTo-SecureString** cmdlet. For more information, type `Get-Help +ConvertTo-SecureString`. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of the key vault to which this secret belongs. This cmdlet constructs the FQDN +of a key vault based on the name that this parameter specifies and your current environment. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecret + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultSecret](./Get-AzKeyVaultSecret.md) + +[Remove-AzKeyVaultSecret](./Remove-AzKeyVaultSecret.md) diff --git a/azps-10.1.0/Az.KeyVault/Stop-AzKeyVaultCertificateOperation.md b/azps-10.1.0/Az.KeyVault/Stop-AzKeyVaultCertificateOperation.md new file mode 100644 index 0000000000..487ad2243b --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Stop-AzKeyVaultCertificateOperation.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +ms.assetid: 3B042D79-658F-41F0-BD4D-9955F2E71CA1 +online version: https://learn.microsoft.com/powershell/module/az.keyvault/stop-azkeyvaultcertificateoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Stop-AzKeyVaultCertificateOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Stop-AzKeyVaultCertificateOperation.md +--- + +# Stop-AzKeyVaultCertificateOperation + +## SYNOPSIS +Cancels a certificate operation in key vault. + +## SYNTAX + +### Default (Default) +``` +Stop-AzKeyVaultCertificateOperation [-VaultName] <String> [-Name] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Stop-AzKeyVaultCertificateOperation [-InputObject] <PSKeyVaultCertificateOperation> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzKeyVaultCertificateOperation** cmdlet cancels a certificate operation in the Azure Key Vault service. + +## EXAMPLES + +### Example 1: Cancel a certificate operation +```powershell +Stop-AzKeyVaultCertificateOperation -VaultName "Contoso01" -Name "TestCert02" -Force +``` + +```output +Status : inProgress +CancellationRequested : True +CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCVr6EVwsd48qDVORsF4V4w4N1aQCUirFW7b+kwoTvSOL4SfMiWcPmno0uxmQQoh + gz157bC3sKFLyBUsGCmS4i7uWkBOSEpCh8L3FKU4XMqRROlUM9AqswzB0e1sURCqevEJA80xFpfTgkeqpm44m4jr6p7gu+h1PBf9Dt7b43Gybde5DUlGrrOiTkOIAF0eU2iNVeHOapoj8m1XHmzO1BARs + oa0pSDxO/aMgeuq/QPkWG64Iiw55U20byKZ86u3Y4g192HsPwsrHkf9ZSYR2M9BYM3YGoT/dkCmAtP4LQAsOwf1+S0a/TwRtrnoOHbPFI6HYSY3TY1iqzZ9xItfgalAgMBAAGgSzBJBgkqhkiG9w0BCQ4 + xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAjxUX5PGhri9qJTxSleGEbMVkxhhn3nuPUgxujEzrcQVr + fZAACJHbOnga/QYwpxumKWnkX9YdWxb58PPn+nLV2gYP3eYEyJ4DR9XDcKpoQxZahUdqD3JZXhWPIcN05tw9Fuq8ziw94BjLZW3h3iDamqkBnysJYW58FBp1H8Ejqk0Iynbo0V223Innq/7QB2fVwe3ZJ + JecT8YxHJjVQ5psdDpEWgLUG/DFiAPHdwupI7JjvtvQmT3AotL0x5GNx2bWNH5hHIXsX4bnbxZgNQnTB2w3tQ3QeuKt8fUx2S0xtxPllaCUul6efa84TNqdMcMfyxCarIwDP6qdhS+CDU1uUA== +ErrorCode : +ErrorMessage : +``` + +This command cancels the TestCert02 certificate operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Operation object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a certificate. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: CertificateName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run.Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultCertificateOperation](./Get-AzKeyVaultCertificateOperation.md) + +[Remove-AzKeyVaultCertificateOperation](./Remove-AzKeyVaultCertificateOperation.md) + diff --git a/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultCertificateRemoval.md b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultCertificateRemoval.md new file mode 100644 index 0000000000..33c35aeea5 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultCertificateRemoval.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/undo-azkeyvaultcertificateremoval +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultCertificateRemoval.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultCertificateRemoval.md +--- + +# Undo-AzKeyVaultCertificateRemoval + +## SYNOPSIS +Recovers a deleted certificate in a key vault into an active state. + +## SYNTAX + +### Default (Default) +``` +Undo-AzKeyVaultCertificateRemoval [-VaultName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Undo-AzKeyVaultCertificateRemoval [-InputObject] <PSDeletedKeyVaultCertificateIdentityItem> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Undo-AzKeyVaultCertificateRemoval** cmdlet will recover a previously deleted certificate. +The recovered certificate will be active and can be used for all operations. +Caller needs to have 'recover' permission in order to perform this operation. + +## EXAMPLES + +### Example 1 +```powershell +Undo-AzKeyVaultCertificateRemoval -VaultName 'MyKeyVault' -Name 'MyCertificate' +``` + +```output +Certificate : [Subject] + CN=contoso.com + + [Issuer] + CN=contoso.com + + [Serial Number] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + [Not Before] + 5/24/2018 10:58:13 AM + + [Not After] + 11/24/2018 10:08:13 AM + + [Thumbprint] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + +KeyId : https://mykeyvault.vault.azure.net:443/keys/mycertificate/7fe415d5518240c1a6fce89986b8d334 +SecretId : https://mykeyvault.vault.azure.net:443/secrets/mycertificate/7fe415d5518240c1a6fce89986b8d334 +Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +RecoveryLevel : Recoverable+Purgeable +Enabled : True +Expires : 11/24/2018 6:08:13 PM +NotBefore : 5/24/2018 5:58:13 PM +Created : 5/24/2018 6:08:13 PM +Updated : 5/24/2018 6:08:13 PM +Tags : +VaultName : MyKeyVault +Name : MyCertificate +Version : 7fe415d5518240c1a6fce89986b8d334 +Id : https://mykeyvault.vault.azure.net:443/certificates/mycertificate/7fe415d5518240c1a6fce89986b8d334 +``` + +This command will recover the certificate 'MyCertificate' that was previously deleted, into an active and usable state. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Deleted Certificate object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultCertificateIdentityItem +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Certificate name. +Cmdlet constructs the FQDN of a certificate from vault name, currently selected environment and certificate name. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: CertificateName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultCertificateIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate + +## NOTES + +## RELATED LINKS + +[Remove-AzKeyVaultCertificate](./Remove-AzKeyVaultCertificate.md) + +[Get-AzKeyVaultCertificate](./Get-AzKeyVaultCertificate.md) diff --git a/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultKeyRemoval.md b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultKeyRemoval.md new file mode 100644 index 0000000000..37c2986b7e --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultKeyRemoval.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/undo-azkeyvaultkeyremoval +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultKeyRemoval.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultKeyRemoval.md +--- + +# Undo-AzKeyVaultKeyRemoval + +## SYNOPSIS +Recovers a deleted key in a key vault into an active state. + +## SYNTAX + +### Default (Default) +``` +Undo-AzKeyVaultKeyRemoval [-VaultName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HsmInteractive +``` +Undo-AzKeyVaultKeyRemoval -HsmName <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Undo-AzKeyVaultKeyRemoval [-InputObject] <PSDeletedKeyVaultKeyIdentityItem> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Undo-AzKeyVaultKeyRemoval** cmdlet will recover a previously deleted key. +The recovered key will be active and can be used for all normal key operations. +Caller needs to have 'recover' permission in order to perform this operation. + +## EXAMPLES + +### Example 1 +```powershell +Undo-AzKeyVaultKeyRemoval -VaultName 'MyKeyVault' -Name 'MyKey' +``` + +```output +Vault Name : MyKeyVault +Name : MyKey +Version : 1af807cc331a49d0b52b7c75e1b2366e +Id : https://mykeybault.vault.azure.net:443/keys/mykey/1af807cc331a49d0b52b7c75e1b2366e +Enabled : True +Expires : +Not Before : +Created : 5/24/2018 8:32:27 PM +Updated : 5/24/2018 8:32:27 PM +Purge Disabled : False +Tags : +``` + +This command will recover the key 'MyKey' that was previously deleted, into an active and usable state. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +HSM name. Cmdlet constructs the FQDN of a managed HSM based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: HsmInteractive +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Deleted key object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultKeyIdentityItem +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Key name. +Cmdlet constructs the FQDN of a key from vault name, currently selected environment and key name. + +```yaml +Type: System.String +Parameter Sets: Default, HsmInteractive +Aliases: KeyName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultKeyIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey + +## NOTES + +## RELATED LINKS + +[Remove-AzKeyVaultKey](./Remove-AzKeyVaultKey.md) + +[Add-AzKeyVaultKey](./Add-AzKeyVaultKey.md) + +[Get-AzKeyVaultKey](./Get-AzKeyVaultKey.md) + diff --git a/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultManagedHsmRemoval.md b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultManagedHsmRemoval.md new file mode 100644 index 0000000000..01a262b503 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultManagedHsmRemoval.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/undo-azkeyvaultmanagedhsmremoval +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultManagedHsmRemoval.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultManagedHsmRemoval.md +--- + +# Undo-AzKeyVaultManagedHsmRemoval + +## SYNOPSIS +Recover a managed HSM. + +## SYNTAX + +### Default (Default) +``` +Undo-AzKeyVaultManagedHsmRemoval [-Name] <String> [-ResourceGroupName] <String> [-Location] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### InputObject +``` +Undo-AzKeyVaultManagedHsmRemoval [-InputObject] <PSDeletedManagedHsm> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Recover a previously deleted HSM for which soft delete was enabled. + +## EXAMPLES + +### Example 1: Recover a deleted HSM +```powershell +Undo-AzKeyVaultManagedHsmRemoval -Name test001 -ResourceGroupName test-rg -Location westus +``` + +```output +Name Resource Group Name Location SKU ProvisioningState +---- ------------------- -------- --- ----------------- +test001 test-rg West US StandardB1 Succeeded +``` + +This command recovers a managed HSM called `test001` from deleted state. + +### Example 2: Recover a deleted HSM by piping +```powershell +Get-AzKeyVaultManagedHsm -Name test001 -Location westus -InRemovedState | Undo-AzKeyVaultManagedHsmRemoval +``` + +```output +Name Resource Group Name Location SKU ProvisioningState +---- ------------------- -------- --- ----------------- +test001 test-rg West US StandardB1 Succeeded +``` + +This command recovers a managed HSM called `test001` from deleted state by piping. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Deleted HSM object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSDeletedManagedHsm +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Specifies the deleted HSM original Azure region. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +HSM name. +Cmdlet constructs the FQDN of a managed HSM based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: HsmName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the deleted HSM resource group. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. + +By default, cmdlets are executed in the subscription that is set in the current context. +If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. + +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. +It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedManagedHsm + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm + +## NOTES + +## RELATED LINKS + +[New-AzKeyVaultManagedHsm](./New-AzKeyVaultManagedHsm.md) + +[Get-AzKeyVaultManagedHsm](./Get-AzKeyVaultManagedHsm.md) + +[Remove-AzKeyVaultManagedHsm](./Remove-AzKeyVaultManagedHsm.md) + +[Update-AzKeyVaultManagedHsm](./Update-AzKeyVaultManagedHsm.md) + diff --git a/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultManagedStorageAccountRemoval.md b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultManagedStorageAccountRemoval.md new file mode 100644 index 0000000000..c48eeea3d1 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultManagedStorageAccountRemoval.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/undo-azkeyvaultmanagedstorageaccountremoval +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultManagedStorageAccountRemoval.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultManagedStorageAccountRemoval.md +--- + +# Undo-AzKeyVaultManagedStorageAccountRemoval + +## SYNOPSIS +Recovers a previously deleted KeyVault-managed storage account. + +## SYNTAX + +### Default (Default) +``` +Undo-AzKeyVaultManagedStorageAccountRemoval [-VaultName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Undo-AzKeyVaultManagedStorageAccountRemoval [-InputObject] <PSDeletedKeyVaultManagedStorageAccountIdentityItem> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Undo-AzKeyVaultManagedStorageAccountRemoval** command recovers a previously deleted managed storage account, provided that soft delete is enabled for this vault, and that the attempt to recover occurs during the recovery interval. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzKeyVaultManagedStorageAccount -VaultName myVault -Name myAccount -InRemovedState +Undo-AzKeyVaultManagedStorageAccountRemoval -VaultName myVault -Name myAccount +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/myaccount +Vault Name : myVault +AccountName : myAccount +Account Resource Id : /subscriptions/8bc48661-1801-4b7a-8ca1-6a3cadfb4870/resourceGroups/myrg/providers/Microsoft.St + orage/storageAccounts/myaccount +Active Key Name : key2 +Auto Regenerate Key : False +Regeneration Period : 90.00:00:00 +Enabled : True +Created : 4/25/2018 1:50:32 AM +Updated : 4/25/2018 1:50:32 AM +Tags : +``` + +This sequence of commands determines whether the specified storage account exists in the vault in a deleted state; the subsequent command recovers the deleted storage account, bringing it back into an active state. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Deleted Managed Storage Account object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageAccountIdentityItem +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the KeyVault managed storage account. +Cmdlet constructs the FQDN of the target from vault name, currently selected environment and the name of the managed storage account. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: StorageAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageAccountIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccount + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultManagedStorageSasDefinitionRemoval.md b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultManagedStorageSasDefinitionRemoval.md new file mode 100644 index 0000000000..a5399b0b2d --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultManagedStorageSasDefinitionRemoval.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/undo-azkeyvaultmanagedstoragesasdefinitionremoval +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultManagedStorageSasDefinitionRemoval.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultManagedStorageSasDefinitionRemoval.md +--- + +# Undo-AzKeyVaultManagedStorageSasDefinitionRemoval + +## SYNOPSIS +Recovers a previously deleted KeyVault-managed storage SAS definition. + +## SYNTAX + +### Default (Default) +``` +Undo-AzKeyVaultManagedStorageSasDefinitionRemoval [-VaultName] <String> [-AccountName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Undo-AzKeyVaultManagedStorageSasDefinitionRemoval [-AccountName] <String> + [-InputObject] <PSDeletedKeyVaultManagedStorageSasDefinitionIdentityItem> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Undo-AzKeyVaultManagedStorageSasDefinitionRemoval** command recovers a previously deleted managed storage SAS definition, provided that soft delete is enabled for this vault, and that the attempt to recover occurs during the recovery interval. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzKeyVaultManagedStorageSasDefinition -VaultName myVault -AccountName myAccount -Name mySasName -InRemovedState +Undo-AzKeyVaultManagedStorageSasDefinitionRemoval -VaultName myVault -AccountName myAccount -Name mySasName +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/myaccount/sas/mysasname +Secret Id : https://myvault.vault.azure.net/secrets/myaccount-mysasname +Vault Name : myVault +AccountName : myAccount +Name : mySasName +Parameter : +Enabled : True +Created : 5/24/2018 9:11:08 PM +Updated : 5/24/2018 9:11:08 PM +Tags : +``` + +This sequence of commands determines whether the specified storage SAS definition exists in the vault in a deleted state; the subsequent command recovers the deleted sas definition, bringing it back into an active state. + +## PARAMETERS + +### -AccountName +KeyVault-managed storage account name. +Cmdlet constructs the FQDN of a managed storage SAS definition from vault name, currently-selected environment and managed storage account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Deleted managed storage SAS definition object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageSasDefinitionIdentityItem +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the KeyVault-managed storage SAS definition. +Cmdlet constructs the FQDN of the target from vault name, currently-selected environment, the name of the managed storage account and the name of the SAS definition. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: SasDefinitionName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageSasDefinitionIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageSasDefinition + +## NOTES + +## RELATED LINKS + +[Get-AzKeyVaultManagedStorageSasDefinition](./Get-AzKeyVaultManagedStorageSasDefinition.md) + +[Remove-AzKeyVaultManagedStorageSasDefinition](./Remove-AzKeyVaultManagedStorageSasDefinition.md) + +[Set-AzKeyVaultManagedStorageSasDefinition](./Set-AzKeyVaultManagedStorageSasDefinition.md) diff --git a/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultRemoval.md b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultRemoval.md new file mode 100644 index 0000000000..5f57997cee --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultRemoval.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/undo-azkeyvaultremoval +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultRemoval.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultRemoval.md +--- + +# Undo-AzKeyVaultRemoval + +## SYNOPSIS +Recovers a deleted key vault into an active state. + +## SYNTAX + +### Default (Default) +``` +Undo-AzKeyVaultRemoval [-VaultName] <String> [-ResourceGroupName] <String> [-Location] <String> + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### InputObject +``` +Undo-AzKeyVaultRemoval [-InputObject] <PSDeletedKeyVault> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Undo-AzKeyVaultRemoval** cmdlet will recover a previously deleted key vault. The +recovered vault will be active after recovery + +## EXAMPLES + +### Example 1 +```powershell +Undo-AzKeyVaultRemoval -VaultName 'MyKeyVault' -ResourceGroupName 'MyResourceGroup' -Location 'eastus2' -Tag @{"x"= "y"} +``` + +```output +Vault Name : MyKeyVault +Resource Group Name : MyResourceGroup +Location : eastus2 +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers + /Microsoft.KeyVault/vaults/mykeyvault +Vault URI : https://mykeyvault.vault.azure.net/ +Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +SKU : Standard +Enabled For Deployment? : True +Enabled For Template Deployment? : True +Enabled For Disk Encryption? : True +Soft Delete Enabled? : True +Access Policies : + Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Application ID : + Display Name : User Name (username@microsoft.com) + Permissions to Keys : get, create, delete, list, update, + import, backup, restore, recover + Permissions to Secrets : get, list, set, delete, backup, + restore, recover + Permissions to Certificates : get, delete, list, create, import, + update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers, + setissuers, recover + Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list, + listsas, regeneratekey, set, setsas, update + +Tags : + Name Value + ==== ===== + x y +``` + +This command will recover the key vault 'MyKeyVault' that was previously deleted from eastus2 +region and 'MyResourceGroup' resource group, into an active and usable state. It also replaces the +tags with new tag. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Deleted vault object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVault +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Specifies the deleted vault original Azure region. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an existing resource group in which to create the key vault. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVault + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +## NOTES + +## RELATED LINKS + +[Remove-AzKeyVault](./Remove-AzKeyVault.md) + +[New-AzKeyVault](./New-AzKeyVault.md) + +[Get-AzKeyVault](./Get-AzKeyVault.md) diff --git a/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultSecretRemoval.md b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultSecretRemoval.md new file mode 100644 index 0000000000..0d35732cd0 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Undo-AzKeyVaultSecretRemoval.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/undo-azkeyvaultsecretremoval +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultSecretRemoval.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Undo-AzKeyVaultSecretRemoval.md +--- + +# Undo-AzKeyVaultSecretRemoval + +## SYNOPSIS +Recovers a deleted secret in a key vault into an active state. + +## SYNTAX + +### Default (Default) +``` +Undo-AzKeyVaultSecretRemoval [-VaultName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Undo-AzKeyVaultSecretRemoval [-InputObject] <PSDeletedKeyVaultSecretIdentityItem> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Undo-AzKeyVaultSecretRemoval** cmdlet will recover a previously deleted secret. +The recovered secret will be active and can be used for all normal secret operations. +Caller needs to have 'recover' permission in order to perform this operation. + +## EXAMPLES + +### Example 1 +```powershell +Undo-AzKeyVaultSecretRemoval -VaultName 'MyKeyVault' -Name 'MySecret' +``` + +```output +Vault Name : MyKeyVault +Name : MySecret +Version : f622abc7b1394092812f1eb0f85dc91c +Id : https://mykeyvault.vault.azure.net:443/secrets/mysecret/f622abc7b1394092812f1eb0f85dc91c +Enabled : True +Expires : +Not Before : +Created : 4/19/2018 5:56:02 PM +Updated : 4/26/2018 7:48:40 PM +Content Type : +Tags : +``` + +This command will recover the secret 'MySecret' that was previously deleted, into an active and usable state. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Deleted secret object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultSecretIdentityItem +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Secret name. +Cmdlet constructs the FQDN of a secret from vault name, currently selected environment and secret name. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: SecretName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultSecretIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecret + +## NOTES + +## RELATED LINKS + +[Remove-AzKeyVaultSecret](./Remove-AzKeyVaultSecret.md) + +[Set-AzKeyVaultSecret](./Set-AzKeyVaultSecret.md) + +[Get-AzKeyVaultSecret](./Get-AzKeyVaultSecret.md) diff --git a/azps-10.1.0/Az.KeyVault/Update-AzKeyVault.md b/azps-10.1.0/Az.KeyVault/Update-AzKeyVault.md new file mode 100644 index 0000000000..1049987075 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Update-AzKeyVault.md @@ -0,0 +1,276 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/update-azkeyvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVault.md +--- + +# Update-AzKeyVault + +## SYNOPSIS +Update the state of an Azure key vault. + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Update-AzKeyVault -ResourceGroupName <String> -VaultName <String> [-EnablePurgeProtection] + [-EnableRbacAuthorization <Boolean>] [-PublicNetworkAccess <String>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzKeyVault -InputObject <PSKeyVault> [-EnablePurgeProtection] [-EnableRbacAuthorization <Boolean>] + [-PublicNetworkAccess <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### UpdateByResourceIdParameterSet +``` +Update-AzKeyVault -ResourceId <String> [-EnablePurgeProtection] [-EnableRbacAuthorization <Boolean>] + [-PublicNetworkAccess <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet updates the state of an Azure key vault. + +## EXAMPLES + +### Example 1: Enable purge protection +```powershell +Get-AzKeyVault -VaultName $keyVaultName -ResourceGroupName $resourceGroupName | Update-AzKeyVault -EnablePurgeProtection +``` + +Enables purge protection using piping syntax. + +### Example 2: Enable RBAC Authorization +```powershell +Get-AzKeyVault -VaultName $keyVaultName -ResourceGroupName $resourceGroupName | Update-AzKeyVault -EnableRbacAuthorization $true +``` + +Enables RBAC Authorization using piping syntax. + +### Example 3: Set tags +```powershell +Get-AzKeyVault -VaultName $keyVaultName | Update-AzKeyVault -Tags @{key = "value"} +``` + +Sets the tags of a key vault named $keyVaultName. + +### Example 4: Clean tags +```powershell +Get-AzKeyVault -VaultName $keyVaultName | Update-AzKeyVault -Tags @{} +``` + +Deletes all tags of a key vault named $keyVaultName. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePurgeProtection +Enable the purge protection functionality for this key vault. +Once enabled it cannot be disabled. +It requires soft-delete to be turned on. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableRbacAuthorization +Enable or disable this key vault to authorize data actions by Role Based Access Control (RBAC). + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Key vault object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Specifies whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID of the key vault. + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Name of the key vault. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultCertificate.md b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultCertificate.md new file mode 100644 index 0000000000..532308ccd5 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultCertificate.md @@ -0,0 +1,258 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/update-azkeyvaultcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultCertificate.md +--- + +# Update-AzKeyVaultCertificate + +## SYNOPSIS +Modifies editable attributes of a certificate. + +## SYNTAX + +### ByName (Default) +``` +Update-AzKeyVaultCertificate [-VaultName] <String> [-Name] <String> [[-Version] <String>] [-Enable <Boolean>] + [-Tag <Hashtable>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObject +``` +Update-AzKeyVaultCertificate [-InputObject] <PSKeyVaultCertificateIdentityItem> [[-Version] <String>] + [-Enable <Boolean>] [-Tag <Hashtable>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzKeyVaultCertificate** cmdlet modifies the editable attributes of a certificate. + +## EXAMPLES + +### Example 1: Modify the tags associated with a certificate +```powershell +$Tags = @{ "Team" = "Azure" ; "Role" = "Engg" } +Update-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01" -Tag $Tags -PassThru +``` + +```output +Name : TestCert01 +Certificate : [Subject] + CN=AZURE + + [Issuer] + CN=AZURE + + [Serial Number] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + [Not Before] + 7/27/2016 6:50:01 PM + + [Not After] + 7/27/2018 7:00:01 PM + + [Thumbprint] + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + +Id : https://ContosoKV01.vault.azure.net:443/certificates/TestCert01 +KeyId : https://ContosoKV01.vault.azure.net:443/keys/TestCert01 +SecretId : https://ContosoKV01.vault.azure.net:443/secrets/TestCert01 +Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +Tags : {[Role, Engg], [Team, Azure]} +Enabled : True +Created : 7/28/2016 2:00:01 AM +Updated : 8/1/2016 5:37:48 PM +``` + +The first command assigns an array of key/value pairs to the $Tags variable. +The second command sets the tags value of the certificate named TestCert01 to be $Tags. + +### Example 2 + +Modifies editable attributes of a certificate. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Update-AzKeyVaultCertificate -Enable $true -Name 'TestCert01' -VaultName 'ContosoKV01' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +If present, enable a certificate if value is true. +Disable a certificate if value is false. +If not specified, the existing value of the certificate's enabled/disabled state remains unchanged. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Certificate object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Certificate name. +Cmdlet constructs the FQDN of a secret from vault name, currently selected environment and secret name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: CertificateName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Cmdlet does not return object by default. +If this switch is specified, return certificate object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable representing certificate tags. +If not specified, the existing tags of the sertificate remain unchanged. +Remove a tag by specifying an empty Hashtable. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Certificate version. +Cmdlet constructs the FQDN of a certificate from vault name, currently selected environment, certificate name and certificate version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CertificateVersion + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultKey.md b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultKey.md new file mode 100644 index 0000000000..2e9a9985b1 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultKey.md @@ -0,0 +1,360 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/update-azkeyvaultkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultKey.md +--- + +# Update-AzKeyVaultKey + +## SYNOPSIS +Updates the attributes of a key in a key vault. + +## SYNTAX + +### Default (Default) +``` +Update-AzKeyVaultKey [-VaultName] <String> [-Name] <String> [[-Version] <String>] [-Enable <Boolean>] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-KeyOps <String[]>] [-Tag <Hashtable>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HsmInteractive +``` +Update-AzKeyVaultKey -HsmName <String> [-Name] <String> [[-Version] <String>] [-Enable <Boolean>] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-KeyOps <String[]>] [-Immutable] [-ReleasePolicyPath <String>] + [-Tag <Hashtable>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObject +``` +Update-AzKeyVaultKey [-InputObject] <PSKeyVaultKeyIdentityItem> [[-Version] <String>] [-Enable <Boolean>] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-KeyOps <String[]>] [-Tag <Hashtable>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzKeyVaultKey** cmdlet updates the editable attributes of a key in a key vault. + +## EXAMPLES + +### Example 1: Modify a key to enable it, and set the expiration date and tags +```powershell +$Expires = (Get-Date).AddYears(2).ToUniversalTime() +$Tags = @{'Severity' = 'high'; 'Accounting' = 'true'} +Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Expires $Expires -Enable $True -Tag $Tags -PassThru +``` + +```output +Vault Name : Contoso +Name : ITSoftware +Version : 394f9379a47a4e2086585468de6c7ae5 +Id : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5 +Enabled : True +Expires : 5/25/2020 7:58:07 PM +Not Before : +Created : 4/6/2018 11:31:36 PM +Updated : 5/25/2018 7:59:02 PM +Purge Disabled : False +Tags : Name Value + Severity high + Accounting true +``` + +The first command creates a **DateTime** object by using the **Get-Date** cmdlet. That object +specifies a time two years in the future. The command stores that date in the $Expires variable. +For more information, type `Get-Help Get-Date`. +The second command creates a variable to store tag values of high severity and Accounting. +The final command modifies a key named ITSoftware. The command enables the key, sets its expiration +time to the time stored in $Expires, and sets the tags that are stored in $Tags. + +### Example 2: Modify a key to delete all tags +```powershell +Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Version '394f9379a47a4e2086585468de6c7ae5' -Tag @{} +``` + +```output +Vault Name : Contoso +Name : ITSoftware +Version : 394f9379a47a4e2086585468de6c7ae5 +Id : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5 +Enabled : True +Expires : 5/25/2020 7:58:07 PM +Not Before : +Created : 4/6/2018 11:31:36 PM +Updated : 5/25/2018 8:00:08 PM +Purge Disabled : False +Tags : +``` + +This commands deletes all tags for a specific version of a key named ITSoftware. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Value of true enables the key and a value of false disabless the key. +If not specified, the existing enabled/disabled state remains unchanged. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expires +The expiration time of a key in UTC time. +If not specified, the existing expiration time of the key remains unchanged. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HsmName +HSM name. Cmdlet constructs the FQDN of a managed HSM based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: HsmInteractive +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Immutable +Sets the release policy as immutable state. Once marked immutable, this flag cannot be reset and the policy cannot be changed under any circumstances. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: HsmInteractive +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Key object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyOps +The operations that can be performed with the key. +If not specified, the existing key operations of the key remain unchanged. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Key name. +Cmdlet constructs the FQDN of a key from vault name, currently selected environment and key name. + +```yaml +Type: System.String +Parameter Sets: Default, HsmInteractive +Aliases: KeyName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotBefore +The UTC time before which key can't be used. +If not specified, the existing NotBefore attribute of the key remains unchanged. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Cmdlet does not return an object by default. +If this switch is specified, returns the updated key bundle object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReleasePolicyPath +A path to a file containing JSON policy definition. The policy rules under which a key can be exported. + +```yaml +Type: System.String +Parameter Sets: HsmInteractive +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable represents key tags. +If not specified, the existings tags of the key remain unchanged. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Key version. +Cmdlet constructs the FQDN of a key from vault name, currently selected environment, key name and key version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: KeyVersion + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultManagedHsm.md b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultManagedHsm.md new file mode 100644 index 0000000000..90d33f214b --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultManagedHsm.md @@ -0,0 +1,298 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/update-azkeyvaultmanagedhsm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultManagedHsm.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultManagedHsm.md +--- + +# Update-AzKeyVaultManagedHsm + +## SYNOPSIS +Update the state of an Azure managed HSM. + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Update-AzKeyVaultManagedHsm -Name <String> -ResourceGroupName <String> [-EnablePurgeProtection] + [-PublicNetworkAccess <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzKeyVaultManagedHsm -InputObject <PSManagedHsm> [-EnablePurgeProtection] + [-PublicNetworkAccess <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### UpdateByResourceIdParameterSet +``` +Update-AzKeyVaultManagedHsm -ResourceId <String> [-EnablePurgeProtection] [-PublicNetworkAccess <String>] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet updates the state of an Azure managed HSM. + +## EXAMPLES + +### Example 1: Update a managed Hsm directly +```powershell +Update-AzKeyVaultManagedHsm -Name $hsmName -ResourceGroupName $resourceGroupName -Tag @{testKey="testValue"} | Format-List +``` + +```output +Managed HSM Name : testmhsm +Resource Group Name : testmhsm +Location : eastus2euap +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testmhsm/provid + ers/Microsoft.KeyVault/managedHSMs/testmhsm +HSM Pool URI : +Tenant ID : xxxxxx-xxxx-xxxx-xxxxxxxxxxxx +Initial Admin Object Ids : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SKU : StandardB1 +Soft Delete Enabled? : True +Enabled Purge Protection? : False +Soft Delete Retention Period (days) : 90 +Provisioning State : Provisioning +Status Message : Resource creation in progress. Starting service... +Tags : + Name Value + ==== ===== + testKey testValued +``` + +Updates tags for the managed Hsm named `$hsmName` in resource group `$resourceGroupName`. + +### Example 2: Update a managed Hsm using piping +```powershell +Get-AzKeyVaultManagedHsm -Name $hsmName -ResourceGroupName $resourceGroupName | Update-AzKeyVaultManagedHsm -Tag @{testKey="testValue"} +``` + +Updates tags for the managed Hsm using piping syntax. + +### Example 3: Enable purge protection for a managed Hsm +```powershell +Update-AzKeyVaultManagedHsm -Name $hsmName -ResourceGroupName $resourceGroupName -EnablePurgeProtection | Format-List +``` + +```output +Managed HSM Name : testmhsm +Resource Group Name : test-rg +Location : eastus +Resource ID : /subscriptions/xxxxxx71-1bf0-4dda-aec3-xxxxxxxxxxxx/resourceGroups/test-rg/provide + rs/Microsoft.KeyVault/managedHSMs/testmhsm +HSM Pool URI : +Tenant ID : 54xxxxxx-38d6-4fb2-bad9-xxxxxxxxxxxx +Initial Admin Object Ids : {xxxxxx9e-5be9-4f43-abd2-xxxxxxxxxxxx} +SKU : StandardB1 +Soft Delete Enabled? : True +Enabled Purge Protection? : True +Soft Delete Retention Period (days) : 70 +Provisioning State : Succeeded +Status Message : The Managed HSM is provisioned and ready to use. +Tags : +``` + +Enables purge protection for the managed Hsm named `$hsmName` in resource group `$resourceGroupName`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePurgeProtection +specifying whether protection against purge is enabled for this managed HSM pool. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Managed HSM object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the managed HSM. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: HsmName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Controls permission for data plane traffic coming from public networks while private endpoint is enabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID of the managed HSM. + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm + +## NOTES + +## RELATED LINKS + +[New-AzKeyVaultManagedHsm](./New-AzKeyVaultManagedHsm.md) + +[Remove-AzKeyVaultManagedHsm](./Remove-AzKeyVaultManagedHsm.md) + +[Get-AzKeyVaultManagedHsm](./Get-AzKeyVaultManagedHsm.md) + +[Undo-AzKeyVaultManagedHsmRemoval](./Undo-AzKeyVaultManagedHsmRemoval.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultManagedStorageAccount.md b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultManagedStorageAccount.md new file mode 100644 index 0000000000..547b15e53a --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultManagedStorageAccount.md @@ -0,0 +1,279 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/update-azkeyvaultmanagedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultManagedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultManagedStorageAccount.md +--- + +# Update-AzKeyVaultManagedStorageAccount + +## SYNOPSIS +Update editable attributes of a Key Vault managed Azure Storage Account. + +## SYNTAX + +### ByDefinitionName (Default) +``` +Update-AzKeyVaultManagedStorageAccount [-VaultName] <String> [-AccountName] <String> [-ActiveKeyName <String>] + [-AutoRegenerateKey <Boolean>] [-RegenerationPeriod <TimeSpan>] [-Enable <Boolean>] [-Tag <Hashtable>] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Update-AzKeyVaultManagedStorageAccount [-InputObject] <PSKeyVaultManagedStorageAccountIdentityItem> + [-ActiveKeyName <String>] [-AutoRegenerateKey <Boolean>] [-RegenerationPeriod <TimeSpan>] [-Enable <Boolean>] + [-Tag <Hashtable>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Update the editable attributes of a Key Vault managed Azure Storage Account. + +## EXAMPLES + +### Example 1: Update the active key to 'key2' on a Key Vault managed Azure Storage Account. +```powershell +Update-AzKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -ActiveKeyName 'key2' +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount +Vault Name : myvault +AccountName : mystorageaccount +Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St + orage/storageAccounts/mystorageaccount +Active Key Name : key2 +Auto Regenerate Key : True +Regeneration Period : 90.00:00:00 +Enabled : True +Created : 5/21/2018 11:55:58 PM +Updated : 5/21/2018 11:55:58 PM +Tags : +``` + +Updates the Key Vault managed Azure Storage Account active key to 'key2'. 'key2' will be used to +generate SAS tokens after this update. + +### Example 2 + +Update editable attributes of a Key Vault managed Azure Storage Account. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Update-AzKeyVaultManagedStorageAccount -AccountName 'mystorageaccount' -AutoRegenerateKey $false -RegenerationPeriod $regenerationPeriod -VaultName 'myvault' +``` + +## PARAMETERS + +### -AccountName +Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account +name from vault name, currently selected environment and manged storage account name. + +```yaml +Type: System.String +Parameter Sets: ByDefinitionName +Aliases: StorageAccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveKeyName +Active key name. +If not specified, the existing value of managed storage account's active key name remains unchanged + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoRegenerateKey +Auto regenerate key. +If not specified, the existing value of auto regenerate key of managed storage account remains unchanged + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +If present, enables a use of a managed storage account key for sas token generation if value is +true. Disables use of a managed storage account key for sas token generation if value is false. If +not specified, the existing value of the storage account's enabled/disabled state remains +unchanged. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +ManagedStorageAccount object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Cmdlet does not return object by default. If this switch is specified, return managed storage +account object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegenerationPeriod +Regeneration period. If auto regenerate key is enabled, this value specifies the timespan after +which managed storage account's inactive keygets auto regenerated and becomes the active key. If +not specified, the existing value of regeneration period of keys of managed storage account remains +unchanged + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: ByDefinitionName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccount + +## NOTES + +## RELATED LINKS + +[Az.KeyVault](/powershell/module/az.keyvault) diff --git a/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultManagedStorageAccountKey.md b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultManagedStorageAccountKey.md new file mode 100644 index 0000000000..aab7fc2c4f --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultManagedStorageAccountKey.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/update-azkeyvaultmanagedstorageaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultManagedStorageAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultManagedStorageAccountKey.md +--- + +# Update-AzKeyVaultManagedStorageAccountKey + +## SYNOPSIS +Regenerates the specified key of Key Vault managed Azure Storage Account. + +## SYNTAX + +### ByDefinitionName (Default) +``` +Update-AzKeyVaultManagedStorageAccountKey [-VaultName] <String> [-AccountName] <String> [-KeyName] <String> + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Update-AzKeyVaultManagedStorageAccountKey [-InputObject] <PSKeyVaultManagedStorageAccountIdentityItem> + [-KeyName] <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Regenerates the specified key of Key Vault managed Azure Storage Account and sets the key as the active key. Key Vault proxies the call to Azure Resource Manager to regenerate the key. The caller must posses permissions to regenerate keys on given Azure Storage Account. + +## EXAMPLES + +### Example 1: Regenerate a key +```powershell +Update-AzKeyVaultManagedStorageAccountKey -VaultName 'myvault' -AccountName 'mystorageaccount' -KeyName 'key1' +``` + +```output +Id : https://myvault.vault.azure.net:443/storage/mystorageaccount +Vault Name : myvault +AccountName : mystorageaccount +Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St + orage/storageAccounts/mystorageaccount +Active Key Name : key1 +Auto Regenerate Key : True +Regeneration Period : 90.00:00:00 +Enabled : True +Created : 5/21/2018 11:55:58 PM +Updated : 5/21/2018 11:55:58 PM +Tags : +``` + +Regenerates 'key1' of account 'mystorageaccount' and sets 'key1' as the active of the Key Vault managed Azure Storage Account. + +## PARAMETERS + +### -AccountName +Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected environment and manged storage account name. + +```yaml +Type: System.String +Parameter Sets: ByDefinitionName +Aliases: StorageAccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +ManagedStorageAccount object. + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +Name of storage account key to regenerate and make active. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Cmdlet does not return an object by default. +If this switch is specified, cmdlet returns the managed storage account that was deleted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: ByDefinitionName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccount + +## NOTES + +## RELATED LINKS + +[Azure Key Vault PowerShell cmdlets](/powershell/module/az.keyvault/) diff --git a/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultNetworkRuleSet.md b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultNetworkRuleSet.md new file mode 100644 index 0000000000..6ee5608299 --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultNetworkRuleSet.md @@ -0,0 +1,330 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/update-azkeyvaultnetworkruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultNetworkRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultNetworkRuleSet.md +--- + +# Update-AzKeyVaultNetworkRuleSet + +## SYNOPSIS +Updates the network rule set on a key vault. + +## SYNTAX + +### ByVaultName (Default) +``` +Update-AzKeyVaultNetworkRuleSet [-VaultName] <String> [[-ResourceGroupName] <String>] + [-DefaultAction <PSKeyVaultNetworkRuleDefaultActionEnum>] [-Bypass <PSKeyVaultNetworkRuleBypassEnum>] + [-IpAddressRange <String[]>] [-VirtualNetworkResourceId <String[]>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ByInputObject +``` +Update-AzKeyVaultNetworkRuleSet [-InputObject] <PSKeyVault> + [-DefaultAction <PSKeyVaultNetworkRuleDefaultActionEnum>] [-Bypass <PSKeyVaultNetworkRuleBypassEnum>] + [-IpAddressRange <String[]>] [-VirtualNetworkResourceId <String[]>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### ByResourceId +``` +Update-AzKeyVaultNetworkRuleSet [-ResourceId] <String> + [-DefaultAction <PSKeyVaultNetworkRuleDefaultActionEnum>] [-Bypass <PSKeyVaultNetworkRuleBypassEnum>] + [-IpAddressRange <String[]>] [-VirtualNetworkResourceId <String[]>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzKeyVaultNetworkRuleSet** command updates the network rules in effect on the specified key vault. + +## EXAMPLES + +### Example 1 +```powershell +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -ServiceEndpoint Microsoft.KeyVault +$virtualNetwork = New-AzVirtualNetwork -Name myVNet -ResourceGroupName myRG -Location westus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet +$myNetworkResId = (Get-AzVirtualNetwork -Name myVNet -ResourceGroupName myRG).Subnets[0].Id +Update-AzKeyVaultNetworkRuleSet -VaultName 'myVault' -ResourceGroupName myRG -Bypass AzureServices -IpAddressRange "10.0.1.0/24" -VirtualNetworkResourceId $myNetworkResId -PassThru +``` + +```output +Vault Name : myVault +Resource Group Name : myRG +Location : West US +Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers + /Microsoft.KeyVault/vaults/myvault +Vault URI : https://myvault.vault.azure.net/ +Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +SKU : Standard +Enabled For Deployment? : False +Enabled For Template Deployment? : False +Enabled For Disk Encryption? : False +Soft Delete Enabled? : +Access Policies : + Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx + Application ID : + Display Name : User Name (username@microsoft.com) + Permissions to Keys : get, create, delete, list, update, + import, backup, restore, recover + Permissions to Secrets : get, list, set, delete, backup, + restore, recover + Permissions to Certificates : get, delete, list, create, import, + update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers, + setissuers, recover, backup, restore + Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list, + listsas, regeneratekey, set, setsas, update, recover, backup, restore + + +Network Rule Set : + Default Action : Allow + Bypass : AzureServices + IP Rules : 10.0.1.0/24 + Virtual Network Rules : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx- + xxxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.network/virtualnetworks/myvn + et/subnets/frontendsubnet + +Tags : +``` + +This command updates the network ruleset on the vault named 'myVault' for the specified IP range and the virtual network, allowing bypassing of the network rule for Azure services. + +### Example 2 + +Updates the network rule set on a key vault. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Update-AzKeyVaultNetworkRuleSet -DefaultAction Allow -VaultName 'myVault' +``` + +## PARAMETERS + +### -Bypass +Specifies bypass of network rule. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultNetworkRuleBypassEnum] +Parameter Sets: (All) +Aliases: +Accepted values: None, AzureServices + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultAction +Specifies default action of network rule. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultNetworkRuleDefaultActionEnum] +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KeyVault object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IpAddressRange +Specifies allowed network IP address range of network rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns the updated key vault object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group associated with the key vault whose network rule is being modified. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +KeyVault Resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. +By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. +Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VaultName +Specifies the name of a key vault whose network rule is being modified. + +```yaml +Type: System.String +Parameter Sets: ByVaultName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkResourceId +Specifies allowed virtual network resource identifier of network rule. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultNetworkRuleDefaultActionEnum, Microsoft.Azure.PowerShell.Cmdlets.KeyVault, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +### System.Nullable`1[[Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultNetworkRuleBypassEnum, Microsoft.Azure.PowerShell.Cmdlets.KeyVault, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultSecret.md b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultSecret.md new file mode 100644 index 0000000000..6f62bc873e --- /dev/null +++ b/azps-10.1.0/Az.KeyVault/Update-AzKeyVaultSecret.md @@ -0,0 +1,324 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml +Module Name: Az.KeyVault +online version: https://learn.microsoft.com/powershell/module/az.keyvault/update-azkeyvaultsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KeyVault/KeyVault/help/Update-AzKeyVaultSecret.md +--- + +# Update-AzKeyVaultSecret + +## SYNOPSIS +Updates attributes of a secret in a key vault. + +## SYNTAX + +### Default (Default) +``` +Update-AzKeyVaultSecret [-VaultName] <String> [-Name] <String> [[-Version] <String>] [-Enable <Boolean>] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-ContentType <String>] [-Tag <Hashtable>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Update-AzKeyVaultSecret [-InputObject] <PSKeyVaultSecretIdentityItem> [[-Version] <String>] [-Enable <Boolean>] + [-Expires <DateTime>] [-NotBefore <DateTime>] [-ContentType <String>] [-Tag <Hashtable>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzKeyVaultSecret** cmdlet updates editable attributes of a secret in a key vault. + +## EXAMPLES + +### Example 1: Modify the attributes of a secret +```powershell +$Expires = (Get-Date).AddYears(2).ToUniversalTime() +$Nbf = (Get-Date).ToUniversalTime() +$Tags = @{ 'Severity' = 'medium'; 'HR' = 'true'} +$ContentType= 'xml' +Update-AzKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Expires $Expires -NotBefore $Nbf -ContentType $ContentType -Enable $True -Tag $Tags -PassThru +``` + +```output +Vault Name : ContosoVault +Name : HR +Version : d476edfcd3544017a03bc49c1f3abec0 +Id : https://ContosoVault.vault.azure.net:443/secrets/HR/d476edfcd3544017a03bc49c1f3abec0 +Enabled : True +Expires : 5/25/2020 8:01:58 PM +Not Before : 5/25/2018 8:02:02 PM +Created : 4/11/2018 11:45:06 PM +Updated : 5/25/2018 8:02:45 PM +Content Type : xml +Tags : Name Value + Severity medium + HR true +``` + +The first four commands define attributes for the expiry date, the NotBefore date, tags, and +context type, and store the attributes in variables. +The final command modifies the attributes for the secret named HR in the key vault named +ContosoVault, using the stored variables. + +### Example 2: Delete the tags and content type for a secret +```powershell +Update-AzKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag @{} +``` + +This command deletes the tags and the content type for the specified version of the secret named HR +in the key vault named Contoso. + +### Example 3: Disable the current version of secrets whose name begins with IT +```powershell +$Vault = 'ContosoVault' +$Prefix = 'IT' +Get-AzKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzKeyVaultSecret -Enable $False +``` + +The first command stores the string value Contoso in the $Vault variable. +The second command stores the string value IT in the $Prefix variable. +The third command uses the Get-AzKeyVaultSecret cmdlet to get the secrets in the specified key +vault, and then passes those secrets to the **Where-Object** cmdlet. The **Where-Object** cmdlet +filters the secrets for names that begin with the characters IT. The command pipes the secrets that +match the filter to the Update-AzKeyVaultSecret cmdlet, which disables them. + +### Example 4: Set the ContentType for all versions of a secret +```powershell +$VaultName = 'ContosoVault' +$Name = 'HR' +$ContentType = 'xml' +Get-AzKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzKeyVaultSecret -ContentType $ContentType +``` + +The first three commands define string variables to use for the *VaultName*, *Name*, and +*ContentType* parameters. The fourth command uses the Get-AzKeyVaultKey cmdlet to get the +specified keys, and pipes the keys to the Update-AzKeyVaultSecret cmdlet to set their +content type to XML. + +## PARAMETERS + +### -ContentType +Secret's content type. +If not specified, the existing value of the secret's content type remains unchanged. +Remove the existing content type value by specifying an empty string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +If present, enable a secret if value is true. +Disable a secret if value is false. +If not specified, the existing value of the secret's enabled/disabled state remains unchanged. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expires +The expiration time of a secret in UTC time. +If not specified, the existing value of the secret's expiration time remains unchanged. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Secret object + +```yaml +Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem +Parameter Sets: InputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Secret name. +Cmdlet constructs the FQDN of a secret from vault name, currently selected environment and secret name. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: SecretName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotBefore +The UTC time before which secret can't be used. +If not specified, the existing value of the secret's NotBefore attribute remains unchanged. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Cmdlet does not return object by default. +If this switch is specified, return Secret object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable representing secret tags. +If not specified, the existing tags of the secret remain unchanged. +Remove a tag by specifying an empty Hashtable. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultName +Vault name. +Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Secret version. +Cmdlet constructs the FQDN of a secret from vault name, currently selected environment, secret name and secret version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SecretVersion + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem + +## OUTPUTS + +### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecret + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.KubernetesConfiguration/Az.KubernetesConfiguration.md b/azps-10.1.0/Az.KubernetesConfiguration/Az.KubernetesConfiguration.md new file mode 100644 index 0000000000..494a1f5eac --- /dev/null +++ b/azps-10.1.0/Az.KubernetesConfiguration/Az.KubernetesConfiguration.md @@ -0,0 +1,52 @@ +--- +Module Name: Az.KubernetesConfiguration +Module Guid: 372af220-241d-455f-a85f-8be57ce75bb7 +Download Help Link: https://learn.microsoft.com/powershell/module/az.kubernetesconfiguration +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Az.KubernetesConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Az.KubernetesConfiguration.md +--- + +# Az.KubernetesConfiguration Module +## Description +Microsoft Azure PowerShell: KubernetesConfiguration cmdlets + +## Az.KubernetesConfiguration Cmdlets +### [Get-AzKubernetesConfigFluxOperationStatus](Get-AzKubernetesConfigFluxOperationStatus.md) +Get Async Operation status + +### [Get-AzKubernetesConfiguration](Get-AzKubernetesConfiguration.md) +Gets details of the Source Control Configuration. + +### [Get-AzKubernetesConfigurationFlux](Get-AzKubernetesConfigurationFlux.md) +Gets details of the Flux Configuration. + +### [Get-AzKubernetesExtension](Get-AzKubernetesExtension.md) +Gets Kubernetes Cluster Extension. + +### [New-AzKubernetesConfiguration](New-AzKubernetesConfiguration.md) +Create a new Kubernetes Source Control Configuration. + +### [New-AzKubernetesConfigurationFlux](New-AzKubernetesConfigurationFlux.md) +Create a new Kubernetes Flux Configuration. + +### [New-AzKubernetesExtension](New-AzKubernetesExtension.md) +Create a new Kubernetes Cluster Extension. + +### [Remove-AzKubernetesConfiguration](Remove-AzKubernetesConfiguration.md) +This will delete the YAML file used to set up the Source control configuration, thus stopping future sync from the source repo. + +### [Remove-AzKubernetesConfigurationFlux](Remove-AzKubernetesConfigurationFlux.md) +This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo. + +### [Remove-AzKubernetesExtension](Remove-AzKubernetesExtension.md) +Delete a Kubernetes Cluster Extension. +This will cause the Agent to Uninstall the extension from the cluster. + +### [Update-AzKubernetesConfigurationFlux](Update-AzKubernetesConfigurationFlux.md) +Update an existing Kubernetes Flux Configuration. + +### [Update-AzKubernetesExtension](Update-AzKubernetesExtension.md) +Patch an existing Kubernetes Cluster Extension. + diff --git a/azps-10.1.0/Az.KubernetesConfiguration/Get-AzKubernetesConfigFluxOperationStatus.md b/azps-10.1.0/Az.KubernetesConfiguration/Get-AzKubernetesConfigFluxOperationStatus.md new file mode 100644 index 0000000000..046e1f3372 --- /dev/null +++ b/azps-10.1.0/Az.KubernetesConfiguration/Get-AzKubernetesConfigFluxOperationStatus.md @@ -0,0 +1,209 @@ +--- +external help file: +Module Name: Az.KubernetesConfiguration +online version: https://learn.microsoft.com/powershell/module/az.kubernetesconfiguration/get-azkubernetesconfigfluxoperationstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Get-AzKubernetesConfigFluxOperationStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Get-AzKubernetesConfigFluxOperationStatus.md +--- + +# Get-AzKubernetesConfigFluxOperationStatus + +## SYNOPSIS +Get Async Operation status + +## SYNTAX + +### Get (Default) +``` +Get-AzKubernetesConfigFluxOperationStatus -ClusterName <String> -ClusterType <String> + -FluxConfigurationName <String> -OperationId <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKubernetesConfigFluxOperationStatus -InputObject <IKubernetesConfigurationIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get Async Operation status + +## EXAMPLES + +### Example 1: Get Async Operation status +```powershell +Get-AzKubernetesConfigFluxOperationStatus -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -FluxConfigurationName azpstestflux-k8s -ResourceGroupName azps_test_group -OperationId e9871335-7ba8-4100-8cb4-73b3464eb863 +``` + +```output +Name ResourceGroupName Status +---- ----------------- ------ +e9871335-7ba8-4100-8cb4-73b3464eb863 azps_test_group Succeeded +``` + +Get Async Operation status + +## PARAMETERS + +### -ClusterName +The name of the kubernetes cluster. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +The Kubernetes cluster resource name - i.e. +managedClusters, connectedClusters, provisionedClusters. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FluxConfigurationName +Name of the Flux Configuration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OperationId +operation Id + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.Api20220301.IOperationStatusResult + +## NOTES + +ALIASES + +Get-AzK8sConfigFluxOperationStatus + +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 <IKubernetesConfigurationIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the kubernetes cluster. + - `[ClusterResourceName <String>]`: The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters. + - `[ClusterRp <String>]`: The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. + - `[ExtensionName <String>]`: Name of the Extension. + - `[FluxConfigurationName <String>]`: Name of the Flux Configuration. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: operation Id + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SourceControlConfigurationName <String>]`: Name of the Source Control Configuration. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.KubernetesConfiguration/Get-AzKubernetesConfiguration.md b/azps-10.1.0/Az.KubernetesConfiguration/Get-AzKubernetesConfiguration.md new file mode 100644 index 0000000000..e88ea12edc --- /dev/null +++ b/azps-10.1.0/Az.KubernetesConfiguration/Get-AzKubernetesConfiguration.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.KubernetesConfiguration +online version: https://learn.microsoft.com/powershell/module/az.kubernetesconfiguration/get-azkubernetesconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Get-AzKubernetesConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Get-AzKubernetesConfiguration.md +--- + +# Get-AzKubernetesConfiguration + +## SYNOPSIS +Gets details of the Source Control Configuration. + +## SYNTAX + +### List (Default) +``` +Get-AzKubernetesConfiguration -ClusterName <String> -ClusterType <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzKubernetesConfiguration -ClusterName <String> -ClusterType <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKubernetesConfiguration -InputObject <IKubernetesConfigurationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets details of the Source Control Configuration. + +## EXAMPLES + +### Example 1: List details of the Source Control Configuration. +```powershell +Get-AzKubernetesConfiguration -ResourceGroupName azps_test_group -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters +``` + +```output +Name RepositoryUrl ResourceGroupName +---- ------------- ----------------- +azpstestk8s http://github.com/xxxx azps_test_group +azpstestk8s-operator http://github.com/xxxx azps_test_group +``` + +List details of the Source Control Configuration. + +### Example 2: Gets details of the Source Control Configuration. +```powershell +Get-AzKubernetesConfiguration -ResourceGroupName azps_test_group -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -Name azpstestk8s +``` + +```output +Name RepositoryUrl ResourceGroupName +---- ------------- ----------------- +azpstestk8s http://github.com/xxxx azps_test_group +``` + +Gets details of the Source Control Configuration. + +## PARAMETERS + +### -ClusterName +The name of the kubernetes cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +The Kubernetes cluster resource name - i.e. +managedClusters, connectedClusters, provisionedClusters. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Source Control Configuration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SourceControlConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.Api20221101.ISourceControlConfiguration + +## NOTES + +ALIASES + +Get-AzK8sConfiguration + +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 <IKubernetesConfigurationIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the kubernetes cluster. + - `[ClusterResourceName <String>]`: The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters. + - `[ClusterRp <String>]`: The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. + - `[ExtensionName <String>]`: Name of the Extension. + - `[FluxConfigurationName <String>]`: Name of the Flux Configuration. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: operation Id + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SourceControlConfigurationName <String>]`: Name of the Source Control Configuration. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.KubernetesConfiguration/Get-AzKubernetesConfigurationFlux.md b/azps-10.1.0/Az.KubernetesConfiguration/Get-AzKubernetesConfigurationFlux.md new file mode 100644 index 0000000000..5d51525e5f --- /dev/null +++ b/azps-10.1.0/Az.KubernetesConfiguration/Get-AzKubernetesConfigurationFlux.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.KubernetesConfiguration +online version: https://learn.microsoft.com/powershell/module/az.kubernetesconfiguration/get-azkubernetesconfigurationflux +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Get-AzKubernetesConfigurationFlux.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Get-AzKubernetesConfigurationFlux.md +--- + +# Get-AzKubernetesConfigurationFlux + +## SYNOPSIS +Gets details of the Flux Configuration. + +## SYNTAX + +### List (Default) +``` +Get-AzKubernetesConfigurationFlux -ClusterName <String> -ClusterType <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzKubernetesConfigurationFlux -ClusterName <String> -ClusterType <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKubernetesConfigurationFlux -InputObject <IKubernetesConfigurationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets details of the Flux Configuration. + +## EXAMPLES + +### Example 1: List details of the Flux Configuration. +```powershell +Get-AzKubernetesConfigurationFlux -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -ResourceGroupName azps_test_group +``` + +```output +Name ResourceGroupName +---- ----------------- +azpstestflux-k8s azps_test_group +``` + +List details of the Flux Configuration. + +### Example 2: Gets details of the Flux Configuration. +```powershell +Get-AzKubernetesConfigurationFlux -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -Name azpstestflux-k8s -ResourceGroupName azps_test_group +``` + +```output +Name ResourceGroupName +---- ----------------- +azpstestflux-k8s azps_test_group +``` + +Gets details of the Flux Configuration. + +## PARAMETERS + +### -ClusterName +The name of the kubernetes cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +The Kubernetes cluster resource name - i.e. +managedClusters, connectedClusters, provisionedClusters. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Flux Configuration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: FluxConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.Api20221101.IFluxConfiguration + +## NOTES + +ALIASES + +Get-AzK8sConfigurationFlux + +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 <IKubernetesConfigurationIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the kubernetes cluster. + - `[ClusterResourceName <String>]`: The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters. + - `[ClusterRp <String>]`: The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. + - `[ExtensionName <String>]`: Name of the Extension. + - `[FluxConfigurationName <String>]`: Name of the Flux Configuration. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: operation Id + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SourceControlConfigurationName <String>]`: Name of the Source Control Configuration. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.KubernetesConfiguration/Get-AzKubernetesExtension.md b/azps-10.1.0/Az.KubernetesConfiguration/Get-AzKubernetesExtension.md new file mode 100644 index 0000000000..81c00f4ee9 --- /dev/null +++ b/azps-10.1.0/Az.KubernetesConfiguration/Get-AzKubernetesExtension.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.KubernetesConfiguration +online version: https://learn.microsoft.com/powershell/module/az.kubernetesconfiguration/get-azkubernetesextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Get-AzKubernetesExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Get-AzKubernetesExtension.md +--- + +# Get-AzKubernetesExtension + +## SYNOPSIS +Gets Kubernetes Cluster Extension. + +## SYNTAX + +### List (Default) +``` +Get-AzKubernetesExtension -ClusterName <String> -ClusterType <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzKubernetesExtension -ClusterName <String> -ClusterType <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKubernetesExtension -InputObject <IKubernetesConfigurationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets Kubernetes Cluster Extension. + +## EXAMPLES + +### Example 1: Gets Kubernetes Cluster Extension. +```powershell +Get-AzKubernetesExtension -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -Name azpstest-extension -ResourceGroupName azps_test_group +``` + +```output +Name ExtensionType Version ProvisioningState AutoUpgradeMinorVersion ReleaseTrain +---- ------------- ------- ----------------- ----------------------- ------------ +azpstest-extension azuremonitor-containers 2.9.2 Succeeded True Stable +``` + +Gets Kubernetes Cluster Extension. + +### Example 2: List Kubernetes Cluster Extension. +```powershell +Get-AzKubernetesExtension -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -ResourceGroupName azps_test_group +``` + +```output +Name ExtensionType Version ProvisioningState AutoUpgradeMinorVersion ReleaseTrain +---- ------------- ------- ----------------- ----------------------- ------------ +azpstest-extension azuremonitor-containers 2.9.2 Succeeded True Stable +flux microsoft.flux 1.0.0 Succeeded True Stable +``` + +List Kubernetes Cluster Extension. + +## PARAMETERS + +### -ClusterName +The name of the kubernetes cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +The Kubernetes cluster resource name - i.e. +managedClusters, connectedClusters, provisionedClusters. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Extension. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.Api20221101.IExtension + +## NOTES + +ALIASES + +Get-AzK8sExtension + +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 <IKubernetesConfigurationIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the kubernetes cluster. + - `[ClusterResourceName <String>]`: The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters. + - `[ClusterRp <String>]`: The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. + - `[ExtensionName <String>]`: Name of the Extension. + - `[FluxConfigurationName <String>]`: Name of the Flux Configuration. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: operation Id + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SourceControlConfigurationName <String>]`: Name of the Source Control Configuration. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.KubernetesConfiguration/New-AzKubernetesConfiguration.md b/azps-10.1.0/Az.KubernetesConfiguration/New-AzKubernetesConfiguration.md new file mode 100644 index 0000000000..afcde84b8d --- /dev/null +++ b/azps-10.1.0/Az.KubernetesConfiguration/New-AzKubernetesConfiguration.md @@ -0,0 +1,384 @@ +--- +external help file: +Module Name: Az.KubernetesConfiguration +online version: https://learn.microsoft.com/powershell/module/az.kubernetesconfiguration/new-azkubernetesconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/New-AzKubernetesConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/New-AzKubernetesConfiguration.md +--- + +# New-AzKubernetesConfiguration + +## SYNOPSIS +Create a new Kubernetes Source Control Configuration. + +## SYNTAX + +``` +New-AzKubernetesConfiguration -ClusterName <String> -ClusterType <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-ClusterScoped] + [-ConfigurationProtectedSetting <Hashtable>] [-EnableHelmOperator] [-HelmOperatorChartValue <String>] + [-HelmOperatorChartVersion <String>] [-OperatorInstanceName <String>] [-OperatorNamespace <String>] + [-OperatorParam <String>] [-OperatorScope <OperatorScopeType>] [-OperatorType <OperatorType>] + [-RepositoryUrl <String>] [-SshKnownHost <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a new Kubernetes Source Control Configuration. + +## EXAMPLES + +### Example 1: Create a configuration for Kubernetes Cluster +```powershell +New-AzConnectedKubernetes -ClusterName azpstest_cluster_arc -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 +New-AzKubernetesConfiguration -ResourceGroupName azps_test_group -ClusterName azpstest_cluster_arc -Name azpstestk8s -RepositoryUrl http://github.com/xxxx -ClusterType ConnectedClusters +``` + +```output +Name RepositoryUrl ResourceGroupName +---- ------------- ----------------- +azpstestk8s http://github.com/xxxx azps_test_group +``` + +This command creates a configuration for Kubernetes Cluster. + +### Example 2: Create a configuration for Kubernetes Cluster with specify paramter OperatorNamespace +```powershell +New-AzConnectedKubernetes -ClusterName azpstest_cluster_arc -ResourceGroupName azps_test_group -Location eastus -KubeConfig $HOME\.kube\config -KubeContext azps_aks_t01 +New-AzKubernetesConfiguration -ResourceGroupName azps_test_group -ClusterName azpstest_cluster_arc -Name azpstestk8s-operator -RepositoryUrl http://github.com/xxxx -OperatorScope 'cluster' -ClusterType ConnectedClusters +``` + +```output +Name RepositoryUrl ResourceGroupName +---- ------------- ----------------- +azpstestk8s-operator http://github.com/xxxx azps_test_group +``` + +This command creates a configuration in the new operator namespace for Kubernetes Cluster. +Note, Unable to create a configuration in an existing operator namespace. + +## PARAMETERS + +### -ClusterName +The name of the kubernetes cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterScoped +If passed set the scope of the Configuration to Cluster (default is nameSpace). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +The Kubernetes cluster resource name - i.e. +managedClusters, connectedClusters, provisionedClusters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationProtectedSetting +Name-value pairs of protected configuration settings for the configuration + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableHelmOperator +Option to enable Helm Operator for this git configuration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HelmOperatorChartValue +Values override for the operator Helm chart. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HelmOperatorChartVersion +Version of the operator Helm chart. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Source Control Configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SourceControlConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperatorInstanceName +Instance name of the operator - identifying the specific configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperatorNamespace +The namespace to which this operator is installed to. +Maximum of 253 lower case alphanumeric characters, hyphen and period only. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperatorParam +Any Parameters for the Operator instance in string format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperatorScope +Scope at which the operator will be installed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Support.OperatorScopeType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperatorType +Type of the operator + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Support.OperatorType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryUrl +Url of the SourceControl Repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshKnownHost +Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.Api20221101.ISourceControlConfiguration + +## NOTES + +ALIASES + +New-AzK8sConfiguration + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.KubernetesConfiguration/New-AzKubernetesConfigurationFlux.md b/azps-10.1.0/Az.KubernetesConfiguration/New-AzKubernetesConfigurationFlux.md new file mode 100644 index 0000000000..4f239aa712 --- /dev/null +++ b/azps-10.1.0/Az.KubernetesConfiguration/New-AzKubernetesConfigurationFlux.md @@ -0,0 +1,815 @@ +--- +external help file: +Module Name: Az.KubernetesConfiguration +online version: https://learn.microsoft.com/powershell/module/az.kubernetesconfiguration/new-azkubernetesconfigurationflux +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/New-AzKubernetesConfigurationFlux.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/New-AzKubernetesConfigurationFlux.md +--- + +# New-AzKubernetesConfigurationFlux + +## SYNOPSIS +Create a new Kubernetes Flux Configuration. + +## SYNTAX + +``` +New-AzKubernetesConfigurationFlux -ClusterName <String> -ClusterType <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-AzureBlobAccountKey <String>] + [-AzureBlobContainerName <String>] [-AzureBlobLocalAuthRef <String>] [-AzureBlobSasToken <String>] + [-AzureBlobSyncIntervalInSecond <Int64>] [-AzureBlobTimeoutInSecond <Int64>] [-AzureBlobUrl <String>] + [-BucketAccessKey <SecureString>] [-BucketInsecure] [-BucketLocalAuthRef <String>] [-BucketName <String>] + [-BucketSyncIntervalInSecond <Int64>] [-BucketTimeoutInSecond <Int64>] [-BucketUrl <String>] + [-ConfigurationProtectedSetting <Hashtable>] [-GitRepositoryHttpsCaCert <String>] + [-GitRepositoryHttpsUser <String>] [-GitRepositoryLocalAuthRef <String>] + [-GitRepositorySshKnownHost <String>] [-GitRepositorySyncIntervalInSecond <Int64>] + [-GitRepositoryTimeoutInSecond <Int64>] [-GitRepositoryUrl <String>] [-Kustomization <Hashtable>] + [-ManagedIdentityClientId <String>] [-Namespace <String>] [-RepositoryRefBranch <String>] + [-RepositoryRefCommit <String>] [-RepositoryRefSemver <String>] [-RepositoryRefTag <String>] + [-Scope <ScopeType>] [-ServicePrincipalClientCertificate <String>] + [-ServicePrincipalClientCertificatePassword <String>] [-ServicePrincipalClientCertificateSendChain] + [-ServicePrincipalClientId <String>] [-ServicePrincipalClientSecret <String>] + [-ServicePrincipalTenantId <String>] [-SourceKind <SourceKindType>] [-Suspend] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new Kubernetes Flux Configuration. + +## EXAMPLES + +### Example 1: Create a new Kubernetes Flux Configuration. +```powershell +$kustomizations = @{ + infra=@{ + Name = "infra" + Path = "./infrastructure" + Prune = "true" + }; + apps=@{ + Name = "apps" + Path = "./apps/staging" + Prune = "true" + DependsOn = @("infra") + } +} +New-AzKubernetesConfigurationFlux -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -Name azpstestflux-k8s -ResourceGroupName azpstest_gp -Namespace namespace-t01 -Scope 'cluster' -GitRepositoryUrl https://github.com/Azure/gitops-flux2-kustomize-helm-mt -RepositoryRefBranch main -SourceKind 'GitRepository' -GitRepositorySyncIntervalInSecond 600 -GitRepositoryTimeoutInSecond 600 -Suspend:$false -Kustomization $kustomizations +``` + +```output +Name ResourceGroupName +---- ----------------- +azpstestflux-k8s azpstest_gp +``` + +Create a new Kubernetes Flux Configuration. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobAccountKey +The account key (shared key) to access the storage account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobContainerName +The Azure Blob container name to sync from the url endpoint for the flux configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobLocalAuthRef +Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobSasToken +The Shared Access token to access the storage container + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobSyncIntervalInSecond +The interval at which to re-reconcile the cluster Azure Blob source with the remote. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobTimeoutInSecond +The maximum time to attempt to reconcile the cluster Azure Blob source with the remote. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobUrl +The URL to sync for the flux configuration Azure Blob storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketAccessKey +Plaintext access key used to securely access the S3 bucket + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketInsecure +Specify whether to use insecure communication when puling data from the S3 bucket. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketLocalAuthRef +Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketName +The bucket name to sync from the url endpoint for the flux configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketSyncIntervalInSecond +The interval at which to re-reconcile the cluster bucket source with the remote. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketTimeoutInSecond +The maximum time to attempt to reconcile the cluster bucket source with the remote. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketUrl +The URL to sync for the flux configuration S3 bucket. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the kubernetes cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +The Kubernetes cluster resource name - i.e. +managedClusters, connectedClusters, provisionedClusters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationProtectedSetting +Key-value pairs of protected configuration settings for the configuration + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositoryHttpsCaCert +Base64-encoded HTTPS certificate authority contents used to access git private git repositories over HTTPS + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositoryHttpsUser +Plaintext HTTPS username used to access private git repositories over HTTPS + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositoryLocalAuthRef +Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositorySshKnownHost +Base64-encoded known_hosts value containing public SSH keys required to access private git repositories over SSH + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositorySyncIntervalInSecond +The interval at which to re-reconcile the cluster git repository source with the remote. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositoryTimeoutInSecond +The maximum time to attempt to reconcile the cluster git repository source with the remote. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositoryUrl +The URL to sync for the flux configuration git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kustomization +Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedIdentityClientId +The client Id for authenticating a Managed Identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Flux Configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FluxConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace to which this configuration is installed to. +Maximum of 253 lower case alphanumeric characters, hyphen and period only. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryRefBranch +The git repository branch name to checkout. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryRefCommit +The commit SHA to checkout. +This value must be combined with the branch name to be valid. +This takes precedence over semver. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryRefSemver +The semver range used to match against git repository tags. +This takes precedence over tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryRefTag +The git repository tag name to checkout. +This takes precedence over branch. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Scope at which the operator will be installed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Support.ScopeType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalClientCertificate +Base64-encoded certificate used to authenticate a Service Principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalClientCertificatePassword +The password for the certificate used to authenticate a Service Principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalClientCertificateSendChain +Specifies whether to include x5c header in client claims when acquiring a token to enable subject name / issuer based authentication for the Client Certificate + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalClientId +The client Id for authenticating a Service Principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalClientSecret +The client secret for authenticating a Service Principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalTenantId +The tenant Id for authenticating a Service Principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceKind +Source Kind to pull the configuration data from. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Support.SourceKindType +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Suspend +Whether this configuration should suspend its reconciliation of its kustomizations and sources. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.Api20221101.IFluxConfiguration + +## NOTES + +ALIASES + +New-AzK8sConfigurationFlux + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.KubernetesConfiguration/New-AzKubernetesExtension.md b/azps-10.1.0/Az.KubernetesConfiguration/New-AzKubernetesExtension.md new file mode 100644 index 0000000000..27b72d9aad --- /dev/null +++ b/azps-10.1.0/Az.KubernetesConfiguration/New-AzKubernetesExtension.md @@ -0,0 +1,466 @@ +--- +external help file: +Module Name: Az.KubernetesConfiguration +online version: https://learn.microsoft.com/powershell/module/az.kubernetesconfiguration/new-azkubernetesextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/New-AzKubernetesExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/New-AzKubernetesExtension.md +--- + +# New-AzKubernetesExtension + +## SYNOPSIS +Create a new Kubernetes Cluster Extension. + +## SYNTAX + +``` +New-AzKubernetesExtension -ClusterName <String> -ClusterType <String> -Name <String> + -ResourceGroupName <String> -ExtensionType <String> [-SubscriptionId <String>] + [-AkAssignedIdentityType <AksIdentityType>] [-AutoUpgradeMinorVersion] + [-ConfigurationProtectedSetting <Hashtable>] [-ConfigurationSetting <Hashtable>] + [-IdentityType <ResourceIdentityType>] [-PlanName <String>] [-PlanProduct <String>] + [-PlanPromotionCode <String>] [-PlanPublisher <String>] [-PlanVersion <String>] [-ReleaseNamespace <String>] + [-ReleaseTrain <String>] [-TargetNamespace <String>] [-Version <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new Kubernetes Cluster Extension. + +## EXAMPLES + +### Example 1: Create a new Kubernetes Cluster Extension. +```powershell +New-AzKubernetesExtension -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -Name azpstest-extension -ResourceGroupName azps_test_group -ExtensionType azuremonitor-containers +``` + +```output +Name ExtensionType Version ProvisioningState AutoUpgradeMinorVersion ReleaseTrain +---- ------------- ------- ----------------- ----------------------- ------------ +azpstest-extension azuremonitor-containers 2.9.2 Succeeded True Stable +``` + +Create a new Kubernetes Cluster Extension. + +### Example 2: Create a Flux Cluster Extension. +```powershell +New-AzKubernetesExtension -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -Name flux -ResourceGroupName azps_test_group -ExtensionType microsoft.flux -AutoUpgradeMinorVersion -ReleaseNamespace flux-system -IdentityType 'SystemAssigned' +``` + +```output +Name ExtensionType Version ProvisioningState AutoUpgradeMinorVersion ReleaseTrain +---- ------------- ------- ----------------- ----------------------- ------------ +flux microsoft.flux 1.0.0 Succeeded True Stable +``` + +Create a Flux Cluster Extension. + +## PARAMETERS + +### -AkAssignedIdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Support.AksIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoUpgradeMinorVersion +Flag to note if this extension participates in auto upgrade of minor version, or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the kubernetes cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +The Kubernetes cluster resource name - i.e. +managedClusters, connectedClusters, provisionedClusters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationProtectedSetting +Configuration settings that are sensitive, as name-value pairs for configuring this extension. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationSetting +Configuration settings, as name-value pairs for configuring this extension. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionType +Type of the Extension, of which this resource is an instance of. +It must be one of the Extension Types registered with Microsoft.KubernetesConfiguration by the Extension publisher. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanName +A user defined name of the 3rd Party Artifact that is being procured. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanProduct +The 3rd Party artifact that is being procured. +E.g. +NewRelic. +Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanPromotionCode +A publisher provided promotion code as provisioned in Data Market for the said product/artifact. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanPublisher +The publisher of the 3rd Party Artifact that is being bought. +E.g. +NewRelic + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanVersion +The version of the desired product/artifact. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReleaseNamespace +Namespace where the extension Release must be placed, for a Cluster scoped extension. +If this namespace does not exist, it will be created + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReleaseTrain +ReleaseTrain this extension participates in for auto-upgrade (e.g. +Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNamespace +Namespace where the extension will be created for an Namespace scoped extension. +If this namespace does not exist, it will be created + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +User-specified version of the extension for this extension to 'pin'. +To use 'version', autoUpgradeMinorVersion must be 'false'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.Api20221101.IExtension + +## NOTES + +ALIASES + +New-AzK8sExtension + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.KubernetesConfiguration/Remove-AzKubernetesConfiguration.md b/azps-10.1.0/Az.KubernetesConfiguration/Remove-AzKubernetesConfiguration.md new file mode 100644 index 0000000000..8e81d2e28d --- /dev/null +++ b/azps-10.1.0/Az.KubernetesConfiguration/Remove-AzKubernetesConfiguration.md @@ -0,0 +1,271 @@ +--- +external help file: +Module Name: Az.KubernetesConfiguration +online version: https://learn.microsoft.com/powershell/module/az.kubernetesconfiguration/remove-azkubernetesconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Remove-AzKubernetesConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Remove-AzKubernetesConfiguration.md +--- + +# Remove-AzKubernetesConfiguration + +## SYNOPSIS +This will delete the YAML file used to set up the Source control configuration, thus stopping future sync from the source repo. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzKubernetesConfiguration -ClusterName <String> -ClusterType <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzKubernetesConfiguration -InputObject <IKubernetesConfigurationIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +This will delete the YAML file used to set up the Source control configuration, thus stopping future sync from the source repo. + +## EXAMPLES + +### Example 1: Remove a configuation of Kubernetes Cluster by name +```powershell +Remove-AzKubernetesConfiguration -ResourceGroupName azps_test_group -ClusterName azpstest_cluster_arc -Name azpstestk8s -ClusterType ConnectedClusters +``` + +This command removes a configuation of Kubernetes Cluster by name. + +### Example 2: Remove a configuation of Kubernetes Cluster by object +```powershell +Get-AzKubernetesConfiguration -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -ResourceGroupName azps_test_group -Name azpstestk8s-operator | Remove-AzKubernetesConfiguration +``` + +This command removes a configuation of Kubernetes Cluster by object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the kubernetes cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +The Kubernetes cluster resource name - i.e. +managedClusters, connectedClusters, provisionedClusters. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Source Control Configuration. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SourceControlConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +Remove-AzK8sConfiguration + +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 <IKubernetesConfigurationIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the kubernetes cluster. + - `[ClusterResourceName <String>]`: The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters. + - `[ClusterRp <String>]`: The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. + - `[ExtensionName <String>]`: Name of the Extension. + - `[FluxConfigurationName <String>]`: Name of the Flux Configuration. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: operation Id + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SourceControlConfigurationName <String>]`: Name of the Source Control Configuration. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.KubernetesConfiguration/Remove-AzKubernetesConfigurationFlux.md b/azps-10.1.0/Az.KubernetesConfiguration/Remove-AzKubernetesConfigurationFlux.md new file mode 100644 index 0000000000..4fd02d383c --- /dev/null +++ b/azps-10.1.0/Az.KubernetesConfiguration/Remove-AzKubernetesConfigurationFlux.md @@ -0,0 +1,286 @@ +--- +external help file: +Module Name: Az.KubernetesConfiguration +online version: https://learn.microsoft.com/powershell/module/az.kubernetesconfiguration/remove-azkubernetesconfigurationflux +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Remove-AzKubernetesConfigurationFlux.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Remove-AzKubernetesConfigurationFlux.md +--- + +# Remove-AzKubernetesConfigurationFlux + +## SYNOPSIS +This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzKubernetesConfigurationFlux -ClusterName <String> -ClusterType <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-ForceDelete] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzKubernetesConfigurationFlux -InputObject <IKubernetesConfigurationIdentity> [-ForceDelete] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo. + +## EXAMPLES + +### Example 1: This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo. +```powershell +Remove-AzKubernetesConfigurationFlux -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -Name azpstestflux-k8s -ResourceGroupName azps_test_group +``` + +This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo. + +### Example 2: This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo. +```powershell +Get-AzKubernetesConfigurationFlux -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -Name azpstestflux-k8s -ResourceGroupName azps_test_group | Remove-AzKubernetesConfigurationFlux +``` + +This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the kubernetes cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +The Kubernetes cluster resource name - i.e. +managedClusters, connectedClusters, provisionedClusters. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDelete +Delete the extension resource in Azure - not the normal asynchronous delete. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Flux Configuration. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: FluxConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +Remove-AzK8sConfigurationFlux + +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 <IKubernetesConfigurationIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the kubernetes cluster. + - `[ClusterResourceName <String>]`: The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters. + - `[ClusterRp <String>]`: The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. + - `[ExtensionName <String>]`: Name of the Extension. + - `[FluxConfigurationName <String>]`: Name of the Flux Configuration. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: operation Id + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SourceControlConfigurationName <String>]`: Name of the Source Control Configuration. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.KubernetesConfiguration/Remove-AzKubernetesExtension.md b/azps-10.1.0/Az.KubernetesConfiguration/Remove-AzKubernetesExtension.md new file mode 100644 index 0000000000..5b2bdd5105 --- /dev/null +++ b/azps-10.1.0/Az.KubernetesConfiguration/Remove-AzKubernetesExtension.md @@ -0,0 +1,281 @@ +--- +external help file: +Module Name: Az.KubernetesConfiguration +online version: https://learn.microsoft.com/powershell/module/az.kubernetesconfiguration/remove-azkubernetesextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Remove-AzKubernetesExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Remove-AzKubernetesExtension.md +--- + +# Remove-AzKubernetesExtension + +## SYNOPSIS +Delete a Kubernetes Cluster Extension. +This will cause the Agent to Uninstall the extension from the cluster. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzKubernetesExtension -ClusterName <String> -ClusterType <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-ForceDelete] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzKubernetesExtension -InputObject <IKubernetesConfigurationIdentity> [-ForceDelete] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a Kubernetes Cluster Extension. +This will cause the Agent to Uninstall the extension from the cluster. + +## EXAMPLES + +### Example 1: Delete a Kubernetes Cluster Extension. +```powershell +Remove-AzKubernetesExtension -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -Name azpstest-extension -ResourceGroupName azps_test_group +``` + +Delete a Kubernetes Cluster Extension. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the kubernetes cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +The Kubernetes cluster resource name - i.e. +managedClusters, connectedClusters, provisionedClusters. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDelete +Delete the extension resource in Azure - not the normal asynchronous delete. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Extension. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +Remove-AzK8sExtension + +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 <IKubernetesConfigurationIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the kubernetes cluster. + - `[ClusterResourceName <String>]`: The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters. + - `[ClusterRp <String>]`: The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. + - `[ExtensionName <String>]`: Name of the Extension. + - `[FluxConfigurationName <String>]`: Name of the Flux Configuration. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: operation Id + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SourceControlConfigurationName <String>]`: Name of the Source Control Configuration. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.KubernetesConfiguration/Update-AzKubernetesConfigurationFlux.md b/azps-10.1.0/Az.KubernetesConfiguration/Update-AzKubernetesConfigurationFlux.md new file mode 100644 index 0000000000..0bcb174159 --- /dev/null +++ b/azps-10.1.0/Az.KubernetesConfiguration/Update-AzKubernetesConfigurationFlux.md @@ -0,0 +1,838 @@ +--- +external help file: +Module Name: Az.KubernetesConfiguration +online version: https://learn.microsoft.com/powershell/module/az.kubernetesconfiguration/update-azkubernetesconfigurationflux +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Update-AzKubernetesConfigurationFlux.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Update-AzKubernetesConfigurationFlux.md +--- + +# Update-AzKubernetesConfigurationFlux + +## SYNOPSIS +Update an existing Kubernetes Flux Configuration. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzKubernetesConfigurationFlux -ClusterName <String> -ClusterType <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-AzureBlobAccountKey <String>] + [-AzureBlobContainerName <String>] [-AzureBlobLocalAuthRef <String>] [-AzureBlobSasToken <String>] + [-AzureBlobSyncIntervalInSecond <Int64>] [-AzureBlobTimeoutInSecond <Int64>] [-AzureBlobUrl <String>] + [-BucketAccessKey <SecureString>] [-BucketInsecure] [-BucketLocalAuthRef <String>] [-BucketName <String>] + [-BucketSyncIntervalInSecond <Int64>] [-BucketTimeoutInSecond <Int64>] [-BucketUrl <String>] + [-ConfigurationProtectedSetting <Hashtable>] [-GitRepositoryHttpsCaCert <String>] + [-GitRepositoryHttpsUser <String>] [-GitRepositoryLocalAuthRef <String>] + [-GitRepositorySshKnownHost <String>] [-GitRepositorySyncIntervalInSecond <Int64>] + [-GitRepositoryTimeoutInSecond <Int64>] [-GitRepositoryUrl <String>] [-Kustomization <Hashtable>] + [-ManagedIdentityClientId <String>] [-RepositoryRefBranch <String>] [-RepositoryRefCommit <String>] + [-RepositoryRefSemver <String>] [-RepositoryRefTag <String>] [-ServicePrincipalClientCertificate <String>] + [-ServicePrincipalClientCertificatePassword <String>] [-ServicePrincipalClientCertificateSendChain] + [-ServicePrincipalClientId <String>] [-ServicePrincipalClientSecret <String>] + [-ServicePrincipalTenantId <String>] [-SourceKind <SourceKindType>] [-Suspend] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzKubernetesConfigurationFlux -InputObject <IKubernetesConfigurationIdentity> + [-AzureBlobAccountKey <String>] [-AzureBlobContainerName <String>] [-AzureBlobLocalAuthRef <String>] + [-AzureBlobSasToken <String>] [-AzureBlobSyncIntervalInSecond <Int64>] [-AzureBlobTimeoutInSecond <Int64>] + [-AzureBlobUrl <String>] [-BucketAccessKey <SecureString>] [-BucketInsecure] [-BucketLocalAuthRef <String>] + [-BucketName <String>] [-BucketSyncIntervalInSecond <Int64>] [-BucketTimeoutInSecond <Int64>] + [-BucketUrl <String>] [-ConfigurationProtectedSetting <Hashtable>] [-GitRepositoryHttpsCaCert <String>] + [-GitRepositoryHttpsUser <String>] [-GitRepositoryLocalAuthRef <String>] + [-GitRepositorySshKnownHost <String>] [-GitRepositorySyncIntervalInSecond <Int64>] + [-GitRepositoryTimeoutInSecond <Int64>] [-GitRepositoryUrl <String>] [-Kustomization <Hashtable>] + [-ManagedIdentityClientId <String>] [-RepositoryRefBranch <String>] [-RepositoryRefCommit <String>] + [-RepositoryRefSemver <String>] [-RepositoryRefTag <String>] [-ServicePrincipalClientCertificate <String>] + [-ServicePrincipalClientCertificatePassword <String>] [-ServicePrincipalClientCertificateSendChain] + [-ServicePrincipalClientId <String>] [-ServicePrincipalClientSecret <String>] + [-ServicePrincipalTenantId <String>] [-SourceKind <SourceKindType>] [-Suspend] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update an existing Kubernetes Flux Configuration. + +## EXAMPLES + +### Example 1: Update an existing Kubernetes Flux Configuration. +```powershell +Update-AzKubernetesConfigurationFlux -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -Name azpstestflux-k8s -ResourceGroupName azps_test_group -GitRepositoryUrl https://github.com/fluxcd/flux2-kustomize-helm-example -RepositoryRefBranch main -SourceKind 'GitRepository' -GitRepositorySyncIntervalInSecond 600 -GitRepositoryTimeoutInSecond 600 -Suspend:$false +``` + +```output +Name ResourceGroupName +---- ----------------- +azpstestflux-k8s azps_test_group +``` + +Update an existing Kubernetes Flux Configuration. + +### Example 2: Update an existing Kubernetes Flux Configuration. +```powershell +Get-AzKubernetesConfigurationFlux -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -Name azpstestflux-k8s -ResourceGroupName azps_test_group | Update-AzKubernetesConfigurationFlux -GitRepositoryUrl https://github.com/fluxcd/flux2-kustomize-helm-example -RepositoryRefBranch main -SourceKind 'GitRepository' -GitRepositorySyncIntervalInSecond 600 -GitRepositoryTimeoutInSecond 600 -Suspend:$false +``` + +```output +Name ResourceGroupName +---- ----------------- +azpstestflux-k8s azps_test_group +``` + +Update an existing Kubernetes Flux Configuration. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobAccountKey +The account key (shared key) to access the storage account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobContainerName +The Azure Blob container name to sync from the url endpoint for the flux configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobLocalAuthRef +Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobSasToken +The Shared Access token to access the storage container + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobSyncIntervalInSecond +The interval at which to re-reconcile the cluster Azure Blob source with the remote. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobTimeoutInSecond +The maximum time to attempt to reconcile the cluster Azure Blob source with the remote. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureBlobUrl +The URL to sync for the flux configuration Azure Blob storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketAccessKey +Plaintext access key used to securely access the S3 bucket + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketInsecure +Specify whether to use insecure communication when puling data from the S3 bucket. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketLocalAuthRef +Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketName +The bucket name to sync from the url endpoint for the flux configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketSyncIntervalInSecond +The interval at which to re-reconcile the cluster bucket source with the remote. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketTimeoutInSecond +The maximum time to attempt to reconcile the cluster bucket source with the remote. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BucketUrl +The URL to sync for the flux configuration S3 bucket. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the kubernetes cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +The Kubernetes cluster resource name - i.e. +managedClusters, connectedClusters, provisionedClusters. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationProtectedSetting +Key-value pairs of protected configuration settings for the configuration + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositoryHttpsCaCert +Base64-encoded HTTPS certificate authority contents used to access git private git repositories over HTTPS + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositoryHttpsUser +Plaintext HTTPS username used to access private git repositories over HTTPS + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositoryLocalAuthRef +Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositorySshKnownHost +Base64-encoded known_hosts value containing public SSH keys required to access private git repositories over SSH + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositorySyncIntervalInSecond +The interval at which to re-reconcile the cluster git repository source with the remote. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositoryTimeoutInSecond +The maximum time to attempt to reconcile the cluster git repository source with the remote. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositoryUrl +The URL to sync for the flux configuration git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kustomization +Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedIdentityClientId +The client Id for authenticating a Managed Identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Flux Configuration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: FluxConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryRefBranch +The git repository branch name to checkout. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryRefCommit +The commit SHA to checkout. +This value must be combined with the branch name to be valid. +This takes precedence over semver. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryRefSemver +The semver range used to match against git repository tags. +This takes precedence over tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryRefTag +The git repository tag name to checkout. +This takes precedence over branch. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalClientCertificate +Base64-encoded certificate used to authenticate a Service Principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalClientCertificatePassword +The password for the certificate used to authenticate a Service Principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalClientCertificateSendChain +Specifies whether to include x5c header in client claims when acquiring a token to enable subject name / issuer based authentication for the Client Certificate + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalClientId +The client Id for authenticating a Service Principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalClientSecret +The client secret for authenticating a Service Principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalTenantId +The tenant Id for authenticating a Service Principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceKind +Source Kind to pull the configuration data from. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Support.SourceKindType +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Suspend +Whether this configuration should suspend its reconciliation of its kustomizations and sources. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.Api20221101.IFluxConfiguration + +## NOTES + +ALIASES + +Update-AzK8sConfigurationFlux + +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 <IKubernetesConfigurationIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the kubernetes cluster. + - `[ClusterResourceName <String>]`: The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters. + - `[ClusterRp <String>]`: The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. + - `[ExtensionName <String>]`: Name of the Extension. + - `[FluxConfigurationName <String>]`: Name of the Flux Configuration. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: operation Id + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SourceControlConfigurationName <String>]`: Name of the Source Control Configuration. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.KubernetesConfiguration/Update-AzKubernetesExtension.md b/azps-10.1.0/Az.KubernetesConfiguration/Update-AzKubernetesExtension.md new file mode 100644 index 0000000000..d4e0781e75 --- /dev/null +++ b/azps-10.1.0/Az.KubernetesConfiguration/Update-AzKubernetesExtension.md @@ -0,0 +1,334 @@ +--- +external help file: +Module Name: Az.KubernetesConfiguration +online version: https://learn.microsoft.com/powershell/module/az.kubernetesconfiguration/update-azkubernetesextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Update-AzKubernetesExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/KubernetesConfiguration/help/Update-AzKubernetesExtension.md +--- + +# Update-AzKubernetesExtension + +## SYNOPSIS +Patch an existing Kubernetes Cluster Extension. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzKubernetesExtension -ClusterName <String> -ClusterType <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-AutoUpgradeMinorVersion] + [-ConfigurationProtectedSetting <Hashtable>] [-ConfigurationSetting <Hashtable>] [-ReleaseTrain <String>] + [-Version <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzKubernetesExtension -InputObject <IKubernetesConfigurationIdentity> [-AutoUpgradeMinorVersion] + [-ConfigurationProtectedSetting <Hashtable>] [-ConfigurationSetting <Hashtable>] [-ReleaseTrain <String>] + [-Version <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Patch an existing Kubernetes Cluster Extension. + +## EXAMPLES + +### Example 1: Update an existing Kubernetes Cluster Extension. +```powershell +Update-AzKubernetesExtension -ClusterName azpstest_cluster_arc -ClusterType ConnectedClusters -Name azpstest-extension -ResourceGroupName azps_test_group -ConfigurationProtectedSetting @{"aa"="bb"} +``` + +```output +Name ExtensionType Version ProvisioningState AutoUpgradeMinorVersion ReleaseTrain +---- ------------- ------- ----------------- ----------------------- ------------ +azpstest-extension azuremonitor-containers 2.9.2 Succeeded True Stable +``` + +Update an existing Kubernetes Cluster Extension. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoUpgradeMinorVersion +Flag to note if this extension participates in auto upgrade of minor version, or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the kubernetes cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +The Kubernetes cluster resource name - i.e. +managedClusters, connectedClusters, provisionedClusters. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationProtectedSetting +Configuration settings that are sensitive, as name-value pairs for configuring this extension. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationSetting +Configuration settings, as name-value pairs for configuring this extension. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Extension. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReleaseTrain +ReleaseTrain this extension participates in for auto-upgrade (e.g. +Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version of the extension for this extension, if it is 'pinned' to a specific version. +autoUpgradeMinorVersion must be 'false'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.Api20221101.IExtension + +## NOTES + +ALIASES + +Update-AzK8sExtension + +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 <IKubernetesConfigurationIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the kubernetes cluster. + - `[ClusterResourceName <String>]`: The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters. + - `[ClusterRp <String>]`: The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. + - `[ExtensionName <String>]`: Name of the Extension. + - `[FluxConfigurationName <String>]`: Name of the Flux Configuration. + - `[Id <String>]`: Resource identity path + - `[OperationId <String>]`: operation Id + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SourceControlConfigurationName <String>]`: Name of the Source Control Configuration. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Add-AzKustoClusterLanguageExtension.md b/azps-10.1.0/Az.Kusto/Add-AzKustoClusterLanguageExtension.md new file mode 100644 index 0000000000..81641bc217 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Add-AzKustoClusterLanguageExtension.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/add-azkustoclusterlanguageextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Add-AzKustoClusterLanguageExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Add-AzKustoClusterLanguageExtension.md +--- + +# Add-AzKustoClusterLanguageExtension + +## SYNOPSIS +Add a list of language extensions that can run within KQL queries. + +## SYNTAX + +### AddExpanded (Default) +``` +Add-AzKustoClusterLanguageExtension -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Value <ILanguageExtension[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### AddViaIdentityExpanded +``` +Add-AzKustoClusterLanguageExtension -InputObject <IKustoIdentity> [-Value <ILanguageExtension[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Add a list of language extensions that can run within KQL queries. + +## EXAMPLES + +### Example 1: Add a list of language extensions +```powershell +Add-AzKustoClusterLanguageExtension -ResourceGroupName testrg -ClusterName testnewkustocluster -Value (@{Name="R"}, @{Name="PYTHON"}) +``` + +The above command adds a list of language extensions that can run within KQL queries + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: AddViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The list of language extensions. +To construct, see NOTES section for VALUE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ILanguageExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`VALUE <ILanguageExtension[]>`: The list of language extensions. + - `[ImageName <LanguageExtensionImageName?>]`: The language extension image name. + - `[Name <LanguageExtensionName?>]`: The language extension name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Add-AzKustoDatabasePrincipal.md b/azps-10.1.0/Az.Kusto/Add-AzKustoDatabasePrincipal.md new file mode 100644 index 0000000000..e53e6df436 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Add-AzKustoDatabasePrincipal.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/add-azkustodatabaseprincipal +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Add-AzKustoDatabasePrincipal.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Add-AzKustoDatabasePrincipal.md +--- + +# Add-AzKustoDatabasePrincipal + +## SYNOPSIS +Add Database principals permissions. + +## SYNTAX + +### AddExpanded (Default) +``` +Add-AzKustoDatabasePrincipal -ClusterName <String> -DatabaseName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Value <IDatabasePrincipal[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### AddViaIdentityExpanded +``` +Add-AzKustoDatabasePrincipal -InputObject <IKustoIdentity> [-Value <IDatabasePrincipal[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Add Database principals permissions. + +## EXAMPLES + +### Example 1: Add Database principals permissions +```powershell +Add-AzKustoDatabasePrincipal -ResourceGroupName testrg -ClusterName testnewkustocluster -DatabaseName mykustodatabase -Value (@{Name="Some User"; Role="Admin"; Type="User"; Email="someuser@microsoft.com"}) +``` + +```output +AppId Email Fqn Name Role TenantName Type +----- ----- --- ---- ---- ---------- ---- + someuser@microsoft.com aaduser=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Some User Admin Microsoft User + otheruser@microsoft.com aaduser=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Other User Admin Microsoft User +``` + +The above command adds Database principals permissions + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: AddViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The list of Kusto database principals. +To construct, see NOTES section for VALUE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDatabasePrincipal[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDatabasePrincipal + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`VALUE <IDatabasePrincipal[]>`: The list of Kusto database principals. + - `Name <String>`: Database principal name. + - `Role <DatabasePrincipalRole>`: Database principal role. + - `Type <DatabasePrincipalType>`: Database principal type. + - `[AppId <String>]`: Application id - relevant only for application principal type. + - `[Email <String>]`: Database principal email if exists. + - `[Fqn <String>]`: Database principal fully qualified name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Az.Kusto.md b/azps-10.1.0/Az.Kusto/Az.Kusto.md new file mode 100644 index 0000000000..ce39e5f5b5 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Az.Kusto.md @@ -0,0 +1,189 @@ +--- +Module Name: Az.Kusto +Module Guid: 18c61846-f6f0-425e-ba4b-5cf903e2bdd8 +Download Help Link: https://learn.microsoft.com/powershell/module/az.kusto +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Az.Kusto.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Az.Kusto.md +--- + +# Az.Kusto Module +## Description +Microsoft Azure PowerShell: Kusto cmdlets + +## Az.Kusto Cmdlets +### [Add-AzKustoClusterLanguageExtension](Add-AzKustoClusterLanguageExtension.md) +Add a list of language extensions that can run within KQL queries. + +### [Add-AzKustoDatabasePrincipal](Add-AzKustoDatabasePrincipal.md) +Add Database principals permissions. + +### [Get-AzKustoAttachedDatabaseConfiguration](Get-AzKustoAttachedDatabaseConfiguration.md) +Returns an attached database configuration. + +### [Get-AzKustoCluster](Get-AzKustoCluster.md) +Gets a Kusto cluster. + +### [Get-AzKustoClusterFollowerDatabase](Get-AzKustoClusterFollowerDatabase.md) +Returns a list of databases that are owned by this cluster and were followed by another cluster. + +### [Get-AzKustoClusterLanguageExtension](Get-AzKustoClusterLanguageExtension.md) +Returns a list of language extensions that can run within KQL queries. + +### [Get-AzKustoClusterOutboundNetworkDependencyEndpoint](Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md) +Gets the network endpoints of all outbound dependencies of a Kusto cluster + +### [Get-AzKustoClusterPrincipalAssignment](Get-AzKustoClusterPrincipalAssignment.md) +Gets a Kusto cluster principalAssignment. + +### [Get-AzKustoClusterSku](Get-AzKustoClusterSku.md) +Lists eligible SKUs for Kusto resource provider. + +### [Get-AzKustoDatabase](Get-AzKustoDatabase.md) +Returns a database. + +### [Get-AzKustoDatabasePrincipal](Get-AzKustoDatabasePrincipal.md) +Returns a list of database principals of the given Kusto cluster and database. + +### [Get-AzKustoDatabasePrincipalAssignment](Get-AzKustoDatabasePrincipalAssignment.md) +Gets a Kusto cluster database principalAssignment. + +### [Get-AzKustoDataConnection](Get-AzKustoDataConnection.md) +Returns a data connection. + +### [Get-AzKustoManagedPrivateEndpoint](Get-AzKustoManagedPrivateEndpoint.md) +Gets a managed private endpoint. + +### [Get-AzKustoOperationsResult](Get-AzKustoOperationsResult.md) +Returns operation results. + +### [Get-AzKustoOperationsResultLocation](Get-AzKustoOperationsResultLocation.md) +Returns operation results. + +### [Get-AzKustoPrivateEndpointConnection](Get-AzKustoPrivateEndpointConnection.md) +Gets a private endpoint connection. + +### [Get-AzKustoPrivateLinkResource](Get-AzKustoPrivateLinkResource.md) +Gets a private link resource. + +### [Get-AzKustoScript](Get-AzKustoScript.md) +Gets a Kusto cluster database script. + +### [Get-AzKustoSku](Get-AzKustoSku.md) +Lists eligible region SKUs for Kusto resource provider by Azure region. + +### [Invoke-AzKustoDataConnectionValidation](Invoke-AzKustoDataConnectionValidation.md) +Checks that the data connection parameters are valid. + +### [Invoke-AzKustoDetachClusterFollowerDatabase](Invoke-AzKustoDetachClusterFollowerDatabase.md) +Detaches all followers of a database owned by this cluster. + +### [Invoke-AzKustoDiagnoseClusterVirtualNetwork](Invoke-AzKustoDiagnoseClusterVirtualNetwork.md) +Diagnoses network connectivity status for external resources on which the service is dependent on. + +### [New-AzKustoAttachedDatabaseConfiguration](New-AzKustoAttachedDatabaseConfiguration.md) +Creates or updates an attached database configuration. + +### [New-AzKustoCluster](New-AzKustoCluster.md) +Create or update a Kusto cluster. + +### [New-AzKustoClusterPrincipalAssignment](New-AzKustoClusterPrincipalAssignment.md) +Create a Kusto cluster principalAssignment. + +### [New-AzKustoDatabase](New-AzKustoDatabase.md) +Creates or updates a database. + +### [New-AzKustoDatabasePrincipalAssignment](New-AzKustoDatabasePrincipalAssignment.md) +Creates a Kusto cluster database principalAssignment. + +### [New-AzKustoDataConnection](New-AzKustoDataConnection.md) +Creates or updates a data connection. + +### [New-AzKustoManagedPrivateEndpoint](New-AzKustoManagedPrivateEndpoint.md) +Creates a managed private endpoint. + +### [New-AzKustoPrivateEndpointConnection](New-AzKustoPrivateEndpointConnection.md) +Approve or reject a private endpoint connection with a given name. + +### [New-AzKustoScript](New-AzKustoScript.md) +Creates a Kusto database script. + +### [Remove-AzKustoAttachedDatabaseConfiguration](Remove-AzKustoAttachedDatabaseConfiguration.md) +Deletes the attached database configuration with the given name. + +### [Remove-AzKustoCluster](Remove-AzKustoCluster.md) +Deletes a Kusto cluster. + +### [Remove-AzKustoClusterLanguageExtension](Remove-AzKustoClusterLanguageExtension.md) +Remove a list of language extensions that can run within KQL queries. + +### [Remove-AzKustoClusterPrincipalAssignment](Remove-AzKustoClusterPrincipalAssignment.md) +Deletes a Kusto cluster principalAssignment. + +### [Remove-AzKustoDatabase](Remove-AzKustoDatabase.md) +Deletes the database with the given name. + +### [Remove-AzKustoDatabasePrincipal](Remove-AzKustoDatabasePrincipal.md) +Remove Database principals permissions. + +### [Remove-AzKustoDatabasePrincipalAssignment](Remove-AzKustoDatabasePrincipalAssignment.md) +Deletes a Kusto principalAssignment. + +### [Remove-AzKustoDataConnection](Remove-AzKustoDataConnection.md) +Deletes the data connection with the given name. + +### [Remove-AzKustoManagedPrivateEndpoint](Remove-AzKustoManagedPrivateEndpoint.md) +Deletes a managed private endpoint. + +### [Remove-AzKustoPrivateEndpointConnection](Remove-AzKustoPrivateEndpointConnection.md) +Deletes a private endpoint connection with a given name. + +### [Remove-AzKustoScript](Remove-AzKustoScript.md) +Deletes a Kusto principalAssignment. + +### [Start-AzKustoCluster](Start-AzKustoCluster.md) +Starts a Kusto cluster. + +### [Stop-AzKustoCluster](Stop-AzKustoCluster.md) +Stops a Kusto cluster. + +### [Test-AzKustoAttachedDatabaseConfigurationNameAvailability](Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md) +Checks that the attached database configuration resource name is valid and is not already in use. + +### [Test-AzKustoClusterNameAvailability](Test-AzKustoClusterNameAvailability.md) +Checks that the cluster name is valid and is not already in use. + +### [Test-AzKustoClusterPrincipalAssignmentNameAvailability](Test-AzKustoClusterPrincipalAssignmentNameAvailability.md) +Checks that the principal assignment name is valid and is not already in use. + +### [Test-AzKustoDatabaseNameAvailability](Test-AzKustoDatabaseNameAvailability.md) +Checks that the databases resource name is valid and is not already in use. + +### [Test-AzKustoDatabasePrincipalAssignmentNameAvailability](Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md) +Checks that the database principal assignment is valid and is not already in use. + +### [Test-AzKustoDataConnectionNameAvailability](Test-AzKustoDataConnectionNameAvailability.md) +Checks that the data connection name is valid and is not already in use. + +### [Test-AzKustoManagedPrivateEndpointNameAvailability](Test-AzKustoManagedPrivateEndpointNameAvailability.md) +Checks that the managed private endpoints resource name is valid and is not already in use. + +### [Test-AzKustoScriptNameAvailability](Test-AzKustoScriptNameAvailability.md) +Checks that the script name is valid and is not already in use. + +### [Update-AzKustoCluster](Update-AzKustoCluster.md) +Update a Kusto cluster. + +### [Update-AzKustoDatabase](Update-AzKustoDatabase.md) +Updates a database. + +### [Update-AzKustoDataConnection](Update-AzKustoDataConnection.md) +Updates a data connection. + +### [Update-AzKustoManagedPrivateEndpoint](Update-AzKustoManagedPrivateEndpoint.md) +Updates a managed private endpoint. + +### [Update-AzKustoScript](Update-AzKustoScript.md) +Updates a database script. + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoAttachedDatabaseConfiguration.md b/azps-10.1.0/Az.Kusto/Get-AzKustoAttachedDatabaseConfiguration.md new file mode 100644 index 0000000000..26dd0f70d4 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoAttachedDatabaseConfiguration.md @@ -0,0 +1,198 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoattacheddatabaseconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoAttachedDatabaseConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoAttachedDatabaseConfiguration.md +--- + +# Get-AzKustoAttachedDatabaseConfiguration + +## SYNOPSIS +Returns an attached database configuration. + +## SYNTAX + +### List (Default) +``` +Get-AzKustoAttachedDatabaseConfiguration -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzKustoAttachedDatabaseConfiguration -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKustoAttachedDatabaseConfiguration -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns an attached database configuration. + +## EXAMPLES + +### Example 1: List all the AttachedDatabaseConfigurations in a cluster +```powershell +Get-AzKustoAttachedDatabaseConfiguration -ResourceGroupName "testrg" -ClusterName "testnewkustoclusterf" +``` + +```output +Name Type Location +---- ---- -------- +testnewkustoclusterf/myfollowerconfiguration Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations East US +``` + +The above command lists all the AttachedDatabaseConfigurations in the cluster "testnewkustoclusterf". + +### Example 2: Get a specific AttachedDatabaseConfiguration in a cluster +```powershell +Get-AzKustoAttachedDatabaseConfiguration -ResourceGroupName "testrg" -ClusterName "testnewkustoclusterf" -Name "myfollowerconfiguration" +``` + +```output +Name Type Location +---- ---- -------- +testnewkustoclusterf/myfollowerconfiguration Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations East US +``` + +The above command returns the AttachedDatabaseConfigurations named "myfollowerconfiguration" in the cluster "testnewkustoclusterf". + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the attached database configuration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AttachedDatabaseConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IAttachedDatabaseConfiguration + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoCluster.md b/azps-10.1.0/Az.Kusto/Get-AzKustoCluster.md new file mode 100644 index 0000000000..0144cccbce --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoCluster.md @@ -0,0 +1,188 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustocluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoCluster.md +--- + +# Get-AzKustoCluster + +## SYNOPSIS +Gets a Kusto cluster. + +## SYNTAX + +### List1 (Default) +``` +Get-AzKustoCluster [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzKustoCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKustoCluster -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzKustoCluster -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Kusto cluster. + +## EXAMPLES + +### Example 1: List all Kusto clusters in a resource group +```powershell +Get-AzKustoCluster -ResourceGroupName testrg +``` + +```output +Location Name Type Zone +-------- ---- ---- ---- +East US testnewkustocluster Microsoft.Kusto/Clusters +East US testnewkustocluster2 Microsoft.Kusto/Clusters +``` + +The above command lists all Kusto clusters in the resource group "testrg". + +### Example 2: Get a specific Kusto cluster by name +```powershell + Get-AzKustoCluster -ResourceGroupName testrg -Name testnewkustocluster +``` + +```output +Location Name Type Zone +-------- ---- ---- ---- +East US testnewkustocluster Microsoft.Kusto/Clusters +``` + +The above command returns the Kusto cluster named "testnewkustocluster" in the resource group "testrg". + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoClusterFollowerDatabase.md b/azps-10.1.0/Az.Kusto/Get-AzKustoClusterFollowerDatabase.md new file mode 100644 index 0000000000..14d19b505d --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoClusterFollowerDatabase.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoclusterfollowerdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoClusterFollowerDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoClusterFollowerDatabase.md +--- + +# Get-AzKustoClusterFollowerDatabase + +## SYNOPSIS +Returns a list of databases that are owned by this cluster and were followed by another cluster. + +## SYNTAX + +``` +Get-AzKustoClusterFollowerDatabase -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Returns a list of databases that are owned by this cluster and were followed by another cluster. + +## EXAMPLES + +### Example 1: List all followed databases +```powershell +Get-AzKustoClusterFollowerDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster +``` + +```output +AttachedDatabaseConfigurationName ClusterResourceId DatabaseName +--------------------------------- ----------------- ------------ +myfollowerconfiguration /subscriptions/xxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Kusto/Clusters/testnewkustoclusterf mykustodatabase +``` + +The above command lists all the databases that are owned by this cluster and were followed by another cluster. + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IFollowerDatabaseDefinition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoClusterLanguageExtension.md b/azps-10.1.0/Az.Kusto/Get-AzKustoClusterLanguageExtension.md new file mode 100644 index 0000000000..4517d2b12c --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoClusterLanguageExtension.md @@ -0,0 +1,150 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoclusterlanguageextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoClusterLanguageExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoClusterLanguageExtension.md +--- + +# Get-AzKustoClusterLanguageExtension + +## SYNOPSIS +Returns a list of language extensions that can run within KQL queries. + +## SYNTAX + +``` +Get-AzKustoClusterLanguageExtension -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Returns a list of language extensions that can run within KQL queries. + +## EXAMPLES + +### Example 1: List all language extensions set for a cluster +```powershell +Get-AzKustoClusterLanguageExtension -ResourceGroupName testrg -ClusterName testnewkustocluster +``` + +```output +Name +---- +R +PYTHON +``` + +The above command returns a list of language extensions that can run within KQL queries. + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ILanguageExtension + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md b/azps-10.1.0/Az.Kusto/Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md new file mode 100644 index 0000000000..9a529c9c45 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md @@ -0,0 +1,121 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoclusteroutboundnetworkdependencyendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md +--- + +# Get-AzKustoClusterOutboundNetworkDependencyEndpoint + +## SYNOPSIS +Gets the network endpoints of all outbound dependencies of a Kusto cluster + +## SYNTAX + +``` +Get-AzKustoClusterOutboundNetworkDependencyEndpoint -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the network endpoints of all outbound dependencies of a Kusto cluster + +## EXAMPLES + +### Example 1: List all Kusto ManagedPrivateEndpoint in a cluster +```powershell +Get-AzKustoClusterOutboundNetworkDependencyEndpoint -ClusterName "mycluster" -ResourceGroupName "testrg" +``` + +```output +Name Type Etag +---- ---- ---- +mycluster/AzureActiveDirectory Microsoft.Kusto/Clusters/OutboundNetworkDependenciesEndpoints +mycluster/AzureMonitor Microsoft.Kusto/Clusters/OutboundNetworkDependenciesEndpoints +mycluster/CertificateAuthority Microsoft.Kusto/Clusters/OutboundNetworkDependenciesEndpoints +mycluster/AzureStorage Microsoft.Kusto/Clusters/OutboundNetworkDependenciesEndpoints +``` + +The above command returns all Kusto OutboundNetworkDependenciesEndpoints in the cluster "mycluster" found in the resource group "testrg". + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IOutboundNetworkDependenciesEndpoint + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoClusterPrincipalAssignment.md b/azps-10.1.0/Az.Kusto/Get-AzKustoClusterPrincipalAssignment.md new file mode 100644 index 0000000000..b3df218b13 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoClusterPrincipalAssignment.md @@ -0,0 +1,198 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoclusterprincipalassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoClusterPrincipalAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoClusterPrincipalAssignment.md +--- + +# Get-AzKustoClusterPrincipalAssignment + +## SYNOPSIS +Gets a Kusto cluster principalAssignment. + +## SYNTAX + +### List (Default) +``` +Get-AzKustoClusterPrincipalAssignment -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzKustoClusterPrincipalAssignment -ClusterName <String> -PrincipalAssignmentName <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKustoClusterPrincipalAssignment -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Kusto cluster principalAssignment. + +## EXAMPLES + +### Example 1: List all Kusto cluster principalAssignment +```powershell +Get-AzKustoClusterPrincipalAssignment -ResourceGroupName testrg -ClusterName testnewkustocluster +``` + +```output +Name Type +---- ---- +testnewkustocluster/kustoprincipal1 Microsoft.Kusto/Clusters/PrincipalAssignments +``` + +The above command lists all principalAssignment in the cluster "testnewkustocluster". + +### Example 2: Gets a Kusto cluster principalAssignment by name +```powershell +Get-AzKustoClusterPrincipalAssignment -ResourceGroupName testrg -ClusterName testnewkustocluster -PrincipalAssignmentName kustoprincipal1 +``` + +```output +Name Type +---- ---- +testnewkustocluster/kustoprincipal1 Microsoft.Kusto/Clusters/PrincipalAssignments +``` + +The above command returns the Kusto cluster principalAssignment named "kustoprincipal1" in the cluster "testnewkustocluster". + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IClusterPrincipalAssignment + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoClusterSku.md b/azps-10.1.0/Az.Kusto/Get-AzKustoClusterSku.md new file mode 100644 index 0000000000..bf97cfccf5 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoClusterSku.md @@ -0,0 +1,176 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoclustersku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoClusterSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoClusterSku.md +--- + +# Get-AzKustoClusterSku + +## SYNOPSIS +Lists eligible SKUs for Kusto resource provider. + +## SYNTAX + +### List (Default) +``` +Get-AzKustoClusterSku [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzKustoClusterSku -ClusterName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists eligible SKUs for Kusto resource provider. + +## EXAMPLES + +### Example 1: Lists eligible SKUs +```powershell +Get-AzKustoClusterSku +``` + +```output +Location Name ResourceType Tier +-------- ---- ------------ ---- +{eastus2} D13_v2 clusters Standard +{eastus2} D14_v2 clusters Standard +{eastus2} L8 clusters Standard +{eastus2} L16 clusters Standard +{eastus2} D11_v2 clusters Standard +{eastus2} D12_v2 clusters Standard +{eastus2} L4 clusters Standard +{eastus2} Standard_D13_v2 clusters Standard +{eastus2} Standard_D14_v2 clusters Standard +{eastus2} Standard_L8s clusters Standard +{eastus2} Standard_L16s clusters Standard +{eastus2} Standard_D11_v2 clusters Standard +{eastus2} Standard_D12_v2 clusters Standard +{eastus2} Standard_L4s clusters Standard +{eastus2} Standard_DS13_v2+1TB_PS clusters Standard +{eastus2} Standard_DS13_v2+2TB_PS clusters Standard +{eastus2} Standard_DS14_v2+3TB_PS clusters Standard +{eastus2} Standard_DS14_v2+4TB_PS clusters Standard +{eastus2} Dev(No SLA)_Standard_D11_v2 clusters Basic +{westcentralus} D13_v2 clusters Standard +{westcentralus} D14_v2 clusters Standard +{westcentralus} D11_v2 clusters Standard +{westcentralus} D12_v2 clusters Standard +{westcentralus} Standard_D13_v2 clusters Standard +{westcentralus} Standard_D14_v2 clusters Standard +{westcentralus} Standard_D11_v2 clusters Standard +{westcentralus} Standard_D12_v2 clusters Standard +{westcentralus} Standard_DS13_v2+1TB_PS clusters Standard +{westcentralus} Standard_DS13_v2+2TB_PS clusters Standard +{westcentralus} Standard_DS14_v2+3TB_PS clusters Standard +{westcentralus} Standard_DS14_v2+4TB_PS clusters Standard +... +``` + +The above command lists eligible SKUs. + +### Example 2: Lists eligible SKUs for specific cluster +```powershell + Get-AzKustoClusterSku -ResourceGroupName testrg -ClusterName testnewkustocluster +``` + +```output +ResourceType +------------ +Microsoft.Kusto/clusters +Microsoft.Kusto/clusters +Microsoft.Kusto/clusters +Microsoft.Kusto/clusters +Microsoft.Kusto/clusters +Microsoft.Kusto/clusters +... +``` + +The above command lists eligible SKUs for specific cluster + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IAzureResourceSku + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ISkuDescription + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoDataConnection.md b/azps-10.1.0/Az.Kusto/Get-AzKustoDataConnection.md new file mode 100644 index 0000000000..062187bee3 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoDataConnection.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustodataconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoDataConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoDataConnection.md +--- + +# Get-AzKustoDataConnection + +## SYNOPSIS +Returns a data connection. + +## SYNTAX + +### List (Default) +``` +Get-AzKustoDataConnection -ClusterName <String> -DatabaseName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzKustoDataConnection -ClusterName <String> -DatabaseName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKustoDataConnection -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns a data connection. + +## EXAMPLES + +### Example 1: List all data connections in a specific database +```powershell +Get-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +EventHub East US testnewkustocluster/mykustodatabase/mykustodataconnection Microsoft.Kusto/Clusters/Databases/DataConnections +``` + +The above command returns all Kusto databases in the cluster "testnewkustocluster" found in the resource group "testrg". + +### Example 2: Get a specific data connection by name +```powershell +Get-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "mykustodataconnection" +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +EventHub East US testnewkustocluster/mykustodatabase/mykustodataconnection Microsoft.Kusto/Clusters/Databases/DataConnections +``` + +The above command returns the data connection named "mykustodataconnection" in database "mykustodatabase" of the existing cluster "testnewkustocluster" found in the resource group "testrg". + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the data connection. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DataConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDataConnection + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoDatabase.md b/azps-10.1.0/Az.Kusto/Get-AzKustoDatabase.md new file mode 100644 index 0000000000..a06fb0cf94 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoDatabase.md @@ -0,0 +1,198 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustodatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoDatabase.md +--- + +# Get-AzKustoDatabase + +## SYNOPSIS +Returns a database. + +## SYNTAX + +### List (Default) +``` +Get-AzKustoDatabase -ClusterName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzKustoDatabase -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKustoDatabase -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns a database. + +## EXAMPLES + +### Example 1: List all Kusto databases in a cluster by name +```powershell +Get-AzKustoDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +ReadWrite East US testnewkustocluster/mykustodatabase Microsoft.Kusto/Clusters/Databases +ReadWrite East US testnewkustocluster/mykustodatabase2 Microsoft.Kusto/Clusters/Databases +``` + +The above command returns all Kusto databases in the cluster "testnewkustocluster" found in the resource group "testrg". + +### Example 2: Get a specific Kusto database by name +```powershell +Get-AzKustoDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster -Name mykustodatabase +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +ReadWrite East US testnewkustocluster/mykustodatabase Microsoft.Kusto/Clusters/Databases +``` + +The above command returns the Kusto database named "mykustodatabase" in the cluster "testnewkustocluster" found in the resource group "testrg". + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DatabaseName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDatabase + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoDatabasePrincipal.md b/azps-10.1.0/Az.Kusto/Get-AzKustoDatabasePrincipal.md new file mode 100644 index 0000000000..52d48e8c54 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoDatabasePrincipal.md @@ -0,0 +1,165 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustodatabaseprincipal +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoDatabasePrincipal.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoDatabasePrincipal.md +--- + +# Get-AzKustoDatabasePrincipal + +## SYNOPSIS +Returns a list of database principals of the given Kusto cluster and database. + +## SYNTAX + +``` +Get-AzKustoDatabasePrincipal -ClusterName <String> -DatabaseName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Returns a list of database principals of the given Kusto cluster and database. + +## EXAMPLES + +### Example 1: List of database principals of the given Kusto cluster and database +```powershell +Get-AzKustoDatabasePrincipal -ResourceGroupName testrg -ClusterName testnewkustocluster -DatabaseName mykustodatabase +``` + +```output +AppId Email Fqn Name Role TenantName Type +----- ----- --- ---- ---- ---------- ---- + someuser@microsoft.com aaduser=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Some User Admin Microsoft User + otheruser@microsoft.com aaduser=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Other User Admin Microsoft User +``` + +The above command returns a list of database principals of the given Kusto cluster and database + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDatabasePrincipal + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoDatabasePrincipalAssignment.md b/azps-10.1.0/Az.Kusto/Get-AzKustoDatabasePrincipalAssignment.md new file mode 100644 index 0000000000..d3bd07960c --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoDatabasePrincipalAssignment.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustodatabaseprincipalassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoDatabasePrincipalAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoDatabasePrincipalAssignment.md +--- + +# Get-AzKustoDatabasePrincipalAssignment + +## SYNOPSIS +Gets a Kusto cluster database principalAssignment. + +## SYNTAX + +### List (Default) +``` +Get-AzKustoDatabasePrincipalAssignment -ClusterName <String> -DatabaseName <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzKustoDatabasePrincipalAssignment -ClusterName <String> -DatabaseName <String> + -PrincipalAssignmentName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKustoDatabasePrincipalAssignment -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Kusto cluster database principalAssignment. + +## EXAMPLES + +### Example 1: List all PrincipalAssignment in a database by name +```powershell +Get-AzKustoDatabasePrincipalAssignment -ResourceGroupName testrg -ClusterName testnewkustocluster -DatabaseName mykustodatabase +``` + +```output +Name Type +---- ---- +testnewkustocluster/mykustodatabase/kustoprincipal1 Microsoft.Kusto/Clusters/Databases/PrincipalAssignments +testnewkustocluster/mykustodatabase/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft.Kusto/Clusters/Databases/PrincipalAssignments +testnewkustocluster/mykustodatabase/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft.Kusto/Clusters/Databases/PrincipalAssignments +``` + +The above command returns all all PrincipalAssignment in the database "mykustodatabase" found in the cluster "testnewkustocluster". + +### Example 2: Get a specific PrincipalAssignment in a database by name +```powershell +Get-AzKustoDatabasePrincipalAssignment -ResourceGroupName testrg -ClusterName testnewkustocluster -DatabaseName mykustodatabase -PrincipalAssignmentName kustoprincipal1 +``` + +```output +Name Type +---- ---- +testnewkustocluster/mykustodatabase/kustoprincipal1 Microsoft.Kusto/Clusters/Databases/PrincipalAssignments +``` + +The above command returns all all PrincipalAssignment named "kustoprincipal1" in the database "mykustodatabase" found in the cluster "testnewkustocluster". + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDatabasePrincipalAssignment + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoManagedPrivateEndpoint.md b/azps-10.1.0/Az.Kusto/Get-AzKustoManagedPrivateEndpoint.md new file mode 100644 index 0000000000..787264dcf0 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoManagedPrivateEndpoint.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustomanagedprivateendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoManagedPrivateEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoManagedPrivateEndpoint.md +--- + +# Get-AzKustoManagedPrivateEndpoint + +## SYNOPSIS +Gets a managed private endpoint. + +## SYNTAX + +### List (Default) +``` +Get-AzKustoManagedPrivateEndpoint -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzKustoManagedPrivateEndpoint -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKustoManagedPrivateEndpoint -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a managed private endpoint. + +## EXAMPLES + +### Example 1: List all Kusto ManagedPrivateEndpoint in a cluster +```powershell +Get-AzKustoManagedPrivateEndpoint -ClusterName "mycluster" -ResourceGroupName "testrg" +``` + +```output +Name Type +---- ---- +ManagedPrivateEndpointName1 Microsoft.Kusto/Clusters/ManagedPrivateEndpoints +ManagedPrivateEndpointName2 Microsoft.Kusto/Clusters/ManagedPrivateEndpoints +``` + +The above command returns all Kusto ManagedPrivateEndpoint in the cluster "mycluster" found in the resource group "testrg". + +### Example 2: Get a specific Kusto ManagedPrivateEndpoint by name +```powershell +Get-AzKustoManagedPrivateEndpoint -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "12345678-1234-1234-1234-123456789098" -Name "ManagedPrivateEndpointName" +``` + +```output +Name Type +---- ---- +ManagedPrivateEndpointName Microsoft.Kusto/Clusters/ManagedPrivateEndpoints +``` + +The above command returns the Kusto ManagedPrivateEndpoint named "ManagedPrivateEndpointName" in the cluster "mycluster" found in the resource group "testrg". + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the managed private endpoint. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ManagedPrivateEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IManagedPrivateEndpoint + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoOperationsResult.md b/azps-10.1.0/Az.Kusto/Get-AzKustoOperationsResult.md new file mode 100644 index 0000000000..a8d675a322 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoOperationsResult.md @@ -0,0 +1,163 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustooperationsresult +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoOperationsResult.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoOperationsResult.md +--- + +# Get-AzKustoOperationsResult + +## SYNOPSIS +Returns operation results. + +## SYNTAX + +### Get (Default) +``` +Get-AzKustoOperationsResult -Location <String> -OperationId <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKustoOperationsResult -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns operation results. + +## EXAMPLES + +### Example 1: +```powershell +Get-AzKustoOperationsResult -Location eastus -OperationId 5c1495e5-f1c4-4c5e-ac95-01a1c7a33353 +``` + +```output +EndTime Name PercentComplete StartTime Status +------- ---- --------------- --------- ------ +29/03/2022 10:02:20 5c1495e5-f1c4-4c5e-ac95-01a1c7a33353 1 29/03/2022 10:01:46 Completed +``` + +Get operation result with kusto. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Azure location (region) name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationId +The Guid of the operation ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IOperationResult + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoOperationsResultLocation.md b/azps-10.1.0/Az.Kusto/Get-AzKustoOperationsResultLocation.md new file mode 100644 index 0000000000..c9be1a9a28 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoOperationsResultLocation.md @@ -0,0 +1,179 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustooperationsresultlocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoOperationsResultLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoOperationsResultLocation.md +--- + +# Get-AzKustoOperationsResultLocation + +## SYNOPSIS +Returns operation results. + +## SYNTAX + +### Get (Default) +``` +Get-AzKustoOperationsResultLocation -Location <String> -OperationId <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKustoOperationsResultLocation -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns operation results. + +## EXAMPLES + +### Example 1: +```powershell +Get-AzKustoOperationsResultLocation -Location eastus -OperationId 5c1495e5-f1c4-4c5e-ac95-01a1c7a33353 +``` + +```output +EndTime Name PercentComplete StartTime Status +------- ---- --------------- --------- ------ +29/03/2022 10:02:20 5c1495e5-f1c4-4c5e-ac95-01a1c7a33353 1 29/03/2022 10:01:46 Completed +``` + +Get operation result with kusto. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Azure location (region) name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationId +The Guid of the operation ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoPrivateEndpointConnection.md b/azps-10.1.0/Az.Kusto/Get-AzKustoPrivateEndpointConnection.md new file mode 100644 index 0000000000..db92fff460 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoPrivateEndpointConnection.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoPrivateEndpointConnection.md +--- + +# Get-AzKustoPrivateEndpointConnection + +## SYNOPSIS +Gets a private endpoint connection. + +## SYNTAX + +### List (Default) +``` +Get-AzKustoPrivateEndpointConnection -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzKustoPrivateEndpointConnection -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKustoPrivateEndpointConnection -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a private endpoint connection. + +## EXAMPLES + +### Example 1: List all Kusto PrivateEndpointConnection in a cluster by name +```powershell +Get-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "12345678-1234-1234-1234-123456789098" +``` + +```output +Name Type +---- ---- +privateEndpointConnectionName1 Microsoft.Kusto/Clusters/PrivateEndpointConnections +privateEndpointConnectionName2 Microsoft.Kusto/Clusters/PrivateEndpointConnections +``` + +The above command returns all Kusto PrivateEndpointConnection in the cluster "mycluster" found in the resource group "testrg". + +### Example 2: Get a specific Kusto PrivateEndpointConnection by name +```powershell +Get-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "12345678-1234-1234-1234-123456789098" -Name "privateEndpointConnectionName" +``` + +```output +Name Type +---- ---- +privateEndpointConnectionName Microsoft.Kusto/Clusters/PrivateEndpointConnections +``` + +The above command returns the Kusto PrivateEndpointConnection named "privateEndpointConnectionName" in the cluster "mycluster" found in the resource group "testrg". + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PrivateEndpointConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IPrivateEndpointConnection + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoPrivateLinkResource.md b/azps-10.1.0/Az.Kusto/Get-AzKustoPrivateLinkResource.md new file mode 100644 index 0000000000..f060a66634 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoPrivateLinkResource.md @@ -0,0 +1,197 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoprivatelinkresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoPrivateLinkResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoPrivateLinkResource.md +--- + +# Get-AzKustoPrivateLinkResource + +## SYNOPSIS +Gets a private link resource. + +## SYNTAX + +### List (Default) +``` +Get-AzKustoPrivateLinkResource -ClusterName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzKustoPrivateLinkResource -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKustoPrivateLinkResource -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a private link resource. + +## EXAMPLES + +### Example 1: List all PrivateLinkResource in a cluster +```powershell +Get-AzKustoPrivateLinkResource -ClusterName "mycluster" -ResourceGroupName "testrg" +``` + +```output +Name Type +---- ---- +mycluster/cluster Microsoft.Kusto/Clusters/PrivateLinkResources +``` + +The above command returns all PrivateLinkResource in the cluster "mycluster" found in the resource group "testrg". + +### Example 2: Get a specific PrivateLinkResource by name +```powershell +Get-AzKustoPrivateLinkResource -ClusterName "mycluster" -ResourceGroupName "testrg" -Name "ManagedPrivateEndpointName" +``` + +```output +Name Type +---- ---- +mycluster/cluster Microsoft.Kusto/Clusters/PrivateLinkResources +``` + +The above command returns the PrivateLinkResource named "mycluster/cluster" in the cluster "mycluster" found in the resource group "testrg". + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the private link resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PrivateLinkResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IPrivateLinkResource + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoScript.md b/azps-10.1.0/Az.Kusto/Get-AzKustoScript.md new file mode 100644 index 0000000000..9eb5f9f6d1 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoScript.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoScript.md +--- + +# Get-AzKustoScript + +## SYNOPSIS +Gets a Kusto cluster database script. + +## SYNTAX + +### List (Default) +``` +Get-AzKustoScript -ClusterName <String> -DatabaseName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzKustoScript -ClusterName <String> -DatabaseName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzKustoScript -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Kusto cluster database script. + +## EXAMPLES + +### Example 1: List all Kusto cluster database scripts +```powershell +Get-AzKustoScript -ClusterName testnewkustocluster -ResourceGroupName testrg -DatabaseName mykustodatabase +``` + +```output +Name Type +---- ---- +testnewkustocluster/mykustodatabase/newkustoscript Microsoft.Kusto/Clusters/Databases/Scripts +``` + +The above command returns all Kusto cluster database scripts in the cluster "testnewkustocluster" found in the resource group "testrg". + +### Example 2: Get a specific Kusto database script by name +```powershell +Get-AzKustoScript -ClusterName testnewkustocluster -ResourceGroupName testrg -DatabaseName mykustodatabase -Name newkustoscript +``` + +```output +Name Type +---- ---- +testnewkustocluster/mykustodatabase/newkustoscript Microsoft.Kusto/Clusters/Databases/Scripts +``` + +The above command returns the Kusto database script named "newkustoscript" in the cluster "testnewkustocluster" found in the resource group "testrg". + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto database script. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ScriptName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IScript + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Get-AzKustoSku.md b/azps-10.1.0/Az.Kusto/Get-AzKustoSku.md new file mode 100644 index 0000000000..dde880413d --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Get-AzKustoSku.md @@ -0,0 +1,145 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustosku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Get-AzKustoSku.md +--- + +# Get-AzKustoSku + +## SYNOPSIS +Lists eligible region SKUs for Kusto resource provider by Azure region. + +## SYNTAX + +``` +Get-AzKustoSku -Location <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Lists eligible region SKUs for Kusto resource provider by Azure region. + +## EXAMPLES + +### Example 1: Lists eligible SKUs for Kusto resource provider by Azure region +```powershell +Get-AzKustoSku -SubscriptionId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Location "East US" +``` + +```output +Location Name ResourceType Tier +-------- ---- ------------ ---- + Dev(No SLA)_Standard_D11_v2 clusters Basic + Dev(No SLA)_Standard_E2a_v4 clusters Basic + Standard_D11_v2 clusters Standard + Standard_D12_v2 clusters Standard + Standard_D13_v2 clusters Standard + Standard_D14_v2 clusters Standard + Standard_D32d_v4 clusters Standard + Standard_DS13_v2+1TB_PS clusters Standard + Standard_DS13_v2+2TB_PS clusters Standard + Standard_DS14_v2+3TB_PS clusters Standard + Standard_DS14_v2+4TB_PS clusters Standard + Standard_L8s_v2 clusters Standard + Standard_L16s_v2 clusters Standard + Standard_E64i_v3 clusters Standard + Standard_E80ids_v4 clusters Standard + Standard_E2a_v4 clusters Standard + Standard_E4a_v4 clusters Standard + Standard_E8a_v4 clusters Standard + Standard_E16a_v4 clusters Standard + Standard_E8as_v4+1TB_PS clusters Standard + Standard_E8as_v4+2TB_PS clusters Standard + Standard_E16as_v4+3TB_PS clusters Standard + Standard_E16as_v4+4TB_PS clusters Standard + Standard_E8as_v5+1TB_PS clusters Standard + Standard_E8as_v5+2TB_PS clusters Standard + Standard_E16as_v5+3TB_PS clusters Standard + Standard_E16as_v5+4TB_PS clusters Standard + Standard_E2ads_v5 clusters Standard + Standard_E4ads_v5 clusters Standard + Standard_E8ads_v5 clusters Standard + Standard_E16ads_v5 clusters Standard + Standard_E8s_v4+1TB_PS clusters Standard + Standard_E8s_v4+2TB_PS clusters Standard + Standard_E16s_v4+3TB_PS clusters Standard + Standard_E16s_v4+4TB_PS clusters Standard + Standard_E2d_v4 clusters Standard + Standard_E4d_v4 clusters Standard + Standard_E8d_v4 clusters Standard + Standard_E16d_v4 clusters Standard + Standard_E2d_v5 clusters Standard + Standard_E4d_v5 clusters Standard + Standard_E8d_v5 clusters Standard + Standard_E16d_v5 clusters Standard +``` + +Lists eligible SKUs for Kusto resource provider by Azure region + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Azure location (region) name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ISkuDescription + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Invoke-AzKustoDataConnectionValidation.md b/azps-10.1.0/Az.Kusto/Invoke-AzKustoDataConnectionValidation.md new file mode 100644 index 0000000000..4c970f1f81 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Invoke-AzKustoDataConnectionValidation.md @@ -0,0 +1,628 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/invoke-azkustodataconnectionvalidation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Invoke-AzKustoDataConnectionValidation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Invoke-AzKustoDataConnectionValidation.md +--- + +# Invoke-AzKustoDataConnectionValidation + +## SYNOPSIS +Checks that the data connection parameters are valid. + +## SYNTAX + +### DataExpandedEventHub (Default) +``` +Invoke-AzKustoDataConnectionValidation -ClusterName <String> -DatabaseName <String> + -ResourceGroupName <String> -ConsumerGroup <String> -DataConnectionName <String> -EventHubResourceId <String> + -Kind <Kind> -Location <String> [-SubscriptionId <String>] [-Compression <Compression>] + [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] [-EventSystemProperty <String[]>] + [-ManagedIdentityResourceId <String>] [-MappingRuleName <String>] [-RetrievalStartDate <DateTime>] + [-TableName <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DataExpandedEventGrid +``` +Invoke-AzKustoDataConnectionValidation -ClusterName <String> -DatabaseName <String> + -ResourceGroupName <String> -ConsumerGroup <String> -DataConnectionName <String> -EventHubResourceId <String> + -Kind <Kind> -Location <String> -StorageAccountResourceId <String> [-SubscriptionId <String>] + [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] [-EventGridResourceId <String>] + [-ManagedIdentityResourceId <String>] [-MappingRuleName <String>] [-TableName <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DataExpandedIotHub +``` +Invoke-AzKustoDataConnectionValidation -ClusterName <String> -DatabaseName <String> + -ResourceGroupName <String> -ConsumerGroup <String> -DataConnectionName <String> -IotHubResourceId <String> + -Kind <Kind> -Location <String> -SharedAccessPolicyName <String> [-SubscriptionId <String>] + [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] [-EventSystemProperty <String[]>] + [-MappingRuleName <String>] [-RetrievalStartDate <DateTime>] [-TableName <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DataViaIdentityExpandedEventGrid +``` +Invoke-AzKustoDataConnectionValidation -InputObject <IKustoIdentity> -ConsumerGroup <String> + -DataConnectionName <String> -EventHubResourceId <String> -Kind <Kind> -Location <String> + -StorageAccountResourceId <String> [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] + [-EventGridResourceId <String>] [-ManagedIdentityResourceId <String>] [-MappingRuleName <String>] + [-TableName <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DataViaIdentityExpandedEventHub +``` +Invoke-AzKustoDataConnectionValidation -InputObject <IKustoIdentity> -ConsumerGroup <String> + -DataConnectionName <String> -EventHubResourceId <String> -Kind <Kind> -Location <String> + [-Compression <Compression>] [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] + [-EventSystemProperty <String[]>] [-ManagedIdentityResourceId <String>] [-MappingRuleName <String>] + [-RetrievalStartDate <DateTime>] [-TableName <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DataViaIdentityExpandedIotHub +``` +Invoke-AzKustoDataConnectionValidation -InputObject <IKustoIdentity> -ConsumerGroup <String> + -DataConnectionName <String> -IotHubResourceId <String> -Kind <Kind> -Location <String> + -SharedAccessPolicyName <String> [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] + [-EventSystemProperty <String[]>] [-MappingRuleName <String>] [-RetrievalStartDate <DateTime>] + [-TableName <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateExpandedEventGrid +``` +Invoke-AzKustoDataConnectionValidation -ConsumerGroup <String> -DataConnectionName <String> -Kind <Kind> + -Location <String> [-BlobStorageEventType <BlobStorageEventType>] [-DataFormat <String>] [-IgnoreFirstRecord] + [-MappingRuleName <String>] [-TableName <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpandedEventGrid +``` +Invoke-AzKustoDataConnectionValidation -ConsumerGroup <String> -DataConnectionName <String> -Kind <Kind> + -Location <String> [-BlobStorageEventType <BlobStorageEventType>] [-DataFormat <String>] [-IgnoreFirstRecord] + [-MappingRuleName <String>] [-TableName <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Checks that the data connection parameters are valid. + +## EXAMPLES + +### Example 1: Validate EventHub data connection parameters +```powershell +Invoke-AzKustoDataConnectionValidation -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventhubdc" -Location "East US" -Kind "EventHub" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -DataFormat "JSON" -ConsumerGroup 'Default' -Compression "None" -TableName "Events" -MappingRuleName "NewEventsMapping" +``` + +```output +ErrorMessage +------------ +event hub resource id and consumer group tuple provided are already used +``` + +The above command validates EventHub data connection named "myeventhubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +### Example 2: Validate EventGrid data connection parameters +```powershell +Invoke-AzKustoDataConnectionValidation -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventgriddc" -Location "East US" -Kind "EventGrid" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -StorageAccountResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Storage/storageAccounts/mystorage" -DataFormat "JSON" -ConsumerGroup 'Default' -TableName "Events" -MappingRuleName "NewEventsMapping" +``` + +```output +ErrorMessage +------------ +event hub resource id and consumer group tuple provided are already used +``` + +The above command validates EventGrid data connection named "myeventgriddc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +### Example 3: Validate IotHub data connection parameters +```powershell +Invoke-AzKustoDataConnectionValidation -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myiothubdc" -Location "East US" -Kind "IotHub" -IotHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Devices/IotHubs/myiothub" -SharedAccessPolicyName "myiothubpolicy" -DataFormat "JSON" -ConsumerGroup 'Default' -TableName "Events" -MappingRuleName "NewEventsMapping" +``` + +```output +ErrorMessage +------------ +event hub resource id and consumer group tuple provided are already used +``` + +The above command validates IotHub data connection named "myiothubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +### Example 4: Validate EventHub data connection parameters via identity +```powershell +$database = Get-AzKustoDatabase -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" +Invoke-AzKustoDataConnectionValidation -InputObject $database -DataConnectionName "myeventhubdc" -Location "East US" -Kind "EventHub" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -DataFormat "JSON" -ConsumerGroup 'Default' -Compression "None" -TableName "Events" -MappingRuleName "NewEventsMapping" +``` + +```output +ErrorMessage +------------ +event hub resource id and consumer group tuple provided are already used +``` + +The above command validates EventHub data connection named "myeventhubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +### Example 5: Validate EventGrid data connection parameters via identity +```powershell +$database = Get-AzKustoDatabase -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" +Invoke-AzKustoDataConnectionValidation -InputObject $database -DataConnectionName "myeventgriddc" -Location "East US" -Kind "EventGrid" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -StorageAccountResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Storage/storageAccounts/mystorage" -DataFormat "JSON" -ConsumerGroup 'Default' -TableName "Events" -MappingRuleName "NewEventsMapping" +``` + +```output +ErrorMessage +------------ +event hub resource id and consumer group tuple provided are already used +``` + +The above command validates EventGrid data connection named "myeventgriddc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +### Example 6: Validate IotHub data connection parameters via identity +```powershell +$database = Get-AzKustoDatabase -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" +Invoke-AzKustoDataConnectionValidation -InputObject $database -DataConnectionName "myiothubdc" -Location "East US" -Kind "IotHub" -IotHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Devices/IotHubs/myiothub" -SharedAccessPolicyName "myiothubpolicy" -DataFormat "JSON" -ConsumerGroup 'Default' -TableName "Events" -MappingRuleName "NewEventsMapping" +``` + +```output +ErrorMessage +------------ +event hub resource id and consumer group tuple provided are already used +``` + +The above command validates IotHub data connection named "myiothubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +## PARAMETERS + +### -BlobStorageEventType +The name of blob storage event type to process. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.BlobStorageEventType +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: DataExpandedEventGrid, DataExpandedEventHub, DataExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compression +The event hub messages compression type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Compression +Parameter Sets: DataExpandedEventHub, DataViaIdentityExpandedEventHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsumerGroup +The event/iot hub consumer group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: DataExpandedEventGrid, DataExpandedEventHub, DataExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseRouting +Indication for database routing information from the data connection, by default only database routing information is allowed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabaseRouting +Parameter Sets: DataExpandedEventGrid, DataExpandedEventHub, DataExpandedIotHub, DataViaIdentityExpandedEventGrid, DataViaIdentityExpandedEventHub, DataViaIdentityExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataConnectionName +The name of the data connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFormat +The data format of the message. +Optionally the data format can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventGridResourceId +The resource ID of the event grid that is subscribed to the storage account events. + +```yaml +Type: System.String +Parameter Sets: DataExpandedEventGrid, DataViaIdentityExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubResourceId +The resource ID of the event hub to be used to create a data connection / event grid is configured to send events. + +```yaml +Type: System.String +Parameter Sets: DataExpandedEventGrid, DataExpandedEventHub, DataViaIdentityExpandedEventGrid, DataViaIdentityExpandedEventHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSystemProperty +System properties of the event/iot hub. + +```yaml +Type: System.String[] +Parameter Sets: DataExpandedEventHub, DataExpandedIotHub, DataViaIdentityExpandedEventHub, DataViaIdentityExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreFirstRecord +If set to true, indicates that ingestion should ignore the first record of every file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +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.Kusto.Models.IKustoIdentity +Parameter Sets: DataViaIdentityExpandedEventGrid, DataViaIdentityExpandedEventHub, DataViaIdentityExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubResourceId +The resource ID of the Iot hub to be used to create a data connection. + +```yaml +Type: System.String +Parameter Sets: DataExpandedIotHub, DataViaIdentityExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the endpoint for the data connection + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedIdentityResourceId +The resource ID of a managed identity (system or user assigned) to be used to authenticate with external resources. + +```yaml +Type: System.String +Parameter Sets: DataExpandedEventGrid, DataExpandedEventHub, DataViaIdentityExpandedEventGrid, DataViaIdentityExpandedEventHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MappingRuleName +The mapping rule to be used to ingest the data. +Optionally the mapping information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: DataExpandedEventGrid, DataExpandedEventHub, DataExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetrievalStartDate +When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. +It can only retrieve events retained by the Event hub, based on its retention period. + +```yaml +Type: System.DateTime +Parameter Sets: DataExpandedEventHub, DataExpandedIotHub, DataViaIdentityExpandedEventHub, DataViaIdentityExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedAccessPolicyName +The name of the share access policy. + +```yaml +Type: System.String +Parameter Sets: DataExpandedIotHub, DataViaIdentityExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The resource ID of the storage account where the data resides. + +```yaml +Type: System.String +Parameter Sets: DataExpandedEventGrid, DataViaIdentityExpandedEventGrid +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: DataExpandedEventGrid, DataExpandedEventHub, DataExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableName +The table where the data should be ingested. +Optionally the table information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDataConnectionValidationResult + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Invoke-AzKustoDetachClusterFollowerDatabase.md b/azps-10.1.0/Az.Kusto/Invoke-AzKustoDetachClusterFollowerDatabase.md new file mode 100644 index 0000000000..b163ef324c --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Invoke-AzKustoDetachClusterFollowerDatabase.md @@ -0,0 +1,266 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/invoke-azkustodetachclusterfollowerdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Invoke-AzKustoDetachClusterFollowerDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Invoke-AzKustoDetachClusterFollowerDatabase.md +--- + +# Invoke-AzKustoDetachClusterFollowerDatabase + +## SYNOPSIS +Detaches all followers of a database owned by this cluster. + +## SYNTAX + +### DetachExpanded (Default) +``` +Invoke-AzKustoDetachClusterFollowerDatabase -ClusterName <String> -ResourceGroupName <String> + -AttachedDatabaseConfigurationName <String> -ClusterResourceId <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DetachViaIdentityExpanded +``` +Invoke-AzKustoDetachClusterFollowerDatabase -InputObject <IKustoIdentity> + -AttachedDatabaseConfigurationName <String> -ClusterResourceId <String> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Detaches all followers of a database owned by this cluster. + +## EXAMPLES + +### Example 1: Detach a follower database +```powershell +Invoke-AzKustoDetachClusterFollowerDatabase -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -AttachedDatabaseConfigurationName "myfollowerconfiguration" -ClusterResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Kusto/Clusters/testnewkustoclusterf" +``` + +The above command detaches the follower database defined in AttachedDatabaseConfiguration "myfollowerconfiguration" from cluster "testnewkustoclusterf". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachedDatabaseConfigurationName +Resource name of the attached database configuration in the follower cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: DetachExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterResourceId +Resource id of the cluster that follows a database owned by this cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DetachViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: DetachExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: DetachExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Invoke-AzKustoDiagnoseClusterVirtualNetwork.md b/azps-10.1.0/Az.Kusto/Invoke-AzKustoDiagnoseClusterVirtualNetwork.md new file mode 100644 index 0000000000..74ba1ce48a --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Invoke-AzKustoDiagnoseClusterVirtualNetwork.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/invoke-azkustodiagnoseclustervirtualnetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Invoke-AzKustoDiagnoseClusterVirtualNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Invoke-AzKustoDiagnoseClusterVirtualNetwork.md +--- + +# Invoke-AzKustoDiagnoseClusterVirtualNetwork + +## SYNOPSIS +Diagnoses network connectivity status for external resources on which the service is dependent on. + +## SYNTAX + +### Diagnose (Default) +``` +Invoke-AzKustoDiagnoseClusterVirtualNetwork -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DiagnoseViaIdentity +``` +Invoke-AzKustoDiagnoseClusterVirtualNetwork -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Diagnoses network connectivity status for external resources on which the service is dependent on. + +## EXAMPLES + +### Example 1: Show network connectivity diagnosis for external resources +```powershell +Invoke-AzKustoDiagnoseClusterVirtualNetwork -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" +``` + +The above command diagnoses network connectivity status for external resources on which the cluster "testnewkustocluster" is dependent on + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Diagnose +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DiagnoseViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Diagnose +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Diagnose +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/New-AzKustoAttachedDatabaseConfiguration.md b/azps-10.1.0/Az.Kusto/New-AzKustoAttachedDatabaseConfiguration.md new file mode 100644 index 0000000000..7253725362 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/New-AzKustoAttachedDatabaseConfiguration.md @@ -0,0 +1,417 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/new-azkustoattacheddatabaseconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoAttachedDatabaseConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoAttachedDatabaseConfiguration.md +--- + +# New-AzKustoAttachedDatabaseConfiguration + +## SYNOPSIS +Creates or updates an attached database configuration. + +## SYNTAX + +``` +New-AzKustoAttachedDatabaseConfiguration -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-ClusterResourceId <String>] [-DatabaseName <String>] + [-DatabaseNameOverride <String>] [-DatabaseNamePrefix <String>] + [-DefaultPrincipalsModificationKind <DefaultPrincipalsModificationKind>] [-Location <String>] + [-TableLevelSharingPropertyExternalTablesToExclude <String[]>] + [-TableLevelSharingPropertyExternalTablesToInclude <String[]>] + [-TableLevelSharingPropertyFunctionsToExclude <String[]>] + [-TableLevelSharingPropertyFunctionsToInclude <String[]>] + [-TableLevelSharingPropertyMaterializedViewsToExclude <String[]>] + [-TableLevelSharingPropertyMaterializedViewsToInclude <String[]>] + [-TableLevelSharingPropertyTablesToExclude <String[]>] [-TableLevelSharingPropertyTablesToInclude <String[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an attached database configuration. + +## EXAMPLES + +### Example 1: Create a new AttachedDatabaseConfiguration +```powershell +New-AzKustoAttachedDatabaseConfiguration -ResourceGroupName "testrg" -ClusterName "testnewkustoclusterf" -Name "myfollowerconfiguration" -Location "East US" -ClusterResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Kusto/Clusters/testnewkustocluster" -DatabaseName "mykustodatabase" -DefaultPrincipalsModificationKind "Union" +``` + +```output +Name Type Location +---- ---- -------- +testnewkustoclusterf/myfollowerconfiguration Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations East US +``` + +The above command creates a ReadOnly database "mykustodatabase" in cluster "testnewkustoclusterf". +It follows the database "mykustodatabase" from cluster "testnewkustocluster" + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterResourceId +The resource id of the cluster where the databases you would like to attach reside. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database which you would like to attach, use * if you want to follow all current and future databases. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseNameOverride +Overrides the original database name. +Relevant only when attaching to a specific database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseNamePrefix +Adds a prefix to the attached databases name. +When following an entire cluster, that prefix would be added to all of the databases original names from leader cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultPrincipalsModificationKind +The default principals modification kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DefaultPrincipalsModificationKind +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -Name +The name of the attached database configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AttachedDatabaseConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyExternalTablesToExclude +List of external tables to exclude from the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyExternalTablesToInclude +List of external tables to include in the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyFunctionsToExclude +List of functions to exclude from the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyFunctionsToInclude +List of functions to include in the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyMaterializedViewsToExclude +List of materialized views to exclude from the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyMaterializedViewsToInclude +List of materialized views to include in the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyTablesToExclude +List of tables to exclude from the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyTablesToInclude +List of tables to include in the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IAttachedDatabaseConfiguration + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/New-AzKustoCluster.md b/azps-10.1.0/Az.Kusto/New-AzKustoCluster.md new file mode 100644 index 0000000000..6b3349114f --- /dev/null +++ b/azps-10.1.0/Az.Kusto/New-AzKustoCluster.md @@ -0,0 +1,758 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/new-azkustocluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoCluster.md +--- + +# New-AzKustoCluster + +## SYNOPSIS +Create or update a Kusto cluster. + +## SYNTAX + +``` +New-AzKustoCluster -Name <String> -ResourceGroupName <String> -Location <String> -SkuName <AzureSkuName> + -SkuTier <AzureSkuTier> [-SubscriptionId <String>] [-IfMatch <String>] [-IfNoneMatch <String>] + [-AcceptedAudience <IAcceptedAudiences[]>] [-AllowedFqdnList <String[]>] [-AllowedIPRangeList <String[]>] + [-EnableAutoStop] [-EnableDiskEncryption] [-EnableDoubleEncryption] [-EnablePurge] [-EnableStreamingIngest] + [-EngineType <EngineType>] [-IdentityType <IdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] + [-KeyVaultPropertyKeyName <String>] [-KeyVaultPropertyKeyVaultUri <String>] + [-KeyVaultPropertyKeyVersion <String>] [-KeyVaultPropertyUserIdentity <String>] + [-LanguageExtensionValue <ILanguageExtension[]>] [-OptimizedAutoscaleIsEnabled] + [-OptimizedAutoscaleMaximum <Int32>] [-OptimizedAutoscaleMinimum <Int32>] + [-OptimizedAutoscaleVersion <Int32>] [-PublicIPType <PublicIPType>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-RestrictOutboundNetworkAccess <ClusterNetworkAccessFlag>] + [-SkuCapacity <Int32>] [-Tag <Hashtable>] [-TrustedExternalTenant <ITrustedExternalTenant[]>] + [-VirtualClusterGraduationProperty <String>] [-VirtualNetworkConfigurationDataManagementPublicIPId <String>] + [-VirtualNetworkConfigurationEnginePublicIPId <String>] [-VirtualNetworkConfigurationSubnetId <String>] + [-Zone <String[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a Kusto cluster. + +## EXAMPLES + +### Example 1: Create a new Kusto cluster +```powershell +New-AzKustoCluster -ResourceGroupName testrg -Name testnewkustocluster -Location 'East US' -SkuName Standard_D11_v2 -SkuTier Standard -EnableDoubleEncryption -EngineType 'V2' +``` + +```output +Location Name Type Zone +-------- ---- ---- ---- +East US testnewkustocluster Microsoft.Kusto/Clusters +``` + +The above command creates a new Kusto cluster named "testnewkustocluster" in the resource group "testrg". + +## PARAMETERS + +### -AcceptedAudience +The cluster's accepted audiences. +To construct, see NOTES section for ACCEPTEDAUDIENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IAcceptedAudiences[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedFqdnList +List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedIPRangeList +The list of ips in the format of CIDR allowed to connect to the cluster. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoStop +A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDiskEncryption +A boolean value that indicates if the cluster's disks are encrypted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDoubleEncryption +A boolean value that indicates if double encryption is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePurge +A boolean value that indicates if the purge operations are enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableStreamingIngest +A boolean value that indicates if the streaming ingest is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EngineType +The engine type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.EngineType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The type of managed identity used. +The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. +The type 'None' will remove all identities. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.IdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +The list of user identities associated with the Kusto cluster. +The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the cluster. +Omit this value to always overwrite the current cluster. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new cluster to be created, but to prevent updating an existing cluster. +Other values will result in a 412 Pre-condition Failed response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyName +The name of the key vault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyVaultUri +The Uri of the key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyVersion +The version of the key vault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyUserIdentity +The user assigned identity (ARM resource id) that has access to the key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LanguageExtensionValue +The list of language extensions. +To construct, see NOTES section for LANGUAGEEXTENSIONVALUE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ILanguageExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleIsEnabled +A boolean value that indicate if the optimized autoscale feature is enabled or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleMaximum +Maximum allowed instances count. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleMinimum +Minimum allowed instances count. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleVersion +The version of the template defined, for instance 1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIPType +Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PublicIPType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Public network access to the cluster is enabled by default. +When disabled, only private endpoint connection to the cluster is allowed + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictOutboundNetworkAccess +Whether or not to restrict outbound network access. +Value is optional but if passed in, must be 'Enabled' or 'Disabled' + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.ClusterNetworkAccessFlag +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +The number of instances of the cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +SKU name. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.AzureSkuName +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +SKU tier. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.AzureSkuTier +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedExternalTenant +The cluster's external tenants. +To construct, see NOTES section for TRUSTEDEXTERNALTENANT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ITrustedExternalTenant[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualClusterGraduationProperty +Virtual Cluster graduation properties + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkConfigurationDataManagementPublicIPId +Data management's service public IP address resource id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkConfigurationEnginePublicIPId +Engine service's public IP address resource id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkConfigurationSubnetId +The subnet resource id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +The availability zones of the cluster. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.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. + + +`ACCEPTEDAUDIENCE <IAcceptedAudiences[]>`: The cluster's accepted audiences. + - `[Value <String>]`: GUID or valid URL representing an accepted audience. + +`LANGUAGEEXTENSIONVALUE <ILanguageExtension[]>`: The list of language extensions. + - `[ImageName <LanguageExtensionImageName?>]`: The language extension image name. + - `[Name <LanguageExtensionName?>]`: The language extension name. + +`TRUSTEDEXTERNALTENANT <ITrustedExternalTenant[]>`: The cluster's external tenants. + - `[Value <String>]`: GUID representing an external tenant. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/New-AzKustoClusterPrincipalAssignment.md b/azps-10.1.0/Az.Kusto/New-AzKustoClusterPrincipalAssignment.md new file mode 100644 index 0000000000..58c24bd9f1 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/New-AzKustoClusterPrincipalAssignment.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/new-azkustoclusterprincipalassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoClusterPrincipalAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoClusterPrincipalAssignment.md +--- + +# New-AzKustoClusterPrincipalAssignment + +## SYNOPSIS +Create a Kusto cluster principalAssignment. + +## SYNTAX + +``` +New-AzKustoClusterPrincipalAssignment -ClusterName <String> -PrincipalAssignmentName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-PrincipalId <String>] + [-PrincipalType <PrincipalType>] [-Role <ClusterPrincipalRole>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a Kusto cluster principalAssignment. + +## EXAMPLES + +### Example 1: Create a Kusto cluster principalAssignment +```powershell +New-AzKustoClusterPrincipalAssignment -ResourceGroupName testrg -ClusterName testnewkustocluster -PrincipalAssignmentName kustoprincipal1 -PrincipalId "7e1cb39f-d2cb-4f0d-801a-c9ea1f376e96" -PrincipalType App -Role AllDatabasesAdmin +``` + +```output +Name Type +---- ---- +testnewkustocluster/kustoprincipal1 Microsoft.Kusto/Clusters/PrincipalAssignments +``` + +The above command creates a Kusto cluster principalAssignment + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalId +The principal ID assigned to the cluster principal. +It can be a user email, application ID, or security group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalType +Principal type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PrincipalType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +Cluster principal role. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.ClusterPrincipalRole +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +The tenant id of the principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IClusterPrincipalAssignment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/New-AzKustoDataConnection.md b/azps-10.1.0/Az.Kusto/New-AzKustoDataConnection.md new file mode 100644 index 0000000000..7335fe19ad --- /dev/null +++ b/azps-10.1.0/Az.Kusto/New-AzKustoDataConnection.md @@ -0,0 +1,589 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/new-azkustodataconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoDataConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoDataConnection.md +--- + +# New-AzKustoDataConnection + +## SYNOPSIS +Creates or updates a data connection. + +## SYNTAX + +### CreateExpandedEventHub (Default) +``` +New-AzKustoDataConnection -ClusterName <String> -DatabaseName <String> -Name <String> + -ResourceGroupName <String> -ConsumerGroup <String> -EventHubResourceId <String> -Kind <Kind> + -Location <String> [-SubscriptionId <String>] [-Compression <Compression>] + [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] [-EventSystemProperty <String[]>] + [-ManagedIdentityResourceId <String>] [-MappingRuleName <String>] [-RetrievalStartDate <DateTime>] + [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CreateExpandedCosmosDb +``` +New-AzKustoDataConnection -ClusterName <String> -DatabaseName <String> -Name <String> + -ResourceGroupName <String> -CosmosDbAccountResourceId <String> -CosmosDbContainer <String> + -CosmosDbDatabase <String> -Kind <Kind> -Location <String> -ManagedIdentityResourceId <String> + -TableName <String> [-SubscriptionId <String>] [-MappingRuleName <String>] [-RetrievalStartDate <DateTime>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateExpandedEventGrid +``` +New-AzKustoDataConnection -ClusterName <String> -DatabaseName <String> -Name <String> + -ResourceGroupName <String> -ConsumerGroup <String> -EventHubResourceId <String> -Kind <Kind> + -Location <String> -StorageAccountResourceId <String> [-SubscriptionId <String>] + [-BlobStorageEventType <BlobStorageEventType>] [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] + [-EventGridResourceId <String>] [-IgnoreFirstRecord] [-ManagedIdentityResourceId <String>] + [-MappingRuleName <String>] [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### CreateExpandedIotHub +``` +New-AzKustoDataConnection -ClusterName <String> -DatabaseName <String> -Name <String> + -ResourceGroupName <String> -ConsumerGroup <String> -IotHubResourceId <String> -Kind <Kind> + -Location <String> -SharedAccessPolicyName <String> [-SubscriptionId <String>] + [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] [-EventSystemProperty <String[]>] + [-MappingRuleName <String>] [-RetrievalStartDate <DateTime>] [-TableName <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a data connection. + +## EXAMPLES + +### Example 1: Create a new EventHub data connection +```powershell +New-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventhubdc" -Location "East US" -Kind "EventHub" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -DataFormat "JSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "EventsMapping" +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +EventHub East US testnewkustocluster/mykustodatabase/myeventhubdc Microsoft.Kusto/Clusters/Databases/DataConnections +``` + +The above command creates a new EventHub data connection named "myeventhubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +### Example 2: Create a new EventGrid data connection +```powershell +New-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventgriddc" -Location "East US" -Kind "EventGrid" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -StorageAccountResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Storage/storageAccounts/mystorage" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +EventGrid East US testnewkustocluster/mykustodatabase/myeventgriddc Microsoft.Kusto/Clusters/Databases/DataConnections +``` + +The above command creates a new EventGrid data connection named "myeventgriddc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +### Example 3: Create a new IotHub data connection +```powershell +New-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myiothubdc" -Location "East US" -Kind "IotHub" -IotHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Devices/IotHubs/myiothub" -SharedAccessPolicyName "myiothubpolicy" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +IotHub East US testnewkustocluster/mykustodatabase/myiothubdc Microsoft.Kusto/Clusters/Databases/DataConnections +``` + +The above command creates a new IotHub data connection named "myiothubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobStorageEventType +The name of blob storage event type to process. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.BlobStorageEventType +Parameter Sets: CreateExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compression +The event hub messages compression type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Compression +Parameter Sets: CreateExpandedEventHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsumerGroup +The event/iot hub consumer group. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedEventGrid, CreateExpandedEventHub, CreateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CosmosDbAccountResourceId +The resource ID of the Cosmos DB account used to create the data connection. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedCosmosDb +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CosmosDbContainer +The name of an existing container in the Cosmos DB database. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedCosmosDb +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CosmosDbDatabase +The name of an existing database in the Cosmos DB account. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedCosmosDb +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseRouting +Indication for database routing information from the data connection, by default only database routing information is allowed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabaseRouting +Parameter Sets: CreateExpandedEventGrid, CreateExpandedEventHub, CreateExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFormat +The data format of the message. +Optionally the data format can be added to each message. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedEventGrid, CreateExpandedEventHub, CreateExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventGridResourceId +The resource ID of the event grid that is subscribed to the storage account events. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubResourceId +The resource ID of the event hub to be used to create a data connection / event grid is configured to send events. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedEventGrid, CreateExpandedEventHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSystemProperty +System properties of the event/iot hub. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpandedEventHub, CreateExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreFirstRecord +If set to true, indicates that ingestion should ignore the first record of every file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHubResourceId +The resource ID of the Iot hub to be used to create a data connection. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the endpoint for the data connection + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedIdentityResourceId +The resource ID of a managed identity (system or user assigned) to be used to authenticate with external resources. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedCosmosDb, CreateExpandedEventGrid, CreateExpandedEventHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MappingRuleName +The mapping rule to be used to ingest the data. +Optionally the mapping information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the data connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DataConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetrievalStartDate +When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. +It can only retrieve events retained by the Event hub, based on its retention period. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpandedCosmosDb, CreateExpandedEventHub, CreateExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedAccessPolicyName +The name of the share access policy. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The resource ID of the storage account where the data resides. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedEventGrid +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableName +The table where the data should be ingested. +Optionally the table information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDataConnection + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/New-AzKustoDatabase.md b/azps-10.1.0/Az.Kusto/New-AzKustoDatabase.md new file mode 100644 index 0000000000..8ff948a869 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/New-AzKustoDatabase.md @@ -0,0 +1,271 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/new-azkustodatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoDatabase.md +--- + +# New-AzKustoDatabase + +## SYNOPSIS +Creates or updates a database. + +## SYNTAX + +``` +New-AzKustoDatabase -ClusterName <String> -Name <String> -ResourceGroupName <String> -Kind <Kind> + [-SubscriptionId <String>] [-CallerRole <CallerRole>] [-HotCachePeriod <TimeSpan>] [-Location <String>] + [-SoftDeletePeriod <TimeSpan>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a database. + +## EXAMPLES + +### Example 1: Create a new database +```powershell +New-AzKustoDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster -Name mykustodatabase -Kind ReadWrite -Location 'East US' +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +ReadWrite East US testnewkustocluster/mykustodatabase Microsoft.Kusto/Clusters/Databases +``` + +The above command creates a new datebase named "mykustodatabase" in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallerRole +By default, any user who run operation on a database become an Admin on it. +This property allows the caller to exclude the caller from Admins list. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.CallerRole +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HotCachePeriod +The time the data should be kept in cache for fast queries in TimeSpan. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the database + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DatabaseName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletePeriod +The time the data should be kept before it stops being accessible to queries in TimeSpan. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDatabase + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/New-AzKustoDatabasePrincipalAssignment.md b/azps-10.1.0/Az.Kusto/New-AzKustoDatabasePrincipalAssignment.md new file mode 100644 index 0000000000..4ea65cfa74 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/New-AzKustoDatabasePrincipalAssignment.md @@ -0,0 +1,272 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/new-azkustodatabaseprincipalassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoDatabasePrincipalAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoDatabasePrincipalAssignment.md +--- + +# New-AzKustoDatabasePrincipalAssignment + +## SYNOPSIS +Creates a Kusto cluster database principalAssignment. + +## SYNTAX + +``` +New-AzKustoDatabasePrincipalAssignment -ClusterName <String> -DatabaseName <String> + -PrincipalAssignmentName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-PrincipalId <String>] [-PrincipalType <PrincipalType>] [-Role <DatabasePrincipalRole>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a Kusto cluster database principalAssignment. + +## EXAMPLES + +### Example 1: Create a Kusto cluster database principalAssignment +```powershell +New-AzKustoDatabasePrincipalAssignment -ResourceGroupName testrg -ClusterName testnewkustocluster -DatabaseName mykustodatabase -PrincipalAssignmentName kustoprincipal1 -PrincipalId "7e1cb39f-d2cb-4f0d-801a-c9ea1f376e96" -PrincipalType App -Role Admin +``` + +```output +Name Type +---- ---- +testnewkustocluster/mykustodatabase/kustoprincipal1 Microsoft.Kusto/Clusters/Databases/PrincipalAssignments +``` + +The above command creates a Kusto cluster database principalAssignment + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalId +The principal ID assigned to the database principal. +It can be a user email, application ID, or security group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalType +Principal type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PrincipalType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +Database principal role. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabasePrincipalRole +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +The tenant id of the principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDatabasePrincipalAssignment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/New-AzKustoManagedPrivateEndpoint.md b/azps-10.1.0/Az.Kusto/New-AzKustoManagedPrivateEndpoint.md new file mode 100644 index 0000000000..ccb5b3b810 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/New-AzKustoManagedPrivateEndpoint.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/new-azkustomanagedprivateendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoManagedPrivateEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoManagedPrivateEndpoint.md +--- + +# New-AzKustoManagedPrivateEndpoint + +## SYNOPSIS +Creates a managed private endpoint. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzKustoManagedPrivateEndpoint -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-GroupId <String>] [-PrivateLinkResourceId <String>] + [-PrivateLinkResourceRegion <String>] [-RequestMessage <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzKustoManagedPrivateEndpoint -ClusterName <String> -Name <String> -ResourceGroupName <String> + -Parameter <IManagedPrivateEndpoint> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a managed private endpoint. + +## EXAMPLES + +### Example 1: Create a new Kusto ManagedPrivateEndpoint in a cluster +```powershell +New-AzKustoManagedPrivateEndpoint -ClusterName "mycluster" -ResourceGroupName "testrg" -Name "ManagedPrivateEndpointName" -GroupId "namespace" -RequestMessage "Please approve" -PrivateLinkResourceRegion "Australia Central" -PrivateLinkResourceId "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testclientsns22" +``` + +```output +Name Type +---- ---- +ManagedPrivateEndpointName Microsoft.Kusto/Clusters/ManagedPrivateEndpoints +``` + +The above command creates a new Kusto ManagedPrivateEndpoint in the cluster "mycluster" found in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +The groupId in which the managed private endpoint is created. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the managed private endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ManagedPrivateEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Class representing a managed private endpoint. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IManagedPrivateEndpoint +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateLinkResourceId +The ARM resource ID of the resource for which the managed private endpoint is created. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkResourceRegion +The region of the resource to which the managed private endpoint is created. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestMessage +The user request message. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IManagedPrivateEndpoint + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IManagedPrivateEndpoint + +## 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. + + +`PARAMETER <IManagedPrivateEndpoint>`: Class representing a managed private endpoint. + - `[AzureAsyncOperation <String>]`: + - `[GroupId <String>]`: The groupId in which the managed private endpoint is created. + - `[PrivateLinkResourceId <String>]`: The ARM resource ID of the resource for which the managed private endpoint is created. + - `[PrivateLinkResourceRegion <String>]`: The region of the resource to which the managed private endpoint is created. + - `[RequestMessage <String>]`: The user request message. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/New-AzKustoPrivateEndpointConnection.md b/azps-10.1.0/Az.Kusto/New-AzKustoPrivateEndpointConnection.md new file mode 100644 index 0000000000..fca6fc9143 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/New-AzKustoPrivateEndpointConnection.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/new-azkustoprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoPrivateEndpointConnection.md +--- + +# New-AzKustoPrivateEndpointConnection + +## SYNOPSIS +Approve or reject a private endpoint connection with a given name. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzKustoPrivateEndpointConnection -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-PrivateLinkServiceConnectionStateDescription <String>] + [-PrivateLinkServiceConnectionStateStatus <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzKustoPrivateEndpointConnection -ClusterName <String> -Name <String> -ResourceGroupName <String> + -Parameter <IPrivateEndpointConnection> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Approve or reject a private endpoint connection with a given name. + +## EXAMPLES + +### Example 1: Create a new PrivateEndpointConnection in a cluster +```powershell +New-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "12345678-1234-1234-1234-123456789098" -Parameter $privateEndpointConnection -Name "testprivateconnection-12345678-1234-1234-1234-123456789098" +``` + +```output +Name Type +---- ---- +testprivateconnection-12345678-1234-1234-1234-123456789098 Microsoft.Kusto/Clusters/PrivateEndpointConnections +``` + +The above command creates a new PrivateEndpointConnection in the cluster "mycluster" found in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PrivateEndpointConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +A private endpoint connection +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IPrivateEndpointConnection +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateLinkServiceConnectionStateDescription +The private link service connection description. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkServiceConnectionStateStatus +The private link service connection status. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IPrivateEndpointConnection + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IPrivateEndpointConnection + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`PARAMETER <IPrivateEndpointConnection>`: A private endpoint connection + - `[PrivateLinkServiceConnectionStateDescription <String>]`: The private link service connection description. + - `[PrivateLinkServiceConnectionStateStatus <String>]`: The private link service connection status. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/New-AzKustoScript.md b/azps-10.1.0/Az.Kusto/New-AzKustoScript.md new file mode 100644 index 0000000000..4adb1ef335 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/New-AzKustoScript.md @@ -0,0 +1,336 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/new-azkustoscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/New-AzKustoScript.md +--- + +# New-AzKustoScript + +## SYNOPSIS +Creates a Kusto database script. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzKustoScript -ClusterName <String> -DatabaseName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-ContinueOnError] [-ForceUpdateTag <String>] [-ScriptContent <String>] + [-ScriptUrl <String>] [-ScriptUrlSasToken <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzKustoScript -ClusterName <String> -DatabaseName <String> -Name <String> -ResourceGroupName <String> + -Parameter <IScript> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a Kusto database script. + +## EXAMPLES + +### Example 1: Create a Kusto database script +```powershell +New-AzKustoScript -ClusterName testnewkustocluster -DatabaseName mykustodatabase -Name newkustoscript -ResourceGroupName testrg -ScriptUrl $BlobSASURL -ScriptUrlSasToken $BlobSASToken +``` + +```output +Name Type +---- ---- +testnewkustocluster/mykustodatabase/newkustoscript Microsoft.Kusto/Clusters/Databases/Scripts +``` + +The above command creates a Kusto database script named "newkustocript" in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinueOnError +Flag that indicates whether to continue if one of the command fails. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpdateTag +A unique string. +If changed the script will be applied again. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto database script. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ScriptName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Class representing a database script. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IScript +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptContent +The script content. +This property should be used when the script is provide inline and not through file in a SA. +Must not be used together with scriptUrl and scriptUrlSasToken properties. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptUrl +The url to the KQL script blob file. +Must not be used together with scriptContent property + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptUrlSasToken +The SaS token that provide read access to the file which contain the script. +Must be provided when using scriptUrl property. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IScript + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IScript + +## 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. + + +`PARAMETER <IScript>`: Class representing a database script. + - `[AzureAsyncOperation <String>]`: + - `[Content <String>]`: The script content. This property should be used when the script is provide inline and not through file in a SA. Must not be used together with scriptUrl and scriptUrlSasToken properties. + - `[ContinueOnError <Boolean?>]`: Flag that indicates whether to continue if one of the command fails. + - `[ForceUpdateTag <String>]`: A unique string. If changed the script will be applied again. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Url <String>]`: The url to the KQL script blob file. Must not be used together with scriptContent property + - `[UrlSasToken <String>]`: The SaS token that provide read access to the file which contain the script. Must be provided when using scriptUrl property. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Remove-AzKustoAttachedDatabaseConfiguration.md b/azps-10.1.0/Az.Kusto/Remove-AzKustoAttachedDatabaseConfiguration.md new file mode 100644 index 0000000000..7dffa824ec --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Remove-AzKustoAttachedDatabaseConfiguration.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustoattacheddatabaseconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoAttachedDatabaseConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoAttachedDatabaseConfiguration.md +--- + +# Remove-AzKustoAttachedDatabaseConfiguration + +## SYNOPSIS +Deletes the attached database configuration with the given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzKustoAttachedDatabaseConfiguration -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzKustoAttachedDatabaseConfiguration -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the attached database configuration with the given name. + +## EXAMPLES + +### Example 1: Delete an existing AttachedDatabaseConfiguration by name +```powershell +Remove-AzKustoAttachedDatabaseConfiguration -ResourceGroupName "testrg" -ClusterName "testnewkustoclusterf" -Name "myfollowerconfiguration" +``` + +The above command deletes the follower database defined in the AttachedDatabaseConfiguration "myfollowerconfiguration" from cluster "testnewkustoclusterf". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the attached database configuration. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AttachedDatabaseConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Remove-AzKustoCluster.md b/azps-10.1.0/Az.Kusto/Remove-AzKustoCluster.md new file mode 100644 index 0000000000..fd14f3067c --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Remove-AzKustoCluster.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustocluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoCluster.md +--- + +# Remove-AzKustoCluster + +## SYNOPSIS +Deletes a Kusto cluster. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzKustoCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzKustoCluster -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Kusto cluster. + +## EXAMPLES + +### Example 1: Delete an existing Kusto cluster by name +```powershell +Remove-AzKustoCluster -ResourceGroupName testrg -Name testnewkustocluster +``` + +The above command deletes the Kusto cluster named "testnewkustocluster" in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Remove-AzKustoClusterLanguageExtension.md b/azps-10.1.0/Az.Kusto/Remove-AzKustoClusterLanguageExtension.md new file mode 100644 index 0000000000..de71b8422a --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Remove-AzKustoClusterLanguageExtension.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustoclusterlanguageextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoClusterLanguageExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoClusterLanguageExtension.md +--- + +# Remove-AzKustoClusterLanguageExtension + +## SYNOPSIS +Remove a list of language extensions that can run within KQL queries. + +## SYNTAX + +### RemoveExpanded (Default) +``` +Remove-AzKustoClusterLanguageExtension -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Value <ILanguageExtension[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RemoveViaIdentityExpanded +``` +Remove-AzKustoClusterLanguageExtension -InputObject <IKustoIdentity> [-Value <ILanguageExtension[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a list of language extensions that can run within KQL queries. + +## EXAMPLES + +### Example 1: Remove a list of language extensions from cluster +```powershell +Remove-AzKustoClusterLanguageExtension -ResourceGroupName testrg -ClusterName testnewkustocluster -Value (@{Name="R"}) +``` + +The above command removes a list of language extensions that can run within KQL queries. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: RemoveViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The list of language extensions. +To construct, see NOTES section for VALUE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ILanguageExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`VALUE <ILanguageExtension[]>`: The list of language extensions. + - `[ImageName <LanguageExtensionImageName?>]`: The language extension image name. + - `[Name <LanguageExtensionName?>]`: The language extension name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Remove-AzKustoClusterPrincipalAssignment.md b/azps-10.1.0/Az.Kusto/Remove-AzKustoClusterPrincipalAssignment.md new file mode 100644 index 0000000000..e5fc0423c5 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Remove-AzKustoClusterPrincipalAssignment.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustoclusterprincipalassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoClusterPrincipalAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoClusterPrincipalAssignment.md +--- + +# Remove-AzKustoClusterPrincipalAssignment + +## SYNOPSIS +Deletes a Kusto cluster principalAssignment. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzKustoClusterPrincipalAssignment -ClusterName <String> -PrincipalAssignmentName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzKustoClusterPrincipalAssignment -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Kusto cluster principalAssignment. + +## EXAMPLES + +### Example 1: Delete an existing Kusto cluster PrincipalAssignment by name +```powershell +Remove-AzKustoClusterPrincipalAssignment -ResourceGroupName testrg -ClusterName testnewkustocluster -PrincipalAssignmentName kustoprincipal1 +``` + +The above command deletes the PrincipalAssignment named "kustoprincipal1" in the Kusto cluster "testnewkustocluster". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Remove-AzKustoDataConnection.md b/azps-10.1.0/Az.Kusto/Remove-AzKustoDataConnection.md new file mode 100644 index 0000000000..d4b0d461cf --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Remove-AzKustoDataConnection.md @@ -0,0 +1,265 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustodataconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoDataConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoDataConnection.md +--- + +# Remove-AzKustoDataConnection + +## SYNOPSIS +Deletes the data connection with the given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzKustoDataConnection -ClusterName <String> -DatabaseName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzKustoDataConnection -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the data connection with the given name. + +## EXAMPLES + +### Example 1: Delete an existing data connection by name +```powershell +Remove-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "mykustodataconnection" +``` + +The above command deletes the data connection named "mykustodataconnection" in database "mykustodatabase" of the existing cluster "testnewkustocluster" found in the resource group "testrg" + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the data connection. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DataConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Remove-AzKustoDatabase.md b/azps-10.1.0/Az.Kusto/Remove-AzKustoDatabase.md new file mode 100644 index 0000000000..474f02e205 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Remove-AzKustoDatabase.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustodatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoDatabase.md +--- + +# Remove-AzKustoDatabase + +## SYNOPSIS +Deletes the database with the given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzKustoDatabase -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzKustoDatabase -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the database with the given name. + +## EXAMPLES + +### Example 1: Delete an existing Kusto database by name +```powershell +Remove-AzKustoDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster -Name mykustodatabase +``` + +The above command deletes the Kusto database named "mykustodatabase" in the cluster "testnewkustocluster" found in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DatabaseName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Remove-AzKustoDatabasePrincipal.md b/azps-10.1.0/Az.Kusto/Remove-AzKustoDatabasePrincipal.md new file mode 100644 index 0000000000..917ebda83e --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Remove-AzKustoDatabasePrincipal.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustodatabaseprincipal +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoDatabasePrincipal.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoDatabasePrincipal.md +--- + +# Remove-AzKustoDatabasePrincipal + +## SYNOPSIS +Remove Database principals permissions. + +## SYNTAX + +### RemoveExpanded (Default) +``` +Remove-AzKustoDatabasePrincipal -ClusterName <String> -DatabaseName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Value <IDatabasePrincipal[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### RemoveViaIdentityExpanded +``` +Remove-AzKustoDatabasePrincipal -InputObject <IKustoIdentity> [-Value <IDatabasePrincipal[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove Database principals permissions. + +## EXAMPLES + +### Example 1: Remove Database principals permissions +```powershell +Remove-AzKustoDatabasePrincipal -ResourceGroupName testrg -ClusterName testnewkustocluster -DatabaseName mykustodatabase -Value (@{Name="Some User"; Role="Admin"; Type="User"; Email="someuser@microsoft.com"}) +``` + +```output +AppId Email Fqn Name Role TenantName Type +----- ----- --- ---- ---- ---------- ---- + otheruser@microsoft.com aaduser=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Other User Admin Microsoft User +``` + +The above command removes Database principals permissions + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: RemoveViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The list of Kusto database principals. +To construct, see NOTES section for VALUE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDatabasePrincipal[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDatabasePrincipal + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`VALUE <IDatabasePrincipal[]>`: The list of Kusto database principals. + - `Name <String>`: Database principal name. + - `Role <DatabasePrincipalRole>`: Database principal role. + - `Type <DatabasePrincipalType>`: Database principal type. + - `[AppId <String>]`: Application id - relevant only for application principal type. + - `[Email <String>]`: Database principal email if exists. + - `[Fqn <String>]`: Database principal fully qualified name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Remove-AzKustoDatabasePrincipalAssignment.md b/azps-10.1.0/Az.Kusto/Remove-AzKustoDatabasePrincipalAssignment.md new file mode 100644 index 0000000000..a6e0954299 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Remove-AzKustoDatabasePrincipalAssignment.md @@ -0,0 +1,265 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustodatabaseprincipalassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoDatabasePrincipalAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoDatabasePrincipalAssignment.md +--- + +# Remove-AzKustoDatabasePrincipalAssignment + +## SYNOPSIS +Deletes a Kusto principalAssignment. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzKustoDatabasePrincipalAssignment -ClusterName <String> -DatabaseName <String> + -PrincipalAssignmentName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzKustoDatabasePrincipalAssignment -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Kusto principalAssignment. + +## EXAMPLES + +### Example 1: Delete an existing Kusto database PrincipalAssignment by name +```powershell +Remove-AzKustoDatabasePrincipalAssignment -ResourceGroupName testrg -ClusterName testnewkustocluster -DatabaseName mykustodatabase -PrincipalAssignmentName kustoprincipal1 +``` + +The above command deletes the PrincipalAssignment named "kustoprincipal1" in the Kusto database "mykustodatabase". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Remove-AzKustoManagedPrivateEndpoint.md b/azps-10.1.0/Az.Kusto/Remove-AzKustoManagedPrivateEndpoint.md new file mode 100644 index 0000000000..abb633200f --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Remove-AzKustoManagedPrivateEndpoint.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustomanagedprivateendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoManagedPrivateEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoManagedPrivateEndpoint.md +--- + +# Remove-AzKustoManagedPrivateEndpoint + +## SYNOPSIS +Deletes a managed private endpoint. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzKustoManagedPrivateEndpoint -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzKustoManagedPrivateEndpoint -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a managed private endpoint. + +## EXAMPLES + +### Example 1: Delete an existing Kusto ManagedPrivateEndpoint by name +```powershell +Remove-AzKustoManagedPrivateEndpoint -ClusterName "mycluster" -ResourceGroupName "testrg" -Name "ManagedPrivateEndpointName" +``` + +The above command deletes the Kusto ManagedPrivateEndpoint named "ManagedPrivateEndpointName" in the cluster "mycluster" found in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the managed private endpoint. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ManagedPrivateEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Remove-AzKustoPrivateEndpointConnection.md b/azps-10.1.0/Az.Kusto/Remove-AzKustoPrivateEndpointConnection.md new file mode 100644 index 0000000000..21e090b208 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Remove-AzKustoPrivateEndpointConnection.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustoprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoPrivateEndpointConnection.md +--- + +# Remove-AzKustoPrivateEndpointConnection + +## SYNOPSIS +Deletes a private endpoint connection with a given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzKustoPrivateEndpointConnection -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzKustoPrivateEndpointConnection -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a private endpoint connection with a given name. + +## EXAMPLES + +### Example 1: Delete an existing Kusto PrivateEndpointConnection by name +```powershell +Remove-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -Name "testprivateconnection-12345678-1234-1234-1234-123456789098" +``` + +The above command deletes the Kusto PrivateEndpointConnection named "testprivateconnection-12345678-1234-1234-1234-123456789098" in the cluster "mycluster" found in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: PrivateEndpointConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Remove-AzKustoScript.md b/azps-10.1.0/Az.Kusto/Remove-AzKustoScript.md new file mode 100644 index 0000000000..053823a960 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Remove-AzKustoScript.md @@ -0,0 +1,265 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustoscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Remove-AzKustoScript.md +--- + +# Remove-AzKustoScript + +## SYNOPSIS +Deletes a Kusto principalAssignment. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzKustoScript -ClusterName <String> -DatabaseName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzKustoScript -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Kusto principalAssignment. + +## EXAMPLES + +### Example 1: Delete a Kusto script +```powershell +Remove-AzKustoScript -ClusterName testnewkustocluster -ResourceGroupName testrg -DatabaseName mykustodatabase -Name newkustoscript +``` + +The above command deletes the Kusto script named "newkustoscript" in the cluster "testnewkustocluster" found in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto database script. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ScriptName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Start-AzKustoCluster.md b/azps-10.1.0/Az.Kusto/Start-AzKustoCluster.md new file mode 100644 index 0000000000..8b88fc99c1 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Start-AzKustoCluster.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/start-azkustocluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Start-AzKustoCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Start-AzKustoCluster.md +--- + +# Start-AzKustoCluster + +## SYNOPSIS +Starts a Kusto cluster. + +## SYNTAX + +### Start (Default) +``` +Start-AzKustoCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzKustoCluster -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Starts a Kusto cluster. + +## EXAMPLES + +### Example 1: Start a Kusto cluster +```powershell +Start-AzKustoCluster -ResourceGroupName testrg -Name testnewkustocluster +``` + +The above command starts a Kusto cluster. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Stop-AzKustoCluster.md b/azps-10.1.0/Az.Kusto/Stop-AzKustoCluster.md new file mode 100644 index 0000000000..aa1ba42472 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Stop-AzKustoCluster.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/stop-azkustocluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Stop-AzKustoCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Stop-AzKustoCluster.md +--- + +# Stop-AzKustoCluster + +## SYNOPSIS +Stops a Kusto cluster. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzKustoCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzKustoCluster -InputObject <IKustoIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Stops a Kusto cluster. + +## EXAMPLES + +### Example 1: Stop a Kusto cluster +```powershell +Stop-AzKustoCluster -ResourceGroupName testrg -Name testnewkustocluster +``` + +The above command stops a Kusto cluster + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md b/azps-10.1.0/Az.Kusto/Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md new file mode 100644 index 0000000000..bc76ae795a --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/test-azkustoattacheddatabaseconfigurationnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md +--- + +# Test-AzKustoAttachedDatabaseConfigurationNameAvailability + +## SYNOPSIS +Checks that the attached database configuration resource name is valid and is not already in use. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzKustoAttachedDatabaseConfigurationNameAvailability -ClusterName <String> -ResourceGroupName <String> + -Name <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzKustoAttachedDatabaseConfigurationNameAvailability -InputObject <IKustoIdentity> -Name <String> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Checks that the attached database configuration resource name is valid and is not already in use. + +## EXAMPLES + +### Example 1: Checks whether the attached database configuration name is available in the given cluster +```powershell +Test-AzKustoAttachedDatabaseConfigurationNameAvailability -ResourceGroupName "testrg" -ClusterName "mycluster" -Name "testdatabase" +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ + testdatabase True +``` + +The above command returns whether or not an attached database configuration name is available in the cluster named "mycluster" in resource group "testrg". + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Attached database resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ICheckNameResult + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Test-AzKustoClusterNameAvailability.md b/azps-10.1.0/Az.Kusto/Test-AzKustoClusterNameAvailability.md new file mode 100644 index 0000000000..ab385d1c41 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Test-AzKustoClusterNameAvailability.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/test-azkustoclusternameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoClusterNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoClusterNameAvailability.md +--- + +# Test-AzKustoClusterNameAvailability + +## SYNOPSIS +Checks that the cluster name is valid and is not already in use. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzKustoClusterNameAvailability -Location <String> -Name <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzKustoClusterNameAvailability -InputObject <IKustoIdentity> -Name <String> [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Checks that the cluster name is valid and is not already in use. + +## EXAMPLES + +### Example 1: Check the availability of a Kusto cluster name which is in use +```powershell +Test-AzKustoClusterNameAvailability -Name testnewkustocluster -Location 'East US' +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ +Name 'testnewkustocluster' with type Engine is already taken. Please specify a different name testnewkustocluster False +``` + +The above command returns whether or not a Kusto cluster named "testnewkustocluster" exists in the "East US" region. + +### Example 2: Check the availability of a Kusto cluster name which is not in use +```powershell +Test-AzKustoClusterNameAvailability -Name availablekustocluster -Location 'East US' +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ + availablekustocluster True +``` + +The above command returns whether or not a Kusto cluster named "availablekustocluster" exists in the "East US" region. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Azure location (region) name. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Cluster name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ICheckNameResult + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Test-AzKustoClusterPrincipalAssignmentNameAvailability.md b/azps-10.1.0/Az.Kusto/Test-AzKustoClusterPrincipalAssignmentNameAvailability.md new file mode 100644 index 0000000000..2ace4291b9 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Test-AzKustoClusterPrincipalAssignmentNameAvailability.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/test-azkustoclusterprincipalassignmentnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoClusterPrincipalAssignmentNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoClusterPrincipalAssignmentNameAvailability.md +--- + +# Test-AzKustoClusterPrincipalAssignmentNameAvailability + +## SYNOPSIS +Checks that the principal assignment name is valid and is not already in use. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzKustoClusterPrincipalAssignmentNameAvailability -ClusterName <String> -ResourceGroupName <String> + -Name <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzKustoClusterPrincipalAssignmentNameAvailability -InputObject <IKustoIdentity> -Name <String> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Checks that the principal assignment name is valid and is not already in use. + +## EXAMPLES + +### Example 1: Check the availability of a cluster principalassignment name which is in use +```powershell +Test-AzKustoClusterPrincipalAssignmentNameAvailability -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -Name "myprincipal" +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ +PrincipalAssignment myprincipal already exists in cluster testnewkustocluster. Please select a different name. myprincipal False +``` + +The above command returns whether or not a PrincipalAssignment named "myprincipal" exists in the cluster "testnewkustocluster". + +### Example 2: Check the availability of a cluster principalassignment name which is not in use +```powershell +Test-AzKustoClusterPrincipalAssignmentNameAvailability -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -Name "newprincipal" +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ + availablekustocluster True +``` + +The above command returns whether or not a PrincipalAssignment named "newprincipal" exists in the cluster "testnewkustocluster". + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Principal Assignment resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ICheckNameResult + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Test-AzKustoDataConnectionNameAvailability.md b/azps-10.1.0/Az.Kusto/Test-AzKustoDataConnectionNameAvailability.md new file mode 100644 index 0000000000..5c5105d1d2 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Test-AzKustoDataConnectionNameAvailability.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/test-azkustodataconnectionnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoDataConnectionNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoDataConnectionNameAvailability.md +--- + +# Test-AzKustoDataConnectionNameAvailability + +## SYNOPSIS +Checks that the data connection name is valid and is not already in use. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzKustoDataConnectionNameAvailability -ClusterName <String> -DatabaseName <String> + -ResourceGroupName <String> -Name <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzKustoDataConnectionNameAvailability -InputObject <IKustoIdentity> -Name <String> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Checks that the data connection name is valid and is not already in use. + +## EXAMPLES + +### Example 1: Check the availability of a Data Connection name which is in use +```powershell +Test-AzKustoDataConnectionNameAvailability -ClusterName testnewkustocluster -DatabaseName mykustodatabase -ResourceGroupName testrg -Name mykustodataconnection +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ +Data Connection mykustodataconnection already exists in database mykustodatabase in cluster testnewkustocluster. Please select a different data connection name. mykustodataconnection False AlreadyExists +``` + +The above command returns whether or not a Data Connection named "mykustodataconnection" exists in the "mykustodatabase" database. + +### Example 2: Check the availability of a Data Connection name which is not in use +```powershell +Test-AzKustoDataConnectionNameAvailability -ClusterName testnewkustocluster -DatabaseName mykustodatabase -ResourceGroupName testrg -Name mydataconnection +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ + mydataconnection True +``` + +The above command returns whether or not a Data Connection named "mydataconnection" exists in the "mykustodatabase" database. + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Data Connection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ICheckNameResult + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Test-AzKustoDatabaseNameAvailability.md b/azps-10.1.0/Az.Kusto/Test-AzKustoDatabaseNameAvailability.md new file mode 100644 index 0000000000..439f948e12 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Test-AzKustoDatabaseNameAvailability.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/test-azkustodatabasenameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoDatabaseNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoDatabaseNameAvailability.md +--- + +# Test-AzKustoDatabaseNameAvailability + +## SYNOPSIS +Checks that the databases resource name is valid and is not already in use. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzKustoDatabaseNameAvailability -ClusterName <String> -ResourceGroupName <String> -Name <String> + -Type <Type> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzKustoDatabaseNameAvailability -InputObject <IKustoIdentity> -Name <String> -Type <Type> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Checks that the databases resource name is valid and is not already in use. + +## EXAMPLES + +### Example 1: Check the availability of a Kusto database name which is in use +```powershell +Test-AzKustoDatabaseNameAvailability -ResourceGroupName testrg -ClusterName testnewkustocluster -Name mykustodatabase -Type Microsoft.Kusto/Clusters/Databases +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ +Database mykustodatabase already exists in cluster testnewkustocluster. Please select a different database name. mykustodatabase False +``` + +The above command returns whether or not a Kusto database named "mykustodatabase" exists in the "testnewkustocluster" cluster. + +### Example 2: Check the availability of a Kusto database name which is not in use +```powershell +Test-AzKustoDatabaseNameAvailability -ResourceGroupName testrg -ClusterName testnewkustocluster -Name mykustodatabase2 -Type Microsoft.Kusto/Clusters/Databases +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ + mykustodatabase2 True +``` + +The above command returns whether or not a Kusto database named "mykustodatabase2" exists in the "testnewkustocluster" cluster. + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The type of resource, for instance Microsoft.Kusto/Clusters/databases. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Type +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ICheckNameResult + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md b/azps-10.1.0/Az.Kusto/Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md new file mode 100644 index 0000000000..9ce837a1b0 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/test-azkustodatabaseprincipalassignmentnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md +--- + +# Test-AzKustoDatabasePrincipalAssignmentNameAvailability + +## SYNOPSIS +Checks that the database principal assignment is valid and is not already in use. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzKustoDatabasePrincipalAssignmentNameAvailability -ClusterName <String> -DatabaseName <String> + -ResourceGroupName <String> -Name <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzKustoDatabasePrincipalAssignmentNameAvailability -InputObject <IKustoIdentity> -Name <String> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Checks that the database principal assignment is valid and is not already in use. + +## EXAMPLES + +### Example 1: Check the availability of a database principalassignment name which is in use +```powershell +Test-AzKustoDatabasePrincipalAssignmentNameAvailability -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -Name "myprincipal" +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ +Database principal assignment myprincipal already exists in database mykustodatabase. Please select a different principal assignment name. myprincipal False +``` + +The above command returns whether or not a PrincipalAssignment named "myprincipal" exists in the database "mykustodatabase" from cluster "testnewkustocluster". + +### Example 2: Check the availability of a database principalassignment name which is not in use +```powershell +Test-AzKustoDatabasePrincipalAssignmentNameAvailability -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -Name "newprincipal" +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ + availablekustocluster True +``` + +The above command returns whether or not a PrincipalAssignment named "myprincipal" exists in the database "mykustodatabase" from cluster "testnewkustocluster" . + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Principal Assignment resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ICheckNameResult + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Test-AzKustoManagedPrivateEndpointNameAvailability.md b/azps-10.1.0/Az.Kusto/Test-AzKustoManagedPrivateEndpointNameAvailability.md new file mode 100644 index 0000000000..abc2484130 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Test-AzKustoManagedPrivateEndpointNameAvailability.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/test-azkustomanagedprivateendpointnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoManagedPrivateEndpointNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoManagedPrivateEndpointNameAvailability.md +--- + +# Test-AzKustoManagedPrivateEndpointNameAvailability + +## SYNOPSIS +Checks that the managed private endpoints resource name is valid and is not already in use. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzKustoManagedPrivateEndpointNameAvailability -ClusterName <String> -ResourceGroupName <String> + -Name <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzKustoManagedPrivateEndpointNameAvailability -InputObject <IKustoIdentity> -Name <String> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Checks that the managed private endpoints resource name is valid and is not already in use. + +## EXAMPLES + +### Example 1: Checks whether the ManagedPrivateEndpoint name is available in the given cluster +```powershell +Test-AzKustoManagedPrivateEndpointNameAvailability -ClusterName "mycluster" -ResourceGroupName "testrg" -Name "testmanagedprivateendpoint" +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ + testmanagedprivateendpoint True +``` + +The above command returns whether or not a ManagedPrivateEndpoint name is available in the cluster named "mycluster" in resource group "testrg". + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Managed private endpoint resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ICheckNameResult + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Test-AzKustoScriptNameAvailability.md b/azps-10.1.0/Az.Kusto/Test-AzKustoScriptNameAvailability.md new file mode 100644 index 0000000000..9b5a6f7e12 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Test-AzKustoScriptNameAvailability.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/test-azkustoscriptnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoScriptNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Test-AzKustoScriptNameAvailability.md +--- + +# Test-AzKustoScriptNameAvailability + +## SYNOPSIS +Checks that the script name is valid and is not already in use. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzKustoScriptNameAvailability -ClusterName <String> -DatabaseName <String> -ResourceGroupName <String> + -Name <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzKustoScriptNameAvailability -InputObject <IKustoIdentity> -Name <String> [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Checks that the script name is valid and is not already in use. + +## EXAMPLES + +### Example 1: Check that the script name which is not in use +```powershell +Test-AzKustoScriptNameAvailability -ClusterName testnewkustocluster -DatabaseName mykustodatabase -ResourceGroupName testrg -Name newkustoscript +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ + newkustoscript True +``` + +The above command checks that the script name which is not in use. + +### Example 2: Check that the script name which is not valid +```powershell +Test-AzKustoScriptNameAvailability -ClusterName testnewkustocluster -DatabaseName mykustodatabase -ResourceGroupName testrg -Name newkustoscript! +``` + +```output +Message Name NameAvailable Reason +------- ---- ------------- ------ +Script: Name='newkustoscript!' does not comply with naming rules (contains invalid characters or format mismatch) newkustoscript! False +``` + +The above command checks that the script name which is not valid. + +## PARAMETERS + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Script name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ICheckNameResult + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Update-AzKustoCluster.md b/azps-10.1.0/Az.Kusto/Update-AzKustoCluster.md new file mode 100644 index 0000000000..503bd7f487 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Update-AzKustoCluster.md @@ -0,0 +1,794 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/update-azkustocluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Update-AzKustoCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Update-AzKustoCluster.md +--- + +# Update-AzKustoCluster + +## SYNOPSIS +Update a Kusto cluster. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzKustoCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IfMatch <String>] [-AcceptedAudience <IAcceptedAudiences[]>] [-AllowedFqdnList <String[]>] + [-AllowedIPRangeList <String[]>] [-EnableAutoStop] [-EnableDiskEncryption] [-EnableDoubleEncryption] + [-EnablePurge] [-EnableStreamingIngest] [-EngineType <EngineType>] [-IdentityType <IdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-KeyVaultPropertyKeyName <String>] + [-KeyVaultPropertyKeyVaultUri <String>] [-KeyVaultPropertyKeyVersion <String>] + [-KeyVaultPropertyUserIdentity <String>] [-LanguageExtensionValue <ILanguageExtension[]>] + [-Location <String>] [-OptimizedAutoscaleIsEnabled] [-OptimizedAutoscaleMaximum <Int32>] + [-OptimizedAutoscaleMinimum <Int32>] [-OptimizedAutoscaleVersion <Int32>] [-PublicIPType <PublicIPType>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-RestrictOutboundNetworkAccess <ClusterNetworkAccessFlag>] + [-SkuCapacity <Int32>] [-SkuName <AzureSkuName>] [-SkuTier <AzureSkuTier>] [-Tag <Hashtable>] + [-TrustedExternalTenant <ITrustedExternalTenant[]>] [-VirtualClusterGraduationProperty <String>] + [-VirtualNetworkConfigurationDataManagementPublicIPId <String>] + [-VirtualNetworkConfigurationEnginePublicIPId <String>] [-VirtualNetworkConfigurationSubnetId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzKustoCluster -InputObject <IKustoIdentity> [-IfMatch <String>] + [-AcceptedAudience <IAcceptedAudiences[]>] [-AllowedFqdnList <String[]>] [-AllowedIPRangeList <String[]>] + [-EnableAutoStop] [-EnableDiskEncryption] [-EnableDoubleEncryption] [-EnablePurge] [-EnableStreamingIngest] + [-EngineType <EngineType>] [-IdentityType <IdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] + [-KeyVaultPropertyKeyName <String>] [-KeyVaultPropertyKeyVaultUri <String>] + [-KeyVaultPropertyKeyVersion <String>] [-KeyVaultPropertyUserIdentity <String>] + [-LanguageExtensionValue <ILanguageExtension[]>] [-Location <String>] [-OptimizedAutoscaleIsEnabled] + [-OptimizedAutoscaleMaximum <Int32>] [-OptimizedAutoscaleMinimum <Int32>] + [-OptimizedAutoscaleVersion <Int32>] [-PublicIPType <PublicIPType>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-RestrictOutboundNetworkAccess <ClusterNetworkAccessFlag>] + [-SkuCapacity <Int32>] [-SkuName <AzureSkuName>] [-SkuTier <AzureSkuTier>] [-Tag <Hashtable>] + [-TrustedExternalTenant <ITrustedExternalTenant[]>] [-VirtualClusterGraduationProperty <String>] + [-VirtualNetworkConfigurationDataManagementPublicIPId <String>] + [-VirtualNetworkConfigurationEnginePublicIPId <String>] [-VirtualNetworkConfigurationSubnetId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a Kusto cluster. + +## EXAMPLES + +### Example 1: Update an existing cluster by name +```powershell +Update-AzKustoCluster -ResourceGroupName testrg -Name testnewkustocluster -SkuName Standard_D12_v2 -SkuTier Standard -EngineType 'V2' +``` + +```output +Location Name Type Zone +-------- ---- ---- ---- +East US testnewkustocluster Microsoft.Kusto/Clusters +``` + +The above command updates the sku of the Kusto cluster "testnewkustocluster" found in the resource group "testrg". + +### Example 2: Update an existing cluster by name +```powershell +Update-AzKustoCluster -ResourceGroupName testrg -Name testnewkustocluster -KeyVaultPropertyKeyName "TestKey" -KeyVaultPropertyKeyVaultUri "https://testpskeyvault.vault.azure.net" -KeyVaultPropertyKeyVersion "4bd66f0e0d7c403fac80305e0355d982" +``` + +```output +Location Name Type Zone +-------- ---- ---- ---- +East US testnewkustocluster Microsoft.Kusto/Clusters +``` + +The above command updates the cluster "testnewkustocluster" found in the resource group "testrg" with a customer managed key. + +## PARAMETERS + +### -AcceptedAudience +The cluster's accepted audiences. +To construct, see NOTES section for ACCEPTEDAUDIENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IAcceptedAudiences[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedFqdnList +List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedIPRangeList +The list of ips in the format of CIDR allowed to connect to the cluster. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoStop +A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDiskEncryption +A boolean value that indicates if the cluster's disks are encrypted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDoubleEncryption +A boolean value that indicates if double encryption is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePurge +A boolean value that indicates if the purge operations are enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableStreamingIngest +A boolean value that indicates if the streaming ingest is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EngineType +The engine type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.EngineType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The type of managed identity used. +The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. +The type 'None' will remove all identities. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.IdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +The list of user identities associated with the Kusto cluster. +The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the cluster. +Omit this value to always overwrite the current cluster. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyName +The name of the key vault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyVaultUri +The Uri of the key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyVersion +The version of the key vault key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyUserIdentity +The user assigned identity (ARM resource id) that has access to the key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LanguageExtensionValue +The list of language extensions. +To construct, see NOTES section for LANGUAGEEXTENSIONVALUE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ILanguageExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleIsEnabled +A boolean value that indicate if the optimized autoscale feature is enabled or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleMaximum +Maximum allowed instances count. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleMinimum +Minimum allowed instances count. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleVersion +The version of the template defined, for instance 1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIPType +Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PublicIPType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Public network access to the cluster is enabled by default. +When disabled, only private endpoint connection to the cluster is allowed + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictOutboundNetworkAccess +Whether or not to restrict outbound network access. +Value is optional but if passed in, must be 'Enabled' or 'Disabled' + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.ClusterNetworkAccessFlag +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +The number of instances of the cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +SKU name. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.AzureSkuName +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +SKU tier. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.AzureSkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedExternalTenant +The cluster's external tenants. +To construct, see NOTES section for TRUSTEDEXTERNALTENANT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.ITrustedExternalTenant[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualClusterGraduationProperty +Virtual Cluster graduation properties + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkConfigurationDataManagementPublicIPId +Data management's service public IP address resource id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkConfigurationEnginePublicIPId +Engine service's public IP address resource id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkConfigurationSubnetId +The subnet resource id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.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. + + +`ACCEPTEDAUDIENCE <IAcceptedAudiences[]>`: The cluster's accepted audiences. + - `[Value <String>]`: GUID or valid URL representing an accepted audience. + +`INPUTOBJECT <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`LANGUAGEEXTENSIONVALUE <ILanguageExtension[]>`: The list of language extensions. + - `[ImageName <LanguageExtensionImageName?>]`: The language extension image name. + - `[Name <LanguageExtensionName?>]`: The language extension name. + +`TRUSTEDEXTERNALTENANT <ITrustedExternalTenant[]>`: The cluster's external tenants. + - `[Value <String>]`: GUID representing an external tenant. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Update-AzKustoDataConnection.md b/azps-10.1.0/Az.Kusto/Update-AzKustoDataConnection.md new file mode 100644 index 0000000000..7d105715c1 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Update-AzKustoDataConnection.md @@ -0,0 +1,708 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/update-azkustodataconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Update-AzKustoDataConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Update-AzKustoDataConnection.md +--- + +# Update-AzKustoDataConnection + +## SYNOPSIS +Updates a data connection. + +## SYNTAX + +### UpdateExpandedEventHub (Default) +``` +Update-AzKustoDataConnection -ClusterName <String> -DatabaseName <String> -Name <String> + -ResourceGroupName <String> -ConsumerGroup <String> -EventHubResourceId <String> -Kind <Kind> + -Location <String> [-SubscriptionId <String>] [-Compression <Compression>] + [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] [-EventSystemProperty <String[]>] + [-ManagedIdentityResourceId <String>] [-MappingRuleName <String>] [-RetrievalStartDate <DateTime>] + [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateExpandedCosmosDb +``` +Update-AzKustoDataConnection -ClusterName <String> -DatabaseName <String> -Name <String> + -ResourceGroupName <String> -CosmosDbAccountResourceId <String> -CosmosDbContainer <String> + -CosmosDbDatabase <String> -Kind <Kind> -Location <String> -ManagedIdentityResourceId <String> + -TableName <String> [-SubscriptionId <String>] [-MappingRuleName <String>] [-RetrievalStartDate <DateTime>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateExpandedEventGrid +``` +Update-AzKustoDataConnection -ClusterName <String> -DatabaseName <String> -Name <String> + -ResourceGroupName <String> -ConsumerGroup <String> -EventHubResourceId <String> -Kind <Kind> + -Location <String> -StorageAccountResourceId <String> [-SubscriptionId <String>] + [-BlobStorageEventType <BlobStorageEventType>] [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] + [-EventGridResourceId <String>] [-IgnoreFirstRecord] [-ManagedIdentityResourceId <String>] + [-MappingRuleName <String>] [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateExpandedIotHub +``` +Update-AzKustoDataConnection -ClusterName <String> -DatabaseName <String> -Name <String> + -ResourceGroupName <String> -ConsumerGroup <String> -IotHubResourceId <String> -Kind <Kind> + -Location <String> -SharedAccessPolicyName <String> [-SubscriptionId <String>] + [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] [-EventSystemProperty <String[]>] + [-MappingRuleName <String>] [-RetrievalStartDate <DateTime>] [-TableName <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpandedCosmosDb +``` +Update-AzKustoDataConnection -InputObject <IKustoIdentity> -CosmosDbAccountResourceId <String> + -CosmosDbContainer <String> -CosmosDbDatabase <String> -Kind <Kind> -Location <String> + -ManagedIdentityResourceId <String> -TableName <String> [-MappingRuleName <String>] + [-RetrievalStartDate <DateTime>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpandedEventGrid +``` +Update-AzKustoDataConnection -InputObject <IKustoIdentity> -ConsumerGroup <String> + -EventHubResourceId <String> -Kind <Kind> -Location <String> -StorageAccountResourceId <String> + [-BlobStorageEventType <BlobStorageEventType>] [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] + [-EventGridResourceId <String>] [-IgnoreFirstRecord] [-ManagedIdentityResourceId <String>] + [-MappingRuleName <String>] [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpandedEventHub +``` +Update-AzKustoDataConnection -InputObject <IKustoIdentity> -ConsumerGroup <String> + -EventHubResourceId <String> -Kind <Kind> -Location <String> [-Compression <Compression>] + [-DatabaseRouting <DatabaseRouting>] [-DataFormat <String>] [-EventSystemProperty <String[]>] + [-ManagedIdentityResourceId <String>] [-MappingRuleName <String>] [-RetrievalStartDate <DateTime>] + [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpandedIotHub +``` +Update-AzKustoDataConnection -InputObject <IKustoIdentity> -ConsumerGroup <String> -IotHubResourceId <String> + -Kind <Kind> -Location <String> -SharedAccessPolicyName <String> [-DatabaseRouting <DatabaseRouting>] + [-DataFormat <String>] [-EventSystemProperty <String[]>] [-MappingRuleName <String>] + [-RetrievalStartDate <DateTime>] [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a data connection. + +## EXAMPLES + +### Example 1: Update an existing EventHub data connection +```powershell +Update-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventhubdc" -Location "East US" -Kind "EventHub" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -DataFormat "JSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "NewEventsMapping" +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +EventHub East US testnewkustocluster/mykustodatabase/myeventhubdc Microsoft.Kusto/Clusters/Databases/DataConnections +``` + +The above command updates the existing EventHub data connection named "myeventhubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +### Example 2: Update an existing EventGrid data connection +```powershell +Update-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventgriddc" -Location "East US" -Kind "EventGrid" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -StorageAccountResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Storage/storageAccounts/mystorage" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "NewEventsMapping" +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +EventGrid East US testnewkustocluster/mykustodatabase/myeventgriddc Microsoft.Kusto/Clusters/Databases/DataConnections +``` + +The above command updates the existing EventGrid data connection named "myeventgriddc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +### Example 3: Update an existing IotHub data connection +```powershell +Update-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myiothubdc" -Location "East US" -Kind "IotHub" -IotHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Devices/IotHubs/myiothub" -SharedAccessPolicyName "myiothubpolicy" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "NewEventsMapping" +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +IotHub East US testnewkustocluster/mykustodatabase/myiothubdc Microsoft.Kusto/Clusters/Databases/DataConnections +``` + +The above command updates the existing IotHub data connection named "myiothubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +### Example 4: Update an existing EventHub data connection via identity +```powershell +$dataConnection = Get-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventhubdc" +Update-AzKustoDataConnection -InputObject $dataConnection -Location "East US" -Kind "EventHub" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -DataFormat "JSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "NewEventsMapping" +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +EventHub East US testnewkustocluster/mykustodatabase/myeventhubdc Microsoft.Kusto/Clusters/Databases/DataConnections +``` + +The above command updates the existing EventHub data connection named "myeventhubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +### Example 5: Update an existing EventGrid data connection via identity +```powershell +$dataConnection = Get-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventgriddc" +Update-AzKustoDataConnection -InputObject $dataConnection -Location "East US" -Kind "EventGrid" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -StorageAccountResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Storage/storageAccounts/mystorage" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "NewEventsMapping" +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +EventGrid East US testnewkustocluster/mykustodatabase/myeventgriddc Microsoft.Kusto/Clusters/Databases/DataConnections +``` + +The above command updates the existing EventGrid data connection named "myeventgriddc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +### Example 6: Update an existing IotHub data connection via identity +```powershell +$dataConnection = Get-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myiothubdc" +Update-AzKustoDataConnection -InputObject $dataConnection -Location "East US" -Kind "IotHub" -IotHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Devices/IotHubs/myiothub" -SharedAccessPolicyName "myiothubpolicy" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "NewEventsMapping" +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +IotHub East US testnewkustocluster/mykustodatabase/myiothubdc Microsoft.Kusto/Clusters/Databases/DataConnections +``` + +The above command updates the existing IotHub data connection named "myiothubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobStorageEventType +The name of blob storage event type to process. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.BlobStorageEventType +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compression +The event hub messages compression type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Compression +Parameter Sets: UpdateExpandedEventHub, UpdateViaIdentityExpandedEventHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsumerGroup +The event/iot hub consumer group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CosmosDbAccountResourceId +The resource ID of the Cosmos DB account used to create the data connection. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedCosmosDb, UpdateViaIdentityExpandedCosmosDb +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CosmosDbContainer +The name of an existing container in the Cosmos DB database. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedCosmosDb, UpdateViaIdentityExpandedCosmosDb +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CosmosDbDatabase +The name of an existing database in the Cosmos DB account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedCosmosDb, UpdateViaIdentityExpandedCosmosDb +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseRouting +Indication for database routing information from the data connection, by default only database routing information is allowed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabaseRouting +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFormat +The data format of the message. +Optionally the data format can be added to each message. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventGridResourceId +The resource ID of the event grid that is subscribed to the storage account events. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubResourceId +The resource ID of the event hub to be used to create a data connection / event grid is configured to send events. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSystemProperty +System properties of the event/iot hub. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreFirstRecord +If set to true, indicates that ingestion should ignore the first record of every file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +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.Kusto.Models.IKustoIdentity +Parameter Sets: UpdateViaIdentityExpandedCosmosDb, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubResourceId +The resource ID of the Iot hub to be used to create a data connection. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedIotHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the endpoint for the data connection + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedIdentityResourceId +The resource ID of a managed identity (system or user assigned) to be used to authenticate with external resources. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateViaIdentityExpandedCosmosDb, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MappingRuleName +The mapping rule to be used to ingest the data. +Optionally the mapping information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the data connection. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: DataConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetrievalStartDate +When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. +It can only retrieve events retained by the Event hub, based on its retention period. + +```yaml +Type: System.DateTime +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaIdentityExpandedCosmosDb, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedAccessPolicyName +The name of the share access policy. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedIotHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The resource ID of the storage account where the data resides. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableName +The table where the data should be ingested. +Optionally the table information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDataConnection + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Update-AzKustoDatabase.md b/azps-10.1.0/Az.Kusto/Update-AzKustoDatabase.md new file mode 100644 index 0000000000..4412d60b93 --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Update-AzKustoDatabase.md @@ -0,0 +1,365 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/update-azkustodatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Update-AzKustoDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Update-AzKustoDatabase.md +--- + +# Update-AzKustoDatabase + +## SYNOPSIS +Updates a database. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzKustoDatabase -ClusterName <String> -Name <String> -ResourceGroupName <String> -Kind <Kind> + -Location <String> [-SubscriptionId <String>] [-CallerRole <CallerRole>] [-HotCachePeriod <TimeSpan>] + [-SoftDeletePeriod <TimeSpan>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzKustoDatabase -InputObject <IKustoIdentity> -Kind <Kind> -Location <String> + [-CallerRole <CallerRole>] [-HotCachePeriod <TimeSpan>] [-SoftDeletePeriod <TimeSpan>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a database. + +## EXAMPLES + +### Example 1: Update an existing database by name +```powershell +$2ds = New-TimeSpan -Days 2 +$4ds = New-TimeSpan -Days 4 +Update-AzKustoDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster -Name mykustodatabase -Kind ReadWrite -SoftDeletePeriod $4ds -HotCachePeriod $2ds -Location 'East US' +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +ReadWrite East US testnewkustocluster/mykustodatabase Microsoft.Kusto/Clusters/Databases +``` + +The above command updates the soft deletion period and hot cache period of the Kusto database "mykustodatabase" in the cluster "testnewkustocluster" found in the resource group "testrg". + +### Example 2: Update an existing database via identity +```powershell +$database = Get-AzKustoDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster -Name mykustodatabase +$2ds = New-TimeSpan -Days 2 +$4ds = New-TimeSpan -Days 4 +Update-AzKustoDatabase -InputObject $database -Kind ReadWrite -SoftDeletePeriod $4ds -HotCachePeriod $2ds -Location 'East US' +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +ReadWrite East US testnewkustocluster/mykustodatabase Microsoft.Kusto/Clusters/Databases +``` + +The above command updates the soft deletion period and hot cache period of the Kusto database "mykustodatabase" in the cluster "testnewkustocluster" found in the resource group "testrg". + +### Example 3: Update an existing ReadOnly database by name +```powershell +$2ds = New-TimeSpan -Days 2 +Update-AzKustoDatabase -ResourceGroupName testrg -ClusterName myfollowercluster -Name mykustodatabase -Kind ReadOnlyFollowing -HotCachePeriod $2ds -Location 'East US' +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +ReadOnlyFollowing East US myfollowercluster/mykustodatabase Microsoft.Kusto/Clusters/Databases +``` + +The above command updates the hot cache period of the Kusto database "mykustodatabase" in the cluster "myfollowercluster" found in the resource group "testrg". + +### Example 4: Update an existing ReadOnly database via identity +```powershell +$database = Get-AzKustoDatabase -ResourceGroupName testrg -ClusterName myfollowercluster -Name mykustodatabase +$2ds = New-TimeSpan -Days 2 +Update-AzKustoDatabase -InputObject $database -Kind ReadOnlyFollowing -HotCachePeriod $2ds -Location 'East US' +``` + +```output +Kind Location Name Type +---- -------- ---- ---- +ReadOnlyFollowing East US myfollowercluster/mykustodatabase Microsoft.Kusto/Clusters/Databases +``` + +The above command updates the hot cache period of the Kusto database "mykustodatabase" in the cluster "myfollowercluster" found in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallerRole +By default, any user who run operation on a database become an Admin on it. +This property allows the caller to exclude the caller from Admins list. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.CallerRole +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HotCachePeriod +The time the data should be kept in cache for fast queries in TimeSpan. + +```yaml +Type: System.TimeSpan +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.Kusto.Models.IKustoIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Kind of the database + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: DatabaseName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletePeriod +The time the data should be kept before it stops being accessible to queries in TimeSpan. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IDatabase + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Update-AzKustoManagedPrivateEndpoint.md b/azps-10.1.0/Az.Kusto/Update-AzKustoManagedPrivateEndpoint.md new file mode 100644 index 0000000000..d665fb572b --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Update-AzKustoManagedPrivateEndpoint.md @@ -0,0 +1,347 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/update-azkustomanagedprivateendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Update-AzKustoManagedPrivateEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Update-AzKustoManagedPrivateEndpoint.md +--- + +# Update-AzKustoManagedPrivateEndpoint + +## SYNOPSIS +Updates a managed private endpoint. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzKustoManagedPrivateEndpoint -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-GroupId <String>] [-PrivateLinkResourceId <String>] + [-PrivateLinkResourceRegion <String>] [-RequestMessage <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Update +``` +Update-AzKustoManagedPrivateEndpoint -ClusterName <String> -Name <String> -ResourceGroupName <String> + -Parameter <IManagedPrivateEndpoint> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzKustoManagedPrivateEndpoint -InputObject <IKustoIdentity> -Parameter <IManagedPrivateEndpoint> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzKustoManagedPrivateEndpoint -InputObject <IKustoIdentity> [-GroupId <String>] + [-PrivateLinkResourceId <String>] [-PrivateLinkResourceRegion <String>] [-RequestMessage <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a managed private endpoint. + +## EXAMPLES + +### Example 1: Update an existing ManagedPrivateEndpoint +```powershell +Update-AzKustoManagedPrivateEndpoint -ResourceGroupName "testrg" -ClusterName "mycluster" -Name "ManagedPrivateEndpointName" -RequestMessage "Please Approve Managed Private Endpoint Request." -GroupId "blob" -PrivateLinkResourceId "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/storageAccountTest" +``` + +```output +Name Type +---- ---- +ManagedPrivateEndpointName Microsoft.Kusto/Clusters/ManagedPrivateEndpoints +``` + +The above command updates the existing ManagedPrivateEndpoint named "ManagedPrivateEndpointName" in the cluster "mycluster". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +The groupId in which the managed private endpoint is created. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the managed private endpoint. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: ManagedPrivateEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Class representing a managed private endpoint. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IManagedPrivateEndpoint +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateLinkResourceId +The ARM resource ID of the resource for which the managed private endpoint is created. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkResourceRegion +The region of the resource to which the managed private endpoint is created. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestMessage +The user request message. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IManagedPrivateEndpoint + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IManagedPrivateEndpoint + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`PARAMETER <IManagedPrivateEndpoint>`: Class representing a managed private endpoint. + - `[AzureAsyncOperation <String>]`: + - `[GroupId <String>]`: The groupId in which the managed private endpoint is created. + - `[PrivateLinkResourceId <String>]`: The ARM resource ID of the resource for which the managed private endpoint is created. + - `[PrivateLinkResourceRegion <String>]`: The region of the resource to which the managed private endpoint is created. + - `[RequestMessage <String>]`: The user request message. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Kusto/Update-AzKustoScript.md b/azps-10.1.0/Az.Kusto/Update-AzKustoScript.md new file mode 100644 index 0000000000..475dafde2c --- /dev/null +++ b/azps-10.1.0/Az.Kusto/Update-AzKustoScript.md @@ -0,0 +1,383 @@ +--- +external help file: +Module Name: Az.Kusto +online version: https://learn.microsoft.com/powershell/module/az.kusto/update-azkustoscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Update-AzKustoScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Kusto/help/Update-AzKustoScript.md +--- + +# Update-AzKustoScript + +## SYNOPSIS +Updates a database script. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzKustoScript -ClusterName <String> -DatabaseName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-ContinueOnError] [-ForceUpdateTag <String>] [-ScriptContent <String>] + [-ScriptUrl <String>] [-ScriptUrlSasToken <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Update +``` +Update-AzKustoScript -ClusterName <String> -DatabaseName <String> -Name <String> -ResourceGroupName <String> + -Parameter <IScript> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzKustoScript -InputObject <IKustoIdentity> -Parameter <IScript> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzKustoScript -InputObject <IKustoIdentity> [-ContinueOnError] [-ForceUpdateTag <String>] + [-ScriptContent <String>] [-ScriptUrl <String>] [-ScriptUrlSasToken <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a database script. + +## EXAMPLES + +### Example 1: Update an existing kusto script by name +```powershell +Update-AzKustoScript -DatabaseName mykustodatabase -Name newkustoscript -ClusterName testnewkustocluster -ResourceGroupName testrg -ScriptUrl $BlobSASURL -ScriptUrlSasToken $BlobSASToken +``` + +```output +Name Type +---- ---- +testnewkustocluster/mykustodatabase/newkustoscript Microsoft.Kusto/Clusters/Databases/Scripts +``` + +The above command updates the Kusto script "newkustoscript" found in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinueOnError +Flag that indicates whether to continue if one of the command fails. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpdateTag +A unique string. +If changed the script will be applied again. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto database script. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: ScriptName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Class representing a database script. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IScript +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the Kusto cluster. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptContent +The script content. +This property should be used when the script is provide inline and not through file in a SA. +Must not be used together with scriptUrl and scriptUrlSasToken properties. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptUrl +The url to the KQL script blob file. +Must not be used together with scriptContent property + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptUrlSasToken +The SaS token that provide read access to the file which contain the script. +Must be provided when using scriptUrl property. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IScript + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20221229.IScript + +## 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 <IKustoIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[ClusterName <String>]`: The name of the Kusto cluster. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto cluster. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure location (region) name. + - `[ManagedPrivateEndpointName <String>]`: The name of the managed private endpoint. + - `[OperationId <String>]`: The Guid of the operation ID + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection. + - `[PrivateLinkResourceName <String>]`: The name of the private link resource. + - `[ResourceGroupName <String>]`: The name of the resource group containing the Kusto cluster. + - `[ScriptName <String>]`: The name of the Kusto database script. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`PARAMETER <IScript>`: Class representing a database script. + - `[AzureAsyncOperation <String>]`: + - `[Content <String>]`: The script content. This property should be used when the script is provide inline and not through file in a SA. Must not be used together with scriptUrl and scriptUrlSasToken properties. + - `[ContinueOnError <Boolean?>]`: Flag that indicates whether to continue if one of the command fails. + - `[ForceUpdateTag <String>]`: A unique string. If changed the script will be applied again. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Url <String>]`: The url to the KQL script blob file. Must not be used together with scriptContent property + - `[UrlSasToken <String>]`: The SaS token that provide read access to the file which contain the script. Must be provided when using scriptUrl property. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Add-AzLabServicesUserQuota.md b/azps-10.1.0/Az.LabServices/Add-AzLabServicesUserQuota.md new file mode 100644 index 0000000000..5d68338d5f --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Add-AzLabServicesUserQuota.md @@ -0,0 +1,247 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/add-azlabservicesuserquota +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Add-AzLabServicesUserQuota.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Add-AzLabServicesUserQuota.md +--- + +# Add-AzLabServicesUserQuota + +## SYNOPSIS +API to add additional user quota. + +## SYNTAX + +### User (Default) +``` +Add-AzLabServicesUserQuota -UsageQuotaToAddToExisting <TimeSpan> -User <User> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Email +``` +Add-AzLabServicesUserQuota -Email <String> -LabName <String> -ResourceGroupName <String> + -UsageQuotaToAddToExisting <TimeSpan> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +API to add additional user quota. + +## EXAMPLES + +### Example 1: Increase student usage quota. +```powershell +Add-AzLabServicesUserQuota -ResourceGroupName "group name" -LabName "lab name" -Email 'student@contoso.com' -UsageQuotaToAddToExisting $(New-Timespan -Hours 4) +``` + +```output +Name Type +---- ---- +testuser Microsoft.LabServices/labs/users +``` + +This command increase the students quota by 4 hours. + +### Example 2: Increase student usage quota with User object. +```powershell +$user = Get-AzLabServicesUser -ResourceGroupName "group name" -LabName "lab name" -UserName 'ContosoUser12345' +$user | Add-AzLabServicesUserQuota -UsageQuotaToAddToExisting $(New-Timespan -Hours 5) +``` + +```output +Name Type +---- ---- +ContosoUser12345 Microsoft.LabServices/labs/users +``` + +Increase the student quota by 5 hours. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +The name of the user that uniqely identifies it within containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Email +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName + + +```yaml +Type: System.String +Parameter Sets: Email +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: Email +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsageQuotaToAddToExisting +The amount of usage quota time the user gets in addition to the current user quota. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +To construct, see NOTES section for USER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.User +Parameter Sets: User +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.User + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.IUser + +## 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. + + +USER `<User>`: + - `Email <String>`: Email address of the user. + - `[AdditionalUsageQuota <TimeSpan?>]`: The amount of usage quota time the user gets in addition to the lab usage quota. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Az.LabServices.md b/azps-10.1.0/Az.LabServices/Az.LabServices.md new file mode 100644 index 0000000000..5f4e87f714 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Az.LabServices.md @@ -0,0 +1,124 @@ +--- +Module Name: Az.LabServices +Module Guid: f4604f08-6749-40ce-bd25-81074c1119e7 +Download Help Link: https://learn.microsoft.com/powershell/module/az.labservices +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Az.LabServices.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Az.LabServices.md +--- + +# Az.LabServices Module +## Description +Microsoft Azure PowerShell: LabServices cmdlets + +## Az.LabServices Cmdlets +### [Add-AzLabServicesUserQuota](Add-AzLabServicesUserQuota.md) +API to add additional user quota. + +### [Get-AzLabServicesLab](Get-AzLabServicesLab.md) +API to get labs. + +### [Get-AzLabServicesLabForVM](Get-AzLabServicesLabForVM.md) +API to return the lab for a specific VM. + +### [Get-AzLabServicesLabPlan](Get-AzLabServicesLabPlan.md) +Retrieves the properties of a Lab Plan. + +### [Get-AzLabServicesPlanImage](Get-AzLabServicesPlanImage.md) +Gets an image resource. + +### [Get-AzLabServicesSchedule](Get-AzLabServicesSchedule.md) +Returns the properties of a lab Schedule. + +### [Get-AzLabServicesTemplateVM](Get-AzLabServicesTemplateVM.md) +API to get the template vm for the lab. + +### [Get-AzLabServicesUser](Get-AzLabServicesUser.md) +Returns the properties of a lab user. + +### [Get-AzLabServicesUserVM](Get-AzLabServicesUserVM.md) +API to get the assigned vm for the user. + +### [Get-AzLabServicesVM](Get-AzLabServicesVM.md) +Returns the properties for a lab virtual machine. + +### [New-AzLabServicesLab](New-AzLabServicesLab.md) +Operation to create a lab resource. + +### [New-AzLabServicesLabPlan](New-AzLabServicesLabPlan.md) +Operation to create or update a Lab Plan resource. + +### [New-AzLabServicesSchedule](New-AzLabServicesSchedule.md) +Operation to create or update a lab schedule. + +### [New-AzLabServicesUser](New-AzLabServicesUser.md) +Operation to create or update a lab user. + +### [Publish-AzLabServicesLab](Publish-AzLabServicesLab.md) +Publish or re-publish a lab. +This will create or update all lab resources, such as virtual machines. + +### [Remove-AzLabServicesLab](Remove-AzLabServicesLab.md) +Operation to delete a lab resource. + +### [Remove-AzLabServicesLabPlan](Remove-AzLabServicesLabPlan.md) +Operation to delete a Lab Plan resource. +Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container. + +### [Remove-AzLabServicesSchedule](Remove-AzLabServicesSchedule.md) +Operation to delete a schedule resource. + +### [Remove-AzLabServicesUser](Remove-AzLabServicesUser.md) +Operation to delete a user resource. + +### [Reset-AzLabServicesVMPassword](Reset-AzLabServicesVMPassword.md) +Resets a lab virtual machine password. + +### [Save-AzLabServicesLabPlanImage](Save-AzLabServicesLabPlanImage.md) +Saves an image from a lab VM to the attached shared image gallery. + +### [Send-AzLabServicesUserInvite](Send-AzLabServicesUserInvite.md) +Operation to invite a user to a lab. + +### [Start-AzLabServicesUserVM](Start-AzLabServicesUserVM.md) +API to start the assigned vm for the user. + +### [Start-AzLabServicesVM](Start-AzLabServicesVM.md) +Action to start a lab virtual machine. + +### [Start-AzLabServicesVMRedeployment](Start-AzLabServicesVMRedeployment.md) +Action to redeploy a lab virtual machine to a different compute node. +For troubleshooting connectivity. + +### [Stop-AzLabServicesUserVM](Stop-AzLabServicesUserVM.md) +API to stop the assigned vm for the user. + +### [Stop-AzLabServicesVM](Stop-AzLabServicesVM.md) +Action to stop a lab virtual machine. + +### [Sync-AzLabServicesLabUser](Sync-AzLabServicesLabUser.md) +Action used to manually kick off an AAD group sync job. + +### [Update-AzLabServicesLab](Update-AzLabServicesLab.md) +Operation to update a lab resource. + +### [Update-AzLabServicesLabPlan](Update-AzLabServicesLabPlan.md) +Operation to update a Lab Plan resource. + +### [Update-AzLabServicesPlanImage](Update-AzLabServicesPlanImage.md) +Updates an image resource. + +### [Update-AzLabServicesQuota](Update-AzLabServicesQuota.md) +API to update the lab quota. + +### [Update-AzLabServicesSchedule](Update-AzLabServicesSchedule.md) +Operation to update a lab schedule. + +### [Update-AzLabServicesUser](Update-AzLabServicesUser.md) +Operation to update a lab user. + +### [Update-AzLabServicesVMReimage](Update-AzLabServicesVMReimage.md) +Re-image a lab virtual machine. +The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab. + diff --git a/azps-10.1.0/Az.LabServices/Get-AzLabServicesLab.md b/azps-10.1.0/Az.LabServices/Get-AzLabServicesLab.md new file mode 100644 index 0000000000..70c2c28c1e --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Get-AzLabServicesLab.md @@ -0,0 +1,281 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/get-azlabserviceslab +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesLab.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesLab.md +--- + +# Get-AzLabServicesLab + +## SYNOPSIS +API to get labs. + +## SYNTAX + +### ListBySubscription (Default) +``` +Get-AzLabServicesLab [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### LabPlan +``` +Get-AzLabServicesLab -LabPlan <LabPlan> [-Name <String>] [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ListByLabName +``` +Get-AzLabServicesLab -Name <String> [-SubscriptionId <String[]>] [-ResourceGroupName <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ListByResourceGroup +``` +Get-AzLabServicesLab -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzLabServicesLab -ResourceId <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +API to get labs. + +## EXAMPLES + +### Example 1: Get all labs +```powershell +Get-AzLabServicesLab +``` + +```output +Location Name Type +-------- ---- ---- +westus2 Lab1 Microsoft.LabServices/labs +westus2 Lab2 Microsoft.LabServices/labs +westus2 Lab3 Microsoft.LabServices/labs +westus2 Lab4 Microsoft.LabServices/labs +``` + +Returns all labs for the current subscription. + +### Example 2: Get a specific lab +```powershell +Get-AzLabServicesLab -ResourceGroupName 'yourgroupname' -Name 'yourlabname' +``` + +```output +Location Name Type +-------- ---- ---- +westus2 yourlabName Microsoft.LabServices/labs +``` + +Get a specific lab using the resource group name and the lab name. + +### Example 3: Get all labs created with a lab plan +```powershell +$plan = Get-AzLabServicesLabPlan -LabPlanName 'lab plan name' +$plan | Get-AzLabServicesLab -Name 'lab name' +``` + +```output +Location Name Type +-------- ---- ---- +westus2 lab Name Microsoft.LabServices/labs +``` + +Get the specific lab in a lab plan using the lab plan object and the lab name. + +### Example 4: Get labs using wildcards in the lab name. +```powershell +Get-AzLabServicesLab -ResourceGroupName 'group name' -Name '*lab name' +``` + +```output +Location Name Type +-------- ---- ---- +westus2 yourlab Name Microsoft.LabServices/labs +westus2 anotherlab Name Microsoft.LabServices/labs +``` + +Using the Name parameter and a wildcard all labs in the resource group like the name are returned. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabPlan +To construct, see NOTES section for LABPLAN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPlan +Parameter Sets: LabPlan +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name + + +```yaml +Type: System.String +Parameter Sets: LabPlan, ListByLabName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: ListByLabName, ListByResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPlan + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ILab + +## 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. + + +LABPLAN `<LabPlan>`: + - `Location <String>`: The geo-location where the resource lives + - `[AllowedRegion <String[]>]`: The allowed regions for the lab creator to use when creating labs using this lab plan. + - `[DefaultAutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[DefaultAutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[DefaultAutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[DefaultAutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[DefaultAutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[DefaultAutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[DefaultConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[DefaultConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[DefaultConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[DefaultConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[DefaultNetworkProfileSubnetId <String>]`: The external subnet resource id + - `[LinkedLmsInstance <String>]`: Base Url of the lms instance this lab plan can link lab rosters against. + - `[SharedGalleryId <String>]`: Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs. + - `[SupportInfoEmail <String>]`: Support contact email address. + - `[SupportInfoInstruction <String>]`: Support instructions. + - `[SupportInfoPhone <String>]`: Support contact phone number. + - `[SupportInfoUrl <String>]`: Support web address. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Get-AzLabServicesLabForVM.md b/azps-10.1.0/Az.LabServices/Get-AzLabServicesLabForVM.md new file mode 100644 index 0000000000..b5edc980db --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Get-AzLabServicesLabForVM.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/get-azlabserviceslabforvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesLabForVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesLabForVM.md +--- + +# Get-AzLabServicesLabForVM + +## SYNOPSIS +API to return the lab for a specific VM. + +## SYNTAX + +``` +Get-AzLabServicesLabForVM -ResourceId <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +API to return the lab for a specific VM. + +## EXAMPLES + +### Example 1: Get the lab for a Virtual machine. +```powershell +Get-AzLabServicesLabForVm -ResourceId '/subscriptions/<SubscriptionID>/resourceGroups/<GroupName>/providers/Microsoft.LabServices/labs/<labName>/virtualMachines/<VMName>' +``` + +```output +Location Name Type +-------- ---- ---- +westus2 labName Microsoft.LabServices/labs +``` + +Gets the lab based on the VM Id. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ILab + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Get-AzLabServicesLabPlan.md b/azps-10.1.0/Az.LabServices/Get-AzLabServicesLabPlan.md new file mode 100644 index 0000000000..de81fb68a9 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Get-AzLabServicesLabPlan.md @@ -0,0 +1,177 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/get-azlabserviceslabplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesLabPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesLabPlan.md +--- + +# Get-AzLabServicesLabPlan + +## SYNOPSIS +Retrieves the properties of a Lab Plan. + +## SYNTAX + +### List (Default) +``` +Get-AzLabServicesLabPlan [-SubscriptionId <String[]>] [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzLabServicesLabPlan -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzLabServicesLabPlan -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### ListByLabPlanName +``` +Get-AzLabServicesLabPlan -Name <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzLabServicesLabPlan -ResourceId <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the properties of a Lab Plan. + +## EXAMPLES + +### Example 1: Get all lab plans in subscription. +```powershell +Get-AzLabServicesLabPlan +``` + +```output +Location Name Type +-------- ---- ---- +westus2 plan1 Microsoft.LabServices/labPlans +westus2 plan2 Microsoft.LabServices/labPlans +westus2 plan3 Microsoft.LabServices/labPlans +``` + +Returns all lab plans in a subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply to the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the lab plan that uniquely identifies it within containing resource group. +Used in resource URIs and in UI. + +```yaml +Type: System.String +Parameter Sets: Get, ListByLabPlanName +Aliases: LabPlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ILabPlan + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Get-AzLabServicesPlanImage.md b/azps-10.1.0/Az.LabServices/Get-AzLabServicesPlanImage.md new file mode 100644 index 0000000000..52679a73a5 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Get-AzLabServicesPlanImage.md @@ -0,0 +1,284 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/get-azlabservicesplanimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesPlanImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesPlanImage.md +--- + +# Get-AzLabServicesPlanImage + +## SYNOPSIS +Gets an image resource. + +## SYNTAX + +### ResourceId (Default) +``` +Get-AzLabServicesPlanImage -ResourceId <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzLabServicesPlanImage -LabPlanName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### LabPlan +``` +Get-AzLabServicesPlanImage -LabPlan <LabPlan> [-Name <String>] [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzLabServicesPlanImage -LabPlanName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Filter <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ListByDisplayName +``` +Get-AzLabServicesPlanImage -DisplayName <String> -LabPlanName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets an image resource. + +## EXAMPLES + +### Example 1: Get all image in the lab plan. +```powershell +Get-AzLabServicesPlanImage -LabPlanName "Plan Name" -ResourceGroupName "Group Name" +``` + +```output +Name +---- +128technology.128t_networking_platform.128t_networking_platform +128technology.128technology_conductor_hourly.128technology_conductor_hourly_427 +128technology.128technology_conductor_hourly.128technology_conductor_hourly_452 +``` + +Gets all the available images, this is usually a long list of images. + +### Example 2: Get specific image in the lab plan. +```powershell +Get-AzLabServicesPlanImage -LabPlanName "Plan Name" -ResourceGroupName "Group Name" -Name 'canonical.0001-com-ubuntu-server-focal.20_04-lts' +``` + +```output +Name +---- +canonical.0001-com-ubuntu-server-focal.20_04-lts +``` + +Returns the specific image. + +### Example 3: Get specific image using display name. +```powershell +Get-AzLabServicesPlanImage -LabPlanName "Plan Name" -ResourceGroupName "Group Name" -DisplayName 'Ubuntu Server 20.04 LTS' +``` + +```output +Name +---- +canonical.0001-com-ubuntu-server-focal.20_04-lts +``` + +Returns the specific image with the display name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName + + +```yaml +Type: System.String +Parameter Sets: ListByDisplayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply to the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabPlan +To construct, see NOTES section for LABPLAN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPlan +Parameter Sets: LabPlan +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LabPlanName +The name of the lab plan that uniquely identifies it within containing resource group. +Used in resource URIs and in UI. + +```yaml +Type: System.String +Parameter Sets: Get, List, ListByDisplayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The image name. + +```yaml +Type: System.String +Parameter Sets: Get, LabPlan +Aliases: ImageName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List, ListByDisplayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPlan + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.IImage + +## 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. + + +LABPLAN `<LabPlan>`: + - `Location <String>`: The geo-location where the resource lives + - `[AllowedRegion <String[]>]`: The allowed regions for the lab creator to use when creating labs using this lab plan. + - `[DefaultAutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[DefaultAutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[DefaultAutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[DefaultAutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[DefaultAutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[DefaultAutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[DefaultConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[DefaultConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[DefaultConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[DefaultConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[DefaultNetworkProfileSubnetId <String>]`: The external subnet resource id + - `[LinkedLmsInstance <String>]`: Base Url of the lms instance this lab plan can link lab rosters against. + - `[SharedGalleryId <String>]`: Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs. + - `[SupportInfoEmail <String>]`: Support contact email address. + - `[SupportInfoInstruction <String>]`: Support instructions. + - `[SupportInfoPhone <String>]`: Support contact phone number. + - `[SupportInfoUrl <String>]`: Support web address. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Get-AzLabServicesSchedule.md b/azps-10.1.0/Az.LabServices/Get-AzLabServicesSchedule.md new file mode 100644 index 0000000000..47faf3e5a6 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Get-AzLabServicesSchedule.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/get-azlabservicesschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesSchedule.md +--- + +# Get-AzLabServicesSchedule + +## SYNOPSIS +Returns the properties of a lab Schedule. + +## SYNTAX + +### LabObject (Default) +``` +Get-AzLabServicesSchedule -ResourceId <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzLabServicesSchedule -LabName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Lab +``` +Get-AzLabServicesSchedule -Lab <Lab> [-Name <String>] [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzLabServicesSchedule -LabName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Filter <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns the properties of a lab Schedule. + +## EXAMPLES + +### Example 1: Get all schedules for a lab. +```powershell +Get-AzLabServicesSchedule -ResourceGroupName "group name" -LabName "lab name" +``` + +```output +Name Type +---- ---- +schedule Microsoft.LabServices/labs/schedules +secondschedule Microsoft.LabServices/labs/schedules +``` + +Returns all lab schedules. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply to the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the schedule that uniquely identifies it within containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Get, Lab +Aliases: ScheduleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: LabObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ISchedule + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Get-AzLabServicesTemplateVM.md b/azps-10.1.0/Az.LabServices/Get-AzLabServicesTemplateVM.md new file mode 100644 index 0000000000..f4b57e8ca3 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Get-AzLabServicesTemplateVM.md @@ -0,0 +1,196 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/get-azlabservicestemplatevm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesTemplateVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesTemplateVM.md +--- + +# Get-AzLabServicesTemplateVM + +## SYNOPSIS +API to get the template vm for the lab. + +## SYNTAX + +### Get (Default) +``` +Get-AzLabServicesTemplateVM -LabName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Lab +``` +Get-AzLabServicesTemplateVM -Lab <Lab> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +API to get the template vm for the lab. + +## EXAMPLES + +### Example 1: Get the template for the lab. +```powershell +Get-AzLabServicesTemplateVM -ResourceGroupName "group name" -LabName "lab name" +``` + +```output +Name Type +---- ---- +0 Microsoft.LabServices/labs/virtualMachines +``` + +Returns the template VM for the lab. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LabName + + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.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. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Get-AzLabServicesUser.md b/azps-10.1.0/Az.LabServices/Get-AzLabServicesUser.md new file mode 100644 index 0000000000..daaf9b2431 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Get-AzLabServicesUser.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/get-azlabservicesuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesUser.md +--- + +# Get-AzLabServicesUser + +## SYNOPSIS +Returns the properties of a lab user. + +## SYNTAX + +### ResourceId (Default) +``` +Get-AzLabServicesUser -ResourceId <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzLabServicesUser -LabName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Lab +``` +Get-AzLabServicesUser -Lab <Lab> [-Name <String>] [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzLabServicesUser -LabName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Filter <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns the properties of a lab user. + +## EXAMPLES + +### Example 1: Get all users for a lab. +```powershell +Get-AzLabServicesUser -LabName "Lab Name" -ResourceGroupName "Group Name" +``` + +```output +Name +---- +testuser +``` + +Gets all the users for a lab. + +### Example 2: Get user using name +```powershell +Get-AzLabServicesUser -LabName "Lab Name" -ResourceGroupName "Group Name" -Name "testuser" +``` + +```output +Name +---- +testuser +``` + +Gets a specific user from the lab. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply to the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the user that uniquely identifies it within containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Get, Lab +Aliases: UserName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.IUser + +## 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. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Get-AzLabServicesUserVM.md b/azps-10.1.0/Az.LabServices/Get-AzLabServicesUserVM.md new file mode 100644 index 0000000000..6e926a079b --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Get-AzLabServicesUserVM.md @@ -0,0 +1,263 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/get-azlabservicesuservm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesUserVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesUserVM.md +--- + +# Get-AzLabServicesUserVM + +## SYNOPSIS +API to get the assigned vm for the user. + +## SYNTAX + +### ResourceId (Default) +``` +Get-AzLabServicesUserVM -ResourceId <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzLabServicesUserVM -Email <String> -LabName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Lab +``` +Get-AzLabServicesUserVM -Email <String> -Lab <Lab> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### User +``` +Get-AzLabServicesUserVM -User <User> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +API to get the assigned vm for the user. + +## EXAMPLES + +### Example 1: Get the Virtual machine assigned to a specific user. +```powershell +Get-AzLabServicesUserVM -ResourceGroupName "Group Name" -LabName "Lab Name" -Email 'user@contoso.com' +``` + +```output +Name +---- +0 +``` + +Returns the specific machine that is assigned to the user in the lab. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email + + +```yaml +Type: System.String +Parameter Sets: Get, Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName + + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +To construct, see NOTES section for USER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.User +Parameter Sets: User +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.User + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.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. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +USER `<User>`: + - `Email <String>`: Email address of the user. + - `[AdditionalUsageQuota <TimeSpan?>]`: The amount of usage quota time the user gets in addition to the lab usage quota. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Get-AzLabServicesVM.md b/azps-10.1.0/Az.LabServices/Get-AzLabServicesVM.md new file mode 100644 index 0000000000..dd5199264f --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Get-AzLabServicesVM.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/get-azlabservicesvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Get-AzLabServicesVM.md +--- + +# Get-AzLabServicesVM + +## SYNOPSIS +Returns the properties for a lab virtual machine. + +## SYNTAX + +### List (Default) +``` +Get-AzLabServicesVM -LabName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Filter <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzLabServicesVM -LabName <String> -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Lab +``` +Get-AzLabServicesVM -Lab <Lab> [-Name <String>] [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns the properties for a lab virtual machine. + +## EXAMPLES + +### Example 1: Gets all the Virtual machines in the lab. +```powershell +Get-AzLabServicesVM -LabName "Lab Name" -ResourceGroupName "Group Name" +``` + +```output +Name +---- +0 +1 +2 +``` + +Returns all the VMs. + +### Example 2: Gets the specific VM in the lab. +```powershell +Get-AzLabServicesVM -LabName "Lab Name" -ResourceGroupName "Group Name" -Name 2 +``` + +```output +Name +---- +2 +``` + +Returns the specific VM. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply to the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The ID of the virtual machine that uniquely identifies it within the containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Get, Lab +Aliases: VirtualMachineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.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. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/New-AzLabServicesLab.md b/azps-10.1.0/Az.LabServices/New-AzLabServicesLab.md new file mode 100644 index 0000000000..7a680cff22 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/New-AzLabServicesLab.md @@ -0,0 +1,861 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/new-azlabserviceslab +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/New-AzLabServicesLab.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/New-AzLabServicesLab.md +--- + +# New-AzLabServicesLab + +## SYNOPSIS +Operation to create a lab resource. + +## SYNTAX + +``` +New-AzLabServicesLab -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-AdditionalCapabilityInstallGpuDriver <EnableState>] [-AdminUserPassword <SecureString>] + [-AdminUserUsername <String>] [-AutoShutdownProfileDisconnectDelay <TimeSpan>] + [-AutoShutdownProfileIdleDelay <TimeSpan>] [-AutoShutdownProfileNoConnectDelay <TimeSpan>] + [-AutoShutdownProfileShutdownOnDisconnect <EnableState>] + [-AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode>] + [-AutoShutdownProfileShutdownWhenNotConnected <EnableState>] + [-ConnectionProfileClientRdpAccess <ConnectionType>] [-ConnectionProfileClientSshAccess <ConnectionType>] + [-ConnectionProfileWebRdpAccess <ConnectionType>] [-ConnectionProfileWebSshAccess <ConnectionType>] + [-Description <String>] [-ImageReferenceId <String>] [-ImageReferenceOffer <String>] + [-ImageReferencePublisher <String>] [-ImageReferenceSku <String>] [-ImageReferenceVersion <String>] + [-LabPlanId <String>] [-NetworkProfileLoadBalancerId <String>] [-NetworkProfilePublicIPId <String>] + [-NetworkProfileSubnetId <String>] [-NonAdminUserPassword <SecureString>] [-NonAdminUserUsername <String>] + [-RosterProfileActiveDirectoryGroupId <String>] [-RosterProfileLmsInstance <String>] + [-RosterProfileLtiClientId <String>] [-RosterProfileLtiContextId <String>] + [-RosterProfileLtiRosterEndpoint <String>] [-SecurityProfileOpenAccess <EnableState>] [-SkuCapacity <Int32>] + [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] [-Tag <Hashtable>] + [-Title <String>] [-VirtualMachineProfileCreateOption <CreateOption>] + [-VirtualMachineProfileUsageQuota <TimeSpan>] [-VirtualMachineProfileUseSharedPassword <EnableState>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to create a lab resource. + +## EXAMPLES + +### Example 1: Create a new lab. +```powershell +New-AzLabServicesLab ` + -Name "NewLab" ` + -ResourceGroupName $ENV:ResourceGroupName ` + -Location $ENV:Location ` + -AdditionalCapabilityInstallGpuDriver Disabled ` + -AdminUserPassword "PlaceholderPassword" ` + -AdminUserUsername "PlaceholderAccountName" ` + -AutoShutdownProfileShutdownOnDisconnect Disabled ` + -AutoShutdownProfileShutdownOnIdle None ` + -AutoShutdownProfileShutdownWhenNotConnected Disabled ` + -ConnectionProfileClientRdpAccess Public ` + -ConnectionProfileClientSshAccess None ` + -ConnectionProfileWebRdpAccess None ` + -ConnectionProfileWebSshAccess None ` + -Description "New lab description" ` + -ImageReferenceOffer "Windows-10" ` + -ImageReferencePublisher "MicrosoftWindowsDesktop" ` + -ImageReferenceSku "20h2-pro" ` + -ImageReferenceVersion "latest" ` + -SecurityProfileOpenAccess Disabled ` + -SkuCapacity 3 ` + -SkuName "Standard" ` + -Title $ENV:NewLabName ` + -VirtualMachineProfileCreateOption "TemplateVM" ` + -VirtualMachineProfileUseSharedPassword Enabled +``` + +```output +Location Name +-------- ---- +westus2 NewLab +``` + +Creates a new Lab. + +## PARAMETERS + +### -AdditionalCapabilityInstallGpuDriver +Flag to pre-install dedicated GPU drivers. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminUserPassword +The password for the user. +This is required for the TemplateVM createOption. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminUserUsername +The username to use when signing in to lab VMs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShutdownProfileDisconnectDelay +The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShutdownProfileIdleDelay +The amount of time a VM will idle before it is shutdown if this behavior is enabled. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShutdownProfileNoConnectDelay +The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShutdownProfileShutdownOnDisconnect +Whether shutdown on disconnect is enabled + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShutdownProfileShutdownOnIdle +Whether a VM will get shutdown when it has idled for a period of time. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ShutdownOnIdleMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShutdownProfileShutdownWhenNotConnected +Whether a VM will get shutdown when it hasn't been connected to after a period of time. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionProfileClientRdpAccess +The enabled access level for Client Access over RDP. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionProfileClientSshAccess +The enabled access level for Client Access over SSH. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionProfileWebRdpAccess +The enabled access level for Web Access over RDP. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionProfileWebSshAccess +The enabled access level for Web Access over SSH. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the lab. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceId +Image resource ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceOffer +The image offer if applicable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferencePublisher +The image publisher + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceSku +The image SKU + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceVersion +The image version specified on creation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabPlanId +The ID of the lab plan. +Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. +Setting a labPlanId on an existing lab provides organization.. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LabName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfileLoadBalancerId +The external load balancer resource id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfilePublicIPId +The external public IP resource id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfileSubnetId +The external subnet resource id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NonAdminUserPassword +The password for the user. +This is required for the TemplateVM createOption. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NonAdminUserUsername +The username to use when signing in to lab VMs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RosterProfileActiveDirectoryGroupId +The AAD group ID which this lab roster is populated from. +Having this set enables AAD sync mode. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RosterProfileLmsInstance +The base URI identifying the lms instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RosterProfileLtiClientId +The unique id of the azure lab services tool in the lms. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RosterProfileLtiContextId +The unique context identifier for the lab in the lms. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RosterProfileLtiRosterEndpoint +The uri of the names and roles service endpoint on the lms for the class attached to this lab. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityProfileOpenAccess +Whether any user or only specified users can register to a lab. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.SkuTier +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title +The title of the lab. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineProfileCreateOption +Indicates what lab virtual machines are created from. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.CreateOption +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineProfileUsageQuota +The initial quota alloted to each lab user. +Must be a time span between 0 and 9999 hours. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineProfileUseSharedPassword +Enabling this option will use the same password for all user VMs. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ILab + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/New-AzLabServicesLabPlan.md b/azps-10.1.0/Az.LabServices/New-AzLabServicesLabPlan.md new file mode 100644 index 0000000000..b7359594f0 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/New-AzLabServicesLabPlan.md @@ -0,0 +1,508 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/new-azlabserviceslabplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/New-AzLabServicesLabPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/New-AzLabServicesLabPlan.md +--- + +# New-AzLabServicesLabPlan + +## SYNOPSIS +Operation to create or update a Lab Plan resource. + +## SYNTAX + +``` +New-AzLabServicesLabPlan -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-AllowedRegion <String[]>] + [-DefaultAutoShutdownProfileDisconnectDelay <TimeSpan>] [-DefaultAutoShutdownProfileIdleDelay <TimeSpan>] + [-DefaultAutoShutdownProfileNoConnectDelay <TimeSpan>] + [-DefaultAutoShutdownProfileShutdownOnDisconnect <EnableState>] + [-DefaultAutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode>] + [-DefaultAutoShutdownProfileShutdownWhenNotConnected <EnableState>] + [-DefaultConnectionProfileClientRdpAccess <ConnectionType>] + [-DefaultConnectionProfileClientSshAccess <ConnectionType>] + [-DefaultConnectionProfileWebRdpAccess <ConnectionType>] + [-DefaultConnectionProfileWebSshAccess <ConnectionType>] [-DefaultNetworkProfileSubnetId <String>] + [-LinkedLmsInstance <String>] [-SharedGalleryId <String>] [-SupportInfoEmail <String>] + [-SupportInfoInstruction <String>] [-SupportInfoPhone <String>] [-SupportInfoUrl <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to create or update a Lab Plan resource. + +## EXAMPLES + +### Example 1: Create a new Lab plan. +```powershell +New-AzLabServicesLabPlan ` + -LabPlanName "testplan" ` + -ResourceGroupName "Group Name" ` + -Location "westus2" ` + -AllowedRegion @('westus2', 'eastus2') ` + -DefaultAutoShutdownProfileShutdownOnDisconnect Disabled ` + -DefaultAutoShutdownProfileShutdownOnIdle None ` + -DefaultAutoShutdownProfileShutdownWhenNotConnected Disabled ` + -DefaultConnectionProfileClientRdpAccess Public ` + -DefaultConnectionProfileClientSshAccess None ` + -SupportInfoEmail 'test@contoso.com' ` + -SupportInfoInstruction 'test information' ` + -SupportInfoPhone '123-456-7890' ` + -SupportInfoUrl 'https:\\test.com' ` + -DefaultConnectionProfileWebRdpAccess None ` + -DefaultConnectionProfileWebSshAccess None +``` + +```output +Location Name +-------- ---- +westus2 testplan +``` + +Create a lab plan. + +## PARAMETERS + +### -AllowedRegion +The allowed regions for the lab creator to use when creating labs using this lab plan. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAutoShutdownProfileDisconnectDelay +The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAutoShutdownProfileIdleDelay +The amount of time a VM will idle before it is shutdown if this behavior is enabled. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAutoShutdownProfileNoConnectDelay +The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAutoShutdownProfileShutdownOnDisconnect +Whether shutdown on disconnect is enabled + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAutoShutdownProfileShutdownOnIdle +Whether a VM will get shutdown when it has idled for a period of time. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ShutdownOnIdleMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAutoShutdownProfileShutdownWhenNotConnected +Whether a VM will get shutdown when it hasn't been connected to after a period of time. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConnectionProfileClientRdpAccess +The enabled access level for Client Access over RDP. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConnectionProfileClientSshAccess +The enabled access level for Client Access over SSH. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConnectionProfileWebRdpAccess +The enabled access level for Web Access over RDP. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConnectionProfileWebSshAccess +The enabled access level for Web Access over SSH. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultNetworkProfileSubnetId +The external subnet resource id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedLmsInstance +Base Url of the lms instance this lab plan can link lab rosters against. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the lab plan that uniquely identifies it within containing resource group. +Used in resource URIs and in UI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LabPlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedGalleryId +Resource ID of the Shared Image Gallery attached to this lab plan. +When saving a lab template virtual machine image it will be persisted in this gallery. +Shared images from the gallery can be made available to use when creating new labs. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportInfoEmail +Support contact email address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportInfoInstruction +Support instructions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportInfoPhone +Support contact phone number. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportInfoUrl +Support web address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ILabPlan + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/New-AzLabServicesSchedule.md b/azps-10.1.0/Az.LabServices/New-AzLabServicesSchedule.md new file mode 100644 index 0000000000..40118a4f30 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/New-AzLabServicesSchedule.md @@ -0,0 +1,386 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/new-azlabservicesschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/New-AzLabServicesSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/New-AzLabServicesSchedule.md +--- + +# New-AzLabServicesSchedule + +## SYNOPSIS +Operation to create or update a lab schedule. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzLabServicesSchedule -LabName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Note <String>] [-RecurrencePatternExpirationDate <DateTime>] + [-RecurrencePatternFrequency <RecurrenceFrequency>] [-RecurrencePatternInterval <Int32>] + [-RecurrencePatternWeekDay <WeekDay[]>] [-StartAt <DateTime>] [-StopAt <DateTime>] [-TimeZoneId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Lab +``` +New-AzLabServicesSchedule -Lab <Lab> -Name <String> [-SubscriptionId <String>] [-Note <String>] + [-RecurrencePatternExpirationDate <DateTime>] [-RecurrencePatternFrequency <RecurrenceFrequency>] + [-RecurrencePatternInterval <Int32>] [-RecurrencePatternWeekDay <WeekDay[]>] [-StartAt <DateTime>] + [-StopAt <DateTime>] [-TimeZoneId <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to create or update a lab schedule. + +## EXAMPLES + +### Example 1: Create a new schedule in a lab. +```powershell +New-AzLabServicesSchedule ` + -ResourceGroupName "Group Name" ` + -LabName "Lab Name" ` + -Name "Schedule Name" ` + -StartAt "$((Get-Date).AddHours(5))" ` + -StopAt "$((Get-Date).AddHours(6))" ` + -RecurrencePatternFrequency 'Weekly' ` + -RecurrencePatternInterval 1 ` + -RecurrencePatternWeekDay @($((Get-Date).DayOfWeek)) ` + -RecurrencePatternExpirationDate $((Get-Date).AddDays(20)) ` + -TimeZoneId 'America/Los_Angeles' +``` + +```output +Name +---- +Schedule Name +``` + +Create a weekly schedule. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the schedule that uniquely identifies it within containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ScheduleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +Notes for this schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrencePatternExpirationDate +When the recurrence will expire. +This date is inclusive. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrencePatternFrequency +The frequency of the recurrence. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.RecurrenceFrequency +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrencePatternInterval +The interval to invoke the schedule on. +For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. +When no interval is supplied, an interval of 1 is used. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrencePatternWeekDay +The week days the schedule runs. +Used for when the Frequency is set to Weekly. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.WeekDay[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartAt +When lab user virtual machines will be started. +Timestamp offsets will be ignored and timeZoneId is used instead. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StopAt +When lab user virtual machines will be stopped. +Timestamp offsets will be ignored and timeZoneId is used instead. + +```yaml +Type: System.DateTime +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeZoneId +The IANA timezone id for the schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ISchedule + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/New-AzLabServicesUser.md b/azps-10.1.0/Az.LabServices/New-AzLabServicesUser.md new file mode 100644 index 0000000000..51af17ba29 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/New-AzLabServicesUser.md @@ -0,0 +1,306 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/new-azlabservicesuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/New-AzLabServicesUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/New-AzLabServicesUser.md +--- + +# New-AzLabServicesUser + +## SYNOPSIS +Operation to create or update a lab user. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzLabServicesUser -LabName <String> -Name <String> -ResourceGroupName <String> -Email <String> + [-SubscriptionId <String>] [-AdditionalUsageQuota <TimeSpan>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Lab +``` +New-AzLabServicesUser -Lab <Lab> -Name <String> -Email <String> [-SubscriptionId <String>] + [-AdditionalUsageQuota <TimeSpan>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to create or update a lab user. + +## EXAMPLES + +### Example 1: Add user to a lab +```powershell +New-AzLabServicesUser -LabName "Lab Name" -ResourceGroupName "Group Name" -Name "User Name" -Email "User@contoso.com" +``` + +```output +Name +---- +User Name +``` + +Adds a user to a lab. + +## PARAMETERS + +### -AdditionalUsageQuota +The amount of usage quota time the user gets in addition to the lab usage quota. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +Email address of the user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the user that uniquely identifies it within containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: UserName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.IUser + +## 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. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Publish-AzLabServicesLab.md b/azps-10.1.0/Az.LabServices/Publish-AzLabServicesLab.md new file mode 100644 index 0000000000..ff3eeb7f57 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Publish-AzLabServicesLab.md @@ -0,0 +1,314 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/publish-azlabserviceslab +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Publish-AzLabServicesLab.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Publish-AzLabServicesLab.md +--- + +# Publish-AzLabServicesLab + +## SYNOPSIS +Publish or re-publish a lab. +This will create or update all lab resources, such as virtual machines. + +## SYNTAX + +### ResourceId (Default) +``` +Publish-AzLabServicesLab -ResourceId <String> [-SubscriptionId <String>] [-AdditionalUsageQuota <Object>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +### Lab +``` +Publish-AzLabServicesLab -Lab <Lab> [-SubscriptionId <String>] [-AdditionalUsageQuota <Object>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +### Publish +``` +Publish-AzLabServicesLab -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Publish or re-publish a lab. +This will create or update all lab resources, such as virtual machines. + +## EXAMPLES + +### Example 1: Publish the lab. +```powershell +Publish-AzLabServicesLab -Name "Lab Name" -ResourceGroupName "Group Name" +``` + +```output +Location Name +-------- ---- +eastus2 Lab Name +``` + +Publish the lab template. + +## PARAMETERS + +### -AdditionalUsageQuota + + +```yaml +Type: System.Object +Parameter Sets: Lab, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Publish +Aliases: LabName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Publish +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Publish +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ILab + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Remove-AzLabServicesLab.md b/azps-10.1.0/Az.LabServices/Remove-AzLabServicesLab.md new file mode 100644 index 0000000000..d215caf4be --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Remove-AzLabServicesLab.md @@ -0,0 +1,339 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/remove-azlabserviceslab +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Remove-AzLabServicesLab.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Remove-AzLabServicesLab.md +--- + +# Remove-AzLabServicesLab + +## SYNOPSIS +Operation to delete a lab resource. + +## SYNTAX + +### ResourceId (Default) +``` +Remove-AzLabServicesLab -ResourceId <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Delete +``` +Remove-AzLabServicesLab -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Lab +``` +Remove-AzLabServicesLab -Lab <Lab> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### LabPlan +``` +Remove-AzLabServicesLab -LabPlan <LabPlan> -Name <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to delete a lab resource. + +## EXAMPLES + +### Example 1: Remove a lab. +```powershell +Remove-AzLabServicesLab -ResourceGroupName "Group Name" -Name "Lab Name" +``` + +Remove the specific lab. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LabPlan +To construct, see NOTES section for LABPLAN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPlan +Parameter Sets: LabPlan +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Delete, LabPlan +Aliases: LabName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +LABPLAN `<LabPlan>`: + - `Location <String>`: The geo-location where the resource lives + - `[AllowedRegion <String[]>]`: The allowed regions for the lab creator to use when creating labs using this lab plan. + - `[DefaultAutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[DefaultAutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[DefaultAutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[DefaultAutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[DefaultAutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[DefaultAutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[DefaultConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[DefaultConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[DefaultConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[DefaultConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[DefaultNetworkProfileSubnetId <String>]`: The external subnet resource id + - `[LinkedLmsInstance <String>]`: Base Url of the lms instance this lab plan can link lab rosters against. + - `[SharedGalleryId <String>]`: Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs. + - `[SupportInfoEmail <String>]`: Support contact email address. + - `[SupportInfoInstruction <String>]`: Support instructions. + - `[SupportInfoPhone <String>]`: Support contact phone number. + - `[SupportInfoUrl <String>]`: Support web address. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Remove-AzLabServicesLabPlan.md b/azps-10.1.0/Az.LabServices/Remove-AzLabServicesLabPlan.md new file mode 100644 index 0000000000..71a211ae84 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Remove-AzLabServicesLabPlan.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/remove-azlabserviceslabplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Remove-AzLabServicesLabPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Remove-AzLabServicesLabPlan.md +--- + +# Remove-AzLabServicesLabPlan + +## SYNOPSIS +Operation to delete a Lab Plan resource. +Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzLabServicesLabPlan -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### LabPlan +``` +Remove-AzLabServicesLabPlan -LabPlan <LabPlan> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to delete a Lab Plan resource. +Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container. + +## EXAMPLES + +### Example 1: Remove a Lab plan +```powershell +Remove-AzLabServicesLabPlan -ResourceGroupName "Group Name" -Name "Lab Plan Name" +``` + +Removes the lab plan. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabPlan +To construct, see NOTES section for LABPLAN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPlan +Parameter Sets: LabPlan +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the lab plan that uniquely identifies it within containing resource group. +Used in resource URIs and in UI. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: LabPlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPlan + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +LABPLAN `<LabPlan>`: + - `Location <String>`: The geo-location where the resource lives + - `[AllowedRegion <String[]>]`: The allowed regions for the lab creator to use when creating labs using this lab plan. + - `[DefaultAutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[DefaultAutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[DefaultAutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[DefaultAutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[DefaultAutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[DefaultAutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[DefaultConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[DefaultConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[DefaultConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[DefaultConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[DefaultNetworkProfileSubnetId <String>]`: The external subnet resource id + - `[LinkedLmsInstance <String>]`: Base Url of the lms instance this lab plan can link lab rosters against. + - `[SharedGalleryId <String>]`: Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs. + - `[SupportInfoEmail <String>]`: Support contact email address. + - `[SupportInfoInstruction <String>]`: Support instructions. + - `[SupportInfoPhone <String>]`: Support contact phone number. + - `[SupportInfoUrl <String>]`: Support web address. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Remove-AzLabServicesSchedule.md b/azps-10.1.0/Az.LabServices/Remove-AzLabServicesSchedule.md new file mode 100644 index 0000000000..28091e9b15 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Remove-AzLabServicesSchedule.md @@ -0,0 +1,271 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/remove-azlabservicesschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Remove-AzLabServicesSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Remove-AzLabServicesSchedule.md +--- + +# Remove-AzLabServicesSchedule + +## SYNOPSIS +Operation to delete a schedule resource. + +## SYNTAX + +### ResourceId (Default) +``` +Remove-AzLabServicesSchedule -ResourceId <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Delete +``` +Remove-AzLabServicesSchedule -LabName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Schedule +``` +Remove-AzLabServicesSchedule -Schedule <Schedule> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to delete a schedule resource. + +## EXAMPLES + +### Example 1: Remove a schedule from a lab. +```powershell +Remove-AzLabServicesSchedule -ResourceGroupName "Group Name" -LabName "Lab Name" -Name "Schedule Name" +``` + +Removes the schedule from the lab. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the schedule that uniquely identifies it within containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ScheduleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schedule +To construct, see NOTES section for SCHEDULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Schedule +Parameter Sets: Schedule +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Schedule + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +SCHEDULE `<Schedule>`: + - `[Note <String>]`: Notes for this schedule. + - `[RecurrencePatternExpirationDate <DateTime?>]`: When the recurrence will expire. This date is inclusive. + - `[RecurrencePatternFrequency <RecurrenceFrequency?>]`: The frequency of the recurrence. + - `[RecurrencePatternInterval <Int32?>]`: The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used. + - `[RecurrencePatternWeekDay <WeekDay[]>]`: The week days the schedule runs. Used for when the Frequency is set to Weekly. + - `[StartAt <DateTime?>]`: When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead. + - `[StopAt <DateTime?>]`: When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[TimeZoneId <String>]`: The IANA timezone id for the schedule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Remove-AzLabServicesUser.md b/azps-10.1.0/Az.LabServices/Remove-AzLabServicesUser.md new file mode 100644 index 0000000000..e02c54427f --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Remove-AzLabServicesUser.md @@ -0,0 +1,339 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/remove-azlabservicesuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Remove-AzLabServicesUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Remove-AzLabServicesUser.md +--- + +# Remove-AzLabServicesUser + +## SYNOPSIS +Operation to delete a user resource. + +## SYNTAX + +### ResourceId (Default) +``` +Remove-AzLabServicesUser -ResourceId <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Delete +``` +Remove-AzLabServicesUser -LabName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Lab +``` +Remove-AzLabServicesUser -Lab <Lab> -Name <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### User +``` +Remove-AzLabServicesUser -User <User> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to delete a user resource. + +## EXAMPLES + +### Example 1: Remove a user from a lab. +```powershell +Remove-AzLabServicesUser -ResourceGroupName "Group Name" -LabName "Lab Name" -Name "User Name" +``` + +Removes the user from the lab. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the user that uniquely identifies it within containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Delete, Lab +Aliases: UserName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +To construct, see NOTES section for USER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.User +Parameter Sets: User +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.User + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +USER `<User>`: + - `Email <String>`: Email address of the user. + - `[AdditionalUsageQuota <TimeSpan?>]`: The amount of usage quota time the user gets in addition to the lab usage quota. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Reset-AzLabServicesVMPassword.md b/azps-10.1.0/Az.LabServices/Reset-AzLabServicesVMPassword.md new file mode 100644 index 0000000000..0a5bf1e85f --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Reset-AzLabServicesVMPassword.md @@ -0,0 +1,295 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/reset-azlabservicesvmpassword +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Reset-AzLabServicesVMPassword.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Reset-AzLabServicesVMPassword.md +--- + +# Reset-AzLabServicesVMPassword + +## SYNOPSIS +Resets a lab virtual machine password. + +## SYNTAX + +### ResourceId (Default) +``` +Reset-AzLabServicesVMPassword -Password <SecureString> -ResourceId <String> [-SubscriptionId <String>] + [-Username <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [<CommonParameters>] +``` + +### Reset +``` +Reset-AzLabServicesVMPassword -LabName <String> -ResourceGroupName <String> -VirtualMachineName <String> + -Password <SecureString> -Username <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### VM +``` +Reset-AzLabServicesVMPassword -Password <SecureString> -VM <VirtualMachine> [-SubscriptionId <String>] + [-Username <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [<CommonParameters>] +``` + +## DESCRIPTION +Resets a lab virtual machine password. + +## EXAMPLES + +### Example 1: Reset the password on the VM. +```powershell +Reset-AzLabServicesVMPassword -ResourceGroupName "Group Name" -LabName "Lab Name" -VirtualMachineName 0 -Password "New Password" +``` + +This changes the VM password. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Reset +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The password + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Reset +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Username +The user whose password is being reset + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineName +The ID of the virtual machine that uniquely identifies it within the containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Reset +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +To construct, see NOTES section for VM properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.VirtualMachine +Parameter Sets: VM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.VirtualMachine + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.IVirtualMachine + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +VM `<VirtualMachine>`: + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Save-AzLabServicesLabPlanImage.md b/azps-10.1.0/Az.LabServices/Save-AzLabServicesLabPlanImage.md new file mode 100644 index 0000000000..3ff2d313cd --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Save-AzLabServicesLabPlanImage.md @@ -0,0 +1,219 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/save-azlabserviceslabplanimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Save-AzLabServicesLabPlanImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Save-AzLabServicesLabPlanImage.md +--- + +# Save-AzLabServicesLabPlanImage + +## SYNOPSIS +Saves an image from a lab VM to the attached shared image gallery. + +## SYNTAX + +``` +Save-AzLabServicesLabPlanImage -LabPlanName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-LabVirtualMachineId <String>] [-Name <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Saves an image from a lab VM to the attached shared image gallery. + +## EXAMPLES + +### Example 1: Saves an image of the VM to the Shared Image Gallery. +```powershell +Save-AzLabServicesLabPlanImage -ResourceGroupName "Group Name" -LabPlanName "Lab Plan Name" -Name "New Image Name" -LabVirtualMachineId "/subscriptions/<subscription Id>/resourceGroups/<group name>/providers/Microsoft.LabServices/labs/labName/virtualMachines/<vm name>" +``` + +This creates a new image in the Shared Image Gallery. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabPlanName +The name of the lab plan that uniquely identifies it within containing resource group. +Used in resource URIs and in UI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabVirtualMachineId +The ID of the lab virtual machine you want to save an image from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name for the image we create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Send-AzLabServicesUserInvite.md b/azps-10.1.0/Az.LabServices/Send-AzLabServicesUserInvite.md new file mode 100644 index 0000000000..609ac6eca3 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Send-AzLabServicesUserInvite.md @@ -0,0 +1,282 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/send-azlabservicesuserinvite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Send-AzLabServicesUserInvite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Send-AzLabServicesUserInvite.md +--- + +# Send-AzLabServicesUserInvite + +## SYNOPSIS +Operation to invite a user to a lab. + +## SYNTAX + +### ResourceId (Default) +``` +Send-AzLabServicesUserInvite -ResourceId <String> [-SubscriptionId <String>] [-Text <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +### InviteExpanded +``` +Send-AzLabServicesUserInvite -LabName <String> -ResourceGroupName <String> -UserName <String> + [-SubscriptionId <String>] [-Text <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Users +``` +Send-AzLabServicesUserInvite -User <User> [-SubscriptionId <String>] [-Text <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to invite a user to a lab. + +## EXAMPLES + +### Example 1: Send lab invite to the user. +```powershell +Send-AzLabServicesUserInvite -ResourceGroupName "Group Name" -LabName "Lab Name" -UserName "User Name" -Text "Welcome to the lab." +``` + +This sends an email invitation to the user with the custom text "Welcome to the lab" in the body of the email. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: InviteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: InviteExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: InviteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Text +Custom text for the invite email. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +To construct, see NOTES section for USER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.User +Parameter Sets: Users +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserName +The name of the user that uniquely identifies it within containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: InviteExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.User + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.IVirtualMachine + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +USER `<User>`: + - `Email <String>`: Email address of the user. + - `[AdditionalUsageQuota <TimeSpan?>]`: The amount of usage quota time the user gets in addition to the lab usage quota. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Start-AzLabServicesUserVM.md b/azps-10.1.0/Az.LabServices/Start-AzLabServicesUserVM.md new file mode 100644 index 0000000000..5b6d169053 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Start-AzLabServicesUserVM.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/start-azlabservicesuservm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Start-AzLabServicesUserVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Start-AzLabServicesUserVM.md +--- + +# Start-AzLabServicesUserVM + +## SYNOPSIS +API to start the assigned vm for the user. + +## SYNTAX + +### Start (Default) +``` +Start-AzLabServicesUserVM -Email <String> -LabName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### User +``` +Start-AzLabServicesUserVM -User <User> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +API to start the assigned vm for the user. + +## EXAMPLES + +### Example 1: Start user assigned VM in the lab. +```powershell +Start-AzLabServicesUserVM -ResourceGroupName "Group Name" -LabName "Lab Name" -Email "user@contoso.com" +``` + +This starts the VM assigned to the user with the specific email. +If there isn't a VM assigned to the user a null is returned. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +The name of the user that uniqely identifies it within containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName + + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +To construct, see NOTES section for USER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.User +Parameter Sets: User +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.User + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.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. + + +USER `<User>`: + - `Email <String>`: Email address of the user. + - `[AdditionalUsageQuota <TimeSpan?>]`: The amount of usage quota time the user gets in addition to the lab usage quota. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Start-AzLabServicesVM.md b/azps-10.1.0/Az.LabServices/Start-AzLabServicesVM.md new file mode 100644 index 0000000000..d7dd7429c0 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Start-AzLabServicesVM.md @@ -0,0 +1,264 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/start-azlabservicesvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Start-AzLabServicesVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Start-AzLabServicesVM.md +--- + +# Start-AzLabServicesVM + +## SYNOPSIS +Action to start a lab virtual machine. + +## SYNTAX + +### ResourceId (Default) +``` +Start-AzLabServicesVM -ResourceId <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [<CommonParameters>] +``` + +### Start +``` +Start-AzLabServicesVM -LabName <String> -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### VM +``` +Start-AzLabServicesVM -VM <VirtualMachine> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [<CommonParameters>] +``` + +## DESCRIPTION +Action to start a lab virtual machine. + +## EXAMPLES + +### Example 1: Start specific VM in the lab. +```powershell +Start-AzLabServicesVM -ResourceGroupName "Group Name" -LabName "Lab Name" -Name 0 +``` + +This start the VM with the name 0. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The ID of the virtual machine that uniquely identifies it within the containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: VirtualMachineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +To construct, see NOTES section for VM properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.VirtualMachine +Parameter Sets: VM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.VirtualMachine + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.IVirtualMachine + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +VM `<VirtualMachine>`: + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Start-AzLabServicesVMRedeployment.md b/azps-10.1.0/Az.LabServices/Start-AzLabServicesVMRedeployment.md new file mode 100644 index 0000000000..3ac8602036 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Start-AzLabServicesVMRedeployment.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/start-azlabservicesvmredeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Start-AzLabServicesVMRedeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Start-AzLabServicesVMRedeployment.md +--- + +# Start-AzLabServicesVMRedeployment + +## SYNOPSIS +Action to redeploy a lab virtual machine to a different compute node. +For troubleshooting connectivity. + +## SYNTAX + +### ResourceId (Default) +``` +Start-AzLabServicesVMRedeployment -ResourceId <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [<CommonParameters>] +``` + +### Redeploy +``` +Start-AzLabServicesVMRedeployment -LabName <String> -ResourceGroupName <String> -VirtualMachineName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Action to redeploy a lab virtual machine to a different compute node. +For troubleshooting connectivity. + +## EXAMPLES + +### Example 1: Redeploy the specific Virtual machine. +```powershell +Start-AzLabServicesVMRedeployment -LabName "Lab Name" -ResourceGroupName "Group Name" -VirtualMachineName 1 +``` + +The Redeploy removes the machine and creates a new one. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Redeploy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Redeploy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineName +The ID of the virtual machine that uniquely identifies it within the containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Redeploy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.IVirtualMachine + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Stop-AzLabServicesUserVM.md b/azps-10.1.0/Az.LabServices/Stop-AzLabServicesUserVM.md new file mode 100644 index 0000000000..6b5614f210 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Stop-AzLabServicesUserVM.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/stop-azlabservicesuservm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Stop-AzLabServicesUserVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Stop-AzLabServicesUserVM.md +--- + +# Stop-AzLabServicesUserVM + +## SYNOPSIS +API to stop the assigned vm for the user. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzLabServicesUserVM -Email <String> -LabName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### User +``` +Stop-AzLabServicesUserVM -User <User> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +API to stop the assigned vm for the user. + +## EXAMPLES + +### Example 1: Stop user assigned VM in the lab. +```powershell +Stop-AzLabServicesUserVM -ResourceGroupName "Group Name" -LabName "Lab Name" -Email "user@contoso.com" +``` + +This stops the VM assigned to the user with the specific email. +If there isn't a VM assigned to the user a null is returned. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +The name of the user that uniqely identifies it within containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName + + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +To construct, see NOTES section for USER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.User +Parameter Sets: User +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.User + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.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. + + +USER `<User>`: + - `Email <String>`: Email address of the user. + - `[AdditionalUsageQuota <TimeSpan?>]`: The amount of usage quota time the user gets in addition to the lab usage quota. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Stop-AzLabServicesVM.md b/azps-10.1.0/Az.LabServices/Stop-AzLabServicesVM.md new file mode 100644 index 0000000000..ffbf69b6f4 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Stop-AzLabServicesVM.md @@ -0,0 +1,264 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/stop-azlabservicesvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Stop-AzLabServicesVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Stop-AzLabServicesVM.md +--- + +# Stop-AzLabServicesVM + +## SYNOPSIS +Action to stop a lab virtual machine. + +## SYNTAX + +### ResourceId (Default) +``` +Stop-AzLabServicesVM -ResourceId <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [<CommonParameters>] +``` + +### Stop +``` +Stop-AzLabServicesVM -LabName <String> -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### VM +``` +Stop-AzLabServicesVM -VM <VirtualMachine> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [<CommonParameters>] +``` + +## DESCRIPTION +Action to stop a lab virtual machine. + +## EXAMPLES + +### Example 1: Stop specific VM in the lab. +```powershell +Stop-AzLabServicesVM -ResourceGroupName "Group Name" -LabName "Lab Name" -Name 0 +``` + +This stops the VM with the name 0. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The ID of the virtual machine that uniquely identifies it within the containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: VirtualMachineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +To construct, see NOTES section for VM properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.VirtualMachine +Parameter Sets: VM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.VirtualMachine + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.IVirtualMachine + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +VM `<VirtualMachine>`: + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Sync-AzLabServicesLabUser.md b/azps-10.1.0/Az.LabServices/Sync-AzLabServicesLabUser.md new file mode 100644 index 0000000000..067f6aebf3 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Sync-AzLabServicesLabUser.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/sync-azlabserviceslabuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Sync-AzLabServicesLabUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Sync-AzLabServicesLabUser.md +--- + +# Sync-AzLabServicesLabUser + +## SYNOPSIS +Action used to manually kick off an AAD group sync job. + +## SYNTAX + +### Sync (Default) +``` +Sync-AzLabServicesLabUser -LabName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Lab +``` +Sync-AzLabServicesLabUser -Lab <Lab> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [<CommonParameters>] +``` + +## DESCRIPTION +Action used to manually kick off an AAD group sync job. + +## EXAMPLES + +### Example 1: Sync the users connected to the lab. +```powershell +Sync-AzLabServicesLabUser -ResourceGroupName "Group Name" -LabName "Lab Name" +``` + +This cmdlet will sync the connected AD Group to update the users. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Sync +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Sync +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Sync +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.IUser + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Update-AzLabServicesLab.md b/azps-10.1.0/Az.LabServices/Update-AzLabServicesLab.md new file mode 100644 index 0000000000..ee3f84fefd --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Update-AzLabServicesLab.md @@ -0,0 +1,776 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/update-azlabserviceslab +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesLab.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesLab.md +--- + +# Update-AzLabServicesLab + +## SYNOPSIS +Operation to update a lab resource. + +## SYNTAX + +``` +Update-AzLabServicesLab -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AdditionalCapabilityInstallGpuDriver <EnableState>] [-AdminUserPassword <SecureString>] + [-AdminUserUsername <String>] [-AutoShutdownProfileDisconnectDelay <TimeSpan>] + [-AutoShutdownProfileIdleDelay <TimeSpan>] [-AutoShutdownProfileNoConnectDelay <TimeSpan>] + [-AutoShutdownProfileShutdownOnDisconnect <EnableState>] + [-AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode>] + [-AutoShutdownProfileShutdownWhenNotConnected <EnableState>] + [-ConnectionProfileClientRdpAccess <ConnectionType>] [-ConnectionProfileClientSshAccess <ConnectionType>] + [-ConnectionProfileWebRdpAccess <ConnectionType>] [-ConnectionProfileWebSshAccess <ConnectionType>] + [-Description <String>] [-ImageReferenceId <String>] [-ImageReferenceOffer <String>] + [-ImageReferencePublisher <String>] [-ImageReferenceSku <String>] [-ImageReferenceVersion <String>] + [-LabPlanId <String>] [-NonAdminUserPassword <SecureString>] [-NonAdminUserUsername <String>] + [-RosterProfileActiveDirectoryGroupId <String>] [-RosterProfileLmsInstance <String>] + [-RosterProfileLtiClientId <String>] [-RosterProfileLtiContextId <String>] + [-RosterProfileLtiRosterEndpoint <String>] [-SecurityProfileOpenAccess <EnableState>] [-SkuCapacity <Int32>] + [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] [-Tag <String[]>] + [-Title <String>] [-VirtualMachineProfileCreateOption <CreateOption>] + [-VirtualMachineProfileUsageQuota <TimeSpan>] [-VirtualMachineProfileUseSharedPassword <EnableState>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to update a lab resource. + +## EXAMPLES + +### Example 1: Update existing lab. +```powershell +Update-AzLabServicesLab -ResourceGroupName "Group Name" -Name "Lab Name" -AutoShutdownProfileShutdownOnDisconnect Enabled -AutoShutdownProfileDisconnectDelay "00:25:00" +``` + +```output +Location Name +-------- ---- +westus2 Lab Name +``` + +This example updates the lab and enables the Shutdown on Disconnect option setting the delay at 25 minutes. + +## PARAMETERS + +### -AdditionalCapabilityInstallGpuDriver +Flag to pre-install dedicated GPU drivers. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminUserPassword +The password for the user. +This is required for the TemplateVM createOption. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminUserUsername +The username to use when signing in to lab VMs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShutdownProfileDisconnectDelay +The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShutdownProfileIdleDelay +The amount of time a VM will idle before it is shutdown if this behavior is enabled. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShutdownProfileNoConnectDelay +The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShutdownProfileShutdownOnDisconnect +Whether shutdown on disconnect is enabled + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShutdownProfileShutdownOnIdle +Whether a VM will get shutdown when it has idled for a period of time. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ShutdownOnIdleMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoShutdownProfileShutdownWhenNotConnected +Whether a VM will get shutdown when it hasn't been connected to after a period of time. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionProfileClientRdpAccess +The enabled access level for Client Access over RDP. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionProfileClientSshAccess +The enabled access level for Client Access over SSH. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionProfileWebRdpAccess +The enabled access level for Web Access over RDP. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionProfileWebSshAccess +The enabled access level for Web Access over SSH. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the lab. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceId +Image resource ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceOffer +The image offer if applicable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferencePublisher +The image publisher + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceSku +The image SKU + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageReferenceVersion +The image version specified on creation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabPlanId +The ID of the lab plan. +Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. +Setting a labPlanId on an existing lab provides organization.. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LabName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NonAdminUserPassword +The password for the user. +This is required for the TemplateVM createOption. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NonAdminUserUsername +The username to use when signing in to lab VMs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RosterProfileActiveDirectoryGroupId +The AAD group ID which this lab roster is populated from. +Having this set enables AAD sync mode. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RosterProfileLmsInstance +The base URI identifying the lms instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RosterProfileLtiClientId +The unique id of the azure lab services tool in the lms. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RosterProfileLtiContextId +The unique context identifier for the lab in the lms. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RosterProfileLtiRosterEndpoint +The uri of the names and roles service endpoint on the lms for the class attached to this lab. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityProfileOpenAccess +Whether any user or only specified users can register to a lab. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.SkuTier +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title +The title of the lab. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineProfileCreateOption +Indicates what lab virtual machines are created from. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.CreateOption +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineProfileUsageQuota +The initial quota alloted to each lab user. +Must be a time span between 0 and 9999 hours. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineProfileUseSharedPassword +Enabling this option will use the same password for all user VMs. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ILab + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Update-AzLabServicesLabPlan.md b/azps-10.1.0/Az.LabServices/Update-AzLabServicesLabPlan.md new file mode 100644 index 0000000000..08a4d91247 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Update-AzLabServicesLabPlan.md @@ -0,0 +1,574 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/update-azlabserviceslabplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesLabPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesLabPlan.md +--- + +# Update-AzLabServicesLabPlan + +## SYNOPSIS +Operation to update a Lab Plan resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzLabServicesLabPlan -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AllowedRegion <String[]>] [-DefaultAutoShutdownProfileDisconnectDelay <TimeSpan>] + [-DefaultAutoShutdownProfileIdleDelay <TimeSpan>] [-DefaultAutoShutdownProfileNoConnectDelay <TimeSpan>] + [-DefaultAutoShutdownProfileShutdownOnDisconnect <EnableState>] + [-DefaultAutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode>] + [-DefaultAutoShutdownProfileShutdownWhenNotConnected <EnableState>] + [-DefaultConnectionProfileClientRdpAccess <ConnectionType>] + [-DefaultConnectionProfileClientSshAccess <ConnectionType>] + [-DefaultConnectionProfileWebRdpAccess <ConnectionType>] + [-DefaultConnectionProfileWebSshAccess <ConnectionType>] [-DefaultNetworkProfileSubnetId <String>] + [-LinkedLmsInstance <String>] [-SharedGalleryId <String>] [-SupportInfoEmail <String>] + [-SupportInfoInstruction <String>] [-SupportInfoPhone <String>] [-SupportInfoUrl <String>] [-Tag <String[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### LabPlan +``` +Update-AzLabServicesLabPlan -LabPlan <LabPlan> [-SubscriptionId <String>] [-AllowedRegion <String[]>] + [-DefaultAutoShutdownProfileDisconnectDelay <TimeSpan>] [-DefaultAutoShutdownProfileIdleDelay <TimeSpan>] + [-DefaultAutoShutdownProfileNoConnectDelay <TimeSpan>] + [-DefaultAutoShutdownProfileShutdownOnDisconnect <EnableState>] + [-DefaultAutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode>] + [-DefaultAutoShutdownProfileShutdownWhenNotConnected <EnableState>] + [-DefaultConnectionProfileClientRdpAccessEnabled <ConnectionType>] + [-DefaultConnectionProfileClientSshAccessEnabled <ConnectionType>] [-DefaultNetworkProfileSubnetId <String>] + [-LinkedLmsInstance <String>] [-SharedGalleryId <String>] [-SupportInfoEmail <String>] + [-SupportInfoInstruction <String>] [-SupportInfoPhone <String>] [-SupportInfoUrl <String>] [-Tag <String[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to update a Lab Plan resource. + +## EXAMPLES + +### Example 1: Update Lab plan +```powershell +Update-AzLabServicesLabPlan -ResourceGroupName "Group Name" -Name "LabPlan Name" -DefaultAutoShutdownProfileShutdownOnDisconnect 'Enabled' -DefaultAutoShutdownProfileDisconnectDelay "00:17:00" +``` + +```output +Location Name +-------- ---- +westus2 LabPlan Name +``` + +This example updates the lab plan enabling the Shutdown on disconnect with a delay of 17 minutes. + +## PARAMETERS + +### -AllowedRegion +The allowed regions for the lab creator to use when creating labs using this lab plan. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAutoShutdownProfileDisconnectDelay +The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAutoShutdownProfileIdleDelay +The amount of time a VM will idle before it is shutdown if this behavior is enabled. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAutoShutdownProfileNoConnectDelay +The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAutoShutdownProfileShutdownOnDisconnect +Whether shutdown on disconnect is enabled + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAutoShutdownProfileShutdownOnIdle +Whether a VM will get shutdown when it has idled for a period of time. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ShutdownOnIdleMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAutoShutdownProfileShutdownWhenNotConnected +Whether a VM will get shutdown when it hasn't been connected to after a period of time. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConnectionProfileClientRdpAccess +The enabled access level for Client Access over RDP. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConnectionProfileClientRdpAccessEnabled + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: LabPlan +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConnectionProfileClientSshAccess +The enabled access level for Client Access over SSH. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConnectionProfileClientSshAccessEnabled + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: LabPlan +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConnectionProfileWebRdpAccess +The enabled access level for Web Access over RDP. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultConnectionProfileWebSshAccess +The enabled access level for Web Access over SSH. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.ConnectionType +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultNetworkProfileSubnetId +The external subnet resource id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabPlan +To construct, see NOTES section for LABPLAN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPlan +Parameter Sets: LabPlan +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkedLmsInstance +Base Url of the lms instance this lab plan can link lab rosters against. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the lab plan that uniquely identifies it within containing resource group. +Used in resource URIs and in UI. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: LabPlanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedGalleryId +Resource ID of the Shared Image Gallery attached to this lab plan. +When saving a lab template virtual machine image it will be persisted in this gallery. +Shared images from the gallery can be made available to use when creating new labs. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportInfoEmail +Support contact email address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportInfoInstruction +Support instructions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportInfoPhone +Support contact phone number. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportInfoUrl +Support web address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPlan + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ILabPlan + +## 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. + + +LABPLAN `<LabPlan>`: + - `Location <String>`: The geo-location where the resource lives + - `[AllowedRegion <String[]>]`: The allowed regions for the lab creator to use when creating labs using this lab plan. + - `[DefaultAutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[DefaultAutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[DefaultAutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[DefaultAutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[DefaultAutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[DefaultAutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[DefaultConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[DefaultConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[DefaultConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[DefaultConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[DefaultNetworkProfileSubnetId <String>]`: The external subnet resource id + - `[LinkedLmsInstance <String>]`: Base Url of the lms instance this lab plan can link lab rosters against. + - `[SharedGalleryId <String>]`: Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs. + - `[SupportInfoEmail <String>]`: Support contact email address. + - `[SupportInfoInstruction <String>]`: Support instructions. + - `[SupportInfoPhone <String>]`: Support contact phone number. + - `[SupportInfoUrl <String>]`: Support web address. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Update-AzLabServicesPlanImage.md b/azps-10.1.0/Az.LabServices/Update-AzLabServicesPlanImage.md new file mode 100644 index 0000000000..1a53762b3b --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Update-AzLabServicesPlanImage.md @@ -0,0 +1,289 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/update-azlabservicesplanimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesPlanImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesPlanImage.md +--- + +# Update-AzLabServicesPlanImage + +## SYNOPSIS +Updates an image resource. + +## SYNTAX + +### ResourceId (Default) +``` +Update-AzLabServicesPlanImage -EnabledState <EnableState> -ResourceId <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +### LabPlan +``` +Update-AzLabServicesPlanImage -LabPlan <LabPlan> -Name <String> -EnabledState <EnableState> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### UpdateExpanded +``` +Update-AzLabServicesPlanImage -LabPlanName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-EnabledState <EnableState>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates an image resource. + +## EXAMPLES + +### Example 1: Update a lab plan image. +```powershell +Update-AzLabServicesPlanImage -ResourceGroupName "Group Name" -LabPlanName "LabPlan Name" -Name "Image Name" -EnabledState "Enabled" +``` + +```output +Name +---- +Image Name +``` + +This example enables the image for use in labs. + +## PARAMETERS + +### -AsJob + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledState +Is the image enabled + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.EnableState +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabPlan +To construct, see NOTES section for LABPLAN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPlan +Parameter Sets: LabPlan +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LabPlanName +The name of the lab plan that uniquely identifies it within containing resource group. +Used in resource URIs and in UI. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The image name. + +```yaml +Type: System.String +Parameter Sets: LabPlan, UpdateExpanded +Aliases: ImageName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPlan + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.IImage + +## 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. + + +LABPLAN `<LabPlan>`: + - `Location <String>`: The geo-location where the resource lives + - `[AllowedRegion <String[]>]`: The allowed regions for the lab creator to use when creating labs using this lab plan. + - `[DefaultAutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[DefaultAutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[DefaultAutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[DefaultAutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[DefaultAutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[DefaultAutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[DefaultConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[DefaultConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[DefaultConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[DefaultConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[DefaultNetworkProfileSubnetId <String>]`: The external subnet resource id + - `[LinkedLmsInstance <String>]`: Base Url of the lms instance this lab plan can link lab rosters against. + - `[SharedGalleryId <String>]`: Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs. + - `[SupportInfoEmail <String>]`: Support contact email address. + - `[SupportInfoInstruction <String>]`: Support instructions. + - `[SupportInfoPhone <String>]`: Support contact phone number. + - `[SupportInfoUrl <String>]`: Support web address. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Update-AzLabServicesQuota.md b/azps-10.1.0/Az.LabServices/Update-AzLabServicesQuota.md new file mode 100644 index 0000000000..5a583dcf47 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Update-AzLabServicesQuota.md @@ -0,0 +1,274 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/update-azlabservicesquota +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesQuota.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesQuota.md +--- + +# Update-AzLabServicesQuota + +## SYNOPSIS +API to update the lab quota. + +## SYNTAX + +### Lab (Default) +``` +Update-AzLabServicesQuota -Lab <Lab> -LabQuota <TimeSpan> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Set +``` +Update-AzLabServicesQuota -LabName <String> -ResourceGroupName <String> -LabQuota <TimeSpan> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +API to update the lab quota. + +## EXAMPLES + +### Example 1: Update-AzLabServicesQuota +```powershell +Update-AzLabServicesQuota -ResourceGroupName "Group Name" -LabName "Lab Name" -LabQuota $(New-TimeSpan -Hours 3) +``` + +```output +Location Name +-------- ---- +westus2 Lab Name +``` + +This example updates the lab adding an additional 3 hours to the lab quota. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LabName + + +```yaml +Type: System.String +Parameter Sets: Set +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabQuota + + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Set +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ILab + +## 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. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Update-AzLabServicesSchedule.md b/azps-10.1.0/Az.LabServices/Update-AzLabServicesSchedule.md new file mode 100644 index 0000000000..b5ea136fb9 --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Update-AzLabServicesSchedule.md @@ -0,0 +1,397 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/update-azlabservicesschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesSchedule.md +--- + +# Update-AzLabServicesSchedule + +## SYNOPSIS +Operation to update a lab schedule. + +## SYNTAX + +### ResourceId (Default) +``` +Update-AzLabServicesSchedule -ResourceId <String> [-SubscriptionId <String>] [-Note <String>] + [-RecurrencePatternExpirationDate <DateTime>] [-RecurrencePatternFrequency <RecurrenceFrequency>] + [-RecurrencePatternInterval <Int32>] [-RecurrencePatternWeekDay <WeekDay[]>] [-StartAt <DateTime>] + [-StopAt <DateTime>] [-TimeZoneId <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Lab +``` +Update-AzLabServicesSchedule -Lab <Lab> -Name <String> [-SubscriptionId <String>] [-Note <String>] + [-RecurrencePatternExpirationDate <DateTime>] [-RecurrencePatternFrequency <RecurrenceFrequency>] + [-RecurrencePatternInterval <Int32>] [-RecurrencePatternWeekDay <WeekDay[]>] [-StartAt <DateTime>] + [-StopAt <DateTime>] [-TimeZoneId <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### UpdateExpanded +``` +Update-AzLabServicesSchedule -LabName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Note <String>] [-RecurrencePatternExpirationDate <DateTime>] + [-RecurrencePatternFrequency <RecurrenceFrequency>] [-RecurrencePatternInterval <Int32>] + [-RecurrencePatternWeekDay <WeekDay[]>] [-StartAt <DateTime>] [-StopAt <DateTime>] [-TimeZoneId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to update a lab schedule. + +## EXAMPLES + +### Example 1: Update existing schedule. +```powershell +Update-AzLabServicesSchedule -ResourceGroupName "Group Name" -LabName "Lab Name" -Name "Schedule Name" -Note "Update note." +``` + +```output +Name Type +---- ---- +Schedule Name Microsoft.LabServices/labs/schedules +``` + +Updated the schedule to add additional note information. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the schedule that uniquely identifies it within containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Lab, UpdateExpanded +Aliases: ScheduleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +Notes for this schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrencePatternExpirationDate +When the recurrence will expire. +This date is inclusive. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrencePatternFrequency +The frequency of the recurrence. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.RecurrenceFrequency +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrencePatternInterval +The interval to invoke the schedule on. +For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. +When no interval is supplied, an interval of 1 is used. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrencePatternWeekDay +The week days the schedule runs. +Used for when the Frequency is set to Weekly. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Support.WeekDay[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartAt +When lab user virtual machines will be started. +Timestamp offsets will be ignored and timeZoneId is used instead. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StopAt +When lab user virtual machines will be stopped. +Timestamp offsets will be ignored and timeZoneId is used instead. + +```yaml +Type: System.DateTime +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeZoneId +The IANA timezone id for the schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ISchedule + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Update-AzLabServicesUser.md b/azps-10.1.0/Az.LabServices/Update-AzLabServicesUser.md new file mode 100644 index 0000000000..8f3aaf08ef --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Update-AzLabServicesUser.md @@ -0,0 +1,312 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/update-azlabservicesuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesUser.md +--- + +# Update-AzLabServicesUser + +## SYNOPSIS +Operation to update a lab user. + +## SYNTAX + +### ResourceId (Default) +``` +Update-AzLabServicesUser -ResourceId <String> [-SubscriptionId <String>] [-AdditionalUsageQuota <TimeSpan>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +### Lab +``` +Update-AzLabServicesUser -Lab <Lab> -Name <String> [-SubscriptionId <String>] + [-AdditionalUsageQuota <TimeSpan>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +### UpdateExpanded +``` +Update-AzLabServicesUser -LabName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AdditionalUsageQuota <TimeSpan>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to update a lab user. + +## EXAMPLES + +### Example 1: Update Lab User information. +```powershell +Update-AzLabServicesUser -ResourceGroupName "Group Name" -LabName "Lab Name" -Name "User Name" -AdditionalUsageQuota $(New-TimeSpan -Hours 2) +``` + +```output +Name +---- +User Name +``` + +This cmdlet will add additional quota of two hours to the user. + +## PARAMETERS + +### -AdditionalUsageQuota +The amount of usage quota time the user gets in addition to the lab usage quota. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lab +To construct, see NOTES section for LAB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab +Parameter Sets: Lab +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the user that uniquely identifies it within containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Lab, UpdateExpanded +Aliases: UserName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.Lab + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.IUser + +## 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. + + +LAB `<Lab>`: + - `Location <String>`: The geo-location where the resource lives + - `[AdditionalCapabilityInstallGpuDriver <EnableState?>]`: Flag to pre-install dedicated GPU drivers. + - `[AdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[AdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[AutoShutdownProfileDisconnectDelay <TimeSpan?>]`: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. + - `[AutoShutdownProfileIdleDelay <TimeSpan?>]`: The amount of time a VM will idle before it is shutdown if this behavior is enabled. + - `[AutoShutdownProfileNoConnectDelay <TimeSpan?>]`: The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. + - `[AutoShutdownProfileShutdownOnDisconnect <EnableState?>]`: Whether shutdown on disconnect is enabled + - `[AutoShutdownProfileShutdownOnIdle <ShutdownOnIdleMode?>]`: Whether a VM will get shutdown when it has idled for a period of time. + - `[AutoShutdownProfileShutdownWhenNotConnected <EnableState?>]`: Whether a VM will get shutdown when it hasn't been connected to after a period of time. + - `[ConnectionProfileClientRdpAccess <ConnectionType?>]`: The enabled access level for Client Access over RDP. + - `[ConnectionProfileClientSshAccess <ConnectionType?>]`: The enabled access level for Client Access over SSH. + - `[ConnectionProfileWebRdpAccess <ConnectionType?>]`: The enabled access level for Web Access over RDP. + - `[ConnectionProfileWebSshAccess <ConnectionType?>]`: The enabled access level for Web Access over SSH. + - `[Description <String>]`: The description of the lab. + - `[ImageReferenceId <String>]`: Image resource ID + - `[ImageReferenceOffer <String>]`: The image offer if applicable. + - `[ImageReferencePublisher <String>]`: The image publisher + - `[ImageReferenceSku <String>]`: The image SKU + - `[ImageReferenceVersion <String>]`: The image version specified on creation. + - `[NetworkProfileLoadBalancerId <String>]`: The external load balancer resource id + - `[NetworkProfilePublicIPId <String>]`: The external public IP resource id + - `[NetworkProfileSubnetId <String>]`: The external subnet resource id + - `[NonAdminUserPassword <String>]`: The password for the user. This is required for the TemplateVM createOption. + - `[NonAdminUserUsername <String>]`: The username to use when signing in to lab VMs. + - `[PlanId <String>]`: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization.. + - `[RosterProfileActiveDirectoryGroupId <String>]`: The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. + - `[RosterProfileLmsInstance <String>]`: The base URI identifying the lms instance. + - `[RosterProfileLtiClientId <String>]`: The unique id of the azure lab services tool in the lms. + - `[RosterProfileLtiContextId <String>]`: The unique context identifier for the lab in the lms. + - `[RosterProfileLtiRosterEndpoint <String>]`: The uri of the names and roles service endpoint on the lms for the class attached to this lab. + - `[SecurityProfileOpenAccess <EnableState?>]`: Whether any user or only specified users can register to a lab. + - `[SkuCapacity <Int32?>]`: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. + - `[SkuFamily <String>]`: If the service has different generations of hardware, for the same SKU, then that can be captured here. + - `[SkuName <String>]`: The name of the SKU. Ex - P3. It is typically a letter+number code + - `[SkuSize <String>]`: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. + - `[SkuTier <SkuTier?>]`: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Title <String>]`: The title of the lab. + - `[VirtualMachineProfileCreateOption <CreateOption?>]`: Indicates what lab virtual machines are created from. + - `[VirtualMachineProfileUsageQuota <TimeSpan?>]`: The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. + - `[VirtualMachineProfileUseSharedPassword <EnableState?>]`: Enabling this option will use the same password for all user VMs. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LabServices/Update-AzLabServicesVMReimage.md b/azps-10.1.0/Az.LabServices/Update-AzLabServicesVMReimage.md new file mode 100644 index 0000000000..d1eb4fce7a --- /dev/null +++ b/azps-10.1.0/Az.LabServices/Update-AzLabServicesVMReimage.md @@ -0,0 +1,273 @@ +--- +external help file: +Module Name: Az.LabServices +online version: https://learn.microsoft.com/powershell/module/az.labservices/update-azlabservicesvmreimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesVMReimage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LabServices/help/Update-AzLabServicesVMReimage.md +--- + +# Update-AzLabServicesVMReimage + +## SYNOPSIS +Re-image a lab virtual machine. +The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab. + +## SYNTAX + +### ResourceId (Default) +``` +Update-AzLabServicesVMReimage -ResourceId <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [<CommonParameters>] +``` + +### Reimage +``` +Update-AzLabServicesVMReimage -LabName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### VM +``` +Update-AzLabServicesVMReimage -VM <VirtualMachine> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [<CommonParameters>] +``` + +## DESCRIPTION +Re-image a lab virtual machine. +The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab. + +## EXAMPLES + +### Example 1: Reimage an existing VM. +```powershell +Update-AzLabServicesVMReimage -ResourceGroupName "Group Name" -LabName "Lab Name" -Name 0 +``` + +```output +Name +---- +0 +``` + +This example reimages the VM. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LabName +The name of the lab that uniquely identifies it within containing lab account. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Reimage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The ID of the virtual machine that uniquely identifies it within the containing lab. +Used in resource URIs. + +```yaml +Type: System.String +Parameter Sets: Reimage +Aliases: VirtualMachineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Reimage +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Reimage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +To construct, see NOTES section for VM properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.VirtualMachine +Parameter Sets: VM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.VirtualMachine + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.IVirtualMachine + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +VM `<VirtualMachine>`: + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LoadTesting/Az.LoadTesting.md b/azps-10.1.0/Az.LoadTesting/Az.LoadTesting.md new file mode 100644 index 0000000000..906c8195c2 --- /dev/null +++ b/azps-10.1.0/Az.LoadTesting/Az.LoadTesting.md @@ -0,0 +1,27 @@ +--- +Module Name: Az.LoadTesting +Module Guid: 739ddedf-3d49-40e0-bc84-00bedfe6b2ec +Download Help Link: https://learn.microsoft.com/powershell/module/az.loadtesting +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LoadTesting/help/Az.LoadTesting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LoadTesting/help/Az.LoadTesting.md +--- + +# Az.LoadTesting Module +## Description +Microsoft Azure PowerShell: LoadTesting cmdlets + +## Az.LoadTesting Cmdlets +### [Get-AzLoad](Get-AzLoad.md) +Get the details of an Azure Load Testing resource. + +### [New-AzLoad](New-AzLoad.md) +Create a new Azure Load Testing resource. + +### [Remove-AzLoad](Remove-AzLoad.md) +Delete an Azure Load Testing resource. + +### [Update-AzLoad](Update-AzLoad.md) +Update an Azure Load Testing resource. + diff --git a/azps-10.1.0/Az.LoadTesting/Get-AzLoad.md b/azps-10.1.0/Az.LoadTesting/Get-AzLoad.md new file mode 100644 index 0000000000..780438a24c --- /dev/null +++ b/azps-10.1.0/Az.LoadTesting/Get-AzLoad.md @@ -0,0 +1,156 @@ +--- +external help file: +Module Name: Az.LoadTesting +online version: https://learn.microsoft.com/powershell/module/az.loadtesting/get-azload +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LoadTesting/help/Get-AzLoad.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LoadTesting/help/Get-AzLoad.md +--- + +# Get-AzLoad + +## SYNOPSIS +Get the details of an Azure Load Testing resource. + +## SYNTAX + +### List (Default) +``` +Get-AzLoad [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzLoad -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzLoad -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the details of an Azure Load Testing resource. + +## EXAMPLES + +### Example 1: Get all Azure Load Testing resources in a subscription +```powershell +Get-AzLoad +``` + +```output +Name Resource group Location DataPlane URL +---- -------------- -------- ------------- +sampleres sample-rg eastus 00000000-0000-0000-0000-000000000000.eastus.cnt-prod.loadtesting.azure.com +sampleres1 sample-rg eastus 00000000-0000-0000-0000-000000000001.eastus.cnt-prod.loadtesting.azure.com +``` + +This command lists all Azure Load Testing resources in the subscription. + +### Example 2: Get all Azure Load Testing resources in a resource group +```powershell +Get-AzLoad -ResourceGroupName sample-rg +``` + +```output +Name Resource group Location DataPlane URL +---- -------------- -------- ------------- +sampleres sample-rg eastus 00000000-0000-0000-0000-000000000000.eastus.cnt-prod.loadtesting.azure.com +sampleres1 sample-rg eastus 00000000-0000-0000-0000-000000000001.eastus.cnt-prod.loadtesting.azure.com +``` + +This command lists all Azure Load Testing resources in resource group named sample-rg. + +### Example 3: Get the details of an Azure Load Testing resource +```powershell +Get-AzLoad -Name sampleres -ResourceGroupName sample-rg +``` + +```output +Name Resource group Location DataPlane URL +---- -------------- -------- ------------- +sampleres sample-rg eastus 00000000-0000-0000-0000-000000000000.eastus.cnt-prod.loadtesting.azure.com +``` + +This command gets the details of the Azure Load Testing resource named sampleres in resource group named sample-rg. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Load Testing resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: LoadTestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LoadTesting.Models.Api20221201.ILoadTestResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LoadTesting/New-AzLoad.md b/azps-10.1.0/Az.LoadTesting/New-AzLoad.md new file mode 100644 index 0000000000..a6925d5d49 --- /dev/null +++ b/azps-10.1.0/Az.LoadTesting/New-AzLoad.md @@ -0,0 +1,319 @@ +--- +external help file: +Module Name: Az.LoadTesting +online version: https://learn.microsoft.com/powershell/module/az.loadtesting/new-azload +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LoadTesting/help/New-AzLoad.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LoadTesting/help/New-AzLoad.md +--- + +# New-AzLoad + +## SYNOPSIS +Create a new Azure Load Testing resource. + +## SYNTAX + +``` +New-AzLoad -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-EncryptionIdentity <String>] [-EncryptionKey <String>] [-IdentityType <ManagedServiceIdentityType>] + [-IdentityUserAssigned <Hashtable>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Azure Load Testing resource in the resource group. + +## EXAMPLES + +### Example 1: Create an Azure Load Testing resource +```powershell +New-AzLoad -Name sampleres -ResourceGroupName sample-rg -Location eastus +``` + +```output +Name Resource group Location DataPlane URL +---- -------------- -------- ------------- +sampleres sample-rg eastus 00000000-0000-0000-0000-000000000000.eastus.cnt-prod.loadtesting.azure.com +``` + +This command creates a new Azure Load Testing resource named sampleres in resource group named sample-rg and in the region East US. + +### Example 2: Create an Azure Load Testing resource with Managed Identity +```powershell +$userAssigned = @{"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" = @{}; "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2" = @{}} + +New-AzLoad -Name sampleres -ResourceGroupName sample-rg -Location eastus -IdentityType "SystemAssigned,UserAssigned" -IdentityUserAssigned $userAssigned +``` + +```output +Name Resource group Location DataPlane URL +---- -------------- -------- ------------- +sampleres sample-rg eastus 00000000-0000-0000-0000-000000000000.eastus.cnt-prod.loadtesting.azure.com +``` + +This command creates a new Azure Load Testing resource named sampleres in resource group named sample-rg and in the region East US, with System-Assigned and 2 provided User-Assigned managed identities. + +### Example 3: Create an Azure Load Testing resource with Customer Managed key encryption +```powershell +$userAssigned = @{"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" = @{}} + +New-AzLoad -Name sampleres -ResourceGroupName sample-rg -Location eastus -IdentityType "SystemAssigned,UserAssigned" -IdentityUserAssigned $userAssigned -EncryptionIdentity "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" -EncryptionKey "https://sample-akv.vault.azure.net/keys/cmk/2d1ccd5c50234ea2a0858fe148b69cde" +``` + +```output +Name Resource group Location DataPlane URL +---- -------------- -------- ------------- +sampleres sample-rg eastus 00000000-0000-0000-0000-000000000000.eastus.cnt-prod.loadtesting.azure.com +``` + +This command creates a new Azure Load Testing resource named sampleres in resource group named sample-rg and in the region East US, with the provided User-Assigned managed identity and uses the Encryption Identity to access the Encryption Key for CMK encryption. + +### Example 4: Create an Azure Load Testing resource with tags +```powershell +$tag = @{"key1" = "value1"; "key2" = "value2"} +New-AzLoad -Name sampleres -ResourceGroupName sample-rg -Location eastus -Tag $tag +``` + +```output +Name Resource group Location DataPlane URL +---- -------------- -------- ------------- +sampleres sample-rg eastus 00000000-0000-0000-0000-000000000000.eastus.cnt-prod.loadtesting.azure.com +``` + +This command creates a new Azure Load Testing resource named sampleres in resource group named sample-rg and in the region East US with the provided tags. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionIdentity +The managed identity for Customer-managed key settings defining which identity should be used to authenticate to Key Vault. +Ex: '/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/\<resource group\>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId' uses the given user-assigned managed identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKey +Encryption key URL, versioned. +Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed identity. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LoadTesting.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssigned +The list of user assigned identities associated with the resource. +The user identity will be ARM resource ids. +The User Assigned Identity is a hashtable with keys in the form of an ARM resource id '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. +The values of the keys are empty objects ({}) in requests. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location where the Azure Load Testing resource needs to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the new Azure Load Testing resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LoadTestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table set as tags on the server. +For example: @{key0="value0";key1=$null;key2="value2"}. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LoadTesting.Models.Api20221201.ILoadTestResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LoadTesting/Remove-AzLoad.md b/azps-10.1.0/Az.LoadTesting/Remove-AzLoad.md new file mode 100644 index 0000000000..c077c9f4b6 --- /dev/null +++ b/azps-10.1.0/Az.LoadTesting/Remove-AzLoad.md @@ -0,0 +1,186 @@ +--- +external help file: +Module Name: Az.LoadTesting +online version: https://learn.microsoft.com/powershell/module/az.loadtesting/remove-azload +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LoadTesting/help/Remove-AzLoad.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LoadTesting/help/Remove-AzLoad.md +--- + +# Remove-AzLoad + +## SYNOPSIS +Delete an Azure Load Testing resource. + +## SYNTAX + +``` +Remove-AzLoad -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete an Azure Load Testing resource. + +## EXAMPLES + +### Example 1: Delete an Azure Load Testing resource +```powershell +Remove-AzLoad -Name sampleres1 -ResourceGroupName sample-rg +``` + +This command deletes the Azure Load Testing resource named sampleres1 in resource group named sample-rg. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Load Testing resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LoadTestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LoadTesting/Update-AzLoad.md b/azps-10.1.0/Az.LoadTesting/Update-AzLoad.md new file mode 100644 index 0000000000..7b64790823 --- /dev/null +++ b/azps-10.1.0/Az.LoadTesting/Update-AzLoad.md @@ -0,0 +1,290 @@ +--- +external help file: +Module Name: Az.LoadTesting +online version: https://learn.microsoft.com/powershell/module/az.loadtesting/update-azload +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LoadTesting/help/Update-AzLoad.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LoadTesting/help/Update-AzLoad.md +--- + +# Update-AzLoad + +## SYNOPSIS +Update an Azure Load Testing resource. + +## SYNTAX + +``` +Update-AzLoad -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-EncryptionIdentity <String>] [-EncryptionKey <String>] [-IdentityType <ManagedServiceIdentityType>] + [-IdentityUserAssigned <Hashtable>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an Azure Load Testing resource in a given resource group. + +## EXAMPLES + +### Example 1: Update an Azure Load Testing resource with tags +```powershell +$tag = @{"key0" = "value0"} +Update-AzLoad -Name sampleres -ResourceGroupName sample-rg -Tag $tag +``` + +```output +Name Resource group Location DataPlane URL +---- -------------- -------- ------------- +sampleres sample-rg eastus 00000000-0000-0000-0000-000000000000.eastus.cnt-prod.loadtesting.azure.com +``` + +This command updates the Azure Load Testing resource named sampleres in resource group named sample-rg with the provided tags. + +### Example 2: Update an Azure Load Testing resource to use System-Assigned identity for CMK encryption +```powershell +Update-AzLoad -Name sampleres -ResourceGroupName sample-rg -IdentityType "SystemAssigned" -EncryptionIdentity "SystemAssigned" -EncryptionKey "https://sample-akv.vault.azure.net/keys/cmk/2d1ccd5c50234ea2a0858fe148b69cde" +``` + +```output +Name Resource group Location DataPlane URL +---- -------------- -------- ------------- +sampleres sample-rg eastus 00000000-0000-0000-0000-000000000000.eastus.cnt-prod.loadtesting.azure.com +``` + +This command updates the Azure Load Testing resource named sampleres in resource group named sample-rg, to use System-assigned identity for accessing the encryption key for CMK encryption. + +### Example 3: Update an Azure Load Testing resource to remove an existing User-Assigned managed identity +```powershell +$userAssigned = @{"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" = @{}; "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2" = $null} + +Update-AzLoad -Name sampleres -ResourceGroupName sample-rg -IdentityType "SystemAssigned,UserAssigned" -IdentityUserAssigned $userAssigned +``` + +```output +Name Resource group Location DataPlane URL +---- -------------- -------- ------------- +sampleres sample-rg eastus 00000000-0000-0000-0000-000000000000.eastus.cnt-prod.loadtesting.azure.com +``` + +This command updates the Azure Load Testing resource named sampleres in resource group named sample-rg, to remove the user-assigned managed identity "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2" if already assigned to the resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionIdentity +The managed identity for Customer-managed key settings defining which identity should be used to authenticate to Key Vault. + +Ex: 'SystemAssigned' uses system-assigned managed identity, whereas '/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/\<resource group\>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId' uses the given user-assigned managed identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKey +Encryption key URL, versioned. +Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed identity. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.LoadTesting.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssigned +The list of user assigned identities associated with the resource. +The user identity will be ARM resource ids. +The User Assigned Identity is a hashtable with keys in the form of an ARM resource id '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. +The values of the keys can be empty objects ({}) to assign an identity and $null to remove an existing identity. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Load Testing resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LoadTestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table set as tags on the server. +For example: @{key0="value0";key1=$null;key2="value2"}. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.LoadTesting.Models.Api20221201.ILoadTestResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.LogicApp/Az.LogicApp.md b/azps-10.1.0/Az.LogicApp/Az.LogicApp.md new file mode 100644 index 0000000000..2005e64859 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Az.LogicApp.md @@ -0,0 +1,168 @@ +--- +Module Name: Az.LogicApp +Module Guid: 8a7d44bb-e747-4265-8f22-b3937961d709 +Download Help Link: https://learn.microsoft.com/powershell/module/az.logicapp +Help Version: 4.0.3.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Az.LogicApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Az.LogicApp.md +--- + +# Az.LogicApp Module +## Description +This topic displays help topics for the Logic Apps cmdlets. + +## Az.LogicApp Cmdlets +### [Get-AzIntegrationAccount](Get-AzIntegrationAccount.md) +Gets integration accounts. + +### [Get-AzIntegrationAccountAgreement](Get-AzIntegrationAccountAgreement.md) +Gets an integration account agreement. + +### [Get-AzIntegrationAccountAssembly](Get-AzIntegrationAccountAssembly.md) +Gets an integration account assembly. + +### [Get-AzIntegrationAccountBatchConfiguration](Get-AzIntegrationAccountBatchConfiguration.md) +Gets an integration account batch configuration. + +### [Get-AzIntegrationAccountCallbackUrl](Get-AzIntegrationAccountCallbackUrl.md) +Gets an integration account callback URL. + +### [Get-AzIntegrationAccountCertificate](Get-AzIntegrationAccountCertificate.md) +Gets integration account certificates from a resource group. + +### [Get-AzIntegrationAccountGeneratedIcn](Get-AzIntegrationAccountGeneratedIcn.md) +This cmdlet retrieves the current value of the generated interchange control number per agreement. + +### [Get-AzIntegrationAccountMap](Get-AzIntegrationAccountMap.md) +Gets an integration account map. + +### [Get-AzIntegrationAccountPartner](Get-AzIntegrationAccountPartner.md) +Gets integration account partners. + +### [Get-AzIntegrationAccountReceivedIcn](Get-AzIntegrationAccountReceivedIcn.md) +This cmdlet retrieves a specific received interchange control number per agreement and control number value. + +### [Get-AzIntegrationAccountSchema](Get-AzIntegrationAccountSchema.md) +Gets integration account schemas. + +### [Get-AzLogicApp](Get-AzLogicApp.md) +Gets a logic app from a resource group. + +### [Get-AzLogicAppRunAction](Get-AzLogicAppRunAction.md) +Gets an action from a logic app run. + +### [Get-AzLogicAppRunHistory](Get-AzLogicAppRunHistory.md) +Gets the run history of a logic app. + +### [Get-AzLogicAppTrigger](Get-AzLogicAppTrigger.md) +Gets the triggers of a logic app. + +### [Get-AzLogicAppTriggerCallbackUrl](Get-AzLogicAppTriggerCallbackUrl.md) +Gets a Logic App trigger callback URL. + +### [Get-AzLogicAppTriggerHistory](Get-AzLogicAppTriggerHistory.md) +Gets the history of triggers in a logic app. + +### [Get-AzLogicAppUpgradedDefinition](Get-AzLogicAppUpgradedDefinition.md) +Gets the upgraded definition for a logic app. + +### [New-AzIntegrationAccount](New-AzIntegrationAccount.md) +Creates an integration account. + +### [New-AzIntegrationAccountAgreement](New-AzIntegrationAccountAgreement.md) +Creates an integration account agreement. + +### [New-AzIntegrationAccountAssembly](New-AzIntegrationAccountAssembly.md) +Creates an integration account assembly. + +### [New-AzIntegrationAccountBatchConfiguration](New-AzIntegrationAccountBatchConfiguration.md) +Creates an integration account batch configuration. + +### [New-AzIntegrationAccountCertificate](New-AzIntegrationAccountCertificate.md) +Creates an integration account certificate. + +### [New-AzIntegrationAccountMap](New-AzIntegrationAccountMap.md) +Creates an integration account map. + +### [New-AzIntegrationAccountPartner](New-AzIntegrationAccountPartner.md) +Creates an integration account partner. + +### [New-AzIntegrationAccountSchema](New-AzIntegrationAccountSchema.md) +Creates an integration account schema. + +### [New-AzLogicApp](New-AzLogicApp.md) +Creates a logic app in a resource group. + +### [Remove-AzIntegrationAccount](Remove-AzIntegrationAccount.md) +Removes an integration account. + +### [Remove-AzIntegrationAccountAgreement](Remove-AzIntegrationAccountAgreement.md) +Removes an integration account agreement. + +### [Remove-AzIntegrationAccountAssembly](Remove-AzIntegrationAccountAssembly.md) +Removes an integration account assembly. + +### [Remove-AzIntegrationAccountBatchConfiguration](Remove-AzIntegrationAccountBatchConfiguration.md) +Removes an integration account batch configuration. + +### [Remove-AzIntegrationAccountCertificate](Remove-AzIntegrationAccountCertificate.md) +Removes an integration account certificate from a resource group. + +### [Remove-AzIntegrationAccountMap](Remove-AzIntegrationAccountMap.md) +Removes an integration account map. + +### [Remove-AzIntegrationAccountPartner](Remove-AzIntegrationAccountPartner.md) +Removes an integration account partner. + +### [Remove-AzIntegrationAccountReceivedIcn](Remove-AzIntegrationAccountReceivedIcn.md) +This cmdlet removes a specific received interchange control number per agreement and control number value. + +### [Remove-AzIntegrationAccountSchema](Remove-AzIntegrationAccountSchema.md) +Removes an integration account schema. + +### [Remove-AzLogicApp](Remove-AzLogicApp.md) +Removes a logic app from a resource group. + +### [Set-AzIntegrationAccount](Set-AzIntegrationAccount.md) +Modifies an integration account. + +### [Set-AzIntegrationAccountAgreement](Set-AzIntegrationAccountAgreement.md) +Modifies an integration account agreement. + +### [Set-AzIntegrationAccountAssembly](Set-AzIntegrationAccountAssembly.md) +Modifies an integration account assembly. + +### [Set-AzIntegrationAccountBatchConfiguration](Set-AzIntegrationAccountBatchConfiguration.md) +Modifies an integration account batch configuration. + +### [Set-AzIntegrationAccountCertificate](Set-AzIntegrationAccountCertificate.md) +Modifies an integration account certificate. + +### [Set-AzIntegrationAccountGeneratedIcn](Set-AzIntegrationAccountGeneratedIcn.md) +Updates the integration account generated interchange control number (ICN) in the Azure resource group. + +### [Set-AzIntegrationAccountMap](Set-AzIntegrationAccountMap.md) +Modifies an integration account map. + +### [Set-AzIntegrationAccountPartner](Set-AzIntegrationAccountPartner.md) +Modifies an integration account partner. + +### [Set-AzIntegrationAccountReceivedIcn](Set-AzIntegrationAccountReceivedIcn.md) +Updates the integration account received interchange control number (ICN) in the Azure resource group. + +### [Set-AzIntegrationAccountSchema](Set-AzIntegrationAccountSchema.md) +Modifies an integration account schema. + +### [Set-AzLogicApp](Set-AzLogicApp.md) +Modifies a logic app in a resource group. + +### [Start-AzLogicApp](Start-AzLogicApp.md) +Runs a logic app in a resource group. + +### [Stop-AzLogicAppRun](Stop-AzLogicAppRun.md) +Cancels a run of a logic app. + +### [Test-AzLogicApp](Test-AzLogicApp.md) +Validates a logic app definition. + diff --git a/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccount.md b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccount.md new file mode 100644 index 0000000000..2829ffd092 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccount.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 7BCF2086-05FA-43FB-9D19-7277374CB03E +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azintegrationaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccount.md +--- + +# Get-AzIntegrationAccount + +## SYNOPSIS +Gets integration accounts. + +## SYNTAX + +``` +Get-AzIntegrationAccount [-ResourceGroupName <String>] [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzIntegrationAccount** cmdlet gets integration accounts from a resource group. +Specify an integration account name and resource group name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get an integration account by name +```powershell +Get-AzIntegrationAccount -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31 +Name : IntegrationAccount31 +Type : Microsoft.Logic/integrationAccounts +Location : brazilsouth +Sku : +CreatedTime : 3/26/2016 4:26:07 PM +ChangedTime : 3/26/2016 4:26:07 PM +``` + +This command gets an integration account named IntegrationAccount31 from the specified resource group. + +### Example 2: Get integration accounts in a resource group +```powershell +Get-AzIntegrationAccount -ResourceGroupName "ResourceGroup11" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup1/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31 +Name : IntegrationAccount31 +Type : Microsoft.Logic/integrationAccounts +Location : brazilsouth +Sku : +CreatedTime : 3/26/2016 4:26:07 PM +ChangedTime : 3/26/2016 4:26:07 PM +``` + +This command gets integration accounts from a resource group named ResourceGroup11. + +### Example 3: Get all integration accounts +```powershell +Get-AzIntegrationAccount +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31 +Name : IntegrationAccount31 +Type : Microsoft.Logic/integrationAccounts +Location : brazilsouth +Sku : +CreatedTime : 3/26/2016 4:26:07 PM +ChangedTime : 3/26/2016 4:26:07 PM +``` + +This command gets all the integration accounts in your Azure subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccount + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountCallbackUrl](./Get-AzIntegrationAccountCallbackUrl.md) + +[New-AzIntegrationAccount](./New-AzIntegrationAccount.md) + +[Remove-AzIntegrationAccount](./Remove-AzIntegrationAccount.md) + +[Set-AzIntegrationAccount](./Set-AzIntegrationAccount.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountAgreement.md b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountAgreement.md new file mode 100644 index 0000000000..789b539288 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountAgreement.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 70C96DFC-F265-4792-AE62-DD224A4EE237 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azintegrationaccountagreement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountAgreement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountAgreement.md +--- + +# Get-AzIntegrationAccountAgreement + +## SYNOPSIS +Gets an integration account agreement. + +## SYNTAX + +``` +Get-AzIntegrationAccountAgreement [-ResourceGroupName <String>] [-Name <String>] [-AgreementName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzIntegrationAccountAgreement** cmdlet gets an integration account agreement from an Azure resource group. +Specify the integration account name, resource group name, and agreement name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get an integration account agreement +```powershell +Get-AzIntegrationAccountAgreement -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -AgreementName "IntegrationAccountAgreement06" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/TestIntegrationAccount/agreements/IntegrationAccount31 +Name : IntegrationAccount31 +Type : Microsoft.Logic/integrationAccounts/agreements +CreatedTime : 3/24/2016 9:08:46 PM +ChangedTime : 3/24/2016 9:08:59 PM +AgreementType : AS2 +HostPartner : TestHost +GuestPartner : TestGuest +HostIdentityQualifier : XX +HostIdentityValue : BB +GuestIdentityQualifier : ZZ +GuestIdentityValue : AA +Content : {"AS2":{"ReceiveAgreement":{"SenderBusinessIdentity":{"Qualifier":"AA","Value":"AA"},"ReceiverBusinessIdentity":{"Qualifier":"ZZ + ","Value":"ZZ"},"ProtocolSettings":{"MessageConnectionSettings":{"IgnoreCertificateNameMismatch":true,"SupportHttpStatusCodeCont + . . . +``` + +This command gets an integration account agreement named IntegrationAccountAgreement06. + +### Example 2: Get integration account agreements by resource group name +```powershell +Get-AzIntegrationAccountAgreement -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/TestIntegrationAccount/agreements/IntegrationAccount31 +Name : IntegrationAccount31 +Type : Microsoft.Logic/integrationAccounts/agreements +CreatedTime : 3/24/2016 9:08:46 PM +ChangedTime : 3/24/2016 9:08:59 PM +AgreementType : AS2 +HostPartner : TestHost +GuestPartner : TestGuest +HostIdentityQualifier : XX +HostIdentityValue : BB +GuestIdentityQualifier : ZZ +GuestIdentityValue : AA +Content : {"AS2":{"ReceiveAgreement":{"SenderBusinessIdentity":{"Qualifier":"AA","Value":"AA"},"ReceiverBusinessIdentity":{"Qualifier":"ZZ + ","Value":"ZZ"},"ProtocolSettings":{"MessageConnectionSettings":{"IgnoreCertificateNameMismatch":true,"SupportHttpStatusCodeCont + . . . +``` + +This command gets the integration account agreements by resource group name. + +## PARAMETERS + +### -AgreementName +Specifies the name of an integration account agreement. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountAgreement + +## NOTES + +## RELATED LINKS + +[New-AzIntegrationAccountAgreement](./New-AzIntegrationAccountAgreement.md) + +[Remove-AzIntegrationAccountAgreement](./Remove-AzIntegrationAccountAgreement.md) + +[Set-AzIntegrationAccountAgreement](./Set-AzIntegrationAccountAgreement.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountAssembly.md b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountAssembly.md new file mode 100644 index 0000000000..e85f4dd0f5 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountAssembly.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azintegrationaccountassembly +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountAssembly.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountAssembly.md +--- + +# Get-AzIntegrationAccountAssembly + +## SYNOPSIS +Gets an integration account assembly. + +## SYNTAX + +### ByIntegrationAccount (Default) +``` +Get-AzIntegrationAccountAssembly -ResourceGroupName <String> -ParentName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObject +``` +Get-AzIntegrationAccountAssembly -ParentObject <IntegrationAccount> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzIntegrationAccountAssembly -ParentResourceId <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzIntegrationAccountAssembly** cmdlet gets an assembly from an integration account. + +## EXAMPLES + +### Example 1: Get an assembly by parameters +```powershell +Get-AzIntegrationAccountAssembly -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -AssemblyName "sampleAssembly" +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.AssemblyProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/assemblies/sampleAssembly +Name : sampleAssembly +Type : Microsoft.Logic/integrationAccounts/assemblies +Location : +Tags : +``` + +Get an assembly named "sampleAssembly" located in the integration account "sampleIntegrationAccount" which is contained in the resource group "sampleResourceGroup". + +### Example 2: List all assemblies in an integration account by parameters +```powershell +Get-AzIntegrationAccountAssembly -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.AssemblyProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/assemblies/sampleAssembly +Name : sampleAssembly +Type : Microsoft.Logic/integrationAccounts/assemblies +Location : +Tags : + +Properties : Microsoft.Azure.Management.Logic.Models.AssemblyProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/assemblies/sampleAssembly2 +Name : sampleAssembly2 +Type : Microsoft.Logic/integrationAccounts/assemblies +Location : +Tags : +``` + +Get all assemblies located in the integration account "sampleIntegrationAccount" which is contained in the resource group "sampleResourceGroup". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration account assembly name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AssemblyName, ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentName +The integration account name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccount +Aliases: IntegrationAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +An integration account object. + +```yaml +Type: Microsoft.Azure.Management.Logic.Models.IntegrationAccount +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The integration account resource id. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountAssembly + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountBatchConfiguration.md b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountBatchConfiguration.md new file mode 100644 index 0000000000..93b5fa29a8 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountBatchConfiguration.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azintegrationaccountbatchconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountBatchConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountBatchConfiguration.md +--- + +# Get-AzIntegrationAccountBatchConfiguration + +## SYNOPSIS +Gets an integration account batch configuration. + +## SYNTAX + +### ByIntegrationAccount (Default) +``` +Get-AzIntegrationAccountBatchConfiguration -ResourceGroupName <String> -ParentName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObject +``` +Get-AzIntegrationAccountBatchConfiguration -ParentObject <IntegrationAccount> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzIntegrationAccountBatchConfiguration -ParentResourceId <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzIntegrationAccountBatchConfiguration** cmdlet gets an batch configuration from an integration account. + +## EXAMPLES + +### Example 1: Get a batch configuration by parameters +```powershell +Get-AzIntegrationAccountBatchConfiguration -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -BatchConfigurationName "sampleBatchConfig" +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.BatchConfigurationProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/batchConfigurations/sampleBatchConfig +Name : sampleBatchConfig +Type : Microsoft.Logic/integrationAccounts/batchConfigurations +Location : +Tags : +``` + +Get a batch configuration named "sampleBatchConfig" located in the integration account "sampleIntegrationAccount" which is contained in the resource group "sampleResourceGroup". + +### Example 2: List all batch configurations in an integration account by parameters +```powershell +Get-AzIntegrationAccountBatchConfiguration -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.BatchConfigurationProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/batchConfigurations/sampleBatchConfig +Name : sampleBatchConfig +Type : Microsoft.Logic/integrationAccounts/batchConfigurations +Location : +Tags : + +Properties : Microsoft.Azure.Management.Logic.Models.BatchConfigurationProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/batchConfigurations/sampleBatchConfig2 +Name : sampleBatchConfig2 +Type : Microsoft.Logic/integrationAccounts/batchConfigurations +Location : +Tags : +``` + +Get all batch configurations located in the integration account "sampleIntegrationAccount" which is contained in the resource group "sampleResourceGroup". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration account batch configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BatchConfigurationName, ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentName +The integration account name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccount +Aliases: IntegrationAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +An integration account object. + +```yaml +Type: Microsoft.Azure.Management.Logic.Models.IntegrationAccount +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The integration account resource id. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountBatchConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountCallbackUrl.md b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountCallbackUrl.md new file mode 100644 index 0000000000..2fc357551c --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountCallbackUrl.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 4813EE2B-16C4-4716-B6DD-9447A0B46F3D +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azintegrationaccountcallbackurl +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountCallbackUrl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountCallbackUrl.md +--- + +# Get-AzIntegrationAccountCallbackUrl + +## SYNOPSIS +Gets an integration account callback URL. + +## SYNTAX + +``` +Get-AzIntegrationAccountCallbackUrl -ResourceGroupName <String> -Name <String> [-NotAfter <DateTime>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzIntegrationAccountCallbackUrl** cmdlet gets an integration account callback URL from a resource group. +This cmdlet returns a **CallbackUrl** object that represents the integration account callback URL. +Specify the integration account name and resource group name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get an integration account callback URL +```powershell +Get-AzIntegrationAccountCallbackUrl -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -NotAfter "03/25/2016 18:23:22" +``` + +```output +CallBackUrl : https://<baseurl>/integrationAccounts/8811f0155a364b5e9618ba28f7180601?api-version=2015-08-01-preview&se=2016-03 + -25T18%3A23%3A22.0000000Z&sp=%2F%2Fread&sv=1.0&sig=<value> +``` + +This command gets an integration account callback URL. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotAfter +Specifies the expiry date for the callback URL. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.CallbackUrl + +## NOTES + +## RELATED LINKS + +[Get-AzLogicAppTriggerCallbackUrl](./Get-AzLogicAppTriggerCallbackUrl.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountCertificate.md b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountCertificate.md new file mode 100644 index 0000000000..bd9dbf77be --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountCertificate.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: C0086E73-CCB1-4B75-B367-C79E17738122 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azintegrationaccountcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountCertificate.md +--- + +# Get-AzIntegrationAccountCertificate + +## SYNOPSIS +Gets integration account certificates from a resource group. + +## SYNTAX + +``` +Get-AzIntegrationAccountCertificate [-ResourceGroupName <String>] [-Name <String>] [-CertificateName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzIntegrationAccountCertificate** cmdlet gets integration account certificates from a resource group. +Specify the integration account name, resource group name, and certificate name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get an integration account certificate +```powershell +Get-AzIntegrationAccountCertificate -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -CertificateName "IntegrationAccountCertificate01" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/certificates/IntegrationAccountCertificate01 +Name : IntegrationAccountCertificate01 +Type : Microsoft.Logic/integrationAccounts/certificates +CreatedTime : 3/26/2016 6:59:07 PM +ChangedTime : 3/26/2016 6:59:07 PM +KeyName : TestKey +KeyVersion : 1.0 +KeyVaultId : /subscriptions/<SubscriptionId/resourcegroups/ResourceGroup11/providers/microsoft.keyvault/vaults/<name> +KeyVaultName : testkeyvault +KeyVaultName : testkeyvault +PublicCertificate : +MetaData : +``` + +This command gets the integration account certificate named IntegrationAccountCertificate01. + +### Example 2: Get integration account certificates by integration account name +```powershell +Get-AzIntegrationAccountCertificate -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/certificates/IntegrationAccountCertificate01 +Name : IntegrationAccountCertificate01 +Type : Microsoft.Logic/integrationAccounts/certificates +CreatedTime : 3/26/2016 6:59:07 PM +ChangedTime : 3/26/2016 6:59:07 PM +KeyName : TestKey +KeyVersion : 1.0 +KeyVaultId : /subscriptions/<SubscriptionId>/resourcegroups/ResourceGroup11/providers/microsoft.keyvault/vaults/<name> +KeyVaultName : testkeyvault +KeyVaultName : testkeyvault +PublicCertificate : +MetaData : +``` + +This command gets the integration account certificates for the integration account named IntegrationAccount31. + +## PARAMETERS + +### -CertificateName +Specifies the name of an integration account certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountCertificate + +## NOTES + +## RELATED LINKS + +[New-AzIntegrationAccountCertificate](./New-AzIntegrationAccountCertificate.md) + +[Remove-AzIntegrationAccountCertificate](./Remove-AzIntegrationAccountCertificate.md) + +[Set-AzIntegrationAccountCertificate](./Set-AzIntegrationAccountCertificate.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountGeneratedIcn.md b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountGeneratedIcn.md new file mode 100644 index 0000000000..61d6f886c0 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountGeneratedIcn.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azintegrationaccountgeneratedicn +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountGeneratedIcn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountGeneratedIcn.md +--- + +# Get-AzIntegrationAccountGeneratedIcn + +## SYNOPSIS +This cmdlet retrieves the current value of the generated interchange control number per agreement. + +## SYNTAX + +``` +Get-AzIntegrationAccountGeneratedIcn -ResourceGroupName <String> -Name <String> [-AgreementName <String>] + [-AgreementType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet is meant to be used in disaster recovery scenarios to retrieve the current value of the generated interchange control number so to write back an increased value with Set-AzIntegrationAccountGeneratedIcn. +The interchange control number should be increased to avoid duplicate interchange control numbers for the numbers that could not yet be replicated to the passive region when the disaster happened in the active region. +Please do provide the "-AgreementType" parameter to specify whether X12 or Edifact control numbers to return + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIntegrationAccountGeneratedIcn -AgreementType "X12" -ResourceGroupName "ResourceGroup1" -Name "IntegrationAccount1" -AgreementName "X12IntegrationAccountAgreement" +``` + +```output +ControlNumber : 1000 +ControlNumberChangedTime : 2/15/2017 12:36:00 AM +IsMessageProcessingFailed: +``` + +This command gets the integration account generated X12 interchange control number by agreement name. Please make sure agreement specified is of type "X12" + +### Example 2 +```powershell +Get-AzIntegrationAccountGeneratedIcn -AgreementType "Edifact" -ResourceGroupName "ResourceGroup1" -Name "IntegrationAccount1" -AgreementName "EdifactIntegrationAccountAgreement" +``` + +```output +ControlNumber : 1000 +ControlNumberChangedTime : 2/15/2017 12:36:00 AM +IsMessageProcessingFailed: +``` + +This command gets the integration account generated Edifact interchange control number by agreement name. Please make sure agreement specified is of type "Edifact" + +### Example 3 +```powershell +Get-AzIntegrationAccountGeneratedIcn -AgreementType "X12" -ResourceGroupName "ResourceGroup1" -Name "IntegrationAccount1" +``` + +```output +ControlNumber : 1000 +ControlNumberChangedTime : 2/22/2017 8:05:41 PM +AgreementName : X12IntegrationAccountAgreement1 +IsMessageProcessingFailed: + +ControlNumber : 1000 +ControlNumberChangedTime : 2/22/2017 8:05:41 PM +AgreementName : X12IntegrationAccountAgreement2 +IsMessageProcessingFailed: + +ControlNumber : No generated control number was found for this agreement. +ControlNumberChangedTime : 1/1/0001 12:00:00 AM +AgreementName : X12IntegrationAccountAgreement3 +IsMessageProcessingFailed: +``` + +This command gets all the generated X12 interchange control numbers by integration account name. + +## PARAMETERS + +### -AgreementName +The integration account agreement name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgreementType +The integration account agreement type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MessageType +Accepted values: X12, Edifact + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The integration account resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.LogicApp.Utilities.IntegrationAccountControlNumber + +## NOTES + +## RELATED LINKS + +[Set-AzIntegrationAccountGeneratedIcn](./Set-AzIntegrationAccountGeneratedIcn.md) + diff --git a/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountMap.md b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountMap.md new file mode 100644 index 0000000000..1788a75a29 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountMap.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 4F65A8B3-A250-41C1-9AA5-DBEB3193C401 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azintegrationaccountmap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountMap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountMap.md +--- + +# Get-AzIntegrationAccountMap + +## SYNOPSIS +Gets an integration account map. + +## SYNTAX + +``` +Get-AzIntegrationAccountMap [-ResourceGroupName <String>] [-Name <String>] [-MapName <String>] + [-MapType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzIntegrationAccountMap** cmdlet gets integration account map from a resource group. +Specifying the integration account name, resource group name, and map name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get an integration account map +```powershell +Get-AzIntegrationAccountMap -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -MapName "IntegrationAccountMap47" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/maps/IntegrationAccountMap47 +Name : IntegrationAccountMap47 +Type : Microsoft.Logic/integrationAccounts/maps +CreatedTime : 3/24/2016 10:34:26 PM +ChangedTime : 3/24/2016 10:34:26 PM +MapType : Xslt +ContentType : +ContentLink : https://<baseurl>/integrationaccounts8811f0155a364b5e9618ba28f7180601/99D1E_XSLT_INTEGRATIONACCOUNT + MAP1-9A960F9B71C844CDB09D4922B3BCFF61?sv=2014-02-14&sr=b&sig=<value> +ContentSize : 3056 +Metadata : +``` + +This command gets an integration account map named IntegrationAccountMap47 in the specified resource group. + +### Example 2: Get integration account maps by integration account name +```powershell +Get-AzIntegrationAccountMap -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/maps/IntegrationAccountMap47 +Name : IntegrationAccountMap47 +Type : Microsoft.Logic/integrationAccounts/maps +CreatedTime : 3/24/2016 10:34:26 PM +ChangedTime : 3/24/2016 10:34:26 PM +MapType : Xslt +ContentType : +ContentLink : https://<baseurl>/integrationaccounts8811f0155a364b5e9618ba28f7180601/99D1E_XSLT_INTEGRATIONACCOUNT + MAP1-9A960F9B71C844CDB09D4922B3BCFF61?sv=2014-02-14&sr=b&sig=<value> +ContentSize : 3056 +Metadata : +``` + +This command gets the integration account maps by integration account name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MapName +Specifies the name of an integration account map. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MapType +The integration account map type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Xslt, Xslt20, Xslt30, Liquid + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name for the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountMap + +## NOTES + +## RELATED LINKS + +[New-AzIntegrationAccountMap](./New-AzIntegrationAccountMap.md) + +[Remove-AzIntegrationAccountMap](./Remove-AzIntegrationAccountMap.md) + +[Set-AzIntegrationAccountMap](./Set-AzIntegrationAccountMap.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountPartner.md b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountPartner.md new file mode 100644 index 0000000000..43bc795250 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountPartner.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 6E84E26F-8150-41F8-8823-CEED05619A75 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azintegrationaccountpartner +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountPartner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountPartner.md +--- + +# Get-AzIntegrationAccountPartner + +## SYNOPSIS +Gets integration account partners. + +## SYNTAX + +``` +Get-AzIntegrationAccountPartner [-ResourceGroupName <String>] [-Name <String>] [-PartnerName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzIntegrationAccountPartner** cmdlet gets integration account partners from a resource group. +Specify the integration account name, resource group name, and partner name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get an integration account partner +```powershell +Get-AzIntegrationAccountPartner -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -PartnerName "IntegrationAccountPartner22" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/TestIntegrationAccount/partners/IntegrationAccountPartner31 +Name : IntegrationAccountPartner31 +Type : Microsoft.Logic/integrationAccounts/partners +PartnerType : B2B +CreatedTime : 3/24/2016 8:46:05 PM +ChangedTime : 3/24/2016 8:47:47 PM +BusinessIdentities : {"Qualifier":"CC","Value":"FF"} +Metadata : +``` + +This command gets the integration account partner named IntegrationAccountPartner22. + +### Example 2: Get an integration account partners by using an integration account name +```powershell +Get-AzIntegrationAccountPartner -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/TestIntegrationAccount/partners/IntegrationAccountPartner31 +Name : IntegrationAccountPartner31 +Type : Microsoft.Logic/integrationAccounts/partners +PartnerType : B2B +CreatedTime : 3/24/2016 8:46:05 PM +ChangedTime : 3/24/2016 8:47:47 PM +BusinessIdentities : {"Qualifier":"CC","Value":"FF"} +Metadata : +``` + +This command gets the integration account partners for the integration account named IntegrationAccount31. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerName +Specifies the name of the integration account partner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountPartner + +## NOTES + +## RELATED LINKS + +[New-AzIntegrationAccountPartner](./New-AzIntegrationAccountPartner.md) + +[Remove-AzIntegrationAccountPartner](./Remove-AzIntegrationAccountPartner.md) + +[Set-AzIntegrationAccountPartner](./Set-AzIntegrationAccountPartner.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountReceivedIcn.md b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountReceivedIcn.md new file mode 100644 index 0000000000..f6bb4b931d --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountReceivedIcn.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azintegrationaccountreceivedicn +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountReceivedIcn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountReceivedIcn.md +--- + +# Get-AzIntegrationAccountReceivedIcn + +## SYNOPSIS +This cmdlet retrieves a specific received interchange control number per agreement and control number value. + +## SYNTAX + +``` +Get-AzIntegrationAccountReceivedIcn -ResourceGroupName <String> -Name <String> -AgreementName <String> + -ControlNumberValue <String> [-AgreementType <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet is meant to be used in disaster recovery scenarios to validate the presence of a received interchange control number and optionally to remove that entity with Remove-AzIntegrationAccountReceivedIcn. +Please do provide the "-AgreementType" parameter to specify whether X12 or Edifact control numbers to return + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIntegrationAccountReceivedIcn -AgreementType "X12" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "X12AgreementName" -ControlNumberValue "000000641" +``` + +```output +ControlNumber : 000000641 +ControlNumberChangedTime : 2/15/2017 12:36:00 AM +IsMessageProcessingFailed: False +``` + +This command gets the X12 integration account received interchange control number by agreement name and control number value. + +### Example 2 +```powershell +Get-AzIntegrationAccountReceivedIcn -AgreementType "Edifact" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "EdifactAgreementName" -ControlNumberValue "000000641" +``` + +```output +ControlNumber : 000000641 +ControlNumberChangedTime : 2/15/2017 12:36:00 AM +IsMessageProcessingFailed: False +``` + +This command gets the Edifact integration account received interchange control number by agreement name and control number value. + +## PARAMETERS + +### -AgreementName +The integration account agreement name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgreementType +The integration account agreement type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MessageType +Accepted values: X12, Edifact + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlNumberValue +The integration account control number value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The integration account resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.LogicApp.Utilities.IntegrationAccountControlNumber + +## NOTES + +## RELATED LINKS + +[Set-AzIntegrationAccountReceivedIcn](./Set-AzIntegrationAccountReceivedIcn.md) + +[Remove-AzIntegrationAccountReceivedIcn](./Remove-AzIntegrationAccountReceivedIcn.md) diff --git a/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountSchema.md b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountSchema.md new file mode 100644 index 0000000000..850cdc158b --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzIntegrationAccountSchema.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 6C16B04B-459A-4B2C-B7DF-AC4D16FF7281 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azintegrationaccountschema +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountSchema.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzIntegrationAccountSchema.md +--- + +# Get-AzIntegrationAccountSchema + +## SYNOPSIS +Gets integration account schemas. + +## SYNTAX + +``` +Get-AzIntegrationAccountSchema [-ResourceGroupName <String>] [-Name <String>] [-SchemaName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzIntegrationAccountSchema** cmdlet gets integration account schemas. +Specifying the integration account name, resource group name, and schema name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get an integration account schema +```powershell +Get-AzIntegrationAccountSchema -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -SchemaName "IntegrationAccountSchema43" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/schemas/IntegrationAccountSchema43 +Name : IntegrationAccountSchema43 +Type : Microsoft.Logic/integrationAccounts/schemas +CreatedTime : 3/25/2016 5:42:58 PM +ChangedTime : 3/25/2016 5:42:58 PM +SchemaType : Xml +ContentType : +ContentLink : https://<baseurl>/integrationaccounts469af4f3cf4047b7ac3a08c87948ec5f/3839E_XML_INTEGRATIONACCOUNTSCHEMA43-5A86631F61F + 14513AA1185A52C6B2874?sv=2014-02-14&sr=b&sig=<value> +ContentSize : 7901 +MetaData : +``` + +This command gets the integration account schema named IntegrationAccountSchema43. + +### Example 2: Get integration account schemas for a resource group +```powershell +Get-AzIntegrationAccountSchema -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/schemas/IntegrationAccountSchema43 +Name : IntegrationAccountSchema43 +Type : Microsoft.Logic/integrationAccounts/schemas +CreatedTime : 3/25/2016 5:42:58 PM +ChangedTime : 3/25/2016 5:42:58 PM +SchemaType : Xml +ContentType : +ContentLink : https://<baseurl>/integrationaccounts469af4f3cf4047b7ac3a08c87948ec5f/3839E_XML_INTEGRATIONACCOUNTSCHEMA43-5A86631F61F + 14513AA1185A52C6B2874?sv=2014-02-14&sr=b&sig=<value> +ContentSize : 7901 +MetaData : +``` + +This command gets the integration account schemas for the resource group named ResourceGroup11. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Specifies the name of an integration account schema. +Specifies the name of a schema. +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountSchema + +## NOTES + +## RELATED LINKS + +[New-AzIntegrationAccountSchema](./New-AzIntegrationAccountSchema.md) + +[Remove-AzIntegrationAccountSchema](./Remove-AzIntegrationAccountSchema.md) + +[Set-AzIntegrationAccountSchema](./Set-AzIntegrationAccountSchema.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Get-AzLogicApp.md b/azps-10.1.0/Az.LogicApp/Get-AzLogicApp.md new file mode 100644 index 0000000000..32225e9ce4 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzLogicApp.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 7BFCD982-EC80-418B-BB52-C9941D028F76 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azlogicapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicApp.md +--- + +# Get-AzLogicApp + +## SYNOPSIS +Gets a logic app from a resource group. + +## SYNTAX + +### ListWorkflows (Default) +``` +Get-AzLogicApp [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByVersion +``` +Get-AzLogicApp -ResourceGroupName <String> -Name <String> -Version <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLogicApp** cmdlet gets a logic app. +This cmdlet returns a **Workflow** object. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get a logic app from a resource group +```powershell +Get-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp03" +``` + +```output +Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp03 +Name : LogicApp03 +Type : Microsoft.Logic/workflows +Location : westus +ChangedTime : 1/13/2016 2:41:39 PM +CreatedTime : 1/13/2016 2:41:39 PM +AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup11/providers/Microsoft.Logic/workflows/LogicApp03 +State : Enabled +DefinitionLinkUri : +DefinitionLinkContentVersion : +Definition : {$schema, contentVersion, parameters, triggers...} +ParametersLinkUri : +ParametersLinkContentVersion : +Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]} +SkuName : Standard +PlanName : StandardServicePlan +PlanType : Microsoft.Web/ServerFarms +PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/StandardServicePlan +Version : 08587489107859952120 +``` + +This command gets a logic app from the resource group named ResourceGroup11. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the logic app that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ListWorkflows +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByVersion +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name for a resource group in which this cmdlet gets a logic app. + +```yaml +Type: System.String +Parameter Sets: ListWorkflows +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByVersion +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Specifies the version of a logic app. + +```yaml +Type: System.String +Parameter Sets: GetByVersion +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.Workflow + +### Microsoft.Azure.Management.Logic.Models.WorkflowVersion + +## NOTES + +## RELATED LINKS + +[New-AzLogicApp](./New-AzLogicApp.md) + +[Remove-AzLogicApp](./Remove-AzLogicApp.md) + +[Set-AzLogicApp](./Set-AzLogicApp.md) + +[Start-AzLogicApp](./Start-AzLogicApp.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Get-AzLogicAppRunAction.md b/azps-10.1.0/Az.LogicApp/Get-AzLogicAppRunAction.md new file mode 100644 index 0000000000..0b9c1c8461 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzLogicAppRunAction.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 2EA28B90-4BAE-45DF-BD2E-60C74F53FB7B +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azlogicapprunaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicAppRunAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicAppRunAction.md +--- + +# Get-AzLogicAppRunAction + +## SYNOPSIS + +Gets an action from a logic app run. + +## SYNTAX + +```powershell +Get-AzLogicAppRunAction -ResourceGroupName <String> -Name <String> -RunName <String> [-ActionName <String>] + [-FollowNextPageLink] [-MaximumFollowNextPageLink <Int32>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION + +The **Get-AzLogicAppRunAction** cmdlet gets an action from a logic app run. +This cmdlet returns a **WorkflowRunAction** objects. +Specify the logic app, resource group, and run. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get an action from a Logic App run + +```powershell +Get-AzLogicAppRunAction -ResourceGroupName "ResourceGroup11" -Name "LogicApp05" -RunName "08585925184423369718380498702CU26" -ActionName "LogicAppAction01" +``` + +```output +Code : NotFound +EndTime : 1/13/2016 2:42:56 PM +Error : +InputsLink : Microsoft.Azure.Management.Logic.Models.ContentLink +Name : LogicAppAction01 +OutputsLink : Microsoft.Azure.Management.Logic.Models.ContentLink +StartTime : 1/13/2016 2:42:55 PM +Status : Failed +TrackingId : +Type : +``` + +This command gets a specific Logic App action from the logic app named LogicApp05 for the run with identifier 08585925184423369718380498702CU26. + +### Example 2: Get all the actions from a Logic App run + +```powershell +Get-AzLogicAppRunAction -ResourceGroupName "ResourceGroup11" -Name "LogicApp05" -RunName "08585925184423369718380498702CU26" -FollowNextPageLink +``` + +This command gets all Logic App actions from a run with identifier 08585925184423369718380498702CU26 of a logic app named LogicApp05. + +## PARAMETERS + +### -ActionName + +Specifies the name of an action in a logic app run. +This cmdlet gets the action that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FollowNextPageLink + +Indicates the cmdlet should follow next page links. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: FL + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumFollowNextPageLink + +Specifies how many times to follow next page links if FollowNextPageLink is used. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: ML + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +Specifies the name of a logic app for which this cmdlet gets an action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specifies the name of a resource group in which this cmdlet gets an action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunName + +Specifies the name of a run of a logic app. +This cmdlet gets an action for the run that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.WorkflowRunAction + +## NOTES + +## RELATED LINKS + +[Get-AzLogicAppRunHistory](./Get-AzLogicAppRunHistory.md) + +[Stop-AzLogicAppRun](./Stop-AzLogicAppRun.md) diff --git a/azps-10.1.0/Az.LogicApp/Get-AzLogicAppRunHistory.md b/azps-10.1.0/Az.LogicApp/Get-AzLogicAppRunHistory.md new file mode 100644 index 0000000000..7034de1d36 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzLogicAppRunHistory.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: F271BCB1-6D43-48E5-BB51-00288F57BFFB +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azlogicapprunhistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicAppRunHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicAppRunHistory.md +--- + +# Get-AzLogicAppRunHistory + +## SYNOPSIS + +Gets the run history of a logic app. + +## SYNTAX + +```powershell +Get-AzLogicAppRunHistory -ResourceGroupName <String> -Name <String> [-RunName <String>] [-FollowNextPageLink] + [-MaximumFollowNextPageLink <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION + +The **Get-AzLogicAppRunHistory** cmdlet gets the run history of a logic app. +This cmdlet returns a collection of **WorkflowRun** objects. +Specify the logic app and resource group. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get the run history of a logic app + +```powershell +Get-AzLogicAppRunHistory -ResourceGroupName "Resourcegroup11" -Name "LogicApp03" +``` + +```output +CorrelationId : 55830326-9042-404d-a4c3-fab198106a57 +EndTime : 1/13/2016 2:46:55 PM +Error : {code, message} +Name : 08587489104702792076 +Outputs : {} +StartTime : 1/13/2016 2:46:55 PM +Status : Failed +TriggerName : +LogicAppName : LogicApp03 +LogicAppVersion : 08587489107859952540 + +CorrelationId : d3ddc917-9aaa-47b3-8814-c621c2ae530b +EndTime : 1/13/2016 2:42:56 PM +Error : {code, message} +Name : 08587489107100664541 +Outputs : {} +StartTime : 1/13/2016 2:42:55 PM +Status : Failed +TriggerName : httpTrigger +LogicAppName : LogicApp03 +LogicAppVersion : 08587489107859952120 +``` + +This command gets the run history of a logic app named LogicApp03. + +### Example 2: Get a logic app run + +```powershell +Get-AzLogicAppRunHistory -ResourceGroupName "Resourcegroup11" -Name "LogicApp03" -RunName "08587489104702792076" +``` + +```output +CorrelationId : 55830326-9042-404d-a4c3-fab198106a57 +EndTime : 1/13/2016 2:46:55 PM +Error : {code, message} +Name : 08587489104702792076 +Outputs : {} +StartTime : 1/13/2016 2:46:55 PM +Status : Failed +TriggerName : +LogicAppName : LogicApp03 +LogicAppVersion : 08587489107859952120 +``` + +This command gets a specific logic app run for the logic app named LogicApp03. + +### Example 3 + +```powershell +Get-AzLogicAppRunHistory -Name 'LogicApp03' -ResourceGroupName MyResourceGroup -FollowNextPageLink +``` + +This command gets the entire run history of a logic app named LogicApp03 by following the NextPageLink. + +### Example 4 + +```powershell +Get-AzLogicAppRunHistory -Name 'LogicApp03' -ResourceGroupName MyResourceGroup -FollowNextPageLink -MaximumFollowNextPageLink 1 +``` + +This command gets the first two pages of run history of a logic app named LogicApp03 by following the NextPageLink and limiting the result size to two pages. +Each page contains thirty results. + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FollowNextPageLink + +Indicates the cmdlet should follow next page links. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: FL + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumFollowNextPageLink + +Specifies how many times to follow next page links if FollowNextPageLink is used. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: ML + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +Specifies the name of the logic app for which this cmdlet gets run history. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specifies the name of a resource group that contains the logic app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunName + +Specifies the run name of a logic app. +This cmdlet gets the workflow run that this cmdlet specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.WorkflowRun + +## NOTES + +## RELATED LINKS + +[Get-AzLogicAppRunAction](./Get-AzLogicAppRunAction.md) + +[Start-AzLogicApp](./Start-AzLogicApp.md) + +[Stop-AzLogicAppRun](./Stop-AzLogicAppRun.md) diff --git a/azps-10.1.0/Az.LogicApp/Get-AzLogicAppTrigger.md b/azps-10.1.0/Az.LogicApp/Get-AzLogicAppTrigger.md new file mode 100644 index 0000000000..ca93ea6ec2 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzLogicAppTrigger.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 5307F1F1-E84C-4949-A557-99EF0012C3DF +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azlogicapptrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicAppTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicAppTrigger.md +--- + +# Get-AzLogicAppTrigger + +## SYNOPSIS +Gets the triggers of a logic app. + +## SYNTAX + +``` +Get-AzLogicAppTrigger -ResourceGroupName <String> -Name <String> [-TriggerName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLogicAppTrigger** cmdlet gets triggers from a logic app. +This cmdlet returns a **WorkflowTrigger** object. +Specify the workflow, resource group, and trigger. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get a trigger of a logic app +```powershell +Get-AzLogicAppTrigger -ResourceGroupName "ResourceGroup11" -Name "LogicApp05" -TriggerName "Trigger01" +``` + +```output +ChangedTime : 1/14/2016 11:45:07 AM +CreatedTime : 1/13/2016 2:42:26 PM +LastExecutionTime : 1/14/2016 11:45:07 AM +Name : Trigger01 +NextExecutionTime : 1/14/2016 12:45:07 PM +RecurrenceFrequency : Minute +RecurrenceInterval : 60 +Status : Waiting +Type : Microsoft.Logic/workflows/triggers +LogicAppName : LogicApp05 +LogicAppVersion : 08587489107406290826 +``` + +This command gets the trigger named Trigger01 from the logic app named LogicApp05. + +### Example 2: Get all triggers of a logic app +```powershell +Get-AzLogicAppTrigger -ResourceGroupName "ResourceGroup11" -Name "LogicApp07" +``` + +```output +ChangedTime : 1/14/2016 11:45:07 AM +CreatedTime : 1/13/2016 2:42:26 PM +LastExecutionTime : 1/14/2016 11:45:07 AM +Name : Trigger02 +NextExecutionTime : 1/14/2016 12:45:07 PM +RecurrenceFrequency : Minute +RecurrenceInterval : 60 +Status : Waiting +Type : Microsoft.Logic/workflows/triggers +LogicAppName : LogicApp07 +LogicAppVersion : 08587489107406290826 +``` + +This command gets the triggers of the logic app named LogicApp07. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the logic app from which this cmdlet gets a trigger. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet gets a trigger. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TriggerName +Specifies the name of the trigger that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.WorkflowTrigger + +## NOTES + +## RELATED LINKS + +[Get-AzLogicAppTriggerHistory](./Get-AzLogicAppTriggerHistory.md) + +[Start-AzLogicApp](./Start-AzLogicApp.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Get-AzLogicAppTriggerCallbackUrl.md b/azps-10.1.0/Az.LogicApp/Get-AzLogicAppTriggerCallbackUrl.md new file mode 100644 index 0000000000..de5b919e07 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzLogicAppTriggerCallbackUrl.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: F523CFA0-427B-41AF-9C2D-EB54EC96C04B +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azlogicapptriggercallbackurl +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicAppTriggerCallbackUrl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicAppTriggerCallbackUrl.md +--- + +# Get-AzLogicAppTriggerCallbackUrl + +## SYNOPSIS +Gets a Logic App trigger callback URL. + +## SYNTAX + +``` +Get-AzLogicAppTriggerCallbackUrl -ResourceGroupName <String> -Name <String> -TriggerName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLogicAppTriggerCallbackUrl** cmdlet gets a Logic App trigger callback URL from a resource group. +This cmdlet returns a **WorkflowTriggerCallbackUrl** object that represents the callback URL. +Specify the resource group name, logic app name, and trigger name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get a Logic App trigger callback URL +```powershell +Get-AzLogicAppTriggerCallbackUrl -ResourceGroupName "ResourceGroup11" -Name "LogicApp1" -TriggerName "manual" +``` + +```output +Value +----- +https://prod-03.westus.logic.azure.com:443/workflows/c4ed9335bc864140a11f4508d19acea3/triggers/manual/run?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=<value> +``` + +This command gets a Logic App trigger callback URL. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a logic app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TriggerName +Specifies the name of a trigger. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.WorkflowTriggerCallbackUrl + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountCallbackUrl](./Get-AzIntegrationAccountCallbackUrl.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Get-AzLogicAppTriggerHistory.md b/azps-10.1.0/Az.LogicApp/Get-AzLogicAppTriggerHistory.md new file mode 100644 index 0000000000..aeaed65557 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzLogicAppTriggerHistory.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: C1F6BBF9-0DB5-46FD-B8A8-9029B0AB6166 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azlogicapptriggerhistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicAppTriggerHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicAppTriggerHistory.md +--- + +# Get-AzLogicAppTriggerHistory + +## SYNOPSIS + +Gets the history of triggers in a logic app. + +## SYNTAX + +```powershell +Get-AzLogicAppTriggerHistory -ResourceGroupName <String> -Name <String> -TriggerName <String> + [-HistoryName <String>] [-FollowNextPageLink] [-MaximumFollowNextPageLink <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION + +The **Get-AzLogicAppTriggerHistory** cmdlet gets the history of triggers in a logic app in the Logic Apps feature. +This cmdlet returns a **WorkflowTriggerHistory** object. +Specify the logic app, resource group, and trigger. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get a trigger history of a logic app + +```powershell +Get-AzLogicAppTriggerHistory -ResourceGroupName "Resourcegroup11" -Name "LogicApp03" -TriggerName "Trigger01" -HistoryName "08587489107387695768" +``` + +```output +Code : BadRequest +EndTime : 1/13/2016 2:42:26 PM +Error : {code, message} +Fired : False +InputsLink : https://flowprodcu02by01.blob.core.windows.net/flow3ea9ffd11c684c9f9f258b1a6ea5cb6020160113t000000zcontent/A7392_d1e831de68ac4ef89d19a40f05e663 + cb_httpTrigger:5Finputs:2Ejson?sv=2014-02-14&sr=b&sig=&se=2016-01-14T16%3A15%3A16Z&sp=r +Name : 08587489107387695768 +OutputsLink : +Run : +StartTime : 1/13/2016 2:42:26 PM +Status : Failed +TrackingId : f88a499b-f80f-4a28-9bbf-c4cc0d129700 +Type : Microsoft.Logic/workflows/triggers/histories +``` + +This command gets a specific logic app trigger history for a trigger in the logic app named LogicApp03. + +### Example 2: Get trigger histories of a logic app + +```powershell +Get-AzLogicAppTriggerHistory -ResourceGroupName "ResourceGroup11" -Name "LogicApp07" -TriggerName "Trigger01" +``` + +```output +Code : BadRequest +EndTime : 1/13/2016 2:43:33 PM +Error : {code, message} +Fired : False +InputsLink : https://flowprodcu02by01.blob.core.windows.net/flow3ea9ffd11c684c9f9f258b1a6ea5cb6020160113t000000zcontent/CAB46_60e2ad0f0e1947e8b5798716914c5d + b6_httpTrigger:5Finputs:2Ejson?sv=2014-02-14&sr=b&sig=&se=2016-01-14T16%3A18%3A27Z&sp=r +Name : 08587489106716457817 +OutputsLink : +Run : +StartTime : 1/13/2016 2:43:33 PM +Status : Failed +TrackingId : c91a63f1-48b4-4eae-91eb-8f6dbfa9fe06 +Type : Microsoft.Logic/workflows/triggers/histories + +Code : BadRequest +EndTime : 1/13/2016 2:42:26 PM +Error : {code, message} +Fired : False +InputsLink : https://flowprodcu02by01.blob.core.windows.net/flow3ea9ffd11c684c9f9f258b1a6ea5cb6020160113t000000zcontent/A7392_d1e831de68ac4ef89d19a40f05e663 + cb_httpTrigger:5Finputs:2Ejson?sv=2014-02-14&sr=b&sig=&se=2016-01-14T16%3A18%3A27Z&sp=r +Name : 08587489107387695768 +OutputsLink : +Run : +StartTime : 1/13/2016 2:42:26 PM +Status : Failed +TrackingId : f88a499b-f80f-4a28-9bbf-c4cc0d129700 +Type : Microsoft.Logic/workflows/triggers/histories +``` + +This command gets the workflow trigger histories for a trigger in the logic app named LogicApp07. + +### Example 3: Get entire trigger history of a logic app + +```powershell +Get-AzLogicAppTriggerHistory -ResourceGroupName "ResourceGroup11" -Name "LogicApp08" -TriggerName "Trigger01" -FollowNextPageLink +``` + +This command gets the entire workflow trigger history for a trigger in the logic app named LogicApp08 by following the NextPageLink. + +### Example 4 + +```powershell +Get-AzLogicAppTriggerHistory -ResourceGroupName "ResourceGroup11" -Name "LogicApp08" -TriggerName "Trigger01" -FollowNextPageLink -MaximumFollowNextPageLink 1 +``` + +This command gets the first two pages of workflow trigger history for a trigger in the logic app named LogicApp09 by following the NextPageLink and limiting the result size to two pages. +Each page contains thirty results. + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FollowNextPageLink + +Indicates the cmdlet should follow next page links. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: FL + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoryName + +Specifies the name of the history that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumFollowNextPageLink + +Specifies how many times to follow next page links if FollowNextPageLink is used. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: ML + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +Specifies the name of the logic app for which this cmdlet gets trigger history. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specifies the name of the resource group in which this cmdlet gets history. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TriggerName + +Specifies the name of the trigger for which this cmdlet gets history. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.WorkflowTriggerHistory + +## NOTES + +## RELATED LINKS + +[Get-AzLogicAppRunHistory](./Get-AzLogicAppRunHistory.md) + +[Get-AzLogicAppTrigger](./Get-AzLogicAppTrigger.md) + +[Start-AzLogicApp](./Start-AzLogicApp.md) diff --git a/azps-10.1.0/Az.LogicApp/Get-AzLogicAppUpgradedDefinition.md b/azps-10.1.0/Az.LogicApp/Get-AzLogicAppUpgradedDefinition.md new file mode 100644 index 0000000000..33ce7bba9e --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Get-AzLogicAppUpgradedDefinition.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: B7FED447-C398-47D7-AF1B-A3E4FDAD0B41 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/get-azlogicappupgradeddefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicAppUpgradedDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Get-AzLogicAppUpgradedDefinition.md +--- + +# Get-AzLogicAppUpgradedDefinition + +## SYNOPSIS +Gets the upgraded definition for a logic app. + +## SYNTAX + +``` +Get-AzLogicAppUpgradedDefinition -ResourceGroupName <String> -Name <String> -TargetSchemaVersion <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLogicAppUpgradedDefinition** cmdlet gets the upgraded definition for the schema version and logic app from a resource group. +This cmdlet returns an object that represents the definition of the upgraded logic app. +Specify the resource group name, logic app name, and target schema version. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Get a logic app upgraded definition +```powershell +$UpgradedDefinition = Get-AzLogicAppUpgradedDefinition -ResourceGroupName "ResourceGroup11" -Name "LogicApp01" -TargetSchemaVersion "2016-06-01" +$UpgradedDefinition.ToString() +``` + +```output +{ + + "$schema": "http://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#", + + "contentVersion": "1.0.0.0", + + "parameters": {}, + + "triggers": { + + "httpTrigger": { + + "recurrence": { + + "frequency": "Hour", + + "interval": 1 + + }, + + "type": "Http", + + "inputs": { + + "method": "GET", + + "uri": "http://www.bing.com" + + }, + + "conditions": [ + + { + + "expression": "@bool('true')" + + } + + ] + + }, + + "manualTrigger": { + + "type": "Request", + + "kind": "Http" + + } + + }, + + "actions": { + + "httpScope": { + + "actions": { + + "http": { + + "runAfter": {}, + + "type": "Http", + + "inputs": { + + "method": "GET", + + "uri": "http://www.bing.com" + + } + + } + + }, + + "runAfter": {}, + + "else": { + + "actions": {} + + }, + + "expression": "@bool('true')", + + "type": "If" + + }, + + "http1Scope": { + + "actions": { + + "http1": { + + "runAfter": {}, + + "type": "Http", + + "inputs": { + + "method": "GET", + + "uri": "http://www.bing.com" + + } + + } + + }, + + "runAfter": {}, + + "else": { + + "actions": {} + + }, + + "expression": "@bool('true')", + + "type": "If" + + } + + }, + + "outputs": { + + "output1": { + + "type": "String", + + "value": "true" + + } + + } + +} +``` + +The first command gets the definition for the logic app upgraded to the specified target schema version. +The command stores the definition in the $UpgradedDefinition variable. +The second command displays the contents of $UpgradedDefinition as a string. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a logic app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetSchemaVersion +Specifies the target schema version of the definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-AzLogicApp](./Get-AzLogicApp.md) + + diff --git a/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccount.md b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccount.md new file mode 100644 index 0000000000..7ca5246773 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccount.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 5F1A4FE0-CB57-45D3-9F08-879469A61E1E +online version: https://learn.microsoft.com/powershell/module/az.logicapp/new-azintegrationaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccount.md +--- + +# New-AzIntegrationAccount + +## SYNOPSIS +Creates an integration account. + +## SYNTAX + +``` +New-AzIntegrationAccount -ResourceGroupName <String> -Name <String> -Location <String> [-Sku <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzIntegrationAccount** cmdlet creates an integration account. +This cmdlet returns an object that represents the integration account.Specify a name, location, resource group name, and SKU name. +Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Create an integration account +```powershell +New-AzIntegrationAccount -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -Location "brazilsouth" -Sku "Standard" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31 +Name : IntegrationAccount31 +Type : Microsoft.Logic/integrationAccounts +Location : brazilsouth +Sku : +CreatedTime : 3/26/2016 4:26:07 PM +ChangedTime : 3/26/2016 4:26:07 PM +``` + +This command creates an integration account named IntegrationAccount31 in the specified resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies a location for the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Specifies a SKU name for the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Free, Basic, Standard + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccount + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccount](./Get-AzIntegrationAccount.md) + +[Remove-AzIntegrationAccount](./Remove-AzIntegrationAccount.md) + +[Set-AzIntegrationAccount](./Set-AzIntegrationAccount.md) + + diff --git a/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountAgreement.md b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountAgreement.md new file mode 100644 index 0000000000..c53df34bcd --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountAgreement.md @@ -0,0 +1,344 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: B8998AAA-05FC-4029-A284-B64E23326B22 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/new-azintegrationaccountagreement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountAgreement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountAgreement.md +--- + +# New-AzIntegrationAccountAgreement + +## SYNOPSIS +Creates an integration account agreement. + +## SYNTAX + +``` +New-AzIntegrationAccountAgreement -ResourceGroupName <String> -Name <String> -AgreementName <String> + -AgreementType <String> -GuestPartner <String> -HostPartner <String> -GuestIdentityQualifier <String> + -GuestIdentityQualifierValue <String> -HostIdentityQualifier <String> -HostIdentityQualifierValue <String> + [-AgreementContent <String>] [-AgreementContentFilePath <String>] [-Metadata <Object>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzIntegrationAccountAgreement** cmdlet creates an integration account agreement. +This cmdlet returns an object that represents the integration account agreement. +Specify the integration account name, resource group name, agreement name, type, partner name, partner qualifiers, and agreement content. +Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Create a integration account agreement +```powershell +New-AzIntegrationAccountAgreement -Name "IntegrationAccount31"-ResourceGroupName "ResourceGroup11" -AgreementName "IntegrationAccountAgreement06" -AgreementType "X12" -GuestPartner "GuestPartner" -HostPartner "HostPartner" -GuestIdentityQualifier "BB" -HostIdentityQualifier "AA" -AgreementContentFilePath "C:\temp\AgreementContent.json" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/agreements/IntegrationAccountAgreement06 +Name : IntegrationAccountAgreement06 +Type : Microsoft.Logic/integrationAccounts/agreements +CreatedTime : 3/26/2016 6:43:52 PM +ChangedTime : 3/26/2016 6:43:52 PM +AgreementType : X12 +HostPartner : HostPartner +GuestPartner : GuestPartner +HostIdentityQualifier : AA +HostIdentityValue : AA +GuestIdentityQualifier : BB +GuestIdentityValue : BB +Content : {"AS2":null,"X12":{"ReceiveAgreement":{"SenderBusinessIdentity":{"Qualifier":"AA","Value":"AA"},"ReceiverBusinessIdentity":{"Qualifier":"ZZ","Valu + e":"ZZ"},"ProtocolSettings":{"ValidationSettings":{"ValidateCharacterSet":true,"CheckDuplicateInterchangeControlNumber":false,"InterchangeControlN + + . . . +``` + +This command creates an integration account agreement in the specified Azure resource group. + +### Example 2 + +Creates an integration account agreement. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +New-AzIntegrationAccountAgreement -AgreementContent <String> -AgreementName 'IntegrationAccountAgreement06' -AgreementType X12 -GuestIdentityQualifier 'BB' -GuestIdentityQualifierValue <String> -GuestPartner 'GuestPartner' -HostIdentityQualifier 'AA' -HostIdentityQualifierValue <String> -HostPartner 'HostPartner' -Name 'IntegrationAccount31' -ResourceGroupName 'ResourceGroup11' +``` + +## PARAMETERS + +### -AgreementContent +Specifies agreement content, in JavaScript Object Notation (JSON) format, for the agreement. +Specify either this parameter or the *AgreementContentFilePath* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgreementContentFilePath +Specifies the file path of agreement content for the agreement. +Specify either this parameter or the *AgreementContent* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgreementName +Specifies a name for the integration account agreement. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AgreementType +Specifies the integration account agreement type. +The acceptable values for this parameter are: +- X12 +- AS2 +- Edifact + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: X12, AS2, Edifact + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestIdentityQualifier +Specifies a name business identity qualifier for the guest partner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestIdentityQualifierValue +The integration account agreement guest identity qualifier value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestPartner +Specifies the name of the guest partner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostIdentityQualifier +Specifies a name business identity qualifier for the host partner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostIdentityQualifierValue +The integration account agreement host identity qualifier value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPartner +Specifies the name of the host partner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies a metadata object for the agreement. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountAgreement + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountAgreement](./Get-AzIntegrationAccountAgreement.md) + +[Remove-AzIntegrationAccountAgreement](./Remove-AzIntegrationAccountAgreement.md) + +[Set-AzIntegrationAccountAgreement](./Set-AzIntegrationAccountAgreement.md) + + diff --git a/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountAssembly.md b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountAssembly.md new file mode 100644 index 0000000000..65143f55c0 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountAssembly.md @@ -0,0 +1,324 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +online version: https://learn.microsoft.com/powershell/module/az.logicapp/new-azintegrationaccountassembly +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountAssembly.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountAssembly.md +--- + +# New-AzIntegrationAccountAssembly + +## SYNOPSIS +Creates an integration account assembly. + +## SYNTAX + +### ByIntegrationAccountAndFilePath (Default) +``` +New-AzIntegrationAccountAssembly -ResourceGroupName <String> -ParentName <String> -Name <String> + -AssemblyFilePath <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationAccountAndContentLink +``` +New-AzIntegrationAccountAssembly -ResourceGroupName <String> -ParentName <String> -Name <String> + -ContentLink <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByIntegrationAccountAndFileBytes +``` +New-AzIntegrationAccountAssembly -ResourceGroupName <String> -ParentName <String> -Name <String> + -AssemblyData <Byte[]> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObjectAndContentLink +``` +New-AzIntegrationAccountAssembly -ParentObject <IntegrationAccount> -Name <String> -ContentLink <String> + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectAndFileBytes +``` +New-AzIntegrationAccountAssembly -ParentObject <IntegrationAccount> -Name <String> -AssemblyData <Byte[]> + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectAndFilePath +``` +New-AzIntegrationAccountAssembly -ParentObject <IntegrationAccount> -Name <String> -AssemblyFilePath <String> + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdAndContentLink +``` +New-AzIntegrationAccountAssembly -ParentResourceId <String> -Name <String> -ContentLink <String> + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdAndFileBytes +``` +New-AzIntegrationAccountAssembly -ParentResourceId <String> -Name <String> -AssemblyData <Byte[]> + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdAndFilePath +``` +New-AzIntegrationAccountAssembly -ParentResourceId <String> -Name <String> -AssemblyFilePath <String> + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzIntegrationAccountAssembly** cmdlet creates a new assembly in an integration account. + +## EXAMPLES + +### Example 1: Create new assembly using local file +```powershell +New-AzIntegrationAccountAssembly -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -AssemblyName "sampleAssembly" -AssemblyFilePath $localAssemblyFilePath +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.AssemblyProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/assemblies/sampleAssembly +Name : sampleAssembly +Type : Microsoft.Logic/integrationAccounts/assemblies +Location : +Tags : +``` + +Creates a new assembly using the local file located at the file path contained in "$localAssemblyFilePath". + +### Example 2: Create new assembly using byte data +```powershell +New-AzIntegrationAccountAssembly -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -AssemblyName "sampleAssembly" -AssemblyData $assemblyContent +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.AssemblyProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/assemblies/sampleAssembly +Name : sampleAssembly +Type : Microsoft.Logic/integrationAccounts/assemblies +Location : +Tags : +``` + +Creates a new assembly using the a byte array contained in "$assemblyContent". + +### Example 3: Create new assembly using a content link +```powershell +New-AzIntegrationAccountAssembly -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -AssemblyName "sampleAssembly" -ContentLink $assemblyUrl +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.AssemblyProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/assemblies/sampleAssembly +Name : sampleAssembly +Type : Microsoft.Logic/integrationAccounts/assemblies +Location : +Tags : +``` + +Creates a new assembly using the a byte data located at the URL "$assemblyUrl". This is the suggested method for creating large sized assemblies. + +## PARAMETERS + +### -AssemblyData +The integration account assembly byte data. + +```yaml +Type: System.Byte[] +Parameter Sets: ByIntegrationAccountAndFileBytes, ByInputObjectAndFileBytes, ByResourceIdAndFileBytes +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssemblyFilePath +The integration account assembly file path. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndFilePath, ByInputObjectAndFilePath, ByResourceIdAndFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentLink +A publicly accessible link to the integration account assembly data. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndContentLink, ByInputObjectAndContentLink, ByResourceIdAndContentLink +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +The integration account assembly metadata. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration account assembly name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AssemblyName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentName +The integration account name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndFilePath, ByIntegrationAccountAndContentLink, ByIntegrationAccountAndFileBytes +Aliases: IntegrationAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +An integration account object. + +```yaml +Type: Microsoft.Azure.Management.Logic.Models.IntegrationAccount +Parameter Sets: ByInputObjectAndContentLink, ByInputObjectAndFileBytes, ByInputObjectAndFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The integration account resource id. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdAndContentLink, ByResourceIdAndFileBytes, ByResourceIdAndFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndFilePath, ByIntegrationAccountAndContentLink, ByIntegrationAccountAndFileBytes +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountAssembly + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountBatchConfiguration.md b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountBatchConfiguration.md new file mode 100644 index 0000000000..4c42193eab --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountBatchConfiguration.md @@ -0,0 +1,424 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +online version: https://learn.microsoft.com/powershell/module/az.logicapp/new-azintegrationaccountbatchconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountBatchConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountBatchConfiguration.md +--- + +# New-AzIntegrationAccountBatchConfiguration + +## SYNOPSIS +Creates an integration account batch configuration. + +## SYNTAX + +### ByIntegrationAccountAndParameters (Default) +``` +New-AzIntegrationAccountBatchConfiguration -ResourceGroupName <String> -ParentName <String> -Name <String> + [-BatchGroupName <String>] [-MessageCount <Int32>] [-BatchSize <Int32>] [-ScheduleInterval <Int32>] + [-ScheduleFrequency <String>] [-ScheduleTimeZone <String>] [-ScheduleStartTime <DateTime>] + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationAccountAndJson +``` +New-AzIntegrationAccountBatchConfiguration -ResourceGroupName <String> -ParentName <String> -Name <String> + -BatchConfigurationDefinition <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationAccountAndFilePath +``` +New-AzIntegrationAccountBatchConfiguration -ResourceGroupName <String> -ParentName <String> -Name <String> + -BatchConfigurationFilePath <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectAndJson +``` +New-AzIntegrationAccountBatchConfiguration -ParentObject <IntegrationAccount> -Name <String> + -BatchConfigurationDefinition <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectAndFilePath +``` +New-AzIntegrationAccountBatchConfiguration -ParentObject <IntegrationAccount> -Name <String> + -BatchConfigurationFilePath <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectAndParameters +``` +New-AzIntegrationAccountBatchConfiguration -ParentObject <IntegrationAccount> -Name <String> + [-BatchGroupName <String>] [-MessageCount <Int32>] [-BatchSize <Int32>] [-ScheduleInterval <Int32>] + [-ScheduleFrequency <String>] [-ScheduleTimeZone <String>] [-ScheduleStartTime <DateTime>] + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdAndJson +``` +New-AzIntegrationAccountBatchConfiguration -ParentResourceId <String> -Name <String> + -BatchConfigurationDefinition <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdAndFilePath +``` +New-AzIntegrationAccountBatchConfiguration -ParentResourceId <String> -Name <String> + -BatchConfigurationFilePath <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdAndParameters +``` +New-AzIntegrationAccountBatchConfiguration -ParentResourceId <String> -Name <String> [-BatchGroupName <String>] + [-MessageCount <Int32>] [-BatchSize <Int32>] [-ScheduleInterval <Int32>] [-ScheduleFrequency <String>] + [-ScheduleTimeZone <String>] [-ScheduleStartTime <DateTime>] [-Metadata <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzIntegrationAccountBatchConfiguration** cmdlet creates a new batch configuration in an integration account. + +## EXAMPLES + +### Example 1: Create new batch configuration using local file +```powershell +New-AzIntegrationAccountBatchConfiguration -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -BatchConfigurationName "sampleBatchConfig" -BatchConfigurationFilePath $batchConfigurationFilePath +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.BatchConfigurationProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/batchConfigurations/sampleBatchConfig +Name : sampleBatchConfig +Type : Microsoft.Logic/integrationAccounts/batchConfigurations +Location : +Tags : +``` + +Creates a new batch configuration using the local file located at the file path contained in "$batchConfigurationFilePath". + +### Example 2: Create new batch configuration using a JSON string +```powershell +New-AzIntegrationAccountBatchConfiguration -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -BatchConfigurationName "sampleBatchConfig" -BatchConfigurationDefinition $batchConfigurationContent +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.BatchConfigurationProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/batchConfigurations/sampleBatchConfig +Name : sampleBatchConfig +Type : Microsoft.Logic/integrationAccounts/batchConfigurations +Location : +Tags : +``` + +Creates a new batch configuration using the a JSON string contained in "$batchConfigurationContent". + +### Example 3: Create new batch configuration using parameters +```powershell +New-AzIntegrationAccountBatchConfiguration -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -BatchConfigurationName "sampleBatchConfig" -MessageCount 199 -BatchSize 5 -ScheduleInterval 1 -ScheduleFrequency "Month" +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.BatchConfigurationProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/batchConfigurations/sampleBatchConfig +Name : sampleBatchConfig +Type : Microsoft.Logic/integrationAccounts/batchConfigurations +Location : +Tags : +``` + +Creates a new batch configuration by manually providing all of the necessary parameters. + +## PARAMETERS + +### -BatchConfigurationDefinition +The integration account batch configuration definition. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndJson, ByInputObjectAndJson, ByResourceIdAndJson +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchConfigurationFilePath +The integration account batch configuration file path. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndFilePath, ByInputObjectAndFilePath, ByResourceIdAndFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchGroupName +The integration account batch configuration group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +The integration account batch configuration batch size. + +```yaml +Type: System.Int32 +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageCount +The integration account batch configuration message count. + +```yaml +Type: System.Int32 +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +The integration account batch configuration metadata. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration account batch configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BatchConfigurationName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentName +The integration account name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndParameters, ByIntegrationAccountAndJson, ByIntegrationAccountAndFilePath +Aliases: IntegrationAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +An integration account object. + +```yaml +Type: Microsoft.Azure.Management.Logic.Models.IntegrationAccount +Parameter Sets: ByInputObjectAndJson, ByInputObjectAndFilePath, ByInputObjectAndParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The integration account batch configuration resource id. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdAndJson, ByResourceIdAndFilePath, ByResourceIdAndParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndParameters, ByIntegrationAccountAndJson, ByIntegrationAccountAndFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleFrequency +The integration account batch configuration schedule frequency. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: +Accepted values: Month, Week, Day, Hour, Minute, Second + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInterval +The integration account batch configuration schedule interval. + +```yaml +Type: System.Int32 +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleStartTime +The integration account batch configuration schedule start time. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleTimeZone +The integration account batch configuration schedule time zone. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountBatchConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountCertificate.md b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountCertificate.md new file mode 100644 index 0000000000..3b3f473324 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountCertificate.md @@ -0,0 +1,310 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: BB1B49CD-B42F-4222-B0BA-0AA4CE3C95E0 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/new-azintegrationaccountcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountCertificate.md +--- + +# New-AzIntegrationAccountCertificate + +## SYNOPSIS +Creates an integration account certificate. + +## SYNTAX + +### PrivateKey +``` +New-AzIntegrationAccountCertificate -ResourceGroupName <String> -Name <String> -CertificateName <String> + -KeyName <String> -KeyVersion <String> -KeyVaultId <String> [-PublicCertificateFilePath <String>] + [-Metadata <Object>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PublicKey +``` +New-AzIntegrationAccountCertificate -ResourceGroupName <String> -Name <String> -CertificateName <String> + [-KeyName <String>] [-KeyVersion <String>] [-KeyVaultId <String>] -PublicCertificateFilePath <String> + [-Metadata <Object>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Both +``` +New-AzIntegrationAccountCertificate -ResourceGroupName <String> -Name <String> -CertificateName <String> + -KeyName <String> -KeyVersion <String> -KeyVaultId <String> -PublicCertificateFilePath <String> + [-Metadata <Object>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzIntegrationAccountCertificate** cmdlet creates an integration account certificate. +This cmdlet returns an object that represents the integration account certificate. +Specify the integration account name, resource group name, certificate name, key name, key version, and key vault ID. +Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Create an integration account certificate +```powershell +New-AzIntegrationAccountCertificate -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -CertificateName "IntegrationAccountCertificate01" -KeyName "TestKey" -KeyVersion "1.0" -KeyVaultId "/subscriptions/<subscriptionId>/resourcegroups/ResourceGroup11/providers/microsoft.keyvault/vaults/keyvault" -PublicCertificateFilePath "c:\temp\Certificate.cer" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/certificates/IntegrationAccountCertificate01 +Name : IntegrationAccountCertificate01 +Type : Microsoft.Logic/integrationAccounts/certificates +CreatedTime : 3/26/2016 6:59:07 PM +ChangedTime : 3/26/2016 6:59:07 PM +KeyName : TestKey +KeyVersion : 1.0 +KeyVaultId : /subscriptions/<SubscriptionId>/resourcegroups/ResourceGroup11/providers/microsoft.keyvault/vaults/<name> +KeyVaultName : testkeyvault +KeyVaultName : testkeyvault +PublicCertificate : +MetaData : +``` + +This command creates the integration account certificate in the specified resource group. + +## PARAMETERS + +### -CertificateName +Specifies a name for the integration account certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +Specifies the name of the certificate key in the key vault. + +```yaml +Type: System.String +Parameter Sets: PrivateKey, Both +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: PublicKey +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultId +Specifies a key vault ID. + +```yaml +Type: System.String +Parameter Sets: PrivateKey, Both +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: PublicKey +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVersion +Specifies the version of the certificate key in the key vault. + +```yaml +Type: System.String +Parameter Sets: PrivateKey, Both +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: PublicKey +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies a metadata object for the certificate. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicCertificateFilePath +Specifies the path of a public certificate (.cer) file. + +```yaml +Type: System.String +Parameter Sets: PrivateKey +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: PublicKey, Both +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountCertificate + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountCertificate](./Get-AzIntegrationAccountCertificate.md) + +[Remove-AzIntegrationAccountCertificate](./Remove-AzIntegrationAccountCertificate.md) + +[Set-AzIntegrationAccountCertificate](./Set-AzIntegrationAccountCertificate.md) + + diff --git a/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountMap.md b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountMap.md new file mode 100644 index 0000000000..954c28f2f4 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountMap.md @@ -0,0 +1,260 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: DF71430C-F33F-409B-A550-CC7285252E91 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/new-azintegrationaccountmap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountMap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountMap.md +--- + +# New-AzIntegrationAccountMap + +## SYNOPSIS +Creates an integration account map. + +## SYNTAX + +``` +New-AzIntegrationAccountMap -ResourceGroupName <String> -Name <String> -MapName <String> + [-MapFilePath <String>] [-MapDefinition <String>] [-MapType <String>] [-ContentType <String>] + [-Metadata <Object>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzIntegrationAccountMap** cmdlet creates an integration account map. +This cmdlet returns an object that represents the integration account map. +Specifying the integration account name, resource group name, map name, and map definition. +Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Create an integration account map +```powershell +New-AzIntegrationAccountMap -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -MapName "IntegrationAccountMap47" -MapDefinition $MapContent +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/maps/IntegrationAccountMap47 +Name : IntegrationAccountMap47 +Type : Microsoft.Logic/integrationAccounts/maps +CreatedTime : 3/26/2016 7:12:22 PM +ChangedTime : 3/26/2016 7:12:22 PM +MapType : Xslt +ContentLink : https://<baseurl>/integrationaccounts68a13b6b49f14995ba7c5f3aedcbd7ad/99D1E_XSLT_INTEGRATIONACCOUNTMAP47-9C97D973088B4256A1893B + BCB1F85246?sv=2014-02-14&sr=b&sig=<value> +ContentSize : 3056 +Metadata : +``` + +This command creates the integration account map in the specified resource group. +The command specifies a map definition stored in the $MapContent variable by a previous command. + +### Example 2 + +Creates an integration account map. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +New-AzIntegrationAccountMap -MapFilePath <String> -MapName 'IntegrationAccountMap47' -MapType Xslt -Name 'IntegrationAccount31' -ResourceGroupName 'ResourceGroup11' +``` + +## PARAMETERS + +### -ContentType +Specifies a content type for the integration account map. +This cmdlet supports application/xml as a map content type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MapDefinition +Specifies a definition object for integration account map. +Specify either this parameter or the *MapFilePath* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MapFilePath +Specifies the file path of a definition for the integration account map. +Specify either this parameter or the *MapDefinition* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MapName +Specifies a name for the integration account map. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MapType +Specifies the type for the integration account map. +This cmdlet supports Xslt as a map type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Xslt, Xslt20, Xslt30, Liquid + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies a metadata object for the map. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountMap + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountMap](./Get-AzIntegrationAccountMap.md) + +[Remove-AzIntegrationAccountMap](./Remove-AzIntegrationAccountMap.md) + +[Set-AzIntegrationAccountMap](./Set-AzIntegrationAccountMap.md) + + diff --git a/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountPartner.md b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountPartner.md new file mode 100644 index 0000000000..b9422f13ff --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountPartner.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 2B5FC268-4888-4AEB-B125-7263CF2E4DCD +online version: https://learn.microsoft.com/powershell/module/az.logicapp/new-azintegrationaccountpartner +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountPartner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountPartner.md +--- + +# New-AzIntegrationAccountPartner + +## SYNOPSIS +Creates an integration account partner. + +## SYNTAX + +``` +New-AzIntegrationAccountPartner -ResourceGroupName <String> -Name <String> -PartnerName <String> + [-PartnerType <String>] -BusinessIdentities <Object> [-Metadata <Object>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzIntegrationAccountPartner** cmdlet creates an integration account partner. +This cmdlet returns an object that represents the integration account partner. +Specify the integration account name, resource group name, partner name, and partner identities. +Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Create an integration account partner +```powershell +$BusinessIdentities = @("ZZ","AA"),@("XX","GG") +New-AzIntegrationAccountPartner -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -PartnerName "IntegrationAccountPartner22" -PartnerType "B2B" -BusinessIdentities $BusinessIdentities +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/partners/IntegrationAccountPartner22 +Name : IntegrationAccountPartner22 +Type : Microsoft.Logic/integrationAccounts/partners +PartnerType : B2B +CreatedTime : 3/26/2016 7:29:30 PM +ChangedTime : 3/26/2016 7:29:30 PM +BusinessIdentities : [{"Qualifier":"ZZ","Value":"AA"},{"Qualifier":"XX","Value":"GG"}] +Metadata : +``` + +This command creates the integration account partner named IntegrationAccountPartner22 in the specified resource group. + +## PARAMETERS + +### -BusinessIdentities +Specifies business identities for the integration account partner. It is a nested array, with inner arrays containing the Qualifier as the first object/string and the Value as the second object/string. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies a metadata object for the partner. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerName +Specifies a name for the integration account partner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerType +Specifies the type of the integration account. +This parameter supports the type B2B. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: B2B + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountPartner + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountPartner](./Get-AzIntegrationAccountPartner.md) + +[Remove-AzIntegrationAccountPartner](./Remove-AzIntegrationAccountPartner.md) + +[Set-AzIntegrationAccountPartner](./Set-AzIntegrationAccountPartner.md) + + diff --git a/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountSchema.md b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountSchema.md new file mode 100644 index 0000000000..42b9509b45 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/New-AzIntegrationAccountSchema.md @@ -0,0 +1,249 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 91FFBEE9-A488-49ED-8C6C-2DE891CE0749 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/new-azintegrationaccountschema +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountSchema.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzIntegrationAccountSchema.md +--- + +# New-AzIntegrationAccountSchema + +## SYNOPSIS +Creates an integration account schema. + +## SYNTAX + +``` +New-AzIntegrationAccountSchema -ResourceGroupName <String> -Name <String> -SchemaName <String> + [-SchemaFilePath <String>] [-SchemaDefinition <String>] [-SchemaType <String>] [-ContentType <String>] + [-Metadata <Object>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzIntegrationAccountSchema** cmdlet creates an integration account schema. +This cmdlet returns an object that represents the integration account schema. +Specify the integration account name, resource group name, schema name, and schema definition. +Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Create the integration account schema +```powershell +New-AzIntegrationAccountSchema -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -SchemaName "IntegrationAccountSchema1" -SchemaFilePath "c:\temp\schema1" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/schemas/IntegrationAccountSchema1 +Name : IntegrationAccountSchema1 +Type : Microsoft.Logic/integrationAccounts/schemas +CreatedTime : 3/26/2016 7:21:10 PM +ChangedTime : 3/26/2016 7:21:10 PM +SchemaType : Xml +ContentLink : https://<baseurl>/integrationaccounts68a13b6b49f14995ba7c5f3aedcbd7ad/3839E_XML_INTEGRATIONACCOUNTSCHEMA2-5A6650B914454A2CAB16 + B4A8D3F9840D?sv=2014-02-14&sr=b&sig=<value> +ContentSize : 7901 +``` + +This command creates the integration account schema named IntegrationAccountSchema1 in the specified resource group. + +## PARAMETERS + +### -ContentType +Specifies a content type for the integration account schema. +This cmdlet supports application/xml as a map content type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies a metadata object for the schema. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaDefinition +Specifies a definition object for integration account schema. +Specify either this parameter or the *SchemaFilePath* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchemaFilePath +Specifies the file path of a definition for the integration account schema. +Specify either this parameter or the *SchemaDefinition* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchemaName +Specifies a name for the integration account schema. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaType +Specifies the type for the integration account schema. +This parameter supports Xml as the type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Xml + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountSchema + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountSchema](./Get-AzIntegrationAccountSchema.md) + +[Remove-AzIntegrationAccountSchema](./Remove-AzIntegrationAccountSchema.md) + +[Set-AzIntegrationAccountSchema](./Set-AzIntegrationAccountSchema.md) + + diff --git a/azps-10.1.0/Az.LogicApp/New-AzLogicApp.md b/azps-10.1.0/Az.LogicApp/New-AzLogicApp.md new file mode 100644 index 0000000000..90b1a5ee3c --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/New-AzLogicApp.md @@ -0,0 +1,382 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 8679240C-EA47-41C5-B8C1-A3C99547F42B +online version: https://learn.microsoft.com/powershell/module/az.logicapp/new-azlogicapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzLogicApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/New-AzLogicApp.md +--- + +# New-AzLogicApp + +## SYNOPSIS +Creates a logic app in a resource group. + +## SYNTAX + +### LogicAppWithDefinitionParameterSet +``` +New-AzLogicApp -ResourceGroupName <String> -Name <String> -Location <String> [-State <String>] + -Definition <Object> [-IntegrationAccountId <String>] [-Parameters <Object>] [-ParameterFilePath <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### LogicAppWithDefinitionFileParameterSet +``` +New-AzLogicApp -ResourceGroupName <String> -Name <String> -Location <String> [-State <String>] + -DefinitionFilePath <String> [-IntegrationAccountId <String>] [-Parameters <Object>] + [-ParameterFilePath <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzLogicApp** cmdlet creates a logic app by using the Logic Apps feature. +A logic app is a collection of actions or triggers defined in Logic App definition. +This cmdlet returns a **Workflow** object. +You can create a logic app by specifying a name, location, Logic App definition, resource group, and plan. +A Logic App definition and parameters are formatted in JavaScript Object Notation (JSON). +You can use a logic app as a template for definition and parameters. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. +Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. + +## EXAMPLES + +### Example 1: Create a logic app by using definition and parameter file paths +```powershell +New-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp03" -Location "westus" -State "Enabled" -DefinitionFilePath "d:\workflows\Definition03.json" -ParameterFilePath "d:\workflows\Parameters03.json" +``` + +```output +Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp03 +Name : LogicApp03 +Type : Microsoft.Logic/workflows +Location : westus +ChangedTime : 1/13/2016 2:41:39 PM +CreatedTime : 1/13/2016 2:41:39 PM +AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup1/providers/Microsoft.Logic/workflows/LogicApp1 +State : Enabled +DefinitionLinkUri : +DefinitionLinkContentVersion : +Definition : {$schema, contentVersion, parameters, triggers...} +ParametersLinkUri : +ParametersLinkContentVersion : +Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]} +SkuName : Standard +PlanName : ServicePlan01 +PlanType : Microsoft.Web/ServerFarms +PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan1 +Version : 08587489107859952120 +``` + +This command creates a logic app in the specified resource group. +The logic app includes the definition and parameters specified by file paths. + +### Example 2: Create a logic app by using definition and parameter objects +```powershell +New-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp05" -Location "westus" -State "Enabled" -Definition ([IO.File]::ReadAllText("d:\Workflows\Definition.json")) -Parameters @{name1="value1";name2="value2"} +``` + +```output +Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp05 +Name : LogicApp05 +Type : Microsoft.Logic/workflows +Location : westus +ChangedTime : 1/13/2016 2:41:39 PM +CreatedTime : 1/13/2016 2:41:39 PM +AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup11/providers/Microsoft.Logic/workflows/LogicApp05 +State : Enabled +DefinitionLinkUri : +DefinitionLinkContentVersion : +Definition : {$schema, contentVersion, parameters, triggers...} +ParametersLinkUri : +ParametersLinkContentVersion : +Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]} +SkuName : Standard +PlanName : ServicePlan1 +PlanType : Microsoft.Web/ServerFarms +PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan1 +Version : 08587489107859952120 +``` + +This command creates a logic app in the specified resource group resource group. + +### Example 3: Create a logic app by using the pipeline to specify the resource group +```powershell +Get-AzResourceGroup -ResourceGroupName "ResourceGroup11" | New-AzLogicApp -Name "LogicApp11" -Location "westus" -State "Enabled" -DefinitionFilePath "d:\Workflow\Definition.json" -ParameterFilePath "d:\Workflow\Parameters.json" +``` + +```output +Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp11 +Name : LogicApp11 +Type : Microsoft.Logic/workflows +Location : westus +ChangedTime : 1/13/2016 2:41:39 PM +CreatedTime : 1/13/2016 2:41:39 PM +AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup11/providers/Microsoft.Logic/workflows/LogicApp11 +State : Enabled +DefinitionLinkUri : +DefinitionLinkContentVersion : +Definition : {$schema, contentVersion, parameters, triggers...} +ParametersLinkUri : +ParametersLinkContentVersion : +Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]} +SkuName : Standard +PlanName : ServicePlan01 +PlanType : Microsoft.Web/ServerFarms +PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan01 +Version : 08587489107859952120 +``` + +This command gets the resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet. +The command passes that resource group to the current cmdlet by using the pipeline operator. +The current cmdlet creates a logic app in that resource group. +The logic app includes the definition and parameters specified by file paths. + +### Example 4: Create a logic app based on an existing logic app +```powershell +$Workflow = Get-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp03" +New-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp13" -Location "westus" -State "Enabled" -Definition $Workflow.Definition -Parameters $Workflow.Parameters +``` + +```output +Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp13 +Name : LogicApp13 +Type : Microsoft.Logic/workflows +Location : westus +ChangedTime : 1/13/2016 2:41:39 PM +CreatedTime : 1/13/2016 2:41:39 PM +AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup11/providers/Microsoft.Logic/workflows/LogicApp13 +State : Enabled +DefinitionLinkUri : +DefinitionLinkContentVersion : +Definition : {$schema, contentVersion, parameters, triggers...} +ParametersLinkUri : +ParametersLinkContentVersion : +Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]} +SkuName : Standard +PlanName : ServicePlan01 +PlanType : Microsoft.Web/ServerFarms +PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan01 +Version : 08587489107859952120 +``` + +The first command gets the logic app named LogicApp03 by using the Get-AzLogicApp cmdlet. +The command stores the logic app in the $Workflow variable. +The second command creates a new logic app that uses the definition and parameters of the logic app stored in $Workflow. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Definition +Specifies the definition for your logic app as an object or a string in JavaScript Object Notation (JSON) format. + +```yaml +Type: System.Object +Parameter Sets: LogicAppWithDefinitionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFilePath +Specifies the definition of a logic app as the path of a definition file in JSON format. + +```yaml +Type: System.String +Parameter Sets: LogicAppWithDefinitionFileParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntegrationAccountId +Specifies an integration account ID for the logic app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the logic app. +Enter an Azure data center location, such as West US or Southeast Asia. +You can place a logic app in any location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name for the logic app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterFilePath +Specifies the path of a JSON formatted parameter file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameters +Specifies a parameters collection object for the Logic App. +Specify a hash table, Dictionary\<string\>, or Dictionary\<string, WorkflowParameter\>. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the state of the logic app. +The acceptable values for this parameter are: Enabled and Disabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-AzLogicApp](./Get-AzLogicApp.md) + +[Remove-AzLogicApp](./Remove-AzLogicApp.md) + +[Set-AzLogicApp](./Set-AzLogicApp.md) + +[Start-AzLogicApp](./Start-AzLogicApp.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccount.md b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccount.md new file mode 100644 index 0000000000..e6920372d1 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccount.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 607FBE75-727D-4388-9504-94AD31BCDBBF +online version: https://learn.microsoft.com/powershell/module/az.logicapp/remove-azintegrationaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccount.md +--- + +# Remove-AzIntegrationAccount + +## SYNOPSIS +Removes an integration account. + +## SYNTAX + +``` +Remove-AzIntegrationAccount -ResourceGroupName <String> -Name <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzIntegrationAccount** cmdlet removes an integration account from a resource group. +Specify the integration account name and resource group name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Remove an integration account +```powershell +Remove-AzIntegrationAccount -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -Force +``` + +This command removes an integration account named IntegrationAccount31. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[New-AzIntegrationAccount](./New-AzIntegrationAccount.md) + +[Set-AzIntegrationAccount](./Set-AzIntegrationAccount.md) + +[Get-AzIntegrationAccount](./Get-AzIntegrationAccount.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountAgreement.md b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountAgreement.md new file mode 100644 index 0000000000..69579898f7 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountAgreement.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: EBDBB9F0-CA2E-4E4F-9034-3D0FAB88E442 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/remove-azintegrationaccountagreement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountAgreement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountAgreement.md +--- + +# Remove-AzIntegrationAccountAgreement + +## SYNOPSIS +Removes an integration account agreement. + +## SYNTAX + +``` +Remove-AzIntegrationAccountAgreement -ResourceGroupName <String> -Name <String> -AgreementName <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzIntegrationAccountAgreement** cmdlet removes an integration account agreement from an Azure resource group. +Specify the integration account name, resource group name, and agreement name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Remove an integration account agreement by name +```powershell +Remove-AzIntegrationAccountAgreement -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -AgreementName "IntegrationAccountAgreement06" -Force +``` + +This command removes the integration account agreement named IntegrationAccountAgreement06. +The command does not prompt you for confirmation. + +## PARAMETERS + +### -AgreementName +Specifies the name of the integration account agreement. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountAgreement](./Get-AzIntegrationAccountAgreement.md) + +[New-AzIntegrationAccountAgreement](./New-AzIntegrationAccountAgreement.md) + +[Set-AzIntegrationAccountAgreement](./Set-AzIntegrationAccountAgreement.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountAssembly.md b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountAssembly.md new file mode 100644 index 0000000000..e7cad7d361 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountAssembly.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +online version: https://learn.microsoft.com/powershell/module/az.logicapp/remove-azintegrationaccountassembly +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountAssembly.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountAssembly.md +--- + +# Remove-AzIntegrationAccountAssembly + +## SYNOPSIS +Removes an integration account assembly. + +## SYNTAX + +### ByIntegrationAccount (Default) +``` +Remove-AzIntegrationAccountAssembly -ResourceGroupName <String> -ParentName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzIntegrationAccountAssembly -InputObject <PSIntegrationAccountAssembly> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzIntegrationAccountAssembly -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzIntegrationAccountAssembly** cmdlet removes an assembly from an integration account. + +## EXAMPLES + +### Example 1: Remove an assembly by parameters +```powershell +Remove-AzIntegrationAccountAssembly -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -AssemblyName "sampleAssembly" +``` + +Removes the assembly named "sampleAssembly" located in the integration account "sampleIntegrationAccount". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +An integration account assembly. + +```yaml +Type: Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountAssembly +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration account assembly name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccount +Aliases: AssemblyName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentName +The integration account name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccount +Aliases: IntegrationAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the command was successful or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The integration account assembly resource id. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountAssembly + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountBatchConfiguration.md b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountBatchConfiguration.md new file mode 100644 index 0000000000..63c893bf6b --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountBatchConfiguration.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +online version: https://learn.microsoft.com/powershell/module/az.logicapp/remove-azintegrationaccountbatchconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountBatchConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountBatchConfiguration.md +--- + +# Remove-AzIntegrationAccountBatchConfiguration + +## SYNOPSIS +Removes an integration account batch configuration. + +## SYNTAX + +### ByIntegrationAccount (Default) +``` +Remove-AzIntegrationAccountBatchConfiguration -ResourceGroupName <String> -ParentName <String> -Name <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzIntegrationAccountBatchConfiguration -InputObject <PSIntegrationAccountBatchConfiguration> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzIntegrationAccountBatchConfiguration -ResourceId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzIntegrationAccountBatchConfiguration** cmdlet removes a batch configuration from an integration account. + +## EXAMPLES + +### Example 1: Remove a batch configuration by parameters +```powershell +Remove-AzIntegrationAccountBatchConfiguration -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -BatchConfigurationName "sampleBatchConfig" +``` + +Removes the batch configuration named "sampleBatchConfig" located in the integration account "sampleIntegrationAccount". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +An integration account batch configuration. + +```yaml +Type: Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountBatchConfiguration +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration account batch configuration name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccount +Aliases: BatchConfigurationName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentName +The integration account name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccount +Aliases: IntegrationAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the command was successful or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The integration account batch configuration resource id. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountBatchConfiguration + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountCertificate.md b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountCertificate.md new file mode 100644 index 0000000000..838821afb4 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountCertificate.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: F9871519-F470-470C-8CCE-A674B6B5A3EE +online version: https://learn.microsoft.com/powershell/module/az.logicapp/remove-azintegrationaccountcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountCertificate.md +--- + +# Remove-AzIntegrationAccountCertificate + +## SYNOPSIS +Removes an integration account certificate from a resource group. + +## SYNTAX + +``` +Remove-AzIntegrationAccountCertificate -ResourceGroupName <String> -Name <String> -CertificateName <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzIntegrationAccountCertificate** cmdlet removes an integration account certificate from a resource group. +Specify the integration account name, resource group name, and certificate name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Remove an integration account certificate +```powershell +Remove-AzIntegrationAccountCertificate -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -CertificateName "IntegrationAccountCertificate01" +``` + +This command removes the integration account certificate named IntegrationAccount31. + +## PARAMETERS + +### -CertificateName +Specifies the name of an integration account certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountCertificate](./Get-AzIntegrationAccountCertificate.md) + +[New-AzIntegrationAccountCertificate](./New-AzIntegrationAccountCertificate.md) + +[Set-AzIntegrationAccountCertificate](./Set-AzIntegrationAccountCertificate.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountMap.md b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountMap.md new file mode 100644 index 0000000000..802e293763 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountMap.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 7AAF2ACC-84ED-449C-B1E8-F074463F44EB +online version: https://learn.microsoft.com/powershell/module/az.logicapp/remove-azintegrationaccountmap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountMap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountMap.md +--- + +# Remove-AzIntegrationAccountMap + +## SYNOPSIS +Removes an integration account map. + +## SYNTAX + +``` +Remove-AzIntegrationAccountMap -ResourceGroupName <String> -Name <String> -MapName <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzIntegrationAccountMap** cmdlet removes an integration account map from a resource group. +Specify the integration account name, resource group name, and map name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Remove an integration account map +```powershell +Remove-AzIntegrationAccountMap -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -MapName "IntegrationAccountMap47" +``` + +This command removes the integration account map named IntegrationAccountMap47. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MapName +Specifies the name of the integration account map. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountMap](./Get-AzIntegrationAccountMap.md) + +[New-AzIntegrationAccountMap](./New-AzIntegrationAccountMap.md) + +[Set-AzIntegrationAccountMap](./Set-AzIntegrationAccountMap.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountPartner.md b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountPartner.md new file mode 100644 index 0000000000..1abe70910b --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountPartner.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: E8A557EA-FE3F-4433-BFDE-B4D73DF8467C +online version: https://learn.microsoft.com/powershell/module/az.logicapp/remove-azintegrationaccountpartner +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountPartner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountPartner.md +--- + +# Remove-AzIntegrationAccountPartner + +## SYNOPSIS +Removes an integration account partner. + +## SYNTAX + +``` +Remove-AzIntegrationAccountPartner -ResourceGroupName <String> -Name <String> -PartnerName <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzIntegrationAccountPartner** cmdlet removes an integration account partner from a resource group. +Specify the integration account name, resource group name, and partner name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Remove an integration account partner +```powershell +Remove-AzIntegrationAccountPartner -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -PartnerName "IntegrationAccountPartner1" +``` + +This command removes the integration account partner named IntegrationAccountPartner1. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerName +Specifies the name of the integration account partner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountPartner](./Get-AzIntegrationAccountPartner.md) + +[New-AzIntegrationAccountPartner](./New-AzIntegrationAccountPartner.md) + +[Set-AzIntegrationAccountPartner](./Set-AzIntegrationAccountPartner.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountReceivedIcn.md b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountReceivedIcn.md new file mode 100644 index 0000000000..85ef2b4933 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountReceivedIcn.md @@ -0,0 +1,226 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +online version: https://learn.microsoft.com/powershell/module/az.logicapp/remove-azintegrationaccountreceivedicn +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountReceivedIcn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountReceivedIcn.md +--- + +# Remove-AzIntegrationAccountReceivedIcn + +## SYNOPSIS +This cmdlet removes a specific received interchange control number per agreement and control number value. + +## SYNTAX + +``` +Remove-AzIntegrationAccountReceivedIcn -ResourceGroupName <String> -Name <String> -AgreementName <String> + -ControlNumberValue <String> [-AgreementType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet is meant to be used in disaster recovery scenarios to remove a received interchange control number from the integration account so that the B2B connector may process again the message when duplicate number detection is enabled. +In rare occasions the received interchange control number may be reserved shortly before a disaster and before the B2B connector rejects the interchange as erroneous. +In such occasions the operation may want to enable the recovery site to process again the same interchange after its payload is corrected. +Please do provide the "-AgreementType" parameter to specify whether X12 or Edifact control numbers to return + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> +```powershell +Get-AzIntegrationAccountReceivedIcn -AgreementType "X12" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "X12AgreementName" -ControlNumberValue "000000641" + +Get-AzIntegrationAccountReceivedIcn : The existing received control number '000000641' for agreement 'X12AgreementName' is not in a valid format. +At line:1 char:1 ++ Get-AzIntegrationAccountReceivedIcn -ResourceGroupName "groupName ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : CloseError: (:) [Get-AzIntegrationAccountReceivedIcn], PSInvalidOperationException + + FullyQualifiedErrorId : Microsoft.Azure.Commands.LogicApp.Cmdlets.GetAzureIntegrationAccountReceivedIcnCommand + +Remove-AzIntegrationAccountReceivedIcn -AgreementType "X12" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "X12AgreementName" -ControlNumberValue "000000641" +Get-AzIntegrationAccountReceivedIcn -AgreementType "X12" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "X12AgreementName" -ControlNumberValue "000000641" + +Get-AzIntegrationAccountReceivedIcn : The session 'X12-ICN-X12AgreementName-000000641' could not be found in integration account 'accountName'. +At line:1 char:1 ++ Get-AzIntegrationAccountReceivedIcn -ResourceGroupName "groupName ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : CloseError: (:) [Get-AzIntegrationAccountReceivedIcn], CloudException + + FullyQualifiedErrorId : Microsoft.Azure.Commands.LogicApp.Cmdlets.GetAzureIntegrationAccountReceivedIcnCommand +``` + +Attempts to get a received X12 interchange control number which content is not in a valid format. +Removes the received X12 interchange control number. +Confirms the received X12 interchange control number was removed by attempting to get it again. + +### Example 2 +<!-- Skip: Output cannot be splitted from code --> +```powershell +Get-AzIntegrationAccountReceivedIcn -AgreementType "Edifact" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "EdifactAgreementName" -ControlNumberValue "000000641" + +Get-AzIntegrationAccountReceivedIcn : The existing received control number '000000641' for agreement 'EdifactAgreementName' is not in a valid format. +At line:1 char:1 ++ Get-AzIntegrationAccountReceivedIcn -ResourceGroupName "groupName ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : CloseError: (:) [Get-AzIntegrationAccountReceivedIcn], PSInvalidOperationException + + FullyQualifiedErrorId : Microsoft.Azure.Commands.LogicApp.Cmdlets.GetAzureIntegrationAccountReceivedIcnCommand + +Remove-AzIntegrationAccountReceivedIcn -AgreementType "Edifact" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "EdifactAgreementName" -ControlNumberValue "000000641" +Get-AzIntegrationAccountReceivedIcn -AgreementType "Edifact" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "EdifactAgreementName" -ControlNumberValue "000000641" + +Get-AzIntegrationAccountReceivedIcn : The session 'Edifact-ICN-EdifactAgreementName-000000641' could not be found in integration account 'accountName'. +At line:1 char:1 ++ Get-AzIntegrationAccountReceivedIcn -ResourceGroupName "groupName ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : CloseError: (:) [Get-AzIntegrationAccountReceivedIcn], CloudException + + FullyQualifiedErrorId : Microsoft.Azure.Commands.LogicApp.Cmdlets.GetAzureIntegrationAccountReceivedIcnCommand +``` + +Attempts to get a received Edifact interchange control number which content is not in a valid format. +Removes the received Edifact interchange control number. +Confirms the received Edifact interchange control number was removed by attempting to get it again. + +## PARAMETERS + +### -AgreementName +The integration account agreement name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgreementType +The integration account agreement type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MessageType +Accepted values: X12, Edifact + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlNumberValue +The integration account control number value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The integration account resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountReceivedIcn](./Get-AzIntegrationAccountReceivedIcn.md) +[Set-AzIntegrationAccountReceivedIcn](./Set-AzIntegrationAccountReceivedIcn.md) + diff --git a/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountSchema.md b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountSchema.md new file mode 100644 index 0000000000..0c482b721e --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Remove-AzIntegrationAccountSchema.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 56550997-21D9-4F85-B23A-677625482547 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/remove-azintegrationaccountschema +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountSchema.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzIntegrationAccountSchema.md +--- + +# Remove-AzIntegrationAccountSchema + +## SYNOPSIS +Removes an integration account schema. + +## SYNTAX + +``` +Remove-AzIntegrationAccountSchema -ResourceGroupName <String> -Name <String> -SchemaName <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzIntegrationAccountSchema** cmdlet removes an integration account schema from a resource group. +Specifying the integration account name, resource group name, and schema name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Remove an integration account schema +```powershell +Remove-AzIntegrationAccountSchema -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -SchemaName "IntegrationAccountSchema43" +``` + +This command removes an integration account schema named IntegrationAccountSchema43. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Specifies the name of an integration account schema. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountSchema](./Get-AzIntegrationAccountSchema.md) + +[New-AzIntegrationAccountSchema](./New-AzIntegrationAccountSchema.md) + +[Set-AzIntegrationAccountSchema](./Set-AzIntegrationAccountSchema.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Remove-AzLogicApp.md b/azps-10.1.0/Az.LogicApp/Remove-AzLogicApp.md new file mode 100644 index 0000000000..143a2a4689 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Remove-AzLogicApp.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 39D1576D-7042-4A62-AB41-0B5131C150D5 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/remove-azlogicapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzLogicApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Remove-AzLogicApp.md +--- + +# Remove-AzLogicApp + +## SYNOPSIS +Removes a logic app from a resource group. + +## SYNTAX + +``` +Remove-AzLogicApp -ResourceGroupName <String> -Name <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzLogicApp** cmdlet removes a logic app from a resource group by using the Logic Apps feature. +Specify the logic app and resource group. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Remove a logic app +```powershell +Remove-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp03" -Force +``` + +This command removes a logic app from a resource group. +The command includes the *Force* parameter, which prevents the command from prompting you for confirmation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the logic app that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the logic app that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzLogicApp](./Get-AzLogicApp.md) + +[New-AzLogicApp](./New-AzLogicApp.md) + +[Set-AzLogicApp](./Set-AzLogicApp.md) + +[Start-AzLogicApp](./Start-AzLogicApp.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccount.md b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccount.md new file mode 100644 index 0000000000..f8722c8ad4 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccount.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: F6D9EA59-BA61-4117-8771-9B190424BFF8 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/set-azintegrationaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccount.md +--- + +# Set-AzIntegrationAccount + +## SYNOPSIS +Modifies an integration account. + +## SYNTAX + +``` +Set-AzIntegrationAccount -ResourceGroupName <String> -Name <String> [-Location <String>] [-Sku <String>] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzIntegrationAccount** cmdlet modifies an integration account. +This cmdlet returns an object that represents the integration account. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Modify an integration account +```powershell +Set-AzIntegrationAccount -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -Sku "Free" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31 +Name : IntegrationAccount31 +Type : Microsoft.Logic/integrationAccounts +Location : brazilsouth +Sku : +CreatedTime : 3/26/2016 4:26:07 PM +ChangedTime : 3/26/2016 4:26:07 PM +``` + +This command modifies an integration account named IntegrationAccount31 in the specified resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies a location for the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Specifies a SKU name for the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Free, Basic, Standard + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccount + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccount](./Get-AzIntegrationAccount.md) + +[New-AzIntegrationAccount](./New-AzIntegrationAccount.md) + +[Remove-AzIntegrationAccount](./Remove-AzIntegrationAccount.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountAgreement.md b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountAgreement.md new file mode 100644 index 0000000000..269471d3ea --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountAgreement.md @@ -0,0 +1,357 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 5FDD6C6A-9F6A-44C3-B332-B528F648DFDB +online version: https://learn.microsoft.com/powershell/module/az.logicapp/set-azintegrationaccountagreement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountAgreement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountAgreement.md +--- + +# Set-AzIntegrationAccountAgreement + +## SYNOPSIS +Modifies an integration account agreement. + +## SYNTAX + +``` +Set-AzIntegrationAccountAgreement -ResourceGroupName <String> -Name <String> -AgreementName <String> + [-AgreementType <String>] [-GuestPartner <String>] [-HostPartner <String>] [-GuestIdentityQualifier <String>] + [-GuestIdentityQualifierValue <String>] [-HostIdentityQualifier <String>] + [-HostIdentityQualifierValue <String>] [-AgreementContent <String>] [-AgreementContentFilePath <String>] + [-Metadata <Object>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzIntegrationAccountAgreement** cmdlet modifies an integration account agreement. +This cmdlet returns an object that represents the integration account agreement. +Specify the integration account name, resource group name, and agreement name. +Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Update an integration account agreement +```powershell +Set-AzIntegrationAccountAgreement -Name "IntegrationAccount31"-ResourceGroupName "ResourceGroup11" -AgreementName "IntegrationAccountAgreement06" -AgreementType "X12" -GuestPartner "GuestPartner" -HostPartner "HostPartner" -GuestIdentityQualifier "BB" -HostIdentityQualifier "AA" -AgreementContentFilePath "C:\temp\AgreementContent.json" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/agreements/IntegrationAccountAgreement06 +Name : IntegrationAccountAgreement06 +Type : Microsoft.Logic/integrationAccounts/agreements +CreatedTime : 3/26/2016 6:43:52 PM +ChangedTime : 3/26/2016 6:43:52 PM +AgreementType : X12 +HostPartner : HostPartner +GuestPartner : GuestPartner +HostIdentityQualifier : AA +HostIdentityValue : AA +GuestIdentityQualifier : BB +GuestIdentityValue : BB +Content : {"AS2":null,"X12":{"ReceiveAgreement":{"SenderBusinessIdentity":{"Qualifier":"AA","Value":"AA"},"ReceiverBusinessIdentity":{"Qualifier":"ZZ","Valu + e":"ZZ"},"ProtocolSettings":{"ValidationSettings":{"ValidateCharacterSet":true,"CheckDuplicateInterchangeControlNumber":false,"InterchangeControlN + . . . +``` + +This command updates an integration account agreement in the specified Azure resource group. + +### Example 2 + +Modifies an integration account agreement. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Set-AzIntegrationAccountAgreement -AgreementContentFilePath 'C:\temp\AgreementContent.json' -AgreementName 'IntegrationAccountAgreement06' -GuestIdentityQualifier 'BB' -GuestIdentityQualifierValue <String> -GuestPartner 'GuestPartner' -HostIdentityQualifier 'AA' -HostIdentityQualifierValue <String> -HostPartner 'HostPartner' -Metadata <Object> -Name 'IntegrationAccount31' -ResourceGroupName 'ResourceGroup11' +``` + +## PARAMETERS + +### -AgreementContent +Specifies agreement content, in JavaScript Object Notation (JSON) format, for the agreement. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgreementContentFilePath +Specifies the file path of agreement content for the agreement. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgreementName +Specifies the name of the integration account agreement. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AgreementType +Specifies the integration account agreement type. +The acceptable values for this parameter are: +- X12 +- AS2 +- Edifact + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: X12, AS2, Edifact + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestIdentityQualifier +Specifies a name business identity qualifier for the guest partner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestIdentityQualifierValue +The integration account agreement guest identity qualifier value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestPartner +Specifies the name of the guest partner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostIdentityQualifier +Specifies a name business identity qualifier for the host partner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostIdentityQualifierValue +The integration account agreement host identity qualifier value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPartner +Specifies the name of the host partner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies a metadata object for the agreement. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountAgreement + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountAgreement](./Get-AzIntegrationAccountAgreement.md) + +[New-AzIntegrationAccountAgreement](./New-AzIntegrationAccountAgreement.md) + +[Remove-AzIntegrationAccountAgreement](./Remove-AzIntegrationAccountAgreement.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountAssembly.md b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountAssembly.md new file mode 100644 index 0000000000..227adff567 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountAssembly.md @@ -0,0 +1,324 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +online version: https://learn.microsoft.com/powershell/module/az.logicapp/set-azintegrationaccountassembly +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountAssembly.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountAssembly.md +--- + +# Set-AzIntegrationAccountAssembly + +## SYNOPSIS +Modifies an integration account assembly. + +## SYNTAX + +### ByIntegrationAccountAndFilePath (Default) +``` +Set-AzIntegrationAccountAssembly -ResourceGroupName <String> -ParentName <String> -Name <String> + -AssemblyFilePath <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationAccountAndContentLink +``` +Set-AzIntegrationAccountAssembly -ResourceGroupName <String> -ParentName <String> -Name <String> + -ContentLink <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByIntegrationAccountAndFileBytes +``` +Set-AzIntegrationAccountAssembly -ResourceGroupName <String> -ParentName <String> -Name <String> + -AssemblyData <Byte[]> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObjectAndContentLink +``` +Set-AzIntegrationAccountAssembly -InputObject <PSIntegrationAccountAssembly> -ContentLink <String> + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectAndFileBytes +``` +Set-AzIntegrationAccountAssembly -InputObject <PSIntegrationAccountAssembly> -AssemblyData <Byte[]> + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectAndFilePath +``` +Set-AzIntegrationAccountAssembly -InputObject <PSIntegrationAccountAssembly> -AssemblyFilePath <String> + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdAndContentLink +``` +Set-AzIntegrationAccountAssembly -ResourceId <String> -ContentLink <String> [-Metadata <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdAndFileBytes +``` +Set-AzIntegrationAccountAssembly -ResourceId <String> -AssemblyData <Byte[]> [-Metadata <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdAndFilePath +``` +Set-AzIntegrationAccountAssembly -ResourceId <String> -AssemblyFilePath <String> [-Metadata <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzIntegrationAccountAssembly** cmdlet modifies an integration account assembly. + +## EXAMPLES + +### Example 1: Modify an assembly using local file +```powershell +Set-AzIntegrationAccountAssembly -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -AssemblyName "sampleAssembly" -AssemblyFilePath $localAssemblyFilePath +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.AssemblyProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/assemblies/sampleAssembly +Name : sampleAssembly +Type : Microsoft.Logic/integrationAccounts/assemblies +Location : +Tags : +``` + +Modifies the assembly named "sampleAssembly" using the local file located at the file path contained in "$localAssemblyFilePath". + +### Example 2: Modify an assembly using byte data +```powershell +Set-AzIntegrationAccountAssembly -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -AssemblyName "sampleAssembly" -AssemblyData $assemblyContent +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.AssemblyProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/assemblies/sampleAssembly +Name : sampleAssembly +Type : Microsoft.Logic/integrationAccounts/assemblies +Location : +Tags : +``` + +Modifies the assembly named "sampleAssembly" using the a byte array contained in "$assemblyContent". + +### Example 3: Modify an assembly using a content link +```powershell +Set-AzIntegrationAccountAssembly -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -AssemblyName "sampleAssembly" -ContentLink $assemblyUrl +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.AssemblyProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/assemblies/sampleAssembly +Name : sampleAssembly +Type : Microsoft.Logic/integrationAccounts/assemblies +Location : +Tags : +``` + +Modifies the assembly named "sampleAssembly" using the a byte data located at the URL "$assemblyUrl". This is the suggested method for creating large sized assemblies. + +## PARAMETERS + +### -AssemblyData +The integration account assembly byte data. + +```yaml +Type: System.Byte[] +Parameter Sets: ByIntegrationAccountAndFileBytes, ByInputObjectAndFileBytes, ByResourceIdAndFileBytes +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssemblyFilePath +The integration account assembly file path. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndFilePath, ByInputObjectAndFilePath, ByResourceIdAndFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentLink +A publicly accessible link to the integration account assembly data. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndContentLink, ByInputObjectAndContentLink, ByResourceIdAndContentLink +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +An integration account assembly. + +```yaml +Type: Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountAssembly +Parameter Sets: ByInputObjectAndContentLink, ByInputObjectAndFileBytes, ByInputObjectAndFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Metadata +The integration account assembly metadata. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration account assembly name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndFilePath, ByIntegrationAccountAndContentLink, ByIntegrationAccountAndFileBytes +Aliases: AssemblyName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentName +The integration account name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndFilePath, ByIntegrationAccountAndContentLink, ByIntegrationAccountAndFileBytes +Aliases: IntegrationAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndFilePath, ByIntegrationAccountAndContentLink, ByIntegrationAccountAndFileBytes +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The integration account assembly resource id. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdAndContentLink, ByResourceIdAndFileBytes, ByResourceIdAndFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountAssembly + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountAssembly + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountBatchConfiguration.md b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountBatchConfiguration.md new file mode 100644 index 0000000000..d44ae59aaa --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountBatchConfiguration.md @@ -0,0 +1,422 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +online version: https://learn.microsoft.com/powershell/module/az.logicapp/set-azintegrationaccountbatchconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountBatchConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountBatchConfiguration.md +--- + +# Set-AzIntegrationAccountBatchConfiguration + +## SYNOPSIS +Modifies an integration account batch configuration. + +## SYNTAX + +### ByIntegrationAccountAndParameters (Default) +``` +Set-AzIntegrationAccountBatchConfiguration -ResourceGroupName <String> -ParentName <String> -Name <String> + [-BatchGroupName <String>] [-MessageCount <Int32>] [-BatchSize <Int32>] [-ScheduleInterval <Int32>] + [-ScheduleFrequency <String>] [-ScheduleTimeZone <String>] [-ScheduleStartTime <DateTime>] + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationAccountAndJson +``` +Set-AzIntegrationAccountBatchConfiguration -ResourceGroupName <String> -ParentName <String> -Name <String> + -BatchConfigurationDefinition <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByIntegrationAccountAndFilePath +``` +Set-AzIntegrationAccountBatchConfiguration -ResourceGroupName <String> -ParentName <String> -Name <String> + -BatchConfigurationFilePath <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectAndJson +``` +Set-AzIntegrationAccountBatchConfiguration -InputObject <PSIntegrationAccountBatchConfiguration> + -BatchConfigurationDefinition <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectAndFilePath +``` +Set-AzIntegrationAccountBatchConfiguration -InputObject <PSIntegrationAccountBatchConfiguration> + -BatchConfigurationFilePath <String> [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectAndParameters +``` +Set-AzIntegrationAccountBatchConfiguration -InputObject <PSIntegrationAccountBatchConfiguration> + [-BatchGroupName <String>] [-MessageCount <Int32>] [-BatchSize <Int32>] [-ScheduleInterval <Int32>] + [-ScheduleFrequency <String>] [-ScheduleTimeZone <String>] [-ScheduleStartTime <DateTime>] + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdAndJson +``` +Set-AzIntegrationAccountBatchConfiguration -ResourceId <String> -BatchConfigurationDefinition <String> + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdAndFilePath +``` +Set-AzIntegrationAccountBatchConfiguration -ResourceId <String> -BatchConfigurationFilePath <String> + [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdAndParameters +``` +Set-AzIntegrationAccountBatchConfiguration -ResourceId <String> [-BatchGroupName <String>] + [-MessageCount <Int32>] [-BatchSize <Int32>] [-ScheduleInterval <Int32>] [-ScheduleFrequency <String>] + [-ScheduleTimeZone <String>] [-ScheduleStartTime <DateTime>] [-Metadata <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzIntegrationAccountBatchConfiguration** cmdlet modifies an integration account batch configuration. + +## EXAMPLES + +### Example 1: Modify a batch configuration using local file +```powershell +Set-AzIntegrationAccountBatchConfiguration -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -BatchConfigurationName "sampleBatchConfig" -BatchConfigurationFilePath $batchConfigurationFilePath +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.BatchConfigurationProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/batchConfigurations/sampleBatchConfig +Name : sampleBatchConfig +Type : Microsoft.Logic/integrationAccounts/batchConfigurations +Location : +Tags : +``` + +Modify a batch configuration named "sampleBatchConfig" using the local file located at the file path contained in "$batchConfigurationFilePath". + +### Example 2: Modify a batch configuration using a JSON string +```powershell +Set-AzIntegrationAccountBatchConfiguration -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -BatchConfigurationName "sampleBatchConfig" -BatchConfigurationDefinition $batchConfigurationContent +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.BatchConfigurationProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/batchConfigurations/sampleBatchConfig +Name : sampleBatchConfig +Type : Microsoft.Logic/integrationAccounts/batchConfigurations +Location : +Tags : +``` + +Modify a batch configuration named "sampleBatchConfig" using the a JSON string contained in "$batchConfigurationContent". + +### Example 3: Modify a batch configuration using parameters +```powershell +Set-AzIntegrationAccountBatchConfiguration -ResourceGroupName "sampleResourceGroup" -IntegrationAccountName "sampleIntegrationAccount" -BatchConfigurationName "sampleBatchConfig" -MessageCount 199 -BatchSize 5 -ScheduleInterval 1 -ScheduleFrequency "Month" +``` + +```output +Properties : Microsoft.Azure.Management.Logic.Models.BatchConfigurationProperties +Id : /subscriptions/{SubscriptionId}/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/integrationAccounts/sampleIntegrationAccount/batchConfigurations/sampleBatchConfig +Name : sampleBatchConfig +Type : Microsoft.Logic/integrationAccounts/batchConfigurations +Location : +Tags : +``` + +Modify a batch configuration named "sampleBatchConfig" by manually providing all of the necessary parameters. + +## PARAMETERS + +### -BatchConfigurationDefinition +The integration account batch configuration definition. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndJson, ByInputObjectAndJson, ByResourceIdAndJson +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchConfigurationFilePath +The integration account batch configuration file path. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndFilePath, ByInputObjectAndFilePath, ByResourceIdAndFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchGroupName +The integration account batch configuration group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +The integration account batch configuration batch size. + +```yaml +Type: System.Int32 +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +An integration account batch configuration. + +```yaml +Type: Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountBatchConfiguration +Parameter Sets: ByInputObjectAndJson, ByInputObjectAndFilePath, ByInputObjectAndParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MessageCount +The integration account batch configuration message count. + +```yaml +Type: System.Int32 +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +The integration account batch configuration metadata. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration account batch configuration name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndParameters, ByIntegrationAccountAndJson, ByIntegrationAccountAndFilePath +Aliases: BatchConfigurationName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentName +The integration account name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndParameters, ByIntegrationAccountAndJson, ByIntegrationAccountAndFilePath +Aliases: IntegrationAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndParameters, ByIntegrationAccountAndJson, ByIntegrationAccountAndFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The integration account batch configuration resource id. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdAndJson, ByResourceIdAndFilePath, ByResourceIdAndParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScheduleFrequency +The integration account batch configuration schedule frequency. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: +Accepted values: Month, Week, Day, Hour, Minute, Second + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInterval +The integration account batch configuration schedule interval. + +```yaml +Type: System.Int32 +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleStartTime +The integration account batch configuration schedule start time. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleTimeZone +The integration account batch configuration schedule time zone. + +```yaml +Type: System.String +Parameter Sets: ByIntegrationAccountAndParameters, ByInputObjectAndParameters, ByResourceIdAndParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountBatchConfiguration + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.LogicApp.Models.PSIntegrationAccountBatchConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountCertificate.md b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountCertificate.md new file mode 100644 index 0000000000..53fbdf4394 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountCertificate.md @@ -0,0 +1,262 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: D9CA9515-5C19-4D63-8D4D-0B288E9309E9 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/set-azintegrationaccountcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountCertificate.md +--- + +# Set-AzIntegrationAccountCertificate + +## SYNOPSIS +Modifies an integration account certificate. + +## SYNTAX + +``` +Set-AzIntegrationAccountCertificate -ResourceGroupName <String> -Name <String> -CertificateName <String> + [-KeyName <String>] [-KeyVersion <String>] [-KeyVaultId <String>] [-PublicCertificateFilePath <String>] + [-Metadata <Object>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzIntegrationAccountCertificate** cmdlet modifies an integration account certificate. +This cmdlet returns an object that represents the integration account certificate. +Specifying the integration account name, resource group name, and certificate name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Modify an integration account certificate +```powershell +Set-AzIntegrationAccountCertificate -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -CertificateName "IntegrationAccountCertificate01" -KeyName "TestKey" -KeyVersion "1.0" -KeyVaultId "/subscriptions/<subscriptionId>/resourcegroups/ResourceGroup11/providers/microsoft.keyvault/vaults/keyvault" -PublicCertificateFilePath "c:\temp\Certificate.cer" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/certificates/IntegrationAccountCertificate01 +Name : IntegrationAccountCertificate01 +Type : Microsoft.Logic/integrationAccounts/certificates +CreatedTime : 3/26/2016 6:59:07 PM +ChangedTime : 3/26/2016 6:59:07 PM +KeyName : TestKey +KeyVersion : 1.0 +KeyVaultId : /subscriptions/<SubscriptionId/resourcegroups/ResourceGroup11/providers/microsoft.keyvault/vaults/testkeyvault +KeyVaultName : testkeyvault +KeyVaultName : testkeyvault +PublicCertificate : +MetaData : +``` + +This command modifies the integration account certificate in the specified resource group. + +## PARAMETERS + +### -CertificateName +Specifies the name of an integration account certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +Specifies the name of a certificate key in the key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyVaultId +Specifies a key vault ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyVersion +Specifies the version of the certificate key in the key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Metadata +Specifies a metadata object for the certificate. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicCertificateFilePath +Specifies the path of a public certificate (.cer) file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountCertificate + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountCertificate](./Get-AzIntegrationAccountCertificate.md) + +[New-AzIntegrationAccountCertificate](./New-AzIntegrationAccountCertificate.md) + +[Remove-AzIntegrationAccountCertificate](./Remove-AzIntegrationAccountCertificate.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountGeneratedIcn.md b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountGeneratedIcn.md new file mode 100644 index 0000000000..7b373f5c18 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountGeneratedIcn.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +online version: https://learn.microsoft.com/powershell/module/az.logicapp/set-azintegrationaccountgeneratedicn +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountGeneratedIcn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountGeneratedIcn.md +--- + +# Set-AzIntegrationAccountGeneratedIcn + +## SYNOPSIS +Updates the integration account generated interchange control number (ICN) in the Azure resource group. + +## SYNTAX + +``` +Set-AzIntegrationAccountGeneratedIcn -ResourceGroupName <String> -Name <String> -AgreementName <String> + -ControlNumber <String> [-AgreementType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzIntegrationAccountGeneratedIcn cmdlet updates an existing integration account generated interchange control number (ICN) and returns an object that represents the integration account generated interchange control number. +Use this cmdlet to update an integration account generated interchange control number. +You can update an integration account generated interchange control number by specifying the integration account name, resource group name and agreement name. +You cannot create a new integration account generated interchange control number with this command. +To use the dynamic parameters, just type them in the command, or type a hyphen sign(-) to indicate a parameter name and then press the TAB key repeatedly to cycle through the available parameters. +If you miss a required template parameter, the cmdlet prompts you for the value. +Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. +Please do provide the "-AgreementType" parameter to specify whether X12 or Edifact control numbers to return + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroup.ResourceGroupName = "ResourceGroup1" +$integrationAccountName = "IntegrationAccount1" +$integrationAccountAgreementName = "X12IntegrationAccountAgreement" +$initialControlNumber = Get-AzIntegrationAccountGeneratedIcn -AgreementType X12 -ResourceGroupName $resourceGroup.ResourceGroupName -Name $integrationAccountName -AgreementName $integrationAccountAgreementName +$incrementedControlNumberValue = [convert]::ToString([convert]::ToInt32($initialControlNumber.ControlNumber, 10) + 100, 10) +Set-AzIntegrationAccountGeneratedIcn -ResourceGroupName $resourceGroup.ResourceGroupName -Name $integrationAccountName -AgreementName $integrationAccountAgreementName -ControlNumber $incrementedControlNumberValue +``` + +```output +ControlNumber : 1100 +ControlNumberChangedTime : 2/15/2017 12:36:00 AM +IsMessageProcessingFailed: +``` + +This command gets the integration account generated X12 interchange control number for a specific integration account agreement, increase its value by 100 then writes back the updated value. + +### Example 2 +```powershell +$resourceGroup.ResourceGroupName = "ResourceGroup1" +$integrationAccountName = "IntegrationAccount1" +$integrationAccountAgreementName = "EdifactIntegrationAccountAgreement" +$initialControlNumber = Get-AzIntegrationAccountGeneratedIcn -AgreementType EdifactIntegrationAccountAgreement -ResourceGroupName $resourceGroup.ResourceGroupName -Name $integrationAccountName -AgreementName $integrationAccountAgreementName +$incrementedControlNumberValue = [convert]::ToString([convert]::ToInt32($initialControlNumber.ControlNumber, 10) + 100, 10) +Set-AzIntegrationAccountGeneratedIcn -ResourceGroupName $resourceGroup.ResourceGroupName -Name $integrationAccountName -AgreementName $integrationAccountAgreementName -ControlNumber $incrementedControlNumberValue +``` + +```output +ControlNumber : 1100 +ControlNumberChangedTime : 2/15/2017 12:36:00 AM +IsMessageProcessingFailed: +``` + +This command gets the integration account generated EdifactIntegrationAccountAgreement interchange control number for a specific integration account agreement, increase its value by 100 then writes back the updated value. + +## PARAMETERS + +### -AgreementName +The integration account agreement name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgreementType +The integration account agreement type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MessageType +Accepted values: X12, Edifact + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlNumber +The generated control number new value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The integration account resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.LogicApp.Utilities.IntegrationAccountControlNumber + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountGeneratedIcn](./Get-AzIntegrationAccountGeneratedIcn.md) + diff --git a/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountMap.md b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountMap.md new file mode 100644 index 0000000000..ba82bc1ad2 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountMap.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 7EF87BE5-FB10-4E5D-A12F-7F50EE6DAD57 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/set-azintegrationaccountmap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountMap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountMap.md +--- + +# Set-AzIntegrationAccountMap + +## SYNOPSIS +Modifies an integration account map. + +## SYNTAX + +``` +Set-AzIntegrationAccountMap -ResourceGroupName <String> -Name <String> -MapName <String> + [-MapFilePath <String>] [-MapDefinition <String>] [-MapType <String>] [-ContentType <String>] + [-Metadata <Object>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzIntegrationAccountMap** cmdlet modifies an integration account map. +This cmdlet returns an object that represents the integration account map. +Specify the integration account name, resource group name, and map name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Modify an integration account map +```powershell +Set-AzIntegrationAccountMap -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -MapName "IntegrationAccountMap47" -MapDefinition $MapContent +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/maps/IntegrationAccountMap47 +Name : IntegrationAccountMap47 +Type : Microsoft.Logic/integrationAccounts/maps +CreatedTime : 3/26/2016 7:12:22 PM +ChangedTime : 3/26/2016 7:12:22 PM +MapType : Xslt +ContentLink : https://<baseurl>/integrationaccounts68a13b6b49f14995ba7c5f3aedcbd7ad/99D1E_XSLT_INTEGRATIONACCOUNTMAP47-9C97D973088B4256A1893B + BCB1F85246?sv=2014-02-14&sr=b&sig=<value> +ContentSize : 3056 +Metadata : +``` + +This command modifies the integration account map in the specified resource group. +The command specifies a map definition stored in the $MapContent variable by a previous command. + +### Example 2 + +Modifies an integration account map. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Set-AzIntegrationAccountMap -MapFilePath <String> -MapName 'IntegrationAccountMap47' -MapType Xslt -Name 'IntegrationAccount31' -ResourceGroupName 'ResourceGroup11' +``` + +## PARAMETERS + +### -ContentType +Specifies a content type for the integration account map. +This cmdlet supports application/xml as a map content type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MapDefinition +Specifies a definition object for integration account map. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MapFilePath +Specifies the file path of a definition for the integration account map. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MapName +Specifies the name of an integration account map. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MapType +Specifies the type for the integration account map. +This cmdlet supports Xslt as a map type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Xslt, Xslt20, Xslt30, Liquid + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies a metadata object for the map. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountMap + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountMap](./Get-AzIntegrationAccountMap.md) + +[New-AzIntegrationAccountMap](./New-AzIntegrationAccountMap.md) + +[Remove-AzIntegrationAccountMap](./Remove-AzIntegrationAccountMap.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountPartner.md b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountPartner.md new file mode 100644 index 0000000000..88b4f98a37 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountPartner.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 9B3B6AD4-C37C-4877-9864-9FB2E3B0BDAB +online version: https://learn.microsoft.com/powershell/module/az.logicapp/set-azintegrationaccountpartner +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountPartner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountPartner.md +--- + +# Set-AzIntegrationAccountPartner + +## SYNOPSIS +Modifies an integration account partner. + +## SYNTAX + +``` +Set-AzIntegrationAccountPartner -ResourceGroupName <String> -Name <String> -PartnerName <String> + [-PartnerType <String>] [-BusinessIdentities <Object>] [-Metadata <Object>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzIntegrationAccountPartner** cmdlet modifies an integration account partner. +This cmdlet returns an object that represents the integration account partner. +Specify the integration account name, resource group name, and partner name. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Modify an integration account partner +```powershell +$BusinessIdentities = @("ZZ","AA"),@("XX","GG") +Set-AzIntegrationAccountPartner -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -PartnerName "IntegrationAccountPartner22" -PartnerType "B2B" -BusinessIdentities $BusinessIdentities +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/partners/IntegrationAccountPartner22 +Name : IntegrationAccountPartner22 +Type : Microsoft.Logic/integrationAccounts/partners +PartnerType : B2B +CreatedTime : 3/26/2016 7:29:30 PM +ChangedTime : 3/26/2016 7:29:30 PM +BusinessIdentities : [{"Qualifier":"ZZ","Value":"AA"},{"Qualifier":"XX","Value":"GG"}] +Metadata +``` + +This command modify the integration account partner named IntegrationAccountPartner22 in the specified resource group. + +### Example 2 + +Modifies an integration account partner. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Set-AzIntegrationAccountPartner -BusinessIdentities <Object> -Metadata <Object> -Name 'IntegrationAccount31' -PartnerName 'IntegrationAccountPartner22' -PartnerType B2B -ResourceGroupName 'ResourceGroup11' +``` + +## PARAMETERS + +### -BusinessIdentities +Specifies business identities for the integration account partner. It is a nested array, with inner arrays containing the Qualifier as the first object/string and the Value as the second object/string. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies a metadata object for the partner. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerName +Specifies the name of the integration account partner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerType +Specifies the type of the integration account. +This parameter supports the type B2B. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: B2B + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountPartner + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountPartner](./Get-AzIntegrationAccountPartner.md) + +[New-AzIntegrationAccountPartner](./New-AzIntegrationAccountPartner.md) + +[Remove-AzIntegrationAccountPartner](./Remove-AzIntegrationAccountPartner.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountReceivedIcn.md b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountReceivedIcn.md new file mode 100644 index 0000000000..094b31e4af --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountReceivedIcn.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +online version: https://learn.microsoft.com/powershell/module/az.logicapp/set-azintegrationaccountreceivedicn +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountReceivedIcn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountReceivedIcn.md +--- + +# Set-AzIntegrationAccountReceivedIcn + +## SYNOPSIS +Updates the integration account received interchange control number (ICN) in the Azure resource group. + +## SYNTAX + +``` +Set-AzIntegrationAccountReceivedIcn -ResourceGroupName <String> -Name <String> -AgreementName <String> + -ControlNumberValue <String> -IsMessageProcessingFailed <Boolean> [-AgreementType <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzIntegrationAccountGeneratedIcn cmdlet updates an existing integration account received interchange control number (ICN) and returns an object that represents the integration account received interchange control number. +Use this cmdlet to update an integration account received interchange control number's message processing status. +You can update an integration account received interchange control number by specifying the integration account name, resource group name, agreement name, control number value and message processing status. +You cannot create a new integration account received interchange control number with this command. +To use the dynamic parameters, just type them in the command, or type a hyphen sign(-) to indicate a parameter name and then press the TAB key repeatedly to cycle through the available parameters. +If you miss a required template parameter, the cmdlet prompts you for the value. +Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. +Please do provide the "-AgreementType" parameter to specify whether X12 or Edifact control numbers to return + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIntegrationAccountGeneratedIcn -AgreementType "X12" -ResourceGroupName "ResourceGroup1" -Name "IntegrationAccount1" -AgreementName "X12IntegrationAccountAgreement" -ControlNumber "123" +``` + +```output +ControlNumber : 1100 +ControlNumberChangedTime : 2/15/2017 12:36:00 AM +IsMessageProcessingFailed : True +``` + +This command updates the integration account received X12 interchange control number for a specific integration account agreement and value with message processing status failed. + +### Example 2 +```powershell +Set-AzIntegrationAccountGeneratedIcn -AgreementType "Edifact" -ResourceGroupName "ResourceGroup1" -Name "IntegrationAccount1" -AgreementName "EdifactIntegrationAccountAgreement" -ControlNumber "123" +``` + +```output +ControlNumber : 1100 +ControlNumberChangedTime : 2/15/2017 12:36:00 AM +IsMessageProcessingFailed : True +``` + +This command updates the integration account received Edifact interchange control number for a specific integration account agreement and value with message processing status failed. + +## PARAMETERS + +### -AgreementName +The integration account agreement name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgreementType +The integration account agreement type (X12 or Edifact). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MessageType +Accepted values: X12, Edifact + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlNumberValue +The integration account control number value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsMessageProcessingFailed +The received message processing status. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The integration account resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.LogicApp.Utilities.IntegrationAccountControlNumber + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountReceivedIcn](./Get-AzIntegrationAccountReceivedIcn.md) +[Remove-AzIntegrationAccountReceivedIcn](./Remove-AzIntegrationAccountReceivedIcn.md) diff --git a/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountSchema.md b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountSchema.md new file mode 100644 index 0000000000..e206337895 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Set-AzIntegrationAccountSchema.md @@ -0,0 +1,263 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 3D4E44E3-0B55-4699-944F-412EE80CEEEF +online version: https://learn.microsoft.com/powershell/module/az.logicapp/set-azintegrationaccountschema +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountSchema.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzIntegrationAccountSchema.md +--- + +# Set-AzIntegrationAccountSchema + +## SYNOPSIS +Modifies an integration account schema. + +## SYNTAX + +``` +Set-AzIntegrationAccountSchema -ResourceGroupName <String> -Name <String> -SchemaName <String> + [-SchemaFilePath <String>] [-SchemaDefinition <String>] [-SchemaType <String>] [-ContentType <String>] + [-Metadata <Object>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzIntegrationAccountSchema** cmdlet modifies an integration account schema. +This cmdlet returns an object that represents the integration account schema. +Specify the integration account name, resource group name, and schema name. +Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Modify an integration account schema +```powershell +Set-AzIntegrationAccountSchema -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -SchemaName "IntegrationAccountSchema43" -SchemaFilePath "c:\temp\schema1" +``` + +```output +Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/schemas/IntegrationAccountSchema43 +Name : IntegrationAccountSchema43 +Type : Microsoft.Logic/integrationAccounts/schemas +CreatedTime : 3/26/2016 7:21:10 PM +ChangedTime : 3/26/2016 7:21:10 PM +SchemaType : Xml +ContentLink : https://<baseurl>/integrationaccounts68a13b6b49f14995ba7c5f3aedcbd7ad/3839E_XML_INTEGRATIONACCOUNTSCHEMA2-5A6650B914454A2CAB16 + B4A8D3F9840D?sv=2014-02-14&sr=b&sig=<value> +ContentSize : 7901 +``` + +This command modifies the integration account schema named IntegrationAccountSchema43. + +## PARAMETERS + +### -ContentType +Specifies a content type for the integration account schema. +This cmdlet supports application/xml as a map content type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies a metadata object for the schema. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the integration account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IntegrationAccountName, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaDefinition +Specifies a definition object for integration account schema. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchemaFilePath +Specifies the file path of a definition for the integration account schema. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchemaName +Specifies the name of the integration account schema. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaType +Specifies the type for the integration account schema. +This parameter supports Xml as the type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Xml + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Logic.Models.IntegrationAccountSchema + +## NOTES + +## RELATED LINKS + +[Get-AzIntegrationAccountSchema](./Get-AzIntegrationAccountSchema.md) + +[New-AzIntegrationAccountSchema](./New-AzIntegrationAccountSchema.md) + +[Remove-AzIntegrationAccountSchema](./Remove-AzIntegrationAccountSchema.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Set-AzLogicApp.md b/azps-10.1.0/Az.LogicApp/Set-AzLogicApp.md new file mode 100644 index 0000000000..a21f16d956 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Set-AzLogicApp.md @@ -0,0 +1,317 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: AEDA89D3-EF80-4E56-9B97-677EC8F3959D +online version: https://learn.microsoft.com/powershell/module/az.logicapp/set-azlogicapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzLogicApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Set-AzLogicApp.md +--- + +# Set-AzLogicApp + +## SYNOPSIS +Modifies a logic app in a resource group. + +## SYNTAX + +### Consumption (Default) +``` +Set-AzLogicApp -ResourceGroupName <String> -Name <String> [-UseConsumptionModel] [-State <String>] + [-Definition <Object>] [-DefinitionFilePath <String>] [-IntegrationAccountId <String>] [-Parameters <Object>] + [-ParameterFilePath <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### HostingPlan +``` +Set-AzLogicApp -ResourceGroupName <String> -Name <String> [-AppServicePlan <String>] [-State <String>] + [-Definition <Object>] [-DefinitionFilePath <String>] [-IntegrationAccountId <String>] [-Parameters <Object>] + [-ParameterFilePath <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzLogicApp** cmdlet modifies a logic app by using the Logic Apps feature. +A logic app is a collection of actions or triggers defined in Logic App definition. +This cmdlet returns a **Workflow** object. +You can modify a logic app by specifying a name, location, Logic App definition, resource group, and plan. +A Logic App definition and parameters are formatted in JavaScript Object Notation (JSON). +You can use a logic app as a template for definition and parameters. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. +Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. + +## EXAMPLES + +### Example 1: Modify a logic app +```powershell +Set-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp17" -State "Enabled" -AppServicePlan "ServicePlan01" -DefinitionFilePath "d:\workflows\Definition17.json" -ParameterFilePath "d:\workflows\Parameters17.json" +``` + +```output +Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp1 +Name : LogicApp17 +Type : Microsoft.Logic/workflows +Location : westus +ChangedTime : 1/13/2016 2:41:39 PM +CreatedTime : 1/13/2016 2:41:39 PM +AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup11/providers/Microsoft.Logic/workflows/LogicApp17 +State : Enabled +DefinitionLinkUri : +DefinitionLinkContentVersion : +Definition : {$schema, contentVersion, parameters, triggers...} +ParametersLinkUri : +ParametersLinkContentVersion : +Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]} +SkuName : Standard +PlanName : ServicePlan01 +PlanType : Microsoft.Web/ServerFarms +PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan17 +Version : 08587489107859952120 +``` + +This command modifies a logic app. + +## PARAMETERS + +### -AppServicePlan +Specifies the name of a plan. + +```yaml +Type: System.String +Parameter Sets: HostingPlan +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Definition +Specifies the definition of a logic app as an object or a string in JavaScript Object Notation (JSON) format. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFilePath +Specifies the definition of a logic app as the path of a definition file in JSON format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntegrationAccountId +Specifies an integration account ID for the logic app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a logic app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterFilePath +Specifies the path of a JSON formatted parameter file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameters +Specifies a parameters collection object for the Logic App. +Specify a hash table, Dictionary\<string\>, or Dictionary\<string, WorkflowParameter\>. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the state of the logic app. +The acceptable values for this parameter are: Enabled and Disabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseConsumptionModel +Indicates that the logic app billing use the consumption based model. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Consumption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-AzLogicApp](./Get-AzLogicApp.md) + +[New-AzLogicApp](./New-AzLogicApp.md) + +[Remove-AzLogicApp](./Remove-AzLogicApp.md) + +[Start-AzLogicApp](./Start-AzLogicApp.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Start-AzLogicApp.md b/azps-10.1.0/Az.LogicApp/Start-AzLogicApp.md new file mode 100644 index 0000000000..6571006eab --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Start-AzLogicApp.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 50C359FC-D98C-4C2C-87EE-BE9A25C3EDC6 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/start-azlogicapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Start-AzLogicApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Start-AzLogicApp.md +--- + +# Start-AzLogicApp + +## SYNOPSIS +Runs a logic app in a resource group. + +## SYNTAX + +``` +Start-AzLogicApp -ResourceGroupName <String> -Name <String> [-Parameters <Object>] -TriggerName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzLogicApp** cmdlet runs a logic app by using the Logic Apps feature. +Specify a name, resource group, and trigger. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Run a logic app +```powershell +Start-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp03" -TriggerName "Trigger22" +``` + +This command runs the logic app in the resource group named ResourceGroup11. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the logic app that this cmdlet starts. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameters +Specifies a parameters collection object of the logic app. +Specify a hash table, Dictionary\<string\>, or Dictionary\<string, WorkflowParameter\>. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the logic app that this cmdlet starts. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TriggerName +Specifies the name of the trigger of the logic app that this cmdlet starts. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzLogicApp](./Get-AzLogicApp.md) + +[Get-AzLogicAppRunHistory](./Get-AzLogicAppRunHistory.md) + +[New-AzLogicApp](./New-AzLogicApp.md) + +[Remove-AzLogicApp](./Remove-AzLogicApp.md) + +[Set-AzLogicApp](./Set-AzLogicApp.md) + +[Stop-AzLogicAppRun](./Stop-AzLogicAppRun.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Stop-AzLogicAppRun.md b/azps-10.1.0/Az.LogicApp/Stop-AzLogicAppRun.md new file mode 100644 index 0000000000..8544bfedb9 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Stop-AzLogicAppRun.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 3308F901-4C9F-424D-8BEB-877A6038B246 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/stop-azlogicapprun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Stop-AzLogicAppRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Stop-AzLogicAppRun.md +--- + +# Stop-AzLogicAppRun + +## SYNOPSIS +Cancels a run of a logic app. + +## SYNTAX + +``` +Stop-AzLogicAppRun -ResourceGroupName <String> -Name <String> -RunName <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzLogicAppRun** cmdlet cancels a run of a logic app. +Specify the logic app, resource group, and run. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Cancel a run of a logic app +```powershell +Stop-AzLogicAppRun -ResourceGroupName "ResourceGroup11" -Name "LogicApp03" -RunName "08587489104702792076" -Force +``` + +This command cancels a run of the logic app named LogicApp03. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a logic app for which this cmdlet cancels a run. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name for a resource group in which this cmdlet cancels a run. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunName +Specifies the name of a logic app run that this cmdlet cancels. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Start-AzLogicApp](./Start-AzLogicApp.md) + + diff --git a/azps-10.1.0/Az.LogicApp/Test-AzLogicApp.md b/azps-10.1.0/Az.LogicApp/Test-AzLogicApp.md new file mode 100644 index 0000000000..4e839bcf45 --- /dev/null +++ b/azps-10.1.0/Az.LogicApp/Test-AzLogicApp.md @@ -0,0 +1,249 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.LogicApp.dll-Help.xml +Module Name: Az.LogicApp +ms.assetid: 929F4593-2A71-49B9-87F8-F24FA9F6E314 +online version: https://learn.microsoft.com/powershell/module/az.logicapp/test-azlogicapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Test-AzLogicApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/LogicApp/LogicApp/help/Test-AzLogicApp.md +--- + +# Test-AzLogicApp + +## SYNOPSIS +Validates a logic app definition. + +## SYNTAX + +### LogicAppWithDefinitionParameterSet +``` +Test-AzLogicApp -ResourceGroupName <String> -Name <String> -Location <String> [-State <String>] + [-Definition <Object>] [-IntegrationAccountId <String>] [-Parameters <Object>] [-ParameterFilePath <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### LogicAppWithDefinitionFileParameterSet +``` +Test-AzLogicApp -ResourceGroupName <String> -Name <String> -Location <String> [-State <String>] + [-DefinitionFilePath <String>] [-IntegrationAccountId <String>] [-Parameters <Object>] + [-ParameterFilePath <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzLogicApp** cmdlet validates a logic app definition in a resource group. +Specify the logic app name, resource group name, location, state, integration account ID, or parameters. +This module supports dynamic parameters. +To use a dynamic parameter, type it in the command. +To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. +If you omit a required template parameter, the cmdlet prompts you for the value. + +## EXAMPLES + +### Example 1: Validate a logic app by using file paths +```powershell +Test-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp01" -Location "westus" -State "Enabled" -DefinitionFilePath "d:\workflows\Definition.json" -ParameterFilePath "d:\workflows\Parameters.json" +``` + +This command validates a logic app named LogicApp01 in the specified resource group. +The command specifies definition and parameter file paths. + +### Example 2: Validate a logic app by using objects +```powershell +Test-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp01" -Location "westus" -State "Enabled" -Definition ([IO.File]::ReadAllText("d:\Workflows\Definition.json")) -Parameters @{name1="value1";name2="value2"} +``` + +This command validates a logic app named LogicApp01 in the specified resource group. +The command specifies definition and parameter objects. + +### Example 3 + +Validates a logic app definition. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Test-AzLogicApp -DefinitionFilePath 'd:\workflows\Definition.json' -IntegrationAccountId <String> -Location 'westus' -Name 'LogicApp01' -ParameterFilePath 'd:\workflows\Parameters.json' -ResourceGroupName 'ResourceGroup11' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Definition +Specifies the definition of a logic app as an object or a string in JavaScript Object Notation (JSON) format. + +```yaml +Type: System.Object +Parameter Sets: LogicAppWithDefinitionParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFilePath +Specifies the definition of your logic app as the path of a definition file in JSON format. + +```yaml +Type: System.String +Parameter Sets: LogicAppWithDefinitionFileParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntegrationAccountId +Specifies an integration account ID for the logic app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the logic app. +Enter an Azure data center location, such as West US or Southeast Asia. +You can place a logic app in any location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the logic app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParameterFilePath +Specifies the path of a JSON formatted parameter file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameters +Specifies a parameters collection object of the logic app. +Specify a hash table, Dictionary\<string\>, or Dictionary\<string, WorkflowParameter\>. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies a state of the logic app. +The acceptable values for this parameter are: Enabled and Disabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzLogicApp](./Get-AzLogicApp.md) + +[New-AzLogicApp](./New-AzLogicApp.md) + +[Remove-AzLogicApp](./Remove-AzLogicApp.md) + +[Set-AzLogicApp](./Set-AzLogicApp.md) + +[Start-AzLogicApp](./Start-AzLogicApp.md) + + diff --git a/azps-10.1.0/Az.Logz/Az.Logz.md b/azps-10.1.0/Az.Logz/Az.Logz.md new file mode 100644 index 0000000000..f9f54e8269 --- /dev/null +++ b/azps-10.1.0/Az.Logz/Az.Logz.md @@ -0,0 +1,98 @@ +--- +Module Name: Az.Logz +Module Guid: 66d504a5-3bf8-4570-92f4-620ec297b16a +Download Help Link: https://learn.microsoft.com/powershell/module/az.logz +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Az.Logz.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Az.Logz.md +--- + +# Az.Logz Module +## Description +Microsoft Azure PowerShell: Logz cmdlets + +## Az.Logz Cmdlets +### [Get-AzLogzMonitor](Get-AzLogzMonitor.md) +Get the properties of a specific monitor resource. + +### [Get-AzLogzMonitoredResource](Get-AzLogzMonitoredResource.md) +List the resources currently being monitored by the Logz monitor resource. + +### [Get-AzLogzMonitorSSOConfiguration](Get-AzLogzMonitorSSOConfiguration.md) +Gets the Logz single sign-on resource for the given Monitor. + +### [Get-AzLogzMonitorTagRule](Get-AzLogzMonitorTagRule.md) +Get a tag rule set for a given monitor resource. + +### [Get-AzLogzMonitorUserRole](Get-AzLogzMonitorUserRole.md) +List the user's roles configured on Logz.io side for the account corresponding to the monitor resource. + +### [Get-AzLogzMonitorVMHost](Get-AzLogzMonitorVMHost.md) +List the compute resources currently being monitored by the Logz main account resource. + +### [Get-AzLogzSubAccount](Get-AzLogzSubAccount.md) +Get a sub account under a given monitor resource. + +### [Get-AzLogzSubAccountTagRule](Get-AzLogzSubAccountTagRule.md) +Get a tag rule set for a given monitor resource. + +### [Get-AzLogzSubAccountVMHost](Get-AzLogzSubAccountVMHost.md) +List the compute resources currently being monitored by the Logz sub account resource. + +### [Invoke-AzLogzHostMonitor](Invoke-AzLogzHostMonitor.md) +Returns the payload that needs to be passed in the request body for installing Logz.io agent on a VM. + +### [Invoke-AzLogzHostSubAccount](Invoke-AzLogzHostSubAccount.md) +Returns the payload that needs to be passed as a request for installing Logz.io agent on a VM. + +### [New-AzLogzFilteringTagObject](New-AzLogzFilteringTagObject.md) +Create a in-memory object for FilteringTag + +### [New-AzLogzMonitor](New-AzLogzMonitor.md) +Create a monitor resource. +This create operation can take upto 10 minutes to complete. + +### [New-AzLogzMonitorSSOConfiguration](New-AzLogzMonitorSSOConfiguration.md) +Configures single-sign-on for this resource. +This operation can take upto 10 minutes to complete. + +### [New-AzLogzMonitorTagRule](New-AzLogzMonitorTagRule.md) +Create or update a tag rule set for a given monitor resource. + +### [New-AzLogzSubAccount](New-AzLogzSubAccount.md) +Create sub account under a given monitor resource. +This create operation can take upto 10 minutes to complete. + +### [New-AzLogzSubAccountTagRule](New-AzLogzSubAccountTagRule.md) +Create or update a tag rule set for a given sub account resource. + +### [New-AzLogzVMResourcesObject](New-AzLogzVMResourcesObject.md) +Create a in-memory object for VMResources + +### [Remove-AzLogzMonitor](Remove-AzLogzMonitor.md) +Delete a monitor resource. +This delete operation can take upto 10 minutes to complete. + +### [Remove-AzLogzMonitorTagRule](Remove-AzLogzMonitorTagRule.md) +Delete a tag rule set for a given monitor resource. + +### [Remove-AzLogzSubAccount](Remove-AzLogzSubAccount.md) +Delete a sub account resource. +This delete operation can take upto 10 minutes to complete. + +### [Remove-AzLogzSubAccountTagRule](Remove-AzLogzSubAccountTagRule.md) +Delete a tag rule set for a given monitor resource. + +### [Update-AzLogzMonitor](Update-AzLogzMonitor.md) +Update a monitor resource. + +### [Update-AzLogzMonitorVMHost](Update-AzLogzMonitorVMHost.md) +Sending request to update the collection when Logz.io agent has been installed on a VM for a given monitor. + +### [Update-AzLogzSubAccount](Update-AzLogzSubAccount.md) +Update a monitor resource. + +### [Update-AzLogzSubAccountVMHost](Update-AzLogzSubAccountVMHost.md) +Sending request to update the collection when Logz.io agent has been installed on a VM for a given monitor. + diff --git a/azps-10.1.0/Az.Logz/Get-AzLogzMonitor.md b/azps-10.1.0/Az.Logz/Get-AzLogzMonitor.md new file mode 100644 index 0000000000..9fa5502a9c --- /dev/null +++ b/azps-10.1.0/Az.Logz/Get-AzLogzMonitor.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/get-azlogzmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzMonitor.md +--- + +# Get-AzLogzMonitor + +## SYNOPSIS +Get the properties of a specific monitor resource. + +## SYNTAX + +### List (Default) +``` +Get-AzLogzMonitor [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzLogzMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzLogzMonitor -InputObject <ILogzIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzLogzMonitor -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the properties of a specific monitor resource. + +## EXAMPLES + +### Example 1: List all logz monitor resources under a subscription +```powershell +Get-AzLogzMonitor +``` + +```output +Name MonitoringStatus Location ResourceGroupName +---- ---------------- -------- ----------------- +ssoMultipleTest03 Enabled westus2 koyTest +saurgupta_logz_001 Enabled westus2 saurgTest +saurg-test-logz-01 Enabled westus2 saurgTest +``` + +This command lists all logz monitor resources under a subscription. + +### Example 2: List all logz monitor resources under a resource group +```powershell +Get-AzLogzMonitor -ResourceGroupName logz-rg-test +``` + +```output +Name MonitoringStatus Location ResourceGroupName +---- ---------------- -------- ----------------- +logz-pwsh01 Enabled westus2 logz-rg-test +``` + +This command lists all logz monitor resources under a resource group. + +### Example 3: Get the properties of a specific logz monitor resource +```powershell +Get-AzLogzMonitor -ResourceGroupName logz-rg-test -Name logz-pwsh01 +``` + +```output +Name MonitoringStatus Location ResourceGroupName +---- ---------------- -------- ----------------- +logz-pwsh01 Enabled westus2 logz-rg-test +``` + +This command gets the properties of a specific logz monitor resource. + +### Example 4: Get the properties of a specific logz monitor resource by pipeline +```powershell +New-AzLogzMonitor -ResourceGroupName logz-rg-test -Name logz-pwsh01 -Location 'westus2' -PlanBillingCycle 'Monthly' -PlanUsageType 'PAYG' -PlanDetail '100gb14days' -PlanEffectiveDate (Get-Date -AsUTC) -UserInfoEmailAddress 'xxxxx@microsoft.com' -UserInfoPhoneNumber 'xxxxxxxx' -UserInfoFirstName 'xxx' -UserInfoLastName 'xxx' | Get-AzLogzMonitor +``` + +```output +Name MonitoringStatus Location ResourceGroupName +---- ---------------- -------- ----------------- +logz-pwsh01 Enabled westus2 logz-rg-test +``` + +This command gets the properties of a specific logz monitor resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.ILogzMonitorResource + +## 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 `<ILogzIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: + - `[SubAccountName <String>]`: Sub Account resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Get-AzLogzMonitorSSOConfiguration.md b/azps-10.1.0/Az.Logz/Get-AzLogzMonitorSSOConfiguration.md new file mode 100644 index 0000000000..8264348c06 --- /dev/null +++ b/azps-10.1.0/Az.Logz/Get-AzLogzMonitorSSOConfiguration.md @@ -0,0 +1,169 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/get-azlogzmonitorssoconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzMonitorSSOConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzMonitorSSOConfiguration.md +--- + +# Get-AzLogzMonitorSSOConfiguration + +## SYNOPSIS +Gets the Logz single sign-on resource for the given Monitor. + +## SYNTAX + +### Get (Default) +``` +Get-AzLogzMonitorSSOConfiguration -MonitorName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzLogzMonitorSSOConfiguration -InputObject <ILogzIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the Logz single sign-on resource for the given Monitor. + +## EXAMPLES + +### Example 1: Gets the default Logz single sign-on resource for the given Monitor +```powershell +Get-AzLogzMonitorSSOConfiguration -ResourceGroupName LPTrials -MonitorName lpatlogz +``` + +```output +Name ProvisioningState SingleSignOnState SingleSignOnUrl ResourceGroupName +---- ----------------- ----------------- --------------- ----------------- +default Succeeded Existing https://api-wa.logz.io/auth/azure/325420/login LPTrials +``` + +This command gets the default Logz single sign-on resource for the given Monitor. + +### Example 2: Gets the default Logz single sign-on resource for the given Monitor by pipeline +```powershell +New-AzLogzMonitorSSOConfiguration -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 | Get-AzLogzMonitorSSOConfiguration +``` + +```output +Name ProvisioningState SingleSignOnState SingleSignOnUrl ResourceGroupName +---- ----------------- ----------------- --------------- ----------------- +default Succeeded Disable https://app.logz.io/ logz-rg-test +``` + +This command gets the default Logz single sign-on resource for the given Monitor by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.ILogzSingleSignOnResource + +## 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 `<ILogzIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: + - `[SubAccountName <String>]`: Sub Account resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Get-AzLogzMonitorTagRule.md b/azps-10.1.0/Az.Logz/Get-AzLogzMonitorTagRule.md new file mode 100644 index 0000000000..b76113a2b4 --- /dev/null +++ b/azps-10.1.0/Az.Logz/Get-AzLogzMonitorTagRule.md @@ -0,0 +1,168 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/get-azlogzmonitortagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzMonitorTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzMonitorTagRule.md +--- + +# Get-AzLogzMonitorTagRule + +## SYNOPSIS +Get a tag rule set for a given monitor resource. + +## SYNTAX + +### Get (Default) +``` +Get-AzLogzMonitorTagRule -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzLogzMonitorTagRule -InputObject <ILogzIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a tag rule set for a given monitor resource. + +## EXAMPLES + +### Example 1: Get the default tag rule set for a given monitor resource +```powershell +Get-AzLogzMonitorTagRule -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 +``` + +```output +Name ProvisioningState ResourceGroupName +---- ----------------- ----------------- +default Succeeded logz-rg-test +``` + +This command gets the default tag rule set for a given monitor resource. + +### Example 2: Get the default tag rule set for a given monitor resource by pipeline +```powershell +Get-AzLogzMonitorTagRule -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 | Get-AzLogzMonitorTagRule +``` + +```output +Name ProvisioningState ResourceGroupName +---- ----------------- ----------------- +default Succeeded logz-rg-test +``` + +This command gets the default tag rule set for a given monitor resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IMonitoringTagRules + +## 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 `<ILogzIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: + - `[SubAccountName <String>]`: Sub Account resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Get-AzLogzMonitorUserRole.md b/azps-10.1.0/Az.Logz/Get-AzLogzMonitorUserRole.md new file mode 100644 index 0000000000..7ff766ef3c --- /dev/null +++ b/azps-10.1.0/Az.Logz/Get-AzLogzMonitorUserRole.md @@ -0,0 +1,163 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/get-azlogzmonitoruserrole +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzMonitorUserRole.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzMonitorUserRole.md +--- + +# Get-AzLogzMonitorUserRole + +## SYNOPSIS +List the user's roles configured on Logz.io side for the account corresponding to the monitor resource. + +## SYNTAX + +``` +Get-AzLogzMonitorUserRole -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-EmailAddress <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List the user's roles configured on Logz.io side for the account corresponding to the monitor resource. + +## EXAMPLES + +### Example 1: List the user's roles configured on Logz.io side for the account corresponding to the monitor resource +```powershell +Get-AzLogzMonitorUserRole -ResourceGroupName logz-rg-test -Name pwsh-logz04 +``` + +```output +Role +---- +None +``` + +This command lists the user's roles configured on Logz.io side for the account corresponding to the monitor resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddress +Email of the user used by Logz for contacting them if needed + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IUserRoleResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Get-AzLogzMonitorVMHost.md b/azps-10.1.0/Az.Logz/Get-AzLogzMonitorVMHost.md new file mode 100644 index 0000000000..e895550c74 --- /dev/null +++ b/azps-10.1.0/Az.Logz/Get-AzLogzMonitorVMHost.md @@ -0,0 +1,148 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/get-azlogzmonitorvmhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzMonitorVMHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzMonitorVMHost.md +--- + +# Get-AzLogzMonitorVMHost + +## SYNOPSIS +List the compute resources currently being monitored by the Logz main account resource. + +## SYNTAX + +``` +Get-AzLogzMonitorVMHost -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List the compute resources currently being monitored by the Logz main account resource. + +## EXAMPLES + +### Example 1: List the compute resources currently being monitored by the monitor resource +```powershell +Get-AzLogzMonitorVMHost -ResourceGroupName logz-rg-test -Name pwsh-logz04 +``` + +```output +AgentVersion Id +------------ -- +1.0 /SUBSCRIPTIONS/xxxx-xxxxxx-xx-xxxxxx/RESOURCEGROUPS/KOYTEST/PROVIDERS/MICROSOFT.COMPUTE/VIRTUALMACHINES/TEST-VM-1 +``` + +This command lists the compute resources currently being monitored by the monitor resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IVMResources + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Get-AzLogzMonitoredResource.md b/azps-10.1.0/Az.Logz/Get-AzLogzMonitoredResource.md new file mode 100644 index 0000000000..fdfbc9693c --- /dev/null +++ b/azps-10.1.0/Az.Logz/Get-AzLogzMonitoredResource.md @@ -0,0 +1,156 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/get-azlogzmonitoredresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzMonitoredResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzMonitoredResource.md +--- + +# Get-AzLogzMonitoredResource + +## SYNOPSIS +List the resources currently being monitored by the Logz monitor resource. + +## SYNTAX + +### List (Default) +``` +Get-AzLogzMonitoredResource -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ListBySubAccount +``` +Get-AzLogzMonitoredResource -MonitorName <String> -ResourceGroupName <String> -SubAccountName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List the resources currently being monitored by the Logz monitor resource. + +## EXAMPLES + +### Example 1: List the resources currently being monitored by the Logz monitor resource +```powershell +Get-AzLogzMonitoredResource -ResourceGroupName LPTrials -MonitorName lpatlogz +``` + +```output +ReasonForLogsStatus ReasonForMetricsStatus SendingLog SendingMetric +------------------- ---------------------- ---------- ------------- +CapturedByRules True +CapturedByRules True +CapturedByRules True +CapturedByRules True +CapturedByRules True +``` + +This command lists the resources currently being monitored by the Logz monitor resource. + +### Example 2: List the resources currently being monitored by the Logz sub account +```powershell +Get-AzLogzMonitoredResource -ResourceGroupName LPTrials -MonitorName lpatlogz -SubAccountName lpslogzsubaccount +``` + +```output +ReasonForLogsStatus ReasonForMetricsStatus SendingLog SendingMetric +------------------- ---------------------- ---------- ------------- +Other False +``` + +This command lists the resources currently being monitored by the Logz sub account + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubAccountName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: ListBySubAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IMonitoredResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Get-AzLogzSubAccount.md b/azps-10.1.0/Az.Logz/Get-AzLogzSubAccount.md new file mode 100644 index 0000000000..975bd75f49 --- /dev/null +++ b/azps-10.1.0/Az.Logz/Get-AzLogzSubAccount.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/get-azlogzsubaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzSubAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzSubAccount.md +--- + +# Get-AzLogzSubAccount + +## SYNOPSIS +Get a sub account under a given monitor resource. + +## SYNTAX + +### List (Default) +``` +Get-AzLogzSubAccount -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzLogzSubAccount -MonitorName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzLogzSubAccount -InputObject <ILogzIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a sub account under a given monitor resource. + +## EXAMPLES + +### Example 1: List all sub accounts under a given monitor resource +```powershell +Get-AzLogzSubAccount -ResourceGroupName logz-rg-test -MonitorName logz-portal01 +``` + +```output +Name MonitoringStatus Location ResourceGroupName +---- ---------------- -------- ----------------- +logz01-subaccount01 Enabled westus2 logz-rg-test +logz01-subaccount02 Enabled westus2 logz-rg-test +``` + +This command lists all sub accounts under a given monitor resource. + +### Example 2: Get a sub account under a given monitor resource +```powershell +Get-AzLogzSubAccount -ResourceGroupName logz-rg-test -MonitorName logz-portal01 -Name logz01-subaccount01 +``` + +```output +Name MonitoringStatus Location ResourceGroupName +---- ---------------- -------- ----------------- +logz01-subaccount01 Enabled westus2 logz-rg-test +``` + +This command gets a sub account under a given monitor resource. + +### Example 3: Get a sub account under a given monitor resource by pipeline +```powershell +New-AzLogzSubAccount -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -Name logz-pwshsub01 -Location 'westus2' -PlanBillingCycle 'Monthly' -PlanUsageType 'PAYG' -PlanDetail '100gb14days' -PlanEffectiveDate (Get-Date -AsUTC) -UserInfoEmailAddress 'xxxxx@microsoft.com' -UserInfoPhoneNumber 'xxxxxx' -UserInfoFirstName 'xxx' -UserInfoLastName 'xxx' | Get-AzLogzSubAccount +``` + +```output +Name MonitoringStatus Location ResourceGroupName +---- ---------------- -------- ----------------- +logz-pwshsub01 Enabled westus2 logz-rg-test +``` + +This command gets a sub account under a given monitor resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Sub Account resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SubAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.ILogzMonitorResource + +## 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 `<ILogzIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: + - `[SubAccountName <String>]`: Sub Account resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Get-AzLogzSubAccountTagRule.md b/azps-10.1.0/Az.Logz/Get-AzLogzSubAccountTagRule.md new file mode 100644 index 0000000000..474d3aaded --- /dev/null +++ b/azps-10.1.0/Az.Logz/Get-AzLogzSubAccountTagRule.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/get-azlogzsubaccounttagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzSubAccountTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzSubAccountTagRule.md +--- + +# Get-AzLogzSubAccountTagRule + +## SYNOPSIS +Get a tag rule set for a given monitor resource. + +## SYNTAX + +### Get (Default) +``` +Get-AzLogzSubAccountTagRule -MonitorName <String> -ResourceGroupName <String> -SubAccountName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzLogzSubAccountTagRule -InputObject <ILogzIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a tag rule set for a given monitor resource. + +## EXAMPLES + +### Example 1: Get the default tag rule set for a given logz sub account resource +```powershell +Get-AzLogzSubAccountTagRule -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -SubAccountName logz-pwshsub01 +``` + +```output +Name ProvisioningState ResourceGroupName +---- ----------------- ----------------- +default Succeeded logz-rg-test +``` + +This command gets the default tag rule set for a given logz sub account resource. + +### Example 2: Get the default tag rule set for a given logz sub account resourceby pipeline +```powershell +New-AzLogzSubAccountTagRule -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -SubAccountName logz-pwshsub01 | Get-AzLogzSubAccountTagRule +``` + +```output +Name ProvisioningState ResourceGroupName +---- ----------------- ----------------- +default Succeeded logz-rg-test +``` + +This command gets the default tag rule set for a given logz sub account resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubAccountName +Sub Account resource name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IMonitoringTagRules + +## 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 `<ILogzIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: + - `[SubAccountName <String>]`: Sub Account resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Get-AzLogzSubAccountVMHost.md b/azps-10.1.0/Az.Logz/Get-AzLogzSubAccountVMHost.md new file mode 100644 index 0000000000..3d236df998 --- /dev/null +++ b/azps-10.1.0/Az.Logz/Get-AzLogzSubAccountVMHost.md @@ -0,0 +1,163 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/get-azlogzsubaccountvmhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzSubAccountVMHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Get-AzLogzSubAccountVMHost.md +--- + +# Get-AzLogzSubAccountVMHost + +## SYNOPSIS +List the compute resources currently being monitored by the Logz sub account resource. + +## SYNTAX + +``` +Get-AzLogzSubAccountVMHost -MonitorName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List the compute resources currently being monitored by the Logz sub account resource. + +## EXAMPLES + +### Example 1: List the compute resources currently being monitored by the logz sub account resource +```powershell +Get-AzLogzSubAccountVMHost -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -Name logz-pwshsub01 +``` + +```output +AgentVersion Id +------------ -- +1.0 /SUBSCRIPTIONS/CE37D538-DFA3-49C3-B3CD-149B4B7DB48A/RESOURCEGROUPS/KOYTEST/PROVIDERS/MICROSOFT.COMPUTE/VIRTUALMACHINES/TEST-VM-1 +``` + +This command lists the compute resources currently being monitored by the logz sub account resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Sub Account resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IVMResources + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Invoke-AzLogzHostMonitor.md b/azps-10.1.0/Az.Logz/Invoke-AzLogzHostMonitor.md new file mode 100644 index 0000000000..362f8f944f --- /dev/null +++ b/azps-10.1.0/Az.Logz/Invoke-AzLogzHostMonitor.md @@ -0,0 +1,200 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/invoke-azlogzhostmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Invoke-AzLogzHostMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Invoke-AzLogzHostMonitor.md +--- + +# Invoke-AzLogzHostMonitor + +## SYNOPSIS +Returns the payload that needs to be passed in the request body for installing Logz.io agent on a VM. + +## SYNTAX + +### Host (Default) +``` +Invoke-AzLogzHostMonitor -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### HostViaIdentity +``` +Invoke-AzLogzHostMonitor -InputObject <ILogzIdentity> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns the payload that needs to be passed in the request body for installing Logz.io agent on a VM. + +## EXAMPLES + +### Example 1: Returns the payload that needs to be passed in the request body for installing Logz.io agent on a VM +```powershell +Invoke-AzLogzHostMonitor -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 +``` + +```output +ApiKey Region +------ ------ +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx westus2 +``` + +This command returns the payload that needs to be passed in the request body for installing Logz.io agent on a VM. + +### Example 2: Returns the payload that needs to be passed in the request body for installing Logz.io agent on a VM by pipeline +```powershell +Get-AzLogzMonitor -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 | Invoke-AzLogzHostMonitor +``` + +```output +ApiKey Region +------ ------ +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx westus2 +``` + +This command returns the payload that needs to be passed in the request body for installing Logz.io agent on a VM by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity +Parameter Sets: HostViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Host +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Host +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Host +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IVMExtensionPayload + +## 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 `<ILogzIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: + - `[SubAccountName <String>]`: Sub Account resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Invoke-AzLogzHostSubAccount.md b/azps-10.1.0/Az.Logz/Invoke-AzLogzHostSubAccount.md new file mode 100644 index 0000000000..3636fc6636 --- /dev/null +++ b/azps-10.1.0/Az.Logz/Invoke-AzLogzHostSubAccount.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/invoke-azlogzhostsubaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Invoke-AzLogzHostSubAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Invoke-AzLogzHostSubAccount.md +--- + +# Invoke-AzLogzHostSubAccount + +## SYNOPSIS +Returns the payload that needs to be passed as a request for installing Logz.io agent on a VM. + +## SYNTAX + +### Host (Default) +``` +Invoke-AzLogzHostSubAccount -MonitorName <String> -ResourceGroupName <String> -SubAccountName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### HostViaIdentity +``` +Invoke-AzLogzHostSubAccount -InputObject <ILogzIdentity> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns the payload that needs to be passed as a request for installing Logz.io agent on a VM. + +## EXAMPLES + +### Example 1: Returns the payload of the logz sub account that needs to be passed in the request body for installing Logz.io agent on a VM +```powershell +Invoke-AzLogzHostSubAccount -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -SubAccountName logz-pwshsub01 +``` + +```output +ApiKey Region +------ ------ +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx westus2 +``` + +This command returns the payload of the logz sub account that needs to be passed in the request body for installing Logz.io agent on a VM. + +### Example 2: Returns the payload of the logz sub account that needs to be passed in the request body for installing Logz.io agent on a VM by pipeline +```powershell +Get-AzLogzSubAccount -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -Name logz-pwshsub01 | Invoke-AzLogzHostSubAccount +``` + +```output +ApiKey Region +------ ------ +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx westus2 +``` + +This command returns the payload of the logz sub account that needs to be passed in the request body for installing Logz.io agent on a VM by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity +Parameter Sets: HostViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Host +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Host +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubAccountName +Sub Account resource name + +```yaml +Type: System.String +Parameter Sets: Host +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Host +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IVMExtensionPayload + +## 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 `<ILogzIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: + - `[SubAccountName <String>]`: Sub Account resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/New-AzLogzFilteringTagObject.md b/azps-10.1.0/Az.Logz/New-AzLogzFilteringTagObject.md new file mode 100644 index 0000000000..3eda9b4c45 --- /dev/null +++ b/azps-10.1.0/Az.Logz/New-AzLogzFilteringTagObject.md @@ -0,0 +1,102 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.Logz/new-AzLogzFilteringTagObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzFilteringTagObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzFilteringTagObject.md +--- + +# New-AzLogzFilteringTagObject + +## SYNOPSIS +Create a in-memory object for FilteringTag + +## SYNTAX + +``` +New-AzLogzFilteringTagObject [-Action <TagAction>] [-Name <String>] [-Value <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for FilteringTag + +## EXAMPLES + +### Example 1: Create a in-memory object for FilteringTag pass into parameter LogRuleFilteringTag when creating a tage rule for the monitor resource +```powershell +$filter = New-AzLogzFilteringTagObject -Action 'Include' -Name 'Env' -Value "Prod" +New-AzLogzMonitorTagRule -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -LogRuleFilteringTag $filter +``` + +```output +Name ProvisioningState ResourceGroupName +---- ----------------- ----------------- +default Succeeded logz-rg-test +``` + +This command creates a in-memory object for FilteringTag pass into parameter LogRuleFilteringTag when creating a tage rule for the monitor resource. + +## PARAMETERS + +### -Action +Valid actions for a filtering tag. +Exclusion takes priority over inclusion. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Support.TagAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name (also known as the key) of the tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The value of the tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.FilteringTag + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/New-AzLogzMonitor.md b/azps-10.1.0/Az.Logz/New-AzLogzMonitor.md new file mode 100644 index 0000000000..d0433332dc --- /dev/null +++ b/azps-10.1.0/Az.Logz/New-AzLogzMonitor.md @@ -0,0 +1,428 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/new-azlogzmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzMonitor.md +--- + +# New-AzLogzMonitor + +## SYNOPSIS +Create a monitor resource. +This create operation can take upto 10 minutes to complete. + +## SYNTAX + +``` +New-AzLogzMonitor -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-CompanyName <String>] [-EnterpriseAppId <String>] [-IdentityType <ManagedIdentityTypes>] + [-MarketplaceSubscriptionStatus <MarketplaceSubscriptionStatus>] [-MonitoringStatus <MonitoringStatus>] + [-PlanBillingCycle <String>] [-PlanDetail <String>] [-PlanEffectiveDate <DateTime>] [-PlanUsageType <String>] + [-SingleSignOnUrl <String>] [-Tag <Hashtable>] [-UserInfoEmailAddress <String>] [-UserInfoFirstName <String>] + [-UserInfoLastName <String>] [-UserInfoPhoneNumber <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a monitor resource. +This create operation can take upto 10 minutes to complete. + +## EXAMPLES + +### Example 1: Create a monitor resource +```powershell +New-AzLogzMonitor -ResourceGroupName logz-rg-test -Name pwsh-logz05 -Location 'westus2' -PlanBillingCycle 'Monthly' -PlanUsageType 'PAYG' -PlanEffectiveDate (Get-Date -AsUTC) -PlanDetail '100gb14days' -UserInfoEmailAddress 'xxxxx@microsoft.com' -UserInfoPhoneNumber 'xxxxxxxx' -UserInfoFirstName 'xxx' -UserInfoLastName 'xxx' +``` + +```output +Name MonitoringStatus Location ResourceGroupName +---- ---------------- -------- ----------------- +logz-pwsh01 Enabled westus2 logz-rg-test +``` + +This command creates a monitor resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +Name of the Logz organization. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnterpriseAppId +The Id of the Enterprise App used for Single sign on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Support.ManagedIdentityTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceSubscriptionStatus +Flag specifying the Marketplace Subscription Status of the resource. +If payment is not made in time, the resource will go in Suspended state. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Support.MarketplaceSubscriptionStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoringStatus +Flag specifying if the resource monitoring is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Support.MonitoringStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanBillingCycle +different billing cycles like MONTHLY/WEEKLY. +this could be enum + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDetail +plan id as published by Logz + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanEffectiveDate +date when plan was applied + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanUsageType +different usage type like PAYG/COMMITTED. +this could be enum + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnUrl +The login URL specific to this Logz Organization. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Dictionary of \<string\> + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoEmailAddress +Email of the user used by Logz for contacting them if needed + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoFirstName +First Name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoLastName +Last Name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoPhoneNumber +Phone number of the user used by Logz for contacting them if needed + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.ILogzMonitorResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/New-AzLogzMonitorSSOConfiguration.md b/azps-10.1.0/Az.Logz/New-AzLogzMonitorSSOConfiguration.md new file mode 100644 index 0000000000..bb7d69a3e3 --- /dev/null +++ b/azps-10.1.0/Az.Logz/New-AzLogzMonitorSSOConfiguration.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/new-azlogzmonitorssoconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzMonitorSSOConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzMonitorSSOConfiguration.md +--- + +# New-AzLogzMonitorSSOConfiguration + +## SYNOPSIS +Configures single-sign-on for this resource. +This operation can take upto 10 minutes to complete. + +## SYNTAX + +``` +New-AzLogzMonitorSSOConfiguration -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-EnterpriseAppId <String>] [-SingleSignOnState <SingleSignOnStates>] [-SingleSignOnUrl <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Configures single-sign-on for this resource. +This operation can take upto 10 minutes to complete. + +## EXAMPLES + +### Example 1: Configures single-sign-on for this resource +```powershell +New-AzLogzMonitorSSOConfiguration -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 +``` + +```output +Name ProvisioningState SingleSignOnState SingleSignOnUrl ResourceGroupName +---- ----------------- ----------------- --------------- ----------------- +default Succeeded Disable https://app.logz.io/ logz-rg-test +``` + +This command configures single-sign-on for this resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnterpriseAppId +The Id of the Enterprise App used for Single sign-on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnState +Various states of the SSO resource + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Support.SingleSignOnStates +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnUrl +The login URL specific to this Logz Organization. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.ILogzSingleSignOnResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/New-AzLogzMonitorTagRule.md b/azps-10.1.0/Az.Logz/New-AzLogzMonitorTagRule.md new file mode 100644 index 0000000000..ebfb876807 --- /dev/null +++ b/azps-10.1.0/Az.Logz/New-AzLogzMonitorTagRule.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/new-azlogzmonitortagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzMonitorTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzMonitorTagRule.md +--- + +# New-AzLogzMonitorTagRule + +## SYNOPSIS +Create or update a tag rule set for a given monitor resource. + +## SYNTAX + +``` +New-AzLogzMonitorTagRule -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-LogRuleFilteringTag <IFilteringTag[]>] [-LogRuleSendAadLog] [-LogRuleSendActivityLog] + [-LogRuleSendSubscriptionLog] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a tag rule set for a given monitor resource. + +## EXAMPLES + +### Example 1: Create or update a tag rule set for a given monitor resource +```powershell +New-AzLogzMonitorTagRule -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 +``` + +```output +Name ProvisioningState ResourceGroupName +---- ----------------- ----------------- +default Succeeded logz-rg-test +``` + +This command creates or update a tag rule set for a given monitor resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleFilteringTag +List of filtering tags to be used for capturing logs. +This only takes effect if SendActivityLogs flag is enabled. +If empty, all resources will be captured. +If only Exclude action is specified, the rules will apply to the list of all available resources. +If Include actions are specified, the rules will only include resources with the associated tags. +To construct, see NOTES section for LOGRULEFILTERINGTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IFilteringTag[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendAadLog +Flag specifying if AAD logs should be sent for the Monitor resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendActivityLog +Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendSubscriptionLog +Flag specifying if subscription logs should be sent for the Monitor resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IMonitoringTagRules + +## 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. + + +LOGRULEFILTERINGTAG <IFilteringTag[]>: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. + - `[Action <TagAction?>]`: Valid actions for a filtering tag. Exclusion takes priority over inclusion. + - `[Name <String>]`: The name (also known as the key) of the tag. + - `[Value <String>]`: The value of the tag. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/New-AzLogzSubAccount.md b/azps-10.1.0/Az.Logz/New-AzLogzSubAccount.md new file mode 100644 index 0000000000..5ce56bc62e --- /dev/null +++ b/azps-10.1.0/Az.Logz/New-AzLogzSubAccount.md @@ -0,0 +1,444 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/new-azlogzsubaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzSubAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzSubAccount.md +--- + +# New-AzLogzSubAccount + +## SYNOPSIS +Create sub account under a given monitor resource. +This create operation can take upto 10 minutes to complete. + +## SYNTAX + +``` +New-AzLogzSubAccount -MonitorName <String> -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-CompanyName <String>] [-EnterpriseAppId <String>] + [-IdentityType <ManagedIdentityTypes>] [-MarketplaceSubscriptionStatus <MarketplaceSubscriptionStatus>] + [-MonitoringStatus <MonitoringStatus>] [-PlanBillingCycle <String>] [-PlanDetail <String>] + [-PlanEffectiveDate <DateTime>] [-PlanUsageType <String>] [-SingleSignOnUrl <String>] [-Tag <Hashtable>] + [-UserInfoEmailAddress <String>] [-UserInfoFirstName <String>] [-UserInfoLastName <String>] + [-UserInfoPhoneNumber <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create sub account under a given monitor resource. +This create operation can take upto 10 minutes to complete. + +## EXAMPLES + +### Example 1: Create sub account under a given monitor resource +```powershell +New-AzLogzSubAccount -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -Name logz-pwshsub01 -Location 'westus2' -PlanBillingCycle 'Monthly' -PlanUsageType 'PAYG' -PlanDetail '100gb14days' -PlanEffectiveDate (Get-Date -AsUTC) -UserInfoEmailAddress 'xxxxx@microsoft.com' -UserInfoPhoneNumber 'xxxxxx' -UserInfoFirstName 'xxx' -UserInfoLastName 'xxx' +``` + +```output +Name MonitoringStatus Location ResourceGroupName +---- ---------------- -------- ----------------- +logz-pwshsub01 Enabled westus2 logz-rg-test +``` + +This command creates sub account under a given monitor resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +Name of the Logz organization. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnterpriseAppId +The Id of the Enterprise App used for Single sign on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Support.ManagedIdentityTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceSubscriptionStatus +Flag specifying the Marketplace Subscription Status of the resource. +If payment is not made in time, the resource will go in Suspended state. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Support.MarketplaceSubscriptionStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoringStatus +Flag specifying if the resource monitoring is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Support.MonitoringStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Sub Account resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SubAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanBillingCycle +different billing cycles like MONTHLY/WEEKLY. +this could be enum + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDetail +plan id as published by Logz + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanEffectiveDate +date when plan was applied + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanUsageType +different usage type like PAYG/COMMITTED. +this could be enum + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SingleSignOnUrl +The login URL specific to this Logz Organization. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Dictionary of \<string\> + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoEmailAddress +Email of the user used by Logz for contacting them if needed + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoFirstName +First Name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoLastName +Last Name of the user + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInfoPhoneNumber +Phone number of the user used by Logz for contacting them if needed + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.ILogzMonitorResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/New-AzLogzSubAccountTagRule.md b/azps-10.1.0/Az.Logz/New-AzLogzSubAccountTagRule.md new file mode 100644 index 0000000000..a67f171408 --- /dev/null +++ b/azps-10.1.0/Az.Logz/New-AzLogzSubAccountTagRule.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/new-azlogzsubaccounttagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzSubAccountTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzSubAccountTagRule.md +--- + +# New-AzLogzSubAccountTagRule + +## SYNOPSIS +Create or update a tag rule set for a given sub account resource. + +## SYNTAX + +``` +New-AzLogzSubAccountTagRule -MonitorName <String> -ResourceGroupName <String> -SubAccountName <String> + [-SubscriptionId <String>] [-LogRuleFilteringTag <IFilteringTag[]>] [-LogRuleSendAadLog] + [-LogRuleSendActivityLog] [-LogRuleSendSubscriptionLog] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a tag rule set for a given sub account resource. + +## EXAMPLES + +### Example 1: Create or update a tag rule set for a given sub account resource +```powershell +New-AzLogzSubAccountTagRule -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -SubAccountName logz-pwshsub01 +``` + +```output +Name ProvisioningState ResourceGroupName +---- ----------------- ----------------- +default Succeeded logz-rg-test +``` + +This command creates or update a tag rule set for a given sub account resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleFilteringTag +List of filtering tags to be used for capturing logs. +This only takes effect if SendActivityLogs flag is enabled. +If empty, all resources will be captured. +If only Exclude action is specified, the rules will apply to the list of all available resources. +If Include actions are specified, the rules will only include resources with the associated tags. +To construct, see NOTES section for LOGRULEFILTERINGTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IFilteringTag[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendAadLog +Flag specifying if AAD logs should be sent for the Monitor resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendActivityLog +Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogRuleSendSubscriptionLog +Flag specifying if subscription logs should be sent for the Monitor resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubAccountName +Sub Account resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IMonitoringTagRules + +## 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. + + +LOGRULEFILTERINGTAG <IFilteringTag[]>: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. + - `[Action <TagAction?>]`: Valid actions for a filtering tag. Exclusion takes priority over inclusion. + - `[Name <String>]`: The name (also known as the key) of the tag. + - `[Value <String>]`: The value of the tag. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/New-AzLogzVMResourcesObject.md b/azps-10.1.0/Az.Logz/New-AzLogzVMResourcesObject.md new file mode 100644 index 0000000000..c28c87b3ed --- /dev/null +++ b/azps-10.1.0/Az.Logz/New-AzLogzVMResourcesObject.md @@ -0,0 +1,86 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.Logz/new-AzLogzVMResourcesObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzVMResourcesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/New-AzLogzVMResourcesObject.md +--- + +# New-AzLogzVMResourcesObject + +## SYNOPSIS +Create a in-memory object for VMResources + +## SYNTAX + +``` +New-AzLogzVMResourcesObject [-AgentVersion <String>] [-Id <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for VMResources + +## EXAMPLES + +### Example 1: Create a in-memory object for VMResources pass into parameter VMResource when updating vm host of the monitor resource +```powershell +$vmResource = New-AzLogzVMResourcesObject -AgentVersion '1.0' -Id '/SUBSCRIPTIONS/CE37D538-DFA3-49C3-B3CD-149B4B7DB48A/RESOURCEGROUPS/KOYTEST/PROVIDERS/MICROSOFT.COMPUTE/VIRTUALMACHINES/TEST-VM-1' +Update-AzLogzMonitorVMHost -ResourceGroupName logz-rg-test -Name pwsh-logz04 -State 'Install' -VMResource $vmResource +``` + +```output +AgentVersion Id +------------ -- +1.0 /SUBSCRIPTIONS/CE37D538-DFA3-49C3-B3CD-149B4B7DB48A/RESOURCEGROUPS/KOYTEST/PROVIDERS/MICROSOFT.COMPUTE/VIRTUALMACHINES/TEST-VM-1 +``` + +This command creates a in-memory object for VMResources pass into parameter VMResource when updating vm host of the monitor resource. + +## PARAMETERS + +### -AgentVersion +Version of the Logz agent installed on the VM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Request of a list vm host update operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.VMResources + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Remove-AzLogzMonitor.md b/azps-10.1.0/Az.Logz/Remove-AzLogzMonitor.md new file mode 100644 index 0000000000..29e405b9bc --- /dev/null +++ b/azps-10.1.0/Az.Logz/Remove-AzLogzMonitor.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/remove-azlogzmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Remove-AzLogzMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Remove-AzLogzMonitor.md +--- + +# Remove-AzLogzMonitor + +## SYNOPSIS +Delete a monitor resource. +This delete operation can take upto 10 minutes to complete. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzLogzMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzLogzMonitor -InputObject <ILogzIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a monitor resource. +This delete operation can take upto 10 minutes to complete. + +## EXAMPLES + +### Example 1: Delete a monitor resource +```powershell +Remove-AzLogzMonitor -ResourceGroupName logz-rg-test -Name logz-portal01 +``` + +This command deletes a monitor resource + +### Example 2: Delete a monitor resource by pipeline +```powershell +Get-AzLogzMonitor -ResourceGroupName logz-rg-test -Name logz-portal01 | Remove-AzLogzMonitor +``` + +This command deletes a monitor resource by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ILogzIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: + - `[SubAccountName <String>]`: Sub Account resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Remove-AzLogzMonitorTagRule.md b/azps-10.1.0/Az.Logz/Remove-AzLogzMonitorTagRule.md new file mode 100644 index 0000000000..c681f20b18 --- /dev/null +++ b/azps-10.1.0/Az.Logz/Remove-AzLogzMonitorTagRule.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/remove-azlogzmonitortagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Remove-AzLogzMonitorTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Remove-AzLogzMonitorTagRule.md +--- + +# Remove-AzLogzMonitorTagRule + +## SYNOPSIS +Delete a tag rule set for a given monitor resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzLogzMonitorTagRule -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzLogzMonitorTagRule -InputObject <ILogzIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a tag rule set for a given monitor resource. + +## EXAMPLES + +### Example 1: Delete a tag rule set for a given monitor resource +```powershell +Remove-AzLogzMonitorTagRule -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 +``` + +This command deletes a tag rule set for a given monitor resource. + +### Example 2: Delete a tag rule set for a given monitor resource by pipeline +```powershell +Get-AzLogzMonitorTagRule -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 | Remove-AzLogzMonitorTagRule +``` + +This command deletes a tag rule set for a given monitor resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ILogzIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: + - `[SubAccountName <String>]`: Sub Account resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Remove-AzLogzSubAccount.md b/azps-10.1.0/Az.Logz/Remove-AzLogzSubAccount.md new file mode 100644 index 0000000000..8b59b2de78 --- /dev/null +++ b/azps-10.1.0/Az.Logz/Remove-AzLogzSubAccount.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/remove-azlogzsubaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Remove-AzLogzSubAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Remove-AzLogzSubAccount.md +--- + +# Remove-AzLogzSubAccount + +## SYNOPSIS +Delete a sub account resource. +This delete operation can take upto 10 minutes to complete. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzLogzSubAccount -MonitorName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzLogzSubAccount -InputObject <ILogzIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a sub account resource. +This delete operation can take upto 10 minutes to complete. + +## EXAMPLES + +### Example 1: Delete a sub account resource +```powershell +Remove-AzLogzSubAccount -ResourceGroupName logz-rg-test -MonitorName logz-portal01 -Name logz01-subaccount01 +``` + +This command deletes a sub account resource. + +### Example 2: Delete a sub account resource by pipeline +```powershell +Get-AzLogzSubAccount -ResourceGroupName logz-rg-test -MonitorName logz-portal01 -Name logz01-subaccount02 | Remove-AzLogzSubAccount +``` + +This command deletes a sub account resource by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Sub Account resource name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SubAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ILogzIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: + - `[SubAccountName <String>]`: Sub Account resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Remove-AzLogzSubAccountTagRule.md b/azps-10.1.0/Az.Logz/Remove-AzLogzSubAccountTagRule.md new file mode 100644 index 0000000000..a76e847b6e --- /dev/null +++ b/azps-10.1.0/Az.Logz/Remove-AzLogzSubAccountTagRule.md @@ -0,0 +1,218 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/remove-azlogzsubaccounttagrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Remove-AzLogzSubAccountTagRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Remove-AzLogzSubAccountTagRule.md +--- + +# Remove-AzLogzSubAccountTagRule + +## SYNOPSIS +Delete a tag rule set for a given monitor resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzLogzSubAccountTagRule -MonitorName <String> -ResourceGroupName <String> -SubAccountName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzLogzSubAccountTagRule -InputObject <ILogzIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a tag rule set for a given monitor resource. + +## EXAMPLES + +### Example 1: Delete a tag rule set for a given logz sub account resource +```powershell +Remove-AzLogzSubAccountTagRule -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -SubAccountName logz-pwshsub01 +``` + +This command deletes a tag rule set for a given logz sub account resource. + +### Example 2: Delete a tag rule set for a given logz sub account resource by pipeline +```powershell +Get-AzLogzSubAccountTagRule -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -SubAccountName logz-pwshsub01 | Remove-AzLogzSubAccountTagRule +``` + +This command deletes a tag rule set for a given logz sub account resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubAccountName +Sub Account resource name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ILogzIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: + - `[SubAccountName <String>]`: Sub Account resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Update-AzLogzMonitor.md b/azps-10.1.0/Az.Logz/Update-AzLogzMonitor.md new file mode 100644 index 0000000000..67b5754e93 --- /dev/null +++ b/azps-10.1.0/Az.Logz/Update-AzLogzMonitor.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/update-azlogzmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Update-AzLogzMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Update-AzLogzMonitor.md +--- + +# Update-AzLogzMonitor + +## SYNOPSIS +Update a monitor resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzLogzMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-MonitoringStatus <MonitoringStatus>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzLogzMonitor -InputObject <ILogzIdentity> [-MonitoringStatus <MonitoringStatus>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a monitor resource. + +## EXAMPLES + +### Example 1: Update a monitor resource +```powershell +Update-AzLogzMonitor -ResourceGroupName logz-rg-test -Name pwsh-logz04 -Tag @{'key01'=1;'key02'=2;'key03'=3} +``` + +```output +Name MonitoringStatus Location ResourceGroupName +---- ---------------- -------- ----------------- +pwsh-logz04 Enabled westus2 logz-rg-test +``` + +This command updates a monitor resource. + +### Example 2: Update a monitor resource by pipeline +```powershell +Get-AzLogzMonitor -ResourceGroupName logz-rg-test -Name pwsh-logz04 | Update-AzLogzMonitor -Tag @{'key01'=1;'key02'=2;'key03'=3} +``` + +```output +Name MonitoringStatus Location ResourceGroupName +---- ---------------- -------- ----------------- +pwsh-logz04 Enabled westus2 logz-rg-test +``` + +This command updates a monitor resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitoringStatus +Flag specifying if the resource monitoring is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Support.MonitoringStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The new tags of the monitor resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.ILogzMonitorResource + +## 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 `<ILogzIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: + - `[SubAccountName <String>]`: Sub Account resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Update-AzLogzMonitorVMHost.md b/azps-10.1.0/Az.Logz/Update-AzLogzMonitorVMHost.md new file mode 100644 index 0000000000..249aaba068 --- /dev/null +++ b/azps-10.1.0/Az.Logz/Update-AzLogzMonitorVMHost.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/update-azlogzmonitorvmhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Update-AzLogzMonitorVMHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Update-AzLogzMonitorVMHost.md +--- + +# Update-AzLogzMonitorVMHost + +## SYNOPSIS +Sending request to update the collection when Logz.io agent has been installed on a VM for a given monitor. + +## SYNTAX + +``` +Update-AzLogzMonitorVMHost -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-State <VMHostUpdateStates>] [-VMResource <IVMResources[]>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Sending request to update the collection when Logz.io agent has been installed on a VM for a given monitor. + +## EXAMPLES + +### Example 1: Sending request to update the collection when Logz.io agent has been installed on a VM for a given monitor +```powershell +$vmResource = New-AzLogzVMResourcesObject -AgentVersion '1.0' -Id '/SUBSCRIPTIONS/CE37D538-DFA3-49C3-B3CD-149B4B7DB48A/RESOURCEGROUPS/KOYTEST/PROVIDERS/MICROSOFT.COMPUTE/VIRTUALMACHINES/TEST-VM-1' +Update-AzLogzMonitorVMHost -ResourceGroupName logz-rg-test -Name pwsh-logz04 -State 'Install' -VMResource $vmResource +``` + +```output +AgentVersion Id +------------ -- +1.0 /SUBSCRIPTIONS/CE37D538-DFA3-49C3-B3CD-149B4B7DB48A/RESOURCEGROUPS/KOYTEST/PROVIDERS/MICROSOFT.COMPUTE/VIRTUALMACHINES/TEST-VM-1 +``` + +This command sending request to update the collection when Logz.io agent has been installed on a VM for a given monitor. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Specifies the state of the operation - install/ delete. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Support.VMHostUpdateStates +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMResource +Request of a list vm host update operation. +To construct, see NOTES section for VMRESOURCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IVMResources[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IVMResources + +## 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. + + +VMRESOURCE <IVMResources[]>: Request of a list vm host update operation. + - `[AgentVersion <String>]`: Version of the Logz agent installed on the VM. + - `[Id <String>]`: Request of a list vm host update operation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Update-AzLogzSubAccount.md b/azps-10.1.0/Az.Logz/Update-AzLogzSubAccount.md new file mode 100644 index 0000000000..93969da8e1 --- /dev/null +++ b/azps-10.1.0/Az.Logz/Update-AzLogzSubAccount.md @@ -0,0 +1,246 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/update-azlogzsubaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Update-AzLogzSubAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Update-AzLogzSubAccount.md +--- + +# Update-AzLogzSubAccount + +## SYNOPSIS +Update a monitor resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzLogzSubAccount -MonitorName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-MonitoringStatus <MonitoringStatus>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzLogzSubAccount -InputObject <ILogzIdentity> [-MonitoringStatus <MonitoringStatus>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a monitor resource. + +## EXAMPLES + +### Example 1: Update a logz sub account resource +```powershell +Update-AzLogzSubAccount -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -Name logz-pwshsub01 -Tag @{'key01'=1;'key02'=2;'key03'=3} +``` + +```output +Name MonitoringStatus Location ResourceGroupName +---- ---------------- -------- ----------------- +logz-pwshsub01 Enabled westus2 logz-rg-test +``` + +This command updates a logz sub account resource. + +### Example 2: Update a logz sub account resource by pipeline +```powershell +Get-AzLogzSubAccount -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -Name logz-pwshsub01 | Update-AzLogzSubAccount -Tag @{'key01'=1;'key02'=2;'key03'=3} +``` + +```output +Name MonitoringStatus Location ResourceGroupName +---- ---------------- -------- ----------------- +logz-pwshsub01 Enabled westus2 logz-rg-test +``` + +This command updates a logz sub account resource by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitoringStatus +Flag specifying if the resource monitoring is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Support.MonitoringStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Sub Account resource name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: SubAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The new tags of the monitor resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.ILogzIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.ILogzMonitorResource + +## 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 `<ILogzIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: + - `[Id <String>]`: Resource identity path + - `[MonitorName <String>]`: Monitor resource name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleSetName <String>]`: + - `[SubAccountName <String>]`: Sub Account resource name + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Logz/Update-AzLogzSubAccountVMHost.md b/azps-10.1.0/Az.Logz/Update-AzLogzSubAccountVMHost.md new file mode 100644 index 0000000000..217c525960 --- /dev/null +++ b/azps-10.1.0/Az.Logz/Update-AzLogzSubAccountVMHost.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.Logz +online version: https://learn.microsoft.com/powershell/module/az.logz/update-azlogzsubaccountvmhost +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Update-AzLogzSubAccountVMHost.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Logz/help/Update-AzLogzSubAccountVMHost.md +--- + +# Update-AzLogzSubAccountVMHost + +## SYNOPSIS +Sending request to update the collection when Logz.io agent has been installed on a VM for a given monitor. + +## SYNTAX + +``` +Update-AzLogzSubAccountVMHost -MonitorName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-State <VMHostUpdateStates>] [-VMResource <IVMResources[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Sending request to update the collection when Logz.io agent has been installed on a VM for a given monitor. + +## EXAMPLES + +### Example 1: Sending request to update the collection when Logz.io agent has been installed on a VM for a logz sub account monitor +```powershell +$vmResource = New-AzLogzVMResourcesObject -AgentVersion '1.0' -Id '/SUBSCRIPTIONS/CE37D538-DFA3-49C3-B3CD-149B4B7DB48A/RESOURCEGROUPS/KOYTEST/PROVIDERS/MICROSOFT.COMPUTE/VIRTUALMACHINES/TEST-VM-1' +Update-AzLogzSubAccountVMHost -ResourceGroupName logz-rg-test -MonitorName pwsh-logz04 -Name logz-pwshsub01 -VMResource $vmResource -State 'Install' +``` + +```output +AgentVersion Id +------------ -- +1.0 /SUBSCRIPTIONS/CE37D538-DFA3-49C3-B3CD-149B4B7DB48A/RESOURCEGROUPS/KOYTEST/PROVIDERS/MICROSOFT.COMPUTE/VIRTUALMACHINES/TEST-VM-1 +``` + +This command sending request to update the collection when Logz.io agent has been installed on a VM for a logz sub account monitor. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Sub Account resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Specifies the state of the operation - install/ delete. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Support.VMHostUpdateStates +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMResource +Request of a list vm host update operation. +To construct, see NOTES section for VMRESOURCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IVMResources[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Logz.Models.Api20201001Preview.IVMResources + +## 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. + + +VMRESOURCE <IVMResources[]>: Request of a list vm host update operation. + - `[AgentVersion <String>]`: Version of the Logz agent installed on the VM. + - `[Id <String>]`: Request of a list vm host update operation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearning/Add-AzMlWebServiceRegionalProperty.md b/azps-10.1.0/Az.MachineLearning/Add-AzMlWebServiceRegionalProperty.md new file mode 100644 index 0000000000..807369952e --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Add-AzMlWebServiceRegionalProperty.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/add-azmlwebserviceregionalproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Add-AzMlWebServiceRegionalProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Add-AzMlWebServiceRegionalProperty.md +--- + +# Add-AzMlWebServiceRegionalProperty + +## SYNOPSIS +Creates regional web service properties. + +## SYNTAX + +``` +Add-AzMlWebServiceRegionalProperty -ResourceGroupName <String> -Name <String> -Region <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates Azure Machine Learning regional properties for an existing web service. + +## EXAMPLES + +### Example 1: Add new regional properties for West Central US + +```powershell +Add-AzMlWebServiceRegionalProperty -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -Region westcentralus +``` + +This example command creates regional property for a web service in the "West Central US" region. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name for the web service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Region +The region in which to create the web service properties. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group in which the web service belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/Az.MachineLearning.md b/azps-10.1.0/Az.MachineLearning/Az.MachineLearning.md new file mode 100644 index 0000000000..fce0de439c --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Az.MachineLearning.md @@ -0,0 +1,93 @@ +--- +Module Name: Az.MachineLearning +Module Guid: bb030259-49f9-46ef-806f-2a3f5a2e018e +Download Help Link: https://learn.microsoft.com/powershell/module/az.machinelearning +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Az.MachineLearning.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Az.MachineLearning.md +--- + +# Az.MachineLearning Module +## Description +Machine Learning Web Services cmdlets for Azure Resource Manager + +## Az.MachineLearning Cmdlets +### [Add-AzMlWebServiceRegionalProperty](Add-AzMlWebServiceRegionalProperty.md) +Creates regional web service properties. + +### [Export-AzMlWebService](Export-AzMlWebService.md) +Exports the web service definition object as a JSON formatted string. + +### [Get-AzMlCommitmentAssociation](Get-AzMlCommitmentAssociation.md) +Retrieves the summary information for one or more commitment associations. + +### [Get-AzMlCommitmentPlan](Get-AzMlCommitmentPlan.md) +Retrieves the summary information for one or more commitment plans. + +### [Get-AzMlCommitmentPlanUsageHistory](Get-AzMlCommitmentPlanUsageHistory.md) +Retrieves usage history information for a specified commitment plan. + +### [Get-AzMlOpCluster](Get-AzMlOpCluster.md) +**Important: This cmdlet is deprecated** + +Gets an operationalization cluster object. + +### [Get-AzMlOpClusterKey](Get-AzMlOpClusterKey.md) +**Important: This cmdlet is deprecated** + +Gets the access keys associated with an operationalization cluster. + +### [Get-AzMlWebService](Get-AzMlWebService.md) +Retrieves the summary information for one or more web services. + +### [Get-AzMlWebServiceKey](Get-AzMlWebServiceKey.md) +Retrieves the web service's keys. + +### [Import-AzMlWebService](Import-AzMlWebService.md) +Imports a JSON object into a web service definition. + +### [Move-AzMlCommitmentAssociation](Move-AzMlCommitmentAssociation.md) +Moves a commitment association from one commitment plan to another. + +### [New-AzMlCommitmentPlan](New-AzMlCommitmentPlan.md) +Creates a new commitment plan. + +### [New-AzMlOpCluster](New-AzMlOpCluster.md) +**Important: This cmdlet is deprecated** + +Creates a new operationalization cluster. + +### [New-AzMlWebService](New-AzMlWebService.md) +Creates a new web service. + +### [Remove-AzMlCommitmentPlan](Remove-AzMlCommitmentPlan.md) +Deletes a commitment plan. + +### [Remove-AzMlOpCluster](Remove-AzMlOpCluster.md) +Removes an operationalization cluster. + +### [Remove-AzMlWebService](Remove-AzMlWebService.md) +Deletes a web service. + +### [Set-AzMlOpCluster](Set-AzMlOpCluster.md) +**Important: This cmdlet is deprecated** + +Sets the properties of an operationalization cluster. + +### [Test-AzMlOpClusterSystemServicesUpdateAvailability](Test-AzMlOpClusterSystemServicesUpdateAvailability.md) +**Important: This cmdlet is deprecated** + +Checks if there are updates available for the system services associated with an operationalization cluster. + +### [Update-AzMlCommitmentPlan](Update-AzMlCommitmentPlan.md) +Updates properties of an existing commitment plan resource. + +### [Update-AzMlOpClusterSystemService](Update-AzMlOpClusterSystemService.md) +**Important: This cmdlet is deprecated** + +Starts an update on the operationalization cluster's system services. + +### [Update-AzMlWebService](Update-AzMlWebService.md) +Updates properties of an existing web service resource. + diff --git a/azps-10.1.0/Az.MachineLearning/Export-AzMlWebService.md b/azps-10.1.0/Az.MachineLearning/Export-AzMlWebService.md new file mode 100644 index 0000000000..cf4ed80483 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Export-AzMlWebService.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/export-azmlwebservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Export-AzMlWebService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Export-AzMlWebService.md +--- + +# Export-AzMlWebService + +## SYNOPSIS +Exports the web service definition object as a JSON formatted string. + +## SYNTAX + +### ExportToFile +``` +Export-AzMlWebService -WebService <WebService> -OutputFile <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ExportToJSON +``` +Export-AzMlWebService -WebService <WebService> [-ToJsonString] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Exports the definition object for the specified web service as a JSON formatted string. +You can return the string immediately or save it to a file. + +## EXAMPLES + +### Example 1: Export as string +```powershell +Export-AzMlWebService -WebService $svc -ToJsonString +``` + +### Example 2: Export to file +```powershell +Export-AzMlWebService -WebService $svc -OutputFile "C:\mlservice.json" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFile +The file path for exported definition. + +```yaml +Type: System.String +Parameter Sets: ExportToFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ToJsonString +Specifies that the definition will be exported as a JSON string. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ExportToJSON +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebService +The web service definition object to be exported. + +```yaml +Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService + +## OUTPUTS + +### System.String + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/Get-AzMlCommitmentAssociation.md b/azps-10.1.0/Az.MachineLearning/Get-AzMlCommitmentAssociation.md new file mode 100644 index 0000000000..d456947164 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Get-AzMlCommitmentAssociation.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/get-azmlcommitmentassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Get-AzMlCommitmentAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Get-AzMlCommitmentAssociation.md +--- + +# Get-AzMlCommitmentAssociation + +## SYNOPSIS +Retrieves the summary information for one or more commitment associations. + +## SYNTAX + +``` +Get-AzMlCommitmentAssociation -ResourceGroupName <String> -CommitmentPlanName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves commitment association information. +Depending on the parameters passed, the cmdlet returns a specific commitment association or a collection of commitment associations for the specified commitment plan. + +## EXAMPLES + +### Example 1: Get a specific commitment association +```powershell +Get-AzMlCommitmentAssociation -ResourceGroupName "MyResourceGroup" -CommitmentPlanName "MyCommitmentPlanName" -Name "MyCommitmentAssociationName" +``` + +### Example 2: Get all commitment associations for the specified commitment plan +```powershell +Get-AzMlCommitmentAssociation -ResourceGroupName "MyResourceGroup" -CommitmentPlanName "MyCommitmentPlanName" +``` + +## PARAMETERS + +### -CommitmentPlanName +The name of the Azure ML commitment plan which has one or more commitment associations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Azure ML commitment association. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group for the Azure ML commitment association. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/Get-AzMlCommitmentPlan.md b/azps-10.1.0/Az.MachineLearning/Get-AzMlCommitmentPlan.md new file mode 100644 index 0000000000..159965c520 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Get-AzMlCommitmentPlan.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/get-azmlcommitmentplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Get-AzMlCommitmentPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Get-AzMlCommitmentPlan.md +--- + +# Get-AzMlCommitmentPlan + +## SYNOPSIS +Retrieves the summary information for one or more commitment plans. + +## SYNTAX + +``` +Get-AzMlCommitmentPlan [-ResourceGroupName <String>] [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves commitment plan information. +Depending on the parameters passed, the cmdlet returns the a specific commitment plan, a collection of commitment plans for a specified resource group within the current subscription, or a collection of commitment plans within the current subscription. + +## EXAMPLES + +### Example 1: Get a specific commitment plan +```powershell +Get-AzMlCommitmentPlan -ResourceGroupName "MyResourceGroup" -Name "MyCommitmentPlanName" +``` + +### Example 2: Get all commitment plan resources in current subscription +```powershell +Get-AzMlCommitmentPlan +``` + +### Example 3: Get all commitment plans in the current subscription and given resource group +```powershell +Get-AzMlCommitmentPlan -ResourceGroupName "MyResourceGroup" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group for the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/Get-AzMlCommitmentPlanUsageHistory.md b/azps-10.1.0/Az.MachineLearning/Get-AzMlCommitmentPlanUsageHistory.md new file mode 100644 index 0000000000..d5be7e52bd --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Get-AzMlCommitmentPlanUsageHistory.md @@ -0,0 +1,93 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/get-azmlcommitmentplanusagehistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Get-AzMlCommitmentPlanUsageHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Get-AzMlCommitmentPlanUsageHistory.md +--- + +# Get-AzMlCommitmentPlanUsageHistory + +## SYNOPSIS +Retrieves usage history information for a specified commitment plan. + +## SYNTAX + +``` +Get-AzMlCommitmentPlanUsageHistory -ResourceGroupName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves usage history information for a specified commitment plan, including resources used and resources remaining within the plan. + +## EXAMPLES + +### Example 1: Get usage history for a specific commitment plan +```powershell +Get-AzMlCommitmentPlanUsageHistory -ResourceGroupName "MyResourceGroup" -Name "MyCommitmentPlanName" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group for the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.PlanUsageHistory + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/Get-AzMlWebService.md b/azps-10.1.0/Az.MachineLearning/Get-AzMlWebService.md new file mode 100644 index 0000000000..33883e3062 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Get-AzMlWebService.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/get-azmlwebservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Get-AzMlWebService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Get-AzMlWebService.md +--- + +# Get-AzMlWebService + +## SYNOPSIS +Retrieves the summary information for one or more web services. + +## SYNTAX + +``` +Get-AzMlWebService [-ResourceGroupName <String>] [-Name <String>] [-Region <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves web service definition information. +Depending on the parameters passed, the cmdlet returns the definition for a specific web service, a collection of definitions for the web services for a specified resource group within the current subscription, or a collection of definitions for the web services within the current subscription. + +## EXAMPLES + +### Example 1: Get details of specific web service +```powershell +Get-AzMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" +``` + +### Example 2: Get all web service resources in current subscription +```powershell +Get-AzMlWebService +``` + +### Example 3: Get all web services in the current subscription and given resource group +```powershell +Get-AzMlWebService -ResourceGroupName "myresourcegroup" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the web service for which the details are retrieved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Region +The name of region + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group from which the details for the web service are retrieved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/Get-AzMlWebServiceKey.md b/azps-10.1.0/Az.MachineLearning/Get-AzMlWebServiceKey.md new file mode 100644 index 0000000000..30a26e1195 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Get-AzMlWebServiceKey.md @@ -0,0 +1,122 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/get-azmlwebservicekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Get-AzMlWebServiceKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Get-AzMlWebServiceKey.md +--- + +# Get-AzMlWebServiceKey + +## SYNOPSIS +Retrieves the web service's keys. + +## SYNTAX + +### GetByNameAndResourceGroup +``` +Get-AzMlWebServiceKey -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByInstance +``` +Get-AzMlWebServiceKey -MlWebService <WebService> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the access keys for the Azure Machine Learning web service's runtime APIs. + +## EXAMPLES + +### Example 1 - Get the keys for a web service specified by resource group and name +```powershell +Get-AzMlWebServiceKey -ResourceGroupName "myresourcegroup" -Name "mywebservicename" +``` + +### Example 2 - Get keys for web service instance +```powershell +Get-AzMlWebServiceKey -MlWebService $mlService +``` + +$mlService is an object of type Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MlWebService +The name of the web service for which the access keys are retrieved. + +```yaml +Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService +Parameter Sets: GetByInstance +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the web service for which the access keys are retrieved. + +```yaml +Type: System.String +Parameter Sets: GetByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group for the web service. + +```yaml +Type: System.String +Parameter Sets: GetByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService + +## OUTPUTS + +### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebServiceKeys + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/Import-AzMlWebService.md b/azps-10.1.0/Az.MachineLearning/Import-AzMlWebService.md new file mode 100644 index 0000000000..0d18a25d7b --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Import-AzMlWebService.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/import-azmlwebservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Import-AzMlWebService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Import-AzMlWebService.md +--- + +# Import-AzMlWebService + +## SYNOPSIS +Imports a JSON object into a web service definition. + +## SYNTAX + +### ImportFromJSONFile +``` +Import-AzMlWebService -InputFile <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ImportFromJSONString. +``` +Import-AzMlWebService -JsonString <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Import-AzMlWebService cmdlet imports , specified either directly or in a referenced file, and creates a web service definition object that can be passed to the New-AzMlWebService cmdlet. + +## EXAMPLES + +### Example 1: Import from string +```powershell +Import-AzMlWebService -JsonString $jsonDefinition +``` + +### Example 2: Import from file path +```powershell +Import-AzMlWebService -InputFile "C:\mlservice.json" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +The path to the file containing the web service definition to import. + +```yaml +Type: System.String +Parameter Sets: ImportFromJSONFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +The JSON formatted string containing the web service definition to import. + +```yaml +Type: System.String +Parameter Sets: ImportFromJSONString. +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/Move-AzMlCommitmentAssociation.md b/azps-10.1.0/Az.MachineLearning/Move-AzMlCommitmentAssociation.md new file mode 100644 index 0000000000..497a745580 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Move-AzMlCommitmentAssociation.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/move-azmlcommitmentassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Move-AzMlCommitmentAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Move-AzMlCommitmentAssociation.md +--- + +# Move-AzMlCommitmentAssociation + +## SYNOPSIS +Moves a commitment association from one commitment plan to another. + +## SYNTAX + +``` +Move-AzMlCommitmentAssociation -ResourceGroupName <String> -CommitmentPlanName <String> -Name <String> + -DestinationPlanId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Moves a commitment association resource from its parent commitment plan to another commitment plan. + +## EXAMPLES + +### Example 1: Move a commitment association +```powershell +Move-AzMlCommitmentAssociation -ResourceGroupName "MyResourceGroup" -CommitmentPlanName "SourceCommitmentPlanName" -Name "MyCommitmentAssociationName" -DestinationPlanId "/subscriptions/MySubscriptionId/resourceGroups/MyResourceGroup/providers/Microsoft.MachineLearning/commitmentPlans/DestinationCommitmentPlanName" +``` + +## PARAMETERS + +### -CommitmentPlanName +The name of the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPlanId +The Azure resource ID of the destination Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Azure ML commitment association. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group for the Azure ML commitment association. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/New-AzMlCommitmentPlan.md b/azps-10.1.0/Az.MachineLearning/New-AzMlCommitmentPlan.md new file mode 100644 index 0000000000..066ad5fcfb --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/New-AzMlCommitmentPlan.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/new-azmlcommitmentplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/New-AzMlCommitmentPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/New-AzMlCommitmentPlan.md +--- + +# New-AzMlCommitmentPlan + +## SYNOPSIS +Creates a new commitment plan. + +## SYNTAX + +``` +New-AzMlCommitmentPlan -ResourceGroupName <String> -Location <String> -Name <String> -SkuName <String> + -SkuTier <String> [-SkuCapacity <Int32>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an Azure Machine Learning commitment plan in an existing resource group. +If a commitment plan with the same name exists in the resource group, the call acts as an update operation and the existing commitment plan is overwritten. + +## EXAMPLES + +### Example 1: Create a new commitment plan +```powershell +New-AzMlCommitmentPlan -ResourceGroupName "MyResourceGroup" -Name "MyCommitmentPlanName" -Location "South Central US" -SkuName DevTest -SkuTier Standard -SkuCapacity 1 +``` + +Creates a new Azure Machine Learning commitment plan named "MyCommitmentPlanName" in the "MyResourceGroup" group and South Central US region. In this example, the SKU DevTest/Standard is used, meaning the resources provided by the commitment plan will be defined by the limits of DevTest/Standard. The SkuCapacity in this example is 1, meaning the cost of the plan will be 1x the cost of DevTest, and the resources the plan contains will be 1x what DevTest provides. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group for the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +The capacity of the SKU to use when provisioning the Azure ML commitment plan. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU to use when provisioning the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +The tier of the SKU to use when provisioning the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/New-AzMlWebService.md b/azps-10.1.0/Az.MachineLearning/New-AzMlWebService.md new file mode 100644 index 0000000000..0a26140d51 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/New-AzMlWebService.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/new-azmlwebservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/New-AzMlWebService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/New-AzMlWebService.md +--- + +# New-AzMlWebService + +## SYNOPSIS +Creates a new web service. + +## SYNTAX + +### CreateFromFile +``` +New-AzMlWebService -ResourceGroupName <String> -Location <String> -Name <String> -DefinitionFile <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateFromInstance +``` +New-AzMlWebService -ResourceGroupName <String> -Location <String> -Name <String> + -NewWebServiceDefinition <WebService> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates an Azure Machine Learning web service in an existing resource group. +If a web service with the same name exists in the resource group, the call acts as an update operation and the existing web service is overwritten. + +## EXAMPLES + +### Example 1: Create a new service from a Json file based definition +```powershell +New-AzMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -Location "South Central US" -DefinitionFile "C:\mlservice.json" +``` + +Creates a new Azure Machine Learning web service named "mywebservicename" in the "myresourcegroup" group and South Central US region, based on the definition present in the referenced json file. + +### Example 2: Create a new service from an object instance +```powershell +New-AzMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -Location "South Central US" -NewWebServiceDefinition $serviceDefinitionObject +``` + +You can obtain a web service object instance to customize before publishing as a resource by using the Import-AzMlWebService cmdlet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +Specifies the path to the file containing the JSON format definition of the web service. +You can find the latest specification for the web service definition in the swagger spec under https://github.com/Azure/azure-rest-api-specs/blob/master/specification/machinelearning/resource-manager/Microsoft.MachineLearning/. + +```yaml +Type: System.String +Parameter Sets: CreateFromFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The region of the web service. +Enter an Azure data center region, such as "West US" or "Southeast Asia". +You can place a web service in any region that supports resources of that type. +The web service does not have to be in the same region your Azure subscription or the same region as its resource group. +Resource groups can contain web services from different regions. +To determine which regions support each resource type, use the Get-AzResourceProvider with the ProviderNamespace parameter cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name for the web service. +The name must be unique in the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewWebServiceDefinition +The definition for the new web service, containing all the properties that make up the service. +This parameter is required and represents an instance of the Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService class. +You can find the latest specification for the web service definition in the swagger spec under https://github.com/Azure/azure-rest-api-specs/blob/master/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2017-01-01/webservices.json. + +```yaml +Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService +Parameter Sets: CreateFromInstance +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group in which to place the web service. +Enter an Azure data center region, such as "West US" or "Southeast Asia". +You can place a web service in any region that supports resources of that type. +The web service does not have to be in the same region your Azure subscription or the same region as its resource group. +Resource groups can contain web services from different regions. +To determine which regions support each resource type, use the Get-AzResourceProvider with the ProviderNamespace parameter cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService + +## OUTPUTS + +### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/Remove-AzMlCommitmentPlan.md b/azps-10.1.0/Az.MachineLearning/Remove-AzMlCommitmentPlan.md new file mode 100644 index 0000000000..448e64bf96 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Remove-AzMlCommitmentPlan.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/remove-azmlcommitmentplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Remove-AzMlCommitmentPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Remove-AzMlCommitmentPlan.md +--- + +# Remove-AzMlCommitmentPlan + +## SYNOPSIS +Deletes a commitment plan. + +## SYNTAX + +### RemoveByNameAndResourceGroup +``` +Remove-AzMlCommitmentPlan -ResourceGroupName <String> -Name <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzMlCommitmentPlan -MlCommitmentPlan <CommitmentPlan> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an Azure Machine Learning commitment plan. Note that commitment plans which have commitment associations cannot be deleted. Commitment associations can only be deleted by their target resource. For example, if you delete an Azure Machine Learning web service, the commitment association which associates the web service to a commitment plan will also be deleted. + +## EXAMPLES + +### Example 1: Delete a commitment plan +```powershell +Remove-AzMlCommitmentPlan -ResourceGroupName "MyResourceGroup" -Name "MyCommitmentPlanName" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MlCommitmentPlan +The machine learning web service object. + +```yaml +Type: Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group for the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan + +## OUTPUTS + +### System.Void + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/Remove-AzMlWebService.md b/azps-10.1.0/Az.MachineLearning/Remove-AzMlWebService.md new file mode 100644 index 0000000000..c4f10c4cf2 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Remove-AzMlWebService.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/remove-azmlwebservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Remove-AzMlWebService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Remove-AzMlWebService.md +--- + +# Remove-AzMlWebService + +## SYNOPSIS +Deletes a web service. + +## SYNTAX + +### RemoveByNameAndResourceGroup +``` +Remove-AzMlWebService -ResourceGroupName <String> -Name <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzMlWebService -MlWebService <WebService> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Azure Machine Learning web service referenced by resource group and name. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MlWebService +The web service to be removed. + +```yaml +Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the web service to be removed. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the web service. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService + +## OUTPUTS + +### System.Void + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/Update-AzMlCommitmentPlan.md b/azps-10.1.0/Az.MachineLearning/Update-AzMlCommitmentPlan.md new file mode 100644 index 0000000000..3ba29b81e3 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Update-AzMlCommitmentPlan.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/update-azmlcommitmentplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Update-AzMlCommitmentPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Update-AzMlCommitmentPlan.md +--- + +# Update-AzMlCommitmentPlan + +## SYNOPSIS +Updates properties of an existing commitment plan resource. + +## SYNTAX + +``` +Update-AzMlCommitmentPlan -ResourceGroupName <String> -Name <String> -SkuName <String> -SkuTier <String> + [-SkuCapacity <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing commitment plan resource. Note that most properties of the commitment plan are immutable and cannot be modified. Properties which can be modified include Sku (allowing you to migrate the commitment plan from one SKU to another) and Tags. + +## EXAMPLES + +### Example 1: Update a commitment plan +```powershell +Update-AzMlCommitmentPlan -ResourceGroupName "MyResourceGroup" -Name "MyCommitmentPlanName" -Tag @{'MyTagKey'='MyTagValue'} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group for the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +The capacity of the SKU to use when updating the Azure ML commitment plan. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU to use when updating the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +The tier of the SKU to use when updating the Azure ML commitment plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags for the commitment plan resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearning/Update-AzMlWebService.md b/azps-10.1.0/Az.MachineLearning/Update-AzMlWebService.md new file mode 100644 index 0000000000..d1e1ed2b68 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearning/Update-AzMlWebService.md @@ -0,0 +1,363 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.MachineLearning.dll-Help.xml +Module Name: Az.MachineLearning +online version: https://learn.microsoft.com/powershell/module/az.machinelearning/update-azmlwebservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Update-AzMlWebService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearning/MachineLearning/help/Update-AzMlWebService.md +--- + +# Update-AzMlWebService + +## SYNOPSIS +Updates properties of an existing web service resource. + +## SYNTAX + +### UpdateFromParameters +``` +Update-AzMlWebService -ResourceGroupName <String> -Name <String> [-Title <String>] [-Description <String>] + [-IsReadOnly] [-Keys <WebServiceKeys>] [-StorageAccountKey <String>] [-Diagnostics <DiagnosticsConfiguration>] + [-RealtimeConfiguration <RealtimeConfiguration>] [-Assets <Hashtable>] + [-Input <ServiceInputOutputSpecification>] [-Output <ServiceInputOutputSpecification>] + [-Parameters <Hashtable>] [-Package <GraphPackage>] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateFromObject +``` +Update-AzMlWebService -ResourceGroupName <String> -Name <String> -ServiceUpdates <WebService> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Update-AzMlWebService cmdlet allows you to update the non-static properties of a web service. +The cmdlet works as a patch operation. +Pass only the properties that you want modified. + +## EXAMPLES + +### Example 1: Selective update arguments +```powershell +Update-AzMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -Description "new update to description" -Keys @{Primary='changed primary key'} -Diagnostics @{Level='All'} +``` + +Here, we change the description, primary access key and enable the diagnostics collection for all traces during runtime for the web service. + +### Example 2: Update based on a web service instance +```powershell +$updates = @{ Properties = @{ Title="New Title"; RealtimeConfiguration = @{ MaxConcurrentCalls=25 }}} + +Update-AzMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -ServiceUpdates $updates +``` + +The example first creates a web service definition, that only contains the fields to be updated, and then calls the Update-AzMlWebService to apply them using the ServiceUpdates parameter. + +## PARAMETERS + +### -Assets +The set of assets (e.g. modules, datasets) that make up the web service. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateFromParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The new value for the web service's description. +This is visible in the service's Swagger API schema. + +```yaml +Type: System.String +Parameter Sets: UpdateFromParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Diagnostics +The settings that control the diagnostics traces collection for the web service. + +```yaml +Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.DiagnosticsConfiguration +Parameter Sets: UpdateFromParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Input +The definition for the web service's input(s), provided as a Swagger schema construct. + +```yaml +Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.ServiceInputOutputSpecification +Parameter Sets: UpdateFromParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsReadOnly +Specifies that this web service is readonly. +Once set, the web service can longer be updated, including changing the value of this property, and can only be deleted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateFromParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Keys +Updates one or both of the access keys used to authenticate calls to the service's runtime APIs. + +```yaml +Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebServiceKeys +Parameter Sets: UpdateFromParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the web service resource to be updated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Output +The definition for the web service's output(s), provided as a Swagger schema construct. + +```yaml +Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.ServiceInputOutputSpecification +Parameter Sets: UpdateFromParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Package +The definition of the graph package that defines this web service. + +```yaml +Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.GraphPackage +Parameter Sets: UpdateFromParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameters +The set of global parameters values defined for the web service, given as a global parameter name -\> default value collection. +If no default value is specified, the parameter is considered to be required. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateFromParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealtimeConfiguration +Updates for the configuration of the service's realtime endpoint. + +```yaml +Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.RealtimeConfiguration +Parameter Sets: UpdateFromParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group that contains the web service to be updated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceUpdates +A set of updates to apply to the web service provided as a web service definition instance. +Only non-static fields are modified. + +```yaml +Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService +Parameter Sets: UpdateFromObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountKey +Rotates the access key for the storage account associated with the web service. + +```yaml +Type: System.String +Parameter Sets: UpdateFromParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title +The new value for the web service's title. +This is visible in the service's Swagger API schema. + +```yaml +Type: System.String +Parameter Sets: UpdateFromParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService + +## OUTPUTS + +### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MachineLearningServices/Az.MachineLearningServices.md b/azps-10.1.0/Az.MachineLearningServices/Az.MachineLearningServices.md new file mode 100644 index 0000000000..e5954d2a3b --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Az.MachineLearningServices.md @@ -0,0 +1,392 @@ +--- +Module Name: Az.MachineLearningServices +Module Guid: 56293047-9014-4c88-96b7-98b69c3b687d +Download Help Link: https://learn.microsoft.com/powershell/module/az.machinelearningservices +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Az.MachineLearningServices.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Az.MachineLearningServices.md +--- + +# Az.MachineLearningServices Module +## Description +Microsoft Azure PowerShell: MachineLearningServices cmdlets + +## Az.MachineLearningServices Cmdlets +### [Get-AzMLServiceQuota](Get-AzMLServiceQuota.md) +Gets the currently assigned Workspace Quotas based on VMFamily. + +### [Get-AzMLServiceUsage](Get-AzMLServiceUsage.md) +Gets the current usage information as well as limits for AML resources for given subscription and location. + +### [Get-AzMLServiceVMSize](Get-AzMLServiceVMSize.md) +Returns supported VM Sizes in a location + +### [Get-AzMLWorkspace](Get-AzMLWorkspace.md) +Gets the properties of the specified machine learning workspace. + +### [Get-AzMLWorkspaceBatchDeployment](Get-AzMLWorkspaceBatchDeployment.md) +Gets a batch inference deployment by id. + +### [Get-AzMLWorkspaceBatchEndpoint](Get-AzMLWorkspaceBatchEndpoint.md) +Gets a batch inference endpoint by name. + +### [Get-AzMLWorkspaceCodeVersion](Get-AzMLWorkspaceCodeVersion.md) +Get version. + +### [Get-AzMLWorkspaceComponentContainer](Get-AzMLWorkspaceComponentContainer.md) +Get container. + +### [Get-AzMLWorkspaceComponentVersion](Get-AzMLWorkspaceComponentVersion.md) +Get version. + +### [Get-AzMLWorkspaceCompute](Get-AzMLWorkspaceCompute.md) +Gets compute definition by its name. +Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them. + +### [Get-AzMLWorkspaceComputeKey](Get-AzMLWorkspaceComputeKey.md) +Gets secrets related to Machine Learning compute (storage keys, service credentials, etc). + +### [Get-AzMLWorkspaceComputeNode](Get-AzMLWorkspaceComputeNode.md) +Get the details (e.g IP address, port etc) of all the compute nodes in the compute. + +### [Get-AzMLWorkspaceConnection](Get-AzMLWorkspaceConnection.md) + + +### [Get-AzMLWorkspaceDataContainer](Get-AzMLWorkspaceDataContainer.md) +Get container. + +### [Get-AzMLWorkspaceDatastore](Get-AzMLWorkspaceDatastore.md) +Get datastore. + +### [Get-AzMLWorkspaceDatastoreSecret](Get-AzMLWorkspaceDatastoreSecret.md) +Get datastore secrets. + +### [Get-AzMLWorkspaceDataVersion](Get-AzMLWorkspaceDataVersion.md) +Get version. + +### [Get-AzMLWorkspaceEnvironmentContainer](Get-AzMLWorkspaceEnvironmentContainer.md) +Get container. + +### [Get-AzMLWorkspaceEnvironmentVersion](Get-AzMLWorkspaceEnvironmentVersion.md) +Get version. + +### [Get-AzMLWorkspaceFeature](Get-AzMLWorkspaceFeature.md) +Lists all enabled features for a workspace + +### [Get-AzMLWorkspaceJob](Get-AzMLWorkspaceJob.md) +Gets a Job by name/id. + +### [Get-AzMLWorkspaceKey](Get-AzMLWorkspaceKey.md) +Lists all the keys associated with this workspace. +This includes keys for the storage account, app insights and password for container registry + +### [Get-AzMLWorkspaceModelContainer](Get-AzMLWorkspaceModelContainer.md) +Get container. + +### [Get-AzMLWorkspaceModelVersion](Get-AzMLWorkspaceModelVersion.md) +Get version. + +### [Get-AzMLWorkspaceNotebookAccessToken](Get-AzMLWorkspaceNotebookAccessToken.md) +return notebook access token and refresh token + +### [Get-AzMLWorkspaceNotebookKey](Get-AzMLWorkspaceNotebookKey.md) +List keys of a notebook. + +### [Get-AzMLWorkspaceOnlineDeployment](Get-AzMLWorkspaceOnlineDeployment.md) +Get Inference Deployment Deployment. + +### [Get-AzMLWorkspaceOnlineDeploymentLog](Get-AzMLWorkspaceOnlineDeploymentLog.md) +Polls an Endpoint operation. + +### [Get-AzMLWorkspaceOnlineDeploymentSku](Get-AzMLWorkspaceOnlineDeploymentSku.md) +List Inference Endpoint Deployment Skus. + +### [Get-AzMLWorkspaceOnlineEndpoint](Get-AzMLWorkspaceOnlineEndpoint.md) +Get Online Endpoint. + +### [Get-AzMLWorkspaceOnlineEndpointKey](Get-AzMLWorkspaceOnlineEndpointKey.md) +List EndpointAuthKeys for an Endpoint using Key-based authentication. + +### [Get-AzMLWorkspaceOnlineEndpointToken](Get-AzMLWorkspaceOnlineEndpointToken.md) +Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication. + +### [Get-AzMLWorkspaceOutboundNetworkDependencyEndpoint](Get-AzMLWorkspaceOutboundNetworkDependencyEndpoint.md) +Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically. + +### [Get-AzMLWorkspaceStorageAccountKey](Get-AzMLWorkspaceStorageAccountKey.md) +List storage account keys of a workspace. + +### [Invoke-AzMLWorkspaceDiagnose](Invoke-AzMLWorkspaceDiagnose.md) +Diagnose workspace setup issue. + +### [Invoke-AzMLWorkspaceNotebook](Invoke-AzMLWorkspaceNotebook.md) +Prepare a notebook. + +### [New-AzMLWorkspace](New-AzMLWorkspace.md) +Creates or updates a workspace with the specified parameters. + +### [New-AzMLWorkspaceAksObject](New-AzMLWorkspaceAksObject.md) +Create an in-memory object for Aks. + +### [New-AzMLWorkspaceAmlComputeObject](New-AzMLWorkspaceAmlComputeObject.md) +Create an in-memory object for AmlCompute. + +### [New-AzMLWorkspaceBatchDeployment](New-AzMLWorkspaceBatchDeployment.md) +Creates/updates a batch inference deployment (asynchronous). + +### [New-AzMLWorkspaceBatchEndpoint](New-AzMLWorkspaceBatchEndpoint.md) +Creates a batch inference endpoint (asynchronous). + +### [New-AzMLWorkspaceCodeVersion](New-AzMLWorkspaceCodeVersion.md) +Create or update version. + +### [New-AzMLWorkspaceCommandJobObject](New-AzMLWorkspaceCommandJobObject.md) +Create an in-memory object for CommandJob. + +### [New-AzMLWorkspaceComponentContainer](New-AzMLWorkspaceComponentContainer.md) +Create or update container. + +### [New-AzMLWorkspaceComponentVersion](New-AzMLWorkspaceComponentVersion.md) +Create or update version. + +### [New-AzMLWorkspaceCompute](New-AzMLWorkspaceCompute.md) +Creates or updates compute. +This call will overwrite a compute if it exists. +This is a nonrecoverable operation. +If your intent is to create a new compute, do a GET first to verify that it does not exist yet. + +### [New-AzMLWorkspaceComputeInstanceObject](New-AzMLWorkspaceComputeInstanceObject.md) +Create an in-memory object for ComputeInstance. + +### [New-AzMLWorkspaceComputeStartStopScheduleObject](New-AzMLWorkspaceComputeStartStopScheduleObject.md) +Create an in-memory object for ComputeStartStopSchedule. + +### [New-AzMLWorkspaceConnection](New-AzMLWorkspaceConnection.md) + + +### [New-AzMLWorkspaceCustomModelJobInputObject](New-AzMLWorkspaceCustomModelJobInputObject.md) +Create an in-memory object for CustomModelJobInput. + +### [New-AzMLWorkspaceCustomModelJobOutputObject](New-AzMLWorkspaceCustomModelJobOutputObject.md) +Create an in-memory object for CustomModelJobOutput. + +### [New-AzMLWorkspaceDatabricksObject](New-AzMLWorkspaceDatabricksObject.md) +Create an in-memory object for Databricks. + +### [New-AzMLWorkspaceDataContainer](New-AzMLWorkspaceDataContainer.md) +Create or update container. + +### [New-AzMLWorkspaceDataFactoryObject](New-AzMLWorkspaceDataFactoryObject.md) +Create an in-memory object for DataFactory. + +### [New-AzMLWorkspaceDataLakeAnalyticsObject](New-AzMLWorkspaceDataLakeAnalyticsObject.md) +Create an in-memory object for DataLakeAnalytics. + +### [New-AzMLWorkspaceDatastore](New-AzMLWorkspaceDatastore.md) +Create or update datastore. + +### [New-AzMLWorkspaceDatastoreBlobObject](New-AzMLWorkspaceDatastoreBlobObject.md) +Create an in-memory object for AzureBlobDatastore. + +### [New-AzMLWorkspaceDatastoreCredentialObject](New-AzMLWorkspaceDatastoreCredentialObject.md) +Create an in-memory object for CertificateDatastoreCredentials. + +### [New-AzMLWorkspaceDatastoreDataLakeGen1Object](New-AzMLWorkspaceDatastoreDataLakeGen1Object.md) +Create an in-memory object for AzureDataLakeGen1Datastore. + +### [New-AzMLWorkspaceDatastoreDataLakeGen2Object](New-AzMLWorkspaceDatastoreDataLakeGen2Object.md) +Create an in-memory object for AzureDataLakeGen2Datastore. + +### [New-AzMLWorkspaceDatastoreFileObject](New-AzMLWorkspaceDatastoreFileObject.md) +Create an in-memory object for AzureFileDatastore. + +### [New-AzMLWorkspaceDatastoreKeyCredentialObject](New-AzMLWorkspaceDatastoreKeyCredentialObject.md) +Create an in-memory object for AccountKeyDatastoreCredentials. + +### [New-AzMLWorkspaceDatastoreNoneCredentialObject](New-AzMLWorkspaceDatastoreNoneCredentialObject.md) +Create an in-memory object for NoneDatastoreCredentials. + +### [New-AzMLWorkspaceDatastoreSasCredentialObject](New-AzMLWorkspaceDatastoreSasCredentialObject.md) +Create an in-memory object for SasDatastoreCredentials. + +### [New-AzMLWorkspaceDatastoreServicePrincipalCredentialObject](New-AzMLWorkspaceDatastoreServicePrincipalCredentialObject.md) +Create an in-memory object for ServicePrincipalDatastoreCredentials. + +### [New-AzMLWorkspaceDataVersion](New-AzMLWorkspaceDataVersion.md) +Create or update version. + +### [New-AzMLWorkspaceEnvironmentVersion](New-AzMLWorkspaceEnvironmentVersion.md) +Creates or updates an EnvironmentVersion. + +### [New-AzMLWorkspaceHDInsightObject](New-AzMLWorkspaceHDInsightObject.md) +Create an in-memory object for HDInsight. + +### [New-AzMLWorkspaceJob](New-AzMLWorkspaceJob.md) +Creates and executes a Job. + +### [New-AzMLWorkspaceJobServiceObject](New-AzMLWorkspaceJobServiceObject.md) +Create an in-memory object for JobService. + +### [New-AzMLWorkspaceKubernetesObject](New-AzMLWorkspaceKubernetesObject.md) +Create an in-memory object for Kubernetes. + +### [New-AzMLWorkspaceLiteralJobInputObject](New-AzMLWorkspaceLiteralJobInputObject.md) +Create an in-memory object for LiteralJobInput. + +### [New-AzMLWorkspaceMLFlowModelJobInputObject](New-AzMLWorkspaceMLFlowModelJobInputObject.md) +Create an in-memory object for MLFlowModelJobInput. + +### [New-AzMLWorkspaceMLFlowModelJobOutputObject](New-AzMLWorkspaceMLFlowModelJobOutputObject.md) +Create an in-memory object for MLFlowModelJobOutput. + +### [New-AzMLWorkspaceMLTableJobInputObject](New-AzMLWorkspaceMLTableJobInputObject.md) +Create an in-memory object for MLTableJobInput. + +### [New-AzMLWorkspaceMLTableJobOutputObject](New-AzMLWorkspaceMLTableJobOutputObject.md) +Create an in-memory object for MLTableJobOutput. + +### [New-AzMLWorkspaceModelContainer](New-AzMLWorkspaceModelContainer.md) +Create or update container. + +### [New-AzMLWorkspaceModelVersion](New-AzMLWorkspaceModelVersion.md) +Create or update version. + +### [New-AzMLWorkspaceOnlineDeployment](New-AzMLWorkspaceOnlineDeployment.md) +Create or update Inference Endpoint Deployment (asynchronous). + +### [New-AzMLWorkspaceOnlineEndpoint](New-AzMLWorkspaceOnlineEndpoint.md) +Create or update Online Endpoint (asynchronous). + +### [New-AzMLWorkspaceOnlineEndpointKey](New-AzMLWorkspaceOnlineEndpointKey.md) +Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous). + +### [New-AzMLWorkspacePipelineJobObject](New-AzMLWorkspacePipelineJobObject.md) +Create an in-memory object for PipelineJob. + +### [New-AzMLWorkspaceQuotaPropertiesObject](New-AzMLWorkspaceQuotaPropertiesObject.md) +Create an in-memory object for QuotaBaseProperties. + +### [New-AzMLWorkspaceSharedPrivateLinkResourceObject](New-AzMLWorkspaceSharedPrivateLinkResourceObject.md) +Create an in-memory object for SharedPrivateLinkResource. + +### [New-AzMLWorkspaceSweepJobObject](New-AzMLWorkspaceSweepJobObject.md) +Create an in-memory object for SweepJob. + +### [New-AzMLWorkspaceSynapseSparkObject](New-AzMLWorkspaceSynapseSparkObject.md) +Create an in-memory object for SynapseSpark. + +### [New-AzMLWorkspaceTritonModelJobInputObject](New-AzMLWorkspaceTritonModelJobInputObject.md) +Create an in-memory object for TritonModelJobInput. + +### [New-AzMLWorkspaceTritonModelJobOutputObject](New-AzMLWorkspaceTritonModelJobOutputObject.md) +Create an in-memory object for TritonModelJobOutput. + +### [New-AzMLWorkspaceUriFileJobInputObject](New-AzMLWorkspaceUriFileJobInputObject.md) +Create an in-memory object for UriFileJobInput. + +### [New-AzMLWorkspaceUriFileJobOutputObject](New-AzMLWorkspaceUriFileJobOutputObject.md) +Create an in-memory object for UriFileJobOutput. + +### [New-AzMLWorkspaceUriFolderJobInputObject](New-AzMLWorkspaceUriFolderJobInputObject.md) +Create an in-memory object for UriFolderJobInput. + +### [New-AzMLWorkspaceUriFolderJobOutputObject](New-AzMLWorkspaceUriFolderJobOutputObject.md) +Create an in-memory object for UriFolderJobOutput. + +### [New-AzMLWorkspaceVirtualMachineObject](New-AzMLWorkspaceVirtualMachineObject.md) +Create an in-memory object for VirtualMachine. + +### [Remove-AzMLWorkspace](Remove-AzMLWorkspace.md) +Deletes a machine learning workspace. + +### [Remove-AzMLWorkspaceBatchDeployment](Remove-AzMLWorkspaceBatchDeployment.md) +Delete Batch Inference deployment (asynchronous). + +### [Remove-AzMLWorkspaceBatchEndpoint](Remove-AzMLWorkspaceBatchEndpoint.md) +Delete Batch Inference Endpoint (asynchronous). + +### [Remove-AzMLWorkspaceCodeVersion](Remove-AzMLWorkspaceCodeVersion.md) +Delete version. + +### [Remove-AzMLWorkspaceComponentContainer](Remove-AzMLWorkspaceComponentContainer.md) +Delete container. + +### [Remove-AzMLWorkspaceComponentVersion](Remove-AzMLWorkspaceComponentVersion.md) +Delete version. + +### [Remove-AzMLWorkspaceCompute](Remove-AzMLWorkspaceCompute.md) +Deletes specified Machine Learning compute. + +### [Remove-AzMLWorkspaceConnection](Remove-AzMLWorkspaceConnection.md) + + +### [Remove-AzMLWorkspaceDataContainer](Remove-AzMLWorkspaceDataContainer.md) +Delete container. + +### [Remove-AzMLWorkspaceDatastore](Remove-AzMLWorkspaceDatastore.md) +Delete datastore. + +### [Remove-AzMLWorkspaceDataVersion](Remove-AzMLWorkspaceDataVersion.md) +Delete version. + +### [Remove-AzMLWorkspaceEnvironmentContainer](Remove-AzMLWorkspaceEnvironmentContainer.md) +Delete container. + +### [Remove-AzMLWorkspaceEnvironmentVersion](Remove-AzMLWorkspaceEnvironmentVersion.md) +Delete version. + +### [Remove-AzMLWorkspaceJob](Remove-AzMLWorkspaceJob.md) +Deletes a Job (asynchronous). + +### [Remove-AzMLWorkspaceModelContainer](Remove-AzMLWorkspaceModelContainer.md) +Delete container. + +### [Remove-AzMLWorkspaceModelVersion](Remove-AzMLWorkspaceModelVersion.md) +Delete version. + +### [Remove-AzMLWorkspaceOnlineDeployment](Remove-AzMLWorkspaceOnlineDeployment.md) +Delete Inference Endpoint Deployment (asynchronous). + +### [Remove-AzMLWorkspaceOnlineEndpoint](Remove-AzMLWorkspaceOnlineEndpoint.md) +Delete Online Endpoint (asynchronous). + +### [Restart-AzMLWorkspaceCompute](Restart-AzMLWorkspaceCompute.md) +Posts a restart action to a compute instance + +### [Start-AzMLWorkspaceCompute](Start-AzMLWorkspaceCompute.md) +Posts a start action to a compute instance + +### [Stop-AzMLWorkspaceCompute](Stop-AzMLWorkspaceCompute.md) +Posts a stop action to a compute instance + +### [Stop-AzMLWorkspaceJob](Stop-AzMLWorkspaceJob.md) +Cancels a Job (asynchronous). + +### [Sync-AzMLWorkspaceKey](Sync-AzMLWorkspaceKey.md) +Resync all the keys associated with this workspace. +This includes keys for the storage account, app insights and password for container registry + +### [Update-AzMLServiceQuota](Update-AzMLServiceQuota.md) +Update quota for each VM family in workspace. + +### [Update-AzMLWorkspace](Update-AzMLWorkspace.md) +Updates a machine learning workspace with the specified parameters. + +### [Update-AzMLWorkspaceBatchDeployment](Update-AzMLWorkspaceBatchDeployment.md) +Update a batch inference deployment (asynchronous). + +### [Update-AzMLWorkspaceBatchEndpoint](Update-AzMLWorkspaceBatchEndpoint.md) +Update a batch inference endpoint (asynchronous). + +### [Update-AzMLWorkspaceCompute](Update-AzMLWorkspaceCompute.md) +Updates properties of a compute. +This call will overwrite a compute if it exists. +This is a nonrecoverable operation. + +### [Update-AzMLWorkspaceOnlineDeployment](Update-AzMLWorkspaceOnlineDeployment.md) +Update Online Deployment (asynchronous). + +### [Update-AzMLWorkspaceOnlineEndpoint](Update-AzMLWorkspaceOnlineEndpoint.md) +Update Online Endpoint (asynchronous). + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLServiceQuota.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLServiceQuota.md new file mode 100644 index 0000000000..e5777e00b1 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLServiceQuota.md @@ -0,0 +1,105 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlservicequota +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLServiceQuota.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLServiceQuota.md +--- + +# Get-AzMLServiceQuota + +## SYNOPSIS +Gets the currently assigned Workspace Quotas based on VMFamily. + +## SYNTAX + +``` +Get-AzMLServiceQuota -Location <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the currently assigned Workspace Quotas based on VMFamily. + +## EXAMPLES + +### Example 1: Gets the currently assigned Workspace Quotas based on VMFamily +```powershell +Get-AzMLServiceQuota -Location eastus +``` + +```output +AmlWorkspaceLocation Limit Unit +-------------------- ----- ---- + 100 Count + 100 Count + 100 Count + 100 Count + 100 Count +``` + +Gets the currently assigned Workspace Quotas based on VMFamily. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location for which resource usage is queried. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceQuota + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLServiceUsage.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLServiceUsage.md new file mode 100644 index 0000000000..fef8fe5ff4 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLServiceUsage.md @@ -0,0 +1,103 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlserviceusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLServiceUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLServiceUsage.md +--- + +# Get-AzMLServiceUsage + +## SYNOPSIS +Gets the current usage information as well as limits for AML resources for given subscription and location. + +## SYNTAX + +``` +Get-AzMLServiceUsage -Location <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the current usage information as well as limits for AML resources for given subscription and location. + +## EXAMPLES + +### Example 1: Gets the current usage information as well as limits for AML resources for given subscription and location +```powershell +Get-AzMLServiceUsage -Location eastus +``` + +```output +AmlWorkspaceLocation CurrentValue Limit Unit +-------------------- ------------ ----- ---- + 9 200 Count + 8 100 Count + 0 100 Count +``` + +Gets the current usage information as well as limits for AML resources for given subscription and location. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location for which resource usage is queried. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IUsage + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLServiceVMSize.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLServiceVMSize.md new file mode 100644 index 0000000000..ed58209abf --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLServiceVMSize.md @@ -0,0 +1,105 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlservicevmsize +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLServiceVMSize.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLServiceVMSize.md +--- + +# Get-AzMLServiceVMSize + +## SYNOPSIS +Returns supported VM Sizes in a location + +## SYNTAX + +``` +Get-AzMLServiceVMSize -Location <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns supported VM Sizes in a location + +## EXAMPLES + +### Example 1: Returns supported VM Sizes in a location +```powershell +Get-AzMLServiceVMSize -Location eastus +``` + +```output +Family Gpu LowPriorityCapable MaxResourceVolumeMb MemoryGb Name OSVhdSizeMb PremiumIo SupportedComputeType VCpUs +------ --- ------------------ ------------------- -------- ---- ----------- --------- -------------------- ----- +standardDFamily 0 True 51200 3.5 Standard_D1 1047552 False {AmlCompute} 1 +standardDFamily 0 True 102400 14 Standard_D11 1047552 False {AmlCompute} 2 +standardDv2Family 0 True 102400 14 Standard_D11_v2 1047552 False {AmlCompute, ComputeInstance} 2 +standardDFamily 0 True 204800 28 Standard_D12 1047552 False {AmlCompute} 4 +standardDv2Family 0 True 204800 28 Standard_D12_v2 1047552 False {AmlCompute, ComputeInstance} 4 +``` + +Returns supported VM Sizes in a location. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location upon which virtual-machine-sizes is queried. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IVirtualMachineSize + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspace.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspace.md new file mode 100644 index 0000000000..202028c3ae --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspace.md @@ -0,0 +1,219 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspace.md +--- + +# Get-AzMLWorkspace + +## SYNOPSIS +Gets the properties of the specified machine learning workspace. + +## SYNTAX + +### List1 (Default) +``` +Get-AzMLWorkspace [-SubscriptionId <String[]>] [-Skip <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspace -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzMLWorkspace -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Skip <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the properties of the specified machine learning workspace. + +## EXAMPLES + +### Example 1: List the properties of the specified machine learning workspace under a subscription +```powershell +Get-AzMLWorkspace +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Location ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- -------- ----------------- +mlworkspace-portal01 5/5/2022 1:27:26 AM v-diya@microsoft.com User 5/5/2022 1:27:26 AM v-diya@microsoft.com User eastus ml-rg-test +mlworkspace-cli01 5/18/2022 6:33:49 AM v-diya@microsoft.com User 5/18/2022 6:33:49 AM v-diya@microsoft.com User eastus ml-rg-test +mlworkspace-demo 5/25/2022 3:06:22 AM v-diya@microsoft.com User 5/25/2022 3:06:22 AM v-diya@microsoft.com User eastus ml-rg-test +``` + +List the properties of the specified machine learning workspace under a subscription. + +### Example 2: List the properties of the specified machine learning workspace under a resource group +```powershell +Get-AzMLWorkspace -ResourceGroupName ml-rg-test +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Location ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- -------- ----------------- +mlworkspace-portal01 5/5/2022 1:27:26 AM v-diya@microsoft.com User 5/5/2022 1:27:26 AM v-diya@microsoft.com User eastus ml-rg-test +mlworkspace-cli01 5/18/2022 6:33:49 AM v-diya@microsoft.com User 5/18/2022 6:33:49 AM v-diya@microsoft.com User eastus ml-rg-test +mlworkspace-demo 5/25/2022 3:06:22 AM v-diya@microsoft.com User 5/25/2022 3:06:22 AM v-diya@microsoft.com User eastus ml-rg-test +``` + +List the properties of the specified machine learning workspace under a resource group. + +### Example 3: Gets the properties of the specified machine learning workspace +```powershell +Get-AzMLWorkspace -ResourceGroupName ml-rg-test -Name mlworkspace-cli01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Location ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- -------- ----------------- +mlworkspace-cli01 5/18/2022 6:33:49 AM v-diya@microsoft.com User 5/18/2022 6:33:49 AM v-diya@microsoft.com User eastus ml-rg-test +``` + +Gets the properties of the specified machine learning workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IWorkspace + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceBatchDeployment.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceBatchDeployment.md new file mode 100644 index 0000000000..3901cc6140 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceBatchDeployment.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacebatchdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceBatchDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceBatchDeployment.md +--- + +# Get-AzMLWorkspaceBatchDeployment + +## SYNOPSIS +Gets a batch inference deployment by id. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceBatchDeployment -EndpointName <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-OrderBy <String>] [-Skip <String>] [-Top <Int32>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceBatchDeployment -EndpointName <String> -Name <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceBatchDeployment -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a batch inference deployment by id. + +## EXAMPLES + +### Example 1: Lists all batch inference deployment under a batch endpoint +```powershell +Get-AzMLWorkspaceBatchDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName batch-cli02 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus nonmlflowdp 6/1/2022 6:19:16 AM Lucas Yao (Wicresoft North America) 6/1/2022 6:19:16 AM ml-rg-test +``` + +Lists all batch inference deployment under a batch endpoint + +### Example 2: Gets a batch inference deployment by Name +```powershell +Get-AzMLWorkspaceBatchDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName batch-cli02 -Name nonmlflowdp +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus nonmlflowdp 6/1/2022 6:19:16 AM Lucas Yao (Wicresoft North America) 6/1/2022 6:19:16 AM ml-rg-test +``` + +Gets a batch inference deployment by Name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Endpoint name + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The identifier for the Batch deployments. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderBy +Ordering of list. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Top of list. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IBatchDeployment + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceBatchEndpoint.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceBatchEndpoint.md new file mode 100644 index 0000000000..a6b06d9fc7 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceBatchEndpoint.md @@ -0,0 +1,229 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacebatchendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceBatchEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceBatchEndpoint.md +--- + +# Get-AzMLWorkspaceBatchEndpoint + +## SYNOPSIS +Gets a batch inference endpoint by name. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceBatchEndpoint -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-Count <Int32>] [-Skip <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceBatchEndpoint -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceBatchEndpoint -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a batch inference endpoint by name. + +## EXAMPLES + +### Example 1: Lists all batch inference endpoint under workspace +```powershell +Get-AzMLWorkspaceBatchEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 +``` + +```output +ocation Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus batch-pwsh03 5/20/2022 7:21:12 AM Lucas Yao (Wicresoft North America) 5/20/2022 7:31:17 AM ml-rg-test +eastus batch-pwsh02 5/20/2022 7:17:33 AM Lucas Yao (Wicresoft North America) 5/20/2022 7:20:02 AM ml-rg-test +eastus batch-cli01 5/20/2022 7:11:11 AM Lucas Yao (Wicresoft North America) 5/20/2022 7:11:32 AM ml-rg-test +``` + +Lists all batch inference endpoint under workspace + +### Example 2: Gets a batch inference endpoint by name +```powershell +Get-AzMLWorkspaceBatchEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name batch-pwsh03 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus batch-pwsh03 5/20/2022 7:21:12 AM Lucas Yao (Wicresoft North America) 5/20/2022 7:31:17 AM ml-rg-test +``` + +Gets a batch inference endpoint by name + +## PARAMETERS + +### -Count +Number of endpoints to be retrieved in a page of results. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name for the Batch Endpoint. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IBatchEndpoint + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceCodeVersion.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceCodeVersion.md new file mode 100644 index 0000000000..1553396d86 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceCodeVersion.md @@ -0,0 +1,194 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacecodeversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceCodeVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceCodeVersion.md +--- + +# Get-AzMLWorkspaceCodeVersion + +## SYNOPSIS +Get version. + +## SYNTAX + +### Get (Default) +``` +Get-AzMLWorkspaceCodeVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceCodeVersion -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get version. + +## EXAMPLES + +### Example 1: Gets code version +```powershell +Get-AzMLWorkspaceCodeVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name 'codepwsh01' -Version 1 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +1 5/24/2022 7:14:05 AM Lucas Yao (Wicresoft North America) User 5/24/2022 7:14:05 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Gets code version. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ICodeVersion + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceComponentContainer.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceComponentContainer.md new file mode 100644 index 0000000000..7900f36c2d --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceComponentContainer.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacecomponentcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceComponentContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceComponentContainer.md +--- + +# Get-AzMLWorkspaceComponentContainer + +## SYNOPSIS +Get container. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceComponentContainer -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-ListViewType <ListViewType>] [-Skip <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceComponentContainer -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceComponentContainer -InputObject <IMachineLearningServicesIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get container. + +## EXAMPLES + +### Example 1: Lists all component containers under a workspace +```powershell +Get-AzMLWorkspaceComponentContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +train_data_component 5/24/2022 7:23:25 AM Lucas Yao (Wicresoft North America) User 5/24/2022 7:23:25 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Lists all containers under a workspace + +### Example 2: Get a component container by name +```powershell +Get-AzMLWorkspaceComponentContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name train_data_component +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +train_data_component 5/24/2022 7:23:25 AM 5/24/2022 7:23:25 AM ml-rg-test +``` + +Get a component container by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ListViewType +View type for including/excluding (for example) archived entities. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ListViewType +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IComponentContainer + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceComponentVersion.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceComponentVersion.md new file mode 100644 index 0000000000..0d9a834a83 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceComponentVersion.md @@ -0,0 +1,272 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacecomponentversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceComponentVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceComponentVersion.md +--- + +# Get-AzMLWorkspaceComponentVersion + +## SYNOPSIS +Get version. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceComponentVersion -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-ListViewType <ListViewType>] [-OrderBy <String>] [-Skip <String>] + [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceComponentVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceComponentVersion -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get version. + +## EXAMPLES + +### Example 1: Lists all component versions +```powershell +Get-AzMLWorkspaceComponentVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name train_data_component +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +1 5/24/2022 7:23:25 AM Lucas Yao (Wicresoft North America) User 5/24/2022 7:23:25 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Lists all component versions + +### Example 2: Gets a component versions +```powershell +Get-AzMLWorkspaceComponentVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name train_data_component -Version 1 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +1 5/24/2022 7:23:25 AM Lucas Yao (Wicresoft North America) User 5/24/2022 7:23:25 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Gets a component versions + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ListViewType +View type for including/excluding (for example) archived entities. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ListViewType +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderBy +Ordering of list. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Maximum number of records to return. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IComponentVersion + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceCompute.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceCompute.md new file mode 100644 index 0000000000..77722d03e3 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceCompute.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacecompute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceCompute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceCompute.md +--- + +# Get-AzMLWorkspaceCompute + +## SYNOPSIS +Gets compute definition by its name. +Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceCompute -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-Skip <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceCompute -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceCompute -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets compute definition by its name. +Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them. + +## EXAMPLES + +### Example 1: Lists all computes under a workspace +```powershell +Get-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Location ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- -------- ----------------- +cpu-cluster eastus ml-rg-test +gpu-cluster eastus ml-rg-test +batch-cluster eastus ml-rg-test +``` + +Lists all computes under a workspace + +### Example 2: Gets a compute by name +```powershell +Get-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name cpu-cluster +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Location ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- -------- ----------------- +cpu-cluster eastus ml-rg-test +``` + +Gets a compute by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ComputeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IComputeResource + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceComputeKey.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceComputeKey.md new file mode 100644 index 0000000000..f033f4e426 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceComputeKey.md @@ -0,0 +1,157 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacecomputekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceComputeKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceComputeKey.md +--- + +# Get-AzMLWorkspaceComputeKey + +## SYNOPSIS +Gets secrets related to Machine Learning compute (storage keys, service credentials, etc). + +## SYNTAX + +``` +Get-AzMLWorkspaceComputeKey -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Gets secrets related to Machine Learning compute (storage keys, service credentials, etc). + +## EXAMPLES + +### Example 1: Gets secrets related to Machine Learning compute (storage keys, service credentials, etc) +```powershell +Get-AzMLWorkspaceComputeKey -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name cpu-cluster +``` + +Gets secrets related to Machine Learning compute (storage keys, service credentials, etc) + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ComputeType + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceComputeNode.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceComputeNode.md new file mode 100644 index 0000000000..5cb8a1fd9c --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceComputeNode.md @@ -0,0 +1,157 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacecomputenode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceComputeNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceComputeNode.md +--- + +# Get-AzMLWorkspaceComputeNode + +## SYNOPSIS +Get the details (e.g IP address, port etc) of all the compute nodes in the compute. + +## SYNTAX + +``` +Get-AzMLWorkspaceComputeNode -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Get the details (e.g IP address, port etc) of all the compute nodes in the compute. + +## EXAMPLES + +### Example 1: Get the details (e.g IP address, port etc) of all the compute nodes in the compute +```powershell +Get-AzMLWorkspaceComputeNode -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name cpu-cluster +``` + +Get the details (e.g IP address, port etc) of all the compute nodes in the compute + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IAmlComputeNodeInformation + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceConnection.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceConnection.md new file mode 100644 index 0000000000..182da10f30 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceConnection.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspaceconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceConnection.md +--- + +# Get-AzMLWorkspaceConnection + +## SYNOPSIS +Get the connection of the specified machine learning workspace. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceConnection -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-Category <String>] [-Target <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceConnection -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceConnection -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the connection of the specified machine learning workspace. + +## EXAMPLES + +### Example 1: Lists all connection under a workspace +```powershell +Get-AzMLWorkspaceConnection -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +test ml-rg-test +``` + +Lists all connection under a workspace + +### Example 2: Gets a connection by name +```powershell +Get-AzMLWorkspaceConnection -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name test +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +test ml-rg-test +``` + +Gets a connection by name + +## PARAMETERS + +### -Category +Category of the workspace connection. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Friendly name of the workspace connection + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Target +Target of the workspace connection. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IWorkspaceConnectionPropertiesV2BasicResource + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceDataContainer.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceDataContainer.md new file mode 100644 index 0000000000..1acdeaa781 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceDataContainer.md @@ -0,0 +1,230 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacedatacontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceDataContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceDataContainer.md +--- + +# Get-AzMLWorkspaceDataContainer + +## SYNOPSIS +Get container. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceDataContainer -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-ListViewType <ListViewType>] [-Skip <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceDataContainer -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceDataContainer -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get container. + +## EXAMPLES + +### Example 1: Lists all data containers under a workspace +```powershell +Get-AzMLWorkspaceDataContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +iris-data 5/5/2022 2:58:50 AM Lucas Yao (Wicresoft North America) User 5/5/2022 2:58:50 AM ml-rg-test +pwshdata01 5/17/2022 7:11:05 AM Lucas Yao (Wicresoft North America) User 5/17/2022 7:11:05 AM ml-rg-test +dtpwsh01 5/24/2022 6:12:06 AM Lucas Yao (Wicresoft North America) User 5/24/2022 6:12:06 AM ml-rg-test +dtpwsh02 5/24/2022 6:21:34 AM Lucas Yao (Wicresoft North America) User 5/24/2022 6:21:35 AM ml-rg-test +``` + +Lists all data containers under a workspace + +### Example 2: Get a data container by name +```powershell +Get-AzMLWorkspaceDataContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name iris-data +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +iris-data 5/5/2022 2:58:50 AM Lucas Yao (Wicresoft North America) User 5/5/2022 2:58:50 AM ml-rg-test +``` + +Get a data container by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ListViewType +View type for including/excluding (for example) archived entities. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ListViewType +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IDataContainer + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceDataVersion.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceDataVersion.md new file mode 100644 index 0000000000..ba31d30b83 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceDataVersion.md @@ -0,0 +1,289 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacedataversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceDataVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceDataVersion.md +--- + +# Get-AzMLWorkspaceDataVersion + +## SYNOPSIS +Get version. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceDataVersion -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-ListViewType <ListViewType>] [-OrderBy <String>] [-Skip <String>] + [-Tag <String>] [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceDataVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceDataVersion -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get version. + +## EXAMPLES + +### Example 1: Lists all data versions +```powershell +Get-AzMLWorkspaceDataVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name iris-data +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +1 5/5/2022 2:58:50 AM Lucas Yao (Wicresoft North America) User 5/5/2022 2:58:50 AM ml-rg-test +``` + +Lists all data versions + +### Example 2: Get a data version +```powershell +Get-AzMLWorkspaceDataVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name iris-data -Version 1 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +1 5/5/2022 2:58:50 AM Lucas Yao (Wicresoft North America) User 5/5/2022 2:58:50 AM ml-rg-test +``` + +Get a data version + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ListViewType +[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ListViewType +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderBy +Please choose OrderBy value from ['createdtime', 'modifiedtime'] + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Comma-separated list of tag names (and optionally values). +Example: tag1,tag2=value2 + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Top count of results, top count cannot be greater than the page size. + If topCount \> page size, results with be default page size count will be returned + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IDataVersionBase + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceDatastore.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceDatastore.md new file mode 100644 index 0000000000..69e6d91e5e --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceDatastore.md @@ -0,0 +1,305 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacedatastore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceDatastore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceDatastore.md +--- + +# Get-AzMLWorkspaceDatastore + +## SYNOPSIS +Get datastore. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceDatastore -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-Count <Int32>] [-IsDefault] [-OrderBy <String>] [-OrderByAsc] [-SearchName <String[]>] + [-SearchText <String>] [-Skip <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceDatastore -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceDatastore -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get datastore. + +## EXAMPLES + +### Example 1: Lists all datastore under a workspace +```powershell +Get-AzMLWorkspaceDatastore -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +workspaceartifactstore 5/5/2022 1:27:41 AM 779301c0-18b2-4cdc-801b-a0a3368fee0a Application 5/5/2022 1:27:42 AM 779301c0-18b2-4cdc-801b-a0a3368fee0a Application ml-rg-test +workspaceworkingdirectory 5/5/2022 1:27:41 AM 779301c0-18b2-4cdc-801b-a0a3368fee0a Application 5/5/2022 1:27:42 AM 779301c0-18b2-4cdc-801b-a0a3368fee0a Application ml-rg-test +workspaceblobstore 5/5/2022 1:27:41 AM 779301c0-18b2-4cdc-801b-a0a3368fee0a Application 5/5/2022 1:27:42 AM 779301c0-18b2-4cdc-801b-a0a3368fee0a Application ml-rg-test +workspacefilestore 5/5/2022 1:27:41 AM 779301c0-18b2-4cdc-801b-a0a3368fee0a Application 5/5/2022 1:27:42 AM 779301c0-18b2-4cdc-801b-a0a3368fee0a Application ml-rg-test +``` + +Lists all datastore under a workspace + +### Example 2: Get a datastore by name +```powershell +Get-AzMLWorkspaceDatastore -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name workspaceartifactstore +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +workspaceartifactstore 5/5/2022 1:27:41 AM 779301c0-18b2-4cdc-801b-a0a3368fee0a Application 5/5/2022 1:27:42 AM 779301c0-18b2-4cdc-801b-a0a3368fee0a Application ml-rg-test +``` + +Get a datastore by name + +## PARAMETERS + +### -Count +Maximum number of results to return. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsDefault +Filter down to the workspace default datastore. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Datastore name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderBy +Order by property (createdtime | modifiedtime | name). + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderByAsc +Order by property in ascending order. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchName +Names of datastores to return. + +```yaml +Type: System.String[] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchText +Text to search for in the datastore names. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceDatastoreSecret.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceDatastoreSecret.md new file mode 100644 index 0000000000..6316d4e54b --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceDatastoreSecret.md @@ -0,0 +1,163 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacedatastoresecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceDatastoreSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceDatastoreSecret.md +--- + +# Get-AzMLWorkspaceDatastoreSecret + +## SYNOPSIS +Get datastore secrets. + +## SYNTAX + +``` +Get-AzMLWorkspaceDatastoreSecret -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Get datastore secrets. + +## EXAMPLES + +### Example 1: Get datastore secrets +```powershell +Get-AzMLWorkspaceDatastoreSecret -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name workspaceartifactstore +``` + +```output +SecretsType Key +----------- --- +AccountKey xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +Get datastore secrets. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Datastore name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.SecretsType + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceEnvironmentContainer.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceEnvironmentContainer.md new file mode 100644 index 0000000000..428c9a3796 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceEnvironmentContainer.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspaceenvironmentcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceEnvironmentContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceEnvironmentContainer.md +--- + +# Get-AzMLWorkspaceEnvironmentContainer + +## SYNOPSIS +Get container. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceEnvironmentContainer -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-ListViewType <ListViewType>] [-Skip <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceEnvironmentContainer -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceEnvironmentContainer -InputObject <IMachineLearningServicesIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get container. + +## EXAMPLES + +### Example 1: List all environment containers under a workspace +```powershell +Get-AzMLWorkspaceEnvironmentContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +pwshenv01 5/11/2022 2:31:25 AM Lucas Yao (Wicresoft North America) User 5/11/2022 2:31:25 AM Lucas Yao (Wicresoft North America) User ml-rg-test +lightgbm-environment 5/5/2022 2:25:41 AM Lucas Yao (Wicresoft North America) User 5/5/2022 2:25:41 AM Lucas Yao (Wicresoft North America) User ml-rg-test +env04 5/5/2022 2:13:02 AM Lucas Yao (Wicresoft North America) User 5/5/2022 2:13:02 AM Lucas Yao (Wicresoft North America) User ml-rg-test +env03 5/5/2022 2:11:34 AM Lucas Yao (Wicresoft North America) User 5/5/2022 2:11:34 AM Lucas Yao (Wicresoft North America) User ml-rg-test +env02 5/5/2022 2:11:08 AM Lucas Yao (Wicresoft North America) User 5/5/2022 2:11:08 AM Lucas Yao (Wicresoft North America) User ml-rg-test +env01 5/5/2022 2:10:35 AM Lucas Yao (Wicresoft North America) User 5/5/2022 2:10:35 AM Lucas Yao (Wicresoft North America) User ml-rg-test +docker-image-example 5/5/2022 1:57:13 AM Lucas Yao (Wicresoft North America) User 5/5/2022 1:57:13 AM Lucas Yao (Wicresoft North America) User ml-rg-test +test 5/5/2022 1:51:43 AM Lucas Yao User 5/5/2022 1:51:43 AM Lucas Yao User ml-rg-test +AzureML-responsibleai-0.18-ubuntu20.04-py38-cpu 5/18/2022 11:07:16 PM Microsoft User 5/18/2022 11:07:16 PM Microsoft User ml-rg-test +``` + +List all environment containers under a workspace + +### Example 2: Gets a environment container by name +```powershell +Get-AzMLWorkspaceEnvironmentContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name pwshenv01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +pwshenv01 5/11/2022 2:31:25 AM Lucas Yao (Wicresoft North America) User 5/11/2022 2:31:25 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Gets a environment container by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ListViewType +View type for including/excluding (for example) archived entities. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ListViewType +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IEnvironmentContainer + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceEnvironmentVersion.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceEnvironmentVersion.md new file mode 100644 index 0000000000..c3d39339b4 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceEnvironmentVersion.md @@ -0,0 +1,274 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspaceenvironmentversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceEnvironmentVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceEnvironmentVersion.md +--- + +# Get-AzMLWorkspaceEnvironmentVersion + +## SYNOPSIS +Get version. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceEnvironmentVersion -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-ListViewType <ListViewType>] [-OrderBy <String>] [-Skip <String>] + [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceEnvironmentVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceEnvironmentVersion -InputObject <IMachineLearningServicesIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get version. + +## EXAMPLES + +### Example 1: Lists all environment versions +```powershell +Get-AzMLWorkspaceEnvironmentVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name pwshenv01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +1 5/11/2022 2:31:25 AM Lucas Yao (Wicresoft North America) User 5/11/2022 2:31:25 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Lists all environment versions + +### Example 2: Get a environment version +```powershell +Get-AzMLWorkspaceEnvironmentVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name pwshenv01 -Version 1 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +1 5/11/2022 2:31:25 AM Lucas Yao (Wicresoft North America) User 5/11/2022 2:31:25 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Get a environment version + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ListViewType +View type for including/excluding (for example) archived entities. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ListViewType +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderBy +Ordering of list. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Maximum number of records to return. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IEnvironmentVersion + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceFeature.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceFeature.md new file mode 100644 index 0000000000..8a4e499b76 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceFeature.md @@ -0,0 +1,125 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacefeature +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceFeature.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceFeature.md +--- + +# Get-AzMLWorkspaceFeature + +## SYNOPSIS +Lists all enabled features for a workspace + +## SYNTAX + +``` +Get-AzMLWorkspaceFeature -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all enabled features for a workspace + +## EXAMPLES + +### Example 1: Lists all enabled features for a workspace +```powershell +Get-AzMLWorkspaceFeature -ResourceGroupName ml-rg-test -Name mlworkspace-portal01 +``` + +```output +Description DisplayName +----------- ----------- +Raw feature explanation for AutoML models Model Explanability +Create, edit or delete AutoML experiments in the SDK Create edit experiments SDK +Create, edit or delete HyperDrive experiments in the SDK Create edit hyperdrive SDK +Select or upload a dataset to train on from datasets in the SDK Dataset integration from SDK +Deploy an AutoML model from the SDK Deploy model SDK +Auto train a forecasting DNN from SDK DNN Forecasting SDK +Auto train an NLP DNN from SDK DNN NLP SDK +Deploy and view explainability dashboard for inference data Explainability at Inference time SDK +Create and view explainability dashboard in the SDK Explainability dashboard in SDK at training time +``` + +Lists all enabled features for a workspace + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IAmlUserFeature + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceJob.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceJob.md new file mode 100644 index 0000000000..299fb8a1fd --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceJob.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacejob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceJob.md +--- + +# Get-AzMLWorkspaceJob + +## SYNOPSIS +Gets a Job by name/id. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceJob -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-JobType <String>] [-ListViewType <ListViewType>] [-Skip <String>] [-Tag <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceJob -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceJob -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Job by name/id. + +## EXAMPLES + +### Example 1: Lists all jobs under a workspace +```powershell +Get-AzMLWorkspaceJob -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +willing_vinegar_mwjs1dyft0 5/31/2022 7:58:38 AM Lucas Yao (Wicresoft North America) User ml-rg-test +ivory_beard_fsbkdw8n77 5/18/2022 8:03:36 AM Lucas Yao (Wicresoft North America) User ml-rg-test +plucky_collar_5x0ds0fgb3 5/18/2022 7:44:55 AM Lucas Yao (Wicresoft North America) User ml-rg-test +heroic_quince_0vqqqpq7mt 5/18/2022 7:10:35 AM Lucas Yao (Wicresoft North America) User ml-rg-test +amiable_hominy_g700h46sb5 5/18/2022 6:42:32 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Lists all jobs under a workspace + +### Example 2: Gets a Job by name +```powershell +Get-AzMLWorkspaceJob -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name willing_vinegar_mwjs1dyft0 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +willing_vinegar_mwjs1dyft0 5/31/2022 7:58:38 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Gets a Job by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobType +Type of job to be returned. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListViewType +View type for including/excluding (for example) archived entities. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ListViewType +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name and identifier for the Job. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Jobs returned will have this tag key. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IJobBase + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceKey.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceKey.md new file mode 100644 index 0000000000..2eabb274cb --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceKey.md @@ -0,0 +1,150 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceKey.md +--- + +# Get-AzMLWorkspaceKey + +## SYNOPSIS +Lists all the keys associated with this workspace. +This includes keys for the storage account, app insights and password for container registry + +## SYNTAX + +``` +Get-AzMLWorkspaceKey -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all the keys associated with this workspace. +This includes keys for the storage account, app insights and password for container registry + +## EXAMPLES + +### Example 1: Lists all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container regist +```powershell +Get-AzMLWorkspaceKey -ResourceGroupName ml-rg-test -Name mlworkspace-cli01 +``` + +```output +AppInsightsInstrumentationKey UserStorageKey UserStorageResourceId +----------------------------- -------------- --------------------- +xxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +Lists all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container regist + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IListWorkspaceKeysResult + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceModelContainer.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceModelContainer.md new file mode 100644 index 0000000000..adadc4db94 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceModelContainer.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacemodelcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceModelContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceModelContainer.md +--- + +# Get-AzMLWorkspaceModelContainer + +## SYNOPSIS +Get container. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceModelContainer -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-Count <Int32>] [-ListViewType <ListViewType>] [-Skip <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceModelContainer -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceModelContainer -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get container. + +## EXAMPLES + +### Example 1: Lists all model containers under a workspace +```powershell +Get-AzMLWorkspaceModelContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +azureml_plucky_collar_5x0ds0fgb3_output_mlflow_log_model 5/18/2022 7:47:43 AM Lucas Yao (Wicresoft North America) User 5/18/2022 7:47:43 AM Lucas Yao (Wicresoft North America) User ml-rg-test +sklearn-iris-example 5/18/2022 7:57:36 AM Lucas Yao (Wicresoft North America) User 5/18/2022 7:57:36 AM Lucas Yao (Wicresoft North America) User ml-rg-test +azureml_ivory_beard_fsbkdw8n77_output_mlflow_log_model 5/18/2022 8:06:06 AM Lucas Yao (Wicresoft North America) User 5/18/2022 8:06:06 AM Lucas Yao (Wicresoft North America) User ml-rg-test +sklearn-iris-cli 5/18/2022 8:35:26 AM Lucas Yao (Wicresoft North America) User 5/18/2022 8:35:26 AM Lucas Yao (Wicresoft North America) User ml-rg-test +a99089c5-23a6-4431-9ecd-37c70f01c9bc 5/19/2022 2:51:55 AM Lucas Yao (Wicresoft North America) User 5/19/2022 2:51:55 AM Lucas Yao (Wicresoft North America) User ml-rg-test +87ec6e92-9253-4e3a-99f2-415dc3301102 5/20/2022 7:35:06 AM Lucas Yao (Wicresoft North America) User 5/20/2022 7:35:06 AM Lucas Yao (Wicresoft North America) User ml-rg-test +modelcontaonerpwsh01 5/24/2022 9:21:21 AM Lucas Yao (Wicresoft North America) User 5/24/2022 9:21:21 AM Lucas Yao (Wicresoft North America) User ml-rg-test +c9436a28-a25c-4e36-ab9d-43be313629fc 6/1/2022 6:18:34 AM Lucas Yao (Wicresoft North America) User 6/1/2022 6:18:34 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Lists all model containers under a workspace + +### Example 2: Gets a model container by name +```powershell +Get-AzMLWorkspaceModelContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name azureml_plucky_collar_5x0ds0fgb3_output_mlflow_log_model +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +azureml_plucky_collar_5x0ds0fgb3_output_mlflow_log_model 5/18/2022 7:47:43 AM Lucas Yao (Wicresoft North America) User 5/18/2022 7:47:43 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Gets a model container by name + +## PARAMETERS + +### -Count +Maximum number of results to return. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ListViewType +View type for including/excluding (for example) archived entities. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ListViewType +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IModelContainer + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceModelVersion.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceModelVersion.md new file mode 100644 index 0000000000..6708635ee5 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceModelVersion.md @@ -0,0 +1,340 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacemodelversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceModelVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceModelVersion.md +--- + +# Get-AzMLWorkspaceModelVersion + +## SYNOPSIS +Get version. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceModelVersion -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-Version <String>] [-Description <String>] [-Feed <String>] + [-ListViewType <ListViewType>] [-Offset <Int32>] [-OrderBy <String>] [-Property <String>] [-Skip <String>] + [-Tag <String>] [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceModelVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceModelVersion -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get version. + +## EXAMPLES + +### Example 1: Lists all model versions +```powershell +Get-AzMLWorkspaceModelVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name modelcontaonerpwsh01 +``` + +Lists all model versions + +### Example 2: Gets all model versions +```powershell +Get-AzMLWorkspaceModelVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name modelcontaonerpwsh01 -Version 1 +``` + +Gets all model versions + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Model description. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Feed +Name of the feed. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ListViewType +View type for including/excluding (for example) archived entities. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ListViewType +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Offset +Number of initial results to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderBy +Ordering of list. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +Comma-separated list of property names (and optionally values). +Example: prop1,prop2=value2 + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Comma-separated list of tag names (and optionally values). +Example: tag1,tag2=value2 + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Maximum number of records to return. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IModelVersion + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceNotebookAccessToken.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceNotebookAccessToken.md new file mode 100644 index 0000000000..5d9eeb3408 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceNotebookAccessToken.md @@ -0,0 +1,148 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacenotebookaccesstoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceNotebookAccessToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceNotebookAccessToken.md +--- + +# Get-AzMLWorkspaceNotebookAccessToken + +## SYNOPSIS +return notebook access token and refresh token + +## SYNTAX + +``` +Get-AzMLWorkspaceNotebookAccessToken -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +return notebook access token and refresh token + +## EXAMPLES + +### Example 1: return notebook access token and refresh token +```powershell +Get-AzMLWorkspaceNotebookAccessToken -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 +``` + +```output +AccessToken ExpiresIn HostName NotebookResourceId PublicDns RefreshToken Scope TokenType +----------- --------- -------- ------------------ --------- ------------ ----- --------- + Azure Machine Learning 770262087db047c88de12c933e679b88 aznb_identity +``` + +return notebook access token and refresh token + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.INotebookAccessTokenResult + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceNotebookKey.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceNotebookKey.md new file mode 100644 index 0000000000..f868d5ec51 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceNotebookKey.md @@ -0,0 +1,148 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacenotebookkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceNotebookKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceNotebookKey.md +--- + +# Get-AzMLWorkspaceNotebookKey + +## SYNOPSIS +List keys of a notebook. + +## SYNTAX + +``` +Get-AzMLWorkspaceNotebookKey -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List keys of a notebook. + +## EXAMPLES + +### Example 1: List keys of a notebook +```powershell +Get-AzMLWorkspaceNotebookKey -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 +``` + +```output +PrimaryAccessKey SecondaryAccessKey +---------------- ------------------ +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +List keys of a notebook. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IListNotebookKeysResult + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineDeployment.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineDeployment.md new file mode 100644 index 0000000000..48a6cd36dc --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineDeployment.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspaceonlinedeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOnlineDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOnlineDeployment.md +--- + +# Get-AzMLWorkspaceOnlineDeployment + +## SYNOPSIS +Get Inference Deployment Deployment. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceOnlineDeployment -EndpointName <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-OrderBy <String>] [-Skip <String>] [-Top <Int32>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceOnlineDeployment -EndpointName <String> -Name <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceOnlineDeployment -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get Inference Deployment Deployment. + +## EXAMPLES + +### Example 1: Lists all online deployments under a online endpoint +```powershell +Get-AzMLWorkspaceOnlineDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName online-cli01 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus blue 5/19/2022 2:52:06 AM Lucas Yao (Wicresoft North America) 5/19/2022 2:52:06 AM Managed ml-rg-test +``` + +Lists all online deployments under a online endpoint + +### Example 2: Gets online deployment by name +```powershell +Get-AzMLWorkspaceOnlineDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName online-cli01 -Name blue +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus blue 5/19/2022 2:52:06 AM Lucas Yao (Wicresoft North America) 5/19/2022 2:52:06 AM Managed ml-rg-test +``` + +Gets online deployment by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Inference endpoint name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Inference Endpoint Deployment name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderBy +Ordering of list. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Top of list. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IOnlineDeployment + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineDeploymentLog.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineDeploymentLog.md new file mode 100644 index 0000000000..a040049461 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineDeploymentLog.md @@ -0,0 +1,219 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspaceonlinedeploymentlog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOnlineDeploymentLog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOnlineDeploymentLog.md +--- + +# Get-AzMLWorkspaceOnlineDeploymentLog + +## SYNOPSIS +Polls an Endpoint operation. + +## SYNTAX + +``` +Get-AzMLWorkspaceOnlineDeploymentLog -EndpointName <String> -Name <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-ContainerType <ContainerType>] [-Tail <Int32>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Polls an Endpoint operation. + +## EXAMPLES + +### Example 1: Gets online deployment log +```powershell +Get-AzMLWorkspaceOnlineDeploymentLog -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName online-cli01 -Name blue +``` + +```output +Instance status: +SystemSetup: Succeeded +UserContainerImagePull: Succeeded +ModelDownload: Succeeded +UserContainerStart: Succeeded + +Container events: +Kind: Pod, Name: Pulling, Type: Normal, Time: 20220519-03:11:59.750675, Message: Start pulling container image +Kind: Pod, Name: Pulling, Type: Normal, Time: 20220519-03:11:59.843068, Message: Start downloading models +Kind: Pod, Name: Pulled, Type: Normal, Time: 20220519-03:12:54.679466, Message: Container image is pulled successfully +Kind: Pod, Name: Downloaded, Type: Normal, Time: 20220519-03:12:54.679466, Message: Models are downloaded successfully or no model need to download +Kind: Pod, Name: Created, Type: Normal, Time: 20220519-03:12:54.798575, Message: Created container inference-server +Kind: Pod, Name: Started, Type: Normal, Time: 20220519-03:12:54.921722, Message: Started container inference-server +``` + +Gets online deployment log + +## PARAMETERS + +### -ContainerType +The type of container to retrieve logs from. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ContainerType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Inference endpoint name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name and identifier for the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tail +The maximum number of lines to tail. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineDeploymentSku.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineDeploymentSku.md new file mode 100644 index 0000000000..08a1a0f78d --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineDeploymentSku.md @@ -0,0 +1,178 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspaceonlinedeploymentsku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOnlineDeploymentSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOnlineDeploymentSku.md +--- + +# Get-AzMLWorkspaceOnlineDeploymentSku + +## SYNOPSIS +List Inference Endpoint Deployment Skus. + +## SYNTAX + +``` +Get-AzMLWorkspaceOnlineDeploymentSku -EndpointName <String> -Name <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-Count <Int32>] [-Skip <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List Inference Endpoint Deployment Skus. + +## EXAMPLES + +### Example 1: List Inference Endpoint Deployment Skus +```powershell +Get-AzMLWorkspaceOnlineDeploymentSku -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName online-cli01 -Name blue +``` + +```output +ResourceType +------------ +Microsoft.MachineLearning.Services/endpoints/deployments +``` + +List Inference Endpoint Deployment Skus + +## PARAMETERS + +### -Count +Number of Skus to be retrieved in a page of results. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Inference endpoint name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Inference Endpoint Deployment name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```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. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ISkuResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineEndpoint.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineEndpoint.md new file mode 100644 index 0000000000..342778823c --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineEndpoint.md @@ -0,0 +1,292 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspaceonlineendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOnlineEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOnlineEndpoint.md +--- + +# Get-AzMLWorkspaceOnlineEndpoint + +## SYNOPSIS +Get Online Endpoint. + +## SYNTAX + +### List (Default) +``` +Get-AzMLWorkspaceOnlineEndpoint -ResourceGroupName <String> -WorkspaceName <String> [-Name <String>] + [-SubscriptionId <String[]>] [-ComputeType <EndpointComputeType>] [-Count <Int32>] [-OrderBy <OrderString>] + [-Property <String>] [-Skip <String>] [-Tag <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMLWorkspaceOnlineEndpoint -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceOnlineEndpoint -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get Online Endpoint. + +## EXAMPLES + +### Example 1: Lists all online enpoints under a workspace +```powershell +Get-AzMLWorkspaceOnlineEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus online-cli02 5/19/2022 2:49:44 AM Lucas Yao (Wicresoft North America) 5/19/2022 2:50:27 AM Managed ml-rg-test +eastus online-cli01 5/19/2022 2:47:34 AM Lucas Yao (Wicresoft North America) 5/19/2022 2:48:26 AM Managed ml-rg-test +eastus online-pwsh01 5/18/2022 9:44:06 AM Lucas Yao (Wicresoft North America) 5/18/2022 9:44:48 AM Managed ml-rg-test +``` + +Lists all online enpoints under a workspace + +### Example 2: Get a online enpoint by name +```powershell +Get-AzMLWorkspaceOnlineEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name online-cli01 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus online-cli01 5/19/2022 2:47:34 AM Lucas Yao (Wicresoft North America) 5/19/2022 2:48:26 AM Managed ml-rg-test +``` + +Get a online enpoint by name + +## PARAMETERS + +### -ComputeType +EndpointComputeType to be filtered by. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.EndpointComputeType +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +Number of endpoints to be retrieved in a page of results. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Online Endpoint name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderBy +The option to order the response. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.OrderString +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +A set of properties with which to filter the returned models. +It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 . + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Continuation token for pagination. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A set of tags with which to filter the returned models. +It is a comma separated string of tags key or tags key=value. +Example: tagKey1,tagKey2,tagKey3=value3 . + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IOnlineEndpoint + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineEndpointKey.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineEndpointKey.md new file mode 100644 index 0000000000..46cabf0f7b --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineEndpointKey.md @@ -0,0 +1,163 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspaceonlineendpointkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOnlineEndpointKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOnlineEndpointKey.md +--- + +# Get-AzMLWorkspaceOnlineEndpointKey + +## SYNOPSIS +List EndpointAuthKeys for an Endpoint using Key-based authentication. + +## SYNTAX + +``` +Get-AzMLWorkspaceOnlineEndpointKey -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List EndpointAuthKeys for an Endpoint using Key-based authentication. + +## EXAMPLES + +### Example 1: List EndpointAuthKeys for an Endpoint using Key-based authentication +```powershell +Get-AzMLWorkspaceOnlineEndpointKey -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name online-cli01 +``` + +```output +PrimaryKey SecondaryKey +---------- ------------ +xxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +List EndpointAuthKeys for an Endpoint using Key-based authentication + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Online Endpoint name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IEndpointAuthKeys + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineEndpointToken.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineEndpointToken.md new file mode 100644 index 0000000000..a562654304 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOnlineEndpointToken.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspaceonlineendpointtoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOnlineEndpointToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOnlineEndpointToken.md +--- + +# Get-AzMLWorkspaceOnlineEndpointToken + +## SYNOPSIS +Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication. + +## SYNTAX + +### Get (Default) +``` +Get-AzMLWorkspaceOnlineEndpointToken -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMLWorkspaceOnlineEndpointToken -InputObject <IMachineLearningServicesIdentity> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication. + +## EXAMPLES + +### Example 1: Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication +```powershell +Get-AzMLWorkspaceOnlineEndpointToken -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name online-portal91 +``` + +```output +AccessToken +----------- +xxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Online Endpoint name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IEndpointAuthToken + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOutboundNetworkDependencyEndpoint.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOutboundNetworkDependencyEndpoint.md new file mode 100644 index 0000000000..20c9e4bf53 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceOutboundNetworkDependencyEndpoint.md @@ -0,0 +1,125 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspaceoutboundnetworkdependencyendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOutboundNetworkDependencyEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceOutboundNetworkDependencyEndpoint.md +--- + +# Get-AzMLWorkspaceOutboundNetworkDependencyEndpoint + +## SYNOPSIS +Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically. + +## SYNTAX + +``` +Get-AzMLWorkspaceOutboundNetworkDependencyEndpoint -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically. + +## EXAMPLES + +### Example 1: Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically +```powershell +Get-AzMLWorkspaceOutboundNetworkDependencyEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 +``` + +```output +Category Endpoint +-------- -------- +Azure Active Directory {{… +Azure portal {{… +Azure Resource Manager {{… +Azure Machine Learning studio {{… +API {{… +Integrated notebook {{… +Compute {{… +Microsoft Container Registry {{… +Azure Machine Learning pre-built images {{… +``` + +Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IFqdnEndpoints + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceStorageAccountKey.md b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceStorageAccountKey.md new file mode 100644 index 0000000000..d4d5d159a4 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Get-AzMLWorkspaceStorageAccountKey.md @@ -0,0 +1,146 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/get-azmlworkspacestorageaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceStorageAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Get-AzMLWorkspaceStorageAccountKey.md +--- + +# Get-AzMLWorkspaceStorageAccountKey + +## SYNOPSIS +List storage account keys of a workspace. + +## SYNTAX + +``` +Get-AzMLWorkspaceStorageAccountKey -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List storage account keys of a workspace. + +## EXAMPLES + +### Example 1: List storage account keys of a workspace +```powershell +Get-AzMLWorkspaceStorageAccountKey -ResourceGroupName ml-rg-test -Name mlworkspace-cli01 +``` + +```output +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +List storage account keys of a workspace + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Invoke-AzMLWorkspaceDiagnose.md b/azps-10.1.0/Az.MachineLearningServices/Invoke-AzMLWorkspaceDiagnose.md new file mode 100644 index 0000000000..a8d2320b0b --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Invoke-AzMLWorkspaceDiagnose.md @@ -0,0 +1,390 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/invoke-azmlworkspacediagnose +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Invoke-AzMLWorkspaceDiagnose.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Invoke-AzMLWorkspaceDiagnose.md +--- + +# Invoke-AzMLWorkspaceDiagnose + +## SYNOPSIS +Diagnose workspace setup issue. + +## SYNTAX + +### DiagnoseExpanded (Default) +``` +Invoke-AzMLWorkspaceDiagnose -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-ApplicationInsightId <Hashtable>] [-ContainerRegistryId <Hashtable>] [-DnsResolution <Hashtable>] + [-KeyVaultId <Hashtable>] [-Nsg <Hashtable>] [-Other <Hashtable>] [-ResourceLock <Hashtable>] + [-StorageAccount <Hashtable>] [-Udr <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### DiagnoseViaIdentityExpanded +``` +Invoke-AzMLWorkspaceDiagnose -InputObject <IMachineLearningServicesIdentity> + [-ApplicationInsightId <Hashtable>] [-ContainerRegistryId <Hashtable>] [-DnsResolution <Hashtable>] + [-KeyVaultId <Hashtable>] [-Nsg <Hashtable>] [-Other <Hashtable>] [-ResourceLock <Hashtable>] + [-StorageAccount <Hashtable>] [-Udr <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Diagnose workspace setup issue. + +## EXAMPLES + +### Example 1: Diagnose workspace setup issue +```powershell +Invoke-AzMLWorkspaceDiagnose -ResourceGroupName ml-rg-test -Name mlworkspace-cli01 -ApplicationInsightId @{'key1'="/subscriptions/xxxx-xxxxx-xxxxxxxxx-xxxx/resourceGroups/ml-rg-test/providers/Microsoft.insights/components/xxxxxxxxxxx"} +``` + +```output +ValueApplicationInsightsResult : {} +ValueContainerRegistryResult : +ValueDnsResolutionResult : +ValueKeyVaultResult : +ValueNetworkSecurityRuleResult : +ValueOtherResult : +ValueResourceLockResult : +ValueStorageAccountResult : +ValueUserDefinedRouteResult : +``` + +Diagnose workspace setup issue + +### Example 2: Diagnose workspace setup issue by workspace object +```powershell +$workspace = Get-AzMLWorkspace -ResourceGroupName ml-rg-test -Name mlworkspace-cli01 +Invoke-AzMLWorkspaceDiagnose -InputObject $workspace -ApplicationInsightId @{'key1'="/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.insights/components/xxxxxxxxxxxx"} +``` + +```output +ValueApplicationInsightsResult : {} +ValueContainerRegistryResult : +ValueDnsResolutionResult : +ValueKeyVaultResult : +ValueNetworkSecurityRuleResult : +ValueOtherResult : +ValueResourceLockResult : +ValueStorageAccountResult : +ValueUserDefinedRouteResult : +``` + +Diagnose workspace setup issue by workspace object + +## PARAMETERS + +### -ApplicationInsightId +Setting for diagnosing dependent application insights + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryId +Setting for diagnosing dependent container registry + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsResolution +Setting for diagnosing dns resolution + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DiagnoseViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyVaultId +Setting for diagnosing dependent key vault + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: DiagnoseExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Nsg +Setting for diagnosing network security group + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Other +Setting for diagnosing unclassified category of problems + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: DiagnoseExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceLock +Setting for diagnosing resource lock + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Setting for diagnosing dependent storage account + +```yaml +Type: System.Collections.Hashtable +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. + +```yaml +Type: System.String +Parameter Sets: DiagnoseExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Udr +Setting for diagnosing user defined routing + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IDiagnoseResponseResultValue + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Invoke-AzMLWorkspaceNotebook.md b/azps-10.1.0/Az.MachineLearningServices/Invoke-AzMLWorkspaceNotebook.md new file mode 100644 index 0000000000..7b3777eac5 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Invoke-AzMLWorkspaceNotebook.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/invoke-azmlworkspacenotebook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Invoke-AzMLWorkspaceNotebook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Invoke-AzMLWorkspaceNotebook.md +--- + +# Invoke-AzMLWorkspaceNotebook + +## SYNOPSIS +Prepare a notebook. + +## SYNTAX + +### Prepare (Default) +``` +Invoke-AzMLWorkspaceNotebook -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### PrepareViaIdentity +``` +Invoke-AzMLWorkspaceNotebook -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Prepare a notebook. + +## EXAMPLES + +### Example 1: Prepare a notebook +```powershell +Invoke-AzMLWorkspaceNotebook -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 +``` + +```output +Fqdn ResourceId +---- ---------- +``` + +Prepare a notebook + +### Example 2: Prepare a notebook by pipeline +```powershell +$workspace = Get-AzMLWorkspace -ResourceGroupName ml-rg-test -Name mlworkspace-cli01 | Invoke-AzMLWorkspaceNotebook +``` + +```output +Fqdn ResourceId +---- ---------- +``` + +Prepare a notebook by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: PrepareViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Prepare +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Prepare +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Prepare +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.INotebookResourceInfo + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspace.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspace.md new file mode 100644 index 0000000000..9fdab3e4a2 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspace.md @@ -0,0 +1,644 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspace.md +--- + +# New-AzMLWorkspace + +## SYNOPSIS +Creates or updates a workspace with the specified parameters. + +## SYNTAX + +``` +New-AzMLWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AllowPublicAccessWhenBehindVnet] [-ApplicationInsightId <String>] [-ContainerRegistryId <String>] + [-CosmoDbCollectionsThroughput <Int32>] [-Description <String>] [-DiscoveryUrl <String>] + [-EncryptionStatus <EncryptionStatus>] [-EncryptionUserAssignedIdentity <String>] [-FriendlyName <String>] + [-HbiWorkspace] [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssigned <Hashtable>] + [-ImageBuildCompute <String>] [-KeyVaultArmId <String>] [-KeyVaultId <String>] + [-KeyVaultIdentityClientId <String>] [-KeyVaultKeyIdentifier <String>] [-Location <String>] + [-PrimaryUserAssignedIdentity <String>] [-PublicNetworkAccess <PublicNetworkAccess>] + [-SharedPrivateLinkResource <ISharedPrivateLinkResource[]>] [-SkuCapacity <Int32>] [-SkuFamily <String>] + [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] [-StorageAccountId <String>] [-Tag <Hashtable>] + [-V1LegacyMode] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a workspace with the specified parameters. + +## EXAMPLES + +### Example 1: Creates or updates a workspace with the specified parameters +```powershell +New-AzMLWorkspace -ResourceGroupName ml-rg-test -Name mlworkspace-pwsh01 -Location eastus -ApplicationInsightId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/ml-rg-test/providers/microsoft.insights/components/insightsmlworkspace" -KeyVaultId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/ml-rg-test/providers/microsoft.keyvault/vaults/kmlworkspace" -StorageAccountId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/ml-rg-test/providers/microsoft.storage/storageaccounts/storagemlworkspace01" -IdentityType 'SystemAssigned' +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Location ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- -------- ----------------- +mlworkspace-pwsh01 5/18/2022 6:33:49 AM v-diya@microsoft.com User 5/18/2022 6:33:49 AM v-diya@microsoft.com User eastus ml-rg-test +``` + +Creates or updates a workspace with the specified parameters + +## PARAMETERS + +### -AllowPublicAccessWhenBehindVnet +The flag to indicate whether to allow public access when behind VNet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationInsightId +ARM id of the application insights associated with this workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryId +ARM id of the container registry associated with this workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CosmoDbCollectionsThroughput +The throughput of the collections in cosmosdb database + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of this workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiscoveryUrl +Url for the discovery service to identify regional endpoints for machine learning experimentation services + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionStatus +Indicates whether or not the encryption is enabled for the workspace. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.EncryptionStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionUserAssignedIdentity +The ArmId of the user assigned identity that will be used to access the customer managed key vault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +The friendly name for this workspace. +This name in mutable + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HbiWorkspace +The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssigned +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageBuildCompute +The compute name for image build + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultArmId +The ArmId of the keyVault where the customer owned encryption key is present. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultId +ARM id of the key vault associated with this workspace. +This cannot be changed once the workspace has been created + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultIdentityClientId +For future use - The client id of the identity which will be used to access key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultKeyIdentifier +Key vault uri to access the encryption key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryUserAssignedIdentity +The user assigned identity resource id that represents the workspace identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Whether requests from Public Network are allowed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedPrivateLinkResource +The list of shared private link resources in this workspace. +To construct, see NOTES section for SHAREDPRIVATELINKRESOURCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ISharedPrivateLinkResource[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountId +ARM id of the storage account associated with this workspace. +This cannot be changed once the workspace has been created + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Contains resource tags defined as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -V1LegacyMode +Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IWorkspace + +## 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. + + +SHAREDPRIVATELINKRESOURCE <ISharedPrivateLinkResource[]>: The list of shared private link resources in this workspace. + - `[GroupId <String>]`: The private link resource group id. + - `[Name <String>]`: Unique name of the private link. + - `[PrivateLinkResourceId <String>]`: The resource id that private link links to. + - `[RequestMessage <String>]`: Request message. + - `[Status <PrivateEndpointServiceConnectionStatus?>]`: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceAksObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceAksObject.md new file mode 100644 index 0000000000..6c7335136b --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceAksObject.md @@ -0,0 +1,343 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspaceaksobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceAksObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceAksObject.md +--- + +# New-AzMLWorkspaceAksObject + +## SYNOPSIS +Create an in-memory object for Aks. + +## SYNTAX + +``` +New-AzMLWorkspaceAksObject [-AgentCount <Int32>] [-AgentVMSize <String>] [-AkNetworkingDnsServiceIP <String>] + [-AkNetworkingDockerBridgeCidr <String>] [-AkNetworkingServiceCidr <String>] [-AkNetworkingSubnetId <String>] + [-ClusterFqdn <String>] [-ClusterPurpose <ClusterPurpose>] [-Description <String>] + [-DisableLocalAuth <Boolean>] [-LoadBalancerSubnet <String>] [-LoadBalancerType <LoadBalancerType>] + [-ResourceId <String>] [-SslCert <String>] [-SslCname <String>] [-SslKey <String>] + [-SslLeafDomainLabel <String>] [-SslOverwriteExistingDomain <Boolean>] [-SslStatus <SslConfigStatus>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for Aks. + +## EXAMPLES + +### Example 1: Create an in-memory object for Aks +```powershell +New-AzMLWorkspaceAksObject -Description "aks compute" +``` + +Create an in-memory object for Aks + +## PARAMETERS + +### -AgentCount +Number of agents. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentVMSize +Agent virtual machine size. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AkNetworkingDnsServiceIP +An IP address assigned to the Kubernetes DNS service. +It must be within the Kubernetes service address range specified in serviceCidr. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AkNetworkingDockerBridgeCidr +A CIDR notation IP range assigned to the Docker bridge network. +It must not overlap with any Subnet IP ranges or the Kubernetes service address range. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AkNetworkingServiceCidr +A CIDR notation IP range from which to assign service cluster IPs. +It must not overlap with any Subnet IP ranges. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AkNetworkingSubnetId +Virtual network subnet resource ID the compute nodes belong to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterFqdn +Cluster full qualified domain name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterPurpose +Intended usage of the cluster. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ClusterPurpose +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerSubnet +Load Balancer Subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerType +Load Balancer Type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.LoadBalancerType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ARM resource id of the underlying compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCert +Cert data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCname +CNAME of the cert. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslKey +Key data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslLeafDomainLabel +Leaf domain label of public endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslOverwriteExistingDomain +Indicates whether to overwrite existing domain label. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslStatus +Enable or disable ssl for scoring. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.SslConfigStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.Aks + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceAmlComputeObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceAmlComputeObject.md new file mode 100644 index 0000000000..8990c18f27 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceAmlComputeObject.md @@ -0,0 +1,332 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspaceamlcomputeobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceAmlComputeObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceAmlComputeObject.md +--- + +# New-AzMLWorkspaceAmlComputeObject + +## SYNOPSIS +Create an in-memory object for AmlCompute. + +## SYNTAX + +``` +New-AzMLWorkspaceAmlComputeObject [-AdminUserName <String>] [-AdminUserPassword <String>] + [-AdminUserSshPublicKey <String>] [-Description <String>] [-DisableLocalAuth <Boolean>] + [-EnableNodePublicIP <Boolean>] [-IsolatedNetwork <Boolean>] [-OSType <OSType>] [-PropertyBag <IAny>] + [-RemoteLoginPortPublicAccess <RemoteLoginPortPublicAccess>] [-ResourceId <String>] + [-ScaleMaxNodeCount <Int32>] [-ScaleMinNodeCount <Int32>] [-ScaleNodeIdleTimeBeforeScaleDown <TimeSpan>] + [-SubnetId <String>] [-VirtualMachineImageId <String>] [-VMPriority <VMPriority>] [-VMSize <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AmlCompute. + +## EXAMPLES + +### Example 1: Create an in-memory object for AmlCompute +```powershell +New-AzMLWorkspaceAmlComputeObject +``` + +Create an in-memory object for AmlCompute + +## PARAMETERS + +### -AdminUserName +Name of the administrator user account which can be used to SSH to nodes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminUserPassword +Password of the administrator user account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminUserSshPublicKey +SSH public key of the administrator user account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNodePublicIP +Enable or disable node public IP address provisioning. +Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. +false - Indicates that the compute nodes will have a private endpoint and no public IPs. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsolatedNetwork +Network is isolated or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSType +Compute OS Type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.OSType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertyBag +A property bag containing additional properties. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IAny +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteLoginPortPublicAccess +State of the public SSH port. +Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. +Enabled - Indicates that the public ssh port is open on all nodes of the cluster. +NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. +It can be default only during cluster creation time, after creation it will be either enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.RemoteLoginPortPublicAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ARM resource id of the underlying compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleMaxNodeCount +Max number of nodes to use. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleMinNodeCount +Min number of nodes to use. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleNodeIdleTimeBeforeScaleDown +Node Idle Time before scaling down amlCompute. +This string needs to be in the RFC Format. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The ID of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineImageId +Virtual Machine image path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMPriority +Virtual Machine priority. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.VMPriority +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMSize +Virtual Machine Size. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.AmlCompute + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceBatchDeployment.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceBatchDeployment.md new file mode 100644 index 0000000000..d5d12b6ced --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceBatchDeployment.md @@ -0,0 +1,666 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacebatchdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceBatchDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceBatchDeployment.md +--- + +# New-AzMLWorkspaceBatchDeployment + +## SYNOPSIS +Creates/updates a batch inference deployment (asynchronous). + +## SYNTAX + +``` +New-AzMLWorkspaceBatchDeployment -EndpointName <String> -Name <String> -ResourceGroupName <String> + -WorkspaceName <String> -Location <String> [-SubscriptionId <String>] [-CodeId <String>] + [-CodeScoringScript <String>] [-ComputeId <String>] [-Description <String>] + [-EndpointDeploymentProperties <Hashtable>] [-EnvironmentId <String>] [-EnvironmentVariable <Hashtable>] + [-ErrorThreshold <Int32>] [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssigned <Hashtable>] + [-Kind <String>] [-LoggingLevel <BatchLoggingLevel>] [-MaxConcurrencyPerInstance <Int32>] + [-MiniBatchSize <Int64>] [-ModelReferenceType <ReferenceType>] [-OutputAction <BatchOutputAction>] + [-OutputFileName <String>] [-ResourceInstanceCount <Int32>] [-ResourceInstanceType <String>] + [-ResourceProperty <Hashtable>] [-RetryMax <Int32>] [-RetryTimeout <TimeSpan>] [-SkuCapacity <Int32>] + [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates/updates a batch inference deployment (asynchronous). + +## EXAMPLES + +### Example 1: Creates/updates a batch inference deployment (asynchronous) +```powershell +New-AzMLWorkspaceBatchDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName batch-pwsh03 -Name nonmlflowdp -Location "eastus" ` +-CodeId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-cli01/codes/bd430754-fba7-4a63-a6b8-8ea8635767f3/versions/1" -CodeScoringScript "digit_identification.py" ` +-EnvironmentId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-cli01/environments/CliV2AnonymousEnvironment/versions/5d230430f302e7876f9b64710733f68e" ` +-Compute "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-cli01/computes/batch-cluster" ` +-ModelReferenceType 'Id' +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus nonmlflowdp 6/1/2022 6:19:16 AM Lucas Yao (Wicresoft North America) 6/1/2022 6:19:16 AM ml-rg-test +``` + +Creates/updates a batch inference deployment (asynchronous) + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CodeId +ARM resource ID of the code asset. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CodeScoringScript +[Required] The script to execute on startup. +eg. +"score.py" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeId +Compute target for batch inference operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the endpoint deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDeploymentProperties +Property dictionary. +Properties can be added, but not removed or altered. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Inference endpoint name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentId +ARM resource ID or AssetId of the environment specification for the endpoint deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentVariable +Environment variables configuration for the deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ErrorThreshold +Error threshold, if the error count for the entire input goes above this value,the batch inference will be aborted. +Range is [-1, int.MaxValue].For FileDataset, this value is the count of file failures.For TabularDataset, this value is the count of record failures.If set to -1 (the lower bound), all failures during batch inference will be ignored. + +```yaml +Type: System.Int32 +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssigned +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoggingLevel +Logging level for batch inference operation. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.BatchLoggingLevel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxConcurrencyPerInstance +Indicates maximum number of parallelism per instance. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MiniBatchSize +Size of the mini-batch passed to each batch invocation.For FileDataset, this is the number of files per mini-batch.For TabularDataset, this is the size of the records in bytes, per mini-batch. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModelReferenceType +[Required] Specifies the type of asset reference. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ReferenceType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The identifier for the Batch inference deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputAction +Indicates how the output will be organized. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.BatchOutputAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFileName +Customized output file name for append_row output action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceInstanceCount +Optional number of instances or nodes used by the compute target. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceInstanceType +Optional type of VM used as supported by the compute target. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceProperty +Additional properties bag. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetryMax +Maximum retry count for a mini-batch + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetryTimeout +Invocation timeout for a mini-batch, in ISO 8601 format. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.SkuTier +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IBatchDeployment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceBatchEndpoint.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceBatchEndpoint.md new file mode 100644 index 0000000000..7df0d7948e --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceBatchEndpoint.md @@ -0,0 +1,445 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacebatchendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceBatchEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceBatchEndpoint.md +--- + +# New-AzMLWorkspaceBatchEndpoint + +## SYNOPSIS +Creates a batch inference endpoint (asynchronous). + +## SYNTAX + +``` +New-AzMLWorkspaceBatchEndpoint -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + -AuthMode <EndpointAuthMode> -Location <String> [-SubscriptionId <String>] [-DefaultDeploymentName <String>] + [-Description <String>] [-EndpointProperties <Hashtable>] [-IdentityType <ManagedServiceIdentityType>] + [-IdentityUserAssigned <Hashtable>] [-Kind <String>] [-PrimaryKey <String>] [-SecondaryKey <String>] + [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a batch inference endpoint (asynchronous). + +## EXAMPLES + +### Example 1: Creates a batch inference endpoint (asynchronous) +```powershell +New-AzMLWorkspaceBatchEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name batchpwsh01-key -AuthMode 'Key' -Location 'eastus' +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus batch-pwsh03 5/20/2022 7:21:12 AM Lucas Yao (Wicresoft North America) 5/20/2022 7:31:17 AM ml-rg-test +``` + +Creates a batch inference endpoint (asynchronous) + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthMode +[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. +'Key' doesn't expire but 'AMLToken' does. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.EndpointAuthMode +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultDeploymentName +Name of the deployment that will be default for the endpoint.This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the inference endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointProperties +Property dictionary. +Properties can be added, but not removed or altered. + +```yaml +Type: System.Collections.Hashtable +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssigned +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name for the Batch inference endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryKey +The primary key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryKey +The secondary key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.SkuTier +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IBatchEndpoint + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCodeVersion.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCodeVersion.md new file mode 100644 index 0000000000..d4dfbabfb3 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCodeVersion.md @@ -0,0 +1,273 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacecodeversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceCodeVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceCodeVersion.md +--- + +# New-AzMLWorkspaceCodeVersion + +## SYNOPSIS +Create or update version. + +## SYNTAX + +``` +New-AzMLWorkspaceCodeVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-CodeUri <String>] [-Description <String>] [-IsAnonymou] + [-IsArchived] [-ResourceBaseProperty <Hashtable>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update version. + +## EXAMPLES + +### Example 1: Create or update code version +```powershell +New-AzMLWorkspaceCodeVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name 'cli-hello-example' -Version 1 -CodeUri "https://mlworkspacepor8056718628.blob.core.windows.net/azureml-blobstore-dc0f7f2b-686d-417b-a456-6c09def791f5/LocalUpload/a8da6e3978c9f8b1cb03501595a9142f/src" +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +1 5/24/2022 7:14:05 AM Lucas Yao (Wicresoft North America) User 5/24/2022 7:14:05 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Create or update code version + +## PARAMETERS + +### -CodeUri +Uri where code is located + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAnonymou +If the name version are system generated (anonymous registration). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchived +Is the asset archived + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceBaseProperty +The asset property dictionary. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ICodeVersion + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCommandJobObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCommandJobObject.md new file mode 100644 index 0000000000..5ad1125f06 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCommandJobObject.md @@ -0,0 +1,455 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacecommandjobobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceCommandJobObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceCommandJobObject.md +--- + +# New-AzMLWorkspaceCommandJobObject + +## SYNOPSIS +Create an in-memory object for CommandJob. + +## SYNTAX + +``` +New-AzMLWorkspaceCommandJobObject -Command <String> -EnvironmentId <String> [-CodeId <String>] + [-ComputeId <String>] [-Description <String>] [-DisplayName <String>] [-DistributionType <DistributionType>] + [-EnvironmentVariable <Hashtable>] [-ExperimentName <String>] [-IdentityType <IdentityConfigurationType>] + [-IsArchived <Boolean>] [-JobInput <ICommandJobInputs>] [-JobOutput <ICommandJobOutputs>] + [-LimitTimeout <TimeSpan>] [-Property <IResourceBaseProperties>] [-ResourceInstanceCount <Int32>] + [-ResourceInstanceType <String>] [-ResourceProperty <IResourceConfigurationProperties>] + [-ServiceEndpoint <String>] [-ServicePort <Int32>] [-ServiceProperty <IJobServiceProperties>] + [-ServiceType <String>] [-Tag <IResourceBaseTags>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for CommandJob. + +## EXAMPLES + +### Example 1: Create an in-memory object for CommandJob +```powershell +# You can use following commands to create job input or job oupt as vaule pass to JobInput or JobOutput parameter of the New-AzMLWorkspaceCommandJobObject + +# New-AzMLWorkspaceCustomModelJobInputObject +# New-AzMLWorkspaceCustomModelJobOutputObject +# New-AzMLWorkspaceLiteralJobInputObject +# New-AzMLWorkspaceMLFlowModelJobInputObject +# New-AzMLWorkspaceMLFlowModelJobOutputObject +# New-AzMLWorkspaceMLTableJobInputObject +# New-AzMLWorkspaceMLTableJobOutputObject +# New-AzMLWorkspaceSharedPrivateLinkResourceObject +# New-AzMLWorkspaceTritonModelJobInputObject +# New-AzMLWorkspaceTritonModelJobOutputObject +# New-AzMLWorkspaceUriFileJobInputObject +# New-AzMLWorkspaceUriFileJobOutputObject +# New-AzMLWorkspaceUriFolderJobInputObject +# New-AzMLWorkspaceUriFolderJobOutputObject + +New-AzMLWorkspaceCommandJobObject -Command "echo `"hello world`"" ` +-ComputeId '/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-test01/computes/aml02' ` +-EnvironmentId '/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-test01/environments/commandjobenv/versions/1'` +-DisplayName 'commandjob01' -ExperimentName 'commandjobexperiment' +``` + +Create an in-memory object for CommandJob. + +## PARAMETERS + +### -CodeId +ARM resource ID of the code asset. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Command +[Required] The command to execute on startup of the job. +eg. +"python train.py". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeId +ARM resource ID of the compute resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display name of job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionType +[Required] Specifies the type of distribution framework. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.DistributionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentId +[Required] The ARM resource ID of the Environment specification for the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentVariable +Environment variables included in the job. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExperimentName +The name of the experiment the job belongs to. +If not set, the job is placed in the "Default" experiment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +[Required] Specifies the type of identity framework. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.IdentityConfigurationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchived +Is the asset archived?. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobInput +Mapping of input data bindings used in the job. +To construct, see NOTES section for JOBINPUT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ICommandJobInputs +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobOutput +Mapping of output data bindings used in the job. +To construct, see NOTES section for JOBOUTPUT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ICommandJobOutputs +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitTimeout +The max run duration in ISO 8601 format, after which the job will be cancelled. +Only supports duration with precision as low as Seconds. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +The asset property dictionary. +To construct, see NOTES section for PROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceInstanceCount +Optional number of instances or nodes used by the compute target. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceInstanceType +Optional type of VM used as supported by the compute target. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceProperty +Additional properties bag. +To construct, see NOTES section for RESOURCEPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceConfigurationProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceEndpoint +Url for endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePort +Port for endpoint. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceProperty +Additional properties to set on the endpoint. +To construct, see NOTES section for SERVICEPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IJobServiceProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceType +Endpoint type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. +To construct, see NOTES section for TAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.CommandJob + +## 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. + + +JOBINPUT `<ICommandJobInputs>`: Mapping of input data bindings used in the job. + - `[(Any) <IJobInput>]`: This indicates any property can be added to this object. + +JOBOUTPUT `<ICommandJobOutputs>`: Mapping of output data bindings used in the job. + - `[(Any) <IJobOutput>]`: This indicates any property can be added to this object. + +PROPERTY `<IResourceBaseProperties>`: The asset property dictionary. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +RESOURCEPROPERTY `<IResourceConfigurationProperties>`: Additional properties bag. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + +SERVICEPROPERTY `<IJobServiceProperties>`: Additional properties to set on the endpoint. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +TAG `<IResourceBaseTags>`: Tag dictionary. Tags can be added, removed, and updated. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceComponentContainer.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceComponentContainer.md new file mode 100644 index 0000000000..6fab8a94d0 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceComponentContainer.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacecomponentcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceComponentContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceComponentContainer.md +--- + +# New-AzMLWorkspaceComponentContainer + +## SYNOPSIS +Create or update container. + +## SYNTAX + +``` +New-AzMLWorkspaceComponentContainer -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-Description <String>] [-IsArchived] [-ResourceBaseProperty <Hashtable>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update container. + +## EXAMPLES + +### Example 1: Create or update component container +```powershell +New-AzMLWorkspaceComponentContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name component-pwsh01 -IsArchived +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +component-pwsh01 6/1/2022 1:45:45 PM 6/1/2022 1:45:45 PM ml-rg-test +``` + +Create or update component container + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchived +Is the asset archived + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceBaseProperty +The asset property dictionary. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IComponentContainer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceComponentVersion.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceComponentVersion.md new file mode 100644 index 0000000000..c9fd8a1070 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceComponentVersion.md @@ -0,0 +1,281 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacecomponentversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceComponentVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceComponentVersion.md +--- + +# New-AzMLWorkspaceComponentVersion + +## SYNOPSIS +Create or update version. + +## SYNTAX + +``` +New-AzMLWorkspaceComponentVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-ComponentSpec <Hashtable>] [-Description <String>] + [-IsAnonymou] [-IsArchived] [-ResourceBaseProperty <Hashtable>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update version. + +## EXAMPLES + +### Example 1: Create or update component version +```powershell +$componentHash = @{ + "name"= "train_data_component"; + "version"= "1"; + "display_name"= "train_data"; + "is_deterministic"= "True"; + "type"= "command"; + "code"= "azureml:/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-cli01/codes/e08a4be4-66c4-477b-acd7-9579fdd0a3f1/versions/1"; + "environment"= "azureml:/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-cli01/environments/AzureML-sklearn-0.24-ubuntu18.04-py37-cpu/versions/1"; + "command"= "python train.py" + } +New-AzMLWorkspaceComponentVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name componentpwsh01 -Version 1 -ComponentSpec $componentHash +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +1 6/5/2022 2:06:37 PM Lucas Yao (Wicresoft North America) User 6/5/2022 2:06:37 PM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Create or update component version + +## PARAMETERS + +### -ComponentSpec +Defines Component definition details.\<see href="https://learn.microsoft.com/en-us/azure/machine-learning/reference-yaml-component-command" /\> + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAnonymou +If the name version are system generated (anonymous registration). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchived +Is the asset archived + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceBaseProperty +The asset property dictionary. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IComponentVersion + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCompute.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCompute.md new file mode 100644 index 0000000000..6f34ed3b03 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCompute.md @@ -0,0 +1,386 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacecompute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceCompute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceCompute.md +--- + +# New-AzMLWorkspaceCompute + +## SYNOPSIS +Creates or updates compute. +This call will overwrite a compute if it exists. +This is a nonrecoverable operation. +If your intent is to create a new compute, do a GET first to verify that it does not exist yet. + +## SYNTAX + +``` +New-AzMLWorkspaceCompute -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-Compute <ICompute>] [-IdentityType <ManagedServiceIdentityType>] + [-IdentityUserAssigned <Hashtable>] [-Location <String>] [-SkuCapacity <Int32>] [-SkuFamily <String>] + [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates compute. +This call will overwrite a compute if it exists. +This is a nonrecoverable operation. +If your intent is to create a new compute, do a GET first to verify that it does not exist yet. + +## EXAMPLES + +### Example 1: Creates or updates compute. This call will overwrite a compute if it exists +```powershell +# The datastore type includes 'AKS', 'Kubernetes', 'AmlCompute', 'ComputeInstance','DataFactory', 'VirtualMachine', 'HDInsight', 'Databricks', 'DataLakeAnalytics', 'SynapseSpark'. +# You can use following command to create it then pass it as value to Compute parameter of the New-AzMLWorkspaceCompute cmdlet. +# New-AzMLWorkspaceAmlComputeObject +# New-AzMLWorkspaceComputeInstanceObject +# New-AzMLWorkspaceAksObject +# New-AzMLWorkspaceKubernetesObject +# New-AzMLWorkspaceVirtualMachineObject +# New-AzMLWorkspaceHDInsightObject +# New-AzMLWorkspaceDataFactoryObject +# New-AzMLWorkspaceDatabricksObject +# New-AzMLWorkspaceDataLakeAnalyticsObject +# New-AzMLWorkspaceSynapseSparkObject + +$aml = New-AzMLWorkspaceAmlComputeObject -OSType 'Linux' -VMSize "STANDARD_DS3_V2" ` +-ScaleMaxNodeCount 8 -ScaleMinNodeCount 0 -RemoteLoginPortPublicAccess 'NotSpecified' -EnableNodePublicIP $true +New-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name aml02 -Location eastus -Compute $aml +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Location ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- -------- ----------------- +aml02 +``` + +Creates or updates compute. +This call will overwrite a compute if it exists + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compute +Compute properties +To construct, see NOTES section for COMPUTE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ICompute +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssigned +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ComputeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.SkuTier +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Contains resource tags defined as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IComputeResource + +## 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. + + +COMPUTE `<ICompute>`: Compute properties + - `Type <ComputeType>`: The type of compute + - `[Description <String>]`: The description of the Machine Learning compute. + - `[DisableLocalAuth <Boolean?>]`: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. + - `[ResourceId <String>]`: ARM resource id of the underlying compute + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceComputeInstanceObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceComputeInstanceObject.md new file mode 100644 index 0000000000..ded37cd4bc --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceComputeInstanceObject.md @@ -0,0 +1,469 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacecomputeinstanceobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceComputeInstanceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceComputeInstanceObject.md +--- + +# New-AzMLWorkspaceComputeInstanceObject + +## SYNOPSIS +Create an in-memory object for ComputeInstance. + +## SYNTAX + +``` +New-AzMLWorkspaceComputeInstanceObject [-ApplicationSharingPolicy <ApplicationSharingPolicy>] + [-AssignedUserObjectId <String>] [-AssignedUserTenantId <String>] + [-AuthorizationType <ComputeInstanceAuthorizationType>] [-CreationScriptArgument <String>] + [-CreationScriptData <String>] [-CreationScriptSource <String>] [-CreationScriptTimeout <String>] + [-Description <String>] [-DisableLocalAuth <Boolean>] [-EnableNodePublicIP <Boolean>] + [-LastOperationName <OperationName>] [-LastOperationStatus <OperationStatus>] [-LastOperationTime <DateTime>] + [-LastOperationTrigger <OperationTrigger>] [-ResourceId <String>] + [-ScheduleComputeStartStop <IComputeStartStopSchedule[]>] [-SshSettingAdminPublicKey <String>] + [-SshSettingSshPublicAccess <SshPublicAccess>] [-StartupScriptArgument <String>] + [-StartupScriptData <String>] [-StartupScriptSource <String>] [-StartupScriptTimeout <String>] + [-SubnetId <String>] [-VersionRuntime <String>] [-VMSize <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ComputeInstance. + +## EXAMPLES + +### Example 1: Create an in-memory object for ComputeInstance +```powershell +New-AzMLWorkspaceComputeInstanceObject +``` + +Create an in-memory object for ComputeInstance + +## PARAMETERS + +### -ApplicationSharingPolicy +Policy for sharing applications on this compute instance among users of parent workspace. +If Personal, only the creator can access applications on this compute instance. +When Shared, any workspace user can access applications on this instance depending on his/her assigned role. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ApplicationSharingPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignedUserObjectId +User’s AAD Object Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignedUserTenantId +User’s AAD Tenant Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizationType +The Compute Instance Authorization type. +Available values are personal (default). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ComputeInstanceAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreationScriptArgument +Optional command line arguments passed to the script to run. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreationScriptData +The location of scripts in the mounted volume. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreationScriptSource +The storage source of the script: inline, workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreationScriptTimeout +Optional time period passed to timeout command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNodePublicIP +Enable or disable node public IP address provisioning. +Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. +false - Indicates that the compute nodes will have a private endpoint and no public IPs. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastOperationName +Name of the last operation. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.OperationName +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastOperationStatus +Operation status. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.OperationStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastOperationTime +Time of the last operation. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastOperationTrigger +Trigger of operation. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.OperationTrigger +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ARM resource id of the underlying compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleComputeStartStop +The list of compute start stop schedules to be applied. +To construct, see NOTES section for SCHEDULECOMPUTESTARTSTOP properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IComputeStartStopSchedule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshSettingAdminPublicKey +Specifies the SSH rsa public key file as a string. +Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshSettingSshPublicAccess +State of the public SSH port. +Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. +Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.SshPublicAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartupScriptArgument +Optional command line arguments passed to the script to run. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartupScriptData +The location of scripts in the mounted volume. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartupScriptSource +The storage source of the script: inline, workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartupScriptTimeout +Optional time period passed to timeout command. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The ID of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VersionRuntime +Runtime of compute instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMSize +Virtual Machine Size. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ComputeInstance + +## 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. + + +SCHEDULECOMPUTESTARTSTOP <IComputeStartStopSchedule[]>: The list of compute start stop schedules to be applied. + - `[Action <ComputePowerAction?>]`: The compute power action. + - `[ScheduleId <String>]`: + - `[ScheduleProvisioningStatus <ScheduleProvisioningState?>]`: + - `[ScheduleStatus <ScheduleStatus?>]`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceComputeStartStopScheduleObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceComputeStartStopScheduleObject.md new file mode 100644 index 0000000000..399636f6e9 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceComputeStartStopScheduleObject.md @@ -0,0 +1,111 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacecomputestartstopscheduleobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceComputeStartStopScheduleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceComputeStartStopScheduleObject.md +--- + +# New-AzMLWorkspaceComputeStartStopScheduleObject + +## SYNOPSIS +Create an in-memory object for ComputeStartStopSchedule. + +## SYNTAX + +``` +New-AzMLWorkspaceComputeStartStopScheduleObject [-Action <ComputePowerAction>] [-ScheduleId <String>] + [-ScheduleProvisioningStatus <ScheduleProvisioningState>] [-ScheduleStatus <ScheduleStatus>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ComputeStartStopSchedule. + +## EXAMPLES + +### Example 1: Create an in-memory object for ComputeStartStopSchedule +```powershell +New-AzMLWorkspaceComputeStartStopScheduleObject +``` + +Create an in-memory object for ComputeStartStopSchedule + +## PARAMETERS + +### -Action +The compute power action. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ComputePowerAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleId + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleProvisioningStatus + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ScheduleProvisioningState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleStatus + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ScheduleStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ComputeStartStopSchedule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceConnection.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceConnection.md new file mode 100644 index 0000000000..ccc6a2c692 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceConnection.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspaceconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceConnection.md +--- + +# New-AzMLWorkspaceConnection + +## SYNOPSIS +Creates or updates a workspace connection with the specified parameters. + +## SYNTAX + +``` +New-AzMLWorkspaceConnection -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + -AuthType <ConnectionAuthType> [-SubscriptionId <String>] [-Category <ConnectionCategory>] [-Target <String>] + [-Value <String>] [-ValueFormat <ValueFormat>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a workspace connection with the specified parameters. + +## EXAMPLES + +### Example 1: Creates a workspace connection +```powershell +New-AzMLWorkspaceConnection -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name test01 -AuthType 'None' -Category 'ContainerRegistry' -Target "www.facebook.com" +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +test01 ml-rg-test +``` + +Creates a workspace connection + +## PARAMETERS + +### -AuthType +Authentication type of the connection target + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ConnectionAuthType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Category +Category of the connection + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ConnectionCategory +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Friendly name of the workspace connection + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Target +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Value details of the workspace connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValueFormat +format for the workspace connection value + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ValueFormat +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IWorkspaceConnectionPropertiesV2BasicResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCustomModelJobInputObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCustomModelJobInputObject.md new file mode 100644 index 0000000000..a0ef46d531 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCustomModelJobInputObject.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacecustommodeljobinputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceCustomModelJobInputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceCustomModelJobInputObject.md +--- + +# New-AzMLWorkspaceCustomModelJobInputObject + +## SYNOPSIS +Create an in-memory object for CustomModelJobInput. + +## SYNTAX + +``` +New-AzMLWorkspaceCustomModelJobInputObject -Type <JobInputType> -Uri <String> [-Description <String>] + [-Mode <InputDeliveryMode>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for CustomModelJobInput. + +## EXAMPLES + +### Example 1: Create an in-memory object for CustomModelJobInput +```powershell +New-AzMLWorkspaceCustomModelJobInputObject +``` + +Create an in-memory object for CustomModelJobInput + +## PARAMETERS + +### -Description +Description for the input. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Input Asset Delivery Mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.InputDeliveryMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +[Required] Specifies the type of job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobInputType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +[Required] Input Asset URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.CustomModelJobInput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCustomModelJobOutputObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCustomModelJobOutputObject.md new file mode 100644 index 0000000000..c80f9813a3 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceCustomModelJobOutputObject.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacecustommodeljoboutputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceCustomModelJobOutputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceCustomModelJobOutputObject.md +--- + +# New-AzMLWorkspaceCustomModelJobOutputObject + +## SYNOPSIS +Create an in-memory object for CustomModelJobOutput. + +## SYNTAX + +``` +New-AzMLWorkspaceCustomModelJobOutputObject -Type <JobOutputType> [-Description <String>] + [-Mode <OutputDeliveryMode>] [-Uri <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for CustomModelJobOutput. + +## EXAMPLES + +### Example 1: Create an in-memory object for CustomModelJobOutput +```powershell +New-AzMLWorkspaceCustomModelJobOutputObject +``` + +Create an in-memory object for CustomModelJobOutput + +## PARAMETERS + +### -Description +Description for the output. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Output Asset Delivery Mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.OutputDeliveryMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +[Required] Specifies the type of job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobOutputType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +Output Asset URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.CustomModelJobOutput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDataContainer.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDataContainer.md new file mode 100644 index 0000000000..4ff5a12c2f --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDataContainer.md @@ -0,0 +1,241 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatacontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDataContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDataContainer.md +--- + +# New-AzMLWorkspaceDataContainer + +## SYNOPSIS +Create or update container. + +## SYNTAX + +``` +New-AzMLWorkspaceDataContainer -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + -DataType <DataType> [-SubscriptionId <String>] [-Description <String>] [-IsArchived] + [-ResourceBaseProperty <Hashtable>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update container. + +## EXAMPLES + +### Example 1: Create or update data container +```powershell +New-AzMLWorkspaceDataContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name datacontainer-pwsh01 -DataType 'uri_file' +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +datacontainer-pwsh01 6/1/2022 3:03:56 PM Lucas Yao (Wicresoft North America) User 6/1/2022 3:03:56 PM ml-rg-test +``` + +Create or update data container + +## PARAMETERS + +### -DataType +[Required] Specifies the type of data. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.DataType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchived +Is the asset archived + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceBaseProperty +The asset property dictionary. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IDataContainer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDataFactoryObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDataFactoryObject.md new file mode 100644 index 0000000000..7dea38a848 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDataFactoryObject.md @@ -0,0 +1,95 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatafactoryobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDataFactoryObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDataFactoryObject.md +--- + +# New-AzMLWorkspaceDataFactoryObject + +## SYNOPSIS +Create an in-memory object for DataFactory. + +## SYNTAX + +``` +New-AzMLWorkspaceDataFactoryObject [-Description <String>] [-DisableLocalAuth <Boolean>] + [-ResourceId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for DataFactory. + +## EXAMPLES + +### Example 1: Create an in-memory object for DataFactory +```powershell +New-AzMLWorkspaceDataFactoryObject +``` + +Create an in-memory object for DataFactory + +## PARAMETERS + +### -Description +The description of the Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ARM resource id of the underlying compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.DataFactory + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDataLakeAnalyticsObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDataLakeAnalyticsObject.md new file mode 100644 index 0000000000..274a6c1e7c --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDataLakeAnalyticsObject.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatalakeanalyticsobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDataLakeAnalyticsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDataLakeAnalyticsObject.md +--- + +# New-AzMLWorkspaceDataLakeAnalyticsObject + +## SYNOPSIS +Create an in-memory object for DataLakeAnalytics. + +## SYNTAX + +``` +New-AzMLWorkspaceDataLakeAnalyticsObject [-DataLakeStoreAccountName <String>] [-Description <String>] + [-DisableLocalAuth <Boolean>] [-ResourceId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for DataLakeAnalytics. + +## EXAMPLES + +### Example 1: Create an in-memory object for DataLakeAnalytics +```powershell +New-AzMLWorkspaceDataLakeAnalyticsObject +``` + +Create an in-memory object for DataLakeAnalytics + +## PARAMETERS + +### -DataLakeStoreAccountName +DataLake Store Account Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ARM resource id of the underlying compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.DataLakeAnalytics + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDataVersion.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDataVersion.md new file mode 100644 index 0000000000..8ca3f153f0 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDataVersion.md @@ -0,0 +1,287 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedataversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDataVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDataVersion.md +--- + +# New-AzMLWorkspaceDataVersion + +## SYNOPSIS +Create or update version. + +## SYNTAX + +``` +New-AzMLWorkspaceDataVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> -DataType <DataType> -DataUri <String> [-SubscriptionId <String>] + [-Description <String>] [-IsAnonymou] [-IsArchived] [-ResourceBaseProperty <Hashtable>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update version. + +## EXAMPLES + +### Example 1: Create or update data version +```powershell +New-AzMLWorkspaceDataVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name iris-data -Version 2 -DataType 'uri_file' -DataUri "https://azuremlexamples.blob.core.windows.net/datasets/iris.csv" +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +2 6/1/2022 3:11:06 PM Lucas Yao (Wicresoft North America) User 6/1/2022 3:11:06 PM ml-rg-test +``` + +Create or update data version + +## PARAMETERS + +### -DataType +[Required] Specifies the type of data. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.DataType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataUri +[Required] Uri of the data. +Usage/meaning depends on Microsoft.MachineLearning.ManagementFrontEnd.Contracts.V20220501.Assets.DataVersionBase.DataType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAnonymou +If the name version are system generated (anonymous registration). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchived +Is the asset archived + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceBaseProperty +The asset property dictionary. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IDataVersionBase + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatabricksObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatabricksObject.md new file mode 100644 index 0000000000..149a46759b --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatabricksObject.md @@ -0,0 +1,129 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatabricksobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatabricksObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatabricksObject.md +--- + +# New-AzMLWorkspaceDatabricksObject + +## SYNOPSIS +Create an in-memory object for Databricks. + +## SYNTAX + +``` +New-AzMLWorkspaceDatabricksObject [-AccessToken <String>] [-Description <String>] + [-DisableLocalAuth <Boolean>] [-ResourceId <String>] [-WorkspaceUrl <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for Databricks. + +## EXAMPLES + +### Example 1: Create an in-memory object for Databricks +```powershell +New-AzMLWorkspaceDatabricksObject +``` + +```output +New-AzMLWorkspaceDatabricksObject +``` + +Create an in-memory object for Databricks + +## PARAMETERS + +### -AccessToken +Databricks access token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ARM resource id of the underlying compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceUrl +Workspace Url. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.Databricks + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastore.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastore.md new file mode 100644 index 0000000000..8eb3a171e2 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastore.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatastore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastore.md +--- + +# New-AzMLWorkspaceDatastore + +## SYNOPSIS +Create or update datastore. + +## SYNTAX + +``` +New-AzMLWorkspaceDatastore -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + -Datastore <IDatastoreProperties> [-SubscriptionId <String>] [-SkipValidation] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update datastore. + +## EXAMPLES + +### Example 1: Create or update datastore +```powershell +# The datastore type includes AzureBlob, AzureDataLakeGen1, AzureDataLakeGen2, AzureFile. +# You can use following command to create it then pass it as value to Datastore parameter of the New-AzMLWorkspaceDatastore cmdlet. +# New-AzMLWorkspaceDatastoreBlobObject +# New-AzMLWorkspaceDatastoreDataLakeGen1Object +# New-AzMLWorkspaceDatastoreDataLakeGen2Object +# New-AzMLWorkspaceDatastoreFileObject +# You can specify credentials when creating a datastore type. The following commands can be used to create credentials. +# New-AzMLWorkspaceDatastoreKeyCredentialObject +# New-AzMLWorkspaceDatastoreCredentialsObject +# New-AzMLWorkspaceDatastoreNoneCredentialsObject +# New-AzMLWorkspaceDatastoreSasCredentialsObject +# New-AzMLWorkspaceDatastoreServicePrincipalCredentialsObject + +$accountKey = New-AzMLWorkspaceDatastoreKeyCredentialObject -Key "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +$datastoreBlob = New-AzMLWorkspaceDatastoreBlobObject -AccountName 'mmstorageeastus' -ContainerName "globaldatasets" -Endpoint "core.windows.net" -Protocol "https" -ServiceDataAccessAuthIdentity 'None' -Credentials $accountKey +New-AzMLWorkspaceDatastore -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-demo -Name blobdatastore -Property $datastoreBlob +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +blobdatastore 5/27/2022 7:15:04 AM Lucas Yao (Wicresoft North America) User 5/27/2022 7:15:05 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Create or update datastore + +## PARAMETERS + +### -Datastore +[Required] Additional attributes of the entity. +To construct, see NOTES section for DATASTORE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IDatastoreProperties +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Datastore name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipValidation +Flag to skip validation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.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. + + +DATASTORE `<IDatastoreProperties>`: [Required] Additional attributes of the entity. + - `Credentials <IDatastoreCredentials>`: [Required] Account credentials. + - `CredentialsType <CredentialsType>`: [Required] Credential type used to authentication with storage. + - `DatastoreType <DatastoreType>`: [Required] Storage type backing the datastore. + - `[Description <String>]`: The asset description text. + - `[Property <IResourceBaseProperties>]`: The asset property dictionary. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[Tag <IResourceBaseTags>]`: Tag dictionary. Tags can be added, removed, and updated. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreBlobObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreBlobObject.md new file mode 100644 index 0000000000..61f846165f --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreBlobObject.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatastoreblobobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreBlobObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreBlobObject.md +--- + +# New-AzMLWorkspaceDatastoreBlobObject + +## SYNOPSIS +Create an in-memory object for AzureBlobDatastore. + +## SYNTAX + +``` +New-AzMLWorkspaceDatastoreBlobObject -Credentials <IDatastoreCredentials> [-AccountName <String>] + [-ContainerName <String>] [-Description <String>] [-Endpoint <String>] [-Property <IResourceBaseProperties>] + [-Protocol <String>] [-ServiceDataAccessAuthIdentity <ServiceDataAccessAuthIdentity>] + [-Tag <IResourceBaseTags>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureBlobDatastore. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureBlobDatastore +```powershell +New-AzMLWorkspaceDatastoreBlobObject +``` + +Create an in-memory object for AzureBlobDatastore + +## PARAMETERS + +### -AccountName +Storage account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerName +Storage account container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credentials +[Required] Account credentials. +To construct, see NOTES section for CREDENTIALS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IDatastoreCredentials +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +Azure cloud endpoint for the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +The asset property dictionary. +To construct, see NOTES section for PROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol used to communicate with the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceDataAccessAuthIdentity +Indicates which identity to use to authenticate service data access to customer's storage. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ServiceDataAccessAuthIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. +To construct, see NOTES section for TAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.AzureBlobDatastore + +## 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. + + +CREDENTIALS `<IDatastoreCredentials>`: [Required] Account credentials. + - `CredentialsType <CredentialsType>`: [Required] Credential type used to authentication with storage. + +PROPERTY `<IResourceBaseProperties>`: The asset property dictionary. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +TAG `<IResourceBaseTags>`: Tag dictionary. Tags can be added, removed, and updated. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreCredentialObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreCredentialObject.md new file mode 100644 index 0000000000..82d6d75e33 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreCredentialObject.md @@ -0,0 +1,140 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatastorecredentialobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreCredentialObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreCredentialObject.md +--- + +# New-AzMLWorkspaceDatastoreCredentialObject + +## SYNOPSIS +Create an in-memory object for CertificateDatastoreCredentials. + +## SYNTAX + +``` +New-AzMLWorkspaceDatastoreCredentialObject -Certificate <String> -ClientId <String> -TenantId <String> + -Thumbprint <String> [-AuthorityUrl <String>] [-ResourceUrl <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for CertificateDatastoreCredentials. + +## EXAMPLES + +### Example 1: Create an in-memory object for CertificateDatastoreCredential +```powershell +New-AzMLWorkspaceDatastoreCredentialObject +``` + +Create an in-memory object for CertificateDatastoreCredential + +## PARAMETERS + +### -AuthorityUrl +Authority URL used for authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Certificate +[Required] Service principal certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientId +[Required] Service principal client ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUrl +Resource the service principal has access to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +[Required] ID of the tenant to which the service principal belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Thumbprint +[Required] Thumbprint of the certificate used for authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.CertificateDatastoreCredentials + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreDataLakeGen1Object.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreDataLakeGen1Object.md new file mode 100644 index 0000000000..b386d9ebeb --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreDataLakeGen1Object.md @@ -0,0 +1,160 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatastoredatalakegen1object +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreDataLakeGen1Object.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreDataLakeGen1Object.md +--- + +# New-AzMLWorkspaceDatastoreDataLakeGen1Object + +## SYNOPSIS +Create an in-memory object for AzureDataLakeGen1Datastore. + +## SYNTAX + +``` +New-AzMLWorkspaceDatastoreDataLakeGen1Object -Credentials <IDatastoreCredentials> -StoreName <String> + [-Description <String>] [-Property <IResourceBaseProperties>] + [-ServiceDataAccessAuthIdentity <ServiceDataAccessAuthIdentity>] [-Tag <IResourceBaseTags>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureDataLakeGen1Datastore. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureDataLakeGen1Datastore +```powershell +New-AzMLWorkspaceDatastoreDataLakeGen1Object +``` + +Create an in-memory object for AzureDataLakeGen1Datastore + +## PARAMETERS + +### -Credentials +[Required] Account credentials. +To construct, see NOTES section for CREDENTIALS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IDatastoreCredentials +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +The asset property dictionary. +To construct, see NOTES section for PROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceDataAccessAuthIdentity +Indicates which identity to use to authenticate service data access to customer's storage. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ServiceDataAccessAuthIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoreName +[Required] Azure Data Lake store name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. +To construct, see NOTES section for TAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.AzureDataLakeGen1Datastore + +## 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. + + +CREDENTIALS `<IDatastoreCredentials>`: [Required] Account credentials. + - `CredentialsType <CredentialsType>`: [Required] Credential type used to authentication with storage. + +PROPERTY `<IResourceBaseProperties>`: The asset property dictionary. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +TAG `<IResourceBaseTags>`: Tag dictionary. Tags can be added, removed, and updated. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreDataLakeGen2Object.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreDataLakeGen2Object.md new file mode 100644 index 0000000000..7dc37d31a5 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreDataLakeGen2Object.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatastoredatalakegen2object +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreDataLakeGen2Object.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreDataLakeGen2Object.md +--- + +# New-AzMLWorkspaceDatastoreDataLakeGen2Object + +## SYNOPSIS +Create an in-memory object for AzureDataLakeGen2Datastore. + +## SYNTAX + +``` +New-AzMLWorkspaceDatastoreDataLakeGen2Object -AccountName <String> -Credentials <IDatastoreCredentials> + -Filesystem <String> [-Description <String>] [-Endpoint <String>] [-Property <IResourceBaseProperties>] + [-Protocol <String>] [-ServiceDataAccessAuthIdentity <ServiceDataAccessAuthIdentity>] + [-Tag <IResourceBaseTags>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureDataLakeGen2Datastore. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureDataLakeGen2Datastore +```powershell +New-AzMLWorkspaceDatastoreDataLakeGen2Object +``` + +Create an in-memory object for AzureDataLakeGen2Datastore + +## PARAMETERS + +### -AccountName +[Required] Storage account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credentials +[Required] Account credentials. +To construct, see NOTES section for CREDENTIALS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IDatastoreCredentials +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +Azure cloud endpoint for the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filesystem +[Required] The name of the Data Lake Gen2 filesystem. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +The asset property dictionary. +To construct, see NOTES section for PROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol used to communicate with the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceDataAccessAuthIdentity +Indicates which identity to use to authenticate service data access to customer's storage. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ServiceDataAccessAuthIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. +To construct, see NOTES section for TAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.AzureDataLakeGen2Datastore + +## 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. + + +CREDENTIALS `<IDatastoreCredentials>`: [Required] Account credentials. + - `CredentialsType <CredentialsType>`: [Required] Credential type used to authentication with storage. + +PROPERTY `<IResourceBaseProperties>`: The asset property dictionary. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +TAG `<IResourceBaseTags>`: Tag dictionary. Tags can be added, removed, and updated. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreFileObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreFileObject.md new file mode 100644 index 0000000000..d910473952 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreFileObject.md @@ -0,0 +1,186 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatastorefileobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreFileObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreFileObject.md +--- + +# New-AzMLWorkspaceDatastoreFileObject + +## SYNOPSIS +Create an in-memory object for AzureFileDatastore. + +## SYNTAX + +``` +New-AzMLWorkspaceDatastoreFileObject -AccountName <String> -FileShareName <String> [-Description <String>] + [-Endpoint <String>] [-Property <IResourceBaseProperties>] [-Protocol <String>] + [-ServiceDataAccessAuthIdentity <ServiceDataAccessAuthIdentity>] [-Tag <IResourceBaseTags>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureFileDatastore. + +## EXAMPLES + +### Example 1: Create an in-memory object for AzureFileDatastore +```powershell +New-AzMLWorkspaceDatastoreFileObject +``` + +Create an in-memory object for AzureFileDatastore + +## PARAMETERS + +### -AccountName +[Required] Storage account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +Azure cloud endpoint for the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileShareName +[Required] The name of the Azure file share that the datastore points to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +The asset property dictionary. +To construct, see NOTES section for PROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol used to communicate with the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceDataAccessAuthIdentity +Indicates which identity to use to authenticate service data access to customer's storage. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ServiceDataAccessAuthIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. +To construct, see NOTES section for TAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.AzureFileDatastore + +## 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 `<IResourceBaseProperties>`: The asset property dictionary. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +TAG `<IResourceBaseTags>`: Tag dictionary. Tags can be added, removed, and updated. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreKeyCredentialObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreKeyCredentialObject.md new file mode 100644 index 0000000000..4ff99565e0 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreKeyCredentialObject.md @@ -0,0 +1,64 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatastorekeycredentialobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreKeyCredentialObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreKeyCredentialObject.md +--- + +# New-AzMLWorkspaceDatastoreKeyCredentialObject + +## SYNOPSIS +Create an in-memory object for AccountKeyDatastoreCredentials. + +## SYNTAX + +``` +New-AzMLWorkspaceDatastoreKeyCredentialObject -Key <String> [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AccountKeyDatastoreCredentials. + +## EXAMPLES + +### Example 1: Create an in-memory object for AccountKeyDatastoreCredentials +```powershell +New-AzMLWorkspaceDatastoreKeyCredentialObject +``` + +Create an in-memory object for AccountKeyDatastoreCredentials + +## PARAMETERS + +### -Key +[Required] Storage account key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.AccountKeyDatastoreCredentials + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreNoneCredentialObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreNoneCredentialObject.md new file mode 100644 index 0000000000..db3a1e65ac --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreNoneCredentialObject.md @@ -0,0 +1,49 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatastorenonecredentialobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreNoneCredentialObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreNoneCredentialObject.md +--- + +# New-AzMLWorkspaceDatastoreNoneCredentialObject + +## SYNOPSIS +Create an in-memory object for NoneDatastoreCredentials. + +## SYNTAX + +``` +New-AzMLWorkspaceDatastoreNoneCredentialObject [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for NoneDatastoreCredentials. + +## EXAMPLES + +### Example 1: Create an in-memory object for NoneDatastoreCredentials +```powershell +New-AzMLWorkspaceDatastoreNoneCredentialObject +``` + +Create an in-memory object for NoneDatastoreCredentials + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.NoneDatastoreCredentials + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreSasCredentialObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreSasCredentialObject.md new file mode 100644 index 0000000000..5078383340 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreSasCredentialObject.md @@ -0,0 +1,64 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatastoresascredentialobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreSasCredentialObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreSasCredentialObject.md +--- + +# New-AzMLWorkspaceDatastoreSasCredentialObject + +## SYNOPSIS +Create an in-memory object for SasDatastoreCredentials. + +## SYNTAX + +``` +New-AzMLWorkspaceDatastoreSasCredentialObject -SasToken <String> [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SasDatastoreCredentials. + +## EXAMPLES + +### Example 1: Create an in-memory object for SasDatastoreCredentials +```powershell +New-AzMLWorkspaceDatastoreSasCredentialObject +``` + +Create an in-memory object for SasDatastoreCredentials + +## PARAMETERS + +### -SasToken +[Required] Storage container secrets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.SasDatastoreCredentials + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreServicePrincipalCredentialObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreServicePrincipalCredentialObject.md new file mode 100644 index 0000000000..6d581b6816 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceDatastoreServicePrincipalCredentialObject.md @@ -0,0 +1,125 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacedatastoreserviceprincipalcredentialobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreServicePrincipalCredentialObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceDatastoreServicePrincipalCredentialObject.md +--- + +# New-AzMLWorkspaceDatastoreServicePrincipalCredentialObject + +## SYNOPSIS +Create an in-memory object for ServicePrincipalDatastoreCredentials. + +## SYNTAX + +``` +New-AzMLWorkspaceDatastoreServicePrincipalCredentialObject -ClientId <String> -ClientSecret <String> + -TenantId <String> [-AuthorityUrl <String>] [-ResourceUrl <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ServicePrincipalDatastoreCredentials. + +## EXAMPLES + +### Example 1: Create an in-memory object for ServicePrincipalDatastoreCredentials +```powershell +New-AzMLWorkspaceDatastoreServicePrincipalCredentialObject +``` + +Create an in-memory object for ServicePrincipalDatastoreCredentials + +## PARAMETERS + +### -AuthorityUrl +Authority URL used for authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientId +[Required] Service principal client ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientSecret +[Required] Service principal secret. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUrl +Resource the service principal has access to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +[Required] ID of the tenant to which the service principal belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ServicePrincipalDatastoreCredentials + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceEnvironmentVersion.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceEnvironmentVersion.md new file mode 100644 index 0000000000..88f9aa7c6d --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceEnvironmentVersion.md @@ -0,0 +1,426 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspaceenvironmentversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceEnvironmentVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceEnvironmentVersion.md +--- + +# New-AzMLWorkspaceEnvironmentVersion + +## SYNOPSIS +Creates or updates an EnvironmentVersion. + +## SYNTAX + +``` +New-AzMLWorkspaceEnvironmentVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-BuildContextUri <String>] + [-BuildDockerfilePath <String>] [-CondaFile <String>] [-Description <String>] [-Image <String>] [-IsAnonymou] + [-IsArchived] [-LivenessRoutePath <String>] [-LivenessRoutePort <Int32>] [-OSType <OperatingSystemType>] + [-ReadinessRoutePath <String>] [-ReadinessRoutePort <Int32>] [-ResourceBaseProperty <Hashtable>] + [-ScoringRoutePath <String>] [-ScoringRoutePort <Int32>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an EnvironmentVersion. + +## EXAMPLES + +### Example 1: Creates or updates an EnvironmentVersion. +```powershell +New-AzMLWorkspaceEnvironmentVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name commandjobenv -Version 1 -Image "library/python:latest" +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +1 5/31/2022 8:28:35 AM Lucas Yao (Wicresoft North America) User 5/31/2022 8:28:35 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Creates or updates an EnvironmentVersion. + +## PARAMETERS + +### -BuildContextUri +[Required] URI of the Docker build context used to build the image. +Supports blob URIs on environment creation and may return blob or Git URIs.\<seealso href="https://docs.docker.com/engine/reference/commandline/build/#extended-description" /\> + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BuildDockerfilePath +Path to the Dockerfile in the build context.\<seealso href="https://docs.docker.com/engine/reference/builder/" /\> + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CondaFile +Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.\<see href="https://repo2docker.readthedocs.io/en/latest/config_files.html#environment-yml-install-a-conda-environment" /\> + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Image +Name of the image that will be used for the environment.\<seealso href="https://learn.microsoft.com/en-us/azure/machine-learning/how-to-deploy-custom-docker-image#use-a-custom-base-image" /\> + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAnonymou +If the name version are system generated (anonymous registration). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchived +Is the asset archived + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessRoutePath +[Required] The path for the route. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessRoutePort +[Required] The port for the route. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of EnvironmentVersion. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSType +The OS type of the environment. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.OperatingSystemType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessRoutePath +[Required] The path for the route. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessRoutePort +[Required] The port for the route. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceBaseProperty +The asset property dictionary. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScoringRoutePath +[Required] The path for the route. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScoringRoutePort +[Required] The port for the route. + +```yaml +Type: System.Int32 +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version of EnvironmentVersion. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IEnvironmentVersion + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceHDInsightObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceHDInsightObject.md new file mode 100644 index 0000000000..faf9733ecf --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceHDInsightObject.md @@ -0,0 +1,187 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacehdinsightobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceHDInsightObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceHDInsightObject.md +--- + +# New-AzMLWorkspaceHDInsightObject + +## SYNOPSIS +Create an in-memory object for HDInsight. + +## SYNTAX + +``` +New-AzMLWorkspaceHDInsightObject [-Address <String>] [-AdministratorAccountPassword <String>] + [-AdministratorAccountPrivateKeyData <String>] [-AdministratorAccountPublicKeyData <String>] + [-AdministratorAccountUsername <String>] [-Description <String>] [-DisableLocalAuth <Boolean>] + [-ResourceId <String>] [-SshPort <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for HDInsight. + +## EXAMPLES + +### Example 1: Create an in-memory object for HDInsight +```powershell +New-AzMLWorkspaceHDInsightObject +``` + +Create an in-memory object for HDInsight + +## PARAMETERS + +### -Address +Public IP address of the master node of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorAccountPassword +Password of admin account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorAccountPrivateKeyData +Private key data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorAccountPublicKeyData +Public key data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorAccountUsername +Username of admin account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ARM resource id of the underlying compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshPort +Port open for ssh connections on the master node of the cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.HdInsight + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceJob.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceJob.md new file mode 100644 index 0000000000..2f279d717e --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceJob.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacejob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceJob.md +--- + +# New-AzMLWorkspaceJob + +## SYNOPSIS +Creates and executes a Job. + +## SYNTAX + +``` +New-AzMLWorkspaceJob -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + -Job <IJobBaseProperties> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates and executes a Job. + +## EXAMPLES + +### Example 1: Creates and executes a Job +```powershell +# The job type includes CommandJob, SweepJob, PipelineJob. +# You can use following command to create it then pass it as value to Job parameter of the New-AzMLWorkspaceJob cmdlet. +# New-AzMLWorkspaceCommandJobObject +# New-AzMLWorkspaceSweepJobObject +# New-AzMLWorkspacePipelineJobObject + +New-AzMLWorkspaceEnvironmentVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name commandjobenv -Version 1 -Image "library/python:latest" +$commandJob = New-AzMLWorkspaceCommandJobObject -Command "echo `"hello world`"" ` +-ComputeId '/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-test01/computes/aml02' ` +-EnvironmentId '/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-test01/environments/commandjobenv/versions/1'` +-DisplayName 'commandjob01' -ExperimentName 'commandjobexperiment' +New-AzMLWorkspaceJob -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name commandJob01 -Job $commandJob +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +commandJob01 5/31/2022 7:58:38 AM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Creates and executes a Job + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Job +[Required] Additional attributes of the entity. +To construct, see NOTES section for JOB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IJobBaseProperties +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name and identifier for the Job. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IJobBase + +## 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. + + +JOB `<IJobBaseProperties>`: [Required] Additional attributes of the entity. + - `JobType <JobType>`: [Required] Specifies the type of job. + - `[Description <String>]`: The asset description text. + - `[Property <IResourceBaseProperties>]`: The asset property dictionary. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[Tag <IResourceBaseTags>]`: Tag dictionary. Tags can be added, removed, and updated. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[ComputeId <String>]`: ARM resource ID of the compute resource. + - `[DisplayName <String>]`: Display name of job. + - `[ExperimentName <String>]`: The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. + - `[IdentityType <IdentityConfigurationType?>]`: [Required] Specifies the type of identity framework. + - `[IsArchived <Boolean?>]`: Is the asset archived? + - `[Service <IJobBaseServices>]`: List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject. + - `[(Any) <IJobService>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceJobServiceObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceJobServiceObject.md new file mode 100644 index 0000000000..234d53f75a --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceJobServiceObject.md @@ -0,0 +1,119 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacejobserviceobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceJobServiceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceJobServiceObject.md +--- + +# New-AzMLWorkspaceJobServiceObject + +## SYNOPSIS +Create an in-memory object for JobService. + +## SYNTAX + +``` +New-AzMLWorkspaceJobServiceObject [-Endpoint <String>] [-Port <Int32>] [-Property <IJobServiceProperties>] + [-Type <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for JobService. + +## EXAMPLES + +### Example 1: Create an in-memory object for JobService +```powershell +New-AzMLWorkspaceJobServiceObject +``` + +Create an in-memory object for JobService + +## PARAMETERS + +### -Endpoint +Url for endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Port for endpoint. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +Additional properties to set on the endpoint. +To construct, see NOTES section for PROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IJobServiceProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Endpoint type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.JobService + +## 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 `<IJobServiceProperties>`: Additional properties to set on the endpoint. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceKubernetesObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceKubernetesObject.md new file mode 100644 index 0000000000..3ca57a18b4 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceKubernetesObject.md @@ -0,0 +1,252 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacekubernetesobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceKubernetesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceKubernetesObject.md +--- + +# New-AzMLWorkspaceKubernetesObject + +## SYNOPSIS +Create an in-memory object for Kubernetes. + +## SYNTAX + +``` +New-AzMLWorkspaceKubernetesObject [-DefaultInstanceType <String>] [-Description <String>] + [-DisableLocalAuth <Boolean>] [-ExtensionInstanceReleaseTrain <String>] [-ExtensionPrincipalId <String>] + [-InstanceLimit <Hashtable>] [-InstanceNodeSelector <Hashtable>] [-InstanceRequest <Hashtable>] + [-Namespace <String>] [-RelayConnectionString <String>] [-ResourceId <String>] + [-ServiceBusConnectionString <String>] [-VcName <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for Kubernetes. + +## EXAMPLES + +### Example 1: Create an in-memory object for Kubernetes +```powershell +New-AzMLWorkspaceKubernetesObject +``` + +```output +{{ Add output here }} +``` + +Create an in-memory object for Kubernetes + +## PARAMETERS + +### -DefaultInstanceType +Default instance type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionInstanceReleaseTrain +Extension instance release train. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionPrincipalId +Extension principal-id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceLimit +Resource limits for this instance type. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceNodeSelector +Node Selector. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceRequest +Resource requests for this instance type. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Compute namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RelayConnectionString +Relay connection string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ARM resource id of the underlying compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceBusConnectionString +ServiceBus connection string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VcName +VC name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.Kubernetes + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceLiteralJobInputObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceLiteralJobInputObject.md new file mode 100644 index 0000000000..9618bb4fda --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceLiteralJobInputObject.md @@ -0,0 +1,95 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspaceliteraljobinputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceLiteralJobInputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceLiteralJobInputObject.md +--- + +# New-AzMLWorkspaceLiteralJobInputObject + +## SYNOPSIS +Create an in-memory object for LiteralJobInput. + +## SYNTAX + +``` +New-AzMLWorkspaceLiteralJobInputObject -Type <JobInputType> -Value <String> [-Description <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for LiteralJobInput. + +## EXAMPLES + +### Example 1: Create an in-memory object for LiteralJobInput +```powershell +New-AzMLWorkspaceLiteralJobInputObject +``` + +Create an in-memory object for LiteralJobInput + +## PARAMETERS + +### -Description +Description for the input. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +[Required] Specifies the type of job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobInputType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +[Required] Literal value for the input. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.LiteralJobInput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceMLFlowModelJobInputObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceMLFlowModelJobInputObject.md new file mode 100644 index 0000000000..bf26be18c8 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceMLFlowModelJobInputObject.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacemlflowmodeljobinputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceMLFlowModelJobInputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceMLFlowModelJobInputObject.md +--- + +# New-AzMLWorkspaceMLFlowModelJobInputObject + +## SYNOPSIS +Create an in-memory object for MLFlowModelJobInput. + +## SYNTAX + +``` +New-AzMLWorkspaceMLFlowModelJobInputObject -Type <JobInputType> -Uri <String> [-Description <String>] + [-Mode <InputDeliveryMode>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for MLFlowModelJobInput. + +## EXAMPLES + +### Example 1: Create an in-memory object for MLFlowModelJobInput +```powershell +New-AzMLWorkspaceMLFlowModelJobInputObject +``` + +Create an in-memory object for MLFlowModelJobInput + +## PARAMETERS + +### -Description +Description for the input. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Input Asset Delivery Mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.InputDeliveryMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +[Required] Specifies the type of job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobInputType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +[Required] Input Asset URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.MlFlowModelJobInput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceMLFlowModelJobOutputObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceMLFlowModelJobOutputObject.md new file mode 100644 index 0000000000..35bfde63b3 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceMLFlowModelJobOutputObject.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacemlflowmodeljoboutputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceMLFlowModelJobOutputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceMLFlowModelJobOutputObject.md +--- + +# New-AzMLWorkspaceMLFlowModelJobOutputObject + +## SYNOPSIS +Create an in-memory object for MLFlowModelJobOutput. + +## SYNTAX + +``` +New-AzMLWorkspaceMLFlowModelJobOutputObject -Type <JobOutputType> [-Description <String>] + [-Mode <OutputDeliveryMode>] [-Uri <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for MLFlowModelJobOutput. + +## EXAMPLES + +### Example 1: Create an in-memory object for MLFlowModelJobOutput +```powershell +New-AzMLWorkspaceMLFlowModelJobOutputObject +``` + +Create an in-memory object for MLFlowModelJobOutput + +## PARAMETERS + +### -Description +Description for the output. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Output Asset Delivery Mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.OutputDeliveryMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +[Required] Specifies the type of job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobOutputType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +Output Asset URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.MlFlowModelJobOutput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceMLTableJobInputObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceMLTableJobInputObject.md new file mode 100644 index 0000000000..d0c95a157f --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceMLTableJobInputObject.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacemltablejobinputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceMLTableJobInputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceMLTableJobInputObject.md +--- + +# New-AzMLWorkspaceMLTableJobInputObject + +## SYNOPSIS +Create an in-memory object for MLTableJobInput. + +## SYNTAX + +``` +New-AzMLWorkspaceMLTableJobInputObject -Type <JobInputType> -Uri <String> [-Description <String>] + [-Mode <InputDeliveryMode>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for MLTableJobInput. + +## EXAMPLES + +### Example 1: Create an in-memory object for MLTableJobInput +```powershell +New-AzMLWorkspaceMLTableJobInputObject +``` + +Create an in-memory object for MLTableJobInput + +## PARAMETERS + +### -Description +Description for the input. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Input Asset Delivery Mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.InputDeliveryMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +[Required] Specifies the type of job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobInputType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +[Required] Input Asset URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.MlTableJobInput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceMLTableJobOutputObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceMLTableJobOutputObject.md new file mode 100644 index 0000000000..cdcaf92202 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceMLTableJobOutputObject.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacemltablejoboutputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceMLTableJobOutputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceMLTableJobOutputObject.md +--- + +# New-AzMLWorkspaceMLTableJobOutputObject + +## SYNOPSIS +Create an in-memory object for MLTableJobOutput. + +## SYNTAX + +``` +New-AzMLWorkspaceMLTableJobOutputObject -Type <JobOutputType> [-Description <String>] + [-Mode <OutputDeliveryMode>] [-Uri <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for MLTableJobOutput. + +## EXAMPLES + +### Example 1: Create an in-memory object for MLTableJobOutput +```powershell +New-AzMLWorkspaceMLTableJobOutputObject +``` + +Create an in-memory object for MLTableJobOutput + +## PARAMETERS + +### -Description +Description for the output. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Output Asset Delivery Mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.OutputDeliveryMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +[Required] Specifies the type of job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobOutputType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +Output Asset URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.MlTableJobOutput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceModelContainer.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceModelContainer.md new file mode 100644 index 0000000000..b827a90b2e --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceModelContainer.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacemodelcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceModelContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceModelContainer.md +--- + +# New-AzMLWorkspaceModelContainer + +## SYNOPSIS +Create or update container. + +## SYNTAX + +``` +New-AzMLWorkspaceModelContainer -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-Description <String>] [-IsArchived] [-ResourceBaseProperty <Hashtable>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update container. + +## EXAMPLES + +### Example 1: Create or update model container +```powershell +New-AzMLWorkspaceModelContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name modelcontainerpwsh01 -Description "code container for test." +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +modelcontainerpwsh01 6/1/2022 4:04:12 PM Lucas Yao (Wicresoft North America) User 6/1/2022 4:04:12 PM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Create or update model container + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchived +Is the asset archived + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceBaseProperty +The asset property dictionary. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IModelContainer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceModelVersion.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceModelVersion.md new file mode 100644 index 0000000000..4857791777 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceModelVersion.md @@ -0,0 +1,320 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacemodelversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceModelVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceModelVersion.md +--- + +# New-AzMLWorkspaceModelVersion + +## SYNOPSIS +Create or update version. + +## SYNTAX + +``` +New-AzMLWorkspaceModelVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-Description <String>] [-Flavor <Hashtable>] + [-IsAnonymou] [-IsArchived] [-JobName <String>] [-ModelType <String>] [-ModelUri <String>] + [-ResourceBaseProperty <Hashtable>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update version. + +## EXAMPLES + +### Example 1: Create or update model version +```powershell +New-AzMLWorkspaceModelVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name modelcontainerpwsh01 -Version 1 -ModelType "mlflow_model" -ModelUri "azureml://subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/workspaces/mlworkspace-cli01/datastores/workspaceartifactstore/paths/ExperimentRun/dcid.plucky_collar_5x0ds0fgb3/model" +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +1 6/1/2022 4:29:14 PM Lucas Yao (Wicresoft North America) User 6/1/2022 4:29:14 PM Lucas Yao (Wicresoft North America) User ml-rg-test +``` + +Create or update model version + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Flavor +Mapping of model flavors to their properties. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAnonymou +If the name version are system generated (anonymous registration). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchived +Is the asset archived + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +Name of the training job which produced this model + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModelType +The storage format for this entity. +Used for NCD. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModelUri +The URI path to the model contents. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container name. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceBaseProperty +The asset property dictionary. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IModelVersion + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceOnlineDeployment.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceOnlineDeployment.md new file mode 100644 index 0000000000..c42d42c7cf --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceOnlineDeployment.md @@ -0,0 +1,760 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspaceonlinedeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceOnlineDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceOnlineDeployment.md +--- + +# New-AzMLWorkspaceOnlineDeployment + +## SYNOPSIS +Create or update Inference Endpoint Deployment (asynchronous). + +## SYNTAX + +``` +New-AzMLWorkspaceOnlineDeployment -EndpointName <String> -Name <String> -ResourceGroupName <String> + -WorkspaceName <String> -EndpointComputeType <EndpointComputeType> -Location <String> + [-SubscriptionId <String>] [-AppInsightsEnabled] [-CodeId <String>] [-CodeScoringScript <String>] + [-Description <String>] [-EndpointDeploymentPropertiesBaseProperty <Hashtable>] [-EnvironmentId <String>] + [-EnvironmentVariable <Hashtable>] [-IdentityType <ManagedServiceIdentityType>] + [-IdentityUserAssigned <Hashtable>] [-InstanceType <String>] [-Kind <String>] + [-LivenessProbeFailureThreshold <Int32>] [-LivenessProbeInitialDelay <TimeSpan>] + [-LivenessProbePeriod <TimeSpan>] [-LivenessProbeSuccessThreshold <Int32>] [-LivenessProbeTimeout <TimeSpan>] + [-Model <String>] [-ModelMountPath <String>] [-ReadinessProbeFailureThreshold <Int32>] + [-ReadinessProbeInitialDelay <TimeSpan>] [-ReadinessProbePeriod <TimeSpan>] + [-ReadinessProbeSuccessThreshold <Int32>] [-ReadinessProbeTimeout <TimeSpan>] + [-RequestMaxConcurrentPerInstance <Int32>] [-RequestMaxQueueWait <TimeSpan>] [-RequestTimeout <TimeSpan>] + [-ScaleType <ScaleType>] [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] + [-SkuTier <SkuTier>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update Inference Endpoint Deployment (asynchronous). + +## EXAMPLES + +### Example 1: Create or update Inference Endpoint Deployment (asynchronous) +```powershell +New-AzMLWorkspaceOnlineDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName online-pwsh01 -Name blue -Location "eastus" -EndpointComputeType 'Managed' ` +-CodeId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-cli01/codes/787fc793-1ac7-414e-a035-7248767b7b23/versions/1" -CodeScoringScript "score.py" ` +-EnvironmentId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-cli01/environments/CliV2AnonymousEnvironment/versions/8a424b013f5b0177929a1697d772da41" ` +-Model "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/ml-rg-test/providers/Microsoft.MachineLearningServices/workspaces/mlworkspace-cli01/models/a99089c5-23a6-4431-9ecd-37c70f01c9bc/versions/1" -InstanceType "Standard_F2s_v2" ` +-SkuName "Default" -SkuCapacity 1 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus blue 5/19/2022 2:52:06 AM Lucas Yao (Wicresoft North America) 5/19/2022 2:52:06 AM Managed ml-rg-test +``` + +Create or update Inference Endpoint Deployment (asynchronous) + +## PARAMETERS + +### -AppInsightsEnabled +If true, enables Application Insights logging. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CodeId +ARM resource ID of the code asset. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CodeScoringScript +[Required] The script to execute on startup. +eg. +"score.py" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the endpoint deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointComputeType +[Required] The compute type of the endpoint. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.EndpointComputeType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDeploymentPropertiesBaseProperty +Property dictionary. +Properties can be added, but not removed or altered. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Inference endpoint name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentId +ARM resource ID or AssetId of the environment specification for the endpoint deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentVariable +Environment variables configuration for the deployment. + +```yaml +Type: System.Collections.Hashtable +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssigned +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceType +Compute instance type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbeFailureThreshold +The number of failures to allow before returning an unhealthy status. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbeInitialDelay +The delay before the first probe in ISO 8601 format. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbePeriod +The length of time between probes in ISO 8601 format. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbeSuccessThreshold +The number of successful probes before returning a healthy status. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivenessProbeTimeout +The probe timeout in ISO 8601 format. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Model +The URI path to the model. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModelMountPath +The path to mount the model in custom container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Inference Endpoint Deployment name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbeFailureThreshold +The number of failures to allow before returning an unhealthy status. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbeInitialDelay +The delay before the first probe in ISO 8601 format. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbePeriod +The length of time between probes in ISO 8601 format. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbeSuccessThreshold +The number of successful probes before returning a healthy status. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadinessProbeTimeout +The probe timeout in ISO 8601 format. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestMaxConcurrentPerInstance +The number of maximum concurrent requests per node allowed per deployment. +Defaults to 1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestMaxQueueWait +The maximum amount of time a request will stay in the queue in ISO 8601 format.Defaults to 500ms. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestTimeout +The scoring timeout in ISO 8601 format.Defaults to 5000ms. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleType +[Required] Type of deployment scaling algorithm + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ScaleType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.SkuTier +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IOnlineDeployment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceOnlineEndpoint.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceOnlineEndpoint.md new file mode 100644 index 0000000000..4fcecdf5b6 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceOnlineEndpoint.md @@ -0,0 +1,462 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspaceonlineendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceOnlineEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceOnlineEndpoint.md +--- + +# New-AzMLWorkspaceOnlineEndpoint + +## SYNOPSIS +Create or update Online Endpoint (asynchronous). + +## SYNTAX + +``` +New-AzMLWorkspaceOnlineEndpoint -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + -AuthMode <EndpointAuthMode> -Location <String> [-SubscriptionId <String>] [-Compute <String>] + [-Description <String>] [-EndpointPropertiesBaseProperty <Hashtable>] + [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssigned <Hashtable>] [-KeyPrimaryKey <String>] + [-KeySecondaryKey <String>] [-Kind <String>] [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] + [-SkuSize <String>] [-SkuTier <SkuTier>] [-Tag <Hashtable>] [-Traffic <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update Online Endpoint (asynchronous). + +## EXAMPLES + +### Example 1: Create or update Online Endpoint (asynchronous) +```powershell +New-AzMLWorkspaceOnlineEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name online-cli01 -Location eastus -AuthMode 'Key' -IdentityType 'SystemAssigned' +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus online-cli01 5/19/2022 2:47:34 AM Lucas Yao (Wicresoft North America) 5/19/2022 2:48:26 AM Managed ml-rg-test +``` + +Create or update Online Endpoint (asynchronous) + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthMode +[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. +'Key' doesn't expire but 'AMLToken' does. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.EndpointAuthMode +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compute +ARM resource ID of the compute if it exists.optional + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the inference endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointPropertiesBaseProperty +Property dictionary. +Properties can be added, but not removed or altered. + +```yaml +Type: System.Collections.Hashtable +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssigned +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyPrimaryKey +The primary key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeySecondaryKey +The secondary key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Online Endpoint name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.SkuTier +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Traffic +Percentage of traffic from endpoint to divert to each deployment. +Traffic values need to sum to 100. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IOnlineEndpoint + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceOnlineEndpointKey.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceOnlineEndpointKey.md new file mode 100644 index 0000000000..98bdc0fa41 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceOnlineEndpointKey.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspaceonlineendpointkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceOnlineEndpointKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceOnlineEndpointKey.md +--- + +# New-AzMLWorkspaceOnlineEndpointKey + +## SYNOPSIS +Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous). + +## SYNTAX + +``` +New-AzMLWorkspaceOnlineEndpointKey -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + -KeyType <KeyType> [-SubscriptionId <String>] [-KeyValue <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous). + +## EXAMPLES + +### Example 1: Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous) +```powershell +New-AzMLWorkspaceOnlineEndpointKey -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name online-pwsh02 -KeyType 'Primary' +``` + +```output +PrimaryKey SecondaryKey +---------- ------------ +xxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous) + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyType +[Required] Specification for which type of key to generate. +Primary or Secondary. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.KeyType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyValue +The value the key is set to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Online Endpoint name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspacePipelineJobObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspacePipelineJobObject.md new file mode 100644 index 0000000000..8fcc9348de --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspacePipelineJobObject.md @@ -0,0 +1,342 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacepipelinejobobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspacePipelineJobObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspacePipelineJobObject.md +--- + +# New-AzMLWorkspacePipelineJobObject + +## SYNOPSIS +Create an in-memory object for PipelineJob. + +## SYNTAX + +``` +New-AzMLWorkspacePipelineJobObject [-ComputeId <String>] [-Description <String>] [-DisplayName <String>] + [-ExperimentName <String>] [-IdentityType <IdentityConfigurationType>] [-IsArchived <Boolean>] + [-Job <IPipelineJobJobs>] [-JobInput <IPipelineJobInputs>] [-JobOutput <IPipelineJobOutputs>] + [-Property <IResourceBaseProperties>] [-ServiceEndpoint <String>] [-ServicePort <Int32>] + [-ServiceProperty <IJobServiceProperties>] [-ServiceType <String>] [-Setting <IAny>] + [-Tag <IResourceBaseTags>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for PipelineJob. + +## EXAMPLES + +### Example 1: Create an in-memory object for PipelineJob +```powershell +# You can use following commands to create job input or job oupt as vaule pass to JobInput or JobOutput parameter of the New-AzMLWorkspacePipelineJobObject + +# New-AzMLWorkspaceCustomModelJobInputObject +# New-AzMLWorkspaceCustomModelJobOutputObject +# New-AzMLWorkspaceLiteralJobInputObject +# New-AzMLWorkspaceMLFlowModelJobInputObject +# New-AzMLWorkspaceMLFlowModelJobOutputObject +# New-AzMLWorkspaceMLTableJobInputObject +# New-AzMLWorkspaceMLTableJobOutputObject +# New-AzMLWorkspaceSharedPrivateLinkResourceObject +# New-AzMLWorkspaceTritonModelJobInputObject +# New-AzMLWorkspaceTritonModelJobOutputObject +# New-AzMLWorkspaceUriFileJobInputObject +# New-AzMLWorkspaceUriFileJobOutputObject +# New-AzMLWorkspaceUriFolderJobInputObject +# New-AzMLWorkspaceUriFolderJobOutputObject + +New-AzMLWorkspacePipelineJobObject +``` + +Create an in-memory object for PipelineJob + +## PARAMETERS + +### -ComputeId +ARM resource ID of the compute resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display name of job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExperimentName +The name of the experiment the job belongs to. +If not set, the job is placed in the "Default" experiment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +[Required] Specifies the type of identity framework. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.IdentityConfigurationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchived +Is the asset archived?. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Job +Jobs construct the Pipeline Job. +To construct, see NOTES section for JOB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IPipelineJobJobs +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobInput +Inputs for the pipeline job. +To construct, see NOTES section for JOBINPUT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IPipelineJobInputs +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobOutput +Outputs for the pipeline job. +To construct, see NOTES section for JOBOUTPUT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IPipelineJobOutputs +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +The asset property dictionary. +To construct, see NOTES section for PROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceEndpoint +Url for endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePort +Port for endpoint. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceProperty +Additional properties to set on the endpoint. +To construct, see NOTES section for SERVICEPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IJobServiceProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceType +Endpoint type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Setting +Pipeline settings, for things like ContinueRunOnStepFailure etc. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IAny +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. +To construct, see NOTES section for TAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.PipelineJob + +## 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. + + +JOB `<IPipelineJobJobs>`: Jobs construct the Pipeline Job. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + +JOBINPUT `<IPipelineJobInputs>`: Inputs for the pipeline job. + - `[(Any) <IJobInput>]`: This indicates any property can be added to this object. + +JOBOUTPUT `<IPipelineJobOutputs>`: Outputs for the pipeline job. + - `[(Any) <IJobOutput>]`: This indicates any property can be added to this object. + +PROPERTY `<IResourceBaseProperties>`: The asset property dictionary. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +SERVICEPROPERTY `<IJobServiceProperties>`: Additional properties to set on the endpoint. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +TAG `<IResourceBaseTags>`: Tag dictionary. Tags can be added, removed, and updated. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceQuotaPropertiesObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceQuotaPropertiesObject.md new file mode 100644 index 0000000000..ddb7749fda --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceQuotaPropertiesObject.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacequotapropertiesobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceQuotaPropertiesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceQuotaPropertiesObject.md +--- + +# New-AzMLWorkspaceQuotaPropertiesObject + +## SYNOPSIS +Create an in-memory object for QuotaBaseProperties. + +## SYNTAX + +``` +New-AzMLWorkspaceQuotaPropertiesObject [-Id <String>] [-Limit <Int64>] [-Type <String>] [-Unit <QuotaUnit>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for QuotaBaseProperties. + +## EXAMPLES + +### Example 1: Create an in-memory object for QuotaBaseProperties pass it to as value of Value parameter of Update-AzMLServiceQuota +```powershell +New-AzMLWorkspaceQuotaPropertiesObject +``` + +Create an in-memory object for QuotaBaseProperties + +## PARAMETERS + +### -Id +Specifies the resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Limit +The maximum permitted quota of the resource. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specifies the resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Unit +An enum describing the unit of quota measurement. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.QuotaUnit +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.QuotaBaseProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceSharedPrivateLinkResourceObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceSharedPrivateLinkResourceObject.md new file mode 100644 index 0000000000..6598506f3d --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceSharedPrivateLinkResourceObject.md @@ -0,0 +1,126 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacesharedprivatelinkresourceobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceSharedPrivateLinkResourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceSharedPrivateLinkResourceObject.md +--- + +# New-AzMLWorkspaceSharedPrivateLinkResourceObject + +## SYNOPSIS +Create an in-memory object for SharedPrivateLinkResource. + +## SYNTAX + +``` +New-AzMLWorkspaceSharedPrivateLinkResourceObject [-GroupId <String>] [-Name <String>] + [-PrivateLinkResourceId <String>] [-RequestMessage <String>] + [-Status <PrivateEndpointServiceConnectionStatus>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SharedPrivateLinkResource. + +## EXAMPLES + +### Example 1: Create an in-memory object for SharedPrivateLinkResource, pass it to as value of Value SharedPrivateLinkResource of New-AzMLWorkspace +```powershell +New-AzMLWorkspaceSharedPrivateLinkResourceObject +``` + +Create an in-memory object for SharedPrivateLinkResource + +## PARAMETERS + +### -GroupId +The private link resource group id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Unique name of the private link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkResourceId +The resource id that private link links to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestMessage +Request message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.PrivateEndpointServiceConnectionStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.SharedPrivateLinkResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceSweepJobObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceSweepJobObject.md new file mode 100644 index 0000000000..e349f49c0c --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceSweepJobObject.md @@ -0,0 +1,612 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacesweepjobobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceSweepJobObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceSweepJobObject.md +--- + +# New-AzMLWorkspaceSweepJobObject + +## SYNOPSIS +Create an in-memory object for SweepJob. + +## SYNTAX + +``` +New-AzMLWorkspaceSweepJobObject -ObjectiveGoal <Goal> -ObjectivePrimaryMetric <String> + -SamplingAlgorithmType <SamplingAlgorithmType> -SearchSpace <IAny> -TrialCommand <String> + -TrialEnvironmentId <String> [-ComputeId <String>] [-Description <String>] [-DisplayName <String>] + [-DistributionType <DistributionType>] [-EarlyTerminationDelayEvaluation <Int32>] + [-EarlyTerminationEvaluationInterval <Int32>] [-EarlyTerminationPolicyType <EarlyTerminationPolicyType>] + [-ExperimentName <String>] [-IdentityType <IdentityConfigurationType>] [-IsArchived <Boolean>] + [-JobInput <ISweepJobInputs>] [-JobOutput <ISweepJobOutputs>] [-LimitMaxConcurrentTrial <Int32>] + [-LimitMaxTotalTrial <Int32>] [-LimitTimeout <TimeSpan>] [-LimitTrialTimeout <TimeSpan>] + [-Property <IResourceBaseProperties>] [-ResourceInstanceCount <Int32>] [-ResourceInstanceType <String>] + [-ResourceProperty <IResourceConfigurationProperties>] [-ServiceEndpoint <String>] [-ServicePort <Int32>] + [-ServiceProperty <IJobServiceProperties>] [-ServiceType <String>] [-Tag <IResourceBaseTags>] + [-TrialCodeId <String>] [-TrialEnvironmentVariable <ITrialComponentEnvironmentVariables>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SweepJob. + +## EXAMPLES + +### Example 1: Create an in-memory object for SweepJob +```powershell +# You can use following commands to create job input or job oupt as vaule pass to JobInput or JobOutput parameter of the New-AzMLWorkspaceSweepJobObject + +# New-AzMLWorkspaceCustomModelJobInputObject +# New-AzMLWorkspaceCustomModelJobOutputObject +# New-AzMLWorkspaceLiteralJobInputObject +# New-AzMLWorkspaceMLFlowModelJobInputObject +# New-AzMLWorkspaceMLFlowModelJobOutputObject +# New-AzMLWorkspaceMLTableJobInputObject +# New-AzMLWorkspaceMLTableJobOutputObject +# New-AzMLWorkspaceSharedPrivateLinkResourceObject +# New-AzMLWorkspaceTritonModelJobInputObject +# New-AzMLWorkspaceTritonModelJobOutputObject +# New-AzMLWorkspaceUriFileJobInputObject +# New-AzMLWorkspaceUriFileJobOutputObject +# New-AzMLWorkspaceUriFolderJobInputObject +# New-AzMLWorkspaceUriFolderJobOutputObject + +New-AzMLWorkspaceSweepJobObject +``` + +Create an in-memory object for SweepJob + +## PARAMETERS + +### -ComputeId +ARM resource ID of the compute resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The asset description text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display name of job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionType +[Required] Specifies the type of distribution framework. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.DistributionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EarlyTerminationDelayEvaluation +Number of intervals by which to delay the first evaluation. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EarlyTerminationEvaluationInterval +Interval (number of runs) between policy evaluations. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EarlyTerminationPolicyType +[Required] Name of policy configuration. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.EarlyTerminationPolicyType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExperimentName +The name of the experiment the job belongs to. +If not set, the job is placed in the "Default" experiment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +[Required] Specifies the type of identity framework. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.IdentityConfigurationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchived +Is the asset archived?. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobInput +Mapping of input data bindings used in the job. +To construct, see NOTES section for JOBINPUT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ISweepJobInputs +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobOutput +Mapping of output data bindings used in the job. +To construct, see NOTES section for JOBOUTPUT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ISweepJobOutputs +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitMaxConcurrentTrial +Sweep Job max concurrent trials. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitMaxTotalTrial +Sweep Job max total trials. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitTimeout +The max run duration in ISO 8601 format, after which the job will be cancelled. +Only supports duration with precision as low as Seconds. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitTrialTimeout +Sweep Job Trial timeout value. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectiveGoal +[Required] Defines supported metric goals for hyperparameter tuning. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.Goal +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectivePrimaryMetric +[Required] Name of the metric to optimize. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +The asset property dictionary. +To construct, see NOTES section for PROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceInstanceCount +Optional number of instances or nodes used by the compute target. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceInstanceType +Optional type of VM used as supported by the compute target. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceProperty +Additional properties bag. +To construct, see NOTES section for RESOURCEPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceConfigurationProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamplingAlgorithmType +[Required] The algorithm used for generating hyperparameter values, along with configuration properties. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.SamplingAlgorithmType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchSpace +[Required] A dictionary containing each parameter and its distribution. +The dictionary key is the name of the parameter. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IAny +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceEndpoint +Url for endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePort +Port for endpoint. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceProperty +Additional properties to set on the endpoint. +To construct, see NOTES section for SERVICEPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IJobServiceProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceType +Endpoint type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tag dictionary. +Tags can be added, removed, and updated. +To construct, see NOTES section for TAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IResourceBaseTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrialCodeId +ARM resource ID of the code asset. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrialCommand +[Required] The command to execute on startup of the job. +eg. +"python train.py". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrialEnvironmentId +[Required] The ARM resource ID of the Environment specification for the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrialEnvironmentVariable +Environment variables included in the job. +To construct, see NOTES section for TRIALENVIRONMENTVARIABLE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ITrialComponentEnvironmentVariables +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.SweepJob + +## 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. + + +JOBINPUT `<ISweepJobInputs>`: Mapping of input data bindings used in the job. + - `[(Any) <IJobInput>]`: This indicates any property can be added to this object. + +JOBOUTPUT `<ISweepJobOutputs>`: Mapping of output data bindings used in the job. + - `[(Any) <IJobOutput>]`: This indicates any property can be added to this object. + +PROPERTY `<IResourceBaseProperties>`: The asset property dictionary. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +RESOURCEPROPERTY `<IResourceConfigurationProperties>`: Additional properties bag. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + +SERVICEPROPERTY `<IJobServiceProperties>`: Additional properties to set on the endpoint. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +TAG `<IResourceBaseTags>`: Tag dictionary. Tags can be added, removed, and updated. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +TRIALENVIRONMENTVARIABLE `<ITrialComponentEnvironmentVariables>`: Environment variables included in the job. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceSynapseSparkObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceSynapseSparkObject.md new file mode 100644 index 0000000000..1ddb437a39 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceSynapseSparkObject.md @@ -0,0 +1,294 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacesynapsesparkobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceSynapseSparkObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceSynapseSparkObject.md +--- + +# New-AzMLWorkspaceSynapseSparkObject + +## SYNOPSIS +Create an in-memory object for SynapseSpark. + +## SYNTAX + +``` +New-AzMLWorkspaceSynapseSparkObject [-AutoPausePropertyDelayInMinute <Int32>] + [-AutoPausePropertyEnabled <Boolean>] [-AutoScalePropertyEnabled <Boolean>] + [-AutoScalePropertyMaxNodeCount <Int32>] [-AutoScalePropertyMinNodeCount <Int32>] [-Description <String>] + [-DisableLocalAuth <Boolean>] [-NodeCount <Int32>] [-NodeSize <String>] [-NodeSizeFamily <String>] + [-PoolName <String>] [-ResourceGroup <String>] [-ResourceId <String>] [-SparkVersion <String>] + [-SubscriptionId <String>] [-WorkspaceName <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SynapseSpark. + +## EXAMPLES + +### Example 1: Create an in-memory object for SynapseSpark +```powershell +New-AzMLWorkspaceSynapseSparkObject +``` + +Create an in-memory object for SynapseSpark + +## PARAMETERS + +### -AutoPausePropertyDelayInMinute + + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoPausePropertyEnabled + + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoScalePropertyEnabled + + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoScalePropertyMaxNodeCount + + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoScalePropertyMinNodeCount + + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeCount +The number of compute nodes currently assigned to the compute. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeSize +Node size. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeSizeFamily +Node size family. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +Pool name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +Name of the resource group in which workspace is located. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ARM resource id of the underlying compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkVersion +Spark version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure subscription identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.SynapseSpark + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceTritonModelJobInputObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceTritonModelJobInputObject.md new file mode 100644 index 0000000000..005bf6103b --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceTritonModelJobInputObject.md @@ -0,0 +1,121 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacetritonmodeljobinputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceTritonModelJobInputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceTritonModelJobInputObject.md +--- + +# New-AzMLWorkspaceTritonModelJobInputObject + +## SYNOPSIS +Create an in-memory object for TritonModelJobInput. + +## SYNTAX + +``` +New-AzMLWorkspaceTritonModelJobInputObject -Type <JobInputType> -Uri <String> [-Description <String>] + [-Mode <InputDeliveryMode>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for TritonModelJobInput. + +## EXAMPLES + +### Example 1: Create an in-memory object for TritonModelJobInput +```powershell +New-AzMLWorkspaceTritonModelJobInputObject +``` + +Create an in-memory object for TritonModelJobInput + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -Description +Description for the input. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Input Asset Delivery Mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.InputDeliveryMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +[Required] Specifies the type of job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobInputType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +[Required] Input Asset URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.TritonModelJobInput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceTritonModelJobOutputObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceTritonModelJobOutputObject.md new file mode 100644 index 0000000000..206a99281d --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceTritonModelJobOutputObject.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacetritonmodeljoboutputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceTritonModelJobOutputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceTritonModelJobOutputObject.md +--- + +# New-AzMLWorkspaceTritonModelJobOutputObject + +## SYNOPSIS +Create an in-memory object for TritonModelJobOutput. + +## SYNTAX + +``` +New-AzMLWorkspaceTritonModelJobOutputObject -Type <JobOutputType> [-Description <String>] + [-Mode <OutputDeliveryMode>] [-Uri <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for TritonModelJobOutput. + +## EXAMPLES + +### Example 1: Create an in-memory object for TritonModelJobOutput +```powershell +New-AzMLWorkspaceTritonModelJobOutputObject +``` + +Create an in-memory object for TritonModelJobOutput + +## PARAMETERS + +### -Description +Description for the output. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Output Asset Delivery Mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.OutputDeliveryMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +[Required] Specifies the type of job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobOutputType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +Output Asset URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.TritonModelJobOutput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceUriFileJobInputObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceUriFileJobInputObject.md new file mode 100644 index 0000000000..e2a41bffa0 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceUriFileJobInputObject.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspaceurifilejobinputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceUriFileJobInputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceUriFileJobInputObject.md +--- + +# New-AzMLWorkspaceUriFileJobInputObject + +## SYNOPSIS +Create an in-memory object for UriFileJobInput. + +## SYNTAX + +``` +New-AzMLWorkspaceUriFileJobInputObject -Type <JobInputType> -Uri <String> [-Description <String>] + [-Mode <InputDeliveryMode>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for UriFileJobInput. + +## EXAMPLES + +### Example 1: Create an in-memory object for UriFileJobInput +```powershell +New-AzMLWorkspaceUriFileJobInputObject +``` + +Create an in-memory object for UriFileJobInput + +## PARAMETERS + +### -Description +Description for the input. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Input Asset Delivery Mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.InputDeliveryMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +[Required] Specifies the type of job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobInputType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +[Required] Input Asset URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.UriFileJobInput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceUriFileJobOutputObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceUriFileJobOutputObject.md new file mode 100644 index 0000000000..3ea00a19fa --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceUriFileJobOutputObject.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspaceurifilejoboutputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceUriFileJobOutputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceUriFileJobOutputObject.md +--- + +# New-AzMLWorkspaceUriFileJobOutputObject + +## SYNOPSIS +Create an in-memory object for UriFileJobOutput. + +## SYNTAX + +``` +New-AzMLWorkspaceUriFileJobOutputObject -Type <JobOutputType> [-Description <String>] + [-Mode <OutputDeliveryMode>] [-Uri <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for UriFileJobOutput. + +## EXAMPLES + +### Example 1: Create an in-memory object for UriFileJobOutput +```powershell +New-AzMLWorkspaceUriFileJobOutputObject +``` + +Create an in-memory object for UriFileJobOutput + +## PARAMETERS + +### -Description +Description for the output. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Output Asset Delivery Mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.OutputDeliveryMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +[Required] Specifies the type of job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobOutputType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +Output Asset URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.UriFileJobOutput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceUriFolderJobInputObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceUriFolderJobInputObject.md new file mode 100644 index 0000000000..6bdb404658 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceUriFolderJobInputObject.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspaceurifolderjobinputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceUriFolderJobInputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceUriFolderJobInputObject.md +--- + +# New-AzMLWorkspaceUriFolderJobInputObject + +## SYNOPSIS +Create an in-memory object for UriFolderJobInput. + +## SYNTAX + +``` +New-AzMLWorkspaceUriFolderJobInputObject -Type <JobInputType> -Uri <String> [-Description <String>] + [-Mode <InputDeliveryMode>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for UriFolderJobInput. + +## EXAMPLES + +### Example 1: Create an in-memory object for UriFolderJobInput +```powershell +New-AzMLWorkspaceUriFolderJobInputObject +``` + +Create an in-memory object for UriFolderJobInput + +## PARAMETERS + +### -Description +Description for the input. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Input Asset Delivery Mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.InputDeliveryMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +[Required] Specifies the type of job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobInputType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +[Required] Input Asset URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.UriFolderJobInput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceUriFolderJobOutputObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceUriFolderJobOutputObject.md new file mode 100644 index 0000000000..5684947b49 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceUriFolderJobOutputObject.md @@ -0,0 +1,110 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspaceurifolderjoboutputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceUriFolderJobOutputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceUriFolderJobOutputObject.md +--- + +# New-AzMLWorkspaceUriFolderJobOutputObject + +## SYNOPSIS +Create an in-memory object for UriFolderJobOutput. + +## SYNTAX + +``` +New-AzMLWorkspaceUriFolderJobOutputObject -Type <JobOutputType> [-Description <String>] + [-Mode <OutputDeliveryMode>] [-Uri <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for UriFolderJobOutput. + +## EXAMPLES + +### Example 1: Create an in-memory object for UriFolderJobOutput +```powershell +New-AzMLWorkspaceUriFolderJobOutputObject +``` + +Create an in-memory object for UriFolderJobOutput + +## PARAMETERS + +### -Description +Description for the output. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Output Asset Delivery Mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.OutputDeliveryMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +[Required] Specifies the type of job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.JobOutputType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +Output Asset URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.UriFolderJobOutput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceVirtualMachineObject.md b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceVirtualMachineObject.md new file mode 100644 index 0000000000..bb9fab8281 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/New-AzMLWorkspaceVirtualMachineObject.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/new-azmlworkspacevirtualmachineobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceVirtualMachineObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/New-AzMLWorkspaceVirtualMachineObject.md +--- + +# New-AzMLWorkspaceVirtualMachineObject + +## SYNOPSIS +Create an in-memory object for VirtualMachine. + +## SYNTAX + +``` +New-AzMLWorkspaceVirtualMachineObject [-Address <String>] [-AdministratorAccountPassword <String>] + [-AdministratorAccountPrivateKeyData <String>] [-AdministratorAccountPublicKeyData <String>] + [-AdministratorAccountUsername <String>] [-Description <String>] [-DisableLocalAuth <Boolean>] + [-IsNotebookInstanceCompute <Boolean>] [-NotebookServerPort <Int32>] [-ResourceId <String>] [-Size <String>] + [-SshPort <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for VirtualMachine. + +## EXAMPLES + +### Example 1: Create an in-memory object for VirtualMachine +```powershell +New-AzMLWorkspaceVirtualMachineObject +``` + +Create an in-memory object for VirtualMachine + +## PARAMETERS + +### -Address +Public IP address of the virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorAccountPassword +Password of admin account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorAccountPrivateKeyData +Private key data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorAccountPublicKeyData +Public key data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorAccountUsername +Username of admin account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsNotebookInstanceCompute +Indicates whether this compute will be used for running notebooks. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotebookServerPort +Notebook server port open for ssh connections. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ARM resource id of the underlying compute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Size +Virtual Machine size. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshPort +Port open for ssh connections. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.VirtualMachine + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspace.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspace.md new file mode 100644 index 0000000000..a1be4c943d --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspace.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspace.md +--- + +# Remove-AzMLWorkspace + +## SYNOPSIS +Deletes a machine learning workspace. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspace -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a machine learning workspace. + +## EXAMPLES + +### Example 1: Deletes a machine learning workspace +```powershell +Remove-AzMLWorkspace -ResourceGroupName ml-rg-test -Name mlworkspace-test01 -Tag @{'key1' = 'value2'} +``` + +Deletes a machine learning workspace + +### Example 2: Deletes a machine learning workspace by pipeline +```powershell +Get-AzMLWorkspace -ResourceGroupName ml-rg-test -Name mlworkspace-test01 | Remove-AzMLWorkspace -Tag @{'key1' = 'value2'} +``` + +Deletes a machine learning workspace by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceBatchDeployment.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceBatchDeployment.md new file mode 100644 index 0000000000..e5ada0205e --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceBatchDeployment.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspacebatchdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceBatchDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceBatchDeployment.md +--- + +# Remove-AzMLWorkspaceBatchDeployment + +## SYNOPSIS +Delete Batch Inference deployment (asynchronous). + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceBatchDeployment -EndpointName <String> -Name <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceBatchDeployment -InputObject <IMachineLearningServicesIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete Batch Inference deployment (asynchronous). + +## EXAMPLES + +### Example 1: Delete Batch Inference deployment (asynchronous) +```powershell +Remove-AzMLWorkspaceBatchDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName batch-pwsh03 -Name nonmlflowdp +``` + +Delete Batch Inference deployment (asynchronous) + +### Example 2: Delete Batch Inference deployment (asynchronous) by pipeline +```powershell +Get-AzMLWorkspaceBatchDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName batch-pwsh03 -Name nonmlflowdp | Remove-AzMLWorkspaceBatchDeployment +``` + +Delete Batch Inference deployment (asynchronous) by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Endpoint name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Inference deployment identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceBatchEndpoint.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceBatchEndpoint.md new file mode 100644 index 0000000000..359c20b838 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceBatchEndpoint.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspacebatchendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceBatchEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceBatchEndpoint.md +--- + +# Remove-AzMLWorkspaceBatchEndpoint + +## SYNOPSIS +Delete Batch Inference Endpoint (asynchronous). + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceBatchEndpoint -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceBatchEndpoint -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete Batch Inference Endpoint (asynchronous). + +## EXAMPLES + +### Example 1: Delete Batch Inference Endpoint (asynchronous) +```powershell +Remove-AzMLWorkspaceBatchEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name batchpwsh01-key +``` + +Delete Batch Inference Endpoint (asynchronous) + +### Example 2: Delete Batch Inference Endpoint (asynchronous) by pipeline +```powershell +Get-AzMLWorkspaceBatchEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name batchpwsh01-key | Remove-AzMLWorkspaceBatchEndpoint +``` + +Delete Batch Inference Endpoint (asynchronous) by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Inference Endpoint name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceCodeVersion.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceCodeVersion.md new file mode 100644 index 0000000000..dcbd552e54 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceCodeVersion.md @@ -0,0 +1,242 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspacecodeversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceCodeVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceCodeVersion.md +--- + +# Remove-AzMLWorkspaceCodeVersion + +## SYNOPSIS +Delete version. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceCodeVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceCodeVersion -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete version. + +## EXAMPLES + +### Example 1: Delete Code version +```powershell +Remove-AzMLWorkspaceCodeVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name 'test01' -Version 1 +``` + +Delete Code version + +### Example 2: Delete Code version by pipeline +```powershell +Get-AzMLWorkspaceCodeVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name 'test01' -Version 1 | Remove-AzMLWorkspaceCodeVersion +``` + +Delete Code version by pipeline + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceComponentContainer.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceComponentContainer.md new file mode 100644 index 0000000000..5c21985d7a --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceComponentContainer.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspacecomponentcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceComponentContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceComponentContainer.md +--- + +# Remove-AzMLWorkspaceComponentContainer + +## SYNOPSIS +Delete container. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceComponentContainer -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceComponentContainer -InputObject <IMachineLearningServicesIdentity> + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete container. + +## EXAMPLES + +### Example 1: Delete component container +```powershell +Remove-AzMLWorkspaceComponentContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name component-pwsh01 +``` + +Delete component container + +### Example 2: Delete component container by pipeline +```powershell +Get-AzMLWorkspaceComponentContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name component-pwsh01 | Remove-AzMLWorkspaceComponentContainer +``` + +Delete component container by pipeline + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceComponentVersion.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceComponentVersion.md new file mode 100644 index 0000000000..29f5878f58 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceComponentVersion.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspacecomponentversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceComponentVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceComponentVersion.md +--- + +# Remove-AzMLWorkspaceComponentVersion + +## SYNOPSIS +Delete version. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceComponentVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceComponentVersion -InputObject <IMachineLearningServicesIdentity> + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete version. + +## EXAMPLES + +### Example 1: Delete component version +```powershell +Remove-AzMLWorkspaceComponentVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name componentpwsh01 -Version 1 +``` + +Delete component version + +### Example 2: Delete component version by pipeline +```powershell +Get-AzMLWorkspaceComponentVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name componentpwsh01 -Version 1 | Remove-AzMLWorkspaceComponentVersion +``` + +Delete component version by pipeline + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceCompute.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceCompute.md new file mode 100644 index 0000000000..7fd0c236ef --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceCompute.md @@ -0,0 +1,271 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspacecompute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceCompute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceCompute.md +--- + +# Remove-AzMLWorkspaceCompute + +## SYNOPSIS +Deletes specified Machine Learning compute. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceCompute -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + -UnderlyingResourceAction <UnderlyingResourceAction> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceCompute -InputObject <IMachineLearningServicesIdentity> + -UnderlyingResourceAction <UnderlyingResourceAction> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes specified Machine Learning compute. + +## EXAMPLES + +### Example 1: Deletes specified Machine Learning compute +```powershell +Remove-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name aml02 -UnderlyingResourceAction 'Delete' +``` + +Deletes specified Machine Learning compute + +### Example 2: Deletes specified Machine Learning compute by pipeline +```powershell +Get-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name aml02 | Remove-AzMLWorkspaceCompute -UnderlyingResourceAction 'Delete' +``` + +Deletes specified Machine Learning compute by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ComputeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnderlyingResourceAction +Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.UnderlyingResourceAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceConnection.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceConnection.md new file mode 100644 index 0000000000..9805324103 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceConnection.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspaceconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceConnection.md +--- + +# Remove-AzMLWorkspaceConnection + +## SYNOPSIS +Deletes a machine learning workspace connection. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceConnection -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceConnection -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a machine learning workspace connection. + +## EXAMPLES + +### Example 1: Delete a workspace connection +```powershell +Remove-AzMLWorkspaceConnection -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -ConnectionName test01 +``` + +Delete a workspace connection + +### Example 2: Delete a workspace connection by pipeline +```powershell +Get-AzMLWorkspaceConnection -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -ConnectionName test01 | Remove-AzMLWorkspaceConnection +``` + +Delete a workspace connection by pipeline + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Friendly name of the workspace connection + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceDataContainer.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceDataContainer.md new file mode 100644 index 0000000000..e69a314b64 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceDataContainer.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspacedatacontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceDataContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceDataContainer.md +--- + +# Remove-AzMLWorkspaceDataContainer + +## SYNOPSIS +Delete container. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceDataContainer -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceDataContainer -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete container. + +## EXAMPLES + +### Example 1: Delete data container +```powershell +Remove-AzMLWorkspaceDataContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name datacontainer-pwsh01 +``` + +Delete data container + +### Example 2: Delete data container by pipeline +```powershell +Get-AzMLWorkspaceDataContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name datacontainer-pwsh01 | Remove-AzMLWorkspaceDataContainer +``` + +Delete data container by pipeline + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceDataVersion.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceDataVersion.md new file mode 100644 index 0000000000..69812a2776 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceDataVersion.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspacedataversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceDataVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceDataVersion.md +--- + +# Remove-AzMLWorkspaceDataVersion + +## SYNOPSIS +Delete version. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceDataVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceDataVersion -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete version. + +## EXAMPLES + +### Example 1: Delete data version +```powershell +Remove-AzMLWorkspaceDataVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name iris-data -Version 2 +``` + +Delete data version + +### Example 2: Delete data version by pipeline +```powershell +Get-AzMLWorkspaceDataVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name iris-data -Version 2 | Remove-AzMLWorkspaceDataVersion +``` + +Delete data version by pipeline + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceDatastore.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceDatastore.md new file mode 100644 index 0000000000..1082b188cb --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceDatastore.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspacedatastore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceDatastore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceDatastore.md +--- + +# Remove-AzMLWorkspaceDatastore + +## SYNOPSIS +Delete datastore. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceDatastore -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceDatastore -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete datastore. + +## EXAMPLES + +### Example 1: Delete datastore by pipeline +```powershell +Remove-AzMLWorkspaceDatastore -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-demo -Name blobdatastore +``` + +Delete datastore + +### Example 2: Delete datastore by pipeline +```powershell +Get-AzMLWorkspaceDatastore -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-demo -Name blobdatastore | Remove-AzMLWorkspaceDatastore +``` + +Delete datastore + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Datastore name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceEnvironmentContainer.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceEnvironmentContainer.md new file mode 100644 index 0000000000..9fe74a1e0d --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceEnvironmentContainer.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspaceenvironmentcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceEnvironmentContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceEnvironmentContainer.md +--- + +# Remove-AzMLWorkspaceEnvironmentContainer + +## SYNOPSIS +Delete container. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceEnvironmentContainer -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceEnvironmentContainer -InputObject <IMachineLearningServicesIdentity> + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete container. + +## EXAMPLES + +### Example 1: Delete environment container +```powershell +Remove-AzMLWorkspaceEnvironmentContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name pwshenv01 +``` + +Delete environment container + +### Example 2: Delete environment container by pipeline +```powershell +Get-AzMLWorkspaceEnvironmentContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-portal01 -Name pwshenv01 | Remove-AzMLWorkspaceEnvironmentContainer +``` + +Delete environment container by pipeline + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceEnvironmentVersion.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceEnvironmentVersion.md new file mode 100644 index 0000000000..440ec38b65 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceEnvironmentVersion.md @@ -0,0 +1,242 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspaceenvironmentversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceEnvironmentVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceEnvironmentVersion.md +--- + +# Remove-AzMLWorkspaceEnvironmentVersion + +## SYNOPSIS +Delete version. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceEnvironmentVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceEnvironmentVersion -InputObject <IMachineLearningServicesIdentity> + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete version. + +## EXAMPLES + +### Example 1: Delete environment container version +```powershell +Remove-AzMLWorkspaceEnvironmentVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name commandjobenv +``` + +Delete environment container + +### Example 2: Delete environment container by pipeline +```powershell +Get-AzMLWorkspaceEnvironmentVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name commandjobenv | Remove-AzMLWorkspaceEnvironmentVersion +``` + +Delete environment container by pipeline + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceJob.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceJob.md new file mode 100644 index 0000000000..d701eff185 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceJob.md @@ -0,0 +1,256 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspacejob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceJob.md +--- + +# Remove-AzMLWorkspaceJob + +## SYNOPSIS +Deletes a Job (asynchronous). + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceJob -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceJob -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Job (asynchronous). + +## EXAMPLES + +### Example 1: Deletes a Job (asynchronous) +```powershell +Remove-AzMLWorkspaceJob -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name commandJob01 +``` + +Deletes a Job (asynchronous) + +### Example 2: Deletes a Job (asynchronous) by pipeline +```powershell +Get-AzMLWorkspaceJob -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name commandJob01 | Remove-AzMLWorkspaceJob +``` + +Deletes a Job (asynchronous) by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name and identifier for the Job. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceModelContainer.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceModelContainer.md new file mode 100644 index 0000000000..8d490e3c62 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceModelContainer.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspacemodelcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceModelContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceModelContainer.md +--- + +# Remove-AzMLWorkspaceModelContainer + +## SYNOPSIS +Delete container. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceModelContainer -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceModelContainer -InputObject <IMachineLearningServicesIdentity> + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete container. + +## EXAMPLES + +### Example 1: Delete model container +```powershell +Remove-AzMLWorkspaceModelContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name modelcontainerpwsh01 +``` + +Delete model container + +### Example 2: Delete model container by pipeline +```powershell +Get-AzMLWorkspaceModelContainer -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name modelcontainerpwsh01 | Remove-AzMLWorkspaceModelContainer +``` + +Delete model container by pipeline + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceModelVersion.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceModelVersion.md new file mode 100644 index 0000000000..2d9c9e38e5 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceModelVersion.md @@ -0,0 +1,242 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspacemodelversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceModelVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceModelVersion.md +--- + +# Remove-AzMLWorkspaceModelVersion + +## SYNOPSIS +Delete version. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceModelVersion -Name <String> -ResourceGroupName <String> -Version <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceModelVersion -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete version. + +## EXAMPLES + +### Example 1: Delete model version +```powershell +Remove-AzMLWorkspaceModelVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name modelcontainerpwsh01 -Version 1 +``` + +Delete model version + +### Example 2: Delete model version by pipeline +```powershell +Get-AzMLWorkspaceModelVersion -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name modelcontainerpwsh01 -Version 1 | Remove-AzMLWorkspaceModelVersion +``` + +Delete model version by pipeline + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Container name. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version identifier. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceOnlineDeployment.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceOnlineDeployment.md new file mode 100644 index 0000000000..4282bf98ee --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceOnlineDeployment.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspaceonlinedeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceOnlineDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceOnlineDeployment.md +--- + +# Remove-AzMLWorkspaceOnlineDeployment + +## SYNOPSIS +Delete Inference Endpoint Deployment (asynchronous). + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceOnlineDeployment -EndpointName <String> -Name <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceOnlineDeployment -InputObject <IMachineLearningServicesIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete Inference Endpoint Deployment (asynchronous). + +## EXAMPLES + +### Example 1: Delete Inference Endpoint Deployment (asynchronous) +```powershell +Remove-AzMLWorkspaceOnlineDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName online-pwsh01 -Name pwshblue01 +``` + +Delete Inference Endpoint Deployment (asynchronous) + +### Example 2: Delete Inference Endpoint Deployment (asynchronous) by pipeline +```powershell +Get-AzMLWorkspaceOnlineDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName online-pwsh01 -Name pwshblue01 | Remove-AzMLWorkspaceOnlineDeployment +``` + +Delete Inference Endpoint Deployment (asynchronous) by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Inference endpoint name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Inference Endpoint Deployment name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceOnlineEndpoint.md b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceOnlineEndpoint.md new file mode 100644 index 0000000000..bf1dd805fb --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Remove-AzMLWorkspaceOnlineEndpoint.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/remove-azmlworkspaceonlineendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceOnlineEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Remove-AzMLWorkspaceOnlineEndpoint.md +--- + +# Remove-AzMLWorkspaceOnlineEndpoint + +## SYNOPSIS +Delete Online Endpoint (asynchronous). + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMLWorkspaceOnlineEndpoint -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMLWorkspaceOnlineEndpoint -InputObject <IMachineLearningServicesIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete Online Endpoint (asynchronous). + +## EXAMPLES + +### Example 1: Delete Online Endpoint (asynchronous) +```powershell +Remove-AzMLWorkspaceOnlineEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name online-pwsh01 +``` + +Delete Online Endpoint (asynchronous) + +### Example 2: Delete Online Endpoint (asynchronous) by pipeline +```powershell +Get-AzMLWorkspaceOnlineEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name online-pwsh01 | Remove-AzMLWorkspaceOnlineEndpoint +``` + +Delete Online Endpoint (asynchronous) by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Online Endpoint name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Restart-AzMLWorkspaceCompute.md b/azps-10.1.0/Az.MachineLearningServices/Restart-AzMLWorkspaceCompute.md new file mode 100644 index 0000000000..387d25bf54 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Restart-AzMLWorkspaceCompute.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/restart-azmlworkspacecompute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Restart-AzMLWorkspaceCompute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Restart-AzMLWorkspaceCompute.md +--- + +# Restart-AzMLWorkspaceCompute + +## SYNOPSIS +Posts a restart action to a compute instance + +## SYNTAX + +### Restart (Default) +``` +Restart-AzMLWorkspaceCompute -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### RestartViaIdentity +``` +Restart-AzMLWorkspaceCompute -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Posts a restart action to a compute instance + +## EXAMPLES + +### Example 1: Posts a restart action to a compute instance +```powershell +Restart-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name compute02 +``` + +Posts a restart action to a compute instance + +### Example 2: Posts a restart action to a compute instance by pipeline +```powershell +Get-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name compute02 | Restart-AzMLWorkspaceCompute +``` + +Posts a restart action to a compute instance by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: ComputeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Start-AzMLWorkspaceCompute.md b/azps-10.1.0/Az.MachineLearningServices/Start-AzMLWorkspaceCompute.md new file mode 100644 index 0000000000..4b4b5d1289 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Start-AzMLWorkspaceCompute.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/start-azmlworkspacecompute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Start-AzMLWorkspaceCompute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Start-AzMLWorkspaceCompute.md +--- + +# Start-AzMLWorkspaceCompute + +## SYNOPSIS +Posts a start action to a compute instance + +## SYNTAX + +### Start (Default) +``` +Start-AzMLWorkspaceCompute -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzMLWorkspaceCompute -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Posts a start action to a compute instance + +## EXAMPLES + +### Example 1: Posts a start action to a compute instance +```powershell +Start-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name compute02 +``` + +Posts a start action to a compute instance + +### Example 2: Posts a start action to a compute instance by pipeline +```powershell +Get-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name compute02 | Start-AzMLWorkspaceCompute +``` + +Posts a start action to a compute instance by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: ComputeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Stop-AzMLWorkspaceCompute.md b/azps-10.1.0/Az.MachineLearningServices/Stop-AzMLWorkspaceCompute.md new file mode 100644 index 0000000000..fac6b0dcc2 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Stop-AzMLWorkspaceCompute.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/stop-azmlworkspacecompute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Stop-AzMLWorkspaceCompute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Stop-AzMLWorkspaceCompute.md +--- + +# Stop-AzMLWorkspaceCompute + +## SYNOPSIS +Posts a stop action to a compute instance + +## SYNTAX + +### Stop (Default) +``` +Stop-AzMLWorkspaceCompute -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzMLWorkspaceCompute -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Posts a stop action to a compute instance + +## EXAMPLES + +### Example 1: Posts a stop action to a compute instance +```powershell +Stop-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name compute02 +``` + +Posts a stop action to a compute instance + +### Example 2: Posts a stop action to a compute instance by pipeline +```powershell +Get-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name compute02 | Stop-AzMLWorkspaceCompute +``` + +Posts a stop action to a compute instance by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: ComputeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Stop-AzMLWorkspaceJob.md b/azps-10.1.0/Az.MachineLearningServices/Stop-AzMLWorkspaceJob.md new file mode 100644 index 0000000000..822413932f --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Stop-AzMLWorkspaceJob.md @@ -0,0 +1,256 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/stop-azmlworkspacejob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Stop-AzMLWorkspaceJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Stop-AzMLWorkspaceJob.md +--- + +# Stop-AzMLWorkspaceJob + +## SYNOPSIS +Cancels a Job (asynchronous). + +## SYNTAX + +### Cancel (Default) +``` +Stop-AzMLWorkspaceJob -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CancelViaIdentity +``` +Stop-AzMLWorkspaceJob -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Cancels a Job (asynchronous). + +## EXAMPLES + +### Example 1: Cancels a Job (asynchronous) +```powershell +Stop-AzMLWorkspaceJob -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name commandJob01 +``` + +Cancels a Job (asynchronous) + +### Example 2: Cancels a Job (asynchronous) by pipeline +```powershell +Get-AzMLWorkspaceJob -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name commandJob01 | Stop-AzMLWorkspaceJob +``` + +Cancels a Job (asynchronous) by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: CancelViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name and identifier for the Job. +This is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Sync-AzMLWorkspaceKey.md b/azps-10.1.0/Az.MachineLearningServices/Sync-AzMLWorkspaceKey.md new file mode 100644 index 0000000000..846cff0d54 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Sync-AzMLWorkspaceKey.md @@ -0,0 +1,242 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/sync-azmlworkspacekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Sync-AzMLWorkspaceKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Sync-AzMLWorkspaceKey.md +--- + +# Sync-AzMLWorkspaceKey + +## SYNOPSIS +Resync all the keys associated with this workspace. +This includes keys for the storage account, app insights and password for container registry + +## SYNTAX + +### Resync (Default) +``` +Sync-AzMLWorkspaceKey -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ResyncViaIdentity +``` +Sync-AzMLWorkspaceKey -InputObject <IMachineLearningServicesIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Resync all the keys associated with this workspace. +This includes keys for the storage account, app insights and password for container registry + +## EXAMPLES + +### Example 1: Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry +```powershell +Sync-AzMLWorkspaceKey -ResourceGroupName ml-rg-test -Name mlworkspace-test01 +``` + +Resync all the keys associated with this workspace. +This includes keys for the storage account, app insights and password for + +### Example 2: Resync all the keys associated with this workspace by pipeline +```powershell +Get-AzMLWorkspaceKey -ResourceGroupName ml-rg-test -Name mlworkspace-test01 | Sync-AzMLWorkspaceKey +``` + +Resync all the keys associated with this workspace by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: ResyncViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: Resync +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Resync +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Resync +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Update-AzMLServiceQuota.md b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLServiceQuota.md new file mode 100644 index 0000000000..b4bc9978b9 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLServiceQuota.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/update-azmlservicequota +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLServiceQuota.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLServiceQuota.md +--- + +# Update-AzMLServiceQuota + +## SYNOPSIS +Update quota for each VM family in workspace. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMLServiceQuota -Location <String> [-SubscriptionId <String>] [-Location1 <String>] + [-Value <IQuotaBaseProperties[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMLServiceQuota -InputObject <IMachineLearningServicesIdentity> [-Location <String>] + [-Value <IQuotaBaseProperties[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update quota for each VM family in workspace. + +## EXAMPLES + +### Example 1: Update quota for each VM family in workspace +```powershell +Update-AzMLServiceQuota -Location eastus -Value @{'key1'='value1'} +``` + +Update quota for each VM family in workspace + +### Example 2: Update quota for each VM family in workspace by pipeline +```powershell +Get-AzMLServiceQuota -Location eastus | Update-AzMLServiceQuota-Value @{'key1'='value1'} +``` + +Update quota for each VM family in workspace by pipeline + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location for update quota is queried. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location1 +Region of workspace quota to be updated. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The list for update quota. +To construct, see NOTES section for VALUE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IQuotaBaseProperties[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IUpdateWorkspaceQuotasResult + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +VALUE <IQuotaBaseProperties[]>: The list for update quota. + - `[Id <String>]`: Specifies the resource ID. + - `[Limit <Int64?>]`: The maximum permitted quota of the resource. + - `[Type <String>]`: Specifies the resource type. + - `[Unit <QuotaUnit?>]`: An enum describing the unit of quota measurement. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspace.md b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspace.md new file mode 100644 index 0000000000..bc58dc5cc9 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspace.md @@ -0,0 +1,492 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/update-azmlworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLWorkspace.md +--- + +# Update-AzMLWorkspace + +## SYNOPSIS +Updates a machine learning workspace with the specified parameters. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMLWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-ApplicationInsightId <String>] [-ContainerRegistryId <String>] [-CosmoDbCollectionsThroughput <Int32>] + [-Description <String>] [-FriendlyName <String>] [-IdentityType <ManagedServiceIdentityType>] + [-IdentityUserAssigned <Hashtable>] [-ImageBuildCompute <String>] [-PrimaryUserAssignedIdentity <String>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] + [-SkuSize <String>] [-SkuTier <SkuTier>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMLWorkspace -InputObject <IMachineLearningServicesIdentity> [-ApplicationInsightId <String>] + [-ContainerRegistryId <String>] [-CosmoDbCollectionsThroughput <Int32>] [-Description <String>] + [-FriendlyName <String>] [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssigned <Hashtable>] + [-ImageBuildCompute <String>] [-PrimaryUserAssignedIdentity <String>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] + [-SkuSize <String>] [-SkuTier <SkuTier>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a machine learning workspace with the specified parameters. + +## EXAMPLES + +### Example 1: Updates a machine learning workspace with the specified parameters +```powershell +Update-AzMLWorkspace -ResourceGroupName ml-rg-test -Name mlworkspace-test01 -Tag @{'key1' = 'value2'} +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Location ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- -------- ----------------- +mlworkspace-pwsh01 5/18/2022 6:33:49 AM v-diya@microsoft.com User 5/18/2022 6:33:49 AM v-diya@microsoft.com User eastus ml-rg-test +``` + +Updates a machine learning workspace with the specified parameters + +### Example 2: Updates a machine learning workspace with the specified parameters by pipeline +```powershell +Get-AzMLWorkspace -ResourceGroupName ml-rg-test -Name mlworkspace-test01 | Update-AzMLWorkspace -Tag @{'key1' = 'value2'} +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Location ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- -------- ----------------- +mlworkspace-pwsh01 5/18/2022 6:33:49 AM v-diya@microsoft.com User 5/18/2022 6:33:49 AM v-diya@microsoft.com User eastus ml-rg-test +``` + +Updates a machine learning workspace with the specified parameters by pipeline + +## PARAMETERS + +### -ApplicationInsightId +ARM id of the application insights associated with this workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryId +ARM id of the container registry associated with this workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CosmoDbCollectionsThroughput +The throughput of the collections in cosmosdb database + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of this workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +The friendly name for this workspace. + +```yaml +Type: System.String +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssigned +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImageBuildCompute +The compute name for image build + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryUserAssignedIdentity +The user assigned identity resource id that represents the workspace identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Whether requests from Public Network are allowed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.SkuTier +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The resource tags for the machine learning workspace. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IWorkspace + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceBatchDeployment.md b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceBatchDeployment.md new file mode 100644 index 0000000000..7e423656d9 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceBatchDeployment.md @@ -0,0 +1,297 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/update-azmlworkspacebatchdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLWorkspaceBatchDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLWorkspaceBatchDeployment.md +--- + +# Update-AzMLWorkspaceBatchDeployment + +## SYNOPSIS +Update a batch inference deployment (asynchronous). + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMLWorkspaceBatchDeployment -EndpointName <String> -Name <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-Description <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMLWorkspaceBatchDeployment -InputObject <IMachineLearningServicesIdentity> [-Description <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a batch inference deployment (asynchronous). + +## EXAMPLES + +### Example 1: Update a batch inference deployment (asynchronous) +```powershell +Update-AzMLWorkspaceBatchDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName batch-pwsh03 -Name nonmlflowdp -Tag @{'key'='value'} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus nonmlflowdp 6/1/2022 6:19:16 AM Lucas Yao (Wicresoft North America) 6/1/2022 6:19:16 AM ml-rg-test +``` + +Update a batch inference deployment (asynchronous) + +### Example 2: Update a batch inference deployment (asynchronous) by pipeline +```powershell +Get-AzMLWorkspaceBatchDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName batch-pwsh03 -Name nonmlflowdp | Update-AzMLWorkspaceBatchDeployment -Tag @{'key'='value'} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus nonmlflowdp 6/1/2022 6:19:16 AM Lucas Yao (Wicresoft North America) 6/1/2022 6:19:16 AM ml-rg-test +``` + +Update a batch inference deployment (asynchronous) by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the endpoint deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Inference endpoint name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The identifier for the Batch inference deployment. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IBatchDeployment + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceBatchEndpoint.md b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceBatchEndpoint.md new file mode 100644 index 0000000000..6fbc873b28 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceBatchEndpoint.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/update-azmlworkspacebatchendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLWorkspaceBatchEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLWorkspaceBatchEndpoint.md +--- + +# Update-AzMLWorkspaceBatchEndpoint + +## SYNOPSIS +Update a batch inference endpoint (asynchronous). + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMLWorkspaceBatchEndpoint -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssigned <Hashtable>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMLWorkspaceBatchEndpoint -InputObject <IMachineLearningServicesIdentity> + [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssigned <Hashtable>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a batch inference endpoint (asynchronous). + +## EXAMPLES + +### Example 1: Update a batch inference endpoint (asynchronous) +```powershell +Update-AzMLWorkspaceBatchEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name batchpwsh01-key -Tag @{'key'='value'} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus batch-pwsh03 5/20/2022 7:21:12 AM Lucas Yao (Wicresoft North America) 5/20/2022 7:31:17 AM ml-rg-test +``` + +Update a batch inference endpoint (asynchronous) + +### Example 2: Update a batch inference endpoint (asynchronous) by pipeline +```powershell +Get-AzMLWorkspaceBatchEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name batchpwsh01-key | Update-AzMLWorkspaceBatchEndpoint-Tag @{'key'='value'} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus batch-pwsh03 5/20/2022 7:21:12 AM Lucas Yao (Wicresoft North America) 5/20/2022 7:31:17 AM ml-rg-test +``` + +Update a batch inference endpoint (asynchronous) by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Managed service identity (system assigned and/or user assigned identities) + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssigned +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name for the Batch inference endpoint. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IBatchEndpoint + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceCompute.md b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceCompute.md new file mode 100644 index 0000000000..8c44456c34 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceCompute.md @@ -0,0 +1,304 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/update-azmlworkspacecompute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLWorkspaceCompute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLWorkspaceCompute.md +--- + +# Update-AzMLWorkspaceCompute + +## SYNOPSIS +Updates properties of a compute. +This call will overwrite a compute if it exists. +This is a nonrecoverable operation. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMLWorkspaceCompute -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-MaxNodeCount <Int32>] [-MinNodeCount <Int32>] + [-NodeIdleTimeBeforeScaleDown <TimeSpan>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMLWorkspaceCompute -InputObject <IMachineLearningServicesIdentity> [-MaxNodeCount <Int32>] + [-MinNodeCount <Int32>] [-NodeIdleTimeBeforeScaleDown <TimeSpan>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates properties of a compute. +This call will overwrite a compute if it exists. +This is a nonrecoverable operation. + +## EXAMPLES + +### Example 1: Updates properties of a compute +```powershell +Update-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name aml02 -MaxNodeCount 8 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Location ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- -------- ----------------- +cpu-cluster eastus ml-rg-test +``` + +Updates properties of a compute + +### Example 2: Updates properties of a compute by pipeline +```powershell +Get-AzMLWorkspaceCompute -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-test01 -Name aml02 | Update-AzMLWorkspaceCompute -MaxNodeCount 8 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Location ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- -------- ----------------- +cpu-cluster eastus ml-rg-test +``` + +Updates properties of a compute by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaxNodeCount +Max number of nodes to use + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinNodeCount +Min number of nodes to use + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Machine Learning compute. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ComputeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeIdleTimeBeforeScaleDown +Node Idle Time before scaling down amlCompute. +This string needs to be in the RFC Format. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IComputeResource + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceOnlineDeployment.md b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceOnlineDeployment.md new file mode 100644 index 0000000000..13c94ac7a7 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceOnlineDeployment.md @@ -0,0 +1,363 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/update-azmlworkspaceonlinedeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLWorkspaceOnlineDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLWorkspaceOnlineDeployment.md +--- + +# Update-AzMLWorkspaceOnlineDeployment + +## SYNOPSIS +Update Online Deployment (asynchronous). + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMLWorkspaceOnlineDeployment -EndpointName <String> -Name <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-SkuCapacity <Int32>] [-SkuFamily <String>] + [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMLWorkspaceOnlineDeployment -InputObject <IMachineLearningServicesIdentity> [-SkuCapacity <Int32>] + [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update Online Deployment (asynchronous). + +## EXAMPLES + +### Example 1: Update Online Deployment (asynchronous) +```powershell +Update-AzMLWorkspaceOnlineDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName online-pwsh01 -Name pwshblue01 -Tag @{'key'='value'} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus blue 5/19/2022 2:52:06 AM Lucas Yao (Wicresoft North America) 5/19/2022 2:52:06 AM Managed ml-rg-test +``` + +Update Online Deployment (asynchronous) + +### Example 2: Update Online Deployment (asynchronous) by pipeline +```powershell +Get-AzMLWorkspaceOnlineDeployment -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -EndpointName online-pwsh01 -Name pwshblue01 | Update-AzMLWorkspaceOnlineDeployment -Tag @{'key'='value'} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus blue 5/19/2022 2:52:06 AM Lucas Yao (Wicresoft North America) 5/19/2022 2:52:06 AM Managed ml-rg-test +``` + +Update Online Deployment (asynchronous) by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Online Endpoint name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Inference Endpoint Deployment name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.SkuTier +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IOnlineDeployment + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceOnlineEndpoint.md b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceOnlineEndpoint.md new file mode 100644 index 0000000000..43ea246de0 --- /dev/null +++ b/azps-10.1.0/Az.MachineLearningServices/Update-AzMLWorkspaceOnlineEndpoint.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.MachineLearningServices +online version: https://learn.microsoft.com/powershell/module/az.machinelearningservices/update-azmlworkspaceonlineendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLWorkspaceOnlineEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MachineLearningServices/help/Update-AzMLWorkspaceOnlineEndpoint.md +--- + +# Update-AzMLWorkspaceOnlineEndpoint + +## SYNOPSIS +Update Online Endpoint (asynchronous). + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMLWorkspaceOnlineEndpoint -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssigned <Hashtable>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMLWorkspaceOnlineEndpoint -InputObject <IMachineLearningServicesIdentity> + [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssigned <Hashtable>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update Online Endpoint (asynchronous). + +## EXAMPLES + +### Example 1: Update Online Endpoint (asynchronous) +```powershell +Update-AzMLWorkspaceOnlineEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name online-pwsh02 -Tag @{'key'='value'} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus online-cli01 5/19/2022 2:47:34 AM Lucas Yao (Wicresoft North America) 5/19/2022 2:48:26 AM Managed ml-rg-test +``` + +Update Online Endpoint (asynchronous) + +### Example 2: Update Online Endpoint (asynchronous) by pipeline +```powershell +Get-AzMLWorkspaceOnlineEndpoint -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name online-pwsh02 | Update-AzMLWorkspaceOnlineEndpoint -Tag @{'key'='value'} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType AzureAsyncOperation Kind ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------------- ---- ----------------- +eastus online-cli01 5/19/2022 2:47:34 AM Lucas Yao (Wicresoft North America) 5/19/2022 2:48:26 AM Managed ml-rg-test +``` + +Update Online Endpoint (asynchronous) by pipeline + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Managed service identity (system assigned and/or user assigned identities) + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssigned +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Online Endpoint name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Azure Machine Learning workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IOnlineEndpoint + +## 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 `<IMachineLearningServicesIdentity>`: Identity Parameter + - `[ComputeName <String>]`: Name of the Azure Machine Learning compute. + - `[ConnectionName <String>]`: Friendly name of the workspace connection + - `[DeploymentName <String>]`: Inference deployment identifier. + - `[EndpointName <String>]`: Inference Endpoint name. + - `[Id <String>]`: The name and identifier for the Job. This is case-sensitive. + - `[Id1 <String>]`: Resource identity path + - `[Location <String>]`: The location for which resource usage is queried. + - `[Name <String>]`: Container name. This is case-sensitive. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the workspace + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[Version <String>]`: Version identifier. This is case-sensitive. + - `[WorkspaceName <String>]`: Name of Azure Machine Learning workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Maintenance/Az.Maintenance.md b/azps-10.1.0/Az.Maintenance/Az.Maintenance.md new file mode 100644 index 0000000000..4381ea406b --- /dev/null +++ b/azps-10.1.0/Az.Maintenance/Az.Maintenance.md @@ -0,0 +1,48 @@ +--- +Module Name: Az.Maintenance +Module Guid: 9b895a4cb333f6bf9176b1eeb9260782R21 +Download Help Link: https://learn.microsoft.com/powershell/module/az.maintenance +Help Version: 0.2.5.0 +Locale: en-us +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Az.Maintenance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Az.Maintenance.md +--- + +# Az.Maintenance Module +## Description +This topic displays help topics for the Azure Maintenance Cmdlets. + +## Az.Maintenance Cmdlets +### [Get-AzApplyUpdate](Get-AzApplyUpdate.md) +Track maintenance updates to resource + +### [Get-AzConfigurationAssignment](Get-AzConfigurationAssignment.md) +List configurationAssignments for resource. + +### [Get-AzMaintenanceConfiguration](Get-AzMaintenanceConfiguration.md) +Get Maintenance configuration record + +### [Get-AzMaintenanceUpdate](Get-AzMaintenanceUpdate.md) +Get pending maintenance updates to resource. + +### [New-AzApplyUpdate](New-AzApplyUpdate.md) +Apply maintenance updates to resource + +### [New-AzConfigurationAssignment](New-AzConfigurationAssignment.md) +Register configuration for resource. + +### [New-AzMaintenanceConfiguration](New-AzMaintenanceConfiguration.md) +Create or Update configuration record + +### [Remove-AzConfigurationAssignment](Remove-AzConfigurationAssignment.md) +Unregister configuration for resource. + +### [Remove-AzMaintenanceConfiguration](Remove-AzMaintenanceConfiguration.md) +Delete Configuration record + +### [Update-AzMaintenanceConfiguration](Update-AzMaintenanceConfiguration.md) +Patch configuration record + +### [Get-AzMaintenancePublicConfiguration](Get-AzMaintenancePublicConfiguration.md) +Get Public Maintenance configuration record + diff --git a/azps-10.1.0/Az.Maintenance/Get-AzApplyUpdate.md b/azps-10.1.0/Az.Maintenance/Get-AzApplyUpdate.md new file mode 100644 index 0000000000..05362b7e2b --- /dev/null +++ b/azps-10.1.0/Az.Maintenance/Get-AzApplyUpdate.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Maintenance.dll-Help.xml +Module Name: Az.Maintenance +online version: https://learn.microsoft.com/powershell/module/az.maintenance/get-azapplyupdate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Get-AzApplyUpdate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Get-AzApplyUpdate.md +--- + +# Get-AzApplyUpdate + +## SYNOPSIS +Track maintenance updates to resource + +## SYNTAX + +``` +Get-AzApplyUpdate [-ResourceGroupName] <String> [-ProviderName] <String> [-ResourceParentType <String>] + [-ResourceParentName <String>] [-ResourceType] <String> [-ResourceName] <String> -ApplyUpdateName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Track maintenance updates to resource + +## EXAMPLES + +### Example 1 +```powershell +Get-AzApplyUpdate -ResourceGroupName smdtest$region -ResourceParentType hostGroups -ResourceParentName smddhg$region -ResourceType hosts -ResourceName smddh$region -ProviderName Microsoft.Compute -ApplyUpdateName default +``` + +```output +Status : InProgress +ResourceId : /subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/smdtestwestus2/providers/Microsoft.Compute/hostGroups/smddhgwestus2/hosts/smddhwestus2 +LastUpdateTime : 11/8/2019 9:39:01 AM +Id : /subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/smdtestwestus2/providers/Microsoft.Compute/hostGroups/smddhgwestus2/hosts/smddhwestus2/providers/Microsoft.Maintenance/applyUpdates/default +Name : default +Type : Microsoft.Maintenance/applyUpdates +``` + +Track maintenance updates to resource + +## PARAMETERS + +### -ApplyUpdateName +The apply update resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderName +The resource provider Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceParentName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceParentType +The parent resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Maintenance.Models.PSApplyUpdate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Maintenance/Get-AzConfigurationAssignment.md b/azps-10.1.0/Az.Maintenance/Get-AzConfigurationAssignment.md new file mode 100644 index 0000000000..7d0e258a83 --- /dev/null +++ b/azps-10.1.0/Az.Maintenance/Get-AzConfigurationAssignment.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Maintenance.dll-Help.xml +Module Name: Az.Maintenance +online version: https://learn.microsoft.com/powershell/module/az.maintenance/get-azconfigurationassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Get-AzConfigurationAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Get-AzConfigurationAssignment.md +--- + +# Get-AzConfigurationAssignment + +## SYNOPSIS +List configurationAssignments for resource. + +## SYNTAX + +``` +Get-AzConfigurationAssignment [-ResourceGroupName] <String> [-ProviderName] <String> + [-ResourceParentType <String>] [-ResourceParentName <String>] [-ResourceType] <String> + [-ResourceName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +List configurationAssignments for resource. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzConfigurationAssignment -ResourceGroupName smdtest$location -ResourceParentType hostGroups -ResourceParentName smddhg$location -ResourceType hosts -ResourceName smddh$location -ProviderName Microsoft.Compute +``` + +```output +MaintenanceConfigurationId : /subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/ps1/providers/Microsoft.Maintenance/maintenanceConfigurations/ps2 +Id : +/subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/smdtestwestus2/providers/Microsoft.Compute/hostGroups/smddhgwestus2/hosts/smddhwestus2/providers/Microsoft.Maintenance/configurationAssignments/ps2 +Name : ps2 +Type : Microsoft.Maintenance/configurationAssignments +``` + +List configurationAssignments for dedicated host. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderName +The resource provider Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceParentName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceParentType +The parent resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Maintenance.Models.PSConfigurationAssignment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Maintenance/Get-AzMaintenanceConfiguration.md b/azps-10.1.0/Az.Maintenance/Get-AzMaintenanceConfiguration.md new file mode 100644 index 0000000000..51b7a97747 --- /dev/null +++ b/azps-10.1.0/Az.Maintenance/Get-AzMaintenanceConfiguration.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Maintenance.dll-Help.xml +Module Name: Az.Maintenance +online version: https://learn.microsoft.com/powershell/module/az.maintenance/get-azmaintenanceconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Get-AzMaintenanceConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Get-AzMaintenanceConfiguration.md +--- + +# Get-AzMaintenanceConfiguration + +## SYNOPSIS +Get Maintenance configuration record + +## SYNTAX + +``` +Get-AzMaintenanceConfiguration [[-ResourceGroupName] <String>] [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get Maintenance configuration record + +## EXAMPLES + +### Example 1 +```powershell +Get-AzMaintenanceConfiguration -ResourceGroupName smdtest -Name workervmscentralus +``` + +```output +Location : centralus +Tags : {} +NamespaceProperty : +ExtensionProperties : {} +MaintenanceScope : Host +Id : /subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/smdtest/providers/Microsoft.Maintenance/maintenanceConfigurations/workervmscentralus +Name : workervmscentralus +Type : Microsoft.Maintenance/maintenanceConfigurations +``` + +Get Maintenance configuration record + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The maintenance configuration Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Maintenance.Models.PSMaintenanceConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Maintenance/Get-AzMaintenancePublicConfiguration.md b/azps-10.1.0/Az.Maintenance/Get-AzMaintenancePublicConfiguration.md new file mode 100644 index 0000000000..6e73886a34 --- /dev/null +++ b/azps-10.1.0/Az.Maintenance/Get-AzMaintenancePublicConfiguration.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Maintenance.dll-Help.xml +Module Name: Az.Maintenance +online version: https://learn.microsoft.com/powershell/module/az.maintenance/get-azmaintenancepublicconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Get-AzMaintenancePublicConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Get-AzMaintenancePublicConfiguration.md +--- + +# Get-AzMaintenancePublicConfiguration + +## SYNOPSIS +Get Public Maintenance Configuration record + +## SYNTAX + +``` +Get-AzMaintenancePublicConfiguration [[-ResourceGroupName] <String>] [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get Public Maintenance Configuration record + +## EXAMPLES + +### Example 1 +```powershell +Get-AzMaintenancePublicConfiguration -ResourceGroupName smdtest -Name workervmscentralus +``` + +```output +Location : centralus +Tags : {} +NamespaceProperty : +ExtensionProperties : {"publicMaintenanceConfigurationId" : "workervmscentralus"} +StartDateTime : 2020-08-01 00:00 +ExpirationDateTime : 2021-08-04 00:00 +TimeZone : Pacific Standard Time +RecurEvery : Day +Duration : 05:00 +MaintenanceScope : SQLDB +Visibility : Public +Id : /subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/smdtest/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/workervmscentralus +Name : workervmscentralus +Type : Microsoft.Maintenance/publicMaintenanceConfigurations +``` + +Get Public Maintenance configuration record + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The public maintenance configuration Name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource Group Name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Maintenance.Models.PSMaintenanceConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Maintenance/Get-AzMaintenanceUpdate.md b/azps-10.1.0/Az.Maintenance/Get-AzMaintenanceUpdate.md new file mode 100644 index 0000000000..357ca1e7c6 --- /dev/null +++ b/azps-10.1.0/Az.Maintenance/Get-AzMaintenanceUpdate.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Maintenance.dll-Help.xml +Module Name: Az.Maintenance +online version: https://learn.microsoft.com/powershell/module/az.maintenance/get-azmaintenanceupdate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Get-AzMaintenanceUpdate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Get-AzMaintenanceUpdate.md +--- + +# Get-AzMaintenanceUpdate + +## SYNOPSIS +Get pending maintenance updates to resource. + +## SYNTAX + +``` +Get-AzMaintenanceUpdate [-ResourceGroupName] <String> [-ProviderName] <String> [-ResourceParentType <String>] + [-ResourceParentName <String>] [-ResourceType] <String> [-ResourceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get pending maintenance updates to resource. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzMaintenanceUpdate -ResourceGroupName smdtest$location -ResourceParentType hostGroups -ResourceParentName smddhg$location -ResourceType hosts -ResourceName smddh$location -ProviderName Microsoft.Compute +``` + +```output +MaintenanceScope : Host +ImpactType : Freeze +Status : Pending +ImpactDurationInSec : 9 +NotBefore : 1/24/2020 5:11:41 AM +ResourceId : /subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/smdtestwestus2/providers/Microsoft.Compute/hostGroups/smddhgwestus2/hosts/smddhwestus2 +``` + +Get pending maintenance updates to resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderName +The resource provider Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceParentName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceParentType +The parent resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Maintenance.Models.Update + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Maintenance/New-AzApplyUpdate.md b/azps-10.1.0/Az.Maintenance/New-AzApplyUpdate.md new file mode 100644 index 0000000000..4ece686d0a --- /dev/null +++ b/azps-10.1.0/Az.Maintenance/New-AzApplyUpdate.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Maintenance.dll-Help.xml +Module Name: Az.Maintenance +online version: https://learn.microsoft.com/powershell/module/az.maintenance/new-azapplyupdate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/New-AzApplyUpdate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/New-AzApplyUpdate.md +--- + +# New-AzApplyUpdate + +## SYNOPSIS +Apply maintenance updates to resource + +## SYNTAX + +``` +New-AzApplyUpdate [-ResourceGroupName] <String> [-ProviderName] <String> [-ResourceParentType <String>] + [-ResourceParentName <String>] [-ResourceType] <String> [-ResourceName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Apply maintenance updates to resource + +## EXAMPLES + +### Example 1 +```powershell +New-AzApplyUpdate -ResourceGroupName smdtest$region -ResourceParentType hostGroups -ResourceParentName smddhg$region -ResourceType hosts -ResourceName smddh$region -ProviderName Microsoft.Compute +``` + +```output +Status : InProgress +ResourceId : /subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/smdtestwestus2/providers/Microsoft.Compute/hostGroups/smddhgwestus2/hosts/smddhwestus2 +LastUpdateTime : 11/8/2019 9:39:01 AM +Id : +/subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/smdtestwestus2/providers/Microsoft.Compute/hostGroups/smddhgwestus2/hosts/smddhwestus2/providers/Microsoft.Maintenance/applyUpdates/cbd4c97d-2011-4fa3-9df1-525f97e74eac +Name : cbd4c97d-2011-4fa3-9df1-525f97e74eac +Type : Microsoft.Maintenance/applyUpdates +``` + +Apply maintenance updates to resource + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderName +The resource provider Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceParentName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceParentType +The parent resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Maintenance.Models.PSApplyUpdate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Maintenance/New-AzConfigurationAssignment.md b/azps-10.1.0/Az.Maintenance/New-AzConfigurationAssignment.md new file mode 100644 index 0000000000..f5e743c643 --- /dev/null +++ b/azps-10.1.0/Az.Maintenance/New-AzConfigurationAssignment.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Maintenance.dll-Help.xml +Module Name: Az.Maintenance +online version: https://learn.microsoft.com/powershell/module/az.maintenance/new-azconfigurationassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/New-AzConfigurationAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/New-AzConfigurationAssignment.md +--- + +# New-AzConfigurationAssignment + +## SYNOPSIS +Register configuration for resource. + +## SYNTAX + +``` +New-AzConfigurationAssignment [-ResourceGroupName] <String> [-ProviderName] <String> + [-ResourceParentType <String>] [-ResourceParentName <String>] [-ResourceType] <String> + [-ResourceName] <String> -ConfigurationAssignmentName <String> [-ResourceId <String>] -Location <String> + -MaintenanceConfigurationId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Register maintenance configuration for resource. + +## EXAMPLES + +### Example 1 +```powershell +New-AzConfigurationAssignment -ResourceGroupName smdtest$location -ResourceParentType hostGroups -ResourceParentName smddhg$location -ResourceType hosts -ResourceName smddh$location -ProviderName Microsoft.Compute -ConfigurationAssignmentName $maintenanceConfigurationName -MaintenanceConfigurationId $maintenanceConfigurationCreated.Id -Location $location +``` + +```output +Location : westus2 +MaintenanceConfigurationId : /subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/ps1/providers/Microsoft.Maintenance/maintenanceConfigurations/ps2 +ResourceId : 7b32ed22-dc7b-4a17-9c42-36c024f4c9f9 +Id : +/subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/smdtestwestus2/providers/Microsoft.Compute/hostGroups/smddhgwestus2/hosts/smddhwestus2/providers/Microsoft.Maintenance/configurationAssignments/ps2 +Name : ps2 +Type : Microsoft.Maintenance/configurationAssignments +``` + +Register maintenance configuration for dedicated host. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationAssignmentName +The configuration assignment name, should match the MaintenanceConfigurationName. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location without spaces for the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceConfigurationId +The fully qualified MaintenanceConfiguration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderName +The resource provider Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The configuration assignment name, should match the MaintenanceConfigurationName. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceParentName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceParentType +The parent resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Maintenance.Models.PSConfigurationAssignment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Maintenance/New-AzMaintenanceConfiguration.md b/azps-10.1.0/Az.Maintenance/New-AzMaintenanceConfiguration.md new file mode 100644 index 0000000000..40dc84d912 --- /dev/null +++ b/azps-10.1.0/Az.Maintenance/New-AzMaintenanceConfiguration.md @@ -0,0 +1,464 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Maintenance.dll-Help.xml +Module Name: Az.Maintenance +online version: https://learn.microsoft.com/powershell/module/az.maintenance/new-azmaintenanceconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/New-AzMaintenanceConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/New-AzMaintenanceConfiguration.md +--- + +# New-AzMaintenanceConfiguration + +## SYNOPSIS +Create or Update configuration record + +## SYNTAX + +``` +New-AzMaintenanceConfiguration [-ResourceGroupName] <string> [-Name] <string> [-Location] <string> [-Tag <hashtable>] + [-ExtensionProperty <hashtable>] [-MaintenanceScope <string>] [-StartDateTime <string>] [-ExpirationDateTime <string>] + [-Timezone <string>] [-Duration <timespan>] [-Visibility <string>] [-RecurEvery <string>] + [-LinuxParameterPackageNameMaskToInclude <HashSet[string]>] [-LinuxParameterPackageNameMaskToExclude <HashSet[string]>] + [-LinuxParameterClassificationToInclude <HashSet[string]>] [-WindowParameterKbNumberToInclude <HashSet[string]>] + [-WindowParameterKbNumberToExclude <HashSet[string]>] [-WindowParameterClassificationToInclude <HashSet[string]>] + [-WindowParameterExcludeKbRequiringReboot <bool>] [-PreTask <string>] [-PostTask <string>] [-InstallPatchRebootSetting + <string>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create or Update configuration record + +## EXAMPLES + +### Example 1 +```powershell +New-AzMaintenanceConfiguration -ResourceGroupName smdtest -Name workervmscentralus -MaintenanceScope Host -Location centralus -StartDateTime "2020-08-01 00:00" -ExpirationDateTime "2021-08-04 00:00" -Timezone "Pacific Standard Time" -Duration 05:00 -RecurEvery Day +``` + +```output +Location : centralus +Tags : {} +ExtensionProperties : {} +MaintenanceScope : Host +StartDateTime : 2020-08-01 00:00 +ExpirationDateTime : 2021-08-04 00:00 +TimeZone : Pacific Standard Time +RecurEvery : Day +Duration : 05:00 +MaintenanceScope : Host +Visibility : Custom +Id : /subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/smdtest/providers/Microsoft.Maintenance/maintenanceConfigurations/workervmscentralus +Name : workervmscentralus +Type : Microsoft.Maintenance/maintenanceConfigurations +``` + +Create a maintenance configuration with scope Host + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Duration +The duration + + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDateTime +The expirationDateTime of the schedule in format YYYY-MM-DD hh:mm + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionProperty +The Extension properties per resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstallPatchRebootSetting +Install Patch Reboot Option. Allowed values Never, IfRequired, Always + +```yaml +Type: string +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinuxParameterClassificationToInclude +List of linux patch classifications + +```yaml +Type: HashSet[string] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinuxParameterPackageNameMaskToExclude +List of packages to exclude during vm patch operation + +```yaml +Type: HashSet[string] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinuxParameterPackageNameMaskToInclude +List of packages to include during vm patch operation + +```yaml +Type: HashSet[string] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The maintenance configuration location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaintenanceScope +The Maintenance Scope. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The maintenance configuration Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PreTask +List of tasks executed before schedule. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}]. This parameter is used to specify a command or script that should be run before the maintenance tasks are performed. This can be used to perform any necessary preparations or cleanup actions before the maintenance tasks are run. This parameter accepts a string value that specifies the command or script to be run. The command or script can be specified as a simple string or as an array of strings. If an array of strings is specified, each element in the array will be treated as a separate command or script. + +```yaml +Type: string +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostTask +List of tasks executed after schedule. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}]. This parameter is used to specify a command or script that should be run after the maintenance tasks are performed. This can be used to perform any necessary follow-up actions after the maintenance tasks are completed. This parameter accepts a string value that specifies the command or script to be run. The command or script can be specified as a simple string or as an array of strings. If an array of strings is specified, each element in the array will be treated as a separate command or script. + +```yaml +Type: string +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurEvery +The schedule recurrence + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartDateTime +The StartDateTime of the schedule in format YYYY-MM-DD hh:mm + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The ARM Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timezone +The timezone + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Visibility +The visibility of the scope + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowParameterClassificationToInclude +List of windows patch classification + +```yaml +Type: HashSet[string] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowParameterExcludeKbRequiringReboot +Exclude KBs which require reboot + +```yaml +Type: bool +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowParameterKbNumberToExclude +List of KBs to exclude during vm patch operation + +```yaml +Type: HashSet[string] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowParameterKbNumberToInclude +List of KBs to include during vm patch operation + +```yaml +Type: HashSet[string] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Maintenance.Models.PSMaintenanceConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Maintenance/Remove-AzConfigurationAssignment.md b/azps-10.1.0/Az.Maintenance/Remove-AzConfigurationAssignment.md new file mode 100644 index 0000000000..04303fa84a --- /dev/null +++ b/azps-10.1.0/Az.Maintenance/Remove-AzConfigurationAssignment.md @@ -0,0 +1,253 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Maintenance.dll-Help.xml +Module Name: Az.Maintenance +online version: https://learn.microsoft.com/powershell/module/az.maintenance/remove-azconfigurationassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Remove-AzConfigurationAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Remove-AzConfigurationAssignment.md +--- + +# Remove-AzConfigurationAssignment + +## SYNOPSIS +Unregister configuration for resource. + +## SYNTAX + +``` +Remove-AzConfigurationAssignment [-ResourceGroupName] <String> [-ProviderName] <String> + [-ResourceParentType <String>] [-ResourceParentName <String>] [-ResourceType] <String> + [-ResourceName] <String> -ConfigurationAssignmentName <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Unregister configuration for resource. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzConfigurationAssignment -ResourceGroupName smdtest$location -ResourceParentType hostGroups -ResourceParentName smddhg$location -ResourceType hosts -ResourceName smddh$location -ProviderName Microsoft.Compute -ConfigurationAssignmentName $maintenanceConfigurationName +``` + +```output +Remove-AzConfigurationAssignment operation +This cmdlet will remove the specified resource. Do you want to continue? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): +``` + +Unregister configuration for resource. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationAssignmentName +The configuration assignment name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force remove without confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns the status of the Remove operation. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderName +The resource provider Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceParentName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceParentType +The parent resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Maintenance/Remove-AzMaintenanceConfiguration.md b/azps-10.1.0/Az.Maintenance/Remove-AzMaintenanceConfiguration.md new file mode 100644 index 0000000000..a52b02c072 --- /dev/null +++ b/azps-10.1.0/Az.Maintenance/Remove-AzMaintenanceConfiguration.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Maintenance.dll-Help.xml +Module Name: Az.Maintenance +online version: https://learn.microsoft.com/powershell/module/az.maintenance/remove-azmaintenanceconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Remove-AzMaintenanceConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Remove-AzMaintenanceConfiguration.md +--- + +# Remove-AzMaintenanceConfiguration + +## SYNOPSIS +Delete Configuration record + +## SYNTAX + +``` +Remove-AzMaintenanceConfiguration [-ResourceGroupName] <String> [-Name] <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete Maintenance Configuration record + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzMaintenanceConfiguration -ResourceGroupName smdtest -Name workervmscentralus +``` + +```output +Remove-AzMaintenanceConfiguration operation +This cmdlet will remove the specified resource. Do you want to continue? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): +``` + +Delete Maintenance Configuration record + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force remove without confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The maintenance configuration Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns the status of the Remove operation. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Maintenance/Update-AzMaintenanceConfiguration.md b/azps-10.1.0/Az.Maintenance/Update-AzMaintenanceConfiguration.md new file mode 100644 index 0000000000..c4612715e4 --- /dev/null +++ b/azps-10.1.0/Az.Maintenance/Update-AzMaintenanceConfiguration.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Maintenance.dll-Help.xml +Module Name: Az.Maintenance +online version: https://learn.microsoft.com/powershell/module/az.maintenance/update-azmaintenanceconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Update-AzMaintenanceConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Update-AzMaintenanceConfiguration.md +--- + +# Update-AzMaintenanceConfiguration + +## SYNOPSIS +Patch configuration record + +## SYNTAX + +``` +Update-AzMaintenanceConfiguration [-ResourceGroupName] <String> [-Name] <String> + [-Configuration] <PSMaintenanceConfiguration> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Patch maintenance configuration record + +## EXAMPLES + +### Example 1 +```powershell +Update-AzMaintenanceConfiguration -ResourceGroupName smdtest -Name workervmscentralus -Configuration $configuration +``` + +```output +Location : centralus +Tags : {} +ExtensionProperties : {} +MaintenanceScope : Host +Id : /subscriptions/42c974dd-2c03-4f1b-96ad-b07f050aaa74/resourcegroups/smdtest/providers/Microsoft.Maintenance/maintenanceConfigurations/workervmscentralus +Name : workervmscentralus +Type : Microsoft.Maintenance/maintenanceConfigurations +``` + +Patch maintenance configuration record + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Configuration +The maintenance configuration to be updated. + +```yaml +Type: Microsoft.Azure.Commands.Maintenance.Models.PSMaintenanceConfiguration +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The maintenance configuration Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Maintenance.Models.PSMaintenanceConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Maintenance.Models.PSMaintenanceConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ManagedServiceIdentity/Az.ManagedServiceIdentity.md b/azps-10.1.0/Az.ManagedServiceIdentity/Az.ManagedServiceIdentity.md new file mode 100644 index 0000000000..464eef12e0 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServiceIdentity/Az.ManagedServiceIdentity.md @@ -0,0 +1,45 @@ +--- +Module Name: Az.ManagedServiceIdentity +Module Guid: 1f09fbda-2563-4cfc-9098-100c27b52fa1 +Download Help Link: https://learn.microsoft.com/powershell/module/az.managedserviceidentity +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Az.ManagedServiceIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Az.ManagedServiceIdentity.md +--- + +# Az.ManagedServiceIdentity Module +## Description +Microsoft Azure PowerShell: ManagedServiceIdentity cmdlets + +## Az.ManagedServiceIdentity Cmdlets +### [Get-AzFederatedIdentityCredentials](Get-AzFederatedIdentityCredentials.md) +Gets the federated identity credential. + +### [Get-AzSystemAssignedIdentity](Get-AzSystemAssignedIdentity.md) +Gets the systemAssignedIdentity available under the specified RP scope. + +### [Get-AzUserAssignedIdentity](Get-AzUserAssignedIdentity.md) +Gets the identity. + +### [Get-AzUserAssignedIdentityAssociatedResource](Get-AzUserAssignedIdentityAssociatedResource.md) +Lists the associated resources for this identity. + +### [New-AzFederatedIdentityCredentials](New-AzFederatedIdentityCredentials.md) +Create or update a federated identity credential under the specified user assigned identity. + +### [New-AzUserAssignedIdentity](New-AzUserAssignedIdentity.md) +Create or update an identity in the specified subscription and resource group. + +### [Remove-AzFederatedIdentityCredentials](Remove-AzFederatedIdentityCredentials.md) +Deletes the federated identity credential. + +### [Remove-AzUserAssignedIdentity](Remove-AzUserAssignedIdentity.md) +Deletes the identity. + +### [Update-AzFederatedIdentityCredentials](Update-AzFederatedIdentityCredentials.md) +Create or update a federated identity credential under the specified user assigned identity. + +### [Update-AzUserAssignedIdentity](Update-AzUserAssignedIdentity.md) +Update an identity in the specified subscription and resource group. + diff --git a/azps-10.1.0/Az.ManagedServiceIdentity/Get-AzFederatedIdentityCredentials.md b/azps-10.1.0/Az.ManagedServiceIdentity/Get-AzFederatedIdentityCredentials.md new file mode 100644 index 0000000000..615b1404b0 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServiceIdentity/Get-AzFederatedIdentityCredentials.md @@ -0,0 +1,237 @@ +--- +external help file: +Module Name: Az.ManagedServiceIdentity +online version: https://learn.microsoft.com/powershell/module/az.managedserviceidentity/get-azfederatedidentitycredentials +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Get-AzFederatedIdentityCredentials.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Get-AzFederatedIdentityCredentials.md +--- + +# Get-AzFederatedIdentityCredentials + +## SYNOPSIS +Gets the federated identity credential. + +## SYNTAX + +### List (Default) +``` +Get-AzFederatedIdentityCredentials -IdentityName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-Skiptoken <String>] [-Top <Int32>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzFederatedIdentityCredentials -IdentityName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzFederatedIdentityCredentials -InputObject <IManagedServiceIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the federated identity credential. + +## EXAMPLES + +### Example 1: List federated identity credentials under a user assigned identity +```powershell +Get-AzFederatedIdentityCredentials -ResourceGroupName azure-rg-test -IdentityName uai-pwsh01 +``` + +```output +Name Issuer Subject Audience +---- ------ ------- -------- +fic-pwsh01 https://kubernetes-oauth.azure.com system:serviceaccount:ns:svcaccount {api://AzureADTokenExchange} +fic-pwsh02 https://kubernetes-oauth-2.azure.com system:serviceaccount-2:ns:svcaccount {api://AzureADTokenExchange} +``` + +This command lists federated identity credentials under a user assigned identity. + +### Example 2: Get a federated identity credential +```powershell +Get-AzFederatedIdentityCredentials -ResourceGroupName azure-rg-test -IdentityName uai-pwsh01 -Name fic-pwsh01 +``` + +```output +Name Issuer Subject Audience +---- ------ ------- -------- +fic-pwsh01 https://kubernetes-oauth.azure.com system:serviceaccount:ns:svcaccount {api://AzureADTokenExchange} +``` + +This command gets a federated identity credential by name. + +### Example 3: Get a federated identity credential by pipeline +```powershell +New-AzFederatedIdentityCredentials -ResourceGroupName azure-rg-test -IdentityName uai-pwsh01 ` + -Name fic-pwsh03 -Issuer "https://kubernetes-oauth-3.azure.com" -Subject "system:serviceaccount-3:ns:svcaccount" ` + | Get-AzFederatedIdentityCredentials +``` + +```output +Name Issuer Subject Audience +---- ------ ------- -------- +fic-pwsh03 https://kubernetes-oauth-3.azure.com system:serviceaccount-3:ns:svcaccount {api://AzureADTokenExchange} +``` + +This command creates and gets a federated identity credential by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityName +The name of the identity resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.IManagedServiceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the federated identity credential resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skiptoken +A skip token is used to continue retrieving items after an operation returns a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Id of the Subscription to which the identity belongs. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Number of records to return. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.IManagedServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IFederatedIdentityCredential + +## 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 <IManagedServiceIdentity>`: Identity Parameter + - `[FederatedIdentityCredentialResourceName <String>]`: The name of the federated identity credential resource. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the Resource Group to which the identity belongs. + - `[ResourceName <String>]`: The name of the identity resource. + - `[Scope <String>]`: The resource provider scope of the resource. Parent resource being extended by Managed Identities. + - `[SubscriptionId <String>]`: The Id of the Subscription to which the identity belongs. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServiceIdentity/Get-AzSystemAssignedIdentity.md b/azps-10.1.0/Az.ManagedServiceIdentity/Get-AzSystemAssignedIdentity.md new file mode 100644 index 0000000000..9d7c74f258 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServiceIdentity/Get-AzSystemAssignedIdentity.md @@ -0,0 +1,86 @@ +--- +external help file: +Module Name: Az.ManagedServiceIdentity +online version: https://learn.microsoft.com/powershell/module/az.managedserviceidentity/get-azsystemassignedidentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Get-AzSystemAssignedIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Get-AzSystemAssignedIdentity.md +--- + +# Get-AzSystemAssignedIdentity + +## SYNOPSIS +Gets the systemAssignedIdentity available under the specified RP scope. + +## SYNTAX + +``` +Get-AzSystemAssignedIdentity -Scope <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the systemAssignedIdentity available under the specified RP scope. + +## EXAMPLES + +### Example 1: Gets the system assigned identity available under the specified RP scope +```powershell +Get-AzSystemAssignedIdentity -Scope "/subscriptions/00000000-0000-0000-00000000000/resourcegroups/lucas-rg-test/providers/Microsoft.Web/sites/functionportal01" +``` + +```output +Name Location ResourceGroupName +---- -------- ----------------- +ubuntu-portal01 eastus azure-rg-test +``` + +This command gets the system assigned identity available under the specified RP scope. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The resource provider scope of the resource. +Parent resource being extended by Managed Identities. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.ISystemAssignedIdentity + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServiceIdentity/Get-AzUserAssignedIdentity.md b/azps-10.1.0/Az.ManagedServiceIdentity/Get-AzUserAssignedIdentity.md new file mode 100644 index 0000000000..3d9149ca11 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServiceIdentity/Get-AzUserAssignedIdentity.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.ManagedServiceIdentity +online version: https://learn.microsoft.com/powershell/module/az.managedserviceidentity/get-azuserassignedidentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Get-AzUserAssignedIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Get-AzUserAssignedIdentity.md +--- + +# Get-AzUserAssignedIdentity + +## SYNOPSIS +Gets the identity. + +## SYNTAX + +### List (Default) +``` +Get-AzUserAssignedIdentity [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzUserAssignedIdentity -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzUserAssignedIdentity -InputObject <IManagedServiceIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzUserAssignedIdentity -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the identity. + +## EXAMPLES + +### Example 1: Lists user assigned identity under a subscription +```powershell +Get-AzUserAssignedIdentity +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus AzSecPackAutoConfigUA-eastus AzSecPackAutoConfigRG +eastus uai-pwsh01 azure-rg-test +eastus2 AzSecPackAutoConfigUA-eastus2 AzSecPackAutoConfigRG +``` + +This command lists user assigned identity under a subscription. + +### Example 2: List user assigned identity under a resource group +```powershell +Get-AzUserAssignedIdentity -ResourceGroupName azure-rg-test +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus uai-pwsh01 azure-rg-test +``` + +This command lists user assigned identity under a resource group. + +### Example 3: Get an user assigned identity +```powershell +Get-AzUserAssignedIdentity -ResourceGroupName azure-rg-test -Name uai-pwsh01 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus uai-pwsh01 azure-rg-test +``` + +This command gets an user assigned identity. + +### Example 4: Get an user assigned identity by pipeline +```powershell +New-AzUserAssignedIdentity -ResourceGroupName azure-rg-test -Name uai-pwsh01 -Location eastus ` + | Get-AzUserAssignedIdentity +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus uai-pwsh01 azure-rg-test +``` + +This command gets an user assigned identity by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.IManagedServiceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the identity resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Resource Group to which the identity belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Id of the Subscription to which the identity belongs. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.IManagedServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IIdentity + +## 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 <IManagedServiceIdentity>`: Identity Parameter + - `[FederatedIdentityCredentialResourceName <String>]`: The name of the federated identity credential resource. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the Resource Group to which the identity belongs. + - `[ResourceName <String>]`: The name of the identity resource. + - `[Scope <String>]`: The resource provider scope of the resource. Parent resource being extended by Managed Identities. + - `[SubscriptionId <String>]`: The Id of the Subscription to which the identity belongs. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServiceIdentity/Get-AzUserAssignedIdentityAssociatedResource.md b/azps-10.1.0/Az.ManagedServiceIdentity/Get-AzUserAssignedIdentityAssociatedResource.md new file mode 100644 index 0000000000..4e5025f8eb --- /dev/null +++ b/azps-10.1.0/Az.ManagedServiceIdentity/Get-AzUserAssignedIdentityAssociatedResource.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.ManagedServiceIdentity +online version: https://learn.microsoft.com/powershell/module/az.managedserviceidentity/get-azuserassignedidentityassociatedresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Get-AzUserAssignedIdentityAssociatedResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Get-AzUserAssignedIdentityAssociatedResource.md +--- + +# Get-AzUserAssignedIdentityAssociatedResource + +## SYNOPSIS +Lists the associated resources for this identity. + +## SYNTAX + +``` +Get-AzUserAssignedIdentityAssociatedResource -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-Filter <String>] [-Orderby <String>] [-Skip <Int32>] [-Skiptoken <String>] + [-Top <Int32>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Lists the associated resources for this identity. + +## EXAMPLES + +### Example 1: List all azure resources associated with given identity. +```powershell +Get-AzUserAssignedIdentityAssociatedResource -ResourceGroupName azure-rg-test -Name uai-pwsh01 +``` + +```output +Name ResourceGroup SubscriptionDisplayName SubscriptionId ResourceType +---- ------------- ----------------------- -------------- ------------ +appServicej6ocml identity-xcsbyfid Visual Studio Enterprise Subscription 0336439f-0e9d-44ec-975e-62accb9b3901 microsoft.web/sites +default test-resources Visual Studio Enterprise Subscription 0336439f-0e9d-44ec-975e-62accb9b3901 microsoft.compute/virtualmachines +``` + +This command lists all azure resources associated with given identity. + +### Example 2: List azure resources associated with given identity with OData expression that allows to filter by: name, type, resourceGroup, subscriptionId, subscriptionDisplayName +```powershell +Get-AzUserAssignedIdentityAssociatedResource -ResourceGroupName azure-rg-test -Name uai-pwsh01 ` + -Filter "type eq 'microsoft.compute/virtualmachines' and contains(name, 'default')" +``` + +```output +Name ResourceGroup SubscriptionDisplayName SubscriptionId ResourceType +---- ------------- ----------------------- -------------- ------------ +default test-resources Visual Studio Enterprise Subscription 0336439f-0e9d-44ec-975e-62accb9b3901 microsoft.compute/virtualmachines +``` + +This command lists azure resources associated with given identity with OData expression that allows to filter by: name, type, resourceGroup, subscriptionId, subscriptionDisplayName + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +OData filter expression to apply to the query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the identity resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orderby +OData orderBy expression to apply to the query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Resource Group to which the identity belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Number of records to skip. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skiptoken +A skip token is used to continue retrieving items after an operation returns a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. + +```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 Subscription to which the identity belongs. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Number of records to return. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.IAzureResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServiceIdentity/New-AzFederatedIdentityCredentials.md b/azps-10.1.0/Az.ManagedServiceIdentity/New-AzFederatedIdentityCredentials.md new file mode 100644 index 0000000000..2cefbf0163 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServiceIdentity/New-AzFederatedIdentityCredentials.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.ManagedServiceIdentity +online version: https://learn.microsoft.com/powershell/module/az.managedserviceidentity/new-azfederatedidentitycredentials +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/New-AzFederatedIdentityCredentials.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/New-AzFederatedIdentityCredentials.md +--- + +# New-AzFederatedIdentityCredentials + +## SYNOPSIS +Create or update a federated identity credential under the specified user assigned identity. + +## SYNTAX + +``` +New-AzFederatedIdentityCredentials -IdentityName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Audience <String[]>] [-Issuer <String>] [-Subject <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a federated identity credential under the specified user assigned identity. + +## EXAMPLES + +### Example 1: Create a federated identity credential under the specified user assigned identity +```powershell +New-AzFederatedIdentityCredentials -ResourceGroupName azure-rg-test -IdentityName uai-pwsh01 ` + -Name fic-pwsh01 -Issuer "https://kubernetes-oauth.azure.com" -Subject "system:serviceaccount:ns:svcaccount" +``` + +```output +Name Issuer Subject Audience +---- ------ ------- -------- +fic-pwsh01 https://kubernetes-oauth.azure.com system:serviceaccount:ns:svcaccount {api://AzureADTokenExchange} +``` + +This command creates a federated identity credential under the specified user assigned identity. + +### Example 2: Create a federated identity credential under the specified user assigned identity with 'Audience' override +```powershell +New-AzFederatedIdentityCredentials -ResourceGroupName azure-rg-test -IdentityName uai-pwsh01 ` + -Name fic-pwsh01 -Issuer "https://kubernetes-oauth.azure.com" -Subject "system:serviceaccount:ns:svcaccount" ` + -Audience @("api://AzureADTokenExchange-Modified") +``` + +```output +Name Issuer Subject Audience +---- ------ ------- -------- +fic-pwsh01 https://kubernetes-oauth.azure.com system:serviceaccount:ns:svcaccount {api://AzureADTokenExchange} +``` + +This command creates a federated identity credential under the specified user assigned identity with the custom audience + +## PARAMETERS + +### -Audience +The list of audiences that can appear in the issued token. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: @("api://AzureADTokenExchange") +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityName +The name of the identity resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Issuer +The URL of the issuer to be trusted. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the federated identity credential resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subject +The identifier of the external identity. + +```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 Subscription to which the identity belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IFederatedIdentityCredential + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServiceIdentity/New-AzUserAssignedIdentity.md b/azps-10.1.0/Az.ManagedServiceIdentity/New-AzUserAssignedIdentity.md new file mode 100644 index 0000000000..8280e1dab8 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServiceIdentity/New-AzUserAssignedIdentity.md @@ -0,0 +1,178 @@ +--- +external help file: +Module Name: Az.ManagedServiceIdentity +online version: https://learn.microsoft.com/powershell/module/az.managedserviceidentity/new-azuserassignedidentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/New-AzUserAssignedIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/New-AzUserAssignedIdentity.md +--- + +# New-AzUserAssignedIdentity + +## SYNOPSIS +Create or update an identity in the specified subscription and resource group. + +## SYNTAX + +``` +New-AzUserAssignedIdentity -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update an identity in the specified subscription and resource group. + +## EXAMPLES + +### Example 1: Creates an user assigned identity in the specified subscription and resource group +```powershell +New-AzUserAssignedIdentity -ResourceGroupName azure-rg-test -Name uai-pwsh01 -Location eastus +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus uai-pwsh01 azure-rg-test +``` + +This command creates an user assigned identity in the specified subscription and resource group + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the identity resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Resource Group to which the identity belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Id of the Subscription to which the identity belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IIdentity + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServiceIdentity/Remove-AzFederatedIdentityCredentials.md b/azps-10.1.0/Az.ManagedServiceIdentity/Remove-AzFederatedIdentityCredentials.md new file mode 100644 index 0000000000..9f78834125 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServiceIdentity/Remove-AzFederatedIdentityCredentials.md @@ -0,0 +1,217 @@ +--- +external help file: +Module Name: Az.ManagedServiceIdentity +online version: https://learn.microsoft.com/powershell/module/az.managedserviceidentity/remove-azfederatedidentitycredentials +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Remove-AzFederatedIdentityCredentials.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Remove-AzFederatedIdentityCredentials.md +--- + +# Remove-AzFederatedIdentityCredentials + +## SYNOPSIS +Deletes the federated identity credential. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzFederatedIdentityCredentials -IdentityName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzFederatedIdentityCredentials -InputObject <IManagedServiceIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the federated identity credential. + +## EXAMPLES + +### Example 1: Delete federated identity credential +```powershell +Remove-AzFederatedIdentityCredentials -ResourceGroupName azure-rg-test -IdentityName uai-pwsh01 -Name fic-pwsh01 +``` + +This command deletes a federated identity credential. + +### Example 2: Delete federated identity credential by pipeline +```powershell +Get-AzFederatedIdentityCredentials -ResourceGroupName azure-rg-test -IdentityName uai-pwsh01 -Name fic-pwsh01 | Remove-AzFederatedIdentityCredentials +``` + +This command deletes a federated identity credential by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityName +The name of the identity resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.IManagedServiceIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the federated identity credential resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Id of the Subscription to which the identity belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.IManagedServiceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IManagedServiceIdentity>`: Identity Parameter + - `[FederatedIdentityCredentialResourceName <String>]`: The name of the federated identity credential resource. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the Resource Group to which the identity belongs. + - `[ResourceName <String>]`: The name of the identity resource. + - `[Scope <String>]`: The resource provider scope of the resource. Parent resource being extended by Managed Identities. + - `[SubscriptionId <String>]`: The Id of the Subscription to which the identity belongs. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServiceIdentity/Remove-AzUserAssignedIdentity.md b/azps-10.1.0/Az.ManagedServiceIdentity/Remove-AzUserAssignedIdentity.md new file mode 100644 index 0000000000..e88d8bd70a --- /dev/null +++ b/azps-10.1.0/Az.ManagedServiceIdentity/Remove-AzUserAssignedIdentity.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.ManagedServiceIdentity +online version: https://learn.microsoft.com/powershell/module/az.managedserviceidentity/remove-azuserassignedidentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Remove-AzUserAssignedIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Remove-AzUserAssignedIdentity.md +--- + +# Remove-AzUserAssignedIdentity + +## SYNOPSIS +Deletes the identity. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzUserAssignedIdentity -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzUserAssignedIdentity -InputObject <IManagedServiceIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the identity. + +## EXAMPLES + +### Example 1: Deletes an user assigned identity +```powershell +Remove-AzUserAssignedIdentity -ResourceGroupName azure-rg-test -Name uai-pwsh01 +``` + +This command deletes an user assigned identity. + +### Example 2: Deletes an user assigned identity by pipeline +```powershell +Get-AzUserAssignedIdentity -ResourceGroupName azure-rg-test -Name uai-pwsh01 | Remove-AzUserAssignedIdentity +``` + +This command deletes an user assigned identity by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.IManagedServiceIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the identity resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Resource Group to which the identity belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Id of the Subscription to which the identity belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.IManagedServiceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IManagedServiceIdentity>`: Identity Parameter + - `[FederatedIdentityCredentialResourceName <String>]`: The name of the federated identity credential resource. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the Resource Group to which the identity belongs. + - `[ResourceName <String>]`: The name of the identity resource. + - `[Scope <String>]`: The resource provider scope of the resource. Parent resource being extended by Managed Identities. + - `[SubscriptionId <String>]`: The Id of the Subscription to which the identity belongs. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServiceIdentity/Update-AzFederatedIdentityCredentials.md b/azps-10.1.0/Az.ManagedServiceIdentity/Update-AzFederatedIdentityCredentials.md new file mode 100644 index 0000000000..5a18f41ba2 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServiceIdentity/Update-AzFederatedIdentityCredentials.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.ManagedServiceIdentity +online version: https://learn.microsoft.com/powershell/module/az.managedserviceidentity/update-azfederatedidentitycredentials +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Update-AzFederatedIdentityCredentials.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Update-AzFederatedIdentityCredentials.md +--- + +# Update-AzFederatedIdentityCredentials + +## SYNOPSIS +Create or update a federated identity credential under the specified user assigned identity. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzFederatedIdentityCredentials -IdentityName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Audience <String[]>] [-Issuer <String>] [-Subject <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzFederatedIdentityCredentials -InputObject <IManagedServiceIdentity> [-Audience <String[]>] + [-Issuer <String>] [-Subject <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a federated identity credential under the specified user assigned identity. + +## EXAMPLES + +### Example 1: Update federated identity credential under the specified user assigned identity +```powershell +Update-AzFederatedIdentityCredentials -ResourceGroupName azure-rg-test -IdentityName uai-pwsh01 ` + -Name fic-pwsh01 -Issuer "https://kubernetes-oauth-upd.azure.com" -Subject "system:serviceaccount-upd:ns:svcaccount" +``` + +```output +Name Issuer Subject Audience +---- ------ ------- -------- +fic-pwsh01 https://kubernetes-oauth-upd.azure.com system:serviceaccount-upd:ns:svcaccount {api://AzureADTokenExchange} +``` + +This command updates a federated identity credential under the specified user assigned identity. + +### Example 2: Update federated identity credential under the specified user assigned identity by pipeline +```powershell +Get-AzFederatedIdentityCredentials -ResourceGroupName azure-rg-test -IdentityName uai-pwsh01 -Name fic-pwsh01 ` + | Update-AzFederatedIdentityCredentials -Issuer "https://kubernetes-oauth-upd.azure.com" -Subject "system:serviceaccount-upd:ns:svcaccount" +``` + +```output +Name Issuer Subject Audience +---- ------ ------- -------- +fic-pwsh01 https://kubernetes-oauth-upd.azure.com system:serviceaccount-upd:ns:svcaccount {api://AzureADTokenExchange} +``` + +This command updates a federated identity credential under the specified user assigned identity by pipeline. + +## PARAMETERS + +### -Audience +The list of audiences that can appear in the issued token. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: @("api://AzureADTokenExchange") +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityName +The name of the identity resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.IManagedServiceIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Issuer +The URL of the issuer to be trusted. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the federated identity credential resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subject +The identifier of the external identity. + +```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 Subscription to which the identity belongs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.IManagedServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IFederatedIdentityCredential + +## 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 <IManagedServiceIdentity>`: Identity Parameter + - `[FederatedIdentityCredentialResourceName <String>]`: The name of the federated identity credential resource. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the Resource Group to which the identity belongs. + - `[ResourceName <String>]`: The name of the identity resource. + - `[Scope <String>]`: The resource provider scope of the resource. Parent resource being extended by Managed Identities. + - `[SubscriptionId <String>]`: The Id of the Subscription to which the identity belongs. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServiceIdentity/Update-AzUserAssignedIdentity.md b/azps-10.1.0/Az.ManagedServiceIdentity/Update-AzUserAssignedIdentity.md new file mode 100644 index 0000000000..278142ba9b --- /dev/null +++ b/azps-10.1.0/Az.ManagedServiceIdentity/Update-AzUserAssignedIdentity.md @@ -0,0 +1,229 @@ +--- +external help file: +Module Name: Az.ManagedServiceIdentity +online version: https://learn.microsoft.com/powershell/module/az.managedserviceidentity/update-azuserassignedidentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Update-AzUserAssignedIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServiceIdentity/help/Update-AzUserAssignedIdentity.md +--- + +# Update-AzUserAssignedIdentity + +## SYNOPSIS +Update an identity in the specified subscription and resource group. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzUserAssignedIdentity -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Location <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzUserAssignedIdentity -InputObject <IManagedServiceIdentity> [-Location <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update an identity in the specified subscription and resource group. + +## EXAMPLES + +### Example 1: Updates an user assigned identity +```powershell +Update-AzUserAssignedIdentity -ResourceGroupName azure-rg-test -Name uai-pwsh01 -Tag @{'key01'='value01'; 'key02'='value02'} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus uai-pwsh01 azure-rg-test +``` + +This command updates an user assigned identity. + +### Example 2: Updates an user assigned identity by pipeline +```powershell +Get-AzUserAssignedIdentity -ResourceGroupName azure-rg-test -Name uai-pwsh01 | Update-AzUserAssignedIdentity -Tag @{'key01'='value01'; 'key02'='value02'} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus uai-pwsh01 azure-rg-test +``` + +This command updates an user assigned identity by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.IManagedServiceIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the identity resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Resource Group to which the identity belongs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Id of the Subscription to which the identity belongs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.IManagedServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IIdentity + +## 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 <IManagedServiceIdentity>`: Identity Parameter + - `[FederatedIdentityCredentialResourceName <String>]`: The name of the federated identity credential resource. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the Resource Group to which the identity belongs. + - `[ResourceName <String>]`: The name of the identity resource. + - `[Scope <String>]`: The resource provider scope of the resource. Parent resource being extended by Managed Identities. + - `[SubscriptionId <String>]`: The Id of the Subscription to which the identity belongs. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServices/Az.ManagedServices.md b/azps-10.1.0/Az.ManagedServices/Az.ManagedServices.md new file mode 100644 index 0000000000..4e804bab04 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServices/Az.ManagedServices.md @@ -0,0 +1,45 @@ +--- +Module Name: Az.ManagedServices +Module Guid: f3c1cabd-ba4d-4158-b4f3-9e037b7a2d62 +Download Help Link: https://learn.microsoft.com/powershell/module/az.managedservices +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/Az.ManagedServices.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/Az.ManagedServices.md +--- + +# Az.ManagedServices Module +## Description +Microsoft Azure PowerShell: ManagedServices cmdlets + +## Az.ManagedServices Cmdlets +### [Get-AzManagedServicesAssignment](Get-AzManagedServicesAssignment.md) +Gets the details of the specified registration assignment. + +### [Get-AzManagedServicesDefinition](Get-AzManagedServicesDefinition.md) +Gets the registration definition details. + +### [Get-AzManagedServicesMarketplaceDefinition](Get-AzManagedServicesMarketplaceDefinition.md) +Get the marketplace registration definition for the marketplace identifier. + +### [New-AzManagedServicesAssignment](New-AzManagedServicesAssignment.md) +Creates or updates a registration assignment. + +### [New-AzManagedServicesAuthorizationObject](New-AzManagedServicesAuthorizationObject.md) +Create an in-memory object for Authorization. + +### [New-AzManagedServicesDefinition](New-AzManagedServicesDefinition.md) +Creates or updates a registration definition. + +### [New-AzManagedServicesEligibleApproverObject](New-AzManagedServicesEligibleApproverObject.md) +Create an in-memory object for EligibleApprover. + +### [New-AzManagedServicesEligibleAuthorizationObject](New-AzManagedServicesEligibleAuthorizationObject.md) +Create a in-memory object for EligibleAuthorization + +### [Remove-AzManagedServicesAssignment](Remove-AzManagedServicesAssignment.md) +Deletes the specified registration assignment. + +### [Remove-AzManagedServicesDefinition](Remove-AzManagedServicesDefinition.md) +Deletes the registration definition. + diff --git a/azps-10.1.0/Az.ManagedServices/Get-AzManagedServicesAssignment.md b/azps-10.1.0/Az.ManagedServices/Get-AzManagedServicesAssignment.md new file mode 100644 index 0000000000..ef78d479e4 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServices/Get-AzManagedServicesAssignment.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.ManagedServices +online version: https://learn.microsoft.com/powershell/module/az.managedservices/get-azmanagedservicesassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/Get-AzManagedServicesAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/Get-AzManagedServicesAssignment.md +--- + +# Get-AzManagedServicesAssignment + +## SYNOPSIS +Gets the details of the specified registration assignment. + +## SYNTAX + +### List (Default) +``` +Get-AzManagedServicesAssignment [-Scope <String>] [-ExpandRegistrationDefinition] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzManagedServicesAssignment -Name <String> [-Scope <String>] [-ExpandRegistrationDefinition] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzManagedServicesAssignment -InputObject <IManagedServicesIdentity> [-ExpandRegistrationDefinition] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the details of the specified registration assignment. + +## EXAMPLES + +### Example 1: List all Azure Lighthouse registration assignments in a subscription +```powershell +Get-AzManagedServicesAssignment +``` + +```output +Name Type +---- ---- +xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft.ManagedServices/registrationAssignments +xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft.ManagedServices/registrationAssignments +xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft.ManagedServices/registrationAssignments +``` + +Lists all the Azure Lighthouse registration assignments in a given subscription in context. + +### Example 2: Get Azure Lighthouse registration assignment by name with selected properties +```powershell +Get-AzManagedServicesAssignment -Name xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | Format-List -Property Id, Name, Type, RegistrationDefinitionId, ProvisioningState +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.ManagedServices/registrationAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Name : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Type : Microsoft.ManagedServices/registrationAssignments +RegistrationDefinitionId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +ProvisioningState : Succeeded +``` + +Gets Azure Lighthouse registration assignment by name with selected properties. + +### Example 3: List all Azure Lighthouse registration assignments by scope +```powershell +Get-AzManagedServicesAssignment -Scope /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | Format-List -Property Id, Name, Type, RegistrationDefinitionId, ProvisioningState +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.ManagedServices/registrationAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Name : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Type : Microsoft.ManagedServices/registrationAssignments +RegistrationDefinitionId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +ProvisioningState : Succeeded + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.ManagedServices/registrationAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Name : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Type : Microsoft.ManagedServices/registrationAssignments +RegistrationDefinitionId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +ProvisioningState : Succeeded + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.ManagedServices/registrationAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Name : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Type : Microsoft.ManagedServices/registrationAssignments +RegistrationDefinitionId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +ProvisioningState : Succeeded +``` + +Lists all the Azure Lighthouse registration assignments in a given subscription or resource group scope. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandRegistrationDefinition +The flag indicating whether to return the registration definition details along with the registration assignment details. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.IManagedServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The GUID of the registration assignment. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RegistrationAssignmentId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: "subscriptions/" + (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.IManagedServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.Api20200201Preview.IRegistrationAssignment + +## 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 `<IManagedServicesIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[MarketplaceIdentifier <String>]`: The Azure Marketplace identifier. Expected formats: {publisher}.{product[-preview]}.{planName}.{version} or {publisher}.{product[-preview]}.{planName} or {publisher}.{product[-preview]} or {publisher}). + - `[RegistrationAssignmentId <String>]`: The GUID of the registration assignment. + - `[RegistrationDefinitionId <String>]`: The GUID of the registration definition. + - `[Scope <String>]`: The scope of the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServices/Get-AzManagedServicesDefinition.md b/azps-10.1.0/Az.ManagedServices/Get-AzManagedServicesDefinition.md new file mode 100644 index 0000000000..f95aa87a8e --- /dev/null +++ b/azps-10.1.0/Az.ManagedServices/Get-AzManagedServicesDefinition.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: Az.ManagedServices +online version: https://learn.microsoft.com/powershell/module/az.managedservices/get-azmanagedservicesdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/Get-AzManagedServicesDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/Get-AzManagedServicesDefinition.md +--- + +# Get-AzManagedServicesDefinition + +## SYNOPSIS +Gets the registration definition details. + +## SYNTAX + +### List (Default) +``` +Get-AzManagedServicesDefinition [-Scope <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzManagedServicesDefinition -Name <String> [-Scope <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzManagedServicesDefinition -InputObject <IManagedServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the registration definition details. + +## EXAMPLES + +### Example 1: List all Azure Lighthouse registration definitions in a subscription +```powershell +Get-AzManagedServicesDefinition +``` + +```output +Name Type +---- ---- +xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft.ManagedServices/registrationDefinitions +xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft.ManagedServices/registrationDefinitions +``` + +Lists all the Azure Lighthouse registration definitions in a given subscription in context. + +### Example 2: Get Azure Lighthouse registration definition by name with selected properties +```powershell +Get-AzManagedServicesDefinition -Name xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |Format-List -Property Id, Name, Type, ManagedByTenantId, Authorization, EligibleAuthorization +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Name : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Type : Microsoft.ManagedServices/registrationDefinitions +ManagedByTenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Authorization : {Test user} +EligibleAuthorization : {Test user} +``` + +Gets Azure Lighthouse registration definition by name with selected properties. + +### Example 3: List all Azure Lighthouse registration definitions by scope +```powershell +Get-AzManagedServicesDefinition -Scope /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | Format-List -Property Id, Name, Type, ManagedByTenantId, Authorization, EligibleAuthorization +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Name : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Type : Microsoft.ManagedServices/registrationDefinitions +ManagedByTenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Authorization : {Test user} +EligibleAuthorization : {Test user} + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Name : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Type : Microsoft.ManagedServices/registrationDefinitions +ManagedByTenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Authorization : {} +EligibleAuthorization : +``` + +Lists all Azure Lighthouse registration definitions by given subscription scope. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.IManagedServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The GUID of the registration definition. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RegistrationDefinitionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: "subscriptions/" + (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.IManagedServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.Api20200201Preview.IRegistrationDefinition + +## 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 `<IManagedServicesIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[MarketplaceIdentifier <String>]`: The Azure Marketplace identifier. Expected formats: {publisher}.{product[-preview]}.{planName}.{version} or {publisher}.{product[-preview]}.{planName} or {publisher}.{product[-preview]} or {publisher}). + - `[RegistrationAssignmentId <String>]`: The GUID of the registration assignment. + - `[RegistrationDefinitionId <String>]`: The GUID of the registration definition. + - `[Scope <String>]`: The scope of the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServices/Get-AzManagedServicesMarketplaceDefinition.md b/azps-10.1.0/Az.ManagedServices/Get-AzManagedServicesMarketplaceDefinition.md new file mode 100644 index 0000000000..a28dcb1e0c --- /dev/null +++ b/azps-10.1.0/Az.ManagedServices/Get-AzManagedServicesMarketplaceDefinition.md @@ -0,0 +1,189 @@ +--- +external help file: +Module Name: Az.ManagedServices +online version: https://learn.microsoft.com/powershell/module/az.managedservices/get-azmanagedservicesmarketplacedefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/Get-AzManagedServicesMarketplaceDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/Get-AzManagedServicesMarketplaceDefinition.md +--- + +# Get-AzManagedServicesMarketplaceDefinition + +## SYNOPSIS +Get the marketplace registration definition for the marketplace identifier. + +## SYNTAX + +### ListWithScope (Default) +``` +Get-AzManagedServicesMarketplaceDefinition [-Scope <String>] [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzManagedServicesMarketplaceDefinition -InputObject <IManagedServicesIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetWithoutScope +``` +Get-AzManagedServicesMarketplaceDefinition -MarketplaceIdentifier <String> -Tenant + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetWithScope +``` +Get-AzManagedServicesMarketplaceDefinition -MarketplaceIdentifier <String> [-Scope <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ListWithoutScope +``` +Get-AzManagedServicesMarketplaceDefinition -Tenant [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the marketplace registration definition for the marketplace identifier. + +## EXAMPLES + +### Example 1: Get the Azure Lighthouse Marketplace registration definition offer details +```powershell +Get-AzManagedServicesMarketplaceDefinition -MarketplaceIdentifier marketplace_test.managed_offer.managed_plan1.1.0.1 | Format-List Id, PlanProduct, PlanPublisher, PlanName, PlanVersion +``` + +```output +Id : /providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions/marketplace_test.managed_offer.managed_plan1.1.0.1 +PlanProduct : managed_offer +PlanPublisher : marketplace_test +PlanName : managed_plan1 +PlanVersion : 1.0.1 +``` + +Gets the Azure Lighthouse Marketplace registration definition offer details. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter query parameter to filter marketplace registration definitions by plan identifier, publisher, version etc. + +```yaml +Type: System.String +Parameter Sets: ListWithoutScope, ListWithScope +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.ManagedServices.Models.IManagedServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MarketplaceIdentifier +The Azure Marketplace identifier. +Expected formats: {publisher}.{product[-preview]}.{planName}.{version} or {publisher}.{product[-preview]}.{planName} or {publisher}.{product[-preview]} or {publisher}). + +```yaml +Type: System.String +Parameter Sets: GetWithoutScope, GetWithScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the resource. + +```yaml +Type: System.String +Parameter Sets: GetWithScope, ListWithScope +Aliases: + +Required: False +Position: Named +Default value: "subscriptions/" + (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +The filter query parameter to filter marketplace registration definitions by plan identifier, publisher, version etc. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetWithoutScope, ListWithoutScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.IManagedServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.Api20200201Preview.IMarketplaceRegistrationDefinition + +## 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 `<IManagedServicesIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[MarketplaceIdentifier <String>]`: The Azure Marketplace identifier. Expected formats: {publisher}.{product[-preview]}.{planName}.{version} or {publisher}.{product[-preview]}.{planName} or {publisher}.{product[-preview]} or {publisher}). + - `[RegistrationAssignmentId <String>]`: The GUID of the registration assignment. + - `[RegistrationDefinitionId <String>]`: The GUID of the registration definition. + - `[Scope <String>]`: The scope of the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesAssignment.md b/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesAssignment.md new file mode 100644 index 0000000000..08e1f35787 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesAssignment.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.ManagedServices +online version: https://learn.microsoft.com/powershell/module/az.managedservices/new-azmanagedservicesassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/New-AzManagedServicesAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/New-AzManagedServicesAssignment.md +--- + +# New-AzManagedServicesAssignment + +## SYNOPSIS +Creates or updates a registration assignment. + +## SYNTAX + +``` +New-AzManagedServicesAssignment -Name <String> [-Scope <String>] [-RegistrationDefinitionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a registration assignment. + +## EXAMPLES + +### Example 1: Create new Azure Lighthouse registration assignment at subscription scope +```powershell +New-AzManagedServicesAssignment -Name xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Scope "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -RegistrationDefinitionId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +```output +Name Type +---- ---- +xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft.ManagedServices/registrationAssignments +``` + +Creates new Azure Lighthouse registration assignment at subscription scope with the registration definition. + +### Example 2: Create new Azure Lighthouse registration assignment at resource group scope +```powershell +New-AzManagedServicesAssignment -Name xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Scope "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testgroup" -RegistrationDefinitionId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +```output +Name Type +---- ---- +xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft.ManagedServices/registrationAssignments +``` + +Creates new Azure Lighthouse registration assignment at resource group scope with the registration definition. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The GUID of the registration assignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RegistrationAssignmentId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationDefinitionId +The fully qualified path of the registration definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: "subscriptions/" + (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.Api20200201Preview.IRegistrationAssignment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesAuthorizationObject.md b/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesAuthorizationObject.md new file mode 100644 index 0000000000..d1dcb20879 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesAuthorizationObject.md @@ -0,0 +1,130 @@ +--- +external help file: +Module Name: Az.ManagedServices +online version: https://learn.microsoft.com/powershell/module/az.ManagedServices/new-AzManagedServicesAuthorizationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/New-AzManagedServicesAuthorizationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/New-AzManagedServicesAuthorizationObject.md +--- + +# New-AzManagedServicesAuthorizationObject + +## SYNOPSIS +Create an in-memory object for Authorization. + +## SYNTAX + +``` +New-AzManagedServicesAuthorizationObject -PrincipalId <String> -RoleDefinitionId <String> + [-DelegatedRoleDefinitionId <String[]>] [-PrincipalIdDisplayName <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for Authorization. + +## EXAMPLES + +### Example 1: Create new Azure Lighthouse Authorization object to use with Registration definition +```powershell +New-AzManagedServicesAuthorizationObject -PrincipalId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -RoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -PrincipalIdDisplayName "Test user" +``` + +```output +DelegatedRoleDefinitionId PrincipalId PrincipalIdDisplayName RoleDefinitionId +------------------------- ----------- ---------------------- ---------------- + xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Test user xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +``` + +Creates new Azure Lighthouse authorization object to use with Registration definition. + +### Example 2: Create new Azure Lighthouse Authorization object with delegatedRoleDefinitionIds +```powershell +New-AzManagedServicesAuthorizationObject -PrincipalId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -RoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -PrincipalIdDisplayName "Test user" -DelegatedRoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +```output +DelegatedRoleDefinitionId PrincipalId PrincipalIdDisplayName RoleDefinitionId +------------------------- ----------- ---------------------- ---------------- +{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx} xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Test user xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +``` + +Creates new Azure Lighthouse authorization object with delegatedRoleDefinitionIds. + +## PARAMETERS + +### -DelegatedRoleDefinitionId +The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. +It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other principals. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalId +The identifier of the Azure Active Directory principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalIdDisplayName +The display name of the Azure Active Directory principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.Api20200201Preview.Authorization + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesDefinition.md b/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesDefinition.md new file mode 100644 index 0000000000..d0363633f4 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesDefinition.md @@ -0,0 +1,342 @@ +--- +external help file: +Module Name: Az.ManagedServices +online version: https://learn.microsoft.com/powershell/module/az.managedservices/new-azmanagedservicesdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/New-AzManagedServicesDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/New-AzManagedServicesDefinition.md +--- + +# New-AzManagedServicesDefinition + +## SYNOPSIS +Creates or updates a registration definition. + +## SYNTAX + +``` +New-AzManagedServicesDefinition -Name <String> [-Scope <String>] [-Authorization <IAuthorization[]>] + [-Description <String>] [-EligibleAuthorization <IEligibleAuthorization[]>] [-ManagedByTenantId <String>] + [-PlanName <String>] [-PlanProduct <String>] [-PlanPublisher <String>] [-PlanVersion <String>] + [-RegistrationDefinitionName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a registration definition. + +## EXAMPLES + +### Example 1: Create new Azure Lighthouse registration definition object with permanent authorization +```powershell +$permantAuth = New-AzManagedServicesAuthorizationObject -PrincipalId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -RoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -PrincipalIdDisplayName "Test user" -DelegatedRoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + +New-AzManagedServicesDefinition -Name xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -RegistrationDefinitionName "Test definition" -ManagedByTenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Authorization $permantAuth -Description "Test definition desc" -Scope "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +```output +Name Type +---- ---- +xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft.ManagedServices/registrationDefinitions +``` + +Creates new Azure Lighthouse registration definition object with permanent authorization. + +### Example 2: Create new Azure Lighthouse registration definition object with both permanent and eligible authorizations +```powershell +$approver = New-AzManagedServicesEligibleApproverObject -PrincipalId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -PrincipalIdDisplayName "Approver group" + +$eligibleAuth = New-AzManagedServicesEligibleAuthorizationObject -PrincipalId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -PrincipalIdDisplayName "Test user" -RoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -JustInTimeAccessPolicyManagedByTenantApprover $approver -JustInTimeAccessPolicyMultiFactorAuthProvider Azure -JustInTimeAccessPolicyMaximumActivationDuration 0:30 + +New-AzManagedServicesDefinition -Name "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -RegistrationDefinitionName "Test definition" -ManagedByTenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Authorization $permantAuth -EligibleAuthorization $eligibleAuth -Description "Test definition desc" -Scope "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +```output +Name Type +---- ---- +xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxMicrosoft.ManagedServices/registrationDefinitions +``` + +Creates new Azure Lighthouse registration definition object with both permanent and eligible authorizations. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. +To construct, see NOTES section for AUTHORIZATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.Api20200201Preview.IAuthorization[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the registration definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EligibleAuthorization +The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. +To construct, see NOTES section for ELIGIBLEAUTHORIZATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.Api20200201Preview.IEligibleAuthorization[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedByTenantId +The identifier of the managedBy tenant. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The GUID of the registration definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RegistrationDefinitionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanName +Azure Marketplace plan name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanProduct +Azure Marketplace product code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanPublisher +Azure Marketplace publisher ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanVersion +Azure Marketplace plan's version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationDefinitionName +The name of the registration definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: "subscriptions/" + (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.Api20200201Preview.IRegistrationDefinition + +## 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. + + +AUTHORIZATION <IAuthorization[]>: The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. + - `PrincipalId <String>`: The identifier of the Azure Active Directory principal. + - `RoleDefinitionId <String>`: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. + - `[DelegatedRoleDefinitionId <String[]>]`: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other principals. + - `[PrincipalIdDisplayName <String>]`: The display name of the Azure Active Directory principal. + +ELIGIBLEAUTHORIZATION <IEligibleAuthorization[]>: The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. + - `PrincipalId <String>`: The identifier of the Azure Active Directory principal. + - `RoleDefinitionId <String>`: The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. + - `[JustInTimeAccessPolicyManagedByTenantApprover <IEligibleApprover[]>]`: The list of managedByTenant approvers for the eligible authorization. + - `PrincipalId <String>`: The identifier of the Azure Active Directory principal. + - `[PrincipalIdDisplayName <String>]`: The display name of the Azure Active Directory principal. + - `[JustInTimeAccessPolicyMaximumActivationDuration <TimeSpan?>]`: The maximum access duration in ISO 8601 format for just-in-time access requests. + - `[JustInTimeAccessPolicyMultiFactorAuthProvider <MultiFactorAuthProvider?>]`: The multi-factor authorization provider to be used for just-in-time access requests. + - `[PrincipalIdDisplayName <String>]`: The display name of the Azure Active Directory principal. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesEligibleApproverObject.md b/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesEligibleApproverObject.md new file mode 100644 index 0000000000..99a21cb9ac --- /dev/null +++ b/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesEligibleApproverObject.md @@ -0,0 +1,86 @@ +--- +external help file: +Module Name: Az.ManagedServices +online version: https://learn.microsoft.com/powershell/module/az.ManagedServices/new-AzManagedServicesEligibleApproverObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/New-AzManagedServicesEligibleApproverObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/New-AzManagedServicesEligibleApproverObject.md +--- + +# New-AzManagedServicesEligibleApproverObject + +## SYNOPSIS +Create an in-memory object for EligibleApprover. + +## SYNTAX + +``` +New-AzManagedServicesEligibleApproverObject -PrincipalId <String> [-PrincipalIdDisplayName <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for EligibleApprover. + +## EXAMPLES + +### Example 1: Creates Azure Lighthouse eligible authorization approver object +```powershell +New-AzManagedServicesEligibleApproverObject -PrincipalId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -PrincipalIdDisplayName "Approvers group" +``` + +```output +PrincipalId PrincipalIdDisplayName +----------- ---------------------- +xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Approvers group +``` + +Creates Azure Lighthouse eligible authorization approver object. + +## PARAMETERS + +### -PrincipalId +The identifier of the Azure Active Directory principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalIdDisplayName +The display name of the Azure Active Directory principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.Api20200201Preview.EligibleApprover + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesEligibleAuthorizationObject.md b/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesEligibleAuthorizationObject.md new file mode 100644 index 0000000000..7f6425a299 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServices/New-AzManagedServicesEligibleAuthorizationObject.md @@ -0,0 +1,179 @@ +--- +external help file: +Module Name: Az.ManagedServices +online version: https://learn.microsoft.com/powershell/module/az.ManagedServices/new-AzManagedServicesEligibleAuthorizationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/New-AzManagedServicesEligibleAuthorizationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/New-AzManagedServicesEligibleAuthorizationObject.md +--- + +# New-AzManagedServicesEligibleAuthorizationObject + +## SYNOPSIS +Create a in-memory object for EligibleAuthorization + +## SYNTAX + +``` +New-AzManagedServicesEligibleAuthorizationObject -PrincipalId <String> -RoleDefinitionId <String> + [-JustInTimeAccessPolicyManagedByTenantApprover <IEligibleApprover[]>] + [-JustInTimeAccessPolicyMaximumActivationDuration <TimeSpan>] + [-JustInTimeAccessPolicyMultiFactorAuthProvider <MultiFactorAuthProvider>] [-PrincipalIdDisplayName <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for EligibleAuthorization + +## EXAMPLES + +### Example 1: Creates new Azure Lighthouse eligible authorization object to use with Registration definition +```powershell +New-AzManagedServicesEligibleAuthorizationObject -PrincipalId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -PrincipalIdDisplayName "Test user" -RoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +```output +PrincipalId PrincipalIdDisplayName RoleDefinitionId +----------- ---------------------- ---------------- +xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Test user xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +``` + +Creates new Azure Lighthouse eligible authorization object to use with Registration definition. + +### Example 2: Create new Azure Lighthouse eligible authorization with JustInTime settings +```powershell +$approver = New-AzManagedServicesEligibleApproverObject -PrincipalId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -PrincipalIdDisplayName "Approver group" + +$eligibleAuth = New-AzManagedServicesEligibleAuthorizationObject -PrincipalId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -PrincipalIdDisplayName "Test user" -RoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -JustInTimeAccessPolicyManagedByTenantApprover $approver -JustInTimeAccessPolicyMultiFactorAuthProvider Azure -JustInTimeAccessPolicyMaximumActivationDuration 0:30 + +$eligibleAuth | Format-List -Property PrinciPalId, PrincipalIdDisplayName, RoleDefinitionId, JustInTimeAccessPolicyManagedByTenantApprover, JustInTimeAccessPolicyMultiFactorAuthProvider, JustInTimeAccessPolicyMaximumActivationDuration +``` + +```output +PrincipalId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +PrincipalIdDisplayName : Test user +RoleDefinitionId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +JustInTimeAccessPolicyManagedByTenantApprover : {Approver group} +JustInTimeAccessPolicyMultiFactorAuthProvider : Azure +JustInTimeAccessPolicyMaximumActivationDuration : 00:30:00 +``` + +Creates new Azure Lighthouse eligible authorization object with JustInTime (JIT) settings. + +## PARAMETERS + +### -JustInTimeAccessPolicyManagedByTenantApprover +The list of managedByTenant approvers for the eligible authorization. +To construct, see NOTES section for JUSTINTIMEACCESSPOLICYMANAGEDBYTENANTAPPROVER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.Api20200201Preview.IEligibleApprover[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JustInTimeAccessPolicyMaximumActivationDuration +The maximum access duration in ISO 8601 format for just-in-time access requests. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JustInTimeAccessPolicyMultiFactorAuthProvider +The multi-factor authorization provider to be used for just-in-time access requests. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Support.MultiFactorAuthProvider +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalId +The identifier of the Azure Active Directory principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalIdDisplayName +The display name of the Azure Active Directory principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.Api20200201Preview.EligibleAuthorization + +## 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. + + +JUSTINTIMEACCESSPOLICYMANAGEDBYTENANTAPPROVER <IEligibleApprover[]>: The list of managedByTenant approvers for the eligible authorization. + - `PrincipalId <String>`: The identifier of the Azure Active Directory principal. + - `[PrincipalIdDisplayName <String>]`: The display name of the Azure Active Directory principal. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServices/Remove-AzManagedServicesAssignment.md b/azps-10.1.0/Az.ManagedServices/Remove-AzManagedServicesAssignment.md new file mode 100644 index 0000000000..20e63bdf81 --- /dev/null +++ b/azps-10.1.0/Az.ManagedServices/Remove-AzManagedServicesAssignment.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.ManagedServices +online version: https://learn.microsoft.com/powershell/module/az.managedservices/remove-azmanagedservicesassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/Remove-AzManagedServicesAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/Remove-AzManagedServicesAssignment.md +--- + +# Remove-AzManagedServicesAssignment + +## SYNOPSIS +Deletes the specified registration assignment. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzManagedServicesAssignment -Name <String> [-Scope <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzManagedServicesAssignment -InputObject <IManagedServicesIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified registration assignment. + +## EXAMPLES + +### Example 1: Removes Azure Lighthouse registration assignment at subscription scope +```powershell +Remove-AzManagedServicesAssignment -Name "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Scope "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +Removes Azure Lighthouse registration assignment at subscription scope. + +### Example 2: Removes Azure Lighthouse registration assignment at resource group scope +```powershell +Remove-AzManagedServicesAssignment -Name "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Scope "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testgroup" +``` + +Removes Azure Lighthouse registration assignment at resource group scope. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.IManagedServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The GUID of the registration assignment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: RegistrationAssignmentId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: "subscriptions/" + (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.IManagedServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IManagedServicesIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[MarketplaceIdentifier <String>]`: The Azure Marketplace identifier. Expected formats: {publisher}.{product[-preview]}.{planName}.{version} or {publisher}.{product[-preview]}.{planName} or {publisher}.{product[-preview]} or {publisher}). + - `[RegistrationAssignmentId <String>]`: The GUID of the registration assignment. + - `[RegistrationDefinitionId <String>]`: The GUID of the registration definition. + - `[Scope <String>]`: The scope of the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagedServices/Remove-AzManagedServicesDefinition.md b/azps-10.1.0/Az.ManagedServices/Remove-AzManagedServicesDefinition.md new file mode 100644 index 0000000000..b8414ce1db --- /dev/null +++ b/azps-10.1.0/Az.ManagedServices/Remove-AzManagedServicesDefinition.md @@ -0,0 +1,178 @@ +--- +external help file: +Module Name: Az.ManagedServices +online version: https://learn.microsoft.com/powershell/module/az.managedservices/remove-azmanagedservicesdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/Remove-AzManagedServicesDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagedServices/help/Remove-AzManagedServicesDefinition.md +--- + +# Remove-AzManagedServicesDefinition + +## SYNOPSIS +Deletes the registration definition. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzManagedServicesDefinition -Name <String> [-Scope <String>] [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzManagedServicesDefinition -InputObject <IManagedServicesIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the registration definition. + +## EXAMPLES + +### Example 1: Removes Azure Lighthouse registration definition +```powershell +Remove-AzManagedServicesDefinition -Name xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Scope "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +Removes Azure Lighthouse registration definition at the given scope. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.IManagedServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The GUID of the registration definition. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: RegistrationDefinitionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: "subscriptions/" + (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.IManagedServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IManagedServicesIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[MarketplaceIdentifier <String>]`: The Azure Marketplace identifier. Expected formats: {publisher}.{product[-preview]}.{planName}.{version} or {publisher}.{product[-preview]}.{planName} or {publisher}.{product[-preview]} or {publisher}). + - `[RegistrationAssignmentId <String>]`: The GUID of the registration assignment. + - `[RegistrationDefinitionId <String>]`: The GUID of the registration definition. + - `[Scope <String>]`: The scope of the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ManagementPartner/Az.ManagementPartner.md b/azps-10.1.0/Az.ManagementPartner/Az.ManagementPartner.md new file mode 100644 index 0000000000..a227380b33 --- /dev/null +++ b/azps-10.1.0/Az.ManagementPartner/Az.ManagementPartner.md @@ -0,0 +1,27 @@ +--- +Module Name: Az.ManagementPartner +Module Guid: bf60f35d-6c0b-42f2-be30-eb333a31279d +Download Help Link: https://learn.microsoft.com/powershell/module/az.managementpartner +Help Version: 0.1.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagementPartner/ManagementPartner/help/Az.ManagementPartner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagementPartner/ManagementPartner/help/Az.ManagementPartner.md +--- + +# Az.ManagementPartner Module +## Description +Management Partner cmdlets for Azure Resource Manager. + +## Az.ManagementPartner Cmdlets +### [Get-AzManagementPartner](Get-AzManagementPartner.md) +Gets the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. + +### [New-AzManagementPartner](New-AzManagementPartner.md) +Associates a Microsoft Partner Network(MPN) ID to the current authenticated user or service principal. + +### [Remove-AzManagementPartner](Remove-AzManagementPartner.md) +Delete the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. + +### [Update-AzManagementPartner](Update-AzManagementPartner.md) +Updates the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. + diff --git a/azps-10.1.0/Az.ManagementPartner/Get-AzManagementPartner.md b/azps-10.1.0/Az.ManagementPartner/Get-AzManagementPartner.md new file mode 100644 index 0000000000..fd8c4bb2ca --- /dev/null +++ b/azps-10.1.0/Az.ManagementPartner/Get-AzManagementPartner.md @@ -0,0 +1,107 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ManagementPartner.dll-Help.xml +Module Name: Az.ManagementPartner +online version: https://learn.microsoft.com/powershell/module/az.managementpartner/get-azmanagementpartner +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagementPartner/ManagementPartner/help/Get-AzManagementPartner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagementPartner/ManagementPartner/help/Get-AzManagementPartner.md +--- + +# Get-AzManagementPartner + +## SYNOPSIS +Gets the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. + +## SYNTAX + +``` +Get-AzManagementPartner [[-PartnerId] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzManagementPartner +``` + +```output +PartnerId : 4977985 +PartnerName : Test_Test_DPORTest +TenantId : 1b1121dd-6900-412a-af73-e8d44f81e1c1 +ObjectId : aa67f786-0552-423e-8849-244ed12bf581 +State : Active +``` + +Get the current management partner id + +### Example 2 +```powershell +Get-AzManagementPartner -PartnerId 4977985 +``` + +```output +PartnerId : 4977985 +PartnerName : Test_Test_DPORTest +TenantId : 1b1121dd-6900-412a-af73-e8d44f81e1c1 +ObjectId : aa67f786-0552-423e-8849-244ed12bf581 +State : Active +``` + +Get the current management partner id using a partner id, if they don't match, it will fail + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerId +The management partner id, it is a 6 digits number + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ManagementPartner.PSManagementPartner + +## NOTES + +## RELATED LINKS + +[Remove-AzManagementPartner](./Remove-AzManagementPartner.md) + +[New-AzManagementPartner](./New-AzManagementPartner.md) + +[Update-AzManagementPartner](./Update-AzManagementPartner.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ManagementPartner/New-AzManagementPartner.md b/azps-10.1.0/Az.ManagementPartner/New-AzManagementPartner.md new file mode 100644 index 0000000000..344fed201c --- /dev/null +++ b/azps-10.1.0/Az.ManagementPartner/New-AzManagementPartner.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ManagementPartner.dll-Help.xml +Module Name: Az.ManagementPartner +online version: https://learn.microsoft.com/powershell/module/az.managementpartner/new-azmanagementpartner +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagementPartner/ManagementPartner/help/New-AzManagementPartner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagementPartner/ManagementPartner/help/New-AzManagementPartner.md +--- + +# New-AzManagementPartner + +## SYNOPSIS +Associates a Microsoft Partner Network(MPN) ID to the current authenticated user or service principal. + +## SYNTAX + +``` +New-AzManagementPartner [-PartnerId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Associates a Microsoft Partner Network(MPN) ID to the current authenticated user or service principal. + +## EXAMPLES + +### Example 1 +```powershell +New-AzManagementPartner -PartnerId 4977985 +``` + +```output +PartnerId : 4977985 +PartnerName : Test_Test_DPORTest +TenantId : 1b1121dd-6900-412a-af73-e8d44f81e1c1 +ObjectId : aa67f786-0552-423e-8849-244ed12bf581 +State : Active +``` + +Add a management partner + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerId +The management partner id, it is a 6 digits number + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ManagementPartner.PSManagementPartner + +## NOTES + +## RELATED LINKS + +[Remove-AzManagementPartner](./Remove-AzManagementPartner.md) + +[Get-AzManagementPartner](./Get-AzManagementPartner.md) + +[Update-AzManagementPartner](./Update-AzManagementPartner.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ManagementPartner/Remove-AzManagementPartner.md b/azps-10.1.0/Az.ManagementPartner/Remove-AzManagementPartner.md new file mode 100644 index 0000000000..42bf24dd66 --- /dev/null +++ b/azps-10.1.0/Az.ManagementPartner/Remove-AzManagementPartner.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ManagementPartner.dll-Help.xml +Module Name: Az.ManagementPartner +online version: https://learn.microsoft.com/powershell/module/az.managementpartner/remove-azmanagementpartner +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagementPartner/ManagementPartner/help/Remove-AzManagementPartner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagementPartner/ManagementPartner/help/Remove-AzManagementPartner.md +--- + +# Remove-AzManagementPartner + +## SYNOPSIS +Delete the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. + +## SYNTAX + +``` +Remove-AzManagementPartner [-PartnerId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzManagementPartner -PartnerId 123457 -PassThru +``` + +```output +true +``` + +Remove management partner + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerId +The management partner id, it is a 6 digits number + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzManagementPartner](./New-AzManagementPartner.md) + +[Get-AzManagementPartner](./Get-AzManagementPartner.md) + +[Update-AzManagementPartner](./Update-AzManagementPartner.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ManagementPartner/Update-AzManagementPartner.md b/azps-10.1.0/Az.ManagementPartner/Update-AzManagementPartner.md new file mode 100644 index 0000000000..f742eb1f8e --- /dev/null +++ b/azps-10.1.0/Az.ManagementPartner/Update-AzManagementPartner.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ManagementPartner.dll-Help.xml +Module Name: Az.ManagementPartner +online version: https://learn.microsoft.com/powershell/module/az.managementpartner/update-azmanagementpartner +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagementPartner/ManagementPartner/help/Update-AzManagementPartner.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ManagementPartner/ManagementPartner/help/Update-AzManagementPartner.md +--- + +# Update-AzManagementPartner + +## SYNOPSIS +Updates the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. + +## SYNTAX + +``` +Update-AzManagementPartner [-PartnerId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzManagementPartner -PartnerId 4977985 +``` + +```output +PartnerId : 4977985 +PartnerName : Test_Test_DPORTest +TenantId : 1b1121dd-6900-412a-af73-e8d44f81e1c1 +ObjectId : aa67f786-0552-423e-8849-244ed12bf581 +State : Active +``` + +Update the management partner to a new one + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerId +The management partner id, it is a 6 digits number + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ManagementPartner.PSManagementPartner + +## NOTES + +## RELATED LINKS + +[Remove-AzManagementPartner](./Remove-AzManagementPartner.md) + +[New-AzManagementPartner](./New-AzManagementPartner.md) + +[Get-AzManagementPartner](./Get-AzManagementPartner.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Maps/Az.Maps.md b/azps-10.1.0/Az.Maps/Az.Maps.md new file mode 100644 index 0000000000..8f402aba59 --- /dev/null +++ b/azps-10.1.0/Az.Maps/Az.Maps.md @@ -0,0 +1,56 @@ +--- +Module Name: Az.Maps +Module Guid: dc0410d0-8396-4441-a4d3-fdaaa915369d +Download Help Link: https://learn.microsoft.com/powershell/module/az.maps +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Az.Maps.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Az.Maps.md +--- + +# Az.Maps Module +## Description +Microsoft Azure PowerShell: Maps cmdlets + +## Az.Maps Cmdlets +### [Get-AzMapsAccount](Get-AzMapsAccount.md) +Get a Maps Account. + +### [Get-AzMapsAccountKey](Get-AzMapsAccountKey.md) +Get the keys to use with the Maps APIs. +A key is used to authenticate and authorize access to the Maps REST APIs. +Only one key is needed at a time; two are given to provide seamless key regeneration. + +### [Get-AzMapsCreator](Get-AzMapsCreator.md) +Get a Maps Creator resource. + +### [Get-AzMapsSubscriptionOperation](Get-AzMapsSubscriptionOperation.md) +List operations available for the Maps Resource Provider + +### [New-AzMapsAccount](New-AzMapsAccount.md) +Create or update a Maps Account. +A Maps Account holds the keys which allow access to the Maps REST APIs. + +### [New-AzMapsAccountKey](New-AzMapsAccountKey.md) +Regenerate either the primary or secondary key for use with the Maps APIs. +The old key will stop working immediately. + +### [New-AzMapsCreator](New-AzMapsCreator.md) +Create or update a Maps Creator resource. +Creator resource will manage Azure resources required to populate a custom set of mapping data. +It requires an account to exist before it can be created. + +### [Remove-AzMapsAccount](Remove-AzMapsAccount.md) +Delete a Maps Account. + +### [Remove-AzMapsCreator](Remove-AzMapsCreator.md) +Delete a Maps Creator resource. + +### [Update-AzMapsAccount](Update-AzMapsAccount.md) +Updates a Maps Account. +Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties. + +### [Update-AzMapsCreator](Update-AzMapsCreator.md) +Updates the Maps Creator resource. +Only a subset of the parameters may be updated after creation, such as Tags. + diff --git a/azps-10.1.0/Az.Maps/Get-AzMapsAccount.md b/azps-10.1.0/Az.Maps/Get-AzMapsAccount.md new file mode 100644 index 0000000000..29be93dc14 --- /dev/null +++ b/azps-10.1.0/Az.Maps/Get-AzMapsAccount.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.Maps +online version: https://learn.microsoft.com/powershell/module/az.maps/get-azmapsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Get-AzMapsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Get-AzMapsAccount.md +--- + +# Get-AzMapsAccount + +## SYNOPSIS +Get a Maps Account. + +## SYNTAX + +### List1 (Default) +``` +Get-AzMapsAccount [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMapsAccount -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMapsAccount -InputObject <IMapsIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzMapsAccount -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a Maps Account. + +## EXAMPLES + +### Example 1: List all Maps Accounts under a subscription +```powershell +Get-AzMapsAccount +``` + +```output +Location Name Type Kind +-------- ---- ---- ---- +eastus pwsh-mapsAccount01 Microsoft.Maps/accounts Gen1 +``` + +This command lists all Maps Accounts under a subscription. + +### Example 2: List all Maps Accounts under a resource group +```powershell +Get-AzMapsAccount -ResourceGroupName azure-rg-test +``` + +```output +Location Name Type Kind +-------- ---- ---- ---- +eastus pwsh-mapsAccount01 Microsoft.Maps/accounts Gen1 +``` + +This command lists all Maps Accounts under a resource group. + +### Example 3: Get a Maps Account +```powershell +Get-AzMapsAccount -ResourceGroupName azure-rg-test -Name pwsh-mapsAccount01 +``` + +```output +Location Name Type Kind +-------- ---- ---- ---- +eastus pwsh-mapsAccount01 Microsoft.Maps/accounts Gen1 +``` + +This command gets a Maps Account. + +### Example 4: Get a Maps Account by pipeline +```powershell +New-AzMapsAccount -ResourceGroupName azure-rg-test -Name pwsh-mapsAccount01 -SkuName S0 -Location eastus | Get-AzMapsAccount +``` + +```output +Location Name Type Kind +-------- ---- ---- ---- +eastus pwsh-mapsAccount01 Microsoft.Maps/accounts Gen1 +``` + +This command gets a Maps Account by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Maps Account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.Api20210201.IMapsAccount + +## 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 `<IMapsIdentity>`: Identity Parameter + - `[AccountName <String>]`: The name of the Maps Account. + - `[CreatorName <String>]`: The name of the Maps Creator instance. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Maps/Get-AzMapsAccountKey.md b/azps-10.1.0/Az.Maps/Get-AzMapsAccountKey.md new file mode 100644 index 0000000000..131ab5a931 --- /dev/null +++ b/azps-10.1.0/Az.Maps/Get-AzMapsAccountKey.md @@ -0,0 +1,154 @@ +--- +external help file: +Module Name: Az.Maps +online version: https://learn.microsoft.com/powershell/module/az.maps/get-azmapsaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Get-AzMapsAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Get-AzMapsAccountKey.md +--- + +# Get-AzMapsAccountKey + +## SYNOPSIS +Get the keys to use with the Maps APIs. +A key is used to authenticate and authorize access to the Maps REST APIs. +Only one key is needed at a time; two are given to provide seamless key regeneration. + +## SYNTAX + +``` +Get-AzMapsAccountKey -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Get the keys to use with the Maps APIs. +A key is used to authenticate and authorize access to the Maps REST APIs. +Only one key is needed at a time; two are given to provide seamless key regeneration. + +## EXAMPLES + +### Example 1: Get the keys to use with the Maps APIs +```powershell +Get-AzMapsAccountKey -ResourceGroupName azure-rg-test -Name pwsh-mapsAccount02 +``` + +```output +PrimaryKey PrimaryKeyLastUpdated SecondaryKey SecondaryKeyLastUpdated +---------- --------------------- ------------ ----------------------- +AZPcJC8OCNCpqRsnj1NB3Ngl-qQncBP5IT21jts_2b0 2021-05-20T05:59:16.2028276Z 3l_cups4uVp7LB90G861PB_ddEFJFOdt0beX1U8ROO4 2021-05-20T05:59:16.2028276Z +``` + +This command get the keys to use with the Maps APIs. +A key is used to authenticate and authorize access to the Maps REST APIs. +Only one key is needed at a time; two are given to provide seamless key regeneration. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Maps Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.Api20210201.IMapsAccountKeys + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Maps/Get-AzMapsCreator.md b/azps-10.1.0/Az.Maps/Get-AzMapsCreator.md new file mode 100644 index 0000000000..0747e5aaf0 --- /dev/null +++ b/azps-10.1.0/Az.Maps/Get-AzMapsCreator.md @@ -0,0 +1,200 @@ +--- +external help file: +Module Name: Az.Maps +online version: https://learn.microsoft.com/powershell/module/az.maps/get-azmapscreator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Get-AzMapsCreator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Get-AzMapsCreator.md +--- + +# Get-AzMapsCreator + +## SYNOPSIS +Get a Maps Creator resource. + +## SYNTAX + +### List (Default) +``` +Get-AzMapsCreator -AccountName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMapsCreator -AccountName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMapsCreator -InputObject <IMapsIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a Maps Creator resource. + +## EXAMPLES + +### Example 1: List all Maps Creator resources under a Maps Account +```powershell +Get-AzMapsCreator -ResourceGroupName azure-rg-test -AccountName pwsh-mapsAccount02 -Name creator-01 +``` + +```output +Location Name Type +-------- ---- ---- +eastus2 creator-01 Microsoft.Maps/accounts/creators +``` + +This command lists Maps Creator resources under a Maps Account. + +### Example 2: Get a Maps Creator resource +```powershell +Get-AzMapsCreator -ResourceGroupName azure-rg-test -AccountName pwsh-mapsAccount02 -Name creator-01 +``` + +```output +Location Name Type +-------- ---- ---- +eastus2 creator-01 Microsoft.Maps/accounts/creators +``` + +This command gets a Maps Creator resource. + +### Example 3: Get a Maps Creator resource by pipeline +```powershell +New-AzMapsCreator -ResourceGroupName azure-rg-test -AccountName pwsh-mapsAccount02 -Name creator-01 -Location eastus2 -StorageUnit 3 | Get-AzMapsCreator +``` + +```output +Location Name Type +-------- ---- ---- +eastus2 creator-01 Microsoft.Maps/accounts/creators +``` + +This command gets a Maps Creator resource by pipeline. + +## PARAMETERS + +### -AccountName +The name of the Maps Account. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Maps Creator instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CreatorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.Api20210201.ICreator + +## 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 `<IMapsIdentity>`: Identity Parameter + - `[AccountName <String>]`: The name of the Maps Account. + - `[CreatorName <String>]`: The name of the Maps Creator instance. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Maps/Get-AzMapsSubscriptionOperation.md b/azps-10.1.0/Az.Maps/Get-AzMapsSubscriptionOperation.md new file mode 100644 index 0000000000..520e4cd6f7 --- /dev/null +++ b/azps-10.1.0/Az.Maps/Get-AzMapsSubscriptionOperation.md @@ -0,0 +1,122 @@ +--- +external help file: +Module Name: Az.Maps +online version: https://learn.microsoft.com/powershell/module/az.maps/get-azmapssubscriptionoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Get-AzMapsSubscriptionOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Get-AzMapsSubscriptionOperation.md +--- + +# Get-AzMapsSubscriptionOperation + +## SYNOPSIS +List operations available for the Maps Resource Provider + +## SYNTAX + +``` +Get-AzMapsSubscriptionOperation [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List operations available for the Maps Resource Provider + +## EXAMPLES + +### Example 1: List operations available for the Maps Resource Provider +```powershell +Get-AzMapsSubscriptionOperation +``` + +```output +IsDataAction Name Origin +------------ ---- ------ + Microsoft.Maps/resourceTypes/read + Microsoft.Maps/unregister/action + Microsoft.Maps/operations/read + Microsoft.Maps/register/action + Microsoft.Maps/accounts/write + Microsoft.Maps/accounts/read + Microsoft.Maps/accounts/delete + Microsoft.Maps/accounts/listKeys/action + Microsoft.Maps/accounts/regenerateKey/action + Microsoft.Maps/accounts/eventGridFilters/delete + Microsoft.Maps/accounts/eventGridFilters/read + Microsoft.Maps/accounts/eventGridFilters/write + Microsoft.Maps/accounts/providers/Microsoft.Insights/metricDefinitions/read system + Microsoft.Maps/accounts/providers/Microsoft.Insights/diagnosticSettings/read system + Microsoft.Maps/accounts/providers/Microsoft.Insights/diagnosticSettings/write system +True Microsoft.Maps/accounts/services/render/read +True Microsoft.Maps/accounts/services/geolocation/read +True Microsoft.Maps/accounts/services/mobility/read +True Microsoft.Maps/accounts/services/route/read +True Microsoft.Maps/accounts/services/search/read +True Microsoft.Maps/accounts/services/timezone/read +True Microsoft.Maps/accounts/services/traffic/read +True Microsoft.Maps/accounts/services/weather/read +True Microsoft.Maps/accounts/services/data/read +True Microsoft.Maps/accounts/services/data/delete +True Microsoft.Maps/accounts/services/data/write +True Microsoft.Maps/accounts/services/spatial/read +True Microsoft.Maps/accounts/services/spatial/write +True Microsoft.Maps/accounts/services/turnbyturn/read +True Microsoft.Maps/accounts/services/elevation/read +True Microsoft.Maps/accounts/services/dataordering/read +True Microsoft.Maps/accounts/services/dataordering/write +True Microsoft.Maps/accounts/services/analytics/read +True Microsoft.Maps/accounts/services/analytics/delete +True Microsoft.Maps/accounts/services/analytics/write + Microsoft.Maps/accounts/creators/write + Microsoft.Maps/accounts/creators/read + Microsoft.Maps/accounts/creators/delete +``` + +This command lists operations available for the Maps Resource Provider. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.Api20210201.IOperationDetail + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Maps/New-AzMapsAccount.md b/azps-10.1.0/Az.Maps/New-AzMapsAccount.md new file mode 100644 index 0000000000..22721c22e3 --- /dev/null +++ b/azps-10.1.0/Az.Maps/New-AzMapsAccount.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.Maps +online version: https://learn.microsoft.com/powershell/module/az.maps/new-azmapsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/New-AzMapsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/New-AzMapsAccount.md +--- + +# New-AzMapsAccount + +## SYNOPSIS +Create or update a Maps Account. +A Maps Account holds the keys which allow access to the Maps REST APIs. + +## SYNTAX + +``` +New-AzMapsAccount -Name <String> -ResourceGroupName <String> -Location <String> -SkuName <Name> + [-SubscriptionId <String>] [-DisableLocalAuth] [-Kind <Kind>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a Maps Account. +A Maps Account holds the keys which allow access to the Maps REST APIs. + +## EXAMPLES + +### Example 1: Create a Maps Account. +```powershell +New-AzMapsAccount -ResourceGroupName azure-rg-test -Name pwsh-mapsAccount01 -SkuName S0 -Location eastus +``` + +```output +Location Name Type Kind +-------- ---- ---- ---- +eastus pwsh-mapsAccount01 Microsoft.Maps/accounts Gen1 +``` + +This command creates a Maps Account.A Maps Account holds the keys which allow access to the Maps REST APIs. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. +This will disable Shared Keys authentication from any usage. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Get or Set Kind property. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Maps.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Maps Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU, in standard format (such as S0). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Maps.Support.Name +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.Api20210201.IMapsAccount + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Maps/New-AzMapsAccountKey.md b/azps-10.1.0/Az.Maps/New-AzMapsAccountKey.md new file mode 100644 index 0000000000..107f98094e --- /dev/null +++ b/azps-10.1.0/Az.Maps/New-AzMapsAccountKey.md @@ -0,0 +1,217 @@ +--- +external help file: +Module Name: Az.Maps +online version: https://learn.microsoft.com/powershell/module/az.maps/new-azmapsaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/New-AzMapsAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/New-AzMapsAccountKey.md +--- + +# New-AzMapsAccountKey + +## SYNOPSIS +Regenerate either the primary or secondary key for use with the Maps APIs. +The old key will stop working immediately. + +## SYNTAX + +### RegenerateExpanded (Default) +``` +New-AzMapsAccountKey -Name <String> -ResourceGroupName <String> -KeyType <KeyType> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RegenerateViaIdentityExpanded +``` +New-AzMapsAccountKey -InputObject <IMapsIdentity> -KeyType <KeyType> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerate either the primary or secondary key for use with the Maps APIs. +The old key will stop working immediately. + +## EXAMPLES + +### Example 1: Regenerate either the primary or secondary key for use with the Maps APIs +```powershell +New-AzMapsAccountKey -ResourceGroupName azure-rg-test -Name pwsh-mapsAccount01 -KeyType primary +``` + +```output +PrimaryKey PrimaryKeyLastUpdated SecondaryKey SecondaryKeyLastUpdated +---------- --------------------- ------------ ----------------------- +W5VYcbrpyt4urV2-4C-lXepnHoy6EIOHnoLL_wjEtaw 2021-05-20T05:50:27.1509422Z zi6W1bw4zIYLjDj_DRRrC3jBkX-APgBebwx4cZBKJOU 2021-05-20T05:41:03.452571Z +``` + +This command regenerate either the primary or secondary key for use with the Maps APIs. +The old key will stop working immediately. + +### Example 2: Regenerate either the primary or secondary key for use with the Maps APIs by pipeline +```powershell +Get-AzMapsAccount -ResourceGroupName azure-rg-test -Name pwsh-mapsAccount01 | New-AzMapsAccountKey -KeyType primary +``` + +```output +PrimaryKey PrimaryKeyLastUpdated SecondaryKey SecondaryKeyLastUpdated +---------- --------------------- ------------ ----------------------- +xoGsuTFWuG6xq0re7EdA7nCbDhvRoisZfLHvKfdzIhQ 2021-05-20T05:55:21.7797268Z zi6W1bw4zIYLjDj_DRRrC3jBkX-APgBebwx4cZBKJOU 2021-05-20T05:41:03.452571Z +``` + +This command regenerate either the primary or secondary key for use with the Maps APIs by pipeline. +The old key will stop working immediately. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity +Parameter Sets: RegenerateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyType +Whether the operation refers to the primary or secondary key. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Maps.Support.KeyType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Maps Account. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.Api20210201.IMapsAccountKeys + +## 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 `<IMapsIdentity>`: Identity Parameter + - `[AccountName <String>]`: The name of the Maps Account. + - `[CreatorName <String>]`: The name of the Maps Creator instance. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Maps/New-AzMapsCreator.md b/azps-10.1.0/Az.Maps/New-AzMapsCreator.md new file mode 100644 index 0000000000..678e04fc34 --- /dev/null +++ b/azps-10.1.0/Az.Maps/New-AzMapsCreator.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.Maps +online version: https://learn.microsoft.com/powershell/module/az.maps/new-azmapscreator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/New-AzMapsCreator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/New-AzMapsCreator.md +--- + +# New-AzMapsCreator + +## SYNOPSIS +Create or update a Maps Creator resource. +Creator resource will manage Azure resources required to populate a custom set of mapping data. +It requires an account to exist before it can be created. + +## SYNTAX + +``` +New-AzMapsCreator -AccountName <String> -Name <String> -ResourceGroupName <String> -Location <String> + -StorageUnit <Int32> [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a Maps Creator resource. +Creator resource will manage Azure resources required to populate a custom set of mapping data. +It requires an account to exist before it can be created. + +## EXAMPLES + +### Example 1: Create a Maps Creator resource +```powershell +New-AzMapsCreator -ResourceGroupName azure-rg-test -AccountName pwsh-mapsAccount02 -Name creator-01 -Location eastus2 -StorageUnit 3 +``` + +```output +Location Name Type +-------- ---- ---- +eastus2 creator-01 Microsoft.Maps/accounts/creators +``` + +This command creates a Maps Creator resource. +Creator resource will manage Azure resources required to populate a custom set of mapping data. +It requires an account to exist before it can be created. + +## PARAMETERS + +### -AccountName +The name of the Maps Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Maps Creator instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CreatorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageUnit +The storage units to be allocated. +Integer values from 1 to 100, inclusive. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.Api20210201.ICreator + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Maps/Remove-AzMapsAccount.md b/azps-10.1.0/Az.Maps/Remove-AzMapsAccount.md new file mode 100644 index 0000000000..fa375073df --- /dev/null +++ b/azps-10.1.0/Az.Maps/Remove-AzMapsAccount.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.Maps +online version: https://learn.microsoft.com/powershell/module/az.maps/remove-azmapsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Remove-AzMapsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Remove-AzMapsAccount.md +--- + +# Remove-AzMapsAccount + +## SYNOPSIS +Delete a Maps Account. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMapsAccount -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMapsAccount -InputObject <IMapsIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a Maps Account. + +## EXAMPLES + +### Example 1: Delete a Maps Account +```powershell +Remove-AzMapsAccount -ResourceGroupName azure-rg-test -Name pwsh-mapsAccount01 +``` + +This command deletes a Maps Account. + +### Example 2: Delete a Maps Account by pipeline +```powershell +Get-AzMapsAccount -ResourceGroupName azure-rg-test -Name pwsh-mapsAccount02 | Remove-AzMapsAccount +``` + +This command deletes a Maps Account by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Maps Account. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMapsIdentity>`: Identity Parameter + - `[AccountName <String>]`: The name of the Maps Account. + - `[CreatorName <String>]`: The name of the Maps Creator instance. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Maps/Remove-AzMapsCreator.md b/azps-10.1.0/Az.Maps/Remove-AzMapsCreator.md new file mode 100644 index 0000000000..f07ec4bd03 --- /dev/null +++ b/azps-10.1.0/Az.Maps/Remove-AzMapsCreator.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.Maps +online version: https://learn.microsoft.com/powershell/module/az.maps/remove-azmapscreator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Remove-AzMapsCreator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Remove-AzMapsCreator.md +--- + +# Remove-AzMapsCreator + +## SYNOPSIS +Delete a Maps Creator resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMapsCreator -AccountName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMapsCreator -InputObject <IMapsIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a Maps Creator resource. + +## EXAMPLES + +### Example 1: Delete a Maps Creator resource +```powershell +Remove-AzMapsCreator -ResourceGroupName azure-rg-test -AccountName pwsh-mapsAccount03 -Name creator-01 +``` + +This command deletes a Maps Creator resource. + +### Example 2: Delete a Maps Creator resource by pipeline +```powershell +Get-AzMapsCreator -ResourceGroupName azure-rg-test -AccountName pwsh-mapsAccount02 -Name creator-01 | Remove-AzMapsCreator +``` + +This command deletes a Maps Creator resource by pipeline. + +## PARAMETERS + +### -AccountName +The name of the Maps Account. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Maps Creator instance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CreatorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMapsIdentity>`: Identity Parameter + - `[AccountName <String>]`: The name of the Maps Account. + - `[CreatorName <String>]`: The name of the Maps Creator instance. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Maps/Update-AzMapsAccount.md b/azps-10.1.0/Az.Maps/Update-AzMapsAccount.md new file mode 100644 index 0000000000..0418d3602d --- /dev/null +++ b/azps-10.1.0/Az.Maps/Update-AzMapsAccount.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: Az.Maps +online version: https://learn.microsoft.com/powershell/module/az.maps/update-azmapsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Update-AzMapsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Update-AzMapsAccount.md +--- + +# Update-AzMapsAccount + +## SYNOPSIS +Updates a Maps Account. +Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMapsAccount -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-DisableLocalAuth] + [-Kind <Kind>] [-SkuName <Name>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMapsAccount -InputObject <IMapsIdentity> [-DisableLocalAuth] [-Kind <Kind>] [-SkuName <Name>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a Maps Account. +Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties. + +## EXAMPLES + +### Example 1: Updates a Maps Account +```powershell +Update-AzMapsAccount -ResourceGroupName azure-rg-test -Name pwsh-mapsAccount03 -Tag @{'key1'='value1'; 'key2'='value2'} +``` + +```output +Location Name Type Kind +-------- ---- ---- ---- +eastus pwsh-mapsAccount03 Microsoft.Maps/accounts Gen1 +``` + +This command updates a Maps Account. +Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties. + +### Example 2: Updates a Maps Account by pipeline +```powershell +Get-AzMapsAccount -ResourceGroupName azure-rg-test -Name pwsh-mapsAccount03 | Update-AzMapsAccount -Tag @{'key1'='value1'; 'key2'='value2'} +``` + +```output +Location Name Type Kind +-------- ---- ---- ---- +eastus pwsh-mapsAccount03 Microsoft.Maps/accounts Gen1 +``` + +This command updates a Maps Account by pipeline. +Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. +This will disable Shared Keys authentication from any usage. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Get or Set Kind property. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Maps.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Maps Account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU, in standard format (such as S0). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Maps.Support.Name +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets a list of key value pairs that describe the resource. +These tags can be used in viewing and grouping this resource (across resource groups). +A maximum of 15 tags can be provided for a resource. +Each tag must have a key no greater than 128 characters and value no greater than 256 characters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.Api20210201.IMapsAccount + +## 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 `<IMapsIdentity>`: Identity Parameter + - `[AccountName <String>]`: The name of the Maps Account. + - `[CreatorName <String>]`: The name of the Maps Creator instance. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Maps/Update-AzMapsCreator.md b/azps-10.1.0/Az.Maps/Update-AzMapsCreator.md new file mode 100644 index 0000000000..b2b2d57707 --- /dev/null +++ b/azps-10.1.0/Az.Maps/Update-AzMapsCreator.md @@ -0,0 +1,252 @@ +--- +external help file: +Module Name: Az.Maps +online version: https://learn.microsoft.com/powershell/module/az.maps/update-azmapscreator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Update-AzMapsCreator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Maps/help/Update-AzMapsCreator.md +--- + +# Update-AzMapsCreator + +## SYNOPSIS +Updates the Maps Creator resource. +Only a subset of the parameters may be updated after creation, such as Tags. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMapsCreator -AccountName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-StorageUnit <Int32>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMapsCreator -InputObject <IMapsIdentity> [-StorageUnit <Int32>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the Maps Creator resource. +Only a subset of the parameters may be updated after creation, such as Tags. + +## EXAMPLES + +### Example 1: Updates the Maps Creator resource +```powershell +Update-AzMapsCreator -ResourceGroupName azure-rg-test -AccountName pwsh-mapsAccount03 -Name creator-01 -Tag @{'key1'='value1'; 'key2'='value2'} +``` + +```output +Location Name Type +-------- ---- ---- +eastus2 creator-01 Microsoft.Maps/accounts/creators +``` + +This command updates the Maps Creator resource. +Only a subset of the parameters may be updated after creation, such as Tags. + +### Example 2: Updates the Maps Creator resource by pipeline +```powershell +Get-AzMapsCreator -ResourceGroupName azure-rg-test -AccountName pwsh-mapsAccount03 -Name creator-01 | Update-AzMapsCreator -Tag @{'key1'='value1'; 'key2'='value2'} +``` + +```output +Location Name Type +-------- ---- ---- +eastus2 creator-01 Microsoft.Maps/accounts/creators +``` + +This command updates the Maps Creator resource by pipeline. +Only a subset of the parameters may be updated after creation, such as Tags. + +## PARAMETERS + +### -AccountName +The name of the Maps Account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Maps Creator instance. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: CreatorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageUnit +The storage units to be allocated. +Integer values from 1 to 100, inclusive. + +```yaml +Type: System.Int32 +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets a list of key value pairs that describe the resource. +These tags can be used in viewing and grouping this resource (across resource groups). +A maximum of 15 tags can be provided for a resource. +Each tag must have a key no greater than 128 characters and value no greater than 256 characters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.IMapsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Maps.Models.Api20210201.ICreator + +## 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 `<IMapsIdentity>`: Identity Parameter + - `[AccountName <String>]`: The name of the Maps Account. + - `[CreatorName <String>]`: The name of the Maps Creator instance. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Az.MariaDb.md b/azps-10.1.0/Az.MariaDb/Az.MariaDb.md new file mode 100644 index 0000000000..8e1455e36c --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Az.MariaDb.md @@ -0,0 +1,75 @@ +--- +Module Name: Az.MariaDb +Module Guid: c3b6a676-7237-4989-99d0-9df520acda9f +Download Help Link: https://learn.microsoft.com/powershell/module/az.mariadb +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Az.MariaDb.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Az.MariaDb.md +--- + +# Az.MariaDb Module +## Description +Microsoft Azure PowerShell: MariaDb cmdlets + +## Az.MariaDb Cmdlets +### [Get-AzMariaDbConfiguration](Get-AzMariaDbConfiguration.md) +Gets information about a configuration of server. + +### [Get-AzMariaDbConnectionString](Get-AzMariaDbConnectionString.md) +Get connection string of a MariaDB under a given framework. + +### [Get-AzMariaDbFirewallRule](Get-AzMariaDbFirewallRule.md) +Gets information about a server firewall rule. + +### [Get-AzMariaDbReplica](Get-AzMariaDbReplica.md) +List all the replicas for a given server. + +### [Get-AzMariaDbServer](Get-AzMariaDbServer.md) +Gets information about a server. + +### [Get-AzMariaDbVirtualNetworkRule](Get-AzMariaDbVirtualNetworkRule.md) +Gets a virtual network rule. + +### [New-AzMariaDbFirewallRule](New-AzMariaDbFirewallRule.md) +Creates a new firewall rule or updates an existing firewall rule. + +### [New-AzMariaDbReplica](New-AzMariaDbReplica.md) +Creates a replica of a MariaDB server. + +### [New-AzMariaDbServer](New-AzMariaDbServer.md) +Creates a new MariaDB. + +### [New-AzMariaDbVirtualNetworkRule](New-AzMariaDbVirtualNetworkRule.md) +Creates or updates an existing virtual network rule. + +### [Remove-AzMariaDbFirewallRule](Remove-AzMariaDbFirewallRule.md) +Deletes a server firewall rule. + +### [Remove-AzMariaDbServer](Remove-AzMariaDbServer.md) +Deletes a server. + +### [Remove-AzMariaDbVirtualNetworkRule](Remove-AzMariaDbVirtualNetworkRule.md) +Deletes the virtual network rule with the given name. + +### [Restart-AzMariaDbServer](Restart-AzMariaDbServer.md) +Restarts a server. + +### [Restore-AzMariaDbServer](Restore-AzMariaDbServer.md) +Restore a MariaDB from a existing MariaDB. + +### [Update-AzMariaDbConfiguration](Update-AzMariaDbConfiguration.md) +Updates a configuration of a server. +Use Update-AzMariaDberver instead if you want update AdministratorLoginPassword, sku, etc. + +### [Update-AzMariaDbFirewallRule](Update-AzMariaDbFirewallRule.md) +Creates a new firewall rule or updates an existing firewall rule. + +### [Update-AzMariaDbServer](Update-AzMariaDbServer.md) +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzMariaDbConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +### [Update-AzMariaDbVirtualNetworkRule](Update-AzMariaDbVirtualNetworkRule.md) +Creates or updates an existing virtual network rule. + diff --git a/azps-10.1.0/Az.MariaDb/Get-AzMariaDbConfiguration.md b/azps-10.1.0/Az.MariaDb/Get-AzMariaDbConfiguration.md new file mode 100644 index 0000000000..f5e3699069 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Get-AzMariaDbConfiguration.md @@ -0,0 +1,346 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/get-azmariadbconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Get-AzMariaDbConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Get-AzMariaDbConfiguration.md +--- + +# Get-AzMariaDbConfiguration + +## SYNOPSIS +Gets information about a configuration of server. + +## SYNTAX + +### List (Default) +``` +Get-AzMariaDbConfiguration -ResourceGroupName <String> -ServerName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMariaDbConfiguration -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMariaDbConfiguration -InputObject <IMariaDbIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a configuration of server. + +## EXAMPLES + +### Example 1: List all configuration under a MariaDB +```powershell +Get-AzMariaDbConfiguration -ServerName mariadb-asd-01 -ResourceGroupName mariadb-test-qu5ov0 +``` + +```output +Name Type +---- ---- +audit_log_enabled Microsoft.DBforMariaDB/servers/configurations +audit_log_events Microsoft.DBforMariaDB/servers/configurations +audit_log_exclude_users Microsoft.DBforMariaDB/servers/configurations +audit_log_include_users Microsoft.DBforMariaDB/servers/configurations +binlog_row_image Microsoft.DBforMariaDB/servers/configurations +character_set_server Microsoft.DBforMariaDB/servers/configurations +collation_server Microsoft.DBforMariaDB/servers/configurations +default_regex_flags Microsoft.DBforMariaDB/servers/configurations +default_week_format Microsoft.DBforMariaDB/servers/configurations +delayed_insert_limit Microsoft.DBforMariaDB/servers/configurations +delayed_insert_timeout Microsoft.DBforMariaDB/servers/configurations +delayed_queue_size Microsoft.DBforMariaDB/servers/configurations +div_precision_increment Microsoft.DBforMariaDB/servers/configurations +event_scheduler Microsoft.DBforMariaDB/servers/configurations +expensive_subquery_limit Microsoft.DBforMariaDB/servers/configurations +explicit_defaults_for_timestamp Microsoft.DBforMariaDB/servers/configurations +group_concat_max_len Microsoft.DBforMariaDB/servers/configurations +histogram_size Microsoft.DBforMariaDB/servers/configurations +histogram_type Microsoft.DBforMariaDB/servers/configurations +host_cache_size Microsoft.DBforMariaDB/servers/configurations +init_connect Microsoft.DBforMariaDB/servers/configurations +innodb_adaptive_flushing Microsoft.DBforMariaDB/servers/configurations +innodb_adaptive_flushing_lwm Microsoft.DBforMariaDB/servers/configurations +innodb_adaptive_hash_index Microsoft.DBforMariaDB/servers/configurations +innodb_adaptive_hash_index_partitions Microsoft.DBforMariaDB/servers/configurations +innodb_adaptive_hash_index_parts Microsoft.DBforMariaDB/servers/configurations +innodb_adaptive_max_sleep_delay Microsoft.DBforMariaDB/servers/configurations +innodb_autoextend_increment Microsoft.DBforMariaDB/servers/configurations +innodb_autoinc_lock_mode Microsoft.DBforMariaDB/servers/configurations +innodb_buffer_pool_dump_pct Microsoft.DBforMariaDB/servers/configurations +innodb_buffer_pool_size Microsoft.DBforMariaDB/servers/configurations +innodb_change_buffer_max_size Microsoft.DBforMariaDB/servers/configurations +innodb_change_buffering Microsoft.DBforMariaDB/servers/configurations +innodb_cmp_per_index_enabled Microsoft.DBforMariaDB/servers/configurations +innodb_compression_failure_threshold_pct Microsoft.DBforMariaDB/servers/configurations +innodb_compression_level Microsoft.DBforMariaDB/servers/configurations +innodb_compression_pad_pct_max Microsoft.DBforMariaDB/servers/configurations +innodb_concurrency_tickets Microsoft.DBforMariaDB/servers/configurations +innodb_deadlock_detect Microsoft.DBforMariaDB/servers/configurations +innodb_default_row_format Microsoft.DBforMariaDB/servers/configurations +innodb_fill_factor Microsoft.DBforMariaDB/servers/configurations +innodb_flush_log_at_timeout Microsoft.DBforMariaDB/servers/configurations +innodb_ft_enable_stopword Microsoft.DBforMariaDB/servers/configurations +innodb_ft_num_word_optimize Microsoft.DBforMariaDB/servers/configurations +innodb_ft_result_cache_limit Microsoft.DBforMariaDB/servers/configurations +innodb_io_capacity Microsoft.DBforMariaDB/servers/configurations +innodb_lock_wait_timeout Microsoft.DBforMariaDB/servers/configurations +innodb_log_compressed_pages Microsoft.DBforMariaDB/servers/configurations +innodb_lru_scan_depth Microsoft.DBforMariaDB/servers/configurations +innodb_max_dirty_pages_pct Microsoft.DBforMariaDB/servers/configurations +innodb_max_dirty_pages_pct_lwm Microsoft.DBforMariaDB/servers/configurations +innodb_max_purge_lag Microsoft.DBforMariaDB/servers/configurations +innodb_max_purge_lag_delay Microsoft.DBforMariaDB/servers/configurations +innodb_max_undo_log_size Microsoft.DBforMariaDB/servers/configurations +innodb_old_blocks_pct Microsoft.DBforMariaDB/servers/configurations +innodb_old_blocks_time Microsoft.DBforMariaDB/servers/configurations +innodb_online_alter_log_max_size Microsoft.DBforMariaDB/servers/configurations +innodb_open_files Microsoft.DBforMariaDB/servers/configurations +innodb_optimize_fulltext_only Microsoft.DBforMariaDB/servers/configurations +innodb_page_cleaners Microsoft.DBforMariaDB/servers/configurations +innodb_purge_batch_size Microsoft.DBforMariaDB/servers/configurations +innodb_purge_rseg_truncate_frequency Microsoft.DBforMariaDB/servers/configurations +innodb_random_read_ahead Microsoft.DBforMariaDB/servers/configurations +innodb_read_ahead_threshold Microsoft.DBforMariaDB/servers/configurations +innodb_read_io_threads Microsoft.DBforMariaDB/servers/configurations +innodb_stats_auto_recalc Microsoft.DBforMariaDB/servers/configurations +innodb_stats_include_delete_marked Microsoft.DBforMariaDB/servers/configurations +innodb_stats_method Microsoft.DBforMariaDB/servers/configurations +innodb_stats_modified_counter Microsoft.DBforMariaDB/servers/configurations +innodb_stats_on_metadata Microsoft.DBforMariaDB/servers/configurations +innodb_stats_persistent Microsoft.DBforMariaDB/servers/configurations +innodb_stats_persistent_sample_pages Microsoft.DBforMariaDB/servers/configurations +innodb_stats_traditional Microsoft.DBforMariaDB/servers/configurations +innodb_stats_transient_sample_pages Microsoft.DBforMariaDB/servers/configurations +innodb_status_output Microsoft.DBforMariaDB/servers/configurations +innodb_status_output_locks Microsoft.DBforMariaDB/servers/configurations +innodb_strict_mode Microsoft.DBforMariaDB/servers/configurations +innodb_sync_array_size Microsoft.DBforMariaDB/servers/configurations +innodb_table_locks Microsoft.DBforMariaDB/servers/configurations +innodb_thread_concurrency Microsoft.DBforMariaDB/servers/configurations +innodb_thread_sleep_delay Microsoft.DBforMariaDB/servers/configurations +innodb_undo_log_truncate Microsoft.DBforMariaDB/servers/configurations +innodb_write_io_threads Microsoft.DBforMariaDB/servers/configurations +interactive_timeout Microsoft.DBforMariaDB/servers/configurations +join_buffer_size Microsoft.DBforMariaDB/servers/configurations +join_cache_level Microsoft.DBforMariaDB/servers/configurations +lock_wait_timeout Microsoft.DBforMariaDB/servers/configurations +log_bin_trust_function_creators Microsoft.DBforMariaDB/servers/configurations +log_output Microsoft.DBforMariaDB/servers/configurations +log_queries_not_using_indexes Microsoft.DBforMariaDB/servers/configurations +log_slow_admin_statements Microsoft.DBforMariaDB/servers/configurations +log_slow_filter Microsoft.DBforMariaDB/servers/configurations +log_slow_rate_limit Microsoft.DBforMariaDB/servers/configurations +log_slow_verbosity Microsoft.DBforMariaDB/servers/configurations +long_query_time Microsoft.DBforMariaDB/servers/configurations +low_priority_updates Microsoft.DBforMariaDB/servers/configurations +lower_case_table_names Microsoft.DBforMariaDB/servers/configurations +max_allowed_packet Microsoft.DBforMariaDB/servers/configurations +max_connect_errors Microsoft.DBforMariaDB/servers/configurations +max_connections Microsoft.DBforMariaDB/servers/configurations +max_delayed_threads Microsoft.DBforMariaDB/servers/configurations +max_digest_length Microsoft.DBforMariaDB/servers/configurations +max_error_count Microsoft.DBforMariaDB/servers/configurations +max_heap_table_size Microsoft.DBforMariaDB/servers/configurations +max_join_size Microsoft.DBforMariaDB/servers/configurations +max_length_for_sort_data Microsoft.DBforMariaDB/servers/configurations +max_prepared_stmt_count Microsoft.DBforMariaDB/servers/configurations +max_recursive_iterations Microsoft.DBforMariaDB/servers/configurations +max_seeks_for_key Microsoft.DBforMariaDB/servers/configurations +max_session_mem_used Microsoft.DBforMariaDB/servers/configurations +max_sort_length Microsoft.DBforMariaDB/servers/configurations +max_sp_recursion_depth Microsoft.DBforMariaDB/servers/configurations +max_user_connections Microsoft.DBforMariaDB/servers/configurations +max_write_lock_count Microsoft.DBforMariaDB/servers/configurations +min_examined_row_limit Microsoft.DBforMariaDB/servers/configurations +net_read_timeout Microsoft.DBforMariaDB/servers/configurations +net_retry_count Microsoft.DBforMariaDB/servers/configurations +net_write_timeout Microsoft.DBforMariaDB/servers/configurations +optimizer_search_depth Microsoft.DBforMariaDB/servers/configurations +optimizer_selectivity_sampling_limit Microsoft.DBforMariaDB/servers/configurations +optimizer_use_condition_selectivity Microsoft.DBforMariaDB/servers/configurations +preload_buffer_size Microsoft.DBforMariaDB/servers/configurations +query_store_capture_interval Microsoft.DBforMariaDB/servers/configurations +query_store_capture_mode Microsoft.DBforMariaDB/servers/configurations +query_store_capture_utility_queries Microsoft.DBforMariaDB/servers/configurations +query_store_retention_period_in_days Microsoft.DBforMariaDB/servers/configurations +query_store_wait_sampling_capture_mode Microsoft.DBforMariaDB/servers/configurations +query_store_wait_sampling_frequency Microsoft.DBforMariaDB/servers/configurations +read_only Microsoft.DBforMariaDB/servers/configurations +server_id Microsoft.DBforMariaDB/servers/configurations +session_track_schema Microsoft.DBforMariaDB/servers/configurations +session_track_state_change Microsoft.DBforMariaDB/servers/configurations +session_track_transaction_info Microsoft.DBforMariaDB/servers/configurations +skip_show_database Microsoft.DBforMariaDB/servers/configurations +slave_parallel_threads Microsoft.DBforMariaDB/servers/configurations +slow_query_log Microsoft.DBforMariaDB/servers/configurations +sort_buffer_size Microsoft.DBforMariaDB/servers/configurations +sql_mode Microsoft.DBforMariaDB/servers/configurations +standard_compliant_cte Microsoft.DBforMariaDB/servers/configurations +stored_program_cache Microsoft.DBforMariaDB/servers/configurations +sync_master_info Microsoft.DBforMariaDB/servers/configurations +sync_relay_log_info Microsoft.DBforMariaDB/servers/configurations +table_definition_cache Microsoft.DBforMariaDB/servers/configurations +table_open_cache Microsoft.DBforMariaDB/servers/configurations +thread_pool_max_threads Microsoft.DBforMariaDB/servers/configurations +thread_pool_min_threads Microsoft.DBforMariaDB/servers/configurations +thread_pool_prio_kickup_timer Microsoft.DBforMariaDB/servers/configurations +thread_pool_priority Microsoft.DBforMariaDB/servers/configurations +thread_pool_stall_limit Microsoft.DBforMariaDB/servers/configurations +time_zone Microsoft.DBforMariaDB/servers/configurations +tx_isolation Microsoft.DBforMariaDB/servers/configurations +updatable_views_with_limit Microsoft.DBforMariaDB/servers/configurations +use_stat_tables Microsoft.DBforMariaDB/servers/configurations +userstat Microsoft.DBforMariaDB/servers/configurations +wait_timeout Microsoft.DBforMariaDB/servers/configurations +``` + +This command lists all configuration under a MariaDB. + +### Example 2: Get a configuration of MariaDB +```powershell +Get-AzMariaDbConfiguration -ServerName mariadb-asd-01 -ResourceGroupName mariadb-test-qu5ov0 -Name max_connections +``` + +```output +Name Type +---- ---- +max_connections Microsoft.DBforMariaDB/servers/configurations +``` + +This command gets a configuration of MariaDB. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server configuration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IConfiguration + +## 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 `<IMariaDbIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Get-AzMariaDbConnectionString.md b/azps-10.1.0/Az.MariaDb/Get-AzMariaDbConnectionString.md new file mode 100644 index 0000000000..80c9b1fe9e --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Get-AzMariaDbConnectionString.md @@ -0,0 +1,195 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/get-azmariadbconnectionstring +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Get-AzMariaDbConnectionString.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Get-AzMariaDbConnectionString.md +--- + +# Get-AzMariaDbConnectionString + +## SYNOPSIS +Get connection string of a MariaDB under a given framework. + +## SYNTAX + +### ServerName (Default) +``` +Get-AzMariaDbConnectionString -Client <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ServerObject +``` +Get-AzMariaDbConnectionString -Client <String> -InputObject <IServer> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get connection string of a MariaDB under a given framework. + +## EXAMPLES + +### Example 1: Get a connection string of MariaDB +```powershell +Get-AzMariaDbConnectionString -ServerName mariadb-asd-01 -ResourceGroupName mariadb-test-qu5ov0 -Client ADO.NET +``` + +```output +Server=mariadb-asd-01.mariadb.database.azure.com; Port=3306; Database={your_database}; Uid=adminuser@mariadb-asd-01; Pwd={your_password}; SslMode=Preferred; +``` + +This command gets a connection string of MariaDB. + +### Example 2: Get a connection string of MariaDB +```powershell +Get-AzMariaDbServer -Name mariadb-gp-t03 -ResourceGroupName lucas-manual-test | Get-AzMariaDbConnectionString -Client PHP +``` + +```output +$con=mysqli_init();mysqli_ssl_set($con, NULL, NULL, {ca-cert filename}, NULL, NULL); mysqli_real_connect($con, "mariadb-gp-t03.mariadb.database.azure.com", "adminuser@mariadb-gp-t03", {your_password}, {your_database}, 3306); +``` + +This command gets a connection string of MariaDB. + +## PARAMETERS + +### -Client +Connect client type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +region DefaultParameters + The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer +Parameter Sets: ServerObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: ServerName +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. + +```yaml +Type: System.String +Parameter Sets: ServerName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID is part of the URI for every service call + +```yaml +Type: System.String +Parameter Sets: ServerName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IServer>`: Identity Parameter + - `Location <String>`: The location the resource resides in. + - `[Tag <ITrackedResourceTags>]`: Application-specific metadata in the form of key-value pairs. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdministratorLogin <String>]`: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). + - `[EarliestRestoreDate <DateTime?>]`: Earliest restore point creation time (ISO8601 format) + - `[FullyQualifiedDomainName <String>]`: The fully qualified domain name of a server. + - `[IdentityType <IdentityType?>]`: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + - `[MasterServerId <String>]`: The master server id of a replica server. + - `[ReplicaCapacity <Int32?>]`: The maximum number of replicas that a master server can have. + - `[ReplicationRole <String>]`: The replication role of the server. + - `[SkuCapacity <Int32?>]`: The scale up/out capacity, representing server's compute units. + - `[SkuFamily <String>]`: The family of hardware. + - `[SkuName <String>]`: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. + - `[SkuSize <String>]`: The size code, to be interpreted by resource as appropriate. + - `[SkuTier <SkuTier?>]`: The tier of the particular SKU, e.g. Basic. + - `[SslEnforcement <SslEnforcementEnum?>]`: Enable ssl enforcement or not when connect to server. + - `[StorageProfileBackupRetentionDay <Int32?>]`: Backup retention days for the server. + - `[StorageProfileGeoRedundantBackup <GeoRedundantBackup?>]`: Enable Geo-redundant or not for server backup. + - `[StorageProfileStorageAutogrow <StorageAutogrow?>]`: Enable Storage Auto Grow. + - `[StorageProfileStorageMb <Int32?>]`: Max storage allowed for a server. + - `[UserVisibleState <ServerState?>]`: A state of a server that is visible to user. + - `[Version <ServerVersion?>]`: Server version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Get-AzMariaDbFirewallRule.md b/azps-10.1.0/Az.MariaDb/Get-AzMariaDbFirewallRule.md new file mode 100644 index 0000000000..8a539c9a08 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Get-AzMariaDbFirewallRule.md @@ -0,0 +1,194 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/get-azmariadbfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Get-AzMariaDbFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Get-AzMariaDbFirewallRule.md +--- + +# Get-AzMariaDbFirewallRule + +## SYNOPSIS +Gets information about a server firewall rule. + +## SYNTAX + +### List (Default) +``` +Get-AzMariaDbFirewallRule -ResourceGroupName <String> -ServerName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMariaDbFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMariaDbFirewallRule -InputObject <IMariaDbIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a server firewall rule. + +## EXAMPLES + +### Example 1: List all firewall rule under a MariaDB +```powershell +Get-AzMariaDbFirewallRule -ResourceGroupName mariadb-test-qu5ov0 -ServerName mariadb-test-4rmtig +``` + +```output +Name Type +---- ---- +fr-cfgl3y Microsoft.DBforMariaDB/servers/firewallRules +fr-usc9na Microsoft.DBforMariaDB/servers/firewallRules +frname-001 Microsoft.DBforMariaDB/servers/firewallRules +``` + +This command lists all girewall rule under a MariaDB. + +### Example 2: Get a firewall rule under a MariaDB +```powershell +Get-AzMariaDbFirewallRule -ResourceGroupName mariadb-test-qu5ov0 -ServerName mariadb-test-4rmtig -Name frname-001 +``` + +```output +Name Type +---- ---- +frname-001 Microsoft.DBforMariaDB/servers/firewallRules +``` + +This command gets a firewall rule under a MariaDB. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IFirewallRule + +## 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 `<IMariaDbIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Get-AzMariaDbReplica.md b/azps-10.1.0/Az.MariaDb/Get-AzMariaDbReplica.md new file mode 100644 index 0000000000..52116f0229 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Get-AzMariaDbReplica.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/get-azmariadbreplica +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Get-AzMariaDbReplica.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Get-AzMariaDbReplica.md +--- + +# Get-AzMariaDbReplica + +## SYNOPSIS +List all the replicas for a given server. + +## SYNTAX + +``` +Get-AzMariaDbReplica -ResourceGroupName <String> -ServerName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List all the replicas for a given server. + +## EXAMPLES + +### Example 1: List all replica DB under a MariaDB +```powershell +Get-AzMariaDbReplica -ServerName mariadb-test-szp6dt -ResourceGroupName mariadb-test-qu5ov0 +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mariadb-test-szp6dt-rep428 eastus zmoxhpgjqc 10.2 5120 GP_Gen5_4 GeneralPurpose Enabled +mariadb-test-szp6dt-rep154 eastus zcsxhpasdc 10.2 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This command lists all replica DB under a MariaDB. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Get-AzMariaDbServer.md b/azps-10.1.0/Az.MariaDb/Get-AzMariaDbServer.md new file mode 100644 index 0000000000..bc72fdb0e0 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Get-AzMariaDbServer.md @@ -0,0 +1,217 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/get-azmariadbserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Get-AzMariaDbServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Get-AzMariaDbServer.md +--- + +# Get-AzMariaDbServer + +## SYNOPSIS +Gets information about a server. + +## SYNTAX + +### List1 (Default) +``` +Get-AzMariaDbServer [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMariaDbServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMariaDbServer -InputObject <IMariaDbIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzMariaDbServer -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a server. + +## EXAMPLES + +### Example 1: List all MariaDB under a subscriptions +```powershell +Get-AzMariaDbServer +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mrdb01 eastus dolauli 10.2 5120 B_Gen5_1 Basic Enabled +wyunchi-10 eastus wyunchi 10.2 5120 GP_Gen5_4 GeneralPurpose Enabled +wyunchi eastus wyunchi 10.2 5120 GP_Gen5_4 GeneralPurpose Enabled +wyunchi-eastus eastus wyunchi 10.2 5120 GP_Gen5_4 GeneralPurpose Enabled +mariadb-test-h3pame eastus qiszomtkpf 10.2 5120 B_Gen5_1 Basic Enabled +mariadb-test-4rmtig eastus xofavpndqj 10.2 5120 B_Gen5_1 Basic Enabled +mariadb-test-szp6dt eastus zmoxhpgjqc 10.2 5120 GP_Gen5_4 GeneralPurpose Enabled +mariadb-test-9pebvn eastus xpwjyfdgui 10.2 7168 GP_Gen5_4 GeneralPurpose Enabled +mariadb-test-szp6dt-rep428 eastus zmoxhpgjqc 10.2 5120 GP_Gen5_4 GeneralPurpose Enabled +mariadb-asd-01 eastus adminuser 10.2 5120 B_Gen5_1 Basic Enabled +rst-001 eastus xpwjyfdgui 10.2 7168 GP_Gen5_4 GeneralPurpose Enabled +rst-002 eastus xpwjyfdgui 10.2 7168 GP_Gen5_4 GeneralPurpose Enabled +rstrgp02-rep-003 eastus xpwjyfdgui 10.2 7168 GP_Gen5_4 GeneralPurpose Enabled +rstrgp02-rep-004 eastus xpwjyfdgui 10.2 7168 GP_Gen5_4 GeneralPurpose Enabled +``` + +This command lists all MariaDB under a subscriptions. + +### Example 2: List all MariaDB under a resource group +```powershell +Get-AzMariaDbServer -ResourceGroupName mariadb-test-qu5ov0 +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mariadb-test-h3pame eastus qiszomtkpf 10.2 5120 B_Gen5_1 Basic Enabled +mariadb-test-4rmtig eastus xofavpndqj 10.2 5120 B_Gen5_1 Basic Enabled +mariadb-test-szp6dt eastus zmoxhpgjqc 10.2 5120 GP_Gen5_4 GeneralPurpose Enabled +mariadb-test-9pebvn eastus xpwjyfdgui 10.2 7168 GP_Gen5_4 GeneralPurpose Enabled +mariadb-test-szp6dt-rep428 eastus zmoxhpgjqc 10.2 5120 GP_Gen5_4 GeneralPurpose Enabled +mariadb-asd-01 eastus adminuser 10.2 5120 B_Gen5_1 Basic Enabled +rst-001 eastus xpwjyfdgui 10.2 7168 GP_Gen5_4 GeneralPurpose Enabled +rst-002 eastus xpwjyfdgui 10.2 7168 GP_Gen5_4 GeneralPurpose Enabled +rstrgp02-rep-003 eastus xpwjyfdgui 10.2 7168 GP_Gen5_4 GeneralPurpose Enabled +rstrgp02-rep-004 eastus xpwjyfdgui 10.2 7168 GP_Gen5_4 GeneralPurpose Enabled +``` + +This command lists all MariaDB under a resource group. + +### Example 3: Get a MariaDB +```powershell +Get-AzMariaDbServer -ResourceGroupName mariadb-test-qu5ov0 -Name mariadb-test-h3pame +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mariadb-test-h3pame eastus qiszomtkpf 10.2 5120 B_Gen5_1 Basic Enabled +``` + +This command gets a MariaDB. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer + +## 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 `<IMariaDbIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Get-AzMariaDbVirtualNetworkRule.md b/azps-10.1.0/Az.MariaDb/Get-AzMariaDbVirtualNetworkRule.md new file mode 100644 index 0000000000..2d4a39ed64 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Get-AzMariaDbVirtualNetworkRule.md @@ -0,0 +1,209 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/get-azmariadbvirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Get-AzMariaDbVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Get-AzMariaDbVirtualNetworkRule.md +--- + +# Get-AzMariaDbVirtualNetworkRule + +## SYNOPSIS +Gets a virtual network rule. + +## SYNTAX + +### List (Default) +``` +Get-AzMariaDbVirtualNetworkRule -ResourceGroupName <String> -ServerName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### Get +``` +Get-AzMariaDbVirtualNetworkRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMariaDbVirtualNetworkRule -InputObject <IMariaDbIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a virtual network rule. + +## EXAMPLES + +### Example 1: List all virtual network rule under a MariaDB +```powershell +Get-AzMariaDbVirtualNetworkRule -ResourceGroupName mariadb-test-qu5ov0 -ServerName mariadb-test-9pebvn +``` + +```output +Name Type +---- ---- +vnetrule-QdMJpU Microsoft.DBforMariaDB/servers/virtualNetworkRules +vnetrule-Adsefc Microsoft.DBforMariaDB/servers/virtualNetworkRules +``` + +This command lists all virtual network rule under a MariaDB. + +### Example 2: Get virtual network rule under a MariaDB +```powershell +Get-AzMariaDbVirtualNetworkRule -ResourceGroupName mariadb-test-qu5ov0 -ServerName mariadb-test-9pebvn -Name vnetrule-QdMJpU +``` + +```output +Name Type +---- ---- +vnetrule-QdMJpU Microsoft.DBforMariaDB/servers/virtualNetworkRules +``` + +This command gets virtual network rule under a MariaDB. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: VirtualNetworkRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IVirtualNetworkRule + +## 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 `<IMariaDbIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/New-AzMariaDbFirewallRule.md b/azps-10.1.0/Az.MariaDb/New-AzMariaDbFirewallRule.md new file mode 100644 index 0000000000..52d7384e94 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/New-AzMariaDbFirewallRule.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/new-azmariadbfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/New-AzMariaDbFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/New-AzMariaDbFirewallRule.md +--- + +# New-AzMariaDbFirewallRule + +## SYNOPSIS +Creates a new firewall rule or updates an existing firewall rule. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzMariaDbFirewallRule -ResourceGroupName <String> -ServerName <String> -EndIPAddress <String> + -StartIPAddress <String> [-Name <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### AllowAll +``` +New-AzMariaDbFirewallRule -ResourceGroupName <String> -ServerName <String> -AllowAll [-Name <String>] + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### ClientIPAddress +``` +New-AzMariaDbFirewallRule -ResourceGroupName <String> -ServerName <String> -ClientIPAddress <String> + [-Name <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new firewall rule or updates an existing firewall rule. + +## EXAMPLES + +### Example 1: Create a firewall rule under a MariaDB +```powershell +New-AzMariaDbFirewallRule -Name firewall-101 -ResourceGroupName mariadb-test-qu5ov0 -ServerName mariadb-asd-01 -EndIPAddress 0.0.2.255 -StartIPAddress 0.0.2.1 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +firewall-101 0.0.2.1 0.0.2.255 +``` + +This command creates a firewall rule under a MariaDB. + +### Example 2: Create a new MariaDB Firewall Rule using -ClientIPAddress. +```powershell +New-AzMariaDbFirewallRule -ResourceGroupName mariadb-test-qu5ov0 -ServerName mariadb-asd-01 -ClientIPAddress 0.0.0.1 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +ClientIPAddress_2020-08-11_18-19-27 0.0.0.1 0.0.0.1 +``` + +This cmdlets create a MariaDB Firewall Rule using -ClientIPAddress. + +### Example 3: Create a new MariaDB Firewall Rule to allow all IPs +```powershell +New-AzMariaDbFirewallRule -ResourceGroupName mariadb-test-qu5ov0 -ServerName mariadb-asd-01 -AllowAll +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +AllowAll_2020-08-11_18-19-27 0.0.0.0 255.255.255.255 +``` + +This cmdlets create a new MariaDB Firewall Rule to allow all IPs. + +## PARAMETERS + +### -AllowAll +Present to allow all range IPs, from 0.0.0.0 to 255.255.255.255. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AllowAll +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientIPAddress +Client specified single IP of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIPAddress +The end IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. +If not specified, the default is undefined. +If AllowAll is present, the default name is AllowAll_yyyy-MM-dd_HH-mm-ss. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FirewallRuleName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +The start IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IFirewallRule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/New-AzMariaDbReplica.md b/azps-10.1.0/Az.MariaDb/New-AzMariaDbReplica.md new file mode 100644 index 0000000000..c408da049f --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/New-AzMariaDbReplica.md @@ -0,0 +1,322 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/new-azmariadbreplica +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/New-AzMariaDbReplica.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/New-AzMariaDbReplica.md +--- + +# New-AzMariaDbReplica + +## SYNOPSIS +Creates a replica of a MariaDB server. + +## SYNTAX + +### ServerName (Default) +``` +New-AzMariaDbReplica -MasterName <String> -ReplicaName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Location <String>] [-Sku <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ServerObject +``` +New-AzMariaDbReplica -Master <IServer> -ReplicaName <String> [-SubscriptionId <String>] [-Location <String>] + [-Sku <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a replica of a MariaDB server. + +## EXAMPLES + +### Example 1: Create a replica db for a MariaDB +```powershell +New-AzMariaDbReplica -MasterName mariadb-test-9pebvn -ReplicaName mariadb-test-9pebvn-rep01 -ResourceGroupName mariadb-test-qu5ov0 +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mariadb-test-9pebvn-rep01 eastus xpwjyfdgui 10.2 7168 GP_Gen5_4 GeneralPurpose Enabled +``` + +This command creates a replica db for a MariaDB. + +### Example 2: Create a replica db for a MariaDB +```powershell +Get-AzMariaDbServer -Name mariadb-test-9pebvn -ResourceGroupName mariadb-test-qu5ov0 | New-AzMariaDbReplica -ReplicaName mariadb-test-9pebvn-rep02 +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mariadb-test-9pebvn-rep02 eastus xpwjyfdgui 10.2 7168 GP_Gen5_4 GeneralPurpose Enabled +``` + +This command creates a replica db for a MariaDB. + +### Example 3: Create a replica db for a MariaDB +```powershell +$mariaDb = Get-AzMariaDbServer -Name mariadb-test-9pebvn -ResourceGroupName mariadb-test-qu5ov0 +New-AzMariaDbReplica -Master $mariaDb -ReplicaName mariadb-test-9pebvn-rep03 +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mariadb-test-9pebvn-rep03 eastus xpwjyfdgui 10.2 7168 GP_Gen5_4 GeneralPurpose Enabled +``` + +This command with parameter inputobject creates a replica db with parameter inputobject for a MariaDB. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +region DefaultParameters + The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location the resource resides in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Master +The source server object to restore from. +To construct, see NOTES section for MASTER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer +Parameter Sets: ServerObject +Aliases: InputObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MasterName +MariaDB server name. + +```yaml +Type: System.String +Parameter Sets: ServerName +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaName +Replica name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ReplicaServerName, Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: ServerName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +B_Gen4_1, GP_Gen5_8. + +```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 subscription ID is part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer + +## 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. + + +MASTER `<IServer>`: The source server object to restore from. + - `Location <String>`: The location the resource resides in. + - `[Tag <ITrackedResourceTags>]`: Application-specific metadata in the form of key-value pairs. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdministratorLogin <String>]`: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). + - `[EarliestRestoreDate <DateTime?>]`: Earliest restore point creation time (ISO8601 format) + - `[FullyQualifiedDomainName <String>]`: The fully qualified domain name of a server. + - `[IdentityType <IdentityType?>]`: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + - `[MasterServerId <String>]`: The master server id of a replica server. + - `[ReplicaCapacity <Int32?>]`: The maximum number of replicas that a master server can have. + - `[ReplicationRole <String>]`: The replication role of the server. + - `[SkuCapacity <Int32?>]`: The scale up/out capacity, representing server's compute units. + - `[SkuFamily <String>]`: The family of hardware. + - `[SkuName <String>]`: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. + - `[SkuSize <String>]`: The size code, to be interpreted by resource as appropriate. + - `[SkuTier <SkuTier?>]`: The tier of the particular SKU, e.g. Basic. + - `[SslEnforcement <SslEnforcementEnum?>]`: Enable ssl enforcement or not when connect to server. + - `[StorageProfileBackupRetentionDay <Int32?>]`: Backup retention days for the server. + - `[StorageProfileGeoRedundantBackup <GeoRedundantBackup?>]`: Enable Geo-redundant or not for server backup. + - `[StorageProfileStorageAutogrow <StorageAutogrow?>]`: Enable Storage Auto Grow. + - `[StorageProfileStorageMb <Int32?>]`: Max storage allowed for a server. + - `[UserVisibleState <ServerState?>]`: A state of a server that is visible to user. + - `[Version <ServerVersion?>]`: Server version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/New-AzMariaDbServer.md b/azps-10.1.0/Az.MariaDb/New-AzMariaDbServer.md new file mode 100644 index 0000000000..14c990aad5 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/New-AzMariaDbServer.md @@ -0,0 +1,353 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/new-azmariadbserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/New-AzMariaDbServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/New-AzMariaDbServer.md +--- + +# New-AzMariaDbServer + +## SYNOPSIS +Creates a new MariaDB. + +## SYNTAX + +``` +New-AzMariaDbServer -Name <String> -ResourceGroupName <String> -AdministratorLoginPassword <SecureString> + -AdministratorUsername <String> -Location <String> -Sku <String> [-SubscriptionId <String>] + [-BackupRetentionDay <Int32>] [-GeoRedundantBackup <GeoRedundantBackup>] + [-SslEnforcement <SslEnforcementEnum>] [-StorageAutogrow <StorageAutogrow>] [-StorageInMb <Int32>] + [-Tag <Hashtable>] [-Version <ServerVersion>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new MariaDB. + +## EXAMPLES + +### Example 1: Create a new MariaDB +```powershell +New-AzMariaDbServer -Name mariadb-aassd-01 -ResourceGroupName lucas-manual-test -Sku 'B_Gen5_1' -Location eastus +``` + +```output +cmdlet New-AzMariaDbServer at command pipeline position 1 +Supply values for the following parameters: +AdministratorUsername: adminuser +AdministratorLoginPassword: ************ + +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mariadb-aassd-01 eastus adminuser 10.2 5120 B_Gen5_1 Basic Enabled +``` + +This command creates a new MariaDB. + +## PARAMETERS + +### -AdministratorLoginPassword +Password of administrator, should be SecureString. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorUsername +Username of administrator. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +region DefaultParameters + The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeoRedundantBackup +Enable Geo-redundant or not for server backup. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Support.GeoRedundantBackup +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location the resource resides in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +MariaDB server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +B_Gen4_1, GP_Gen5_8. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslEnforcement +Enable ssl enforcement or not when connect to server. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Support.SslEnforcementEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAutogrow +Enable Storage Auto Grow. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Support.StorageAutogrow +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageInMb +Max storage allowed for a server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID is part of the URI for every service call + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Server version. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Support.ServerVersion +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/New-AzMariaDbVirtualNetworkRule.md b/azps-10.1.0/Az.MariaDb/New-AzMariaDbVirtualNetworkRule.md new file mode 100644 index 0000000000..833877fd11 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/New-AzMariaDbVirtualNetworkRule.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/new-azmariadbvirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/New-AzMariaDbVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/New-AzMariaDbVirtualNetworkRule.md +--- + +# New-AzMariaDbVirtualNetworkRule + +## SYNOPSIS +Creates or updates an existing virtual network rule. + +## SYNTAX + +``` +New-AzMariaDbVirtualNetworkRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-IgnoreMissingVnetServiceEndpoint] [-SubnetId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an existing virtual network rule. + +## EXAMPLES + +### Example 1: Create a virtual network rule for a MariaDB +```powershell +$vnet = Get-AzVirtualNetwork -Name vnet -ResourceGroupName mariadb-test-qu5ov0 +New-AzMariaDbVirtualNetworkRule -ServerName mariadb-test-9pebvn -ResourceGroupName mariadb-test-qu5ov0 -Name vnet-001 -SubnetId $vnet.Subnets[0].Id -IgnoreMissingVnetServiceEndpoint +``` + +```output +Name Type +---- ---- +vnet-001 Microsoft.DBforMariaDB/servers/virtualNetworkRules +``` + +This command creates a virtual network rule for a MariaDB. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreMissingVnetServiceEndpoint +Create firewall rule before the virtual network has vnet service endpoint enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VirtualNetworkRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The ARM resource id of the virtual network subnet. + +```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 subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IVirtualNetworkRule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Remove-AzMariaDbFirewallRule.md b/azps-10.1.0/Az.MariaDb/Remove-AzMariaDbFirewallRule.md new file mode 100644 index 0000000000..45eb496ccf --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Remove-AzMariaDbFirewallRule.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/remove-azmariadbfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Remove-AzMariaDbFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Remove-AzMariaDbFirewallRule.md +--- + +# Remove-AzMariaDbFirewallRule + +## SYNOPSIS +Deletes a server firewall rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMariaDbFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMariaDbFirewallRule -InputObject <IMariaDbIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a server firewall rule. + +## EXAMPLES + +### Example 1: Remove a firewall rule under a MariaDB +```powershell +Remove-AzMariaDbFirewallRule -Name frname-001 -ResourceGroupName mariadb-test-qu5ov0 -ServerName mariadb-test-4rmtig +``` + +This command removes a firewall rule under a MariaDB. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMariaDbIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Remove-AzMariaDbServer.md b/azps-10.1.0/Az.MariaDb/Remove-AzMariaDbServer.md new file mode 100644 index 0000000000..0d4fcdeaa1 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Remove-AzMariaDbServer.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/remove-azmariadbserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Remove-AzMariaDbServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Remove-AzMariaDbServer.md +--- + +# Remove-AzMariaDbServer + +## SYNOPSIS +Deletes a server. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMariaDbServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMariaDbServer -InputObject <IMariaDbIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a server. + +## EXAMPLES + +### Example 1: Remove a MariaDB +```powershell +Remove-AzMariaDbServer -Name mariadb-asd-01 -ResourceGroupName mariadb-test-qu5ov0 +``` + +This command removes a MariaDB. + +### Example 2: Remove a MariaDB +```powershell +Get-AzMariaDbServer -Name mariadb-bc-t01 -ResourceGroupName mariadb-test-qu5ov0 | Remove-AzMariaDbServer +``` + +This command removes a MariaDB. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMariaDbIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Remove-AzMariaDbVirtualNetworkRule.md b/azps-10.1.0/Az.MariaDb/Remove-AzMariaDbVirtualNetworkRule.md new file mode 100644 index 0000000000..2a4200e3c4 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Remove-AzMariaDbVirtualNetworkRule.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/remove-azmariadbvirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Remove-AzMariaDbVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Remove-AzMariaDbVirtualNetworkRule.md +--- + +# Remove-AzMariaDbVirtualNetworkRule + +## SYNOPSIS +Deletes the virtual network rule with the given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMariaDbVirtualNetworkRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMariaDbVirtualNetworkRule -InputObject <IMariaDbIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the virtual network rule with the given name. + +## EXAMPLES + +### Example 1: Remove a virtual network rule +```powershell +Remove-AzMariaDbVirtualNetworkRule -Name vnet-001 -ResourceGroupName mariadb-test-qu5ov0 -ServerName mariadb-test-9pebvn +``` + +This command removes a virtual network rule. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: VirtualNetworkRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMariaDbIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Restart-AzMariaDbServer.md b/azps-10.1.0/Az.MariaDb/Restart-AzMariaDbServer.md new file mode 100644 index 0000000000..11cee94e5d --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Restart-AzMariaDbServer.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/restart-azmariadbserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Restart-AzMariaDbServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Restart-AzMariaDbServer.md +--- + +# Restart-AzMariaDbServer + +## SYNOPSIS +Restarts a server. + +## SYNTAX + +### ServerName (Default) +``` +Restart-AzMariaDbServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ServerObject +``` +Restart-AzMariaDbServer -InputObject <IMariaDbIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Restarts a server. + +## EXAMPLES + +### Example 1: Restart a MariaDB +```powershell +Restart-AzMariaDbServer -Name mariadb-test-9pebvn -ResourceGroupName mariadb-test-qu5ov0 +``` + +This command restart a MariaDB. + +### Example 2: Restart a MariaDB +```powershell +Get-AzMariaDbServer -Name mariadb-test-9pebvn -ResourceGroupName mariadb-test-qu5ov0 | Restart-AzMariaDbServer +``` + +This command restart a MariaDB. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity +Parameter Sets: ServerObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: ServerName +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: ServerName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: ServerName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMariaDbIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Restore-AzMariaDbServer.md b/azps-10.1.0/Az.MariaDb/Restore-AzMariaDbServer.md new file mode 100644 index 0000000000..e81e64e138 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Restore-AzMariaDbServer.md @@ -0,0 +1,303 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/restore-azmariadbserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Restore-AzMariaDbServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Restore-AzMariaDbServer.md +--- + +# Restore-AzMariaDbServer + +## SYNOPSIS +Restore a MariaDB from a existing MariaDB. + +## SYNTAX + +``` +Restore-AzMariaDbServer -Name <String> -RestorePointInTime <DateTime> [-InputObject <IServer>] + [-ResourceGroupName <String>] [-ServerName <String>] [-SubscriptionId <String>] [-Location <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Restore a MariaDB from a existing MariaDB. + +## EXAMPLES + +### Example 1: Restore a PointInTime MariaDB by server name. +```powershell +Restore-AzMariaDbServer -Name restore-db01 -ServerName mariadb-test-usegeo -ResourceGroupName mariadb-test-4rih5z -RestorePointInTime $(Get-Date) -Location eastus +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +restore-db01 eastus adminuser 10.2 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This command restore a PointInTime MariaDB by server name. + +### Example 2: Restore a PointInTime MariaDB by server object +```powershell +$db = Get-AzMariaDbServer -Name mariadb-test-usegeo -ResourceGroupName mariadb-test-4rih5z +Restore-AzMariaDbServer -Name restore-db02 -InputObject $db -RestorePointInTime $(Get-Date) -Location eastus +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +restore-db02 eastus adminuser 10.2 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This command restore a PointInTime MariaDB by server object. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +region DefaultParameters + The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The source server object to restore from. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location the resource resides in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The dest server name to restore from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestorePointInTime +region PointInTimeRestore + The location the resource resides in. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The source server name to restore from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets the subscription Id which uniquely identifies the Microsoft Azure subscription. +The subscription ID is part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer + +## 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 `<IServer>`: The source server object to restore from. + - `Location <String>`: The location the resource resides in. + - `[Tag <ITrackedResourceTags>]`: Application-specific metadata in the form of key-value pairs. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdministratorLogin <String>]`: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). + - `[EarliestRestoreDate <DateTime?>]`: Earliest restore point creation time (ISO8601 format) + - `[FullyQualifiedDomainName <String>]`: The fully qualified domain name of a server. + - `[IdentityType <IdentityType?>]`: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + - `[MasterServerId <String>]`: The master server id of a replica server. + - `[ReplicaCapacity <Int32?>]`: The maximum number of replicas that a master server can have. + - `[ReplicationRole <String>]`: The replication role of the server. + - `[SkuCapacity <Int32?>]`: The scale up/out capacity, representing server's compute units. + - `[SkuFamily <String>]`: The family of hardware. + - `[SkuName <String>]`: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. + - `[SkuSize <String>]`: The size code, to be interpreted by resource as appropriate. + - `[SkuTier <SkuTier?>]`: The tier of the particular SKU, e.g. Basic. + - `[SslEnforcement <SslEnforcementEnum?>]`: Enable ssl enforcement or not when connect to server. + - `[StorageProfileBackupRetentionDay <Int32?>]`: Backup retention days for the server. + - `[StorageProfileGeoRedundantBackup <GeoRedundantBackup?>]`: Enable Geo-redundant or not for server backup. + - `[StorageProfileStorageAutogrow <StorageAutogrow?>]`: Enable Storage Auto Grow. + - `[StorageProfileStorageMb <Int32?>]`: Max storage allowed for a server. + - `[UserVisibleState <ServerState?>]`: A state of a server that is visible to user. + - `[Version <ServerVersion?>]`: Server version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Update-AzMariaDbConfiguration.md b/azps-10.1.0/Az.MariaDb/Update-AzMariaDbConfiguration.md new file mode 100644 index 0000000000..9291ece26c --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Update-AzMariaDbConfiguration.md @@ -0,0 +1,268 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/update-azmariadbconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Update-AzMariaDbConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Update-AzMariaDbConfiguration.md +--- + +# Update-AzMariaDbConfiguration + +## SYNOPSIS +Updates a configuration of a server. +Use Update-AzMariaDbServer instead if you want update AdministratorLoginPassword, sku, etc. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMariaDbConfiguration -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-Source <String>] [-Value <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMariaDbConfiguration -InputObject <IMariaDbIdentity> [-Source <String>] [-Value <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a configuration of a server. +Use Update-AzMariaDberver instead if you want update AdministratorLoginPassword, sku, etc. + +## EXAMPLES + +### Example 1: Update MariaDB configuration +```powershell +Update-AzMariaDbConfiguration -Name delayed_insert_timeout -Value 200 -ServerName mariadb-test-h3pame -ResourceGroupName mariadb-test-qu5ov0 +``` + +```output +Name Type +---- ---- +delayed_insert_timeout Microsoft.DBforMariaDB/servers/configurations +``` + +This command updates a MariaDB configuration. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server configuration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Source of the configuration. + +```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 subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Value of the configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IConfiguration + +## 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 `<IMariaDbIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Update-AzMariaDbFirewallRule.md b/azps-10.1.0/Az.MariaDb/Update-AzMariaDbFirewallRule.md new file mode 100644 index 0000000000..d32f0cf755 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Update-AzMariaDbFirewallRule.md @@ -0,0 +1,325 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/update-azmariadbfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Update-AzMariaDbFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Update-AzMariaDbFirewallRule.md +--- + +# Update-AzMariaDbFirewallRule + +## SYNOPSIS +Creates a new firewall rule or updates an existing firewall rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMariaDbFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -EndIPAddress <String> -StartIPAddress <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ClientIPAddress +``` +Update-AzMariaDbFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -ClientIPAddress <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ClientIPAddressViaIdentity +``` +Update-AzMariaDbFirewallRule -InputObject <IMariaDbIdentity> -ClientIPAddress <String> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMariaDbFirewallRule -InputObject <IMariaDbIdentity> -EndIPAddress <String> -StartIPAddress <String> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new firewall rule or updates an existing firewall rule. + +## EXAMPLES + +### Example 1: Update MariaDB firewall rule +```powershell +Update-AzMariaDbFirewallRule -Name fr-cfgl3y -ServerName mariadb-test-4rmtig -ResourceGroupName mariadb-test-qu5ov0 -StartIPAddress 0.0.3.1 -EndIPAddress 0.0.3.255 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +fr-cfgl3y 0.0.3.1 0.0.3.255 +``` + +This command updates a MariaDB firewall rule. + +### Example 2: Update MariaDB Firewall Rule by identity. +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/mariadb-test-qu5ov0/providers/Microsoft.DBforMariaDB/servers/mariadb-test-4rmtig/firewallRules/fr-cfgl3y" +Update-AzMariaDbFirewallRule -InputObject $ID -EndIPAddress 0.0.0.3 -StartIPAddress 0.0.0.2 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +fr-cfgl3y 0.0.0.2 0.0.0.3 +``` + +The cmdlet updates MariaDB Firewall Rule by identity. + +### Example 3: Update MariaDB Firewall Rule by -ClientIPAddress. +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/mariadb-test-qu5ov0/providers/Microsoft.DBforMariaDB/servers/mariadb-test-4rmtig/firewallRules/fr-cfgl3y" +Update-AzMariaDbFirewallRule -InputObject $ID -ClientIPAddress 0.0.0.2 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +fr-cfgl3y 0.0.0.2 0.0.0.2 +``` + +The cmdlet updates MariaDB Firewall Rule by -ClientIPAddress. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientIPAddress +Client specified single IP of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, ClientIPAddressViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIPAddress +The end IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity +Parameter Sets: ClientIPAddressViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +The start IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IFirewallRule + +## 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 `<IMariaDbIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Update-AzMariaDbServer.md b/azps-10.1.0/Az.MariaDb/Update-AzMariaDbServer.md new file mode 100644 index 0000000000..fb76db6ae1 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Update-AzMariaDbServer.md @@ -0,0 +1,379 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/update-azmariadbserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Update-AzMariaDbServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Update-AzMariaDbServer.md +--- + +# Update-AzMariaDbServer + +## SYNOPSIS +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzMariaDbConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +## SYNTAX + +### ServerName (Default) +``` +Update-AzMariaDbServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AdministratorLoginPassword <SecureString>] [-BackupRetentionDay <Int32>] + [-GeoRedundantBackup <GeoRedundantBackup>] [-ReplicationRole <String>] [-Sku <String>] + [-SslEnforcement <SslEnforcementEnum>] [-StorageAutogrow <StorageAutogrow>] [-StorageInMb <Int32>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ServerObject +``` +Update-AzMariaDbServer -InputObject <IMariaDbIdentity> [-AdministratorLoginPassword <SecureString>] + [-BackupRetentionDay <Int32>] [-GeoRedundantBackup <GeoRedundantBackup>] [-ReplicationRole <String>] + [-Sku <String>] [-SslEnforcement <SslEnforcementEnum>] [-StorageAutogrow <StorageAutogrow>] + [-StorageInMb <Int32>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzMariaDbConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +## EXAMPLES + +### Example 1: Update MariaDB +```powershell +Update-AzMariaDbServer -Name mariadb-test-4rmtig -ResourceGroupName mariadb-test-qu5ov0 -StorageInMb 8192 +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mariadb-test-4rmtig eastus xofavpndqj 10.2 8192 B_Gen5_1 Basic Enabled +``` + +This command updates a MariaDB. + +### Example 2: Update MariaDB +```powershell +Get-AzMariaDbServer -Name mariadb-test-4rmtig -ResourceGroupName mariadb-test-qu5ov0 | Update-AzMariaDbServer -StorageInMb (8192+1024) +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mariadb-test-4rmtig eastus xofavpndqj 10.2 9216 B_Gen5_1 Basic Enabled +``` + +This command updates a MariaDB. + +## PARAMETERS + +### -AdministratorLoginPassword +The password of the administrator login. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +region DefaultParameters + The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeoRedundantBackup +Enable Geo-redundant or not for server backup. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Support.GeoRedundantBackup +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.MariaDb.Models.IMariaDbIdentity +Parameter Sets: ServerObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +MariaDB server name + +```yaml +Type: System.String +Parameter Sets: ServerName +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationRole +The replication role of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. + +```yaml +Type: System.String +Parameter Sets: ServerName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +B_Gen4_1, GP_Gen5_8. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslEnforcement +Enable ssl enforcement or not when connect to server. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Support.SslEnforcementEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAutogrow +Enable Storage Auto Grow. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Support.StorageAutogrow +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageInMb +Max storage allowed for a server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID is part of the URI for every service call + +```yaml +Type: System.String +Parameter Sets: ServerName +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer + +## 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 `<IMariaDbIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MariaDb/Update-AzMariaDbVirtualNetworkRule.md b/azps-10.1.0/Az.MariaDb/Update-AzMariaDbVirtualNetworkRule.md new file mode 100644 index 0000000000..dae6c0d417 --- /dev/null +++ b/azps-10.1.0/Az.MariaDb/Update-AzMariaDbVirtualNetworkRule.md @@ -0,0 +1,283 @@ +--- +external help file: +Module Name: Az.MariaDb +online version: https://learn.microsoft.com/powershell/module/az.mariadb/update-azmariadbvirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Update-AzMariaDbVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MariaDb/help/Update-AzMariaDbVirtualNetworkRule.md +--- + +# Update-AzMariaDbVirtualNetworkRule + +## SYNOPSIS +Creates or updates an existing virtual network rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMariaDbVirtualNetworkRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-IgnoreMissingVnetServiceEndpoint] [-SubnetId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMariaDbVirtualNetworkRule -InputObject <IMariaDbIdentity> [-IgnoreMissingVnetServiceEndpoint] + [-SubnetId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an existing virtual network rule. + +## EXAMPLES + +### Example 1: Update MariaDB virtual network rule +```powershell +$vnet = Get-AzVirtualNetwork -Name vnet -ResourceGroupName mariadb-test-qu5ov0 +Update-AzMariaDbVirtualNetworkRule -ServerName mariadb-test-9pebvn -ResourceGroupName mariadb-test-qu5ov0 -Name vnetrule-QdMJpU -SubnetId $vnet.Subnets[0].Id -IgnoreMissingVnetServiceEndpoint +``` + +```output +Name Type +---- ---- +vnetrule-QdMJpU Microsoft.DBforMariaDB/servers/virtualNetworkRules +``` + +This command updates a virtual network rule. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreMissingVnetServiceEndpoint +Create firewall rule before the virtual network has vnet service endpoint enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: VirtualNetworkRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The ARM resource id of the virtual network subnet. + +```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 subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.IMariaDbIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IVirtualNetworkRule + +## 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 `<IMariaDbIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Az.Marketplace.md b/azps-10.1.0/Az.Marketplace/Az.Marketplace.md new file mode 100644 index 0000000000..568643d6c0 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Az.Marketplace.md @@ -0,0 +1,75 @@ +--- +Module Name: Az.Marketplace +Module Guid: 91832aaa-dc11-4583-8239-bce5fd531604 +Download Help Link: https://learn.microsoft.com/powershell/module/az.marketplace +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Az.Marketplace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Az.Marketplace.md +--- + +# Az.Marketplace Module +## Description +Commands to interact with Azure Marketplace. + +## Az.Marketplace Cmdlets +### [Get-AzMarketplacePrivateStoreOffer](Get-AzMarketplacePrivateStoreOffer.md) +Get one or more private store's offer. + +### [Get-AzMarketplacePrivateStore](Get-AzMarketplacePrivateStore.md) +Get private store list + +### [Remove-AzMarketplacePrivateStoreOffer](Remove-AzMarketplacePrivateStoreOffer.md) +Remove an offer from private store. + +### [Set-AzMarketplacePrivateStoreOffer](Set-AzMarketplacePrivateStoreOffer.md) +Updates or creates offer for private store. + + +### [Copy-AzMarketplacePrivateStoreCollectionOffer](Copy-AzMarketplacePrivateStoreCollectionOffer.md) +transferring offers (copy or move) from source collection to target collection(s) + +### [Get-AzMarketplaceBillingPrivateStoreAccount](Get-AzMarketplaceBillingPrivateStoreAccount.md) +Tenant billing accounts names + +### [Get-AzMarketplaceCollectionToSubscriptionMapping](Get-AzMarketplaceCollectionToSubscriptionMapping.md) +For a given subscriptions list, the API will return a map of collections and the related subscriptions from the supplied list. + +### [Get-AzMarketplacePrivateStoreCollection](Get-AzMarketplacePrivateStoreCollection.md) +Gets private store collection + +### [Get-AzMarketplacePrivateStoreCollectionOffer](Get-AzMarketplacePrivateStoreCollectionOffer.md) +Gets information about a specific offer. + +### [Get-AzMarketplacePrivateStoreV1](Get-AzMarketplacePrivateStoreV1.md) +Get information about the private store + +### [Get-AzMarketplaceQueryPrivateStoreOffer](Get-AzMarketplaceQueryPrivateStoreOffer.md) +List of offers, regardless the collections + +### [New-AzMarketplacePrivateStore](New-AzMarketplacePrivateStore.md) +Changes private store properties + +### [New-AzMarketplacePrivateStoreCollection](New-AzMarketplacePrivateStoreCollection.md) +Create or update private store collection + +### [New-AzMarketplacePrivateStoreCollectionOffer](New-AzMarketplacePrivateStoreCollectionOffer.md) +Update or add an offer to a specific collection of the private store. + +### [Remove-AzMarketplacePrivateStoreCollection](Remove-AzMarketplacePrivateStoreCollection.md) +Delete a collection from the given private store. + +### [Remove-AzMarketplacePrivateStoreCollectionOffer](Remove-AzMarketplacePrivateStoreCollectionOffer.md) +Deletes an offer from the given collection of private store. + +### [Set-AzMarketplaceBulkPrivateStoreCollectionAction](Set-AzMarketplaceBulkPrivateStoreCollectionAction.md) +Perform an action on bulk collections + +### [Set-AzMarketplacePrivateStore](Set-AzMarketplacePrivateStore.md) +Changes private store properties + +### [Set-AzMarketplacePrivateStoreCollection](Set-AzMarketplacePrivateStoreCollection.md) +Create or update private store collection + +### [Set-AzMarketplacePrivateStoreCollectionOffer](Set-AzMarketplacePrivateStoreCollectionOffer.md) +Update or add an offer to a specific collection of the private store. diff --git a/azps-10.1.0/Az.Marketplace/Copy-AzMarketplacePrivateStoreCollectionOffer.md b/azps-10.1.0/Az.Marketplace/Copy-AzMarketplacePrivateStoreCollectionOffer.md new file mode 100644 index 0000000000..8f0026bd41 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Copy-AzMarketplacePrivateStoreCollectionOffer.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/copy-azmarketplaceprivatestorecollectionoffer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Copy-AzMarketplacePrivateStoreCollectionOffer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Copy-AzMarketplacePrivateStoreCollectionOffer.md +--- + +# Copy-AzMarketplacePrivateStoreCollectionOffer + +## SYNOPSIS +transferring offers (copy or move) from source collection to target collection(s) + +## SYNTAX + +### TransferExpanded (Default) +``` +Copy-AzMarketplacePrivateStoreCollectionOffer -CollectionId <String> -PrivateStoreId <String> + [-OfferIdList <String[]>] [-Operation <String>] [-TargetCollection <String[]>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Transfer +``` +Copy-AzMarketplacePrivateStoreCollectionOffer -CollectionId <String> -PrivateStoreId <String> + -Payload <ITransferOffersProperties> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### TransferViaIdentity +``` +Copy-AzMarketplacePrivateStoreCollectionOffer -InputObject <IMarketplaceIdentity> + -Payload <ITransferOffersProperties> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### TransferViaIdentityExpanded +``` +Copy-AzMarketplacePrivateStoreCollectionOffer -InputObject <IMarketplaceIdentity> [-OfferIdList <String[]>] + [-Operation <String>] [-TargetCollection <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +transferring offers (copy or move) from source collection to target collection(s) + +## EXAMPLES + +### Example 1: Copy offers from source collection to target collections. +```powershell +$payload = @{OfferIdsList = "aumatics.azure_managedservices"; Operation = "Copy"; TargetCollection = "3ac32d8c-e888-4dc6-b4ff-be4d755af13a"} +Copy-AzMarketplacePrivateStoreCollectionOffer -PrivateStoreId 3ac32d8c-e888-4dc6-b4ff-be4d755af13a -CollectionId fdb889a1-cf3e-49f0-95b8-2bb012fa01f1 -Payload $payload +``` + +```output +Failed Succeeded +------ --------- +{} {DefaultCollection} +``` + +This command copy offers from source collection to target collections. + +## PARAMETERS + +### -CollectionId +The collection ID + +```yaml +Type: System.String +Parameter Sets: Transfer, TransferExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity +Parameter Sets: TransferViaIdentity, TransferViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OfferIdList +Offers ids list to transfer from source collection to target collection(s) + +```yaml +Type: System.String[] +Parameter Sets: TransferExpanded, TransferViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operation +Operation to perform (For example: Copy or Move) + +```yaml +Type: System.String +Parameter Sets: TransferExpanded, TransferViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Payload +Transfer offers properties +To construct, see NOTES section for PAYLOAD properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.ITransferOffersProperties +Parameter Sets: Transfer, TransferViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateStoreId +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: Transfer, TransferExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetCollection +Target collections ids + +```yaml +Type: System.String[] +Parameter Sets: TransferExpanded, TransferViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.ITransferOffersProperties + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.ITransferOffersResponse + +## 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 `<IMarketplaceIdentity>`: Identity Parameter + - `[AdminRequestApprovalId <String>]`: The admin request approval ID to get create or update + - `[CollectionId <String>]`: The collection ID + - `[Id <String>]`: Resource identity path + - `[OfferId <String>]`: The offer ID to update or delete + - `[PrivateStoreId <String>]`: The store ID - must use the tenant ID + - `[RequestApprovalId <String>]`: The request approval ID to get create or update + +PAYLOAD `<ITransferOffersProperties>`: Transfer offers properties + - `[OfferIdsList <String[]>]`: Offers ids list to transfer from source collection to target collection(s) + - `[Operation <String>]`: Operation to perform (For example: Copy or Move) + - `[TargetCollection <String[]>]`: Target collections ids + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Get-AzMarketplaceBillingPrivateStoreAccount.md b/azps-10.1.0/Az.Marketplace/Get-AzMarketplaceBillingPrivateStoreAccount.md new file mode 100644 index 0000000000..6b262866ad --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Get-AzMarketplaceBillingPrivateStoreAccount.md @@ -0,0 +1,153 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/get-azmarketplacebillingprivatestoreaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplaceBillingPrivateStoreAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplaceBillingPrivateStoreAccount.md +--- + +# Get-AzMarketplaceBillingPrivateStoreAccount + +## SYNOPSIS +Tenant billing accounts names + +## SYNTAX + +### Billing (Default) +``` +Get-AzMarketplaceBillingPrivateStoreAccount -PrivateStoreId <String> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### BillingViaIdentity +``` +Get-AzMarketplaceBillingPrivateStoreAccount -InputObject <IMarketplaceIdentity> [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Tenant billing accounts names + +## EXAMPLES + +### Example 1: Returns the billing account of a private store +```powershell +Get-AzMarketplaceBillingPrivateStoreAccount -PrivateStoreId 3ac32d8c-e888-4dc6-b4ff-be4d755af13a +``` + +```output +<billing account[string]> +``` + +This command returns the billing account of a private store. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity +Parameter Sets: BillingViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateStoreId +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: Billing +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMarketplaceIdentity>`: Identity Parameter + - `[AdminRequestApprovalId <String>]`: The admin request approval ID to get create or update + - `[CollectionId <String>]`: The collection ID + - `[Id <String>]`: Resource identity path + - `[OfferId <String>]`: The offer ID to update or delete + - `[PrivateStoreId <String>]`: The store ID - must use the tenant ID + - `[RequestApprovalId <String>]`: The request approval ID to get create or update + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Get-AzMarketplaceCollectionToSubscriptionMapping.md b/azps-10.1.0/Az.Marketplace/Get-AzMarketplaceCollectionToSubscriptionMapping.md new file mode 100644 index 0000000000..de215f48f7 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Get-AzMarketplaceCollectionToSubscriptionMapping.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/get-azmarketplacecollectiontosubscriptionmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplaceCollectionToSubscriptionMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplaceCollectionToSubscriptionMapping.md +--- + +# Get-AzMarketplaceCollectionToSubscriptionMapping + +## SYNOPSIS +For a given subscriptions list, the API will return a map of collections and the related subscriptions from the supplied list. + +## SYNTAX + +### CollectionsExpanded (Default) +``` +Get-AzMarketplaceCollectionToSubscriptionMapping -PrivateStoreId <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Collections +``` +Get-AzMarketplaceCollectionToSubscriptionMapping -PrivateStoreId <String> + -Payload <ICollectionsToSubscriptionsMappingPayload> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CollectionsViaIdentity +``` +Get-AzMarketplaceCollectionToSubscriptionMapping -InputObject <IMarketplaceIdentity> + -Payload <ICollectionsToSubscriptionsMappingPayload> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CollectionsViaIdentityExpanded +``` +Get-AzMarketplaceCollectionToSubscriptionMapping -InputObject <IMarketplaceIdentity> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +For a given subscriptions list, the API will return a map of collections and the related subscriptions from the supplied list. + +## EXAMPLES + +### Example 1: For a given subscriptions list, the Cmdlet will return a map of collections and the related subscriptions from the supplied list. +```powershell +$res = Get-AzMarketplaceCollectionToSubscriptionMapping -PrivateStoreId a260d38c-96cf-492d-a340-404d0c4b3ad6 -Payload @{SubscriptionId = "53425a7b-4ac1-4729-8340-e1da5046212c"} +$res.keys +``` + +```output +e58535dc-1be3-4d2c-904c-1f97984ebe5d +fdb889a1-cf3e-49f0-95b8-2bb012fa01f1 +``` + +This command For a given subscriptions list, will return a map of collections and the related subscriptions from the supplied list. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity +Parameter Sets: CollectionsViaIdentity, CollectionsViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Payload +The subscriptions list to get the related collections +To construct, see NOTES section for PAYLOAD properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.ICollectionsToSubscriptionsMappingPayload +Parameter Sets: Collections, CollectionsViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateStoreId +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: Collections, CollectionsExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscriptions ids list + +```yaml +Type: System.String[] +Parameter Sets: CollectionsExpanded, CollectionsViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.ICollectionsToSubscriptionsMappingPayload + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.ICollectionsToSubscriptionsMappingResponseProperties + +## 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 `<IMarketplaceIdentity>`: Identity Parameter + - `[AdminRequestApprovalId <String>]`: The admin request approval ID to get create or update + - `[CollectionId <String>]`: The collection ID + - `[Id <String>]`: Resource identity path + - `[OfferId <String>]`: The offer ID to update or delete + - `[PrivateStoreId <String>]`: The store ID - must use the tenant ID + - `[RequestApprovalId <String>]`: The request approval ID to get create or update + +PAYLOAD `<ICollectionsToSubscriptionsMappingPayload>`: The subscriptions list to get the related collections + - `[SubscriptionId <String[]>]`: Subscriptions ids list + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStore.md b/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStore.md new file mode 100644 index 0000000000..1804337653 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStore.md @@ -0,0 +1,72 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.dll-Help.xml +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/get-azmarketplaceprivatestore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplacePrivateStore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplacePrivateStore.md +--- + +# Get-AzMarketplacePrivateStore + +## SYNOPSIS +Get private store list + +## SYNTAX + +``` +Get-AzMarketplacePrivateStore [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get private store list that were created under tenant scope + +## EXAMPLES + +### Example 1 +```powershell +Get-AzMarketplacePrivateStore +``` + +```output +Availability : enabled +PrivateStoreId : 7gh67884-1r56-44fb-a93d-030d4ae08b2d +ETag : "47006253-0000-0100-0000-5ecb6df90000" +Id : /providers/Microsoft.Marketplace/privateStores/7gh67884-1r56-44fb-a93d-030d4ae08b2d +Name : 7gh67884-1r56-44fb-a93d-030d4ae08b2d +Type : Microsoft.Marketplace/privateStores +``` + +private store list that were created under tenant scope + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Marketplace.Models.PrivateStore.PSPrivateStore + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStoreCollection.md b/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStoreCollection.md new file mode 100644 index 0000000000..67105d87e9 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStoreCollection.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/get-azmarketplaceprivatestorecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplacePrivateStoreCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplacePrivateStoreCollection.md +--- + +# Get-AzMarketplacePrivateStoreCollection + +## SYNOPSIS +Gets private store collection + +## SYNTAX + +### List (Default) +``` +Get-AzMarketplacePrivateStoreCollection -PrivateStoreId <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzMarketplacePrivateStoreCollection -CollectionId <String> -PrivateStoreId <String> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMarketplacePrivateStoreCollection -InputObject <IMarketplaceIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets private store collection + +## EXAMPLES + +### Example 1: Get list of private store collections +```powershell +Get-AzMarketplacePrivateStoreCollection -PrivateStoreId 53425a7b-4ac1-4729-8340-e1da5046212c +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +53425a7b-4ac1-4729-8340-e1da5046212c User 8/23/2021 6:06:52 AM User +23455a7b-4ac1-4729-8340-e1da5046212c 12/1/2021 9:01:33 PM User 12/1/2021 9:01:33 PM User + +``` + +This command gets list of private store collections + +## PARAMETERS + +### -CollectionId +The collection ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateStoreId +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.ICollection + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.ICollectionsList + +## 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 `<IMarketplaceIdentity>`: Identity Parameter + - `[AdminRequestApprovalId <String>]`: The admin request approval ID to get create or update + - `[CollectionId <String>]`: The collection ID + - `[Id <String>]`: Resource identity path + - `[OfferId <String>]`: The offer ID to update or delete + - `[PrivateStoreId <String>]`: The store ID - must use the tenant ID + - `[RequestApprovalId <String>]`: The request approval ID to get create or update + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStoreCollectionOffer.md b/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStoreCollectionOffer.md new file mode 100644 index 0000000000..aa04d8ecb3 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStoreCollectionOffer.md @@ -0,0 +1,162 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/get-azmarketplaceprivatestorecollectionoffer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplacePrivateStoreCollectionOffer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplacePrivateStoreCollectionOffer.md +--- + +# Get-AzMarketplacePrivateStoreCollectionOffer + +## SYNOPSIS +Gets information about a specific offer. + +## SYNTAX + +### List (Default) +``` +Get-AzMarketplacePrivateStoreCollectionOffer -CollectionId <String> -PrivateStoreId <String> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMarketplacePrivateStoreCollectionOffer -CollectionId <String> -OfferId <String> -PrivateStoreId <String> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMarketplacePrivateStoreCollectionOffer -InputObject <IMarketplaceIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a specific offer. + +## EXAMPLES + +### Example 1: Gets collection offers. +```powershell +Get-AzMarketplacePrivateStoreCollectionOffer -PrivateStoreId a260d38c-96cf-492d-a340-404d0c4b3ad6 -CollectionId a260d38c-96cf-492d-a340-404d0c4b3ad6 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ------------------- +data3-limited-1019419.d3_azure_managed_services +viacode_consulting-1089577.viacodems +RedHat.RHEL_7 +``` + +This command get colletion offer + +## PARAMETERS + +### -CollectionId +The collection ID + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OfferId +The offer ID to update or delete + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateStoreId +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.IOffer + +## 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 `<IMarketplaceIdentity>`: Identity Parameter + - `[AdminRequestApprovalId <String>]`: The admin request approval ID to get create or update + - `[CollectionId <String>]`: The collection ID + - `[Id <String>]`: Resource identity path + - `[OfferId <String>]`: The offer ID to update or delete + - `[PrivateStoreId <String>]`: The store ID - must use the tenant ID + - `[RequestApprovalId <String>]`: The request approval ID to get create or update + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStoreOffer.md b/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStoreOffer.md new file mode 100644 index 0000000000..5b034f3651 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStoreOffer.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.dll-Help.xml +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/get-azmarketplaceprivatestoreoffer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplacePrivateStoreOffer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplacePrivateStoreOffer.md +--- + +# Get-AzMarketplacePrivateStoreOffer + +## SYNOPSIS +Get one or more private store's offer. + +## SYNTAX + +``` +Get-AzMarketplacePrivateStoreOffer -PrivateStoreId <String> [-OfferId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get one or more private store's offer with public + private plans that were added under tenant scope. If subscription id is presents, +get one or more private store's offer with private plans only under subscription scope +## EXAMPLES + +### Example 1 +```powershell +Get-AzMarketplacePrivateStoreOffer -PrivateStoreId 7gh67884-1r56-44fb-a93d-030d4ae08b2d +``` + +```output +UniqueOfferId : publisherid.offerid +OfferDisplayName : +PublisherDisplayName : +ETag : "04009182-0000-0100-0000-5ecd2fb00000" +PrivateStoreId : 7gh67884-1r56-44fb-a93d-030d4ae08b2d +CreatedBy : +CreatedDate : 01/01/0001 00:00:00 +SpecificPlanIdsLimitation : {small, medium-with-upgraded-bandwidth, medium-with-upgraded-apps, large, large-pr, small-pr} +Id : /providers/Microsoft.Marketplace/privateStores/7gh67884-1r56-44fb-a93d-030d4ae08b2d/offers/ + publisherid.offerid +Name : publisherid.offerid +Type : Microsoft.Marketplace/privateStores/offers + +UniqueOfferId : publisherid1.offerid1 +OfferDisplayName : +PublisherDisplayName : +ETag : "00009568-0000-0100-0000-5ec4f9590000" +PrivateStoreId : 7gh67884-1r56-44fb-a93d-030d4ae08b2d +CreatedBy : +CreatedDate : 01/01/0001 00:00:00 +SpecificPlanIdsLimitation : {azure_managedservices_professional ,azure_managedservices_professional-pr} +Id : /providers/Microsoft.Marketplace/privateStores/7gh67884-1r56-44fb-a93d-030d4ae08b2d/offers/ + publisherid1.offerid1 +Name : publisherid1.offerid1 +Type : Microsoft.Marketplace/privateStores/offers +``` + +Get private store's offers with private + public plans that were added under tenant scope. + +### Example 2 +```powershell +Get-AzMarketplacePrivateStoreOffer -PrivateStoreId 7gh67884-1r56-44fb-a93d-030d4ae08b2d -SubscriptionId bc17bb69-1264-4f90-a9f6-0e51e29d5281 +``` + +```output +UniqueOfferId : publisherid.offerid +OfferDisplayName : +PublisherDisplayName : +ETag : "04009182-0000-0100-0000-5ecd2fb00000" +PrivateStoreId : 7gh67884-1r56-44fb-a93d-030d4ae08b2d +CreatedBy : +CreatedDate : 01/01/0001 00:00:00 +SpecificPlanIdsLimitation : {large-pr, small-pr} +Id : /subscriptions/bc17bb69-1264-4f90-a9f6-0e51e29d5281/providers/Microsoft.Marketplace/privateStores/7gh67884-1r56-44fb-a93d-030d4ae08b2d/offers/ + publisherid.offerid +Name : publisherid.offerid +Type : Microsoft.Marketplace/privateStores/offers + +UniqueOfferId : publisherid1.offerid1 +OfferDisplayName : +PublisherDisplayName : +ETag : "00009568-0000-0100-0000-5ec4f9590000" +PrivateStoreId : 7gh67884-1r56-44fb-a93d-030d4ae08b2d +CreatedBy : +CreatedDate : 01/01/0001 00:00:00 +SpecificPlanIdsLimitation : {azure_managedservices_professional-pr} +Id : /subscriptions/bc17bb69-1264-4f90-a9f6-0e51e29d5281/providers/Microsoft.Marketplace/privateStores/7gh67884-1r56-44fb-a93d-030d4ae08b2d/offers/ + publisherid1.offerid1 +Name : publisherid1.offerid1 +Type : Microsoft.Marketplace/privateStores/offers +``` + +Get private store's offers with private plans only that were added under subscription scope. + +### Example 3 +```powershell +Get-AzMarketplacePrivateStoreOffer -PrivateStoreId 7gh67884-1r56-44fb-a93d-030d4ae08b2d -OfferId publisherid.offerid +``` + +```output +UniqueOfferId : publisherid.offerid +OfferDisplayName : +PublisherDisplayName : +ETag : "04009182-0000-0100-0000-5ecd2fb00000" +PrivateStoreId : 7gh67884-1r56-44fb-a93d-030d4ae08b2d +CreatedBy : +CreatedDate : 01/01/0001 00:00:00 +SpecificPlanIdsLimitation : {small, medium-with-upgraded-bandwidth, medium-with-upgraded-apps, large, large-pr, small-pr} +Id : /providers/Microsoft.Marketplace/privateStores/7gh67884-1r56-44fb-a93d-030d4ae08b2d/offers/ + publisherid.offerid +Name : publisherid.offerid +Type : Microsoft.Marketplace/privateStores/offers +``` + +Get private store's offer with private + public plans that was been added under tenant scope. + +### Example 4 +```powershell +Get-AzMarketplacePrivateStoreOffer -PrivateStoreId 7gh67884-1r56-44fb-a93d-030d4ae08b2d -OfferId publisherid.offerid -SubscriptionId bc17bb69-1264-4f90-a9f6-0e51e29d5281 +``` + +```output +UniqueOfferId : publisherid.offerid +OfferDisplayName : +PublisherDisplayName : +ETag : "04009182-0000-0100-0000-5ecd2fb00000" +PrivateStoreId : 7gh67884-1r56-44fb-a93d-030d4ae08b2d +CreatedBy : +CreatedDate : 01/01/0001 00:00:00 +SpecificPlanIdsLimitation : {large-pr, small-pr} +Id : /subscriptions/bc17bb69-1264-4f90-a9f6-0e51e29d5281/providers/Microsoft.Marketplace/privateStores/7gh67884-1r56-44fb-a93d-030d4ae08b2d/offers/ + publisherid.offerid +Name : publisherid.offerid +Type : Microsoft.Marketplace/privateStores/offers +``` + +Get private store's offer with private plans only that was been added under tenant scope. + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferId +Required Azure Marketplace privateStore offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateStoreId +Required Azure Marketplace privateStore offers + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Marketplace subscription id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Marketplace.Models.PrivateStore.PSPrivateStoreOffer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStoreV1.md b/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStoreV1.md new file mode 100644 index 0000000000..4e60353218 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Get-AzMarketplacePrivateStoreV1.md @@ -0,0 +1,144 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/get-azmarketplaceprivatestorev1 +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplacePrivateStoreV1.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplacePrivateStoreV1.md +--- + +# Get-AzMarketplacePrivateStoreV1 + +## SYNOPSIS +Get information about the private store + +## SYNTAX + +### List (Default) +``` +Get-AzMarketplacePrivateStoreV1 [-UseCache <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMarketplacePrivateStoreV1 -Id <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMarketplacePrivateStoreV1 -InputObject <IMarketplaceIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get information about the private store + +## EXAMPLES + +### Example 1: Get Private Store details +```powershell +Get-AzMarketplacePrivateStoreV1 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +a260d38c-96cf-492d-a340-404d0c4b3ad6 User 12/1/2021 9:01:33 PM User +``` + +This command Gets the private store details + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PrivateStoreId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UseCache +Determines if to use cache or DB for serving this request + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.IPrivateStore + +## 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 `<IMarketplaceIdentity>`: Identity Parameter + - `[AdminRequestApprovalId <String>]`: The admin request approval ID to get create or update + - `[CollectionId <String>]`: The collection ID + - `[Id <String>]`: Resource identity path + - `[OfferId <String>]`: The offer ID to update or delete + - `[PrivateStoreId <String>]`: The store ID - must use the tenant ID + - `[RequestApprovalId <String>]`: The request approval ID to get create or update + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Get-AzMarketplaceQueryPrivateStoreOffer.md b/azps-10.1.0/Az.Marketplace/Get-AzMarketplaceQueryPrivateStoreOffer.md new file mode 100644 index 0000000000..2005dfc0a8 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Get-AzMarketplaceQueryPrivateStoreOffer.md @@ -0,0 +1,160 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/get-azmarketplacequeryprivatestoreoffer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplaceQueryPrivateStoreOffer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Get-AzMarketplaceQueryPrivateStoreOffer.md +--- + +# Get-AzMarketplaceQueryPrivateStoreOffer + +## SYNOPSIS +List of offers, regardless the collections + +## SYNTAX + +### Query (Default) +``` +Get-AzMarketplaceQueryPrivateStoreOffer -PrivateStoreId <String> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### QueryViaIdentity +``` +Get-AzMarketplaceQueryPrivateStoreOffer -InputObject <IMarketplaceIdentity> [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List of offers, regardless the collections + +## EXAMPLES + +### Example 1: Returns private store offer regardless of collections +```powershell +Get-AzMarketplaceQueryPrivateStoreOffer -PrivateStoreId 3ac32d8c-e888-4dc6-b4ff-be4d755af13a +``` + +```output +CreatedAt ETag ModifiedAt OfferDisplayName PrivateStoreId PublisherDisplayName SpecificPlanIdLimitation UniqueOfferId +--------- ---- ---------- ---------------- -------------- -------------------- ------------------------- ------------- + "ed0093ae-0000-0100-0000-61a4dab30000" 3ac32d8c-e888-4dc6-b4ff-be4d755af13a {d3-azure-health-check, data3-azure-optimiser-plan, data3-managed-azure-plan} data3-limite… + "750547d8-0000-0100-0000-61b752010000" 3ac32d8c-e888-4dc6-b4ff-be4d755af13a {mgmt-limited-free, mgmt-assessment} viacode_cons… + "ef00ab05-0000-0100-0000-61a5f12f0000" 3ac32d8c-e888-4dc6-b4ff-be4d755af13a {RedHatEnterpriseLinux72-ARM} RedHat.RHEL_7 + "f300276b-0000-0100-0000-61a7e1af0000" 3ac32d8c-e888-4dc6-b4ff-be4d755af13a {128technology_conductor_hourly_427, 128technology_conductor_hourly_452} 128technolog… + "f300296b-0000-0100-0000-61a7e1af0000" 3ac32d8c-e888-4dc6-b4ff-be4d755af13a {128technology_router_100_hourly_427, 128technology_router_100_hourly_452} 128technolog… + +``` + +This command returns private store offer regardless of collections + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity +Parameter Sets: QueryViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateStoreId +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: Query +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.IQueryOffers + +## 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 `<IMarketplaceIdentity>`: Identity Parameter + - `[AdminRequestApprovalId <String>]`: The admin request approval ID to get create or update + - `[CollectionId <String>]`: The collection ID + - `[Id <String>]`: Resource identity path + - `[OfferId <String>]`: The offer ID to update or delete + - `[PrivateStoreId <String>]`: The store ID - must use the tenant ID + - `[RequestApprovalId <String>]`: The request approval ID to get create or update + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/New-AzMarketplacePrivateStore.md b/azps-10.1.0/Az.Marketplace/New-AzMarketplacePrivateStore.md new file mode 100644 index 0000000000..d03e0436e8 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/New-AzMarketplacePrivateStore.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/new-azmarketplaceprivatestore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/New-AzMarketplacePrivateStore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/New-AzMarketplacePrivateStore.md +--- + +# New-AzMarketplacePrivateStore + +## SYNOPSIS +Changes private store properties + +## SYNTAX + +``` +New-AzMarketplacePrivateStore -Id <String> [-Availability <Availability>] [-Branding <Hashtable>] + [-ETag <String>] [-IsGov] [-NotificationSettingRecipient <IRecipient[]>] + [-NotificationSettingSendToAllMarketplaceAdmin] [-PrivateStoreName <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Changes private store properties + +## EXAMPLES + +### Example 1: Changes private store properties +```powershell +New-AzMarketplacePrivateStore -Id 0000000-0000-00000-0000-000000000000 -Availability 'disabled' -ETag '0000000-0000-00000-0000-000000000000' +``` + +This command changes private store properties. + +## PARAMETERS + +### -Availability +Indicates private store availability + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Support.Availability +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Branding +Gets or sets list of branding characteristics + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETag +Identifier for purposes of race condition + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PrivateStoreId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsGov +Is government + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSettingRecipient +Gets or sets list of notified recipients for new requests +To construct, see NOTES section for NOTIFICATIONSETTINGRECIPIENT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.IRecipient[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSettingSendToAllMarketplaceAdmin +Gets or sets whether to send email to all marketplace admins for new requests + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateStoreName +Private Store Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +Tenant id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +NOTIFICATIONSETTINGRECIPIENT <IRecipient[]>: Gets or sets list of notified recipients for new requests + - `[PrincipalId <String>]`: Principal ID + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/New-AzMarketplacePrivateStoreCollection.md b/azps-10.1.0/Az.Marketplace/New-AzMarketplacePrivateStoreCollection.md new file mode 100644 index 0000000000..fa66f26136 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/New-AzMarketplacePrivateStoreCollection.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/new-azmarketplaceprivatestorecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/New-AzMarketplacePrivateStoreCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/New-AzMarketplacePrivateStoreCollection.md +--- + +# New-AzMarketplacePrivateStoreCollection + +## SYNOPSIS +Create or update private store collection + +## SYNTAX + +``` +New-AzMarketplacePrivateStoreCollection -CollectionId <String> -PrivateStoreId <String> [-AllSubscription] + [-Claim <String>] [-CollectionName <String>] [-Enabled] [-SubscriptionsList <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update private store collection + +## EXAMPLES + +### Example 1: Create or updates private store collection +```powershell +New-AzMarketplacePrivateStoreCollection -CollectionName test -CollectionId fdb889a1-cf3e-49f0-95b8-2bb012fa01f1 -PrivateStoreId 3ac32d8c-e888-4dc6-b4ff-be4d755af13a -SubscriptionsList 7f5402e4-e8f4-46bd-9bd1-8d27866a606b +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +fdb889a1-cf3e-49f0-95b8-2bb012fa01f1 12/13/2021 11:12:27 AM User 12/13/2021 11:12:27 AM User +``` + +This command create or updates private store collection + +## PARAMETERS + +### -AllSubscription +Indicating whether all subscriptions are selected (=true) or not (=false). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Claim +Gets or sets the association with Commercial's Billing Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionId +The collection ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionName +Gets or sets collection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Indicating whether the collection is enabled or disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateStoreId +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionsList +Gets or sets subscription ids list. +Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. +On insert, null is considered as bad request + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.ICollection + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/New-AzMarketplacePrivateStoreCollectionOffer.md b/azps-10.1.0/Az.Marketplace/New-AzMarketplacePrivateStoreCollectionOffer.md new file mode 100644 index 0000000000..1b7e16e068 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/New-AzMarketplacePrivateStoreCollectionOffer.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/new-azmarketplaceprivatestorecollectionoffer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/New-AzMarketplacePrivateStoreCollectionOffer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/New-AzMarketplacePrivateStoreCollectionOffer.md +--- + +# New-AzMarketplacePrivateStoreCollectionOffer + +## SYNOPSIS +Update or add an offer to a specific collection of the private store. + +## SYNTAX + +``` +New-AzMarketplacePrivateStoreCollectionOffer -CollectionId <String> -OfferId <String> -PrivateStoreId <String> + [-ETag <String>] [-IconFileUri <Hashtable>] [-Plan <IPlan[]>] [-SpecificPlanIdLimitation <String[]>] + [-UpdateSuppressedDueIdempotence] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update or add an offer to a specific collection of the private store. + +## EXAMPLES + +### Example 1: Creates or updates offer to private store collection +```powershell +$acc = @{Accessibility = "azure_managedservices_professional"} +New-AzMarketplacePrivateStoreCollectionOffer -CollectionId fdb889a1-cf3e-49f0-95b8-2bb012fa01f1 -PrivateStoreId 7f5402e4-e8f4-46bd-9bd1-8d27866a606b -OfferId aumatics.azure_managedservices -Plan $acc +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +aumatics.azure_managedservices +``` + +This command creates or updates offer to private store collection. + +## PARAMETERS + +### -CollectionId +The collection ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETag +Identifier for purposes of race condition + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IconFileUri +Icon File Uris + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferId +The offer ID to update or delete + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Plan +Offer plans +To construct, see NOTES section for PLAN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.IPlan[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateStoreId +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpecificPlanIdLimitation +Plan ids limitation for this offer + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateSuppressedDueIdempotence +Indicating whether the offer was not updated to db (true = not updated). +If the allow list is identical to the existed one in db, the offer would not be updated. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.IOffer + +## 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. + + +PLAN <IPlan[]>: Offer plans + - `[Accessibility <Accessibility?>]`: Plan accessibility + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Remove-AzMarketplacePrivateStoreCollection.md b/azps-10.1.0/Az.Marketplace/Remove-AzMarketplacePrivateStoreCollection.md new file mode 100644 index 0000000000..838108e13d --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Remove-AzMarketplacePrivateStoreCollection.md @@ -0,0 +1,179 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/remove-azmarketplaceprivatestorecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Remove-AzMarketplacePrivateStoreCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Remove-AzMarketplacePrivateStoreCollection.md +--- + +# Remove-AzMarketplacePrivateStoreCollection + +## SYNOPSIS +Delete a collection from the given private store. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMarketplacePrivateStoreCollection -CollectionId <String> -PrivateStoreId <String> + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMarketplacePrivateStoreCollection -InputObject <IMarketplaceIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a collection from the given private store. + +## EXAMPLES + +### Example 1: Removes private store collection +```powershell +Remove-AzMarketplacePrivateStoreCollection -PrivateStoreId 3ac32d8c-e888-4dc6-b4ff-be4d755af13a -CollectionId fdb889a1-cf3e-49f0-95b8-2bb012fa01f1 +``` + +This command removes private store collection + +## PARAMETERS + +### -CollectionId +The collection ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateStoreId +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMarketplaceIdentity>`: Identity Parameter + - `[AdminRequestApprovalId <String>]`: The admin request approval ID to get create or update + - `[CollectionId <String>]`: The collection ID + - `[Id <String>]`: Resource identity path + - `[OfferId <String>]`: The offer ID to update or delete + - `[PrivateStoreId <String>]`: The store ID - must use the tenant ID + - `[RequestApprovalId <String>]`: The request approval ID to get create or update + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Remove-AzMarketplacePrivateStoreCollectionOffer.md b/azps-10.1.0/Az.Marketplace/Remove-AzMarketplacePrivateStoreCollectionOffer.md new file mode 100644 index 0000000000..2a754fc808 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Remove-AzMarketplacePrivateStoreCollectionOffer.md @@ -0,0 +1,194 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/remove-azmarketplaceprivatestorecollectionoffer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Remove-AzMarketplacePrivateStoreCollectionOffer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Remove-AzMarketplacePrivateStoreCollectionOffer.md +--- + +# Remove-AzMarketplacePrivateStoreCollectionOffer + +## SYNOPSIS +Deletes an offer from the given collection of private store. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMarketplacePrivateStoreCollectionOffer -CollectionId <String> -OfferId <String> + -PrivateStoreId <String> [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMarketplacePrivateStoreCollectionOffer -InputObject <IMarketplaceIdentity> + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an offer from the given collection of private store. + +## EXAMPLES + +### Example 1: Removes offer from private store collection +```powershell +Remove-AzMarketplacePrivateStoreCollectionOffer -PrivateStoreId 3ac32d8c-e888-4dc6-b4ff-be4d755af13a -CollectionId fdb889a1-cf3e-49f0-95b8-2bb012fa01f1 -OfferId aumatics.azure_managedservices +``` + +This command removes offer from private store collection + +## PARAMETERS + +### -CollectionId +The collection ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OfferId +The offer ID to update or delete + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateStoreId +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.IMarketplaceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMarketplaceIdentity>`: Identity Parameter + - `[AdminRequestApprovalId <String>]`: The admin request approval ID to get create or update + - `[CollectionId <String>]`: The collection ID + - `[Id <String>]`: Resource identity path + - `[OfferId <String>]`: The offer ID to update or delete + - `[PrivateStoreId <String>]`: The store ID - must use the tenant ID + - `[RequestApprovalId <String>]`: The request approval ID to get create or update + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Remove-AzMarketplacePrivateStoreOffer.md b/azps-10.1.0/Az.Marketplace/Remove-AzMarketplacePrivateStoreOffer.md new file mode 100644 index 0000000000..7e4fc5ad88 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Remove-AzMarketplacePrivateStoreOffer.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.dll-Help.xml +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/remove-azmarketplaceprivatestoreoffer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Remove-AzMarketplacePrivateStoreOffer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Remove-AzMarketplacePrivateStoreOffer.md +--- + +# Remove-AzMarketplacePrivateStoreOffer + +## SYNOPSIS +Remove an offer from private store. + +## SYNTAX + +``` +Remove-AzMarketplacePrivateStoreOffer -PrivateStoreId <String> -OfferId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove an offer from private store that was created in tenant scope. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzMarketplacePrivateStoreOffer -privateStoreId 7gh67884-1r56-44fb-a93d-030d4ae08b2d -offerId publisherid.offerid +``` + +Remove an offer from private store that was created in tenant scope. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferId +Required Azure Marketplace privateStore offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateStoreId +Required Azure Marketplace privateStore + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Marketplace/Set-AzMarketplaceBulkPrivateStoreCollectionAction.md b/azps-10.1.0/Az.Marketplace/Set-AzMarketplaceBulkPrivateStoreCollectionAction.md new file mode 100644 index 0000000000..06a8573eea --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Set-AzMarketplaceBulkPrivateStoreCollectionAction.md @@ -0,0 +1,181 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/set-azmarketplacebulkprivatestorecollectionaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Set-AzMarketplaceBulkPrivateStoreCollectionAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Set-AzMarketplaceBulkPrivateStoreCollectionAction.md +--- + +# Set-AzMarketplaceBulkPrivateStoreCollectionAction + +## SYNOPSIS +Perform an action on bulk collections + +## SYNTAX + +### BulkExpanded (Default) +``` +Set-AzMarketplaceBulkPrivateStoreCollectionAction -PrivateStoreId <String> [-Action <String>] + [-CollectionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Bulk +``` +Set-AzMarketplaceBulkPrivateStoreCollectionAction -PrivateStoreId <String> -Payload <IBulkCollectionsPayload> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Perform an action on bulk collections + +## EXAMPLES + +### Example 1: Preforms bulk action on collections +```powershell +Set-AzMarketplaceBulkPrivateStoreCollectionAction -PrivateStoreId 3ac32d8c-e888-4dc6-b4ff-be4d755af13a -Payload @{Action = "EnableCollections"; CollectionId = "3ac32d8c-e888-4dc6-b4ff-be4d755af13a", "fdb889a1-cf3e-49f0-95b8-2bb012fa01f1" } +``` + +```output +Failed Succeeded +------ --------- +{} {DefaultCollection, test} +``` + +This command Preforms bulk action on collections + +## PARAMETERS + +### -Action +Action to perform (For example: EnableCollections, DisableCollections) + +```yaml +Type: System.String +Parameter Sets: BulkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionId +collection ids list that the action is performed on + +```yaml +Type: System.String[] +Parameter Sets: BulkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Payload +Bulk collections action properties +To construct, see NOTES section for PAYLOAD properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.IBulkCollectionsPayload +Parameter Sets: Bulk +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateStoreId +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.IBulkCollectionsPayload + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.IBulkCollectionsResponse + +## 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. + + +PAYLOAD `<IBulkCollectionsPayload>`: Bulk collections action properties + - `[Action <String>]`: Action to perform (For example: EnableCollections, DisableCollections) + - `[CollectionId <String[]>]`: collection ids list that the action is performed on + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Set-AzMarketplacePrivateStore.md b/azps-10.1.0/Az.Marketplace/Set-AzMarketplacePrivateStore.md new file mode 100644 index 0000000000..c3eeb2a203 --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Set-AzMarketplacePrivateStore.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/set-azmarketplaceprivatestore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Set-AzMarketplacePrivateStore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Set-AzMarketplacePrivateStore.md +--- + +# Set-AzMarketplacePrivateStore + +## SYNOPSIS +Changes private store properties + +## SYNTAX + +``` +Set-AzMarketplacePrivateStore -Id <String> [-Availability <Availability>] [-Branding <Hashtable>] + [-ETag <String>] [-IsGov] [-NotificationSettingRecipient <IRecipient[]>] + [-NotificationSettingSendToAllMarketplaceAdmin] [-PrivateStoreName <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Changes private store properties + +## EXAMPLES + +### Example 1: Changes private store properties +```powershell +Set-AzMarketplacePrivateStore -Id 0000000-0000-00000-0000-000000000000 -Availability 'disabled' -ETag '0000000-0000-00000-0000-000000000000' +``` + +This command changes private store properties + +## PARAMETERS + +### -Availability +Indicates private store availability + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Support.Availability +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Branding +Gets or sets list of branding characteristics + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETag +Identifier for purposes of race condition + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PrivateStoreId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsGov +Is government + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSettingRecipient +Gets or sets list of notified recipients for new requests +To construct, see NOTES section for NOTIFICATIONSETTINGRECIPIENT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.IRecipient[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSettingSendToAllMarketplaceAdmin +Gets or sets whether to send email to all marketplace admins for new requests + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateStoreName +Private Store Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +Tenant id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +NOTIFICATIONSETTINGRECIPIENT <IRecipient[]>: Gets or sets list of notified recipients for new requests + - `[PrincipalId <String>]`: Principal ID + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Set-AzMarketplacePrivateStoreCollection.md b/azps-10.1.0/Az.Marketplace/Set-AzMarketplacePrivateStoreCollection.md new file mode 100644 index 0000000000..a3651b9f4d --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Set-AzMarketplacePrivateStoreCollection.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/set-azmarketplaceprivatestorecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Set-AzMarketplacePrivateStoreCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Set-AzMarketplacePrivateStoreCollection.md +--- + +# Set-AzMarketplacePrivateStoreCollection + +## SYNOPSIS +Create or update private store collection + +## SYNTAX + +``` +Set-AzMarketplacePrivateStoreCollection -CollectionId <String> -PrivateStoreId <String> [-AllSubscription] + [-Claim <String>] [-CollectionName <String>] [-Enabled] [-SubscriptionsList <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update private store collection + +## EXAMPLES + +### Example 1: Creates or updates private store collection +```powershell +Set-AzMarketplacePrivateStoreCollection -CollectionId 7f5402e4-e8f4-46bd-9bd1-8d27866a606b -PrivateStoreId 7f5402e4-e8f4-46bd-9bd1-8d27866a606b -AllSubscription +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +7f5402e4-e8f4-46bd-9bd1-8d27866a606b User 12/13/2021 1:21:57 PM User +``` + +This command creates or updates private store collection + +## PARAMETERS + +### -AllSubscription +Indicating whether all subscriptions are selected (=true) or not (=false). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Claim +Gets or sets the association with Commercial's Billing Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionId +The collection ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionName +Gets or sets collection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Indicating whether the collection is enabled or disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateStoreId +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionsList +Gets or sets subscription ids list. +Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. +On insert, null is considered as bad request + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.ICollection + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Set-AzMarketplacePrivateStoreCollectionOffer.md b/azps-10.1.0/Az.Marketplace/Set-AzMarketplacePrivateStoreCollectionOffer.md new file mode 100644 index 0000000000..621c114f7c --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Set-AzMarketplacePrivateStoreCollectionOffer.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/set-azmarketplaceprivatestorecollectionoffer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Set-AzMarketplacePrivateStoreCollectionOffer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Set-AzMarketplacePrivateStoreCollectionOffer.md +--- + +# Set-AzMarketplacePrivateStoreCollectionOffer + +## SYNOPSIS +Update or add an offer to a specific collection of the private store. + +## SYNTAX + +``` +Set-AzMarketplacePrivateStoreCollectionOffer -CollectionId <String> -OfferId <String> -PrivateStoreId <String> + [-ETag <String>] [-IconFileUri <Hashtable>] [-Plan <IPlan[]>] [-SpecificPlanIdLimitation <String[]>] + [-UpdateSuppressedDueIdempotence] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update or add an offer to a specific collection of the private store. + +## EXAMPLES + +### Example 1: Creates or updates offer to private store collection +```powershell +$acc = @{Accessibility = "azure_managedservices_professional"} +New-AzMarketplacePrivateStoreCollectionOffer -CollectionId fdb889a1-cf3e-49f0-95b8-2bb012fa01f1 -PrivateStoreId 7f5402e4-e8f4-46bd-9bd1-8d27866a606b -OfferId aumatics.azure_managedservices -Plan $acc +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- +aumatics.azure_managedservices +``` + +This command creates or updates offer to private store collection. + +## PARAMETERS + +### -CollectionId +The collection ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETag +Identifier for purposes of race condition + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IconFileUri +Icon File Uris + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferId +The offer ID to update or delete + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Plan +Offer plans +To construct, see NOTES section for PLAN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.IPlan[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateStoreId +The store ID - must use the tenant ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpecificPlanIdLimitation +Plan ids limitation for this offer + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateSuppressedDueIdempotence +Indicating whether the offer was not updated to db (true = not updated). +If the allow list is identical to the existed one in db, the offer would not be updated. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Marketplace.Models.Api20210601.IOffer + +## 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. + + +PLAN <IPlan[]>: Offer plans + - `[Accessibility <Accessibility?>]`: Plan accessibility + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Marketplace/Set-AzMarketplacePrivateStoreOffer.md b/azps-10.1.0/Az.Marketplace/Set-AzMarketplacePrivateStoreOffer.md new file mode 100644 index 0000000000..e6de2bb6db --- /dev/null +++ b/azps-10.1.0/Az.Marketplace/Set-AzMarketplacePrivateStoreOffer.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Marketplace.dll-Help.xml +Module Name: Az.Marketplace +online version: https://learn.microsoft.com/powershell/module/az.marketplace/set-azmarketplaceprivatestoreoffer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Set-AzMarketplacePrivateStoreOffer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Marketplace/Marketplace/help/Set-AzMarketplacePrivateStoreOffer.md +--- + +# Set-AzMarketplacePrivateStoreOffer + +## SYNOPSIS +Updates or creates offer for private store. + +## SYNTAX + +``` +Set-AzMarketplacePrivateStoreOffer -PrivateStoreId <String> -OfferId <String> + -SpecificPlanIdsLimitation <System.Collections.Generic.List`1[System.String]> [-ETag <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates or creates offer for private store that was created under tenant scope. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzMarketplacePrivateStoreOffer -privateStoreId 7gh67884-1r56-44fb-a93d-030d4ae08b2d -offerId publisherid.offerid -SpecificPlanIdsLimitation @("PublisherEnterpriseLinux72", "PublisherEnterpriseLinux72-ARM", "PublisherEnterpriseLinux73", "PublisherEnterpriseLinux73-ARM ", "PublisherEnterpriseLinux73-ARM-pr") +``` + +```output +UniqueOfferId : publisherid.offerid +OfferDisplayName : +PublisherDisplayName : +ETag : "04009562-0000-0600-0000-5ecd2fb00000" +PrivateStoreId : 7gh67884-1r56-44fb-a93d-030d4ae08b2d +CreatedBy : +CreatedDate : 01/01/0001 00:00:00 +SpecificPlanIdsLimitation : {PublisherEnterpriseLinux72, PublisherEnterpriseLinux72-ARM, PublisherEnterpriseLinux73, PublisherEnterpriseLinux73-ARM, PublisherEnterpriseLinux73-ARM-pr} +Id : /providers/Microsoft.Marketplace/privateStores/7gh67884-1r56-44fb-a93d-030d4ae08b2d/offers/ + publisherid.offerid +Name : publisherid.offerid +Type : Microsoft.Marketplace/privateStores/offers +``` + +Creates offer with private + public plans for private store that was created under tenant scope. + +### Example 2 +```powershell +Set-AzMarketplacePrivateStoreOffer -privateStoreId 7gh67884-1r56-44fb-a93d-030d4ae08b2d -offerId publisherid.offerid -SubscriptionId bc17bb69-1264-4f90-a9f6-0e51e29d5281 -SpecificPlanIdsLimitation @("PublisherEnterpriseLinux72", "PublisherEnterpriseLinux72-ARM", "PublisherEnterpriseLinux73", "PublisherEnterpriseLinux73-ARM ", "PublisherEnterpriseLinux73-ARM-pr") +``` + +```output +UniqueOfferId : publisherid.offerid +OfferDisplayName : +PublisherDisplayName : +ETag : "04009562-0000-0600-0000-5ecd2fb00000" +PrivateStoreId : 7gh67884-1r56-44fb-a93d-030d4ae08b2d +CreatedBy : +CreatedDate : 01/01/0001 00:00:00 +SpecificPlanIdsLimitation : {PublisherEnterpriseLinux73-ARM-pr} +Id : /subscriptions/bc17bb69-1264-4f90-a9f6-0e51e29d5281/providers/Microsoft.Marketplace/privateStores/7gh67884-1r56-44fb-a93d-030d4ae08b2d/offers/ + publisherid.offerid +Name : publisherid.offerid +Type : Microsoft.Marketplace/privateStores/offers +``` + +Creates offer with private plans only for private store that was created under subscription scope. + +### Example 3 +```powershell +Set-AzMarketplacePrivateStoreOffer -privateStoreId 7gh67884-1r56-44fb-a93d-030d4ae08b2d -offerId publisherid.offerid -SpecificPlanIdsLimitation @("PublisherEnterpriseLinux72", "PublisherEnterpriseLinux72-ARM", "PublisherEnterpriseLinux73") -ETag 04009562-0000-0600-0000-5ecd2fb00000 +``` + +```output +UniqueOfferId : publisherid.offerid +OfferDisplayName : +PublisherDisplayName : +ETag : "02009562-0000-0600-0120-3ecd2fb00000" +PrivateStoreId : 7gh67884-1r56-44fb-a93d-030d4ae08b2d +CreatedBy : +CreatedDate : 01/01/0001 00:00:00 +SpecificPlanIdsLimitation : {PublisherEnterpriseLinux72, PublisherEnterpriseLinux72-ARM, PublisherEnterpriseLinux73} +Id : /providers/Microsoft.Marketplace/privateStores/7gh67884-1r56-44fb-a93d-030d4ae08b2d/offers/ + publisherid.offerid +Name : publisherid.offerid +Type : Microsoft.Marketplace/privateStores/offers +``` + +Updates offer with private + public plans for private store that was created under tenant scope. Etag is needed. + +### Example 4 +```powershell +Set-AzMarketplacePrivateStoreOffer -privateStoreId 7gh67884-1r56-44fb-a93d-030d4ae08b2d -offerId publisherid.offerid -SubscriptionId bc17bb69-1264-4f90-a9f6-0e51e29d5281 -SpecificPlanIdsLimitation @("PublisherEnterpriseLinux73-pr") -ETag 04009562-0000-0600-0000-5ecd2fb00000 +``` + +```output +UniqueOfferId : publisherid.offerid +OfferDisplayName : +PublisherDisplayName : +ETag : "02009562-0000-0600-0120-3ecd2fb00000" +PrivateStoreId : 7gh67884-1r56-44fb-a93d-030d4ae08b2d +CreatedBy : +CreatedDate : 01/01/0001 00:00:00 +SpecificPlanIdsLimitation : {PublisherEnterpriseLinux73-pr} +Id : /subscriptions/bc17bb69-1264-4f90-a9f6-0e51e29d5281/providers/Microsoft.Marketplace/privateStores/7gh67884-1r56-44fb-a93d-030d4ae08b2d/offers/ + publisherid.offerid +Name : publisherid.offerid +Type : Microsoft.Marketplace/privateStores/offers +``` + +Updates offer for private store with private plans only that was created under subscription scope. Etag is needed. + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETag +Azure Marketplace privateStore offer's eTag for update + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferId +Required Azure Marketplace privateStore offer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateStoreId +Required Azure Marketplace privateStore offers + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpecificPlanIdsLimitation +Required Azure Marketplace privateStore offer's specific plan ids limitation + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Marketplace.Models.PrivateStore.PSPrivateStoreOffer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MarketplaceOrdering/Az.MarketplaceOrdering.md b/azps-10.1.0/Az.MarketplaceOrdering/Az.MarketplaceOrdering.md new file mode 100644 index 0000000000..7d1defa6ce --- /dev/null +++ b/azps-10.1.0/Az.MarketplaceOrdering/Az.MarketplaceOrdering.md @@ -0,0 +1,27 @@ +--- +Module Name: Az.MarketplaceOrdering +Module Guid: 95b51ba9-b0c9-430e-bab9-69492bc277cf +Download Help Link: https://learn.microsoft.com/powershell/module/az.marketplaceordering +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MarketplaceOrdering/help/Az.MarketplaceOrdering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MarketplaceOrdering/help/Az.MarketplaceOrdering.md +--- + +# Az.MarketplaceOrdering Module +## Description +Microsoft Azure PowerShell: MarketplaceOrdering cmdlets + +## Az.MarketplaceOrdering Cmdlets +### [Get-AzMarketplaceTerms](Get-AzMarketplaceTerms.md) +Get marketplace terms. + +### [Invoke-AzMarketplaceSignTerms](Invoke-AzMarketplaceSignTerms.md) +Sign marketplace terms. + +### [Set-AzMarketplaceTerms](Set-AzMarketplaceTerms.md) +Accept or reject terms for a given publisher id(Publisher), offer id(Product) and plan id(Name). + +### [Stop-AzMarketplaceTerms](Stop-AzMarketplaceTerms.md) +Cancel marketplace terms. + diff --git a/azps-10.1.0/Az.MarketplaceOrdering/Get-AzMarketplaceTerms.md b/azps-10.1.0/Az.MarketplaceOrdering/Get-AzMarketplaceTerms.md new file mode 100644 index 0000000000..3597755286 --- /dev/null +++ b/azps-10.1.0/Az.MarketplaceOrdering/Get-AzMarketplaceTerms.md @@ -0,0 +1,168 @@ +--- +external help file: +Module Name: Az.MarketplaceOrdering +online version: https://learn.microsoft.com/powershell/module/az.marketplaceordering/get-azmarketplaceterms +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MarketplaceOrdering/help/Get-AzMarketplaceTerms.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MarketplaceOrdering/help/Get-AzMarketplaceTerms.md +--- + +# Get-AzMarketplaceTerms + +## SYNOPSIS +Get marketplace terms. + +## SYNTAX + +### Get1 (Default) +``` +Get-AzMarketplaceTerms -Name <String> -Product <String> -Publisher <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMarketplaceTerms -Name <String> -OfferType <OfferType> -Product <String> -Publisher <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get marketplace terms. + +## EXAMPLES + +### Example 1: Get marketplace terms +```powershell +Get-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" +``` + +```output +Name Product Publisher Accepted Signature PrivacyPolicyLink +---- ------- --------- -------- --------- ----------------- +windows2016 microsoft-ads +``` + +This command gets marketplace terms. + +### Example 2: Get marketplace terms with offer type +```powershell +Get-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" -OfferType 'virtualmachine' +``` + +```output +Name Product Publisher Accepted Signature PrivacyPolicyLink +---- ------- --------- -------- --------- ----------------- +windows2016 windows-data-science-vm microsoft-ads True 523GN576A2S5OTTOGVFEZWYIWCUIQN2VE3I4WW3H2MER3ERJGDXZESHHQF5ZB2II2VUYXLRK6NE2A7EPF7GH6LWMQ6ECSYSPOD2SHFQ https://www.microsoft.com/EN-US/privacystatement/OnlineS +``` + +This command gets marketplace terms with offer type. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Plan identifier string of image being deployed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferType +Publisher identifier string of image being deployed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MarketplaceOrdering.Support.OfferType +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Product +Offer identifier string of image being deployed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Publisher +Publisher identifier string of image being deployed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MarketplaceOrdering.Models.IMarketplaceOrderingIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MarketplaceOrdering.Models.Api202101.IAgreementTerms + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MarketplaceOrdering/Invoke-AzMarketplaceSignTerms.md b/azps-10.1.0/Az.MarketplaceOrdering/Invoke-AzMarketplaceSignTerms.md new file mode 100644 index 0000000000..421c649ad0 --- /dev/null +++ b/azps-10.1.0/Az.MarketplaceOrdering/Invoke-AzMarketplaceSignTerms.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.MarketplaceOrdering +online version: https://learn.microsoft.com/powershell/module/az.marketplaceordering/invoke-azmarketplacesignterms +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MarketplaceOrdering/help/Invoke-AzMarketplaceSignTerms.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MarketplaceOrdering/help/Invoke-AzMarketplaceSignTerms.md +--- + +# Invoke-AzMarketplaceSignTerms + +## SYNOPSIS +Sign marketplace terms. + +## SYNTAX + +### Sign (Default) +``` +Invoke-AzMarketplaceSignTerms -Name <String> -Product <String> -Publisher <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### SignViaIdentity +``` +Invoke-AzMarketplaceSignTerms -InputObject <IMarketplaceOrderingIdentity> [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Sign marketplace terms. + +## EXAMPLES + +### Example 1: Sign marketplace terms +```powershell +Invoke-AzMarketplaceSignTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" +``` + +```output +Name Product Publisher Accepted Signature PrivacyPolicyLink +---- ------- --------- -------- --------- ----------------- +windows2016 microsoft-ads +``` + +This command signs marketplace terms. + +### Example 2: Sign marketplace terms by pipeline +```powershell +Get-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" | Invoke-AzMarketplaceSignTerms +``` + +```output +Name Product Publisher Accepted Signature PrivacyPolicyLink +---- ------- --------- -------- --------- ----------------- +windows2016 microsoft-ads +``` + +This command signs marketplace terms by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MarketplaceOrdering.Models.IMarketplaceOrderingIdentity +Parameter Sets: SignViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Plan identifier string of image being deployed. + +```yaml +Type: System.String +Parameter Sets: Sign +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Product +Offer identifier string of image being deployed. + +```yaml +Type: System.String +Parameter Sets: Sign +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Publisher +Publisher identifier string of image being deployed. + +```yaml +Type: System.String +Parameter Sets: Sign +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Sign +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MarketplaceOrdering.Models.IMarketplaceOrderingIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MarketplaceOrdering.Models.Api202101.IAgreementTerms + +## 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 <IMarketplaceOrderingIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[OfferId <String>]`: Offer identifier string of image being deployed. + - `[OfferType <OfferType?>]`: Offer Type, currently only virtualmachine type is supported. + - `[PlanId <String>]`: Plan identifier string of image being deployed. + - `[PublisherId <String>]`: Publisher identifier string of image being deployed. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MarketplaceOrdering/Set-AzMarketplaceTerms.md b/azps-10.1.0/Az.MarketplaceOrdering/Set-AzMarketplaceTerms.md new file mode 100644 index 0000000000..97a2355208 --- /dev/null +++ b/azps-10.1.0/Az.MarketplaceOrdering/Set-AzMarketplaceTerms.md @@ -0,0 +1,291 @@ +--- +external help file: +Module Name: Az.MarketplaceOrdering +online version: https://learn.microsoft.com/powershell/module/az.marketplaceordering/set-azmarketplaceterms +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MarketplaceOrdering/help/Set-AzMarketplaceTerms.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MarketplaceOrdering/help/Set-AzMarketplaceTerms.md +--- + +# Set-AzMarketplaceTerms + +## SYNOPSIS +Accept or reject terms for a given publisher id(Publisher), offer id(Product) and plan id(Name). + +## SYNTAX + +### TermsAccept (Default) +``` +Set-AzMarketplaceTerms -Name <String> -Product <String> -Publisher <String> -Accept [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### TermsAcceptViaIdentity +``` +Set-AzMarketplaceTerms -Accept -Terms <IAgreementTerms> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### TermsReject +``` +Set-AzMarketplaceTerms -Name <String> -Product <String> -Publisher <String> -Reject [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### TermsRejectViaIdentity +``` +Set-AzMarketplaceTerms -Reject -Terms <IAgreementTerms> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Accept or reject terms for a given publisher id(Publisher), offer id(Product) and plan id(Name). + +## EXAMPLES + +### Example 1: Accept terms for a given publisher id(Publisher), offer id(Product) and plan id(Name) +```powershell +Set-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" -Accept +``` + +```output +Name Product Publisher Accepted Signature PrivacyPolicyLink +---- ------- --------- -------- --------- ----------------- +windows2016 windows-data-science-vm microsoft-ads True 523GN576A2S5OTTOGVFEZWYIWCUIQN2VE3I4WW3H2MER3ERJGDXZESHHQF5ZB2II2VUYXLRK6NE2A7EPF7GH6LWMQ6ECSYSPOD2SHFQ https://www.microsoft.com/EN-US/privacystatement/OnlineS +``` + +This command accept terms for a given publisher id(Publisher), offer id(Product) and plan id(Name). + +### Example 2: Accept terms for a given publisher id(Publisher), offer id(Product) and plan id(Name) by pipeline +```powershell +Get-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" -OfferType 'virtualmachine' | Set-AzMarketplaceTerms -Accept +``` + +```output +Name Product Publisher Accepted Signature PrivacyPolicyLink +---- ------- --------- -------- --------- ----------------- +windows2016 windows-data-science-vm microsoft-ads True 523GN576A2S5OTTOGVFEZWYIWCUIQN2VE3I4WW3H2MER3ERJGDXZESHHQF5ZB2II2VUYXLRK6NE2A7EPF7GH6LWMQ6ECSYSPOD2SHFQ https://www.microsoft.com/EN-US/privacystatement/OnlineS +``` + +This command accept terms for a given publisher id(Publisher), offer id(Product) and plan id(Name) by pipeline. + +### Example 3: Reject terms for a given publisher id(Publisher), offer id(Product) and plan id(Name) +```powershell +Set-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" -Reject +``` + +```output +Name Product Publisher Accepted Signature PrivacyPolicyLink +---- ------- --------- -------- --------- ----------------- +windows2016 windows-data-science-vm microsoft-ads False 523GN576A2S5OTTOGVFEZWYIWCUIQN2VE3I4WW3H2MER3ERJGDXZESHHQF5ZB2II2VUYXLRK6NE2A7EPF7GH6LWMQ6ECSYSPOD2SHFQ https://www.microsoft.com/EN-US/privacystatement/OnlineS +``` + +This command reject terms for a given publisher id(Publisher), offer id(Product) and plan id(Name). + +### Example 4: Reject terms for a given publisher id(Publisher), offer id(Product) and plan id(Name) by pipeline +```powershell +Get-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" -OfferType 'virtualmachine' | Set-AzMarketplaceTerms -Reject +``` + +```output +Name Product Publisher Accepted Signature PrivacyPolicyLink +---- ------- --------- -------- --------- ----------------- +windows2016 windows-data-science-vm microsoft-ads False 523GN576A2S5OTTOGVFEZWYIWCUIQN2VE3I4WW3H2MER3ERJGDXZESHHQF5ZB2II2VUYXLRK6NE2A7EPF7GH6LWMQ6ECSYSPOD2SHFQ https://www.microsoft.com/EN-US/privacystatement/OnlineS +``` + +This command reject terms for a given publisher id(Publisher), offer id(Product) and plan id(Name) by pipeline. + +## PARAMETERS + +### -Accept +If any version of the terms have been accepted, otherwise false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: TermsAccept, TermsAcceptViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Plan identifier string of image being deployed. + +```yaml +Type: System.String +Parameter Sets: TermsAccept, TermsReject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Product +Offer identifier string of image being deployed. + +```yaml +Type: System.String +Parameter Sets: TermsAccept, TermsReject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Publisher +Publisher identifier string of image being deployed. + +```yaml +Type: System.String +Parameter Sets: TermsAccept, TermsReject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reject +Pass this to reject the legal terms. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: TermsReject, TermsRejectViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: TermsAccept, TermsReject +Aliases: + +Required: True +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Terms +Terms properties for provided Publisher/Offer/Plan tuple +To construct, see NOTES section for PARAMETER properties and create a hash table. +To construct, see NOTES section for TERMS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MarketplaceOrdering.Models.Api202101.IAgreementTerms +Parameter Sets: TermsAcceptViaIdentity, TermsRejectViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MarketplaceOrdering.Models.Api202101.IAgreementTerms + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MarketplaceOrdering.Models.Api202101.IAgreementTerms + +## 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. + + +`TERMS <IAgreementTerms>`: Terms properties for provided Publisher/Offer/Plan tuple To construct, see NOTES section for PARAMETER properties and create a hash table. + - `[Accepted <Boolean?>]`: If any version of the terms have been accepted, otherwise false. + - `[LicenseTextLink <String>]`: Link to HTML with Microsoft and Publisher terms. + - `[MarketplaceTermsLink <String>]`: Link to HTML with Azure Marketplace terms. + - `[Plan <String>]`: Plan identifier string of image being deployed. + - `[PrivacyPolicyLink <String>]`: Link to the privacy policy of the publisher. + - `[Product <String>]`: Offer identifier string of image being deployed. + - `[Publisher <String>]`: Publisher identifier string of image being deployed. + - `[RetrieveDatetime <DateTime?>]`: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. + - `[Signature <String>]`: Terms signature. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MarketplaceOrdering/Stop-AzMarketplaceTerms.md b/azps-10.1.0/Az.MarketplaceOrdering/Stop-AzMarketplaceTerms.md new file mode 100644 index 0000000000..4036f7338c --- /dev/null +++ b/azps-10.1.0/Az.MarketplaceOrdering/Stop-AzMarketplaceTerms.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.MarketplaceOrdering +online version: https://learn.microsoft.com/powershell/module/az.marketplaceordering/stop-azmarketplaceterms +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MarketplaceOrdering/help/Stop-AzMarketplaceTerms.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MarketplaceOrdering/help/Stop-AzMarketplaceTerms.md +--- + +# Stop-AzMarketplaceTerms + +## SYNOPSIS +Cancel marketplace terms. + +## SYNTAX + +### Cancel (Default) +``` +Stop-AzMarketplaceTerms -Name <String> -Product <String> -Publisher <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CancelViaIdentity +``` +Stop-AzMarketplaceTerms -InputObject <IMarketplaceOrderingIdentity> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Cancel marketplace terms. + +## EXAMPLES + +### Example 1: Cancel marketplace terms +```powershell +Stop-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" +``` + +```output +Name Product Publisher Accepted Signature PrivacyPolicyLink +---- ------- --------- -------- --------- ----------------- +windows2016 microsoft-ads +``` + +This command cancel marketplace terms. + +### Example 2: Cancel marketplace terms by pipeline +```powershell +Get-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" | Stop-AzMarketplaceTerms +``` + +```output +Name Product Publisher Accepted Signature PrivacyPolicyLink +---- ------- --------- -------- --------- ----------------- +windows2016 microsoft-ads +``` + +This command cancel marketplace terms by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MarketplaceOrdering.Models.IMarketplaceOrderingIdentity +Parameter Sets: CancelViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Plan identifier string of image being deployed. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Product +Offer identifier string of image being deployed. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Publisher +Publisher identifier string of image being deployed. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MarketplaceOrdering.Models.IMarketplaceOrderingIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MarketplaceOrdering.Models.Api202101.IAgreementTerms + +## 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 <IMarketplaceOrderingIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[OfferId <String>]`: Offer identifier string of image being deployed. + - `[OfferType <OfferType?>]`: Offer Type, currently only virtualmachine type is supported. + - `[PlanId <String>]`: Plan identifier string of image being deployed. + - `[PublisherId <String>]`: Publisher identifier string of image being deployed. + - `[SubscriptionId <String>]`: The subscription ID that identifies an Azure subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Media/Az.Media.md b/azps-10.1.0/Az.Media/Az.Media.md new file mode 100644 index 0000000000..227f716cd6 --- /dev/null +++ b/azps-10.1.0/Az.Media/Az.Media.md @@ -0,0 +1,43 @@ +--- +Module Name: Az.Media +Module Guid: c66edca6-2e57-4550-905e-f5cc104de25e +Download Help Link: https://learn.microsoft.com/powershell/module/az.media +Help Version: 0.9.2.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Az.Media.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Az.Media.md +--- + +# Az.Media Module +## Description +This topic displays help topics for the Media Service web service feature in Azure App Service cmdlets. + +## Az.Media Cmdlets +### [Get-AzMediaService](Get-AzMediaService.md) +Gets information about a media service. + +### [Get-AzMediaServiceKey](Get-AzMediaServiceKey.md) +Gets key information for accessing the REST endpoint associated with the media service. + +### [Get-AzMediaServiceNameAvailability](Get-AzMediaServiceNameAvailability.md) +Checks whether a media service name is available. +Media service names are globally unique. + +### [New-AzMediaService](New-AzMediaService.md) +Creates a media service if the media service already exists, all its properties are updated with the input provided. + +### [New-AzMediaServiceStorageConfig](New-AzMediaServiceStorageConfig.md) +Create a storage account configuration for the media service cmdlets. + +### [Remove-AzMediaService](Remove-AzMediaService.md) +Removes a media service. + +### [Set-AzMediaService](Set-AzMediaService.md) +Modifies specified properties of an existing media service. + +### [Set-AzMediaServiceKey](Set-AzMediaServiceKey.md) +Regenerates a key used for accessing the REST endpoint associated with the media service. + +### [Sync-AzMediaServiceStorageKey](Sync-AzMediaServiceStorageKey.md) +Synchronizes storage account keys for a storage account associated with the media service. + diff --git a/azps-10.1.0/Az.Media/Get-AzMediaService.md b/azps-10.1.0/Az.Media/Get-AzMediaService.md new file mode 100644 index 0000000000..632360516f --- /dev/null +++ b/azps-10.1.0/Az.Media/Get-AzMediaService.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Media.dll-Help.xml +Module Name: Az.Media +ms.assetid: 9843D191-CBC4-481A-BD36-D7B2D7917BD9 +online version: https://learn.microsoft.com/powershell/module/az.media/get-azmediaservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Get-AzMediaService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Get-AzMediaService.md +--- + +# Get-AzMediaService + +## SYNOPSIS +Gets information about a media service. + +## SYNTAX + +### ResourceGroupParameterSet +``` +Get-AzMediaService [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### AccountNameParameterSet +``` +Get-AzMediaService [-ResourceGroupName] <String> [-AccountName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzMediaService** cmdlet gets information about a media service. + +## EXAMPLES + +### Example 1: Get all media services in a resource group +```powershell +Get-AzMediaService -ResourceGroupName "ResourceGroup001" +``` + +This command gets properties for all media services in the resource group named ResourceGroup001. + +### Example 2: Get media service properties +```powershell +Get-AzMediaService -ResourceGroupName "ResourceGroup002" -AccountName "MediaService1" +``` + +This command gets the properties of the media service named MediaService1 that belongs to the resource group named ResourceGroup002. + +## PARAMETERS + +### -AccountName +Specifies the name of the media service that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: AccountNameParameterSet +Aliases: Name, ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the media service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Media.Models.PSMediaService + +## NOTES + +## RELATED LINKS + +[New-AzMediaService](./New-AzMediaService.md) + +[Remove-AzMediaService](./Remove-AzMediaService.md) + +[Set-AzMediaService](./Set-AzMediaService.md) + + diff --git a/azps-10.1.0/Az.Media/Get-AzMediaServiceKey.md b/azps-10.1.0/Az.Media/Get-AzMediaServiceKey.md new file mode 100644 index 0000000000..b7ecc3720f --- /dev/null +++ b/azps-10.1.0/Az.Media/Get-AzMediaServiceKey.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Media.dll-Help.xml +Module Name: Az.Media +ms.assetid: 2099938F-5325-416C-AE10-6813546A1055 +online version: https://learn.microsoft.com/powershell/module/az.media/get-azmediaservicekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Get-AzMediaServiceKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Get-AzMediaServiceKey.md +--- + +# Get-AzMediaServiceKey + +## SYNOPSIS +Gets key information for accessing the REST endpoint associated with the media service. + +## SYNTAX + +``` +Get-AzMediaServiceKey [-ResourceGroupName] <String> [-AccountName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzMediaServiceKey** cmdlet gets key information for accessing the Representational State Transfer (REST) endpoint associated with the Azure media service. + +## EXAMPLES + +### Example 1: Get the key information for accessing the media service +```powershell +Get-AzMediaServiceKey -ResourceGroupName "ResourceGroup001" -AccountName "MediaService001" +``` + +This command gets the key information for accessing the media service named MediaService001 that belongs to the resource group named ResourceGroup001. + +## PARAMETERS + +### -AccountName +Specifies the name of the media service that this cmdlet gets the media service keys from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the media service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Media.Models.PSServiceKeys + +## NOTES + +## RELATED LINKS + +[Set-AzMediaServiceKey](./Set-AzMediaServiceKey.md) + + diff --git a/azps-10.1.0/Az.Media/Get-AzMediaServiceNameAvailability.md b/azps-10.1.0/Az.Media/Get-AzMediaServiceNameAvailability.md new file mode 100644 index 0000000000..afd5a1b6f2 --- /dev/null +++ b/azps-10.1.0/Az.Media/Get-AzMediaServiceNameAvailability.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Media.dll-Help.xml +Module Name: Az.Media +ms.assetid: 23C6C9D3-A745-46C8-AB2C-B874223FBFFF +online version: https://learn.microsoft.com/powershell/module/az.media/get-azmediaservicenameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Get-AzMediaServiceNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Get-AzMediaServiceNameAvailability.md +--- + +# Get-AzMediaServiceNameAvailability + +## SYNOPSIS +Checks whether a media service name is available. +Media service names are globally unique. + +## SYNTAX + +``` +Get-AzMediaServiceNameAvailability [-DefaultProfile <IAzureContextContainer>] [-AccountName] <String> + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzMediaServiceNameAvailability** cmdlet checks whether a media service name is available. +Media service names are globally unique. + +## EXAMPLES + +### Example 1: Check whether a Media Service name is available +```powershell +Get-AzMediaServiceNameAvailability -AccountName "MediaService1" +``` + +This command checks if the name MediaService1 is available. + +## PARAMETERS + +### -AccountName +Specifies the name of the media service that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Media.Models.PSCheckNameAvailabilityOutput + +## NOTES + +## RELATED LINKS + +[Get-AzMediaService](./Get-AzMediaService.md) + +[New-AzMediaService](./New-AzMediaService.md) + +[Remove-AzMediaService](./Remove-AzMediaService.md) + +[Set-AzMediaService](./Set-AzMediaService.md) + + diff --git a/azps-10.1.0/Az.Media/New-AzMediaService.md b/azps-10.1.0/Az.Media/New-AzMediaService.md new file mode 100644 index 0000000000..4db4a00466 --- /dev/null +++ b/azps-10.1.0/Az.Media/New-AzMediaService.md @@ -0,0 +1,266 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Media.dll-Help.xml +Module Name: Az.Media +ms.assetid: 5CEA7323-4CF7-42B2-BA94-BB3C8F73D2E9 +online version: https://learn.microsoft.com/powershell/module/az.media/new-azmediaservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/New-AzMediaService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/New-AzMediaService.md +--- + +# New-AzMediaService + +## SYNOPSIS +Creates a media service if the media service already exists, all its properties are updated with the input provided. + +## SYNTAX + +### StorageAccountIdParamSet +``` +New-AzMediaService [-ResourceGroupName] <String> [-AccountName] <String> [-Location] <String> + [-StorageAccountId] <String> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### StorageAccountsParamSet +``` +New-AzMediaService [-ResourceGroupName] <String> [-AccountName] <String> [-Location] <String> + [-StorageAccounts] <PSStorageAccount[]> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzMediaService** cmdlet creates a media service. +If the media service already exists, this cmdlet update its properties. + +## EXAMPLES + +### Example1: Create a media service with the primary storage account only +```powershell +# Variables +## Global +$ResourceGroupName = "ResourceGroup001" +$Location = "East US" + +## Storage +$StorageName = "Storage1" +$StorageType = "Standard_GRS" + +## Media Service +$Tags = @{"tag1" = "value1"; "tag2" = "value2"} +$MediaServiceName = "MediaService1" + +# Resource Group +New-AzResourceGroup -Name $ResourceGroupName -Location $Location + +# Storage +$StorageAccount = New-AzStorageAccount -ResourceGroupName $ResourceGroupName -Name $StorageName -Location $Location -Type $StorageType + +# Media Service +New-AzMediaService -ResourceGroupName $ResourceGroupName -AccountName $MediaServiceName -Location $Location -StorageAccountId $StorageAccount.Id -Tag $Tags +``` + +This example shows how to create a media service with specifying primary storage account only. +This script uses several other cmdlets. + +### Example 2: Create a media service with multiple storage +```powershell +# Variables + +## Global +$ResourceGroupName = "ResourceGroup001" +$Location = "East US" + +## Storage +$StorageName1 = "storage1" +$StorageName2 = "storage2" +$StorageType = "Standard_GRS" + +## Media Service +$Tags = @{"tag1" = "value1"; "tag2" = "value2"} +$MediaServiceName = "MediaService1" + +# Resource Group +New-AzResourceGroup -Name $ResourceGroupName -Location $Location + +# Storage +$StorageAccount1 = New-AzStorageAccount -ResourceGroupName $ResourceGroupName -Name $StorageName1 -Location $Location -Type $StorageType + + +$StorageAccount2 = New-AzStorageAccount -ResourceGroupName $ResourceGroupName -Name $StorageName2 -Location $Location -Type $StorageType + +# Media Service + +## Setup the storage configuration object. +$PrimaryStorageAccount = New-AzMediaServiceStorageConfig -StorageAccountId $StorageAccount1.Id -IsPrimary +$SecondaryStorageAccount = New-AzMediaServiceStorageConfig -StorageAccountId $StorageAccount2.Id +$StorageAccounts = @($PrimaryStorageAccount, $SecondaryStorageAccount) + +## Create a media service.New-AzMediaService -ResourceGroupName $ResourceGroupName -AccountName $MediaServiceName -Location $Location -StorageAccounts $StorageAccounts -Tag $Tags +``` + +This example shows how to create a media service with multiple storage accounts. +This script uses several other cmdlets. + +## PARAMETERS + +### -AccountName +Specifies the name of the media service that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the region that this cmdlet creates the media service in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the media service is assigned to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountId +Specifies the storage account associated with the media service account. + +```yaml +Type: System.String +Parameter Sets: StorageAccountIdParamSet +Aliases: Id + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccounts +Specifies an array of storage accounts to associate with the media service. + +```yaml +Type: Microsoft.Azure.Commands.Media.Models.PSStorageAccount[] +Parameter Sets: StorageAccountsParamSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The tags associated with the media service account. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Media.Models.PSStorageAccount[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Media.Models.PSMediaService + +## NOTES + +## RELATED LINKS + +[Get-AzMediaService](./Get-AzMediaService.md) + +[Remove-AzMediaService](./Remove-AzMediaService.md) + +[Set-AzMediaService](./Set-AzMediaService.md) + + diff --git a/azps-10.1.0/Az.Media/New-AzMediaServiceStorageConfig.md b/azps-10.1.0/Az.Media/New-AzMediaServiceStorageConfig.md new file mode 100644 index 0000000000..edc1cf7e48 --- /dev/null +++ b/azps-10.1.0/Az.Media/New-AzMediaServiceStorageConfig.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Media.dll-Help.xml +Module Name: Az.Media +ms.assetid: 4D64CA4D-1066-4D3E-9317-60D37D9DE2BB +online version: https://learn.microsoft.com/powershell/module/az.media/new-azmediaservicestorageconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/New-AzMediaServiceStorageConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/New-AzMediaServiceStorageConfig.md +--- + +# New-AzMediaServiceStorageConfig + +## SYNOPSIS +Create a storage account configuration for the media service cmdlets. + +## SYNTAX + +``` +New-AzMediaServiceStorageConfig [-DefaultProfile <IAzureContextContainer>] [-StorageAccountId] <String> + [-IsPrimary] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzMediaServiceStorageConfig** cmdlet creates a storage account configuration for the media service cmdlets. + +## EXAMPLES + +### Example 1: Create a storage account configuration for the media service cmdlets +```powershell +$StorageAccount = New-AzStorageAccount -ResourceGroupName "ResourceGroup001" -Name "Storage1" -Location "East US" -Type "Standard_GRS" + +New-AzMediaServiceStorageConfig -StorageAccountId $StorageAccount.Id -IsPrimary +``` + +The first command creates a storage account object by using **the New-AzStorageAccount** cmdlet. +The command names this storage account Storage1 and the type is named Standard_GRS and stores the result in the variable named $StorageAccount. +The second command creates a storage configuration object as the primary storage account associated with the media service using the storage account ID information stored in the $StorageAccount variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsPrimary +Indicates that the cmdlet creates the storage account as the primary storage for the media service. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountId +Specifies the ID of the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Media.Models.PSStorageAccount + +## NOTES + +## RELATED LINKS + +[Sync-AzMediaServiceStorageKey](./Sync-AzMediaServiceStorageKey.md) + + diff --git a/azps-10.1.0/Az.Media/Remove-AzMediaService.md b/azps-10.1.0/Az.Media/Remove-AzMediaService.md new file mode 100644 index 0000000000..fde403e8d1 --- /dev/null +++ b/azps-10.1.0/Az.Media/Remove-AzMediaService.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Media.dll-Help.xml +Module Name: Az.Media +ms.assetid: 6AB6C366-4925-4370-A33E-EDAF4BE1E230 +online version: https://learn.microsoft.com/powershell/module/az.media/remove-azmediaservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Remove-AzMediaService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Remove-AzMediaService.md +--- + +# Remove-AzMediaService + +## SYNOPSIS +Removes a media service. + +## SYNTAX + +``` +Remove-AzMediaService [-ResourceGroupName] <String> [-AccountName] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzMediaService** cmdlet removes a media service. + +## EXAMPLES + +### Example 1: Remove a media service +```powershell +Remove-AzMediaService -ResourceGroupName "ResourceGroup001" -AccountName "MediaService0011" +``` + +This command removes the media service named MediaService0011 in the resource group named ResourceGroup001. + +## PARAMETERS + +### -AccountName +Specifies the name of the media service that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the media service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzMediaService](./Get-AzMediaService.md) + +[New-AzMediaService](./New-AzMediaService.md) + +[Set-AzMediaService](./Set-AzMediaService.md) + + diff --git a/azps-10.1.0/Az.Media/Set-AzMediaService.md b/azps-10.1.0/Az.Media/Set-AzMediaService.md new file mode 100644 index 0000000000..12a7231045 --- /dev/null +++ b/azps-10.1.0/Az.Media/Set-AzMediaService.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Media.dll-Help.xml +Module Name: Az.Media +ms.assetid: 0FA49058-F3A7-4ED9-93F2-0C84BC130FB7 +online version: https://learn.microsoft.com/powershell/module/az.media/set-azmediaservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Set-AzMediaService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Set-AzMediaService.md +--- + +# Set-AzMediaService + +## SYNOPSIS +Modifies specified properties of an existing media service. + +## SYNTAX + +``` +Set-AzMediaService [-ResourceGroupName] <String> [-AccountName] <String> [-Tag <Hashtable>] + [-StorageAccounts <PSStorageAccount[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzMediaService** cmdlet modifies specified properties of an existing media service. + +## EXAMPLES + +### Example 1: Modify an existing media service +```powershell +$StorageAccounts = New-AzStorageAccount -ResourceGroupName "ResourceGroupName001" -Name "Storage1" -Location "East US" -Type "Standard_GRS" +$Tags = @{"tag1" = "value1"; "tag2" = "value2"} +Set-AzMediaService -ResourceGroupName "ResourceGroup123" -AccountName "MediaService001" -Tag $Tags -StorageAccounts $StorageAccounts +``` + +The first command creates a series of tags and stores those tags in the variable named $Tags. +This second command updates the media service named MediaService001 that belongs to the resource group named ResourceGroup123 with the tags stored in $Tags variable. +The command also uses an array of storage configuration objects stored in $StorageAccounts variable. + +## PARAMETERS + +### -AccountName +Specifies the name of the media service that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the media service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccounts +Specifies an array of storage accounts that this cmdlet associates with the media service. + +```yaml +Type: Microsoft.Azure.Commands.Media.Models.PSStorageAccount[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The tags associated with the media account. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Media.Models.PSStorageAccount[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Media.Models.PSMediaService + +## NOTES + +## RELATED LINKS + +[Get-AzMediaService](./Get-AzMediaService.md) + +[New-AzMediaService](./New-AzMediaService.md) + +[Remove-AzMediaService](./Remove-AzMediaService.md) + + diff --git a/azps-10.1.0/Az.Media/Set-AzMediaServiceKey.md b/azps-10.1.0/Az.Media/Set-AzMediaServiceKey.md new file mode 100644 index 0000000000..f6a1bda10f --- /dev/null +++ b/azps-10.1.0/Az.Media/Set-AzMediaServiceKey.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Media.dll-Help.xml +Module Name: Az.Media +ms.assetid: D28EB28D-DBC6-48D5-AB0A-C56F56CD0104 +online version: https://learn.microsoft.com/powershell/module/az.media/set-azmediaservicekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Set-AzMediaServiceKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Set-AzMediaServiceKey.md +--- + +# Set-AzMediaServiceKey + +## SYNOPSIS +Regenerates a key used for accessing the REST endpoint associated with the media service. + +## SYNTAX + +``` +Set-AzMediaServiceKey [-ResourceGroupName] <String> [-AccountName] <String> [-KeyType] <KeyType> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzMediaServiceKey** cmdlet regenerates a key used for accessing the Representational State Transfer (REST) endpoint associated with the media service. + +## EXAMPLES + +### Example 1: Regenerate the primary key used for accessing the Media Service +```powershell +Set-AzMediaServiceKey -ResourceGroupName "ResourceGroup004" -AccountName "MediaService001" -KeyType Primary +``` + +This command regenerates the primary key for the media service named MediaService001 that belongs to the resource group named ResourceGroup004. + +### Example 2: Regenerates the secondary key used for accessing the Media Service +```powershell +Set-AzMediaServiceKey -ResourceGroupName "Resourcegroup123" -AccountName "MediaService002" -KeyType Secondary +``` + +This command regenerates the secondary key for the media service named MediaService002 that belongs to the resource group named Resourcegroup123. + +## PARAMETERS + +### -AccountName +Specifies the name of the media service that this cmdlet regenerates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyType +Specifies the key type of the media service. +The acceptable values for this parameter are: Primary or Secondary. + +```yaml +Type: Microsoft.Azure.Management.Media.Models.KeyType +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the media service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Media.Models.PSServiceKey + +## NOTES + +## RELATED LINKS + +[Get-AzMediaServiceKey](./Get-AzMediaServiceKey.md) + + diff --git a/azps-10.1.0/Az.Media/Sync-AzMediaServiceStorageKey.md b/azps-10.1.0/Az.Media/Sync-AzMediaServiceStorageKey.md new file mode 100644 index 0000000000..5098314d2d --- /dev/null +++ b/azps-10.1.0/Az.Media/Sync-AzMediaServiceStorageKey.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Media.dll-Help.xml +Module Name: Az.Media +ms.assetid: F395E192-80FA-421D-A389-8C5C0C2267E4 +online version: https://learn.microsoft.com/powershell/module/az.media/sync-azmediaservicestoragekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Sync-AzMediaServiceStorageKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Media/Media/help/Sync-AzMediaServiceStorageKey.md +--- + +# Sync-AzMediaServiceStorageKey + +## SYNOPSIS +Synchronizes storage account keys for a storage account associated with the media service. + +## SYNTAX + +```powershell +Sync-AzMediaServiceStorageKey [-ResourceGroupName] <String> [-AccountName] <String> + [-StorageAccountId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Sync-AzMediaServiceStorageKey** cmdlet synchronizes storage account keys for a storage account associated with the media service. + +## EXAMPLES + +### Example 1: Synchronize storage account keys for a storage account associated with the media service + +```powershell +$StorageAccount = Get-AzStorageAccount -ResourceGroupName "ResourceGroup001" -Name "Storage135" +Sync-AzMediaServiceStorageKey -ResourceGroupName "ResourceGroup001" -AccountName "MediasService001" -StorageAccountId $StorageAccount.Id +``` + +The first command uses the Get-AzStorageAccount cmdlet to get the storage account named Storage135 that belongs to ResourceGroup001 and stores the result in the variable named $StorageAccount. +The second command synchronizes the storage account keys for the media service named MediaService001 using the **Id** property contained in the $StorageAccount variable. + +## PARAMETERS + +### -AccountName +Specifies the name of the media service that this cmdlet synchronizes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the media service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountId +Specifies the storage account ID associated with the media service account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Id + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Migrate/Az.Migrate.md b/azps-10.1.0/Az.Migrate/Az.Migrate.md new file mode 100644 index 0000000000..901c145715 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Az.Migrate.md @@ -0,0 +1,109 @@ +--- +Module Name: Az.Migrate +Module Guid: c638312b-9fd1-4611-a5cc-11a8caa5b698 +Download Help Link: https://learn.microsoft.com/powershell/module/az.migrate +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Az.Migrate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Az.Migrate.md +--- + +# Az.Migrate Module +## Description +Microsoft Azure PowerShell: Migrate cmdlets + +## Az.Migrate Cmdlets +### [Get-AzMigrateDiscoveredServer](Get-AzMigrateDiscoveredServer.md) +Get All discovered servers in a migrate project. + +### [Get-AzMigrateJob](Get-AzMigrateJob.md) +Retrieves the status of an Azure Migrate job. + +### [Get-AzMigrateProject](Get-AzMigrateProject.md) +Method to get a migrate project. + +### [Get-AzMigrateReplicationFabric](Get-AzMigrateReplicationFabric.md) +Gets the details of an Azure Site Recovery fabric. + +### [Get-AzMigrateReplicationPolicy](Get-AzMigrateReplicationPolicy.md) +Gets the details of a replication policy. + +### [Get-AzMigrateReplicationProtectionContainer](Get-AzMigrateReplicationProtectionContainer.md) +Gets the details of a protection container. + +### [Get-AzMigrateReplicationProtectionContainerMapping](Get-AzMigrateReplicationProtectionContainerMapping.md) +Gets the details of a protection container mapping. + +### [Get-AzMigrateReplicationRecoveryServicesProvider](Get-AzMigrateReplicationRecoveryServicesProvider.md) +Gets the details of registered recovery services provider. + +### [Get-AzMigrateRunAsAccount](Get-AzMigrateRunAsAccount.md) +Method to get run as account. + +### [Get-AzMigrateServerReplication](Get-AzMigrateServerReplication.md) +Retrieves the details of the replicating server. + +### [Get-AzMigrateSite](Get-AzMigrateSite.md) +Method to get a site. + +### [Get-AzMigrateSolution](Get-AzMigrateSolution.md) +Gets a solution in the migrate project. + +### [Initialize-AzMigrateReplicationInfrastructure](Initialize-AzMigrateReplicationInfrastructure.md) +Initialises the infrastructure for the migrate project. + +### [New-AzMigrateDiskMapping](New-AzMigrateDiskMapping.md) +Creates a new disk mapping + +### [New-AzMigrateNicMapping](New-AzMigrateNicMapping.md) +Creates an object to update NIC properties of a replicating server. + +### [New-AzMigrateProject](New-AzMigrateProject.md) +Creates a new Migrate project. + +### [New-AzMigrateReplicationPolicy](New-AzMigrateReplicationPolicy.md) +The operation to create a replication policy. + +### [New-AzMigrateReplicationProtectionContainerMapping](New-AzMigrateReplicationProtectionContainerMapping.md) +The operation to create a protection container mapping. + +### [New-AzMigrateServerReplication](New-AzMigrateServerReplication.md) +Starts replication for the specified server. + +### [New-AzMigrateTestNicMapping](New-AzMigrateTestNicMapping.md) +Creates an object to update NIC properties of a test migrating server. + +### [Register-AzMigrateProjectTool](Register-AzMigrateProjectTool.md) +Registers a tool with the migrate project. + +### [Remove-AzMigrateProject](Remove-AzMigrateProject.md) +Delete the migrate project. +Deleting non-existent project is a no-operation. + +### [Remove-AzMigrateServerReplication](Remove-AzMigrateServerReplication.md) +Stops replication for the migrated server. + +### [Restart-AzMigrateServerReplication](Restart-AzMigrateServerReplication.md) +Restarts the replication for specified server. + +### [Resume-AzMigrateServerReplication](Resume-AzMigrateServerReplication.md) +Starts the replication that has been suspended. + +### [Set-AzMigrateDiskMapping](Set-AzMigrateDiskMapping.md) +Updates disk mapping + +### [Set-AzMigrateServerReplication](Set-AzMigrateServerReplication.md) +Updates the target properties for the replicating server. + +### [Start-AzMigrateServerMigration](Start-AzMigrateServerMigration.md) +Starts the migration for the replicating server. + +### [Start-AzMigrateTestMigration](Start-AzMigrateTestMigration.md) +Starts the test migration for the replicating server. + +### [Start-AzMigrateTestMigrationCleanup](Start-AzMigrateTestMigrationCleanup.md) +Cleans up the test migration for the replicating server. + +### [Suspend-AzMigrateServerReplication](Suspend-AzMigrateServerReplication.md) +Suspends the ongoing replication. + diff --git a/azps-10.1.0/Az.Migrate/Get-AzMigrateDiscoveredServer.md b/azps-10.1.0/Az.Migrate/Get-AzMigrateDiscoveredServer.md new file mode 100644 index 0000000000..1ce5c02004 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Get-AzMigrateDiscoveredServer.md @@ -0,0 +1,302 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratediscoveredserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateDiscoveredServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateDiscoveredServer.md +--- + +# Get-AzMigrateDiscoveredServer + +## SYNOPSIS +Get All discovered servers in a migrate project. + +## SYNTAX + +### List (Default) +``` +Get-AzMigrateDiscoveredServer -ProjectName <String> -ResourceGroupName <String> [-DisplayName <String>] + [-SubscriptionId <String[]>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Get +``` +Get-AzMigrateDiscoveredServer -Name <String> -ProjectName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### GetInSite +``` +Get-AzMigrateDiscoveredServer -ApplianceName <String> -Name <String> -ProjectName <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ListInSite +``` +Get-AzMigrateDiscoveredServer -ApplianceName <String> -ProjectName <String> -ResourceGroupName <String> + [-DisplayName <String>] [-SubscriptionId <String[]>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Get Azure migrate server commandlet fetches all servers in a migrate project. + +## EXAMPLES + +### Example 1: List +```powershell +Get-AzMigrateDiscoveredServer -SubscriptionId xxx-xxx-xxx -ResourceGroupName julytest -ProjectName julytest +``` + +```output +Name Typeo… +---- ----o… +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029c180-1359-5e3c-3f56-05632aa4a37f Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029d80d-d014-72f3-8d05-d43ee49a023d Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029bd24-6d40-88dc-4f29-329596f9a50b Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50292d97-2025-bfdf-1f07-86afa50d144f Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50293685-fb73-0a89-204f-f79cb1f0061e Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029c9aa-3c8c-aba8-834e-1058bc457e5b Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029dabc-cc94-780f-76fd-e39acb0e9dce Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50299579-fc18-4152-ade2-c4a57946f72b Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029cc18-efdc-7315-3b09-9d12a0f337e2 Microsoft.OffAzure/VMwareSites/machines + +``` + +Get All servers in a migrate project. + +### Example 2: Get +```powershell +Get-AzMigrateDiscoveredServer -Name idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc -SubscriptionId xxx-xxx-xxx -ResourceGroupName julytest -ProjectName julytest +``` + +```output +Name Typeo… +---- ----o… +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc Microsoft.OffAzure/VMwareSites/machines + +``` + +Get a server in a migrate project by name. +Name is a unique paramenter for a server. + +### Example 3: List in an appliance +```powershell +Get-AzMigrateDiscoveredServer -ApplianceName BBVMwareAVS -SubscriptionId xxx-xxx-xxx -ResourceGroupName julytest -ProjectName julytest +``` + +```output +Name Typeo… +---- ----o… +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029c180-1359-5e3c-3f56-05632aa4a37f Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029d80d-d014-72f3-8d05-d43ee49a023d Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029bd24-6d40-88dc-4f29-329596f9a50b Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50292d97-2025-bfdf-1f07-86afa50d144f Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50293685-fb73-0a89-204f-f79cb1f0061e Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029c9aa-3c8c-aba8-834e-1058bc457e5b Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029dabc-cc94-780f-76fd-e39acb0e9dce Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50299579-fc18-4152-ade2-c4a57946f72b Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029cc18-efdc-7315-3b09-9d12a0f337e2 Microsoft.OffAzure/VMwareSites/machines + +``` + +List all servers for an appliance in a project. + +### Example 4: Get in an appliance +```powershell +Get-AzMigrateDiscoveredServer -Name idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc -ApplianceName BBVMwareAVS -SubscriptionId xxx-xxx-xxx -ResourceGroupName julytest -ProjectName julytest +``` + +```output +Name Typeo… +---- ----o… +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc Microsoft.OffAzure/VMwareSites/machines + +``` + +Get a server for an appliance in a project. +Name is a unique paramenter for a server. + +### Example 5: List and filter by display name +```powershell +Get-AzMigrateDiscoveredServer -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -ProjectName BugBashAVSVMware -DisplayName Contoso | Format-Table DisplayName,Name,Type +``` + +```output +DisplayName Name Type +----------- ---- ---- +Contoso-ConfigurationServer 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50098b08-5701-4c58-f6ad-1daf127a8ed9 Microsoft.OffAzure/VMwareSites/machines +Contoso-FrontTier1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5009c31a-241a-8213-5627-4ea4af00df93 Microsoft.OffAzure/VMwareSites/machines +Contoso-MiddleTier1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50097bb8-f32c-39d6-f475-5aaa6194f016 Microsoft.OffAzure/VMwareSites/machines +ContosoAppSrv2 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5009b455-1721-fa03-7ceb-8177cd2c5de6 Microsoft.OffAzure/VMwareSites/machines +ContosoCSASR 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50096b80-7061-672c-8db0-07ee41212869 Microsoft.OffAzure/VMwareSites/machines +ContosoVMwareMigration2 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50099d31-71d5-2bd1-fada-8c4eba2f279a Microsoft.OffAzure/VMwareSites/machines +ContosoAppSrv1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50097d3f-c1f6-9217-825c-936db54043df Microsoft.OffAzure/VMwareSites/machines + +``` + +List servers in a migrate project and filter responses with display name. + +### Example 6: List in an appliance and filter by display name +```powershell +Get-AzMigrateDiscoveredServer -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -ProjectName BugBashAVSVMware -ApplianceName BBVMwareAVS -DisplayName Contoso | Format-Table DisplayName,Name,Type +``` + +```output +DisplayName Name Type +----------- ---- ---- +Contoso-ConfigurationServer 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50098b08-5701-4c58-f6ad-1daf127a8ed9 Microsoft.OffAzure/VMwareSites/machines +Contoso-FrontTier1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5009c31a-241a-8213-5627-4ea4af00df93 Microsoft.OffAzure/VMwareSites/machines +Contoso-MiddleTier1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50097bb8-f32c-39d6-f475-5aaa6194f016 Microsoft.OffAzure/VMwareSites/machines +ContosoAppSrv2 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5009b455-1721-fa03-7ceb-8177cd2c5de6 Microsoft.OffAzure/VMwareSites/machines +ContosoCSASR 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50096b80-7061-672c-8db0-07ee41212869 Microsoft.OffAzure/VMwareSites/machines +ContosoVMwareMigration2 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50099d31-71d5-2bd1-fada-8c4eba2f279a Microsoft.OffAzure/VMwareSites/machines +ContosoAppSrv1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50097d3f-c1f6-9217-825c-936db54043df Microsoft.OffAzure/VMwareSites/machines +Contoso-DataTier3 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_500986e5-7720-471e-11d7-d4e8ae9edc45 Microsoft.OffAzure/VMwareSites/machines +``` + +List servers for an appliance in a migrate project and filter responses with display name. + +## PARAMETERS + +### -ApplianceName +Specifies the appliance name. +This internally maps to a site. + +```yaml +Type: System.String +Parameter Sets: GetInSite, ListInSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies the VMware machine display name. + +```yaml +Type: System.String +Parameter Sets: List, ListInSite +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the VMware machine name. +This is an internal Name. +For users, use display name. + +```yaml +Type: System.String +Parameter Sets: Get, GetInSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +Specifies the migrate project name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Specifies the subscription id. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IVMwareMachine + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Get-AzMigrateJob.md b/azps-10.1.0/Az.Migrate/Get-AzMigrateJob.md new file mode 100644 index 0000000000..e67797de79 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Get-AzMigrateJob.md @@ -0,0 +1,358 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratejob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateJob.md +--- + +# Get-AzMigrateJob + +## SYNOPSIS +Retrieves the status of an Azure Migrate job. + +## SYNTAX + +### ListByName (Default) +``` +Get-AzMigrateJob -ProjectName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Filter <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetById +``` +Get-AzMigrateJob -JobID <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetByInputObject +``` +Get-AzMigrateJob -InputObject <IJob> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetByName +``` +Get-AzMigrateJob -JobName <String> -ProjectName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ListById +``` +Get-AzMigrateJob -ProjectID <String> -ResourceGroupID <String> [-SubscriptionId <String>] [-Filter <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzMigrateJob cmdlet retrives the status of an Azure Migrate job. + +## EXAMPLES + +### Example 1: Get By Job Id +```powershell +Get-AzMigrateJob -JobID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b" +``` + +```output +ActivityId : 68af14b4-46ae-48d1-b3e9-cdcffb9e8a93 ActivityId: 74d1a396-1d37-4264-8a5b-b727aaef0171 +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : 9/16/20 11:57:33 AM +Error : {} +FriendlyName : Associate replication policy +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b +Location : +Name : 997e2a92-5afe-49c7-a81a-89660aec9b7b +ScenarioName : AssociateProtectionProfile +StartTime : 9/16/20 11:57:32 AM +State : Succeeded +StateDescription : Completed +TargetInstanceType : ProtectionProfile +TargetObjectId : 42752b89-5fad-52fd-bf93-679fbdb6fed9 +TargetObjectName : migrateAzMigratePWSHTc8d1sitepolicy +Task : {CloudPairingPrerequisitesCheck, CloudPairingPrepareSite} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +This retrieves a job by it's Id. + +### Example 2: List by resource group and project +```powershell +Get-AzMigrateJob -ResourceGroupName 'azmigratepwshtestasr13072020' -ProjectName 'AzMigrateTestProjectPWSH' +``` + +```output +ActivityId : +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : +EndTime : 9/21/20 4:13:40 PM +Error : {} +FriendlyName : Update the virtual machine +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/1c89e38e-34ec-4903-aa7c-115201bf2de1 +Location : +Name : 1c89e38e-34ec-4903-aa7c-115201bf2de1 +ScenarioName : UpdateVmProperties +StartTime : 9/21/20 4:13:34 PM +State : Succeeded +StateDescription : Completed +TargetInstanceType : ProtectionEntity +TargetObjectId : 593b735d-2a34-53b2-b8ed-e33da5650703 +TargetObjectName : rb-w2k12r2-1 +Task : {} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +This gets all jobs in a project. + +### Example 3: Get by resource group, project and job name +```powershell +Get-AzMigrateJob -ResourceGroupName 'azmigratepwshtestasr13072020' -ProjectName 'AzMigrateTestProjectPWSH' -JobName 7ae1ee7c-442c-499d-8b0e-81d52a42b71e +``` + +```output +ActivityId : 6986b7e5-0f1f-49d8-8b4b-77e6f66bcb92 ActivityId: eb73c6a1-7c66-469f-a853-d896aa38cc0f +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : 8/21/20 6:41:48 AM +Error : {} +FriendlyName : Create replication policy +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/7ae1ee7c-442c-499d-8b0e-81d52a42b71e +Location : +Name : 7ae1ee7c-442c-499d-8b0e-81d52a42b71e +ScenarioName : AddProtectionProfile +StartTime : 8/21/20 6:41:48 AM +State : Succeeded +StateDescription : Completed +TargetInstanceType : ProtectionProfile +TargetObjectId : 18b2ccec-e39a-517b-ae5d-dd395e9f4f96 +TargetObjectName : samplePolicy3 +Task : {AddProtectionProfilePreflightsCheckTask, AddProtectionProfileTask} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +This gets a specific job. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +OData filter options. + +```yaml +Type: System.String +Parameter Sets: ListById, ListByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the job object of the replicating server. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IJob +Parameter Sets: GetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobID +Specifies the job id for which the details needs to be retrieved. + +```yaml +Type: System.String +Parameter Sets: GetById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +Job identifier + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectID +Specifies the Azure Migrate Project in which servers are replicating. + +```yaml +Type: System.String +Parameter Sets: ListById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the migrate project. + +```yaml +Type: System.String +Parameter Sets: GetByName, ListByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupID +Specifies the Resource Group of the Azure Migrate Project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: ListById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group where the recovery services vault is present. + +```yaml +Type: System.String +Parameter Sets: GetByName, ListByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IJob + +## 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 <IJob>`: Specifies the job object of the replicating server. + - `[Location <String>]`: Resource Location + - `[ActivityId <String>]`: The activity id. + - `[AllowedAction <String[]>]`: The Allowed action the job. + - `[CustomDetailAffectedObjectDetail <IJobDetailsAffectedObjectDetails>]`: The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[CustomDetailInstanceType <String>]`: Gets the type of job details (see JobDetailsTypes enum for possible values). + - `[EndTime <DateTime?>]`: The end time. + - `[Error <IJobErrorDetails[]>]`: The errors. + - `[CreationTime <DateTime?>]`: The creation time of job error. + - `[ErrorLevel <String>]`: Error level of error. + - `[ProviderErrorDetailErrorCode <Int32?>]`: The Error code. + - `[ProviderErrorDetailErrorId <String>]`: The Provider error Id. + - `[ProviderErrorDetailErrorMessage <String>]`: The Error message. + - `[ProviderErrorDetailPossibleCaus <String>]`: The possible causes for the error. + - `[ProviderErrorDetailRecommendedAction <String>]`: The recommended action to resolve the error. + - `[ServiceErrorDetailActivityId <String>]`: Activity Id. + - `[ServiceErrorDetailCode <String>]`: Error code. + - `[ServiceErrorDetailMessage <String>]`: Error message. + - `[ServiceErrorDetailPossibleCaus <String>]`: Possible causes of error. + - `[ServiceErrorDetailRecommendedAction <String>]`: Recommended action to resolve error. + - `[TaskId <String>]`: The Id of the task. + - `[FriendlyName <String>]`: The DisplayName. + - `[ScenarioName <String>]`: The ScenarioName. + - `[StartTime <DateTime?>]`: The start time. + - `[State <String>]`: The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. + - `[StateDescription <String>]`: The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. + - `[TargetInstanceType <String>]`: The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class. + - `[TargetObjectId <String>]`: The affected Object Id. + - `[TargetObjectName <String>]`: The name of the affected object. + - `[Task <IAsrTask[]>]`: The tasks. + - `[AllowedAction <String[]>]`: The state/actions applicable on this task. + - `[CustomDetailInstanceType <String>]`: The type of task details. + - `[EndTime <DateTime?>]`: The end time. + - `[Error <IJobErrorDetails[]>]`: The task error details. + - `[FriendlyName <String>]`: The name. + - `[GroupTaskCustomDetailChildTask <IAsrTask[]>]`: The child tasks. + - `[GroupTaskCustomDetailInstanceType <String>]`: The type of task details. + - `[Name <String>]`: The unique Task name. + - `[StartTime <DateTime?>]`: The start time. + - `[State <String>]`: The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. + - `[StateDescription <String>]`: The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. + - `[TaskId <String>]`: The Id. + - `[TaskType <String>]`: The type of task. Details in CustomDetails property depend on this type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Get-AzMigrateProject.md b/azps-10.1.0/Az.Migrate/Get-AzMigrateProject.md new file mode 100644 index 0000000000..3eedf94d3e --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Get-AzMigrateProject.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigrateproject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateProject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateProject.md +--- + +# Get-AzMigrateProject + +## SYNOPSIS +Method to get a migrate project. + +## SYNTAX + +``` +Get-AzMigrateProject -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Method to get a migrate project. + +## EXAMPLES + +### Example 1: Get +```powershell +Get-AzMigrateProject -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -Name BugBashAVSVMware +``` + +```output +ETag Location Name Type +---- -------- ---- ---- + southeastasia BugBashAVSVMware Microsoft.Migrate/MigrateProjects +``` + +Method to get a migrate project. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Migrate project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MigrateProjectName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure Resource Group that migrate project is part of. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180901Preview.IMigrateProject + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationFabric.md b/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationFabric.md new file mode 100644 index 0000000000..0e1f3c6973 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationFabric.md @@ -0,0 +1,197 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationfabric +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateReplicationFabric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateReplicationFabric.md +--- + +# Get-AzMigrateReplicationFabric + +## SYNOPSIS +Gets the details of an Azure Site Recovery fabric. + +## SYNTAX + +### List (Default) +``` +Get-AzMigrateReplicationFabric -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMigrateReplicationFabric -FabricName <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-Filter <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the details of an Azure Site Recovery fabric. + +## EXAMPLES + +### Example 1: Get all fabrics by resource group and vault name +```powershell +Get-AzMigrateReplicationFabric -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -FabricName AzMigratePWSHTc8d1replicationfabric +``` + +```output +BcdrState : Valid +CustomDetailInstanceType : VMwareV2 +EncryptionDetailKekCertExpiryDate : +EncryptionDetailKekCertThumbprint : +EncryptionDetailKekState : None +FriendlyName : AzMigratePWSHTc8d1replicationfabric +Health : Normal +HealthErrorDetail : {} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsof + t.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabr + ic +InternalIdentifier : 501ff8f2-c9d7-5bf4-87ff-d0b3fc98aeb5 +Location : +Name : AzMigratePWSHTc8d1replicationfabric +RolloverEncryptionDetailKekCertExpiryDate : +RolloverEncryptionDetailKekCertThumbprint : +RolloverEncryptionDetailKekState : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics +``` + +Get all fabrics in resource group and vault + +### Example 2: Get fabric by resource group, vault name and fabric name +```powershell +Get-AzMigrateReplicationFabric -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault +``` + +```output +BcdrState : Valid +CustomDetailInstanceType : VMwareV2 +EncryptionDetailKekCertExpiryDate : +EncryptionDetailKekCertThumbprint : +EncryptionDetailKekState : None +FriendlyName : AzMigratePWSHTc8d1replicationfabric +Health : Normal +HealthErrorDetail : {} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsof + t.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabr + ic +InternalIdentifier : 501ff8f2-c9d7-5bf4-87ff-d0b3fc98aeb5 +Location : +Name : AzMigratePWSHTc8d1replicationfabric +RolloverEncryptionDetailKekCertExpiryDate : +RolloverEncryptionDetailKekCertThumbprint : +RolloverEncryptionDetailKekState : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics +``` + +Get a specific fabric + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FabricName +Fabric name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +OData filter options. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group where the recovery services vault is present. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IFabric + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationPolicy.md b/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationPolicy.md new file mode 100644 index 0000000000..caf288255d --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationPolicy.md @@ -0,0 +1,155 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateReplicationPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateReplicationPolicy.md +--- + +# Get-AzMigrateReplicationPolicy + +## SYNOPSIS +Gets the details of a replication policy. + +## SYNTAX + +### List (Default) +``` +Get-AzMigrateReplicationPolicy -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMigrateReplicationPolicy -PolicyName <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the details of a replication policy. + +## EXAMPLES + +### Example 1: Get all policies in a vault +```powershell +Get-AzMigrateReplicationPolicy -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault +``` + +```output +Location Name Type +-------- ---- ---- + samplepolicy2 Microsoft.RecoveryServices/vaults/replicationPolicies + samplepolicy1 Microsoft.RecoveryServices/vaults/replicationPolicies + samplePolicy3 Microsoft.RecoveryServices/vaults/replicationPolicies + migrateAzMigratePWSHTc8d1sitepolicy Microsoft.RecoveryServices/vaults/replicationPolicies +``` + +Get all policies. + +### Example 2: Get a specific policy +```powershell +Get-AzMigrateReplicationPolicy -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -PolicyName migrateAzMigratePWSHTc8d1sitepolicy +``` + +```output +Location Name Type +-------- ---- ---- + migrateAzMigratePWSHTc8d1sitepolicy Microsoft.RecoveryServices/vaults/replicationPolicies +``` + +Get a specific one. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Replication policy name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group where the recovery services vault is present. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IPolicy + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationProtectionContainer.md b/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationProtectionContainer.md new file mode 100644 index 0000000000..6eb0c6bf11 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationProtectionContainer.md @@ -0,0 +1,174 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationprotectioncontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateReplicationProtectionContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateReplicationProtectionContainer.md +--- + +# Get-AzMigrateReplicationProtectionContainer + +## SYNOPSIS +Gets the details of a protection container. + +## SYNTAX + +### List1 (Default) +``` +Get-AzMigrateReplicationProtectionContainer -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMigrateReplicationProtectionContainer -FabricName <String> -ProtectionContainerName <String> + -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzMigrateReplicationProtectionContainer -FabricName <String> -ResourceGroupName <String> + -ResourceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the details of a protection container. + +## EXAMPLES + +### Example 1: List all protection containers in vault and fabric +```powershell +Get-AzMigrateReplicationProtectionContainer -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -FabricName AzMigratePWSHTc8d1replicationfabric +``` + +```output +Location Name Type +-------- ---- ---- + AzMigratePWSHTc8d1replicationcontainer Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers +``` + +Lists all. + +### Example 2: Get a specific container +```powershell +Get-AzMigrateReplicationProtectionContainer -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -FabricName AzMigratePWSHTc8d1replicationfabric -ProtectionContainerName AzMigratePWSHTc8d1replicationcontainer +``` + +```output +Location Name Type +-------- ---- ---- + AzMigratePWSHTc8d1replicationcontainer Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers +``` + +Gets a specific one. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FabricName +Fabric name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionContainerName +Protection container name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group where the recovery services vault is present. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IProtectionContainer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationProtectionContainerMapping.md b/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationProtectionContainerMapping.md new file mode 100644 index 0000000000..0148cd228b --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationProtectionContainerMapping.md @@ -0,0 +1,177 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationprotectioncontainermapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateReplicationProtectionContainerMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateReplicationProtectionContainerMapping.md +--- + +# Get-AzMigrateReplicationProtectionContainerMapping + +## SYNOPSIS +Gets the details of a protection container mapping. + +## SYNTAX + +### List1 (Default) +``` +Get-AzMigrateReplicationProtectionContainerMapping -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMigrateReplicationProtectionContainerMapping -FabricName <String> -MappingName <String> + -ProtectionContainerName <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzMigrateReplicationProtectionContainerMapping -FabricName <String> -ProtectionContainerName <String> + -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the details of a protection container mapping. + +## EXAMPLES + +### Example 1: Get a specific mapping +```powershell +Get-AzMigrateReplicationProtectionContainerMapping -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -FabricName AzMigratePWSHTc8d1replicationfabric -ProtectionContainerName AzMigratePWSHTc8d1replicationcontainer -MappingName "containermapping" +``` + +```output +Location Name Type +-------- ---- ---- + containermapping Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings +``` + +Get a mapping detail. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FabricName +Fabric name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MappingName +Protection Container mapping name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionContainerName +Protection container name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group where the recovery services vault is present. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IProtectionContainerMapping + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationRecoveryServicesProvider.md b/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationRecoveryServicesProvider.md new file mode 100644 index 0000000000..2020f1ef55 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Get-AzMigrateReplicationRecoveryServicesProvider.md @@ -0,0 +1,155 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationrecoveryservicesprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateReplicationRecoveryServicesProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateReplicationRecoveryServicesProvider.md +--- + +# Get-AzMigrateReplicationRecoveryServicesProvider + +## SYNOPSIS +Gets the details of registered recovery services provider. + +## SYNTAX + +### List (Default) +``` +Get-AzMigrateReplicationRecoveryServicesProvider -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMigrateReplicationRecoveryServicesProvider -FabricName <String> -ProviderName <String> + -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the details of registered recovery services provider. + +## EXAMPLES + +### Example 1: Get all providers in vault +```powershell +Get-AzMigrateReplicationRecoveryServicesProvider -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault +``` + +```output +Location Name Type +-------- ---- ---- + AzMigratePWSHTc8d1dra Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders +``` + +List all. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FabricName +Fabric name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderName +Recovery services provider name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group where the recovery services vault is present. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IRecoveryServicesProvider + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Get-AzMigrateRunAsAccount.md b/azps-10.1.0/Az.Migrate/Get-AzMigrateRunAsAccount.md new file mode 100644 index 0000000000..d256ba3c9d --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Get-AzMigrateRunAsAccount.md @@ -0,0 +1,153 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigraterunasaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateRunAsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateRunAsAccount.md +--- + +# Get-AzMigrateRunAsAccount + +## SYNOPSIS +Method to get run as account. + +## SYNTAX + +### List (Default) +``` +Get-AzMigrateRunAsAccount -ResourceGroupName <String> -SiteName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMigrateRunAsAccount -AccountName <String> -ResourceGroupName <String> -SiteName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Method to get run as account. + +## EXAMPLES + +### Example 1: List (Default) +```powershell +Get-AzMigrateRunAsAccount -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -SiteName BBVMwareAVScbbcsite +``` + +```output +Name Type +---- ---- +b090bef3-b733-5e34-bc8f-eb6f2701432a Microsoft.OffAzure/VMwareSites/runasaccounts +``` + +List all run as accounts in a site. + +### Example 2: Get +```powershell +Get-AzMigrateRunAsAccount -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -SiteName BBVMwareAVScbbcsite -AccountName b090bef3-b733-5e34-bc8f-eb6f2701432a +``` + +```output +Name Type +---- ---- +b090bef3-b733-5e34-bc8f-eb6f2701432a Microsoft.OffAzure/VMwareSites/runasaccounts +``` + +Get Run as account by name. + +## PARAMETERS + +### -AccountName +Run as account ARM name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteName +Site name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IVMwareRunAsAccount + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Get-AzMigrateServerReplication.md b/azps-10.1.0/Az.Migrate/Get-AzMigrateServerReplication.md new file mode 100644 index 0000000000..338eca4d7f --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Get-AzMigrateServerReplication.md @@ -0,0 +1,427 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigrateserverreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateServerReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateServerReplication.md +--- + +# Get-AzMigrateServerReplication + +## SYNOPSIS +Retrieves the details of the replicating server. + +## SYNTAX + +### ListByName (Default) +``` +Get-AzMigrateServerReplication -ProjectName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Filter <String>] [-SkipToken <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetByInputObject +``` +Get-AzMigrateServerReplication -InputObject <IMigrationItem> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetByMachineName +``` +Get-AzMigrateServerReplication -MachineName <String> -ProjectName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetBySDSID +``` +Get-AzMigrateServerReplication -DiscoveredMachineId <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetBySRSID +``` +Get-AzMigrateServerReplication -TargetObjectID <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ListById +``` +Get-AzMigrateServerReplication -ProjectID <String> -ResourceGroupID <String> [-SubscriptionId <String>] + [-Filter <String>] [-SkipToken <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzMigrateServerReplication cmdlet retrieves the object for the replicating server. + +## EXAMPLES + +### Example 1: Get details by id +```powershell +Get-AzMigrateServerReplication -TargetObjectID '/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f' +``` + +```output +AllowedOperation : {DisableMigration, TestMigrate, Migrate} +CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None +CurrentJobName : None +CurrentJobStartTime : 1/1/53 1:01:01 AM +EventCorrelationId : d8b110c6-3be9-4798-b2d4-9a1cd068adfb +Health : Normal +HealthError : {101883a0-23f7-538a-bbd5-6d8b4fa900e2} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont + ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- + e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f +LastTestMigrationStatus : +LastTestMigrationTime : +Location : +MachineName : prsadhu-TestVM +MigrationState : Replicating +MigrationStateDescription : Ready to migrate +Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f +PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy +PolicyId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy +ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails +TestMigrateState : None +TestMigrateStateDescription : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems +``` + +Get by id. + +### Example 2: List all in project by id. +```powershell +Get-AzMigrateServerReplication -ResourceGroupID /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020 -ProjectID "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Migrate/MigrateProjects/AzMigrateTestProjectPWSH" +``` + +```output +AllowedOperation : {DisableMigration, TestMigrate, Migrate} +CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None +CurrentJobName : None +CurrentJobStartTime : 1/1/53 1:01:01 AM +EventCorrelationId : d8b110c6-3be9-4798-b2d4-9a1cd068adfb +Health : Normal +HealthError : {101883a0-23f7-538a-bbd5-6d8b4fa900e2} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont + ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- + e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f +LastTestMigrationStatus : +LastTestMigrationTime : +Location : +MachineName : prsadhu-TestVM +MigrationState : Replicating +MigrationStateDescription : Ready to migrate +Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f +PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy +PolicyId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy +ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails +TestMigrateState : None +TestMigrateStateDescription : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems + +AllowedOperation : {DisableMigration, TestMigrate, Migrate} +CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None +CurrentJobName : None +CurrentJobStartTime : 1/1/53 1:01:01 AM +EventCorrelationId : 57b59212-6a2f-4333-8882-461647bb05f9 +Health : Normal +HealthError : {593b735d-2a34-53b2-b8ed-e33da5650703} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont + ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- + e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629 +LastTestMigrationStatus : +LastTestMigrationTime : +Location : +MachineName : rb-w2k12r2-1 +MigrationState : Replicating +MigrationStateDescription : Ready to migrate +Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629 +PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy +PolicyId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy +ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails +TestMigrateState : None +TestMigrateStateDescription : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems +``` + +List all. + +### Example 3: List all in project by name. +```powershell +Get-AzMigrateServerReplication -ResourceGroupName azmigratepwshtestasr13072020 -ProjectName AzMigrateTestProjectPWSH +``` + +```output +AllowedOperation : {DisableMigration, TestMigrate, Migrate} +CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None +CurrentJobName : None +CurrentJobStartTime : 1/1/53 1:01:01 AM +EventCorrelationId : d8b110c6-3be9-4798-b2d4-9a1cd068adfb +Health : Normal +HealthError : {101883a0-23f7-538a-bbd5-6d8b4fa900e2} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont + ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- + e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f +LastTestMigrationStatus : +LastTestMigrationTime : +Location : +MachineName : prsadhu-TestVM +MigrationState : Replicating +MigrationStateDescription : Ready to migrate +Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f +PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy +PolicyId : /Subscriptions/7xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy +ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails +TestMigrateState : None +TestMigrateStateDescription : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems + +AllowedOperation : {DisableMigration, TestMigrate, Migrate} +CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None +CurrentJobName : None +CurrentJobStartTime : 1/1/53 1:01:01 AM +EventCorrelationId : 57b59212-6a2f-4333-8882-461647bb05f9 +Health : Normal +HealthError : {593b735d-2a34-53b2-b8ed-e33da5650703} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont + ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- + e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629 +LastTestMigrationStatus : +LastTestMigrationTime : +Location : +MachineName : rb-w2k12r2-1 +MigrationState : Replicating +MigrationStateDescription : Ready to migrate +Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629 +PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy +PolicyId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy +ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails +TestMigrateState : None +TestMigrateStateDescription : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems +``` + +List all. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiscoveredMachineId +Specifies the machine ID of the discovered server. + +```yaml +Type: System.String +Parameter Sets: GetBySDSID +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +OData filter options. + +```yaml +Type: System.String +Parameter Sets: ListById, ListByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the machine object of the replicating server. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IMigrationItem +Parameter Sets: GetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineName +Specifies the display name of the replicating machine. + +```yaml +Type: System.String +Parameter Sets: GetByMachineName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectID +Specifies the Azure Migrate Project in which servers are replicating. + +```yaml +Type: System.String +Parameter Sets: ListById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +Specifies the Azure Migrate project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: GetByMachineName, ListByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupID +Specifies the Resource Group of the Azure Migrate Project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: ListById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the Resource Group of the Azure Migrate Project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: GetByMachineName, ListByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +The pagination token. + +```yaml +Type: System.String +Parameter Sets: ListById, ListByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replicating server. + +```yaml +Type: System.String +Parameter Sets: GetBySRSID +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IMigrationItem + +## 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 <IMigrationItem>`: Specifies the machine object of the replicating server. + - `[Location <String>]`: Resource Location + - `[ProviderSpecificDetail <IMigrationProviderSpecificSettings>]`: The migration provider custom settings. + - `InstanceType <String>`: Gets the instance type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Get-AzMigrateSite.md b/azps-10.1.0/Az.Migrate/Get-AzMigrateSite.md new file mode 100644 index 0000000000..38c1699a9a --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Get-AzMigrateSite.md @@ -0,0 +1,119 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratesite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateSite.md +--- + +# Get-AzMigrateSite + +## SYNOPSIS +Method to get a site. + +## SYNTAX + +``` +Get-AzMigrateSite -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Method to get a site. + +## EXAMPLES + +### Example 1: Get (Default) +```powershell +Get-AzMigrateSite -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -SiteName BBVMwareAVScbbcsite +``` + +```output +ETag Location Name Type +---- -------- ---- ---- + southeastasia BBVMwareAVScbbcsite Microsoft.OffAzure/VMwareSites + +``` + +Get site by name + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Site name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SiteName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IVMwareSite + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Get-AzMigrateSolution.md b/azps-10.1.0/Az.Migrate/Get-AzMigrateSolution.md new file mode 100644 index 0000000000..dd3ef56ceb --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Get-AzMigrateSolution.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratesolution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateSolution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Get-AzMigrateSolution.md +--- + +# Get-AzMigrateSolution + +## SYNOPSIS +Gets a solution in the migrate project. + +## SYNTAX + +``` +Get-AzMigrateSolution -MigrateProjectName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a solution in the migrate project. + +## EXAMPLES + +### Example 1: Get +```powershell +Get-AzMigrateSolution -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -MigrateProjectName BugBashAVSVMware -Name Servers-Migration-ServerMigration +``` + +```output +Etag Name Type +---- ---- ---- +"010097f1-0000-1800-0000-5ee9ae2b0000" Servers-Migration-ServerMigration Microsoft.Migrate/MigrateProjec… +``` + +Get Migrate project solution by name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateProjectName +Name of the Azure Migrate project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Unique name of a migration solution within a migrate project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SolutionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure Resource Group that migrate project is part of. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180901Preview.ISolution + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Initialize-AzMigrateReplicationInfrastructure.md b/azps-10.1.0/Az.Migrate/Initialize-AzMigrateReplicationInfrastructure.md new file mode 100644 index 0000000000..8367110861 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Initialize-AzMigrateReplicationInfrastructure.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/initialize-azmigratereplicationinfrastructure +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Initialize-AzMigrateReplicationInfrastructure.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Initialize-AzMigrateReplicationInfrastructure.md +--- + +# Initialize-AzMigrateReplicationInfrastructure + +## SYNOPSIS +Initialises the infrastructure for the migrate project. + +## SYNTAX + +``` +Initialize-AzMigrateReplicationInfrastructure -ProjectName <String> -ResourceGroupName <String> + -Scenario <String> -TargetRegion <String> [-CacheStorageAccountId <String>] [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The Initialize-AzMigrateReplicationInfrastructure cmdlet initialises the infrastructure for the migrate project. + +## EXAMPLES + +### Example 1: Initialises the infrastructure for the migrate project. +```powershell +Initialize-AzMigrateReplicationInfrastructure -ResourceGroupName TestRG -ProjectName TestProject -TargetRegion centralus +``` + +```output +True +``` + +Initialises the infrastructure for the migrate project. + +### Example 2: Initialises the infrastructure for the migrate project for private endpoint scenario. +```powershell +Initialize-AzMigrateReplicationInfrastructure -ResourceGroupName "TestRG" -ProjectName "TestPEProject" -TargetRegion "centraluseuap" -Scenario "agentlessVMware" -CacheStorageAccountId "/subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/singhabh-rg/providers/Microsoft.Storage/storageAccounts/singhabhstoragepe1" +``` + +```output +True +``` + +Initialises the infrastructure for the migrate project for private endpoint scenario. + +## PARAMETERS + +### -CacheStorageAccountId +Specifies the Storage Account Id to be used for private endpoint scenario. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +Specifies the name of the Azure Migrate project to be used for server migration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the Resource Group of the Azure Migrate Project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scenario +Specifies the server migration scenario for which the replication infrastructure needs to be initialized. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetRegion +Specifies the target Azure region for server migrations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/New-AzMigrateDiskMapping.md b/azps-10.1.0/Az.Migrate/New-AzMigrateDiskMapping.md new file mode 100644 index 0000000000..d2e1951f82 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/New-AzMigrateDiskMapping.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratediskmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateDiskMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateDiskMapping.md +--- + +# New-AzMigrateDiskMapping + +## SYNOPSIS +Creates a new disk mapping + +## SYNTAX + +``` +New-AzMigrateDiskMapping -DiskID <String> -DiskType <String> -IsOSDisk <String> + [-DiskEncryptionSetID <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzMigrateDiskMapping cmdlet creates a mapping of the source disk attached to the server to be migrated + +## EXAMPLES + +### Example 1: Make disks +```powershell +New-AzMigrateDiskMapping -DiskID a -DiskType Standard -IsOSDisk 'true' +``` + +```output +DiskEncryptionSetId DiskId DiskType IsOSDisk LogStorageAccountId LogStorageAccountSasSecretName +------------------- ------ -------- -------- ------------------- ------------------------------ + a Standard true +``` + +Get disks object to provide input for New-AzMigrateServerReplication + +## PARAMETERS + +### -DiskEncryptionSetID +Specifies the disk encyption set to be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskID +Specifies the disk ID of the disk attached to the discovered server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskType +Specifies the type of disks to be used for the Azure VM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsOSDisk +Specifies whether the disk contains the Operating System for the source server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtDiskInput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/New-AzMigrateNicMapping.md b/azps-10.1.0/Az.Migrate/New-AzMigrateNicMapping.md new file mode 100644 index 0000000000..256eb7bb96 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/New-AzMigrateNicMapping.md @@ -0,0 +1,163 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratenicmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateNicMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateNicMapping.md +--- + +# New-AzMigrateNicMapping + +## SYNOPSIS +Creates an object to update NIC properties of a replicating server. + +## SYNTAX + +``` +New-AzMigrateNicMapping -NicID <String> [-TargetNicIP <String>] [-TargetNicName <String>] + [-TargetNicSelectionType <String>] [-TargetNicSubnet <String>] [-TestNicIP <String>] + [-TestNicSubnet <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzMigrateNicMapping cmdlet creates a mapping of the source NIC attached to the server to be migrated. +This object is provided as an input to the Set-AzMigrateServerReplication cmdlet to update the NIC and its properties for a replicating server. + +## EXAMPLES + +### Example 1: Create a NIC object +```powershell +New-AzMigrateNicMapping -NicID a2399354-653a-464e-a567-d30ef5467a31 -TargetNicSelectionType primary -TargetNicIP "172.17.1.17" +``` + +```output +IsPrimaryNic IsSelectedForMigration NicId TargetStaticIPAddress TargetSubnetName +------------ ---------------------- ----- --------------------- ---------------- +false false a2399354-653a-464e-a567-d30ef5467a31 +``` + +Creates a NIC update object. + +## PARAMETERS + +### -NicID +Specifies the ID of the NIC to be updated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNicIP +Specifies the IP within the destination subnet to be used for the NIC. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNicName +Specifies the name of the NIC to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNicSelectionType +Specifies whether the NIC to be updated will be the primary, secondary or not migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNicSubnet +Specifies the Subnet name for the NIC in the destination Virtual Network to which the server needs to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNicIP +Specifies the IP within the destination test subnet to be used for the NIC. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNicSubnet +Specifies the Subnet name for the NIC in the destination Virtual Network to which the server needs to be test migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtNicInput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/New-AzMigrateProject.md b/azps-10.1.0/Az.Migrate/New-AzMigrateProject.md new file mode 100644 index 0000000000..3ab079bb7c --- /dev/null +++ b/azps-10.1.0/Az.Migrate/New-AzMigrateProject.md @@ -0,0 +1,186 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigrateproject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateProject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateProject.md +--- + +# New-AzMigrateProject + +## SYNOPSIS +Creates a new Migrate project. + +## SYNTAX + +``` +New-AzMigrateProject -Location <String> -Name <String> -ResourceGroupName <String> [-ETag <String>] + [-Property <IMigrateProjectProperties>] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Migrate project. + +## EXAMPLES + +### Example 1: Create (Default) +```powershell +New-AzMigrateProject -SubscriptionId xxx-xxx-xxx -ResourceGroupName kuchaturimpkocrg1 -Name kuchaturimpkocrg1pwshp14 -Location "centralus" +``` + +```output +ETag Location Name Type +---- -------- ---- ---- + centralus kuchaturimpkocrg1pwshp14 Microsoft.Migrate/MigrateProjects + +``` + +Method to create a new migrate project. + +## PARAMETERS + +### -ETag +Specifies the VMware machine name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the VMware machine name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the migrate project name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +Specifies the project properties. +To construct, see NOTES section for PROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180901Preview.IMigrateProjectProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Specifies the subscription id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## 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 <IMigrateProjectProperties>`: Specifies the project properties. + - `[ProvisioningState <ProvisioningState?>]`: Provisioning state of the migrate project. + - `[RegisteredTool <String[]>]`: Gets or sets the list of tools registered with the migrate project. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/New-AzMigrateReplicationPolicy.md b/azps-10.1.0/Az.Migrate/New-AzMigrateReplicationPolicy.md new file mode 100644 index 0000000000..5d22c6f347 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/New-AzMigrateReplicationPolicy.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratereplicationpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateReplicationPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateReplicationPolicy.md +--- + +# New-AzMigrateReplicationPolicy + +## SYNOPSIS +The operation to create a replication policy. + +## SYNTAX + +``` +New-AzMigrateReplicationPolicy -PolicyName <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String>] [-ProviderSpecificInput <IPolicyProviderSpecificInput>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The operation to create a replication policy. + +## EXAMPLES + +### Example 1: Create a replication policy +```powershell +$providerSpecificPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtPolicyCreationInput]::new() +$providerSpecificPolicy.AppConsistentFrequencyInMinute = 240 +$providerSpecificPolicy.InstanceType = "VMwareCbt" +$providerSpecificPolicy.RecoveryPointHistoryInMinute = 4320 +$providerSpecificPolicy.CrashConsistentFrequencyInMinute = 60 +New-AzMigrateReplicationPolicy -PolicyName TestPolicy -ResourceGroupName ResourceGroup -ResourceName VaultName -SubscriptionId SubscriptionId -ProviderSpecificInput $providerSpecificPolicy +``` + +```output +Location Name Type +-------- ---- ---- + TestPolicy Microsoft.RecoveryServices/vaults/replicationPolicies + +``` + +Creates a policy for VmWare Cbt + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Replication policy name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderSpecificInput +The ReplicationProviderSettings. +To construct, see NOTES section for PROVIDERSPECIFICINPUT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IPolicyProviderSpecificInput +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group where the recovery services vault is present. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IPolicy + +## 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. + + +`PROVIDERSPECIFICINPUT <IPolicyProviderSpecificInput>`: The ReplicationProviderSettings. + - `InstanceType <String>`: The class type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/New-AzMigrateReplicationProtectionContainerMapping.md b/azps-10.1.0/Az.Migrate/New-AzMigrateReplicationProtectionContainerMapping.md new file mode 100644 index 0000000000..9e4eded5d3 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/New-AzMigrateReplicationProtectionContainerMapping.md @@ -0,0 +1,290 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratereplicationprotectioncontainermapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateReplicationProtectionContainerMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateReplicationProtectionContainerMapping.md +--- + +# New-AzMigrateReplicationProtectionContainerMapping + +## SYNOPSIS +The operation to create a protection container mapping. + +## SYNTAX + +``` +New-AzMigrateReplicationProtectionContainerMapping -FabricName <String> -MappingName <String> + -ProtectionContainerName <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String>] [-PolicyId <String>] + [-ProviderSpecificInput <IReplicationProviderSpecificContainerMappingInput>] + [-TargetProtectionContainerId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +The operation to create a protection container mapping. + +## EXAMPLES + +### Example 1: Create a mapping +```powershell +$providerSpecificInput = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtContainerMappingInput]::new() +$providerSpecificInput.InstanceType = "VMwareCbt" +$providerSpecificInput.KeyVaultId = "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.KeyVault/vaults/migratekv846827101" +$providerSpecificInput.KeyVaultUri = "https://migratekv846827101.vault.azure.net" +$providerSpecificInput.ServiceBusConnectionStringSecretName = "ServiceBusConnectionString" +$providerSpecificInput.StorageAccountId = "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Storage/storageAccounts/migrategwsa846827101" +$providerSpecificInput.StorageAccountSasSecretName = "migrategwsa846827101-gwySas" +$providerSpecificInput.TargetLocation = "centraluseuap" + +New-AzMigrateReplicationProtectionContainerMapping -FabricName "AzMigratePWSHTc8d1replicationfabric" -MappingName "containermapping" -ProtectionContainerName "AzMigratePWSHTc8d1replicationcontainer" -ResourceGroupName "azmigratepwshtestasr13072020" -ResourceName "AzMigrateTestProjectPWSH02aarsvault" -PolicyId "/subscriptionsxxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy" -ProviderSpecificInput $providerSpecificInput -TargetProtectionContainerId "Microsoft Azure" +``` + +```output +Location Name Type +-------- ---- ---- + containermapping Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings +``` + +Create a mapping + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FabricName +Fabric name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MappingName +Protection container mapping name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +Applicable policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionContainerName +Protection container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderSpecificInput +Provider specific input for pairing. +To construct, see NOTES section for PROVIDERSPECIFICINPUT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IReplicationProviderSpecificContainerMappingInput +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group where the recovery services vault is present. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetProtectionContainerId +The target unique protection container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IProtectionContainerMapping + +## 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. + + +`PROVIDERSPECIFICINPUT <IReplicationProviderSpecificContainerMappingInput>`: Provider specific input for pairing. + - `InstanceType <String>`: The class type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/New-AzMigrateServerReplication.md b/azps-10.1.0/Az.Migrate/New-AzMigrateServerReplication.md new file mode 100644 index 0000000000..957767a5f8 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/New-AzMigrateServerReplication.md @@ -0,0 +1,576 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigrateserverreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateServerReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateServerReplication.md +--- + +# New-AzMigrateServerReplication + +## SYNOPSIS +Starts replication for the specified server. + +## SYNTAX + +### ByIdDefaultUser (Default) +``` +New-AzMigrateServerReplication -DiskType <String> -LicenseType <String> -MachineId <String> -OSDiskID <String> + -TargetNetworkId <String> -TargetResourceGroupId <String> -TargetSubnetName <String> -TargetVMName <String> + [-DiskEncryptionSetID <String>] [-DiskTag <IVMwareCbtEnableMigrationInputTargetDiskTags>] + [-NicTag <IVMwareCbtEnableMigrationInputTargetNicTags>] [-PerformAutoResync <String>] + [-SqlServerLicenseType <String>] [-SubscriptionId <String>] [-Tag <Hashtable>] + [-TargetAvailabilitySet <String>] [-TargetAvailabilityZone <String>] + [-TargetBootDiagnosticsStorageAccount <String>] [-TargetVMSize <String>] [-TestNetworkId <String>] + [-TestSubnetName <String>] [-VMTag <IVMwareCbtEnableMigrationInputTargetVmtags>] + [-VMWarerunasaccountID <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ByIdPowerUser +``` +New-AzMigrateServerReplication -DiskToInclude <IVMwareCbtDiskInput[]> -LicenseType <String> + -MachineId <String> -TargetNetworkId <String> -TargetResourceGroupId <String> -TargetSubnetName <String> + -TargetVMName <String> [-DiskTag <IVMwareCbtEnableMigrationInputTargetDiskTags>] + [-NicTag <IVMwareCbtEnableMigrationInputTargetNicTags>] [-PerformAutoResync <String>] + [-SqlServerLicenseType <String>] [-SubscriptionId <String>] [-Tag <Hashtable>] + [-TargetAvailabilitySet <String>] [-TargetAvailabilityZone <String>] + [-TargetBootDiagnosticsStorageAccount <String>] [-TargetVMSize <String>] [-TestNetworkId <String>] + [-TestSubnetName <String>] [-VMTag <IVMwareCbtEnableMigrationInputTargetVmtags>] + [-VMWarerunasaccountID <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ByInputObjectDefaultUser +``` +New-AzMigrateServerReplication -DiskType <String> -InputObject <IVMwareMachine> -LicenseType <String> + -OSDiskID <String> -TargetNetworkId <String> -TargetResourceGroupId <String> -TargetSubnetName <String> + -TargetVMName <String> [-DiskEncryptionSetID <String>] + [-DiskTag <IVMwareCbtEnableMigrationInputTargetDiskTags>] + [-NicTag <IVMwareCbtEnableMigrationInputTargetNicTags>] [-PerformAutoResync <String>] + [-SqlServerLicenseType <String>] [-SubscriptionId <String>] [-Tag <Hashtable>] + [-TargetAvailabilitySet <String>] [-TargetAvailabilityZone <String>] + [-TargetBootDiagnosticsStorageAccount <String>] [-TargetVMSize <String>] [-TestNetworkId <String>] + [-TestSubnetName <String>] [-VMTag <IVMwareCbtEnableMigrationInputTargetVmtags>] + [-VMWarerunasaccountID <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ByInputObjectPowerUser +``` +New-AzMigrateServerReplication -DiskToInclude <IVMwareCbtDiskInput[]> -InputObject <IVMwareMachine> + -LicenseType <String> -TargetNetworkId <String> -TargetResourceGroupId <String> -TargetSubnetName <String> + -TargetVMName <String> [-DiskTag <IVMwareCbtEnableMigrationInputTargetDiskTags>] + [-NicTag <IVMwareCbtEnableMigrationInputTargetNicTags>] [-PerformAutoResync <String>] + [-SqlServerLicenseType <String>] [-SubscriptionId <String>] [-Tag <Hashtable>] + [-TargetAvailabilitySet <String>] [-TargetAvailabilityZone <String>] + [-TargetBootDiagnosticsStorageAccount <String>] [-TargetVMSize <String>] [-TestNetworkId <String>] + [-TestSubnetName <String>] [-VMTag <IVMwareCbtEnableMigrationInputTargetVmtags>] + [-VMWarerunasaccountID <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzMigrateServerReplication cmdlet starts the replication for a particular discovered server in the Azure Migrate project. + +## EXAMPLES + +### Example 1: When there is only OS disk +```powershell +New-AzMigrateServerReplication -MachineId "/subscriptions/xxx-xxx-xxx4/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.OffAzure/VMwareSites/AzMigratePWSHTc8d1site/machines/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" -LicenseType NoLicenseType -TargetResourceGroupId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG" -TargetNetworkId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork" -TargetSubnetName default -TargetVMName "prsadhu-TestVM" -DiskType "Standard_LRS" -OSDiskID "6000C299-343d-7bcd-c05e-a94bd63316dd" +``` + +```output +ActivityId : 68af14b4-46ae-48d1-b3e9-cdcffb9e8a93 ActivityId: 74d1a396-1d37-4264-8a5b-b727aaef0171 +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : 9/16/20 11:57:33 AM +Error : {} +FriendlyName : Enable +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b +Location : +Name : 997e2a92-5afe-49c7-a81a-89660aec9b7b +ScenarioName : Enable +StartTime : 9/16/20 11:57:32 AM +State : Succeeded +StateDescription : Completed +TargetInstanceType : ProtectionProfile +TargetObjectId : 42752b89-5fad-52fd-bf93-679fbdb6fed9 +TargetObjectName : migrateAzMigratePWSHTc8d1sitepolicy +Task : {CloudPairingPrerequisitesCheck, CloudPairingPrepareSite} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +This is for the scenario, when there is only one single disk that has to be protected. + +### Example 2: When there are multiple disks +```powershell +$OSDisk = New-AzMigrateDiskMapping -DiskID '6000C299-343d-7bcd-c05e-a94bd63316dd' -DiskType 'Standard_LRS' -IsOSDisk 'true' +$DataDisk = New-AzMigrateDiskMapping -DiskID '7000C299-343d-7bcd-c05e-a94bd63316dd' -DiskType 'Standard_LRS' -IsOSDisk 'false' +$DisksToInclude += $OSDisk +$DisksToInclude += $DataDisk +New-AzMigrateServerReplication -MachineId "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.OffAzure/VMwareSites/AzMigratePWSHTc8d1site/machines/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" -LicenseType NoLicenseType -TargetResourceGroupId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG" -TargetNetworkId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork" -TargetSubnetName default -TargetVMName "prsadhu-TestVM" -DiskToInclude $DisksToInclude -PerformAutoResync true +``` + +```output +ActivityId : 68af14b4-46ae-48d1-b3e9-cdcffb9e8a93 ActivityId: 74d1a396-1d37-4264-8a5b-b727aaef0171 +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : 9/16/20 11:57:33 AM +Error : {} +FriendlyName : Enable +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b +Location : +Name : 997e2a92-5afe-49c7-a81a-89660aec9b7b +ScenarioName : Enable +StartTime : 9/16/20 11:57:32 AM +State : Succeeded +StateDescription : Completed +TargetInstanceType : ProtectionProfile +TargetObjectId : 42752b89-5fad-52fd-bf93-679fbdb6fed9 +TargetObjectName : migrateAzMigratePWSHTc8d1sitepolicy +Task : {CloudPairingPrerequisitesCheck, CloudPairingPrepareSite} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +This is for the scenario, when there are multiple disks that has to be protected. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetID +Specifies the disk encyption set to be used. + +```yaml +Type: System.String +Parameter Sets: ByIdDefaultUser, ByInputObjectDefaultUser +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskTag +Specifies the tag to be used for disk creation. +To construct, see NOTES section for DISKTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtEnableMigrationInputTargetDiskTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskToInclude +Specifies the disks on the source server to be included for replication. +To construct, see NOTES section for DISKTOINCLUDE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtDiskInput[] +Parameter Sets: ByIdPowerUser, ByInputObjectPowerUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskType +Specifies the type of disks to be used for the Azure VM. + +```yaml +Type: System.String +Parameter Sets: ByIdDefaultUser, ByInputObjectDefaultUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the discovered server to be migrated. +The server object can be retrieved using the Get-AzMigrateServer cmdlet. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IVMwareMachine +Parameter Sets: ByInputObjectDefaultUser, ByInputObjectPowerUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +Specifies if Azure Hybrid benefit is applicable for the source server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineId +Specifies the machine ID of the discovered server to be migrated. + +```yaml +Type: System.String +Parameter Sets: ByIdDefaultUser, ByIdPowerUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NicTag +Specifies the tag to be used for NIC creation. +To construct, see NOTES section for NICTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtEnableMigrationInputTargetNicTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSDiskID +Specifies the Operating System disk for the source server to be migrated. + +```yaml +Type: System.String +Parameter Sets: ByIdDefaultUser, ByInputObjectDefaultUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PerformAutoResync +Specifies if replication be auto-repaired in case change tracking is lost for the source server under replication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlServerLicenseType +Specifies if Azure Hybrid benefit for SQL Server is applicable for the server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specifies the tag to be used for Resource creation. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetAvailabilitySet +Specifies the Availability Set to be used for VM creationSpecifies the Availability Set to be used for VM creation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetAvailabilityZone +Specifies the Availability Zone to be used for VM creation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetBootDiagnosticsStorageAccount +Specifies the storage account to be used for boot diagnostics. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNetworkId +Specifies the Virtual Network id within the destination Azure subscription to which the server needs to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupId +Specifies the Resource Group id within the destination Azure subscription to which the server needs to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSubnetName +Specifies the Subnet name within the destination Virtual Network to which the server needs to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMName +Specifies the name of the Azure VM to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMSize +Specifies the SKU of the Azure VM to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNetworkId +Specifies the Virtual Network id within the destination Azure subscription to which the server needs to be test migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestSubnetName +Specifies the Subnet name within the destination Virtual Network to which the server needs to be test migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMTag +Specifies the tag to be used for VM creation. +To construct, see NOTES section for VMTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtEnableMigrationInputTargetVmtags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMWarerunasaccountID +Account id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IJob + +## 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. + + +`DISKTAG <IVMwareCbtEnableMigrationInputTargetDiskTags>`: Specifies the tag to be used for disk creation. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +`DISKTOINCLUDE <IVMwareCbtDiskInput[]>`: Specifies the disks on the source server to be included for replication. + - `DiskId <String>`: The disk Id. + - `IsOSDisk <String>`: A value indicating whether the disk is the OS disk. + - `LogStorageAccountId <String>`: The log storage account ARM Id. + - `LogStorageAccountSasSecretName <String>`: The key vault secret name of the log storage account. + - `[DiskEncryptionSetId <String>]`: The DiskEncryptionSet ARM Id. + - `[DiskType <DiskAccountType?>]`: The disk type. + +`INPUTOBJECT <IVMwareMachine>`: Specifies the discovered server to be migrated. The server object can be retrieved using the Get-AzMigrateServer cmdlet. + - `[GuestOSDetailOstype <String>]`: Type of the operating system. + +`NICTAG <IVMwareCbtEnableMigrationInputTargetNicTags>`: Specifies the tag to be used for NIC creation. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +`VMTAG <IVMwareCbtEnableMigrationInputTargetVmtags>`: Specifies the tag to be used for VM creation. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/New-AzMigrateTestNicMapping.md b/azps-10.1.0/Az.Migrate/New-AzMigrateTestNicMapping.md new file mode 100644 index 0000000000..b81b459f1b --- /dev/null +++ b/azps-10.1.0/Az.Migrate/New-AzMigrateTestNicMapping.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratetestnicmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateTestNicMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/New-AzMigrateTestNicMapping.md +--- + +# New-AzMigrateTestNicMapping + +## SYNOPSIS +Creates an object to update NIC properties of a test migrating server. + +## SYNTAX + +``` +New-AzMigrateTestNicMapping -NicID <String> -TestNicSubnet <String> [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzMigrateTestNicMapping cmdlet creates a mapping of the source NIC attached to the server to be test migrated. +This object is provided as an input to the Start-AzMigrateTestMigration cmdlet to update the NIC and its properties for a test migrating server. + +## EXAMPLES + +### Example 1: Create a NIC object for test migration. +```powershell +New-AzMigrateTestNicMapping -NicID a2399354-653a-464e-a567-d30ef5467a31 -TestNicSubnet subnet1 +``` + +```output +IsPrimaryNic IsSelectedForMigration NicId TargetNicName TargetStaticIPAddress TargetSubnetName TestStaticIPAddress TestSubnetName +------------ ---------------------- ----- ------------- --------------------- ---------------- ------------------- -------------- + a2399354-653a-464e-a567-d30ef5467a31 subnet1 +``` + +Creates a NIC object for test migration. + +## PARAMETERS + +### -NicID +Specifies the ID of the NIC to be updated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNicSubnet +Specifies the Subnet name for the NIC in the destination Virtual Network to which the server needs to be test migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtNicInput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Register-AzMigrateProjectTool.md b/azps-10.1.0/Az.Migrate/Register-AzMigrateProjectTool.md new file mode 100644 index 0000000000..389dfbebc5 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Register-AzMigrateProjectTool.md @@ -0,0 +1,178 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/register-azmigrateprojecttool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Register-AzMigrateProjectTool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Register-AzMigrateProjectTool.md +--- + +# Register-AzMigrateProjectTool + +## SYNOPSIS +Registers a tool with the migrate project. + +## SYNTAX + +``` +Register-AzMigrateProjectTool -MigrateProjectName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AcceptLanguage <String>] [-Tool <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Registers a tool with the migrate project. + +## EXAMPLES + +### Example 1: REgister tool. +```powershell +Register-AzMigrateProjectTool -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -MigrateProjectName BugBashAVSVMware -Tool Zerto +``` + +```output +True +``` + +Registers a tool with the migrate project. + +## PARAMETERS + +### -AcceptLanguage +Standard request header. +Used by service to respond to client in appropriate language. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateProjectName +Name of the Azure Migrate project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure Resource Group that migrate project is part of. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tool +Gets or sets the tool to be registered. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Remove-AzMigrateProject.md b/azps-10.1.0/Az.Migrate/Remove-AzMigrateProject.md new file mode 100644 index 0000000000..082616f11e --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Remove-AzMigrateProject.md @@ -0,0 +1,176 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/remove-azmigrateproject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Remove-AzMigrateProject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Remove-AzMigrateProject.md +--- + +# Remove-AzMigrateProject + +## SYNOPSIS +Delete the migrate project. +Deleting non-existent project is a no-operation. + +## SYNTAX + +``` +Remove-AzMigrateProject -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AcceptLanguage <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the migrate project. +Deleting non-existent project is a no-operation. + +## EXAMPLES + +### Example 1: Delete (Default) +```powershell +Remove-AzMigrateProject -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -Name BugBashAVSVMware +``` + +Delete the migrate project. +Deleting non-existent project is a no-operation. + +## PARAMETERS + +### -AcceptLanguage +Standard request header. +Used by service to respond to client in appropriate language. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Migrate project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MigrateProjectName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure Resource Group that migrate project is part of. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Remove-AzMigrateServerReplication.md b/azps-10.1.0/Az.Migrate/Remove-AzMigrateServerReplication.md new file mode 100644 index 0000000000..33276bc1c2 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Remove-AzMigrateServerReplication.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/remove-azmigrateserverreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Remove-AzMigrateServerReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Remove-AzMigrateServerReplication.md +--- + +# Remove-AzMigrateServerReplication + +## SYNOPSIS +Stops replication for the migrated server. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Remove-AzMigrateServerReplication -TargetObjectID <String> [-SubscriptionId <String>] [-ForceRemove <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ByInputObjectVMwareCbt +``` +Remove-AzMigrateServerReplication -InputObject <IMigrationItem> [-SubscriptionId <String>] + [-ForceRemove <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzMigrateServerReplication cmdlet stops the replication for a migrated server. + +## EXAMPLES + +### Example 1: Remove by id. +```powershell +Remove-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Disable +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : Disable +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs + +``` + +Resync by id. + +### Example 2: Remove by Input Object +```powershell +$obj = Get-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" +Remove-AzMigrateServerReplication -InputObject $obj +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Disable +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : Disable +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceRemove +Specifies whether the replication needs to be force removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the machine object of the replicating server. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replcating server for which the replicatio needs to be disabled. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IJob + +## 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 <IMigrationItem>`: Specifies the machine object of the replicating server. + - `[Location <String>]`: Resource Location + - `[ProviderSpecificDetail <IMigrationProviderSpecificSettings>]`: The migration provider custom settings. + - `InstanceType <String>`: Gets the instance type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Restart-AzMigrateServerReplication.md b/azps-10.1.0/Az.Migrate/Restart-AzMigrateServerReplication.md new file mode 100644 index 0000000000..e884f44bc5 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Restart-AzMigrateServerReplication.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/restart-azmigrateserverreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Restart-AzMigrateServerReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Restart-AzMigrateServerReplication.md +--- + +# Restart-AzMigrateServerReplication + +## SYNOPSIS +Restarts the replication for specified server. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Restart-AzMigrateServerReplication -TargetObjectID <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ByInputObjectVMwareCbt +``` +Restart-AzMigrateServerReplication -InputObject <IMigrationItem> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +The Restart-AzMigrateServerReplication cmdlet repairs the replication for the specified server. + +## EXAMPLES + +### Example 1: By id. +```powershell +Restart-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Restart +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : Restart +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By id. + +### Example 2: By Input Object +```powershell +$obj = Get-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" +$output = Restart-AzMigrateServerReplication -InputObject $obj +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Restart +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : Restart +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By Input Object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the machine object of the replicating server. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replcating server for which the resync needs to be initiated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IJob + +## 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 <IMigrationItem>`: Specifies the machine object of the replicating server. + - `[Location <String>]`: Resource Location + - `[ProviderSpecificDetail <IMigrationProviderSpecificSettings>]`: The migration provider custom settings. + - `InstanceType <String>`: Gets the instance type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Resume-AzMigrateServerReplication.md b/azps-10.1.0/Az.Migrate/Resume-AzMigrateServerReplication.md new file mode 100644 index 0000000000..a5aa3b3088 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Resume-AzMigrateServerReplication.md @@ -0,0 +1,230 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/resume-azmigrateserverreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Resume-AzMigrateServerReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Resume-AzMigrateServerReplication.md +--- + +# Resume-AzMigrateServerReplication + +## SYNOPSIS +Starts the replication that has been suspended. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Resume-AzMigrateServerReplication -TargetObjectID <String> [-DeleteMigratedResource] + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ByInputObjectVMwareCbt +``` +Resume-AzMigrateServerReplication -InputObject <IMigrationItem> [-DeleteMigratedResource] + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The Resume-AzMigrateServerReplication starts the replication that has been suspended. + +## EXAMPLES + +### Example 1: By machine id. +```powershell +Resume-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxxxxx-xxx-xxx/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoffccyapp3352vault/replicationFabrics/signoffccyappae52replicationfabric/replicationProtectionContainers/signoffccyappae52replicationcontainer/replicationMigrationItems/idclab-vcen67-fareast-corp-micr-0f144e99-ba36-4649-b92b-8b06854aa539_5015f6d8-fc84-afdf-de47-1eab79330f00" +``` + +```output +ActivityId : 0b810233-b0aa-4a4c-a44e-bea4589c0513 ActivityId: ccb4889b-b9ec-4a76-af4d-4eb59c76ebac +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : +Id : /Subscriptions/xxx-xxx-xxxxxx-xxx-xxx/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff + ccyapp3352vault/replicationJobs/75a6945d-2276-4dbb-926c-d0745e004130 +Location : +Name : 75a6945d-2276-4dbb-926c-d0745e004130 +ScenarioName : +StartTime : +State : NotStarted +StateDescription : NotStarted +TargetInstanceType : ProtectionEntity +TargetObjectId : +TargetObjectName : +Task : {} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By machine id. + +### Example 2: By input object +```powershell +$obj = Get-AzMigrateServerReplication -ProjectName "signoffccyproj" -ResourceGroupName "cbtsignoff2201rg" -MachineName "Win2k16" +Resume-AzMigrateServerReplication -InputObject $obj +``` + +```output +ActivityId : 0b810233-b0aa-4a4c-a44e-bea4589c0513 ActivityId: ccb4889b-b9ec-4a76-af4d-4eb59c76ebac +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : +Id : /Subscriptions/xxx-xxx-xxxxxx-xxx-xxx/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff + ccyapp3352vault/replicationJobs/75a6945d-2276-4dbb-926c-d0745e004130 +Location : +Name : 75a6945d-2276-4dbb-926c-d0745e004130 +ScenarioName : +StartTime : +State : NotStarted +StateDescription : NotStarted +TargetInstanceType : ProtectionEntity +TargetObjectId : +TargetObjectName : +Task : {} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By input object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteMigratedResource +Specifies whether the migrated resources needs to be deleted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the replicating server for which the resume replication needs to be initiated. +The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replicating server for which the resume replication needs to be initiated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IJob + +## 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 <IMigrationItem>`: Specifies the replicating server for which the resume replication needs to be initiated. The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet + - `[Location <String>]`: Resource Location + - `[ProviderSpecificDetail <IMigrationProviderSpecificSettings>]`: The migration provider custom settings. + - `InstanceType <String>`: Gets the instance type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Set-AzMigrateDiskMapping.md b/azps-10.1.0/Az.Migrate/Set-AzMigrateDiskMapping.md new file mode 100644 index 0000000000..5c397149af --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Set-AzMigrateDiskMapping.md @@ -0,0 +1,100 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/set-azmigratediskmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Set-AzMigrateDiskMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Set-AzMigrateDiskMapping.md +--- + +# Set-AzMigrateDiskMapping + +## SYNOPSIS +Updates disk mapping + +## SYNTAX + +``` +Set-AzMigrateDiskMapping -DiskID <String> [-DiskName <String>] [-IsOSDisk <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzMigrateDiskMapping cmdlet updates a mapping of the source disk attached to the server to be migrated + +## EXAMPLES + +### Example 1: Make disks +```powershell +Set-AzMigrateDiskMapping -DiskID "6000C294-1217-dec3-bc18-81f117220424" -DiskName "ContosoDisk_1" -IsOSDisk "True" +``` + +```output +DiskId IsOSDisk TargetDiskName +------ -------- -------------- +6000C294-1217-dec3-bc18-81f117220424 True ContosoDisk_1 +``` + +Get disks object to provide input for Set-AzMigrateServerReplication + +## PARAMETERS + +### -DiskID +Specifies the disk ID of the disk attached to the discovered server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskName +Specifies the name of the managed disk to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsOSDisk +Specifies whether the disk contains the Operating System for the source server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtUpdateDiskInput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Set-AzMigrateServerReplication.md b/azps-10.1.0/Az.Migrate/Set-AzMigrateServerReplication.md new file mode 100644 index 0000000000..d315da5062 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Set-AzMigrateServerReplication.md @@ -0,0 +1,534 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/set-azmigrateserverreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Set-AzMigrateServerReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Set-AzMigrateServerReplication.md +--- + +# Set-AzMigrateServerReplication + +## SYNOPSIS +Updates the target properties for the replicating server. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Set-AzMigrateServerReplication -TargetObjectID <String> [-DiskToUpdate <IVMwareCbtUpdateDiskInput[]>] + [-NicToUpdate <IVMwareCbtNicInput[]>] [-SqlServerLicenseType <String>] [-SubscriptionId <String>] + [-TargetAvailabilitySet <String>] [-TargetAvailabilityZone <String>] + [-TargetBootDiagnosticsStorageAccount <String>] [-TargetDiskName <String>] [-TargetNetworkId <String>] + [-TargetResourceGroupID <String>] [-TargetVMName <String>] [-TargetVMSize <String>] [-TestNetworkId <String>] + [-UpdateDiskTag <IVMwareCbtEnableMigrationInputTargetDiskTags>] [-UpdateDiskTagOperation <String>] + [-UpdateNicTag <IVMwareCbtEnableMigrationInputTargetNicTags>] [-UpdateNicTagOperation <String>] + [-UpdateTag <Hashtable>] [-UpdateTagOperation <String>] + [-UpdateVMTag <IVMwareCbtEnableMigrationInputTargetVmtags>] [-UpdateVMTagOperation <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ByInputObjectVMwareCbt +``` +Set-AzMigrateServerReplication -InputObject <IMigrationItem> [-DiskToUpdate <IVMwareCbtUpdateDiskInput[]>] + [-NicToUpdate <IVMwareCbtNicInput[]>] [-SqlServerLicenseType <String>] [-SubscriptionId <String>] + [-TargetAvailabilitySet <String>] [-TargetAvailabilityZone <String>] + [-TargetBootDiagnosticsStorageAccount <String>] [-TargetDiskName <String>] [-TargetNetworkId <String>] + [-TargetResourceGroupID <String>] [-TargetVMName <String>] [-TargetVMSize <String>] [-TestNetworkId <String>] + [-UpdateDiskTag <IVMwareCbtEnableMigrationInputTargetDiskTags>] [-UpdateDiskTagOperation <String>] + [-UpdateNicTag <IVMwareCbtEnableMigrationInputTargetNicTags>] [-UpdateNicTagOperation <String>] + [-UpdateTag <Hashtable>] [-UpdateTagOperation <String>] + [-UpdateVMTag <IVMwareCbtEnableMigrationInputTargetVmtags>] [-UpdateVMTagOperation <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzMigrateServerReplication cmdlet updates the target properties for the replicating server. + +## EXAMPLES + +### Example 1: Update by id +```powershell +Set-AzMigrateServerReplication -TargetObjectID '/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629' -TargetVMName 'rb-w2k12r2-1' +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Update +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : Update +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By id. + +### Example 2: Update multiple disk names by id +```powershell +$OSDisk = Set-AzMigrateDiskMapping -DiskID "6000C294-1217-dec3-bc18-81f117220424" -DiskName "ContosoDisk_1" +$DataDisk = Set-AzMigrateDiskMapping -DiskID "6000C292-79b9-bbdc-fb8a-f1fa8dbeff84" -DiskName "ContosoDisk_2" +$DiskMapping = $OSDisk, $DataDisk +Set-AzMigrateServerReplication -TargetObjectId "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2105srcrg/providers/Microsoft.RecoveryServices/vaults/signoff2105app1452vault/replicationFabrics/signoff2105app1c36replicationfabric/replicationProtectionContainers/signoff2105app1c36replicationcontainer/replicationMigrationItems/idclab-vcen67-fareast-corp-micr-6f5e3b29-29ad-4e62-abbd-6cd33c4183ef_5015f6d8-fc84-afdf-de47-1eab79330f00" -DiskToUpdate $DiskMapping +``` + +```output +ActivityId : c533d88d-2211-43c6-b615-7b46876d8882 ActivityId: de18df8b-8d43-4249-8989-846d33a124f6 +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210210.JobDetailsAffectedObje + ctDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Update the virtual machine +Id : /Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2105src + rg/providers/Microsoft.RecoveryServices/vaults/signoff2105app1452vault/replicationJo + bs/6ec1cca6-87c7-4f14-9657-bd0469c02fcd +Location : +Name : 6ec1cca6-87c7-4f14-9657-bd0469c02fcd +ScenarioName : UpdateVmProperties +StartTime : 8/30/2021 7:08:51 AM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : f3aa6bd4-1b60-52bb-b12d-e850f8d8f13c +TargetObjectName : Win2k16 +Task : {UpdateVmPropertiesTask} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +Updating disk name by id. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskToUpdate +Updates the disk for the Azure VM to be created. +To construct, see NOTES section for DISKTOUPDATE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtUpdateDiskInput[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the replicating server for which the properties need to be updated. +The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NicToUpdate +Updates the NIC for the Azure VM to be created. +To construct, see NOTES section for NICTOUPDATE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtNicInput[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlServerLicenseType +Specifies if Azure Hybrid benefit for SQL Server is applicable for the server to be migrated. + +```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 subscription Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetAvailabilitySet +Specifies the Availability Set to be used for VM creation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetAvailabilityZone +Specifies the Availability Zone to be used for VM creation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetBootDiagnosticsStorageAccount +Specifies the storage account to be used for boot diagnostics. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDiskName +Specifies the name of the Azure VM to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNetworkId +Updates the Virtual Network id within the destination Azure subscription to which the server needs to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replcating server for which the properties need to be updated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupID +Updates the Resource Group id within the destination Azure subscription to which the server needs to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMName +Specifies the replcating server for which the properties need to be updated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMSize +Updates the SKU of the Azure VM to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNetworkId +Updates the Virtual Network id within the destination Azure subscription to which the server needs to be test migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateDiskTag +Specifies the tag to be used for disk creation. +To construct, see NOTES section for UPDATEDISKTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtEnableMigrationInputTargetDiskTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateDiskTagOperation +Specifies update disk tag operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateNicTag +Specifies the tag to be used for NIC creation. +To construct, see NOTES section for UPDATENICTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtEnableMigrationInputTargetNicTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateNicTagOperation +Specifies update NIC tag operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTag +Specifies the tag to be used for Resource creation. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTagOperation +Specifies update tag operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateVMTag +Specifies the tag to be used for VM creation. +To construct, see NOTES section for UPDATEVMTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtEnableMigrationInputTargetVmtags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateVMTagOperation +Specifies update VM tag operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IJob + +## 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. + + +`DISKTOUPDATE <IVMwareCbtUpdateDiskInput[]>`: Updates the disk for the Azure VM to be created. + - `DiskId <String>`: The disk Id. + - `[IsOSDisk <String>]`: A value indicating whether the disk is the OS disk. + - `[TargetDiskName <String>]`: The target disk name. + +`INPUTOBJECT <IMigrationItem>`: Specifies the replicating server for which the properties need to be updated. The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet. + - `[Location <String>]`: Resource Location + - `[ProviderSpecificDetail <IMigrationProviderSpecificSettings>]`: The migration provider custom settings. + - `InstanceType <String>`: Gets the instance type. + +`NICTOUPDATE <IVMwareCbtNicInput[]>`: Updates the NIC for the Azure VM to be created. + - `IsPrimaryNic <String>`: A value indicating whether this is the primary NIC. + - `NicId <String>`: The NIC Id. + - `[IsSelectedForMigration <String>]`: A value indicating whether this NIC is selected for migration. + - `[TargetNicName <String>]`: Target NIC name. + - `[TargetStaticIPAddress <String>]`: The static IP address. + - `[TargetSubnetName <String>]`: Target subnet name. + - `[TestStaticIPAddress <String>]`: The test static IP address. + - `[TestSubnetName <String>]`: The test subnet name. + +`UPDATEDISKTAG <IVMwareCbtEnableMigrationInputTargetDiskTags>`: Specifies the tag to be used for disk creation. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +`UPDATENICTAG <IVMwareCbtEnableMigrationInputTargetNicTags>`: Specifies the tag to be used for NIC creation. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +`UPDATEVMTAG <IVMwareCbtEnableMigrationInputTargetVmtags>`: Specifies the tag to be used for VM creation. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Start-AzMigrateServerMigration.md b/azps-10.1.0/Az.Migrate/Start-AzMigrateServerMigration.md new file mode 100644 index 0000000000..a7f9db40ac --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Start-AzMigrateServerMigration.md @@ -0,0 +1,184 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/start-azmigrateservermigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Start-AzMigrateServerMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Start-AzMigrateServerMigration.md +--- + +# Start-AzMigrateServerMigration + +## SYNOPSIS +Starts the migration for the replicating server. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Start-AzMigrateServerMigration -TargetObjectID <String> [-OsUpgradeVersion <String>] + [-SubscriptionId <String>] [-TurnOffSourceServer] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ByInputObjectVMwareCbt +``` +Start-AzMigrateServerMigration -InputObject <IMigrationItem> [-OsUpgradeVersion <String>] + [-SubscriptionId <String>] [-TurnOffSourceServer] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Starts the migration for the replicating server. + +## EXAMPLES + +### Example 1: By id +```powershell +Start-AzMigrateServerMigration -TargetObjectID "/Subscriptions/7xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_52f42ee7-8eb3-1aa4-e2d5-1ae83f86b085" +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Migrate +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : Migrate +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By id + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the replicating server for which migration needs to be initiated. +The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsUpgradeVersion +Specifies the target version to which the Os has to be upgraded to. +The valid values can be selected from SupportedOSVersions retrieved using Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replcating server for which migration needs to be initiated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TurnOffSourceServer +Specifies whether the source server should be turned off post migration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IJob + +## 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 <IMigrationItem>`: Specifies the replicating server for which migration needs to be initiated. The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet. + - `[Location <String>]`: Resource Location + - `[ProviderSpecificDetail <IMigrationProviderSpecificSettings>]`: The migration provider custom settings. + - `InstanceType <String>`: Gets the instance type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Start-AzMigrateTestMigration.md b/azps-10.1.0/Az.Migrate/Start-AzMigrateTestMigration.md new file mode 100644 index 0000000000..3da601914c --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Start-AzMigrateTestMigration.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/start-azmigratetestmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Start-AzMigrateTestMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Start-AzMigrateTestMigration.md +--- + +# Start-AzMigrateTestMigration + +## SYNOPSIS +Starts the test migration for the replicating server. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Start-AzMigrateTestMigration -TargetObjectID <String> -TestNetworkID <String> + [-NicToUpdate <IVMwareCbtNicInput[]>] [-OsUpgradeVersion <String>] [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ByInputObjectVMwareCbt +``` +Start-AzMigrateTestMigration -InputObject <IMigrationItem> -TestNetworkID <String> + [-NicToUpdate <IVMwareCbtNicInput[]>] [-OsUpgradeVersion <String>] [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +The Start-AzMigrateTestMigration cmdlet initiates the test migration for the replicating server. + +## EXAMPLES + +### Example 1: By machine id. +```powershell +Start-AzMigrateTestMigration -TargetObjectID '/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f' -TestNetworkId '/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork' +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Test Migrate +Id : /Subscriptions/xxx-xxx-xxxresourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : TestMigrate +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs + +``` + +By machine id. + +### Example 2: By input object +```powershell +$obj = Get-AzMigrateServerReplication -TargetObjectID $env.srsMachineId -SubscriptionId $env.srsSubscriptionId +Start-AzMigrateTestMigration -InputObject $obj -TestNetworkId '/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork' +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Test Migrate +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : TestMigrate +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs + +``` + +By input object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the replicating server for which the test migration needs to be initiated. +The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NicToUpdate +Updates the NIC for the Azure VM to be created. +To construct, see NOTES section for NICTOUPDATE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IVMwareCbtNicInput[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsUpgradeVersion +Specifies the target version to which the Os has to be upgraded to. +The valid values can be selected from SupportedOSVersions retrieved using Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replicating server for which the test migration needs to be initiated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNetworkID +Updates the Virtual Network id within the destination Azure subscription to be used for test migration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IJob + +## 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 <IMigrationItem>`: Specifies the replicating server for which the test migration needs to be initiated. The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet. + - `[Location <String>]`: Resource Location + - `[ProviderSpecificDetail <IMigrationProviderSpecificSettings>]`: The migration provider custom settings. + - `InstanceType <String>`: Gets the instance type. + +`NICTOUPDATE <IVMwareCbtNicInput[]>`: Updates the NIC for the Azure VM to be created. + - `IsPrimaryNic <String>`: A value indicating whether this is the primary NIC. + - `NicId <String>`: The NIC Id. + - `[IsSelectedForMigration <String>]`: A value indicating whether this NIC is selected for migration. + - `[TargetNicName <String>]`: Target NIC name. + - `[TargetStaticIPAddress <String>]`: The static IP address. + - `[TargetSubnetName <String>]`: Target subnet name. + - `[TestStaticIPAddress <String>]`: The test static IP address. + - `[TestSubnetName <String>]`: The test subnet name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Start-AzMigrateTestMigrationCleanup.md b/azps-10.1.0/Az.Migrate/Start-AzMigrateTestMigrationCleanup.md new file mode 100644 index 0000000000..b4770111f7 --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Start-AzMigrateTestMigrationCleanup.md @@ -0,0 +1,188 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/start-azmigratetestmigrationcleanup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Start-AzMigrateTestMigrationCleanup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Start-AzMigrateTestMigrationCleanup.md +--- + +# Start-AzMigrateTestMigrationCleanup + +## SYNOPSIS +Cleans up the test migration for the replicating server. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Start-AzMigrateTestMigrationCleanup -TargetObjectID <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ByInputObjectVMwareCbt +``` +Start-AzMigrateTestMigrationCleanup -InputObject <IMigrationItem> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +The Start-AzMigrateTestMigrationCleanup cmdlet initiates the clean up of the test migration for the replicating server. + +## EXAMPLES + +### Example 1: By machine id. +```powershell +Start-AzMigrateTestMigrationCleanup -TargetObjectID '/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f' +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Test Migrate Cleanup +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : TestMigrateCleanup +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs + +``` + +By machine id. + +### Example 2: By input object +```powershell +$obj = Get-AzMigrateServerReplication -TargetObjectID $env.srsMachineId -SubscriptionId $env.srsSubscriptionId +Start-AzMigrateTestMigrationCleanup -InputObject $ob +``` + +```output +AllowedOperation : {DisableMigration, TestMigrate, Migrate} + +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Test Migrate Cleanup +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : TestMigrateCleanup +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs + +``` + +By input object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the replicating server for which the test migration cleanup needs to be initiated. +The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replicating server for which the test migration cleanup needs to be initiated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IJob + +## 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 <IMigrationItem>`: Specifies the replicating server for which the test migration cleanup needs to be initiated. The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet + - `[Location <String>]`: Resource Location + - `[ProviderSpecificDetail <IMigrationProviderSpecificSettings>]`: The migration provider custom settings. + - `InstanceType <String>`: Gets the instance type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Migrate/Suspend-AzMigrateServerReplication.md b/azps-10.1.0/Az.Migrate/Suspend-AzMigrateServerReplication.md new file mode 100644 index 0000000000..1dc3345d6b --- /dev/null +++ b/azps-10.1.0/Az.Migrate/Suspend-AzMigrateServerReplication.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/suspend-azmigrateserverreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Suspend-AzMigrateServerReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Migrate/help/Suspend-AzMigrateServerReplication.md +--- + +# Suspend-AzMigrateServerReplication + +## SYNOPSIS +Suspends the ongoing replication. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Suspend-AzMigrateServerReplication -TargetObjectID <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ByInputObjectVMwareCbt +``` +Suspend-AzMigrateServerReplication -InputObject <IMigrationItem> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +The Suspend-AzMigrateServerReplication suspends the ongoing replication. + +## EXAMPLES + +### Example 1: By machine id. +```powershell +Suspend-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxxxxx-xxx-xxx/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoffccyapp3352vault/replicationFabrics/signoffccyappae52replicationfabric/replicationProtectionContainers/signoffccyappae52replicationcontainer/replicationMigrationItems/idclab-vcen67-fareast-corp-micr-0f144e99-ba36-4649-b92b-8b06854aa539_5015f6d8-fc84-afdf-de47-1eab79330f00" +``` + +```output +ActivityId : da61a495-48b7-40df-a251-f23f491b2566 ActivityId: e16e0301-be13-4c35-8242-1451cb057994 +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Pause replication +Id : /Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff + ccyapp3352vault/replicationJobs/6ded7417-b939-4c30-b622-d80a63865025 +Location : +Name : 6ded7417-b939-4c30-b622-d80a63865025 +ScenarioName : PauseReplication +StartTime : 9/25/2022 9:10:42 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 52896ea4-214d-5825-bc32-24169dfcc44c +TargetObjectName : Win2k16 +Task : {PauseReplicationPreflightChecksTask, PauseReplicationTask} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By machine id. + +### Example 2: By input object +```powershell +$obj = Get-AzMigrateServerReplication -ProjectName "signoffccyproj" -ResourceGroupName "cbtsignoff2201rg" -MachineName "Win2k16" +Suspend-AzMigrateServerReplication -InputObject $obj +``` + +```output +ActivityId : da61a495-48b7-40df-a251-f23f491b2566 ActivityId: e16e0301-be13-4c35-8242-1451cb057994 +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Pause replication +Id : /Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff + ccyapp3352vault/replicationJobs/6ded7417-b939-4c30-b622-d80a63865025 +Location : +Name : 6ded7417-b939-4c30-b622-d80a63865025 +ScenarioName : PauseReplication +StartTime : 9/25/2022 9:10:42 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 52896ea4-214d-5825-bc32-24169dfcc44c +TargetObjectName : Win2k16 +Task : {PauseReplicationPreflightChecksTask, PauseReplicationTask} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By input object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the replicating server for which the suspend replication needs to be initiated. +The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replicating server for which the suspend replication needs to be initiated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.IJob + +## 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 <IMigrationItem>`: Specifies the replicating server for which the suspend replication needs to be initiated. The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet + - `[Location <String>]`: Resource Location + - `[ProviderSpecificDetail <IMigrationProviderSpecificSettings>]`: The migration provider custom settings. + - `InstanceType <String>`: Gets the instance type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/Az.MixedReality.md b/azps-10.1.0/Az.MixedReality/Az.MixedReality.md new file mode 100644 index 0000000000..26500f2e24 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Az.MixedReality.md @@ -0,0 +1,72 @@ +--- +Module Name: Az.MixedReality +Module Guid: 4bdb5e8a-54be-4080-8f73-9c4e31acf7c7 +Download Help Link: https://learn.microsoft.com/powershell/module/az.mixedreality +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Az.MixedReality.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Az.MixedReality.md +--- + +# Az.MixedReality Module +## Description +Microsoft Azure PowerShell: MixedReality cmdlets + +## Az.MixedReality Cmdlets +### [Get-AzMixedRealityObjectAnchorsAccount](Get-AzMixedRealityObjectAnchorsAccount.md) +Retrieve an Object Anchors Account. + +### [Get-AzMixedRealityObjectAnchorsAccountKey](Get-AzMixedRealityObjectAnchorsAccountKey.md) +List Both of the 2 Keys of an object anchors Account + +### [Get-AzMixedRealityRemoteRenderingAccount](Get-AzMixedRealityRemoteRenderingAccount.md) +Retrieve a Remote Rendering Account. + +### [Get-AzMixedRealityRemoteRenderingAccountKey](Get-AzMixedRealityRemoteRenderingAccountKey.md) +List Both of the 2 Keys of a Remote Rendering Account + +### [Get-AzMixedRealitySpatialAnchorsAccount](Get-AzMixedRealitySpatialAnchorsAccount.md) +Retrieve a Spatial Anchors Account. + +### [Get-AzMixedRealitySpatialAnchorsAccountKey](Get-AzMixedRealitySpatialAnchorsAccountKey.md) +List Both of the 2 Keys of a Spatial Anchors Account + +### [New-AzMixedRealityObjectAnchorsAccount](New-AzMixedRealityObjectAnchorsAccount.md) +Creating or Updating an object anchors Account. + +### [New-AzMixedRealityObjectAnchorsAccountKey](New-AzMixedRealityObjectAnchorsAccountKey.md) +Regenerate specified Key of an object anchors Account + +### [New-AzMixedRealityRemoteRenderingAccount](New-AzMixedRealityRemoteRenderingAccount.md) +Creating or Updating a Remote Rendering Account. + +### [New-AzMixedRealityRemoteRenderingAccountKey](New-AzMixedRealityRemoteRenderingAccountKey.md) +Regenerate specified Key of a Remote Rendering Account + +### [New-AzMixedRealitySpatialAnchorsAccount](New-AzMixedRealitySpatialAnchorsAccount.md) +Creating or Updating a Spatial Anchors Account. + +### [New-AzMixedRealitySpatialAnchorsAccountKey](New-AzMixedRealitySpatialAnchorsAccountKey.md) +Regenerate specified Key of a Spatial Anchors Account + +### [Remove-AzMixedRealityObjectAnchorsAccount](Remove-AzMixedRealityObjectAnchorsAccount.md) +Delete an Object Anchors Account. + +### [Remove-AzMixedRealityRemoteRenderingAccount](Remove-AzMixedRealityRemoteRenderingAccount.md) +Delete a Remote Rendering Account. + +### [Remove-AzMixedRealitySpatialAnchorsAccount](Remove-AzMixedRealitySpatialAnchorsAccount.md) +Delete a Spatial Anchors Account. + +### [Test-AzMixedRealityNameAvailability](Test-AzMixedRealityNameAvailability.md) +Check Name Availability for local uniqueness + +### [Update-AzMixedRealityObjectAnchorsAccount](Update-AzMixedRealityObjectAnchorsAccount.md) +Updating an Object Anchors Account + +### [Update-AzMixedRealityRemoteRenderingAccount](Update-AzMixedRealityRemoteRenderingAccount.md) +Updating a Remote Rendering Account + +### [Update-AzMixedRealitySpatialAnchorsAccount](Update-AzMixedRealitySpatialAnchorsAccount.md) +Updating a Spatial Anchors Account + diff --git a/azps-10.1.0/Az.MixedReality/Get-AzMixedRealityObjectAnchorsAccount.md b/azps-10.1.0/Az.MixedReality/Get-AzMixedRealityObjectAnchorsAccount.md new file mode 100644 index 0000000000..ea776d2589 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Get-AzMixedRealityObjectAnchorsAccount.md @@ -0,0 +1,193 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/get-azmixedrealityobjectanchorsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Get-AzMixedRealityObjectAnchorsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Get-AzMixedRealityObjectAnchorsAccount.md +--- + +# Get-AzMixedRealityObjectAnchorsAccount + +## SYNOPSIS +Retrieve an Object Anchors Account. + +## SYNTAX + +### List (Default) +``` +Get-AzMixedRealityObjectAnchorsAccount [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzMixedRealityObjectAnchorsAccount -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMixedRealityObjectAnchorsAccount -InputObject <IMixedRealityIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzMixedRealityObjectAnchorsAccount -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve an Object Anchors Account. + +## EXAMPLES + +### Example 1: List Object Anchors Accounts by Subscription. +```powershell +Get-AzMixedRealityObjectAnchorsAccount +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpstestanchorsaccount-object azps_test_group +``` + +List Object Anchors Accounts by Subscription. + +### Example 2: List Object Anchors Accounts by Resource Group. +```powershell +Get-AzMixedRealityObjectAnchorsAccount -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpstestanchorsaccount-object azps_test_group +``` + +List Object Anchors Accounts by Resource Group. + +### Example 3: Retrieve an Object Anchors Account. +```powershell +Get-AzMixedRealityObjectAnchorsAccount -Name azpstestanchorsaccount-object -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpstestanchorsaccount-object azps_test_group +``` + +Retrieve an Object Anchors Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.IObjectAnchorsAccount + +## 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 <IMixedRealityIdentity>`: Identity Parameter + - `[AccountName <String>]`: Name of an Mixed Reality Account. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: Name of an Azure resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/Get-AzMixedRealityObjectAnchorsAccountKey.md b/azps-10.1.0/Az.MixedReality/Get-AzMixedRealityObjectAnchorsAccountKey.md new file mode 100644 index 0000000000..72e95f925d --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Get-AzMixedRealityObjectAnchorsAccountKey.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/get-azmixedrealityobjectanchorsaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Get-AzMixedRealityObjectAnchorsAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Get-AzMixedRealityObjectAnchorsAccountKey.md +--- + +# Get-AzMixedRealityObjectAnchorsAccountKey + +## SYNOPSIS +List Both of the 2 Keys of an object anchors Account + +## SYNTAX + +``` +Get-AzMixedRealityObjectAnchorsAccountKey -AccountName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List Both of the 2 Keys of an object anchors Account + +## EXAMPLES + +### Example 1: List Both of the 2 Keys of an object anchors Account. +```powershell +Get-AzMixedRealityObjectAnchorsAccountKey -AccountName azpstestanchorsaccount-object -ResourceGroupName azps_test_group +``` + +```output +PrimaryKey SecondaryKey +---------- ------------ +7N9FGZT/5******PhlS1e8= fO/rmry******+mP5VJCZS4s= +``` + +List Both of the 2 Keys of an object anchors Account. + +## PARAMETERS + +### -AccountName +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.IAccountKeys + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/Get-AzMixedRealityRemoteRenderingAccount.md b/azps-10.1.0/Az.MixedReality/Get-AzMixedRealityRemoteRenderingAccount.md new file mode 100644 index 0000000000..0197fb0942 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Get-AzMixedRealityRemoteRenderingAccount.md @@ -0,0 +1,193 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/get-azmixedrealityremoterenderingaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Get-AzMixedRealityRemoteRenderingAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Get-AzMixedRealityRemoteRenderingAccount.md +--- + +# Get-AzMixedRealityRemoteRenderingAccount + +## SYNOPSIS +Retrieve a Remote Rendering Account. + +## SYNTAX + +### List (Default) +``` +Get-AzMixedRealityRemoteRenderingAccount [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzMixedRealityRemoteRenderingAccount -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMixedRealityRemoteRenderingAccount -InputObject <IMixedRealityIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzMixedRealityRemoteRenderingAccount -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve a Remote Rendering Account. + +## EXAMPLES + +### Example 1: List Remote Rendering Account by Subscription. +```powershell +Get-AzMixedRealityRemoteRenderingAccount +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstestrenderingaccount azps_test_group +``` + +List Remote Rendering Account by Subscription. + +### Example 2: List Remote Rendering Account by Resource Group. +```powershell +Get-AzMixedRealityRemoteRenderingAccount -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstestrenderingaccount azps_test_group +``` + +List Remote Rendering Account by Resource Group. + +### Example 3: Get a Remote Rendering Account. +```powershell +Get-AzMixedRealityRemoteRenderingAccount -ResourceGroupName azps_test_group -Name azpstestrenderingaccount +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstestrenderingaccount azps_test_group +``` + +Get a Remote Rendering Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.IRemoteRenderingAccount + +## 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 <IMixedRealityIdentity>`: Identity Parameter + - `[AccountName <String>]`: Name of an Mixed Reality Account. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: Name of an Azure resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/Get-AzMixedRealityRemoteRenderingAccountKey.md b/azps-10.1.0/Az.MixedReality/Get-AzMixedRealityRemoteRenderingAccountKey.md new file mode 100644 index 0000000000..4184c14ef4 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Get-AzMixedRealityRemoteRenderingAccountKey.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/get-azmixedrealityremoterenderingaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Get-AzMixedRealityRemoteRenderingAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Get-AzMixedRealityRemoteRenderingAccountKey.md +--- + +# Get-AzMixedRealityRemoteRenderingAccountKey + +## SYNOPSIS +List Both of the 2 Keys of a Remote Rendering Account + +## SYNTAX + +``` +Get-AzMixedRealityRemoteRenderingAccountKey -AccountName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List Both of the 2 Keys of a Remote Rendering Account + +## EXAMPLES + +### Example 1: List Both of the 2 Keys of a Remote Rendering Account. +```powershell +Get-AzMixedRealityRemoteRenderingAccountKey -AccountName azpstestrenderingaccount -ResourceGroupName azps_test_group +``` + +```output +PrimaryKey SecondaryKey +---------- ------------ +H9BrXT******8QJ3S/cIzE= VOR11nS******RtYevu5U5fTHM= +``` + +List Both of the 2 Keys of a Remote Rendering Account. + +## PARAMETERS + +### -AccountName +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.IAccountKeys + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/Get-AzMixedRealitySpatialAnchorsAccount.md b/azps-10.1.0/Az.MixedReality/Get-AzMixedRealitySpatialAnchorsAccount.md new file mode 100644 index 0000000000..c8f98b8914 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Get-AzMixedRealitySpatialAnchorsAccount.md @@ -0,0 +1,193 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/get-azmixedrealityspatialanchorsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Get-AzMixedRealitySpatialAnchorsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Get-AzMixedRealitySpatialAnchorsAccount.md +--- + +# Get-AzMixedRealitySpatialAnchorsAccount + +## SYNOPSIS +Retrieve a Spatial Anchors Account. + +## SYNTAX + +### List (Default) +``` +Get-AzMixedRealitySpatialAnchorsAccount [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzMixedRealitySpatialAnchorsAccount -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMixedRealitySpatialAnchorsAccount -InputObject <IMixedRealityIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzMixedRealitySpatialAnchorsAccount -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve a Spatial Anchors Account. + +## EXAMPLES + +### Example 1: List Spatial Anchors Accounts by Subscription. +```powershell +Get-AzMixedRealitySpatialAnchorsAccount +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstestanchorsaccount azps_test_group +``` + +List Spatial Anchors Accounts by Subscription. + +### Example 2: List Spatial Anchors Accounts by Resource Group. +```powershell +Get-AzMixedRealitySpatialAnchorsAccount -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstestanchorsaccount azps_test_group +``` + +List Spatial Anchors Accounts by Resource Group. + +### Example 3: Retrieve a Spatial Anchors Account. +```powershell +Get-AzMixedRealitySpatialAnchorsAccount -Name azpstestanchorsaccount -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstestanchorsaccount azps_test_group +``` + +Retrieve a Spatial Anchors Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.ISpatialAnchorsAccount + +## 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 <IMixedRealityIdentity>`: Identity Parameter + - `[AccountName <String>]`: Name of an Mixed Reality Account. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: Name of an Azure resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/Get-AzMixedRealitySpatialAnchorsAccountKey.md b/azps-10.1.0/Az.MixedReality/Get-AzMixedRealitySpatialAnchorsAccountKey.md new file mode 100644 index 0000000000..b1d8ce711d --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Get-AzMixedRealitySpatialAnchorsAccountKey.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/get-azmixedrealityspatialanchorsaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Get-AzMixedRealitySpatialAnchorsAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Get-AzMixedRealitySpatialAnchorsAccountKey.md +--- + +# Get-AzMixedRealitySpatialAnchorsAccountKey + +## SYNOPSIS +List Both of the 2 Keys of a Spatial Anchors Account + +## SYNTAX + +``` +Get-AzMixedRealitySpatialAnchorsAccountKey -AccountName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List Both of the 2 Keys of a Spatial Anchors Account + +## EXAMPLES + +### Example 1: List Both of the 2 Keys of a Spatial Anchors Account. +```powershell +Get-AzMixedRealitySpatialAnchorsAccountKey -AccountName azpstestanchorsaccount -ResourceGroupName azps_test_group +``` + +```output +PrimaryKey SecondaryKey +---------- ------------ +OAocrh+K******8VRRO/I= froxBip******KVs6tqyPA= +``` + +List Both of the 2 Keys of a Spatial Anchors Account. + +## PARAMETERS + +### -AccountName +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.IAccountKeys + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/New-AzMixedRealityObjectAnchorsAccount.md b/azps-10.1.0/Az.MixedReality/New-AzMixedRealityObjectAnchorsAccount.md new file mode 100644 index 0000000000..5a004d0abd --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/New-AzMixedRealityObjectAnchorsAccount.md @@ -0,0 +1,386 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/new-azmixedrealityobjectanchorsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/New-AzMixedRealityObjectAnchorsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/New-AzMixedRealityObjectAnchorsAccount.md +--- + +# New-AzMixedRealityObjectAnchorsAccount + +## SYNOPSIS +Creating or Updating an object anchors Account. + +## SYNTAX + +``` +New-AzMixedRealityObjectAnchorsAccount -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-IdentityType <ResourceIdentityType>] [-KindCapacity <Int32>] + [-KindFamily <String>] [-KindName <String>] [-KindSize <String>] [-KindTier <SkuTier>] + [-PlanType <ResourceIdentityType>] [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] + [-SkuSize <String>] [-SkuTier <SkuTier>] [-StorageAccountName <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creating or Updating an object anchors Account. + +## EXAMPLES + +### Example 1: Creating or Updating an object anchors Account. +```powershell +New-AzMixedRealityObjectAnchorsAccount -Name azpstestanchorsaccount-object -ResourceGroupName azps_test_group -Location eastus2 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpstestanchorsaccount-object azps_test_group +``` + +Creating or Updating an object anchors Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account associated with this accountId + +```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 Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.IObjectAnchorsAccount + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/New-AzMixedRealityObjectAnchorsAccountKey.md b/azps-10.1.0/Az.MixedReality/New-AzMixedRealityObjectAnchorsAccountKey.md new file mode 100644 index 0000000000..8c9e591bde --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/New-AzMixedRealityObjectAnchorsAccountKey.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/new-azmixedrealityobjectanchorsaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/New-AzMixedRealityObjectAnchorsAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/New-AzMixedRealityObjectAnchorsAccountKey.md +--- + +# New-AzMixedRealityObjectAnchorsAccountKey + +## SYNOPSIS +Regenerate specified Key of an object anchors Account + +## SYNTAX + +### RegenerateExpanded (Default) +``` +New-AzMixedRealityObjectAnchorsAccountKey -AccountName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Serial <Int32>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### RegenerateViaIdentityExpanded +``` +New-AzMixedRealityObjectAnchorsAccountKey -InputObject <IMixedRealityIdentity> [-Serial <Int32>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerate specified Key of an object anchors Account + +## EXAMPLES + +### Example 1: Regenerate specified Key of an object anchors Account. +```powershell +New-AzMixedRealityObjectAnchorsAccountKey -AccountName azpstestanchorsaccount-object -ResourceGroupName azps_test_group -Serial 1 +``` + +```output +PrimaryKey SecondaryKey +---------- ------------ +7N9FGZT/5******PhlS1e8= fO/rmry******+mP5VJCZS4s= +``` + +Regenerate specified Key of an object anchors Account. + +## PARAMETERS + +### -AccountName +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity +Parameter Sets: RegenerateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Serial +. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.IAccountKeys + +## 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 <IMixedRealityIdentity>`: Identity Parameter + - `[AccountName <String>]`: Name of an Mixed Reality Account. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: Name of an Azure resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/New-AzMixedRealityRemoteRenderingAccount.md b/azps-10.1.0/Az.MixedReality/New-AzMixedRealityRemoteRenderingAccount.md new file mode 100644 index 0000000000..10797f01bc --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/New-AzMixedRealityRemoteRenderingAccount.md @@ -0,0 +1,386 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/new-azmixedrealityremoterenderingaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/New-AzMixedRealityRemoteRenderingAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/New-AzMixedRealityRemoteRenderingAccount.md +--- + +# New-AzMixedRealityRemoteRenderingAccount + +## SYNOPSIS +Creating or Updating a Remote Rendering Account. + +## SYNTAX + +``` +New-AzMixedRealityRemoteRenderingAccount -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-IdentityType <ResourceIdentityType>] [-KindCapacity <Int32>] + [-KindFamily <String>] [-KindName <String>] [-KindSize <String>] [-KindTier <SkuTier>] + [-PlanType <ResourceIdentityType>] [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] + [-SkuSize <String>] [-SkuTier <SkuTier>] [-StorageAccountName <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creating or Updating a Remote Rendering Account. + +## EXAMPLES + +### Example 1: Creating or Updating a Remote Rendering Account. +```powershell +New-AzMixedRealityRemoteRenderingAccount -Name azpstestrenderingaccount -ResourceGroupName azps_test_group -Location eastus -IdentityType 'SystemAssigned' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstestrenderingaccount azps_test_group +``` + +Creating or Updating a Remote Rendering Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account associated with this accountId + +```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 Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.IRemoteRenderingAccount + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/New-AzMixedRealityRemoteRenderingAccountKey.md b/azps-10.1.0/Az.MixedReality/New-AzMixedRealityRemoteRenderingAccountKey.md new file mode 100644 index 0000000000..5fe81a1f71 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/New-AzMixedRealityRemoteRenderingAccountKey.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/new-azmixedrealityremoterenderingaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/New-AzMixedRealityRemoteRenderingAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/New-AzMixedRealityRemoteRenderingAccountKey.md +--- + +# New-AzMixedRealityRemoteRenderingAccountKey + +## SYNOPSIS +Regenerate specified Key of a Remote Rendering Account + +## SYNTAX + +### RegenerateExpanded (Default) +``` +New-AzMixedRealityRemoteRenderingAccountKey -AccountName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Serial <Int32>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### RegenerateViaIdentityExpanded +``` +New-AzMixedRealityRemoteRenderingAccountKey -InputObject <IMixedRealityIdentity> [-Serial <Int32>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerate specified Key of a Remote Rendering Account + +## EXAMPLES + +### Example 1: Regenerate specified Key of a Remote Rendering Account. +```powershell +New-AzMixedRealityRemoteRenderingAccountKey -AccountName azpstestrenderingaccount -ResourceGroupName azps_test_group -Serial 1 +``` + +```output +PrimaryKey SecondaryKey +---------- ------------ +H9BrXT******8QJ3S/cIzE= VOR11nS******RtYevu5U5fTHM= +``` + +Regenerate specified Key of a Remote Rendering Account. + +## PARAMETERS + +### -AccountName +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity +Parameter Sets: RegenerateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Serial +. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.IAccountKeys + +## 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 <IMixedRealityIdentity>`: Identity Parameter + - `[AccountName <String>]`: Name of an Mixed Reality Account. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: Name of an Azure resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/New-AzMixedRealitySpatialAnchorsAccount.md b/azps-10.1.0/Az.MixedReality/New-AzMixedRealitySpatialAnchorsAccount.md new file mode 100644 index 0000000000..5b2f5bf3b8 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/New-AzMixedRealitySpatialAnchorsAccount.md @@ -0,0 +1,386 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/new-azmixedrealityspatialanchorsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/New-AzMixedRealitySpatialAnchorsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/New-AzMixedRealitySpatialAnchorsAccount.md +--- + +# New-AzMixedRealitySpatialAnchorsAccount + +## SYNOPSIS +Creating or Updating a Spatial Anchors Account. + +## SYNTAX + +``` +New-AzMixedRealitySpatialAnchorsAccount -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-IdentityType <ResourceIdentityType>] [-KindCapacity <Int32>] + [-KindFamily <String>] [-KindName <String>] [-KindSize <String>] [-KindTier <SkuTier>] + [-PlanType <ResourceIdentityType>] [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] + [-SkuSize <String>] [-SkuTier <SkuTier>] [-StorageAccountName <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creating or Updating a Spatial Anchors Account. + +## EXAMPLES + +### Example 1: Creating or Updating a Spatial Anchors Account. +```powershell +New-AzMixedRealitySpatialAnchorsAccount -Name azpstestanchorsaccount -ResourceGroupName azps_test_group -Location eastus +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstestanchorsaccount azps_test_group +``` + +Creating or Updating a Spatial Anchors Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account associated with this accountId + +```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 Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.ISpatialAnchorsAccount + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/New-AzMixedRealitySpatialAnchorsAccountKey.md b/azps-10.1.0/Az.MixedReality/New-AzMixedRealitySpatialAnchorsAccountKey.md new file mode 100644 index 0000000000..e0ad2ada30 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/New-AzMixedRealitySpatialAnchorsAccountKey.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/new-azmixedrealityspatialanchorsaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/New-AzMixedRealitySpatialAnchorsAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/New-AzMixedRealitySpatialAnchorsAccountKey.md +--- + +# New-AzMixedRealitySpatialAnchorsAccountKey + +## SYNOPSIS +Regenerate specified Key of a Spatial Anchors Account + +## SYNTAX + +### RegenerateExpanded (Default) +``` +New-AzMixedRealitySpatialAnchorsAccountKey -AccountName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Serial <Int32>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### RegenerateViaIdentityExpanded +``` +New-AzMixedRealitySpatialAnchorsAccountKey -InputObject <IMixedRealityIdentity> [-Serial <Int32>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerate specified Key of a Spatial Anchors Account + +## EXAMPLES + +### Example 1: Regenerate specified Key of a Spatial Anchors Account. +```powershell +New-AzMixedRealitySpatialAnchorsAccountKey -AccountName azpstestanchorsaccount -ResourceGroupName azps_test_group -Serial 1 +``` + +```output +PrimaryKey SecondaryKey +---------- ------------ +OAocrh+K******8VRRO/I= froxBip******KVs6tqyPA= +``` + +Regenerate specified Key of a Spatial Anchors Account. + +## PARAMETERS + +### -AccountName +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity +Parameter Sets: RegenerateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Serial +. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.IAccountKeys + +## 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 <IMixedRealityIdentity>`: Identity Parameter + - `[AccountName <String>]`: Name of an Mixed Reality Account. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: Name of an Azure resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/Remove-AzMixedRealityObjectAnchorsAccount.md b/azps-10.1.0/Az.MixedReality/Remove-AzMixedRealityObjectAnchorsAccount.md new file mode 100644 index 0000000000..76144b0b08 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Remove-AzMixedRealityObjectAnchorsAccount.md @@ -0,0 +1,195 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/remove-azmixedrealityobjectanchorsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Remove-AzMixedRealityObjectAnchorsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Remove-AzMixedRealityObjectAnchorsAccount.md +--- + +# Remove-AzMixedRealityObjectAnchorsAccount + +## SYNOPSIS +Delete an Object Anchors Account. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMixedRealityObjectAnchorsAccount -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMixedRealityObjectAnchorsAccount -InputObject <IMixedRealityIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete an Object Anchors Account. + +## EXAMPLES + +### Example 1: Delete an Object Anchors Account. +```powershell +Remove-AzMixedRealityObjectAnchorsAccount -Name azpstestanchorsaccount-object -ResourceGroupName azps_test_group +``` + +Delete an Object Anchors Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMixedRealityIdentity>`: Identity Parameter + - `[AccountName <String>]`: Name of an Mixed Reality Account. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: Name of an Azure resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/Remove-AzMixedRealityRemoteRenderingAccount.md b/azps-10.1.0/Az.MixedReality/Remove-AzMixedRealityRemoteRenderingAccount.md new file mode 100644 index 0000000000..4247328519 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Remove-AzMixedRealityRemoteRenderingAccount.md @@ -0,0 +1,195 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/remove-azmixedrealityremoterenderingaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Remove-AzMixedRealityRemoteRenderingAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Remove-AzMixedRealityRemoteRenderingAccount.md +--- + +# Remove-AzMixedRealityRemoteRenderingAccount + +## SYNOPSIS +Delete a Remote Rendering Account. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMixedRealityRemoteRenderingAccount -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMixedRealityRemoteRenderingAccount -InputObject <IMixedRealityIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a Remote Rendering Account. + +## EXAMPLES + +### Example 1: Delete a Remote Rendering Account. +```powershell +Remove-AzMixedRealityRemoteRenderingAccount -Name azpstestrenderingaccount -ResourceGroupName azps_test_group +``` + +Delete a Remote Rendering Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMixedRealityIdentity>`: Identity Parameter + - `[AccountName <String>]`: Name of an Mixed Reality Account. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: Name of an Azure resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/Remove-AzMixedRealitySpatialAnchorsAccount.md b/azps-10.1.0/Az.MixedReality/Remove-AzMixedRealitySpatialAnchorsAccount.md new file mode 100644 index 0000000000..bab890cda3 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Remove-AzMixedRealitySpatialAnchorsAccount.md @@ -0,0 +1,195 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/remove-azmixedrealityspatialanchorsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Remove-AzMixedRealitySpatialAnchorsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Remove-AzMixedRealitySpatialAnchorsAccount.md +--- + +# Remove-AzMixedRealitySpatialAnchorsAccount + +## SYNOPSIS +Delete a Spatial Anchors Account. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMixedRealitySpatialAnchorsAccount -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMixedRealitySpatialAnchorsAccount -InputObject <IMixedRealityIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a Spatial Anchors Account. + +## EXAMPLES + +### Example 1: Delete a Spatial Anchors Account. +```powershell +Remove-AzMixedRealitySpatialAnchorsAccount -Name azpstestanchorsaccount -ResourceGroupName azps_test_group +``` + +Delete a Spatial Anchors Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMixedRealityIdentity>`: Identity Parameter + - `[AccountName <String>]`: Name of an Mixed Reality Account. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: Name of an Azure resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/Test-AzMixedRealityNameAvailability.md b/azps-10.1.0/Az.MixedReality/Test-AzMixedRealityNameAvailability.md new file mode 100644 index 0000000000..d3b3656212 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Test-AzMixedRealityNameAvailability.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/test-azmixedrealitynameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Test-AzMixedRealityNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Test-AzMixedRealityNameAvailability.md +--- + +# Test-AzMixedRealityNameAvailability + +## SYNOPSIS +Check Name Availability for local uniqueness + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzMixedRealityNameAvailability -Location <String> -Name <String> -Type <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzMixedRealityNameAvailability -InputObject <IMixedRealityIdentity> -Name <String> -Type <String> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Check Name Availability for local uniqueness + +## EXAMPLES + +### Example 1: Check Object Anchors Accounts Name Availability for local uniqueness. +```powershell +Test-AzMixedRealityNameAvailability -Location eastus -Name azpstest -Type "Microsoft.MixedReality/objectAnchorsAccounts" +``` + +```output +Message NameAvailable Reason +------- ------------- ------ + True +``` + +Check Object Anchors Accounts Name Availability for local uniqueness. + +### Example 2: Check Remote Rendering Accounts Name Availability for local uniqueness. +```powershell +Test-AzMixedRealityNameAvailability -Location eastus -Name azpstest -Type "Microsoft.MixedReality/remoteRenderingAccounts" +``` + +```output +Message NameAvailable Reason +------- ------------- ------ + True +``` + +Check Remote Rendering Accounts Name Availability for local uniqueness. + +### Example 3: Check Spatial Anchors Accounts Name Availability for local uniqueness. +```powershell +Test-AzMixedRealityNameAvailability -Location eastus -Name azpstest -Type "Microsoft.MixedReality/spatialAnchorsAccounts" +``` + +```output +Message NameAvailable Reason +------- ------------- ------ + True +``` + +Check Spatial Anchors Accounts Name Availability for local uniqueness. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity +Parameter Sets: CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location in which uniqueness will be verified. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource Name To Verify + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Fully qualified resource type which includes provider namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.ICheckNameAvailabilityResponse + +## 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 <IMixedRealityIdentity>`: Identity Parameter + - `[AccountName <String>]`: Name of an Mixed Reality Account. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: Name of an Azure resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/Update-AzMixedRealityObjectAnchorsAccount.md b/azps-10.1.0/Az.MixedReality/Update-AzMixedRealityObjectAnchorsAccount.md new file mode 100644 index 0000000000..5434e45d0d --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Update-AzMixedRealityObjectAnchorsAccount.md @@ -0,0 +1,427 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/update-azmixedrealityobjectanchorsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Update-AzMixedRealityObjectAnchorsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Update-AzMixedRealityObjectAnchorsAccount.md +--- + +# Update-AzMixedRealityObjectAnchorsAccount + +## SYNOPSIS +Updating an Object Anchors Account + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMixedRealityObjectAnchorsAccount -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-IdentityType <ResourceIdentityType>] [-KindCapacity <Int32>] + [-KindFamily <String>] [-KindName <String>] [-KindSize <String>] [-KindTier <SkuTier>] + [-PlanType <ResourceIdentityType>] [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] + [-SkuSize <String>] [-SkuTier <SkuTier>] [-StorageAccountName <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMixedRealityObjectAnchorsAccount -InputObject <IMixedRealityIdentity> -Location <String> + [-IdentityType <ResourceIdentityType>] [-KindCapacity <Int32>] [-KindFamily <String>] [-KindName <String>] + [-KindSize <String>] [-KindTier <SkuTier>] [-PlanType <ResourceIdentityType>] [-SkuCapacity <Int32>] + [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] + [-StorageAccountName <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updating an Object Anchors Account + +## EXAMPLES + +### Example 1: Updating an Object Anchors Account. +```powershell +Update-AzMixedRealityObjectAnchorsAccount -Name azpstestanchorsaccount-object -ResourceGroupName azps_test_group -Location eastus2 -Tag @{"a"="1"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus2 azpstestanchorsaccount-object azps_test_group +``` + +Updating an Object Anchors Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.ResourceIdentityType +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.MixedReality.Models.IMixedRealityIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KindCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account associated with this accountId + +```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 Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.IObjectAnchorsAccount + +## 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 <IMixedRealityIdentity>`: Identity Parameter + - `[AccountName <String>]`: Name of an Mixed Reality Account. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: Name of an Azure resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/Update-AzMixedRealityRemoteRenderingAccount.md b/azps-10.1.0/Az.MixedReality/Update-AzMixedRealityRemoteRenderingAccount.md new file mode 100644 index 0000000000..3bcdcd7c10 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Update-AzMixedRealityRemoteRenderingAccount.md @@ -0,0 +1,427 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/update-azmixedrealityremoterenderingaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Update-AzMixedRealityRemoteRenderingAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Update-AzMixedRealityRemoteRenderingAccount.md +--- + +# Update-AzMixedRealityRemoteRenderingAccount + +## SYNOPSIS +Updating a Remote Rendering Account + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMixedRealityRemoteRenderingAccount -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-IdentityType <ResourceIdentityType>] [-KindCapacity <Int32>] + [-KindFamily <String>] [-KindName <String>] [-KindSize <String>] [-KindTier <SkuTier>] + [-PlanType <ResourceIdentityType>] [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] + [-SkuSize <String>] [-SkuTier <SkuTier>] [-StorageAccountName <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMixedRealityRemoteRenderingAccount -InputObject <IMixedRealityIdentity> -Location <String> + [-IdentityType <ResourceIdentityType>] [-KindCapacity <Int32>] [-KindFamily <String>] [-KindName <String>] + [-KindSize <String>] [-KindTier <SkuTier>] [-PlanType <ResourceIdentityType>] [-SkuCapacity <Int32>] + [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] + [-StorageAccountName <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updating a Remote Rendering Account + +## EXAMPLES + +### Example 1: Updating a Remote Rendering Account. +```powershell +Update-AzMixedRealityRemoteRenderingAccount -Name azpstestrenderingaccount -ResourceGroupName azps_test_group -Location eastus -Tag @{"a"="1"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstestrenderingaccount azps_test_group +``` + +Updating a Remote Rendering Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.ResourceIdentityType +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.MixedReality.Models.IMixedRealityIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KindCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account associated with this accountId + +```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 Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.IRemoteRenderingAccount + +## 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 <IMixedRealityIdentity>`: Identity Parameter + - `[AccountName <String>]`: Name of an Mixed Reality Account. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: Name of an Azure resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MixedReality/Update-AzMixedRealitySpatialAnchorsAccount.md b/azps-10.1.0/Az.MixedReality/Update-AzMixedRealitySpatialAnchorsAccount.md new file mode 100644 index 0000000000..decdd5f980 --- /dev/null +++ b/azps-10.1.0/Az.MixedReality/Update-AzMixedRealitySpatialAnchorsAccount.md @@ -0,0 +1,427 @@ +--- +external help file: +Module Name: Az.MixedReality +online version: https://learn.microsoft.com/powershell/module/az.mixedreality/update-azmixedrealityspatialanchorsaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Update-AzMixedRealitySpatialAnchorsAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MixedReality/help/Update-AzMixedRealitySpatialAnchorsAccount.md +--- + +# Update-AzMixedRealitySpatialAnchorsAccount + +## SYNOPSIS +Updating a Spatial Anchors Account + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMixedRealitySpatialAnchorsAccount -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-IdentityType <ResourceIdentityType>] [-KindCapacity <Int32>] + [-KindFamily <String>] [-KindName <String>] [-KindSize <String>] [-KindTier <SkuTier>] + [-PlanType <ResourceIdentityType>] [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] + [-SkuSize <String>] [-SkuTier <SkuTier>] [-StorageAccountName <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMixedRealitySpatialAnchorsAccount -InputObject <IMixedRealityIdentity> -Location <String> + [-IdentityType <ResourceIdentityType>] [-KindCapacity <Int32>] [-KindFamily <String>] [-KindName <String>] + [-KindSize <String>] [-KindTier <SkuTier>] [-PlanType <ResourceIdentityType>] [-SkuCapacity <Int32>] + [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] [-SkuTier <SkuTier>] + [-StorageAccountName <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updating a Spatial Anchors Account + +## EXAMPLES + +### Example 1: Updating a Spatial Anchors Account. +```powershell +Update-AzMixedRealitySpatialAnchorsAccount -Name azpstestanchorsaccount -ResourceGroupName azps_test_group -Location eastus -Tag @{"a"="1"} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azpstestanchorsaccount azps_test_group +``` + +Updating a Spatial Anchors Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.ResourceIdentityType +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.MixedReality.Models.IMixedRealityIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KindCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KindTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of an Mixed Reality Account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +If the SKU supports scale out/in then the capacity integer should be included. +If scale out/in is not possible for the resource this may be omitted. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +If the service has different generations of hardware, for the same SKU, then that can be captured here. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Ex - P3. +It is typically a letter+number code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +The SKU size. +When the name field is the combination of tier and some other value, this would be the standalone code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account associated with this accountId + +```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 Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.IMixedRealityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MixedReality.Models.Api20210301Preview.ISpatialAnchorsAccount + +## 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 <IMixedRealityIdentity>`: Identity Parameter + - `[AccountName <String>]`: Name of an Mixed Reality Account. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: Name of an Azure resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Az.MobileNetwork.md b/azps-10.1.0/Az.MobileNetwork/Az.MobileNetwork.md new file mode 100644 index 0000000000..546f9995a4 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Az.MobileNetwork.md @@ -0,0 +1,190 @@ +--- +Module Name: Az.MobileNetwork +Module Guid: 11f61d2d-3318-4e19-8917-0f0bd2cc78c7 +Download Help Link: https://learn.microsoft.com/powershell/module/az.mobilenetwork +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Az.MobileNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Az.MobileNetwork.md +--- + +# Az.MobileNetwork Module +## Description +Microsoft Azure PowerShell: MobileNetwork cmdlets + +## Az.MobileNetwork Cmdlets +### [Deploy-AzMobileNetworkReinstallPacketCoreControlPlane](Deploy-AzMobileNetworkReinstallPacketCoreControlPlane.md) +Reinstall the specified packet core control plane. +This action will remove any transaction state from the packet core to return it to a known state. +This action will cause a service outage. + +### [Deploy-AzMobileNetworkRollbackPacketCoreControlPlane](Deploy-AzMobileNetworkRollbackPacketCoreControlPlane.md) +Roll back the specified packet core control plane to the previous version, \"rollbackVersion\". +Multiple consecutive rollbacks are not possible. +This action may cause a service outage. + +### [Get-AzMobileNetwork](Get-AzMobileNetwork.md) +Gets information about the specified mobile network. + +### [Get-AzMobileNetworkAttachedDataNetwork](Get-AzMobileNetworkAttachedDataNetwork.md) +Gets information about the specified attached data network. + +### [Get-AzMobileNetworkDataNetwork](Get-AzMobileNetworkDataNetwork.md) +Gets information about the specified data network. + +### [Get-AzMobileNetworkPacketCoreControlPlane](Get-AzMobileNetworkPacketCoreControlPlane.md) +Gets information about the specified packet core control plane. + +### [Get-AzMobileNetworkPacketCoreControlPlaneVersion](Get-AzMobileNetworkPacketCoreControlPlaneVersion.md) +Gets information about the specified packet core control plane version. + +### [Get-AzMobileNetworkPacketCoreDataPlane](Get-AzMobileNetworkPacketCoreDataPlane.md) +Gets information about the specified packet core data plane. + +### [Get-AzMobileNetworkService](Get-AzMobileNetworkService.md) +Gets information about the specified service. + +### [Get-AzMobileNetworkSim](Get-AzMobileNetworkSim.md) +Gets information about the specified SIM. + +### [Get-AzMobileNetworkSimGroup](Get-AzMobileNetworkSimGroup.md) +Gets information about the specified SIM group. + +### [Get-AzMobileNetworkSimPolicy](Get-AzMobileNetworkSimPolicy.md) +Gets information about the specified SIM policy. + +### [Get-AzMobileNetworkSite](Get-AzMobileNetworkSite.md) +Gets information about the specified mobile network site. + +### [Get-AzMobileNetworkSlice](Get-AzMobileNetworkSlice.md) +Gets information about the specified network slice. + +### [New-AzMobileNetwork](New-AzMobileNetwork.md) +Creates or updates a mobile network. + +### [New-AzMobileNetworkAttachedDataNetwork](New-AzMobileNetworkAttachedDataNetwork.md) +Creates or updates an attached data network. +Must be created in the same location as its parent packet core data plane. + +### [New-AzMobileNetworkDataNetwork](New-AzMobileNetworkDataNetwork.md) +Creates or updates a data network. +Must be created in the same location as its parent mobile network. + +### [New-AzMobileNetworkDataNetworkConfigurationObject](New-AzMobileNetworkDataNetworkConfigurationObject.md) +Create an in-memory object for DataNetworkConfiguration. + +### [New-AzMobileNetworkPacketCoreControlPlane](New-AzMobileNetworkPacketCoreControlPlane.md) +Creates or updates a packet core control plane. + +### [New-AzMobileNetworkPacketCoreDataPlane](New-AzMobileNetworkPacketCoreDataPlane.md) +Creates or updates a packet core data plane. +Must be created in the same location as its parent packet core control plane. + +### [New-AzMobileNetworkPccRuleConfigurationObject](New-AzMobileNetworkPccRuleConfigurationObject.md) +Create an in-memory object for PccRuleConfiguration. + +### [New-AzMobileNetworkService](New-AzMobileNetworkService.md) +Creates or updates a service. +Must be created in the same location as its parent mobile network. + +### [New-AzMobileNetworkServiceDataFlowTemplateObject](New-AzMobileNetworkServiceDataFlowTemplateObject.md) +Create an in-memory object for ServiceDataFlowTemplate. + +### [New-AzMobileNetworkServiceResourceIdObject](New-AzMobileNetworkServiceResourceIdObject.md) +Create an in-memory object for ServiceResourceId. + +### [New-AzMobileNetworkSim](New-AzMobileNetworkSim.md) +Creates or updates a SIM. + +### [New-AzMobileNetworkSimGroup](New-AzMobileNetworkSimGroup.md) +Creates or updates a SIM group. + +### [New-AzMobileNetworkSimPolicy](New-AzMobileNetworkSimPolicy.md) +Creates or updates a SIM policy. +Must be created in the same location as its parent mobile network. + +### [New-AzMobileNetworkSimStaticIPPropertiesObject](New-AzMobileNetworkSimStaticIPPropertiesObject.md) +Create an in-memory object for SimStaticIPProperties. + +### [New-AzMobileNetworkSite](New-AzMobileNetworkSite.md) +Creates or updates a mobile network site. +Must be created in the same location as its parent mobile network. + +### [New-AzMobileNetworkSiteResourceIdObject](New-AzMobileNetworkSiteResourceIdObject.md) +Create an in-memory object for SiteResourceId. + +### [New-AzMobileNetworkSlice](New-AzMobileNetworkSlice.md) +Creates or updates a network slice. +Must be created in the same location as its parent mobile network. + +### [New-AzMobileNetworkSliceConfigurationObject](New-AzMobileNetworkSliceConfigurationObject.md) +Create an in-memory object for SliceConfiguration. + +### [Remove-AzMobileNetwork](Remove-AzMobileNetwork.md) +Deletes the specified mobile network. + +### [Remove-AzMobileNetworkAttachedDataNetwork](Remove-AzMobileNetworkAttachedDataNetwork.md) +Deletes the specified attached data network. + +### [Remove-AzMobileNetworkDataNetwork](Remove-AzMobileNetworkDataNetwork.md) +Deletes the specified data network. + +### [Remove-AzMobileNetworkPacketCoreControlPlane](Remove-AzMobileNetworkPacketCoreControlPlane.md) +Deletes the specified packet core control plane. + +### [Remove-AzMobileNetworkPacketCoreDataPlane](Remove-AzMobileNetworkPacketCoreDataPlane.md) +Deletes the specified packet core data plane. + +### [Remove-AzMobileNetworkService](Remove-AzMobileNetworkService.md) +Deletes the specified service. + +### [Remove-AzMobileNetworkSim](Remove-AzMobileNetworkSim.md) +Deletes the specified SIM. + +### [Remove-AzMobileNetworkSimGroup](Remove-AzMobileNetworkSimGroup.md) +Deletes the specified SIM group. + +### [Remove-AzMobileNetworkSimPolicy](Remove-AzMobileNetworkSimPolicy.md) +Deletes the specified SIM policy. + +### [Remove-AzMobileNetworkSite](Remove-AzMobileNetworkSite.md) +Deletes the specified mobile network site. +This will also delete any network functions that are a part of this site. + +### [Remove-AzMobileNetworkSlice](Remove-AzMobileNetworkSlice.md) +Deletes the specified network slice. + +### [Trace-AzMobileNetworkCollectPacketCoreControlPlaneDiagnosticPackage](Trace-AzMobileNetworkCollectPacketCoreControlPlaneDiagnosticPackage.md) +Collect a diagnostics package for the specified packet core control plane. +This action will upload the diagnostics to a storage account. + +### [Update-AzMobileNetwork](Update-AzMobileNetwork.md) +Updates mobile network tags. + +### [Update-AzMobileNetworkAttachedDataNetwork](Update-AzMobileNetworkAttachedDataNetwork.md) +Updates an attached data network. + +### [Update-AzMobileNetworkDataNetwork](Update-AzMobileNetworkDataNetwork.md) +Updates data network. + +### [Update-AzMobileNetworkPacketCoreControlPlane](Update-AzMobileNetworkPacketCoreControlPlane.md) +Updates packet core control planes. + +### [Update-AzMobileNetworkPacketCoreDataPlane](Update-AzMobileNetworkPacketCoreDataPlane.md) +Updates packet core data planes. + +### [Update-AzMobileNetworkService](Update-AzMobileNetworkService.md) +Updates service. + +### [Update-AzMobileNetworkSimGroup](Update-AzMobileNetworkSimGroup.md) +Updates SIM group. + +### [Update-AzMobileNetworkSimPolicy](Update-AzMobileNetworkSimPolicy.md) +Updates SIM policy. + +### [Update-AzMobileNetworkSite](Update-AzMobileNetworkSite.md) +Updates site tags. + +### [Update-AzMobileNetworkSlice](Update-AzMobileNetworkSlice.md) +Updates slice. + diff --git a/azps-10.1.0/Az.MobileNetwork/Deploy-AzMobileNetworkReinstallPacketCoreControlPlane.md b/azps-10.1.0/Az.MobileNetwork/Deploy-AzMobileNetworkReinstallPacketCoreControlPlane.md new file mode 100644 index 0000000000..c5c720360b --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Deploy-AzMobileNetworkReinstallPacketCoreControlPlane.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/deploy-azmobilenetworkreinstallpacketcorecontrolplane +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Deploy-AzMobileNetworkReinstallPacketCoreControlPlane.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Deploy-AzMobileNetworkReinstallPacketCoreControlPlane.md +--- + +# Deploy-AzMobileNetworkReinstallPacketCoreControlPlane + +## SYNOPSIS +Reinstall the specified packet core control plane. +This action will remove any transaction state from the packet core to return it to a known state. +This action will cause a service outage. + +## SYNTAX + +### Reinstall (Default) +``` +Deploy-AzMobileNetworkReinstallPacketCoreControlPlane -PacketCoreControlPlaneName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ReinstallViaIdentity +``` +Deploy-AzMobileNetworkReinstallPacketCoreControlPlane -InputObject <IMobileNetworkIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Reinstall the specified packet core control plane. +This action will remove any transaction state from the packet core to return it to a known state. +This action will cause a service outage. + +## EXAMPLES + +### Example 1: Reinstall the specified packet core control plane. +```powershell +Deploy-AzMobileNetworkReinstallPacketCoreControlPlane -PacketCoreControlPlaneName azps-mn-pccp -ResourceGroupName azps_test_group +``` + +Reinstall the specified packet core control plane. +This action will remove any transaction state from the packet core to return it to a known state. +This action will cause a service outage. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: ReinstallViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreControlPlaneName +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: Reinstall +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Reinstall +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Reinstall +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IAsyncOperationStatus + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Deploy-AzMobileNetworkRollbackPacketCoreControlPlane.md b/azps-10.1.0/Az.MobileNetwork/Deploy-AzMobileNetworkRollbackPacketCoreControlPlane.md new file mode 100644 index 0000000000..a6c6b4ac14 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Deploy-AzMobileNetworkRollbackPacketCoreControlPlane.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/deploy-azmobilenetworkrollbackpacketcorecontrolplane +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Deploy-AzMobileNetworkRollbackPacketCoreControlPlane.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Deploy-AzMobileNetworkRollbackPacketCoreControlPlane.md +--- + +# Deploy-AzMobileNetworkRollbackPacketCoreControlPlane + +## SYNOPSIS +Roll back the specified packet core control plane to the previous version, \"rollbackVersion\". +Multiple consecutive rollbacks are not possible. +This action may cause a service outage. + +## SYNTAX + +### Rollback (Default) +``` +Deploy-AzMobileNetworkRollbackPacketCoreControlPlane -PacketCoreControlPlaneName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RollbackViaIdentity +``` +Deploy-AzMobileNetworkRollbackPacketCoreControlPlane -InputObject <IMobileNetworkIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Roll back the specified packet core control plane to the previous version, \"rollbackVersion\". +Multiple consecutive rollbacks are not possible. +This action may cause a service outage. + +## EXAMPLES + +### Example 1: Roll back the specified packet core control plane to the previous version, \"rollbackVersion\". +```powershell +Deploy-AzMobileNetworkRollbackPacketCoreControlPlane -PacketCoreControlPlaneName azps-mn-pccp -ResourceGroupName azps_test_group +``` + +Roll back the specified packet core control plane to the previous version, \"rollbackVersion\". +Multiple consecutive rollbacks are not possible. +This action may cause a service outage. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: RollbackViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreControlPlaneName +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: Rollback +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Rollback +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Rollback +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IAsyncOperationStatus + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetwork.md b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetwork.md new file mode 100644 index 0000000000..43d86630a7 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetwork.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/get-azmobilenetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetwork.md +--- + +# Get-AzMobileNetwork + +## SYNOPSIS +Gets information about the specified mobile network. + +## SYNTAX + +### List (Default) +``` +Get-AzMobileNetwork [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMobileNetwork -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMobileNetwork -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzMobileNetwork -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified mobile network. + +## EXAMPLES + +### Example 1: List information about the specified mobile network by Sub. +```powershell +Get-AzMobileNetwork +``` + +```output +Location Name ResourceGroupName PublicLandMobileNetworkIdentifierMcc PublicLandMobileNetworkIdentifierMnc +-------- ---- ----------------- ------------------------------------ ------------------------------------ +eastus azps-mn azps_test_group 001 01 +eastus azps-mn2 azps_test_group 001 01 +``` + +List information about the specified mobile network by Sub. + +### Example 2: List information about the specified mobile network by ResourceGroup. +```powershell +Get-AzMobileNetwork -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName PublicLandMobileNetworkIdentifierMcc PublicLandMobileNetworkIdentifierMnc +-------- ---- ----------------- ------------------------------------ ------------------------------------ +eastus azps-mn azps_test_group 001 01 +eastus azps-mn2 azps_test_group 001 01 +``` + +List information about the specified mobile network by ResourceGroup. + +### Example 3: Get information about the specified mobile network. +```powershell +Get-AzMobileNetwork -ResourceGroupName azps_test_group -Name azps-mn +``` + +```output +Location Name ResourceGroupName PublicLandMobileNetworkIdentifierMcc PublicLandMobileNetworkIdentifierMnc +-------- ---- ----------------- ------------------------------------ ------------------------------------ +eastus azps-mn azps_test_group 001 01 +``` + +Get information about the specified mobile network. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: MobileNetworkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IMobileNetwork + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkAttachedDataNetwork.md b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkAttachedDataNetwork.md new file mode 100644 index 0000000000..d3b3ca0969 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkAttachedDataNetwork.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/get-azmobilenetworkattacheddatanetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkAttachedDataNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkAttachedDataNetwork.md +--- + +# Get-AzMobileNetworkAttachedDataNetwork + +## SYNOPSIS +Gets information about the specified attached data network. + +## SYNTAX + +### List (Default) +``` +Get-AzMobileNetworkAttachedDataNetwork -PacketCoreControlPlaneName <String> -PacketCoreDataPlaneName <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMobileNetworkAttachedDataNetwork -Name <String> -PacketCoreControlPlaneName <String> + -PacketCoreDataPlaneName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMobileNetworkAttachedDataNetwork -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified attached data network. + +## EXAMPLES + +### Example 1: List information about the specified attached data network by PacketCoreControlPlaneName and PacketCoreDataPlaneName. +```powershell +Get-AzMobileNetworkAttachedDataNetwork -PacketCoreControlPlaneName azps=mn-pccp -PacketCoreDataPlaneName azps-mn-pcdp -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-adn azps_test_group Succeeded +``` + +List information about the specified attached data network by PacketCoreControlPlaneName and PacketCoreDataPlaneName. + +### Example 2: Get information about the specified attached data network by Name. +```powershell +Get-AzMobileNetworkAttachedDataNetwork -PacketCoreControlPlaneName azps=mn-pccp -PacketCoreDataPlaneName azps-mn-pcdp -ResourceGroupName azps_test_group -Name azps-mn-adn +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-adn azps_test_group Succeeded +``` + +Get information about the specified attached data network by Name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the attached data network. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AttachedDataNetworkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreControlPlaneName +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreDataPlaneName +The name of the packet core data plane. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IAttachedDataNetwork + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkDataNetwork.md b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkDataNetwork.md new file mode 100644 index 0000000000..6fe65055e8 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkDataNetwork.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/get-azmobilenetworkdatanetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkDataNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkDataNetwork.md +--- + +# Get-AzMobileNetworkDataNetwork + +## SYNOPSIS +Gets information about the specified data network. + +## SYNTAX + +### List (Default) +``` +Get-AzMobileNetworkDataNetwork -MobileNetworkName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMobileNetworkDataNetwork -MobileNetworkName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMobileNetworkDataNetwork -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified data network. + +## EXAMPLES + +### Example 1: List information about the specified data network by MobileNetwork Name. +```powershell +Get-AzMobileNetworkDataNetwork -MobileNetworkName azps-mn -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-datanetwork azps_test_group Succeeded +``` + +List information about the specified data network by MobileNetwork Name. + +### Example 2: Get information about the specified data network. +```powershell +Get-AzMobileNetworkDataNetwork -MobileNetworkName azps-mn -ResourceGroupName azps_test_group -Name azps-mn-datanetwork +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-datanetwork azps_test_group Succeeded +``` + +Get information about the specified data network. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the data network. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DataNetworkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IDataNetwork + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkPacketCoreControlPlane.md b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkPacketCoreControlPlane.md new file mode 100644 index 0000000000..2afcb18328 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkPacketCoreControlPlane.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/get-azmobilenetworkpacketcorecontrolplane +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkPacketCoreControlPlane.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkPacketCoreControlPlane.md +--- + +# Get-AzMobileNetworkPacketCoreControlPlane + +## SYNOPSIS +Gets information about the specified packet core control plane. + +## SYNTAX + +### List (Default) +``` +Get-AzMobileNetworkPacketCoreControlPlane [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzMobileNetworkPacketCoreControlPlane -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMobileNetworkPacketCoreControlPlane -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzMobileNetworkPacketCoreControlPlane -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified packet core control plane. + +## EXAMPLES + +### Example 1: List information about the specified packet core control plane by Sub. +```powershell +Get-AzMobileNetworkPacketCoreControlPlane +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-pccp azps_test_group Succeeded +``` + +List information about the specified packet core control plane by Sub. + +### Example 2: Get information about the specified packet core control plane by ResourceGroup. +```powershell +Get-AzMobileNetworkPacketCoreControlPlane -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-pccp azps_test_group Succeeded +``` + +Get information about the specified packet core control plane by ResourceGroup. + +### Example 3: Get information about the specified packet core control plane by Name. +```powershell +Get-AzMobileNetworkPacketCoreControlPlane -ResourceGroupName azps_test_group -Name azps-mn-pccp +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-pccp azps_test_group Succeeded +``` + +Get information about the specified packet core control plane by Name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PacketCoreControlPlaneName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IPacketCoreControlPlane + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkPacketCoreControlPlaneVersion.md b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkPacketCoreControlPlaneVersion.md new file mode 100644 index 0000000000..71680edc66 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkPacketCoreControlPlaneVersion.md @@ -0,0 +1,153 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/get-azmobilenetworkpacketcorecontrolplaneversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkPacketCoreControlPlaneVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkPacketCoreControlPlaneVersion.md +--- + +# Get-AzMobileNetworkPacketCoreControlPlaneVersion + +## SYNOPSIS +Gets information about the specified packet core control plane version. + +## SYNTAX + +### List (Default) +``` +Get-AzMobileNetworkPacketCoreControlPlaneVersion [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMobileNetworkPacketCoreControlPlaneVersion -VersionName <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMobileNetworkPacketCoreControlPlaneVersion -InputObject <IMobileNetworkIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified packet core control plane version. + +## EXAMPLES + +### Example 1: List information about the specified packet core control plane version by sub. +```powershell +Get-AzMobileNetworkPacketCoreControlPlaneVersion +``` + +```output +Name +---- +PMN-4-9-0 +pmn-2301-0-1 +``` + +List information about the specified packet core control plane version by sub. + +### Example 2: Get information about the specified packet core control plane version by VersionName. +```powershell +Get-AzMobileNetworkPacketCoreControlPlaneVersion -VersionName pmn-2301-0-1 +``` + +```output +Name +---- +pmn-2301-0-1 +``` + +Get information about the specified packet core control plane version by VersionName. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VersionName +The name of the packet core control plane version. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IPacketCoreControlPlaneVersion + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkPacketCoreDataPlane.md b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkPacketCoreDataPlane.md new file mode 100644 index 0000000000..82b0106b9f --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkPacketCoreDataPlane.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/get-azmobilenetworkpacketcoredataplane +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkPacketCoreDataPlane.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkPacketCoreDataPlane.md +--- + +# Get-AzMobileNetworkPacketCoreDataPlane + +## SYNOPSIS +Gets information about the specified packet core data plane. + +## SYNTAX + +### List (Default) +``` +Get-AzMobileNetworkPacketCoreDataPlane -PacketCoreControlPlaneName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMobileNetworkPacketCoreDataPlane -Name <String> -PacketCoreControlPlaneName <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMobileNetworkPacketCoreDataPlane -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified packet core data plane. + +## EXAMPLES + +### Example 1: List information about the specified packet core data plane by PacketCoreControlPlaneName. +```powershell +Get-AzMobileNetworkPacketCoreDataPlane -PacketCoreControlPlaneName azps-mn-pccp -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-pcdp azps_test_group Succeeded +``` + +List information about the specified packet core data plane by PacketCoreControlPlaneName. + +### Example 2: Get information about the specified packet core data plane by Name. +```powershell +Get-AzMobileNetworkPacketCoreDataPlane -PacketCoreControlPlaneName azps-mn-pccp -ResourceGroupName azps_test_group -Name azps-mn-pcdp +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-pcdp azps_test_group Succeeded +``` + +Get information about the specified packet core data plane by Name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the packet core data plane. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PacketCoreDataPlaneName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreControlPlaneName +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IPacketCoreDataPlane + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkService.md b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkService.md new file mode 100644 index 0000000000..64e28b33c8 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkService.md @@ -0,0 +1,200 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/get-azmobilenetworkservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkService.md +--- + +# Get-AzMobileNetworkService + +## SYNOPSIS +Gets information about the specified service. + +## SYNTAX + +### List (Default) +``` +Get-AzMobileNetworkService -MobileNetworkName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMobileNetworkService -MobileNetworkName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMobileNetworkService -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified service. + +## EXAMPLES + +### Example 1: List information about the specified service by MobileNetwork Name. +```powershell +Get-AzMobileNetworkService -MobileNetworkName azps-mn -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName ProvisioningState Precedence MaximumBitRateDownlink MaximumBitRateUplink QoPolicyAllocationAndRetentionPriorityLevel QoPolicyFiveQi +-------- ---- ----------------- ----------------- ---------- ---------------------- -------------------- ------------------------------------------- -------------- +eastus azps-mn-service azps_test_group Succeeded 0 1 Gbps 500 Mbps 9 9 +``` + +List information about the specified service by MobileNetwork Name. + +### Example 2: Get information about the specified service. +```powershell +Get-AzMobileNetworkService -MobileNetworkName azps-mn -ResourceGroupName azps_test_group -Name azps-mn-service +``` + +```output +Location Name ResourceGroupName ProvisioningState Precedence MaximumBitRateDownlink MaximumBitRateUplink QoPolicyAllocationAndRetentionPriorityLevel QoPolicyFiveQi +-------- ---- ----------------- ----------------- ---------- ---------------------- -------------------- ------------------------------------------- -------------- +eastus azps-mn-service azps_test_group Succeeded 0 1 Gbps 500 Mbps 9 9 +``` + +Get information about the specified service. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service. +You must not use any of the following reserved strings - 'default', 'requested' or 'service' + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IService + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSim.md b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSim.md new file mode 100644 index 0000000000..897eb6c418 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSim.md @@ -0,0 +1,198 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/get-azmobilenetworksim +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkSim.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkSim.md +--- + +# Get-AzMobileNetworkSim + +## SYNOPSIS +Gets information about the specified SIM. + +## SYNTAX + +### List (Default) +``` +Get-AzMobileNetworkSim -GroupName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMobileNetworkSim -GroupName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMobileNetworkSim -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified SIM. + +## EXAMPLES + +### Example 1: List information about the specified SIM by SimGroup. +```powershell +Get-AzMobileNetworkSim -GroupName azps-mn-simgroup -ResourceGroupName azps_test_group +``` + +```output +Name ResourceGroupName ProvisioningState +---- ----------------- ----------------- +azps-mn-sim azps_test_group Succeeded +``` + +List information about the specified SIM by SimGroup. + +### Example 2: Get information about the specified SIM by Name. +```powershell +Get-AzMobileNetworkSim -GroupName azps-mn-simgroup -ResourceGroupName azps_test_group -Name azps-mn-sim +``` + +```output +Name ResourceGroupName ProvisioningState +---- ----------------- ----------------- +azps-mn-sim azps_test_group Succeeded +``` + +Get information about the specified SIM by Name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +The name of the SIM Group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: SimGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the SIM. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SimName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISim + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSimGroup.md b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSimGroup.md new file mode 100644 index 0000000000..2a99664eb4 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSimGroup.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/get-azmobilenetworksimgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkSimGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkSimGroup.md +--- + +# Get-AzMobileNetworkSimGroup + +## SYNOPSIS +Gets information about the specified SIM group. + +## SYNTAX + +### List (Default) +``` +Get-AzMobileNetworkSimGroup [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMobileNetworkSimGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMobileNetworkSimGroup -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzMobileNetworkSimGroup -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified SIM group. + +## EXAMPLES + +### Example 1: Get information about the specified SIM group by Sub. +```powershell +Get-AzMobileNetworkSimGroup +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-simgroup azps_test_group Succeeded +``` + +Get information about the specified SIM group by Sub. + +### Example 2: Get information about the specified SIM group by ResourceGroup. +```powershell +Get-AzMobileNetworkSimGroup -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-simgroup azps_test_group Succeeded +``` + +Get information about the specified SIM group by ResourceGroup. + +### Example 3: Get information about the specified SIM group. +```powershell +Get-AzMobileNetworkSimGroup -ResourceGroupName azps_test_group -Name azps-mn-simgroup +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-simgroup azps_test_group Succeeded +``` + +Get information about the specified SIM group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the SIM Group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SimGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISimGroup + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSimPolicy.md b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSimPolicy.md new file mode 100644 index 0000000000..31f73fa318 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSimPolicy.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/get-azmobilenetworksimpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkSimPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkSimPolicy.md +--- + +# Get-AzMobileNetworkSimPolicy + +## SYNOPSIS +Gets information about the specified SIM policy. + +## SYNTAX + +### List (Default) +``` +Get-AzMobileNetworkSimPolicy -MobileNetworkName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMobileNetworkSimPolicy -MobileNetworkName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMobileNetworkSimPolicy -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified SIM policy. + +## EXAMPLES + +### Example 1: List information about the specified SIM policy by MobileNetwork Name. +```powershell +Get-AzMobileNetworkSimPolicy -MobileNetworkName azps-mn -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName ProvisioningState RegistrationTimer UeAmbrDownlink UeAmbrUplink +-------- ---- ----------------- ----------------- ----------------- -------------- ------------ +eastus azps-mn-simpolicy azps_test_group Succeeded 3240 1 Gbps 500 Mbps +``` + +List information about the specified SIM policy by MobileNetwork Name. + +### Example 2: Get information about the specified SIM policy. +```powershell +Get-AzMobileNetworkSimPolicy -MobileNetworkName azps-mn -ResourceGroupName azps_test_group -Name azps-mn-simpolicy +``` + +```output +Location Name ResourceGroupName ProvisioningState RegistrationTimer UeAmbrDownlink UeAmbrUplink +-------- ---- ----------------- ----------------- ----------------- -------------- ------------ +eastus azps-mn-simpolicy azps_test_group Succeeded 3240 1 Gbps 500 Mbps +``` + +Get information about the specified SIM policy. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the SIM policy. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SimPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISimPolicy + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSite.md b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSite.md new file mode 100644 index 0000000000..80ad59f9d4 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSite.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/get-azmobilenetworksite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkSite.md +--- + +# Get-AzMobileNetworkSite + +## SYNOPSIS +Gets information about the specified mobile network site. + +## SYNTAX + +### List (Default) +``` +Get-AzMobileNetworkSite -MobileNetworkName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMobileNetworkSite -MobileNetworkName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMobileNetworkSite -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified mobile network site. + +## EXAMPLES + +### Example 1: List information about the specified mobile network site by MobileNetwork Name. +```powershell +Get-AzMobileNetworkSite -ResourceGroupName azps_test_group -MobileNetworkName azps-mn +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-site azps_test_group Succeeded +``` + +List information about the specified mobile network site by MobileNetwork Name. + +### Example 2: Get information about the specified mobile network site. +```powershell +Get-AzMobileNetworkSite -ResourceGroupName azps_test_group -MobileNetworkName azps-mn -Name azps-mn-site +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-site azps_test_group Succeeded +``` + +Get information about the specified mobile network site. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the mobile network site. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SiteName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISite + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSlice.md b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSlice.md new file mode 100644 index 0000000000..f4dc7e2b3a --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Get-AzMobileNetworkSlice.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/get-azmobilenetworkslice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkSlice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Get-AzMobileNetworkSlice.md +--- + +# Get-AzMobileNetworkSlice + +## SYNOPSIS +Gets information about the specified network slice. + +## SYNTAX + +### List (Default) +``` +Get-AzMobileNetworkSlice -MobileNetworkName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMobileNetworkSlice -MobileNetworkName <String> -ResourceGroupName <String> -SliceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMobileNetworkSlice -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified network slice. + +## EXAMPLES + +### Example 1: List information about the specified network slice by MobileNetwork Name. +```powershell +Get-AzMobileNetworkSlice -MobileNetworkName azps-mn -ResourceGroupName azps_test_group +``` + +```output +Location Name ResourceGroupName ProvisioningState SnssaiSst SnssaiSd +-------- ---- ----------------- ----------------- --------- -------- +eastus azps-mn-slice azps_test_group Succeeded 1 1abcde +``` + +List information about the specified network slice by MobileNetwork Name. + +### Example 2: Get information about the specified network slice. +```powershell +Get-AzMobileNetworkSlice -MobileNetworkName azps-mn -ResourceGroupName azps_test_group -SliceName azps-mn-slice +``` + +```output +Location Name ResourceGroupName ProvisioningState SnssaiSst SnssaiSd +-------- ---- ----------------- ----------------- --------- -------- +eastus azps-mn-slice azps_test_group Succeeded 1 1abcde +``` + +Get information about the specified network slice. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SliceName +The name of the network slice. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISlice + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetwork.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetwork.md new file mode 100644 index 0000000000..8a658fffdc --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetwork.md @@ -0,0 +1,241 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/new-azmobilenetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetwork.md +--- + +# New-AzMobileNetwork + +## SYNOPSIS +Creates or updates a mobile network. + +## SYNTAX + +``` +New-AzMobileNetwork -Name <String> -ResourceGroupName <String> -Location <String> + -PublicLandMobileNetworkIdentifierMcc <String> -PublicLandMobileNetworkIdentifierMnc <String> + [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a mobile network. + +## EXAMPLES + +### Example 1: Creates or updates a mobile network. +```powershell +New-AzMobileNetwork -Name azps-mn -ResourceGroupName azps_test_group -Location eastus -PublicLandMobileNetworkIdentifierMcc 001 -PublicLandMobileNetworkIdentifierMnc 01 -Tag @{"china"="move"} +``` + +```output +Location Name ResourceGroupName PublicLandMobileNetworkIdentifierMcc PublicLandMobileNetworkIdentifierMnc +-------- ---- ----------------- ------------------------------------ ------------------------------------ +eastus azps-mn azps_test_group 001 01 +``` + +Creates or updates a mobile network. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MobileNetworkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicLandMobileNetworkIdentifierMcc +Mobile country code (MCC). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicLandMobileNetworkIdentifierMnc +Mobile network code (MNC). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IMobileNetwork + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkAttachedDataNetwork.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkAttachedDataNetwork.md new file mode 100644 index 0000000000..3ac977ede0 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkAttachedDataNetwork.md @@ -0,0 +1,505 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/new-azmobilenetworkattacheddatanetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkAttachedDataNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkAttachedDataNetwork.md +--- + +# New-AzMobileNetworkAttachedDataNetwork + +## SYNOPSIS +Creates or updates an attached data network. +Must be created in the same location as its parent packet core data plane. + +## SYNTAX + +``` +New-AzMobileNetworkAttachedDataNetwork -Name <String> -PacketCoreControlPlaneName <String> + -PacketCoreDataPlaneName <String> -ResourceGroupName <String> -DnsAddress <String[]> -Location <String> + [-SubscriptionId <String>] [-NaptConfigurationEnabled <NaptEnabled>] [-NaptConfigurationPinholeLimit <Int32>] + [-PinholeTimeoutIcmp <Int32>] [-PinholeTimeoutTcp <Int32>] [-PinholeTimeoutUdp <Int32>] + [-PortRangeMaxPort <Int32>] [-PortRangeMinPort <Int32>] [-PortReuseHoldTimeTcp <Int32>] + [-PortReuseHoldTimeUdp <Int32>] [-Tag <Hashtable>] [-UserEquipmentAddressPoolPrefix <String[]>] + [-UserEquipmentStaticAddressPoolPrefix <String[]>] [-UserPlaneDataInterfaceIpv4Address <String>] + [-UserPlaneDataInterfaceIpv4Gateway <String>] [-UserPlaneDataInterfaceIpv4Subnet <String>] + [-UserPlaneDataInterfaceName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an attached data network. +Must be created in the same location as its parent packet core data plane. + +## EXAMPLES + +### Example 1: Creates or updates an attached data network. +```powershell +$dns=@("1.1.1.1", "1.1.1.2") + +New-AzMobileNetworkAttachedDataNetwork -Name azps-mn-adn -PacketCoreControlPlaneName azps-mn-pccp -PacketCoreDataPlaneName azps-mn-pcdp -ResourceGroupName azps_test_group -DnsAddress $dns -Location eastus -UserPlaneDataInterfaceIpv4Address 10.0.0.10 -UserPlaneDataInterfaceIpv4Gateway 10.0.0.1 -UserPlaneDataInterfaceIpv4Subnet 10.0.0.0/24 -UserPlaneDataInterfaceName N6 +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-adn azps_test_group Succeeded +``` + +Creates or updates an attached data network. +Must be created in the same location as its parent packet core data plane. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsAddress +The DNS servers to signal to UEs to use for this attached data network. +This configuration is mandatory - if you don't want DNS servers, you must provide an empty array. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the attached data network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AttachedDataNetworkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NaptConfigurationEnabled +Whether NAPT is enabled for connections to this attached data network. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.NaptEnabled +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NaptConfigurationPinholeLimit +Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. +For 5G networks, this is the N6 interface. +For 4G networks, this is the SGi interface. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreControlPlaneName +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreDataPlaneName +The name of the packet core data plane. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinholeTimeoutIcmp +Pinhole timeout for ICMP pinholes in seconds. +Default for ICMP Echo is 30 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinholeTimeoutTcp +Pinhole timeout for TCP pinholes in seconds. +Default for TCP is 3 minutes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinholeTimeoutUdp +Pinhole timeout for UDP pinholes in seconds. +Default for UDP is 30 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PortRangeMaxPort +The maximum port number + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PortRangeMinPort +The minimum port number + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PortReuseHoldTimeTcp +Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. +Default for TCP is 2 minutes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PortReuseHoldTimeUdp +Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. +Default for UDP is 1 minute. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEquipmentAddressPoolPrefix +The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will dynamically assign IP addresses to UEs.The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. +You must define at least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix. +If you define both, they must be of the same size. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEquipmentStaticAddressPoolPrefix +The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will assign static IP addresses to UEs.The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. +The static IP address for a specific UE is set in StaticIPConfiguration on the corresponding SIM resource.At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. +If both are defined, they must be of the same size. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneDataInterfaceIpv4Address +The IPv4 address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneDataInterfaceIpv4Gateway +The default IPv4 gateway (router). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneDataInterfaceIpv4Subnet +The IPv4 subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneDataInterfaceName +The logical name for this interface. +This should match one of the interfaces configured on your Azure Stack Edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IAttachedDataNetwork + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkDataNetwork.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkDataNetwork.md new file mode 100644 index 0000000000..0a0c281b16 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkDataNetwork.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/new-azmobilenetworkdatanetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkDataNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkDataNetwork.md +--- + +# New-AzMobileNetworkDataNetwork + +## SYNOPSIS +Creates or updates a data network. +Must be created in the same location as its parent mobile network. + +## SYNTAX + +``` +New-AzMobileNetworkDataNetwork -MobileNetworkName <String> -Name <String> -ResourceGroupName <String> + -Location <String> [-SubscriptionId <String>] [-Description <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a data network. +Must be created in the same location as its parent mobile network. + +## EXAMPLES + +### Example 1: Creates or updates a data network. +```powershell +New-AzMobileNetworkDataNetwork -MobileNetworkName azps-mn -Name azps-mn-datanetwork -ResourceGroupName azps_test_group -Location eastus +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-datanetwork azps_test_group Succeeded +``` + +Creates or updates a data network. +Must be created in the same location as its parent mobile network. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +An optional description for this data network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the data network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DataNetworkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IDataNetwork + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkDataNetworkConfigurationObject.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkDataNetworkConfigurationObject.md new file mode 100644 index 0000000000..d3612f7b67 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkDataNetworkConfigurationObject.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.MobileNetwork/new-AzMobileNetworkDataNetworkConfigurationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkDataNetworkConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkDataNetworkConfigurationObject.md +--- + +# New-AzMobileNetworkDataNetworkConfigurationObject + +## SYNOPSIS +Create an in-memory object for DataNetworkConfiguration. + +## SYNTAX + +``` +New-AzMobileNetworkDataNetworkConfigurationObject -AllowedService <IServiceResourceId[]> + -DataNetworkId <String> -SessionAmbrDownlink <String> -SessionAmbrUplink <String> + [-AdditionalAllowedSessionType <PduSessionType[]>] [-AllocationAndRetentionPriorityLevel <Int32>] + [-DefaultSessionType <PduSessionType>] [-FiveQi <Int32>] [-MaximumNumberOfBufferedPacket <Int32>] + [-PreemptionCapability <PreemptionCapability>] [-PreemptionVulnerability <PreemptionVulnerability>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for DataNetworkConfiguration. + +## EXAMPLES + +### Example 1: Create an in-memory object for DataNetworkConfiguration. +```powershell +$ServiceResourceId = New-AzMobileNetworkServiceResourceIdObject -Id "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/services/azps-mn-service" + +New-AzMobileNetworkDataNetworkConfigurationObject -AllowedService $ServiceResourceId -DataNetworkId "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/dataNetworks/azps-mn-datanetwork" -SessionAmbrDownlink "1 Gbps" -SessionAmbrUplink "500 Mbps" -FiveQi 9 -AllocationAndRetentionPriorityLevel 9 -DefaultSessionType 'IPv4' -MaximumNumberOfBufferedPacket 200 -PreemptionCapability 'NotPreempt' -PreemptionVulnerability 'Preemptable' +``` + +```output +AdditionalAllowedSessionType AllocationAndRetentionPriorityLevel DefaultSessionType FiveQi MaximumNumberOfBufferedPacket PreemptionCapability PreemptionVulnerability +---------------------------- ----------------------------------- ------------------ ------ ----------------------------- -------------------- ----------------------- + 9 IPv4 9 200 NotPreempt Preemptable +``` + +Create an in-memory object for DataNetworkConfiguration. + +## PARAMETERS + +### -AdditionalAllowedSessionType +Allowed session types in addition to the default session type. +Must not duplicate the default session type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.PduSessionType[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllocationAndRetentionPriorityLevel +Default QoS Flow allocation and retention priority (ARP) level. +Flows with higher priority preempt flows with lower priority, if the settings of preemptionCapability and preemptionVulnerability allow it. +1 is the highest level of priority. +If this field is not specified then 5qi is used to derive the ARP value. +See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedService +List of services that can be used as part of this SIM policy. +The list must not contain duplicate items and must contain at least one item. +The services must be in the same location as the SIM policy. +To construct, see NOTES section for ALLOWEDSERVICE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IServiceResourceId[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataNetworkId +Data network resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSessionType +The default PDU session type, which is used if the UE does not request a specific session type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.PduSessionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FiveQi +Default QoS Flow 5G QoS Indicator value. +The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. +This must not be a standardized 5QI value corresponding to a GBR (guaranteed bit rate) QoS Flow. +The illegal GBR 5QI values are: 1, 2, 3, 4, 65, 66, 67, 71, 72, 73, 74, 75, 76, 82, 83, 84, and 85. +See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5QI parameter, and table 5.7.4-1 for the definition of which are the GBR 5QI values. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumNumberOfBufferedPacket +The maximum number of downlink packets to buffer at the user plane for High Latency Communication - Extended Buffering. +See 3GPP TS29.272 v15.10.0 section 7.3.188 for a full description. +This maximum is not guaranteed because there is a internal limit on buffered packets across all PDU sessions. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreemptionCapability +Default QoS Flow preemption capability. +The preemption capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. +See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.PreemptionCapability +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreemptionVulnerability +Default QoS Flow preemption vulnerability. +The preemption vulnerability of a QoS Flow controls whether it can be preempted by a QoS Flow with a higher priority level. +See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.PreemptionVulnerability +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionAmbrDownlink +Downlink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionAmbrUplink +Uplink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.DataNetworkConfiguration + +## 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. + + +`ALLOWEDSERVICE <IServiceResourceId[]>`: List of services that can be used as part of this SIM policy. The list must not contain duplicate items and must contain at least one item. The services must be in the same location as the SIM policy. + - `Id <String>`: Service resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkPacketCoreControlPlane.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkPacketCoreControlPlane.md new file mode 100644 index 0000000000..d715ed6ac9 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkPacketCoreControlPlane.md @@ -0,0 +1,521 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/new-azmobilenetworkpacketcorecontrolplane +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkPacketCoreControlPlane.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkPacketCoreControlPlane.md +--- + +# New-AzMobileNetworkPacketCoreControlPlane + +## SYNOPSIS +Creates or updates a packet core control plane. + +## SYNTAX + +``` +New-AzMobileNetworkPacketCoreControlPlane -Name <String> -ResourceGroupName <String> + -LocalDiagnosticAccessAuthenticationType <AuthenticationType> -Location <String> -PlatformType <PlatformType> + -Site <ISiteResourceId[]> -Sku <BillingSku> [-SubscriptionId <String>] [-AzureStackEdgeDeviceId <String>] + [-AzureStackHciClusterId <String>] [-ConnectedClusterId <String>] + [-ControlPlaneAccessInterfaceIpv4Address <String>] [-ControlPlaneAccessInterfaceIpv4Gateway <String>] + [-ControlPlaneAccessInterfaceIpv4Subnet <String>] [-ControlPlaneAccessInterfaceName <String>] + [-CoreNetworkTechnology <CoreNetworkType>] [-CustomLocationId <String>] [-HttpsServerCertificateUrl <String>] + [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] + [-InteropSetting <Hashtable>] [-Tag <Hashtable>] [-UeMtu <Int32>] [-Version <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a packet core control plane. + +## EXAMPLES + +### Example 1: Creates or updates a packet core control plane. +```powershell +$siteResourceId = New-AzMobileNetworkSiteResourceIdObject -Id /subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/sites/azps-mn-site + +New-AzMobileNetworkPacketCoreControlPlane -Name azps-mn-pccp -ResourceGroupName azps_test_group -LocalDiagnosticAccessAuthenticationType Password -Location eastus -PlatformType AKS-HCI -Site $siteResourceId -Sku G0 -ControlPlaneAccessInterfaceIpv4Address 192.168.1.10 -ControlPlaneAccessInterfaceIpv4Gateway 192.168.1.1 -ControlPlaneAccessInterfaceIpv4Subnet 192.168.1.0/24 -ControlPlaneAccessInterfaceName N2 -CoreNetworkTechnology 5GC +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-pccp azps_test_group Succeeded +``` + +Creates or updates a packet core control plane. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureStackEdgeDeviceId +Azure Stack Edge device resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureStackHciClusterId +Azure Stack HCI cluster resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedClusterId +Azure Arc connected cluster resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlPlaneAccessInterfaceIpv4Address +The IPv4 address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlPlaneAccessInterfaceIpv4Gateway +The default IPv4 gateway (router). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlPlaneAccessInterfaceIpv4Subnet +The IPv4 subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlPlaneAccessInterfaceName +The logical name for this interface. +This should match one of the interfaces configured on your Azure Stack Edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CoreNetworkTechnology +The core network technology generation (5G core or EPC / 4G core). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.CoreNetworkType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomLocationId +Azure Arc custom location resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsServerCertificateUrl +The certificate URL, unversioned. +For example: https://contosovault.vault.azure.net/certificates/ingress. + +```yaml +Type: System.String +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InteropSetting +Settings to allow interoperability with third party components e.g. +RANs and UEs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalDiagnosticAccessAuthenticationType +How to authenticate users who access local diagnostics APIs. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.AuthenticationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PacketCoreControlPlaneName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlatformType +The platform type where packet core is deployed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.PlatformType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Site +Site(s) under which this packet core control plane should be deployed. +The sites must be in the same location as the packet core control plane. +To construct, see NOTES section for SITE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISiteResourceId[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SKU defining the throughput and SIM allowances for this packet core control plane deployment. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.BillingSku +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UeMtu +The MTU (in bytes) signaled to the UE. +The same MTU is set on the user plane data links for all data networks. +The MTU set on the user plane access link is calculated to be 60 bytes greater than this value to allow for GTP encapsulation. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +The version of the packet core software that is deployed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IPacketCoreControlPlane + +## 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. + + +`SITE <ISiteResourceId[]>`: Site(s) under which this packet core control plane should be deployed. The sites must be in the same location as the packet core control plane. + - `Id <String>`: Site resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkPacketCoreDataPlane.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkPacketCoreDataPlane.md new file mode 100644 index 0000000000..a52164b426 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkPacketCoreDataPlane.md @@ -0,0 +1,291 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/new-azmobilenetworkpacketcoredataplane +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkPacketCoreDataPlane.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkPacketCoreDataPlane.md +--- + +# New-AzMobileNetworkPacketCoreDataPlane + +## SYNOPSIS +Creates or updates a packet core data plane. +Must be created in the same location as its parent packet core control plane. + +## SYNTAX + +``` +New-AzMobileNetworkPacketCoreDataPlane -Name <String> -PacketCoreControlPlaneName <String> + -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] [-Tag <Hashtable>] + [-UserPlaneAccessInterfaceIpv4Address <String>] [-UserPlaneAccessInterfaceIpv4Gateway <String>] + [-UserPlaneAccessInterfaceIpv4Subnet <String>] [-UserPlaneAccessInterfaceName <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a packet core data plane. +Must be created in the same location as its parent packet core control plane. + +## EXAMPLES + +### Example 1: Creates or updates a packet core data plane. +```powershell +New-AzMobileNetworkPacketCoreDataPlane -Name azps-mn-pcdp -PacketCoreControlPlaneName azps-mn-pccp -ResourceGroupName azps_test_group -Location eastus -UserPlaneAccessInterfaceIpv4Address 10.0.1.10 -UserPlaneAccessInterfaceIpv4Gateway 10.0.1.1 -UserPlaneAccessInterfaceIpv4Subnet 10.0.1.0/24 -UserPlaneAccessInterfaceName N3 +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-pcdp azps_test_group Succeeded +``` + +Creates or updates a packet core data plane. +Must be created in the same location as its parent packet core control plane. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the packet core data plane. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PacketCoreDataPlaneName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreControlPlaneName +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneAccessInterfaceIpv4Address +The IPv4 address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneAccessInterfaceIpv4Gateway +The default IPv4 gateway (router). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneAccessInterfaceIpv4Subnet +The IPv4 subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneAccessInterfaceName +The logical name for this interface. +This should match one of the interfaces configured on your Azure Stack Edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IPacketCoreDataPlane + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkPccRuleConfigurationObject.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkPccRuleConfigurationObject.md new file mode 100644 index 0000000000..9915e51a91 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkPccRuleConfigurationObject.md @@ -0,0 +1,272 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.MobileNetwork/new-AzMobileNetworkPccRuleConfigurationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkPccRuleConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkPccRuleConfigurationObject.md +--- + +# New-AzMobileNetworkPccRuleConfigurationObject + +## SYNOPSIS +Create an in-memory object for PccRuleConfiguration. + +## SYNTAX + +``` +New-AzMobileNetworkPccRuleConfigurationObject -RuleName <String> -RulePrecedence <Int32> + -ServiceDataFlowTemplate <IServiceDataFlowTemplate[]> [-GuaranteedBitRateDownlink <String>] + [-GuaranteedBitRateUplink <String>] [-RuleQoPolicyAllocationAndRetentionPriorityLevel <Int32>] + [-RuleQoPolicyFiveQi <Int32>] [-RuleQoPolicyMaximumBitRateDownlink <String>] + [-RuleQoPolicyMaximumBitRateUplink <String>] [-RuleQoPolicyPreemptionCapability <PreemptionCapability>] + [-RuleQoPolicyPreemptionVulnerability <PreemptionVulnerability>] [-TrafficControl <TrafficControlPermission>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for PccRuleConfiguration. + +## EXAMPLES + +### Example 1: Create an in-memory object for PccRuleConfiguration. +```powershell +$ServiceDataFlowTemplate = New-AzMobileNetworkServiceDataFlowTemplateObject -Direction "Bidirectional" -Protocol "255" -RemoteIPList "any" -TemplateName azps-mn-flow-template + +New-AzMobileNetworkPccRuleConfigurationObject -RuleName azps-mn-service-rule -RulePrecedence 0 -ServiceDataFlowTemplate $ServiceDataFlowTemplate -TrafficControl 'Enabled' -RuleQoPolicyPreemptionVulnerability 'Preemptable' -RuleQoPolicyPreemptionCapability 'NotPreempt' -RuleQoPolicyAllocationAndRetentionPriorityLevel 9 -RuleQoPolicyMaximumBitRateDownlink "1 Gbps" -RuleQoPolicyMaximumBitRateUplink "500 Mbps" +``` + +```output +RuleName RulePrecedence TrafficControl +-------- -------------- -------------- +azps-mn-service-rule 0 Enabled +``` + +Create an in-memory object for PccRuleConfiguration. + +## PARAMETERS + +### -GuaranteedBitRateDownlink +Downlink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuaranteedBitRateUplink +Uplink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleName +The name of the rule. +This must be unique within the parent service. +You must not use any of the following reserved strings - 'default', 'requested' or 'service'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RulePrecedence +A precedence value that is used to decide between data flow policy rules when identifying the QoS values to use for a particular SIM. +A lower value means a higher priority. +This value should be unique among all data flow policy rules configured in the mobile network. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleQoPolicyAllocationAndRetentionPriorityLevel +QoS Flow allocation and retention priority (ARP) level. +Flows with higher priority preempt flows with lower priority, if the settings of preemptionCapability and preemptionVulnerability allow it. +1 is the highest level of priority. +If this field is not specified then 5qi is used to derive the ARP value. +See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleQoPolicyFiveQi +QoS Flow 5G QoS Indicator value. +The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. +This must not be a standardized 5QI value corresponding to a GBR (guaranteed bit rate) QoS Flow. +The illegal GBR 5QI values are: 1, 2, 3, 4, 65, 66, 67, 71, 72, 73, 74, 75, 76, 82, 83, 84, and 85. +See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5QI parameter, and table 5.7.4-1 for the definition of which are the GBR 5QI values. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleQoPolicyMaximumBitRateDownlink +Downlink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleQoPolicyMaximumBitRateUplink +Uplink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleQoPolicyPreemptionCapability +QoS Flow preemption capability. +The preemption capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. +See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.PreemptionCapability +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleQoPolicyPreemptionVulnerability +QoS Flow preemption vulnerability. +The preemption vulnerability of a QoS Flow controls whether it can be preempted by a QoS Flow with a higher priority level. +See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.PreemptionVulnerability +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceDataFlowTemplate +The set of data flow templates to use for this data flow policy rule. +To construct, see NOTES section for SERVICEDATAFLOWTEMPLATE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IServiceDataFlowTemplate[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficControl +Determines whether flows that match this data flow policy rule are permitted. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.TrafficControlPermission +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.PccRuleConfiguration + +## 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. + + +`SERVICEDATAFLOWTEMPLATE <IServiceDataFlowTemplate[]>`: The set of data flow templates to use for this data flow policy rule. + - `Direction <SdfDirection>`: The direction of this flow. + - `Protocol <String[]>`: A list of the allowed protocol(s) for this flow. If you want this flow to be able to use any protocol within the internet protocol suite, use the value `ip`. If you only want to allow a selection of protocols, you must use the corresponding IANA Assigned Internet Protocol Number for each protocol, as described in https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. For example, for UDP, you must use 17. If you use the value `ip` then you must leave the field `port` unspecified. + - `RemoteIPList <String[]>`: The remote IP address(es) to which UEs will connect for this flow. If you want to allow connections on any IP address, use the value 'any'. Otherwise, you must provide each of the remote IP addresses to which the packet core instance will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). + - `TemplateName <String>`: The name of the data flow template. This must be unique within the parent data flow policy rule. You must not use any of the following reserved strings - 'default', 'requested' or 'service'. + - `[Port <String[]>]`: The port(s) to which UEs will connect for this flow. You can specify zero or more ports or port ranges. If you specify one or more ports or port ranges then you must specify a value other than `ip` in the `protocol` field. This is an optional setting. If you do not specify it then connections will be allowed on all ports. Port ranges must be specified as <FirstPort>-<LastPort>. For example: [`8080`, `8082-8085`]. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkService.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkService.md new file mode 100644 index 0000000000..5000ddedd1 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkService.md @@ -0,0 +1,394 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/new-azmobilenetworkservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkService.md +--- + +# New-AzMobileNetworkService + +## SYNOPSIS +Creates or updates a service. +Must be created in the same location as its parent mobile network. + +## SYNTAX + +``` +New-AzMobileNetworkService -MobileNetworkName <String> -Name <String> -ResourceGroupName <String> + -Location <String> -PccRule <IPccRuleConfiguration[]> -ServicePrecedence <Int32> [-SubscriptionId <String>] + [-MaximumBitRateDownlink <String>] [-MaximumBitRateUplink <String>] + [-ServiceQoPolicyAllocationAndRetentionPriorityLevel <Int32>] [-ServiceQoPolicyFiveQi <Int32>] + [-ServiceQoPolicyPreemptionCapability <PreemptionCapability>] + [-ServiceQoPolicyPreemptionVulnerability <PreemptionVulnerability>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a service. +Must be created in the same location as its parent mobile network. + +## EXAMPLES + +### Example 1: Creates or updates a service. +```powershell +$ServiceDataFlowTemplate = New-AzMobileNetworkServiceDataFlowTemplateObject -Direction "Bidirectional" -Protocol "255" -RemoteIPList "any" -TemplateName azps-mn-flow-template + +$PccRule = New-AzMobileNetworkPccRuleConfigurationObject -RuleName azps-mn-service-rule -RulePrecedence 0 -ServiceDataFlowTemplate $ServiceDataFlowTemplate -TrafficControl 'Enabled' -RuleQoPolicyPreemptionVulnerability 'Preemptable' -RuleQoPolicyPreemptionCapability 'NotPreempt' -RuleQoPolicyAllocationAndRetentionPriorityLevel 9 -RuleQoPolicyMaximumBitRateDownlink "1 Gbps" -RuleQoPolicyMaximumBitRateUplink "500 Mbps" + +New-AzMobileNetworkService -MobileNetworkName azps-mn -Name azps-mn-service -ResourceGroupName azps_test_group -Location eastus -PccRule $PccRule -ServicePrecedence 0 -MaximumBitRateDownlink "1 Gbps" -MaximumBitRateUplink "500 Mbps" -ServiceQoPolicyAllocationAndRetentionPriorityLevel 9 -ServiceQoPolicyFiveQi 9 -ServiceQoPolicyPreemptionCapability 'MayPreempt' -ServiceQoPolicyPreemptionVulnerability 'Preemptable' +``` + +```output +Location Name ResourceGroupName ProvisioningState Precedence MaximumBitRateDownlink MaximumBitRateUplink QoPolicyAllocationAndRetentionPriorityLevel QoPolicyFiveQi +-------- ---- ----------------- ----------------- ---------- ---------------------- -------------------- ------------------------------------------- -------------- +eastus azps-mn-service azps_test_group Succeeded 0 1 Gbps 500 Mbps 9 9 +``` + +Creates or updates a service. +Must be created in the same location as its parent mobile network. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumBitRateDownlink +Downlink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumBitRateUplink +Uplink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service. +You must not use any of the following reserved strings - 'default', 'requested' or 'service' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PccRule +The set of data flow policy rules that make up this service. +To construct, see NOTES section for PCCRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IPccRuleConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrecedence +A precedence value that is used to decide between services when identifying the QoS values to use for a particular SIM. +A lower value means a higher priority. +This value should be unique among all services configured in the mobile network. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceQoPolicyAllocationAndRetentionPriorityLevel +QoS Flow allocation and retention priority (ARP) level. +Flows with higher priority preempt flows with lower priority, if the settings of `preemptionCapability` and `preemptionVulnerability` allow it. +1 is the highest level of priority. +If this field is not specified then `5qi` is used to derive the ARP value. +See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceQoPolicyFiveQi +5G QoS Flow Indicator value. +The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. +See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5QI parameter, and table 5.7.4-1 for the definition the 5QI values. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceQoPolicyPreemptionCapability +QoS Flow preemption capability. +The preemption capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. +See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.PreemptionCapability +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceQoPolicyPreemptionVulnerability +QoS Flow preemption vulnerability. +The preemption vulnerability of a QoS Flow controls whether it can be preempted by a QoS Flow with a higher priority level. +See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.PreemptionVulnerability +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IService + +## 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. + + +`PCCRULE <IPccRuleConfiguration[]>`: The set of data flow policy rules that make up this service. + - `RuleName <String>`: The name of the rule. This must be unique within the parent service. You must not use any of the following reserved strings - 'default', 'requested' or 'service'. + - `RulePrecedence <Int32>`: A precedence value that is used to decide between data flow policy rules when identifying the QoS values to use for a particular SIM. A lower value means a higher priority. This value should be unique among all data flow policy rules configured in the mobile network. + - `ServiceDataFlowTemplate <IServiceDataFlowTemplate[]>`: The set of data flow templates to use for this data flow policy rule. + - `Direction <SdfDirection>`: The direction of this flow. + - `Protocol <String[]>`: A list of the allowed protocol(s) for this flow. If you want this flow to be able to use any protocol within the internet protocol suite, use the value `ip`. If you only want to allow a selection of protocols, you must use the corresponding IANA Assigned Internet Protocol Number for each protocol, as described in https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. For example, for UDP, you must use 17. If you use the value `ip` then you must leave the field `port` unspecified. + - `RemoteIPList <String[]>`: The remote IP address(es) to which UEs will connect for this flow. If you want to allow connections on any IP address, use the value 'any'. Otherwise, you must provide each of the remote IP addresses to which the packet core instance will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). + - `TemplateName <String>`: The name of the data flow template. This must be unique within the parent data flow policy rule. You must not use any of the following reserved strings - 'default', 'requested' or 'service'. + - `[Port <String[]>]`: The port(s) to which UEs will connect for this flow. You can specify zero or more ports or port ranges. If you specify one or more ports or port ranges then you must specify a value other than `ip` in the `protocol` field. This is an optional setting. If you do not specify it then connections will be allowed on all ports. Port ranges must be specified as <FirstPort>-<LastPort>. For example: [`8080`, `8082-8085`]. + - `[GuaranteedBitRateDownlink <String>]`: Downlink bit rate. + - `[GuaranteedBitRateUplink <String>]`: Uplink bit rate. + - `[RuleQoPolicyAllocationAndRetentionPriorityLevel <Int32?>]`: QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority, if the settings of `preemptionCapability` and `preemptionVulnerability` allow it. 1 is the highest level of priority. If this field is not specified then `5qi` is used to derive the ARP value. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `[RuleQoPolicyFiveQi <Int32?>]`: 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5QI parameter, and table 5.7.4-1 for the definition the 5QI values. + - `[RuleQoPolicyMaximumBitRateDownlink <String>]`: Downlink bit rate. + - `[RuleQoPolicyMaximumBitRateUplink <String>]`: Uplink bit rate. + - `[RuleQoPolicyPreemptionCapability <PreemptionCapability?>]`: QoS Flow preemption capability. The preemption capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `[RuleQoPolicyPreemptionVulnerability <PreemptionVulnerability?>]`: QoS Flow preemption vulnerability. The preemption vulnerability of a QoS Flow controls whether it can be preempted by a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `[TrafficControl <TrafficControlPermission?>]`: Determines whether flows that match this data flow policy rule are permitted. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkServiceDataFlowTemplateObject.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkServiceDataFlowTemplateObject.md new file mode 100644 index 0000000000..638406e742 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkServiceDataFlowTemplateObject.md @@ -0,0 +1,146 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.MobileNetwork/new-AzMobileNetworkServiceDataFlowTemplateObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkServiceDataFlowTemplateObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkServiceDataFlowTemplateObject.md +--- + +# New-AzMobileNetworkServiceDataFlowTemplateObject + +## SYNOPSIS +Create an in-memory object for ServiceDataFlowTemplate. + +## SYNTAX + +``` +New-AzMobileNetworkServiceDataFlowTemplateObject -Direction <SdfDirection> -Protocol <String[]> + -RemoteIPList <String[]> -TemplateName <String> [-Port <String[]>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ServiceDataFlowTemplate. + +## EXAMPLES + +### Example 1: Create an in-memory object for ServiceDataFlowTemplate. +```powershell +New-AzMobileNetworkServiceDataFlowTemplateObject -Direction "Bidirectional" -Protocol "255" -RemoteIPList "any" -TemplateName azps-mn-flow-template +``` + +```output +Direction Port Protocol RemoteIPList TemplateName +--------- ---- -------- ------------ ------------ +Bidirectional {255} {any} azps-mn-flow-template +``` + +Create an in-memory object for ServiceDataFlowTemplate. + +## PARAMETERS + +### -Direction +The direction of this flow. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.SdfDirection +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +The port(s) to which UEs will connect for this flow. +You can specify zero or more ports or port ranges. +If you specify one or more ports or port ranges then you must specify a value other than ip in the protocol field. +This is an optional setting. +If you do not specify it then connections will be allowed on all ports. +Port ranges must be specified as \<FirstPort\>-\<LastPort\>. +For example: [8080, 8082-8085]. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +A list of the allowed protocol(s) for this flow. +If you want this flow to be able to use any protocol within the internet protocol suite, use the value ip. +If you only want to allow a selection of protocols, you must use the corresponding IANA Assigned Internet Protocol Number for each protocol, as described in https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. +For example, for UDP, you must use 17. +If you use the value ip then you must leave the field port unspecified. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteIPList +The remote IP address(es) to which UEs will connect for this flow. +If you want to allow connections on any IP address, use the value 'any'. +Otherwise, you must provide each of the remote IP addresses to which the packet core instance will connect for this flow. +You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateName +The name of the data flow template. +This must be unique within the parent data flow policy rule. +You must not use any of the following reserved strings - 'default', 'requested' or 'service'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ServiceDataFlowTemplate + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkServiceResourceIdObject.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkServiceResourceIdObject.md new file mode 100644 index 0000000000..bca1fb2723 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkServiceResourceIdObject.md @@ -0,0 +1,70 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.MobileNetwork/new-AzMobileNetworkServiceResourceIdObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkServiceResourceIdObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkServiceResourceIdObject.md +--- + +# New-AzMobileNetworkServiceResourceIdObject + +## SYNOPSIS +Create an in-memory object for ServiceResourceId. + +## SYNTAX + +``` +New-AzMobileNetworkServiceResourceIdObject -Id <String> [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ServiceResourceId. + +## EXAMPLES + +### Example 1: Create an in-memory object for ServiceResourceId. +```powershell +New-AzMobileNetworkServiceResourceIdObject -Id "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/services/azps-mn-service" +``` + +```output +Id +-- +/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/services/azps-mn-service +``` + +Create an in-memory object for ServiceResourceId. + +## PARAMETERS + +### -Id +Service resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ServiceResourceId + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSim.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSim.md new file mode 100644 index 0000000000..c417ae07ad --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSim.md @@ -0,0 +1,317 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/new-azmobilenetworksim +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSim.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSim.md +--- + +# New-AzMobileNetworkSim + +## SYNOPSIS +Creates or updates a SIM. + +## SYNTAX + +``` +New-AzMobileNetworkSim -GroupName <String> -Name <String> -ResourceGroupName <String> + -InternationalMobileSubscriberIdentity <String> [-SubscriptionId <String>] [-AuthenticationKey <String>] + [-DeviceType <String>] [-IntegratedCircuitCardIdentifier <String>] [-OperatorKeyCode <String>] + [-SimPolicyId <String>] [-StaticIPConfiguration <ISimStaticIPProperties[]>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a SIM. + +## EXAMPLES + +### Example 1: Creates or updates a SIM. +```powershell +$staticIp = New-AzMobileNetworkSimStaticIPPropertiesObject -StaticIPIpv4Address 10.0.0.20 + +New-AzMobileNetworkSim -GroupName azps-mn-simgroup -Name azps-mn-sim -ResourceGroupName azps_test_group -InternationalMobileSubscriberIdentity 000000000000001 -AuthenticationKey 00112233445566778899AABBCCDDEEFF -DeviceType Mobile -IntegratedCircuitCardIdentifier 8900000000000000001 -OperatorKeyCode 00000000000000000000000000000001 -SimPolicyId "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/simPolicies/azps-mn-simpolicy" -StaticIPConfiguration $staticIp +``` + +```output +Name ResourceGroupName ProvisioningState +---- ----------------- ----------------- +azps-mn-sim azps_test_group Succeeded +``` + +Creates or updates a SIM. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationKey +The Ki value for the SIM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceType +An optional free-form text field that can be used to record the device type this SIM is associated with, for example 'Video camera'. +The Azure portal allows SIMs to be grouped and filtered based on this value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +The name of the SIM Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SimGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntegratedCircuitCardIdentifier +The integrated circuit card ID (ICCID) for the SIM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternationalMobileSubscriberIdentity +The international mobile subscriber identity (IMSI) for the SIM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the SIM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SimName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperatorKeyCode +The Opc value for the SIM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimPolicyId +SIM policy resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticIPConfiguration +A list of static IP addresses assigned to this SIM. +Each address is assigned at a defined network scope, made up of {attached data network, slice}. +To construct, see NOTES section for STATICIPCONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISimStaticIPProperties[] +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISim + +## 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. + + +`STATICIPCONFIGURATION <ISimStaticIPProperties[]>`: A list of static IP addresses assigned to this SIM. Each address is assigned at a defined network scope, made up of {attached data network, slice}. + - `[AttachedDataNetworkId <String>]`: Attached data network resource ID. + - `[SlouseId <String>]`: Slice resource ID. + - `[StaticIPIpv4Address <String>]`: The IPv4 address assigned to the SIM at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attached data network. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSimGroup.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSimGroup.md new file mode 100644 index 0000000000..e4e5bffb2b --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSimGroup.md @@ -0,0 +1,275 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/new-azmobilenetworksimgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSimGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSimGroup.md +--- + +# New-AzMobileNetworkSimGroup + +## SYNOPSIS +Creates or updates a SIM group. + +## SYNTAX + +``` +New-AzMobileNetworkSimGroup -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-EncryptionKeyUrl <String>] [-IdentityType <ManagedServiceIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-MobileNetworkId <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a SIM group. + +## EXAMPLES + +### Example 1: Creates or updates a SIM group. +```powershell +New-AzMobileNetworkSimGroup -Name azps-mn-simgroup -ResourceGroupName azps_test_group -Location eastus -MobileNetworkId "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn" +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-simgroup azps_test_group Succeeded +``` + +Creates or updates a SIM group. +You need to create Keyvault, managementiidentity, and give Keyvault some permissions on the ManagementIdentity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyUrl +The key URL, unversioned. +For example: https://contosovault.vault.azure.net/keys/azureKey. + +```yaml +Type: System.String +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileNetworkId +Mobile network resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the SIM Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SimGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISimGroup + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSimPolicy.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSimPolicy.md new file mode 100644 index 0000000000..b5240ec081 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSimPolicy.md @@ -0,0 +1,351 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/new-azmobilenetworksimpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSimPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSimPolicy.md +--- + +# New-AzMobileNetworkSimPolicy + +## SYNOPSIS +Creates or updates a SIM policy. +Must be created in the same location as its parent mobile network. + +## SYNTAX + +``` +New-AzMobileNetworkSimPolicy -MobileNetworkName <String> -Name <String> -ResourceGroupName <String> + -DefaultSliceId <String> -Location <String> -SliceConfiguration <ISliceConfiguration[]> + -UeAmbrDownlink <String> -UeAmbrUplink <String> [-SubscriptionId <String>] [-RegistrationTimer <Int32>] + [-RfspIndex <Int32>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a SIM policy. +Must be created in the same location as its parent mobile network. + +## EXAMPLES + +### Example 1: Creates or updates a SIM policy. +```powershell +$ServiceResourceId = New-AzMobileNetworkServiceResourceIdObject -Id "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/services/azps-mn-service" + +$DataNetworkConfiguration = New-AzMobileNetworkDataNetworkConfigurationObject -AllowedService $ServiceResourceId -DataNetworkId "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/dataNetworks/azps-mn-datanetwork" -SessionAmbrDownlink "1 Gbps" -SessionAmbrUplink "500 Mbps" -FiveQi 9 -AllocationAndRetentionPriorityLevel 9 -DefaultSessionType 'IPv4' -MaximumNumberOfBufferedPacket 200 -PreemptionCapability 'NotPreempt' -PreemptionVulnerability 'Preemptable' + +$SliceConfiguration = New-AzMobileNetworkSliceConfigurationObject -DataNetworkConfiguration $DataNetworkConfiguration -DefaultDataNetworkId "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/dataNetworks/azps-mn-datanetwork" -SliceId "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/slices/azps-mn-slice" + +New-AzMobileNetworkSimPolicy -MobileNetworkName azps-mn -Name azps-mn-simpolicy -ResourceGroupName azps_test_group -Location eastus -DefaultSliceId "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/slices/azps-mn-slice" -SliceConfiguration $SliceConfiguration -UeAmbrDownlink "1 Gbps" -UeAmbrUplink "500 Mbps" -RegistrationTimer 3240 +``` + +```output +Location Name ResourceGroupName ProvisioningState RegistrationTimer UeAmbrDownlink UeAmbrUplink +-------- ---- ----------------- ----------------- ----------------- -------------- ------------ +eastus azps-mn-simpolicy azps_test_group Succeeded 3240 1 Gbps 500 Mbps +``` + +Creates or updates a SIM policy. +Must be created in the same location as its parent mobile network. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSliceId +Slice resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the SIM policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SimPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationTimer +Interval for the UE periodic registration update procedure, in seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RfspIndex +RAT/Frequency Selection Priority Index, defined in 3GPP TS 36.413. +This is an optional setting and by default is unspecified. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SliceConfiguration +The allowed slices and the settings to use for them. +The list must not contain duplicate items and must contain at least one item. +To construct, see NOTES section for SLICECONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISliceConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UeAmbrDownlink +Downlink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UeAmbrUplink +Uplink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISimPolicy + +## 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. + + +`SLICECONFIGURATION <ISliceConfiguration[]>`: The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item. + - `DataNetworkConfiguration <IDataNetworkConfiguration[]>`: The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. + - `AllowedService <IServiceResourceId[]>`: List of services that can be used as part of this SIM policy. The list must not contain duplicate items and must contain at least one item. The services must be in the same location as the SIM policy. + - `Id <String>`: Service resource ID. + - `DataNetworkId <String>`: Data network resource ID. + - `SessionAmbrDownlink <String>`: Downlink bit rate. + - `SessionAmbrUplink <String>`: Uplink bit rate. + - `[AdditionalAllowedSessionType <PduSessionType[]>]`: Allowed session types in addition to the default session type. Must not duplicate the default session type. + - `[AllocationAndRetentionPriorityLevel <Int32?>]`: Default QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority, if the settings of `preemptionCapability` and `preemptionVulnerability` allow it. 1 is the highest level of priority. If this field is not specified then `5qi` is used to derive the ARP value. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `[DefaultSessionType <PduSessionType?>]`: The default PDU session type, which is used if the UE does not request a specific session type. + - `[FiveQi <Int32?>]`: Default 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5QI parameter, and table 5.7.4-1 for the definition the 5QI values. + - `[MaximumNumberOfBufferedPacket <Int32?>]`: The maximum number of downlink packets to buffer at the user plane for High Latency Communication - Extended Buffering. See 3GPP TS29.272 v15.10.0 section 7.3.188 for a full description. This maximum is not guaranteed because there is a internal limit on buffered packets across all PDU sessions. + - `[PreemptionCapability <PreemptionCapability?>]`: Default QoS Flow preemption capability. The preemption capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `[PreemptionVulnerability <PreemptionVulnerability?>]`: Default QoS Flow preemption vulnerability. The preemption vulnerability of a QoS Flow controls whether it can be preempted by a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `DefaultDataNetworkId <String>`: Data network resource ID. + - `SlouseId <String>`: Slice resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSimStaticIPPropertiesObject.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSimStaticIPPropertiesObject.md new file mode 100644 index 0000000000..e0640932bd --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSimStaticIPPropertiesObject.md @@ -0,0 +1,102 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.MobileNetwork/new-AzMobileNetworkSimStaticIPPropertiesObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSimStaticIPPropertiesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSimStaticIPPropertiesObject.md +--- + +# New-AzMobileNetworkSimStaticIPPropertiesObject + +## SYNOPSIS +Create an in-memory object for SimStaticIPProperties. + +## SYNTAX + +``` +New-AzMobileNetworkSimStaticIPPropertiesObject [-AttachedDataNetworkId <String>] [-SliceId <String>] + [-StaticIPIpv4Address <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SimStaticIPProperties. + +## EXAMPLES + +### Example 1: Create an in-memory object for SimStaticIPProperties. +```powershell +New-AzMobileNetworkSimStaticIPPropertiesObject -StaticIPIpv4Address 10.0.0.20 +``` + +```output +AttachedDataNetworkId SlouseId StaticIPIpv4Address +--------------------- -------- ------------------- + 10.0.0.20 +``` + +Create an in-memory object for SimStaticIPProperties. + +## PARAMETERS + +### -AttachedDataNetworkId +Attached data network resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SliceId +Slice resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticIPIpv4Address +The IPv4 address assigned to the SIM at this network scope. +This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attached data network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.SimStaticIPProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSite.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSite.md new file mode 100644 index 0000000000..ed856281d4 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSite.md @@ -0,0 +1,595 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/new-azmobilenetworksite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSite.md +--- + +# New-AzMobileNetworkSite + +## SYNOPSIS +Creates or updates a mobile network site. +Must be created in the same location as its parent mobile network. + +## SYNTAX + +``` +New-AzMobileNetworkSite -MobileNetworkName <String> -Name <String> -ResourceGroupName <String> + -Location <String> [-DataNetworkName <String>] [-SubscriptionId <String>] [-AzureStackEdgeDeviceId <String>] + [-ControlPlaneAccessInterfaceIpv4Address <String>] [-ControlPlaneAccessInterfaceIpv4Gateway <String>] + [-ControlPlaneAccessInterfaceIpv4Subnet <String>] [-ControlPlaneAccessInterfaceName <String>] + [-CoreNetworkTechnology <CoreNetworkType>] [-CustomLocationId <String>] [-DnsAddress <String[]>] + [-LocalDiagnosticAccessAuthenticationType <AuthenticationType>] [-NaptConfigurationEnabled <NaptEnabled>] + [-PlatformType <PlatformType>] [-Sku <BillingSku>] [-Tag <Hashtable>] + [-UserEquipmentAddressPoolPrefix <String[]>] [-UserEquipmentStaticAddressPoolPrefix <String[]>] + [-UserPlaneAccessInterfaceIpv4Address <String>] [-UserPlaneAccessInterfaceIpv4Gateway <String>] + [-UserPlaneAccessInterfaceIpv4Subnet <String>] [-UserPlaneAccessInterfaceName <String>] + [-UserPlaneDataInterfaceIpv4Address <String>] [-UserPlaneDataInterfaceIpv4Gateway <String>] + [-UserPlaneDataInterfaceIpv4Subnet <String>] [-UserPlaneDataInterfaceName <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a mobile network site. +Must be created in the same location as its parent mobile network. + +## EXAMPLES + +### Example 1: Creates or updates a mobile network site. +```powershell +New-AzMobileNetworkSite -MobileNetworkName azps-mn -Name azps-mn-site -ResourceGroupName azps_test_group -Location eastus -Tag @{"site"="123"} +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-site azps_test_group Succeeded +``` + +Creates or updates a mobile network site. +Must be created in the same location as its parent mobile network. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureStackEdgeDeviceId +Azure Stack Edge device resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlPlaneAccessInterfaceIpv4Address +The IPv4 address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlPlaneAccessInterfaceIpv4Gateway +The default IPv4 gateway (router). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlPlaneAccessInterfaceIpv4Subnet +The IPv4 subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlPlaneAccessInterfaceName +The logical name for this interface. +This should match one of the interfaces configured on your Azure Stack Edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CoreNetworkTechnology +The core network technology generation (5G core or EPC / 4G core). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.CoreNetworkType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomLocationId +Azure Arc custom location resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataNetworkName +New-AzMobileNetworkDataNetwork +The name of the data network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsAddress +New-AzMobileNetworkAttachedDataNetwork +The DNS servers to signal to UEs to use for this attached data network. +This configuration is mandatory - if you don't want DNS servers, you must provide an empty array. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalDiagnosticAccessAuthenticationType +How to authenticate users who access local diagnostics APIs. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.AuthenticationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the mobile network site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SiteName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NaptConfigurationEnabled +Whether NAPT is enabled for connections to this attached data network. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.NaptEnabled +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlatformType +New-AzMobileNetworkPacketCoreControlPlane +The platform type where packet core is deployed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.PlatformType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SKU defining the throughput and SIM allowances for this packet core control plane deployment. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.BillingSku +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEquipmentAddressPoolPrefix +The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will dynamically assign IP addresses to UEs.The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. +You must define at least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix. +If you define both, they must be of the same size. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEquipmentStaticAddressPoolPrefix +The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will assign static IP addresses to UEs.The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. +The static IP address for a specific UE is set in StaticIPConfiguration on the corresponding SIM resource.At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. +If both are defined, they must be of the same size. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneAccessInterfaceIpv4Address +New-AzMobileNetworkPacketCoreDataPlane +The IPv4 address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneAccessInterfaceIpv4Gateway +The default IPv4 gateway (router). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneAccessInterfaceIpv4Subnet +The IPv4 subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneAccessInterfaceName +The logical name for this interface. +This should match one of the interfaces configured on your Azure Stack Edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneDataInterfaceIpv4Address +The IPv4 address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneDataInterfaceIpv4Gateway +The default IPv4 gateway (router). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneDataInterfaceIpv4Subnet +The IPv4 subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneDataInterfaceName +The logical name for this interface. +This should match one of the interfaces configured on your Azure Stack Edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISite + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSiteResourceIdObject.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSiteResourceIdObject.md new file mode 100644 index 0000000000..8f7cb7e3df --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSiteResourceIdObject.md @@ -0,0 +1,70 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.MobileNetwork/new-AzMobileNetworkSiteResourceIdObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSiteResourceIdObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSiteResourceIdObject.md +--- + +# New-AzMobileNetworkSiteResourceIdObject + +## SYNOPSIS +Create an in-memory object for SiteResourceId. + +## SYNTAX + +``` +New-AzMobileNetworkSiteResourceIdObject -Id <String> [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SiteResourceId. + +## EXAMPLES + +### Example 1: Create an in-memory object for SiteResourceId. +```powershell +New-AzMobileNetworkSiteResourceIdObject -Id "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/sites/azps-mn-site" +``` + +```output +Id +-- +/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/sites/azps-mn-site +``` + +Create an in-memory object for SiteResourceId. + +## PARAMETERS + +### -Id +Site resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.SiteResourceId + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSlice.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSlice.md new file mode 100644 index 0000000000..93765dbe4a --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSlice.md @@ -0,0 +1,273 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/new-azmobilenetworkslice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSlice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSlice.md +--- + +# New-AzMobileNetworkSlice + +## SYNOPSIS +Creates or updates a network slice. +Must be created in the same location as its parent mobile network. + +## SYNTAX + +``` +New-AzMobileNetworkSlice -MobileNetworkName <String> -ResourceGroupName <String> -SliceName <String> + -Location <String> -SnssaiSst <Int32> [-SubscriptionId <String>] [-Description <String>] [-SnssaiSd <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a network slice. +Must be created in the same location as its parent mobile network. + +## EXAMPLES + +### Example 1: Creates or updates a network slice. +```powershell +New-AzMobileNetworkSlice -MobileNetworkName azps-mn -ResourceGroupName azps_test_group -SliceName azps-mn-slice -Location eastus -SnssaiSst 1 -SnssaiSd "1abcde" +``` + +```output +Location Name ResourceGroupName ProvisioningState SnssaiSst SnssaiSd +-------- ---- ----------------- ----------------- --------- -------- +eastus azps-mn-slice azps_test_group Succeeded 1 1abcde +``` + +Creates or updates a network slice. +Must be created in the same location as its parent mobile network. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +An optional description for this network slice. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SliceName +The name of the network slice. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnssaiSd +Slice differentiator (SD). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnssaiSst +Slice/service type (SST). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISlice + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSliceConfigurationObject.md b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSliceConfigurationObject.md new file mode 100644 index 0000000000..57780a252a --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/New-AzMobileNetworkSliceConfigurationObject.md @@ -0,0 +1,126 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.MobileNetwork/new-AzMobileNetworkSliceConfigurationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSliceConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/New-AzMobileNetworkSliceConfigurationObject.md +--- + +# New-AzMobileNetworkSliceConfigurationObject + +## SYNOPSIS +Create an in-memory object for SliceConfiguration. + +## SYNTAX + +``` +New-AzMobileNetworkSliceConfigurationObject -DataNetworkConfiguration <IDataNetworkConfiguration[]> + -DefaultDataNetworkId <String> -SliceId <String> [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SliceConfiguration. + +## EXAMPLES + +### Example 1: Create an in-memory object for SliceConfiguration. +```powershell +$ServiceResourceId = New-AzMobileNetworkServiceResourceIdObject -Id "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/services/azps-mn-service" + +$DataNetworkConfiguration = New-AzMobileNetworkDataNetworkConfigurationObject -AllowedService $ServiceResourceId -DataNetworkId "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/dataNetworks/azps-mn-datanetwork" -SessionAmbrDownlink "1 Gbps" -SessionAmbrUplink "500 Mbps" -FiveQi 9 -AllocationAndRetentionPriorityLevel 9 -DefaultSessionType 'IPv4' -MaximumNumberOfBufferedPacket 200 -PreemptionCapability 'NotPreempt' -PreemptionVulnerability 'Preemptable' + +New-AzMobileNetworkSliceConfigurationObject -DataNetworkConfiguration $DataNetworkConfiguration -DefaultDataNetworkId "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/dataNetworks/azps-mn-datanetwork" -SliceId "/subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.MobileNetwork/mobileNetworks/azps-mn/slices/azps-mn-slice" +``` + +```output +DataNetworkConfiguration +------------------------ +{{… +``` + +Create an in-memory object for SliceConfiguration. + +## PARAMETERS + +### -DataNetworkConfiguration +The allowed data networks and the settings to use for them. +The list must not contain duplicate items and must contain at least one item. +To construct, see NOTES section for DATANETWORKCONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IDataNetworkConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultDataNetworkId +Data network resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SliceId +Slice resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.SliceConfiguration + +## 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. + + +`DATANETWORKCONFIGURATION <IDataNetworkConfiguration[]>`: The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. + - `AllowedService <IServiceResourceId[]>`: List of services that can be used as part of this SIM policy. The list must not contain duplicate items and must contain at least one item. The services must be in the same location as the SIM policy. + - `Id <String>`: Service resource ID. + - `DataNetworkId <String>`: Data network resource ID. + - `SessionAmbrDownlink <String>`: Downlink bit rate. + - `SessionAmbrUplink <String>`: Uplink bit rate. + - `[AdditionalAllowedSessionType <PduSessionType[]>]`: Allowed session types in addition to the default session type. Must not duplicate the default session type. + - `[AllocationAndRetentionPriorityLevel <Int32?>]`: Default QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority, if the settings of `preemptionCapability` and `preemptionVulnerability` allow it. 1 is the highest level of priority. If this field is not specified then `5qi` is used to derive the ARP value. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `[DefaultSessionType <PduSessionType?>]`: The default PDU session type, which is used if the UE does not request a specific session type. + - `[FiveQi <Int32?>]`: Default 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5QI parameter, and table 5.7.4-1 for the definition the 5QI values. + - `[MaximumNumberOfBufferedPacket <Int32?>]`: The maximum number of downlink packets to buffer at the user plane for High Latency Communication - Extended Buffering. See 3GPP TS29.272 v15.10.0 section 7.3.188 for a full description. This maximum is not guaranteed because there is a internal limit on buffered packets across all PDU sessions. + - `[PreemptionCapability <PreemptionCapability?>]`: Default QoS Flow preemption capability. The preemption capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `[PreemptionVulnerability <PreemptionVulnerability?>]`: Default QoS Flow preemption vulnerability. The preemption vulnerability of a QoS Flow controls whether it can be preempted by a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetwork.md b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetwork.md new file mode 100644 index 0000000000..9c0498a076 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetwork.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/remove-azmobilenetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetwork.md +--- + +# Remove-AzMobileNetwork + +## SYNOPSIS +Deletes the specified mobile network. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMobileNetwork -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMobileNetwork -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified mobile network. + +## EXAMPLES + +### Example 1: Deletes the specified mobile network. +```powershell +Remove-AzMobileNetwork -Name azps-mn -ResourceGroupName azps_test_group +``` + +Deletes the specified mobile network. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: MobileNetworkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkAttachedDataNetwork.md b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkAttachedDataNetwork.md new file mode 100644 index 0000000000..434bfc9dcc --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkAttachedDataNetwork.md @@ -0,0 +1,266 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/remove-azmobilenetworkattacheddatanetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkAttachedDataNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkAttachedDataNetwork.md +--- + +# Remove-AzMobileNetworkAttachedDataNetwork + +## SYNOPSIS +Deletes the specified attached data network. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMobileNetworkAttachedDataNetwork -Name <String> -PacketCoreControlPlaneName <String> + -PacketCoreDataPlaneName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMobileNetworkAttachedDataNetwork -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified attached data network. + +## EXAMPLES + +### Example 1: Deletes the specified attached data network. +```powershell +Remove-AzMobileNetworkAttachedDataNetwork -Name azps-mn-adn -PacketCoreControlPlaneName azps-mn-pccp -PacketCoreDataPlaneName azps-mn-pcdp -ResourceGroupName azps_test_group +``` + +Deletes the specified attached data network. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the attached data network. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AttachedDataNetworkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreControlPlaneName +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreDataPlaneName +The name of the packet core data plane. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkDataNetwork.md b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkDataNetwork.md new file mode 100644 index 0000000000..e694ec4215 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkDataNetwork.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/remove-azmobilenetworkdatanetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkDataNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkDataNetwork.md +--- + +# Remove-AzMobileNetworkDataNetwork + +## SYNOPSIS +Deletes the specified data network. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMobileNetworkDataNetwork -MobileNetworkName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMobileNetworkDataNetwork -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified data network. + +## EXAMPLES + +### Example 1: Deletes the specified data network. +```powershell +Remove-AzMobileNetworkDataNetwork -MobileNetworkName azps-mn -Name azps-mn-datanetwork -ResourceGroupName azps_test_group +``` + +Deletes the specified data network. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the data network. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DataNetworkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkPacketCoreControlPlane.md b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkPacketCoreControlPlane.md new file mode 100644 index 0000000000..dc5e5be1ee --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkPacketCoreControlPlane.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/remove-azmobilenetworkpacketcorecontrolplane +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkPacketCoreControlPlane.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkPacketCoreControlPlane.md +--- + +# Remove-AzMobileNetworkPacketCoreControlPlane + +## SYNOPSIS +Deletes the specified packet core control plane. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMobileNetworkPacketCoreControlPlane -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMobileNetworkPacketCoreControlPlane -InputObject <IMobileNetworkIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified packet core control plane. + +## EXAMPLES + +### Example 1: Deletes the specified packet core control plane. +```powershell +Remove-AzMobileNetworkPacketCoreControlPlane -Name azps-mn-pccp -ResourceGroupName azps_test_group +``` + +Deletes the specified packet core control plane. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: PacketCoreControlPlaneName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkPacketCoreDataPlane.md b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkPacketCoreDataPlane.md new file mode 100644 index 0000000000..0e5ccdacd2 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkPacketCoreDataPlane.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/remove-azmobilenetworkpacketcoredataplane +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkPacketCoreDataPlane.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkPacketCoreDataPlane.md +--- + +# Remove-AzMobileNetworkPacketCoreDataPlane + +## SYNOPSIS +Deletes the specified packet core data plane. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMobileNetworkPacketCoreDataPlane -Name <String> -PacketCoreControlPlaneName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMobileNetworkPacketCoreDataPlane -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified packet core data plane. + +## EXAMPLES + +### Example 1: Deletes the specified packet core data plane. +```powershell +Remove-AzMobileNetworkPacketCoreDataPlane -Name azps-mn-pcdp -PacketCoreControlPlaneName azps-mn-pccp -ResourceGroupName azps_test_group +``` + +Deletes the specified packet core data plane. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the packet core data plane. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: PacketCoreDataPlaneName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreControlPlaneName +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkService.md b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkService.md new file mode 100644 index 0000000000..846031cbf0 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkService.md @@ -0,0 +1,252 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/remove-azmobilenetworkservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkService.md +--- + +# Remove-AzMobileNetworkService + +## SYNOPSIS +Deletes the specified service. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMobileNetworkService -MobileNetworkName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMobileNetworkService -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified service. + +## EXAMPLES + +### Example 1: Deletes the specified service. +```powershell +Remove-AzMobileNetworkService -MobileNetworkName azps-mn -Name azps-mn-service -ResourceGroupName azps_test_group +``` + +Deletes the specified service. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service. +You must not use any of the following reserved strings - 'default', 'requested' or 'service' + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSim.md b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSim.md new file mode 100644 index 0000000000..903d038191 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSim.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/remove-azmobilenetworksim +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkSim.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkSim.md +--- + +# Remove-AzMobileNetworkSim + +## SYNOPSIS +Deletes the specified SIM. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMobileNetworkSim -GroupName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMobileNetworkSim -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified SIM. + +## EXAMPLES + +### Example 1: Deletes the specified SIM. +```powershell +Remove-AzMobileNetworkSim -GroupName azps-mn-simgroup -Name azps-mn-sim -ResourceGroupName azps_test_group +``` + +Deletes the specified SIM. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +The name of the SIM Group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SimGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the SIM. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SimName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSimGroup.md b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSimGroup.md new file mode 100644 index 0000000000..ebb1052722 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSimGroup.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/remove-azmobilenetworksimgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkSimGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkSimGroup.md +--- + +# Remove-AzMobileNetworkSimGroup + +## SYNOPSIS +Deletes the specified SIM group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMobileNetworkSimGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMobileNetworkSimGroup -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified SIM group. + +## EXAMPLES + +### Example 1: Deletes the specified SIM group. +```powershell +Remove-AzMobileNetworkSimGroup -Name azps-mn-simgroup -ResourceGroupName azps_test_group +``` + +Deletes the specified SIM group. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the SIM Group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SimGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSimPolicy.md b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSimPolicy.md new file mode 100644 index 0000000000..a3cd649bf0 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSimPolicy.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/remove-azmobilenetworksimpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkSimPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkSimPolicy.md +--- + +# Remove-AzMobileNetworkSimPolicy + +## SYNOPSIS +Deletes the specified SIM policy. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMobileNetworkSimPolicy -MobileNetworkName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMobileNetworkSimPolicy -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified SIM policy. + +## EXAMPLES + +### Example 1: Deletes the specified SIM policy. +```powershell +Remove-AzMobileNetworkSimPolicy -MobileNetworkName azps-mn -Name azps-mn-simpolicy -ResourceGroupName azps_test_group +``` + +Deletes the specified SIM policy. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the SIM policy. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SimPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSite.md b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSite.md new file mode 100644 index 0000000000..eeb207b5df --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSite.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/remove-azmobilenetworksite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkSite.md +--- + +# Remove-AzMobileNetworkSite + +## SYNOPSIS +Deletes the specified mobile network site. +This will also delete any network functions that are a part of this site. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMobileNetworkSite -MobileNetworkName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMobileNetworkSite -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified mobile network site. +This will also delete any network functions that are a part of this site. + +## EXAMPLES + +### Example 1: Deletes the specified mobile network site. +```powershell +Remove-AzMobileNetworkSite -MobileNetworkName azps-mn -Name azps-mn-site -ResourceGroupName azps_test_group +``` + +Deletes the specified mobile network site. +This will also delete any network functions that are a part of this site. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the mobile network site. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SiteName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSlice.md b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSlice.md new file mode 100644 index 0000000000..8ce6685cd1 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Remove-AzMobileNetworkSlice.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/remove-azmobilenetworkslice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkSlice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Remove-AzMobileNetworkSlice.md +--- + +# Remove-AzMobileNetworkSlice + +## SYNOPSIS +Deletes the specified network slice. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMobileNetworkSlice -MobileNetworkName <String> -ResourceGroupName <String> -SliceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMobileNetworkSlice -InputObject <IMobileNetworkIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified network slice. + +## EXAMPLES + +### Example 1: Deletes the specified network slice. +```powershell +Remove-AzMobileNetworkSlice -MobileNetworkName azps-mn -ResourceGroupName azps_test_group -SliceName azps-mn-slice +``` + +Deletes the specified network slice. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SliceName +The name of the network slice. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Trace-AzMobileNetworkCollectPacketCoreControlPlaneDiagnosticPackage.md b/azps-10.1.0/Az.MobileNetwork/Trace-AzMobileNetworkCollectPacketCoreControlPlaneDiagnosticPackage.md new file mode 100644 index 0000000000..13f21f042f --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Trace-AzMobileNetworkCollectPacketCoreControlPlaneDiagnosticPackage.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/trace-azmobilenetworkcollectpacketcorecontrolplanediagnosticpackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Trace-AzMobileNetworkCollectPacketCoreControlPlaneDiagnosticPackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Trace-AzMobileNetworkCollectPacketCoreControlPlaneDiagnosticPackage.md +--- + +# Trace-AzMobileNetworkCollectPacketCoreControlPlaneDiagnosticPackage + +## SYNOPSIS +Collect a diagnostics package for the specified packet core control plane. +This action will upload the diagnostics to a storage account. + +## SYNTAX + +### CollectExpanded (Default) +``` +Trace-AzMobileNetworkCollectPacketCoreControlPlaneDiagnosticPackage -PacketCoreControlPlaneName <String> + -ResourceGroupName <String> -StorageAccountBlobUrl <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CollectViaIdentityExpanded +``` +Trace-AzMobileNetworkCollectPacketCoreControlPlaneDiagnosticPackage -InputObject <IMobileNetworkIdentity> + -StorageAccountBlobUrl <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Collect a diagnostics package for the specified packet core control plane. +This action will upload the diagnostics to a storage account. + +## EXAMPLES + +### Example 1: Collect a diagnostics package for the specified packet core control plane. +```powershell +Trace-AzMobileNetworkCollectPacketCoreControlPlaneDiagnosticPackage -PacketCoreControlPlaneName azps-mn-pccp -ResourceGroupName azps_test_group -StorageAccountBlobUrl https://azpsstorage.blob.core.windows.net/testdiag/test +``` + +Collect a diagnostics package for the specified packet core control plane. +This action will upload the diagnostics to a storage account. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: CollectViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreControlPlaneName +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: CollectExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CollectExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountBlobUrl +The Storage Account Blob URL to upload the diagnostics package to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: CollectExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IAsyncOperationStatus + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetwork.md b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetwork.md new file mode 100644 index 0000000000..a99d81525b --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetwork.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/update-azmobilenetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetwork.md +--- + +# Update-AzMobileNetwork + +## SYNOPSIS +Updates mobile network tags. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMobileNetwork -MobileNetworkName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMobileNetwork -InputObject <IMobileNetworkIdentity> [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates mobile network tags. + +## EXAMPLES + +### Example 1: Updates mobile network tags. +```powershell +Update-AzMobileNetwork -MobileNetworkName azps-mn -ResourceGroupName azps_test_group -Tag @{"123"="abc"} +``` + +```output +Location Name ResourceGroupName PublicLandMobileNetworkIdentifierMcc PublicLandMobileNetworkIdentifierMnc +-------- ---- ----------------- ------------------------------------ ------------------------------------ +eastus azps-mn azps_test_group 001 01 +``` + +Updates mobile network tags. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IMobileNetwork + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkAttachedDataNetwork.md b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkAttachedDataNetwork.md new file mode 100644 index 0000000000..f05f5d95bc --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkAttachedDataNetwork.md @@ -0,0 +1,457 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/update-azmobilenetworkattacheddatanetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkAttachedDataNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkAttachedDataNetwork.md +--- + +# Update-AzMobileNetworkAttachedDataNetwork + +## SYNOPSIS +Updates an attached data network. + +## SYNTAX + +``` +Update-AzMobileNetworkAttachedDataNetwork -AttachedDataNetworkName <String> + -PacketCoreControlPlaneName <String> -PacketCoreDataPlaneName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DnsAddress <String[]>] [-NaptConfigurationEnabled <NaptEnabled>] + [-NaptConfigurationPinholeLimit <Int32>] [-PinholeTimeoutIcmp <Int32>] [-PinholeTimeoutTcp <Int32>] + [-PinholeTimeoutUdp <Int32>] [-PortRangeMaxPort <Int32>] [-PortRangeMinPort <Int32>] + [-PortReuseHoldTimeTcp <Int32>] [-PortReuseHoldTimeUdp <Int32>] [-Tag <Hashtable>] + [-UserEquipmentAddressPoolPrefix <String[]>] [-UserEquipmentStaticAddressPoolPrefix <String[]>] + [-UserPlaneDataInterfaceIpv4Address <String>] [-UserPlaneDataInterfaceIpv4Gateway <String>] + [-UserPlaneDataInterfaceIpv4Subnet <String>] [-UserPlaneDataInterfaceName <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an attached data network. + +## EXAMPLES + +### Example 1: Updates an attached data network. +```powershell +Update-AzMobileNetworkAttachedDataNetwork -AttachedDataNetworkName azps-mn-adn -PacketCoreControlPlaneName azps-mn-pccp -PacketCoreDataPlaneName azps_test_group -ResourceGroupName -Tag @{"abc"="123"} +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-adn azps_test_group Succeeded +``` + +Updates an attached data network. + +## PARAMETERS + +### -AttachedDataNetworkName +The name of the attached data network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsAddress +The DNS servers to signal to UEs to use for this attached data network. +This configuration is mandatory - if you don't want DNS servers, you must provide an empty array. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NaptConfigurationEnabled +Whether NAPT is enabled for connections to this attached data network. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.NaptEnabled +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NaptConfigurationPinholeLimit +Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. +For 5G networks, this is the N6 interface. +For 4G networks, this is the SGi interface. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreControlPlaneName +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreDataPlaneName +The name of the packet core data plane. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinholeTimeoutIcmp +Pinhole timeout for ICMP pinholes in seconds. +Default for ICMP Echo is 30 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinholeTimeoutTcp +Pinhole timeout for TCP pinholes in seconds. +Default for TCP is 3 minutes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinholeTimeoutUdp +Pinhole timeout for UDP pinholes in seconds. +Default for UDP is 30 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PortRangeMaxPort +The maximum port number + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PortRangeMinPort +The minimum port number + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PortReuseHoldTimeTcp +Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. +Default for TCP is 2 minutes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PortReuseHoldTimeUdp +Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. +Default for UDP is 1 minute. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEquipmentAddressPoolPrefix +The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will dynamically assign IP addresses to UEs.The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. +You must define at least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix. +If you define both, they must be of the same size. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEquipmentStaticAddressPoolPrefix +The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will assign static IP addresses to UEs.The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. +The static IP address for a specific UE is set in StaticIPConfiguration on the corresponding SIM resource.At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. +If both are defined, they must be of the same size. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneDataInterfaceIpv4Address +The IPv4 address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneDataInterfaceIpv4Gateway +The default IPv4 gateway (router). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneDataInterfaceIpv4Subnet +The IPv4 subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneDataInterfaceName +The logical name for this interface. +This should match one of the interfaces configured on your Azure Stack Edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IAttachedDataNetwork + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkDataNetwork.md b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkDataNetwork.md new file mode 100644 index 0000000000..c80ed525e4 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkDataNetwork.md @@ -0,0 +1,197 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/update-azmobilenetworkdatanetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkDataNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkDataNetwork.md +--- + +# Update-AzMobileNetworkDataNetwork + +## SYNOPSIS +Updates data network. + +## SYNTAX + +``` +Update-AzMobileNetworkDataNetwork -DataNetworkName <String> -MobileNetworkName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-Description <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates data network. + +## EXAMPLES + +### Example 1: Updates data network. +```powershell +Update-AzMobileNetworkDataNetwork -MobileNetworkName azps-mn -DataNetworkName azps-mn-datanetwork -ResourceGroupName azps_test_group -Tag @{"abc"="12"} +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-datanetwork azps_test_group Succeeded +``` + +Updates data network. + +## PARAMETERS + +### -DataNetworkName +The name of the data network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +An optional description for this data network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IDataNetwork + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkPacketCoreControlPlane.md b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkPacketCoreControlPlane.md new file mode 100644 index 0000000000..f1e64b4a13 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkPacketCoreControlPlane.md @@ -0,0 +1,476 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/update-azmobilenetworkpacketcorecontrolplane +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkPacketCoreControlPlane.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkPacketCoreControlPlane.md +--- + +# Update-AzMobileNetworkPacketCoreControlPlane + +## SYNOPSIS +Updates packet core control planes. + +## SYNTAX + +``` +Update-AzMobileNetworkPacketCoreControlPlane -PacketCoreControlPlaneName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AzureStackEdgeDeviceId <String>] [-AzureStackHciClusterId <String>] + [-ConnectedClusterId <String>] [-ControlPlaneAccessInterfaceIpv4Address <String>] + [-ControlPlaneAccessInterfaceIpv4Gateway <String>] [-ControlPlaneAccessInterfaceIpv4Subnet <String>] + [-ControlPlaneAccessInterfaceName <String>] [-CoreNetworkTechnology <CoreNetworkType>] + [-CustomLocationId <String>] [-HttpsServerCertificateUrl <String>] + [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] + [-InteropSetting <Hashtable>] [-LocalDiagnosticAccessAuthenticationType <AuthenticationType>] + [-PlatformType <PlatformType>] [-Site <ISiteResourceId[]>] [-Sku <BillingSku>] [-Tag <Hashtable>] + [-UeMtu <Int32>] [-Version <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates packet core control planes. + +## EXAMPLES + +### Example 1: Updates packet core control planes. +```powershell +Update-AzMobileNetworkPacketCoreControlPlane -PacketCoreControlPlaneName azps-mn-pccp -ResourceGroupName azps_test_group -Tag @{"abc"="123"} +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-pccp azps_test_group Succeeded +``` + +Updates packet core control planes. + +## PARAMETERS + +### -AzureStackEdgeDeviceId +Azure Stack Edge device resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureStackHciClusterId +Azure Stack HCI cluster resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedClusterId +Azure Arc connected cluster resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlPlaneAccessInterfaceIpv4Address +The IPv4 address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlPlaneAccessInterfaceIpv4Gateway +The default IPv4 gateway (router). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlPlaneAccessInterfaceIpv4Subnet +The IPv4 subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ControlPlaneAccessInterfaceName +The logical name for this interface. +This should match one of the interfaces configured on your Azure Stack Edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CoreNetworkTechnology +The core network technology generation (5G core or EPC / 4G core). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.CoreNetworkType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomLocationId +Azure Arc custom location resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsServerCertificateUrl +The certificate URL, unversioned. +For example: https://contosovault.vault.azure.net/certificates/ingress. + +```yaml +Type: System.String +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InteropSetting +Settings to allow interoperability with third party components e.g. +RANs and UEs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalDiagnosticAccessAuthenticationType +How to authenticate users who access local diagnostics APIs. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.AuthenticationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreControlPlaneName +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlatformType +The platform type where packet core is deployed. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.PlatformType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Site +Site(s) under which this packet core control plane should be deployed. +The sites must be in the same location as the packet core control plane. +To construct, see NOTES section for SITE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISiteResourceId[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SKU defining the throughput and SIM allowances for this packet core control plane deployment. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.BillingSku +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UeMtu +The MTU (in bytes) signaled to the UE. +The same MTU is set on the user plane data links for all data networks. +The MTU set on the user plane access link is calculated to be 60 bytes greater than this value to allow for GTP encapsulation. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +The version of the packet core software that is deployed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IPacketCoreControlPlane + +## 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. + + +`SITE <ISiteResourceId[]>`: Site(s) under which this packet core control plane should be deployed. The sites must be in the same location as the packet core control plane. + - `Id <String>`: Site resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkPacketCoreDataPlane.md b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkPacketCoreDataPlane.md new file mode 100644 index 0000000000..b36301e078 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkPacketCoreDataPlane.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/update-azmobilenetworkpacketcoredataplane +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkPacketCoreDataPlane.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkPacketCoreDataPlane.md +--- + +# Update-AzMobileNetworkPacketCoreDataPlane + +## SYNOPSIS +Updates packet core data planes. + +## SYNTAX + +``` +Update-AzMobileNetworkPacketCoreDataPlane -PacketCoreControlPlaneName <String> + -PacketCoreDataPlaneName <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Tag <Hashtable>] + [-UserPlaneAccessInterfaceIpv4Address <String>] [-UserPlaneAccessInterfaceIpv4Gateway <String>] + [-UserPlaneAccessInterfaceIpv4Subnet <String>] [-UserPlaneAccessInterfaceName <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates packet core data planes. + +## EXAMPLES + +### Example 1: Updates packet core data planes. +```powershell +Update-AzMobileNetworkPacketCoreDataPlane -PacketCoreControlPlaneName azps-mn-pccp -PacketCoreDataPlaneName azps-mn-pcdp -ResourceGroupName azps_test_group -Tag @{"abc"="123"} +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-pcdp azps_test_group Succeeded +``` + +Updates packet core data planes. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreControlPlaneName +The name of the packet core control plane. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacketCoreDataPlaneName +The name of the packet core data plane. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneAccessInterfaceIpv4Address +The IPv4 address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneAccessInterfaceIpv4Gateway +The default IPv4 gateway (router). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneAccessInterfaceIpv4Subnet +The IPv4 subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPlaneAccessInterfaceName +The logical name for this interface. +This should match one of the interfaces configured on your Azure Stack Edge device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IPacketCoreDataPlane + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkService.md b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkService.md new file mode 100644 index 0000000000..cea5f28695 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkService.md @@ -0,0 +1,346 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/update-azmobilenetworkservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkService.md +--- + +# Update-AzMobileNetworkService + +## SYNOPSIS +Updates service. + +## SYNTAX + +``` +Update-AzMobileNetworkService -MobileNetworkName <String> -ResourceGroupName <String> -ServiceName <String> + -ServicePrecedence <Int32> [-SubscriptionId <String>] [-MaximumBitRateDownlink <String>] + [-MaximumBitRateUplink <String>] [-PccRule <IPccRuleConfiguration[]>] + [-ServiceQoPolicyAllocationAndRetentionPriorityLevel <Int32>] [-ServiceQoPolicyFiveQi <Int32>] + [-ServiceQoPolicyPreemptionCapability <PreemptionCapability>] + [-ServiceQoPolicyPreemptionVulnerability <PreemptionVulnerability>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates service. + +## EXAMPLES + +### Example 1: Updates service. +```powershell +Update-AzMobileNetworkService -MobileNetworkName azps-mn -ServiceName azps-mn-service -ResourceGroupName azps_test_group -Tag @{"abc"="123"} -ServicePrecedence 0 +``` + +```output +Location Name ResourceGroupName ProvisioningState Precedence MaximumBitRateDownlink MaximumBitRateUplink QoPolicyAllocationAndRetentionPriorityLevel QoPolicyFiveQi +-------- ---- ----------------- ----------------- ---------- ---------------------- -------------------- ------------------------------------------- -------------- +eastus azps-mn-service azps_test_group Succeeded 0 1 Gbps 500 Mbps 9 9 +``` + +Updates service. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumBitRateDownlink +Downlink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumBitRateUplink +Uplink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PccRule +The set of data flow policy rules that make up this service. +To construct, see NOTES section for PCCRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IPccRuleConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the service. +You must not use any of the following reserved strings - 'default', 'requested' or 'service' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrecedence +A precedence value that is used to decide between services when identifying the QoS values to use for a particular SIM. +A lower value means a higher priority. +This value should be unique among all services configured in the mobile network. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceQoPolicyAllocationAndRetentionPriorityLevel +QoS Flow allocation and retention priority (ARP) level. +Flows with higher priority preempt flows with lower priority, if the settings of `preemptionCapability` and `preemptionVulnerability` allow it. +1 is the highest level of priority. +If this field is not specified then `5qi` is used to derive the ARP value. +See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceQoPolicyFiveQi +QoS Flow 5G QoS Indicator value. +The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. +This must not be a standardized 5QI value corresponding to a GBR (guaranteed bit rate) QoS Flow. +The illegal GBR 5QI values are: 1, 2, 3, 4, 65, 66, 67, 71, 72, 73, 74, 75, 76, 82, 83, 84, and 85. +See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5QI parameter, and table 5.7.4-1 for the definition of which are the GBR 5QI values. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceQoPolicyPreemptionCapability +QoS Flow preemption capability. +The preemption capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. +See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.PreemptionCapability +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceQoPolicyPreemptionVulnerability +QoS Flow preemption vulnerability. +The preemption vulnerability of a QoS Flow controls whether it can be preempted by a QoS Flow with a higher priority level. +See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.PreemptionVulnerability +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.IService + +## 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. + + +`PCCRULE <IPccRuleConfiguration[]>`: The set of data flow policy rules that make up this service. + - `RuleName <String>`: The name of the rule. This must be unique within the parent service. You must not use any of the following reserved strings - 'default', 'requested' or 'service'. + - `RulePrecedence <Int32>`: A precedence value that is used to decide between data flow policy rules when identifying the QoS values to use for a particular SIM. A lower value means a higher priority. This value should be unique among all data flow policy rules configured in the mobile network. + - `ServiceDataFlowTemplate <IServiceDataFlowTemplate[]>`: The set of data flow templates to use for this data flow policy rule. + - `Direction <SdfDirection>`: The direction of this flow. + - `Protocol <String[]>`: A list of the allowed protocol(s) for this flow. If you want this flow to be able to use any protocol within the internet protocol suite, use the value `ip`. If you only want to allow a selection of protocols, you must use the corresponding IANA Assigned Internet Protocol Number for each protocol, as described in https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. For example, for UDP, you must use 17. If you use the value `ip` then you must leave the field `port` unspecified. + - `RemoteIPList <String[]>`: The remote IP address(es) to which UEs will connect for this flow. If you want to allow connections on any IP address, use the value 'any'. Otherwise, you must provide each of the remote IP addresses to which the packet core instance will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). + - `TemplateName <String>`: The name of the data flow template. This must be unique within the parent data flow policy rule. You must not use any of the following reserved strings - 'default', 'requested' or 'service'. + - `[Port <String[]>]`: The port(s) to which UEs will connect for this flow. You can specify zero or more ports or port ranges. If you specify one or more ports or port ranges then you must specify a value other than `ip` in the `protocol` field. This is an optional setting. If you do not specify it then connections will be allowed on all ports. Port ranges must be specified as <FirstPort>-<LastPort>. For example: [`8080`, `8082-8085`]. + - `[GuaranteedBitRateDownlink <String>]`: Downlink bit rate. + - `[GuaranteedBitRateUplink <String>]`: Uplink bit rate. + - `[RuleQoPolicyAllocationAndRetentionPriorityLevel <Int32?>]`: QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority, if the settings of `preemptionCapability` and `preemptionVulnerability` allow it. 1 is the highest level of priority. If this field is not specified then `5qi` is used to derive the ARP value. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `[RuleQoPolicyFiveQi <Int32?>]`: 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5QI parameter, and table 5.7.4-1 for the definition the 5QI values. + - `[RuleQoPolicyMaximumBitRateDownlink <String>]`: Downlink bit rate. + - `[RuleQoPolicyMaximumBitRateUplink <String>]`: Uplink bit rate. + - `[RuleQoPolicyPreemptionCapability <PreemptionCapability?>]`: QoS Flow preemption capability. The preemption capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `[RuleQoPolicyPreemptionVulnerability <PreemptionVulnerability?>]`: QoS Flow preemption vulnerability. The preemption vulnerability of a QoS Flow controls whether it can be preempted by a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `[TrafficControl <TrafficControlPermission?>]`: Determines whether flows that match this data flow policy rule are permitted. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkSimGroup.md b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkSimGroup.md new file mode 100644 index 0000000000..d1243a684a --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkSimGroup.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/update-azmobilenetworksimgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkSimGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkSimGroup.md +--- + +# Update-AzMobileNetworkSimGroup + +## SYNOPSIS +Updates SIM group. + +## SYNTAX + +``` +Update-AzMobileNetworkSimGroup -ResourceGroupName <String> -SimGroupName <String> [-SubscriptionId <String>] + [-EncryptionKeyUrl <String>] [-IdentityType <ManagedServiceIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-MobileNetworkId <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates SIM group. + +## EXAMPLES + +### Example 1: Updates SIM group. +```powershell +Update-AzMobileNetworkSimGroup -SimGroupName azps-mn-simgroup -ResourceGroupName azps_test_group -Tag @{"abc"="123"} +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-simgroup azps_test_group Succeeded +``` + +Updates SIM group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyUrl +The key URL, unversioned. +For example: https://contosovault.vault.azure.net/keys/azureKey. + +```yaml +Type: System.String +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileNetworkId +Mobile network resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimGroupName +The name of the SIM Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISimGroup + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkSimPolicy.md b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkSimPolicy.md new file mode 100644 index 0000000000..49b328865b --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkSimPolicy.md @@ -0,0 +1,299 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/update-azmobilenetworksimpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkSimPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkSimPolicy.md +--- + +# Update-AzMobileNetworkSimPolicy + +## SYNOPSIS +Updates SIM policy. + +## SYNTAX + +``` +Update-AzMobileNetworkSimPolicy -MobileNetworkName <String> -ResourceGroupName <String> + -SimPolicyName <String> [-SubscriptionId <String>] [-DefaultSliceId <String>] [-RegistrationTimer <Int32>] + [-RfspIndex <Int32>] [-SliceConfiguration <ISliceConfiguration[]>] [-Tag <Hashtable>] + [-UeAmbrDownlink <String>] [-UeAmbrUplink <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates SIM policy. + +## EXAMPLES + +### Example 1: Updates SIM policy. +```powershell +Update-AzMobileNetworkSimPolicy -MobileNetworkName azps-mn -SimPolicyName azps-mn-simpolicy -ResourceGroupName azps_test_group -Tag @{"abc"="123"} +``` + +```output +Location Name ResourceGroupName ProvisioningState RegistrationTimer UeAmbrDownlink UeAmbrUplink +-------- ---- ----------------- ----------------- ----------------- -------------- ------------ +eastus azps-mn-simpolicy azps_test_group Succeeded 3240 1 Gbps 500 Mbps +``` + +Updates SIM policy. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSliceId +Slice resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegistrationTimer +Interval for the UE periodic registration update procedure, in seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RfspIndex +RAT/Frequency Selection Priority Index, defined in 3GPP TS 36.413. +This is an optional setting and by default is unspecified. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimPolicyName +The name of the SIM policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SliceConfiguration +The allowed slices and the settings to use for them. +The list must not contain duplicate items and must contain at least one item. +To construct, see NOTES section for SLICECONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISliceConfiguration[] +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UeAmbrDownlink +Downlink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UeAmbrUplink +Uplink bit rate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISimPolicy + +## 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. + + +`SLICECONFIGURATION <ISliceConfiguration[]>`: The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item. + - `DataNetworkConfiguration <IDataNetworkConfiguration[]>`: The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. + - `AllowedService <IServiceResourceId[]>`: List of services that can be used as part of this SIM policy. The list must not contain duplicate items and must contain at least one item. The services must be in the same location as the SIM policy. + - `Id <String>`: Service resource ID. + - `DataNetworkId <String>`: Data network resource ID. + - `SessionAmbrDownlink <String>`: Downlink bit rate. + - `SessionAmbrUplink <String>`: Uplink bit rate. + - `[AdditionalAllowedSessionType <PduSessionType[]>]`: Allowed session types in addition to the default session type. Must not duplicate the default session type. + - `[AllocationAndRetentionPriorityLevel <Int32?>]`: Default QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority, if the settings of `preemptionCapability` and `preemptionVulnerability` allow it. 1 is the highest level of priority. If this field is not specified then `5qi` is used to derive the ARP value. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `[DefaultSessionType <PduSessionType?>]`: The default PDU session type, which is used if the UE does not request a specific session type. + - `[FiveQi <Int32?>]`: Default 5G QoS Flow Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5QI parameter, and table 5.7.4-1 for the definition the 5QI values. + - `[MaximumNumberOfBufferedPacket <Int32?>]`: The maximum number of downlink packets to buffer at the user plane for High Latency Communication - Extended Buffering. See 3GPP TS29.272 v15.10.0 section 7.3.188 for a full description. This maximum is not guaranteed because there is a internal limit on buffered packets across all PDU sessions. + - `[PreemptionCapability <PreemptionCapability?>]`: Default QoS Flow preemption capability. The preemption capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `[PreemptionVulnerability <PreemptionVulnerability?>]`: Default QoS Flow preemption vulnerability. The preemption vulnerability of a QoS Flow controls whether it can be preempted by a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. + - `DefaultDataNetworkId <String>`: Data network resource ID. + - `SlouseId <String>`: Slice resource ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkSite.md b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkSite.md new file mode 100644 index 0000000000..943c5dc562 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkSite.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/update-azmobilenetworksite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkSite.md +--- + +# Update-AzMobileNetworkSite + +## SYNOPSIS +Updates site tags. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMobileNetworkSite -MobileNetworkName <String> -ResourceGroupName <String> -SiteName <String> + [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMobileNetworkSite -InputObject <IMobileNetworkIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates site tags. + +## EXAMPLES + +### Example 1: Updates site tags. +```powershell +Update-AzMobileNetworkSite -MobileNetworkName azps-mn -SiteName azps-mn-site -ResourceGroupName azps_test_group -Tag @{"site"="123"} +``` + +```output +Location Name ResourceGroupName ProvisioningState +-------- ---- ----------------- ----------------- +eastus azps-mn-site azps_test_group Succeeded +``` + +Updates site tags. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteName +The name of the mobile network site. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISite + +## 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 <IMobileNetworkIdentity>`: Identity Parameter + - `[AttachedDataNetworkName <String>]`: The name of the attached data network. + - `[DataNetworkName <String>]`: The name of the data network. + - `[Id <String>]`: Resource identity path + - `[MobileNetworkName <String>]`: The name of the mobile network. + - `[PacketCoreControlPlaneName <String>]`: The name of the packet core control plane. + - `[PacketCoreDataPlaneName <String>]`: The name of the packet core data plane. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ServiceName <String>]`: The name of the service. You must not use any of the following reserved strings - 'default', 'requested' or 'service' + - `[SimGroupName <String>]`: The name of the SIM Group. + - `[SimName <String>]`: The name of the SIM. + - `[SimPolicyName <String>]`: The name of the SIM policy. + - `[SiteName <String>]`: The name of the mobile network site. + - `[SliceName <String>]`: The name of the network slice. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VersionName <String>]`: The name of the packet core control plane version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkSlice.md b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkSlice.md new file mode 100644 index 0000000000..c7346fd3e7 --- /dev/null +++ b/azps-10.1.0/Az.MobileNetwork/Update-AzMobileNetworkSlice.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.MobileNetwork +online version: https://learn.microsoft.com/powershell/module/az.mobilenetwork/update-azmobilenetworkslice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkSlice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MobileNetwork/help/Update-AzMobileNetworkSlice.md +--- + +# Update-AzMobileNetworkSlice + +## SYNOPSIS +Updates slice. + +## SYNTAX + +``` +Update-AzMobileNetworkSlice -MobileNetworkName <String> -ResourceGroupName <String> -SliceName <String> + -SnssaiSst <Int32> [-SubscriptionId <String>] [-Description <String>] [-SnssaiSd <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates slice. + +## EXAMPLES + +### Example 1: Updates slice. +```powershell +Update-AzMobileNetworkSlice -MobileNetworkName azps-mn -ResourceGroupName azps_test_group -SliceName azps-mn-slice -Tag @{"abc"="123"} -SnssaiSst 1 +``` + +```output +Location Name ResourceGroupName ProvisioningState SnssaiSst SnssaiSd +-------- ---- ----------------- ----------------- --------- -------- +eastus azps-mn-slice azps_test_group Succeeded 1 1abcde +``` + +Updates slice. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +An optional description for this network slice. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileNetworkName +The name of the mobile network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SliceName +The name of the network slice. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnssaiSd +Slice differentiator (SD). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnssaiSst +Slice/service type (SST). + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.IMobileNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.Models.Api20221101.ISlice + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Monitor/Add-AzLogProfile.md b/azps-10.1.0/Az.Monitor/Add-AzLogProfile.md new file mode 100644 index 0000000000..d5cdcdf4b6 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Add-AzLogProfile.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: 18D5B95E-4CF1-4C79-AE8B-9F4DA49B46A9 +online version: https://learn.microsoft.com/powershell/module/az.monitor/add-azlogprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Add-AzLogProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Add-AzLogProfile.md +--- + +# Add-AzLogProfile + +## SYNOPSIS +Creates a new activity log profile. This profile is used to either archive the activity log to an Azure storage account or stream it to an Azure event hub in the same subscription. + +## SYNTAX + +``` +Add-AzLogProfile -Name <String> [-StorageAccountId <String>] [-ServiceBusRuleId <String>] + [-RetentionInDays <Int32>] -Location <System.Collections.Generic.List`1[System.String]> + [-Category <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzLogProfile** cmdlet creates a log profile. +- **Storage Account** - Only standard storage account (premium storage account is not supported) is supported. It could either be of type ARM or Classic. If it's logged to a storage account, the cost of storing the activity log is billed at normal standard storage rates. There could be only one log profile per subscription consequentially only one storage account per subscription can be used to export activity log. +- **Event Hub** - There could be only one log profile per subscription consequentially only one event hub per subscription can be used to export activity log. If activity log is streamed to an event hub, standard event hub pricing will apply. +In the activity log, events can pertain to a region or could be "Global". Global essentially means these events are region agnostics and are independent of region, in fact majority of events fall into this category. If the activity log profile is set from the portal, it implicitly adds "Global" along with any other region selected in the user interface. When using the cmdlet, the location as "Global" must be explicitly mentioned apart from any other region. +**Note** :- **Failing to set "Global" in the locations will result in a majority of activity log not getting exported.** +This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. + +## EXAMPLES + +### Example 1: Add a new log profile to export the activity log matching the location condition to a storage account +```powershell +Add-AzLogProfile -Location "Global","West US" -Name ExportLogProfile -StorageAccountId /subscriptions/40gpe80s-9sb7-4f07-9042-b1b6a92ja9fk/resourceGroups/activitylogRG/providers/Microsoft.Storage/storageAccounts/activitylogstorageaccount +``` + +Add a new log profile to export the activity log matching the location condition to a storage account + +### Example 2 + +Creates a new activity log profile. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Add-AzLogProfile -Location 'Global' -Name ExportLogProfile -RetentionInDays <Int32> -ServiceBusRuleId <String> -StorageAccountId /subscriptions/40gpe80s-9sb7-4f07-9042-b1b6a92ja9fk/resourceGroups/activitylogRG/providers/Microsoft.Storage/storageAccounts/activitylogstorageaccount +``` + +## PARAMETERS + +### -Category +Specifies the list of categories. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the log profile. +Valid values: Run below cmdlet to get the latest list of locations. +Get-AzLocation | Select DisplayName + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionInDays +Specifies the retention policy, in days. This is the number of days the logs are preserved in the storage account specified. To retain the data forever set this to **0**. If it's not specified, then it defaults to **0**. Normal standard storage or event hub billing rates will apply for data retention. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceBusRuleId +Specifies the ID of the Service Bus rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountId +Specifies the ID of the Storage account. ID is the fully qualified Resource ID of the storage account for example +/subscriptions/40gpe80s-9sb7-4f07-9042-b1b6a92ja9fk/resourceGroups/activitylogRG/providers/Microsoft.Storage/storageAccounts/activitylogstorageaccount + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSLogProfile + +## NOTES + +## RELATED LINKS + +[Get-AzLogProfile](./Get-AzLogProfile.md) + +[Remove-AzLogProfile](./Remove-AzLogProfile.md) + + diff --git a/azps-10.1.0/Az.Monitor/Add-AzMetricAlertRule.md b/azps-10.1.0/Az.Monitor/Add-AzMetricAlertRule.md new file mode 100644 index 0000000000..1d4663f0a1 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Add-AzMetricAlertRule.md @@ -0,0 +1,349 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: A90564B5-57D7-48EB-976D-38C03D930289 +online version: https://learn.microsoft.com/powershell/module/az.monitor/add-azmetricalertrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Add-AzMetricAlertRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Add-AzMetricAlertRule.md +--- + +# Add-AzMetricAlertRule + +## SYNOPSIS +Adds or updates a claasic metric-based alert rule (already retired on public cloud). To create a new metric alert rule, use the [Add-AzMetricAlertRuleV2](./Add-AzMetricAlertRuleV2.md) cmdlet. + +## SYNTAX + +``` +Add-AzMetricAlertRule -WindowSize <TimeSpan> -Operator <ConditionOperator> -Threshold <Double> + -TargetResourceId <String> -MetricName <String> -TimeAggregationOperator <TimeAggregationOperator> + -Location <String> [-Description <String>] [-DisableRule] -ResourceGroupName <String> -Name <String> + [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzMetricAlertRule** cmdlet adds or updates a metric-based alert rule. +The added rule is associated with a resource group and has a name. +This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. + +## EXAMPLES + +### Example 1: Add a metric alert rule to a website +```powershell +Add-AzMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup "Default-Web-EastUS" -Operator GreaterThan -Threshold 2 -WindowSize 00:05:00 -MetricName "Requests" -Description "Pura Vida" -TimeAggregationOperator Total +``` + +```output +RequestId StatusCode +--------- ---------- +33574ccf-0b01-43b4-aa97-87e6bbcf1c11 Created +``` + +This command creates a metric alert rule for a website. + +### Example 2: Disable a rule +```powershell +Add-AzMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup Default-Web-EastUS -Operator GreaterThan -Threshold 2 -WindowSize 00:05:00 -MetricName "Requests" -TimeAggregationOperator Total +``` + +```output +RequestId StatusCode +--------- ---------- +96c489f1-8529-46e1-a76d-2c1463ca3116 OK +``` + +This command disables a rule. +If the rule does not exist, it creates it disabled. +If the rule exists, then it just disables it. + +### Example 3: Add a rule with actions +```powershell +Add-AzMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup "Default-Web-EastUS" -Operator GreaterThan -Threshold 1 -TargetResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -MetricName "Requests" -TimeAggregationOperator Total +``` + +```output +RequestId StatusCode +--------- ---------- +9a5bc388-c7ac-4dc6-aa70-f4bc29c2c712 OK +``` + +This command creates a metric alert rule for a website. + +## PARAMETERS + +### -Action +Specifies a comma-separated list of actions. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description of the rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisableRule +Disables the rule. +If you do not specify this parameter, the rule is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the location where the rule is defined. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MetricName +Specifies the name of the metric the rule is monitoring. +Specify this parameter only for metric-based rules. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Operator +Specifies the relational operator for the condition of the rule. +The acceptable values for this parameter are: +- GreaterThan +- GreaterThanOrEqual +- LessThan +- LessThanOrEqual + +```yaml +Type: Microsoft.Azure.Management.Monitor.Management.Models.ConditionOperator +Parameter Sets: (All) +Aliases: +Accepted values: GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for the rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceId +Specifies the ID of the resource the rule is monitoring. NOTE: This property cannot be updated for an existing alert rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Threshold +Specifies the threshold of the rule. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TimeAggregationOperator +Specifies the aggregation operator to apply to the time window when the rule is being evaluated. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Monitor.Management.Models.TimeAggregationOperator] +Parameter Sets: (All) +Aliases: +Accepted values: Average, Minimum, Maximum, Total, Last + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WindowSize +Specifies the time window size for the rule to compute its data. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.TimeSpan + +### Microsoft.Azure.Management.Monitor.Management.Models.ConditionOperator + +### System.Double + +### System.String + +### System.Nullable`1[[Microsoft.Azure.Management.Monitor.Management.Models.TimeAggregationOperator, Microsoft.Azure.PowerShell.Cmdlets.Monitor, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +### System.Management.Automation.SwitchParameter + +### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction, Microsoft.Azure.PowerShell.Cmdlets.Monitor, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSAddAlertRuleOperationResponse + +## NOTES + +## RELATED LINKS + +[Add-AzWebtestAlertRule](./Add-AzWebtestAlertRule.md) + +[Get-AzAlertHistory](./Get-AzAlertHistory.md) + +[Get-AzAlertRule](./Get-AzAlertRule.md) + +[New-AzAlertRuleEmail](./New-AzAlertRuleEmail.md) + +[New-AzAlertRuleWebhook](./New-AzAlertRuleWebhook.md) + +[Remove-AzAlertRule](./Remove-AzAlertRule.md) + + diff --git a/azps-10.1.0/Az.Monitor/Add-AzMetricAlertRuleV2.md b/azps-10.1.0/Az.Monitor/Add-AzMetricAlertRuleV2.md new file mode 100644 index 0000000000..7a113f8caa --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Add-AzMetricAlertRuleV2.md @@ -0,0 +1,459 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/add-azmetricalertrulev2 +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Add-AzMetricAlertRuleV2.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Add-AzMetricAlertRuleV2.md +--- + +# Add-AzMetricAlertRuleV2 + +## SYNOPSIS +Adds or updates a V2 (non-classic) metric-based alert rule. + +## SYNTAX + +### CreateAlertByResourceId (Default) +``` +Add-AzMetricAlertRuleV2 -Name <String> -ResourceGroupName <String> -WindowSize <TimeSpan> -Frequency <TimeSpan> + -TargetResourceId <String> + -Condition <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.IPSMultiMetricCriteria]> + [-AutoMitigate <Boolean>] [-ActionGroup <ActivityLogAlertActionGroup[]>] [-ActionGroupId <String[]>] + [-DisableRule] [-Description <String>] -Severity <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### CreateAlertByScopes +``` +Add-AzMetricAlertRuleV2 -Name <String> -ResourceGroupName <String> -WindowSize <TimeSpan> -Frequency <TimeSpan> + -TargetResourceScope <String[]> -TargetResourceType <String> -TargetResourceRegion <String> + -Condition <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.IPSMultiMetricCriteria]> + [-AutoMitigate <Boolean>] [-ActionGroup <ActivityLogAlertActionGroup[]>] [-ActionGroupId <String[]>] + [-DisableRule] [-Description <String>] -Severity <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Adds or updates a **V2 (non-classic) metric-based alert rule**. The added rule is associated with a resource group and has a name. This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. + +## EXAMPLES + +### Example 1: Add a metric alert rule to a virtual machine + +```powershell +$act = [Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup]::New("/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/default-activitylogalerts/providers/Microsoft.Insights/actiongroups/actionGroupDemo") +Add-AzMetricAlertRuleV2 -Name PS3182019 -ResourceGroupName xxxxRG -WindowSize 0:5 -Frequency 0:5 -TargetResourceScope "/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/012345/providers/Microsoft.Compute/virtualMachines/VM1", "/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/012345/providers/Microsoft.Compute/virtualMachines/VM2" -TargetResourceType "Microsoft.Compute/virtualMachines" -TargetResourceRegion "eastus" -Description "This is description" -Severity 4 -ActionGroup $act -Condition $condition +``` + +```output +Description : This is description +Severity : 4 +Enabled : True +Scopes : {/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/012345/providers/Microsoft.Compute/virtualMachines/VM1, + /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/012345/providers/Microsoft.Compute/virtualMachines/VM2} +EvaluationFrequency : 00:05:00 +WindowSize : 00:05:00 +TargetResourceType : Microsoft.Compute/virtualMachines +TargetResourceRegion : eastus +Criteria : Microsoft.Azure.Management.Monitor.Models.MetricAlertMultipleResourceMultipleMetricCriteria +AutoMitigate : +Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/default-activitylogalerts/providers/Microsoft.Insights/actiongroups/demo} +LastUpdatedTime : +Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/xxxxRG/providers/Microsoft.Insights/metricAlerts/PS3182019 +Name : PS3182019 +Type : Microsoft.Insights/metricAlerts +Location : global +Tags : +``` + +This command creates a metric alert rule for a virtual machine. $condition is the output of [New-AzMetricAlertRuleV2Criteria](https://learn.microsoft.com/powershell/module/az.monitor/new-azmetricalertrulev2criteria) cmdlet + +### Example 2: Add a metric alert rule for all virtual machines in a subscription +```powershell +$act = [Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup]::New("/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/default-activitylogalerts/providers/Microsoft.Insights/actiongroups/actionGroupDemo") +Add-AzMetricAlertRuleV2 -Name AllVM -ResourceGroupName xxxxRG -WindowSize 0:5 -Frequency 0:5 -TargetResourceScope "/subscriptions/00000000-0000-0000-0000-0000000" -TargetResourceType "Microsoft.Compute/virtualMachines" -TargetResourceRegion "eastus" -Description "This is description" -Severity 4 -ActionGroup $act -Condition $condition +``` + +```output +Description : This is description +Severity : 4 +Enabled : True +Scopes : {/subscriptions/00000000-0000-0000-0000-0000000} +EvaluationFrequency : 00:05:00 +WindowSize : 00:05:00 +TargetResourceType : Microsoft.Compute/virtualMachines +TargetResourceRegion : eastus +Criteria : Microsoft.Azure.Management.Monitor.Models.MetricAlertMultipleResourceMultipleMetricCriteria +AutoMitigate : +Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/default-activitylogalerts/providers/Microsoft.Insights/actiongroups/demo} +LastUpdatedTime : +Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/xxxxRG/providers/Microsoft.Insights/metricAlerts/AllVM +Name : AllVM +Type : Microsoft.Insights/metricAlerts +Location : global +Tags : +``` + +This command creates a metric alert rule for all virtual machines in the subscription that are in eastus + +### Example 3: Disable a metric alert rule +```powershell +Get-AzMetricAlertRuleV2 -ResourceGroupName alertstest -Name TestAlertRule | Add-AzMetricAlertRuleV2 -DisableRule +``` + +```output +Description : This new Metric alert rule was created from Powershell version: 1.0.1 +Severity : 4 +Enabled : False +Scopes : {/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/alertstest/providers/Microsoft.Insights/components/alertstestFunction} +EvaluationFrequency : 00:05:00 +WindowSize : 00:05:00 +TargetResourceType : +TargetResourceRegion : +Criteria : Microsoft.Azure.Management.Monitor.Models.MetricAlertSingleResourceMultipleMetricCriteria +AutoMitigate : +Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/default-activitylogalerts/providers/Microsoft.Insights/actiongroups/demo1} +LastUpdatedTime : +Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/alertstest/providers/Microsoft.Insights/metricAlerts/TestAlertRule +Name : TestAlertRule +Type : Microsoft.Insights/metricAlerts +Location : global +Tags : +``` + +This command disables a metric alert rule. Here, we are piping output of [Get-AzMetricAlertRuleV2](https://learn.microsoft.com/powershell/module/az.monitor/get-azmetricalertrulev2) to [Add-AzMetricAlertRuleV2](https://learn.microsoft.com/powershell/module/az.monitor/add-azmetricalertrulev2) + +### Example 4: Add a metric alert rule with dimensions + +```powershell +$act = [Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup]::New("/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/default-activitylogalerts/providers/Microsoft.Insights/actiongroups/actionGroupDemo") +$dim1 = New-AzMetricAlertRuleV2DimensionSelection -DimensionName "availabilityResult/name" -ValuesToInclude "gdtest" +$dim2 = New-AzMetricAlertRuleV2DimensionSelection -DimensionName "availabilityResult/location" -ValuesToInclude "*" +$criteria = New-AzMetricAlertRuleV2Criteria -MetricName "availabilityResults/availabilityPercentage" -DimensionSelection $dim1,$dim2 -TimeAggregation Average -Operator GreaterThan -Threshold 2 +Add-AzMetricAlertRuleV2 -Name AlertWithDim -ResourceGroupName alertstest -WindowSize 00:05:00 -Frequency 00:05:00 -TargetResourceId "/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/alertstest/providers/Microsoft.Insights/components/alertstestFunction" -Condition $criteria -ActionGroup $act -DisableRule -Severity 4 +``` + +```output +Description : This new Metric alert rule was created from Powershell version: 1.0.0 +Severity : 4 +Enabled : False +Scopes : {/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/alertstest/providers/Microsoft.Insights/components/alertstestFunction} +EvaluationFrequency : 00:05:00 +WindowSize : 00:05:00 +TargetResourceType : +TargetResourceRegion : +Criteria : Microsoft.Azure.Management.Monitor.Models.MetricAlertSingleResourceMultipleMetricCriteria +AutoMitigate : +Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/default-activitylogalerts/providers/Microsoft.Insights/actiongroups/actionGroupDemo} +LastUpdatedTime : +Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/alertstest/providers/Microsoft.Insights/metricAlerts/AlertWithDim +Name : AlertWithDim +Type : Microsoft.Insights/metricAlerts +Location : global +Tags : +``` + +To create a more complex metric alert rule like the ones that involve selecting dimension values or have multiple criteria, you can use the helper cmdlets [New-AzMetricAlertRuleV2DimensionSelection](https://learn.microsoft.com/powershell/module/az.monitor/new-azmetricalertrulev2dimensionselection) and [New-AzMetricAlertRuleV2Criteria](https://learn.microsoft.com/powershell/module/az.monitor/new-azmetricalertrulev2criteria). + +Above set of cmdlets will create a metric alert rule with dimensions. + +## PARAMETERS + +### -ActionGroup +The Action Group for rule + +```yaml +Type: Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup[] +Parameter Sets: (All) +Aliases: Actions + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ActionGroupId +The Action Group id for rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutoMitigate +The flag that indicates whether the alert should be auto resolved or not + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Condition +The condition for rule + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.IPSMultiMetricCriteria] +Parameter Sets: (All) +Aliases: Criteria + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the metric alert rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisableRule +The disable rule (status) flag + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Frequency +The evaluation frequency for rule + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: EvaluationFrequency + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of metric alert rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Severity +The severity for the metric alert rule + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceId +The target resource id for rule + +```yaml +Type: System.String +Parameter Sets: CreateAlertByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceRegion +The target resource region for rule + +```yaml +Type: System.String +Parameter Sets: CreateAlertByScopes +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceScope +The target resource scope for rule + +```yaml +Type: System.String[] +Parameter Sets: CreateAlertByScopes +Aliases: Scopes + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceType +The target resource type for rule + +```yaml +Type: System.String +Parameter Sets: CreateAlertByScopes +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WindowSize +The window size for rule + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.TimeSpan + +### System.String[] + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Insights.OutputClasses.IPSMultiMetricCriteria, Microsoft.Azure.PowerShell.Cmdlets.Monitor, Version=1.0.1.0, Culture=neutral, PublicKeyToken=null]] + +### Microsoft.Azure.Management.Monitor.Models.ActivityLogAlertActionGroup[] + +### System.Management.Automation.SwitchParameter + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricAlertRuleV2 + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Add-AzWebtestAlertRule.md b/azps-10.1.0/Az.Monitor/Add-AzWebtestAlertRule.md new file mode 100644 index 0000000000..71325a902c --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Add-AzWebtestAlertRule.md @@ -0,0 +1,290 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: FBAE5F75-1E28-4F1C-A9ED-20075FFD4AC7 +online version: https://learn.microsoft.com/powershell/module/az.monitor/add-azwebtestalertrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Add-AzWebtestAlertRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Add-AzWebtestAlertRule.md +--- + +# Add-AzWebtestAlertRule + +## SYNOPSIS +Adds or updates a classic webtest alert rule (already retired on public cloud). +To create a new webtest alert rule, use the [Add-AzMetricAlertRuleV2](./Add-AzMetricAlertRuleV2.md) cmdlet, passing a criteria object for webtest (created via the [New-AzMetricAlertRuleV2Criteria](./New-AzMetricAlertRuleV2Criteria.md) cmdlet with a "-WebTest" criteria type). + +## SYNTAX + +``` +Add-AzWebtestAlertRule -MetricName <String> -TargetResourceUri <String> -WindowSize <TimeSpan> + -FailedLocationCount <Int32> [-MetricNamespace <String>] -Location <String> [-Description <String>] + [-DisableRule] -ResourceGroupName <String> -Name <String> + [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzWebtestAlertRule** cmdlet adds or updates an alert rule of either metric, event, or webtest type. +The added rule is associated to a resource group and has a name. +This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. + +## EXAMPLES + +### Example 1: Add a webtest alert rule +```powershell +Add-AzWebtestAlertRule -Name "webtestRule" -Location "East US" -ResourceGroup "Default-Web-EastUS" -WindowSize 00:05:00 -MetricName "metric" -TargetResourceUri "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Default-Web-WestUS/providers/Microsoft.Insights/webtests/leowebtestr1-webtestr1" -Description "Nice Webtest rule" -FailedLocationCount 3 +``` + +```output +RequestId StatusCode +--------- ---------- +9a5bc388-c7ac-4dc6-aa70-f4bc29c2c712 OK +``` + +This command adds or updates a webtest alert rule. + +## PARAMETERS + +### -Action +Specifies a comma-separated list of actions. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description of the rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisableRule +Disables the rule. +If you do not specify this parameter, the rule is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FailedLocationCount +Specifies the failed location count for the webtest rules. +This is similar to the threshold in the other types of rules. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the location where the rule is defined. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MetricName +Specifies the name of the metric. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MetricNamespace +Specifies the metric namespace for rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceUri +Specifies the resource ID of the webtest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WindowSize +Specifies the time window size for the rule to compute its data. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.TimeSpan + +### System.Int32 + +### System.Management.Automation.SwitchParameter + +### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction, Microsoft.Azure.PowerShell.Cmdlets.Monitor, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSAddAlertRuleOperationResponse + +## NOTES + +## RELATED LINKS + +[Add-AzMetricAlertRule](./Add-AzMetricAlertRule.md) + +[Get-AzAlertHistory](./Get-AzAlertHistory.md) + +[New-AzAlertRuleWebhook](./New-AzAlertRuleWebhook.md) + + diff --git a/azps-10.1.0/Az.Monitor/Az.Monitor.md b/azps-10.1.0/Az.Monitor/Az.Monitor.md new file mode 100644 index 0000000000..846b06fe11 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Az.Monitor.md @@ -0,0 +1,254 @@ +--- +Module Name: Az.Monitor +Module Guid: 698c387c-bd6b-41c6-82ce-721f1ef39548 +Download Help Link: https://learn.microsoft.com/powershell/module/az.monitor +Help Version: 4.0.4.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Az.Monitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Az.Monitor.md +--- + +# Az.Monitor Module +## Description +This topic displays help topics for the Azure Insights Cmdlets. + +## Az.Monitor Cmdlets +### [Add-AzLogProfile](Add-AzLogProfile.md) +Creates a new activity log profile. This profile is used to either archive the activity log to an Azure storage account or stream it to an Azure event hub in the same subscription. + +### [Add-AzMetricAlertRule](Add-AzMetricAlertRule.md) +Adds or updates a claasic metric-based alert rule (already retired on public cloud). To create a new metric alert rule, use the [Add-AzMetricAlertRuleV2](./Add-AzMetricAlertRuleV2.md) cmdlet. + +### [Add-AzMetricAlertRuleV2](Add-AzMetricAlertRuleV2.md) +Adds or updates a V2 (non-classic) metric-based alert rule. + +### [Add-AzWebtestAlertRule](Add-AzWebtestAlertRule.md) +Adds or updates a classic webtest alert rule (already retired on public cloud). +To create a new webtest alert rule, use the [Add-AzMetricAlertRuleV2](./Add-AzMetricAlertRuleV2.md) cmdlet, passing a criteria object for webtest (created via the [New-AzMetricAlertRuleV2Criteria](./New-AzMetricAlertRuleV2Criteria.md) cmdlet with a "-WebTest" criteria type). + +### [Get-AzActionGroup](Get-AzActionGroup.md) +Gets action group(s). + +### [Get-AzActivityLog](Get-AzActivityLog.md) +Retrieve Activity Log events. + +### [Get-AzActivityLogAlert](Get-AzActivityLogAlert.md) +Get an Activity Log Alert rule. + +### [Get-AzAlertHistory](Get-AzAlertHistory.md) +Gets the history of classic alert rules. + +### [Get-AzAlertRule](Get-AzAlertRule.md) +Gets classic alert rules. + +### [Get-AzAutoscaleHistory](Get-AzAutoscaleHistory.md) +Gets the Autoscale history. + +### [Get-AzAutoscalePredictiveMetric](Get-AzAutoscalePredictiveMetric.md) +get predictive autoscale metric future data + +### [Get-AzAutoscaleSetting](Get-AzAutoscaleSetting.md) +Gets an autoscale setting + +### [Get-AzDataCollectionRule](Get-AzDataCollectionRule.md) +Gets data collection rule(s). + +### [Get-AzDataCollectionRuleAssociation](Get-AzDataCollectionRuleAssociation.md) +Gets data collection rule association(s). + +### [Get-AzDiagnosticSetting](Get-AzDiagnosticSetting.md) +Gets the active diagnostic settings for the specified resource. + +### [Get-AzDiagnosticSettingCategory](Get-AzDiagnosticSettingCategory.md) +Gets the diagnostic settings category for the specified resource. + +### [Get-AzEventCategory](Get-AzEventCategory.md) +Get the list of available event categories supported in the Activity Logs Service. +The current list includes the following: Administrative, Security, ServiceHealth, Alert, Recommendation, Policy. + +### [Get-AzInsightsPrivateLinkScope](Get-AzInsightsPrivateLinkScope.md) +Get private link scope + +### [Get-AzInsightsPrivateLinkScopedResource](Get-AzInsightsPrivateLinkScopedResource.md) +Get for private link scoped resource + +### [Get-AzLogProfile](Get-AzLogProfile.md) +Gets a log profile. + +### [Get-AzMetric](Get-AzMetric.md) +Gets the metric values of a resource. + +### [Get-AzMetricAlertRuleV2](Get-AzMetricAlertRuleV2.md) +Gets V2 (non-classic) metric alert rules + +### [Get-AzMetricDefinition](Get-AzMetricDefinition.md) +Gets metric definitions. + +### [Get-AzMonitorWorkspace](Get-AzMonitorWorkspace.md) +Returns the specific Azure Monitor workspace + +### [Get-AzScheduledQueryRule](Get-AzScheduledQueryRule.md) +Retrieve an scheduled query rule definition. + +### [Get-AzSubscriptionDiagnosticSetting](Get-AzSubscriptionDiagnosticSetting.md) +Gets the active subscription diagnostic settings for the specified resource. + +### [New-AzActionGroupReceiver](New-AzActionGroupReceiver.md) +Creates an new action group receiver. + +### [New-AzActivityLogAlert](New-AzActivityLogAlert.md) +Create a new Activity Log Alert rule or update an existing one. + +### [New-AzActivityLogAlertActionGroupObject](New-AzActivityLogAlertActionGroupObject.md) +Create an in-memory object for ActionGroup. + +### [New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject](New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject.md) +Create an in-memory object for AlertRuleAnyOfOrLeafCondition. + +### [New-AzActivityLogAlertAlertRuleLeafConditionObject](New-AzActivityLogAlertAlertRuleLeafConditionObject.md) +Create an in-memory object for AlertRuleLeafCondition. + +### [New-AzAlertRuleEmail](New-AzAlertRuleEmail.md) +Creates an email action for an alert rule. + +### [New-AzAlertRuleWebhook](New-AzAlertRuleWebhook.md) +Creates an alert rule webhook. + +### [New-AzAutoscaleNotificationObject](New-AzAutoscaleNotificationObject.md) +Create an in-memory object for AutoscaleNotification. + +### [New-AzAutoscaleProfileObject](New-AzAutoscaleProfileObject.md) +Create an in-memory object for AutoscaleProfile. + +### [New-AzAutoscaleScaleRuleMetricDimensionObject](New-AzAutoscaleScaleRuleMetricDimensionObject.md) +Create an in-memory object for ScaleRuleMetricDimension. + +### [New-AzAutoscaleScaleRuleObject](New-AzAutoscaleScaleRuleObject.md) +Create an in-memory object for ScaleRule. + +### [New-AzAutoscaleSetting](New-AzAutoscaleSetting.md) +Creates or updates an autoscale setting. + +### [New-AzAutoscaleWebhookNotificationObject](New-AzAutoscaleWebhookNotificationObject.md) +Create an in-memory object for WebhookNotification. + +### [New-AzDataCollectionRule](New-AzDataCollectionRule.md) +Create a data collection rule. + +### [New-AzDataCollectionRuleAssociation](New-AzDataCollectionRuleAssociation.md) +Create data collection rule association. + +### [New-AzDiagnosticSetting](New-AzDiagnosticSetting.md) +Creates or updates diagnostic settings for the specified resource. + +### [New-AzDiagnosticSettingLogSettingsObject](New-AzDiagnosticSettingLogSettingsObject.md) +Create an in-memory object for LogSettings. + +### [New-AzDiagnosticSettingMetricSettingsObject](New-AzDiagnosticSettingMetricSettingsObject.md) +Create an in-memory object for MetricSettings. + +### [New-AzDiagnosticSettingSubscriptionLogSettingsObject](New-AzDiagnosticSettingSubscriptionLogSettingsObject.md) +Create an in-memory object for SubscriptionLogSettings. + +### [New-AzInsightsPrivateLinkScope](New-AzInsightsPrivateLinkScope.md) +create private link scope + +### [New-AzInsightsPrivateLinkScopedResource](New-AzInsightsPrivateLinkScopedResource.md) +create for private link scoped resource + +### [New-AzMetricAlertRuleV2Criteria](New-AzMetricAlertRuleV2Criteria.md) +Creates a local criteria object that can be used to create a new metric alert + +### [New-AzMetricAlertRuleV2DimensionSelection](New-AzMetricAlertRuleV2DimensionSelection.md) +Creates a local dimension selection object that can be used to construct a metric alert criteria. + +### [New-AzMetricFilter](New-AzMetricFilter.md) +Creates a metric dimension filter that can be used to query metrics. + +### [New-AzMonitorWorkspace](New-AzMonitorWorkspace.md) +Create or update a workspace + +### [New-AzScheduledQueryRule](New-AzScheduledQueryRule.md) +Creates or updates a scheduled query rule. + +### [New-AzScheduledQueryRuleConditionObject](New-AzScheduledQueryRuleConditionObject.md) +Create an in-memory object for Condition. + +### [New-AzScheduledQueryRuleDimensionObject](New-AzScheduledQueryRuleDimensionObject.md) +Create an in-memory object for Dimension. + +### [New-AzSubscriptionDiagnosticSetting](New-AzSubscriptionDiagnosticSetting.md) +Creates or updates subscription diagnostic settings for the specified resource. + +### [Remove-AzActionGroup](Remove-AzActionGroup.md) +Removes an action group. + +### [Remove-AzActivityLogAlert](Remove-AzActivityLogAlert.md) +Delete an Activity Log Alert rule. + +### [Remove-AzAlertRule](Remove-AzAlertRule.md) +Removes an alert rule. + +### [Remove-AzAutoscaleSetting](Remove-AzAutoscaleSetting.md) +Deletes and autoscale setting + +### [Remove-AzDataCollectionRule](Remove-AzDataCollectionRule.md) +Delete a data collection rule. + +### [Remove-AzDataCollectionRuleAssociation](Remove-AzDataCollectionRuleAssociation.md) +Delete a data collection rule association. + +### [Remove-AzDiagnosticSetting](Remove-AzDiagnosticSetting.md) +Deletes existing diagnostic settings for the specified resource. + +### [Remove-AzInsightsPrivateLinkScope](Remove-AzInsightsPrivateLinkScope.md) +delete private link scope + +### [Remove-AzInsightsPrivateLinkScopedResource](Remove-AzInsightsPrivateLinkScopedResource.md) +delete for private link scoped resource + +### [Remove-AzLogProfile](Remove-AzLogProfile.md) +Removes a log profile. + +### [Remove-AzMetricAlertRuleV2](Remove-AzMetricAlertRuleV2.md) +Removes a V2 (non-classic) metric alert rule. + +### [Remove-AzMonitorWorkspace](Remove-AzMonitorWorkspace.md) +Delete a workspace + +### [Remove-AzScheduledQueryRule](Remove-AzScheduledQueryRule.md) +Deletes a scheduled query rule. + +### [Remove-AzSubscriptionDiagnosticSetting](Remove-AzSubscriptionDiagnosticSetting.md) +Deletes existing subscription diagnostic settings for the specified resource. + +### [Set-AzActionGroup](Set-AzActionGroup.md) +Creates a new or updates an existing action group. + +### [Set-AzDataCollectionRule](Set-AzDataCollectionRule.md) +Updates (full replacement) a data collection rule. + +### [Test-AzActionGroup](Test-AzActionGroup.md) +Sends test notifications + +### [Update-AzActivityLogAlert](Update-AzActivityLogAlert.md) +Updates 'tags' and 'enabled' fields in an existing Alert rule. +This method is used to update the Alert rule tags, and to enable or disable the Alert rule. +To update other fields use CreateOrUpdate operation. + +### [Update-AzAutoscaleSetting](Update-AzAutoscaleSetting.md) +Updates an existing AutoscaleSettingsResource. +To update other fields use the CreateOrUpdate method. + +### [Update-AzDataCollectionRule](Update-AzDataCollectionRule.md) +Updates a data collection rule tags property. + +### [Update-AzInsightsPrivateLinkScope](Update-AzInsightsPrivateLinkScope.md) +Update for private link scope + +### [Update-AzMonitorWorkspace](Update-AzMonitorWorkspace.md) +Updates part of a workspace + +### [Update-AzScheduledQueryRule](Update-AzScheduledQueryRule.md) +Update a scheduled query rule. + diff --git a/azps-10.1.0/Az.Monitor/Get-AzActionGroup.md b/azps-10.1.0/Az.Monitor/Get-AzActionGroup.md new file mode 100644 index 0000000000..9e3253732b --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzActionGroup.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: 1CA26790-C791-4BFD-B986-70F28E3B095B +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azactiongroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzActionGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzActionGroup.md +--- + +# Get-AzActionGroup + +## SYNOPSIS +Gets action group(s). + +## SYNTAX + +### BySubscriptionOrResourceGroup (Default) +``` +Get-AzActionGroup [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByName +``` +Get-AzActionGroup -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzActionGroup** cmdlet gets one or more action groups. + +## EXAMPLES + +### Example 1: Get an action group by subscription ID +```powershell +Get-AzActionGroup +``` + +This command lists all the action group for the current subscription. + +### Example 2: Get action groups for the given resource group +```powershell +Get-AzActionGroup -ResourceGroupName "Default-activityLogAlerts" +``` + +This command lists action groups for the given resource group. + +### Example 3: Get an action group. +```powershell +Get-AzActionGroup -ResourceGroupName "Default-activityLogAlerts" -Name "actionGroup1" +``` + +This command lists one (a list with a single element) action group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the action group. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: BySubscriptionOrResourceGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource + +## NOTES + +## RELATED LINKS + +[Set-AzActionGroup](./Set-AzActionGroup.md) +[Remove-AzActionGroup](./Remove-AzActionGroup.md) +[New-AzActionGroupReceiver](./New-AzActionGroupReceiver.md) diff --git a/azps-10.1.0/Az.Monitor/Get-AzActivityLog.md b/azps-10.1.0/Az.Monitor/Get-AzActivityLog.md new file mode 100644 index 0000000000..8642ea84d9 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzActivityLog.md @@ -0,0 +1,387 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azactivitylog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzActivityLog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzActivityLog.md +--- + +# Get-AzActivityLog + +## SYNOPSIS +Retrieve Activity Log events. + +## SYNTAX + +### GetBySubscription (Default) +``` +Get-AzActivityLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] + [-DetailedOutput] [-MaxRecord <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByCorrelationId +``` +Get-AzActivityLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] + [-DetailedOutput] [-CorrelationId] <String> [-MaxRecord <Int32>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceGroup +``` +Get-AzActivityLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] + [-DetailedOutput] [-ResourceGroupName] <String> [-MaxRecord <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceId +``` +Get-AzActivityLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] + [-DetailedOutput] [-ResourceId] <String> [-MaxRecord <Int32>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceProvider +``` +Get-AzActivityLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] + [-DetailedOutput] [-ResourceProvider] <String> [-MaxRecord <Int32>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzActivityLog cmdlet retrieve Activity Log events. The events can be associated with the current subscription ID, correlation ID, resource group, resource ID, or resource provider. + +## EXAMPLES + +### Example 1: Get an event log by subscription ID +```powershell +Get-AzActivityLog +``` + +This command lists at most 1000 events associated with the user's subscription ID that took place 7 days from the current date/time. + +### Example 2: Get an event log by subscription ID with a maximum number of events +```powershell +Get-AzActivityLog -MaxRecord 100 +``` + +This command lists at most 100 events associated with the user's subscription ID that took place 7 days from the current date/time. + +### Example 3: Get an event log by subscription ID with a start time. +```powershell +Get-AzActivityLog -StartTime 2017-06-01T10:30 +``` + +This command lists at most 1000 events associated with the user's subscription ID that took place on or after 2017-06-01T10:30 local time if that date/time is not older than 90 days from the current date/time. + +### Example 4: Get an event log by subscription ID with a start time and end time. +```powershell +Get-AzActivityLog -StartTime 2017-04-01T10:30 -EndTime 2017-04-14T11:30 +``` + +This command lists at most 1000 of the events associated with the user's subscription ID that took place on or after 2017-04-01T10:30 local time, and before 2017-04-14T11:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. + +### Example 5: Get an event log by correlation ID +```powershell +Get-AzActivityLog -CorrelationId "60c694d0-e46f-4c12-bed1-9b7aef541c23" +``` + +This command lists at most 1000 events associated with the specified correlation ID that took place 7 days from the current date/time. +**NOTE**: this is usually only one event. + +### Example 6: Get an event log by correlation ID with a maximum number of events +```powershell +Get-AzActivityLog -CorrelationId "60c694d0-e46f-4c12-bed1-9b7aef541c23" -MaxRecord 100 +``` + +This command lists at most 100 events associated with the specified correlation ID that took place 7 days from the current date/time. +**NOTE**: this is usually only one event. + +### Example 7: Get an event log by correlation ID and start time +```powershell +Get-AzActivityLog -CorrelationId "60c694d0-e46f-4c12-bed1-9b7aef541c23" -StartTime 2017-05-22T04:30:00 +``` + +This command lists at most 1000 events associated with the specified correlation ID that took place on or after 2017-05-22T04:30:00 local time if the start time is not older than 90 days from the current date/time. +**NOTE**: this is usually only one event. + +### Example 8: Get an event log by correlation ID with start time and end time +```powershell +Get-AzActivityLog -CorrelationId "60c694d0-e46f-4c12-bed1-9b7aef541c23" -StartTime 2017-04-15T04:30:00 -EndTime 2017-04-25T12:30:00 +``` + +This command lists at most 1000 events associated with the specified correlation ID that took place on or after 2017-04-15T04:30 local time, but before 2017-04-25T12:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. + +### Example 9: Get an event log for a resource group +```powershell +Get-AzActivityLog -ResourceGroupName "Contoso-Web-CentralUS" +``` + +This command lists at most 1000 the events associated with the specified resource group that took place 7 days from the current date/time. + +### Example 10: Get an event log for a resource group with a maximum number of events +```powershell +Get-AzActivityLog -ResourceGroup "Contoso-Web-CentralUS" -MaxRecord 100 +``` + +This command lists at most 100 events associated with the specified resource group that took place 7 days from the current date/time. + +### Example 11: Get an event log for a resource group by start time +```powershell +Get-AzActivityLog -ResourceGroup "Contoso-Web-CentralUS" -StartTime 2017-05-22T04:30:00 +``` + +This command lists at most 1000 events associated with the specified resource group that took place on or after 2017-05-22T04:30:00 local time if the start time is not older than 90 days from the current date/time. + +### Example 12: Get an event log for a resource group with a start time and end time +```powershell +Get-AzActivityLog -ResourceGroup "Contoso-Web-CentralUS" -StartTime 2017-04-15T04:30 -EndTime 2017-04-25T12:30 +``` + +This command lists at most 1000 events associated with the specified resource group that took place on or after 2017-04-15T04:30 local time, but before 2017-04-25T12:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. + +### Example 13: Get an event log by resource ID +```powershell +Get-AzActivityLog -ResourceId "/subscriptions/623d50f1-4fa8-4e46-a967-a9214aed43ab/ResourceGroups/Contoso-Web-CentralUS/providers/Microsoft.Web/ServerFarms/Contoso1" +``` + +This command lists at most 1000 events associated with the specified resource ID that took place 7 days from the current date/time. + +### Example 14: Get an event log by resource ID with a maximum number of events +```powershell +Get-AzActivityLog -ResourceId "/subscriptions/623d50f1-4fa8-4e46-a967-a9214aed43ab/ResourceGroups/Contoso-Web-CentralUS/providers/Microsoft.Web/ServerFarms/Contoso1" -MaxRecord 100 +``` + +This command lists at most 100 events associated with the specified resource ID that took place 7 days from the current date/time. + +### Example 15: Get an event log by resource ID with a start time +```powershell +Get-AzActivityLog -ResourceId "/subscriptions/623d50f1-4fa8-4e46-a967-a9214aed43ab/ResourceGroups/Contoso-Web-CentralUS/providers/Microsoft.Web/ServerFarms/Contoso1" -StartTime 2017-05-22T04:30 +``` + +This command lists at most 1000 events associated with the specified resource ID that took place on or after 2017-05-22T04:30:00 local time if the start time is not older than 90 days from the current date/time. + +### Example 16: Get an event log by resource ID with a start time and end time +```powershell +Get-AzActivityLog -ResourceId "/subscriptions/623d50f1-4fa8-4e46-a967-a9214aed43ab/ResourceGroups/Contoso-Web-CentralUS/providers/Microsoft.Web/ServerFarms/Contoso1" -StartTime 2017-04-15T04:30 -EndTime 2017-04-25T12:30 +``` + +This command lists at most 1000 events associated with the specified resource ID that took place on or after 2017-04-15T04:30 local time, but before 2017-04-25T12:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. + +### Example 17: Get an event log by resource provider +```powershell +Get-AzActivityLog -ResourceProvider "Microsoft.Web" +``` + +This command lists at most 1000 events associated with the specified resource provider that took place 7 days from the current date/time. + +### Example 18: Get an event log by resource provider with a maximum number of events +```powershell +Get-AzActivityLog -ResourceProvider "Microsoft.Web" -MaxRecord 100 +``` + +This command lists at most 100 events associated with the specified resource provider that took place 7 days from the current date/time. + +### Example 19: Get an event log by resource provider with a start time +```powershell +Get-AzActivityLog -ResourceProvider "Microsoft.Web" -StartTime 2017-05-22T04:30 +``` + +This command lists at most 1000 events associated with the specified resource provider that took place on or after 2017-05-22T04:30:00 local time if the start time is not older than 90 days from the current date/time. + +### Example 20: Get an event log by resource provider with a start time and end time +```powershell +Get-AzActivityLog -ResourceProvider "Microsoft.Web" -StartTime 2017-04-15T04:30 -EndTime 2017-04-25T12:30 +``` + +This command lists at most 1000 events associated with the specified resource provider that took place on or after 2017-04-15T04:30 local time, but before 2017-04-25T12:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. + +## PARAMETERS + +### -Caller +The caller of the events to fetch + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CorrelationId +The CorrelationId + +```yaml +Type: System.String +Parameter Sets: GetByCorrelationId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetailedOutput +Return object with all the details of the events (the default is to return only some attributes, i.e. +no detail) + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EndTime +The endTime of the query + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MaxRecord +The maximum number of records to fetch. +Alias: MaxRecords, MaxEvents + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: GetByResourceGroup +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceProvider +The ResourceProvider name + +```yaml +Type: System.String +Parameter Sets: GetByResourceProvider +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +The startTime of the query + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +The status of the events to fetch + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String + +### System.Management.Automation.SwitchParameter + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSEventData + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Get-AzActivityLogAlert.md b/azps-10.1.0/Az.Monitor/Get-AzActivityLogAlert.md new file mode 100644 index 0000000000..2ee6cf69bc --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzActivityLogAlert.md @@ -0,0 +1,172 @@ +--- +external help file: Az.ActivityLogAlert.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azactivitylogalert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzActivityLogAlert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzActivityLogAlert.md +--- + +# Get-AzActivityLogAlert + +## SYNOPSIS +Get an Activity Log Alert rule. + +## SYNTAX + +### List (Default) +``` +Get-AzActivityLogAlert [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzActivityLogAlert -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzActivityLogAlert -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzActivityLogAlert -InputObject <IActivityLogAlertIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get an Activity Log Alert rule. + +## EXAMPLES + +### Example 1: List activity log alerts under current subscription +```powershell +Get-AzActivityLogAlert +``` + +List activity log alerts under current subscription + +### Example 2: List activity log alerts under resource group +```powershell +Get-AzActivityLogAlert -ResourceGroupName $rg-name +``` + +List activity log alerts under resource group + +### Example 3: Get activity log alert by name +```powershell +Get-AzActivityLogAlert -ResourceGroupName $rg-name -Name $alert-name +``` + +Get activity log alert by name + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.IActivityLogAlertIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Activity Log Alert rule. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ActivityLogAlertName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: List, Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.IActivityLogAlertIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.Api20201001.IActivityLogAlertResource + +## 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 <IActivityLogAlertIdentity>`: Identity Parameter + - `[ActivityLogAlertName <String>]`: The name of the Activity Log Alert rule. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Get-AzAlertHistory.md b/azps-10.1.0/Az.Monitor/Get-AzAlertHistory.md new file mode 100644 index 0000000000..568a4e4853 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzAlertHistory.md @@ -0,0 +1,409 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: 1EDFCAC4-6A66-4124-8192-B7F0D3C5BCFC +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azalerthistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzAlertHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzAlertHistory.md +--- + +# Get-AzAlertHistory + +## SYNOPSIS +Gets the history of classic alert rules. + +## SYNTAX + +``` +Get-AzAlertHistory [-ResourceId <String>] [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] + [-Caller <String>] [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzAlertHistory** cmdlet gets the history of classic alert rules as they are enabled, disabled, fired, resolved, and so on. + +## EXAMPLES + +### Example 1: Get the alert history +```powershell +Get-AzAlertHistory -StartTime 2015-02-11T11:00:00 -EndTime 2015-02-11T12:00:00 -DetailedOutput +``` + +```output +Authorization : +Caller : Microsoft.Insights/alertRules +Claims : + http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules +CorrelationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj + cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi + LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj + LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzg4ODU3OTI5OTI2 +Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' has been resolved for Website: + garyyang1 (Default-Web-EastUS) +EventDataId : 769fab1c-fc9f-4e18-bc3a-fa79fbdd3616 +EventName : Alert +EventSource : Microsoft.Insights/alertrules +EventTimestamp : 2/11/2015 7:14:45 PM +HttpRequest : +Id : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/events/769fab1c-fc + 9f-4e18-bc3a-fa79fbdd3616/ticks/635592788857929926 +Level : Informational +OperationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj + cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi + LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj + LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzg4ODU3OTI5OTI2 +OperationName : ResolveAlert +Properties : + RuleUri : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web- + EastUS/providers/Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d + RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d + RuleDescription: + Threshold : 3 + WindowSizeInMinutes: 5 + Aggregation : Total + Operator : GreaterThan + MetricName : CpuTime + MetricUnit : Count +ResourceGroupName : Default-Web-EastUS +ResourceProviderName : Microsoft.Insights +ResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d +Status : Resolved +SubmissionTimestamp : 2/11/2015 7:14:45 PM +SubscriptionId : b93fb07a-6f93-30be-bf3e-4f0deca15f4f +SubStatus : +Authorization : +Caller : Microsoft.Insights/alertRules +Claims : + http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules +CorrelationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj + cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi + LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj + LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 +Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' was activated for Website: garyyang1 + (Default-Web-EastUS) +EventDataId : 66277c94-2097-4f5f-860d-e585f1206cd7 +EventName : Alert +EventSource : Microsoft.Insights/alertrules +EventTimestamp : 2/11/2015 7:04:46 PM +HttpRequest : +Id : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + microsoft.web/sites/garyyang1/events/66277c94-2097-4f5f-860d-e585f1206cd7/ticks/6355927828650595 + 14 +Level : Error +OperationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj + cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi + LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj + LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 +OperationName : ActivateAlert +Properties : + RuleUri : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web- + EastUS/providers/Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d + RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d + RuleDescription: + Threshold : 3 + WindowSizeInMinutes: 5 + Aggregation : Total + Operator : GreaterThan + MetricName : CpuTime + MetricUnit : Count +ResourceGroupName : Default-Web-EastUS +ResourceProviderName : microsoft.web +ResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + microsoft.web/sites/garyyang1 +Status : Activated +SubmissionTimestamp : 2/11/2015 7:04:46 PM +SubscriptionId : b93fb07a-6f93-30be-bf3e-4f0deca15f4f +SubStatus : +Authorization : +Caller : Microsoft.Insights/alertRules +Claims : + http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules +CorrelationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj + cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi + LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj + LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 +Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' was activated for Website: garyyang1 + (Default-Web-EastUS) +EventDataId : ec9f7b3c-c6ea-4b45-bd15-ff43e38491e3 +EventName : Alert +EventSource : Microsoft.Insights/alertrules +EventTimestamp : 2/11/2015 7:04:46 PM +HttpRequest : +Id : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/events/ec9f7b3c-c6 + ea-4b45-bd15-ff43e38491e3/ticks/635592782865059514 +Level : Error +OperationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj + cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi + LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj + LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 +OperationName : ActivateAlert +Properties : + RuleUri : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web- + EastUS/providers/Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d + RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d + RuleDescription: + Threshold : 3 + WindowSizeInMinutes: 5 + Aggregation : Total + Operator : GreaterThan + MetricName : CpuTime + MetricUnit : Count +ResourceGroupName : Default-Web-EastUS +ResourceProviderName : Microsoft.Insights +ResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d +Status : Activated +SubmissionTimestamp : 2/11/2015 7:04:46 PM +SubscriptionId : b93fb07a-6f93-30be-bf3e-4f0deca15f4f +SubStatus : +``` + +This command gets the alert history for the specified time frame for the current subscription. + +### Example 2: Get alert history for a specified resource +```powershell +Get-AzAlertHistory -StartTime 2015-02-11T11:00:00 -EndTime 2015-02-11T12:00:00 -ResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d" -DetailedOutput +``` + +```output +Authorization : +Caller : Microsoft.Insights/alertRules +Claims : + http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules +CorrelationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj + cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi + LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj + LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzg4ODU3OTI5OTI2 +Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' has been resolved for Website: + garyyang1 (Default-Web-EastUS) +EventDataId : 769fab1c-fc9f-4e18-bc3a-fa79fbdd3616 +EventName : Alert +EventSource : Microsoft.Insights/alertrules +EventTimestamp : 2/11/2015 7:14:45 PM +HttpRequest : +Id : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/events/769fab1c-fc + 9f-4e18-bc3a-fa79fbdd3616/ticks/635592788857929926 +Level : Informational +OperationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj + cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi + LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj + LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzg4ODU3OTI5OTI2 +OperationName : ResolveAlert +Properties : +RuleUri : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web- + EastUS/providers/Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d +RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d +RuleDescription: +Threshold : 3 +WindowSizeInMinutes: 5 +Aggregation : Total +Operator : GreaterThan +MetricName : CpuTime +MetricUnit : Count +ResourceGroupName : Default-Web-EastUS +ResourceProviderName : Microsoft.Insights +ResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d +Status : Resolved +SubmissionTimestamp : 2/11/2015 7:14:45 PM +SubscriptionId : b93fb07a-6f93-30be-bf3e-4f0deca15f4f +SubStatus : +Authorization : +Caller : Microsoft.Insights/alertRules +Claims : + http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules +CorrelationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj + cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi + LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj + LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 +Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' was activated for Website: garyyang1 + (Default-Web-EastUS) +EventDataId : ec9f7b3c-c6ea-4b45-bd15-ff43e38491e3 +EventName : Alert +EventSource : Microsoft.Insights/alertrules +EventTimestamp : 2/11/2015 7:04:46 PM +HttpRequest : +Id : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/events/ec9f7b3c-c6 + ea-4b45-bd15-ff43e38491e3/ticks/635592782865059514 +Level : Error +OperationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj + cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi + LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj + LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 +OperationName : ActivateAlert +Properties : +RuleUri : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web- + EastUS/providers/Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d +RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d +RuleDescription: +Threshold : 3 +WindowSizeInMinutes: 5 +Aggregation : Total +Operator : GreaterThan +MetricName : CpuTime +MetricUnit : Count +ResourceGroupName : Default-Web-EastUS +ResourceProviderName : Microsoft.Insights +ResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d +Status : Activated +SubmissionTimestamp : 2/11/2015 7:04:46 PM +SubscriptionId : b93fb07a-6f93-30be-bf3e-4f0deca15f4f +SubStatus : +``` + +This command gets the alert rule-related events for a specified resource. + +## PARAMETERS + +### -Caller +Specifies the caller. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetailedOutput +Displays full details in the output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EndTime +Specifies the end time of the query in local time. +The default is the current time. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the resource ID the rule is associated with. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +Specifies the start time of the query in local time. +The default is the current local time minus one hour. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +Specifies the status. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSEventData + +## NOTES + +## RELATED LINKS + +[Add-AzMetricAlertRule](./Add-AzMetricAlertRule.md) + +[Add-AzWebtestAlertRule](./Add-AzWebtestAlertRule.md) + +[Get-AzAlertRule](./Get-AzAlertRule.md) + +[Remove-AzAlertRule](./Remove-AzAlertRule.md) + + diff --git a/azps-10.1.0/Az.Monitor/Get-AzAlertRule.md b/azps-10.1.0/Az.Monitor/Get-AzAlertRule.md new file mode 100644 index 0000000000..3651610d7b --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzAlertRule.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: A837077C-0A79-431C-93D2-799B2134EE69 +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azalertrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzAlertRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzAlertRule.md +--- + +# Get-AzAlertRule + +## SYNOPSIS +Gets classic alert rules. + +## SYNTAX + +### GetByResourceGroup (Default) +``` +Get-AzAlertRule -ResourceGroupName <String> [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByName +``` +Get-AzAlertRule -ResourceGroupName <String> -Name <String> [-DetailedOutput] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceUri +``` +Get-AzAlertRule -ResourceGroupName <String> -TargetResourceId <String> [-DetailedOutput] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzAlertRule** cmdlet gets a classic alert rule by its name or URI, or all classic alert rules from a specified resource group. + +## EXAMPLES + +### Example 1: Get alert rules for a resource group +```powershell +Get-AzAlertRule -ResourceGroup "Default-Web-CentralUS" +``` + +This command gets all of the alert rules for the resource group named Default-Web-CentralUS. +The output does not contain details about the rules because the *DetailedOutput* parameter is not specified. + +### Example 2: Get an alert rule by name +```powershell +Get-AzAlertRule -ResourceGroup "Default-Web-CentralUS" -Name "myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8" +``` + +This command gets the alert rule named myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8. +Because the *DetailedOutput* parameter is not specified, the output contains only basic information about the alert rule. + +### Example 3: Get an alert rule by name with detailed output +```powershell +Get-AzAlertRule -ResourceGroup "Default-Web-CentralUS" -Name "myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8" -DetailedOutput +``` + +This command gets the alert rule named myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8. +The *DetailedOutput* parameter is specified, so the output is detailed. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetailedOutput +Displays full details in the output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the alert rule to get. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceId +Specifies the ID of the target resource. + +```yaml +Type: System.String +Parameter Sets: GetByResourceUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSAlertRule + +## NOTES + +## RELATED LINKS + +[Add-AzMetricAlertRule](./Add-AzMetricAlertRule.md) + +[Add-AzWebtestAlertRule](./Add-AzWebtestAlertRule.md) + +[Get-AzAlertHistory](./Get-AzAlertHistory.md) + +[Remove-AzAlertRule](./Remove-AzAlertRule.md) + + diff --git a/azps-10.1.0/Az.Monitor/Get-AzAutoscaleHistory.md b/azps-10.1.0/Az.Monitor/Get-AzAutoscaleHistory.md new file mode 100644 index 0000000000..a45afb1d82 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzAutoscaleHistory.md @@ -0,0 +1,314 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: A70F4C03-E842-45D5-9323-DC5B14B569F1 +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azautoscalehistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzAutoscaleHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzAutoscaleHistory.md +--- + +# Get-AzAutoscaleHistory + +## SYNOPSIS +Gets the Autoscale history. + +## SYNTAX + +``` +Get-AzAutoscaleHistory [-ResourceId <String>] [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] + [-Caller <String>] [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzAutoscaleHistory** cmdlet gets the history of events related to an Autoscale setting. + +## EXAMPLES + +### Example 1: Get all events associated with a subscription +```powershell +Get-AzAutoscaleHistory -StartTime 2015-02-09T18:35:00 -EndTime 2015-02-09T18:40:00 -DetailedOutput +``` + +This command gets all of the Autoscale-related events associated with the current subscription. + +### Example 2: GetAutoscaleHistory for a particular resource +```powershell +Get-AzAutoscaleHistory -StartTime 2015-02-09T18:35:00 -EndTime 2015-02-09T18:40:00 -ResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/Microsoft.Insights/autoscalesettings/DefaultServerFarm-Default-Web-EastUS" -DetailedOutput +``` + +```output +Authorization : +Caller : Microsoft.Insights/autoscaleSettings +Claims : http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/autoscaleSettings +CorrelationId : ac5b03ca-05d4-4811-9c27-0314a145f785 +Description : The autoscale engine attempting to scale resource '/subscriptions/a93fb07c-6c93-40be-bf3b-4f0deb + a10f4b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm' + from 1 instances count to 2 instances count. +EventDataId : c554f7ed-514c-449c-9338-13e15b4b56a3 +EventName : AutoscaleAction +EventSource : Microsoft.Insights/autoscalesettings +EventTimestamp : 2/10/2015 2:38:19 AM +HttpRequest : +Id : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/autoscalesettings/DefaultServerFarm-Default-Web-EastUS/events/c554f7ed-514c-4 + 49c-9338-13e15b4b56a3/ticks/635591326997519815 +Level : Informational +OperationId : ac5b03ca-05d4-4811-9c27-0314a145f785 +OperationName : ScaleUp +Properties : +Description : The autoscale engine attempting to scale resource '/subscriptions/a93fb07c-6c93 + -40be-bf3b-4f0deba10f4b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/De + faultServerFarm' from 1 instances count to 2 instances count. +ResourceName : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web- + EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm +OldInstancesCount: 1 +NewInstancesCount: 2 +ActiveAutoscaleProfile: { + "Name": "No scheduled times", + "Capacity": { + "Minimum": "1", + "Maximum": "3", + "Default": "1" + }, + "Rules": [ + { + "MetricTrigger": { + "Name": "CpuPercentage", + "Namespace": "", + "Resource": "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default- + Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm", + "ResourceLocation": "East US", + "TimeGrain": "PT1M", + "Statistic": "Average", + "TimeWindow": "PT45M", + "TimeAggregation": "Average", + "Operator": "GreaterThanOrEqual", + "Threshold": 14.0, + "Source": "WebsiteDedicated:eastuswebspace:DefaultServerFarm" + }, + "ScaleAction": { + "Direction": "Increase", + "Type": "ChangeCount", + "Value": "1", + "Cooldown": "PT5M" + } + }, + { + "MetricTrigger": { + "Name": "CpuPercentage", + "Namespace": "", + "Resource": "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default- + Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm", + "ResourceLocation": "East US", + "TimeGrain": "PT1M", + "Statistic": "Average", + "TimeWindow": "PT45M", + "TimeAggregation": "Average", + "Operator": "LessThanOrEqual", + "Threshold": 4.0, + "Source": "WebsiteDedicated:eastuswebspace:DefaultServerFarm" + }, + "ScaleAction": { + "Direction": "Decrease", + "Type": "ChangeCount", + "Value": "1", + "Cooldown": "PT2H" + } + }, + { + "MetricTrigger": { + "Name": "BytesReceived", + "Namespace": "", + "Resource": "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default- + Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm", + "ResourceLocation": "East US", + "TimeGrain": "PT1M", + "Statistic": "Average", + "TimeWindow": "PT10M", + "TimeAggregation": "Average", + "Operator": "LessThanOrEqual", + "Threshold": 50.0, + "Source": "WebsiteDedicated:eastuswebspace:DefaultServerFarm" + }, + "ScaleAction": { + "Direction": "Decrease", + "Type": "ChangeCount", + "Value": "1", + "Cooldown": "PT10M" + } + }, + { + "MetricTrigger": { + "Name": "BytesReceived", + "Namespace": "", + "Resource": "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default- + Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm", + "ResourceLocation": "East US", + "TimeGrain": "PT1M", + "Statistic": "Average", + "TimeWindow": "PT5M", + "TimeAggregation": "Average", + "Operator": "GreaterThanOrEqual", + "Threshold": 100.0, + "Source": "WebsiteDedicated:eastuswebspace:DefaultServerFarm" + }, + "ScaleAction": { + "Direction": "Increase", + "Type": "ChangeCount", + "Value": "1", + "Cooldown": "PT10M" + } + } + ] + } +ResourceGroupName : Default-Web-EastUS +ResourceProviderName : Microsoft.Insights +ResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ + Microsoft.Insights/autoscalesettings/DefaultServerFarm-Default-Web-EastUS +Status : Succeeded +SubmissionTimestamp : 2/10/2015 2:38:19 AM +SubscriptionId : b93fb07a-6f93-30be-bf3e-4f0deca15f4f +SubStatus : +``` + +This command gets all Autoscale-related events associated with a particular resource identified by the resource's ID (essentially, the ResourceUri). + +## PARAMETERS + +### -Caller +Specifies a caller. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetailedOutput +Indicates that this operation included detailed output. +If you do not specify this parameter, the output is summarized. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EndTime +Specifies the end time of the query in local time. +The default is the current time. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the resource ID to which the autoscale setting is associated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +Specifies the start time of the query in local time. +This parameter is optional. +The default is the current local time minus one hour. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +Specifies a filter by status. +This parameter is optional. +The fault is an empty string (i.e. +no filter) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSEventData + +## NOTES + +## RELATED LINKS + +[Get-AzAutoscaleSetting](./Get-AzAutoscaleSetting.md) + +[Remove-AzAutoscaleSetting](./Remove-AzAutoscaleSetting.md) + + diff --git a/azps-10.1.0/Az.Monitor/Get-AzAutoscalePredictiveMetric.md b/azps-10.1.0/Az.Monitor/Get-AzAutoscalePredictiveMetric.md new file mode 100644 index 0000000000..24292d09f5 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzAutoscalePredictiveMetric.md @@ -0,0 +1,228 @@ +--- +external help file: Az.Autoscale.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azautoscalepredictivemetric +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzAutoscalePredictiveMetric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzAutoscalePredictiveMetric.md +--- + +# Get-AzAutoscalePredictiveMetric + +## SYNOPSIS +get predictive autoscale metric future data + +## SYNTAX + +### GetViaIdentity (Default) +``` +Get-AzAutoscalePredictiveMetric -InputObject <IAutoscaleIdentity> -Aggregation <String> -Interval <TimeSpan> + -MetricName <String> -MetricNamespace <String> -Timespan <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzAutoscalePredictiveMetric -AutoscaleSettingName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] -Aggregation <String> -Interval <TimeSpan> -MetricName <String> + -MetricNamespace <String> -Timespan <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +get predictive autoscale metric future data + +## EXAMPLES + +### Example 1: Get predictive metric for autoscale setting +```powershell +Get-AzAutoscalePredictiveMetric -AutoscaleSettingName test-autoscalesetting -ResourceGroupName test-group -Timespan "2021-10-14T22:00:00.000Z/2021-10-16T22:00:00.000Z" -Aggregation "Total" -Interval ([System.TimeSpan]::New(0,60,0)) -MetricName "PercentageCPU" -MetricNamespace "Microsoft.Compute/virtualMachineScaleSets" +``` + +Get predictive metric for autoscale setting + +## PARAMETERS + +### -Aggregation +The list of aggregation types (comma separated) to retrieve. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoscaleSettingName +The autoscale setting name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.IAutoscaleIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Interval +The interval (i.e. +timegrain) of the query. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricName +The names of the metrics (comma separated) to retrieve. +Special case: If a metricname itself has a comma in it then use %2 to indicate it. +Eg: 'Metric,Name1' should be **'Metric%2Name1'** + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricNamespace +Metric namespace to query metric definitions for. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timespan +The timespan of the query. +It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.IAutoscaleIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IPredictiveResponse + +## 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 <IAutoscaleIdentity>`: Identity Parameter + - `[AutoscaleSettingName <String>]`: The autoscale setting name. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Get-AzAutoscaleSetting.md b/azps-10.1.0/Az.Monitor/Get-AzAutoscaleSetting.md new file mode 100644 index 0000000000..a87622bc14 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzAutoscaleSetting.md @@ -0,0 +1,171 @@ +--- +external help file: Az.Autoscale.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azautoscalesetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzAutoscaleSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzAutoscaleSetting.md +--- + +# Get-AzAutoscaleSetting + +## SYNOPSIS +Gets an autoscale setting + +## SYNTAX + +### List1 (Default) +``` +Get-AzAutoscaleSetting [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzAutoscaleSetting -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzAutoscaleSetting -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzAutoscaleSetting -InputObject <IAutoscaleIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets an autoscale setting + +## EXAMPLES + +### Example 1: List autoscale setting under current subscription +```powershell +Get-AzAutoscaleSetting +``` + +List autoscale setting under current subscription + +### Example 2: List autoscale setting under resource group +```powershell +Get-AzAutoscaleSetting -ResourceGroupName test-group +``` + +List autoscale setting under resource group + +### Example 2: Get autoscale setting by name +```powershell +Get-AzAutoscaleSetting -ResourceGroupName test-group -Name test-autoscalesetting +``` + +Get autoscale setting by name + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.IAutoscaleIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The autoscale setting name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AutoscaleSettingName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: List1, Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.IAutoscaleIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IAutoscaleSettingResource + +## 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 <IAutoscaleIdentity>`: Identity Parameter + - `[AutoscaleSettingName <String>]`: The autoscale setting name. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Get-AzDataCollectionRule.md b/azps-10.1.0/Az.Monitor/Get-AzDataCollectionRule.md new file mode 100644 index 0000000000..5c6bb05300 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzDataCollectionRule.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azdatacollectionrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzDataCollectionRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzDataCollectionRule.md +--- + +# Get-AzDataCollectionRule + +## SYNOPSIS +Gets data collection rule(s). + +## SYNTAX + +### BySubscription (Default) +``` +Get-AzDataCollectionRule [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceGroup +``` +Get-AzDataCollectionRule -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByName +``` +Get-AzDataCollectionRule -ResourceGroupName <String> -RuleName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzDataCollectionRule -RuleId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataCollectionRule** cmdlet gets one or more data collection rules. + +Data Collection Rules (DCR) define data coming into Azure Monitor and specify where that data should be sent or stored. Here is the complete [DCR overview article](https://learn.microsoft.com/azure/azure-monitor/essentials/data-collection-rule-overview). + +## EXAMPLES + +### Example 1: Get data collection rules by subscription ID +```powershell +Get-AzDataCollectionRule +``` + +```output +Description : DCR description +DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources +Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations +DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow} +ProvisioningState : Succeeded +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/testgroup/providers/Microsoft.Insights/dataCollectionRules/testDcr +Name : testDcr +Type : Microsoft.Insights/dataCollectionRules +Location : East US 2 EUAP +Tags : {[tag2, value2], [tag1, value1]} +``` + +This command lists all the data collection rules for the current subscription. + +### Example 2: Get data collection rules for the given resource group +```powershell +Get-AzDataCollectionRule -ResourceGroupName "testgroup" +``` + +```output +Description : DCR description +DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources +Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations +DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow} +ProvisioningState : Succeeded +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/testgroup/providers/Microsoft.Insights/dataCollectionRules/testDcr +Name : testDcr +Type : Microsoft.Insights/dataCollectionRules +Location : East US 2 EUAP +Tags : {[tag2, value2], [tag1, value1]} +``` + +This command lists data collection rules for the given resource group. + +### Example 3: Get a data collection rule +```powershell +Get-AzDataCollectionRule -ResourceGroupName "testgroup" -RuleName "testDcr" +``` + +```output +Description : DCR description +DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources +Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations +DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow} +ProvisioningState : Succeeded +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/testgroup/providers/Microsoft.Insights/dataCollectionRules/testDcr +Name : testDcr +Type : Microsoft.Insights/dataCollectionRules +Location : East US 2 EUAP +Tags : {[tag2, value2], [tag1, value1]} +``` + +This command lists one (a list with a single element) data collection rule. + +### Example 4: Get a data collection rule by Rule ID +```powershell +Get-AzDataCollectionRule -RuleId "/subscriptions/{subId}/resourceGroups/testgroup/providers/Microsoft.Insights/dataCollectionRules/testDcr" +``` + +```output +Description : DCR description +DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources +Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations +DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow} +ProvisioningState : Succeeded +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/testgroup/providers/Microsoft.Insights/dataCollectionRules/testDcr +Name : testDcr +Type : Microsoft.Insights/dataCollectionRules +Location : East US 2 EUAP +Tags : {[tag2, value2], [tag1, value1]} +``` + +This command lists one (a list with a single element) data collection rule. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup, ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleId +The ID of the resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleName +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleResource + +## NOTES + +## RELATED LINKS + +[Set-AzDataCollectionRule](./Set-AzDataCollectionRule.md) +[Remove-AzDataCollectionRule](./Remove-AzDataCollectionRule.md) +[New-AzDataCollectionRule](./New-AzDataCollectionRule.md) +[Update-AzDataCollectionRule](./Update-AzDataCollectionRule.md) diff --git a/azps-10.1.0/Az.Monitor/Get-AzDataCollectionRuleAssociation.md b/azps-10.1.0/Az.Monitor/Get-AzDataCollectionRuleAssociation.md new file mode 100644 index 0000000000..4f0eddf3b1 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzDataCollectionRuleAssociation.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azdatacollectionruleassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzDataCollectionRuleAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzDataCollectionRuleAssociation.md +--- + +# Get-AzDataCollectionRuleAssociation + +## SYNOPSIS +Gets data collection rule association(s). + +## SYNTAX + +### ByAssociatedResource (Default) +``` +Get-AzDataCollectionRuleAssociation -TargetResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByName +``` +Get-AzDataCollectionRuleAssociation -TargetResourceId <String> -AssociationName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByRule +``` +Get-AzDataCollectionRuleAssociation -ResourceGroupName <String> -RuleName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObject +``` +Get-AzDataCollectionRuleAssociation -InputObject <PSDataCollectionRuleResource> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataCollectionRuleAssociation** cmdlet gets one or more data collection rules associations (DCRA). + +To apply a DCR to a virtual machine, you create an association for the virtual machine. A virtual machine may have an association to multiple DCRs, and a DCR may have multiple virtual machines associated to it. This allows you to define a set of DCRs, each matching a particular requirement, and apply them to only the virtual machines where they apply. Here is the ["Configure data collection for the Azure Monitor agent"](https://learn.microsoft.com/azure/azure-monitor/platform/data-collection-rule-azure-monitor-agent) using DCRA article. + +## EXAMPLES + +### Example 1: Get data collection rules associations by target resource ID (associated virtual machine) +```powershell +$vm = Get-AzVM -ResourceGroupName $rg -Name $vmName +Get-AzDataCollectionRuleAssociation -TargetResourceId $vm.Id +``` + +```output +Description : +DataCollectionRuleId : /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.I + nsights/dataCollectionRules/{dcrName} +ProvisioningState : +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.C + ompute/virtualMachines/{vmName}/providers/Microsoft.Insights/dataCollectionRuleAssociations/{assocName} +Name : {assocName} +Type : Microsoft.Insights/dataCollectionRuleAssociations +``` + +This command lists all the data collection rules for the given target resource ID (virtual machine). + +### Example 2: Get data collection rules associations by rule (DCR) +```powershell +Get-AzDataCollectionRuleAssociation -ResourceGroupName $rg -RuleName $dcrName +``` + +```output +Description : +DataCollectionRuleId : /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.I + nsights/dataCollectionRules/{dcrName} +ProvisioningState : +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.C + ompute/virtualMachines/{vmName}/providers/Microsoft.Insights/dataCollectionRuleAssociations/{assocName} +Name : {assocName} +Type : Microsoft.Insights/dataCollectionRuleAssociations +``` + +This command lists data collection rules associations for the given resource group and rule (DCR). + +### Example 3: Get data collection rule associations by input object (PSDataCollectionRuleResource) +```powershell +$dcr = Get-AzDataCollectionRule -ResourceGroupName $rg -RuleName $dcrName +$dcr | Get-AzDataCollectionRuleAssociation +``` + +```output +Description : +DataCollectionRuleId : /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.I + nsights/dataCollectionRules/{dcrName} +ProvisioningState : +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.C + ompute/virtualMachines/{vmName}/providers/Microsoft.Insights/dataCollectionRuleAssociations/{assocName} +Name : {assocName} +Type : Microsoft.Insights/dataCollectionRuleAssociations +``` + +This command lists data collection rules associations for the given input object. + +### Example 4: Get a data collection rule association by target resource ID (associated virtual machine) and association name +```powershell +Get-AzDataCollectionRuleAssociation -TargetResourceId $vm.Id -AssociationName $assocName +``` + +```output +Description : +DataCollectionRuleId : /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.I + nsights/dataCollectionRules/{dcrName} +ProvisioningState : +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.C + ompute/virtualMachines/{vmName}/providers/Microsoft.Insights/dataCollectionRuleAssociations/{assocName} +Name : {assocName} +Type : Microsoft.Insights/dataCollectionRuleAssociations +``` + +This command lists one (a list with a single element) data collection rule association. + +## PARAMETERS + +### -AssociationName +The name of the association. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSDataCollectionRuleResource Object + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleResource +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: ByRule +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleName +The data collection rule name + +```yaml +Type: System.String +Parameter Sets: ByRule +Aliases: DataCollectionRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceId +The associated resource ID + +```yaml +Type: System.String +Parameter Sets: ByAssociatedResource, ByName +Aliases: ResourceUri + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleResource + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleAssociationProxyOnlyResource + +## NOTES + +## RELATED LINKS + +[Remove-AzDataCollectionRuleAssociation](./Remove-AzDataCollectionRuleAssociation.md) +[New-AzDataCollectionRuleAssociation](./New-AzDataCollectionRuleAssociation.md) diff --git a/azps-10.1.0/Az.Monitor/Get-AzDiagnosticSetting.md b/azps-10.1.0/Az.Monitor/Get-AzDiagnosticSetting.md new file mode 100644 index 0000000000..ebfbcb3796 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzDiagnosticSetting.md @@ -0,0 +1,144 @@ +--- +external help file: Az.DiagnosticSetting.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azdiagnosticsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzDiagnosticSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzDiagnosticSetting.md +--- + +# Get-AzDiagnosticSetting + +## SYNOPSIS +Gets the active diagnostic settings for the specified resource. + +## SYNTAX + +### List (Default) +``` +Get-AzDiagnosticSetting -ResourceId <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDiagnosticSetting -Name <String> -ResourceId <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDiagnosticSetting -InputObject <IDiagnosticSettingIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the active diagnostic settings for the specified resource. + +## EXAMPLES + +### Example 1: List diagnostic settings +```powershell +$subscriptionId = (Get-AzContext).Subscription.Id +Get-AzDiagnosticSetting -ResourceId /subscriptions/$subscriptionId/resourceGroups/test-rg-name/providers/Microsoft.AppPlatform/Spring/springcloud-001 +``` + +List diagnostic settings for resource + +### Example 2: Get diagnostic setting by name +```powershell +$subscriptionId = (Get-AzContext).Subscription.Id +Get-AzDiagnosticSetting -ResourceId /subscriptions/$subscriptionId/resourceGroups/test-rg-name/providers/Microsoft.AppPlatform/Spring/springcloud-001 -Name test-setting +``` + +Get diagnostic settings under resource by name + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the diagnostic setting. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The identifier of the resource. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.IDiagnosticSettingsResource + +## 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 <IDiagnosticSettingIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[Name <String>]`: The name of the diagnostic setting. + - `[ResourceUri <String>]`: The identifier of the resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Get-AzDiagnosticSettingCategory.md b/azps-10.1.0/Az.Monitor/Get-AzDiagnosticSettingCategory.md new file mode 100644 index 0000000000..2fbc76fdb8 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzDiagnosticSettingCategory.md @@ -0,0 +1,137 @@ +--- +external help file: Az.DiagnosticSetting.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azdiagnosticsettingcategory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzDiagnosticSettingCategory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzDiagnosticSettingCategory.md +--- + +# Get-AzDiagnosticSettingCategory + +## SYNOPSIS +Gets the diagnostic settings category for the specified resource. + +## SYNTAX + +### List (Default) +``` +Get-AzDiagnosticSettingCategory -ResourceId <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzDiagnosticSettingCategory -Name <String> -ResourceId <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzDiagnosticSettingCategory -InputObject <IDiagnosticSettingIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the diagnostic settings category for the specified resource. + +## EXAMPLES + +### Example 1: List supported diagnostic setting categories +```powershell +$subscriptionId = (Get-AzContext).Subscription.Id +Get-AzDiagnosticSettingCategory -ResourceId /subscriptions/$subscriptionId/resourceGroups/test-rg-name/providers/Microsoft.AppPlatform/Spring/springcloud-001 +``` + +List supported diagnostic setting categories for resource + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the diagnostic setting. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The identifier of the resource. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.IDiagnosticSettingsCategoryResource + +## 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 <IDiagnosticSettingIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[Name <String>]`: The name of the diagnostic setting. + - `[ResourceUri <String>]`: The identifier of the resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Get-AzEventCategory.md b/azps-10.1.0/Az.Monitor/Get-AzEventCategory.md new file mode 100644 index 0000000000..2f16d75b6b --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzEventCategory.md @@ -0,0 +1,79 @@ +--- +external help file: Az.DiagnosticSetting.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azeventcategory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzEventCategory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzEventCategory.md +--- + +# Get-AzEventCategory + +## SYNOPSIS +Get the list of available event categories supported in the Activity Logs Service. +The current list includes the following: Administrative, Security, ServiceHealth, Alert, Recommendation, Policy. + +## SYNTAX + +``` +Get-AzEventCategory [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the list of available event categories supported in the Activity Logs Service. +The current list includes the following: Administrative, Security, ServiceHealth, Alert, Recommendation, Policy. + +## EXAMPLES + +### Example 1: List event categories +```powershell +Get-AzEventCategory +``` + +```output +LocalizedValue Value +-------------- ----- +Administrative Administrative +Security Security +Service Health ServiceHealth +Alert Alert +Recommendation Recommendation +Policy Policy +Autoscale Autoscale +Resource Health ResourceHealth +``` + +List event categories, these are also supported diagnostic setting categories for subscription + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20150401.ILocalizableString + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Get-AzInsightsPrivateLinkScope.md b/azps-10.1.0/Az.Monitor/Get-AzInsightsPrivateLinkScope.md new file mode 100644 index 0000000000..8724d0eafd --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzInsightsPrivateLinkScope.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azinsightsprivatelinkscope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzInsightsPrivateLinkScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzInsightsPrivateLinkScope.md +--- + +# Get-AzInsightsPrivateLinkScope + +## SYNOPSIS +Get private link scope + +## SYNTAX + +### ByResourceGroupParameterSet (Default) +``` +Get-AzInsightsPrivateLinkScope [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByResourceNameParameterSet +``` +Get-AzInsightsPrivateLinkScope -ResourceGroupName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzInsightsPrivateLinkScope -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +List or get private link scope + +## EXAMPLES + +### Example 1 +```powershell +Get-AzInsightsPrivateLinkScope -ResourceGroupName "rg_name" +``` + +List private link scopes under resource group "rg_name" + +### Example 2 +```powershell +Get-AzInsightsPrivateLinkScope -ResourceGroupName "rg_name" -Name "scope_name" +``` + +Get private link scope with name "scope_name" under resource group "rg_name" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Private Link Scope Name + +```yaml +Type: System.String +Parameter Sets: ByResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScope + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Get-AzInsightsPrivateLinkScopedResource.md b/azps-10.1.0/Az.Monitor/Get-AzInsightsPrivateLinkScopedResource.md new file mode 100644 index 0000000000..4392669019 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzInsightsPrivateLinkScopedResource.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azinsightsprivatelinkscopedresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzInsightsPrivateLinkScopedResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzInsightsPrivateLinkScopedResource.md +--- + +# Get-AzInsightsPrivateLinkScopedResource + +## SYNOPSIS +Get for private link scoped resource + +## SYNTAX + +### ByScopeParameterSet (Default) +``` +Get-AzInsightsPrivateLinkScopedResource -ResourceGroupName <String> -ScopeName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObjectParameterSet +``` +Get-AzInsightsPrivateLinkScopedResource [-Name <String>] -InputObject <PSMonitorPrivateLinkScope> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzInsightsPrivateLinkScopedResource -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get or list for private link scoped resource, scoped resource could be Log Analytics workspace or Application Insights component + +## EXAMPLES + +### Example 1 +```powershell +Get-AzInsightsPrivateLinkScopedResource -ResourceGroupName "rg_name" -ScopeName "scope_name" +``` + +List scoped resource under private link scope "scope_name" + +### Example 2 +```powershell +Get-AzInsightsPrivateLinkScopedResource -ResourceGroupName "rg_name" -ScopeName "scope_name" -Name "scoped_resource_name" +``` + +Get scoped resource under private link scope "scope_name" with name "scoped_resource_name" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSMonitorPrivateLinkScope + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScope +Parameter Sets: ByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Scoped resource Name + +```yaml +Type: System.String +Parameter Sets: ByScopeParameterSet, ByInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ByScopeParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeName +Private Link Scope Name + +```yaml +Type: System.String +Parameter Sets: ByScopeParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### icrosoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScopedResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Get-AzLogProfile.md b/azps-10.1.0/Az.Monitor/Get-AzLogProfile.md new file mode 100644 index 0000000000..c319587a1f --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzLogProfile.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: 019EFD94-4087-45F6-812D-FBDFE1B2E48A +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azlogprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzLogProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzLogProfile.md +--- + +# Get-AzLogProfile + +## SYNOPSIS +Gets a log profile. + +## SYNTAX + +``` +Get-AzLogProfile [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLogProfile** cmdlet gets a log profile. + +## EXAMPLES + +### Example 1: Gets a log profile +```powershell +Get-AzLogProfile +``` + +```output +StorageAccountId : /subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/resourceGroups/testrg/providers/Microsoft.Stor +age/storageAccounts/storageaccount +ServiceBusRuleId : +Locations + : eastus +Categories + : Delete + : Write + : Action +RetentionPolicy +Enabled : False +Days : 0 + +Id : +/subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/providers/microsoft.insights/logprofiles/exportlogprofile +Name : exportlogprofile +Type : +Location : +Tags : +Kind : +Etag : +``` + +This command gets a log profile. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the log profile to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSLogProfileCollection + +## NOTES + +## RELATED LINKS + +[Add-AzLogProfile](./Add-AzLogProfile.md) + +[Remove-AzLogProfile](./Remove-AzLogProfile.md) + + diff --git a/azps-10.1.0/Az.Monitor/Get-AzMetric.md b/azps-10.1.0/Az.Monitor/Get-AzMetric.md new file mode 100644 index 0000000000..fa8cc5f876 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzMetric.md @@ -0,0 +1,459 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: EAFB9C98-000C-4EAC-A32D-6B0F1939AA2F +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azmetric +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzMetric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzMetric.md +--- + +# Get-AzMetric + +## SYNOPSIS +Gets the metric values of a resource. + +## SYNTAX + +### GetWithDefaultParameters (Default) +``` +Get-AzMetric [-ResourceId] <String> [-TimeGrain <TimeSpan>] [-StartTime <DateTime>] [-EndTime <DateTime>] + [[-MetricName] <String[]>] [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetWithFullParameters +``` +Get-AzMetric [-ResourceId] <String> [-TimeGrain <TimeSpan>] [-AggregationType <AggregationType>] + [-StartTime <DateTime>] [-EndTime <DateTime>] [-Top <Int32>] [-OrderBy <String>] [-MetricNamespace <String>] + [-ResultType <ResultType>] [-MetricFilter <String>] [-MetricName] <String[]> [-DetailedOutput] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzMetric** cmdlet gets the metric values for a specified resource. + +## EXAMPLES + +### Example 1: Get a metric with summarized output +```powershell +Get-AzMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -TimeGrain 00:01:00 +``` + +```output +DimensionName : +DimensionValue : +Name : AverageResponseTime +EndTime : 3/20/2015 6:40:46 PM +MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, + Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} +Properties : {} +ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3 +StartTime : 3/20/2015 5:40:00 PM +TimeGrain : 00:01:00 +Unit : Seconds +DimensionName : +DimensionValue : +Name : AverageMemoryWorkingSet +EndTime : 3/20/2015 6:40:46 PM +MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, + Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} +Properties : {} +ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3 +StartTime : 3/20/2015 5:40:00 PM +TimeGrain : 00:01:00 +Unit : Bytes +``` + +This command gets the metric values for website3 with a time grain of 1 minute. + +### Example 2: Get a metric with detailed output +```powershell +Get-AzMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -TimeGrain 00:01:00 -DetailedOutput +``` + +```output +MetricValues : + Average : 0 + Count : 1 + Last : + Maximum : + Minimum : + Properties : + Timestamp : 3/20/2015 6:37:00 PM + Total : 0 + Average : 0.106 + Count : 1 + Last : + Maximum : + Minimum : + Properties : + Timestamp : 3/20/2015 6:39:00 PM + Total : 0.106 + Average : 0.064 + Count : 1 + Last : + Maximum : + Minimum : + Properties : + Timestamp : 3/20/2015 6:41:00 PM + Total : 0.064 +Properties : +DimensionName : +DimensionValue : +Name : AverageResponseTime +EndTime : 3/20/2015 6:43:33 PM +ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3 +StartTime : 3/20/2015 5:43:00 PM +TimeGrain : 00:01:00 +Unit : Seconds +``` + +This command gets the metric values for website3 with a time grain of 1 minute. +The output is detailed. + +### Example 3: Get detailed output for a specified metric +```powershell +Get-AzMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -MetricName "Requests" -TimeGrain 00:01:00 -DetailedOutput +``` + +```output +MetricValues : + Average : 1 + Count : 1 + Last : + Maximum : + Minimum : + Properties : + Timestamp : 3/20/2015 6:39:00 PM + Total : 1 + Average : 1 + Count : 1 + Last : + Maximum : + Minimum : + Properties : + Timestamp : 3/20/2015 6:41:00 PM + Total : 1 + Average : 0 + Count : 1 + Last : + Maximum : + Minimum : + Properties : + Timestamp : 3/20/2015 6:43:00 PM + Total : 0 + Average : 1 + Count : 1 + Last : + Maximum : + Minimum : + Properties : + Timestamp : 3/20/2015 6:44:00 PM + Total : 1 + Average : 0 + Count : 1 + Last : + Maximum : + Minimum : + Properties : + Timestamp : 3/20/2015 6:45:00 PM + Total : 0 +Properties : +DimensionName : +DimensionValue : +Name : Requests +EndTime : 3/20/2015 6:47:56 PM +ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3 +StartTime : 3/20/2015 5:47:00 PM +TimeGrain : 00:01:00 +Unit : Count +``` + +This command gets detailed output for the Requests metric. + +### Example 4: Get summarized output for a specified metric with specified dimension filter +```powershell +$dimFilter = @((New-AzMetricFilter -Dimension City -Operator eq -Value "Seattle","Toronto"), (New-AzMetricFilter -Dimension AuthenticationType -Operator eq -Value User)) + +Get-AzMetric -ResourceId <resourceId> -MetricName PageViews -TimeGrain 00:05:00 -MetricFilter $dimFilter -StartTime 2018-02-01T12:00:00Z -EndTime 2018-02-01T12:10:00Z -AggregationType Average +``` + +```output +ResourceId : [ResourceId] +MetricNamespace : Microsoft.Insights/ApplicationInsights +Metric Name : +LocalizedValue : Page Views +Value : PageViews +Unit : Seconds +Timeseries : +City : Seattle +AuthenticationType : User + +Timestamp : 2018-02-01 12:00:00 PM +Average : 3518 + +Timestamp : 2018-02-01 12:05:00 PM +Average : 1984 + +City : Toronto +AuthenticationType : User + +Timestamp : 2018-02-01 12:00:00 PM +Average : 894 + +Timestamp : 2018-02-01 12:05:00 PM +Average : 967 +``` + +This command gets summarized output for the PageViews metric with specified dimension filter and aggregation type. + +## PARAMETERS + +### -AggregationType +The aggregation type of the query + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Monitor.Models.AggregationType] +Parameter Sets: GetWithFullParameters +Aliases: +Accepted values: None, Average, Count, Minimum, Maximum, Total + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetailedOutput +Indicates that this cmdlet displays detailed output. +By default, output is summarized. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EndTime +Specifies the end time of the query in local time. +The default is the current time. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MetricFilter +Specifies the metric dimension filter to query metrics for. + +```yaml +Type: System.String +Parameter Sets: GetWithFullParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MetricName +Specifies an array of names of metrics. + +```yaml +Type: System.String[] +Parameter Sets: GetWithDefaultParameters +Aliases: MetricNames + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String[] +Parameter Sets: GetWithFullParameters +Aliases: MetricNames + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MetricNamespace +Specifies the metric namespace to query metrics for. + +```yaml +Type: System.String +Parameter Sets: GetWithFullParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OrderBy +Specifies the aggregation to use for sorting results and the direction of the sort (Example: sum asc). + +```yaml +Type: System.String +Parameter Sets: GetWithFullParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the resource ID of the metric. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResultType +Specifies the result type to be returned (metadata or data). + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.Monitor.Models.ResultType] +Parameter Sets: GetWithFullParameters +Aliases: +Accepted values: Data, Metadata + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +Specifies the start time of the query in local time. +The default is the current local time minus one hour. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TimeGrain +Specifies the time grain of the metric as a **TimeSpan** object in the format hh:mm:ss. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +Specifies the maximum number of records to retrieve (default:10), to be specified with $filter. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: GetWithFullParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.TimeSpan + +### System.Nullable`1[[Microsoft.Azure.Management.Monitor.Models.AggregationType, Microsoft.Azure.Management.Monitor, Version=0.21.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.DateTime + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[Microsoft.Azure.Management.Monitor.Models.ResultType, Microsoft.Azure.Management.Monitor, Version=0.21.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] + +### System.String[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMetric + +## NOTES + +More information about the supported metrics may be found at: +https://learn.microsoft.com/azure/azure-monitor/platform/metrics-supported + +## RELATED LINKS + +[Get-AzMetricDefinition](./Get-AzMetricDefinition.md) +[New-AzMetricFilter](./New-AzMetricFilter.md) + + diff --git a/azps-10.1.0/Az.Monitor/Get-AzMetricAlertRuleV2.md b/azps-10.1.0/Az.Monitor/Get-AzMetricAlertRuleV2.md new file mode 100644 index 0000000000..c12fef5362 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzMetricAlertRuleV2.md @@ -0,0 +1,266 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azmetricalertrulev2 +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzMetricAlertRuleV2.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzMetricAlertRuleV2.md +--- + +# Get-AzMetricAlertRuleV2 + +## SYNOPSIS +Gets V2 (non-classic) metric alert rules + +## SYNTAX + +### ByResourceGroupName (Default) +``` +Get-AzMetricAlertRuleV2 [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByRuleName +``` +Get-AzMetricAlertRuleV2 -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByRuleId +``` +Get-AzMetricAlertRuleV2 -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzMetricAlertRuleV2** cmdlet gets a metric alert rule by its name or URI, or all metric alert rules from a specified resource group or subscription. + +## EXAMPLES + +### Example 1: Get all metric alert rules in current subscription +```powershell +Get-AzMetricAlertRuleV2 +``` + +```output +TargetResourceId : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricResourceGroup/providers/Microsoft.KeyVault/vaults/GenevaRPKeyVault +Criteria : {Metric1} +Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/sampleresourcegroup/providers/Microsoft.Insights/actiongroups/scnewactiongroup} +ResourceGroup : metricResourceGroup +Description : fdafda +Severity : 3 +Enabled : True +Scopes : {/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricResourceGroup/providers/Microsoft.KeyVault/vaults/GenevaRPKeyVault} +EvaluationFrequency : 00:01:00 +WindowSize : 00:05:00 +TargetResourceType : +TargetResourceRegion : +AutoMitigate : +LastUpdatedTime : +Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricResourceGroup/providers/Microsoft.Insights/metricAlerts/Rule1 +Name : Rule1 +Type : Microsoft.Insights/metricAlerts +Location : global +Tags : {} + +Criteria : {Metric1} +Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/sampleresourcegroup/providers/Microsoft.Insights/actiongroups/scnewactiongroup} +ResourceGroup : SampleResourceGroup +Description : Testing 1 minute granuarity +Severity : 3 +Enabled : True +Scopes : {/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Compute/virtualMachines/SCCMDemo4} +EvaluationFrequency : 00:01:00 +WindowSize : 00:01:00 +TargetResourceType : Microsoft.Compute/virtualMachines +TargetResourceRegion : eastus +AutoMitigate : True +LastUpdatedTime : +Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Insights/metricAlerts/Rule2 +Name : Rule2 +Type : Microsoft.Insights/metricAlerts +Location : global +Tags : {} +``` + +This command gets all the metric alert rules in the current subscription. + +### Example 2: Get all metric alert rules in a resource group + +```powershell +Get-AzMetricAlertRuleV2 -ResourceGroupName metricAlertsRG +``` + +```output +Criteria : {Metric1} +Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/default-activitylogalerts/pr + oviders/Microsoft.Insights/actiongroups/emails} +ResourceGroup : metricAlertsRG +Description : Test Classic VM alert - CPU Usage +Severity : 3 +Enabled : True +Scopes : {/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricAlertsRG/providers/Micr + osoft.ClassicCompute/virtualMachines/VM1} +EvaluationFrequency : 00:01:00 +WindowSize : 00:05:00 +TargetResourceType : Microsoft.ClassicCompute/virtualMachines +TargetResourceRegion : southcentralus +AutoMitigate : True +LastUpdatedTime : +Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricAlertsRG/providers/micro + soft.insights/metricAlerts/Test%20Classic%20VM%20alert%20-%20CPU%20Usage +Name : Test Classic VM alert - CPU Usage +Type : Microsoft.Insights/metricAlerts +Location : global +Tags : {} +``` + +This command gets all the metric alert rules in the resource group named metricAlertsRG. + +### Example 3: Get a metric alert rule by name + +```powershell +Get-AzMetricAlertRuleV2 -ResourceGroupName metricAlertsRG -Name PS3182019 +``` + +```output +Criteria : {metric1} +Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/default-activitylogalerts/providers/Microsoft.Insights/actiongroups/demo} +ResourceGroup : metricAlertsRG +Description : This is description +Severity : 1 +Enabled : True +Scopes : {/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricAlertsRG/providers/Microsoft.Compute/virtualMachines/VM1, + /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricAlertsRG/providers/Microsoft.Compute/virtualMachines/VM2} +EvaluationFrequency : 00:05:00 +WindowSize : 00:05:00 +TargetResourceType : Microsoft.Compute/virtualMachines +TargetResourceRegion : eastus +AutoMitigate : +LastUpdatedTime : +Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricAlertsRG/providers/Microsoft.Insights/metricAlerts/PS3182019 +Name : PS3182019 +Type : Microsoft.Insights/metricAlerts +Location : global +Tags : +``` + +This command gets the metric alert rule named PS3182019 in the resource group named metricAlertsRG. + +### Example 4: Get a metric alert rule by ruleID + +```powershell +Get-AzMetricAlertRuleV2 -ResourceId /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Insights/metricAlerts/MyMetricAlertRule +``` + +```output +TargetResourceId : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Insights/components/alertstestFunction +Criteria : {Metric1} +Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/default-activitylogalerts/providers/Microsoft.Insights/actiongroups/emails} +ResourceGroup : SampleResourceGroup +Description : Test Description +Severity : 3 +Enabled : True +Scopes : {/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Insights/components/alertstestFunction} +EvaluationFrequency : 00:01:00 +WindowSize : 00:05:00 +TargetResourceType : +TargetResourceRegion : +AutoMitigate : +LastUpdatedTime : +Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Insights/metricAlerts/MyMetricAlertRule +Name : MyMetricAlertRule +Type : Microsoft.Insights/metricAlerts +Location : global +Tags : +``` + +This command gets the metric alert rule with the given resource ID. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name of metric alert rule + +```yaml +Type: System.String +Parameter Sets: ByRuleName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The ResourceGroupName + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupName +Aliases: ResourceGroup + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByRuleName +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Rule Id of metric alert rule + +```yaml +Type: System.String +Parameter Sets: ByRuleId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricAlertRuleV2 + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Get-AzMetricDefinition.md b/azps-10.1.0/Az.Monitor/Get-AzMetricDefinition.md new file mode 100644 index 0000000000..4f36e2fb60 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzMetricDefinition.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: 7915A7AC-5A47-4868-B846-2896BCEBFAB2 +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azmetricdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzMetricDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzMetricDefinition.md +--- + +# Get-AzMetricDefinition + +## SYNOPSIS +Gets metric definitions. + +## SYNTAX + +``` +Get-AzMetricDefinition [-ResourceId] <String> [-MetricName <String[]>] [-MetricNamespace <String>] + [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzMetricDefinition** cmdlet gets metric definitions. + +## EXAMPLES + +### Example 1: Get metric definitions for a resource +```powershell +Get-AzMetricDefinition -ResourceId "/subscriptions/d33fb0c7-69d3-40be-e35b-4f0deba70fff/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website2" +``` + +```output +Name : CpuTime +Dimensions : {} +MetricAvailabilities : {Microsoft.Azure.Insights.Models.MetricAvailability, + Microsoft.Azure.Insights.Models.MetricAvailability, + Microsoft.Azure.Insights.Models.MetricAvailability} +PrimaryAggregationType : Total +Properties : {} +ResourceUri : +Unit : Seconds +Name : Requests +Dimensions : {} +MetricAvailabilities : {Microsoft.Azure.Insights.Models.MetricAvailability, + Microsoft.Azure.Insights.Models.MetricAvailability, + Microsoft.Azure.Insights.Models.MetricAvailability} +PrimaryAggregationType : Total +Properties : {} +ResourceUri : +Unit : Count +``` + +This command gets the metrics definitions for the specified resource. + +### Example 2: Get metric definitions with detailed output +```powershell +Get-AzMetricDefinition -ResourceId "/subscriptions/d33fb0c7-69d3-40be-e35b-4f0deba70fff/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website2" -DetailedOutput +``` + +```output +Dimensions : +MetricAvailabilities : + Location : + Retention : 2.00:00:00 + Values : 00:01:00 + Location : + Retention : 30.00:00:00 + Values : 01:00:00 + Location : + Retention : 90.00:00:00 + Values : 1.00:00:00 +Name : CpuTime +Properties : +PrimaryAggregationType : Total +ResourceUri : +Unit : Seconds +Dimensions : +MetricAvailabilities : + Location : + Retention : 2.00:00:00 + Values : 00:01:00 + Location : + Retention : 30.00:00:00 + Values : 01:00:00 + Location : + Retention : 90.00:00:00 + Values : 1.00:00:00 +Name : Requests +Properties : +PrimaryAggregationType : Total +ResourceUri : +Unit : Count +``` + +This command gets the metric definitions for website2. +The output is detailed. + +### Example 3: Get metric definitions by name +```powershell +Get-AzMetricDefinition -ResourceId "/subscriptions/d33fb0c7-69d3-40be-e35b-4f0deba70fff/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website2" -DetailedOutput -MetricName "BytesSent,CpuTime" +``` + +```output +MetricAvailabilities : + Location : + Retention : 2.00:00:00 + Values : 00:01:00 + Location : + Retention : 30.00:00:00 + Values : 01:00:00 + Location : + Retention : 90.00:00:00 + Values : 1.00:00:00 +Name : CpuTime +Properties : +PrimaryAggregationType : Total +ResourceUri : +Unit : Seconds +Dimensions : +MetricAvailabilities : + Location : + Retention : 2.00:00:00 + Values : 00:01:00 + Location : + Retention : 30.00:00:00 + Values : 01:00:00 + Location : + Retention : 90.00:00:00 + Values : 1.00:00:00 +Name : BytesSent +Properties : +PrimaryAggregationType : Total +ResourceUri : +Unit : Bytes +``` + +This command gets definitions for the BytesSent and CpuTime metrics. +The output is detailed. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetailedOutput +Indicates that this operation included detailed output. +If you do not specify this parameter, the output is summarized. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricName +Specifies an array of names of metrics. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MetricNamespace +Specifies the metric namespace to query metric definitions for. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricDefinition + +## NOTES + +More information about the supported metrics may be found at: +https://learn.microsoft.com/azure/azure-monitor/platform/metrics-supported + +## RELATED LINKS + +[Get-AzMetric](./Get-AzMetric.md) +[New-AzMetricFilter](./New-AzMetricFilter.md) + + diff --git a/azps-10.1.0/Az.Monitor/Get-AzMonitorWorkspace.md b/azps-10.1.0/Az.Monitor/Get-AzMonitorWorkspace.md new file mode 100644 index 0000000000..b5f4bf3d0c --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzMonitorWorkspace.md @@ -0,0 +1,191 @@ +--- +external help file: Az.MonitorWorkspace.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azmonitorworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzMonitorWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzMonitorWorkspace.md +--- + +# Get-AzMonitorWorkspace + +## SYNOPSIS +Returns the specific Azure Monitor workspace + +## SYNTAX + +### List1 (Default) +``` +Get-AzMonitorWorkspace [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMonitorWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzMonitorWorkspace -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMonitorWorkspace -InputObject <IMonitorWorkspaceIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns the specific Azure Monitor workspace + +## EXAMPLES + +### Example 1: List the specific Azure Monitor workspace. +```powershell +Get-AzMonitorWorkspace +``` + +```output +Name Location ProvisioningState PublicNetworkAccess ResourceGroupName +---- -------- ----------------- ------------------- ----------------- +azps-monitor-workspace eastus Succeeded Enabled azps_test_group +``` + +List the specific Azure Monitor workspace. + +### Example 2: List the specific Azure Monitor workspace by Resource Groupy. +```powershell +Get-AzMonitorWorkspace -ResourceGroupName azps_test_group +``` + +```output +Name Location ProvisioningState PublicNetworkAccess ResourceGroupName +---- -------- ----------------- ------------------- ----------------- +azps-monitor-workspace eastus Succeeded Enabled azps_test_group +``` + +List the specific Azure Monitor workspace by Resource Groupy. + +### Example 3: Get the specific Azure Monitor workspace by monitor workspace name. +```powershell +Get-AzMonitorWorkspace -ResourceGroupName azps_test_group -Name azps-monitor-workspace +``` + +```output +Name Location ProvisioningState PublicNetworkAccess ResourceGroupName +---- -------- ----------------- ------------------- ----------------- +azps-monitor-workspace eastus Succeeded Enabled azps_test_group +``` + +Get the specific Azure Monitor workspace by monitor workspace name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.IMonitorWorkspaceIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Azure Monitor workspace. +The name is case insensitive + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AzureMonitorWorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: List1, Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.IMonitorWorkspaceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.Api20230403.IAzureMonitorWorkspaceResource + +## 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 <IMonitorWorkspaceIdentity>`: Identity Parameter + - `[AzureMonitorWorkspaceName <String>]`: The name of the Azure Monitor workspace. The name is case insensitive + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Get-AzScheduledQueryRule.md b/azps-10.1.0/Az.Monitor/Get-AzScheduledQueryRule.md new file mode 100644 index 0000000000..492ffa4b31 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzScheduledQueryRule.md @@ -0,0 +1,172 @@ +--- +external help file: Az.ScheduledQueryRule.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azscheduledqueryrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzScheduledQueryRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzScheduledQueryRule.md +--- + +# Get-AzScheduledQueryRule + +## SYNOPSIS +Retrieve an scheduled query rule definition. + +## SYNTAX + +### List (Default) +``` +Get-AzScheduledQueryRule [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzScheduledQueryRule -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzScheduledQueryRule -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzScheduledQueryRule -InputObject <IScheduledQueryRuleIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve an scheduled query rule definition. + +## EXAMPLES + +### Example 1: List scheduled query rules under current subscription +```powershell +Get-AzScheduledQueryRule +``` + +List scheduled query rules under current subscription + +### Example 2: List scheduled query rules for resource group +```powershell +Get-AzScheduledQueryRule -ResourceGroupName "test-group" +``` + +List scheduled query rules for resource group: "test-group" + +### Example 3: Get scheduled query rule by name +```powershell +Get-AzScheduledQueryRule -ResourceGroupName "test-group" -Name "test-rule" +``` + +Get scheduled query rule by name + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.IScheduledQueryRuleIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the rule. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: List, Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.IScheduledQueryRuleIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api20210801.IScheduledQueryRuleResource + +## 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 <IScheduledQueryRuleIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleName <String>]`: The name of the rule. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Get-AzSubscriptionDiagnosticSetting.md b/azps-10.1.0/Az.Monitor/Get-AzSubscriptionDiagnosticSetting.md new file mode 100644 index 0000000000..46f1de0c50 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Get-AzSubscriptionDiagnosticSetting.md @@ -0,0 +1,144 @@ +--- +external help file: Az.DiagnosticSetting.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/get-azsubscriptiondiagnosticsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzSubscriptionDiagnosticSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Get-AzSubscriptionDiagnosticSetting.md +--- + +# Get-AzSubscriptionDiagnosticSetting + +## SYNOPSIS +Gets the active subscription diagnostic settings for the specified resource. + +## SYNTAX + +### List (Default) +``` +Get-AzSubscriptionDiagnosticSetting [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzSubscriptionDiagnosticSetting -Name <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSubscriptionDiagnosticSetting -InputObject <IDiagnosticSettingIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the active subscription diagnostic settings for the specified resource. + +## EXAMPLES + +### Example 1: List diagnostic setting for subscription +```powershell +Get-AzSubscriptionDiagnosticSetting +``` + +List diagnostic setting for current subscription + +### Example 2: Get diagnostic setting for subscription +```powershell +Get-AzSubscriptionDiagnosticSetting -Name test-setting +``` + +Get diagnostic setting by name under current subscription + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the diagnostic setting. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.ISubscriptionDiagnosticSettingsResource + +## 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 <IDiagnosticSettingIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[Name <String>]`: The name of the diagnostic setting. + - `[ResourceUri <String>]`: The identifier of the resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzActionGroupReceiver.md b/azps-10.1.0/Az.Monitor/New-AzActionGroupReceiver.md new file mode 100644 index 0000000000..4ac54d6e3d --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzActionGroupReceiver.md @@ -0,0 +1,781 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: 9830CD16-D797-47EB-BEF5-6CFE3454BCAA +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azactiongroupreceiver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzActionGroupReceiver.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzActionGroupReceiver.md +--- + +# New-AzActionGroupReceiver + +## SYNOPSIS +Creates an new action group receiver. + +## SYNTAX + +### NewEmailReceiver (Default) +``` +New-AzActionGroupReceiver -Name <String> [-UseCommonAlertSchema] [-EmailReceiver] -EmailAddress <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NewEventHubReceiver +``` +New-AzActionGroupReceiver -Name <String> [-UseCommonAlertSchema] [-EventHubReceiver] + -EventHubNameSpace <String> -EventHubName <String> -SubscriptionId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NewSmsReceiver +``` +New-AzActionGroupReceiver -Name <String> [-UseCommonAlertSchema] [-SmsReceiver] [-CountryCode <String>] + -PhoneNumber <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NewWebhookReceiver +``` +New-AzActionGroupReceiver -Name <String> [-UseCommonAlertSchema] [-WebhookReceiver] -ServiceUri <String> + [-UseAadAuth] [-ObjectId <String>] [-IdentifierUri <String>] [-TenantId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NewItsmReceiver +``` +New-AzActionGroupReceiver -Name <String> [-UseCommonAlertSchema] [-ItsmReceiver] -WorkspaceId <String> + -ConnectionId <String> -TicketConfiguration <String> -Region <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NewVoiceReceiver +``` +New-AzActionGroupReceiver -Name <String> [-UseCommonAlertSchema] [-VoiceReceiver] [-VoiceCountryCode <String>] + -VoicePhoneNumber <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NewArmRoleReceiver +``` +New-AzActionGroupReceiver -Name <String> [-UseCommonAlertSchema] [-ArmRoleReceiver] -RoleId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NewAzureFunctionReceiver +``` +New-AzActionGroupReceiver -Name <String> [-UseCommonAlertSchema] [-AzureFunctionReceiver] + -FunctionAppResourceId <String> -HttpTriggerUrl <String> -FunctionName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NewLogicAppReceiver +``` +New-AzActionGroupReceiver -Name <String> [-UseCommonAlertSchema] [-LogicAppReceiver] -ResourceId <String> + -CallbackUrl <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NewAutomationRunbookReceiver +``` +New-AzActionGroupReceiver -Name <String> [-UseCommonAlertSchema] [-AutomationRunbookReceiver] + -AutomationAccountId <String> -RunbookName <String> [-IsGlobalRunbook] -AutomationRunbookServiceUri <String> + -WebhookResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NewAzureAppPushReceiver +``` +New-AzActionGroupReceiver -Name <String> [-UseCommonAlertSchema] [-AzureAppPushReceiver] + -AzureAppPushEmailAddress <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzActionGroupReceiver** cmdlet creates new action group receiver in memory. + +## EXAMPLES + +### Example 1: Create a new Email receiver in memory. +```powershell +$emailReceiver = New-AzActionGroupReceiver -Name 'emailReceiver1' -EmailReceiver -EmailAddress 'user1@example.com' +``` + +This command creates a new Email receiver in memory. + +### Example 2: Create a new SMS receiver in memory. +```powershell +$smsReceiver = New-AzActionGroupReceiver -Name 'smsReceiver1' -SmsReceiver -CountryCode '1' -PhoneNumber '5555555555' +``` + +This command creates a new SMS receiver in memory. + +### Example 3: Create a new webhook receiver in memory. +```powershell +$webhookReceiver = New-AzActionGroupReceiver -Name 'webhookReceiver1' -WebhookReceiver -ServiceUri 'http://test.com' +``` + +This command creates a new webhook receiver in memory. + +## PARAMETERS + +### -ArmRoleReceiver +Create a ArmRoleReceiver + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewArmRoleReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutomationAccountId +the AutomationAccountId + +```yaml +Type: System.String +Parameter Sets: NewAutomationRunbookReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutomationRunbookReceiver +Create a AutomationRunbookReceiver + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewAutomationRunbookReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutomationRunbookServiceUri +the URI where webhooks should be sent + +```yaml +Type: System.String +Parameter Sets: NewAutomationRunbookReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureAppPushEmailAddress +the AzureAppPushEmailAddress + +```yaml +Type: System.String +Parameter Sets: NewAzureAppPushReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureAppPushReceiver +Create a AzureAppPushReceiver + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewAzureAppPushReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureFunctionReceiver +Create a ArmRoleReceiver + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewAzureFunctionReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CallbackUrl +the CallbackUrl + +```yaml +Type: System.String +Parameter Sets: NewLogicAppReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConnectionId +the itsm connection id of this receiver + +```yaml +Type: System.String +Parameter Sets: NewItsmReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CountryCode +Specifies the country code for the SMS receiver. + +```yaml +Type: System.String +Parameter Sets: NewSmsReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddress +Specifies the address for the Email receiver. + +```yaml +Type: System.String +Parameter Sets: NewEmailReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EmailReceiver +Specifies to create an Email receiver + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewEmailReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EventHubName +The EventHubName of the event hub receiver + +```yaml +Type: System.String +Parameter Sets: NewEventHubReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EventHubNameSpace +The name space of the event hub receiver + +```yaml +Type: System.String +Parameter Sets: NewEventHubReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EventHubReceiver +Create a event hub receiver + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewEventHubReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FunctionAppResourceId +the function app resourceId + +```yaml +Type: System.String +Parameter Sets: NewAzureFunctionReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FunctionName +the functionName + +```yaml +Type: System.String +Parameter Sets: NewAzureFunctionReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HttpTriggerUrl +the httpTriggerUrl + +```yaml +Type: System.String +Parameter Sets: NewAzureFunctionReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentifierUri +the Identifier uri for aad auth + +```yaml +Type: System.String +Parameter Sets: NewWebhookReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IsGlobalRunbook +indicating whether this instance is global runbook + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewAutomationRunbookReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ItsmReceiver +Create a ItsmReceiver + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewItsmReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LogicAppReceiver +Create a LogicAppReceiver + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewLogicAppReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name for the receiver. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ObjectId +the webhook app object Id for aad auth + +```yaml +Type: System.String +Parameter Sets: NewWebhookReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PhoneNumber +Specifies the phone number for the SMS receiver. + +```yaml +Type: System.String +Parameter Sets: NewSmsReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Region +the itsm Region of this receiver + +```yaml +Type: System.String +Parameter Sets: NewItsmReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +the ResourceId + +```yaml +Type: System.String +Parameter Sets: NewLogicAppReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoleId +The arm role id of the receiver + +```yaml +Type: System.String +Parameter Sets: NewArmRoleReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunbookName +the RunbookName + +```yaml +Type: System.String +Parameter Sets: NewAutomationRunbookReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceUri +Specifies the URI for the webhook receiver. + +```yaml +Type: System.String +Parameter Sets: NewWebhookReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SmsReceiver +Specifies to create a SMS receiver + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewSmsReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription id of the event hub receiver + +```yaml +Type: System.String +Parameter Sets: NewEventHubReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantId +the tenant id for aad auth + +```yaml +Type: System.String +Parameter Sets: NewWebhookReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TicketConfiguration +the itsm TicketConfiguration of this receiver + +```yaml +Type: System.String +Parameter Sets: NewItsmReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UseAadAuth +the flag to use add auth + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewWebhookReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UseCommonAlertSchema +The flag whether to use common alert schema . This value will be neglectedfor SMS, Azure App push , ITSM and Voice recievers. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VoiceCountryCode +The country code of the voice receiver + +```yaml +Type: System.String +Parameter Sets: NewVoiceReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VoicePhoneNumber +The phone number of the voice receiver + +```yaml +Type: System.String +Parameter Sets: NewVoiceReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VoiceReceiver +Create a voice receiver + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewVoiceReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WebhookReceiver +Specifies to create a webhook receiver + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewWebhookReceiver +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WebhookResourceId +the WebhookResourceId + +```yaml +Type: System.String +Parameter Sets: NewAutomationRunbookReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceId +the itsm workspace id of this receiver + +```yaml +Type: System.String +Parameter Sets: NewItsmReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase + +## NOTES + +## RELATED LINKS + +[Set-AzActionGroup](./Set-AzActionGroup.md) +[Get-AzActionGroup](./Get-AzActionGroup.md) +[Remove-AzActionGroup](./Remove-AzActionGroup.md) diff --git a/azps-10.1.0/Az.Monitor/New-AzActivityLogAlert.md b/azps-10.1.0/Az.Monitor/New-AzActivityLogAlert.md new file mode 100644 index 0000000000..bd5f4bf75b --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzActivityLogAlert.md @@ -0,0 +1,282 @@ +--- +external help file: Az.ActivityLogAlert.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azactivitylogalert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzActivityLogAlert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzActivityLogAlert.md +--- + +# New-AzActivityLogAlert + +## SYNOPSIS +Create a new Activity Log Alert rule or update an existing one. + +## SYNTAX + +``` +New-AzActivityLogAlert -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + -Action <IActionGroup[]> -Condition <IAlertRuleAnyOfOrLeafCondition[]> -Location <String> -Scope <String[]> + [-Description <String>] [-Enabled <Boolean>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new Activity Log Alert rule or update an existing one. + +## EXAMPLES + +### Example 1: Create activity log alert +```powershell +$scope = "subscriptions/"+(Get-AzContext).Subscription.ID +$actiongroup=New-AzActivityLogAlertActionGroupObject -Id $ActionGroupResourceId -WebhookProperty @{"sampleWebhookProperty"="SamplePropertyValue"} +$condition1=New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject -Equal Administrative -Field category +$condition2=New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject -Equal Error -Field level +$any1=New-AzActivityLogAlertAlertRuleLeafConditionObject -Field properties.incidentType -Equal Maintenance +$any2=New-AzActivityLogAlertAlertRuleLeafConditionObject -Field properties.incidentType -Equal Incident +$condition3=New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject -AnyOf $any1,$any2 +New-AzActivityLogAlert -Name $AlertName -ResourceGroupName $ResourceGroupName -Action $actiongroup -Condition @($condition1,$condition2,$condition3) -Location global -Scope $scope +``` + +Create activity log alert for subscription, when `$condition1` and `$condition2` and (`$any1` or `$any2`) fulfilled + +## PARAMETERS + +### -Action +The list of the Action Groups. +To construct, see NOTES section for ACTIONGROUP properties and create a hash table. +To construct, see NOTES section for ACTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.Api20201001.IActionGroup[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Condition +The list of Activity Log Alert rule conditions. +To construct, see NOTES section for CONDITIONALLOF properties and create a hash table. +To construct, see NOTES section for CONDITION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.Api20201001.IAlertRuleAnyOfOrLeafCondition[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description of this Activity Log Alert rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Indicates whether this Activity Log Alert rule is enabled. +If an Activity Log Alert rule is not enabled, then none of its actions will be activated. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. +Since Azure Activity Log Alerts is a global service, the location of the rules should always be 'global'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Activity Log Alert rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ActivityLogAlertName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +A list of resource IDs that will be used as prefixes. +The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. +This list must include at least one item. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags of the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.Api20201001.IActivityLogAlertResource + +## 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. + + +`ACTION <IActionGroup[]>`: The list of the Action Groups. To construct, see NOTES section for ACTIONGROUP properties and create a hash table. + - `Id <String>`: The resource ID of the Action Group. This cannot be null or empty. + - `[WebhookProperty <IActionGroupWebhookProperties>]`: the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +`CONDITION <IAlertRuleAnyOfOrLeafCondition[]>`: The list of Activity Log Alert rule conditions. To construct, see NOTES section for CONDITIONALLOF properties and create a hash table. + - `[ContainsAny <String[]>]`: The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met. + - `[Equal <String>]`: The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met. + - `[Field <String>]`: The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'. + - `[AnyOf <IAlertRuleLeafCondition[]>]`: An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met. + - `[ContainsAny <String[]>]`: The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met. + - `[Equal <String>]`: The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met. + - `[Field <String>]`: The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzActivityLogAlertActionGroupObject.md b/azps-10.1.0/Az.Monitor/New-AzActivityLogAlertActionGroupObject.md new file mode 100644 index 0000000000..b701742c77 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzActivityLogAlertActionGroupObject.md @@ -0,0 +1,90 @@ +--- +external help file: Az.ActivityLogAlert.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzActivityLogAlertActionGroupObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzActivityLogAlertActionGroupObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzActivityLogAlertActionGroupObject.md +--- + +# New-AzActivityLogAlertActionGroupObject + +## SYNOPSIS +Create an in-memory object for ActionGroup. + +## SYNTAX + +``` +New-AzActivityLogAlertActionGroupObject -Id <String> [-WebhookProperty <IActionGroupWebhookProperties>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ActionGroup. + +## EXAMPLES + +### Example 1: Create action group object +```powershell +New-AzActivityLogAlertActionGroupObject -Id $ActionGroupResourceId -WebhookProperty @{"sampleWebhookProperty"="SamplePropertyValue"} +``` + +Create action group object + +## PARAMETERS + +### -Id +The resource ID of the Action Group. +This cannot be null or empty. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebhookProperty +the dictionary of custom properties to include with the post operation. +These data are appended to the webhook payload. +To construct, see NOTES section for WEBHOOKPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.Api20201001.IActionGroupWebhookProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.Api20201001.ActionGroup + +## 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. + + +`WEBHOOKPROPERTY <IActionGroupWebhookProperties>`: the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject.md b/azps-10.1.0/Az.Monitor/New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject.md new file mode 100644 index 0000000000..88b5f95ad9 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject.md @@ -0,0 +1,129 @@ +--- +external help file: Az.ActivityLogAlert.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject.md +--- + +# New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject + +## SYNOPSIS +Create an in-memory object for AlertRuleAnyOfOrLeafCondition. + +## SYNTAX + +``` +New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject [-AnyOf <IAlertRuleLeafCondition[]>] + [-ContainsAny <String[]>] [-Equal <String>] [-Field <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AlertRuleAnyOfOrLeafCondition. + +## EXAMPLES + +### Example 1: Create alert rule condition +```powershell +New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject -Equal Administrative -Field category +``` + +Create alert rule condition + +### Example 2: Create alert rule condition with leaf condition +```powershell +$any=New-AzActivityLogAlertAlertRuleLeafConditionObject -Field properties.incidentType -Equal Maintenance +New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject -AnyOf $any +``` + +Create alert rule condition with leaf condition + +## PARAMETERS + +### -AnyOf +An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met. +To construct, see NOTES section for ANYOF properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.Api20201001.IAlertRuleLeafCondition[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainsAny +The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Equal +The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Field +The name of the Activity Log event's field that this condition will examine. + The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.Api20201001.AlertRuleAnyOfOrLeafCondition + +## 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. + + +`ANYOF <IAlertRuleLeafCondition[]>`: An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met. + - `[ContainsAny <String[]>]`: The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met. + - `[Equal <String>]`: The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met. + - `[Field <String>]`: The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzActivityLogAlertAlertRuleLeafConditionObject.md b/azps-10.1.0/Az.Monitor/New-AzActivityLogAlertAlertRuleLeafConditionObject.md new file mode 100644 index 0000000000..001606f868 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzActivityLogAlertAlertRuleLeafConditionObject.md @@ -0,0 +1,95 @@ +--- +external help file: Az.ActivityLogAlert.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzActivityLogAlertAlertRuleLeafConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzActivityLogAlertAlertRuleLeafConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzActivityLogAlertAlertRuleLeafConditionObject.md +--- + +# New-AzActivityLogAlertAlertRuleLeafConditionObject + +## SYNOPSIS +Create an in-memory object for AlertRuleLeafCondition. + +## SYNTAX + +``` +New-AzActivityLogAlertAlertRuleLeafConditionObject [-ContainsAny <String[]>] [-Equal <String>] + [-Field <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AlertRuleLeafCondition. + +## EXAMPLES + +### Example 1: Create Alert rule leaf condition +```powershell +New-AzActivityLogAlertAlertRuleLeafConditionObject -Field properties.incidentType -Equal Maintenance +``` + +Create Alert rule leaf condition + +## PARAMETERS + +### -ContainsAny +The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Equal +The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Field +The name of the Activity Log event's field that this condition will examine. + The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.Api20201001.AlertRuleLeafCondition + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzAlertRuleEmail.md b/azps-10.1.0/Az.Monitor/New-AzAlertRuleEmail.md new file mode 100644 index 0000000000..35aed91178 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzAlertRuleEmail.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: B1000C10-265E-4465-B167-F1251470BE3E +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azalertruleemail +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAlertRuleEmail.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAlertRuleEmail.md +--- + +# New-AzAlertRuleEmail + +## SYNOPSIS +Creates an email action for an alert rule. + +## SYNTAX + +``` +New-AzAlertRuleEmail [[-CustomEmail] <String[]>] [-SendToServiceOwner] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzAlertRuleEmail** cmdlet creates an e-mail action for an alert rule. + +## EXAMPLES + +### Example 1: Create an alert rule email action for service owners +```powershell +New-AzAlertRuleEmail -SendToServiceOwner +``` + +This command creates an alert rule email action to send for its service owners when an alert rule is fired. + +### Example 2: Create an alert rule email action for non-service owners +```powershell +New-AzAlertRuleEmail -CustomEmail pattif@contoso.com,davidchew@contoso.net +``` + +This command creates an alert rule email action for the specified email addresses, but not for the service owners. + +### Example 3: Create an alert rule email action for service owners and non-service owners +```powershell +New-AzAlertRuleEmail -CustomEmail pattif@contoso.net -SendToServiceOwner +``` + +This command creates an alert rule email action for the specified address and for its service owners. + +## PARAMETERS + +### -CustomEmail +Specifies a list of comma-separated e-mail addresses. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendToServiceOwner +Indicates that this operation sends an e-mail to the service owners when the rule fires. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Management.Monitor.Management.Models.RuleEmailAction + +## NOTES + +## RELATED LINKS + +[Add-AzMetricAlertRule](./Add-AzMetricAlertRule.md) + +[Add-AzWebtestAlertRule](./Add-AzWebtestAlertRule.md) + +[New-AzAlertRuleWebhook](./New-AzAlertRuleWebhook.md) + + diff --git a/azps-10.1.0/Az.Monitor/New-AzAlertRuleWebhook.md b/azps-10.1.0/Az.Monitor/New-AzAlertRuleWebhook.md new file mode 100644 index 0000000000..b866034a79 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzAlertRuleWebhook.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: 0137ECA3-37E1-4064-8A65-A582519E9017 +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azalertrulewebhook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAlertRuleWebhook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAlertRuleWebhook.md +--- + +# New-AzAlertRuleWebhook + +## SYNOPSIS +Creates an alert rule webhook. + +## SYNTAX + +``` +New-AzAlertRuleWebhook [-ServiceUri] <String> [[-Property] <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzAlertRuleWebhook** cmdlet creates an alert rule webhook. + +## EXAMPLES + +### Example 1: Create an alert rule webhook +```powershell +New-AzAlertRuleWebhook -ServiceUri "http://contoso.com" +``` + +This command creates an alert rule webhook by specifying only the service URI. + +### Example 2: Create a webhook with one property +```powershell +$Actual = New-AzAlertRuleWebhook -ServiceUri "http://contoso.com" -Property @{prop1 = 'value1'} +``` + +This command creates an alert rule webhook for Contoso.com that has one property, and then stores it in the $Actual variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +Specifies the list of properties in the format @(property1 = 'value1',....). + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceUri +Specifies the service URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Management.Monitor.Management.Models.RuleWebhookAction + +## NOTES + +## RELATED LINKS + +[Add-AzMetricAlertRule](./Add-AzMetricAlertRule.md) + +[Add-AzWebtestAlertRule](./Add-AzWebtestAlertRule.md) + +[New-AzAlertRuleEmail](./New-AzAlertRuleEmail.md) diff --git a/azps-10.1.0/Az.Monitor/New-AzAutoscaleNotificationObject.md b/azps-10.1.0/Az.Monitor/New-AzAutoscaleNotificationObject.md new file mode 100644 index 0000000000..3456c0b5ca --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzAutoscaleNotificationObject.md @@ -0,0 +1,123 @@ +--- +external help file: Az.Autoscale.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzAutoscaleNotificationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAutoscaleNotificationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAutoscaleNotificationObject.md +--- + +# New-AzAutoscaleNotificationObject + +## SYNOPSIS +Create an in-memory object for AutoscaleNotification. + +## SYNTAX + +``` +New-AzAutoscaleNotificationObject [-EmailCustomEmail <String[]>] + [-EmailSendToSubscriptionAdministrator <Boolean>] [-EmailSendToSubscriptionCoAdministrator <Boolean>] + [-Webhook <IWebhookNotification[]>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AutoscaleNotification. + +## EXAMPLES + +### Example 1: Create web hook notification object +```powershell +$webhook1=New-AzAutoscaleWebhookNotificationObject -Property @{} -ServiceUri "http://myservice.com" +New-AzAutoscaleNotificationObject -EmailCustomEmail "gu@ms.com" -EmailSendToSubscriptionAdministrator $true -EmailSendToSubscriptionCoAdministrator $true -Webhook $webhook1 +``` + +Create web hook notification object + +## PARAMETERS + +### -EmailCustomEmail +the custom e-mails list. +This value can be null or empty, in which case this attribute will be ignored. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailSendToSubscriptionAdministrator +a value indicating whether to send email to subscription administrator. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailSendToSubscriptionCoAdministrator +a value indicating whether to send email to subscription co-administrators. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Webhook +the collection of webhook notifications. +To construct, see NOTES section for WEBHOOK properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IWebhookNotification[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.AutoscaleNotification + +## 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. + + +`WEBHOOK <IWebhookNotification[]>`: the collection of webhook notifications. + - `[Property <IWebhookNotificationProperties>]`: a property bag of settings. This value can be empty. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[ServiceUri <String>]`: the service address to receive the notification. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzAutoscaleProfileObject.md b/azps-10.1.0/Az.Monitor/New-AzAutoscaleProfileObject.md new file mode 100644 index 0000000000..93e4d265dc --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzAutoscaleProfileObject.md @@ -0,0 +1,304 @@ +--- +external help file: Az.Autoscale.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzAutoscaleProfileObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAutoscaleProfileObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAutoscaleProfileObject.md +--- + +# New-AzAutoscaleProfileObject + +## SYNOPSIS +Create an in-memory object for AutoscaleProfile. + +## SYNTAX + +``` +New-AzAutoscaleProfileObject -CapacityDefault <String> -CapacityMaximum <String> -CapacityMinimum <String> + -Name <String> -Rule <IScaleRule[]> [-FixedDateEnd <DateTime>] [-FixedDateStart <DateTime>] + [-FixedDateTimeZone <String>] [-RecurrenceFrequency <RecurrenceFrequency>] [-ScheduleDay <String[]>] + [-ScheduleHour <Int32[]>] [-ScheduleMinute <Int32[]>] [-ScheduleTimeZone <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AutoscaleProfile. + +## EXAMPLES + +### Example 1: Create autoscale profile object +```powershell +$subscriptionId = (Get-AzContext).Subscription.Id +$rule1=New-AzAutoscaleScaleRuleObject -MetricTriggerMetricName "Percentage CPU" -MetricTriggerMetricResourceUri "/subscriptions/$subscriptionId/resourceGroups/test-group/providers/Microsoft.Compute/virtualMachineScaleSets/test-vmss" -MetricTriggerTimeGrain ([System.TimeSpan]::New(0,1,0)) -MetricTriggerStatistic "Average" -MetricTriggerTimeWindow ([System.TimeSpan]::New(0,5,0)) -MetricTriggerTimeAggregation "Average" -MetricTriggerOperator "GreaterThan" -MetricTriggerThreshold 10 -MetricTriggerDividePerInstance $false -ScaleActionDirection "Increase" -ScaleActionType "ChangeCount" -ScaleActionValue 1 -ScaleActionCooldown ([System.TimeSpan]::New(0,5,0)) +New-AzAutoscaleProfileObject -Name "adios" -CapacityDefault 1 -CapacityMaximum 10 -CapacityMinimum 1 -Rule $rule1 -FixedDateEnd ([System.DateTime]::Parse("2022-12-31T14:00:00Z")) -FixedDateStart ([System.DateTime]::Parse("2022-12-31T13:00:00Z")) -FixedDateTimeZone "UTC" +``` + +Create autoscale profile object + +## PARAMETERS + +### -CapacityDefault +the number of instances that will be set if metrics are not available for evaluation. +The default is only used if the current instance count is lower than the default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapacityMaximum +the maximum number of instances for the resource. +The actual maximum number of instances is limited by the cores that are available in the subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapacityMinimum +the minimum number of instances for the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FixedDateEnd +the end time for the profile in ISO 8601 format. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FixedDateStart +the start time for the profile in ISO 8601 format. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FixedDateTimeZone +the timezone of the start and end times for the profile. +Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. +South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. +Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. +Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. +Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. +Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. +Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. +Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. +Australia Standard Time, AUS Central Standard Time, E. +Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +the name of the profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrenceFrequency +the recurrence frequency. +How often the schedule profile should take effect. +This value must be Week, meaning each week will have the same set of profiles. +For example, to set a daily schedule, set **schedule** to every day of the week. +The frequency property specifies that the schedule is repeated weekly. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Support.RecurrenceFrequency +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +the collection of rules that provide the triggers and parameters for the scaling action. +A maximum of 10 rules can be specified. +To construct, see NOTES section for RULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IScaleRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleDay +the collection of days that the profile takes effect on. +Possible values are Sunday through Saturday. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleHour +A collection of hours that the profile takes effect on. +Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported). + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleMinute +A collection of minutes at which the profile takes effect at. + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleTimeZone +the timezone for the hours of the profile. +Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. +South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. +Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. +Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. +Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. +Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. +Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. +Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. +Australia Standard Time, AUS Central Standard Time, E. +Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.AutoscaleProfile + +## 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. + + +`RULE <IScaleRule[]>`: the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified. + - `MetricTriggerMetricName <String>`: the name of the metric that defines what the rule monitors. + - `MetricTriggerMetricResourceUri <String>`: the resource identifier of the resource the rule monitors. + - `MetricTriggerOperator <ComparisonOperationType>`: the operator that is used to compare the metric data and the threshold. + - `MetricTriggerStatistic <MetricStatisticType>`: the metric statistic type. How the metrics from multiple instances are combined. + - `MetricTriggerThreshold <Double>`: the threshold of the metric that triggers the scale action. + - `MetricTriggerTimeAggregation <TimeAggregationType>`: time aggregation type. How the data that is collected should be combined over time. The default value is Average. + - `MetricTriggerTimeGrain <TimeSpan>`: the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute. + - `MetricTriggerTimeWindow <TimeSpan>`: the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes. + - `ScaleActionCooldown <TimeSpan>`: the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format. + - `ScaleActionDirection <ScaleDirection>`: the scale direction. Whether the scaling action increases or decreases the number of instances. + - `ScaleActionType <ScaleType>`: the type of action that should occur when the scale rule fires. + - `[MetricTriggerDimension <IScaleRuleMetricDimension[]>]`: List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}]. + - `DimensionName <String>`: Name of the dimension. + - `Operator <ScaleRuleMetricDimensionOperationType>`: the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values + - `Value <String[]>`: list of dimension values. For example: ["App1","App2"]. + - `[MetricTriggerDividePerInstance <Boolean?>]`: a value indicating whether metric should divide per instance. + - `[MetricTriggerMetricNamespace <String>]`: the namespace of the metric that defines what the rule monitors. + - `[MetricTriggerMetricResourceLocation <String>]`: the location of the resource the rule monitors. + - `[ScaleActionValue <String>]`: the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzAutoscaleScaleRuleMetricDimensionObject.md b/azps-10.1.0/Az.Monitor/New-AzAutoscaleScaleRuleMetricDimensionObject.md new file mode 100644 index 0000000000..b3800ff592 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzAutoscaleScaleRuleMetricDimensionObject.md @@ -0,0 +1,98 @@ +--- +external help file: Az.Autoscale.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzAutoscaleScaleRuleMetricDimensionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAutoscaleScaleRuleMetricDimensionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAutoscaleScaleRuleMetricDimensionObject.md +--- + +# New-AzAutoscaleScaleRuleMetricDimensionObject + +## SYNOPSIS +Create an in-memory object for ScaleRuleMetricDimension. + +## SYNTAX + +``` +New-AzAutoscaleScaleRuleMetricDimensionObject -DimensionName <String> + -Operator <ScaleRuleMetricDimensionOperationType> -Value <String[]> [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ScaleRuleMetricDimension. + +## EXAMPLES + +### Example 1: Create scale rule metric dimension object +```powershell +New-AzAutoscaleScaleRuleMetricDimensionObject -DimensionName VMName -Operator 'Equals' -Value test-vm +``` + +Create scale rule metric dimension object + +## PARAMETERS + +### -DimensionName +Name of the dimension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operator +the dimension operator. +Only 'Equals' and 'NotEquals' are supported. +'Equals' being equal to any of the values. +'NotEquals' being not equal to all of the values. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Support.ScaleRuleMetricDimensionOperationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +list of dimension values. +For example: ["App1","App2"]. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.ScaleRuleMetricDimension + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzAutoscaleScaleRuleObject.md b/azps-10.1.0/Az.Monitor/New-AzAutoscaleScaleRuleObject.md new file mode 100644 index 0000000000..22b0ee0c31 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzAutoscaleScaleRuleObject.md @@ -0,0 +1,319 @@ +--- +external help file: Az.Autoscale.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzAutoscaleScaleRuleObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAutoscaleScaleRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAutoscaleScaleRuleObject.md +--- + +# New-AzAutoscaleScaleRuleObject + +## SYNOPSIS +Create an in-memory object for ScaleRule. + +## SYNTAX + +``` +New-AzAutoscaleScaleRuleObject -MetricTriggerMetricName <String> -MetricTriggerMetricResourceUri <String> + -MetricTriggerOperator <ComparisonOperationType> -MetricTriggerStatistic <MetricStatisticType> + -MetricTriggerThreshold <Double> -MetricTriggerTimeAggregation <TimeAggregationType> + -MetricTriggerTimeGrain <TimeSpan> -MetricTriggerTimeWindow <TimeSpan> -ScaleActionCooldown <TimeSpan> + -ScaleActionDirection <ScaleDirection> -ScaleActionType <ScaleType> + [-MetricTriggerDimension <IScaleRuleMetricDimension[]>] [-MetricTriggerDividePerInstance <Boolean>] + [-MetricTriggerMetricNamespace <String>] [-MetricTriggerMetricResourceLocation <String>] + [-ScaleActionValue <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ScaleRule. + +## EXAMPLES + +### Example 1: Create scale rule object +```powershell +$subscriptionId = (Get-AzContext).Subscription.Id +New-AzAutoscaleScaleRuleObject -MetricTriggerMetricName "Percentage CPU" -MetricTriggerMetricResourceUri "/subscriptions/$subscriptionId/resourceGroups/test-group/providers/Microsoft.Compute/virtualMachineScaleSets/test-vmss" -MetricTriggerTimeGrain ([System.TimeSpan]::New(0,1,0)) -MetricTriggerStatistic "Average" -MetricTriggerTimeWindow ([System.TimeSpan]::New(0,5,0)) -MetricTriggerTimeAggregation "Average" -MetricTriggerOperator "GreaterThan" -MetricTriggerThreshold 10 -MetricTriggerDividePerInstance $false -ScaleActionDirection "Increase" -ScaleActionType "ChangeCount" -ScaleActionValue 1 -ScaleActionCooldown ([System.TimeSpan]::New(0,5,0)) +``` + +Create scale rule object + +## PARAMETERS + +### -MetricTriggerDimension +List of dimension conditions. +For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}]. +To construct, see NOTES section for METRICTRIGGERDIMENSION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IScaleRuleMetricDimension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricTriggerDividePerInstance +a value indicating whether metric should divide per instance. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricTriggerMetricName +the name of the metric that defines what the rule monitors. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricTriggerMetricNamespace +the namespace of the metric that defines what the rule monitors. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricTriggerMetricResourceLocation +the location of the resource the rule monitors. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricTriggerMetricResourceUri +the resource identifier of the resource the rule monitors. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricTriggerOperator +the operator that is used to compare the metric data and the threshold. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Support.ComparisonOperationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricTriggerStatistic +the metric statistic type. +How the metrics from multiple instances are combined. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Support.MetricStatisticType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricTriggerThreshold +the threshold of the metric that triggers the scale action. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricTriggerTimeAggregation +time aggregation type. +How the data that is collected should be combined over time. +The default value is Average. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Support.TimeAggregationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricTriggerTimeGrain +the granularity of metrics the rule monitors. +Must be one of the predefined values returned from metric definitions for the metric. +Must be between 12 hours and 1 minute. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricTriggerTimeWindow +the range of time in which instance data is collected. +This value must be greater than the delay in metric collection, which can vary from resource-to-resource. +Must be between 12 hours and 5 minutes. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleActionCooldown +the amount of time to wait since the last scaling action before this action occurs. +It must be between 1 week and 1 minute in ISO 8601 format. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleActionDirection +the scale direction. +Whether the scaling action increases or decreases the number of instances. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Support.ScaleDirection +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleActionType +the type of action that should occur when the scale rule fires. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Support.ScaleType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleActionValue +the number of instances that are involved in the scaling action. +This value must be 1 or greater. +The default value is 1. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.ScaleRule + +## 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. + + +`METRICTRIGGERDIMENSION <IScaleRuleMetricDimension[]>`: List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}]. + - `DimensionName <String>`: Name of the dimension. + - `Operator <ScaleRuleMetricDimensionOperationType>`: the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values + - `Value <String[]>`: list of dimension values. For example: ["App1","App2"]. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzAutoscaleSetting.md b/azps-10.1.0/Az.Monitor/New-AzAutoscaleSetting.md new file mode 100644 index 0000000000..8b00c5be3a --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzAutoscaleSetting.md @@ -0,0 +1,467 @@ +--- +external help file: Az.Autoscale.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azautoscalesetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAutoscaleSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAutoscaleSetting.md +--- + +# New-AzAutoscaleSetting + +## SYNOPSIS +Creates or updates an autoscale setting. + +## SYNTAX + +### CreateViaIdentity (Default) +``` +New-AzAutoscaleSetting -InputObject <IAutoscaleIdentity> -Parameter <IAutoscaleSettingResource> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateExpanded +``` +New-AzAutoscaleSetting -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] -Location <String> + -Profile <IAutoscaleProfile[]> [-Enabled] [-Notification <IAutoscaleNotification[]>] + [-PredictiveAutoscalePolicyScaleLookAheadTime <TimeSpan>] + [-PredictiveAutoscalePolicyScaleMode <PredictiveAutoscalePolicyScaleMode>] [-PropertiesName <String>] + [-Tag <Hashtable>] [-TargetResourceLocation <String>] [-TargetResourceUri <String>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an autoscale setting. + +## EXAMPLES + +### Example 1: Create autoscale setting for vmss +```powershell +$subscriptionId = (Get-AzContext).Subscription.Id +$rule1=New-AzAutoscaleScaleRuleObject -MetricTriggerMetricName "Percentage CPU" -MetricTriggerMetricResourceUri "/subscriptions/$subscriptionId/resourceGroups/test-group/providers/Microsoft.Compute/virtualMachineScaleSets/test-vmss" -MetricTriggerTimeGrain ([System.TimeSpan]::New(0,1,0)) -MetricTriggerStatistic "Average" -MetricTriggerTimeWindow ([System.TimeSpan]::New(0,5,0)) -MetricTriggerTimeAggregation "Average" -MetricTriggerOperator "GreaterThan" -MetricTriggerThreshold 10 -MetricTriggerDividePerInstance $false -ScaleActionDirection "Increase" -ScaleActionType "ChangeCount" -ScaleActionValue 1 -ScaleActionCooldown ([System.TimeSpan]::New(0,5,0)) +$profile1=New-AzAutoscaleProfileObject -Name "adios" -CapacityDefault 1 -CapacityMaximum 10 -CapacityMinimum 1 -Rule $rule1 -FixedDateEnd ([System.DateTime]::Parse("2022-12-31T14:00:00Z")) -FixedDateStart ([System.DateTime]::Parse("2022-12-31T13:00:00Z")) -FixedDateTimeZone "UTC" +$webhook1=New-AzAutoscaleWebhookNotificationObject -Property @{} -ServiceUri "http://myservice.com" +$notification1=New-AzAutoscaleNotificationObject -EmailCustomEmail "gu@ms.com" -EmailSendToSubscriptionAdministrator $true -EmailSendToSubscriptionCoAdministrator $true -Webhook $webhook1 +New-AzAutoscaleSetting -Name test-autoscalesetting -ResourceGroupName test-group -Location westeurope -Profile $profile1 -Enabled -Notification $notification1 -PredictiveAutoscalePolicyScaleLookAheadTime ([System.TimeSpan]::New(0,5,0)) -PredictiveAutoscalePolicyScaleMode 'Enabled' -PropertiesName "test-autoscalesetting" -TargetResourceUri "/subscriptions/$subscriptionId/resourceGroups/test-group/providers/Microsoft.Compute/virtualMachineScaleSets/test-vmss" +``` + +Create autoscale setting for vmss + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +the enabled flag. +Specifies whether automatic scaling is enabled for the resource. +The default value is 'false'. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.IAutoscaleIdentity +Parameter Sets: CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The autoscale setting name. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: AutoscaleSettingName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notification +the collection of notifications. +To construct, see NOTES section for NOTIFICATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IAutoscaleNotification[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +The autoscale setting resource. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IAutoscaleSettingResource +Parameter Sets: CreateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PredictiveAutoscalePolicyScaleLookAheadTime +the amount of time to specify by which instances are launched in advance. +It must be between 1 minute and 60 minutes in ISO 8601 format. + +```yaml +Type: System.TimeSpan +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PredictiveAutoscalePolicyScaleMode +the predictive autoscale mode + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Support.PredictiveAutoscalePolicyScaleMode +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Profile +the collection of automatic scaling profiles that specify different scaling parameters for different time periods. +A maximum of 20 profiles can be specified. +To construct, see NOTES section for PROFILE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IAutoscaleProfile[] +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertiesName +the name of the autoscale setting. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets a list of key value pairs that describe the resource. +These tags can be used in viewing and grouping this resource (across resource groups). +A maximum of 15 tags can be provided for a resource. +Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceLocation +the location of the resource that the autoscale setting should be added to. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceUri +the resource identifier of the resource that the autoscale setting should be added to. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IAutoscaleSettingResource + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.IAutoscaleIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IAutoscaleSettingResource + +## 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 <IAutoscaleIdentity>`: Identity Parameter + - `[AutoscaleSettingName <String>]`: The autoscale setting name. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`NOTIFICATION <IAutoscaleNotification[]>`: the collection of notifications. + - `[EmailCustomEmail <String[]>]`: the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored. + - `[EmailSendToSubscriptionAdministrator <Boolean?>]`: a value indicating whether to send email to subscription administrator. + - `[EmailSendToSubscriptionCoAdministrator <Boolean?>]`: a value indicating whether to send email to subscription co-administrators. + - `[Webhook <IWebhookNotification[]>]`: the collection of webhook notifications. + - `[Property <IWebhookNotificationProperties>]`: a property bag of settings. This value can be empty. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[ServiceUri <String>]`: the service address to receive the notification. + +`PARAMETER <IAutoscaleSettingResource>`: The autoscale setting resource. + - `Location <String>`: Resource location + - `Profile <IAutoscaleProfile[]>`: the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified. + - `CapacityDefault <String>`: the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default. + - `CapacityMaximum <String>`: the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription. + - `CapacityMinimum <String>`: the minimum number of instances for the resource. + - `Name <String>`: the name of the profile. + - `Rule <IScaleRule[]>`: the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified. + - `MetricTriggerMetricName <String>`: the name of the metric that defines what the rule monitors. + - `MetricTriggerMetricResourceUri <String>`: the resource identifier of the resource the rule monitors. + - `MetricTriggerOperator <ComparisonOperationType>`: the operator that is used to compare the metric data and the threshold. + - `MetricTriggerStatistic <MetricStatisticType>`: the metric statistic type. How the metrics from multiple instances are combined. + - `MetricTriggerThreshold <Double>`: the threshold of the metric that triggers the scale action. + - `MetricTriggerTimeAggregation <TimeAggregationType>`: time aggregation type. How the data that is collected should be combined over time. The default value is Average. + - `MetricTriggerTimeGrain <TimeSpan>`: the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute. + - `MetricTriggerTimeWindow <TimeSpan>`: the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes. + - `ScaleActionCooldown <TimeSpan>`: the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format. + - `ScaleActionDirection <ScaleDirection>`: the scale direction. Whether the scaling action increases or decreases the number of instances. + - `ScaleActionType <ScaleType>`: the type of action that should occur when the scale rule fires. + - `[MetricTriggerDimension <IScaleRuleMetricDimension[]>]`: List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}]. + - `DimensionName <String>`: Name of the dimension. + - `Operator <ScaleRuleMetricDimensionOperationType>`: the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values + - `Value <String[]>`: list of dimension values. For example: ["App1","App2"]. + - `[MetricTriggerDividePerInstance <Boolean?>]`: a value indicating whether metric should divide per instance. + - `[MetricTriggerMetricNamespace <String>]`: the namespace of the metric that defines what the rule monitors. + - `[MetricTriggerMetricResourceLocation <String>]`: the location of the resource the rule monitors. + - `[ScaleActionValue <String>]`: the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. + - `[FixedDateEnd <DateTime?>]`: the end time for the profile in ISO 8601 format. + - `[FixedDateStart <DateTime?>]`: the start time for the profile in ISO 8601 format. + - `[FixedDateTimeZone <String>]`: the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time + - `[RecurrenceFrequency <RecurrenceFrequency?>]`: the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set **schedule** to every day of the week. The frequency property specifies that the schedule is repeated weekly. + - `[ScheduleDay <String[]>]`: the collection of days that the profile takes effect on. Possible values are Sunday through Saturday. + - `[ScheduleHour <Int32[]>]`: A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported). + - `[ScheduleMinute <Int32[]>]`: A collection of minutes at which the profile takes effect at. + - `[ScheduleTimeZone <String>]`: the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Tag <IResourceTags>]`: Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[Enabled <Boolean?>]`: the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'false'. + - `[Notification <IAutoscaleNotification[]>]`: the collection of notifications. + - `[EmailCustomEmail <String[]>]`: the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored. + - `[EmailSendToSubscriptionAdministrator <Boolean?>]`: a value indicating whether to send email to subscription administrator. + - `[EmailSendToSubscriptionCoAdministrator <Boolean?>]`: a value indicating whether to send email to subscription co-administrators. + - `[Webhook <IWebhookNotification[]>]`: the collection of webhook notifications. + - `[Property <IWebhookNotificationProperties>]`: a property bag of settings. This value can be empty. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[ServiceUri <String>]`: the service address to receive the notification. + - `[PredictiveAutoscalePolicyScaleLookAheadTime <TimeSpan?>]`: the amount of time to specify by which instances are launched in advance. It must be between 1 minute and 60 minutes in ISO 8601 format. + - `[PredictiveAutoscalePolicyScaleMode <PredictiveAutoscalePolicyScaleMode?>]`: the predictive autoscale mode + - `[PropertiesName <String>]`: the name of the autoscale setting. + - `[TargetResourceLocation <String>]`: the location of the resource that the autoscale setting should be added to. + - `[TargetResourceUri <String>]`: the resource identifier of the resource that the autoscale setting should be added to. + +`PROFILE <IAutoscaleProfile[]>`: the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified. + - `CapacityDefault <String>`: the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default. + - `CapacityMaximum <String>`: the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription. + - `CapacityMinimum <String>`: the minimum number of instances for the resource. + - `Name <String>`: the name of the profile. + - `Rule <IScaleRule[]>`: the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified. + - `MetricTriggerMetricName <String>`: the name of the metric that defines what the rule monitors. + - `MetricTriggerMetricResourceUri <String>`: the resource identifier of the resource the rule monitors. + - `MetricTriggerOperator <ComparisonOperationType>`: the operator that is used to compare the metric data and the threshold. + - `MetricTriggerStatistic <MetricStatisticType>`: the metric statistic type. How the metrics from multiple instances are combined. + - `MetricTriggerThreshold <Double>`: the threshold of the metric that triggers the scale action. + - `MetricTriggerTimeAggregation <TimeAggregationType>`: time aggregation type. How the data that is collected should be combined over time. The default value is Average. + - `MetricTriggerTimeGrain <TimeSpan>`: the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute. + - `MetricTriggerTimeWindow <TimeSpan>`: the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes. + - `ScaleActionCooldown <TimeSpan>`: the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format. + - `ScaleActionDirection <ScaleDirection>`: the scale direction. Whether the scaling action increases or decreases the number of instances. + - `ScaleActionType <ScaleType>`: the type of action that should occur when the scale rule fires. + - `[MetricTriggerDimension <IScaleRuleMetricDimension[]>]`: List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}]. + - `DimensionName <String>`: Name of the dimension. + - `Operator <ScaleRuleMetricDimensionOperationType>`: the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values + - `Value <String[]>`: list of dimension values. For example: ["App1","App2"]. + - `[MetricTriggerDividePerInstance <Boolean?>]`: a value indicating whether metric should divide per instance. + - `[MetricTriggerMetricNamespace <String>]`: the namespace of the metric that defines what the rule monitors. + - `[MetricTriggerMetricResourceLocation <String>]`: the location of the resource the rule monitors. + - `[ScaleActionValue <String>]`: the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. + - `[FixedDateEnd <DateTime?>]`: the end time for the profile in ISO 8601 format. + - `[FixedDateStart <DateTime?>]`: the start time for the profile in ISO 8601 format. + - `[FixedDateTimeZone <String>]`: the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time + - `[RecurrenceFrequency <RecurrenceFrequency?>]`: the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set **schedule** to every day of the week. The frequency property specifies that the schedule is repeated weekly. + - `[ScheduleDay <String[]>]`: the collection of days that the profile takes effect on. Possible values are Sunday through Saturday. + - `[ScheduleHour <Int32[]>]`: A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported). + - `[ScheduleMinute <Int32[]>]`: A collection of minutes at which the profile takes effect at. + - `[ScheduleTimeZone <String>]`: the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzAutoscaleWebhookNotificationObject.md b/azps-10.1.0/Az.Monitor/New-AzAutoscaleWebhookNotificationObject.md new file mode 100644 index 0000000000..a6a0cf1852 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzAutoscaleWebhookNotificationObject.md @@ -0,0 +1,89 @@ +--- +external help file: Az.Autoscale.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzAutoscaleWebhookNotificationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAutoscaleWebhookNotificationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzAutoscaleWebhookNotificationObject.md +--- + +# New-AzAutoscaleWebhookNotificationObject + +## SYNOPSIS +Create an in-memory object for WebhookNotification. + +## SYNTAX + +``` +New-AzAutoscaleWebhookNotificationObject [-Property <IWebhookNotificationProperties>] [-ServiceUri <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for WebhookNotification. + +## EXAMPLES + +### Example 1: Create webhook nofitication object +```powershell +New-AzAutoscaleWebhookNotificationObject -Property @{} -ServiceUri "http://myservice.com" +``` + +Create webhook nofitication object + +## PARAMETERS + +### -Property +a property bag of settings. +This value can be empty. +To construct, see NOTES section for PROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IWebhookNotificationProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceUri +the service address to receive the notification. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.WebhookNotification + +## 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 <IWebhookNotificationProperties>`: a property bag of settings. This value can be empty. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzDataCollectionRule.md b/azps-10.1.0/Az.Monitor/New-AzDataCollectionRule.md new file mode 100644 index 0000000000..3d2f94b7eb --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzDataCollectionRule.md @@ -0,0 +1,251 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azdatacollectionrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDataCollectionRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDataCollectionRule.md +--- + +# New-AzDataCollectionRule + +## SYNOPSIS +Create a data collection rule. + +## SYNTAX + +``` +New-AzDataCollectionRule -Location <String> -ResourceGroupName <String> -RuleName <String> -RuleFile <String> + [-Description <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataCollectionRule** cmdlet creates a data collection rule. + +Data Collection Rules (DCR) define data coming into Azure Monitor and specify where that data should be sent or stored. Here is the complete [DCR overview article](https://learn.microsoft.com/azure/azure-monitor/essentials/data-collection-rule-overview). + +To use the -RuleFile parameter, construct a json file containing three properties: dataSources, destinations, dataFlows (see Example #1) + +You may find here the [schema detail](https://learn.microsoft.com/rest/api/monitor/datacollectionrules/create). + +The output of a DCR serialized with the cmdlet ConvertTo-Json is also supported (see Example #2). + +## EXAMPLES + +### Example 1: Create data collection rule, JSON from Rest API +```powershell +New-AzDataCollectionRule -Location 'East US 2 EUAP' -ResourceGroupName 'testdcr' ` + -RuleName 'newDcrEx1' -RuleFile 'C:\samples\dcrEx1.json' ` + -Description 'Dcr description' ` + -Tag @{"tag1"="value1"; "tag2"="value2"} +``` + +```output +Description : Dcr description +DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources +Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations +DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow} +ProvisioningState : Succeeded +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/newDcrEx1 +Name : newDcrEx1 +Type : Microsoft.Insights/dataCollectionRules +Location : East US 2 EUAP +Tags : {[tag2, value2], [tag1, value1]} + +# Note: Content of C:\samples\dcrEx1.json +{ + "properties": { + "dataSources": { + "performanceCounters": [ + { + "streams": [ + "Microsoft-InsightsMetrics" + ], + "scheduledTransferPeriod": "PT1M", + "samplingFrequencyInSeconds": 10, + "counterSpecifiers": [ + "\\Processor Information(_Total)\\% Processor Time" + ], + "name": "perfCounter01" + } + ] + }, + "destinations": { + "azureMonitorMetrics": { + "name": "azureMonitorMetrics-default" + } + }, + "dataFlows": [ + { + "streams": [ + "Microsoft-InsightsMetrics" + ], + "destinations": [ + "azureMonitorMetrics-default" + ] + } + ] + } +} +``` + +This command creates a data collection rules for the current subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The resource description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleFile +The JSON file path + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleName +The resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleResource + +## NOTES + +## RELATED LINKS + +[Set-AzDataCollectionRule](./Set-AzDataCollectionRule.md) +[Remove-AzDataCollectionRule](./Remove-AzDataCollectionRule.md) +[Get-AzDataCollectionRule](./Get-AzDataCollectionRule.md) +[Update-AzDataCollectionRule](./Update-AzDataCollectionRule.md) diff --git a/azps-10.1.0/Az.Monitor/New-AzDataCollectionRuleAssociation.md b/azps-10.1.0/Az.Monitor/New-AzDataCollectionRuleAssociation.md new file mode 100644 index 0000000000..0ca7526afd --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzDataCollectionRuleAssociation.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azdatacollectionruleassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDataCollectionRuleAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDataCollectionRuleAssociation.md +--- + +# New-AzDataCollectionRuleAssociation + +## SYNOPSIS +Create data collection rule association. + +## SYNTAX + +### ByDataCollectionRuleId (Default) +``` +New-AzDataCollectionRuleAssociation -TargetResourceId <String> -AssociationName <String> -RuleId <String> + [-Description <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +New-AzDataCollectionRuleAssociation -TargetResourceId <String> -AssociationName <String> + [-Description <String>] -InputObject <PSDataCollectionRuleResource> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataCollectionRuleAssociation** cmdlet creates a data collection rules association (DCRA). + +To apply a DCR to a virtual machine, you create an association for the virtual machine. A virtual machine may have an association to multiple DCRs, and a DCR may have multiple virtual machines associated to it. This allows you to define a set of DCRs, each matching a particular requirement, and apply them to only the virtual machines where they apply. Here is the ["Configure data collection for the Azure Monitor agent"](https://learn.microsoft.com/azure/azure-monitor/platform/data-collection-rule-azure-monitor-agent) using DCRA article. + +## EXAMPLES + +### Example 1: Create data collection rule association +```powershell +$dcr = Get-AzDataCollectionRule -ResourceGroupName $rg -RuleName $dcrName +$vmId = '/subscriptions/{subId}/resourceGroups/{resourcegroup}/providers/Microsoft.Compute/virtualMachines/{vmName}' +New-AzDataCollectionRuleAssociation -TargetResourceId $vmId -AssociationName "dcrAssoc" -RuleId $dcr.Id +``` + +```output +Description : +DataCollectionRuleId : /subscriptions/{subId}/resourceGroups/{resourcegroup}/providers/Microsoft.Insights/dataCollectionRules/{dcrName} +ProvisioningState : +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/{resourcegroup}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Insights/dataCollectionRuleAssociations/dcrAssoc +Name : dcrAssoc +Type : Microsoft.Insights/dataCollectionRuleAssociations +``` + +This command creates a data collection rule association for given rule and target resource ID. + +### Example 2: Create data collection rule association from a DCR object +```powershell +$dcr = Get-AzDataCollectionRule -ResourceGroupName $rg -RuleName $dcrName +$vmId = '/subscriptions/{subId}/resourceGroups/{resourcegroup}/providers/Microsoft.Compute/virtualMachines/{vmName}' +$dcr | New-AzDataCollectionRuleAssociation -TargetResourceId $vmId -AssociationName "dcrAssocInput" +``` + +```output +Description : +DataCollectionRuleId : /subscriptions/{subId}/resourceGroups/{resourcegroup}/providers/Microsoft.Insights/dataCollectionRules/{dcrName} +ProvisioningState : +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/{resourcegroup}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Insights/dataCollectionRuleAssociations/dcrAssocInput +Name : dcrAssocInput +Type : Microsoft.Insights/dataCollectionRuleAssociations +``` + +This command creates a data collection rule association for given rule and target resource ID. + +## PARAMETERS + +### -AssociationName +The resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The resource description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSDataCollectionRuleResource Object + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleResource +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RuleId +The data collection rule ID + +```yaml +Type: System.String +Parameter Sets: ByDataCollectionRuleId +Aliases: DataCollectionRuleId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceId +The resource ID to associate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceUri + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleAssociationProxyOnlyResource + +## NOTES + +## RELATED LINKS + +[Remove-AzDataCollectionRuleAssociation](./Remove-AzDataCollectionRuleAssociation.md) +[Get-AzDataCollectionRuleAssociation](./Get-AzDataCollectionRuleAssociation.md) diff --git a/azps-10.1.0/Az.Monitor/New-AzDiagnosticSetting.md b/azps-10.1.0/Az.Monitor/New-AzDiagnosticSetting.md new file mode 100644 index 0000000000..335bb4a023 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzDiagnosticSetting.md @@ -0,0 +1,307 @@ +--- +external help file: Az.DiagnosticSetting.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azdiagnosticsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDiagnosticSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDiagnosticSetting.md +--- + +# New-AzDiagnosticSetting + +## SYNOPSIS +Creates or updates diagnostic settings for the specified resource. + +## SYNTAX + +``` +New-AzDiagnosticSetting -Name <String> -ResourceId <String> [-EventHubAuthorizationRuleId <String>] + [-EventHubName <String>] [-Log <ILogSettings[]>] [-LogAnalyticsDestinationType <String>] + [-MarketplacePartnerId <String>] [-Metric <IMetricSettings[]>] [-ServiceBusRuleId <String>] + [-StorageAccountId <String>] [-WorkspaceId <String>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates diagnostic settings for the specified resource. + +## EXAMPLES + +### Example 1: Create diagnostic setting +```powershell +$subscriptionId = (Get-AzContext).Subscription.Id +$metric = @() +$log = @() +$metric += New-AzDiagnosticSettingMetricSettingsObject -Enabled $true -Category AllMetrics -RetentionPolicyDay 7 -RetentionPolicyEnabled $true +$log += New-AzDiagnosticSettingLogSettingsObject -Enabled $true -Category ContainerEventLogs -RetentionPolicyDay 7 -RetentionPolicyEnabled $true +New-AzDiagnosticSetting -Name test-setting -ResourceId /subscriptions/$subscriptionId/resourceGroups/test-rg-name/providers/Microsoft.AppPlatform/Spring/springcloud-001 -WorkspaceId /subscriptions/$subscriptionId/resourcegroups/test-rg-name/providers/microsoft.operationalinsights/workspaces/test-workspace -Log $log -Metric $metric +``` + +Create diagnostic setting for resource with log analytics workspace as destination + +### Example 2: Create diagnostic setting for all supported categories +```powershell +$subscriptionId = (Get-AzContext).Subscription.Id +$metric = @() +$log = @() +$categories = Get-AzDiagnosticSettingCategory -ResourceId /subscriptions/$subscriptionId/resourceGroups/test-rg-name/providers/Microsoft.AppPlatform/Spring/springcloud-001 +$categories | ForEach-Object {if($_.CategoryType -eq "Metrics"){$metric+=New-AzDiagnosticSettingMetricSettingsObject -Enabled $true -Category $_.Name -RetentionPolicyDay 7 -RetentionPolicyEnabled $true} else{$log+=New-AzDiagnosticSettingLogSettingsObject -Enabled $true -Category $_.Name -RetentionPolicyDay 7 -RetentionPolicyEnabled $true}} +New-AzDiagnosticSetting -Name test-setting -ResourceId /subscriptions/$subscriptionId/resourceGroups/test-rg-name/providers/Microsoft.AppPlatform/Spring/springcloud-001 -WorkspaceId /subscriptions/$subscriptionId/resourcegroups/test-rg-name/providers/microsoft.operationalinsights/workspaces/test-workspace -Log $log -Metric $metric +``` + +Create diagnostic setting for all supported categories + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubAuthorizationRuleId +The resource Id for the event hub authorization rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the event hub. +If none is specified, the default event hub will be selected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Log +The list of logs settings. +To construct, see NOTES section for LOG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.ILogSettings[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticsDestinationType +A string indicating whether the export to Log Analytics should use the default destination type, i.e. +AzureDiagnostics, or use a destination type constructed as follows: \<normalized service identity\>_\<normalized category name\>. +Possible values are: Dedicated and null (null is default.) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplacePartnerId +The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metric +The list of metric settings. +To construct, see NOTES section for METRIC properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.IMetricSettings[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the diagnostic setting. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The identifier of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceBusRuleId +The service bus rule Id of the diagnostic setting. +This is here to maintain backwards compatibility. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountId +The resource ID of the storage account to which you would like to send Diagnostic Logs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceId +The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. +Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.IDiagnosticSettingsResource + +## 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. + + +`LOG <ILogSettings[]>`: The list of logs settings. + - `Enabled <Boolean>`: a value indicating whether this log is enabled. + - `[Category <String>]`: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. + - `[CategoryGroup <String>]`: Name of a Diagnostic Log category group for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. + - `[RetentionPolicyDay <Int32?>]`: the number of days for the retention in days. A value of 0 will retain the events indefinitely. + - `[RetentionPolicyEnabled <Boolean?>]`: a value indicating whether the retention policy is enabled. + +`METRIC <IMetricSettings[]>`: The list of metric settings. + - `Enabled <Boolean>`: a value indicating whether this category is enabled. + - `[Category <String>]`: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation. + - `[RetentionPolicyDay <Int32?>]`: the number of days for the retention in days. A value of 0 will retain the events indefinitely. + - `[RetentionPolicyEnabled <Boolean?>]`: a value indicating whether the retention policy is enabled. + - `[TimeGrain <TimeSpan?>]`: the timegrain of the metric in ISO8601 format. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzDiagnosticSettingLogSettingsObject.md b/azps-10.1.0/Az.Monitor/New-AzDiagnosticSettingLogSettingsObject.md new file mode 100644 index 0000000000..2beb561492 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzDiagnosticSettingLogSettingsObject.md @@ -0,0 +1,127 @@ +--- +external help file: Az.DiagnosticSetting.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzDiagnosticSettingLogSettingsObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDiagnosticSettingLogSettingsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDiagnosticSettingLogSettingsObject.md +--- + +# New-AzDiagnosticSettingLogSettingsObject + +## SYNOPSIS +Create an in-memory object for LogSettings. + +## SYNTAX + +``` +New-AzDiagnosticSettingLogSettingsObject -Enabled <Boolean> [-Category <String>] [-CategoryGroup <String>] + [-RetentionPolicyDay <Int32>] [-RetentionPolicyEnabled <Boolean>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for LogSettings. + +## EXAMPLES + +### Example 1: Create log setting object +```powershell +New-AzDiagnosticSettingLogSettingsObject -Enabled $true -Category ContainerEventLogs -RetentionPolicyDay 7 -RetentionPolicyEnabled $true +``` + +Create log setting object, to get supported categories for resource, please see `Get-AzDiagnosticSettingCategory` + +## PARAMETERS + +### -Category +Name of a Diagnostic Log category for a resource type this setting is applied to. +To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CategoryGroup +Name of a Diagnostic Log category group for a resource type this setting is applied to. +To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +a value indicating whether this log is enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicyDay +the number of days for the retention in days. +A value of 0 will retain the events indefinitely. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicyEnabled +a value indicating whether the retention policy is enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.LogSettings + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzDiagnosticSettingMetricSettingsObject.md b/azps-10.1.0/Az.Monitor/New-AzDiagnosticSettingMetricSettingsObject.md new file mode 100644 index 0000000000..f97a8b1d39 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzDiagnosticSettingMetricSettingsObject.md @@ -0,0 +1,126 @@ +--- +external help file: Az.DiagnosticSetting.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzDiagnosticSettingMetricSettingsObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDiagnosticSettingMetricSettingsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDiagnosticSettingMetricSettingsObject.md +--- + +# New-AzDiagnosticSettingMetricSettingsObject + +## SYNOPSIS +Create an in-memory object for MetricSettings. + +## SYNTAX + +``` +New-AzDiagnosticSettingMetricSettingsObject -Enabled <Boolean> [-Category <String>] + [-RetentionPolicyDay <Int32>] [-RetentionPolicyEnabled <Boolean>] [-TimeGrain <TimeSpan>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for MetricSettings. + +## EXAMPLES + +### Example 1: Create metric setting object +```powershell +New-AzDiagnosticSettingMetricSettingsObject -Enabled $true -Category AllMetrics -RetentionPolicyDay 7 -RetentionPolicyEnabled $true +``` + +Create metric setting object, to get supported categories for resource, please see `Get-AzDiagnosticSettingCategory` + +## PARAMETERS + +### -Category +Name of a Diagnostic Metric category for a resource type this setting is applied to. +To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +a value indicating whether this category is enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicyDay +the number of days for the retention in days. +A value of 0 will retain the events indefinitely. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicyEnabled +a value indicating whether the retention policy is enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeGrain +the timegrain of the metric in ISO8601 format. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.MetricSettings + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzDiagnosticSettingSubscriptionLogSettingsObject.md b/azps-10.1.0/Az.Monitor/New-AzDiagnosticSettingSubscriptionLogSettingsObject.md new file mode 100644 index 0000000000..4b895a4e00 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzDiagnosticSettingSubscriptionLogSettingsObject.md @@ -0,0 +1,94 @@ +--- +external help file: Az.DiagnosticSetting.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzDiagnosticSettingSubscriptionLogSettingsObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDiagnosticSettingSubscriptionLogSettingsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDiagnosticSettingSubscriptionLogSettingsObject.md +--- + +# New-AzDiagnosticSettingSubscriptionLogSettingsObject + +## SYNOPSIS +Create an in-memory object for SubscriptionLogSettings. + +## SYNTAX + +``` +New-AzDiagnosticSettingSubscriptionLogSettingsObject -Enabled <Boolean> [-Category <String>] + [-CategoryGroup <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SubscriptionLogSettings. + +## EXAMPLES + +### Example 1: Create subscription log setting object +```powershell +New-AzDiagnosticSettingSubscriptionLogSettingsObject -Category Recommendation -Enabled $true +``` + +Create subscription log setting object, to get supported categories for resource, please see `Get-AzEventCategory` + +## PARAMETERS + +### -Category +Name of a Subscription Diagnostic Log category for a resource type this setting is applied to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CategoryGroup +Name of a Subscription Diagnostic Log category group for a resource type this setting is applied to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +a value indicating whether this log is enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.SubscriptionLogSettings + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzInsightsPrivateLinkScope.md b/azps-10.1.0/Az.Monitor/New-AzInsightsPrivateLinkScope.md new file mode 100644 index 0000000000..fd8b6a6501 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzInsightsPrivateLinkScope.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azinsightsprivatelinkscope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzInsightsPrivateLinkScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzInsightsPrivateLinkScope.md +--- + +# New-AzInsightsPrivateLinkScope + +## SYNOPSIS +create private link scope + +## SYNTAX + +``` +New-AzInsightsPrivateLinkScope -Location <String> -ResourceGroupName <String> -Name <String> [-Tags <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +create private link scope + +## EXAMPLES + +### Example 1 +```powershell +New-AzInsightsPrivateLinkScope -Location "eastus" -ResourceGroupName "rg_name" -Name "scope_name" +``` + +create private link scope with name "scope_name" under resource group "rg_name" in location "eastus" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Private Link Scope Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +Tags + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScope + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzInsightsPrivateLinkScopedResource.md b/azps-10.1.0/Az.Monitor/New-AzInsightsPrivateLinkScopedResource.md new file mode 100644 index 0000000000..e3ed18cb81 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzInsightsPrivateLinkScopedResource.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azinsightsprivatelinkscopedresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzInsightsPrivateLinkScopedResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzInsightsPrivateLinkScopedResource.md +--- + +# New-AzInsightsPrivateLinkScopedResource + +## SYNOPSIS +create for private link scoped resource + +## SYNTAX + +### ByResourceNameParameterSet (Default) +``` +New-AzInsightsPrivateLinkScopedResource -LinkedResourceId <String> -ResourceGroupName <String> + -ScopeName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObjectParameterSet +``` +New-AzInsightsPrivateLinkScopedResource -LinkedResourceId <String> -Name <String> + -InputObject <PSMonitorPrivateLinkScope> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +create for private link scoped resource, scoped resource could be Log Analytics workspace or Application Insights component + +## EXAMPLES + +### Example 1 +```powershell +$ai = Get-AzApplicationInsights -ResourceGroupName "rg_name" -Name "ai_name" + +New-AzInsightsPrivateLinkScopedResource -LinkedResourceId $ai.Id -ResourceGroupName "rg_name" -ScopeName "scope_name" -Name "scoped_resource_name" +``` + +create scoped resource "scoped_resource_name" linked to application insights component "ai_name" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSMonitorPrivateLinkScope + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScope +Parameter Sets: ByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkedResourceId +LA/AI Resource Id to Link + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Scoped resource Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ByResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeName +Private Link Scope Name + +```yaml +Type: System.String +Parameter Sets: ByResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScope + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScopedResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzMetricAlertRuleV2Criteria.md b/azps-10.1.0/Az.Monitor/New-AzMetricAlertRuleV2Criteria.md new file mode 100644 index 0000000000..0c4c7ae8ad --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzMetricAlertRuleV2Criteria.md @@ -0,0 +1,392 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azmetricalertrulev2criteria +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzMetricAlertRuleV2Criteria.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzMetricAlertRuleV2Criteria.md +--- + +# New-AzMetricAlertRuleV2Criteria + +## SYNOPSIS +Creates a local criteria object that can be used to create a new metric alert + +## SYNTAX + +### StaticThresholdParameterSet (Default) +``` +New-AzMetricAlertRuleV2Criteria -MetricName <String> [-MetricNamespace <String>] + [-SkipMetricValidation <Boolean>] [-DimensionSelection <PSMetricDimension[]>] -TimeAggregation <String> + -Operator <String> -Threshold <Double> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DynamicThresholdParameterSet +``` +New-AzMetricAlertRuleV2Criteria [-DynamicThreshold] -MetricName <String> [-MetricNamespace <String>] + [-SkipMetricValidation <Boolean>] [-DimensionSelection <PSMetricDimension[]>] -TimeAggregation <String> + -Operator <String> [-ThresholdSensitivity <String>] [-ViolationCount <Int32>] + [-ExaminedAggregatedPointCount <Int32>] [-IgnoreDataBefore <DateTime>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### WebtestParameterSet +``` +New-AzMetricAlertRuleV2Criteria [-WebTest] -WebTestId <String> -ApplicationInsightsId <String> + [-FailedLocationCount <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzMetricAlertRuleV2Criteria** cmdlet creates a local metric criteria object to be used as an input [Add-AzMetricAlertRuleV2](https://learn.microsoft.com/powershell/module/az.monitor/add-azmetricalertrulev2) cmdlet which creates a new metric alert rule. + +## EXAMPLES + +### Example 1: Create a simple metric alert criteria + +```powershell +New-AzMetricAlertRuleV2Criteria -MetricName "Percentage CPU" -MetricNameSpace "Microsoft.Compute/virtualMachines" -TimeAggregation Average -Operator GreaterThan -Threshold 5 +``` + +```output +CriterionType : StaticThresholdCriterion +OperatorProperty : GreaterThan +Threshold : 5 +AdditionalProperties : +Name : metric1 +MetricName : Percentage CPU +MetricNamespace : Microsoft.Compute/virtualMachines +TimeAggregation : Average +Dimensions : +``` + +This command creates a simple metric alert criteria that can be used in a metric alert rule + +### Example 2: Create a dynamic metric alert criteria + +```powershell +New-AzMetricAlertRuleV2Criteria -DynamicThreshold -MetricName "Percentage CPU" -MetricNameSpace "Microsoft.Compute/virtualMachines" -TimeAggregation Average -Operator GreaterThan -ThresholdSensitivity Medium -ViolationCount 2 -ExaminedAggregatedPointCount 4 +``` + +```output +CriterionType : DynamicThresholdCriterion +OperatorProperty : GreaterThan +AlertSensitivity : Medium +FailingPeriods : Microsoft.Azure.Management.Monitor.Models.DynamicThresholdFailingPeriods +IgnoreDataBefore : +AdditionalProperties : +Name : metric1 +MetricName : Percentage CPU +MetricNamespace : Microsoft.Compute/virtualMachines +TimeAggregation : Average +Dimensions : +``` + +This command creates a Dynamic metric alert criteria that can be used in a metric alert rule + +### Example 3: Create a more complex metric alert criteria + +```powershell +New-AzMetricAlertRuleV2DimensionSelection -DimensionName "availabilityResult/name" -ValuesToInclude "gdtest" | New-AzMetricAlertRuleV2Criteria -MetricName "availabilityResults/availabilityPercentage" -TimeAggregation Average -Operator GreaterThan -Threshold 2 +``` + +```output +CriterionType : StaticThresholdCriterion +OperatorProperty : GreaterThan +Threshold : 2 +AdditionalProperties : +Name : metric1 +MetricName : availabilityResults/availabilityPercentage +MetricNamespace : +TimeAggregation : Average +Dimensions : {availabilityResult/name} +``` + +This set of commands creates a more complex metric alert criteria which includes dimension selection + +### Example 4: Create a webtest availability criteria + +```powershell +New-AzMetricAlertRuleV2Criteria -WebTest -WebTestId "/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/012345/providers/Microsoft.Insights/webtests/PingTest-appInsights" -ApplicationInsightsId "/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/012345/providers/Microsoft.Insights/components/appInsights" -FailedLocationCount 3 +``` + +```output +CriterionType : WebtestLocationAvailabilityCriterion +WebTestId : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/012345/providers/Microsoft.Insights/webtests/PingTest-appInsights +ComponentId : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/012345/providers/Microsoft.Insights/components/appInsights +FailedLocationCount : 3 +AdditionalProperties : +``` + +This command creates a webtest availability criteria that can be used in a metric alert rule + +## PARAMETERS + +### -ApplicationInsightsId +The Application Insights resource Id. + +```yaml +Type: System.String +Parameter Sets: WebtestParameterSet +Aliases: componentId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DimensionSelection +List of dimension conditions + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricDimension[] +Parameter Sets: StaticThresholdParameterSet, DynamicThresholdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DynamicThreshold +Switch parameter for using Dynamic Threshold Type + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DynamicThresholdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExaminedAggregatedPointCount +The Total number of examined points + +```yaml +Type: System.Int32 +Parameter Sets: DynamicThresholdParameterSet +Aliases: TotalPeriod, NumberOfExaminedAggregatedPoints + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailedLocationCount +The minimum number of failed locations to raise an alert. + +```yaml +Type: System.Int32 +Parameter Sets: WebtestParameterSet +Aliases: AlertLocationThreshold + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDataBefore +The IgnoreDataBefore parameter + +```yaml +Type: System.DateTime +Parameter Sets: DynamicThresholdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricName +The metric name for rule + +```yaml +Type: System.String +Parameter Sets: StaticThresholdParameterSet, DynamicThresholdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricNamespace +The Namespace of the metric + +```yaml +Type: System.String +Parameter Sets: StaticThresholdParameterSet, DynamicThresholdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operator +The rule condition operator + +```yaml +Type: System.String +Parameter Sets: StaticThresholdParameterSet, DynamicThresholdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMetricValidation +Allows creating an alert rule on a custom metric that isn't yet emitted, by causing the metric validation to be skipped + +```yaml +Type: System.Boolean +Parameter Sets: StaticThresholdParameterSet, DynamicThresholdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Threshold +The threshold for rule condition + +```yaml +Type: System.Double +Parameter Sets: StaticThresholdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThresholdSensitivity +The sensitivity for rule condition + +```yaml +Type: System.String +Parameter Sets: DynamicThresholdParameterSet +Aliases: Sensitivity + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeAggregation +The aggregation operation used to roll up multiple metric values across the window interval + +```yaml +Type: System.String +Parameter Sets: StaticThresholdParameterSet, DynamicThresholdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ViolationCount +The minimum number of violations required within the selected lookback time window required to raise an alert + +```yaml +Type: System.Int32 +Parameter Sets: DynamicThresholdParameterSet +Aliases: FailingPeriod, NumberOfViolations + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebTest +Switch parameter for using availability criteria Type + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WebtestParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebTestId +The Application Insights web test Id. + +```yaml +Type: System.String +Parameter Sets: WebtestParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricDimension[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.IPSMultiMetricCriteria + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzMetricAlertRuleV2DimensionSelection.md b/azps-10.1.0/Az.Monitor/New-AzMetricAlertRuleV2DimensionSelection.md new file mode 100644 index 0000000000..64724da3f2 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzMetricAlertRuleV2DimensionSelection.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azmetricalertrulev2dimensionselection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzMetricAlertRuleV2DimensionSelection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzMetricAlertRuleV2DimensionSelection.md +--- + +# New-AzMetricAlertRuleV2DimensionSelection + +## SYNOPSIS +Creates a local dimension selection object that can be used to construct a metric alert criteria. + +## SYNTAX + +``` +New-AzMetricAlertRuleV2DimensionSelection -DimensionName <String> -ValuesToInclude <String[]> + [-ValuesToExclude <String[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzMetricAlertRuleV2DimensionSelection** cmdlet creates a local dimension selection object to help with the construction of metric alert criteria using [New-AzMetricAlertRuleV2Criteria](https://learn.microsoft.com/powershell/module/az.monitor/new-azmetricalertrulev2criteria) cmdlet. + +## EXAMPLES + +### Example 1: Create a dimension selection object + +```powershell +New-AzMetricAlertRuleV2DimensionSelection -DimensionName LUN -ValuesToInclude 1,3,4 +``` + +```output +Dimension IncludeValues ExcludeValues +--------- ------------- ------------- +LUN {1, 3, 4} +``` + +This command creates a dimension selection object that specifies that values {1,3,4} need to be selected for Dimension "LUN" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DimensionName +The Dimension name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ValuesToExclude +The ExcludeValues + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ValuesToInclude +The IncludeValues + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricDimension + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzMetricFilter.md b/azps-10.1.0/Az.Monitor/New-AzMetricFilter.md new file mode 100644 index 0000000000..8b625cf51d --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzMetricFilter.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azmetricfilter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzMetricFilter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzMetricFilter.md +--- + +# New-AzMetricFilter + +## SYNOPSIS +Creates a metric dimension filter that can be used to query metrics. + +## SYNTAX + +``` +New-AzMetricFilter [-Dimension] <String> [-Operator] <String> [-Value] <String[]> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzMetricFilter** cmdlet creates a metric dimension filter that can be used to query metrics. + +## EXAMPLES + +### Example 1: Create a metric dimension filter +```powershell +New-AzMetricFilter -Dimension City -Operator eq -Value "Seattle","New York" +``` + +This command creates metric dimension filter of the format "City eq 'Seattle' or City eq 'New York'". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Dimension +The name of the metric dimension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Operator +Specifies the operator used to select the metric dimension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Specifies the array of metric dimension values. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzMetric](./Get-AzMetric.md) +[Get-AzMetricDefinition](./Get-AzMetricDefinition.md) + diff --git a/azps-10.1.0/Az.Monitor/New-AzMonitorWorkspace.md b/azps-10.1.0/Az.Monitor/New-AzMonitorWorkspace.md new file mode 100644 index 0000000000..3f2ef5f97b --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzMonitorWorkspace.md @@ -0,0 +1,215 @@ +--- +external help file: Az.MonitorWorkspace.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azmonitorworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzMonitorWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzMonitorWorkspace.md +--- + +# New-AzMonitorWorkspace + +## SYNOPSIS +Create or update a workspace + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzMonitorWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] -Location <String> + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzMonitorWorkspace -InputObject <IMonitorWorkspaceIdentity> -Location <String> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a workspace + +## EXAMPLES + +### Example 1: Create or update a workspace. +```powershell +New-AzMonitorWorkspace -Name azps-monitor-workspace -ResourceGroupName azps_test_group -Location eastus +``` + +```output +Name Location ProvisioningState PublicNetworkAccess ResourceGroupName +---- -------- ----------------- ------------------- ----------------- +azps-monitor-workspace eastus Succeeded Enabled azps_test_group +``` + +Create or update a workspace. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.IMonitorWorkspaceIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Azure Monitor workspace. +The name is case insensitive + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: AzureMonitorWorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.IMonitorWorkspaceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.Api20230403.IAzureMonitorWorkspaceResource + +## 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 <IMonitorWorkspaceIdentity>`: Identity Parameter + - `[AzureMonitorWorkspaceName <String>]`: The name of the Azure Monitor workspace. The name is case insensitive + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzScheduledQueryRule.md b/azps-10.1.0/Az.Monitor/New-AzScheduledQueryRule.md new file mode 100644 index 0000000000..4b8fc537b2 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzScheduledQueryRule.md @@ -0,0 +1,473 @@ +--- +external help file: Az.ScheduledQueryRule.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azscheduledqueryrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzScheduledQueryRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzScheduledQueryRule.md +--- + +# New-AzScheduledQueryRule + +## SYNOPSIS +Creates or updates a scheduled query rule. + +## SYNTAX + +``` +New-AzScheduledQueryRule -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + -Location <String> [-ActionCustomProperty <Hashtable>] [-ActionGroupResourceId <String[]>] [-AutoMitigate] + [-CheckWorkspaceAlertsStorageConfigured] [-CriterionAllOf <ICondition[]>] [-Description <String>] + [-DisplayName <String>] [-Enabled] [-EvaluationFrequency <TimeSpan>] [-Kind <Kind>] + [-MuteActionsDuration <TimeSpan>] [-OverrideQueryTimeRange <TimeSpan>] [-Scope <String[]>] [-Severity <Int64>] + [-SkipQueryValidation] [-Tag <Hashtable>] [-TargetResourceType <String[]>] [-WindowSize <TimeSpan>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a scheduled query rule. + +## EXAMPLES + +### Example 1: Create scheduled query rule +```powershell +$subscriptionId=(Get-AzContext).Subscription.Id +$dimension = New-AzScheduledQueryRuleDimensionObject -Name Computer -Operator Include -Value * +$condition=New-AzScheduledQueryRuleConditionObject -Dimension $dimension -Query "Perf | where ObjectName == `"Processor`" and CounterName == `"% Processor Time`" | summarize AggregatedValue = avg(CounterValue) by bin(TimeGenerated, 5m), Computer" -TimeAggregation "Average" -MetricMeasureColumn "AggregatedValue" -Operator "GreaterThan" -Threshold "70" -FailingPeriodNumberOfEvaluationPeriod 1 -FailingPeriodMinFailingPeriodsToAlert 1 +New-AzScheduledQueryRule -Name test-rule -ResourceGroupName test-group -Location eastus -DisplayName test-rule -Scope "/subscriptions/$subscriptionId/resourceGroups/test-group/providers/Microsoft.Compute/virtualMachines/test-vm" -Severity 4 -WindowSize ([System.TimeSpan]::New(0,10,0)) -EvaluationFrequency ([System.TimeSpan]::New(0,5,0)) -CriterionAllOf $condition +``` + +Create scheduled query rule + +## PARAMETERS + +### -ActionCustomProperty +The properties of an alert payload. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActionGroupResourceId +Action Group resource Ids to invoke when the alert fires. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoMitigate +The flag that indicates whether the alert should be automatically resolved or not. +The default is true. +Relevant only for rules of the kind LogAlert. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CheckWorkspaceAlertsStorageConfigured +The flag which indicates whether this scheduled query rule should be stored in the customer's storage. +The default is false. +Relevant only for rules of the kind LogAlert. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CriterionAllOf +A list of conditions to evaluate against the specified scopes +To construct, see NOTES section for CRITERIONALLOF properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api20210801.ICondition[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the scheduled query rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name of the alert rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The flag which indicates whether this scheduled query rule is enabled. +Value should be true or false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EvaluationFrequency +How often the scheduled query rule is evaluated represented in ISO 8601 duration format. +Relevant and required only for rules of the kind LogAlert. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Indicates the type of scheduled query rule. +The default is LogAlert. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MuteActionsDuration +Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. +Relevant only for rules of the kind LogAlert. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverrideQueryTimeRange +If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). +Relevant only for rules of the kind LogAlert. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The list of resource id's that this scheduled query rule is scoped to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity +Severity of the alert. +Should be an integer between [0-4]. +Value of 0 is severest. +Relevant and required only for rules of the kind LogAlert. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipQueryValidation +The flag which indicates whether the provided query should be validated or not. +The default is false. +Relevant only for rules of the kind LogAlert. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceType +List of resource type of the target resource(s) on which the alert is created/updated. +For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. +Relevant only for rules of the kind LogAlert + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowSize +The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). +Relevant and required only for rules of the kind LogAlert. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api20210801.IScheduledQueryRuleResource + +## 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. + + +`CRITERIONALLOF <ICondition[]>`: A list of conditions to evaluate against the specified scopes + - `[Dimension <IDimension[]>]`: List of Dimensions conditions + - `Name <String>`: Name of the dimension + - `Operator <DimensionOperator>`: Operator for dimension values + - `Value <String[]>`: List of dimension values + - `[FailingPeriodMinFailingPeriodsToAlert <Int64?>]`: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 + - `[FailingPeriodNumberOfEvaluationPeriod <Int64?>]`: The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1 + - `[MetricMeasureColumn <String>]`: The column containing the metric measure number. Relevant only for rules of the kind LogAlert. + - `[MetricName <String>]`: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric. + - `[Operator <ConditionOperator?>]`: The criteria operator. Relevant and required only for rules of the kind LogAlert. + - `[Query <String>]`: Log query alert + - `[ResourceIdColumn <String>]`: The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert. + - `[Threshold <Double?>]`: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert. + - `[TimeAggregation <TimeAggregation?>]`: Aggregation type. Relevant and required only for rules of the kind LogAlert. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzScheduledQueryRuleConditionObject.md b/azps-10.1.0/Az.Monitor/New-AzScheduledQueryRuleConditionObject.md new file mode 100644 index 0000000000..9289336ff3 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzScheduledQueryRuleConditionObject.md @@ -0,0 +1,224 @@ +--- +external help file: Az.ScheduledQueryRule.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzScheduledQueryRuleConditionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzScheduledQueryRuleConditionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzScheduledQueryRuleConditionObject.md +--- + +# New-AzScheduledQueryRuleConditionObject + +## SYNOPSIS +Create an in-memory object for Condition. + +## SYNTAX + +``` +New-AzScheduledQueryRuleConditionObject [-Dimension <IDimension[]>] + [-FailingPeriodMinFailingPeriodsToAlert <Int64>] [-FailingPeriodNumberOfEvaluationPeriod <Int64>] + [-MetricMeasureColumn <String>] [-MetricName <String>] [-Operator <ConditionOperator>] [-Query <String>] + [-ResourceIdColumn <String>] [-Threshold <Double>] [-TimeAggregation <TimeAggregation>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for Condition. + +## EXAMPLES + +### Example 1: Create condition object +```powershell +$dimension = New-AzScheduledQueryRuleDimensionObject -Name Computer -Operator Include -Value * +New-AzScheduledQueryRuleConditionObject -Dimension $dimension -Query "Perf | where ObjectName == `"Processor`" and CounterName == `"% Processor Time`" | summarize AggregatedValue = avg(CounterValue) by bin(TimeGenerated, 5m), Computer" -TimeAggregation "Average" -MetricMeasureColumn "AggregatedValue" -Operator "GreaterThan" -Threshold "70" -FailingPeriodNumberOfEvaluationPeriod 1 -FailingPeriodMinFailingPeriodsToAlert 1 +``` + +Create condition object + +## PARAMETERS + +### -Dimension +List of Dimensions conditions. +To construct, see NOTES section for DIMENSION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api20210801.IDimension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailingPeriodMinFailingPeriodsToAlert +The number of violations to trigger an alert. +Should be smaller or equal to numberOfEvaluationPeriods. +Default value is 1. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailingPeriodNumberOfEvaluationPeriod +The number of aggregated lookback points. +The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. +Default value is 1. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricMeasureColumn +The column containing the metric measure number. +Relevant only for rules of the kind LogAlert. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricName +The name of the metric to be sent. +Relevant and required only for rules of the kind LogToMetric. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operator +The criteria operator. +Relevant and required only for rules of the kind LogAlert. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Support.ConditionOperator +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Log query alert. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceIdColumn +The column containing the resource id. +The content of the column must be a uri formatted as resource id. +Relevant only for rules of the kind LogAlert. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Threshold +the criteria threshold value that activates the alert. +Relevant and required only for rules of the kind LogAlert. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeAggregation +Aggregation type. +Relevant and required only for rules of the kind LogAlert. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Support.TimeAggregation +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api20210801.Condition + +## 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. + + +`DIMENSION <IDimension[]>`: List of Dimensions conditions. + - `Name <String>`: Name of the dimension + - `Operator <DimensionOperator>`: Operator for dimension values + - `Value <String[]>`: List of dimension values + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzScheduledQueryRuleDimensionObject.md b/azps-10.1.0/Az.Monitor/New-AzScheduledQueryRuleDimensionObject.md new file mode 100644 index 0000000000..e2a858fcc0 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzScheduledQueryRuleDimensionObject.md @@ -0,0 +1,94 @@ +--- +external help file: Az.ScheduledQueryRule.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzScheduledQueryRuleDimensionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzScheduledQueryRuleDimensionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzScheduledQueryRuleDimensionObject.md +--- + +# New-AzScheduledQueryRuleDimensionObject + +## SYNOPSIS +Create an in-memory object for Dimension. + +## SYNTAX + +``` +New-AzScheduledQueryRuleDimensionObject -Name <String> -Operator <DimensionOperator> -Value <String[]> + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for Dimension. + +## EXAMPLES + +### Example 1: Create dimension object +```powershell +New-AzScheduledQueryRuleDimensionObject -Name Computer -Operator Include -Value * +``` + +Create dimension object + +## PARAMETERS + +### -Name +Name of the dimension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operator +Operator for dimension values. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Support.DimensionOperator +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +List of dimension values. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api20210801.Dimension + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/New-AzSubscriptionDiagnosticSetting.md b/azps-10.1.0/Az.Monitor/New-AzSubscriptionDiagnosticSetting.md new file mode 100644 index 0000000000..90e932cae7 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/New-AzSubscriptionDiagnosticSetting.md @@ -0,0 +1,250 @@ +--- +external help file: Az.DiagnosticSetting.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/new-azsubscriptiondiagnosticsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzSubscriptionDiagnosticSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzSubscriptionDiagnosticSetting.md +--- + +# New-AzSubscriptionDiagnosticSetting + +## SYNOPSIS +Creates or updates subscription diagnostic settings for the specified resource. + +## SYNTAX + +``` +New-AzSubscriptionDiagnosticSetting -Name <String> [-SubscriptionId <String>] + [-EventHubAuthorizationRuleId <String>] [-EventHubName <String>] [-Log <ISubscriptionLogSettings[]>] + [-MarketplacePartnerId <String>] [-ServiceBusRuleId <String>] [-StorageAccountId <String>] + [-WorkspaceId <String>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates subscription diagnostic settings for the specified resource. + +## EXAMPLES + +### Example 1: Create diagnostic setting for current subscription +```powershell +$subscriptionId = (Get-AzContext).Subscription.Id +$log = @() +$log += New-AzDiagnosticSettingSubscriptionLogSettingsObject -Category Recommendation -Enabled $true +New-AzSubscriptionDiagnosticSetting -Name test-setting -WorkspaceId /subscriptions/$subscriptionId/resourcegroups/test-rg-name/providers/microsoft.operationalinsights/workspaces/test-workspace -Log $log +``` + +Create diagnostic setting for current subscription + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubAuthorizationRuleId +The resource Id for the event hub authorization rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the event hub. +If none is specified, the default event hub will be selected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Log +The list of logs settings. +To construct, see NOTES section for LOG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.ISubscriptionLogSettings[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplacePartnerId +The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the diagnostic setting. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceBusRuleId +The service bus rule Id of the diagnostic setting. +This is here to maintain backwards compatibility. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountId +The resource ID of the storage account to which you would like to send Diagnostic Logs. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceId +The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. +Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.ISubscriptionDiagnosticSettingsResource + +## 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. + + +`LOG <ISubscriptionLogSettings[]>`: The list of logs settings. + - `Enabled <Boolean>`: a value indicating whether this log is enabled. + - `[Category <String>]`: Name of a Subscription Diagnostic Log category for a resource type this setting is applied to. + - `[CategoryGroup <String>]`: Name of a Subscription Diagnostic Log category group for a resource type this setting is applied to. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Remove-AzActionGroup.md b/azps-10.1.0/Az.Monitor/Remove-AzActionGroup.md new file mode 100644 index 0000000000..14767cad13 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzActionGroup.md @@ -0,0 +1,178 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: 8D8FE2FE-03E7-453E-B968-E28B07E42EF2 +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azactiongroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzActionGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzActionGroup.md +--- + +# Remove-AzActionGroup + +## SYNOPSIS +Removes an action group. + +## SYNTAX + +### ByPropertyName (Default) +``` +Remove-AzActionGroup -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzActionGroup -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzActionGroup -InputObject <PSActionGroupResource> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzActionGroup** cmdlet removes an action group. + +## EXAMPLES + +### Example 1: Remove an action group +```powershell +Remove-AzActionGroup -ResourceGroupName "Default-Web-CentralUS" -Name "myActionGroup" +``` + +```output +RequestId StatusCode +--------- ---------- +2c6c159b-0e73-4a01-a67b-c32c1a0008a3 OK +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The action group resource + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the action group. + +```yaml +Type: System.String +Parameter Sets: ByPropertyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group nam + +```yaml +Type: System.String +Parameter Sets: ByPropertyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource i + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource + +## OUTPUTS + +### Microsoft.Azure.AzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Set-AzActionGroup](./Set-AzActionGroup.md) +[Get-AzActionGroup](./Get-AzActionGroup.md) +[New-AzActionGroupReceiver](./New-AzActionGroupReceiver.md) diff --git a/azps-10.1.0/Az.Monitor/Remove-AzActivityLogAlert.md b/azps-10.1.0/Az.Monitor/Remove-AzActivityLogAlert.md new file mode 100644 index 0000000000..024a4d74d6 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzActivityLogAlert.md @@ -0,0 +1,201 @@ +--- +external help file: Az.ActivityLogAlert.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azactivitylogalert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzActivityLogAlert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzActivityLogAlert.md +--- + +# Remove-AzActivityLogAlert + +## SYNOPSIS +Delete an Activity Log Alert rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzActivityLogAlert -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzActivityLogAlert -InputObject <IActivityLogAlertIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete an Activity Log Alert rule. + +## EXAMPLES + +### Example 1: Remove activity log alert by name +```powershell +Remove-AzActivityLogAlert -ResourceGroupName $ResourceGroupName -Name $AlertName +``` + +Remove activity log alert by name + +### Example 2: Remove activity log alert by pipeline input object +```powershell +$alert = Get-AzActivityLogAlert -ResourceGroupName $ResourceGroupName -Name $AlertName +$alert | Remove-AzActivityLogAlert +``` + +Remove activity log alert by pipeline input object + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.IActivityLogAlertIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Activity Log Alert rule. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ActivityLogAlertName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.IActivityLogAlertIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IActivityLogAlertIdentity>`: Identity Parameter + - `[ActivityLogAlertName <String>]`: The name of the Activity Log Alert rule. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Remove-AzAlertRule.md b/azps-10.1.0/Az.Monitor/Remove-AzAlertRule.md new file mode 100644 index 0000000000..3c6668f008 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzAlertRule.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: C7EC21C7-1C7E-49B2-9B33-486532FCDAEC +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azalertrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzAlertRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzAlertRule.md +--- + +# Remove-AzAlertRule + +## SYNOPSIS +Removes an alert rule. + +## SYNTAX + +``` +Remove-AzAlertRule -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzAlertRule** cmdlet removes an alert rule. +You must specify the name of the alert rule and the resource group to which it is assigned. +This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. + +## EXAMPLES + +### Example 1: Remove an alert rule +```powershell +Remove-AzAlertRule -ResourceGroup "Default-Web-CentralUS" -Name "myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8" +``` + +```output +RequestId StatusCode +--------- ---------- +2c6c159b-0e73-4a01-a67b-c32c1a0008a3 OK +``` + +This command removes the alert rule named myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8 in the resource group Default-Web-CentralUS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the alert rule to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for the alert rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.AzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Add-AzMetricAlertRule](./Add-AzMetricAlertRule.md) + +[Add-AzWebtestAlertRule](./Add-AzWebtestAlertRule.md) + +[Get-AzAlertHistory](./Get-AzAlertHistory.md) + +[Get-AzAlertRule](./Get-AzAlertRule.md) + + diff --git a/azps-10.1.0/Az.Monitor/Remove-AzAutoscaleSetting.md b/azps-10.1.0/Az.Monitor/Remove-AzAutoscaleSetting.md new file mode 100644 index 0000000000..d4e8404ab8 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzAutoscaleSetting.md @@ -0,0 +1,193 @@ +--- +external help file: Az.Autoscale.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azautoscalesetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzAutoscaleSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzAutoscaleSetting.md +--- + +# Remove-AzAutoscaleSetting + +## SYNOPSIS +Deletes and autoscale setting + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutoscaleSetting -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzAutoscaleSetting -InputObject <IAutoscaleIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes and autoscale setting + +## EXAMPLES + +### Example 1: Remove autoscale setting +```powershell +Remove-AzAutoscaleSetting -Name test-autoscalesetting -ResourceGroupName test-group +``` + +Remove autoscale setting + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.IAutoscaleIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The autoscale setting name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AutoscaleSettingName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.IAutoscaleIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IAutoscaleIdentity>`: Identity Parameter + - `[AutoscaleSettingName <String>]`: The autoscale setting name. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Remove-AzDataCollectionRule.md b/azps-10.1.0/Az.Monitor/Remove-AzDataCollectionRule.md new file mode 100644 index 0000000000..621c902d8e --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzDataCollectionRule.md @@ -0,0 +1,214 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azdatacollectionrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzDataCollectionRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzDataCollectionRule.md +--- + +# Remove-AzDataCollectionRule + +## SYNOPSIS +Delete a data collection rule. + +## SYNTAX + +### ByName (Default) +``` +Remove-AzDataCollectionRule -ResourceGroupName <String> -RuleName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzDataCollectionRule -InputObject <PSDataCollectionRuleResource> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzDataCollectionRule -RuleId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataCollectionRule** cmdlet delete a data collection rule. + +Data Collection Rules (DCR) define data coming into Azure Monitor and specify where that data should be sent or stored. Here is the complete [DCR overview article](https://learn.microsoft.com/azure/azure-monitor/essentials/data-collection-rule-overview). + +## EXAMPLES + +### Example 1: Delete data collection rule with name and resource group parameters +```powershell +Remove-AzDataCollectionRule -ResourceGroupName "testgroup" -RuleName "testDcr" +``` + +Delete data collection rule with name and resource group parameters + +### Example 2: Delete data collection rule with name and resource group return bool +```powershell +Remove-AzDataCollectionRule -ResourceGroupName "testgroup" -RuleName "testDcr" -PassThru +``` + +```output +True +``` + +Delete data collection rule with name and resource group return bool + +### Example 3: Delete data collection rule from InputObject +```powershell +Get-AzDataCollectionRule -ResourceGroupName "testdcr" -RuleName "dcrFromPipe95" | Remove-AzDataCollectionRule +``` + +Delete data collection rule from InputObject + +### Example 4: Delete data collection rule from resource id +```powershell +Remove-AzDataCollectionRule -RuleId "/subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/{dcrName}" +``` + +Delete data collection rule from resource id + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The data collection rule resource from the pipe + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleResource +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Return true upon successful removal. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleName +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleResource + +## NOTES + +## RELATED LINKS + +[Set-AzDataCollectionRule](./Set-AzDataCollectionRule.md) +[Get-AzDataCollectionRule](./Get-AzDataCollectionRule.md) +[New-AzDataCollectionRule](./New-AzDataCollectionRule.md) +[Update-AzDataCollectionRule](./Update-AzDataCollectionRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Monitor/Remove-AzDataCollectionRuleAssociation.md b/azps-10.1.0/Az.Monitor/Remove-AzDataCollectionRuleAssociation.md new file mode 100644 index 0000000000..eec3945dd6 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzDataCollectionRuleAssociation.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azdatacollectionruleassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzDataCollectionRuleAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzDataCollectionRuleAssociation.md +--- + +# Remove-AzDataCollectionRuleAssociation + +## SYNOPSIS +Delete a data collection rule association. + +## SYNTAX + +### ByName (Default) +``` +Remove-AzDataCollectionRuleAssociation -TargetResourceId <String> -AssociationName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzDataCollectionRuleAssociation -InputObject <PSDataCollectionRuleAssociationProxyOnlyResource> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzDataCollectionRuleAssociation -AssociationId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataCollectionRuleAssociation** cmdlet delete a data collection rule association (DCRA). + +To apply a DCR to a virtual machine, you create an association for the virtual machine. A virtual machine may have an association to multiple DCRs, and a DCR may have multiple virtual machines associated to it. This allows you to define a set of DCRs, each matching a particular requirement, and apply them to only the virtual machines where they apply. Here is the ["Configure data collection for the Azure Monitor agent"](https://learn.microsoft.com/azure/azure-monitor/platform/data-collection-rule-azure-monitor-agent) using DCRA article. + +## EXAMPLES + +### Example 1: Delete data collection rule association with name and target resource ID (associated virtual machine) parameters +```powershell +Remove-AzDataCollectionRuleAssociation -TargetResourceId $vm.Id -AssociationName $assocName +``` + +Delete data collection rule association with name and target resource ID (associated virtual machine) parameters + +### Example 2: Delete data collection rule with Input Object +```powershell +$dcrAssoc | Remove-AzDataCollectionRule +``` + +Delete data collection rule with Input Object + +### Example 3: Delete data collection rule with the association resource ID property +```powershell +Remove-AzDataCollectionRuleAssociation -AssociationId $dcrAssoc.Id +``` + +Delete data collection rule with the association resource ID property + +## PARAMETERS + +### -AssociationId +The resource identifier. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssociationName +The name of the association resource. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSDataCollectionRuleResource Object + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleAssociationProxyOnlyResource +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Return true upon successful removal. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceId +The associated resource ID. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ResourceUri + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String +### Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleAssociationProxyOnlyResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzDataCollectionRule](./Get-AzDataCollectionRule.md) +[New-AzDataCollectionRule](./New-AzDataCollectionRule.md) diff --git a/azps-10.1.0/Az.Monitor/Remove-AzDiagnosticSetting.md b/azps-10.1.0/Az.Monitor/Remove-AzDiagnosticSetting.md new file mode 100644 index 0000000000..2b9a0c90f5 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzDiagnosticSetting.md @@ -0,0 +1,178 @@ +--- +external help file: Az.DiagnosticSetting.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azdiagnosticsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzDiagnosticSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzDiagnosticSetting.md +--- + +# Remove-AzDiagnosticSetting + +## SYNOPSIS +Deletes existing diagnostic settings for the specified resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDiagnosticSetting -Name <String> -ResourceId <String> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzDiagnosticSetting -InputObject <IDiagnosticSettingIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes existing diagnostic settings for the specified resource. + +## EXAMPLES + +### Example 1: Remove DiagnosticSetting by name +```powershell +$subscriptionId = (Get-AzContext).Subscription.Id +Remove-AzDiagnosticSetting -ResourceId /subscriptions/$subscriptionId/resourceGroups/test-rg-name/providers/Microsoft.AppPlatform/Spring/springcloud-001 -Name test-setting +``` + +Remove DiagnosticSetting by name + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the diagnostic setting. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The identifier of the resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDiagnosticSettingIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[Name <String>]`: The name of the diagnostic setting. + - `[ResourceUri <String>]`: The identifier of the resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Remove-AzInsightsPrivateLinkScope.md b/azps-10.1.0/Az.Monitor/Remove-AzInsightsPrivateLinkScope.md new file mode 100644 index 0000000000..ef1905df5a --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzInsightsPrivateLinkScope.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azinsightsprivatelinkscope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzInsightsPrivateLinkScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzInsightsPrivateLinkScope.md +--- + +# Remove-AzInsightsPrivateLinkScope + +## SYNOPSIS +delete private link scope + +## SYNTAX + +### ByResourceNameParameterSet (Default) +``` +Remove-AzInsightsPrivateLinkScope -ResourceGroupName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzInsightsPrivateLinkScope -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectParameterSet +``` +Remove-AzInsightsPrivateLinkScope -InputObject <PSMonitorPrivateLinkScope> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +delete private link scope + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzInsightsPrivateLinkScope -ResourceGroupName "rg_name" -Name "scope_name" +``` + +delete private link scope with name "scope_name" under resource group "rg_name" + +### Example 2 +```powershell +Remove-AzInsightsPrivateLinkScope -ResourceId "/subscriptions/{subscriptionId}/resourceGroups/rg_name/providers/Microsoft.Insights/privateLinkScopes/scope_name" +``` + +delete private link scope with resource Id + +### Example 3 +```powershell +Get-AzInsightsPrivateLinkScope -ResourceGroupName "rg_name" -Name "scope_name" | Remove-AzInsightsPrivateLinkScope +``` + +delete private link scope with input private link scope object + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSMonitorPrivateLinkScope + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScope +Parameter Sets: ByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Private Link Scope Name + +```yaml +Type: System.String +Parameter Sets: ByResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ByResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScope + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Remove-AzInsightsPrivateLinkScopedResource.md b/azps-10.1.0/Az.Monitor/Remove-AzInsightsPrivateLinkScopedResource.md new file mode 100644 index 0000000000..f528597bc8 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzInsightsPrivateLinkScopedResource.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azinsightsprivatelinkscopedresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzInsightsPrivateLinkScopedResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzInsightsPrivateLinkScopedResource.md +--- + +# Remove-AzInsightsPrivateLinkScopedResource + +## SYNOPSIS +delete for private link scoped resource + +## SYNTAX + +### ByScopeParameterSet (Default) +``` +Remove-AzInsightsPrivateLinkScopedResource -ResourceGroupName <String> -ScopeName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectParameterSet +``` +Remove-AzInsightsPrivateLinkScopedResource -Name <String> -InputObject <PSMonitorPrivateLinkScope> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzInsightsPrivateLinkScopedResource -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +delete for private link scoped resource + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzInsightsPrivateLinkScopedResource -ResourceGroupName "rg_name" -ScopeName "scope_name" -Name "scoped_resource_name" +``` + +delete private link scoped resource + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSMonitorPrivateLinkScope + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScope +Parameter Sets: ByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Scoped resource Name + +```yaml +Type: System.String +Parameter Sets: ByScopeParameterSet, ByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ByScopeParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeName +Private Link Scope Name + +```yaml +Type: System.String +Parameter Sets: ByScopeParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScope + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Remove-AzLogProfile.md b/azps-10.1.0/Az.Monitor/Remove-AzLogProfile.md new file mode 100644 index 0000000000..f4ba7502fc --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzLogProfile.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: DDA137FD-4EB3-4FB7-A202-978922038AFC +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azlogprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzLogProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzLogProfile.md +--- + +# Remove-AzLogProfile + +## SYNOPSIS +Removes a log profile. + +## SYNTAX + +``` +Remove-AzLogProfile -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzLogProfile** cmdlet removes a log profile. +This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. + +## EXAMPLES + +### Example 1 + +Removes a log profile. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Remove-AzLogProfile -Name 'LogAlertRule1' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the log profile to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.AzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Add-AzLogProfile](./Add-AzLogProfile.md) + +[Get-AzLogProfile](./Get-AzLogProfile.md) + + diff --git a/azps-10.1.0/Az.Monitor/Remove-AzMetricAlertRuleV2.md b/azps-10.1.0/Az.Monitor/Remove-AzMetricAlertRuleV2.md new file mode 100644 index 0000000000..a0ad136b4f --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzMetricAlertRuleV2.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azmetricalertrulev2 +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzMetricAlertRuleV2.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzMetricAlertRuleV2.md +--- + +# Remove-AzMetricAlertRuleV2 + +## SYNOPSIS +Removes a V2 (non-classic) metric alert rule. + +## SYNTAX + +### ByMetricRuleResourceName (Default) +``` +Remove-AzMetricAlertRuleV2 -Name <String> -ResourceGroupName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByMetricRuleResourceId +``` +Remove-AzMetricAlertRuleV2 -ResourceId <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRuleObject +``` +Remove-AzMetricAlertRuleV2 -InputObject <PSMetricAlertRuleV2> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzMetricAlertRuleV2** cmdlet removes an alert rule. This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. + +## EXAMPLES + +### Example 1: Remove an alert rule by name + +```powershell +Remove-AzMetricAlertRuleV2 -ResourceGroupName xxxxRG -Name PsSdk -PassThru +``` + +```output +True +``` + +This command removes the alert rule named PsSdk + +### Example 2: Remove an alert rule by ID + +```powershell +Remove-AzMetricAlertRuleV2 -ResourceId /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricAlertRG/providers/Microsoft.Insights/metricAlerts/myAlertRule +``` + +This command removes the alert rule with resource ID `/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricAlertRG/providers/Microsoft.Insights/metricAlerts/myAlertRule` + +### Example 3: Get an alert and remove it + +```powershell +Get-AzMetricAlertRuleV2 -ResourceGroupName alertstest -Name sampleAlertRule | Remove-AzMetricAlertRuleV2 +``` + +This command gets an alert and removes it. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Metric rule object + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricAlertRuleV2 +Parameter Sets: ByRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of metric alert rule + +```yaml +Type: System.String +Parameter Sets: ByMetricRuleResourceName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return true upon successful deletion. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The ResourceGroupName + +```yaml +Type: System.String +Parameter Sets: ByMetricRuleResourceName +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The RuleResourceId + +```yaml +Type: System.String +Parameter Sets: ByMetricRuleResourceId +Aliases: RuleResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricAlertRuleV2 + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Remove-AzMonitorWorkspace.md b/azps-10.1.0/Az.Monitor/Remove-AzMonitorWorkspace.md new file mode 100644 index 0000000000..6c14da30d8 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzMonitorWorkspace.md @@ -0,0 +1,231 @@ +--- +external help file: Az.MonitorWorkspace.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azmonitorworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzMonitorWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzMonitorWorkspace.md +--- + +# Remove-AzMonitorWorkspace + +## SYNOPSIS +Delete a workspace + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMonitorWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMonitorWorkspace -InputObject <IMonitorWorkspaceIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a workspace + +## EXAMPLES + +### Example 1: Delete a workspace. +```powershell +Remove-AzMonitorWorkspace -Name azps-monitor-workspace -ResourceGroupName azps_test_group +``` + +Delete a workspace. + +### Example 2: Delete a workspace. +```powershell +Get-AzMonitorWorkspace -Name azps-monitor-workspace -ResourceGroupName azps_test_group | Remove-AzMonitorWorkspace +``` + +Delete a workspace. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.IMonitorWorkspaceIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Azure Monitor workspace. +The name is case insensitive + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AzureMonitorWorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.IMonitorWorkspaceIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMonitorWorkspaceIdentity>`: Identity Parameter + - `[AzureMonitorWorkspaceName <String>]`: The name of the Azure Monitor workspace. The name is case insensitive + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Remove-AzScheduledQueryRule.md b/azps-10.1.0/Az.Monitor/Remove-AzScheduledQueryRule.md new file mode 100644 index 0000000000..f3ef43b742 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzScheduledQueryRule.md @@ -0,0 +1,193 @@ +--- +external help file: Az.ScheduledQueryRule.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azscheduledqueryrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzScheduledQueryRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzScheduledQueryRule.md +--- + +# Remove-AzScheduledQueryRule + +## SYNOPSIS +Deletes a scheduled query rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzScheduledQueryRule -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzScheduledQueryRule -InputObject <IScheduledQueryRuleIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a scheduled query rule. + +## EXAMPLES + +### Example 1: Remove scheduled query rule +```powershell +Remove-AzScheduledQueryRule -ResourceGroupName "test-group" -Name "test-rule" +``` + +Remove scheduled query rule + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.IScheduledQueryRuleIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the rule. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.IScheduledQueryRuleIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IScheduledQueryRuleIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleName <String>]`: The name of the rule. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Remove-AzSubscriptionDiagnosticSetting.md b/azps-10.1.0/Az.Monitor/Remove-AzSubscriptionDiagnosticSetting.md new file mode 100644 index 0000000000..f0af55da81 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Remove-AzSubscriptionDiagnosticSetting.md @@ -0,0 +1,177 @@ +--- +external help file: Az.DiagnosticSetting.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/remove-azsubscriptiondiagnosticsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzSubscriptionDiagnosticSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Remove-AzSubscriptionDiagnosticSetting.md +--- + +# Remove-AzSubscriptionDiagnosticSetting + +## SYNOPSIS +Deletes existing subscription diagnostic settings for the specified resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSubscriptionDiagnosticSetting -Name <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSubscriptionDiagnosticSetting -InputObject <IDiagnosticSettingIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes existing subscription diagnostic settings for the specified resource. + +## EXAMPLES + +### Example 1: Remove subscription diagnostic setting by name +```powershell +Get-AzSubscriptionDiagnosticSetting -Name test-setting +``` + +Remove diagnostic setting by name for current subscription + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the diagnostic setting. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IDiagnosticSettingIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[Name <String>]`: The name of the diagnostic setting. + - `[ResourceUri <String>]`: The identifier of the resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Set-AzActionGroup.md b/azps-10.1.0/Az.Monitor/Set-AzActionGroup.md new file mode 100644 index 0000000000..2e072317c3 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Set-AzActionGroup.md @@ -0,0 +1,313 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +ms.assetid: 4A6816DB-0E46-44F0-8AE9-180B1C4AAB22 +online version: https://learn.microsoft.com/powershell/module/az.monitor/set-azactiongroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Set-AzActionGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Set-AzActionGroup.md +--- + +# Set-AzActionGroup + +## SYNOPSIS +Creates a new or updates an existing action group. + +## SYNTAX + +### ByPropertyName (Default) +``` +Set-AzActionGroup -ResourceGroupName <String> -Name <String> -ShortName <String> + -Receiver <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase]> + [-DisableGroup] [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-Location <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzActionGroup -ShortName <String> + -Receiver <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase]> + [-DisableGroup] [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-Location <String>] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObject +``` +Set-AzActionGroup [-ShortName <String>] [-DisableGroup] + [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] [-Location <String>] + -InputObject <PSActionGroupResource> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzActionGroup** cmdlet creates a new or updates an existing action group + +## EXAMPLES + +### Example 1: Create an Action Group +```powershell +$email1 = New-AzActionGroupReceiver -Name 'user1' -EmailReceiver -EmailAddress 'user1@example.com' +$sms1 = New-AzActionGroupReceiver -Name 'user2' -SmsReceiver -CountryCode '1' -PhoneNumber '5555555555' +Set-AzActionGroup -Name $actionGroupName -ResourceGroupName $resourceGroupName -ShortName $shortName -Receiver $email1,$sms1 +``` + +The first two commands create two receivers. +The final command creates an Action Group including the two receivers. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableGroup +Disables the action group. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByPropertyName, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The action group resource + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the action group resource + +```yaml +Type: System.String +Parameter Sets: ByPropertyName, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the action group. + +```yaml +Type: System.String +Parameter Sets: ByPropertyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Receiver +The list of receivers of the action group. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase] +Parameter Sets: ByPropertyName, ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group nam + +```yaml +Type: System.String +Parameter Sets: ByPropertyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource i + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShortName +The short name of the action group. + +```yaml +Type: System.String +Parameter Sets: ByPropertyName, ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The tags of the action group resource + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: ByPropertyName, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase, Microsoft.Azure.PowerShell.Cmdlets.Monitor, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +### System.Management.Automation.SwitchParameter + +### System.Collections.Generic.IDictionary`2[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource + +## NOTES + +## RELATED LINKS + +[Get-AzActionGroup](./Get-AzActionGroup.md) +[Remove-AzActionGroup](./Remove-AzActionGroup.md) +[New-AzActionGroupReceiver](./New-AzActionGroupReceiver.md) diff --git a/azps-10.1.0/Az.Monitor/Set-AzDataCollectionRule.md b/azps-10.1.0/Az.Monitor/Set-AzDataCollectionRule.md new file mode 100644 index 0000000000..c6811621c8 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Set-AzDataCollectionRule.md @@ -0,0 +1,376 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/set-azdatacollectionrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Set-AzDataCollectionRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Set-AzDataCollectionRule.md +--- + +# Set-AzDataCollectionRule + +## SYNOPSIS +Updates (full replacement) a data collection rule. + +## SYNTAX + +### ByName (Default) +``` +Set-AzDataCollectionRule -Location <String> -ResourceGroupName <String> -RuleName <String> -RuleFile <String> + [-Description <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzDataCollectionRule -Location <String> -RuleId <String> -RuleFile <String> [-Description <String>] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Set-AzDataCollectionRule -InputObject <PSDataCollectionRuleResource> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataCollectionRule** cmdlet replaces an existing data collection rule. + +Data Collection Rules (DCR) define data coming into Azure Monitor and specify where that data should be sent or stored. Here is the complete [DCR overview article](https://learn.microsoft.com/azure/azure-monitor/essentials/data-collection-rule-overview). + +To use the -RuleFile parameter, construct a json file containing three properties: dataSources, destinations, dataFlows (see Example #1). + +You may find here the [schema detail](https://learn.microsoft.com/rest/api/monitor/datacollectionrules/create). + +The output of a DCR serialized with the cmdlet ConvertTo-Json is also supported (Example #2). + +## EXAMPLES + +### Example 1: Update data collection rule, JSON from Rest API +```powershell +Set-AzDataCollectionRule -Location 'East US 2 EUAP' ` + -ResourceGroupName 'testdcr' ` + -RuleName 'newDcr' ` + -RuleFile 'C:\samples\dcr1.json' ` + -Description 'Updated Description' +``` + +```output +Description : Updated Description +DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources +Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations +DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow} +ProvisioningState : Succeeded +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/newDcr +Name : newDcr +Type : Microsoft.Insights/dataCollectionRules +Location : East US 2 EUAP +Tags : {[tag2, value2], [tag1, value1]} + +# Note: Content of C:\samples\dcr1.json +{ + "properties": { + "dataSources": { + "performanceCounters": [ + { + "streams": [ + "Microsoft-InsightsMetrics" + ], + "scheduledTransferPeriod": "PT1M", + "samplingFrequencyInSeconds": 10, + "counterSpecifiers": [ + "\\Processor Information(_Total)\\% Processor Time" + ], + "name": "perfCounter01" + } + ] + }, + "destinations": { + "azureMonitorMetrics": { + "name": "azureMonitorMetrics-default" + } + }, + "dataFlows": [ + { + "streams": [ + "Microsoft-InsightsMetrics" + ], + "destinations": [ + "azureMonitorMetrics-default" + ] + } + ] + } +} +``` + +This command replaces an existing data collection rules for the current subscription. + +### Example 2: Update data collection rule, JSON from PSDataCollectionRuleResource +```powershell +Set-AzDataCollectionRule -Location 'East US 2 EUAP' ` + -RuleId '/subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/newDcr' ` + -RuleFile 'C:\samples\dcr2.json' ` + -Description 'Updated Description' +``` + +```output +Description : Updated Description +DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources +Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations +DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow} +ProvisioningState : Succeeded +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/newDcr +Name : newDcr +Type : Microsoft.Insights/dataCollectionRules +Location : East US 2 EUAP +Tags : {[tag2, value2], [tag1, value1]} + +# Note: Content of C:\samples\dcr2.json +{ + "DataSources": { + "PerformanceCounters": [ + { + "Streams": [ + "Microsoft-InsightsMetrics" + ], + "ScheduledTransferPeriod": "PT1M", + "SamplingFrequencyInSeconds": 10, + "CounterSpecifiers": [ + "\\Processor Information(_Total)\\% Processor Time" + ], + "Name": "perfCounter01" + } + ] + }, + "Destinations": { + "AzureMonitorMetrics": { + "Name": "azureMonitorMetrics-default" + } + }, + "DataFlows": [ + { + "Streams": [ + "Microsoft-InsightsMetrics" + ], + "Destinations": [ + "azureMonitorMetrics-default" + ] + } + ] +} +``` + +This command replaces an existing data collection rules for the current subscription. + +### Example 3: Update data collection rule from object +```powershell +$dcr = Get-AzDataCollectionRule -ResourceGroupName "testdcr" -Name "newDcr" +$dcr.Description = 'This is a test' +$dcr | Set-AzDataCollectionRule +``` + +```output +Description : This is a test +DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources +Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations +DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow} +ProvisioningState : {provState} +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/newDcr +Name : newDcr +Type : Microsoft.Insights/dataCollectionRules +Location : East US 2 EUAP +Tags : {[tag2, value2], [tag1, value1]} +``` + +Update data collection rule from object + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The resource description + +```yaml +Type: System.String +Parameter Sets: ByName, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSDataCollectionRuleResource Object + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleResource +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The resource location + +```yaml +Type: System.String +Parameter Sets: ByName, ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleFile +The JSON file path + +```yaml +Type: System.String +Parameter Sets: ByName, ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +The resource ID + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleName +The resource name + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByName, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleResource + +## NOTES + +## RELATED LINKS + +[New-AzDataCollectionRule](./New-AzDataCollectionRule.md) +[Remove-AzDataCollectionRule](./Remove-AzDataCollectionRule.md) +[Get-AzDataCollectionRule](./Get-AzDataCollectionRule.md) +[Update-AzDataCollectionRule](./Update-AzDataCollectionRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Monitor/Test-AzActionGroup.md b/azps-10.1.0/Az.Monitor/Test-AzActionGroup.md new file mode 100644 index 0000000000..a54987b8eb --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Test-AzActionGroup.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/test-azactiongroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Test-AzActionGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Test-AzActionGroup.md +--- + +# Test-AzActionGroup + +## SYNOPSIS +Sends test notifications + +## SYNTAX + +``` +Test-AzActionGroup -AlertType <String> -ResourceGroupName <String> -ActionGroupName <String> + -Receiver <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This Test-AzActionGroup cmdlet send test notifications + +## EXAMPLES + +### Send Service Health alert test notifications to email +```powershell +$email = New-AzActionGroupReceiver -Name 'user1' -EmailReceiver -EmailAddress 'test@test.example.com' +Test-AzActionGroup -AlertType servicehealth -Receiver $email -ResourceGroupName "test-RG" -ActionGroupName "test-AG" +``` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +## PARAMETERS + +### -ActionGroupName +The required action group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertType +The required alert type name. The supported values are: +servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, activitylog, resourcehealth, budget, actualcostbudget, forecastedbudget + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Receiver +The required list of receivers + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The required resource group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSTestNotificationDetailsResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Update-AzActivityLogAlert.md b/azps-10.1.0/Az.Monitor/Update-AzActivityLogAlert.md new file mode 100644 index 0000000000..da7f2f15ee --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Update-AzActivityLogAlert.md @@ -0,0 +1,212 @@ +--- +external help file: Az.ActivityLogAlert.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/update-azactivitylogalert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Update-AzActivityLogAlert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Update-AzActivityLogAlert.md +--- + +# Update-AzActivityLogAlert + +## SYNOPSIS +Updates 'tags' and 'enabled' fields in an existing Alert rule. +This method is used to update the Alert rule tags, and to enable or disable the Alert rule. +To update other fields use CreateOrUpdate operation. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzActivityLogAlert -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Enabled <Boolean>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzActivityLogAlert -InputObject <IActivityLogAlertIdentity> [-Enabled <Boolean>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates 'tags' and 'enabled' fields in an existing Alert rule. +This method is used to update the Alert rule tags, and to enable or disable the Alert rule. +To update other fields use CreateOrUpdate operation. + +## EXAMPLES + +### Example 1: Update activity log alert +```powershell +Update-AzActivityLogAlert -ResourceGroupName $ResourceGroupName -Name $AlertName -Tag @{"key"="val"} -Enabled $false +``` + +Disable activity log alert, add tag "key":"val" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Indicates whether this Activity Log Alert rule is enabled. +If an Activity Log Alert rule is not enabled, then none of its actions will be activated. + +```yaml +Type: System.Boolean +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.Monitor.ActivityLogAlert.Models.IActivityLogAlertIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Activity Log Alert rule. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ActivityLogAlertName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.IActivityLogAlertIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ActivityLogAlert.Models.Api20201001.IActivityLogAlertResource + +## 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 <IActivityLogAlertIdentity>`: Identity Parameter + - `[ActivityLogAlertName <String>]`: The name of the Activity Log Alert rule. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Update-AzAutoscaleSetting.md b/azps-10.1.0/Az.Monitor/Update-AzAutoscaleSetting.md new file mode 100644 index 0000000000..b97aa71825 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Update-AzAutoscaleSetting.md @@ -0,0 +1,357 @@ +--- +external help file: Az.Autoscale.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/update-azAutoscaleSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Update-AzAutoscaleSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Update-AzAutoscaleSetting.md +--- + +# Update-AzAutoscaleSetting + +## SYNOPSIS +Updates an existing AutoscaleSettingsResource. +To update other fields use the CreateOrUpdate method. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutoscaleSetting -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Enabled <Boolean>] [-Notification <IAutoscaleNotification[]>] + [-PredictiveAutoscalePolicyScaleLookAheadTime <TimeSpan>] + [-PredictiveAutoscalePolicyScaleMode <PredictiveAutoscalePolicyScaleMode>] [-Profile <IAutoscaleProfile[]>] + [-Tag <Hashtable>] [-TargetResourceLocation <String>] [-TargetResourceUri <String>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutoscaleSetting -InputObject <IAutoscaleIdentity> [-Enabled <Boolean>] + [-Notification <IAutoscaleNotification[]>] [-PredictiveAutoscalePolicyScaleLookAheadTime <TimeSpan>] + [-PredictiveAutoscalePolicyScaleMode <PredictiveAutoscalePolicyScaleMode>] [-Profile <IAutoscaleProfile[]>] + [-Tag <Hashtable>] [-TargetResourceLocation <String>] [-TargetResourceUri <String>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing AutoscaleSettingsResource. +To update other fields use the CreateOrUpdate method. + +## EXAMPLES + +### Example 1: Update Tag and Enable existing autoscale setting +```powershell +Update-AzAutoscaleSetting -ResourceGroupName test-group -Name test-autoscalesetting -Tag @{'key'='val'} -Enabled $true +``` + +Update Tag and Enable existing autoscale setting + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +the enabled flag. +Specifies whether automatic scaling is enabled for the resource. +The default value is 'false'. + +```yaml +Type: System.Boolean +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.Monitor.Autoscale.Models.IAutoscaleIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The autoscale setting name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: AutoscaleSettingName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notification +the collection of notifications. +To construct, see NOTES section for NOTIFICATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IAutoscaleNotification[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PredictiveAutoscalePolicyScaleLookAheadTime +the amount of time to specify by which instances are launched in advance. +It must be between 1 minute and 60 minutes in ISO 8601 format. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PredictiveAutoscalePolicyScaleMode +the predictive autoscale mode + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Support.PredictiveAutoscalePolicyScaleMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Profile +the collection of automatic scaling profiles that specify different scaling parameters for different time periods. +A maximum of 20 profiles can be specified. +To construct, see NOTES section for PROFILE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IAutoscaleProfile[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceLocation +the location of the resource that the autoscale setting should be added to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceUri +the resource identifier of the resource that the autoscale setting should be added to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.IAutoscaleIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.Autoscale.Models.Api20221001.IAutoscaleSettingResource + +## 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 <IAutoscaleIdentity>`: Identity Parameter + - `[AutoscaleSettingName <String>]`: The autoscale setting name. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`NOTIFICATION <IAutoscaleNotification[]>`: the collection of notifications. + - `[EmailCustomEmail <String[]>]`: the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored. + - `[EmailSendToSubscriptionAdministrator <Boolean?>]`: a value indicating whether to send email to subscription administrator. + - `[EmailSendToSubscriptionCoAdministrator <Boolean?>]`: a value indicating whether to send email to subscription co-administrators. + - `[Webhook <IWebhookNotification[]>]`: the collection of webhook notifications. + - `[Property <IWebhookNotificationProperties>]`: a property bag of settings. This value can be empty. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[ServiceUri <String>]`: the service address to receive the notification. + +`PROFILE <IAutoscaleProfile[]>`: the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified. + - `CapacityDefault <String>`: the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default. + - `CapacityMaximum <String>`: the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription. + - `CapacityMinimum <String>`: the minimum number of instances for the resource. + - `Name <String>`: the name of the profile. + - `Rule <IScaleRule[]>`: the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified. + - `MetricTriggerMetricName <String>`: the name of the metric that defines what the rule monitors. + - `MetricTriggerMetricResourceUri <String>`: the resource identifier of the resource the rule monitors. + - `MetricTriggerOperator <ComparisonOperationType>`: the operator that is used to compare the metric data and the threshold. + - `MetricTriggerStatistic <MetricStatisticType>`: the metric statistic type. How the metrics from multiple instances are combined. + - `MetricTriggerThreshold <Double>`: the threshold of the metric that triggers the scale action. + - `MetricTriggerTimeAggregation <TimeAggregationType>`: time aggregation type. How the data that is collected should be combined over time. The default value is Average. + - `MetricTriggerTimeGrain <TimeSpan>`: the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute. + - `MetricTriggerTimeWindow <TimeSpan>`: the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes. + - `ScaleActionCooldown <TimeSpan>`: the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format. + - `ScaleActionDirection <ScaleDirection>`: the scale direction. Whether the scaling action increases or decreases the number of instances. + - `ScaleActionType <ScaleType>`: the type of action that should occur when the scale rule fires. + - `[MetricTriggerDimension <IScaleRuleMetricDimension[]>]`: List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}]. + - `DimensionName <String>`: Name of the dimension. + - `Operator <ScaleRuleMetricDimensionOperationType>`: the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values + - `Value <String[]>`: list of dimension values. For example: ["App1","App2"]. + - `[MetricTriggerDividePerInstance <Boolean?>]`: a value indicating whether metric should divide per instance. + - `[MetricTriggerMetricNamespace <String>]`: the namespace of the metric that defines what the rule monitors. + - `[MetricTriggerMetricResourceLocation <String>]`: the location of the resource the rule monitors. + - `[ScaleActionValue <String>]`: the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. + - `[FixedDateEnd <DateTime?>]`: the end time for the profile in ISO 8601 format. + - `[FixedDateStart <DateTime?>]`: the start time for the profile in ISO 8601 format. + - `[FixedDateTimeZone <String>]`: the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time + - `[RecurrenceFrequency <RecurrenceFrequency?>]`: the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set **schedule** to every day of the week. The frequency property specifies that the schedule is repeated weekly. + - `[ScheduleDay <String[]>]`: the collection of days that the profile takes effect on. Possible values are Sunday through Saturday. + - `[ScheduleHour <Int32[]>]`: A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported). + - `[ScheduleMinute <Int32[]>]`: A collection of minutes at which the profile takes effect at. + - `[ScheduleTimeZone <String>]`: the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Update-AzDataCollectionRule.md b/azps-10.1.0/Az.Monitor/Update-AzDataCollectionRule.md new file mode 100644 index 0000000000..060fe586c6 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Update-AzDataCollectionRule.md @@ -0,0 +1,249 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/update-azdatacollectionrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Update-AzDataCollectionRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Update-AzDataCollectionRule.md +--- + +# Update-AzDataCollectionRule + +## SYNOPSIS +Updates a data collection rule tags property. + +## SYNTAX + +### ByName (Default) +``` +Update-AzDataCollectionRule -ResourceGroupName <String> -RuleName <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Update-AzDataCollectionRule -RuleId <String> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Update-AzDataCollectionRule -InputObject <PSDataCollectionRuleResource> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzDataCollectionRule** cmdlet updates a data collection rule Tags property. + +Data Collection Rules (DCR) define data coming into Azure Monitor and specify where that data should be sent or stored. Here is the complete [DCR overview article](https://learn.microsoft.com/azure/azure-monitor/essentials/data-collection-rule-overview). + +## EXAMPLES + +### Example 1: Update data collection rule tags +```powershell +Update-AzDataCollectionRule -RuleName 'newDcr' ` + -ResourceGroupName 'testdcr' ` + -Tag @{"tag1"="value1"; "tag2"="value2"} +``` + +```output +Description : +DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources +Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations +DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow} +ProvisioningState : Succeeded +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/newDcr +Name : newDcr +Type : Microsoft.Insights/dataCollectionRules +Location : East US 2 EUAP +Tags : {[tag2, value2], [tag1, value1]} +``` + +This command updates the tags property for the given data collection rule. + +### Example 2: Update data collection rule tags +```powershell +Update-AzDataCollectionRule -RuleId '/subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/newDcr' ` + -Tag @{"tag1"="value1"; "tag2"="value2"} +``` + +```output +Description : +DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources +Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations +DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow} +ProvisioningState : Succeeded +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/newDcr +Name : newDcr +Type : Microsoft.Insights/dataCollectionRules +Location : East US 2 EUAP +Tags : {[tag2, value2], [tag1, value1]} +``` + +This command updates the tags property for the given data collection rule. + +### Example 3: Update data collection rule tags +```powershell +$dcr = Get-AzDataCollectionRule -ResourceGroupName "testdcr" -Name "newDcr" +$dcr | Update-AzDataCollectionRule -Tag @{"tag1"="value1"; "tag2"="value2"} +``` + +```output +Description : +DataSources : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDataSources +Destinations : Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleDestinations +DataFlows : {Microsoft.Azure.Commands.Insights.OutputClasses.PSDataFlow} +ProvisioningState : {provState} +Etag : "{etag}" +Id : /subscriptions/{subId}/resourceGroups/testdcr/providers/Microsoft.Insights/dataCollectionRules/newDcr +Name : newDcr +Type : Microsoft.Insights/dataCollectionRules +Location : East US 2 EUAP +Tags : {[tag2, value2], [tag1, value1]} +``` + +This command updates the tags property for the given data collection rule. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSDataCollectionRuleResource Object + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleResource +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +The resource ID of the data collection rule + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleName +The resource name + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags property of the data collection rule + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSDataCollectionRuleResource + +## NOTES + +## RELATED LINKS + +[New-AzDataCollectionRule](./New-AzDataCollectionRule.md) +[Remove-AzDataCollectionRule](./Remove-AzDataCollectionRule.md) +[Get-AzDataCollectionRule](./Get-AzDataCollectionRule.md) +[Set-AzDataCollectionRule](./Set-AzDataCollectionRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Monitor/Update-AzInsightsPrivateLinkScope.md b/azps-10.1.0/Az.Monitor/Update-AzInsightsPrivateLinkScope.md new file mode 100644 index 0000000000..f131c5b832 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Update-AzInsightsPrivateLinkScope.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/update-azinsightsprivatelinkscope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Update-AzInsightsPrivateLinkScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Update-AzInsightsPrivateLinkScope.md +--- + +# Update-AzInsightsPrivateLinkScope + +## SYNOPSIS +Update for private link scope + +## SYNTAX + +### ByResourceNameParameterSet (Default) +``` +Update-AzInsightsPrivateLinkScope -ResourceGroupName <String> -Name <String> [-Tags <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzInsightsPrivateLinkScope -ResourceId <String> [-Tags <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObjectParameterSet +``` +Update-AzInsightsPrivateLinkScope -InputObject <PSMonitorPrivateLinkScope> [-Tags <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update for private link scope + +## EXAMPLES + +### Example 1 +```powershell +Update-AzInsightsPrivateLinkScope -ResourceGroupName "rg_name" -Name "scope_name" -Tags "key:value" +``` + +update private link scope with name "scope_name" under resource group "rg_name" to use tag "key:value" + +### Example 2 +```powershell +Update-AzInsightsPrivateLinkScope -ResourceId "/subscriptions/{subscriptionId}/resourceGroups/rg_name/providers/Microsoft.Insights/privateLinkScopes/scope_name" -Tags "key:value" +``` + +update private link scope with resource Id to use tag "key:value" + +### Example 3 +```powershell +Get-AzInsightsPrivateLinkScope -ResourceGroupName "rg_name" -Name "scope_name" | Update-AzInsightsPrivateLinkScope -Tags "key:value" +``` + +update private link scope with input private link scope object to use tag "key:value" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +PSMonitorPrivateLinkScope + +```yaml +Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScope +Parameter Sets: ByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Private Link Scope Name + +```yaml +Type: System.String +Parameter Sets: ByResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: ByResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +Tags + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScope + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Insights.OutputClasses.PSMonitorPrivateLinkScope + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Update-AzMonitorWorkspace.md b/azps-10.1.0/Az.Monitor/Update-AzMonitorWorkspace.md new file mode 100644 index 0000000000..134a74e7b3 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Update-AzMonitorWorkspace.md @@ -0,0 +1,213 @@ +--- +external help file: Az.MonitorWorkspace.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/update-azmonitorworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Update-AzMonitorWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Update-AzMonitorWorkspace.md +--- + +# Update-AzMonitorWorkspace + +## SYNOPSIS +Updates part of a workspace + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMonitorWorkspace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMonitorWorkspace -InputObject <IMonitorWorkspaceIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates part of a workspace + +## EXAMPLES + +### Example 1: Updates part of a workspace. +```powershell +Update-AzMonitorWorkspace -Name azps-monitor-workspace -ResourceGroupName azps_test_group -Tag @{"123"="abc"} +``` + +```output +Name Location ProvisioningState PublicNetworkAccess ResourceGroupName +---- -------- ----------------- ------------------- ----------------- +azps-monitor-workspace eastus Succeeded Enabled azps_test_group +``` + +Updates part of a workspace. + +### Example 2: Updates part of a workspace. +```powershell +Get-AzMonitorWorkspace -Name azps-monitor-workspace -ResourceGroupName azps_test_group | Update-AzMonitorWorkspace -Tag @{"aaa"="bbb"} +``` + +```output +Name Location ProvisioningState PublicNetworkAccess ResourceGroupName +---- -------- ----------------- ------------------- ----------------- +azps-monitor-workspace eastus Succeeded Enabled azps_test_group +``` + +Updates part of a workspace. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.IMonitorWorkspaceIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Azure Monitor workspace. +The name is case insensitive + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: AzureMonitorWorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.IMonitorWorkspaceIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.Api20230403.IAzureMonitorWorkspaceResource + +## 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 <IMonitorWorkspaceIdentity>`: Identity Parameter + - `[AzureMonitorWorkspaceName <String>]`: The name of the Azure Monitor workspace. The name is case insensitive + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Monitor/Update-AzScheduledQueryRule.md b/azps-10.1.0/Az.Monitor/Update-AzScheduledQueryRule.md new file mode 100644 index 0000000000..f990846c88 --- /dev/null +++ b/azps-10.1.0/Az.Monitor/Update-AzScheduledQueryRule.md @@ -0,0 +1,476 @@ +--- +external help file: Az.ScheduledQueryRule.psm1-help.xml +Module Name: Az.Monitor +online version: https://learn.microsoft.com/powershell/module/az.monitor/update-azscheduledqueryrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Update-AzScheduledQueryRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/Update-AzScheduledQueryRule.md +--- + +# Update-AzScheduledQueryRule + +## SYNOPSIS +Update a scheduled query rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzScheduledQueryRule -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-ActionCustomProperty <Hashtable>] [-ActionGroupResourceId <String[]>] [-AutoMitigate] + [-CheckWorkspaceAlertsStorageConfigured] [-CriterionAllOf <ICondition[]>] [-Description <String>] + [-DisplayName <String>] [-Enabled] [-EvaluationFrequency <TimeSpan>] [-MuteActionsDuration <TimeSpan>] + [-OverrideQueryTimeRange <TimeSpan>] [-Scope <String[]>] [-Severity <Int64>] [-SkipQueryValidation] + [-Tag <Hashtable>] [-TargetResourceType <String[]>] [-WindowSize <TimeSpan>] [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzScheduledQueryRule -InputObject <IScheduledQueryRuleIdentity> [-ActionCustomProperty <Hashtable>] + [-ActionGroupResourceId <String[]>] [-AutoMitigate] [-CheckWorkspaceAlertsStorageConfigured] + [-CriterionAllOf <ICondition[]>] [-Description <String>] [-DisplayName <String>] [-Enabled] + [-EvaluationFrequency <TimeSpan>] [-MuteActionsDuration <TimeSpan>] [-OverrideQueryTimeRange <TimeSpan>] + [-Scope <String[]>] [-Severity <Int64>] [-SkipQueryValidation] [-Tag <Hashtable>] + [-TargetResourceType <String[]>] [-WindowSize <TimeSpan>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Update a scheduled query rule. + +## EXAMPLES + +### Example 1: Update scheduled query rule +```powershell +$subscriptionId=(Get-AzContext).Subscription.Id +Update-AzScheduledQueryRule -Name test-rule -ResourceGroupName test-group -Scope "/subscriptions/$subscriptionId/resourceGroups/test-group/providers/Microsoft.Compute/virtualMachines/test-vm" -ActionGroupResourceId "/subscriptions/$subscriptionId/resourceGroups/test-group/providers/microsoft.insights/actionGroups/test-action-group" -AutoMitigate:$false +``` + +Update scheduled query rule + +## PARAMETERS + +### -ActionCustomProperty +The properties of an alert payload. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActionGroupResourceId +Action Group resource Ids to invoke when the alert fires. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoMitigate +The flag that indicates whether the alert should be automatically resolved or not. +The default is true. +Relevant only for rules of the kind LogAlert. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CheckWorkspaceAlertsStorageConfigured +The flag which indicates whether this scheduled query rule should be stored in the customer's storage. +The default is false. +Relevant only for rules of the kind LogAlert. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CriterionAllOf +A list of conditions to evaluate against the specified scopes +To construct, see NOTES section for CRITERIONALLOF properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api20210801.ICondition[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the scheduled query rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name of the alert rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The flag which indicates whether this scheduled query rule is enabled. +Value should be true or false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EvaluationFrequency +How often the scheduled query rule is evaluated represented in ISO 8601 duration format. +Relevant and required only for rules of the kind LogAlert. + +```yaml +Type: System.TimeSpan +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.Monitor.ScheduledQueryRule.Models.IScheduledQueryRuleIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MuteActionsDuration +Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. +Relevant only for rules of the kind LogAlert. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the rule. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverrideQueryTimeRange +If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). +Relevant only for rules of the kind LogAlert. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The list of resource id's that this scheduled query rule is scoped to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity +Severity of the alert. +Should be an integer between [0-4]. +Value of 0 is severest. +Relevant and required only for rules of the kind LogAlert. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipQueryValidation +The flag which indicates whether the provided query should be validated or not. +The default is false. +Relevant only for rules of the kind LogAlert. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceType +List of resource type of the target resource(s) on which the alert is created/updated. +For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. +Relevant only for rules of the kind LogAlert + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowSize +The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). +Relevant and required only for rules of the kind LogAlert. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.IScheduledQueryRuleIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api20210801.IScheduledQueryRuleResource + +## 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. + + +`CRITERIONALLOF <ICondition[]>`: A list of conditions to evaluate against the specified scopes + - `[Dimension <IDimension[]>]`: List of Dimensions conditions + - `Name <String>`: Name of the dimension + - `Operator <DimensionOperator>`: Operator for dimension values + - `Value <String[]>`: List of dimension values + - `[FailingPeriodMinFailingPeriodsToAlert <Int64?>]`: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 + - `[FailingPeriodNumberOfEvaluationPeriod <Int64?>]`: The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1 + - `[MetricMeasureColumn <String>]`: The column containing the metric measure number. Relevant only for rules of the kind LogAlert. + - `[MetricName <String>]`: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric. + - `[Operator <ConditionOperator?>]`: The criteria operator. Relevant and required only for rules of the kind LogAlert. + - `[Query <String>]`: Log query alert + - `[ResourceIdColumn <String>]`: The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert. + - `[Threshold <Double?>]`: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert. + - `[TimeAggregation <TimeAggregation?>]`: Aggregation type. Relevant and required only for rules of the kind LogAlert. + +`INPUTOBJECT <IScheduledQueryRuleIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleName <String>]`: The name of the rule. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.MonitoringSolutions/Az.MonitoringSolutions.md b/azps-10.1.0/Az.MonitoringSolutions/Az.MonitoringSolutions.md new file mode 100644 index 0000000000..36b196ca08 --- /dev/null +++ b/azps-10.1.0/Az.MonitoringSolutions/Az.MonitoringSolutions.md @@ -0,0 +1,27 @@ +--- +Module Name: Az.MonitoringSolutions +Module Guid: 4e0cdc62-833e-41bd-aa97-f8f042986de3 +Download Help Link: https://learn.microsoft.com/powershell/module/az.monitoringsolutions +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MonitoringSolutions/help/Az.MonitoringSolutions.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MonitoringSolutions/help/Az.MonitoringSolutions.md +--- + +# Az.MonitoringSolutions Module +## Description +Microsoft Azure PowerShell: MonitoringSolutions cmdlets + +## Az.MonitoringSolutions Cmdlets +### [Get-AzMonitorLogAnalyticsSolution](Get-AzMonitorLogAnalyticsSolution.md) +Retrieves the user solution. + +### [New-AzMonitorLogAnalyticsSolution](New-AzMonitorLogAnalyticsSolution.md) +Creates a log analytics solution. + +### [Remove-AzMonitorLogAnalyticsSolution](Remove-AzMonitorLogAnalyticsSolution.md) +Deletes the solution in the subscription. + +### [Update-AzMonitorLogAnalyticsSolution](Update-AzMonitorLogAnalyticsSolution.md) +Update the tags of a solution. + diff --git a/azps-10.1.0/Az.MonitoringSolutions/Get-AzMonitorLogAnalyticsSolution.md b/azps-10.1.0/Az.MonitoringSolutions/Get-AzMonitorLogAnalyticsSolution.md new file mode 100644 index 0000000000..a95012304d --- /dev/null +++ b/azps-10.1.0/Az.MonitoringSolutions/Get-AzMonitorLogAnalyticsSolution.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.MonitoringSolutions +online version: https://learn.microsoft.com/powershell/module/az.monitoringsolutions/get-azmonitorloganalyticssolution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MonitoringSolutions/help/Get-AzMonitorLogAnalyticsSolution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MonitoringSolutions/help/Get-AzMonitorLogAnalyticsSolution.md +--- + +# Get-AzMonitorLogAnalyticsSolution + +## SYNOPSIS +Retrieves the user solution. + +## SYNTAX + +### List1 (Default) +``` +Get-AzMonitorLogAnalyticsSolution [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzMonitorLogAnalyticsSolution -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMonitorLogAnalyticsSolution -InputObject <IMonitoringSolutionsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzMonitorLogAnalyticsSolution -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the user solution. + +## EXAMPLES + +### Example 1: Get a monitor log analytics solution by name +```powershell +Get-AzMonitorLogAnalyticsSolution -ResourceGroupName azureps-monitor -Name 'Containers(azureps-monitor)' +``` + +```output +Name Type Location +---- ---- -------- +Containers(azureps-monitor) Microsoft.OperationsManagement/solutions West US 2 +``` + +This command gets a monitor log analytics solution by name. + +### Example 2: Get a monitor log analytics solution by resource id +```powershell +@{Id = "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/azureps-manual-test/providers/Microsoft.OperationsManagement/solutions/Containers(monitoringworkspace-t01)"} | Get-AzMonitorLogAnalyticsSolution +``` + +```output +Name Type Location +---- ---- -------- +Containers(monitoringworkspace-t01) Microsoft.OperationsManagement/solutions East US +``` + +This command gets a monitor log analytics solution by resource id. + +### Example 3: Get a monitor log analytics solution by object +```powershell +$monitor = New-AzMonitorLogAnalyticsSolution -ResourceGroupName azureps-monitor -Type "Microsoft.OperationsManagement/solutions" -Location "West US 2" -WorkspaceResourceId workspaceResourceId +Get-AzMonitorLogAnalyticsSolution -InputObject $monitor +``` + +```output +Name Type Location +---- ---- -------- +Containers(azureps-monitor) Microsoft.OperationsManagement/solutions West US 2 +``` + +This command gets a monitor log analytics solution by object. + +### Example 4: Get all monitor log analytics solutions under a resource group +```powershell +Get-AzMonitorLogAnalyticsSolution -ResourceGroupName azureps-monitor +``` + +```output +Name Type Location +---- ---- -------- +Containers(azureps-monitor) Microsoft.OperationsManagement/solutions West US 2 +``` + +This command gets all monitor log analytics solutions under a resource group. + +### Example 5: Get all monitor log analytics solutions under a subscription +```powershell +Get-AzMonitorLogAnalyticsSolution +``` + +```output +Name Type Location +---- ---- -------- +Containers(monitoringworkspace-t01) Microsoft.OperationsManagement/solutions East US +Containers(azureps-monitor) Microsoft.OperationsManagement/solutions West US 2 +``` + +This command gets all monitor log analytics solutions under a subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MonitoringSolutions.Models.IMonitoringSolutionsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +User Solution Name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SolutionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to get. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MonitoringSolutions.Models.IMonitoringSolutionsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MonitoringSolutions.Models.Api20151101Preview.ISolution + +## 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 `<IMonitoringSolutionsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ManagementAssociationName <String>]`: User ManagementAssociation Name. + - `[ManagementConfigurationName <String>]`: User Management Configuration Name. + - `[ProviderName <String>]`: Provider name for the parent resource. + - `[ResourceGroupName <String>]`: The name of the resource group to get. The name is case insensitive. + - `[ResourceName <String>]`: Parent resource name. + - `[ResourceType <String>]`: Resource type for the parent resource + - `[SolutionName <String>]`: User Solution Name. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MonitoringSolutions/New-AzMonitorLogAnalyticsSolution.md b/azps-10.1.0/Az.MonitoringSolutions/New-AzMonitorLogAnalyticsSolution.md new file mode 100644 index 0000000000..529b00abb5 --- /dev/null +++ b/azps-10.1.0/Az.MonitoringSolutions/New-AzMonitorLogAnalyticsSolution.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.MonitoringSolutions +online version: https://learn.microsoft.com/powershell/module/az.monitoringsolutions/new-azmonitorloganalyticssolution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MonitoringSolutions/help/New-AzMonitorLogAnalyticsSolution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MonitoringSolutions/help/New-AzMonitorLogAnalyticsSolution.md +--- + +# New-AzMonitorLogAnalyticsSolution + +## SYNOPSIS +Creates a log analytics solution. + +## SYNTAX + +``` +New-AzMonitorLogAnalyticsSolution -ResourceGroupName <String> -Location <String> -Type <String> + -WorkspaceResourceId <String> [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a log analytics solution. + +## EXAMPLES + +### Example 1: Create a monitor log analytics solution for the log analytics workspace +```powershell +$workspace = Get-AzOperationalInsightsWorkspace -ResourceGroupName azureps-manual-test -Name monitoringworkspace-2vob7n +New-AzMonitorLogAnalyticsSolution -Type Containers -ResourceGroupName azureps-manual-test -Location $workspace.Location -WorkspaceResourceId $workspace.ResourceId +``` + +```output +Name Type Location +---- ---- -------- +Containers(monitoringworkspace-2vob7n) Microsoft.OperationsManagement/solutions East US +``` + +This command creates a monitor log analytics solution for the log analytics workspace. + +Commonly used types are: + +| Type | Description | +| :-----| :----- | +| SecurityCenterFree | Azure Security Center – Free Edition | +| Security | Azure Security Center | +| Updates | Update Management | +| ContainerInsights | Azure Monitor for Containers | +| ServiceMap | Service Map | +| AzureActivity | Activity log analytics | +| ChangeTracking | Change tracking and inventory | +| VMInsights | Azure Monitor for VMs | +| SecurityInsights | Azure Sentinel | +| NetworkMonitoring | Network Performance Monitor | +| SQLVulnerabilityAssessment | SQL Vulnerability Assessment | +| SQLAdvancedThreatProtection | SQL Advanced Threat Protection | +| AntiMalware | Antimalware Assessment | +| AzureAutomation | Automation Hybrid Worker | +| LogicAppsManagement | Logic Apps Management | +| SQLDataClassification | SQL Data Discovery & Classification | + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. +Must be the same as the log analytic workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to get. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of the solution to be created. +For example "Container". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SolutionType + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +The Azure resource ID for the workspace where the solution will be deployed/enabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MonitoringSolutions.Models.Api20151101Preview.ISolution + +## NOTES + +ALIASES + +## RELATED LINKS + + + +[Get-AzOperationalInsightsWorkspace](https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightsworkspace) + diff --git a/azps-10.1.0/Az.MonitoringSolutions/Remove-AzMonitorLogAnalyticsSolution.md b/azps-10.1.0/Az.MonitoringSolutions/Remove-AzMonitorLogAnalyticsSolution.md new file mode 100644 index 0000000000..52059c914e --- /dev/null +++ b/azps-10.1.0/Az.MonitoringSolutions/Remove-AzMonitorLogAnalyticsSolution.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.MonitoringSolutions +online version: https://learn.microsoft.com/powershell/module/az.monitoringsolutions/remove-azmonitorloganalyticssolution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MonitoringSolutions/help/Remove-AzMonitorLogAnalyticsSolution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MonitoringSolutions/help/Remove-AzMonitorLogAnalyticsSolution.md +--- + +# Remove-AzMonitorLogAnalyticsSolution + +## SYNOPSIS +Deletes the solution in the subscription. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMonitorLogAnalyticsSolution -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMonitorLogAnalyticsSolution -InputObject <IMonitoringSolutionsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the solution in the subscription. + +## EXAMPLES + +### Example 1: Remove a monitor log analytics solution by name +```powershell +Remove-AzMonitorLogAnalyticsSolution -ResourceGroupName azureps-manual-test -Name 'Containers(monitoringworkspace-2vob7n)' +``` + +This command removes a monitor log analytics solution by name. + +### Example 2: Remove a monitor log analytics solution by object +```powershell +$monitor = Get-AzMonitorLogAnalyticsSolution -ResourceGroupName azureps-manual-test -Name 'Containers(monitoringworkspace-pevful)' +Remove-AzMonitorLogAnalyticsSolution -InputObject $monitor +``` + +This command removes a monitor log analytics solution by object. + +### Example 3: Remove a monitor log analytics solution by pipeline +```powershell +$monitor = Get-AzMonitorLogAnalyticsSolution -ResourceGroupName azureps-manual-test -Name 'Containers(monitoringworkspace-asdehu)' | Remove-AzMonitorLogAnalyticsSolution +``` + +This command removes a monitor log analytics solution by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MonitoringSolutions.Models.IMonitoringSolutionsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +User Solution Name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SolutionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to get. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MonitoringSolutions.Models.IMonitoringSolutionsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IMonitoringSolutionsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ManagementAssociationName <String>]`: User ManagementAssociation Name. + - `[ManagementConfigurationName <String>]`: User Management Configuration Name. + - `[ProviderName <String>]`: Provider name for the parent resource. + - `[ResourceGroupName <String>]`: The name of the resource group to get. The name is case insensitive. + - `[ResourceName <String>]`: Parent resource name. + - `[ResourceType <String>]`: Resource type for the parent resource + - `[SolutionName <String>]`: User Solution Name. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MonitoringSolutions/Update-AzMonitorLogAnalyticsSolution.md b/azps-10.1.0/Az.MonitoringSolutions/Update-AzMonitorLogAnalyticsSolution.md new file mode 100644 index 0000000000..e7bbe60c2f --- /dev/null +++ b/azps-10.1.0/Az.MonitoringSolutions/Update-AzMonitorLogAnalyticsSolution.md @@ -0,0 +1,219 @@ +--- +external help file: +Module Name: Az.MonitoringSolutions +online version: https://learn.microsoft.com/powershell/module/az.monitoringsolutions/update-azmonitorloganalyticssolution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MonitoringSolutions/help/Update-AzMonitorLogAnalyticsSolution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MonitoringSolutions/help/Update-AzMonitorLogAnalyticsSolution.md +--- + +# Update-AzMonitorLogAnalyticsSolution + +## SYNOPSIS +Update the tags of a solution. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMonitorLogAnalyticsSolution -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMonitorLogAnalyticsSolution -InputObject <IMonitoringSolutionsIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update the tags of a solution. + +## EXAMPLES + +### Example 1: Update a monitor log analytics solution by name +```powershell +Update-AzMonitorLogAnalyticsSolution -ResourceGroupName lucas-manual-test -Name 'Containers(monitoringworkspace-2vob7n)' -Tag @{'Operation'='update';'Param'='Tag'} +``` + +```output +Name Type Location +---- ---- -------- +Containers(monitoringworkspace-2vob7n) Microsoft.OperationsManagement/solutions East US +``` + +This command updates a monitor log analytics solution by name. + +### Example 2: Update a monitor log analytics solution by object +```powershell +$monitor = Get-AzMonitorLogAnalyticsSolution -ResourceGroupName lucas-manual-test -Name 'Containers(monitoringworkspace-2vob7n)' +Update-AzMonitorLogAnalyticsSolution -InputObject $monitor -Tag @{'Operation'='update';'Param'='Tag'} +``` + +```output +Name Type Location +---- ---- -------- +Containers(monitoringworkspace-2vob7n) Microsoft.OperationsManagement/solutions East US +``` + +This command updates a monitor log analytics solution by object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MonitoringSolutions.Models.IMonitoringSolutionsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +User Solution Name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: SolutionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group to get. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MonitoringSolutions.Models.IMonitoringSolutionsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MonitoringSolutions.Models.Api20151101Preview.ISolution + +## 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 `<IMonitoringSolutionsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ManagementAssociationName <String>]`: User ManagementAssociation Name. + - `[ManagementConfigurationName <String>]`: User Management Configuration Name. + - `[ProviderName <String>]`: Provider name for the parent resource. + - `[ResourceGroupName <String>]`: The name of the resource group to get. The name is case insensitive. + - `[ResourceName <String>]`: Parent resource name. + - `[ResourceType <String>]`: Resource type for the parent resource + - `[SolutionName <String>]`: User Solution Name. + - `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Az.MySql.md b/azps-10.1.0/Az.MySql/Az.MySql.md new file mode 100644 index 0000000000..3e7bcf176e --- /dev/null +++ b/azps-10.1.0/Az.MySql/Az.MySql.md @@ -0,0 +1,146 @@ +--- +Module Name: Az.MySql +Module Guid: 0b8ac9f4-b926-4ac8-b73f-937a0d218521 +Download Help Link: https://learn.microsoft.com/powershell/module/az.mysql +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Az.MySql.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Az.MySql.md +--- + +# Az.MySql Module +## Description +Microsoft Azure PowerShell: MySql cmdlets + +## Az.MySql Cmdlets +### [Get-AzMySqlConfiguration](Get-AzMySqlConfiguration.md) +Gets information about a configuration of server. + +### [Get-AzMySqlConnectionString](Get-AzMySqlConnectionString.md) +Get the connection string according to client connection provider. + +### [Get-AzMySqlFirewallRule](Get-AzMySqlFirewallRule.md) +Gets information about a server firewall rule. + +### [Get-AzMySqlFlexibleServer](Get-AzMySqlFlexibleServer.md) +Gets information about a server. + +### [Get-AzMySqlFlexibleServerConfiguration](Get-AzMySqlFlexibleServerConfiguration.md) +Gets information about a configuration of server. + +### [Get-AzMySqlFlexibleServerConnectionString](Get-AzMySqlFlexibleServerConnectionString.md) +Get the connection string according to client connection provider. + +### [Get-AzMySqlFlexibleServerDatabase](Get-AzMySqlFlexibleServerDatabase.md) +Gets information about a database. + +### [Get-AzMySqlFlexibleServerFirewallRule](Get-AzMySqlFlexibleServerFirewallRule.md) +Gets information about a server firewall rule. + +### [Get-AzMySqlFlexibleServerLocationBasedCapability](Get-AzMySqlFlexibleServerLocationBasedCapability.md) +Get the available SKU information for the location + +### [Get-AzMySqlFlexibleServerReplica](Get-AzMySqlFlexibleServerReplica.md) +List all the replicas for a given server. + +### [Get-AzMySqlReplica](Get-AzMySqlReplica.md) +List all the replicas for a given server. + +### [Get-AzMySqlServer](Get-AzMySqlServer.md) +Gets information about a server. + +### [Get-AzMySqlVirtualNetworkRule](Get-AzMySqlVirtualNetworkRule.md) +Gets a virtual network rule. + +### [New-AzMySqlFirewallRule](New-AzMySqlFirewallRule.md) +Creates a new firewall rule or updates an existing firewall rule. + +### [New-AzMySqlFlexibleServer](New-AzMySqlFlexibleServer.md) +Creates a new MySQL flexible server. + +### [New-AzMySqlFlexibleServerDatabase](New-AzMySqlFlexibleServerDatabase.md) +Creates a new database or updates an existing database. + +### [New-AzMySqlFlexibleServerFirewallRule](New-AzMySqlFlexibleServerFirewallRule.md) +Creates a new firewall rule for MySQL flexible server + +### [New-AzMySqlFlexibleServerReplica](New-AzMySqlFlexibleServerReplica.md) +Creates a replica server for a MySQL flexible server + +### [New-AzMySqlReplica](New-AzMySqlReplica.md) +Creates a new replica from an existing database. + +### [New-AzMySqlServer](New-AzMySqlServer.md) +Creates a new server. + +### [New-AzMySqlVirtualNetworkRule](New-AzMySqlVirtualNetworkRule.md) +Creates or updates an existing virtual network rule. + +### [Remove-AzMySqlFirewallRule](Remove-AzMySqlFirewallRule.md) +Deletes a server firewall rule. + +### [Remove-AzMySqlFlexibleServer](Remove-AzMySqlFlexibleServer.md) +Deletes a server. + +### [Remove-AzMySqlFlexibleServerDatabase](Remove-AzMySqlFlexibleServerDatabase.md) +Deletes a database. + +### [Remove-AzMySqlFlexibleServerFirewallRule](Remove-AzMySqlFlexibleServerFirewallRule.md) +Deletes a firewall rule. + +### [Remove-AzMySqlServer](Remove-AzMySqlServer.md) +Deletes a server. + +### [Remove-AzMySqlVirtualNetworkRule](Remove-AzMySqlVirtualNetworkRule.md) +Deletes the virtual network rule with the given name. + +### [Restart-AzMySqlFlexibleServer](Restart-AzMySqlFlexibleServer.md) +Restarts a server. + +### [Restart-AzMySqlServer](Restart-AzMySqlServer.md) +Restarts a server. + +### [Restore-AzMySqlFlexibleServer](Restore-AzMySqlFlexibleServer.md) +Restore a server from an existing backup + +### [Restore-AzMySqlServer](Restore-AzMySqlServer.md) +Restore a server from an existing backup + +### [Start-AzMySqlFlexibleServer](Start-AzMySqlFlexibleServer.md) +Starts a server. + +### [Stop-AzMySqlFlexibleServer](Stop-AzMySqlFlexibleServer.md) +Stops a server. + +### [Test-AzMySqlFlexibleServerConnect](Test-AzMySqlFlexibleServerConnect.md) +Test out the connection to the database server + +### [Update-AzMySqlConfiguration](Update-AzMySqlConfiguration.md) +Updates a configuration of a server. +Use Update-AzMySqlServer instead if you want update AdministratorLoginPassword, sku, etc. + +### [Update-AzMySqlFirewallRule](Update-AzMySqlFirewallRule.md) +Creates a new firewall rule or updates an existing firewall rule. + +### [Update-AzMySqlFlexibleServer](Update-AzMySqlFlexibleServer.md) +Updates an existing MySQL flexible server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzMySqlFlexibleServerConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +### [Update-AzMySqlFlexibleServerConfiguration](Update-AzMySqlFlexibleServerConfiguration.md) +Updates information about a configuration of a MySQL flexible server. + +### [Update-AzMySqlFlexibleServerFirewallRule](Update-AzMySqlFlexibleServerFirewallRule.md) +Updates an existing firewall rule. + +### [Update-AzMySqlServer](Update-AzMySqlServer.md) +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzMySqlConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +### [Update-AzMySqlServerConfigurationsList](Update-AzMySqlServerConfigurationsList.md) +Update a list of configurations in a given server. + +### [Update-AzMySqlVirtualNetworkRule](Update-AzMySqlVirtualNetworkRule.md) +Creates or updates an existing virtual network rule. + diff --git a/azps-10.1.0/Az.MySql/Get-AzMySqlConfiguration.md b/azps-10.1.0/Az.MySql/Get-AzMySqlConfiguration.md new file mode 100644 index 0000000000..025e033534 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Get-AzMySqlConfiguration.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/get-azmysqlconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlConfiguration.md +--- + +# Get-AzMySqlConfiguration + +## SYNOPSIS +Gets information about a configuration of server. + +## SYNTAX + +### List (Default) +``` +Get-AzMySqlConfiguration -ResourceGroupName <String> -ServerName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMySqlConfiguration -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMySqlConfiguration -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a configuration of server. + +## EXAMPLES + +### Example 1: List all configurations in specified MySql server +```powershell +Get-AzMySqlConfiguration -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +Name Type +---- ---- +audit_log_enabled Microsoft.DBforMySQL/servers/configurations +audit_log_events Microsoft.DBforMySQL/servers/configurations +audit_log_exclude_users Microsoft.DBforMySQL/servers/configurations +audit_log_include_users Microsoft.DBforMySQL/servers/configurations +... +transaction_prealloc_size Microsoft.DBforMySQL/servers/configurations +tx_isolation Microsoft.DBforMySQL/servers/configurations +updatable_views_with_limit Microsoft.DBforMySQL/servers/configurations +wait_timeout Microsoft.DBforMySQL/servers/configurations +``` + +This cmdlet lists all configurations in specified MySql server. + +### Example 2: Get specified MySql configuration by name +```powershell +Get-AzMySqlConfiguration -Name time_zone -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +Name Type +---- ---- +time_zone Microsoft.DBforMySQL/servers/configurations +``` + +This cmdlet gets specified MySql configuration by name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server configuration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IConfiguration + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Get-AzMySqlConnectionString.md b/azps-10.1.0/Az.MySql/Get-AzMySqlConnectionString.md new file mode 100644 index 0000000000..66c7cd9657 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Get-AzMySqlConnectionString.md @@ -0,0 +1,197 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/get-azmysqlconnectionstring +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlConnectionString.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlConnectionString.md +--- + +# Get-AzMySqlConnectionString + +## SYNOPSIS +Get the connection string according to client connection provider. + +## SYNTAX + +### Get (Default) +``` +Get-AzMySqlConnectionString -Client <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMySqlConnectionString -Client <String> -InputObject <IServer> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the connection string according to client connection provider. + +## EXAMPLES + +### Example 1: Get MySql server connection string by resource group and server name +```powershell +Get-AzMySqlConnectionString -Client ADO.NET -Name mysql-test -ResourceGroupName PowershellMySqlTest +``` + +```output +Server=mysql-test.mysql.database.azure.com; Port=3306; Database={your_database}; Uid=mysql_test@mysql-test; Pwd={your_password}; +``` + +This cmdlet gets MySql server connection string by resource group and server name. + +### Example 2: Get MySql server connection string by identity +```powershell +Get-AzMySqlServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test | Get-AzMySqlConnectionString -Client PHP +``` + +```output +$con=mysqli_init(); mysqli_real_connect($con, "mysql-test.mysql.database.azure.com", "mysql_test@mysql-test", {your_password}, {your_database}, 3306); +``` + +This cmdlet gets MySql server connection string by identity. + +## PARAMETERS + +### -Client +Client connection provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The server for the connection string. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IServer +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IServer + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServer>`: The server for the connection string. + - `Location <String>`: The geo-location where the resource lives + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdministratorLogin <String>]`: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). + - `[EarliestRestoreDate <DateTime?>]`: Earliest restore point creation time (ISO8601 format) + - `[FullyQualifiedDomainName <String>]`: The fully qualified domain name of a server. + - `[IdentityType <IdentityType?>]`: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + - `[InfrastructureEncryption <InfrastructureEncryption?>]`: Status showing whether the server enabled infrastructure encryption. + - `[MasterServerId <String>]`: The master server id of a replica server. + - `[MinimalTlsVersion <MinimalTlsVersionEnum?>]`: Enforce a minimal Tls version for the server. + - `[PublicNetworkAccess <PublicNetworkAccessEnum?>]`: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' + - `[ReplicaCapacity <Int32?>]`: The maximum number of replicas that a master server can have. + - `[ReplicationRole <String>]`: The replication role of the server. + - `[SkuCapacity <Int32?>]`: The scale up/out capacity, representing server's compute units. + - `[SkuFamily <String>]`: The family of hardware. + - `[SkuName <String>]`: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. + - `[SkuSize <String>]`: The size code, to be interpreted by resource as appropriate. + - `[SkuTier <SkuTier?>]`: The tier of the particular SKU, e.g. Basic. + - `[SslEnforcement <SslEnforcementEnum?>]`: Enable ssl enforcement or not when connect to server. + - `[StorageProfileBackupRetentionDay <Int32?>]`: Backup retention days for the server. + - `[StorageProfileGeoRedundantBackup <GeoRedundantBackup?>]`: Enable Geo-redundant or not for server backup. + - `[StorageProfileStorageAutogrow <StorageAutogrow?>]`: Enable Storage Auto Grow. + - `[StorageProfileStorageMb <Int32?>]`: Max storage allowed for a server. + - `[UserVisibleState <ServerState?>]`: A state of a server that is visible to user. + - `[Version <ServerVersion?>]`: Server version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Get-AzMySqlFirewallRule.md b/azps-10.1.0/Az.MySql/Get-AzMySqlFirewallRule.md new file mode 100644 index 0000000000..71f08d9b26 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Get-AzMySqlFirewallRule.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/get-azmysqlfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFirewallRule.md +--- + +# Get-AzMySqlFirewallRule + +## SYNOPSIS +Gets information about a server firewall rule. + +## SYNTAX + +### List (Default) +``` +Get-AzMySqlFirewallRule -ResourceGroupName <String> -ServerName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMySqlFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMySqlFirewallRule -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a server firewall rule. + +## EXAMPLES + +### Example 1: Lists all the Firewall Rules in specified MySql server +```powershell +Get-AzMySqlFirewallRule -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +Name Type +---- ---- +rule Microsoft.DBforMySQL/servers/firewallRules +``` + +This cmdlet lists all the Firewall Rule in specified MySql server. + +### Example 2: Get Firewall Rule by name +```powershell +Get-AzMySqlFirewallRule -Name rule -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +Name Type +---- ---- +rule Microsoft.DBforMySQL/servers/firewallRules +``` + +This cmdlet gets Firewall Rule by name. + +### Example 3: Get Firewall Rule by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/servers/mysql-test/firewallRules/rule" +Get-AzMySqlFirewallRule -InputObject $ID +``` + +```output +Name Type +---- ---- +rule Microsoft.DBforMySQL/servers/firewallRules +``` + +This cmdlet gets Firewall Rule by identity. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IFirewallRule + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServer.md b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServer.md new file mode 100644 index 0000000000..34964ad2ee --- /dev/null +++ b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServer.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/get-azmysqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServer.md +--- + +# Get-AzMySqlFlexibleServer + +## SYNOPSIS +Gets information about a server. + +## SYNTAX + +### List1 (Default) +``` +Get-AzMySqlFlexibleServer [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMySqlFlexibleServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMySqlFlexibleServer -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzMySqlFlexibleServer -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a server. + +## EXAMPLES + +### Example 1: Get MySql server with default context +```powershell +Get-AzMySqlFlexibleServer +``` + +```output +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test West US 2 Standard_D2ds_v4 GeneralPurpose admin 5.7 32 + +``` + +This cmdlet gets MySql servers with default context. + +### Example 2: Get MySql server by resource group and server name +```powershell +Get-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -Name mysql-test +``` + +```output +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test West US 2 Standard_D2ds_v4 GeneralPurpose admin 5.7 32 +``` + +This cmdlet gets MySql servers by resource group and server name. + +### Example 3: Lists all the MySql servers in specified resource group +```powershell +Get-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest +``` + +```output +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test West US 2 Standard_D2ds_v4 GeneralPurpose admin 5.7 32 +mysql-test2 West US 2 Standard_D2ds_v4 GeneralPurpose admin 5.7 32 +``` + +This cmdlet lists all the MySql servers in the specified resource group. + +### Example 4: Get MySql server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/flexibleServers/mysql-test" +Get-AzMySqlFlexibleServer -InputObject $ID +``` + +```output +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test West US 2 Standard_D2ds_v4 GeneralPurpose admin 5.7 32 +``` + +This cmdlet lists gets MySql servers by identity. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IServerAutoGenerated + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerConfiguration.md b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerConfiguration.md new file mode 100644 index 0000000000..3c2590d1ad --- /dev/null +++ b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerConfiguration.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/get-azmysqlflexibleserverconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServerConfiguration.md +--- + +# Get-AzMySqlFlexibleServerConfiguration + +## SYNOPSIS +Gets information about a configuration of server. + +## SYNTAX + +### List (Default) +``` +Get-AzMySqlFlexibleServerConfiguration -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMySqlFlexibleServerConfiguration -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMySqlFlexibleServerConfiguration -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a configuration of server. + +## EXAMPLES + +### Example 1: List all configurations in specified MySql server +```powershell +Get-AzMySqlFlexibleServerConfiguration -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +Name Value +---- ----- +archive OFF +audit_log_enabled OFF +audit_log_events CONNECTION +audit_log_exclude_users azure_superuser +... +wait_timeout 28800 +``` + +This cmdlet lists all configurations in specified MySql server. + +### Example 2: Get specified MySql configuration by name +```powershell +Get-AzMySqlFlexibleServerConfiguration -Name wait_timeout -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +Name Value AllowedValue Source DefaultValue +---- ----- ------------ ------ ------------ +wait_timeout 28800 1-31536000 system-default 28800 +``` + +This cmdlet gets specified MySql configuration by name. + +### Example 3: List configuration by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/flexibleServers/mysql-test/configurations/wait_timeout" +Get-AzMySqlFlexibleServerConfiguration -Name wait_timeout -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +Name Value AllowedValue Source DefaultValue +---- ----- ------------ ------ ------------ +wait_timeout 28800 1-31536000 system-default 28800 +``` + +This cmdlet gets specified MySql configuration by identity. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server configuration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IConfigurationAutoGenerated + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerConnectionString.md b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerConnectionString.md new file mode 100644 index 0000000000..61094a0b75 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerConnectionString.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/get-azmysqlflexibleserverconnectionstring +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServerConnectionString.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServerConnectionString.md +--- + +# Get-AzMySqlFlexibleServerConnectionString + +## SYNOPSIS +Get the connection string according to client connection provider. + +## SYNTAX + +### Get (Default) +``` +Get-AzMySqlFlexibleServerConnectionString -Client <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMySqlFlexibleServerConnectionString -Client <String> -InputObject <IMySqlIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the connection string according to client connection provider. + +## EXAMPLES + +### Example 1: Get connection string by name +```powershell +Get-AzMySqlFlexibleServerConnectionString -Client Python -ResourceGroupName PowershellMySqlTest -Name mysql-test +``` + +```output +cnx = mysql.connector.connect(user=mysql_user, password="{your_password}", host="mysql-test.mysql.database.azure.com", port=3306, database="{your_database}", ssl_ca="{ca-cert filename}", ssl_disabled=False) +``` + +This cmdlet shows connection string of a client by server name. + +### Example 2: Get MySql server connection string by identity +```powershell +Get-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test | Get-AzMySqlFlexibleServerConnectionString -Client PHP +``` + +```output +$con=mysqli_init(); mysqli_real_connect($con, "mysql-test.mysql.database.azure.com", "mysql_test", {your_password}, {your_database}, 3306); +``` + +This cmdlet gets MySql server connection string by identity. + +## PARAMETERS + +### -Client +Client connection provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The server for the connection string. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMySqlIdentity>`: The server for the connection string. + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerDatabase.md b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerDatabase.md new file mode 100644 index 0000000000..f735fd5db8 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerDatabase.md @@ -0,0 +1,217 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/get-azmysqlflexibleserverdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServerDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServerDatabase.md +--- + +# Get-AzMySqlFlexibleServerDatabase + +## SYNOPSIS +Gets information about a database. + +## SYNTAX + +### List (Default) +``` +Get-AzMySqlFlexibleServerDatabase -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMySqlFlexibleServerDatabase -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMySqlFlexibleServerDatabase -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a database. + +## EXAMPLES + +### Example 1: Get a MySql database by resource name +```powershell +Get-AzMySqlFlexibleServerDatabase -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -Name flexibleserverdb +``` + +```output +Name Charset Collation +---- -------- ------------------ +flexibleserverdb utf8 utf8_general_ci +``` + +This cmdlet gets MySql server by resource name. + +### Example 2: Get MySql databases by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/flexibleServers/mysql-test" +Get-AzMySqlFlexibleServerDatabase -InputObject $ID +``` + +```output +Name Charset Collation +---- ------- --------- +information_schema utf8 utf8_general_ci +flexibleserverdb utf8 utf8_general_ci +mysql latin1 latin1_swedish_ci +performance_schema utf8 utf8_general_ci +sys utf8 utf8_general_ci +``` + +This cmdlet gets a MySql server by identity. + +### Example 3: Lists all the MySql databases in the specified server +```powershell +Get-AzMySqlFlexibleServerDatabase -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +Name Charset Collation +---- ------- --------- +information_schema utf8 utf8_general_ci +flexibleserverdb utf8 utf8_general_ci +mysql latin1 latin1_swedish_ci +performance_schema utf8 utf8_general_ci +sys utf8 utf8_general_ci +``` + +This cmdlet lists all the MySql servers in specified the server. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the database. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DatabaseName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IDatabaseAutoGenerated + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerFirewallRule.md b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerFirewallRule.md new file mode 100644 index 0000000000..cedfc5cee8 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerFirewallRule.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/get-azmysqlflexibleserverfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServerFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServerFirewallRule.md +--- + +# Get-AzMySqlFlexibleServerFirewallRule + +## SYNOPSIS +Gets information about a server firewall rule. + +## SYNTAX + +### List (Default) +``` +Get-AzMySqlFlexibleServerFirewallRule -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMySqlFlexibleServerFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMySqlFlexibleServerFirewallRule -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a server firewall rule. + +## EXAMPLES + +### Example 1: Get firewall rules by name +```powershell +Get-AzMySqlFlexibleServerFirewallRule -Name firewallrule-test -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +FirewallRuleName StartIPAddress EndIPAddress +----------------- --------------- --------------- +firewallrule-test 12.12.12.12 23.23.23.23 +``` + +This cmdlet gets firewall rules by name. + +### Example 2: Get firewall rules by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/servers/mysql-test/firewallRules/firewallrule-test" +Get-AzMySqlFlexibleServerFirewallRule -InputObject $ID +``` + +```output +FirewallRuleName StartIPAddress EndIPAddress +----------------- --------------- --------------- +firewallrule-test 12.12.12.12 23.23.23.23 +``` + +This cmdlet gets firewall rules by identity. + +### Example 3: Lists all the firewall rules in the specified MySql server +```powershell +Get-AzMySqlFlexibleServerFirewallRule -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +FirewallRuleName StartIPAddress EndIPAddress +----------------- --------------- --------------- +firewallrule-test 12.12.12.12 23.23.23.23 +firewallrule-test2 12.12.12.15 23.23.23.25 +``` + +This cmdlet lists all the firewall rule in specified MySql server. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IFirewallRuleAutoGenerated + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerLocationBasedCapability.md b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerLocationBasedCapability.md new file mode 100644 index 0000000000..7b41d3515e --- /dev/null +++ b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerLocationBasedCapability.md @@ -0,0 +1,119 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/get-azmysqlflexibleserverlocationbasedcapability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServerLocationBasedCapability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServerLocationBasedCapability.md +--- + +# Get-AzMySqlFlexibleServerLocationBasedCapability + +## SYNOPSIS +Get the available SKU information for the location + +## SYNTAX + +``` +Get-AzMySqlFlexibleServerLocationBasedCapability -Location <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the available SKU information for the location + +## EXAMPLES + +### Example 1: Get location capabilities by location name +```powershell +Get-AzMySqlFlexibleServerLocationBasedCapability -Location westus2 +``` + +```output +"Please refer to https://aka.ms/mysql-pricing for pricing details" + +SKU Memory Tier vCore +--- ------ ---- ----- +Standard_B1s 1024 Burstable 1 +Standard_B1ms 2048 Burstable 1 +Standard_B2s 2048 Burstable 2 +Standard_D2ds_v4 4096 GeneralPurpose 2 +Standard_D4ds_v4 4096 GeneralPurpose 4 +Standard_D8ds_v4 4096 GeneralPurpose 8 +Standard_D16ds_v4 4096 GeneralPurpose 16 +Standard_D32ds_v4 4096 GeneralPurpose 32 +Standard_D48ds_v4 4096 GeneralPurpose 48 +Standard_D64ds_v4 4096 GeneralPurpose 64 +Standard_E2ds_v4 8192 MemoryOptimized 2 +Standard_E4ds_v4 8192 MemoryOptimized 4 +Standard_E8ds_v4 8192 MemoryOptimized 8 +Standard_E16ds_v4 8192 MemoryOptimized 16 +Standard_E32ds_v4 8192 MemoryOptimized 32 +Standard_E48ds_v4 8192 MemoryOptimized 48 +Standard_E64ds_v4 8192 MemoryOptimized 64 +``` + +This cmdlet shows basic sku information of the provided location. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The name of the location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.ICapabilityProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerReplica.md b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerReplica.md new file mode 100644 index 0000000000..174220f7e6 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Get-AzMySqlFlexibleServerReplica.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/get-azmysqlflexibleserverreplica +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServerReplica.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlFlexibleServerReplica.md +--- + +# Get-AzMySqlFlexibleServerReplica + +## SYNOPSIS +List all the replicas for a given server. + +## SYNTAX + +``` +Get-AzMySqlFlexibleServerReplica -ResourceGroupName <String> -ServerName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List all the replicas for a given server. + +## EXAMPLES + +### Example 1: Get MySql server replica by resource group and server name +```powershell +Get-AzMySqlFlexibleServerReplica -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test-replica West US 2 Standard_D2ds_v4 GeneralPurpose admin 5.7 32 +``` + +This cmdlet gets MySql server replica by resource group and server name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IServerAutoGenerated + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Get-AzMySqlReplica.md b/azps-10.1.0/Az.MySql/Get-AzMySqlReplica.md new file mode 100644 index 0000000000..73fd732101 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Get-AzMySqlReplica.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/get-azmysqlreplica +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlReplica.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlReplica.md +--- + +# Get-AzMySqlReplica + +## SYNOPSIS +List all the replicas for a given server. + +## SYNTAX + +``` +Get-AzMySqlReplica -ResourceGroupName <String> -ServerName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List all the replicas for a given server. + +## EXAMPLES + +### Example 1: Get MySql server replica by resource group and server name +```powershell +Get-AzMySqlReplica -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mysql-test-replica eastus mysql_test 5.7 10240 GP_Gen5_4 GeneralPurpose Disabled +``` + +This cmdlet gets MySql server replica by resource group and server name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IServer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Get-AzMySqlServer.md b/azps-10.1.0/Az.MySql/Get-AzMySqlServer.md new file mode 100644 index 0000000000..dee810bfb7 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Get-AzMySqlServer.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/get-azmysqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlServer.md +--- + +# Get-AzMySqlServer + +## SYNOPSIS +Gets information about a server. + +## SYNTAX + +### List1 (Default) +``` +Get-AzMySqlServer [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzMySqlServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMySqlServer -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzMySqlServer -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a server. + +## EXAMPLES + +### Example 1: Get MySql server with default context +```powershell +Get-AzMySqlServer +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mysql-test-11 eastus mysql_test 5.7 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This cmdlet gets MySql server with default context. + +### Example 2: Get MySql server by resource group and server name +```powershell +Get-AzMySqlServer -ResourceGroupName PowershellMySqlTest -Name mysql-test +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mysql-test eastus mysql_test 5.7 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This cmdlet gets MySql server by resource group and server name. + +### Example 3: Lists all the MySql servers in specified resource group +```powershell +Get-AzMySqlServer -ResourceGroupName PowershellMySqlTest +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- ------------ +mysql-test eastus mysql_test 5.7 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This cmdlet lists all the MySql servers in specified resource group. + +### Example 4: Get MySql server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/servers/mysql-test" +Get-AzMySqlServer -InputObject $ID +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- ------------ +mysql-test eastus mysql_test 5.7 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This cmdlet lists gets MySql server by identity. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IServer + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Get-AzMySqlVirtualNetworkRule.md b/azps-10.1.0/Az.MySql/Get-AzMySqlVirtualNetworkRule.md new file mode 100644 index 0000000000..50ffac1b2c --- /dev/null +++ b/azps-10.1.0/Az.MySql/Get-AzMySqlVirtualNetworkRule.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/get-azmysqlvirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Get-AzMySqlVirtualNetworkRule.md +--- + +# Get-AzMySqlVirtualNetworkRule + +## SYNOPSIS +Gets a virtual network rule. + +## SYNTAX + +### List (Default) +``` +Get-AzMySqlVirtualNetworkRule -ResourceGroupName <String> -ServerName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### Get +``` +Get-AzMySqlVirtualNetworkRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzMySqlVirtualNetworkRule -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a virtual network rule. + +## EXAMPLES + +### Example 1: Lists all the Virtual Network Rules in specified MySql server +```powershell +Get-AzMySqlVirtualNetworkRule -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +Name Type +---- ---- +vnet Microsoft.DBforMySQL/servers/virtualNetworkRules +``` + +This cmdlet lists all the Virtual Network Rules in specified MySql server. + +### Example 2: Get Virtual Network Rule by name +```powershell +Get-AzMySqlVirtualNetworkRule -Name vnet -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +```output +Name Type +---- ---- +vnet Microsoft.DBforMySQL/servers/virtualNetworkRules +``` + +This cmdlet gets Virtual Network Rule by name. + +### Example 3: Get Virtual Network Rule by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/servers/mysql-test/virtualNetworkRules/vnet" +Get-AzMySqlVirtualNetworkRule -InputObject $ID +``` + +```output +Name Type +---- ---- +vnet Microsoft.DBforMySQL/servers/virtualNetworkRules +``` + +This cmdlet gets Virtual Network Rule by identity. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: VirtualNetworkRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IVirtualNetworkRule + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/New-AzMySqlFirewallRule.md b/azps-10.1.0/Az.MySql/New-AzMySqlFirewallRule.md new file mode 100644 index 0000000000..7475abc04d --- /dev/null +++ b/azps-10.1.0/Az.MySql/New-AzMySqlFirewallRule.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/new-azmysqlfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlFirewallRule.md +--- + +# New-AzMySqlFirewallRule + +## SYNOPSIS +Creates a new firewall rule or updates an existing firewall rule. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzMySqlFirewallRule -ResourceGroupName <String> -ServerName <String> -EndIPAddress <String> + -StartIPAddress <String> [-Name <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### AllowAll +``` +New-AzMySqlFirewallRule -ResourceGroupName <String> -ServerName <String> -AllowAll [-Name <String>] + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### ClientIPAddress +``` +New-AzMySqlFirewallRule -ResourceGroupName <String> -ServerName <String> -ClientIPAddress <String> + [-Name <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new firewall rule or updates an existing firewall rule. + +## EXAMPLES + +### Example 1: Create a new MySql server Firewall Rule +```powershell +New-AzMySqlFirewallRule -Name rule -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -EndIPAddress 0.0.0.1 -StartIPAddress 0.0.0.0 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.0 0.0.0.1 +``` + +This cmdlets create a MySql server Firewall Rule. + +### Example 2: Create a new MySql Firewall Rule using -ClientIPAddress. +```powershell +New-AzMySqlFirewallRule -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -ClientIPAddress 0.0.0.1 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +ClientIPAddress_2020-08-11_18-19-27 0.0.0.1 0.0.0.1 +``` + +This cmdlets create a MySql Firewall Rule using -ClientIPAddress. + +### Example 3: Create a new MySql Firewall Rule to allow all IPs +```powershell +New-AzMySqlFirewallRule -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -AllowAll +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +AllowAll_2020-08-11_18-19-27 0.0.0.0 255.255.255.255 +``` + +This cmdlets create a new MySql Firewall Rule to allow all IPs. + +## PARAMETERS + +### -AllowAll +Present to allow all range IPs, from 0.0.0.0 to 255.255.255.255. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AllowAll +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientIPAddress +Client specified single IP of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIPAddress +The end IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. +If not specified, the default is undefined. +If AllowAll is present, the default name is AllowAll_yyyy-MM-dd_HH-mm-ss. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FirewallRuleName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +The start IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IFirewallRule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/New-AzMySqlFlexibleServer.md b/azps-10.1.0/Az.MySql/New-AzMySqlFlexibleServer.md new file mode 100644 index 0000000000..9270213049 --- /dev/null +++ b/azps-10.1.0/Az.MySql/New-AzMySqlFlexibleServer.md @@ -0,0 +1,637 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/new-azmysqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlFlexibleServer.md +--- + +# New-AzMySqlFlexibleServer + +## SYNOPSIS +Creates a new MySQL flexible server. + +## SYNTAX + +``` +New-AzMySqlFlexibleServer [-Name <String>] [-ResourceGroupName <String>] [-SubscriptionId <String>] + [-AdministratorLoginPassword <SecureString>] [-AdministratorUserName <String>] [-BackupRetentionDay <Int32>] + [-HighAvailability <String>] [-Iops <Int32>] [-Location <String>] [-PrivateDnsZone <String>] + [-PublicAccess <String>] [-Sku <String>] [-SkuTier <String>] [-StorageAutogrow <StorageAutogrow>] + [-StorageInMb <Int32>] [-Subnet <String>] [-SubnetPrefix <String>] [-Tag <Hashtable>] + [-Version <ServerVersion>] [-Vnet <String>] [-VnetPrefix <String>] [-Zone <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new MySQL flexible server. + +## EXAMPLES + +### Example 1: Create a new MySql flexible server with arguments +```powershell +New-AzMySqlFlexibleServer -Name mysql-test -ResourceGroupName PowershellMySqlTest -Location eastus -AdministratorUserName mysqltest -AdministratorLoginPassword $password -Sku Standard_D2ds_v4 -SkuTier Burstable -Version 12 -StorageInMb 20480 -PublicAccess none -Zone 1 -BackupRetentionDay 10 -StorageAutogrow Enabled -Iops 500 -HighAvailability ZoneRedundant +``` + +```output +Checking the existence of the resource group PowershellMySqlTest ... +Resource group PowershellMySqlTest exists ? : True +Creating MySQL server mysql-test in group MySqlTest... +Your server mysql-test is using sku Standard_B1ms (Paid Tier). Please refer to https://aka.ms/mysql-pricing for pricing details + +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test East US Standard_D2ds_v4 GeneralPurpose admin 5.7 20 + +``` + + + +### Example 2: Create a new MySql flexible server with default setting +```powershell +New-AzMySqlFlexibleServer +``` + +```output +Creating resource group group00000000... +Creating new vnet VNETserver00000000 in resource group group00000000 +Creating new subnet Subnetserver00000000 in resource group group00000000 and delegating it to Microsoft.DBforMySQL/flexibleServers +Creating MySQL server server00000000 in group group00000000... +Your server mysql-test is using sku Standard_B1ms (Paid Tier). Please refer to https://aka.ms/mysql-pricing for pricing details +Creating database flexibleserverdb... + +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test West US 2 Standard_B1ms Burstable admin 5.7 32 +``` + +This cmdlet creates MySql flexible server with default parameter values and provision the server inside a new virtual network and have a subnet delegated to the server. +The default values of location is West US 2, Sku is Standard_B1ms, Sku tier is Burstable, and storage size is 10GiB. + + +If you want to find the auto-generated password for your server, use ConvertFrom-SecureString to convert 'SecuredPassword' property to plain text. + +(E.g., $server.SecuredPassword | ConvertFrom-SecureString -AsPlainText) + +### Example 3: Create a new MySql flexible server with existing Subnet +```powershell +$Subnet = '/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnetname' +$DnsZone = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/postgresqltest/providers/Microsoft.Network/privateDnsZones/testserver.private.mysql.database.azure.com' +New-AzMySqlFlexibleServer -ResourceGroupName postgresqltest -ServerName testserver -Subnet $Subnet -PrivateDnsZone $DnsZone +``` + +```output +Resource group PowershellPostgreSqlTest exists ? : True +You have supplied a subnet Id. Verifying its existence... +Creating PostgreSQL server testserver in group PowershellPostgreSqlTest... +Your server server00000000 is using sku Standard_B1ms (Paid Tier). Please refer to https://aka.ms/postgresql-pricing for pricing details +Creating database flexibleserverdb... + +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test West US 2 Standard_B1ms Burstable admin 5.7 32 + +``` + +This cmdlet creates PostgreSql flexible server with an existing Subnet Id provided by a user. +The subnet will be delegated to PostgreSQL flexible server if not already delegated. +You cannot use a subnet delegated to different services. + +### Example 4: Create a new MySql flexible server with virtual network and subnet name +```powershell +$DnsZone = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/postgresqltest/providers/Microsoft.Network/privateDnsZones/testserver.private.mysql.database.azure.com' +New-AzMySqlFlexibleServer -Name mysql-test -ResourceGroupName PowershellMySqlTest -Vnet mysql-vnet -Subnet mysql-subnet -VnetPrefix 10.0.0.0/16 -SubnetPrefix 10.0.0.0/24 -PrivateDnsZone $DnsZone +``` + +```output +Resource group PowershellMySqlTest exists ? : True +Creating new vnet mysql-vnet in resource group PowershellMySqlTest +Creating new subnet mysql-subnet in resource group PowershellMySqlTest and delegating it to Microsoft.DBforMySQL/flexibleServers +Creating MySQL server mysql-test in group PowershellMySqlTest... +Your server mysql-test is using sku Standard_B1ms (Paid Tier). Please refer to https://aka.ms/mysql-pricing for pricing details +Creating database flexibleserverdb... + +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test West US 2 Standard_B1ms Burstable admin 5.7 32 + +``` + +This cmdlet creates MySql flexible server with vnet name, subnet name, vnet prefix, and subnet prefix. +If the virtual network and subnet don't exist, the cmdlet creates one. + +### Example 5: Create a new MySql flexible server with virtual network +```powershell +$Vnet = 'vnetname' +$DnsZone = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/postgresqltest/providers/Microsoft.Network/privateDnsZones/testserver.private.mysql.database.azure.com' +New-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -Vnet $Vnet -PrivateDnsZone $DnsZone + +# or + +$Vnet = '/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/PowershellMySqlTest/providers/Microsoft.Network/virtualNetworks/vnetname' +New-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -Vnet $Vnet -PrivateDnsZone $DnsZone +``` + +```output +Resource group PowershellMySqlTest exists ? : True +You have supplied a vnet Id/name. Verifying its existence... +Creating new vnet vnetname in resource group PowershellMySqlTest +Creating new subnet Subnetserver00000000 in resource group PowershellMySqlTest and delegating it to Microsoft.DBforMySQL/flexibleServers +Creating MySQL server server00000000 in group PowershellMySqlTest... +Your server server00000000 is using sku Standard_B1ms (Paid Tier). Please refer to https://aka.ms/mysql-pricing for pricing details +Creating database flexibleserverdb... + +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test West US 2 Standard_B1ms Burstable admin 5.7 32 + +``` + +This cmdlet creates MySql flexible server with vnet id or vnet name provided by a user. +If the virtual network doesn't exist, the cmdlet creates one. + +### Example 6: Create a new MySql flexible server with public access to all IPs +```powershell +New-AzMySqlFlexibleServer -Name mysql-test -ResourceGroupName PowershellMySqlTest -PublicAccess All +``` + +```output +Resource group PowershellMySqlTest exists ? : True +Creating MySQL server mysql-test in group PowershellMySqlTest... +Your server mysql-test is using sku Standard_B1ms (Paid Tier). Please refer to https://aka.ms/mysql-pricing for pricing details +Creating database flexibleserverdb... +Configuring server firewall rule to accept connections from 0.0.0.0 to 255.255.255.255 + +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test West US 2 Standard_B1ms Burstable admin 5.7 32 +``` + +This cmdlet creates MySql flexible server open to all IP addresses. + +### Example 7: Create a new MySql flexible server with firewall +```powershell +New-AzMySqlFlexibleServer -Name mysql-test -ResourceGroupName PowershellMySqlTest -PublicAccess 10.10.10.10-10.10.10.12 +``` + +```output +Resource group PowershellMySqlTest exists ? : True +Creating MySQL server mysql-test in group PowershellMySqlTest... +Your server mysql-test is using sku Standard_B1ms (Paid Tier). Please refer to https://aka.ms/mysql-pricing for pricing details +Creating database flexibleserverdb... +Configuring server firewall rule to accept connections from 10.10.10.10 to 10.10.10.12 + +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test West US 2 Standard_B1ms Burstable admin 5.7 32 + +``` + +This cmdlet creates MySql flexible server open to specified IP addresses. + +## PARAMETERS + +### -AdministratorLoginPassword +The password of the administrator. +Minimum 8 characters and maximum 128 characters. +Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorUserName +Administrator username for the server. +Once set, it cannot be changed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. +Day count is between 1 and 35. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailability +Enable or disable high availability feature. +Allowed values are 'ZoneRedundant', 'SameZone', and 'Disabled'. +Default value is Disabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HaEnabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Iops +Number of IOPS to be allocated for this server. +You will get certain amount of free IOPS based on compute and storage provisioned. +The default value for IOPS is free IOPS. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location the resource resides in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServerName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateDnsZone +The id of an existing private dns zone. +The suffix of dns zone has to be same as that of fully qualified domain of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicAccess +Determines the public access. +Allowed values: All, None, IP address range (e.g., 1.1.1.1-1.1.1.5, 1.1.1.1) Specifying 0.0.0.0 allows public access from any resources deployed within Azure to access your server. +Specifying no IP address sets the server in public access mode but does not create a firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +Standard_B1ms, Standard_D2ds_v4. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +Compute tier of the server. +Accepted values: Burstable, GeneralPurpose, Memory Optimized. +Default: Burstable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAutogrow +Enable or disable Storage Auto Grow. +The default value is Disabled + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.StorageAutogrow +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageInMb +Max storage allowed for a server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +The Name or Id of an existing Subnet or name of a new one to create. +Use resource ID if you want to use a subnet from different resource group. +Please note that the subnet will be delegated to Microsoft.DBforMySQL/flexibleServers. +After delegation, this subnet cannot be used for any other type of Azure resources. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetPrefix +The subnet IP address prefix to use when creating a new vnet in CIDR format. +Default value is 10.0.0.0/24. + +```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 subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Server version. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.ServerVersion +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vnet +The Name or Id of an existing virtual network or name of a new one to create. +The name must be between 2 to 64 characters. +The name must begin with a letter or number, end with a letter, number or underscore, and may contain only letters, numbers, underscores, periods, or hyphens. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetPrefix +The IP address prefix to use when creating a new vnet in CIDR format. +Default value is 10.0.0.0/16. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +Availability zone into which to provision the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IServerAutoGenerated + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/New-AzMySqlFlexibleServerDatabase.md b/azps-10.1.0/Az.MySql/New-AzMySqlFlexibleServerDatabase.md new file mode 100644 index 0000000000..968bb14da3 --- /dev/null +++ b/azps-10.1.0/Az.MySql/New-AzMySqlFlexibleServerDatabase.md @@ -0,0 +1,268 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/new-azmysqlflexibleserverdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlFlexibleServerDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlFlexibleServerDatabase.md +--- + +# New-AzMySqlFlexibleServerDatabase + +## SYNOPSIS +Creates a new database or updates an existing database. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzMySqlFlexibleServerDatabase -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-Charset <String>] [-Collation <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzMySqlFlexibleServerDatabase -InputObject <IMySqlIdentity> [-Charset <String>] [-Collation <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new database or updates an existing database. + +## EXAMPLES + +### Example 1: Create a new MySql server database +```powershell +New-AzMySqlFlexibleServerDatabase -Name databasetest -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -Charset latin1 -Collation latin1_swedish_ci +``` + +```output +Name Charset Collation +---- -------- ------------------ +databasetest latin1 latin1_swedish_ci +``` + +Create a database with default settings. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Charset +The charset of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Collation +The collation of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the database. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: DatabaseName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IDatabaseAutoGenerated + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/New-AzMySqlFlexibleServerFirewallRule.md b/azps-10.1.0/Az.MySql/New-AzMySqlFlexibleServerFirewallRule.md new file mode 100644 index 0000000000..e0f1d0617e --- /dev/null +++ b/azps-10.1.0/Az.MySql/New-AzMySqlFlexibleServerFirewallRule.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/new-azmysqlflexibleserverfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlFlexibleServerFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlFlexibleServerFirewallRule.md +--- + +# New-AzMySqlFlexibleServerFirewallRule + +## SYNOPSIS +Creates a new firewall rule for MySQL flexible server + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzMySqlFlexibleServerFirewallRule -ResourceGroupName <String> -ServerName <String> -EndIPAddress <String> + -StartIPAddress <String> [-Name <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### AllowAll +``` +New-AzMySqlFlexibleServerFirewallRule -ResourceGroupName <String> -ServerName <String> -AllowAll + [-Name <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### ClientIPAddress +``` +New-AzMySqlFlexibleServerFirewallRule -ResourceGroupName <String> -ServerName <String> + -ClientIPAddress <String> [-Name <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new firewall rule for MySQL flexible server + +## EXAMPLES + +### Example 1: Create a new MySql server Firewall Rule +```powershell +New-AzMySqlFlexibleServerFirewallRule -Name firewallrule-test -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -EndIPAddress 0.0.0.1 -StartIPAddress 0.0.0.0 +``` + +```output +Name StartIPAddress EndIPAddress +----------------- -------------- ------------ +firewallrule-test 0.0.0.0 0.0.0.1 +``` + +This cmdlets create a MySql server Firewall Rule. + +### Example 2: Create a new MySql Firewall Rule using -ClientIPAddress. +```powershell +New-AzMySqlFlexibleServerFirewallRule -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -ClientIPAddress 0.0.0.1 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +ClientIPAddress_2020-08-11_18-19-27 0.0.0.1 0.0.0.1 +``` + +This cmdlets create a MySql Firewall Rule using -ClientIPAddress. + +### Example 3: Create a new MySql Firewall Rule to allow all IPs +```powershell +New-AzMySqlFlexibleServerFirewallRule -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -AllowAll +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +AllowAll_2020-08-11_18-19-27 0.0.0.0 255.255.255.255 +``` + +This cmdlets create a new MySql Firewall Rule to allow all IPs. + +## PARAMETERS + +### -AllowAll +Present to allow all range IPs, from 0.0.0.0 to 255.255.255.255. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AllowAll +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientIPAddress +Client specified single IP of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIPAddress +The end IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. +If not specified, the default is undefined. +If AllowAll is present, the default name is AllowAll_yyyy-MM-dd_HH-mm-ss. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FirewallRuleName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +The start IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IFirewallRule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/New-AzMySqlFlexibleServerReplica.md b/azps-10.1.0/Az.MySql/New-AzMySqlFlexibleServerReplica.md new file mode 100644 index 0000000000..4bc5dbfe02 --- /dev/null +++ b/azps-10.1.0/Az.MySql/New-AzMySqlFlexibleServerReplica.md @@ -0,0 +1,264 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/new-azmysqlflexibleserverreplica +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlFlexibleServerReplica.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlFlexibleServerReplica.md +--- + +# New-AzMySqlFlexibleServerReplica + +## SYNOPSIS +Creates a replica server for a MySQL flexible server + +## SYNTAX + +``` +New-AzMySqlFlexibleServerReplica -Replica <String> -ResourceGroupName <String> -Master <IServerAutoGenerated> + [-SubscriptionId <String>] [-Zone <Int32>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new replica from an existing database. + +## EXAMPLES + +### Example 1: Create a new MySql server replica +```powershell +Get-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test | New-AzMySqlFlexibleServerReplica -Replica mysql-test-replica -ResourceGroupName PowershellMySqlTest +``` + +```output +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test-replica West US 2 Standard_D2ds_v4 GeneralPurpose admin 5.7 32 +``` + +This cmdlet creates a new MySql server replica. + +### Example 2: Create a new MySql server replica +```powershell +$mysql = Get-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +New-AzMySqlFlexibleServerReplica -Master $mysql -Replica mysql-test-replica -ResourceGroupName PowershellMySqlTest +``` + +```output +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test-replica West US 2 Standard_D2ds_v4 GeneralPurpose admin 5.7 32 +``` + +This cmdlet with parameter master(inputobject) creates a new MySql server replica. + +## PARAMETERS + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Master +The source server object to create replica from. +To construct, see NOTES section for MASTER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IServerAutoGenerated +Parameter Sets: (All) +Aliases: InputObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Replica +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ReplicaServerName, Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +Availability zone into which to provision the replica resource. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IServerAutoGenerated + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IServerAutoGenerated + +## 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. + + +`MASTER <IServerAutoGenerated>`: The source server object to create replica from. + - `Location <String>`: The geo-location where the resource lives + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdministratorLogin <String>]`: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). + - `[AdministratorLoginPassword <SecureString>]`: The password of the administrator login (required for server creation). + - `[AvailabilityZone <String>]`: availability Zone information of the server. + - `[BackupGeoRedundantBackup <EnableStatusEnum?>]`: Whether or not geo redundant backup is enabled. + - `[BackupRetentionDay <Int32?>]`: Backup retention days for the server. + - `[CreateMode <CreateMode?>]`: The mode to create a new MySQL server. + - `[HighAvailabilityMode <HighAvailabilityMode?>]`: High availability mode for a server. + - `[HighAvailabilityStandbyAvailabilityZone <String>]`: Availability zone of the standby server. + - `[MaintenanceWindowCustomWindow <String>]`: indicates whether custom window is enabled or disabled + - `[MaintenanceWindowDayOfWeek <Int32?>]`: day of week for maintenance window + - `[MaintenanceWindowStartHour <Int32?>]`: start hour for maintenance window + - `[MaintenanceWindowStartMinute <Int32?>]`: start minute for maintenance window + - `[NetworkDelegatedSubnetResourceId <String>]`: Delegated subnet resource id used to setup vnet for a server. + - `[NetworkPrivateDnsZoneResourceId <String>]`: Private DNS zone resource id. + - `[ReplicationRole <ReplicationRole?>]`: The replication role. + - `[RestorePointInTime <DateTime?>]`: Restore point creation time (ISO8601 format), specifying the time to restore from. + - `[SkuName <String>]`: The name of the sku, e.g. Standard_D32s_v3. + - `[SkuTier <SkuTier?>]`: The tier of the particular SKU, e.g. GeneralPurpose. + - `[SourceServerResourceId <String>]`: The source MySQL server id. + - `[StorageAutoGrow <EnableStatusEnum?>]`: Enable Storage Auto Grow or not. + - `[StorageIop <Int32?>]`: Storage IOPS for a server. + - `[StorageSizeGb <Int32?>]`: Max storage size allowed for a server. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Version <ServerVersion?>]`: Server version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/New-AzMySqlReplica.md b/azps-10.1.0/Az.MySql/New-AzMySqlReplica.md new file mode 100644 index 0000000000..a04769f330 --- /dev/null +++ b/azps-10.1.0/Az.MySql/New-AzMySqlReplica.md @@ -0,0 +1,273 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/new-azmysqlreplica +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlReplica.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlReplica.md +--- + +# New-AzMySqlReplica + +## SYNOPSIS +Creates a new replica from an existing database. + +## SYNTAX + +``` +New-AzMySqlReplica -Replica <String> -ResourceGroupName <String> -Master <IServer> [-SubscriptionId <String>] + [-Location <String>] [-Sku <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new replica from an existing database. + +## EXAMPLES + +### Example 1: Create a new MySql server replica +```powershell +Get-AzMySqlServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test | New-AzMySqlReplica -Replica mysql-test-replica -ResourceGroupName PowershellMySqlTest +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mysql-test-replica eastus mysql_test 5.7 10240 GP_Gen5_4 GeneralPurpose Disabled +``` + +This cmdlet creates a new MySql server replica. + +### Example 2: Create a new MySql server replica +```powershell +$mysql = Get-AzMySqlServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +New-AzMySqlReplica -Master $mysql -Replica mysql-test-replica -ResourceGroupName PowershellMySqlTest +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mysql-test-replica eastus mysql_test 5.7 10240 GP_Gen5_4 GeneralPurpose Disabled +``` + +This cmdlet with parameter master(inputobject) creates a new MySql server replica. + +## PARAMETERS + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location the resource resides in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Master +The source server object to create replica from. +To construct, see NOTES section for MASTER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IServer +Parameter Sets: (All) +Aliases: InputObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Replica +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ReplicaServerName, Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +B_Gen4_1, GP_Gen5_8. + +```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 subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IServer + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IServer + +## 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. + + +`MASTER <IServer>`: The source server object to create replica from. + - `Location <String>`: The geo-location where the resource lives + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdministratorLogin <String>]`: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). + - `[EarliestRestoreDate <DateTime?>]`: Earliest restore point creation time (ISO8601 format) + - `[FullyQualifiedDomainName <String>]`: The fully qualified domain name of a server. + - `[IdentityType <IdentityType?>]`: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + - `[InfrastructureEncryption <InfrastructureEncryption?>]`: Status showing whether the server enabled infrastructure encryption. + - `[MasterServerId <String>]`: The master server id of a replica server. + - `[MinimalTlsVersion <MinimalTlsVersionEnum?>]`: Enforce a minimal Tls version for the server. + - `[PublicNetworkAccess <PublicNetworkAccessEnum?>]`: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' + - `[ReplicaCapacity <Int32?>]`: The maximum number of replicas that a master server can have. + - `[ReplicationRole <String>]`: The replication role of the server. + - `[SkuCapacity <Int32?>]`: The scale up/out capacity, representing server's compute units. + - `[SkuFamily <String>]`: The family of hardware. + - `[SkuName <String>]`: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. + - `[SkuSize <String>]`: The size code, to be interpreted by resource as appropriate. + - `[SkuTier <SkuTier?>]`: The tier of the particular SKU, e.g. Basic. + - `[SslEnforcement <SslEnforcementEnum?>]`: Enable ssl enforcement or not when connect to server. + - `[StorageProfileBackupRetentionDay <Int32?>]`: Backup retention days for the server. + - `[StorageProfileGeoRedundantBackup <GeoRedundantBackup?>]`: Enable Geo-redundant or not for server backup. + - `[StorageProfileStorageAutogrow <StorageAutogrow?>]`: Enable Storage Auto Grow. + - `[StorageProfileStorageMb <Int32?>]`: Max storage allowed for a server. + - `[UserVisibleState <ServerState?>]`: A state of a server that is visible to user. + - `[Version <ServerVersion?>]`: Server version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/New-AzMySqlServer.md b/azps-10.1.0/Az.MySql/New-AzMySqlServer.md new file mode 100644 index 0000000000..e9f76cf1e8 --- /dev/null +++ b/azps-10.1.0/Az.MySql/New-AzMySqlServer.md @@ -0,0 +1,367 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/new-azmysqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlServer.md +--- + +# New-AzMySqlServer + +## SYNOPSIS +Creates a new server. + +## SYNTAX + +``` +New-AzMySqlServer -Name <String> -ResourceGroupName <String> -AdministratorLoginPassword <SecureString> + -AdministratorUserName <String> -Location <String> -Sku <String> [-SubscriptionId <String>] + [-BackupRetentionDay <Int32>] [-GeoRedundantBackup <GeoRedundantBackup>] + [-MinimalTlsVersion <MinimalTlsVersionEnum>] [-SslEnforcement <SslEnforcementEnum>] + [-StorageAutogrow <StorageAutogrow>] [-StorageInMb <Int32>] [-Tag <Hashtable>] [-Version <ServerVersion>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new server. + +## EXAMPLES + +### Example 1: Create a new MySql server +```powershell +New-AzMySqlServer -Name mysql-test -ResourceGroupName PowershellMySqlTest -Location eastus -AdministratorUserName mysql_test -AdministratorLoginPassword $password -Sku GP_Gen5_4 +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- ------------ +mysql-test eastus mysql_test 5.7 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +These cmdlets create a new MySql server. + +## PARAMETERS + +### -AdministratorLoginPassword +The password of the administrator. +Minimum 8 characters and maximum 128 characters. +Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorUserName +Administrator username for the server. +Once set, it cannot be changed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. +Day count is between 7 and 35. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeoRedundantBackup +Enable Geo-redundant or not for server backup. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.GeoRedundantBackup +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location the resource resides in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimalTlsVersion +Set the minimal TLS version for connections to server when SSL is enabled. +Default is TLSEnforcementDisabled.accepted values: TLS1_0, TLS1_1, TLS1_2, TLSEnforcementDisabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.MinimalTlsVersionEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +B_Gen4_1, GP_Gen5_8. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslEnforcement +Enable ssl enforcement or not when connect to server. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.SslEnforcementEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAutogrow +Enable Storage Auto Grow. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.StorageAutogrow +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageInMb +Max storage allowed for a server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Server version. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.ServerVersion +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IServer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/New-AzMySqlVirtualNetworkRule.md b/azps-10.1.0/Az.MySql/New-AzMySqlVirtualNetworkRule.md new file mode 100644 index 0000000000..eab80a1b8d --- /dev/null +++ b/azps-10.1.0/Az.MySql/New-AzMySqlVirtualNetworkRule.md @@ -0,0 +1,241 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/new-azmysqlvirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/New-AzMySqlVirtualNetworkRule.md +--- + +# New-AzMySqlVirtualNetworkRule + +## SYNOPSIS +Creates or updates an existing virtual network rule. + +## SYNTAX + +``` +New-AzMySqlVirtualNetworkRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -SubnetId <String> [-SubscriptionId <String>] [-IgnoreMissingVnetServiceEndpoint] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an existing virtual network rule. + +## EXAMPLES + +### Example 1: Create a new MySql server Virtual Network Rule +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.Network/virtualNetworks/MySqlVNet/subnets/MysqlSubnet1" +New-AzMySqlVirtualNetworkRule -Name vnet -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -SubnetId $ID +``` + +```output +Name Type +---- ---- +vnet Microsoft.DBforMySQL/servers/virtualNetworkRules +``` + +These cmdlets create a MySql server Virtual Network Rule. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreMissingVnetServiceEndpoint +Create firewall rule before the virtual network has vnet service endpoint enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VirtualNetworkRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The ARM resource id of the virtual network subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IVirtualNetworkRule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Remove-AzMySqlFirewallRule.md b/azps-10.1.0/Az.MySql/Remove-AzMySqlFirewallRule.md new file mode 100644 index 0000000000..3e2965916f --- /dev/null +++ b/azps-10.1.0/Az.MySql/Remove-AzMySqlFirewallRule.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/remove-azmysqlfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Remove-AzMySqlFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Remove-AzMySqlFirewallRule.md +--- + +# Remove-AzMySqlFirewallRule + +## SYNOPSIS +Deletes a server firewall rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMySqlFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMySqlFirewallRule -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a server firewall rule. + +## EXAMPLES + +### Example 1: Remove MySql Firewall Rule by name +```powershell +Remove-AzMySqlFirewallRule -Name rule -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +This cmdlet removes MySql Firewall Rule by name. + +### Example 2: Remove MySql Firewall Rule by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/servers/mysql-test/firewallRules/rule" +Remove-AzMySqlFirewallRule -InputObject $ID +``` + +These cmdlets remove MySql Firewall Rule by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Remove-AzMySqlFlexibleServer.md b/azps-10.1.0/Az.MySql/Remove-AzMySqlFlexibleServer.md new file mode 100644 index 0000000000..d45e8a363c --- /dev/null +++ b/azps-10.1.0/Az.MySql/Remove-AzMySqlFlexibleServer.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/remove-azmysqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Remove-AzMySqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Remove-AzMySqlFlexibleServer.md +--- + +# Remove-AzMySqlFlexibleServer + +## SYNOPSIS +Deletes a server. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMySqlFlexibleServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMySqlFlexibleServer -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a server. + +## EXAMPLES + +### Example 1: Remove MySql server by resourceGroup and server name +```powershell +Remove-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -Name mysql-test +``` + +This cmdlet removes MySql server by resourceGroup and server name. + +### Example 2: Remove MySql server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/flexibleServers/mysql-test" +Remove-AzMySqlFlexibleServer -InputObject $ID +``` + +These cmdlets remove MySql server by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Remove-AzMySqlFlexibleServerDatabase.md b/azps-10.1.0/Az.MySql/Remove-AzMySqlFlexibleServerDatabase.md new file mode 100644 index 0000000000..decb67605f --- /dev/null +++ b/azps-10.1.0/Az.MySql/Remove-AzMySqlFlexibleServerDatabase.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/remove-azmysqlflexibleserverdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Remove-AzMySqlFlexibleServerDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Remove-AzMySqlFlexibleServerDatabase.md +--- + +# Remove-AzMySqlFlexibleServerDatabase + +## SYNOPSIS +Deletes a database. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMySqlFlexibleServerDatabase -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMySqlFlexibleServerDatabase -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a database. + +## EXAMPLES + +### Example 1: Remove MySql database by name +```powershell +Remove-AzMySqlFlexibleServerDatabase -Name databasetest -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +This cmdlet removes MySql database by name. + +### Example 2: Remove MySql database by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/flexibleServers/mysql-test/databases/databasetest" +Remove-AzMySqlFlexibleServerDatabase -InputObject $ID +``` + +These cmdlets remove MySql database by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the database. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DatabaseName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Remove-AzMySqlFlexibleServerFirewallRule.md b/azps-10.1.0/Az.MySql/Remove-AzMySqlFlexibleServerFirewallRule.md new file mode 100644 index 0000000000..19f15e0251 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Remove-AzMySqlFlexibleServerFirewallRule.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/remove-azmysqlflexibleserverfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Remove-AzMySqlFlexibleServerFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Remove-AzMySqlFlexibleServerFirewallRule.md +--- + +# Remove-AzMySqlFlexibleServerFirewallRule + +## SYNOPSIS +Deletes a firewall rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMySqlFlexibleServerFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMySqlFlexibleServerFirewallRule -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a firewall rule. + +## EXAMPLES + +### Example 1: Remove MySql Firewall Rule by name +```powershell +Remove-AzMySqlFlexibleServerFirewallRule -Name firewall-rule-test -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +This cmdlet removes MySql Firewall Rule by name. + +### Example 2: Remove MySql Firewall Rule by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/flexibleServers/mysql-test/firewallRules/firewall-rule-test" +Remove-AzMySqlFlexibleServerFirewallRule -InputObject $ID +``` + +These cmdlets remove MySql Firewall Rule by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Remove-AzMySqlServer.md b/azps-10.1.0/Az.MySql/Remove-AzMySqlServer.md new file mode 100644 index 0000000000..83c1f63af4 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Remove-AzMySqlServer.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/remove-azmysqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Remove-AzMySqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Remove-AzMySqlServer.md +--- + +# Remove-AzMySqlServer + +## SYNOPSIS +Deletes a server. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMySqlServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMySqlServer -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a server. + +## EXAMPLES + +### Example 1: Remove MySql server by resourceGroup and server name +```powershell +Remove-AzMySqlServer -ResourceGroupName PowershellMySqlTest -Name mysql-test +``` + +This cmdlet removes MySql server by resourceGroup and server name. + +### Example 2: Remove MySql server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/servers/mysql-test" +Remove-AzMySqlServer -InputObject $ID +``` + +These cmdlets remove MySql server by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Remove-AzMySqlVirtualNetworkRule.md b/azps-10.1.0/Az.MySql/Remove-AzMySqlVirtualNetworkRule.md new file mode 100644 index 0000000000..8665da815a --- /dev/null +++ b/azps-10.1.0/Az.MySql/Remove-AzMySqlVirtualNetworkRule.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/remove-azmysqlvirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Remove-AzMySqlVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Remove-AzMySqlVirtualNetworkRule.md +--- + +# Remove-AzMySqlVirtualNetworkRule + +## SYNOPSIS +Deletes the virtual network rule with the given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMySqlVirtualNetworkRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzMySqlVirtualNetworkRule -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the virtual network rule with the given name. + +## EXAMPLES + +### Example 1: Remove MySql server Virtual Network Rule by name +```powershell +Remove-AzMySqlVirtualNetworkRule -Name vnet -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +This cmdlet removes MySql server Virtual Network Rule by name. + +### Example 2: Remove MySql server Virtual Network Rule by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/servers/mysql-test/virtualNetworkRules/vnet" +Remove-AzMySqlVirtualNetworkRule -InputObject $ID +``` + +These cmdlets remove MySql server Virtual Network Rule by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: VirtualNetworkRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Restart-AzMySqlFlexibleServer.md b/azps-10.1.0/Az.MySql/Restart-AzMySqlFlexibleServer.md new file mode 100644 index 0000000000..70cf1d4fb8 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Restart-AzMySqlFlexibleServer.md @@ -0,0 +1,313 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/restart-azmysqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Restart-AzMySqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Restart-AzMySqlFlexibleServer.md +--- + +# Restart-AzMySqlFlexibleServer + +## SYNOPSIS +Restarts a server. + +## SYNTAX + +### RestartExpanded (Default) +``` +Restart-AzMySqlFlexibleServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-MaxFailoverSecond <Int32>] [-RestartWithFailover <EnableStatusEnum>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Restart +``` +Restart-AzMySqlFlexibleServer -Name <String> -ResourceGroupName <String> -Parameter <IServerRestartParameter> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### RestartViaIdentity +``` +Restart-AzMySqlFlexibleServer -InputObject <IMySqlIdentity> -Parameter <IServerRestartParameter> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RestartViaIdentityExpanded +``` +Restart-AzMySqlFlexibleServer -InputObject <IMySqlIdentity> [-MaxFailoverSecond <Int32>] + [-RestartWithFailover <EnableStatusEnum>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Restarts a server. + +## EXAMPLES + +### Example 1: Restart the server by resource name +```powershell +Restart-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -Name mysql-test +``` + +Restart the server by name + +### Example 2: Restart the server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/flexibleServers/mysql-test/restart" +Restart-AzMySqlFlexibleServer -InputObject $ID +``` + +Restart the server by identity + +### Example 2: Restart the server with failover +```powershell +Restart-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -Name mysql-test -RestartWithFailover Enabled +``` + +Restart the server with failover + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: RestartViaIdentity, RestartViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaxFailoverSecond +The maximum allowed failover time in seconds. + +```yaml +Type: System.Int32 +Parameter Sets: RestartExpanded, RestartViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Restart, RestartExpanded +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Server restart parameters. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IServerRestartParameter +Parameter Sets: Restart, RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Restart, RestartExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestartWithFailover +Whether or not failover to standby server when restarting a server with high availability enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.EnableStatusEnum +Parameter Sets: RestartExpanded, RestartViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Restart, RestartExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IServerRestartParameter + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +`PARAMETER <IServerRestartParameter>`: Server restart parameters. + - `[MaxFailoverSecond <Int32?>]`: The maximum allowed failover time in seconds. + - `[RestartWithFailover <EnableStatusEnum?>]`: Whether or not failover to standby server when restarting a server with high availability enabled. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Restart-AzMySqlServer.md b/azps-10.1.0/Az.MySql/Restart-AzMySqlServer.md new file mode 100644 index 0000000000..81d456865e --- /dev/null +++ b/azps-10.1.0/Az.MySql/Restart-AzMySqlServer.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/restart-azmysqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Restart-AzMySqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Restart-AzMySqlServer.md +--- + +# Restart-AzMySqlServer + +## SYNOPSIS +Restarts a server. + +## SYNTAX + +### Restart (Default) +``` +Restart-AzMySqlServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RestartViaIdentity +``` +Restart-AzMySqlServer -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Restarts a server. + +## EXAMPLES + +### Example 1: Restart MySql server by resource group and server name +```powershell +Restart-AzMySqlServer -ResourceGroupName PowershellMySqlTest -Name mysql-test +``` + +This cmdlet restarts MySql server by resource group and server name. + +### Example 2: Restart MySql server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/servers/mysql-test/restart" +Restart-AzMySqlServer -InputObject $ID +``` + +These cmdlets restart MySql server by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Restore-AzMySqlFlexibleServer.md b/azps-10.1.0/Az.MySql/Restore-AzMySqlFlexibleServer.md new file mode 100644 index 0000000000..9830b4edc6 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Restore-AzMySqlFlexibleServer.md @@ -0,0 +1,316 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/restore-azmysqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Restore-AzMySqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Restore-AzMySqlFlexibleServer.md +--- + +# Restore-AzMySqlFlexibleServer + +## SYNOPSIS +Restore a server from an existing backup + +## SYNTAX + +``` +Restore-AzMySqlFlexibleServer -Name <String> -ResourceGroupName <String> -InputObject <IServerAutoGenerated> + -RestorePointInTime <DateTime> [-SubscriptionId <String>] [-PrivateDnsZone <String>] [-Subnet <String>] + [-Zone <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Restore a server from an existing backup + +## EXAMPLES + +### Example 1: Restore MySql server using PointInTime Restore +```powershell +$restorePointInTime = (Get-Date).AddMinutes(-10) +Get-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test | Restore-AzMySqlFlexibleServer -Name mysql-test-restore -ResourceGroupName PowershellMySqlTest -RestorePointInTime $restorePointInTime +``` + +```output +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test-restore West US 2 Standard_D2ds_v4 GeneralPurpose admin 5.7 32 +``` + +These cmdlets restore MySql server using PointInTime Restore. + +### Example 2: Restore MySql server with new private access resources +```powershell +$restorePointInTime = (Get-Date).AddMinutes(-10) +Get-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test | Restore-AzMySqlFlexibleServer -Name mysql-test-restore -ResourceGroupName PowershellMySqlTest -RestorePointInTime $restorePointInTime -Subnet <SubnetId> -PrivateDnsZone <PrivateDnsZoneId> +``` + +```output +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test-restore West US 2 Standard_D2ds_v4 GeneralPurpose admin 5.7 32 +``` + +These cmdlets restore MySql server using PointInTime Restore either from private access server to different private access resources or from public access server to private access server. + +## PARAMETERS + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The source server object to restore from. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IServerAutoGenerated +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateDnsZone +The id of an existing private dns zone. +You can use the + private dns zone from same resource group, different resource group, or + different subscription. +The suffix of dns zone has to be same as that of fully qualified domain of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestorePointInTime +The location the resource resides in. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +The id of an existing Subnet the private access server will created to. +Please note that the subnet will be delegated to Microsoft.DBforPostgreSQL/flexibleServers. +After delegation, this subnet cannot be used for any other type of Azure resources. + +```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 subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +Availability zone into which to provision the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IServerAutoGenerated + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IServerAutoGenerated + +## 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 <IServerAutoGenerated>`: The source server object to restore from. + - `Location <String>`: The geo-location where the resource lives + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdministratorLogin <String>]`: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). + - `[AdministratorLoginPassword <SecureString>]`: The password of the administrator login (required for server creation). + - `[AvailabilityZone <String>]`: availability Zone information of the server. + - `[BackupGeoRedundantBackup <EnableStatusEnum?>]`: Whether or not geo redundant backup is enabled. + - `[BackupRetentionDay <Int32?>]`: Backup retention days for the server. + - `[CreateMode <CreateMode?>]`: The mode to create a new MySQL server. + - `[HighAvailabilityMode <HighAvailabilityMode?>]`: High availability mode for a server. + - `[HighAvailabilityStandbyAvailabilityZone <String>]`: Availability zone of the standby server. + - `[MaintenanceWindowCustomWindow <String>]`: indicates whether custom window is enabled or disabled + - `[MaintenanceWindowDayOfWeek <Int32?>]`: day of week for maintenance window + - `[MaintenanceWindowStartHour <Int32?>]`: start hour for maintenance window + - `[MaintenanceWindowStartMinute <Int32?>]`: start minute for maintenance window + - `[NetworkDelegatedSubnetResourceId <String>]`: Delegated subnet resource id used to setup vnet for a server. + - `[NetworkPrivateDnsZoneResourceId <String>]`: Private DNS zone resource id. + - `[ReplicationRole <ReplicationRole?>]`: The replication role. + - `[RestorePointInTime <DateTime?>]`: Restore point creation time (ISO8601 format), specifying the time to restore from. + - `[SkuName <String>]`: The name of the sku, e.g. Standard_D32s_v3. + - `[SkuTier <SkuTier?>]`: The tier of the particular SKU, e.g. GeneralPurpose. + - `[SourceServerResourceId <String>]`: The source MySQL server id. + - `[StorageAutoGrow <EnableStatusEnum?>]`: Enable Storage Auto Grow or not. + - `[StorageIop <Int32?>]`: Storage IOPS for a server. + - `[StorageSizeGb <Int32?>]`: Max storage size allowed for a server. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Version <ServerVersion?>]`: Server version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Restore-AzMySqlServer.md b/azps-10.1.0/Az.MySql/Restore-AzMySqlServer.md new file mode 100644 index 0000000000..393ab3550e --- /dev/null +++ b/azps-10.1.0/Az.MySql/Restore-AzMySqlServer.md @@ -0,0 +1,342 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/restore-azmysqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Restore-AzMySqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Restore-AzMySqlServer.md +--- + +# Restore-AzMySqlServer + +## SYNOPSIS +Restore a server from an existing backup + +## SYNTAX + +### GeoRestore (Default) +``` +Restore-AzMySqlServer -Name <String> -ResourceGroupName <String> -InputObject <IServer> -UseGeoRestore + [-SubscriptionId <String>] [-Location <String>] [-Sku <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### PointInTimeRestore +``` +Restore-AzMySqlServer -Name <String> -ResourceGroupName <String> -InputObject <IServer> + -RestorePointInTime <DateTime> -UsePointInTimeRestore [-SubscriptionId <String>] [-Location <String>] + [-Sku <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Restore a server from an existing backup + +## EXAMPLES + +### Example 1: Restore MySql server using GeoReplica Restore +```powershell +Get-AzMySqlServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test-replica | Restore-AzMySqlServer -Name mysql-test -ResourceGroupName PowershellMySqlTest -UseGeoRestore +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mysql-test-11 eastus mysql_test 5.7 10240 GP_Gen5_4 GeneralPurpose Disabled +``` + +This cmdlet restores MySql server using GeoReplica Restore. + +### Example 2: Restore MySql server using PointInTime Restore +```powershell +$restorePointInTime = (Get-Date).AddMinutes(-10) +Get-AzMySqlServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test | Restore-AzMySqlServer -Name mysql-test-restore -ResourceGroupName PowershellMySqlTest -RestorePointInTime $restorePointInTime -UsePointInTimeRestore +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mysql-test-restore eastus mysql_test 5.7 10240 GP_Gen5_4 GeneralPurpose Disabled +``` + +These cmdlets restore MySql server using PointInTime Restore. + +## PARAMETERS + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The source server object to restore from. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IServer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location the resource resides in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestorePointInTime +The location the resource resides in. + +```yaml +Type: System.DateTime +Parameter Sets: PointInTimeRestore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +B_Gen4_1, GP_Gen5_8. + +```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 subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseGeoRestore +Use Geo mode to restore + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GeoRestore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePointInTimeRestore +Use PointInTime mode to restore + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PointInTimeRestore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IServer + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IServer + +## 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 <IServer>`: The source server object to restore from. + - `Location <String>`: The geo-location where the resource lives + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdministratorLogin <String>]`: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). + - `[EarliestRestoreDate <DateTime?>]`: Earliest restore point creation time (ISO8601 format) + - `[FullyQualifiedDomainName <String>]`: The fully qualified domain name of a server. + - `[IdentityType <IdentityType?>]`: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + - `[InfrastructureEncryption <InfrastructureEncryption?>]`: Status showing whether the server enabled infrastructure encryption. + - `[MasterServerId <String>]`: The master server id of a replica server. + - `[MinimalTlsVersion <MinimalTlsVersionEnum?>]`: Enforce a minimal Tls version for the server. + - `[PublicNetworkAccess <PublicNetworkAccessEnum?>]`: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' + - `[ReplicaCapacity <Int32?>]`: The maximum number of replicas that a master server can have. + - `[ReplicationRole <String>]`: The replication role of the server. + - `[SkuCapacity <Int32?>]`: The scale up/out capacity, representing server's compute units. + - `[SkuFamily <String>]`: The family of hardware. + - `[SkuName <String>]`: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. + - `[SkuSize <String>]`: The size code, to be interpreted by resource as appropriate. + - `[SkuTier <SkuTier?>]`: The tier of the particular SKU, e.g. Basic. + - `[SslEnforcement <SslEnforcementEnum?>]`: Enable ssl enforcement or not when connect to server. + - `[StorageProfileBackupRetentionDay <Int32?>]`: Backup retention days for the server. + - `[StorageProfileGeoRedundantBackup <GeoRedundantBackup?>]`: Enable Geo-redundant or not for server backup. + - `[StorageProfileStorageAutogrow <StorageAutogrow?>]`: Enable Storage Auto Grow. + - `[StorageProfileStorageMb <Int32?>]`: Max storage allowed for a server. + - `[UserVisibleState <ServerState?>]`: A state of a server that is visible to user. + - `[Version <ServerVersion?>]`: Server version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Start-AzMySqlFlexibleServer.md b/azps-10.1.0/Az.MySql/Start-AzMySqlFlexibleServer.md new file mode 100644 index 0000000000..edd70c7a66 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Start-AzMySqlFlexibleServer.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/start-azmysqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Start-AzMySqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Start-AzMySqlFlexibleServer.md +--- + +# Start-AzMySqlFlexibleServer + +## SYNOPSIS +Starts a server. + +## SYNTAX + +### Start (Default) +``` +Start-AzMySqlFlexibleServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzMySqlFlexibleServer -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Starts a server. + +## EXAMPLES + +### Example 1: Start the server by resource name +```powershell +Start-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -Name mysql-test +``` + +Start the server by name + +### Example 2: Start the server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/flexibleServers/mysql-test/start" +Start-AzMySqlFlexibleServer -InputObject $ID +``` + +Start the server by identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Stop-AzMySqlFlexibleServer.md b/azps-10.1.0/Az.MySql/Stop-AzMySqlFlexibleServer.md new file mode 100644 index 0000000000..e4d0b73ced --- /dev/null +++ b/azps-10.1.0/Az.MySql/Stop-AzMySqlFlexibleServer.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/stop-azmysqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Stop-AzMySqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Stop-AzMySqlFlexibleServer.md +--- + +# Stop-AzMySqlFlexibleServer + +## SYNOPSIS +Stops a server. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzMySqlFlexibleServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzMySqlFlexibleServer -InputObject <IMySqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Stops a server. + +## EXAMPLES + +### Example 1: Stop the server by resource name +```powershell +Stop-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -Name mysql-test +``` + +Stop the server by name + +### Example 2: Stop the server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/flexibleServers/mysql-test/stop" +Stop-AzMySqlFlexibleServer -InputObject $ID +``` + +Stop the server by identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Test-AzMySqlFlexibleServerConnect.md b/azps-10.1.0/Az.MySql/Test-AzMySqlFlexibleServerConnect.md new file mode 100644 index 0000000000..c1f9234d1d --- /dev/null +++ b/azps-10.1.0/Az.MySql/Test-AzMySqlFlexibleServerConnect.md @@ -0,0 +1,264 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/test-azmysqlflexibleserverconnect +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Test-AzMySqlFlexibleServerConnect.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Test-AzMySqlFlexibleServerConnect.md +--- + +# Test-AzMySqlFlexibleServerConnect + +## SYNOPSIS +Test out the connection to the database server + +## SYNTAX + +### Test (Default) +``` +Test-AzMySqlFlexibleServerConnect -Name <String> -ResourceGroupName <String> + -AdministratorLoginPassword <SecureString> [-DatabaseName <String>] [-AdministratorUserName <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### TestAndQuery +``` +Test-AzMySqlFlexibleServerConnect -Name <String> -QueryText <String> -ResourceGroupName <String> + -AdministratorLoginPassword <SecureString> [-DatabaseName <String>] [-AdministratorUserName <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### TestViaIdentity +``` +Test-AzMySqlFlexibleServerConnect -AdministratorLoginPassword <SecureString> -InputObject <IMySqlIdentity> + [-DatabaseName <String>] [-AdministratorUserName <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### TestViaIdentityAndQuery +``` +Test-AzMySqlFlexibleServerConnect -QueryText <String> -AdministratorLoginPassword <SecureString> + -InputObject <IMySqlIdentity> [-DatabaseName <String>] [-AdministratorUserName <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Test out the connection to the database server + +## EXAMPLES + +### Example 1: Test connection by name +```powershell +$password = ConvertTo-SecureString <YourPassword> -AsPlainText +Test-AzMySqlFlexibleServerConnect -ResourceGroupName PowershellMySqlTest -Name mysql-test -AdministratorLoginPassword $password +``` + +```output +The connection testing to mysql-test.database.azure.com was successful! +``` + +Test connection by the resource group and the server name + +### Example 2: Test connection by identity +```powershell +$password = ConvertTo-SecureString <YourPassword> -AsPlainText +Get-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test | Test-AzMySqlFlexibleServerConnect -AdministratorLoginPassword $password +``` + +```output +The connection testing to mysql-test.database.azure.com was successful! +``` + +Test connection by the identity + +### Example 3: Test query by name +```powershell +$password = ConvertTo-SecureString <YourPassword> -AsPlainText +Test-AzMySqlFlexibleServerConnect -ResourceGroupName PowershellMySqlTest -Name mysql-test -AdministratorLoginPassword $password -QueryText "SELECT * FROM test" +``` + +```output +col +----- +1 +2 +3 +``` + +Test a query by the resource group and the server name + +### Example 4: Test connection by identity +```powershell +Get-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test | Test-AzMySqlFlexibleServerConnect -QueryText "SELECT * FROM test" -AdministratorLoginPassword $password +``` + +```output +col +----- +1 +2 +3 +``` + +Test a query by the identity + +## PARAMETERS + +### -AdministratorLoginPassword +The password of the administrator. +Minimum 8 characters and maximum 128 characters. +Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorUserName +Administrator username for the server. +Once set, it cannot be changed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The database name to connect. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The server to connect. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: TestViaIdentity, TestViaIdentityAndQuery +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server to connect. + +```yaml +Type: System.String +Parameter Sets: Test, TestAndQuery +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryText +The query for the database to test + +```yaml +Type: System.String +Parameter Sets: TestAndQuery, TestViaIdentityAndQuery +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Test, TestAndQuery +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IMySqlIdentity>`: The server to connect. + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Update-AzMySqlConfiguration.md b/azps-10.1.0/Az.MySql/Update-AzMySqlConfiguration.md new file mode 100644 index 0000000000..2b5e96fdd0 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Update-AzMySqlConfiguration.md @@ -0,0 +1,283 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/update-azmysqlconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlConfiguration.md +--- + +# Update-AzMySqlConfiguration + +## SYNOPSIS +Updates a configuration of a server. +Use Update-AzMySqlServer instead if you want update AdministratorLoginPassword, sku, etc. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMySqlConfiguration -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-Source <String>] [-Value <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMySqlConfiguration -InputObject <IMySqlIdentity> [-Source <String>] [-Value <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a configuration of a server. +Use Update-AzMySqlServer instead if you want update AdministratorLoginPassword, sku, etc. + +## EXAMPLES + +### Example 1: Update MySql configuration by name +```powershell +Update-AzMySqlConfiguration -Name net_retry_count -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -Value 15 +``` + +```output +Name Value +---- ----- +net_retry_count 15 +``` + +This cmdlet updates MySql configuration by name. + +### Example 2: Update MySql configuration by identity. +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/servers/mysql-test/configurations/wait_timeout" +Update-AzMySqlConfiguration -InputObject $ID -Value 150 +``` + +```output +Name Value +---- ----- +wait_timeout 150 +``` + +These cmdlets update MySql configuration by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server configuration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Source of the configuration. + +```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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Value of the configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IConfiguration + +## 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 <IMySqlIdentity>`: Identity Parameter. + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Update-AzMySqlFirewallRule.md b/azps-10.1.0/Az.MySql/Update-AzMySqlFirewallRule.md new file mode 100644 index 0000000000..47c3e417b2 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Update-AzMySqlFirewallRule.md @@ -0,0 +1,326 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/update-azmysqlfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlFirewallRule.md +--- + +# Update-AzMySqlFirewallRule + +## SYNOPSIS +Creates a new firewall rule or updates an existing firewall rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMySqlFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -EndIPAddress <String> -StartIPAddress <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ClientIPAddress +``` +Update-AzMySqlFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -ClientIPAddress <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ClientIPAddressViaIdentity +``` +Update-AzMySqlFirewallRule -InputObject <IMySqlIdentity> -ClientIPAddress <String> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMySqlFirewallRule -InputObject <IMySqlIdentity> -EndIPAddress <String> -StartIPAddress <String> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new firewall rule or updates an existing firewall rule. + +## EXAMPLES + +### Example 1: Update MySql Firewall Rule by name +```powershell +Update-AzMySqlFirewallRule -Name rule -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -EndIPAddress 0.0.0.3 -StartIPAddress 0.0.0.2 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.2 0.0.0.3 +``` + +This cmdlet updates MySql Firewall Rule by name. + +### Example 2: Update MySql Firewall Rule by identity. +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/servers/mysql-test/firewallRules/rule" +Update-AzMySqlFirewallRule -InputObject $ID -EndIPAddress 0.0.0.3 -StartIPAddress 0.0.0.2 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.2 0.0.0.3 +``` + +These cmdlets update MySql Firewall Rule by identity. + +### Example 3: Update MySql Firewall Rule by -ClientIPAddress. +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/servers/mysql-test/firewallRules/rule" +Update-AzMySqlFirewallRule -InputObject $ID -ClientIPAddress 0.0.0.2 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.2 0.0.0.2 +``` + +These cmdlets update MySql Firewall Rule by -ClientIPAddress. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientIPAddress +Client specified single IP of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, ClientIPAddressViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIPAddress +The end IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: ClientIPAddressViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +The start IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IFirewallRule + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Update-AzMySqlFlexibleServer.md b/azps-10.1.0/Az.MySql/Update-AzMySqlFlexibleServer.md new file mode 100644 index 0000000000..83da10c9cb --- /dev/null +++ b/azps-10.1.0/Az.MySql/Update-AzMySqlFlexibleServer.md @@ -0,0 +1,403 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/update-azmysqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlFlexibleServer.md +--- + +# Update-AzMySqlFlexibleServer + +## SYNOPSIS +Updates an existing MySQL flexible server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzMySqlFlexibleServerConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMySqlFlexibleServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AdministratorLoginPassword <SecureString>] [-BackupRetentionDay <Int32>] [-HighAvailability <String>] + [-MaintenanceWindow <String>] [-ReplicationRole <String>] [-Sku <String>] [-SkuTier <SkuTier>] + [-StorageAutogrow <StorageAutogrow>] [-StorageInMb <Int32>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMySqlFlexibleServer -InputObject <IMySqlIdentity> [-AdministratorLoginPassword <SecureString>] + [-BackupRetentionDay <Int32>] [-HighAvailability <String>] [-MaintenanceWindow <String>] + [-ReplicationRole <String>] [-Sku <String>] [-SkuTier <SkuTier>] [-StorageAutogrow <StorageAutogrow>] + [-StorageInMb <Int32>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing MySQL flexible server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzMySqlFlexibleServerConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +## EXAMPLES + +### Example 1: Update MySql server by resource group and server name +```powershell +Update-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -Name mysql-test -Sku Standard_D4ds_v4 +``` + +```output +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test West US 2 Standard_D2ds_v4 GeneralPurpose admin 5.7 32 +``` + +This cmdlet updates MySql server by resource group and server name. + +### Example 2: Update MySql server by identity. +```powershell +Get-AzMySqlFlexibleServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test | Update-AzMySqlFlexibleServer -BackupRetentionDay 23 -StorageInMb 10240 +``` + +```output +Name Location SkuName SkuTier AdministratorLogin Version StorageSizeGb +---- -------- ------- ------- ------------------ ------- ------------- +mysql-test West US 2 Standard_D2ds_v4 GeneralPurpose admin 5.7 32 +``` + +This cmdlet updates MySql server by identity. + +## PARAMETERS + +### -AdministratorLoginPassword +The password of the administrator login. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. +Day count is between 7 and 35. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailability +Enable or disable high availability feature. +Default value is Disabled. +Default: Disabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HaEnabled + +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.MySql.Models.IMySqlIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaintenanceWindow +Period of time (UTC) designated for maintenance. +Examples: "Sun:23:30" to schedule on Sunday, 11:30pm UTC. +To set back to default pass in "Disabled" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationRole +The replication role of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +Burstable_B1ms, Standard_D2ds_v4 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +The tier of the particular SKU. +Accepted values: Burstable, GeneralPurpose, Memory Optimized. +Default: Burstable. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAutogrow +Enable or disable Storage Auto Grow. +The default value is Disabled + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.StorageAutogrow +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageInMb +Max storage allowed for a server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IServerAutoGenerated + +## 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 <IMySqlIdentity>`: Identity Parameter. + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Update-AzMySqlFlexibleServerConfiguration.md b/azps-10.1.0/Az.MySql/Update-AzMySqlFlexibleServerConfiguration.md new file mode 100644 index 0000000000..7508f34c91 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Update-AzMySqlFlexibleServerConfiguration.md @@ -0,0 +1,282 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/update-azmysqlflexibleserverconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlFlexibleServerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlFlexibleServerConfiguration.md +--- + +# Update-AzMySqlFlexibleServerConfiguration + +## SYNOPSIS +Updates information about a configuration of a MySQL flexible server. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMySqlFlexibleServerConfiguration -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-Source <String>] [-Value <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMySqlFlexibleServerConfiguration -InputObject <IMySqlIdentity> [-Source <String>] [-Value <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates information about a configuration of a MySQL flexible server. + +## EXAMPLES + +### Example 1: Update MySql configuration by name +```powershell +Update-AzMySqlFlexibleServerConfiguration -Name net_retry_count -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -Value 15 +``` + +```output +Name Value AllowedValue Source DefaultValue +---- ----- ------------ ------ ------------ +net_retry_count 15 1-4294967295 user-override 10 +``` + +This cmdlet updates MySql configuration by name. + +### Example 2: Update MySql configuration by identity. +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBForMySql/flexibleServers/mysql-test/configurations/wait_timeout" +Update-AzMySqlFlexibleServerConfiguration -InputObject $ID -Value 150 +``` + +```output +Name Value AllowedValue Source DefaultValue +---- ----- ------------ ------ ------------ +wait_timeout 150 1-31536000 user-override 28800 +``` + +These cmdlets update MySql configuration by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server configuration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +The source of the updating value. +The default value is user-override + +```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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Value of the configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IConfigurationAutoGenerated + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Update-AzMySqlFlexibleServerFirewallRule.md b/azps-10.1.0/Az.MySql/Update-AzMySqlFlexibleServerFirewallRule.md new file mode 100644 index 0000000000..289ce9e2d9 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Update-AzMySqlFlexibleServerFirewallRule.md @@ -0,0 +1,313 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/update-azmysqlflexibleserverfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlFlexibleServerFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlFlexibleServerFirewallRule.md +--- + +# Update-AzMySqlFlexibleServerFirewallRule + +## SYNOPSIS +Updates an existing firewall rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMySqlFlexibleServerFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -EndIPAddress <String> -StartIPAddress <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ClientIPAddress +``` +Update-AzMySqlFlexibleServerFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -ClientIPAddress <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ClientIPAddressViaIdentity +``` +Update-AzMySqlFlexibleServerFirewallRule -InputObject <IMySqlIdentity> -ClientIPAddress <String> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMySqlFlexibleServerFirewallRule -InputObject <IMySqlIdentity> -EndIPAddress <String> + -StartIPAddress <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing firewall rule. + +## EXAMPLES + +### Example 1: Update MySql Firewall Rule by name +```powershell +Update-AzMySqlFlexibleServerFirewallRule -Name rule -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -EndIPAddress 0.0.0.3 -StartIPAddress 0.0.0.2 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.2 0.0.0.3 +``` + +This cmdlet updates MySql Firewall Rule by name. + +### Example 2: Update MySql Firewall Rule by identity. +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBForMySql/flexibleServers/mysql-test/firewallRules/rule" +Update-AzMySqlFlexibleServerFirewallRule -InputObject $ID -EndIPAddress 0.0.0.3 -StartIPAddress 0.0.0.2 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.2 0.0.0.3 +``` + +These cmdlets update MySql Firewall Rule by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientIPAddress +Client specified single IP of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, ClientIPAddressViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIPAddress +The end IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: ClientIPAddressViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +The start IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20210501.IFirewallRuleAutoGenerated + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Update-AzMySqlServer.md b/azps-10.1.0/Az.MySql/Update-AzMySqlServer.md new file mode 100644 index 0000000000..b9868b8ab5 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Update-AzMySqlServer.md @@ -0,0 +1,446 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/update-azmysqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlServer.md +--- + +# Update-AzMySqlServer + +## SYNOPSIS +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzMySqlConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMySqlServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AdministratorLoginPassword <SecureString>] [-BackupRetentionDay <Int32>] + [-MinimalTlsVersion <MinimalTlsVersionEnum>] [-PublicNetworkAccess <PublicNetworkAccessEnum>] + [-ReplicationRole <String>] [-Sku <String>] [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuTier <SkuTier>] + [-SslEnforcement <SslEnforcementEnum>] [-StorageAutogrow <StorageAutogrow>] [-StorageInMb <Int32>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMySqlServer -InputObject <IMySqlIdentity> [-AdministratorLoginPassword <SecureString>] + [-BackupRetentionDay <Int32>] [-MinimalTlsVersion <MinimalTlsVersionEnum>] + [-PublicNetworkAccess <PublicNetworkAccessEnum>] [-ReplicationRole <String>] [-Sku <String>] + [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuTier <SkuTier>] [-SslEnforcement <SslEnforcementEnum>] + [-StorageAutogrow <StorageAutogrow>] [-StorageInMb <Int32>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzMySqlConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +## EXAMPLES + +### Example 1: Update MySql server by resource group and server name +```powershell +Update-AzMySqlServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -SslEnforcement Disabled +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mysql-test eastus mysql_test 5.7 5120 GP_Gen5_4 GeneralPurpose Disabled +``` + +This cmdlet updates MySql server by resource group and server name. + +### Example 2: Update MySql server by identity. +```powershell +Get-AzMySqlServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test | Update-AzMySqlServer -BackupRetentionDay 23 -StorageInMb 10240 +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +mysql-test eastus mysql_test 5.7 10240 GP_Gen5_4 GeneralPurpose Disabled +``` + +This cmdlet updates MySql server by identity. + +## PARAMETERS + +### -AdministratorLoginPassword +The password of the administrator login. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. +Day count is between 7 and 35. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MinimalTlsVersion +Set the minimal TLS version for connections to server when SSL is enabled. +Default is TLSEnforcementDisabled.accepted values: TLS1_0, TLS1_1, TLS1_2, TLSEnforcementDisabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.MinimalTlsVersionEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Whether or not public network access is allowed for this server. +Value is optional but if passed in, must be 'Enabled' or 'Disabled' + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.PublicNetworkAccessEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationRole +The replication role of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +B_Gen4_1, GP_Gen5_8. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +The scale up/out capacity, representing server's compute units. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +The family of hardware. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +The tier of the particular SKU, e.g. +Basic. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslEnforcement +Enable ssl enforcement or not when connect to server. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.SslEnforcementEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAutogrow +Enable Storage Auto Grow. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.StorageAutogrow +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageInMb +Max storage allowed for a server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IServer + +## 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 <IMySqlIdentity>`: Identity Parameter. + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Update-AzMySqlServerConfigurationsList.md b/azps-10.1.0/Az.MySql/Update-AzMySqlServerConfigurationsList.md new file mode 100644 index 0000000000..e014e7c0fe --- /dev/null +++ b/azps-10.1.0/Az.MySql/Update-AzMySqlServerConfigurationsList.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/update-azmysqlserverconfigurationslist +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlServerConfigurationsList.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlServerConfigurationsList.md +--- + +# Update-AzMySqlServerConfigurationsList + +## SYNOPSIS +Update a list of configurations in a given server. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMySqlServerConfigurationsList -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-Value <IConfiguration[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMySqlServerConfigurationsList -InputObject <IMySqlIdentity> [-Value <IConfiguration[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a list of configurations in a given server. + +## EXAMPLES + +### Example 1: Update MySQL configurations list by name +```powershell +Update-AzMySqlServerConfigurationsList -ResourceGroupName PowershellMySqlTest -ServerName mysql-test +``` + +Update MySQL configurations list by name. + +### Example 2: Update MySQL configurations list by identity +```powershell +Get-AzMySqlServer -ResourceGroupName PowershellMySqlTest -ServerName mysql-test | Update-AzMySqlServerConfigurationsList +``` + +Update MySQL configurations list by ID. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The list of server configurations. +To construct, see NOTES section for VALUE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IConfiguration + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +`VALUE <IConfiguration[]>`: The list of server configurations. + - `[Source <String>]`: Source of the configuration. + - `[Value <String>]`: Value of the configuration. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.MySql/Update-AzMySqlVirtualNetworkRule.md b/azps-10.1.0/Az.MySql/Update-AzMySqlVirtualNetworkRule.md new file mode 100644 index 0000000000..f9132f8382 --- /dev/null +++ b/azps-10.1.0/Az.MySql/Update-AzMySqlVirtualNetworkRule.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://learn.microsoft.com/powershell/module/az.mysql/update-azmysqlvirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/MySql/help/Update-AzMySqlVirtualNetworkRule.md +--- + +# Update-AzMySqlVirtualNetworkRule + +## SYNOPSIS +Creates or updates an existing virtual network rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMySqlVirtualNetworkRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -SubnetId <String> [-SubscriptionId <String>] [-IgnoreMissingVnetServiceEndpoint] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMySqlVirtualNetworkRule -InputObject <IMySqlIdentity> -SubnetId <String> + [-IgnoreMissingVnetServiceEndpoint] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an existing virtual network rule. + +## EXAMPLES + +### Example 1: Update MySql Virtual Network Rule by name +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.Network/virtualNetworks/MySqlVNet/subnets/MysqlSubnet2" +Update-AzMySqlVirtualNetworkRule -Name $env.VNetName -ResourceGroupName $env.resourceGroup -ServerName $env.serverName -SubnetId $ID +``` + +```output +Name Type +---- ---- +vnet Microsoft.DBforMySQL/servers/virtualNetworkRules +``` + +This cmdlet updates MySql Virtual Network Rule by name. + +### Example 2: Update MySql Virtual Network Rule by identity. +```powershell +$SubnetID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.Network/virtualNetworks/MySqlVNet/subnets/MysqlSubnet1" +$VNetID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellMySqlTest/providers/Microsoft.DBforMySQL/servers/mysql-test/virtualNetworkRules/vnet" +Update-AzMySqlVirtualNetworkRule -InputObject $VNetID -SubnetId $SubnetID +``` + +```output +Name Type +---- ---- +vnet Microsoft.DBforMySQL/servers/virtualNetworkRules +``` + +These cmdlets update MySql Virtual Network Rule by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreMissingVnetServiceEndpoint +Create firewall rule before the virtual network has vnet service endpoint enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: VirtualNetworkRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The ARM resource id of the virtual network subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IVirtualNetworkRule + +## 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 <IMySqlIdentity>`: Identity Parameter + - `[BackupName <String>]`: The name of the backup. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.NetAppFiles/Approve-AzNetAppFilesReplication.md b/azps-10.1.0/Az.NetAppFiles/Approve-AzNetAppFilesReplication.md new file mode 100644 index 0000000000..a717160243 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Approve-AzNetAppFilesReplication.md @@ -0,0 +1,245 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/approve-aznetappfilesreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Approve-AzNetAppFilesReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Approve-AzNetAppFilesReplication.md +--- + +# Approve-AzNetAppFilesReplication + +## SYNOPSIS +Approve/Authorize replication connection on the source volume + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Approve-AzNetAppFilesReplication -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -Name <String> -DataProtectionVolumeId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Approve-AzNetAppFilesReplication -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Approve-AzNetAppFilesReplication -InputObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Approve the replication connection on the source volume + +## EXAMPLES + +### Example 1 +```powershell +Approve-AzNetAppFilesReplication -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -DataProtectionVolumeId "MyDestinationVolumeId" +``` + +```output +remoteVolumeResourceId : resourceId +``` + +This command Approves the Replication on MyAnfVolume. + +## PARAMETERS + +### -AccountName +The name of the ANF account of the replication source volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataProtectionVolumeId +The file system id of the destination data protection volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The ANF source volume object to authorized the replication destination + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF replication source volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether replication authorization of the specified volume was performed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool of the replication source volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF replication source volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF replication source volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Initialize-AzNetAppFilesReplication](./Initialize-AzNetAppFilesReplication.md) +[Suspend-AzNetAppFilesReplication](./Suspend-AzNetAppFilesReplication.md) +[Resume-AzNetAppFilesReplication](./Resume-AzNetAppFilesReplication.md) +[Remove-AzNetAppFilesReplication](./Remove-AzNetAppFilesReplication.md) +[Get-AzNetAppFilesReplicationStatus](./Get-AzNetAppFilesReplicationStatus.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Az.NetAppFiles.md b/azps-10.1.0/Az.NetAppFiles/Az.NetAppFiles.md new file mode 100644 index 0000000000..1af57aea00 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Az.NetAppFiles.md @@ -0,0 +1,217 @@ +--- +Module Name: Az.NetAppFiles +Module Guid: e20e99dc-6df9-479b-8504-2960f0088f00 +Download Help Link: https://learn.microsoft.com/powershell/module/az.netappfiles +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Az.NetAppFiles.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Az.NetAppFiles.md +--- + +# Az.NetAppFiles Module +## Description +The topics in this section document the Azure PowerShell cmdlets for Azure NetApp Files in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.NetAppFiles namespace. + +## Az.NetAppFiles Cmdlets +### [Approve-AzNetAppFilesReplication](Approve-AzNetAppFilesReplication.md) +Approve/Authorize replication connection on the source volume + +### [Get-AzNetAppFilesAccount](Get-AzNetAppFilesAccount.md) +Gets details of an Azure NetApp Files (ANF) account. + +### [Get-AzNetAppFilesActiveDirectory](Get-AzNetAppFilesActiveDirectory.md) +Gets details of an Azure NetApp Files (ANF) Active Directory configuration. + +### [Get-AzNetAppFilesBackup](Get-AzNetAppFilesBackup.md) +Gets details of an Azure NetApp Files (ANF) Backup. + +### [Get-AzNetAppFilesBackupPolicy](Get-AzNetAppFilesBackupPolicy.md) +Gets details of an Azure NetApp Files (ANF) Backup Policy. + +### [Get-AzNetAppFilesPool](Get-AzNetAppFilesPool.md) +Gets details of an Azure NetApp Files (ANF) pool. + +### [Get-AzNetAppFilesQuotaLimit](Get-AzNetAppFilesQuotaLimit.md) +Get quota limits + +### [Get-AzNetAppFilesReplicationStatus](Get-AzNetAppFilesReplicationStatus.md) +Get the status of the replication + +### [Get-AzNetAppFilesSnapshot](Get-AzNetAppFilesSnapshot.md) +Gets details of an Azure NetApp Files (ANF) snapshot. + +### [Get-AzNetAppFilesSnapshotPolicy](Get-AzNetAppFilesSnapshotPolicy.md) +Gets details of an Azure NetApp Files (ANF) snapshot policy. + +### [Get-AzNetAppFilesSubvolume](Get-AzNetAppFilesSubvolume.md) +Gets details of an Azure NetApp Files (ANF) subvolume. + +### [Get-AzNetAppFilesSubvolumeMetadata](Get-AzNetAppFilesSubvolumeMetadata.md) +Gets metadata details of an Azure NetApp Files (ANF) subvolume. + +### [Get-AzNetAppFilesVolume](Get-AzNetAppFilesVolume.md) +Gets details of an Azure NetApp Files (ANF) volume. + +### [Get-AzNetAppFilesVolumeBackupStatus](Get-AzNetAppFilesVolumeBackupStatus.md) +Get volume's backup status + +### [Get-AzNetAppFilesVolumeGroup](Get-AzNetAppFilesVolumeGroup.md) +Gets details of an Azure NetApp Files (ANF) VolumeGroup. + +### [Get-AzNetAppFilesVolumeQuotaRule](Get-AzNetAppFilesVolumeQuotaRule.md) +Gets details of an Azure NetApp Files (ANF) Volume Quouta Rule. + +### [Get-AzNetAppFilesVolumeReplication](Get-AzNetAppFilesVolumeReplication.md) +Get volume's replication + +### [Get-AzNetAppFilesVolumeRestoreStatus](Get-AzNetAppFilesVolumeRestoreStatus.md) +Get volume's restore status + +### [Initialize-AzNetAppFilesReplication](Initialize-AzNetAppFilesReplication.md) +Re-Initializes the replication connection on the destination volume + +### [New-AzNetAppFilesAccount](New-AzNetAppFilesAccount.md) +Creates a new Azure NetApp Files (ANF) account. + +### [New-AzNetAppFilesActiveDirectory](New-AzNetAppFilesActiveDirectory.md) +Creates a new Azure NetApp Files (ANF) active directory configuration. + +### [New-AzNetAppFilesBackup](New-AzNetAppFilesBackup.md) +Creates a new Azure NetApp Files (ANF) backup. + +### [New-AzNetAppFilesBackupPolicy](New-AzNetAppFilesBackupPolicy.md) +Creates a new Azure NetApp Files (ANF) backup policy for an ANF account. + +### [New-AzNetAppFilesExportPolicyObject](New-AzNetAppFilesExportPolicyObject.md) +Creates export policy object. + +### [New-AzNetAppFilesExportPolicyRuleObject](New-AzNetAppFilesExportPolicyRuleObject.md) +Creates export policy rule object. + +### [New-AzNetAppFilesPool](New-AzNetAppFilesPool.md) +Creates a new Azure NetApp Files (ANF) pool. + +### [New-AzNetAppFilesSnapshot](New-AzNetAppFilesSnapshot.md) +Creates a new Azure NetApp Files (ANF) snapshot. + +### [New-AzNetAppFilesSnapshotPolicy](New-AzNetAppFilesSnapshotPolicy.md) +Creates a new Azure NetApp Files (ANF) snapshot policy for an ANF account. + +### [New-AzNetAppFilesSubvolume](New-AzNetAppFilesSubvolume.md) +Creates a new Azure NetApp Files (ANF) subvolume. + +### [New-AzNetAppFilesVolume](New-AzNetAppFilesVolume.md) +Creates a new Azure NetApp Files (ANF) volume. + +### [New-AzNetAppFilesVolumeGroup](New-AzNetAppFilesVolumeGroup.md) +Creates a new Azure NetApp Files (ANF) VolumeGroup along with requisite volumes. +Creating volume group will create all the volumes specified in request body implicitly. Once volumes are created using volume group, those will be treated as regular volumes thereafter. + +### [New-AzNetAppFilesVolumeQuotaRule](New-AzNetAppFilesVolumeQuotaRule.md) +Creates a new Azure NetApp Files (ANF) Volume Quota Rule. + +### [Remove-AzNetAppFilesAccount](Remove-AzNetAppFilesAccount.md) +Deletes an Azure NetApp Files (ANF) account. + +### [Remove-AzNetAppFilesActiveDirectory](Remove-AzNetAppFilesActiveDirectory.md) +Deletes an Azure NetApp Files (ANF) active directory configuration. + +### [Remove-AzNetAppFilesBackup](Remove-AzNetAppFilesBackup.md) +Deletes an Azure NetApp Files (ANF) backup. + +### [Remove-AzNetAppFilesBackupPolicy](Remove-AzNetAppFilesBackupPolicy.md) +Deletes an Azure NetApp Files (ANF) backup policy. + +### [Remove-AzNetAppFilesPool](Remove-AzNetAppFilesPool.md) +Deletes an Azure NetApp Files (ANF) pool. + +### [Remove-AzNetAppFilesReplication](Remove-AzNetAppFilesReplication.md) +Remove/Delete the replication connection on the destination volume, and send release to the source replication + +### [Remove-AzNetAppFilesSnapshot](Remove-AzNetAppFilesSnapshot.md) +Deletes an Azure NetApp Files (ANF) snapshot. + +### [Remove-AzNetAppFilesSnapshotPolicy](Remove-AzNetAppFilesSnapshotPolicy.md) +Deletes an Azure NetApp Files (ANF) snapshot policy. + +### [Remove-AzNetAppFilesSubvolume](Remove-AzNetAppFilesSubvolume.md) +Deletes an Azure NetApp Files (ANF) subvolume. + +### [Remove-AzNetAppFilesVolume](Remove-AzNetAppFilesVolume.md) +Deletes an Azure NetApp Files (ANF) volume. + +### [Remove-AzNetAppFilesVolumeGroup](Remove-AzNetAppFilesVolumeGroup.md) +Deletes an Azure NetApp Files (ANF) VolumeGroup. This delete the specified volume group only does not delete the volumes. + +### [Remove-AzNetAppFilesVolumeQuotaRule](Remove-AzNetAppFilesVolumeQuotaRule.md) +Deletes an Azure NetApp Files (ANF) Volume Quota Rule. + +### [Reset-AzNetAppFilesVolumeCifsPassword](Reset-AzNetAppFilesVolumeCifsPassword.md) +Reset the Cifs password for the volume + +### [Restore-AzNetAppFilesBackupFile](Restore-AzNetAppFilesBackupFile.md) +Create a new Backup Restore Files request + +### [Restore-AzNetAppFilesReplication](Restore-AzNetAppFilesReplication.md) +Restore (Re-establish) the specified replication for the volume + +### [Restore-AzNetAppFilesSnapshotFile](Restore-AzNetAppFilesSnapshotFile.md) +Restore the specified files from the specified snapshot to the active filesystem + +### [Restore-AzNetAppFilesVolume](Restore-AzNetAppFilesVolume.md) +Restore/Revert a volume to one of its snapshots + +### [Resume-AzNetAppFilesReplication](Resume-AzNetAppFilesReplication.md) +Resume/Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from source to destination. + +### [Set-AzNetAppFilesAccount](Set-AzNetAppFilesAccount.md) +Updates an Azure NetApp Files (ANF) account with the new data set. Useful for deletion of associated active directories. + +### [Set-AzNetAppFilesBackupPolicy](Set-AzNetAppFilesBackupPolicy.md) +Updates an Azure NetApp Files (ANF) Backup Policy with the new data set. + +### [Set-AzNetAppFilesPool](Set-AzNetAppFilesPool.md) +Updates an Azure NetApp Files (ANF) Capacity Pool with the new data set. + +### [Set-AzNetAppFilesSnapshotPolicy](Set-AzNetAppFilesSnapshotPolicy.md) +Updates an Azure NetApp Files (ANF) Snapshot Policy with the new data set. + +### [Set-AzNetAppFilesVolumePool](Set-AzNetAppFilesVolumePool.md) +Change pool for an Azure NetApp Files (ANF) volume. + +### [Suspend-AzNetAppFilesReplication](Suspend-AzNetAppFilesReplication.md) +Suspend/break the replication connection on the destination volume + +### [Unlock-AzNetAppFilesVolumeFileLock](Unlock-AzNetAppFilesVolumeFileLock.md) +Break file locks + +### [Update-AzNetAppFilesAccount](Update-AzNetAppFilesAccount.md) +Updates an Azure NetApp Files (ANF) account according to the optional modifiers provided. + +### [Update-AzNetAppFilesAccountCredential](Update-AzNetAppFilesAccountCredential.md) +Renew identity credentials + +### [Update-AzNetAppFilesActiveDirectory](Update-AzNetAppFilesActiveDirectory.md) +Updates an Azure NetApp Files (ANF) active directory configuration to the optional modifiers provided. + +### [Update-AzNetAppFilesBackup](Update-AzNetAppFilesBackup.md) +Updates an Azure NetApp Files (ANF) backup to the optional modifiers provided. + +### [Update-AzNetAppFilesBackupPolicy](Update-AzNetAppFilesBackupPolicy.md) +Updates an Azure NetApp Files (ANF) backup policy to the optional modifiers provided. + +### [Update-AzNetAppFilesPool](Update-AzNetAppFilesPool.md) +Updates an Azure NetApp Files (ANF) pool according to the optional modifiers provided. + +### [Update-AzNetAppFilesSnapshotPolicy](Update-AzNetAppFilesSnapshotPolicy.md) +Updates an Azure NetApp Files (ANF) snapshot policy to the optional modifiers provided. + +### [Update-AzNetAppFilesSubvolume](Update-AzNetAppFilesSubvolume.md) +Updates an Azure NetApp Files (ANF) subvolume according to the optional modifiers provided. + +### [Update-AzNetAppFilesVolume](Update-AzNetAppFilesVolume.md) +Updates an Azure NetApp Files (ANF) volume according to the optional modifiers provided. + +### [Update-AzNetAppFilesVolumeQuotaRule](Update-AzNetAppFilesVolumeQuotaRule.md) +Updates an Azure NetApp Files (ANF) volume quota rule according to the optional modifiers provided. + diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesAccount.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesAccount.md new file mode 100644 index 0000000000..e11b4b596a --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesAccount.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesAccount.md +--- + +# Get-AzNetAppFilesAccount + +## SYNOPSIS +Gets details of an Azure NetApp Files (ANF) account. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesAccount -ResourceGroupName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesAccount -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesAccount** cmdlet gets details of an ANF account. + +## EXAMPLES + +### Example 1: Get an ANF account +```powershell +Get-AzNetAppFilesAccount -ResourceGroupName "MyRG" -Name "MyAnfAccount" +``` + +```output +Location : westus2 +Id : /subscriptions/mySubs/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount +Name : MyAnfAccount +Type : Microsoft.NetApp/netAppAccounts +Tags : +ProvisioningState : Succeeded +``` + +This command gets the account named MyAnfAccount. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: AccountName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesAccount](./New-AzNetAppFilesAccount.md) +[Remove-AzNetAppFilesAccount](./Remove-AzNetAppFilesAccount.md) +[Set-AzNetAppFilesAccount](./Set-AzNetAppFilesAccount.md) +[Update-AzNetAppFilesAccount](./Update-AzNetAppFilesAccount.md) +[Get-AzNetAppFilesActiveDirectory](./Get-AzNetAppFilesActiveDirectory.md) +[New-AzNetAppFilesActiveDirectory](./New-AzNetAppFilesActiveDirectory.md) +[Remove-AzNetAppFilesActiveDirectory](./Remove-AzNetAppFilesActiveDirectory.md) +[Update-AzNetAppFilesActiveDirectory](./Update-AzNetAppFilesActiveDirectory.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesActiveDirectory.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesActiveDirectory.md new file mode 100644 index 0000000000..ae66bcef28 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesActiveDirectory.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesactivedirectory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesActiveDirectory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesActiveDirectory.md +--- + +# Get-AzNetAppFilesActiveDirectory + +## SYNOPSIS +Gets details of an Azure NetApp Files (ANF) Active Directory configuration. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesActiveDirectory -ResourceGroupName <String> -AccountName <String> + [-ActiveDirectoryId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesActiveDirectory [-ActiveDirectoryId <String>] -AccountObject <PSNetAppFilesAccount> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesActiveDirectory** cmdlet gets details of an ANF accounts Active Directory configuration. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetAppFilesActiveDirectory -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -ActiveDirectoryId "MyADConfigName" +``` + +This command gets the AD configuration named MyADConfigName for the Azure NetApp Files (ANF) account named MyAnfAccount. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account for the new Active Directory object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ActiveDirectoryId +The ActiveDirectoryId of the ANF Active Directory + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ActiveDirectoryName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesActiveDirectory + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesActiveDirectory](./New-AzNetAppFilesActiveDirectory.md) +[Remove-AzNetAppFilesActiveDirectory](./Remove-AzNetAppFilesActiveDirectory.md) +[Update-AzNetAppFilesActiveDirectory](./Update-AzNetAppFilesActiveDirectory.md) +[Get-AzNetAppFilesAccount](./Get-AzNetAppFilesAccount.md) +[New-AzNetAppFilesAccount](./New-AzNetAppFilesAccount.md) +[Remove-AzNetAppFilesAccount](./Remove-AzNetAppFilesAccount.md) +[Set-AzNetAppFilesAccount](./Set-AzNetAppFilesAccount.md) +[Update-AzNetAppFilesAccount](./Update-AzNetAppFilesAccount.md) diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesBackup.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesBackup.md new file mode 100644 index 0000000000..1e2fdf9d8f --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesBackup.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesBackup.md +--- + +# Get-AzNetAppFilesBackup + +## SYNOPSIS +Gets details of an Azure NetApp Files (ANF) Backup. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesBackup -ResourceGroupName <String> -AccountName <String> -PoolName <String> + [-VolumeName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByAccountBackupFieldsParameterSet +``` +Get-AzNetAppFilesBackup -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-AccountBackupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesBackup [-Name <String>] [-AccountBackupName <String>] -VolumeObject <PSNetAppFilesVolume> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesBackup [-Name <String>] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesBackup** cmdlet gets details of an ANF backup. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -PoolName "MyPool" -VolumeName "MyVolume" -Name "MyBackup" +``` + +This command gets the backup named "MyAnfAccount" from the volume named "MyVolume". + +### Example 2 +```powershell +Get-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -AccountBackupName "MyBackup" +``` + +This command gets the backup named "MyAnfAccount" from the Account named "MyAccount". + +## PARAMETERS + +### -AccountBackupName +The name of the ANF backup + +```yaml +Type: System.String +Parameter Sets: ByAccountBackupFieldsParameterSet, ByParentObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByAccountBackupFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF backup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BackupName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByAccountBackupFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Backup + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the backup to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesBackup](./New-AzNetAppFilesBackup.md) +[Remove-AzNetAppFilesBackup](./Remove-AzNetAppFilesBackup.md) +[Update-AzNetAppFilesBackup](./Update-AzNetAppFilesBackup.md) +[Get-AzNetAppFilesBackupPolicy](./Get-AzNetAppFilesBackupPolicy.md) +[New-AzNetAppFilesBackupPolicy](./New-AzNetAppFilesBackupPolicy.md) +[Update-AzNetAppFilesBackupPolicy](./Update-AzNetAppFilesBackupPolicy.md) +[Remove-AzNetAppFilesBackupPolicy](./Remove-AzNetAppFilesBackupPolicy.md) +[Get-AzNetAppFilesVault](./Get-AzNetAppFilesVault.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesBackupPolicy.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesBackupPolicy.md new file mode 100644 index 0000000000..04b02706fe --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesBackupPolicy.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesbackuppolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesBackupPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesBackupPolicy.md +--- + +# Get-AzNetAppFilesBackupPolicy + +## SYNOPSIS +Gets details of an Azure NetApp Files (ANF) Backup Policy. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesBackupPolicy -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesBackupPolicy [-Name <String>] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesBackupPolicy [-Name <String>] -AccountObject <PSNetAppFilesAccount> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesBackupPolicy** cmdlet gets details of an ANF backup policy. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetAppFilesBackupPolicy -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -Name "MyBackupPolicy" +``` + +This command gets the backup policy named "MyBackupPolicy" for account "MyAnfAccount". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account object containing the Backup Policy to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF backup policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BackupPolicyName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Backup Policy + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesBackupPolicy](./New-AzNetAppFilesBackupPolicy.md) +[Update-AzNetAppFilesBackupPolicy](./Update-AzNetAppFilesBackupPolicy.md) +[Remove-AzNetAppFilesBackupPolicy](./Remove-AzNetAppFilesBackupPolicy.md) +[Set-AzNetAppFilesBackupPolicy](./Set-AzNetAppFilesBackupPolicy.md) +[Get-AzNetAppFilesBackup](./Get-AzNetAppFilesBackup.md) +[New-AzNetAppFilesBackup](./New-AzNetAppFilesBackup.md) +[Remove-AzNetAppFilesBackup](./Remove-AzNetAppFilesBackup.md) +[Update-AzNetAppFilesBackup](./Update-AzNetAppFilesBackup.md) +[Get-AzNetAppFilesVault](./Get-AzNetAppFilesVault.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesPool.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesPool.md new file mode 100644 index 0000000000..00e64718b3 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesPool.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilespool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesPool.md +--- + +# Get-AzNetAppFilesPool + +## SYNOPSIS +Gets details of an Azure NetApp Files (ANF) pool. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesPool -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesPool -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesPool -AccountObject <PSNetAppFilesAccount> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesPool** cmdlet gets details of an ANF pool. + +## EXAMPLES + +### Example 1: Get an ANF pool +```powershell +Get-AzNetAppFilesPool -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -Name "MyAnfPool" +``` + +```output +Location : westus2 +Id : /subscriptions/subsID/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount/capacityPools/MyAnfPool +Name : MyAnfAccount/MyAnfPool +Type : Microsoft.NetApp/netAppAccounts/capacityPools +Tags : +PoolId : a3a53a09-fd70-37ab-39dc-392a04cba525 +Size : 4398046511104 +ServiceLevel : Premium +TotalThroughputMibps: 262.144 +UtilizedThroughputMibps: 164.221 +QosType : Auto +ProvisioningState : Succeeded +``` + +This command gets the account named MyAnfPool from the account "MyAnfAccount". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The account object containing the pool to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: PoolName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesPool](./New-AzNetAppFilesPool.md) +[Remove-AzNetAppFilesPool](./Remove-AzNetAppFilesPool.md) +[Set-AzNetAppFilesPool](./Set-AzNetAppFilesPool.md) +[Update-AzNetAppFilesPool](./Update-AzNetAppFilesPool.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesQuotaLimit.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesQuotaLimit.md new file mode 100644 index 0000000000..d029e0c390 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesQuotaLimit.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesquotalimit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesQuotaLimit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesQuotaLimit.md +--- + +# Get-AzNetAppFilesQuotaLimit + +## SYNOPSIS +Get quota limits + +## SYNTAX + +``` +Get-AzNetAppFilesQuotaLimit -Location <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the default and current limits for Azure NetApp Files (ANF) quotas + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetAppFilesQuotaLimit -Location "westus2" -Name totalTiBsPerSubscription +``` + +```output +Name Current Default +---- ------- ------- +westus2/totalTiBsPerSubscription 25 25 +``` + +This command gets the Quota Limits named totalTiBsPerSubscription + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Quota Limit + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: QuotaLimitName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSubscriptionQuotaLimit + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesReplicationStatus.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesReplicationStatus.md new file mode 100644 index 0000000000..d259eb3cca --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesReplicationStatus.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesreplicationstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesReplicationStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesReplicationStatus.md +--- + +# Get-AzNetAppFilesReplicationStatus + +## SYNOPSIS +Get the status of the replication + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesReplicationStatus -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesReplicationStatus -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Get-AzNetAppFilesReplicationStatus -InputObject <PSNetAppFilesVolume> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the status of the replication + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetAppFilesReplicationStatus -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyVol" +``` + +```output +Healthy : true +RelationshipStatus : Idle +MirrorState : Mirrored +TotalProgress : 1024 +ErrorMessage : +``` + +This command gets the status of replication on MyVol + +## PARAMETERS + +### -AccountName +The name of the ANF account of the replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The ANF replication destination volume object to get replication status + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool of the replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesReplicationStatus + +## NOTES + +## RELATED LINKS + +[Approve-AzNetAppFilesReplication](./Approve-AzNetAppFilesReplication.md) +[Initialize-AzNetAppFilesReplication](./Initialize-AzNetAppFilesReplication.md) +[Suspend-AzNetAppFilesReplication](./Suspend-AzNetAppFilesReplication.md) +[Resume-AzNetAppFilesReplication](./Resume-AzNetAppFilesReplication.md) +[Remove-AzNetAppFilesReplication](./Remove-AzNetAppFilesReplication.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesSnapshot.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesSnapshot.md new file mode 100644 index 0000000000..bcc1e91c34 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesSnapshot.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilessnapshot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesSnapshot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesSnapshot.md +--- + +# Get-AzNetAppFilesSnapshot + +## SYNOPSIS +Gets details of an Azure NetApp Files (ANF) snapshot. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesSnapshot -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -VolumeName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesSnapshot [-Name <String>] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesSnapshot [-Name <String>] -VolumeObject <PSNetAppFilesVolume> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesSnapshot** cmdlet gets details of an ANF snapshot. + +## EXAMPLES + +### Example 1: Get an ANF snapshot +```powershell +Get-AzNetAppFilesSnapshot -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSnapshot" +``` + +```output +ResourceGroupName : MyRG +Location : westus2 +Id : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount/capacityPools/MyAnfPool/volumes/MyAnfVolume/snapshots/MyAnfSnapshot +Name : MyAnfAccount/MyAnfPool/MyAnfVolume/MyAnfSnapshot +Type : Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots +Tags : +FileSystemId : 3e2773a7-2a72-d003-0637-1a8b1fa3eaaf +SnapshotId : ca7c4ebd-91cb-0e30-91f5-9154050033df +Created : +ProvisioningState : Succeeded +``` + +This command gets the snapshot named MyAnfSnapshot from the volume "MyAnfVolume". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF snapshot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SnapshotName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF snapshot + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the snapshot to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshot + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesSnapshot](./New-AzNetAppFilesSnapshot.md) +[Remove-AzNetAppFilesSnapshot](./Remove-AzNetAppFilesSnapshot.md) +[Get-AzNetAppFilesSnapshotPolicy](./Get-AzNetAppFilesSnapshotPolicy.md) +[New-AzNetAppFilesSnapshotPolicy](./New-AzNetAppFilesSnapshotPolicy.md) +[Update-AzNetAppFilesSnapshotPolicy](./Update-AzNetAppFilesSnapshotPolicy.md) +[Remove-AzNetAppFilesSnapshotPolicy](./Remove-AzNetAppFilesSnapshotPolicy.md) +[Set-AzNetAppFilesSnapshotPolicy](./Set-AzNetAppFilesSnapshotPolicy.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesSnapshotPolicy.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesSnapshotPolicy.md new file mode 100644 index 0000000000..069a6e6ee6 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesSnapshotPolicy.md @@ -0,0 +1,197 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilessnapshotpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesSnapshotPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesSnapshotPolicy.md +--- + +# Get-AzNetAppFilesSnapshotPolicy + +## SYNOPSIS +Gets details of an Azure NetApp Files (ANF) snapshot policy. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesSnapshotPolicy -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesSnapshotPolicy -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesSnapshotPolicy -AccountObject <PSNetAppFilesAccount> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesSnapshotPolicy** cmdlet gets details of an ANF snapshot policy. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetAppFilesSnapshotPolicy -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -Name "MySnapshotPolicy" +``` + +This command gets the backup policy named "MyBackupPolicy" for account "MyAnfAccount". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account for the new Snapshot Policy object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF snapshot policy + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: SnapshotPolicyName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Snapshot Policy + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshotPolicy + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesSnapshotPolicy](./New-AzNetAppFilesSnapshotPolicy.md) +[Update-AzNetAppFilesSnapshotPolicy](./Update-AzNetAppFilesSnapshotPolicy.md) +[Remove-AzNetAppFilesSnapshotPolicy](./Remove-AzNetAppFilesSnapshotPolicy.md) +[Set-AzNetAppFilesSnapshotPolicy](./Set-AzNetAppFilesSnapshotPolicy.md) +[Get-AzNetAppFilesSnapshot](./Get-AzNetAppFilesSnapshot.md) +[New-AzNetAppFilesSnapshot](./New-AzNetAppFilesSnapshot.md) +[Remove-AzNetAppFilesSnapshot](./Remove-AzNetAppFilesSnapshot.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesSubvolume.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesSubvolume.md new file mode 100644 index 0000000000..93b32909e6 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesSubvolume.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilessubvolume +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesSubvolume.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesSubvolume.md +--- + +# Get-AzNetAppFilesSubvolume + +## SYNOPSIS +Gets details of an Azure NetApp Files (ANF) subvolume. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesSubvolume -ResourceGroupName <String> -AccountName <String> -PoolName <String> + [-VolumeName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesSubvolume [-Name <String>] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesSubvolume [-Name <String>] -VolumeObject <PSNetAppFilesVolume> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesSubvolume** cmdlet gets details of an ANF Subvolume. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetAppFilesSubvolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSubvolume" +``` + +```output +ResourceGroupName : myrg +Id : /subscriptions/69a75bda-882e-44d5-8431-63421204132a/resourceGroups/myrg/providers/Microsoft.NetApp/netAppAccounts/myanfaccount/capacityPools/myanfpool/volumes/myanfvolume/subvolumes/myanfsubvolume +Name : myanfaccount/myanfpool/myanfvolume/myanfsubvolume +Type : Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes +Etag : +Path : /subvolumePath +Size : +ParentPath : +ProvisioningState : Succeeded +``` + +The **Get-AzNetAppFilesSubvolume** cmdlet gets details of an ANF Subvolume. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF Subvolume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SubvolumeName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF Subvolume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Subvolume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the Subvolume to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesSubvolume](./New-AzNetAppFilesSubvolume.md) +[Update-AzNetAppFilesSubvolume](./Update-AzNetAppFilesSubvolume.md) +[Remove-AzNetAppFilesSubvolume](./Remove-AzNetAppFilesSubvolume.md) +[Get-AzNetAppFilesSubvolumeMetadata](./Get-AzNetAppFilesSubvolumeMetadata.md) diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesSubvolumeMetadata.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesSubvolumeMetadata.md new file mode 100644 index 0000000000..0f903bce5b --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesSubvolumeMetadata.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilessubvolumemetadata +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesSubvolumeMetadata.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesSubvolumeMetadata.md +--- + +# Get-AzNetAppFilesSubvolumeMetadata + +## SYNOPSIS +Gets metadata details of an Azure NetApp Files (ANF) subvolume. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesSubvolumeMetadata -ResourceGroupName <String> -AccountName <String> -PoolName <String> + [-VolumeName <String>] -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesSubvolumeMetadata -Name <String> -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesSubvolumeMetadata -Name <String> -VolumeObject <PSNetAppFilesVolume> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesSubvolumeMetadata** cmdlet gets metadata details of an ANF Subvolume. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetAppFilesSubvolumeMetadata -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSubvolume" +``` + +```output +ResourceGroupName : myrg +Id : /subscriptions/69a75bda-882e-44d5-8431-63421204132a/resourceGroups/myrg/providers/Microsoft.NetApp/netAppAccounts/myanfaccount/capacityPools/myanfpool/volumes/myanfvolume/subvolumes/myanfsubvolume +Name : myanfaccount/myanfpool/myanfvolume/myanfsubvolume +Type : Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes +Path : /subvolumePath +ParentPath : +Size : 5 +BytesUsed : 0 +Permissions : 644 +CreationTimeStamp : 28/04/2022 15:49:24 +AccessedTimeStamp : 28/04/2022 15:49:23 +ModifiedTimeStamp : 28/04/2022 15:49:24 +ChangedTimeStamp : 28/04/2022 15:49:24 +ProvisioningState : Succeeded +``` + +The gets details of the MyAnfSubvolume Subvolume metadata. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF Subvolume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SubvolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF Subvolume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Subvolume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the Subvolume Metadata to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesSubvolume](./New-AzNetAppFilesSubvolume.md) +[Update-AzNetAppFilesSubvolume](./Update-AzNetAppFilesSubvolume.md) +[Remove-AzNetAppFilesSubvolume](./Remove-AzNetAppFilesSubvolume.md) +[Get-AzNetAppFilesSubvolume](./Get-AzNetAppFilesSubvolume.md) diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolume.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolume.md new file mode 100644 index 0000000000..89e95a51b7 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolume.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesvolume +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolume.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolume.md +--- + +# Get-AzNetAppFilesVolume + +## SYNOPSIS +Gets details of an Azure NetApp Files (ANF) volume. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesVolume -ResourceGroupName <String> -AccountName <String> -PoolName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesVolume -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesVolume -PoolObject <PSNetAppFilesPool> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesVolume** cmdlet gets details of an ANF volume. + +## EXAMPLES + +### Example 1: Get an ANF volume +```powershell +Get-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" +``` + +```output +ResourceGroupName : MyRG +Location : westus2 +Id : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount/capacityPools/MyAnfPool/volumes/MyAnfVolume +Name : MyAnfAccount/MyAnfPool/MyAnfVolume +Type : Microsoft.NetApp/netAppAccounts/capacityPools/volumes +Tags : +FileSystemId : 3e2773a7-2a72-d003-0637-1a8b1fa3eaaf +CreationToken : +ServiceLevel : Premium +UsageThreshold : 1099511627776 +ProvisioningState : Succeeded +SubnetId : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyRG-vnet/subnets/default +``` + +This command gets the volume named MyAnfVolume from the pool "MyAnfPool". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: VolumeName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolObject +The pool object containing the volume to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) +[Restore-AzNetAppFilesVolume](./Restore-AzNetAppFilesVolume.md) +[Set-AzNetAppFilesVolumePool](./Set-AzNetAppFilesVolumePool.md) +[Get-AzNetAppFilesVolumeBackupStatus](./Get-AzNetAppFilesVolumeBackupStatus.md) +[Get-AzNetAppFilesVolumeRestoreStatus](./Get-AzNetAppFilesVolumeRestoreStatus.md) +[Approve-AzNetAppFilesReplication](./Approve-AzNetAppFilesReplication.md) +[Initialize-AzNetAppFilesReplication](./Initialize-AzNetAppFilesReplication.md) +[Resume-AzNetAppFilesReplication](./Resume-AzNetAppFilesReplication.md) +[Remove-AzNetAppFilesReplication](./Remove-AzNetAppFilesReplication.md) diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeBackupStatus.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeBackupStatus.md new file mode 100644 index 0000000000..45136264be --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeBackupStatus.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesvolumebackupstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeBackupStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeBackupStatus.md +--- + +# Get-AzNetAppFilesVolumeBackupStatus + +## SYNOPSIS +Get volume's backup status + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesVolumeBackupStatus -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesVolumeBackupStatus -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesVolumeBackupStatus -PoolObject <PSNetAppFilesPool> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Get-AzNetAppFilesVolumeBackupStatus -InputObject <PSNetAppFilesVolume> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesVolumeBackupStatus** cmdLet gets the status of the backup for a volume + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetAppFilesVolumeBackupStatus -ResourceGroupName MyGroup -AccountName MyAccount -PoolName MyPool -Name MyVolume +``` + +This command gets the status of a backup of volume named "MyVolume". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The volume object to get backup status for + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolObject +The pool object containing the volume to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolumeBackupStatus + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesBackup](./New-AzNetAppFilesBackup.md) +[Remove-AzNetAppFilesBackup](./Remove-AzNetAppFilesBackup.md) +[Update-AzNetAppFilesBackup](./Update-AzNetAppFilesBackup.md) +[Get-AzNetAppFilesBackupPolicy](./Get-AzNetAppFilesBackupPolicy.md) +[New-AzNetAppFilesBackupPolicy](./New-AzNetAppFilesBackupPolicy.md) +[Update-AzNetAppFilesBackupPolicy](./Update-AzNetAppFilesBackupPolicy.md) +[Remove-AzNetAppFilesBackupPolicy](./Remove-AzNetAppFilesBackupPolicy.md) +[Set-AzNetAppFilesBackupPolicy](./Set-AzNetAppFilesBackupPolicy.md) +[Get-AzNetAppFilesVault](./Get-AzNetAppFilesVault.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeGroup.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeGroup.md new file mode 100644 index 0000000000..f526fc0b10 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeGroup.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesvolumegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeGroup.md +--- + +# Get-AzNetAppFilesVolumeGroup + +## SYNOPSIS +Gets details of an Azure NetApp Files (ANF) VolumeGroup. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesVolumeGroup -ResourceGroupName <String> -AccountName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesVolumeGroup [-Name <String>] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesVolumeGroup [-Name <String>] -AccountObject <PSNetAppFilesAccount> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesVolumeGroup** cmdlet gets details of an ANF VolumeGroup. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetAppFilesVolumeGroup -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -Name "MyAnfVolumeGroup" +``` + +This command gets the volume named MyAnfVolumeGroup from the Account "MyAnfAccount". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account object containing the VolumeGroup to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF VolumeGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VolumeGroupName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF VolumeGroup + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF VolumeGroup + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolumeGroupDetail + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesVolumeGroup](./New-AzNetAppFilesVolumeGroup.md) +[Remove-AzNetAppFilesVolumeGroup](./Remove-AzNetAppFilesVolumeGroup.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeQuotaRule.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeQuotaRule.md new file mode 100644 index 0000000000..51a9152a4f --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeQuotaRule.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesvolumequotarule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeQuotaRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeQuotaRule.md +--- + +# Get-AzNetAppFilesVolumeQuotaRule + +## SYNOPSIS +Gets details of an Azure NetApp Files (ANF) Volume Quouta Rule. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesVolumeQuotaRule -ResourceGroupName <String> -AccountName <String> -PoolName <String> + [-VolumeName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesVolumeQuotaRule [-Name <String>] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesVolumeQuotaRule [-Name <String>] -VolumeObject <PSNetAppFilesVolume> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesVolumeQuotaRule** cmdlet gets details of an ANF Volume Quota Rule. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetAppFilesVolumeQuotaRule -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -VolumeName "MyAnfVolume" -Name "MyVolumeQuotaRuleName" +``` + +This command gets the volume quota rule named MyVolumeQuotaRuleName from the Volume "MyAnfVolume". + +## PARAMETERS + +### -AccountName +This command deletes the ANF volume quota rule "MyVolumeQuotaRuleName" . + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF Subvolume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SubvolumeName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF VolumeQuotaRule + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF VolumeQuotaRule + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the VolumeQuotaRule to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeReplication.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeReplication.md new file mode 100644 index 0000000000..9f01e492cf --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeReplication.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesvolumereplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeReplication.md +--- + +# Get-AzNetAppFilesVolumeReplication + +## SYNOPSIS +Get volume's replication + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesVolumeReplication -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesVolumeReplication -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesVolumeReplication -PoolObject <PSNetAppFilesPool> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesVolumeRestoreStatus** cmdLet gets the Replications for a volume + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetAppFilesVolumeReplication -ResourceGroupName MyGroup -AccountName MyAccount -PoolName MyPool -Name MyVolume +``` + +This command gets the Replications for a volume named "MyVolume". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolObject +The pool object containing the volume to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeRestoreStatus.md b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeRestoreStatus.md new file mode 100644 index 0000000000..01c76559d7 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Get-AzNetAppFilesVolumeRestoreStatus.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesvolumerestorestatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeRestoreStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeRestoreStatus.md +--- + +# Get-AzNetAppFilesVolumeRestoreStatus + +## SYNOPSIS +Get volume's restore status + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Get-AzNetAppFilesVolumeRestoreStatus -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzNetAppFilesVolumeRestoreStatus -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzNetAppFilesVolumeRestoreStatus -PoolObject <PSNetAppFilesPool> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Get-AzNetAppFilesVolumeRestoreStatus -InputObject <PSNetAppFilesVolume> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetAppFilesVolumeRestoreStatus** cmdLet gets the status of the restore from a backup of a volume + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetAppFilesVolumeRestoreStatus -ResourceGroupName MyGroup -AccountName MyAccount -PoolName MyPool -Name MyVolume +``` + +This command gets the status of a restore from backup of volume named "MyVolume". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The volume object to get Restore status for + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolObject +The pool object containing the volume to return restore status for + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolumeRestoreStatus + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesBackup](./New-AzNetAppFilesBackup.md) +[Remove-AzNetAppFilesBackup](./Remove-AzNetAppFilesBackup.md) +[Update-AzNetAppFilesBackup](./Update-AzNetAppFilesBackup.md) +[Get-AzNetAppFilesBackupPolicy](./Get-AzNetAppFilesBackupPolicy.md) +[New-AzNetAppFilesBackupPolicy](./New-AzNetAppFilesBackupPolicy.md) +[Update-AzNetAppFilesBackupPolicy](./Update-AzNetAppFilesBackupPolicy.md) +[Remove-AzNetAppFilesBackupPolicy](./Remove-AzNetAppFilesBackupPolicy.md) +[Set-AzNetAppFilesBackupPolicy](./Set-AzNetAppFilesBackupPolicy.md) +[Get-AzNetAppFilesVault](./Get-AzNetAppFilesVault.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Initialize-AzNetAppFilesReplication.md b/azps-10.1.0/Az.NetAppFiles/Initialize-AzNetAppFilesReplication.md new file mode 100644 index 0000000000..d3ee0ade5e --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Initialize-AzNetAppFilesReplication.md @@ -0,0 +1,226 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/initialize-aznetappfilesreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Initialize-AzNetAppFilesReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Initialize-AzNetAppFilesReplication.md +--- + +# Initialize-AzNetAppFilesReplication + +## SYNOPSIS +Re-Initializes the replication connection on the destination volume + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Initialize-AzNetAppFilesReplication -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Initialize-AzNetAppFilesReplication -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Initialize-AzNetAppFilesReplication -InputObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Re-Initializes the connection on the destination volume + +## EXAMPLES + +### Example 1 +```powershell +Initialize-AzNetAppFilesReplication -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyDestinationAnfVolume" +``` + +This command Re-Initializes the ANF Replication connection on volume "MyDestinationAnfVolume". + +## PARAMETERS + +### -AccountName +The name of the ANF account of the replication volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The ANF replication destination volume object to resync + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether resync of the specified replication volume was performed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool of the replication volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Approve-AzNetAppFilesReplication](./Approve-AzNetAppFilesReplication.md) +[Suspend-AzNetAppFilesReplication](./Suspend-AzNetAppFilesReplication.md) +[Resume-AzNetAppFilesReplication](./Resume-AzNetAppFilesReplication.md) +[Remove-AzNetAppFilesReplication](./Remove-AzNetAppFilesReplication.md) +[Get-AzNetAppFilesReplicationStatus](./Get-AzNetAppFilesReplicationStatus.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesAccount.md b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesAccount.md new file mode 100644 index 0000000000..d03d0722d0 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesAccount.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilesaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesAccount.md +--- + +# New-AzNetAppFilesAccount + +## SYNOPSIS +Creates a new Azure NetApp Files (ANF) account. + +## SYNTAX + +``` +New-AzNetAppFilesAccount -ResourceGroupName <String> -Location <String> -Name <String> + [-ActiveDirectory <PSNetAppFilesActiveDirectory[]>] [-Encryption <PSNetAppFilesAccountEncryption>] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetAppFilesAccount** cmdlet creates an ANF account. + +## EXAMPLES + +### Example 1: Create an ANF account +```powershell +New-AzNetAppFilesAccount -ResourceGroupName "MyRG" -Name "MyAnfAccount" -Location "westus2" +``` + +```output +Location : westus2 +Id : /subscriptions/mySubs/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount +Name : MyAnfAccount +Type : Microsoft.NetApp/netAppAccounts +Tags : +ProvisioningState : Succeeded +``` + +This command creates the new ANF account "MyAnfAccount". + +## PARAMETERS + +### -ActiveDirectory +A hashtable array which represents the active directories + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesActiveDirectory[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Encryption +A hashtable which represents the Encryption settings + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccountEncryption +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesAccount](./Get-AzNetAppFilesAccount.md) +[Remove-AzNetAppFilesAccount](./Remove-AzNetAppFilesAccount.md) +[Set-AzNetAppFilesAccount](./Set-AzNetAppFilesAccount.md) +[Update-AzNetAppFilesAccount](./Update-AzNetAppFilesAccount.md) +[Get-AzNetAppFilesActiveDirectory](./Get-AzNetAppFilesActiveDirectory.md) +[New-AzNetAppFilesActiveDirectory](./New-AzNetAppFilesActiveDirectory.md) +[Remove-AzNetAppFilesActiveDirectory](./Remove-AzNetAppFilesActiveDirectory.md) +[Update-AzNetAppFilesActiveDirectory](./Update-AzNetAppFilesActiveDirectory.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesActiveDirectory.md b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesActiveDirectory.md new file mode 100644 index 0000000000..c691451ded --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesActiveDirectory.md @@ -0,0 +1,471 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilesactivedirectory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesActiveDirectory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesActiveDirectory.md +--- + +# New-AzNetAppFilesActiveDirectory + +## SYNOPSIS +Creates a new Azure NetApp Files (ANF) active directory configuration. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzNetAppFilesActiveDirectory -ResourceGroupName <String> -AccountName <String> [-Dns <String[]>] + -Domain <String> [-Site <String>] -SmbServerName <String> [-Username <String>] [-Password <SecureString>] + [-OrganizationalUnit <String>] [-KdcIP <String>] [-BackupOperator <String[]>] + [-ServerRootCACertificate <String>] [-AdName <String>] [-SecurityOperator <String[]>] [-AesEncryption] + [-LdapSigning] [-LdapOverTLS] [-AllowLocalNfsUsersWithLdap] [-Administrator <String[]>] [-EncryptDCConnection] + [-LdapSearchScope <PSNetAppFilesLdapSearchScopeOpt>] [-PreferredServersForLdapClient <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzNetAppFilesActiveDirectory [-Dns <String[]>] -Domain <String> [-Site <String>] -SmbServerName <String> + [-Username <String>] [-Password <SecureString>] [-OrganizationalUnit <String>] [-KdcIP <String>] + [-BackupOperator <String[]>] [-ServerRootCACertificate <String>] [-AdName <String>] + [-SecurityOperator <String[]>] [-AesEncryption] [-LdapSigning] [-LdapOverTLS] [-AllowLocalNfsUsersWithLdap] + [-Administrator <String[]>] [-EncryptDCConnection] [-LdapSearchScope <PSNetAppFilesLdapSearchScopeOpt>] + [-PreferredServersForLdapClient <String[]>] -AccountObject <PSNetAppFilesAccount> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetAppFilesActiveDirectory** cmdlet creates a new active directory configuration for an ANF account. + +## EXAMPLES + +### Example 1 +```powershell +$pwd_secure_string = Read-Host "Enter a Password" -AsSecureString +New-AzNetAppFilesActiveDirectory -ResourceGroupName "MyRG" -AccountName "MyAccount" -AdName "MyADName" -Username "AdUserName" -Password $pwd_secure_string -Domain "AdDomain" -Dns "192.0.2.2" -SmbServerName "AdSmbServerName" +``` + +This command gets the AD password from promt into a secreates the new Active Directory configuration for the ANF account "MyAnfAccount". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account for the new Backup Policy object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Administrator +Domain Users to be added to the Built-in Administrators Active Directory group. A list of unique usernames without domain specifier. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdName +Name of the active directory machine. +This optional parameter is used only while creating kerberos volume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AesEncryption +When AES is enabled, set if AES encryption will be enabled for SMB communication. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLocalNfsUsersWithLdap +If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupOperator +Users to be added to the Built-in Backup Operator active directory group. +A list of unique usernames without domain specifier + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Dns +Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +Name of the Active Directory domain + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptDCConnection +If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KdcIP +kdc server IP addresses for the active directory machine. +This optional parameter is used only while creating kerberos volume. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapOverTLS +When LDAP over SSL/TLS is enabled, specifies whether or not the LDAP traffic needs to be secured via TLS. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapSearchScope +LDAP Search scope options. + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesLdapSearchScopeOpt +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapSigning +When LDAP over SSL/TLS is enabled, Specifies whether or not the LDAP traffic needs to be signed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The Organizational Unit (OU) within the Windows Active Directory + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Plain text password of Active Directory domain administrator, value is masked in the response + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredServersForLdapClient +Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityOperator +Domain Users in the Active directory to be given Security Privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerRootCACertificate +When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Site +The Active Directory site the service will limit Domain Controller discovery to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmbServerName +NetBIOS name of the SMB server. +This name will be registered as a computer account in the AD and used to mount volumes + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Username +A domain user account with permission to create machine accounts + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesActiveDirectory + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesActiveDirectory](./Get-AzNetAppFilesActiveDirectory.md) +[Remove-AzNetAppFilesActiveDirectory](./Remove-AzNetAppFilesActiveDirectory.md) +[Update-AzNetAppFilesActiveDirectory](./Update-AzNetAppFilesActiveDirectory.md) +[Get-AzNetAppFilesAccount](./Get-AzNetAppFilesAccount.md) +[New-AzNetAppFilesAccount](./New-AzNetAppFilesAccount.md) +[Remove-AzNetAppFilesAccount](./Remove-AzNetAppFilesAccount.md) +[Set-AzNetAppFilesAccount](./Set-AzNetAppFilesAccount.md) +[Update-AzNetAppFilesAccount](./Update-AzNetAppFilesAccount.md) diff --git a/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesBackup.md b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesBackup.md new file mode 100644 index 0000000000..21e4dac00c --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesBackup.md @@ -0,0 +1,251 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilesbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesBackup.md +--- + +# New-AzNetAppFilesBackup + +## SYNOPSIS +Creates a new Azure NetApp Files (ANF) backup. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzNetAppFilesBackup -ResourceGroupName <String> -Location <String> -AccountName <String> -PoolName <String> + -VolumeName <String> -Name <String> -Label <String> [-UseExistingSnapshot] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzNetAppFilesBackup -Name <String> -Label <String> [-UseExistingSnapshot] + -VolumeObject <PSNetAppFilesVolume> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetAppFilesBackup** cmdlet creates a backup for an ANF volume. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetAppFilesBackup -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAccount" -PoolName "MyPool" -VolumeName "MyVolume" -Name "MyVolumeBackup" -Label "ALabel" +``` + +This command creates the new ANF backup for volume named account "MyVolume". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +Label for backup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF backup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BackupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseExistingSnapshot +Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume for the new backup object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesBackup](./Get-AzNetAppFilesBackup.md) +[Remove-AzNetAppFilesBackup](./Remove-AzNetAppFilesBackup.md) +[Update-AzNetAppFilesBackup](./Update-AzNetAppFilesBackup.md) +[Get-AzNetAppFilesBackupPolicy](./Get-AzNetAppFilesBackupPolicy.md) +[New-AzNetAppFilesBackupPolicy](./New-AzNetAppFilesBackupPolicy.md) +[Update-AzNetAppFilesBackupPolicy](./Update-AzNetAppFilesBackupPolicy.md) +[Remove-AzNetAppFilesBackupPolicy](./Remove-AzNetAppFilesBackupPolicy.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesBackupPolicy.md b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesBackupPolicy.md new file mode 100644 index 0000000000..c20f0d52c5 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesBackupPolicy.md @@ -0,0 +1,269 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilesbackuppolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesBackupPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesBackupPolicy.md +--- + +# New-AzNetAppFilesBackupPolicy + +## SYNOPSIS +Creates a new Azure NetApp Files (ANF) backup policy for an ANF account. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzNetAppFilesBackupPolicy -ResourceGroupName <String> -Location <String> -AccountName <String> + -Name <String> [-Enabled] [-DailyBackupsToKeep <Int32>] [-WeeklyBackupsToKeep <Int32>] + [-MonthlyBackupsToKeep <Int32>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzNetAppFilesBackupPolicy -Name <String> [-Enabled] [-DailyBackupsToKeep <Int32>] + [-WeeklyBackupsToKeep <Int32>] [-MonthlyBackupsToKeep <Int32>] [-Tag <Hashtable>] + -AccountObject <PSNetAppFilesAccount> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetAppFilesBackupPolicy** cmdlet creates a new backup policy for an ANF account. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetAppFilesBackupPolicy -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAccount" -Name "MyBackupPolicy" -Tag @{"tag1" = "tagValue"} -Enabled -DailyBackupsToKeep 1 -WeeklyBackupsToKeep 2 -MonthlyBackupsToKeep 2 +``` + +This command creates the new ANF backup policy for ANF account named account "MyAccount". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account object for the new Backup Policy + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DailyBackupsToKeep +Daily backups count to keep + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The property to decide policy is enabled or not + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonthlyBackupsToKeep +Monthly backups count to keep + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF backup policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BackupPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable array which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeeklyBackupsToKeep +Weekly backups count to keep + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesBackupPolicy](./Get-AzNetAppFilesBackupPolicy.md) +[Update-AzNetAppFilesBackupPolicy](./Update-AzNetAppFilesBackupPolicy.md) +[Remove-AzNetAppFilesBackupPolicy](./Remove-AzNetAppFilesBackupPolicy.md) +[Set-AzNetAppFilesBackupPolicy](./Set-AzNetAppFilesBackupPolicy.md) +[Get-AzNetAppFilesBackup](./Get-AzNetAppFilesBackup.md) +[New-AzNetAppFilesBackup](./New-AzNetAppFilesBackup.md) +[Remove-AzNetAppFilesBackup](./Remove-AzNetAppFilesBackup.md) +[Update-AzNetAppFilesBackup](./Update-AzNetAppFilesBackup.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesExportPolicyObject.md b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesExportPolicyObject.md new file mode 100644 index 0000000000..d956440a69 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesExportPolicyObject.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilesexportpolicyobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesExportPolicyObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesExportPolicyObject.md +--- + +# New-AzNetAppFilesExportPolicyObject + +## SYNOPSIS +Creates export policy object. + +## SYNTAX + +``` +New-AzNetAppFilesExportPolicyObject -Rule <PSNetAppFilesExportPolicyRule[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +New-AzNetAppFilesExportPolicyObject is a helper cmdlet that creates an export policy object that can be used with New-AzNetAppFilesVolume. +Each ExportPolicy object consists of a set of ExportPolicy rules that can be applied to an ANF volume. + +## EXAMPLES + +### Example 1 +```powershell +$exportPolicyRule = New-AzNetAppFilesExportPolicyRuleObject -RuleIndex 1 -AllowedClient '0.0.0.0/0' -UnixReadOnly -UnixReadWrite -Cifs -Nfsv3 +$exportPolicyRules = $($exportPolicyRule) +$newExportPolicy = New-AzNetAppFilesExportPolicyObject -Rule $exportPolicyRules +New-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" -Location "westus2" -CreationToken "MyAnfVolume" -UsageThreshold 1099511627776 -ServiceLevel "Premium" -SubnetId "/subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyVnetName/subnets/MySubNetName" -ExportPolicy $newExportPolicy +``` + +This example creates an ExportPolicyRule in variable $exportPolicyRule, sets it an export policy object $exportPolicyRules that is then used in the creation of an AFN volume "MyAnfVolume"" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +List of items which need to be included into endpont scope. + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesExportPolicyRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolumeExportPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesExportPolicyRuleObject.md b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesExportPolicyRuleObject.md new file mode 100644 index 0000000000..21c6a1debb --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesExportPolicyRuleObject.md @@ -0,0 +1,332 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilesexportpolicyruleobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesExportPolicyRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesExportPolicyRuleObject.md +--- + +# New-AzNetAppFilesExportPolicyRuleObject + +## SYNOPSIS +Creates export policy rule object. + +## SYNTAX + +``` +New-AzNetAppFilesExportPolicyRuleObject -RuleIndex <Int32> [-UnixReadOnly] [-UnixReadWrite] + [-Kerberos5ReadOnly] [-Kerberos5ReadWrite] [-Kerberos5iReadOnly] [-Kerberos5iReadWrite] [-Kerberos5p] + [-Kerberos5pReadWrite] [-Cifs] [-Nfsv3] [-Nfsv41] [-AllowedClient <String>] [-HasRootAccess] + [-ChownMode <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +New-AzNetAppFilesExportPolicyRuleObject is a helper cmdlet that creates an export policy rule object that can be used with New-AzExportPolicyObject and New-AzNetAppFilesVolume. + +## EXAMPLES + +### Example 1 +```powershell +$exportPolicyRule = New-AzNetAppFilesExportPolicyRuleObject -RuleIndex 1 -AllowedClient '0.0.0.0/0' -UnixReadOnly -UnixReadWrite -Cifs -Nfsv3 +$exportPolicyRules = $($exportPolicyRule) +$newExportPolicy = New-AzNetAppFilesExportPolicyObject -Rule $exportPolicyRules +New-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" -Location "westus2" -CreationToken "MyAnfVolume" -UsageThreshold 1099511627776 -ServiceLevel "Premium" -SubnetId "/subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyVnetName/subnets/MySubNetName" -ExportPolicy $newExportPolicy +``` + +This example creates an ExportPolicyRule in variable $exportPolicyRule, sets it an export policy object $exportPolicyRules that is then used in the creation of an AFN volume "MyAnfVolume"" + +## PARAMETERS + +### -AllowedClient +Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChownMode +Specifies who is authorized to change the ownership of a file. +restricted - Only root user can change the ownership of the file. +unrestricted - Non-root users can change ownership of files that they own. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cifs +Allows CIFS protocol. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasRootAccess +Has root access to volume. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kerberos5iReadOnly +Kerberos5i Read only access. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kerberos5iReadWrite +Kerberos5i Read and write access. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kerberos5p +Kerberos5p Read only access. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kerberos5pReadWrite +Kerberos5p Read and write access. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kerberos5ReadOnly +Kerberos5 Read only access. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kerberos5ReadWrite +Kerberos5 Read and write access. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Nfsv3 +Allows NFSv3 protocol. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Nfsv41 +Allows NFSv41 protocol. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleIndex +Order index. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnixReadOnly +Read only access. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnixReadWrite +Read and write access. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesExportPolicyRule + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesPool.md b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesPool.md new file mode 100644 index 0000000000..da3397ead9 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesPool.md @@ -0,0 +1,289 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilespool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesPool.md +--- + +# New-AzNetAppFilesPool + +## SYNOPSIS +Creates a new Azure NetApp Files (ANF) pool. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzNetAppFilesPool -ResourceGroupName <String> -Location <String> -AccountName <String> -Name <String> + -PoolSize <Int64> -ServiceLevel <String> [-QosType <String>] [-CoolAccess] [-EncryptionType <String>] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzNetAppFilesPool -Name <String> -PoolSize <Int64> -ServiceLevel <String> [-QosType <String>] [-CoolAccess] + [-EncryptionType <String>] [-Tag <Hashtable>] -AccountObject <PSNetAppFilesAccount> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetAppFilesPool** cmdlet creates an ANF pool. + +## EXAMPLES + +### Example 1: Create an ANF pool +```powershell +New-AzNetAppFilesPool -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -Name "MyAnfPool" -Location "westus2" -PoolSize 4398046511104 -ServiceLevel "Premium" -QosType "Auto" +``` + +```output +Location : westus2 +Id : /subscriptions/subsID/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount/capacityPools/MyAnfPool +Name : MyAnfAccount/MyAnfPool +Type : Microsoft.NetApp/netAppAccounts/capacityPools +Tags : +PoolId : a3a53a09-fd70-37ab-39dc-392a04cba525 +Size : 4398046511104 +ServiceLevel : Premium +TotalThroughputMibps: 262.144 +UtilizedThroughputMibps: 164.221 +QosType : Auto +ProvisioningState : Succeeded +``` + +This command creates the new ANF pool "MyAnfPool" within the account "MyAnfAccount". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The account for the new pool object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CoolAccess +If enabled (true) the pool can contain cool Access enabled volumes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionType +Encryption type of the capacity pool (Single, Double), set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolSize +The size of the ANF pool + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QosType +The qos type of the pool. Possible values include: 'Auto', 'Manual' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Auto +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceLevel +The service level of the ANF pool + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesPool](./Get-AzNetAppFilesPool.md) +[Remove-AzNetAppFilesPool](./Remove-AzNetAppFilesPool.md) +[Set-AzNetAppFilesPool](./Set-AzNetAppFilesPool.md) +[Update-AzNetAppFilesPool](./Update-AzNetAppFilesPool.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesSnapshot.md b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesSnapshot.md new file mode 100644 index 0000000000..a753f864c5 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesSnapshot.md @@ -0,0 +1,262 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilessnapshot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesSnapshot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesSnapshot.md +--- + +# New-AzNetAppFilesSnapshot + +## SYNOPSIS +Creates a new Azure NetApp Files (ANF) snapshot. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzNetAppFilesSnapshot -ResourceGroupName <String> -Location <String> -AccountName <String> + -PoolName <String> -VolumeName <String> -Name <String> [-FileSystemId <String>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzNetAppFilesSnapshot -Name <String> [-Tag <Hashtable>] -VolumeObject <PSNetAppFilesVolume> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetAppFilesSnapshot** cmdlet creates an ANF snapshot. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetAppFilesSnapshot -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -SnapshotName "MyAnfSnapshot" -FileSystemId "3e2773a7-2a72-d003-0637-1a8b1fa3eaaf" +``` + +```output +Location : westus2 +Id : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount/capacityPools/MyAnfPool/volumes/MyAnfVolume/snapshots/MyAnfSnapshot +Name : MyAnfAccount/MyAnfPool/MyAnfVolume/MyAnfSnapshot +Type : Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots +Tags : +SnapshotId : ca7c4ebd-91cb-0e30-91f5-9154050033df +FileSystemId : 3e2773a7-2a72-d003-0637-1a8b1fa3eaaf +Created : +ProvisioningState : Succeeded +``` + +This command creates the new ANF snapshot "MyAnfSnapshot" within the volume "MyAnfVolume". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystemId +The file system id + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF snapshot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SnapshotName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume for the new snapshot object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshot + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesSnapshot](./Get-AzNetAppFilesSnapshot.md) +[Remove-AzNetAppFilesSnapshot](./Remove-AzNetAppFilesSnapshot.md) +[Get-AzNetAppFilesSnapshotPolicy](./Get-AzNetAppFilesSnapshotPolicy.md) +[New-AzNetAppFilesSnapshotPolicy](./New-AzNetAppFilesSnapshotPolicy.md) +[Update-AzNetAppFilesSnapshotPolicy](./Update-AzNetAppFilesSnapshotPolicy.md) +[Remove-AzNetAppFilesSnapshotPolicy](./Remove-AzNetAppFilesSnapshotPolicy.md) +[Set-AzNetAppFilesSnapshotPolicy](./Set-AzNetAppFilesSnapshotPolicy.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesSnapshotPolicy.md b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesSnapshotPolicy.md new file mode 100644 index 0000000000..fbf3fde6b6 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesSnapshotPolicy.md @@ -0,0 +1,305 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilessnapshotpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesSnapshotPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesSnapshotPolicy.md +--- + +# New-AzNetAppFilesSnapshotPolicy + +## SYNOPSIS +Creates a new Azure NetApp Files (ANF) snapshot policy for an ANF account. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzNetAppFilesSnapshotPolicy -ResourceGroupName <String> -Location <String> -AccountName <String> + -Name <String> [-Enabled] -HourlySchedule <PSNetAppFilesHourlySchedule> + -DailySchedule <PSNetAppFilesDailySchedule> -WeeklySchedule <PSNetAppFilesWeeklySchedule> + -MonthlySchedule <PSNetAppFilesMonthlySchedule> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzNetAppFilesSnapshotPolicy -Name <String> [-Enabled] -HourlySchedule <PSNetAppFilesHourlySchedule> + -DailySchedule <PSNetAppFilesDailySchedule> -WeeklySchedule <PSNetAppFilesWeeklySchedule> + -MonthlySchedule <PSNetAppFilesMonthlySchedule> [-Tag <Hashtable>] -AccountObject <PSNetAppFilesAccount> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetAppFilesSnapshotPolicy** cmdlet creates a new snapshot policy for an ANF account. + +## EXAMPLES + +### Example 1 +```powershell +$hourlySchedule = @{ + Minute = 2 + SnapshotsToKeep = 6 + } + $dailySchedule = @{ + Hour = 1 + Minute = 2 + SnapshotsToKeep = 6 + } + $weeklySchedule = @{ + Minute = 2 + Hour = 1 + Day = "Sunday,Monday" + SnapshotsToKeep = 6 + } + $monthlySchedule = @{ + Minute = 2 + Hour = 1 + DaysOfMonth = "2,11,21" + SnapshotsToKeep = 6 + } +New-AzNetAppFilesSnapshotPolicy -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAccount" -Name "MySnapshotPolicy" -Enabled -HourlySchedule $hourlySchedule -DailySchedule $dailySchedule -WeeklySchedule $weeklySchedule -MonthlySchedule $monthlySchedule +``` + +This command creates the new ANF snapshot policy for ANF account named account "MyAccount". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account for the new Snapshot Policy object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DailySchedule +A hashtable array which represents the daily Schedule + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesDailySchedule +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The property to decide policy is enabled or not + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HourlySchedule +A hashtable array which represents the hourly Schedule + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesHourlySchedule +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonthlySchedule +A hashtable array which represents the montly Schedule + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesMonthlySchedule +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF snapshot policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SnapshotPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable array which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeeklySchedule +A hashtable array which represents the montly Schedule + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesWeeklySchedule +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshotPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesSnapshotPolicy](./Get-AzNetAppFilesSnapshotPolicy.md) +[Update-AzNetAppFilesSnapshotPolicy](./Update-AzNetAppFilesSnapshotPolicy.md) +[Remove-AzNetAppFilesSnapshotPolicy](./Remove-AzNetAppFilesSnapshotPolicy.md) +[Set-AzNetAppFilesSnapshotPolicy](./Set-AzNetAppFilesSnapshotPolicy.md) +[Get-AzNetAppFilesSnapshot](./Get-AzNetAppFilesSnapshot.md) +[New-AzNetAppFilesSnapshot](./New-AzNetAppFilesSnapshot.md) +[Remove-AzNetAppFilesSnapshot](./Remove-AzNetAppFilesSnapshot.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesSubvolume.md b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesSubvolume.md new file mode 100644 index 0000000000..c2649c6a01 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesSubvolume.md @@ -0,0 +1,259 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilessubvolume +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesSubvolume.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesSubvolume.md +--- + +# New-AzNetAppFilesSubvolume + +## SYNOPSIS +Creates a new Azure NetApp Files (ANF) subvolume. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzNetAppFilesSubvolume -ResourceGroupName <String> -Location <String> -AccountName <String> + -PoolName <String> -VolumeName <String> -Name <String> -Path <String> -Size <Int64> [-ParentPath <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzNetAppFilesSubvolume -Name <String> -Path <String> -Size <Int64> [-ParentPath <String>] + -VolumeObject <PSNetAppFilesVolume> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetAppFilesSubvolume** cmdlet creates an ANF subvolume. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetAppFilesSubvolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MySubvolume" -Location "westus2" +``` + +This command creates the new ANF subvolume "MySubvolume" for the parent volume "MyAnfVolume". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF Subvolume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SubvolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentPath +Parent path to the subvolume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Path for subvolume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Size +Truncate subvolume to the provided size in bytes + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume for the new backup object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## NOTES + +## RELATED LINKS + +[Update-AzNetAppFilesSubvolume](./Update-AzNetAppFilesSubvolume.md) +[Remove-AzNetAppFilesSubvolume](./Remove-AzNetAppFilesSubvolume.md) +[Get-AzNetAppFilesSubvolume](./Get-AzNetAppFilesSubvolume.md) +[Get-AzNetAppFilesSubvolumeMetadata](./Get-AzNetAppFilesSubvolumeMetadata.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesVolume.md b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesVolume.md new file mode 100644 index 0000000000..5eb52cd36c --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesVolume.md @@ -0,0 +1,859 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilesvolume +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesVolume.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesVolume.md +--- + +# New-AzNetAppFilesVolume + +## SYNOPSIS +Creates a new Azure NetApp Files (ANF) volume. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzNetAppFilesVolume -ResourceGroupName <String> -Location <String> -AccountName <String> -PoolName <String> + -Name <String> -UsageThreshold <Int64> -SubnetId <String> -CreationToken <String> [-VolumeType <String>] + -ServiceLevel <String> [-SnapshotId <String>] [-ExportPolicy <PSNetAppFilesVolumeExportPolicy>] + [-ReplicationObject <PSNetAppFilesReplicationObject>] [-Snapshot <PSNetAppFilesVolumeSnapshot>] + [-SnapshotPolicyId <String>] [-Backup <PSNetAppFilesVolumeBackupProperties>] [-ProtocolType <String[]>] + [-SnapshotDirectoryVisible] [-BackupId <String>] [-SecurityStyle <String>] [-ThroughputMibps <Double>] + [-KerberosEnabled] [-SmbEncryption] [-SmbContinuouslyAvailable] [-LdapEnabled] [-CoolAccess] + [-CoolnessPeriod <Int32>] [-UnixPermission <String>] [-AvsDataStore <String>] [-IsDefaultQuotaEnabled] + [-DefaultUserQuotaInKiB <Int64>] [-DefaultGroupQuotaInKiB <Int64>] [-NetworkFeature <String>] + [-CapacityPoolResourceId <String>] [-ProximityPlacementGroup <String>] [-VolumeSpecName <String>] + [-PlacementRule <System.Collections.Generic.IList`1[Microsoft.Azure.Commands.NetAppFiles.Models.PSKeyValuePairs]>] + [-EnableSubvolume] [-Zone <String[]>] [-EncryptionKeySource <String>] + [-KeyVaultPrivateEndpointResourceId <String>] [-DeleteBaseSnapshot] [-SmbAccessBasedEnumeration <String>] + [-SmbNonBrowsable <String>] [-IsLargeVolume] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzNetAppFilesVolume -Name <String> -UsageThreshold <Int64> -SubnetId <String> -CreationToken <String> + -ServiceLevel <String> [-ExportPolicy <PSNetAppFilesVolumeExportPolicy>] + [-ReplicationObject <PSNetAppFilesReplicationObject>] [-Snapshot <PSNetAppFilesVolumeSnapshot>] + [-SnapshotPolicyId <String>] [-Backup <PSNetAppFilesVolumeBackupProperties>] [-ProtocolType <String[]>] + [-SnapshotDirectoryVisible] [-SecurityStyle <String>] [-ThroughputMibps <Double>] [-KerberosEnabled] + [-SmbEncryption] [-SmbContinuouslyAvailable] [-LdapEnabled] [-CoolAccess] [-CoolnessPeriod <Int32>] + [-UnixPermission <String>] [-AvsDataStore <String>] [-IsDefaultQuotaEnabled] [-DefaultUserQuotaInKiB <Int64>] + [-DefaultGroupQuotaInKiB <Int64>] [-NetworkFeature <String>] [-CapacityPoolResourceId <String>] + [-ProximityPlacementGroup <String>] [-VolumeSpecName <String>] + [-PlacementRule <System.Collections.Generic.IList`1[Microsoft.Azure.Commands.NetAppFiles.Models.PSKeyValuePairs]>] + [-EnableSubvolume] [-Zone <String[]>] [-EncryptionKeySource <String>] + [-KeyVaultPrivateEndpointResourceId <String>] [-DeleteBaseSnapshot] [-SmbAccessBasedEnumeration <String>] + [-SmbNonBrowsable <String>] [-IsLargeVolume] [-Tag <Hashtable>] -PoolObject <PSNetAppFilesPool> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetAppFilesVolume** cmdlet creates an ANF volume. + +## EXAMPLES + +### Example 1: Create an ANF volume +```powershell +New-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" -Location "westus2" -CreationToken "MyAnfVolume" -UsageThreshold 1099511627776 -ServiceLevel "Premium" -SubnetId "/subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyVnetName/subnets/MySubNetName" +``` + +```output +Location : westus2 +Id : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount/capacityPools/MyAnfPool/volumes/MyAnfVolume +Name : MyAnfAccount/MyAnfPool/MyAnfVolume +Type : Microsoft.NetApp/netAppAccounts/capacityPools/volumes +Tags : +FileSystemId : 3e2773a7-2a72-d003-0637-1a8b1fa3eaaf +CreationToken : MyAnfVolume +ServiceLevel : Premium +UsageThreshold : 1099511627776 +ProvisioningState : Succeeded +SubnetId : /subscriptions/f557b96d-2308-4a18-aae1-b8f7e7e70cc7/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyVnetName/subnets/default +``` + +This command creates the new ANF volume "MyAnfVolume" within the pool "MyAnfPool". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsDataStore +Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose (Enabled, Disabled) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Backup +A hashtable array which represents the backup object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolumeBackupProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupId +Backup ID. UUID v4 or resource identifier used to identify the Backup + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapacityPoolResourceId +Pool Resource Id used in case of creating a volume through volume group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CoolAccess +Specifies whether Cool Access(tiering) is enabled for the volume (default false). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CoolnessPeriod +Specifies the number of days after which data that is not accessed by clients will be tiered (minimum 7, maximum 63). + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreationToken +A unique file path for the volume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultGroupQuotaInKiB +Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultUserQuotaInKiB +Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteBaseSnapshot +If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSubvolume +Flag indicating whether subvolume operations are enabled on the volume (Enabled, Disabled) + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeySource +Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values are: 'Microsoft.NetApp, Microsoft.KeyVault' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportPolicy +A hashtable array which represents the export policy + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolumeExportPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefaultQuotaEnabled +Specifies if default quota is enabled for the volume + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsLargeVolume +Specifies whether volume is a Large Volume or Regular Volume. Defaults to false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KerberosEnabled +Describe if a volume is Kerberos Enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPrivateEndpointResourceId +The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapEnabled +Specifies whether LDAP is enabled or not for a given NFS volume. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkFeature +Basic network, or Standard features available to the volume (Basic, Standard). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlacementRule +Application specific placement rules for the particular volume. + +```yaml +Type: System.Collections.Generic.IList`1[Microsoft.Azure.Commands.NetAppFiles.Models.PSKeyValuePairs] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolObject +The pool for the new volume object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProtocolType +A hashtable array which represents the export policy + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProximityPlacementGroup +Proximity placement group associated with the volume. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationObject +A hashtable array which represents the replication object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesReplicationObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityStyle +The security style of volume. Possible values include: 'ntfs', 'unix' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceLevel +The service level of the ANF volume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmbAccessBasedEnumeration +Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmbContinuouslyAvailable +Enables continuously available share property for SMB volume. Only applicable for SMB volume. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmbEncryption +Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmbNonBrowsable +Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Snapshot +A hashtable array which represents the snapshot object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolumeSnapshot +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnapshotDirectoryVisible +If enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots (default to true) + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnapshotId +Create volume from a snapshot. UUID v4 or resource identifier used to identify the Snapshot + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnapshotPolicyId +Snapshot Policy ResourceId used to apply a snapshot policy to the volume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The Azure Resource URI for a delegated subnet + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThroughputMibps +Maximum throughput in Mibps that can be achieved by this volume + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnixPermission +UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: UnixPermissions + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsageThreshold +The maximum storage quota allowed for a file system in bytes + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeSpecName +Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeType +The type of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +A list of Availability Zones + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Restore-AzNetAppFilesVolume](./Restore-AzNetAppFilesVolume.md) +[Set-AzNetAppFilesVolumePool](./Set-AzNetAppFilesVolumePool.md) +[Get-AzNetAppFilesVolumeBackupStatus](./Get-AzNetAppFilesVolumeBackupStatus.md) +[Get-AzNetAppFilesVolumeRestoreStatus](./Get-AzNetAppFilesVolumeRestoreStatus.md) +[New-AzNetAppFilesVolumeRestoreStatus](./Get-AzNetAppFilesVolumeRestoreStatus.md) +[Approve-AzNetAppFilesReplication](./Approve-AzNetAppFilesReplication.md) +[Inititialize-AzNetAppFilesReplication](./Approve-AzNetAppFilesReplication.md) +[Resume-AzNetAppFilesReplication](./Resume-AzNetAppFilesReplication.md) +[Remove-AzNetAppFilesReplication](./Remove-AzNetAppFilesReplication.md) diff --git a/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesVolumeGroup.md b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesVolumeGroup.md new file mode 100644 index 0000000000..ebfaed0d9a --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesVolumeGroup.md @@ -0,0 +1,659 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilesvolumegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesVolumeGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesVolumeGroup.md +--- + +# New-AzNetAppFilesVolumeGroup + +## SYNOPSIS +Creates a new Azure NetApp Files (ANF) VolumeGroup along with requisite volumes. +Creating volume group will create all the volumes specified in request body implicitly. Once volumes are created using volume group, those will be treated as regular volumes thereafter. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzNetAppFilesVolumeGroup -ResourceGroupName <String> -Location <String> -AccountName <String> + -PoolName <String> [-Name <String>] [-GroupDescription <String>] [-ApplicationType <String>] + -ApplicationIdentifier <String> -ProximityPlacementGroup <String> -NodeMemory <Int32> + [-CapacityOverhead <Int32>] [-StartingHostId <Int32>] [-HostCount <Int32>] [-SystemRole <String>] + [-Prefix <String>] [-Vnet <String>] [-SubnetId <String>] [-DataSize <Int64>] [-DataPerformance <Int32>] + [-LogSize <Int64>] [-LogPerformance <Int32>] [-SharedSize <Int64>] [-SharedPerformance <Int32>] + [-DataBackupSize <Int64>] [-DataBackupPerformance <Int32>] [-LogBackupSize <Int64>] + [-LogBackupPerformance <Int32>] [-HannaSystemReplication] [-DisasterRecoveryDestination] + [-BackupProtocolType <String[]>] [-ExportPolicy <PSNetAppFilesVolumeExportPolicy>] + [-GlobalPlacementRule <System.Collections.Generic.IList`1[Microsoft.Azure.Management.NetApp.Models.PlacementKeyValuePairs]>] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzNetAppFilesVolumeGroup -PoolName <String> [-Name <String>] [-GroupDescription <String>] + [-ApplicationType <String>] -ApplicationIdentifier <String> -ProximityPlacementGroup <String> + -NodeMemory <Int32> [-CapacityOverhead <Int32>] [-StartingHostId <Int32>] [-HostCount <Int32>] + [-SystemRole <String>] [-Prefix <String>] [-Vnet <String>] [-SubnetId <String>] [-DataSize <Int64>] + [-DataPerformance <Int32>] [-LogSize <Int64>] [-LogPerformance <Int32>] [-SharedSize <Int64>] + [-SharedPerformance <Int32>] [-DataBackupSize <Int64>] [-DataBackupPerformance <Int32>] + [-LogBackupSize <Int64>] [-LogBackupPerformance <Int32>] [-HannaSystemReplication] + [-DisasterRecoveryDestination] [-BackupProtocolType <String[]>] + [-ExportPolicy <PSNetAppFilesVolumeExportPolicy>] + [-GlobalPlacementRule <System.Collections.Generic.IList`1[Microsoft.Azure.Management.NetApp.Models.PlacementKeyValuePairs]>] + [-Tag <Hashtable>] -AccountObject <PSNetAppFilesAccount> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetAppFilesVolumeGroup** cmdlet creates an ANF VolumeGroup. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetAppFilesVolumeGroup -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolumeGroupName" -Location "westus2" -GroupDescription "MyAnfVolumeGroup Description" -ApplicationIdentifier "SH1" -ProximityPlacementGroup "MyPPGResourceId" -Vnet "MyAnfVnet" -SystemRole "PRIMARY" -NodeMemory 100 +``` + +This command creates the new "PRIMARY" ANF VolumeGroup "MyAnfVolumeGroup" within the Account "MyAnfAccount" using the proximityPlacementGroup "MyPPGResourceId", the vnet "MyAnfVnet", and NodeMemory of 100 + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The account for the new pool object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ApplicationIdentifier +Application specific identifier, default SAP System ID SH1 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationType +Application Type, default SAP-HANA + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupProtocolType +A hashtable array which represents the protocol types for Data Backup/Log Backup volumes default NFSv4.1, for other volume types nfsv4.1 will be used. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapacityOverhead +Capacity overhead %, Additional quota reserved for snapshots during best-practice sizing of data volume, default 50 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataBackupPerformance +Specify throughput in MiB/s. +If ommited DataBackupPerformance will be autocalculated or specify an integer value representing throughput. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataBackupSize +Specify capacity (in GiB). +If ommited DataSize will be autocalculated or specify an integer value representing size. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataPerformance +Specify throughput in MiB/s. +If ommited DataPerformance will be autocalculated or specify and integer value representing throughput. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataSize +Specify capacity (in GiB). +If ommited DataSize will be autocalculated or specify an integer value representing size. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisasterRecoveryDestination +Create volume groups for DR, using ANF Cross Region Replication, scenario allows volumes to be replicated between different regions using SnapMirror + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportPolicy +A hashtable array which represents the export policy, which should be common to all volumes. + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolumeExportPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalPlacementRule +Application specific placement rules for the volume group + +```yaml +Type: System.Collections.Generic.IList`1[Microsoft.Azure.Management.NetApp.Models.PlacementKeyValuePairs] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupDescription +Group Description, example Primary for SH1-{HostId} (default) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HannaSystemReplication +HANA System Replication (HSR): Replication between the same SID instance on hosts in the same region, or differerent regions. +This could be Scale-Up or Scale-Out configurations. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostCount +Number of SAP HANA hosts. +Total Number of SAP HANA hosts for single or multiplehost scenarios. +Defaults to 50 for single-host setups. +Currently at max 3 nodes can be configured. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogBackupPerformance +Specify throughput in MiB/s. +If ommited LogBackupPerformance will be autocalculated or specify an integer value representing throughput. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogBackupSize +Specify capacity (in GiB). +If ommited DataSize will be autocalculated or specify an integer value representing size. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogPerformance +Specify throughput in MiB/s. +If ommited LogPerformance will be autocalculated or specify and integer value representing throughput. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogSize +Specify capacity (in GiB). +If ommited LogSize will be autocalculated or specify an integer value representing size. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF VolumeGroup, example SAP-HANA-SH00001. +Defaults to SAP-HANA-{HostId}, where the {HostId} pattern in the name will be replaced by a 5 digit host ID that begins at 1 for the Single-host and counts up for the subsequent Multiple-host, host + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VolumeGroupName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeMemory +SAP node memory (GiB), Memory on SAP compute host + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +Default capacity pool for volumes, use a manual QoS type capacity pool + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Prefix +All volume names will be prefixed with the given text. +The default values for prefix text depends on system role. +For PRIMARY it will be empty and HA it will be "HA - " + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProximityPlacementGroup +Default proximity placement group, for data, log, and if present the shared volume, in all volume groups. +Specifies that the data, log, and shared volumes are to be created close to the VMs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF VolumeGroup + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedPerformance +Specify throughput in MiB/s. +If ommited SharedPerformance will be autocalculated or specify and integer value representing throughput. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedSize +Specify capacity (in GiB). +If ommited SharedSize will be autocalculated or specify an integer value representing size. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartingHostId +Starting SAP HANA Host ID. +Host ID 1 indicates Master Host. +Shared, Data Backup and Log Backup volumes are only provisioned for Master Host i.e. +HostID == 1.1 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Default delegated subnet, for all volume groups + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemRole +The role of the system, Primary SAP system, HANA System Replication(HSR) or DataRecovery destination for ANF Cross-region replication (CRR) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vnet +Default virtual network, for all volume groups + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolumeGroupDetail + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesVolumeGroup](./Get-AzNetAppFilesVolumeGroup.md) +[New-AzNetAppFilesVolumeGroup](./New-AzNetAppFilesVolumeGroup.md) +[Remove-AzNetAppFilesVolumeGroup](./Remove-AzNetAppFilesVolumeGroup.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesVolumeQuotaRule.md b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesVolumeQuotaRule.md new file mode 100644 index 0000000000..78819299f9 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/New-AzNetAppFilesVolumeQuotaRule.md @@ -0,0 +1,271 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilesvolumequotarule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesVolumeQuotaRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesVolumeQuotaRule.md +--- + +# New-AzNetAppFilesVolumeQuotaRule + +## SYNOPSIS +Creates a new Azure NetApp Files (ANF) Volume Quota Rule. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +New-AzNetAppFilesVolumeQuotaRule -ResourceGroupName <String> -Location <String> -AccountName <String> + -PoolName <String> -VolumeName <String> -Name <String> [-Tag <Hashtable>] -QuotaSize <Int32> + -QuotaType <String> [-QuotaTarget <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +New-AzNetAppFilesVolumeQuotaRule -Name <String> [-Tag <Hashtable>] -QuotaSize <Int32> -QuotaType <String> + [-QuotaTarget <String>] -VolumeObject <PSNetAppFilesVolume> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetAppFilesVolumeQuotaRule** cmdlet creates an ANF Volume Quota Rule. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetAppFilesVolumeQuotaRule -ResourceGroupName $resourceGroup -Location $resourceLocation -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfVolumeQuotaRule" -QuotaType "DefaultGroupQuota" -QuotaSize 100006 +``` + +This command creates the new ANF VolumeQuotaRule "MyAnfVolumeQuotaRule" of type DefaultGroupQuota for the volume "MyAnfVolume" using the QuotaSize 100006 + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF QuotaRule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VolumeQuotaRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuotaSize +Size of quota in KiBs + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuotaTarget +UserID/GroupID/SID based on the quota target type. +UserID and groupID can be found by running 'id' or 'getent' command for the user or group and SID can be found by running \<wmic useraccount where name='user-name' get sid\> + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuotaType +Type of quota + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume for the new VolumeQuotaRule object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesAccount.md b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesAccount.md new file mode 100644 index 0000000000..d672fcd7ba --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesAccount.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilesaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesAccount.md +--- + +# Remove-AzNetAppFilesAccount + +## SYNOPSIS +Deletes an Azure NetApp Files (ANF) account. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzNetAppFilesAccount -ResourceGroupName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzNetAppFilesAccount -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzNetAppFilesAccount -InputObject <PSNetAppFilesAccount> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetAppFilesAccount** cmdlet deletes an ANF account. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetAppFilesAccount -ResourceGroupName "MyRG" -Name "MyAnfAccount" +``` + +This command deletes the ANF account "MyAnfAccount". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The account object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified account was successfully removed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesAccount](./Get-AzNetAppFilesAccount.md) +[New-AzNetAppFilesAccount](./New-AzNetAppFilesAccount.md) +[Set-AzNetAppFilesAccount](./Set-AzNetAppFilesAccount.md) +[Update-AzNetAppFilesAccount](./Update-AzNetAppFilesAccount.md) +[Get-AzNetAppFilesActiveDirectory](./Get-AzNetAppFilesActiveDirectory.md) +[New-AzNetAppFilesActiveDirectory](./New-AzNetAppFilesActiveDirectory.md) +[Remove-AzNetAppFilesActiveDirectory](./Remove-AzNetAppFilesActiveDirectory.md) +[Update-AzNetAppFilesActiveDirectory](./Update-AzNetAppFilesActiveDirectory.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesActiveDirectory.md b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesActiveDirectory.md new file mode 100644 index 0000000000..d1f76b5224 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesActiveDirectory.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilesactivedirectory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesActiveDirectory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesActiveDirectory.md +--- + +# Remove-AzNetAppFilesActiveDirectory + +## SYNOPSIS +Deletes an Azure NetApp Files (ANF) active directory configuration. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzNetAppFilesActiveDirectory -ResourceGroupName <String> -AccountName <String> + -ActiveDirectoryId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzNetAppFilesActiveDirectory -ActiveDirectoryId <String> -AccountObject <PSNetAppFilesAccount> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzNetAppFilesActiveDirectory -InputObject <PSNetAppFilesActiveDirectory> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetAppFilesActiveDirectory** cmdlet deletes an ANF active directory configuration. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetAppFilesActiveDirectory -ResourceGroupName "MyRG" -AccountName "MyAccount" -ActiveDirectoryId "MyActiveDirectoryId" +``` + +This command deletes the new ANF active directory configuration with a the name "MyADName". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account for the Active Directory object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ActiveDirectoryId +The ID of the ANF active directory + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The active directory object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesActiveDirectory +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified Active Directory was successfully removed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesActiveDirectory + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesActiveDirectory + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesActiveDirectory](./Get-AzNetAppFilesActiveDirectory.md) +[New-AzNetAppFilesActiveDirectory](./New-AzNetAppFilesActiveDirectory.md) +[Update-AzNetAppFilesActiveDirectory](./Update-AzNetAppFilesActiveDirectory.md) +[Get-AzNetAppFilesAccount](./Get-AzNetAppFilesAccount.md) +[New-AzNetAppFilesAccount](./New-AzNetAppFilesAccount.md) +[Remove-AzNetAppFilesAccount](./Remove-AzNetAppFilesAccount.md) +[Set-AzNetAppFilesAccount](./Set-AzNetAppFilesAccount.md) +[Update-AzNetAppFilesAccount](./Update-AzNetAppFilesAccount.md) diff --git a/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesBackup.md b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesBackup.md new file mode 100644 index 0000000000..3013a8ecba --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesBackup.md @@ -0,0 +1,306 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilesbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesBackup.md +--- + +# Remove-AzNetAppFilesBackup + +## SYNOPSIS +Deletes an Azure NetApp Files (ANF) backup. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzNetAppFilesBackup -ResourceGroupName <String> [-AccountName <String>] -PoolName <String> + [-VolumeName <String>] -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByAccountBackupFieldsParameterSet +``` +Remove-AzNetAppFilesBackup -ResourceGroupName <String> -AccountName <String> -AccountBackupName <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzNetAppFilesBackup -Name <String> -VolumeObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzNetAppFilesBackup -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzNetAppFilesBackup -InputObject <PSNetAppFilesBackup> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetAppFilesBackup** cmdlet deletes an ANF account. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -PoolName "MyPool" -VolumeName "MyVolume" -Name "MyBackup" +``` + +This command deletes the new ANF backup with a the name "MyBackup" for volume "MyVolume". + +### Example 2 +```powershell +Remove-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -AccountBackupName "MyBackup" +``` + +This command deletes the new ANF backup with a the name "MyBackup" for account "MyAccount". + +## PARAMETERS + +### -AccountBackupName +The name of the ANF backup + +```yaml +Type: System.String +Parameter Sets: ByAccountBackupFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByAccountBackupFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The snapshot object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF backup + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: BackupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified backup was successfully removed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByAccountBackupFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Backup + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the backup to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesBackup](./New-AzNetAppFilesBackup.md) +[Get-AzNetAppFilesBackup](./Get-AzNetAppFilesBackup.md) +[Update-AzNetAppFilesBackup](./Update-AzNetAppFilesBackup.md) +[Get-AzNetAppFilesBackupPolicy](./Get-AzNetAppFilesBackupPolicy.md) +[New-AzNetAppFilesBackupPolicy](./New-AzNetAppFilesBackupPolicy.md) +[Update-AzNetAppFilesBackupPolicy](./Update-AzNetAppFilesBackupPolicy.md) +[Remove-AzNetAppFilesBackupPolicy](./Remove-AzNetAppFilesBackupPolicy.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesBackupPolicy.md b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesBackupPolicy.md new file mode 100644 index 0000000000..1c3cbbc21b --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesBackupPolicy.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilesbackuppolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesBackupPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesBackupPolicy.md +--- + +# Remove-AzNetAppFilesBackupPolicy + +## SYNOPSIS +Deletes an Azure NetApp Files (ANF) backup policy. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzNetAppFilesBackupPolicy -ResourceGroupName <String> -AccountName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzNetAppFilesBackupPolicy -Name <String> -AccountObject <PSNetAppFilesAccount> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzNetAppFilesBackupPolicy -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzNetAppFilesBackupPolicy -InputObject <PSNetAppFilesBackupPolicy> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetAppFilesBackupPolicy** cmdlet deletes an ANF backup policy. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetAppFilesBackupPolicy -ResourceGroupName "MyRG" -AccountName "MyAccount" -Name "MyBackupPolicy" +``` + +This command deletes the new ANF backup policy with a the name "MyBackupPolicy" for account "MyAccount". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account object containing the Backup Policy to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The BackupPolicy object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF backup policy + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: BackupPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified backup policy was successfully removed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Backup Policy + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesBackupPolicy](./New-AzNetAppFilesBackupPolicy.md) +[Update-AzNetAppFilesBackupPolicy](./Update-AzNetAppFilesBackupPolicy.md) +[Remove-AzNetAppFilesBackupPolicy](./Remove-AzNetAppFilesBackupPolicy.md) +[Get-AzNetAppFilesBackup](./Get-AzNetAppFilesBackup.md) +[New-AzNetAppFilesBackup](./New-AzNetAppFilesBackup.md) +[Remove-AzNetAppFilesBackup](./Remove-AzNetAppFilesBackup.md) +[Update-AzNetAppFilesBackup](./Update-AzNetAppFilesBackup.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesPool.md b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesPool.md new file mode 100644 index 0000000000..6bf8fd67f3 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesPool.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilespool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesPool.md +--- + +# Remove-AzNetAppFilesPool + +## SYNOPSIS +Deletes an Azure NetApp Files (ANF) pool. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzNetAppFilesPool -ResourceGroupName <String> -AccountName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzNetAppFilesPool -Name <String> -AccountObject <PSNetAppFilesAccount> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzNetAppFilesPool -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzNetAppFilesPool -InputObject <PSNetAppFilesPool> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetAppFilesPool** cmdlet deletes an ANF pool. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetAppFilesPool -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" +``` + +This command deletes the ANF pool "MyAnfPool". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The account object containing the pool to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The pool object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: PoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified pool was successfully removed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesPool](./New-AzNetAppFilesPool.md) +[Get-AzNetAppFilesPool](./Get-AzNetAppFilesPool.md) +[Set-AzNetAppFilesPool](./Set-AzNetAppFilesPool.md) +[Update-AzNetAppFilesPool](./Update-AzNetAppFilesPool.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesReplication.md b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesReplication.md new file mode 100644 index 0000000000..1600f38bc0 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesReplication.md @@ -0,0 +1,226 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilesreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesReplication.md +--- + +# Remove-AzNetAppFilesReplication + +## SYNOPSIS +Remove/Delete the replication connection on the destination volume, and send release to the source replication + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzNetAppFilesReplication -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzNetAppFilesReplication -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzNetAppFilesReplication -InputObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove/Delete the replication connection on the destination volume, and send release to the source replication + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetAppFilesReplication -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyDestinationAnfVolume" +``` + +This command removes the ANF Replication connection on volume "MyDestinationAnfVolume". + +## PARAMETERS + +### -AccountName +The name of the ANF account of the replication volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The ANF destination volume with the replication to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified ANF replication was successfully removed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool of the replication volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Approve-AzNetAppFilesReplication](./Approve-AzNetAppFilesReplication.md) +[Initialize-AzNetAppFilesReplication](./Initialize-AzNetAppFilesReplication.md) +[Suspend-AzNetAppFilesReplication](./Suspend-AzNetAppFilesReplication.md) +[Resume-AzNetAppFilesReplication](./Resume-AzNetAppFilesReplication.md) +[Get-AzNetAppFilesReplicationStatus](./Get-AzNetAppFilesReplicationStatus.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesSnapshot.md b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesSnapshot.md new file mode 100644 index 0000000000..b0c3f31b21 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesSnapshot.md @@ -0,0 +1,266 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilessnapshot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesSnapshot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesSnapshot.md +--- + +# Remove-AzNetAppFilesSnapshot + +## SYNOPSIS +Deletes an Azure NetApp Files (ANF) snapshot. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzNetAppFilesSnapshot -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -VolumeName <String> -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzNetAppFilesSnapshot -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzNetAppFilesSnapshot -VolumeObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzNetAppFilesSnapshot -InputObject <PSNetAppFilesSnapshot> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetAppFilesSnapshot** cmdlet deletes an ANF snapshot. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetAppFilesSnapshot -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSnapshot" +``` + +This command deletes the ANF snapshot "MyAnfSnapshot". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The snapshot object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshot +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF snapshot + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: SnapshotName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified volume was successfully removed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF snapshot + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF snapshot + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the snapshot to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshot + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesSnapshot](./Get-AzNetAppFilesSnapshot.md) +[New-AzNetAppFilesSnapshot](./New-AzNetAppFilesSnapshot.md) +[Get-AzNetAppFilesSnapshotPolicy](./Get-AzNetAppFilesSnapshotPolicy.md) +[New-AzNetAppFilesSnapshotPolicy](./New-AzNetAppFilesSnapshotPolicy.md) +[Update-AzNetAppFilesSnapshotPolicy](./Update-AzNetAppFilesSnapshotPolicy.md) +[Remove-AzNetAppFilesSnapshotPolicy](./Remove-AzNetAppFilesSnapshotPolicy.md) +[Set-AzNetAppFilesSnapshotPolicy](./Set-AzNetAppFilesSnapshotPolicy.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesSnapshotPolicy.md b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesSnapshotPolicy.md new file mode 100644 index 0000000000..15e5ac3f99 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesSnapshotPolicy.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilessnapshotpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesSnapshotPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesSnapshotPolicy.md +--- + +# Remove-AzNetAppFilesSnapshotPolicy + +## SYNOPSIS +Deletes an Azure NetApp Files (ANF) snapshot policy. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzNetAppFilesSnapshotPolicy -ResourceGroupName <String> -AccountName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzNetAppFilesSnapshotPolicy -Name <String> -AccountObject <PSNetAppFilesAccount> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzNetAppFilesSnapshotPolicy -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzNetAppFilesSnapshotPolicy -InputObject <PSNetAppFilesSnapshotPolicy> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetAppFilesSnapshotPolicy** cmdlet deletes an ANF snapshot policy. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetAppFilesSnapshotPolicy -ResourceGroupName "MyRG" -AccountName "MyAccount" -Name "MySnapshotPolicy" +``` + +This command deletes the new ANF backup policy with a the name "MyBackupPolicy" for account "MyAccount". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account for the new Snapshot Policy object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The SnapshotPolicy object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshotPolicy +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF snapshot policy + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: SnapshotPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified account was successfully removed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Snapshot Policy + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshotPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshotPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesSnapshotPolicy](./Get-AzNetAppFilesSnapshotPolicy.md) +[New-AzNetAppFilesSnapshotPolicy](./New-AzNetAppFilesSnapshotPolicy.md) +[Update-AzNetAppFilesSnapshotPolicy](./Update-AzNetAppFilesSnapshotPolicy.md) +[Set-AzNetAppFilesSnapshotPolicy](./Set-AzNetAppFilesSnapshotPolicy.md) +[Get-AzNetAppFilesSnapshot](./Get-AzNetAppFilesSnapshot.md) +[New-AzNetAppFilesSnapshot](./New-AzNetAppFilesSnapshot.md) +[Remove-AzNetAppFilesSnapshot](./Remove-AzNetAppFilesSnapshot.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesSubvolume.md b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesSubvolume.md new file mode 100644 index 0000000000..978e13704f --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesSubvolume.md @@ -0,0 +1,260 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilessubvolume +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesSubvolume.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesSubvolume.md +--- + +# Remove-AzNetAppFilesSubvolume + +## SYNOPSIS +Deletes an Azure NetApp Files (ANF) subvolume. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzNetAppFilesSubvolume -ResourceGroupName <String> -AccountName <String> -PoolName <String> + [-VolumeName <String>] [-Name <String>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzNetAppFilesSubvolume [-Name <String>] -ResourceId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzNetAppFilesSubvolume [-Name <String>] -VolumeObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzNetAppFilesSubvolume [-Name <String>] -InputObject <PSNetAppFilesBackup> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetAppFilesSubvolume** cmdlet deletes an ANF subvolume. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetAppFilesSubvolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSubvolume" +``` + +This command deletes the ANF volume "MyAnfSubvolume". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The subvolume object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF Subvolume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SubvolumeName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified backup was successfully removed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Subvolume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the subvolume to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesSubvolume](./New-AzNetAppFilesSubvolume.md) +[Get-AzNetAppFilesSubvolume](./Get-AzNetAppFilesSubvolume.md) +[Update-AzNetAppFilesSubvolume](./Update-AzNetAppFilesSubvolume.md) +[Get-AzNetAppFilesSubvolume](./Get-AzNetAppFilesSubvolume.md) +[Get-AzNetAppFilesSubvolumeMetadata](./Get-AzNetAppFilesSubvolumeMetadata.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesVolume.md b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesVolume.md new file mode 100644 index 0000000000..997b822755 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesVolume.md @@ -0,0 +1,266 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilesvolume +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesVolume.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesVolume.md +--- + +# Remove-AzNetAppFilesVolume + +## SYNOPSIS +Deletes an Azure NetApp Files (ANF) volume. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzNetAppFilesVolume -ResourceGroupName <String> -AccountName <String> -PoolName <String> -Name <String> + [-ForceDelete] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzNetAppFilesVolume -Name <String> [-ForceDelete] -PoolObject <PSNetAppFilesPool> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzNetAppFilesVolume [-ForceDelete] -ResourceId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzNetAppFilesVolume [-ForceDelete] -InputObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetAppFilesVolume** cmdlet deletes an ANF volume. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" +``` + +This command deletes the ANF volume "MyAnfVolume". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDelete +An option to force delete the volume. Will cleanup resources connected to the particular volume + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The volume object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified volume was successfully removed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolObject +The pool object containing the volume to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Restore-AzNetAppFilesVolume](./Restore-AzNetAppFilesVolume.md) +[Set-AzNetAppFilesVolumePool](./Set-AzNetAppFilesVolumePool.md) +[Get-AzNetAppFilesVolumeBackupStatus](./Get-AzNetAppFilesVolumeBackupStatus.md) +[Get-AzNetAppFilesVolumeRestoreStatus](./Get-AzNetAppFilesVolumeRestoreStatus.md) +[Approve-AzNetAppFilesReplication](./Approve-AzNetAppFilesReplication.md) +[Initialize-AzNetAppFilesReplication](./Initialize-AzNetAppFilesReplication.md) +[Resume-AzNetAppFilesReplication](./Resume-AzNetAppFilesReplication.md) +[Remove-AzNetAppFilesReplication](./Remove-AzNetAppFilesReplication.md) diff --git a/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesVolumeGroup.md b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesVolumeGroup.md new file mode 100644 index 0000000000..0e786d556e --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesVolumeGroup.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilesvolumegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesVolumeGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesVolumeGroup.md +--- + +# Remove-AzNetAppFilesVolumeGroup + +## SYNOPSIS +Deletes an Azure NetApp Files (ANF) VolumeGroup. This delete the specified volume group only does not delete the volumes. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzNetAppFilesVolumeGroup -ResourceGroupName <String> -AccountName <String> [-Name <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzNetAppFilesVolumeGroup [-Name <String>] -ResourceId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzNetAppFilesVolumeGroup [-Name <String>] -AccountObject <PSNetAppFilesAccount> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzNetAppFilesVolumeGroup [-Name <String>] -InputObject <PSNetAppFilesBackupPolicy> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetAppFilesVolumeGroup** cmdlet deletes an empty ANF VolumeGroup. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetAppFilesVolumeGroup -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -Name "MyAnfVolumeGroup" +``` + +This command deletes the ANF volume "MyAnfVolumeGroup" if it has no volumes under the group. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The account object containing the VolumeGroup to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The VolumeGroup object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF VolumeGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VolumeGroupName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified backup policy was successfully removed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF VolumeGroup + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF VolumeGroup + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesVolumeGroup](./Get-AzNetAppFilesVolumeGroup.md) +[New-AzNetAppFilesVolumeGroup](./New-AzNetAppFilesVolumeGroup.md) +[Remove-AzNetAppFilesVolumeGroup](./Remove-AzNetAppFilesVolumeGroup.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesVolumeQuotaRule.md b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesVolumeQuotaRule.md new file mode 100644 index 0000000000..6ee16e456f --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Remove-AzNetAppFilesVolumeQuotaRule.md @@ -0,0 +1,254 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilesvolumequotarule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesVolumeQuotaRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesVolumeQuotaRule.md +--- + +# Remove-AzNetAppFilesVolumeQuotaRule + +## SYNOPSIS +Deletes an Azure NetApp Files (ANF) Volume Quota Rule. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Remove-AzNetAppFilesVolumeQuotaRule -ResourceGroupName <String> -AccountName <String> -PoolName <String> + [-VolumeName <String>] [-Name <String>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Remove-AzNetAppFilesVolumeQuotaRule [-Name <String>] -ResourceId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Remove-AzNetAppFilesVolumeQuotaRule [-Name <String>] -VolumeObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Remove-AzNetAppFilesVolumeQuotaRule [-Name <String>] -InputObject <PSNetAppFilesBackupPolicy> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetAppFilesVolumeQuotaRule** cmdlet deletes an empty ANF VolumeQuotaRule. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetAppFilesVolumeQuotaRule -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -VolumeName "MyAnfVolume" -Name "MyVolumeQuotaRuleName" +``` + +The **Remove-AzNetAppFilesVolumeGroup** cmdlet deletes an empty ANF VolumeQuotaRule. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The VolumeGroup object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF VolumeGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VolumeGroupName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified VolumeQuotaRule was successfully removed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF VolumeQuotaRule + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF VolumeQuotaRule + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the subvolume to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.NetAppFiles/Reset-AzNetAppFilesVolumeCifsPassword.md b/azps-10.1.0/Az.NetAppFiles/Reset-AzNetAppFilesVolumeCifsPassword.md new file mode 100644 index 0000000000..be5c768f5b --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Reset-AzNetAppFilesVolumeCifsPassword.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/reset-aznetappfilesvolumecifspassword +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Reset-AzNetAppFilesVolumeCifsPassword.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Reset-AzNetAppFilesVolumeCifsPassword.md +--- + +# Reset-AzNetAppFilesVolumeCifsPassword + +## SYNOPSIS +Reset the Cifs password for the volume + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Reset-AzNetAppFilesVolumeCifsPassword -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Reset-AzNetAppFilesVolumeCifsPassword -Name <String> -PoolObject <PSNetAppFilesPool> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Reset-AzNetAppFilesVolumeCifsPassword -ResourceId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Reset-AzNetAppFilesVolumeCifsPassword -InputObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Reset Cifs password from volume + +## EXAMPLES + +### Example 1 +```powershell +Reset-AzNetAppFilesVolumeCifsPassword -ResourceGroupName "MyRG" -AccountName "MyAccount" -PoolName "MyPool" -VolumeName "MyVolume" +``` + +This command resets the Cifs password for the volume MyVolume + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The volume object to restore + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified volumes Cifs Password was successfully reset + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolObject +The pool object containing the volume to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.NetAppFiles/Restore-AzNetAppFilesBackupFile.md b/azps-10.1.0/Az.NetAppFiles/Restore-AzNetAppFilesBackupFile.md new file mode 100644 index 0000000000..7a84c0965e --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Restore-AzNetAppFilesBackupFile.md @@ -0,0 +1,307 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/restore-aznetappfilesbackupfile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Restore-AzNetAppFilesBackupFile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Restore-AzNetAppFilesBackupFile.md +--- + +# Restore-AzNetAppFilesBackupFile + +## SYNOPSIS +Create a new Backup Restore Files request + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Restore-AzNetAppFilesBackupFile -ResourceGroupName <String> -AccountName <String> -Name <String> + -PoolName <String> -VolumeName <String> -FileList <String[]> [-RestoreFilePath <String>] + -DestinationVolumeId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Restore-AzNetAppFilesBackupFile -Name <String> -FileList <String[]> [-RestoreFilePath <String>] + -DestinationVolumeId <String> -VolumeObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Restore-AzNetAppFilesBackupFile -FileList <String[]> [-RestoreFilePath <String>] -DestinationVolumeId <String> + -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Restore-AzNetAppFilesBackupFile -FileList <String[]> [-RestoreFilePath <String>] -DestinationVolumeId <String> + -InputObject <PSNetAppFilesBackup> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Restore the specified files from the specified backup to the active filesystem + +## EXAMPLES + +### Example 1 +```powershell +$fileList = New-Object string[] 1 +$fileList[0] = "/dir1/customer1.db" +Restore-AzNetAppFilesBackupFile -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyVolume" -BackupName "MyBackup" -FileList $fileList -DestinationVolumeId "destinationVolumeResourceId" +``` + +This command Restores the file customer1.db from "MyBackup" to the specified destingation volume + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationVolumeId +Resource Id of the destination volume on which the files need to be restored + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FileList +List of files to be restored + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The backup object to restore files from + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF backup + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: BackupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified files where successfully restored + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Backup + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestoreFilePath +Destination folder where the files will be restored. +The path name should start with a forward slash. +If it is omitted from request then restore is done at the root folder of the destination volume by default + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the backup to restore files from + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.NetAppFiles/Restore-AzNetAppFilesReplication.md b/azps-10.1.0/Az.NetAppFiles/Restore-AzNetAppFilesReplication.md new file mode 100644 index 0000000000..1647949ce4 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Restore-AzNetAppFilesReplication.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/restore-aznetappfilesreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Restore-AzNetAppFilesReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Restore-AzNetAppFilesReplication.md +--- + +# Restore-AzNetAppFilesReplication + +## SYNOPSIS +Restore (Re-establish) the specified replication for the volume + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Restore-AzNetAppFilesReplication -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -Name <String> -SourceVolumeId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Restore-AzNetAppFilesReplication -SourceVolumeId <String> -ResourceId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Restore-AzNetAppFilesReplication -SourceVolumeId <String> -InputObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Restore (Re-establish) a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots + +## EXAMPLES + +### Example 1 +```powershell +Restore-AzNetAppFilesReplication -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyVolume" -SourceVolumeId "volumeResourceId" +``` + +This command Restores the replication for the volumes + +## PARAMETERS + +### -AccountName +The name of the ANF account of the replication volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The ANF replication destination volume object to restore/reestablish replication + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether Reestablish of the specified replication volume was performed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool of the replication volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceVolumeId +Resource id of the source volume for the replication + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.NetAppFiles/Restore-AzNetAppFilesSnapshotFile.md b/azps-10.1.0/Az.NetAppFiles/Restore-AzNetAppFilesSnapshotFile.md new file mode 100644 index 0000000000..2cc3305be9 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Restore-AzNetAppFilesSnapshotFile.md @@ -0,0 +1,262 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/restore-aznetappfilessnapshotfile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Restore-AzNetAppFilesSnapshotFile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Restore-AzNetAppFilesSnapshotFile.md +--- + +# Restore-AzNetAppFilesSnapshotFile + +## SYNOPSIS +Restore the specified files from the specified snapshot to the active filesystem + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Restore-AzNetAppFilesSnapshotFile -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -VolumeName <String> [-Name <String>] -FilePath <String[]> [-DestinationPath <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Restore-AzNetAppFilesSnapshotFile [-Name <String>] -FilePath <String[]> [-DestinationPath <String>] + -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Restore-AzNetAppFilesSnapshotFile [-Name <String>] -FilePath <String[]> [-DestinationPath <String>] + -VolumeObject <PSNetAppFilesVolume> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Restore the specified files from the specified snapshot to the active filesystem + +## EXAMPLES + +### Example 1 +```powershell +Restore-AzNetAppFilesSnapshotFile -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyVolume" -Name "MySnapshotName" -FilePath "/dir1/customer1.db" -DestinationPath "/AVSdataStore" +``` + +This command Restores the files provided in FilePath to the directory /AVSdataStore from the MyVolume snapshot called MySnapshotName + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPath +Destination folder where the files will be restored + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +List of files to be restored + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF snapshot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SnapshotName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified files where successfully restored + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF snapshot + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the snapshot + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshot + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.NetAppFiles/Restore-AzNetAppFilesVolume.md b/azps-10.1.0/Az.NetAppFiles/Restore-AzNetAppFilesVolume.md new file mode 100644 index 0000000000..d2ac1af592 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Restore-AzNetAppFilesVolume.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/restore-aznetappfilesvolume +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Restore-AzNetAppFilesVolume.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Restore-AzNetAppFilesVolume.md +--- + +# Restore-AzNetAppFilesVolume + +## SYNOPSIS +Restore/Revert a volume to one of its snapshots + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Restore-AzNetAppFilesVolume -ResourceGroupName <String> -AccountName <String> -PoolName <String> -Name <String> + [-SnapshotId <String>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Restore-AzNetAppFilesVolume -Name <String> -PoolObject <PSNetAppFilesPool> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Restore-AzNetAppFilesVolume -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Restore-AzNetAppFilesVolume -InputObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Restore/Revert a volume to the snapshot specified in the SnapshotId paramter + +## EXAMPLES + +### Example 1 +```powershell +Restore-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAccount" -PoolName "MyPool" -VolumeName "MyVolume" -SnapshotId "7d6e4069-6c78-6c61-7bf6-c60968e45fbf" +``` + +This command Restores/Reverts the volume MyVolume to one of its snapshots with the snapshotId of 7d6e4069-6c78-6c61-7bf6-c60968e45fbf + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The volume object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified volume was successfully restored/reverted + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolObject +The pool object containing the volume to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SnapshotId +SnapshotId of the snapshot. +UUID v4 used to identify the Snapshot + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) +[Set-AzNetAppFilesVolumePool](./Set-AzNetAppFilesVolumePool.md) +[Get-AzNetAppFilesVolumeBackupStatus](./Get-AzNetAppFilesVolumeBackupStatus.md) +[Get-AzNetAppFilesVolumeRestoreStatus](./Get-AzNetAppFilesVolumeRestoreStatus.md) +[Approve-AzNetAppFilesReplication](./Approve-AzNetAppFilesReplication.md) +[Initialize-AzNetAppFilesReplication](./Initialize-AzNetAppFilesReplication.md) +[Resume-AzNetAppFilesReplication](./Resume-AzNetAppFilesReplication.md) +[Remove-AzNetAppFilesReplication](./Remove-AzNetAppFilesReplication.md) diff --git a/azps-10.1.0/Az.NetAppFiles/Resume-AzNetAppFilesReplication.md b/azps-10.1.0/Az.NetAppFiles/Resume-AzNetAppFilesReplication.md new file mode 100644 index 0000000000..d0b2c55aab --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Resume-AzNetAppFilesReplication.md @@ -0,0 +1,226 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/resume-aznetappfilesreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Resume-AzNetAppFilesReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Resume-AzNetAppFilesReplication.md +--- + +# Resume-AzNetAppFilesReplication + +## SYNOPSIS +Resume/Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from source to destination. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Resume-AzNetAppFilesReplication -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Resume-AzNetAppFilesReplication -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Resume-AzNetAppFilesReplication -InputObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Resume/Resync the connection on the destination volume + +## EXAMPLES + +### Example 1 +```powershell +Resume-AzNetAppFilesReplication -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyDestinationAnfVolume" +``` + +This command resumes the ANF Replication connection on volume "MyDestinationAnfVolume". + +## PARAMETERS + +### -AccountName +The name of the ANF account of the replication volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The ANF replication destination volume object to resync + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether resync of the specified replication volume was performed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool of the replication volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Approve-AzNetAppFilesReplication](./Approve-AzNetAppFilesReplication.md) +[Inititialize-AzNetAppFilesReplication](./Approve-AzNetAppFilesReplication.md) +[Suspend-AzNetAppFilesReplication](./Suspend-AzNetAppFilesReplication.md) +[Remove-AzNetAppFilesReplication](./Remove-AzNetAppFilesReplication.md) +[Get-AzNetAppFilesReplicationStatus](./Get-AzNetAppFilesReplicationStatus.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesAccount.md b/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesAccount.md new file mode 100644 index 0000000000..ecc900b053 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesAccount.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/set-aznetappfilesaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Set-AzNetAppFilesAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Set-AzNetAppFilesAccount.md +--- + +# Set-AzNetAppFilesAccount + +## SYNOPSIS +Updates an Azure NetApp Files (ANF) account with the new data set. Useful for deletion of associated active directories. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Set-AzNetAppFilesAccount -ResourceGroupName <String> -Location <String> -Name <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceActiveDirectory +``` +Set-AzNetAppFilesAccount -Location <String> -Name <String> [-ActiveDirectory <PSNetAppFilesActiveDirectory[]>] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Set-AzNetAppFilesAccount -Location <String> -Name <String> [-Tag <Hashtable>] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetAppFilesAccount** cmdlet modifies an ANF account. + +## EXAMPLES + +### Example 1 : Modify an ANF account +```powershell +Set-AzNetAppFilesAccount -ResourceGroupName "MyRG" -Location "westus2" -Name "MyAnfAccount" +``` + +```output +Location : westus2 +Id : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount +Name : MyAnfAccount +Type : Microsoft.NetApp/netAppAccounts +Tags : +AccountId : 9fa2ca6d-1e48-4439-30e3-7de056e44e5a +ActiveDirectories : {} +ProvisioningState : Succeeded +``` + +This command performs an update on the given account. The absence of the active directory means it will be removed from the account. + +## PARAMETERS + +### -ActiveDirectory +A hashtable array which represents the active directories + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesActiveDirectory[] +Parameter Sets: SetByResourceActiveDirectory +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesAccount](./New-AzNetAppFilesAccount.md) +[Get-AzNetAppFilesAccount](./Get-AzNetAppFilesAccount.md) +[Remove-AzNetAppFilesAccount](./Remove-AzNetAppFilesAccount.md) +[Update-AzNetAppFilesAccount](./Update-AzNetAppFilesAccount.md) +[Get-AzNetAppFilesActiveDirectory](./Get-AzNetAppFilesActiveDirectory.md) +[New-AzNetAppFilesActiveDirectory](./New-AzNetAppFilesActiveDirectory.md) +[Remove-AzNetAppFilesActiveDirectory](./Remove-AzNetAppFilesActiveDirectory.md) +[Update-AzNetAppFilesActiveDirectory](./Update-AzNetAppFilesActiveDirectory.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesBackupPolicy.md b/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesBackupPolicy.md new file mode 100644 index 0000000000..0dff02a95c --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesBackupPolicy.md @@ -0,0 +1,292 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/set-aznetappfilesbackuppolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Set-AzNetAppFilesBackupPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Set-AzNetAppFilesBackupPolicy.md +--- + +# Set-AzNetAppFilesBackupPolicy + +## SYNOPSIS +Updates an Azure NetApp Files (ANF) Backup Policy with the new data set. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Set-AzNetAppFilesBackupPolicy -ResourceGroupName <String> -Location <String> -AccountName <String> + -Name <String> [-Enabled] [-DailyBackupsToKeep <Int32>] [-WeeklyBackupsToKeep <Int32>] + [-MonthlyBackupsToKeep <Int32>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Set-AzNetAppFilesBackupPolicy -Name <String> [-Enabled] [-DailyBackupsToKeep <Int32>] + [-WeeklyBackupsToKeep <Int32>] [-MonthlyBackupsToKeep <Int32>] [-Tag <Hashtable>] + -AccountObject <PSNetAppFilesAccount> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Set-AzNetAppFilesBackupPolicy -Name <String> [-Enabled] [-DailyBackupsToKeep <Int32>] + [-WeeklyBackupsToKeep <Int32>] [-MonthlyBackupsToKeep <Int32>] [-Tag <Hashtable>] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetAppFilesBackupPolicy** cmdlet modifies an ANF account. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzNetAppFilesBackupPolicy -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAccount" -Name "MyBackupPolicy" -Tag @{"tag1" = "tagValue"} -Enabled -DailyBackupsToKeep 1 -WeeklyBackupsToKeep 2 -MonthlyBackupsToKeep 2 +``` + +This command performs an update on the given backup policy. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account object for the new Backup Policy + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DailyBackupsToKeep +Daily backups count to keep + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The property to decide policy is enabled or not + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonthlyBackupsToKeep +Monthly backups count to keep + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF backup policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BackupPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable array which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeeklyBackupsToKeep +Weekly backups count to keep + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesSnapshotPolicy](./Get-AzNetAppFilesSnapshotPolicy.md) +[New-AzNetAppFilesSnapshotPolicy](./New-AzNetAppFilesSnapshotPolicy.md) +[Update-AzNetAppFilesSnapshotPolicy](./Update-AzNetAppFilesSnapshotPolicy.md) +[Remove-AzNetAppFilesSnapshotPolicy](./Remove-AzNetAppFilesSnapshotPolicy.md) +[Get-AzNetAppFilesSnapshot](./Get-AzNetAppFilesSnapshot.md) +[New-AzNetAppFilesSnapshot](./New-AzNetAppFilesSnapshot.md) +[Remove-AzNetAppFilesSnapshot](./Remove-AzNetAppFilesSnapshot.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesPool.md b/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesPool.md new file mode 100644 index 0000000000..9e45184f94 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesPool.md @@ -0,0 +1,284 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/set-aznetappfilespool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Set-AzNetAppFilesPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Set-AzNetAppFilesPool.md +--- + +# Set-AzNetAppFilesPool + +## SYNOPSIS +Updates an Azure NetApp Files (ANF) Capacity Pool with the new data set. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Set-AzNetAppFilesPool -ResourceGroupName <String> -Location <String> -AccountName <String> -Name <String> + -PoolSize <Int64> -ServiceLevel <String> [-QosType <String>] [-CoolAccess] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Set-AzNetAppFilesPool -Name <String> -PoolSize <Int64> -ServiceLevel <String> [-QosType <String>] [-CoolAccess] + [-Tag <Hashtable>] -AccountObject <PSNetAppFilesAccount> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Set-AzNetAppFilesPool -Name <String> -PoolSize <Int64> -ServiceLevel <String> [-QosType <String>] [-CoolAccess] + [-Tag <Hashtable>] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetAppFilesPool** cmdlet modifies an ANF Capacity Pool. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzNetAppFilesPool -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -Name "MyAnfPool" -Location "westus2" -PoolSize 4398046511104 -ServiceLevel "Premium" -QosType "Auto" +``` + +This command updates the new ANF pool "MyAnfPool" within the account "MyAnfAccount". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The account for the new pool object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CoolAccess +If enabled (true) the pool can contain cool Access enabled volumes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolSize +The size of the ANF pool + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QosType +The qos type of the pool. +Possible values include: 'Auto', 'Manual' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceLevel +The service level of the ANF pool. Possible values "Standard", "Premium", "Ultra" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesPool](./New-AzNetAppFilesPool.md) +[Get-AzNetAppFilesPool](./Get-AzNetAppFilesPool.md) +[Remove-AzNetAppFilesPool](./Remove-AzNetAppFilesPool.md) +[Update-AzNetAppFilesPool](./Update-AzNetAppFilesPool.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesSnapshotPolicy.md b/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesSnapshotPolicy.md new file mode 100644 index 0000000000..7796adc5e2 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesSnapshotPolicy.md @@ -0,0 +1,330 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/set-aznetappfilessnapshotpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Set-AzNetAppFilesSnapshotPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Set-AzNetAppFilesSnapshotPolicy.md +--- + +# Set-AzNetAppFilesSnapshotPolicy + +## SYNOPSIS +Updates an Azure NetApp Files (ANF) Snapshot Policy with the new data set. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Set-AzNetAppFilesSnapshotPolicy -ResourceGroupName <String> -Location <String> -AccountName <String> + -Name <String> [-Enabled] -HourlySchedule <PSNetAppFilesHourlySchedule> + -DailySchedule <PSNetAppFilesDailySchedule> -WeeklySchedule <PSNetAppFilesWeeklySchedule> + -MonthlySchedule <PSNetAppFilesMonthlySchedule> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Set-AzNetAppFilesSnapshotPolicy -Name <String> [-Enabled] -HourlySchedule <PSNetAppFilesHourlySchedule> + -DailySchedule <PSNetAppFilesDailySchedule> -WeeklySchedule <PSNetAppFilesWeeklySchedule> + -MonthlySchedule <PSNetAppFilesMonthlySchedule> [-Tag <Hashtable>] -AccountObject <PSNetAppFilesAccount> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Set-AzNetAppFilesSnapshotPolicy -Name <String> [-Enabled] -HourlySchedule <PSNetAppFilesHourlySchedule> + -DailySchedule <PSNetAppFilesDailySchedule> -WeeklySchedule <PSNetAppFilesWeeklySchedule> + -MonthlySchedule <PSNetAppFilesMonthlySchedule> [-Tag <Hashtable>] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetAppFilesSnapshotPolicy** cmdlet modifies an ANF Snapshot Policy. + +## EXAMPLES + +### Example 1 +```powershell +$hourlySchedule = @{ + Minute = 2 + SnapshotsToKeep = 6 + } + $dailySchedule = @{ + Hour = 1 + Minute = 2 + SnapshotsToKeep = 6 + } + $weeklySchedule = @{ + Minute = 2 + Hour = 1 + Day = "Sunday,Monday" + SnapshotsToKeep = 6 + } + $monthlySchedule = @{ + Minute = 2 + Hour = 1 + DaysOfMonth = "2,11,21" + SnapshotsToKeep = 6 + } +Set-AzNetAppFilesSnapshotPolicy -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAccount" -Name "MySnapshotPolicy" -Enabled -HourlySchedule $hourlySchedule -DailySchedule $dailySchedule -WeeklySchedule $weeklySchedule -MonthlySchedule $monthlySchedule +``` + +This command creates the new ANF snapshot policy for ANF account named account "MyAccount". + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account for the new Snapshot Policy object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DailySchedule +A hashtable array which represents the daily Schedule + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesDailySchedule +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The property to decide policy is enabled or not + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HourlySchedule +A hashtable array which represents the hourly Schedule + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesHourlySchedule +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonthlySchedule +A hashtable array which represents the montly Schedule + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesMonthlySchedule +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF snapshot policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SnapshotPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable array which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeeklySchedule +A hashtable array which represents the montly Schedule + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesWeeklySchedule +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshotPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesSnapshotPolicy](./Get-AzNetAppFilesSnapshotPolicy.md) +[New-AzNetAppFilesSnapshotPolicy](./New-AzNetAppFilesSnapshotPolicy.md) +[Update-AzNetAppFilesSnapshotPolicy](./Update-AzNetAppFilesSnapshotPolicy.md) +[Remove-AzNetAppFilesSnapshotPolicy](./Remove-AzNetAppFilesSnapshotPolicy.md) +[Get-AzNetAppFilesSnapshot](./Get-AzNetAppFilesSnapshot.md) +[New-AzNetAppFilesSnapshot](./New-AzNetAppFilesSnapshot.md) +[Remove-AzNetAppFilesSnapshot](./Remove-AzNetAppFilesSnapshot.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesVolumePool.md b/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesVolumePool.md new file mode 100644 index 0000000000..273e0f1b78 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Set-AzNetAppFilesVolumePool.md @@ -0,0 +1,245 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/set-aznetAppfilesvolumepool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Set-AzNetAppFilesVolumePool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Set-AzNetAppFilesVolumePool.md +--- + +# Set-AzNetAppFilesVolumePool + +## SYNOPSIS +Change pool for an Azure NetApp Files (ANF) volume. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Set-AzNetAppFilesVolumePool -ResourceGroupName <String> -AccountName <String> -PoolName <String> -Name <String> + [-NewPoolResourceId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Set-AzNetAppFilesVolumePool -Name <String> -PoolObject <PSNetAppFilesPool> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Set-AzNetAppFilesVolumePool -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Set-AzNetAppFilesVolumePool -InputObject <PSNetAppFilesVolume> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetAppFilesVolumePool** cmdlet changes the pool of an ANF volume. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzNetAppFilesVolumePool -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" -NewPoolResourceId 7d6e4069-6c78-6c61-7bf6-c60968e45fbf +``` + +This changes the pool for the volume MyVolume to one with the Id of 7d6e4069-6c78-6c61-7bf6-c60968e45fbf + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The volume object to move + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewPoolResourceId +ResourceId of the capacity pool to move to. +UUID v4 used to identify the pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolObject +The pool object containing the volume + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesPool](./Get-AzNetAppFilesPool.md) +[New-AzNetAppFilesPool](./New-AzNetAppFilesPool.md) +[Remove-AzNetAppFilesPool](./Remove-AzNetAppFilesPool.md) +[Update-AzNetAppFilesPool](./Update-AzNetAppFilesPool.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Suspend-AzNetAppFilesReplication.md b/azps-10.1.0/Az.NetAppFiles/Suspend-AzNetAppFilesReplication.md new file mode 100644 index 0000000000..08ecc9fed4 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Suspend-AzNetAppFilesReplication.md @@ -0,0 +1,241 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/suspend-aznetappfilesreplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Suspend-AzNetAppFilesReplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Suspend-AzNetAppFilesReplication.md +--- + +# Suspend-AzNetAppFilesReplication + +## SYNOPSIS +Suspend/break the replication connection on the destination volume + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Suspend-AzNetAppFilesReplication -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -Name <String> [-ForceBreak] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Suspend-AzNetAppFilesReplication -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Suspend-AzNetAppFilesReplication -InputObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Suspend/break the replication connection on the destination volume + +## EXAMPLES + +### Example 1 +```powershell +Suspend-AzNetAppFilesReplication -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyDestinationAnfVolume" +``` + +This command suspends the ANF Replication connection on volume "MyDestinationAnfVolume". + +## PARAMETERS + +### -AccountName +The name of the ANF account of the replication volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceBreak +If replication is in status transferring and you want to force break the replication, set to true + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The ANF destination volume object with the replication to break + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the break of the specified volume replication was performed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool of the replication volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF replication destination volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Approve-AzNetAppFilesReplication](./Approve-AzNetAppFilesReplication.md) +[Initialize-AzNetAppFilesReplication](./Initialize-AzNetAppFilesReplication.md) +[Resume-AzNetAppFilesReplication](./Resume-AzNetAppFilesReplication.md) +[Remove-AzNetAppFilesReplication](./Remove-AzNetAppFilesReplication.md) +[Get-AzNetAppFilesReplicationStatus](./Get-AzNetAppFilesReplicationStatus.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Unlock-AzNetAppFilesVolumeFileLock.md b/azps-10.1.0/Az.NetAppFiles/Unlock-AzNetAppFilesVolumeFileLock.md new file mode 100644 index 0000000000..3cbd499c16 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Unlock-AzNetAppFilesVolumeFileLock.md @@ -0,0 +1,254 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/unlock-aznetappfilesvolumefilelock +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Unlock-AzNetAppFilesVolumeFileLock.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Unlock-AzNetAppFilesVolumeFileLock.md +--- + +# Unlock-AzNetAppFilesVolumeFileLock + +## SYNOPSIS +Break file locks + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Unlock-AzNetAppFilesVolumeFileLock -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -Name <String> [-ClientIp <String>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Unlock-AzNetAppFilesVolumeFileLock -Name <String> [-ClientIp <String>] -PoolObject <PSNetAppFilesPool> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Unlock-AzNetAppFilesVolumeFileLock [-ClientIp <String>] -ResourceId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Unlock-AzNetAppFilesVolumeFileLock [-ClientIp <String>] -InputObject <PSNetAppFilesVolume> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Break all the file locks on a volume + +## EXAMPLES + +### Example 1 +```powershell +Unlock-AzNetAppFilesVolumeFileLock -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" +``` + +This command breaks file locks on the specified ANF volume + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientIp +To clear file locks on a volume for a particular client. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The volume object to break files locks on + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether FileLocks on the specified volumes where successfully broken + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolObject +The pool object containing the volume to break file locks on + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesAccount.md b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesAccount.md new file mode 100644 index 0000000000..87147a5161 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesAccount.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/update-aznetappfilesaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesAccount.md +--- + +# Update-AzNetAppFilesAccount + +## SYNOPSIS +Updates an Azure NetApp Files (ANF) account according to the optional modifiers provided. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Update-AzNetAppFilesAccount -ResourceGroupName <String> [-Location <String>] -Name <String> + [-ActiveDirectory <PSNetAppFilesActiveDirectory[]>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzNetAppFilesAccount -ResourceGroupName <String> [-Location <String>] -Name <String> + -ResourceId <String> [-ActiveDirectory <PSNetAppFilesActiveDirectory[]>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzNetAppFilesAccount -ResourceGroupName <String> [-Location <String>] -Name <String> + [-ActiveDirectory <PSNetAppFilesActiveDirectory[]>] -InputObject <PSNetAppFilesAccount> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzNetAppFilesAccount** cmdlet modifies an ANF account. + +## EXAMPLES + +### Example 1 : Updates an ANF account +```powershell +Update-AzNetAppFilesAccount -ResourceGroupName "MyRG" -Location "westus2" -Name "MyAnfAccount" -Tag @{'Tag1' = 'Value1'} +``` + +```output +Location : westus2 +Id : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount +Name : MyAnfAccount +Type : Microsoft.NetApp/netAppAccounts +Tags : {Tag1} +AccountId : 9fa2ca6d-1e48-4439-30e3-7de056e44e5a +ActiveDirectories : +ProvisioningState : Succeeded +``` + +This command performs an update on the given account modifying the tags to those provided. + +## PARAMETERS + +### -ActiveDirectory +A hashtable array which represents the active directories + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesActiveDirectory[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The account object to update + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesAccount](./New-AzNetAppFilesAccount.md) +[Get-AzNetAppFilesAccount](./Get-AzNetAppFilesAccount.md) +[Remove-AzNetAppFilesAccount](./Remove-AzNetAppFilesAccount.md) +[Set-AzNetAppFilesAccount](./Set-AzNetAppFilesAccount.md) +[Get-AzNetAppFilesActiveDirectory](./Get-AzNetAppFilesActiveDirectory.md) +[New-AzNetAppFilesActiveDirectory](./New-AzNetAppFilesActiveDirectory.md) +[Remove-AzNetAppFilesActiveDirectory](./Remove-AzNetAppFilesActiveDirectory.md) +[Update-AzNetAppFilesActiveDirectory](./Update-AzNetAppFilesActiveDirectory.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesAccountCredential.md b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesAccountCredential.md new file mode 100644 index 0000000000..07696f7f35 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesAccountCredential.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/update-aznetappfilesaccountcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesAccountCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesAccountCredential.md +--- + +# Update-AzNetAppFilesAccountCredential + +## SYNOPSIS +Renew identity credentials + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Update-AzNetAppFilesAccountCredential -ResourceGroupName <String> [-Location <String>] -Name <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzNetAppFilesAccountCredential -ResourceGroupName <String> [-Location <String>] -Name <String> + -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzNetAppFilesAccountCredential -ResourceGroupName <String> [-Location <String>] -Name <String> + -InputObject <PSNetAppFilesAccount> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzNetAppFilesAccountCredential -ResourceGroupName "MyRG" -Name "MyAnfAccount" +``` + +This command renews the identity credentials that are used to authenticate to key vault for the NetAppAccount named MyAnfAccount. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The account object to update credentials on + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified NetApp Accounts credentials were successfully renewed/updated + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesActiveDirectory.md b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesActiveDirectory.md new file mode 100644 index 0000000000..2b9726112f --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesActiveDirectory.md @@ -0,0 +1,515 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/update-aznetappfilesactivedirectory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesActiveDirectory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesActiveDirectory.md +--- + +# Update-AzNetAppFilesActiveDirectory + +## SYNOPSIS +Updates an Azure NetApp Files (ANF) active directory configuration to the optional modifiers provided. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Update-AzNetAppFilesActiveDirectory -ResourceGroupName <String> -AccountName <String> + -ActiveDirectoryId <String> [-Dns <String[]>] [-Domain <String>] [-Site <String>] [-SmbServerName <String>] + [-Username <String>] [-Password <SecureString>] [-OrganizationalUnit <String>] [-KdcIP <String>] + [-BackupOperator <String[]>] [-ServerRootCACertificate <String>] [-AdName <String>] + [-SecurityOperator <String[]>] [-AesEncryption] [-LdapSigning] [-LdapOverTLS] [-AllowLocalNfsUsersWithLdap] + [-Administrator <String[]>] [-EncryptDCConnection] [-LdapSearchScope <PSNetAppFilesLdapSearchScopeOpt>] + [-PreferredServersForLdapClient <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzNetAppFilesActiveDirectory -ActiveDirectoryId <String> [-Dns <String[]>] [-Domain <String>] + [-Site <String>] [-SmbServerName <String>] [-Username <String>] [-Password <SecureString>] + [-OrganizationalUnit <String>] [-KdcIP <String>] [-BackupOperator <String[]>] + [-ServerRootCACertificate <String>] [-AdName <String>] [-SecurityOperator <String[]>] [-AesEncryption] + [-LdapSigning] [-LdapOverTLS] [-AllowLocalNfsUsersWithLdap] [-Administrator <String[]>] [-EncryptDCConnection] + [-LdapSearchScope <PSNetAppFilesLdapSearchScopeOpt>] [-PreferredServersForLdapClient <String[]>] + -AccountObject <PSNetAppFilesAccount> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzNetAppFilesActiveDirectory [-Dns <String[]>] [-Domain <String>] [-Site <String>] + [-SmbServerName <String>] [-Username <String>] [-Password <SecureString>] [-OrganizationalUnit <String>] + [-KdcIP <String>] [-BackupOperator <String[]>] [-ServerRootCACertificate <String>] [-AdName <String>] + [-SecurityOperator <String[]>] [-AesEncryption] [-LdapSigning] [-LdapOverTLS] [-AllowLocalNfsUsersWithLdap] + [-Administrator <String[]>] [-EncryptDCConnection] [-LdapSearchScope <PSNetAppFilesLdapSearchScopeOpt>] + [-PreferredServersForLdapClient <String[]>] -InputObject <PSNetAppFilesActiveDirectory> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzNetAppFilesActiveDirectory** cmdlet modifies an ANF active directory configuration. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzNetAppFilesActiveDirectory -ResourceGroupName "MyRG" -AccountName "MyAccount" -AdName "MyADName" -Username $adUsername +``` + +This command performs an update on the given active directory configuration modifying the username to that provided. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The account for the active directory object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ActiveDirectoryId +The ID of the ANF active directory + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Administrator +Domain Users to be added to the Built-in Administrators Active Directory group. A list of unique usernames without domain specifier. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdName +Name of the active directory machine. +This optional parameter is used only while creating kerberos volume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AesEncryption +When AES is enabled, set if AES encryption will be enabled for SMB communication. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLocalNfsUsersWithLdap +If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupOperator +Users to be added to the Built-in Backup Operator active directory group. +A list of unique usernames without domain specifier + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Dns +Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +Name of the Active Directory domain + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptDCConnection +If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The active directory object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesActiveDirectory +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KdcIP +kdc server IP addresses for the active directory machine. +This optional parameter is used only while creating kerberos volume. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapOverTLS +When LDAP over SSL/TLS is enabled, specifies whether or not the LDAP traffic needs to be secured via TLS. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapSearchScope +LDAP Search scope options. + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesLdapSearchScopeOpt +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LdapSigning +When LDAP over SSL/TLS is enabled, Specifies whether or not the LDAP traffic needs to be signed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationalUnit +The Organizational Unit (OU) within the Windows Active Directory + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Plain text password of Active Directory domain administrator, value is masked in the response + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredServersForLdapClient +Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityOperator +Domain Users in the Active directory to be given Security Privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerRootCACertificate +When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Site +The Active Directory site the service will limit Domain Controller discovery to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmbServerName +NetBIOS name of the SMB server. +This name will be registered as a computer account in the AD and used to mount volumes + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Username +A domain user account with permission to create machine accounts + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesActiveDirectory + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesActiveDirectory + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesActiveDirectory](./Get-AzNetAppFilesActiveDirectory.md) +[New-AzNetAppFilesActiveDirectory](./New-AzNetAppFilesActiveDirectory.md) +[Remove-AzNetAppFilesActiveDirectory](./Remove-AzNetAppFilesActiveDirectory.md) +[Get-AzNetAppFilesAccount](./Get-AzNetAppFilesAccount.md) +[New-AzNetAppFilesAccount](./New-AzNetAppFilesAccount.md) +[Remove-AzNetAppFilesAccount](./Remove-AzNetAppFilesAccount.md) +[Set-AzNetAppFilesAccount](./Set-AzNetAppFilesAccount.md) +[Update-AzNetAppFilesAccount](./Update-AzNetAppFilesAccount.md) diff --git a/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesBackup.md b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesBackup.md new file mode 100644 index 0000000000..47c4057f5f --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesBackup.md @@ -0,0 +1,297 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/update-aznetappfilesbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesBackup.md +--- + +# Update-AzNetAppFilesBackup + +## SYNOPSIS +Updates an Azure NetApp Files (ANF) backup to the optional modifiers provided. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Update-AzNetAppFilesBackup -ResourceGroupName <String> -Location <String> -AccountName <String> -Name <String> + -PoolName <String> -VolumeName <String> [-Label <String>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzNetAppFilesBackup -Name <String> [-Label <String>] [-Tag <Hashtable>] + -VolumeObject <PSNetAppFilesVolume> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzNetAppFilesBackup [-Label <String>] [-Tag <Hashtable>] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzNetAppFilesBackup [-Label <String>] [-Tag <Hashtable>] -InputObject <PSNetAppFilesBackup> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzNetAppFilesBackup** cmdlet modifies an ANF backup. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName $accName1 -Name $backupPolicyObject -Label "updatedLabel" +``` + +This command performs an update on the given backup modifying the username to that provided. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The snapshot object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Label +Label for backup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF backup policy + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: BackupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Backup + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the backup to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesBackup](./New-AzNetAppFilesBackup.md) +[Get-AzNetAppFilesBackup](./Get-AzNetAppFilesBackup.md) +[Remove-AzNetAppFilesBackup](./Remove-AzNetAppFilesBackup.md) +[Get-AzNetAppFilesBackupPolicy](./Get-AzNetAppFilesBackupPolicy.md) +[New-AzNetAppFilesBackupPolicy](./New-AzNetAppFilesBackupPolicy.md) +[Update-AzNetAppFilesBackupPolicy](./Update-AzNetAppFilesBackupPolicy.md) +[Remove-AzNetAppFilesBackupPolicy](./Remove-AzNetAppFilesBackupPolicy.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesBackupPolicy.md b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesBackupPolicy.md new file mode 100644 index 0000000000..95825daa02 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesBackupPolicy.md @@ -0,0 +1,299 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/update-aznetappfilesbackuppolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesBackupPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesBackupPolicy.md +--- + +# Update-AzNetAppFilesBackupPolicy + +## SYNOPSIS +Updates an Azure NetApp Files (ANF) backup policy to the optional modifiers provided. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Update-AzNetAppFilesBackupPolicy -ResourceGroupName <String> -Location <String> -AccountName <String> + -Name <String> [-DailyBackupsToKeep <Int32>] [-WeeklyBackupsToKeep <Int32>] [-MonthlyBackupsToKeep <Int32>] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzNetAppFilesBackupPolicy -Name <String> [-DailyBackupsToKeep <Int32>] [-WeeklyBackupsToKeep <Int32>] + [-MonthlyBackupsToKeep <Int32>] [-Tag <Hashtable>] -AccountObject <PSNetAppFilesAccount> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzNetAppFilesBackupPolicy [-DailyBackupsToKeep <Int32>] [-WeeklyBackupsToKeep <Int32>] + [-MonthlyBackupsToKeep <Int32>] [-Tag <Hashtable>] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzNetAppFilesBackupPolicy [-DailyBackupsToKeep <Int32>] [-WeeklyBackupsToKeep <Int32>] + [-MonthlyBackupsToKeep <Int32>] [-Tag <Hashtable>] -InputObject <PSNetAppFilesBackupPolicy> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzNetAppFilesBackupPolicy** cmdlet modifies an ANF backup policy . + +## EXAMPLES + +### Example 1 +```powershell +Update-AzNetAppFilesBackupPolicy -ResourceGroupName "MyRG" -AccountName "MyAccount" -Name "MyBackupPolicy" -DailyBackupsToKeep 2 +``` + +This command changes the ANF backup policy "MyBackupPolicy" to have the given DailyBackupsToKeep. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account object containing the Backup Policy to update + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DailyBackupsToKeep +Daily backups count to keep + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The BackupPolicy object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonthlyBackupsToKeep +Monthly backups count to keep + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF backup policy + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: BackupPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Backup Policy + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable array which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeeklyBackupsToKeep +Weekly backups count to keep + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesSnapshotPolicy](./Get-AzNetAppFilesSnapshotPolicy.md) +[New-AzNetAppFilesSnapshotPolicy](./New-AzNetAppFilesSnapshotPolicy.md) +[Remove-AzNetAppFilesSnapshotPolicy](./Remove-AzNetAppFilesSnapshotPolicy.md) +[Set-AzNetAppFilesSnapshotPolicy](./Set-AzNetAppFilesSnapshotPolicy.md) +[Get-AzNetAppFilesSnapshot](./Get-AzNetAppFilesSnapshot.md) +[New-AzNetAppFilesSnapshot](./New-AzNetAppFilesSnapshot.md) +[Remove-AzNetAppFilesSnapshot](./Remove-AzNetAppFilesSnapshot.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesPool.md b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesPool.md new file mode 100644 index 0000000000..325e4682de --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesPool.md @@ -0,0 +1,304 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/update-aznetappfilespool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesPool.md +--- + +# Update-AzNetAppFilesPool + +## SYNOPSIS +Updates an Azure NetApp Files (ANF) pool according to the optional modifiers provided. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Update-AzNetAppFilesPool -ResourceGroupName <String> [-Location <String>] -AccountName <String> -Name <String> + [-PoolSize <Int64>] [-QosType <String>] [-CoolAccess] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzNetAppFilesPool -Name <String> [-PoolSize <Int64>] [-QosType <String>] [-CoolAccess] + [-Tag <Hashtable>] -AccountObject <PSNetAppFilesAccount> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzNetAppFilesPool [-PoolSize <Int64>] [-QosType <String>] [-CoolAccess] [-Tag <Hashtable>] + -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzNetAppFilesPool [-PoolSize <Int64>] [-QosType <String>] [-CoolAccess] [-Tag <Hashtable>] + -InputObject <PSNetAppFilesPool> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzNetAppFilesPool** cmdlet modifies an ANF pool. + +## EXAMPLES + +### Example 1: Modify an ANF pool +```powershell +Update-AzNetAppFilesPool -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -PoolSize 4398046511104 -QosType "Auto" +``` + +```output +Location : westus2 +Id : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount/capacityPools/MyAnfPool +Name : MyAnfAccount/MyAnfPool +Type : Microsoft.NetApp/netAppAccounts/capacityPools +Tags : +PoolId : 9fa2ca6d-1e48-4439-30e3-7de056e44e5a +Size : 4398046511104 +ServiceLevel : Standard +QosType : Auto +ProvisioningState : Succeeded +``` + +This command changes the ANF pool "MyAnfPool" to have the given size and QosType. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The account object containing the pool to update + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CoolAccess +If enabled (true) the pool can contain cool Access enabled volumes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The pool object to update + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: PoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolSize +The size of the ANF pool + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QosType +The qos type of the pool. Possible values include: 'Auto', 'Manual' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesPool](./New-AzNetAppFilesPool.md) +[Get-AzNetAppFilesPool](./Get-AzNetAppFilesPool.md) +[Remove-AzNetAppFilesPool](./Remove-AzNetAppFilesPool.md) +[Set-AzNetAppFilesPool](./Set-AzNetAppFilesPool.md) diff --git a/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesSnapshotPolicy.md b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesSnapshotPolicy.md new file mode 100644 index 0000000000..01bf2a1ce9 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesSnapshotPolicy.md @@ -0,0 +1,340 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/update-aznetappfilessnapshotpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesSnapshotPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesSnapshotPolicy.md +--- + +# Update-AzNetAppFilesSnapshotPolicy + +## SYNOPSIS +Updates an Azure NetApp Files (ANF) snapshot policy to the optional modifiers provided. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Update-AzNetAppFilesSnapshotPolicy -ResourceGroupName <String> -Location <String> -AccountName <String> + -Name <String> [-Enabled <Boolean>] [-HourlySchedule <PSNetAppFilesHourlySchedule>] + [-DailySchedule <PSNetAppFilesDailySchedule>] [-WeeklySchedule <PSNetAppFilesWeeklySchedule>] + [-MonthlySchedule <PSNetAppFilesMonthlySchedule>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzNetAppFilesSnapshotPolicy -Name <String> [-Enabled <Boolean>] + [-HourlySchedule <PSNetAppFilesHourlySchedule>] [-DailySchedule <PSNetAppFilesDailySchedule>] + [-WeeklySchedule <PSNetAppFilesWeeklySchedule>] [-MonthlySchedule <PSNetAppFilesMonthlySchedule>] + [-Tag <Hashtable>] -AccountObject <PSNetAppFilesAccount> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzNetAppFilesSnapshotPolicy [-Enabled <Boolean>] [-HourlySchedule <PSNetAppFilesHourlySchedule>] + [-DailySchedule <PSNetAppFilesDailySchedule>] [-WeeklySchedule <PSNetAppFilesWeeklySchedule>] + [-MonthlySchedule <PSNetAppFilesMonthlySchedule>] -ResourceId <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzNetAppFilesSnapshotPolicy [-Enabled <Boolean>] [-HourlySchedule <PSNetAppFilesHourlySchedule>] + [-DailySchedule <PSNetAppFilesDailySchedule>] [-WeeklySchedule <PSNetAppFilesWeeklySchedule>] + [-MonthlySchedule <PSNetAppFilesMonthlySchedule>] [-Tag <Hashtable>] + -InputObject <PSNetAppFilesSnapshotPolicy> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzNetAppFilesSnapshotPolicy** cmdlet modifies an ANF snapshot policy. + +## EXAMPLES + +### Example 1 +```powershell +$hourlySchedule = @{ + Minute = 1 + SnapshotsToKeep = 3 + } +Update-AzNetAppFilesSnapshotPolicy -ResourceGroupName "MyRG" -AccountName "MyAccount" -Name "MySnapshotPolicy" -HourlySchedule $hourlySchedule +``` + +This command changes the ANF backup policy "MySnapshotPolicy" to have the given HourlySchedule. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountObject +The Account for the new Snapshot Policy object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DailySchedule +A hashtable array which represents the daily Schedule + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesDailySchedule +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The property to decide policy is enabled or not + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HourlySchedule +A hashtable array which represents the hourly Schedule + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesHourlySchedule +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The snapshot object to remove + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshotPolicy +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonthlySchedule +A hashtable array which represents the montly Schedule + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesMonthlySchedule +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF snapshot policy + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: SnapshotPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Snapshot Policy + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable array which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeeklySchedule +A hashtable array which represents the montly Schedule + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesWeeklySchedule +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesAccount + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshotPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshotPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzNetAppFilesSnapshotPolicy](./Get-AzNetAppFilesSnapshotPolicy.md) +[New-AzNetAppFilesSnapshotPolicy](./New-AzNetAppFilesSnapshotPolicy.md) +[Remove-AzNetAppFilesSnapshotPolicy](./Remove-AzNetAppFilesSnapshotPolicy.md) +[Set-AzNetAppFilesSnapshotPolicy](./Set-AzNetAppFilesSnapshotPolicy.md) +[Get-AzNetAppFilesSnapshot](./Get-AzNetAppFilesSnapshot.md) +[New-AzNetAppFilesSnapshot](./New-AzNetAppFilesSnapshot.md) +[Remove-AzNetAppFilesSnapshot](./Remove-AzNetAppFilesSnapshot.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesSubvolume.md b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesSubvolume.md new file mode 100644 index 0000000000..a26619eb09 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesSubvolume.md @@ -0,0 +1,275 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/update-aznetappfilessubvolume +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesSubvolume.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesSubvolume.md +--- + +# Update-AzNetAppFilesSubvolume + +## SYNOPSIS +Updates an Azure NetApp Files (ANF) subvolume according to the optional modifiers provided. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Update-AzNetAppFilesSubvolume -ResourceGroupName <String> -AccountName <String> -PoolName <String> + [-VolumeName <String>] [-Name <String>] -Path <String> -Size <Int64> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzNetAppFilesSubvolume [-Name <String>] -Path <String> -Size <Int64> -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzNetAppFilesSubvolume [-Name <String>] -Path <String> -Size <Int64> -VolumeObject <PSNetAppFilesVolume> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzNetAppFilesSubvolume [-Name <String>] -Path <String> -Size <Int64> -InputObject <PSNetAppFilesBackup> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzNetAppFilesSubvolume** cmdlet updates an ANF subvolume. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzNetAppFilesSubvolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSubvolume" -Size Size +``` + +This command updates the ANF volume "MyAnfSubvolume" with the new size. This will truncate the subvolume to the provided size in bytes. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The subvolume object to update + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF Subvolume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SubvolumeName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Path for subvolume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF Subvolume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Size +Truncate subvolume to the provided size in bytes + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the subvolume to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupPolicy + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesSubvolume](./New-AzNetAppFilesSubvolume.md) +[Get-AzNetAppFilesSubvolume](./Get-AzNetAppFilesSubvolume.md) +[Remove-AzNetAppFilesSubvolume](./Remove-AzNetAppFilesSubvolume.md) +[Get-AzNetAppFilesSubvolume](./Get-AzNetAppFilesSubvolume.md) +[Get-AzNetAppFilesSubvolumeMetadata](./Get-AzNetAppFilesSubvolumeMetadata.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesVolume.md b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesVolume.md new file mode 100644 index 0000000000..e351c22892 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesVolume.md @@ -0,0 +1,476 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/update-aznetappfilesvolume +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesVolume.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesVolume.md +--- + +# Update-AzNetAppFilesVolume + +## SYNOPSIS +Updates an Azure NetApp Files (ANF) volume according to the optional modifiers provided. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Update-AzNetAppFilesVolume -ResourceGroupName <String> -Location <String> -AccountName <String> + -PoolName <String> -Name <String> [-UsageThreshold <Int64>] [-ServiceLevel <String>] + [-ExportPolicy <PSNetAppFilesVolumeExportPolicy>] [-Backup <PSNetAppFilesVolumeBackupProperties>] + [-ThroughputMibps <Double>] [-SnapshotPolicyId <String>] [-IsDefaultQuotaEnabled] + [-DefaultUserQuotaInKiB <Int64>] [-DefaultGroupQuotaInKiB <Int64>] [-Tag <Hashtable>] + [-UnixPermission <String>] [-CoolAccess] [-CoolnessPeriod <Int32>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzNetAppFilesVolume -Name <String> [-UsageThreshold <Int64>] [-ServiceLevel <String>] + [-ExportPolicy <PSNetAppFilesVolumeExportPolicy>] [-Backup <PSNetAppFilesVolumeBackupProperties>] + [-ThroughputMibps <Double>] [-SnapshotPolicyId <String>] [-IsDefaultQuotaEnabled] + [-DefaultUserQuotaInKiB <Int64>] [-DefaultGroupQuotaInKiB <Int64>] [-Tag <Hashtable>] + [-UnixPermission <String>] [-CoolAccess] [-CoolnessPeriod <Int32>] -PoolObject <PSNetAppFilesPool> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzNetAppFilesVolume [-UsageThreshold <Int64>] [-ServiceLevel <String>] + [-ExportPolicy <PSNetAppFilesVolumeExportPolicy>] [-Backup <PSNetAppFilesVolumeBackupProperties>] + [-ThroughputMibps <Double>] [-SnapshotPolicyId <String>] [-IsDefaultQuotaEnabled] + [-DefaultUserQuotaInKiB <Int64>] [-DefaultGroupQuotaInKiB <Int64>] [-Tag <Hashtable>] + [-UnixPermission <String>] [-CoolAccess] [-CoolnessPeriod <Int32>] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzNetAppFilesVolume [-UsageThreshold <Int64>] [-ServiceLevel <String>] + [-ExportPolicy <PSNetAppFilesVolumeExportPolicy>] [-Backup <PSNetAppFilesVolumeBackupProperties>] + [-ThroughputMibps <Double>] [-SnapshotPolicyId <String>] [-IsDefaultQuotaEnabled] + [-DefaultUserQuotaInKiB <Int64>] [-DefaultGroupQuotaInKiB <Int64>] [-Tag <Hashtable>] + [-UnixPermission <String>] [-CoolAccess] [-CoolnessPeriod <Int32>] -InputObject <PSNetAppFilesVolume> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzNetAppFilesVolume** cmdlet updates an ANF volume. + +## EXAMPLES + +### Example 1: Update an ANF volume +```powershell +Update-AzNetAppFilesVolume -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" -UsageThreshold Size +``` + +```output +Location : westus2 +Id : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount/capacityPools/MyAnfPool/volumes/MyAnfVolume +Name : MyAnfAccount/MyAnfPool/MyAnfVolume +Type : Microsoft.NetApp/netAppAccounts/capacityPools/volumes +Tags : +FileSystemId : 3e2773a7-2a72-d003-0637-1a8b1fa3eaaf +CreationToken : MyAnfVolume +ServiceLevel : Premium +UsageThreshold : 2199023255552 +ProvisioningState : Succeeded +SubnetId : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyRG-vnet/subnets/default +``` + +This command updates the ANF volume "MyAnfVolume" with the new UsageThreshold size. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Backup +A hashtable array which represents the backup object + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolumeBackupProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CoolAccess +Specifies whether Cool Access(tiering) is enabled for the volume (default false). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CoolnessPeriod +Specifies the number of days after which data that is not accessed by clients will be tiered (minimum 7, maximum 63). + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultGroupQuotaInKiB +Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultUserQuotaInKiB +Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExportPolicy +A hashtable array which represents the export policy + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolumeExportPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The volume object to update + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsDefaultQuotaEnabled +Specifies if default quota is enabled for the volume + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet +Aliases: VolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolObject +The pool object containing the volume to update + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceLevel +The service level of the ANF volume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnapshotPolicyId +Snapshot Policy ResourceId used to apply a snapshot policy to the volume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThroughputMibps +Maximum throughput in Mibps that can be achieved by this volume + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnixPermission +UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsageThreshold +The maximum storage quota allowed for a file system in bytes + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +## NOTES + +## RELATED LINKS + +[New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md) +[Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md) +[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md) +[Restore-AzNetAppFilesVolume](./Restore-AzNetAppFilesVolume.md) +[Set-AzNetAppFilesVolumePool](./Set-AzNetAppFilesVolumePool.md) +[Get-AzNetAppFilesVolumeBackupStatus](./Get-AzNetAppFilesVolumeBackupStatus.md) +[Get-AzNetAppFilesVolumeRestoreStatus](./Get-AzNetAppFilesVolumeRestoreStatus.md) +[Approve-AzNetAppFilesReplication](./Approve-AzNetAppFilesReplication.md) +[Initialize-AzNetAppFilesReplication](./Initialize-AzNetAppFilesReplication.md) +[Resume-AzNetAppFilesReplication](./Resume-AzNetAppFilesReplication.md) +[Remove-AzNetAppFilesReplication](./Remove-AzNetAppFilesReplication.md) diff --git a/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesVolumeQuotaRule.md b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesVolumeQuotaRule.md new file mode 100644 index 0000000000..829d574b50 --- /dev/null +++ b/azps-10.1.0/Az.NetAppFiles/Update-AzNetAppFilesVolumeQuotaRule.md @@ -0,0 +1,303 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml +Module Name: Az.NetAppFiles +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/update-aznetappfilesvolumequotarule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesVolumeQuotaRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesVolumeQuotaRule.md +--- + +# Update-AzNetAppFilesVolumeQuotaRule + +## SYNOPSIS +Updates an Azure NetApp Files (ANF) volume quota rule according to the optional modifiers provided. + +## SYNTAX + +### ByFieldsParameterSet (Default) +``` +Update-AzNetAppFilesVolumeQuotaRule -ResourceGroupName <String> -AccountName <String> -PoolName <String> + -VolumeName <String> -Name <String> [-Tag <Hashtable>] [-QuotaSize <Int32>] [-QuotaType <String>] + [-QuotaTarget <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Update-AzNetAppFilesVolumeQuotaRule -Name <String> [-Tag <Hashtable>] [-QuotaSize <Int32>] + [-QuotaType <String>] [-QuotaTarget <String>] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Update-AzNetAppFilesVolumeQuotaRule -Name <String> [-Tag <Hashtable>] [-QuotaSize <Int32>] + [-QuotaType <String>] [-QuotaTarget <String>] -VolumeObject <PSNetAppFilesVolume> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByObjectParameterSet +``` +Update-AzNetAppFilesVolumeQuotaRule -Name <String> [-Tag <Hashtable>] [-QuotaSize <Int32>] + [-QuotaType <String>] [-QuotaTarget <String>] -InputObject <PSNetAppFilesBackup> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzNetAppFilesVolumeQuotaRule** cmdlet updates an ANF volume quota rule. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzNetAppFilesVolumeQuotaRule -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -VolumeName "MyAnfVolume" -Name "MyVolumeQuotaRuleName" -QuotaSize 100006 +``` + +This command updates the ANF volume quota rule "MyVolumeQuotaRuleName" with the new quota size. + +## PARAMETERS + +### -AccountName +The name of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The VolumeQuotaRule object to update + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup +Parameter Sets: ByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ANF Subvolume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SubvolumeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolName +The name of the ANF pool + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuotaSize +Size of quota in KiBs + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuotaTarget +UserID/GroupID/SID based on the quota target type. +UserID and groupID can be found by running 'id' or 'getent' command for the user or group and SID can be found by running \<wmic useraccount where name='user-name' get sid\> + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuotaType +Type of quota + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the ANF account + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ANF VolumeQuotaRule + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeName +The name of the ANF volume + +```yaml +Type: System.String +Parameter Sets: ByFieldsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeObject +The volume object containing the subvolume to return + +```yaml +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## OUTPUTS + +### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayAuthenticationCertificate.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayAuthenticationCertificate.md new file mode 100644 index 0000000000..7cd5e71572 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayAuthenticationCertificate.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 38855E74-F30C-43DF-8D94-ABD7872BCE11 +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewayauthenticationcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayAuthenticationCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayAuthenticationCertificate.md +--- + +# Add-AzApplicationGatewayAuthenticationCertificate + +## SYNOPSIS +Adds an authentication certificate to an application gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewayAuthenticationCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> + -CertificateFile <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayAuthenticationCertificate** cmdlet adds an authentication certificate to an Azure application gateway. + +## EXAMPLES + +### Example 1: Add authentication certificate to an application gateway +```powershell +$appgw = Get-AzApplicationGateway -ResourceGroupName "rg" -Name "appGwName" +$appgw = Add-AzApplicationGatewayAuthenticationCertificate -ApplicationGateway $appgw -Name "cert01" -CertificateFile "C:\cert.cer" +$appgw = Set-AzApplicationGateway -ApplicationGateway $appgw +``` + +The first command gets an application gateway named appGwName and stores it in $appgw variable. +The second command adds authentication certificate named cert01 to the application gateway. +The third command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the name of application gateway for which this cmdlet adds an authentication certificate. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertificateFile +Specifies the path of the authentication certificate that this cmdlet adds. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a certificate that this cmdlet adds to the application gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Get-AzApplicationGatewayAuthenticationCertificate](./Get-AzApplicationGatewayAuthenticationCertificate.md) + +[New-AzApplicationGatewayAuthenticationCertificate](./New-AzApplicationGatewayAuthenticationCertificate.md) + +[Remove-AzApplicationGatewayAuthenticationCertificate](./Remove-AzApplicationGatewayAuthenticationCertificate.md) + +[Set-AzApplicationGatewayAuthenticationCertificate](./Set-AzApplicationGatewayAuthenticationCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayBackendAddressPool.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayBackendAddressPool.md new file mode 100644 index 0000000000..7b2545da2e --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayBackendAddressPool.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 6FBFAEFF-786D-440A-94B2-8C27BE033A0A +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewaybackendaddresspool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayBackendAddressPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayBackendAddressPool.md +--- + +# Add-AzApplicationGatewayBackendAddressPool + +## SYNOPSIS +Adds a back-end address pool to an application gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewayBackendAddressPool -ApplicationGateway <PSApplicationGateway> -Name <String> + [-BackendIPAddresses <String[]>] [-BackendFqdns <String[]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayBackendAddressPool** cmdlet adds a back-end address pool to an application gateway. +A back-end address can be specified using an IP address, a fully-qualified domain name (FQDN) or IP configuration IDs. + +## EXAMPLES + +### Example 1: Add a back-end address pool by using a back-end server FQDN +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "Pool02" -BackendFqdns "contoso1.com", " contoso1.com" +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command adds the back-end address pool of the application gateway stored in $AppGw by using FQDNs. + +### Example 2: Add a back-end address pool by using backend server IP addresses +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "Pool02" -BackendIPAddresses "10.10.10.10", "10.10.10.11" +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command adds the back-end address pool of the application gateway stored in $AppGw by using IP addresses. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway to which this cmdlet adds a back-end address pool. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -BackendFqdns +Specifies a list of backend FQDNs which this cmdlet adds as a back-end server pool. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendIPAddresses +Specifies a list of back-end IP addresses which this cmdlet adds as a back-end server pool. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the back-end server pool that this cmdlet adds. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayBackendAddressPool](./Get-AzApplicationGatewayBackendAddressPool.md) + +[Get-AzApplicationGatewayBackendAddressPool](./Get-AzApplicationGatewayBackendAddressPool.md) + +[New-AzApplicationGatewayBackendAddressPool](./New-AzApplicationGatewayBackendAddressPool.md) + +[Remove-AzApplicationGatewayBackendAddressPool](./Remove-AzApplicationGatewayBackendAddressPool.md) + +[Set-AzApplicationGatewayBackendAddressPool](./Set-AzApplicationGatewayBackendAddressPool.md) + +[Set-AzNetworkInterfaceIpConfig](./Set-AzNetworkInterfaceIpConfig.md) diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayBackendHttpSetting.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayBackendHttpSetting.md new file mode 100644 index 0000000000..1163e50405 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayBackendHttpSetting.md @@ -0,0 +1,322 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewaybackendhttpsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayBackendHttpSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayBackendHttpSetting.md +--- + +# Add-AzApplicationGatewayBackendHttpSetting + +## SYNOPSIS +Adds back-end HTTP settings to an application gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewayBackendHttpSetting -ApplicationGateway <PSApplicationGateway> -Name <String> + -Port <Int32> -Protocol <String> -CookieBasedAffinity <String> [-RequestTimeout <Int32>] + [-ConnectionDraining <PSApplicationGatewayConnectionDraining>] [-ProbeId <String>] + [-Probe <PSApplicationGatewayProbe>] + [-AuthenticationCertificates <PSApplicationGatewayAuthenticationCertificate[]>] + [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>] [-PickHostNameFromBackendAddress] + [-HostName <String>] [-AffinityCookieName <String>] [-Path <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Add-AzApplicationGatewayBackendHttpSetting cmdlet adds back-end HTTP settings to an application gateway. +Back-end HTTP settings are applied to all back-end servers in the pool. + +## EXAMPLES + +### Example 1: Add back-end HTTP settings to an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayBackendHttpSetting -ApplicationGateway $AppGw -Name "Setting02" -Port 88 -Protocol "HTTP" -CookieBasedAffinity "Disabled" +``` + +The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable.The second command adds back-end HTTP settings to the application gateway, setting the port to 88 and the protocol to HTTP and names the settings Setting02. + +### Example 2 + +Adds back-end HTTP settings to an application gateway. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Add-AzApplicationGatewayBackendHttpSetting -ApplicationGateway <PSApplicationGateway> -CookieBasedAffinity Enabled -Name 'Setting02' -PickHostNameFromBackendAddress -Port 88 -Probe <PSApplicationGatewayProbe> -Protocol http -RequestTimeout <Int32> +``` + +## PARAMETERS + +### -AffinityCookieName +Cookie name to use for the affinity cookie + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationGateway +Specifies the name of application gateway for which this cmdlet adds settings. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AuthenticationCertificates +Specifies authentication certificates for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionDraining +Connection draining of the backend http settings resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CookieBasedAffinity +Specifies whether cookie-based affinity should be enabled or disabled for the backend server pool. +The acceptable values for this parameter are: Disabled, Enabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +Sets host header to be sent to the backend servers. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the back-end HTTP settings which this cmdlet adds. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Path which should be used as a prefix for all HTTP requests. +If no value is provided for this parameter, then no path will be prefixed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PickHostNameFromBackendAddress +Flag if host header should be picked from the host name of the backend server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Specifies the port of the back-end server pool. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Probe +Specifies a probe to associate with a back-end server. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeId +Specifies the ID of the probe to associate with the back-end server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol for communication between application gateway and back-end servers. +The acceptable values for this parameter are: Http and Https. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestTimeout +Specifies the request time-out value. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedRootCertificate +Application gateway Trusted Root Certificates + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayBackendHttpSetting](./Get-AzApplicationGatewayBackendHttpSetting.md) + +[New-AzApplicationGatewayBackendHttpSetting](./New-AzApplicationGatewayBackendHttpSetting.md) + +[Remove-AzApplicationGatewayBackendHttpSetting](./Remove-AzApplicationGatewayBackendHttpSetting.md) + +[Set-AzApplicationGatewayBackendHttpSetting](./Set-AzApplicationGatewayBackendHttpSetting.md) + diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayBackendSetting.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayBackendSetting.md new file mode 100644 index 0000000000..ea3970c74e --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayBackendSetting.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewaybackendsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayBackendSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayBackendSetting.md +--- + +# Add-AzApplicationGatewayBackendSetting + +## SYNOPSIS +Adds back-end TCP\TLS settings to an application gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewayBackendSetting -ApplicationGateway <PSApplicationGateway> -Name <String> -Port <Int32> + -Protocol <String> [-Timeout <Int32>] [-ProbeId <String>] [-Probe <PSApplicationGatewayProbe>] + [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>] [-PickHostNameFromBackendAddress] + [-HostName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Add-AzApplicationGatewayBackendSetting cmdlet adds back-end TCP\TLS settings to an application gateway. +Back-end settings are applied to all back-end servers in the pool. + +## EXAMPLES + +### Example 1: Add back-end TCP\TLS settings to an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayBackendSetting -ApplicationGateway $Appgw -Name "Setting01" -Port 88 -Protocol TCP +``` + +The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable.The second command adds back-end settings to the application gateway, setting the port to 88 and the protocol to TCP and names the settings Setting01. + +## PARAMETERS + +### -ApplicationGateway +Specifies the name of application gateway for which this cmdlet adds settings. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +Sets host header to be sent to the backend servers. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the backend settings + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PickHostNameFromBackendAddress +Flag if host header should be picked from the host name of the backend server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Port + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Probe +Application gateway Probe + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeId +ID of the application gateway Probe + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TCP, TLS + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +Timeout. +Default value 30 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedRootCertificate +Application gateway Trusted Root Certificates + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayBackendSetting](./Get-AzApplicationGatewayBackendSetting.md) + +[New-AzApplicationGatewayBackendSetting](./New-AzApplicationGatewayBackendSetting.md) + +[Remove-AzApplicationGatewayBackendSetting](./Remove-AzApplicationGatewayBackendSetting.md) + +[Set-AzApplicationGatewayBackendSetting](./Set-AzApplicationGatewayBackendSetting.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayCustomError.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayCustomError.md new file mode 100644 index 0000000000..c042c4bae8 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayCustomError.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewaycustomerror +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayCustomError.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayCustomError.md +--- + +# Add-AzApplicationGatewayCustomError + +## SYNOPSIS +Adds a custom error to an application gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewayCustomError -ApplicationGateway <PSApplicationGateway> -StatusCode <String> + -CustomErrorPageUrl <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayCustomError** cmdlet adds a custom error to an application gateway. + +## EXAMPLES + +### Example 1: Adds custom error to application gateway level +```powershell +$resourceGroupName = "resourceGroupName" +$AppGWName = "applicationGatewayName" +$AppGw = Get-AzApplicationGateway -Name $AppGWName -ResourceGroupName $resourceGroupName +$customError502Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/502.htm" +$updatedgateway = Add-AzApplicationGatewayCustomError -ApplicationGateway $AppGw -StatusCode HttpStatus502 -CustomErrorPageUrl $customError502Url +Set-AzApplicationGateway -ApplicationGateway $AppGw +``` + +This command adds a custom error of http status code 502 to the application gateway $appgw, and return the updated gateway. + +### Example 2: Adds custom error to application gateway listener level +```powershell +$resourceGroupName = "resourceGroupName" + $AppGWName = "applicationGatewayName" + $customError502Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/502.htm" + $listenerName = "listenerName" + $AppGw = Get-AzApplicationGateway -Name $AppGWName -ResourceGroupName $resourceGroupName + $listener = Get-AzApplicationGatewayHttpListener -ApplicationGateway $AppGW -Name $listenerName + $updatedListener = Add-AzApplicationGatewayHttpListenerCustomError -HttpListener $listener -StatusCode HttpStatus502 -CustomErrorPageUrl $customError502Url + Set-AzApplicationGateway -ApplicationGateway $AppGw +``` + +This command adds a custom error of http status code 502 to the application gateway $appgw at the listener level, and return the updated gateway. + +## PARAMETERS + +### -ApplicationGateway +The Application Gateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CustomErrorPageUrl +Error page URL of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusCode +Status code of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayCustomError](./Get-AzApplicationGatewayCustomError.md) + +[New-AzApplicationGatewayCustomError](./New-AzApplicationGatewayCustomError.md) + +[Remove-AzApplicationGatewayCustomError](./Remove-AzApplicationGatewayCustomError.md) + +[Set-AzApplicationGatewayCustomError](./Set-AzApplicationGatewayCustomError.md) diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayFrontendIPConfig.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayFrontendIPConfig.md new file mode 100644 index 0000000000..63034bf9df --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayFrontendIPConfig.md @@ -0,0 +1,262 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 0ECE4232-EA5D-46A0-8260-69646E27FA9A +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewayfrontendipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayFrontendIPConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayFrontendIPConfig.md +--- + +# Add-AzApplicationGatewayFrontendIPConfig + +## SYNOPSIS +Adds a front-end IP configuration to an application gateway. + +## SYNTAX + +### SetByResourceId +``` +Add-AzApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + [-PrivateIPAddress <String>] [-SubnetId <String>] [-PublicIPAddressId <String>] + [-PrivateLinkConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +Add-AzApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + [-PrivateIPAddress <String>] [-Subnet <PSSubnet>] [-PublicIPAddress <PSPublicIpAddress>] + [-PrivateLinkConfiguration <PSApplicationGatewayPrivateLinkConfiguration>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayFrontendIPConfig** cmdlet adds a front-end IP configuration to an application gateway. +An application gateway supports two types of front-end IP configurations: +- Public IP addresses +- Private IP addresses using internal load-balancing (ILB) +An application gateway can have at most one public IP and one private IP. +Add the public IP address and private IP address as separate front-end IPs. + +## EXAMPLES + +### Example 1: Add a public IP as the front-end IP address +```powershell +$PublicIp = New-AzPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIp01" -location "West US" -AllocationMethod Dynamic +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontEndIp01" -PublicIPAddress $PublicIp +``` + +The first command creates a public IP address object and stores it in the $PublicIp variable. +The second command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The third command adds the front-end IP configuration named FrontEndIp01, for the gateway in $AppGw, using the address stored in $PublicIp. + +### Example 2: Add a static private IP as the front-end IP address +```powershell +$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" +$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontendIP02" -Subnet $Subnet -PrivateIPAddress 10.0.1.1 +``` + +The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. +The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. +The third command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command and the private IP address 10.0.1.1. + +### Example 3: Add a dynamic private IP as the front-end IP address +```powershell +$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" +$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontendIP02" -Subnet $Subnet +``` + +The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. +The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. +The third command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway to which this cmdlet adds a front-end IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the front-end IP configuration to add. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIPAddress +Specifies the private IP address to add as a front-end IP for the application gateway. +If specified, this IP is statically allocated from the subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkConfiguration +PrivateLinkConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkConfigurationId +PrivateLinkConfigurationId + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIPAddress +Specifies the public IP address which this cmdlet adds as a front-end IP address for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIPAddressId +Specifies the ID of the public IP address which this cmdlet adds as a front-end IP address for the application gateway. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Specifies the subnet which this cmdlet adds as front-end IP configuration. +If you specify this parameter, it implies that the application gateway supports a private IP based-configuration. +If the *PrivateIPAddress* parameter is specified, it should belong to this subnet. +If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Specifies the subnet ID which this cmdlet adds as the front-end IP configuration. +Passing subnet implies private IP. +If the *PrivateIPAddress* parameter is specified, it should belong to this subnet. +Otherwise, one of the IP from this subnet is dynamically picked up as the front-end IP of the application gateway. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayFrontendIPConfig](./Get-AzApplicationGatewayFrontendIPConfig.md) + +[New-AzApplicationGatewayFrontendIPConfig](./New-AzApplicationGatewayFrontendIPConfig.md) + +[Remove-AzApplicationGatewayFrontendIPConfig](./Remove-AzApplicationGatewayFrontendIPConfig.md) + +[Set-AzApplicationGatewayFrontendIPConfig](./Set-AzApplicationGatewayFrontendIPConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayFrontendPort.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayFrontendPort.md new file mode 100644 index 0000000000..90dd0f3605 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayFrontendPort.md @@ -0,0 +1,122 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 40198C86-A4EB-494A-86D5-DF632518EB95 +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewayfrontendport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayFrontendPort.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayFrontendPort.md +--- + +# Add-AzApplicationGatewayFrontendPort + +## SYNOPSIS +Adds a front-end port to an application gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewayFrontendPort -ApplicationGateway <PSApplicationGateway> -Name <String> -Port <Int32> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayFrontendPort** cmdlet adds a front-end port to an application gateway. + +## EXAMPLES + +### Example 1: Add a front-end port to an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayFrontendPort -ApplicationGateway $AppGw -Name "FrontEndPort01" -Port 80 +``` + +The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command adds port 80 as a front-end port for the application gateway stored in $AppGw and names the port FrontEndPort01. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway to which this cmdlet adds a front-end port. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the front-end port. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Specifies the port number. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayFrontendPort](./Get-AzApplicationGatewayFrontendPort.md) + +[New-AzApplicationGatewayFrontendPort](./New-AzApplicationGatewayFrontendPort.md) + +[Remove-AzApplicationGatewayFrontendPort](./Remove-AzApplicationGatewayFrontendPort.md) + +[Set-AzApplicationGatewayFrontendPort](./Set-AzApplicationGatewayFrontendPort.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayHttpListener.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayHttpListener.md new file mode 100644 index 0000000000..62aeaff1e5 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayHttpListener.md @@ -0,0 +1,369 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 1E192553-61D8-4449-936B-68CF866C710C +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewayhttplistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayHttpListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayHttpListener.md +--- + +# Add-AzApplicationGatewayHttpListener + +## SYNOPSIS +Adds an HTTP listener to an application gateway. + +## SYNTAX + +### SetByResourceId +``` +Add-AzApplicationGatewayHttpListener -ApplicationGateway <PSApplicationGateway> -Name <String> + [-FrontendIPConfigurationId <String>] [-FrontendPortId <String>] [-SslCertificateId <String>] + [-FirewallPolicyId <String>] [-SslProfileId <String>] [-HostName <String>] [-HostNames <String[]>] + [-RequireServerNameIndication <String>] -Protocol <String> + [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SetByResource +``` +Add-AzApplicationGatewayHttpListener -ApplicationGateway <PSApplicationGateway> -Name <String> + [-FrontendIPConfiguration <PSApplicationGatewayFrontendIPConfiguration>] + [-FrontendPort <PSApplicationGatewayFrontendPort>] + [-FirewallPolicy <PSApplicationGatewayWebApplicationFirewallPolicy>] + [-SslCertificate <PSApplicationGatewaySslCertificate>] [-SslProfile <PSApplicationGatewaySslProfile>] + [-HostName <String>] [-HostNames <String[]>] [-RequireServerNameIndication <String>] -Protocol <String> + [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayHttpListener** cmdlet adds a HTTP listener to an application gateway. + +## EXAMPLES + +### Example 1: Add a HTTP listener +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Appgw = Add-AzApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "listener01" -Protocol "Http" -FrontendIpConfiguration $FIP01 -FrontendPort $FP01 +``` + +The first command gets the application gateway and stores it in the $AppGw variable.The second command adds the HTTP listener to the application gateway. + +### Example 2: Add a HTTPS listener with SSL +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "Listener01" -Protocol "Https" -FrontendIpConfiguration $FIP01 -FrontendPort $FP01 -SslCertificate $SSLCert01 +``` + +The first command gets the application gateway and stores it in the $AppGw variable. +The second command adds the listener, which uses the HTTPS protocol, to the application gateway. + +### Example 3: Add a HTTPS listener with SSL and HostNames +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "Listener01" -Protocol "Https" -FrontendIpConfiguration $FIP01 -FrontendPort $FP01 -SslCertificate $SSLCert01 -HostNames "*.contoso.com","www.microsoft.com" +``` + +The first command gets the application gateway and stores it in the $AppGw variable. +The second command adds the listener, which uses the HTTPS protocol, with SSL Certificates and HostNames, to the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway to which this cmdlet adds an HTTP listener. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CustomErrorConfiguration +Customer error of an application gateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicy +FirewallPolicy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallPolicy +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicyId +FirewallPolicyId + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIPConfiguration +Specifies the application gateway front-end IP resource object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIPConfigurationId +Specifies the application gateway front-end IP ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendPort +Specifies the application gateway front-end port object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendPortId +Specifies the application gateway front-end port ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +Specifies the host name that this cmdlet adds a HTTP listener to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostNames +Host names + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the front-end port that this command adds. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol of the HTTP listener. +Both HTTP and HTTPS are supported. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireServerNameIndication +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: true, false + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificate +Specifies the SSL certificate of the HTTP listener. +Must be specified if HTTPS is chosen as listener protocol. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificateId +Specifies the SSL certificate ID of the HTTP listener. +Must be specified if HTTPS is chosen as listener protocol. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfile +SslProfile + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfileId +SslProfileId + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayHttpListener](./Get-AzApplicationGatewayHttpListener.md) + +[New-AzApplicationGatewayHttpListener](./New-AzApplicationGatewayHttpListener.md) + +[Remove-AzApplicationGatewayHttpListener](./Remove-AzApplicationGatewayHttpListener.md) + +[Set-AzApplicationGatewayHttpListener](./Set-AzApplicationGatewayHttpListener.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayHttpListenerCustomError.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayHttpListenerCustomError.md new file mode 100644 index 0000000000..26ed7d43b9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayHttpListenerCustomError.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewayhttplistenercustomerror +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayHttpListenerCustomError.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayHttpListenerCustomError.md +--- + +# Add-AzApplicationGatewayHttpListenerCustomError + +## SYNOPSIS +Adds a custom error to a http listener of an application gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewayHttpListenerCustomError -HttpListener <PSApplicationGatewayHttpListener> + -StatusCode <String> -CustomErrorPageUrl <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayCustomError** cmdlet adds a custom error to a http listener of an application gateway. + +## EXAMPLES + +### Example 1: Adds custom error to http listener level +```powershell +$customError502Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/502.htm" +$updatedlistener = Add-AzApplicationGatewayHttpListenerCustomError -HttpListener $listener01 -StatusCode HttpStatus502 -CustomErrorPageUrl $customError502Url +``` + +This command adds a custom error of http status code 502 to the http listener $listener01, and return the updated listener. + +## PARAMETERS + +### -CustomErrorPageUrl +Error page URL of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpListener +The Application Gateway Http Listener + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StatusCode +Status code of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayHttpListenerCustomError](./Get-AzApplicationGatewayHttpListenerCustomError.md) + +[Remove-AzApplicationGatewayHttpListenerCustomError](./Remove-AzApplicationGatewayHttpListenerCustomError.md) + +[Set-AzApplicationGatewayHttpListenerCustomError](./Set-AzApplicationGatewayHttpListenerCustomError.md) diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayIPConfiguration.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayIPConfiguration.md new file mode 100644 index 0000000000..4b4f947f3a --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayIPConfiguration.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 5358C08F-A1EB-457E-85B1-7F12396A873A +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewayipconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayIPConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayIPConfiguration.md +--- + +# Add-AzApplicationGatewayIPConfiguration + +## SYNOPSIS +Adds an IP configuration to an application gateway. + +## SYNTAX + +### SetByResourceId +``` +Add-AzApplicationGatewayIPConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> + [-SubnetId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +Add-AzApplicationGatewayIPConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> + [-Subnet <PSSubnet>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayIPConfiguration** cmdlet adds an IP configuration to an application gateway. +IP configurations contain the subnet in which the application gateway is deployed. + +## EXAMPLES + +### Example 1: Add an virtual network configuration to an application gateway +```powershell +$Vnet = Get-AzVirtualNetwork -Name "Vnet01" -ResourceGroupName "ResourceGroup01" +$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $Vnet +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayIPConfiguration -ApplicationGateway $AppGw -Name "Appgwsubnet01" -Subnet $Subnet +``` + +The first command gets a virtual network. +The second command gets a subnet using the previously created virtual network. +The third command gets the application gateway and stores it in the $AppGw variable. +The fourth command adds the IP configuration to the application gateway stored in $AppGw. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway to which this cmdlet adds an IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the IP configuration to add. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Specifies a subnet. +This is the subnet in which the application gateway is deployed. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Specifies a subnet ID. +This is the subnet in which the application gateway is deployed. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayIPConfiguration](./Get-AzApplicationGatewayIPConfiguration.md) + +[New-AzApplicationGatewayIPConfiguration](./New-AzApplicationGatewayIPConfiguration.md) + +[Remove-AzApplicationGatewayIPConfiguration](./Remove-AzApplicationGatewayIPConfiguration.md) + +[Set-AzApplicationGatewayIPConfiguration](./Set-AzApplicationGatewayIPConfiguration.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayListener.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayListener.md new file mode 100644 index 0000000000..d03c5ed3d7 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayListener.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewaylistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayListener.md +--- + +# Add-AzApplicationGatewayListener + +## SYNOPSIS +Adds an listener to an application gateway. + +## SYNTAX + +### SetByResource (Default) +``` +Add-AzApplicationGatewayListener -ApplicationGateway <PSApplicationGateway> -Name <String> + [-FrontendIPConfiguration <PSApplicationGatewayFrontendIPConfiguration>] + [-FrontendPort <PSApplicationGatewayFrontendPort>] [-SslCertificate <PSApplicationGatewaySslCertificate>] + [-SslProfile <PSApplicationGatewaySslProfile>] -Protocol <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SetByResourceId +``` +Add-AzApplicationGatewayListener -ApplicationGateway <PSApplicationGateway> -Name <String> + [-FrontendIPConfigurationId <String>] [-FrontendPortId <String>] [-SslCertificateId <String>] + [-SslProfileId <String>] -Protocol <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayListener** cmdlet adds a TCP\TLS listener to an application gateway. + +## EXAMPLES + +### Example 1: Add a listener +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayListener -ApplicationGateway $Appgw -Name "Listener01" -Protocol "TCP" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01 +``` + +The first command gets the application gateway and stores it in the $AppGw variable.The second command adds the listener to the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIPConfiguration +Application gateway FrontendIPConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIPConfigurationId +ID of the application gateway FrontendIPConfiguration + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendPort +Application gateway FrontendPort + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendPortId +ID of the application gateway FrontendPort + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Listener + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TCP, TLS + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificate +Application gateway SslCertificate + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificateId +ID of the application gateway SslCertificate + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfile +SslProfile + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfileId +SslProfileId + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayListener](./Get-AzApplicationGatewayListener.md) + +[New-AzApplicationGatewayListener](./New-AzApplicationGatewayListener.md) + +[Remove-AzApplicationGatewayListener](./Remove-AzApplicationGatewayListener.md) + +[Set-AzApplicationGatewayListener](./Set-AzApplicationGatewayListener.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayPrivateLinkConfiguration.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayPrivateLinkConfiguration.md new file mode 100644 index 0000000000..4c0e1d7f73 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayPrivateLinkConfiguration.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewayprivatelinkconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayPrivateLinkConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayPrivateLinkConfiguration.md +--- + +# Add-AzApplicationGatewayPrivateLinkConfiguration + +## SYNOPSIS +Adds a private link configuration to an application gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewayPrivateLinkConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> + -IpConfiguration <PSApplicationGatewayPrivateLinkIpConfiguration[]> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayPrivateLinkConfiguration** cmdlet adds a private link configuration to an application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$PrivateLinkIpConfiguration = New-AzApplicationGatewayPrivateLinkIpConfiguration -Name "ipConfig01" -Subnet $subnet -Primary +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayPrivateLinkConfiguration -ApplicationGateway $AppGw -Name "privateLinkConfig01" -IpConfiguration $PrivateLinkIpConfiguration +``` + +The first command creates a privateLinkIpConfiguration and stores it in the $PrivateLinkIpConfiguration variable. +The second command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The third command adds the private link configuration named privateLinkConfig01, for the gateway in $AppGw + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfiguration +The list of ipConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkIpConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the privateLink configuration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkIpConfiguration[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayPrivateLinkConfiguration](./New-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Get-AzApplicationGatewayPrivateLinkConfiguration](./Get-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Remove-AzApplicationGatewayPrivateLinkConfiguration](./Remove-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Set-AzApplicationGatewayPrivateLinkConfiguration](./Set-AzApplicationGatewayPrivateLinkConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayProbeConfig.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayProbeConfig.md new file mode 100644 index 0000000000..34a7e0d918 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayProbeConfig.md @@ -0,0 +1,272 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewayprobeconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayProbeConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayProbeConfig.md +--- + +# Add-AzApplicationGatewayProbeConfig + +## SYNOPSIS +Adds a health probe to an Application Gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewayProbeConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + -Protocol <String> [-HostName <String>] [-Path <String>] -Interval <Int32> -Timeout <Int32> + -UnhealthyThreshold <Int32> [-PickHostNameFromBackendHttpSettings] [-MinServers <Int32>] [-Port <Int32>] + [-Match <PSApplicationGatewayProbeHealthResponseMatch>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Add-AzApplicationGatewayProbeConfig cmdlet adds a health probe to an Application Gateway. + +## EXAMPLES + +### Example 1: Add a health probe to an application gateway +```powershell +$Probe = Add-AzApplicationGatewayProbeConfig -ApplicationGateway Gateway -Name "Probe01" -Protocol Http -HostName "contoso.com" -Path "/path/custompath.htm" -Interval 30 -Timeout 120 -UnhealthyThreshold 8 +``` + +This command adds a health probe named Probe01 for the application gateway named Gateway. +The command also sets the unhealthy threshold to 8 retries and times out after 120 seconds. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway to which this cmdlet adds a probe. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +Specifies the host name that this cmdlet sends the probe to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Interval +Specifies the probe interval in seconds. +This is the time interval between two consecutive probes. +This value is between 1 second and 86400 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Match +Body that must be contained in the health response. +Default value is empty + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbeHealthResponseMatch +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinServers +Minimum number of servers that are always marked healthy. +Default value is 0 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the probe. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the relative path of probe. +Valid path start with the slash character (/). +The probe is sent to \<Protocol\>://\<host\>:\<port\>\<path\>. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PickHostNameFromBackendHttpSettings +Whether the host header should be picked from the backend http settings. +Default value is false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Port that is used for probing the backend server + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol used to send probe. +This cmdlet supports HTTP only. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https, TCP, TLS + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +Specifies the probe timeout in seconds. +This cmdlet marks the probe as failed if a valid response is not received with this timeout period. +Valid values are between 1 second and 86400 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnhealthyThreshold +Specifies the probe retry count. +The backend server is marked down after consecutive probe failure count reaches the unhealthy threshold. +Valid values are between 1 second and 20 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add a probe to an existing application gateway](https://azure.microsoft.com/en-us/documentation/articles/application-gateway-create-probe-ps/#add-a-probe-to-an-existing-application-gateway) + +[Get-AzApplicationGatewayProbeConfig](./Get-AzApplicationGatewayProbeConfig.md) + +[New-AzApplicationGatewayProbeConfig](./New-AzApplicationGatewayProbeConfig.md) + +[Remove-AzApplicationGatewayProbeConfig](./Remove-AzApplicationGatewayProbeConfig.md) + +[Set-AzApplicationGatewayProbeConfig](./Set-AzApplicationGatewayProbeConfig.md) + diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayRedirectConfiguration.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayRedirectConfiguration.md new file mode 100644 index 0000000000..ce4962abfe --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayRedirectConfiguration.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewayredirectconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayRedirectConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayRedirectConfiguration.md +--- + +# Add-AzApplicationGatewayRedirectConfiguration + +## SYNOPSIS +Adds a redirect configuration to an Application Gateway. + +## SYNTAX + +### SetByResourceId +``` +Add-AzApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> + -RedirectType <String> [-TargetListenerID <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +Add-AzApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> + -RedirectType <String> [-TargetListener <PSApplicationGatewayHttpListener>] [-IncludePath <Boolean>] + [-IncludeQueryString <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByURL +``` +Add-AzApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> + -RedirectType <String> [-TargetUrl <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayRedirectConfiguration** cmdlet adds a redirect configuration to an Application Gateway. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Appgw = Add-AzApplicationGatewayRedirectConfiguration -ApplicationGateway $AppGw -Name "Redirect01" -RedirectType Permanent -TargetListener $listener01 +``` + +The first command gets the application gateway and stores it in the $AppGw variable. +The second command adds the redirect configuration to the application gateway. + +### Example 2 + +Adds a redirect configuration to an Application Gateway. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Add-AzApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -IncludePath $false -IncludeQueryString $false -Name 'Redirect01' -RedirectType Permanent -TargetListener <PSApplicationGatewayHttpListener> +``` + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePath +Include path in the redirected url. +Default is true. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeQueryString +Include query string in the redirected url. +Default is true. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Redirect Configuration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectType +The type of redirect + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Permanent, Found, SeeOther, Temporary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetListener +HTTP listener to redirect the request to + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetListenerID +ID of HTTP listener to redirect the request to + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetUrl +Target URL fo redirection + +```yaml +Type: System.String +Parameter Sets: SetByURL +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayRedirectConfiguration](./Get-AzApplicationGatewayRedirectConfiguration.md) + +[New-AzApplicationGatewayRedirectConfiguration](./New-AzApplicationGatewayRedirectConfiguration.md) + +[Remove-AzApplicationGatewayRedirectConfiguration](./Remove-AzApplicationGatewayRedirectConfiguration.md) + +[Set-AzApplicationGatewayRedirectConfiguration](./Set-AzApplicationGatewayRedirectConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayRequestRoutingRule.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayRequestRoutingRule.md new file mode 100644 index 0000000000..8580bde57d --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayRequestRoutingRule.md @@ -0,0 +1,330 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: BBA600C2-4813-4C12-8447-E770A949DA32 +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewayrequestroutingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayRequestRoutingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayRequestRoutingRule.md +--- + +# Add-AzApplicationGatewayRequestRoutingRule + +## SYNOPSIS +Adds a request routing rule to an application gateway. + +## SYNTAX + +### SetByResourceId +``` +Add-AzApplicationGatewayRequestRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> + -RuleType <String> [-Priority <Int32>] [-BackendHttpSettingsId <String>] [-HttpListenerId <String>] + [-BackendAddressPoolId <String>] [-UrlPathMapId <String>] [-RewriteRuleSetId <String>] + [-RedirectConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +Add-AzApplicationGatewayRequestRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> + -RuleType <String> [-Priority <Int32>] [-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] + [-HttpListener <PSApplicationGatewayHttpListener>] + [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] [-UrlPathMap <PSApplicationGatewayUrlPathMap>] + [-RewriteRuleSet <PSApplicationGatewayRewriteRuleSet>] + [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayRequestRoutingRule** cmdlet adds a request routing rule to an application gateway. + +## EXAMPLES + +### Example 1: Add a request routing rule to an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Appgw = Add-AzApplicationGatewayRequestRoutingRule -ApplicationGateway $AppGw -Name "Rule01" -RuleType Basic -Priority 100 -BackendHttpSettings $Setting -HttpListener $Listener -BackendAddressPool $Pool +``` + +The first command gets the application gateway and stores it in the $AppGw variable. +The second command adds the request routing rule to the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies an application gateway to which this cmdlet adds a request routing rule. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -BackendAddressPool +Specifies an application gateway back-end address pool object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +Specifies an application gateway back-end address pool ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendHttpSettings +Specifies a back-end HTTP settings object for an application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendHttpSettingsId +Specifies a backend HTTP settings ID for an application gateway. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpListener +Specifies application gateway HTTP listener object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpListenerId +Specifies application gateway HTTP listener ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of request routing rule this cmdlet adds. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The priority of the rule + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectConfiguration +Application gateway RedirectConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectConfigurationId +ID of the application gateway RedirectConfiguration + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RewriteRuleSet +Application gateway RewriteRuleSet + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleSet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RewriteRuleSetId +ID of the application gateway RewriteRuleSet + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleType +Specifies the type of request routing rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, PathBasedRouting + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlPathMap +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlPathMapId +Specifies the URL path map ID for the routing rule. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayRequestRoutingRule](./Get-AzApplicationGatewayRequestRoutingRule.md) + +[New-AzApplicationGatewayRequestRoutingRule](./New-AzApplicationGatewayRequestRoutingRule.md) + +[Remove-AzApplicationGatewayRequestRoutingRule](./Remove-AzApplicationGatewayRequestRoutingRule.md) + +[Set-AzApplicationGatewayRequestRoutingRule](./Set-AzApplicationGatewayRequestRoutingRule.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayRewriteRuleSet.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayRewriteRuleSet.md new file mode 100644 index 0000000000..9554c7544e --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayRewriteRuleSet.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewayrewriteruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayRewriteRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayRewriteRuleSet.md +--- + +# Add-AzApplicationGatewayRewriteRuleSet + +## SYNOPSIS +Adds a rewrite rule set to an application gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewayRewriteRuleSet -ApplicationGateway <PSApplicationGateway> -Name <String> + -RewriteRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRule]> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayRewriteRuleSet** cmdlet adds a rewrite rule set to an application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Add-AzApplicationGatewayRewriteRuleSet -ApplicationGateway $AppGw -Name "ruleset1" -RewriteRule $rule +``` + +The first command gets the application gateway and stores it in the $AppGw variable. +The second command adds the rewrite rule set to the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the RewriteRuleSet + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RewriteRule +List of rewrite rules + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRule] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayRewriteRuleSet](./Get-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRuleSet](./New-AzApplicationGatewayRewriteRuleSet.md) + +[Remove-AzApplicationGatewayRewriteRuleSet](./Remove-AzApplicationGatewayRewriteRuleSet.md) + +[Set-AzApplicationGatewayRewriteRuleSet](./Set-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRule](./New-AzApplicationGatewayRewriteRule.md) + +[New-AzApplicationGatewayRewriteRuleActionSet](./New-AzApplicationGatewayRewriteRuleActionSet.md) + +[New-AzApplicationGatewayRewriteRuleHeaderConfiguration](./New-AzApplicationGatewayRewriteRuleHeaderConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayRoutingRule.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayRoutingRule.md new file mode 100644 index 0000000000..e78d91db7c --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayRoutingRule.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewayroutingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayRoutingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayRoutingRule.md +--- + +# Add-AzApplicationGatewayRoutingRule + +## SYNOPSIS +Adds a routing rule to an application gateway. + +## SYNTAX + +### SetByResource (Default) +``` +Add-AzApplicationGatewayRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> + -RuleType <String> -Priority <Int32> [-BackendSettings <PSApplicationGatewayBackendSettings>] + [-Listener <PSApplicationGatewayListener>] [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +Add-AzApplicationGatewayRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> + -RuleType <String> -Priority <Int32> [-BackendSettingsId <String>] [-ListenerId <String>] + [-BackendAddressPoolId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayRoutingRule** cmdlet adds a routing rule to an application gateway. + +## EXAMPLES + +### Example 1: Add a routing rule to an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Appgw = Add-AzApplicationGatewayRoutingRule -ApplicationGateway $AppGw -Name "Rule01" -RuleType Basic -Priority 100 -BackendSettings $Setting -Listener $Listener -BackendAddressPool $Pool +``` + +The first command gets the application gateway and stores it in the $AppGw variable. +The second command adds the routing rule to the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -BackendAddressPool +Application gateway BackendAddressPool + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +ID of the application gateway BackendAddressPool + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendSettings +Application gateway BackendSettings + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendSettings +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendSettingsId +ID of the application gateway BackendSettings + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Listener +Application gateway Listener + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayListener +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListenerId +ID of the application gateway Listener + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Routing Rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The priority of the rule + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleType +The type of rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, PathBasedRouting + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayRoutingRule](./Get-AzApplicationGatewayRoutingRule.md) + +[New-AzApplicationGatewayRoutingRule](./New-AzApplicationGatewayRoutingRule.md) + +[Remove-AzApplicationGatewayRoutingRule](./Remove-AzApplicationGatewayRoutingRule.md) + +[Set-AzApplicationGatewayRoutingRule](./Set-AzApplicationGatewayRoutingRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewaySslCertificate.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewaySslCertificate.md new file mode 100644 index 0000000000..81baac6aa7 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewaySslCertificate.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 7EC4C642-1D23-4699-AE00-6E180C38271E +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewaysslcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewaySslCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewaySslCertificate.md +--- + +# Add-AzApplicationGatewaySslCertificate + +## SYNOPSIS +Adds an SSL certificate to an application gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewaySslCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> + [-CertificateFile <String>] [-Password <SecureString>] [-KeyVaultSecretId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewaySslCertificate** cmdlet adds an SSL certificate to an application gateway. + +## EXAMPLES + +### Example 1: Add an SSL certificate using pfx to an application gateway. +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$password = ConvertTo-SecureString $passwordPlainString -AsPlainText -Force +$AppGW = Add-AzApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert01" -CertificateFile "D:\cert01.pfx" -Password $password +``` + +This command gets an application gateway named ApplicationGateway01 and then adds an SSL certificate named Cert01 to it. + +### Example 2: Add an SSL certificate using KeyVault Secret (version-less secretId) to an application gateway. +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$secret = Get-AzKeyVaultCertificate -VaultName "keyvault01" -Name "sslCert01" +$secretId = $secret.SecretId.Replace($secret.Version, "") # https://<keyvaultname>.vault.azure.net/secrets/ +$AppGW = Add-AzApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert01" -KeyVaultSecretId $secretId +``` + +Get the secret and reference it in the `Add-AzApplicationGatewaySslCertificate` to add it to the Application Gateway with name `Cert01`. +Note: As version-less secretId is provided here, Application Gateway will sync the certificate in regular intervals with the KeyVault. + +### Example 3: Add an SSL certificate using KeyVault Secret (versioned secretId) to an application gateway. +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$secret = Get-AzKeyVaultCertificate -VaultName "keyvault01" -Name "sslCert01" +$secretId = $secret.Id # https://<keyvaultname>.vault.azure.net/secrets/<hash> +$AppGW = Add-AzApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert01" -KeyVaultSecretId $secretId +``` + +Get the secret and reference it in the `Add-AzApplicationGatewaySslCertificate` to add it to the Application Gateway with name `Cert01`. +Note: If it is required that Application Gateway syncs the certificate with the KeyVault, please provide the version-less secretId. + +## PARAMETERS + +### -ApplicationGateway +Specifies the name of application gateway to which this cmdlet adds an SSL certificate. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertificateFile +Specifies the .pfx file of an SSL certificate that this cmdlet adds. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultSecretId +SecretId (uri) of the KeyVault Secret. Use this option when a specific version of secret needs to be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the SSL certificate that this cmdlet adds. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Specifies the password of the SSL certificate that this cmdlet adds. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewaySslCertificate](./Get-AzApplicationGatewaySslCertificate.md) + +[New-AzApplicationGatewaySslCertificate](./New-AzApplicationGatewaySslCertificate.md) + +[Remove-AzApplicationGatewaySslCertificate](./Remove-AzApplicationGatewaySslCertificate.md) + +[Set-AzApplicationGatewaySslCertificate](./Set-AzApplicationGatewaySslCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewaySslProfile.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewaySslProfile.md new file mode 100644 index 0000000000..af4eaf6f78 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewaySslProfile.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewaysslprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewaySslProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewaySslProfile.md +--- + +# Add-AzApplicationGatewaySslProfile + +## SYNOPSIS +Adds SSL profile to an application gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewaySslProfile -ApplicationGateway <PSApplicationGateway> -Name <String> + [-SslPolicy <PSApplicationGatewaySslPolicy>] + [-ClientAuthConfiguration <PSApplicationGatewayClientAuthConfiguration>] + [-TrustedClientCertificates <PSApplicationGatewayTrustedClientCertificate[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewaySslProfile** cmdlet adds a SSL profile to an application gateway. The SSL profile is applied to HTTPS Listeners. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$sslPolicy = New-AzApplicationGatewaySslPolicy -PolicyType Custom -MinProtocolVersion TLSv1_1 -CipherSuite "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_AES_128_GCM_SHA256" +$trustedClient01 = New-AzApplicationGatewayTrustedClientCertificate -Name "ClientCert01" -CertificateFile "C:\clientCAChain1.cer" +$trustedClient02 = New-AzApplicationGatewayTrustedClientCertificate -Name "ClientCert02" -CertificateFile "C:\clientCAChain2.cer" +$AppGw = Add-AzApplicationGatewaySslProfile -Name $sslProfile01Name -ApplicationGateway $AppGw -SslPolicy $sslPolicy -TrustedClientCertificates $trustedClient01,$trustedClient02 +``` + +The first command gets the application gateway and stores it in the $AppGw variable. +The second command creates a new SSL policy and stores it in the $sslPolicy variable. +The third and fourth command creates two new trusted client CA certificate chains and stores them in the $ClientCert01 and $ClientCert02 variables. +The fifth command adds the SSL profile with the the ssl policy and trusted client CA certificate chains to the application gateway $AppGw. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ClientAuthConfiguration +Client authentication configuration settings + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayClientAuthConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the SSL profile + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslPolicy +SSL policy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedClientCertificates +The trusted client CA certificate chains + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedClientCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewaySslProfile](./New-AzApplicationGatewaySslProfile.md) + +[Get-AzApplicationGatewaySslProfile](./Get-AzApplicationGatewaySslProfile.md) + +[Remove-AzApplicationGatewaySslProfile](./Remove-AzApplicationGatewaySslProfile.md) + +[Set-AzApplicationGatewaySslProfile](./Set-AzApplicationGatewaySslProfile.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayTrustedClientCertificate.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayTrustedClientCertificate.md new file mode 100644 index 0000000000..caa88e1f5d --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayTrustedClientCertificate.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewaytrustedclientcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayTrustedClientCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayTrustedClientCertificate.md +--- + +# Add-AzApplicationGatewayTrustedClientCertificate + +## SYNOPSIS +Adds a trusted client CA certificate chain to an application gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewayTrustedClientCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> + -CertificateFile <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayTrustedClientCertificate** cmdlet adds a trusted client CA certificate chain to an Azure application gateway. + +## EXAMPLES + +### Example 1 + +Adds a trusted client CA certificate chain to an application gateway. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Add-AzApplicationGatewayTrustedClientCertificate -ApplicationGateway <PSApplicationGateway> -CertificateFile 'C:\cert.cer' -Name 'cert01' +``` + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertificateFile +Path of the trusted client CA certificate chain file + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the trusted client CA certificate chain + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayTrustedClientCertificate](./New-AzApplicationGatewayTrustedClientCertificate.md) + +[Get-AzApplicationGatewayTrustedClientCertificate](./Get-AzApplicationGatewayTrustedClientCertificate.md) + +[Remove-AzApplicationGatewayTrustedClientCertificate](./Remove-AzApplicationGatewayTrustedClientCertificate.md) + +[Set-AzApplicationGatewayTrustedClientCertificate](./Set-AzApplicationGatewayTrustedClientCertificate.md) diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayTrustedRootCertificate.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayTrustedRootCertificate.md new file mode 100644 index 0000000000..b3958db5d2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayTrustedRootCertificate.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewaytrustedrootcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayTrustedRootCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayTrustedRootCertificate.md +--- + +# Add-AzApplicationGatewayTrustedRootCertificate + +## SYNOPSIS +Adds a trusted root certificate to an application gateway. + +## SYNTAX + +``` +Add-AzApplicationGatewayTrustedRootCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> + -CertificateFile <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayTrustedRootCertificate** cmdlet adds a trusted root certificate to an Azure application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$gw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $resgpName +$gw = Add-AzApplicationGatewayTrustedRootCertificate -ApplicationGateway $gw -Name $certName -CertificateFile ".\rootCA.cer" +$gw = Add-AzApplicationGatewayBackendHttpSetting -ApplicationGateway $gw -Name $poolSetting01Name -Port 443 -Protocol Https -CookieBasedAffinity Enabled -PickHostNameFromBackendAddress -TrustedRootCertificate $gw.TrustedRootCertificates[0] +$gw = Set-AzApplicationGateway -ApplicationGateway $gw +``` + +The first command gets the application gateway and stores it in $gw variable. +The second command adds a new trusted root certificate to Application Gateway taking path of the root certificate as input. +The third command creates new backend http setting using trusted root certificate for validating the backend server certificate against. +The fourth command updates the Application Gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertificateFile +Path of certificate CER file + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the TrustedRoot certificate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayTrustedRootCertificate](./Get-AzApplicationGatewayTrustedRootCertificate.md) + +[New-AzApplicationGatewayTrustedRootCertificate](./New-AzApplicationGatewayTrustedRootCertificate.md) + +[Remove-AzApplicationGatewayTrustedRootCertificate](./Remove-AzApplicationGatewayTrustedRootCertificate.md) + +[Set-AzApplicationGatewayTrustedRootCertificate](./Set-AzApplicationGatewayTrustedRootCertificate.md) diff --git a/azps-10.1.0/Az.Network/Add-AzApplicationGatewayUrlPathMapConfig.md b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayUrlPathMapConfig.md new file mode 100644 index 0000000000..22b1e333a9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzApplicationGatewayUrlPathMapConfig.md @@ -0,0 +1,279 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 9D9D079C-5557-40DC-8CFB-1DCD446D9109 +online version: https://learn.microsoft.com/powershell/module/az.network/add-azapplicationgatewayurlpathmapconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayUrlPathMapConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzApplicationGatewayUrlPathMapConfig.md +--- + +# Add-AzApplicationGatewayUrlPathMapConfig + +## SYNOPSIS +Adds an array of URL path mappings to a backend server pool. + +## SYNTAX + +### BackendSetByResource (Default) +``` +Add-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + -PathRules <PSApplicationGatewayPathRule[]> + -DefaultBackendAddressPool <PSApplicationGatewayBackendAddressPool> + -DefaultBackendHttpSettings <PSApplicationGatewayBackendHttpSettings> + [-DefaultRewriteRuleSet <PSApplicationGatewayRewriteRuleSet>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### BackendSetByResourceId +``` +Add-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + -PathRules <PSApplicationGatewayPathRule[]> -DefaultBackendAddressPoolId <String> + -DefaultBackendHttpSettingsId <String> [-DefaultRewriteRuleSetId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RedirectSetByResource +``` +Add-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + -PathRules <PSApplicationGatewayPathRule[]> [-DefaultRewriteRuleSet <PSApplicationGatewayRewriteRuleSet>] + -DefaultRedirectConfiguration <PSApplicationGatewayRedirectConfiguration> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RedirectSetByResourceId +``` +Add-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + -PathRules <PSApplicationGatewayPathRule[]> [-DefaultRewriteRuleSetId <String>] + -DefaultRedirectConfigurationId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzApplicationGatewayUrlPathMapConfig** cmdlet adds an array of URL path mappings to a back end server pool. + +## EXAMPLES + +### Example 1: Add an URL path mapping to an application gateway. +```powershell +$appgw = Get-AzApplicationGateway -ResourceGroupName "rg" -Name "appGwName" +$pool = Get-AzApplicationGatewayBackendAddressPool -ApplicationGateway $appgw -Name "pool01" +$poolSettings = Get-AzApplicationGatewayBackendHttpSetting -ApplicationGateway $appgw -Name "poolSettings01" +$pathRule = New-AzApplicationGatewayPathRuleConfig -Name "rule01" -Paths "/path" -BackendAddressPool $pool -BackendHttpSettings $poolSettings +$appgw = Add-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway $appgw -Name "url01" -PathRules $pathRule -DefaultBackendAddressPool $pool -DefaultBackendHttpSettings $poolSettings +$appgw = Set-AzApplicationGateway -ApplicationGateway $appgw +``` + +The first command gets an application gateway named appGwName and stores it in $appgw variable. +The second command gets backend address pool and stores it in $pool variable. +The third command gets backend http settings and stores it in $poolSettings variable. +The fourth command create new path rule configuration named rule01 and stores it in $pathRule variable. +The fifth command adds url path mapping configuration named url01 to the application gateway. +The sixth command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway to which this cmdlet adds a URL path map configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultBackendAddressPool +Specifies the default backend address pool to route in case none of the rules specified in the *pathRules* parameter match. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool +Parameter Sets: BackendSetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultBackendAddressPoolId +Specifies the default backend address pool ID. + +```yaml +Type: System.String +Parameter Sets: BackendSetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultBackendHttpSettings +Specifies the default backend HTTP settings to use in case none of the rules specified in the *pathRules* parameter match. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings +Parameter Sets: BackendSetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultBackendHttpSettingsId +Specifies the default backend HTTP settings ID. + +```yaml +Type: System.String +Parameter Sets: BackendSetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultRedirectConfiguration +Application gateway default RedirectConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration +Parameter Sets: RedirectSetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultRedirectConfigurationId +ID of the application gateway default RedirectConfiguration + +```yaml +Type: System.String +Parameter Sets: RedirectSetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultRewriteRuleSet +Application gateway default rewrite rule set + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleSet +Parameter Sets: BackendSetByResource, RedirectSetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultRewriteRuleSetId +ID of the application gateway default rewrite rule set + +```yaml +Type: System.String +Parameter Sets: BackendSetByResourceId, RedirectSetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the URL path map name that this cmdlet adds to the backend server pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PathRules +Specifies a list of path rules. +The path rules are order sensitive, they are applied in order they are specified. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayUrlPathMapConfig](./Get-AzApplicationGatewayUrlPathMapConfig.md) + +[New-AzApplicationGatewayUrlPathMapConfig](./New-AzApplicationGatewayUrlPathMapConfig.md) + +[Remove-AzApplicationGatewayUrlPathMapConfig](./Remove-AzApplicationGatewayUrlPathMapConfig.md) + +[Set-AzApplicationGatewayUrlPathMapConfig](./Set-AzApplicationGatewayUrlPathMapConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzDelegation.md b/azps-10.1.0/Az.Network/Add-AzDelegation.md new file mode 100644 index 0000000000..ce5b0f8907 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzDelegation.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azdelegation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzDelegation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzDelegation.md +--- + +# Add-AzDelegation + +## SYNOPSIS +Adds a delegation to a subnet. + +## SYNTAX + +``` +Add-AzDelegation -Name <String> -ServiceName <String> -Subnet <PSSubnet> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzDelegation** cmdlet adds a service delegation to an Azure subnet. + +## EXAMPLES + +### Example 1: Adding a delegation +```powershell +$vnet = Get-AzVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" +$subnet = Get-AzVirtualNetworkSubnetConfig -Name "mySubnet" -VirtualNetwork $vnet +$subnet = Add-AzDelegation -Name "myDelegation" -ServiceName "Microsoft.Sql/servers" -Subnet $subnet +Set-AzVirtualNetwork -VirtualNetwork $vnet +``` + +The first command retrieves the virtual network on which the subnet lies. The second command isolates out the subnet of interest - the one which you want to delegate. The third command adds a delegation to the subnet. This particular example would be useful when you want to enable SQL to create interface endpoints in this subnet. The final command sends the updated subnet to the server to actually update your subnet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the delegation + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +The name of the service to which the subnet should be delegated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Subnet +The subnet + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSSubnet + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSSubnet + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) +[Get-AzVirtualNetworkSubnetConfig](./Get-AzVirtualNetworkSubnetConfig.md) +[Set-AzVirtualNetwork](./Set-AzVirtualNetwork.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Add-AzExpressRouteCircuitAuthorization.md b/azps-10.1.0/Az.Network/Add-AzExpressRouteCircuitAuthorization.md new file mode 100644 index 0000000000..c2d771cda9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzExpressRouteCircuitAuthorization.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 9994E2B2-20A1-4E95-9A9F-379B8B63F7F5 +online version: https://learn.microsoft.com/powershell/module/az.network/add-azexpressroutecircuitauthorization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzExpressRouteCircuitAuthorization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzExpressRouteCircuitAuthorization.md +--- + +# Add-AzExpressRouteCircuitAuthorization + +## SYNOPSIS +Adds an ExpressRoute circuit authorization. + +## SYNTAX + +``` +Add-AzExpressRouteCircuitAuthorization -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzExpressRouteCircuitAuthorization** cmdlet adds an authorization to an ExpressRoute +circuit. ExpressRoute circuits connect your on-premises network to the Microsoft cloud by using a +connectivity provider instead of the public Internet. The owner of an ExpressRoute circuit can +create as many as 10 authorizations for each circuit; these authorizations generate an +authorization key that can be used by a virtual network owner to connect his or her network to the +circuit (one authorization per virtual network). **Add-AzExpressRouteCircuitAuthorization** +adds a new authorization to a circuit and, at the same time, generates the corresponding +authorization key. These keys can be viewed at any time by running the +Get-AzExpressRouteCircuitAuthorization cmdlet and, as needed, can then be copied and forwarded +to the appropriate network owner. +Note that, after running **Add-AzExpressRouteCircuitAuthorization**, you must call the +Set-AzExpressRouteCircuit cmdlet to activate the key. If you do not call +**Set-AzExpressRouteCircuit** the authorization will be added to the circuit but will not be +enabled for use. + +## EXAMPLES + +### Example 1: Add an authorization to the specified ExpressRoute circuit +```powershell +$Circuit = Get-AzExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup" +Add-AzExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" -ExpressRouteCircuit $Circuit +Set-AzExpressRouteCircuit -ExpressRouteCircuit $Circuit +``` + +The commands in this example add a new authorization to an existing ExpressRoute circuit. The first +command uses **Get-AzExpressRouteCircuit** to create an object reference to a circuit named +ContosoCircuit. That object reference is stored in a variable named $Circuit. +In the second command, the **Add-AzExpressRouteCircuitAuthorization** cmdlet is used to add a +new authorization (ContosoCircuitAuthorization) to the ExpressRoute circuit. This command adds the +authorization but does not activate that authorization. Activating an authorization requires the +**Set-AzExpressRouteCircuit** shown in the final command in the example. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuit +Specifies the ExpressRoute circuit that this cmdlet adds the authorization to. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the circuit authorization to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuit](./Get-AzExpressRouteCircuit.md) + +[Get-AzExpressRouteCircuitAuthorization](./Get-AzExpressRouteCircuitAuthorization.md) + +[New-AzExpressRouteCircuitAuthorization](./New-AzExpressRouteCircuitAuthorization.md) + +[Remove-AzExpressRouteCircuitAuthorization](./Remove-AzExpressRouteCircuitAuthorization.md) + +[Set-AzExpressRouteCircuit](./Set-AzExpressRouteCircuit.md) diff --git a/azps-10.1.0/Az.Network/Add-AzExpressRouteCircuitConnectionConfig.md b/azps-10.1.0/Az.Network/Add-AzExpressRouteCircuitConnectionConfig.md new file mode 100644 index 0000000000..e147f90efa --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzExpressRouteCircuitConnectionConfig.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 7b4a8c9f-874c-4a27-b87e-c8ad7e73188d +online version: https://learn.microsoft.com/powershell/module/az.network/add-azexpressroutecircuitconnectionconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzExpressRouteCircuitConnectionConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzExpressRouteCircuitConnectionConfig.md +--- + +# Add-AzExpressRouteCircuitConnectionConfig + +## SYNOPSIS +Adds a circuit connection configuration to Private Peering of an Express Route Circuit. + +## SYNTAX + +### SetByResource (Default) +``` +Add-AzExpressRouteCircuitConnectionConfig [-Name] <String> [-ExpressRouteCircuit] <PSExpressRouteCircuit> + [-AddressPrefix] <String> [-AddressPrefixType <String>] [-AuthorizationKey <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Add-AzExpressRouteCircuitConnectionConfig [-Name] <String> [-ExpressRouteCircuit] <PSExpressRouteCircuit> + [-PeerExpressRouteCircuitPeering] <String> [-AddressPrefix] <String> [-AddressPrefixType <String>] + [-AuthorizationKey <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzExpressRouteCircuitConnectionConfig** cmdlet adds a circuit connection configuration to +private peering for an ExpressRoute circuit. This allows peering two Express Route Circuits +across regions or subscriptions.Note that, after running **Add-AzExpressRouteCircuitConnectionConfig**, +you must call the Set-AzExpressRouteCircuit cmdlet to activate the configuration. + +## EXAMPLES + +### Example 1: Add a circuit connection resource to an existing ExpressRoute circuit +```powershell +$circuit_init = Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg +$circuit_peer = Get-AzExpressRouteCircuit -Name $peeringCircuitName -ResourceGroupName $rg +$addressSpace = '60.0.0.0/29' +$addressPrefixType = 'IPv4' +Add-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init -PeerExpressRouteCircuitPeering $circuit_peer.Peerings[0].Id -AddressPrefix $addressSpace -AddressPrefixType $addressPrefixType -AuthorizationKey $circuit_peer.Authorizations[0].AuthorizationKey +Set-AzExpressRouteCircuit -ExpressRouteCircuit $circuit_init +``` + +### Example 2: Add a circuit connection configuration using Piping to an existing ExpressRoute Circuit +```powershell +$circuit_peer = Get-AzExpressRouteCircuit -Name $peeringCircuitName -ResourceGroupName $rg +$addressSpace = '60.0.0.0/29' +Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Add-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -PeerExpressRouteCircuitPeering $circuit_peer.Peerings[0].Id -AddressPrefix $addressSpace -AuthorizationKey $circuit_peer.Authorizations[0].AuthorizationKey |Set-AzExpressRouteCircuit +``` + +## PARAMETERS + +### -AddressPrefix +A minimum /29 customer address space to create VxLan tunnels between Express Route Circuits for IPv4 tunnels. +or a minimum of /125 customer address space to create VxLan tunnels between Express Route Circuits for IPv6 tunnels. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressPrefixType +This specifies the Address Family that address prefix belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: IPv4 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizationKey +Authorization Key to peer Express Route Circuit in another subscription. Authorization on peer circuit can be created using existing commands. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuit +The ExpressRoute circuit being modified. This is Azure object returned by the +**Get-AzExpressRouteCircuit** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the circuit connection resource to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerExpressRouteCircuitPeering +Resource Id for Private Peering of remote circuit which will be peered with the current circuit. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuitConnectionConfig](Get-AzExpressRouteCircuitConnectionConfig.md) + +[Remove-AzExpressRouteCircuitConnectionConfig](Remove-AzExpressRouteCircuitConnectionConfig.md) + +[Set-AzExpressRouteCircuitConnectionConfig](Set-AzExpressRouteCircuitConnectionConfig.md) + +[Set-AzExpressRouteCircuit](Set-AzExpressRouteCircuit.md) + +[Get-AzExpressRouteCircuit](Get-AzExpressRouteCircuit.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Add-AzExpressRouteCircuitPeeringConfig.md b/azps-10.1.0/Az.Network/Add-AzExpressRouteCircuitPeeringConfig.md new file mode 100644 index 0000000000..eabee5af33 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzExpressRouteCircuitPeeringConfig.md @@ -0,0 +1,366 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C44AD23A-E575-418C-BE90-323B44D6D2E8 +online version: https://learn.microsoft.com/powershell/module/az.network/add-azexpressroutecircuitpeeringconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzExpressRouteCircuitPeeringConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzExpressRouteCircuitPeeringConfig.md +--- + +# Add-AzExpressRouteCircuitPeeringConfig + +## SYNOPSIS +Adds a peering configuration to an ExpressRoute circuit. + +## SYNTAX + +### SetByResource (Default) +``` +Add-AzExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> + -PeeringType <String> -PeerASN <UInt32> -PrimaryPeerAddressPrefix <String> + -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] + [-MicrosoftConfigAdvertisedPublicPrefixes <String[]>] [-MicrosoftConfigCustomerAsn <Int32>] + [-MicrosoftConfigRoutingRegistryName <String>] [-PeerAddressType <String>] [-LegacyMode <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### MicrosoftPeeringConfigRoutFilterId +``` +Add-AzExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> + -PeeringType <String> -PeerASN <UInt32> -PrimaryPeerAddressPrefix <String> + -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] + [-MicrosoftConfigAdvertisedPublicPrefixes <String[]>] [-MicrosoftConfigCustomerAsn <Int32>] + [-MicrosoftConfigRoutingRegistryName <String>] -RouteFilterId <String> [-PeerAddressType <String>] + [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### MicrosoftPeeringConfigRoutFilter +``` +Add-AzExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> + -PeeringType <String> -PeerASN <UInt32> -PrimaryPeerAddressPrefix <String> + -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] + [-MicrosoftConfigAdvertisedPublicPrefixes <String[]>] [-MicrosoftConfigCustomerAsn <Int32>] + [-MicrosoftConfigRoutingRegistryName <String>] -RouteFilter <PSRouteFilter> [-PeerAddressType <String>] + [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzExpressRouteCircuitPeeringConfig** cmdlet adds a peering configuration to an +ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to the Microsoft cloud +by using a connectivity provider instead of the public Internet. Note that, after running +**Add-AzExpressRouteCircuitPeeringConfig**, you must call the Set-AzExpressRouteCircuit +cmdlet to activate the configuration. + +## EXAMPLES + +### Example 1: Add a peer to an existing ExpressRoute circuit +```powershell +$circuit = Get-AzExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg +$parameters = @{ + Name = 'AzurePrivatePeering' + Circuit = $circuit + PeeringType = 'AzurePrivatePeering' + PeerASN = 100 + PrimaryPeerAddressPrefix = '10.6.1.0/30' + SecondaryPeerAddressPrefix = '10.6.2.0/30' + VlanId = 200 +} +Add-AzExpressRouteCircuitPeeringConfig @parameters +Set-AzExpressRouteCircuit -ExpressRouteCircuit $circuit +``` + +### Example 2 + +Adds a peering configuration to an ExpressRoute circuit. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Add-AzExpressRouteCircuitPeeringConfig -ExpressRouteCircuit <PSExpressRouteCircuit> -MicrosoftConfigAdvertisedPublicPrefixes <String[]> -MicrosoftConfigCustomerAsn <Int32> -MicrosoftConfigRoutingRegistryName <String> -Name 'AzurePrivatePeering' -PeerASN 100 -PeerAddressType IPv4 -PeeringType AzurePrivatePeering -PrimaryPeerAddressPrefix '123.0.0.0/30' -SecondaryPeerAddressPrefix '123.0.0.4/30' -VlanId 300 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuit +The ExpressRoute circuit being modified. This is Azure object returned by the +**Get-AzExpressRouteCircuit** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LegacyMode +The legacy mode of the Peering + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MicrosoftConfigAdvertisedPublicPrefixes +For a PeeringType of MicrosoftPeering, you must provide a list of all prefixes you plan to +advertise over the BGP session. Only public IP address prefixes are accepted. You can send a comma +separated list if you plan to send a set of prefixes. These prefixes must be registered to you in +a Routing Registry Name (RIR / IRR). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftConfigCustomerAsn +If you are advertising prefixes that are not registered to the peering AS number, you can specify +the AS number to which they are registered. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftConfigRoutingRegistryName +The Routing Registry Name (RIR / IRR) to which the AS number and prefixes are registered. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the peering relationship to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerAddressType +PeerAddressType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerASN +The AS number of your ExpressRoute circuit. This must be a Public ASN when the PeeringType is +AzurePublicPeering. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringType +The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and +`MicrosoftPeering` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryPeerAddressPrefix +This is the IP Address range for the primary routing path of this peering relationship. This must +be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your +router interface. Azure will configure the next even-numbered address to the Azure router interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteFilter +This is an existing RouteFilter object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter +Parameter Sets: MicrosoftPeeringConfigRoutFilter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteFilterId +This is the resource Id of an existing RouteFilter object. + +```yaml +Type: System.String +Parameter Sets: MicrosoftPeeringConfigRoutFilterId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryPeerAddressPrefix +This is the IP Address range for the secondary routing path of this peering relationship. This must +be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your +router interface. Azure will configure the next even-numbered address to the Azure router interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedKey +This is an optional MD5 hash used as a pre-shared key for the peering configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VlanId +This is the Id number of the VLAN assigned for this peering. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilter + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuit](Get-AzExpressRouteCircuit.md) + +[New-AzExpressRouteCircuitPeeringConfig](New-AzExpressRouteCircuitPeeringConfig.md) + +[Remove-AzExpressRouteCircuitPeeringConfig](Remove-AzExpressRouteCircuitPeeringConfig.md) + +[Set-AzExpressRouteCircuit](Set-AzExpressRouteCircuit.md) diff --git a/azps-10.1.0/Az.Network/Add-AzExpressRouteCrossConnectionPeering.md b/azps-10.1.0/Az.Network/Add-AzExpressRouteCrossConnectionPeering.md new file mode 100644 index 0000000000..ca6ea005c8 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzExpressRouteCrossConnectionPeering.md @@ -0,0 +1,328 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C44AD23A-E575-418C-BE90-323B44D6D2E8 +online version: https://learn.microsoft.com/powershell/module/az.network/add-azexpressroutecrossconnectionpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzExpressRouteCrossConnectionPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzExpressRouteCrossConnectionPeering.md +--- + +# Add-AzExpressRouteCrossConnectionPeering + +## SYNOPSIS +Adds a peering configuration to an ExpressRoute cross connection. + +## SYNTAX + +``` +Add-AzExpressRouteCrossConnectionPeering -Name <String> + -ExpressRouteCrossConnection <PSExpressRouteCrossConnection> [-Force] -PeeringType <String> -PeerASN <UInt32> + -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] + [-MicrosoftConfigAdvertisedPublicPrefix <String[]>] [-MicrosoftConfigCustomerAsn <Int32>] + [-MicrosoftConfigRoutingRegistryName <String>] [-PeerAddressType <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzExpressRouteCrossConnectionPeering** cmdlet adds a peering configuration to an +ExpressRoute cross connection. Note that, after running +**Add-AzExpressRouteCrossConnectionPeering**, you must call the Set-AzExpressRouteCrossConnection +cmdlet to activate the configuration. + +## EXAMPLES + +### Example 1: Add a peer to an existing ExpressRoute cross connection +```powershell +$cc = Get-AzExpressRouteCrossConnection -Name $CrossConnectionName -ResourceGroupName $rg +$parameters = @{ + Name = 'AzurePrivatePeering' + CrossConnection = $cc + PeeringType = 'AzurePrivatePeering' + PeerASN = 100 + PrimaryPeerAddressPrefix = '10.6.1.0/30' + SecondaryPeerAddressPrefix = '10.6.2.0/30' + VlanId = 200 +} +Add-AzExpressRouteCrossConnectionPeering @parameters +Set-AzExpressRouteCrossConnection -ExpressRouteCrossConnection $cc +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCrossConnection +The ExpressRoute cross connection being modified. This is Azure object returned by the +**Get-AzExpressRouteCrossConnection** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCrossConnection +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftConfigAdvertisedPublicPrefix +For a PeeringType of MicrosoftPeering, you must provide a list of all prefixes you plan to +advertise over the BGP session. Only public IP address prefixes are accepted. You can send a comma +separated list if you plan to send a set of prefixes. These prefixes must be registered to you in +a Routing Registry Name (RIR / IRR). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftConfigCustomerAsn +If you are advertising prefixes that are not registered to the peering AS number, you can specify +the AS number to which they are registered. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftConfigRoutingRegistryName +The Routing Registry Name (RIR / IRR) to which the AS number and prefixes are registered. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the peering relationship to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerAddressType +PeerAddressType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerASN +The AS number of your ExpressRoute cross connection. This must be a Public ASN when the PeeringType is +AzurePublicPeering. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringType +The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and +`MicrosoftPeering` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryPeerAddressPrefix +This is the IP Address range for the primary routing path of this peering relationship. This must +be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your +router interface. Azure will configure the next even-numbered address to the Azure router interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryPeerAddressPrefix +This is the IP Address range for the secondary routing path of this peering relationship. This must +be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your +router interface. Azure will configure the next even-numbered address to the Azure router interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedKey +This is an optional MD5 hash used as a pre-shared key for the peering configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VlanId +This is the Id number of the VLAN assigned for this peering. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PSExpressRouteCrossConnection +Parameter 'ExpressRouteCrossConnection' accepts value of type 'PSExpressRouteCrossConnection' from the pipeline + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCrossConnection + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCrossConnectionPeering](Get-AzExpressRouteCrossConnectionPeering.md) + +[Remove-AzExpressRouteCrossConnectionPeering](Remove-AzExpressRouteCrossConnectionPeering.md) + +[Get-AzExpressRouteCrossConnection](Get-AzExpressRouteCrossConnection.md) + +[Set-AzExpressRouteCrossConnection](Set-AzExpressRouteCrossConnection.md) diff --git a/azps-10.1.0/Az.Network/Add-AzExpressRoutePortAuthorization.md b/azps-10.1.0/Az.Network/Add-AzExpressRoutePortAuthorization.md new file mode 100644 index 0000000000..59783b743a --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzExpressRoutePortAuthorization.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azexpressrouteportauthorization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzExpressRoutePortAuthorization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzExpressRoutePortAuthorization.md +--- + +# Add-AzExpressRoutePortAuthorization + +## SYNOPSIS +Adds an ExpressRoutePort authorization. + +## SYNTAX + +``` +Add-AzExpressRoutePortAuthorization -Name <String> -ExpressRoutePortObject <PSExpressRoutePort> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzExpressRoutePortAuthorization** cmdlet adds an authorization to an ExpressRoutePort. +The owner of an ExpressRoutePort can create these authorizations which generate an +authorization key that can be used by a ExpressRoute circuit owner to create the circuit on +the ExpressRoutePort (with a different owner). Only one circuit can be created with one +ExpressRoutePort authorization.**Add-AzExpressRoutePortAuthorization** +adds a new authorization to a ExpressRoutePort and, at the same time, generates the corresponding +authorization key. These keys can be viewed at any time by running the +**Get-AzExpressRoutePortAuthorization** cmdlet and, as needed, can then be copied and forwarded +to the appropriate circuit owner. + +## EXAMPLES + +### Example 1 +```powershell +$ERPort = Get-AzExpressRoutePort -Name "ContosoPort" -ResourceGroupName "ContosoResourceGroup" +``` + +```output +Name : ContosoPort +ResourceGroupName : ContosoResourceGroup +Location : westcentralus +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/ContosoResourceGroup/pr + oviders/Microsoft.Network/expressRoutePorts/ContosoPort +Etag : W/"cf987288-013e-40bf-a2aa-b29d017e7b7f" +ResourceGuid : 4c0e5cdb-79e1-4cb8-a430-0ce9b24472ca +ProvisioningState : Succeeded +PeeringLocation : Area51-ERDirect +BandwidthInGbps : 100 +ProvisionedBandwidthInGbps : 0 +Encapsulation : QinQ +Mtu : 1500 +EtherType : 0x8100 +AllocationDate : Thursday, March 31, 2022 +Identity : null +Links : [ + { + "Name": "link1", + "Etag": "W/\"cf987288-013e-40bf-a2aa-b29d017e7b7f\"", + "Id": "/subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/ContosoResou + rceGroup/providers/Microsoft.Network/expressRoutePorts/ContosoPort/links/link1", + "RouterName": "a51-test-06gmr-cis-3", + "InterfaceName": "HundredGigE15/15/19", + "PatchPanelId": "PP:0123:1110201 - Port 42", + "RackId": "A51 02050-0123-L", + "ConnectorType": "LC", + "AdminState": "Disabled", + "ProvisioningState": "Succeeded", + "MacSecConfig": { + "SciState": "Disabled", + "Cipher": "GcmAes128" + } + }, + { + "Name": "link2", + "Etag": "W/\"cf987288-013e-40bf-a2aa-b29d017e7b7f\"", + "Id": "/subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/ContosoResou + rceGroup/providers/Microsoft.Network/expressRoutePorts/ContosoPort/links/link2", + "RouterName": "a51-test-06gmr-cis-4", + "InterfaceName": "HundredGigE15/15/19", + "PatchPanelId": "2050:0124:1110854 - Port 42", + "RackId": "A51 02050-0124-L", + "ConnectorType": "LC", + "AdminState": "Disabled", + "ProvisioningState": "Succeeded", + "MacSecConfig": { + "SciState": "Disabled", + "Cipher": "GcmAes128" + } + } + ] +Circuits : [] +``` + +```powershell +Add-AzExpressRoutePortAuthorization -Name "ContosoPortAuthorization" -ExpressRoutePortObject $ERPort +``` + +```output +Name : ContosoPortAuthorization +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/ContosoResourceGroup/provid + ers/Microsoft.Network/expressRoutePorts/ContosoPort/authorizations/ContosoPortAuthorization +Etag : W/"36ccc199-c371-4d19-88cc-90d51bfe7ea9" +AuthorizationKey : 10d01cd7-0b67-4c44-88ca-51e7effa452d +AuthorizationUseStatus : Available +ProvisioningState : Succeeded +CircuitResourceUri : +``` + +The commands in this example add a new authorization to an existing ExpressRoutePort. The first +command uses **Get-AzExpressRoutePort** to create an object reference to a ExpressRoutePort named +ContosoPort. That object reference is stored in a variable named $ERPort. +In the second command, the **Add-AzExpressRoutePortAuthorization** cmdlet is used to add a +new authorization (ContosoPortAuthorization) to the ExpressRoutePort. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRoutePortObject +The ExpressRoutePort Object + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies a unique name for the new ExpressRoutePort authorization. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePortAuthorization + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRoutePortAuthorization](./Get-AzExpressRoutePortAuthorization.md) + +[Remove-AzExpressRoutePortAuthorization](./Remove-AzExpressRoutePortAuthorization.md) diff --git a/azps-10.1.0/Az.Network/Add-AzLoadBalancerBackendAddressPoolConfig.md b/azps-10.1.0/Az.Network/Add-AzLoadBalancerBackendAddressPoolConfig.md new file mode 100644 index 0000000000..d01b74597f --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzLoadBalancerBackendAddressPoolConfig.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 9EB11283-0189-4333-8142-DCC3F770F91A +online version: https://learn.microsoft.com/powershell/module/az.network/add-azloadbalancerbackendaddresspoolconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerBackendAddressPoolConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerBackendAddressPoolConfig.md +--- + +# Add-AzLoadBalancerBackendAddressPoolConfig + +## SYNOPSIS +Adds a backend address pool configuration to a load balancer. + +## SYNTAX + +``` +Add-AzLoadBalancerBackendAddressPoolConfig -LoadBalancer <PSLoadBalancer> -Name <String> + [-TunnelInterface <PSTunnelInterface[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzLoadBalancerBackend** cmdlet adds a backend address pool to an Azure load balancer. + +## EXAMPLES + +### Example 1: Add a backend address pool configuration to a load balancer +```powershell +Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "myrg" | Add-AzLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool02" | Set-AzLoadBalancer +``` + +This command gets the load balancer named MyLoadBalancer, adds the backend address pool named BackendAddressPool02 to MyLoadBalancer, and then uses the **Set-AzLoadBalancer** cmdlet to update MyLoadBalancer. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies a **LoadBalancer** object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the backend address pool configuration to add. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TunnelInterface +Gateway Load Balancer provider configurations. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSTunnelInterface[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[Get-AzNetworkInterface](./Get-AzNetworkInterface.md) + +[Get-AzLoadBalancerBackendAddressPoolConfig](./Get-AzLoadBalancerBackendAddressPoolConfig.md) + +[New-AzLoadBalancerBackendAddressPoolConfig](./New-AzLoadBalancerBackendAddressPoolConfig.md) + +[Remove-AzLoadBalancerBackendAddressPoolConfig](./Remove-AzLoadBalancerBackendAddressPoolConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzLoadBalancerFrontendIpConfig.md b/azps-10.1.0/Az.Network/Add-AzLoadBalancerFrontendIpConfig.md new file mode 100644 index 0000000000..e1afcb0d2a --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzLoadBalancerFrontendIpConfig.md @@ -0,0 +1,367 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 07FF274A-F365-44E5-A66B-6740CD165664 +online version: https://learn.microsoft.com/powershell/module/az.network/add-azloadbalancerfrontendipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerFrontendIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerFrontendIpConfig.md +--- + +# Add-AzLoadBalancerFrontendIpConfig + +## SYNOPSIS +Adds a front-end IP configuration to a load balancer. + +## SYNTAX + +### SetByResourceSubnet (Default) +``` +Add-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-PrivateIpAddress <String>] + [-PrivateIpAddressVersion <String>] [-Zone <String[]>] -Subnet <PSSubnet> [-GatewayLoadBalancerId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdSubnet +``` +Add-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-PrivateIpAddress <String>] + [-PrivateIpAddressVersion <String>] [-Zone <String[]>] -SubnetId <String> [-GatewayLoadBalancerId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdPublicIpAddress +``` +Add-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Zone <String[]>] + -PublicIpAddressId <String> [-GatewayLoadBalancerId <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourcePublicIpAddress +``` +Add-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Zone <String[]>] + -PublicIpAddress <PSPublicIpAddress> [-GatewayLoadBalancerId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdPublicIpAddressPrefix +``` +Add-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Zone <String[]>] + -PublicIpAddressPrefixId <String> [-GatewayLoadBalancerId <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourcePublicIpAddressPrefix +``` +Add-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Zone <String[]>] + -PublicIpAddressPrefix <PSPublicIpPrefix> [-GatewayLoadBalancerId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzLoadBalancerFrontendIpConfig** cmdlet adds a front-end IP configuration to an Azure load balancer. + +## EXAMPLES + +### Example 1 Add a front-end IP configuration with a dynamic IP address +```powershell +$Subnet = Get-AzVirtualNetwork -Name "MyVnet" -ResourceGroupName "MyRg" | Get-AzVirtualNetworkSubnetConfig -Name "MySubnet" +Get-AzLoadBalancer -Name "MyLB" -ResourceGroupName "NrpTest" | Add-AzLoadBalancerFrontendIpConfig -Name "FrontendName" -Subnet $Subnet | Set-AzLoadBalancer +``` + +The first command gets the Azure virtual network named MyVnet and passes the result using the pipeline to the **Get-AzVirtualNetworkSubnetConfig** cmdlet to get the subnet named MySubnet. +The command then stores the result in the variable named $Subnet. +The second command gets the load balancer named MyLB and passes the result to the **Add-AzLoadBalancerFrontendIpConfig** cmdlet that adds a front-end IP configuration to the load balancer with a dynamic private IP address from the subnet stored in the variable named $MySubnet. + +### Example 2 Add a front-end IP configuration with a static IP address +```powershell +$Subnet = Get-AzVirtualNetwork -Name "MyVnet" -ResourceGroupName "RG001" | Get-AzVirtualNetworkSubnetConfig -Name "MySubnet" +Get-AzLoadBalancer -Name "MyLB" -ResourceGroupName "NrpTest" | Add-AzLoadBalancerFrontendIpConfig -Name "FrontendName" -Subnet $Subnet -PrivateIpAddress "10.0.1.6" | Set-AzLoadBalancer +``` + +The first command gets the Azure virtual network named MyVnet and passes the result using the pipeline to the **Get-AzVirtualNetworkSubnetConfig** cmdlet to get the subnet named MySubnet. +The command then stores the result in the variable named $Subnet. +The second command gets the load balancer named MyLB and passes the result to the **Add-AzLoadBalancerFrontendIpConfig** cmdlet that adds a front-end IP configuration to the load balancer with a static private IP address from the subnet stored in the variable named $Subnet. + +### Example 3 Add a front-end IP configuration with a public IP address +```powershell +$PublicIp = Get-AzPublicIpAddress -ResourceGroupName "myRG" -Name "MyPub" +Get-AzLoadBalancer -Name "MyLB" -ResourceGroupName "NrpTest" | Add-AzLoadBalancerFrontendIpConfig -Name "FrontendName" -PublicIpAddress $PublicIp | Set-AzLoadBalancer +``` + +The first command gets the Azure public IP address named MyPub and stores the result in the variable named $PublicIp. +The second command gets the load balancer named MyLB and passes the result to the **Add-AzLoadBalancerFrontendIpConfig** cmdlet that adds a front-end IP configuration to the load balancer with public IP address stored in the variable named $PublicIp. + +### Example 4 Add a front-end IP configuration with a public IP prefix +```powershell +$PublicIpPrefix = Get-AzPublicIpPrefix -ResourceGroupName "myRG" -Name "MyPubPrefix" +Get-AzLoadBalancer -Name "MyLB" -ResourceGroupName "NrpTest" | Add-AzLoadBalancerFrontendIpConfig -Name "FrontendName" -PublicIpAddressPrefix $PublicIpPrefix | Set-AzLoadBalancer +``` + +The first command gets the Azure public IP prefix named MyPubPrefix and stores the result in the variable named $PublicIpPrefix. +The second command gets the load balancer named MyLB and passes the result to the **Add-AzLoadBalancerFrontendIpConfig** cmdlet that adds a front-end IP configuration to the load balancer with public IP prefix stored in the variable named $PublicIpPrefix. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayLoadBalancerId +The reference of Gateway LoadBalancer Provider resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies a **LoadBalancer** object. +This cmdlet adds a front-end IP configuration to the load balancer that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the front-end IP configuration to add. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddress +Specifies the private IP address to associate with a front-end IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceSubnet, SetByResourceIdSubnet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateIpAddressVersion +The private IP address version of the IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceSubnet, SetByResourceIdSubnet +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddress +Specifies the public IP address to associate with a front-end IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: SetByResourcePublicIpAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddressId +Specifies the ID of the public IP address in which to add a front-end IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdPublicIpAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddressPrefix +Specifies the public ip address prefix object to associate with a front-end IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix +Parameter Sets: SetByResourcePublicIpAddressPrefix +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PublicIpAddressPrefixId +Specifies the ID of the public ip address prefix object to associate with a front-end IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdPublicIpAddressPrefix +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Subnet +Specifies the subnet object in which to add a front-end IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResourceSubnet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubnetId +Specifies the ID of the subnet in which to add a front-end IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdSubnet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +A list of availability zones denoting the IP allocated for the resource needs to come from. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +### System.String[] + +### Microsoft.Azure.Commands.Network.Models.PSSubnet + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Get-AzLoadBalancerFrontendIpConfig](./Get-AzLoadBalancerFrontendIpConfig.md) + +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) + +[Get-AzVirtualNetworkSubnetConfig](./Get-AzVirtualNetworkSubnetConfig.md) + +[New-AzLoadBalancerFrontendIpConfig](./New-AzLoadBalancerFrontendIpConfig.md) + +[Remove-AzLoadBalancerFrontendIpConfig](./Remove-AzLoadBalancerFrontendIpConfig.md) + +[Set-AzLoadBalancerFrontendIpConfig](./Set-AzLoadBalancerFrontendIpConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzLoadBalancerInboundNatPoolConfig.md b/azps-10.1.0/Az.Network/Add-AzLoadBalancerInboundNatPoolConfig.md new file mode 100644 index 0000000000..1fb0695a2f --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzLoadBalancerInboundNatPoolConfig.md @@ -0,0 +1,282 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: EB4DF001-AD05-4747-972B-5E4194A404C8 +online version: https://learn.microsoft.com/powershell/module/az.network/add-azloadbalancerinboundnatpoolconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerInboundNatPoolConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerInboundNatPoolConfig.md +--- + +# Add-AzLoadBalancerInboundNatPoolConfig + +## SYNOPSIS +Adds an inbound NAT pool to a load balancer. + +## SYNTAX + +### SetByResource (Default) +``` +Add-AzLoadBalancerInboundNatPoolConfig -LoadBalancer <PSLoadBalancer> -Name <String> -Protocol <String> + -FrontendPortRangeStart <Int32> -FrontendPortRangeEnd <Int32> -BackendPort <Int32> + [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-EnableTcpReset] + [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Add-AzLoadBalancerInboundNatPoolConfig -LoadBalancer <PSLoadBalancer> -Name <String> -Protocol <String> + -FrontendPortRangeStart <Int32> -FrontendPortRangeEnd <Int32> -BackendPort <Int32> + [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-EnableTcpReset] [-FrontendIpConfigurationId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzLoadBalancerInboundNatPoolConfig** cmdlet adds an inbound NAT pool to a load balancer. + +## EXAMPLES + +### Example 1: Add +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$feIpConfig = Get-AzLoadBalancerFrontendIpConfig -Name "FrontendName" -Loadbalancer $slb +$slb | Add-AzLoadBalancerInboundNatPoolConfig -Name "myInboundNatPool" -Protocol TCP -FrontendIPConfigurationId $feIpConfig.Id -FrontendPortRangeStart 1001 -FrontendPortRangeEnd 2000 -BackendPort 1001 +$lb | Set-AzLoadBalancer +``` + +### Example 2 + +Adds an inbound NAT pool to a load balancer. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Add-AzLoadBalancerInboundNatPoolConfig -BackendPort 1001 -FrontendIpConfigurationId <String> -FrontendPortRangeEnd 2000 -FrontendPortRangeStart 1001 -Name 'myInboundNatPool' -Protocol TCP -LoadBalancer <PSLoadBalancer> +``` + +## PARAMETERS + +### -BackendPort +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFloatingIP +Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTcpReset +Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIpConfiguration +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendIpConfigurationId +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPortRangeEnd +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPortRangeStart +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancer +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Get-AzLoadBalancerInboundNatPoolConfig](./Get-AzLoadBalancerInboundNatPoolConfig.md) + +[New-AzLoadBalancerInboundNatPoolConfig](./New-AzLoadBalancerInboundNatPoolConfig.md) + +[Remove-AzLoadBalancerInboundNatPoolConfig](./Remove-AzLoadBalancerInboundNatPoolConfig.md) + +[Set-AzLoadBalancerInboundNatPoolConfig](./Set-AzLoadBalancerInboundNatPoolConfig.md) diff --git a/azps-10.1.0/Az.Network/Add-AzLoadBalancerInboundNatRuleConfig.md b/azps-10.1.0/Az.Network/Add-AzLoadBalancerInboundNatRuleConfig.md new file mode 100644 index 0000000000..fd7a2f5d83 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzLoadBalancerInboundNatRuleConfig.md @@ -0,0 +1,355 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: EE8F5D57-1ECE-4F23-9A5B-F226DD2C5ECB +online version: https://learn.microsoft.com/powershell/module/az.network/add-azloadbalancerinboundnatruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerInboundNatRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerInboundNatRuleConfig.md +--- + +# Add-AzLoadBalancerInboundNatRuleConfig + +## SYNOPSIS +Adds an inbound NAT rule configuration to a load balancer. + +## SYNTAX + +### SetByResource (Default) +``` +Add-AzLoadBalancerInboundNatRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] + [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] + [-EnableTcpReset] [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-FrontendPortRangeStart <Int32>] + [-FrontendPortRangeEnd <Int32>] [-BackendAddressPool <PSBackendAddressPool>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Add-AzLoadBalancerInboundNatRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] + [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] + [-EnableTcpReset] [-FrontendIpConfigurationId <String>] [-FrontendPortRangeStart <Int32>] + [-FrontendPortRangeEnd <Int32>] [-BackendAddressPoolId <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzLoadBalancerInboundNatRuleConfig** cmdlet adds an inbound network address translation (NAT) rule configuration to an Azure load balancer. + +## EXAMPLES + +### Example 1: Add an inbound NAT rule configuration to a load balancer +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$slb | Add-AzLoadBalancerInboundNatRuleConfig -Name "NewNatRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP +$slb | Set-AzLoadBalancer +``` + +The first command gets the load balancer named MyloadBalancer, and then stores it in the variable $slb. +The second command uses the pipeline operator to pass the load balancer in $slb to **Add-AzLoadBalancerInboundNatRuleConfig**, which adds an inbound NAT rule configuration to the load balancer. +The last command sets the configuration to the loadbalancer, if you don't perform Set-AzLoadBalancer, your changes will not be applied to the loadbalancer. + +### Example 2: Add an inbound NAT rule V2 configuration to a load balancer +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$slb | Add-AzLoadBalancerInboundNatRuleConfig -Name "NewNatRuleV2" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -IdleTimeoutInMinutes 10 -FrontendPortRangeStart 3389 -FrontendPortRangeEnd 4000 -BackendAddressPool $slb.BackendAddressPools[0] -BackendPort 3389 +$slb | Set-AzLoadBalancer +``` + +The first command gets the load balancer named MyloadBalancer, and then stores it in the variable $slb. +The second command uses the pipeline operator to pass the load balancer in $slb to **Add-AzLoadBalancerInboundNatRuleConfig**, which adds an inbound NAT rule V2 configuration to the load balancer. +The last command sets the configuration to the loadbalancer, if you don't perform Set-AzLoadBalancer, your changes will not be applied to the loadbalancer. + +## PARAMETERS + +### -BackendAddressPool +Specifies the backend address pool to associate with an inbound NAT rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +Specifies the ID of a BackendAddressPool object to associate with an inbound NAT rule configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendPort +Specifies the backend port for traffic matched by a rule configuration. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFloatingIP +Indicates that this cmdlet enables a floating IP address for a rule configuration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTcpReset +Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIpConfiguration +Specifies a list of front-end IP addresses to associate with an inbound NAT rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendIpConfigurationId +Specifies an ID for a front-end IP address configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPort +Specifies the front-end port that is matched by a rule configuration. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPortRangeEnd +Specifies the last port number in the range of external ports that is used by a rule configuration. Acceptable values range between 1 and 65535. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPortRangeStart +Specifies the first port number in the range of external ports that is used by a rule configuration. Acceptable values range between 1 and 65534. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +Specifies the length of time, in minutes, that the state of conversations is maintained in a load balancer. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies a **LoadBalancer** object. +This cmdlet adds an inbound NAT rule configuration to the load balancer that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the inbound NAT rule configuration to add. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol that is matched by an inbound NAT rule. +The acceptable values for this parameter are: Tcp or Udp. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[Get-AzLoadBalancerInboundNatRuleConfig](./Get-AzLoadBalancerInboundNatRuleConfig.md) + +[New-AzLoadBalancerInboundNatRuleConfig](./New-AzLoadBalancerInboundNatRuleConfig.md) + +[Remove-AzLoadBalancerInboundNatRuleConfig](./Remove-AzLoadBalancerInboundNatRuleConfig.md) + +[Set-AzLoadBalancer](./Set-AzLoadBalancer.md) + +[Set-AzLoadBalancerInboundNatRuleConfig](./Set-AzLoadBalancerInboundNatRuleConfig.md) diff --git a/azps-10.1.0/Az.Network/Add-AzLoadBalancerOutboundRuleConfig.md b/azps-10.1.0/Az.Network/Add-AzLoadBalancerOutboundRuleConfig.md new file mode 100644 index 0000000000..02e486ca91 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzLoadBalancerOutboundRuleConfig.md @@ -0,0 +1,262 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azloadbalanceroutboundruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerOutboundRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerOutboundRuleConfig.md +--- + +# Add-AzLoadBalancerOutboundRuleConfig + +## SYNOPSIS +Adds an outbound rule configuration to a load balancer. + +## SYNTAX + +### SetByResource (Default) +``` +Add-AzLoadBalancerOutboundRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> + [-AllocatedOutboundPort <Int32>] -Protocol <String> [-EnableTcpReset] [-IdleTimeoutInMinutes <Int32>] + -FrontendIpConfiguration <PSResourceId[]> -BackendAddressPool <PSBackendAddressPool> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Add-AzLoadBalancerOutboundRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> + [-AllocatedOutboundPort <Int32>] -Protocol <String> [-EnableTcpReset] [-IdleTimeoutInMinutes <Int32>] + -FrontendIpConfiguration <PSResourceId[]> -BackendAddressPoolId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzLoadBalancerOutboundRuleConfig** cmdlet adds an outbound rule configuration to an Azure load balancer. + +## EXAMPLES + +### Example 1: Add an outbound rule configuration to a load balancer +```powershell +$slb = Get-AzLoadBalancer -ResourceGroupName "MyResourceGroup" -Name "MyLoadBalancer" +$slb | Add-AzLoadBalancerOutboundRuleConfig -Name "NewRule" -Protocol "Tcp" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -BackendAddressPool $slb.BackendAddressPools[0] +``` + +The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. +The second command uses the pipeline operator to pass the load balancer in $slb to **Add-AzLoadBalancerOutboundRuleConfig**, which adds an outbound rule configuration to the load balancer. + +## PARAMETERS + +### -AllocatedOutboundPort +The number of outbound ports to be used for NAT. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendAddressPool +A reference to a pool of DIPs. +Outbound traffic is randomly load balanced across IPs in the backend IPs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +A reference to a pool of DIPs. +Outbound traffic is randomly load balanced across IPs in the backend IPs. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTcpReset +Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. +This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIpConfiguration +The Frontend IP addresses of the load balancer. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSResourceId[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +The timeout for the TCP idle connection + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancer +The reference of the load balancer resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the outbound rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol - TCP, UDP or All + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.Int32 + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSResourceId[] + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Get-AzLoadBalancerOutboundRuleConfig](./Get-AzLoadBalancerOutboundRuleConfig.md) + +[New-AzLoadBalancerOutboundRuleConfig](./New-AzLoadBalancerOutboundRuleConfig.md) + +[Remove-AzLoadBalancerOutboundRuleConfig](./Remove-AzLoadBalancerOutboundRuleConfig.md) + +[Set-AzLoadBalancerOutboundRuleConfig](./Set-AzLoadBalancerOutboundRuleConfig.md) diff --git a/azps-10.1.0/Az.Network/Add-AzLoadBalancerProbeConfig.md b/azps-10.1.0/Az.Network/Add-AzLoadBalancerProbeConfig.md new file mode 100644 index 0000000000..f367c6ea54 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzLoadBalancerProbeConfig.md @@ -0,0 +1,234 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 6F9BAB0B-7DC7-4672-B2B5-8B139D652DDD +online version: https://learn.microsoft.com/powershell/module/az.network/add-azloadbalancerprobeconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerProbeConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerProbeConfig.md +--- + +# Add-AzLoadBalancerProbeConfig + +## SYNOPSIS +Adds a probe configuration to a load balancer. + +## SYNTAX + +``` +Add-AzLoadBalancerProbeConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] -Port <Int32> + -IntervalInSeconds <Int32> -ProbeCount <Int32> [-ProbeThreshold <Int32>] [-RequestPath <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzLoadBalancerProbeConfig** cmdlet adds a probe configuration to an Azure load balancer. + +## EXAMPLES + +### Example 1: Add a probe configuration to a load balancer +```powershell +Get-AzLoadBalancer -Name "myLb" -ResourceGroupName "myRg" | Add-AzLoadBalancerProbeConfig -Name "probeName" -RequestPath healthcheck2.aspx -Protocol http -Port 81 -IntervalInSeconds 16 -ProbeCount 3 -ProbeThreshold 3 | Set-AzLoadBalancer +``` + +This command gets the load balancer named myLb, adds the specified probe configuration to it, and then uses the **Set-AzLoadBalancer** cmdlet to update the load balancer. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntervalInSeconds +Specifies the interval, in seconds, between probes to each instance of the load-balanced service. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies a **LoadBalancer** object. +This cmdlet adds a probe configuration to the load balancer that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the probe configuration to add. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Specifies the port on which probes should connect to a load-balanced service. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProbeCount +Specifies the number of per-instance consecutive failures for an instance to be considered unhealthy. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProbeThreshold +Specifies the number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol to use for the probe. +The acceptable values for this parameter are: Tcp or Http. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RequestPath +Specifies the path in the load-balanced service to probe to determine health. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Get-AzLoadBalancerProbeConfig](./Get-AzLoadBalancerProbeConfig.md) + +[New-AzLoadBalancerProbeConfig](./New-AzLoadBalancerProbeConfig.md) + +[Remove-AzLoadBalancerProbeConfig](./Remove-AzLoadBalancerProbeConfig.md) + +[Set-AzLoadBalancer](./Set-AzLoadBalancer.md) + +[Set-AzLoadBalancerProbeConfig](./Set-AzLoadBalancerProbeConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzLoadBalancerRuleConfig.md b/azps-10.1.0/Az.Network/Add-AzLoadBalancerRuleConfig.md new file mode 100644 index 0000000000..2c40c2476b --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzLoadBalancerRuleConfig.md @@ -0,0 +1,391 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 2AE5E9B8-7344-407B-9317-47709F10FCD8 +online version: https://learn.microsoft.com/powershell/module/az.network/add-azloadbalancerruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzLoadBalancerRuleConfig.md +--- + +# Add-AzLoadBalancerRuleConfig + +## SYNOPSIS +Adds a rule configuration to a load balancer. + +## SYNTAX + +### SetByResource (Default) +``` +Add-AzLoadBalancerRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] + [-LoadDistribution <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] + [-EnableFloatingIP] [-EnableTcpReset] [-DisableOutboundSNAT] + [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-BackendAddressPool <PSBackendAddressPool[]>] + [-Probe <PSProbe>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Add-AzLoadBalancerRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] + [-LoadDistribution <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] + [-EnableFloatingIP] [-EnableTcpReset] [-DisableOutboundSNAT] [-FrontendIpConfigurationId <String>] + [-BackendAddressPoolId <String[]>] [-ProbeId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzLoadBalancerRuleConfig** cmdlet adds a rule configuration to an Azure load balancer. + +## EXAMPLES + +### Example 1: Add a rule configuration to a load balancer +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$slb | Add-AzLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP +$slb | Set-AzLoadBalancer +``` + +The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. +The second command uses the pipeline operator to pass the load balancer in $slb to **Add-AzLoadBalancerRuleConfig**, which adds the rule configuration named NewRule. +The third command will update the load balancer in azure with the new Load Balancer Rule Config. + +### Example 2: Add a rule configuration with two backend address pools to a load balancer +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$MyBackendPool1 = Get-AzLoadBalancerBackendAddressPool -ResourceGroupName $resourceGroup -LoadBalancerName $MyLoadBalancer -Name $backendPool1Name +$MyBackendPool2 = Get-AzLoadBalancerBackendAddressPool -ResourceGroupName $resourceGroup -LoadBalancerName $MyLoadBalancer -Name $backendPool2Name +$slb | Add-AzLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol All -FrontendPort 0 -BackendPort 0 -BackendAddressPool $MyBackendPool1, $MyBackendPool2 +$slb | Set-AzLoadBalancer +``` + +This enables Gateway Load Balancer to have multiple backend pools +The first command will get the load balancer named MyLoadBalancer, and then stores it in the variable $slb. +The second and thrid command will get the backend address pools to be added the rule +The forth command will add a new rule with configured backend pools +the fifth command will update the load balancer in azure with the new Load Balancer Rule Config. + +## PARAMETERS + +### -BackendAddressPool +Specifies the backend address pool to associate with a load balancer rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +Specifies the ID of a **BackendAddressPool** object to associate with a load balancer rule configuration. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendPort +Specifies the backend port for traffic that is matched by a load balancer rule configuration. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableOutboundSNAT +Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFloatingIP +Indicates that this cmdlet enables a floating IP address for a rule configuration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTcpReset +Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIpConfiguration +Specifies a list of front-end IP addresses to associate with a load balancer rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendIpConfigurationId +Specifies the ID for a front-end IP address configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPort +Specifies the front-end port that is matched by a load balancer rule configuration. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +Specifies the length of time, in minutes, that the state of conversations is maintained in the load balancer. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies a **LoadBalancer** object. +This cmdlet adds a rule configuration to the load balancer that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LoadDistribution +Specifies a load distribution. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the load balancer rule configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Probe +Specifies a probe to associate with a load balancer rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSProbe +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProbeId +Specifies the ID of the probe to associate with a load balancer rule configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol that is matched by a load balancer rule. +The acceptable values for this parameter are: Tcp or Udp. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +### Microsoft.Azure.Commands.Network.Models.PSProbe + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[Get-AzLoadBalancerRuleConfig](./Get-AzLoadBalancerRuleConfig.md) + +[New-AzLoadBalancerRuleConfig](./New-AzLoadBalancerRuleConfig.md) + +[Remove-AzLoadBalancerRuleConfig](./Remove-AzLoadBalancerRuleConfig.md) + +[Set-AzLoadBalancerRuleConfig](./Set-AzLoadBalancerRuleConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzNetworkInterfaceIpConfig.md b/azps-10.1.0/Az.Network/Add-AzNetworkInterfaceIpConfig.md new file mode 100644 index 0000000000..bca942e547 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzNetworkInterfaceIpConfig.md @@ -0,0 +1,383 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 7610228A-61F9-41B8-A42A-CD7C793BB33F +online version: https://learn.microsoft.com/powershell/module/az.network/add-aznetworkinterfaceipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzNetworkInterfaceIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzNetworkInterfaceIpConfig.md +--- + +# Add-AzNetworkInterfaceIpConfig + +## SYNOPSIS +Adds a network interface IP configuration to a network interface. + +## SYNTAX + +### SetByResource (Default) +``` +Add-AzNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> + [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] [-Primary] [-Subnet <PSSubnet>] + [-PublicIpAddress <PSPublicIpAddress>] [-LoadBalancerBackendAddressPool <PSBackendAddressPool[]>] + [-LoadBalancerInboundNatRule <PSInboundNatRule[]>] + [-ApplicationGatewayBackendAddressPool <PSApplicationGatewayBackendAddressPool[]>] + [-ApplicationSecurityGroup <PSApplicationSecurityGroup[]>] [-GatewayLoadBalancerId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +Add-AzNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> + [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] [-Primary] [-SubnetId <String>] + [-PublicIpAddressId <String>] [-LoadBalancerBackendAddressPoolId <String[]>] + [-LoadBalancerInboundNatRuleId <String[]>] [-ApplicationGatewayBackendAddressPoolId <String[]>] + [-ApplicationSecurityGroupId <String[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzNetworkInterfaceIpConfig** cmdlet adds a network interface IP configuration to an Azure network interface. + +## EXAMPLES + +### Example 1: Add a new IP configuration with an application security group +```powershell +$subnet = New-AzVirtualNetworkSubnetConfig -Name MySubnet -AddressPrefix 10.0.1.0/24 +$vnet = New-AzVirtualNetwork -Name MyVNET -ResourceGroupName MyResourceGroup -Location "West US" -AddressPrefix 10.0.0.0/16 -Subnet $subnet + +$nic = New-AzNetworkInterface -Name MyNetworkInterface -ResourceGroupName MyResourceGroup -Location "West US" -Subnet $vnet.Subnets[0] + +$asg = New-AzApplicationSecurityGroup -ResourceGroupName MyResourceGroup -Name MyASG -Location "West US" + +$nic | Set-AzNetworkInterfaceIpConfig -Name $nic.IpConfigurations[0].Name -Subnet $vnet.Subnets[0] -ApplicationSecurityGroup $asg | Set-AzNetworkInterface + +$nic | Add-AzNetworkInterfaceIpConfig -Name MyNewIpConfig -Subnet $vnet.Subnets[0] -ApplicationSecurityGroup $asg | Set-AzNetworkInterface +``` + +In this example, we create a new network interface MyNetworkInterface that belongs to a subnet in the new virtual network MyVNET. We also create an empty application security group MyASG to associate with the IP configurations in the network interface. Once both objects are created, we link the default IP configuration to the MyASG object. At last, we create a new IP configuration in the network interface also linked to the application security group object. + +## PARAMETERS + +### -ApplicationGatewayBackendAddressPool +Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationGatewayBackendAddressPoolId +Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationSecurityGroup +Specifies a collection of application security group references to which this network interface IP configuration belongs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationSecurityGroupId +Specifies a collection of application security group references to which this network interface IP configuration belongs. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayLoadBalancerId +The reference of Gateway LoadBalancer Provider resource. + +```yaml +Type: System.String +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerBackendAddressPool +Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerBackendAddressPoolId +Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerInboundNatRule +Specifies a collection of load balancer inbound network address translation (NAT) rule references to which this network interface IP configuration belongs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSInboundNatRule[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerInboundNatRuleId +Specifies a collection of load balancer inbound NAT rule references to which this network interface IP configuration belongs. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network interface IP configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterface +Specifies a **NetworkInterface** object. +This cmdlet adds a network interface IP configuration to the object that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterface +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Primary +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddress +Specifies the static IP address of the network interface IP configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddressVersion +Specifies the IP address version of a network interface IP configuration. +The acceptable values for this parameter are: +- IPv4 +- IPv6 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddress +Specifies a **PublicIPAddress** object. +This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddressId +This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Specifies a **Subnet** object. +This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +### System.String[] + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool[] + +### Microsoft.Azure.Commands.Network.Models.PSInboundNatRule[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Get-AzNetworkInterfaceIpConfig](./Get-AzNetworkInterfaceIpConfig.md) + +[New-AzNetworkInterfaceIpConfig](./New-AzNetworkInterfaceIpConfig.md) + +[Remove-AzNetworkInterfaceIpConfig](./Remove-AzNetworkInterfaceIpConfig.md) + +[Set-AzNetworkInterfaceIpConfig](./Set-AzNetworkInterfaceIpConfig.md) diff --git a/azps-10.1.0/Az.Network/Add-AzNetworkInterfaceTapConfig.md b/azps-10.1.0/Az.Network/Add-AzNetworkInterfaceTapConfig.md new file mode 100644 index 0000000000..9665b58826 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzNetworkInterfaceTapConfig.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-aznetworkinterfacetapconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzNetworkInterfaceTapConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzNetworkInterfaceTapConfig.md +--- + +# Add-AzNetworkInterfaceTapConfig + +## SYNOPSIS +Creates a TapConfiguration resource associated to a NetworkInterface. This will reference to an existing VirtualNetworkTap resource. + +## SYNTAX + +### SetByResource (Default) +``` +Add-AzNetworkInterfaceTapConfig -NetworkInterface <PSNetworkInterface> -Name <String> + [-VirtualNetworkTap <PSVirtualNetworkTap>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByResourceId +``` +Add-AzNetworkInterfaceTapConfig -NetworkInterface <PSNetworkInterface> -Name <String> + [-VirtualNetworkTapId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzNetworkInterfaceTapConfig** cmdlet creates a TapConfiguration resource associated to a NetworkInterface. This will reference to an existing VirtualNetworkTap resource. + +## EXAMPLES + +### Example 1: Add TapConfiguration to a given NetworkInterface +```powershell +Add-AzNetworkInterfaceTapConfig -NetworkInterface $sourceNic -VirtualNetworkTap $vVirtualNetworkTap -Name 'myTapConfig' +``` + +Add the TapConfiguration to a sourceNic. The traffic from sourceNic VM will be mirrored to destination VM referred in vVirtualNetworkTap resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the tap configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterface +The reference of the network interface resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterface +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -VirtualNetworkTap +The reference of the virtual network tap resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkTapId +The reference of the virtual network tap resource. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkInterfaceTapConfig](./Get-AzNetworkInterfaceTapConfig.md) + +[Remove-AzNetworkInterfaceTapConfig](./Remove-AzNetworkInterfaceTapConfig.md) + +[Set-AzNetworkInterfaceTapConfig](./Set-AzNetworkInterfaceTapConfig.md) diff --git a/azps-10.1.0/Az.Network/Add-AzNetworkSecurityRuleConfig.md b/azps-10.1.0/Az.Network/Add-AzNetworkSecurityRuleConfig.md new file mode 100644 index 0000000000..5b2ac77923 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzNetworkSecurityRuleConfig.md @@ -0,0 +1,364 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 9160A21D-0F83-415B-830B-F35C8B863E90 +online version: https://learn.microsoft.com/powershell/module/az.network/add-aznetworksecurityruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzNetworkSecurityRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzNetworkSecurityRuleConfig.md +--- + +# Add-AzNetworkSecurityRuleConfig + +## SYNOPSIS +Adds a network security rule configuration to a network security group. + +## SYNTAX + +### SetByResource (Default) +``` +Add-AzNetworkSecurityRuleConfig -Name <String> -NetworkSecurityGroup <PSNetworkSecurityGroup> + [-Description <String>] [-Protocol <String>] [-SourcePortRange <String[]>] [-DestinationPortRange <String[]>] + [-SourceAddressPrefix <String[]>] [-DestinationAddressPrefix <String[]>] + [-SourceApplicationSecurityGroup <PSApplicationSecurityGroup[]>] + [-DestinationApplicationSecurityGroup <PSApplicationSecurityGroup[]>] [-Access <String>] [-Priority <Int32>] + [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +Add-AzNetworkSecurityRuleConfig -Name <String> -NetworkSecurityGroup <PSNetworkSecurityGroup> + [-Description <String>] [-Protocol <String>] [-SourcePortRange <String[]>] [-DestinationPortRange <String[]>] + [-SourceAddressPrefix <String[]>] [-DestinationAddressPrefix <String[]>] + [-SourceApplicationSecurityGroupId <String[]>] [-DestinationApplicationSecurityGroupId <String[]>] + [-Access <String>] [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzNetworkSecurityRuleConfig** cmdlet adds a network security rule configuration to an Azure network security group. + +## EXAMPLES + +### Example 1: Adding a network security group +```powershell +Get-AzNetworkSecurityGroup -Name nsg1 -ResourceGroupName rg1 | +Add-AzNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" -Access ` + Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix Internet ` + -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 | + Set-AzNetworkSecurityGroup +``` + +The first command retrieves an Azure network security group named "nsg1" from resource group "rg1". The second command adds a network security rule named "rdp-rule" that allows traffic from internet on port 3389 to the retrieved network security group object. Persists the modified Azure network security group. + +### Example 2: Adding a new security rule with application security groups +```powershell +$srcAsg = New-AzApplicationSecurityGroup -ResourceGroupName MyResourceGroup -Name srcAsg -Location "West US" +$destAsg = New-AzApplicationSecurityGroup -ResourceGroupName MyResourceGroup -Name destAsg -Location "West US" + +Get-AzNetworkSecurityGroup -Name nsg1 -ResourceGroupName rg1 | +Add-AzNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" -Access ` + Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceApplicationSecurityGroup ` + $srcAsg -SourcePortRange * -DestinationApplicationSecurityGroup $destAsg -DestinationPortRange 3389 | +Set-AzNetworkSecurityGroup +``` + +First, we create two new application security groups. Then, we retrieve an Azure network security group named "nsg1" from resource group "rg1". and add a network security rule named "rdp-rule" to it. The rule allows traffic from all the IP configurations in the application security group "srcAsg" to all the IP configurations in "destAsg" on port 3389. After adding the rule, we persist the modified Azure network security group. + +## PARAMETERS + +### -Access +Specifies whether network traffic is allowed or denied. +The acceptable values for this parameter are: Allow and Deny. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description of a network security rule configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationAddressPrefix +Specifies a destination address prefix. +The acceptable values for this parameter are: +- A Classless Interdomain Routing (CIDR) address +- A destination IP address range +- A wildcard character (*) to match any IP address. +You can use tags such as VirtualNetwork, AzureLoadBalancer, and Internet. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationApplicationSecurityGroup +The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationApplicationSecurityGroupId +The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPortRange +Specifies a destination port or range. +The acceptable values for this parameter are: +- An integer +- A range of integers between 0 and 65535 +- A wildcard character (*) to match any port + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Specifies whether a rule is evaluated on incoming or outgoing traffic. +The acceptable values for this parameter are: Inbound and Outbound. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Inbound, Outbound + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a network security rule configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSecurityGroup +Specifies a **NetworkSecurityGroup** object. +This cmdlet adds a network security rule configuration to the object that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Priority +Specifies the priority of a rule configuration. +The acceptable values for this parameter are: An integer between 100 and 4096. +The priority number must be unique for each rule in the collection. +The lower the priority number, the higher the priority of the rule. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the network protocol that a rule configuration applies to. +The acceptable values for this parameter are: +- Tcp +- Udp +- Icmp +- Esp +- Ah +- Wildcard character (*) to match all + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Tcp, Udp, Icmp, Esp, Ah, * + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceAddressPrefix +Specifies a source address prefix. +The acceptable values for this parameter are: +- A CIDR +- A source IP range +- A wildcard character (*) to match any IP address. +You can also use tags such as VirtualNetwork, AzureLoadBalancer and Internet. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceApplicationSecurityGroup +The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceApplicationSecurityGroupId +The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourcePortRange +Specifies a source port or range. +This value is expressed as an integer, as a range between 0 and 65535, or as a wildcard character (*) to match any source port. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkSecurityRuleConfig](./Get-AzNetworkSecurityRuleConfig.md) + +[New-AzNetworkSecurityRuleConfig](./New-AzNetworkSecurityRuleConfig.md) + +[Remove-AzNetworkSecurityRuleConfig](./Remove-AzNetworkSecurityRuleConfig.md) + +[Set-AzNetworkSecurityRuleConfig](./Set-AzNetworkSecurityRuleConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzRouteConfig.md b/azps-10.1.0/Az.Network/Add-AzRouteConfig.md new file mode 100644 index 0000000000..cba9fdf16d --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzRouteConfig.md @@ -0,0 +1,268 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C868DFA4-8A9D-4108-B88B-ACD7F100A63C +online version: https://learn.microsoft.com/powershell/module/az.network/add-azrouteconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzRouteConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzRouteConfig.md +--- + +# Add-AzRouteConfig + +## SYNOPSIS +Adds a route to a route table. + +## SYNTAX + +``` +Add-AzRouteConfig -RouteTable <PSRouteTable> [-Name <String>] [-AddressPrefix <String>] [-NextHopType <String>] + [-NextHopIpAddress <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzRouteConfig** cmdlet adds a route to an Azure route table. + +## EXAMPLES + +### Example 1: Add a route to a route table +```powershell +$RouteTable = Get-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" +Add-AzRouteConfig -Name "Route13" -AddressPrefix 10.3.0.0/16 -NextHopType "VnetLocal" -RouteTable $RouteTable +``` + +The first command gets a route table named RouteTable01 by using the Get-AzRouteTable cmdlet. +The command stores the table in the $RouteTable variable. +The second command adds a route named Route13 to the route table stored in $RouteTable. +This route forwards packets to the local virtual network. + +### Example 2: Add a route to a route table by using the pipeline +```powershell +Get-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Add-AzRouteConfig -Name "Route02" -AddressPrefix 10.2.0.0/16 -NextHopType VnetLocal | Set-AzRouteTable +``` + +```output +Name : routetable01 +ResourceGroupName : ResourceGroup11 +Location : eastus +Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ + k/routeTables/routetable01 +Etag : W/"f13e1bc8-d41f-44d0-882d-b8b5a1134f59" +ProvisioningState : Succeeded +Tags : +Routes : [ + { + "Name": "route07", + "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"", + "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro + soft.Network/routeTables/routetable01/routes/route07", + "AddressPrefix": "10.1.0.0/16", + "NextHopType": "VnetLocal", + "NextHopIpAddress": null, + "ProvisioningState": "Succeeded" + }, + { + "Name": "route02", + "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"", + "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro + soft.Network/routeTables/routetable01/routes/route02", + "AddressPrefix": "10.2.0.0/16", + "NextHopType": "VnetLocal", + "NextHopIpAddress": null, + "ProvisioningState": "Succeeded" + }, + { + "Name": "route13", + "Etag": null, + "Id": null, + "AddressPrefix": "10.3.0.0/16", + "NextHopType": "VnetLocal", + "NextHopIpAddress": null, + "ProvisioningState": null + } + ] +Subnets : [] +``` + +This command gets the route table named RouteTable01 by using **Get-AzRouteTable**. +The command passes that table to the current cmdlet by using the pipeline operator. +The current cmdlet adds the route named Route02, and then passes the result to the **Set-AzRouteTable** cmdlet, which updates the table to reflect your changes. + +### Example 3: Add a route with a Service Tag to a route table (Public Preview) +```powershell +$RouteTable = Get-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" +Add-AzRouteConfig -Name "Route13" -AddressPrefix "AppService" -NextHopType "VirtualAppliance" -NextHopIpAddress "10.0.2.4" -RouteTable $RouteTable +``` + +The first command gets a route table named RouteTable01 by using the Get-AzRouteTable cmdlet. +The command stores the table in the $RouteTable variable. +The second command adds a route named Route13 to the route table stored in $RouteTable. +This route forwards traffic to IP prefixes contained in the AppService Service Tag to a virtual appliance. + +## PARAMETERS + +### -AddressPrefix +Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies. You can also specify a Service Tag here (this feature is in Public Preview). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name of the route to add to the route table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextHopIpAddress +Specifies the IP address of a virtual appliance that you add to your Azure virtual network. +This route forwards packets to that address. +Specify this parameter only if you specify a value of VirtualAppliance for the *NextHopType* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextHopType +Specifies how this route forwards packets. +The acceptable values for this parameter are: +- Internet. +The default Internet gateway provided by Azure. +- None. +If you specify this value, the route does not forward packets. +- VirtualAppliance. +A virtual appliance that you add to your Azure virtual network. +- VirtualNetworkGateway. +An Azure server-to-server virtual private network gateway. +- VnetLocal. +The local virtual network. +If you have two subnets, 10.1.0.0/16 and 10.2.0.0/16 in the same virtual network, select a value of VnetLocal for each subnet to forward to the other subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteTable +Specifies the route table to which this cmdlet adds a route. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +## NOTES + +## RELATED LINKS + +[Get-AzRouteConfig](./Get-AzRouteConfig.md) + +[Get-AzRouteTable](./Get-AzRouteTable.md) + +[New-AzRouteConfig](./New-AzRouteConfig.md) + +[Remove-AzRouteConfig](./Remove-AzRouteConfig.md) + +[Set-AzRouteConfig](./Set-AzRouteConfig.md) + +[Set-AzRouteTable](./Set-AzRouteTable.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzRouteFilterRuleConfig.md b/azps-10.1.0/Az.Network/Add-AzRouteFilterRuleConfig.md new file mode 100644 index 0000000000..57a81c132f --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzRouteFilterRuleConfig.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azroutefilterruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzRouteFilterRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzRouteFilterRuleConfig.md +--- + +# Add-AzRouteFilterRuleConfig + +## SYNOPSIS +Adds a route filter rule to a route filter. + +## SYNTAX + +``` +Add-AzRouteFilterRuleConfig -RouteFilter <PSRouteFilter> [-Force] -Name <String> -Access <String> + -RouteFilterRuleType <String> -CommunityList <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Add-AzRouteFilterRuleConfig cmdlet adds a route filter rule to an Azure route filter. + +## EXAMPLES + +### Example 1: Add a route filter rule to a route filter +```powershell +$RouteFilter = Get-AzRouteFilter -ResourceGroupName "ResourceGroup11" -Name "routefilter01" +Add-AzRouteFilterRuleConfig -Name "rule13" -Access Allow -RouteFilterRuleType Community -RouteFilter $RouteFilter +``` + +The first command gets a route filter named routefilter01 by using the Get-AzRouteFilter cmdlet. +The command stores the filter in the $RouteFilter variable. + +## PARAMETERS + +### -Access +Specifies the access of the route filter rule, Valid values are Deny or Allow. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommunityList +The list of community value that route filter will filter on + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name of the route filter rule to add to the route filter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteFilter +Specifies the route filter to which this cmdlet adds a route filter rule. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RouteFilterRuleType +Specifies the route filter rule type. +Valid values are: Community + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Community + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilter + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilter + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Get-AzRouteFilterRuleConfig](./Get-AzRouteFilterRuleConfig.md) + +[New-AzRouteFilterRuleConfig](./New-AzRouteFilterRuleConfig.md) + +[Remove-AzRouteFilterRuleConfig](./Remove-AzRouteFilterRuleConfig.md) + +[Set-AzRouteFilterRuleConfig](./Set-AzRouteFilterRuleConfig.md) + +[Get-AzRouteFilter](./Get-AzRouteFilter.md) + +[New-AzRouteFilter](./New-AzRouteFilter.md) + +[Remove-AzRouteFilter](./Remove-AzRouteFilter.md) + +[Set-AzRouteFilter](./Set-AzRouteFilter.md) diff --git a/azps-10.1.0/Az.Network/Add-AzRouteServerPeer.md b/azps-10.1.0/Az.Network/Add-AzRouteServerPeer.md new file mode 100644 index 0000000000..b23864f1a2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzRouteServerPeer.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azrouteserverpeer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzRouteServerPeer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzRouteServerPeer.md +--- + +# Add-AzRouteServerPeer + +## SYNOPSIS +Add a peer to an Azure RouteServer + +## SYNTAX + +### RouteServerNPeerNameParameterSet (Default) +``` +Add-AzRouteServerPeer -ResourceGroupName <String> -PeerName <String> -PeerIp <String> -PeerAsn <UInt32> + [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RouteServerNameParameterSet +``` +Add-AzRouteServerPeer -ResourceGroupName <String> -PeerName <String> -PeerIp <String> -PeerAsn <UInt32> + -RouteServerName <String> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzRouteServerPeer** cmdlet adds a RouteServer Peer to an Azure RouteServer + +## EXAMPLES + +### Example 1 +```powershell +Add-AzRouteServerPeer -ResourceGroupName $rgname -RouteServerName $routeServerName -PeerName $peerName -PeerIp "192.168.1.5" -PeerAsn "20000" +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerAsn +ASN of remote route server peer. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerIp +Ip of remote route server peer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerName +The name of the route server peer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the route server/peer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteServerName +The route server where peer exists. + +```yaml +Type: System.String +Parameter Sets: RouteServerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.UInt32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteServer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Add-AzRoutingPolicy.md b/azps-10.1.0/Az.Network/Add-AzRoutingPolicy.md new file mode 100644 index 0000000000..2c7108b32f --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzRoutingPolicy.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azroutingpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzRoutingPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzRoutingPolicy.md +--- + +# Add-AzRoutingPolicy + +## SYNOPSIS +Add a Routing Policy to the Routing Intent object. + +## SYNTAX + +``` +Add-AzRoutingPolicy -RoutingIntent <PSRoutingIntent> -Destination <String[]> -NextHop <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzRoutingPolicy** cmdlet adds a RoutingPolicy to a RoutingIntent resource. This will only return an updated in-memory routing intent resource. Please use the [Set-AzRoutingIntent](./Set-AzRoutingIntent.md) cmdlet to update the actual resource and ensure that the policies take effect. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRg" +$firewallName = "testFirewall" +$firewall = Get-AzFirewall -Name $firewallName -ResourceGroupName $rgName +$routingIntent = Get-AzRoutingIntent -Name "routingIntent1" -HubName "hub1" -ResourceGroupName $rgName +Add-AzRoutingPolicy -Name "PublicTraffic" -RoutingIntent $routingIntent -Destination @("Internet") -NextHop $firewall.Id +Set-AzRoutingIntent -InputObject $routingIntent +``` + +```output +ProvisioningState : Succeeded +RoutingPolicies : {PublicTraffic} +RoutingPoliciesText : [ + { + "Name": "PublicTraffic", + "DestinationType": "TrafficType", + "Destinations": [ + "Internet" + ], + "NextHopType": "ResourceId", + "NextHop": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall" + } + ] +Name : routingIntent1 +Etag : W/"etag" +Id : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub1/routingIntent/routingIntent1 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +The list of destinations. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the routing policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextHop +Id of the next hop resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingIntent +The routing intent resource to which this rouing policy has to be added. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingIntent +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSRoutingIntent + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRoutingIntent + +## NOTES + +## RELATED LINKS + +[Get-AzRoutingIntent](./Get-AzRoutingIntent.md) + +[Get-AzRoutingPolicy](./Get-AzRoutingPolicy.md) + +[New-AzRoutingPolicy](./New-AzRoutingPolicy.md) + +[Remove-AzRoutingIntent](./Remove-AzRoutingIntent.md) + +[Remove-AzRoutingPolicy](./Remove-AzRoutingPolicy.md) + +[Set-AzRoutingIntent](./Set-AzRoutingIntent.md) + +[Set-AzRoutingPolicy](./Set-AzRoutingPolicy.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Add-AzServiceEndpointPolicyDefinition.md b/azps-10.1.0/Az.Network/Add-AzServiceEndpointPolicyDefinition.md new file mode 100644 index 0000000000..a1235160da --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzServiceEndpointPolicyDefinition.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azserviceendpointpolicydefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzServiceEndpointPolicyDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzServiceEndpointPolicyDefinition.md +--- + +# Add-AzServiceEndpointPolicyDefinition + +## SYNOPSIS +Adds a service endpoint policy definition to a specified policy. + +## SYNTAX + +``` +Add-AzServiceEndpointPolicyDefinition -Name <String> -ServiceEndpointPolicy <PSServiceEndpointPolicy> + [-Description <String>] [-ServiceResource <String[]>] [-Service <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzServiceEndpointPolicyDefinition** cmdlet add a service endpoint policy definition to the policy. + +## EXAMPLES + +### Example 1: Updates a service endpoint policy definition in a service endpoint policy +```powershell +New-AzServiceEndpointPolicyDefinition -Name "ServiceEndpointPolicyDefinition1" -Service "Microsoft.Storage" -ServiceResource "subscriptions/sub1" -Description "New Definition" +``` + +This command updated the service endpoint policy definition with name ServiceEndpointPolicyDefinition1, service Microsoft.Storage, service resources subscriptions/sub1 and +description "New Definition" that belongs to the resource group named ResourceGroup01 and stores it in the $policydef variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the definition + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service endpoint policy definition + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Service +Name of the service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceEndpointPolicy +The ServiceEndpointPolicy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ServiceResource +List of service resources + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzServiceEndpointPolicyDefinition](./Get-AzServiceEndpointPolicyDefinition.md) + +[New-AzServiceEndpointPolicyDefinition](./New-AzServiceEndpointPolicyDefinition.md) + +[Remove-AzServiceEndpointPolicyDefinition](./Remove-AzServiceEndpointPolicyDefinition.md) + +[Set-AzServiceEndpointPolicyDefinition](./Set-AzServiceEndpointPolicyDefinition.md) diff --git a/azps-10.1.0/Az.Network/Add-AzVirtualHubRoute.md b/azps-10.1.0/Az.Network/Add-AzVirtualHubRoute.md new file mode 100644 index 0000000000..45db155bba --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzVirtualHubRoute.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azvirtualhubroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVirtualHubRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVirtualHubRoute.md +--- + +# Add-AzVirtualHubRoute + +## SYNOPSIS +Creates a VirtualHubRoute object which can be passed as parameter to the Add-AzVirtualHubRouteTable command. + +## SYNTAX + +``` +Add-AzVirtualHubRoute -Destination <String[]> -DestinationType <String> -NextHop <String[]> + -NextHopType <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a VirtualHubRoute object. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzVirtualHubRoute -DestinationType "CIDR" -Destination @("10.4.0.0/16", "10.5.0.0/16") -NextHopType "IPAddress" -NextHop @("10.0.0.68") +``` + +```output +AddressPrefixes : {10.4.0.0/16, 10.5.0.0/16} +NextHopIpAddress : 10.0.0.68 +DestinationType : CIDR +Destinations : {10.4.0.0/16, 10.5.0.0/16} +NextHopType : IPAddress +NextHops : {10.0.0.68} +``` + +The above command will create a VirtualHubRoute object which can then be added to a VirtualHubRouteTable resource and set to a VirtualHub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +List of Destinations. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationType +Type of Destinations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextHop +List of Next hops. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextHopType +The Next Hop type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHubRoute + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Add-AzVirtualHubRouteTable.md b/azps-10.1.0/Az.Network/Add-AzVirtualHubRouteTable.md new file mode 100644 index 0000000000..89c5290c72 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzVirtualHubRouteTable.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azvirtualhubroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVirtualHubRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVirtualHubRouteTable.md +--- + +# Add-AzVirtualHubRouteTable + +## SYNOPSIS +Creates a Virtual Hub Route Table resource which is a child of VirtualHub. + +## SYNTAX + +``` +Add-AzVirtualHubRouteTable -Name <String> -Route <PSVirtualHubRoute[]> -Connection <String[]> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The virtual hub route table resource contains the list of routes and a list of connections to which it can +be attached to and is used to route traffic in a Virtual Hub. + +## EXAMPLES + +### Example 1 +```powershell +$route1 = Add-AzVirtualHubRoute -DestinationType "CIDR" -Destination @("10.4.0.0/16", "10.5.0.0/16") -NextHopType "IPAddress" -NextHop @("10.0.0.68") +Add-AzVirtualHubRouteTable -Route @($route1) -Connection @("All_Vnets") -Name "routeTable1" +``` + +```output +Name : routeTable1 +Id : +Routes : {Microsoft.Azure.Commands.Network.Models.PSVirtualHubRoute} +Connections : {All_Vnets} +ProvisioningState : +``` + +The above command will create a Virtual Hub Route Table resource from the routes passed to it and this object can be used for routing traffic in a Virtual Hub. + +## PARAMETERS + +### -Connection +List of connections this route table is attached to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the route table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Route +List of virtual hub routes. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHubRoute[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Add-AzVirtualNetworkGatewayIpConfig.md b/azps-10.1.0/Az.Network/Add-AzVirtualNetworkGatewayIpConfig.md new file mode 100644 index 0000000000..7f06a9dc16 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzVirtualNetworkGatewayIpConfig.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: BCB64535-FF37-46EF-85AF-7286BB67787B +online version: https://learn.microsoft.com/powershell/module/az.network/add-azvirtualnetworkgatewayipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVirtualNetworkGatewayIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVirtualNetworkGatewayIpConfig.md +--- + +# Add-AzVirtualNetworkGatewayIpConfig + +## SYNOPSIS +Adds an IP configuration to a virtual network gateway. + +## SYNTAX + +### SetByResourceId +``` +Add-AzVirtualNetworkGatewayIpConfig -VirtualNetworkGateway <PSVirtualNetworkGateway> -Name <String> + [-PrivateIpAddress <String>] [-SubnetId <String>] [-PublicIpAddressId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResource +``` +Add-AzVirtualNetworkGatewayIpConfig -VirtualNetworkGateway <PSVirtualNetworkGateway> -Name <String> + [-PrivateIpAddress <String>] [-Subnet <PSSubnet>] [-PublicIpAddress <PSPublicIpAddress>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVirtualNetworkGatewayIpConfig** cmdlet adds an IP configuration to a virtual network gateway. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzVirtualNetworkGatewayIpConfig -VirtualNetworkGateway $gw -Name GWIPConfig2 -Subnet $subnet -PublicIpAddress $gwpip2 +``` + +```output +Name : VNet7GW +ResourceGroupName : VPNGatewayV3 +Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/virtualNetworkGateways/VNet7GW +Etag : W/"d27a784f-3c3f-4150-863d-764649b6e8e7" +ResourceGuid : 3c2478a7-d5d4-4e80-8532-7ea2ad577598 +ProvisioningState : Succeeded +Tags : +IpConfigurations : [ + { + "PrivateIpAllocationMethod": "Dynamic", + "Subnet": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/virtualNetworks/Vnet7/subnets/GatewaySubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/publicIPAddresses/VNet7GW_IP" + }, + "Name": "default", + "Etag": "W/\"d27a784f-3c3f-4150-863d-764649b6e8e7\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/virtualNetworkGateways/VNet7GW/ipConfigurations/default" + }, + { + "PrivateIpAllocationMethod": "Dynamic", + "PublicIpAddress": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/publicIPAddresses/delIPConfig" + }, + "Name": "GWIPConfig2", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupNotSet/providers/Microsoft.Network/virtualNetworkGateways/VirtualNetworkGatewayNameNotSet/virtualNetworkGatewayIpConfiguration/GWIPConfig2" + } + ] +GatewayType : Vpn +VpnType : RouteBased +EnableBgp : True +ActiveActive : False +GatewayDefaultSite : null +Sku : { + "Capacity": 2, + "Name": "VpnGw1", + "Tier": "VpnGw1" + } +VpnClientConfiguration : null +BgpSettings : { + "Asn": 65534, + "BgpPeeringAddress": "10.7.255.254", + "PeerWeight": 0 + } +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the gateway IP configuration to add. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddress +Specifies the private IP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddress +Specifies the public IP address. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddressId +Specifies the ID of the public IP address. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Specifies a **PSSubnet** object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Specifies the ID of the subnet. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkGateway +Specifies a **PSVirtualNetworkGateway** object. +This cmdlet modifies the **PSVirtualNetworkGateway** object that you specify. +You can use the Get-AzVirtualNetworkGateway cmdlet to retrieve a **PSVirtualNetworkGateway** object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkGateway](./Get-AzVirtualNetworkGateway.md) + +[New-AzVirtualNetworkGatewayIpConfig](./New-AzVirtualNetworkGatewayIpConfig.md) + +[Remove-AzVirtualNetworkGatewayIpConfig](./Remove-AzVirtualNetworkGatewayIpConfig.md) diff --git a/azps-10.1.0/Az.Network/Add-AzVirtualNetworkPeering.md b/azps-10.1.0/Az.Network/Add-AzVirtualNetworkPeering.md new file mode 100644 index 0000000000..6971faf660 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzVirtualNetworkPeering.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 13901193-8C68-4969-ADCD-2E82EA714354 +online version: https://learn.microsoft.com/powershell/module/az.network/add-azvirtualnetworkpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVirtualNetworkPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVirtualNetworkPeering.md +--- + +# Add-AzVirtualNetworkPeering + +## SYNOPSIS +Creates a peering between two virtual networks. + +## SYNTAX + +``` +Add-AzVirtualNetworkPeering -Name <String> -VirtualNetwork <PSVirtualNetwork> -RemoteVirtualNetworkId <String> + [-BlockVirtualNetworkAccess] [-AllowForwardedTraffic] [-AllowGatewayTransit] [-UseRemoteGateways] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVirtualNetworkPeering** cmdlet creates a peering between two virtual networks. + +## EXAMPLES + +### Example 1: Create a peering between two virtual networks in the same region +```powershell +# Variables for common values used throughout the script. +$rgName='myResourceGroup' +$location='eastus' + +# Create a resource group. +New-AzResourceGroup -Name $rgName -Location $location + +# Create virtual network 1. +$vnet1 = New-AzVirtualNetwork -ResourceGroupName $rgName -Name 'myVnet1' -AddressPrefix '10.0.0.0/16' -Location $location + +# Create virtual network 2. +$vnet2 = New-AzVirtualNetwork -ResourceGroupName $rgName -Name 'myVnet2' -AddressPrefix '10.1.0.0/16' -Location $location + +# Peer VNet1 to VNet2. +Add-AzVirtualNetworkPeering -Name 'myVnet1ToMyVnet2' -VirtualNetwork $vnet1 -RemoteVirtualNetworkId $vnet2.Id + +# Peer VNet2 to VNet1. +Add-AzVirtualNetworkPeering -Name 'myVnet2ToMyVnet1' -VirtualNetwork $vnet2 -RemoteVirtualNetworkId $vnet1.Id +``` + +Note that a peering link must be created from vnet1 to vnet2 and vice versa in order for peering to work. + +### Example 2: Create a peering between two virtual networks in different regions +```powershell +# Variables for common values used throughout the script. +$rgName='myResourceGroup' + +# Create a resource group. +New-AzResourceGroup -Name $rgName -Location westcentralus + +# Create virtual network 1. +$vnet1 = New-AzVirtualNetwork -ResourceGroupName $rgName -Name 'myVnet1' -AddressPrefix '10.0.0.0/16' -Location westcentralus + +# Create virtual network 2. +$vnet2 = New-AzVirtualNetwork -ResourceGroupName $rgName -Name 'myVnet2' -AddressPrefix '10.1.0.0/16' -Location canadacentral + +# Peer VNet1 to VNet2. +Add-AzVirtualNetworkPeering -Name 'myVnet1ToMyVnet2' -VirtualNetwork $vnet1 -RemoteVirtualNetworkId $vnet2.Id + +# Peer VNet2 to VNet1. +Add-AzVirtualNetworkPeering -Name 'myVnet2ToMyVnet1' -VirtualNetwork $vnet2 -RemoteVirtualNetworkId $vnet1.Id +``` + +Here 'myVnet1' in US West Central is peered with 'myVnet2' in Canada Central. + +## PARAMETERS + +### -AllowForwardedTraffic +Indicates that this cmdlet allows the forwarded traffic from the virtual machines in the remote virtual network. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGatewayTransit +Flag to allow gatewayLinks be used in remote virtual network's link to this virtual network + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockVirtualNetworkAccess +Indicates that this cmdlet blocks the virtual machines in the linked virtual network space to access all the virtual machines in local virtual network space. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual network peering. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteVirtualNetworkId +Specifies the ID of the remote virtual network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UseRemoteGateways +Indicates that this cmdlet allows remote gateways on this virtual network. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetwork +Specifies the parent virtual network. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) + +[Get-AzVirtualNetworkPeering](./Get-AzVirtualNetworkPeering.md) + +[Remove-AzVirtualNetworkPeering](./Remove-AzVirtualNetworkPeering.md) + +[Set-AzVirtualNetworkPeering](./Set-AzVirtualNetworkPeering.md) + +[Sync-AzVirtualNetworkPeering](./Sync-AzVirtualNetworkPeering.md) diff --git a/azps-10.1.0/Az.Network/Add-AzVirtualNetworkSubnetConfig.md b/azps-10.1.0/Az.Network/Add-AzVirtualNetworkSubnetConfig.md new file mode 100644 index 0000000000..7d0961908e --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzVirtualNetworkSubnetConfig.md @@ -0,0 +1,339 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: B8B632B5-9D3B-4352-B4C8-49C00472B3A7 +online version: https://learn.microsoft.com/powershell/module/az.network/add-azvirtualnetworksubnetconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVirtualNetworkSubnetConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVirtualNetworkSubnetConfig.md +--- + +# Add-AzVirtualNetworkSubnetConfig + +## SYNOPSIS +Adds a subnet configuration to a virtual network. + +## SYNTAX + +### SetByResource (Default) +``` +Add-AzVirtualNetworkSubnetConfig -Name <String> -VirtualNetwork <PSVirtualNetwork> -AddressPrefix <String[]> + [-NetworkSecurityGroup <PSNetworkSecurityGroup>] [-RouteTable <PSRouteTable>] [-InputObject <PSNatGateway>] + [-ServiceEndpoint <String[]>] [-ServiceEndpointPolicy <PSServiceEndpointPolicy[]>] + [-Delegation <PSDelegation[]>] [-PrivateEndpointNetworkPoliciesFlag <String>] + [-PrivateLinkServiceNetworkPoliciesFlag <String>] [-IpAllocation <PSIpAllocation[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +Add-AzVirtualNetworkSubnetConfig -Name <String> -VirtualNetwork <PSVirtualNetwork> -AddressPrefix <String[]> + [-NetworkSecurityGroupId <String>] [-RouteTableId <String>] [-ResourceId <String>] + [-ServiceEndpoint <String[]>] [-ServiceEndpointPolicy <PSServiceEndpointPolicy[]>] + [-Delegation <PSDelegation[]>] [-PrivateEndpointNetworkPoliciesFlag <String>] + [-PrivateLinkServiceNetworkPoliciesFlag <String>] [-IpAllocation <PSIpAllocation[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVirtualNetworkSubnetConfig** cmdlet adds a subnet configuration to an existing Azure virtual network. + +## EXAMPLES + +### Example 1: Add a subnet to an existing virtual network +```powershell +New-AzResourceGroup -Name TestResourceGroup -Location centralus + $frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" + $virtualNetwork = New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet + Add-AzVirtualNetworkSubnetConfig -Name backendSubnet -VirtualNetwork $virtualNetwork -AddressPrefix "10.0.2.0/24" + $virtualNetwork | Set-AzVirtualNetwork +``` + + This example first creates a resource group as a container of the resources to be created. It then creates a subnet configuration and uses it to create a virtual network. The + Add-AzVirtualNetworkSubnetConfig is then used to add a subnet to the in-memory representation of the virtual network. The Set-AzVirtualNetwork command updates the existing virtual + network with the new subnet. + +### Example 2: Add a delegation to a subnet being added to an existing virtual network +```powershell +$vnet = Get-AzVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" +$delegation = New-AzDelegation -Name "myDelegation" -ServiceName "Microsoft.Sql/servers" +Add-AzVirtualNetworkSubnetConfig -Name "mySubnet" -VirtualNetwork $vnet -AddressPrefix "10.0.2.0/24" -Delegation $delegation | Set-AzVirtualNetwork +``` + +This example first gets an existing vnet. +Then, it creates a delegation object in memory. +Finally, it creates a new subnet with that delegation that is added to the vnet. The modified configuration is then sent to the server. + +## PARAMETERS + +### -AddressPrefix +Specifies a range of IP addresses for a subnet configuration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delegation +List of services that have permission to perform operations on this subnet. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSDelegation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Specifies the nat gateway associated with the subnet configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNatGateway +Parameter Sets: SetByResource +Aliases: NatGateway + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpAllocation +Specifies IpAllocations for a subnet. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpAllocation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the subnet configuration to add. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSecurityGroup +Specifies a **NetworkSecurityGroup** object. +This cmdlet adds a virtual network subnet configuration to the object that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkSecurityGroupId +Specifies the ID of a network security group. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateEndpointNetworkPoliciesFlag +Configure to enable or disable applying network policies on private endpoint in the subnet. Default value is Disabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateLinkServiceNetworkPoliciesFlag +Configure to enable or disable applying network policies on private link service in the subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the Id of NAT Gateway resource associated with the subnet configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: NatGatewayId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteTable +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteTableId +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceEndpoint +Service Endpoint Value + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceEndpointPolicy +Service Endpoint Policies + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetwork +Specifies the **VirtualNetwork** object in which to add a subnet configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +### System.String[] + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy[] + +### Microsoft.Azure.Commands.Network.Models.PSDelegation[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkSubnetConfig](./Get-AzVirtualNetworkSubnetConfig.md) + +[New-AzVirtualNetworkSubnetConfig](./New-AzVirtualNetworkSubnetConfig.md) + +[Remove-AzVirtualNetworkSubnetConfig](./Remove-AzVirtualNetworkSubnetConfig.md) + +[Set-AzVirtualNetworkSubnetConfig](./Set-AzVirtualNetworkSubnetConfig.md) diff --git a/azps-10.1.0/Az.Network/Add-AzVirtualRouterPeer.md b/azps-10.1.0/Az.Network/Add-AzVirtualRouterPeer.md new file mode 100644 index 0000000000..c437cc0831 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzVirtualRouterPeer.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/add-azvirtualrouterpeer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVirtualRouterPeer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVirtualRouterPeer.md +--- + +# Add-AzVirtualRouterPeer + +## SYNOPSIS +Add a Peer to an Azure VirtualRouter + +## SYNTAX + +``` +Add-AzVirtualRouterPeer -ResourceGroupName <String> -PeerName <String> -PeerIp <String> -PeerAsn <UInt32> + -VirtualRouterName <String> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVirtualRouterPeer** cmdlet adds a VirtualRouter Peer to an Azure VirtualRouter + +## EXAMPLES + +### Example 1 +```powershell +Add-AzVirtualRouterPeer -ResourceGroupName virtualRouterRG -PeerName csr -PeerIp 10.0.1.5 -PeerAsn 63000 -VirtualRouterName virtualRouter +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerAsn +Peer ASN. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerIp +Peer Ip. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerName +The name of the virtual router Peer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the virtual router/peer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualRouterName +The virtual router where peer exists. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.UInt32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualRouter + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Add-AzVpnClientRevokedCertificate.md b/azps-10.1.0/Az.Network/Add-AzVpnClientRevokedCertificate.md new file mode 100644 index 0000000000..a8297a84dd --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzVpnClientRevokedCertificate.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 90FB7B88-844E-4783-A10F-04D7BA47C030 +online version: https://learn.microsoft.com/powershell/module/az.network/add-azvpnclientrevokedcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVpnClientRevokedCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVpnClientRevokedCertificate.md +--- + +# Add-AzVpnClientRevokedCertificate + +## SYNOPSIS +Adds a VPN client-revocation certificate. + +## SYNTAX + +``` +Add-AzVpnClientRevokedCertificate -VpnClientRevokedCertificateName <String> -VirtualNetworkGatewayName <String> + -ResourceGroupName <String> -Thumbprint <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVpnClientRevokedCertificate** cmdlet assigns a client-revocation certificate to a virtual network gateway. +Client-revocation certificates prevent client computers from using the specified certificate for authentication. +You need to specify both the certificate name and the certificate thumbprint to use this cmdlet. + +## EXAMPLES + +### Example 1: Add a new client-revocation certificate to a virtual network gateway +```powershell +Add-AzVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -VpnClientRevokedCertificateName "ContosoRevokedClientCertificate" -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" +``` + +This command adds a new client-revocation certificate to the virtual network gateway named ContosoVirtualNetwork. +In order to add the certificate, you must specify both the certificate name and the certificate thumbprint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the virtual network gateway is assigned to. +Resource groups categorize items to help simplify inventory management and general Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Thumbprint +Specifies the unique identifier of the certificate being added. +For example: +-Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" +You can get thumbprint information for your certificates by using a Windows PowerShell command similar to this: `Get-ChildItem -Path Cert:\LocalMachine\Root`. +The preceding command gets information for all the local computer certificates found in the root certificate store. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +Specifies the name of the virtual network gateway where the certificate should be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientRevokedCertificateName +Specifies the name of the VPN client certificate to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate + +## NOTES + +## RELATED LINKS + +[Get-AzVpnClientRevokedCertificate](./Get-AzVpnClientRevokedCertificate.md) + +[New-AzVpnClientRevokedCertificate](./New-AzVpnClientRevokedCertificate.md) + +[Remove-AzVpnClientRevokedCertificate](./Remove-AzVpnClientRevokedCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Add-AzVpnClientRootCertificate.md b/azps-10.1.0/Az.Network/Add-AzVpnClientRootCertificate.md new file mode 100644 index 0000000000..5e10130788 --- /dev/null +++ b/azps-10.1.0/Az.Network/Add-AzVpnClientRootCertificate.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: B9153CA9-06D1-4EF3-9863-D649C2EBAEAA +online version: https://learn.microsoft.com/powershell/module/az.network/add-azvpnclientrootcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVpnClientRootCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Add-AzVpnClientRootCertificate.md +--- + +# Add-AzVpnClientRootCertificate + +## SYNOPSIS +Adds a VPN client root certificate. + +## SYNTAX + +``` +Add-AzVpnClientRootCertificate -VpnClientRootCertificateName <String> -VirtualNetworkGatewayName <String> + -ResourceGroupName <String> -PublicCertData <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzVpnClientRootCertificate** cmdlet adds a root certificate to a virtual network gateway. +Root certificates are X.509 certificates that identify your Root Certification Authority. +By design, all certificates used on the gateway trust the root certificate. +This cmdlet assigns an existing certificate as a gateway root certificate. +If you do not have an X.509 certificate available you can generate one through your public key infrastructure or use a certificate generator such as makecert.exe. +To add a root certificate, you must specify the certificate name and provide a text-only representation of the certificate (see *the PublicCertData* parameter for more information). +Azure allows you to assign more than one root certificate to a gateway. +Multiple root certificates are often deployed by organizations that include users from more than one company. + +## EXAMPLES + +### Example 1: Add a client root certificate to a virtual gateway +```powershell +$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertificate.cer" +$CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text[$i]} +Add-AzVpnClientRootCertificate -PublicCertData $CertificateText -ResourceGroupName "ContosoResourceGroup" -VirtualNetworkGatewayName "ContosoVirtualGateway" -VpnClientRootCertificateName "ContosoClientRootCertificate" +``` + +This example adds a client root certificate to a virtual gateway named ContosoVirtualGateway. +The first command uses the **Get-Content** cmdlet to get a previously-exported text representation of the root certificate and stores that text data the variable named $Text. +The second command then uses a for loop to extract all the text except for the first line and the last line. +The extracted text is stored in a variable named $CertificateText. +The third command then uses the text stored in $CertificateText with the **Add-AzVpnClientRootCertificate** cmdlet to add the root certificate to the gateway. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicCertData +Specifies the text representation of the root certificate to be added. +To obtain the text representation, export your certificate in .cer format (using Base64 encoding), then open the resulting file in a text editor. +When you do that, you will see output similar to the following (note that the actual output will contain many more lines of text than the abbreviated sample shown here): +----- BEGIN CERTIFICATE ----- +MIIC13FAAXC3671Auij9HHgUNEW8343NMJklo09982CVVFAw8w +----- END CERTIFICATE ----- +The PublicCertData is made up of all the lines between the first line (----- BEGIN CERTIFICATE -----) and the last line (----- END CERTIFICATE -----) in the file. +You can retrieve this data by using Windows PowerShell commands similar to this: `$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertificate.cer"` +`$CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text\[$i\]}` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the root certificate is assigned to. +Resource groups categorize items to help simplify inventory management and general Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +Specifies the name of the virtual network gateway where the certificate is added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientRootCertificateName +Specifies the name of the client root certificate that this cmdlet adds. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate + +## NOTES + +## RELATED LINKS + +[Get-AzVpnClientRootCertificate](./Get-AzVpnClientRootCertificate.md) + +[New-AzVpnClientRootCertificate](./New-AzVpnClientRootCertificate.md) + +[Remove-AzVpnClientRootCertificate](./Remove-AzVpnClientRootCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Approve-AzPrivateEndpointConnection.md b/azps-10.1.0/Az.Network/Approve-AzPrivateEndpointConnection.md new file mode 100644 index 0000000000..36ff6ad55d --- /dev/null +++ b/azps-10.1.0/Az.Network/Approve-AzPrivateEndpointConnection.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/approve-azprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Approve-AzPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Approve-AzPrivateEndpointConnection.md +--- + +# Approve-AzPrivateEndpointConnection + +## SYNOPSIS +Approves a private endpoint connection. + +## SYNTAX + +### ByResourceId (Default) +``` +Approve-AzPrivateEndpointConnection [-Description <String>] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResource +``` +Approve-AzPrivateEndpointConnection -Name <String> [-Description <String>] -ResourceGroupName <String> + -ServiceName <String> [-DefaultProfile <IAzureContextContainer>] -PrivateLinkResourceType <String> + [<CommonParameters>] +``` + +## DESCRIPTION +The **Approve-AzPrivateEndpointConnection** cmdlet approves a private endpoint connection. + +## EXAMPLES + +### Example 1 +```powershell +Approve-AzPrivateEndpointConnection -Name TestPrivateEndpointConnection -ResourceGroupName TestResourceGroup -ServiceName TestPrivateLinkService -PrivateLinkResourceType Microsoft.Network/privateLinkServices +``` + +This example approves a private endpoint connection. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The reason of action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateLinkResourceType +The private link resource type. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: +Accepted values: Microsoft.AgFoodPlatform/farmBeats, Microsoft.ApiManagement/service, Microsoft.AppConfiguration/configurationStores, Microsoft.Attestation/attestationProviders, Microsoft.Authorization/resourceManagementPrivateLinks, Microsoft.Automation/automationAccounts, Microsoft.Batch/batchAccounts, Microsoft.Cache/Redis, Microsoft.Cache/redisEnterprise, Microsoft.CognitiveServices/accounts, Microsoft.Compute/diskAccesses, Microsoft.ContainerRegistry/registries, Microsoft.ContainerService/managedClusters, Microsoft.Databricks/workspaces, Microsoft.DataFactory/factories, Microsoft.DBforMariaDB/servers, Microsoft.DBforMySQL/servers, Microsoft.DBforPostgreSQL/servers, Microsoft.DesktopVirtualization/hostpools, Microsoft.DesktopVirtualization/workspaces, Microsoft.Devices/IotHubs, Microsoft.Devices/ProvisioningServices, Microsoft.DeviceUpdate/accounts, Microsoft.DigitalTwins/digitalTwinsInstances, Microsoft.DocumentDB/databaseAccounts, Microsoft.EventGrid/topics, Microsoft.EventGrid/domains, Microsoft.EventHub/namespaces, Microsoft.HardwareSecurityModules/cloudHsmClusters, Microsoft.HealthcareApis/services, Microsoft.HDInsight/clusters, Microsoft.HybridCompute/privateLinkScopes, Microsoft.Insights/privateLinkScopes, Microsoft.KeyVault/vaults, Microsoft.Keyvault/managedHSMs, Microsoft.MachineLearningServices/workspaces, Microsoft.MachineLearningServices/registries, Microsoft.Media/mediaservices, Microsoft.Media/videoanalyzers, Microsoft.Migrate/assessmentProjects, Microsoft.Migrate/migrateProjects, Microsoft.Monitor/accounts, Microsoft.Network/applicationgateways, Microsoft.Network/privateLinkServices, Microsoft.OffAzure/masterSites, Microsoft.PowerBI/privateLinkServicesForPowerBI, Microsoft.Purview/accounts, Microsoft.RecoveryServices/vaults, Microsoft.Relay/namespaces, Microsoft.Search/searchServices, Microsoft.ServiceBus/namespaces, Microsoft.SignalRService/signalr, Microsoft.SignalRService/webPubSub, Microsoft.Sql/servers, Microsoft.Storage/storageAccounts, Microsoft.StorageSync/storageSyncServices, Microsoft.Synapse/privateLinkHubs, Microsoft.Synapse/workspaces, Microsoft.Web/sites, Microsoft.Web/staticSites, Microsoft.Web/hostingEnvironments, Microsoft.BotService/botServices, Microsoft.OpenEnergyPlatform/energyServices, Microsoft.DBforMySQL/flexibleServers + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource manager id of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +The private link service name. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateLinkService + +## NOTES + +## RELATED LINKS + +[Deny-AzPrivateEndpointConnection](./Deny-AzPrivateEndpointConnection.md) + +[Get-AzPrivateEndpointConnection](./Get-AzPrivateEndpointConnection.md) + +[Remove-AzPrivateEndpointConnection](./Remove-AzPrivateEndpointConnection.md) + +[Set-AzPrivateEndpointConnection](./Set-AzPrivateEndpointConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Az.Network.md b/azps-10.1.0/Az.Network/Az.Network.md new file mode 100644 index 0000000000..172644b080 --- /dev/null +++ b/azps-10.1.0/Az.Network/Az.Network.md @@ -0,0 +1,2282 @@ +--- +Module Name: Az.Network +Module Guid: eb75c732-e274-4a20-b502-e9958e63484a +Download Help Link: https://learn.microsoft.com/powershell/module/az.network +Help Version: 5.4.2.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Az.Network.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Az.Network.md +--- + +# Az.Network Module +## Description +This topic displays help topics for the Azure Network Cmdlets. + +## Az.Network Cmdlets +### [Add-AzApplicationGatewayAuthenticationCertificate](Add-AzApplicationGatewayAuthenticationCertificate.md) +Adds an authentication certificate to an application gateway. + +### [Add-AzApplicationGatewayBackendAddressPool](Add-AzApplicationGatewayBackendAddressPool.md) +Adds a back-end address pool to an application gateway. + +### [Add-AzApplicationGatewayBackendHttpSetting](Add-AzApplicationGatewayBackendHttpSetting.md) +Adds back-end HTTP settings to an application gateway. + +### [Add-AzApplicationGatewayBackendSetting](Add-AzApplicationGatewayBackendSetting.md) +Adds back-end TCP\TLS settings to an application gateway. + +### [Add-AzApplicationGatewayCustomError](Add-AzApplicationGatewayCustomError.md) +Adds a custom error to an application gateway. + +### [Add-AzApplicationGatewayFrontendIPConfig](Add-AzApplicationGatewayFrontendIPConfig.md) +Adds a front-end IP configuration to an application gateway. + +### [Add-AzApplicationGatewayFrontendPort](Add-AzApplicationGatewayFrontendPort.md) +Adds a front-end port to an application gateway. + +### [Add-AzApplicationGatewayHttpListener](Add-AzApplicationGatewayHttpListener.md) +Adds an HTTP listener to an application gateway. + +### [Add-AzApplicationGatewayHttpListenerCustomError](Add-AzApplicationGatewayHttpListenerCustomError.md) +Adds a custom error to a http listener of an application gateway. + +### [Add-AzApplicationGatewayIPConfiguration](Add-AzApplicationGatewayIPConfiguration.md) +Adds an IP configuration to an application gateway. + +### [Add-AzApplicationGatewayListener](Add-AzApplicationGatewayListener.md) +Adds an listener to an application gateway. + +### [Add-AzApplicationGatewayPrivateLinkConfiguration](Add-AzApplicationGatewayPrivateLinkConfiguration.md) +Adds a private link configuration to an application gateway. + +### [Add-AzApplicationGatewayProbeConfig](Add-AzApplicationGatewayProbeConfig.md) +Adds a health probe to an Application Gateway. + +### [Add-AzApplicationGatewayRedirectConfiguration](Add-AzApplicationGatewayRedirectConfiguration.md) +Adds a redirect configuration to an Application Gateway. + +### [Add-AzApplicationGatewayRequestRoutingRule](Add-AzApplicationGatewayRequestRoutingRule.md) +Adds a request routing rule to an application gateway. + +### [Add-AzApplicationGatewayRewriteRuleSet](Add-AzApplicationGatewayRewriteRuleSet.md) +Adds a rewrite rule set to an application gateway. + +### [Add-AzApplicationGatewayRoutingRule](Add-AzApplicationGatewayRoutingRule.md) +Adds a routing rule to an application gateway. + +### [Add-AzApplicationGatewaySslCertificate](Add-AzApplicationGatewaySslCertificate.md) +Adds an SSL certificate to an application gateway. + +### [Add-AzApplicationGatewaySslProfile](Add-AzApplicationGatewaySslProfile.md) +Adds SSL profile to an application gateway. + +### [Add-AzApplicationGatewayTrustedClientCertificate](Add-AzApplicationGatewayTrustedClientCertificate.md) +Adds a trusted client CA certificate chain to an application gateway. + +### [Add-AzApplicationGatewayTrustedRootCertificate](Add-AzApplicationGatewayTrustedRootCertificate.md) +Adds a trusted root certificate to an application gateway. + +### [Add-AzApplicationGatewayUrlPathMapConfig](Add-AzApplicationGatewayUrlPathMapConfig.md) +Adds an array of URL path mappings to a backend server pool. + +### [Add-AzDelegation](Add-AzDelegation.md) +Adds a delegation to a subnet. + +### [Add-AzExpressRouteCircuitAuthorization](Add-AzExpressRouteCircuitAuthorization.md) +Adds an ExpressRoute circuit authorization. + +### [Add-AzExpressRouteCircuitConnectionConfig](Add-AzExpressRouteCircuitConnectionConfig.md) +Adds a circuit connection configuration to Private Peering of an Express Route Circuit. + +### [Add-AzExpressRouteCircuitPeeringConfig](Add-AzExpressRouteCircuitPeeringConfig.md) +Adds a peering configuration to an ExpressRoute circuit. + +### [Add-AzExpressRouteCrossConnectionPeering](Add-AzExpressRouteCrossConnectionPeering.md) +Adds a peering configuration to an ExpressRoute cross connection. + +### [Add-AzExpressRoutePortAuthorization](Add-AzExpressRoutePortAuthorization.md) +Adds an ExpressRoutePort authorization. + +### [Add-AzLoadBalancerBackendAddressPoolConfig](Add-AzLoadBalancerBackendAddressPoolConfig.md) +Adds a backend address pool configuration to a load balancer. + +### [Add-AzLoadBalancerFrontendIpConfig](Add-AzLoadBalancerFrontendIpConfig.md) +Adds a front-end IP configuration to a load balancer. + +### [Add-AzLoadBalancerInboundNatPoolConfig](Add-AzLoadBalancerInboundNatPoolConfig.md) +Adds an inbound NAT pool to a load balancer. + +### [Add-AzLoadBalancerInboundNatRuleConfig](Add-AzLoadBalancerInboundNatRuleConfig.md) +Adds an inbound NAT rule configuration to a load balancer. + +### [Add-AzLoadBalancerOutboundRuleConfig](Add-AzLoadBalancerOutboundRuleConfig.md) +Adds an outbound rule configuration to a load balancer. + +### [Add-AzLoadBalancerProbeConfig](Add-AzLoadBalancerProbeConfig.md) +Adds a probe configuration to a load balancer. + +### [Add-AzLoadBalancerRuleConfig](Add-AzLoadBalancerRuleConfig.md) +Adds a rule configuration to a load balancer. + +### [Add-AzNetworkInterfaceIpConfig](Add-AzNetworkInterfaceIpConfig.md) +Adds a network interface IP configuration to a network interface. + +### [Add-AzNetworkInterfaceTapConfig](Add-AzNetworkInterfaceTapConfig.md) +Creates a TapConfiguration resource associated to a NetworkInterface. This will reference to an existing VirtualNetworkTap resource. + +### [Add-AzNetworkSecurityRuleConfig](Add-AzNetworkSecurityRuleConfig.md) +Adds a network security rule configuration to a network security group. + +### [Add-AzRouteConfig](Add-AzRouteConfig.md) +Adds a route to a route table. + +### [Add-AzRouteFilterRuleConfig](Add-AzRouteFilterRuleConfig.md) +Adds a route filter rule to a route filter. + +### [Add-AzRouteServerPeer](Add-AzRouteServerPeer.md) +Add a peer to an Azure RouteServer + +### [Add-AzRoutingPolicy](Add-AzRoutingPolicy.md) +Add a Routing Policy to the Routing Intent object. + +### [Add-AzServiceEndpointPolicyDefinition](Add-AzServiceEndpointPolicyDefinition.md) +Adds a service endpoint policy definition to a specified policy. + +### [Add-AzVirtualHubRoute](Add-AzVirtualHubRoute.md) +Creates a VirtualHubRoute object which can be passed as parameter to the Add-AzVirtualHubRouteTable command. + +### [Add-AzVirtualHubRouteTable](Add-AzVirtualHubRouteTable.md) +Creates a Virtual Hub Route Table resource which is a child of VirtualHub. + +### [Add-AzVirtualNetworkGatewayIpConfig](Add-AzVirtualNetworkGatewayIpConfig.md) +Adds an IP configuration to a virtual network gateway. + +### [Add-AzVirtualNetworkPeering](Add-AzVirtualNetworkPeering.md) +Creates a peering between two virtual networks. + +### [Add-AzVirtualNetworkSubnetConfig](Add-AzVirtualNetworkSubnetConfig.md) +Adds a subnet configuration to a virtual network. + +### [Add-AzVirtualRouterPeer](Add-AzVirtualRouterPeer.md) +Add a Peer to an Azure VirtualRouter + +### [Add-AzVpnClientRevokedCertificate](Add-AzVpnClientRevokedCertificate.md) +Adds a VPN client-revocation certificate. + +### [Add-AzVpnClientRootCertificate](Add-AzVpnClientRootCertificate.md) +Adds a VPN client root certificate. + +### [Approve-AzPrivateEndpointConnection](Approve-AzPrivateEndpointConnection.md) +Approves a private endpoint connection. + +### [Deny-AzPrivateEndpointConnection](Deny-AzPrivateEndpointConnection.md) +denies a private endpoint connection. + +### [Deploy-AzNetworkManagerCommit](Deploy-AzNetworkManagerCommit.md) +Deploys a network manager commit. + +### [Disconnect-AzP2SVpnGatewayVpnConnection](Disconnect-AzP2SVpnGatewayVpnConnection.md) +Disconnect given connected vpn client connections with a given p2s vpn gateway + +### [Disconnect-AzVirtualNetworkGatewayVpnConnection](Disconnect-AzVirtualNetworkGatewayVpnConnection.md) +Disconnect given connected vpn client connections with a given virtual network gateway. + +### [Get-AzApplicationGateway](Get-AzApplicationGateway.md) +Gets an application gateway. + +### [Get-AzApplicationGatewayAuthenticationCertificate](Get-AzApplicationGatewayAuthenticationCertificate.md) +Gets an authentication certificate for an application gateway. + +### [Get-AzApplicationGatewayAutoscaleConfiguration](Get-AzApplicationGatewayAutoscaleConfiguration.md) +Gets the Autoscale Configuration of the Application Gateway. + +### [Get-AzApplicationGatewayAvailableServerVariableAndHeader](Get-AzApplicationGatewayAvailableServerVariableAndHeader.md) +Get the supported server variables and available request and response headers. + +### [Get-AzApplicationGatewayAvailableSslOption](Get-AzApplicationGatewayAvailableSslOption.md) +Gets all available ssl options for ssl policy for Application Gateway. + +### [Get-AzApplicationGatewayAvailableWafRuleSet](Get-AzApplicationGatewayAvailableWafRuleSet.md) +Gets all available web application firewall rule sets. + +### [Get-AzApplicationGatewayBackendAddressPool](Get-AzApplicationGatewayBackendAddressPool.md) +Gets a back-end address pool for an application gateway. + +### [Get-AzApplicationGatewayBackendHealth](Get-AzApplicationGatewayBackendHealth.md) +Gets application gateway backend health. + +### [Get-AzApplicationGatewayBackendHttpSetting](Get-AzApplicationGatewayBackendHttpSetting.md) +Gets the back-end HTTP settings of an application gateway. + +### [Get-AzApplicationGatewayBackendSetting](Get-AzApplicationGatewayBackendSetting.md) +Gets the back-end TCP\TLS settings of an application gateway. + +### [Get-AzApplicationGatewayClientAuthConfiguration](Get-AzApplicationGatewayClientAuthConfiguration.md) +Gets the client authentication configuration of a SSL profile object. + +### [Get-AzApplicationGatewayConnectionDraining](Get-AzApplicationGatewayConnectionDraining.md) +Gets the connection draining configuration of a back-end HTTP settings object. + +### [Get-AzApplicationGatewayCustomError](Get-AzApplicationGatewayCustomError.md) +Gets custom error(s) from an application gateway. + +### [Get-AzApplicationGatewayFirewallPolicy](Get-AzApplicationGatewayFirewallPolicy.md) +Gets an application gateway firewall policy. + +### [Get-AzApplicationGatewayFrontendIPConfig](Get-AzApplicationGatewayFrontendIPConfig.md) +Gets the front-end IP configuration of an application gateway. + +### [Get-AzApplicationGatewayFrontendPort](Get-AzApplicationGatewayFrontendPort.md) +Gets the front-end port of an application gateway. + +### [Get-AzApplicationGatewayHttpListener](Get-AzApplicationGatewayHttpListener.md) +Gets the HTTP listener of an application gateway. + +### [Get-AzApplicationGatewayHttpListenerCustomError](Get-AzApplicationGatewayHttpListenerCustomError.md) +Gets custom error(s) from a http listener of an application gateway. + +### [Get-AzApplicationGatewayIdentity](Get-AzApplicationGatewayIdentity.md) +Get identity assigned to the application gateway. + +### [Get-AzApplicationGatewayIPConfiguration](Get-AzApplicationGatewayIPConfiguration.md) +Gets the IP configuration of an application gateway. + +### [Get-AzApplicationGatewayListener](Get-AzApplicationGatewayListener.md) +Gets the TCP\TLS listener of an application gateway. + +### [Get-AzApplicationGatewayPrivateLinkConfiguration](Get-AzApplicationGatewayPrivateLinkConfiguration.md) +Gets the private link configuration of an application gateway. + +### [Get-AzApplicationGatewayProbeConfig](Get-AzApplicationGatewayProbeConfig.md) +Gets an existing health probe configuration from an Application Gateway. + +### [Get-AzApplicationGatewayRedirectConfiguration](Get-AzApplicationGatewayRedirectConfiguration.md) +Gets an existing redirect configuration from an Application Gateway. + +### [Get-AzApplicationGatewayRequestRoutingRule](Get-AzApplicationGatewayRequestRoutingRule.md) +Gets the request routing rule of an application gateway. + +### [Get-AzApplicationGatewayRewriteRuleSet](Get-AzApplicationGatewayRewriteRuleSet.md) +Gets the rewrite rule set of an application gateway. + +### [Get-AzApplicationGatewayRoutingRule](Get-AzApplicationGatewayRoutingRule.md) +Gets the routing rule of an application gateway. + +### [Get-AzApplicationGatewaySku](Get-AzApplicationGatewaySku.md) +Gets the SKU of an application gateway. + +### [Get-AzApplicationGatewaySslCertificate](Get-AzApplicationGatewaySslCertificate.md) +Gets an SSL certificate for an application gateway. + +### [Get-AzApplicationGatewaySslPolicy](Get-AzApplicationGatewaySslPolicy.md) +Gets the SSL policy of an application gateway. + +### [Get-AzApplicationGatewaySslPredefinedPolicy](Get-AzApplicationGatewaySslPredefinedPolicy.md) +Gets Predefined SSL Policies provided by Application Gateway. + +### [Get-AzApplicationGatewaySslProfile](Get-AzApplicationGatewaySslProfile.md) +Gets the SSL profile of an application gateway. + +### [Get-AzApplicationGatewaySslProfilePolicy](Get-AzApplicationGatewaySslProfilePolicy.md) +Gets the SSL policy of an application gateway SSL profile. + +### [Get-AzApplicationGatewayTrustedClientCertificate](Get-AzApplicationGatewayTrustedClientCertificate.md) +Gets the trusted client CA certificate chain with a specific name from the Application Gateway. + +### [Get-AzApplicationGatewayTrustedRootCertificate](Get-AzApplicationGatewayTrustedRootCertificate.md) +Gets the Trusted Root Certificate with a specific name from the Application Gateway. + +### [Get-AzApplicationGatewayUrlPathMapConfig](Get-AzApplicationGatewayUrlPathMapConfig.md) +Gets an array of URL path mappings to a backend server pool. + +### [Get-AzApplicationGatewayWafDynamicManifest](Get-AzApplicationGatewayWafDynamicManifest.md) +Gets the web application firewall manifest and all the supported rule sets. + +### [Get-AzApplicationGatewayWebApplicationFirewallConfiguration](Get-AzApplicationGatewayWebApplicationFirewallConfiguration.md) +Gets the WAF configuration of an application gateway. + +### [Get-AzApplicationSecurityGroup](Get-AzApplicationSecurityGroup.md) +Gets an application security group. + +### [Get-AzAutoApprovedPrivateLinkService](Get-AzAutoApprovedPrivateLinkService.md) +Gets an array of private link service id that can be linked to a private end point with auto approved. + +### [Get-AzAvailablePrivateEndpointType](Get-AzAvailablePrivateEndpointType.md) +Return available private end point types in the location. + +### [Get-AzAvailableServiceAlias](Get-AzAvailableServiceAlias.md) +Get available service aliases in the region. + +### [Get-AzAvailableServiceDelegation](Get-AzAvailableServiceDelegation.md) +Get available service delegations in the region. + +### [Get-AzBastion](Get-AzBastion.md) +Gets a Bastion resource or Bastion resources. + +### [Get-AzBgpServiceCommunity](Get-AzBgpServiceCommunity.md) +Provides a list of all services / regions, BGP communities, and associated prefixes. + +### [Get-AzCustomIpPrefix](Get-AzCustomIpPrefix.md) +Gets a CustomIpPrefix resource + +### [Get-AzDdosProtectionPlan](Get-AzDdosProtectionPlan.md) +Gets a DDoS protection plan. + +### [Get-AzDelegation](Get-AzDelegation.md) +Get a delegation (or all of the delegations) on a given subnet. + +### [Get-AzEffectiveNetworkSecurityGroup](Get-AzEffectiveNetworkSecurityGroup.md) +Gets the effective network security group of a network interface. + +### [Get-AzEffectiveRouteTable](Get-AzEffectiveRouteTable.md) +Gets the effective route table of a network interface. + +### [Get-AzExpressRouteCircuit](Get-AzExpressRouteCircuit.md) +Gets an Azure ExpressRoute circuit from Azure. + +### [Get-AzExpressRouteCircuitARPTable](Get-AzExpressRouteCircuitARPTable.md) +Gets the ARP table from an ExpressRoute circuit. + +### [Get-AzExpressRouteCircuitAuthorization](Get-AzExpressRouteCircuitAuthorization.md) +Gets information about ExpressRoute circuit authorizations. + +### [Get-AzExpressRouteCircuitConnectionConfig](Get-AzExpressRouteCircuitConnectionConfig.md) +Gets an ExpressRoute circuit connection configuration associated with Private Peering of ExpressRouteCircuit. + +### [Get-AzExpressRouteCircuitPeeringConfig](Get-AzExpressRouteCircuitPeeringConfig.md) +Gets an ExpressRoute circuit peering configuration. + +### [Get-AzExpressRouteCircuitRouteTable](Get-AzExpressRouteCircuitRouteTable.md) +Gets a route table from an ExpressRoute circuit. + +### [Get-AzExpressRouteCircuitRouteTableSummary](Get-AzExpressRouteCircuitRouteTableSummary.md) +Gets a route table summary of an ExpressRoute circuit. + +### [Get-AzExpressRouteCircuitStat](Get-AzExpressRouteCircuitStat.md) +Gets usage statistics of an ExpressRoute circuit. + +### [Get-AzExpressRouteConnection](Get-AzExpressRouteConnection.md) +Gets a ExpressRoute connection by name or lists all ExpressRoute connections connected to a ExpressRouteGateway. + +### [Get-AzExpressRouteCrossConnection](Get-AzExpressRouteCrossConnection.md) +Gets an Azure ExpressRoute cross connection from Azure. + +### [Get-AzExpressRouteCrossConnectionArpTable](Get-AzExpressRouteCrossConnectionArpTable.md) +Gets the ARP table from an ExpressRoute cross connection. + +### [Get-AzExpressRouteCrossConnectionPeering](Get-AzExpressRouteCrossConnectionPeering.md) +Gets an ExpressRoute cross connection peering configuration. + +### [Get-AzExpressRouteCrossConnectionRouteTable](Get-AzExpressRouteCrossConnectionRouteTable.md) +Gets a route table from an ExpressRoute cross connection. + +### [Get-AzExpressRouteCrossConnectionRouteTableSummary](Get-AzExpressRouteCrossConnectionRouteTableSummary.md) +Gets a route table summary of an ExpressRoute cross connection. + +### [Get-AzExpressRouteGateway](Get-AzExpressRouteGateway.md) +Gets a ExpressRouteGateway resource using ResourceGroupName and GatewayName OR lists all gateways by ResourceGroupName or SubscriptionId. + +### [Get-AzExpressRoutePort](Get-AzExpressRoutePort.md) +Gets an Azure ExpressRoutePort resource. + +### [Get-AzExpressRoutePortAuthorization](Get-AzExpressRoutePortAuthorization.md) +Gets information about ExpressRoutePort authorizations. + +### [Get-AzExpressRoutePortIdentity](Get-AzExpressRoutePortIdentity.md) +Get identity assigned to an ExpressRoutePort. + +### [Get-AzExpressRoutePortLinkConfig](Get-AzExpressRoutePortLinkConfig.md) +Gets an ExpressRoutePort link configuration. + +### [Get-AzExpressRoutePortsLocation](Get-AzExpressRoutePortsLocation.md) +Gets the locations at which ExpressRoutePort resources are available. + +### [Get-AzExpressRouteServiceProvider](Get-AzExpressRouteServiceProvider.md) +Gets a list ExpressRoute service providers and their attributes. + +### [Get-AzFirewall](Get-AzFirewall.md) +Gets a Azure Firewall. + +### [Get-AzFirewallFqdnTag](Get-AzFirewallFqdnTag.md) +Gets the available Azure Firewall Fqdn Tags. + +### [Get-AzFirewallLearnedIpPrefix](Get-AzFirewallLearnedIpPrefix.md) +Gets firewall auto learned ip prefixes. + +### [Get-AzFirewallPolicy](Get-AzFirewallPolicy.md) +Gets a Azure Firewall Policy + +### [Get-AzFirewallPolicyRuleCollectionGroup](Get-AzFirewallPolicyRuleCollectionGroup.md) +Gets a Azure Firewall Policy Rule Collection Group + +### [Get-AzIpAllocation](Get-AzIpAllocation.md) +Gets a Azure IpAllocation. + +### [Get-AzIpGroup](Get-AzIpGroup.md) +Get an Azure IpGroup + +### [Get-AzLoadBalancer](Get-AzLoadBalancer.md) +Gets a load balancer. + +### [Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping](Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping.md) +Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping retrieves inbound nat rule port mapping list for one backend address. + +### [Get-AzLoadBalancerBackendAddressPool](Get-AzLoadBalancerBackendAddressPool.md) +Get-AzLoadBalancerBackendAddressPool retrieves one or more backend address pools associated with a load balancer. + +### [Get-AzLoadBalancerBackendAddressPoolConfig](Get-AzLoadBalancerBackendAddressPoolConfig.md) +Gets a backend address pool configuration for a load balancer. + +### [Get-AzLoadBalancerFrontendIpConfig](Get-AzLoadBalancerFrontendIpConfig.md) +Gets a front-end IP configuration in a load balancer. + +### [Get-AzLoadBalancerInboundNatPoolConfig](Get-AzLoadBalancerInboundNatPoolConfig.md) +Gets one or more inbound NAT pool configurations from a load balancer. + +### [Get-AzLoadBalancerInboundNatRuleConfig](Get-AzLoadBalancerInboundNatRuleConfig.md) +Gets an inbound NAT rule configuration for a load balancer. + +### [Get-AzLoadBalancerOutboundRuleConfig](Get-AzLoadBalancerOutboundRuleConfig.md) +Gets an outbound rule configuration in a load balancer. + +### [Get-AzLoadBalancerProbeConfig](Get-AzLoadBalancerProbeConfig.md) +Gets a probe configuration for a load balancer. + +### [Get-AzLoadBalancerRuleConfig](Get-AzLoadBalancerRuleConfig.md) +Gets the rule configuration for a load balancer. + +### [Get-AzLocalNetworkGateway](Get-AzLocalNetworkGateway.md) +Gets a Local Network Gateway + +### [Get-AzNatGateway](Get-AzNatGateway.md) +Gets a Nat Gateway resource in a resource group by name or NatGateway Id or all Nat Gateway resources in a resource group. + +### [Get-AzNetworkInterface](Get-AzNetworkInterface.md) +Gets a network interface. + +### [Get-AzNetworkInterfaceIpConfig](Get-AzNetworkInterfaceIpConfig.md) +Gets a network interface IP configuration for a network interface. + +### [Get-AzNetworkInterfaceTapConfig](Get-AzNetworkInterfaceTapConfig.md) +Gets a Tap configuration resource. + +### [Get-AzNetworkManager](Get-AzNetworkManager.md) +Gets a network manager in a resource group. + +### [Get-AzNetworkManagerActiveConnectivityConfiguration](Get-AzNetworkManagerActiveConnectivityConfiguration.md) +Lists NetworkManager Active Connectivity Configurations in network manager. + +### [Get-AzNetworkManagerActiveSecurityAdminRule](Get-AzNetworkManagerActiveSecurityAdminRule.md) +Lists NetworkManager Active Security Admin Rules in network manager. + +### [Get-AzNetworkManagerConnectivityConfiguration](Get-AzNetworkManagerConnectivityConfiguration.md) +Gets a connectivity configuration in a network manager. + +### [Get-AzNetworkManagerDeploymentStatus](Get-AzNetworkManagerDeploymentStatus.md) +Lists Deployment Status in a network manager. + +### [Get-AzNetworkManagerEffectiveConnectivityConfiguration](Get-AzNetworkManagerEffectiveConnectivityConfiguration.md) +Lists NetworkManager Effective Connectivity Configurations applied on a virtual networks. + +### [Get-AzNetworkManagerEffectiveSecurityAdminRule](Get-AzNetworkManagerEffectiveSecurityAdminRule.md) +Lists NetworkManager Effective Security Admin Rules applied on a virtual networks. + +### [Get-AzNetworkManagerGroup](Get-AzNetworkManagerGroup.md) +Gets network group(s) in a network manager. + +### [Get-AzNetworkManagerManagementGroupConnection](Get-AzNetworkManagerManagementGroupConnection.md) +Gets a network manager management group connection. + +### [Get-AzNetworkManagerScopeConnection](Get-AzNetworkManagerScopeConnection.md) +Gets a scope connection in a network manager. + +### [Get-AzNetworkManagerSecurityAdminConfiguration](Get-AzNetworkManagerSecurityAdminConfiguration.md) +Gets a network security admin configuration in a network manager. + +### [Get-AzNetworkManagerSecurityAdminRule](Get-AzNetworkManagerSecurityAdminRule.md) +Gets a security admin rule in a network manager. + +### [Get-AzNetworkManagerSecurityAdminRuleCollection](Get-AzNetworkManagerSecurityAdminRuleCollection.md) +Gets a security admin rule collection in a network manager. + +### [Get-AzNetworkManagerStaticMember](Get-AzNetworkManagerStaticMember.md) +Gets network manager static members. + +### [Get-AzNetworkManagerSubscriptionConnection](Get-AzNetworkManagerSubscriptionConnection.md) +Gets a network manager subscription connection. + +### [Get-AzNetworkProfile](Get-AzNetworkProfile.md) +Gets an existing network profile top level resource + +### [Get-AzNetworkSecurityGroup](Get-AzNetworkSecurityGroup.md) +Gets a network security group. + +### [Get-AzNetworkSecurityRuleConfig](Get-AzNetworkSecurityRuleConfig.md) +Get a network security rule configuration for a network security group. + +### [Get-AzNetworkServiceTag](Get-AzNetworkServiceTag.md) +Gets the list of service tag information resources. + +### [Get-AzNetworkUsage](Get-AzNetworkUsage.md) +Lists network usages for a subscription + +### [Get-AzNetworkVirtualAppliance](Get-AzNetworkVirtualAppliance.md) +Get or List Network Virtual Appliances. + +### [Get-AzNetworkVirtualApplianceSku](Get-AzNetworkVirtualApplianceSku.md) +Get or List available Network Virtual Appliance Skus in the inventory. + +### [Get-AzNetworkWatcher](Get-AzNetworkWatcher.md) +Gets the properties of a Network Watcher + +### [Get-AzNetworkWatcherConnectionMonitor](Get-AzNetworkWatcherConnectionMonitor.md) +Returns connection monitor with specified name or the list of connection monitors + +### [Get-AzNetworkWatcherConnectionMonitorReport](Get-AzNetworkWatcherConnectionMonitorReport.md) +Query a snapshot of the most recent connection states. + +### [Get-AzNetworkWatcherFlowLog](Get-AzNetworkWatcherFlowLog.md) +Gets a flow log resource or a list of flow log resources in the specified subscription and region. + +### [Get-AzNetworkWatcherFlowLogStatus](Get-AzNetworkWatcherFlowLogStatus.md) +Gets the status of flow logging on a resource. + +### [Get-AzNetworkWatcherNextHop](Get-AzNetworkWatcherNextHop.md) +Gets the next hop from a VM. + +### [Get-AzNetworkWatcherPacketCapture](Get-AzNetworkWatcherPacketCapture.md) +Gets information and properties and status of a packet capture resource. + +### [Get-AzNetworkWatcherReachabilityProvidersList](Get-AzNetworkWatcherReachabilityProvidersList.md) +Lists all available internet service providers for a specified Azure region. + +### [Get-AzNetworkWatcherReachabilityReport](Get-AzNetworkWatcherReachabilityReport.md) +Gets the relative latency score for internet service providers from a specified location to Azure regions. + +### [Get-AzNetworkWatcherSecurityGroupView](Get-AzNetworkWatcherSecurityGroupView.md) +View the configured and effective network security group rules applied on a VM. + +### [Get-AzNetworkWatcherTopology](Get-AzNetworkWatcherTopology.md) +Gets a network level view of resources and their relationships in a resource group. + +### [Get-AzNetworkWatcherTroubleshootingResult](Get-AzNetworkWatcherTroubleshootingResult.md) +Gets the troubleshooting result from the previously run or currently running troubleshooting operation. + +### [Get-AzP2sVpnGateway](Get-AzP2sVpnGateway.md) +Gets an existing P2SVpnGateway under VirtualHub. + +### [Get-AzP2sVpnGatewayConnectionHealth](Get-AzP2sVpnGatewayConnectionHealth.md) +Gets the current aggregared point to site connections health information from P2SVpnGateway. + +### [Get-AzP2sVpnGatewayDetailedConnectionHealth](Get-AzP2sVpnGatewayDetailedConnectionHealth.md) +Gets the detailed information of current point to site connections from P2SVpnGateway. + +### [Get-AzP2sVpnGatewayVpnProfile](Get-AzP2sVpnGatewayVpnProfile.md) +Generates and returns a SAS url for customer to download Vpn profile for point to site client setup to have point to site connectivity to P2SVpnGateway. + +### [Get-AzPrivateDnsZoneGroup](Get-AzPrivateDnsZoneGroup.md) +Gets private DNS zone group + +### [Get-AzPrivateEndpoint](Get-AzPrivateEndpoint.md) +Get a private endpoint + +### [Get-AzPrivateEndpointConnection](Get-AzPrivateEndpointConnection.md) +Gets a private endpoint connection resource. + +### [Get-AzPrivateLinkResource](Get-AzPrivateLinkResource.md) +Gets a private link resource. + +### [Get-AzPrivateLinkService](Get-AzPrivateLinkService.md) +Gets private link service + +### [Get-AzPublicIpAddress](Get-AzPublicIpAddress.md) +Gets a public IP address. + +### [Get-AzPublicIpPrefix](Get-AzPublicIpPrefix.md) +Gets a public IP prefix + +### [Get-AzRouteConfig](Get-AzRouteConfig.md) +Gets routes from a route table. + +### [Get-AzRouteFilter](Get-AzRouteFilter.md) +Gets a route filter. + +### [Get-AzRouteFilterRuleConfig](Get-AzRouteFilterRuleConfig.md) +Gets a route filter rule in a route filter. + +### [Get-AzRouteMap](Get-AzRouteMap.md) +Retrieves a route map of a VirtualHub. + +### [Get-AzRouteServer](Get-AzRouteServer.md) +Get an Azure RouteServer + +### [Get-AzRouteServerPeer](Get-AzRouteServerPeer.md) +Gets a RouteServer peer in an Azure RouteServer + +### [Get-AzRouteServerPeerAdvertisedRoute](Get-AzRouteServerPeerAdvertisedRoute.md) +List routes being advertised by specific route server peer + +### [Get-AzRouteServerPeerLearnedRoute](Get-AzRouteServerPeerLearnedRoute.md) +List routes learned by a specific route server peer + +### [Get-AzRouteTable](Get-AzRouteTable.md) +Gets route tables. + +### [Get-AzRoutingIntent](Get-AzRoutingIntent.md) +Retrieves a routing intent resource associated with a VirtualHub. + +### [Get-AzRoutingPolicy](Get-AzRoutingPolicy.md) +Retrieves a routing policy of a routing intent resource associated with a VirtualHub. + +### [Get-AzSecurityPartnerProvider](Get-AzSecurityPartnerProvider.md) +Get an Azure SecurityPartnerProvider + +### [Get-AzServiceEndpointPolicy](Get-AzServiceEndpointPolicy.md) +Gets a service endpoint policy. + +### [Get-AzServiceEndpointPolicyDefinition](Get-AzServiceEndpointPolicyDefinition.md) +Gets a service endpoint policy definition. + +### [Get-AzVHubEffectiveRoute](Get-AzVHubEffectiveRoute.md) +Retrieves the effective routes of a virtual hub resource + +### [Get-AzVHubInboundRoute](Get-AzVHubInboundRoute.md) +Retrieves the inbound routes of a virtual hub connection + +### [Get-AzVHubOutboundRoute](Get-AzVHubOutboundRoute.md) +Retrieves the outbound routes of a virtual hub connection + +### [Get-AzVHubRouteTable](Get-AzVHubRouteTable.md) +Retrieves a hub route table resource associated with a VirtualHub. + +### [Get-AzVirtualApplianceSite](Get-AzVirtualApplianceSite.md) +Get or List sites connected to Network Virtual Appliance resource(s). + +### [Get-AzVirtualHub](Get-AzVirtualHub.md) +Gets an Azure VirtualHub by Name and ResourceGroupName or lists all Virtual Hubs by ResourceGroupName/Subscription. + +### [Get-AzVirtualHubBgpConnection](Get-AzVirtualHubBgpConnection.md) +The Get-AzVirtualHubBgpConnection cmdlet gets a Virtual WAN Hub BGP Connection in a Virtual WAN Hub or lists all Virtual WAN Hub BGP Connections in a Virtual WAN Hub. + +### [Get-AzVirtualHubRouteTable](Get-AzVirtualHubRouteTable.md) +Gets a Virtual Hub Route Table in a virtual hub or lists all route tables in a virtual hub. The cmdlet [Get-AzVHubRouteTable](./Get-AzVHubRouteTable.md) is replacing this cmdlet. + +### [Get-AzVirtualHubVnetConnection](Get-AzVirtualHubVnetConnection.md) +Gets a Virtual Network Connection in a virtual hub or lists all virtual network connections in a virtual hub. + +### [Get-AzVirtualNetwork](Get-AzVirtualNetwork.md) +Gets a virtual network in a resource group. + +### [Get-AzVirtualNetworkAvailableEndpointService](Get-AzVirtualNetworkAvailableEndpointService.md) +Lists available endpoint services for location. + +### [Get-AzVirtualNetworkGateway](Get-AzVirtualNetworkGateway.md) +Gets a Virtual Network Gateway + +### [Get-AzVirtualNetworkGatewayAdvertisedRoute](Get-AzVirtualNetworkGatewayAdvertisedRoute.md) +Lists routes being advertised by an Azure virtual network gateway + +### [Get-AzVirtualNetworkGatewayBGPPeerStatus](Get-AzVirtualNetworkGatewayBGPPeerStatus.md) +Lists an Azure virtual network gateway's BGP peers + +### [Get-AzVirtualNetworkGatewayConnection](Get-AzVirtualNetworkGatewayConnection.md) +Gets a Virtual Network Gateway Connection + +### [Get-AzVirtualNetworkGatewayConnectionIkeSa](Get-AzVirtualNetworkGatewayConnectionIkeSa.md) +Get IKE Security Associations of a Virtual Network Gateway Connection + +### [Get-AzVirtualNetworkGatewayConnectionSharedKey](Get-AzVirtualNetworkGatewayConnectionSharedKey.md) +Displays the shared key used for the connection. + +### [Get-AzVirtualNetworkGatewayConnectionVpnDeviceConfigScript](Get-AzVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md) +This commandlet takes the connection resource, VPN device brand, model, firmware version, and return the corresponding configuration script that customers can apply directly on their on-premises VPN devices. The script will follow the syntax of the selected device, and fill in the necessary parameters such as Azure gateway public IP addresses, virtual network address prefixes, VPN tunnel pre-shared key, etc. so customers can simply copy-paste to their VPN device configurations. + +### [Get-AzVirtualNetworkGatewayLearnedRoute](Get-AzVirtualNetworkGatewayLearnedRoute.md) +Lists routes learned by an Azure virtual network gateway + +### [Get-AzVirtualNetworkGatewayNatRule](Get-AzVirtualNetworkGatewayNatRule.md) +Gets a Virtual Network Gateway NatRule. + +### [Get-AzVirtualNetworkGatewaySupportedVpnDevice](Get-AzVirtualNetworkGatewaySupportedVpnDevice.md) +This commandlet returns a list of supported VPN device brands, models, and firmware versions. + +### [Get-AzVirtualNetworkGatewayVpnClientConnectionHealth](Get-AzVirtualNetworkGatewayVpnClientConnectionHealth.md) +Get the list of vpn client connection health of an Azure virtual network gateway for per vpn client connection + +### [Get-AzVirtualNetworkPeering](Get-AzVirtualNetworkPeering.md) +Gets the virtual network peering. + +### [Get-AzVirtualNetworkSubnetConfig](Get-AzVirtualNetworkSubnetConfig.md) +Gets a subnet in a virtual network. + +### [Get-AzVirtualNetworkTap](Get-AzVirtualNetworkTap.md) +Gets a virtual network tap + +### [Get-AzVirtualNetworkUsageList](Get-AzVirtualNetworkUsageList.md) +Gets virtual network current usage. + +### [Get-AzVirtualRouter](Get-AzVirtualRouter.md) +Get an Azure VirtualRouter + +### [Get-AzVirtualRouterPeer](Get-AzVirtualRouterPeer.md) +Gets a VirtualRouter peer in an Azure VirtualRouter + +### [Get-AzVirtualRouterPeerAdvertisedRoute](Get-AzVirtualRouterPeerAdvertisedRoute.md) +List routes being advertised by specific virtual router peer + +### [Get-AzVirtualRouterPeerLearnedRoute](Get-AzVirtualRouterPeerLearnedRoute.md) +List routes learned by a specific virtual router peer + +### [Get-AzVirtualWan](Get-AzVirtualWan.md) +Gets a Virtual WAN or all Virtual WANs in a resource group or subscription. + +### [Get-AzVirtualWanVpnConfiguration](Get-AzVirtualWanVpnConfiguration.md) +Gets the Vpn configuration for a subset of VpnSites connected to this WAN via VpnConnections. Uploads the generated Vpn +configuration to a storage blob specified by the customer. + +### [Get-AzVirtualWanVpnServerConfiguration](Get-AzVirtualWanVpnServerConfiguration.md) +Gets the list of all VpnServerConfigurations that are associated with this VirtualWan. + +### [Get-AzVirtualWanVpnServerConfigurationVpnProfile](Get-AzVirtualWanVpnServerConfigurationVpnProfile.md) +Generates and downloads Vpn profile at VirtualWan-VpnServerConfiguration level for Point to site client setup. + +### [Get-AzVpnClientConfiguration](Get-AzVpnClientConfiguration.md) +Allows users to easily download the Vpn Profile package that was generated using the New-AzVpnClientConfiguration commandlet. + +### [Get-AzVpnClientIpsecParameter](Get-AzVpnClientIpsecParameter.md) +Gets the vpn Ipsec parameters set on Virtual Network Gateway for Point to site connections. + +### [Get-AzVpnClientPackage](Get-AzVpnClientPackage.md) +Gets information about a VPN client package. + +### [Get-AzVpnClientRevokedCertificate](Get-AzVpnClientRevokedCertificate.md) +Gets information about VPN client-revocation certificates. + +### [Get-AzVpnClientRootCertificate](Get-AzVpnClientRootCertificate.md) +Gets information about VPN root certificates. + +### [Get-AzVpnConnection](Get-AzVpnConnection.md) +Gets a vpn connection by name or lists all vpn connections connected to a VpnGateway. + +>[!NOTE] +> This Powershell command is for customers using Virtual WAN Site-to-site VPN Gateway only. + +### [Get-AzVpnGateway](Get-AzVpnGateway.md) +Gets a VpnGateway resource using ResourceGroupName and GatewayName OR lists all gateways by ResourceGroupName or SubscriptionId. + +### [Get-AzVpnGatewayNatRule](Get-AzVpnGatewayNatRule.md) +Gets a NAT rule associated with VpnGateway. + +### [Get-AzVpnServerConfiguration](Get-AzVpnServerConfiguration.md) +Gets an existing VpnServerConfiguration for point to site connectivity. + +### [New-AzP2sVpnGateway](New-AzP2sVpnGateway.md) +Create a new P2SVpnGateway under VirtualHub for point to site connectivity. + +### [Get-AzVpnSite](Get-AzVpnSite.md) +Gets an Azure VpnSite resource by name OR lists all VpnSites in a ResourceGroup or SubscriptionId. + +This is an RM representation of customer branches that are uploaded to Azure for S2S connectivity with a Cortex virtual hub. + +### [Get-AzVpnSiteLinkConnectionIkeSa](Get-AzVpnSiteLinkConnectionIkeSa.md) +Get IKE Security Associations of VPN Site Link Connections + +### [Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic](Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic.md) +Invoke network configuration diagnostic session for specified network profiles on target resource. + +### [Move-AzExpressRouteCircuit](Move-AzExpressRouteCircuit.md) +Moves an ExpressRoute circuit from the classic deployment model to the Resource Manager deployment model. + +### [New-AzApplicationGateway](New-AzApplicationGateway.md) +Creates an application gateway. + +### [New-AzApplicationGatewayAuthenticationCertificate](New-AzApplicationGatewayAuthenticationCertificate.md) +Creates an authentication certificate for an application gateway. + +### [New-AzApplicationGatewayAutoscaleConfiguration](New-AzApplicationGatewayAutoscaleConfiguration.md) +Creates a Autoscale Configuration for the Application Gateway. + +### [New-AzApplicationGatewayBackendAddressPool](New-AzApplicationGatewayBackendAddressPool.md) +Creates a back-end address pool for an application gateway. + +### [New-AzApplicationGatewayBackendHttpSetting](New-AzApplicationGatewayBackendHttpSetting.md) +Creates back-end HTTP setting for an application gateway. + +### [New-AzApplicationGatewayBackendSetting](New-AzApplicationGatewayBackendSetting.md) +Creates back-end TCP\TLS setting for an application gateway. + +### [New-AzApplicationGatewayClientAuthConfiguration](New-AzApplicationGatewayClientAuthConfiguration.md) +Creates a new client authentication configuration for SSL profile. + +### [New-AzApplicationGatewayConnectionDraining](New-AzApplicationGatewayConnectionDraining.md) +Creates a new connection draining configuration for back-end HTTP settings. + +### [New-AzApplicationGatewayCustomError](New-AzApplicationGatewayCustomError.md) +Creates a custom error with http status code and custom error page url + +### [New-AzApplicationGatewayFirewallCondition](New-AzApplicationGatewayFirewallCondition.md) +Creates a match condition for custom rule + +### [New-AzApplicationGatewayFirewallCustomRule](New-AzApplicationGatewayFirewallCustomRule.md) +Creates a new custom rule for the application gateway firewall policy. + +### [New-AzApplicationGatewayFirewallCustomRuleGroupByUserSession](New-AzApplicationGatewayFirewallCustomRuleGroupByUserSession.md) +Creates a new GroupByUserSession for the application gateway firewall custom rule. + +### [New-AzApplicationGatewayFirewallCustomRuleGroupByVariable](New-AzApplicationGatewayFirewallCustomRuleGroupByVariable.md) +Creates a new GroupByVariable for the application gateway firewall custom rule GroupByUserSession. + +### [New-AzApplicationGatewayFirewallDisabledRuleGroupConfig](New-AzApplicationGatewayFirewallDisabledRuleGroupConfig.md) +Creates a new disabled rule group configuration. + +### [New-AzApplicationGatewayFirewallExclusionConfig](New-AzApplicationGatewayFirewallExclusionConfig.md) +Creates a new exclusion rule list for application gateway waf + +### [New-AzApplicationGatewayFirewallMatchVariable](New-AzApplicationGatewayFirewallMatchVariable.md) +Creates a match variable for firewall condition. + +### [New-AzApplicationGatewayFirewallPolicy](New-AzApplicationGatewayFirewallPolicy.md) +Creates a application gateway firewall policy. + +### [New-AzApplicationGatewayFirewallPolicyExclusion](New-AzApplicationGatewayFirewallPolicyExclusion.md) +Creates an exclusion on the Firewall Policy + +### [New-AzApplicationGatewayFirewallPolicyExclusionManagedRule](New-AzApplicationGatewayFirewallPolicyExclusionManagedRule.md) +Creates an exclusionManagedRule entry for ExclusionManagedRuleGroup entry. + +### [New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup](New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup.md) +Creates ExclusionManagedRuleGroup entry in ExclusionManagedRuleSets for the firewall policy exclusion. + +### [New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet](New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet.md) +Creates an ExclusionManagedRuleSet for the firewallPolicy exclusion + +### [New-AzApplicationGatewayFirewallPolicyLogScrubbingConfiguration](New-AzApplicationGatewayFirewallPolicyLogScrubbingConfiguration.md) +Creates a log scrubbing configuration for firewall policy + +### [New-AzApplicationGatewayFirewallPolicyLogScrubbingRule](New-AzApplicationGatewayFirewallPolicyLogScrubbingRule.md) +Creates a log scrubbing rule for firewall policy + +### [New-AzApplicationGatewayFirewallPolicyManagedRule](New-AzApplicationGatewayFirewallPolicyManagedRule.md) +Create ManagedRules for the firewall policy. + +### [New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride](New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride.md) +Creates RuleGroupOverride entry in ManagedRuleSets for the firewall policy. + +### [New-AzApplicationGatewayFirewallPolicyManagedRuleOverride](New-AzApplicationGatewayFirewallPolicyManagedRuleOverride.md) +Creates a managedRuleOverride entry for RuleGroupOverrideGroup entry. + +### [New-AzApplicationGatewayFirewallPolicyManagedRuleSet](New-AzApplicationGatewayFirewallPolicyManagedRuleSet.md) +Creates a ManagedRuleSet for the firewallPolicy + +### [New-AzApplicationGatewayFirewallPolicySetting](New-AzApplicationGatewayFirewallPolicySetting.md) +Creates a policy setting for the firewall policy + +### [New-AzApplicationGatewayFrontendIPConfig](New-AzApplicationGatewayFrontendIPConfig.md) +Creates a front-end IP configuration for an application gateway. + +### [New-AzApplicationGatewayFrontendPort](New-AzApplicationGatewayFrontendPort.md) +Creates a front-end port for an application gateway. + +### [New-AzApplicationGatewayHttpListener](New-AzApplicationGatewayHttpListener.md) +Creates an HTTP listener for an application gateway. + +### [New-AzApplicationGatewayIdentity](New-AzApplicationGatewayIdentity.md) +Creates an identity object for an application gateway. This will hold reference to the user assigned identity. + +### [New-AzApplicationGatewayIPConfiguration](New-AzApplicationGatewayIPConfiguration.md) +Creates an IP configuration for an application gateway. + +### [New-AzApplicationGatewayListener](New-AzApplicationGatewayListener.md) +Creates an TCP\TLS listener for an application gateway. + +### [New-AzApplicationGatewayPathRuleConfig](New-AzApplicationGatewayPathRuleConfig.md) +Creates an application gateway path rule. + +### [New-AzApplicationGatewayPrivateLinkConfiguration](New-AzApplicationGatewayPrivateLinkConfiguration.md) +Creates a private link configuration for an application gateway + +### [New-AzApplicationGatewayPrivateLinkIpConfiguration](New-AzApplicationGatewayPrivateLinkIpConfiguration.md) +Creates an Ip Configuration to be associated with PrivateLink Configuration + +### [New-AzApplicationGatewayProbeConfig](New-AzApplicationGatewayProbeConfig.md) +Creates a health probe. + +### [New-AzApplicationGatewayProbeHealthResponseMatch](New-AzApplicationGatewayProbeHealthResponseMatch.md) +Creates a health probe response match used by Health Probe for an application gateway. + +### [New-AzApplicationGatewayRedirectConfiguration](New-AzApplicationGatewayRedirectConfiguration.md) +Creates a redirect configuration for an application gateway. + +### [New-AzApplicationGatewayRequestRoutingRule](New-AzApplicationGatewayRequestRoutingRule.md) +Creates a request routing rule for an application gateway. + +### [New-AzApplicationGatewayRewriteRule](New-AzApplicationGatewayRewriteRule.md) +Creates a rewrite rule for an application gateway. + +### [New-AzApplicationGatewayRewriteRuleActionSet](New-AzApplicationGatewayRewriteRuleActionSet.md) +Creates a rewrite rule action set for an application gateway. + +### [New-AzApplicationGatewayRewriteRuleCondition](New-AzApplicationGatewayRewriteRuleCondition.md) +Adds a condition to the RewriteRule for an application gateway. + +### [New-AzApplicationGatewayRewriteRuleHeaderConfiguration](New-AzApplicationGatewayRewriteRuleHeaderConfiguration.md) +Creates a rewrite rule header configuration for an application gateway. + +### [New-AzApplicationGatewayRewriteRuleSet](New-AzApplicationGatewayRewriteRuleSet.md) +Creates a rewrite rule set for an application gateway. + +### [New-AzApplicationGatewayRewriteRuleUrlConfiguration](New-AzApplicationGatewayRewriteRuleUrlConfiguration.md) +Creates a rewrite rule url configuration for an application gateway. + +### [New-AzApplicationGatewayRoutingRule](New-AzApplicationGatewayRoutingRule.md) +Creates a routing rule for an application gateway. + +### [New-AzApplicationGatewaySku](New-AzApplicationGatewaySku.md) +Creates a SKU for an application gateway. + +### [New-AzApplicationGatewaySslCertificate](New-AzApplicationGatewaySslCertificate.md) +Creates an SSL certificate for an Azure application gateway. + +### [New-AzApplicationGatewaySslPolicy](New-AzApplicationGatewaySslPolicy.md) +Creates an SSL policy for an application gateway. + +### [New-AzApplicationGatewaySslProfile](New-AzApplicationGatewaySslProfile.md) +Creates SSL profile for an application gateway. + +### [New-AzApplicationGatewayTrustedClientCertificate](New-AzApplicationGatewayTrustedClientCertificate.md) +Creates a trusted client CA certificate chain for an application gateway. + +### [New-AzApplicationGatewayTrustedRootCertificate](New-AzApplicationGatewayTrustedRootCertificate.md) +Creates a Trusted Root Certificate for an application gateway. + +### [New-AzApplicationGatewayUrlPathMapConfig](New-AzApplicationGatewayUrlPathMapConfig.md) +Creates an array of URL path mappings to a backend server pool. + +### [New-AzApplicationGatewayWebApplicationFirewallConfiguration](New-AzApplicationGatewayWebApplicationFirewallConfiguration.md) +Creates a WAF configuration for an application gateway. + +### [New-AzApplicationSecurityGroup](New-AzApplicationSecurityGroup.md) +Creates an application security group. + +### [New-AzBastion](New-AzBastion.md) +Creates a bastion resource. + +### [New-AzContainerNicConfig](New-AzContainerNicConfig.md) +Creates a new container network interface configuration object. + +### [New-AzContainerNicConfigIpConfig](New-AzContainerNicConfigIpConfig.md) +Creates a container nic configuration ip configuration object. + +### [New-AzCustomIpPrefix](New-AzCustomIpPrefix.md) +Creates a CustomIpPrefix resource + +### [New-AzDdosProtectionPlan](New-AzDdosProtectionPlan.md) +Creates a DDoS protection plan. + +### [New-AzDelegation](New-AzDelegation.md) +Creates a service delegation. + +### [New-AzExpressRouteCircuit](New-AzExpressRouteCircuit.md) +Creates an Azure express route circuit. + +### [New-AzExpressRouteCircuitAuthorization](New-AzExpressRouteCircuitAuthorization.md) +Creates an ExpressRoute circuit authorization. + +### [New-AzExpressRouteCircuitPeeringConfig](New-AzExpressRouteCircuitPeeringConfig.md) +Creates a new peering configuration to be added to an ExpressRoute circuit. + +### [New-AzExpressRouteConnection](New-AzExpressRouteConnection.md) +Creates an ExpressRoute connection that connects an ExpressRoute gateway to an on premise ExpressRoute circuit + +### [New-AzExpressRouteGateway](New-AzExpressRouteGateway.md) +Creates a Scalable ExpressRoute Gateway. + +### [New-AzExpressRoutePort](New-AzExpressRoutePort.md) +Creates an Azure ExpressRoutePort. + +### [New-AzExpressRoutePortIdentity](New-AzExpressRoutePortIdentity.md) +Creates an Azure ExpressRoutePortIdentity. + +### [New-AzExpressRoutePortLOA](New-AzExpressRoutePortLOA.md) +Download letter of authorization document for an express route port. + +### [New-AzFirewall](New-AzFirewall.md) +Creates a new Firewall in a resource group. + +### [New-AzFirewallApplicationRule](New-AzFirewallApplicationRule.md) +Creates a Firewall Application Rule. + +### [New-AzFirewallApplicationRuleCollection](New-AzFirewallApplicationRuleCollection.md) +Creates a collection of Firewall application rules. + +### [New-AzFirewallHubIpAddress](New-AzFirewallHubIpAddress.md) +Ip addresses assoicated to the firewall on virtual hub + +### [New-AzFirewallHubPublicIpAddress](New-AzFirewallHubPublicIpAddress.md) +Public Ip assoicated to the firewall on virtual hub + +### [New-AzFirewallNatRule](New-AzFirewallNatRule.md) +Creates a Firewall NAT Rule. + +### [New-AzFirewallNatRuleCollection](New-AzFirewallNatRuleCollection.md) +Creates a collection of Firewall NAT rules. + +### [New-AzFirewallNetworkRule](New-AzFirewallNetworkRule.md) +Creates a Firewall Network Rule. + +### [New-AzFirewallNetworkRuleCollection](New-AzFirewallNetworkRuleCollection.md) +Creates a Azure Firewall Network Collection of Network rules. + +### [New-AzFirewallPolicy](New-AzFirewallPolicy.md) +Creates a new Azure Firewall Policy + +### [New-AzFirewallPolicyApplicationRule](New-AzFirewallPolicyApplicationRule.md) +Create a new Azure Firewall Policy Application Rule + +### [New-AzFirewallPolicyApplicationRuleCustomHttpHeader](New-AzFirewallPolicyApplicationRuleCustomHttpHeader.md) +Create a new Azure Firewall Policy Application Rule Custon HTTP Header + +### [New-AzFirewallPolicyDnsSetting](New-AzFirewallPolicyDnsSetting.md) +Creates a new DNS Setting for Azure Firewall Policy + +### [New-AzFirewallPolicyExplicitProxy](New-AzFirewallPolicyExplicitProxy.md) +Creates a new Explicit Proxy + +### [New-AzFirewallPolicyFilterRuleCollection](New-AzFirewallPolicyFilterRuleCollection.md) +Create a new Azure Firewall Policy Filter Rule Collection + +### [New-AzFirewallPolicyIntrusionDetection](New-AzFirewallPolicyIntrusionDetection.md) +Creates a new Azure Firewall Policy Intrusion Detection to associate with Firewall Policy + +### [New-AzFirewallPolicyIntrusionDetectionBypassTraffic](New-AzFirewallPolicyIntrusionDetectionBypassTraffic.md) +Creates a new Azure Firewall Policy Intrusion Detection Bypass Traffic Setting + +### [New-AzFirewallPolicyIntrusionDetectionSignatureOverride](New-AzFirewallPolicyIntrusionDetectionSignatureOverride.md) +Creates a new Azure Firewall Policy Intrusion Detection Signature Override + +### [New-AzFirewallPolicyNatRule](New-AzFirewallPolicyNatRule.md) +Create a new Azure Firewall Policy NAT Rule + +### [New-AzFirewallPolicyNatRuleCollection](New-AzFirewallPolicyNatRuleCollection.md) +Create a new Azure Firewall Policy Nat Rule Collection + +### [New-AzFirewallPolicyNetworkRule](New-AzFirewallPolicyNetworkRule.md) +Create a new Azure Firewall Policy Network Rule + +### [New-AzFirewallPolicyRuleCollectionGroup](New-AzFirewallPolicyRuleCollectionGroup.md) +Create a new Azure Firewall Policy Rule Collection Group + +### [New-AzFirewallPolicySnat](New-AzFirewallPolicySnat.md) +Creates SNAT configuration of PrivateRange and AutoLearnPrivateRanges for the firewall policy + +### [New-AzFirewallPolicySqlSetting](New-AzFirewallPolicySqlSetting.md) +Creates a new SQL Setting for Azure Firewall Policy + +### [New-AzFirewallPolicyThreatIntelWhitelist](New-AzFirewallPolicyThreatIntelWhitelist.md) +Create a new threat intelligence whitelist for Azure Firewall Policy + +### [New-AzFirewallPublicIpAddress](New-AzFirewallPublicIpAddress.md) +This is the placeholder for the Ip Address that can be used for multi pip on azure firewall. + +### [New-AzFirewallThreatIntelWhitelist](New-AzFirewallThreatIntelWhitelist.md) +Create a new threat intelligence whitelist for Azure Firewall + +### [New-AzGatewayCustomBgpIpConfigurationObject](New-AzGatewayCustomBgpIpConfigurationObject.md) +creates a new GatewayCustomBgpIpConfigurationObject. + +### [New-AzIpAllocation](New-AzIpAllocation.md) +Creates an Azure IpAllocation. + +### [New-AzIpConfigurationBgpPeeringAddressObject](New-AzIpConfigurationBgpPeeringAddressObject.md) +creates a new IpconfigurationBgpPeeringAddressObject + +### [New-AzIpGroup](New-AzIpGroup.md) +Creates an Azure IpGroup. + +### [New-AzIpsecPolicy](New-AzIpsecPolicy.md) +Creates an IPSec Policy. + +### [New-AzIpsecTrafficSelectorPolicy](New-AzIpsecTrafficSelectorPolicy.md) +Creates a traffic selector policy. + +### [New-AzLoadBalancer](New-AzLoadBalancer.md) +Creates a load balancer. + +### [New-AzLoadBalancerBackendAddressConfig](New-AzLoadBalancerBackendAddressConfig.md) +Returns a load balancer backend address config. + +### [New-AzLoadBalancerBackendAddressPool](New-AzLoadBalancerBackendAddressPool.md) +Creates a backend address pool on a loadbalancer. + +### [New-AzLoadBalancerBackendAddressPoolConfig](New-AzLoadBalancerBackendAddressPoolConfig.md) +Creates a backend address pool configuration for a load balancer. + +### [New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig](New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig.md) +Creates a tunnel interface in a backend address pool of a load balancer. + +### [New-AzLoadBalancerFrontendIpConfig](New-AzLoadBalancerFrontendIpConfig.md) +Creates a front-end IP configuration for a load balancer. + +### [New-AzLoadBalancerInboundNatPoolConfig](New-AzLoadBalancerInboundNatPoolConfig.md) +Creates an inbound NAT pool configuration for a load balancer. + +### [New-AzLoadBalancerInboundNatRuleConfig](New-AzLoadBalancerInboundNatRuleConfig.md) +Creates an inbound NAT rule configuration for a load balancer. + +### [New-AzLoadBalancerOutboundRuleConfig](New-AzLoadBalancerOutboundRuleConfig.md) +Creates an outbound rule configuration for a load balancer. + +### [New-AzLoadBalancerProbeConfig](New-AzLoadBalancerProbeConfig.md) +Creates a probe configuration for a load balancer. + +### [New-AzLoadBalancerRuleConfig](New-AzLoadBalancerRuleConfig.md) +Creates a rule configuration for a load balancer. + +### [New-AzLocalNetworkGateway](New-AzLocalNetworkGateway.md) +Creates a Local Network Gateway + +### [New-AzNatGateway](New-AzNatGateway.md) +Create new Nat Gateway resource with properties Public Ip Address/Public Ip Prefix, IdleTimeoutInMinutes and Sku. + +### [New-AzNetworkInterface](New-AzNetworkInterface.md) +Creates a network interface. + +### [New-AzNetworkInterfaceIpConfig](New-AzNetworkInterfaceIpConfig.md) +Creates a network interface IP configuration. + +### [New-AzNetworkManager](New-AzNetworkManager.md) +Creates a network manager. + +### [New-AzNetworkManagerAddressPrefixItem](New-AzNetworkManagerAddressPrefixItem.md) +Creates a network manager address prefix item. + +### [New-AzNetworkManagerConnectivityConfiguration](New-AzNetworkManagerConnectivityConfiguration.md) +Creates a network manager connectivity configuration. + +### [New-AzNetworkManagerConnectivityGroupItem](New-AzNetworkManagerConnectivityGroupItem.md) +Creates a connectivity group item. + +### [New-AzNetworkManagerGroup](New-AzNetworkManagerGroup.md) +Creates a network manager group. + +### [New-AzNetworkManagerHub](New-AzNetworkManagerHub.md) +Creates a network manager hub. + +### [New-AzNetworkManagerManagementGroupConnection](New-AzNetworkManagerManagementGroupConnection.md) +Creates a network manager management group connection. + +### [New-AzNetworkManagerScope](New-AzNetworkManagerScope.md) +Creates a network manager scope. + +### [New-AzNetworkManagerScopeConnection](New-AzNetworkManagerScopeConnection.md) +Creates a scope connection. + +### [New-AzNetworkManagerSecurityAdminConfiguration](New-AzNetworkManagerSecurityAdminConfiguration.md) +Creates a security admin configuration. + +### [New-AzNetworkManagerSecurityAdminRule](New-AzNetworkManagerSecurityAdminRule.md) +Creates a security admin rule. + +### [New-AzNetworkManagerSecurityAdminRuleCollection](New-AzNetworkManagerSecurityAdminRuleCollection.md) +Creates a security admin rule collection. + +### [New-AzNetworkManagerSecurityGroupItem](New-AzNetworkManagerSecurityGroupItem.md) +Creates a security group item. + +### [New-AzNetworkManagerStaticMember](New-AzNetworkManagerStaticMember.md) +Creates a network manager static member. + +### [New-AzNetworkManagerSubscriptionConnection](New-AzNetworkManagerSubscriptionConnection.md) +Creates a network manager subscription connection. + +### [New-AzNetworkProfile](New-AzNetworkProfile.md) +Creates a new network profile. + +### [New-AzNetworkSecurityGroup](New-AzNetworkSecurityGroup.md) +Creates a network security group. + +### [New-AzNetworkSecurityRuleConfig](New-AzNetworkSecurityRuleConfig.md) +Creates a network security rule configuration. + +### [New-AzNetworkVirtualAppliance](New-AzNetworkVirtualAppliance.md) +Create a Network Virtual Appliance resource. + +### [New-AzNetworkWatcher](New-AzNetworkWatcher.md) +Creates a new Network Watcher resource. + +### [New-AzNetworkWatcherConnectionMonitor](New-AzNetworkWatcherConnectionMonitor.md) +Creates a connection monitor resource. + +### [New-AzNetworkWatcherConnectionMonitorEndpointObject](New-AzNetworkWatcherConnectionMonitorEndpointObject.md) +Creates connection monitor endpoint. + +### [New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject](New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject.md) +Creates a connection monitor endpoint scope item. + +### [New-AzNetworkWatcherConnectionMonitorObject](New-AzNetworkWatcherConnectionMonitorObject.md) +Create a connection monitor V2 object. + +### [New-AzNetworkWatcherConnectionMonitorOutputObject](New-AzNetworkWatcherConnectionMonitorOutputObject.md) +Create connection monitor output destination object. + +### [New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject](New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject.md) +Create protocol configuration used to perform test evaluation over TCP, HTTP or ICMP. + +### [New-AzNetworkWatcherConnectionMonitorTestConfigurationObject](New-AzNetworkWatcherConnectionMonitorTestConfigurationObject.md) +Create a connection monitor test configuration. + +### [New-AzNetworkWatcherConnectionMonitorTestGroupObject](New-AzNetworkWatcherConnectionMonitorTestGroupObject.md) +Create a connection monitor test group. + +### [New-AzNetworkWatcherFlowLog](New-AzNetworkWatcherFlowLog.md) +Create or update a flow log resource for the specified network security group. + +### [New-AzNetworkWatcherNetworkConfigurationDiagnosticProfile](New-AzNetworkWatcherNetworkConfigurationDiagnosticProfile.md) +Creates a new network configuration diagnostic profile object. +This object is used to restrict the network configuration during a diagnostic session using the specified criteria. + +### [New-AzNetworkWatcherPacketCapture](New-AzNetworkWatcherPacketCapture.md) +Creates a new packet capture resource and starts a packet capture session on a VM. + +### [New-AzNetworkWatcherPacketCaptureV2](New-AzNetworkWatcherPacketCaptureV2.md) +V2 Version of Packet Capture Cmdlet which creates a new packet capture resource and starts a packet capture session on a VM, VMSS or few instances of VMSS. + +### [New-AzNetworkWatcherProtocolConfiguration](New-AzNetworkWatcherProtocolConfiguration.md) +Creates a new protocol configuration object. + +### [New-AzO365PolicyProperty](New-AzO365PolicyProperty.md) +Create an office 365 traffic breakout policy object. + +### [New-AzOffice365PolicyProperty](New-AzOffice365PolicyProperty.md) +Define a new Office 365 traffic breakout policy to be used with a Virtual Appliance site. + +### [New-AzP2sVpnGateway](New-AzP2sVpnGateway.md) +Create a new P2SVpnGateway under VirtualHub for point to site connectivity. + +### [New-AzPacketCaptureFilterConfig](New-AzPacketCaptureFilterConfig.md) +Creates a new packet capture filter object. + +### [New-AzPacketCaptureScopeConfig](New-AzPacketCaptureScopeConfig.md) +Creates a new packet capture scope object. + +### [New-AzPrivateDnsZoneConfig](New-AzPrivateDnsZoneConfig.md) +Creates DNS zone configuration of the private dns zone group. + +### [New-AzPrivateDnsZoneGroup](New-AzPrivateDnsZoneGroup.md) +Creates a private DNS zone group in the specified private endpoint. + +### [New-AzPrivateEndpoint](New-AzPrivateEndpoint.md) +Creates a private endpoint. + +### [New-AzPrivateEndpointIpConfiguration](New-AzPrivateEndpointIpConfiguration.md) +Creates an IpConfiguration object for private endpoint. + +### [New-AzPrivateLinkService](New-AzPrivateLinkService.md) +Creates a private link service + +### [New-AzPrivateLinkServiceConnection](New-AzPrivateLinkServiceConnection.md) +Creates a private link service connection configuration. + +### [New-AzPrivateLinkServiceIpConfig](New-AzPrivateLinkServiceIpConfig.md) +Create a private link service ip configuration. + +### [New-AzPublicIpAddress](New-AzPublicIpAddress.md) +Creates a public IP address. + +### [New-AzPublicIpPrefix](New-AzPublicIpPrefix.md) +Creates a Public IP Prefix + +### [New-AzPublicIpTag](New-AzPublicIpTag.md) +Creates an IP Tag. + +### [New-AzRadiusServer](New-AzRadiusServer.md) +Creates an external radius server configuration + +### [New-AzRouteConfig](New-AzRouteConfig.md) +Creates a route for a route table. + +### [New-AzRouteFilter](New-AzRouteFilter.md) +Creates a route filter. + +### [New-AzRouteFilterRuleConfig](New-AzRouteFilterRuleConfig.md) +Creates a route filter rule for a route filter. + +### [New-AzRouteMap](New-AzRouteMap.md) +Create a route map to a VirtualHub. + +### [New-AzRouteMapRule](New-AzRouteMapRule.md) +Create a route map rule. + +### [New-AzRouteMapRuleAction](New-AzRouteMapRuleAction.md) +Create a route map rule action. + +### [New-AzRouteMapRuleActionParameter](New-AzRouteMapRuleActionParameter.md) +Create a route map rule action parameter for the rule action. + +### [New-AzRouteMapRuleCriterion](New-AzRouteMapRuleCriterion.md) +Create a route map rule criterion. + +### [New-AzRouteServer](New-AzRouteServer.md) +Creates an Azure RouteServer. + +### [New-AzRouteTable](New-AzRouteTable.md) +Creates a route table. + +### [New-AzRoutingConfiguration](New-AzRoutingConfiguration.md) +Creates a RoutingConfiguration object. + +### [New-AzRoutingIntent](New-AzRoutingIntent.md) +Creates a routing intent resource associated with a VirtualHub. + +### [New-AzRoutingPolicy](New-AzRoutingPolicy.md) +Returns an in-memory routing policy object. + +### [New-AzSecurityPartnerProvider](New-AzSecurityPartnerProvider.md) +Creates an Azure SecurityPartnerProvider. + +### [New-AzServiceEndpointPolicy](New-AzServiceEndpointPolicy.md) +Creates a service endpoint policy. + +### [New-AzServiceEndpointPolicyDefinition](New-AzServiceEndpointPolicyDefinition.md) +Creates a service endpoint policy definition. + +### [New-AzStaticRoute](New-AzStaticRoute.md) +Creates a StaticRoute object which can then be added to a RoutingConfiguration object. + +### [New-AzVHubRoute](New-AzVHubRoute.md) +Creates a VHubRoute object which can be passed as parameter to the New-AzVHubRouteTable command. + +### [New-AzVHubRouteTable](New-AzVHubRouteTable.md) +Creates a hub route table resource associated with a VirtualHub. + +### [New-AzVirtualApplianceAdditionalNicProperty](New-AzVirtualApplianceAdditionalNicProperty.md) +Define a Network Virtual Appliance Additional Nic Property for the resource. + +### [New-AzVirtualApplianceSite](New-AzVirtualApplianceSite.md) +Create a site connected to a Network Virtual Appliance. + +### [New-AzVirtualApplianceSkuProperty](New-AzVirtualApplianceSkuProperty.md) +Define a Network Virtual Appliance sku for the resource. + +### [New-AzVirtualHub](New-AzVirtualHub.md) +Creates an Azure VirtualHub resource. + +### [New-AzVirtualHubBgpConnection](New-AzVirtualHubBgpConnection.md) +The New-AzVirtualHubBgpConnection cmdlet creates a HubBgpConnection resource that peers the Azure Virtual WAN Hub Router with a BGP-enabled peer in a virtual network connected to the Virtual WAN Hub. + +### [New-AzVirtualHubRoute](New-AzVirtualHubRoute.md) +Creates an Azure Virtual Hub Route object. + +### [New-AzVirtualHubRouteTable](New-AzVirtualHubRouteTable.md) +Creates an Azure Virtual Hub Route Table object. + +### [New-AzVirtualHubVnetConnection](New-AzVirtualHubVnetConnection.md) +The New-AzVirtualHubVnetConnection cmdlet creates a HubVirtualNetworkConnection resource that peers a Virtual Network to the Azure Virtual Hub. + +### [New-AzVirtualNetwork](New-AzVirtualNetwork.md) +Creates a virtual network. + +### [New-AzVirtualNetworkGateway](New-AzVirtualNetworkGateway.md) +Creates a Virtual Network Gateway + +### [New-AzVirtualNetworkGatewayConnection](New-AzVirtualNetworkGatewayConnection.md) +Creates the Site-to-Site VPN connection between the virtual network gateway and the on-prem VPN device. + +### [New-AzVirtualNetworkGatewayIpConfig](New-AzVirtualNetworkGatewayIpConfig.md) +Creates an IP Configuration for a Virtual Network Gateway + +### [New-AzVirtualNetworkGatewayNatRule](New-AzVirtualNetworkGatewayNatRule.md) +Creates the virtual network gateway natRule object. + +### [New-AzVirtualNetworkGatewayPolicyGroup](New-AzVirtualNetworkGatewayPolicyGroup.md) +Create a Virtual Network Gateway Policy Group + +### [New-AzVirtualNetworkGatewayPolicyGroupMember](New-AzVirtualNetworkGatewayPolicyGroupMember.md) +Create a Virtual Network Gateway Policy Group Member + +### [New-AzVirtualNetworkSubnetConfig](New-AzVirtualNetworkSubnetConfig.md) +Creates a virtual network subnet configuration. + +### [New-AzVirtualNetworkTap](New-AzVirtualNetworkTap.md) +Creates a VirtualNetworkTap resource. + +### [New-AzVirtualRouter](New-AzVirtualRouter.md) +Creates an Azure VirtualRouter. + +### [New-AzVirtualRouterAutoScaleConfiguration](New-AzVirtualRouterAutoScaleConfiguration.md) +Create a VirtualRouterAutoScaleConfiguration object for a Virtual Hub. + +### [New-AzVirtualWan](New-AzVirtualWan.md) +Creates an Azure Virtual WAN. + +### [New-AzVpnClientConfiguration](New-AzVpnClientConfiguration.md) +This command allows the users to create the Vpn profile package based on pre-configured vpn settings on the VPN gateway, in addition to some additional settings that users may need to configure, for e.g. some root certificates. + +### [New-AzVpnClientConnectionConfiguration](New-AzVpnClientConnectionConfiguration.md) +Create Virtual Network Gateway Connection configuration + +### [New-AzVpnClientIpsecParameter](New-AzVpnClientIpsecParameter.md) +This command allows the users to create the Vpn ipsec parameters object specifying one or all values such as IpsecEncryption,IpsecIntegrity,IkeEncryption,IkeIntegrity,DhGroup,PfsGroup to set on the existing VPN gateway. + +### [New-AzVpnClientIpsecPolicy](New-AzVpnClientIpsecPolicy.md) +This command allows the users to create the Vpn ipsec policy object specifying one or all values such as IpsecEncryption,IpsecIntegrity,IkeEncryption,IkeIntegrity,DhGroup,PfsGroup to set on the VPN gateway. This command let output object is used to set vpn ipsec policy for both new / existing gateway. + +### [New-AzVpnClientRevokedCertificate](New-AzVpnClientRevokedCertificate.md) +Creates a new VPN client-revocation certificate. + +### [New-AzVpnClientRootCertificate](New-AzVpnClientRootCertificate.md) +Creates a new VPN client root certificate. + +### [New-AzVpnConnection](New-AzVpnConnection.md) +Creates a IPSec connection that connects a VpnGateway to a remote customer branch represented in RM as a VpnSite. + +### [New-AzVpnGateway](New-AzVpnGateway.md) +Creates a Scalable VPN Gateway. + +### [New-AzVpnGatewayNatRule](New-AzVpnGatewayNatRule.md) +Creates a NAT rule on a VpnGateway which can be associated with VpnSiteLinkConnection. + +### [New-AzVpnServerConfiguration](New-AzVpnServerConfiguration.md) +Create a new VpnServerConfiguration for point to site connectivity. + +### [New-AzP2sVpnGateway](New-AzP2sVpnGateway.md) +Create a new P2SVpnGateway under VirtualHub for point to site connectivity. + +### [New-AzVpnSite](New-AzVpnSite.md) +Creates a new Azure VpnSite resource. This is an RM representation of customer branches that are uploaded to Azure +for S2S connectivity with a Cortex virtual hub. + +### [New-AzVpnSiteLink](New-AzVpnSiteLink.md) +Creates an Azure VpnSiteLink object. + +### [New-AzVpnSiteLinkConnection](New-AzVpnSiteLinkConnection.md) +Creates an Azure VpnSiteLinkConnection object. + +### [Remove-AzApplicationGateway](Remove-AzApplicationGateway.md) +Removes an application gateway. + +### [Remove-AzApplicationGatewayAuthenticationCertificate](Remove-AzApplicationGatewayAuthenticationCertificate.md) +Removes an authentication certificate from an application gateway. + +### [Remove-AzApplicationGatewayAutoscaleConfiguration](Remove-AzApplicationGatewayAutoscaleConfiguration.md) +Removes Autoscale Configuration from an application gateway. + +### [Remove-AzApplicationGatewayBackendAddressPool](Remove-AzApplicationGatewayBackendAddressPool.md) +Removes a back-end address pool from an application gateway. + +### [Remove-AzApplicationGatewayBackendHttpSetting](Remove-AzApplicationGatewayBackendHttpSetting.md) +Removes back-end HTTP settings from an application gateway. + +### [Remove-AzApplicationGatewayBackendSetting](Remove-AzApplicationGatewayBackendSetting.md) +Removes back-end TCP\TLS settings from an application gateway. + +### [Remove-AzApplicationGatewayClientAuthConfiguration](Remove-AzApplicationGatewayClientAuthConfiguration.md) +Removes the client authentication configuration of a SSL profile object. + +### [Remove-AzApplicationGatewayConnectionDraining](Remove-AzApplicationGatewayConnectionDraining.md) +Removes the connection draining configuration of a back-end HTTP settings object. + +### [Remove-AzApplicationGatewayCustomError](Remove-AzApplicationGatewayCustomError.md) +Removes a custom error from an application gateway. + +### [Remove-AzApplicationGatewayFirewallPolicy](Remove-AzApplicationGatewayFirewallPolicy.md) +Removes an application gateway firewall policy. + +### [Remove-AzApplicationGatewayFrontendIPConfig](Remove-AzApplicationGatewayFrontendIPConfig.md) +Removes a front-end IP configuration from an application gateway. + +### [Remove-AzApplicationGatewayFrontendPort](Remove-AzApplicationGatewayFrontendPort.md) +Removes a front-end port from an application gateway. + +### [Remove-AzApplicationGatewayHttpListener](Remove-AzApplicationGatewayHttpListener.md) +Removes an HTTP listener from an application gateway. + +### [Remove-AzApplicationGatewayHttpListenerCustomError](Remove-AzApplicationGatewayHttpListenerCustomError.md) +Removes a custom error from a http listener of an application gateway. + +### [Remove-AzApplicationGatewayIdentity](Remove-AzApplicationGatewayIdentity.md) +Removes a identity from an application gateway. + +### [Remove-AzApplicationGatewayIPConfiguration](Remove-AzApplicationGatewayIPConfiguration.md) +Removes an IP configuration from an application gateway. + +### [Remove-AzApplicationGatewayListener](Remove-AzApplicationGatewayListener.md) +Removes a TCP\TLS listener from an application gateway. + +### [Remove-AzApplicationGatewayPrivateLinkConfiguration](Remove-AzApplicationGatewayPrivateLinkConfiguration.md) +Removes a privateLink configuration from an application gateway. + +### [Remove-AzApplicationGatewayProbeConfig](Remove-AzApplicationGatewayProbeConfig.md) +Removes a health probe from an existing application gateway. + +### [Remove-AzApplicationGatewayRedirectConfiguration](Remove-AzApplicationGatewayRedirectConfiguration.md) +Removes a redirect configuration from an existing Application Gateway. + +### [Remove-AzApplicationGatewayRequestRoutingRule](Remove-AzApplicationGatewayRequestRoutingRule.md) +Removes a request routing rule from an application gateway. + +### [Remove-AzApplicationGatewayRewriteRuleSet](Remove-AzApplicationGatewayRewriteRuleSet.md) +Removes a rewrite rule set from an application gateway. + +### [Remove-AzApplicationGatewayRoutingRule](Remove-AzApplicationGatewayRoutingRule.md) +Removes a routing rule from an application gateway. + +### [Remove-AzApplicationGatewaySslCertificate](Remove-AzApplicationGatewaySslCertificate.md) +Removes an SSL certificate from an Azure application gateway. + +### [Remove-AzApplicationGatewaySslPolicy](Remove-AzApplicationGatewaySslPolicy.md) +Removes an SSL policy from an Azure application gateway. + +### [Remove-AzApplicationGatewaySslProfile](Remove-AzApplicationGatewaySslProfile.md) +Removes the ssl profile from an application gateway. + +### [Remove-AzApplicationGatewaySslProfilePolicy](Remove-AzApplicationGatewaySslProfilePolicy.md) +Removes an SSL policy from an Azure application gateway SSL profile. + +### [Remove-AzApplicationGatewayTrustedClientCertificate](Remove-AzApplicationGatewayTrustedClientCertificate.md) +Removes the trusted client CA certificate chain object from an application gateway. + +### [Remove-AzApplicationGatewayTrustedRootCertificate](Remove-AzApplicationGatewayTrustedRootCertificate.md) +Removes a Trusted Root Certificate from an application gateway. + +### [Remove-AzApplicationGatewayUrlPathMapConfig](Remove-AzApplicationGatewayUrlPathMapConfig.md) +Removes URL path mappings to a backend server pool. + +### [Remove-AzApplicationSecurityGroup](Remove-AzApplicationSecurityGroup.md) +Removes an application security group. + +### [Remove-AzBastion](Remove-AzBastion.md) +Removes a bastion resource. + +### [Remove-AzCustomIpPrefix](Remove-AzCustomIpPrefix.md) +Removes a CustomIpPrefix + +### [Remove-AzDdosProtectionPlan](Remove-AzDdosProtectionPlan.md) +Removes a DDoS protection plan. + +### [Remove-AzDelegation](Remove-AzDelegation.md) +Removes a service delegation from the provided subnet. + +### [Remove-AzExpressRouteCircuit](Remove-AzExpressRouteCircuit.md) +Removes an ExpressRoute circuit. + +### [Remove-AzExpressRouteCircuitAuthorization](Remove-AzExpressRouteCircuitAuthorization.md) +Removes an existing ExpressRoute configuration authorization. + +### [Remove-AzExpressRouteCircuitConnectionConfig](Remove-AzExpressRouteCircuitConnectionConfig.md) +Removes an ExpressRoute circuit connection configuration. + +### [Remove-AzExpressRouteCircuitPeeringConfig](Remove-AzExpressRouteCircuitPeeringConfig.md) +Removes an ExpressRoute circuit peering configuration. + +### [Remove-AzExpressRouteConnection](Remove-AzExpressRouteConnection.md) +Removes a ExpressRouteConnection. + +### [Remove-AzExpressRouteCrossConnectionPeering](Remove-AzExpressRouteCrossConnectionPeering.md) +Removes an ExpressRoute cross connection peering configuration. + +### [Remove-AzExpressRouteGateway](Remove-AzExpressRouteGateway.md) +The Remove-AzExpressRouteGateway cmdlet removes an Azure ExpressRoute gateway. This is a gateway specific to Azure Virtual WAN's software defined connectivity. + +### [Remove-AzExpressRoutePort](Remove-AzExpressRoutePort.md) +Removes an ExpressRoutePort. + +### [Remove-AzExpressRoutePortAuthorization](Remove-AzExpressRoutePortAuthorization.md) +Removes an existing ExpressRoutePort authorization. + +### [Remove-AzExpressRoutePortIdentity](Remove-AzExpressRoutePortIdentity.md) +Removes a identity from an ExpressRoutePort. + +### [Remove-AzFirewall](Remove-AzFirewall.md) +Remove a Firewall. + +### [Remove-AzFirewallPolicy](Remove-AzFirewallPolicy.md) +Removes an Azure Firewall Policy + +### [Remove-AzFirewallPolicyRuleCollectionGroup](Remove-AzFirewallPolicyRuleCollectionGroup.md) +Removes a Azure Firewall Policy Rule Collection Group in a Azure firewall policy + +### [Remove-AzIpAllocation](Remove-AzIpAllocation.md) +Deletes an Azure IpAllocation. + +### [Remove-AzIpGroup](Remove-AzIpGroup.md) +Deletes an Azure IpGroup. + +### [Remove-AzLoadBalancer](Remove-AzLoadBalancer.md) +Removes a load balancer. + +### [Remove-AzLoadBalancerBackendAddressPool](Remove-AzLoadBalancerBackendAddressPool.md) +Removes a backend pool from a load balancer + +### [Remove-AzLoadBalancerBackendAddressPoolConfig](Remove-AzLoadBalancerBackendAddressPoolConfig.md) +Removes a backend address pool configuration from a load balancer. + +### [Remove-AzLoadBalancerFrontendIpConfig](Remove-AzLoadBalancerFrontendIpConfig.md) +Removes a front-end IP configuration from a load balancer. + +### [Remove-AzLoadBalancerInboundNatPoolConfig](Remove-AzLoadBalancerInboundNatPoolConfig.md) +Removes an inbound NAT pool configuration from a load balancer. + +### [Remove-AzLoadBalancerInboundNatRuleConfig](Remove-AzLoadBalancerInboundNatRuleConfig.md) +Removes an inbound NAT rule configuration from a load balancer. + +### [Remove-AzLoadBalancerOutboundRuleConfig](Remove-AzLoadBalancerOutboundRuleConfig.md) +Removes an outbound rule configuration from a load balancer. + +### [Remove-AzLoadBalancerProbeConfig](Remove-AzLoadBalancerProbeConfig.md) +Removes a probe configuration from a load balancer. + +### [Remove-AzLoadBalancerRuleConfig](Remove-AzLoadBalancerRuleConfig.md) +Removes a rule configuration for a load balancer. + +### [Remove-AzLocalNetworkGateway](Remove-AzLocalNetworkGateway.md) +Deletes a Local Network Gateway + +### [Remove-AzNatGateway](Remove-AzNatGateway.md) +Remove Nat Gateway resource. + +### [Remove-AzNetworkInterface](Remove-AzNetworkInterface.md) +Removes a network interface. + +### [Remove-AzNetworkInterfaceIpConfig](Remove-AzNetworkInterfaceIpConfig.md) +Removes a network interface IP configuration from a network interface. + +### [Remove-AzNetworkInterfaceTapConfig](Remove-AzNetworkInterfaceTapConfig.md) +Removes a tap configuration from given network interface + +### [Remove-AzNetworkManager](Remove-AzNetworkManager.md) +Removes a network manager. + +### [Remove-AzNetworkManagerConnectivityConfiguration](Remove-AzNetworkManagerConnectivityConfiguration.md) +Removes a connectivity configuration. + +### [Remove-AzNetworkManagerGroup](Remove-AzNetworkManagerGroup.md) +Removes a network Group. + +### [Remove-AzNetworkManagerManagementGroupConnection](Remove-AzNetworkManagerManagementGroupConnection.md) +Removes a network manager management group connection. + +### [Remove-AzNetworkManagerScopeConnection](Remove-AzNetworkManagerScopeConnection.md) +Removes a network manager scope connection. + +### [Remove-AzNetworkManagerSecurityAdminConfiguration](Remove-AzNetworkManagerSecurityAdminConfiguration.md) +Removes a security admin configuration. + +### [Remove-AzNetworkManagerSecurityAdminRule](Remove-AzNetworkManagerSecurityAdminRule.md) +Removes a security admin rule. + +### [Remove-AzNetworkManagerSecurityAdminRuleCollection](Remove-AzNetworkManagerSecurityAdminRuleCollection.md) +Removes a security admin rule collection. + +### [Remove-AzNetworkManagerStaticMember](Remove-AzNetworkManagerStaticMember.md) +Removes a network manager static member. + +### [Remove-AzNetworkManagerSubscriptionConnection](Remove-AzNetworkManagerSubscriptionConnection.md) +Remove a network manager subscription connection. + +### [Remove-AzNetworkProfile](Remove-AzNetworkProfile.md) +Removes a network profile. + +### [Remove-AzNetworkSecurityGroup](Remove-AzNetworkSecurityGroup.md) +Removes a network security group. + +### [Remove-AzNetworkSecurityRuleConfig](Remove-AzNetworkSecurityRuleConfig.md) +Removes a network security rule from a network security group. + +### [Remove-AzNetworkVirtualAppliance](Remove-AzNetworkVirtualAppliance.md) +Remove a Network Virtual Appliance resource. + +### [Remove-AzNetworkWatcher](Remove-AzNetworkWatcher.md) +Removes a Network Watcher. + +### [Remove-AzNetworkWatcherConnectionMonitor](Remove-AzNetworkWatcherConnectionMonitor.md) +Remove connection monitor. + +### [Remove-AzNetworkWatcherFlowLog](Remove-AzNetworkWatcherFlowLog.md) +Deletes the specified flow log resource. + +### [Remove-AzNetworkWatcherPacketCapture](Remove-AzNetworkWatcherPacketCapture.md) +Removes a packet capture resource. + +### [Remove-AzP2sVpnGateway](Remove-AzP2sVpnGateway.md) +Removes an existing P2SVpnGateway. + +### [Remove-AzPrivateDnsZoneGroup](Remove-AzPrivateDnsZoneGroup.md) +Removes a DNS zone group. + +### [Remove-AzPrivateEndpoint](Remove-AzPrivateEndpoint.md) +Removes a private endpoint. + +### [Remove-AzPrivateEndpointConnection](Remove-AzPrivateEndpointConnection.md) +Removes a private endpoint connection. + +### [Remove-AzPrivateLinkService](Remove-AzPrivateLinkService.md) +Removes a private link service + +### [Remove-AzPublicIpAddress](Remove-AzPublicIpAddress.md) +Removes a public IP address. + +### [Remove-AzPublicIpPrefix](Remove-AzPublicIpPrefix.md) +Removes a public IP prefix + +### [Remove-AzRouteConfig](Remove-AzRouteConfig.md) +Removes a route from a route table. + +### [Remove-AzRouteFilter](Remove-AzRouteFilter.md) +Removes a route filter. + +### [Remove-AzRouteFilterRuleConfig](Remove-AzRouteFilterRuleConfig.md) +Removes a route filter rule from a route filter. + +### [Remove-AzRouteMap](Remove-AzRouteMap.md) +Remove a route map from a VirtualHub. + +### [Remove-AzRouteServer](Remove-AzRouteServer.md) +Deletes an Azure RouteServer. + +### [Remove-AzRouteServerPeer](Remove-AzRouteServerPeer.md) +Removes a Peer from an Azure RouteServer + +### [Remove-AzRouteTable](Remove-AzRouteTable.md) +Removes a route table. + +### [Remove-AzRoutingIntent](Remove-AzRoutingIntent.md) +Delete a routing intent resource associated with a VirtualHub. + +### [Remove-AzRoutingPolicy](Remove-AzRoutingPolicy.md) +Removes the specified routing policy from a routing intent resource associated with a VirtualHub. + +### [Remove-AzSecurityPartnerProvider](Remove-AzSecurityPartnerProvider.md) +Deletes an Azure SecurityPartnerProvider. + +### [Remove-AzServiceEndpointPolicy](Remove-AzServiceEndpointPolicy.md) +Removes a service endpoint policy. + +### [Remove-AzServiceEndpointPolicyDefinition](Remove-AzServiceEndpointPolicyDefinition.md) +Removes a service endpoint policy definition. + +### [Remove-AzVHubRouteTable](Remove-AzVHubRouteTable.md) +Delete a hub route table resource associated with a VirtualHub. + +### [Remove-AzVirtualApplianceSite](Remove-AzVirtualApplianceSite.md) +Remove a virtual appliance site from a Network Virtual Appliance resource. + +### [Remove-AzVirtualHub](Remove-AzVirtualHub.md) +Removes an Azure VirtualHub resource. + +### [Remove-AzVirtualHubBgpConnection](Remove-AzVirtualHubBgpConnection.md) +The Remove-AzVirtualHubBgpConnection cmdlet removes a HubBgpConnection resource that peers the Azure Virtual WAN Hub Router with a BGP-enabled peer in a virtual network connected to the Virtual WAN Hub. + +### [Remove-AzVirtualHubRouteTable](Remove-AzVirtualHubRouteTable.md) +Delete a virtual hub route table resource associated with a virtual hub. + +### [Remove-AzVirtualHubVnetConnection](Remove-AzVirtualHubVnetConnection.md) +The Remove-AzVirtualHubVnetConnection cmdlet removes an Azure Virtual Network Connection which peers a remote VNET to the hub VNET. + +### [Remove-AzVirtualNetwork](Remove-AzVirtualNetwork.md) +Removes a virtual network. + +### [Remove-AzVirtualNetworkGateway](Remove-AzVirtualNetworkGateway.md) +Deletes a Virtual Network Gateway + +### [Remove-AzVirtualNetworkGatewayConnection](Remove-AzVirtualNetworkGatewayConnection.md) +Deletes a Virtual Network Gateway Connection + +### [Remove-AzVirtualNetworkGatewayDefaultSite](Remove-AzVirtualNetworkGatewayDefaultSite.md) +Removes the default site from a virtual network gateway. + +### [Remove-AzVirtualNetworkGatewayIpConfig](Remove-AzVirtualNetworkGatewayIpConfig.md) +Removes an IP Configuration from a Virtual Network Gateway + +### [Remove-AzVirtualNetworkGatewayNatRule](Remove-AzVirtualNetworkGatewayNatRule.md) +Removes or Delete a Virtual Network Gateway NatRule. + +### [Remove-AzVirtualNetworkPeering](Remove-AzVirtualNetworkPeering.md) +Removes a virtual network peering. + +### [Remove-AzVirtualNetworkSubnetConfig](Remove-AzVirtualNetworkSubnetConfig.md) +Removes a subnet configuration from a virtual network. + +### [Remove-AzVirtualNetworkTap](Remove-AzVirtualNetworkTap.md) +Removes a virtual network tap. + +### [Remove-AzVirtualRouter](Remove-AzVirtualRouter.md) +Deletes an Azure VirtualRouter. + +### [Remove-AzVirtualRouterPeer](Remove-AzVirtualRouterPeer.md) +Removes a Peer from an Azure VirtualRouter + +### [Remove-AzVirtualWan](Remove-AzVirtualWan.md) +Removes an Azure Virtual WAN. + +### [Remove-AzVpnClientIpsecParameter](Remove-AzVpnClientIpsecParameter.md) +Removes Vpn custom ipsec policy set on Virtual Network Gateway resource. + +### [Remove-AzVpnClientRevokedCertificate](Remove-AzVpnClientRevokedCertificate.md) +Removes a VPN client-revocation certificate. + +### [Remove-AzVpnClientRootCertificate](Remove-AzVpnClientRootCertificate.md) +Removes an existing VPN client root certificate. + +### [Remove-AzVpnConnection](Remove-AzVpnConnection.md) +Removes a VpnConnection. + +### [Remove-AzVpnGateway](Remove-AzVpnGateway.md) +The Remove-AzVpnGateway cmdlet removes an Azure VPN gateway. This is a gateway specific to Azure Virtual WAN's software defined connectivity. + +### [Remove-AzVpnGatewayNatRule](Remove-AzVpnGatewayNatRule.md) +Removes a NAT rule associated with VpnGateway. + +### [Remove-AzVpnServerConfiguration](Remove-AzVpnServerConfiguration.md) +Removes an existing VpnServerConfiguration. + +### [New-AzP2sVpnGateway](New-AzP2sVpnGateway.md) +Create a new P2SVpnGateway under VirtualHub for point to site connectivity. + +### [Remove-AzVpnSite](Remove-AzVpnSite.md) +Removes an Azure VpnSite resource. + +### [Reset-AzHubRouter](Reset-AzHubRouter.md) +Resets the RoutingState of a VirtualHub resource. + +### [Reset-AzP2sVpnGateway](Reset-AzP2sVpnGateway.md) +Resets the scalable P2S VPN gateway. + +### [Reset-AzVirtualNetworkGateway](Reset-AzVirtualNetworkGateway.md) +Resets the Virtual Network Gateway + +### [Reset-AzVirtualNetworkGatewayConnection](Reset-AzVirtualNetworkGatewayConnection.md) +Reset a Virtual Network Gateway Connection + +### [Reset-AzVirtualNetworkGatewayConnectionSharedKey](Reset-AzVirtualNetworkGatewayConnectionSharedKey.md) +Resets the shared key of the virtual network gateway connection. + +### [Reset-AzVpnGateway](Reset-AzVpnGateway.md) +Resets the scalable VPN gateway. + +### [Reset-AzVpnSiteLinkConnection](Reset-AzVpnSiteLinkConnection.md) +Reset a VPN Site Link Connection + +### [Resize-AzVirtualNetworkGateway](Resize-AzVirtualNetworkGateway.md) +Resizes an existing virtual network gateway. + +### [Set-AzApplicationGateway](Set-AzApplicationGateway.md) +Updates an application gateway. + +### [Set-AzApplicationGatewayAuthenticationCertificate](Set-AzApplicationGatewayAuthenticationCertificate.md) +Updates an authentication certificate for an application gateway. + +### [Set-AzApplicationGatewayAutoscaleConfiguration](Set-AzApplicationGatewayAutoscaleConfiguration.md) +Updates Autoscale Configuration of an application gateway. + +### [Set-AzApplicationGatewayBackendAddressPool](Set-AzApplicationGatewayBackendAddressPool.md) +Updates a back-end address pool for an application gateway. + +### [Set-AzApplicationGatewayBackendHttpSetting](Set-AzApplicationGatewayBackendHttpSetting.md) +Updates back-end HTTP settings for an application gateway. + +### [Set-AzApplicationGatewayBackendSetting](Set-AzApplicationGatewayBackendSetting.md) +Updates back-end TCP\TLS settings for an application gateway. + +### [Set-AzApplicationGatewayClientAuthConfiguration](Set-AzApplicationGatewayClientAuthConfiguration.md) +Modifies the client auth configuration of a ssl profile object. + +### [Set-AzApplicationGatewayConnectionDraining](Set-AzApplicationGatewayConnectionDraining.md) +Modifies the connection draining configuration of a back-end HTTP settings object. + +### [Set-AzApplicationGatewayCustomError](Set-AzApplicationGatewayCustomError.md) +Updates a custom error in an application gateway. + +### [Set-AzApplicationGatewayFirewallPolicy](Set-AzApplicationGatewayFirewallPolicy.md) +Updates an application gateway firewall policy. + +### [Set-AzApplicationGatewayFrontendIPConfig](Set-AzApplicationGatewayFrontendIPConfig.md) +Modifies a front-end IP address configuration. + +### [Set-AzApplicationGatewayFrontendPort](Set-AzApplicationGatewayFrontendPort.md) +Modifies a front-end port for an application gateway. + +### [Set-AzApplicationGatewayHttpListener](Set-AzApplicationGatewayHttpListener.md) +Modifies an HTTP listener for an application gateway. + +### [Set-AzApplicationGatewayHttpListenerCustomError](Set-AzApplicationGatewayHttpListenerCustomError.md) +Updates a custom error in a http listener of an application gateway. + +### [Set-AzApplicationGatewayIdentity](Set-AzApplicationGatewayIdentity.md) +Updates a identity assigned to the application gateway. + +### [Set-AzApplicationGatewayIPConfiguration](Set-AzApplicationGatewayIPConfiguration.md) +Modifies an IP configuration for an application gateway. + +### [Set-AzApplicationGatewayListener](Set-AzApplicationGatewayListener.md) +Modifies a TCP\TLS listener for an application gateway. + +### [Set-AzApplicationGatewayPrivateLinkConfiguration](Set-AzApplicationGatewayPrivateLinkConfiguration.md) +Modifies an PrivateLink Configuration for an application gateway. + +### [Set-AzApplicationGatewayProbeConfig](Set-AzApplicationGatewayProbeConfig.md) +Sets the health probe configuration on an existing Application Gateway. + +### [Set-AzApplicationGatewayRedirectConfiguration](Set-AzApplicationGatewayRedirectConfiguration.md) +Sets the redirect configuration on an existing Application Gateway. + +### [Set-AzApplicationGatewayRequestRoutingRule](Set-AzApplicationGatewayRequestRoutingRule.md) +Modifies a request routing rule for an application gateway. + +### [Set-AzApplicationGatewayRewriteRuleSet](Set-AzApplicationGatewayRewriteRuleSet.md) +Modifies a rewrite rule set for an application gateway. + +### [Set-AzApplicationGatewayRoutingRule](Set-AzApplicationGatewayRoutingRule.md) +Modifies a routing rule for an application gateway. + +### [Set-AzApplicationGatewaySku](Set-AzApplicationGatewaySku.md) +Modifies the SKU of an application gateway. + +### [Set-AzApplicationGatewaySslCertificate](Set-AzApplicationGatewaySslCertificate.md) +Updates an SSL certificate for an application gateway. + +### [Set-AzApplicationGatewaySslPolicy](Set-AzApplicationGatewaySslPolicy.md) +Modifies the SSL policy of an application gateway. + +### [Set-AzApplicationGatewaySslProfile](Set-AzApplicationGatewaySslProfile.md) +Updates ssl profile for an application gateway. + +### [Set-AzApplicationGatewaySslProfilePolicy](Set-AzApplicationGatewaySslProfilePolicy.md) +Modifies the SSL policy of an application gateway SSL profile. + +### [Set-AzApplicationGatewayTrustedClientCertificate](Set-AzApplicationGatewayTrustedClientCertificate.md) +Modifies the trusted client CA certificate chain of an application gateway. + +### [Set-AzApplicationGatewayTrustedRootCertificate](Set-AzApplicationGatewayTrustedRootCertificate.md) +Updates a Trusted Root Certificate of an application gateway. + +### [Set-AzApplicationGatewayUrlPathMapConfig](Set-AzApplicationGatewayUrlPathMapConfig.md) +Sets configuration for an array of URL path mappings to a backend server pool. + +### [Set-AzApplicationGatewayWebApplicationFirewallConfiguration](Set-AzApplicationGatewayWebApplicationFirewallConfiguration.md) +Modifies the WAF configuration of an application gateway. + +### [Set-AzBastion](Set-AzBastion.md) +Updates the Bastion Resource. + +### [Set-AzExpressRouteCircuit](Set-AzExpressRouteCircuit.md) +Modifies an ExpressRoute circuit. + +### [Set-AzExpressRouteCircuitConnectionConfig](Set-AzExpressRouteCircuitConnectionConfig.md) +Updates a circuit connection configuration created in Private Peerings for an Express Route Circuit. + +### [Set-AzExpressRouteCircuitPeeringConfig](Set-AzExpressRouteCircuitPeeringConfig.md) +Saves a modified ExpressRoute peering configuration. + +### [Set-AzExpressRouteConnection](Set-AzExpressRouteConnection.md) +Updates an express route connection created between an express route gateway and on-premise express route circuit peering. + +### [Set-AzExpressRouteCrossConnection](Set-AzExpressRouteCrossConnection.md) +Modifies an ExpressRoute cross connection. + +### [Set-AzExpressRouteGateway](Set-AzExpressRouteGateway.md) +Updates a Scalable ExpressRoute Gateway. + +### [Set-AzExpressRoutePort](Set-AzExpressRoutePort.md) +Modifies an ExpressRoutePort. + +### [Set-AzExpressRoutePortIdentity](Set-AzExpressRoutePortIdentity.md) +Updates a identity assigned to an ExpressRoutePort. + +### [Set-AzFirewall](Set-AzFirewall.md) +Saves a modified Firewall. + +### [Set-AzFirewallPolicy](Set-AzFirewallPolicy.md) +Saves a modified azure firewall policy + +### [Set-AzFirewallPolicyRuleCollectionGroup](Set-AzFirewallPolicyRuleCollectionGroup.md) +saves a modified azure firewall policy rule collection group + +### [Set-AzIpAllocation](Set-AzIpAllocation.md) +Saves a modified IpAllocation. + +### [Set-AzIpGroup](Set-AzIpGroup.md) +Saves a modified Firewall. + +### [Set-AzLoadBalancer](Set-AzLoadBalancer.md) +Updates a load balancer. + +### [Set-AzLoadBalancerBackendAddressPool](Set-AzLoadBalancerBackendAddressPool.md) +Updates the backend pool on a loadbalancer + +### [Set-AzLoadBalancerFrontendIpConfig](Set-AzLoadBalancerFrontendIpConfig.md) +Updates a front-end IP configuration for a load balancer. + +### [Set-AzLoadBalancerInboundNatPoolConfig](Set-AzLoadBalancerInboundNatPoolConfig.md) +Sets an inbound NAT pool configuration for a load balancer. + +### [Set-AzLoadBalancerInboundNatRuleConfig](Set-AzLoadBalancerInboundNatRuleConfig.md) +Sets an inbound NAT rule configuration for a load balancer. + +### [Set-AzLoadBalancerOutboundRuleConfig](Set-AzLoadBalancerOutboundRuleConfig.md) +Sets an outbound rule configuration for a load balancer. + +### [Set-AzLoadBalancerProbeConfig](Set-AzLoadBalancerProbeConfig.md) +Updates a probe configuration for a load balancer. + +### [Set-AzLoadBalancerRuleConfig](Set-AzLoadBalancerRuleConfig.md) +Updates a rule configuration for a load balancer. + +### [Set-AzLocalNetworkGateway](Set-AzLocalNetworkGateway.md) +Modifies a local network gateway. + +### [Set-AzNatGateway](Set-AzNatGateway.md) +Update Nat Gateway Resource with Public Ip Address, Public Ip Prefix and IdleTimeoutInMinutes. + +### [Set-AzNetworkInterface](Set-AzNetworkInterface.md) +Updates a network interface. + +### [Set-AzNetworkInterfaceIpConfig](Set-AzNetworkInterfaceIpConfig.md) +Updates an IP configuration for a network interface. + +### [Set-AzNetworkInterfaceTapConfig](Set-AzNetworkInterfaceTapConfig.md) +Updates a tap configuration for a network interface. + +### [Set-AzNetworkManager](Set-AzNetworkManager.md) +Updates a network manager.. + +### [Set-AzNetworkManagerConnectivityConfiguration](Set-AzNetworkManagerConnectivityConfiguration.md) +Updates a connectivity configuration. + +### [Set-AzNetworkManagerGroup](Set-AzNetworkManagerGroup.md) +Updates a network manager group. + +### [Set-AzNetworkManagerManagementGroupConnection](Set-AzNetworkManagerManagementGroupConnection.md) +Update a network manger management group connection + +### [Set-AzNetworkManagerScopeConnection](Set-AzNetworkManagerScopeConnection.md) +Update a network manager scope connection. + +### [Set-AzNetworkManagerSecurityAdminConfiguration](Set-AzNetworkManagerSecurityAdminConfiguration.md) +Updates a network manager security admin configuration. + +### [Set-AzNetworkManagerSecurityAdminRule](Set-AzNetworkManagerSecurityAdminRule.md) +Updates a network manager security admin rule. + +### [Set-AzNetworkManagerSecurityAdminRuleCollection](Set-AzNetworkManagerSecurityAdminRuleCollection.md) +Updates a network manager security admin rule collection. + +### [Set-AzNetworkManagerSubscriptionConnection](Set-AzNetworkManagerSubscriptionConnection.md) +Update a network manager subscription connection. + +### [Set-AzNetworkProfile](Set-AzNetworkProfile.md) +Updates a network profile. + +### [Set-AzNetworkSecurityGroup](Set-AzNetworkSecurityGroup.md) +Updates a network security group. + +### [Set-AzNetworkSecurityRuleConfig](Set-AzNetworkSecurityRuleConfig.md) +Updates a network security rule configuration for a network security group. + +### [Set-AzNetworkWatcherConfigFlowLog](Set-AzNetworkWatcherConfigFlowLog.md) +Configures flow logging for a target resource. + +### [Set-AzNetworkWatcherConnectionMonitor](Set-AzNetworkWatcherConnectionMonitor.md) +Updates connection monitor resource. + +### [Set-AzNetworkWatcherFlowLog](Set-AzNetworkWatcherFlowLog.md) +Updates flow log resource. + +### [Set-AzPrivateDnsZoneGroup](Set-AzPrivateDnsZoneGroup.md) +Updates DNS zone group + +### [Set-AzPrivateEndpoint](Set-AzPrivateEndpoint.md) +Updates a private endpoint. + +### [Set-AzPrivateEndpointConnection](Set-AzPrivateEndpointConnection.md) +Updates a private endpoint connection state on private link service. + +### [Set-AzPrivateLinkService](Set-AzPrivateLinkService.md) +Updates a private link service. + +### [Set-AzPublicIpAddress](Set-AzPublicIpAddress.md) +Updates a public IP address. + +### [Set-AzPublicIpPrefix](Set-AzPublicIpPrefix.md) +Sets the Tags for an existing PublicIpPrefix + +### [Set-AzRouteConfig](Set-AzRouteConfig.md) +Updates a route configuration for a route table. + +### [Set-AzRouteFilter](Set-AzRouteFilter.md) +Updates a route filter. + +### [Set-AzRouteFilterRuleConfig](Set-AzRouteFilterRuleConfig.md) +Modifies the route filter rule of a route filter. + +### [Set-AzRouteTable](Set-AzRouteTable.md) +Updates a route table. + +### [Set-AzRoutingIntent](Set-AzRoutingIntent.md) +Updates a routing intent resource associated with a VirtualHub. + +### [Set-AzRoutingPolicy](Set-AzRoutingPolicy.md) +Updates the destinations or nexthop for the specified Routing Policy of a Routing Intent object. + +### [Set-AzSecurityPartnerProvider](Set-AzSecurityPartnerProvider.md) +Saves a modified Azure SecurityPartnerProvider. + +### [Set-AzServiceEndpointPolicy](Set-AzServiceEndpointPolicy.md) +Updates a service endpoint policy. + +### [Set-AzServiceEndpointPolicyDefinition](Set-AzServiceEndpointPolicyDefinition.md) +Updates a service endpoint policy definition. + +### [Set-AzVirtualHub](Set-AzVirtualHub.md) +Modifies a Virtual Hub to add a Virtual HUb Route Table to it. + +### [Set-AzVirtualNetwork](Set-AzVirtualNetwork.md) +Updates a virtual network. + +### [Set-AzVirtualNetworkGateway](Set-AzVirtualNetworkGateway.md) +Updates a virtual network gateway. + +### [Set-AzVirtualNetworkGatewayConnection](Set-AzVirtualNetworkGatewayConnection.md) +Configures a virtual network gateway connection. + +### [Set-AzVirtualNetworkGatewayConnectionSharedKey](Set-AzVirtualNetworkGatewayConnectionSharedKey.md) +Configures the shared key of the virtual network gateway connection. + +### [Set-AzVirtualNetworkGatewayDefaultSite](Set-AzVirtualNetworkGatewayDefaultSite.md) +Sets the default site for a virtual network gateway. + +### [Set-AzVirtualNetworkPeering](Set-AzVirtualNetworkPeering.md) +Configures a virtual network peering. + +### [Set-AzVirtualNetworkSubnetConfig](Set-AzVirtualNetworkSubnetConfig.md) +Updates a subnet configuration for a virtual network. + +### [Set-AzVirtualNetworkTap](Set-AzVirtualNetworkTap.md) +Updates a virtual network tap. + +### [Set-AzVpnClientIpsecParameter](Set-AzVpnClientIpsecParameter.md) +Sets the vpn ipsec parameters for existing virtual network gateway. + +### [Start-AzApplicationGateway](Start-AzApplicationGateway.md) +Starts an application gateway. + +### [Start-AzNetworkWatcherConnectionMonitor](Start-AzNetworkWatcherConnectionMonitor.md) +Start a connection monitor + +### [Start-AzNetworkWatcherResourceTroubleshooting](Start-AzNetworkWatcherResourceTroubleshooting.md) +Starts troubleshooting on a Networking resource in Azure. + +### [Start-AzVirtualNetworkGatewayConnectionPacketCapture](Start-AzVirtualNetworkGatewayConnectionPacketCapture.md) +Starts Packet Capture Operation on a Virtual Network Gateway Connection. + +### [Start-AzVirtualnetworkGatewayPacketCapture](Start-AzVirtualnetworkGatewayPacketCapture.md) +Starts Packet Capture Operation on a Virtual Network Gateway. + +### [Start-AzVpnConnectionPacketCapture](Start-AzVpnConnectionPacketCapture.md) +Starts Packet Capture Operation on a Vpn Connection. + +### [Start-AzVpnGatewayPacketCapture](Start-AzVpnGatewayPacketCapture.md) +Starts Packet Capture Operation on a Vpn Gateway. + +### [Stop-AzApplicationGateway](Stop-AzApplicationGateway.md) +Stops an application gateway + +### [Stop-AzNetworkWatcherConnectionMonitor](Stop-AzNetworkWatcherConnectionMonitor.md) +Stop a connection monitor + +### [Stop-AzNetworkWatcherPacketCapture](Stop-AzNetworkWatcherPacketCapture.md) +Stops a running packet capture session + +### [Stop-AzVirtualNetworkGatewayConnectionPacketCapture](Stop-AzVirtualNetworkGatewayConnectionPacketCapture.md) +Stops Packet Capture Operation on a Virtual Network Gateway connection + +### [Stop-AzVirtualNetworkGatewayPacketCapture](Stop-AzVirtualNetworkGatewayPacketCapture.md) +Stops Packet Capture Operation on a Virtual Network Gateway. + +### [Stop-AzVpnConnectionPacketCapture](Stop-AzVpnConnectionPacketCapture.md) +Stops Packet Capture Operation on a Vpn connection + +### [Stop-AzVpnGatewayPacketCapture](Stop-AzVpnGatewayPacketCapture.md) +Stops Packet Capture Operation on a Vpn Gateway. + +### [Sync-AzVirtualNetworkPeering](Sync-AzVirtualNetworkPeering.md) +Command to sync the address space on the peering link if the remote virtual network has a new address space. + +### [Test-AzDnsAvailability](Test-AzDnsAvailability.md) +Checks whether a domain name in the cloudapp.azure.com zone is available for use. + +### [Test-AzNetworkWatcherConnectivity](Test-AzNetworkWatcherConnectivity.md) +Returns connectivity information for a specified source VM and a destination. + +### [Test-AzNetworkWatcherIPFlow](Test-AzNetworkWatcherIPFlow.md) +Returns whether the packet is allowed or denied to or from a particular destination. + +### [Test-AzPrivateIPAddressAvailability](Test-AzPrivateIPAddressAvailability.md) +Test availability of a private IP address in a virtual network. + +### [Test-AzPrivateLinkServiceVisibility](Test-AzPrivateLinkServiceVisibility.md) +The **Test-AzPrivateLinkServiceVisibility** checks whether a private link service is visible for current use. + +### [Update-AzCustomIpPrefix](Update-AzCustomIpPrefix.md) +Updates a CustomIpPrefix + +### [Update-AzNetworkVirtualAppliance](Update-AzNetworkVirtualAppliance.md) +Update or Change a Network Virtual Appliance resource. + +### [Update-AzP2sVpnGateway](Update-AzP2sVpnGateway.md) +Update an existing P2SVpnGateway under VirtualHub for point to site connectivity. + +### [Update-AzRouteMap](Update-AzRouteMap.md) +Update a route map of a VirtualHub. + +### [Update-AzRouteServer](Update-AzRouteServer.md) +Update an Azure RouteServer. + +### [Update-AzRouteServerPeer](Update-AzRouteServerPeer.md) +Update a Peer in an Azure RouteServer + +### [Update-AzVHubRouteTable](Update-AzVHubRouteTable.md) +Delete a hub route table resource associated with a VirtualHub. + +### [Update-AzVirtualApplianceSite](Update-AzVirtualApplianceSite.md) +Change or Modify a Virtual Appliance site connected to a Network Virtual Appliance resource. + +### [Update-AzVirtualHub](Update-AzVirtualHub.md) +Updates a virtual hub. + +### [Update-AzVirtualHubBgpConnection](Update-AzVirtualHubBgpConnection.md) +The Update-AzVirtualHubBgpConnection cmdlet updates an existing HubBgpConnection resource (Virtual WAN Hub BGP Connection). + +### [Update-AzVirtualHubVnetConnection](Update-AzVirtualHubVnetConnection.md) +Updates an existing HubVirtualNetworkConnection. + +### [Update-AzVirtualNetworkGatewayNatRule](Update-AzVirtualNetworkGatewayNatRule.md) +Updates a Virtual Network Gateway NatRule. + +### [Update-AzVirtualRouter](Update-AzVirtualRouter.md) +Updates a Virtual Router. + +### [Update-AzVirtualRouterPeer](Update-AzVirtualRouterPeer.md) +Update a Peer in an Azure VirtualRouter + +### [Update-AzVirtualWan](Update-AzVirtualWan.md) +Updates an Azure Virtual WAN. + +### [Update-AzVpnConnection](Update-AzVpnConnection.md) +Updates a VPN connection. + +### [Update-AzVpnGateway](Update-AzVpnGateway.md) +Updates a scalable VPN gateway. + +### [Update-AzVpnGatewayNatRule](Update-AzVpnGatewayNatRule.md) +Updates a NAT rule associated with VpnGateway. + +### [Update-AzVpnServerConfiguration](Update-AzVpnServerConfiguration.md) +Updates an existing VpnServerConfiguration. + +### [New-AzP2sVpnGateway](New-AzP2sVpnGateway.md) +Create a new P2SVpnGateway under VirtualHub for point to site connectivity. + +### [Update-AzVpnSite](Update-AzVpnSite.md) +Updates a VPN site. + diff --git a/azps-10.1.0/Az.Network/Deny-AzPrivateEndpointConnection.md b/azps-10.1.0/Az.Network/Deny-AzPrivateEndpointConnection.md new file mode 100644 index 0000000000..3e13e047f0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Deny-AzPrivateEndpointConnection.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/deny-azprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Deny-AzPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Deny-AzPrivateEndpointConnection.md +--- + +# Deny-AzPrivateEndpointConnection + +## SYNOPSIS +denies a private endpoint connection. + +## SYNTAX + +### ByResourceId (Default) +``` +Deny-AzPrivateEndpointConnection [-Description <String>] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResource +``` +Deny-AzPrivateEndpointConnection -Name <String> [-Description <String>] -ResourceGroupName <String> + -ServiceName <String> [-DefaultProfile <IAzureContextContainer>] -PrivateLinkResourceType <String> + [<CommonParameters>] +``` + +## DESCRIPTION +The **Deny-AzPrivateEndpointConnection** cmdlet denies a private endpoint connection. + +## EXAMPLES + +### Example 1 +```powershell +Deny-AzPrivateEndpointConnection -Name TestPrivateEndpointConnection -ResourceGroupName TestResourceGroup -ServiceName TestPrivateLinkService -PrivateLinkResourceType Microsoft.Network/privateLinkServices +``` + +This example denies a private endpoint connection. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The reason of action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateLinkResourceType +The private link resource type. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: +Accepted values: Microsoft.AgFoodPlatform/farmBeats, Microsoft.ApiManagement/service, Microsoft.AppConfiguration/configurationStores, Microsoft.Attestation/attestationProviders, Microsoft.Authorization/resourceManagementPrivateLinks, Microsoft.Automation/automationAccounts, Microsoft.Batch/batchAccounts, Microsoft.Cache/Redis, Microsoft.Cache/redisEnterprise, Microsoft.CognitiveServices/accounts, Microsoft.Compute/diskAccesses, Microsoft.ContainerRegistry/registries, Microsoft.ContainerService/managedClusters, Microsoft.Databricks/workspaces, Microsoft.DataFactory/factories, Microsoft.DBforMariaDB/servers, Microsoft.DBforMySQL/servers, Microsoft.DBforPostgreSQL/servers, Microsoft.DesktopVirtualization/hostpools, Microsoft.DesktopVirtualization/workspaces, Microsoft.Devices/IotHubs, Microsoft.Devices/ProvisioningServices, Microsoft.DeviceUpdate/accounts, Microsoft.DigitalTwins/digitalTwinsInstances, Microsoft.DocumentDB/databaseAccounts, Microsoft.EventGrid/topics, Microsoft.EventGrid/domains, Microsoft.EventHub/namespaces, Microsoft.HardwareSecurityModules/cloudHsmClusters, Microsoft.HealthcareApis/services, Microsoft.HDInsight/clusters, Microsoft.HybridCompute/privateLinkScopes, Microsoft.Insights/privateLinkScopes, Microsoft.KeyVault/vaults, Microsoft.Keyvault/managedHSMs, Microsoft.MachineLearningServices/workspaces, Microsoft.MachineLearningServices/registries, Microsoft.Media/mediaservices, Microsoft.Media/videoanalyzers, Microsoft.Migrate/assessmentProjects, Microsoft.Migrate/migrateProjects, Microsoft.Monitor/accounts, Microsoft.Network/applicationgateways, Microsoft.Network/privateLinkServices, Microsoft.OffAzure/masterSites, Microsoft.PowerBI/privateLinkServicesForPowerBI, Microsoft.Purview/accounts, Microsoft.RecoveryServices/vaults, Microsoft.Relay/namespaces, Microsoft.Search/searchServices, Microsoft.ServiceBus/namespaces, Microsoft.SignalRService/signalr, Microsoft.SignalRService/webPubSub, Microsoft.Sql/servers, Microsoft.Storage/storageAccounts, Microsoft.StorageSync/storageSyncServices, Microsoft.Synapse/privateLinkHubs, Microsoft.Synapse/workspaces, Microsoft.Web/sites, Microsoft.Web/staticSites, Microsoft.Web/hostingEnvironments, Microsoft.BotService/botServices, Microsoft.OpenEnergyPlatform/energyServices, Microsoft.DBforMySQL/flexibleServers + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource manager id of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +The name of service that private endpoint connection belong to. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateLinkService + +## NOTES + +## RELATED LINKS + +[Approve-AzPrivateEndpointConnection](./Approve-AzPrivateEndpointConnection.md) + +[Get-AzPrivateEndpointConnection](./Get-AzPrivateEndpointConnection.md) + +[Remove-AzPrivateEndpointConnection](./Remove-AzPrivateEndpointConnection.md) + +[Set-AzPrivateEndpointConnection](./Set-AzPrivateEndpointConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Deploy-AzNetworkManagerCommit.md b/azps-10.1.0/Az.Network/Deploy-AzNetworkManagerCommit.md new file mode 100644 index 0000000000..891a553ad5 --- /dev/null +++ b/azps-10.1.0/Az.Network/Deploy-AzNetworkManagerCommit.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/deploy-aznetworkmanagercommit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Deploy-AzNetworkManagerCommit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Deploy-AzNetworkManagerCommit.md +--- + +# Deploy-AzNetworkManagerCommit + +## SYNOPSIS +Deploys a network manager commit. + +## SYNTAX + +``` +Deploy-AzNetworkManagerCommit -Name <String> -ResourceGroupName <String> -TargetLocation <String[]> + [-ConfigurationId <String[]>] -CommitType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Deploy-AzNetworkManagerCommit** cmdlet deploys a network manager commit. + +## EXAMPLES + +### Example 1 +```powershell +$regions = @("eastus", "westus") +$configIds = @("/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/connectivityConfigurations/psConnectivityConfigMesh") +Deploy-AzNetworkManagerCommit -ResourceGroupName "psResourceGroup" -Name "psNetworkManager" -TargetLocation $regions -ConfigurationId $configids -CommitType "Connectivity" +``` + +This example is used to commit connecitivity confguration in East US and West US regions. + +### Example 2 +```powershell +$regions = @( "westus") +Deploy-AzNetworkManagerCommit -ResourceGroupName "psResourceGroup" -Name "psNetworkManager" -TargetLocation $regions -CommitType "Connectivity" +``` + +This example is used to uncommit all connecitivity confgurations in West US region. + +### Example 3 +```powershell +$regions = @( "westus") +$configIds = @("/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/securityAdminConfigurations/psSecurityAdminConfig") +Deploy-AzNetworkManagerCommit -ResourceGroupName "psResourceGroup" -Name "psNetworkManager" -TargetLocation $regions -CommitType "Connectivity" -ConfigurationId $configids +``` + +This example is used to commit a security admin config in West US region. + +## PARAMETERS + +### -CommitType +Commit Type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: SecurityAdmin, Connectivity + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ConfigurationId +List of configuration ids. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -TargetLocation +List of target locations. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerCommit + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManager](./New-AzNetworkManager.md) + +[Get-AzNetworkManager](./Get-AzNetworkManager.md) + +[Remove-AzNetworkManager](./Remove-AzNetworkManager.md) + +[Set-AzNetworkManager](./Set-AzNetworkManager.md) diff --git a/azps-10.1.0/Az.Network/Disconnect-AzP2SVpnGatewayVpnConnection.md b/azps-10.1.0/Az.Network/Disconnect-AzP2SVpnGatewayVpnConnection.md new file mode 100644 index 0000000000..1fa821cdcf --- /dev/null +++ b/azps-10.1.0/Az.Network/Disconnect-AzP2SVpnGatewayVpnConnection.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/disconnect-azp2svpngatewayvpnconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Disconnect-AzP2SVpnGatewayVpnConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Disconnect-AzP2SVpnGatewayVpnConnection.md +--- + +# Disconnect-AzP2SVpnGatewayVpnConnection + +## SYNOPSIS +Disconnect given connected vpn client connections with a given p2s vpn gateway + +## SYNTAX + +### ByP2SVpnGatewayName (Default) +``` +Disconnect-AzP2SVpnGatewayVpnConnection -ResourceGroupName <String> -Name <String> -VpnConnectionId <String[]> + [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayResourceId +``` +Disconnect-AzP2SVpnGatewayVpnConnection -ResourceId <String> -VpnConnectionId <String[]> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayObject +``` +Disconnect-AzP2SVpnGatewayVpnConnection -InputObject <PSP2SVpnGateway> -VpnConnectionId <String[]> [-AsJob] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disconnect-AzP2sVpnGatewayVpnConnection** cmdlet enables you to disconnect given current point to site connection from P2SVpnGateway. + +## EXAMPLES + +### Example 1 +```powershell +Disconnect-AzP2SVpnGatewayVpnConnection -ResourceName 683482ade8564515aed4b8448c9757ea-westus-gw -ResourceGroupName P2SCortexGATesting -VpnConnectionId @("IKEv2_7e1cfe59-5c7c-4315-a876-b11fbfdfeed4") +``` + +```output +ResourceGroupName : P2SCortexGATesting +Name : 683482ade8564515aed4b8448c9757ea-westus-gw +Id : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482ade8564515a + ed4b8448c9757ea-westus-gw +Location : westus +VpnGatewayScaleUnit : 1 +VirtualHub : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub +VpnServerConfiguration : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/WestUsConfig +VpnServerConfigurationLocation : +VpnClientConnectionHealth : null +Type : Microsoft.Network/p2sVpnGateways +ProvisioningState : Succeeded +P2SConnectionConfigurations : [ + { + "ProvisioningState": "Succeeded", + "VpnClientAddressPool": { + "AddressPrefixes": [ + "192.168.2.0/24" + ] + }, + "Name": "P2SConnectionConfigDefault", + "Etag": "W/\"4b96e6a2-b4d8-46b3-9210-76d40f359bef\"", + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482 + ade8564515aed4b8448c9757ea-westus-gw/p2sConnectionConfigurations/P2SConnectionConfigDefault" + } + ] +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The p2s vpn gateway object to be modified + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +Parameter Sets: ByP2SVpnGatewayObject +Aliases: P2SVpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayName +Aliases: ResourceName, P2SVpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +P2s Virtual network gateway resource Id + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnConnectionId +Vpn Connection Ida + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Disconnect-AzVirtualNetworkGatewayVpnConnection.md b/azps-10.1.0/Az.Network/Disconnect-AzVirtualNetworkGatewayVpnConnection.md new file mode 100644 index 0000000000..24a5e0456c --- /dev/null +++ b/azps-10.1.0/Az.Network/Disconnect-AzVirtualNetworkGatewayVpnConnection.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/disconnect-azvirtualnetworkgatewayvpnconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Disconnect-AzVirtualNetworkGatewayVpnConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Disconnect-AzVirtualNetworkGatewayVpnConnection.md +--- + +# Disconnect-AzVirtualNetworkGatewayVpnConnection + +## SYNOPSIS +Disconnect given connected vpn client connections with a given virtual network gateway. + +## SYNTAX + +### ByFactoryName (Default) +``` +Disconnect-AzVirtualNetworkGatewayVpnConnection -VirtualNetworkGatewayName <String> -ResourceGroupName <String> + -VpnConnectionId <String[]> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Disconnect-AzVirtualNetworkGatewayVpnConnection -ResourceId <String> -VpnConnectionId <String[]> [-AsJob] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Disconnect-AzVirtualNetworkGatewayVpnConnection [-InputObject <PSVirtualNetworkGateway>] + -VpnConnectionId <String[]> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disconnect-AzVirtualNetworkGatewayVpnConnection** cmdlet enables you to disconnect given connected vpn client connection. + +## EXAMPLES + +### Example 1 +```powershell +Disconnect-AzVirtualNetworkGatewayVpnConnection -ResourceName vnet-gw -ResourceGroupName vnetgwrg -VpnConnectionId @("IKEv2_7e1cfe59-5c7c-4315-a876-b11fbfdfeed4") +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Virtual network gateway object + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: ByFactoryObject +Aliases: VirtualNetworkGateway + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Virtual network gateway resource group's name + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Virtual network gateway resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: VirtualNetworkGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +Virtual network gateway name + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnConnectionId +Vpn Connection Ids + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGateway.md b/azps-10.1.0/Az.Network/Get-AzApplicationGateway.md new file mode 100644 index 0000000000..dedf87f167 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGateway.md @@ -0,0 +1,336 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 77CDEE77-FD5D-4C2D-B027-FF1F6FF6618E +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGateway.md +--- + +# Get-AzApplicationGateway + +## SYNOPSIS +Gets an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGateway [-Name <String>] [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGateway** cmdlet gets an application gateway. + +## EXAMPLES + +### Example 1: Get a specified application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +``` + +```output +Sku : Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku +SslPolicy : +GatewayIPConfigurations : {appGatewayFrontendIP} +AuthenticationCertificates : {} +SslCertificates : {} +TrustedRootCertificates : {} +FrontendIPConfigurations : {appGatewayFrontendIP} +FrontendPorts : {appGatewayFrontendPort} +Probes : {} +BackendAddressPools : {appGatewayBackendPool} +BackendHttpSettingsCollection : {appGatewayBackendHttpSettings} +HttpListeners : {appGatewayHttpListener} +UrlPathMaps : {} +RequestRoutingRules : {rule1} +RewriteRuleSets : {} +RedirectConfigurations : {} +WebApplicationFirewallConfiguration : +AutoscaleConfiguration : +CustomErrorConfigurations : {} +EnableHttp2 : +EnableFips : +ForceFirewallPolicyAssociation : +Zones : {} +OperationalState : Running +ProvisioningState : Succeeded +Identity : +DefaultPredefinedSslPolicy : AppGwSslPolicy20150501 +GatewayIpConfigurationsText : [] +AuthenticationCertificatesText : [] +SslCertificatesText : [] +FrontendIpConfigurationsText : [] +FrontendPortsText : [] +BackendAddressPoolsText : [] +BackendHttpSettingsCollectionText : [] +HttpListenersText : [] +RewriteRuleSetsText : [] +RequestRoutingRulesText : [] +ProbesText : [] +UrlPathMapsText : [] +IdentityText : null +SslPolicyText : null +ResourceGroupName : tjp-rg +Location : westus +ResourceGuid : 00000000-0000-0000-0000-000000000000 +Type : Microsoft.Network/applicationGateways +Tag : {} +TagsTable : +Name : ApplicationGateway01 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/provide + rs/Microsoft.Network/applicationGateways/ApplicationGateway01 +``` + +This command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. + +### Example 2: Get a list of application gateways in a resource group +```powershell +$AppGwList = Get-AzApplicationGateway -ResourceGroupName "ResourceGroup01" +``` + +```output +Sku : Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku +SslPolicy : +GatewayIPConfigurations : {appGatewayFrontendIP} +AuthenticationCertificates : {} +SslCertificates : {} +TrustedRootCertificates : {} +FrontendIPConfigurations : {appGatewayFrontendIP} +FrontendPorts : {appGatewayFrontendPort} +Probes : {} +BackendAddressPools : {appGatewayBackendPool} +BackendHttpSettingsCollection : {appGatewayBackendHttpSettings} +HttpListeners : {appGatewayHttpListener} +UrlPathMaps : {} +RequestRoutingRules : {rule1} +RewriteRuleSets : {} +RedirectConfigurations : {} +WebApplicationFirewallConfiguration : +AutoscaleConfiguration : +CustomErrorConfigurations : {} +EnableHttp2 : +EnableFips : +ForceFirewallPolicyAssociation : +Zones : {} +OperationalState : Running +ProvisioningState : Succeeded +Identity : +DefaultPredefinedSslPolicy : AppGwSslPolicy20150501 +GatewayIpConfigurationsText : [] +AuthenticationCertificatesText : [] +SslCertificatesText : [] +FrontendIpConfigurationsText : [] +FrontendPortsText : [] +BackendAddressPoolsText : [] +BackendHttpSettingsCollectionText : [] +HttpListenersText : [] +RewriteRuleSetsText : [] +RequestRoutingRulesText : [] +ProbesText : [] +UrlPathMapsText : [] +IdentityText : null +SslPolicyText : null +ResourceGroupName : tjp-rg +Location : westus +ResourceGuid : 00000000-0000-0000-0000-000000000000 +Type : Microsoft.Network/applicationGateways +Tag : {} +TagsTable : +Name : ApplicationGateway01 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/provide + rs/Microsoft.Network/applicationGateways/ApplicationGateway01 +``` + +This command gets a list of all the application gateways in the resource group named ResourceGroup01 and stores it in the $AppGwList variable. + +### Example 3: Get a list of application gateways in a subscription +```powershell +$AppGwList = Get-AzApplicationGateway +``` + +```output +Sku : Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku +SslPolicy : +GatewayIPConfigurations : {appGatewayFrontendIP} +AuthenticationCertificates : {} +SslCertificates : {} +TrustedRootCertificates : {} +FrontendIPConfigurations : {appGatewayFrontendIP} +FrontendPorts : {appGatewayFrontendPort} +Probes : {} +BackendAddressPools : {appGatewayBackendPool} +BackendHttpSettingsCollection : {appGatewayBackendHttpSettings} +HttpListeners : {appGatewayHttpListener} +UrlPathMaps : {} +RequestRoutingRules : {rule1} +RewriteRuleSets : {} +RedirectConfigurations : {} +WebApplicationFirewallConfiguration : +AutoscaleConfiguration : +CustomErrorConfigurations : {} +EnableHttp2 : +EnableFips : +ForceFirewallPolicyAssociation : +Zones : {} +OperationalState : Running +ProvisioningState : Succeeded +Identity : +DefaultPredefinedSslPolicy : AppGwSslPolicy20150501 +GatewayIpConfigurationsText : [] +AuthenticationCertificatesText : [] +SslCertificatesText : [] +FrontendIpConfigurationsText : [] +FrontendPortsText : [] +BackendAddressPoolsText : [] +BackendHttpSettingsCollectionText : [] +HttpListenersText : [] +RewriteRuleSetsText : [] +RequestRoutingRulesText : [] +ProbesText : [] +UrlPathMapsText : [] +IdentityText : null +SslPolicyText : null +ResourceGroupName : tjp-rg +Location : westus +ResourceGuid : 00000000-0000-0000-0000-000000000000 +Type : Microsoft.Network/applicationGateways +Tag : {} +TagsTable : +Name : ApplicationGateway01 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/provide + rs/Microsoft.Network/applicationGateways/ApplicationGateway01 +``` + +This command gets a list of all the application gateways in the subscription and stores it in the $AppGwList variable. + +### Example 4: Get a list of application gateways in a subscription using filtering +```powershell +$AppGwList = Get-AzApplicationGateway -Name ApplicationGateway* +``` + +```output +Sku : Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku +SslPolicy : +GatewayIPConfigurations : {appGatewayFrontendIP} +AuthenticationCertificates : {} +SslCertificates : {} +TrustedRootCertificates : {} +FrontendIPConfigurations : {appGatewayFrontendIP} +FrontendPorts : {appGatewayFrontendPort} +Probes : {} +BackendAddressPools : {appGatewayBackendPool} +BackendHttpSettingsCollection : {appGatewayBackendHttpSettings} +HttpListeners : {appGatewayHttpListener} +UrlPathMaps : {} +RequestRoutingRules : {rule1} +RewriteRuleSets : {} +RedirectConfigurations : {} +WebApplicationFirewallConfiguration : +AutoscaleConfiguration : +CustomErrorConfigurations : {} +EnableHttp2 : +EnableFips : +ForceFirewallPolicyAssociation : +Zones : {} +OperationalState : Running +ProvisioningState : Succeeded +Identity : +DefaultPredefinedSslPolicy : AppGwSslPolicy20150501 +GatewayIpConfigurationsText : [] +AuthenticationCertificatesText : [] +SslCertificatesText : [] +FrontendIpConfigurationsText : [] +FrontendPortsText : [] +BackendAddressPoolsText : [] +BackendHttpSettingsCollectionText : [] +HttpListenersText : [] +RewriteRuleSetsText : [] +RequestRoutingRulesText : [] +ProbesText : [] +UrlPathMapsText : [] +IdentityText : null +SslPolicyText : null +ResourceGroupName : tjp-rg +Location : westus +ResourceGuid : 00000000-0000-0000-0000-000000000000 +Type : Microsoft.Network/applicationGateways +Tag : {} +TagsTable : +Name : ApplicationGateway01 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/provide + rs/Microsoft.Network/applicationGateways/ApplicationGateway01 +``` + +This command gets a list of all the application gateways in the subscription that start with "ApplicationGateway01" and stores it in the $AppGwList variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the application gateway that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the application gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Stop-AzApplicationGateway](./Stop-AzApplicationGateway.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAuthenticationCertificate.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAuthenticationCertificate.md new file mode 100644 index 0000000000..01f71fe300 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAuthenticationCertificate.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 706C918B-1D1A-476C-BB74-EBB4EE72AC0C +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayauthenticationcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayAuthenticationCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayAuthenticationCertificate.md +--- + +# Get-AzApplicationGatewayAuthenticationCertificate + +## SYNOPSIS +Gets an authentication certificate for an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayAuthenticationCertificate [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayAuthenticationCertificate** cmdlet gets an authentication certificate for an Azure application gateway. + +## EXAMPLES + +### Example 1: Get a specified authentication certificate +```powershell +$appgw = Get-AzApplicationGateway -ResourceGroupName "rg" -Name "appGwName" +$cert = Get-AzApplicationGatewayAuthenticationCertificate -Name "cert01" -ApplicationGateway $appgw +``` + +The first command gets the application gateway named appGwName and stores it in the $appgw variable. +The second command gets the authentication certificate named cert01 and stores it in the $cert variable. + +## PARAMETERS + +### -ApplicationGateway +Specifies the name of application gateway for which this cmdlet gets an authentication certificate. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the authentication certificate that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Add-AzApplicationGatewayAuthenticationCertificate](./Add-AzApplicationGatewayAuthenticationCertificate.md) + +[New-AzApplicationGatewayAuthenticationCertificate](./New-AzApplicationGatewayAuthenticationCertificate.md) + +[Remove-AzApplicationGatewayAuthenticationCertificate](./Remove-AzApplicationGatewayAuthenticationCertificate.md) + +[Set-AzApplicationGatewayAuthenticationCertificate](./Set-AzApplicationGatewayAuthenticationCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAutoscaleConfiguration.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAutoscaleConfiguration.md new file mode 100644 index 0000000000..780875b511 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAutoscaleConfiguration.md @@ -0,0 +1,88 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayautoscaleconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayAutoscaleConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayAutoscaleConfiguration.md +--- + +# Get-AzApplicationGatewayAutoscaleConfiguration + +## SYNOPSIS +Gets the Autoscale Configuration of the Application Gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayAutoscaleConfiguration -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayAutoscaleConfiguration** cmdlet gets Autoscale Configuration of the Application Gateway. + +## EXAMPLES + +### Example 1 +```powershell +$gw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $resgpName +$autoscaleConfiguration = Get-AzApplicationGatewayAutoscaleConfiguration -ApplicationGateway $gw +$autoscaleConfiguration.MinCapacity +``` + +The first command gets the application gateway and stores it in $gw variable. +The second command extracts out the autoscale configuration from the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAutoscaleConfiguration + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayAutoscaleConfiguration](./New-AzApplicationGatewayAutoscaleConfiguration.md) + +[Remove-AzApplicationGatewayAutoscaleConfiguration](./Remove-AzApplicationGatewayAutoscaleConfiguration.md) + +[Set-AzApplicationGatewayAutoscaleConfiguration](./Set-AzApplicationGatewayAutoscaleConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAvailableServerVariableAndHeader.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAvailableServerVariableAndHeader.md new file mode 100644 index 0000000000..41fdd61f20 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAvailableServerVariableAndHeader.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayavailableservervariableandheader +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayAvailableServerVariableAndHeader.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayAvailableServerVariableAndHeader.md +--- + +# Get-AzApplicationGatewayAvailableServerVariableAndHeader + +## SYNOPSIS +Get the supported server variables and available request and response headers. + +## SYNTAX + +``` +Get-AzApplicationGatewayAvailableServerVariableAndHeader [-DefaultProfile <IAzureContextContainer>] + [-ServerVariable] [-RequestHeader] [-ResponseHeader] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayAvailableServerVariableAndHeader** cmdlet gets the supported server variables and available request and response headers. Parameters can be used to get the variables or headers lists. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzApplicationGatewayAvailableServerVariableAndHeader -ServerVariable +``` + +This commands returns all the available server variables. + +### Example 2 +```powershell +Get-AzApplicationGatewayAvailableServerVariableAndHeader -RequestHeader +``` + +This commands returns all the available request headers. + +### Example 3 +```powershell +Get-AzApplicationGatewayAvailableServerVariableAndHeader -ResponseHeader +``` + +This commands returns all the available response headers. + +### Example 4 +```powershell +Get-AzApplicationGatewayAvailableServerVariableAndHeader -ServerVariable -RequestHeader -ResponseHeader +``` + +This commands returns all the available server variables, request and response headers. + +### Example 5 +```powershell +Get-AzApplicationGatewayAvailableServerVariableAndHeader +``` + +This commands returns all the available server variables, request and response headers. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestHeader +Application Gateway available request headers. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseHeader +Application Gateway available response headers. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerVariable +Application Gateway available server variables. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAvailableServerVariableAndRequestHeaderResult + +## NOTES +**List-AzApplicationGatewayAvailableServerVariableAndHeader** is an alias for the **Get-AzApplicationGatewayAvailableServerVariableAndHeader** cmdlet. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAvailableSslOption.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAvailableSslOption.md new file mode 100644 index 0000000000..bc39e73346 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAvailableSslOption.md @@ -0,0 +1,63 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayavailablessloption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayAvailableSslOption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayAvailableSslOption.md +--- + +# Get-AzApplicationGatewayAvailableSslOption + +## SYNOPSIS +Gets all available ssl options for ssl policy for Application Gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayAvailableSslOption [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayAvailableSslOption** cmdlet gets all available ssl options for ssl policy + +## EXAMPLES + +### Example 1 +```powershell +$sslOptions = Get-AzApplicationGatewayAvailableSslOption +``` + +This commands returns all available ssl options for ssl policy. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAvailableSslOptions + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAvailableWafRuleSet.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAvailableWafRuleSet.md new file mode 100644 index 0000000000..bb21d98dd9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayAvailableWafRuleSet.md @@ -0,0 +1,64 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayavailablewafruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayAvailableWafRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayAvailableWafRuleSet.md +--- + +# Get-AzApplicationGatewayAvailableWafRuleSet + +## SYNOPSIS +Gets all available web application firewall rule sets. + +## SYNTAX + +``` +Get-AzApplicationGatewayAvailableWafRuleSet [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayAvailableWafRuleSet** cmdlet gets all available web application firewall rule sets. + +## EXAMPLES + +### Example 1 +```powershell +$availableRuleSets = Get-AzApplicationGatewayAvailableWafRuleSet +``` + +This commands returns all the available web application firewall rule sets. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAvailableWafRuleSetsResult + +## NOTES +**List-AzApplicationGatewayAvailableWafRuleSets** is an alias for the **Get-AzApplicationGatewayAvailableWafRuleSet** cmdlet. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayBackendAddressPool.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayBackendAddressPool.md new file mode 100644 index 0000000000..a441d0739e --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayBackendAddressPool.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 4B2066B6-51D7-46D8-8A72-1A232B3E6589 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaybackendaddresspool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayBackendAddressPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayBackendAddressPool.md +--- + +# Get-AzApplicationGatewayBackendAddressPool + +## SYNOPSIS +Gets a back-end address pool for an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayBackendAddressPool [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayBackendAddressPool** cmdlet gets one or more backend address pool configurations from an application gateway. + +## EXAMPLES + +### Example 1: Get a specified back-end server pool +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$BackendPool = Get-AzApplicationGatewayBackendAddressPool -Name "Pool01" -ApplicationGateway $AppGw +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command gets the back-end address pool associated with $AppGw named Pool01 and stores it in the $BackendPool variable. + +### Example 2: Get a list of back-end server pool +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$BackendPools = Get-AzApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command gets a list of the back-end address pools associated with $AppGw, and stores the list in the $BackendPools variable. + +## PARAMETERS + +### -ApplicationGateway +The **Get-AzApplicationGatewayBackendAddressPool** cmdlet gets a back-end address pool for an application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the back-end address pool that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayBackendAddressPool](./Add-AzApplicationGatewayBackendAddressPool.md) + +[New-AzApplicationGatewayBackendAddressPool](./New-AzApplicationGatewayBackendAddressPool.md) + +[Remove-AzApplicationGatewayBackendAddressPool](./Remove-AzApplicationGatewayBackendAddressPool.md) + +[Set-AzApplicationGatewayBackendAddressPool](./Set-AzApplicationGatewayBackendAddressPool.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayBackendHealth.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayBackendHealth.md new file mode 100644 index 0000000000..7b081cbc44 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayBackendHealth.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: D5E928C3-26B6-4B7C-8A9C-F1F602BABF75 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaybackendhealth +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayBackendHealth.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayBackendHealth.md +--- + +# Get-AzApplicationGatewayBackendHealth + +## SYNOPSIS +Gets application gateway backend health. + +## SYNTAX + +``` +Get-AzApplicationGatewayBackendHealth -Name <String> -ResourceGroupName <String> [-ExpandResource <String>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzApplicationGatewayBackendHealth cmdlet gets application gateway backend health. + +## EXAMPLES + +### Example 1: Gets backend health without expanded resources. +```powershell +$BackendHealth = Get-AzApplicationGatewayBackendHealth -Name ApplicationGateway01 -ResourceGroupName ResourceGroup01 +``` + +This command gets the backend health of application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $BackendHealth variable. + +### Example 2: Gets backend health with expanded resources. +```powershell +$BackendHealth = Get-AzApplicationGatewayBackendHealth -Name ApplicationGateway01 -ResourceGroupName ResourceGroup01 -ExpandResource "backendhealth/applicationgatewayresource" +``` + +This command gets the backend health (with expanded resources) of application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $BackendHealth variable. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandResource +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the application gateway that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the application gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHealth + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Get-AzApplicationGateway](./Get-AzApplicationGateway.md) + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayBackendHttpSetting.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayBackendHttpSetting.md new file mode 100644 index 0000000000..bef370039b --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayBackendHttpSetting.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaybackendhttpsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayBackendHttpSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayBackendHttpSetting.md +--- + +# Get-AzApplicationGatewayBackendHttpSetting + +## SYNOPSIS +Gets the back-end HTTP settings of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayBackendHttpSetting [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzApplicationGatewayBackendHttpSetting cmdlet gets the back-end HTTP settings of an application gateway. + +## EXAMPLES + +### Example 1: Get back-end HTTP settings by name +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Settings = Get-AzApplicationGatewayBackendHttpSetting -Name "Settings01" -ApplicationGateway $AppGw +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets the HTTP settings named Settings01 for $AppGw and stores the settings in the $Settings variable. + +### Example 2: Get a collection of back-end HTTP settings +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$SettingsList = Get-AzApplicationGatewayBackendHttpSetting -ApplicationGateway $AppGw +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets the collection of HTTP settings for $AppGw and stores the settings in the $SettingsList variable. + +## PARAMETERS + +### -ApplicationGateway +Specifies an application gateway object that contains back-end HTTP settings. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the backend HTTP settings that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayBackendHttpSetting](./Add-AzApplicationGatewayBackendHttpSetting.md) + +[New-AzApplicationGatewayBackendHttpSetting](./New-AzApplicationGatewayBackendHttpSetting.md) + +[Remove-AzApplicationGatewayBackendHttpSetting](./Remove-AzApplicationGatewayBackendHttpSetting.md) + +[Set-AzApplicationGatewayBackendHttpSetting](./Set-AzApplicationGatewayBackendHttpSetting.md) + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayBackendSetting.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayBackendSetting.md new file mode 100644 index 0000000000..e6c4fd6f89 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayBackendSetting.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaybackendsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayBackendSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayBackendSetting.md +--- + +# Get-AzApplicationGatewayBackendSetting + +## SYNOPSIS +Gets the back-end TCP\TLS settings of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayBackendSetting [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzApplicationGatewayBackendSetting cmdlet gets the back-end TCP\TLS settings of an application gateway. + +## EXAMPLES + +### Example 1: Get back-end TCP\TLS settings by name +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Settings = Get-AzApplicationGatewayBackendSetting -Name "Settings01" -ApplicationGateway $AppGw +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets the backend settings named Settings01 for $AppGw and stores the settings in the $Settings variable. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the backend settings + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendSettings + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayBackendSetting](./Add-AzApplicationGatewayBackendSetting.md) + +[New-AzApplicationGatewayBackendSetting](./New-AzApplicationGatewayBackendSetting.md) + +[Remove-AzApplicationGatewayBackendSetting](./Remove-AzApplicationGatewayBackendSetting.md) + +[Set-AzApplicationGatewayBackendSetting](./Set-AzApplicationGatewayBackendSetting.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayClientAuthConfiguration.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayClientAuthConfiguration.md new file mode 100644 index 0000000000..3973d36d67 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayClientAuthConfiguration.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayclientauthconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayClientAuthConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayClientAuthConfiguration.md +--- + +# Get-AzApplicationGatewayClientAuthConfiguration + +## SYNOPSIS +Gets the client authentication configuration of a SSL profile object. + +## SYNTAX + +``` +Get-AzApplicationGatewayClientAuthConfiguration -SslProfile <PSApplicationGatewaySslProfile> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayClientAuthConfiguration** cmdlet gets the client authentication configuration of a SSL profile object. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$SslProfile = Get-AzApplicationGatewaySslProfile -Name "SslProfile01" -ApplicationGateway $AppGw +$ClientAuthConfig = Get-AzApplicationGatewayClientAuthConfiguration -SslProfile $SslProfile +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. The second command gets the SSL profile named SslProfile01 for $AppGw and stores it $SslProfile variable. The last command gets the client authentication configuration from the SSL profile $SslProfile and stores it in the $ClientAuthConfig variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfile +The ssl profile + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayClientAuthConfiguration + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayClientAuthConfiguration](./New-AzApplicationGatewayClientAuthConfiguration.md) + +[Remove-AzApplicationGatewayClientAuthConfiguration](./Remove-AzApplicationGatewayClientAuthConfiguration.md) + +[Set-AzApplicationGatewayClientAuthConfiguration](./Set-AzApplicationGatewayClientAuthConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayConnectionDraining.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayConnectionDraining.md new file mode 100644 index 0000000000..b7f811561a --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayConnectionDraining.md @@ -0,0 +1,93 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayconnectiondraining +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayConnectionDraining.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayConnectionDraining.md +--- + +# Get-AzApplicationGatewayConnectionDraining + +## SYNOPSIS +Gets the connection draining configuration of a back-end HTTP settings object. + +## SYNTAX + +``` +Get-AzApplicationGatewayConnectionDraining -BackendHttpSettings <PSApplicationGatewayBackendHttpSettings> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayConnectionDraining** cmdlet gets the connection draining configuration of a back-end HTTP settings object. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Settings = Get-AzApplicationGatewayBackendHttpSetting -Name "Settings01" -ApplicationGateway $AppGw +$ConnectionDraining = Get-AzApplicationGatewayConnectionDraining -BackendHttpSettings $Settings +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command gets the back-end HTTP settings named Settings01 for $AppGw and stores the settings in the $Settings variable. +The last command gets the connection draining configuration from the back-end HTTP settings $Settings and stores it in the $ConnectionDraining variable. + +## PARAMETERS + +### -BackendHttpSettings +The backend http settings + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGateway](./Get-AzApplicationGateway.md) + +[Get-AzApplicationGatewayBackendHttpSetting](./Get-AzApplicationGatewayBackendHttpSetting.md) + +[New-AzApplicationGatewayConnectionDraining](./New-AzApplicationGatewayConnectionDraining.md) + +[Remove-AzApplicationGatewayConnectionDraining](./Remove-AzApplicationGatewayConnectionDraining.md) + +[Set-AzApplicationGatewayConnectionDraining](./Set-AzApplicationGatewayConnectionDraining.md) diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayCustomError.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayCustomError.md new file mode 100644 index 0000000000..67e2fd7c5d --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayCustomError.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaycustomerror +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayCustomError.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayCustomError.md +--- + +# Get-AzApplicationGatewayCustomError + +## SYNOPSIS +Gets custom error(s) from an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayCustomError [-StatusCode <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayCustomError** cmdlet gets custom error(s) from an application gateway. + +## EXAMPLES + +### Example 1: Gets a custom error in an application gateway +```powershell +$ce = Get-AzApplicationGatewayCustomError -ApplicationGateway $appgw -StatusCode HttpStatus502 +``` + +This command gets and returns the custom error of http status code 502 from the application gateway $appgw. + +### Example 2: Gets the list of all custom errors in an application gateway +```powershell +$ces = Get-AzApplicationGatewayCustomError -ApplicationGateway $appgw +``` + +This command gets and returns the list of all custom errors from the application gateway $appgw. + +## PARAMETERS + +### -ApplicationGateway +The Application Gateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusCode +Status code of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayCustomError](./Add-AzApplicationGatewayCustomError.md) + +[New-AzApplicationGatewayCustomError](./New-AzApplicationGatewayCustomError.md) + +[Remove-AzApplicationGatewayCustomError](./Remove-AzApplicationGatewayCustomError.md) + +[Set-AzApplicationGatewayCustomError](./Set-AzApplicationGatewayCustomError.md) diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayFirewallPolicy.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayFirewallPolicy.md new file mode 100644 index 0000000000..657ad2a6ee --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayFirewallPolicy.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayfirewallpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayFirewallPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayFirewallPolicy.md +--- + +# Get-AzApplicationGatewayFirewallPolicy + +## SYNOPSIS +Gets an application gateway firewall policy. + +## SYNTAX + +``` +Get-AzApplicationGatewayFirewallPolicy [-Name <String>] [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayFirewallPolicy** cmdlet gets an application gateway firewall policy.. + +## EXAMPLES + +### Example 1 +```powershell +$AppGwFirewallPolicy = Get-AzApplicationGatewayFirewallPolicy -Name "FirewallPolicy1" -ResourceGroupName "ResourceGroup01" +``` + +This command gets the application gateway firewall policy named FirewallPolicy1 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGwFirewallPolicy variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayFrontendIPConfig.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayFrontendIPConfig.md new file mode 100644 index 0000000000..488c9368b9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayFrontendIPConfig.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 364C41D0-A5DB-4AEF-853A-FE5A11AD9155 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayfrontendipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayFrontendIPConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayFrontendIPConfig.md +--- + +# Get-AzApplicationGatewayFrontendIPConfig + +## SYNOPSIS +Gets the front-end IP configuration of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayFrontendIPConfig [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayFrontendIPConfig** cmdlet gets the front-end IP configuration of an application gateway. + +## EXAMPLES + +### Example 1: Get a specified front-end IP configuration +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$FrontEndIP= Get-AzApplicationGatewayFrontendIPConfig -Name "FrontEndIP01" -ApplicationGateway $AppGw +``` + +The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets the front-end IP configuration named FrontEndIP01 from $AppGw and stores it in the $FrontEndIP variable. + +### Example 2: Get a list of front-end IP configurations +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$FrontEndIPs= Get-AzApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw +``` + +The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets a list of the front-end IP configurations from $AppGw and stores it in the $FrontEndIPs variable. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway object that contains the front-end IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the front-end IP configuration that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayFrontendIPConfig](./Add-AzApplicationGatewayFrontendIPConfig.md) + +[New-AzApplicationGatewayFrontendIPConfig](./New-AzApplicationGatewayFrontendIPConfig.md) + +[Remove-AzApplicationGatewayFrontendIPConfig](./Remove-AzApplicationGatewayFrontendIPConfig.md) + +[Set-AzApplicationGatewayFrontendIPConfig](./Set-AzApplicationGatewayFrontendIPConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayFrontendPort.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayFrontendPort.md new file mode 100644 index 0000000000..c821760fa9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayFrontendPort.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 4518D2A9-7DE7-4617-86E0-7778B8CFE48C +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayfrontendport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayFrontendPort.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayFrontendPort.md +--- + +# Get-AzApplicationGatewayFrontendPort + +## SYNOPSIS +Gets the front-end port of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayFrontendPort [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayFrontendPort** cmdlet gets the front-end port of an application gateway. + +## EXAMPLES + +### Example 1: Get a specified front-end port +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$FrontEndPort = Get-AzApplicationGatewayFrontendPort -Name "FrontEndPort01" -ApplicationGateway $AppGw +``` + +The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The second command gets the front-end port named FrontEndPort01 from $AppGw and stores it in the $FrontEndPort variable. + +### Example 2: Get a list of front-end ports +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$FrontEndPorts = Get-AzApplicationGatewayFrontendPort -ApplicationGateway $AppGw +``` + +The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The second command gets a list of the front-end ports from $AppGw and stores it in the $FrontEndPorts variable. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway object that contains the front-end port. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the front-end port to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayFrontendPort](./Add-AzApplicationGatewayFrontendPort.md) + +[New-AzApplicationGatewayFrontendPort](./New-AzApplicationGatewayFrontendPort.md) + +[Remove-AzApplicationGatewayFrontendPort](./Remove-AzApplicationGatewayFrontendPort.md) + +[Set-AzApplicationGatewayFrontendPort](./Set-AzApplicationGatewayFrontendPort.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayHttpListener.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayHttpListener.md new file mode 100644 index 0000000000..a27448743b --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayHttpListener.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 8D41EDAC-17D9-494B-8336-67906F4E1E81 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayhttplistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayHttpListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayHttpListener.md +--- + +# Get-AzApplicationGatewayHttpListener + +## SYNOPSIS +Gets the HTTP listener of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayHttpListener [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayHttpListener** cmdlet gets the HTTP listener of an application gateway. + +## EXAMPLES + +### Example 1: Get a specific HTTP listener +```powershell +$Appgw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Listener = Get-AzApplicationGatewayHttpListener -Name "Listener01" -ApplicationGateway $Appgw +``` + +This command gets an HTTP listener named Listener01. + +### Example 2: Get a list of HTTP listeners +```powershell +$Appgw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Listeners = Get-AzApplicationGatewayHttpListener -ApplicationGateway $Appgw +``` + +This command gets a list of HTTP listeners. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway object that contains the HTTP listener. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the HTTP listener which this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayHttpListener](./Add-AzApplicationGatewayHttpListener.md) + +[New-AzApplicationGatewayHttpListener](./New-AzApplicationGatewayHttpListener.md) + +[Remove-AzApplicationGatewayHttpListener](./Remove-AzApplicationGatewayHttpListener.md) + +[Set-AzApplicationGatewayHttpListener](./Set-AzApplicationGatewayHttpListener.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayHttpListenerCustomError.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayHttpListenerCustomError.md new file mode 100644 index 0000000000..ba60f819c9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayHttpListenerCustomError.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayhttplistenercustomerror +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayHttpListenerCustomError.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayHttpListenerCustomError.md +--- + +# Get-AzApplicationGatewayHttpListenerCustomError + +## SYNOPSIS +Gets custom error(s) from a http listener of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayHttpListenerCustomError [-StatusCode <String>] + -HttpListener <PSApplicationGatewayHttpListener> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayCustomError** cmdlet gets custom error(s) from a http listener of an application gateway. + +## EXAMPLES + +### Example 1: Gets a custom error in a http listener +```powershell +$ce = Get-AzApplicationGatewayHttpListenerCustomError -HttpListener $listener01 -StatusCode HttpStatus502 +``` + +This command gets and returns the custom error of http status code 502 from the http listener $listener01. + +### Example 2: Gets the list of all custom errors in a http listener +```powershell +$ces = Get-AzApplicationGatewayHttpListenerCustomError -HttpListener $listener01 +``` + +This command gets and returns the list of all custom errors from the http listener $listener01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpListener +The Application Gateway Http Listener + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StatusCode +Status code of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayHttpListenerCustomError](./Add-AzApplicationGatewayHttpListenerCustomError.md) + +[Remove-AzApplicationGatewayHttpListenerCustomError](./Remove-AzApplicationGatewayHttpListenerCustomError.md) + +[Set-AzApplicationGatewayHttpListenerCustomError](./Set-AzApplicationGatewayHttpListenerCustomError.md) diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayIPConfiguration.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayIPConfiguration.md new file mode 100644 index 0000000000..ad99b8e1bf --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayIPConfiguration.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 35562212-283C-4BB2-8B12-C3617A6760D0 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayipconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayIPConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayIPConfiguration.md +--- + +# Get-AzApplicationGatewayIPConfiguration + +## SYNOPSIS +Gets the IP configuration of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayIPConfiguration [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayIPConfiguration** cmdlet gets the IP configuration of an application gateway. +The IP configuration contains the subnet in which the application gateway is deployed. + +## EXAMPLES + +### Example 1: Get a specific IP configuration +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$GatewaySubnet = Get-AzApplicationGatewayIPConfiguration -Name "GatewaySubnet01" -ApplicationGateway $AppGw +``` + +The first command gets an application gateway and stores it in the $AppGw variable.The second command gets an IP configuration named GateSubnet01 from the gateway stored in $AppGw. + +### Example 2: Get a list of IP configurations +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$GatewaySubnets = Get-AzApplicationGatewayIPConfiguration -ApplicationGateway $AppGw +``` + +The first command gets an application gateway and stores it in the $AppGw variable.The second command gets a list of all IP configurations. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway object that contains IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the IP configuration which this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayIPConfiguration + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayIPConfiguration](./Add-AzApplicationGatewayIPConfiguration.md) + +[New-AzApplicationGatewayIPConfiguration](./New-AzApplicationGatewayIPConfiguration.md) + +[Remove-AzApplicationGatewayIPConfiguration](./Remove-AzApplicationGatewayIPConfiguration.md) + +[Set-AzApplicationGatewayIPConfiguration](./Set-AzApplicationGatewayIPConfiguration.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayIdentity.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayIdentity.md new file mode 100644 index 0000000000..889693d5ca --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayIdentity.md @@ -0,0 +1,80 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayidentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayIdentity.md +--- + +# Get-AzApplicationGatewayIdentity + +## SYNOPSIS +Get identity assigned to the application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayIdentity -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayIdentity** cmdlet gets identity assigned to the application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$gw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $resgpName +$identity = Get-AzApplicationGatewayIdentity -ApplicationGateway $gw +``` + +This examples shows how to get application gateway identity from Application Gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayListener.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayListener.md new file mode 100644 index 0000000000..0a8fc7538f --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayListener.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaylistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayListener.md +--- + +# Get-AzApplicationGatewayListener + +## SYNOPSIS +Gets the TCP\TLS listener of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayListener [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayListener** cmdlet gets the TCP\TLS listener of an application gateway. + +## EXAMPLES + +### Example 1: Get a specific TCP\TLS listener +```powershell +$Appgw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Listener = Get-AzApplicationGatewayListener -Name "Listener01" -ApplicationGateway $Appgw +``` + +This command gets a TCP\TLS listener named Listener01. + +### Example 2: Get a list of TCP\TLS listeners +```powershell +$Appgw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Listeners = Get-AzApplicationGatewayListener -ApplicationGateway $Appgw +``` + +This command gets a list of TCP\TLS listeners. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the application gateway listener + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayListener + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayListener](./Add-AzApplicationGatewayListener.md) + +[New-AzApplicationGatewayListener](./New-AzApplicationGatewayListener.md) + +[Remove-AzApplicationGatewayListener](./Remove-AzApplicationGatewayListener.md) + +[Set-AzApplicationGatewayListener](./Set-AzApplicationGatewayListener.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayPrivateLinkConfiguration.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayPrivateLinkConfiguration.md new file mode 100644 index 0000000000..8ef2f24c89 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayPrivateLinkConfiguration.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayprivatelinkconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayPrivateLinkConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayPrivateLinkConfiguration.md +--- + +# Get-AzApplicationGatewayPrivateLinkConfiguration + +## SYNOPSIS +Gets the private link configuration of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayPrivateLinkConfiguration -ApplicationGateway <PSApplicationGateway> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayPrivateLinkConfiguration** cmdlet gets the private link configuration of an application gateway. + +## EXAMPLES + +### Example 1 : Get a specified private link configuration +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$PrivateLinkConfiguration = Get-AzApplicationGatewayPrivateLinkConfiguration -Name "privateLinkConfig01" -ApplicationGateway $AppGw +``` + +The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The second command gets the private link configuration named privateLinkConfig01 from $AppGw and stores it in the $PrivateLinkConfiguration variable. + +### Example 2 : Get a list of private link configuration +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$PrivateLinkConfigurations = Get-AzApplicationGatewayPrivateLinkConfiguration -ApplicationGateway $AppGw +``` + +The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The second command gets all the private link configurations from $AppGw and stores it in the $PrivateLinkConfigurations variable. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the application gateway privateLink configuration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkConfiguration + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayPrivateLinkConfiguration](./New-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Add-AzApplicationGatewayPrivateLinkConfiguration](./Add-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Remove-AzApplicationGatewayPrivateLinkConfiguration](./Remove-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Set-AzApplicationGatewayPrivateLinkConfiguration](./Set-AzApplicationGatewayPrivateLinkConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayProbeConfig.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayProbeConfig.md new file mode 100644 index 0000000000..bfbe090190 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayProbeConfig.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayprobeconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayProbeConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayProbeConfig.md +--- + +# Get-AzApplicationGatewayProbeConfig + +## SYNOPSIS +Gets an existing health probe configuration from an Application Gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayProbeConfig [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzApplicationGatewayProbeConfig cmdlet gets an existing health probe configuration from an Application Gateway. + +## EXAMPLES + +### Example 1: Get an existing probe from an application gateway +```powershell +Get-AzApplicationGatewayProbeConfig -ApplicationGateway Gateway -Name "Probe02" +``` + +This command gets the health probe named Probe02 from the application gateway named Gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway to which this cmdlet gets a probe configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the probe. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe + +## NOTES + +## RELATED LINKS + +[Add a probe to an existing application gateway](https://azure.microsoft.com/en-us/documentation/articles/application-gateway-create-probe-ps/#add-a-probe-to-an-existing-application-gateway) + +[Add-AzApplicationGatewayProbeConfig](./Add-AzApplicationGatewayProbeConfig.md) + +[New-AzApplicationGatewayProbeConfig](./New-AzApplicationGatewayProbeConfig.md) + +[Remove-AzApplicationGatewayProbeConfig](./Remove-AzApplicationGatewayProbeConfig.md) + +[Set-AzApplicationGatewayProbeConfig](./Set-AzApplicationGatewayProbeConfig.md) + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayRedirectConfiguration.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayRedirectConfiguration.md new file mode 100644 index 0000000000..f71101d3c1 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayRedirectConfiguration.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayredirectconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayRedirectConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayRedirectConfiguration.md +--- + +# Get-AzApplicationGatewayRedirectConfiguration + +## SYNOPSIS +Gets an existing redirect configuration from an Application Gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayRedirectConfiguration [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayRedirectConfiguration** cmdlet gets an existing redirect configuration from an Application Gateway. + +## EXAMPLES + +### Example 1 +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$RedirectConfig = Get-AzApplicationGatewayRedirectConfiguration -Name "Redirect01" -ApplicationGateway $AppGW +``` + +The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. +The second command gets the redirect configuration named Redirect01 from the Application Gateway stored in the variable named $AppGW. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the request routing rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRedirectConfiguration](./Add-AzApplicationGatewayRedirectConfiguration.md) + +[New-AzApplicationGatewayRedirectConfiguration](./New-AzApplicationGatewayRedirectConfiguration.md) + +[Remove-AzApplicationGatewayRedirectConfiguration](./Remove-AzApplicationGatewayRedirectConfiguration.md) + +[Set-AzApplicationGatewayRedirectConfiguration](./Set-AzApplicationGatewayRedirectConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayRequestRoutingRule.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayRequestRoutingRule.md new file mode 100644 index 0000000000..c67529ff03 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayRequestRoutingRule.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 57A6DB40-43EC-402C-9784-06817ECD99B8 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayrequestroutingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayRequestRoutingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayRequestRoutingRule.md +--- + +# Get-AzApplicationGatewayRequestRoutingRule + +## SYNOPSIS +Gets the request routing rule of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayRequestRoutingRule [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayRequestRoutingRule** cmdlet gets the request routing rule of an application gateway. + +## EXAMPLES + +### Example 1: Get a specific request routing rule +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Rule = Get-AzApplicationGatewayRequestRoutingRule -Name "Rule01" -ApplicationGateway $AppGW +``` + +The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. +The second command gets the request routing rule named Rule01 from the Application Gateway stored in the variable named $AppGW. + +### Example 2: Get a list of request routing rules +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Rules = Get-AzApplicationGatewayRequestRoutingRule -ApplicationGateway $AppGW +``` + +The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. +The second command gets a list of request routing rules from the Application Gateway stored in the variable named $AppGW. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway object that contains request routing rule. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the request routing rule which this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRequestRoutingRule](./Add-AzApplicationGatewayRequestRoutingRule.md) + +[New-AzApplicationGatewayRequestRoutingRule](./New-AzApplicationGatewayRequestRoutingRule.md) + +[Remove-AzApplicationGatewayRequestRoutingRule](./Remove-AzApplicationGatewayRequestRoutingRule.md) + +[Set-AzApplicationGatewayRequestRoutingRule](./Set-AzApplicationGatewayRequestRoutingRule.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayRewriteRuleSet.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayRewriteRuleSet.md new file mode 100644 index 0000000000..70c4c76c06 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayRewriteRuleSet.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayrewriteruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayRewriteRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayRewriteRuleSet.md +--- + +# Get-AzApplicationGatewayRewriteRuleSet + +## SYNOPSIS +Gets the rewrite rule set of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayRewriteRuleSet [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the rewrite rule set of an application gateway. + +## EXAMPLES + +### Example 1 : Get a specific rewrite rule set +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Rule = Get-AzApplicationGatewayRewriteRuleSet -Name "RuleSet01" -ApplicationGateway $AppGW +``` + +The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. +The second command gets the rewrite rule set named RuleSet01 from the Application Gateway stored in the variable named $AppGW. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the application gateway RewriteRuleSet + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleSet + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRewriteRuleSet](./Add-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRuleSet](./New-AzApplicationGatewayRewriteRuleSet.md) + +[Remove-AzApplicationGatewayRewriteRuleSet](./Remove-AzApplicationGatewayRewriteRuleSet.md) + +[Set-AzApplicationGatewayRewriteRuleSet](./Set-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRule](./New-AzApplicationGatewayRewriteRule.md) + +[New-AzApplicationGatewayRewriteRuleActionSet](./New-AzApplicationGatewayRewriteRuleActionSet.md) + +[New-AzApplicationGatewayRewriteRuleHeaderConfiguration](./New-AzApplicationGatewayRewriteRuleHeaderConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayRoutingRule.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayRoutingRule.md new file mode 100644 index 0000000000..586b8a781e --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayRoutingRule.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayroutingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayRoutingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayRoutingRule.md +--- + +# Get-AzApplicationGatewayRoutingRule + +## SYNOPSIS +Gets the routing rule of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayRoutingRule [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayRoutingRule** cmdlet gets the routing rule of an application gateway. + +## EXAMPLES + +### Example 1: Get a specific routing rule +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Rule = Get-AzApplicationGatewayRoutingRule -Name "Rule01" -ApplicationGateway $AppGW +``` + +The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. +The second command gets the routing rule named Rule01 from the Application Gateway stored in the variable named $AppGW. + +### Example 2: Get a list of routing rules +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Rules = Get-AzApplicationGatewayRoutingRule -ApplicationGateway $AppGW +``` + +The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. +The second command gets a list of routing rules from the Application Gateway stored in the variable named $AppGW. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the routing rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRoutingRule + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRoutingRule](./Add-AzApplicationGatewayRoutingRule.md) + +[New-AzApplicationGatewayRoutingRule](./New-AzApplicationGatewayRoutingRule.md) + +[Remove-AzApplicationGatewayRoutingRule](./Remove-AzApplicationGatewayRoutingRule.md) + +[Set-AzApplicationGatewayRoutingRule](./Set-AzApplicationGatewayRoutingRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySku.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySku.md new file mode 100644 index 0000000000..e8d5936836 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySku.md @@ -0,0 +1,88 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: F01CB88A-49E7-41D8-B4E7-F1A4DCDC6B84 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaysku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewaySku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewaySku.md +--- + +# Get-AzApplicationGatewaySku + +## SYNOPSIS +Gets the SKU of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewaySku -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewaySku** cmdlet gets the stock keeping unit (SKU) of an application gateway. + +## EXAMPLES + +### Example 1: Get an application gateway SKU +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$SKU = Get-AzApplicationGatewaySku -ApplicationGateway $AppGW +``` + +The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. +The second command gets the SKU of an application gateway named ApplicationGateway01 and stores the result in the variable named $SKU. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewaySku](./New-AzApplicationGatewaySku.md) + +[Set-AzApplicationGatewaySku](./Set-AzApplicationGatewaySku.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslCertificate.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslCertificate.md new file mode 100644 index 0000000000..629c09b00c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslCertificate.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 919B3755-81D4-43FB-AE8C-B071329A61D9 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaysslcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewaySslCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewaySslCertificate.md +--- + +# Get-AzApplicationGatewaySslCertificate + +## SYNOPSIS +Gets an SSL certificate for an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewaySslCertificate [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewaySslCertificate** cmdlet gets an SSL certificate for an application gateway. + +## EXAMPLES + +### Example 1: Get a specific SSL certificate +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Cert = Get-AzApplicationGatewaySslCertificate -Name "Cert01" -ApplicationGateway $AppGW +``` + +The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. +The second command gets the SSL certificate named Cert01 from the application gateway stored in the variable named $AppGW. +The command stores the certificate in the variable named $Cert. + +### Example 2: Get a list of SSL certificates +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Certs = Get-AzApplicationGatewaySslCertificate -ApplicationGateway $AppGW +``` + +The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. +This second command gets a list of SSL certificates from the application gateway stored in the variable named $AppGW. +The command then stores the results in the variable named $Certs. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway object that contains the SSL certificate. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of SSL certificate pool that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewaySslCertificate](./Add-AzApplicationGatewaySslCertificate.md) + +[New-AzApplicationGatewaySslCertificate](./New-AzApplicationGatewaySslCertificate.md) + +[Remove-AzApplicationGatewaySslCertificate](./Remove-AzApplicationGatewaySslCertificate.md) + +[Set-AzApplicationGatewaySslCertificate](./Set-AzApplicationGatewaySslCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslPolicy.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslPolicy.md new file mode 100644 index 0000000000..0eab6db672 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslPolicy.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: AF02FFF8-F00D-4446-968F-F3C9008C39F0 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaysslpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewaySslPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewaySslPolicy.md +--- + +# Get-AzApplicationGatewaySslPolicy + +## SYNOPSIS +Gets the SSL policy of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewaySslPolicy -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewaySslPolicy** cmdlet gets the SSL policy of an application gateway. + +## EXAMPLES + +### 1: +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$sslpolicy = Get-AzApplicationGatewaySslPolicy -ApplicationGateway $AppGW +``` + +The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. +The second command gets the ssl policy from the Application Gateway stored in the variable named $AppGW. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway of the SSL policy that this cmdlet gets. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[New-AzApplicationGatewaySslPolicy](./New-AzApplicationGatewaySslPolicy.md) + +[Set-AzApplicationGatewaySslPolicy](./Set-AzApplicationGatewaySslPolicy.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslPredefinedPolicy.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslPredefinedPolicy.md new file mode 100644 index 0000000000..5bbfeef913 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslPredefinedPolicy.md @@ -0,0 +1,234 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaysslpredefinedpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewaySslPredefinedPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewaySslPredefinedPolicy.md +--- + +# Get-AzApplicationGatewaySslPredefinedPolicy + +## SYNOPSIS +Gets Predefined SSL Policies provided by Application Gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewaySslPredefinedPolicy [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewaySslPredefinedPolicy** cmdlet gets Predefined SSL Policies provided by Application Gateway. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzApplicationGatewaySslPredefinedPolicy +``` + +```output +Name: AppGwSslPolicy20150501 +MinProtocolVersion: TLSv1_0 +CipherSuites: + TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 + TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 + TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 + TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA + TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA + TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 + TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 + TLS_DHE_RSA_WITH_AES_256_CBC_SHA + TLS_DHE_RSA_WITH_AES_128_CBC_SHA + TLS_RSA_WITH_AES_256_GCM_SHA384 + TLS_RSA_WITH_AES_128_GCM_SHA256 + TLS_RSA_WITH_AES_256_CBC_SHA256 + TLS_RSA_WITH_AES_128_CBC_SHA256 + TLS_RSA_WITH_AES_256_CBC_SHA + TLS_RSA_WITH_AES_128_CBC_SHA + TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 + TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA + TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 + TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 + TLS_DHE_DSS_WITH_AES_256_CBC_SHA + TLS_DHE_DSS_WITH_AES_128_CBC_SHA + TLS_RSA_WITH_3DES_EDE_CBC_SHA + TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA + + +Name: AppGwSslPolicy20170401 +MinProtocolVersion: TLSv1_1 +CipherSuites: + TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 + TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 + TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA + TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA + TLS_RSA_WITH_AES_256_GCM_SHA384 + TLS_RSA_WITH_AES_128_GCM_SHA256 + TLS_RSA_WITH_AES_256_CBC_SHA256 + TLS_RSA_WITH_AES_128_CBC_SHA256 + TLS_RSA_WITH_AES_256_CBC_SHA + TLS_RSA_WITH_AES_128_CBC_SHA + + +Name: AppGwSslPolicy20170401S +MinProtocolVersion: TLSv1_2 +CipherSuites: + TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 + TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 + TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA + TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA + TLS_RSA_WITH_AES_256_GCM_SHA384 + TLS_RSA_WITH_AES_128_GCM_SHA256 + TLS_RSA_WITH_AES_256_CBC_SHA256 + TLS_RSA_WITH_AES_128_CBC_SHA256 + TLS_RSA_WITH_AES_256_CBC_SHA + TLS_RSA_WITH_AES_128_CBC_SHA +``` + +This commands returns all the predefined SSL policies. + +### Example 2 +```powershell +Get-AzApplicationGatewaySslPredefinedPolicy -Name AppGwSslPolicy20170401 +``` + +```output +Name: AppGwSslPolicy20170401 +MinProtocolVersion: TLSv1_1 +CipherSuites: + TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 + TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 + TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA + TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA + TLS_RSA_WITH_AES_256_GCM_SHA384 + TLS_RSA_WITH_AES_128_GCM_SHA256 + TLS_RSA_WITH_AES_256_CBC_SHA256 + TLS_RSA_WITH_AES_128_CBC_SHA256 + TLS_RSA_WITH_AES_256_CBC_SHA + TLS_RSA_WITH_AES_128_CBC_SHA +``` + +This commands returns predefined policy with name AppGwSslPolicy20170401. + +### Example 3 +```powershell +Get-AzApplicationGatewaySslPredefinedPolicy -Name AppGwSslPolicy2017* +``` + +```output +Name: AppGwSslPolicy20170401 +MinProtocolVersion: TLSv1_1 +CipherSuites: + TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 + TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 + TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA + TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA + TLS_RSA_WITH_AES_256_GCM_SHA384 + TLS_RSA_WITH_AES_128_GCM_SHA256 + TLS_RSA_WITH_AES_256_CBC_SHA256 + TLS_RSA_WITH_AES_128_CBC_SHA256 + TLS_RSA_WITH_AES_256_CBC_SHA + TLS_RSA_WITH_AES_128_CBC_SHA + + +Name: AppGwSslPolicy20170401S +MinProtocolVersion: TLSv1_2 +CipherSuites: + TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 + TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 + TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA + TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA + TLS_RSA_WITH_AES_256_GCM_SHA384 + TLS_RSA_WITH_AES_128_GCM_SHA256 + TLS_RSA_WITH_AES_256_CBC_SHA256 + TLS_RSA_WITH_AES_128_CBC_SHA256 + TLS_RSA_WITH_AES_256_CBC_SHA + TLS_RSA_WITH_AES_128_CBC_SHA +``` + +This commands returns predefined policy with name starting with "AppGwSslPolicy2017". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the ssl predefined policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPredefinedPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslProfile.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslProfile.md new file mode 100644 index 0000000000..0e37d476f1 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslProfile.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaysslprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewaySslProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewaySslProfile.md +--- + +# Get-AzApplicationGatewaySslProfile + +## SYNOPSIS +Gets the SSL profile of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewaySslProfile [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewaySslProfile** cmdlet gets the SSL profile of an application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$profile = Get-AzApplicationGatewaySslProfile -Name "SslProfile01" -ApplicationGateway $AppGw +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets the SSL profile SslProfile01 for $AppGw and stores it in the $profile variable. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ssl profile + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewaySslProfile](./New-AzApplicationGatewaySslProfile.md) + +[Add-AzApplicationGatewaySslProfile](./Add-AzApplicationGatewaySslProfile.md) + +[Remove-AzApplicationGatewaySslProfile](./Remove-AzApplicationGatewaySslProfile.md) + +[Set-AzApplicationGatewaySslProfile](./Set-AzApplicationGatewaySslProfile.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslProfilePolicy.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslProfilePolicy.md new file mode 100644 index 0000000000..dabed46458 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewaySslProfilePolicy.md @@ -0,0 +1,85 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaysslprofilepolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewaySslProfilePolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewaySslProfilePolicy.md +--- + +# Get-AzApplicationGatewaySslProfilePolicy + +## SYNOPSIS +Gets the SSL policy of an application gateway SSL profile. + +## SYNTAX + +``` +Get-AzApplicationGatewaySslProfilePolicy -SslProfile <PSApplicationGatewaySslProfile> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewaySslProfilePolicy** cmdlet gets the SSL policy of an application gateway SSL profile. + +## EXAMPLES + +### Example 1 +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$SslProfile = Get-AzApplicationGatewaySslProfile -Name "SslProfile01" -ApplicationGateway $AppGw +$sslpolicy = Get-AzApplicationGatewaySslProfilePolicy -SslProfile $SslProfile +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. The second command gets the SSL profile named SslProfile01 for $AppGw and stores it $SslProfile variable. The last command gets the SSL policy from the SSL profile $SslProfile and stores it in the $sslpolicy variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfile +The application Gateway SSL profile + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy + +## NOTES + +## RELATED LINKS + +[Remove-AzApplicationGatewaySslProfilePolicy](./Remove-AzApplicationGatewaySslProfilePolicy.md) + +[Set-AzApplicationGatewaySslProfilePolicy](./Set-AzApplicationGatewaySslProfilePolicy.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayTrustedClientCertificate.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayTrustedClientCertificate.md new file mode 100644 index 0000000000..4c2e26654c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayTrustedClientCertificate.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaytrustedclientcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayTrustedClientCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayTrustedClientCertificate.md +--- + +# Get-AzApplicationGatewayTrustedClientCertificate + +## SYNOPSIS +Gets the trusted client CA certificate chain with a specific name from the Application Gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayTrustedClientCertificate [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzApplicationGatewayTrustedClientCertificate cmdlet gets the trusted client CA certificate chain with a specific name from the Application Gateway. + +## EXAMPLES + +### Example 1 +```powershell +$gw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $resgpName +$trustedClientCert = Get-AzApplicationGatewayTrustedClientCertificate -ApplicationGateway $gw -Name $certName +``` + +The first command gets the Application Gateway and stores it in $gw variable. The second command gets the trusted client CA certificate chain with a specified name from the Application Gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the trusted client CA certificate chain + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedClientCertificate + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayTrustedClientCertificate](./New-AzApplicationGatewayTrustedClientCertificate.md) + +[Add-AzApplicationGatewayTrustedClientCertificate](./Add-AzApplicationGatewayTrustedClientCertificate.md) + +[Remove-AzApplicationGatewayTrustedClientCertificate](./Remove-AzApplicationGatewayTrustedClientCertificate.md) + +[Set-AzApplicationGatewayTrustedClientCertificate](./Set-AzApplicationGatewayTrustedClientCertificate.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayTrustedRootCertificate.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayTrustedRootCertificate.md new file mode 100644 index 0000000000..586214b61b --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayTrustedRootCertificate.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaytrustedrootcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayTrustedRootCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayTrustedRootCertificate.md +--- + +# Get-AzApplicationGatewayTrustedRootCertificate + +## SYNOPSIS +Gets the Trusted Root Certificate with a specific name from the Application Gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayTrustedRootCertificate [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayTrustedRootCertificate** cmdlet gets Trusted Root Certificate with a specific name from the Application Gateway. + +## EXAMPLES + +### Example 1 +```powershell +$gw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $resgpName +$trustedRootCert = Get-AzApplicationGatewayTrustedRootCertificate -ApplicationGateway $gw -Name $certName +``` + +The first command gets the Application Gateway and stores it in $gw variable. +The second command gets the Trusted Root Certificate with a specified name from the Application Gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the TrustedRoot certificate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayTrustedRootCertificate](./Add-AzApplicationGatewayTrustedRootCertificate.md) + +[New-AzApplicationGatewayTrustedRootCertificate](./New-AzApplicationGatewayTrustedRootCertificate.md) + +[Remove-AzApplicationGatewayTrustedRootCertificate](./Remove-AzApplicationGatewayTrustedRootCertificate.md) + +[Set-AzApplicationGatewayTrustedRootCertificate](./Set-AzApplicationGatewayTrustedRootCertificate.md) diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayUrlPathMapConfig.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayUrlPathMapConfig.md new file mode 100644 index 0000000000..1ad02b82d4 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayUrlPathMapConfig.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 000B32E9-FFFB-4165-87ED-F19A6E6CEE54 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewayurlpathmapconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayUrlPathMapConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayUrlPathMapConfig.md +--- + +# Get-AzApplicationGatewayUrlPathMapConfig + +## SYNOPSIS +Gets an array of URL path mappings to a backend server pool. + +## SYNTAX + +``` +Get-AzApplicationGatewayUrlPathMapConfig [-Name <String>] -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayURLPathMapConfig** cmdlet gets an array of URL path mappings to a backend server pool. + +## EXAMPLES + +### Example 1: Get a URL path map configuration +```powershell +Get-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway Gateway +``` + +This command gets the URL path map configurations from the backend server located on the application gateway named Gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway to which this cmdlet gets a URL path map configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the URL path map name in which this cmdlet get the path map configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayUrlPathMapConfig](./Add-AzApplicationGatewayUrlPathMapConfig.md) + +[New-AzApplicationGatewayUrlPathMapConfig](./New-AzApplicationGatewayUrlPathMapConfig.md) + +[Remove-AzApplicationGatewayUrlPathMapConfig](./Remove-AzApplicationGatewayUrlPathMapConfig.md) + +[Set-AzApplicationGatewayUrlPathMapConfig](./Set-AzApplicationGatewayUrlPathMapConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayWafDynamicManifest.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayWafDynamicManifest.md new file mode 100644 index 0000000000..541d4c03e8 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayWafDynamicManifest.md @@ -0,0 +1,79 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaywafdynamicmanifest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayWafDynamicManifest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayWafDynamicManifest.md +--- + +# Get-AzApplicationGatewayWafDynamicManifest + +## SYNOPSIS +Gets the web application firewall manifest and all the supported rule sets. + +## SYNTAX + +``` +Get-AzApplicationGatewayWafDynamicManifest -Location <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayWafDynamicManifest** cmdlet gets athe web application firewall manifest and all the supported rule sets . + +## EXAMPLES + +### Example 1 +```powershell +$wafManifest = Get-AzApplicationGatewayWafDynamicManifest -Location westcentralus +``` + +This commands returns the web application firewall manifest and all the supported rule sets. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location where resource usage is queried. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSUsage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationGatewayWebApplicationFirewallConfiguration.md b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayWebApplicationFirewallConfiguration.md new file mode 100644 index 0000000000..3e1e3a8548 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationGatewayWebApplicationFirewallConfiguration.md @@ -0,0 +1,91 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 5D887302-7678-44C0-86F3-CEF2EF8A0991 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationgatewaywebapplicationfirewallconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayWebApplicationFirewallConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationGatewayWebApplicationFirewallConfiguration.md +--- + +# Get-AzApplicationGatewayWebApplicationFirewallConfiguration + +## SYNOPSIS +Gets the WAF configuration of an application gateway. + +## SYNTAX + +``` +Get-AzApplicationGatewayWebApplicationFirewallConfiguration -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationGatewayWebApplicationFirewallConfiguration** cmdlet gets the web application firewall (WAF) configuration of an application gateway. + +## EXAMPLES + +### Example 1: Get an application gateway web application firewall configuration +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$FirewallConfig = Get-AzApplicationGatewayWebApplicationFirewallConfiguration -ApplicationGateway $AppGW +``` + +The first command gets the application gateway named ApplicationGateway01, and then stores it in the $AppGW variable. +The second command gets the firewall configuration of the application gateway in $AppGW, and then stores it in $FirewallConfig. + +## PARAMETERS + +### -ApplicationGateway +Specifies an application gateway object. +You can use the Get-AzApplicationGateway cmdlet to get an application gateway object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallConfiguration + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGateway](./Get-AzApplicationGateway.md) + +[New-AzApplicationGatewayWebApplicationFirewallConfiguration](./New-AzApplicationGatewayWebApplicationFirewallConfiguration.md) + +[Set-AzApplicationGatewayWebApplicationFirewallConfiguration](./Set-AzApplicationGatewayWebApplicationFirewallConfiguration.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzApplicationSecurityGroup.md b/azps-10.1.0/Az.Network/Get-AzApplicationSecurityGroup.md new file mode 100644 index 0000000000..09b5073d00 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzApplicationSecurityGroup.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azapplicationsecuritygroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationSecurityGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzApplicationSecurityGroup.md +--- + +# Get-AzApplicationSecurityGroup + +## SYNOPSIS +Gets an application security group. + +## SYNTAX + +``` +Get-AzApplicationSecurityGroup [-ResourceGroupName <String>] [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzApplicationSecurityGroup** cmdlet gets an application security group. + +## EXAMPLES + +### Example 1: Retrieve all application security groups. +```powershell +Get-AzApplicationSecurityGroup +``` + +```output +ProvisioningState : Succeeded +ResourceGroupName : MyResourceGroup +Location : southcentralus +ResourceGuid : +Type : Microsoft.Network/applicationSecurityGroups +Tag : {} +TagsTable : +Name : MyApplicationSecurityGroup1 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsof + t.Network/applicationSecurityGroups/MyApplicationSecurityGroup1 + +ProvisioningState : Succeeded +ResourceGroupName : MyResourceGroup +Location : southcentralus +ResourceGuid : +Type : Microsoft.Network/applicationSecurityGroups +Tag : {} +TagsTable : +Name : MyApplicationSecurityGroup2 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsof + t.Network/applicationSecurityGroups/MyApplicationSecurityGroup2 +``` + +The command above returns the all application security groups in the subscription. + +### Example 2: Retrieve application security groups in a resource group. +```powershell +Get-AzApplicationSecurityGroup -ResourceGroupName MyResourceGroup +``` + +```output +ProvisioningState : Succeeded +ResourceGroupName : MyResourceGroup +Location : southcentralus +ResourceGuid : +Type : Microsoft.Network/applicationSecurityGroups +Tag : {} +TagsTable : +Name : MyApplicationSecurityGroup1 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsof + t.Network/applicationSecurityGroups/MyApplicationSecurityGroup1 + +ProvisioningState : Succeeded +ResourceGroupName : MyResourceGroup +Location : southcentralus +ResourceGuid : +Type : Microsoft.Network/applicationSecurityGroups +Tag : {} +TagsTable : +Name : MyApplicationSecurityGroup2 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsof + t.Network/applicationSecurityGroups/MyApplicationSecurityGroup2 +``` + +The command above returns all application security groups that belong to the resource group MyResourceGroup. + +### Example 3: Retrieve a specific application security group. +```powershell +Get-AzApplicationSecurityGroup -ResourceGroupName MyResourceGroup -Name MyApplicationSecurityGroup1 +``` + +```output +ProvisioningState : Succeeded +ResourceGroupName : MyResourceGroup +Location : southcentralus +ResourceGuid : +Type : Microsoft.Network/applicationSecurityGroups +Tag : {} +TagsTable : +Name : MyApplicationSecurityGroup1 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsof + t.Network/applicationSecurityGroups/MyApplicationSecurityGroup1 +``` + +The command above returns the application security group MyApplicationSecurityGroup under the resource group MyResourceGroup. + +### Example 4: Retrieve application security groups using filtering. +```powershell +Get-AzApplicationSecurityGroup -Name MyApplicationSecurityGroup* +``` + +```output +ProvisioningState : Succeeded +ResourceGroupName : MyResourceGroup +Location : southcentralus +ResourceGuid : +Type : Microsoft.Network/applicationSecurityGroups +Tag : {} +TagsTable : +Name : MyApplicationSecurityGroup1 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsof + t.Network/applicationSecurityGroups/MyApplicationSecurityGroup1 + +ProvisioningState : Succeeded +ResourceGroupName : MyResourceGroup +Location : southcentralus +ResourceGuid : +Type : Microsoft.Network/applicationSecurityGroups +Tag : {} +TagsTable : +Name : MyApplicationSecurityGroup2 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsof + t.Network/applicationSecurityGroups/MyApplicationSecurityGroup2 +``` + +The command above returns all application security groups that start with "MyApplicationSecurityGroup". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup + +## NOTES + +## RELATED LINKS + +[New-AzApplicationSecurityGroup](./New-AzApplicationSecurityGroup.md) + +[Remove-AzApplicationSecurityGroup](./Remove-AzApplicationSecurityGroup.md) + +[Get-AzNetworkSecurityRuleConfig](./Get-AzNetworkSecurityRuleConfig.md) + +[Get-AzNetworkInterfaceIpConfig](./Get-AzNetworkInterfaceIpConfig.md) diff --git a/azps-10.1.0/Az.Network/Get-AzAutoApprovedPrivateLinkService.md b/azps-10.1.0/Az.Network/Get-AzAutoApprovedPrivateLinkService.md new file mode 100644 index 0000000000..4d0e3f6e15 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzAutoApprovedPrivateLinkService.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azautoapprovedprivatelinkservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzAutoApprovedPrivateLinkService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzAutoApprovedPrivateLinkService.md +--- + +# Get-AzAutoApprovedPrivateLinkService + +## SYNOPSIS +Gets an array of private link service id that can be linked to a private end point with auto approved. + +## SYNTAX + +``` +Get-AzAutoApprovedPrivateLinkService -Location <String> [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzAutoApprovedPrivateLinkService** gets an array of private link service id that can be linked to a private end point with auto approved. + +## EXAMPLES + +### Example +```powershell +Get-AzAutoApprovedPrivateLinkService -Location westus -ResourceGroupName TestResourceGroup +``` + +This example return an array of private link service id that can be linked to a private end point with auto approved. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAutoApprovedPrivateLinkService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzAvailablePrivateEndpointType.md b/azps-10.1.0/Az.Network/Get-AzAvailablePrivateEndpointType.md new file mode 100644 index 0000000000..16f17da095 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzAvailablePrivateEndpointType.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azavailableprivateendpointtype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzAvailablePrivateEndpointType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzAvailablePrivateEndpointType.md +--- + +# Get-AzAvailablePrivateEndpointType + +## SYNOPSIS +Return available private end point types in the location. + +## SYNTAX + +``` +Get-AzAvailablePrivateEndpointType -Location <String> [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzAvailablePrivateEndpointType** cmdlet returns all available private end point types in the location. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAvailablePrivateEndpointType -Location eastus +``` + +```output +[ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/availablePrivateEndpointTypes/typename1", + "type": "Microsoft.Network/availablePrivateEndpointType", + "resourceName": "Microsoft.Sql/servers" + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/availablePrivateEndpointTypes/typename2", + "type": "Microsoft.Network/availablePrivateEndpointType", + "resourceName": "Microsoft.Storage/accounts" + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/availablePrivateEndpointTypes/typename3", + "type": "Microsoft.Network/availablePrivateEndpointType", + "resourceName": "Microsoft.Cosmos/cosmosDbAccounts" + } +] +``` + +This example returns all available private end point types in the location. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAvailablePrivateEndpointType + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzAvailableServiceAlias.md b/azps-10.1.0/Az.Network/Get-AzAvailableServiceAlias.md new file mode 100644 index 0000000000..45b7feef68 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzAvailableServiceAlias.md @@ -0,0 +1,83 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azavailableservicealias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzAvailableServiceAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzAvailableServiceAlias.md +--- + +# Get-AzAvailableServiceAlias + +## SYNOPSIS +Get available service aliases in the region. + +## SYNTAX + +``` +Get-AzAvailableServiceAlias -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzAvailableServiceAlias** cmdlet allows you to retrieve all of the available service aliases for a subnet in the provided location. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAvailableServiceAlias -Location "westus" +``` + +```output +Name Id Type ResourceName +---- -- ---- ------------ +servicesAzure /subscriptions/61dc4623-b5f8-41a0-acfc-29537dcf6e5d/providers/Microsoft.Network/AvailableServiceAliases/servicesAzure Microsoft.Network/AvailableServiceAliases /services/Azure +servicesAzureManagedInstance /subscriptions/61dc4623-b5f8-41a0-acfc-29537dcf6e5d/providers/Microsoft.Network/AvailableServiceAliases/servicesAzureManagedInstance Microsoft.Network/AvailableServiceAliases /services/Azure/ManagedInstance +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PsAvailableServiceAlias + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzAvailableServiceDelegation.md b/azps-10.1.0/Az.Network/Get-AzAvailableServiceDelegation.md new file mode 100644 index 0000000000..6f36d01b4a --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzAvailableServiceDelegation.md @@ -0,0 +1,96 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azavailableservicedelegation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzAvailableServiceDelegation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzAvailableServiceDelegation.md +--- + +# Get-AzAvailableServiceDelegation + +## SYNOPSIS +Get available service delegations in the region. + +## SYNTAX + +``` +Get-AzAvailableServiceDelegation -Location <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzAvailableServiceDelegation** cmdlet allows you to retrieve all of the available service delegations for a subnet in the provided location. This cmdlet does *not* describe which delegations may co-exist on a single subnet. + +## EXAMPLES + +### Example 1: Getting all available service delegations +```powershell +Get-AzAvailableServiceDelegation -Location "westus" +``` + +```output +Name : Microsoft.Web.serverFarms +Id : /subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Web.serverFarms +Type : Microsoft.Network/availableDelegations +ServiceName : Microsoft.Web/serverFarms +Actions : {Microsoft.Network/virtualNetworks/subnets/action} + +Name : Microsoft.Sql.servers +Id : /subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Sql.servers +Type : Microsoft.Network/availableDelegations +ServiceName : Microsoft.Sql/servers +Actions : {} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAvailableDelegation + +## NOTES + +## RELATED LINKS + +[Add-AzDelegation](./Add-AzDelegation.md) +[New-AzDelegation](./New-AzDelegation.md) +[Remove-AzDelegation](./Remove-AzDelegation.md) +[Get-AzDelegation](./Get-AzDelegation.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzBastion.md b/azps-10.1.0/Az.Network/Get-AzBastion.md new file mode 100644 index 0000000000..ad27086afa --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzBastion.md @@ -0,0 +1,324 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azbastion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzBastion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzBastion.md +--- + +# Get-AzBastion + +## SYNOPSIS +Gets a Bastion resource or Bastion resources. + +## SYNTAX + +### ListBySubscriptionId (Default) +``` +Get-AzBastion [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ListByResourceGroupName +``` +Get-AzBastion [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceGroupNameByName +``` +Get-AzBastion -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzBastion -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-Bastion** cmdlet gets one or more bastions in a resource group or subscritption. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzBastion +``` + +```output +ResourceGroupName : abagarwaProd-PPTest +Location : westcentralus +ResourceGuid : +Type : Microsoft.Network/bastionHosts +Tag : {} +TagsTable : +Name : abagarwaProd-PPTest-vnet-bastion +Etag : W/"55702e34-348f-4b79-bf44-9c306623b7c7" +Id : /subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/abagarwaProd-PPTest/providers/Microsoft.Network/bastionHosts/abagarwaProd-PPTest-vnet-bastion + +IpConfigurations : {IpConf} +DnsName : bst-f594cc74-c21e-44c3-ad5e-5bb93933965f.bastion.azure.com +ProvisioningState : Succeeded +IpConfigurationsText : [ + { + "Name": "IpConf", + "Etag": "W/\"7ae27d14-9260-4e2d-8c48-47e9628a3e3b\"", + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionTest/providers/Microsoft.Network/bastionHosts/BastionTest-vnet-bastion/bastionHostIpConfigurations/IpConf", + "Subnet": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionTest/providers/Microsoft.Network/virtualNetworks/BastionTest-vnet/subnets/default" + }, + "PublicIpAddress": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionTest/providers/Microsoft.Network/publicIPAddresses/BastionTest-vnet-ip" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAllocationMethod": "Dynamic" + } + ] +ResourceGroupName : BastionTest +Location : westcentralus +ResourceGuid : +Type : Microsoft.Network/bastionHosts +Tag : {} +TagsTable : +Name : BastionTest-vnet-bastion +Etag : W/"7ae27d14-9260-4e2d-8c48-47e9628a3e3b" +Id : /subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionTest/providers/Microsoft.Network/bastionHosts/BastionTest-vnet-bastion + +IpConfigurations : {IpConf} +DnsName : bst-32359e0c-d6a5-45f1-b196-2f9a4b4b77e8.bastion.azure.com +ProvisioningState : Succeeded +IpConfigurationsText : [ + { + "Name": "IpConf", + "Etag": "W/\"bd537319-3379-4caf-a8dc-be4506f9dd3a\"", + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps1621/providers/Microsoft.Network/bastionHosts/ps5581/bastionHostIpConfigurations/IpConf", + "Subnet": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps1621/providers/Microsoft.Network/virtualNetworks/ps7070/subnets/AzureBastionSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps1621/providers/Microsoft.Network/publicIPAddresses/ps2217" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAllocationMethod": "Dynamic" + } + ] +ResourceGroupName : ps1621 +Location : westcentralus +ResourceGuid : +Type : Microsoft.Network/bastionHosts +Tag : +TagsTable : +Name : ps5581 +Etag : W/"bd537319-3379-4caf-a8dc-be4506f9dd3a" +Id : /subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps1621/providers/Microsoft.Network/bastionHosts/ps5581 + +IpConfigurations : {IpConf} +DnsName : bst-aee29973-3b60-44c1-a1de-bd8636e79127.bastion.azure.com +ProvisioningState : Succeeded +IpConfigurationsText : [ + { + "Name": "IpConf", + "Etag": "W/\"42f723dd-f1de-4fd0-b307-3fe82f0b50f7\"", + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3151/providers/Microsoft.Network/bastionHosts/ps8815/bastionHostIpConfigurations/IpConf", + "Subnet": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3151/providers/Microsoft.Network/virtualNetworks/ps5766/subnets/AzureBastionSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3151/providers/Microsoft.Network/publicIPAddresses/ps2773" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAllocationMethod": "Dynamic" + } + ] +ResourceGroupName : ps3151 +Location : westcentralus +ResourceGuid : +Type : Microsoft.Network/bastionHosts +Tag : +TagsTable : +Name : ps8815 +Etag : W/"42f723dd-f1de-4fd0-b307-3fe82f0b50f7" +Id : /subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3151/providers/Microsoft.Network/bastionHosts/ps8815 + +IpConfigurations : {IpConf} +DnsName : bst-746c229d-f144-4699-a7ea-303a15a70457.bastion.azure.com +ProvisioningState : Succeeded +IpConfigurationsText : [ + { + "Name": "IpConf", + "Etag": "W/\"0b11e3e7-330b-4727-b073-dfe458429fcf\"", + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3429/providers/Microsoft.Network/bastionHosts/ps7790/bastionHostIpConfigurations/IpConf", + "Subnet": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3429/providers/Microsoft.Network/virtualNetworks/ps7582/subnets/AzureBastionSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3429/providers/Microsoft.Network/publicIPAddresses/ps8199" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAllocationMethod": "Dynamic" + } + ] +``` + +### Example 2 +```powershell +Get-AzBastion -ResourceGroupName "BastionPowershellTest" -Name "testBastion" +``` + +```output +IpConfigurations : {IpConf} +DnsName : bst-0597f607-ab71-46c2-ab2a-777bfa887aff.bastion.azure.com +ProvisioningState : Succeeded +IpConfigurationsText : [ + { + "Name": "IpConf", + "Etag": "W/\"4d023823-3ea8-439a-ac00-20f16fb0c9b2\"", + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/bastionHosts/testBastion/bastionHostIpConfigurations/IpConf", + "Subnet": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/virtualNetworks/TestVnet/subnets/AzureBastionSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/publicIPAddresses/Test-Ip" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAllocationMethod": "Dynamic" + } + ] +ResourceGroupName : BastionPowershellTest +Location : westeurope +ResourceGuid : +Type : Microsoft.Network/bastionHosts +Tag : +TagsTable : +Name : testBastion +Etag : W/"4d023823-3ea8-439a-ac00-20f16fb0c9b2" +Id : /subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/bastionHosts/testBastion +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The bastion resource name. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupNameByName +Aliases: ResourceName, BastionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupNameByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceId +The bastion Azure resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBastion + +### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.Network.Models.PSBastion, Microsoft.Azure.PowerShell.Cmdlets.Network, Version=1.13.0.0, Culture=neutral, PublicKeyToken=null]] + +## NOTES + +## RELATED LINKS + +[New-AzBastion](./New-AzBastion.md) + +[Remove-AzBastion](./Remove-AzBastion.md) diff --git a/azps-10.1.0/Az.Network/Get-AzBgpServiceCommunity.md b/azps-10.1.0/Az.Network/Get-AzBgpServiceCommunity.md new file mode 100644 index 0000000000..36475917b0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzBgpServiceCommunity.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azbgpservicecommunity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzBgpServiceCommunity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzBgpServiceCommunity.md +--- + +# Get-AzBgpServiceCommunity + +## SYNOPSIS +Provides a list of all services / regions, BGP communities, and associated prefixes. + +## SYNTAX + +``` +Get-AzBgpServiceCommunity [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet provides a list of all services / regions, BGP communities, and associated prefixes. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzBgpServiceCommunity +``` + +```output +... + +Name : AzureCentralIndia +Id : /subscriptions//resourceGroups//providers/Microsoft.Network/bgpServiceCommunities/AzureCentralIndia +Type : Microsoft.Network/bgpServiceCommunities +BgpCommunities : [ + { + "ServiceSupportedRegion": "Global", + "CommunityName": "Azure Central India", + "CommunityValue": "12076:51017", + "CommunityPrefixes": [ + "13.71.0.0/18", + "20.190.146.0/25", + "40.79.214.0/24", + "40.81.224.0/19", + "40.87.224.0/22", + "40.112.39.0/25", + "40.112.39.128/26", + "40.126.18.0/25", + "52.136.24.0/24", + "52.140.64.0/18", + "52.159.64.0/19", + "52.172.128.0/17", + "52.239.135.64/26", + "52.239.202.0/24", + "52.245.96.0/22", + "52.253.168.0/22", + "104.47.210.0/23", + "104.211.64.0/20", + "104.211.81.0/24", + "104.211.82.0/23", + "104.211.84.0/22", + "104.211.88.0/21", + "104.211.96.0/19" + ], + "IsAuthorizedToUse": true, + "ServiceGroup": "Azure" + } + ] +... +``` + +This cmdlet provides a list of all services / regions, BGP communities, and associated prefixes. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBgpServiceCommunity + +## NOTES + +## RELATED LINKS + +[Move-AzExpressRouteCircuit](Move-AzExpressRouteCircuit.md) + +[New-AzExpressRouteCircuit](New-AzExpressRouteCircuit.md) + +[Remove-AzExpressRouteCircuit](Remove-AzExpressRouteCircuit.md) + +[Set-AzExpressRouteCircuit](Set-AzExpressRouteCircuit.md) + +[Get-AzRouteFilter](Get-AzRouteFilter.md) + +[Get-AzRouteFilterRuleConfig](Get-AzRouteFilterRuleConfig.md) + +[Remove-AzRouteFilter](Remove-AzRouteFilter.md) + +[Remove-AzRouteFilterRuleConfig](Remove-AzRouteFilterRuleConfig.md) + +[Set-AzRouteFilter](Set-AzRouteFilter.md) + +[Set-AzRouteFilterRuleConfig](Set-AzRouteFilterRuleConfig.md) + +[New-AzRouteFilter](New-AzRouteFilter.md) + +[New-AzRouteFilterRuleConfig](New-AzRouteFilterRuleConfig.md) diff --git a/azps-10.1.0/Az.Network/Get-AzCustomIpPrefix.md b/azps-10.1.0/Az.Network/Get-AzCustomIpPrefix.md new file mode 100644 index 0000000000..d55a8c9a81 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzCustomIpPrefix.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azcustomipprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzCustomIpPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzCustomIpPrefix.md +--- + +# Get-AzCustomIpPrefix + +## SYNOPSIS +Gets a CustomIpPrefix resource + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzCustomIpPrefix [-Name <String>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzCustomIpPrefix -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzCustomIpPrefix** cmdlet gets one or more CustomIpPrefixes given the set of input parameters + +## EXAMPLES + +### Example 1 +```powershell +Get-AzCustomIpPrefix -ResourceGroupName myRg -Name myCustomIpPrefix +``` + +```output +Name : myCustomIpPrefix +ResourceGroupName : myRg +Location : westus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/byoip-test-rg/providers/Micro + soft.Network/customIPPrefixes/testCustomIpPrefix +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +Cidr : 111.111.111.111/24 +CommissionedState : Provisioning +PublicIpPrefixes : [] +Zones : {} +SignedMessage : SignedMessage +AuthorizationMessage : AuthorizationMessage +CustomIpPrefixParent : +ChildCustomIpPrefixes: [] +``` + +This command gets a CustomIpPrefix resource named myCustomIpPrefix in resource group myRg + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +The resource id. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSCustomIpPrefix + +## NOTES + +## RELATED LINKS + +[New-AzCustomIpPrefix](./New-AzCustomIpPrefix.md) + +[Remove-AzCustomIpPrefix](./Remove-AzCustomIpPrefix.md) + +[Update-AzCustomIpPrefix](./Update-AzCustomIpPrefix.md) diff --git a/azps-10.1.0/Az.Network/Get-AzDdosProtectionPlan.md b/azps-10.1.0/Az.Network/Get-AzDdosProtectionPlan.md new file mode 100644 index 0000000000..10b214af02 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzDdosProtectionPlan.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azddosprotectionplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzDdosProtectionPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzDdosProtectionPlan.md +--- + +# Get-AzDdosProtectionPlan + +## SYNOPSIS +Gets a DDoS protection plan. + +## SYNTAX + +``` +Get-AzDdosProtectionPlan [-ResourceGroupName <String>] [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDdosProtectionPlan cmdlet gets a DDoS protection plan. + +## EXAMPLES + +### Example 1: Get a specific DDoS protection plan +```powershell +Get-AzDdosProtectionPlan -ResourceGroupName ResourceGroupName -Name DdosProtectionPlanName +``` + +```output +Name : DdosProtectionPlanName +Id : /subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/ddosProtectionPlans/DdosProtectionPlanName +Etag : W/"a20e5592-9b51-423b-9758-b00cd322f744" +ProvisioningState : Succeeded +VirtualNetworks : [ + { + "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName" + } + ] +``` + +In this case, we need to specify both **ResourceGroupName** and **Name** attributes, which correspond to the resource group and the name of the DDoS protection plan, respectively. + +### Example 2: Get all DDoS protection plans in a resource group +```powershell +Get-AzDdosProtectionPlan -ResourceGroupName ResourceGroupName +``` + +```output +Name : DdosProtectionPlanName +Id : /subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/ddosProtectionPlans/DdosProtectionPlanName +Etag : W/"a20e5592-9b51-423b-9758-b00cd322f744" +ProvisioningState : Succeeded +VirtualNetworks : [ + { + "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName" + } + ] +``` + +In this scenario, we only specify the parameter **ResourceGroupName** to get a list of DDoS protection plans. + +### Example 3: Get all DDoS protection plans in a subscription +```powershell +Get-AzDdosProtectionPlan +``` + +```output +Name : DdosProtectionPlanName +Id : /subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/ddosProtectionPlans/DdosProtectionPlanName +Etag : W/"a20e5592-9b51-423b-9758-b00cd322f744" +ProvisioningState : Succeeded +VirtualNetworks : [ + { + "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName" + } + ] +``` + +Here, we do not specify any parameters to get a list of all DDoS protection plans in a subscription. + +### Example 4: Get all DDoS protection plans in a subscription +```powershell +Get-AzDdosProtectionPlan -Name test* +``` + +```output +Name : test1 +Id : /subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/ddosProtectionPlans/test1 +Etag : W/"a20e5592-9b51-423b-9758-b00cd322f744" +ProvisioningState : Succeeded +VirtualNetworks : [ + { + "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName" + } + ] + +Name : test2 +Id : /subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/ddosProtectionPlans/test2 +Etag : W/"a20e5592-9b51-423b-9758-b00cd322f744" +ProvisioningState : Succeeded +VirtualNetworks : [ + { + "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName" + } + ] +``` + +This cmdlet returns all DdosProtectionPlans that start with "test". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the DDoS protection plan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the DDoS protection plan resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSDdosProtectionPlan + +## NOTES + +## RELATED LINKS + +[New-AzDdosProtectionPlan](./New-AzDdosProtectionPlan.md) + +[Remove-AzDdosProtectionPlan](./Remove-AzDdosProtectionPlan.md) + +[New-AzVirtualNetwork](./New-AzVirtualNetwork.md) + +[Set-AzVirtualNetwork](./Set-AzVirtualNetwork.md) + +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzDelegation.md b/azps-10.1.0/Az.Network/Get-AzDelegation.md new file mode 100644 index 0000000000..ce89fd23f9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzDelegation.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azdelegation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzDelegation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzDelegation.md +--- + +# Get-AzDelegation + +## SYNOPSIS +Get a delegation (or all of the delegations) on a given subnet. + +## SYNTAX + +``` +Get-AzDelegation [-Name <String>] -Subnet <PSSubnet> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDelegation** cmdlet gets the named delegation from a subnet. If no delegation is named, it returns all of the delegations on the provided subnet. + +## EXAMPLES + +### 1: Retrieving a specific delegation +```powershell +$subnet = Get-AzVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" | Get-AzVirtualNetworkSubnetConfig -Name "mySubnet" +Get-AzDelegation -Name "myDelegation" -Subnet $subnet +``` + +```output +ProvisioningState : Succeeded +ServiceName : Microsoft.Sql/servers +Actions : {} +Name : myDelegation +Etag : "thisisaguid" +Id : /subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mySubnet/delegations/myDelegation +``` + +The first line retrieves the subnet of interest. The second line shows the delegation information for the delegation called "myDelegation." + +### 2: Retrieving all subnet delegations +```powershell +$subnet = Get-AzVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" | Get-AzVirtualNetworkSubnetConfig -Name "mySubnet" +$delegations = Get-AzDelegation -Subnet $subnet +``` + +The first line retrieves the subnet of interest. The second line stores a list of all of the delegations on _mySubnet_ in the $delegations variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the delegation + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Subnet +The subnet + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSSubnet + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSDelegation + +## NOTES + +## RELATED LINKS + +[Add-AzDelegation](./Add-AzDelegation.md) +[New-AzDelegation](./New-AzDelegation.md) +[Remove-AzDelegation](./Remove-AzDelegation.md) +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) +[Get-AzVirtualNetworkSubnetConfig](./Get-AzVirtualNetworkSubnetConfig.md) diff --git a/azps-10.1.0/Az.Network/Get-AzEffectiveNetworkSecurityGroup.md b/azps-10.1.0/Az.Network/Get-AzEffectiveNetworkSecurityGroup.md new file mode 100644 index 0000000000..42d7e243ae --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzEffectiveNetworkSecurityGroup.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: B9409AD6-F761-4B80-8E08-DBB2356F567D +online version: https://learn.microsoft.com/powershell/module/az.network/get-azeffectivenetworksecuritygroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzEffectiveNetworkSecurityGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzEffectiveNetworkSecurityGroup.md +--- + +# Get-AzEffectiveNetworkSecurityGroup + +## SYNOPSIS +Gets the effective network security group of a network interface. + +## SYNTAX + +``` +Get-AzEffectiveNetworkSecurityGroup -NetworkInterfaceName <String> [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzEffectiveNetworkSecurityGroup** cmdlet returns the effective network security group that is applied on a network interface. + +## EXAMPLES + +### Example 1: Get the effective network security group on a network interface +```powershell +Get-AzEffectiveNetworkSecurityGroup -NetworkInterfaceName "MyNetworkInterface" -ResourceGroupName "myResourceGroup" +``` + +This command gets all of the effective network security rules associated with the network interface named MyNetworkInterface in the resource group named myResourceGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterfaceName +Specified the name of a network interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group of a network interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSEffectiveNetworkSecurityGroup + +## NOTES + +## RELATED LINKS + +[Get-AzEffectiveRouteTable](./Get-AzEffectiveRouteTable.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzEffectiveRouteTable.md b/azps-10.1.0/Az.Network/Get-AzEffectiveRouteTable.md new file mode 100644 index 0000000000..bb7662398c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzEffectiveRouteTable.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 84FDB0F7-E6DE-4E1B-BD71-89535EDC6AA1 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azeffectiveroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzEffectiveRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzEffectiveRouteTable.md +--- + +# Get-AzEffectiveRouteTable + +## SYNOPSIS +Gets the effective route table of a network interface. + +## SYNTAX + +``` +Get-AzEffectiveRouteTable -NetworkInterfaceName <String> [-ResourceGroupName <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzEffectiveRouteTable** cmdlet returns the effective route table that is applied on a network interface. + +## EXAMPLES + +### Example 1: Get the effective route table on a network interface +```powershell +Get-AzEffectiveRouteTable -NetworkInterfaceName "MyNetworkInterface" -ResourceGroupName "MyResourceGroup" +``` + +This command gets the effective route table associated with network interface named MyNetworkInterface in the resource group named MyResourceGroup. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterfaceName +Specified the name of a network interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group of a network interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSEffectiveRoute + +## NOTES + +## RELATED LINKS + +[Get-AzEffectiveNetworkSecurityGroup](./Get-AzEffectiveNetworkSecurityGroup.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuit.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuit.md new file mode 100644 index 0000000000..71a0b45b36 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuit.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C9954E3D-8645-473E-A6D4-86278C2F6BC1 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutecircuit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuit.md +--- + +# Get-AzExpressRouteCircuit + +## SYNOPSIS +Gets an Azure ExpressRoute circuit from Azure. + +## SYNTAX + +``` +Get-AzExpressRouteCircuit [-Name <String>] [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteCircuit** cmdlet is used to retrieve an ExpressRoute circuit object +from your subscription. The circuit object returned can be used as input to other cmdlets that +operate on ExpressRoute circuits. + +## EXAMPLES + +### Example 1: Get the ExpressRoute circuit +```powershell +Get-AzExpressRouteCircuit -ResourceGroupName testrg -Name test +``` + +```output +Name : test +ResourceGroupName : testrg +Location : southcentralus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/pro + viders/Microsoft.Network/expressRouteCircuits/test +Etag : W/"00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +Sku : { + "Name": "Standard_UnlimitedData", + "Tier": "Standard", + "Family": "UnlimitedData" + } +CircuitProvisioningState : Enabled +ServiceProviderProvisioningState : NotProvisioned +ServiceProviderNotes : +ServiceProviderProperties : { + "ServiceProviderName": "AT&T", + "PeeringLocation": "Silicon Valley", + "BandwidthInMbps": 50 + } +ExpressRoutePort : null +BandwidthInGbps : +Stag : +ServiceKey : 00000000-0000-0000-0000-000000000000 +Peerings : [] +Authorizations : [] +AllowClassicOperations : False +GatewayManagerEtag : +``` + +Get a specific ExpressRoute circuit with Name "testrg" and ResourceGroupName "test" + +### Example 2: List the ExpressRoute circuits using filtering +```powershell +Get-AzExpressRouteCircuit -Name test* +``` + +```output +Name : test1 +ResourceGroupName : testrg +Location : southcentralus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/pro + viders/Microsoft.Network/expressRouteCircuits/test1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +Sku : { + "Name": "Standard_UnlimitedData", + "Tier": "Standard", + "Family": "UnlimitedData" + } +CircuitProvisioningState : Enabled +ServiceProviderProvisioningState : NotProvisioned +ServiceProviderNotes : +ServiceProviderProperties : { + "ServiceProviderName": "AT&T", + "PeeringLocation": "Silicon Valley", + "BandwidthInMbps": 50 + } +ExpressRoutePort : null +BandwidthInGbps : +Stag : +ServiceKey : 00000000-0000-0000-0000-000000000000 +Peerings : [] +Authorizations : [] +AllowClassicOperations : False +GatewayManagerEtag : + +Name : test2 +ResourceGroupName : testrg +Location : southcentralus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/pro + viders/Microsoft.Network/expressRouteCircuits/test2 +Etag : W/"00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +Sku : { + "Name": "Standard_UnlimitedData", + "Tier": "Standard", + "Family": "UnlimitedData" + } +CircuitProvisioningState : Enabled +ServiceProviderProvisioningState : NotProvisioned +ServiceProviderNotes : +ServiceProviderProperties : { + "ServiceProviderName": "AT&T", + "PeeringLocation": "Silicon Valley", + "BandwidthInMbps": 50 + } +ExpressRoutePort : null +BandwidthInGbps : +Stag : +ServiceKey : 00000000-0000-0000-0000-000000000000 +Peerings : [] +Authorizations : [] +AllowClassicOperations : False +GatewayManagerEtag : +``` + +Get all ExpressRoute circuits whose name starts with "test". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ExpressRoute circuit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group that contains the ExpressRoute circuit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## NOTES + +## RELATED LINKS + +[Move-AzExpressRouteCircuit](Move-AzExpressRouteCircuit.md) + +[New-AzExpressRouteCircuit](New-AzExpressRouteCircuit.md) + +[Remove-AzExpressRouteCircuit](Remove-AzExpressRouteCircuit.md) + +[Set-AzExpressRouteCircuit](Set-AzExpressRouteCircuit.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitARPTable.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitARPTable.md new file mode 100644 index 0000000000..c71b45f102 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitARPTable.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: F0370845-13D9-4FB5-B30E-826A22EBC5E0 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutecircuitarptable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitARPTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitARPTable.md +--- + +# Get-AzExpressRouteCircuitARPTable + +## SYNOPSIS +Gets the ARP table from an ExpressRoute circuit. + +## SYNTAX + +``` +Get-AzExpressRouteCircuitARPTable -ResourceGroupName <String> -ExpressRouteCircuitName <String> + -PeeringType <String> -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteCircuitARPTable** cmdlet retrieves the ARP table from both interfaces +of an ExpressRoute circuit. The ARP table provides a mapping of the IPv4 address to MAC address for +a particular peering. You can use the ARP table to validate layer 2 configuration and connectivity. + +## EXAMPLES + +### Example 1: Display the ARP table for an ExpressRoute peer +```powershell +Get-AzExpressRouteCircuitARPTable -ResourceGroupName $RG -ExpressRouteCircuitName $CircuitName -PeeringType MicrosoftPeering -DevicePath Primary +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DevicePath +The acceptable values for this parameter are: `Primary` or `Secondary` + +```yaml +Type: Microsoft.Azure.Commands.Network.DevicePathEnum +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuitName +The name of the ExpressRoute circuit being examined. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeeringType +The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and +`MicrosoftPeering` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the ExpressRoute circuit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitArpTable + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuitRouteTable](Get-AzExpressRouteCircuitRouteTable.md) + +[Get-AzExpressRouteCircuitRouteTableSummary](Get-AzExpressRouteCircuitRouteTableSummary.md) + +[Get-AzExpressRouteCircuitStat](./Get-AzExpressRouteCircuitStat.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitAuthorization.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitAuthorization.md new file mode 100644 index 0000000000..3913961413 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitAuthorization.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 3D80F94B-AF9D-40C2-BE7E-2F32E5E926D2 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutecircuitauthorization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitAuthorization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitAuthorization.md +--- + +# Get-AzExpressRouteCircuitAuthorization + +## SYNOPSIS +Gets information about ExpressRoute circuit authorizations. + +## SYNTAX + +``` +Get-AzExpressRouteCircuitAuthorization [-Name <String>] -ExpressRouteCircuit <PSExpressRouteCircuit> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteCircuitAuthorization** cmdlet gets information about the +authorizations assigned to an ExpressRoute circuit. ExpressRoute circuits connect your on-premises +network to the Microsoft cloud by using a connectivity provider instead of the public Internet. The +owner of an ExpressRoute circuit can create as many as 10 authorizations for each circuit; these +authorizations generate an authorization key that can be used by a virtual network owner to connect +his or her network to the circuit (one authorization per virtual network). Authorization keys, as +well as other information about the authorization, can be viewed at any time by running +**Get-AzExpressRouteCircuitAuthorization**. + +## EXAMPLES + +### Example 1: Get all ExpressRoute authorizations +```powershell +$Circuit = Get-AzExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup" +Get-AzExpressRouteCircuitAuthorization -ExpressRouteCircuit $Circuit +``` + +These commands return information about all the ExpressRoute authorizations associated with an +ExpressRoute circuit. The first command uses the **Get-AzExpressRouteCircuit** cmdlet to +create an object reference a circuit named ContosoCircuit; that object reference is stored in the +variable $Circuit. The second command then uses that object reference and the +**Get-AzExpressRouteCircuitAuthorization** cmdlet to return information about the +authorizations associated with ContosoCircuit. + +### Example 2: Get all ExpressRoute authorizations using the Where-Object cmdlet +```powershell +$Circuit = Get-AzExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup" + Get-AzExpressRouteCircuitAuthorization -ExpressRouteCircuit $Circuit | Where-Object {$_.AuthorizationUseStatus -eq "Available"} +``` + +These commands represent a variation on the commands used in Example 1. In this case, however, +information is returned only for those authorizations that are available for use (that is, for +authorizations that have not been assigned to a virtual network). To do this, the circuit +authorization information is returned in command 2 and is piped to the **Where-Object** cmdlet. +**Where-Object** then picks out only those authorizations where the *AuthorizationUseStatus* +property is set to Available. To list only those authorizations that are not available, use this +syntax for the Where clause: +`{$_.AuthorizationUseStatus -ne "Available"}` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuit +Specifies the ExpressRoute circuit authorization. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the ExpressRoute circuit authorization that this cmdlet gets. +-Name "ContosoCircuitAuthorization" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization + +## NOTES + +## RELATED LINKS + +[Add-AzExpressRouteCircuitAuthorization](./Add-AzExpressRouteCircuitAuthorization.md) + +[Get-AzExpressRouteCircuit](./Get-AzExpressRouteCircuit.md) + +[New-AzExpressRouteCircuitAuthorization](./New-AzExpressRouteCircuitAuthorization.md) + +[Remove-AzExpressRouteCircuitAuthorization](./Remove-AzExpressRouteCircuitAuthorization.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitConnectionConfig.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitConnectionConfig.md new file mode 100644 index 0000000000..95606af2a5 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitConnectionConfig.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 59692f1f-9f1e-4a3c-8200-312c3806a9b7 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutecircuitconnectionconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitConnectionConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitConnectionConfig.md +--- + +# Get-AzExpressRouteCircuitConnectionConfig + +## SYNOPSIS +Gets an ExpressRoute circuit connection configuration associated with Private Peering of ExpressRouteCircuit. + +## SYNTAX + +``` +Get-AzExpressRouteCircuitConnectionConfig [[-Name] <String>] [-ExpressRouteCircuit] <PSExpressRouteCircuit> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteCircuitConnectionConfig** cmdlet retrieves the configuration of a circuit connection +associated with Private Peering for an ExpressRoute circuit. + +## EXAMPLES + +### Example 1: Display the circuit connection configuration for an ExpressRoute circuit +```powershell +$circuit_init = Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg +Get-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init +``` + +### Example 2: Get circuit connection resource associated with an ExpressRoute Circuit using piping +```powershell +Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Get-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuit +The ExpressRoute circuit object containing the circuit connection configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the circuit connection configuration to be retrieved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitConnection + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuit](Get-AzExpressRouteCircuit.md) + +[Add-AzExpressRouteCircuitConnectionConfig](Add-AzExpressRouteCircuitConnectionConfig.md) + +[Remove-AzExpressRouteCircuitConnectionConfig](Remove-AzExpressRouteCircuitConnectionConfig.md) + +[Set-AzExpressRouteCircuitConnectionConfig](Set-AzExpressRouteCircuitConnectionConfig.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitPeeringConfig.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitPeeringConfig.md new file mode 100644 index 0000000000..be093b15c9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitPeeringConfig.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 47C45467-F368-4993-937E-E7E975F400B5 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutecircuitpeeringconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitPeeringConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitPeeringConfig.md +--- + +# Get-AzExpressRouteCircuitPeeringConfig + +## SYNOPSIS +Gets an ExpressRoute circuit peering configuration. + +## SYNTAX + +``` +Get-AzExpressRouteCircuitPeeringConfig [-Name <String>] -ExpressRouteCircuit <PSExpressRouteCircuit> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteCircuitPeeringConfig** cmdlet retrieves the configuration of a peering +relationship for an ExpressRoute circuit. + +## EXAMPLES + +### Example 1: Display the peering configuration for an ExpressRoute circuit +```powershell +$ckt = Get-AzExpressRouteCircuit -Name $CircuitName -ResourceGroupName $RG +Get-AzExpressRouteCircuitPeeringConfig -Name "AzurePrivatePeering" -ExpressRouteCircuit $ckt +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuit +The ExpressRoute circuit object containing the peering configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the peering configuration to be retrieved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPeering + +## NOTES + +## RELATED LINKS + +[Add-AzExpressRouteCircuitPeeringConfig](Add-AzExpressRouteCircuitPeeringConfig.md) + +[New-AzExpressRouteCircuitPeeringConfig](New-AzExpressRouteCircuitPeeringConfig.md) + +[Remove-AzExpressRouteCircuitPeeringConfig](Remove-AzExpressRouteCircuitPeeringConfig.md) + +[Set-AzExpressRouteCircuit](Set-AzExpressRouteCircuit.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitRouteTable.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitRouteTable.md new file mode 100644 index 0000000000..99b5360f8b --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitRouteTable.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: BA7F6BAC-6047-42B0-B8CA-0B36302951B0 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutecircuitroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitRouteTable.md +--- + +# Get-AzExpressRouteCircuitRouteTable + +## SYNOPSIS +Gets a route table from an ExpressRoute circuit. + +## SYNTAX + +``` +Get-AzExpressRouteCircuitRouteTable -ResourceGroupName <String> -ExpressRouteCircuitName <String> + -PeeringType <String> -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteCircuitRouteTable** cmdlet retrieves a detailed route table of an +ExpressRoute circuit. The route table will show all routes or can be filtered to show routes for a +specific peering type. You can use the route table to validate your peering configuration and +connectivity. + +## EXAMPLES + +### Example 1: Display the route table for the primary path +```powershell +Get-AzExpressRouteCircuitRouteTable -ResourceGroupName $RG -ExpressRouteCircuitName $CircuitName -PeeringType 'AzurePrivatePeering' -DevicePath 'Primary' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DevicePath +The acceptable values for this parameter are: `Primary` or `Secondary` + +```yaml +Type: Microsoft.Azure.Commands.Network.DevicePathEnum +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuitName +The name of the ExpressRoute circuit being examined. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeeringType +The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and +`MicrosoftPeering` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the ExpressRoute circuit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitRoutesTable + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuitARPTable](Get-AzExpressRouteCircuitARPTable.md) + +[Get-AzExpressRouteCircuitRouteTableSummary](Get-AzExpressRouteCircuitRouteTableSummary.md) + +[Get-AzExpressRouteCircuitStat](./Get-AzExpressRouteCircuitStat.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitRouteTableSummary.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitRouteTableSummary.md new file mode 100644 index 0000000000..8ac3025ae0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitRouteTableSummary.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 2C603E0E-A19F-4EA6-B918-945007BE22FF +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutecircuitroutetablesummary +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitRouteTableSummary.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitRouteTableSummary.md +--- + +# Get-AzExpressRouteCircuitRouteTableSummary + +## SYNOPSIS +Gets a route table summary of an ExpressRoute circuit. + +## SYNTAX + +``` +Get-AzExpressRouteCircuitRouteTableSummary -ResourceGroupName <String> -ExpressRouteCircuitName <String> + -PeeringType <String> -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteCircuitRouteTableSummary** cmdlet retrieves a summary of BGP neighbor +information for a particular routing context. This information is useful to determine for how long +a routing context has been established and the number of route prefixes advertised by the peering +router. + +## EXAMPLES + +### Example 1: Display the route summary for the primary path +```powershell +Get-AzExpressRouteCircuitRouteTableSummary -ResourceGroupName $RG -ExpressRouteCircuitName $CircuitName -DevicePath 'Primary' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DevicePath +The acceptable values for this parameter are: `Primary` or `Secondary` + +```yaml +Type: Microsoft.Azure.Commands.Network.DevicePathEnum +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuitName +The name of the ExpressRoute circuit being examined. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeeringType +The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and +`MicrosoftPeering` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the ExpressRoute circuit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitRoutesTableSummary + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuitARPTable](Get-AzExpressRouteCircuitARPTable.md) + +[Get-AzExpressRouteCircuitRouteTable](Get-AzExpressRouteCircuitRouteTable.md) + +[Get-AzExpressRouteCircuitStat](./Get-AzExpressRouteCircuitStat.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitStat.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitStat.md new file mode 100644 index 0000000000..c5ec4f39dd --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteCircuitStat.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: CFE184E2-6DEF-4E92-A9C3-E82F29BB4FB8 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutecircuitstat +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitStat.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCircuitStat.md +--- + +# Get-AzExpressRouteCircuitStat + +## SYNOPSIS +Gets usage statistics of an ExpressRoute circuit. + +## SYNTAX + +``` +Get-AzExpressRouteCircuitStat -ResourceGroupName <String> -ExpressRouteCircuitName <String> + [-PeeringType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteCircuitStat** cmdlet retrieves traffic statistics for an ExpressRoute +circuit. The statistics include the number of bytes sent and received over both the primary and +secondary routes. + +## EXAMPLES + +### Example 1: Display the traffic statistics for an ExpressRoute peer +```powershell +Get-AzExpressRouteCircuitStat -ResourceGroupName $RG -ExpressRouteCircuitName $CircuitName -PeeringType 'AzurePrivatePeering' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuitName +The name of the ExpressRoute circuit being examined. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeeringType +The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and +`MicrosoftPeering` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the ExpressRoute circuit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitStats + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuitARPTable](Get-AzExpressRouteCircuitARPTable.md) + +[Get-AzExpressRouteCircuitRouteTable](Get-AzExpressRouteCircuitRouteTable.md) + +[Get-AzExpressRouteCircuitRouteTableSummary](Get-AzExpressRouteCircuitRouteTableSummary.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteConnection.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteConnection.md new file mode 100644 index 0000000000..ce01a8958b --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteConnection.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressrouteconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteConnection.md +--- + +# Get-AzExpressRouteConnection + +## SYNOPSIS +Gets a ExpressRoute connection by name or lists all ExpressRoute connections connected to a ExpressRouteGateway. + +## SYNTAX + +### ByExpressRouteGatewayName (Default) +``` +Get-AzExpressRouteConnection -ResourceGroupName <String> -ExpressRouteGatewayName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByExpressRouteGatewayObject +``` +Get-AzExpressRouteConnection -ExpressRouteGatewayObject <PSExpressRouteGateway> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByExpressRouteGatewayResourceId +``` +Get-AzExpressRouteConnection -ParentResourceId <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets an ExpressRoute connection by name or lists all ExpressRoute connections connected to a ExpressRouteGateway. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West Central US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West Central US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" -VirtualHubId $virtualHub.Id -MinScaleUnits 2 +$ExpressRouteGateway = Get-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" +$ExpressRouteCircuit = New-AzExpressRouteCircuit -ResourceGroupName "testRG" -Name "testExpressRouteCircuit" -Location "West Central US" -SkuTier Premium -SkuFamily MeteredData -ServiceProviderName "Equinix" -PeeringLocation "Silicon Valley" -BandwidthInMbps 200 +Add-AzExpressRouteCircuitPeeringConfig -Name "AzurePrivatePeering" -ExpressRouteCircuit $ExpressRouteCircuit -PeeringType AzurePrivatePeering -PeerASN 100 -PrimaryPeerAddressPrefix "123.0.0.0/30" -SecondaryPeerAddressPrefix "123.0.0.4/30" -VlanId 300 +$ExpressRouteCircuit = Set-AzExpressRouteCircuit -ExpressRouteCircuit $ExpressRouteCircuit +$ExpressRouteCircuitPeeringId = $ExpressRouteCircuit.Peerings[0].Id +New-AzExpressRouteConnection -ResourceGroupName $ExpressRouteGateway.ResourceGroupName -ExpressRouteGatewayName $ExpressRouteGateway.Name -Name "testConnection" -ExpressRouteCircuitPeeringId $ExpressRouteCircuitPeeringId -RoutingWeight 20 +Get-AzExpressRouteConnection -ResourceGroupName $ExpressRouteGateway.ResourceGroupName -ExpressRouteGatewayName $ExpressRouteGateway.Name -Name "testConnection" +``` + +```output +ExpressRouteCircuitPeeringId : Microsoft.Azure.Commands.Network.Models.PSResourceId +AuthorizationKey : +RoutingWeight : 20 +ProvisioningState : Succeeded +Name : testConnection +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/ExpressRouteGateways/testExpressRoutegw/expressRouteConnections/testConnection +EnableInternetSecurity : False +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a ExpressRouteSite in West US in "testRG" resource group in Azure. +A ExpressRoute gateway will be created thereafter in the Virtual Hub with 2 scale units. + +Once the gateway has been created, it is connected to the on premise ExpressRoute circuit using the New-AzExpressRouteConnection command. + +Then it gets the connection using the connection name. + +### Example 2 + +```powershell +Get-AzExpressRouteConnection -ResourceGroupName ps9361 -ExpressRouteGatewayName testExpressRoutegw -Name test* +``` + +```output +ExpressRouteCircuitPeeringId : Microsoft.Azure.Commands.Network.Models.PSResourceId +AuthorizationKey : +RoutingWeight : 20 +ProvisioningState : Succeeded +Name : testConnection1 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/{subscriptionId}/resourceGroups/ps9361/providers/Microsoft.Network/ExpressRouteGateways/testExpressRoutegw/expressRouteConnections/testConnection1 +EnableInternetSecurity : False +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } + +ExpressRouteCircuitPeeringId : Microsoft.Azure.Commands.Network.Models.PSResourceId +AuthorizationKey : +RoutingWeight : 20 +ProvisioningState : Succeeded +Name : testConnection2 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/{subscriptionId}/resourceGroups/ps9361/providers/Microsoft.Network/ExpressRouteGateways/testExpressRoutegw/expressRouteConnections/testConnection2 +EnableInternetSecurity : False +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +This command will get all Connections in ExpressRoute "testExpressRoutegw" that start with "test" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteGatewayName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteGatewayObject +The parent ExpressRouteGateway for this connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteGateway +Parameter Sets: ByExpressRouteGatewayObject +Aliases: ExpressRouteGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, ExpressRouteConnectionName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ParentResourceId +The resource id of the parent ExpressRouteGateway for this connection. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteGatewayResourceId +Aliases: ExpressRouteGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteConnection + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnection.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnection.md new file mode 100644 index 0000000000..a4cc648cb0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnection.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 3efb6270-f908-4734-bdb1-6c7e4e4eb382 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutecrossconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCrossConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCrossConnection.md +--- + +# Get-AzExpressRouteCrossConnection + +## SYNOPSIS +Gets an Azure ExpressRoute cross connection from Azure. + +## SYNTAX + +``` +Get-AzExpressRouteCrossConnection [-ResourceGroupName <String>] [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteCrossConnection** cmdlet is used to retrieve an ExpressRoute cross connection object +from your subscription. +AzureRmExpressRouteCrossConnection + +## EXAMPLES + +### Example 1: Get the ExpressRoute cross connection +```powershell +Get-AzExpressRouteCrossConnection -Name $CrossConnectionName -ResourceGroupName $rg +``` + +### Example 2: List the ExpressRoute cross connections using a filter +```powershell +Get-AzExpressRouteCrossConnection -Name test* +``` + +This cmdlet will list all ExpressRoute cross connections that begin with "test" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ExpressRoute cross connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group that contains the ExpressRoute cross connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +This cmdlet does not accept any input. + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCrossConnection + +## NOTES + +## RELATED LINKS + +[Set-AzExpressRouteCrossConnection](Set-AzExpressRouteCrossConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnectionArpTable.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnectionArpTable.md new file mode 100644 index 0000000000..410f963177 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnectionArpTable.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: F0370845-13D9-4FB5-B30E-826A22EBC5E0 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutecrossconnectionarptable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCrossConnectionArpTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCrossConnectionArpTable.md +--- + +# Get-AzExpressRouteCrossConnectionArpTable + +## SYNOPSIS +Gets the ARP table from an ExpressRoute cross connection. + +## SYNTAX + +### SpecifyByParameterValues +``` +Get-AzExpressRouteCrossConnectionArpTable -ResourceGroupName <String> -CrossConnectionName <String> + -PeeringType <String> -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SpecifyByReference +``` +Get-AzExpressRouteCrossConnectionArpTable -ExpressRouteCrossConnection <PSExpressRouteCrossConnection> + -PeeringType <String> -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteCrossConnectionARPTable** cmdlet retrieves the ARP table from both interfaces +of an ExpressRoute cross connection. The ARP table provides a mapping of the IPv4 address to MAC address for +a particular peering. You can use the ARP table to validate layer 2 configuration and connectivity. + +## EXAMPLES + +### Example 1: Display the ARP table for an ExpressRoute peer +```powershell +Get-AzExpressRouteCrossConnectionARPTable -ResourceGroupName $RG -CrossConnectionName $CrossConnectionName -PeeringType MicrosoftPeering -DevicePath Primary +``` + +## PARAMETERS + +### -CrossConnectionName +The Name of Express Route Cross Connection + +```yaml +Type: System.String +Parameter Sets: SpecifyByParameterValues +Aliases: Name, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DevicePath +The acceptable values for this parameter are: `Primary` or `Secondary` + +```yaml +Type: Microsoft.Azure.Commands.Network.DevicePathEnum +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCrossConnection +The Express Route Cross Connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCrossConnection +Parameter Sets: SpecifyByReference +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeeringType +The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and +`MicrosoftPeering` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the ExpressRoute cross connection. + +```yaml +Type: System.String +Parameter Sets: SpecifyByParameterValues +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +This cmdlet does not accept any input. + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitArpTable + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCrossConnectionRouteTable](Get-AzExpressRouteCrossConnectionRouteTable.md) + +[Get-AzExpressRouteCrossConnectionRouteTableSummary](Get-AzExpressRouteCrossConnectionRouteTableSummary.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnectionPeering.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnectionPeering.md new file mode 100644 index 0000000000..4f318f2aac --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnectionPeering.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 47C45467-F368-4993-937E-E7E975F400B5 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutecrossconnectionpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCrossConnectionPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCrossConnectionPeering.md +--- + +# Get-AzExpressRouteCrossConnectionPeering + +## SYNOPSIS +Gets an ExpressRoute cross connection peering configuration. + +## SYNTAX + +``` +Get-AzExpressRouteCrossConnectionPeering [-Name <String>] + -ExpressRouteCrossConnection <PSExpressRouteCrossConnection> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteCrossConnectionPeering** cmdlet retrieves the configuration of a peering +relationship for an ExpressRoute cross connection. + +## EXAMPLES + +### Example 1: Display the peering configuration for an ExpressRoute cross connection +```powershell +$cc = Get-AzExpressRouteCrossConnection -Name $CrossConnectionName -ResourceGroupName $RG +Get-AzExpressRouteCrossConnectionPeering -Name "AzurePrivatePeering" -ExpressRouteCrossConnection $cc +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCrossConnection +The ExpressRoute cross connection object containing the peering configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCrossConnection +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the peering configuration to be retrieved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PSExpressRouteCrossConnection +Parameter 'ExpressRouteCrossConnection' accepts value of type 'PSExpressRouteCrossConnection' from the pipeline + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPeering + +## NOTES + +## RELATED LINKS + +[Add-AzExpressRouteCrossConnectionPeering](Add-AzExpressRouteCrossConnectionPeering.md) + +[Remove-AzExpressRouteCrossConnectionPeering](Remove-AzExpressRouteCrossConnectionPeering.md) + +[Get-AzExpressRouteCrossConnection](Get-AzExpressRouteCrossConnection.md) + +[Set-AzExpressRouteCrossConnection](Set-AzExpressRouteCrossConnection.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnectionRouteTable.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnectionRouteTable.md new file mode 100644 index 0000000000..0f015c08f2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnectionRouteTable.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: BA7F6BAC-6047-42B0-B8CA-0B36302951B0 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutecrossconnectionroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCrossConnectionRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCrossConnectionRouteTable.md +--- + +# Get-AzExpressRouteCrossConnectionRouteTable + +## SYNOPSIS +Gets a route table from an ExpressRoute cross connection. + +## SYNTAX + +### SpecifyByParameterValues +``` +Get-AzExpressRouteCrossConnectionRouteTable -ResourceGroupName <String> -CrossConnectionName <String> + -PeeringType <String> -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SpecifyByReference +``` +Get-AzExpressRouteCrossConnectionRouteTable -ExpressRouteCrossConnection <PSExpressRouteCrossConnection> + -PeeringType <String> -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteCrossConnectionRouteTable** cmdlet retrieves a detailed route table of an +ExpressRoute circuit. The route table will show all routes or can be filtered to show routes for a +specific peering type. You can use the route table to validate your peering configuration and +connectivity. + +## EXAMPLES + +### Example 1: Display the route table for the primary path +```powershell +Get-AzExpressRouteCrossConnectionRouteTable -ResourceGroupName $RG -CrossConnectionName $CircuitName -PeeringType MicrosoftPeering -DevicePath Primary +``` + +## PARAMETERS + +### -CrossConnectionName +The Name of Express Route Cross Connection + +```yaml +Type: System.String +Parameter Sets: SpecifyByParameterValues +Aliases: Name, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DevicePath +The acceptable values for this parameter are: `Primary` or `Secondary` + +```yaml +Type: Microsoft.Azure.Commands.Network.DevicePathEnum +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCrossConnection +The Express Route Cross Connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCrossConnection +Parameter Sets: SpecifyByReference +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeeringType +The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and +`MicrosoftPeering` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the ExpressRoute cross connection. + +```yaml +Type: System.String +Parameter Sets: SpecifyByParameterValues +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +This cmdlet does not accept any input. + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitRoutesTable + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCrossConnectionARPTable](Get-AzExpressRouteCrossConnectionARPTable.md) + +[Get-AzExpressRouteCrossConnectionRouteTableSummary](Get-AzExpressRouteCrossConnectionRouteTableSummary.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnectionRouteTableSummary.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnectionRouteTableSummary.md new file mode 100644 index 0000000000..130645f3fc --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteCrossConnectionRouteTableSummary.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 2C603E0E-A19F-4EA6-B918-945007BE22FF +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutecrossconnectionroutetablesummary +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCrossConnectionRouteTableSummary.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteCrossConnectionRouteTableSummary.md +--- + +# Get-AzExpressRouteCrossConnectionRouteTableSummary + +## SYNOPSIS +Gets a route table summary of an ExpressRoute cross connection. + +## SYNTAX + +### SpecifyByParameterValues +``` +Get-AzExpressRouteCrossConnectionRouteTableSummary -ResourceGroupName <String> -CrossConnectionName <String> + -PeeringType <String> -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SpecifyByReference +``` +Get-AzExpressRouteCrossConnectionRouteTableSummary -ExpressRouteCrossConnection <PSExpressRouteCrossConnection> + -PeeringType <String> -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteCrossConnectionRouteTableSummary** cmdlet retrieves a summary of BGP neighbor +information for a particular routing context. This information is useful to determine for how long +a routing context has been established and the number of route prefixes advertised by the peering +router. + +## EXAMPLES + +### Example 1: Display the route summary for the primary path +```powershell +Get-AzExpressRouteCrossConnectionRouteTableSummary -ResourceGroupName $RG -CrossConnectionName $CrossConnectionName -PeeringType MicrosoftPeering -DevicePath Primary +``` + +## PARAMETERS + +### -CrossConnectionName +The Name of Express Route Cross Connection + +```yaml +Type: System.String +Parameter Sets: SpecifyByParameterValues +Aliases: Name, ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DevicePath +The acceptable values for this parameter are: `Primary` or `Secondary` + +```yaml +Type: Microsoft.Azure.Commands.Network.DevicePathEnum +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCrossConnection +The Express Route Cross Connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCrossConnection +Parameter Sets: SpecifyByReference +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeeringType +The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and +`MicrosoftPeering` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group containing the ExpressRoute cross connection. + +```yaml +Type: System.String +Parameter Sets: SpecifyByParameterValues +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +This cmdlet does not accept any input. + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCrossConnectionRoutesTableSummary + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCrossConnectionARPTable](Get-AzExpressRouteCrossConnectionARPTable.md) + +[Get-AzExpressRouteCrossConnectionRouteTable](Get-AzExpressRouteCrossConnectionRouteTable.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteGateway.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteGateway.md new file mode 100644 index 0000000000..52165a5d4e --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteGateway.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressroutegateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteGateway.md +--- + +# Get-AzExpressRouteGateway + +## SYNOPSIS +Gets a ExpressRouteGateway resource using ResourceGroupName and GatewayName OR lists all gateways by ResourceGroupName or SubscriptionId. + +## SYNTAX + +### ListBySubscriptionId (Default) +``` +Get-AzExpressRouteGateway [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListByResourceGroupName +``` +Get-AzExpressRouteGateway [-ResourceGroupName <String>] [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByExpressRouteGatewayResourceId +``` +Get-AzExpressRouteGateway -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a ExpressRouteGateway resource using ResourceGroupName and GatewayName OR lists all gateways by ResourceGroupName or SubscriptionId. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West Central US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West Central US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" -VirtualHubId $virtualHub.Id -MinScaleUnits 2 +Get-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" +``` + +```output +ResourceGroupName : testRG +Name : testExpressRoutegw +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/ExpressRouteGateways/testExpressRoutegw +Location : West Central US +ExpressRouteGatewayScaleUnit : 2 +VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub +BgpSettings : {} +Type : Microsoft.Network/ExpressRouteGateways +ProvisioningState : Succeeded +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in West Central US in "testRG" resource group in Azure. +A ExpressRoute gateway will be created thereafter in the Virtual Hub with 2 scale units. + +It then gets the ExpressRouteGateway using its resourceGroupName and the gateway name. + +### Example 2 + +```powershell +Get-AzExpressRouteGateway -Name test* +``` + +```output +ResourceGroupName : testRG +Name : testExpressRoutegw1 +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/ExpressRouteGateways/testExpressRoutegw1 +Location : West Central US +ExpressRouteGatewayScaleUnit : 2 +VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub +BgpSettings : {} +Type : Microsoft.Network/ExpressRouteGateways +ProvisioningState : Succeeded + +ResourceGroupName : testRG +Name : testExpressRoutegw2 +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/ExpressRouteGateways/testExpressRoutegw2 +Location : West Central US +ExpressRouteGatewayScaleUnit : 2 +VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub +BgpSettings : {} +Type : Microsoft.Network/ExpressRouteGateways +ProvisioningState : Succeeded +``` + +This command will get all ExpressRouteGateways that start with "test" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: ResourceName, ExpressRouteGatewayName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceId +The Azure resource ID for the expressRouteGateway to be deleted. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteGatewayResourceId +Aliases: expressRouteGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRoutePort.md b/azps-10.1.0/Az.Network/Get-AzExpressRoutePort.md new file mode 100644 index 0000000000..4ad1fb8a3e --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRoutePort.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressrouteport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRoutePort.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRoutePort.md +--- + +# Get-AzExpressRoutePort + +## SYNOPSIS +Gets an Azure ExpressRoutePort resource. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Get-AzExpressRoutePort [-ResourceGroupName <String>] [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzExpressRoutePort -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRoutePort** cmdlet is used to retrieve an ExpressRoutePort object +from your subscription. The expressrouteport object returned can be used as input to other cmdlets that +operate on ExpressRoutePort. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzExpressRoutePort -Name $PortName -ResourceGroupName $rg +``` + +Gets the ExpressRoutePort object with name $PortName in resource group $rg in your subscription. + +### Example 2 +```powershell +Get-AzExpressRoutePort -Name test* +``` + +Gets all of the ExpressRoutePort objects whose name starts with "test". + +### Example 3 +```powershell +Get-AzExpressRoutePort -ResourceId $id +``` + +Gets the ExpressRoutePort object with ResourceId $id. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ExpressRoutePort. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name of the ExpressRoutePort. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +ResourceId of the express route port. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +## NOTES + +## RELATED LINKS + +[New-AzExpressRoutePort](./New-AzExpressRoutePort.md) + +[Remove-AzExpressRoutePort](./Remove-AzExpressRoutePort.md) + +[Set-AzExpressRoutePort](./Set-AzExpressRoutePort.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRoutePortAuthorization.md b/azps-10.1.0/Az.Network/Get-AzExpressRoutePortAuthorization.md new file mode 100644 index 0000000000..b98786f28d --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRoutePortAuthorization.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressrouteportauthorization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRoutePortAuthorization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRoutePortAuthorization.md +--- + +# Get-AzExpressRoutePortAuthorization + +## SYNOPSIS +Gets information about ExpressRoutePort authorizations. + +## SYNTAX + +``` +Get-AzExpressRoutePortAuthorization [-Name <String>] -ExpressRoutePortObject <PSExpressRoutePort> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRoutePortAuthorization** cmdlet gets information about the +authorizations assigned to an ExpressRoutePort. The owner of an ExpressRoutePort +can create these authorizations which generate an authorization key that can be +used by a ExpressRoute circuit owner to create the circuit on the ExpressRoutePort +(with a different owner). Only one circuit can be created with one ExpressRoutePort +authorization. Authorization keys, as well as other information about +the authorization, can be viewed at any time by running +**Get-AzExpressRoutePortAuthorization**. + +## EXAMPLES + +### Example 1 +```powershell +$ERPort = Get-AzExpressRoutePort -Name "ContosoPort" -ResourceGroupName "ContosoResourceGroup" +``` + +```output +Name : ContosoPort +ResourceGroupName : ContosoResourceGroup +Location : westcentralus +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/ContosoResourceGroup/pr + oviders/Microsoft.Network/expressRoutePorts/ContosoPort +Etag : W/"cf987288-013e-40bf-a2aa-b29d017e7b7f" +ResourceGuid : 4c0e5cdb-79e1-4cb8-a430-0ce9b24472ca +ProvisioningState : Succeeded +PeeringLocation : Area51-ERDirect +BandwidthInGbps : 100 +ProvisionedBandwidthInGbps : 0 +Encapsulation : QinQ +Mtu : 1500 +EtherType : 0x8100 +AllocationDate : Thursday, March 31, 2022 +Identity : null +Links : [ + { + "Name": "link1", + "Etag": "W/\"cf987288-013e-40bf-a2aa-b29d017e7b7f\"", + "Id": "/subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/ContosoResou + rceGroup/providers/Microsoft.Network/expressRoutePorts/ContosoPort/links/link1", + "RouterName": "a51-test-06gmr-cis-3", + "InterfaceName": "HundredGigE15/15/19", + "PatchPanelId": "PP:0123:1110201 - Port 42", + "RackId": "A51 02050-0123-L", + "ConnectorType": "LC", + "AdminState": "Disabled", + "ProvisioningState": "Succeeded", + "MacSecConfig": { + "SciState": "Disabled", + "Cipher": "GcmAes128" + } + }, + { + "Name": "link2", + "Etag": "W/\"cf987288-013e-40bf-a2aa-b29d017e7b7f\"", + "Id": "/subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/ContosoResou + rceGroup/providers/Microsoft.Network/expressRoutePorts/ContosoPort/links/link2", + "RouterName": "a51-test-06gmr-cis-4", + "InterfaceName": "HundredGigE15/15/19", + "PatchPanelId": "2050:0124:1110854 - Port 42", + "RackId": "A51 02050-0124-L", + "ConnectorType": "LC", + "AdminState": "Disabled", + "ProvisioningState": "Succeeded", + "MacSecConfig": { + "SciState": "Disabled", + "Cipher": "GcmAes128" + } + } + ] +Circuits : [] +``` + +```powershell +Get-AzExpressRoutePortAuthorization -ExpressRoutePortObject $ERPort +``` + +```output +Name : ContosoPortAuthorization +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/ContosoResourceGroup/provid + ers/Microsoft.Network/expressRoutePorts/ContosoPort/authorizations/ContosoPortAuthorization +Etag : W/"36ccc199-c371-4d19-88cc-90d51bfe7ea9" +AuthorizationKey : 10d01cd7-0b67-4c44-88ca-51e7effa452d +AuthorizationUseStatus : Available +ProvisioningState : Succeeded +CircuitResourceUri : +``` + +These commands return information about all the ExpressRoute authorizations associated with an +ExpressRoutePort. The first command uses the **Get-AzExpressRoutePort** cmdlet to +create an object reference a ExpressRoutePort named ContosoPort; that object reference is stored in the +variable $ERPort. The second command then uses that object reference and the +**Get-AzExpressRoutePortAuthorization** cmdlet to return information about the +authorizations associated with ContosoPort. You can also specify the name of the authorization +with this command to a specific authorization associated with ContosoPort. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRoutePortObject +The ExpressRoutePort Object + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the ExpressRoutePort authorization that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePortAuthorization + +## NOTES + +## RELATED LINKS + +[Add-AzExpressRoutePortAuthorization](./Add-AzExpressRoutePortAuthorization.md) + +[Remove-AzExpressRoutePortAuthorization](./Remove-AzExpressRoutePortAuthorization.md) diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRoutePortIdentity.md b/azps-10.1.0/Az.Network/Get-AzExpressRoutePortIdentity.md new file mode 100644 index 0000000000..8f9af34451 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRoutePortIdentity.md @@ -0,0 +1,84 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressrouteportidentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRoutePortIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRoutePortIdentity.md +--- + +# Get-AzExpressRoutePortIdentity + +## SYNOPSIS +Get identity assigned to an ExpressRoutePort. + +## SYNTAX + +``` +Get-AzExpressRoutePortIdentity -ExpressRoutePort <PSExpressRoutePort> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRoutePortIdentity** cmdlet gets identity assigned to a local Azure ExpressRoutePort object. + +## EXAMPLES + +### Example 1 +```powershell +$exrPort = Get-AzExpressRoutePort -Name $exrPortName -ResourceGroupName $resgpName +$identity = Get-AzExpressRoutePortIdentity -ExpressRoutePort $exrPort +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRoutePort +The ExpressRoute Port + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity + +## NOTES + +## RELATED LINKS + +[Set-AzExpressRoutePortIdentity](./Set-AzExpressRoutePortIdentity.md) + +[New-AzExpressRoutePortIdentity](./New-AzExpressRoutePortIdentity.md) + +[Remove-AzExpressRoutePortIdentity](./Remove-AzExpressRoutePortIdentity.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRoutePortLinkConfig.md b/azps-10.1.0/Az.Network/Get-AzExpressRoutePortLinkConfig.md new file mode 100644 index 0000000000..054efe61c1 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRoutePortLinkConfig.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressrouteportlinkconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRoutePortLinkConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRoutePortLinkConfig.md +--- + +# Get-AzExpressRoutePortLinkConfig + +## SYNOPSIS +Gets an ExpressRoutePort link configuration. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Get-AzExpressRoutePortLinkConfig -ExpressRoutePort <PSExpressRoutePort> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzExpressRoutePortLinkConfig -ResourceId <String> -ExpressRoutePort <PSExpressRoutePort> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRoutePortLinkConfig** cmdlet retrieves the configuration of a link +of an ExpressRoutePort. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzExpressRoutePortLinkConfig -ExpressRoutePort $erport -Name Link1 +``` + +Gets the Link1 configuration of ExpressRoutePort $erport + +### Example 2 +```powershell +Get-AzExpressRoutePortLinkConfig -ExpressRoutePort $erport -ResourceId $id +``` + +Gets the configuration of link with ResourceId $id in ExpressRoutePort $erport + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRoutePort +The reference of the ExpressRoutePort resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the link. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the link. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteLink + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRoutePortsLocation.md b/azps-10.1.0/Az.Network/Get-AzExpressRoutePortsLocation.md new file mode 100644 index 0000000000..0c60ef5194 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRoutePortsLocation.md @@ -0,0 +1,88 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressrouteportslocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRoutePortsLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRoutePortsLocation.md +--- + +# Get-AzExpressRoutePortsLocation + +## SYNOPSIS +Gets the locations at which ExpressRoutePort resources are available. + +## SYNTAX + +``` +Get-AzExpressRoutePortsLocation [-LocationName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRoutePortsLocation** cmdlet is used to retrieve the locations at which +ExpressRoutePort resources are available. Given a specific location as input, the cmdlet displays +the details of that location i.e., list of available bandwidths at that location. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzExpressRoutePortsLocation +``` + +Lists the locations at which ExpressRoutePort resources are available. + +### Example 2 +```powershell +Get-AzExpressRoutePortsLocation -LocationName $loc +``` + +Lists the ExpressRoutePort bandwidths available at location $loc. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationName +The name of the location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePortsLocation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzExpressRouteServiceProvider.md b/azps-10.1.0/Az.Network/Get-AzExpressRouteServiceProvider.md new file mode 100644 index 0000000000..6cd0c84e21 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzExpressRouteServiceProvider.md @@ -0,0 +1,73 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 009F6E65-0268-4505-AEC1-FF379CB96804 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azexpressrouteserviceprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteServiceProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzExpressRouteServiceProvider.md +--- + +# Get-AzExpressRouteServiceProvider + +## SYNOPSIS +Gets a list ExpressRoute service providers and their attributes. + +## SYNTAX + +``` +Get-AzExpressRouteServiceProvider [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzExpressRouteServiceProvider** cmdlet retrieves a list ExpressRoute service +providers and their attributes. Attribute include location and bandwidth options. + +## EXAMPLES + +### Example 1: Get a list of service provider with locations in "Silicon Valley" +```powershell +Get-AzExpressRouteServiceProvider | + Where-Object PeeringLocations -Contains "Silicon Valley" | + Select-Object Name +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteServiceProvider + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuitARPTable](Get-AzExpressRouteCircuitARPTable.md) + +[Get-AzExpressRouteCircuitRouteTable](Get-AzExpressRouteCircuitRouteTable.md) + +[Get-AzExpressRouteCircuitRouteTableSummary](Get-AzExpressRouteCircuitRouteTableSummary.md) + +[Get-AzExpressRouteCircuitStat](./Get-AzExpressRouteCircuitStat.md) diff --git a/azps-10.1.0/Az.Network/Get-AzFirewall.md b/azps-10.1.0/Az.Network/Get-AzFirewall.md new file mode 100644 index 0000000000..303d2dbcc9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzFirewall.md @@ -0,0 +1,350 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 91D58F60-F22A-454A-B04C-E5AEF33E9D06 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azfirewall +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzFirewall.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzFirewall.md +--- + +# Get-AzFirewall + +## SYNOPSIS +Gets a Azure Firewall. + +## SYNTAX + +``` +Get-AzFirewall [-Name <String>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzFirewall** cmdlet gets one or more Firewalls in a resource group. + +## EXAMPLES + +### Example 1: Retrieve all Firewalls in a resource group +```powershell +Get-AzFirewall -ResourceGroupName rgName +``` + +```output +Name : azFw +ResourceGroupName : rgName +Location : westcentralus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Micros + oft.Network/azureFirewalls/azFw +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : +ProvisioningState : Succeeded +Tags : +IpConfigurations : [ + { + "Name": "AzureFirewallIpConfiguration", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/provi + ders/Microsoft.Network/azureFirewalls/azFw/azureFirewallIpConfigurations/AzureFirewallIp + Configuration", + "PrivateIPAddress": "x.x.x.x", + "Subnet": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/pro + viders/Microsoft.Network/virtualNetworks/vnetname/subnets/AzureFirewallSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/pro + viders/Microsoft.Network/publicIPAddresses/publicipname" + } + } + ] +ApplicationRuleCollections : [] +NatRuleCollections : [] +NetworkRuleCollections : [] +Zones : {} + +Name : azFw1 +ResourceGroupName : rgName +Location : westcentralus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Micros + oft.Network/azureFirewalls/azFw1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : +ProvisioningState : Succeeded +Tags : +IpConfigurations : [ + { + "Name": "AzureFirewallIpConfiguration", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/provi + ders/Microsoft.Network/azureFirewalls/azFw1/azureFirewallIpConfigurations/AzureFirewallIp + Configuration", + "PrivateIPAddress": "x.x.x.x", + "Subnet": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/pro + viders/Microsoft.Network/virtualNetworks/vnetname/subnets/AzureFirewallSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/pro + viders/Microsoft.Network/publicIPAddresses/publicipname" + } + } + ] +ApplicationRuleCollections : [] +NatRuleCollections : [] +NetworkRuleCollections : [] +Zones : {} +``` + +This example retrieves all Firewalls in resource group "rgName". + +### Example 2: Retrieve a Firewall by name +```powershell +Get-AzFirewall -ResourceGroupName rgName -Name azFw +``` + +```output +Name : azFw +ResourceGroupName : rgName +Location : westcentralus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Micros + oft.Network/azureFirewalls/azFw +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : +ProvisioningState : Succeeded +Tags : +IpConfigurations : [ + { + "Name": "AzureFirewallIpConfiguration", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/provi + ders/Microsoft.Network/azureFirewalls/azFw/azureFirewallIpConfigurations/AzureFirewallIp + Configuration", + "PrivateIPAddress": "x.x.x.x", + "Subnet": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/pro + viders/Microsoft.Network/virtualNetworks/vnetname/subnets/AzureFirewallSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/pro + viders/Microsoft.Network/publicIPAddresses/publicipname" + } + } + ] +ApplicationRuleCollections : [] +NatRuleCollections : [] +NetworkRuleCollections : [] +Zones : {} +``` + +This example retrieves Firewall named "azFw" in resource group "rgName". + +### Example 3: Retrieve all Firewalls with filtering +```powershell +Get-AzFirewall -Name azFw* +``` + +```output +Name : azFw +ResourceGroupName : rgName +Location : westcentralus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Micros + oft.Network/azureFirewalls/azFw +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : +ProvisioningState : Succeeded +Tags : +IpConfigurations : [ + { + "Name": "AzureFirewallIpConfiguration", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/provi + ders/Microsoft.Network/azureFirewalls/azFw/azureFirewallIpConfigurations/AzureFirewallIp + Configuration", + "PrivateIPAddress": "x.x.x.x", + "Subnet": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/pro + viders/Microsoft.Network/virtualNetworks/vnetname/subnets/AzureFirewallSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/pro + viders/Microsoft.Network/publicIPAddresses/publicipname" + } + } + ] +ApplicationRuleCollections : [] +NatRuleCollections : [] +NetworkRuleCollections : [] +Zones : {} + +Name : azFw1 +ResourceGroupName : rgName +Location : westcentralus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Micros + oft.Network/azureFirewalls/azFw1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : +ProvisioningState : Succeeded +Tags : +IpConfigurations : [ + { + "Name": "AzureFirewallIpConfiguration", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/provi + ders/Microsoft.Network/azureFirewalls/azFw1/azureFirewallIpConfigurations/AzureFirewallIp + Configuration", + "PrivateIPAddress": "x.x.x.x", + "Subnet": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/pro + viders/Microsoft.Network/virtualNetworks/vnetname/subnets/AzureFirewallSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/pro + viders/Microsoft.Network/publicIPAddresses/publicipname" + } + } + ] +ApplicationRuleCollections : [] +NatRuleCollections : [] +NetworkRuleCollections : [] +Zones : {} +``` + +This example retrieves all Firewalls that start with "azFw" + +### Example 4: Retrieve a firewall and then add a application rule collection to the Firewall +```powershell +$azFw=Get-AzFirewall -Name "azFw" -ResourceGroupName "rgName" +$appRule = New-AzFirewallApplicationRule -Name R1 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" -SourceAddress "10.0.0.0" +$appRuleCollection = New-AzFirewallApplicationRuleCollection -Name "MyAppRuleCollection" -Priority 100 -Rule $appRule -ActionType "Allow" +$azFw.AddApplicationRuleCollection($appRuleCollection) +``` + +This example retrieves a firewall, then adds a application rule collection to the firewall by calling method AddApplicationRuleCollection. + +### Example 5: Retrieve a firewall and then add a network rule collection to the Firewall +```powershell +$azFw=Get-AzFirewall -Name "azFw" -ResourceGroupName "rgName" +$netRule = New-AzFirewallNetworkRule -Name "all-udp-traffic" -Description "Rule for all UDP traffic" -Protocol "UDP" -SourceAddress "*" -DestinationAddress "*" -DestinationPort "*" +$netRuleCollection = New-AzFirewallNetworkRuleCollection -Name "MyNetworkRuleCollection" -Priority 100 -Rule $netRule -ActionType "Allow" +$azFw.AddNetworkRuleCollection($netRuleCollection) +``` + +This example retrieves a firewall, then adds a network rule collection to the firewall by calling method AddNetworkRuleCollection. + +### Example 6: Retrieve a firewall and then retrieve a application rule collection by name from the Firewall +```powershell +$azFw=Get-AzFirewall -Name "azFw" -ResourceGroupName "rgName" +$getAppRc=$azFw.GetApplicationRuleCollectionByName("MyAppRuleCollection") +``` + +This example retrieves a firewall and then gets a rule collection by name, calling method GetApplicationRuleCollectionByName on the +firewall object. The rule collection name for method GetApplicationRuleCollectionByName is case-insensitive. + +### Example 7: Retrieve a firewall and then retrieve a network rule collection by name from the Firewall +```powershell +$azFw=Get-AzFirewall -Name "azFw" -ResourceGroupName "rgName" +$getNetRc=$azFw.GetNetworkRuleCollectionByName("MyNetworkRuleCollection") +``` + +This example retrieves a firewall and then gets a rule collection by name, calling method GetNetworkRuleCollectionByName on the +firewall object. The rule collection name for method GetNetworkRuleCollectionByName is case-insensitive. + +### Example 8: Retrieve a firewall and then remove a application rule collection by name from the Firewall +```powershell +$azFw=Get-AzFirewall -Name "azFw" -ResourceGroupName "rgName" +$azFw.RemoveApplicationRuleCollectionByName("MyAppRuleCollection") +``` + +This example retrieves a firewall and then removes a rule collection by name, calling method RemoveApplicationRuleCollectionByName on the +firewall object. The rule collection name for method RemoveApplicationRuleCollectionByName is case-insensitive. + +### Example 9: Retrieve a firewall and then remove a network rule collection by name from the Firewall +```powershell +$azFw=Get-AzFirewall -Name "azFw" -ResourceGroupName "rgName" +$azFw.RemoveNetworkRuleCollectionByName("MyNetworkRuleCollection") +``` + +This example retrieves a firewall and then removes a rule collection by name, calling method RemoveNetworkRuleCollectionByName on the +firewall object. The rule collection name for method RemoveNetworkRuleCollectionByName is case-insensitive. + +### Example 10: Retrieve a firewall and then allocate the firewall +```powershell +$vnet=Get-AzVirtualNetwork -Name "vnet" -ResourceGroupName "rgName" +$publicIp=Get-AzPublicIpAddress -Name "firewallpip" -ResourceGroupName "rgName" +$azFw=Get-AzFirewall -Name "azFw" -ResourceGroupName "rgName" +$azFw.Allocate($vnet, $publicIp) +``` + +This example retrieves a firewall and calls Allocate on the firewall to start the firewall service using the configuration +(application and network rule collections) associated with the firewall. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Firewall that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the resource group that Firewall belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewall + +### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.Network.Models.PSAzureFirewall, Microsoft.Azure.PowerShell.Cmdlets.Network, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## NOTES + +## RELATED LINKS + +[New-AzFirewall](./New-AzFirewall.md) + +[Remove-AzFirewall](./Remove-AzFirewall.md) + +[Set-AzFirewall](./Set-AzFirewall.md) diff --git a/azps-10.1.0/Az.Network/Get-AzFirewallFqdnTag.md b/azps-10.1.0/Az.Network/Get-AzFirewallFqdnTag.md new file mode 100644 index 0000000000..d415f35866 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzFirewallFqdnTag.md @@ -0,0 +1,78 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 98CB62E1-0A18-4207-81FA-07CC60310896 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azfirewallfqdntag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzFirewallFqdnTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzFirewallFqdnTag.md +--- + +# Get-AzFirewallFqdnTag + +## SYNOPSIS +Gets the available Azure Firewall Fqdn Tags. + +## SYNTAX + +``` +Get-AzFirewallFqdnTag [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzFirewallFqdnTag** cmdlet gets the list of FQDN Tags which can be used for Azure Firewall Application Rules + +## EXAMPLES + +### 1: Retrieve all available FQDN Tags +```powershell +Get-AzFirewallFqdnTag +``` + +This example retrieves all available FQDN Tags. + +### 2: Use first available FQDN Tag in an Application Rule +```powershell +$fqdnTags = Get-AzFirewallFqdnTag +New-AzFirewallApplicationRule -Name AR -SourceAddress * -FqdnTag $fqdnTags[0].FqdnTagName +``` + +This example creates a Firewall Application Rule using the first available FQDN Tag + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallFqdnTag + +### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.Network.Models.PSAzureFirewallFqdnTag, Microsoft.Azure.PowerShell.Cmdlets.Network, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +## NOTES + +## RELATED LINKS + +[New-AzFirewallApplicationRule](./New-AzFirewallApplicationRule.md) + +[New-AzFirewall](./New-AzFirewall.md) diff --git a/azps-10.1.0/Az.Network/Get-AzFirewallLearnedIpPrefix.md b/azps-10.1.0/Az.Network/Get-AzFirewallLearnedIpPrefix.md new file mode 100644 index 0000000000..d41448a77f --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzFirewallLearnedIpPrefix.md @@ -0,0 +1,97 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/Get-AzFirewallLearnedIpPrefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzFirewallLearnedIpPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzFirewallLearnedIpPrefix.md +--- + +# Get-AzFirewallLearnedIpPrefix + +## SYNOPSIS +Gets firewall auto learned ip prefixes. + +## SYNTAX + +``` +Get-AzFirewallLearnedIpPrefix [-Name <String>] [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzFirewallLearnedIpPrefix** cmdlet gets a firewall auto learned ip prefixes. + +## EXAMPLES + +### Example 1: Retrieve a Firewall auto learned ip prefixes by its name + +```powershell +Get-AzFirewallLearnedIpPrefix -ResourceGroupName rgName -Name azFw +``` + +```output +IpPrefixes : [ "10.101.0.0/16", "10.102.0.0/16" ] +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Firewall that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the resource group that Firewall belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallIpPrefix + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzFirewallPolicy.md b/azps-10.1.0/Az.Network/Get-AzFirewallPolicy.md new file mode 100644 index 0000000000..09fc247307 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzFirewallPolicy.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azfirewallpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzFirewallPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzFirewallPolicy.md +--- + +# Get-AzFirewallPolicy + +## SYNOPSIS +Gets a Azure Firewall Policy + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzFirewallPolicy -Name <String> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzFirewallPolicy -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzFirewallPolicy** cmdlet gets one or more Firewalls in a resource group + +## EXAMPLES + +### Example 1 +```powershell +Get-AzFirewallPolicy -Name firewallPolicy -ResourceGroupName TestRg +``` + +This example gets a firewall policy named "firewallPolicy" in the resource group "TestRg" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +The resource Id. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewall + +### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.Network.Models.PSAzureFirewall, Microsoft.Azure.PowerShell.Cmdlets.Network, Version=1.12.0.0, Culture=neutral, PublicKeyToken=null]] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzFirewallPolicyRuleCollectionGroup.md b/azps-10.1.0/Az.Network/Get-AzFirewallPolicyRuleCollectionGroup.md new file mode 100644 index 0000000000..976b7d2cd9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzFirewallPolicyRuleCollectionGroup.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azfirewallpolicyrulecollectiongroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzFirewallPolicyRuleCollectionGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzFirewallPolicyRuleCollectionGroup.md +--- + +# Get-AzFirewallPolicyRuleCollectionGroup + +## SYNOPSIS +Gets a Azure Firewall Policy Rule Collection Group + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzFirewallPolicyRuleCollectionGroup -Name <String> -ResourceGroupName <String> + -AzureFirewallPolicyName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzFirewallPolicyRuleCollectionGroup -Name <String> -AzureFirewallPolicy <PSAzureFirewallPolicy> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzFirewallPolicyRuleCollectionGroup -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzFirewallPolicyRuleCollectionGroup** cmdlet gets the RuleCollectionGroup mentioned from a Firewall Policy + +## EXAMPLES + +### Example 1 +```powershell +Get-AzFirewallPolicyRuleCollectionGroup -Name rg1 -AzureFirewallPolicy $fp +``` + +This example get the rule collectionGroup in the firewall policy $fp + +### Example 2 + +Gets a Azure Firewall Policy Rule Collection Group. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Get-AzFirewallPolicyRuleCollectionGroup -AzureFirewallPolicyName fpName -Name rg1 -ResourceGroupName myresourcegroup +``` + +## PARAMETERS + +### -AzureFirewallPolicy +Firewall Policy. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicy +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AzureFirewallPolicyName +The Firewall policy name + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Firewall Policy Rule Collection Group resource name. For example: "DefaultNetworkRuleCollectionGroup" + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: GetByInputObjectParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +The resource Id. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewall + +### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.Network.Models.PSAzureFirewall, Microsoft.Azure.PowerShell.Cmdlets.Network, Version=1.12.0.0, Culture=neutral, PublicKeyToken=null]] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzIpAllocation.md b/azps-10.1.0/Az.Network/Get-AzIpAllocation.md new file mode 100644 index 0000000000..e39bf8d149 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzIpAllocation.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azipallocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzIpAllocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzIpAllocation.md +--- + +# Get-AzIpAllocation + +## SYNOPSIS +Gets a Azure IpAllocation. + +## SYNTAX + +### GetByNameParameterSet +``` +Get-AzIpAllocation -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ListParameterSet +``` +Get-AzIpAllocation [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzIpAllocation -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzIpAllocation** cmdlet gets an Azure IpAllocation + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIpAllocation -ResourceGroupName 'TestResourceGroup' -Name 'TestIpAllocation' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ListParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IpAllocation Id + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIpAllocation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzIpGroup.md b/azps-10.1.0/Az.Network/Get-AzIpGroup.md new file mode 100644 index 0000000000..342bc2d1a8 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzIpGroup.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azipgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzIpGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzIpGroup.md +--- + +# Get-AzIpGroup + +## SYNOPSIS +Get an Azure IpGroup + +## SYNTAX + +### IpGroupNameParameterSet (Default) +``` +Get-AzIpGroup [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### IpGroupResourceIdParameterSet +``` +Get-AzIpGroup -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzIpGroup** cmdlet gets an Azure IpGroup + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIpGroup -ResourceGroupName ipGroupRG -Name ipGroup +``` + +### Example 2 +```powershell +$ipGroupId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/ipGroupRG/providers/Microsoft.Network/ipGroups/ipGroup' +Get-AzIpGroup -ResourceId $ipGroupId +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ipgroup. + +```yaml +Type: System.String +Parameter Sets: IpGroupNameParameterSet +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name of the ipgroup. + +```yaml +Type: System.String +Parameter Sets: IpGroupNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +ResourceId of the ipgroup. + +```yaml +Type: System.String +Parameter Sets: IpGroupResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIpGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzLoadBalancer.md b/azps-10.1.0/Az.Network/Get-AzLoadBalancer.md new file mode 100644 index 0000000000..1b707e80d4 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzLoadBalancer.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 78F356F6-A621-4C27-B9CC-D103E74B3A33 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azloadbalancer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancer.md +--- + +# Get-AzLoadBalancer + +## SYNOPSIS +Gets a load balancer. + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzLoadBalancer [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### Expand +``` +Get-AzLoadBalancer -ResourceGroupName <String> -Name <String> -ExpandResource <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLoadBalancer** cmdlet gets one or more Azure load balancers that are contained in a resource group. + +## EXAMPLES + +### Example 1: Get a load balancer +```powershell +Get-AzLoadBalancer -Name "MyLoadBalancer1" -ResourceGroupName "MyResourceGroup" +``` + +```output +Name : MyLoadBalancer1 +ResourceGroupName : MyResourceGroup +Location : australiaeast +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/M + icrosoft.Network/loadBalancers/MyLoadBalancer1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +FrontendIpConfigurations : [] +BackendAddressPools : [] +LoadBalancingRules : [] +Probes : [] +InboundNatRules : [] +InboundNatPools : [] +Sku : { + "Name": "Basic", + "Tier": "Regional" + } +``` + +This command gets the load balancer named MyLoadBalancer. +A load balancer must exist before you can run this cmdlet. + +### Example 2: List load balancers using filtering +```powershell +Get-AzLoadBalancer -Name MyLoadBalancer* +``` + +```output +Name : MyLoadBalancer1 +ResourceGroupName : MyResourceGroup +Location : australiaeast +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/M + icrosoft.Network/loadBalancers/MyLoadBalancer1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +FrontendIpConfigurations : [] +BackendAddressPools : [] +LoadBalancingRules : [] +Probes : [] +InboundNatRules : [] +InboundNatPools : [] +Sku : { + "Name": "Basic", + "Tier": "Regional" + } + +Name : MyLoadBalancer2 +ResourceGroupName : MyResourceGroup +Location : australiaeast +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/M + icrosoft.Network/loadBalancers/MyLoadBalancer2 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +FrontendIpConfigurations : [] +BackendAddressPools : [] +LoadBalancingRules : [] +Probes : [] +InboundNatRules : [] +InboundNatPools : [] +Sku : { + "Name": "Basic", + "Tier": "Regional" + } +``` + +This command gets all load balancers with a name that starts with "MyLoadBalancer" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandResource +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[New-AzLoadBalancer](./New-AzLoadBalancer.md) + +[Remove-AzLoadBalancer](./Remove-AzLoadBalancer.md) + +[Set-AzLoadBalancer](./Set-AzLoadBalancer.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping.md b/azps-10.1.0/Az.Network/Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping.md new file mode 100644 index 0000000000..d46618ce48 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azloadbalancerbackendaddressinboundnatruleportmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping.md +--- + +# Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping + +## SYNOPSIS +Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping retrieves inbound nat rule port mapping list for one backend address. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping -ResourceGroupName <String> + -LoadBalancerName <String> [-Name <String>] [-IpAddress <String>] + [-NetworkInterfaceIpConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping [-Name <String>] -LoadBalancer <PSLoadBalancer> + [-IpAddress <String>] [-NetworkInterfaceIpConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping -ResourceId <String> [-IpAddress <String>] + [-NetworkInterfaceIpConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get-AzLoadBalancerBackendAddressPool retrieves inbound nat rule port mapping list for one backend address. + +## EXAMPLES + +### Example 1 +```powershell +## Get inbound nat rule port mapping by NIC id +Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping -ResourceGroupName $rgname -LoadBalancerName $lbName -NetworkInterfaceIpConfigurationId $ipconfig.Id -Name pool1 +``` + +### Example 2 +```powershell +## Get inbound nat rule port mapping by ip address +$testIpAddress1 = "10.0.0.5" +Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping -ResourceGroupName $rgname -LoadBalancerName $lbName -Name $backendAddressPoolName -IpAddress $testIpAddress1 +``` + +### Example 3 +```powershell +## Get inbound nat rule port mapping by ip address and load balancer object +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping -LoadBalancer $slb -Name $backendAddressPoolName -IpAddress $testIpAddress1 +``` + +### Example 4 +```powershell +## Get inbound nat rule port mapping by ip address and backend pool id +Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping -ResourceId $backendPool1.Id -IpAddress $testIpAddress1 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddress + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies the load balancer that has the backend address pool + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LoadBalancerName +The name of the load balancer. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the backend address pool. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterfaceIpConfigurationId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the load balancer. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSInboundNatRulePortMapping + +## NOTES + +## RELATED LINKS + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) diff --git a/azps-10.1.0/Az.Network/Get-AzLoadBalancerBackendAddressPool.md b/azps-10.1.0/Az.Network/Get-AzLoadBalancerBackendAddressPool.md new file mode 100644 index 0000000000..41e136d85b --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzLoadBalancerBackendAddressPool.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azloadbalancerbackendaddresspool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerBackendAddressPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerBackendAddressPool.md +--- + +# Get-AzLoadBalancerBackendAddressPool + +## SYNOPSIS +Get-AzLoadBalancerBackendAddressPool retrieves one or more backend address pools associated with a load balancer. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzLoadBalancerBackendAddressPool -ResourceGroupName <String> -LoadBalancerName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzLoadBalancerBackendAddressPool [-Name <String>] -LoadBalancer <PSLoadBalancer> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzLoadBalancerBackendAddressPool -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get-AzLoadBalancerBackendAddressPool retrieves one or more backend address pools associated with a load balancer. + +## EXAMPLES + +### Example 1 +```powershell +## Get single backend under loadbalancer +$lb = Get-AzLoadBalancer -ResourceGroupName $resourceGroup -Name $loadBalancerName +``` + +```powershell +## Get all backends under loadbalancer +$lb | Get-AzLoadBalancerBackendAddressPool +``` + +### Example 2 +```powershell +#Get specific backend from loadbalancer +$lb | Get-AzLoadBalancerBackendAddressPool -Name $backendPool1 +``` + +### Example 3 +```powershell +#Get a backend by resource Id +Get-AzLoadBalancerBackendAddressPool -ResourceId $backendPool1.Id +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +{{ Fill LoadBalancer Description }} + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LoadBalancerName +The name of the load balancer. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the backend address pool. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the load balancer. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzLoadBalancerBackendAddressPoolConfig.md b/azps-10.1.0/Az.Network/Get-AzLoadBalancerBackendAddressPoolConfig.md new file mode 100644 index 0000000000..c79857e5c2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzLoadBalancerBackendAddressPoolConfig.md @@ -0,0 +1,107 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: F421174A-B138-45EB-AF84-CB3CE5870F27 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azloadbalancerbackendaddresspoolconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerBackendAddressPoolConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerBackendAddressPoolConfig.md +--- + +# Get-AzLoadBalancerBackendAddressPoolConfig + +## SYNOPSIS +Gets a backend address pool configuration for a load balancer. + +## SYNTAX + +``` +Get-AzLoadBalancerBackendAddressPoolConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLoadBalancerBackendAddressPoolConfig** cmdlet gets a single backend address pool or a list of backend address pools within a load balancer. + +## EXAMPLES + +### Example 1: Get the backend address pool +```powershell +$loadbalancer = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +Get-AzLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool02" -LoadBalancer $loadbalancer +``` + +The first command gets an existing load balancer named MyLoadBalancer in the resource group named MyResourceGroup, and then stores it in the $loadbalancer variable. +The second command gets the associated backend address pool configuration named BackendAddressPool02 for the load balancer in $loadbalancer. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies the load balancer that is associated with the backend address pool to get. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the load balancer that contains the backend address pool to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerBackendAddressPoolConfig](./Add-AzLoadBalancerBackendAddressPoolConfig.md) + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[New-AzLoadBalancerBackendAddressPoolConfig](./New-AzLoadBalancerBackendAddressPoolConfig.md) + +[Remove-AzLoadBalancerBackendAddressPoolConfig](./Remove-AzLoadBalancerBackendAddressPoolConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzLoadBalancerFrontendIpConfig.md b/azps-10.1.0/Az.Network/Get-AzLoadBalancerFrontendIpConfig.md new file mode 100644 index 0000000000..b6e30274f0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzLoadBalancerFrontendIpConfig.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 6BEED413-E2E4-4557-BD31-2A655E790C1D +online version: https://learn.microsoft.com/powershell/module/az.network/get-azloadbalancerfrontendipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerFrontendIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerFrontendIpConfig.md +--- + +# Get-AzLoadBalancerFrontendIpConfig + +## SYNOPSIS +Gets a front-end IP configuration in a load balancer. + +## SYNTAX + +``` +Get-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLoadBalancerFrontendIpConfig** cmdlet gets a front-end IP configuration or a list of front-end IP configurations in a load balancer. + +## EXAMPLES + +### Example 1: Get a front-end IP configuration in a load balancer +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +Get-AzLoadBalancerFrontendIpConfig -Name "MyFrontEnd" -LoadBalancer $slb +``` + +The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. +The second command gets the front end IP configuration associated with that load balancer. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies the load balancer that is associated with the front-end IP configuration to get. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the load balancer that contains the front-end IP configuration to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerFrontendIpConfig](./Add-AzLoadBalancerFrontendIpConfig.md) + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[New-AzLoadBalancerFrontendIpConfig](./New-AzLoadBalancerFrontendIpConfig.md) + +[Remove-AzLoadBalancerFrontendIpConfig](./Remove-AzLoadBalancerFrontendIpConfig.md) + +[Set-AzLoadBalancerFrontendIpConfig](./Set-AzLoadBalancerFrontendIpConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzLoadBalancerInboundNatPoolConfig.md b/azps-10.1.0/Az.Network/Get-AzLoadBalancerInboundNatPoolConfig.md new file mode 100644 index 0000000000..0f09402365 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzLoadBalancerInboundNatPoolConfig.md @@ -0,0 +1,98 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 614B0634-154A-449A-83E7-051DEF5A3BEE +online version: https://learn.microsoft.com/powershell/module/az.network/get-azloadbalancerinboundnatpoolconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerInboundNatPoolConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerInboundNatPoolConfig.md +--- + +# Get-AzLoadBalancerInboundNatPoolConfig + +## SYNOPSIS +Gets one or more inbound NAT pool configurations from a load balancer. + +## SYNTAX + +``` +Get-AzLoadBalancerInboundNatPoolConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLoadBalancerInboundNatPoolConfig** cmdlet gets one or more inbound NAT pool configurations from a load balancer. + +## EXAMPLES + +### 1: Get +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$slb | Get-AzLoadBalancerInboundNatPoolConfig -Name myInboundNatPool +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSInboundNatPool + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerInboundNatPoolConfig](./Add-AzLoadBalancerInboundNatPoolConfig.md) + +[New-AzLoadBalancerInboundNatPoolConfig](./New-AzLoadBalancerInboundNatPoolConfig.md) + +[Remove-AzLoadBalancerInboundNatPoolConfig](./Remove-AzLoadBalancerInboundNatPoolConfig.md) + +[Set-AzLoadBalancerInboundNatPoolConfig](./Set-AzLoadBalancerInboundNatPoolConfig.md) diff --git a/azps-10.1.0/Az.Network/Get-AzLoadBalancerInboundNatRuleConfig.md b/azps-10.1.0/Az.Network/Get-AzLoadBalancerInboundNatRuleConfig.md new file mode 100644 index 0000000000..562620eeab --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzLoadBalancerInboundNatRuleConfig.md @@ -0,0 +1,107 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 1FDA90C0-D01F-45E1-9149-16AD04046271 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azloadbalancerinboundnatruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerInboundNatRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerInboundNatRuleConfig.md +--- + +# Get-AzLoadBalancerInboundNatRuleConfig + +## SYNOPSIS +Gets an inbound NAT rule configuration for a load balancer. + +## SYNTAX + +``` +Get-AzLoadBalancerInboundNatRuleConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLoadBalancerInboundNatRuleConfig** cmdlet gets one or more inbound network address translation (NAT) rules in an Azure load balancer. + +## EXAMPLES + +### Example 1: Get an inbound NAT rule configuration +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +Get-AzLoadBalancerInboundNatRuleConfig -Name "MyInboundNatRule1" -LoadBalancer $slb +``` + +The first command gets the load balancer named MyLoadBalancer, and stores it in the variable $slb. +The second command gets the associated NAT rule named MyInboundNatRule1 from the load balancer in $slb. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies the load balancer that is associated with the inbound NAT rule configuration to get. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the inbound NAT rule configuration to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSInboundNatRule + +## NOTES + +## RELATED LINKS + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[New-AzLoadBalancerInboundNatRuleConfig](./New-AzLoadBalancerInboundNatRuleConfig.md) + +[Remove-AzLoadBalancerInboundNatRuleConfig](./Remove-AzLoadBalancerInboundNatRuleConfig.md) + +[Set-AzLoadBalancerInboundNatRuleConfig](./Set-AzLoadBalancerInboundNatRuleConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzLoadBalancerOutboundRuleConfig.md b/azps-10.1.0/Az.Network/Get-AzLoadBalancerOutboundRuleConfig.md new file mode 100644 index 0000000000..ee14ab3cdd --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzLoadBalancerOutboundRuleConfig.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azloadbalanceroutboundruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerOutboundRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerOutboundRuleConfig.md +--- + +# Get-AzLoadBalancerOutboundRuleConfig + +## SYNOPSIS +Gets an outbound rule configuration in a load balancer. + +## SYNTAX + +``` +Get-AzLoadBalancerOutboundRuleConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLoadBalancerOutboundRuleConfig** cmdlet gets an outbound rule configuration or a list of outbound rule configurations in a load balancer. + +## EXAMPLES + +### Example 1: Get an outbound rule configuration in a load balancer +```powershell +$slb = Get-AzLoadBalancer -ResourceGroupName "MyResourceGroup" -Name "MyLoadBalancer" +Get-AzLoadBalancerOutboundRuleConfig -LoadBalancer $slb -Name "MyRule" +``` + +The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. +The second command gets the outbound rule configuration named MyRule associated with that load balancer. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +The reference of the load balancer resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the outbound rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSOutboundRule + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerOutboundRuleConfig](./Add-AzLoadBalancerOutboundRuleConfig.md) + +[New-AzLoadBalancerOutboundRuleConfig](./New-AzLoadBalancerOutboundRuleConfig.md) + +[Remove-AzLoadBalancerOutboundRuleConfig](./Remove-AzLoadBalancerOutboundRuleConfig.md) + +[Set-AzLoadBalancerOutboundRuleConfig](./Set-AzLoadBalancerOutboundRuleConfig.md) diff --git a/azps-10.1.0/Az.Network/Get-AzLoadBalancerProbeConfig.md b/azps-10.1.0/Az.Network/Get-AzLoadBalancerProbeConfig.md new file mode 100644 index 0000000000..cf09223956 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzLoadBalancerProbeConfig.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 278228EB-0126-4F27-A30F-51DC498C65FE +online version: https://learn.microsoft.com/powershell/module/az.network/get-azloadbalancerprobeconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerProbeConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerProbeConfig.md +--- + +# Get-AzLoadBalancerProbeConfig + +## SYNOPSIS +Gets a probe configuration for a load balancer. + +## SYNTAX + +``` +Get-AzLoadBalancerProbeConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLoadBalancerProbeConfig** cmdlet gets one or more probe configurations for a load balancer. + +## EXAMPLES + +### Example 1: Get the probe configuration of a load balancer +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +Get-AzLoadBalancerProbeConfig -Name "MyProbe" -LoadBalancer $slb +``` + +The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. +The second command gets the associated probe configuration named MyProbe from the load balancer in $slb. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies the load balancer that is associated with the probe configuration to get. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the probe configuration to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSProbe + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerProbeConfig](./Add-AzLoadBalancerProbeConfig.md) + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[New-AzLoadBalancerProbeConfig](./New-AzLoadBalancerProbeConfig.md) + +[Remove-AzLoadBalancerProbeConfig](./Remove-AzLoadBalancerProbeConfig.md) + +[Set-AzLoadBalancerProbeConfig](./Set-AzLoadBalancerProbeConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzLoadBalancerRuleConfig.md b/azps-10.1.0/Az.Network/Get-AzLoadBalancerRuleConfig.md new file mode 100644 index 0000000000..4fc11fb378 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzLoadBalancerRuleConfig.md @@ -0,0 +1,107 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: B2CF11FC-520C-4C14-9A1B-13F06B250B5D +online version: https://learn.microsoft.com/powershell/module/az.network/get-azloadbalancerruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLoadBalancerRuleConfig.md +--- + +# Get-AzLoadBalancerRuleConfig + +## SYNOPSIS +Gets the rule configuration for a load balancer. + +## SYNTAX + +``` +Get-AzLoadBalancerRuleConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLoadBalancerRuleConfig** cmdlet gets one or more rule configurations for a load balancer. + +## EXAMPLES + +### Example 1: Get the rule configuration of a load balancer +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +Get-AzLoadBalancerRuleConfig -Name "MyLBrulename" -LoadBalancer $slb +``` + +The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. +The second command gets the associated rule configuration named MyLBrulename from the load balancer in $slb. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies the load balancer that is associated with the rule configuration to get. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the rule configuration to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancingRule + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerRuleConfig](./Add-AzLoadBalancerRuleConfig.md) + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[Remove-AzLoadBalancerRuleConfig](./Remove-AzLoadBalancerRuleConfig.md) + +[Set-AzLoadBalancerRuleConfig](./Set-AzLoadBalancerRuleConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzLocalNetworkGateway.md b/azps-10.1.0/Az.Network/Get-AzLocalNetworkGateway.md new file mode 100644 index 0000000000..114a9a4f0a --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzLocalNetworkGateway.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: F8756DA1-7BB9-4CD5-9D81-E11FF7A26125 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azlocalnetworkgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLocalNetworkGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzLocalNetworkGateway.md +--- + +# Get-AzLocalNetworkGateway + +## SYNOPSIS +Gets a Local Network Gateway + +## SYNTAX + +``` +Get-AzLocalNetworkGateway [-Name <String>] -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Local Network Gateway is the object representing your VPN device On-Premises. +The **Get-AzLocalNetworkGateway** cmdlet returns the object representing your on-prem gateway based on Name and Resource Group Name. + +## EXAMPLES + +### Example 1: Get a Local Network Gateway +```powershell +Get-AzLocalNetworkGateway -Name myLocalGW1 -ResourceGroupName myRG +``` + +```output +Name : myLocalGW1 +ResourceGroupName : myRG +Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/M + icrosoft.Network/localNetworkGateways/myLocalGW1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +GatewayIpAddress : x.x.x.x +LocalNetworkAddressSpace : { + "AddressPrefixes": [] + } +BgpSettings : null +``` + +Returns the object of the Local Network Gateway with the name "myLocalGW1" within the resource group "myRG" + +### Example 2: Get Local Network Gateways using filtering +```powershell +Get-AzLocalNetworkGateway -Name myLocalGW* -ResourceGroupName myRG +``` + +```output +Name : myLocalGW1 +ResourceGroupName : myRG +Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/M + icrosoft.Network/localNetworkGateways/myLocalGW1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +GatewayIpAddress : x.x.x.x +LocalNetworkAddressSpace : { + "AddressPrefixes": [] + } +BgpSettings : null + +Name : myLocalGW2 +ResourceGroupName : myRG +Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/M + icrosoft.Network/localNetworkGateways/myLocalGW2 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +GatewayIpAddress : x.x.x.x +LocalNetworkAddressSpace : { + "AddressPrefixes": [] + } +BgpSettings : null +``` + +Returns the object of the Local Network Gateway with name starting with "myLocalGW" within the resource group "myRG" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway + +## NOTES + +## RELATED LINKS + +[New-AzLocalNetworkGateway](./New-AzLocalNetworkGateway.md) + +[Remove-AzLocalNetworkGateway](./Remove-AzLocalNetworkGateway.md) + +[Set-AzLocalNetworkGateway](./Set-AzLocalNetworkGateway.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNatGateway.md b/azps-10.1.0/Az.Network/Get-AzNatGateway.md new file mode 100644 index 0000000000..ad9706b7ff --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNatGateway.md @@ -0,0 +1,233 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznatgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNatGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNatGateway.md +--- + +# Get-AzNatGateway + +## SYNOPSIS +Gets a Nat Gateway resource in a resource group by name or NatGateway Id or all Nat Gateway resources in a resource group. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzNatGateway [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzNatGateway -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzNatGateway -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Nat Gateway resource in a resource group by name OR NatGateway Id OR all Nat Gateway resources in a resource group. + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +Get-AzNatGateway -ResourceGroupName "natgateway_test" + + +IdleTimeoutInMinutes : 4 +ProvisioningState : Succeeded +Sku : Microsoft.Azure.Commands.Network.Models.PSNatGatewaySku +PublicIpAddresses : {/subscriptions/<subid>/resourceGroups/natgateway_test/providers/Microsoft.Network/publicIPAddresses/Test_Pip} +PublicIpPrefixes : {} +SkuText : { + "Name": "Standard" + } +PublicIpAddressesText : [ + { + "Id": "/subscriptions/<subid>/resourceGroups/natgateway_test/providers/Microsoft.Network/publicIPAddresses/Test_Pip" + } + ] +PublicIpPrefixesText : [] +ResourceGroupName : natgateway_test +Location : eastus2 +ResourceGuid : +Type : Microsoft.Network/natGateways +Tag : +TagsTable : +Name : nat_gateway +Etag : W/"178470d2-7b86-4ddd-b954-e0cd3ab30a90" +Id : /subscriptions/<subid>/resourceGroups/natgateway_test/providers/Microsoft.Network/natGateways/nat_gateway + +IdleTimeoutInMinutes : 4 +ProvisioningState : Succeeded +Sku : Microsoft.Azure.Commands.Network.Models.PSNatGatewaySku +PublicIpAddresses : {} +PublicIpPrefixes : {} +SkuText : { + "Name": "Standard" + } +PublicIpAddressesText : [] +PublicIpPrefixesText : [] +ResourceGroupName : natgateway_test +Location : eastus2 +ResourceGuid : +Type : Microsoft.Network/natGateways +Tag : +TagsTable : +Name : ng1 +Etag : W/"bdf98e30-d6c6-4af2-8f62-10d1fdaa6e84" +Id : /subscriptions/<subid>/resourceGroups/natgateway_test/providers/Microsoft.Network/natGateways/ng1 + + +Get-AzNatGateway -ResourceGroupName "natgateway_test" -Name "nat_gateway" + + +IdleTimeoutInMinutes : 4 +ProvisioningState : Succeeded +Sku : Microsoft.Azure.Commands.Network.Models.PSNatGatewaySku +PublicIpAddresses : {/subscriptions/<subid>/resourceGroups/natgateway_test/providers/Microsoft.Network/publicIPAddresses/Test_Pip} +PublicIpPrefixes : {} +SkuText : { + "Name": "Standard" + } +PublicIpAddressesText : [ + { + "Id": "/subscriptions/<subid>/resourceGroups/natgateway_test/providers/Microsoft.Network/publicIPAddresses/Test_Pip" + } + ] +PublicIpPrefixesText : [] +ResourceGroupName : natgateway_test +Location : eastus2 +ResourceGuid : +Type : Microsoft.Network/natGateways +Tag : +TagsTable : +Name : nat_gateway +Etag : W/"178470d2-7b86-4ddd-b954-e0cd3ab30a90" +Id : /subscriptions/<subid>/resourceGroups/natgateway_test/providers/Microsoft.Network/natGateways/nat_gateway + +Get-AzNatGateway -ResourceId "/subscriptions/<subid>/resourceGroups/natgateway_test/providers/Microsoft.Network/natGateways/nat_gateway" + + +IdleTimeoutInMinutes : 4 +ProvisioningState : Succeeded +Sku : Microsoft.Azure.Commands.Network.Models.PSNatGatewaySku +PublicIpAddresses : {/subscriptions/<subid>/resourceGroups/natgateway_test/providers/Microsoft.Network/publicIPAddresses/Test_Pip} +PublicIpPrefixes : {} +SkuText : { + "Name": "Standard" + } +PublicIpAddressesText : [ + { + "Id": "/subscriptions/<subid>/resourceGroups/natgateway_test/providers/Microsoft.Network/publicIPAddresses/Test_Pip" + } + ] +PublicIpPrefixesText : [] +ResourceGroupName : natgateway_test +Location : eastus2 +ResourceGuid : +Type : Microsoft.Network/natGateways +Tag : +TagsTable : +Name : nat_gateway +Etag : W/"178470d2-7b86-4ddd-b954-e0cd3ab30a90" +Id : /subscriptions/<subid>/resourceGroups/natgateway_test/providers/Microsoft.Network/natGateways/nat_gateway +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the nat gateway. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the nat gateway. + +```yaml +Type: System.String +Parameter Sets: ListParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Nat Gateway Id + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNatGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkInterface.md b/azps-10.1.0/Az.Network/Get-AzNetworkInterface.md new file mode 100644 index 0000000000..031a01ec0c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkInterface.md @@ -0,0 +1,425 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: E066BBFA-2E03-431D-85D1-99F230B6AC59 +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkinterface +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkInterface.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkInterface.md +--- + +# Get-AzNetworkInterface + +## SYNOPSIS +Gets a network interface. + +## SYNTAX + +### NoExpandStandAloneNic (Default) +``` +Get-AzNetworkInterface [-Name <String>] [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ExpandStandAloneNic +``` +Get-AzNetworkInterface -Name <String> -ResourceGroupName <String> -ExpandResource <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NoExpandScaleSetNic +``` +Get-AzNetworkInterface [-Name <String>] -ResourceGroupName <String> [-VirtualMachineScaleSetName <String>] + [-VirtualMachineIndex <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ExpandScaleSetNic +``` +Get-AzNetworkInterface -Name <String> -ResourceGroupName <String> -VirtualMachineScaleSetName <String> + -VirtualMachineIndex <String> -ExpandResource <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceIdExpandParameterSet +``` +Get-AzNetworkInterface -ResourceId <String> -ExpandResource <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceIdNoExpandParameterSet +``` +Get-AzNetworkInterface -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkInterface** cmdlet gets an Azure network interface or a list of Azure network interfaces in a resource group. + +## EXAMPLES + +### Example 1: Get all network interfaces +```powershell +Get-AzNetworkInterface +``` + +```output +Name : test1 +ResourceGroupName : ResourceGroup1 +Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/providers/Micros + oft.Network/networkInterfaces/test1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +VirtualMachine : { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provide + rs/Microsoft.Compute/virtualMachines/test1" + } +IpConfigurations : [ + { + "Name": "test1", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provi + ders/Microsoft.Network/networkInterfaces/test1/ipConfigurations/test1", + "PrivateIpAddress": "x.x.x.x", + "PrivateIpAllocationMethod": "Dynamic", + "Subnet": { + "Delegations": [], + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/pro + viders/Microsoft.Network/virtualNetworks/test1/subnets/test1", + "ServiceAssociationLinks": [] + }, + "PublicIpAddress": { + "IpTags": [], + "Zones": [], + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/pro + viders/Microsoft.Network/publicIPAddresses/test1" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAddressVersion": "IPv4", + "LoadBalancerBackendAddressPools": [], + "LoadBalancerInboundNatRules": [], + "Primary": true, + "ApplicationGatewayBackendAddressPools": [], + "ApplicationSecurityGroups": [] + } + ] +DnsSettings : { + "DnsServers": [], + "AppliedDnsServers": [] + } +EnableIPForwarding : False +EnableAcceleratedNetworking : False +NetworkSecurityGroup : { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provide + rs/Microsoft.Network/networkSecurityGroups/test1" + } +Primary : True +MacAddress : +``` + +This command gets all network interfaces for the current subscription. + +### Example 2: Get all network interfaces with a specific provisioning state +```powershell +Get-AzNetworkInterface -ResourceGroupName "ResourceGroup1" | Where-Object {$_.ProvisioningState -eq 'Succeeded'} +``` + +```output +Name : test1 +ResourceGroupName : ResourceGroup1 +Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/providers/Micros + oft.Network/networkInterfaces/test1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +VirtualMachine : { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provide + rs/Microsoft.Compute/virtualMachines/test1" + } +IpConfigurations : [ + { + "Name": "test1", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provi + ders/Microsoft.Network/networkInterfaces/test1/ipConfigurations/test1", + "PrivateIpAddress": "x.x.x.x", + "PrivateIpAllocationMethod": "Dynamic", + "Subnet": { + "Delegations": [], + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/pro + viders/Microsoft.Network/virtualNetworks/test1/subnets/test1", + "ServiceAssociationLinks": [] + }, + "PublicIpAddress": { + "IpTags": [], + "Zones": [], + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/pro + viders/Microsoft.Network/publicIPAddresses/test1" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAddressVersion": "IPv4", + "LoadBalancerBackendAddressPools": [], + "LoadBalancerInboundNatRules": [], + "Primary": true, + "ApplicationGatewayBackendAddressPools": [], + "ApplicationSecurityGroups": [] + } + ] +DnsSettings : { + "DnsServers": [], + "AppliedDnsServers": [] + } +EnableIPForwarding : False +EnableAcceleratedNetworking : False +NetworkSecurityGroup : { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provide + rs/Microsoft.Network/networkSecurityGroups/test1" + } +Primary : True +MacAddress : +``` + +This command gets all network interfaces in the resource group named ResourceGroup1 that has a provisioning state of succeeded. + +### Example 3: Get network interfaces using filtering +```powershell +Get-AzNetworkInterface -Name test* +``` + +```output +Name : test1 +ResourceGroupName : ResourceGroup1 +Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/providers/Micros + oft.Network/networkInterfaces/test1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +VirtualMachine : { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provide + rs/Microsoft.Compute/virtualMachines/test1" + } +IpConfigurations : [ + { + "Name": "test1", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provi + ders/Microsoft.Network/networkInterfaces/test1/ipConfigurations/test1", + "PrivateIpAddress": "x.x.x.x", + "PrivateIpAllocationMethod": "Dynamic", + "Subnet": { + "Delegations": [], + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/pro + viders/Microsoft.Network/virtualNetworks/test1/subnets/test1", + "ServiceAssociationLinks": [] + }, + "PublicIpAddress": { + "IpTags": [], + "Zones": [], + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/pro + viders/Microsoft.Network/publicIPAddresses/test1" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAddressVersion": "IPv4", + "LoadBalancerBackendAddressPools": [], + "LoadBalancerInboundNatRules": [], + "Primary": true, + "ApplicationGatewayBackendAddressPools": [], + "ApplicationSecurityGroups": [] + } + ] +DnsSettings : { + "DnsServers": [], + "AppliedDnsServers": [] + } +EnableIPForwarding : False +EnableAcceleratedNetworking : False +NetworkSecurityGroup : { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provide + rs/Microsoft.Network/networkSecurityGroups/test1" + } +Primary : True +MacAddress : +``` + +This command gets all network interfaces for the current subscription that start with "test". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandResource +```yaml +Type: System.String +Parameter Sets: ExpandStandAloneNic, ExpandScaleSetNic, GetByResourceIdExpandParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network interface that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: NoExpandStandAloneNic, NoExpandScaleSetNic +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: ExpandStandAloneNic, ExpandScaleSetNic +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the resource group from which this cmdlet gets network interfaces. + +```yaml +Type: System.String +Parameter Sets: NoExpandStandAloneNic +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: ExpandStandAloneNic, NoExpandScaleSetNic, ExpandScaleSetNic +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +The Azure resource manager id of the network interface. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdExpandParameterSet, GetByResourceIdNoExpandParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -VirtualMachineIndex +Specifies the virtual machine index of the virtual machine scale set from which this cmdlet gets network interfaces. + +```yaml +Type: System.String +Parameter Sets: NoExpandScaleSetNic +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ExpandScaleSetNic +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSetName +Specifies the name of the virtual machine scale set from which this cmdlet gets network interfaces. + +```yaml +Type: System.String +Parameter Sets: NoExpandScaleSetNic +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ExpandScaleSetNic +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +## NOTES + +## RELATED LINKS + +[New-AzNetworkInterface](./New-AzNetworkInterface.md) + +[Remove-AzNetworkInterface](./Remove-AzNetworkInterface.md) + +[Set-AzNetworkInterface](./Set-AzNetworkInterface.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkInterfaceIpConfig.md b/azps-10.1.0/Az.Network/Get-AzNetworkInterfaceIpConfig.md new file mode 100644 index 0000000000..60ede61be0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkInterfaceIpConfig.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 1B39809C-90DA-4ECB-B949-D4A9A54ED982 +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkinterfaceipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkInterfaceIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkInterfaceIpConfig.md +--- + +# Get-AzNetworkInterfaceIpConfig + +## SYNOPSIS +Gets a network interface IP configuration for a network interface. + +## SYNTAX + +``` +Get-AzNetworkInterfaceIpConfig [-Name <String>] -NetworkInterface <PSNetworkInterface> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkInterfaceIPConfig** cmdlet gets a network interface IP configuration from an Azure network interface. + +## EXAMPLES + +### 1: Get an IP configuration of a network interface +```powershell +$nic1 = Get-AzNetworkInterface -Name mynic -ResourceGroupName $myrg +Get-AzNetworkInterfaceIpConfig -Name ipconfig1 -NetworkInterface $nic1 +``` + +The first command gets an existing network interface called mynic and stores it in the variable $nic1. The second + command gets the IP configuration called ipconfig1 of this network interface. + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network IP configuration that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterface +Specifies a **NetworkInterface** object that contains the network IP configuration that this cmdlet gets. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterface +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Add-AzNetworkInterfaceIpConfig](./Add-AzNetworkInterfaceIpConfig.md) + +[New-AzNetworkInterfaceIpConfig](./New-AzNetworkInterfaceIpConfig.md) + +[Remove-AzNetworkInterfaceIpConfig](./Remove-AzNetworkInterfaceIpConfig.md) + +[Set-AzNetworkInterfaceIpConfig](./Set-AzNetworkInterfaceIpConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkInterfaceTapConfig.md b/azps-10.1.0/Az.Network/Get-AzNetworkInterfaceTapConfig.md new file mode 100644 index 0000000000..4c1e5583bc --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkInterfaceTapConfig.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkinterfacetapconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkInterfaceTapConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkInterfaceTapConfig.md +--- + +# Get-AzNetworkInterfaceTapConfig + +## SYNOPSIS +Gets a Tap configuration resource. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzNetworkInterfaceTapConfig -ResourceGroupName <String> -NetworkInterfaceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzNetworkInterfaceTapConfig -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkInterfaceTapConfig** cmdlet gets an Azure Tap Configuration for a given resource group, network interface and tap configuration name or list of tap configurations in a resource group and network interface. + +## EXAMPLES + +### Example 1: Get all tap configurations for a given network interface +```powershell +Get-AzNetworkInterfaceTapConfig -ResourceGroupName "ResourceGroup1" -NetworkInterfaceName "sourceNicName" +``` + +This command gets tap configurations added for the given network interface. + +### Example 2: Get a given tap configuration +```powershell +Get-AzNetworkInterfaceTapConfig -ResourceGroupName "ResourceGroup1" -NetworkInterfaceName "sourceNicName" -Name "tapconfigName" +``` + +This command gets specific tap configuration added for the given network interface. + +### Example 3: Get a given tap configuration +```powershell +Get-AzNetworkInterfaceTapConfig -ResourceGroupName "ResourceGroup1" -NetworkInterfaceName "sourceNicName" -Name "tapconfig*" +``` + +This command gets tap configurations added for the given network interface with name starting with "tapconfig". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the specific tap configuration. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -NetworkInterfaceName +The Network Interface name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the TapConfiguration resource + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceTapConfiguration + +## NOTES + +## RELATED LINKS + +[Add-AzNetworkInterfaceTapConfig](./Add-AzNetworkInterfaceTapConfig.md) + +[Remove-AzNetworkInterfaceTapConfig](./Remove-AzNetworkInterfaceTapConfig.md) + +[Set-AzNetworkInterfaceTapConfig](./Set-AzNetworkInterfaceTapConfig.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManager.md b/azps-10.1.0/Az.Network/Get-AzNetworkManager.md new file mode 100644 index 0000000000..73bb097822 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManager.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanager +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManager.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManager.md +--- + +# Get-AzNetworkManager + +## SYNOPSIS +Gets a network manager in a resource group. + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzNetworkManager [-Name <String>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### Expand +``` +Get-AzNetworkManager -Name <String> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManager** cmdlet gets one or more network managers in a resource group. + +## EXAMPLES + +### Example 1: Retrieve a network manager +```powershell +Get-AzNetworkManager -ResourceGroupName "TestResourceGroup" -Name "TestNM" +``` + +```output +DisplayName : +Description : +Location : eastus2euap +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/provider + s/Microsoft.Network/networkManagers/TestNM +Type : Microsoft.Network/networkManagers +Tag : {} +ProvisioningState : Succeeded +NetworkManagerScopeAccesses : [ + "SecurityAdmin", + "SecurityUser" + ] +NetworkManagerScopes : { + "ManagementGroups": [], + "Subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + } +SystemData : { + "CreatedBy": "user@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2021-10-05T04:15:42", + "LastModifiedBy": "user@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2021-10-05T04:15:42" + } +Name : TestNM +Etag : W/"00000000-0000-0000-0000-000000000000" +``` + +Retrieve a network manager. + +### Example 2: List all network managers in a resource group +```powershell +Get-AzNetworkManager -ResourceGroupName "TestResourceGroup" +``` + +```output +DisplayName : +Description : +Location : eastus2euap +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/provider + s/Microsoft.Network/networkManagers/TestNM +Type : Microsoft.Network/networkManagers +Tag : {} +ProvisioningState : Succeeded +NetworkManagerScopeAccesses : [ + "SecurityAdmin", + "SEcurityUser" + ] +NetworkManagerScopes : { + "ManagementGroups": [], + "Subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + } +SystemData : { + "CreatedBy": "user@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2021-10-05T04:15:42", + "LastModifiedBy": "user@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2021-10-05T04:15:42" + } +Name : TestNM +Etag : W/"00000000-0000-0000-0000-000000000000" +``` + +List all network managers in a resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManager + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerActiveConnectivityConfiguration.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerActiveConnectivityConfiguration.md new file mode 100644 index 0000000000..f7cd0b059a --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerActiveConnectivityConfiguration.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanageractiveconnectivityconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerActiveConnectivityConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerActiveConnectivityConfiguration.md +--- + +# Get-AzNetworkManagerActiveConnectivityConfiguration + +## SYNOPSIS +Lists NetworkManager Active Connectivity Configurations in network manager. + +## SYNTAX + +``` +Get-AzNetworkManagerActiveConnectivityConfiguration -NetworkManagerName <String> -ResourceGroupName <String> + [-Region <String[]>] [-SkipToken <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerActiveConnectivityConfiguration** cmdlet lists NetworkManager Active Connectivity Configurations in network manager . + +## EXAMPLES + +### Example 1 +```powershell +$regions = @("centraluseuap") +Get-AzNetworkManagerActiveConnectivityConfiguration -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG" -Region $regions -SkipToken "FakeSkipToken" +``` + +```output +Value : [ + { + "Region": "centraluseuap", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/connectivityConfigurations/TestConn", + "DisplayName": "Sample Config Name", + "Description": "", + "ConnectivityTopology": "HubAndSpoke", + "Hubs": [ + { + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/provide + rs/Microsoft.Network/virtualNetworks/hub", + "ResourceType": "Microsoft.Network/virtualNetworks" + } + ], + "IsGlobal": "False", + "AppliesToGroups": [ + { + "NetworkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/pro + viders/Microsoft.Network/networkManagers/TestNMName/networkGroups/testNG", + "UseHubGateway": "False", + "IsGlobal": "True", + "GroupConnectivity": "None" + } + ], + "ProvisioningState": "Succeeded", + "DeleteExistingPeering": "True", + "ConfigurationGroups": [ + { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/testNG", + "DisplayName": "DISplayName", + "Description": "SampleDESCRIption", + "GroupMembers": [ + { + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet" + } + ], + "ConditionalMembership": "", + "ProvisioningState": "Succeeded" + } + ] + } + ] +SkipToken : +``` + +Lists NetworkManager Active Connectivity Configurations in network manager for region centraluseuap. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Region +List of regions. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SkipToken +SkipToken. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerActiveConnectivityConfigurationListResult + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerActiveSecurityAdminRule](./Get-AzNetworkManagerActiveSecurityAdminRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerActiveSecurityAdminRule.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerActiveSecurityAdminRule.md new file mode 100644 index 0000000000..7298f22d6f --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerActiveSecurityAdminRule.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanageractivesecurityadminrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerActiveSecurityAdminRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerActiveSecurityAdminRule.md +--- + +# Get-AzNetworkManagerActiveSecurityAdminRule + +## SYNOPSIS +Lists NetworkManager Active Security Admin Rules in network manager. + +## SYNTAX + +``` +Get-AzNetworkManagerActiveSecurityAdminRule -NetworkManagerName <String> -ResourceGroupName <String> + [-Region <String[]>] [-SkipToken <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerActiveSecurityAdminRule** cmdlet lists NetworkManager Active Security Admin Rules in network manager. + +## EXAMPLES + +### Example 1 +```powershell +$regions = @("centraluseuap") +Get-AzNetworkManagerActiveSecurityAdminRule -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG" -Region $regions -SkipToken "FakeSkipToken" +``` + +```output +Value : [ + { + "DisplayName": "Sample Rule Name", + "Description": "Description", + "Protocol": "Tcp", + "Sources": [ + { + "AddressPrefix": "Internet", + "AddressPrefixType": "ServiceTag" + } + ], + "Destinations": [ + { + "AddressPrefix": "10.0.0.1", + "AddressPrefixType": "IPPrefix" + } + ], + "SourcePortRanges": [ + "100" + ], + "DestinationPortRanges": [ + "99" + ], + "Access": "Allow", + "Priority": 100, + "Direction": "Inbound", + "ProvisioningState": "Succeeded", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/securityAdminConfigurations/TestAdminConfig/ruleCollections/TestRuleCollection/rules/TestRule", + "Region": "eastus2euap", + "ConfigurationDisplayName": "sample Config DisplayName", + "ConfigurationDescription": "DESCription", + "RuleCollectionDisplayName": "Sample rule Collection displayName", + "RuleCollectionDescription": "Sample rule Collection Description", + "RuleCollectionAppliesToGroups": [ + { + "NetworkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/testNG" + } + ], + "RuleGroups": [ + { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/testNG", + "DisplayName": "DISplayName", + "Description": "SampleConfigDESCRIption", + "GroupMembers": [ + { + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet" + } + ], + "ConditionalMembership": "", + "ProvisioningState": "Succeeded" + } + ] + } + ] +SkipToken : +``` + +Lists NetworkManager Active Security Admin Rules in network manager for region centraluseuap. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Region +List of regions. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SkipToken +SkipToken. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerActiveSecurityAdminRuleListResult + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerActiveConnectivityConfiguration](./Get-AzNetworkManagerActiveConnectivityConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerConnectivityConfiguration.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerConnectivityConfiguration.md new file mode 100644 index 0000000000..48c43887d1 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerConnectivityConfiguration.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanagerconnectivityconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerConnectivityConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerConnectivityConfiguration.md +--- + +# Get-AzNetworkManagerConnectivityConfiguration + +## SYNOPSIS +Gets a connectivity configuration in a network manager. + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzNetworkManagerConnectivityConfiguration [-Name <String>] -NetworkManagerName <String> + -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Expand +``` +Get-AzNetworkManagerConnectivityConfiguration -Name <String> -NetworkManagerName <String> + -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerConnectivityConfiguration** cmdlet gets one or more connectivity configurations in a network manager. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkManagerConnectivityConfiguration -ResourceGroupName "psResourceGroup" -NetworkManagerName "psNetworkManager" -Name "psConnectivityConfig" +``` + +```output +ConnectivityTopology : HubAndSpoke +Hubs : {/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884/resourceGroups/jaredgorthy-PowerShellTestResources/providers/Microsoft.Network/virtualNetworks/powerShellTestVnetHub} +DeleteExistingPeering : True +IsGlobal : False +AppliesToGroups : {/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup, + /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup2} +AppliesToGroupsText : [ + { + "NetworkGroupId": + "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup", + "UseHubGateway": "False", + "IsGlobal": "False", + "GroupConnectivity": "None" + }, + { + "NetworkGroupId": + "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup2", + "UseHubGateway": "False", + "IsGlobal": "False", + "GroupConnectivity": "None" + } + ] +HubsText : [ + { + "ResourceId": "/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884/resourceGroups/jaredgorthy-PowerShellTestResources/providers/Microsoft.Network/virtualNetworks/powerShellTestVnetHub", + "ResourceType": "Microsoft.Network/virtualNetworks" + } + ] +DisplayName : +Description : +Type : Microsoft.Network/networkManagers/connectivityConfigurations +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T04:37:43.1186543Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-08T00:58:41.1751638Z" + } +Name : psConnectivityConfig +Etag : "02002303-0000-0700-0000-62f05fc10000" +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/connectivityConfigurations/psConnectivityConfig +``` + +Gets a connectivity configuration in a network manager. + +### Example 2 +```powershell +Get-AzNetworkManagerConnectivityConfiguration -ResourceGroupName "psResourceGroup" -NetworkManagerName "psNetworkManager" +``` + +```output +ConnectivityTopology : HubAndSpoke +Hubs : {/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884/resourceGroups/jaredgorthy-PowerShellTestResources/providers/Microsoft.Network/virtualNetworks/powerShellTestVnetHub} +DeleteExistingPeering : True +IsGlobal : False +AppliesToGroups : {/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup, + /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup2} +AppliesToGroupsText : [ + { + "NetworkGroupId": + "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup", + "UseHubGateway": "False", + "IsGlobal": "False", + "GroupConnectivity": "None" + }, + { + "NetworkGroupId": + "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup2", + "UseHubGateway": "False", + "IsGlobal": "False", + "GroupConnectivity": "None" + } + ] +HubsText : [ + { + "ResourceId": "/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884/resourceGroups/jaredgorthy-PowerShellTestResources/providers/Microsoft.Network/virtualNetworks/powerShellTestVnetHub", + "ResourceType": "Microsoft.Network/virtualNetworks" + } + ] +DisplayName : +Description : +Type : Microsoft.Network/networkManagers/connectivityConfigurations +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T04:37:43.1186543Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-08T00:58:41.1751638Z" + } +Name : psConnectivityConfig +Etag : "02002303-0000-0700-0000-62f05fc10000" +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/connectivityConfigurations/psConnectivityConfig + +ConnectivityTopology : Mesh +Hubs : {} +DeleteExistingPeering : True +IsGlobal : False +AppliesToGroups : {/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup} +AppliesToGroupsText : [ + { + "NetworkGroupId": + "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup", + "UseHubGateway": "False", + "IsGlobal": "False", + "GroupConnectivity": "None" + } + ] +HubsText : [] +DisplayName : +Description : +Type : Microsoft.Network/networkManagers/connectivityConfigurations +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T04:43:00.9075845Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-07T04:43:00.9075845Z" + } +Name : psConnectivityConfigMesh +Etag : "010010af-0000-0700-0000-62ef42d50000" +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/connectivityConfigurations/psConnectivityConfigMesh +``` + +Gets all connectivity configurations in a network manager. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnectivityConfiguration + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerConnectivityConfiguration](./New-AzNetworkManagerConnectivityConfiguration.md) + +[Remove-AzNetworkManagerConnectivityConfiguration](./Remove-AzNetworkManagerConnectivityConfiguration.md) + +[Set-AzNetworkManagerConnectivityConfiguration](./Set-AzNetworkManagerConnectivityConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerDeploymentStatus.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerDeploymentStatus.md new file mode 100644 index 0000000000..e500877e0e --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerDeploymentStatus.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanagerdeploymentstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerDeploymentStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerDeploymentStatus.md +--- + +# Get-AzNetworkManagerDeploymentStatus + +## SYNOPSIS +Lists Deployment Status in a network manager. + +## SYNTAX + +``` +Get-AzNetworkManagerDeploymentStatus -NetworkManagerName <String> -ResourceGroupName <String> + [-Region <String[]>] [-DeploymentType <String[]>] [-SkipToken <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerDeploymentStatus** cmdlet lists Deployment Status in a network manager. + +## EXAMPLES + +### Example 1 +```powershell +$regions = @("centraluseuap") +$DeploymentTypes = @("SecurityAdmin") +Get-AzNetworkManagerDeploymentStatus -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG" -region $regions -skipToken "FakeSkipToken" -DeploymentType $DeploymentTypes +``` + +```output +Value : [ + { + "CommitTime": "2021-10-18T04:06:08Z", + "Region": "centraluseuap", + "DeploymentStatus": "Deployed", + "ConfigurationIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/securityAdminConfigurations/testAdminConfig" + ], + "DeploymentType": "SecurityAdmin", + "ErrorMessage": "" + } + ] +SkipToken : +``` + +Lists Deployment Status of SecurityAdmin configurations in region centraluseuap for a network manager. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentType +List of deploymentTypes. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkManagerName +The networkManager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Region +List of regions. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SkipToken +SkipToken. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerDeploymentStatusListResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerEffectiveConnectivityConfiguration.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerEffectiveConnectivityConfiguration.md new file mode 100644 index 0000000000..9f644cbb07 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerEffectiveConnectivityConfiguration.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanagereffectiveconnectivityconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerEffectiveConnectivityConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerEffectiveConnectivityConfiguration.md +--- + +# Get-AzNetworkManagerEffectiveConnectivityConfiguration + +## SYNOPSIS +Lists NetworkManager Effective Connectivity Configurations applied on a virtual networks. + +## SYNTAX + +``` +Get-AzNetworkManagerEffectiveConnectivityConfiguration -VirtualNetworkName <String> + -VirtualNetworkResourceGroupName <String> [-SkipToken <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerEffectiveConnectivityConfiguration** cmdlet lists NetworkManager Effective Connectivity Configurations applied on a virtual network. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkManagerEffectiveConnectivityConfiguration -VirtualNetworkName "TestVnet" -VirtualNetworkResourceGroupName "TestRG" -SkipToken "FakeSkipToken" +``` + +```output +Value : [ + { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/connectivityConfigurations/TestConn", + "DisplayName": "Sample Config Name", + "Description": "", + "ConnectivityTopology": "HubAndSpoke", + "Hubs": [ + { + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/hub", + "ResourceType": "Microsoft.Network/virtualNetworks" + } + ], + "IsGlobal": "False", + "AppliesToGroups": [ + { + "NetworkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/testNG", + "UseHubGateway": "False", + "IsGlobal": "True", + "GroupConnectivity": "None" + } + ], + "ProvisioningState": "Succeeded", + "DeleteExistingPeering": "True", + "ConfigurationGroups": [ + { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/testNG", + "DisplayName": "DISplayName", + "Description": "SampleDESCRIption", + "GroupMembers": [ + { + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet" + } + ], + "ConditionalMembership": "", + "ProvisioningState": "Succeeded" + } + ] + } + ] +SkipToken : +``` + +Lists NetworkManager Effective Connectivity Configurations applied on a virtual network 'TestVnet'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +SkipToken. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkName +The vnet name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -VirtualNetworkResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerEffectiveConnectivityConfigurationListResult + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerEffectiveSecurityAdminRule](./Get-AzNetworkManagerEffectiveSecurityAdminRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerEffectiveSecurityAdminRule.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerEffectiveSecurityAdminRule.md new file mode 100644 index 0000000000..c2d3a9bd13 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerEffectiveSecurityAdminRule.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanagereffectivesecurityadminrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerEffectiveSecurityAdminRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerEffectiveSecurityAdminRule.md +--- + +# Get-AzNetworkManagerEffectiveSecurityAdminRule + +## SYNOPSIS +Lists NetworkManager Effective Security Admin Rules applied on a virtual networks. + +## SYNTAX + +``` +Get-AzNetworkManagerEffectiveSecurityAdminRule -VirtualNetworkName <String> + -VirtualNetworkResourceGroupName <String> [-SkipToken <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerEffectiveSecurityAdminRule** cmdlet lists NetworkManager Effective Security Admin Rules applied on a virtual network. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkManagerEffectiveSecurityAdminRule -VirtualNetworkName "TestVnet" -VirtualNetworkResourceGroupName "TestRG" -SkipToken "FakeSkipToken" +``` + +```output +Value : [ + { + "DisplayName": "Sample Rule Name", + "Description": "Description", + "Protocol": "Tcp", + "Sources": [ + { + "AddressPrefix": "Internet", + "AddressPrefixType": "ServiceTag" + } + ], + "Destinations": [ + { + "AddressPrefix": "10.0.0.1", + "AddressPrefixType": "IPPrefix" + } + ], + "SourcePortRanges": [ + "100" + ], + "DestinationPortRanges": [ + "99" + ], + "Access": "Allow", + "Priority": 100, + "Direction": "Inbound", + "ProvisioningState": "Succeeded", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/securityAdminConfigurations/TestAdminConfig/ruleCollections/TestRuleCollection/rules/TestRule", + "ConfigurationDisplayName": "sample Config DisplayName", + "ConfigurationDescription": "DESCription", + "RuleCollectionDisplayName": "Sample rule Collection displayName", + "RuleCollectionDescription": "Sample rule Collection Description", + "RuleCollectionAppliesToGroups": [ + { + "NetworkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/testNG" + } + ], + "RuleGroups": [ + { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/testNG", + "DisplayName": "DISplayName", + "Description": "SampleConfigDESCRIption", + "GroupMembers": [ + { + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/TestVnet" + } + ], + "ConditionalMembership": "", + "ProvisioningState": "Succeeded" + } + ] + } + ] +SkipToken : +``` + +Lists NetworkManager Effective Security Admin Rules applied on a virtual network 'TestVnet'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +SkipToken. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkName +The vnet name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -VirtualNetworkResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerEffectiveSecurityAdminRuleListResult + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerEffectiveConnectivityConfiguration](./Get-AzNetworkManagerEffectiveConnectivityConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerGroup.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerGroup.md new file mode 100644 index 0000000000..8d8e30be52 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerGroup.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanagergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerGroup.md +--- + +# Get-AzNetworkManagerGroup + +## SYNOPSIS +Gets network group(s) in a network manager. + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzNetworkManagerGroup [-Name <String>] -NetworkManagerName <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Expand +``` +Get-AzNetworkManagerGroup -Name <String> -NetworkManagerName <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerGroup** cmdlet gets a network group in a network manager. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkManagerGroup -Name "TestGroup" -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG" +``` + +```output +Name : TestGroup +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/TestGroup +Description : +Etag : "00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +ConditionalMembership : +MemberType : +SystemData : { + "CreatedBy": "00000000-0000-0000-0000-000000000000", + "CreatedByType": "Application", + "CreatedAt": "2021-10-17T21:13:02", + "LastModifiedBy": "00000000-0000-0000-0000-000000000000", + "LastModifiedByType": "Application", + "LastModifiedAt": "2021-10-17T21:13:02" + } +``` + +Gets a network group 'TestGroup' in a network manager. + +### Example 2 +```powershell +Get-AzNetworkManagerGroup -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG" +``` + +```output +Name : TestGroup +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/TestGroup +Description : +Etag : "00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +ConditionalMembership : +MemberType : +SystemData : { + "CreatedBy": "00000000-0000-0000-0000-000000000000", + "CreatedByType": "Application", + "CreatedAt": "2021-10-17T21:13:02", + "LastModifiedBy": "00000000-0000-0000-0000-000000000000", + "LastModifiedByType": "Application", + "LastModifiedAt": "2021-10-17T21:13:02" + } + + Name : TestGroup2 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/TestGroup2 +Description : +Etag : "00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +ConditionalMembership : +MemberType : +SystemData : { + "CreatedBy": "00000000-0000-0000-0000-000000000000", + "CreatedByType": "Application", + "CreatedAt": "2021-10-17T21:13:02", + "LastModifiedBy": "00000000-0000-0000-0000-000000000000", + "LastModifiedByType": "Application", + "LastModifiedAt": "2021-10-17T21:13:02" + } +``` + +Gets all network groups in a network manager. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerGroup + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerGroup](./New-AzNetworkManagerGroup.md) + +[Remove-AzNetworkManagerGroup](./Remove-AzNetworkManagerGroup.md) + +[Set-AzNetworkManagerGroup](./Set-AzNetworkManagerGroup.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerManagementGroupConnection.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerManagementGroupConnection.md new file mode 100644 index 0000000000..d2a474fd19 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerManagementGroupConnection.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanagermanagementgroupconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerManagementGroupConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerManagementGroupConnection.md +--- + +# Get-AzNetworkManagerManagementGroupConnection + +## SYNOPSIS +Gets a network manager management group connection. + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzNetworkManagerManagementGroupConnection -ManagementGroupId <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Expand +``` +Get-AzNetworkManagerManagementGroupConnection -ManagementGroupId <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerManagementGroupConnection** cmdlet gets a network manager connection on a management group. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkManagerManagementGroupConnection -ManagementGroupId "newMG" -Name "psConnection" +``` + +```output +NetworkManagerId : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager +ConnectionState : Pending +DisplayName : +Description : sample description +Type : Microsoft.Network/networkManagerConnections +ProvisioningState : +SystemData : +SystemDataText : null +Name : psConnection +Etag : +Id : /providers/Microsoft.Management/managementGroups/newMG/providers/Microsoft.Network/networkManagerConnections/psConnection +``` + +Gets a network manager connection on management group 'newMG'. + +### Example 2 +```powershell +Get-AzNetworkManagerManagementGroupConnection -ManagementGroupId "newMG" +``` + +```output +NetworkManagerId : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/jaredgorthy-testResources/providers/Microsoft.Network/networkManagers/jaredgorthy +ConnectionState : Pending +DisplayName : +Description : +Type : Microsoft.Network/networkManagerConnections +ProvisioningState : +SystemData : +SystemDataText : null +Name : mgConnection +Etag : +Id : /providers/Microsoft.Management/managementGroups/newMG/providers/Microsoft.Network/networkManagerConnections/mgConnection + +NetworkManagerId : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager +ConnectionState : Pending +DisplayName : +Description : sample description +Type : Microsoft.Network/networkManagerConnections +ProvisioningState : +SystemData : +SystemDataText : null +Name : psConnection +Etag : +Id : /providers/Microsoft.Management/managementGroups/newMG/providers/Microsoft.Network/networkManagerConnections/psConnection +``` + +Gets all network manager connections on management group 'newMG'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnection + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerManagementGroupConnection](./New-AzNetworkManagerManagementGroupConnection.md) + +[Set-AzNetworkManagerManagementGroupConnection](./Set-AzNetworkManagerManagementGroupConnection.md) + +[Remove-AzNetworkManagerManagementGroupConnection](./Remove-AzNetworkManagerManagementGroupConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerScopeConnection.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerScopeConnection.md new file mode 100644 index 0000000000..34e4644b83 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerScopeConnection.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanagerscopeconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerScopeConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerScopeConnection.md +--- + +# Get-AzNetworkManagerScopeConnection + +## SYNOPSIS +Gets a scope connection in a network manager. + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzNetworkManagerScopeConnection [-Name <String>] -NetworkManagerName <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Expand +``` +Get-AzNetworkManagerScopeConnection -Name <String> -NetworkManagerName <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerScopeConnection** cmdlet gets one or more scope connections in a network manager. + +## EXAMPLES + +### Example 1: Retrieve a scope connection +```powershell +Get-AzNetworkManagerScopeConnection -ResourceGroupName "TestResourceGroup" -NetworkManagerName "TestNM" -Name "testsc" +``` + +```output +TenantId : 00000000-0000-0000-0000-000000000000 +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000000 +ConnectionState : Pending +Description : SampleDescription +DisplayName : +Type : Microsoft.Network/networkManagers/scopeConnections +ProvisioningState : +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "user@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-03-16T03:01:26.397158Z", + "LastModifiedBy": "user@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-03-16T03:01:26.397158Z" + } +Name : testsc +Etag : +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/networkManagers/TestNM/scopeConnections/testsc +``` + +Get a specific scope connection on a network manager. + +### Example 2: List scope connections +```powershell +Get-AzNetworkManagerScopeConnection -ResourceGroupName "psResourceGroup" -NetworkManagerName "psNetworkManager" +``` + +```output +TenantId : 72f988bf-86f1-41af-91ab-2d7cd011db47 +ResourceId : /subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884 +ConnectionState : Pending +DisplayName : +Description : SampleDescription +Type : Microsoft.Network/networkManagers/scopeConnections +ProvisioningState : +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T23:53:52.6942092Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-07T23:53:52.6942092Z" + } +Name : subConnection +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/scopeConnections/subConnection + +TenantId : 72f988bf-86f1-41af-91ab-2d7cd011db47 +ResourceId : /providers/Microsoft.Management/managementGroups/newMG +ConnectionState : Pending +DisplayName : +Description : SampleDescription +Type : Microsoft.Network/networkManagers/scopeConnections +ProvisioningState : +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T23:55:14.7516201Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-07T23:55:14.7516201Z" + } +Name : mgConnection +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/scopeConnections/mgConnection +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopeConnection + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerScopeConnection](./New-AzNetworkManagerScopeConnection.md) + +[Remove-AzNetworkManagerScopeConnection](./Remove-AzNetworkManagerScopeConnection.md) + +[Set-AzNetworkManagerScopeConnection](./Set-AzNetworkManagerScopeConnection.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerSecurityAdminConfiguration.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerSecurityAdminConfiguration.md new file mode 100644 index 0000000000..2052fac17c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerSecurityAdminConfiguration.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanagersecurityadminconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerSecurityAdminConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerSecurityAdminConfiguration.md +--- + +# Get-AzNetworkManagerSecurityAdminConfiguration + +## SYNOPSIS +Gets a network security admin configuration in a network manager. + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzNetworkManagerSecurityAdminConfiguration [-Name <String>] -NetworkManagerName <String> + -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Expand +``` +Get-AzNetworkManagerSecurityAdminConfiguration -Name <String> -NetworkManagerName <String> + -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerSecurityAdminConfiguration** cmdlet gets a security admin configuration in a network manager. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkManagerSecurityAdminConfiguration -Name "TestSecConfig" -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG" +``` + +```output +Name : TestSecConfig +Description : DESCription +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/securityAdminConfigurations/TestSecConfig +Type : Microsoft.Network/networkManagers/securityAdminConfigurations +Etag : "00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +DeleteExistingNSGs : +ApplyOnNetworkIntentPolicyBasedServices: +SecurityType : +SystemData : { + "CreatedBy": "00000000-0000-0000-0000-000000000000", + "CreatedByType": "Application", + "CreatedAt": "2021-10-18T04:05:57", + "LastModifiedBy": "00000000-0000-0000-0000-000000000000", + "LastModifiedByType": "Application", + "LastModifiedAt": "2021-10-18T04:05:59" + } +``` + +Get a security admin configuration. + +### Example 2 +```powershell +Get-AzNetworkManagerSecurityAdminConfiguration -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG" +``` + +```output +Name : TestSecConfig +Description : DESCription +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/securityAdminConfigurations/TestSecConfig +Type : Microsoft.Network/networkManagers/securityAdminConfigurations +Etag : "00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +DeleteExistingNSGs : +ApplyOnNetworkIntentPolicyBasedServices: +SecurityType : +SystemData : { + "CreatedBy": "00000000-0000-0000-0000-000000000000", + "CreatedByType": "Application", + "CreatedAt": "2021-10-18T04:05:57", + "LastModifiedBy": "00000000-0000-0000-0000-000000000000", + "LastModifiedByType": "Application", + "LastModifiedAt": "2021-10-18T04:05:59" + } + + Name : TestSecConfig2 +Description : DESCription +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/securityAdminConfigurations/TestSecConfig2 +Type : Microsoft.Network/networkManagers/securityAdminConfigurations +Etag : "00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +DeleteExistingNSGs : +ApplyOnNetworkIntentPolicyBasedServices: +SecurityType : +SystemData : { + "CreatedBy": "00000000-0000-0000-0000-000000000000", + "CreatedByType": "Application", + "CreatedAt": "2021-10-18T04:05:57", + "LastModifiedBy": "00000000-0000-0000-0000-000000000000", + "LastModifiedByType": "Application", + "LastModifiedAt": "2021-10-18T04:05:59" + } +``` + +Gets all security admin configurations on a network manager. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityAdminConfiguration + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerSecurityAdminConfiguration](./New-AzNetworkManagerSecurityAdminConfiguration.md) + +[Remove-AzNetworkManagerSecurityAdminConfiguration](./Remove-AzNetworkManagerSecurityAdminConfiguration.md) + +[Set-AzNetworkManagerSecurityAdminConfiguration](./Set-AzNetworkManagerSecurityAdminConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerSecurityAdminRule.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerSecurityAdminRule.md new file mode 100644 index 0000000000..683f421508 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerSecurityAdminRule.md @@ -0,0 +1,288 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanagersecurityadminrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerSecurityAdminRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerSecurityAdminRule.md +--- + +# Get-AzNetworkManagerSecurityAdminRule + +## SYNOPSIS +Gets a security admin rule in a network manager. + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzNetworkManagerSecurityAdminRule [-Name <String>] -RuleCollectionName <String> + -SecurityAdminConfigurationName <String> -NetworkManagerName <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Expand +``` +Get-AzNetworkManagerSecurityAdminRule -Name <String> -RuleCollectionName <String> + -SecurityAdminConfigurationName <String> -NetworkManagerName <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerSecurityAdminRule** cmdlets gets security admin rule in a network manager. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkManagerSecurityAdminRule -Name "testRule" -RuleCollectionName "TestRC" -SecurityAdminConfigurationName "TestSecConfig" -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG" +``` + +```output +Name : testRule +Description : Description +Type : Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/securityAdminConfigurations/TestSecConfig/ruleCollections/TestRC/rules/testRule +Etag : "00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +Protocol : Tcp +Direction : Inbound +Sources : [ + { + "AddressPrefix": "Internet", + "AddressPrefixType": "ServiceTag" + } + ] +Destinations : [ + { + "AddressPrefix": "10.0.0.1", + "AddressPrefixType": "IPPrefix" + } + ] +SourcePortRanges : [ + "100" + ] +DestinationPortRanges : [ + "99" + ] +Access : Allow +Priority : 100 +SystemData : { + "CreatedBy": "00000000-0000-0000-0000-000000000000", + "CreatedByType": "Application", + "CreatedAt": "2021-10-18T04:06:05", + "LastModifiedBy": "00000000-0000-0000-0000-000000000000", + "LastModifiedByType": "Application", + "LastModifiedAt": "2021-10-18T04:06:06" + } +``` + +Gets a security admin rule in a rule rollection. + +### Example 2 +```powershell +Get-AzNetworkManagerSecurityAdminRule -RuleCollectionName "TestRC" -SecurityAdminConfigurationName "TestSecConfig" -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG" +``` + +```output +Name : testRule +Description : Description +Type : Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/securityAdminConfigurations/TestSecConfig/ruleCollections/TestRC/rules/testRule +Etag : "00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +Protocol : Tcp +Direction : Inbound +Sources : [ + { + "AddressPrefix": "Internet", + "AddressPrefixType": "ServiceTag" + } + ] +Destinations : [ + { + "AddressPrefix": "10.0.0.1", + "AddressPrefixType": "IPPrefix" + } + ] +SourcePortRanges : [ + "100" + ] +DestinationPortRanges : [ + "99" + ] +Access : Allow +Priority : 100 +SystemData : { + "CreatedBy": "00000000-0000-0000-0000-000000000000", + "CreatedByType": "Application", + "CreatedAt": "2021-10-18T04:06:05", + "LastModifiedBy": "00000000-0000-0000-0000-000000000000", + "LastModifiedByType": "Application", + "LastModifiedAt": "2021-10-18T04:06:06" + } + + Name : testRule2 +Description : Description +Type : Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/securityAdminConfigurations/TestSecConfig/ruleCollections/TestRC/rules/testRule2 +Etag : "00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +Protocol : Tcp +Direction : Inbound +Sources : [ + { + "AddressPrefix": "Internet", + "AddressPrefixType": "ServiceTag" + } + ] +Destinations : [ + { + "AddressPrefix": "10.0.0.1", + "AddressPrefixType": "IPPrefix" + } + ] +SourcePortRanges : [ + "100" + ] +DestinationPortRanges : [ + "99" + ] +Access : Allow +Priority : 100 +SystemData : { + "CreatedBy": "00000000-0000-0000-0000-000000000000", + "CreatedByType": "Application", + "CreatedAt": "2021-10-18T04:06:05", + "LastModifiedBy": "00000000-0000-0000-0000-000000000000", + "LastModifiedByType": "Application", + "LastModifiedAt": "2021-10-18T04:06:06" + } +``` + +Gets all rules within a security admin rule collection. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleCollectionName +The network manager security admin rule collection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SecurityAdminConfigurationName +The network manager security admin configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConfigName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityBaseAdminRule + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerSecurityAdminRule](./New-AzNetworkManagerSecurityAdminRule.md) + +[Remove-AzNetworkManagerSecurityAdminRule](./Remove-AzNetworkManagerSecurityAdminRule.md) + +[Set-AzNetworkManagerSecurityAdminRule](./Set-AzNetworkManagerSecurityAdminRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerSecurityAdminRuleCollection.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerSecurityAdminRuleCollection.md new file mode 100644 index 0000000000..7da7f9370d --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerSecurityAdminRuleCollection.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanagersecurityadminrulecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerSecurityAdminRuleCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerSecurityAdminRuleCollection.md +--- + +# Get-AzNetworkManagerSecurityAdminRuleCollection + +## SYNOPSIS +Gets a security admin rule collection in a network manager. + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzNetworkManagerSecurityAdminRuleCollection [-Name <String>] -SecurityAdminConfigurationName <String> + -NetworkManagerName <String> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### Expand +``` +Get-AzNetworkManagerSecurityAdminRuleCollection -Name <String> -SecurityAdminConfigurationName <String> + -NetworkManagerName <String> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerSecurityAdminRuleCollection** cmdlet gets a security admin rule collection in a network manager. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkManagerSecurityAdminRuleCollection -Name "TestRC" -SecurityAdminConfigurationName "TestSecConfig" -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG" +``` + +```output +Name : TestRC +Description : Sample rule Collection Description +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/securityAdminConfigurations/TestSecConfig/ruleCollections/TestRC +Type : Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections +Etag : "00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +AppliesToGroups : [ + { + "NetworkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/testng" + } + ] +SystemData : { + "CreatedBy": "00000000-0000-0000-0000-000000000000", + "CreatedByType": "Application", + "CreatedAt": "2021-10-18T04:06:01", + "LastModifiedBy": "00000000-0000-0000-0000-000000000000", + "LastModifiedByType": "Application", + "LastModifiedAt": "2021-10-18T04:06:03" + } +``` + +Gets a rule collection with a security admin configuration. + +### Example 2 +```powershell +Get-AzNetworkManagerSecurityAdminRuleCollection -SecurityAdminConfigurationName "TestSecConfig" -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG" +``` + +```output +Name : TestRC +Description : Sample rule Collection Description +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/securityAdminConfigurations/TestSecConfig/ruleCollections/TestRC +Type : Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections +Etag : "00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +AppliesToGroups : [ + { + "NetworkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/testng" + } + ] +SystemData : { + "CreatedBy": "00000000-0000-0000-0000-000000000000", + "CreatedByType": "Application", + "CreatedAt": "2021-10-18T04:06:01", + "LastModifiedBy": "00000000-0000-0000-0000-000000000000", + "LastModifiedByType": "Application", + "LastModifiedAt": "2021-10-18T04:06:03" + } + + Name : TestRC2 +Description : Sample rule Collection Description +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/securityAdminConfigurations/TestSecConfig/ruleCollections/TestRC2 +Type : Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections +Etag : "00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +AppliesToGroups : [ + { + "NetworkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/testng" + } + ] +SystemData : { + "CreatedBy": "00000000-0000-0000-0000-000000000000", + "CreatedByType": "Application", + "CreatedAt": "2021-10-18T04:06:01", + "LastModifiedBy": "00000000-0000-0000-0000-000000000000", + "LastModifiedByType": "Application", + "LastModifiedAt": "2021-10-18T04:06:03" + } +``` + +Gets all rule collections within a security admin configuration. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SecurityAdminConfigurationName +The network manager security admin configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConfigName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityAdminRuleCollection + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerSecurityAdminRuleCollection](./New-AzNetworkManagerSecurityAdminRuleCollection.md) + +[Remove-AzNetworkManagerSecurityAdminRuleCollection](./Remove-AzNetworkManagerSecurityAdminRuleCollection.md) + +[Set-AzNetworkManagerSecurityAdminRuleCollection](./Set-AzNetworkManagerSecurityAdminRuleCollection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerStaticMember.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerStaticMember.md new file mode 100644 index 0000000000..da1ecaaa72 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerStaticMember.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanagerstaticmember +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerStaticMember.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerStaticMember.md +--- + +# Get-AzNetworkManagerStaticMember + +## SYNOPSIS +Gets network manager static members. + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzNetworkManagerStaticMember [-Name <String>] -NetworkGroupName <String> -NetworkManagerName <String> + -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Expand +``` +Get-AzNetworkManagerStaticMember -Name <String> -NetworkGroupName <String> -NetworkManagerName <String> + -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerStaticMember** cmdlet gets a network manager static member. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkManagerStaticMember -Name "TestStaticMember" -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG" -NetworkGroupName "TestNetworkGroup" +``` + +```output +Name : TestSM +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/TestNetworkGroup/staticMembers/TestStaticMember +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/vnet1 +Description : +Type : Microsoft.Network/networkManagers/networkGroups/staticMembers +Etag : +ProvisioningState : Succeeded +``` + +Gets a single static member. + +### Example 2 +```powershell +Get-AzNetworkManagerStaticMember -NetworkManagerName "psNetworkManager" -ResourceGroupName "psResourceGroup" -NetworkGroupName "psNetworkGroup" +``` + +```output +Name : TestSM +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/TestNetworkGroup/staticMembers/TestSM +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/vnet1 +Description : +Type : Microsoft.Network/networkManagers/networkGroups/staticMembers +Etag : +ProvisioningState : Succeeded + +Name : TestSM2 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/TestNetworkGroup/staticMembers/TestSM2 +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/vnet2 +Description : +Type : Microsoft.Network/networkManagers/networkGroups/staticMembers +Etag : +ProvisioningState : Succeeded +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkGroupName +The network manager group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerStaticMember + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerStaticMember](./New-AzNetworkManagerStaticMember.md) + +[Remove-AzNetworkManagerStaticMember](./Remove-AzNetworkManagerStaticMember.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkManagerSubscriptionConnection.md b/azps-10.1.0/Az.Network/Get-AzNetworkManagerSubscriptionConnection.md new file mode 100644 index 0000000000..3f2859766c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkManagerSubscriptionConnection.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkmanagersubscriptionconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerSubscriptionConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkManagerSubscriptionConnection.md +--- + +# Get-AzNetworkManagerSubscriptionConnection + +## SYNOPSIS +Gets a network manager subscription connection. + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzNetworkManagerSubscriptionConnection [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### Expand +``` +Get-AzNetworkManagerSubscriptionConnection -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkManagerSubscriptionConnection** cmdlet gets a network manager subscription connection. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkManagerSubscriptionConnection -Name "subConnection" +``` + +```output +NetworkManagerId : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager +ConnectionState : Conflict +DisplayName : +Description : new description +Type : Microsoft.Network/networkManagerConnections +ProvisioningState : +SystemData : +SystemDataText : null +Name : subConnection +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/providers/Microsoft.Network/networkManagerConnections/subConnection +``` + +Gets a network manager connection on a subscription. + +### Example 2 +```powershell +Get-AzNetworkManagerSubscriptionConnection +``` + +```output +NetworkManagerId : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager +ConnectionState : Conflict +DisplayName : +Description : new description +Type : Microsoft.Network/networkManagerConnections +ProvisioningState : +SystemData : +SystemDataText : null +Name : subConnection +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/providers/Microsoft.Network/networkManagerConnections/subConnection + +NetworkManagerId : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager2 +ConnectionState : Conflict +DisplayName : +Description : SampleDescription +Type : Microsoft.Network/networkManagerConnections +ProvisioningState : +SystemData : +SystemDataText : null +Name : subConnection2 +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/providers/Microsoft.Network/networkManagerConnections/subConnection2 +``` + +Gets all network manager connections on a subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnection + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerSubscriptionConnection](./New-AzNetworkManagerSubscriptionConnection.md) + +[Set-AzNetworkManagerSubscriptionConnection](./Set-AzNetworkManagerSubscriptionConnection.md) + +[Remove-AzNetworkManagerSubscriptionConnection](./Remove-AzNetworkManagerSubscriptionConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkProfile.md b/azps-10.1.0/Az.Network/Get-AzNetworkProfile.md new file mode 100644 index 0000000000..c3f69dab3a --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkProfile.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkProfile.md +--- + +# Get-AzNetworkProfile + +## SYNOPSIS +Gets an existing network profile top level resource + +## SYNTAX + +### GetByResourceNameNoExpandParameterSet (Default) +``` +Get-AzNetworkProfile [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceNameExpandParameterSet +``` +Get-AzNetworkProfile -ResourceGroupName <String> -Name <String> -ExpandResource <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdExpandParameterSet +``` +Get-AzNetworkProfile -ResourceId <String> -ExpandResource <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceIdNoExpandParameterSet +``` +Get-AzNetworkProfile -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkProfile** cmdlet retrieves an existing network profile top level resource + +## EXAMPLES + +### Example 1 +```powershell +$networkProfile = Get-AzNetworkProfile -Name np1 -ResourceGroupName rg1 +``` + +```output +ProvisioningState : Succeeded +ContainerNetworkInterfaces : {} +ContainerNetworkInterfaceConfigurations : {} +ContainerNetworkInterfacesText : [] +ContainerNetworkInterfaceConfigurationsText : [] +ResourceGroupName : rg1 +Location : westus +ResourceGuid : 00000000-0000-0000-0000-000000000000 +Type : Microsoft.Network/networkProfiles +Tag : +TagsTable : +Name : np1 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1 + /providers/Microsoft.Network/networkProfiles/np1 +``` + +This retrieves the network profile np1 in resource group rg1 + +### Example 2 +```powershell +$networkProfile = Get-AzNetworkProfile -Name np* +``` + +```output +ProvisioningState : Succeeded +ContainerNetworkInterfaces : {} +ContainerNetworkInterfaceConfigurations : {} +ContainerNetworkInterfacesText : [] +ContainerNetworkInterfaceConfigurationsText : [] +ResourceGroupName : rg1 +Location : westus +ResourceGuid : 00000000-0000-0000-0000-000000000000 +Type : Microsoft.Network/networkProfiles +Tag : +TagsTable : +Name : np1 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1 + /providers/Microsoft.Network/networkProfiles/np1 + +ProvisioningState : Succeeded +ContainerNetworkInterfaces : {} +ContainerNetworkInterfaceConfigurations : {} +ContainerNetworkInterfacesText : [] +ContainerNetworkInterfaceConfigurationsText : [] +ResourceGroupName : rg1 +Location : westus +ResourceGuid : 00000000-0000-0000-0000-000000000000 +Type : Microsoft.Network/networkProfiles +Tag : +TagsTable : +Name : np2 +Etag : W/"00000000-0000-0000-0000-000000000000" +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1 + /providers/Microsoft.Network/networkProfiles/np2 +``` + +This retrieves the network profiles that start with "np" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandResource +The resource reference to be expanded. + +```yaml +Type: System.String +Parameter Sets: GetByResourceNameExpandParameterSet, GetByResourceIdExpandParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the network profile. + +```yaml +Type: System.String +Parameter Sets: GetByResourceNameNoExpandParameterSet +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: GetByResourceNameExpandParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name of the network profile. + +```yaml +Type: System.String +Parameter Sets: GetByResourceNameNoExpandParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: GetByResourceNameExpandParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +The Azure resource manager id of the network profile. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdExpandParameterSet, GetByResourceIdNoExpandParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkProfile + +## NOTES + +## RELATED LINKS + +[New-AzNetworkProfile](./New-AzNetworkProfile.md) + +[Remove-AzNetworkProfile](./Remove-AzNetworkProfile.md) + +[Set-AzNetworkProfile](./Set-AzNetworkProfile.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkSecurityGroup.md b/azps-10.1.0/Az.Network/Get-AzNetworkSecurityGroup.md new file mode 100644 index 0000000000..8919ac04fe --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkSecurityGroup.md @@ -0,0 +1,602 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 5AECCBD7-1FDE-4217-9F59-36328062E669 +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworksecuritygroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkSecurityGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkSecurityGroup.md +--- + +# Get-AzNetworkSecurityGroup + +## SYNOPSIS +Gets a network security group. + +## SYNTAX + +### NoExpand +``` +Get-AzNetworkSecurityGroup [-Name <String>] [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Expand +``` +Get-AzNetworkSecurityGroup -Name <String> -ResourceGroupName <String> -ExpandResource <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkSecurityGroup** cmdlet gets an Azure network security group. + +## EXAMPLES + +### Example 1: Retrieve an existing network security group +```powershell +Get-AzNetworkSecurityGroup -Name nsg1 -ResourceGroupName "rg1" +``` + +```output +Name : nsg1 +ResourceGroupName : rg1 +Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provider + s/Microsoft.Network/networkSecurityGroups/nsg1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +FlushConnection : False +SecurityRules : [] +DefaultSecurityRules : [ + { + "Name": "AllowVnetInBound", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide + rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "Description": "Allow inbound traffic from all VMs in VNET", + "Protocol": "*", + "SourcePortRange": [ + "*" + ], + "DestinationPortRange": [ + "*" + ], + "SourceAddressPrefix": [ + "VirtualNetwork" + ], + "DestinationAddressPrefix": [ + "VirtualNetwork" + ], + "Access": "Allow", + "Priority": 65000, + "Direction": "Inbound", + "ProvisioningState": "Succeeded", + "SourceApplicationSecurityGroups": [], + "DestinationApplicationSecurityGroups": [] + }, + { + "Name": "AllowAzureLoadBalancerInBound", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide + rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBou + nd", + "Description": "Allow inbound traffic from azure load balancer", + "Protocol": "*", + "SourcePortRange": [ + "*" + ], + "DestinationPortRange": [ + "*" + ], + "SourceAddressPrefix": [ + "AzureLoadBalancer" + ], + "DestinationAddressPrefix": [ + "*" + ], + "Access": "Allow", + "Priority": 65001, + "Direction": "Inbound", + "ProvisioningState": "Succeeded", + "SourceApplicationSecurityGroups": [], + "DestinationApplicationSecurityGroups": [] + }, + { + "Name": "DenyAllInBound", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide + rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "Description": "Deny all inbound traffic", + "Protocol": "*", + "SourcePortRange": [ + "*" + ], + "DestinationPortRange": [ + "*" + ], + "SourceAddressPrefix": [ + "*" + ], + "DestinationAddressPrefix": [ + "*" + ], + "Access": "Deny", + "Priority": 65500, + "Direction": "Inbound", + "ProvisioningState": "Succeeded", + "SourceApplicationSecurityGroups": [], + "DestinationApplicationSecurityGroups": [] + }, + { + "Name": "AllowVnetOutBound", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide + rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "Description": "Allow outbound traffic from all VMs to all VMs in VNET", + "Protocol": "*", + "SourcePortRange": [ + "*" + ], + "DestinationPortRange": [ + "*" + ], + "SourceAddressPrefix": [ + "VirtualNetwork" + ], + "DestinationAddressPrefix": [ + "VirtualNetwork" + ], + "Access": "Allow", + "Priority": 65000, + "Direction": "Outbound", + "ProvisioningState": "Succeeded", + "SourceApplicationSecurityGroups": [], + "DestinationApplicationSecurityGroups": [] + }, + { + "Name": "AllowInternetOutBound", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide + rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "Description": "Allow outbound traffic from all VMs to Internet", + "Protocol": "*", + "SourcePortRange": [ + "*" + ], + "DestinationPortRange": [ + "*" + ], + "SourceAddressPrefix": [ + "*" + ], + "DestinationAddressPrefix": [ + "Internet" + ], + "Access": "Allow", + "Priority": 65001, + "Direction": "Outbound", + "ProvisioningState": "Succeeded", + "SourceApplicationSecurityGroups": [], + "DestinationApplicationSecurityGroups": [] + }, + { + "Name": "DenyAllOutBound", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide + rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "Description": "Deny all outbound traffic", + "Protocol": "*", + "SourcePortRange": [ + "*" + ], + "DestinationPortRange": [ + "*" + ], + "SourceAddressPrefix": [ + "*" + ], + "DestinationAddressPrefix": [ + "*" + ], + "Access": "Deny", + "Priority": 65500, + "Direction": "Outbound", + "ProvisioningState": "Succeeded", + "SourceApplicationSecurityGroups": [], + "DestinationApplicationSecurityGroups": [] + } + ] +NetworkInterfaces : [] +Subnets : [] +``` + +This command returns contents of Azure network security group "nsg1" in resource group "rg1" + +### Example 2: List existing network security groups using filtering +```powershell +Get-AzNetworkSecurityGroup -Name nsg* +``` + +```output +Name : nsg1 +ResourceGroupName : rg1 +Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provider + s/Microsoft.Network/networkSecurityGroups/nsg1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +FlushConnection : False +SecurityRules : [] +DefaultSecurityRules : [ + { + "Name": "AllowVnetInBound", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide + rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "Description": "Allow inbound traffic from all VMs in VNET", + "Protocol": "*", + "SourcePortRange": [ + "*" + ], + "DestinationPortRange": [ + "*" + ], + "SourceAddressPrefix": [ + "VirtualNetwork" + ], + "DestinationAddressPrefix": [ + "VirtualNetwork" + ], + "Access": "Allow", + "Priority": 65000, + "Direction": "Inbound", + "ProvisioningState": "Succeeded", + "SourceApplicationSecurityGroups": [], + "DestinationApplicationSecurityGroups": [] + }, + { + "Name": "AllowAzureLoadBalancerInBound", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide + rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBou + nd", + "Description": "Allow inbound traffic from azure load balancer", + "Protocol": "*", + "SourcePortRange": [ + "*" + ], + "DestinationPortRange": [ + "*" + ], + "SourceAddressPrefix": [ + "AzureLoadBalancer" + ], + "DestinationAddressPrefix": [ + "*" + ], + "Access": "Allow", + "Priority": 65001, + "Direction": "Inbound", + "ProvisioningState": "Succeeded", + "SourceApplicationSecurityGroups": [], + "DestinationApplicationSecurityGroups": [] + }, + { + "Name": "DenyAllInBound", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide + rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "Description": "Deny all inbound traffic", + "Protocol": "*", + "SourcePortRange": [ + "*" + ], + "DestinationPortRange": [ + "*" + ], + "SourceAddressPrefix": [ + "*" + ], + "DestinationAddressPrefix": [ + "*" + ], + "Access": "Deny", + "Priority": 65500, + "Direction": "Inbound", + "ProvisioningState": "Succeeded", + "SourceApplicationSecurityGroups": [], + "DestinationApplicationSecurityGroups": [] + }, + { + "Name": "AllowVnetOutBound", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide + rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "Description": "Allow outbound traffic from all VMs to all VMs in VNET", + "Protocol": "*", + "SourcePortRange": [ + "*" + ], + "DestinationPortRange": [ + "*" + ], + "SourceAddressPrefix": [ + "VirtualNetwork" + ], + "DestinationAddressPrefix": [ + "VirtualNetwork" + ], + "Access": "Allow", + "Priority": 65000, + "Direction": "Outbound", + "ProvisioningState": "Succeeded", + "SourceApplicationSecurityGroups": [], + "DestinationApplicationSecurityGroups": [] + }, + { + "Name": "AllowInternetOutBound", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide + rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "Description": "Allow outbound traffic from all VMs to Internet", + "Protocol": "*", + "SourcePortRange": [ + "*" + ], + "DestinationPortRange": [ + "*" + ], + "SourceAddressPrefix": [ + "*" + ], + "DestinationAddressPrefix": [ + "Internet" + ], + "Access": "Allow", + "Priority": 65001, + "Direction": "Outbound", + "ProvisioningState": "Succeeded", + "SourceApplicationSecurityGroups": [], + "DestinationApplicationSecurityGroups": [] + }, + { + "Name": "DenyAllOutBound", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/provide + rs/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "Description": "Deny all outbound traffic", + "Protocol": "*", + "SourcePortRange": [ + "*" + ], + "DestinationPortRange": [ + "*" + ], + "SourceAddressPrefix": [ + "*" + ], + "DestinationAddressPrefix": [ + "*" + ], + "Access": "Deny", + "Priority": 65500, + "Direction": "Outbound", + "ProvisioningState": "Succeeded", + "SourceApplicationSecurityGroups": [], + "DestinationApplicationSecurityGroups": [] + } + ] +NetworkInterfaces : [] +Subnets : [] +``` + +This command returns contents of Azure network security groups that start with "nsg" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandResource +The resource reference to be expanded. + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network security group that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the resource group that the network security group belongs to. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +## NOTES + +## RELATED LINKS + +[New-AzNetworkSecurityGroup](./New-AzNetworkSecurityGroup.md) + +[Remove-AzNetworkSecurityGroup](./Remove-AzNetworkSecurityGroup.md) + +[Set-AzNetworkSecurityGroup](./Set-AzNetworkSecurityGroup.md) + + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandResource +The resource reference to be expanded. + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkSecurityRuleConfig.md b/azps-10.1.0/Az.Network/Get-AzNetworkSecurityRuleConfig.md new file mode 100644 index 0000000000..8c4f796f9a --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkSecurityRuleConfig.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 5A0D9326-3A8A-4156-8372-EBA93C1BB4E4 +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworksecurityruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkSecurityRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkSecurityRuleConfig.md +--- + +# Get-AzNetworkSecurityRuleConfig + +## SYNOPSIS +Get a network security rule configuration for a network security group. + +## SYNTAX + +``` +Get-AzNetworkSecurityRuleConfig [-Name <String>] -NetworkSecurityGroup <PSNetworkSecurityGroup> [-DefaultRules] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkSecurityRuleConfig** cmdlet gets a network security rule configuration for an Azure network security group. + +## EXAMPLES + +### 1: Retrieving a network security rule config +```powershell +Get-AzNetworkSecurityGroup -Name nsg1 -ResourceGroupName rg1 ` + | Get-AzNetworkSecurityRuleConfig -Name AllowInternetOutBound -DefaultRules +``` + +This command retrieves the default rule named "AllowInternetOutBound" from Azure network security group named "nsg1" in resource group "rg1" + +### 2: Retrieving a network security rule config using only the name +```powershell +Get-AzNetworkSecurityGroup -Name nsg1 -ResourceGroupName rg1 ` + | Get-AzNetworkSecurityRuleConfig -Name "rdp-rule" +``` + +This command retrieves user defined rule named "rdp-rule" from Azure network security group named "nsg1" in resource group "rg1" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultRules +Indicates whether this cmdlet gets a user-created rule configuration or a default rule configuration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network security rule configuration to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSecurityGroup +Specifies a **NetworkSecurityGroup** object that contains the network security rule configuration to get. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSSecurityRule + +## NOTES + +## RELATED LINKS + +[Add-AzNetworkSecurityRuleConfig](./Add-AzNetworkSecurityRuleConfig.md) + +[New-AzNetworkSecurityRuleConfig](./New-AzNetworkSecurityRuleConfig.md) + +[Remove-AzNetworkSecurityRuleConfig](./Remove-AzNetworkSecurityRuleConfig.md) + +[Set-AzNetworkSecurityRuleConfig](./Set-AzNetworkSecurityRuleConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkServiceTag.md b/azps-10.1.0/Az.Network/Get-AzNetworkServiceTag.md new file mode 100644 index 0000000000..5a1fcf1580 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkServiceTag.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkservicetag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkServiceTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkServiceTag.md +--- + +# Get-AzNetworkServiceTag + +## SYNOPSIS +Gets the list of service tag information resources. + +## SYNTAX + +``` +Get-AzNetworkServiceTag -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNetworkServiceTag** cmdlet gets the list of service tag information resources. + +Please note that the Azure region information you specify will be used as a reference for version (not as a filter based on location). +For example, even if you specify `-Location eastus2` you will get the list of service tags with prefix details across all regions but limited to the cloud that your subscription belongs to (i.e. Public, US government, China or Germany). + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$serviceTags = Get-AzNetworkServiceTag -Location eastus2 +$serviceTags + +Name : Public +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx/providers/Microsoft.Network/serviceTags/Public +Type : Microsoft.Network/serviceTags +ChangeNumber : 63 +Cloud : Public +Values : {ApiManagement, ApiManagement.AustraliaCentral, ApiManagement.AustraliaCentral2, ApiManagement.AustraliaEast...} + +$serviceTags.Values + +Name : ApiManagement +System Service : AzureApiManagement +Address Prefixes : {13.64.39.16/32, 13.66.138.92/31, 13.66.140.176/28, 13.67.8.108/31...} +Change Number : 7 + +Name : ApiManagement.AustraliaCentral +System Service : AzureApiManagement +Region : australiacentral +Address Prefixes : {20.36.106.68/31, 20.36.107.176/28} +Change Number : 2 + +Name : ApiManagement.AustraliaCentral2 +System Service : AzureApiManagement +Region : australiacentral2 +Address Prefixes : {20.36.114.20/31, 20.36.115.128/28} +Change Number : 2 + +Name : ApiManagement.AustraliaEast +System Service : AzureApiManagement +Region : australiaeast +Address Prefixes : {13.70.72.28/31, 13.70.72.240/28, 13.75.217.184/32, 13.75.221.78/32...} +Change Number : 3 + +Name : ApiManagement.AustraliaSoutheast +System Service : AzureApiManagement +Region : australiasoutheast +Address Prefixes : {13.77.50.68/31, 13.77.52.224/28} +Change Number : 2 + +... +``` + +The command gets the list of service tag information resources and stores it in variable `serviceTags`. + +### Example 2: Get all address prefixes for AzureSQL +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$serviceTags = Get-AzNetworkServiceTag -Location eastus2 +$sql = $serviceTags.Values | Where-Object { $_.Name -eq "Sql" } +$sql + +Name : Sql +System Service : AzureSQL +Address Prefixes : {13.65.31.249/32, 13.65.39.207/32, 13.65.85.183/32, 13.65.200.105/32...} +Change Number : 18 + +$sql.Properties.AddressPrefixes.Count +644 +$sql.Properties.AddressPrefixes +13.65.31.249/32 +13.65.39.207/32 +13.65.85.183/32 +13.65.200.105/32 +13.65.209.243/32 +... +``` + +The first command gets the list of service tag information resources and stores it in variable `serviceTags`. +The second command filters the list to select information resource for Sql. + +### Example 3: Get Storage's service tag information resource for West US 2 +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$serviceTags = Get-AzNetworkServiceTag -Location eastus2 +$serviceTags.Values | Where-Object { $_.Name -eq "Storage.WestUS2" } + +Name : Storage.WestUS2 +System Service : AzureStorage +Region : westus2 +Address Prefixes : {13.66.176.16/28, 13.66.176.48/28, 13.66.232.64/28, 13.66.232.208/28...} +Change Number : 5 + +$serviceTags.Values | Where-Object { $_.Name -like "Storage*" -and $_.Properties.Region -eq "westus2" } + +Name : Storage.WestUS2 +System Service : AzureStorage +Region : westus2 +Address Prefixes : {13.66.176.16/28, 13.66.176.48/28, 13.66.232.64/28, 13.66.232.208/28...} +Change Number : 5 + +$serviceTags.Values | Where-Object { $_.Properties.SystemService -eq "AzureStorage" -and $_.Properties.Region -eq "westus2" } + +Name : Storage.WestUS2 +System Service : AzureStorage +Region : westus2 +Address Prefixes : {13.66.176.16/28, 13.66.176.48/28, 13.66.232.64/28, 13.66.232.208/28...} +Change Number : 5 +``` + +The first command gets the list of service tag information resources and stores it in variable `serviceTags`. +The following commands show various way to filter the list to select service tag information for Storage in West US 2. + +### Example 4: Get all global service tag information resources +```powershell +$serviceTags = Get-AzNetworkServiceTag -Location eastus2 +$serviceTags.Values | Where-Object { -not $_.Properties.Region } +``` + +```output +Name : ApiManagement +System Service : AzureApiManagement +Address Prefixes : {13.64.39.16/32, 13.66.138.92/31, 13.66.140.176/28, 13.67.8.108/31...} +Change Number : 7 + +Name : AppService +System Service : AzureAppService +Address Prefixes : {13.64.73.110/32, 13.65.30.245/32, 13.65.37.122/32, 13.65.39.165/32...} +Change Number : 13 + +Name : AppServiceManagement +System Service : AzureAppServiceManagement +Address Prefixes : {13.64.115.203/32, 13.66.140.0/26, 13.67.8.128/26, 13.69.64.128/26...} +Change Number : 7 + +Name : AzureActiveDirectory +System Service : AzureAD +Address Prefixes : {13.64.151.161/32, 13.66.141.64/27, 13.67.9.224/27, 13.67.50.224/29...} +Change Number : 3 + +Name : AzureActiveDirectoryDomainServices +System Service : AzureIdentity +Address Prefixes : {13.64.151.161/32, 13.66.141.64/27, 13.67.9.224/27, 13.69.66.160/27...} +Change Number : 2 + +... +``` + +The first command gets the list of service tag information resources and stores it in variable `serviceTags`. +The second command filters the list to select only those without set region. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location that will be used as a reference for version (not as a filter based on location, you will get the list of service tags with prefix details across all regions but limited to the cloud that your subscription belongs to). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkServiceTag + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkUsage.md b/azps-10.1.0/Az.Network/Get-AzNetworkUsage.md new file mode 100644 index 0000000000..3da654268d --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkUsage.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkUsage.md +--- + +# Get-AzNetworkUsage + +## SYNOPSIS +Lists network usages for a subscription + +## SYNTAX + +``` +Get-AzNetworkUsage -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkUsage cmdlet gets limits and current usage for Network resources. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkUsage -Location westcentralus +``` + +```output +ResourceType : Virtual Networks +CurrentValue : 6 +Limit : 50 + +ResourceType : Static Public IP Addresses +CurrentValue : 1 +Limit : 20 + +ResourceType : Network Security Groups +CurrentValue : 2 +Limit : 100 + +ResourceType : Public IP Addresses +CurrentValue : 6 +Limit : 60 + +ResourceType : Network Interfaces +CurrentValue : 1 +Limit : 300 + +ResourceType : Load Balancers +CurrentValue : 1 +Limit : 100 + +ResourceType : Application Gateways +CurrentValue : 1 +Limit : 50 + +ResourceType : Route Tables +CurrentValue : 0 +Limit : 100 + +ResourceType : Route Filters +CurrentValue : 0 +Limit : 1000 + +ResourceType : Network Watchers +CurrentValue : 1 +Limit : 1 + +ResourceType : Packet Captures +CurrentValue : 0 +Limit : 10 +``` + +Gets resources usage data in westcentralus region + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location where resource usage is queried. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSUsage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkVirtualAppliance.md b/azps-10.1.0/Az.Network/Get-AzNetworkVirtualAppliance.md new file mode 100644 index 0000000000..908040521a --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkVirtualAppliance.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkvirtualappliance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkVirtualAppliance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkVirtualAppliance.md +--- + +# Get-AzNetworkVirtualAppliance + +## SYNOPSIS +Get or List Network Virtual Appliances. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Get-AzNetworkVirtualAppliance [-Name <String>] [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzNetworkVirtualAppliance -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkVirtualAppliance commands gets or lists Network Virtual Appliance resources. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkVirtualAppliance -ResourceGroupName testrg -Name nva +``` + +```output +BootStrapConfigurationBlobs : {} +VirtualHub : Microsoft.Azure.Commands.Network.Models.PSResourceId +CloudInitConfigurationBlobs : {} +CloudInitConfiguration : echo hi +VirtualApplianceAsn : 1270 +VirtualApplianceNics : {privatenicipconfig, publicnicipconfig, privatenicipconfig, publicnicipconfig} +VirtualApplianceSites : {} +ProvisioningState : Succeeded +Identity : +NvaSku : Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceSkuProperties +ResourceGroupName : testrg +Location : eastus2 +ResourceGuid : +Type : Microsoft.Network/NetworkVirtualAppliances +Tag : +TagsTable : +Name : nva +Etag : 00000000-0000-0000-0000-000000000000 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Network/networkVirtualAppliances/nva +``` + +Get a Network Virtual Appliance resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualAppliance + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkVirtualApplianceConnection.md b/azps-10.1.0/Az.Network/Get-AzNetworkVirtualApplianceConnection.md new file mode 100644 index 0000000000..4f3dbf9e78 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkVirtualApplianceConnection.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkvirtualapplianceconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkVirtualApplianceConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkVirtualApplianceConnection.md +--- + +# Get-AzNetworkVirtualApplianceConnection + +## SYNOPSIS +Get or List Network Virtual Appliances connections connected to a Network Virtual Appliance. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Get-AzNetworkVirtualApplianceConnection -ResourceGroupName <String> -VirtualApplianceName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceObjectParameterSet +``` +Get-AzNetworkVirtualApplianceConnection -VirtualAppliance <PSNetworkVirtualAppliance> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzNetworkVirtualApplianceConnection -VirtualApplianceResourceId <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkVirtualApplianceConnection commands gets or lists connections connected to a Network Virtual Appliance. + +## EXAMPLES + +### Example 1 + +```powershell +Get-AzNetworkVirtualApplianceConnection -ResourceGroupName testrg -VirtualApplianceName nva +``` + +```output +Name : defaultConnection +ProvisioningState : Succeeded +PropagateStaticRoutes : False +EnableInternetSecurity : False +BgpPeerAddress : [] +Asn : 65222 +TunnelIdentifier : 0 +RoutingConfiguration : { + "AssociatedRouteTable": { + "ResourceUri":"/subscriptions/{subid}/resourceGroups/{resource-group-name}/providers/Microsoft.Network/virtualHubs/{hub-name}//hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "ResourceUri": "/subscriptions/{subid}/resourceGroups/{resource-group-name}/providers/Microsoft.Network/virtualHubs/{hub-name}//hubRouteTables/defaultRouteTable" + } + ] + }, + "InboundRouteMap": { + "ResourceUri": "" + }, + "OutboundRouteMap": { + "ResourceUri": "" + } + } +``` + +The above will gets the connection from "testRG" resource group using Resource group and Parent NVA name + + +### Example 2 + +```powershell +$nva = Get-AzNetworkVirtualAppliance -ResourceGroupName testrg -Name nva +Get-AzNetworkVirtualApplianceConnection -VirtualAppliance $nva +``` + +```output +Name : defaultConnection +ProvisioningState : Succeeded +PropagateStaticRoutes : False +EnableInternetSecurity : False +BgpPeerAddress : [] +Asn : 65222 +TunnelIdentifier : 0 +RoutingConfiguration : { + "AssociatedRouteTable": { + "ResourceUri":"/subscriptions/{subid}/resourceGroups/{resource-group-name}/providers/Microsoft.Network/virtualHubs/{hub-name}//hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "ResourceUri": "/subscriptions/{subid}/resourceGroups/{resource-group-name}/providers/Microsoft.Network/virtualHubs/{hub-name}//hubRouteTables/defaultRouteTable" + } + ] + }, + "InboundRouteMap": { + "ResourceUri": "" + }, + "OutboundRouteMap": { + "ResourceUri": "" + } + } +``` + +This cmdlet gets the NVA connection using Network Virtual Appliance object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, NetworkVirtualApplianceConnectionName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -VirtualAppliance +The parent Network Virtual Appliance for this connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualAppliance +Parameter Sets: ResourceObjectParameterSet +Aliases: ParentNva, NetworkVirtualAppliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualApplianceResourceId +The resource id of the parent Network Virtual Appliance for this connection. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: ParentNvaId, NetworkVirtualApplianceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualApplianceName +The parent virtual appliance resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: ParentNvaName, NetworkVirtualApplianceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualAppliance + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualApplianceConnection + +## NOTES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkVirtualApplianceSku.md b/azps-10.1.0/Az.Network/Get-AzNetworkVirtualApplianceSku.md new file mode 100644 index 0000000000..8b747016b2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkVirtualApplianceSku.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkvirtualappliancesku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkVirtualApplianceSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkVirtualApplianceSku.md +--- + +# Get-AzNetworkVirtualApplianceSku + +## SYNOPSIS +Get or List available Network Virtual Appliance Skus in the inventory. + +## SYNTAX + +``` +Get-AzNetworkVirtualApplianceSku [-SkuName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkVirtualApplianceSku gets or lists available Network Virtual Appliance Skus in the Microsoft Azure inventory. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkVirtualApplianceSku -SkuName barracudasdwanrelease +``` + +```output +Vendor : barracudasdwanrelease +AvailableVersions : {8.1.0038301, latest} +AvailableScaleUnits : {Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualApplianceSkuInstances, Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualApplianceSkuInstances} +Name : barracudasdwanrelease +Etag : 00000000-0000-0000-0000-000000000000 +Id : +``` + +Get a sku by name. + +### Example 2 +```powershell +Get-AzNetworkVirtualApplianceSku +``` + +```output +Vendor : barracuda sdwan nightly +AvailableVersions : {latest} +AvailableScaleUnits : {Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualApplianceSkuInstances} +Name : barracuda sdwan nightly +Etag : 00000000-0000-0000-0000-000000000000 +Id : + +Vendor : barracuda sdwan +AvailableVersions : {latest} +AvailableScaleUnits : {Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualApplianceSkuInstances} +Name : barracuda sdwan +Etag : 00000000-0000-0000-0000-000000000000 +Id : + +Vendor : barracudasdwanrelease +AvailableVersions : {8.1.0038301, latest} +AvailableScaleUnits : {Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualApplianceSkuInstances, Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualApplianceSkuInstances} +Name : barracudasdwanrelease +Etag : 00000000-0000-0000-0000-000000000000 +Id : +``` + +List all available Skus of Network Virtual Appliance. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The Sku name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualApplianceSku + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkWatcher.md b/azps-10.1.0/Az.Network/Get-AzNetworkWatcher.md new file mode 100644 index 0000000000..cde4c82840 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkWatcher.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkwatcher +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcher.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcher.md +--- + +# Get-AzNetworkWatcher + +## SYNOPSIS +Gets the properties of a Network Watcher + +## SYNTAX + +### List +``` +Get-AzNetworkWatcher [-Name <String>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SetByLocation +``` +Get-AzNetworkWatcher -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkWatcher cmdlet gets one or more Azure Network Watcher resources. + +## EXAMPLES + +### Example 1: Get a Network Watcher +```powershell +Get-AzNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroupName NetworkWatcherRG +``` + +```output +Name : NetworkWatcher_westcentralus +Id : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_westcentralus +Etag : W/"ac624778-0214-49b9-a04c-794863485fa6" +Location : westcentralus +Tags : +ProvisioningState : Succeeded +``` + +Gets the Network Watcher named NetworkWatcher_westcentralus in the resource group NetworkWatcherRG. + +### Example 2: List Network Watchers using filtering +```powershell +Get-AzNetworkWatcher -Name NetworkWatcher* +``` + +```output +Name : NetworkWatcher_westcentralus1 +Id : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_westcentralus1 +Etag : W/"ac624778-0214-49b9-a04c-794863485fa6" +Location : westcentralus +Tags : +ProvisioningState : Succeeded + +Name : NetworkWatcher_westcentralus2 +Id : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_westcentralus2 +Etag : W/"ac624778-0214-49b9-a04c-794863485fa6" +Location : westcentralus +Tags : +ProvisioningState : Succeeded +``` + +Gets the Network Watchers that start with "NetworkWatcher" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The network watcher name. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkWatcherConnectionMonitor.md b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherConnectionMonitor.md new file mode 100644 index 0000000000..4ed133e0b7 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherConnectionMonitor.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkwatcherconnectionmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherConnectionMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherConnectionMonitor.md +--- + +# Get-AzNetworkWatcherConnectionMonitor + +## SYNOPSIS +Returns connection monitor with specified name or the list of connection monitors + +## SYNTAX + +### SetByName (Default) +``` +Get-AzNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +Get-AzNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Get-AzNetworkWatcherConnectionMonitor -Location <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +Get-AzNetworkWatcherConnectionMonitor -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkWatcherConnectionMonitor cmdlet returns the connection monitor with the specified name / resourceId or the list of connection monitors corresponding to the specified network watcher / location. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkWatcherConnectionMonitor -Location centraluseuap -Name cm +``` + +Name : cm +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGro + ups/NetworkWatcherRG/providers/Microsoft.Network/networkWatcher + s/NetworkWatcher_centraluseuap/connectionMonitors/cm +Etag : W/"40961b58-e379-4204-a47b-0c477739b095" +ProvisioningState : Succeeded +Source : { + "ResourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6 + a1f99/resourceGroups/VarunRgCentralUSEUAP/providers/Microsoft.C + ompute/virtualMachines/irinavm", + "Port": 0 + } +Destination : { + "Address": "google.com", + "Port": 80 + } +MonitoringIntervalInSeconds : 60 +AutoStart : True +StartTime : 1/12/2018 7:19:28 PM +MonitoringStatus : Stopped +Location : centraluseuap +Type : Microsoft.Network/networkWatchers/connectionMonitors +Tags : { + "key1": "value1" + } + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The connection monitor name. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: ConnectionMonitorName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResultV1 + +### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResultV2 + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkWatcherConnectionMonitorReport.md b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherConnectionMonitorReport.md new file mode 100644 index 0000000000..8e6ab64c6c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherConnectionMonitorReport.md @@ -0,0 +1,427 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkwatcherconnectionmonitorreport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherConnectionMonitorReport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherConnectionMonitorReport.md +--- + +# Get-AzNetworkWatcherConnectionMonitorReport + +## SYNOPSIS +Query a snapshot of the most recent connection states. + +## SYNTAX + +### SetByName (Default) +``` +Get-AzNetworkWatcherConnectionMonitorReport -NetworkWatcherName <String> -ResourceGroupName <String> + -Name <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +Get-AzNetworkWatcherConnectionMonitorReport -NetworkWatcher <PSNetworkWatcher> -Name <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Get-AzNetworkWatcherConnectionMonitorReport -Location <String> -Name <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +Get-AzNetworkWatcherConnectionMonitorReport -ResourceId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByInputObject +``` +Get-AzNetworkWatcherConnectionMonitorReport -InputObject <PSConnectionMonitorResult> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkWatcherConnectionMonitorReport cmdlet returns the report on the most recent connection states. + +## EXAMPLES + +### Example 1: Get the most recent connection snapshot of the connection monitor by name in the specified location +```powershell +Get-AzNetworkWatcherConnectionMonitorReport -Location centraluseuap -Name cm +``` + +```output +States : [ + { + "ConnectionState": "Reachable", + "StartTime": "2018-01-12T01:18:20Z", + "EvaluationState": "Completed", + "Hops": [ + { + "Type": "Source", + "Id": "1530e0f2-c9b7-4bc0-a205-cf7332cd8983", + "Address": "10.1.1.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP + /providers/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", + "NextHopIds": [ + "b19b74b1-423d-4f0b-99cd-bcaed4d0b8a2" + ], + "Issues": [] + }, + { + "Type": "VirtualAppliance", + "Id": "b19b74b1-423d-4f0b-99cd-bcaed4d0b8a2", + "Address": "10.1.2.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP + /providers/Microsoft.Network/networkInterfaces/fwNic/ipConfigurations/ipconfig1", + "NextHopIds": [ + "80e46c56-2cf9-4106-8602-608a74832d41" + ], + "Issues": [] + }, + { + "Type": "VirtualAppliance", + "Id": "80e46c56-2cf9-4106-8602-608a74832d41", + "Address": "10.1.3.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP + /providers/Microsoft.Network/networkInterfaces/auNic/ipConfigurations/ipconfig1", + "NextHopIds": [ + "e17cf884-69db-43b8-9cd5-f920770a0dbe" + ], + "Issues": [] + }, + { + "Type": "VirtualNetwork", + "Id": "e17cf884-69db-43b8-9cd5-f920770a0dbe", + "Address": "10.1.4.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP + /providers/Microsoft.Network/networkInterfaces/dbNic0/ipConfigurations/ipconfig1", + "NextHopIds": [], + "Issues": [] + } + ] + }, + { + "ConnectionState": "Unreachable", + "StartTime": "2018-01-12T01:14:11Z", + "EvaluationState": "Completed", + "Hops": [ + { + "Type": "Source", + "Id": "b6251ff8-3d07-4fdf-98f8-04b168e1cf90", + "Address": "10.1.1.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP + /providers/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", + "NextHopIds": [ + "de6d463b-47fb-4beb-afc4-d77782755313" + ], + "Issues": [ + { + "Origin": "Local", + "Severity": "Error", + "Type": "NetworkError", + "Context": [] + } + ] + }, + { + "Type": "VirtualAppliance", + "Id": "de6d463b-47fb-4beb-afc4-d77782755313", + "Address": "10.1.2.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP + /providers/Microsoft.Network/networkInterfaces/fwNic/ipConfigurations/ipconfig1", + "NextHopIds": [ + "0cbadb7e-cd99-4fa9-a832-eb4e0d112293" + ], + "Issues": [] + }, + { + "Type": "VirtualAppliance", + "Id": "0cbadb7e-cd99-4fa9-a832-eb4e0d112293", + "Address": "10.1.3.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP + /providers/Microsoft.Network/networkInterfaces/auNic/ipConfigurations/ipconfig1", + "NextHopIds": [ + "538005d1-994a-4350-9866-6985385beecf" + ], + "Issues": [] + }, + { + "Type": "VirtualNetwork", + "Id": "538005d1-994a-4350-9866-6985385beecf", + "Address": "10.1.4.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP + /providers/Microsoft.Network/networkInterfaces/dbNic0/ipConfigurations/ipconfig1", + "NextHopIds": [], + "Issues": [] + } + ] + }, + { + "ConnectionState": "Reachable", + "StartTime": "2018-01-11T23:54:05Z", + "EvaluationState": "Completed", + "Hops": [ + { + "Type": "Source", + "Id": "3dbec7e8-a37f-4acd-bc5f-86918fffba0e", + "Address": "10.1.1.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP + /providers/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", + "NextHopIds": [ + "1a87cf61-1be6-4add-bba7-f84afbcf3726" + ], + "Issues": [] + }, + { + "Type": "VirtualAppliance", + "Id": "1a87cf61-1be6-4add-bba7-f84afbcf3726", + "Address": "10.1.2.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP + /providers/Microsoft.Network/networkInterfaces/fwNic/ipConfigurations/ipconfig1", + "NextHopIds": [ + "070c0740-308e-43ba-b72f-5d8d5a6537ec" + ], + "Issues": [] + }, + { + "Type": "VirtualAppliance", + "Id": "070c0740-308e-43ba-b72f-5d8d5a6537ec", + "Address": "10.1.3.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP + /providers/Microsoft.Network/networkInterfaces/auNic/ipConfigurations/ipconfig1", + "NextHopIds": [ + "760182e1-c88d-4cfc-a711-65e7e622a67a" + ], + "Issues": [] + }, + { + "Type": "VirtualNetwork", + "Id": "760182e1-c88d-4cfc-a711-65e7e622a67a", + "Address": "10.1.4.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP + /providers/Microsoft.Network/networkInterfaces/dbNic0/ipConfigurations/ipconfig1", + "NextHopIds": [], + "Issues": [] + } + ] + } + ] +``` + +In this example we query the most recent connection states of the specified connection monitor. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Connection monitor object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult +Parameter Sets: SetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The connection monitor name. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: ConnectionMonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID of the connection monitor. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorQueryResult + +## NOTES +Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkWatcherFlowLog.md b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherFlowLog.md new file mode 100644 index 0000000000..57c450252a --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherFlowLog.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkwatcherflowlog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherFlowLog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherFlowLog.md +--- + +# Get-AzNetworkWatcherFlowLog + +## SYNOPSIS +Gets a flow log resource or a list of flow log resources in the specified subscription and region. + +## SYNTAX + +### SetByName (Default) +``` +Get-AzNetworkWatcherFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +Get-AzNetworkWatcherFlowLog -NetworkWatcher <PSNetworkWatcher> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Get-AzNetworkWatcherFlowLog -Location <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SetByResourceId +``` +Get-AzNetworkWatcherFlowLog -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a flow log resource or a list of flow log resources in the specified subscription and region. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzNetworkWatcherFlowLog -Location eastus -Name pstest +``` + +Name : pstest +Id : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NetworkWatcherRG/provid + ers/Microsoft.Network/networkWatchers/NetworkWatcher_eastus/FlowLogs/pstest +Etag : W/"f6047360-d797-4ca6-a9ec-28b5aec5c768" +ProvisioningState : Succeeded +Location : eastus +TargetResourceId : /subscriptions/56abfbd6-ec72-4ce9-831f-bc2b6f2c5505/resourceGroups/MyFlowLog/provide + rs/Microsoft.Network/networkSecurityGroups/MyNSG +StorageId : /subscriptions/56abfbd6-ec72-4ce9-831f-bc2b6f2c5505/resourceGroups/FlowLogsV2Demo/provider + s/Microsoft.Storage/storageAccounts/MySTorage +Enabled : True +RetentionPolicy : { + "Days": 5, + "Enabled": true + } +Format : { + "Type": "JSON", + "Version": 2 + } +FlowAnalyticsConfiguration : { + "networkWatcherFlowAnalyticsConfiguration": { + "enabled": true, + "workspaceId": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", + "workspaceRegion": "eastus", + "workspaceResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourcegr + oups/flowlogsv2demo/providers/Microsoft.OperationalInsights/workspaces/MyWorkspace", + "trafficAnalyticsInterval": 60 + } + +### Example 2 + +Gets a flow log resource or a list of flow log resources in the specified subscription and region. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Get-AzNetworkWatcherFlowLog -NetworkWatcherName nw1 -ResourceGroupName myresourcegroup +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The flow log name. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: FlowLogName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSFlowLogResource + +## NOTES + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherFlowLog](./New-AzNetworkWatcherFlowLog.md) + +[Set-AzNetworkWatcherFlowLog](./Set-AzNetworkWatcherFlowLog.md) + +[Remove-AzNetworkWatcherFlowLog](./Remove-AzNetworkWatcherFlowLog.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkWatcherFlowLogStatus.md b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherFlowLogStatus.md new file mode 100644 index 0000000000..370bf0df0c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherFlowLogStatus.md @@ -0,0 +1,278 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkwatcherflowlogstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherFlowLogStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherFlowLogStatus.md +--- + +# Get-AzNetworkWatcherFlowLogStatus + +## SYNOPSIS +Gets the status of flow logging on a resource. + +## SYNTAX + +### SetByResource (Default) +``` +Get-AzNetworkWatcherFlowLogStatus -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByName +``` +Get-AzNetworkWatcherFlowLogStatus -NetworkWatcherName <String> -ResourceGroupName <String> + -TargetResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Get-AzNetworkWatcherFlowLogStatus -Location <String> -TargetResourceId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkWatcherFlowLogStatus cmdlet Gets the status of flow logging on a resource. +The status includes whether or not flow logging is enabled for the resource provided, the configured storage account to send logs, and the retention policy for the logs. +Currently Network Security Groups are supported for flow logging. + +## EXAMPLES + +### Example 1: Get the Flow Logging Status for a Specified NSG +```powershell +$NW = Get-AzNetworkWatcher -ResourceGroupName NetworkWatcherRg -Name NetworkWatcher_westcentralus +$nsg = Get-AzNetworkSecurityGroup -ResourceGroupName NSGRG -Name appNSG + +Get-AzNetworkWatcherFlowLogStatus -NetworkWatcher $NW -TargetResourceId $nsg.Id +``` + +```output +TargetResourceId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Network/networkSecurityGroups/appNSG +Properties : { + "Enabled": true, + "RetentionPolicy": { + "Days": 0, + "Enabled": false + }, + "StorageId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123" + "Format" : { + "Type ": "Json", + "Version": 1 + } + } +``` + +In this example we get the flow logging status for a Network Security Group. The specified NSG has flow logging enabled, default format, and no retention policy set. + +### Example 2: Get the Flow Logging and Traffic Analytics Status for a Specified NSG +```powershell +$NW = Get-AzNetworkWatcher -ResourceGroupName NetworkWatcherRg -Name NetworkWatcher_westcentralus +$nsg = Get-AzNetworkSecurityGroup -ResourceGroupName NSGRG -Name appNSG + +Get-AzNetworkWatcherFlowLogStatus -NetworkWatcher $NW -TargetResourceId $nsg.Id +``` + +```output +TargetResourceId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Network/networkSecurityGroups/appNSG +StorageId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123 +Enabled : True +RetentionPolicy : { + "Days": 0, + "Enabled": false + } +Format : { + "Type ": "Json", + "Version": 1 + } +FlowAnalyticsConfiguration : { + "networkWatcherFlowAnalyticsConfiguration": { + "enabled": true, + "workspaceId": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", + "workspaceRegion": "WorkspaceLocation", + "workspaceResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourcegroups/WorkspaceRg/providers/microsoft.operationalinsights/workspaces/WorkspaceName", + "TrafficAnalyticsInterval": 60 + } + } +``` + +In this example we get the flow logging and Traffic Analytics status for a Network Security Group. The specified NSG has flow logging and Traffic Analytics enabled, default format and no retention policy set. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceId +The target resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSFlowLog + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, watcher, flow, logs, flowlog, logging + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkWatcherNextHop.md b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherNextHop.md new file mode 100644 index 0000000000..8aa4f41953 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherNextHop.md @@ -0,0 +1,283 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkwatchernexthop +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherNextHop.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherNextHop.md +--- + +# Get-AzNetworkWatcherNextHop + +## SYNOPSIS +Gets the next hop from a VM. + +## SYNTAX + +### SetByResource (Default) +``` +Get-AzNetworkWatcherNextHop -NetworkWatcher <PSNetworkWatcher> -TargetVirtualMachineId <String> + -DestinationIPAddress <String> -SourceIPAddress <String> [-TargetNetworkInterfaceId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByName +``` +Get-AzNetworkWatcherNextHop -NetworkWatcherName <String> -ResourceGroupName <String> + -TargetVirtualMachineId <String> -DestinationIPAddress <String> -SourceIPAddress <String> + [-TargetNetworkInterfaceId <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Get-AzNetworkWatcherNextHop -Location <String> -TargetVirtualMachineId <String> -DestinationIPAddress <String> + -SourceIPAddress <String> [-TargetNetworkInterfaceId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkWatcherNextHop cmdlet gets the next hop from a VM. +Next hop allows you to view the type of Azure resource, the associated IP address of that resource, and the routing table rule that is responsible for the route. + +## EXAMPLES + +### Example 1: Get the Next Hop when communicating with an Internet IP +```powershell +$nw = Get-AzResource | Where-Object {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } +$networkWatcher = Get-AzNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName +$VM = Get-AzVM -ResourceGroupName ContosoResourceGroup -Name VM0 +$Nics = Get-AzNetworkInterface | Where-Object {$_.Id -eq $vm.NetworkProfile.NetworkInterfaces.Id.ForEach({$_})} +Get-AzNetworkWatcherNextHop -NetworkWatcher $networkWatcher -TargetVirtualMachineId $VM.Id -SourceIPAddress $nics[0].IpConfigurations[0].PrivateIpAddress -DestinationIPAddress 204.79.197.200 +``` + +```output +NextHopIpAddress NextHopType RouteTableId +---------------- ----------- ------------ + Internet System Route +``` + +Gets the Next Hop for outbound communication from the primary Network Interface on the specified Virtual Machine to 204.79.197.200 (www.bing.com) + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationIPAddress +Destination IP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceIPAddress +Source IP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNetworkInterfaceId +Target network interface Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVirtualMachineId +The target virtual machine ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNextHopResult + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, next, hop + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkWatcherPacketCapture.md b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherPacketCapture.md new file mode 100644 index 0000000000..8f06a82288 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherPacketCapture.md @@ -0,0 +1,246 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkwatcherpacketcapture +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherPacketCapture.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherPacketCapture.md +--- + +# Get-AzNetworkWatcherPacketCapture + +## SYNOPSIS +Gets information and properties and status of a packet capture resource. + +## SYNTAX + +### SetByResource (Default) +``` +Get-AzNetworkWatcherPacketCapture -NetworkWatcher <PSNetworkWatcher> [-PacketCaptureName <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByName +``` +Get-AzNetworkWatcherPacketCapture -NetworkWatcherName <String> -ResourceGroupName <String> + [-PacketCaptureName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Get-AzNetworkWatcherPacketCapture -Location <String> [-PacketCaptureName <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkWatcherPacketCapture gets the properties and status of a packet capture resource. + +## EXAMPLES + +### Example 1: Create a Packet Capture with multiple filters and retrieve its status +```powershell +$nw = Get-AzResource | Where-Object {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } +$networkWatcher = Get-AzNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName + +$storageAccount = Get-AzStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 + +$filter1 = New-AzPacketCaptureFilterConfig -Protocol TCP -RemoteIPAddress "1.1.1.1-255.255.255" -LocalIPAddress "10.0.0.3" -LocalPort "1-65535" -RemotePort "20;80;443" +$filter2 = New-AzPacketCaptureFilterConfig -Protocol UDP +New-AzNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -TargetVirtualMachineId $vm.Id -PacketCaptureName "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSeconds 60 -Filter $filter1, $filter2 + +Get-AzNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -PacketCaptureName "PacketCaptureTest" +``` + +In this example we create a packet capture named "PacketCaptureTest" with multiple filters and a time limit. Once the session is complete, it will be saved to the specified storage account. +We then call Get-AzNetworkWatcherPacketCapture to retrieve the status of the capture session. +Note: The Azure Network Watcher extension must be installed on the target virtual machine to create packet captures. + +>[!NOTE] +>If you create a reference to the packet capture directly from the New-AzNetworkWatcherPacketCapture command, it won't have all the properties. You can get all of the properties of the packet capture by making a call to the Get-AzNetworkWatcherPacketCapture command. + +### Example 2: Create a Packet Capture with multiple filters and retrieve its status +```powershell +Get-AzNetworkWatcherPacketCapture -ResourceGroupName rg1 -NetworkWatcherName nw1 -PacketCaptureName PacketCapture* +``` + +This cmdlet returns all PacketCaptures that start with "PacketCapture" in the nw1 Network Watcher. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PacketCaptureName +The packet capture name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSGetPacketCaptureResult + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) + diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkWatcherReachabilityProvidersList.md b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherReachabilityProvidersList.md new file mode 100644 index 0000000000..bb71aa3d23 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherReachabilityProvidersList.md @@ -0,0 +1,329 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkwatcherreachabilityproviderslist +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherReachabilityProvidersList.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherReachabilityProvidersList.md +--- + +# Get-AzNetworkWatcherReachabilityProvidersList + +## SYNOPSIS +Lists all available internet service providers for a specified Azure region. + +## SYNTAX + +### SetByName (Default) +``` +Get-AzNetworkWatcherReachabilityProvidersList -NetworkWatcherName <String> -ResourceGroupName <String> + [-Location <String[]>] [-Country <String>] [-State <String>] [-City <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +Get-AzNetworkWatcherReachabilityProvidersList -NetworkWatcher <PSNetworkWatcher> [-Location <String[]>] + [-Country <String>] [-State <String>] [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SetByLocation +``` +Get-AzNetworkWatcherReachabilityProvidersList -NetworkWatcherLocation <String> [-Location <String[]>] + [-Country <String>] [-State <String>] [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SetByResourceId +``` +Get-AzNetworkWatcherReachabilityProvidersList -ResourceId <String> [-Location <String[]>] [-Country <String>] + [-State <String>] [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkWatcherReachabilityProvidersList lists all available internet service providers for a specified Azure region. + +## EXAMPLES + +### Example 1 +```powershell +$nw = Get-AzNetworkWatcher -Name NetworkWatcher -ResourceGroupName NetworkWatcherRG +Get-AzNetworkWatcherReachabilityProvidersList -NetworkWatcher $nw -Location "West US" -Country "United States" -State "washington" -City "seattle" +``` + +```output +"countries" : [ + { + "countryName" : "United States", + "states" : [ + { + "stateName" : "washington", + "cities" : [ + { + "cityName" : "seattle", + "providers" : [ + "Comcast Cable Communications, Inc. - ASN 7922", + "Comcast Cable Communications, LLC - ASN 7922", + "Level 3 Communications, Inc. (GBLX) - ASN 3549", + "Qwest Communications Company, LLC - ASN 209" + ] + } + ] + } + ] + } +] +``` + +Lists all available providers in Seattle, WA for Azure Data Center in West US. + +### Example 2 + +Lists all available internet service providers for a specified Azure region. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Get-AzNetworkWatcherReachabilityProvidersList -NetworkWatcherName nw1 -ResourceGroupName myresourcegroup +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -City +The name of the city. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Country +The name of the country. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Optional Azure regions to scope the query to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherLocation +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: ResourceName, Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Id of network watcher resource. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +The name of the state. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAvailableProvidersList + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, next, hop + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkWatcherReachabilityReport.md b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherReachabilityReport.md new file mode 100644 index 0000000000..52488bf702 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherReachabilityReport.md @@ -0,0 +1,378 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkwatcherreachabilityreport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherReachabilityReport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherReachabilityReport.md +--- + +# Get-AzNetworkWatcherReachabilityReport + +## SYNOPSIS +Gets the relative latency score for internet service providers from a specified location to Azure regions. + +## SYNTAX + +### SetByName (Default) +``` +Get-AzNetworkWatcherReachabilityReport -NetworkWatcherName <String> -ResourceGroupName <String> + [-Provider <String[]>] [-Location <String[]>] -StartTime <DateTime> -EndTime <DateTime> [-Country <String>] + [-State <String>] [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +Get-AzNetworkWatcherReachabilityReport -NetworkWatcher <PSNetworkWatcher> [-Provider <String[]>] + [-Location <String[]>] -StartTime <DateTime> -EndTime <DateTime> [-Country <String>] [-State <String>] + [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +Get-AzNetworkWatcherReachabilityReport -ResourceId <String> [-Provider <String[]>] [-Location <String[]>] + -StartTime <DateTime> -EndTime <DateTime> [-Country <String>] [-State <String>] [-City <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Get-AzNetworkWatcherReachabilityReport -NetworkWatcherLocation <String> [-Provider <String[]>] + [-Location <String[]>] -StartTime <DateTime> -EndTime <DateTime> [-Country <String>] [-State <String>] + [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkWatcherReachabilityReport gets the relative latency score for internet service providers from a specified location to Azure regions. + +## EXAMPLES + +### Example 1 +```powershell +$nw = Get-AzNetworkWatcher -Name NetworkWatcher -ResourceGroupName NetworkWatcherRG +Get-AzNetworkWatcherReachabilityReport -NetworkWatcher $nw -Location "West US" -Country "United States" -StartTime "2017-10-10" -EndTime "2017-10-12" +``` + +```output +"aggregationLevel" : "Country", +"providerLocation" : { + "country" : "United States" +}, +"reachabilityReport" : [ + { + "provider" : "Frontier Communications of America, Inc. - ASN 5650", + "azureLocation": "West US", + "latencies": [ + { + "timeStamp": "2017-10-10T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-10-11T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-10-12T00:00:00Z", + "score": 94 + } + ] + } +] +``` + +Gets relative latencies to Azure Data Center in West US from 2017-10-10 to 2017-10-12 inside United State. + +### Example 2 + +Gets the relative latency score for internet service providers from a specified location to Azure regions. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Get-AzNetworkWatcherReachabilityReport -Country 'United States' -EndTime '2017-10-12' -Location 'West US' -NetworkWatcherName nw1 -ResourceGroupName myresourcegroup -StartTime '2017-10-10' -State 'washington' +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -City +The name of the city. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Country +The name of the country. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +The end time for the Azure reachability report. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Optional Azure regions to scope the query to. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherLocation +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: ResourceName, Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Provider +List of Internet service providers. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Id of network watcher resource. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +The start time for the Azure reachability report. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The name of the state. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureReachabilityReport + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, reachability, report + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkWatcherSecurityGroupView.md b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherSecurityGroupView.md new file mode 100644 index 0000000000..bedebf4072 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherSecurityGroupView.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkwatchersecuritygroupview +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherSecurityGroupView.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherSecurityGroupView.md +--- + +# Get-AzNetworkWatcherSecurityGroupView + +## SYNOPSIS +View the configured and effective network security group rules applied on a VM. + +## SYNTAX + +### SetByResource (Default) +``` +Get-AzNetworkWatcherSecurityGroupView -NetworkWatcher <PSNetworkWatcher> -TargetVirtualMachineId <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByName +``` +Get-AzNetworkWatcherSecurityGroupView -NetworkWatcherName <String> -ResourceGroupName <String> + -TargetVirtualMachineId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Get-AzNetworkWatcherSecurityGroupView -Location <String> -TargetVirtualMachineId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkWatcherSecurityGroupView enables you to view the configured and effective network security group rules applied on a VM. + +## EXAMPLES + +### Example 1: Make a Security Group View call on a VM +```powershell +$nw = Get-AzResource | Where-Object {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } +$networkWatcher = Get-AzNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName +$VM = Get-AzVM -ResourceGroupName ContosoResourceGroup -Name VM0 +Get-AzNetworkWatcherSecurityGroupView -NetworkWatcher $networkWatcher -TargetVirtualMachineId $VM.Id +``` + +In the above example, we first get the regional Network Watcher, then a VM in the region. +Then we make a Security Group View call on the specified VM. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetVirtualMachineId +The target VM Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSSecurityGroupViewResult + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, flow, ip + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkWatcherTopology.md b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherTopology.md new file mode 100644 index 0000000000..94252db5f4 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherTopology.md @@ -0,0 +1,306 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkwatchertopology +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherTopology.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherTopology.md +--- + +# Get-AzNetworkWatcherTopology + +## SYNOPSIS +Gets a network level view of resources and their relationships in a resource group. + +## SYNTAX + +### SetByResource (Default) +``` +Get-AzNetworkWatcherTopology -NetworkWatcher <PSNetworkWatcher> -TargetResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByName +``` +Get-AzNetworkWatcherTopology -NetworkWatcherName <String> -ResourceGroupName <String> + -TargetResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Get-AzNetworkWatcherTopology -Location <String> -TargetResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkWatcherTopology cmdlet a network level view of resources and their relationships in a resource group. +Note: If resources from multiple regions reside in the resource group, only the resources in the same region as the Network Watcher will be included in the JSON output. + +## EXAMPLES + +### Example 1: Get an Azure Topology +```powershell +$networkWatcher = Get-AzNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroupName NetworkWatcherRG +Get-AzNetworkWatcherTopology -NetworkWatcher $networkWatcher -TargetResourceGroupName testresourcegroup +``` + +```output +Id : e33d80cf-4f76-4b8f-b51c-5bb8eba80103 +CreatedDateTime : 0/00/0000 9:21:51 PM +LastModified : 0/00/0000 4:53:29 AM +TopologyResources : [ + { + "Name": "testresourcegroup-vnet", + "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/virtualNetworks/testresourcegroup-vnet", + "Location": "westcentralus", + "TopologyAssociations": [ + { + "Name": "default", + "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/virtualNetworks/testresourcegroup-vnet/subnets/default", + "AssociationType": "Contains" + } + ] + }, + { + "Name": "default", + "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/virtualNetworks/testresourcegroup-vnet/subnets/default", + "Location": "westcentralus", + "TopologyAssociations": [] + }, + { + "Name": "VM0", + "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Compute/virtualMachines/VM0", + "TopologyAssociations": [ + { + "Name": "vm0131", + "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkInterfaces/vm0131", + "AssociationType": "Contains" + } + ] + }, + { + "Name": "vm0131", + "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkInterfaces/vm0131", + "Location": "westcentralus", + "TopologyAssociations": [ + { + "Name": "VM0", + "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Compute/virtualMachines/VM0", + "AssociationType": "Associated" + }, + { + "Name": "VM0-nsg", + "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkSecurityGroups/VM0-nsg", + "AssociationType": "Associated" + }, + { + "Name": "default", + "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/virtualNetworks/testresourcegroup-vnet/subnets/default", + "AssociationType": "Associated" + }, + { + "Name": "VM0-ip", + "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/publicIPAddresses/VM0-ip", + "AssociationType": "Associated" + } + ] + }, + { + "Name": "VM0-nsg", + "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkSecurityGroups/VM0-nsg", + "Location": "westcentralus", + "TopologyAssociations": [ + { + "Name": "default-allow-rdp", + "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkSecurityGroups/VM0-nsg/securityRules/default-allow-rdp", + "AssociationType": "Contains" + } + ] + }, + { + "Name": "default-allow-rdp", + "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkSecurityGroups/VM0-nsg/securityRules/default-allow-rdp", + "Location": "westcentralus", + "TopologyAssociations": [] + }, + { + "Name": "VM0-ip", + "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/publicIPAddresses/VM0-ip", + "Location": "westcentralus", + "TopologyAssociations": [ + { + "Name": "vm0131", + "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkInterfaces/vm0131", + "AssociationType": "Associated" + } + ] + } + ] +``` + +In this example we run the Get-AzNetworkWatcherTopology cmdlet on a resource group that contains a VM, Nic, NSG, and public IP. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSTopology + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, topology, view + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) + diff --git a/azps-10.1.0/Az.Network/Get-AzNetworkWatcherTroubleshootingResult.md b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherTroubleshootingResult.md new file mode 100644 index 0000000000..bff2834c26 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzNetworkWatcherTroubleshootingResult.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-aznetworkwatchertroubleshootingresult +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherTroubleshootingResult.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzNetworkWatcherTroubleshootingResult.md +--- + +# Get-AzNetworkWatcherTroubleshootingResult + +## SYNOPSIS +Gets the troubleshooting result from the previously run or currently running troubleshooting operation. + +## SYNTAX + +### SetByResource (Default) +``` +Get-AzNetworkWatcherTroubleshootingResult -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByName +``` +Get-AzNetworkWatcherTroubleshootingResult -NetworkWatcherName <String> -ResourceGroupName <String> + -TargetResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Get-AzNetworkWatcherTroubleshootingResult -Location <String> -TargetResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzNetworkWatcherTroubleshootingResult cmdlet gets the troubleshooting result from the previously run or currently running Start-AzNetworkWatcherResourceTroubleshooting operation. +If the troubleshooting operation is currently in progress, then this operation may take a few minutes to complete. Currently Virtual Network Gateways and Connections are supported. + +## EXAMPLES + +### Example 1: Start Troubleshooting on a Virtual Network Gateway and Retrieve Result +```powershell +$nw = Get-AzResource | Where-Object {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } +$networkWatcher = Get-AzNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName + +$target = '/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{vnetGatewayName}' +$storageId = '/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{storageAccountName}' +$storagePath = 'https://{storageAccountName}.blob.core.windows.net/troubleshoot' + +Start-AzNetworkWatcherResourceTroubleshooting -NetworkWatcher $networkWatcher -TargetResourceId $target -StorageId $storageId -StoragePath $storagePath + +Get-AzNetworkWatcherTroubleshootingResult -NetworkWatcher $NW -TargetResourceId $target +``` + +The above sample starts troubleshooting on a virtual network gateway. The operation may take a few minutes to complete. +After troubleshooting has started, a Get-AzNetworkWatcherTroubleshootingResult call is made to the resource to retrieve the result of this call. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceId +The target resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSTroubleshootingResult + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, troubleshoot, VPN, connection + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Get-AzP2sVpnGateway.md b/azps-10.1.0/Az.Network/Get-AzP2sVpnGateway.md new file mode 100644 index 0000000000..2e162e4603 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzP2sVpnGateway.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azp2svpngateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzP2sVpnGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzP2sVpnGateway.md +--- + +# Get-AzP2sVpnGateway + +## SYNOPSIS +Gets an existing P2SVpnGateway under VirtualHub. + +## SYNTAX + +### ListBySubscriptionId (Default) +``` +Get-AzP2sVpnGateway [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListByResourceGroupName +``` +Get-AzP2sVpnGateway [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzP2sVpnGateway** cmdlet enables you to get an existing P2SVpnGateway under VirtualHub. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzP2sVpnGateway -ResourceGroupName P2SCortexGATesting -Name 683482ade8564515aed4b8448c9757ea-westus-gw +``` + +```output +ResourceGroupName : P2SCortexGATesting +Name : 683482ade8564515aed4b8448c9757ea-westus-gw +Id : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482ade8564515a + ed4b8448c9757ea-westus-gw +Location : westus +VpnGatewayScaleUnit : 1 +VirtualHub : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub +VpnServerConfiguration : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/WestUsConfig +VpnServerConfigurationLocation : +VpnClientConnectionHealth : null +Type : Microsoft.Network/p2sVpnGateways +ProvisioningState : Succeeded +P2SConnectionConfigurations : [ + { + "ProvisioningState": "Succeeded", + "VpnClientAddressPool": { + "AddressPrefixes": [ + "192.168.2.0/24" + ] + }, + "RoutingConfiguration": { + "AssociatedRouteTable": { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + }, + "Name": "P2SConnectionConfigDefault", + "Etag": "W/\"4b96e6a2-b4d8-46b3-9210-76d40f359bef\"", + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482 + ade8564515aed4b8448c9757ea-westus-gw/p2sConnectionConfigurations/P2SConnectionConfigDefault" + } + ] +``` + +The **Get-AzP2sVpnGateway** cmdlet enables you to get an existing P2SVpnGateway under VirtualHub that is used for Point to site connectivity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: ResourceName, P2SVpnGatewayName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzP2sVpnGatewayConnectionHealth.md b/azps-10.1.0/Az.Network/Get-AzP2sVpnGatewayConnectionHealth.md new file mode 100644 index 0000000000..b9b8a1bb2d --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzP2sVpnGatewayConnectionHealth.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azp2svpngatewayconnectionhealth +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzP2sVpnGatewayConnectionHealth.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzP2sVpnGatewayConnectionHealth.md +--- + +# Get-AzP2sVpnGatewayConnectionHealth + +## SYNOPSIS +Gets the current aggregared point to site connections health information from P2SVpnGateway. + +## SYNTAX + +### ByP2SVpnGatewayName (Default) +``` +Get-AzP2sVpnGatewayConnectionHealth [-Name <String>] -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByP2SVpnGatewayObject +``` +Get-AzP2sVpnGatewayConnectionHealth -InputObject <PSP2SVpnGateway> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByP2SVpnGatewayResourceId +``` +Get-AzP2sVpnGatewayConnectionHealth -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzP2sVpnGatewayConnectionHealth** cmdlet enables you to get the current aggregated health of point to site connections from P2SVpnGateway. Aggregated health shows number of point to site clients connected to P2SVpnGateway, total ingress and egress bytes transferred through P2SVpnGateway and allocated ip addresses for connected point to site clients. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzP2sVpnGatewayConnectionHealth -ResourceGroupName P2SCortexGATesting -Name 683482ade8564515aed4b8448c9757ea-westus-gw +``` + +```output +ResourceGroupName : P2SCortexGATesting +Name : 683482ade8564515aed4b8448c9757ea-westus-gw +Id : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482ade8564515a + ed4b8448c9757ea-westus-gw +Location : westus +VpnGatewayScaleUnit : 1 +VirtualHub : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub +VpnServerConfiguration : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/WestUsConfig +VpnServerConfigurationLocation : +VpnClientConnectionHealth : { + "VpnClientConnectionsCount": 2, + "AllocatedIpAddresses": { "192.168.2.1", "192.168.2.2" }, + "TotalIngressBytesTransferred": 100, + "TotalEgressBytesTransferred": 200 + } +Type : Microsoft.Network/p2sVpnGateways +ProvisioningState : Succeeded +P2SConnectionConfigurations : [ + { + "ProvisioningState": "Succeeded", + "VpnClientAddressPool": { + "AddressPrefixes": [ + "192.168.2.0/24" + ] + }, + "Name": "P2SConnectionConfigDefault", + "Etag": "W/\"4b96e6a2-b4d8-46b3-9210-76d40f359bef\"", + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482 + ade8564515aed4b8448c9757ea-westus-gw/p2sConnectionConfigurations/P2SConnectionConfigDefault" + } + ] +``` + +The **Get-AzP2sVpnGatewayConnectionHealth** cmdlet enables you to get the current aggregated health of point to site connections from P2SVpnGateway. Above command let output health shows that number of point to site clients connected to P2SVpnGateway are 2. Total ingress and egress bytes transferred through P2SVpnGateway are 100 and 200 respectively. Allocated ip addresses for connected point to site clients are "192.168.2.1", "192.168.2.2". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The p2s vpn gateway object to be modified + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +Parameter Sets: ByP2SVpnGatewayObject +Aliases: P2SVpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayName +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the P2SVpnGateway to be modified. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzP2sVpnGatewayDetailedConnectionHealth.md b/azps-10.1.0/Az.Network/Get-AzP2sVpnGatewayDetailedConnectionHealth.md new file mode 100644 index 0000000000..42eb177208 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzP2sVpnGatewayDetailedConnectionHealth.md @@ -0,0 +1,178 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azp2svpngatewaydetailedconnectionhealth +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzP2sVpnGatewayDetailedConnectionHealth.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzP2sVpnGatewayDetailedConnectionHealth.md +--- + +# Get-AzP2sVpnGatewayDetailedConnectionHealth + +## SYNOPSIS +Gets the detailed information of current point to site connections from P2SVpnGateway. + +## SYNTAX + +### ByP2SVpnGatewayName (Default) +``` +Get-AzP2sVpnGatewayDetailedConnectionHealth [-Name <String>] -ResourceGroupName <String> + -OutputBlobSasUrl <String> [-VpnUserNamesFilter <String[]>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByP2SVpnGatewayObject +``` +Get-AzP2sVpnGatewayDetailedConnectionHealth -InputObject <PSP2SVpnGateway> -OutputBlobSasUrl <String> + [-VpnUserNamesFilter <String[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByP2SVpnGatewayResourceId +``` +Get-AzP2sVpnGatewayDetailedConnectionHealth -ResourceId <String> -OutputBlobSasUrl <String> + [-VpnUserNamesFilter <String[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzP2sVpnGatewayDetailedConnectionHealth** cmdlet enables you to get the detailed information of current point to site connections from P2SVpnGateway. Customer needs to pass SAS url where we can put this detailed health information. + +Please note that the SAS url provided should be one for the **blob** (file) that has been created in the storage account and **not** the container. Please use the **New-AzStorageBlobSASToken** Powershell command and not the **New-AzStorageContainerSASToken**. You will also need to allow read and write permissions on your SaSURl. + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$blobSasUrl = New-AzStorageBlobSASToken -Container contp2stesting -Blob emptyfile.txt -Context $context -Permission "rwd" -StartTime $now.AddHours(-1) -ExpiryTime $now.AddDays(1) -FullUri +$blobSasUrl +SignedSasUrl +Get-AzP2sVpnGatewayDetailedConnectionHealth -Name 683482ade8564515aed4b8448c9757ea-westus-gw -ResourceGroupName P2SCortexGATesting -OutputBlobSasUrl $blobSasUrl +SasUrl : SignedSasUrl +``` + +The **Get-AzP2sVpnGatewayDetailedConnectionHealth** cmdlet enables you to get the detailed information of current point to site connections from P2SVpnGateway. Customer can download health details from passed SAS url download. This will show information of each point to site connection with usernames, bytes in, bytes out, allocated ip address etc. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The p2s vpn gateway object to be modified + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +Parameter Sets: ByP2SVpnGatewayObject +Aliases: P2SVpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayName +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputBlobSasUrl +OutputBlob Sas url to which the p2s vpn connection health will be written. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the P2SVpnGateway to be modified. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnUserNamesFilter +The list of P2S vpn user names to filter. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnConnectionHealth + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzP2sVpnGatewayVpnProfile.md b/azps-10.1.0/Az.Network/Get-AzP2sVpnGatewayVpnProfile.md new file mode 100644 index 0000000000..78d868860c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzP2sVpnGatewayVpnProfile.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azp2svpngatewayvpnprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzP2sVpnGatewayVpnProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzP2sVpnGatewayVpnProfile.md +--- + +# Get-AzP2sVpnGatewayVpnProfile + +## SYNOPSIS +Generates and returns a SAS url for customer to download Vpn profile for point to site client setup to have point to site connectivity to P2SVpnGateway. + +## SYNTAX + +### ByP2SVpnGatewayName (Default) +``` +Get-AzP2sVpnGatewayVpnProfile [-Name <String>] -ResourceGroupName <String> [-AuthenticationMethod <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByP2SVpnGatewayObject +``` +Get-AzP2sVpnGatewayVpnProfile -InputObject <PSP2SVpnGateway> [-AuthenticationMethod <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByP2SVpnGatewayResourceId +``` +Get-AzP2sVpnGatewayVpnProfile -ResourceId <String> [-AuthenticationMethod <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzP2sVpnGatewayVpnProfile** cmdlet enables you to generate and get a SAS url for customer to download Vpn profile for point to site client setup to have point to site connectivity to P2SVpnGateway. Point to site client setup using this Vpn profile can connect to this specific P2SVpnGateway only. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzP2sVpnGatewayVpnProfile -Name 683482ade8564515aed4b8448c9757ea-westus-gw -ResourceGroupName P2SCortexGATesting -AuthenticationMethod EAPTLS +``` + +```output +ProfileUrl : https://nfvprodsuppby.blob.core.windows.net/vpnprofileimmutable/8cf00031-37ec-4949-b74a-48f9021bf4c0/vpnprofile/2f132439-1051-44c6-9128-b704c1c48cf7/vpnclientconfiguration.zip?sv=2017-04-17&sr=b&sig=HmBSprVrs + 6hDY3x1HX958nimOjavnEjL2rlSuKIIW8Q%3D&st=2019-10-25T19%3A20%3A04Z&se=2019-10-25T20%3A20%3A04Z&sp=r&fileExtension=.zip +``` + +The **Get-AzP2sVpnGatewayVpnProfile** cmdlet enables you to generate and get a SAS url for customer to download Vpn profile for point to site client setup to have point to site connectivity to P2SVpnGateway. ProfileUrl shows the SAS url from where customer can download Vpn profile for point to site client setup. + +## PARAMETERS + +### -AuthenticationMethod +Authentication Method + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: EAPTLS, EAPMSCHAPv2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The p2s vpn gateway object to be modified + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +Parameter Sets: ByP2SVpnGatewayObject +Aliases: P2SVpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayName +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the P2SVpnGateway to be modified. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnProfileResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzPrivateDnsZoneGroup.md b/azps-10.1.0/Az.Network/Get-AzPrivateDnsZoneGroup.md new file mode 100644 index 0000000000..aa08ea1e6b --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzPrivateDnsZoneGroup.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azprivatednszonegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPrivateDnsZoneGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPrivateDnsZoneGroup.md +--- + +# Get-AzPrivateDnsZoneGroup + +## SYNOPSIS +Gets private DNS zone group + +## SYNTAX + +### List (Default) +``` +Get-AzPrivateDnsZoneGroup -ResourceGroupName <String> -PrivateEndpointName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByName +``` +Get-AzPrivateDnsZoneGroup -ResourceGroupName <String> -PrivateEndpointName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPrivateDnsZoneGroup** cmdlet gets one or more private DNS zone groups. + +## EXAMPLES + +### Example 1: Retrieve private DNS zone group +```powershell +Get-AzPrivateDnsZoneGroup -ResourceGroupName "rg" -PrivateEndpointName "test-pr-endpoint" -name "dnsgroup1" +``` + +```output +Name : dnsgroup1 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/test-pr-endpoint/privateDnsZoneGroups/dnsgroup1 +ProvisioningState : Succeeded +PrivateDnsZoneConfigs : [ + { + "Name": "test-vault-azure-com", + "PrivateDnsZoneId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Network/privateDnsZones/test.vault.azure.com", + "RecordSets": [] + } + ] +``` + +Above example gets a private DNS zone group named dnsgroup1 in the resource group rg. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the private dns zone group. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: PrivateDnsZoneGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateEndpointName +The name of the private endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateDnsZoneGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzPrivateEndpoint.md b/azps-10.1.0/Az.Network/Get-AzPrivateEndpoint.md new file mode 100644 index 0000000000..ac6e7b7703 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzPrivateEndpoint.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azprivateendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPrivateEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPrivateEndpoint.md +--- + +# Get-AzPrivateEndpoint + +## SYNOPSIS +Get a private endpoint + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzPrivateEndpoint [-Name <String>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### Expand +``` +Get-AzPrivateEndpoint -Name <String> -ResourceGroupName <String> -ExpandResource <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPrivateEndpoint** cmdlet gets one or more private endpoints. + +## EXAMPLES + +### Example 1: Retrieve a private endpoint +```powershell +Get-AzPrivateEndpoint -Name MyPrivateEndpoint1 -ResourceGroupName TestResourceGroup +``` + +```output +Name : MyPrivateEndpoint1 +ResourceGroupName : TestResourceGroup +Location : eastus2euap +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/provi + ders/Microsoft.Network/privateEndpoints/MyPrivateEndpoint1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +Subnet : { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork1/subnets/backendSubnet", + } +NetworkInterfaces : [ + { + + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/networkInterfaces/MyNic1", + } + ] +PrivateLinkServiceConnections : [] +ManualPrivateLinkServiceConnections : [ + { + "Name": "MyPrivateLinkServiceConnection", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/privateEndpoints/MyPrivateEndpoint1/manualPrivateLinkServi + ceConnections/MyPrivateLinkServiceConnection", + "PrivateLinkServiceId": "/subscriptions/00000000-0000-0000-0000-000000000000/ + resourceGroups/TestResourceGroup/providers/Microsoft.Network/priv + ateLinkServices/MyPrivateLinkService", + "PrivateLinkServiceConnectionState": { + "Status": "Pending", + "Description": "Awaiting approval" + } + } + ] +``` + +This command gets the private endpoint named MyPrivateEndpoint1 in the resource group TestResourceGroup + +### Example 2: List all private endpoints in ResourceGroup +```powershell +Get-AzPrivateEndpoint -ResourceGroupName TestResourceGroup +``` + +```output +Name : MyPrivateEndpoint1 +ResourceGroupName : TestResourceGroup +Location : eastus2euap +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/provi + ders/Microsoft.Network/privateEndpoints/MyPrivateEndpoint1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +Subnet : { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork1/subnets/backendSubnet", + } +NetworkInterfaces : [ + { + + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/networkInterfaces/MyNic1", + } + ] +PrivateLinkServiceConnections : [] +ManualPrivateLinkServiceConnections : [ + { + "Name": "MyPrivateLinkServiceConnection", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/privateEndpoints/MyPrivateEndpoint1/manualPrivateLinkServi + ceConnections/MyPrivateLinkServiceConnection", + "PrivateLinkServiceId": "/subscriptions/00000000-0000-0000-0000-000000000000/ + resourceGroups/TestResourceGroup/providers/Microsoft.Network/priv + ateLinkServices/MyPrivateLinkService", + "PrivateLinkServiceConnectionState": { + "Status": "Pending", + "Description": "Awaiting approval" + } + } + ] +``` + +This command gets all of private end points in the resource group TestResourceGroup + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandResource +The resource reference to be expanded. + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +## NOTES + +## RELATED LINKS + +[New-AzPrivateEndpoint](./New-AzPrivateEndpoint.md) + +[Remove-AzPrivateEndpoint](./Remove-AzPrivateEndpoint.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzPrivateEndpointConnection.md b/azps-10.1.0/Az.Network/Get-AzPrivateEndpointConnection.md new file mode 100644 index 0000000000..7ac0771a3b --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzPrivateEndpointConnection.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPrivateEndpointConnection.md +--- + +# Get-AzPrivateEndpointConnection + +## SYNOPSIS +Gets a private endpoint connection resource. + +## SYNTAX + +### ByResourceId (Default) +``` +Get-AzPrivateEndpointConnection [-Description <String>] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByPrivateLinkResourceId +``` +Get-AzPrivateEndpointConnection -PrivateLinkResourceId <String> [-Description <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResource +``` +Get-AzPrivateEndpointConnection [-Description <String>] [-Name <String>] -ResourceGroupName <String> + -ServiceName <String> [-DefaultProfile <IAzureContextContainer>] -PrivateLinkResourceType <String> + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPrivateEndpointConnection** cmdlet retrieves a private endpoint connection resource. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzPrivateEndpointConnection -PrivateLinkResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Sql/servers/mySql' +``` + +This example return a list of all private endpoint connections belongs to sql server named Mysql. + +### Example 2 +```powershell +Get-AzPrivateEndpointConnection -Name MyPrivateEndpointConnection1 -ResourceGroupName TestResourceGroup -ServiceName MyPrivateLinkService -PrivateLinkResourceType Microsoft.Network/privateLinkServices +``` + +This example get a private endpoint connection named MyPrivateEndpointConnection1 belongs to private link service named MyPrivateLinkService + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The reason of action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PrivateLinkResourceId +The Azure resource manager id of the private link resource that private endpoint connection belongs to. + +```yaml +Type: System.String +Parameter Sets: ByPrivateLinkResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateLinkResourceType +The private link resource type. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: +Accepted values: Microsoft.AgFoodPlatform/farmBeats, Microsoft.ApiManagement/service, Microsoft.AppConfiguration/configurationStores, Microsoft.Attestation/attestationProviders, Microsoft.Authorization/resourceManagementPrivateLinks, Microsoft.Automation/automationAccounts, Microsoft.Batch/batchAccounts, Microsoft.Cache/Redis, Microsoft.Cache/redisEnterprise, Microsoft.CognitiveServices/accounts, Microsoft.Compute/diskAccesses, Microsoft.ContainerRegistry/registries, Microsoft.ContainerService/managedClusters, Microsoft.Databricks/workspaces, Microsoft.DataFactory/factories, Microsoft.DBforMariaDB/servers, Microsoft.DBforMySQL/servers, Microsoft.DBforPostgreSQL/servers, Microsoft.DesktopVirtualization/hostpools, Microsoft.DesktopVirtualization/workspaces, Microsoft.Devices/IotHubs, Microsoft.Devices/ProvisioningServices, Microsoft.DeviceUpdate/accounts, Microsoft.DigitalTwins/digitalTwinsInstances, Microsoft.DocumentDB/databaseAccounts, Microsoft.EventGrid/topics, Microsoft.EventGrid/domains, Microsoft.EventHub/namespaces, Microsoft.HardwareSecurityModules/cloudHsmClusters, Microsoft.HealthcareApis/services, Microsoft.HDInsight/clusters, Microsoft.HybridCompute/privateLinkScopes, Microsoft.Insights/privateLinkScopes, Microsoft.KeyVault/vaults, Microsoft.Keyvault/managedHSMs, Microsoft.MachineLearningServices/workspaces, Microsoft.MachineLearningServices/registries, Microsoft.Media/mediaservices, Microsoft.Media/videoanalyzers, Microsoft.Migrate/assessmentProjects, Microsoft.Migrate/migrateProjects, Microsoft.Monitor/accounts, Microsoft.Network/applicationgateways, Microsoft.Network/privateLinkServices, Microsoft.OffAzure/masterSites, Microsoft.PowerBI/privateLinkServicesForPowerBI, Microsoft.Purview/accounts, Microsoft.RecoveryServices/vaults, Microsoft.Relay/namespaces, Microsoft.Search/searchServices, Microsoft.ServiceBus/namespaces, Microsoft.SignalRService/signalr, Microsoft.SignalRService/webPubSub, Microsoft.Sql/servers, Microsoft.Storage/storageAccounts, Microsoft.StorageSync/storageSyncServices, Microsoft.Synapse/privateLinkHubs, Microsoft.Synapse/workspaces, Microsoft.Web/sites, Microsoft.Web/staticSites, Microsoft.Web/hostingEnvironments, Microsoft.BotService/botServices, Microsoft.OpenEnergyPlatform/energyServices, Microsoft.DBforMySQL/flexibleServers + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource manager id of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +The name of service that the private endpoint connection belong to. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateEndpointConnection + +## NOTES + +## RELATED LINKS + +[Approve-AzPrivateEndpointConnection](./Approve-AzPrivateEndpointConnection.md) + +[Deny-AzPrivateEndpointConnection](./Deny-AzPrivateEndpointConnection.md) + +[Remove-AzPrivateEndpointConnection](./Remove-AzPrivateEndpointConnection.md) + +[Set-AzPrivateEndpointConnection](./Set-AzPrivateEndpointConnection.md) diff --git a/azps-10.1.0/Az.Network/Get-AzPrivateLinkResource.md b/azps-10.1.0/Az.Network/Get-AzPrivateLinkResource.md new file mode 100644 index 0000000000..a6a63596ba --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzPrivateLinkResource.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azprivatelinkresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPrivateLinkResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPrivateLinkResource.md +--- + +# Get-AzPrivateLinkResource + +## SYNOPSIS +Gets a private link resource. + +## SYNTAX + +### ByPrivateLinkResourceId (Default) +``` +Get-AzPrivateLinkResource -PrivateLinkResourceId <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResource +``` +Get-AzPrivateLinkResource -ResourceGroupName <String> -ServiceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [-PrivateLinkResourceType <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPrivateLinkResource** cmdlet retrieves all link resources belongs PrivateLinkResource. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzPrivateLinkResource -PrivateLinkResourceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Sql/servers/mySql' +``` + +This example list all private link resources nbelong to sql server named mySql. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The private link resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GroupName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateLinkResourceId +The Azure resource manager id of the private link resource. + +```yaml +Type: System.String +Parameter Sets: ByPrivateLinkResourceId +Aliases: PrivateLinkServiceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateLinkResourceType +The private link resource type. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: +Accepted values: Microsoft.AgFoodPlatform/farmBeats, Microsoft.ApiManagement/service, Microsoft.AppConfiguration/configurationStores, Microsoft.Attestation/attestationProviders, Microsoft.Authorization/resourceManagementPrivateLinks, Microsoft.Automation/automationAccounts, Microsoft.Batch/batchAccounts, Microsoft.Cache/Redis, Microsoft.Cache/redisEnterprise, Microsoft.CognitiveServices/accounts, Microsoft.Compute/diskAccesses, Microsoft.ContainerRegistry/registries, Microsoft.ContainerService/managedClusters, Microsoft.Databricks/workspaces, Microsoft.DataFactory/factories, Microsoft.DBforMariaDB/servers, Microsoft.DBforMySQL/servers, Microsoft.DBforPostgreSQL/servers, Microsoft.DesktopVirtualization/hostpools, Microsoft.DesktopVirtualization/workspaces, Microsoft.Devices/IotHubs, Microsoft.Devices/ProvisioningServices, Microsoft.DeviceUpdate/accounts, Microsoft.DigitalTwins/digitalTwinsInstances, Microsoft.DocumentDB/databaseAccounts, Microsoft.EventGrid/topics, Microsoft.EventGrid/domains, Microsoft.EventHub/namespaces, Microsoft.HardwareSecurityModules/cloudHsmClusters, Microsoft.HealthcareApis/services, Microsoft.HDInsight/clusters, Microsoft.HybridCompute/privateLinkScopes, Microsoft.Insights/privateLinkScopes, Microsoft.KeyVault/vaults, Microsoft.Keyvault/managedHSMs, Microsoft.MachineLearningServices/workspaces, Microsoft.MachineLearningServices/registries, Microsoft.Media/mediaservices, Microsoft.Media/videoanalyzers, Microsoft.Migrate/assessmentProjects, Microsoft.Migrate/migrateProjects, Microsoft.Monitor/accounts, Microsoft.Network/applicationgateways, Microsoft.OffAzure/masterSites, Microsoft.PowerBI/privateLinkServicesForPowerBI, Microsoft.Purview/accounts, Microsoft.RecoveryServices/vaults, Microsoft.Relay/namespaces, Microsoft.Search/searchServices, Microsoft.ServiceBus/namespaces, Microsoft.SignalRService/signalr, Microsoft.SignalRService/webPubSub, Microsoft.Sql/servers, Microsoft.Storage/storageAccounts, Microsoft.StorageSync/storageSyncServices, Microsoft.Synapse/privateLinkHubs, Microsoft.Synapse/workspaces, Microsoft.Web/sites, Microsoft.Web/staticSites, Microsoft.Web/hostingEnvironments, Microsoft.BotService/botServices, Microsoft.OpenEnergyPlatform/energyServices, Microsoft.DBforMySQL/flexibleServers + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +The private link service name. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzPrivateLinkService.md b/azps-10.1.0/Az.Network/Get-AzPrivateLinkService.md new file mode 100644 index 0000000000..45a08c7fcc --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzPrivateLinkService.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azprivatelinkservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPrivateLinkService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPrivateLinkService.md +--- + +# Get-AzPrivateLinkService + +## SYNOPSIS +Gets private link service + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzPrivateLinkService [-Name <String>] [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Expand +``` +Get-AzPrivateLinkService -Name <String> -ResourceGroupName <String> -ExpandResource <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPrivateLinkService** cmdlet gets one or more private link services. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzPrivateLinkService -Name MyPLS -ResourceGroupName TestResourceGroup +``` + +```output +Name : MyPLS +ResourceGroupName : TestResourceGroup +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/prov + iders/Microsoft.Network/privateLinkServices/MyPLS +Location : eastus2euap +Type : Microsoft.Network/privateLinkServices +Etag : W/"00000000-0000-0000-0000-000000000000" +Tag : {} +ProvisioningState : Succeeded +Visibility : +AutoApproval : +Alias : +LoadBalancerFrontendIpConfigurations : [] +IpConfigurations : [ + { + "PrivateIPAddress": "10.0.2.5", + "PrivateIPAllocationMethod": "Static", + "ProvisioningState": "Failed", + "PrivateIPAddressVersion": "IPv4", + "Name": "IP-Config", + "Subnet": { + "Delegations": [], + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ + TestResourceGroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/backendSubne + t", + "ServiceAssociationLinks": [] + } + } + ] +PrivateEndpointConnections : [] +NetworkInterfaces : [ + { + "TapConfigurations": [], + "HostedWorkloads": [], + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/networkInterfaces/mytestinterface" + } + ] +``` + +This commandlet gets a private link service in the resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandResource +The resource reference to be expanded. + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateLinkService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzPublicIpAddress.md b/azps-10.1.0/Az.Network/Get-AzPublicIpAddress.md new file mode 100644 index 0000000000..200116e374 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzPublicIpAddress.md @@ -0,0 +1,330 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 0CD03BF8-8DB6-44BC-91F0-D863949DBD17 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azpublicipaddress +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPublicIpAddress.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPublicIpAddress.md +--- + +# Get-AzPublicIpAddress + +## SYNOPSIS +Gets a public IP address. + +## SYNTAX + +### NoExpandStandAloneIp (Default) +``` +Get-AzPublicIpAddress [-Name <String>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ExpandStandAloneIp +``` +Get-AzPublicIpAddress -Name <String> -ResourceGroupName <String> -ExpandResource <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### NoExpandScaleSetIp +``` +Get-AzPublicIpAddress [-Name <String>] -ResourceGroupName <String> [-VirtualMachineScaleSetName <String>] + [-VirtualMachineIndex <String>] [-NetworkInterfaceName <String>] [-IpConfigurationName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ExpandScaleSetIp +``` +Get-AzPublicIpAddress -Name <String> -ResourceGroupName <String> -VirtualMachineScaleSetName <String> + -VirtualMachineIndex <String> -NetworkInterfaceName <String> -IpConfigurationName <String> + -ExpandResource <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPublicIPAddress** cmdlet gets one or more public IP addresses in a resource group. + +## EXAMPLES + +### Example 1: Get a public IP resource +```powershell +Get-AzPublicIpAddress -Name myPublicIp1 -ResourceGroupName myRg +``` + +```output +Name : myPublicIp1 +ResourceGroupName : myRg +Location : westus2 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/Microsoft + .Network/publicIPAddresses/myPublicIp1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +PublicIpAllocationMethod : Dynamic +IpAddress : Not Assigned +PublicIpAddressVersion : IPv4 +IdleTimeoutInMinutes : 4 +IpConfiguration : { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/ + Microsoft.Network/networkInterfaces/ps-azure-env407/ipConfigurations/ipconfig1" + } +DnsSettings : null +Zones : {} +Sku : { + "Name": "Basic", + "Tier": "Regional" + } +IpTags : [] +``` + +This command gets a public IP address resource with name myPublicIp in the resource group myRg. + +### Example 2: Get public IP resources using filtering +```powershell +Get-AzPublicIpAddress -Name myPublicIp* +``` + +```output +Name : myPublicIp1 +ResourceGroupName : myRg +Location : westus2 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/Microsoft + .Network/publicIPAddresses/myPublicIp1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +PublicIpAllocationMethod : Dynamic +IpAddress : Not Assigned +PublicIpAddressVersion : IPv4 +IdleTimeoutInMinutes : 4 +IpConfiguration : { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/ + Microsoft.Network/networkInterfaces/ps-azure-env407/ipConfigurations/ipconfig1" + } +DnsSettings : null +Zones : {} +Sku : { + "Name": "Basic", + "Tier": "Regional" + } +IpTags : [] +``` + +This command gets all public IP address resources whose name starts with myPublicIp. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandResource +```yaml +Type: System.String +Parameter Sets: ExpandStandAloneIp, ExpandScaleSetIp +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpConfigurationName +Network Interface IP Configuration Name. + +```yaml +Type: System.String +Parameter Sets: NoExpandScaleSetIp +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ExpandScaleSetIp +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the public IP address that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: NoExpandStandAloneIp, NoExpandScaleSetIp +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: ExpandStandAloneIp, ExpandScaleSetIp +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkInterfaceName +Virtual Machine Network Interface Name. + +```yaml +Type: System.String +Parameter Sets: NoExpandScaleSetIp +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ExpandScaleSetIp +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the public IP address that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: NoExpandStandAloneIp +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: ExpandStandAloneIp, NoExpandScaleSetIp, ExpandScaleSetIp +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -VirtualMachineIndex +Virtual Machine Index. + +```yaml +Type: System.String +Parameter Sets: NoExpandScaleSetIp +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ExpandScaleSetIp +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachineScaleSetName +Virtual Machine Scale Set Name. + +```yaml +Type: System.String +Parameter Sets: NoExpandScaleSetIp +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ExpandScaleSetIp +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress + +## NOTES + +## RELATED LINKS + +[New-AzPublicIpAddress](./New-AzPublicIpAddress.md) + +[Remove-AzPublicIpAddress](./Remove-AzPublicIpAddress.md) + +[Set-AzPublicIpAddress](./Set-AzPublicIpAddress.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzPublicIpPrefix.md b/azps-10.1.0/Az.Network/Get-AzPublicIpPrefix.md new file mode 100644 index 0000000000..a3490dfab6 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzPublicIpPrefix.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azpublicipprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPublicIpPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzPublicIpPrefix.md +--- + +# Get-AzPublicIpPrefix + +## SYNOPSIS +Gets a public IP prefix + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzPublicIpPrefix [-Name <String>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzPublicIpPrefix -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPublicIpPrefix** cmdlet gets one or more public IP prefixes in a resource group. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzPublicIpPrefix -ResourceGroupName myRg -Name myPublicIpPrefix1 +``` + +```output +Name : myPublicIpPrefix1 +ResourceGroupName : myRg +Location : westus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/Mic + rosoft.Network/publicIPPrefixes/myPublicIpPrefix1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +PublicIpAddressVersion : IPv4 +PrefixLength : 28 +IPPrefix : xx.xx.xx.xx/xx +IdleTimeoutInMinutes : +Zones : {} +Sku : { + "Name": "Standard", + "Tier":"Regional" + } +IpTags : [] +PublicIpAddresses : [] +``` + +This command gets a public IP prefix resource with myPublicIpPrefix1 in resource group myRg + +### Example 2 +```powershell +Get-AzPublicIpPrefix -Name myPublicIpPrefix* +``` + +```output +Name : myPublicIpPrefix1 +ResourceGroupName : myRg +Location : westus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/Mic + rosoft.Network/publicIPPrefixes/myPublicIpPrefix1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +PublicIpAddressVersion : IPv4 +PrefixLength : 28 +IPPrefix : xx.xx.xx.xx/xx +IdleTimeoutInMinutes : +Zones : {} +Sku : { + "Name": "Standard", + "Tier": "Regional" + } +IpTags : [] +PublicIpAddresses : [] +``` + +This command gets all public IP prefix resources that start with myPublicIpPrefix. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ListParameterSet +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +The resource Id. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix + +## NOTES + +## RELATED LINKS + +[New-AzPublicIpPrefix](./New-AzPublicIpPrefix.md) + +[Remove-AzPublicIpPrefix](./Remove-AzPublicIpPrefix.md) + +[Set-AzPublicIpPrefix](./Set-AzPublicIpPrefix.md) diff --git a/azps-10.1.0/Az.Network/Get-AzRouteConfig.md b/azps-10.1.0/Az.Network/Get-AzRouteConfig.md new file mode 100644 index 0000000000..e2c103e3f7 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzRouteConfig.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: DBD40431-DD7A-42CB-83AA-568B1065A468 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azrouteconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteConfig.md +--- + +# Get-AzRouteConfig + +## SYNOPSIS +Gets routes from a route table. + +## SYNTAX + +``` +Get-AzRouteConfig -RouteTable <PSRouteTable> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRouteConfig** cmdlet gets routes from an Azure route table. +You can specify a route by name. + +## EXAMPLES + +### Example 1: Get a route table +```powershell +Get-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Get-AzRouteConfig -Name "Route07" +``` + +```output +Name : route07 +Id : +Etag : +ProvisioningState : +AddressPrefix : 10.1.0.0/16 +NextHopType : VnetLocal +NextHopIpAddress : +``` + +This command gets the route table named RouteTable01 by using the **Get-AzRouteTable** cmdlet. +The command passes that table to the current cmdlet by using the pipeline operator. +The current cmdlet gets the route named Route07 in the route table named RouteTable01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the route that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteTable +Specifies the route table from which this cmdlet gets routes. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRoute + +## NOTES + +## RELATED LINKS + +[Add-AzRouteConfig](./Add-AzRouteConfig.md) + +[Get-AzRouteTable](./Get-AzRouteTable.md) + +[New-AzRouteConfig](./New-AzRouteConfig.md) + +[Remove-AzRouteConfig](./Remove-AzRouteConfig.md) + +[Set-AzRouteConfig](./Set-AzRouteConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzRouteFilter.md b/azps-10.1.0/Az.Network/Get-AzRouteFilter.md new file mode 100644 index 0000000000..e91f81eb85 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzRouteFilter.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azroutefilter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteFilter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteFilter.md +--- + +# Get-AzRouteFilter + +## SYNOPSIS +Gets a route filter. + +## SYNTAX + +### NoExpand +``` +Get-AzRouteFilter [-Name <String>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### Expand +``` +Get-AzRouteFilter -Name <String> -ResourceGroupName <String> -ExpandResource <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRouteFilter** cmdlet gets a route filter. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRouteFilter -Name "RouteFilter01" -ResourceGroupName "ResourceGroup01" +``` + +```output +Name : RouteFilter01 +ResourceGroupName : ResourceGroup01 +Location : westus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsof + t.Network/routeFilters/RouteFilter01 +Etag : W/"00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +Tags : +Rules : [] +Peerings : [] +``` + +This command gets the route filter named RouteFilter01 that belongs to the resource group named ResourceGroup01. + +### Example 2 +```powershell +Get-AzRouteFilter -Name "RouteFilter*" +``` + +```output +Name : RouteFilter01 +ResourceGroupName : ResourceGroup01 +Location : westus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsof + t.Network/routeFilters/RouteFilter01 +Etag : W/"00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +Tags : +Rules : [] +Peerings : [] + +Name : RouteFilter02 +ResourceGroupName : ResourceGroup01 +Location : westus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsof + t.Network/routeFilters/RouteFilter02 +Etag : W/"00000000-0000-0000-0000-000000000000" +ProvisioningState : Succeeded +Tags : +Rules : [] +Peerings : [] +``` + +This command gets all route filters that start with "RouteFilter". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandResource +The resource reference to be expanded. + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilter + +## NOTES + +## RELATED LINKS + +[New-AzRouteFilter](./New-AzRouteFilter.md) + +[Remove-AzRouteFilter](./Remove-AzRouteFilter.md) + +[Set-AzRouteFilter](./Set-AzRouteFilter.md) + +[Add-AzRouteFilterRuleConfig](./Add-AzRouteFilterRuleConfig.md) + +[Get-AzRouteFilterRuleConfig](./Get-AzRouteFilterRuleConfig.md) + +[New-AzRouteFilterRuleConfig](./New-AzRouteFilterRuleConfig.md) + +[Remove-AzRouteFilterRuleConfig](./Remove-AzRouteFilterRuleConfig.md) + +[Set-AzRouteFilterRuleConfig](./Set-AzRouteFilterRuleConfig.md) diff --git a/azps-10.1.0/Az.Network/Get-AzRouteFilterRuleConfig.md b/azps-10.1.0/Az.Network/Get-AzRouteFilterRuleConfig.md new file mode 100644 index 0000000000..a188977ad3 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzRouteFilterRuleConfig.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azroutefilterruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteFilterRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteFilterRuleConfig.md +--- + +# Get-AzRouteFilterRuleConfig + +## SYNOPSIS +Gets a route filter rule in a route filter. + +## SYNTAX + +``` +Get-AzRouteFilterRuleConfig [-Name <String>] -RouteFilter <PSRouteFilter> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRouteFilterRuleConfig** cmdlet gets a route filter rule or a list of route filter rules in a route filter. + +## EXAMPLES + +### Example 1 +```powershell +$rf = Get-AzRouteFilter -Name "MyRouteFilter" -ResourceGroupName "MyResourceGroup" +Get-AzRouteFilterRuleConfig -RouteFilter $rf -Name "Rule01" +Get-AzRouteFilterRuleConfig -RouteFilter $rf +``` + +The first command gets the route filter named MyRouteFilter, and then stores it in the variable $rf. +The second command gets the route filter rule named Rule01 associated with that route filter. +The third command gets a list of route filter rules associated with that route filter. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the route filter rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteFilter +The RouteFilter + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilter + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule + +## NOTES + +## RELATED LINKS + +[Add-AzRouteFilterRuleConfig](./Add-AzRouteFilterRuleConfig.md) + +[New-AzRouteFilterRuleConfig](./New-AzRouteFilterRuleConfig.md) + +[Remove-AzRouteFilterRuleConfig](./Remove-AzRouteFilterRuleConfig.md) + +[Set-AzRouteFilterRuleConfig](./Set-AzRouteFilterRuleConfig.md) + +[Get-AzRouteFilter](./Get-AzRouteFilter.md) + +[New-AzRouteFilter](./New-AzRouteFilter.md) + +[Remove-AzRouteFilter](./Remove-AzRouteFilter.md) + +[Set-AzRouteFilter](./Set-AzRouteFilter.md) diff --git a/azps-10.1.0/Az.Network/Get-AzRouteMap.md b/azps-10.1.0/Az.Network/Get-AzRouteMap.md new file mode 100644 index 0000000000..25c9337e7c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzRouteMap.md @@ -0,0 +1,236 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azroutemap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteMap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteMap.md +--- + +# Get-AzRouteMap + +## SYNOPSIS +Retrieves a route map of a VirtualHub. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +Get-AzRouteMap [-ResourceGroupName <String>] [-VirtualHubName <String>] [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Get-AzRouteMap [-VirtualHubObject <PSVirtualHub>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +Get-AzRouteMap [-VirtualHubResourceId <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the route map from a VirtualHub. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" + +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" + +# creating new route map rules and a new route map resource and new routing configuration +$routeMapMatchCriterion1 = New-AzRouteMapRuleCriterion -MatchCondition "Contains" -RoutePrefix @("10.0.0.0/16") +$routeMapActionParameter1 = New-AzRouteMapRuleActionParameter -AsPath @("12345") +$routeMapAction1 = New-AzRouteMapRuleAction -Type "Add" -Parameter @($routeMapActionParameter1) +$routeMapRule1 = New-AzRouteMapRule -Name "rule1" -MatchCriteria @($routeMapMatchCriterion1) -RouteMapRuleAction @($routeMapAction1) -NextStepIfMatched "Continue" + +$routeMapMatchCriterion2 = New-AzRouteMapRuleCriterion -MatchCondition "Equals" -AsPath @("12345") +$routeMapAction2 = New-AzRouteMapRuleAction -Type "Drop" +$routeMapRule2 = New-AzRouteMapRule -Name "rule2" -MatchCriteria @($routeMapMatchCriterion2) -RouteMapRuleAction @($routeMapAction2) -NextStepIfMatched "Terminate" + +New-AzRouteMap -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteMap" -RouteMapRule @($routeMapRule1, $routeMapRule2) +Get-AzRouteMap -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteMap" +``` + +```output +Name : testRouteMap +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/routemap0419/providers/Microsoft.Network/virtualHubs/westcentralus_hub1/routeMaps/testRouteMap +ProvisioningState : Succeeded +RouteMapRules : [ + { + "Name": "rule1", + "MatchCriteria": [ + { + "MatchCondition": "Contains", + "RoutePrefix": [ + "10.0.0.0/16" + ], + "Community": [], + "AsPath": [] + } + ], + "Actions": [ + { + "Type": "Add", + "Parameters": [ + { + "RoutePrefix": [], + "Community": [], + "AsPath": [ + "12345" + ] + } + ] + } + ], + "NextStepIfMatched": "Continue" + }, + { + "Name": "rule2", + "MatchCriteria": [ + { + "MatchCondition": "Equals", + "RoutePrefix": [], + "Community": [], + "AsPath": [ + "12345" + ] + } + ], + "Actions": [ + { + "Type": "Drop", + "Parameters": [] + } + ], + "NextStepIfMatched": "Terminate" + } + ] +AssociatedInboundConnections : [] +AssociatedOutboundConnections : [] +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The route map name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, RouteMapName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubName +The Virtual Hub name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: ParentVirtualHubName, ParentResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubObject +The Virtual Hub Object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: ParentObject, ParentVirtualHub + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubResourceId +The Virtual Hub Resource Id. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId, ParentVirtualHubId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteMap + +## NOTES + +## RELATED LINKS + +[New-AzRouteMap](./New-AzRouteMap.md) + +[New-AzRouteMapRule](./New-AzRouteMapRule.md) + +[Update-AzRouteMap](./Update-AzRouteMap.md) + +[Remove-AzRouteMap](./Remove-AzRouteMap.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzRouteServer.md b/azps-10.1.0/Az.Network/Get-AzRouteServer.md new file mode 100644 index 0000000000..47db465246 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzRouteServer.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azrouteserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteServer.md +--- + +# Get-AzRouteServer + +## SYNOPSIS +Get an Azure RouteServer + +## SYNTAX + +### RouteServerSubscriptionIdParameterSet (Default) +``` +Get-AzRouteServer [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RouteServerNameParameterSet +``` +Get-AzRouteServer -ResourceGroupName <String> [-RouteServerName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RouteServerResourceIdParameterSet +``` +Get-AzRouteServer -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRouteServer** cmdlet gets an Azure RouteServer + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRouteServer -ResourceGroupName routeServerRG -RouteServerName routeServer +``` + +### Example 2 +```powershell +$routeServerId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/routeServerRG/providers/Microsoft.Network/virtualHubs/routeServer' +Get-AzRouteServer -ResourceId $routeServerId +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the route server. + +```yaml +Type: System.String +Parameter Sets: RouteServerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +ResourceId of the route server. + +```yaml +Type: System.String +Parameter Sets: RouteServerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteServerName +The name of the route server. + +```yaml +Type: System.String +Parameter Sets: RouteServerNameParameterSet +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteServer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzRouteServerPeer.md b/azps-10.1.0/Az.Network/Get-AzRouteServerPeer.md new file mode 100644 index 0000000000..f37cafe0f1 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzRouteServerPeer.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azrouteserverpeer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteServerPeer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteServerPeer.md +--- + +# Get-AzRouteServerPeer + +## SYNOPSIS +Gets a RouteServer peer in an Azure RouteServer + +## SYNTAX + +### RouteServerNPeerNameParameterSet (Default) +``` +Get-AzRouteServerPeer -ResourceGroupName <String> -PeerName <String> -RouteServerName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RouteServerNPeerResourceIdParameterSet +``` +Get-AzRouteServerPeer -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRouteServerPeer** cmdlet gets a Peer in an Azure RouteServer + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRouteServerPeer -ResourceGroupName routeServerRG -RouteServerName routeServer -PeerName peer +``` + +### Example 2 +```powershell +$routeServerPeerId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/routeServerRG/providers/Microsoft.Network/virtualHubs/routeServer/bgpConnections/peer' +Get-AzRouteServerPeer -ResourceId $routeServerPeerId +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerName +The name of the route server peer. + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name of the route server. + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +ResourceId of the route server peer. + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteServerName +The name of the route server. + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteServerPeer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzRouteServerPeerAdvertisedRoute.md b/azps-10.1.0/Az.Network/Get-AzRouteServerPeerAdvertisedRoute.md new file mode 100644 index 0000000000..33d673bcbc --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzRouteServerPeerAdvertisedRoute.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azrouteserverpeeradvertisedroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteServerPeerAdvertisedRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteServerPeerAdvertisedRoute.md +--- + +# Get-AzRouteServerPeerAdvertisedRoute + +## SYNOPSIS +List routes being advertised by specific route server peer + +## SYNTAX + +### RouteServerNPeerNameParameterSet (Default) +``` +Get-AzRouteServerPeerAdvertisedRoute -ResourceGroupName <String> -RouteServerName <String> -PeerName <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RouteServerNPeerInputObjectParameterSet +``` +Get-AzRouteServerPeerAdvertisedRoute -InputObject <PSRouteServerPeer> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Given A route server peer either by name or by object, enumerate routes being advertised to that peer by a specific route server. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRouteServerPeerAdvertisedRoute -ResourceGroupName $resourceGroupName -RouteServerName $routeServerName -PeerName $peerName +``` + +### Example 2 +```powershell +$routeServerPeer = Get-AzRouteServerPeer -ResourceGroupName $resourceGroupName -RouteServerName $routeServerName -PeerName $peerName +Get-AzRouteServerPeerAdvertisedRoute -InputObject $routeServerPeer +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The route server peer input object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteServerPeer +Parameter Sets: RouteServerNPeerInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PeerName +Route server peer name + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Route server peer resource group's name + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteServerName +Route Server name + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSRouteServerPeer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPeerRoute + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzRouteServerPeerLearnedRoute.md b/azps-10.1.0/Az.Network/Get-AzRouteServerPeerLearnedRoute.md new file mode 100644 index 0000000000..235419dac6 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzRouteServerPeerLearnedRoute.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azrouteserverpeerlearnedroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteServerPeerLearnedRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteServerPeerLearnedRoute.md +--- + +# Get-AzRouteServerPeerLearnedRoute + +## SYNOPSIS +List routes learned by a specific route server peer + +## SYNTAX + +### RouteServerNPeerNameParameterSet (Default) +``` +Get-AzRouteServerPeerLearnedRoute -ResourceGroupName <String> -RouteServerName <String> -PeerName <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RouteServerNPeerInputObjectParameterSet +``` +Get-AzRouteServerPeerLearnedRoute -InputObject <PSRouteServerPeer> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Enumerate routes learned by a route server peer from other sources. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRouteServerPeerLearnedRoute -ResourceGroupName $resourceGroupName -RouteServerName $routeServerName -PeerName $peerName +``` + +### Example 2 +```powershell +$routerServerPeer = Get-AzRouteServerPeer -ResourceGroupName $resourceGroupName -RouteServerName $routeServerName -PeerName $peerName +Get-AzRouteServerPeerLearnedRoute -InputObject $routerServerPeer +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The route server peer input object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteServerPeer +Parameter Sets: RouteServerNPeerInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PeerName +Route server peer name + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Route server peer resource group's name + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteServerName +Route server name + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSRouteServerPeer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPeerRoute + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzRouteTable.md b/azps-10.1.0/Az.Network/Get-AzRouteTable.md new file mode 100644 index 0000000000..0fc69400d5 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzRouteTable.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 4F487FCA-930D-4D56-8D28-7693312E1A01 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRouteTable.md +--- + +# Get-AzRouteTable + +## SYNOPSIS +Gets route tables. + +## SYNTAX + +### NoExpand (Default) +``` +Get-AzRouteTable [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### Expand +``` +Get-AzRouteTable -ResourceGroupName <String> -Name <String> -ExpandResource <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRouteTable** cmdlet gets Azure route tables. +You can get a single route table, or get all the route tables in a resource group or in your subscription. + +## EXAMPLES + +### Example 1: Get a route table +```powershell +Get-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" +``` + +```output +Name : routetable01 +ResourceGroupName : ResourceGroup11 +Location : eastus +Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ + k/routeTables/routetable01 +Etag : W/"db5f4e12-3f34-465b-92dd-0ab3bf6fc274" +ProvisioningState : Succeeded +Tags : +Routes : [ + { + "Name": "route07", + "Etag": "W/\"db5f4e12-3f34-465b-92dd-0ab3bf6fc274\"", + "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro + soft.Network/routeTables/routetable01/routes/route07", + "AddressPrefix": "10.1.0.0/16", + "NextHopType": "VnetLocal", + "NextHopIpAddress": null, + "ProvisioningState": "Succeeded" + } + ] +Subnets : [] +``` + +This command gets the route table named RouteTable01 in the resource group named ResourceGroup11. + +### Example 2: List route tables using filtering +```powershell +Get-AzRouteTable -Name RouteTable* +``` + +```output +Name : routetable01 +ResourceGroupName : ResourceGroup11 +Location : eastus +Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ + k/routeTables/routetable01 +Etag : W/"db5f4e12-3f34-465b-92dd-0ab3bf6fc274" +ProvisioningState : Succeeded +Tags : +Routes : [ + { + "Name": "route07", + "Etag": "W/\"db5f4e12-3f34-465b-92dd-0ab3bf6fc274\"", + "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro + soft.Network/routeTables/routetable01/routes/route07", + "AddressPrefix": "10.1.0.0/16", + "NextHopType": "VnetLocal", + "NextHopIpAddress": null, + "ProvisioningState": "Succeeded" + } + ] +Subnets : [] + +Name : routetable02 +ResourceGroupName : ResourceGroup11 +Location : eastus +Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ + k/routeTables/routetable02 +Etag : W/"db5f4e12-3f34-465b-92dd-0ab3bf6fc274" +ProvisioningState : Succeeded +Tags : +Routes : [ + { + "Name": "route07", + "Etag": "W/\"db5f4e12-3f34-465b-92dd-0ab3bf6fc274\"", + "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro + soft.Network/routeTables/routetable02/routes/route07", + "AddressPrefix": "10.1.0.0/16", + "NextHopType": "VnetLocal", + "NextHopIpAddress": null, + "ProvisioningState": "Succeeded" + } + ] +Subnets : [] +``` + +This command gets all route tables whose name starts with "RouteTable" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandResource +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the route table that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the route tables that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +## NOTES + +## RELATED LINKS + +[New-AzRouteTable](./New-AzRouteTable.md) + +[Remove-AzRouteTable](./Remove-AzRouteTable.md) + +[Set-AzRouteTable](./Set-AzRouteTable.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzRoutingIntent.md b/azps-10.1.0/Az.Network/Get-AzRoutingIntent.md new file mode 100644 index 0000000000..c5eb6b8c45 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzRoutingIntent.md @@ -0,0 +1,245 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azroutingintent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRoutingIntent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRoutingIntent.md +--- + +# Get-AzRoutingIntent + +## SYNOPSIS +Retrieves a routing intent resource associated with a VirtualHub. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +Get-AzRoutingIntent -ResourceGroupName <String> -HubName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Get-AzRoutingIntent -VirtualHub <PSVirtualHub> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +Get-AzRoutingIntent -ParentResourceId <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the specified routing intent that is associated with the specified virtual hub. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" + +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" + +$fwIp = New-AzFirewallHubPublicIpAddress -Count 1 +$hubIpAddresses = New-AzFirewallHubIpAddress -PublicIP $fwIp + +New-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" -Location "westcentralus" -Sku AZFW_Hub -VirtualHubId $virtualHub.Id -HubIPAddress $hubIpAddresses +$firewall = Get-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" + +$policy1 = New-AzRoutingPolicy -Name "PrivateTraffic" -Destination @("PrivateTraffic") -NextHop $firewall.Id +$policy2 = New-AzRoutingPolicy -Name "PublicTraffic" -Destination @("Internet") -NextHop $firewall.Id + +New-AzRoutingIntent -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRoutingIntent" -RoutingPolicy @($policy1, $policy2) +Get-AzRoutingIntent -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRoutingIntent" +``` + +```output +ProvisioningState : Succeeded +RoutingPolicies : {PrivateTraffic, PublicTraffic} +RoutingPoliciesText : [ + { + "Name": "PrivateTraffic", + "DestinationType": "TrafficType", + "Destinations": [ + "PrivateTraffic" + ], + "NextHopType": "ResourceId", + "NextHop": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall" + }, + { + "Name": "PublicTraffic", + "DestinationType": "TrafficType", + "Destinations": [ + "Internet" + ], + "NextHopType": "ResourceId", + "NextHop": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall" + } + ] +Name : testRoutingIntent +Etag : W/"etag" +Id : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/routingIntent/testRoutingIntent +``` + +This command gets the routing intent of the virtual hub. + +### Example 2 + +```powershell +$rgName = "testRg" +$virtualHubName = "testHub" +Get-AzRoutingIntent -Name $riName -VirtualHub $virtualHub +``` + +```output +ProvisioningState : Succeeded +RoutingPolicies : {PrivateTraffic, PublicTraffic} +RoutingPoliciesText : [ + { + "Name": "PrivateTraffic", + "DestinationType": "TrafficType", + "Destinations": [ + "PrivateTraffic" + ], + "NextHopType": "ResourceId", + "NextHop": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall" + }, + { + "Name": "PublicTraffic", + "DestinationType": "TrafficType", + "Destinations": [ + "Internet" + ], + "NextHopType": "ResourceId", + "NextHop": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall" + } + ] +Name : testRoutingIntent +Etag : W/"etag" +Id : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/routingIntent/testRoutingIntent +``` + +This command get the routing intent in the specified VirtualHub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: VirtualHubName, ParentVirtualHubName, ParentResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, RoutingIntentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ParentResourceId +The parent resource id. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId, ParentVirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The parent resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: ParentObject, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRoutingIntent + +## NOTES + +## RELATED LINKS + +[New-AzVHubRoute](./New-AzVHubRoute.md) + +[New-AzRoutingIntent](./New-AzRoutingIntent.md) + +[Set-AzRoutingIntent](./Set-AzRoutingIntent.md) + +[Remove-AzRoutingIntent](./Remove-AzRoutingIntent.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzRoutingPolicy.md b/azps-10.1.0/Az.Network/Get-AzRoutingPolicy.md new file mode 100644 index 0000000000..2060ae7688 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzRoutingPolicy.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azroutingpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRoutingPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzRoutingPolicy.md +--- + +# Get-AzRoutingPolicy + +## SYNOPSIS +Retrieves a routing policy of a routing intent resource associated with a VirtualHub. + +## SYNTAX + +``` +Get-AzRoutingPolicy -RoutingIntent <PSRoutingIntent> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the specified routing Policy that is associated with the specified routing intent resource. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" + +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" + +$fwIp = New-AzFirewallHubPublicIpAddress -Count 1 +$hubIpAddresses = New-AzFirewallHubIpAddress -PublicIP $fwIp + +New-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" -Location "westcentralus" -Sku AZFW_Hub -VirtualHubId $virtualHub.Id -HubIPAddress $hubIpAddresses +$firewall = Get-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" + +$policy1 = New-AzRoutingPolicy -Name "PrivateTraffic" -Destination @("PrivateTraffic") -NextHop $firewall.Id +New-AzRoutingIntent -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRoutingIntent" -RoutingPolicy @($policy1) + +$routingIntent = Get-AzRoutingIntent -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRoutingIntent" +Get-AzRoutingPolicy -RoutingIntent $routingIntent -Name "PrivateTraffic" +``` + +```output +Name : PrivateTraffic +DestinationType : TrafficType +Destinations : {PrivateTraffic} +NextHopType : ResourceId +NextHop : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The policy name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingIntent +The routing intent resource to which this rouing policy has to be added. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingIntent +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRoutingIntent + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRoutingPolicy + +## NOTES + +## RELATED LINKS + +[New-AzRoutingPolicy](./New-AzRoutingPolicy.md) + +[New-AzRoutingPolicy](./New-AzRoutingPolicy.md) + +[Set-AzRoutingPolicy](./Set-AzRoutingPolicy.md) + +[Remove-AzRoutingPolicy](./Remove-AzRoutingPolicy.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzSecurityPartnerProvider.md b/azps-10.1.0/Az.Network/Get-AzSecurityPartnerProvider.md new file mode 100644 index 0000000000..290baa384b --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzSecurityPartnerProvider.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azsecuritypartnerprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzSecurityPartnerProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzSecurityPartnerProvider.md +--- + +# Get-AzSecurityPartnerProvider + +## SYNOPSIS +Get an Azure SecurityPartnerProvider + +## SYNTAX + +### SecurityPartnerProviderNameParameterSet (Default) +``` +Get-AzSecurityPartnerProvider -Name <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SecurityPartnerProviderResourceIdParameterSet +``` +Get-AzSecurityPartnerProvider -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSecurityPartnerProvider** cmdlet gets an Azure SecurityPartnerProvider + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityPartnerProvider -ResourceGroupName securityPartnerProviderRG -Name securityPartnerProvider +``` + +### Example 2 +```powershell +$securityPartnerProviderId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/securityPartnerProviderRG/providers/Microsoft.Network/securityPartnerProvider/securityPartnerProvider' +Get-AzSecurityPartnerProvider -ResourceId $securityPartnerProviderId +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: SecurityPartnerProviderNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: SecurityPartnerProviderNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +The resource Id. + +```yaml +Type: System.String +Parameter Sets: SecurityPartnerProviderResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSSecurityPartnerProvider + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzServiceEndpointPolicy.md b/azps-10.1.0/Az.Network/Get-AzServiceEndpointPolicy.md new file mode 100644 index 0000000000..97c049a784 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzServiceEndpointPolicy.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azserviceendpointpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzServiceEndpointPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzServiceEndpointPolicy.md +--- + +# Get-AzServiceEndpointPolicy + +## SYNOPSIS +Gets a service endpoint policy. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzServiceEndpointPolicy [-Name <String>] [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzServiceEndpointPolicy -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzServiceEndpointPolicy** cmdlet gets a service endpoint policy. + +## EXAMPLES + +### Example 1 +```powershell +$policy = Get-AzServiceEndpointPolicy -Name "ServiceEndpointPolicy1" -ResourceGroupName "ResourceGroup01" +``` + +This command gets the service endpoint policy named ServiceEndpointPolicy1 that belongs to the resource group named ResourceGroup01 and stores it in the $policy variable. + +### Example 2 +```powershell +$policyList = Get-AzServiceEndpointPolicy -ResourceGroupName "ResourceGroup01" +``` + +This command gets a list of all the service endpoint policies in the resource group named ResourceGroup01 and stores it in the $policyList variable. + +### Example 3 +```powershell +$policyList = Get-AzServiceEndpointPolicy -ResourceGroupName "ServiceEndpointPolicy*" +``` + +This command gets a list of all the service endpoint policies that start with "ServiceEndpointPolicy". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service endpoint policy + +```yaml +Type: System.String +Parameter Sets: ListParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +The ID of the service endpoint policy. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy + +## NOTES + +## RELATED LINKS + +[New-AzServiceEndpointPolicy](./New-AzServiceEndpointPolicy.md) + +[Remove-AzServiceEndpointPolicy](./Remove-AzServiceEndpointPolicy.md) + +[Set-AzServiceEndpointPolicy](./Set-AzServiceEndpointPolicy.md) diff --git a/azps-10.1.0/Az.Network/Get-AzServiceEndpointPolicyDefinition.md b/azps-10.1.0/Az.Network/Get-AzServiceEndpointPolicyDefinition.md new file mode 100644 index 0000000000..ff4241e5d0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzServiceEndpointPolicyDefinition.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azserviceendpointpolicydefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzServiceEndpointPolicyDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzServiceEndpointPolicyDefinition.md +--- + +# Get-AzServiceEndpointPolicyDefinition + +## SYNOPSIS +Gets a service endpoint policy definition. + +## SYNTAX + +``` +Get-AzServiceEndpointPolicyDefinition [-Name <String>] -ServiceEndpointPolicy <PSServiceEndpointPolicy> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzServiceEndpointPolicyDefinition** cmdlet gets a service endpoint policy definition. + +## EXAMPLES + +### Example 1 +```powershell +$policydef= Get-AzServiceEndpointPolicyDefinition -Name "ServiceEndpointPolicyDefinition1" -ServiceEndpointPolicy $Policy +``` + +This command gets the service endpoint policy definition named ServiceEndpointPolicyDefinition1 in ServiceEndpointPolicy $Policy stores it in the $policydef variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service endpoint policy definition + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceEndpointPolicy +The Service endpoint policy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicyDefinition + +## NOTES + +## RELATED LINKS + +[Add-AzServiceEndpointPolicyDefinition](./Add-AzServiceEndpointPolicyDefinition.md) + +[New-AzServiceEndpointPolicyDefinition](./New-AzServiceEndpointPolicyDefinition.md) + +[Remove-AzServiceEndpointPolicyDefinition](./Remove-AzServiceEndpointPolicyDefinition.md) + +[Set-AzServiceEndpointPolicyDefinition](./Set-AzServiceEndpointPolicyDefinition.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVHubEffectiveRoute.md b/azps-10.1.0/Az.Network/Get-AzVHubEffectiveRoute.md new file mode 100644 index 0000000000..26f880e64e --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVHubEffectiveRoute.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azVHubEffectiveRoute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVHubEffectiveRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVHubEffectiveRoute.md +--- + +# Get-AzVHubEffectiveRoute + +## SYNOPSIS +Retrieves the effective routes of a virtual hub resource + +## SYNTAX + +### ByVirtualHubName (Default) +``` +Get-AzVHubEffectiveRoute -ResourceGroupName <String> -VirtualHubName <String> [-ResourceId <String>] + [-VirtualWanResourceType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Get-AzVHubEffectiveRoute -VirtualHubObject <PSVirtualHub> [-ResourceId <String>] + [-VirtualWanResourceType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +Get-AzVHubEffectiveRoute -VirtualHubResourceId <String> [-ResourceId <String>] + [-VirtualWanResourceType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the effective routes of the given virtual hub resource + +## EXAMPLES + +### Example 1 + +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" +$hubRouteTableId = "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/hubRouteTables/defaultRouteTable" +Get-AzVHubEffectiveRoute -VirtualHubObject $virtualHub -ResourceId $hubRouteTableId -VirtualWanResourceType "RouteTable" +``` + +```output +Value : [ + { + "AddressPrefixes": [ + "10.2.0.0/16" + ], + "NextHops": [ + "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtu + alHubs/testHub/hubVirtualNetworkConnections/testConnection" + ], + "NextHopType": "Virtual Network Connection", + "RouteOrigin": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft. + Network/virtualHubs/testHub/hubVirtualNetworkConnections/testConnection" + } + ] +``` + +This command gets the effective routes of the virtual hub default route table. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of a virtual wan resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubName +The virtual hub resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: ParentVirtualHubName, ParentResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubObject +The parent resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: ParentObject, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubResourceId +The virtual hub resource id. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId, ParentVirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualWanResourceType +The virtual wan resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHubEffectiveRouteList + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVHubInboundRoute.md b/azps-10.1.0/Az.Network/Get-AzVHubInboundRoute.md new file mode 100644 index 0000000000..ea1b6aab57 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVHubInboundRoute.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azVHubInboundRoute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVHubInboundRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVHubInboundRoute.md +--- + +# Get-AzVHubInboundRoute + +## SYNOPSIS +Retrieves the inbound routes of a virtual hub connection + +## SYNTAX + +### ByVirtualHubName (Default) +``` +Get-AzVHubInboundRoute -ResourceGroupName <String> -VirtualHubName <String> [-ResourceUri <String>] + [-VirtualWanConnectionType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Get-AzVHubInboundRoute -VirtualHubObject <PSVirtualHub> [-ResourceUri <String>] + [-VirtualWanConnectionType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +Get-AzVHubInboundRoute -VirtualHubResourceId <String> [-ResourceUri <String>] + [-VirtualWanConnectionType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the inbound routes of the given virtual hub connection + +## EXAMPLES + +### Example 1 + +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" +$hubVnetConnectionId = "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/hubVirtualNetworkConnections/testCon" +Get-AzVHubInboundRoute -VirtualHubObject $virtualHub -ResourceUri $hubVnetConnectionId -VirtualWanConnectionType "HubVirtualNetworkConnection" +``` + +```output +Value : [ + { + "Prefix": "10.2.0.0/16", + "BgpCommunities": "4293853166", + "AsPath": "" + } + ] +``` + +This command gets the inbound routes of the virtual hub spoke vnet connection. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The resource uri of a virtual wan connection resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubName +The virtual hub resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: ParentVirtualHubName, ParentResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubObject +The parent resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: ParentObject, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubResourceId +The virtual hub resource id. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId, ParentVirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualWanConnectionType +The virtual wan connection type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHubEffectiveRouteMapRouteList + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVHubOutboundRoute.md b/azps-10.1.0/Az.Network/Get-AzVHubOutboundRoute.md new file mode 100644 index 0000000000..e5e6ce179b --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVHubOutboundRoute.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azVHubOutboundRoute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVHubOutboundRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVHubOutboundRoute.md +--- + +# Get-AzVHubOutboundRoute + +## SYNOPSIS +Retrieves the outbound routes of a virtual hub connection + +## SYNTAX + +### ByVirtualHubName (Default) +``` +Get-AzVHubOutboundRoute -ResourceGroupName <String> -VirtualHubName <String> [-ResourceUri <String>] + [-VirtualWanConnectionType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Get-AzVHubOutboundRoute -VirtualHubObject <PSVirtualHub> [-ResourceUri <String>] + [-VirtualWanConnectionType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +Get-AzVHubOutboundRoute -VirtualHubResourceId <String> [-ResourceUri <String>] + [-VirtualWanConnectionType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the outbound routes of the given virtual hub connection + +## EXAMPLES + +### Example 1 + +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" +$hubVnetConnectionId = "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/hubVirtualNetworkConnections/testCon" +Get-AzVHubOutboundRoute -VirtualHubObject $virtualHub -ResourceUri $hubVnetConnectionId -VirtualWanConnectionType "HubVirtualNetworkConnection" +``` + +```output +Value : [ + { + "Prefix": "10.2.0.0/16", + "BgpCommunities": "4293853166", + "AsPath": "" + } + ] +``` + +This command gets the outbound routes of the virtual hub spoke vnet connection. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The resource uri of a virtual wan connection resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubName +The virtual hub resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: ParentVirtualHubName, ParentResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubObject +The parent resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: ParentObject, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubResourceId +The virtual hub resource id. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId, ParentVirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualWanConnectionType +The virtual wan connection type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHubEffectiveRouteMapRouteList + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVHubRouteTable.md b/azps-10.1.0/Az.Network/Get-AzVHubRouteTable.md new file mode 100644 index 0000000000..2da1817612 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVHubRouteTable.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvhubroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVHubRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVHubRouteTable.md +--- + +# Get-AzVHubRouteTable + +## SYNOPSIS +Retrieves a hub route table resource associated with a VirtualHub. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +Get-AzVHubRouteTable -ResourceGroupName <String> -HubName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Get-AzVHubRouteTable -VirtualHub <PSVirtualHub> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +Get-AzVHubRouteTable -ParentResourceId <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the specified hub route table that is associated with the specified virtual hub. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" +$fwIp = New-AzFirewallHubPublicIpAddress -Count 1 +$hubIpAddresses = New-AzFirewallHubIpAddress -PublicIP $fwIp +New-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" -Location "westcentralus" -Sku AZFW_Hub -VirtualHubId $virtualHub.Id -HubIPAddress $hubIpAddresses +$firewall = Get-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" +$route1 = New-AzVHubRoute -Name "private-traffic" -Destination @("10.30.0.0/16", "10.40.0.0/16") -DestinationType "CIDR" -NextHop $firewall.Id -NextHopType "ResourceId" +New-AzVHubRouteTable -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteTable" -Route @($route1) -Label @("testLabel") +Get-AzVHubRouteTable -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteTable" +``` + +```output +Name : testRouteTable +Id : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/hubRouteTables/testRouteTable +ProvisioningState : Succeeded +Labels : {testLabel} +Routes : [ + { + "Name": "private-traffic", + "DestinationType": "CIDR", + "Destinations": [ + "10.30.0.0/16", + "10.40.0.0/16" + ], + "NextHopType": "ResourceId", + "NextHop": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall" + } + ] +AssociatedConnections : [] +PropagatingConnections : [] +``` + +This command gets the hub route table of the virtual hub. + +### Example 2 + +```powershell +$rgName = "testRg" +$virtualHubName = "testHub" +Get-AzVHubRouteTable -ResourceGroupName $rgName -VirtualHubName $virtualHubName +``` + +```output +Name : defaultRouteTable +Id : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/hubRouteTables/defaultRouteTable +ProvisioningState : Succeeded +Labels : {testLabel} +Routes : [] +AssociatedConnections : [] +PropagatingConnections : [] + + +Name : noneRouteTable +Id : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/hubRouteTables/noneRouteTable +ProvisioningState : Succeeded +Labels : {testLabel} +Routes : [] +AssociatedConnections : [] +PropagatingConnections : [] +``` + +This command lists all the hub route tables in the specified VirtualHub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: VirtualHubName, ParentVirtualHubName, ParentResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VirtualHubRouteTableName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ParentResourceId +The parent resource id. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId, ParentVirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The parent resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: ParentObject, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVHubRouteTable + +## NOTES + +## RELATED LINKS + +[New-AzVHubRoute](./New-AzVHubRoute.md) + +[New-AzVHubRouteTable](./New-AzVHubRouteTable.md) + +[Update-AzVHubRouteTable](./Update-AzVHubRouteTable.md) + +[Remove-AzVHubRouteTable](./Remove-AzVHubRouteTable.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualApplianceSite.md b/azps-10.1.0/Az.Network/Get-AzVirtualApplianceSite.md new file mode 100644 index 0000000000..edd7d74c49 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualApplianceSite.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualappliancesite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualApplianceSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualApplianceSite.md +--- + +# Get-AzVirtualApplianceSite + +## SYNOPSIS +Get or List sites connected to Network Virtual Appliance resource(s). + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Get-AzVirtualApplianceSite [-Name <String>] [-NetworkVirtualApplianceId <String>] [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzVirtualApplianceSite -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzVirtualApplianceSite gets or lists sites connected to one or more Network Virtual Appliance resources. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualApplianceSite -Name testsite -NetworkVirtualApplianceId $nva.Id -ResourceGroupName testrg +``` + +```output +AddressPrefix : 10.0.1.0/24 +O365Policy : Microsoft.Azure.Commands.Network.Models.PSOffice365PolicyProperties +ProvisioningState : Succeeded +Name : testsite +Etag : 00000000-0000-0000-0000-000000000000 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/testsite +``` + +Get a Virtual Appliance site resource. + +### Example 2 +```powershell +Get-AzVirtualApplianceSite -NetworkVirtualApplianceId $nva.Id -ResourceGroupName testrg +``` + +```output +AddressPrefix : 10.0.1.0/24 +O365Policy : Microsoft.Azure.Commands.Network.Models.PSOffice365PolicyProperties +ProvisioningState : Succeeded +Name : testsite +Etag : 00000000-0000-0000-0000-000000000000 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/testsite + +AddressPrefix : 10.0.2.0/24 +O365Policy : Microsoft.Azure.Commands.Network.Models.PSOffice365PolicyProperties +ProvisioningState : Succeeded +Name : testsite2 +Etag : 00000000-0000-0000-0000-000000000000 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/testsite2 +``` + +List Virtual Appliance site resources in a Network Virtual Appliance. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkVirtualApplianceId +The Network Virtual Appliance that the site is attached. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id of the Virtual Appliance Site. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceSite + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualHub.md b/azps-10.1.0/Az.Network/Get-AzVirtualHub.md new file mode 100644 index 0000000000..654975d5ec --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualHub.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualHub.md +--- + +# Get-AzVirtualHub + +## SYNOPSIS +Gets an Azure VirtualHub by Name and ResourceGroupName or lists all Virtual Hubs by ResourceGroupName/Subscription. + +## SYNTAX + +### ListBySubscriptionId (Default) +``` +Get-AzVirtualHub [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListByResourceGroupName +``` +Get-AzVirtualHub [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an Azure VirtualHub by Name and ResourceGroupName or lists all Virtual Hubs by ResourceGroupName/Subscription. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +Get-AzVirtualHub -ResourceGroupName "testRG" -Name "westushub" +``` + +```output +VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +ResourceGroupName : testRG +Name : westushub +Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub +AddressPrefix : 10.0.1.0/24 +RouteTable : +VirtualNetworkConnections : {} +Location : West US +Type : Microsoft.Network/virtualHubs +ProvisioningState : Succeeded +``` + +The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". + +It then gets the virtual hub using its ResourceGroupName and ResourceName. + +### Example 2 + +```powershell +Get-AzVirtualHub -Name westushub* +``` + +```output +VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +ResourceGroupName : testRG +Name : westushub1 +Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub1 +AddressPrefix : 10.0.1.0/24 +RouteTable : +VirtualNetworkConnections : {} +Location : West US +Type : Microsoft.Network/virtualHubs +ProvisioningState : Succeeded + +VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +ResourceGroupName : testRG +Name : westushub2 +Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub2 +AddressPrefix : 10.0.1.0/24 +RouteTable : +VirtualNetworkConnections : {} +Location : West US +Type : Microsoft.Network/virtualHubs +ProvisioningState : Succeeded +``` + +This cmdlet gets the virtual hub using filtering. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: ResourceName, VirtualHubName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +## NOTES + +## RELATED LINKS + +[New-AzVirtualHub](./New-AzVirtualHub.md) + +[Remove-AzVirtualHub](./Remove-AzVirtualHub.md) + +[Update-AzVirtualHub](./Update-AzVirtualHub.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualHubBgpConnection.md b/azps-10.1.0/Az.Network/Get-AzVirtualHubBgpConnection.md new file mode 100644 index 0000000000..92ba5fbd50 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualHubBgpConnection.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualhubbgpconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualHubBgpConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualHubBgpConnection.md +--- + +# Get-AzVirtualHubBgpConnection + +## SYNOPSIS +The Get-AzVirtualHubBgpConnection cmdlet gets a Virtual WAN Hub BGP Connection in a Virtual WAN Hub or lists all Virtual WAN Hub BGP Connections in a Virtual WAN Hub. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +Get-AzVirtualHubBgpConnection -ResourceGroupName <String> -VirtualHubName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Get-AzVirtualHubBgpConnection [-Name <String>] -VirtualHub <PSVirtualHub> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByHubBgpConnectionResourceId +``` +Get-AzVirtualHubBgpConnection -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzVirtualHubBgpConnection cmdlet gets a Virtual WAN Hub BGP Connection in a Virtual WAN Hub or lists all Virtual WAN Hub BGP Connections in a Virtual WAN Hub. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "192.168.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "192.168.2.0/24" +$remoteVirtualNetwork = New-AzVirtualNetwork -Name "testVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "192.168.0.0/16" -Subnet $frontendSubnet,$backendSubnet +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "testWan" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "testHub" -AddressPrefix "10.0.1.0/24" +$hubVnetConnection = New-AzVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -Name "testVnetConnection" -RemoteVirtualNetwork $remoteVirtualNetwork +New-AzVirtualHubBgpConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -PeerIp 192.168.1.5 -PeerAsn 20000 -Name "testBgpConnection" -VirtualHubVnetConnection $hubVnetConnection + +Get-AzVirtualHubBgpConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -Name "testBgpConnection" +``` + +```output +Name : testBgpConnection +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/bgpConnections/testBgpConnection +HubVirtualNetworkConnection : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/hubVirtualNetworkConnections/testVnetConnection +PeerAsn : 20000 +PeerIp : 192.168.1.5 +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual WAN Hub in West US and connect the Virtual Network to the Virtual WAN Hub in that resource group in Azure. A Virtual WAN Hub BGP Connection will be created thereafter which will peer the Virtual WAN Hub with the network appliance deployed in the Virtual Network. + +After the Virtual WAN Hub BGP Connection is created, it gets the BGP Connection using its resource group name, the Virtual WAN Hub name and the BGP Connection name. + +### Example 2 + +```powershell +Get-AzVirtualHubBgpConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -Name test* +``` + +```output +Name : testBgpConnection1 +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/bgpConnections/testBgpConnection1 +HubVirtualNetworkConnection : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/hubVirtualNetworkConnections/testVnetConnection +PeerAsn : 20000 +PeerIp : 192.168.1.5 + +Name : testBgpConnection2 +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/bgpConnections/testBgpConnection2 +HubVirtualNetworkConnection : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/hubVirtualNetworkConnections/testVnetConnection +PeerAsn : 20000 +PeerIp : 192.168.1.6 +``` + +This cmdlet lists all the Virtual WAN Hub BGP Connections starting with "test" using its resource group name and the Virtual WAN Hub name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName, ByVirtualHubObject +Aliases: ResourceName, BgpConnectionName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id. + +```yaml +Type: System.String +Parameter Sets: ByHubBgpConnectionResourceId +Aliases: BgpConnectionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The virtual hub resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: ParentObject, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubName +The virtual hub name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: ParentResourceName, ParentVirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBgpConnection + +## NOTES + +## RELATED LINKS + +[New-AzVirtualHubBgpConnection](./Get-AzVirtualHubBgpConnection.md) + +[Remove-AzVirtualHubBgpConnection](./Remove-AzVirtualHubBgpConnection.md) + +[Update-AzVirtualHubBgpConnection](./Update-AzVirtualHubBgpConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualHubRouteTable.md b/azps-10.1.0/Az.Network/Get-AzVirtualHubRouteTable.md new file mode 100644 index 0000000000..c023797a45 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualHubRouteTable.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualhubroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualHubRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualHubRouteTable.md +--- + +# Get-AzVirtualHubRouteTable + +## SYNOPSIS +Gets a Virtual Hub Route Table in a virtual hub or lists all route tables in a virtual hub. The cmdlet [Get-AzVHubRouteTable](./Get-AzVHubRouteTable.md) is replacing this cmdlet. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +Get-AzVirtualHubRouteTable -ResourceGroupName <String> -HubName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Get-AzVirtualHubRouteTable -VirtualHub <PSVirtualHub> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +Get-AzVirtualHubRouteTable -ParentResourceId <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Virtual Hub Route Table in a virtual hub or lists all route tables in a virtual hub. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualHubRouteTable -ResourceGroupName "testRg" -HubName "westushub" -Name "routeTable1" +``` + +```output +Name : routeTable1 +Id : /subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/routeTables/routeTable1 +Routes : {Microsoft.Azure.Commands.Network.Models.PSVirtualHubRoute} +Connections : {All_Vnets} +ProvisioningState : Succeeded +``` + +This cmdlet retrieves a route table resource using resource group name, hub name and the route table name. + +### Example 2 +```powershell +Get-AzVirtualHubRouteTable -ResourceGroupName "testRg" -HubName "westushub" +``` + +```output +Name : routeTable1 +Id : /subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/routeTables/routeTable1 +Routes : {Microsoft.Azure.Commands.Network.Models.PSVirtualHubRoute} +Connections : {All_Vnets} +ProvisioningState : Succeeded + +Name : routeTable2 +Id : /subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/routeTables/routeTable2 +Routes : {Microsoft.Azure.Commands.Network.Models.PSVirtualHubRoute} +Connections : {All_Branches} +ProvisioningState : Succeeded +``` + +This cmdlet lists all route tables present in a virtual hub using resource group name and the hub name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: VirtualHubName, ParentVirtualHubName, ParentResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VirtualHubRouteTableName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ParentResourceId +The parent resource id. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId, ParentVirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The parent resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: ParentObject, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualHubVnetConnection.md b/azps-10.1.0/Az.Network/Get-AzVirtualHubVnetConnection.md new file mode 100644 index 0000000000..6167479238 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualHubVnetConnection.md @@ -0,0 +1,284 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualhubvnetconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualHubVnetConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualHubVnetConnection.md +--- + +# Get-AzVirtualHubVnetConnection + +## SYNOPSIS +Gets a Virtual Network Connection in a virtual hub or lists all virtual network connections in a virtual hub. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +Get-AzVirtualHubVnetConnection -ResourceGroupName <String> -ParentResourceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Get-AzVirtualHubVnetConnection -ParentObject <PSVirtualHub> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +Get-AzVirtualHubVnetConnection -ParentResourceId <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Virtual Network Connection in a virtual hub or lists all virtual network connections in a virtual hub. + +## EXAMPLES + +### Example 1 +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" +$remoteVirtualNetwork = New-AzVirtualNetwork -Name "MyVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet + +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +New-AzVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "westushub" -Name "testvnetconnection" -RemoteVirtualNetwork $remoteVirtualNetwork + +Get-AzVirtualHubVnetConnection -ResourceGroupName testRG -VirtualHubName westushub -Name testvnetconnection +``` + +```output +Name : testvnetconnection +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubVirtualNetworkConnections/testvnetconnection +RemoteVirtualNetwork : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork +ProvisioningState : Succeeded +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in Central US in that resource group in Azure. A Virtual Network Connection will be created thereafter which will peer the Virtual Network to the Virtual Hub. + +After the hub virtual network connection is created, it gets the hub virtual network connection using its resource group name, the hub name and the connection name. + +### Example 2 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" +$remoteVirtualNetwork = New-AzVirtualNetwork -Name "MyVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +New-AzVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "westushub" -Name "testvnetconnection" -RemoteVirtualNetwork $remoteVirtualNetwork +Get-AzVirtualHubVnetConnection -ResourceGroupName testRG -VirtualHubName westushub +``` + +```output +Name : testvnetconnection +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubVirtualNetworkConnections/testvnetconnection +RemoteVirtualNetwork : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork +ProvisioningState : Succeeded +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in Central US in that resource group in Azure. A Virtual Network Connection will be created thereafter which will peer the Virtual Network to the Virtual Hub. + +After the hub virtual network connection is created, it lists all the hub virtual network connection using its resource group name and the hub name. + +### Example 3 + +```powershell +Get-AzVirtualHubVnetConnection -ResourceGroupName testRG -VirtualHubName westushub -Name test* +``` + +```output +Name : testvnetconnection1 +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubVirtualNetworkConnections/testvnetconnection1 +RemoteVirtualNetwork : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork +ProvisioningState : Succeeded +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } + +Name : testvnetconnection2 +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubVirtualNetworkConnections/testvnetconnection2 +RemoteVirtualNetwork : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork +ProvisioningState : Succeeded +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +This cmdlet lists all the hub virtual network connections starting with "test" using its resource group name and the hub name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, HubVirtualNetworkConnectionName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ParentObject +The parent resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The parent resource id. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId, ParentVirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: VirtualHubName, ParentVirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection + +## NOTES + +## RELATED LINKS + +[New-AzVirtualHubVnetConnection](./New-AzVirtualHubVnetConnection.md) + +[Remove-AzVirtualHubVnetConnection](./Remove-AzVirtualHubVnetConnection.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetwork.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetwork.md new file mode 100644 index 0000000000..8d6816c558 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetwork.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: CBDF4BCB-7EB3-4D64-B19C-1314D4AB84E4 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetwork.md +--- + +# Get-AzVirtualNetwork + +## SYNOPSIS +Gets a virtual network in a resource group. + +## SYNTAX + +### NoExpand +``` +Get-AzVirtualNetwork [-Name <String>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### Expand +``` +Get-AzVirtualNetwork -Name <String> -ResourceGroupName <String> -ExpandResource <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVirtualNetwork** cmdlet gets one or more virtual networks in a resource group. + +## EXAMPLES + +### Example 1: Retrieve a virtual network +```powershell +Get-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup +``` + +```output +Name : MyVirtualNetwork1 +ResourceGroupName : TestResourceGroup +Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup + /providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +AddressSpace : { + "AddressPrefixes": [ + "xx.x.x.x/x" + ] + } +DhcpOptions : {} +FlowTimeoutInMinutes : null +Subnets : [] +VirtualNetworkPeerings : [] +EnableDdosProtection : false +DdosProtectionPlan : null +``` + +This command gets the virtual network named MyVirtualNetwork in the resource group TestResourceGroup + +### Example 2: List virtual networks using filter +```powershell +Get-AzVirtualNetwork -Name MyVirtualNetwork* +``` + +```output +Name : MyVirtualNetwork1 +ResourceGroupName : TestResourceGroup +Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup + /providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +AddressSpace : { + "AddressPrefixes": [ + "xx.x.x.x/x" + ] + } +DhcpOptions : {} +FlowTimeoutInMinutes : null +Subnets : [] +VirtualNetworkPeerings : [] +EnableDdosProtection : false +DdosProtectionPlan : null +``` + +This command gets all virtual networks that start with "MyVirtualNetwork". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandResource +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual network that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the resource group that virtual network belongs to. + +```yaml +Type: System.String +Parameter Sets: NoExpand +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: Expand +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +## NOTES + +## RELATED LINKS + +[New-AzVirtualNetwork](./New-AzVirtualNetwork.md) + +[Remove-AzVirtualNetwork](./Remove-AzVirtualNetwork.md) + +[Set-AzVirtualNetwork](./Set-AzVirtualNetwork.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkAvailableEndpointService.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkAvailableEndpointService.md new file mode 100644 index 0000000000..189419dc19 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkAvailableEndpointService.md @@ -0,0 +1,85 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkavailableendpointservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkAvailableEndpointService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkAvailableEndpointService.md +--- + +# Get-AzVirtualNetworkAvailableEndpointService + +## SYNOPSIS +Lists available endpoint services for location. + +## SYNTAX + +``` +Get-AzVirtualNetworkAvailableEndpointService -Location <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get-AzVirtualNetworkAvailableEndpointService lists endpoint services available in the specified location. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualNetworkAvailableEndpointService -Location westus +``` + +```output +-Name Id Type +----- -- ---- +-Microsoft.Storage /subscriptions/id/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Storage Microsoft.Network/virtualNetworkEndpointServices +``` + +Gets available endpoint services in westus region. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location to retrieve the endpoint services from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSEndpointServiceResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGateway.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGateway.md new file mode 100644 index 0000000000..c5f0dc9bfc --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGateway.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 9CBF592E-734B-4A0C-A45D-358C226D08C7 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGateway.md +--- + +# Get-AzVirtualNetworkGateway + +## SYNOPSIS +Gets a Virtual Network Gateway + +## SYNTAX + +``` +Get-AzVirtualNetworkGateway [-Name <String>] -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Virtual Network Gateway is the object representing your gateway in Azure. +The **Get-AzVirtualNetworkGateway** cmdlet returns the object of your gateway in Azure based on Name and Resource Group Name. + +## EXAMPLES + +### Example 1: Get a Virtual Network Gateway +```powershell +Get-AzVirtualNetworkGateway -Name myGateway1 -ResourceGroupName myRG +``` + +Returns the object of the Virtual Network Gateway with the name "myGateway1" within the resource group "myRG" + +### Example 2: Get a Virtual Network Gateway +```powershell +Get-AzVirtualNetworkGateway -Name myGateway* -ResourceGroupName myRG +``` + +Returns all Virtual Network Gateways that start with "myGateway" within the resource group "myRG" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +## NOTES + +## RELATED LINKS + +[New-AzVirtualNetworkGateway](./New-AzVirtualNetworkGateway.md) + +[Remove-AzVirtualNetworkGateway](./Remove-AzVirtualNetworkGateway.md) + +[Reset-AzVirtualNetworkGateway](./Reset-AzVirtualNetworkGateway.md) + +[Resize-AzVirtualNetworkGateway](./Resize-AzVirtualNetworkGateway.md) + +[Set-AzVirtualNetworkGateway](./Set-AzVirtualNetworkGateway.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayAdvertisedRoute.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayAdvertisedRoute.md new file mode 100644 index 0000000000..11a2d69681 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayAdvertisedRoute.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkgatewayadvertisedroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayAdvertisedRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayAdvertisedRoute.md +--- + +# Get-AzVirtualNetworkGatewayAdvertisedRoute + +## SYNOPSIS +Lists routes being advertised by an Azure virtual network gateway + +## SYNTAX + +``` +Get-AzVirtualNetworkGatewayAdvertisedRoute -VirtualNetworkGatewayName <String> -ResourceGroupName <String> + -Peer <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Given the IP of a BGP peer, enumerates routes being advertised to that peer by the specified Azure virtual network gateway. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualNetworkGatewayAdvertisedRoute -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName -Peer 10.0.0.254 +``` + +For the Azure gateway named gatewayName in resource group resourceGroupName, retrieves a list of routes being advertised to the BGP peer with IP 10.0.0.254 + +### Example 2 +```powershell +$bgpPeerStatus = Get-AzVirtualNetworkGatewayBGPPeerStatus -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName +Get-AzVirtualNetworkGatewayAdvertisedRoute -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName -Peer $bgpPeerStatus[0].Neighbor +``` + +For the Azure gateway named gatewayName in resource group resourceGroupName, retrieves routes being advertised to the first BGP peer on the gateway's list of BGP peers. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Peer +BGP peer's IP address. This should be an IP within the address space accessible from within the Azure virtual network the gateway is deployed in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Virtual network gateway resource group's name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +Virtual network gateway name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSGatewayRoute + +## NOTES +This command is only applicable to Azure virtual network gateways with BGP enabled connections. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayBGPPeerStatus.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayBGPPeerStatus.md new file mode 100644 index 0000000000..300e356845 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayBGPPeerStatus.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkgatewaybgppeerstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayBGPPeerStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayBGPPeerStatus.md +--- + +# Get-AzVirtualNetworkGatewayBGPPeerStatus + +## SYNOPSIS +Lists an Azure virtual network gateway's BGP peers + +## SYNTAX + +``` +Get-AzVirtualNetworkGatewayBGPPeerStatus -VirtualNetworkGatewayName <String> -ResourceGroupName <String> + [-Peer <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This command enumerates BGP peers an Azure virtual network gateway is configured to peer with. The status of each peer is also given. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualNetworkGatewayBgpPeerStatus -ResourceGroupName resourceGroup -VirtualNetworkGatewayName gatewayName +``` + +```output +Asn : 65515 +ConnectedDuration : 9.01:04:53.5768637 +LocalAddress : 10.1.0.254 +MessagesReceived : 14893 +MessagesSent : 14900 +Neighbor : 10.0.0.254 +RoutesReceived : 1 +State : Connected +``` + +Retrieves BGP peers for the Azure virtual network gateway named gatewayName in resource group resourceGroup. +This example output shows one connected BGP peer, with an IP of 10.0.0.254. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Peer +IP of the peer to retrieve status for + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Virtual network gateway resource group's name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +Virtual network gateway name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBGPPeerStatus + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayConnection.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayConnection.md new file mode 100644 index 0000000000..72c1b29230 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayConnection.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 617FB2F9-05EA-4224-B9A9-2F00A7599486 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkgatewayconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayConnection.md +--- + +# Get-AzVirtualNetworkGatewayConnection + +## SYNOPSIS +Gets a Virtual Network Gateway Connection + +## SYNTAX + +``` +Get-AzVirtualNetworkGatewayConnection [-Name <String>] -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Virtual Network Gateway Connection is the object representing the IPsec tunnel (Site-to-Site or Vnet-to-Vnet) connected to your Virtual Network Gateway in Azure. +The **Get-AzVirtualNetworkGatewayConnection** cmdlet returns the object of your connection based on Name and Resource Group Name. +If the **Get-AzVirtualNetworkGatewayConnection** cmdlet is issued without specifying the -Name parameter, the output will not show ConnectionStatus and SharedKey details. + +## EXAMPLES + +### 1: Get a Virtual Network Gateway Connection +```powershell +Get-AzVirtualNetworkGatewayConnection -Name myTunnel -ResourceGroupName myRG +``` + +Returns the object of the Virtual Network Gateway Connection with the name "myTunnel" within the resource group "myRG" + +### 2: Get all Virtual Network Gateway Connections using filtering +```powershell +Get-AzVirtualNetworkGatewayConnection -Name myTunnel* -ResourceGroupName myRG +``` + +Returns all Virtual Network Gateway Connections that start with "myTunnel" within the resource group "myRG" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection + +## NOTES + +## RELATED LINKS + +[New-AzVirtualNetworkGatewayConnection](./New-AzVirtualNetworkGatewayConnection.md) + +[Remove-AzVirtualNetworkGatewayConnection](./Remove-AzVirtualNetworkGatewayConnection.md) + +[Set-AzVirtualNetworkGatewayConnection](./Set-AzVirtualNetworkGatewayConnection.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayConnectionIkeSa.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayConnectionIkeSa.md new file mode 100644 index 0000000000..a8935c6dbe --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayConnectionIkeSa.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkgatewayconnectionikesa +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayConnectionIkeSa.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayConnectionIkeSa.md +--- + +# Get-AzVirtualNetworkGatewayConnectionIkeSa + +## SYNOPSIS +Get IKE Security Associations of a Virtual Network Gateway Connection + +## SYNTAX + +### ByName (Default) +``` +Get-AzVirtualNetworkGatewayConnectionIkeSa -Name <String> -ResourceGroupName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByInputObject +``` +Get-AzVirtualNetworkGatewayConnectionIkeSa -InputObject <PSVirtualNetworkGatewayConnection> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzVirtualNetworkGatewayConnectionIkeSa -ResourceId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVirtualNetworkGatewayConnectionIkeSa** cmdlet returns the IKE Security Associations of your connection based on the Connection Name and Resource Group Name. +If the **Get-AzVirtualNetworkGatewayConnection** cmdlet is issued without specifying the -Name parameter, the output will not show the IKE Security Associations. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualNetworkGatewayConnectionIkeSa -ResourceGroupName myRG -Name myTunnel +``` + +```output +localEndpoint : 52.180.160.154 +remoteEndpoint : 104.208.54.1 +initiatorCookie : 5490733703579933026 +responderCookie : 15460013388959380535 +localUdpEncapsulationPort : 0 +remoteUdpEncapsulationPort : 0 +encryption : AES256 +integrity : SHA1 +dhGroup : DHGroup2 +lifeTimeSeconds : 28800 +isSaInitiator : True +elapsedTimeInseconds : 23092 +quickModeSa : {} +``` + +Returns the IKE Security Associations for the Virtual Network Gateway Connection with the name "myTunnel" within the resource group "myRG" + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual network gateway connection object for which IKE SAs needs to be fetched. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The virtual network gateway connection name for which IKE SAs needs to be fetched. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ResourceName, ConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the Virtual Network Gateway Connection for which IKE SAs needs to be fetched. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnectionIkeSa + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayConnectionSharedKey.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayConnectionSharedKey.md new file mode 100644 index 0000000000..9f3d1f0a52 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayConnectionSharedKey.md @@ -0,0 +1,97 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: ECC5C079-C9A0-4159-A039-EE216897D686 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkgatewayconnectionsharedkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayConnectionSharedKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayConnectionSharedKey.md +--- + +# Get-AzVirtualNetworkGatewayConnectionSharedKey + +## SYNOPSIS +Displays the shared key used for the connection. + +## SYNTAX + +``` +Get-AzVirtualNetworkGatewayConnectionSharedKey [-Name <String>] -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Displays the shared key used for the connection. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualNetworkGatewayConnectionSharedKey -Name 1 -ResourceGroupName P2SVPNGateway +``` + +```output +xxxxxx +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Reset-AzVirtualNetworkGatewayConnectionSharedKey](./Reset-AzVirtualNetworkGatewayConnectionSharedKey.md) + +[Set-AzVirtualNetworkGatewayConnectionSharedKey](./Set-AzVirtualNetworkGatewayConnectionSharedKey.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md new file mode 100644 index 0000000000..e558fd6307 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkgatewayconnectionvpndeviceconfigscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md +--- + +# Get-AzVirtualNetworkGatewayConnectionVpnDeviceConfigScript + +## SYNOPSIS +This commandlet takes the connection resource, VPN device brand, model, firmware version, and return the corresponding configuration script that customers can apply directly on their on-premises VPN devices. The script will follow the syntax of the selected device, and fill in the necessary parameters such as Azure gateway public IP addresses, virtual network address prefixes, VPN tunnel pre-shared key, etc. so customers can simply copy-paste to their VPN device configurations. + +## SYNTAX + +``` +Get-AzVirtualNetworkGatewayConnectionVpnDeviceConfigScript -Name <String> -ResourceGroupName <String> + -DeviceVendor <String> -DeviceFamily <String> -FirmwareVersion <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This commandlet takes the connection resource, VPN device brand, model, firmware version, and return the corresponding configuration script that customers can apply directly on their on-premises VPN devices. The script will follow the syntax of the selected device, and fill in the necessary parameters such as Azure gateway public IP addresses, virtual network address prefixes, VPN tunnel pre-shared key, etc. so customers can simply copy-paste to their VPN device configurations. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualNetworkGatewaySupportedVpnDevice -ResourceGroupName TestRG -Name TestGateway +Get-AzVirtualNetworkGatewayConnectionVpnDeviceConfigScript -ResourceGroupName TestRG -Name TestConnection -DeviceVendor "Cisco-Test" -DeviceFamily "IOS-Test" -FirmwareVersion "20" +``` + +The above example uses Get-AzVirtualNetworkGatewaySupportedVpnDevice to get the supported VPN Device brands, models, and firmware versions. +Then uses one of the returned models information to generate a VPN Device configuration script for the VirtualNetworkGatewayConnection "TestConnection". The device used in this example has DeviceFamily "IOS-Test", DeviceVendor "Cisco-Test" and FirmwareVersion 20. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceFamily +Name of the VPN device model/family. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DeviceVendor +Name of the VPN device vendor. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FirmwareVersion +Firmware version of the VPN device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name of the connection for which the configuration is to be generated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayLearnedRoute.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayLearnedRoute.md new file mode 100644 index 0000000000..aa1e94bae8 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayLearnedRoute.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkgatewaylearnedroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayLearnedRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayLearnedRoute.md +--- + +# Get-AzVirtualNetworkGatewayLearnedRoute + +## SYNOPSIS +Lists routes learned by an Azure virtual network gateway + +## SYNTAX + +``` +Get-AzVirtualNetworkGatewayLearnedRoute -VirtualNetworkGatewayName <String> -ResourceGroupName <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Enumerates routes learned by an Azure virtual network gateway from various sources. This includes routes learned over BGP, as well as static routes. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualNetworkGatewayLearnedRoute -ResourceGroupName resourceGroup -VirtualNetworkGatewayname gatewayName +``` + +```output +AsPath : +LocalAddress : 10.1.0.254 +Network : 10.1.0.0/16 +NextHop : +Origin : Network +SourcePeer : 10.1.0.254 +Weight : 32768 + +AsPath : +LocalAddress : 10.1.0.254 +Network : 10.0.0.254/32 +NextHop : +Origin : Network +SourcePeer : 10.1.0.254 +Weight : 32768 + +AsPath : 65515 +LocalAddress : 10.1.0.254 +Network : 10.0.0.0/16 +NextHop : 10.0.0.254 +Origin : EBgp +SourcePeer : 10.0.0.254 +Weight : 32768 +``` + +For the Azure virtual network gateway named gatewayname in resource group resourceGroup, retrieves routes the Azure gateway knows. +The Azure virtual network gateway in this case has two static routes (10.1.0.0/16 and 10.0.0.254/32), as well as one route learned over BGP (10.0.0.0/16). + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Virtual network gateway resource group's name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +Virtual network gateway name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSGatewayRoute + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayNatRule.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayNatRule.md new file mode 100644 index 0000000000..90dc9e4914 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayNatRule.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkgatewaynatrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayNatRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayNatRule.md +--- + +# Get-AzVirtualNetworkGatewayNatRule + +## SYNOPSIS +Gets a Virtual Network Gateway NatRule. + +## SYNTAX + +### ByVirtualNetworkGatewayName (Default) +``` +Get-AzVirtualNetworkGatewayNatRule -ResourceGroupName <String> -ParentResourceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualNetworkGatewayObject +``` +Get-AzVirtualNetworkGatewayNatRule -ParentObject <PSVirtualNetworkGateway> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualNetworkGatewayResourceId +``` +Get-AzVirtualNetworkGatewayNatRule -ParentResourceId <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +**Get-AzVirtualNetworkGatewayNatRule** cmdlet returns a virtual network gateway nat rule object of your virtual network gateway based on Name and ParentResourceName. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualNetworkGatewayNatRule -ResourceGroupName "rg1" -Name "natRule1" -ParentResourceName gw1 +``` + +```output +Name : natRule1 +ProvisioningState : Succeeded +Type : Static +Mode : IngressSnat +InternalMappings : [ + { + "AddressSpace": "25.0.0.0/16" + } + ] +ExternalMappings : [ + { + "AddressSpace": "30.0.0.0/16" + } + ] +IpConfigurationId : +Id : /subscriptions/7afd8f92-c220-4f53-886e-1df53a69afd4/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gw1/natRules/natRule1 +Etag : W/"5150d788-e165-42ba-99c4-8138a545fce9" +``` + +### Example 2: +```powershell +Get-AzVirtualNetworkGatewayNatRule -ResourceGroupName "rg1" -ParentResourceName "gw1" +``` + +```output +Name : natRule1 +ProvisioningState : Succeeded +Type : Static +Mode : IngressSnat +InternalMappings : [ + { + "AddressSpace": "25.0.0.0/16" + } + ] +ExternalMappings : [ + { + "AddressSpace": "30.0.0.0/16" + } + ] +IpConfigurationId : +Id : /subscriptions/7afd8f92-c220-4f53-886e-1df53a69afd4/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gw1/natRules/natRule1 +Etag : W/"5150d788-e165-42ba-99c4-8138a545fce9" + +Name : natRule2 +ProvisioningState : Succeeded +Type : Static +Mode : EgressSnat +InternalMappings : [ + { + "AddressSpace": "20.0.0.0/16" + } + ] +ExternalMappings : [ + { + "AddressSpace": "50.0.0.0/16" + } + ] +IpConfigurationId : +Id : /subscriptions/7afd8f92-c220-4f53-886e-1df53a69afd4/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gw1/natRules/natRule2 +Etag : W/"5150d788-e165-42ba-99c4-8138a545fce9" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VirtualNetworkGatewayNatRuleName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ParentObject +The parent VirtualNetworkGateway for this VirtualNetworkGatewayNatRule. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: ByVirtualNetworkGatewayObject +Aliases: ParentVirtualNetworkGateway, VirtualNetworkGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The resource id of the parent VirtualNetworkGateway for this VirtualNetworkGatewayNatRule. + +```yaml +Type: System.String +Parameter Sets: ByVirtualNetworkGatewayResourceId +Aliases: ParentVirtualNetworkGatewayId, VirtualNetworkGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualNetworkGatewayName +Aliases: ParentVirtualNetworkGatewayName, VirtualNetworkGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualNetworkGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayNatRule + +## NOTES + +## RELATED LINKS + +[New-AzVirtualNetworkGatewayNatRule](./New-AzVirtualNetworkGatewayNatRule.md) + +[Remove-AzVirtualNetworkGatewayNatRule](./Remove-AzVirtualNetworkGatewayNatRule.md) + +[Update-AzVirtualNetworkGatewayNatRule](./Update-AzVirtualNetworkGatewayNatRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewaySupportedVpnDevice.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewaySupportedVpnDevice.md new file mode 100644 index 0000000000..a83fd7ec05 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewaySupportedVpnDevice.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkgatewaysupportedvpndevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewaySupportedVpnDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewaySupportedVpnDevice.md +--- + +# Get-AzVirtualNetworkGatewaySupportedVpnDevice + +## SYNOPSIS +This commandlet returns a list of supported VPN device brands, models, and firmware versions. + +## SYNTAX + +``` +Get-AzVirtualNetworkGatewaySupportedVpnDevice -Name <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This commandlet returns a list of supported VPN device brands, models, and firmware versions. + +## EXAMPLES + +### Example 1 + +The following example returns a list of supported VPN device brands, models and firmware versions. + +```powershell +Get-AzVirtualNetworkGatewaySupportedVpnDevice -ResourceGroupName TestRG -Name TestGateway +``` + +```output +<?xml version="1.0" encoding="utf-8"?> +<RpVpnDeviceList version="1.0"> + <Vendor name="Cisco-Test"> + <DeviceFamily name="IOS-Test"> + <FirmwareVersion name="20" /> + </DeviceFamily> + </Vendor> +</RpVpnDeviceList> +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The virtual network gateway name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayVpnClientConnectionHealth.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayVpnClientConnectionHealth.md new file mode 100644 index 0000000000..210cce344c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkGatewayVpnClientConnectionHealth.md @@ -0,0 +1,234 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkgatewayvpnclientconnectionhealth +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayVpnClientConnectionHealth.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkGatewayVpnClientConnectionHealth.md +--- + +# Get-AzVirtualNetworkGatewayVpnClientConnectionHealth + +## SYNOPSIS +Get the list of vpn client connection health of an Azure virtual network gateway for per vpn client connection + +## SYNTAX + +### ByFactoryName (Default) +``` +Get-AzVirtualNetworkGatewayVpnClientConnectionHealth -VirtualNetworkGatewayName <String> + -ResourceGroupName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzVirtualNetworkGatewayVpnClientConnectionHealth [-ResourceId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Get-AzVirtualNetworkGatewayVpnClientConnectionHealth [-InputObject <PSVirtualNetworkGateway>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +List all connected vpn client connection health. This includes: +vpnConnectionId +vpnConnectionDuration +vpnConnectionTime +publicIpAddress +privateIpAddress +vpnUserName +maxBandwidth +egressPacketsTransferred +egressBytesTransferred +ingressPacketsTransferred +ingressBytesTransferred +maxPacketsPerSecond + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualNetworkGatewayVpnClientConnectionHealth -ResourceName gatewayName -ResourceGroupName resourceGroup +``` + +```output +VpnConnectionId : OVPN_0085393D-B345-4846-0426-140616833F4C +VpnConnectionDuration : 27878 +VpnConnectionTime : 05/30/2019 16:03:11 +PublicIpAddress : 13.78.148.224:39672 +PrivateIpAddress : 10.1.1.131 +VpnUserName : GWP2SChildCert +MaxBandwidth : 48000000 +EgressPacketsTransferred : 104084 +EgressBytesTransferred : 4059276 +IngressPacketsTransferred : 1410 +IngressBytesTransferred : 67680 +MaxPacketsPerSecond : 1 + +VpnConnectionId : OVPN_00F692AC-2D6F-DE7B-DCAF-07BE896233A0 +VpnConnectionDuration : 27878 +VpnConnectionTime : 05/30/2019 16:03:11 +PublicIpAddress : 13.78.148.224:39692 +PrivateIpAddress : 10.1.1.79 +VpnUserName : GWP2SChildCert +MaxBandwidth : 48000000 +EgressPacketsTransferred : 104623 +EgressBytesTransferred : 4080297 +IngressPacketsTransferred : 1416 +IngressBytesTransferred : 67968 +MaxPacketsPerSecond : 1 +``` + +For the Azure virtual network gateway named gatewayname in resource group resourceGroup, retrieves the currently connected vpn client connection by using OpenVpn. + +### Example 2 + +Get the list of vpn client connection health of an Azure virtual network gateway for per vpn client connection. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Get-AzVirtualNetworkGatewayVpnClientConnectionHealth -ResourceGroupName resourceGroup -VirtualNetworkGatewayName 'ContosoVirtualNetwork' +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Virtual network gateway object + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: ByFactoryObject +Aliases: VirtualNetworkGateway + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Virtual network gateway resource group's name + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Virtual network gateway resource Id + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: VirtualNetworkGatewayId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +Virtual network gateway name + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSGatewayRoute + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkPeering.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkPeering.md new file mode 100644 index 0000000000..d371187d52 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkPeering.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 463DDBA8-0F93-483D-A4B6-3B055968CDE8 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkPeering.md +--- + +# Get-AzVirtualNetworkPeering + +## SYNOPSIS +Gets the virtual network peering. + +## SYNTAX + +``` +Get-AzVirtualNetworkPeering -VirtualNetworkName <String> -ResourceGroupName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVirtualNetworkPeering** cmdlet gets the virtual network peering. + +## EXAMPLES + +### Example 1: Get a peering between two virtual networks +```powershell +# Get virtual network peering named myVnet1TomyVnet2 located in myVirtualNetwork in the resource group named myResourceGroup. + +Get-AzVirtualNetworkPeering -Name "myVnet1TomyVnet2" -VirtualNetworkName "myVnet" -ResourceGroupName "myResourceGroup" +``` + +### Example 2: Get all peerings in virtual network +```powershell +# Get all virtual network peerings located in myVirtualNetwork in the resource group named myResourceGroup. + +Get-AzVirtualNetworkPeering -Name "myVnet1To*" -VirtualNetworkName "myVnet" -ResourceGroupName "myResourceGroup" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the virtual network peering name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the resource group name that the virtual network peering belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkName +Specifies the virtual network name that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering + +## NOTES + +## RELATED LINKS + +[Add-AzVirtualNetworkPeering](./Add-AzVirtualNetworkPeering.md) + +[Remove-AzVirtualNetworkPeering](./Remove-AzVirtualNetworkPeering.md) + +[Set-AzVirtualNetworkPeering](./Set-AzVirtualNetworkPeering.md) + +[Sync-AzVirtualNetworkPeering](./Sync-AzVirtualNetworkPeering.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkSubnetConfig.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkSubnetConfig.md new file mode 100644 index 0000000000..0f24b2cdde --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkSubnetConfig.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 7688CE56-0A25-4409-9676-BF1B67C3F05F +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworksubnetconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkSubnetConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkSubnetConfig.md +--- + +# Get-AzVirtualNetworkSubnetConfig + +## SYNOPSIS +Gets a subnet in a virtual network. + +## SYNTAX + +### GetByVirtualNetwork (Default) +``` +Get-AzVirtualNetworkSubnetConfig [-Name <String>] -VirtualNetwork <PSVirtualNetwork> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceId +``` +Get-AzVirtualNetworkSubnetConfig -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVirtualNetworkSubnetConfig** cmdlet gets one or more subnet configurations in an Azure virtual network. + +## EXAMPLES + +### 1: Get a subnet in a virtual network +```powershell +New-AzResourceGroup -Name TestResourceGroup -Location centralus +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" +$virtualNetwork = New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet +Get-AzVirtualNetworkSubnetConfig -Name frontendSubnet -VirtualNetwork $virtualNetwork +``` + +This example creates a resource group and a virtual network with a single subnet in that resource group. It then retrieves data about that subnet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the subnet configuration that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: GetByVirtualNetwork +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the resource id of the subnet that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: GetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetwork +Specifies the **VirtualNetwork** object that contains the subnet configuration that this cmdlet gets. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork +Parameter Sets: GetByVirtualNetwork +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSSubnet + +## NOTES + +## RELATED LINKS + +[Add-AzVirtualNetworkSubnetConfig](./Add-AzVirtualNetworkSubnetConfig.md) + +[New-AzVirtualNetworkSubnetConfig](./New-AzVirtualNetworkSubnetConfig.md) + +[Remove-AzVirtualNetworkSubnetConfig](./Remove-AzVirtualNetworkSubnetConfig.md) + +[Set-AzVirtualNetworkSubnetConfig](./Set-AzVirtualNetworkSubnetConfig.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkTap.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkTap.md new file mode 100644 index 0000000000..5bb308ba9e --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkTap.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworktap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkTap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkTap.md +--- + +# Get-AzVirtualNetworkTap + +## SYNOPSIS +Gets a virtual network tap + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzVirtualNetworkTap [-ResourceGroupName <String>] [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzVirtualNetworkTap -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVirtualNetworkTap** cmdlet gets an Azure virtual network tap or a list of Azure virtual network taps in a resource group. + +## EXAMPLES + +### Example 1: Get a virtual network tap +```powershell +Get-AzVirtualNetworkTap -ResourceGroupName "ResourceGroup1" -Name "VirtualTap1" +``` + +This command gets a VirtualNetwork tap reference for given "VirtualTap1" in "ResourceGroup1". + +### Example 2: Get all virtual network taps using filtering +```powershell +Get-AzVirtualNetworkTap -Name "VirtualTap*" +``` + +This command gets all VirtualNetwork tap references that start with "VirtualTap". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the tap. + +```yaml +Type: System.String +Parameter Sets: ListParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name of the virtual network tap. + +```yaml +Type: System.String +Parameter Sets: ListParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +ResourceId of the VirtualNetworkTap resource + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap + +## NOTES + +## RELATED LINKS + +[New-AzVirtualNetworkTap](./New-AzVirtualNetworkTap.md) + +[Remove-AzVirtualNetworkTap](./Remove-AzVirtualNetworkTap.md) + +[Set-AzVirtualNetworkTap](./Set-AzVirtualNetworkTap.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualNetworkUsageList.md b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkUsageList.md new file mode 100644 index 0000000000..ee32839523 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualNetworkUsageList.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualnetworkusagelist +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkUsageList.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualNetworkUsageList.md +--- + +# Get-AzVirtualNetworkUsageList + +## SYNOPSIS +Gets virtual network current usage. + +## SYNTAX + +``` +Get-AzVirtualNetworkUsageList -ResourceGroupName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVirtualNetworkUsageList** cmdlet gets per subnet usage for the specified virtual network. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualNetworkUsageList -ResourceGroupName test -Name usagetest +``` + +```output +Name : Subnet size and usage +Id : /subscriptions/sub1/resourceGroups/test/providers/Microsoft.Network/virtualNetworks/usagetest/subnets/subnet +CurrentValue : 1 +Limit : 65531 +Unit : Count + +Name : Subnet size and usage +Id : /subscriptions/sub1/resourceGroups/test/providers/Microsoft.Network/virtualNetworks/usagetest/subnets/subnet11 +CurrentValue : 0 +Limit : 251 +Unit : Count +``` + +Gets per subnet current values of usage for usagetest virtual network. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual network to show usages for. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that virtual network belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkUsage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualRouter.md b/azps-10.1.0/Az.Network/Get-AzVirtualRouter.md new file mode 100644 index 0000000000..f7bd17262f --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualRouter.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualrouter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualRouter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualRouter.md +--- + +# Get-AzVirtualRouter + +## SYNOPSIS +Get an Azure VirtualRouter + +## SYNTAX + +### VirtualRouterSubscriptionIdParameterSet (Default) +``` +Get-AzVirtualRouter [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### VirtualRouterNameParameterSet +``` +Get-AzVirtualRouter -ResourceGroupName <String> [-RouterName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### VirtualRouterResourceIdParameterSet +``` +Get-AzVirtualRouter -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVirtualRouter** cmdlet gets an Azure VirtualRouter + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualRouter -ResourceGroupName virtualRouterRG -RouterName virtualRouter +``` + +### Example 2 +```powershell +$virtualRouterId = '/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/virtualRouterRG/providers/Microsoft.Network/virtualRouters/virtualRouter' +Get-AzVirtualRouter -ResourceId $virtualRouterId +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the virtual router. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +ResourceId of the virtual router. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouterName +The name of the virtual router. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterNameParameterSet +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualRouter + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualRouterPeer.md b/azps-10.1.0/Az.Network/Get-AzVirtualRouterPeer.md new file mode 100644 index 0000000000..440f0dab1c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualRouterPeer.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualrouterpeer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualRouterPeer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualRouterPeer.md +--- + +# Get-AzVirtualRouterPeer + +## SYNOPSIS +Gets a VirtualRouter peer in an Azure VirtualRouter + +## SYNTAX + +### VirtualRouterPeerNameParameterSet (Default) +``` +Get-AzVirtualRouterPeer -ResourceGroupName <String> -PeerName <String> -VirtualRouterName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### VirtualRouterPeerResourceIdParameterSet +``` +Get-AzVirtualRouterPeer -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVirtualRouterPeer** cmdlet gets a Peer in an Azure VirtualRouter + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualRouterPeer -ResourceGroupName virtualRouterRG -VirtualRouterName virtualRouter -PeerName csr +``` + +### Example 2 +```powershell +$virtualRouterPeerId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/virtualRouterRG/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/csr' +Get-AzVirtualRouterPeer -ResourceId $virtualRouterPeerId +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerName +The name of the virtual router peer. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name of the virtual router. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +ResourceId of the virtual router. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualRouterName +The name of the virtual router. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualRouterPeer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualRouterPeerAdvertisedRoute.md b/azps-10.1.0/Az.Network/Get-AzVirtualRouterPeerAdvertisedRoute.md new file mode 100644 index 0000000000..f97965312e --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualRouterPeerAdvertisedRoute.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualrouterpeeradvertisedroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualRouterPeerAdvertisedRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualRouterPeerAdvertisedRoute.md +--- + +# Get-AzVirtualRouterPeerAdvertisedRoute + +## SYNOPSIS +List routes being advertised by specific virtual router peer + +## SYNTAX + +### VirtualRouterPeerNameParameterSet (Default) +``` +Get-AzVirtualRouterPeerAdvertisedRoute -ResourceGroupName <String> -VirtualRouterName <String> + -PeerName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### VirtualRouterPeerObjectParameterSet +``` +Get-AzVirtualRouterPeerAdvertisedRoute -InputObject <PSVirtualRouterPeer> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Given A virtual router peer either by name or by object, enumerate routes being advertised to that peer by a specific virtual router. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualRouterPeerAdvertisedRoute -ResourceGroupName $resourceGroupName -VirtualRouterName $virtualRouterName -PeerName $peerName +``` + +### Example 2 +```powershell +$virtualRouterPeer = Get-AzVirtualRouterPeer -ResourceGroupName $resourceGroupName -VirtualRouterName $virtualRouterName -PeerName $peerName +Get-AzVirtualRouterPeerAdvertisedRoute -InputObject $virtualRouterPeer +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual router peer input object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualRouterPeer +Parameter Sets: VirtualRouterPeerObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PeerName +Virtual router peer name + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Virtual router peer resource group's name + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualRouterName +Virtual router name + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualRouterPeer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPeerRoute + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualRouterPeerLearnedRoute.md b/azps-10.1.0/Az.Network/Get-AzVirtualRouterPeerLearnedRoute.md new file mode 100644 index 0000000000..d8d858dd44 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualRouterPeerLearnedRoute.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualrouterpeerlearnedroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualRouterPeerLearnedRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualRouterPeerLearnedRoute.md +--- + +# Get-AzVirtualRouterPeerLearnedRoute + +## SYNOPSIS +List routes learned by a specific virtual router peer + +## SYNTAX + +### VirtualRouterPeerNameParameterSet (Default) +``` +Get-AzVirtualRouterPeerLearnedRoute -ResourceGroupName <String> -VirtualRouterName <String> -PeerName <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### VirtualRouterPeerObjectParameterSet +``` +Get-AzVirtualRouterPeerLearnedRoute -InputObject <PSVirtualRouterPeer> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Enumerate routes learned by a virtual router peer from other sources. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualRouterPeerLearnedRoute -ResourceGroupName $resourceGroupName -VirtualRouterName $virtualRouterName -PeerName $peerName +``` + +### Example 2 +```powershell +$virtualRouterPeer = Get-AzVirtualRouterPeer -ResourceGroupName $resourceGroupName -VirtualRouterName $virtualRouterName -PeerName $peerName +Get-AzVirtualRouterPeerLearnedRoute -InputObject $virtualRouterPeer +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual router peer input object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualRouterPeer +Parameter Sets: VirtualRouterPeerObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PeerName +Virtual router peer name + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Virtual router peer resource group's name + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualRouterName +Virtual router name + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualRouterPeer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPeerRoute + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualWan.md b/azps-10.1.0/Az.Network/Get-AzVirtualWan.md new file mode 100644 index 0000000000..d362be988c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualWan.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualwan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualWan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualWan.md +--- + +# Get-AzVirtualWan + +## SYNOPSIS +Gets a Virtual WAN or all Virtual WANs in a resource group or subscription. + +## SYNTAX + +### ListBySubscriptionId (Default) +``` +Get-AzVirtualWan [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListByResourceGroupName +``` +Get-AzVirtualWan [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Virtual WAN or all Virtual WANs in a resource group or subscription. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -AllowBranchToBranchTraffic +Get-AzVirtualWan -Name "myVirtualWAN" -ResourceGroupName "testRG" +``` + +```output +Name : myVirtualWAN +Id : /subscriptions/{SubscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +AllowVnetToVnetTraffic : False +AllowBranchToBranchTraffic : True +Location : West US +Type : Microsoft.Network/virtualWans +ProvisioningState : Succeeded +``` + +This command gets the Virtual WAN named myVirtualWAN in the resource group testRG. + +### Example 2 + +```powershell +Get-AzVirtualWan -Name test* +``` + +```output +Name : test1 +Id : /subscriptions/{SubscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/test1 +AllowVnetToVnetTraffic : False +AllowBranchToBranchTraffic : True +Location : West US +Type : Microsoft.Network/virtualWans +ProvisioningState : Succeeded + +Name : test2 +Id : /subscriptions/{SubscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/test2 +AllowVnetToVnetTraffic : False +AllowBranchToBranchTraffic : True +Location : West US +Type : Microsoft.Network/virtualWans +ProvisioningState : Succeeded +``` + +This command gets all Virtual WANs starting with "test". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualWan + +## NOTES + +## RELATED LINKS + +[New-AzVirtualWan](./New-AzVirtualWan.md) + +[Remove-AzVirtualWan](./Remove-AzVirtualWan.md) + +[Update-AzVirtualWan](./Update-AzVirtualWan.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualWanVpnConfiguration.md b/azps-10.1.0/Az.Network/Get-AzVirtualWanVpnConfiguration.md new file mode 100644 index 0000000000..1338588a12 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualWanVpnConfiguration.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualwanvpnconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualWanVpnConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualWanVpnConfiguration.md +--- + +# Get-AzVirtualWanVpnConfiguration + +## SYNOPSIS +Gets the Vpn configuration for a subset of VpnSites connected to this WAN via VpnConnections. Uploads the generated Vpn +configuration to a storage blob specified by the customer. + +## SYNTAX + +### ByVirtualWanNameByVpnSiteObject (Default) +``` +Get-AzVirtualWanVpnConfiguration -ResourceGroupName <String> -Name <String> -StorageSasUrl <String> + -VpnSite <PSVpnSite[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanNameByVpnSiteResourceId +``` +Get-AzVirtualWanVpnConfiguration -ResourceGroupName <String> -Name <String> -StorageSasUrl <String> + -VpnSiteId <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanObjectByVpnSiteObject +``` +Get-AzVirtualWanVpnConfiguration -InputObject <PSVirtualWan> -StorageSasUrl <String> -VpnSite <PSVpnSite[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanObjectByVpnSiteResourceId +``` +Get-AzVirtualWanVpnConfiguration -InputObject <PSVirtualWan> -StorageSasUrl <String> -VpnSiteId <String[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanResourceIdByVpnSiteObject +``` +Get-AzVirtualWanVpnConfiguration -ResourceId <String> -StorageSasUrl <String> -VpnSite <PSVpnSite[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanResourceIdByVpnSiteResourceId +``` +Get-AzVirtualWanVpnConfiguration -ResourceId <String> -StorageSasUrl <String> -VpnSiteId <String[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the Vpn configuration for a subset of VpnSites connected to this WAN via VpnConnections. Uploads the generated Vpn +configuration to a storage blob specified by the customer. + +## EXAMPLES + +### Example 1 +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" + +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" + +$vpnSite = New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" + +New-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite + +$vpnSitesForConfig = New-Object Microsoft.Azure.Commands.Network.Models.PSVpnSite[] 1 +$vpnSitesForConfig[0] = $vpnSite +Get-AzVirtualWanVpnConfiguration -VirtualWan $virtualWan -StorageSasUrl "SignedSasUrl" -VpnSite $vpnSitesForConfig +``` + +```output +SasUrl +------ +SignedSasUrl +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite in West US in "testRG" resource group in Azure. +A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. + +Once the gateway has been created, it is connected to the VpnSite using the New-AzVpnConnection command. + +The configuration is then downloaded using this commandlet. + +If the commandlet is successful, then the download configuration will be written to the blob indicated by the SignedSasUrl. Below is an example for how the URL will look like : +https://[account].blob.core.windows.net/[container]/[path/to/blob]?[SAS] + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The vpn site object to be modified + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan +Parameter Sets: ByVirtualWanObjectByVpnSiteObject, ByVirtualWanObjectByVpnSiteResourceId +Aliases: VirtualWan + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanNameByVpnSiteObject, ByVirtualWanNameByVpnSiteResourceId +Aliases: ResourceName, VirtualWanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanNameByVpnSiteObject, ByVirtualWanNameByVpnSiteResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID for the virtual wan. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanResourceIdByVpnSiteObject, ByVirtualWanResourceIdByVpnSiteResourceId +Aliases: VirtualWanId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSasUrl +The SAS Url for the storage location where the configuration is to be generated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnSite +The list of VpnSite resource ids to generate configuration for. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnSite[] +Parameter Sets: ByVirtualWanNameByVpnSiteObject, ByVirtualWanObjectByVpnSiteObject, ByVirtualWanResourceIdByVpnSiteObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnSiteId +The list of VpnSite resource ids to generate configuration for. + +```yaml +Type: System.String[] +Parameter Sets: ByVirtualWanNameByVpnSiteResourceId, ByVirtualWanObjectByVpnSiteResourceId, ByVirtualWanResourceIdByVpnSiteResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualWan + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualWanVpnSitesConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualWanVpnServerConfiguration.md b/azps-10.1.0/Az.Network/Get-AzVirtualWanVpnServerConfiguration.md new file mode 100644 index 0000000000..b07f70c0ec --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualWanVpnServerConfiguration.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualwanvpnserverconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualWanVpnServerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualWanVpnServerConfiguration.md +--- + +# Get-AzVirtualWanVpnServerConfiguration + +## SYNOPSIS +Gets the list of all VpnServerConfigurations that are associated with this VirtualWan. + +## SYNTAX + +### ByVirtualWanName (Default) +``` +Get-AzVirtualWanVpnServerConfiguration -Name <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualWanObject +``` +Get-AzVirtualWanVpnServerConfiguration -VirtualWanObject <PSVirtualWan> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualWanResourceId +``` +Get-AzVirtualWanVpnServerConfiguration -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVirtualWanVpnServerConfiguration** cmdlet will return the list of all VpnServerConfigurations that are associated with this VirtualWan. i.e. All the VpnServerConfigurations which are attached to any P2SVpnGateways under VirutalHubs of this VirtualWan. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualWanVpnServerConfiguration -Name WestUsVirtualWan -ResourceGroupName P2SCortexGATesting +``` + +```output +VpnServerConfigurationResourceIds : [ + "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/WestUsConfig" ] +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanName +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID for the virtual wan. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanResourceId +Aliases: VirtualWanId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualWanObject +The virtual wan object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan +Parameter Sets: ByVirtualWanObject +Aliases: VirtualWan + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +Microsoft.Azure.Commands.Network.Models.PSVirtualWan + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnServerConfigurationsResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVirtualWanVpnServerConfigurationVpnProfile.md b/azps-10.1.0/Az.Network/Get-AzVirtualWanVpnServerConfigurationVpnProfile.md new file mode 100644 index 0000000000..63f325eff2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVirtualWanVpnServerConfigurationVpnProfile.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvirtualwanvpnserverconfigurationvpnprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualWanVpnServerConfigurationVpnProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVirtualWanVpnServerConfigurationVpnProfile.md +--- + +# Get-AzVirtualWanVpnServerConfigurationVpnProfile + +## SYNOPSIS +Generates and downloads Vpn profile at VirtualWan-VpnServerConfiguration level for Point to site client setup. + +## SYNTAX + +### ByVirtualWanNameByVpnServerConfigurationObject (Default) +``` +Get-AzVirtualWanVpnServerConfigurationVpnProfile [-Name <String>] -ResourceGroupName <String> + -VpnServerConfiguration <PSVpnServerConfiguration> [-AuthenticationMethod <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualWanNameByVpnServerConfigurationResourceId +``` +Get-AzVirtualWanVpnServerConfigurationVpnProfile [-Name <String>] -ResourceGroupName <String> + -VpnServerConfigurationId <String> [-AuthenticationMethod <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByVirtualWanObjectByVpnServerConfigurationObject +``` +Get-AzVirtualWanVpnServerConfigurationVpnProfile -VirtualWanObject <PSVirtualWan> + -VpnServerConfiguration <PSVpnServerConfiguration> [-AuthenticationMethod <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualWanObjectByVpnServerConfigurationResourceId +``` +Get-AzVirtualWanVpnServerConfigurationVpnProfile -VirtualWanObject <PSVirtualWan> + -VpnServerConfigurationId <String> [-AuthenticationMethod <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByVirtualWanResourceIdByVpnServerConfigurationObject +``` +Get-AzVirtualWanVpnServerConfigurationVpnProfile -ResourceId <String> + -VpnServerConfiguration <PSVpnServerConfiguration> [-AuthenticationMethod <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVirtualWanResourceIdByVpnServerConfigurationResourceId +``` +Get-AzVirtualWanVpnServerConfigurationVpnProfile -ResourceId <String> -VpnServerConfigurationId <String> + [-AuthenticationMethod <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVirtualWanVpnServerConfigurationVpnProfile** cmdlet enables you to generate and download the Vpn profile at VirtualWan-VpnServerConfiguration level for Point to site client setup. This is required for Point to site connectivity from Point to site client to Azure P2SVpnGateway. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVirtualWanVpnServerConfigurationVpnProfile -Name WestUsVirtualWan -ResourceGroupName P2SCortexGATesting -VpnServerConfiguration $vpnServerConfig -AuthenticationMethod EAPTLS +``` + +```output +ProfileUrl : https://nfvprodsuppby.blob.core.windows.net/vpnprofileimmutable/aa316f33-d0f6-4e61-994a-9aa24c0e5f70/vpnprofile/eb99aa3d-1106-49eb-9644-791c045c5cca/vpnclientconfiguration.zip?sv=2017-04-17&sr=b&sig=kZinevNqW + qsEAbWAcYiKfUHFxZzh2hwvtb49dfVtUDA%3D&st=2019-10-25T19%3A52%3A36Z&se=2019-10-25T20%3A52%3A36Z&sp=r&fileExtension=.zip +``` + +The above command will generate and returns SAS Url for customer to download the Vpn profile at VirtualWan-VpnServerConfiguration level for Point to site client setup. + +## PARAMETERS + +### -AuthenticationMethod +Authentication Method + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: EAPTLS, EAPMSCHAPv2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanNameByVpnServerConfigurationObject, ByVirtualWanNameByVpnServerConfigurationResourceId +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanNameByVpnServerConfigurationObject, ByVirtualWanNameByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID for the virtual wan. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanResourceIdByVpnServerConfigurationObject, ByVirtualWanResourceIdByVpnServerConfigurationResourceId +Aliases: VirtualWanId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualWanObject +The virtual wan object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan +Parameter Sets: ByVirtualWanObjectByVpnServerConfigurationObject, ByVirtualWanObjectByVpnServerConfigurationResourceId +Aliases: VirtualWan + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VpnServerConfiguration +The VpnServerConfiguration with which this VirtualWan is associated. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration +Parameter Sets: ByVirtualWanNameByVpnServerConfigurationObject, ByVirtualWanObjectByVpnServerConfigurationObject, ByVirtualWanResourceIdByVpnServerConfigurationObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VpnServerConfigurationId +The id of Vpn server configuraiton object this Virtual wan will be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanNameByVpnServerConfigurationResourceId, ByVirtualWanObjectByVpnServerConfigurationResourceId, ByVirtualWanResourceIdByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +Microsoft.Azure.Commands.Network.Models.PSVirtualWan +Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnProfileResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVpnClientConfiguration.md b/azps-10.1.0/Az.Network/Get-AzVpnClientConfiguration.md new file mode 100644 index 0000000000..1868533361 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVpnClientConfiguration.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvpnclientconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnClientConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnClientConfiguration.md +--- + +# Get-AzVpnClientConfiguration + +## SYNOPSIS +Allows users to easily download the Vpn Profile package that was generated using the New-AzVpnClientConfiguration commandlet. + +## SYNTAX + +``` +Get-AzVpnClientConfiguration [-Name <String>] -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzVpnClientConfiguration returns the URL where the VPN client can be downloaded from. + +## EXAMPLES + +### Example 1 +```powershell +New-AzVpnClientConfiguration -Name "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" -AuthenticationMethod "EAPTLS" -RadiusRootCertificateFile "C:\Users\Test\Desktop\VpnProfileRadiusCert.cer" + +Get-AzVpnClientConfiguration -Name "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" +``` + +Gets the URL to download a VpnClient profile that has been previously generated using the New-AzVpnClientConfiguration command. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnProfile + +## NOTES + +## RELATED LINKS + +[New-AzVpnClientConfiguration](./New-AzVpnClientConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVpnClientIpsecParameter.md b/azps-10.1.0/Az.Network/Get-AzVpnClientIpsecParameter.md new file mode 100644 index 0000000000..d9420ae43c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVpnClientIpsecParameter.md @@ -0,0 +1,101 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvpnclientipsecparameter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnClientIpsecParameter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnClientIpsecParameter.md +--- + +# Get-AzVpnClientIpsecParameter + +## SYNOPSIS +Gets the vpn Ipsec parameters set on Virtual Network Gateway for Point to site connections. + +## SYNTAX + +``` +Get-AzVpnClientIpsecParameter [-Name <String>] -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Virtual Network Gateway is the object representing your gateway in Azure. +The **Get-AzVpnClientIpsecParameter** cmdlet returns the object of your vpn ipsec parameters set on gateway in Azure based on Gateway Name and Resource Group Name. + +## EXAMPLES + +### Example 1: Gets the vpn Ipsec parameters set on Virtual Network Gateway for Point to site connections. +```powershell +$VpnClientIPsecParameters = Get-AzVpnClientIpsecParameter -Name myGateway -ResourceGroupName myRG +``` + +Returns the object of the vpn ipsec parameters set on the Virtual Network Gateway with the name "myGateway" within the resource group "myRG" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientIPsecParameters + +## NOTES + +## RELATED LINKS + +[New-AzVpnClientIpsecParameter](./New-AzVpnClientIpsecParameter.md) + +[Remove-AzVpnClientIpsecParameter](./Remove-AzVpnClientIpsecParameter.md) + +[Set-AzVpnClientIpsecParameter](./Set-AzVpnClientIpsecParameter.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVpnClientPackage.md b/azps-10.1.0/Az.Network/Get-AzVpnClientPackage.md new file mode 100644 index 0000000000..ef3744e699 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVpnClientPackage.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 2B4A3E2A-1868-492F-9F77-932319D2CE6D +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvpnclientpackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnClientPackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnClientPackage.md +--- + +# Get-AzVpnClientPackage + +## SYNOPSIS +Gets information about a VPN client package. + +## SYNTAX + +``` +Get-AzVpnClientPackage -ResourceGroupName <String> -VirtualNetworkGatewayName <String> + -ProcessorArchitecture <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVpnClientPackage** cmdlet gets information about the VPN client packages available from a virtual network gateway. +Client packages contain configuration data that enable a client computer to make a VPN connection to an Azure virtual network; client computers must have the correct configuration package installed in order to make a VPN connection. +Different configuration packages are available based on the client computer's version of Windows (for example, Windows 7 or Windows 10) and on the client computer's processor architecture (AMD64 or x86). +You must specify the architecture type when running **Get-AzVpnClientPackage**. + +## EXAMPLES + +### Example 1: Get information about a processor architecture VPN client package +```powershell +Get-AzVpnClientPackage -VirtualNetworkGatewayName "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" -ProcessorArchitecture "Amd64" +``` + +This command gets information about the AMD64 VPN client packages stored on the virtual network gateway named ContosoVirtualNetworkGateway. +To get information about the x86 client packages, set the value of the *ProcessorArchitecture* parameter to x86. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProcessorArchitecture +Specifies the type of CPU architecture that the client package is designed for. +Valid values are Amd64 and X86. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Amd64, X86 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the virtual network gateway is assigned to. +Resource groups categorize items to help simplify inventory management and general Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +Specifies the name of the virtual network gateway where the client package information is stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Resize-AzVirtualNetworkGateway](./Resize-AzVirtualNetworkGateway.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVpnClientRevokedCertificate.md b/azps-10.1.0/Az.Network/Get-AzVpnClientRevokedCertificate.md new file mode 100644 index 0000000000..6ac2cb697d --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVpnClientRevokedCertificate.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 05626BF7-F886-4C76-8FC2-DDF783DEB539 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvpnclientrevokedcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnClientRevokedCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnClientRevokedCertificate.md +--- + +# Get-AzVpnClientRevokedCertificate + +## SYNOPSIS +Gets information about VPN client-revocation certificates. + +## SYNTAX + +``` +Get-AzVpnClientRevokedCertificate [-VpnClientRevokedCertificateName <String>] + -VirtualNetworkGatewayName <String> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVpnClientRevokedCertificate** cmdlet returns information about the client-revocation certificates assigned to a virtual network gateway. +Client-revocation certificates prevent client computers from using the specified certificate for authentication. +**Get-AzVpnClientRevokedCertificate** enables you to return information about all the client-revocation certificates on the gateway or, by using the *VpnClientRevokedCertificateName* parameter, to get information about a single certificate. + +## EXAMPLES + +### Example 1: Get information about all client-revocation certificates +```powershell +Get-AzVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" +``` + +This command gets information about all the client-revocation certificates associated with the virtual network gateway named ContosoVirtualNetworkGateway. + +### Example 2: Get information about specific client-revocation certificates +```powershell +Get-AzVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -VpnClientRevokedCertificateName "ContosoRevokedClientCertificate" +``` + +This command is a variation of the command shown in Example 1. +In this case, however, the *VpnClientRevokedCertificateName* parameter is used to limit the returned data to a specific client-revoked certificate: the certificate with the name ContosoRevokedClientCertificate. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the virtual network gateway is assigned to. +Resource groups categorize items to help simplify inventory management and general Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +Specifies the name of the virtual network gateway where the revoked certificate information is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientRevokedCertificateName +Specifies the name of the VPN client certificate that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate + +## NOTES + +## RELATED LINKS + +[Add-AzVpnClientRevokedCertificate](./Add-AzVpnClientRevokedCertificate.md) + +[New-AzVpnClientRevokedCertificate](./New-AzVpnClientRevokedCertificate.md) + +[Remove-AzVpnClientRevokedCertificate](./Remove-AzVpnClientRevokedCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzVpnClientRootCertificate.md b/azps-10.1.0/Az.Network/Get-AzVpnClientRootCertificate.md new file mode 100644 index 0000000000..6dc58b47cf --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVpnClientRootCertificate.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 16754F70-9619-4F68-86E9-5C8B27812707 +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvpnclientrootcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnClientRootCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnClientRootCertificate.md +--- + +# Get-AzVpnClientRootCertificate + +## SYNOPSIS +Gets information about VPN root certificates. + +## SYNTAX + +``` +Get-AzVpnClientRootCertificate [-VpnClientRootCertificateName <String>] -VirtualNetworkGatewayName <String> + -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVpnClientRootCertificate** cmdlet returns information about the root certificates assigned to a virtual network gateway. +Root certificates are X.509 certificates that identify your Root Certification Authority: all other certificates used on the gateway trust the root certificate. +By default, **Get-AzVpnClientRootCertificate** returns information about all the root certificates assigned to a gateway. +(Gateways can have more than one root certificate.) However, by including the **VpnClientRootCertificateName** parameter you can limit the returned data to a specific certificate. + +## EXAMPLES + +### Example 1: Get information about all root certificates +```powershell +Get-AzVpnClientRootCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" +``` + +This command gets information about all the root certificates assigned to a virtual network gateway named ContosoVirtualNetwork. + +### Example 2: Get information about specific root certificates +```powershell +Get-AzVpnClientRootCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -VpnClientRootCertificateName "ContosoRootClientCertificate" +``` + +This command is a variation of the command shown in Example 1. +In this case, however, the *VpnClientRootCertificateName* parameter is included in order to limit the returned data to a specific root certificate: ContosoRootClientCertificate. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the virtual network gateway is assigned to. +Resource groups categorize items to help simplify inventory management and general Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +Specifies the name of the virtual network gateway where the root certificate is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientRootCertificateName +Specifies the name of the client root certificate that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate + +## NOTES + +## RELATED LINKS + +[Add-AzVpnClientRootCertificate](./Add-AzVpnClientRootCertificate.md) + +[New-AzVpnClientRootCertificate](./New-AzVpnClientRootCertificate.md) + +[Remove-AzVpnClientRootCertificate](./Remove-AzVpnClientRootCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Get-AzVpnConnection.md b/azps-10.1.0/Az.Network/Get-AzVpnConnection.md new file mode 100644 index 0000000000..5daedc57a1 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVpnConnection.md @@ -0,0 +1,284 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvpnconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnConnection.md +--- + +# Get-AzVpnConnection + +## SYNOPSIS +Gets a vpn connection by name or lists all vpn connections connected to a VpnGateway. + +>[!NOTE] +> This Powershell command is for customers using Virtual WAN Site-to-site VPN Gateway only. + +## SYNTAX + +### ByVpnGatewayName (Default) +``` +Get-AzVpnConnection -ResourceGroupName <String> -ParentResourceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVpnGatewayObject +``` +Get-AzVpnConnection -ParentObject <PSVpnGateway> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByVpnGatewayResourceId +``` +Get-AzVpnConnection -ParentResourceId <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a vpn connection by name or lists all vpn connections connected to a VpnGateway. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" + +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" + +$vpnSite = New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" + +New-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite +Get-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" +``` + +```output +RemoteVpnSite : Microsoft.Azure.Commands.Network.Models.PSResourceId +SharedKey : +VpnConnectionProtocolType : IKEv2 +ConnectionStatus : +EgressBytesTransferred : 0 +IngressBytesTransferred : 0 +IpsecPolicies : {} +ConnectionBandwidth : 20 +EnableBgp : False +ProvisioningState : testConnection +Name : ps9709 +Etag : W/"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +Id : /subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/vpnGateways/testvpngw/vpnConnections/testConnection +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite in West US in "testRG" resource group in Azure. +A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. + +Once the gateway has been created, it is connected to the VpnSite using the New-AzVpnConnection command. + +Then it gets the connection using the connection name. + +### Example 2 + +```powershell +Get-AzVpnConnection -ResourceGroupName ps9361 -ParentResourceName testvpngw -Name test* +``` + +```output +RemoteVpnSite : Microsoft.Azure.Commands.Network.Models.PSResourceId +SharedKey : +VpnConnectionProtocolType : IKEv2 +ConnectionStatus : +EgressBytesTransferred : 0 +IngressBytesTransferred : 0 +IpsecPolicies : {} +ConnectionBandwidth : 20 +EnableBgp : False +ProvisioningState : testConnection +Name : ps9709 +Etag : W/"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +Id : /subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/vpnGateways/testvpngw/vpnConnections/testConnection1 +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } + +RemoteVpnSite : Microsoft.Azure.Commands.Network.Models.PSResourceId +SharedKey : +VpnConnectionProtocolType : IKEv2 +ConnectionStatus : +EgressBytesTransferred : 0 +IngressBytesTransferred : 0 +IpsecPolicies : {} +ConnectionBandwidth : 20 +EnableBgp : False +ProvisioningState : testConnection +Name : ps9709 +Etag : W/"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +Id : /subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/vpnGateways/testvpngw/vpnConnections/testConnection2 +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +This cmdlet gets all connections that start with "test". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VpnConnectionName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ParentObject +The parent VpnGateway for this connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnGateway +Parameter Sets: ByVpnGatewayObject +Aliases: ParentVpnGateway, VpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The resource id of the parent VpnGateway for this connection. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayResourceId +Aliases: ParentVpnGatewayId, VpnGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: ParentVpnGatewayName, VpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnConnection + +## NOTES + +## RELATED LINKS + +[New-AzVpnConnection](./New-AzVpnConnection.md) + +[Remove-AzVpnConnection](./Remove-AzVpnConnection.md) + +[Update-AzVpnConnection](./Update-AzVpnConnection.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVpnGateway.md b/azps-10.1.0/Az.Network/Get-AzVpnGateway.md new file mode 100644 index 0000000000..59e0cb34fd --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVpnGateway.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvpngateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnGateway.md +--- + +# Get-AzVpnGateway + +## SYNOPSIS +Gets a VpnGateway resource using ResourceGroupName and GatewayName OR lists all gateways by ResourceGroupName or SubscriptionId. + +## SYNTAX + +### ListBySubscriptionId (Default) +``` +Get-AzVpnGateway [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListByResourceGroupName +``` +Get-AzVpnGateway [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a VpnGateway resource using ResourceGroupName and GatewayName OR lists all gateways by ResourceGroupName or SubscriptionId. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" +``` + +```output +ResourceGroupName : testRG +Name : testvpngw +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnGateways/testvpngw +Location : West US +VpnGatewayScaleUnit : 2 +VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/Ali_pS_Test/providers/Microsoft.Network/virtualHubs/westushub +BgpSettings : {} +IpConfigurations : {Instance0, Instance1} +Type : Microsoft.Network/vpnGateways +ProvisioningState : Succeeded +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in West US in "testRG" resource group in Azure. +A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. + +It then gets the VpnGateway using its resourceGroupName and the gateway name. + +### Example 2 + +```powershell +Get-AzVpnGateway -Name test* +``` + +```output +ResourceGroupName : testRG +Name : test1 +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnGateways/test1 +Location : West US +VpnGatewayScaleUnit : 2 +VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/Ali_pS_Test/providers/Microsoft.Network/virtualHubs/westushub +BgpSettings : {} +IpConfigurations : {Instance0, Instance1} +Type : Microsoft.Network/vpnGateways +ProvisioningState : Succeeded + +ResourceGroupName : testRG +Name : test2 +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnGateways/test2 +Location : West US +VpnGatewayScaleUnit : 2 +VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/Ali_pS_Test/providers/Microsoft.Network/virtualHubs/westushub +BgpSettings : {} +IpConfigurations : {Instance0, Instance1} +Type : Microsoft.Network/vpnGateways +ProvisioningState : Succeeded +``` + +This cmdlet gets all Gateways that start with "test". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: ResourceName, VpnGatewayName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGateway + +## NOTES + +## RELATED LINKS + +[New-AzVpnGateway](./New-AzVpnGateway.md) + +[Remove-AzVpnGateway](./Remove-AzVpnGateway.md) + +[Update-AzVpnGateway](./Update-AzVpnGateway.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVpnGatewayNatRule.md b/azps-10.1.0/Az.Network/Get-AzVpnGatewayNatRule.md new file mode 100644 index 0000000000..640ee507fd --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVpnGatewayNatRule.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvpngatewaynatrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnGatewayNatRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnGatewayNatRule.md +--- + +# Get-AzVpnGatewayNatRule + +## SYNOPSIS +Gets a NAT rule associated with VpnGateway. + +## SYNTAX + +### ByVpnGatewayName (Default) +``` +Get-AzVpnGatewayNatRule -ResourceGroupName <String> -ParentResourceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVpnGatewayObject +``` +Get-AzVpnGatewayNatRule -ParentObject <PSVpnGateway> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVpnGatewayResourceId +``` +Get-AzVpnGatewayNatRule -ParentResourceId <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a NAT rule associated with VpnGateway. + +## EXAMPLES + +### Example + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" +New-AzVpnGatewayNatRule -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testNatRule" -Type Static -Mode EgressSnat -InternalMapping "10.0.0.1/26" -ExternalMapping "192.168.0.0/26" +Get-AzVpnGatewayNatRule -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testNatRule" +``` + +```output +Type : Static +Mode : EgressSnat +VpnConnectionProtocolType : IKEv2 +InternalMappings : 10.0.0.1/26 +ExternalMappings : 192.168.0.0/26 +IpConfigurationId : +IngressVpnSiteLinkConnections : [Microsoft.Azure.Commands.Network.Models.PSResourceId] +EgressVpnSiteLinkConnections : [Microsoft.Azure.Commands.Network.Models.PSResourceId] +ProvisioningState : Provisioned +Name : ps9709 +Etag : W/"4580a2e2-2fab-4cff-88eb-92013a76b5a8" +Id : /subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/vpnGateways/testvpngw/natRules/testNatRule +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and VpnGateway & a NAT rule associated with Vpngateway. +Then it gets the NAT rule using the NAT rule name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VpnGatewayNatRuleName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ParentObject +The parent VpnGateway for this VpnGatewayNatRule. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnGateway +Parameter Sets: ByVpnGatewayObject +Aliases: ParentVpnGateway, VpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The resource id of the parent VpnGateway for this VpnGatewayNatRule. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayResourceId +Aliases: ParentVpnGatewayId, VpnGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: ParentVpnGatewayName, VpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGatewayNatRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVpnServerConfiguration.md b/azps-10.1.0/Az.Network/Get-AzVpnServerConfiguration.md new file mode 100644 index 0000000000..2a11f9b4d2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVpnServerConfiguration.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvpnserverconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnServerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnServerConfiguration.md +--- + +# Get-AzVpnServerConfiguration + +## SYNOPSIS +Gets an existing VpnServerConfiguration for point to site connectivity. + +## SYNTAX + +### ListBySubscriptionId (Default) +``` +Get-AzVpnServerConfiguration [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListByResourceGroupName +``` +Get-AzVpnServerConfiguration [-ResourceGroupName <String>] [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVpnServerConfiguration** cmdlet returns the existing VpnServerConfiguration for Point to site connectivity. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVpnServerConfiguration -ResourceGroupName P2SCortexGATesting -Name test1config +``` + +```output +ResourceGroupName : P2SCortexGATesting +Name : test1config +Id : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/test1config +Location : westus +VpnProtocols : {IkeV2, OpenVPN} +VpnAuthenticationTypes : {Certificate} +VpnClientRootCertificates : +VpnClientRevokedCertificates : [ + { + "Name": "cert2", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] +RadiusServerAddress : +RadiusServerRootCertificates : [] +RadiusClientRootCertificates : [] +VpnClientIpsecPolicies : [] +AadAuthenticationParameters : null +P2sVpnGateways : [] +Type : Microsoft.Network/vpnServerConfigurations +ProvisioningState : Succeeded +``` + +The above command will get the existing VpnServerConfiguration. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: ResourceName, VpnServerConfigurationName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Get-AzVpnServerConfigurationPolicyGroup.md b/azps-10.1.0/Az.Network/Get-AzVpnServerConfigurationPolicyGroup.md new file mode 100644 index 0000000000..c97b37142a --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVpnServerConfigurationPolicyGroup.md @@ -0,0 +1,460 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvpnserverconfigurationpolicygroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnServerConfigurationPolicyGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnServerConfigurationPolicyGroup.md +--- + +# New-AzP2sVpnGateway + +## SYNOPSIS +Create a new P2SVpnGateway under VirtualHub for point to site connectivity. + +## SYNTAX + +### ByVirtualHubNameByVpnServerConfigurationObject (Default) +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubName <String> [-VpnServerConfiguration <PSVpnServerConfiguration>] + [-VpnClientAddressPool <String[]>] [-CustomDnsServer <String[]>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] [-DisableInternetSecurityFlag] + [-EnableRoutingPreferenceInternetFlag] [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubNameByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubName <String> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObjectByVpnServerConfigurationObject +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHub <PSVirtualHub> [-VpnServerConfiguration <PSVpnServerConfiguration>] + [-VpnClientAddressPool <String[]>] [-CustomDnsServer <String[]>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] [-DisableInternetSecurityFlag] + [-EnableRoutingPreferenceInternetFlag] [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubObjectByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHub <PSVirtualHub> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByVpnServerConfigurationObject +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubId <String> [-VpnServerConfiguration <PSVpnServerConfiguration>] [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubId <String> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzP2sVpnGateway cmdlet enables you to create a new P2SVpnGateway under VirtualHub for Point to site connectivity from Point to site clients to Azure VirtualWan. + +## EXAMPLES + +### Example 1 +```powershell +$virtualHub = Get-AzVirtualHub -ResourceGroupName P2SCortexGATesting -Name WestUsVirtualHub +$vpnServerConfig1 = Get-AzVpnServerConfiguration -ResourceGroupName P2SCortexGATesting -Name WestUsConfig +$vpnClientAddressSpaces = New-Object string[] 1 +$vpnClientAddressSpaces[0] = "192.168.2.0/24" +$createdP2SVpnGateway = New-AzP2sVpnGateway -ResourceGroupName P2SCortexGATesting -Name 683482ade8564515aed4b8448c9757ea-westus-gw -VirtualHub $virtualHub -VpnGatewayScaleUnit 1 -VpnClientAddressPool $vpnClientAddressSpaces -VpnServerConfiguration $vpnServerConfig1 -EnableInternetSecurityFlag -EnableRoutingPreferenceInternetFlag +``` + +```output +ResourceGroupName : P2SCortexGATesting +Name : 683482ade8564515aed4b8448c9757ea-westus-gw +Id : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482ade8564515a + ed4b8448c9757ea-westus-gw +Location : westus +VpnGatewayScaleUnit : 1 +VirtualHub : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub +VpnServerConfiguration : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/WestUsConfig +VpnServerConfigurationLocation : +VpnClientConnectionHealth : null +Type : Microsoft.Network/p2sVpnGateways +ProvisioningState : Succeeded +P2SConnectionConfigurations : [ + { + "ProvisioningState": "Succeeded", + "VpnClientAddressPool": { + "AddressPrefixes": [ + "192.168.2.0/24" + ] + }, + "EnableInternetSecurity": True, + "RoutingConfiguration": { + "AssociatedRouteTable": { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + }, + "Name": "P2SConnectionConfigDefault", + "Etag": "W/\"4b96e6a2-b4d8-46b3-9210-76d40f359bef\"", + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482 + ade8564515aed4b8448c9757ea-westus-gw/p2sConnectionConfigurations/P2SConnectionConfigDefault" + } + ] +``` + +The New-AzP2sVpnGateway cmdlet enables you to create a new P2SVpnGateway under VirtualHub for Point to site connectivity. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```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 +``` + +### -CustomDnsServer +The list of Custom Dns Servers. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableInternetSecurityFlag +Flag to disable internet security feature on this P2SVpnGateway P2SConnectionConfiguration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternetSecurityFlag +Enable internet security flag for this P2SVpnGateway connections + +```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 +``` + +### -EnableRoutingPreferenceInternetFlag +Flag to enable Routing Preference Internet on this P2SVpnGateway. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, P2SVpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -P2SConnectionConfiguration +The list of P2SConnectionConfigurations that this P2SVpnGateway needs to have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSP2SConnectionConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingConfiguration +Routing configuration for this connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObjectByVpnServerConfigurationObject, ByVirtualHubObjectByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubId +The Id of the VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceIdByVpnServerConfigurationObject, ByVirtualHubResourceIdByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualHubName +The Id of the VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationObject, ByVirtualHubNameByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnClientAddressPool +P2S VpnClient AddressPool for this P2SVpnGateway P2SConnectionConfiguration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnGatewayScaleUnit +The scale unit for this P2SVpnGateway. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnServerConfiguration +The VpnServerConfiguration to be attached to this P2SVpnGateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationObject, ByVirtualHubObjectByVpnServerConfigurationObject, ByVirtualHubResourceIdByVpnServerConfigurationObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VpnServerConfigurationId +The id of Vpn server configuration object this P2SVpnGateway will be attached to. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationResourceId, ByVirtualHubObjectByVpnServerConfigurationResourceId, ByVirtualHubResourceIdByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub +System.String Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +## NOTES + +## RELATED LINKS + +[New-AzRoutingConfiguration]() + diff --git a/azps-10.1.0/Az.Network/Get-AzVpnSite.md b/azps-10.1.0/Az.Network/Get-AzVpnSite.md new file mode 100644 index 0000000000..3d6908a9f0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVpnSite.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvpnsite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnSite.md +--- + +# Get-AzVpnSite + +## SYNOPSIS +Gets an Azure VpnSite resource by name OR lists all VpnSites in a ResourceGroup or SubscriptionId. + +This is an RM representation of customer branches that are uploaded to Azure for S2S connectivity with a Cortex virtual hub. + +## SYNTAX + +### ListBySubscriptionId (Default) +``` +Get-AzVpnSite [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListByResourceGroupName +``` +Get-AzVpnSite [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an Azure VpnSite resource by name OR lists all VpnSites in a ResourceGroup or SubscriptionId. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" +New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" +Get-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" +``` + +```output +ResourceGroupName : testRG +Name : testVpnSite +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnSites/testVpnSite +Location : eastus2euap +IpAddress : 1.2.3.4 +VirtualWan : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +AddressSpace : {192.168.2.0/24, 192.168.3.0/24} +BgpSettings : +Type : Microsoft.Network/vpnSites +ProvisioningState : Succeeded +``` + +The above will create a resource group, Virtual WAN in West US in "testRG" resource group in Azure. + +Then it creates a VpnSite to represent a customer branch and links it to the Virtual WAN. + +Once the site is created, it gets the site using the Get-AzVpnSite command. + +### Example 2 + +```powershell +Get-AzVpnSite -Name test* +``` + +```output +ResourceGroupName : testRG +Name : testVpnSite1 +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnSites/testVpnSite1 +Location : eastus2euap +IpAddress : 1.2.3.4 +VirtualWan : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +AddressSpace : {192.168.2.0/24, 192.168.3.0/24} +BgpSettings : +Type : Microsoft.Network/vpnSites +ProvisioningState : Succeeded + +ResourceGroupName : testRG +Name : testVpnSite2 +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnSites/testVpnSite2 +Location : eastus2euap +IpAddress : 1.2.3.4 +VirtualWan : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +AddressSpace : {192.168.2.0/24, 192.168.3.0/24} +BgpSettings : +Type : Microsoft.Network/vpnSites +ProvisioningState : Succeeded +``` + +This cmdlet gets all Sites that start with "test". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: ResourceName, VpnSiteName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnSite + +## NOTES + +## RELATED LINKS + +[New-AzVpnSite](./New-AzVpnSite.md) + +[Remove-AzVpnSite](./Remove-AzVpnSite.md) + +[Update-AzVpnSite](./Update-AzVpnSite.md) diff --git a/azps-10.1.0/Az.Network/Get-AzVpnSiteLinkConnectionIkeSa.md b/azps-10.1.0/Az.Network/Get-AzVpnSiteLinkConnectionIkeSa.md new file mode 100644 index 0000000000..4aececfa0c --- /dev/null +++ b/azps-10.1.0/Az.Network/Get-AzVpnSiteLinkConnectionIkeSa.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/get-azvpnsitelinkconnectionikesa +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnSiteLinkConnectionIkeSa.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Get-AzVpnSiteLinkConnectionIkeSa.md +--- + +# Get-AzVpnSiteLinkConnectionIkeSa + +## SYNOPSIS +Get IKE Security Associations of VPN Site Link Connections + +## SYNTAX + +### ByName (Default) +``` +Get-AzVpnSiteLinkConnectionIkeSa -ResourceGroupName <String> -VpnGatewayName <String> + -VpnConnectionName <String> -Name <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByInputObject +``` +Get-AzVpnSiteLinkConnectionIkeSa -InputObject <PSVpnSiteLinkConnection> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzVpnSiteLinkConnectionIkeSa -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzVpnSiteLinkConnectionIkeSa** cmdlet returns the IKE Security Associations of your VPN Link Connection based on the VPN Site Link Connection Name, VPN Connection Name, VPN Gateway Name and Resource Group Name. +If the **Get-AzVpnSiteLinkConnectionIkeSa** cmdlet is issued without specifying any of the aforementioned parameters, the output will not show the IKE Security Associations. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzVpnSiteLinkConnectionIkeSa -ResourceGroupName test-rg -VpnGatewayName test-gateway -VpnConnectionName test-connection -ResourceName test-linkConnection +``` + +```output +LocalEndpoint : 52.148.27.69 +RemoteEndpoint : 13.78.223.113 +InitiatorCookie : 10994953846917485010 +ResponderCookie : 4652217515638795111 +LocalUdpEncapsulationPort : 0 +RemoteUdpEncapsulationPort : 0 +Encryption : AES256 +Integrity : SHA1 +DhGroup : DHGroup2 +LifeTimeSeconds : 28800 +IsSaInitiator : True +ElapsedTimeInseconds : 21437 +Quick Mode SA : 1 item(s) +``` + +Returns the IKE Security Associations for the VPN Site Link Connection with the name "test-linkConnection" within the resource group "test-rg" + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Vpn site link connection object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnSiteLinkConnection +Parameter Sets: ByInputObject +Aliases: VpnSiteLinkConnection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Vpn site link connection name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ResourceName, VpnSiteLinkConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the Vpn site link connection for which IKE Security Associations needs to be fetched. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnConnectionName +The Vpn connection name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ParentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnGatewayName +The Vpn gateway name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: GrandParentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnSiteLinkConnection + +### System.String + +## OUTPUTS + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.Cortex.PSVpnSiteLinkConnectionIkeSaMainModeSa, Microsoft.Azure.PowerShell.Cmdlets.Network, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic.md b/azps-10.1.0/Az.Network/Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic.md new file mode 100644 index 0000000000..7f223f87c0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic.md @@ -0,0 +1,315 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/invoke-aznetworkwatchernetworkconfigurationdiagnostic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic.md +--- + +# Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic + +## SYNOPSIS +Invoke network configuration diagnostic session for specified network profiles on target resource. + +## SYNTAX + +### SetByResource (Default) +``` +Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic -NetworkWatcher <PSNetworkWatcher> + -TargetResourceId <String> [-VerbosityLevel <String>] + -Profile <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkConfigurationDiagnosticProfile]> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByName +``` +Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic -NetworkWatcherName <String> -ResourceGroupName <String> + -TargetResourceId <String> [-VerbosityLevel <String>] + -Profile <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkConfigurationDiagnosticProfile]> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic -Location <String> -TargetResourceId <String> + [-VerbosityLevel <String>] + -Profile <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkConfigurationDiagnosticProfile]> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic -ResourceId <String> -TargetResourceId <String> + [-VerbosityLevel <String>] + -Profile <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkConfigurationDiagnosticProfile]> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic cmdlet invoke network configuration diagnostic session for specified network profiles on target resource. + +## EXAMPLES + +### Example 1: Invoke network configuration diagnostic session for VM and specified network profile +```powershell +$profile = New-AzNetworkWatcherNetworkConfigurationDiagnosticProfile -Direction Inbound -Protocol Tcp -Source 10.1.1.4 -Destination * -DestinationPort 50 +Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic -Location eastus -TargetResourceId /subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgEastUS/providers/Microsoft.Compute/virtualMachines/vm1 -Profile $profile +``` + +```output +Results : [ + { + "Profile": { + "Direction": "Inbound", + "Protocol": "Tcp", + "Source": "10.1.1.4", + "Destination": "*", + "DestinationPort": "50" + }, + "NetworkSecurityGroupResult": { + "SecurityRuleAccessResult": "Allow", + "EvaluatedNetworkSecurityGroups": [ + { + "NetworkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/clean + upservice/providers/Microsoft.Network/networkSecurityGroups/rg-cleanupservice-nsg1", + "MatchedRule": { + "RuleName": "UserRule_Cleanuptool-Allow-4001", + "Action": "Allow" + }, + "RulesEvaluationResult": [ + { + "Name": "UserRule_Cleanuptool-Allow-100", + "ProtocolMatched": true, + "SourceMatched": false, + "SourcePortMatched": true, + "DestinationMatched": true, + "DestinationPortMatched": false + }, +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Profile +List of network configuration diagnostic profiles. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkConfigurationDiagnosticProfile] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceId +The ID of the target resource to perform network configuration diagnostic. +Valid options are VM, NetworkInterface, VMSS/NetworkInterface and Application Gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VerbosityLevel +Verbosity level. +Accepted values are 'Normal', 'Minimum', 'Full'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkConfigurationDiagnosticResponse + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, watcher, diagnostic, profile + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Move-AzExpressRouteCircuit.md b/azps-10.1.0/Az.Network/Move-AzExpressRouteCircuit.md new file mode 100644 index 0000000000..1117108a64 --- /dev/null +++ b/azps-10.1.0/Az.Network/Move-AzExpressRouteCircuit.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: F845ED42-A7C1-4CCC-9AD8-E9A91C3EEC7A +online version: https://learn.microsoft.com/powershell/module/az.network/move-azexpressroutecircuit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Move-AzExpressRouteCircuit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Move-AzExpressRouteCircuit.md +--- + +# Move-AzExpressRouteCircuit + +## SYNOPSIS +Moves an ExpressRoute circuit from the classic deployment model to the Resource Manager deployment model. + +## SYNTAX + +``` +Move-AzExpressRouteCircuit -Name <String> -ResourceGroupName <String> -Location <String> -ServiceKey <String> + [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Move-AzExpressRouteCircuit** cmdlet moves an ExpressRoute circuit from the classic +deployment model to the Resource Manager deployment model. After the move, the ExpressRoute circuit +behaves and performs like any other ExpressRoute circuit that is created in the Resource Manager +deployment model. Circuit links, virtual networks, and VPN gateways are not moved through this +operation. Those resources need to be reconfigured after the move. + +## EXAMPLES + +### Example 1: Move an ExpressRoute circuit to the Resource Manager deployment model +```powershell +Move-AzExpressRouteCircuit -Name $CircuitName -ResourceGroupName $RG -Location $Location -ServiceKey $ServiceKey +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The name of the Azure location where the ExpressRoute circuit resides. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the ExpressRoute circuit to be moved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that will contain the ExpressRoute circuit being moved. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceKey +The Service Key used by the ExpressRoute circuit in the classic deployment model. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuit](./Get-AzExpressRouteCircuit.md) + +[New-AzExpressRouteCircuit](./New-AzExpressRouteCircuit.md) + +[Remove-AzExpressRouteCircuit](./Remove-AzExpressRouteCircuit.md) + +[Set-AzExpressRouteCircuit](./Set-AzExpressRouteCircuit.md) diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGateway.md b/azps-10.1.0/Az.Network/New-AzApplicationGateway.md new file mode 100644 index 0000000000..4f25507433 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGateway.md @@ -0,0 +1,915 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 1F5066C6-9756-47B4-886C-C52755809926 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGateway.md +--- + +# New-AzApplicationGateway + +## SYNOPSIS +Creates an application gateway. + +## SYNTAX + +### IdentityByUserAssignedIdentityId (Default) +``` +New-AzApplicationGateway -Name <String> -ResourceGroupName <String> -Location <String> + -Sku <PSApplicationGatewaySku> [-SslPolicy <PSApplicationGatewaySslPolicy>] + -GatewayIPConfigurations <PSApplicationGatewayIPConfiguration[]> + [-SslCertificates <PSApplicationGatewaySslCertificate[]>] + [-AuthenticationCertificates <PSApplicationGatewayAuthenticationCertificate[]>] + [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>] + [-TrustedClientCertificates <PSApplicationGatewayTrustedClientCertificate[]>] + [-FrontendIPConfigurations <PSApplicationGatewayFrontendIPConfiguration[]>] + -FrontendPorts <PSApplicationGatewayFrontendPort[]> [-Probes <PSApplicationGatewayProbe[]>] + -BackendAddressPools <PSApplicationGatewayBackendAddressPool[]> + [-BackendHttpSettingsCollection <PSApplicationGatewayBackendHttpSettings[]>] + [-BackendSettingsCollection <PSApplicationGatewayBackendSettings[]>] + [-SslProfiles <PSApplicationGatewaySslProfile[]>] [-HttpListeners <PSApplicationGatewayHttpListener[]>] + [-Listeners <PSApplicationGatewayListener[]>] [-UrlPathMaps <PSApplicationGatewayUrlPathMap[]>] + [-RequestRoutingRules <PSApplicationGatewayRequestRoutingRule[]>] + [-RoutingRules <PSApplicationGatewayRoutingRule[]>] [-RewriteRuleSet <PSApplicationGatewayRewriteRuleSet[]>] + [-RedirectConfigurations <PSApplicationGatewayRedirectConfiguration[]>] + [-WebApplicationFirewallConfiguration <PSApplicationGatewayWebApplicationFirewallConfiguration>] + [-AutoscaleConfiguration <PSApplicationGatewayAutoscaleConfiguration>] [-EnableHttp2] [-EnableFIPS] + [-ForceFirewallPolicyAssociation] [-Zone <String[]>] [-Tag <Hashtable>] [-UserAssignedIdentityId <String>] + [-Force] [-AsJob] [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>] + [-PrivateLinkConfiguration <PSApplicationGatewayPrivateLinkConfiguration[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzApplicationGateway -Name <String> -ResourceGroupName <String> -Location <String> + -Sku <PSApplicationGatewaySku> [-SslPolicy <PSApplicationGatewaySslPolicy>] + -GatewayIPConfigurations <PSApplicationGatewayIPConfiguration[]> + [-SslCertificates <PSApplicationGatewaySslCertificate[]>] + [-AuthenticationCertificates <PSApplicationGatewayAuthenticationCertificate[]>] + [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>] + [-TrustedClientCertificates <PSApplicationGatewayTrustedClientCertificate[]>] + [-FrontendIPConfigurations <PSApplicationGatewayFrontendIPConfiguration[]>] + -FrontendPorts <PSApplicationGatewayFrontendPort[]> [-Probes <PSApplicationGatewayProbe[]>] + -BackendAddressPools <PSApplicationGatewayBackendAddressPool[]> + [-BackendHttpSettingsCollection <PSApplicationGatewayBackendHttpSettings[]>] + [-BackendSettingsCollection <PSApplicationGatewayBackendSettings[]>] + [-SslProfiles <PSApplicationGatewaySslProfile[]>] [-HttpListeners <PSApplicationGatewayHttpListener[]>] + [-Listeners <PSApplicationGatewayListener[]>] [-UrlPathMaps <PSApplicationGatewayUrlPathMap[]>] + [-RequestRoutingRules <PSApplicationGatewayRequestRoutingRule[]>] + [-RoutingRules <PSApplicationGatewayRoutingRule[]>] [-RewriteRuleSet <PSApplicationGatewayRewriteRuleSet[]>] + [-RedirectConfigurations <PSApplicationGatewayRedirectConfiguration[]>] + [-WebApplicationFirewallConfiguration <PSApplicationGatewayWebApplicationFirewallConfiguration>] + [-FirewallPolicyId <String>] [-AutoscaleConfiguration <PSApplicationGatewayAutoscaleConfiguration>] + [-EnableHttp2] [-EnableFIPS] [-ForceFirewallPolicyAssociation] [-Zone <String[]>] [-Tag <Hashtable>] [-Force] + [-AsJob] [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>] + [-PrivateLinkConfiguration <PSApplicationGatewayPrivateLinkConfiguration[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResource +``` +New-AzApplicationGateway -Name <String> -ResourceGroupName <String> -Location <String> + -Sku <PSApplicationGatewaySku> [-SslPolicy <PSApplicationGatewaySslPolicy>] + -GatewayIPConfigurations <PSApplicationGatewayIPConfiguration[]> + [-SslCertificates <PSApplicationGatewaySslCertificate[]>] + [-AuthenticationCertificates <PSApplicationGatewayAuthenticationCertificate[]>] + [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>] + [-TrustedClientCertificates <PSApplicationGatewayTrustedClientCertificate[]>] + [-FrontendIPConfigurations <PSApplicationGatewayFrontendIPConfiguration[]>] + -FrontendPorts <PSApplicationGatewayFrontendPort[]> [-Probes <PSApplicationGatewayProbe[]>] + -BackendAddressPools <PSApplicationGatewayBackendAddressPool[]> + [-BackendHttpSettingsCollection <PSApplicationGatewayBackendHttpSettings[]>] + [-BackendSettingsCollection <PSApplicationGatewayBackendSettings[]>] + [-SslProfiles <PSApplicationGatewaySslProfile[]>] [-HttpListeners <PSApplicationGatewayHttpListener[]>] + [-Listeners <PSApplicationGatewayListener[]>] [-UrlPathMaps <PSApplicationGatewayUrlPathMap[]>] + [-RequestRoutingRules <PSApplicationGatewayRequestRoutingRule[]>] + [-RoutingRules <PSApplicationGatewayRoutingRule[]>] [-RewriteRuleSet <PSApplicationGatewayRewriteRuleSet[]>] + [-RedirectConfigurations <PSApplicationGatewayRedirectConfiguration[]>] + [-WebApplicationFirewallConfiguration <PSApplicationGatewayWebApplicationFirewallConfiguration>] + [-FirewallPolicy <PSApplicationGatewayWebApplicationFirewallPolicy>] + [-AutoscaleConfiguration <PSApplicationGatewayAutoscaleConfiguration>] [-EnableHttp2] [-EnableFIPS] + [-ForceFirewallPolicyAssociation] [-Zone <String[]>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>] + [-PrivateLinkConfiguration <PSApplicationGatewayPrivateLinkConfiguration[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdentityByIdentityObject +``` +New-AzApplicationGateway -Name <String> -ResourceGroupName <String> -Location <String> + -Sku <PSApplicationGatewaySku> [-SslPolicy <PSApplicationGatewaySslPolicy>] + -GatewayIPConfigurations <PSApplicationGatewayIPConfiguration[]> + [-SslCertificates <PSApplicationGatewaySslCertificate[]>] + [-AuthenticationCertificates <PSApplicationGatewayAuthenticationCertificate[]>] + [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>] + [-TrustedClientCertificates <PSApplicationGatewayTrustedClientCertificate[]>] + [-FrontendIPConfigurations <PSApplicationGatewayFrontendIPConfiguration[]>] + -FrontendPorts <PSApplicationGatewayFrontendPort[]> [-Probes <PSApplicationGatewayProbe[]>] + -BackendAddressPools <PSApplicationGatewayBackendAddressPool[]> + [-BackendHttpSettingsCollection <PSApplicationGatewayBackendHttpSettings[]>] + [-BackendSettingsCollection <PSApplicationGatewayBackendSettings[]>] + [-SslProfiles <PSApplicationGatewaySslProfile[]>] [-HttpListeners <PSApplicationGatewayHttpListener[]>] + [-Listeners <PSApplicationGatewayListener[]>] [-UrlPathMaps <PSApplicationGatewayUrlPathMap[]>] + [-RequestRoutingRules <PSApplicationGatewayRequestRoutingRule[]>] + [-RoutingRules <PSApplicationGatewayRoutingRule[]>] [-RewriteRuleSet <PSApplicationGatewayRewriteRuleSet[]>] + [-RedirectConfigurations <PSApplicationGatewayRedirectConfiguration[]>] + [-WebApplicationFirewallConfiguration <PSApplicationGatewayWebApplicationFirewallConfiguration>] + [-AutoscaleConfiguration <PSApplicationGatewayAutoscaleConfiguration>] [-EnableHttp2] [-EnableFIPS] + [-ForceFirewallPolicyAssociation] [-Zone <String[]>] [-Tag <Hashtable>] -Identity <PSManagedServiceIdentity> + [-Force] [-AsJob] [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>] + [-PrivateLinkConfiguration <PSApplicationGatewayPrivateLinkConfiguration[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGateway** cmdlet creates an Azure application gateway. +An application gateway requires the following: +- A resource group. +- A virtual network. +- A back-end server pool, containing the IP addresses of the back-end servers. +- Back-end server pool settings. Each pool has settings such as port, protocol and cookie-based affinity, that are applied to all servers within the pool. +- Front-end IP addresses, which are the IP addresses opened on the application gateway. A front-end IP address can be a public IP address or an internal IP address. +- Front-end ports, which are the public ports opened on the application gateway. Traffic that hits these ports is redirected to the back-end servers. +- A request routing rule that binds the listener and the back-end server pool. The rule defines which back-end server pool the traffic should be directed to when it hits a particular listener. +A listener has a front-end port, front-end IP address, protocol (HTTP or HTTPS) and Secure Sockets +Layer (SSL) certificate name (if configuring SSL offload). + +## EXAMPLES + +### Example 1: Create an application gateway +```powershell +$ResourceGroup = New-AzResourceGroup -Name "ResourceGroup01" -Location "West US" -Tag @{Name = "Department"; Value = "Marketing"} +$Subnet = New-AzVirtualNetworkSubnetConfig -Name "Subnet01" -AddressPrefix 10.0.0.0/24 +$VNet = New-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -Location "West US" -AddressPrefix 10.0.0.0/16 -Subnet $Subnet +$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" +$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet +$GatewayIPconfig = New-AzApplicationGatewayIPConfiguration -Name "GatewayIp01" -Subnet $Subnet +$Pool = New-AzApplicationGatewayBackendAddressPool -Name "Pool01" -BackendIPAddresses 10.10.10.1, 10.10.10.2, 10.10.10.3 +$PoolSetting = New-AzApplicationGatewayBackendHttpSetting -Name "PoolSetting01" -Port 80 -Protocol "Http" -CookieBasedAffinity "Disabled" +$FrontEndPort = New-AzApplicationGatewayFrontendPort -Name "FrontEndPort01" -Port 80 +# Create a public IP address +$PublicIp = New-AzPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIpName01" -Location "West US" -AllocationMethod "Dynamic" +$FrontEndIpConfig = New-AzApplicationGatewayFrontendIPConfig -Name "FrontEndConfig01" -PublicIPAddress $PublicIp +$Listener = New-AzApplicationGatewayHttpListener -Name "ListenerName01" -Protocol "Http" -FrontendIpConfiguration $FrontEndIpConfig -FrontendPort $FrontEndPort +$Rule = New-AzApplicationGatewayRequestRoutingRule -Name "Rule01" -RuleType basic -BackendHttpSettings $PoolSetting -HttpListener $Listener -BackendAddressPool $Pool +$Sku = New-AzApplicationGatewaySku -Name "Standard_Small" -Tier Standard -Capacity 2 +$Gateway = New-AzApplicationGateway -Name "AppGateway01" -ResourceGroupName "ResourceGroup01" -Location "West US" -BackendAddressPools $Pool -BackendHttpSettingsCollection $PoolSetting -FrontendIpConfigurations $FrontEndIpConfig -GatewayIpConfigurations $GatewayIpConfig -FrontendPorts $FrontEndPort -HttpListeners $Listener -RequestRoutingRules $Rule -Sku $Sku +``` + +The following example creates an application gateway by first creating a resource group and a +virtual network, as well as the following: +- A back-end server pool +- Back-end server pool settings +- Front-end ports +- Front-end IP addresses +- A request routing rule +These four commands create a virtual network. +The first command creates a subnet configuration. +The second command creates a virtual network. +The third command verifies the subnet configuration and the fourth command verifies that the virtual network is created successfully. +The following commands create the application gateway. +The first command creates an IP configuration named GatewayIp01 for the subnet created previously. +The second command creates a back-end server pool named Pool01 with a list of back-end IP addresses and stores the pool in the $Pool variable. +The third command creates the settings for the back-end server pool and stores the settings in the $PoolSetting variable. +The forth command creates a front-end port on port 80, names it FrontEndPort01, and stores the port in the $FrontEndPort variable. +The fifth command creates a public IP address by using New-AzPublicIpAddress. +The sixth command creates a front-end IP configuration using $PublicIp, names it FrontEndPortConfig01, and stores it in the $FrontEndIpConfig variable. +The seventh command creates a listener using the previously created $FrontEndIpConfig $FrontEndPort. +The eighth command creates a rule for the listener. +The ninth command sets the SKU. +The tenth command creates the gateway using the objects set by the previous commands. + +### Example 2: Create an application gateway with UserAssigned Identity +```powershell +$ResourceGroup = New-AzResourceGroup -Name "ResourceGroup01" -Location "West US" -Tag @{Name = "Department"; Value = "Marketing"} +$Subnet = New-AzVirtualNetworkSubnetConfig -Name "Subnet01" -AddressPrefix 10.0.0.0/24 +$VNet = New-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -Location "West US" -AddressPrefix 10.0.0.0/16 -Subnet $Subnet +$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" +$Subnet = Get-AzVirtualNetworkSubnetConfig -Name $Subnet01 -VirtualNetwork $VNet +$GatewayIPconfig = New-AzApplicationGatewayIPConfiguration -Name "GatewayIp01" -Subnet $Subnet +$Pool = New-AzApplicationGatewayBackendAddressPool -Name "Pool01" -BackendIPAddresses 10.10.10.1, 10.10.10.2, 10.10.10.3 +$PoolSetting = New-AzApplicationGatewayBackendHttpSetting -Name "PoolSetting01" -Port 80 -Protocol "Http" -CookieBasedAffinity "Disabled" +$FrontEndPort = New-AzApplicationGatewayFrontendPort -Name "FrontEndPort01" -Port 80 +# Create a public IP address +$PublicIp = New-AzPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIpName01" -Location "West US" -AllocationMethod "Dynamic" +$FrontEndIpConfig = New-AzApplicationGatewayFrontendIPConfig -Name "FrontEndConfig01" -PublicIPAddress $PublicIp +$Listener = New-AzApplicationGatewayHttpListener -Name "ListenerName01" -Protocol "Http" -FrontendIpConfiguration $FrontEndIpConfig -FrontendPort $FrontEndPort +$Rule = New-AzApplicationGatewayRequestRoutingRule -Name "Rule01" -RuleType basic -BackendHttpSettings $PoolSetting -HttpListener $Listener -BackendAddressPool $Pool +$Sku = New-AzApplicationGatewaySku -Name "Standard_Small" -Tier Standard -Capacity 2 +$Identity = New-AzUserAssignedIdentity -Name "Identity01" -ResourceGroupName "ResourceGroup01" -Location "West US" +$AppgwIdentity = New-AzApplicationGatewayIdentity -UserAssignedIdentity $Identity.Id +$Gateway = New-AzApplicationGateway -Name "AppGateway01" -ResourceGroupName "ResourceGroup01" -Location "West US" -Identity $AppgwIdentity -BackendAddressPools $Pool -BackendHttpSettingsCollection $PoolSetting -FrontendIpConfigurations $FrontEndIpConfig -GatewayIpConfigurations $GatewayIpConfig -FrontendPorts $FrontEndPort -HttpListeners $Listener -RequestRoutingRules $Rule -Sku $Sku +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationCertificates +Specifies authentication certificates for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutoscaleConfiguration +Autoscale Configuration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAutoscaleConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendAddressPools +Specifies the list of back-end address pools for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendHttpSettingsCollection +Specifies the list of back-end HTTP settings for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendSettingsCollection +The list of backend settings + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendSettings[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CustomErrorConfiguration +Customer error of an application gateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFIPS +Whether FIPS is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableHttp2 +Whether HTTP2 is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicy +Firewall configuration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallPolicy +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicyId +FirewallPolicyId + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceFirewallPolicyAssociation +Whether Force firewallPolicy association is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIPConfigurations +Specifies a list of front-end IP configurations for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPorts +Specifies a list of front-end ports for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GatewayIPConfigurations +Specifies a list of IP configurations for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayIPConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HttpListeners +Specifies a list of HTTP listeners for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Identity +Application Gateway Identity to be assigned to Application Gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity +Parameter Sets: IdentityByIdentityObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Listeners +The list of listener + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayListener[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the region in which to create the application gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of application gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateLinkConfiguration +The list of privateLink Configuration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Probes +Specifies probes for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RedirectConfigurations +The list of redirect configuration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RequestRoutingRules +Specifies a list of request routing rules for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group in which to create the application gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RewriteRuleSet +The list of RewriteRuleSet + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleSet[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoutingRules +The list of routing rule + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRoutingRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Specifies the stock keeping unit (SKU) of the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SslCertificates +Specifies the list of Secure Sockets Layer (SSL) certificates for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SslPolicy +Specifies an SSL policy for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SslProfiles +The list of ssl profiles + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TrustedClientCertificates +The list of trusted client CA certificate chains + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedClientCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TrustedRootCertificate +The list of trusted root certificates + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UrlPathMaps +Specifies URL path maps for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +ResourceId of the user assigned identity to be assigned to Application Gateway. + +```yaml +Type: System.String +Parameter Sets: IdentityByUserAssignedIdentityId +Aliases: UserAssignedIdentity + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WebApplicationFirewallConfiguration +Specifies a web application firewall (WAF) configuration. You can use the +Get-AzApplicationGatewayWebApplicationFirewallConfiguration cmdlet to get a WAF. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +A list of availability zones denoting where the application gateway needs to come from. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayIPConfiguration[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleSet[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallConfiguration + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAutoscaleConfiguration + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayBackendAddressPool](./New-AzApplicationGatewayBackendAddressPool.md) + +[New-AzApplicationGatewayBackendHttpSetting](./New-AzApplicationGatewayBackendHttpSetting.md) + +[New-AzApplicationGatewayFrontendIPConfig](./New-AzApplicationGatewayFrontendIPConfig.md) + +[New-AzApplicationGatewayFrontendPort](./New-AzApplicationGatewayFrontendPort.md) + +[New-AzApplicationGatewayHttpListener](./New-AzApplicationGatewayHttpListener.md) + +[New-AzApplicationGatewayIPConfiguration](./New-AzApplicationGatewayIPConfiguration.md) + +[New-AzApplicationGatewayRequestRoutingRule](./New-AzApplicationGatewayRequestRoutingRule.md) + +[New-AzApplicationGatewaySku](./New-AzApplicationGatewaySku.md) + +[New-AzVirtualNetwork](./New-AzVirtualNetwork.md) + +[New-AzVirtualNetworkSubnetConfig](./New-AzVirtualNetworkSubnetConfig.md) diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayAuthenticationCertificate.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayAuthenticationCertificate.md new file mode 100644 index 0000000000..25e5d35276 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayAuthenticationCertificate.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 4736FA0D-222D-4D69-BCBD-72036303A20E +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayauthenticationcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayAuthenticationCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayAuthenticationCertificate.md +--- + +# New-AzApplicationGatewayAuthenticationCertificate + +## SYNOPSIS +Creates an authentication certificate for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayAuthenticationCertificate -Name <String> -CertificateFile <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayAuthenticationCertificate** cmdlet creates an authentication certificate for an Azure application gateway. + +## EXAMPLES + +### Example 1: Create an authentication certificate +```powershell +$cert = New-AzApplicationGatewayAuthenticationCertificate -Name "cert01" -CertificateFile "C:\cert.cer" +``` + +The first command creates authentication certificate named cert01. + +## PARAMETERS + +### -CertificateFile +Specifies the path of the authentication certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the authentication certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Add-AzApplicationGatewayAuthenticationCertificate](./Add-AzApplicationGatewayAuthenticationCertificate.md) + +[Get-AzApplicationGatewayAuthenticationCertificate](./Get-AzApplicationGatewayAuthenticationCertificate.md) + +[Remove-AzApplicationGatewayAuthenticationCertificate](./Remove-AzApplicationGatewayAuthenticationCertificate.md) + +[Set-AzApplicationGatewayAuthenticationCertificate](./Set-AzApplicationGatewayAuthenticationCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayAutoscaleConfiguration.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayAutoscaleConfiguration.md new file mode 100644 index 0000000000..48e7eb5ac0 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayAutoscaleConfiguration.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayautoscaleconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayAutoscaleConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayAutoscaleConfiguration.md +--- + +# New-AzApplicationGatewayAutoscaleConfiguration + +## SYNOPSIS +Creates a Autoscale Configuration for the Application Gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayAutoscaleConfiguration -MinCapacity <Int32> [-MaxCapacity <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayAutoscaleConfiguration** cmdlet creates Autoscale Configuration for an Azure application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$AutoscaleConfig = New-AzApplicationGatewayAutoscaleConfiguration -MinCapacity 3 +$Gateway = New-AzApplicationGateway -Name "AppGateway01" -ResourceGroupName "ResourceGroup01" -Location "West US" -BackendAddressPools $Pool -BackendHttpSettingsCollection $PoolSetting -FrontendIpConfigurations $FrontEndIpConfig -GatewayIpConfigurations $GatewayIpConfig -FrontendPorts $FrontEndPort -HttpListeners $Listener -RequestRoutingRules $Rule -Sku $Sku -AutoscaleConfiguration $AutoscaleConfig +``` + +The first command creates an autoscale configuration with minimum capacity 3. +The second command creates an application gateway with the autoscale configuration. + +### Example 2 + +```powershell +$gw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$gw.Sku.Capacity = $null +$gw.AutoscaleConfiguration = New-AzApplicationGatewayAutoscaleConfiguration -MinCapacity 2 -MaxCapacity 4 +$gw = Set-AzApplicationGateway -ApplicationGateway $gw +``` + +The first command gets the configuration of the Application Gateway into a variable. +The second command clears the SKU Capacity variable to allow the Autoscale Configuration to be set. +The third command specifies a new AutoScale Configuration for the Application Gateway. +The fourth command applies the new configuration to the Application Gateway. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCapacity +Maximum capacity units that will always be available [and charged] for application gateway. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinCapacity +Minimum capacity units that will always be available [and charged] for application gateway. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAutoscaleConfiguration + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayAutoscaleConfiguration](./Get-AzApplicationGatewayAutoscaleConfiguration.md) + +[Remove-AzApplicationGatewayAutoscaleConfiguration](./Remove-AzApplicationGatewayAutoscaleConfiguration.md) + +[Set-AzApplicationGatewayAutoscaleConfiguration](./Set-AzApplicationGatewayAutoscaleConfiguration.md) diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayBackendAddressPool.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayBackendAddressPool.md new file mode 100644 index 0000000000..68b1fc5ea8 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayBackendAddressPool.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C257E62F-1535-4626-A12B-F4572D00BB13 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewaybackendaddresspool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayBackendAddressPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayBackendAddressPool.md +--- + +# New-AzApplicationGatewayBackendAddressPool + +## SYNOPSIS +Creates a back-end address pool for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayBackendAddressPool -Name <String> [-BackendIPAddresses <String[]>] + [-BackendFqdns <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayBackendAddressPool** cmdlet creates a back-end address pool for an Azure application gateway. +A back-end address can be specified as an IP address, a fully-qualified domain name (FQDN) or an IP configuration ID. + +## EXAMPLES + +### Example 1: Create a back-end address pool by using the FQDN of a back-end server +```powershell +$Pool = New-AzApplicationGatewayBackendAddressPool -Name "Pool01" -BackendFqdns "contoso1.com", "contoso2.com" +``` + +This command creates a back-end address pool named Pool01 by using the FQDNs of back-end servers, and stores it in the $Pool variable. + +### Example 2: Create a back-end address pool by using the IP address of a back-end server +```powershell +$Pool = New-AzApplicationGatewayBackendAddressPool -Name "Pool02" -BackendFqdns "10.10.10.10", "10.10.10.11" +``` + +This command creates a back-end address pool named Pool02 by using the IP addresses of back-end servers, and stores it in the $Pool variable. + +## PARAMETERS + +### -BackendFqdns +Specifies a list of back-end FQDNs that this cmdlet associates with the back-end server pool. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendIPAddresses +Specifies a list of back-end IP addresses that this cmdlet associates with the back-end server pool. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the back-end server pool that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayBackendAddressPool](./Add-AzApplicationGatewayBackendAddressPool.md) + +[Get-AzApplicationGatewayBackendAddressPool](./Get-AzApplicationGatewayBackendAddressPool.md) + +[Remove-AzApplicationGatewayBackendAddressPool](./Remove-AzApplicationGatewayBackendAddressPool.md) + +[Set-AzApplicationGatewayBackendAddressPool](./Set-AzApplicationGatewayBackendAddressPool.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayBackendHttpSetting.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayBackendHttpSetting.md new file mode 100644 index 0000000000..ef2dab29cd --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayBackendHttpSetting.md @@ -0,0 +1,306 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewaybackendhttpsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayBackendHttpSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayBackendHttpSetting.md +--- + +# New-AzApplicationGatewayBackendHttpSetting + +## SYNOPSIS +Creates back-end HTTP setting for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayBackendHttpSetting -Name <String> -Port <Int32> -Protocol <String> + -CookieBasedAffinity <String> [-RequestTimeout <Int32>] + [-ConnectionDraining <PSApplicationGatewayConnectionDraining>] [-ProbeId <String>] + [-Probe <PSApplicationGatewayProbe>] + [-AuthenticationCertificates <PSApplicationGatewayAuthenticationCertificate[]>] + [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>] [-PickHostNameFromBackendAddress] + [-HostName <String>] [-AffinityCookieName <String>] [-Path <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzApplicationGatewayBackendHttpSetting cmdlet creates back-end HTTP settings for an application gateway. +Back-end HTTP settings are applied to all back-end servers in a pool. + +## EXAMPLES + +### Example 1: Create back-end HTTP settings +```powershell +$Setting = New-AzApplicationGatewayBackendHttpSetting -Name "Setting01" -Port 80 -Protocol Http -CookieBasedAffinity Disabled +``` + +This command creates back-end HTTP settings named Setting01 on port 80, using the HTTP protocol, with cookie-based affinity disabled. +The settings are stored in the $Setting variable. + +### Example 2 + +Creates back-end HTTP setting for an application gateway. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzApplicationGatewayBackendHttpSetting -CookieBasedAffinity Enabled -Name 'Setting01' -PickHostNameFromBackendAddress -Port 80 -Probe <PSApplicationGatewayProbe> -Protocol http -RequestTimeout <Int32> +``` + +## PARAMETERS + +### -AffinityCookieName +Cookie name to use for the affinity cookie + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationCertificates +Specifies authentication certificates for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionDraining +Connection draining of the backend http settings resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CookieBasedAffinity +Specifies whether cookie-based affinity should be enabled or disabled for the back-end server pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +Sets host header to be sent to the backend servers. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the back-end HTTP settings that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Path which should be used as a prefix for all HTTP requests. +If no value is provided for this parameter, then no path will be prefixed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PickHostNameFromBackendAddress +Flag if host header should be picked from the host name of the backend server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Specifies the port of the back-end server pool. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Probe +Specifies a probe to associate with the back-end server pool. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeId +Specifies the ID of the probe to associate with the back-end server pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol to use for communication between the application gateway and the back-end servers. +The acceptable values for this parameter are: Http and Https. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestTimeout +Specifies a request time-out value. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedRootCertificate +Application gateway Trusted Root Certificates + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayBackendHttpSetting](./Add-AzApplicationGatewayBackendHttpSetting.md) + +[Get-AzApplicationGatewayBackendHttpSetting](./Get-AzApplicationGatewayBackendHttpSetting.md) + +[Remove-AzApplicationGatewayBackendHttpSetting](./Remove-AzApplicationGatewayBackendHttpSetting.md) + +[Set-AzApplicationGatewayBackendHttpSetting](./Set-AzApplicationGatewayBackendHttpSetting.md) + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayBackendSetting.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayBackendSetting.md new file mode 100644 index 0000000000..f6913152f1 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayBackendSetting.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewaybackendsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayBackendSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayBackendSetting.md +--- + +# New-AzApplicationGatewayBackendSetting + +## SYNOPSIS +Creates back-end TCP\TLS setting for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayBackendSetting -Name <String> -Port <Int32> -Protocol <String> [-Timeout <Int32>] + [-ProbeId <String>] [-Probe <PSApplicationGatewayProbe>] + [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>] [-PickHostNameFromBackendAddress] + [-HostName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzApplicationGatewayBackendSetting cmdlet creates back-end TCP\TLS settings for an application gateway. +Back-end settings are applied to all back-end servers in a pool. + +## EXAMPLES + +### Example 1: Create back-end TCP\TLS settings +```powershell +$Setting = New-AzApplicationGatewayBackendSetting -Name "Setting01" -Port 80 -Protocol Tcp +``` + +This command creates back-end settings named Setting01 on port 80, using the Tcp protocol +The settings are stored in the $Setting variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +Sets host header to be sent to the backend servers. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the backend settings + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PickHostNameFromBackendAddress +Flag if host header should be picked from the host name of the backend server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Port + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Probe +Application gateway Probe + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeId +ID of the application gateway Probe + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TCP, TLS + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +Timeout. +Default value 30 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedRootCertificate +Application gateway Trusted Root Certificates + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendSettings + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayBackendSetting](./Add-AzApplicationGatewayBackendSetting.md) + +[Get-AzApplicationGatewayBackendSetting](./Get-AzApplicationGatewayBackendSetting.md) + +[Remove-AzApplicationGatewayBackendSetting](./Remove-AzApplicationGatewayBackendSetting.md) + +[Set-AzApplicationGatewayBackendSetting](./Set-AzApplicationGatewayBackendSetting.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayClientAuthConfiguration.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayClientAuthConfiguration.md new file mode 100644 index 0000000000..fdb2edab34 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayClientAuthConfiguration.md @@ -0,0 +1,101 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayclientauthconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayClientAuthConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayClientAuthConfiguration.md +--- + +# New-AzApplicationGatewayClientAuthConfiguration + +## SYNOPSIS +Creates a new client authentication configuration for SSL profile. + +## SYNTAX + +``` +New-AzApplicationGatewayClientAuthConfiguration [-VerifyClientCertIssuerDN] [-VerifyClientRevocation <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayClientAuthConfiguration** cmdlet creates a new client authentication configuration for SSL profile. + +## EXAMPLES + +### Example 1 +```powershell +$clientAuthConfig = New-AzApplicationGatewayClientAuthConfiguration -VerifyClientCertIssuerDN -VerifyClientRevocation OCSP +``` + +The command create a new client auth configuration and stores it in $clientAuthConfig variable to be used in a SSL profile. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VerifyClientCertIssuerDN +Verify client certificate issuer name. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VerifyClientRevocation +Verify client certificate revocation status. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, OCSP + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayClientAuthConfiguration + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayClientAuthConfiguration](./Get-AzApplicationGatewayClientAuthConfiguration.md) + +[Remove-AzApplicationGatewayClientAuthConfiguration](./Remove-AzApplicationGatewayClientAuthConfiguration.md) + +[Set-AzApplicationGatewayClientAuthConfiguration](./Set-AzApplicationGatewayClientAuthConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayConnectionDraining.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayConnectionDraining.md new file mode 100644 index 0000000000..1c71009a7e --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayConnectionDraining.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayconnectiondraining +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayConnectionDraining.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayConnectionDraining.md +--- + +# New-AzApplicationGatewayConnectionDraining + +## SYNOPSIS +Creates a new connection draining configuration for back-end HTTP settings. + +## SYNTAX + +``` +New-AzApplicationGatewayConnectionDraining -Enabled <Boolean> -DrainTimeoutInSec <Int32> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayConnectionDraining** cmdlet creates a new connection draining configuration for back-end HTTP settings. + +## EXAMPLES + +### Example 1 +```powershell +$connectionDraining = New-AzApplicationGatewayConnectionDraining -Enabled $True -DrainTimeoutInSec 42 +``` + +The command creates a new connection draining configuration with Enabled set to True and DrainTimeoutInSec set to 42 seconds and stores it in $connectionDraining. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DrainTimeoutInSec +The number of seconds connection draining is active. +Acceptable values are from 1 second to 3600 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Whether connection draining is enabled or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayConnectionDraining](./Get-AzApplicationGatewayConnectionDraining.md) + +[Remove-AzApplicationGatewayConnectionDraining](./Remove-AzApplicationGatewayConnectionDraining.md) + +[Set-AzApplicationGatewayConnectionDraining](./Set-AzApplicationGatewayConnectionDraining.md) + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayCustomError.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayCustomError.md new file mode 100644 index 0000000000..b9ae868852 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayCustomError.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewaycustomerror +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayCustomError.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayCustomError.md +--- + +# New-AzApplicationGatewayCustomError + +## SYNOPSIS +Creates a custom error with http status code and custom error page url + +## SYNTAX + +``` +New-AzApplicationGatewayCustomError -StatusCode <String> -CustomErrorPageUrl <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayCustomError** cmdlet creates a custom error. + +## EXAMPLES + +### Example 1 +```powershell +$customError403Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/403-another.htm" +$ce = New-AzApplicationGatewayCustomError -StatusCode HttpStatus403 -CustomErrorPageUrl $customError403Url +``` + +This command creates the custom error of http status code 403. + +## PARAMETERS + +### -CustomErrorPageUrl +Error page URL of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusCode +Status code of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayCustomError](./Add-AzApplicationGatewayCustomError.md) + +[Get-AzApplicationGatewayCustomError](./Get-AzApplicationGatewayCustomError.md) + +[Remove-AzApplicationGatewayCustomError](./Remove-AzApplicationGatewayCustomError.md) + +[Set-AzApplicationGatewayCustomError](./Set-AzApplicationGatewayCustomError.md) diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallCondition.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallCondition.md new file mode 100644 index 0000000000..973d8eddad --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallCondition.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallcondition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallCondition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallCondition.md +--- + +# New-AzApplicationGatewayFirewallCondition + +## SYNOPSIS +Creates a match condition for custom rule + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallCondition -MatchVariable <PSApplicationGatewayFirewallMatchVariable[]> + -Operator <String> [-NegationCondition <Boolean>] [-MatchValue <String[]>] [-Transform <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallCondition** creates a match condition for firewall custom rule. + +## EXAMPLES + +### Example 1 +```powershell +$condition = New-AzApplicationGatewayFirewallCondition -MatchVariable $variable -Operator Contains -NegationCondition false -Transform Lowercase, Trim -MatchValue abc, cde +``` + +The command creates a new match condition using the match variable defined in the $variable, the operator is Contains and negation condition is false, Transfroms including lowercase and trim, the match value is abc and cde. The new match condition is saved in $condition. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchValue +Match value. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchVariable +List of match variables. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallMatchVariable[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NegationCondition +Describes if this is negate condition or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operator +Describes operator to be matched. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPMatch, Equal, Contains, LessThan, GreaterThan, LessThanOrEqual, GreaterThanOrEqual, BeginsWith, EndsWith, Regex, GeoMatch, Any + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Transform +List of transforms. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: Uppercase, Lowercase, Trim, UrlDecode, UrlEncode, RemoveNulls, HtmlEntityDecode + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCondition + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallCustomRule.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallCustomRule.md new file mode 100644 index 0000000000..b86466c7c7 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallCustomRule.md @@ -0,0 +1,295 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallcustomrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallCustomRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallCustomRule.md +--- + +# New-AzApplicationGatewayFirewallCustomRule + +## SYNOPSIS +Creates a new custom rule for the application gateway firewall policy. + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallCustomRule -Name <String> -Priority <Int32> [-RateLimitDuration <String>] + [-RateLimitThreshold <Int32>] -RuleType <String> -MatchCondition <PSApplicationGatewayFirewallCondition[]> + [-GroupByUserSession <PSApplicationGatewayFirewallCustomRuleGroupByUserSession[]>] -Action <String> + [-State <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallCustomRule** creates a custom rule for firewall policy. + +## EXAMPLES + +### Example 1 +```powershell +New-AzApplicationGatewayFirewallCustomRule -Name example-rule -Priority 1 -RuleType MatchRule -MatchCondition $condtion -Action Allow +``` + +```output +Name : example-rule +Priority : 1 +RuleType : MatchRule +MatchConditions : {Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCondition} +Action : Allow +State : Enabled +MatchConditionsText : [ + { + "MatchVariables": [ + { + "VariableName": "RequestHeaders", + "Selector": "Malicious-Header" + } + ], + "OperatorProperty": "Any", + "NegationConditon": false + } + ] +``` + +The command creates a new custom rule with name of example-rule, priority 1 and the rule type will be MatchRule with condition defined in the condition variable, the action will the allow. + +### Example 2 +```powershell +New-AzApplicationGatewayFirewallCustomRule -Name example-rule -Priority 2 -RuleType MatchRule -MatchCondition $condition -Action Allow -State Disabled +``` + +```output +Name : example-rule +Priority : 2 +RuleType : MatchRule +MatchConditions : {Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCondition} +Action : Allow +State : Disabled +MatchConditionsText : [ + { + "MatchVariables": [ + { + "VariableName": "RequestHeaders", + "Selector": "Malicious-Header" + } + ], + "OperatorProperty": "Any", + "NegationConditon": false + } + ] +``` + +The command creates a new custom rule with name of example-rule, state as Disabled, priority 2 and the rule type will be MatchRule with condition defined in the condition variable, the action will the allow. + +### Example 3 +```powershell +New-AzApplicationGatewayFirewallCustomRule -Name RateLimitRule3 -Priority 3 -RateLimitDuration OneMin -RateLimitThreshold 10 -RuleType RateLimitRule -MatchCondition $condition -GroupByUserSession $groupbyUserSes -Action Allow -State Disabled +``` + +```output +Name : RateLimitRule3 +Priority : 3 +RateLimitDuration : OneMin +RateLimitThreshold : 10 +RuleType : RateLimitRule +MatchConditions : {Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCondition} +GroupByUserSession : {Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCustomRuleGroupByUserSession} +Action : Allow +State : Disabled +MatchConditionsText : [ + { + "MatchVariables": [ + { + "VariableName": "RequestHeaders", + "Selector": "Malicious-Header" + } + ], + "OperatorProperty": "Any", + "NegationConditon": false + } + ] +GroupByUserSessionText : [ + { + "groupByVariables": [ + { + "variableName": "ClientAddr" + } + ] + } + ] +``` + +The command creates a new custom rule with name of RateLimitRule3, state as Disabled, priority 3, RateLimitDuration OneMin, RateLimitThreshold 10 and the rule type will be RateLimitRule with condition defined in the condition variable, the action will the allow, the GroupByUserSession defined in the GroupByUserSession condition variable. + +## PARAMETERS + +### -Action +Type of Actions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Block, Log + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByUserSession +List of match conditions. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCustomRuleGroupByUserSession[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchCondition +List of match conditions. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCondition[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name of the Rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Describes priority of the rule. +Rules with a lower value will be evaluated before rules with a higher value. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RateLimitDuration +Describes duration over which Rate Limit policy will be applied. Applies only when ruleType is RateLimitRule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: OneMin, FiveMins + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RateLimitThreshold +Describes rate limit threshold. Applies only when ruleType is RateLimitRule.Accepted range for this value is 1 - 5000. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleType +Describes type of rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: MatchRule, RateLimitRule + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +State variable of the custom rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, Enabled + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCustomRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallCustomRuleGroupByUserSession.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallCustomRuleGroupByUserSession.md new file mode 100644 index 0000000000..6af18e2617 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallCustomRuleGroupByUserSession.md @@ -0,0 +1,80 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallcustomrulegroupbyusersession +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallCustomRuleGroupByUserSession.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallCustomRuleGroupByUserSession.md +--- + +# New-AzApplicationGatewayFirewallCustomRuleGroupByUserSession + +## SYNOPSIS +Creates a new GroupByUserSession for the application gateway firewall custom rule. + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallCustomRuleGroupByUserSession + -GroupByVariable <PSApplicationGatewayFirewallCustomRuleGroupByVariable[]> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallCustomRuleGroupByUserSession** creates a new GroupByUserSession for the application gateway firewall custom rule. + +## EXAMPLES + +### Example 1 +```powershell +New-AzApplicationGatewayFirewallCustomRuleGroupByUserSession -GroupByVariable $groupbyVar +``` + +The command creates a new GroupByUserSession, with the GroupByVariables condition named groupbyVar + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByVariable +Define user session group by clause variables. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCustomRuleGroupByVariable[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCustomRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallCustomRuleGroupByVariable.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallCustomRuleGroupByVariable.md new file mode 100644 index 0000000000..5028f11fe7 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallCustomRuleGroupByVariable.md @@ -0,0 +1,80 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallcustomrulegroupbyvariable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallCustomRuleGroupByVariable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallCustomRuleGroupByVariable.md +--- + +# New-AzApplicationGatewayFirewallCustomRuleGroupByVariable + +## SYNOPSIS +Creates a new GroupByVariable for the application gateway firewall custom rule GroupByUserSession. + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallCustomRuleGroupByVariable -VariableName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallCustomRuleGroupByVariable** creates a new GroupByVariable for the application gateway firewall custom rule GroupByUserSession. + +## EXAMPLES + +### Example 1 +```powershell +New-AzApplicationGatewayFirewallCustomRuleGroupByVariable -VariableName ClientAddr +``` + +The command creates a new GroupByVariable, with the VariableName ClientAddr + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VariableName +User Session clause variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: ClientAddr, Geo, None + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCustomRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallDisabledRuleGroupConfig.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallDisabledRuleGroupConfig.md new file mode 100644 index 0000000000..256b776539 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallDisabledRuleGroupConfig.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewalldisabledrulegroupconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallDisabledRuleGroupConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallDisabledRuleGroupConfig.md +--- + +# New-AzApplicationGatewayFirewallDisabledRuleGroupConfig + +## SYNOPSIS +Creates a new disabled rule group configuration. + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallDisabledRuleGroupConfig -RuleGroupName <String> [-Rules <Int32[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallDisabledRuleGroupConfig** cmdlet creates a new disabled rule group configuration. + +## EXAMPLES + +### Example 1 +```powershell +$disabledRuleGroup1 = New-AzApplicationGatewayFirewallDisabledRuleGroupConfig -RuleGroupName "REQUEST-942-APPLICATION-ATTACK-SQLI" -Rules 942130,942140 +``` + +The command creates a new disabled rule group configuration for the rule group named "REQUEST-942-APPLICATION-ATTACK-SQLI" with rule 942130 and rule 942140 being disabled. The new disabled rule group configuration is saved in $disabledRuleGroup1. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleGroupName +The name of the rule group that will be disabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rules +The list of rules that will be disabled. +If null, all rules of the rule group will be disabled. + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallDisabledRuleGroup + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayWebApplicationFirewallConfiguration](./New-AzApplicationGatewayWebApplicationFirewallConfiguration.md) + +[Set-AzApplicationGatewayWebApplicationFirewallConfiguration](./Set-AzApplicationGatewayWebApplicationFirewallConfiguration.md) + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallExclusionConfig.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallExclusionConfig.md new file mode 100644 index 0000000000..8c5144b2f6 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallExclusionConfig.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallexclusionconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallExclusionConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallExclusionConfig.md +--- + +# New-AzApplicationGatewayFirewallExclusionConfig + +## SYNOPSIS +Creates a new exclusion rule list for application gateway waf + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallExclusionConfig -Variable <String> -Operator <String> -Selector <String> + [-ExclusionManagedRuleSet <PSApplicationGatewayFirewallPolicyExclusionManagedRuleSet[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallExclusionConfig** cmdlet a new exclusion rule list for application gateway waf. + +## EXAMPLES + +### Example 1 +```powershell +$exclusion1 = New-AzApplicationGatewayFirewallExclusionConfig -Variable "RequestHeaderNames" -Operator "StartsWith" -Selector "xyz" +``` + +This command creates a new exclusion rule lists configuration for the variable named RequestHeaderNames and operator named StartsWith and Selector named xyz. The exclusion list configuration is saved in $exclusion1. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionManagedRuleSet +List of Exclusion Managed ruleSets. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyExclusionManagedRuleSet[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operator +When variable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. Possible values are Any, IPMatch, GeoMatch, Equal, Contains, LessThan, GreaterThan, LessThanOrEqual, GreaterThanOrEqual, BeginsWith, EndsWith. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Selector +When variable is a collection, operator used to specify which elements in the collection this exclusion applies to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Variable +The variable to be excluded. Match variable. Possible values are RequestHeaderNames, RequestCookieNames, QueryStringArgNames, RequestBodyPostArgNames. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallExclusion + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallMatchVariable.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallMatchVariable.md new file mode 100644 index 0000000000..570853e673 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallMatchVariable.md @@ -0,0 +1,95 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallmatchvariable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallMatchVariable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallMatchVariable.md +--- + +# New-AzApplicationGatewayFirewallMatchVariable + +## SYNOPSIS +Creates a match variable for firewall condition. + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallMatchVariable -VariableName <String> [-Selector <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallMatchVariable** creates a match variable for firewall condition. + +## EXAMPLES + +### Example 1 +```powershell +$variable = New-AzApplicationGatewayFirewallMatchVariable -VariableName RequestHeaders -Selector Content-Length +``` + +The command creates a new match variable with name of request headers and selector is Content-Length field. The new match variable is saved in $variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Selector +Describes field of the matchVariable collection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VariableName +Match Variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: RemoteAddr, RequestMethod, QueryString, PostArgs, RequestUri, RequestHeaders, RequestBody, RequestCookies + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallMatchVariable + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicy.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicy.md new file mode 100644 index 0000000000..973d009b74 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicy.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicy.md +--- + +# New-AzApplicationGatewayFirewallPolicy + +## SYNOPSIS +Creates a application gateway firewall policy. + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallPolicy -Name <String> -ResourceGroupName <String> -Location <String> + [-CustomRule <PSApplicationGatewayFirewallCustomRule[]>] + [-PolicySetting <PSApplicationGatewayFirewallPolicySettings>] + [-ManagedRule <PSApplicationGatewayFirewallPolicyManagedRules>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallPolicy** cmdlet creates a application gateway firewall policy. + +## EXAMPLES + +### Example 1 +```powershell +$firewallPolicy = New-AzApplicationGatewayFirewallPolicy -Name wafResource1 -ResourceGroupName "rg1" -Location "westus" -CustomRule $customRule +``` + +This command creates a new Azure application gateway firewall policy named "wafResource1" in resource group "rg1" in location "westus" with custom rules defined in the $customRule variable + +### Example 2 + +Creates a application gateway firewall policy. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzApplicationGatewayFirewallPolicy -CustomRule <PSApplicationGatewayFirewallCustomRule[]> -Location 'westus' -Name wafResource1 -PolicySetting <PSApplicationGatewayFirewallPolicySettings> -ResourceGroupName 'rg1' +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomRule +The list of CustomRules + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCustomRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagedRule +Managed Rule Setting + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyManagedRules +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicySetting +Policy Settings for Web Application Firewall + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicySettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCustomRule[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicySettings + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyManagedRules + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyExclusion.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyExclusion.md new file mode 100644 index 0000000000..17e1ef3fac --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyExclusion.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallpolicyexclusion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyExclusion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyExclusion.md +--- + +# New-AzApplicationGatewayFirewallPolicyExclusion + +## SYNOPSIS +Creates an exclusion on the Firewall Policy + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallPolicyExclusion -MatchVariable <String> -SelectorMatchOperator <String> + -Selector <String> [-ExclusionManagedRuleSet <PSApplicationGatewayFirewallPolicyExclusionManagedRuleSet[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallPolicyExclusion** cmdlet a new exclusion rule list for firewall policy. + +## EXAMPLES + +### Example 1 +```powershell +$exclusionEntry = New-AzApplicationGatewayFirewallPolicyExclusion -MatchVariable "RequestHeaderNames" -SelectorMatchOperator "StartsWith" -Selector "xyz" +``` + +This command creates a new exclusion-entry for the variable named RequestHeaderNames and operator named StartsWith and Selector named xyz. The exclusion entry is saved in $exclusionEntry. + +### Example 2 +```powershell +$exclusionEntry = New-AzApplicationGatewayFirewallPolicyExclusion -MatchVariable "RequestHeaderKeys" -SelectorMatchOperator "Contains" -Selector "abc" +``` + +This command creates a new exclusion-entry for the variable named RequestHeaderKeys and operator named Contains and Selector named abc. The exclusion entry is saved in $exclusionEntry. + +### Example 3 +```powershell +$exclusionEntry = New-AzApplicationGatewayFirewallPolicyExclusion -MatchVariable "RequestHeaderNames" -SelectorMatchOperator "StartsWith" -Selector "xyz" -ExclusionManagedRuleSet $exclusionManagedRuleSet +``` + +This command creates a new exclusion-entry for the variable named RequestHeaderNames and operator named StartsWith, Selector named xyz and ExclusionManagedRuleSet named $exclusionManagedRuleSet. The exclusion entry is saved in $exclusionEntry. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionManagedRuleSet +List of Exclusion Managed ruleSets. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyExclusionManagedRuleSet[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchVariable +The variable to be excluded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: RequestHeaderNames, RequestCookieNames, RequestArgNames, RequestHeaderKeys, RequestCookieKeys, RequestArgKeys, RequestHeaderValues, RequestCookieValues, RequestArgValues + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Selector +When variable is a collection, operator used to specify which elements in the collection this exclusion applies to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SelectorMatchOperator +When variable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Equals, Contains, StartsWith, EndsWith, EqualsAny + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyExclusion + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyExclusionManagedRule.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyExclusionManagedRule.md new file mode 100644 index 0000000000..51c1741608 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyExclusionManagedRule.md @@ -0,0 +1,79 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallpolicyexclusionmanagedrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyExclusionManagedRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyExclusionManagedRule.md +--- + +# New-AzApplicationGatewayFirewallPolicyExclusionManagedRule + +## SYNOPSIS +Creates an exclusionManagedRule entry for ExclusionManagedRuleGroup entry. + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallPolicyExclusionManagedRule -RuleId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallPolicyExclusionManagedRule** creates an exclusion rule entry. + +## EXAMPLES + +### Example 1 +```powershell +$ruleOverrideEntry = New-AzApplicationGatewayFirewallPolicyExclusionManagedRule -RuleId $ruleId +``` + +Creates an exclusion rule Entry with RuleId as $ruleId. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Specify the RuleId in exclusion rule entry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyExclusionManagedRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup.md new file mode 100644 index 0000000000..f2c6cfca91 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallpolicyexclusionmanagedrulegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup.md +--- + +# New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup + +## SYNOPSIS +Creates ExclusionManagedRuleGroup entry in ExclusionManagedRuleSets for the firewall policy exclusion. + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup -Name <String> + [-Rule <PSApplicationGatewayFirewallPolicyExclusionManagedRule[]>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup** creates a exclusionManagedRuleGroup entry in a exclusionManagedRuleSet for a firewall policy exclusion. + +## EXAMPLES + +### Example 1 +```powershell +$ruleGroupEntry = New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup -RuleGroupName $ruleName -Rule $rule1,$rule2 +``` + +Creates an ExclusionManagedRuleGroup entry with group name as $ruleName and Rules as $rule1, $rule2. Assigns the same to $ruleGroupEntry + +### Example 2 +```powershell +$ruleGroupEntry = New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup -RuleGroupName $ruleName +``` + +Creates an ExclusionManagedRuleGroup entry with group name as $ruleName. Assigns the same to $ruleGroupEntry + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Rule Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RuleGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +List of Rules. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyExclusionManagedRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyExclusionManagedRuleGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet.md new file mode 100644 index 0000000000..1b085bcfb4 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallpolicyexclusionmanagedruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet.md +--- + +# New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet + +## SYNOPSIS +Creates an ExclusionManagedRuleSet for the firewallPolicy exclusion + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet -Type <String> -Version <String> + [-RuleGroup <PSApplicationGatewayFirewallPolicyExclusionManagedRuleGroup[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet** creates an exclusion managed-ruleset for a firewall policy exclusion. + +## EXAMPLES + +### Example 1 +```powershell +$managedRuleSet = New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet -RuleSetType $ruleSetType ` +-RuleSetVersion $ruleSetVersion -RuleGroup $ruleGroup1, $ruleGroup2 +``` + +Creates an ExclusionManagedRuleSet with ruleSetType as $ruleSetType, ruleSetVersion as $ruleSetVersion and RuleGroups as a list with entires as $ruleGroup1, $ruleGroup2 +The new ExclusionManagedRuleSet is assigned to $managedRuleSet + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleGroup +Rule Group Overrides. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyExclusionManagedRuleGroup[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +RuleSet Type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RuleSetType + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +RuleSet Version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RuleSetVersion + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyExclusionManagedRuleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyLogScrubbingConfiguration.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyLogScrubbingConfiguration.md new file mode 100644 index 0000000000..1f8b44247b --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyLogScrubbingConfiguration.md @@ -0,0 +1,97 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallpolicylogscrubbingconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyLogScrubbingConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyLogScrubbingConfiguration.md +--- + +# New-AzApplicationGatewayFirewallPolicyLogScrubbingConfiguration + +## SYNOPSIS +Creates a log scrubbing configuration for firewall policy + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallPolicyLogScrubbingConfiguration -State <String> + -ScrubbingRule <PSApplicationGatewayFirewallPolicyLogScrubbingRule[]> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallPolicyLogScrubbingConfiguration** creates a log scrubbing configuration for firewall policy. + +## EXAMPLES + +### Example 1 +```powershell +$logScrubbingRuleConfig = New-AzApplicationGatewayFirewallPolicyLogScrubbingConfiguration -State Enabled -ScrubbingRule $logScrubbingRule1 +``` + +The command creates a log scrubbing rule configuration with state as enable, ScrubbingRule as $logScrubbingRule1. +The new log scrubbing rule configuration is stored to $logScrubbingRuleConfig. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScrubbingRule +The rules that are applied to the logs for scrubbing. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyLogScrubbingRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +State of the log scrubbing config. Default value is Enabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicySettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyLogScrubbingRule.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyLogScrubbingRule.md new file mode 100644 index 0000000000..cab465ff47 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyLogScrubbingRule.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallpolicylogscrubbingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyLogScrubbingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyLogScrubbingRule.md +--- + +# New-AzApplicationGatewayFirewallPolicyLogScrubbingRule + +## SYNOPSIS +Creates a log scrubbing rule for firewall policy + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallPolicyLogScrubbingRule -State <String> -MatchVariable <String> + -SelectorMatchOperator <String> [-Selector <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallPolicyLogScrubbingRule** creates a log scrubbing rule for firewall policy. + +## EXAMPLES + +### Example 1 +```powershell +$logScrubbingRuleConfig1 = New-AzApplicationGatewayFirewallPolicyLogScrubbingRule -State Enabled -MatchVariable RequestArgNames -SelectorMatchOperator Equals -Selector test +``` + +The command creates a log scrubbing rule configuration with state as enable, MatchVariable as RequestArgNames, SelectorMatchOperator as Equals and Selector as test +The new log scrubbing rule is stored to $logScrubbingRuleConfig1. + +### Example 2 +```powershell +$logScrubbingRuleConfig2 = New-AzApplicationGatewayFirewallPolicyLogScrubbingRule -State Enabled -MatchVariable RequestIPAddress -SelectorMatchOperator EqualsAny +``` + +The command creates a log scrubbing rule configuration with state as enable, MatchVariable as RequestIPAddress, SelectorMatchOperator as EqualsAny +The new log scrubbing rule is stored to $logScrubbingRuleConfig2. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchVariable +The variable to be scrubbed from the logs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: RequestHeaderNames, RequestCookieNames, RequestArgNames, RequestPostArgNames, RequestJSONArgNames, RequestIPAddress + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Selector +When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SelectorMatchOperator +When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Equals, EqualsAny + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Defines the state of log scrubbing rule. Default value is Enabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicySettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyManagedRule.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyManagedRule.md new file mode 100644 index 0000000000..ad23c06477 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyManagedRule.md @@ -0,0 +1,96 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallpolicymanagedrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyManagedRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyManagedRule.md +--- + +# New-AzApplicationGatewayFirewallPolicyManagedRule + +## SYNOPSIS +Create ManagedRules for the firewall policy. + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallPolicyManagedRule + [-ManagedRuleSet <PSApplicationGatewayFirewallPolicyManagedRuleSet[]>] + [-Exclusion <PSApplicationGatewayFirewallPolicyExclusion[]>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallPolicyManagedRule** creates a managed-rules for a firewall policy. + +## EXAMPLES + +### Example 1 +```powershell +$condition = New-AzApplicationGatewayFirewallPolicyManagedRule -ManagedRuleSet $managedRuleSet -Exclusion $exclusion1,$exclusion2 +``` + +The command creates managed rules a list of ManagedRuleSet with $managedRuleSet and an exclusion list with entries as $exclusion1, $exclusion2. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exclusion +List of Exclusion Entry. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyExclusion[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedRuleSet +List of Managed ruleSets. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyManagedRuleSet[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyManagedRules + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride.md new file mode 100644 index 0000000000..69917c431c --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride.md @@ -0,0 +1,95 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallpolicymanagedrulegroupoverride +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride.md +--- + +# New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride + +## SYNOPSIS +Creates RuleGroupOverride entry in ManagedRuleSets for the firewall policy. + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride -RuleGroupName <String> + -Rule <PSApplicationGatewayFirewallPolicyManagedRuleOverride[]> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride** creates a ruleGroupOverride entry in a managedRuleSet for a firewall policy. + +## EXAMPLES + +### Example 1 +```powershell +$overrideEntry = New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride -RuleGroupName $ruleName -Rule $rule1,$rule2 +``` + +Creates a RuleGroupOverride entry with group name as $ruleName and Rules as $rule1, $rule2. Assigns the same to $overrideEntry + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +List of Rules. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyManagedRuleOverride[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleGroupName +Specify the ruleGroupName in a override RuleGroup entry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyManagedRuleGroupOverride + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyManagedRuleOverride.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyManagedRuleOverride.md new file mode 100644 index 0000000000..0cfa87fd57 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyManagedRuleOverride.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallpolicymanagedruleoverride +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyManagedRuleOverride.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyManagedRuleOverride.md +--- + +# New-AzApplicationGatewayFirewallPolicyManagedRuleOverride + +## SYNOPSIS +Creates a managedRuleOverride entry for RuleGroupOverrideGroup entry. + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallPolicyManagedRuleOverride -RuleId <String> [-State <String>] [-Action <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallPolicyManagedRuleOverride** creates a ruleOverride entry. + +## EXAMPLES + +### Example 1 +```powershell +$ruleOverrideEntry = New-AzApplicationGatewayFirewallPolicyManagedRuleOverride -RuleId $ruleId -State Disabled +``` + +Creates a ruleOverride Entry with RuleId as $ruleId and State as Disabled. + +### Example 2 +```powershell +$ruleOverrideEntry = New-AzApplicationGatewayFirewallPolicyManagedRuleOverride -RuleId $ruleId -State Enabled -Action Log +``` + +Creates a ruleOverride Entry with RuleId as $ruleId, State as Enabled and Action as Log. + +## PARAMETERS + +### -Action +Specify the Action in override rule entry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AnomalyScoring, Allow, Block, Log + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Specify the RuleId in override rule entry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Specify the RuleId in override rule entry. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, Enabled + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyManagedRuleOverride + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyManagedRuleSet.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyManagedRuleSet.md new file mode 100644 index 0000000000..f777ee4bc8 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicyManagedRuleSet.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallpolicymanagedruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyManagedRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicyManagedRuleSet.md +--- + +# New-AzApplicationGatewayFirewallPolicyManagedRuleSet + +## SYNOPSIS +Creates a ManagedRuleSet for the firewallPolicy + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallPolicyManagedRuleSet -RuleSetType <String> -RuleSetVersion <String> + [-RuleGroupOverride <PSApplicationGatewayFirewallPolicyManagedRuleGroupOverride[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallPolicyManagedRuleSet** creates a managed-rules for a firewall policy. + +## EXAMPLES + +### Example 1 +```powershell +$managedRuleSet = New-AzApplicationGatewayFirewallPolicyManagedRuleSet -RuleSetType $ruleSetType ` +-RuleSetVersion $ruleSetVersion -RuleGroupOverride $ruleGroupOverride1, $ruleGroupOverride2 +``` + +Creates a ManagedRuleSet with ruleSetType as $ruleSetType, ruleSetVersion as $ruleSetVersion and RuleGroupOverrides as a list with entires as $ruleGroupOverride1, $ruleGroupOverride2 +The new ManagedRuleSet is assigned to $managedRuleSet + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleGroupOverride +Rule Group Overrides. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyManagedRuleGroupOverride[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSetType +Specify the RuleSetType in a managedRuleSet + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSetVersion +Specify the RuleSetVersion in a managedRuleSet + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyManagedRuleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicySetting.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicySetting.md new file mode 100644 index 0000000000..1a38305f15 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFirewallPolicySetting.md @@ -0,0 +1,251 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfirewallpolicysetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicySetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFirewallPolicySetting.md +--- + +# New-AzApplicationGatewayFirewallPolicySetting + +## SYNOPSIS +Creates a policy setting for the firewall policy + +## SYNTAX + +``` +New-AzApplicationGatewayFirewallPolicySetting [-Mode <String>] [-State <String>] + [-DisableRequestBodyEnforcement <Boolean>] [-RequestBodyInspectLimitInKB <Int32>] [-DisableRequestBodyCheck] + [-MaxRequestBodySizeInKb <Int32>] [-DisableFileUploadEnforcement <Boolean>] [-MaxFileUploadInMb <Int32>] + [-CustomBlockResponseStatusCode <Int32>] [-CustomBlockResponseBody <String>] + [-LogScrubbing <PSApplicationGatewayFirewallPolicyLogScrubbingConfiguration>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFirewallPolicySetting** creates a policy settings for a firewall policy. + +## EXAMPLES + +### Example 1 +```powershell +$condition = New-AzApplicationGatewayFirewallPolicySetting -State $enabledState -Mode $enabledMode -DisableRequestBodyCheck -MaxFileUploadInMb $fileUploadLimitInMb -MaxRequestBodySizeInKb $maxRequestBodySizeInKb +``` + +The command creates a policy setting with state as $enabledState, mode as $enabledMode, RequestBodyCheck as false, FileUploadLimitInMb as $fileUploadLimitInMb and MaxRequestBodySizeInKb as $$maxRequestBodySizeInKb. +The new policySettings is stored to $condition. + +### Example 2 +```powershell +$condition = New-AzApplicationGatewayFirewallPolicySetting -State $enabledState -Mode $enabledMode -DisableRequestBodyCheck -MaxFileUploadInMb $fileUploadLimitInMb -MaxRequestBodySizeInKb $maxRequestBodySizeInKb -LogScrubbing $logScrubbingRuleConfig +``` + +The command creates a policy setting with state as $enabledState, mode as $enabledMode, RequestBodyCheck as false, FileUploadLimitInMb as $fileUploadLimitInMb and MaxRequestBodySizeInKb as $$maxRequestBodySizeInKb with a scrubbing rule as $logScrubbingRuleConfig. +The new policySettings is stored to $condition. + +### Example 3 +```powershell +$condition = New-AzApplicationGatewayFirewallPolicySetting -State $enabledState -Mode $enabledMode -DisableRequestBodyEnforcement true -RequestBodyInspectLimitInKB 2000 -DisableRequestBodyCheck -MaxFileUploadInMb $fileUploadLimitInMb -DisableFileUploadEnforcement true -MaxRequestBodySizeInKb $maxRequestBodySizeInKb +``` + +The command creates a policy setting with state as $enabledState, mode as $enabledMode, RequestBodyEnforcement as false, RequestBodyInspectLimitInKB as 2000, RequestBodyCheck as false, FileUploadLimitInMb as $fileUploadLimitInMb, FileUploadEnforcement as false and MaxRequestBodySizeInKb as $$maxRequestBodySizeInKb. + +## PARAMETERS + +### -CustomBlockResponseBody +Custom Block Response Body in policy settings of the firewall policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomBlockResponseStatusCode +Custom block response status code in policy settings of the firewall policy. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableFileUploadEnforcement +Disable file upload enforcement limits for WAF. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableRequestBodyCheck +Diables the requestBodyCheck in policy settings of the firewall policy. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableRequestBodyEnforcement +Disable request body enforcement limits for WAF. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogScrubbing +To scrub sensitive log fields + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyLogScrubbingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxFileUploadInMb +Maximum fileUpload size in MB. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxRequestBodySizeInKb +MaxRequestBodySizeInKb in policy settings of the firewall policy. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 128 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Firewall Mode in policy settings of the firewall policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Prevention, Detection + +Required: False +Position: Named +Default value: Detection +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestBodyInspectLimitInKB +Max inspection limit in KB for request body inspection. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +State variable in policy settings of the firewall policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, Enabled + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicySettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFrontendIPConfig.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFrontendIPConfig.md new file mode 100644 index 0000000000..a9daeb506e --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFrontendIPConfig.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: AE8E26F2-CF8E-4340-936D-230731B5BA32 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfrontendipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFrontendIPConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFrontendIPConfig.md +--- + +# New-AzApplicationGatewayFrontendIPConfig + +## SYNOPSIS +Creates a front-end IP configuration for an application gateway. + +## SYNTAX + +### SetByResourceId +``` +New-AzApplicationGatewayFrontendIPConfig -Name <String> [-PrivateIPAddress <String>] [-SubnetId <String>] + [-PublicIPAddressId <String>] [-PrivateLinkConfigurationId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +New-AzApplicationGatewayFrontendIPConfig -Name <String> [-PrivateIPAddress <String>] [-Subnet <PSSubnet>] + [-PublicIPAddress <PSPublicIpAddress>] + [-PrivateLinkConfiguration <PSApplicationGatewayPrivateLinkConfiguration>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFrontendIPConfig** cmdlet creates a front-end IP configuration for an Azure application gateway. +An application gateway supports two types of front-end IP configuration: +- Public IP addresses + -- Private IP addresses using internal load balancing (ILB). +An application gateway can have at most one public IP address and one private IP address. +The public IP address and private IP address should be added separately as front-end IP addresses. + +## EXAMPLES + +### Example 1: Create a front-end IP configuration using a public IP resource object +```powershell +$PublicIP = New-AzPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIP01" -location "West US" -AllocationMethod Dynamic +$FrontEnd = New-AzApplicationGatewayFrontendIPConfig -Name "FrontEndIP01" -PublicIPAddress $PublicIP +``` + +The first command creates a public IP resource object and stores it in the $PublicIP variable. +The second command uses $PublicIP to create a new front-end IP configuration named FrontEndIP01 and stores it in the $FrontEnd variable. + +### Example 2: Create a static private IP as the front-end IP address +```powershell +$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" +$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet +$FrontEnd = New-AzApplicationGatewayFrontendIPConfig -Name "FrontendIP02" -Subnet $Subnet -PrivateIPAddress 10.0.1.1 +``` + +The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. +The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. +The third command creates a front-end IP configuration named FrontEndIP02 using $Subnet from the second command and the private IP address 10.0.1.1, and then stores it in the $FrontEnd variable. + +### Example 3: Create a dynamic private IP as the front-end IP address +```powershell +$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" +$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet +$FrontEnd = New-AzApplicationGatewayFrontendIPConfig -Name "FrontendIP03" -Subnet $Subnet +``` + +The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. +The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. +The third command creates a front-end IP configuration named FrontEndIP03 using $Subnet from the second command, and stores it in the $FrontEnd variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the front-end IP configuration that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIPAddress +Specifies the private IP address which this cmdlet associates with the front-end IP address of the application gateway. +This can be specified only if a subnet is specified. +This IP is statically allocated from the subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkConfiguration +PrivateLinkConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkConfigurationId +PrivateLinkConfigurationId + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIPAddress +Specifies the public IP address object which this cmdlet associates with the front-end IP address of the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIPAddressId +Specifies the public IP address ID which this cmdlet associates with the front-end IP of the application gateway. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Specifies the subnet object which this cmdlet associates with the front-end IP address of the application gateway. +If you specify this parameter, it implies that the gateway uses a private IP address. +If the *PrivateIPAddress* parameter is specified, it should belong to the subnet specified by this parameter. +If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Specifies the subnet ID which this cmdlet associates with the front-end IP configuration of the application gateway. +If you specify the *Subnet* parameter, it implies that the gateway uses a private IP address. +If the *PrivateIPAddress* parameter is specified, it should belong to the subnet specified by *Subnet*. +If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayFrontendIPConfig](./Add-AzApplicationGatewayFrontendIPConfig.md) + +[Get-AzApplicationGatewayFrontendIPConfig](./Get-AzApplicationGatewayFrontendIPConfig.md) + +[Remove-AzApplicationGatewayFrontendIPConfig](./Remove-AzApplicationGatewayFrontendIPConfig.md) + +[Set-AzApplicationGatewayFrontendIPConfig](./Set-AzApplicationGatewayFrontendIPConfig.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayFrontendPort.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFrontendPort.md new file mode 100644 index 0000000000..e59d50494f --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayFrontendPort.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 3C046A0A-A2B6-413C-8D3B-8991A1FC4926 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayfrontendport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFrontendPort.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayFrontendPort.md +--- + +# New-AzApplicationGatewayFrontendPort + +## SYNOPSIS +Creates a front-end port for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayFrontendPort -Name <String> -Port <Int32> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayFrontendPort** cmdlet creates a front-end port for an Azure application gateway. + +## EXAMPLES + +### Example 1: Example1: Create a front-end port +```powershell +$FrontEndPort = New-AzApplicationGatewayFrontendPort -Name "FrontEndPort01" -Port 80 +``` + +This command creates a front-end port named FrontEndPort01 on port 80 and stores the result in the variable named $FrontEndPort. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the front-end port that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Specifies the port number of the front-end port. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayFrontendPort](./Add-AzApplicationGatewayFrontendPort.md) + +[Get-AzApplicationGatewayFrontendPort](./Get-AzApplicationGatewayFrontendPort.md) + +[Remove-AzApplicationGatewayFrontendPort](./Remove-AzApplicationGatewayFrontendPort.md) + +[Set-AzApplicationGatewayFrontendPort](./Set-AzApplicationGatewayFrontendPort.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayHttpListener.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayHttpListener.md new file mode 100644 index 0000000000..eb5aa87b0f --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayHttpListener.md @@ -0,0 +1,363 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: AF8CC409-2EA7-4EC1-86C9-E7A773DE9201 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayhttplistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayHttpListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayHttpListener.md +--- + +# New-AzApplicationGatewayHttpListener + +## SYNOPSIS +Creates an HTTP listener for an application gateway. + +## SYNTAX + +### SetByResourceId +``` +New-AzApplicationGatewayHttpListener -Name <String> [-FrontendIPConfigurationId <String>] + [-FrontendPortId <String>] [-SslCertificateId <String>] [-FirewallPolicyId <String>] [-SslProfileId <String>] + [-HostName <String>] [-HostNames <String[]>] [-RequireServerNameIndication <String>] -Protocol <String> + [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SetByResource +``` +New-AzApplicationGatewayHttpListener -Name <String> + [-FrontendIPConfiguration <PSApplicationGatewayFrontendIPConfiguration>] + [-FrontendPort <PSApplicationGatewayFrontendPort>] + [-FirewallPolicy <PSApplicationGatewayWebApplicationFirewallPolicy>] + [-SslCertificate <PSApplicationGatewaySslCertificate>] [-SslProfile <PSApplicationGatewaySslProfile>] + [-HostName <String>] [-HostNames <String[]>] [-RequireServerNameIndication <String>] -Protocol <String> + [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayHttpListener** cmdlet creates an HTTP listener for an Azure application gateway. + +## EXAMPLES + +### Example 1: Create an HTTP listener +```powershell +$Listener = New-AzApplicationGatewayHttpListener -Name "Listener01" -Protocol "Http" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01 +``` + +This command creates an HTTP listener named Listener01 and stores the result in the variable named $Listener. + +### Example 2: Create an HTTP listener with SSL +```powershell +$Listener = New-AzApplicationGatewayHttpListener -Name "Listener01" -Protocol "Https" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01 -SslCertificate $SSLCert01 +``` + +This command creates an HTTP listener that uses SSL offload and provides the SSL certificate in the $SSLCert01 variable. +The command stores the result in the variable named $Listener. + +### Example 3: Create an HTTP listener with firewall-policy +```powershell +$Listener = New-AzApplicationGatewayHttpListener -Name "Listener01" -Protocol "Http" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01 -FirewallPolicy $firewallPolicy +``` + +This command creates an HTTP listener named Listener01, FirewallPolicy as $firewallPolicy and stores the result in the variable named $Listener. + +### Example 4: Add a HTTPS listener with SSL and HostNames +```powershell +$Listener = New-AzApplicationGatewayHttpListener -Name "Listener01" -Protocol "Https" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01 -SslCertificate $SSLCert01 -HostNames "*.contoso.com","www.microsoft.com" +``` + +This command creates an HTTP listener that uses SSL offload and provides the SSL certificate in the $SSLCert01 variable along with two HostNames. +The command stores the result in the variable named $Listener. + +## PARAMETERS + +### -CustomErrorConfiguration +Customer error of an application gateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicy +Specifies the object reference to a top-level firewall policy. +The object reference can be created by using New-AzApplicationGatewayWebApplicationFirewallPolicy cmdlet. +$firewallPolicy = New-AzApplicationGatewayFirewallPolicy -Name "wafPolicy1" -ResourceGroup "rgName" +A firewall policy created using the above commandlet can be referred at a path-rule level. +he above command would create a default policy settings and managed rules. +Instead of the default values, users can specify PolicySettings, ManagedRules by using New-AzApplicationGatewayFirewallPolicySettings and New-AzApplicationGatewayFirewallPolicyManagedRules respectively. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallPolicy +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicyId +Specifies the ID of an existing top-level web application firewall resource. +Firewall policy IDs can be returned by using the Get-AzApplicationGatewayWebApplicationFirewallPolicy cmdlet. +After we have the ID you can use *FirewallPolicyId* parameter instead of *FirewallPolicy* parameter. +For instance: +`-FirewallPolicyId "/subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/<firewallPolicyName>"` + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIPConfiguration +Specifies front-end IP configuration object for the HTTP listener. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIPConfigurationId +Specifies the ID of the front-end IP configuration for the HTTP listener. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendPort +Specifies the front-end port for the HTTP listener. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendPortId +Specifies the ID of the front-end port object for the HTTP listener. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +Specifies the host name of the application gateway HTTP listener. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostNames +Host names + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the HTTP listener that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol that the HTTP listener uses. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireServerNameIndication +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: true, false + +Required: False +Position: Named +Default value: true +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificate +Specifies the SSL certificate object for the HTTP listener. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificateId +Specifies the ID of the SSL certificate for the HTTP listener. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfile +SslProfile + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfileId +SslProfileId + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayHttpListener](./Add-AzApplicationGatewayHttpListener.md) + +[Get-AzApplicationGatewayHttpListener](./Get-AzApplicationGatewayHttpListener.md) + +[Remove-AzApplicationGatewayHttpListener](./Remove-AzApplicationGatewayHttpListener.md) + +[Set-AzApplicationGatewayHttpListener](./Set-AzApplicationGatewayHttpListener.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayIPConfiguration.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayIPConfiguration.md new file mode 100644 index 0000000000..9df0b5441f --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayIPConfiguration.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 312AA609-7362-42A5-A889-C0784D5A2943 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayipconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayIPConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayIPConfiguration.md +--- + +# New-AzApplicationGatewayIPConfiguration + +## SYNOPSIS +Creates an IP configuration for an application gateway. + +## SYNTAX + +### SetByResourceId +``` +New-AzApplicationGatewayIPConfiguration -Name <String> [-SubnetId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +New-AzApplicationGatewayIPConfiguration -Name <String> [-Subnet <PSSubnet>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayIPConfiguration** cmdlet creates an IP configuration for an application gateway. +The IP configuration contains the subnet in which application gateway is deployed. + +## EXAMPLES + +### Example 1: Create an IP configuration for an application gateway. +```powershell +$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" +$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet +$GatewayIpConfig = New-AzApplicationGatewayIPConfiguration -Name "AppGwSubnet01" -Subnet $Subnet +``` + +The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01. +The second command gets the subnet configuration for the subnet that the virtual network in the previous command belongs to, and stores it in the $Subnet variable. +The third command creates the IP configuration using $Subnet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the IP configuration to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Specifies the subnet object. +This is the subnet in which the application gateway is deployed. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Specifies the subnet ID. +This is the subnet in which the application gateway would be deployed. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayIPConfiguration + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayIPConfiguration](./Add-AzApplicationGatewayIPConfiguration.md) + +[Get-AzApplicationGatewayIPConfiguration](./Get-AzApplicationGatewayIPConfiguration.md) + +[Remove-AzApplicationGatewayIPConfiguration](./Remove-AzApplicationGatewayIPConfiguration.md) + +[Set-AzApplicationGatewayIPConfiguration](./Set-AzApplicationGatewayIPConfiguration.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayIdentity.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayIdentity.md new file mode 100644 index 0000000000..6d5ac1c62b --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayIdentity.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayidentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayIdentity.md +--- + +# New-AzApplicationGatewayIdentity + +## SYNOPSIS +Creates an identity object for an application gateway. This will hold reference to the user assigned identity. + +## SYNTAX + +``` +New-AzApplicationGatewayIdentity -UserAssignedIdentityId <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +**New-AzApplicationGatewayIdentity** cmdlet creates an application gateway identity object. + +## EXAMPLES + +### Example 1 +```powershell +$identity = New-AzUserAssignedIdentity -Name $identityName -ResourceGroupName $rgName -Location $location +$appgwIdentity = New-AzApplicationGatewayIdentity -UserAssignedIdentity $identity.Id +$gateway = New-AzApplicationGateway -Name "AppGateway01" -ResourceGroupName "ResourceGroup01" -Location "West US" -Identity $appgwIdentity <..> +``` + +In this example, we create a user assigned identity and then reference it in identity object used with Application Gateway. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +ResourceId of the user assigned identity to be assigned to Application Gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: UserAssignedIdentity + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayListener.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayListener.md new file mode 100644 index 0000000000..bfa7b9f651 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayListener.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewaylistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayListener.md +--- + +# New-AzApplicationGatewayListener + +## SYNOPSIS +Creates an TCP\TLS listener for an application gateway. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzApplicationGatewayListener -Name <String> + [-FrontendIPConfiguration <PSApplicationGatewayFrontendIPConfiguration>] + [-FrontendPort <PSApplicationGatewayFrontendPort>] [-SslCertificate <PSApplicationGatewaySslCertificate>] + [-SslProfile <PSApplicationGatewaySslProfile>] -Protocol <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzApplicationGatewayListener -Name <String> [-FrontendIPConfigurationId <String>] + [-FrontendPortId <String>] [-SslCertificateId <String>] [-SslProfileId <String>] -Protocol <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayListener** cmdlet creates an TCP\TLS listener for an Azure application gateway. + +## EXAMPLES + +### Example 1: Create an TCP listener +```powershell +$Listener = New-AzApplicationGatewayListener -Name "Listener01" -Protocol "Tcp" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01 +``` + +This command creates an Tcp listener named Listener01 and stores the result in the variable named $Listener. + +### Example 2: Create an TLS listener with SSL +```powershell +$Listener = New-AzApplicationGatewayListener -Name "Listener01" -Protocol "Tls" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01 -SslCertificate $SSLCert01 +``` + +This command creates an Tls listener that uses SSL offload and provides the SSL certificate in the $SSLCert01 variable. +The command stores the result in the variable named $Listener. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIPConfiguration +Application gateway FrontendIPConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIPConfigurationId +ID of the application gateway FrontendIPConfiguration + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendPort +Application gateway FrontendPort + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendPortId +ID of the application gateway FrontendPort + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Listener + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TCP, TLS + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificate +Application gateway SslCertificate + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificateId +ID of the application gateway SslCertificate + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfile +SslProfile + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfileId +SslProfileId + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayListener + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayListener](./Add-AzApplicationGatewayListener.md) + +[Get-AzApplicationGatewayListener](./Get-AzApplicationGatewayListener.md) + +[Remove-AzApplicationGatewayListener](./Remove-AzApplicationGatewayListener.md) + +[Set-AzApplicationGatewayListener](./Set-AzApplicationGatewayListener.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayPathRuleConfig.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayPathRuleConfig.md new file mode 100644 index 0000000000..4393b8d618 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayPathRuleConfig.md @@ -0,0 +1,331 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: A1F949A9-7AEF-41C1-B757-114421B79493 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewaypathruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayPathRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayPathRuleConfig.md +--- + +# New-AzApplicationGatewayPathRuleConfig + +## SYNOPSIS +Creates an application gateway path rule. + +## SYNTAX + +### SetByResourceId +``` +New-AzApplicationGatewayPathRuleConfig -Name <String> -Paths <String[]> [-BackendAddressPoolId <String>] + [-BackendHttpSettingsId <String>] [-RewriteRuleSetId <String>] [-RedirectConfigurationId <String>] + [-FirewallPolicyId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +New-AzApplicationGatewayPathRuleConfig -Name <String> -Paths <String[]> + [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] + [-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] + [-RewriteRuleSet <PSApplicationGatewayRewriteRuleSet>] + [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] + [-FirewallPolicy <PSApplicationGatewayWebApplicationFirewallPolicy>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayPathRuleConfig** cmdlet creates an application gateway path rule. +Rules created by this cmdlet can be added to a collection of URL path map configuration settings and then assigned to a gateway. +Path map configuration settings are used in application gateway load balancing. + +## EXAMPLES + +### Example 1 +```powershell +$Gateway = Get-AzApplicationGateway -Name "ContosoApplicationGateway" +$AddressPool = New-AzApplicationGatewayBackendAddressPool -Name "ContosoAddressPool" -BackendIPAddresses "192.168.1.1", "192.168.1.2" +$HttpSettings = New-AzApplicationGatewayBackendHttpSetting -Name "ContosoHttpSettings" -Port 80 -Protocol "Http" -CookieBasedAffinity "Disabled" +$PathRuleConfig = New-AzApplicationGatewayPathRuleConfig -Name "base" -Paths "/base" -BackendAddressPool $AddressPool -BackendHttpSettings $HttpSettings +Add-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway $Gateway -Name "ContosoUrlPathMap" -PathRules $PathRuleConfig -DefaultBackendAddressPool $AddressPool -DefaultBackendHttpSettings $HttpSettings +``` + +These commands create a new application gateway path rule and then use the **Add-AzApplicationGatewayUrlPathMapConfig** cmdlet to assign that rule to an application gateway. +To do this, the first command creates an object reference to the gateway ContosoApplicationGateway. +This object reference is stored in a variable named $Gateway. +The next two commands create a backend address pool and a backend HTTP settings object; these objects (stored in the variables $AddressPool and $HttpSettings) are needed in order to create a path rule object. +The fourth command creates the path rule object and is stored in a variable named $PathRuleConfig. +The fifth command uses **Add-AzApplicationGatewayUrlPathMapConfig** to add the configuration settings and the new path rule contained within those settings to ContosoApplicationGateway. + +### Example 2 +```powershell +$PathRuleConfig = New-AzApplicationGatewayPathRuleConfig -Name "base" -Paths "/base" -BackendAddressPool $AddressPool -BackendHttpSettings $HttpSettings -FirewallPolicy $firewallPolicy +``` + +These command creates a path-rule with the Name as "base", Paths as "/base", BackendAddressPool as $AddressPool, BackendHttpSettings as $HttpSettings and FirewallPolicy as $firewallPolicy.ngs and the new path rule contained within those settings to ContosoApplicationGateway. + +## PARAMETERS + +### -BackendAddressPool +Specifies an object reference to a collection of backend address pool settings to be added to the gateway path rules configuration settings. +You can create this object reference by using the New-AzApplicationGatewayBackendAddressPool cmdlet and syntax similar to this: +`$AddressPool = New-AzApplicationGatewayBackendAddressPool -Name "ContosoAddressPool" -BackendIPAddresses "192.168.1.1", "192.168.1.2"` +The preceding command adds two IP addresses (192.16.1.1 and 192.168.1.2) to the address pool. +Note that the IP address are enclosed in quote marks and separated by using commas. +The resulting variable, $AddressPool, can then be used as the parameter value for the *DefaultBackendAddressPool* parameter. +The backend address pool represents the IP addresses on the backend servers. +These IP addresses should either belong to the virtual network subnet or should be public IP addresses. +If you use this parameter you cannot use the *DefaultBackendAddressPoolId* parameter in the same command. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +Specifies the ID of an existing backend address pool that can be added to the gateway path rule configuration settings. +Address pool IDs can be returned by using the Get-AzApplicationGatewayBackendAddressPool cmdlet. +After you have the ID you can then use the *DefaultBackendAddressPoolId* parameter instead of the *DefaultBackendAddressPool* parameter. +For instance: +-DefaultBackendAddressPoolId "/subscriptions/39c54063-01d3-4abf-8f4c-234777bc1f10/resourceGroups/appgw-rg/providers/Microsoft.Network/applicationGateways/appgwtest/backendAddressPools/ContosoAddressPool" +The backend address pool represents the IP addresses on the backend servers. +These IP addresses should either belong to the virtual network subnet or should be public IP addresses. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendHttpSettings +Specifies an object reference to a collection of backend HTTP settings to be added to the gateway path rule configuration settings. +You can create this object reference by using the New-AzApplicationGatewayBackendHttpSettings cmdlet and syntax similar to this: +$HttpSettings = New-AzApplicationGatewayBackendHttpSettings -Name "ContosoHttpSettings" -Port 80 -Protocol "Http" -CookieBasedAffinity "Disabled" +The resulting variable, $HttpSettings, can then be used as the parameter value for the *DefaultBackendAddressPool* parameter: +-DefaultBackendHttpSettings $HttpSettings +The backend HTTP settings configure properties such as port, protocol, and cookie-based affinity for a backend pool. +If you use this parameter you cannot use the *DefaultBackendHttpSettingsId* parameter in the same command. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendHttpSettingsId +Specifies the ID of an existing backend HTTP settings collection that can be added to the gateway path rule configuration settings. +HTTP setting IDs can be returned by using the Get-AzApplicationGatewayBackendHttpSettings cmdlet. +After you have the ID you can then use the *DefaultBackendHttpSettingsId* parameter instead of the *DefaultBackendHttpSettings* parameter. +For instance: +-DefaultBackendSettings Id "/subscriptions/39c54063-01d3-4abf-8f4c-234777bc1f10/resourceGroups/appgw-rg/providers/Microsoft.Network/applicationGateways/appgwtest/backendHttpSettingsCollection/ContosoHttpSettings" +The backend HTTP settings configure properties such as port, protocol, and cookie-based affinity for a backend pool. +If you use this parameter you cannot use the *DefaultBackendHttpSettings* parameter in the same command. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicy +Specifies the object reference to a top-level firewall policy. +The object reference can be created by using New-AzApplicationGatewayWebApplicationFirewallPolicy cmdlet. +$firewallPolicy = New-AzApplicationGatewayFirewallPolicy -Name "wafPolicy1" -ResourceGroup "rgName" +A firewall policy created using the above commandlet can be referred at a path-rule level. +he above command would create a default policy settings and managed rules. +Instead of the default values, users can specify PolicySettings, ManagedRules by using New-AzApplicationGatewayFirewallPolicySettings and New-AzApplicationGatewayFirewallPolicyManagedRules respectively. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallPolicy +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicyId +Specifies the ID of an existing top-level web application firewall resource. +Firewall policy IDs can be returned by using the Get-AzApplicationGatewayWebApplicationFirewallPolicy cmdlet. +After we have the ID you can use *FirewallPolicyId* parameter instead of *FirewallPolicy* parameter. +For instance: +-FirewallPolicyId `/subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/<firewallPolicyName>` + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the path rule configuration that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Paths +Specifies one or more application gateway path rules. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectConfiguration +Application gateway RedirectConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectConfigurationId +ID of the application gateway RedirectConfiguration + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RewriteRuleSet +Application gateway RewriteRuleSet + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleSet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RewriteRuleSetId +ID of the application gateway RewriteRuleSet + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayUrlPathMapConfig](./Add-AzApplicationGatewayUrlPathMapConfig.md) + +[Get-AzApplicationGateway](./Get-AzApplicationGateway.md) + +[Get-AzApplicationGatewayUrlPathMapConfig](./Get-AzApplicationGatewayUrlPathMapConfig.md) + +[New-AzApplicationGatewayBackendAddressPool](./New-AzApplicationGatewayBackendAddressPool.md) + +[New-AzApplicationGatewayBackendHttpSetting](./New-AzApplicationGatewayBackendHttpSetting.md) + +[New-AzApplicationGatewayPathRuleConfig](./New-AzApplicationGatewayPathRuleConfig.md) + +[New-AzApplicationGatewayUrlPathMapConfig](./New-AzApplicationGatewayUrlPathMapConfig.md) + +[Remove-AzApplicationGatewayUrlPathMapConfig](./Remove-AzApplicationGatewayUrlPathMapConfig.md) + +[Set-AzApplicationGatewayUrlPathMapConfig](./Set-AzApplicationGatewayUrlPathMapConfig.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayPrivateLinkConfiguration.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayPrivateLinkConfiguration.md new file mode 100644 index 0000000000..429a1947ba --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayPrivateLinkConfiguration.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayprivatelinkconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayPrivateLinkConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayPrivateLinkConfiguration.md +--- + +# New-AzApplicationGatewayPrivateLinkConfiguration + +## SYNOPSIS +Creates a private link configuration for an application gateway + +## SYNTAX + +``` +New-AzApplicationGatewayPrivateLinkConfiguration -Name <String> + -IpConfiguration <PSApplicationGatewayPrivateLinkIpConfiguration[]> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayPrivateLinkConfiguration** cmdlet creates an PrivateLink Configuration for an Azure application gateway. +The private link configuration must be associated to a frontend ip configuration to enable the private link functionality. +One private link configuration can atmost be associated to only one frontend ip configuration on application gateway. + +## EXAMPLES + +### Example 1: Create an Private Link Configuration with single Ip Configuration +```powershell +$PrivateLinkIpConfiguration1 = New-AzApplicationGatewayPrivateLinkIpConfiguration -Name "ipConfig01" -Subnet $subnet -Primary +$PrivateLinkConfiguration = New-AzApplicationGatewayPrivateLinkConfiguration -Name "privateLinkConfig01" -IpConfiguration $privateLinkIpConfiguration1 +``` + +This command creates an PrivateLink configuration named 'privateLinkConfig01' and stores the result in the variable named $PrivateLinkConfiguration. + +### Example 2: Create an Private Link Configuration with multiple Ip Configurations +```powershell +$PrivateLinkIpConfiguration1 = New-AzApplicationGatewayPrivateLinkIpConfiguration -Name "ipConfig01" -Subnet $subnet -Primary +$PrivateLinkIpConfiguration2 = New-AzApplicationGatewayPrivateLinkIpConfiguration -Name "ipConfig02" -Subnet $subnet +$PrivateLinkConfiguration = New-AzApplicationGatewayPrivateLinkConfiguration -Name "privateLinkConfig01" -IpConfiguration $privateLinkIpConfiguration1, $privateLinkIpConfiguration2 +``` + +This command creates an PrivateLink configuration named 'privateLinkConfig01' with two ipConfigurations and stores the result in the variable named $PrivateLinkConfiguration. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfiguration +The list of ipConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkIpConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the privateLink configuration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkIpConfiguration[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkConfiguration + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayPrivateLinkConfiguration](./Get-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Add-AzApplicationGatewayPrivateLinkConfiguration](./Add-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Remove-AzApplicationGatewayPrivateLinkConfiguration](./Remove-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Set-AzApplicationGatewayPrivateLinkConfiguration](./Set-AzApplicationGatewayPrivateLinkConfiguration.md) diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayPrivateLinkIpConfiguration.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayPrivateLinkIpConfiguration.md new file mode 100644 index 0000000000..0664f9673e --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayPrivateLinkIpConfiguration.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayprivatelinkipconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayPrivateLinkIpConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayPrivateLinkIpConfiguration.md +--- + +# New-AzApplicationGatewayPrivateLinkIpConfiguration + +## SYNOPSIS +Creates an Ip Configuration to be associated with PrivateLink Configuration + +## SYNTAX + +``` +New-AzApplicationGatewayPrivateLinkIpConfiguration -Name <String> -Subnet <PSSubnet> + [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] [-Primary] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayPrivateLinkIpConfiguration** cmdlet creates an Ip Configuration to be associated with PrivateLink Configuration for an Azure application gateway. + +## EXAMPLES + +### Example 1: PrivateLink Ip Configuration +```powershell +$PrivateLinkIpConfiguration = New-AzApplicationGatewayPrivateLinkIpConfiguration -Name "ipConfig01" -Subnet $subnet -Primary +``` + +This command creates an PrivateLink IP Configuration named 'ipConfig01' stores the result in the variable named $PrivateLinkIpConfiguration. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the IpConfiguration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Primary +Indicate the ip configuration is primary. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddress +The private ip address of the ipConfiguration if static allocation is desired. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddressVersion +The ip version of the ip configuration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Subnet + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkIpConfiguration + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayPrivateLinkConfiguration](./New-AzApplicationGatewayPrivateLinkConfiguration.md) diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayProbeConfig.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayProbeConfig.md new file mode 100644 index 0000000000..bcaf0e38af --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayProbeConfig.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayprobeconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayProbeConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayProbeConfig.md +--- + +# New-AzApplicationGatewayProbeConfig + +## SYNOPSIS +Creates a health probe. + +## SYNTAX + +``` +New-AzApplicationGatewayProbeConfig -Name <String> -Protocol <String> [-HostName <String>] [-Path <String>] + -Interval <Int32> -Timeout <Int32> -UnhealthyThreshold <Int32> [-PickHostNameFromBackendHttpSettings] + [-MinServers <Int32>] [-Port <Int32>] [-Match <PSApplicationGatewayProbeHealthResponseMatch>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzApplicationGatewayProbeConfig cmdlet creates a health probe. + +## EXAMPLES + +### Example 1: Example1: Create a health probe +```powershell +New-AzApplicationGatewayProbeConfig -Name "Probe03" -Protocol Http -HostName "contoso.com" -Path "/path/custompath.htm" -Interval 30 -Timeout 120 -UnhealthyThreshold 8 +``` + +This command creates a health probe named Probe03, with HTTP protocol, a 30 second interval, timeout of 120 seconds, and an unhealthy threshold of 8 retries. + +### Example 2 + +Creates a health probe. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzApplicationGatewayProbeConfig -Interval 30 -Match <PSApplicationGatewayProbeHealthResponseMatch> -Name 'Probe03' -Path '/path/custompath.htm' -PickHostNameFromBackendHttpSettings -Protocol https -Timeout 120 -UnhealthyThreshold 8 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +Specifies the host name that this cmdlet sends the probe. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Interval +Specifies the probe interval in seconds. +This is the time interval between two consecutive probes. +This value is between 1 second and 86400 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Match +Body that must be contained in the health response. +Default value is empty + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbeHealthResponseMatch +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinServers +Minimum number of servers that are always marked healthy. +Default value is 0 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the probe. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the relative path of probe. +Valid paths start with the slash character (/). +The probe is sent to \<Protocol\>://\<host\>:\<port\>\<path\>. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PickHostNameFromBackendHttpSettings +Whether the host header should be picked from the backend http settings. +Default value is false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Specifies the port used for probing backend servers. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol used to send probe. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https, TCP, TLS + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +Specifies the probe timeout in seconds. +This cmdlet marks the probe as failed if a valid response is not received with this timeout period. +Valid values are between 1 second and 86400 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnhealthyThreshold +Specifies the probe retry count. +The backend server is marked down after consecutive probe failure count reaches the unhealthy threshold. +Valid values are between 1 second and 20 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe + +## NOTES + +## RELATED LINKS + +[Create custom probe for Application Gateway using PowerShell for Azure Resource Manager](https://azure.microsoft.com/en-us/documentation/articles/application-gateway-create-probe-ps/#) + +[Add-AzApplicationGatewayProbeConfig](./Add-AzApplicationGatewayProbeConfig.md) + +[Get-AzApplicationGatewayProbeConfig](./Get-AzApplicationGatewayProbeConfig.md) + +[Remove-AzApplicationGatewayProbeConfig](./Remove-AzApplicationGatewayProbeConfig.md) + +[Set-AzApplicationGatewayProbeConfig](./Set-AzApplicationGatewayProbeConfig.md) + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayProbeHealthResponseMatch.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayProbeHealthResponseMatch.md new file mode 100644 index 0000000000..479262f034 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayProbeHealthResponseMatch.md @@ -0,0 +1,95 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayprobehealthresponsematch +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayProbeHealthResponseMatch.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayProbeHealthResponseMatch.md +--- + +# New-AzApplicationGatewayProbeHealthResponseMatch + +## SYNOPSIS +Creates a health probe response match used by Health Probe for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayProbeHealthResponseMatch [-Body <String>] [-StatusCode <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +**The Add-AzApplicationGatewayProbeHealthResponseMatch** cmdlet creates a health probe response match used by Health Probe for an application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$responsematch = New-AzApplicationGatewayProbeHealthResponseMatch -Body "helloworld" -StatusCode "200-399","503" +``` + +This command creates a health response match which can be passed to ProbeConfig as a parameter. + +## PARAMETERS + +### -Body +Body that must be contained in the health response. +Default value is empty + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusCode +Allowed ranges of healthy status codes.Default range of healthy status codes is 200 - 399 + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbeHealthResponseMatch + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayRedirectConfiguration.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRedirectConfiguration.md new file mode 100644 index 0000000000..65d9502f5f --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRedirectConfiguration.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayredirectconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRedirectConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRedirectConfiguration.md +--- + +# New-AzApplicationGatewayRedirectConfiguration + +## SYNOPSIS +Creates a redirect configuration for an application gateway. + +## SYNTAX + +### SetByResourceId +``` +New-AzApplicationGatewayRedirectConfiguration -Name <String> -RedirectType <String> + [-TargetListenerID <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +New-AzApplicationGatewayRedirectConfiguration -Name <String> -RedirectType <String> + [-TargetListener <PSApplicationGatewayHttpListener>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByURL +``` +New-AzApplicationGatewayRedirectConfiguration -Name <String> -RedirectType <String> [-TargetUrl <String>] + [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +**The New-AzApplicationGatewayRedirectConfiguration** cmdlet creates a redirect configuration for an application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$RedirectConfig = New-AzApplicationGatewayRedirectConfiguration -Name "Redirect01" -RedirectType Permanent -TargetListener $listener01 +``` + +This command creates a redirect configuration named Redirect01 and stores the result in the variable named $RedirectConfig. + +### Example 2 + +Creates a redirect configuration for an application gateway. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzApplicationGatewayRedirectConfiguration -IncludePath $false -IncludeQueryString $false -Name 'Redirect01' -RedirectType Permanent -TargetListener <PSApplicationGatewayHttpListener> +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePath +Include path in the redirected url. +Default is true. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeQueryString +Include query string in the redirected url. +Default is true. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Redirect Configuration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectType +The type of redirect + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Permanent, Found, SeeOther, Temporary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetListener +HTTP listener to redirect the request to + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetListenerID +ID of HTTP listener to redirect the request to + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetUrl +Target URL fo redirection + +```yaml +Type: System.String +Parameter Sets: SetByURL +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRedirectConfiguration](./Add-AzApplicationGatewayRedirectConfiguration.md) + +[Get-AzApplicationGatewayRedirectConfiguration](./Get-AzApplicationGatewayRedirectConfiguration.md) + +[Remove-AzApplicationGatewayRedirectConfiguration](./Remove-AzApplicationGatewayRedirectConfiguration.md) + +[Set-AzApplicationGatewayRedirectConfiguration](./Set-AzApplicationGatewayRedirectConfiguration.md) diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayRequestRoutingRule.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRequestRoutingRule.md new file mode 100644 index 0000000000..09c6a69bce --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRequestRoutingRule.md @@ -0,0 +1,311 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 622FE9AC-1CC4-489C-BB17-9D6B9D1C151D +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayrequestroutingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRequestRoutingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRequestRoutingRule.md +--- + +# New-AzApplicationGatewayRequestRoutingRule + +## SYNOPSIS +Creates a request routing rule for an application gateway. + +## SYNTAX + +### SetByResourceId +``` +New-AzApplicationGatewayRequestRoutingRule -Name <String> -RuleType <String> [-Priority <Int32>] + [-BackendHttpSettingsId <String>] [-HttpListenerId <String>] [-BackendAddressPoolId <String>] + [-UrlPathMapId <String>] [-RewriteRuleSetId <String>] [-RedirectConfigurationId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +New-AzApplicationGatewayRequestRoutingRule -Name <String> -RuleType <String> [-Priority <Int32>] + [-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] + [-HttpListener <PSApplicationGatewayHttpListener>] + [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] [-UrlPathMap <PSApplicationGatewayUrlPathMap>] + [-RewriteRuleSet <PSApplicationGatewayRewriteRuleSet>] + [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +**The Add-AzApplicationGatewayRequestRoutingRule** cmdlet creates a request routing rule for an Azure application gateway. + +## EXAMPLES + +### Example 1: Create a request routing rule for an application gateway +```powershell +$Rule = New-AzApplicationGatewayRequestRoutingRule -Name "Rule01" -RuleType Basic -Priority 100 -BackendHttpSettings $Setting -HttpListener $Listener -BackendAddressPool $Pool +``` + +This command creates a basic request routing rule named Rule01 and stores the result in the variable named $Rule. + +## PARAMETERS + +### -BackendAddressPool +Specifies the back-end address pool, as an object, for the request routing rule to create. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +Specifies the back-end address pool ID of the request routing rule to create. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendHttpSettings +Specifies the back-end HTTP settings, as an object, for the request routing rule to create. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendHttpSettingsId +Specifies the back-end HTTP settings ID of the request routing rule to create. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpListener +Specifies the back-end HTTP listener for the request routing rule to create. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpListenerId +Specifies the backend HTTP listener ID for the request routing rule to create. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the request routing rule that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The priority of the rule + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectConfiguration +Application gateway RedirectConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectConfigurationId +ID of the application gateway RedirectConfiguration + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RewriteRuleSet +Application gateway RewriteRuleSet + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleSet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RewriteRuleSetId +ID of the application gateway RewriteRuleSet + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleType +Specifies type of the request routing rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, PathBasedRouting + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlPathMap +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlPathMapId +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRequestRoutingRule](./Add-AzApplicationGatewayRequestRoutingRule.md) + +[Get-AzApplicationGatewayRequestRoutingRule](./Get-AzApplicationGatewayRequestRoutingRule.md) + +[Remove-AzApplicationGatewayRequestRoutingRule](./Remove-AzApplicationGatewayRequestRoutingRule.md) + +[Set-AzApplicationGatewayRequestRoutingRule](./Set-AzApplicationGatewayRequestRoutingRule.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRule.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRule.md new file mode 100644 index 0000000000..22d353222c --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRule.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayrewriterule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRewriteRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRewriteRule.md +--- + +# New-AzApplicationGatewayRewriteRule + +## SYNOPSIS +Creates a rewrite rule for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayRewriteRule -Name <String> -ActionSet <PSApplicationGatewayRewriteRuleActionSet> + [-RuleSequence <Int32>] [-Condition <PSApplicationGatewayRewriteRuleCondition[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +**The New-AzApplicationGatewayRewriteRule** cmdlet creates a rewrite rule for an Azure application gateway. + +## EXAMPLES + +### Example 1 : Create a rewrite rule for an application gateway +```powershell +$rule = New-AzApplicationGatewayRewriteRule -Name rule1 -ActionSet $action -RuleSequence 101 -Condition $condition +``` + +This command creates a rewrite rule named rule1 and stores the result in the variable named $rule. + +## PARAMETERS + +### -ActionSet +ActionSet of the rewrite rule + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleActionSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Condition +Condition for the rewrite rule to execute + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleCondition[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the RewriteRule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSequence +The rule ordering of this rewrite rule in the rewrite rule set + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRule + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRewriteRuleSet](./Add-AzApplicationGatewayRewriteRuleSet.md) + +[Get-AzApplicationGatewayRewriteRuleSet](./Get-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRuleSet](./New-AzApplicationGatewayRewriteRuleSet.md) + +[Remove-AzApplicationGatewayRewriteRuleSet](./Remove-AzApplicationGatewayRewriteRuleSet.md) + +[Set-AzApplicationGatewayRewriteRuleSet](./Set-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRuleActionSet](./New-AzApplicationGatewayRewriteRuleActionSet.md) + +[New-AzApplicationGatewayRewriteRuleHeaderConfiguration](./New-AzApplicationGatewayRewriteRuleHeaderConfiguration.md) diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleActionSet.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleActionSet.md new file mode 100644 index 0000000000..5f591584bc --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleActionSet.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayrewriteruleactionset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRewriteRuleActionSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRewriteRuleActionSet.md +--- + +# New-AzApplicationGatewayRewriteRuleActionSet + +## SYNOPSIS +Creates a rewrite rule action set for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayRewriteRuleActionSet + [-RequestHeaderConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHeaderConfiguration]>] + [-ResponseHeaderConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHeaderConfiguration]>] + [-UrlConfiguration <PSApplicationGatewayUrlConfiguration>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +**The New-AzApplicationGatewayRewriteRuleActionSet** cmdlet creates a rewrite rule action set for an Azure application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$action = New-AzApplicationGatewayRewriteRuleActionSet -ResponseHeaderConfiguration $hc -UrlConfiguration $urlConfiguration +``` + +This command creates a rewrite rule action set and stores the result in the variable named $action. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestHeaderConfiguration +List of request header configurations + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHeaderConfiguration] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResponseHeaderConfiguration +List of response header configurations + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHeaderConfiguration] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlConfiguration +Url Configuration for action set + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleActionSet + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRewriteRuleSet](./Add-AzApplicationGatewayRewriteRuleSet.md) + +[Get-AzApplicationGatewayRewriteRuleSet](./Get-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRuleSet](./New-AzApplicationGatewayRewriteRuleSet.md) + +[Remove-AzApplicationGatewayRewriteRuleSet](./Remove-AzApplicationGatewayRewriteRuleSet.md) + +[Set-AzApplicationGatewayRewriteRuleSet](./Set-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRule](./New-AzApplicationGatewayRewriteRule.md) + +[New-AzApplicationGatewayRewriteRuleHeaderConfiguration](./New-AzApplicationGatewayRewriteRuleHeaderConfiguration.md) + +[New-AzApplicationGatewayRewriteRuleUrlConfiguration](./New-AzApplicationGatewayRewriteRuleUrlConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleCondition.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleCondition.md new file mode 100644 index 0000000000..9b16ebd365 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleCondition.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayrewriterulecondition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRewriteRuleCondition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRewriteRuleCondition.md +--- + +# New-AzApplicationGatewayRewriteRuleCondition + +## SYNOPSIS +Adds a condition to the RewriteRule for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayRewriteRuleCondition -Variable <String> [-Pattern <String>] [-IgnoreCase] [-Negate] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +**The AzApplicationGatewayRewriteRuleCondition** cmdlet creates a rewrite rule condition for an Azure application gateway. + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$condition = New-AzApplicationGatewayRewriteRuleCondition -Variable "var_request_uri" -Pattern "http" -IgnoreCase +$condition + +Variable : var_request_uri +Pattern : http +IgnoreCase : True +Negate : False + +$condition | Format-Table + +Variable Pattern IgnoreCase Negate +-------- ------- ---------- ------ +var_request_uri http True False +``` + +This command creates a condition in a rewrite rule and stores the result in the variable named $condition. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreCase +Set this flag to ignore case on the pattern + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Negate +Set this flag to negate the condition validation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +Pattern to look for in the Variable Header + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Variable +Name of the Header to set condition on it + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleCondition + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRewriteRuleSet](./Add-AzApplicationGatewayRewriteRuleSet.md) + +[Get-AzApplicationGatewayRewriteRuleSet](./Get-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRuleSet](./New-AzApplicationGatewayRewriteRuleSet.md) + +[Remove-AzApplicationGatewayRewriteRuleSet](./Remove-AzApplicationGatewayRewriteRuleSet.md) + +[Set-AzApplicationGatewayRewriteRuleSet](./Set-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRule](./New-AzApplicationGatewayRewriteRule.md) + +[New-AzApplicationGatewayRewriteRuleActionSet](./New-AzApplicationGatewayRewriteRuleActionSet.md) diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleHeaderConfiguration.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleHeaderConfiguration.md new file mode 100644 index 0000000000..eb00111cf7 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleHeaderConfiguration.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayrewriteruleheaderconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRewriteRuleHeaderConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRewriteRuleHeaderConfiguration.md +--- + +# New-AzApplicationGatewayRewriteRuleHeaderConfiguration + +## SYNOPSIS +Creates a rewrite rule header configuration for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayRewriteRuleHeaderConfiguration -HeaderName <String> [-HeaderValue <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +**The AzApplicationGatewayRewriteRuleHeaderConfiguration** cmdlet creates a rewrite rule action set for an Azure application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$hc = New-AzApplicationGatewayRewriteRuleHeaderConfiguration -HeaderName abc -HeaderValue def +``` + +This command creates a rewrite rule header configuration and stores the result in the variable named $hc. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderName +Name of the Header to rewrite + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderValue +Header value to the set for the given header name. +Header will be deleted if this is omitted + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHeaderConfiguration + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRewriteRuleSet](./Add-AzApplicationGatewayRewriteRuleSet.md) + +[Get-AzApplicationGatewayRewriteRuleSet](./Get-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRuleSet](./New-AzApplicationGatewayRewriteRuleSet.md) + +[Remove-AzApplicationGatewayRewriteRuleSet](./Remove-AzApplicationGatewayRewriteRuleSet.md) + +[Set-AzApplicationGatewayRewriteRuleSet](./Set-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRule](./New-AzApplicationGatewayRewriteRule.md) + +[New-AzApplicationGatewayRewriteRuleActionSet](./New-AzApplicationGatewayRewriteRuleActionSet.md) diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleSet.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleSet.md new file mode 100644 index 0000000000..564c67315a --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleSet.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayrewriteruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRewriteRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRewriteRuleSet.md +--- + +# New-AzApplicationGatewayRewriteRuleSet + +## SYNOPSIS +Creates a rewrite rule set for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayRewriteRuleSet -Name <String> + -RewriteRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRule]> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +**The New-AzApplicationGatewayRewriteRuleSet** cmdlet creates a rewrite rule set for an Azure application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$ruleset = New-AzApplicationGatewayRewriteRuleSet -Name ruleset1 -RewriteRule $rule +``` + +This command creates a rewrite rule set named ruleset1 and stores the result in the variable named $ruleset. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the RewriteRuleSet + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RewriteRule +List of rewrite rules + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRule] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleSet + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRewriteRuleSet](./Add-AzApplicationGatewayRewriteRuleSet.md) + +[Get-AzApplicationGatewayRewriteRuleSet](./Get-AzApplicationGatewayRewriteRuleSet.md) + +[Remove-AzApplicationGatewayRewriteRuleSet](./Remove-AzApplicationGatewayRewriteRuleSet.md) + +[Set-AzApplicationGatewayRewriteRuleSet](./Set-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRule](./New-AzApplicationGatewayRewriteRule.md) + +[New-AzApplicationGatewayRewriteRuleActionSet](./New-AzApplicationGatewayRewriteRuleActionSet.md) + +[New-AzApplicationGatewayRewriteRuleHeaderConfiguration](./New-AzApplicationGatewayRewriteRuleHeaderConfiguration.md) diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleUrlConfiguration.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleUrlConfiguration.md new file mode 100644 index 0000000000..ffb0768a40 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRewriteRuleUrlConfiguration.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayrewriteruleurlconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRewriteRuleUrlConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRewriteRuleUrlConfiguration.md +--- + +# New-AzApplicationGatewayRewriteRuleUrlConfiguration + +## SYNOPSIS +Creates a rewrite rule url configuration for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayRewriteRuleUrlConfiguration [-ModifiedPath <String>] [-ModifiedQueryString <String>] + [-Reroute] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +**The AzApplicationGatewayRewriteRuleUrlConfiguration** cmdlet creates a rewrite rule url configuration for an Azure application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$urlConfiguration = New-AzApplicationGatewayRewriteRuleUrlConfiguration -ModifiedPath "/abc" -ModifiedQueryString "x=y&a=b" +``` + +This command creates a rewrite rule url configuration and stores the result in the variable named $urlConfiguration. + +If you want to update any existing UrlConfiguration, you can do it by creating a new UrlConfiguration and assigning the new UrlConfiguration to the UrlConfiguration property of Rewrite Rule Action Set. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModifiedPath +Url path value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModifiedQueryString +Url query string value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reroute +Flag to re-evaluate the url path map provided in path based request routing rules using modified path. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlConfiguration + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRewriteRuleSet](./Add-AzApplicationGatewayRewriteRuleSet.md) + +[Get-AzApplicationGatewayRewriteRuleSet](./Get-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRuleSet](./New-AzApplicationGatewayRewriteRuleSet.md) + +[Remove-AzApplicationGatewayRewriteRuleSet](./Remove-AzApplicationGatewayRewriteRuleSet.md) + +[Set-AzApplicationGatewayRewriteRuleSet](./Set-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRule](./New-AzApplicationGatewayRewriteRule.md) + +[New-AzApplicationGatewayRewriteRuleActionSet](./New-AzApplicationGatewayRewriteRuleActionSet.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayRoutingRule.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRoutingRule.md new file mode 100644 index 0000000000..e86c7c485a --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayRoutingRule.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayroutingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRoutingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayRoutingRule.md +--- + +# New-AzApplicationGatewayRoutingRule + +## SYNOPSIS +Creates a routing rule for an application gateway. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzApplicationGatewayRoutingRule -Name <String> -RuleType <String> -Priority <Int32> + [-BackendSettings <PSApplicationGatewayBackendSettings>] [-Listener <PSApplicationGatewayListener>] + [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzApplicationGatewayRoutingRule -Name <String> -RuleType <String> -Priority <Int32> + [-BackendSettingsId <String>] [-ListenerId <String>] [-BackendAddressPoolId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +**The Add-AzApplicationGatewayRoutingRule** cmdlet creates a routing rule for an Azure application gateway. + +## EXAMPLES + +### Example 1: Create a routing rule for an application gateway +```powershell +$Rule = New-AzApplicationGatewayRoutingRule -Name "Rule01" -RuleType Basic -Priority 100 -BackendSettings $Setting -Listener $Listener -BackendAddressPool $Pool +``` + +This command creates a basic routing rule named Rule01 and stores the result in the variable named $Rule. + +## PARAMETERS + +### -BackendAddressPool +Application gateway BackendAddressPool + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +ID of the application gateway BackendAddressPool + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendSettings +Application gateway BackendSettings + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendSettings +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendSettingsId +ID of the application gateway BackendSettings + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Listener +Application gateway Listener + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayListener +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListenerId +ID of the application gateway Listener + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Routing Rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The priority of the rule + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleType +The type of rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, PathBasedRouting + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRoutingRule + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRoutingRule](./Add-AzApplicationGatewayRoutingRule.md) + +[Get-AzApplicationGatewayRoutingRule](./Get-AzApplicationGatewayRoutingRule.md) + +[Remove-AzApplicationGatewayRoutingRule](./Remove-AzApplicationGatewayRoutingRule.md) + +[Set-AzApplicationGatewayRoutingRule](./Set-AzApplicationGatewayRoutingRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewaySku.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewaySku.md new file mode 100644 index 0000000000..2040fbd77e --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewaySku.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 48C33FAF-83C1-4725-AD2A-CF48D0718182 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewaysku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewaySku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewaySku.md +--- + +# New-AzApplicationGatewaySku + +## SYNOPSIS +Creates a SKU for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewaySku -Name <String> -Tier <String> [-Capacity <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewaySku** cmdlet creates a stock keeping unit (SKU) for an Azure application gateway. + +## EXAMPLES + +### Example 1: Create a SKU for an Azure application gateway +```powershell +$SKU = New-AzApplicationGatewaySku -Name "Standard_Small" -Tier "Standard" -Capacity 2 +``` + +This command creates a SKU named Standard_Small for an Azure application gateway and stores the result in the variable named $SKU. + +## PARAMETERS + +### -Capacity +Specifies the number of instances of an application gateway. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the SKU. +The acceptable values for this parameter are: +- Standard_Small +- Standard_Medium +- Standard_Large +- WAF_Medium +- WAF_Large +- Standard_v2 +- WAF_v2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Standard_Small, Standard_Medium, Standard_Large, WAF_Medium, WAF_Large, Standard_v2, WAF_v2 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tier +Specifies the tier of the SKU. +The acceptable values for this parameter are: +- Standard +- WAF +- Standard_v2 +- WAF_v2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Standard, WAF, Standard_v2, WAF_v2 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewaySku](./Get-AzApplicationGatewaySku.md) + +[Set-AzApplicationGatewaySku](./Set-AzApplicationGatewaySku.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewaySslCertificate.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewaySslCertificate.md new file mode 100644 index 0000000000..93f344a732 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewaySslCertificate.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 6FFE1B64-C80B-423D-A043-55C90A224752 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewaysslcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewaySslCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewaySslCertificate.md +--- + +# New-AzApplicationGatewaySslCertificate + +## SYNOPSIS +Creates an SSL certificate for an Azure application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewaySslCertificate -Name <String> [-CertificateFile <String>] [-Password <SecureString>] + [-KeyVaultSecretId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewaySslCertificate** cmdlet creates an SSL certificate for an Azure application gateway. + +## EXAMPLES + +### Example 1: Create an SSL certificate for an Azure application gateway. +```powershell +$password = ConvertTo-SecureString $passwordPlainString -AsPlainText -Force +$cert = New-AzApplicationGatewaySslCertificate -Name "Cert01" -CertificateFile "D:\cert01.pfx" -Password $password +``` + +This command creates a SSL certificate named Cert01 for the default application gateway and stores the result in the variable named $Cert. + +### Example 2: Create an SSL certificate using KeyVault Secret (version-less secretId) and add to an application gateway. +```powershell +$secret = Get-AzKeyVaultSecret -VaultName "keyvault01" -Name "sslCert01" +$secretId = $secret.Id.Replace($secret.Version, "") # https://<keyvaultname>.vault.azure.net/secrets/ +$cert = New-AzApplicationGatewaySslCertificate -Name "Cert01" -KeyVaultSecretId $secretId +``` + +Get the secret and create an SSL Certificate using `New-AzApplicationGatewaySslCertificate`. +Note: As version-less secretId is provided here, Application Gateway will sync the certificate in regular intervals with the KeyVault. + +### Example 3: Create an SSL certificate using KeyVault Secret and add to an Application Gateway. +```powershell +$secret = Get-AzKeyVaultSecret -VaultName "keyvault01" -Name "sslCert01" +$secretId = $secret.Id # https://<keyvaultname>.vault.azure.net/secrets/<hash> +$cert = New-AzApplicationGatewaySslCertificate -Name "Cert01" -KeyVaultSecretId $secretId +``` + +Get the secret and create an SSL Certificate using `New-AzApplicationGatewaySslCertificate`. +Note: If it is required that Application Gateway syncs the certificate with the KeyVault, please provide the version-less secretId. + +## PARAMETERS + +### -CertificateFile +Specifies the path of the .pfx file of the SSL certificate that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultSecretId +SecretId (uri) of the KeyVault Secret. Use this option when a specific version of secret needs to be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the SSL certificate that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Specifies the password of the SSL that this cmdlet creates. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewaySslCertificate](./Add-AzApplicationGatewaySslCertificate.md) + +[Get-AzApplicationGatewaySslCertificate](./Get-AzApplicationGatewaySslCertificate.md) + +[Remove-AzApplicationGatewaySslCertificate](./Remove-AzApplicationGatewaySslCertificate.md) + +[Set-AzApplicationGatewaySslCertificate](./Set-AzApplicationGatewaySslCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewaySslPolicy.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewaySslPolicy.md new file mode 100644 index 0000000000..b30fc7eb6d --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewaySslPolicy.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 98FA4E95-CAC5-4FBD-AA84-113BE9ED7FEA +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewaysslpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewaySslPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewaySslPolicy.md +--- + +# New-AzApplicationGatewaySslPolicy + +## SYNOPSIS +Creates an SSL policy for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewaySslPolicy [-DisabledSslProtocols <String[]>] [-PolicyType <String>] + [-PolicyName <String>] [-CipherSuite <String[]>] [-MinProtocolVersion <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewaySslPolicy** cmdlet creates an SSL policy for an application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$sslPolicy = New-AzApplicationGatewaySslPolicy -PolicyType Custom -MinProtocolVersion TLSv1_1 -CipherSuite "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_AES_128_GCM_SHA256" +``` + +This command creates a custom policy. + +## PARAMETERS + +### -CipherSuite +Ssl cipher suites to be enabled in the specified order to application gateway + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledSslProtocols +Specifies which protocols are disabled. +The acceptable values for this parameter are: +- TLSv1_0 +- TLSv1_1 +- TLSv1_2 + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinProtocolVersion +Minimum version of Ssl protocol to be supported on application gateway + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Name of Ssl predefined policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyType +Type of Ssl Policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Predefined, Custom, CustomV2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Get-AzApplicationGatewaySslPolicy](./Get-AzApplicationGatewaySslPolicy.md) + +[Set-AzApplicationGatewaySslPolicy](./Set-AzApplicationGatewaySslPolicy.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewaySslProfile.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewaySslProfile.md new file mode 100644 index 0000000000..7b4a5af579 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewaySslProfile.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewaysslprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewaySslProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewaySslProfile.md +--- + +# New-AzApplicationGatewaySslProfile + +## SYNOPSIS +Creates SSL profile for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewaySslProfile -Name <String> [-SslPolicy <PSApplicationGatewaySslPolicy>] + [-ClientAuthConfiguration <PSApplicationGatewayClientAuthConfiguration>] + [-TrustedClientCertificates <PSApplicationGatewayTrustedClientCertificate[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewaySslProfile** cmdlet creates SSL profile for an application gateway. The ssl profile is configured on the HTTPS listeners. + +## EXAMPLES + +### Example 1 +```powershell +$sslPolicy = New-AzApplicationGatewaySslPolicy -PolicyType Custom -MinProtocolVersion TLSv1_1 -CipherSuite "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_AES_128_GCM_SHA256" +$trustedClient01 = New-AzApplicationGatewayTrustedClientCertificate -Name "ClientCert01" -CertificateFile "C:\clientCAChain1.cer" +$profile = New-AzApplicationGatewaySslProfile -Name $sslProfile01Name -SslPolicy $sslPolicy -TrustedClientCertificates $trustedClient01 +``` + +The first command creates a new SSL policy and stores it in the $sslPolicy variable. +The second command creates a trusted client CA certificate chains and stores them in the $ClientCert01 variable. +The third command create a new SSL profile with the the ssl policy and trusted client CA certificate chain. + +## PARAMETERS + +### -ClientAuthConfiguration +Client authentication configuration settings + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayClientAuthConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the SSL profile + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslPolicy +SSL policy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedClientCertificates +The trusted client CA certificate chains + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedClientCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewaySslProfile](./Add-AzApplicationGatewaySslProfile.md) + +[Get-AzApplicationGatewaySslProfile](./Get-AzApplicationGatewaySslProfile.md) + +[Remove-AzApplicationGatewaySslProfile](./Remove-AzApplicationGatewaySslProfile.md) + +[Set-AzApplicationGatewaySslProfile](./Set-AzApplicationGatewaySslProfile.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayTrustedClientCertificate.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayTrustedClientCertificate.md new file mode 100644 index 0000000000..97ee8bcac0 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayTrustedClientCertificate.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewaytrustedclientcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayTrustedClientCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayTrustedClientCertificate.md +--- + +# New-AzApplicationGatewayTrustedClientCertificate + +## SYNOPSIS +Creates a trusted client CA certificate chain for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayTrustedClientCertificate -Name <String> -CertificateFile <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzApplicationGatewayTrustedClientCertificate cmdlet creates a trusted client CA certificate chain for an application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$trustedClient = New-AzApplicationGatewayTrustedClientCertificate -Name "ClientCert" -CertificateFile "C:\clientCAChain.cer" +``` + +The command creates a new trusted client CA certificate chain object taking path of the client CA certificate as input. + +## PARAMETERS + +### -CertificateFile +Path of the trusted client CA certificate chain file + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the trusted client CA certificate chain + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedClientCertificate + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayTrustedClientCertificate](./Add-AzApplicationGatewayTrustedClientCertificate.md) + +[Get-AzApplicationGatewayTrustedClientCertificate](./Get-AzApplicationGatewayTrustedClientCertificate.md) + +[Remove-AzApplicationGatewayTrustedClientCertificate](./Remove-AzApplicationGatewayTrustedClientCertificate.md) + +[Set-AzApplicationGatewayTrustedClientCertificate](./Set-AzApplicationGatewayTrustedClientCertificate.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayTrustedRootCertificate.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayTrustedRootCertificate.md new file mode 100644 index 0000000000..13f150e37b --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayTrustedRootCertificate.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewaytrustedrootcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayTrustedRootCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayTrustedRootCertificate.md +--- + +# New-AzApplicationGatewayTrustedRootCertificate + +## SYNOPSIS +Creates a Trusted Root Certificate for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayTrustedRootCertificate -Name <String> -CertificateFile <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayTrustedRootCertificate** cmdlet creates a Trusted Root Certificate for an Azure application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$certFilePath = ".\rootCA.cer" +$trc = New-AzApplicationGatewayTrustedRootCertificate -Name "trc1" -CertificateFile $certFilePath +``` + +This command creates a Trusted Root Certificate named List "trc1" and stores the result in the variable named $trc. + +## PARAMETERS + +### -CertificateFile +Path of certificate CER file + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the TrustedRoot certificate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayTrustedRootCertificate](./Add-AzApplicationGatewayTrustedRootCertificate.md) + +[Get-AzApplicationGatewayTrustedRootCertificate](./Get-AzApplicationGatewayTrustedRootCertificate.md) + +[Remove-AzApplicationGatewayTrustedRootCertificate](./Remove-AzApplicationGatewayTrustedRootCertificate.md) + +[Set-AzApplicationGatewayTrustedRootCertificate](./Set-AzApplicationGatewayTrustedRootCertificate.md) diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayUrlPathMapConfig.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayUrlPathMapConfig.md new file mode 100644 index 0000000000..46de6a87e5 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayUrlPathMapConfig.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: F312FD6E-AF0F-4901-B763-741E1B46A654 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewayurlpathmapconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayUrlPathMapConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayUrlPathMapConfig.md +--- + +# New-AzApplicationGatewayUrlPathMapConfig + +## SYNOPSIS +Creates an array of URL path mappings to a backend server pool. + +## SYNTAX + +### BackendSetByResource (Default) +``` +New-AzApplicationGatewayUrlPathMapConfig -Name <String> -PathRules <PSApplicationGatewayPathRule[]> + -DefaultBackendAddressPool <PSApplicationGatewayBackendAddressPool> + -DefaultBackendHttpSettings <PSApplicationGatewayBackendHttpSettings> + [-DefaultRewriteRuleSet <PSApplicationGatewayRewriteRuleSet>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### BackendSetByResourceId +``` +New-AzApplicationGatewayUrlPathMapConfig -Name <String> -PathRules <PSApplicationGatewayPathRule[]> + -DefaultBackendAddressPoolId <String> -DefaultBackendHttpSettingsId <String> + [-DefaultRewriteRuleSetId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RedirectSetByResource +``` +New-AzApplicationGatewayUrlPathMapConfig -Name <String> -PathRules <PSApplicationGatewayPathRule[]> + [-DefaultRewriteRuleSet <PSApplicationGatewayRewriteRuleSet>] + -DefaultRedirectConfiguration <PSApplicationGatewayRedirectConfiguration> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RedirectSetByResourceId +``` +New-AzApplicationGatewayUrlPathMapConfig -Name <String> -PathRules <PSApplicationGatewayPathRule[]> + [-DefaultRewriteRuleSetId <String>] -DefaultRedirectConfigurationId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayUrlPathMapConfig** cmdlet creates an array of URL path mappings to a backend server pool. + +## EXAMPLES + +### Example 1: Create an array of URL path mappings to a backend server pool +```powershell +New-AzApplicationGatewayUrlPathMapConfig -Name $UrlPathMapName -PathRules $VideoPathRule, $ImagePathRule -DefaultBackendAddressPool $Pool -DefaultBackendHttpSettings $PoolSetting02 +``` + +This command creates an array of URL path mappings to a backend server pool. + +## PARAMETERS + +### -DefaultBackendAddressPool +Specifies the default backend address pool to route in case none of the rules specified in the *pathRules* parameter match. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool +Parameter Sets: BackendSetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultBackendAddressPoolId +Specifies the default backend address pool ID. + +```yaml +Type: System.String +Parameter Sets: BackendSetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultBackendHttpSettings +Specifies the default backend HTTP settings to use in case none of the rules specified in the *pathRules* parameter match. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings +Parameter Sets: BackendSetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultBackendHttpSettingsId +Specifies the default backend HTTP settings ID. + +```yaml +Type: System.String +Parameter Sets: BackendSetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultRedirectConfiguration +Application gateway default RedirectConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration +Parameter Sets: RedirectSetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultRedirectConfigurationId +ID of the application gateway default RedirectConfiguration + +```yaml +Type: System.String +Parameter Sets: RedirectSetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultRewriteRuleSet +Application gateway default rewrite rule set + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleSet +Parameter Sets: BackendSetByResource, RedirectSetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultRewriteRuleSetId +ID of the application gateway default rewrite rule set + +```yaml +Type: System.String +Parameter Sets: BackendSetByResourceId, RedirectSetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the URL path map name that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PathRules +Specifies a list of path rules. +Note that the path rules are order sensitive, they are applied in order they are specified. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayUrlPathMapConfig](./Add-AzApplicationGatewayUrlPathMapConfig.md) + +[Get-AzApplicationGatewayUrlPathMapConfig](./Get-AzApplicationGatewayUrlPathMapConfig.md) + +[Remove-AzApplicationGatewayUrlPathMapConfig](./Remove-AzApplicationGatewayUrlPathMapConfig.md) + +[Set-AzApplicationGatewayUrlPathMapConfig](./Set-AzApplicationGatewayUrlPathMapConfig.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationGatewayWebApplicationFirewallConfiguration.md b/azps-10.1.0/Az.Network/New-AzApplicationGatewayWebApplicationFirewallConfiguration.md new file mode 100644 index 0000000000..8e9413697e --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationGatewayWebApplicationFirewallConfiguration.md @@ -0,0 +1,251 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 76DB6AF5-BF6F-436C-8500-626468F84466 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationgatewaywebapplicationfirewallconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayWebApplicationFirewallConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationGatewayWebApplicationFirewallConfiguration.md +--- + +# New-AzApplicationGatewayWebApplicationFirewallConfiguration + +## SYNOPSIS +Creates a WAF configuration for an application gateway. + +## SYNTAX + +``` +New-AzApplicationGatewayWebApplicationFirewallConfiguration -Enabled <Boolean> -FirewallMode <String> + [-RuleSetType <String>] [-RuleSetVersion <String>] + [-DisabledRuleGroup <PSApplicationGatewayFirewallDisabledRuleGroup[]>] [-RequestBodyCheck <Boolean>] + [-MaxRequestBodySizeInKb <Int32>] [-FileUploadLimitInMb <Int32>] + [-Exclusion <PSApplicationGatewayFirewallExclusion[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationGatewayWebApplicationFirewallConfiguration** cmdlet creates a web application firewall (WAF) configuration for an Azure application gateway. + +## EXAMPLES + +### Example 1: Create a web application firewall configuration for an application gateway +```powershell +$disabledRuleGroup1 = New-AzApplicationGatewayFirewallDisabledRuleGroupConfig -RuleGroupName "REQUEST-942-APPLICATION-ATTACK-SQLI" -Rules 942130,942140 +$disabledRuleGroup2 = New-AzApplicationGatewayFirewallDisabledRuleGroupConfig -RuleGroupName "REQUEST-921-PROTOCOL-ATTACK" +$firewallConfig = New-AzApplicationGatewayWebApplicationFirewallConfiguration -Enabled $true -FirewallMode "Prevention" -RuleSetType "OWASP" -RuleSetVersion "3.0" -DisabledRuleGroups $disabledRuleGroup1,$disabledRuleGroup2 +``` + +The first command creates a new disabled rule group configuration for the rule group named "REQUEST-942-APPLICATION-ATTACK-SQLI" with rule 942130 and rule 942140 being disabled. +The second command creates another disabled rule group configuration for a rule group named "REQUEST-921-PROTOCOL-ATTACK". No rules are specifically passed and thus all rules of the rule group will be disabled. +The last command then creates a WAF configuration with firewall rules disabled as configured in $disabledRuleGroup1 and $disabledRuleGroup2. The new WAF configuration is stored in the $firewallConfig variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledRuleGroup +The disabled rule groups. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallDisabledRuleGroup[] +Parameter Sets: (All) +Aliases: DisabledRuleGroups + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Indicates whether the WAF is enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exclusion +The exclusion lists. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallExclusion[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileUploadLimitInMb +Max file upload limit in MB. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallMode +Specifies the web application firewall mode. +The acceptable values for this parameter are: +- Detection +- Prevention + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Detection, Prevention + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxRequestBodySizeInKb +Max request body size in KB. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestBodyCheck +Whether request body is checked or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSetType +The type of the web application firewall rule set. +The acceptable values for this parameter are: +- OWASP + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: OWASP + +Required: False +Position: Named +Default value: OWASP +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSetVersion +The version of the rule set type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 3.0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallConfiguration + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayWebApplicationFirewallConfiguration](./Get-AzApplicationGatewayWebApplicationFirewallConfiguration.md) + +[Set-AzApplicationGatewayWebApplicationFirewallConfiguration](./Set-AzApplicationGatewayWebApplicationFirewallConfiguration.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzApplicationSecurityGroup.md b/azps-10.1.0/Az.Network/New-AzApplicationSecurityGroup.md new file mode 100644 index 0000000000..1016c73ddc --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzApplicationSecurityGroup.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azapplicationsecuritygroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationSecurityGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzApplicationSecurityGroup.md +--- + +# New-AzApplicationSecurityGroup + +## SYNOPSIS +Creates an application security group. + +## SYNTAX + +``` +New-AzApplicationSecurityGroup -ResourceGroupName <String> -Name <String> -Location <String> [-Tag <Hashtable>] + [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzApplicationSecurityGroup** cmdlet creates an application security group. + +## EXAMPLES + +### Example 1 +```powershell +New-AzApplicationSecurityGroup -ResourceGroupName "MyResourceGroup" -Name "MyApplicationSecurityGroup" -Location "West US" +``` + +This example creates an application security group with no associations. Once it is created, IP configurations in the network interface can be included in the group. Security rules may also refer to the group as their sources or destinations. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the application security group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the application security group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationSecurityGroup](./Get-AzApplicationSecurityGroup.md) + +[Remove-AzApplicationSecurityGroup](./Remove-AzApplicationSecurityGroup.md) + +[New-AzNetworkSecurityRuleConfig](./New-AzNetworkSecurityRuleConfig.md) + +[Add-AzNetworkSecurityRuleConfig](./Add-AzNetworkSecurityRuleConfig.md) + +[Set-AzNetworkSecurityRuleConfig](./Set-AzNetworkSecurityRuleConfig.md) + +[New-AzNetworkInterfaceIpConfig](./New-AzNetworkInterfaceIpConfig.md) + +[Add-AzNetworkInterfaceIpConfig](./Add-AzNetworkInterfaceIpConfig.md) + +[Set-AzNetworkInterfaceIpConfig](./Set-AzNetworkInterfaceIpConfig.md) diff --git a/azps-10.1.0/Az.Network/New-AzBastion.md b/azps-10.1.0/Az.Network/New-AzBastion.md new file mode 100644 index 0000000000..2d7d12481a --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzBastion.md @@ -0,0 +1,497 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azbastion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzBastion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzBastion.md +--- + +# New-AzBastion + +## SYNOPSIS +Creates a bastion resource. + +## SYNTAX + +### ByPublicIpAddressByVirtualNetwork (Default) +``` +New-AzBastion -ResourceGroupName <String> -Name <String> -PublicIpAddress <PSPublicIpAddress> + -VirtualNetwork <PSVirtualNetwork> [-Sku <String>] [-ScaleUnit <Int32>] [-AsJob] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByPublicIpAddressByVirtualNetworkRGNameByVirtualNetworkName +``` +New-AzBastion -ResourceGroupName <String> -Name <String> -PublicIpAddress <PSPublicIpAddress> + -VirtualNetworkRgName <String> -VirtualNetworkName <String> [-Sku <String>] [-ScaleUnit <Int32>] [-AsJob] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByPublicIpAddressByVirtualNetworkId +``` +New-AzBastion -ResourceGroupName <String> -Name <String> -PublicIpAddress <PSPublicIpAddress> + -VirtualNetworkId <String> [-Sku <String>] [-ScaleUnit <Int32>] [-AsJob] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByPublicIpAddressIdByVirtualNetwork +``` +New-AzBastion -ResourceGroupName <String> -Name <String> -PublicIpAddressId <String> + -VirtualNetwork <PSVirtualNetwork> [-Sku <String>] [-ScaleUnit <Int32>] [-AsJob] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByPublicIpAddressIdByVirtualNetworkRGNameByVirtualNetworkName +``` +New-AzBastion -ResourceGroupName <String> -Name <String> -PublicIpAddressId <String> + -VirtualNetworkRgName <String> -VirtualNetworkName <String> [-Sku <String>] [-ScaleUnit <Int32>] [-AsJob] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByPublicIpAddressIdByVirtualNetworkId +``` +New-AzBastion -ResourceGroupName <String> -Name <String> -PublicIpAddressId <String> -VirtualNetworkId <String> + [-Sku <String>] [-ScaleUnit <Int32>] [-AsJob] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByPublicIpAddressRgNameByPublicIpAddressNameByVirtualNetwork +``` +New-AzBastion -ResourceGroupName <String> -Name <String> -PublicIpAddressRgName <String> + -PublicIpAddressName <String> -VirtualNetwork <PSVirtualNetwork> [-Sku <String>] [-ScaleUnit <Int32>] [-AsJob] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByPublicIpAddressRgNameByPublicIpAddressNameByVirtualNetworkRGNameByVirtualNetworkName +``` +New-AzBastion -ResourceGroupName <String> -Name <String> -PublicIpAddressRgName <String> + -PublicIpAddressName <String> -VirtualNetworkRgName <String> -VirtualNetworkName <String> [-Sku <String>] + [-ScaleUnit <Int32>] [-AsJob] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByPublicIpAddressRgNameByPublicIpAddressNameByVirtualNetworkId +``` +New-AzBastion -ResourceGroupName <String> -Name <String> -PublicIpAddressRgName <String> + -PublicIpAddressName <String> -VirtualNetworkId <String> [-Sku <String>] [-ScaleUnit <Int32>] [-AsJob] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a bastion resource.This will need a Public Ip Address and a VirtualNetwork. There must be a subnet with name AzureBastionSubnet in this VirtualNetwork.The Pubic Ip Address must be created with Sku Standard. + +## EXAMPLES + +### Example 1 +```powershell +$subnetName = "AzureBastionSubnet" +$subnet = New-AzVirtualNetworkSubnetConfig -Name $subnetName -AddressPrefix 10.0.0.0/24 +$vnet = New-AzVirtualNetwork -Name "TestVnet" -ResourceGroupName "BastionPowershellTest" -Location "westeurope" -AddressPrefix 10.0.0.0/16 -Subnet $subnet +$publicip = New-AzPublicIpAddress -ResourceGroupName "BastionPowershellTest" -Name "Test-Ip" -location "westeurope" -AllocationMethod Dynamic -Sku Standard +$bastion = New-AzBastion -ResourceGroupName "BastionPowershellTest" -Name "test-Bastion2" -PublicIpAddress $publicip -VirtualNetwork $vnet +``` + +```output +IpConfigurations : {IpConf} +DnsName : bst-a9ca868f-ddab-4a50-9f45-a443ea8a0187.bastion.azure.com +ProvisioningState : Succeeded +IpConfigurationsText : [ + { + "Subnet": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/virtualNetworks/TestVnet/subnets/AzureBastionSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/publicIPAddresses/Test-Ip" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAllocationMethod": "Dynamic", + "Name": "IpConf", + "Etag": "W/\"ed810ccd-b3f6-4e22-891e-b0ed0a26d6dd\"", + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/bastionHosts/test-Bastion2/bastionHostIpConfigurations/IpConf" + } + ] +ResourceGroupName : BastionPowershellTest +Location : westeurope +ResourceGuid : +Type : Microsoft.Network/bastionHosts +Tag : +TagsTable : +Name : test-Bastion2 +Etag : W/"ed810ccd-b3f6-4e22-891e-b0ed0a26d6dd" +Id : /subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/bastionHosts/test-Bastion2 +Sku : { + "Name": "Basic" + } +Scale Units : 2 +``` + +This example creates a bastion attached to virtual network "vnet" in the same resource group as the bastion. +There must be a subnet with name AzureBastionSubnet in this vnet. +The Ip Address must be created with Sku Standard. + +### Example 2 +```powershell +$vnet = Get-AzVirtualNetwork -ResourceGroupName "BastionPowershellTest" -Name "testVnet2" +Add-AzVirtualNetworkSubnetConfig -Name "AzureBastionSubnet" -VirtualNetwork $vnet -AddressPrefix "10.0.0.0/24" +$vnet| Set-AzVirtualNetwork +New-AzBastion -ResourceGroupName "BastionPowershellTest" -Name "testBastion2" -PublicIpAddressRgName "BastionPowershellTest" -PublicIpAddressName "testIp2" -VirtualNetworkRgName "BastionPowershellTest" -VirtualNetworkName "testVnet2" +``` + +```output +IpConfigurations : {IpConf} +DnsName : bst-53757658-c4fd-4908-b1a7-0849e555d489.bastion.azure.com +ProvisioningState : Succeeded +IpConfigurationsText : [ + { + "Name": "IpConf", + "Etag": "W/\"7460e5f6-ad41-438b-a595-a63346ed8f16\"", + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/bastionHosts/testBastion2/bastionHostIpConfigurations/IpConf", + "Subnet": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/virtualNetworks/testVnet2/subnets/AzureBastionSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/publicIPAddresses/testIp2" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAllocationMethod": "Dynamic" + } + ] +ResourceGroupName : BastionPowershellTest +Location : westeurope +ResourceGuid : +Type : Microsoft.Network/bastionHosts +Tag : +TagsTable : +Name : testBastion2 +Etag : W/"7460e5f6-ad41-438b-a595-a63346ed8f16" +Id : /subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/bastionHosts/testBastion2 +Sku : { + "Name": "Basic" + } +Scale Units : 2 +``` + +### Example 3 +```powershell +$vnet = Get-AzVirtualNetwork -ResourceGroupName "BastionPowershellTest" -Name "testVnet2" +Add-AzVirtualNetworkSubnetConfig -Name "AzureBastionSubnet" -VirtualNetwork $vnet -AddressPrefix "10.0.0.0/24" +$vnet| Set-AzVirtualNetwork +New-AzBastion -ResourceGroupName "BastionPowershellTest" -Name "testBastion2" -PublicIpAddressRgName "BastionPowershellTest" -PublicIpAddressName "testIp2" -VirtualNetworkRgName "BastionPowershellTest" -VirtualNetworkName "testVnet2" -Sku "Standard" -ScaleUnit 3 +``` + +```output +IpConfigurations : {IpConf} +DnsName : bst-53757658-c4fd-4908-b1a7-0849e555d489.bastion.azure.com +ProvisioningState : Succeeded +IpConfigurationsText : [ + { + "Name": "IpConf", + "Etag": "W/\"7460e5f6-ad41-438b-a595-a63346ed8f16\"", + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/bastionHosts/testBastion2/bastionHostIpConfigurations/IpConf", + "Subnet": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/virtualNetworks/testVnet2/subnets/AzureBastionSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/publicIPAddresses/testIp2" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAllocationMethod": "Dynamic" + } + ] +ResourceGroupName : BastionPowershellTest +Location : westeurope +ResourceGuid : +Type : Microsoft.Network/bastionHosts +Tag : +TagsTable : +Name : testBastion2 +Etag : W/"7460e5f6-ad41-438b-a595-a63346ed8f16" +Id : /subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/bastionHosts/testBastion2 +Sku : { + "Name": "Standard" + } +Scale Units : 3 +``` + +This example creates a BastionHost resource with Standard Sku and 3 Scale Units. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The bastion resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, BastionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddress +The public IP address object for bastion. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: ByPublicIpAddressByVirtualNetwork, ByPublicIpAddressByVirtualNetworkRGNameByVirtualNetworkName, ByPublicIpAddressByVirtualNetworkId +Aliases: PublicIpAddressObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddressId +The public Ip address Azure resource Id for bastion. + +```yaml +Type: System.String +Parameter Sets: ByPublicIpAddressIdByVirtualNetwork, ByPublicIpAddressIdByVirtualNetworkRGNameByVirtualNetworkName, ByPublicIpAddressIdByVirtualNetworkId +Aliases: PublicIpAddressResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddressName +The public Ip address resource name for bastion. + +```yaml +Type: System.String +Parameter Sets: ByPublicIpAddressRgNameByPublicIpAddressNameByVirtualNetwork, ByPublicIpAddressRgNameByPublicIpAddressNameByVirtualNetworkRGNameByVirtualNetworkName, ByPublicIpAddressRgNameByPublicIpAddressNameByVirtualNetworkId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddressRgName +The public Ip address resource group name for bastion. + +```yaml +Type: System.String +Parameter Sets: ByPublicIpAddressRgNameByPublicIpAddressNameByVirtualNetwork, ByPublicIpAddressRgNameByPublicIpAddressNameByVirtualNetworkRGNameByVirtualNetworkName, ByPublicIpAddressRgNameByPublicIpAddressNameByVirtualNetworkId +Aliases: PublicIpAddressResourceGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name where you need to create bastion. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScaleUnit +The Scale Units for BastionHost + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 2 +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sku +The Bastion Sku Tier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, Standard + +Required: False +Position: Named +Default value: Basic +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetwork +The virtual network object for bastion. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork +Parameter Sets: ByPublicIpAddressByVirtualNetwork, ByPublicIpAddressIdByVirtualNetwork, ByPublicIpAddressRgNameByPublicIpAddressNameByVirtualNetwork +Aliases: VirtualNetworkObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkId +The virtual network Azure resource Id for bastion. + +```yaml +Type: System.String +Parameter Sets: ByPublicIpAddressByVirtualNetworkId, ByPublicIpAddressIdByVirtualNetworkId, ByPublicIpAddressRgNameByPublicIpAddressNameByVirtualNetworkId +Aliases: VirtualNetworkResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkName +The virtual network resource name for bastion. + +```yaml +Type: System.String +Parameter Sets: ByPublicIpAddressByVirtualNetworkRGNameByVirtualNetworkName, ByPublicIpAddressIdByVirtualNetworkRGNameByVirtualNetworkName, ByPublicIpAddressRgNameByPublicIpAddressNameByVirtualNetworkRGNameByVirtualNetworkName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRgName +The virtual network resource group name for bastion. + +```yaml +Type: System.String +Parameter Sets: ByPublicIpAddressByVirtualNetworkRGNameByVirtualNetworkName, ByPublicIpAddressIdByVirtualNetworkRGNameByVirtualNetworkName, ByPublicIpAddressRgNameByPublicIpAddressNameByVirtualNetworkRGNameByVirtualNetworkName +Aliases: VirtualNetworkResourceGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBastion + +## NOTES + +## RELATED LINKS + +[Get-AzBastion](./Get-AzBastion.md) + +[Remove-AzBastion](./Remove-AzBastion.md) + +[Set-AzBastion](./Set-AzBastion.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzContainerNicConfig.md b/azps-10.1.0/Az.Network/New-AzContainerNicConfig.md new file mode 100644 index 0000000000..47d1c1487f --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzContainerNicConfig.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-AzContainerNicconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzContainerNicConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzContainerNicConfig.md +--- + +# New-AzContainerNicConfig + +## SYNOPSIS +Creates a new container network interface configuration object. + +## SYNTAX + +``` +New-AzContainerNicConfig [-Name <String>] [-IpConfiguration <PSIPConfigurationProfile[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzContainerNicConfig** cmdlet creates a new container network interface configuration object. This object determines the characteristics of container network interface created referencing the parent network profile. + +## EXAMPLES + +### Example 1 +```powershell +$containerNicConfig = New-AzContainerNicConfig -Name cnicConfig1 + +$networkProfile = New-AzNetworkProfile -Name np1 -ResourceGroupName rg1 -Location westus -ContainerNetworkInterfaceConfiguration $containerNicConfig +``` + +The first command creates an empty container network interface configuration. The second creates a new network profile, passing the previously created container network interface configuration as an argument to the New-NetworkProfile cmdlet. + +### Example 2 + +Creates a new container network interface configuration object. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzContainerNicConfig -IpConfiguration <PSIPConfigurationProfile[]> -Name cnic +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfiguration +Collection of IP configuration profiles which determine what ip configurations are created when a container nic is instantiated from this container network interface configuration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIPConfigurationProfile[] +Parameter Sets: (All) +Aliases: IpConfig + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the container network interface configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIPConfigurationProfile[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSContainerNetworkInterfaceConfiguration + +## NOTES + +## RELATED LINKS + +[New-AzContainerNicConfigIpConfig](./New-AzContainerNicConfigIpConfig.md) diff --git a/azps-10.1.0/Az.Network/New-AzContainerNicConfigIpConfig.md b/azps-10.1.0/Az.Network/New-AzContainerNicConfigIpConfig.md new file mode 100644 index 0000000000..5f90849df2 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzContainerNicConfigIpConfig.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-AzContainerNicconfigipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzContainerNicConfigIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzContainerNicConfigIpConfig.md +--- + +# New-AzContainerNicConfigIpConfig + +## SYNOPSIS +Creates a container nic configuration ip configuration object. + +## SYNTAX + +``` +New-AzContainerNicConfigIpConfig -Name <String> -Subnet <PSSubnet> [-SubnetId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzContainerNicConfigIpConfig** cmdlet creates a new container network interface configuration ip configuration. + +## EXAMPLES + +### Example 1 +```powershell +$subnet = New-AzVirtualNetworkSubnetConfig -Name subnet -AddressPrefix 10.0.1.0/24 + +$vnet = New-AzVirtualNetwork -Name vnet -ResourceGroupName rg1 -Location "West US" -AddressPrefix 10.0.0.0/16 -Subnet $subnet + +$containerNicConfigIpConfig = New-AzContainerNicConfigIpConfig -Name ipconfigprofile1 -Subnet $vnet.Subnets[0] + +$containerNicConfig = New-AzContainerNicConfig -Name cnic -IpConfiguration $containerNicConfigIpConfig + +$networkProfile = New-AzNetworkProfile -Name np1 -Location "West US" -ResourceGroupName rg1 -ContainerNetworkInterfaceConfiguration $containerNicConfig +``` + +The first two commands create and initialize a vnet and a subnet. The third command creates a container nic ip configuration profile referencing the created subnet. The fourth command creates a container network interface configuration supplying the ip configuration profile created in the previous command. Finally, the fifth command creates a network profile initialized with the container network interface configuration stored in $containerNicConfig. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the container network interface configuration ip configuration profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Subnet + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +SubnetId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSContainerNetworkInterfaceConfiguration + +## NOTES + +## RELATED LINKS + +[New-AzContainerNicConfig](./New-AzContainerNicConfig.md) diff --git a/azps-10.1.0/Az.Network/New-AzCustomIpPrefix.md b/azps-10.1.0/Az.Network/New-AzCustomIpPrefix.md new file mode 100644 index 0000000000..be353a6e2d --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzCustomIpPrefix.md @@ -0,0 +1,335 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azcustomipprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzCustomIpPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzCustomIpPrefix.md +--- + +# New-AzCustomIpPrefix + +## SYNOPSIS +Creates a CustomIpPrefix resource + +## SYNTAX + +``` +New-AzCustomIpPrefix -Name <String> -ResourceGroupName <String> -Location <String> -Cidr <String> + [-Asn <String>] [-Geo <String>] [-SignedMessage <String>] [-AuthorizationMessage <String>] + [-ExpressRouteAdvertise] [-CustomIpPrefixParent <PSCustomIpPrefix>] [-IsParent] [-Zone <String[]>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzCustomIpPrefix** cmdlet creates a CustomIpPrefix resource. + +## EXAMPLES + +### Example 1 +```powershell +$myCustomIpPrefix = New-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Cidr "40.40.40.0/24" -Location westus2 -Zone 1,2,3 -AuthorizationMessage $authorizationMessage -SignedMessage $signedMessage +``` + +This command kicks off the provisioning process for a new zone-redundant IPv4 Custom IP Prefix resource with name $prefixName in resource group $rgName with a CIDR of 40.40.40.0/24 in West US 2 region. Note the AuthorizationMessage is a contactenated string (containing the subscription ID, CIDR, and Route Origin Authorization expiration date) and the SignedMessage is the same string signed by X509 certificate offline. + +### Example 2 +```powershell +$myV4ParentPrefix = New-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Cidr "40.40.40.0/24" -Location westus2 -IsParent -AuthorizationMessage $authorizationMessage -SignedMessage $signedMessage +``` + +This command kicks off the provisioning process for a new Parent IPv4 Custom IP Prefix resource with name $prefixName in resource group $rgName with a CIDR of 40.40.40.0/24. + +### Example 3 +```powershell +$myV4ChildIpPrefix = New-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Cidr "40.40.40.0/25" -Location westus2 -CustomIpPrefixParent $myV4ParentPrefix +``` + +This command kicks off the provisioning process for a new Child IPv4 Custom IP Prefix resource with name $prefixName in resource group $rgName with a CIDR of 40.40.40.0/25. Its parent prefix is $myV4ParentPrefix. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Asn +The customIpPrefix ASN code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuthorizationMessage +Authorization message for WAN validation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Cidr +The CustomIpPrefix CIDR. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CustomIpPrefixParent +Parent CustomIpPrefix of resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSCustomIpPrefix +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteAdvertise +Using expressRoute advertise. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Geo +The customIpPrefix GEO code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AFRI, APAC, AQ, EURO, LATAM, ME, NAM, OCEANIA + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IsParent +Denotes that resource is being created as a Parent CustomIpPrefix + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The CustomIpPrefix location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SignedMessage +Signed message for WAN validation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +A list of availability zones denoting the IP allocated for the resource needs to come from. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Network.Models.PSCustomIpPrefix + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSCustomIpPrefix + +## NOTES + +## RELATED LINKS + +[Get-AzCustomIpPrefix](./Get-AzCustomIpPrefix.md) + +[Remove-AzCustomIpPrefix](./Remove-AzCustomIpPrefix.md) + +[Update-AzCustomIpPrefix](./Update-AzCustomIpPrefix.md) diff --git a/azps-10.1.0/Az.Network/New-AzDdosProtectionPlan.md b/azps-10.1.0/Az.Network/New-AzDdosProtectionPlan.md new file mode 100644 index 0000000000..703ed86096 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzDdosProtectionPlan.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azddosprotectionplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzDdosProtectionPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzDdosProtectionPlan.md +--- + +# New-AzDdosProtectionPlan + +## SYNOPSIS +Creates a DDoS protection plan. + +## SYNTAX + +``` +New-AzDdosProtectionPlan -ResourceGroupName <String> -Name <String> -Location <String> [-Tag <Hashtable>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDdosProtectionPlan cmdlet creates a DDoS protection plan. + +## EXAMPLES + +### Example 1: Create and associate a DDoS protection plan with a new virtual network +```powershell +$ddosProtectionPlan = New-AzDdosProtectionPlan -ResourceGroupName ResourceGroupName -Name DdosProtectionPlanName -Location "West US" +$subnet = New-AzVirtualNetworkSubnetConfig -Name SubnetName -AddressPrefix 10.0.1.0/24 +$vnet = New-AzVirtualNetwork -Name VnetName -ResourceGroupName ResourceGroupName -Location "West US" -AddressPrefix 10.0.0.0/16 -DnsServer 8.8.8.8 -Subnet $subnet -EnableDdoSProtection -DdosProtectionPlanId $ddosProtectionPlan.Id +``` + +First, we create a new DDoS Protection plan with the **New-AzDdosProtectionPlan** command. +Then, we create a new virtual network with **New-AzVirtualNetwork** and we specify the ID of the newly created plan in the parameter **DdosProtectionPlanId**. In this case, since we are associating the virtual network with a plan, we can also specify the parameter **EnableDdoSProtection**. + +### Example 2: Create and associate a DDoS protection plan with an existing virtual network +```powershell +$ddosProtectionPlan = New-AzDdosProtectionPlan -ResourceGroupName ResourceGroupName -Name DdosProtectionPlanName -Location "West US" +$vnet = Get-AzVirtualNetwork -Name VnetName -ResourceGroupName ResourceGroupName +$vnet.DdosProtectionPlan = New-Object Microsoft.Azure.Commands.Network.Models.PSResourceId +$vnet.DdosProtectionPlan.Id = $ddosProtectionPlan.Id +$vnet.EnableDdosProtection = $true +$vnet | Set-AzVirtualNetwork +``` + +```output +Name : VnetName +ResourceGroupName : ResourceGroupName +Location : westus +Id : /subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName +Etag : W/"fbf41754-3c13-43fd-bb5b-fcc37d5e1cbb" +ResourceGuid : fcb7bc1e-ee0d-4005-b3f1-feda76e3756c +ProvisioningState : Succeeded +Tags : +AddressSpace : { + "AddressPrefixes": [ + "10.0.0.0/16" + ] + } +DhcpOptions : { + "DnsServers": [ + "8.8.8.8" + ] + } +Subnets : [ + { + "Name": "SubnetName", + "Etag": "W/\"fbf41754-3c13-43fd-bb5b-fcc37d5e1cbb\"", + "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName/subnets/SubnetName", + "AddressPrefix": "10.0.1.0/24", + "IpConfigurations": [], + "ResourceNavigationLinks": [], + "ServiceEndpoints": [], + "ProvisioningState": "Succeeded" + } + ] +VirtualNetworkPeerings : [] +EnableDdosProtection : true +DdosProtectionPlan : { + "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/ddosProtectionPlans/DdosProtectionPlanName" + } +EnableVmProtection : false +``` + +First, we create a new DDoS Protection plan with the **New-AzDdosProtectionPlan** command. +Second, we get the most updated version of the virtual network we want to associate with the plan. We update the property **DdosProtectionPlan** with a **PSResourceId** object containing a reference to the ID of the newly created plan. In this case, if we associate the virtual network with a DDoS protection plan, we can also set the flag **EnableDdosProtection** to true. +Finally, we persist the new state by piping the local variable into **Set-AzVirtualNetwork**. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the DDoS protection plan to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the DDoS protection plan to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group of the DDoS protection plan to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSDdosProtectionPlan + +## NOTES + +## RELATED LINKS + +[Get-AzDdosProtectionPlan](./Get-AzDdosProtectionPlan.md) + +[Remove-AzDdosProtectionPlan](./Remove-AzDdosProtectionPlan.md) + +[New-AzVirtualNetwork](./New-AzVirtualNetwork.md) + +[Set-AzVirtualNetwork](./Set-AzVirtualNetwork.md) + +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzDelegation.md b/azps-10.1.0/Az.Network/New-AzDelegation.md new file mode 100644 index 0000000000..08f5c8bc2e --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzDelegation.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azdelegation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzDelegation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzDelegation.md +--- + +# New-AzDelegation + +## SYNOPSIS +Creates a service delegation. + +## SYNTAX + +``` +New-AzDelegation -Name <String> -ServiceName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDelegation** cmdlet creates a service delegation that can be added to a subnet. + +## EXAMPLES + +### Example 1 +```powershell +$delegation = New-AzDelegation -Name "myDelegation" -ServiceName "Microsoft.Sql/servers" +$vnet = Get-AzVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" +$subnet = Get-AzVirtualNetworkSubnetConfig -Name "mySubnet" -VirtualNetwork $vnet +$subnet.Delegations.Add($delegation) +Set-AzVirtualNetwork -VirtualNetwork $vnet +``` + +The first cmdlet creates a delegation that can be added to a subnet, and stores it in the $delegation variable. The second and third cmdlets retrieve the subnet to be delegated. The fourth cmdlet adds the created delegation to the subnet of interest, and the final cmdlet sends the updated configuration to the server. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the delegation + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +The name of the service to which the subnet should be delegated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSDelegation + +## NOTES + +## RELATED LINKS + +[Add-AzDelegation](./Add-AzDelegation.md) +[Get-AzDelegation](./Get-AzDelegation.md) +[Remove-AzDelegation](./Remove-AzDelegation.md) +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) +[Get-AzVirtualNetworkSubnetConfig](./Get-AzVirtualNetworkSubnetConfig.md) +[Set-AzVirtualNetwork](./Set-AzVirtualNetwork.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzExpressRouteCircuit.md b/azps-10.1.0/Az.Network/New-AzExpressRouteCircuit.md new file mode 100644 index 0000000000..1e64c2cf48 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzExpressRouteCircuit.md @@ -0,0 +1,415 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: E40CAF2F-ED57-4AC1-8B9A-E48042DD8F91 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azexpressroutecircuit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRouteCircuit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRouteCircuit.md +--- + +# New-AzExpressRouteCircuit + +## SYNOPSIS +Creates an Azure express route circuit. + +## SYNTAX + +### ServiceProvider (Default) +``` +New-AzExpressRouteCircuit -Name <String> -ResourceGroupName <String> -Location <String> [-SkuTier <String>] + [-SkuFamily <String>] -ServiceProviderName <String> -PeeringLocation <String> -BandwidthInMbps <Int32> + [-Peering <PSPeering[]>] [-Authorization <PSExpressRouteCircuitAuthorization[]>] + [-AllowClassicOperations <Boolean>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ExpressRoutePort +``` +New-AzExpressRouteCircuit -Name <String> -ResourceGroupName <String> -Location <String> [-SkuTier <String>] + [-SkuFamily <String>] -ExpressRoutePort <PSExpressRoutePort> -BandwidthInGbps <Double> + [-AuthorizationKey <String>] [-Peering <PSPeering[]>] [-Authorization <PSExpressRouteCircuitAuthorization[]>] + [-AllowClassicOperations <Boolean>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzExpressRouteCircuit** cmdlet creates an Azure express route circuit. + +## EXAMPLES + +### Example 1: Create a new ExpressRoute circuit +```powershell +$parameters = @{ + Name='ExpressRouteCircuit' + ResourceGroupName='ExpressRouteResourceGroup' + Location='West US' + SkuTier='Standard' + SkuFamily='MeteredData' + ServiceProviderName='Equinix' + PeeringLocation='Silicon Valley' + BandwidthInMbps=200 +} +New-AzExpressRouteCircuit @parameters +``` + +### Example 2: Create a new ExpressRoute circuit on ExpressRoutePort +```powershell +$parameters = @{ + Name='ExpressRouteCircuit' + ResourceGroupName='ExpressRouteResourceGroup' + Location='West US' + SkuTier='Standard' + SkuFamily='MeteredData' + ExpressRoutePort=$PSExpressRoutePort + BandwidthInGbps=10.0 +} +New-AzExpressRouteCircuit @parameters +``` + +## PARAMETERS + +### -AllowClassicOperations +The use of this parameter allows you to use the classic Azure PowerShell cmdlets to manage the +circuit. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +A list of circuit authorizations. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AuthorizationKey +The authorization key used when the circuit is provisioned on an ExpressRoutePort resource in different subscription. + +```yaml +Type: System.String +Parameter Sets: ExpressRoutePort +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BandwidthInGbps +The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. + +```yaml +Type: System.Double +Parameter Sets: ExpressRoutePort +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BandwidthInMbps +The bandwidth of the circuit. This must be a value that is supported by the service provider. + +```yaml +Type: System.Int32 +Parameter Sets: ServiceProvider +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRoutePort +The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort +Parameter Sets: ExpressRoutePort +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the circuit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the ExpressRoute circuit being created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Peering +A list peer configurations. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPeering[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeeringLocation +The name of the peering location supported by the service provider. + +```yaml +Type: System.String +Parameter Sets: ServiceProvider +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group that will contain the circuit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceProviderName +The name of the circuit service provider. This must match a name listed by the +Get-AzExpressRouteServiceProvider cmdlet. + +```yaml +Type: System.String +Parameter Sets: ServiceProvider +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuFamily +SKU family determines the billing type. Possible values for this parameter are: `MeteredData` or +`UnlimitedData`. Note that you can change the billing type from MeteredData to UnlimitedData, but +you can't change the type from UnlimitedData to MeteredData. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: MeteredData, UnlimitedData + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuTier +The tier of service for the circuit. Possible values for this parameter are: `Standard`, `Premium` or `Local`. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Standard, Premium, Basic, Local + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +### System.Double + +### Microsoft.Azure.Commands.Network.Models.PSPeering[] + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization[] + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuit](Get-AzExpressRouteCircuit.md) + +[Move-AzExpressRouteCircuit](Move-AzExpressRouteCircuit.md) + +[Remove-AzExpressRouteCircuit](Remove-AzExpressRouteCircuit.md) + +[Set-AzExpressRouteCircuit](Set-AzExpressRouteCircuit.md) diff --git a/azps-10.1.0/Az.Network/New-AzExpressRouteCircuitAuthorization.md b/azps-10.1.0/Az.Network/New-AzExpressRouteCircuitAuthorization.md new file mode 100644 index 0000000000..78b938219f --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzExpressRouteCircuitAuthorization.md @@ -0,0 +1,101 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: B6E55944-1B78-463F-9FC9-98097FEEC278 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azexpressroutecircuitauthorization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRouteCircuitAuthorization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRouteCircuitAuthorization.md +--- + +# New-AzExpressRouteCircuitAuthorization + +## SYNOPSIS +Creates an ExpressRoute circuit authorization. + +## SYNTAX + +``` +New-AzExpressRouteCircuitAuthorization -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzExpressRouteCircuitAuthorization** cmdlet creates a circuit authorization that can +be added to an ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to the +Microsoft cloud by using a connectivity provider instead of the public Internet. The owner of an +ExpressRoute circuit can create as many as 10 authorizations for each circuit; these authorizations +generate an authorization key that can be used by a virtual network owner to connect a network to +the circuit. There can only one authorization per virtual network. +After you create an ExpressRoute circuit you can use +**Add-AzExpressRouteCircuitAuthorization** to add an authorization to that circuit. +Alternatively, you can use **New-AzExpressRouteCircuitAuthorization** to create an +authorization that can be added to a new circuit at the same time the circuit is created. + +## EXAMPLES + +### Example 1: Create a new circuit authorization +```powershell +$Authorization = New-AzExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" +``` + +This command creates a new circuit authorization named ContosoCircuitAuthorization and then stores +that object in a variable named $Authorization. Saving the object to a variable is important: +although **New-AzExpressRouteCircuitAuthorization** can create a circuit authorization it +cannot add that authorization to a circuit route. Instead, the variable $Authorization is used +New-AzExpressRouteCircuit when creating a brand-new ExpressRoute circuit. +For more information, see the documentation for the New-AzExpressRouteCircuit cmdlet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a unique name for the new ExpressRoute circuit authorization. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization + +## NOTES + +## RELATED LINKS + +[Add-AzExpressRouteCircuitAuthorization](./Add-AzExpressRouteCircuitAuthorization.md) + +[Get-AzExpressRouteCircuitAuthorization](./Get-AzExpressRouteCircuitAuthorization.md) + +[Remove-AzExpressRouteCircuitAuthorization](./Remove-AzExpressRouteCircuitAuthorization.md) + diff --git a/azps-10.1.0/Az.Network/New-AzExpressRouteCircuitPeeringConfig.md b/azps-10.1.0/Az.Network/New-AzExpressRouteCircuitPeeringConfig.md new file mode 100644 index 0000000000..59697c37f1 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzExpressRouteCircuitPeeringConfig.md @@ -0,0 +1,342 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 5E9C02BE-9DCC-4865-95D2-6B69D373BE77 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azexpressroutecircuitpeeringconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRouteCircuitPeeringConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRouteCircuitPeeringConfig.md +--- + +# New-AzExpressRouteCircuitPeeringConfig + +## SYNOPSIS +Creates a new peering configuration to be added to an ExpressRoute circuit. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzExpressRouteCircuitPeeringConfig -Name <String> -PeeringType <String> -PeerASN <UInt32> + -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] + [-MicrosoftConfigAdvertisedPublicPrefixes <String[]>] [-MicrosoftConfigCustomerAsn <Int32>] + [-MicrosoftConfigRoutingRegistryName <String>] [-PeerAddressType <String>] [-LegacyMode <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### MicrosoftPeeringConfigRoutFilterId +``` +New-AzExpressRouteCircuitPeeringConfig -Name <String> -PeeringType <String> -PeerASN <UInt32> + -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] + [-MicrosoftConfigAdvertisedPublicPrefixes <String[]>] [-MicrosoftConfigCustomerAsn <Int32>] + [-MicrosoftConfigRoutingRegistryName <String>] -RouteFilterId <String> [-PeerAddressType <String>] + [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### MicrosoftPeeringConfigRoutFilter +``` +New-AzExpressRouteCircuitPeeringConfig -Name <String> -PeeringType <String> -PeerASN <UInt32> + -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] + [-MicrosoftConfigAdvertisedPublicPrefixes <String[]>] [-MicrosoftConfigCustomerAsn <Int32>] + [-MicrosoftConfigRoutingRegistryName <String>] -RouteFilter <PSRouteFilter> [-PeerAddressType <String>] + [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzExpressRouteCircuitPeeringConfig** cmdlet adds a peering configuration to an +ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to the Microsoft cloud +by using a connectivity provider instead of the public Internet. + +## EXAMPLES + +### Example 1: Create a new ExpressRoute circuit with a peering configuration +```powershell +$parameters = @{ + Name = 'AzurePrivatePeering' + PeeringType = 'AzurePrivatePeering' + PeerASN = 100 + PrimaryPeerAddressPrefix = '10.6.1.0/30' + SecondaryPeerAddressPrefix = '10.6.2.0/30' + VlanId = 200 +} +$PeerConfig = New-AzExpressRouteCircuitPeeringConfig @parameters + +$parameters = @{ + Name='ExpressRouteCircuit' + ResourceGroupName='ExpressRouteResourceGroup' + Location='West US' + SkuTier='Standard' + SkuFamily='MeteredData' + ServiceProviderName='Equinix' + Peering=$PeerConfig + PeeringLocation='Silicon Valley' + BandwidthInMbps=200 +} +New-AzExpressRouteCircuit @parameters +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LegacyMode +The legacy mode of the Peering + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MicrosoftConfigAdvertisedPublicPrefixes +For a PeeringType of MicrosoftPeering, you must provide a list of all prefixes you plan to +advertise over the BGP session. Only public IP address prefixes are accepted. You can send a comma +separated list if you plan to send a set of prefixes. These prefixes must be registered to you in +a Routing Registry Name (RIR / IRR). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftConfigCustomerAsn +If you are advertising prefixes that are not registered to the peering AS number, you can specify +the AS number to which they are registered. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftConfigRoutingRegistryName +The Routing Registry Name (RIR / IRR) to which the AS number and prefixes are registered. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the peering configuration to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerAddressType +PeerAddressType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerASN +The AS number of your ExpressRoute circuit. This must be a Public ASN when the PeeringType is +AzurePublicPeering. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringType +The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and +`MicrosoftPeering` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryPeerAddressPrefix +This is the IP Address range for the primary routing path of this peering relationship. This must +be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your +router interface. Azure will configure the next even-numbered address to the Azure router interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteFilter +This is an existing RouteFilter object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter +Parameter Sets: MicrosoftPeeringConfigRoutFilter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteFilterId +This is the resource Id of an existing RouteFilter object. + +```yaml +Type: System.String +Parameter Sets: MicrosoftPeeringConfigRoutFilterId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryPeerAddressPrefix +This is the IP Address range for the secondary routing path of this peering relationship. This must +be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your +router interface. Azure will configure the next even-numbered address to the Azure router interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedKey +This is an optional MD5 hash used as a pre-shared key for the peering configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VlanId +This is the Id number of the VLAN assigned for this peering. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilter + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPeering + +## NOTES + +## RELATED LINKS + +[Add-AzExpressRouteCircuitPeeringConfig](Add-AzExpressRouteCircuitPeeringConfig.md) + +[Get-AzExpressRouteCircuit](Get-AzExpressRouteCircuit.md) + +[Remove-AzExpressRouteCircuitPeeringConfig](Remove-AzExpressRouteCircuitPeeringConfig.md) + +[Set-AzExpressRouteCircuit](Set-AzExpressRouteCircuit.md) diff --git a/azps-10.1.0/Az.Network/New-AzExpressRouteConnection.md b/azps-10.1.0/Az.Network/New-AzExpressRouteConnection.md new file mode 100644 index 0000000000..e3b1fc7c91 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzExpressRouteConnection.md @@ -0,0 +1,320 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azexpressrouteconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRouteConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRouteConnection.md +--- + +# New-AzExpressRouteConnection + +## SYNOPSIS +Creates an ExpressRoute connection that connects an ExpressRoute gateway to an on premise ExpressRoute circuit + +## SYNTAX + +### ByExpressRouteGatewayName (Default) +``` +New-AzExpressRouteConnection -ResourceGroupName <String> -ExpressRouteGatewayName <String> -Name <String> + -ExpressRouteCircuitPeeringId <String> [-AuthorizationKey <String>] [-RoutingWeight <UInt32>] + [-EnableInternetSecurity] [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByExpressRouteGatewayObject +``` +New-AzExpressRouteConnection -ExpressRouteGatewayObject <PSExpressRouteGateway> -Name <String> + -ExpressRouteCircuitPeeringId <String> [-AuthorizationKey <String>] [-RoutingWeight <UInt32>] + [-EnableInternetSecurity] [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByExpressRouteGatewayResourceId +``` +New-AzExpressRouteConnection -ParentResourceId <String> -Name <String> -ExpressRouteCircuitPeeringId <String> + [-AuthorizationKey <String>] [-RoutingWeight <UInt32>] [-EnableInternetSecurity] + [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an ExpressRoute connection between an on-premise ExpressRoute circuit BGP peering to the ExpressRoute gateway inside a Virtual hub. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West Central US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West Central US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" -VirtualHubId $virtualHub.Id -MinScaleUnits 2 +$ExpressRouteGateway = Get-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" +$ExpressRouteCircuit = New-AzExpressRouteCircuit -ResourceGroupName "testRG" -Name "testExpressRouteCircuit" -Location "West Central US" -SkuTier Premium -SkuFamily MeteredData -ServiceProviderName "Equinix" -PeeringLocation "Silicon Valley" -BandwidthInMbps 200 +Add-AzExpressRouteCircuitPeeringConfig -Name "AzurePrivatePeering" -ExpressRouteCircuit $ExpressRouteCircuit -PeeringType AzurePrivatePeering -PeerASN 100 -PrimaryPeerAddressPrefix "123.0.0.0/30" -SecondaryPeerAddressPrefix "123.0.0.4/30" -VlanId 300 +$ExpressRouteCircuit = Set-AzExpressRouteCircuit -ExpressRouteCircuit $ExpressRouteCircuit +$ExpressRouteCircuitPeeringId = $ExpressRouteCircuit.Peerings[0].Id +New-AzExpressRouteConnection -ResourceGroupName $ExpressRouteGateway.ResourceGroupName -ExpressRouteGatewayName $ExpressRouteGateway.Name -Name "testConnection" -ExpressRouteCircuitPeeringId $ExpressRouteCircuitPeeringId -RoutingWeight 20 +``` + +```output +ExpressRouteCircuitPeeringId : Microsoft.Azure.Commands.Network.Models.PSResourceId +AuthorizationKey : +RoutingWeight : 20 +ProvisioningState : Succeeded +Name : testConnection +Etag : W/"4580a2e2-2fab-4cff-88eb-92013a76b5a8" +Id : /subscriptions/{subscriptionId}/resourceGroups/ps9361/providers/Microsoft.Network/ExpressRouteGateways/testExpressRoutegw/expressRouteConnections/testConnection +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub, Express Route gateway and an ExpressRoute circuit with private peering in West Central US in "testRG" resource group in Azure. +Once the gateway has been created, it is connected to the ExpressRoute Circuit Peering using the New-AzExpressRouteConnection command. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizationKey +A key obtained from the ExpressRoute circuit owner to be able to create a connection with a gateway in a different subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternetSecurity +Enable internet security for this ExpressRoute Gateway connection + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuitPeeringId +The resource id of the Express Route Circuit Peering to which this Express Route gateway connection is to be created to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteGatewayName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteGatewayObject +The parent ExpressRouteGateway for this connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteGateway +Parameter Sets: ByExpressRouteGatewayObject +Aliases: ExpressRouteGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, ExpressRouteConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceId +The resource id of the parent ExpressRouteGateway for this connection. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteGatewayResourceId +Aliases: ExpressRouteGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingConfiguration +Routing configuration for this connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingWeight +The weight for packet routing that needs to be assigned to this connection. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteConnection + +## NOTES + +## RELATED LINKS + +[New-AzRoutingConfiguration](./New-AzRoutingConfiguration.md) diff --git a/azps-10.1.0/Az.Network/New-AzExpressRouteGateway.md b/azps-10.1.0/Az.Network/New-AzExpressRouteGateway.md new file mode 100644 index 0000000000..ae367510e4 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzExpressRouteGateway.md @@ -0,0 +1,283 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azexpressroutegateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRouteGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRouteGateway.md +--- + +# New-AzExpressRouteGateway + +## SYNOPSIS +Creates a Scalable ExpressRoute Gateway. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +New-AzExpressRouteGateway -ResourceGroupName <String> -Name <String> -MinScaleUnits <UInt32> + [-MaxScaleUnits <UInt32>] -VirtualHubName <String> [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +New-AzExpressRouteGateway -ResourceGroupName <String> -Name <String> -MinScaleUnits <UInt32> + [-MaxScaleUnits <UInt32>] -VirtualHub <PSVirtualHub> [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +New-AzExpressRouteGateway -ResourceGroupName <String> -Name <String> -MinScaleUnits <UInt32> + [-MaxScaleUnits <UInt32>] -VirtualHubId <String> [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +New-AzExpressRouteGateway creates a scalable ExpressRoute Gateway. This is software defined connectivity for on premise to Azure inside the VirtualHub. + +This gateway can be scaled based on the scale unit specified in this or the Set-AzExpressRouteGateway cmdlet. + +A connection is set up from a on-premise ExpressRoute circuit to the scalable gateway. + +The ExpressRouteGateway will be in the same location as the referenced VirtualHub. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testergw" -VirtualHubId $virtualHub.Id -MinScaleUnits 2 +``` + +```output +ResourceGroupName : testRG +Name : testergw +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/expressRouteGateways/testergw +Location : West US +MinScaleUnits : 2 +VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub +BgpSettings : {} +Type : Microsoft.Network/expressRouteGateways +ProvisioningState : Succeeded +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in West US in "testRG" resource group in Azure. +An ExpressRoute gateway will be created thereafter in the Virtual Hub with 2 scale units. + +### Example 2 + +Creates a Scalable ExpressRoute Gateway. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzExpressRouteGateway -MaxScaleUnits <UInt32> -MinScaleUnits 2 -Name 'testExpressRoutegw' -ResourceGroupName 'testRG' -Tag @{"tag1"="value1"; "tag2"="value2"} -VirtualHubName <String> +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxScaleUnits +The maximum number of scale units for this ExpressRouteGateway. Valid range > 2 + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinScaleUnits +The minimum number of scale units for this ExpressRouteGateway. Valid range > 2 + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, ExpressRouteGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The VirtualHub this VpnGateway needs to be associated with. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubId +The Id of the VirtualHub this VpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualHubName +The Id of the VirtualHub this VpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzExpressRoutePort.md b/azps-10.1.0/Az.Network/New-AzExpressRoutePort.md new file mode 100644 index 0000000000..265b350618 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzExpressRoutePort.md @@ -0,0 +1,331 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azexpressrouteport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRoutePort.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRoutePort.md +--- + +# New-AzExpressRoutePort + +## SYNOPSIS +Creates an Azure ExpressRoutePort. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +New-AzExpressRoutePort -ResourceGroupName <String> -Name <String> -PeeringLocation <String> + -BandwidthInGbps <Int32> -Encapsulation <String> -Location <String> [-Tag <Hashtable>] + [-Link <PSExpressRouteLink[]>] [-Force] [-AsJob] [-Identity <PSManagedServiceIdentity>] + [-BillingType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +New-AzExpressRoutePort -ResourceId <String> -PeeringLocation <String> -BandwidthInGbps <Int32> + -Encapsulation <String> -Location <String> [-Tag <Hashtable>] [-Link <PSExpressRouteLink[]>] [-Force] [-AsJob] + [-Identity <PSManagedServiceIdentity>] [-BillingType <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzExpressRoutePort** cmdlet creates an Azure ExpressRoutePort + +## EXAMPLES + +### Example 1 +```powershell +$parameters = @{ + Name='ExpressRoutePort' + ResourceGroupName='ExpressRouteResourceGroup' + Location='West US' + PeeringLocation='Silicon Valley' + BandwidthInGbps=100 + Encapsulation='QinQ' +} +New-AzExpressRoutePort @parameters +``` + +### Example 2 +```powershell +$parameters = @{ + ResourceId='/subscriptions/<SubId>/resourceGroups/<ResourceGroupName>/providers/Microsoft.Network/expressRoutePorts/<PortName>' + Location='West US' + PeeringLocation='Silicon Valley' + BandwidthInGbps=100 + Encapsulation='QinQ' +} +New-AzExpressRoutePort @parameters +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BandwidthInGbps +Bandwidth of procured ports in Gbps + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BillingType +Billing type of the port + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: MeteredData +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Encapsulation +Encapsulation method on physical ports. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +User Assigned Identity for reading MacSec configuration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Link +The set of physical links of the ExpressRoutePort resource + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteLink[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +The location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the ExpressRoutePort. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeeringLocation +The name of the peering location that the ExpressRoutePort is mapped to physically. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the ExpressRoutePort. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the express route port. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteLink[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRoutePort](./Get-AzExpressRoutePort.md) + +[Remove-AzExpressRoutePort](./Remove-AzExpressRoutePort.md) + +[Set-AzExpressRoutePort](./Set-AzExpressRoutePort.md) diff --git a/azps-10.1.0/Az.Network/New-AzExpressRoutePortIdentity.md b/azps-10.1.0/Az.Network/New-AzExpressRoutePortIdentity.md new file mode 100644 index 0000000000..b222740bb8 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzExpressRoutePortIdentity.md @@ -0,0 +1,86 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azexpressrouteportidentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRoutePortIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRoutePortIdentity.md +--- + +# New-AzExpressRoutePortIdentity + +## SYNOPSIS +Creates an Azure ExpressRoutePortIdentity. + +## SYNTAX + +``` +New-AzExpressRoutePortIdentity -UserAssignedIdentityId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzExpressRoutePortIdentity** cmdlet creates a local Azure ExpressRoutePort Identity object. Use **New-AzExpressRoutePort** or **Set-AzExpressRoutePort** to assign it to Azure ExpressRoutePort. + +## EXAMPLES + +### Example 1 +```powershell +$parameters = @{ + UserAssignedIdentityId='/subscriptions/<SubId>/resourceGroups/<ResourceGroupName>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<IdentityName>' + } +New-AzExpressRoutePortIdentity @parameters +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +ResourceId of the user assigned identity to be assigned to ExpressRoutePort. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: UserAssignedIdentity + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRoutePortIdentity](./Get-AzExpressRoutePortIdentity.md) + +[Remove-AzExpressRoutePortIdentity](./Remove-AzExpressRoutePortIdentity.md) + +[Set-AzExpressRoutePortIdentity](./Set-AzExpressRoutePortIdentity.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzExpressRoutePortLOA.md b/azps-10.1.0/Az.Network/New-AzExpressRoutePortLOA.md new file mode 100644 index 0000000000..a289655785 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzExpressRoutePortLOA.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azexpressrouteportloa +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRoutePortLOA.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzExpressRoutePortLOA.md +--- + +# New-AzExpressRoutePortLOA + +## SYNOPSIS +Download letter of authorization document for an express route port. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +New-AzExpressRoutePortLOA -PortName <String> -ResourceGroupName <String> -CustomerName <String> + [-Destination <String>] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceObjectParameterSet +``` +New-AzExpressRoutePortLOA -ExpressRoutePort <PSExpressRoutePort> -CustomerName <String> [-Destination <String>] + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +New-AzExpressRoutePortLOA -Id <String> -CustomerName <String> [-Destination <String>] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +New-AzExpressRoutePortLOA cmdlet downloads a letter of authorization document in PDF format for an express route port. + +## EXAMPLES + +### Example 1 +```powershell +New-AzExpressRoutePortLOA -ResourceGroupName myRg -PortName myPort -CustomerName Contoso -Destination loa.pdf +``` + +Download the letter of authorization document for express route port 'myPort' and store it in file 'loa.pdf'. + +### Example 2 + +Download letter of authorization document for an express route port. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzExpressRoutePortLOA -CustomerName Contoso -Destination loa.pdf -ExpressRoutePort <PSExpressRoutePort> +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerName +The customer name to whom this Express Route Port is assigned to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +The output filepath to store the Letter of Authorization to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRoutePort +The express route port resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort +Parameter Sets: ResourceObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ResourceId of the express route port. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PortName +The express route port name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the express route port. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewall.md b/azps-10.1.0/Az.Network/New-AzFirewall.md new file mode 100644 index 0000000000..f77b5e1d2f --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewall.md @@ -0,0 +1,798 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: A3D60CF1-2E66-4EE5-9C68-932DD8DF80BD +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewall +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewall.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewall.md +--- + +# New-AzFirewall + +## SYNOPSIS +Creates a new Firewall in a resource group. + +## SYNTAX + +### Default (Default) +``` +New-AzFirewall -Name <String> -ResourceGroupName <String> -Location <String> + [-ApplicationRuleCollection <PSAzureFirewallApplicationRuleCollection[]>] + [-NatRuleCollection <PSAzureFirewallNatRuleCollection[]>] + [-NetworkRuleCollection <PSAzureFirewallNetworkRuleCollection[]>] [-ThreatIntelMode <String>] + [-ThreatIntelWhitelist <PSAzureFirewallThreatIntelWhitelist>] [-PrivateRange <String[]>] [-EnableDnsProxy] + [-DnsServer <String[]>] [-Tag <Hashtable>] [-Force] [-AsJob] [-Zone <String[]>] [-SkuName <String>] + [-SkuTier <String>] [-VirtualHubId <String>] [-HubIPAddress <PSAzureFirewallHubIpAddresses>] + [-FirewallPolicyId <String>] [-AllowActiveFTP] [-EnableFatFlowLogging] [-EnableUDPLogOptimization] + [-RouteServerId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### OldIpConfigurationParameterValues +``` +New-AzFirewall -Name <String> -ResourceGroupName <String> -Location <String> -VirtualNetworkName <String> + [-PublicIpName <String>] [-ApplicationRuleCollection <PSAzureFirewallApplicationRuleCollection[]>] + [-NatRuleCollection <PSAzureFirewallNatRuleCollection[]>] + [-NetworkRuleCollection <PSAzureFirewallNetworkRuleCollection[]>] [-ThreatIntelMode <String>] + [-ThreatIntelWhitelist <PSAzureFirewallThreatIntelWhitelist>] [-PrivateRange <String[]>] [-EnableDnsProxy] + [-DnsServer <String[]>] [-Tag <Hashtable>] [-Force] [-AsJob] [-Zone <String[]>] [-SkuName <String>] + [-SkuTier <String>] [-VirtualHubId <String>] [-HubIPAddress <PSAzureFirewallHubIpAddresses>] + [-FirewallPolicyId <String>] [-AllowActiveFTP] [-EnableFatFlowLogging] [-EnableUDPLogOptimization] + [-RouteServerId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IpConfigurationParameterValues +``` +New-AzFirewall -Name <String> -ResourceGroupName <String> -Location <String> -VirtualNetwork <PSVirtualNetwork> + [-PublicIpAddress <PSPublicIpAddress[]>] [-ManagementPublicIpAddress <PSPublicIpAddress>] + [-ApplicationRuleCollection <PSAzureFirewallApplicationRuleCollection[]>] + [-NatRuleCollection <PSAzureFirewallNatRuleCollection[]>] + [-NetworkRuleCollection <PSAzureFirewallNetworkRuleCollection[]>] [-ThreatIntelMode <String>] + [-ThreatIntelWhitelist <PSAzureFirewallThreatIntelWhitelist>] [-PrivateRange <String[]>] [-EnableDnsProxy] + [-DnsServer <String[]>] [-Tag <Hashtable>] [-Force] [-AsJob] [-Zone <String[]>] [-SkuName <String>] + [-SkuTier <String>] [-VirtualHubId <String>] [-HubIPAddress <PSAzureFirewallHubIpAddresses>] + [-FirewallPolicyId <String>] [-AllowActiveFTP] [-EnableFatFlowLogging] [-EnableUDPLogOptimization] + [-RouteServerId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewall** cmdlet creates an Azure Firewall. + +## EXAMPLES + +### Example 1: Create a Firewall attached to a virtual network +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -ResourceGroupName $rgName -Name "vnet" +$pip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "publicIpName" +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetwork $vnet -PublicIpAddress $pip +``` + +This example creates a Firewall attached to virtual network "vnet" in the same resource group as the firewall. +Since no rules were specified, the firewall will block all traffic (default behavior). +Threat Intel will also run in default mode - Alert - which means malicious traffic will be logged, but not denied. + +### Example 2: Create a Firewall which allows all HTTPS traffic +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -ResourceGroupName $rgName -Name "vnet" +$pip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "publicIpName" + +$rule = New-AzFirewallApplicationRule -Name R1 -Protocol "https:443" -TargetFqdn "*" +$ruleCollection = New-AzFirewallApplicationRuleCollection -Name RC1 -Priority 100 -Rule $rule -ActionType "Allow" +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetwork $vnet -PublicIpAddress $pip -ApplicationRuleCollection $ruleCollection +``` + +This example creates a Firewall which allows all HTTPS traffic on port 443. +Threat Intel will run in default mode - Alert - which means malicious traffic will be logged, but not denied. + +### Example 3: DNAT - redirect traffic destined to 10.1.2.3:80 to 10.2.3.4:8080 +```powershell +$rule = New-AzFirewallNatRule -Name "natRule" -Protocol "TCP" -SourceAddress "*" -DestinationAddress "10.1.2.3" -DestinationPort "80" -TranslatedAddress "10.2.3.4" -TranslatedPort "8080" +$ruleCollection = New-AzFirewallNatRuleCollection -Name "NatRuleCollection" -Priority 1000 -Rule $rule +New-AzFirewall -Name "azFw" -ResourceGroupName "rg" -Location centralus -NatRuleCollection $ruleCollection -ThreatIntelMode Off +``` + +This example created a Firewall which translated the destination IP and port of all packets destined to 10.1.2.3:80 to 10.2.3.4:8080 +Threat Intel is turned off in this example. + +### Example 4: Create a Firewall with no rules and with Threat Intel in Alert mode +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -ResourceGroupName $rgName -Name "vnet" +$pip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "publicIpName" +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetwork $vnet -PublicIpAddress $pip -ThreatIntelMode Alert +``` + +This example creates a Firewall which blocks all traffic (default behavior) and has Threat Intel running in Alert mode. +This means alerting logs are emitted for malicious traffic before applying the other rules (in this case just the default rule - Deny All) + +### Example 5: Create a Firewall which allows all HTTP traffic on port 8080, but blocks malicious domains identified by Threat Intel +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -ResourceGroupName $rgName -Name "vnet" +$pip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "publicIpName" + +$rule = New-AzFirewallApplicationRule -Name R1 -Protocol "http:8080" -TargetFqdn "*" +$ruleCollection = New-AzFirewallApplicationRuleCollection -Name RC1 -Priority 100 -Rule $rule -ActionType "Allow" +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetwork $vnet -PublicIpAddress $pip -ApplicationRuleCollection $ruleCollection -ThreatIntelMode Deny +``` + +This example creates a Firewall which allows all HTTP traffic on port 8080 unless it is considered malicious by Threat Intel. +When running in Deny mode, unlike Alert, traffic considered malicious by Threat Intel is not just logged, but also blocked. + +### Example 6: Create a Firewall with no rules and with availability zones +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -ResourceGroupName $rgName -Name "vnet" +$pip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "publicIpName" +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetworkName $vnet.Name -PublicIpName $pip.Name -Zone 1,2,3 +``` + +This example creates a Firewall with all available availability zones. + +### Example 7: Create a Firewall with two or more Public IP Addresses +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -Name "vnet" -ResourceGroupName $rgName +$pip1 = New-AzPublicIpAddress -Name "AzFwPublicIp1" -ResourceGroupName "rg" -Sku "Basic" -Tier "Regional" -Location "centralus" -AllocationMethod Static +$pip2 = New-AzPublicIpAddress -Name "AzFwPublicIp2" -ResourceGroupName "rg" -Sku "Basic" -Tier "Regional" -Location "centralus" -AllocationMethod Static +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetwork $vnet -PublicIpAddress @($pip1, $pip2) +``` + +This example creates a Firewall attached to virtual network "vnet" with two public IP addresses. + +### Example 8: Create a Firewall which allows MSSQL traffic to specific SQL database +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -ResourceGroupName $rgName -Name "vnet" +$pip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "publicIpName" + +$rule = New-AzFirewallApplicationRule -Name R1 -Protocol "mssql:1433" -TargetFqdn "sql1.database.windows.net" +$ruleCollection = New-AzFirewallApplicationRuleCollection -Name RC1 -Priority 100 -Rule $rule -ActionType "Allow" +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetwork $vnet -PublicIpAddress $pip -ApplicationRuleCollection $ruleCollection -ThreatIntelMode Deny +``` + +This example creates a Firewall which allows MSSQL traffic on standard port 1433 to SQL database sql1.database.windows.net. + +### Example 9: Create a Firewall attached to a virtual hub +```powershell +$rgName = "resourceGroupName" +$fp = Get-AzFirewallPolicy -ResourceGroupName $rgName -Name "fp" +$fpId = $fp.Id +$vHub = Get-AzVirtualHub -Name "hub" +$vHubId = $vHub.Id + +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -SkuName AZFW_Hub -VirtualHubId $vHubId -FirewallPolicyId -$fpId +``` + +This example creates a Firewall attached to virtual hub "vHub". A firewall policy $fp will be attached to the firewall. This firewall allows/denies the traffic based on the rules mentioned in the firewall policy $fp. The virtual hub and the firewall should be in the same regions. + +### Example 10: Create a Firewall with threat intelligence whitelist setup +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -ResourceGroupName $rgName -Name "vnet" +$pip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "publicIpName" + +$tiWhitelist = New-AzFirewallThreatIntelWhitelist -FQDN @("www.microsoft.com") -IpAddress @("8.8.8.8") +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetwork $vnet -PublicIpAddress $pip -ThreatIntelWhitelist $tiWhitelist +``` + +This example creates a Firewall that whitelist "www.microsoft.com" and "8.8.8.8" from threat intelligence + +### Example 11: Create a Firewall with customized private range setup +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -ResourceGroupName $rgName -Name "vnet" +$pip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "publicIpName" + +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetwork $vnet -PublicIpAddress $pip -PrivateRange @("99.99.99.0/24", "66.66.0.0/16") +``` + +This example creates a Firewall that treats "99.99.99.0/24" and "66.66.0.0/16" as private ip ranges and won't snat traffic to those addresses + +### Example 12: Create a Firewall with a management subnet and Public IP address +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -ResourceGroupName $rgName -Name "vnet" +$pip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "publicIpName" +$mgmtPip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "managementPublicIpName" + +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetwork $vnet -PublicIpAddress $pip -ManagementPublicIpAddress $mgmtPip +``` + +This example creates a Firewall attached to virtual network "vnet" in the same resource group as the firewall. +Since no rules were specified, the firewall will block all traffic (default behavior). +Threat Intel will also run in default mode - Alert - which means malicious traffic will be logged, but not denied. + +To support "forced tunneling" scenarios, this firewall will use the subnet "AzureFirewallManagementSubnet" and the management public IP address for its management traffic + +### Example 13: Create a Firewall with Firewall Policy attached to a virtual network +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -ResourceGroupName $rgName -Name "vnet" +$pip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "publicIpName" +$fp = Get-AzFirewallPolicy -ResourceGroupName $rgName -Name "fp" +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetwork $vnet -PublicIpAddress $pip -FirewallPolicyId $fp +``` + +This example creates a Firewall attached to virtual network "vnet" in the same resource group as the firewall. +The rules and threat intelligence that will be applied to the firewall will be taken from the firewall policy + +### Example 14: Create a Firewall with DNS Proxy and DNS Servers +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -ResourceGroupName $rgName -Name "vnet" +$pip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "publicIpName" +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetwork $vnet -PublicIpAddress $pip -DnsServer @("10.10.10.1", "20.20.20.2") +``` + +This example creates a Firewall attached to virtual network "vnet" in the same resource group as the firewall. +DNS Proxy is enabled for this firewall and 2 DNS Servers are provided. Also Require DNS Proxy for Network rules is set +so if there are any Network rules with FQDNs then DNS proxy will be used for them too. + +### Example 15: Create a Firewall with multiple IPs. The Firewall can be associated with the Virtual Hub +```powershell +$rgName = "resourceGroupName" +$vHub = Get-AzVirtualHub -Name "hub" +$vHubId = $vHub.Id +$fwpips = New-AzFirewallHubPublicIpAddress -Count 2 +$hubIpAddresses = New-AzFirewallHubIpAddress -PublicIP $fwpips +$fw=New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location westus -SkuName AZFW_Hub -HubIPAddress $hubIpAddresses -VirtualHubId $vHubId +``` + +This example creates a Firewall attached to virtual hub "hub" in the same resource group as the firewall. +The Firewall will be assigned 2 public IPs that are created implicitly. + +### Example 16: Create a Firewall with Allow Active FTP. +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -ResourceGroupName $rgName -Name "vnet" +$pip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "publicIpName" +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetwork $vnet -PublicIpAddress $pip -AllowActiveFTP +``` + +This example creates a Firewall with allow active FTP flag. + +### Example 17: Create a Firewall with a management subnet and no data Public IP address +```powershell +$rgName = "resourceGroupName" +$vnet = Get-AzVirtualNetwork -ResourceGroupName $rgName -Name "vnet" +$mgmtPip = Get-AzPublicIpAddress -ResourceGroupName $rgName -Name "managementPublicIpName" + +New-AzFirewall -Name "azFw" -ResourceGroupName $rgName -Location centralus -VirtualNetwork $vnet -ManagementPublicIpAddress $mgmtPip +``` + +This example creates a "forced tunneling" Firewall that uses the subnet "AzureFirewallManagementSubnet" and the management public IP address for its management traffic. +In this scenario, users do not have to specify a data Public IP if they are only using firewall for private traffic only. + +## PARAMETERS + +### -AllowActiveFTP +Allows Active FTP on the Firewall. By default it is disabled. + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationRuleCollection +Specifies the collections of application rules for the new Firewall. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallApplicationRuleCollection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsServer +The list of DNS Servers to be used for DNS resolution, + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDnsProxy +Enable DNS Proxy. By default it is disabled. + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFatFlowLogging +Enable Fat Flow Logging. By default it is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUDPLogOptimization +Enable UDP Log Optimization. By default it is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicyId +The firewall policy attached to the firewall + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubIPAddress +The ip addresses for the firewall attached to a virtual hub + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallHubIpAddresses +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the region for the Firewall. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagementPublicIpAddress +One or more Public IP Addresses to use for management traffic. The Public IP addresses must use Standard SKU and must belong to the same resource group as the Firewall. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: IpConfigurationParameterValues +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Azure Firewall that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NatRuleCollection +The list of AzureFirewallNatRuleCollections + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNatRuleCollection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkRuleCollection +The list of AzureFirewallNetworkRuleCollections + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNetworkRuleCollection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateRange +The private IP ranges to which traffic won't be SNAT'ed + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddress +One or more Public IP Addresses. The Public IP addresses must use Standard SKU and must belong to the same resource group as the Firewall. No input needed for Forced Tunneling Firewalls. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress[] +Parameter Sets: IpConfigurationParameterValues +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpName +Public Ip Name. The Public IP must use Standard SKU and must belong to the same resource group as the Firewall. + +```yaml +Type: System.String +Parameter Sets: OldIpConfigurationParameterValues +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group to contain the Firewall. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteServerId +The Route Server Id for the firewall + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The sku name for firewall + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Sku +Accepted values: AZFW_Hub, AZFW_VNet + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuTier +The sku tier for firewall + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Standard, Premium, Basic + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: + +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ThreatIntelMode +Specifies the operation mode for Threat Intelligence. Default mode is Alert, not Off. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Alert, Deny, Off + +Required: False +Position: Named +Default value: Alert +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ThreatIntelWhitelist +The whitelist for Threat Intelligence + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallThreatIntelWhitelist +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubId +The virtual hub that a firewall is attached to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetwork +Virtual Network + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork +Parameter Sets: IpConfigurationParameterValues +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualNetworkName +Specifies the name of the virtual network for which the Firewall will be deployed. Virtual network and Firewall must belong to the same resource group. + +```yaml +Type: System.String +Parameter Sets: OldIpConfigurationParameterValues +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +A list of availability zones denoting where the firewall needs to come from. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress[] + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallApplicationRuleCollection[] + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNatRuleCollection[] + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNetworkRuleCollection[] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewall + +## NOTES + +## RELATED LINKS + +[Get-AzFirewall](./Get-AzFirewall.md) + +[Remove-AzFirewall](./Remove-AzFirewall.md) + +[Set-AzFirewall](./Set-AzFirewall.md) + +[New-AzFirewallApplicationRuleCollection](./New-AzFirewallApplicationRuleCollection.md) + +[New-AzFirewallNatRuleCollection](./New-AzFirewallNatRuleCollection.md) + +[New-AzFirewallNetworkRuleCollection](./New-AzFirewallNetworkRuleCollection.md) diff --git a/azps-10.1.0/Az.Network/New-AzFirewallApplicationRule.md b/azps-10.1.0/Az.Network/New-AzFirewallApplicationRule.md new file mode 100644 index 0000000000..b0f834aa21 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallApplicationRule.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C0E1D4DF-232F-49C6-BE4C-05C8E8038329 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallapplicationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallApplicationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallApplicationRule.md +--- + +# New-AzFirewallApplicationRule + +## SYNOPSIS +Creates a Firewall Application Rule. + +## SYNTAX + +### TargetFqdn (Default) +``` +New-AzFirewallApplicationRule -Name <String> [-Description <String>] [-SourceAddress <String[]>] + [-SourceIpGroup <String[]>] -TargetFqdn <String[]> -Protocol <String[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FqdnTag +``` +New-AzFirewallApplicationRule -Name <String> [-Description <String>] [-SourceAddress <String[]>] + [-SourceIpGroup <String[]>] -FqdnTag <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallApplicationRule** cmdlet creates an application rule for Azure Firewall. + +## EXAMPLES + +### Example 1: Create a rule to allow all HTTPS traffic from 10.0.0.0 +```powershell +New-AzFirewallApplicationRule -Name "https-rule" -Protocol "https:443" -TargetFqdn "*" -SourceAddress "10.0.0.0" +``` + +This example creates a rule which will allow all HTTPS traffic on port 443 from 10.0.0.0. + +### Example 2: Create a rule to allow WindowsUpdate for 10.0.0.0/24 subnet +```powershell +New-AzFirewallApplicationRule -Name "windows-update-rule" -FqdnTag WindowsUpdate -SourceAddress "10.0.0.0/24" +``` + +This example creates a rule which will allow traffic for Windows Updates for 10.0.0.0/24 domain. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies an optional description of this rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FqdnTag +Specifies a list of FQDN Tags for this rule. The available tags can be retrieved using [Get-AzFirewallFqdnTag](./Get-AzFirewallFqdnTag.md) cmdlet. + +```yaml +Type: System.String[] +Parameter Sets: FqdnTag +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of this application rule. The name must be unique inside a rule collection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the type of traffic to be filtered by this rule. The format is <protocol `type>:<port>`. +For example, "http:80" or "https:443". +Protocol is mandatory when TargetFqdn is used, but it cannot be used with FqdnTag. The supported protocols are HTTP and HTTPS. + +```yaml +Type: System.String[] +Parameter Sets: TargetFqdn +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceAddress +The source addresses of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceIpGroup +The source ipgroup of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetFqdn +Specifies a list of domain names filtered by this rule. +The asterisk character, '*', is accepted only as the first character of an FQDN in the list. When used, the asterisk matches any number of characters. (e.g. '*msn.com' will match msn.com and all its subdomains) + +```yaml +Type: System.String[] +Parameter Sets: TargetFqdn +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallApplicationRule + +## NOTES + +## RELATED LINKS + +[New-AzFirewallApplicationRuleCollection](./New-AzFirewallApplicationRuleCollection.md) + +[New-AzFirewall](./New-AzFirewall.md) + +[Get-AzFirewall](./Get-AzFirewall.md) + +[Get-AzFirewallFqdnTag](./Get-AzFirewallFqdnTag.md) diff --git a/azps-10.1.0/Az.Network/New-AzFirewallApplicationRuleCollection.md b/azps-10.1.0/Az.Network/New-AzFirewallApplicationRuleCollection.md new file mode 100644 index 0000000000..3dc0ccd77e --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallApplicationRuleCollection.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: A29E9921-C1B9-42C2-B816-5D4873AC6688 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallapplicationrulecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallApplicationRuleCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallApplicationRuleCollection.md +--- + +# New-AzFirewallApplicationRuleCollection + +## SYNOPSIS +Creates a collection of Firewall application rules. + +## SYNTAX + +``` +New-AzFirewallApplicationRuleCollection -Name <String> -Priority <UInt32> + -Rule <PSAzureFirewallApplicationRule[]> -ActionType <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallApplicationRuleCollection** cmdlet creates a collection of Firewall Application Rules. + +## EXAMPLES + +### Example 1: Create a collection with one rule +```powershell +$rule1 = New-AzFirewallApplicationRule -Name "httpsRule" -Protocol "https:443" -TargetFqdn "*" -SourceAddress "10.0.0.0" +New-AzFirewallApplicationRuleCollection -Name "MyAppRuleCollection" -Priority 1000 -Rule $rule1 -ActionType "Allow" +``` + +This example creates a collection with one rule. All traffic that matches the conditions identified in $rule1 will be allowed. +The first rule is for all HTTPS traffic on port 443 from 10.0.0.0. +If there is another application rule collection with higher priority (smaller number) which also matches traffic identified in $rule1, +the action of the rule collection with higher priority will take in effect instead. + +### Example 2: Add a rule to a rule collection +```powershell +$rule1 = New-AzFirewallApplicationRule -Name R1 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" -SourceAddress "10.0.0.0" +$ruleCollection = New-AzFirewallApplicationRuleCollection -Name "MyAppRuleCollection" -Priority 100 -Rule $rule1 -ActionType "Allow" + +$rule2 = New-AzFirewallApplicationRule -Name R2 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" +$ruleCollection.AddRule($rule2) +``` + +This example creates a new application rule collection with one rule and then adds a second rule to the rule collection using method +AddRule on the rule collection object. Each rule name in a given rule collection must have a unique name and is case insensitive. + +### Example 3: Get a rule from a rule collection +```powershell +$rule1 = New-AzFirewallApplicationRule -Name R1 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" -SourceAddress "10.0.0.0" +$ruleCollection = New-AzFirewallApplicationRuleCollection -Name "MyAppRuleCollection" -Priority 100 -Rule $rule1 -ActionType "Allow" +$getRule=$ruleCollection.GetRuleByName("r1") +``` + +This example creates a new application rule collection with one rule and then gets the rule by name, calling method GetRuleByName on the +rule collection object. The rule name for method GetRuleByName is case-insensitive. + +### Example 4: Remove a rule from a rule collection +```powershell +$rule1 = New-AzFirewallApplicationRule -Name R1 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" -SourceAddress "10.0.0.0" +$rule2 = New-AzFirewallApplicationRule -Name R2 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" +$ruleCollection = New-AzFirewallApplicationRuleCollection -Name "MyAppRuleCollection" -Priority 100 -Rule $rule1, $rule1 -ActionType "Allow" +$ruleCollection.RemoveRuleByName("r1") +``` + +This example creates a new application rule collection with two rules and then removes the first rule from the rule collection by calling method +RemoveRuleByName on the rule collection object. The rule name for method RemoveRuleByName is case-insensitive. + +## PARAMETERS + +### -ActionType +The action of the rule collection + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of this application rule. The name must be unique inside a rule collection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Specifies the priority of this rule. Priority is a number between 100 and 65000. The smaller the number, the bigger the priority. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +Specifies the list of rules to be grouped under this collection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallApplicationRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallApplicationRuleCollection + +## NOTES + +## RELATED LINKS + +[New-AzFirewallApplicationRule](./New-AzFirewallApplicationRule.md) + +[New-AzFirewall](./New-AzFirewall.md) + +[Get-AzFirewall](./Get-AzFirewall.md) diff --git a/azps-10.1.0/Az.Network/New-AzFirewallHubIpAddress.md b/azps-10.1.0/Az.Network/New-AzFirewallHubIpAddress.md new file mode 100644 index 0000000000..6ab4c42177 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallHubIpAddress.md @@ -0,0 +1,95 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallhubipaddress +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallHubIpAddress.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallHubIpAddress.md +--- + +# New-AzFirewallHubIpAddress + +## SYNOPSIS +Ip addresses assoicated to the firewall on virtual hub + +## SYNTAX + +``` +New-AzFirewallHubIpAddress [-PrivateIPAddress <String>] [-PublicIP <PSAzureFirewallHubPublicIpAddresses>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Ip addresses assoicated to the firewall on virtual hub. These can be public and private addresses + +## EXAMPLES + +### Example 1 +```powershell +$fwpips = New-AzFirewallHubPublicIpAddress -Count 2 +New-AzFirewallHubIpAddress -PublicIP $fwpips +``` + +This example creates a Hub Ip address object with a count of 2 public IPs. The HubIPAddress object is associated to the firewall on the virtual hub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIPAddress +The private Ip Address of the Firewall attached to a Hub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIP +The IP Addresses of the Firewall attached to a hub + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallHubPublicIpAddresses +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallHubIpAddresses + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallHubPublicIpAddress.md b/azps-10.1.0/Az.Network/New-AzFirewallHubPublicIpAddress.md new file mode 100644 index 0000000000..dfce1b4bc3 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallHubPublicIpAddress.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallhubpublicipaddress +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallHubPublicIpAddress.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallHubPublicIpAddress.md +--- + +# New-AzFirewallHubPublicIpAddress + +## SYNOPSIS +Public Ip assoicated to the firewall on virtual hub + +## SYNTAX + +``` +New-AzFirewallHubPublicIpAddress [-Count <Int32>] [-Address <PSAzureFirewallPublicIpAddress[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Public Ip assoicated to the firewall on virtual hub + +## EXAMPLES + +### Example 1 +```powershell +New-AzFirewallHubPublicIpAddress -Count 2 +``` + +This will create 2 public ips on the firewall attached to the virtual hub. This will create the ip address in the backend.We cannot provide the ipaddresses explicitly for a new firewall. + +### Example 2 +```powershell +$publicIp1 = New-AzFirewallPublicIpAddress -Address 10.2.3.4 +$publicIp2 = New-AzFirewallPublicIpAddress -Address 20.56.37.46 +New-AzFirewallHubPublicIpAddress -Count 3 -Address $publicIp1, $publicIp2 +``` + +This will create 1 new public ip on the firewall by retain $publicIp1, $publicIp2 which are already exist on the firewall. + +## PARAMETERS + +### -Address +The Public IP Addresses of the Firewall attached to a hub + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPublicIpAddress[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +The count of public Ip addresses + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallHubPublicIpAddresses + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallNatRule.md b/azps-10.1.0/Az.Network/New-AzFirewallNatRule.md new file mode 100644 index 0000000000..117aadd531 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallNatRule.md @@ -0,0 +1,268 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C0E1D4DF-232F-49C6-BE4C-05C8E8038329 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallnatrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallNatRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallNatRule.md +--- + +# New-AzFirewallNatRule + +## SYNOPSIS +Creates a Firewall NAT Rule. + +## SYNTAX + +``` +New-AzFirewallNatRule -Name <String> [-Description <String>] [-SourceAddress <String[]>] + [-SourceIpGroup <String[]>] -DestinationAddress <String[]> -DestinationPort <String[]> -Protocol <String[]> + [-TranslatedAddress <String>] [-TranslatedFqdn <String>] -TranslatedPort <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallNatRule** cmdlet creates a NAT rule for Azure Firewall. + +## EXAMPLES + +### Example 1: Create a rule to DNAT all TCP traffic from 10.0.0.0/24 with destination 10.1.2.3:80 to destination 10.4.5.6:8080 +```powershell +New-AzFirewallNatRule -Name "dnat-rule" -Protocol "TCP" -SourceAddress "10.0.0.0/24" -DestinationAddress "10.1.2.3" -DestinationPort "80" -TranslatedAddress "10.4.5.6" -TranslatedPort "8080" +``` + +This example creates a rule which will DNAT all traffic originating in 10.0.0.0/24 with destination 10.1.2.3:80 to 10.4.5.6:8080 + +### Example 2 + +Creates a Firewall NAT Rule. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzFirewallNatRule -DestinationAddress '10.0.0.1' -DestinationPort '443' -Name 'dnat-rule' -Protocol Any -SourceIpGroup <String[]> -TranslatedAddress '10.0.0.2' -TranslatedPort '8080' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies an optional description of this rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationAddress +The destination addresses of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPort +The destination ports of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of this NAT rule. The name must be unique inside a rule collection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the type of traffic to be filtered by this rule. +The supported protocols are TCP and UDP. +A special value "Any" is allowed, meaning it will match both TCP and UDP, but no other protocols. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: Any, TCP, UDP + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceAddress +The source addresses of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceIpGroup +The source ipgroup of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranslatedAddress +Specifies the desired result of the address translation + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranslatedFqdn +The translated FQDN for this NAT rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranslatedPort +Specifies the desired result of the port translation + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNatRule + +## NOTES + +## RELATED LINKS + +[New-AzFirewallNatRuleCollection](./New-AzFirewallNatRuleCollection.md) + +[New-AzFirewall](./New-AzFirewall.md) + +[Get-AzFirewall](./Get-AzFirewall.md) diff --git a/azps-10.1.0/Az.Network/New-AzFirewallNatRuleCollection.md b/azps-10.1.0/Az.Network/New-AzFirewallNatRuleCollection.md new file mode 100644 index 0000000000..08542d12c1 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallNatRuleCollection.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: A29E9921-C1B9-42C2-B816-5D4873AC6688 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallnatrulecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallNatRuleCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallNatRuleCollection.md +--- + +# New-AzFirewallNatRuleCollection + +## SYNOPSIS +Creates a collection of Firewall NAT rules. + +## SYNTAX + +``` +New-AzFirewallNatRuleCollection -Name <String> -Priority <UInt32> -Rule <PSAzureFirewallNatRule[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallNatRuleCollection** cmdlet creates a collection of Firewall NAT Rules. + +## EXAMPLES + +### Example 1: Create a collection with one rule +```powershell +$rule1 = New-AzFirewallNatRule -Name "natRule" -Protocol "TCP" -SourceAddress "*" -DestinationAddress "10.0.0.1" -DestinationPort "80" -TranslatedAddress "10.0.0.2" -TranslatedPort "8080" +New-AzFirewallNatRuleCollection -Name "MyNatRuleCollection" -Priority 1000 -Rule $rule1 +``` + +This example creates a collection with one rule. All traffic that matches the conditions identified in $rule1 will be DNAT'ed to translated address and port. + +### Example 2: Add a rule to a rule collection +```powershell +$rule1 = New-AzFirewallNatRule -Name R1 -Protocol "UDP","TCP" -SourceAddress "*" -DestinationAddress "10.0.0.1" -DestinationPort "80" -TranslatedAddress "10.0.0.2" -TranslatedPort "8080" +$ruleCollection = New-AzFirewallNatRuleCollection -Name "MyNatRuleCollection" -Priority 100 -Rule $rule1 + +$rule2 = New-AzFirewallNatRule -Name R2 -Protocol "TCP" -SourceAddress "*" -DestinationAddress "10.0.0.1" -DestinationPort "443" -TranslatedAddress "10.0.0.2" -TranslatedPort "8443" +$ruleCollection.AddRule($rule2) +``` + +This example creates a new NAT rule collection with one rule and then adds a second rule to the rule collection using method +AddRule on the rule collection object. Each rule name in a given rule collection must have an unique name and is case insensitive. + +### Example 3: Get a rule from a rule collection +```powershell +$rule1 = New-AzFirewallNatRule -Name R1 -Protocol "TCP" -SourceAddress "10.0.0.0/24" -DestinationAddress "10.0.1.0/24" -DestinationPort "443" -TranslatedAddress "10.0.0.2" -TranslatedPort "8443" +$ruleCollection = New-AzFirewallNatRuleCollection -Name "MyNatRuleCollection" -Priority 100 -Rule $rule1 + +$rule=$ruleCollection.GetRuleByName("r1") +``` + +This example creates a new NAT rule collection with one rule and then gets the rule by name, calling method GetRuleByName on the +rule collection object. The rule name for method GetRuleByName is case-insensitive. + +### Example 4: Remove a rule from a rule collection +```powershell +$rule1 = New-AzFirewallNatRule -Name R1 -Protocol "UDP","TCP" -SourceAddress "*" -DestinationAddress "10.0.0.1" -DestinationPort "80" -TranslatedAddress "10.0.0.2" -TranslatedPort "8080" +$rule2 = New-AzFirewallNatRule -Name R2 -Protocol "TCP" -SourceAddress "*" -DestinationAddress "10.0.0.1" -DestinationPort "443" -TranslatedAddress "10.0.0.2" -TranslatedPort "8443" +$ruleCollection = New-AzFirewallNatRuleCollection -Name "MyNatRuleCollection" -Priority 100 -Rule $rule1, $rule2 +$ruleCollection.RemoveRuleByName("r1") +``` + +This example creates a new NAT rule collection with two rules and then removes the first rule from the rule collection by calling method +RemoveRuleByName on the rule collection object. The rule name for method RemoveRuleByName is case-insensitive. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of this NAT rule. The name must be unique inside a rule collection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Specifies the priority of this rule. Priority is a number between 100 and 65000. The smaller the number, the bigger the priority. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +Specifies the list of rules to be grouped under this collection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNatRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNatRuleCollection + +## NOTES + +## RELATED LINKS + +[New-AzFirewallNatRule](./New-AzFirewallNatRule.md) + +[New-AzFirewall](./New-AzFirewall.md) + +[Get-AzFirewall](./Get-AzFirewall.md) diff --git a/azps-10.1.0/Az.Network/New-AzFirewallNetworkRule.md b/azps-10.1.0/Az.Network/New-AzFirewallNetworkRule.md new file mode 100644 index 0000000000..63bad7d99a --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallNetworkRule.md @@ -0,0 +1,254 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C0E1D4DF-232F-49C6-BE4C-05C8E8038329 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallNetworkRule.md +--- + +# New-AzFirewallNetworkRule + +## SYNOPSIS +Creates a Firewall Network Rule. + +## SYNTAX + +``` +New-AzFirewallNetworkRule -Name <String> [-Description <String>] [-SourceAddress <String[]>] + [-SourceIpGroup <String[]>] [-DestinationAddress <String[]>] [-DestinationIpGroup <String[]>] + [-DestinationFqdn <String[]>] -DestinationPort <String[]> -Protocol <String[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallNetworkRule** cmdlet creates an network rule for Azure Firewall. + +## EXAMPLES + +### Example 1: Create a rule for all TCP traffic +```powershell +$rule = New-AzFirewallNetworkRule -Name "all-tcp-traffic" -Description "Rule for all TCP traffic" -Protocol TCP -SourceAddress "*" -DestinationAddress "*" -DestinationPort "*" +``` + +This example creates a rule for all TCP traffic. User enforces whether traffic will be allowed or denied for a rule based on the rule collection it is associated with. + +### Example 2: Create a rule for all TCP traffic from 10.0.0.0 to 60.1.5.0:4040 +```powershell +$rule = New-AzFirewallNetworkRule -Name "partial-tcp-rule" -Description "Rule for all TCP traffic from 10.0.0.0 to 60.1.5.0:4040" -Protocol TCP -SourceAddress "10.0.0.0" -DestinationAddress "60.1.5.0" -DestinationPort "4040" +``` + +This example creates a rule for all TCP traffic from 10.0.0.0 to 60.1.5.0:4040. User enforces whether traffic will be allowed or denied for a rule based on the rule collection it is associated with. + +### Example 3: Create a rule for all TCP and ICMP traffic from any source to 10.0.0.0/16 +```powershell +$rule = New-AzFirewallNetworkRule -Name "tcp-and-icmp-rule" -Description "Rule for all TCP and ICMP traffic from any source to 10.0.0.0/16" -Protocol TCP,ICMP -SourceAddress * -DestinationAddress "10.0.0.0/16" -DestinationPort * +``` + +This example creates a rule for all TCP traffic from any source to 10.0.0.0/16. User enforces whether traffic will be allowed or denied for a rule based on the rule collection it is associated with. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies an optional description of this rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationAddress +The destination addresses of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationFqdn +The destination FQDN of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationIpGroup +The destination ipgroup of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPort +The destination ports of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of this network rule. The name must be unique inside a rule collection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the type of traffic to be filtered by this rule. Possible values are TCP, UDP, ICMP and Any. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: Any, TCP, UDP, ICMP + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceAddress +The source addresses of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceIpGroup +The source ipgroup of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNetworkRule + +## NOTES + +## RELATED LINKS + +[New-AzFirewallNetworkRuleCollection](./New-AzFirewallNetworkRuleCollection.md) + +[New-AzFirewall](./New-AzFirewall.md) + +[Get-AzFirewall](./Get-AzFirewall.md) diff --git a/azps-10.1.0/Az.Network/New-AzFirewallNetworkRuleCollection.md b/azps-10.1.0/Az.Network/New-AzFirewallNetworkRuleCollection.md new file mode 100644 index 0000000000..f36d1afc96 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallNetworkRuleCollection.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: A29E9921-C1B9-42C2-B816-5D4873AC6688 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallnetworkrulecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallNetworkRuleCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallNetworkRuleCollection.md +--- + +# New-AzFirewallNetworkRuleCollection + +## SYNOPSIS +Creates a Azure Firewall Network Collection of Network rules. + +## SYNTAX + +``` +New-AzFirewallNetworkRuleCollection -Name <String> -Priority <UInt32> -Rule <PSAzureFirewallNetworkRule[]> + -ActionType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallNetworkRuleCollection** cmdlet creates a collection of Firewall Network Rules. + +## EXAMPLES + +### Example 1: Create a network collection with two rules +```powershell +$rule1 = New-AzFirewallNetworkRule -Name "all-udp-traffic" -Description "Rule for all UDP traffic" -Protocol UDP -SourceAddress "*" -DestinationAddress "*" -DestinationPort "*" +$rule2 = New-AzFirewallNetworkRule -Name "partial-tcp-rule" -Description "Rule for all TCP traffic from 10.0.0.0 to 60.1.5.0:4040" -Protocol TCP -SourceAddress "10.0.0.0" -DestinationAddress "60.1.5.0" -DestinationPort "4040" +New-AzFirewallNetworkRuleCollection -Name RC1 -Priority 100 -Rule $rule1, $rule2 -ActionType "Allow" +``` + +This example creates a collection which will allow all traffic that matches either of the two rules. +The first rule is for all UDP traffic. +The second rule is for TCP traffic from 10.0.0.0 to 60.1.5.0:4040. +If there is another Network rule collection with higher priority (smaller number) which also matches traffic identified in $rule1 or $rule2, +the action of the rule collection with higher priority will take in effect instead. + +### Example 2: Add a rule to a rule collection +```powershell +$rule1 = New-AzFirewallNetworkRule -Name "all-udp-traffic" -Description "Rule for all UDP traffic" -Protocol UDP -SourceAddress "*" -DestinationAddress "*" -DestinationPort "*" +$ruleCollection = New-AzFirewallNetworkRuleCollection -Name "MyNetworkRuleCollection" -Priority 100 -Rule $rule1 -ActionType "Allow" + +$rule2 = New-AzFirewallNetworkRule -Name "partial-tcp-rule" -Description "Rule for all TCP traffic from 10.0.0.0 to 60.1.5.0:4040" -Protocol TCP -SourceAddress "10.0.0.0" -DestinationAddress "60.1.5.0" -DestinationPort "4040" +$ruleCollection.AddRule($rule2) +``` + +This example creates a new network rule collection with one rule and then adds a second rule to the rule collection using method +AddRule on the rule collection object. Each rule name in a given rule collection must have a unique name and is case insensitive. + +### Example 3: Get a rule from a rule collection +```powershell +$rule1 = New-AzFirewallNetworkRule -Name "all-udp-traffic" -Description "Rule for all UDP traffic" -Protocol UDP -SourceAddress "*" -DestinationAddress "*" -DestinationPort "*" +$ruleCollection = New-AzFirewallNetworkRuleCollection -Name "MyNetworkRuleCollection" -Priority 100 -Rule $rule1 -ActionType "Allow" +$getRule=$ruleCollection.GetRuleByName("ALL-UDP-traffic") +``` + +This example creates a new network rule collection with one rule and then gets the rule by name, calling method GetRuleByName on the +rule collection object. The rule name for method GetRuleByName is case-insensitive. + +### Example 4: Remove a rule from a rule collection +```powershell +$rule1 = New-AzFirewallNetworkRule -Name "all-udp-traffic" -Description "Rule for all UDP traffic" -Protocol UDP -SourceAddress "*" -DestinationAddress "*" -DestinationPort "*" +$rule2 = New-AzFirewallNetworkRule -Name "partial-tcp-rule" -Description "Rule for all TCP traffic from 10.0.0.0 to 60.1.5.0:4040" -Protocol TCP -SourceAddress "10.0.0.0" -DestinationAddress "60.1.5.0" -DestinationPort "4040" +$ruleCollection = New-AzFirewallNetworkRuleCollection -Name "MyNetworkRuleCollection" -Priority 100 -Rule $rule1, $rule2 -ActionType "Allow" +$ruleCollection.RemoveRuleByName("ALL-udp-traffic") +``` + +This example creates a new network rule collection with two rules and then removes the first rule from the rule collection by calling method +RemoveRuleByName on the rule collection object. The rule name for method RemoveRuleByName is case-insensitive. + +## PARAMETERS + +### -ActionType +Specifies the action to be taken for traffic matching conditions of this rule. Accepted actions are "Allow" or "Deny". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of this network rule collection. The name must be unique across all network rule collection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Specifies the priority of this rule collection. Priority is a number between 100 and 65000. The smaller the number, the higher the priority. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +Specifies the list of rules to be grouped under this collection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNetworkRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNetworkRuleCollection + +## NOTES + +## RELATED LINKS + +[New-AzFirewallNetworkRule](./New-AzFirewallNetworkRule.md) + +[New-AzFirewall](./New-AzFirewall.md) + +[Get-AzFirewall](./Get-AzFirewall.md) diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicy.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicy.md new file mode 100644 index 0000000000..6ae780f831 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicy.md @@ -0,0 +1,485 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicy.md +--- + +# New-AzFirewallPolicy + +## SYNOPSIS +Creates a new Azure Firewall Policy + +## SYNTAX + +``` +New-AzFirewallPolicy -Name <String> -ResourceGroupName <String> -Location <String> [-ThreatIntelMode <String>] + [-ThreatIntelWhitelist <PSAzureFirewallPolicyThreatIntelWhitelist>] [-BasePolicy <String>] + [-DnsSetting <PSAzureFirewallPolicyDnsSettings>] [-SqlSetting <PSAzureFirewallPolicySqlSetting>] + [-Tag <Hashtable>] [-Force] [-AsJob] [-IntrusionDetection <PSAzureFirewallPolicyIntrusionDetection>] + [-TransportSecurityName <String>] [-TransportSecurityKeyVaultSecretId <String>] [-SkuTier <String>] + [-UserAssignedIdentityId <String>] [-Identity <PSManagedServiceIdentity>] [-PrivateRange <String[]>] + [-ExplicitProxy <PSAzureFirewallPolicyExplicitProxy>] [-Snat <PSAzureFirewallPolicySNAT>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicy** cmdlet creates an Azure Firewall Policy. + +## EXAMPLES + +### Example 1: Create an empty policy +```powershell +New-AzFirewallPolicy -Name fp1 -ResourceGroupName TestRg +``` + +This example creates an azure firewall policy + +### Example 2: Create an empty policy with ThreatIntel Mode +```powershell +New-AzFirewallPolicy -Name fp1 -ResourceGroupName TestRg -ThreatIntelMode "Deny" +``` + +This example creates an azure firewall policy with a threat intel mode + +### Example 3: Create an empty policy with ThreatIntel Whitelist +```powershell +$threatIntelWhitelist = New-AzFirewallPolicyThreatIntelWhitelist -IpAddress 23.46.72.91,192.79.236.79 -FQDN microsoft.com +New-AzFirewallPolicy -Name fp1 -ResourceGroupName TestRg -ThreatIntelWhitelist $threatIntelWhitelist +``` + +This example creates an azure firewall policy with a threat intel whitelist + +### Example 4: Create policy with intrusion detection, identity and transport security +```powershell +$bypass = New-AzFirewallPolicyIntrusionDetectionBypassTraffic -Name "bypass-setting" -Protocol "TCP" -DestinationPort "80" -SourceAddress "10.0.0.0" -DestinationAddress "*" +$signatureOverride = New-AzFirewallPolicyIntrusionDetectionSignatureOverride -Id "123456798" -Mode "Deny" +$intrusionDetection = New-AzFirewallPolicyIntrusionDetection -Mode "Alert" -SignatureOverride $signatureOverride -BypassTraffic $bypass +$userAssignedIdentity = '/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/TestRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-assign-identity' +New-AzFirewallPolicy -Name fp1 -Location "westus2" -ResourceGroupName TestRg -SkuTier "Premium" -IntrusionDetection $intrusionDetection -TransportSecurityName tsName -TransportSecurityKeyVaultSecretId "https://<keyvaultname>.vault.azure.net/secrets/cacert" -UserAssignedIdentityId $userAssignedIdentity +``` + +This example creates an azure firewall policy with a intrusion detection in mode alert, user assigned identity and transport security + +### Example 5: Create an empty Firewall Policy with customized private range setup +```powershell +New-AzFirewallPolicy -Name fp1 -ResourceGroupName TestRg -PrivateRange @("99.99.99.0/24", "66.66.0.0/16") +``` + +This example creates a Firewall that treats "99.99.99.0/24" and "66.66.0.0/16" as private ip ranges and won't snat traffic to those addresses + +### Example 6: Create an empty Firewall Policy with Explicit Proxy Settings +```powershell +$exProxy = New-AzFirewallPolicyExplicitProxy -EnableExplicitProxy -HttpPort 100 -HttpsPort 101 -EnablePacFile -PacFilePort 130 -PacFile "sampleurlfortesting.blob.core.windowsnet/nothing" +New-AzFirewallPolicy -Name fp1 -ResourceGroupName TestRg -ExplicitProxy $exProxy +``` + +```output +BasePolicy : null + DnsSettings : null + Etag : null + ExplicitProxy + EnableExplicitProxy : true + EnablePacFile : true + HttpPort : 100 + HttpsPort : 101 + PacFile : "sampleurlfortesting.blob.core.windowsnet/nothing" + PacFilePort : 130 + Id : null + Identity : null + IntrusionDetection : null + Location : "westus2" + Name : "fp1" + PrivateRange : null + PrivateRangeText : "[]" + ProvisioningState : null + ResourceGroupName : "TestRg" + ResourceGuid : null + RuleCollectionGroups : null + Sku + Tier : "Standard" + Snat + AutoLearnPrivateRanges : null + PrivateRanges : null + SqlSetting : null + Tag : null + TagsTable : null + ThreatIntelMode : "Alert" + ThreatIntelWhitelist : null + TransportSecurity : null + Type : null +``` + +This example creates a firewall policy with explicit proxy settings + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BasePolicy +The base policy to inherit from + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsSetting +The DNS Setting + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyDnsSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExplicitProxy +The Explicit Proxy Settings + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyExplicitProxy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Firewall Policy Identity to be assigned to Firewall Policy. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntrusionDetection +The Intrusion Detection Setting + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyIntrusionDetection +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateRange +The private IP ranges to which traffic won't be SNAT'ed + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuTier +Firewall policy sku tier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Standard, Premium, Basic + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Snat +The private IP addresses/IP ranges to which traffic will not be SNAT in Firewall Policy. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicySNAT +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlSetting +The SQL related setting + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicySqlSetting +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ThreatIntelMode +The operation mode for Threat Intelligence. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Alert, Deny, Off + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ThreatIntelWhitelist +The whitelist for Threat Intelligence + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyThreatIntelWhitelist +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportSecurityKeyVaultSecretId +Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportSecurityName +Transport security name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +ResourceId of the user assigned identity to be assigned to Firewall Policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: UserAssignedIdentity + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewall + +## NOTES + +## RELATED LINKS + +[New-AzFirewallPolicyExplicitProxy](./New-AzFirewallPolicyExplicitProxy.md) +[New-AzFirewallPolicySnat](./New-AzFirewallPolicySnat.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicyApplicationRule.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicyApplicationRule.md new file mode 100644 index 0000000000..f2609fcadc --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicyApplicationRule.md @@ -0,0 +1,270 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicyapplicationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyApplicationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyApplicationRule.md +--- + +# New-AzFirewallPolicyApplicationRule + +## SYNOPSIS +Create a new Azure Firewall Policy Application Rule + +## SYNTAX + +### SourceAddressAndTargetFqdn (Default) +``` +New-AzFirewallPolicyApplicationRule -Name <String> [-Description <String>] -SourceAddress <String[]> + -TargetFqdn <String[]> -Protocol <String[]> [-TerminateTLS] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SourceAddressAndFqdnTag +``` +New-AzFirewallPolicyApplicationRule -Name <String> [-Description <String>] -SourceAddress <String[]> + -FqdnTag <String[]> [-TerminateTLS] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SourceAddressAndWebCategory +``` +New-AzFirewallPolicyApplicationRule -Name <String> [-Description <String>] -SourceAddress <String[]> + -WebCategory <String[]> -Protocol <String[]> [-TerminateTLS] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SourceAddressAndTargetUrl +``` +New-AzFirewallPolicyApplicationRule -Name <String> [-Description <String>] -SourceAddress <String[]> + -Protocol <String[]> -TargetUrl <String[]> [-TerminateTLS] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SourceIpGroupAndTargetFqdn +``` +New-AzFirewallPolicyApplicationRule -Name <String> [-Description <String>] -SourceIpGroup <String[]> + -TargetFqdn <String[]> -Protocol <String[]> [-TerminateTLS] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SourceIpGroupAndFqdnTag +``` +New-AzFirewallPolicyApplicationRule -Name <String> [-Description <String>] -SourceIpGroup <String[]> + -FqdnTag <String[]> [-TerminateTLS] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SourceIpGroupAndWebCategory +``` +New-AzFirewallPolicyApplicationRule -Name <String> [-Description <String>] -SourceIpGroup <String[]> + -FqdnTag <String[]> -WebCategory <String[]> -Protocol <String[]> [-TerminateTLS] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SourceIpGroupAndTargetUrl +``` +New-AzFirewallPolicyApplicationRule -Name <String> [-Description <String>] -SourceIpGroup <String[]> + -Protocol <String[]> -TargetUrl <String[]> [-TerminateTLS] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicyApplicationRule** cmdlet creates an Application Rule for a Azure Firewall Policy. + +## EXAMPLES + +### Example 1 +```powershell +New-AzFirewallPolicyApplicationRule -Name AR1 -SourceAddress "192.168.0.0/16" -Protocol "http:80","https:443" -TargetFqdn "*.ro", "*.com" +``` + +This example creates an application rule with the source address, protocol and the target fqdns. + +### Example 2 +```powershell +New-AzFirewallPolicyApplicationRule -Name AR1 -SourceAddress "192.168.0.0/16" -Protocol "http:80","https:443" -WebCategory "DatingAndPersonals", "Tasteless" +``` + +This example creates an application rule with the source address, protocol and web categories. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FqdnTag +The FQDN Tags of the rule + +```yaml +Type: System.String[] +Parameter Sets: SourceAddressAndFqdnTag, SourceIpGroupAndFqdnTag, SourceIpGroupAndWebCategory +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +The protocols of the rule + +```yaml +Type: System.String[] +Parameter Sets: SourceAddressAndTargetFqdn, SourceAddressAndWebCategory, SourceAddressAndTargetUrl, SourceIpGroupAndTargetFqdn, SourceIpGroupAndWebCategory, SourceIpGroupAndTargetUrl +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceAddress +The source addresses of the rule + +```yaml +Type: System.String[] +Parameter Sets: SourceAddressAndTargetFqdn, SourceAddressAndFqdnTag, SourceAddressAndWebCategory, SourceAddressAndTargetUrl +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceIpGroup +The source ipgroups of the rule + +```yaml +Type: System.String[] +Parameter Sets: SourceIpGroupAndTargetFqdn, SourceIpGroupAndFqdnTag, SourceIpGroupAndWebCategory, SourceIpGroupAndTargetUrl +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetFqdn +The target FQDNs of the rule + +```yaml +Type: System.String[] +Parameter Sets: SourceAddressAndTargetFqdn, SourceIpGroupAndTargetFqdn +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetUrl +The Target Url of the rule + +```yaml +Type: System.String[] +Parameter Sets: SourceAddressAndTargetUrl, SourceIpGroupAndTargetUrl +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TerminateTLS +Indicates terminating TLS + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebCategory +The Web Categories of the rule + +```yaml +Type: System.String[] +Parameter Sets: SourceAddressAndWebCategory, SourceIpGroupAndWebCategory +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyApplicationRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicyApplicationRuleCustomHttpHeader.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicyApplicationRuleCustomHttpHeader.md new file mode 100644 index 0000000000..d3512b6f3c --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicyApplicationRuleCustomHttpHeader.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicyapplicationrulecustomhttpHeader +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyApplicationRuleCustomHttpHeader.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyApplicationRuleCustomHttpHeader.md +--- + +# New-AzFirewallPolicyApplicationRuleCustomHttpHeader + +## SYNOPSIS +Create a new Azure Firewall Policy Application Rule Custon HTTP Header + +## SYNTAX + +``` +New-AzFirewallPolicyApplicationRuleCustomHttpHeader -HeaderName <String> -HeaderValue <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicyApplicationRuleCustomHttpHeader** cmdlet creates a Custom HTTP Header for Application Rule. + +## EXAMPLES + +### Example 1 +```powershell +$appRule = New-AzFirewallPolicyApplicationRule -Name "appRule" -SourceAddress "192.168.0.0/16" -TargetFqdn "*.contoso.com" -Protocol "https:443" + +$headerToInsert = New-AzFirewallPolicyApplicationRuleCustomHttpHeader -HeaderName "Restrict-Access-To-Tenants" -HeaderValue "contoso.com,fabrikam.onmicrosoft.com" + +$appRule.AddCustomHttpHeaderToInsert($headerToInsert) +``` + +This example creates an application rule and a custom HTTP header, then adds the header to the rule. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderName +The description of the rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderValue +The description of the rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyApplicationRuleCustomHttpHeader + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicyDnsSetting.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicyDnsSetting.md new file mode 100644 index 0000000000..912a0f6c60 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicyDnsSetting.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicydnssetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyDnsSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyDnsSetting.md +--- + +# New-AzFirewallPolicyDnsSetting + +## SYNOPSIS +Creates a new DNS Setting for Azure Firewall Policy + +## SYNTAX + +``` +New-AzFirewallPolicyDnsSetting [-EnableProxy] [-Server <String[]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicyDnsSetting** cmdlet creates a DNS Setting Object for Azure Firewall Policy + +## EXAMPLES + +### Example 1. Create an empty policy +```powershell +New-AzFirewallPolicyDnsSetting -EnableProxy +``` + +This example creates a dns Setting object with setting enabling dns proxy. + +### Example 2. Create an empty policy with ThreatIntel Mode +```powershell +$dnsServers = @("10.10.10.1", "20.20.20.2") +New-AzFirewallPolicyDnsSetting -EnableProxy -Server $dnsServers +``` + +This example creates a dns Setting object with setting enabling dns proxy and setting custom dns servers. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableProxy +Enable DNS Proxy. +By default it is disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +The list of DNS Servers + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyDnsSettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicyExplicitProxy.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicyExplicitProxy.md new file mode 100644 index 0000000000..d9462236aa --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicyExplicitProxy.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicyexplicitproxy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyExplicitProxy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyExplicitProxy.md +--- + +# New-AzFirewallPolicyExplicitProxy + +## SYNOPSIS +Creates a new Explicit Proxy + +## SYNTAX + +``` +New-AzFirewallPolicyExplicitProxy [-EnableExplicitProxy] [-HttpPort <Int32>] [-HttpsPort <Int32>] + [-EnablePacFile] [-PacFilePort <Int32>] [-PacFile <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicyExplicitProxy** cmdlet creates an explicit proxy + +## EXAMPLES + +### Example 1 +```powershell +New-AzFirewallPolicyExplicitProxy -EnableExplicitProxy -HttpPort 100 -HttpsPort 101 -EnablePacFile -PacFilePort 130 -PacFile "sampleurlfortesting.blob.core.windowsnet/nothing" +``` + +```output +EnableExplicitProxy : true + EnablePacFile : true + HttpPort : 100 + HttpsPort : 101 + PacFile : "sampleurlfortesting.blob.core.windowsnet/nothing" + PacFilePort : 130 +``` + +This example creates an explicit proxy with provided settings + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExplicitProxy +Enable Explicit Proxy. +By default it is disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePacFile +Enable PAC File. +By default it is disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPort +Port number for explicit proxy http protocol. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsPort +Port number for explicit proxy https protocol. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacFile +SAS URL for PAC file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PacFilePort +Port number for firewall to serve PAC file. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyExplicitProxy + +## NOTES + +## RELATED LINKS + +[New-AzFireWallPolicy](./New-AzFireWallPolicy.md) + +[Set-AzFireWallPolicy](./Set-AzFireWallPolicy.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicyFilterRuleCollection.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicyFilterRuleCollection.md new file mode 100644 index 0000000000..520ee6fd0f --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicyFilterRuleCollection.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicyfilterrulecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyFilterRuleCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyFilterRuleCollection.md +--- + +# New-AzFirewallPolicyFilterRuleCollection + +## SYNOPSIS +Create a new Azure Firewall Policy Filter Rule Collection + +## SYNTAX + +``` +New-AzFirewallPolicyFilterRuleCollection -Name <String> -Priority <UInt32> + [-Rule <PSAzureFirewallPolicyRule[]>] -ActionType <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicyFilterRuleCollection** cmdlet creates a Filter rule collection for a Azure Firewall Policy. + +## EXAMPLES + +### Example 1 +```powershell +New-AzFirewallPolicyFilterRuleCollection -Name FR1 -Priority 400 -Rule $appRule1 ,$appRule2 -ActionType "Allow" +``` + +This example creates a Filter rule with 2 rule conditions + +## PARAMETERS + +### -ActionType +The action of the rule collection + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Application Rule Collection + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The priority of the rule collection + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +The list of application rules + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyRuleCollectionGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicyIntrusionDetection.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicyIntrusionDetection.md new file mode 100644 index 0000000000..a4c8e1e208 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicyIntrusionDetection.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicyintrusiondetection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyIntrusionDetection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyIntrusionDetection.md +--- + +# New-AzFirewallPolicyIntrusionDetection + +## SYNOPSIS +Creates a new Azure Firewall Policy Intrusion Detection to associate with Firewall Policy + +## SYNTAX + +``` +New-AzFirewallPolicyIntrusionDetection -Mode <String> + [-SignatureOverride <PSAzureFirewallPolicyIntrusionDetectionSignatureOverride[]>] + [-BypassTraffic <PSAzureFirewallPolicyIntrusionDetectionBypassTrafficSetting[]>] [-PrivateRange <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicyIntrusionDetection** cmdlet creates an Azure Firewall Policy Intrusion Detection Object. + +## EXAMPLES + +### Example 1: Create intrusion detection with mode +```powershell +New-AzFirewallPolicyIntrusionDetection -Mode "Alert" +``` + +This example creates intrusion detection with Alert (detection) mode + +### Example 2: Create intrusion detection with signature overrides +```powershell +$signatureOverride = New-AzFirewallPolicyIntrusionDetectionSignatureOverride -Id "123456798" -Mode "Deny" +New-AzFirewallPolicyIntrusionDetection -Mode "Alert" -SignatureOverride $signatureOverride +``` + +This example creates intrusion detection with specific signature override + +### Example 3: Create firewall policy with intrusion detection configured with bypass traffic setting +```powershell +$bypass = New-AzFirewallPolicyIntrusionDetectionBypassTraffic -Name "bypass-setting" -Protocol "TCP" -DestinationPort "80" -SourceAddress "10.0.0.0" -DestinationAddress "10.0.0.0" +$intrusionDetection = New-AzFirewallPolicyIntrusionDetection -Mode "Deny" -BypassTraffic $bypass +New-AzFirewallPolicy -Name fp1 -Location "westus2" -ResourceGroupName TestRg -SkuTier "Premium" -IntrusionDetection $intrusionDetection +``` + +This example creates intrusion detection with bypass traffic setting + +### Example 4: Create firewall policy with intrusion detection configured with private ranges setting +```powershell +$intrusionDetection = New-AzFirewallPolicyIntrusionDetection -Mode "Deny" -PrivateRange @("167.220.204.0/24", "167.221.205.101/32") +New-AzFirewallPolicy -Name fp1 -Location "westus2" -ResourceGroupName TestRg -SkuTier "Premium" -IntrusionDetection $intrusionDetection +``` + +This example creates intrusion detection with bypass traffic setting + +## PARAMETERS + +### -BypassTraffic +List of rules for traffic to bypass. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyIntrusionDetectionBypassTrafficSetting[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Intrusion Detection general state. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Off, Alert, Deny + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateRange +List of IDPS Private IP ranges. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignatureOverride +List of specific signatures states. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyIntrusionDetectionSignatureOverride[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyIntrusionDetection + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicyIntrusionDetectionBypassTraffic.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicyIntrusionDetectionBypassTraffic.md new file mode 100644 index 0000000000..46ca48a325 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicyIntrusionDetectionBypassTraffic.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicyintrusiondetectionbypasstraffic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyIntrusionDetectionBypassTraffic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyIntrusionDetectionBypassTraffic.md +--- + +# New-AzFirewallPolicyIntrusionDetectionBypassTraffic + +## SYNOPSIS +Creates a new Azure Firewall Policy Intrusion Detection Bypass Traffic Setting + +## SYNTAX + +``` +New-AzFirewallPolicyIntrusionDetectionBypassTraffic -Name <String> [-Description <String>] -Protocol <String> + [-SourceAddress <String[]>] [-DestinationAddress <String[]>] [-SourceIpGroup <String[]>] + [-DestinationIpGroup <String[]>] -DestinationPort <String[]> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicyIntrusionDetectionBypassTraffic** cmdlet creates an Azure Firewall Policy Intrusion Detection Bypass Traffic Object. + +## EXAMPLES + +### Example 1: Create bypass traffic with specific port and source address +```powershell +$bypass = New-AzFirewallPolicyIntrusionDetectionBypassTraffic -Name "bypass-setting" -Protocol "TCP" -DestinationPort "80" -SourceAddress "10.0.0.0" -DestinationAddress "*" +New-AzFirewallPolicyIntrusionDetection -Mode "Deny" -BypassTraffic $bypass +``` + +This example creates intrusion detection with bypass traffic setting + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Bypass setting description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationAddress +List of destination IP addresses or ranges. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationIpGroup +List of destination IpGroups. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPort +List of destination ports or ranges. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Bypass setting name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Bypass setting protocol. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TCP, UDP, ICMP, ANY + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceAddress +List of source IP addresses or ranges. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceIpGroup +List of source IpGroups. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyIntrusionDetectionBypassTrafficSetting + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicyIntrusionDetectionSignatureOverride.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicyIntrusionDetectionSignatureOverride.md new file mode 100644 index 0000000000..631c57f1fe --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicyIntrusionDetectionSignatureOverride.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicyintrusiondetectionsignatureoverride +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyIntrusionDetectionSignatureOverride.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyIntrusionDetectionSignatureOverride.md +--- + +# New-AzFirewallPolicyIntrusionDetectionSignatureOverride + +## SYNOPSIS +Creates a new Azure Firewall Policy Intrusion Detection Signature Override + +## SYNTAX + +``` +New-AzFirewallPolicyIntrusionDetectionSignatureOverride -Id <UInt64> -Mode <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicyIntrusionDetectionSignatureOverride** cmdlet creates an Azure Firewall Policy Signature Override Object. + +## EXAMPLES + +### Example 1: Create intrusion detection with signature overrides +```powershell +$signatureOverride = New-AzFirewallPolicyIntrusionDetectionSignatureOverride -Id "123456798" -Mode "Deny" +New-AzFirewallPolicyIntrusionDetection -Mode "Alert" -SignatureOverride $signatureOverride +``` + +This example creates intrusion detection with specific signature override to Deny mode + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Signature id. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Signature state. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Off, Alert, Deny + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyIntrusionDetectionSignatureOverride + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicyNatRule.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicyNatRule.md new file mode 100644 index 0000000000..1491566491 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicyNatRule.md @@ -0,0 +1,244 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicynatrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyNatRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyNatRule.md +--- + +# New-AzFirewallPolicyNatRule + +## SYNOPSIS +Create a new Azure Firewall Policy NAT Rule + +## SYNTAX + +### SourceAddressAndTranslatedAddress +``` +New-AzFirewallPolicyNatRule -Name <String> [-Description <String>] -SourceAddress <String[]> + -DestinationAddress <String[]> -DestinationPort <String[]> -Protocol <String[]> -TranslatedAddress <String> + -TranslatedPort <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SourceAddressAndTranslatedFqdn +``` +New-AzFirewallPolicyNatRule -Name <String> [-Description <String>] -SourceAddress <String[]> + -DestinationAddress <String[]> -DestinationPort <String[]> -Protocol <String[]> -TranslatedFqdn <String> + -TranslatedPort <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SourceIpGroupAndTranslatedAddress +``` +New-AzFirewallPolicyNatRule -Name <String> [-Description <String>] -SourceIpGroup <String[]> + -DestinationAddress <String[]> -DestinationPort <String[]> -Protocol <String[]> -TranslatedAddress <String> + -TranslatedPort <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SourceIpGroupAndTranslatedFqdn +``` +New-AzFirewallPolicyNatRule -Name <String> [-Description <String>] -SourceIpGroup <String[]> + -DestinationAddress <String[]> -DestinationPort <String[]> -Protocol <String[]> -TranslatedFqdn <String> + -TranslatedPort <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicyNatRule** cmdlet creates a NAT rule for a Azure Firewall Policy. + +## EXAMPLES + +### Example 1 +```powershell +New-AzFirewallPolicyNatRule -Name NatRule1 -Protocol "TCP" -SourceAddress "192.168.0.0/16" -DestinationAddress 10.20.30.40 -DestinationPort 1000 -TranslatedAddress "192.168.0.1" -TranslatedPort "100" +``` + +This example creates a NAT rule with the source address, protocol, destination address, destination port, translated address, and translated port. + +### Example 2 +```powershell +New-AzFirewallPolicyNatRule -Name NatRule1 -Protocol "TCP" -SourceAddress "192.168.0.0/16" -DestinationAddress 10.20.30.40 -DestinationPort 1000 -TranslatedFqdn "internalhttp.server.net" -TranslatedPort "100" +``` + +This example creates a NAT rule with the source address, protocol, destination address, destination port, translated fqdn, and translated port. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationAddress +The destination addresses of the rule. This has to be Public IP of the Firewall. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPort +The destination ports of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the NAT Rule Collection + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +The protocols of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceAddress +The source addresses of the rule + +```yaml +Type: System.String[] +Parameter Sets: SourceAddressAndTranslatedAddress, SourceAddressAndTranslatedFqdn +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceIpGroup +The source ipgroups of the rule + +```yaml +Type: System.String[] +Parameter Sets: SourceIpGroupAndTranslatedAddress, SourceIpGroupAndTranslatedFqdn +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranslatedAddress +The translated address for this NAT rule + +```yaml +Type: System.String +Parameter Sets: SourceAddressAndTranslatedAddress, SourceIpGroupAndTranslatedAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranslatedFqdn +The translated FQDN for this NAT rule + +```yaml +Type: System.String +Parameter Sets: SourceAddressAndTranslatedFqdn, SourceIpGroupAndTranslatedFqdn +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranslatedPort +The translated port for this NAT rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNatRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicyNatRuleCollection.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicyNatRuleCollection.md new file mode 100644 index 0000000000..3d1b492d8f --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicyNatRuleCollection.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicynatrulecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyNatRuleCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyNatRuleCollection.md +--- + +# New-AzFirewallPolicyNatRuleCollection + +## SYNOPSIS +Create a new Azure Firewall Policy Nat Rule Collection + +## SYNTAX + +``` +New-AzFirewallPolicyNatRuleCollection -Name <String> -Priority <UInt32> + [-Rule <PSAzureFirewallPolicyNatRule[]>] -ActionType <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicyNatRuleCollection** cmdlet creates a Nat rule collection for a Azure Firewall Policy. + +## EXAMPLES + +### Example 1 +```powershell +$netRule1 = New-AzFirewallPolicyNatRule -Name NatRule1 -Protocol "TCP" -SourceAddress "192.168.0.0/16" -DestinationAddress 10.20.30.40 -DestinationPort 1000 -TranslatedAddress "192.168.0.1" -TranslatedPort "100" +New-AzFirewallPolicyNatRuleCollection -Name NatRC1 -Priority 200 -Rule $netRule1 -ActionType "Dnat" +``` + +This example creates a nat rule collection with a network rule + +## PARAMETERS + +### -ActionType +The type of the rule action + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Dnat, Snat + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Network Rule Collection + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The priority of the rule collection + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +The list of network rules + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyNatRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNetworkRuleCollection + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicyNetworkRule.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicyNetworkRule.md new file mode 100644 index 0000000000..35ac2d458b --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicyNetworkRule.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicynetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyNetworkRule.md +--- + +# New-AzFirewallPolicyNetworkRule + +## SYNOPSIS +Create a new Azure Firewall Policy Network Rule + +## SYNTAX + +### SourceAddress +``` +New-AzFirewallPolicyNetworkRule -Name <String> [-Description <String>] -SourceAddress <String[]> + [-DestinationAddress <String[]>] [-DestinationIpGroup <String[]>] -DestinationPort <String[]> + [-DestinationFqdn <String[]>] -Protocol <String[]> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SourceIpGroup +``` +New-AzFirewallPolicyNetworkRule -Name <String> [-Description <String>] -SourceIpGroup <String[]> + [-DestinationAddress <String[]>] [-DestinationIpGroup <String[]>] -DestinationPort <String[]> + [-DestinationFqdn <String[]>] -Protocol <String[]> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicyNetworkRule** cmdlet creates a Network rule for a Azure Firewall Policy. + +## EXAMPLES + +### Example 1 +```powershell +New-AzFirewallPolicyNetworkRule -Name NRC1 -Protocol "TCP" -SourceAddress "192.168.0.0/16" -DestinationAddress * -DestinationPort * +``` + +This example creates an network rule with the source address, protocol , destination address and destination port + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationAddress +The destination addresses of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationFqdn +The destination FQDN of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationIpGroup +The destination ipgroups of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPort +The destination ports of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Network Rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +The protocols of the rule + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: Any, TCP, UDP, ICMP + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceAddress +The source addresses of the rule + +```yaml +Type: System.String[] +Parameter Sets: SourceAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceIpGroup +The source ipgroups of the rule + +```yaml +Type: System.String[] +Parameter Sets: SourceIpGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNetworkRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicyRuleCollectionGroup.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicyRuleCollectionGroup.md new file mode 100644 index 0000000000..6e7d00dbca --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicyRuleCollectionGroup.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicyrulecollectiongroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyRuleCollectionGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyRuleCollectionGroup.md +--- + +# New-AzFirewallPolicyRuleCollectionGroup + +## SYNOPSIS +Create a new Azure Firewall Policy Rule Collection Group + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +New-AzFirewallPolicyRuleCollectionGroup -Name <String> -Priority <UInt32> + [-RuleCollection <PSAzureFirewallPolicyBaseRuleCollection[]>] -ResourceGroupName <String> + -FirewallPolicyName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +New-AzFirewallPolicyRuleCollectionGroup -Name <String> -Priority <UInt32> + [-RuleCollection <PSAzureFirewallPolicyBaseRuleCollection[]>] -FirewallPolicyObject <PSAzureFirewallPolicy> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicyRuleCollectionGroup** cmdlet creates a rule collection group in a Azure Firewall Policy. + +## EXAMPLES + +### Example 1 +```powershell +New-AzFirewallPolicyRuleCollectionGroup -Name rg1 -Priority 200 -RuleCollection $filterRule1 -FirewallPolicyObject $fp +``` + +This example creates a rule collection group in the firewall policy $fp + +### Example 2 + +Create a new Azure Firewall Policy Rule Collection Group. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzFirewallPolicyRuleCollectionGroup -FirewallPolicyName <String> -Name rg1 -Priority 200 -ResourceGroupName TestRg +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicyName +The name of the firewall policy + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FirewallPolicyObject +Firewall Policy. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicy +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the Rule Group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The priority of the rule group + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleCollection +The list of rules + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyBaseRuleCollection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyRuleCollectionGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicySnat.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicySnat.md new file mode 100644 index 0000000000..3bdc137ff4 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicySnat.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicysnat +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicySnat.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicySnat.md +--- + +# New-AzFirewallPolicySnat + +## SYNOPSIS +Creates SNAT configuration of PrivateRange and AutoLearnPrivateRanges for the firewall policy + +## SYNTAX + +``` +New-AzFirewallPolicySnat [-PrivateRange <String[]>] [-AutoLearnPrivateRange] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzFirewallPolicySnat is used to configure Private Ranges and auto learn private ranges for a firewall policy. + +## EXAMPLES + +### Example 1 +```powershell +New-AzFirewallPolicySnat -PrivateRange @("3.3.0.0/24", "98.0.0.0/8","10.227.16.0/20") -AutoLearnPrivateRange +``` + +```output +PrivateRange : ["3.3.0.0/24", "98.0.0.0/8","10.227.16.0/20"] + AutoLearnPrivateRanges : Enabled +``` + +This example configures private IP addresses/IP ranges to which traffic will not be SNATed and enables auto learn of private ip ranges in Firewall Policy. + +### Example 2 +```powershell +New-AzFirewallPolicySnat -PrivateRange @("3.3.0.0/24", "98.0.0.0/8","10.227.16.0/20") +``` + +```output +PrivateRange : ["3.3.0.0/24", "98.0.0.0/8","10.227.16.0/20"] + AutoLearnPrivateRanges : Disabled +``` + +This example configures private IP addresses/IP ranges to which traffic will not be SNATed and disables auto learn of private ip ranges in Firewall Policy. + +## PARAMETERS + +### -AutoLearnPrivateRange +Enable/disable auto learn private ranges. +By default it is disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateRange +The Private IP Range + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicySNAT + +## NOTES + +## RELATED LINKS + +[New-AzFireWallPolicy](./New-AzFireWallPolicy.md) + +[Set-AzFireWallPolicy](./Set-AzFireWallPolicy.md) diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicySqlSetting.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicySqlSetting.md new file mode 100644 index 0000000000..3e748734d4 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicySqlSetting.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicysqlsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicySqlSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicySqlSetting.md +--- + +# New-AzFirewallPolicySqlSetting + +## SYNOPSIS +Creates a new SQL Setting for Azure Firewall Policy + +## SYNTAX + +``` +New-AzFirewallPolicySqlSetting [-AllowSqlRedirect] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicySqlSetting** cmdlet creates a SQL Setting Object for Azure Firewall Policy + +## EXAMPLES + +### Example 1. Create a SQL setting that allows SQL server redirect mode traffic +```powershell +New-AzFirewallPolicySqlSetting -AllowSqlRedirect +``` + +This example creates a SQL setting object with setting allow sql redirect. + +## PARAMETERS + +### -AllowSqlRedirect +Allow SQL server redirect mode traffic. +By default this type of traffic is not allowed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicySqlSetting + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPolicyThreatIntelWhitelist.md b/azps-10.1.0/Az.Network/New-AzFirewallPolicyThreatIntelWhitelist.md new file mode 100644 index 0000000000..b708b18bf2 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPolicyThreatIntelWhitelist.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpolicythreatintelwhitelist +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyThreatIntelWhitelist.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPolicyThreatIntelWhitelist.md +--- + +# New-AzFirewallPolicyThreatIntelWhitelist + +## SYNOPSIS +Create a new threat intelligence whitelist for Azure Firewall Policy + +## SYNTAX + +``` +New-AzFirewallPolicyThreatIntelWhitelist [-FQDN <String[]>] [-IpAddress <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallPolicyThreatIntelWhitelist** cmdlet creates a threat intel whitelist object, which can be used when creating or setting an Azure Firewall Policy. + +## EXAMPLES + +### Example 1 +```powershell +New-AzFirewallPolicyThreatIntelWhitelist -IpAddress 23.46.72.91,192.79.236.79 -FQDN microsoft.com +``` + +This example creates a threat intel whitelist containing a FQDN whitelist of one entry and an Ip address whitelist of two entries + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FQDN +The FQDNs of the Threat Intel Whitelist + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddress +The IP Addresses of the Threat Intel Whitelist + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyThreatIntelWhitelist + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallPublicIpAddress.md b/azps-10.1.0/Az.Network/New-AzFirewallPublicIpAddress.md new file mode 100644 index 0000000000..88eecda1d9 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallPublicIpAddress.md @@ -0,0 +1,79 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallpublicipaddress +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPublicIpAddress.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallPublicIpAddress.md +--- + +# New-AzFirewallPublicIpAddress + +## SYNOPSIS +This is the placeholder for the Ip Address that can be used for multi pip on azure firewall. + +## SYNTAX + +``` +New-AzFirewallPublicIpAddress [-Address <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +This is the placeholder for the Ip Address that can be used for multi pip on azure firewall. + +## EXAMPLES + +### Example 1 +```powershell +$publicIp = New-AzFirewallPublicIpAddress -Address 20.2.3.4 +``` + +$publicIp will be the placeholder for the ip address 20.2.3.4 + +## PARAMETERS + +### -Address +The IP Addresses of the Firewall attached to a hub + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPublicIpAddress + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzFirewallThreatIntelWhitelist.md b/azps-10.1.0/Az.Network/New-AzFirewallThreatIntelWhitelist.md new file mode 100644 index 0000000000..b890b49a1e --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzFirewallThreatIntelWhitelist.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azfirewallthreatintelwhitelist +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallThreatIntelWhitelist.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzFirewallThreatIntelWhitelist.md +--- + +# New-AzFirewallThreatIntelWhitelist + +## SYNOPSIS +Create a new threat intelligence whitelist for Azure Firewall + +## SYNTAX + +``` +New-AzFirewallThreatIntelWhitelist [-FQDN <String[]>] [-IpAddress <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzFirewallThreatIntelWhitelist** cmdlet creates a threat intel whitelist object, which can be used when creating or setting an Azure Firewall. + +## EXAMPLES + +### Example 1 +```powershell +New-AzFirewallThreatIntelWhitelist -IpAddress @("2.2.2.2", "3.3.3.3") -FQDN @("bing.com", "yammer.com") +``` + +This example creates a threat intel whitelist containing a FQDN whitelist of two entries and an Ip address whitelist of two entries + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FQDN +The FQDNs of the Threat Intel Whitelist + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddress +The IP Addresses of the Threat Intel Whitelist + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallThreatIntelWhitelist + +## NOTES + +## RELATED LINKS + +[Get-AzFirewall](./Get-AzFirewall.md) + +[New-AzFirewall](./New-AzFirewall.md) + +[Set-AzFirewall](./Set-AzFirewall.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzGatewayCustomBgpIpConfigurationObject.md b/azps-10.1.0/Az.Network/New-AzGatewayCustomBgpIpConfigurationObject.md new file mode 100644 index 0000000000..23e4e78f80 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzGatewayCustomBgpIpConfigurationObject.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azgatewaycustombgpipconfigurationobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzGatewayCustomBgpIpConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzGatewayCustomBgpIpConfigurationObject.md +--- + +# New-AzGatewayCustomBgpIpConfigurationObject + +## SYNOPSIS +creates a new GatewayCustomBgpIpConfigurationObject. + +## SYNTAX + +``` +New-AzGatewayCustomBgpIpConfigurationObject -IpConfigurationId <String> -CustomBgpIpAddress <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzGatewayCustomBgpIpConfigurationObject** creates a GatewayCustomBgpIpConfigurationObject which represents GatewayCustomBgpIpAddress property in your virtual network gateway connection. + +## EXAMPLES + +### Example 1 Create a AzGatewayCustomBgpIpConfigurationObject VirtualNetworkGatewayConnection +```powershell +$address = New-AzGatewayCustomBgpIpConfigurationObject -IpConfigurationId "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/khbaheti_PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw/ipConfigurations/default" -CustomBgpIpAddress "169.254.21.1" +``` + +### Example 2 Create a AzGatewayCustomBgpIpConfigurationObject VpnsiteLinkConnection +```powershell +$vpnGateway = Get-AzVpnGateway -ResourceGroupName PS_testing -Name 196ddf92afae40e4b20edc32dfb48a63-eastus-gw +$address1 = New-AzGatewayCustomBgpIpConfigurationObject -IpConfigurationId "Instance0" -CustomBgpIpAddress "169.254.22.1" +$address2 = New-AzGatewayCustomBgpIpConfigurationObject -IpConfigurationId "Instance1" -CustomBgpIpAddress "169.254.22.3" +``` + +The above will create a IpConfigurationBgpPeeringAddressObject. + +## PARAMETERS + +### -CustomBgpIpAddress +The virtual network gateway CustomBgpIpAddress for BgpPeeringAddresses used in connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfigurationId +The virtual network gateway IpConfigurationId for BgpPeeringAddresses used in connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSGatewayCustomBgpIpConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzIpAllocation.md b/azps-10.1.0/Az.Network/New-AzIpAllocation.md new file mode 100644 index 0000000000..1ce781b08b --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzIpAllocation.md @@ -0,0 +1,286 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azipallocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzIpAllocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzIpAllocation.md +--- + +# New-AzIpAllocation + +## SYNOPSIS +Creates an Azure IpAllocation. + +## SYNTAX + +``` +New-AzIpAllocation -Name <String> -ResourceGroupName <String> -Location <String> -IpAllocationType <String> + [-Prefix <String>] [-PrefixLength <Int32>] [-PrefixType <String>] [-IpamAllocationId <String>] + [-IpAllocationTag <Hashtable>] [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzIpAllocation** cmdlet creates an Azure IpAllocation + +## EXAMPLES + +### Example 1 +```powershell +New-AzIpAllocation -ResourceName 'TestIpAllocation' -ResourceGroupName 'TestResourcegroupName' -Location 'eastus' -IpAllocationType 'Hypernet' -Prefix '1.2.3.4/32' -IpAllocationTag @{"VnetId"="vnet1"} +``` + +### Example 2 +```powershell +New-AzIpAllocation -ResourceName 'TestIpAllocation' -ResourceGroupName 'TestResourcegroupName' -Location 'eastus' -IpAllocationType 'Hypernet' -PrefixLength 32 -PrefixType 'ipv4' -IpAllocationTag @{"VnetId"="vnet1"} +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to override a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAllocationTag +The allocation tags of the IP allocation + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpAllocationType +The type of the IP allocation + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Hypernet, Undefined + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpamAllocationId +The ipam allocation ID of the IP allocation + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Prefix +The prefix of the IP allocation + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrefixLength +The prefix length of the IP allocation + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrefixType +The prefix type of the IP allocation + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPV4, IPV6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIpAllocation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzIpConfigurationBgpPeeringAddressObject.md b/azps-10.1.0/Az.Network/New-AzIpConfigurationBgpPeeringAddressObject.md new file mode 100644 index 0000000000..3547bda217 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzIpConfigurationBgpPeeringAddressObject.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azipconfigurationbgppeeringaddressobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzIpConfigurationBgpPeeringAddressObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzIpConfigurationBgpPeeringAddressObject.md +--- + +# New-AzIpConfigurationBgpPeeringAddressObject + +## SYNOPSIS +creates a new IpconfigurationBgpPeeringAddressObject + +## SYNTAX + +``` +New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId <String> + -CustomAddress <System.Collections.Generic.List`1[System.String]> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzIpConfigurationBgpPeeringAddressObject** creates a IpConfigurationBgpPeeringAddressObject object which represents BgpPeeringAddresses property in your virtual network gateway bgpsettings. + +## EXAMPLES + +### Example 1: Create a AzIpConfigurationBgpPeeringAddressObject +```powershell +$ipconfigurationId1 = '/subscriptions/c886bc58-0000-4e01-993f-e01ba3702aaf/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworkGateways/gw1/ipConfigurations/default' +$addresslist1 = @('169.254.21.5') +$gw1ipconfBgp1 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId1 -CustomAddress $addresslist1 +``` + +The above will create a IpConfigurationBgpPeeringAddressObject.This new object will be to gw1ipconfBgp1. + +## PARAMETERS + +### -CustomAddress +The virtual network gateway CustomAddress List for BgpPeeringAddresses. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfigurationId +The virtual network gateway IpConfigurationId for BgpPeeringAddresses. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIpConfigurationBgpPeeringAddress + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzIpGroup.md b/azps-10.1.0/Az.Network/New-AzIpGroup.md new file mode 100644 index 0000000000..2563b922fa --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzIpGroup.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azipgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzIpGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzIpGroup.md +--- + +# New-AzIpGroup + +## SYNOPSIS +Creates an Azure IpGroup. + +## SYNTAX + +``` +New-AzIpGroup -Name <String> -ResourceGroupName <String> [-IpAddress <String[]>] -Location <String> + [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzIpGroup** cmdlet creates an Azure IpGroup + +## EXAMPLES + +### Example 1 +```powershell +New-AzIpGroup -Name ipGroup -ResourceGroupName ipGroupRG -Location 'West US' +``` + +### Example 2 +```powershell +New-AzIpGroup -Name ipGroup -ResourceGroupName ipGroupRG -Location 'West US' -IpAddress 10.0.0.0/24,11.9.0.0/24 +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddress +IpAddresses defined in the IpGroup + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the ipgroup. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the ipgroup. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIpGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzIpsecPolicy.md b/azps-10.1.0/Az.Network/New-AzIpsecPolicy.md new file mode 100644 index 0000000000..baa4921c7d --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzIpsecPolicy.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azipsecpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzIpsecPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzIpsecPolicy.md +--- + +# New-AzIpsecPolicy + +## SYNOPSIS +Creates an IPSec Policy. + +## SYNTAX + +``` +New-AzIpsecPolicy [-SALifeTimeSeconds <Int32>] [-SADataSizeKilobytes <Int32>] -IpsecEncryption <String> + -IpsecIntegrity <String> -IkeEncryption <String> -IkeIntegrity <String> -DhGroup <String> -PfsGroup <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzIpsecPolicy cmdlet creates an IPSec policy proposal to be used in a virtual network gateway connection. + +## EXAMPLES + +### Example 1 +```powershell +$ipsecPolicy = New-AzIpsecPolicy -SALifeTimeSeconds 1000 -SADataSizeKilobytes 2000 -IpsecEncryption "GCMAES256" -IpsecIntegrity "GCMAES256" -IkeEncryption "AES256" -IkeIntegrity "SHA256" -DhGroup "DHGroup14" -PfsGroup "PFS2048" +New-AzVirtualNetworkGatewayConnection -ResourceGroupName $rgname -name $vnetConnectionName -location $location -VirtualNetworkGateway1 $vnetGateway -LocalNetworkGateway2 $localnetGateway -ConnectionType IPsec -RoutingWeight 3 -SharedKey $sharedKey -UsePolicyBasedTrafficSelectors $true -IpsecPolicies $ipsecPolicy +``` + +Creating an IPSec policy to be used for a new virtual network gateway connection. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DhGroup +The DH Groups used in IKE Phase 1 for initial SA + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IkeEncryption +The IKE encryption algorithm (IKE Phase 1) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: DES, DES3, AES128, AES192, AES256 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IkeIntegrity +The IKE integrity algorithm (IKE Phase 1) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: MD5, SHA1, SHA256, SHA384 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpsecEncryption +The IPSec encryption algorithm (IKE Phase 2) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpsecIntegrity +The IPSec integrity algorithm (IKE Phase 2) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: MD5, SHA1, SHA256, GCMAES128, GCMAES192, GCMAES256 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PfsGroup +The DH Groups used in IKE Phase 2 for new child SA + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, PFS1, PFS2, PFS2048, PFS24, ECP256, ECP384 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SADataSizeKilobytes +The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SALifeTimeSeconds +The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzIpsecTrafficSelectorPolicy.md b/azps-10.1.0/Az.Network/New-AzIpsecTrafficSelectorPolicy.md new file mode 100644 index 0000000000..7f411e422e --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzIpsecTrafficSelectorPolicy.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azipsectrafficselectorpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzIpsecTrafficSelectorPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzIpsecTrafficSelectorPolicy.md +--- + +# New-AzIpsecTrafficSelectorPolicy + +## SYNOPSIS +Creates a traffic selector policy. + +## SYNTAX + +``` +New-AzIpsecTrafficSelectorPolicy -LocalAddressRange <String[]> -RemoteAddressRange <String[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzTrafficSelectorPolicy cmdlet creates a traffic selector policy proposal to be used in a virtual network gateway connection. + +## EXAMPLES + +### Example 1 +```powershell +$trafficSelectorPolicy = New-AzIpsecTrafficSelectorPolicy -LocalAddressRange ("10.10.10.0/24", "20.20.20.0/24") -RemoteAddressRange ("30.30.30.0/24", "40.40.40.0/24") +New-AzVirtualNetworkGatewayConnection -ResourceGroupName $rgname -name $vnetConnectionName -location $location -VirtualNetworkGateway1 $vnetGateway -LocalNetworkGateway2 $localnetGateway -ConnectionType IPsec -RoutingWeight 3 -SharedKey $sharedKey -UsePolicyBasedTrafficSelectors $true -TrafficSelectorPolicy ($trafficSelectorPolicy) +``` + +Creates an instance of a traffic selector policy and adds it as a parameter when creating a virtual network gateway connection with an IKEv2 protocol. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalAddressRange +A collection of CIDR address ranges + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RemoteAddressRange +A collection of CIDR address ranges + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSTrafficSelectorPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzLoadBalancer.md b/azps-10.1.0/Az.Network/New-AzLoadBalancer.md new file mode 100644 index 0000000000..8f88ad9983 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzLoadBalancer.md @@ -0,0 +1,397 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: F1522074-7EEA-4DCF-AC16-26FE8E654720 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azloadbalancer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancer.md +--- + +# New-AzLoadBalancer + +## SYNOPSIS +Creates a load balancer. + +## SYNTAX + +``` +New-AzLoadBalancer -ResourceGroupName <String> -Name <String> -Location <String> [-Tag <Hashtable>] + [-Sku <String>] [-Tier <String>] [-FrontendIpConfiguration <PSFrontendIPConfiguration[]>] + [-BackendAddressPool <PSBackendAddressPool[]>] [-LoadBalancingRule <PSLoadBalancingRule[]>] + [-Probe <PSProbe[]>] [-InboundNatRule <PSInboundNatRule[]>] [-InboundNatPool <PSInboundNatPool[]>] + [-OutboundRule <PSOutboundRule[]>] [-EdgeZone <String>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzLoadBalancer** cmdlet creates an Azure load balancer. + +## EXAMPLES + +### Example 1: Create a load balancer +```powershell +$publicip = New-AzPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIp" -Location "West US" -AllocationMethod "Dynamic" +$frontend = New-AzLoadBalancerFrontendIpConfig -Name "MyFrontEnd" -PublicIpAddress $publicip +$backendAddressPool = New-AzLoadBalancerBackendAddressPoolConfig -Name "MyBackendAddPoolConfig02" +$probe = New-AzLoadBalancerProbeConfig -Name "MyProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -ProbeThreshold 2 -RequestPath "healthcheck.aspx" +$inboundNatRule1 = New-AzLoadBalancerInboundNatRuleConfig -Name "MyinboundNatRule1" -FrontendIPConfiguration $frontend -Protocol "Tcp" -FrontendPort 3389 -BackendPort 3389 -IdleTimeoutInMinutes 15 -EnableFloatingIP +$inboundNatRule2 = New-AzLoadBalancerInboundNatRuleConfig -Name "MyinboundNatRule2" -FrontendIPConfiguration $frontend -Protocol "Tcp" -FrontendPort 3391 -BackendPort 3392 +$lbrule = New-AzLoadBalancerRuleConfig -Name "MyLBruleName" -FrontendIPConfiguration $frontend -BackendAddressPool $backendAddressPool -Probe $probe -Protocol "Tcp" -FrontendPort 80 -BackendPort 80 -IdleTimeoutInMinutes 15 -EnableFloatingIP -LoadDistribution SourceIP +$lb = New-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -Location "West US" -FrontendIpConfiguration $frontend -BackendAddressPool $backendAddressPool -Probe $probe -InboundNatRule $inboundNatRule1,$inboundNatRule2 -LoadBalancingRule $lbrule +Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +``` + +Deploying a load balancer requires that you first create several objects, and the first seven +commands show how to create those objects. +The eighth command creates a load balancer named MyLoadBalancer in the resource group named +MyResourceGroup. +The ninth and last command gets the new load balancer to ensure it was successfully created. +Note that this example only shows how to create a load balancer. You must also configure it using +the Add-AzNetworkInterfaceIpConfig cmdlet to assign the NICs to different virtual machines. + +### Example 2: Create a global load balancer +```powershell +$publicip = New-AzPublicIpAddress -ResourceGroupName "MyResourceGroup" -name "MyPublicIp" -Location "West US" -AllocationMethod Static -DomainNameLabel $domainNameLabel -Sku Standard -Tier Global +$frontend = New-AzLoadBalancerFrontendIpConfig -Name $frontendName -PublicIpAddress $publicip +$backendAddressPool = New-AzLoadBalancerBackendAddressPoolConfig -Name "MyBackendAddPoolConfig01" +$probe = New-AzLoadBalancerProbeConfig -Name "MyProbe" -RequestPath healthcheck.aspx -Protocol http -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -ProbeThreshold 2 +$lbrule = New-AzLoadBalancerRuleConfig -Name "MyLBruleName" -FrontendIPConfiguration $frontend -BackendAddressPool $backendAddressPool -Probe $probe -Protocol Tcp -FrontendPort 80 -BackendPort 80 -IdleTimeoutInMinutes 15 -EnableFloatingIP -LoadDistribution SourceIP -DisableOutboundSNAT +$lb = New-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -Location "West US" -FrontendIpConfiguration $frontend -BackendAddressPool $backendAddressPool -Probe $probe -LoadBalancingRule $lbrule -Sku Standard -Tier Global +Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +``` + +Deploying a global load balancer requires that you first create several objects, and the first five +commands show how to create those objects. +The sixth command creates a load balancer named MyLoadBalancer in the resource group named +MyResourceGroup. +The seventh and last command gets the new load balancer to ensure it was successfully created. +Note that this example only shows how to create a global load balancer. You must also configure it using +the New-AzLoadBalancerBackendAddressConfig cmdlet to assign regional load balancer frontend ipconfig ids to +its backend address pool + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendAddressPool +Specifies a backend address pool to associate with a load balancer. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +The edge zone of the load balancer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet creates a load balancer even if a load balancer with the same name already exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIpConfiguration +Specifies a list of front-end IP addresses to associate with a load balancer. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InboundNatPool +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSInboundNatPool[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InboundNatRule +Specifies a list of inbound network address translation (NAT) rules to associate with a load balancer. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSInboundNatRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancingRule +Specifies a list of load balancing rules to associate with a load balancer. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancingRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the region in which to create a load balancer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the load balancer that this creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OutboundRule +The outbound rules. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSOutboundRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Probe +Specifies a list of probes to associate with a load balancer. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSProbe[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group in which to create a load balancer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +The load balancer Sku name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tier +The load balancer Sku Tier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration[] + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool[] + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancingRule[] + +### Microsoft.Azure.Commands.Network.Models.PSProbe[] + +### Microsoft.Azure.Commands.Network.Models.PSInboundNatRule[] + +### Microsoft.Azure.Commands.Network.Models.PSInboundNatPool[] + +### Microsoft.Azure.Commands.Network.Models.PSOutboundRule[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzNetworkInterfaceIpConfig](./Add-AzNetworkInterfaceIpConfig.md) + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[Remove-AzLoadBalancer](./Remove-AzLoadBalancer.md) + +[Set-AzLoadBalancer](./Set-AzLoadBalancer.md) diff --git a/azps-10.1.0/Az.Network/New-AzLoadBalancerBackendAddressConfig.md b/azps-10.1.0/Az.Network/New-AzLoadBalancerBackendAddressConfig.md new file mode 100644 index 0000000000..b326bf3d7e --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzLoadBalancerBackendAddressConfig.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azloadbalancerbackendaddressconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerBackendAddressConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerBackendAddressConfig.md +--- + +# New-AzLoadBalancerBackendAddressConfig + +## SYNOPSIS +Returns a load balancer backend address config. + +## SYNTAX + +### SetByIpAndSubnet (Default) +``` +New-AzLoadBalancerBackendAddressConfig -IpAddress <String> -Name <String> -SubnetId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByIpAndVnet +``` +New-AzLoadBalancerBackendAddressConfig -IpAddress <String> -Name <String> -VirtualNetworkId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceFrontendIPConfiguration +``` +New-AzLoadBalancerBackendAddressConfig -Name <String> -LoadBalancerFrontendIPConfigurationId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Returns a load balancer backend address config. + +## EXAMPLES + +### Example 1: New loadbalancer address config with virtual network reference +```powershell +$virtualNetwork = Get-AzVirtualNetwork -Name $vnetName -ResourceGroupName $resourceGroup +New-AzLoadBalancerBackendAddressConfig -IpAddress "10.0.0.5" -Name "TestVNetRef" -VirtualNetworkId $virtualNetwork.Id +``` + +### Example 2: New loadbalancer address config with subnet reference +```powershell +$virtualNetwork = Get-AzVirtualNetwork -Name $vnetName -ResourceGroupName $resourceGroup +$subnet = Get-AzVirtualNetworkSubnetConfig -Name $subnetName -VirtualNetwork $virtualNetwork +New-AzLoadBalancerBackendAddressConfig -IpAddress "10.0.0.5" -Name "TestVNetRef" -SubnetId $subnet.Id +``` + +### Example 3: New loadbalancer address config with loadbalancer frontend ip configuration reference +```powershell +$frontend = New-AzLoadBalancerFrontendIpConfig -Name $frontendName -PublicIpAddress $publicip +New-AzLoadBalancerBackendAddressConfig -LoadBalancerFrontendIPConfigurationId $frontend.Id -Name "TestLBFERef" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddress +The IPAddress to add to the backend pool + +```yaml +Type: System.String +Parameter Sets: SetByIpAndSubnet, SetByIpAndVnet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerFrontendIPConfigurationId +The load balancer frontend ip configuration associated with Backend Address config + +```yaml +Type: System.String +Parameter Sets: SetByResourceFrontendIPConfiguration +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the Backend Address config + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubnetId +The subnet associated with the Backend Address config + +```yaml +Type: System.String +Parameter Sets: SetByIpAndSubnet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkId +The virtual network associated with Backend Address config + +```yaml +Type: System.String +Parameter Sets: SetByIpAndVnet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancerBackendAddress + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzLoadBalancerBackendAddressPool.md b/azps-10.1.0/Az.Network/New-AzLoadBalancerBackendAddressPool.md new file mode 100644 index 0000000000..e5ad8456f0 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzLoadBalancerBackendAddressPool.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azloadbalancerbackendaddresspool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerBackendAddressPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerBackendAddressPool.md +--- + +# New-AzLoadBalancerBackendAddressPool + +## SYNOPSIS +Creates a backend address pool on a loadbalancer. + +## SYNTAX + +### CreateByNameParameterSet (Default) +``` +New-AzLoadBalancerBackendAddressPool -ResourceGroupName <String> -LoadBalancerName <String> -Name <String> + [-TunnelInterface <PSTunnelInterface[]>] [-LoadBalancerBackendAddress <PSLoadBalancerBackendAddress[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByParentObjectParameterSet +``` +New-AzLoadBalancerBackendAddressPool -LoadBalancer <PSLoadBalancer> -Name <String> + [-TunnelInterface <PSTunnelInterface[]>] [-LoadBalancerBackendAddress <PSLoadBalancerBackendAddress[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a backend address pool on a loadbalancer. Allows for specifiying a array of PSLoadBalancerBackendAddress. + +## EXAMPLES + +### Example 1 +```powershell +## create by passing loadbalancer without Ips +$virtualNetwork = Get-AzVirtualNetwork -Name $vnetName -ResourceGroupName $resourceGroup +$lb = Get-AzLoadBalancer -ResourceGroupName $resourceGroup -Name $loadBalancerName +$ip1 = New-AzLoadBalancerBackendAddressConfig -IpAddress "10.0.0.5" -Name "TestVNetRef" -VirtualNetworkId $virtualNetwork.Id +$ip2 = New-AzLoadBalancerBackendAddressConfig -IpAddress "10.0.0.6" -Name "TestVNetRef2" -VirtualNetworkId $virtualNetwork.Id +$ips = @($ip1, $ip2) + +$lb | New-AzLoadBalancerBackendAddressPool -Name $backendPool1 +``` + +### Example 2 +```powershell +## create by passing loadbalancer with ips +$lb | New-AzLoadBalancerBackendAddressPool -Name $backendPool7 -LoadBalancerBackendAddress $ips +``` + +### Example 3 +```powershell +## create by name without ips +New-AzLoadBalancerBackendAddressPool -ResourceGroupName $resourceGroup -LoadBalancerName $loadBalancerName -Name $backendPool3 +``` + +### Example 4 +```powershell +## create by name with ips +New-AzLoadBalancerBackendAddressPool -ResourceGroupName $resourceGroup -LoadBalancerName $loadBalancerName -Name $backendPool3 -LoadBalancerBackendAddress $ips +``` + +### Example 5: Create a backend address pool configuration with tunnel interface for a load balancer +```powershell +## create with Gateway LoadBalancer TunnelInterface configuration +$tunnelInterface1 = New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig -Protocol 'Vxlan' -Type 'Internal' -Port 2000 -Identifier 800 +$tunnelInterface2 = New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig -Protocol 'Vxlan' -Type 'External' -Port 2001 -Identifier 801 +New-AzLoadBalancerBackendAddressPool -ResourceGroupName $resourceGroup -LoadBalancerName $loadBalancerName -Name $backendPool3 -TunnelInterface $tunnelInterface1, $tunnelInterface2 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +The load balancer resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: CreateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LoadBalancerBackendAddress +The backend addresses. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancerBackendAddress[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerName +The name of the load balancer. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the backend pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the load balancer. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TunnelInterface +Gateway Load Balancer provider configurations. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSTunnelInterface[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzLoadBalancerBackendAddressPoolConfig.md b/azps-10.1.0/Az.Network/New-AzLoadBalancerBackendAddressPoolConfig.md new file mode 100644 index 0000000000..1741a5d868 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzLoadBalancerBackendAddressPoolConfig.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 67AD15B0-94EB-486F-8C17-606EA5F702D3 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azloadbalancerbackendaddresspoolconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerBackendAddressPoolConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerBackendAddressPoolConfig.md +--- + +# New-AzLoadBalancerBackendAddressPoolConfig + +## SYNOPSIS +Creates a backend address pool configuration for a load balancer. + +## SYNTAX + +``` +New-AzLoadBalancerBackendAddressPoolConfig -Name <String> [-TunnelInterface <PSTunnelInterface[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzLoadBalancerBackendAddressPoolConfig** cmdlet creates a backend address pool configuration for an Azure load balancer. + +## EXAMPLES + +### Example 1: Create a backend address pool configuration for a load balancer +```powershell +New-AzLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool02" +``` + +This command creates a backend address pool configuration named BackendAddressPool02 for a load balancer. + +### Example 2: Create a backend address pool configuration with tunnel interface for a load balancer +```powershell +## create with Gateway LoadBalancer TunnelInterface configuration +$tunnelInterface1 = New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig -Protocol 'Vxlan' -Type 'Internal' -Port 2000 -Identifier 800 +$tunnelInterface2 = New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig -Protocol 'Vxlan' -Type 'External' -Port 2001 -Identifier 801 +New-AzLoadBalancerBackendAddressPool -ResourceGroupName $resourceGroup -LoadBalancerName $loadBalancerName -Name $backendPool3 -TunnelInterface $tunnelInterface1, $tunnelInterface2 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the address pool configuration to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TunnelInterface +The configuration of Gateway LoadBalancer Provider. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSTunnelInterface[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerBackendAddressPoolConfig](./Add-AzLoadBalancerBackendAddressPoolConfig.md) + +[Get-AzLoadBalancerBackendAddressPoolConfig](./Get-AzLoadBalancerBackendAddressPoolConfig.md) + +[Remove-AzLoadBalancerBackendAddressPoolConfig](./Remove-AzLoadBalancerBackendAddressPoolConfig.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig.md b/azps-10.1.0/Az.Network/New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig.md new file mode 100644 index 0000000000..2c77f93da3 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig.md +--- + +# New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig + +## SYNOPSIS +Creates a tunnel interface in a backend address pool of a load balancer. + +## SYNTAX + +``` +New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig -Protocol <String> -Type <String> -Identifier <Int32> + -Port <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a tunnel interface in a backend address pool of a load balancer. This is used for Gateway Load Balancer + +## EXAMPLES + +### Example 1: Add a tunnel interface to a backend address pool configuration to a load balancer +```powershell +## Get loadbalancer +$lb = Get-AzLoadBalancer -ResourceGroupName $resourceGroup -Name $loadBalancerName + +## Create tunnel interface to backend address pool +$tunnelInterface1 = New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig -Protocol Vxlan -Type Internal -Port 2000 -Identifier 800 +$tunnelInterface2 = New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig -Protocol Vxlan -Type External -Port 2001 -Identifier 801 + +## Set backend address pool +$pool = Set-AzLoadBalancerBackendAddressPool -Name "BackendAddressPool02" -TunnelInterface $tunnelInterface1, $tunnelInterface2 +``` + +If the properties are not provided then they will be replaced with default values. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identifier +Specifies the identifier of tunnel interface. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Specifies the port of tunnel interface. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol of tunnel interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specifies the type of tunnel interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSTunnelInterface + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerBackendAddressPoolConfig](./Add-AzLoadBalancerBackendAddressPoolConfig.md) + +[Get-AzLoadBalancerBackendAddressPoolConfig](./Get-AzLoadBalancerBackendAddressPoolConfig.md) + +[Remove-AzLoadBalancerBackendAddressPoolConfig](./Remove-AzLoadBalancerBackendAddressPoolConfig.md) diff --git a/azps-10.1.0/Az.Network/New-AzLoadBalancerFrontendIpConfig.md b/azps-10.1.0/Az.Network/New-AzLoadBalancerFrontendIpConfig.md new file mode 100644 index 0000000000..38d0cb8dd4 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzLoadBalancerFrontendIpConfig.md @@ -0,0 +1,309 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: D639E4F5-5AAD-4F13-9B48-70E90D2DFFCA +online version: https://learn.microsoft.com/powershell/module/az.network/new-azloadbalancerfrontendipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerFrontendIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerFrontendIpConfig.md +--- + +# New-AzLoadBalancerFrontendIpConfig + +## SYNOPSIS +Creates a front-end IP configuration for a load balancer. + +## SYNTAX + +### SetByResourceSubnet (Default) +``` +New-AzLoadBalancerFrontendIpConfig -Name <String> [-PrivateIpAddress <String>] + [-PrivateIpAddressVersion <String>] [-Zone <String[]>] -Subnet <PSSubnet> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdSubnet +``` +New-AzLoadBalancerFrontendIpConfig -Name <String> [-PrivateIpAddress <String>] + [-PrivateIpAddressVersion <String>] [-Zone <String[]>] -SubnetId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdPublicIpAddress +``` +New-AzLoadBalancerFrontendIpConfig -Name <String> [-Zone <String[]>] -PublicIpAddressId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourcePublicIpAddress +``` +New-AzLoadBalancerFrontendIpConfig -Name <String> [-Zone <String[]>] -PublicIpAddress <PSPublicIpAddress> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdPublicIpAddressPrefix +``` +New-AzLoadBalancerFrontendIpConfig -Name <String> [-Zone <String[]>] -PublicIpAddressPrefixId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourcePublicIpAddressPrefix +``` +New-AzLoadBalancerFrontendIpConfig -Name <String> [-Zone <String[]>] -PublicIpAddressPrefix <PSPublicIpPrefix> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzLoadBalancerFrontendIpConfig** cmdlet creates a front-end IP configuration for an Azure load balancer. + +## EXAMPLES + +### Example 1: Create a front-end IP configuration for a load balancer +```powershell +$publicip = New-AzPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIP" -Location "West US" -AllocationMethod "Dynamic" +New-AzLoadBalancerFrontendIpConfig -Name "FrontendIpConfig01" -PublicIpAddress $publicip +``` + +The first command creates a dynamic public IP address named MyPublicIP in the resource group named MyResourceGroup, and then stores it in the $publicip variable. +The second command creates a front-end IP configuration named FrontendIpConfig01 using the public IP address in $publicip. + +### Example 2: Create a front-end IP configuration for a load balancer using ip prefix +```powershell +$publicipprefix = New-AzPublicIpPrefix -ResourceGroupName "MyResourceGroup" -name "MyPublicIPPrefix" -location "West US" -Sku Standard -PrefixLength 28 +$frontend = New-AzLoadBalancerFrontendIpConfig -Name "FrontendIpConfig01" -PublicIpAddressPrefix $publicipprefix +``` + +The first command creates a public ip prefix named MyPublicIP of length 28 in the resource group named MyResourceGroup, and then stores it in the $publicipprefix variable. +The second command creates a front-end IP configuration named FrontendIpConfig01 using the public IP prefix in $publicipprefix. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the front-end IP configuration that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddress +Specifies the private IP address of the load balancer. +Specify this parameter only if you also specify the *Subnet* parameter. + +```yaml +Type: System.String +Parameter Sets: SetByResourceSubnet, SetByResourceIdSubnet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateIpAddressVersion +The private IP address version of the IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceSubnet, SetByResourceIdSubnet +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddress +Specifies the **PublicIpAddress** object to associate with a front-end IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: SetByResourcePublicIpAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddressId +Specifies the ID of the **PublicIpAddress** object to associate with a front-end IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdPublicIpAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddressPrefix +Specifies the **PublicIpAddressPrefix** object to associate with a front-end IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix +Parameter Sets: SetByResourcePublicIpAddressPrefix +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PublicIpAddressPrefixId +Specifies the ID of the **PublicIpAddressPrefix** object to associate with a front-end IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdPublicIpAddressPrefix +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Subnet +Specifies the **Subnet** object in which to create a front-end IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResourceSubnet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubnetId +Specifies the ID of the subnet in which to create a front-end IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdSubnet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +A list of availability zones denoting the IP allocated for the resource needs to come from. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### Microsoft.Azure.Commands.Network.Models.PSSubnet + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerFrontendIpConfig](./Add-AzLoadBalancerFrontendIpConfig.md) + +[Get-AzLoadBalancerFrontendIpConfig](./Get-AzLoadBalancerFrontendIpConfig.md) + +[New-AzPublicIpAddress](./New-AzPublicIpAddress.md) + +[Remove-AzLoadBalancerFrontendIpConfig](./Remove-AzLoadBalancerFrontendIpConfig.md) + +[Set-AzLoadBalancerFrontendIpConfig](./Set-AzLoadBalancerFrontendIpConfig.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzLoadBalancerInboundNatPoolConfig.md b/azps-10.1.0/Az.Network/New-AzLoadBalancerInboundNatPoolConfig.md new file mode 100644 index 0000000000..7b74db3ca5 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzLoadBalancerInboundNatPoolConfig.md @@ -0,0 +1,254 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 61C34433-A16A-4ACF-A318-1C7D9E49579F +online version: https://learn.microsoft.com/powershell/module/az.network/new-azloadbalancerinboundnatpoolconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerInboundNatPoolConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerInboundNatPoolConfig.md +--- + +# New-AzLoadBalancerInboundNatPoolConfig + +## SYNOPSIS +Creates an inbound NAT pool configuration for a load balancer. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzLoadBalancerInboundNatPoolConfig -Name <String> -Protocol <String> -FrontendPortRangeStart <Int32> + -FrontendPortRangeEnd <Int32> -BackendPort <Int32> [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] + [-EnableTcpReset] [-FrontendIpConfiguration <PSFrontendIPConfiguration>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzLoadBalancerInboundNatPoolConfig -Name <String> -Protocol <String> -FrontendPortRangeStart <Int32> + -FrontendPortRangeEnd <Int32> -BackendPort <Int32> [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] + [-EnableTcpReset] [-FrontendIpConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzLoadBalancerInboundNatPoolConfig** cmdlet creates an inbound NAT pool configuration for a load balancer. + +## EXAMPLES + +### Example 1: New +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$feIpConfig = Get-AzLoadBalancerFrontendIpConfig -Name "FrontendName" -Loadbalancer $slb +New-AzLoadBalancerInboundNatPoolConfig -Name "myInboundNatPool" -FrontendIpConfigurationId $feIpConfig.Id -Protocol TCP -FrontendPortRangeStart 1001 -FrontendPortRangeEnd 2000 -BackendPort 1001 +``` + +## PARAMETERS + +### -BackendPort +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFloatingIP +Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTcpReset +Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIpConfiguration +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendIpConfigurationId +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPortRangeEnd +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPortRangeStart +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSInboundNatPool + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerInboundNatPoolConfig](./Add-AzLoadBalancerInboundNatPoolConfig.md) + +[Get-AzLoadBalancerInboundNatPoolConfig](./Get-AzLoadBalancerInboundNatPoolConfig.md) + +[Remove-AzLoadBalancerInboundNatPoolConfig](./Remove-AzLoadBalancerInboundNatPoolConfig.md) + +[Set-AzLoadBalancerInboundNatPoolConfig](./Set-AzLoadBalancerInboundNatPoolConfig.md) diff --git a/azps-10.1.0/Az.Network/New-AzLoadBalancerInboundNatRuleConfig.md b/azps-10.1.0/Az.Network/New-AzLoadBalancerInboundNatRuleConfig.md new file mode 100644 index 0000000000..e6b3caa743 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzLoadBalancerInboundNatRuleConfig.md @@ -0,0 +1,341 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 4AA587F8-4967-439D-84B6-EDC24235D3F5 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azloadbalancerinboundnatruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerInboundNatRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerInboundNatRuleConfig.md +--- + +# New-AzLoadBalancerInboundNatRuleConfig + +## SYNOPSIS +Creates an inbound NAT rule configuration for a load balancer. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzLoadBalancerInboundNatRuleConfig -Name <String> [-Protocol <String>] [-FrontendPort <Int32>] + [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-EnableTcpReset] + [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-FrontendPortRangeStart <Int32>] + [-FrontendPortRangeEnd <Int32>] [-BackendAddressPool <PSBackendAddressPool>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzLoadBalancerInboundNatRuleConfig -Name <String> [-Protocol <String>] [-FrontendPort <Int32>] + [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-EnableTcpReset] + [-FrontendIpConfigurationId <String>] [-FrontendPortRangeStart <Int32>] [-FrontendPortRangeEnd <Int32>] + [-BackendAddressPoolId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzLoadBalancerInboundNatRuleConfig** cmdlet creates an inbound network address translation (NAT) rule configuration for an Azure load balancer. + +## EXAMPLES + +### Example 1: Create an inbound NAT rule configuration for a load balancer +```powershell +$publicip = New-AzPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIP" -Location "West US" -AllocationMethod "Dynamic" +$frontend = New-AzLoadBalancerFrontendIpConfig -Name "FrontendIpConfig01" -PublicIpAddress $publicip +New-AzLoadBalancerInboundNatRuleConfig -Name "MyInboundNatRule" -FrontendIPConfiguration $frontend -Protocol "Tcp" -FrontendPort 3389 -BackendPort 3389 +``` + +The first command creates a public IP address named MyPublicIP in the resource group named MyResourceGroup, and then stores it in the $publicip variable. +The second command creates a front-end IP configuration named FrontendIpConfig01 using the public IP address in $publicip, and then stores it in the $frontend variable. +The third command creates an inbound NAT rule configuration named MyInboundNatRule using the front-end object in $frontend. +The TCP protocol is specified and the front-end port is 3389, the same as the backend port in this case. +The *FrontendIpConfiguration*, *Protocol*, *FrontendPort*, and *BackendPort* parameters are all required to create an inbound NAT rule configuration. + +### Example 2: Create an inbound NAT rule V2 configuration for a load balancer +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$natRuleV2 = New-AzLoadBalancerInboundNatRuleConfig -Name natRuleV2 -Protocol "Tcp" -FrontendIpConfiguration $slb.FrontendIpConfigurations[0] -FrontendPortRangeStart 3390 -FrontendPortRangeEnd 4001 -BackendAddressPool $slb.BackendAddressPools[0] -IdleTimeoutInMinutes 4 -BackendPort 3389 +``` + +The first command gets the load balancer named MyloadBalancer, and then stores it in the variable $slb. +The second command creates an inbound NAT rule configuration named natRuleV2.The *FrontendIpConfiguration*, *BackendAddressPool*, *Protocol*, *FrontendPortRangeStart*, *FrontendPortRangeEnd* and *BackendPort* parameters are all required to create an inbound NAT rule V2 configuration. + +## PARAMETERS + +### -BackendAddressPool +Specifies the backend address pool to associate with an inbound NAT rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +Specifies the ID of a BackendAddressPool object to associate with an inbound NAT rule configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendPort +Specifies the backend port for traffic that is matched by this rule configuration. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFloatingIP +Indicates that this cmdlet enables a floating IP address for a rule configuration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTcpReset +Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIpConfiguration +Specifies a list of front-end IP addresses to associate with a load balancer rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendIpConfigurationId +Specifies the ID for a front-end IP address configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPort +Specifies the front-end port that is matched by a load balancer rule configuration. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPortRangeEnd +Specifies the last port number in the range of external ports that is used by a rule configuration. Acceptable values range between 1 and 65535. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPortRangeStart +Specifies the first port number in the range of external ports that is used by a rule configuration. Acceptable values range between 1 and 65534. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +Specifies the length of time, in minutes, for which the state of conversations is maintained in a load balancer. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the rule configuration that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies a protocol. +The acceptable values for this parameter are: +- Tcp +- Udp + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSInboundNatRule + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerInboundNatRuleConfig](./Add-AzLoadBalancerInboundNatRuleConfig.md) + +[Get-AzLoadBalancerInboundNatRuleConfig](./Get-AzLoadBalancerInboundNatRuleConfig.md) + +[New-AzLoadBalancerFrontendIpConfig](./New-AzLoadBalancerFrontendIpConfig.md) + +[New-AzPublicIpAddress](./New-AzPublicIpAddress.md) + +[Remove-AzLoadBalancerInboundNatRuleConfig](./Remove-AzLoadBalancerInboundNatRuleConfig.md) + +[Set-AzLoadBalancerInboundNatRuleConfig](./Set-AzLoadBalancerInboundNatRuleConfig.md) diff --git a/azps-10.1.0/Az.Network/New-AzLoadBalancerOutboundRuleConfig.md b/azps-10.1.0/Az.Network/New-AzLoadBalancerOutboundRuleConfig.md new file mode 100644 index 0000000000..7a8e1d56ad --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzLoadBalancerOutboundRuleConfig.md @@ -0,0 +1,261 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azloadbalanceroutboundruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerOutboundRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerOutboundRuleConfig.md +--- + +# New-AzLoadBalancerOutboundRuleConfig + +## SYNOPSIS +Creates an outbound rule configuration for a load balancer. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzLoadBalancerOutboundRuleConfig -Name <String> [-AllocatedOutboundPort <Int32>] -Protocol <String> + [-EnableTcpReset] [-IdleTimeoutInMinutes <Int32>] -FrontendIpConfiguration <PSResourceId[]> + -BackendAddressPool <PSBackendAddressPool> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzLoadBalancerOutboundRuleConfig -Name <String> [-AllocatedOutboundPort <Int32>] -Protocol <String> + [-EnableTcpReset] [-IdleTimeoutInMinutes <Int32>] -FrontendIpConfiguration <PSResourceId[]> + -BackendAddressPoolId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzLoadBalancerOutboundRuleConfig** cmdlet creates an outbound rule configuration for an Azure load balancer. + +## EXAMPLES + +### Example 1: Create an outbound rule configuration for a load balancer +```powershell +$publicip = New-AzPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIP" -Location "West US" -AllocationMethod "Dynamic" -Sku "Standard" +$frontend = New-AzLoadBalancerFrontendIpConfig -Name "FrontendIpConfig01" -PublicIpAddress $publicip +$backend = New-AzLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool01" +New-AzLoadBalancerOutboundRuleConfig -Name "MyOutboundRule" -Protocol "Tcp" -FrontendIPConfiguration $frontend -BackendAddressPool $backend +``` + +The first command creates a public IP address named MyPublicIP in the resource group named MyResourceGroup, and then stores it in the $publicip variable. +The second command creates a front-end IP configuration named FrontendIpConfig01 using the public IP address in $publicip, and then stores it in the $frontend variable. +The third command creates a back-end address pool configuration named BackendAddressPool01, and then stores it in the $backend variable. +The fourth command creates an outbound rule configuration named MyOutboundRule using the front-end and back-end objects in $frontend and $backend. +The *Protocol*, *FrontendIPConfiguration*, and *BackendAddressPool* parameters are all required to create an outbound rule configuration. + +### Example 2 + +Creates an outbound rule configuration for a load balancer. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzLoadBalancerOutboundRuleConfig -BackendAddressPool <PSBackendAddressPool> -EnableTcpReset -FrontendIpConfiguration <PSResourceId[]> -Name 'MyOutboundRule' -Protocol 'Tcp' +``` + +## PARAMETERS + +### -AllocatedOutboundPort +The number of outbound ports to be used for NAT. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendAddressPool +A reference to a pool of DIPs. +Outbound traffic is randomly load balanced across IPs in the backend IPs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +A reference to a pool of DIPs. +Outbound traffic is randomly load balanced across IPs in the backend IPs. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTcpReset +Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. +This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIpConfiguration +The Frontend IP addresses of the load balancer. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSResourceId[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +The timeout for the TCP idle connection + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the outbound rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol - TCP, UDP or All + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSResourceId[] + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSOutboundRule + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerOutboundRuleConfig](./Add-AzLoadBalancerOutboundRuleConfig.md) + +[Get-AzLoadBalancerOutboundRuleConfig](./Get-AzLoadBalancerOutboundRuleConfig.md) + +[Remove-AzLoadBalancerOutboundRuleConfig](./Remove-AzLoadBalancerOutboundRuleConfig.md) + +[Set-AzLoadBalancerOutboundRuleConfig](./Set-AzLoadBalancerOutboundRuleConfig.md) diff --git a/azps-10.1.0/Az.Network/New-AzLoadBalancerProbeConfig.md b/azps-10.1.0/Az.Network/New-AzLoadBalancerProbeConfig.md new file mode 100644 index 0000000000..06c493ca4d --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzLoadBalancerProbeConfig.md @@ -0,0 +1,226 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 2049CB74-E3CB-4294-B97C-B41E91209A1E +online version: https://learn.microsoft.com/powershell/module/az.network/new-azloadbalancerprobeconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerProbeConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerProbeConfig.md +--- + +# New-AzLoadBalancerProbeConfig + +## SYNOPSIS +Creates a probe configuration for a load balancer. + +## SYNTAX + +``` +New-AzLoadBalancerProbeConfig -Name <String> [-Protocol <String>] -Port <Int32> -IntervalInSeconds <Int32> + -ProbeCount <Int32> [-ProbeThreshold <Int32>] [-RequestPath <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzLoadBalancerProbeConfig** cmdlet creates a probe configuration for an Azure load balancer. + +## EXAMPLES + +### Example 1: Create a probe configuration +```powershell +New-AzLoadBalancerProbeConfig -Name "MyProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 15 -ProbeThreshold 15 +``` + +This command creates a probe configuration named MyProbe using the HTTP protocol. +The new probe will connect to a load-balanced service on port 80. + +### Example 2 + +Creates a probe configuration for a load balancer. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzLoadBalancerProbeConfig -IntervalInSeconds 15 -Name 'MyProbe' -Port 80 -ProbeCount 15 -ProbeThreshold 15 -Protocol 'http' -RequestPath 'healthcheck.aspx' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntervalInSeconds +Specifies the interval, in seconds, between probes to each instance of a load-balanced service. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the probe configuration to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Specifies the port on which the new probe should connect to a load-balanced service. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProbeCount +Specifies the number of per-instance consecutive failures for an instance to be considered unhealthy. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProbeThreshold +Specifies the number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol to use for the probe configuration. +The acceptable values for this parameter are: Tcp or Http. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RequestPath +Specifies the path in a load-balanced service to probe to determine health. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSProbe + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerProbeConfig](./Add-AzLoadBalancerProbeConfig.md) + +[Get-AzLoadBalancerProbeConfig](./Get-AzLoadBalancerProbeConfig.md) + +[Remove-AzLoadBalancerProbeConfig](./Remove-AzLoadBalancerProbeConfig.md) + +[Set-AzLoadBalancerProbeConfig](./Set-AzLoadBalancerProbeConfig.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzLoadBalancerRuleConfig.md b/azps-10.1.0/Az.Network/New-AzLoadBalancerRuleConfig.md new file mode 100644 index 0000000000..21d0f890cd --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzLoadBalancerRuleConfig.md @@ -0,0 +1,374 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: FD84D530-491B-4075-A6B4-2E1C46AD92D4 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azloadbalancerruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLoadBalancerRuleConfig.md +--- + +# New-AzLoadBalancerRuleConfig + +## SYNOPSIS +Creates a rule configuration for a load balancer. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzLoadBalancerRuleConfig -Name <String> [-Protocol <String>] [-LoadDistribution <String>] + [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] + [-EnableTcpReset] [-DisableOutboundSNAT] [-FrontendIpConfiguration <PSFrontendIPConfiguration>] + [-BackendAddressPool <PSBackendAddressPool[]>] [-Probe <PSProbe>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzLoadBalancerRuleConfig -Name <String> [-Protocol <String>] [-LoadDistribution <String>] + [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] + [-EnableTcpReset] [-DisableOutboundSNAT] [-FrontendIpConfigurationId <String>] + [-BackendAddressPoolId <String[]>] [-ProbeId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzLoadBalancerRuleConfig** cmdlet creates a rule configuration for an Azure load balancer. + +## EXAMPLES + +### Example 1: Creating a rule configuration for an Azure Load Balancer +```powershell +$publicip = New-AzPublicIpAddress -ResourceGroupName "MyResourceGroup" ` + -name MyPublicIP -location 'West US' -AllocationMethod Dynamic +$frontend = New-AzLoadBalancerFrontendIpConfig -Name MyFrontEnd ` + -PublicIpAddress $publicip +$probe = New-AzLoadBalancerProbeConfig -Name MyProbe -Protocol http -Port ` + 80 -IntervalInSeconds 15 -ProbeCount 2 -ProbeThreshold 2 -RequestPath healthcheck.aspx +New-AzLoadBalancerRuleConfig -Name "MyLBrule" -FrontendIPConfiguration ` + $frontend -BackendAddressPool $backendAddressPool -Probe $probe -Protocol Tcp ` + -FrontendPort 80 -BackendPort 80 -IdleTimeoutInMinutes 15 -EnableFloatingIP ` + -LoadDistribution SourceIP +``` + +### Example 2: Creating a rule configuration for an Azure Load Balancer with Gateway Load Balancer +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$MyBackendPool1 = Get-AzLoadBalancerBackendAddressPool -ResourceGroupName $resourceGroup -LoadBalancerName $MyLoadBalancer -Name $backendPool1Name +$MyBackendPool2 = Get-AzLoadBalancerBackendAddressPool -ResourceGroupName $resourceGroup -LoadBalancerName $MyLoadBalancer -Name $backendPool2Name +$slb | Add-AzLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "All" -FrontendPort 0 -BackendPort 0 -BackendAddressPool $MyBackendPool1,$MyBackendPool2 +$slb | Set-AzLoadBalancer +``` + +The first three commands set up a public IP, a front end, and a probe for the rule configuration in the forth command. The forth command creates a new rule called MyLBrule with certain specifications. + +## PARAMETERS + +### -BackendAddressPool +Specifies a **BackendAddressPool** object to associate with a load balancer rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +Specifies the ID of a **BackendAddressPool** object to associate with a load balancer rule configuration. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendPort +Specifies the backend port for traffic that is matched by this load balancer rule configuration. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableOutboundSNAT +Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFloatingIP +Indicates that this cmdlet enables a floating IP address for a rule configuration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTcpReset +Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIpConfiguration +Specifies a list of front-end IP addresses to associate with a load balancer rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendIpConfigurationId +Specifies the ID for a front-end IP address configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPort +Specifies the front-end port that is matched by a load balancer rule configuration. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +Specifies the length of time, in minutes, that the state of conversations is maintained in a load balancer. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadDistribution +Specifies a load distribution. +The acceptable values for this parameter are: +- Default +- SourceIP +- SourceIPProtocol + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the load balancing rule that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Probe +Specifies a probe to associate with a load balancer rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSProbe +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProbeId +Specifies the ID of the probe to associate with a load balancer rule configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol that is matched by a load balancer rule configuration. +The acceptable values for this parameter are: Tcp or Udp. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +### Microsoft.Azure.Commands.Network.Models.PSProbe + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancingRule + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerRuleConfig](./Add-AzLoadBalancerRuleConfig.md) + +[Get-AzLoadBalancerRuleConfig](./Get-AzLoadBalancerRuleConfig.md) + +[Remove-AzLoadBalancerRuleConfig](./Remove-AzLoadBalancerRuleConfig.md) + +[Set-AzLoadBalancerRuleConfig](./Set-AzLoadBalancerRuleConfig.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzLocalNetworkGateway.md b/azps-10.1.0/Az.Network/New-AzLocalNetworkGateway.md new file mode 100644 index 0000000000..0afafc55d5 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzLocalNetworkGateway.md @@ -0,0 +1,293 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 59BE802E-C061-4E25-A446-B00B0BA36019 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azlocalnetworkgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLocalNetworkGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzLocalNetworkGateway.md +--- + +# New-AzLocalNetworkGateway + +## SYNOPSIS +Creates a Local Network Gateway + +## SYNTAX + +### ByLocalNetworkGatewayIpAddress +``` +New-AzLocalNetworkGateway -Name <String> -ResourceGroupName <String> -Location <String> + [-GatewayIpAddress <String>] [-AddressPrefix <String[]>] [-Asn <UInt32>] [-BgpPeeringAddress <String>] + [-PeerWeight <Int32>] [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByLocalNetworkGatewayFqdn +``` +New-AzLocalNetworkGateway -Name <String> -ResourceGroupName <String> -Location <String> [-Fqdn <String>] + [-AddressPrefix <String[]>] [-Asn <UInt32>] [-BgpPeeringAddress <String>] [-PeerWeight <Int32>] + [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The Local Network Gateway is the object representing your VPN device On-Premises. +The **New-AzLocalNetworkGateway** cmdlet creates the object representing your on-prem gateway +based on the Name, Resource Group Name, Location, and IP Address of the gateway, as well as the +Address Prefix of the On-Premises network which will be connecting to Azure. + +## EXAMPLES + +### Example 1: Create a Local Network Gateway +```powershell +New-AzLocalNetworkGateway -Name myLocalGW -ResourceGroupName myRG -Location "West US" -GatewayIpAddress 23.99.221.164 -AddressPrefix "10.5.51.0/24" +``` + +Creates the object of the Local Network Gateway with the name "myLocalGW" within the resource group +"myRG" in location "West US" with the IP address "23.99.221.164" and the address prefix +"10.5.51.0/24" on-prem. + +## PARAMETERS + +### -AddressPrefix +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Asn +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BgpPeeringAddress +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fqdn +FQDN of local network gateway. + +```yaml +Type: System.String +Parameter Sets: ByLocalNetworkGatewayFqdn +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GatewayIpAddress +```yaml +Type: System.String +Parameter Sets: ByLocalNetworkGatewayIpAddress +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerWeight +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group that the local network gateway belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.String[] + +### System.UInt32 + +### System.Int32 + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway + +## NOTES + +## RELATED LINKS + +[Get-AzLocalNetworkGateway](./Get-AzLocalNetworkGateway.md) + +[Remove-AzLocalNetworkGateway](./Remove-AzLocalNetworkGateway.md) + +[Set-AzLocalNetworkGateway](./Set-AzLocalNetworkGateway.md) diff --git a/azps-10.1.0/Az.Network/New-AzNatGateway.md b/azps-10.1.0/Az.Network/New-AzNatGateway.md new file mode 100644 index 0000000000..270c495b93 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNatGateway.md @@ -0,0 +1,289 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznatgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNatGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNatGateway.md +--- + +# New-AzNatGateway + +## SYNOPSIS +Create new Nat Gateway resource with properties Public Ip Address/Public Ip Prefix, IdleTimeoutInMinutes and Sku. + +## SYNTAX + +``` +New-AzNatGateway -ResourceGroupName <String> -Name <String> [-IdleTimeoutInMinutes <Int32>] [-Zone <String[]>] + [-Sku <String>] [-Location <String>] [-Tag <Hashtable>] [-PublicIpAddress <PSResourceId[]>] + [-PublicIpPrefix <PSResourceId[]>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNatGateway** cmdlet creates a Nat Gateway Resource. +A natgateway requires the following: +- Public Ip Address and/or Public Ip Prefix +- IdleTimeoutInMinutes +- Sku +- ResourceGroupName +- ResourceName +- Location + +## EXAMPLES + +### Example 1: Create Nat Gateway with Public Ip Address +```powershell +$pip = New-AzPublicIpAddress -Name "pip" -ResourceGroupName "natgateway_test" -Location "eastus2" -Sku "Standard" -IdleTimeoutInMinutes 4 -AllocationMethod "static" +$natgateway = New-AzNatGateway -ResourceGroupName "natgateway_test" -Name "nat_gateway" -IdleTimeoutInMinutes 4 -Sku "Standard" -Location "eastus2" -PublicIpAddress $pip +``` + +### Example 2: Create Nat Gateway with Public Ip Prefix +```powershell +$publicipprefix = New-AzPublicIpPrefix -Name "prefix2" -ResourceGroupName "natgateway_test" -Location "eastus2" -Sku "Standard" -PrefixLength "31" +$natgateway = New-AzNatGateway -ResourceGroupName "natgateway_test" -Name "nat_gateway" -IdleTimeoutInMinutes 4 -Sku "Standard" -Location "eastus2" -PublicIpPrefix $publicipprefix +``` + +### Example 3: Create Nat Gateway with Public IP Address in Availability Zone 1 +```powershell +$pip = New-AzPublicIpAddress -Name "pip" -ResourceGroupName "natgateway_test" -Location "eastus2" -Sku "Standard" -IdleTimeoutInMinutes 4 -AllocationMethod "static" +$natgateway = New-AzNatGateway -ResourceGroupName "natgateway_test" -Name "nat_gateway" -IdleTimeoutInMinutes 4 -Sku "Standard" -Location "eastus2" -PublicIpAddress $pip -Zone "1" +``` + +The first command creates standard Public IP Address. +The second command creates NAT Gateway with Public IP Address in Availability Zone 1. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +The idle timeout of the nat gateway. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the nat gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddress +An array of public ip addresses associated with the nat gateway resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSResourceId[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpPrefix +An array of public ip prefixes associated with the nat gateway resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSResourceId[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the nat gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +Name of a NAT gateway SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +A list of availability zones denoting the zone in which Nat Gateway should be deployed. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Network.Models.PSResourceId[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNatGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzNetworkInterface.md b/azps-10.1.0/Az.Network/New-AzNetworkInterface.md new file mode 100644 index 0000000000..0f89f32fed --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkInterface.md @@ -0,0 +1,660 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: B2F2082F-4BAA-4FBE-8846-2D436A433570 +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkinterface +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkInterface.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkInterface.md +--- + +# New-AzNetworkInterface + +## SYNOPSIS +Creates a network interface. + +## SYNTAX + +### SetByIpConfigurationResource (Default) +``` +New-AzNetworkInterface -Name <String> -ResourceGroupName <String> -Location <String> [-EdgeZone <String>] + -IpConfiguration <PSNetworkInterfaceIPConfiguration[]> [-DnsServer <String[]>] + [-InternalDnsNameLabel <String>] [-DisableTcpStateTracking <String>] [-EnableIPForwarding] + [-EnableAcceleratedNetworking] [-AuxiliaryMode <String>] [-AuxiliarySku <String>] [-Tag <Hashtable>] [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByIpConfigurationResourceId +``` +New-AzNetworkInterface -Name <String> -ResourceGroupName <String> -Location <String> [-EdgeZone <String>] + -IpConfiguration <PSNetworkInterfaceIPConfiguration[]> [-NetworkSecurityGroupId <String>] + [-NetworkSecurityGroup <PSNetworkSecurityGroup>] [-DnsServer <String[]>] [-InternalDnsNameLabel <String>] + [-DisableTcpStateTracking <String>] [-EnableIPForwarding] [-EnableAcceleratedNetworking] + [-AuxiliaryMode <String>] [-AuxiliarySku <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzNetworkInterface -Name <String> -ResourceGroupName <String> -Location <String> [-EdgeZone <String>] + -SubnetId <String> [-PublicIpAddressId <String>] [-NetworkSecurityGroupId <String>] + [-LoadBalancerBackendAddressPoolId <String[]>] [-LoadBalancerInboundNatRuleId <String[]>] + [-ApplicationGatewayBackendAddressPoolId <String[]>] [-ApplicationSecurityGroupId <String[]>] + [-PrivateIpAddress <String>] [-IpConfigurationName <String>] [-DnsServer <String[]>] + [-InternalDnsNameLabel <String>] [-DisableTcpStateTracking <String>] [-EnableIPForwarding] + [-EnableAcceleratedNetworking] [-AuxiliaryMode <String>] [-AuxiliarySku <String>] [-Tag <Hashtable>] [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResource +``` +New-AzNetworkInterface -Name <String> -ResourceGroupName <String> -Location <String> [-EdgeZone <String>] + -Subnet <PSSubnet> [-PublicIpAddress <PSPublicIpAddress>] [-NetworkSecurityGroup <PSNetworkSecurityGroup>] + [-LoadBalancerBackendAddressPool <PSBackendAddressPool[]>] [-LoadBalancerInboundNatRule <PSInboundNatRule[]>] + [-ApplicationGatewayBackendAddressPool <PSApplicationGatewayBackendAddressPool[]>] + [-ApplicationSecurityGroup <PSApplicationSecurityGroup[]>] [-PrivateIpAddress <String>] + [-IpConfigurationName <String>] [-DnsServer <String[]>] [-InternalDnsNameLabel <String>] + [-DisableTcpStateTracking <String>] [-EnableIPForwarding] [-EnableAcceleratedNetworking] + [-AuxiliaryMode <String>] [-AuxiliarySku <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkInterface** cmdlet creates an Azure network interface. + +## EXAMPLES + +### Example 1: Create an Azure network interface +```powershell +New-AzNetworkInterface -Name "NetworkInterface1" -ResourceGroupName "ResourceGroup1" -Location "centralus" -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Network/virtualNetworks/VirtualNetwork1/subnets/Subnet1" -IpConfigurationName "IPConfiguration1" -DnsServer "8.8.8.8", "8.8.4.4" +``` + +This command creates a network interface named NetworkInterface001 with a dynamically assigned +private IP address from Subnet1 in the virtual network named VirtualNetwork1. The command also +assigns two DNS servers to the network interface. The IPConfiguration child resource will be +created automatically using the name IPConfiguration1. + +### Example 2: Create an Azure network interface using an IP configuration object +```powershell +$Subnet = Get-AzVirtualNetwork -Name "VirtualNetwork1" -ResourceGroupName "ResourceGroup1" +$IPconfig = New-AzNetworkInterfaceIpConfig -Name "IPConfig1" -PrivateIpAddressVersion IPv4 -PrivateIpAddress "10.0.1.10" -SubnetId $Subnet.Subnets[0].Id +New-AzNetworkInterface -Name "NetworkInterface1" -ResourceGroupName "ResourceGroup1" -Location "centralus" -IpConfiguration $IPconfig +``` + +This example creates a new network interface using an IP configuration object. The IP configuration +object specifies a static private IPv4 address. +The first command retrieves an existing specified virtual network used to assign the subnet in the second command. +The second command creates a network interface IP configuration named IPConfig1 and stores the +configuration in the variable named $IPconfig. +The third command creates a network interface named NetworkInterface1 that uses the network +interface IP configuration stored in the variable named $IPconfig. + +### Example 3 + +Creates a network interface. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzNetworkInterface -Location 'West US' -Name 'NetworkInterface1' -PrivateIpAddress '10.0.1.10' -ResourceGroupName 'ResourceGroup1' -SubnetId '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Network/virtualNetworks/VirtualNetwork1/subnets/Subnet1' +``` + +## PARAMETERS + +### -ApplicationGatewayBackendAddressPool +Specifies an **ApplicationGatewayBackendAddressPool** object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationGatewayBackendAddressPoolId +Specifies the ID of a **ApplicationGatewayBackendAddressPool** object. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationSecurityGroup +Specifies a collection of application security group references to which the network interface IP configuration should belong to. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationSecurityGroupId +Specifies a collection of application security group references to which the network interface IP configuration should belong to. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuxiliaryMode +The auxiliary mode of the Network Interface + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, MaxConnections, AcceleratedConnections + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuxiliarySku +The auxiliary sku of the Network Interface + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, A1, A2, A4, A8 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableTcpStateTracking +Indicates whether to disable tcp state tracking. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DnsServer +Specifies the DNS server for the network interface. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EdgeZone +The edge zone of the network interface + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableAcceleratedNetworking +Enables accelerated networking. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableIPForwarding +Indicates that this cmdlet enables IP forwarding for the network interface. +IP forwarding allows a virtual machine to receive traffic addressed to other destinations. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the creation of the network interface even if a network interface with the same name already exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalDnsNameLabel +Specifies the internal DNS name label for the new network interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpConfiguration +Specifies the IP configuration that this cmdlet uses for the network interface. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration[] +Parameter Sets: SetByIpConfigurationResource, SetByIpConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpConfigurationName +Specifies the name of an IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId, SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerBackendAddressPool +Specifies a **BackendAddressPool** object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerBackendAddressPoolId +Specifies the ID of a **BackendAddressPool** object. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerInboundNatRule +Specifies an inbound NAT rule configuration for a load balancer. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSInboundNatRule[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerInboundNatRuleId +Specifies the ID of an inbound NAT rule configuration for a load balancer. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the region for a network interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network interface to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkSecurityGroup +Specifies a **NetworkSecurityGroup** object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup +Parameter Sets: SetByIpConfigurationResourceId, SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkSecurityGroupId +Specifies the ID of a network security group. + +```yaml +Type: System.String +Parameter Sets: SetByIpConfigurationResourceId, SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateIpAddress +Specifies a static IPv4 IP address to assign to this network interface. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId, SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddress +Specifies a **PublicIPAddress** object to assign to a network interface. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddressId +Specifies the ID of a **PublicIPAddress** object to assign to a network interface. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that the network interface belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Subnet +Specifies a **Subnet** object. +This cmdlet creates a network interface for the subnet that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubnetId +Specifies the ID of the subnet for which to create a network interface. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration[] + +### Microsoft.Azure.Commands.Network.Models.PSSubnet + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +### System.String[] + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool[] + +### Microsoft.Azure.Commands.Network.Models.PSInboundNatRule[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkInterface](./Get-AzNetworkInterface.md) + +[Remove-AzNetworkInterface](./Remove-AzNetworkInterface.md) + +[Set-AzNetworkInterface](./Set-AzNetworkInterface.md) diff --git a/azps-10.1.0/Az.Network/New-AzNetworkInterfaceIpConfig.md b/azps-10.1.0/Az.Network/New-AzNetworkInterfaceIpConfig.md new file mode 100644 index 0000000000..eff98c7dcb --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkInterfaceIpConfig.md @@ -0,0 +1,390 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: D29C82CC-2080-48DA-880A-1AA83007E552 +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkinterfaceipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkInterfaceIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkInterfaceIpConfig.md +--- + +# New-AzNetworkInterfaceIpConfig + +## SYNOPSIS +Creates a network interface IP configuration. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzNetworkInterfaceIpConfig -Name <String> [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] + [-Primary] [-Subnet <PSSubnet>] [-PublicIpAddress <PSPublicIpAddress>] + [-LoadBalancerBackendAddressPool <PSBackendAddressPool[]>] [-LoadBalancerInboundNatRule <PSInboundNatRule[]>] + [-ApplicationGatewayBackendAddressPool <PSApplicationGatewayBackendAddressPool[]>] + [-ApplicationSecurityGroup <PSApplicationSecurityGroup[]>] [-GatewayLoadBalancerId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzNetworkInterfaceIpConfig -Name <String> [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] + [-Primary] [-SubnetId <String>] [-PublicIpAddressId <String>] [-LoadBalancerBackendAddressPoolId <String[]>] + [-LoadBalancerInboundNatRuleId <String[]>] [-ApplicationGatewayBackendAddressPoolId <String[]>] + [-ApplicationSecurityGroupId <String[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkInterfaceIpConfig** cmdlet creates an Azure network interface IP configuration for a network interface. + +## EXAMPLES + +### Example 1: Create an IP configuration with a public IP address for a network interface +```powershell +$vnet = Get-AzVirtualNetwork -Name myvnet -ResourceGroupName myrg +$Subnet = Get-AzVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet +$PIP1 = Get-AzPublicIpAddress -Name "PIP1" -ResourceGroupName "RG1" + +$IPConfig1 = New-AzNetworkInterfaceIpConfig -Name "IPConfig-1" -Subnet $Subnet -PublicIpAddress $PIP1 -Primary + +$nic = New-AzNetworkInterface -Name mynic1 -ResourceGroupName myrg -Location westus -IpConfiguration $IpConfig1 +``` + +The first two commands get a virtual network called myvnet and a subnet called mysubnet respectively that were + previously created. These are stored in $vnet and $Subnet respectively. The third command gets a previously + created public IP address called PIP1. The forth command creates a new IP configuration called "IPConfig-1" as the + primary IP configuration with a public IP address associated with it. + The last command then creates a network interface called mynic1 using this IP configuration. + +### Example 2: Create an IP configuration with a private IP address +```powershell +$vnet = Get-AzVirtualNetwork -Name myvnet -ResourceGroupName myrg +$Subnet = Get-AzVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet + +$IPConfig2 = New-AzNetworkInterfaceIpConfig -Name "IP-Config2" -Subnet $Subnet -PrivateIpAddress 10.0.0.5 + +$nic = New-AzNetworkInterface -Name mynic1 -ResourceGroupName myrg -Location westus -IpConfiguration $IpConfig2 +``` + +The first two commands get a virtual network called myvnet and a subnet called mysubnet respectively that were + previously created. These are stored in $vnet and $Subnet respectively. The third command creates a new IP + configuration called "IPConfig-2" with a private IP address 10.0.0.5 associated with it. + The last command then creates a network interface called mynic1 using this IP configuration. + +### Example 3 + +Creates a network interface IP configuration. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzNetworkInterfaceIpConfig -Name 'IP-Config2' -PrivateIpAddress '10.0.1.10' -PrivateIpAddressVersion IPv4 -SubnetId <String> +``` + +## PARAMETERS + +### -ApplicationGatewayBackendAddressPool +Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationGatewayBackendAddressPoolId +Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationSecurityGroup +Specifies a collection of application security group references to which this network interface IP configuration belongs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationSecurityGroupId +Specifies a collection of application security group references to which this network interface IP configuration belongs. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayLoadBalancerId +The reference of Gateway LoadBalancer Provider resource. + +```yaml +Type: System.String +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerBackendAddressPool +Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerBackendAddressPoolId +Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerInboundNatRule +Specifies a collection of load balancer inbound Nat Rule references to which this network interface IPConfiguration belongs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSInboundNatRule[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerInboundNatRuleId +Specifies a collection of load balancer inbound network address translation (NAT) rule references to which this network interface IP configuration belongs. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network interface IP configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Primary +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddress +Specifies the static IP address of the network interface IP configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddressVersion +Specifies the IP address version of a network interface IP configuration. +The acceptable values for this parameter are: +- IPv4 +- IPv6 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddress +Specifies a **PublicIPAddress** object. +This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddressId +This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Specifies a **Subnet** object. +This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Specifies a reference to a subnet in which this network interface IP configuration is created. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool[] + +### Microsoft.Azure.Commands.Network.Models.PSInboundNatRule[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Add-AzNetworkInterfaceIpConfig](./Add-AzNetworkInterfaceIpConfig.md) + +[Get-AzNetworkInterfaceIpConfig](./Get-AzNetworkInterfaceIpConfig.md) + +[Remove-AzNetworkInterfaceIpConfig](./Remove-AzNetworkInterfaceIpConfig.md) + +[Set-AzNetworkInterfaceIpConfig](./Set-AzNetworkInterfaceIpConfig.md) diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManager.md b/azps-10.1.0/Az.Network/New-AzNetworkManager.md new file mode 100644 index 0000000000..4ee5cebaf2 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManager.md @@ -0,0 +1,327 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanager +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManager.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManager.md +--- + +# New-AzNetworkManager + +## SYNOPSIS +Creates a network manager. + +## SYNTAX + +``` +New-AzNetworkManager -Name <String> -ResourceGroupName <String> -Location <String> [-Description <String>] + [-Tag <Hashtable>] -NetworkManagerScope <PSNetworkManagerScopes> + -NetworkManagerScopeAccess <NetworkManagerScopeAccessType[]> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManager** cmdlet creates a network manager. + +## EXAMPLES + +### Example 1: Creates a connectivity network manager. +```powershell +$subscriptions = @("/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884") +$managementGroups = @("/providers/Microsoft.Management/managementGroups/PowerShellTest") +$scope = New-AzNetworkManagerScope -Subscription $subscriptions -ManagementGroup $managementGroups +$access = @("Connectivity") +New-AzNetworkManager -ResourceGroupName "psResourceGroup" -Name "psNetworkManager" -NetworkManagerScope $scope -NetworkManagerScopeAccess $access -Location "westus" +``` + +```output +Location : westus +Tag : {} +NetworkManagerScopes : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopes +NetworkManagerScopeAccesses : {Connectivity} +NetworkManagerScopeAccessesText : [ + "Connectivity" + ] +NetworkManagerScopesText : { + "ManagementGroups": [ + "/providers/Microsoft.Management/managementGroups/PowerShellTest" + ], + "Subscriptions": [ + "/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884" + ] + } +TagsTable : +DisplayName : +Description : +Type : Microsoft.Network/networkManagers +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T04:12:51.7463424Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-07T04:12:51.7463424Z" + } +Name : psNetworkManager +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager +``` + +Creates a network manager with connectivity access in West US, with a subscription and management group in scope. + +### Example 2: Creates a security admin network manager. +```powershell +$subscriptions = @("/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884") +$scope = New-AzNetworkManagerScope -Subscription $subscriptions +$access = @("SecurityAdmin") +New-AzNetworkManager -ResourceGroupName "psResourceGroup" -Name "psNetworkManager" -NetworkManagerScope $scope -NetworkManagerScopeAccess $access -Location "westus" +``` + +```output +Location : westus +Tag : {} +NetworkManagerScopes : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopes +NetworkManagerScopeAccesses : {"SecurityAdmin"} +NetworkManagerScopeAccessesText : [ + "SecurityAdmin" + ] +NetworkManagerScopesText : { + "Subscriptions": [ + "/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884" + ] + } +TagsTable : +DisplayName : +Description : +Type : Microsoft.Network/networkManagers +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T04:12:51.7463424Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-07T04:12:51.7463424Z" + } +Name : psNetworkManager +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/pr + oviders/Microsoft.Network/networkManagers/psNetworkManager +``` + +Creates a network manager with security administrator access in West US, with a subscription in scope. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkManagerScope +Network Manager Scope + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopes +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkManagerScopeAccess +Network Manager Scope Access. + +```yaml +Type: Microsoft.Azure.Commands.Network.NewAzNetworkManagerCommand+NetworkManagerScopeAccessType[] +Parameter Sets: (All) +Aliases: +Accepted values: SecurityAdmin, Connectivity + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopes + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManager + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerScope](./New-AzNetworkManagerScope.md) + +[Get-AzNetworkManager](./Get-AzNetworkManager.md) + +[Remove-AzNetworkManager](./Remove-AzNetworkManager.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerAddressPrefixItem.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerAddressPrefixItem.md new file mode 100644 index 0000000000..23f682c69a --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerAddressPrefixItem.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanageraddressprefixitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerAddressPrefixItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerAddressPrefixItem.md +--- + +# New-AzNetworkManagerAddressPrefixItem + +## SYNOPSIS +Creates a network manager address prefix item. + +## SYNTAX + +``` +New-AzNetworkManagerAddressPrefixItem -AddressPrefix <String> -AddressPrefixType <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerAddressPrefixItem** cmdlet creates a network manager address prefix item. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetworkManagerAddressPrefixItem -AddressPrefix "Internet" -AddressPrefixType "ServiceTag" +``` + +```output +AddressPrefix AddressPrefixType +------------- ----------------- +Internet ServiceTag +``` + +Creates a network manager service tag address prefix item. + +### Example 2 +```powershell +New-AzNetworkManagerAddressPrefixItem -AddressPrefix "10.0.0.1" -AddressPrefixType "IPPrefix" +``` + +```output +AddressPrefix AddressPrefixType +------------- ----------------- +10.0.0.1 IPPrefix +``` + +Creates a network manager IP address prefix item. + +## PARAMETERS + +### -AddressPrefix +AddressPrefix + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AddressPrefixType +AddressPrefix Type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPPrefix, ServiceTag + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerAddressPrefixItem + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerConnectivityConfiguration.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerConnectivityConfiguration.md new file mode 100644 index 0000000000..ce94566471 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerConnectivityConfiguration.md @@ -0,0 +1,362 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanagerconnectivityconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerConnectivityConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerConnectivityConfiguration.md +--- + +# New-AzNetworkManagerConnectivityConfiguration + +## SYNOPSIS +Creates a network manager connectivity configuration. + +## SYNTAX + +``` +New-AzNetworkManagerConnectivityConfiguration -Name <String> -NetworkManagerName <String> + -ResourceGroupName <String> -AppliesToGroup <PSNetworkManagerConnectivityGroupItem[]> + -ConnectivityTopology <String> [-Description <String>] [-Hub <PSNetworkManagerHub[]>] [-DeleteExistingPeering] + [-IsGlobal] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerConnectivityConfiguration** cmdlet creates a network manager connectivity configuration. + +## EXAMPLES + +### Example 1 +```powershell +$connectivityGroupItem = New-AzNetworkManagerConnectivityGroupItem -NetworkGroupId "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup" +$connectivityGroup = @($connectivityGroupItem) + +$hub = New-AzNetworkManagerHub -ResourceId "/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884/resourceGroups/jaredgorthy-PowerShellTestResources/providers/Microsoft.Network/virtualNetworks/powerShellTestVnetHub" -ResourceType "Microsoft.Network/virtualNetworks" +$hubList = @($hub) +New-AzNetworkManagerConnectivityConfiguration -ResourceGroupName psResourceGroup -Name "psConnectivityConfig" -NetworkManagerName psNetworkManager -ConnectivityTopology "HubAndSpoke" -Hub $hublist -AppliesToGroup $connectivityGroup -DeleteExistingPeering +``` + +```output +ConnectivityTopology : HubAndSpoke +Hubs : {/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884/resourceGroups/jaredgorthy-PowerShellTestResources/providers/Microsoft.Network/virtualNetworks/powerShellTestVnetHub} +DeleteExistingPeering : True +IsGlobal : False +AppliesToGroups : {/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup} +AppliesToGroupsText : [ + { + "NetworkGroupId": "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup", + "UseHubGateway": "False", + "IsGlobal": "False", + "GroupConnectivity": "None" + } + ] +HubsText : [ + { + "ResourceId": "/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884/resourceGroups/jaredgorthy-PowerShellTestResources/providers/Microsoft.Network/virtualNetworks/powerShellTestVnetHub", + "ResourceType": "Microsoft.Network/virtualNetworks" + } + ] +DisplayName : +Description : +Type : Microsoft.Network/networkManagers/connectivityConfigurations +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T04:37:43.1186543Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-07T04:37:43.1186543Z" + } +Name : psConnectivityConfig +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/connectivityConfigurations/psConnectivityConfig +``` + +Creates a hub and spoke network manager connectivity configuration. + +### Example 2 +```powershell +$connectivityGroupItem = New-AzNetworkManagerConnectivityGroupItem -NetworkGroupId "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup" +[System.Collections.Generic.List[Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnectivityGroupItem]]$connectivityGroup = @() +$connectivityGroup.Add($connectivityGroupItem) +New-AzNetworkManagerConnectivityConfiguration -ResourceGroupName psResourceGroup -Name "psConnectivityConfigMesh" -NetworkManagerName psNetworkManager -ConnectivityTopology "Mesh" -AppliesToGroup $connectivityGroup -DeleteExistingPeering +``` + +```output +ConnectivityTopology : Mesh +Hubs : {} +DeleteExistingPeering : True +IsGlobal : False +AppliesToGroups : {/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup} +AppliesToGroupsText : [ + { + "NetworkGroupId": "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup", + "UseHubGateway": "False", + "IsGlobal": "False", + "GroupConnectivity": "None" + } + ] +HubsText : [] +DisplayName : +Description : +Type : Microsoft.Network/networkManagers/connectivityConfigurations +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T04:43:00.9075845Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-07T04:43:00.9075845Z" + } +Name : psConnectivityConfigMesh +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/connectivityConfigurations/psConnectivityConfigMesh +``` + +Creates a mesh network manager connectivity configuration. + +## PARAMETERS + +### -AppliesToGroup +Connectivity Group. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnectivityGroupItem[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectivityTopology +Connectivity Topology. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: HubAndSpoke, Mesh + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteExistingPeering +DeleteExistingPeering Flag. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +Description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Hub +Hub Id list. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerHub[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IsGlobal +IsGlobal Flag. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnectivityGroupItem, Microsoft.Azure.PowerShell.Cmdlets.Network, Version=4.16.1.0, Culture=neutral, PublicKeyToken=null]] + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerHub, Microsoft.Azure.PowerShell.Cmdlets.Network, Version=4.16.1.0, Culture=neutral, PublicKeyToken=null]] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnectivityConfiguration + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerConnectivityConfiguration](./Get-AzNetworkManagerConnectivityConfiguration.md) + +[Remove-AzNetworkManagerConnectivityConfiguration](./Remove-AzNetworkManagerConnectivityConfiguration.md) + +[Set-AzNetworkManagerConnectivityConfiguration](./Set-AzNetworkManagerConnectivityConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerConnectivityGroupItem.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerConnectivityGroupItem.md new file mode 100644 index 0000000000..27f7f98e94 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerConnectivityGroupItem.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanagerconnectivitygroupitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerConnectivityGroupItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerConnectivityGroupItem.md +--- + +# New-AzNetworkManagerConnectivityGroupItem + +## SYNOPSIS +Creates a connectivity group item. + +## SYNTAX + +``` +New-AzNetworkManagerConnectivityGroupItem -NetworkGroupId <String> [-UseHubGateway] + [-GroupConnectivity <String>] [-IsGlobal] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerConnectivityGroupItem** cmdlet creates a connectivity group item. + +## EXAMPLES + +### Example 1 +```powershell +$networkGroupId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/TestGroup" +New-AzNetworkManagerConnectivityGroupItem -NetworkGroupId $networkGroupId -UseHubGateway -GroupConnectivity "None" -IsGlobal +``` + +```output +NetworkGroupId UseHubGateway IsGlobal GroupConnectivity +-------------- ------------- -------- ----------------- +/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/TestGroup True True None +``` + +Creates a connectivity group item using hub as gateway. + +### Example 2 +```powershell +$networkGroupId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/TestGroup" +New-AzNetworkManagerConnectivityGroupItem -NetworkGroupId $networkGroupId -GroupConnectivity "DirectlyConnected" +``` + +```output +NetworkGroupId UseHubGateway IsGlobal GroupConnectivity +-------------- ------------- -------- ----------------- +/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/TestGroup False False DirectlyConnected +``` + +Creates a connectivity group item with direct connectivity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupConnectivity +Group Connectivity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, DirectlyConnected + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IsGlobal +IsGlobal flag + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkGroupId +Network Group Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UseHubGateway +Use hub gateway flag + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnectivityGroupItem + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerConnectivityConfiguration](./New-AzNetworkManagerConnectivityConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerGroup.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerGroup.md new file mode 100644 index 0000000000..2ff6d955a7 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerGroup.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanagergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerGroup.md +--- + +# New-AzNetworkManagerGroup + +## SYNOPSIS +Creates a network manager group. + +## SYNTAX + +``` +New-AzNetworkManagerGroup -Name <String> -NetworkManagerName <String> -ResourceGroupName <String> + [-Description <String>] [-IfMatch <String>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerGroup** cmdlet creates a network manager group. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetworkManagerGroup -ResourceGroupName "psTestResourceGroup" -NetworkManagerName "psNetworkManager" -Name psNetworkGroup -Description "psDescription" +``` + +```output +MemberType : +DisplayName : +Description : psDescription +Type : Microsoft.Network/networkManagers/networkGroups +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T04:32:21.6585296Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-07T04:32:21.6585296Z" + } +Name : psNetworkGroup +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup +``` + +Creates a network manager group. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +If match header. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerGroup + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerGroup](./Get-AzNetworkManagerGroup.md) + +[Remove-AzNetworkManagerGroup](./Remove-AzNetworkManagerGroup.md) + +[Set-AzNetworkManagerGroup](./Set-AzNetworkManagerGroup.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerHub.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerHub.md new file mode 100644 index 0000000000..d839ef17b1 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerHub.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanagerhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerHub.md +--- + +# New-AzNetworkManagerHub + +## SYNOPSIS +Creates a network manager hub. + +## SYNTAX + +``` +New-AzNetworkManagerHub -ResourceId <String> -ResourceType <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerHub** cmdlet creates a network manager hub. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetworkManagerHub -ResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/TestGroup" -ResourceType "Microsoft.Network/virtualNetworks" +``` + +```output +ResourceId ResourceType +---------- ------------ +/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestRG/providers/Microsoft.Network/networkManagers/TestNMName/networkGroups/TestGroup Microsoft.Network/virtualNetworks +``` + +Creates a network manager virtual network hub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +Resource Type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerHub + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerConnectivityConfiguration](./New-AzNetworkManagerConnectivityConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerManagementGroupConnection.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerManagementGroupConnection.md new file mode 100644 index 0000000000..df7691412e --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerManagementGroupConnection.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanagermanagementgroupconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerManagementGroupConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerManagementGroupConnection.md +--- + +# New-AzNetworkManagerManagementGroupConnection + +## SYNOPSIS +Creates a network manager management group connection. + +## SYNTAX + +``` +New-AzNetworkManagerManagementGroupConnection -ManagementGroupId <String> -Name <String> + -NetworkManagerId <String> [-Description <String>] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerManagementGroupConnection** cmdlet creates a network manager management group connection. + +## EXAMPLES + +### Example 1 +```powershell +$networkManagerId = "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager" +$managementGroupId = "newMG" +New-AzNetworkManagerManagementGroupConnection -ManagementGroupId $managementGroupId -Name "psConnection" -NetworkManagerId $networkManagerId -Description "sample description" +``` + +```output +NetworkManagerId : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager +ConnectionState : Pending +DisplayName : +Description : sample description +Type : Microsoft.Network/networkManagerConnections +ProvisioningState : +SystemData : +SystemDataText : null +Name : psConnection +Etag : +Id : /providers/Microsoft.Management/managementGroups/newMG/providers/Microsoft.Network/networkManagerConnections/psConnection +``` + +Creates a network manager management group connection. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkManagerId +Network Manager Id of the resource you'd like to manage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnection + +## NOTES + +## RELATED LINKS + +[Set-AzNetworkManagerManagementGroupConnection](./Set-AzNetworkManagerManagementGroupConnection.md) + +[Get-AzNetworkManagerManagementGroupConnection](./Get-AzNetworkManagerManagementGroupConnection.md) + +[Remove-AzNetworkManagerManagementGroupConnection](./Remove-AzNetworkManagerManagementGroupConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerScope.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerScope.md new file mode 100644 index 0000000000..cf85b5f094 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerScope.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanagerscope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerScope.md +--- + +# New-AzNetworkManagerScope + +## SYNOPSIS +Creates a network manager scope. + +## SYNTAX + +``` +New-AzNetworkManagerScope [-ManagementGroup <String[]>] [-Subscription <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerScope** cmdlet creates a network manager scope. + +## EXAMPLES + +### Example 1 +```powershell +$subgroup = @("/subscriptions/00000000-0000-0000-0000-000000000000") +$mggroup = @("/providers/Microsoft.Management/managementGroups/PowerShellTest") +New-AzNetworkManagerScope -Subscription $subgroup -ManagementGroup $mggroup +``` + +```output +ManagementGroups Subscriptions +---------------- ------------- +{/providers/Microsoft.Management/managementGroups/PowerShellTest} {/subscriptions/00000000-0000-0000-0000-000000000000} +``` + +Creates a network manager scope with management group and subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroup +Management Group Lists in Network Manager Scope + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Subscription +Subscription Lists in Network Manager Scope + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopes + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManager](./New-AzNetworkManager.md) + +[Get-AzNetworkManager](./Get-AzNetworkManager.md) + +[Remove-AzNetworkManager](./Remove-AzNetworkManager.md) + +[Set-AzNetworkManager](./Set-AzNetworkManager.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerScopeConnection.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerScopeConnection.md new file mode 100644 index 0000000000..f5b838119f --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerScopeConnection.md @@ -0,0 +1,274 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanagerscopeconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerScopeConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerScopeConnection.md +--- + +# New-AzNetworkManagerScopeConnection + +## SYNOPSIS +Creates a scope connection. + +## SYNTAX + +``` +New-AzNetworkManagerScopeConnection -Name <String> -NetworkManagerName <String> -ResourceGroupName <String> + -TenantId <String> -ResourceId <String> [-Description <String>] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerScopeConnection** cmdlet creates a scope connection. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetworkManagerScopeConnection -ResourceGroupName psResourceGroup -NetworkManagerName psNetworkManager -Name "subConnection" -TenantId "72f988bf-86f1-41af-91ab-2d7cd011db47" -ResourceId "/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884" -Description "SampleDescription" +``` + +```output +TenantId : 72f988bf-86f1-41af-91ab-2d7cd011db47 +ResourceId : /subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884 +ConnectionState : Pending +DisplayName : +Description : SampleDescription +Type : Microsoft.Network/networkManagers/scopeConnections +ProvisioningState : +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T23:53:52.6942092Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-07T23:53:52.6942092Z" + } +Name : subConnection +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/scopeConnections/subConnection +``` + +Creates a scope connection to a cross-tenant subscription. + +### Example 2 +```powershell +New-AzNetworkManagerScopeConnection -ResourceGroupName psResourceGroup -NetworkManagerName psNetworkManager -Name "mgConnection" -TenantId "72f988bf-86f1-41af-91ab-2d7cd011db47" -ResourceId "/providers/Microsoft.Management/managementGroups/newMG" -Description "SampleDescription" +``` + +```output +TenantId : 72f988bf-86f1-41af-91ab-2d7cd011db47 +ResourceId : /providers/Microsoft.Management/managementGroups/newMG +ConnectionState : Pending +DisplayName : +Description : SampleDescription +Type : Microsoft.Network/networkManagers/scopeConnections +ProvisioningState : +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T23:55:14.7516201Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-07T23:55:14.7516201Z" + } +Name : mgConnection +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/scopeConnections/mgConnection +``` + +Creates a scope connection to a cross-tenant management group. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id of the subscription or management group to be managed. +Resource IDs should be in the form '/subscriptions/{subscriptionId}' or '/providers/Microsoft.Management/managementGroups/{managementGroupId}'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantId +Tenant Id of the resource you'd like to manage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopeConnection + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerScopeConnection](./Get-AzNetworkManagerScopeConnection.md) + +[Remove-AzNetworkManagerScopeConnection](./Remove-AzNetworkManagerScopeConnection.md) + +[Set-AzNetworkManagerScopeConnection](./Set-AzNetworkManagerScopeConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerSecurityAdminConfiguration.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerSecurityAdminConfiguration.md new file mode 100644 index 0000000000..5e4be71645 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerSecurityAdminConfiguration.md @@ -0,0 +1,287 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanagersecurityadminconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerSecurityAdminConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerSecurityAdminConfiguration.md +--- + +# New-AzNetworkManagerSecurityAdminConfiguration + +## SYNOPSIS +Creates a security admin configuration. + +## SYNTAX + +``` +New-AzNetworkManagerSecurityAdminConfiguration -Name <String> -NetworkManagerName <String> + -ResourceGroupName <String> [-Description <String>] + [-ApplyOnNetworkIntentPolicyBasedService <NetworkIntentPolicyBasedServiceType[]>] [-DeleteExistingNSG] + [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerSecurityAdminConfiguration** cmdlet creates a security admin configuration. + +## EXAMPLES + +### Example 1 +```powershell +$ApplyOnNetworkIntentPolicyBasedService = @("None") +New-AzNetworkManagerSecurityAdminConfiguration -ResourceGroupName "psResourceGroup" -NetworkManagerName "psNetworkManager" -Name "psSecurityAdminConfig" -Description "TestDescription" -DeleteExistingNSG -ApplyOnNetworkIntentPolicyBasedService $ApplyOnNetworkIntentPolicyBasedService +``` + +```output +SecurityType : +ApplyOnNetworkIntentPolicyBasedServices : {None} +ApplyOnNetworkIntentPolicyBasedServicesText : [ + "None" + ] +DeleteExistingNSGs : +DisplayName : +Description : TestDescription +Type : Microsoft.Network/networkManagers/securityAdminConfigurations +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T23:58:54.8549506Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-07T23:59:12.5789979Z" + } +Name : psSecurityAdminConfig +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/securityAdminConfigurations/psSecurityAdminConfig +``` + +Creates a security admin configuration that will delete existing NSGs and not apply on NIP based services. + +### Example 2 +```powershell +$ApplyOnNetworkIntentPolicyBasedService = @("All") +New-AzNetworkManagerSecurityAdminConfiguration -ResourceGroupName "psResourceGroup" -NetworkManagerName "psNetworkManager" -Name "psSecurityAdminConfig" -Description "TestDescription" -ApplyOnNetworkIntentPolicyBasedService $ApplyOnNetworkIntentPolicyBasedService +``` + +```output +SecurityType : +ApplyOnNetworkIntentPolicyBasedServices : {All} +ApplyOnNetworkIntentPolicyBasedServicesText : [ + "All" + ] +DeleteExistingNSGs : +DisplayName : +Description : TestDescription +Type : Microsoft.Network/networkManagers/securityAdminConfigurations +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T23:58:54.8549506Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-08T00:01:21.391989Z" + } +Name : psSecurityAdminConfig +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/securityAdminConfigurations/psSecurityAdminConfig +``` + +Creates a security admin configuration that will apply on NIP based services. + +## PARAMETERS + +### -ApplyOnNetworkIntentPolicyBasedService +ApplyOnNetworkIntentPolicyBasedServices. + +```yaml +Type: Microsoft.Azure.Commands.Network.NewAzNetworkManagerSecurityAdminConfigurationCommand+NetworkIntentPolicyBasedServiceType[] +Parameter Sets: (All) +Aliases: +Accepted values: None, All, AllowRulesOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteExistingNSG +DeleteExistingNSGs Flag. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +Description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityAdminConfiguration + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerSecurityAdminConfiguration](./Get-AzNetworkManagerSecurityAdminConfiguration.md) + +[Remove-AzNetworkManagerSecurityAdminConfiguration](./Remove-AzNetworkManagerSecurityAdminConfiguration.md) + +[Set-AzNetworkManagerSecurityAdminConfiguration](./Set-AzNetworkManagerSecurityAdminConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerSecurityAdminRule.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerSecurityAdminRule.md new file mode 100644 index 0000000000..ad674ee038 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerSecurityAdminRule.md @@ -0,0 +1,428 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanagersecurityadminrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerSecurityAdminRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerSecurityAdminRule.md +--- + +# New-AzNetworkManagerSecurityAdminRule + +## SYNOPSIS +Creates a security admin rule. + +## SYNTAX + +### Custom (Default) +``` +New-AzNetworkManagerSecurityAdminRule -Name <String> -RuleCollectionName <String> + -SecurityAdminConfigurationName <String> -NetworkManagerName <String> -ResourceGroupName <String> + [-Description <String>] -Protocol <String> -Direction <String> -Access <String> + [-SourceAddressPrefix <PSNetworkManagerAddressPrefixItem[]>] + [-DestinationAddressPrefix <PSNetworkManagerAddressPrefixItem[]>] [-SourcePortRange <String[]>] + [-DestinationPortRange <String[]>] -Priority <Int32> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Default +``` +New-AzNetworkManagerSecurityAdminRule -Name <String> -RuleCollectionName <String> + -SecurityAdminConfigurationName <String> -NetworkManagerName <String> -ResourceGroupName <String> + -Flag <String> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerSecurityAdminRule** cmdlet creates a security admin rule. + +## EXAMPLES + +### Example 1: Create Custom Security Admin Rule +```powershell +$sourceAddressPrefix = New-AzNetworkManagerAddressPrefixItem -AddressPrefix "Internet" -AddressPrefixType "ServiceTag" +$destinationAddressPrefix = New-AzNetworkManagerAddressPrefixItem -AddressPrefix "10.0.0.1" -AddressPrefixType "IPPrefix" +$sourcePortList = @("100") +$destinationPortList = @("99") +New-AzNetworkManagerSecurityAdminRule -ResourceGroupName "psResourceGroup" -NetworkManagerName "psNetworkManager" -ConfigName "psSecurityAdminConfig" -RuleCollectionName "psRuleCollection" -Name "psRule" -Description "TestDescription" -Protocol "TCP" -Direction "Inbound" -Access "Allow" -Priority 100 -SourcePortRange $sourcePortList -DestinationPortRange $destinationPortList -SourceAddressPrefix $sourceAddressPrefix -DestinationAddressPrefix $destinationAddressPrefix +``` + +```output +Protocol : Tcp +Direction : Inbound +Sources : {Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerAddressPrefixItem} +Destinations : {Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerAddressPrefixItem} +SourcePortRanges : {100} +DestinationPortRanges : {99} +Access : Allow +Priority : 100 +SourcesText : [ + { + "AddressPrefix": "Internet", + "AddressPrefixType": "ServiceTag" + } + ] +DestinationsText : [ + { + "AddressPrefix": "10.0.0.1", + "AddressPrefixType": "IPPrefix" + } + ] +SourcePortRangesText : [ + "100" + ] +DestinationPortRangesText : [ + "99" + ] +DisplayName : +Description : TestDescription +Type : Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-08T00:39:56.4512419Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-08T00:39:56.4512419Z" + } +Name : psRule +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/securityAdminConfigurations/psSecurityAdminConfig/ruleCollections/psRuleCollection/rules/psRule +``` + +Creates a security admin rule. + +## PARAMETERS + +### -Access +Access of Rule. + +```yaml +Type: System.String +Parameter Sets: Custom +Aliases: +Accepted values: Allow, Deny, AlwaysAllow + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description. + +```yaml +Type: System.String +Parameter Sets: Custom +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DestinationAddressPrefix +Destination Address Prefixes. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerAddressPrefixItem[] +Parameter Sets: Custom +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DestinationPortRange +Destination Port Ranges. + +```yaml +Type: System.String[] +Parameter Sets: Custom +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Direction +Direction of Rule. + +```yaml +Type: System.String +Parameter Sets: Custom +Aliases: +Accepted values: Inbound, Outbound + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Flag +Default Flag Type. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Priority +Priority of Rule. + +```yaml +Type: System.Int32 +Parameter Sets: Custom +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocol +Protocol of Rule. + +```yaml +Type: System.String +Parameter Sets: Custom +Aliases: +Accepted values: Tcp, Udp, Icmp, Esp, Any, Ah + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleCollectionName +The network manager security admin rule collection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SecurityAdminConfigurationName +The network manager security admin configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConfigName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SourceAddressPrefix +Source Address Prefixes. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerAddressPrefixItem[] +Parameter Sets: Custom +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourcePortRange +Source Port Ranges. + +```yaml +Type: System.String[] +Parameter Sets: Custom +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerAddressPrefixItem[] + +### System.String[] + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityBaseAdminRule + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerSecurityAdminRule](./Get-AzNetworkManagerSecurityAdminRule.md) + +[Remove-AzNetworkManagerSecurityAdminRule](./Remove-AzNetworkManagerSecurityAdminRule.md) + +[Set-AzNetworkManagerSecurityAdminRule](./Set-AzNetworkManagerSecurityAdminRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerSecurityAdminRuleCollection.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerSecurityAdminRuleCollection.md new file mode 100644 index 0000000000..890fca0d91 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerSecurityAdminRuleCollection.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanagersecurityadminrulecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerSecurityAdminRuleCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerSecurityAdminRuleCollection.md +--- + +# New-AzNetworkManagerSecurityAdminRuleCollection + +## SYNOPSIS +Creates a security admin rule collection. + +## SYNTAX + +``` +New-AzNetworkManagerSecurityAdminRuleCollection -Name <String> -SecurityAdminConfigurationName <String> + -NetworkManagerName <String> -ResourceGroupName <String> [-Description <String>] + -AppliesToGroup <PSNetworkManagerSecurityGroupItem[]> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerSecurityAdminConfiguration** cmdlet creates a security admin rule collection. + +## EXAMPLES + +### Example 1 +```powershell +$groupItem = New-AzNetworkManagerSecurityGroupItem -NetworkGroupId "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup" +$configGroup = @($groupItem) +New-AzNetworkManagerSecurityAdminRuleCollection -ResourceGroupName "psResourceGroup" -NetworkManagerName "psNetworkManager" -ConfigName "psSecurityAdminConfig" -Name "psRuleCollection" -AppliesToGroup $configGroup +``` + +```output +AppliesToGroups : {/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup} +AppliesToGroupsText : [ + { + "NetworkGroupId": + "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup" + } + ] +DisplayName : +Description : +Type : Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-08T00:34:32.030751Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-08T00:34:32.030751Z" + } +Name : psRuleCollection +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/securityAdminConfigurations/psSecurityAdminConfig/ruleCollections/psRuleCollection +``` + +Creates a security admin rule collection with a network group member. + +## PARAMETERS + +### -AppliesToGroup +Applies To Groups. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityGroupItem[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SecurityAdminConfigurationName +The network manager security admin configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConfigName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityGroupItem[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityAdminRuleCollection + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerSecurityGroupItem](./New-AzNetworkManagerSecurityGroupItem.md) + +[Get-AzNetworkManagerSecurityAdminRuleCollection](./Get-AzNetworkManagerSecurityAdminRuleCollection.md) + +[Remove-AzNetworkManagerSecurityAdminRuleCollection](./Remove-AzNetworkManagerSecurityAdminRuleCollection.md) + +[Set-AzNetworkManagerSecurityAdminRuleCollection](./Set-AzNetworkManagerSecurityAdminRuleCollection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerSecurityGroupItem.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerSecurityGroupItem.md new file mode 100644 index 0000000000..f040dd4ab4 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerSecurityGroupItem.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanagersecuritygroupitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerSecurityGroupItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerSecurityGroupItem.md +--- + +# New-AzNetworkManagerSecurityGroupItem + +## SYNOPSIS +Creates a security group item. + +## SYNTAX + +``` +New-AzNetworkManagerSecurityGroupItem -NetworkGroupId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerSecurityGroupItem** cmdlet creates a security group item. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetworkManagerSecurityGroupItem -NetworkGroupId "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup" +``` + +```output +NetworkGroupId +-------------- +/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup +``` + +Creates a security group item. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkGroupId +Network Group Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityGroupItem + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerSecurityAdminRuleCollection](./New-AzNetworkManagerSecurityAdminRuleCollection.md) diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerStaticMember.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerStaticMember.md new file mode 100644 index 0000000000..8ecc35a12d --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerStaticMember.md @@ -0,0 +1,226 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanagerstaticmember +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerStaticMember.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerStaticMember.md +--- + +# New-AzNetworkManagerStaticMember + +## SYNOPSIS +Creates a network manager static member. + +## SYNTAX + +``` +New-AzNetworkManagerStaticMember -Name <String> -NetworkManagerName <String> -NetworkGroupName <String> + -ResourceGroupName <String> -ResourceId <String> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerStaticMember** cmdlet creates a network manager static member. + +## EXAMPLES + +### Example 1 +```powershell +$vnetId = "/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884/resourceGroups/PowerShellTestResources/providers/Microsoft.Network/virtualNetworks/powerShellTestVnet" +New-AzNetworkManagerStaticMember -ResourceGroupName "psResourceGroup" -NetworkManagerName "psNetworkManager" -NetworkGroupName "psNetworkGroup" -Name "psStaticMember" -ResourceId $vnetId +``` + +```output +ResourceId : /subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884/resourceGroups/PowerShellTestResources/providers/Microsoft.Network/virtualNetworks/powerShellTestVnet +DisplayName : +Description : +Type : Microsoft.Network/networkManagers/networkGroups/staticMembers +ProvisioningState : Updating +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-08T00:13:22.2067814Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-08T00:13:22.2067814Z" + } +Name : psStaticMember +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup/staticMembers/psStaticMember +``` + +Creates a network manager static member with a vnet resource. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkGroupName +The network manager group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerStaticMember + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerStaticMember](./Get-AzNetworkManagerStaticMember.md) + +[Remove-AzNetworkManagerStaticMember](./Remove-AzNetworkManagerStaticMember.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkManagerSubscriptionConnection.md b/azps-10.1.0/Az.Network/New-AzNetworkManagerSubscriptionConnection.md new file mode 100644 index 0000000000..175a9f12b7 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkManagerSubscriptionConnection.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkmanagersubscriptionconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerSubscriptionConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkManagerSubscriptionConnection.md +--- + +# New-AzNetworkManagerSubscriptionConnection + +## SYNOPSIS +Creates a network manager subscription connection. + +## SYNTAX + +``` +New-AzNetworkManagerSubscriptionConnection -Name <String> -NetworkManagerId <String> [-Description <String>] + [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkManagerSubscriptionConnection** cmdlet creates a network manager subscription connection. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetworkManagerSubscriptionConnection -Name "subConnection" -NetworkManagerId "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager" -Description "SampleDescription" +``` + +```output +NetworkManagerId : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager +ConnectionState : Pending +DisplayName : +Description : SampleDescription +Type : Microsoft.Network/networkManagerConnections +ProvisioningState : +SystemData : +SystemDataText : null +Name : subConnection +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/providers/Microsoft.Network/networkManagerConnections/subConnection +``` + +Creates a network manager connection to a subscription. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkManagerId +Network Manager Id of the resource you'd like to manage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnection + +## NOTES + +## RELATED LINKS + +[Set-AzNetworkManagerManagementGroupConnection](./Set-AzNetworkManagerManagementGroupConnection.md) + +[Get-AzNetworkManagerManagementGroupConnection](./Get-AzNetworkManagerManagementGroupConnection.md) + +[Remove-AzNetworkManagerManagementGroupConnection](./Remove-AzNetworkManagerManagementGroupConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkProfile.md b/azps-10.1.0/Az.Network/New-AzNetworkProfile.md new file mode 100644 index 0000000000..bc6c2da447 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkProfile.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkProfile.md +--- + +# New-AzNetworkProfile + +## SYNOPSIS +Creates a new network profile. + +## SYNTAX + +``` +New-AzNetworkProfile -ResourceGroupName <String> -Name <String> [-Location <String>] [-Tag <Hashtable>] + [-ContainerNicConfig <PSContainerNetworkInterfaceConfiguration[]>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkProfile** cmdlet creates a new network profile top level resource. + +## EXAMPLES + +### Example 1 +```powershell +$networkProfile = New-AzNetworkProfile -Name np1 -ResourceGroupName rg1 -Location westus +``` + +This creates a new network profile top level resource + +### Example 2 + +Creates a new network profile. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzNetworkProfile -ContainerNicConfig <PSContainerNetworkInterfaceConfiguration[]> -Location 'West US' -Name np1 -ResourceGroupName rg1 +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerNicConfig +The container network interface configurations to add to this network profile. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSContainerNetworkInterfaceConfiguration[] +Parameter Sets: (All) +Aliases: ContainerNetworkInterfaceConfiguration + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the network profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the network profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Network.Models.PSContainerNetworkInterfaceConfiguration[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkProfile + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkProfile](./Get-AzNetworkProfile.md) + +[Remove-AzNetworkProfile](./Remove-AzNetworkProfile.md) + +[Set-AzNetworkProfile](./Set-AzNetworkProfile.md) diff --git a/azps-10.1.0/Az.Network/New-AzNetworkSecurityGroup.md b/azps-10.1.0/Az.Network/New-AzNetworkSecurityGroup.md new file mode 100644 index 0000000000..1450b433c9 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkSecurityGroup.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: A420B3E7-2FE9-4D0B-803E-AC28E5F23C59 +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworksecuritygroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkSecurityGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkSecurityGroup.md +--- + +# New-AzNetworkSecurityGroup + +## SYNOPSIS +Creates a network security group. + +## SYNTAX + +``` +New-AzNetworkSecurityGroup -Name <String> -ResourceGroupName <String> -Location <String> [-FlushConnection] + [-SecurityRules <PSSecurityRule[]>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkSecurityGroup** cmdlet creates an Azure network security group. + +## EXAMPLES + +### Example 1: Create a new network security group +```powershell +New-AzNetworkSecurityGroup -Name "nsg1" -ResourceGroupName "rg1" -Location "westus" +``` + +This command creates a new Azure network security group named "nsg1" in resource group "rg1" in location "westus". + +### Example 2: Create a detailed network security group +```powershell +$rule1 = New-AzNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" ` + -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix ` + Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 + +$rule2 = New-AzNetworkSecurityRuleConfig -Name web-rule -Description "Allow HTTP" ` + -Access Allow -Protocol Tcp -Direction Inbound -Priority 101 -SourceAddressPrefix ` + Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 80 + +$nsg = New-AzNetworkSecurityGroup -ResourceGroupName TestRG -Location westus -Name ` + "NSG-FrontEnd" -SecurityRules $rule1,$rule2 +``` + +Step:1 Create a security rule allowing access from the Internet to port 3389.<br> +Step:2 Create a security rule allowing access from the Internet to port 80.<br> +Step:3 Add the rules created above to a new NSG named NSG-FrontEnd.<br> + +### Example 3: Create a new network security group with flush connection +```powershell +New-AzNetworkSecurityGroup -Name "nsg1" -ResourceGroupName "rg1" -Location "westus" -FlushConnection +``` + +This command creates a new Azure network security group named "nsg1" in resource group "rg1" in location "westus" and enables flushing of connection. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlushConnection +When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updated. +Initial enablement will trigger re-evaluation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the region for which to create a network security group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network security group to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet creates a network security group in the resource group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecurityRules +Specifies a list of network security rule objects to create in a network security group. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSecurityRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSSecurityRule[] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkSecurityGroup](./Get-AzNetworkSecurityGroup.md) + +[Remove-AzNetworkSecurityGroup](./Remove-AzNetworkSecurityGroup.md) + +[Set-AzNetworkSecurityGroup](./Set-AzNetworkSecurityGroup.md) diff --git a/azps-10.1.0/Az.Network/New-AzNetworkSecurityRuleConfig.md b/azps-10.1.0/Az.Network/New-AzNetworkSecurityRuleConfig.md new file mode 100644 index 0000000000..454e031cb4 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkSecurityRuleConfig.md @@ -0,0 +1,339 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 633FB5C9-BEB3-42A3-AF4F-A54CC3F9E0F7 +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworksecurityruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkSecurityRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkSecurityRuleConfig.md +--- + +# New-AzNetworkSecurityRuleConfig + +## SYNOPSIS +Creates a network security rule configuration. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzNetworkSecurityRuleConfig -Name <String> [-Description <String>] [-Protocol <String>] + [-SourcePortRange <String[]>] [-DestinationPortRange <String[]>] [-SourceAddressPrefix <String[]>] + [-DestinationAddressPrefix <String[]>] [-SourceApplicationSecurityGroup <PSApplicationSecurityGroup[]>] + [-DestinationApplicationSecurityGroup <PSApplicationSecurityGroup[]>] [-Access <String>] [-Priority <Int32>] + [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzNetworkSecurityRuleConfig -Name <String> [-Description <String>] [-Protocol <String>] + [-SourcePortRange <String[]>] [-DestinationPortRange <String[]>] [-SourceAddressPrefix <String[]>] + [-DestinationAddressPrefix <String[]>] [-SourceApplicationSecurityGroupId <String[]>] + [-DestinationApplicationSecurityGroupId <String[]>] [-Access <String>] [-Priority <Int32>] + [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkSecurityRuleConfig** cmdlet creates an Azure network security rule configuration for a network security group. + +## EXAMPLES + +### Example 1: Create a network security rule to allow RDP +```powershell +$rule1 = New-AzNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" ` + -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix ` + Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 +``` + +This command creates a security rule allowing access from the Internet to port 3389 + +### Example 2: Create a network security rule that allows HTTP +```powershell +$rule2 = New-AzNetworkSecurityRuleConfig -Name web-rule -Description "Allow HTTP" ` + -Access Allow -Protocol Tcp -Direction Inbound -Priority 101 -SourceAddressPrefix ` + Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 80 +``` + +This command creates a security rule allowing access from the Internet to port 80 + +## PARAMETERS + +### -Access +Specifies whether network traffic is allowed or denied. +The acceptable values for this parameter are: Allow and Deny. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description of the network security rule configuration to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationAddressPrefix +Specifies a destination address prefix. +The acceptable values for this parameter are: +- A Classless Interdomain Routing (CIDR) address +- A destination IP address range +- A wildcard character (*) to match any IP address +You can use tags such as VirtualNetwork, AzureLoadBalancer, and Internet. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationApplicationSecurityGroup +The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationApplicationSecurityGroupId +The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPortRange +Specifies a destination port or range. +The acceptable values for this parameter are: +- An integer +- A range of integers between 0 and 65535 +- A wildcard character (*) to match any port + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Specifies whether a rule is evaluated on incoming or outgoing traffic. +The acceptable values for this parameter are: Inbound and Outbound. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Inbound, Outbound + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network security rule configuration that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Specifies the priority of a rule configuration. +The acceptable values for this parameter are: An integer between 100 and 4096. +The priority number must be unique for each rule in the collection. +The lower the priority number, the higher the priority of the rule. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the network protocol that a new rule configuration applies to. +The acceptable values for this parameter are: +- Tcp +- Udp +- wildcard character (*) to match both. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Tcp, Udp, Icmp, Esp, Ah, * + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceAddressPrefix +Specifies a source address prefix. +The acceptable values for this parameter are: +- A CIDR +- A source IP range +- A wildcard character (*) to match any IP address. +You can also use tags such as VirtualNetwork, AzureLoadBalancer and Internet. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceApplicationSecurityGroup +The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceApplicationSecurityGroupId +The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourcePortRange +Specifies the source port or range. +The acceptable values for this parameter are: +- An integer +- A range of integers between 0 and 65535 +- A wildcard character (*) to match any port + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSSecurityRule + +## NOTES + +## RELATED LINKS + +[Add-AzNetworkSecurityRuleConfig](./Add-AzNetworkSecurityRuleConfig.md) + +[Get-AzNetworkSecurityRuleConfig](./Get-AzNetworkSecurityRuleConfig.md) + +[Remove-AzNetworkSecurityRuleConfig](./Remove-AzNetworkSecurityRuleConfig.md) + +[Set-AzNetworkSecurityRuleConfig](./Set-AzNetworkSecurityRuleConfig.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzNetworkVirtualAppliance.md b/azps-10.1.0/Az.Network/New-AzNetworkVirtualAppliance.md new file mode 100644 index 0000000000..d7dc104ec1 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkVirtualAppliance.md @@ -0,0 +1,362 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkvirtualappliance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkVirtualAppliance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkVirtualAppliance.md +--- + +# New-AzNetworkVirtualAppliance + +## SYNOPSIS +Create a Network Virtual Appliance resource. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +New-AzNetworkVirtualAppliance -Name <String> -ResourceGroupName <String> -Location <String> + -VirtualHubId <String> -Sku <PSVirtualApplianceSkuProperties> -VirtualApplianceAsn <Int32> + [-Identity <PSManagedServiceIdentity>] [-BootStrapConfigurationBlob <String[]>] + [-CloudInitConfigurationBlob <String[]>] [-CloudInitConfiguration <String>] [-Tag <Hashtable>] [-Force] + [-AsJob] [-AdditionalNic <PSVirtualApplianceAdditionalNicProperties[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +New-AzNetworkVirtualAppliance -ResourceId <String> -Location <String> -VirtualHubId <String> + -Sku <PSVirtualApplianceSkuProperties> -VirtualApplianceAsn <Int32> [-Identity <PSManagedServiceIdentity>] + [-BootStrapConfigurationBlob <String[]>] [-CloudInitConfigurationBlob <String[]>] + [-CloudInitConfiguration <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-AdditionalNic <PSVirtualApplianceAdditionalNicProperties[]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNetworkVirtualAppliance** command creates a Network Virtual Appliance(NVA) resource in Azure. + +## EXAMPLES + +### Example 1 +```powershell +$sku=New-AzVirtualApplianceSkuProperty -VendorName "barracudasdwanrelease" -BundledScaleUnit 1 -MarketPlaceVersion 'latest' + +$hub=Get-AzVirtualHub -ResourceGroupName testrg -Name hub + +$nva=New-AzNetworkVirtualAppliance -ResourceGroupName testrg -Name nva -Location eastus2 -VirtualApplianceAsn 1270 -VirtualHubId $hub.Id -Sku $sku -CloudInitConfiguration "echo Hello World!" +``` + +Creates a new Network Virtual Appliance resource in resource group: testrg. + +### Example 2 +```powershell +$sku=New-AzVirtualApplianceSkuProperty -VendorName "ciscosdwantest" -BundledScaleUnit 4 -MarketPlaceVersion '17.6.03' + +$hub=Get-AzVirtualHub -ResourceGroupName testrg -Name hub + +$additionalNic=New-AzVirtualApplianceAdditionalNicProperty -NicName "sdwan" -HasPublicIp $true + +$nva=New-AzNetworkVirtualAppliance -ResourceGroupName testrg -Name nva -Location eastus2 -VirtualApplianceAsn 65222 -VirtualHubId $hub.Id -Sku $sku -CloudInitConfiguration "echo Hello World!" -AdditionalNic $additionalNic +``` + +Creates a new Network Virtual Appliance resource in resource group: testrg with additional nic "sdwan" and a public IP attached to "sdwan" nic. + +## PARAMETERS + +### -AdditionalNic +The AdditionalNic Properties of the Virtual Appliance. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceAdditionalNicProperties[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BootStrapConfigurationBlob +The Bootstrap configuration blob URL. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CloudInitConfiguration +The Cloudinit configuration as plain text. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CloudInitConfigurationBlob +The Cloudinit configuration blob storage URL. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Managed identity. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +The public IP address location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +The Sku of the Virtual Appliance. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceSkuProperties +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualApplianceAsn +The ASN number of the Virtual Appliance. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualHubId +The Resource Id of the Virtual Hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceSkuProperties + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity + +### System.String[] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualAppliance + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcher.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcher.md new file mode 100644 index 0000000000..029d983683 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcher.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatcher +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcher.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcher.md +--- + +# New-AzNetworkWatcher + +## SYNOPSIS +Creates a new Network Watcher resource. + +## SYNTAX + +``` +New-AzNetworkWatcher -Name <String> -ResourceGroupName <String> -Location <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzNetworkWatcher cmdlet creates a new Network Watcher resource. + +## EXAMPLES + +### Example 1: Create a Network Watcher +```powershell +New-AzResourceGroup -Name NetworkWatcherRG -Location westcentralus +New-AzNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroupName NetworkWatcherRG +``` + +```output +Name : NetworkWatcher_westcentralus +Id : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_westcentralus +Etag : W/"7cf1f2fe-8445-4aa7-9bf5-c15347282c39" +Location : westcentralus +Tags : +ProvisioningState : Succeeded +``` + +This example creates a new Network Watcher inside a newly created Resource Group. Note that only +one Network Watcher can be created per region per subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The network watcher name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitor.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitor.md new file mode 100644 index 0000000000..404423d5bb --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitor.md @@ -0,0 +1,463 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatcherconnectionmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitor.md +--- + +# New-AzNetworkWatcherConnectionMonitor + +## SYNOPSIS +Creates a connection monitor resource. + +## SYNTAX + +### SetByName (Default) +``` +New-AzNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String> + -SourceResourceId <String> [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] + [-DestinationResourceId <String>] -DestinationPort <Int32> [-DestinationAddress <String>] [-ConfigureOnly] + [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByResource +``` +New-AzNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> -Name <String> + -SourceResourceId <String> [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] + [-DestinationResourceId <String>] -DestinationPort <Int32> [-DestinationAddress <String>] [-ConfigureOnly] + [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByResourceV2 +``` +New-AzNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> -Name <String> + -TestGroup <PSNetworkWatcherConnectionMonitorTestGroupObject[]> + [-Output <PSNetworkWatcherConnectionMonitorOutputObject[]>] [-Note <String>] [-Tag <Hashtable>] [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByNameV2 +``` +New-AzNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String> + -TestGroup <PSNetworkWatcherConnectionMonitorTestGroupObject[]> + [-Output <PSNetworkWatcherConnectionMonitorOutputObject[]>] [-Note <String>] [-Tag <Hashtable>] [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +New-AzNetworkWatcherConnectionMonitor -Location <String> -Name <String> -SourceResourceId <String> + [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] [-DestinationResourceId <String>] + -DestinationPort <Int32> [-DestinationAddress <String>] [-ConfigureOnly] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocationV2 +``` +New-AzNetworkWatcherConnectionMonitor -Location <String> -Name <String> + -TestGroup <PSNetworkWatcherConnectionMonitorTestGroupObject[]> + [-Output <PSNetworkWatcherConnectionMonitorOutputObject[]>] [-Note <String>] [-Tag <Hashtable>] [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByConnectionMonitorV2Object +``` +New-AzNetworkWatcherConnectionMonitor -ConnectionMonitor <PSNetworkWatcherConnectionMonitorObject> [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzNetworkWatcherConnectionMonitor cmdlet creates a connection monitor resource for specified source and destination (SingleSourcedestination connection monitor) or set of test groups (MultiEndpointConnectionMonitor). + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetworkWatcherConnectionMonitor -NetworkWatcher $nw -Name cm -SourceResourceId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RgCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm -DestinationAddress bing.com -DestinationPort 80 +``` + +```output +Name : cm +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGro + ups/NetworkWatcherRG/providers/Microsoft.Network/networkWatcher + s/NetworkWatcher_centraluseuap/connectionMonitors/t1 +Etag : W/"e86b28cf-b907-4475-a8b7-34d310367694" +ProvisioningState : Succeeded +Source : { + "ResourceId": "/subscriptions/00000000-0000-0000-0000-0000000 + 00000/resourceGroups/RgCentralUSEUAP/providers/Microsoft + .Compute/virtualMachines/vm", + "Port": 0 + } +Destination : { + "Address": "bing.com", + "Port": 80 + } +MonitoringIntervalInSeconds : 60 +AutoStart : True +StartTime : 1/12/2018 7:13:11 PM +MonitoringStatus : Running +Location : centraluseuap +Type : Microsoft.Network/networkWatchers/connectionMonitors +Tags : {} +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigureOnly +Configure connection monitor, but do not start it + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionMonitor +Connection monitor object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorObject +Parameter Sets: SetByConnectionMonitorV2Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationAddress +Address of the connection monitor destination (IP or domain name). + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPort +The destination port used by connection monitor. + +```yaml +Type: System.Int32 +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationResourceId +The ID of the resource used as the destination by connection monitor. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation, SetByLocationV2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoringIntervalInSeconds +Monitoring interval in seconds. Default value is 60 seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The connection monitor name. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByResourceV2, SetByNameV2, SetByLocation, SetByLocationV2 +Aliases: ConnectionMonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource, SetByResourceV2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByNameV2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +Notes associated with connection monitor. + +```yaml +Type: System.String +Parameter Sets: SetByResourceV2, SetByNameV2, SetByLocationV2 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Output +Describes a connection monitor output destinations. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorOutputObject[] +Parameter Sets: SetByResourceV2, SetByNameV2, SetByLocationV2 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByNameV2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourcePort +The source port used by connection monitor. + +```yaml +Type: System.Int32 +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceResourceId +The ID of the resource used as the source by connection monitor. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetByName, SetByResource, SetByResourceV2, SetByNameV2, SetByLocation, SetByLocationV2 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestGroup +The list of test groups. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorTestGroupObject[] +Parameter Sets: SetByResourceV2, SetByNameV2, SetByLocationV2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorTestGroupObject, Microsoft.Azure.PowerShell.Cmdlets.Network, Version=2.2.2.0, Culture=neutral, PublicKeyToken=null]] + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorOutputObject, Microsoft.Azure.PowerShell.Cmdlets.Network, Version=2.2.2.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResultV1 + +### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResultV2 + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorEndpointObject.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorEndpointObject.md new file mode 100644 index 0000000000..ec0a5f8ef9 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorEndpointObject.md @@ -0,0 +1,395 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatcherconnectionmonitorendpointobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorEndpointObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorEndpointObject.md +--- + +# New-AzNetworkWatcherConnectionMonitorEndpointObject + +## SYNOPSIS +Creates connection monitor endpoint. + +## SYNTAX + +### AzureVM +``` +New-AzNetworkWatcherConnectionMonitorEndpointObject -Name <String> [-AzureVM] -ResourceId <String> + [-Address <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureVNet +``` +New-AzNetworkWatcherConnectionMonitorEndpointObject -Name <String> [-AzureVNet] -ResourceId <String> + [-IncludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>] + [-ExcludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>] [-CoverageLevel <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureSubnet +``` +New-AzNetworkWatcherConnectionMonitorEndpointObject -Name <String> [-AzureSubnet] -ResourceId <String> + [-ExcludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>] [-CoverageLevel <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ExternalAddress +``` +New-AzNetworkWatcherConnectionMonitorEndpointObject -Name <String> [-ExternalAddress] -Address <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MMAWorkspaceMachine +``` +New-AzNetworkWatcherConnectionMonitorEndpointObject -Name <String> [-MMAWorkspaceMachine] -ResourceId <String> + -Address <String> [-IncludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MMAWorkspaceNetwork +``` +New-AzNetworkWatcherConnectionMonitorEndpointObject -Name <String> [-MMAWorkspaceNetwork] -ResourceId <String> + -IncludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]> + [-ExcludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>] [-CoverageLevel <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureVMSS +``` +New-AzNetworkWatcherConnectionMonitorEndpointObject -Name <String> [-AzureVMSS] -ResourceId <String> + [-IncludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>] + [-ExcludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>] [-CoverageLevel <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureArcVM +``` +New-AzNetworkWatcherConnectionMonitorEndpointObject -Name <String> [-AzureArcVM] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +New-AzNetworkWatcherConnectionMonitorEndpointObject cmdlet creates connection monitor endpoint. + +## EXAMPLES + +### Example 1 +```powershell +$MySrcResourceId1 = "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourceGroup/providers/Microsoft.OperationalInsights/workspaces/myworkspace" +$SrcEndpointScopeItem1 = New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject -Address "WIN-P0HGNDO2S1B" +$SourceEndpointObject1 = New-AzNetworkWatcherConnectionMonitorEndpointObject -Name "workspaceEndpoint" -MMAWorkspaceMachine -ResourceId $MySrcResourceId1 -IncludeItem $SrcEndpointScopeItem1 +``` + +```output +Name : workspaceEndpoint +Type : MMAWorkspaceMachine +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourceGroup/providers/Microsoft.OperationalInsights/workspaces/myworkspace +Address : +Scope : { + "Include": [ + { + "Address": "WIN-P0HGNDO2S1B" + } + ] + } +``` + +## PARAMETERS + +### -Address +Address of the connection monitor endpoint (IP or domain name). + +```yaml +Type: System.String +Parameter Sets: AzureVM +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ExternalAddress, MMAWorkspaceMachine +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureArcVM +AzureArc VM endpoint switch + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureArcVM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureSubnet +Azure Subnet endpoint switch. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureSubnet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureVM +Azure VM endpoint switch. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureVM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureVMSS +Azure Virtual Machine Scale sets. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureVMSS +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureVNet +Azure Vnet endpoint switch. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureVNet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CoverageLevel +Test coverage for the endpoint. +Supported values are Default, Low, BelowAverage, Average, AboveAvergae, Full. + +```yaml +Type: System.String +Parameter Sets: AzureVNet, AzureSubnet, MMAWorkspaceNetwork, AzureVMSS +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeItem +List of items which need to be excluded from endpoint scope. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorEndpointScopeItem[] +Parameter Sets: AzureVNet, AzureSubnet, MMAWorkspaceNetwork, AzureVMSS +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalAddress +External Address endpoint switch. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ExternalAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeItem +List of items which need to be included into endpont scope. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorEndpointScopeItem[] +Parameter Sets: AzureVNet, MMAWorkspaceMachine, AzureVMSS +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorEndpointScopeItem[] +Parameter Sets: MMAWorkspaceNetwork +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MMAWorkspaceMachine +MMA Workspace Machine endpoint switch. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: MMAWorkspaceMachine +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MMAWorkspaceNetwork +MMA Workspace Network endpoint switch. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: MMAWorkspaceNetwork +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the connection monitor endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID of the connection monitor endpoint. + +```yaml +Type: System.String +Parameter Sets: AzureVM, AzureVNet, AzureSubnet, MMAWorkspaceMachine, MMAWorkspaceNetwork, AzureVMSS, AzureArcVM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorEndpointObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject.md new file mode 100644 index 0000000000..33ee80904d --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatcherconnectionmonitorendpointscopeitemobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject.md +--- + +# New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject + +## SYNOPSIS +Creates a connection monitor endpoint scope item. + +## SYNTAX + +``` +New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject [-DefaultProfile <IAzureContextContainer>] + -Address <String> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject cmdlet creates endpoint scope item. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject -Address "10.0.1.0/24" +``` + +## PARAMETERS + +### -Address +The address of the scope item. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorEndpointScopeItem + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorObject.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorObject.md new file mode 100644 index 0000000000..ce51de46da --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorObject.md @@ -0,0 +1,364 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatcherconnectionmonitorobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorObject.md +--- + +# New-AzNetworkWatcherConnectionMonitorObject + +## SYNOPSIS +Create a connection monitor V2 object. + +## SYNTAX + +### SetByResource +``` +New-AzNetworkWatcherConnectionMonitorObject -NetworkWatcher <PSNetworkWatcher> -Name <String> + [-TestGroup <PSNetworkWatcherConnectionMonitorTestGroupObject[]>] + [-Output <PSNetworkWatcherConnectionMonitorOutputObject[]>] [-Note <String>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByName +``` +New-AzNetworkWatcherConnectionMonitorObject -NetworkWatcherName <String> -ResourceGroupName <String> + -Name <String> [-TestGroup <PSNetworkWatcherConnectionMonitorTestGroupObject[]>] + [-Output <PSNetworkWatcherConnectionMonitorOutputObject[]>] [-Note <String>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +New-AzNetworkWatcherConnectionMonitorObject -Location <String> -Name <String> + [-TestGroup <PSNetworkWatcherConnectionMonitorTestGroupObject[]>] + [-Output <PSNetworkWatcherConnectionMonitorOutputObject[]>] [-Note <String>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzNetworkWatcherConnectionMonitorObject cmdlet creates a connection monitor V2 object. + +## EXAMPLES + +### Example 1 +```powershell +$cmtest = New-AzNetworkWatcherConnectionMonitorObject -Location westcentralus -Name cmV2test -TestGroup $testGroup1, $testGroup2 -Tag @{"name" = "value"} +$cmtest +``` + +```output +NetworkWatcherName : NetworkWatcher_westcentralus +ResourceGroupName : NetworkWatcherRG +Name : cmV2test +TestGroups : [ + { + "Name": "testGroup1", + "Disable": false, + "TestConfigurations": [ + { + "Name": "tcpTC", + "TestFrequencySec": 60, + "ProtocolConfiguration": { + "Port": 80, + "DisableTraceRoute": false + }, + "SuccessThreshold": { + "ChecksFailedPercent": 20, + "RoundTripTimeMs": 5 + } + }, + { + "Name": "icmpTC", + "TestFrequencySec": 30, + "PreferredIPVersion": "IPv4", + "ProtocolConfiguration": { + "DisableTraceRoute": true + } + } + ], + "Sources": [ + { + "Name": "MultiTierApp0(IrinaRGWestcentralus)", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/RGW + estcentralus/providers/Microsoft.Compute/virtualMachines/MultiTierApp0" + }, + { + "Name": "NPM-CommonEUS(er-lab)", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/er-lab/p + roviders/Microsoft.OperationalInsights/workspaces/NPM-CommonEUS", + "Filter": { + "Type": "Include", + "Items": [ + { + "Type": "AgentAddress", + "Address": "SEA-Cust50-VM01" + }, + { + "Type": "AgentAddress", + "Address": "WIN-P0HGNDO2S1B" + } + ] + } + } + ], + "Destinations": [ + { + "Name": "bingEndpoint", + "Address": "bing.com" + }, + { + "Name": "googleEndpoint", + "Address": "google.com" + } + ] + }, + { + "Name": "testGroup2", + "Disable": false, + "TestConfigurations": [ + { + "Name": "httpTC", + "TestFrequencySec": 120, + "ProtocolConfiguration": { + "Port": 443, + "Method": "GET", + "RequestHeaders": [ + { + "Name": "Allow", + "Value": "GET" + } + ], + "ValidStatusCodeRanges": [ + "2xx", + "300-308" + ], + "PreferHTTPS": true + }, + "SuccessThreshold": { + "ChecksFailedPercent": 20, + "RoundTripTimeMs": 30 + } + } + ], + "Sources": [ + { + "Name": "MultiTierApp0(IrinaRGWestcentralus)", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/IrinaRGW + estcentralus/providers/Microsoft.Compute/virtualMachines/MultiTierApp0" + } + ], + "Destinations": [ + { + "Name": "googleEndpoint", + "Address": "google.com" + } + ] + } + ] +Outputs : null +Notes : +Tags : { + "name": "value" + } +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The connection monitor name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConnectionMonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +Notes associated with connection monitor. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Output +Describes a connection monitor output destinations. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorOutputObject[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TestGroup +The list of test groups. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorTestGroupObject[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorOutputObject.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorOutputObject.md new file mode 100644 index 0000000000..6e24d94518 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorOutputObject.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatcherconnectionmonitoroutputobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorOutputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorOutputObject.md +--- + +# New-AzNetworkWatcherConnectionMonitorOutputObject + +## SYNOPSIS +Create connection monitor output destination object. + +## SYNTAX + +``` +New-AzNetworkWatcherConnectionMonitorOutputObject [-OutputType <String>] -WorkspaceResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzNetworkWatcherConnectionMonitorOutputObject cmdlet creates connection monitor output destination object. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetworkWatcherConnectionMonitorOutputObject -OutputType "workspace" -WorkspaceResourceId MyWSResourceId +``` + +```output +Type : "workspace" +WorkspaceSettings : { + "WorkspaceResourceId": "MyWSResourceId" + } +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputType +Connection monitor output destination type. Currently, only \"Workspace\" is supported. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +Log analytics workspace resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorOutputObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject.md new file mode 100644 index 0000000000..6bf25f49a3 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject.md @@ -0,0 +1,277 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatcherconnectionmonitorprotocolconfigurationobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject.md +--- + +# New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject + +## SYNOPSIS +Create protocol configuration used to perform test evaluation over TCP, HTTP or ICMP. + +## SYNTAX + +### TCP +``` +New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject [-TcpProtocol] -Port <UInt16> + [-DisableTraceRoute] [-DestinationPortBehavior <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### HTTP +``` +New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject [-HttpProtocol] [-Port <UInt16>] + [-Method <String>] [-Path <String>] [-RequestHeader <Hashtable>] [-ValidStatusCodeRange <String[]>] + [-PreferHTTPS] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ICMP +``` +New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject [-IcmpProtocol] [-DisableTraceRoute] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject cmdlet creates protocol configuration used to perform test evaluation over TCP, HTTP or ICMP. + +## EXAMPLES + +### Example 1 +```powershell +$TcpProtocolConfiguration = New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject -TcpProtocol -Port 80 -DisableTraceRoute +``` + +```output +Port : 80 +DisableTraceRoute : False +``` + +### Example 2 + +Create protocol configuration used to perform test evaluation over TCP, HTTP or ICMP. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject -IcmpProtocol +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPortBehavior +Destination port behavior. +Supported values are None, ListenIfAvailable. + +```yaml +Type: System.String +Parameter Sets: TCP +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableTraceRoute +Value indicating whether path evaluation with trace route should be disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: TCP, ICMP +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpProtocol +HTTP protocol switch. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: HTTP +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IcmpProtocol +ICMP protocol switch. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ICMP +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Method +The HTTP method to use. + +```yaml +Type: System.String +Parameter Sets: HTTP +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path component of the URI. +For instance, "/dir1/dir2". + +```yaml +Type: System.String +Parameter Sets: HTTP +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +The port to connect to. + +```yaml +Type: System.Nullable`1[System.UInt16] +Parameter Sets: TCP +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Nullable`1[System.UInt16] +Parameter Sets: HTTP +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferHTTPS +Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: HTTP +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestHeader +The HTTP headers to transmit with the request. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: HTTP +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TcpProtocol +TCP protocol switch. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: TCP +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidStatusCodeRange +HTTP status codes to consider successful. +For instance, "2xx,301-304,418". + +```yaml +Type: System.String[] +Parameter Sets: HTTP +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorTcpConfiguration + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorHttpConfiguration + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorIcmpConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorTestConfigurationObject.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorTestConfigurationObject.md new file mode 100644 index 0000000000..9914c260af --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorTestConfigurationObject.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatcherconnectionmonitortestconfigurationobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorTestConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorTestConfigurationObject.md +--- + +# New-AzNetworkWatcherConnectionMonitorTestConfigurationObject + +## SYNOPSIS +Create a connection monitor test configuration. + +## SYNTAX + +``` +New-AzNetworkWatcherConnectionMonitorTestConfigurationObject -Name <String> -TestFrequencySec <Int32> + -ProtocolConfiguration <PSNetworkWatcherConnectionMonitorProtocolConfiguration> + [-SuccessThresholdChecksFailedPercent <Int32>] [-SuccessThresholdRoundTripTimeMs <Double>] + [-PreferredIPVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzNetworkWatcherConnectionMonitorTestConfigurationObject cmdlet creates a connection monitor test configuration. + +## EXAMPLES + +### Example 1 +```powershell +$httpProtocolConfiguration = New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject -HttpProtocol -Port 443 -Method GET -RequestHeader @{"Allow" = "GET"} -ValidStatusCodeRange 2xx, 300-308 -PreferHTTPS +$httpTestConfiguration = New-AzNetworkWatcherConnectionMonitorTestConfigurationObject -Name httpTC -TestFrequencySec 120 -ProtocolConfiguration $httpProtocolConfiguration -SuccessThresholdChecksFailedPercent 20 -SuccessThresholdRoundTripTimeMs 30 +``` + +```output +Name : httpTC +TestFrequencySec : 120 +PreferredIPVersion : +ProtocolConfiguration : { + "Port": 443, + "Method": "GET", + "RequestHeaders": [ + { + "Name": "Allow", + "Value": "GET" + } + ], + "ValidStatusCodeRanges": [ + "2xx", + "300-308" + ], + "PreferHTTPS": true + } +SuccessThreshold : { + "ChecksFailedPercent": 20, + "RoundTripTimeMs": 30 + } +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the connection monitor test configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredIPVersion +The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtocolConfiguration +The parameters used to perform test evaluation over some protocol. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorProtocolConfiguration +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuccessThresholdChecksFailedPercent +The maximum percentage of failed checks permitted for a test to evaluate as successful. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuccessThresholdRoundTripTimeMs +The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestFrequencySec +The frequency of test evaluation, in seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: TestFrequency + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorTestConfigurationObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorTestGroupObject.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorTestGroupObject.md new file mode 100644 index 0000000000..c02cffee5a --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcherConnectionMonitorTestGroupObject.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatcherconnectionmonitortestgroupobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorTestGroupObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherConnectionMonitorTestGroupObject.md +--- + +# New-AzNetworkWatcherConnectionMonitorTestGroupObject + +## SYNOPSIS +Create a connection monitor test group. + +## SYNTAX + +``` +New-AzNetworkWatcherConnectionMonitorTestGroupObject -Name <String> + -TestConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorTestConfigurationObject]> + -Source <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorEndpointObject]> + -Destination <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorEndpointObject]> + [-Disable] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzNetworkWatcherConnectionMonitorTestGroupObject cmdlet creates a connection monitor test group. + +## EXAMPLES + +### Example 1: Create a test group with 2 testConfigurations, w source and 2 destination endpoints + +```powershell +$testGroup1 = New-AzNetworkWatcherConnectionMonitorTestGroupObject -Name testGroup1 -TestConfiguration $tcpTestConfiguration, $icmpTestConfiguration -Source $vmEndpoint, $workspaceEndpoint -Destination $bingEndpoint, $googleEndpoint +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +List of destination endpoints. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorEndpointObject] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disable +Flag indicating whether test group is disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The test group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +List of source endpoints. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorEndpointObject] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestConfiguration +List of test configuration. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorTestConfigurationObject] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorTestGroupObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcherFlowLog.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcherFlowLog.md new file mode 100644 index 0000000000..ecb61a55aa --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcherFlowLog.md @@ -0,0 +1,522 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatcherflowlog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherFlowLog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherFlowLog.md +--- + +# New-AzNetworkWatcherFlowLog + +## SYNOPSIS +Create or update a flow log resource for the specified network security group. + +## SYNTAX + +### SetByName (Default) +``` +New-AzNetworkWatcherFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String> + -TargetResourceId <String> -StorageId <String> -Enabled <Boolean> [-EnableRetention <Boolean>] + [-RetentionPolicyDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResource +``` +New-AzNetworkWatcherFlowLog -NetworkWatcher <PSNetworkWatcher> -Name <String> -TargetResourceId <String> + -StorageId <String> -Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] + [-FormatType <String>] [-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceWithTA +``` +New-AzNetworkWatcherFlowLog -NetworkWatcher <PSNetworkWatcher> -Name <String> -TargetResourceId <String> + -StorageId <String> -Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] + [-FormatType <String>] [-FormatVersion <Int32>] [-EnableTrafficAnalytics] + [-TrafficAnalyticsWorkspaceId <String>] [-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByNameWithTA +``` +New-AzNetworkWatcherFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String> + -TargetResourceId <String> -StorageId <String> -Enabled <Boolean> [-EnableRetention <Boolean>] + [-RetentionPolicyDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>] [-EnableTrafficAnalytics] + [-TrafficAnalyticsWorkspaceId <String>] [-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +New-AzNetworkWatcherFlowLog -Location <String> -Name <String> -TargetResourceId <String> -StorageId <String> + -Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>] + [-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetByLocationWithTA +``` +New-AzNetworkWatcherFlowLog -Location <String> -Name <String> -TargetResourceId <String> -StorageId <String> + -Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>] + [-FormatVersion <Int32>] [-EnableTrafficAnalytics] [-TrafficAnalyticsWorkspaceId <String>] + [-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +New-AzNetworkWatcherFlowLog command creates or updates a flow log resource for the specified network security group. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNetworkWatcherFlowLog -Location eastus -Name pstest -TargetResourceId /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/MyFlowLog/providers/Microsoft.Network/networkSecurityGroups/MyNSG -StorageId /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/FlowLogsV2Demo/providers/Microsoft.Storage/storageAccounts/MyStorage -Enabled $true -EnableRetention $true -RetentionPolicyDays 5 -FormatVersion 2 -EnableTrafficAnalytics -TrafficAnalyticsWorkspaceId /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourcegroups/flowlogsv2demo/providers/Microsoft.OperationalInsights/workspaces/MyWorkspace +``` + +```output +Name : pstest +Id : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NetworkWatcherRG/provid + ers/Microsoft.Network/networkWatchers/NetworkWatcher_eastus/FlowLogs/pstest +Etag : W/"f6047360-d797-4ca6-a9ec-28b5aec5c768" +ProvisioningState : Succeeded +Location : eastus +TargetResourceId : /subscriptions/56abfbd6-ec72-4ce9-831f-bc2b6f2c5505/resourceGroups/MyFlowLog/provide + rs/Microsoft.Network/networkSecurityGroups/MyNSG +StorageId : /subscriptions/56abfbd6-ec72-4ce9-831f-bc2b6f2c5505/resourceGroups/FlowLogsV2Demo/provider + s/Microsoft.Storage/storageAccounts/MySTorage +Enabled : True +RetentionPolicy : { + "Days": 5, + "Enabled": true + } +Format : { + "Type": "JSON", + "Version": 2 + } +FlowAnalyticsConfiguration : { + "networkWatcherFlowAnalyticsConfiguration": { + "enabled": true, + "workspaceId": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", + "workspaceRegion": "eastus", + "workspaceResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourcegr + oups/flowlogsv2demo/providers/Microsoft.OperationalInsights/workspaces/MyWorkspace", + "trafficAnalyticsInterval": 60 + } + } +``` + +### Example 2 +```powershell +New-AzNetworkWatcherFlowLog -Location eastus -Name pstest -TargetResourceId /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/MyFlowLog/providers/Microsoft.Network/networkSecurityGroups/MyNSG -StorageId /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/FlowLogsV2Demo/providers/Microsoft.Storage/storageAccounts/MyStorage -Enabled $false -EnableTrafficAnalytics:$false +``` + +```output +Name : pstest +Id : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NetworkWatcherRG/provid + ers/Microsoft.Network/networkWatchers/NetworkWatcher_eastus/FlowLogs/pstest +Etag : W/"f6047360-d797-4ca6-a9ec-28b5aec5c768" +ProvisioningState : Succeeded +Location : eastus +TargetResourceId : /subscriptions/56abfbd6-ec72-4ce9-831f-bc2b6f2c5505/resourceGroups/MyFlowLog/provide + rs/Microsoft.Network/networkSecurityGroups/MyNSG +StorageId : /subscriptions/56abfbd6-ec72-4ce9-831f-bc2b6f2c5505/resourceGroups/FlowLogsV2Demo/provider + s/Microsoft.Storage/storageAccounts/MySTorage +Enabled : False +RetentionPolicy : { + "Days": 0, + "Enabled": false + } +Format : { + "Type": "JSON", + "Version": 1 + } +FlowAnalyticsConfiguration : { + "networkWatcherFlowAnalyticsConfiguration": { + "enabled": false, + "trafficAnalyticsInterval": 60 + } + } +``` + +If you want to disable flowLog resource for which TrafficAnalytics is configured, it is necessary to disable TrafficAnalytics as well. It can be done like in the example 2. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Flag to enable/disable flow logging. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableRetention +Flag to enable/disable retention. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTrafficAnalytics +Flag to enable/disable TrafficAnalytics + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetByResourceWithTA, SetByNameWithTA, SetByLocationWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FormatType +The file type of flow log. +The only supported value now is 'JSON'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FormatVersion +The version (revision) of the flow log. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation, SetByLocationWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The flow log name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FlowLogName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource, SetByResourceWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByNameWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByNameWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicyDays +Number of days to retain flow log records. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageId +ID of the storage account which is used to store the flow log. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceId +ID of network security group to which flow log will be applied. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficAnalyticsInterval +The interval in minutes which would decide how frequently TA service should do flow analytics. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: SetByResourceWithTA, SetByNameWithTA, SetByLocationWithTA +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficAnalyticsWorkspaceId +Resource Id of the attached workspace. + +```yaml +Type: System.String +Parameter Sets: SetByResourceWithTA, SetByNameWithTA, SetByLocationWithTA +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSFlowLogResource + +## NOTES + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherFlowLog](./Get-AzNetworkWatcherFlowLog.md) + +[Set-AzNetworkWatcherFlowLog](./Set-AzNetworkWatcherFlowLog.md) + +[Remove-AzNetworkWatcherFlowLog](./Remove-AzNetworkWatcherFlowLog.md) diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcherNetworkConfigurationDiagnosticProfile.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcherNetworkConfigurationDiagnosticProfile.md new file mode 100644 index 0000000000..fcadcab109 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcherNetworkConfigurationDiagnosticProfile.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatchernetworkconfigurationdiagnosticprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherNetworkConfigurationDiagnosticProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherNetworkConfigurationDiagnosticProfile.md +--- + +# New-AzNetworkWatcherNetworkConfigurationDiagnosticProfile + +## SYNOPSIS +Creates a new network configuration diagnostic profile object. +This object is used to restrict the network configuration during a diagnostic session using the specified criteria. + +## SYNTAX + +``` +New-AzNetworkWatcherNetworkConfigurationDiagnosticProfile -Direction <String> -Protocol <String> + -Source <String> -Destination <String> -DestinationPort <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzNetworkWatcherNetworkConfigurationDiagnosticProfile cmdlet creates a new diagnostic profile object. +This object is used to restrict the network configuration during a network configuration diagnostic session using the specified criteria. + +## EXAMPLES + +### Example 1: Invoke network configuration diagnostic session for VM and specified network profile +```powershell +$profile = New-AzNetworkWatcherNetworkConfigurationDiagnosticProfile -Direction Inbound -Protocol Tcp -Source 10.1.1.4 -Destination * -DestinationPort 50 +Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic -Location eastus -TargetResourceId /subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgEastUS/providers/Microsoft.Compute/virtualMachines/vm1 -Profile $profile +``` + +```output +Results : [ + { + "Profile": { + "Direction": "Inbound", + "Protocol": "Tcp", + "Source": "10.1.1.4", + "Destination": "*", + "DestinationPort": "50" + }, + "NetworkSecurityGroupResult": { + "SecurityRuleAccessResult": "Allow", + "EvaluatedNetworkSecurityGroups": [ + { + "NetworkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/clean + upservice/providers/Microsoft.Network/networkSecurityGroups/rg-cleanupservice-nsg1", + "MatchedRule": { + "RuleName": "UserRule_Cleanuptool-Allow-4001", + "Action": "Allow" + }, + "RulesEvaluationResult": [ + { + "Name": "UserRule_Cleanuptool-Allow-100", + "ProtocolMatched": true, + "SourceMatched": false, + "SourcePortMatched": true, + "DestinationMatched": true, + "DestinationPortMatched": false + }, +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +Traffic destination. +Accepted values are: '*', IP Address/CIDR, Service Tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DestinationPort +Traffic destination port. +Accepted values are '*', port (for example, 3389) and port range (for example, 80-100). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Direction +The direction of the traffic. +Accepted values are 'Inbound' and 'Outbound' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Protocol +Protocol to be verified on. +Accepted values are '*', TCP, UDP. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Source +Traffic source. +Accepted values are '*', IP Address/CIDR, Service Tag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkConfigurationDiagnosticProfile + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, watcher, diagnostic, profile + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcherPacketCapture.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcherPacketCapture.md new file mode 100644 index 0000000000..cb710759e6 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcherPacketCapture.md @@ -0,0 +1,398 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatcherpacketcapture +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherPacketCapture.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherPacketCapture.md +--- + +# New-AzNetworkWatcherPacketCapture + +## SYNOPSIS +Creates a new packet capture resource and starts a packet capture session on a VM. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzNetworkWatcherPacketCapture -NetworkWatcher <PSNetworkWatcher> -PacketCaptureName <String> + -TargetVirtualMachineId <String> [-StorageAccountId <String>] [-StoragePath <String>] + [-LocalFilePath <String>] [-BytesToCapturePerPacket <Int32>] [-TotalBytesPerSession <UInt32>] + [-TimeLimitInSeconds <Int32>] [-Filter <PSPacketCaptureFilter[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByName +``` +New-AzNetworkWatcherPacketCapture -NetworkWatcherName <String> -ResourceGroupName <String> + -PacketCaptureName <String> -TargetVirtualMachineId <String> [-StorageAccountId <String>] + [-StoragePath <String>] [-LocalFilePath <String>] [-BytesToCapturePerPacket <Int32>] + [-TotalBytesPerSession <UInt32>] [-TimeLimitInSeconds <Int32>] [-Filter <PSPacketCaptureFilter[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +New-AzNetworkWatcherPacketCapture -Location <String> -PacketCaptureName <String> + -TargetVirtualMachineId <String> [-StorageAccountId <String>] [-StoragePath <String>] + [-LocalFilePath <String>] [-BytesToCapturePerPacket <Int32>] [-TotalBytesPerSession <UInt32>] + [-TimeLimitInSeconds <Int32>] [-Filter <PSPacketCaptureFilter[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzNetworkWatcherPacketCapture cmdlet creates a new packet capture resource and starts a packet capture session on a VM. +The length of the Packet Capture sessions can be configured via a time constraint or a size constraint. The amount of data captured for each packet can also be configured. +Filters can be applied to a given packet capture session, allowing you to customize the type of packets captured. Filters can restrict packets on local and remote IP addresses & address ranges, local and remote ports & port ranges, and the session level protocol to be captured. Filters are composable, and multiple filters can be applied to provide you with granularity of capture. + +## EXAMPLES + +### Example 1: Create a Packet Capture with multiple filters +```powershell +$nw = Get-AzResource | Where-Object {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } +$networkWatcher = Get-AzNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName + +$storageAccount = Get-AzStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 + +$filter1 = New-AzPacketCaptureFilterConfig -Protocol TCP -RemoteIPAddress "1.1.1.1-255.255.255" -LocalIPAddress "10.0.0.3" -LocalPort "1-65535" -RemotePort "20;80;443" +$filter2 = New-AzPacketCaptureFilterConfig -Protocol UDP +New-AzNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -TargetVirtualMachineId $vm.Id -PacketCaptureName "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSeconds 60 -Filter $filter1, $filter2 +``` + +In this example we create a packet capture named "PacketCaptureTest" with multiple filters and a time limit. Once the session is complete, it will be saved to the specified storage account. +Note: The Azure Network Watcher extension must be installed on the target virtual machine to create packet captures. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BytesToCapturePerPacket +Bytes to capture per packet. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filters for packet capture session. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPacketCaptureFilter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalFilePath +Local file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PacketCaptureName +The packet capture name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountId +Storage account Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StoragePath +Storage path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetVirtualMachineId +The target virtual machine ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TimeLimitInSeconds +Time limit in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TotalBytesPerSession +Total bytes per session. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPacketCaptureResult + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcherPacketCaptureV2.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcherPacketCaptureV2.md new file mode 100644 index 0000000000..bc96143e33 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcherPacketCaptureV2.md @@ -0,0 +1,573 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatcherpacketcapturev2 +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherPacketCaptureV2.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherPacketCaptureV2.md +--- + +# New-AzNetworkWatcherPacketCaptureV2 + +## SYNOPSIS +V2 Version of Packet Capture Cmdlet which creates a new packet capture resource and starts a packet capture session on a VM, VMSS or few instances of VMSS. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzNetworkWatcherPacketCaptureV2 -NetworkWatcher <PSNetworkWatcher> -Name <String> -TargetId <String> + [-StorageAccountId <String>] [-StoragePath <String>] [-LocalFilePath <String>] + [-BytesToCapturePerPacket <Int32>] [-TotalBytesPerSession <UInt32>] [-TimeLimitInSecond <Int32>] + [-Scope <PSPacketCaptureMachineScope>] [-TargetType <String>] [-Filter <PSPacketCaptureFilter[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByName +``` +New-AzNetworkWatcherPacketCaptureV2 -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String> + -TargetId <String> [-StorageAccountId <String>] [-StoragePath <String>] [-LocalFilePath <String>] + [-BytesToCapturePerPacket <Int32>] [-TotalBytesPerSession <UInt32>] [-TimeLimitInSecond <Int32>] + [-Scope <PSPacketCaptureMachineScope>] [-TargetType <String>] [-Filter <PSPacketCaptureFilter[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +New-AzNetworkWatcherPacketCaptureV2 -Location <String> -Name <String> -TargetId <String> + [-StorageAccountId <String>] [-StoragePath <String>] [-LocalFilePath <String>] + [-BytesToCapturePerPacket <Int32>] [-TotalBytesPerSession <UInt32>] [-TimeLimitInSecond <Int32>] + [-Scope <PSPacketCaptureMachineScope>] [-TargetType <String>] [-Filter <PSPacketCaptureFilter[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzNetworkWatcherPacketCaptureV2 cmdlet creates a new packet capture resource and starts a packet capture session on a VM, VMSS or few instances of VMSS. +The length of the Packet Capture sessions can be configured via a time constraint or a size constraint. The amount of data captured for each packet can also be configured. +Filters can be applied to a given packet capture session, allowing you to customize the type of packets captured. Filters can restrict packets on local and remote IP addresses & address ranges, local and remote ports & port ranges, and the session level protocol to be captured. Filters are composable, and multiple filters can be applied to provide you with granularity of capture. + +## EXAMPLES + +### Example 1: Create a Packet Capture on a VM +```powershell +$nw = Get-AzResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } +$networkWatcher = Get-AzNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName + +$storageAccount = Get-AzStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 + +$filter1 = New-AzPacketCaptureFilterConfig -Protocol TCP -RemoteIPAddress "1.1.1.1-255.255.255" -LocalIPAddress "10.0.0.3" -LocalPort "1-65535" -RemotePort "20;80;443" +$filter2 = New-AzPacketCaptureFilterConfig -Protocol UDP +New-AzNetworkWatcherPacketCaptureV2 -NetworkWatcher $networkWatcher -TargetId $vm.Id -TargetType "azurevm" -Name "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSecond 60 -Filter $filter1, $filter2 +``` + +```output +Name : PacketCaptureTest +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_eastus/packetCaptures/PacketCaptureTest +Etag : W/"0b3c52cb-aa63-4647-93d3-3221c13ccdd2" +ProvisioningState : Succeeded +Target : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoResourceGroup/providers/Microsoft.Compute/virtualMachines/SampleVM +TargetType : AzureVM +BytesToCapturePerPacket : 0 +TotalBytesPerSession : 1073741824 +TimeLimitInSeconds : 18000 +StorageLocation : { + "StorageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoResourceGroup/providers/Microsoft.Storage/storageAccounts/contosostorage123", + "StoragePath": "https://contosostorage123.blob.core.windows.net/network-watcher-logs/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/contosoResourceGroup/providers/microsoft.compute/virtualmachines/SampleVM/2022/07/21/packetcapture_09_20_07_166.cap" + } +Filters : [ + { + "Protocol": "TCP", + "RemoteIPAddress": "1.1.1.1-255.255.255", + "LocalIPAddress": "10.0.0.3", + "LocalPort": "1-65535", + "RemotePort": "20;80;443" + }, + { + "Protocol": "UDP", + "RemoteIPAddress": "", + "LocalIPAddress": "", + "LocalPort": "", + "RemotePort": "" + } + ] +Scope : { + "Include": [], + "Exclude": [] + } +``` + +In this example we create a packet capture named "PacketCaptureTest" with multiple filters and a time limit. Once the session is complete, it will be saved to the specified storage account. +Note: The Azure Network Watcher extension must be installed on the target virtual machine to create packet captures. + +### Example 2: Create a Packet Capture on a VMSS +```powershell +$nw = Get-AzResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } +$networkWatcher = Get-AzNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName + +$storageAccount = Get-AzStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 + +$filter1 = New-AzPacketCaptureFilterConfig -Protocol TCP -RemoteIPAddress "1.1.1.1-255.255.255" -LocalIPAddress "10.0.0.3" -LocalPort "1-65535" -RemotePort "20;80;443" +$filter2 = New-AzPacketCaptureFilterConfig -Protocol UDP +New-AzNetworkWatcherPacketCaptureV2 -NetworkWatcher $networkWatcher -TargetId $vmss.Id -TargetType "azurevmss" -Name "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSecond 60 -Filter $filter1, $filter2 +``` + +```output +Name : PacketCaptureTest +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_eastus/packetCaptures/PacketCaptureTest +Etag : W/"0b3c52cb-aa63-4647-93d3-3221c13ccdd2" +ProvisioningState : Succeeded +Target : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/SampleVMSS +TargetType : AzureVMSS +BytesToCapturePerPacket : 0 +TotalBytesPerSession : 1073741824 +TimeLimitInSeconds : 60 +StorageLocation : { + "StorageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoResourceGroup/providers/Microsoft.Storage/storageAccounts/contosostorage123", + "StoragePath": "https://contosostorage123.blob.core.windows.net/network-watcher-logs/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/contosoResourceGroup/providers/microsoft.compute/virtualmachinescalesets/SampleVMSS/2022/07/21/packetcapture_09_20_07_166.cap" + } +Filters : [ + { + "Protocol": "TCP", + "RemoteIPAddress": "1.1.1.1-255.255.255", + "LocalIPAddress": "10.0.0.3", + "LocalPort": "1-65535", + "RemotePort": "20;80;443" + }, + { + "Protocol": "UDP", + "RemoteIPAddress": "", + "LocalIPAddress": "", + "LocalPort": "", + "RemotePort": "" + } + ] +Scope : { + "Include": [], + "Exclude": [] + } +``` + +In this example we create a packet capture named "PacketCaptureTest" with multiple filters and a time limit. Once the session is complete, it will be saved to the specified storage account. +Note: The Azure Network Watcher extension must be installed on the target virtual machine scale set and all the respective instances adhering to the latest vmss model, to create packet captures. + +### Example 3: Create a Packet Capture on few Instances of VMSS +```powershell +$nw = Get-AzResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } +$networkWatcher = Get-AzNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName + +$storageAccount = Get-AzStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 + +$filter1 = New-AzPacketCaptureFilterConfig -Protocol TCP -RemoteIPAddress "1.1.1.1-255.255.255" -LocalIPAddress "10.0.0.3" -LocalPort "1-65535" -RemotePort "20;80;443" +$filter2 = New-AzPacketCaptureFilterConfig -Protocol UDP + +$instance1 = $vmssInstance1.Name +$instance2 = $vmssInstance2.Name +$scope = New-AzPacketCaptureScopeConfig -Include $instance1, $instance2 + +New-AzNetworkWatcherPacketCaptureV2 -NetworkWatcher $networkWatcher -TargetId $vmss.Id -TargetType "azurevmss" -Scope $scope -Name "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSecond 60 -Filter $filter1, $filter2 +``` + +```output +Name : PacketCaptureTest +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_eastus/packetCaptures/PacketCaptureTest +Etag : W/"0b3c52cb-aa63-4647-93d3-3221c13ccdd2" +ProvisioningState : Succeeded +Target : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/SampleVMSS +TargetType : AzureVMSS +BytesToCapturePerPacket : 0 +TotalBytesPerSession : 1073741824 +TimeLimitInSeconds : 18000 +StorageLocation : { + "StorageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoResourceGroup/providers/Microsoft.Storage/storageAccounts/contosostorage123", + "StoragePath": "https://contosostorage123.blob.core.windows.net/network-watcher-logs/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/contosoResourceGroup/providers/microsoft.compute/virtualmachinescalesets/SampleVMSS/2022/07/21/packetcapture_09_20_07_166.cap" + } +Filters : [ + { + "Protocol": "TCP", + "RemoteIPAddress": "1.1.1.1-255.255.255", + "LocalIPAddress": "10.0.0.3", + "LocalPort": "1-65535", + "RemotePort": "20;80;443" + }, + { + "Protocol": "UDP", + "RemoteIPAddress": "", + "LocalIPAddress": "", + "LocalPort": "", + "RemotePort": "" + } + ] +Scope : { + "Include": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/SampleVMSS/virtualMachines/0", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/SampleVMSS/virtualMachines/1" + ], + "Exclude": [] + } +``` + +In this example we create a packet capture named "PacketCaptureTest" with multiple filters and a time limit. Once the session is complete, it will be saved to the specified storage account. +Note: The Azure Network Watcher extension must be installed on the target virtual machine scale set and on the respective instances in include scope adhering to the latest vmss model, to create packet captures. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BytesToCapturePerPacket +Bytes to capture per packet. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filters for packet capture session. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPacketCaptureFilter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalFilePath +Local file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The packet capture name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PacketCaptureName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Scope of VMSS Instances to be Included or Excluded. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPacketCaptureMachineScope +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountId +Storage account Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StoragePath +Storage path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetId +The target virtual machine ID or virtual machine scale set ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetType +Target Type of the Resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeLimitInSecond +Time limit in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TotalBytesPerSession +Total bytes per session. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPacketCaptureResult + +## NOTES + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzNetworkWatcherProtocolConfiguration.md b/azps-10.1.0/Az.Network/New-AzNetworkWatcherProtocolConfiguration.md new file mode 100644 index 0000000000..bb0ec76d52 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzNetworkWatcherProtocolConfiguration.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-aznetworkwatcherprotocolconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherProtocolConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzNetworkWatcherProtocolConfiguration.md +--- + +# New-AzNetworkWatcherProtocolConfiguration + +## SYNOPSIS +Creates a new protocol configuration object. + +## SYNTAX + +``` +New-AzNetworkWatcherProtocolConfiguration -Protocol <String> [-Method <String>] [-Header <IDictionary>] + [-ValidStatusCode <Int32[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzNetworkWatcherProtocolConfiguration cmdlet creates a new protocol configuration object. +This object is used to restrict the protocol configuration during a connectivity check session using the specified criteria. + +## EXAMPLES + +### Example 1: Test Network Watcher Connectivity from a VM to a website with protocol configuration +```powershell +$config = New-AzNetworkWatcherProtocolConfiguration -Protocol Http -Method Get -Header @{"accept"="application/json"} -ValidStatusCode @(200,202,204) + +Test-AzNetworkWatcherConnectivity -NetworkWatcherName NetworkWatcher -ResourceGroupName NetworkWatcherRG -SourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoRG/providers/Microsoft.Compute/virtualMachines/MultiTierApp0" -DestinationAddress "bing.com" -DestinationPort 80 -ProtocolConfiguration $config +``` + +```output +ConnectionStatus : Reachable +AvgLatencyInMs : 4 +MinLatencyInMs : 2 +MaxLatencyInMs : 15 +ProbesSent : 15 +ProbesFailed : 0 +Hops : [ + { + "Type": "Source", + "Id": "f8cff464-e13f-457f-a09e-4dcd53d38a85", + "Address": "10.1.1.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoRG/provi iders/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", + "NextHopIds": [ + "1034b1bf-0b1b-4f0a-93b2-900477f45485" + ], + "Issues": [] + }, + { + "Type": "Internet", + "Id": "1034b1bf-0b1b-4f0a-93b2-900477f45485", + "Address": "13.107.21.200", + "ResourceId": "Internet", + "NextHopIds": [], + "Issues": [] + } + ] +``` + +In this example we test connectivity from a VM in Azure to www.bing.com. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Header +list of HTTP headers + +```yaml +Type: System.Collections.IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Method +HTTP method + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidStatusCode +valid status codes + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherProtocolConfiguration + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, watcher, packet, capture, traffic, filter + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/New-AzO365PolicyProperty.md b/azps-10.1.0/Az.Network/New-AzO365PolicyProperty.md new file mode 100644 index 0000000000..068d1620dc --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzO365PolicyProperty.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azo365policyproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzO365PolicyProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzO365PolicyProperty.md +--- + +# New-AzO365PolicyProperty + +## SYNOPSIS +Create an office 365 traffic breakout policy object. + +## SYNTAX + +``` +New-AzO365PolicyProperty [-Allow] [-Optimize] [-Default] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an office 365 breakout policy to be used with New-AzVpnSite and Update-AzVpnSite cmdlets. + +## EXAMPLES + +### Example 1 +```powershell +$policy = New-AzO365PolicyProperty -Allow -Optimize +``` + +Create an office 365 traffic breakout policy with breakout allowed for allow and optimize category of traffic. + +## PARAMETERS + +### -Allow +Breakout the allow category traffic. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Default +Breakout the default category traffic. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Optimize +Breakout the optimize category traffic. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSO365PolicyProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzOffice365PolicyProperty.md b/azps-10.1.0/Az.Network/New-AzOffice365PolicyProperty.md new file mode 100644 index 0000000000..a7edd3d0de --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzOffice365PolicyProperty.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azoffice365policyproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzOffice365PolicyProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzOffice365PolicyProperty.md +--- + +# New-AzOffice365PolicyProperty + +## SYNOPSIS +Define a new Office 365 traffic breakout policy to be used with a Virtual Appliance site. + +## SYNTAX + +``` +New-AzOffice365PolicyProperty [-Allow] [-Optimize] [-Default] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzOffice365PolicyProperties command defines an Office 365 breakout policy that is to be used with a Virtual Appliance site. + +## EXAMPLES + +### Example 1 +```powershell +$o365Policy = New-AzOffice365PolicyProperty -Allow -Optimize +``` + +Create Office 365 traffic breakout policy object to be used with Virtual Appliance site commands. + +## PARAMETERS + +### -Allow +Breakout the allow category traffic. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Default +Breakout the default category traffic. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Optimize +Breakout the optimize category traffic. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSOffice365PolicyProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzP2sVpnGateway.md b/azps-10.1.0/Az.Network/New-AzP2sVpnGateway.md new file mode 100644 index 0000000000..70c43c7ef7 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzP2sVpnGateway.md @@ -0,0 +1,460 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azp2svpngateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzP2sVpnGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzP2sVpnGateway.md +--- + +# New-AzP2sVpnGateway + +## SYNOPSIS +Create a new P2SVpnGateway under VirtualHub for point to site connectivity. + +## SYNTAX + +### ByVirtualHubNameByVpnServerConfigurationObject (Default) +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubName <String> [-VpnServerConfiguration <PSVpnServerConfiguration>] + [-VpnClientAddressPool <String[]>] [-CustomDnsServer <String[]>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] [-DisableInternetSecurityFlag] + [-EnableRoutingPreferenceInternetFlag] [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubNameByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubName <String> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObjectByVpnServerConfigurationObject +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHub <PSVirtualHub> [-VpnServerConfiguration <PSVpnServerConfiguration>] + [-VpnClientAddressPool <String[]>] [-CustomDnsServer <String[]>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] [-DisableInternetSecurityFlag] + [-EnableRoutingPreferenceInternetFlag] [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubObjectByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHub <PSVirtualHub> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByVpnServerConfigurationObject +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubId <String> [-VpnServerConfiguration <PSVpnServerConfiguration>] [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubId <String> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzP2sVpnGateway cmdlet enables you to create a new P2SVpnGateway under VirtualHub for Point to site connectivity from Point to site clients to Azure VirtualWan. + +## EXAMPLES + +### Example 1 +```powershell +$virtualHub = Get-AzVirtualHub -ResourceGroupName P2SCortexGATesting -Name WestUsVirtualHub +$vpnServerConfig1 = Get-AzVpnServerConfiguration -ResourceGroupName P2SCortexGATesting -Name WestUsConfig +$vpnClientAddressSpaces = New-Object string[] 1 +$vpnClientAddressSpaces[0] = "192.168.2.0/24" +$createdP2SVpnGateway = New-AzP2sVpnGateway -ResourceGroupName P2SCortexGATesting -Name 683482ade8564515aed4b8448c9757ea-westus-gw -VirtualHub $virtualHub -VpnGatewayScaleUnit 1 -VpnClientAddressPool $vpnClientAddressSpaces -VpnServerConfiguration $vpnServerConfig1 -EnableInternetSecurityFlag -EnableRoutingPreferenceInternetFlag +``` + +```output +ResourceGroupName : P2SCortexGATesting +Name : 683482ade8564515aed4b8448c9757ea-westus-gw +Id : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482ade8564515a + ed4b8448c9757ea-westus-gw +Location : westus +VpnGatewayScaleUnit : 1 +VirtualHub : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub +VpnServerConfiguration : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/WestUsConfig +VpnServerConfigurationLocation : +VpnClientConnectionHealth : null +Type : Microsoft.Network/p2sVpnGateways +ProvisioningState : Succeeded +P2SConnectionConfigurations : [ + { + "ProvisioningState": "Succeeded", + "VpnClientAddressPool": { + "AddressPrefixes": [ + "192.168.2.0/24" + ] + }, + "EnableInternetSecurity": True, + "RoutingConfiguration": { + "AssociatedRouteTable": { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + }, + "Name": "P2SConnectionConfigDefault", + "Etag": "W/\"4b96e6a2-b4d8-46b3-9210-76d40f359bef\"", + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482 + ade8564515aed4b8448c9757ea-westus-gw/p2sConnectionConfigurations/P2SConnectionConfigDefault" + } + ] +``` + +The New-AzP2sVpnGateway cmdlet enables you to create a new P2SVpnGateway under VirtualHub for Point to site connectivity. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```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 +``` + +### -CustomDnsServer +The list of Custom Dns Servers. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableInternetSecurityFlag +Flag to disable internet security feature on this P2SVpnGateway P2SConnectionConfiguration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternetSecurityFlag +Enable internet security flag for this P2SVpnGateway connections + +```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 +``` + +### -EnableRoutingPreferenceInternetFlag +Flag to enable Routing Preference Internet on this P2SVpnGateway. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, P2SVpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -P2SConnectionConfiguration +The list of P2SConnectionConfigurations that this P2SVpnGateway needs to have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSP2SConnectionConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingConfiguration +Routing configuration for this connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObjectByVpnServerConfigurationObject, ByVirtualHubObjectByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubId +The Id of the VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceIdByVpnServerConfigurationObject, ByVirtualHubResourceIdByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualHubName +The Id of the VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationObject, ByVirtualHubNameByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnClientAddressPool +P2S VpnClient AddressPool for this P2SVpnGateway P2SConnectionConfiguration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnGatewayScaleUnit +The scale unit for this P2SVpnGateway. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnServerConfiguration +The VpnServerConfiguration to be attached to this P2SVpnGateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationObject, ByVirtualHubObjectByVpnServerConfigurationObject, ByVirtualHubResourceIdByVpnServerConfigurationObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VpnServerConfigurationId +The id of Vpn server configuration object this P2SVpnGateway will be attached to. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationResourceId, ByVirtualHubObjectByVpnServerConfigurationResourceId, ByVirtualHubResourceIdByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub +System.String Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +## NOTES + +## RELATED LINKS + +[New-AzRoutingConfiguration]() + diff --git a/azps-10.1.0/Az.Network/New-AzPacketCaptureFilterConfig.md b/azps-10.1.0/Az.Network/New-AzPacketCaptureFilterConfig.md new file mode 100644 index 0000000000..7fa37c2690 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzPacketCaptureFilterConfig.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azpacketcapturefilterconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPacketCaptureFilterConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPacketCaptureFilterConfig.md +--- + +# New-AzPacketCaptureFilterConfig + +## SYNOPSIS +Creates a new packet capture filter object. + +## SYNTAX + +``` +New-AzPacketCaptureFilterConfig [-Protocol <String>] [-RemoteIPAddress <String>] [-LocalIPAddress <String>] + [-LocalPort <String>] [-RemotePort <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzPacketCaptureFilterConfig cmdlet creates a new packet capture filter object. +This object is used to restrict the type of packets that are captured during a packet capture session using the specified criteria. +The New-AzNetworkWatcherPacketCapture cmdlet can accept multiple filter objects to enable composable capture sessions. + +## EXAMPLES + +### Example 1: Create a Packet Capture with multiple filters +```powershell +$nw = Get-AzResource | Where-Object {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } +$networkWatcher = Get-AzNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName + +$storageAccount = Get-AzStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 + +$filter1 = New-AzPacketCaptureFilterConfig -Protocol TCP -RemoteIPAddress "1.1.1.1-255.255.255" -LocalIPAddress "10.0.0.3" -LocalPort "1-65535" -RemotePort "20;80;443" +$filter2 = New-AzPacketCaptureFilterConfig -Protocol UDP +New-AzNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -TargetVirtualMachineId $vm.Id -PacketCaptureName "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSeconds 60 -Filter $filter1, $filter2 +``` + +In this example we create a packet capture named "PacketCaptureTest" with multiple filters and a time limit. Once the session is complete, it will be saved to the specified storage account. +Note: The Azure Network Watcher extension must be installed on the target virtual machine to create packet captures. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalIPAddress +Specifies the Local IP Address to filter on. +Example inputs: +"127.0.0.1" for single address entry. +"127.0.0.1-127.0.0.255" for range. +"127.0.0.1;127.0.0.5;" for multiple entries. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LocalPort +Specifies the Local IP Address to filter on. +Example inputs: +"127.0.0.1" for single address entry. +"127.0.0.1-127.0.0.255" for range. +"127.0.0.1;127.0.0.5;" for multiple entries. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocol +Specifies the Protocol to filter on. Acceptable values "TCP","UDP","Any" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RemoteIPAddress +Specifies the remote IP address to filter on. +Example inputs: +"127.0.0.1" for single address entry. +"127.0.0.1-127.0.0.255" for range. +"127.0.0.1;127.0.0.5;" for multiple entries. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RemotePort +Specifies the Remote Port to filter on. +Remote port +Example inputs: +"80" for single port entry. +"80-85" for range. +"80;443;" for multiple entries. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPacketCaptureFilter + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, watcher, packet, capture, traffic, filter + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureScopeConfig](./New-AzPacketCaptureScopeConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/New-AzPacketCaptureScopeConfig.md b/azps-10.1.0/Az.Network/New-AzPacketCaptureScopeConfig.md new file mode 100644 index 0000000000..367248b1d1 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzPacketCaptureScopeConfig.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azpacketcapturescopeconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPacketCaptureScopeConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPacketCaptureScopeConfig.md +--- + +# New-AzPacketCaptureScopeConfig + +## SYNOPSIS +Creates a new packet capture scope object. + +## SYNTAX + +``` +New-AzPacketCaptureScopeConfig [-Include <String[]>] [-Exclude <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzPacketCaptureScopeConfig cmdlet creates a new packet capture scope object. +This object is used to either include or exclude the provided VMSS Instances for running Packet Captures. +The New-AzPacketCaptureScopeConfig cmdlet can accept multiple VMSS Instances Names enable/disable composable capture sessions. + +## EXAMPLES + +### Example 1: Create a Packet Capture with multiple VMSS Instances in Include Scope +```powershell +$nw = Get-AzResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } +$networkWatcher = Get-AzNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName + +$storageAccount = Get-AzStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 + +$instance1 = $vmssInstance1.Name +$instance2 = $vmssInstance2.Name +$scope = New-AzPacketCaptureScopeConfig -Include $instance1, $instance2 + +New-AzNetworkWatcherPacketCaptureV2 -NetworkWatcher $networkWatcher -TargetId $vmss.Id -TargetType "azurevmss" -Scope $scope -PacketCaptureName "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSecond 60 +``` + +In this example we create a packet capture named "PacketCaptureTest" with multiple VMSS Instances in Include Scope and a time limit. Once the session is complete, it will be saved to the specified storage account. +Note: The Azure Network Watcher extension must be installed on the target virtual machine to create packet captures. + +### Example 2: Create a Packet Capture with multiple VMSS Instances in Exclude Scope +```powershell +$nw = Get-AzResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } +$networkWatcher = Get-AzNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName + +$storageAccount = Get-AzStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 + +$instance1 = $vmssInstance1.Name +$instance2 = $vmssInstance2.Name +$scope = New-AzPacketCaptureScopeConfig -Exclude $instance1, $instance2 + +New-AzNetworkWatcherPacketCaptureV2 -NetworkWatcher $networkWatcher -TargetId $vmss.Id -TargetType "azurevmss" -Scope $scope -PacketCaptureName "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSecond 60 +``` + +In this example we create a packet capture named "PacketCaptureTest" with multiple VMSS Instances in Exclude Scope - meaning that apart from these provided Instance, Packet Capture would be working on all other instances and a time limit. Once the session is complete, it will be saved to the specified storage account. +Note: The Azure Network Watcher extension must be installed on the target virtual machine to create packet captures. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exclude +Machines to be Excluded in Scope + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Include +Machines to be Included in Scope + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPacketCaptureMachineScope + +## NOTES + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzPrivateDnsZoneConfig.md b/azps-10.1.0/Az.Network/New-AzPrivateDnsZoneConfig.md new file mode 100644 index 0000000000..290735d194 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzPrivateDnsZoneConfig.md @@ -0,0 +1,96 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azprivatednszoneconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateDnsZoneConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateDnsZoneConfig.md +--- + +# New-AzPrivateDnsZoneConfig + +## SYNOPSIS +Creates DNS zone configuration of the private dns zone group. + +## SYNTAX + +``` +New-AzPrivateDnsZoneConfig -Name <String> [-PrivateDnsZoneId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPrivateDnsZoneConfig** cmdlet enables you to create a new DNS zone configuration object which will be set on DNS zone group. + +## EXAMPLES + +### Example 1: Creates DNS zone configuration +```powershell +$dnsZone = New-AzPrivateDnsZone -ResourceGroupName "rg" -Name "test.vault.azure.com" +$config = New-AzPrivateDnsZoneConfig -Name "test-vault-azure-com" -PrivateDnsZoneId $dnsZone.ResourceId +``` + +The above example creates DNS zone and then creates DNS zone configuration. `New-AzPrivateDnsZone` cmdlet is proveded by module Az.PrivateDns. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the resource that is unique within a resource group. +This name can be used to access the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateDnsZoneId +The resource id of the private dns zone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateDnsZoneConfig + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzPrivateDnsZoneGroup.md b/azps-10.1.0/Az.Network/New-AzPrivateDnsZoneGroup.md new file mode 100644 index 0000000000..ef6f5749ea --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzPrivateDnsZoneGroup.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azprivatednszonegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateDnsZoneGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateDnsZoneGroup.md +--- + +# New-AzPrivateDnsZoneGroup + +## SYNOPSIS +Creates a private DNS zone group in the specified private endpoint. + +## SYNTAX + +``` +New-AzPrivateDnsZoneGroup -ResourceGroupName <String> -PrivateEndpointName <String> -Name <String> + -PrivateDnsZoneConfig <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPrivateDnsZoneConfig]> + [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPrivateDnsZoneGroup** cmdlet enables you to create a new private DNS zone group. + +## EXAMPLES + +### Example 1 +```powershell +$dnsZone = New-AzPrivateDnsZone -ResourceGroupName "rg" -Name "test.vault.azure.com" +$config = New-AzPrivateDnsZoneConfig -Name "test-vault-azure-com" -PrivateDnsZoneId $dnsZone.ResourceId +New-AzPrivateDnsZoneGroup -ResourceGroupName "rg" -PrivateEndpointName "test-pr-endpoint" -name "dnsgroup1" -PrivateDnsZoneConfig $config -Force +``` + +```output +Name : dnsgroup1 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/test-pr-endpoint/privateDnsZoneGroups/dnsgroup1 +ProvisioningState : Succeeded +PrivateDnsZoneConfigs : [ + { + "Name": "test-vault-azure-com", + "PrivateDnsZoneId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Network/privateDnsZones/test.vault.azure.com", + "RecordSets": [] + } + ] +``` + +Once private endpoint `test-pr-endpoint` is created, above example creates DNS zone group under that private endpoint. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the private dns zone group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PrivateDnsZoneGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateDnsZoneConfig +A collection of private dns zone configurations of the private dns zone group. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPrivateDnsZoneConfig] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateEndpointName +The name of the private endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSPrivateDnsZoneConfig, Microsoft.Azure.PowerShell.Cmdlets.Network, Version=2.5.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateDnsZoneGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzPrivateEndpoint.md b/azps-10.1.0/Az.Network/New-AzPrivateEndpoint.md new file mode 100644 index 0000000000..dd7ede90b7 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzPrivateEndpoint.md @@ -0,0 +1,323 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azprivateendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateEndpoint.md +--- + +# New-AzPrivateEndpoint + +## SYNOPSIS +Creates a private endpoint. + +## SYNTAX + +``` +New-AzPrivateEndpoint -Name <String> -ResourceGroupName <String> -Location <String> -Subnet <PSSubnet> + -PrivateLinkServiceConnection <PSPrivateLinkServiceConnection[]> [-ByManualRequest] [-EdgeZone <String>] + [-Tag <Hashtable>] [-Force] [-AsJob] [-ApplicationSecurityGroup <PSApplicationSecurityGroup[]>] + [-IpConfiguration <PSPrivateEndpointIPConfiguration[]>] [-CustomNetworkInterfaceName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The **New-AzPrivateEndpoint** cmdlet creates a private endpoint. + +## EXAMPLES + +### Example 1: Create a private endpoint + +The following example creates a private endpoint with a specific private link service ID in the +specified subnet in a virtual network. + +```powershell +$virtualNetwork = Get-AzVirtualNetwork -ResourceName 'myVirtualNetwork' -ResourceGroupName 'myResourceGroup' +$subnet = $virtualNetwork | Select-Object -ExpandProperty subnets | Where-Object Name -eq 'mySubnet' +$plsConnection= New-AzPrivateLinkServiceConnection -Name 'MyPLSConnections' -PrivateLinkServiceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateLinkServices/privateLinkService' -RequestMessage 'Please Approve my request' +New-AzPrivateEndpoint -Name 'MyPrivateEndpoint' -ResourceGroupName 'myResourceGroup' -Location 'centralus' -PrivateLinkServiceConnection $plsConnection -Subnet $subnet +``` + +## PARAMETERS + +### -ApplicationSecurityGroup +The application security group + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob + +Run cmdlet as a job in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ByManualRequest + +Use manual request to establish the connection. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomNetworkInterfaceName +The custom network interface name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +The edge zone of the private endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force + +Do not ask for confirmation to overwrite a resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfiguration +The private endpoint IP configuration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPrivateEndpointIPConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +Specifies a location for the private endpoint. Use [Get-AzLocation](/powershell/module/az.resources/get-azlocation) +to determine valid values for this parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name + +Name of the private endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateLinkServiceConnection + +The resource ID to connect the private endpoint. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPrivateLinkServiceConnection[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Subnet + +The subnet of the private endpoint. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag + +Key-value pairs in the form of a hash table. For example: +@{key0='value0';key1=$null;key2='value2'} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSSubnet + +### Microsoft.Azure.Commands.Network.Models.PSPrivateLinkServiceConnection[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateEndpoint + +## NOTES + +## RELATED LINKS + +[Get-AzPrivateEndpoint](./Get-AzPrivateEndpoint.md) + +[Remove-AzPrivateEndpoint](./Remove-AzPrivateEndpoint.md) + +[New-AzPrivateLinkServiceConnection](./New-AzPrivateLinkServiceConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzPrivateEndpointIpConfiguration.md b/azps-10.1.0/Az.Network/New-AzPrivateEndpointIpConfiguration.md new file mode 100644 index 0000000000..0bdc2587d2 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzPrivateEndpointIpConfiguration.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azprivateendpointipconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateEndpointIpConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateEndpointIpConfiguration.md +--- + +# New-AzPrivateEndpointIpConfiguration + +## SYNOPSIS +Creates an IpConfiguration object for private endpoint. + +## SYNTAX + +``` +New-AzPrivateEndpointIpConfiguration -Name <String> [-GroupId <String>] [-MemberName <String>] + -PrivateIpAddress <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPrivateEndpointIpConfiguration** cmdlet creates an IpConfiguration object for private endpoint. + +## EXAMPLES + +### Example 1 +```powershell +New-AzPrivateEndpointIpConfiguration -Name "IpConfigurationForPrivateEndpoint" -PrivateIPAddress "10.0.0.10" +``` + +This example creates an IpConfiguration object used for private endpoint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +The ID of a group that the private endpoint connects to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberName +The member name of a group that the private endpoint connects to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the private endpoint IP configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddress +The private ip address of the private endpoint's subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateEndpointIPConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzPrivateLinkService.md b/azps-10.1.0/Az.Network/New-AzPrivateLinkService.md new file mode 100644 index 0000000000..13c2e1e901 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzPrivateLinkService.md @@ -0,0 +1,297 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azprivatelinkservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateLinkService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateLinkService.md +--- + +# New-AzPrivateLinkService + +## SYNOPSIS +Creates a private link service + +## SYNTAX + +``` +New-AzPrivateLinkService -Name <String> -ResourceGroupName <String> -Location <String> + -LoadBalancerFrontendIpConfiguration <PSFrontendIPConfiguration[]> + -IpConfiguration <PSPrivateLinkServiceIpConfiguration[]> [-Visibility <String[]>] [-AutoApproval <String[]>] + [-EnableProxyProtocol] [-EdgeZone <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPrivateLinkService** cmdlet creates a private link service + +## EXAMPLES + +### Example 1 + +The following example creates a private link service. + +```powershell +$vnet = Get-AzVirtualNetwork -ResourceName 'myvnet' -ResourceGroupName 'myresourcegroup' +# View the results of $vnet and change 'mysubnet' in the following line to the appropriate subnet name. +$subnet = $vnet | Select-Object -ExpandProperty subnets | Where-Object Name -eq 'mysubnet' +$IPConfig = New-AzPrivateLinkServiceIpConfig -Name 'IP-Config' -Subnet $subnet -PrivateIpAddress '10.0.0.5' +$publicip = Get-AzPublicIpAddress -ResourceGroupName 'myresourcegroup' +$frontend = New-AzLoadBalancerFrontendIpConfig -Name 'FrontendIpConfig01' -PublicIpAddress $publicip +$lb = New-AzLoadBalancer -Name 'MyLoadBalancer' -ResourceGroupName 'myresourcegroup' -Location 'West US' -FrontendIpConfiguration $frontend +New-AzPrivateLinkService -Name 'mypls' -ResourceGroupName myresourcegroup -Location "West US" -LoadBalancerFrontendIpConfiguration $frontend -IpConfiguration $IPConfig +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoApproval +The auto approval subscriptions of private link service + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +The edge zone of the private link service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableProxyProtocol +Enable proxy protocol for the private link service. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfiguration +The ip configurations + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPrivateLinkServiceIpConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerFrontendIpConfiguration +The front end ip configurations + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Visibility +The visibility subscriptions of private link service + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration[] + +### Microsoft.Azure.Commands.Network.Models.PSPrivateLinkServiceIpConfiguration[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateLinkService + +## NOTES + +## RELATED LINKS + +[Get-AzPrivateLinkService](./Get-AzPrivateLinkService.md) + +[Remove-AzPrivateLinkService](./Remove-AzPrivateLinkService.md) + +[New-AzPrivateLinkServiceIpConfig](./New-AzPrivateLinkServiceIpConfig.md) diff --git a/azps-10.1.0/Az.Network/New-AzPrivateLinkServiceConnection.md b/azps-10.1.0/Az.Network/New-AzPrivateLinkServiceConnection.md new file mode 100644 index 0000000000..e14c9da0d6 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzPrivateLinkServiceConnection.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azprivatelinkserviceconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateLinkServiceConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateLinkServiceConnection.md +--- + +# New-AzPrivateLinkServiceConnection + +## SYNOPSIS +Creates a private link service connection configuration. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzPrivateLinkServiceConnection -Name <String> -PrivateLinkService <PSPrivateLinkService> + [-GroupId <String[]>] [-RequestMessage <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzPrivateLinkServiceConnection -Name <String> -PrivateLinkServiceId <String> [-GroupId <String[]>] + [-RequestMessage <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +**The New-AzPrivateLinkServiceConnection** cmdlet creates a private link service connection configuration. + +## EXAMPLES + +### Example 1 +```powershell +New-AzPrivateLinkServiceConnection -Name MyPLSConnection -PrivateLinkServiceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/privateLinkServices/privateLinkService" -RequestMessage "Please Approve my request" +``` + +This example create a private link service connection object in memory for using in creating private endpoint. + +### Example 2 + +Creates a private link service connection configuration. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzPrivateLinkServiceConnection -GroupId <String[]> -Name 'MyPLSConnections' -PrivateLinkServiceId '/subscriptions/00000000-0000-0000-0000-00000000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/privateLinkServices/privateLinkService' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +The list of group id. You can use '(Get-AzPrivateLinkResource -PrivateLinkResourceId ${privateLinkResourceId}).GroupId' to get the supported group ids. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of private link service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkService +The private link service. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPrivateLinkService +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateLinkServiceId +The id of private link service. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RequestMessage +The request message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateLinkServiceConnection + +## NOTES + +## RELATED LINKS + +[New-AzPrivateEndpoint](./New-AzPrivateEndpoint.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzPrivateLinkServiceIpConfig.md b/azps-10.1.0/Az.Network/New-AzPrivateLinkServiceIpConfig.md new file mode 100644 index 0000000000..1fe1d93d9c --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzPrivateLinkServiceIpConfig.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azprivatelinkserviceipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateLinkServiceIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPrivateLinkServiceIpConfig.md +--- + +# New-AzPrivateLinkServiceIpConfig + +## SYNOPSIS +Create a private link service ip configuration. + +## SYNTAX + +``` +New-AzPrivateLinkServiceIpConfig -Name <String> [-PrivateIpAddressVersion <String>] + [-PrivateIpAddress <String>] [-PublicIpAddress <PSPublicIpAddress>] [-Subnet <PSSubnet>] [-Primary] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPrivateLinkServiceIpConfig** cmdlet creates a private link service ip configuration. This configuration is used for source NAT-ing the incoming traffic from private endpoint. + +## EXAMPLES + +### Example 1 +```powershell +New-AzPrivateLinkServiceIpConfig -Name $IpConfigurationName -PrivateIpAddress "10.0.0.5" -Primary +``` + +This example create a private link service ip configuration in memory. + +### Example 2 + +Create a private link service ip configuration. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzPrivateLinkServiceIpConfig -Name 'IP-Config' -PrivateIpAddress '10.0.0.5' -Subnet <PSSubnet> +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the IpConfiguration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Primary +Indicate current ip configuration is primary or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddress +The private ip address of the ipConfiguration if static allocation is specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddressVersion +The ip version of the ip configuration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddress +PublicIpAddress + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Subnet + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateLinkServiceIpConfiguration + +## NOTES + +## RELATED LINKS + +[New-AzPrivateLinkService](./New-AzPrivateLinkService.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzPublicIpAddress.md b/azps-10.1.0/Az.Network/New-AzPublicIpAddress.md new file mode 100644 index 0000000000..c523cc41de --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzPublicIpAddress.md @@ -0,0 +1,508 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 8D84F81A-F6B5-413D-B349-50947FCD5CFC +online version: https://learn.microsoft.com/powershell/module/az.network/new-azpublicipaddress +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPublicIpAddress.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPublicIpAddress.md +--- + +# New-AzPublicIpAddress + +## SYNOPSIS +Creates a public IP address. + +## SYNTAX + +``` +New-AzPublicIpAddress [-Name <String>] -ResourceGroupName <String> [-Location <String>] [-EdgeZone <String>] + [-Sku <String>] [-Tier <String>] -AllocationMethod <String> [-IpAddressVersion <String>] + [-DomainNameLabel <String>] [-DomainNameLabelScope <String>][-IpTag <PSPublicIpTag[]>] [-PublicIpPrefix <PSPublicIpPrefix>] + [-DdosProtectionMode <String>] [-DdosProtectionPlanId <String>] [-ReverseFqdn <String>] + [-IdleTimeoutInMinutes <Int32>] [-Zone <String[]>] [-IpAddress <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPublicIpAddress** cmdlet creates a public IP address. + +## EXAMPLES + +### Example 1: Create a new public IP address +```powershell +$publicIp = New-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -AllocationMethod Static -DomainNameLabel $dnsPrefix -Location $location +``` + +This command creates a new public IP address resource.A DNS record is created for +$dnsPrefix.$location.cloudapp.azure.com pointing to the public IP address of this resource. A +public IP address is immediately allocated to this resource as the -AllocationMethod is specified +as 'Static'. If it is specified as 'Dynamic', a public IP address gets allocated only when you +start (or create) the associated resource (like a VM or load balancer). + +### Example 2: Create a public IP address with a reverse FQDN +```powershell +$publicIp = New-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -AllocationMethod Static -DomainNameLabel $dnsPrefix -Location $location -ReverseFqdn $customFqdn +``` + +This command creates a new public IP address resource. With the -ReverseFqdn parameter, Azure +creates a DNS PTR record (reverse-lookup) for the public IP address allocated to this resource, +pointing to the $customFqdn specified in the command. As a pre-requisite, the $customFqdn (say +webapp.contoso.com) should have a DNS CNAME record (forward-lookup) pointing to +$dnsPrefix.$location.cloudapp.azure.com. + +### Example 3: Create a new public IP address with IpTag +```powershell +$ipTag = New-AzPublicIpTag -IpTagType "FirstPartyUsage" -Tag "/Sql" +$publicIp = New-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -AllocationMethod Static -DomainNameLabel $dnsPrefix -Location $location -IpTag $ipTag +``` + +This command creates a new public IP address resource.A DNS record is created for +$dnsPrefix.$location.cloudapp.azure.com pointing to the public IP address of this resource. A +public IP address is immediately allocated to this resource as the -AllocationMethod is specified +as 'Static'. If it is specified as 'Dynamic', a public IP address gets allocated only when you +start (or create) the associated resource (like a VM or load balancer). An Iptag is used to +specific the Tags associated with resource. Iptag can be specified using New-AzPublicIpTag +and passed as input through -IpTags. + +### Example 4: Create a new public IP address from a Prefix +```powershell +$publicIp = New-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -AllocationMethod Static -DomainNameLabel $dnsPrefix -Location $location -PublicIpPrefix $publicIpPrefix -Sku Standard +``` + +This command creates a new public IP address resource. A DNS record is created for +$dnsPrefix.$location.cloudapp.azure.com pointing to the public IP address of this resource. A +public IP address is immediately allocated to this resource from the publicIpPrefix specified. +This option is only supported for the 'Standard' Sku and 'Static' AllocationMethod. + +### Example 5: Create a specific public IP address from a BYOIP Prefix +```powershell +$publicIp = New-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -AllocationMethod Static -Location $location -IpAddress 0.0.0.0 -PublicIpPrefix $publicIpPrefix -Sku Standard +``` + +This command creates a new public IP address resource with specific IP. NRP would check if the +given IP is inside the PublicIpPrefix and if the given PublicIpPrefix is BYOIP PublicIpPrefix. +the given public IP address is immediately allocated to this resource from the publicIpPrefix +specified. This option is only supported for the 'Standard' Sku and 'Static' AllocationMethod +and BYOIP PublicIpPrefix. + +### Example 6: Create a new global public IP address +```powershell +$publicIp = New-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -AllocationMethod Static -DomainNameLabel $domainNameLabel -Location $location -Sku Standard -Tier Global +``` + +This command creates a new global public IP address resource.A DNS record is created for +$dnsPrefix.$location.cloudapp.azure.com pointing to the public IP address of this resource. A +global public IP address is immediately allocated to this resource. +This option is only supported for the 'Standard' Sku and 'Static' AllocationMethod. + +### Example 7: Create a public IP address with a DomainNameLabelScope +```powershell +$publicIp = New-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -AllocationMethod Static -DomainNameLabel $dnsPrefix -DomainNameLabelScope $hasedReusePolicy -Location $location +``` + +This command creates a new public IP address resource. With the -DomainNameLabelScope parameter, Azure +creates a DNS record with a hashed value in FQDN for the public IP address allocated to this resource +with the policy suggested by $hasedReusePolicy. + +## PARAMETERS + +### -AllocationMethod +Specifies the method with which to allocate the public IP address. +The acceptable values for this parameter are: Static or Dynamic. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Dynamic, Static + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DdosProtectionMode +The DdosProtectionMode to use for Public IP address + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: VirtualNetworkInherited, Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DdosProtectionPlanId +The DdosProtectionPlan id to attach to the Public IP address + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainNameLabel +Specifies the relative DNS name for a public IP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DomainNameLabelScope +Specifies the HashedReusePolicy for DNS name for a public IP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EdgeZone +The name of the extended location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +Specifies the idle time-out, in minutes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpAddress +Specifies the IP address when creating a BYOIP publicIpAddress. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpAddressVersion +Specifies the version of the IP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpTag +IpTag List. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpTag[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the region in which to create a public IP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the public IP address that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpPrefix +Specifies the PSPublicIpPrefix from which to allocate the public IP address. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group in which to create a public IP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReverseFqdn +Specifies a reverse fully qualified domain name (FQDN). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +The public IP Sku name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, Standard + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tier +The public IP Sku Tier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Regional, Global + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +A list of availability zones denoting the IP allocated for the resource needs to come from. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpTag[] + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix + +### System.Int32 + +### System.String[] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress + +## NOTES + +## RELATED LINKS + +[Get-AzPublicIpAddress](./Get-AzPublicIpAddress.md) + +[Remove-AzPublicIpAddress](./Remove-AzPublicIpAddress.md) + +[Set-AzPublicIpAddress](./Set-AzPublicIpAddress.md) diff --git a/azps-10.1.0/Az.Network/New-AzPublicIpPrefix.md b/azps-10.1.0/Az.Network/New-AzPublicIpPrefix.md new file mode 100644 index 0000000000..4fc9b17a61 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzPublicIpPrefix.md @@ -0,0 +1,342 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azpublicipprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPublicIpPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPublicIpPrefix.md +--- + +# New-AzPublicIpPrefix + +## SYNOPSIS +Creates a Public IP Prefix + +## SYNTAX + +``` +New-AzPublicIpPrefix -Name <String> -ResourceGroupName <String> [-Location <String>] [-Sku <String>] + [-Tier <String>] -PrefixLength <UInt16> [-IpAddressVersion <String>] [-IpTag <PSPublicIpPrefixTag[]>] + [-Zone <String[]>] [-CustomIpPrefix <PSCustomIpPrefix>] [-EdgeZone <String>] [-Tag <Hashtable>] [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPublicIpPrefix** cmdlet creates a public IP prefix. + +## EXAMPLES + +### Example 1: Create a new public Ip prefix +```powershell +$publicIpPrefix = New-AzPublicIpPrefix -Name $prefixName -ResourceGroupName $rgName -PrefixLength 30 +``` + +This command creates a new public IP prefix resource. + +### Example 2: Create a new global public Ip prefix +```powershell +$publicIpPrefix = New-AzPublicIpPrefix -ResourceGroupName $rgname -name $rname -location $location -Tier Global -PrefixLength 30 +``` + +This command creates a new global public IP prefix resource. + +### Example 3 + +Creates a Public IP Prefix. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzPublicIpPrefix -CustomIpPrefix <PSCustomIpPrefix> -Location 'West US' -Name 'MyPublicIPPrefix' -PrefixLength '31' -ResourceGroupName 'MyResourceGroup' +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomIpPrefix +The CustomIpPrefix that this PublicIpPrefix will be associated with + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSCustomIpPrefix +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +The edge zone of the public IP prefix + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddressVersion +The public IP address version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpTag +IpTag List. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefixTag[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +The public IP prefix location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrefixLength +The PublicIPPrefix length + +```yaml +Type: System.UInt16 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +The public IP Prefix Sku name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Standard + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tier +The public IP Prefix Sku tier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Regional, Global + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +A list of availability zones denoting the IP allocated for the resource needs to come from. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.UInt16 + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefixTag[] + +### System.String[] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix + +## NOTES + +## RELATED LINKS + +[Get-AzPublicIpPrefix](./Get-AzPublicIpPrefix.md) + +[Remove-AzPublicIpPrefix](./Remove-AzPublicIpPrefix.md) + +[Set-AzPublicIpPrefix](./Set-AzPublicIpPrefix.md) diff --git a/azps-10.1.0/Az.Network/New-AzPublicIpTag.md b/azps-10.1.0/Az.Network/New-AzPublicIpTag.md new file mode 100644 index 0000000000..4a481eb3a7 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzPublicIpTag.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azpubliciptag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPublicIpTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzPublicIpTag.md +--- + +# New-AzPublicIpTag + +## SYNOPSIS +Creates an IP Tag. + +## SYNTAX + +``` +New-AzPublicIpTag -IpTagType <String> -Tag <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPublicIpTag** cmdlet creates a IP Tag. + +## EXAMPLES + +### Example 1: Create a new IP Tag +```powershell +$ipTag = New-AzPublicIpTag -IpTagType $ipTagType -Tag $tag +``` + +This command creates a new IP Tag with the Tagtype like "FirstPartyUsage" +and tag like "/Sql". This is used in publicIpAddress creation with these +specific tags for allocation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpTagType +IpTag type Example:FirstPartyUsage + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +IpTag value Example:/Sql + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpTag + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzRadiusServer.md b/azps-10.1.0/Az.Network/New-AzRadiusServer.md new file mode 100644 index 0000000000..381682c238 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRadiusServer.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azradiusserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRadiusServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRadiusServer.md +--- + +# New-AzRadiusServer + +## SYNOPSIS +Creates an external radius server configuration + +## SYNTAX + +``` +New-AzRadiusServer -RadiusServerAddress <String> -RadiusServerSecret <SecureString> + [-RadiusServerScore <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzRadiusServer cmdlet creates an external radius server configuration to be used in virtual network gateway and VPN server configuration. + +## EXAMPLES + +### Example 1 +```powershell +$radiusServer1 = New-AzRadiusServer -RadiusServerAddress 10.1.0.1 -RadiusServerSecret $radiuspd -RadiusServerScore 30 +$radiusServer2 = New-AzRadiusServer -RadiusServerAddress 10.1.0.2 -RadiusServerSecret $radiuspd -RadiusServerScore 1 +New-AzVirtualNetworkGateway -ResourceGroupName $rgname -name $rname -location $location -IpConfigurations $vnetIpConfig -GatewayType Vpn -VpnType RouteBased -EnableBgp $false -GatewaySku VpnGw1 -VpnClientAddressPool 201.169.0.0/16 -VpnClientProtocol "IkeV2" -RadiusServerList $radiusServers +``` + +Creating multiple external radius server configurations to be used for configuring P2S on a new virtual network gateway. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RadiusServerAddress +External radius server address + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RadiusServerScore +External radius server score + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RadiusServerSecret +External radius server secret + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Security.SecureString + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRadiusServer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzRouteConfig.md b/azps-10.1.0/Az.Network/New-AzRouteConfig.md new file mode 100644 index 0000000000..c3c7b56ee2 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRouteConfig.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 356764CF-A860-432A-907A-9058CEB2BF8E +online version: https://learn.microsoft.com/powershell/module/az.network/new-azrouteconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteConfig.md +--- + +# New-AzRouteConfig + +## SYNOPSIS +Creates a route for a route table. + +## SYNTAX + +``` +New-AzRouteConfig [-Name <String>] [-AddressPrefix <String>] [-NextHopType <String>] + [-NextHopIpAddress <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRouteConfig** cmdlet creates a route for an Azure route table. + +## EXAMPLES + +### Example 1: Create a route +```powershell +$Route = New-AzRouteConfig -Name "Route07" -AddressPrefix 10.1.0.0/16 -NextHopType "VnetLocal" +$Route +``` + +```output +Name : Route07 +Id : +Etag : +ProvisioningState : +AddressPrefix : 10.1.0.0/16 +NextHopType : VnetLocal +NextHopIpAddress : +``` + +The first command creates a route named Route07, and then stores it in the $Route variable. +This route forwards packets to the local virtual network. +The second command displays the properties of the route. + +### Example 2 + +Creates a route for a route table. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzRouteConfig -AddressPrefix 10.1.0.0/16 -Name 'Route07' -NextHopIpAddress '12.0.0.5' -NextHopType 'VnetLocal' +``` + +### Example 3: Create a route with a Service Tag +```powershell +New-AzRouteConfig -Name "Route07" -AddressPrefix "AppService" -NextHopType "VirtualAppliance" -NextHopIpAddress "10.0.2.4" +``` + +This command creates a route named Route07 which forwards traffic to IP prefixes contained in the AppService Service Tag to a virtual appliance. + +## PARAMETERS + +### -AddressPrefix +Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies. You can also specify a Service Tag here (this feature is in Public Preview). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the route. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextHopIpAddress +Specifies the IP address of a virtual appliance that you add to your Azurevirtual network. +This route forwards packets to that address. +Specify this parameter only if you specify a value of VirtualAppliance for the *NextHopType* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextHopType +Specifies how this route forwards packets. +The acceptable values for this parameter are: +- Internet. +The default Internet gateway provided by Azure. +- None. +If you specify this value, the route does not forward packets. +- VirtualAppliance. +A virtual appliance that you add to your Azure virtual network. +- VirtualNetworkGateway. +An Azure server-to-server virtual private network gateway. +- VnetLocal. +The local virtual network. +If you have two subnets, 10.1.0.0/16 and 10.2.0.0/16 in the same virtual network, select a value of VnetLocal for each subnet to forward to the other subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRoute + +## NOTES + +## RELATED LINKS + +[Add-AzRouteConfig](./Add-AzRouteConfig.md) + +[Get-AzRouteConfig](./Get-AzRouteConfig.md) + +[Remove-AzRouteConfig](./Remove-AzRouteConfig.md) + +[Set-AzRouteConfig](./Set-AzRouteConfig.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzRouteFilter.md b/azps-10.1.0/Az.Network/New-AzRouteFilter.md new file mode 100644 index 0000000000..3f9bf97c24 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRouteFilter.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azroutefilter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteFilter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteFilter.md +--- + +# New-AzRouteFilter + +## SYNOPSIS +Creates a route filter. + +## SYNTAX + +``` +New-AzRouteFilter -Name <String> -ResourceGroupName <String> -Location <String> [-Rule <PSRouteFilterRule[]>] + [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzRouteFilter cmdlet creates an Azure route filter. + +## EXAMPLES + +### Example 1 +```powershell +New-AzRouteFilter -Name "MyRouteFilter" -ResourceGroupName "MyResourceGroup" -Location "West US" +``` + +The command creates a new route filter. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet creates a route table even if a route filter that has the same name already exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the Azure region in which this cmdlet creates a route filter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the route filter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group in which this cmdlet creates a route filter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Rule +Specifies an array of Route Filter Rule objects to associate with the route filter. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule[] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilter + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Get-AzRouteFilter](./Get-AzRouteFilter.md) + +[Remove-AzRouteFilter](./Remove-AzRouteFilter.md) + +[Set-AzRouteFilter](./Set-AzRouteFilter.md) + +[Add-AzRouteFilterRuleConfig](./Add-AzRouteFilterRuleConfig.md) + +[Get-AzRouteFilterRuleConfig](./Get-AzRouteFilterRuleConfig.md) + +[New-AzRouteFilterRuleConfig](./New-AzRouteFilterRuleConfig.md) + +[Remove-AzRouteFilterRuleConfig](./Remove-AzRouteFilterRuleConfig.md) + +[Set-AzRouteFilterRuleConfig](./Set-AzRouteFilterRuleConfig.md) diff --git a/azps-10.1.0/Az.Network/New-AzRouteFilterRuleConfig.md b/azps-10.1.0/Az.Network/New-AzRouteFilterRuleConfig.md new file mode 100644 index 0000000000..ff54ca62fc --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRouteFilterRuleConfig.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azroutefilterruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteFilterRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteFilterRuleConfig.md +--- + +# New-AzRouteFilterRuleConfig + +## SYNOPSIS +Creates a route filter rule for a route filter. + +## SYNTAX + +``` +New-AzRouteFilterRuleConfig [-Force] -Name <String> -Access <String> -RouteFilterRuleType <String> + -CommunityList <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzRouteFilterRuleConfig cmdlet creates a route filter rule for an Azure route filter. + +## EXAMPLES + +### Example 1 +```powershell +$rule1 = New-AzRouteFilterRuleConfig -Name "Rule01" -Access "Allow" -RouteFilterRuleType "Community" -CommunityList "12076:5040" +``` + +The command creates a new route filter rule and stores it in variable $rule1. + +## PARAMETERS + +### -Access +Access for route filter rule. +Valid values are Allow or Deny. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommunityList +The list of community value that route filter will filter on + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the route filter rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteFilterRuleType +Route Filter Rule Type. +Valid values are: Community + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Community + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Add-AzRouteFilterRuleConfig](./Add-AzRouteFilterRuleConfig.md) + +[Get-AzRouteFilterRuleConfig](./Get-AzRouteFilterRuleConfig.md) + +[Remove-AzRouteFilterRuleConfig](./Remove-AzRouteFilterRuleConfig.md) + +[Set-AzRouteFilterRuleConfig](./Set-AzRouteFilterRuleConfig.md) + +[Get-AzRouteFilter](./Get-AzRouteFilter.md) + +[New-AzRouteFilter](./New-AzRouteFilter.md) + +[Remove-AzRouteFilter](./Remove-AzRouteFilter.md) + +[Set-AzRouteFilter](./Set-AzRouteFilter.md) diff --git a/azps-10.1.0/Az.Network/New-AzRouteMap.md b/azps-10.1.0/Az.Network/New-AzRouteMap.md new file mode 100644 index 0000000000..99e7278aea --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRouteMap.md @@ -0,0 +1,339 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azroutemap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteMap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteMap.md +--- + +# New-AzRouteMap + +## SYNOPSIS +Create a route map to a VirtualHub. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +New-AzRouteMap [-ResourceGroupName <String>] [-VirtualHubName <String>] [-Name <String>] + [-RouteMapRule <PSRouteMapRule[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +New-AzRouteMap [-VirtualHubObject <PSVirtualHub>] [-Name <String>] [-RouteMapRule <PSRouteMapRule[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +New-AzRouteMap [-VirtualHubResourceId <String>] [-Name <String>] [-RouteMapRule <PSRouteMapRule[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a route map to a VirtualHub. + +## EXAMPLES + +### Example 1 Create route map + +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" + +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" + +# creating new route map rules and a new route map resource and new routing configuration +$routeMapMatchCriterion1 = New-AzRouteMapRuleCriterion -MatchCondition "Contains" -RoutePrefix @("10.0.0.0/16") +$routeMapActionParameter1 = New-AzRouteMapRuleActionParameter -AsPath @("12345") +$routeMapAction1 = New-AzRouteMapRuleAction -Type "Add" -Parameter @($routeMapActionParameter1) +$routeMapRule1 = New-AzRouteMapRule -Name "rule1" -MatchCriteria @($routeMapMatchCriterion1) -RouteMapRuleAction @($routeMapAction1) -NextStepIfMatched "Continue" + +$routeMapMatchCriterion2 = New-AzRouteMapRuleCriterion -MatchCondition "Equals" -AsPath @("12345") +$routeMapAction2 = New-AzRouteMapRuleAction -Type "Drop" +$routeMapRule2 = New-AzRouteMapRule -Name "rule2" -MatchCriteria @($routeMapMatchCriterion2) -RouteMapRuleAction @($routeMapAction2) -NextStepIfMatched "Terminate" + +New-AzRouteMap -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteMap" -RouteMapRule @($routeMapRule1, $routeMapRule2) +``` + +```output +Name : testRouteMap +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/routemap0419/providers/Microsoft.Network/virtualHubs/westcentralus_hub1/routeMaps/testRouteMap +ProvisioningState : Succeeded +RouteMapRules : [ + { + "Name": "rule1", + "MatchCriteria": [ + { + "MatchCondition": "Contains", + "RoutePrefix": [ + "10.0.0.0/16" + ], + "Community": [], + "AsPath": [] + } + ], + "Actions": [ + { + "Type": "Add", + "Parameters": [ + { + "RoutePrefix": [], + "Community": [], + "AsPath": [ + "12345" + ] + } + ] + } + ], + "NextStepIfMatched": "Continue" + }, + { + "Name": "rule2", + "MatchCriteria": [ + { + "MatchCondition": "Equals", + "RoutePrefix": [], + "Community": [], + "AsPath": [ + "12345" + ] + } + ], + "Actions": [ + { + "Type": "Drop", + "Parameters": [] + } + ], + "NextStepIfMatched": "Terminate" + } + ] +AssociatedInboundConnections : [] +AssociatedOutboundConnections : [] +``` + +### Example 2 Apply route map to connections + +```powershell +$testRouteMap = Get-AzRouteMap -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteMap" + +$rt1 = Get-AzVHubRouteTable -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "defaultRouteTable" +$rt2 = Get-AzVHubRouteTable -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "noneRouteTable" +$testRoutingConfiguration =New-AzRoutingConfiguration -AssociatedRouteTable $rt1.Id -Label @("testLabel") -Id @($rt2.Id) -InboundRouteMap @($testRouteMap.Id) + +# creating virtual network and a virtual hub vnet connection resource +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.2.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.2.2.0/24" +$remoteVirtualNetwork = New-AzVirtualNetwork -Name "MyVirtualNetwork" -ResourceGroupName "testRG" -Location "westcentralus" -AddressPrefix "10.2.0.0/16" -Subnet $frontendSubnet,$backendSubnet +New-AzVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -Name "testvnetconnection" -RemoteVirtualNetwork $remoteVirtualNetwork -RoutingConfiguration $testRoutingConfiguration +``` + +```output +Name : testvnetconnection +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubVirtualNetworkConnections/testvnetconnection +RemoteVirtualNetwork : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork +EnableInternetSecurity : False +ProvisioningState : Succeeded +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + }, + "InboundRouteMap": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/routeMaps/testRouteMap" + } + } +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The route map name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, RouteMapName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteMapRule +List of route map rules in the route map. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteMapRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubName +The Virtual Hub name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: ParentVirtualHubName, ParentResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubObject +The Virtual Hub Object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub, ParentVirtualHub + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubResourceId +The Virtual Hub Resource Id. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId, ParentVirtualHubId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteMap + +## NOTES + +## RELATED LINKS + +[Get-AzRouteMap](./Get-AzRouteMap.md) + +[New-AzRouteMapRule](./New-AzRouteMapRule.md) + +[Update-AzRouteMap](./Update-AzRouteMap.md) + +[Remove-AzRouteMap](./Remove-AzRouteMap.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzRouteMapRule.md b/azps-10.1.0/Az.Network/New-AzRouteMapRule.md new file mode 100644 index 0000000000..ad497de674 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRouteMapRule.md @@ -0,0 +1,197 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azroutemaprule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteMapRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteMapRule.md +--- + +# New-AzRouteMapRule + +## SYNOPSIS +Create a route map rule. + +## SYNTAX + +``` +New-AzRouteMapRule [-MatchCriteria <PSRouteMapRuleCriterion[]>] -RouteMapRuleAction <PSRouteMapRuleAction[]> + -NextStepIfMatched <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a route map rule. + +## EXAMPLES + +### Example 1 + +```powershell +# creating new route map rules and a new route map resource +$routeMapMatchCriterion1 = New-AzRouteMapRuleCriterion -MatchCondition "Contains" -RoutePrefix @("10.0.0.0/16") +$routeMapRuleActionParameter1 = New-AzRouteMapRuleActionParameter -AsPath @("12345") +$routeMapRuleAction1 = New-AzRouteMapRuleAction -Type "Add" -Parameter @($routeMapRuleActionParameter1) +New-AzRouteMapRule -Name "rule1" -MatchCriteria @($routeMapMatchCriterion1) -RouteMapRuleAction @($routeMapRuleAction1) -NextStepIfMatched "Continue" +``` + +```output +MatchCriteria : {} +Actions : {} +NextStepIfMatched : Continue +MatchCriteriaText : [ + { + "MatchCondition": "Contains", + "RoutePrefix": [ + "10.0.0.0/16" + ] + } + ] +ActionsText : [ + { + "Type": "Add", + "Parameters": [ + { + "AsPath": [ + "12345" + ] + } + ] + } + ] +Name : rule1 +Etag : +Id : +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchCriteria +The route map rule Match Criteria. If not providing, will match all + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteMapRuleCriterion[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The route map rule name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextStepIfMatched +Next step if the route map rule matched. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteMapRuleAction +The route map rule actions. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteMapRuleAction[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteMapRuleCriterion + +### Microsoft.Azure.Commands.Network.Models.PSRouteMapRuleAction + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteMapRule + +## NOTES + +## RELATED LINKS + +[New-AzRouteMap](./New-AzRouteMap.md) + +[New-AzRouteMapRuleAction](./New-RouteMapRuleAction.md) + +[New-AzRouteMap](./New-AzRouteMap.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzRouteMapRuleAction.md b/azps-10.1.0/Az.Network/New-AzRouteMapRuleAction.md new file mode 100644 index 0000000000..dbe0243409 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRouteMapRuleAction.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azroutemapruleaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteMapRuleAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteMapRuleAction.md +--- + +# New-AzRouteMapRuleAction + +## SYNOPSIS +Create a route map rule action. + +## SYNTAX + +``` +New-AzRouteMapRuleAction -Type <String> [-Parameter <PSRouteMapRuleActionParameter[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a route map rule action. + +## EXAMPLES + +### Example 1 + +```powershell +# creating new route map rule action +$routeMapRuleActionParameter1 = New-AzRouteMapRuleActionParameter -AsPath @("12345") +New-AzRouteMapRuleAction -Type "Add" -Parameter @($routeMapRuleActionParameter1) +``` + +```output +Type : Add +Parameters : {} +ParametersText : [ + { + "AsPath": [ + "12345" + ] + } + ] +Name : +Etag : +Id : +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +The route map rule action parameter. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteMapRuleActionParameter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The route map rule action type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteMapRuleActionParameter + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteMapRuleAction + +## NOTES + +## RELATED LINKS + +[New-AzRouteMapRule](./New-AzRouteMapRule.md) + +[New-AzRouteMapRuleActionParameter](./New-AzRouteMapRuleActionParameter.md) diff --git a/azps-10.1.0/Az.Network/New-AzRouteMapRuleActionParameter.md b/azps-10.1.0/Az.Network/New-AzRouteMapRuleActionParameter.md new file mode 100644 index 0000000000..393e47914a --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRouteMapRuleActionParameter.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azroutemapruleactionparameter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteMapRuleActionParameter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteMapRuleActionParameter.md +--- + +# New-AzRouteMapRuleActionParameter + +## SYNOPSIS +Create a route map rule action parameter for the rule action. + +## SYNTAX + +``` +New-AzRouteMapRuleActionParameter [-RoutePrefix <String[]>] [-Community <String[]>] [-AsPath <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a route map rule action parameter for the rule action. + +## EXAMPLES + +### Example 1 + +```powershell +# creating new route map rule action +New-AzRouteMapRuleActionParameter -AsPath @("12345") +``` + +```output +RoutePrefix : +Community : +AsPath : {12345} +Name : +Etag : +Id : +``` + +## PARAMETERS + +### -AsPath +As Path + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Community +Community + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutePrefix +Route Prefix + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteMapRuleActionParameter + +## NOTES + +## RELATED LINKS + +[New-AzRouteMapRule](./New-AzRouteMapRule.md) + +[New-AzRouteMapRuleAction](./New-AzRouteMapRuleAction.md) diff --git a/azps-10.1.0/Az.Network/New-AzRouteMapRuleCriterion.md b/azps-10.1.0/Az.Network/New-AzRouteMapRuleCriterion.md new file mode 100644 index 0000000000..f633340327 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRouteMapRuleCriterion.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azroutemaprulecriterion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteMapRuleCriterion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteMapRuleCriterion.md +--- + +# New-AzRouteMapRuleCriterion + +## SYNOPSIS +Create a route map rule criterion. + +## SYNTAX + +``` +New-AzRouteMapRuleCriterion -MatchCondition <String> [-RoutePrefix <String[]>] [-Community <String[]>] + [-AsPath <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a route map rule criterion. + +## EXAMPLES + +### Example 1 + +```powershell +# creating new route map rule action +New-AzRouteMapRuleCriterion -MatchCondition "Contains" -RoutePrefix @("10.0.0.0/16") +``` + +```output +MatchCondition : Contains +RoutePrefix : {10.0.0.0/16} +Community : +AsPath : +Name : +Etag : +Id : +``` + +## PARAMETERS + +### -AsPath +As Path + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Community +Community + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchCondition +Match condition of a route, contains or equals + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutePrefix +Route Prefix + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteMapRuleActionParameter + +## NOTES + +## RELATED LINKS + +[New-AzRouteMapRule](./New-AzRouteMapRule.md) + +[New-AzRouteMapRuleAction](./New-AzRouteMapRuleAction.md) diff --git a/azps-10.1.0/Az.Network/New-AzRouteServer.md b/azps-10.1.0/Az.Network/New-AzRouteServer.md new file mode 100644 index 0000000000..c1574cddd8 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRouteServer.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azrouteserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteServer.md +--- + +# New-AzRouteServer + +## SYNOPSIS +Creates an Azure RouteServer. + +## SYNTAX + +``` +New-AzRouteServer -ResourceGroupName <String> -RouteServerName <String> -HostedSubnet <String> + [-PublicIpAddress <PSPublicIpAddress>] -Location <String> [-Tag <Hashtable>] [-Force] [-AsJob] + [-HubRoutingPreference <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRouteServer** cmdlet creates an Azure RouteServer + +## EXAMPLES + +### Example 1: Create a new router server +```powershell +New-AzResourceGroup -Name myResourceGroup -Location eastus + +$subnet = New-AzVirtualNetworkSubnetConfig -Name RouteServerSubnet -AddressPrefix 10.0.0.0/24 +$vnet = New-AzVirtualNetwork -Name myVNet -ResourceGroupName myResourceGroup -Location eastus -AddressPrefix 10.0.0.0/16 -Subnet $subnet +$subnetId = (Get-AzVirtualNetworkSubnetConfig -Name RouteServerSubnet -VirtualNetwork $vnet).Id +$publicIpAddress = New-AzPublicIpAddress -Name myRouteServerIP -ResourceGroupName myResourceGroup -AllocationMethod Static -Location eastus -Sku Standard -Tier Regional + +New-AzRouteServer -RouteServerName myRouteServer -ResourceGroupName myResourceGroup -Location eastus -HostedSubnet $subnetId -PublicIpAddress $publicIpAddress +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostedSubnet +The subnet where the route server is hosted. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubRoutingPreference +Routing Preference to route traffic + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: ExpressRoute, VpnGateway, ASPath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddress +The public ip address of ip configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the route server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteServerName +The name of the route server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteServer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzRouteTable.md b/azps-10.1.0/Az.Network/New-AzRouteTable.md new file mode 100644 index 0000000000..e9b0b59af6 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRouteTable.md @@ -0,0 +1,260 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 6A278F91-C078-4DD4-82D0-2E4FA549A089 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRouteTable.md +--- + +# New-AzRouteTable + +## SYNOPSIS +Creates a route table. + +## SYNTAX + +``` +New-AzRouteTable -ResourceGroupName <String> -Name <String> [-DisableBgpRoutePropagation] -Location <String> + [-Tag <Hashtable>] [-Route <PSRoute[]>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRouteTable** cmdlet creates an Azure route table. + +## EXAMPLES + +### Example 1: Create a route table that contains a route +```powershell +$Route = New-AzRouteConfig -Name "Route07" -AddressPrefix 10.1.0.0/16 -NextHopType "VnetLocal" +New-AzRouteTable -Name "RouteTable01" -ResourceGroupName "ResourceGroup11" -Location "EASTUS" -Route $Route +``` + +```output +Name : routetable01 +ResourceGroupName : ResourceGroup11 +Location : eastus +Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ + k/routeTables/myroutetable +Etag : W/"db5f4e12-3f34-465b-92dd-0ab3bf6fc274" +ProvisioningState : Succeeded +Tags : +Routes : [ + { + "Name": "route07", + "Etag": "W/\"db5f4e12-3f34-465b-92dd-0ab3bf6fc274\"", + "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro + soft.Network/routeTables/routetable01/routes/route07", + "AddressPrefix": "10.1.0.0/16", + "NextHopType": "VnetLocal", + "NextHopIpAddress": null, + "ProvisioningState": "Succeeded" + } + ] +Subnets : [] +``` + +The first command creates a route named Route07 by using the New-AzRouteConfig cmdlet, and +then stores it in the $Route variable. This route forwards packets to the local virtual network. +The second command creates a route table named RouteTable01, and adds the route stored in $Route to +the new table. The command specifies the resource group to which the table belongs and the location +for the table. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableBgpRoutePropagation +Disable BGP Route auto propagation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet creates a route table even if a route table that has the same name already exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the Azure region in which this cmdlet creates a route table. +For more information, see [Azure Regions](http://azure.microsoft.com/en-us/regions/). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the route table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group in which this cmdlet creates a route table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Route +Specifies an array of **Route** objects to associate with the route table. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoute[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Network.Models.PSRoute[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +## NOTES + +## RELATED LINKS + +[Get-AzRouteTable](./Get-AzRouteTable.md) + +[New-AzRouteConfig](./New-AzRouteConfig.md) + +[Remove-AzRouteTable](./Remove-AzRouteTable.md) + +[Set-AzRouteTable](./Set-AzRouteTable.md) diff --git a/azps-10.1.0/Az.Network/New-AzRoutingConfiguration.md b/azps-10.1.0/Az.Network/New-AzRoutingConfiguration.md new file mode 100644 index 0000000000..bffe590163 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRoutingConfiguration.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azroutingconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRoutingConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRoutingConfiguration.md +--- + +# New-AzRoutingConfiguration + +## SYNOPSIS +Creates a RoutingConfiguration object. + +## SYNTAX + +``` +New-AzRoutingConfiguration -AssociatedRouteTable <String> -Label <String[]> -Id <String[]> + [-StaticRoute <PSStaticRoute[]>] [-VnetLocalRouteOverrideCriteria <String>] [-InboundRouteMap <String>] + [-OutboundRouteMap <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a RoutingConfiguration object. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRg" +$virtualHubName = "testHub" +$inboundRouteMap = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/routeMaps/testRouteMap" +$rt1 = Get-AzVHubRouteTable -ResourceGroupName $rgName -VirtualHubName $virtualHubName -Name "defaultRouteTable" +$rt2 = Get-AzVHubRouteTable -ResourceGroupName $rgName -VirtualHubName $virtualHubName -Name "noneRouteTable" +$route1 = New-AzStaticRoute -Name "route1" -AddressPrefix @("10.20.0.0/16", "10.30.0.0/16")-NextHopIpAddress "10.90.0.5" +New-AzRoutingConfiguration -AssociatedRouteTable $rt1.Id -Label @("testLabel") -Id @($rt2.Id) -StaticRoute @($route1) -InboundRouteMap $inboundRouteMap +``` + +```output +AssociatedRouteTable : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/hubRouteTables/defaultRouteTable" +PropagatedRouteTables : { + "Labels": [ + "testLabel" + ], + "Ids": [ + { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/hubRouteTables/noneRouteTable" + } + ], + "InboundRouteMap": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/routeMaps/testRouteMap" + } +VnetRoutes : { + "StaticRoutes": [ + { + "Name": "route1", + "AddressPrefixes": [ + "10.20.0.0/16", + "10.30.0.0/16" + ], + "NextHopIpAddress": "10.90.0.5" + } + ] + } +``` + +The above command will create a RoutingConfiguration object which can then be added to a connection resource. Static routes are only allowed with a HubVirtualNetworkConnection object. + +## PARAMETERS + +### -AssociatedRouteTable +The hub route table associated with this routing configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The list of resource ids of all the hub route tables to advertise the routes to for the PropagatedRouteTables property. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundRouteMap +The inbound route maps of this routing configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +The list of labels for the PropagatedRouteTables property. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutboundRouteMap +The outbound route maps of this routing configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StaticRoute +List of routes that control routing from VirtualHub into a virtual network connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSStaticRoute[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetLocalRouteOverrideCriteria +Should we bypass NVA for destinations in spoke vnet? 'Contains' for no, 'Equal' for yes. Default is 'Contains'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSStaticRoute + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRoutingConfiguration + +## NOTES + +## RELATED LINKS + +[New-AzStaticRoute](./New-AzStaticRoute.md) + +[New-AzExpressRouteConnection](./New-AzExpressRouteConnection.md) + +[Set-AzExpressRouteConnection](./Set-AzExpressRouteConnection.md) + +[New-AzVirtualHubVnetConnection](./New-AzVpnConnection.md) + +[Update-AzVirtualHubVnetConnection](./Update-AzVpnConnection.md) + +[New-AzP2sVpnGateway](./New-AzP2sVpnGateway.md) + +[Update-AzP2sVpnGateway](./Update-AzP2sVpnGateway.md) + +[New-AzVpnConnection](./New-AzVpnConnection.md) + +[Update-AzVpnConnection](./Update-AzVpnConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzRoutingIntent.md b/azps-10.1.0/Az.Network/New-AzRoutingIntent.md new file mode 100644 index 0000000000..65050fc114 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRoutingIntent.md @@ -0,0 +1,278 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azroutingintent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRoutingIntent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRoutingIntent.md +--- + +# New-AzRoutingIntent + +## SYNOPSIS +Creates a routing intent resource associated with a VirtualHub. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +New-AzRoutingIntent -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + -RoutingPolicy <PSRoutingPolicy[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +New-AzRoutingIntent -ParentObject <PSVirtualHub> -Name <String> -RoutingPolicy <PSRoutingPolicy[]> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +New-AzRoutingIntent -ParentResourceId <String> -Name <String> -RoutingPolicy <PSRoutingPolicy[]> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates the specified routing intent that is associated with the specified virtual hub with the provided list of routing policies. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" + +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" + +$fwIp = New-AzFirewallHubPublicIpAddress -Count 1 +$hubIpAddresses = New-AzFirewallHubIpAddress -PublicIP $fwIp + +New-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" -Location "westcentralus" -Sku AZFW_Hub -VirtualHubId $virtualHub.Id -HubIPAddress $hubIpAddresses +$firewall = Get-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" + +$policy1 = New-AzRoutingPolicy -Name "PrivateTraffic" -Destination @("PrivateTraffic") -NextHop $firewall.Id +$policy2 = New-AzRoutingPolicy -Name "PublicTraffic" -Destination @("Internet") -NextHop $firewall.Id + +New-AzRoutingIntent -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRoutingIntent" -RoutingPolicy @($policy1, $policy2) +``` + +```output +ProvisioningState : Succeeded +RoutingPolicies : {PrivateTraffic, PublicTraffic} +RoutingPoliciesText : [ + { + "Name": "PrivateTraffic", + "DestinationType": "TrafficType", + "Destinations": [ + "PrivateTraffic" + ], + "NextHopType": "ResourceId", + "NextHop": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall" + }, + { + "Name": "PublicTraffic", + "DestinationType": "TrafficType", + "Destinations": [ + "Internet" + ], + "NextHopType": "ResourceId", + "NextHop": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall" + } + ] +Name : testRoutingIntent +Etag : W/"etag" +Id : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/routingIntent/testRoutingIntent +``` + +This command creates a routing intent of the virtual hub. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, RoutingIntentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The parent virtual hub object of this resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The resource id of the virtual hub resource. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId, ParentVirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: VirtualHubName, ParentVirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingPolicy +The list of routing policies for this rouoting intent resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingPolicy[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### Microsoft.Azure.Commands.Network.Models.PSRoutingPolicy + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRoutingIntent + +## NOTES + +## RELATED LINKS + +[Add-AzRoutingPolicy](./Add-AzRoutingPolicy.md) + +[Get-AzRoutingIntent](./Get-AzRoutingIntent.md) + +[Get-AzRoutingPolicy](./Get-AzRoutingPolicy.md) + +[New-AzRoutingPolicy](./New-AzRoutingPolicy.md) + +[Remove-AzRoutingIntent](./Remove-AzRoutingIntent.md) + +[Remove-AzRoutingPolicy](./Remove-AzRoutingPolicy.md) + +[Set-AzRoutingIntent](./Set-AzRoutingIntent.md) + +[Set-AzRoutingPolicy](./Set-AzRoutingPolicy.md) diff --git a/azps-10.1.0/Az.Network/New-AzRoutingPolicy.md b/azps-10.1.0/Az.Network/New-AzRoutingPolicy.md new file mode 100644 index 0000000000..0e1fa1c7d5 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzRoutingPolicy.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azroutingpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRoutingPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzRoutingPolicy.md +--- + +# New-AzRoutingPolicy + +## SYNOPSIS +Returns an in-memory routing policy object. + +## SYNTAX + +``` +New-AzRoutingPolicy -Destination <String[]> -NextHop <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRoutingPolicy** cmdlet creates a routing policy object. This can be passed in to [Add-AzRoutingPolicy](./Add-AzRoutingPolicy.md) cmdlet to add to an existing routing intent resource or [New-AzRoutingIntent](./New-AzRoutingIntent.md) cmdlet to create a new routing intent resource. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRg" +$firewallName = "testFirewall" +$firewall = Get-AzFirewall -Name $firewallName -ResourceGroupName $rgName +New-AzRoutingPolicy -Name "PrivateTraffic" -Destination @("PrivateTraffic") -NextHop $firewall.Id +``` + +```output +Name : PrivateTraffic +DestinationType : TrafficType +Destinations : {PrivateTraffic} +NextHopType : ResourceId +NextHop : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +The list of destinations. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the routing policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextHop +Id of the next hop resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSRoutingIntent + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRoutingPolicy + +## NOTES + +## RELATED LINKS + +[Add-AzRoutingPolicy](./Add-AzRoutingPolicy.md) + +[Get-AzRoutingIntent](./Get-AzRoutingIntent.md) + +[Get-AzRoutingPolicy](./Get-AzRoutingPolicy.md) + +[New-AzRoutingIntent](./New-AzRoutingIntent.md) + +[Remove-AzRoutingIntent](./Remove-AzRoutingIntent.md) + +[Remove-AzRoutingPolicy](./Remove-AzRoutingPolicy.md) + +[Set-AzRoutingIntent](./Set-AzRoutingIntent.md) + +[Set-AzRoutingPolicy](./Set-AzRoutingPolicy.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzSecurityPartnerProvider.md b/azps-10.1.0/Az.Network/New-AzSecurityPartnerProvider.md new file mode 100644 index 0000000000..59fa5d4be2 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzSecurityPartnerProvider.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azsecuritypartnerprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzSecurityPartnerProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzSecurityPartnerProvider.md +--- + +# New-AzSecurityPartnerProvider + +## SYNOPSIS +Creates an Azure SecurityPartnerProvider. + +## SYNTAX + +``` +New-AzSecurityPartnerProvider -Name <String> -ResourceGroupName <String> -Location <String> + -SecurityProviderName <String> [-VirtualHub <PSVirtualHub>] [-VirtualHubId <String>] + [-VirtualHubName <String>] [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSecurityPartnerProvider** cmdlet creates an Azure SecurityPartnerProvider + +## EXAMPLES + +### Example 1 +```powershell +New-AzSecurityPartnerProvider -Name securityPartnerProviderName -ResourceGroupName rgname -Location 'West US' -SecurityProviderName 'ZScaler' +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecurityProviderName +The Security Provider name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: ZScaler, IBoss, Checkpoint + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualHub +The virtual hub Id that the security partner provider is attached to + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubId +The Id of the VirtualHub this VpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualHubName +The Id of the VirtualHub this VpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSSecurityPartnerProvider + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzServiceEndpointPolicy.md b/azps-10.1.0/Az.Network/New-AzServiceEndpointPolicy.md new file mode 100644 index 0000000000..489b5b4474 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzServiceEndpointPolicy.md @@ -0,0 +1,178 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azserviceendpointpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzServiceEndpointPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzServiceEndpointPolicy.md +--- + +# New-AzServiceEndpointPolicy + +## SYNOPSIS +Creates a service endpoint policy. + +## SYNTAX + +``` +New-AzServiceEndpointPolicy -Name <String> + [-ServiceEndpointPolicyDefinition <PSServiceEndpointPolicyDefinition[]>] -ResourceGroupName <String> + -Location <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzServiceEndpointPolicy** cmdlet create a service endpoint policy. + +## EXAMPLES + +### Example 1: Creates a service endpoint policy +```powershell +$serviceEndpointPolicy = New-AzServiceEndpointPolicy -Name "Policy1" -ServiceEndpointPolicyDefinition $serviceEndpointDefinition -Location "location"; +``` + +This command creates a service endpoint policy named Policy1 with definitions defined by the object $serviceEndpointDefinition and stores it in the $serviceEndpointPolicy variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the subnet + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceEndpointPolicyDefinition +List of service endpoint definitions + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicyDefinition[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzServiceEndpointPolicy](./Get-AzServiceEndpointPolicy.md) + +[Remove-AzServiceEndpointPolicy](./Remove-AzServiceEndpointPolicy.md) + +[Set-AzServiceEndpointPolicy](./Set-AzServiceEndpointPolicy.md) diff --git a/azps-10.1.0/Az.Network/New-AzServiceEndpointPolicyDefinition.md b/azps-10.1.0/Az.Network/New-AzServiceEndpointPolicyDefinition.md new file mode 100644 index 0000000000..7828da2e3f --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzServiceEndpointPolicyDefinition.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azserviceendpointpolicydefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzServiceEndpointPolicyDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzServiceEndpointPolicyDefinition.md +--- + +# New-AzServiceEndpointPolicyDefinition + +## SYNOPSIS +Creates a service endpoint policy definition. + +## SYNTAX + +``` +New-AzServiceEndpointPolicyDefinition -Name <String> [-Description <String>] [-ServiceResource <String[]>] + [-Service <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzServiceEndpointPolicyDefinition** cmdlet create a service endpoint policy definition. + +## EXAMPLES + +### Example 1: Creates a service endpoint policy +```powershell +$policydef= New-AzServiceEndpointPolicyDefinition -Name "ServiceEndpointPolicyDefinition1" -Service "Microsoft.Storage" -ServiceResource "subscriptions/sub1" -Description "New Definition" +``` + +This command creates the service endpoint policy definition with name ServiceEndpointPolicyDefinition1, service Microsoft.Storage, service resources subscriptions/sub1 and +description "New Definition" that belongs to the resource group named ResourceGroup01 and stores it in the $policydef variable. + +### Example 2 + +Creates a service endpoint policy definition. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzServiceEndpointPolicyDefinition -Description 'New Definition' -Name 'ServiceEndpointPolicyDefinition1' -Service 'Microsoft.Storage' -ServiceResource <String[]> +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the definition + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service endpoint policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Service +Name of the service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceResource +List of service resources + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicyDefinition + +## NOTES + +## RELATED LINKS + +[Add-AzServiceEndpointPolicyDefinition](./Add-AzServiceEndpointPolicyDefinition.md) + +[Get-AzServiceEndpointPolicyDefinition](./Get-AzServiceEndpointPolicyDefinition.md) + +[Remove-AzServiceEndpointPolicyDefinition](./Remove-AzServiceEndpointPolicyDefinition.md) + +[Set-AzServiceEndpointPolicyDefinition](./Set-AzServiceEndpointPolicyDefinition.md) diff --git a/azps-10.1.0/Az.Network/New-AzStaticRoute.md b/azps-10.1.0/Az.Network/New-AzStaticRoute.md new file mode 100644 index 0000000000..4df143edb7 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzStaticRoute.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azstaticroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzStaticRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzStaticRoute.md +--- + +# New-AzStaticRoute + +## SYNOPSIS +Creates a StaticRoute object which can then be added to a RoutingConfiguration object. + +## SYNTAX + +``` +New-AzStaticRoute -Name <String> -AddressPrefix <String[]> -NextHopIpAddress <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a StaticRoute object. + +## EXAMPLES + +### Example 1 +```powershell +New-AzStaticRoute -Name "route1" -AddressPrefix @("10.20.0.0/16", "10.30.0.0/16") -NextHopIpAddress "10.90.0.5" +``` + +```output +Name AddressPrefixes NextHopIpAddress +---- --------------- ---------------- +route1 {10.20.0.0/16, 10.30.0.0/16} 10.90.0.5 +``` + +The above command will create a StaticRoute object which can then be added to a RoutingConfiguration object. + +## PARAMETERS + +### -AddressPrefix +List of address prefixes. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The route name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextHopIpAddress +The next hop ip address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSStaticRoute + +## NOTES + +## RELATED LINKS + +[New-AzRoutingConfiguration](./New-AzRoutingConfiguration.md) diff --git a/azps-10.1.0/Az.Network/New-AzVHubRoute.md b/azps-10.1.0/Az.Network/New-AzVHubRoute.md new file mode 100644 index 0000000000..c1d90324f8 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVHubRoute.md @@ -0,0 +1,248 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvhubroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVHubRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVHubRoute.md +--- + +# New-AzVHubRoute + +## SYNOPSIS +Creates a VHubRoute object which can be passed as parameter to the New-AzVHubRouteTable command. + +## SYNTAX + +``` +New-AzVHubRoute -Destination <String[]> -DestinationType <String> -NextHop <String> -Name <String> + -NextHopType <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION + +Creates a VHubRoute object. + +## EXAMPLES + +### Example 1 + +```powershell +$rgName = "testRg" +$firewallName = "testFirewall" +$firewall = Get-AzFirewall -Name $firewallName -ResourceGroupName $rgName +New-AzVHubRoute -Name "private-traffic" -Destination @("10.30.0.0/16", "10.40.0.0/16") -DestinationType "CIDR" -NextHop $firewall.Id -NextHopType "ResourceId" +``` + +```output +Name : private-traffic +DestinationType : CIDR +Destinations : {10.30.0.0/16, 10.40.0.0/16} +NextHopType : ResourceId +NextHop : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall +``` + +The above command will create a VHubRoute object with nextHop as the specified Firewall which can then be added to a VHubRouteTable resource. + +### Example 2 + +```powershell +$rgName = "testRg" +$hubName = "testHub" +$hubVnetConnName = "testHubVnetConn" +$hubVnetConnection = Get-AzVirtualHubVnetConnection -Name $hubVnetConnName -ParentResourceName $hubName -ResourceGroupName $rgName +New-AzVHubRoute -Name "nva-traffic" -Destination @("10.20.0.0/16", "10.50.0.0/16") -DestinationType "CIDR" -NextHop $hubVnetConnection.Id -NextHopType "ResourceId" +``` + +```output +Name : private-traffic +DestinationType : CIDR +Destinations : {10.30.0.0/16, 10.40.0.0/16} +NextHopType : ResourceId +NextHop : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/hubVirtualNetworkConnections/testHubVnetConn +``` + +The above command will create a VHubRoute object with nextHop as the specified hubVnetConnection which can then be added to a VHubRouteTable resource. + +### Example 3 +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$hub = Get-AzVirtualHub -ResourceGroupName "rgname" -Name "virtual-hub-name" +$hubVnetConn = Get-AzVirtualHubVnetConnection -ParentObject $hub -Name "connection-name" +$hubVnetConn + +Name : conn_2 +Id : /subscriptions/{subscriptionID}/resourceGroups/{rgname}/providers/Microsoft.Network/virtualHubs/{virtual-hub-name}/hubVirtualNetworkConnections/conn_2 +RemoteVirtualNetwork : /subscriptions/{subscriptionID}/resourceGroups/{rgname}/providers/Microsoft.Network/virtualNetworks/rVnet_2 +EnableInternetSecurity : True +ProvisioningState : Succeeded +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionID}/resourceGroups/{rgname}/providers/Microsoft.Network/virtualHubs/{virtual-hub-name}/hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [ + "default" + ], + "Ids": [ + { + "Id": + "/subscriptions/{subscriptionID}/resourceGroups/{rgname}/providers/Microsoft.Network/virtualHubs/{virtual-hub-name}/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } + +$staticRoute1 = New-AzStaticRoute -Name "static_route1" -AddressPrefix @("10.2.1.0/24", "10.2.3.0/24") -NextHopIpAddress "10.2.0.5" +$routingConfig = $hubVnetConn.RoutingConfiguration +$routingConfig.VnetRoutes.StaticRoutes = @($staticRoute1) +$routingConfig +AssociatedRouteTable : Microsoft.Azure.Commands.Network.Models.PSResourceId +PropagatedRouteTables : { + "Labels": [ + "default" + ], + "Ids": [ + { + "Id": + "/subscriptions/{subscriptionID}/resourceGroups/{rgname}/providers/Microsoft.Network/virtualHubs/rTestHub1/hubRouteTables/defaultRouteTable" + } + ] + } +VnetRoutes : { + "StaticRoutes": [ + { + "Name": "static_route1", + "AddressPrefixes": [ + "10.2.1.0/24", + "10.2.3.0/24" + ], + "NextHopIpAddress": "10.2.0.5" + } + ] + } + +Update-AzVirtualHubVnetConnection -InputObject $hubVnetConn -RoutingConfiguration $routingConfig +``` + +The above commands will get the RoutingConfiguration of an already existing AzVHubRoute and then add a static route on the connection. Alternatively, if you hope to create a new connection with the static route within it, please see Example 1 [here.](New-AzRoutingConfiguration.md) + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +List of Destinations. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationType +Type of Destinations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The route name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextHop +The next hop. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextHopType +The Next Hop type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVHubRoute + +## NOTES + +## RELATED LINKS + +[Get-AzVHubRouteTable](./Get-AzVHubRouteTable.md) + +[New-AzVHubRouteTable](./New-AzVHubRouteTable.md) + +[Remove-AzVHubRouteTable](./Remove-AzVHubRouteTable.md) + +[Update-AzVHubRouteTable](./Update-AzVHubRouteTable.md) diff --git a/azps-10.1.0/Az.Network/New-AzVHubRouteTable.md b/azps-10.1.0/Az.Network/New-AzVHubRouteTable.md new file mode 100644 index 0000000000..f5237b835e --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVHubRouteTable.md @@ -0,0 +1,275 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvhubroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVHubRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVHubRouteTable.md +--- + +# New-AzVHubRouteTable + +## SYNOPSIS +Creates a hub route table resource associated with a VirtualHub. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +New-AzVHubRouteTable -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + -Route <PSVHubRoute[]> -Label <String[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +New-AzVHubRouteTable -ParentObject <PSVirtualHub> -Name <String> -Route <PSVHubRoute[]> -Label <String[]> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +New-AzVHubRouteTable -ParentResourceId <String> -Name <String> -Route <PSVHubRoute[]> -Label <String[]> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates the specified route table that is associated with the specified virtual hub with the provided routes and the labels. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" + +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" + +$fwIp = New-AzFirewallHubPublicIpAddress -Count 1 +$hubIpAddresses = New-AzFirewallHubIpAddress -PublicIP $fwIp +New-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" -Location "westcentralus" -Sku AZFW_Hub -VirtualHubId $virtualHub.Id -HubIPAddress $hubIpAddresses +$firewall = Get-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" + +$route1 = New-AzVHubRoute -Name "private-traffic" -Destination @("10.30.0.0/16", "10.40.0.0/16") -DestinationType "CIDR" -NextHop $firewall.Id -NextHopType "ResourceId" +New-AzVHubRouteTable -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteTable" -Route @($route1) -Label @("testLabel") +``` + +```output +Name : testRouteTable +Id : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/hubRouteTables/testRouteTable +ProvisioningState : Succeeded +Labels : {testLabel} +Routes : [ + { + "Name": "private-traffic", + "DestinationType": "CIDR", + "Destinations": [ + "10.30.0.0/16", + "10.40.0.0/16" + ], + "NextHopType": "ResourceId", + "NextHop": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall" + } + ] +AssociatedConnections : [] +PropagatingConnections : [] +``` + +This command creates a hub route table of the virtual hub. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +The list of labels. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VHubRouteTableName, RouteTableName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The parent virtual hub object of this resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The resource id of the virtual hub resource. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId, ParentVirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: VirtualHubName, ParentVirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Route +The list of routes for this route table. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVHubRoute[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### Microsoft.Azure.Commands.Network.Models.PSVHubRouteTable + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVHubRouteTable + +## NOTES + +## RELATED LINKS + +[Get-AzVHubRouteTable](./Get-AzVHubRouteTable.md) + +[New-AzVHubRoute](./New-AzVHubRoute.md) + +[Remove-AzVHubRouteTable](./Remove-AzVHubRouteTable.md) + +[Update-AzVHubRouteTable](./Update-AzVHubRouteTable.md) diff --git a/azps-10.1.0/Az.Network/New-AzVirtualApplianceAdditionalNicProperty.md b/azps-10.1.0/Az.Network/New-AzVirtualApplianceAdditionalNicProperty.md new file mode 100644 index 0000000000..d1246ad370 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualApplianceAdditionalNicProperty.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualapplianceadditionalnicproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualApplianceAdditionalNicProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualApplianceAdditionalNicProperty.md +--- + +# New-AzVirtualApplianceAdditionalNicProperty + +## SYNOPSIS +Define a Network Virtual Appliance Additional Nic Property for the resource. + +## SYNTAX + +``` +New-AzVirtualApplianceAdditionalNicProperty -NicName <String> -HasPublicIP <Boolean> [-AddressFamily <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzVirtualApplianceAdditionalNicProperty command defines an Additional Nic Property for Network Virtual Appliance resource. + +## EXAMPLES + +### Example 1 +```powershell +$var=New-AzVirtualApplianceAdditionalNicProperty -NicName "sdwan" -HasPublicIp $true +``` + +Create an Additional Nic Property object to be used with New-AzNetworkVirtualAppliance command. + +## PARAMETERS + +### -AddressFamily +The Address Family for IP for Interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasPublicIP +Additional Interface to have public IP or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NicName +The Name of Interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceAdditionalNicProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzVirtualApplianceSite.md b/azps-10.1.0/Az.Network/New-AzVirtualApplianceSite.md new file mode 100644 index 0000000000..d3ab238b55 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualApplianceSite.md @@ -0,0 +1,245 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualappliancesite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualApplianceSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualApplianceSite.md +--- + +# New-AzVirtualApplianceSite + +## SYNOPSIS +Create a site connected to a Network Virtual Appliance. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +New-AzVirtualApplianceSite -Name <String> -ResourceGroupName <String> -AddressPrefix <String> + -O365Policy <PSOffice365PolicyProperties> -NetworkVirtualApplianceId <String> [-Tag <Hashtable>] [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +New-AzVirtualApplianceSite -ResourceId <String> -AddressPrefix <String> + -O365Policy <PSOffice365PolicyProperties> -NetworkVirtualApplianceId <String> [-Tag <Hashtable>] [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzVirtualApplianceSite command creates a Virtual Appliance site connected to a Network Virtual Appliance resource. + +## EXAMPLES + +### Example 1 +```powershell +$nva = Get-AzNetworkVirtualAppliance -ResourceGroupName testrg -Name nva +$o365Policy = New-AzOffice365PolicyProperty -Allow -Optimize +$site = New-AzVirtualApplianceSite -ResourceGroupName testrg -Name testsite -NetworkVirtualApplianceId $nva.Id -AddressPrefix 10.0.1.0/24 -O365Policy $o365Policy +``` + +Create a new Virtual Appliance site in the resource group: testrg. + +## PARAMETERS + +### -AddressPrefix +The address prefix for the site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkVirtualApplianceId +The Network virtual appliance that this site is attached to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -O365Policy +The Office 365 breakout policy. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSOffice365PolicyProperties +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSOffice365PolicyProperties + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceSite + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzVirtualApplianceSkuProperty.md b/azps-10.1.0/Az.Network/New-AzVirtualApplianceSkuProperty.md new file mode 100644 index 0000000000..8fb825da43 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualApplianceSkuProperty.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualapplianceskuproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualApplianceSkuProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualApplianceSkuProperty.md +--- + +# New-AzVirtualApplianceSkuProperty + +## SYNOPSIS +Define a Network Virtual Appliance sku for the resource. + +## SYNTAX + +``` +New-AzVirtualApplianceSkuProperty -VendorName <String> -BundledScaleUnit <String> -MarketPlaceVersion <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzVirtualApplianceSkuProperties command defines a Sku for Network Virtual Appliance resource. + +## EXAMPLES + +### Example 1 +```powershell +$var=New-AzVirtualApplianceSkuProperty -VendorName "barracudasdwanrelease" -BundledScaleUnit 1 -MarketPlaceVersion 'latest' +``` + +Create a Virtual Appliance Sku Properties object to be used with New-AzNetworkVirtualAppliance command. + +## PARAMETERS + +### -BundledScaleUnit +The bundled scale unit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketPlaceVersion +The market place version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VendorName +The name of the vendor. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceSkuProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzVirtualHub.md b/azps-10.1.0/Az.Network/New-AzVirtualHub.md new file mode 100644 index 0000000000..fda724b92b --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualHub.md @@ -0,0 +1,453 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualHub.md +--- + +# New-AzVirtualHub + +## SYNOPSIS +Creates an Azure VirtualHub resource. + +## SYNTAX + +### ByVirtualWanObject (Default) +``` +New-AzVirtualHub -ResourceGroupName <String> -Name <String> -VirtualWan <PSVirtualWan> -AddressPrefix <String> + -Location <String> [-HubVnetConnection <PSHubVirtualNetworkConnection[]>] + [-RouteTable <PSVirtualHubRouteTable>] [-Tag <Hashtable>] [-Sku <String>] [-PreferredRoutingGateway <String>] + [-HubRoutingPreference <String>] [-VirtualRouterAsn <UInt32>] + [-VirtualRouterAutoScaleConfiguration <PSVirtualRouterAutoScaleConfiguration>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanResourceId +``` +New-AzVirtualHub -ResourceGroupName <String> -Name <String> -VirtualWanId <String> -AddressPrefix <String> + -Location <String> [-HubVnetConnection <PSHubVirtualNetworkConnection[]>] + [-RouteTable <PSVirtualHubRouteTable>] [-Tag <Hashtable>] [-Sku <String>] [-PreferredRoutingGateway <String>] + [-HubRoutingPreference <String>] [-VirtualRouterAsn <UInt32>] + [-VirtualRouterAutoScaleConfiguration <PSVirtualRouterAutoScaleConfiguration>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an Azure VirtualHub resource. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +``` + +```output +VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +ResourceGroupName : testRG +Name : westushub +Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub +AddressPrefix : 10.0.1.0/24 +RouteTable : +VirtualNetworkConnections : {} +RouteTables : {} +Location : West US +Sku : Standard +PreferredRoutingGateway : ExpressRoute +HubRoutingPreference : ExpressRoute +Type : Microsoft.Network/virtualHubs +ProvisioningState : Succeeded +``` + +The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". + +### Example 2 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWanId $virtualWan.Id -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -Location "West US" +``` + +```output +VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +ResourceGroupName : testRG +Name : westushub +Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub +AddressPrefix : 10.0.1.0/24 +RouteTable : +VirtualNetworkConnections : {} +RouteTables : {} +Location : West US +Sku : Standard +PreferredRoutingGateway : ExpressRoute +HubRoutingPreference : ExpressRoute +Type : Microsoft.Network/virtualHubs +ProvisioningState : Succeeded +``` + +The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". + +This example is similar to Example 1, but uses a resource Id to reference the Virtual WAN that is required to create the virtual Hub. + +### Example 3 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +$route1 = New-AzVirtualHubRoute -AddressPrefix @("10.0.0.0/16", "11.0.0.0/16") -NextHopIpAddress "12.0.0.5" +$route2 = New-AzVirtualHubRoute -AddressPrefix @("13.0.0.0/16") -NextHopIpAddress "14.0.0.5" +$routeTable = New-AzVirtualHubRouteTable -Route @($route1, $route2) +New-AzVirtualHub -VirtualWanId $virtualWan.Id -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -RouteTable $routeTable +``` + +```output +VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +ResourceGroupName : testRG +Name : westushub +Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub +AddressPrefix : 10.0.1.0/24 +RouteTable : Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable +VirtualNetworkConnections : {} +RouteTables : {} +Location : West US +Sku : Standard +PreferredRoutingGateway : ExpressRoute +HubRoutingPreference : ExpressRoute +Type : Microsoft.Network/virtualHubs +ProvisioningState : Succeeded +``` + +The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24" and a route table attached. + +This example is similar to Example 2, but also attaches a route table to the virtual hub. + +### Example 4 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +$autoscale = New-AzVirtualRouterAutoScaleConfiguration -MinCapacity 3 +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -HubRoutingPreference "VpnGateway" -VirtualRouterAutoScaleConfiguration $autoscale +``` + +```output +VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +ResourceGroupName : testRG +Name : westushub +Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub +AddressPrefix : 10.0.1.0/24 +RouteTable : +Location : West US +Sku : Standard +HubRoutingPreference : VpnGateway +VirtualNetworkConnections : {} +Location : West US +Type : Microsoft.Network/virtualHubs +ProvisioningState : Succeeded +``` + +The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have preferred routing gateway as VPNGateway and minimum capacity 3. + +## PARAMETERS + +### -AddressPrefix +The address space string for this virtual hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubRoutingPreference +Virtual Hub Routing Preference to route traffic + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: ExpressRoute, VpnGateway, ASPath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubVnetConnection +The hub virtual network connections associated with this Virtual Hub. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredRoutingGateway +Preferred Routing Gateway to Route On-Prem traffic from VNET (Deprecated, please use HubRoutingPreference) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: ExpressRoute, VpnGateway + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteTable +The route table associated with this Virtual Hub. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The sku of the Virtual Hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualRouterAsn +The ASN of this virtual hub + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualRouterAutoScaleConfiguration +Autoscale configuration for the hub router + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualRouterAutoScaleConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualWan +The virtual wan object this hub is linked to. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan +Parameter Sets: ByVirtualWanObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualWanId +The id of virtual wan object this hub is linked to. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualWan + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualHub](./Get-AzVirtualHub.md) + +[Remove-AzVirtualHub](./Remove-AzVirtualHub.md) + +[Update-AzVirtualHub](./Update-AzVirtualHub.md) diff --git a/azps-10.1.0/Az.Network/New-AzVirtualHubBgpConnection.md b/azps-10.1.0/Az.Network/New-AzVirtualHubBgpConnection.md new file mode 100644 index 0000000000..47edd56bbe --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualHubBgpConnection.md @@ -0,0 +1,323 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualhubbgpconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualHubBgpConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualHubBgpConnection.md +--- + +# New-AzVirtualHubBgpConnection + +## SYNOPSIS +The New-AzVirtualHubBgpConnection cmdlet creates a HubBgpConnection resource that peers the Azure Virtual WAN Hub Router with a BGP-enabled peer in a virtual network connected to the Virtual WAN Hub. + +## SYNTAX + +### ByVirtualHubNameByHubVirtualNetworkConnectionObject (Default) +``` +New-AzVirtualHubBgpConnection -ResourceGroupName <String> -VirtualHubName <String> -PeerIp <String> + -PeerAsn <UInt32> -Name <String> -VirtualHubVnetConnection <PSHubVirtualNetworkConnection> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubNameByHubVirtualNetworkConnectionResourceId +``` +New-AzVirtualHubBgpConnection -ResourceGroupName <String> -VirtualHubName <String> -PeerIp <String> + -PeerAsn <UInt32> -Name <String> -VirtualHubVnetConnectionId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObjectByHubVirtualNetworkConnectionObject +``` +New-AzVirtualHubBgpConnection -PeerIp <String> -PeerAsn <UInt32> -Name <String> + -VirtualHubVnetConnection <PSHubVirtualNetworkConnection> -VirtualHub <PSVirtualHub> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByHubVirtualNetworkConnectionObject +``` +New-AzVirtualHubBgpConnection -PeerIp <String> -PeerAsn <UInt32> -Name <String> + -VirtualHubVnetConnection <PSHubVirtualNetworkConnection> -VirtualHubId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId +``` +New-AzVirtualHubBgpConnection -PeerIp <String> -PeerAsn <UInt32> -Name <String> + -VirtualHubVnetConnectionId <String> -VirtualHub <PSVirtualHub> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByHubVirtualNetworkConnectionResourceId +``` +New-AzVirtualHubBgpConnection -PeerIp <String> -PeerAsn <UInt32> -Name <String> + -VirtualHubVnetConnectionId <String> -VirtualHubId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzVirtualHubBgpConnection cmdlet creates a HubBgpConnection resource that peers Azure Virtual WAN Hub Router with a BGP-enabled peer in virtual network connected to the Virtual WAN Hub. + +## EXAMPLES + +### Example 1 +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "192.168.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "192.168.2.0/24" +$remoteVirtualNetwork = New-AzVirtualNetwork -Name "testVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "192.168.0.0/16" -Subnet $frontendSubnet,$backendSubnet +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "testWan" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "testHub" -AddressPrefix "10.0.1.0/24" +$hubVnetConnection = New-AzVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -Name "testVnetConnection" -RemoteVirtualNetwork $remoteVirtualNetwork +New-AzVirtualHubBgpConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -PeerIp 192.168.1.5 -PeerAsn 20000 -Name "testBgpConnection" -VirtualHubVnetConnection $hubVnetConnection +``` + +```output +Name : testBgpConnection +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/bgpConnections/testBgpConnection +HubVirtualNetworkConnection : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/hubVirtualNetworkConnections/testVnetConnection +PeerAsn : 20000 +PeerIp : 192.168.1.5 +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual WAN Hub in West US and connect the Virtual Network to the Virtual WAN Hub in that resource group in Azure. A Virtual WAN Hub BGP Connection will be created thereafter which will peer the Virtual WAN Hub with the network appliance deployed in the Virtual Network. + +### Example 2 +```powershell +$hubVnetConnection = Get-AzVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -Name "testVnetConnection" +Get-AzVirtualHub -ResourceGroupName "testRG" -Name "testHub" | New-AzVirtualHubBgpConnection -PeerIp 192.168.1.5 -PeerAsn 20000 -Name "testBgpConnection" -VirtualHubVnetConnection $hubVnetConnection +``` + +```output +Name : testBgpConnection +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/bgpConnections/testBgpConnection +HubVirtualNetworkConnection : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/hubVirtualNetworkConnections/testVnetConnection +PeerAsn : 20000 +PeerIp : 192.168.1.5 +``` + +The above will create a Virtual WAN Hub BGP Connection for existing Virtual WAN Hub and Virtual WAN Hub Vnet Connection using powershell piping on the output from Get-AzVirtualHub. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerAsn +The peer ASN. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerIp +The peer IP. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByHubVirtualNetworkConnectionObject, ByVirtualHubNameByHubVirtualNetworkConnectionResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The virtual hub resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObjectByHubVirtualNetworkConnectionObject, ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId +Aliases: ParentObject, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubId +The virtual hub resource id. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceIdByHubVirtualNetworkConnectionObject, ByVirtualHubResourceIdByHubVirtualNetworkConnectionResourceId +Aliases: ParentResourceId, ParentVirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubName +The virtual hub name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByHubVirtualNetworkConnectionObject, ByVirtualHubNameByHubVirtualNetworkConnectionResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubVnetConnection +The VirtualHubVnetConnection resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection +Parameter Sets: ByVirtualHubNameByHubVirtualNetworkConnectionObject, ByVirtualHubObjectByHubVirtualNetworkConnectionObject, ByVirtualHubResourceIdByHubVirtualNetworkConnectionObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubVnetConnectionId +The VirtualHubVnetConnection resource id. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByHubVirtualNetworkConnectionResourceId, ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId, ByVirtualHubResourceIdByHubVirtualNetworkConnectionResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBgpConnection + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualHubBgpConnection](./Get-AzVirtualHubBgpConnection.md) + +[Remove-AzVirtualHubBgpConnection](./Remove-AzVirtualHubBgpConnection.md) + +[Update-AzVirtualHubBgpConnection](./Update-AzVirtualHubBgpConnection.md) diff --git a/azps-10.1.0/Az.Network/New-AzVirtualHubRoute.md b/azps-10.1.0/Az.Network/New-AzVirtualHubRoute.md new file mode 100644 index 0000000000..a7b7cdf244 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualHubRoute.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualhubroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualHubRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualHubRoute.md +--- + +# New-AzVirtualHubRoute + +## SYNOPSIS +Creates an Azure Virtual Hub Route object. + +## SYNTAX + +``` +New-AzVirtualHubRoute -AddressPrefix <String[]> -NextHopIpAddress <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an Azure Virtual Hub Route object. + +## EXAMPLES + +### Example 1 + +```powershell +$route1 = New-AzVirtualHubRoute -AddressPrefix @("10.0.0.0/16", "11.0.0.0/16") -NextHopIpAddress "12.0.0.5" +``` + +```output +AddressPrefixes NextHopIpAddress +--------------- ---------------- +{10.0.0.0/16, 11.0.0.0/16} 12.0.0.5 +``` + +The above will create a virtual hub route object that can be included in the virtual hub route table. + +The virtual hub route is an in-memory object that can be used to create a VirtualHubRouteTable object. + +## PARAMETERS + +### -AddressPrefix +List of Address Prefixes. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextHopIpAddress +The Next Hop IpAddress. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHubRoute + +## NOTES + +## RELATED LINKS + +[New-AzVirtualHubRouteTable](./New-AzVirtualHubRouteTable.md) diff --git a/azps-10.1.0/Az.Network/New-AzVirtualHubRouteTable.md b/azps-10.1.0/Az.Network/New-AzVirtualHubRouteTable.md new file mode 100644 index 0000000000..615f88ae7e --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualHubRouteTable.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualhubroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualHubRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualHubRouteTable.md +--- + +# New-AzVirtualHubRouteTable + +## SYNOPSIS +Creates an Azure Virtual Hub Route Table object. + +## SYNTAX + +``` +New-AzVirtualHubRouteTable -Route <PSVirtualHubRoute[]> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates an Azure Virtual Hub Route Table object. + +## EXAMPLES + +### Example 1 + +```powershell +$route1 = New-AzVirtualHubRoute -AddressPrefix @("10.0.0.0/16", "11.0.0.0/16") -NextHopIpAddress "12.0.0.5" +$route2 = New-AzVirtualHubRoute -AddressPrefix @("13.0.0.0/16") -NextHopIpAddress "14.0.0.5" +$routeTable = New-AzVirtualHubRouteTable -Route @($route1, $route2) +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWanId $virtualWan.Id -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -RouteTable $routeTable +``` + +```output +VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +ResourceGroupName : testRG +Name : westushub +Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub +AddressPrefix : 10.0.1.0/24 +RouteTable : Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable +VirtualNetworkConnections : {} +Location : West US +Type : Microsoft.Network/virtualHubs +ProvisioningState : Succeeded +``` + +The above will create a route table composed of multiple routes and attached to a new virtual hub. + +This is an in-memory object that can be used to add a Route table to a new or an existing VirtualHub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Route +List of virtual hub routes. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHubRoute[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable + +## NOTES + +## RELATED LINKS + +[New-AzVirtualHubRoute](./New-AzVirtualHubRoute.md) diff --git a/azps-10.1.0/Az.Network/New-AzVirtualHubVnetConnection.md b/azps-10.1.0/Az.Network/New-AzVirtualHubVnetConnection.md new file mode 100644 index 0000000000..bee2fe27ee --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualHubVnetConnection.md @@ -0,0 +1,396 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualhubvnetconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualHubVnetConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualHubVnetConnection.md +--- + +# New-AzVirtualHubVnetConnection + +## SYNOPSIS +The New-AzVirtualHubVnetConnection cmdlet creates a HubVirtualNetworkConnection resource that peers a Virtual Network to the Azure Virtual Hub. + +## SYNTAX + +### ByVirtualHubNameByRemoteVirtualNetworkObject (Default) +``` +New-AzVirtualHubVnetConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + -RemoteVirtualNetwork <PSVirtualNetwork> [-EnableInternetSecurity] [-EnableInternetSecurityFlag <Boolean>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubNameByRemoteVirtualNetworkResourceId +``` +New-AzVirtualHubVnetConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + -RemoteVirtualNetworkId <String> [-EnableInternetSecurity] [-EnableInternetSecurityFlag <Boolean>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObjectByRemoteVirtualNetworkObject +``` +New-AzVirtualHubVnetConnection -ParentObject <PSVirtualHub> -Name <String> + -RemoteVirtualNetwork <PSVirtualNetwork> [-EnableInternetSecurity] [-EnableInternetSecurityFlag <Boolean>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObjectByRemoteVirtualNetworkResourceId +``` +New-AzVirtualHubVnetConnection -ParentObject <PSVirtualHub> -Name <String> -RemoteVirtualNetworkId <String> + [-EnableInternetSecurity] [-EnableInternetSecurityFlag <Boolean>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByRemoteVirtualNetworkObject +``` +New-AzVirtualHubVnetConnection -ParentResourceId <String> -Name <String> + -RemoteVirtualNetwork <PSVirtualNetwork> [-EnableInternetSecurity] [-EnableInternetSecurityFlag <Boolean>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByRemoteVirtualNetworkResourceId +``` +New-AzVirtualHubVnetConnection -ParentResourceId <String> -Name <String> -RemoteVirtualNetworkId <String> + [-EnableInternetSecurity] [-EnableInternetSecurityFlag <Boolean>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzVirtualHubVnetConnection cmdlet creates a HubVirtualNetworkConnection resource that peers a Virtual Network to the Azure Virtual Hub. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" +$remoteVirtualNetwork = New-AzVirtualNetwork -Name "MyVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +New-AzVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "westushub" -Name "testvnetconnection" -RemoteVirtualNetwork $remoteVirtualNetwork +``` + +```output +Name : testvnetconnection +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubVirtualNetworkConnections/testvnetconnection +RemoteVirtualNetwork : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork +EnableInternetSecurity : False +ProvisioningState : Succeeded +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in Central US in that resource group in Azure. A Virtual Network Connection will be created thereafter which will peer the Virtual Network to the Virtual Hub. + +### Example 2 + +The New-AzVirtualHubVnetConnection cmdlet creates a HubVirtualNetworkConnection resource that peers a Virtual Network to the Azure Virtual Hub. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzVirtualHubVnetConnection -EnableInternetSecurity -Name 'testvnetconnection' -ParentResourceName 'westushub' -RemoteVirtualNetwork <PSVirtualNetwork> -ResourceGroupName 'testRG' +``` + +### Example 3 +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$rgName = "testRg" +$virtualHubName = "testHub" +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" +$remoteVirtualNetwork = New-AzVirtualNetwork -Name "MyVirtualNetwork" -ResourceGroupName $rgName -Location "West US" -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet +$rt1 = Get-AzVHubRouteTable -ResourceGroupName $rgName -VirtualHubName $virtualHubName -Name "defaultRouteTable" +$rt2 = Get-AzVHubRouteTable -ResourceGroupName $rgName -VirtualHubName $virtualHubName -Name "noneRouteTable" +$route1 = New-AzStaticRoute -Name "route1" -AddressPrefix @("10.20.0.0/16", "10.30.0.0/16")-NextHopIpAddress "10.90.0.5" +$routingconfig = New-AzRoutingConfiguration -AssociatedRouteTable $rt1.Id -Label @("testLabel") -Id @($rt2.Id) -StaticRoute @($route1) + +AssociatedRouteTable : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/hubRouteTables/defaultRouteTable" +PropagatedRouteTables : { + "Labels": [ + "testLabel" + ], + "Ids": [ + { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/hubRouteTables/noneRouteTable" + } + ] + } +VnetRoutes : { + "StaticRoutes": [ + { + "Name": "route1", + "AddressPrefixes": [ + "10.20.0.0/16", + "10.30.0.0/16" + ], + "NextHopIpAddress": "10.90.0.5" + } + ] + } +New-AzVirtualHubVnetConnection -ResourceGroupName $rgName -VirtualHubName $virtualHubName -Name "testvnetconnection" -RemoteVirtualNetwork $remoteVirtualNetwork -RoutingConfiguration $routingconfig +``` + +The above will create a new routing configuration and create static routes in the routing config with the next hop as a specified IP address. This routing configuration can then be passed into the New-AzVirtualHubVnetConnection command as the parameter -RoutingConfiguration. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternetSecurity +Enable internet security for this connection + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternetSecurityFlag +Enable internet security for this connection + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, HubVirtualNetworkConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The parent resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObjectByRemoteVirtualNetworkObject, ByVirtualHubObjectByRemoteVirtualNetworkResourceId +Aliases: VirtualHub, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The parent resource. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceIdByRemoteVirtualNetworkObject, ByVirtualHubResourceIdByRemoteVirtualNetworkResourceId +Aliases: VirtualHubId, ParentVirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentResourceName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByRemoteVirtualNetworkObject, ByVirtualHubNameByRemoteVirtualNetworkResourceId +Aliases: VirtualHubName, ParentVirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteVirtualNetwork +The remote virtual network to which this hub virtual network connection is connected. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork +Parameter Sets: ByVirtualHubNameByRemoteVirtualNetworkObject, ByVirtualHubObjectByRemoteVirtualNetworkObject, ByVirtualHubResourceIdByRemoteVirtualNetworkObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteVirtualNetworkId +The remote virtual network to which this hub virtual network connection is connected. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByRemoteVirtualNetworkResourceId, ByVirtualHubObjectByRemoteVirtualNetworkResourceId, ByVirtualHubResourceIdByRemoteVirtualNetworkResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByRemoteVirtualNetworkObject, ByVirtualHubNameByRemoteVirtualNetworkResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingConfiguration +Routing configuration for this connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualHubVnetConnection](./Get-AzVirtualHubVnetConnection.md) + +[Remove-AzVirtualHubVnetConnection](./Remove-AzVirtualHubVnetConnection.md) + +[New-AzRoutingConfiguration](./New-AzRoutingConfiguration.md) diff --git a/azps-10.1.0/Az.Network/New-AzVirtualNetwork.md b/azps-10.1.0/Az.Network/New-AzVirtualNetwork.md new file mode 100644 index 0000000000..48dcf6250f --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualNetwork.md @@ -0,0 +1,409 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 81D55C43-C9A3-4DA7-A469-A3A7550FE9A4 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualnetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetwork.md +--- + +# New-AzVirtualNetwork + +## SYNOPSIS +Creates a virtual network. + +## SYNTAX + +``` +New-AzVirtualNetwork -Name <String> -ResourceGroupName <String> -Location <String> -AddressPrefix <String[]> + [-DnsServer <String[]>] [-FlowTimeout <Int32>] [-Subnet <PSSubnet[]>] [-BgpCommunity <String>] + [-EnableEncryption <String>] [-EncryptionEnforcementPolicy <String>] [-Tag <Hashtable>] + [-EnableDdosProtection] [-DdosProtectionPlanId <String>] [-IpAllocation <PSIpAllocation[]>] + [-EdgeZone <String>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVirtualNetwork** cmdlet creates an Azure virtual network. + +## EXAMPLES + +### Example 1: Create a virtual network with two subnets +```powershell +New-AzResourceGroup -Name TestResourceGroup -Location centralus +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" +New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet +``` + +This example creates a virtual network with two subnets. First, a new resource group is created in +the centralus region. Then, the example creates in-memory representations of two subnets. The +New-AzVirtualNetworkSubnetConfig cmdlet will not create any subnet on the server side. There +is one subnet called frontendSubnet and one subnet called backendSubnet. The +New-AzVirtualNetwork cmdlet then creates a virtual network using the CIDR 10.0.0.0/16 as the +address prefix and two subnets. + +### Example 2: Create a virtual network with DNS settings +```powershell +New-AzResourceGroup -Name TestResourceGroup -Location centralus +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" +New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet -DnsServer 10.0.1.5,10.0.1.6 +``` + +This example create a virtual network with two subnets and two DNS servers. The effect of +specifying the DNS servers on the virtual network is that the NICs/VMs that are deployed into this +virtual network inherit these DNS servers as defaults. These defaults can be overwritten per NIC +through a NIC-level setting. If no DNS servers are specified on a VNET and no DNS servers on the +NICs, then the default Azure DNS servers are used for DNS resolution. + +### Example 3: Create a virtual network with a subnet referencing a network security group +```powershell +New-AzResourceGroup -Name TestResourceGroup -Location centralus +$rdpRule = New-AzNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 +$networkSecurityGroup = New-AzNetworkSecurityGroup -ResourceGroupName TestResourceGroup -Location centralus -Name "NSG-FrontEnd" -SecurityRules $rdpRule +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -NetworkSecurityGroup $networkSecurityGroup +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" -NetworkSecurityGroup $networkSecurityGroup +New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet +``` + +This example creates a virtual network with subnets that reference a network security group. First, +the example creates a resource group as a container for the resources that will be created. Then, a +network security group is created that allows inbound RDP access, but otherwise enforces the +default network security group rules. The New-AzVirtualNetworkSubnetConfig cmdlet then creates +in-memory representations of two subnets that both reference the network security group that was +created. The New-AzVirtualNetwork command then creates the virtual network. + +## PARAMETERS + +### -AddressPrefix +Specifies a range of IP addresses for a virtual network. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpCommunity +The BGP Community advertised over ExpressRoute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DdosProtectionPlanId +Reference to the DDoS protection plan resource associated with the virtual network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsServer +Specifies the DNS server for a subnet. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EdgeZone +{{ Fill EdgeZone Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableDdosProtection +A switch parameter which represents if DDoS protection is enabled or not. + +```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 +``` + +### -EnableEncryption +Indicates if encryption is enabled on the virtual network. The value should be true to enable encryption on the virtual network, false to disable encryption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptionEnforcementPolicy +Set the Encryption EnforcementPolicy. The value should be allowUnencrypted to allow VMs without encryption capability inside an encrypted virtual network, or dropUnencrypted to disable any VM without encryption capability from being added into an encrypted virtual network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FlowTimeout +FlowTimeout enables connection tracking for intra-VM flows. The value should be between 4 and 30 minutes (inclusive) to enable tracking, or null to disable tracking. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAllocation +Specifies IpAllocations for a virtual network. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpAllocation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the region for the virtual network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual network that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group to contain the virtual network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Subnet +Specifies a list of subnets to associate with the virtual network. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.String[] + +### Microsoft.Azure.Commands.Network.Models.PSSubnet[] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) + +[Remove-AzVirtualNetwork](./Remove-AzVirtualNetwork.md) + +[Set-AzVirtualNetwork](./Set-AzVirtualNetwork.md) + +[New-AzDdosProtectionPlan](./New-AzDdosProtectionPlan.md) diff --git a/azps-10.1.0/Az.Network/New-AzVirtualNetworkGateway.md b/azps-10.1.0/Az.Network/New-AzVirtualNetworkGateway.md new file mode 100644 index 0000000000..d77069f2e6 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualNetworkGateway.md @@ -0,0 +1,854 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 5784FD44-91D4-4537-84F3-4F03CCBA355F +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualnetworkgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkGateway.md +--- + +# New-AzVirtualNetworkGateway + +## SYNOPSIS +Creates a Virtual Network Gateway + +## SYNTAX + +``` +New-AzVirtualNetworkGateway -Name <String> -ResourceGroupName <String> -Location <String> + [-IpConfigurations <PSVirtualNetworkGatewayIpConfiguration[]>] [-GatewayType <String>] + [-ExtendedLocation <String>] [-VNetExtendedLocationResourceId <String>] [-VpnType <String>] + [-EnableBgp <Boolean>] [-DisableIPsecProtection <Boolean>] [-EnableActiveActiveFeature] + [-EnablePrivateIpAddress] [-GatewaySku <String>] [-GatewayDefaultSite <PSLocalNetworkGateway>] + [-VpnClientAddressPool <String[]>] [-VpnClientProtocol <String[]>] [-VpnAuthenticationType <String[]>] + [-VpnClientRootCertificates <PSVpnClientRootCertificate[]>] + [-VpnClientRevokedCertificates <PSVpnClientRevokedCertificate[]>] [-VpnClientIpsecPolicy <PSIpsecPolicy[]>] + [-Asn <UInt32>] [-PeerWeight <Int32>] + [-IpConfigurationBgpPeeringAddresses <PSIpConfigurationBgpPeeringAddress[]>] + [-NatRule <PSVirtualNetworkGatewayNatRule[]>] [-EnableBgpRouteTranslationForNat] [-Tag <Hashtable>] [-Force] + [-RadiusServerAddress <String>] [-RadiusServerSecret <SecureString>] [-RadiusServerList <PSRadiusServer[]>] + [-AadTenantUri <String>] [-AadAudienceId <String>] [-AadIssuerUri <String>] [-CustomRoute <String[]>] + [-VpnGatewayGeneration <String>] [-VirtualNetworkGatewayPolicyGroup <PSVirtualNetworkGatewayPolicyGroup[]>] + [-ClientConnectionConfiguration <PSClientConnectionConfiguration[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Virtual Network Gateway is the object representing your gateway in Azure. +The **New-AzVirtualNetworkGateway** cmdlet creates the object of your gateway in Azure based +on the Name, Resource Group Name, Location, and IP configuration, as well as the Gateway Type and +if VPN, the VPN Type. You can also name the Gateway SKU. +If this Gateway is being used for Point-to-Site connections, you will also need to include the VPN +Client Address Pool from which to assign addresses to connecting clients and the VPN Client Root +Certificate used to authenticate VPN clients connecting to the Gateway. +You can also choose to include other features like BGP and Active-Active. + +## EXAMPLES + +### Example 1: Create a Virtual Network Gateway +```powershell +New-AzResourceGroup -Location "UK West" -Name "vnet-gateway" +$subnet = New-AzVirtualNetworkSubnetConfig -Name 'gatewaysubnet' -AddressPrefix '10.254.0.0/27' + +$ngwpip = New-AzPublicIpAddress -Name ngwpip -ResourceGroupName "vnet-gateway" -Location "UK West" -AllocationMethod Dynamic +$vnet = New-AzVirtualNetwork -AddressPrefix "10.254.0.0/27" -Location "UK West" -Name vnet-gateway -ResourceGroupName "vnet-gateway" -Subnet $subnet +$subnet = Get-AzVirtualNetworkSubnetConfig -name 'gatewaysubnet' -VirtualNetwork $vnet +$ngwipconfig = New-AzVirtualNetworkGatewayIpConfig -Name ngwipconfig -SubnetId $subnet.Id -PublicIpAddressId $ngwpip.Id + +New-AzVirtualNetworkGateway -Name myNGW -ResourceGroupName vnet-gateway -Location "UK West" -IpConfigurations $ngwIpConfig -GatewayType "Vpn" -VpnType "RouteBased" -GatewaySku "Basic" -CustomRoute 192.168.0.0/24 +``` + +The above will create a resource group, request a Public IP Address, create a Virtual Network and +subnet and create a Virtual Network Gateway in Azure. +The gateway will be called "myNGW" within the resource group "vnet-gateway" in the location "UK +West" with the previously created IP configurations saved in the variable "ngwIPConfig," the +gateway type of "VPN," the vpn type "RouteBased," and the sku "Basic." + +### Example 2: Create a Virtual Network Gateway with External Radius Configuration +```powershell +New-AzResourceGroup -Location "UK West" -Name "vnet-gateway" +New-AzVirtualNetworkSubnetConfig -Name 'gatewaysubnet' -AddressPrefix '10.254.0.0/27' + +$ngwpip = New-AzPublicIpAddress -Name ngwpip -ResourceGroupName "vnet-gateway" -Location "UK West" -AllocationMethod Dynamic +$vnet = New-AzVirtualNetwork -AddressPrefix "10.254.0.0/27" -Location "UK West" -Name vnet-gateway -ResourceGroupName "vnet-gateway" -Subnet $subnet +$subnet = Get-AzVirtualNetworkSubnetConfig -name 'gatewaysubnet' -VirtualNetwork $vnet +$ngwipconfig = New-AzVirtualNetworkGatewayIpConfig -Name ngwipconfig -SubnetId $subnet.Id -PublicIpAddressId $ngwpip.Id +$Secure_String_Pwd = ConvertTo-SecureString "TestRadiusServerPassword" -AsPlainText -Force + +New-AzVirtualNetworkGateway -Name myNGW -ResourceGroupName vnet-gateway -Location "UK West" -IpConfigurations $ngwIpConfig -GatewayType "Vpn" -VpnType "RouteBased" -GatewaySku "Basic" -RadiusServerAddress "TestRadiusServer" -RadiusServerSecret $Secure_String_Pwd -CustomRoute 192.168.0.0/24 +``` + +The above will create a resource group, request a Public IP Address, create a Virtual Network and +subnet and create a Virtual Network Gateway in Azure. +The gateway will be called "myNGW" within the resource group "vnet-gateway" in the location "UK West" with the previously created IP configurations saved in the variable "ngwIPConfig," the gateway type of "VPN," the vpn type "RouteBased," and the sku "Basic." It also adds an external radius server with address "TestRadiusServer". It will also set custom routes specified by customers on gateway. + +### Example 3: Create a Virtual Network Gateway with P2S settings +```powershell +New-AzResourceGroup -Location "UK West" -Name "vnet-gateway" +$subnet = New-AzVirtualNetworkSubnetConfig -Name 'gatewaysubnet' -AddressPrefix '10.254.0.0/27' + +$ngwpip = New-AzPublicIpAddress -Name ngwpip -ResourceGroupName "vnet-gateway" -Location "UK West" -AllocationMethod Dynamic +$vnet = New-AzVirtualNetwork -AddressPrefix "10.254.0.0/27" -Location "UK West" -Name vnet-gateway -ResourceGroupName "vnet-gateway" -Subnet $subnet +$subnet = Get-AzVirtualNetworkSubnetConfig -name 'gatewaysubnet' -VirtualNetwork $vnet +$ngwipconfig = New-AzVirtualNetworkGatewayIpConfig -Name ngwipconfig -SubnetId $subnet.Id -PublicIpAddressId $ngwpip.Id +$rootCert = New-AzVpnClientRootCertificate -Name $clientRootCertName -PublicCertData $samplePublicCertData +$vpnclientipsecpolicy = New-AzVpnClientIpsecPolicy -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTime 86471 -SADataSize 429496 -IkeEncryption AES256 -IkeIntegrity SHA384 -DhGroup DHGroup2 -PfsGroup PFS2 + +New-AzVirtualNetworkGateway -Name myNGW -ResourceGroupName vnet-gateway -Location "UK West" -IpConfigurations $ngwIpConfig -GatewayType "Vpn" -VpnType "RouteBased" -GatewaySku "VpnGw1" -VpnClientProtocol IkeV2 -VpnClientAddressPool 201.169.0.0/16 -VpnClientRootCertificates $rootCert -VpnClientIpsecPolicy $vpnclientipsecpolicy -CustomRoute 192.168.0.0/24 +``` + +The above will create a resource group, request a Public IP Address, create a Virtual Network and +subnet and create a Virtual Network Gateway with P2S settings e.g. VpnProtocol,VpnClientAddressPool,VpnClientRootCertificates,VpnClientIpsecPolicy etc. in Azure. +The gateway will be called "myNGW" within the resource group "vnet-gateway" in the location "UK West" with the previously created IP configurations saved in the variable "ngwIPConfig," the gateway type of "VPN," the vpn type "RouteBased," and the sku "VpnGw1." Vpn settings will be set on Gateway such as VpnProtocol set as Ikev2, VpnClientAddressPool as "201.169.0.0/16", VpnClientRootCertificate set as passed one: clientRootCertName and custom vpn ipsec policy passed in object:$vpnclientipsecpolicy +It will also set custom routes specified by customers on gateway. + +### Example 4: Create a Virtual Network Gateway with AAD authentication Configuration for VpnClient of virtual network gateway. +```powershell +New-AzResourceGroup -Location "UK West" -Name "vnet-gateway" +New-AzVirtualNetworkSubnetConfig -Name 'gatewaysubnet' -AddressPrefix '10.254.0.0/27' + +$ngwpip = New-AzPublicIpAddress -Name ngwpip -ResourceGroupName "vnet-gateway" -Location "UK West" -AllocationMethod Dynamic +$vnet = New-AzVirtualNetwork -AddressPrefix "10.254.0.0/27" -Location "UK West" -Name vnet-gateway -ResourceGroupName "vnet-gateway" -Subnet $subnet +$subnet = Get-AzVirtualNetworkSubnetConfig -name 'gatewaysubnet' -VirtualNetwork $vnet +$ngwipconfig = New-AzVirtualNetworkGatewayIpConfig -Name ngwipconfig -SubnetId $subnet.Id -PublicIpAddressId $ngwpip.Id +$Secure_String_Pwd = ConvertTo-SecureString "TestRadiusServerPassword" -AsPlainText -Force + +New-AzVirtualNetworkGateway -Name myNGW -ResourceGroupName vnet-gateway -Location "UK West" -IpConfigurations $ngwIpConfig -GatewayType "Vpn" -VpnType "RouteBased" -GatewaySku "VpnGw1" -VpnClientProtocol OpenVPN -VpnClientAddressPool 201.169.0.0/16 -AadTenantUri "https://login.microsoftonline.com/0ab2c4f4-81e6-44cc-a0b2-b3a47a1443f4" -AadIssuerUri "https://sts.windows.net/0ab2c4f4-81e6-44cc-a0b2-b3a47a1443f4/" -AadAudienceId "a21fce82-76af-45e6-8583-a08cb3b956f9" +``` + +The above will create a resource group, request a Public IP Address, create a Virtual Network and +subnet and create a Virtual Network Gateway in Azure. +The gateway will be called "myNGW" within the resource group "vnet-gateway" in the location "UK West" with the previously created IP configurations saved in the variable "ngwIPConfig," the gateway type of "VPN," the vpn type "RouteBased," and the sku "Basic." It also configures AAD authentication configurations: AadTenantUri, AadIssuerUri and AadAudienceId for VpnClient of virtual network gateway. + +### Example 5: Create a Virtual Network Gateway with VpnGatewayGeneration +```powershell +New-AzResourceGroup -Location "UK West" -Name "vnet-gateway" +$subnet = New-AzVirtualNetworkSubnetConfig -Name 'gatewaysubnet' -AddressPrefix '10.254.0.0/27' + +$ngwpip = New-AzPublicIpAddress -Name ngwpip -ResourceGroupName "vnet-gateway" -Location "UK West" -AllocationMethod Dynamic +$vnet = New-AzVirtualNetwork -AddressPrefix "10.254.0.0/27" -Location "UK West" -Name vnet-gateway -ResourceGroupName "vnet-gateway" -Subnet $subnet +$subnet = Get-AzVirtualNetworkSubnetConfig -name 'gatewaysubnet' -VirtualNetwork $vnet +$ngwipconfig = New-AzVirtualNetworkGatewayIpConfig -Name ngwipconfig -SubnetId $subnet.Id -PublicIpAddressId $ngwpip.Id + +New-AzVirtualNetworkGateway -Name myNGW -ResourceGroupName vnet-gateway -Location "UK West" -IpConfigurations $ngwIpConfig -GatewayType "Vpn" -VpnType "RouteBased" -GatewaySku "VpnGw4" -VpnGatewayGeneration "Generation2" +``` + +The above will create a resource group, request a Public IP Address, create a Virtual Network and +subnet and create a Virtual Network Gateway in Azure. +The gateway will be called "myNGW" within the resource group "vnet-gateway" in the location "UK West" +with the previously created IP configurations saved in the variable "ngwIPConfig," the +gateway type of "VPN", the vpn type "RouteBased", the sku "VpnGw4" and VpnGatewayGeneration Generation2 enabled. + +### Example 6: Create a Virtual Network Gateway with IpConfigurationBgpPeeringAddresses +```powershell +New-AzResourceGroup -Location "UK West" -Name "resourcegroup1" +$subnet = New-AzVirtualNetworkSubnetConfig -Name 'gatewaysubnet' -AddressPrefix '10.254.0.0/27' + +$ngwpip = New-AzPublicIpAddress -Name ngwpip -ResourceGroupName "resourcegroup1" -Location "UK West" -AllocationMethod Dynamic +$vnet = New-AzVirtualNetwork -AddressPrefix "10.254.0.0/27" -Location "UK West" -Name vnet-gateway -ResourceGroupName "resourcegroup1" -Subnet $subnet +$subnet = Get-AzVirtualNetworkSubnetConfig -name 'gatewaysubnet' -VirtualNetwork $vnet +$ngwipconfig = New-AzVirtualNetworkGatewayIpConfig -Name ipconfig1 -SubnetId $subnet.Id -PublicIpAddressId $ngwpip.Id + +$ipconfigurationId1 = $ngwipconfig.Id +$addresslist1 = @('169.254.21.10') +$gw1ipconfBgp1 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId1 -CustomAddress $addresslist1 + +New-AzVirtualNetworkGateway -Name gateway1 -ResourceGroupName vnet-gateway -Location "UK West" -IpConfigurations $ngwIpConfig -IpConfigurationBgpPeeringAddresses $gw1ipconfBgp1 -GatewayType "Vpn" -VpnType "RouteBased" -GatewaySku "VpnGw4" -VpnGatewayGeneration "Generation2" +``` + +The above will create a resource group, request a Public IP Address, create a Virtual Network and +subnet and create a Virtual Network Gateway in Azure. +ipconfigurationId1 of gateway ipconfiguration just created and stored in ngwipconfig. +The gateway will be called "gateway1" within the resource group "resourcegroup1resourcegroup1" in the location "UK West" +with the previously created IP configurations Bgppeering address saved in the variable "gw1ipconfBgp1," the +gateway type of "VPN", the vpn type "RouteBased", the sku "VpnGw4" and VpnGatewayGeneration Generation2 enabled. + +### Example 7: Create a Virtual Network Gateway with NatRules +```powershell +New-AzResourceGroup -Location "UK West" -Name "resourcegroup1" +$subnet = New-AzVirtualNetworkSubnetConfig -Name 'gatewaysubnet' -AddressPrefix '10.254.0.0/27' + +$ngwpip = New-AzPublicIpAddress -Name ngwpip -ResourceGroupName "resourcegroup1" -Location "UK West" -AllocationMethod Dynamic +$vnet = New-AzVirtualNetwork -AddressPrefix "10.254.0.0/27" -Location "UK West" -Name vnet-gateway -ResourceGroupName "resourcegroup1" -Subnet $subnet +$subnet = Get-AzVirtualNetworkSubnetConfig -name 'gatewaysubnet' -VirtualNetwork $vnet +$ngwipconfig = New-AzVirtualNetworkGatewayIpConfig -Name ipconfig1 -SubnetId $subnet.Id -PublicIpAddressId $ngwpip.Id + +$natRule = New-AzVirtualNetworkGatewayNatRule -Name "natRule1" -Type "Static" -Mode "IngressSnat" -InternalMapping @("25.0.0.0/16") -ExternalMapping @("30.0.0.0/16") + +New-AzVirtualNetworkGateway -Name gateway1 -ResourceGroupName vnet-gateway -Location "UK West" -IpConfigurations $ngwIpConfig -GatewayType "Vpn" -VpnType "RouteBased" -GatewaySku "VpnGw4" -VpnGatewayGeneration "Generation2" -NatRule $natRule -EnableBgpRouteTranslationForNat +``` + +The above will create a resource group, request a Public IP Address, create a Virtual Network and +subnet and create a Virtual Network Gateway in Azure. +ipconfigurationId1 of gateway ipconfiguration just created and stored in ngwipconfig. +The gateway will be called "gateway1" within the resource group "resourcegroup1resourcegroup1" in the location "UK West" +New virtualNetworkGateway NatRule will be saved in the variable "natRule" +the gateway type of "VPN", the vpn type "RouteBased", the sku "VpnGw4" and VpnGatewayGeneration Generation2 enabled and BgpRouteTranslationForNat enabled. + +## PARAMETERS + +### -AadAudienceId +P2S AAD authentication option:AadAudienceId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AadIssuerUri +P2S AAD authentication option:AadIssuerUri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AadTenantUri +P2S AAD authentication option:AadTenantUri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Asn +The virtual network gateway's ASN for BGP over VPN + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientConnectionConfiguration +P2S Client Connection Configuration that assiociate between address and policy group + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSClientConnectionConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CustomRoute +Custom routes AddressPool specified by customer + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableIPsecProtection +The Flag disables IPsec Protection on VirtualNetworkGateway. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableActiveActiveFeature +Flag to enable Active Active feature on virtual network gateway + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBgp +EnableBgp Flag + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableBgpRouteTranslationForNat +Flag to enable BgpRouteTranslationForNat on this VirtualNetworkGateway. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePrivateIpAddress +Flag to enable private IPAddress on virtual network gateway + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedLocation +The extended location of this virtual network gateway + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayDefaultSite +GatewayDefaultSite + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GatewaySku +The Gateway Sku Tier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3, VpnGw4, VpnGw5, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, VpnGw4AZ, VpnGw5AZ, ErGw1AZ, ErGw2AZ, ErGw3AZ + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GatewayType +The type of this virtual network gateway: Vpn, ExpressRoute + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Vpn, ExpressRoute, LocalGateway + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpConfigurationBgpPeeringAddresses +The BgpPeeringAddresses for Virtual network gateway bgpsettings. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpConfigurationBgpPeeringAddress[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpConfigurations +The IpConfigurations for Virtual network gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayIpConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NatRule +The NatRules for Virtual network gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayNatRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerWeight +The weight added to routes learned over BGP from this virtual network gateway + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RadiusServerAddress +P2S External Radius server address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RadiusServerList +P2S multiple external Radius server servers. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRadiusServer[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RadiusServerSecret +P2S External Radius server secret. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayPolicyGroup +P2S policy group added to this gateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayPolicyGroup[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VNetExtendedLocationResourceId +VNetExtendedLocationResourceId for Virtual network gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnAuthenticationType +The list of P2S VPN client authentication types. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: Certificate, Radius, AAD + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientAddressPool +P2S VpnClient AddressPool + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientIpsecPolicy +A list of IPSec policies for P2S VPN client tunneling protocols. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientProtocol +The list of P2S VPN client tunneling protocols + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: SSTP, IkeV2, OpenVPN + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientRevokedCertificates +The list of VpnClientCertificates to be revoked. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientRootCertificates +The list of VpnClientRootCertificates to be added. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnGatewayGeneration +The generation for this VirtualNetwork VPN gateway. +Must be None if GatewayType is not VPN. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnType +The type of the Vpn:PolicyBased/RouteBased + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: PolicyBased, RouteBased + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayIpConfiguration[] + +### System.Boolean + +### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway + +### System.String[] + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate[] + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate[] + +### Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy[] + +### System.UInt32 + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSIpConfigurationBgpPeeringAddress[] + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayNatRule[] + +### System.Collections.Hashtable + +### System.Security.SecureString + +### Microsoft.Azure.Commands.Network.Models.PSRadiusServer[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayConnection.md b/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayConnection.md new file mode 100644 index 0000000000..61d1e89efa --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayConnection.md @@ -0,0 +1,597 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 0F141A92-4994-45B3-AE94-09865BC691C4 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualnetworkgatewayconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkGatewayConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkGatewayConnection.md +--- + +# New-AzVirtualNetworkGatewayConnection + +## SYNOPSIS +Creates the Site-to-Site VPN connection between the virtual network gateway and the on-prem VPN device. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzVirtualNetworkGatewayConnection -Name <String> -ResourceGroupName <String> -Location <String> + [-AuthorizationKey <String>] -VirtualNetworkGateway1 <PSVirtualNetworkGateway> + [-VirtualNetworkGateway2 <PSVirtualNetworkGateway>] [-LocalNetworkGateway2 <PSLocalNetworkGateway>] + -ConnectionType <String> [-RoutingWeight <Int32>] [-DpdTimeoutInSeconds <Int32>] [-ConnectionMode <String>] + [-SharedKey <String>] [-Peer <PSPeering>] [-EnableBgp <Boolean>] [-UseLocalAzureIpAddress] [-Tag <Hashtable>] + [-Force] [-UsePolicyBasedTrafficSelectors <Boolean>] [-IpsecPolicies <PSIpsecPolicy[]>] + [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] [-ConnectionProtocol <String>] + [-IngressNatRule <PSResourceId[]>] [-EgressNatRule <PSResourceId[]>] + [-GatewayCustomBgpIpAddress <PSGatewayCustomBgpIpConfiguration[]>] [-AsJob] [-ExpressRouteGatewayBypass] + [-EnablePrivateLinkFastPath] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzVirtualNetworkGatewayConnection -Name <String> -ResourceGroupName <String> -Location <String> + [-AuthorizationKey <String>] -VirtualNetworkGateway1 <PSVirtualNetworkGateway> + [-VirtualNetworkGateway2 <PSVirtualNetworkGateway>] [-LocalNetworkGateway2 <PSLocalNetworkGateway>] + -ConnectionType <String> [-RoutingWeight <Int32>] [-DpdTimeoutInSeconds <Int32>] [-ConnectionMode <String>] + [-SharedKey <String>] [-PeerId <String>] [-EnableBgp <Boolean>] [-UseLocalAzureIpAddress] [-Tag <Hashtable>] + [-Force] [-UsePolicyBasedTrafficSelectors <Boolean>] [-IpsecPolicies <PSIpsecPolicy[]>] + [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] [-ConnectionProtocol <String>] + [-IngressNatRule <PSResourceId[]>] [-EgressNatRule <PSResourceId[]>] + [-GatewayCustomBgpIpAddress <PSGatewayCustomBgpIpConfiguration[]>] [-AsJob] [-ExpressRouteGatewayBypass] + [-EnablePrivateLinkFastPath] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates the Site-to-Site VPN connection between the virtual network gateway and the on-prem VPN device. + +## EXAMPLES + +### Example 1 +```powershell +$vnetgw1 = Get-AzVirtualNetworkGateway -ResourceGroupName "Rg1" -Name "gw1" +$vnetgw2 = Get-AzVirtualNetworkGateway -ResourceGroupName "Rg1" -Name "gw2" +New-AzVirtualNetworkGatewayConnection -Name conn-client-1 -ResourceGroupName "Rg1" -VirtualNetworkGateway1 $vnetgw1 -VirtualNetworkGateway2 $vnetgw2 -Location "eastus" -ConnectionType Vnet2Vnet -SharedKey 'a1b2c3d4e5' +``` + +### Example 2 Add/Update IngressNatRule/EgressNatRule to an existing virtual network gateway connection +```powershell +$vnetgw1 = Get-AzVirtualNetworkGateway -ResourceGroupName "Rg1" -Name "vnetgw1" +$vnetgw2 = Get-AzVirtualNetworkGateway -ResourceGroupName "Rg1" -Name "vnetgw2" +$ingressnatrule = Get-AzVirtualNetworkGatewayNatRule -ResourceGroupName "Rg1" -Name "natRule1" -ParentResourceName vnetgw1 +$egressnatrule = Get-AzVirtualNetworkGatewayNatRule -ResourceGroupName "Rg1" -Name "natRule2" -ParentResourceName vnetgw1 +New-AzVirtualNetworkGatewayConnection -Name conn-client-1 -ResourceGroupName $RG1 -VirtualNetworkGateway1 $vnetgw1 -VirtualNetworkGateway2 $vnetgw2 -Location "eastus" -ConnectionType Vnet2Vnet -SharedKey 'a1b2c3d4e5' ` +-IngressNatRule $ingressnatrule -EgressNatRule $egressnatrule +``` + +The first command gets a virtual network gateway natRule named natRule1 that's type is IngressSnat. +The second command gets a virtual network gateway natRule named natRule2 that's type is EgressSnat. +The third command creates this new virtual Network gateway connection with Ingress and Egress NatRules. + +### Example 3 Add GatewayCustomBgpIpAddress to virtual network gateway connection +```powershell +$LocalnetGateway = Get-AzLocalNetworkGateway -ResourceGroupName "PS_testing" -name "testLng" +$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName PS_testing -ResourceName testGw +$address = New-AzGatewayCustomBgpIpConfigurationObject -IpConfigurationId "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw/ipConfigurations/default" -CustomBgpIpAddress "169.254.21.1" + +New-AzVirtualNetworkGatewayConnection -ResourceGroupName "PS_testing" -name "Conn" -location "eastus" -VirtualNetworkGateway1 $gateway -LocalNetworkGateway2 $localnetGateway -ConnectionType IPsec -RoutingWeight 3 -SharedKey abc -GatewayCustomBgpIpAddress $address -EnableBgp $true +``` + +The two command gets a local network gateway and virtual network gateway. +The thrid command creates a AzGatewayCustomBgpIpConfigurationObject. +The third command creates this new virtual Network gateway connection with GatewayCustomBgpIpAddress. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizationKey +AuthorizationKey. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConnectionMode +Virtual Network Gateway Connection Mode. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionProtocol +Gateway connection protocol:IKEv1/IKEv2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IKEv1, IKEv2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionType +Gateway connection type:IPsec/Vnet2Vnet/ExpressRoute/VPNClient + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPsec, Vnet2Vnet, ExpressRoute, VPNClient + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpdTimeoutInSeconds +Dead Peer Detection Timeout of the connection in seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EgressNatRule +The list of egress NAT rules that are associated with this Connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSResourceId[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBgp +Whether to establish a BGP session over a S2S VPN tunnel + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnablePrivateLinkFastPath +Bypass the ExpressRoute gateway when accessing private-links. +ExpressRoute FastPath (ExpressRouteGatewayBypass) must be enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpressRouteGatewayBypass +Whether to use accelerated virtual network access by bypassing gateway + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayCustomBgpIpAddress +The GatewayCustomBgpIpAddress of Virtual network gateway used in this connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSGatewayCustomBgpIpConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IngressNatRule +The list of ingress NAT rules that are associated with this Connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSResourceId[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpsecPolicies +A list of IPSec policies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LocalNetworkGateway2 +local network gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Peer +Peer + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPeering +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerId +PeerId + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoutingWeight +RoutingWeight. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SharedKey +The Ipsec share key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TrafficSelectorPolicy +A list of traffic selector policies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSTrafficSelectorPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UseLocalAzureIpAddress +Whether to use PrivateIP for this S2S VPN tunnel + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UsePolicyBasedTrafficSelectors +Whether to use policy-based traffic selectors for a S2S connection + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkGateway1 +First virtual network gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGateway2 +Second virtual network gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSPeering + +### System.Boolean + +### System.Management.Automation.SwitchParameter + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy[] + +### Microsoft.Azure.Commands.Network.Models.PSTrafficSelectorPolicy[] + +### Microsoft.Azure.Commands.Network.Models.PSGatewayCustomBgpIpConfiguration[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkGatewayConnection](./Get-AzVirtualNetworkGatewayConnection.md) + +[Remove-AzVirtualNetworkGatewayConnection](./Remove-AzVirtualNetworkGatewayConnection.md) + +[Set-AzVirtualNetworkGatewayConnection](./Set-AzVirtualNetworkGatewayConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayIpConfig.md b/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayIpConfig.md new file mode 100644 index 0000000000..d913834566 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayIpConfig.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C6E65138-CD14-4A54-A901-8E944201F2AE +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualnetworkgatewayipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkGatewayIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkGatewayIpConfig.md +--- + +# New-AzVirtualNetworkGatewayIpConfig + +## SYNOPSIS +Creates an IP Configuration for a Virtual Network Gateway + +## SYNTAX + +### SetByResourceId +``` +New-AzVirtualNetworkGatewayIpConfig -Name <String> [-PrivateIpAddress <String>] [-SubnetId <String>] + [-PublicIpAddressId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +New-AzVirtualNetworkGatewayIpConfig -Name <String> [-PrivateIpAddress <String>] [-Subnet <PSSubnet>] + [-PublicIpAddress <PSPublicIpAddress>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVirtualNetworkGatewayIpConfig** cmdlet creates a configuration assigned to a Virtual Network Gateway with a (previously created) Public IP Address based on Subnet ID. + +## EXAMPLES + +### 1: Create an IP Configuration for a Virtual Network Gateway +```powershell +$gwIpConfig = New-AzVirtualNetworkGatewayIpConfig -Name myGWIpConfig -SubnetId $myGWsubnet.Id -PublicIpAddressId $myGWpip.Id +``` + +Configures a Virtual Network Gateway with a Public IP Address. The variable $myGWsubnet is obtained using the **Get-AzVirtualNetworkSubnetConfig** cmdlet on the "GatewaySubnet" within the Virtual Network you intend to create a Virtual Network Gateway. The variable $myGWpip is obtained using the **New-AzPublicIpAddress** cmdlet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddress +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddress +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddressId +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayIpConfiguration + +## NOTES + +## RELATED LINKS + +[Add-AzVirtualNetworkGatewayIpConfig](./Add-AzVirtualNetworkGatewayIpConfig.md) + +[Remove-AzVirtualNetworkGatewayIpConfig](./Remove-AzVirtualNetworkGatewayIpConfig.md) diff --git a/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayNatRule.md b/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayNatRule.md new file mode 100644 index 0000000000..41988497d7 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayNatRule.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualnetworkgatewaynatrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkGatewayNatRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkGatewayNatRule.md +--- + +# New-AzVirtualNetworkGatewayNatRule + +## SYNOPSIS +Creates the virtual network gateway natRule object. + +## SYNTAX + +``` +New-AzVirtualNetworkGatewayNatRule -Name <String> -Type <String> -Mode <String> -InternalMapping <String[]> + -ExternalMapping <String[]> [-InternalPortRange <String[]>] [-ExternalPortRange <String[]>] + [-IpConfigurationId <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +**New-AzVirtualNetworkGatewayNatRule** cmdlet creates a PSVirtualNetworkGatewayNatRule object which represents natRules property in your virtual network gateway. + +## EXAMPLES + +### Example 1 +```powershell +$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName myRg -Name gw1 +$natRule = New-AzVirtualNetworkGatewayNatRule -Name "natRule1" -Type "Static" -Mode "IngressSnat" -InternalMapping @("25.0.0.0/16") -ExternalMapping @("30.0.0.0/16") -InternalPortRange @("100-100") -ExternalPortRange @("200-200") +Set-AzVirtualNetworkGateway -VirtualNetworkGateway $gateway -NatRule $natRule +``` + +The first command gets a virtual network gateway named gw1 that belongs to resource group myRg and stores it to the variable named $gateway +The second command creates a new PSVirtualNetworkGatewayNatRuleirtual object. +The third command updates the virtual network gateway gw1 with the with newly added natRule. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalMapping +The list of private IP address subnet external mappings for NAT + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalPortRange +The list of external port range mappings for NAT subnets + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalMapping +The list of private IP address subnet internal mappings for NAT + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalPortRange +The list of internal port range mappings for NAT subnets + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfigurationId +The IP Configuration ID this NAT rule applies to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Source NAT direction of a VPN NAT + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: EgressSnat, IngressSnat + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VirtualNetworkGatewayNatRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The type of NAT rule for VPN NAT + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Static, Dynamic + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayNatRule + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkGatewayNatRule](./Get-AzVirtualNetworkGatewayNatRule.md) + +[Remove-AzVirtualNetworkGatewayNatRule](./Remove-AzVirtualNetworkGatewayNatRule.md) + +[Update-AzVirtualNetworkGatewayNatRule](./Update-AzVirtualNetworkGatewayNatRule.md) diff --git a/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayPolicyGroup.md b/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayPolicyGroup.md new file mode 100644 index 0000000000..5d1a1b34a2 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayPolicyGroup.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualnetworkgatewaypolicygroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkGatewayPolicyGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkGatewayPolicyGroup.md +--- + +# New-AzVirtualNetworkGatewayPolicyGroup + +## SYNOPSIS +Create a Virtual Network Gateway Policy Group + +## SYNTAX + +``` +New-AzVirtualNetworkGatewayPolicyGroup -Name <String> -Priority <Int32> [-DefaultPolicyGroup] + -PolicyMember <PSVirtualNetworkGatewayPolicyGroupMember[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Virtual Network Gateway Policy Group is a used for setting up different groups of users based on their identity or authentication credentials + +## EXAMPLES + +### Example 1 +```powershell +#create the policy group and connection client configuration +$member1=New-AzVirtualNetworkGatewayPolicyGroupMember -Name "member1" -AttributeType "CertificateGroupId" -AttributeValue "ab" +$member2=New-AzVirtualNetworkGatewayPolicyGroupMember -Name "member2" -AttributeType "CertificateGroupId" -AttributeValue "cd" +$policyGroup1=New-AzVirtualNetworkGatewayPolicyGroup -Name "policyGroup1" -Priority 0 -DefaultPolicyGroup -PolicyMember $member1 +$policyGroup2=New-AzVirtualNetworkGatewayPolicyGroup -Name "policyGroup2" -Priority 10 -PolicyMember $member2 +``` + +create policy group member + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultPolicyGroup +Flag to set this as Default Policy Group on this VpnServerConfiguration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Virtual Network Gateway Policy Group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyMember +The list of Policy members. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayPolicyGroupMember[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Priority +The Priority of the policy group. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayPolicyGroupMember[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayPolicyGroupmember.md b/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayPolicyGroupmember.md new file mode 100644 index 0000000000..66ad0a5c8c --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualNetworkGatewayPolicyGroupmember.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualnetworkgatewaypolicygroupmember +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkGatewayPolicyGroupmember.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkGatewayPolicyGroupmember.md +--- + +# New-AzVirtualNetworkGatewayPolicyGroupMember + +## SYNOPSIS +Create a Virtual Network Gateway Policy Group Member + +## SYNTAX + +``` +New-AzVirtualNetworkGatewayPolicyGroupMember -Name <String> -AttributeType <String> -AttributeValue <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Virtual Network Gateway Policy Group Member is a used for setting up one policy based on their identity or authentication credentials + +## EXAMPLES + +### Example 1 +```powershell +#create the policy group and connection client configuration +$member1=New-AzVirtualNetworkGatewayPolicyGroupMember -Name "member1" -AttributeType "CertificateGroupId" -AttributeValue "ab" +$member2=New-AzVirtualNetworkGatewayPolicyGroupMember -Name "member2" -AttributeType "CertificateGroupId" -AttributeValue "cd" +$policyGroup1=New-AzVirtualNetworkGatewayPolicyGroup -Name "policyGroup1" -Priority 0 -DefaultPolicyGroup -PolicyMember $member1 +$policyGroup2=New-AzVirtualNetworkGatewayPolicyGroup -Name "policyGroup2" -Priority 10 -PolicyMember $member2 +``` + +create policy group member + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttributeType +The Attribute Type of the policy group member. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AttributeValue +The Attribute Value + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Virtual Network Gateway Policy Group Member + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzVirtualNetworkSubnetConfig.md b/azps-10.1.0/Az.Network/New-AzVirtualNetworkSubnetConfig.md new file mode 100644 index 0000000000..185bb3fd77 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualNetworkSubnetConfig.md @@ -0,0 +1,340 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 901FD38B-67FA-40D5-8D23-51E5544C25D8 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualnetworksubnetconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkSubnetConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkSubnetConfig.md +--- + +# New-AzVirtualNetworkSubnetConfig + +## SYNOPSIS +Creates a virtual network subnet configuration. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzVirtualNetworkSubnetConfig -Name <String> -AddressPrefix <String[]> + [-NetworkSecurityGroup <PSNetworkSecurityGroup>] [-RouteTable <PSRouteTable>] [-InputObject <PSNatGateway>] + [-ServiceEndpoint <String[]>] [-ServiceEndpointPolicy <PSServiceEndpointPolicy[]>] + [-Delegation <PSDelegation[]>] [-PrivateEndpointNetworkPoliciesFlag <String>] + [-PrivateLinkServiceNetworkPoliciesFlag <String>] [-IpAllocation <PSIpAllocation[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzVirtualNetworkSubnetConfig -Name <String> -AddressPrefix <String[]> [-NetworkSecurityGroupId <String>] + [-RouteTableId <String>] [-ResourceId <String>] [-ServiceEndpoint <String[]>] + [-ServiceEndpointPolicy <PSServiceEndpointPolicy[]>] [-Delegation <PSDelegation[]>] + [-PrivateEndpointNetworkPoliciesFlag <String>] [-PrivateLinkServiceNetworkPoliciesFlag <String>] + [-IpAllocation <PSIpAllocation[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +**The New-AzVirtualNetworkSubnetConfig** cmdlet creates a virtual network subnet configuration. + +## EXAMPLES + +### Example 1: Create a virtual network with two subnets and a network security group +```powershell +New-AzResourceGroup -Name TestResourceGroup -Location centralus + +$rdpRule = New-AzNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" ` + -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 ` + -SourceAddressPrefix Internet -SourcePortRange * ` + -DestinationAddressPrefix * -DestinationPortRange 3389 + +$networkSecurityGroup = New-AzNetworkSecurityGroup -ResourceGroupName TestResourceGroup ` + -Location centralus -Name "NSG-FrontEnd" -SecurityRules $rdpRule + +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet ` + -AddressPrefix "10.0.1.0/24" -NetworkSecurityGroup $networkSecurityGroup + +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet ` + -AddressPrefix "10.0.2.0/24" -NetworkSecurityGroup $networkSecurityGroup + +$pip = New-AzPublicIpAddress -Name "pip" -ResourceGroupName "natgateway_test" ` + -Location "eastus2" -Sku "Standard" -IdleTimeoutInMinutes 4 -AllocationMethod "static" + +$natgateway = New-AzNatGateway -ResourceGroupName "natgateway_test" -Name "nat_gateway" ` + -IdleTimeoutInMinutes 4 -Sku "Standard" -Location "eastus2" -PublicIpAddress $pip + +$natGatewaySubnet = New-AzVirtualNetworkSubnetConfig -Name natGatewaySubnet ` + -AddressPrefix "10.0.3.0/24" -InputObject $natGateway + +New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup ` + -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet,$natGatewaySubnet +``` + +This example creates two new subnet configurations using the + New-AzVirtualSubnetConfig cmdlet, and then uses them to create a virtual network. + The New-AzVirtualSubnetConfig template only creates an in-memory representation of + the subnet. In this example, the frontendSubnet has CIDR 10.0.1.0/24 and references a + network security group that allows RDP access. The backendSubnet has CIDR 10.0.2.0/24 and + references the same network security group. + +## PARAMETERS + +### -AddressPrefix +Specifies a range of IP addresses for a subnet configuration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delegation +List of services that have permission to perform operations on this subnet. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSDelegation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Specifies the nat gateway associated with the subnet configuration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNatGateway +Parameter Sets: SetByResource +Aliases: NatGateway + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpAllocation +Specifies IpAllocations for a subnet. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpAllocation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the subnet configuration to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSecurityGroup +Specifies a NetworkSecurityGroup object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkSecurityGroupId +Specifies the ID of a network security group. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateEndpointNetworkPoliciesFlag +Configure to enable or disable applying network policies on private endpoint in the subnet. Default value is Disabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateLinkServiceNetworkPoliciesFlag +Configure to enable or disable applying network policies on private link service in the subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the Id of NAT Gateway resource associated with the subnet configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: NatGatewayId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteTable +Specifies the route table associated with the subnet configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteTableId +Specifies the ID of the route table associated with the subnet configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceEndpoint +Service Endpoint Value + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceEndpointPolicy +Service Endpoint Policies + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +### Microsoft.Azure.Commands.Network.Models.PSNatGateway + +### System.String[] + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy[] + +### Microsoft.Azure.Commands.Network.Models.PSDelegation[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSSubnet + +## NOTES + +## RELATED LINKS + +[Add-AzVirtualNetworkSubnetConfig](./Add-AzVirtualNetworkSubnetConfig.md) + +[Get-AzVirtualNetworkSubnetConfig](./Get-AzVirtualNetworkSubnetConfig.md) + +[Remove-AzVirtualNetworkSubnetConfig](./Remove-AzVirtualNetworkSubnetConfig.md) + +[Set-AzVirtualNetworkSubnetConfig](./Set-AzVirtualNetworkSubnetConfig.md) diff --git a/azps-10.1.0/Az.Network/New-AzVirtualNetworkTap.md b/azps-10.1.0/Az.Network/New-AzVirtualNetworkTap.md new file mode 100644 index 0000000000..31973337a0 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualNetworkTap.md @@ -0,0 +1,297 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualnetworktap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkTap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualNetworkTap.md +--- + +# New-AzVirtualNetworkTap + +## SYNOPSIS +Creates a VirtualNetworkTap resource. + +## SYNTAX + +### SetByResource (Default) +``` +New-AzVirtualNetworkTap -ResourceGroupName <String> -Name <String> [-DestinationPort <Int32>] + [-Location <String>] [-Tag <Hashtable>] + [-DestinationNetworkInterfaceIPConfiguration <PSNetworkInterfaceIPConfiguration>] + [-DestinationLoadBalancerFrontEndIPConfiguration <PSFrontendIPConfiguration>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +New-AzVirtualNetworkTap -ResourceGroupName <String> -Name <String> [-DestinationPort <Int32>] + [-Location <String>] [-Tag <Hashtable>] [-DestinationNetworkInterfaceIPConfigurationId <String>] + [-DestinationLoadBalancerFrontEndIPConfigurationId <String>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVirtualNetworkTap** cmdlet creates an Azure virtual network tap resource. + +## EXAMPLES + +### Example 1: Create an Azure virtual network tap +```powershell +New-AzVirtualNetworkTap -Name "VirtualNetworkTap1" -ResourceGroupName "ResourceGroup1" -Location "centralus" -DestinationPort 8888 -DestinationNetworkInterfaceIPConfiguration $destinationNic.IpConfigurations[0] +``` + +This command creates a virtual network tap named "VirtualNetworkTap1" which has destination VM configuration details (DestinationIpConfiguration, DestinationPort). +All the source tap configured VM's traffic will be routed to this Destination IP + Port. + +### Example 2: Create an Azure virtual network tap using LoadBalancer IP +```powershell +# Create LoadBalancer +$frontend = New-AzLoadBalancerFrontendIpConfig -Name $frontendName -PublicIpAddress $publicip +New-AzVirtualNetworkTap -Name "VirtualNetworkTap1" -ResourceGroupName "ResourceGroup1" -Location "centralus" -DestinationLoadBalancerFrontEndIPConfiguration $frontend +``` + +This command creates a virtual network tap named "VirtualNetworkTap1" which has destination VM configuration details (FrontEndIpConfiguration). +All the source tap configured VM's traffic will be routed to this LoadBalancer IpConfiguration. Default Destination Port is 4789. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationLoadBalancerFrontEndIPConfiguration +The reference of the destination load balancer front end IP configuration resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DestinationLoadBalancerFrontEndIPConfigurationId +The reference of the destination load balancer front end IP configuration resource. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DestinationNetworkInterfaceIPConfiguration +The reference of the destination network interface IP configuration resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DestinationNetworkInterfaceIPConfigurationId +The reference of the destination network interface IP configuration resource. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DestinationPort +The Destination Port of the packet collector + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the tap. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the virtual network tap. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkTap](./Get-AzVirtualNetworkTap.md) + +[Remove-AzVirtualNetworkTap](./Remove-AzVirtualNetworkTap.md) + +[Set-AzVirtualNetworkTap](./Set-AzVirtualNetworkTap.md) diff --git a/azps-10.1.0/Az.Network/New-AzVirtualRouter.md b/azps-10.1.0/Az.Network/New-AzVirtualRouter.md new file mode 100644 index 0000000000..b2c6104f66 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualRouter.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualrouter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualRouter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualRouter.md +--- + +# New-AzVirtualRouter + +## SYNOPSIS +Creates an Azure VirtualRouter. + +## SYNTAX + +``` +New-AzVirtualRouter -ResourceGroupName <String> -Name <String> -HostedSubnet <String> -Location <String> + [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVirtualRouter** cmdlet creates an Azure VirtualRouter + +## EXAMPLES + +### Example 1 +```powershell +$subnet = New-AzVirtualNetworkSubnetConfig -Name $subnetName -AddressPrefix 10.0.0.0/24 +$vnet = New-AzVirtualNetwork -Name $vnetName -ResourceGroupName $resourceGroupName -Location $resourceGroupLocation -AddressPrefix 10.0.0.0/16 -Subnet $subnet +$subnetId = (Get-AzVirtualNetworkSubnetConfig -Name $subnetName -VirtualNetwork $vnet).Id +New-AzVirtualRouter -Name $virtualRouterName -ResourceGroupName $resourceGroupName -Location $resourceGroupLocation -HostedSubnet $subnetId +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostedSubnet +The subnet where the virtual router is hosted. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the virtual router. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the virtual router. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualRouter + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzVirtualRouterAutoScaleConfiguration.md b/azps-10.1.0/Az.Network/New-AzVirtualRouterAutoScaleConfiguration.md new file mode 100644 index 0000000000..b9c4f74e09 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualRouterAutoScaleConfiguration.md @@ -0,0 +1,86 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualrouterautoscaleconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualRouterAutoScaleConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualRouterAutoScaleConfiguration.md +--- + +# New-AzVirtualRouterAutoScaleConfiguration + +## SYNOPSIS +Create a VirtualRouterAutoScaleConfiguration object for a Virtual Hub. + +## SYNTAX + +``` +New-AzVirtualRouterAutoScaleConfiguration -MinCapacity <Int32> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVirtualRouterAutoScaleConfiguration** cmdlet creates a virtual hub autoscale configuration object. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +$autoscale = New-AzVirtualRouterAutoScaleConfiguration -MinCapacity 3 +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -VirtualRouterAutoScaleConfiguration $autoscale +Remove-AzVirtualHub -ResourceGroupName "testRG" -Name "westushub" +``` + +The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24" and minimum capacity 3. + +It then deletes the virtual hub using its ResourceGroupName and ResourceName. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinCapacity +The minimum number of scale units for VirtualHub Router. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualRouterAutoScaleConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzVirtualWan.md b/azps-10.1.0/Az.Network/New-AzVirtualWan.md new file mode 100644 index 0000000000..e00d94cd1f --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVirtualWan.md @@ -0,0 +1,246 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvirtualwan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualWan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVirtualWan.md +--- + +# New-AzVirtualWan + +## SYNOPSIS +Creates an Azure Virtual WAN. + +## SYNTAX + +``` +New-AzVirtualWan -ResourceGroupName <String> -Name <String> -Location <String> [-AllowVnetToVnetTraffic] + [-AllowBranchToBranchTraffic] [-Tag <Hashtable>] [-VirtualWANType <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Azure VirtualWAN resource. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -AllowBranchToBranchTraffic +``` + +```output +Name : testRG +Id : /subscriptions/{SubscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +AllowVnetToVnetTraffic : False +AllowBranchToBranchTraffic : True +Location : West US +VirtualWANType : Standard +Type : Microsoft.Network/virtualWans +ProvisioningState : Succeeded +``` + +The above will create a resource group "testRG" in region "West US" and an Azure Virtual WAN with branch to branch traffic allowed in that resource group in Azure. + +### Example 2 + +Creates an Azure Virtual WAN. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzVirtualWan -AllowBranchToBranchTraffic -AllowVnetToVnetTraffic -Location 'Central US' -Name 'MyVirtualWan' -ResourceGroupName 'TestResourceGroup' -VirtualWANType 'Standard' +``` + +## PARAMETERS + +### -AllowBranchToBranchTraffic +Allow branch to branch traffic for VirtualWan. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowVnetToVnetTraffic +Allow vnet to vnet traffic for VirtualWan. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the VirtualWAN resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VirtualWanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualWANType +The type of the Virtual Wan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualWan + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualWan](./Get-AzVirtualWan.md) + +[Remove-AzVirtualWan](./Remove-AzVirtualWan.md) + +[Update-AzVirtualWan](./Update-AzVirtualWan.md) diff --git a/azps-10.1.0/Az.Network/New-AzVpnClientConfiguration.md b/azps-10.1.0/Az.Network/New-AzVpnClientConfiguration.md new file mode 100644 index 0000000000..3aee990fb1 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnClientConfiguration.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpnclientconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnClientConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnClientConfiguration.md +--- + +# New-AzVpnClientConfiguration + +## SYNOPSIS +This command allows the users to create the Vpn profile package based on pre-configured vpn settings on the VPN gateway, in addition to some additional settings that users may need to configure, for e.g. some root certificates. + +## SYNTAX + +``` +New-AzVpnClientConfiguration [-Name <String>] -ResourceGroupName <String> [-ProcessorArchitecture <String>] + [-AuthenticationMethod <String>] [-RadiusRootCertificateFile <String>] + [-ClientRootCertificateFileList <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +this allows the users to create the Vpn profile package based on pre-configured vpn settings on the VPN gateway, in addition to some additional settings that users may need to configure, for e.g. some root certificates. + +## EXAMPLES + +### Example 1 +```powershell +New-AzVpnClientConfiguration -ResourceGroupName "ContosoResourceGroup" -Name "ContosoVirtualNetworkGateway" -AuthenticationMethod "EAPTLS" -RadiusRootCertificateFile "C:\Users\Test\Desktop\VpnProfileRadiusCert.cer" +``` + +This cmdlet is used to create a VPN client profile zip file for "ContosoVirtualNetworkGateway" in ResourceGroup "ContosoResourceGroup". The profile is generated for a pre-configured radius server that is configured to use "EAPTLS" authentication method with the VpnProfileRadiusCert certificate file. + +## PARAMETERS + +### -AuthenticationMethod +Authentication Method +Can take values EAPMSCHAPv2 or EAPTLS. When EAPMSCHAPv2 is specified then the cmdlet generates a client configuration installer for username/password authentication that uses EAP-MSCHAPv2 authentication protocol. If EAPTLS is specified then the cmdlet generates a client configuration installer for certificate authentication that uses EAP-TLS protocol. The "EapTls" option can be used for both RADIUS-based certificate authentication and certification authentication performed by the Virtual Network Gateway by uploading the trusted root. The cmdlet automatically detects what is configured. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: EAPTLS, EAPMSCHAPv2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientRootCertificateFileList +A list of client root certificate paths + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProcessorArchitecture +ProcessorArchitecture + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Amd64, X86 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RadiusRootCertificateFile +Radius server root certificate path. This is a mandatory parameter that has to be specified when EAP-TLS with RADIUS authentication is used. This is the full path name of .cer file containing the RADIUS root certificate that the client uses to validates the RADIUS server during authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnProfile + +## NOTES + +## RELATED LINKS + +[Get-AzVpnClientConfiguration](./Get-AzVpnClientConfiguration.md) diff --git a/azps-10.1.0/Az.Network/New-AzVpnClientConnectionConfiguration.md b/azps-10.1.0/Az.Network/New-AzVpnClientConnectionConfiguration.md new file mode 100644 index 0000000000..9dc8f0f327 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnClientConnectionConfiguration.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpnclientconnectionconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnClientConnectionConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnClientConnectionConfiguration.md +--- + +# New-AzVpnClientConnectionConfiguration + +## SYNOPSIS +Create Virtual Network Gateway Connection configuration + +## SYNTAX + +``` +New-AzVpnClientConnectionConfiguration -Name <String> + -VirtualNetworkGatewayPolicyGroup <PSVirtualNetworkGatewayPolicyGroup[]> -VpnClientAddressPool <String[]> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Conneciton Configuration associate between the address space of the P2S client and the according virtual network gateway policy groups + +## EXAMPLES + +### Example 1 +```powershell +$member1=New-AzVirtualNetworkGatewayPolicyGroupMember -Name "member1" -AttributeType "CertificateGroupId" -AttributeValue "ab" +$member2=New-AzVirtualNetworkGatewayPolicyGroupMember -Name "member2" -AttributeType "CertificateGroupId" -AttributeValue "cd" +$policyGroup1=New-AzVirtualNetworkGatewayPolicyGroup -Name "policyGroup1" -Priority 0 -DefaultPolicyGroup -PolicyMember $member1 +$policyGroup2=New-AzVirtualNetworkGatewayPolicyGroup -Name "policyGroup2" -Priority 10 -PolicyMember $member2 +$vngconnectionConfig=New-AzVpnClientConnectionConfiguration -Name "coonfig1" -VirtualNetworkGatewayPolicyGroup $policyGroup1 -VpnClientAddressPool "192.168.10.0/24" +$vngconnectionConfig2=New-AzVpnClientConnectionConfiguration -Name "coonfig2" -VirtualNetworkGatewayPolicyGroup $policyGroup2 -VpnClientAddressPool "192.168.20.0/24" +``` + +Create Client Connection configuration + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Virtual Network Gateway Policy Group Member + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayPolicyGroup +Virtual Network Gateway Policy Groups + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayPolicyGroup[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientAddressPool +The Associatted client address pool + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayPolicyGroup[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzVpnClientIpsecParameter.md b/azps-10.1.0/Az.Network/New-AzVpnClientIpsecParameter.md new file mode 100644 index 0000000000..4de2c70f54 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnClientIpsecParameter.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpnclientipsecparameter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnClientIpsecParameter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnClientIpsecParameter.md +--- + +# New-AzVpnClientIpsecParameter + +## SYNOPSIS +This command allows the users to create the Vpn ipsec parameters object specifying one or all values such as IpsecEncryption,IpsecIntegrity,IkeEncryption,IkeIntegrity,DhGroup,PfsGroup to set on the existing VPN gateway. + +## SYNTAX + +``` +New-AzVpnClientIpsecParameter [-SALifeTime <Int32>] [-SADataSize <Int32>] [-IpsecEncryption <String>] + [-IpsecIntegrity <String>] [-IkeEncryption <String>] [-IkeIntegrity <String>] [-DhGroup <String>] + [-PfsGroup <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This command allows the users to create the Vpn ipsec parameters object specifying one or all values such as IpsecEncryption,IpsecIntegrity,IkeEncryption,IkeIntegrity,DhGroup,PfsGroup to set on the existing VPN gateway. + +## EXAMPLES + +### Example 1 +```powershell +$vpnclientipsecparams1 = New-AzVpnClientIpsecParameter -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTime 86473 -SADataSize 429498 -IkeEncryption AES256 -IkeIntegrity SHA384 -DhGroup DHGroup2 -PfsGroup PFS2 +$setvpnIpsecParams = Set-AzVpnClientIpsecParameter -VirtualNetworkGatewayName $rname -ResourceGroupName $rgname -VpnClientIPsecParameter $vpnclientipsecparams1 +``` + +New-AzVpnClientIpsecParameter cmdlet is used to create the vpn ipsec parameters object of using the passed one or all parameters' values which user can set for any existing Virtual network gateway in ResourceGroup. +This created VpnClientIPsecParameters object is passed to Set-AzVpnClientIpsecParameter command to set the specified Vpn ipsec custom policy on Virtual network gateway as shown in above example. This command returns object of VpnClientIPsecParameters which shows set parameters. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DhGroup +The VpnClient DH Groups used in IKE Phase 1 for initial SA. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: DHGroup24, ECP384, ECP256, DHGroup14, DHGroup2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IkeEncryption +The VpnClient IKE encryption algorithm (IKE Phase 2) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: GCMAES256, GCMAES128, AES256, AES128 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IkeIntegrity +The VpnClient IKE integrity algorithm (IKE Phase 2) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: SHA384, SHA256 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpsecEncryption +The VpnClient IPSec encryption algorithm (IKE Phase 1) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: GCMAES256, GCMAES128, AES256, AES128 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpsecIntegrity +The VpnClient IPSec integrity algorithm (IKE Phase 1) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: GCMAES256, GCMAES128, SHA256 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PfsGroup +The VpnClient PFS Groups used in IKE Phase 2 for new child SA + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: PFS24, PFSMM, ECP384, ECP256, PFS14, PFS2, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SADataSize +The VpnClient IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SALifeTime +The VpnClient IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientIPsecParameters + +## NOTES + +## RELATED LINKS + +[Get-AzVpnClientIpsecParameter](./Get-AzVpnClientIpsecParameter.md) + +[Remove-AzVpnClientIpsecParameter](./Remove-AzVpnClientIpsecParameter.md) + +[Set-AzVpnClientIpsecParameter](./Set-AzVpnClientIpsecParameter.md) diff --git a/azps-10.1.0/Az.Network/New-AzVpnClientIpsecPolicy.md b/azps-10.1.0/Az.Network/New-AzVpnClientIpsecPolicy.md new file mode 100644 index 0000000000..469f2b7442 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnClientIpsecPolicy.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpnclientipsecpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnClientIpsecPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnClientIpsecPolicy.md +--- + +# New-AzVpnClientIpsecPolicy + +## SYNOPSIS +This command allows the users to create the Vpn ipsec policy object specifying one or all values such as IpsecEncryption,IpsecIntegrity,IkeEncryption,IkeIntegrity,DhGroup,PfsGroup to set on the VPN gateway. This command let output object is used to set vpn ipsec policy for both new / existing gateway. + +## SYNTAX + +``` +New-AzVpnClientIpsecPolicy [-SALifeTime <Int32>] [-SADataSize <Int32>] [-IpsecEncryption <String>] + [-IpsecIntegrity <String>] [-IkeEncryption <String>] [-IkeIntegrity <String>] [-DhGroup <String>] + [-PfsGroup <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This command allows the users to create the Vpn ipsec policy object specifying one or all values such as IpsecEncryption,IpsecIntegrity,IkeEncryption,IkeIntegrity,DhGroup,PfsGroup to set on the VPN gateway. This command let output object is used to set vpn ipsec policy for both new / existing gateway. + +## EXAMPLES + +### Example 1: Define vpn ipsec policy object: +```powershell +$vpnclientipsecpolicy = New-AzVpnClientIpsecPolicy -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTime 86472 -SADataSize 429497 -IkeEncryption AES256 -IkeIntegrity SHA256 -DhGroup DHGroup2 -PfsGroup None +``` + +This cmdlet is used to create the vpn ipsec policy object using the passed one or all parameters' values which user can pass to param:VpnClientIpsecPolicy of PS command let: New-AzVirtualNetworkGateway (New VPN Gateway creation) / Set-AzVirtualNetworkGateway (existing VPN Gateway update) in ResourceGroup : + +### Example 2: Create new virtual network gateway with setting vpn custom ipsec policy: +```powershell +$vnetGateway = New-AzVirtualNetworkGateway -ResourceGroupName vnet-gateway -name myNGW -location $location -IpConfigurations $vnetIpConfig -GatewayType Vpn -VpnType RouteBased -GatewaySku VpnGw1 -VpnClientIpsecPolicy $vpnclientipsecpolicy +``` + +This cmdlet returns virtual network gateway object after creation. + +### Example 3: Set vpn custom ipsec policy on existing virtual network gateway: +```powershell +$vnetGateway = Set-AzVirtualNetworkGateway -VirtualNetworkGateway $gateway -VpnClientIpsecPolicy $vpnclientipsecpolicy +``` + +This cmdlet returns virtual network gateway object after setting vpn custom ipsec policy. + +### Example 4: Get virtual network gateway to see if vpn custom policy is set correctly: +```powershell +$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName vnet-gateway -name myNGW +``` + +This cmdlet returns virtual network gateway object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DhGroup +The VpnClient DH Groups used in IKE Phase 1 for initial SA + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: DHGroup24, ECP384, ECP256, DHGroup14, DHGroup2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IkeEncryption +The VpnClient IKE encryption algorithm (IKE Phase 2) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: GCMAES256, GCMAES128, AES256, AES128 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IkeIntegrity +The VpnClient IKE integrity algorithm (IKE Phase 2) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: SHA384, SHA256 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpsecEncryption +The VpnClient IPSec encryption algorithm (IKE Phase 1) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: GCMAES256, GCMAES128, AES256, AES128 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpsecIntegrity +The VpnClient IPSec integrity algorithm (IKE Phase 1) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: GCMAES256, GCMAES128, SHA256 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PfsGroup +The VpnClient PFS Groups used in IKE Phase 2 for new child SA + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: PFS24, PFSMM, ECP384, ECP256, PFS14, PFS2, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SADataSize +The VpnClient IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SALifeTime +The VpnClient IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzVpnClientRevokedCertificate.md b/azps-10.1.0/Az.Network/New-AzVpnClientRevokedCertificate.md new file mode 100644 index 0000000000..add89c2ace --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnClientRevokedCertificate.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 973E1E53-983F-45A7-A7CF-18A8D96EC4E6 +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpnclientrevokedcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnClientRevokedCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnClientRevokedCertificate.md +--- + +# New-AzVpnClientRevokedCertificate + +## SYNOPSIS +Creates a new VPN client-revocation certificate. + +## SYNTAX + +``` +New-AzVpnClientRevokedCertificate -Name <String> -Thumbprint <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVpnClientRevokedCertificate** cmdlet creates a new virtual private network (VPN) client-revocation certificate for use on a virtual network gateway. +Client-revocation certificates prevent client computers from using the specified certificate for authentication. +This cmdlet creates a stand-alone certificate that is not assigned to a virtual gateway. +Instead, the certificate created by **New-AzVpnClientRevokedCertificate** is used in conjunction with the New-AzVirtualNetworkGateway cmdlet when it creates a new gateway. +For instance, suppose you create a new certificate and store it in a variable named $Certificate. +You can then use that certificate object when you create a new virtual gateway. +For instance, +`New-AzVirtualNetworkGateway -Name "ContosoVirtualGateway" -ResourceGroupName "ContosoResourceGroup" -Location "West US" -GatewayType "VPN" -IpConfigurations $Ipconfig -VPNType "RouteBased" -VpnClientRevokedCertificates $Certificate` +For more information, see the documentation for the New-AzVirtualNetworkGateway cmdlet. + +## EXAMPLES + +### Example 1: Create a new client-revoked certificate +```powershell +$Certificate = New-AzVpnClientRevokedCertificate -Name "ContosoClientRevokedCertificate" -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" +``` + +This command creates a new client-revoked certificate and stores the certificate object in a variable named $Certificate. +This variable can then be used by the **New-AzVirtualNetworkGateway** cmdlet to add the certificate to a new virtual network gateway. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a unique name for the new client-revocation certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Thumbprint +Specifies the unique identifier of the certificate being added. +You can return thumbprint information for your certificates by using a Windows PowerShell command similar to this: +`Get-ChildItem -Path Cert:\LocalMachine\Root` +The preceding command returns information for all the Local Computer certificates found in the Root certificate store. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate + +## NOTES + +## RELATED LINKS + +[Add-AzVpnClientRevokedCertificate](./Add-AzVpnClientRevokedCertificate.md) + +[Get-AzVpnClientRevokedCertificate](./Get-AzVpnClientRevokedCertificate.md) + +[Remove-AzVpnClientRevokedCertificate](./Remove-AzVpnClientRevokedCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzVpnClientRootCertificate.md b/azps-10.1.0/Az.Network/New-AzVpnClientRootCertificate.md new file mode 100644 index 0000000000..b098e1c929 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnClientRootCertificate.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C54AC64C-DA21-443E-8CFE-6CCAC6152C2B +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpnclientrootcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnClientRootCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnClientRootCertificate.md +--- + +# New-AzVpnClientRootCertificate + +## SYNOPSIS +Creates a new VPN client root certificate. + +## SYNTAX + +``` +New-AzVpnClientRootCertificate -Name <String> -PublicCertData <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVpnClientRootCertificate** cmdlet creates a new VPN root certificate for use on a virtual network gateway. +Root certificates are X.509 certificates that identify your Root Certification Authority: all other certificates used on the gateway trust the root certificate. +This cmdlet creates a stand-alone certificate that is not assigned to a virtual gateway. +Instead, the certificate created by **New-AzVpnClientRootCertificate** is used in conjunction with the New-AzVirtualNetworkGateway cmdlet when creating a new gateway. +For example, suppose you create a new certificate and store it in a variable named $Certificate. +You can then use that certificate object when creating a new virtual gateway. +For instance, +`New-AzVirtualNetworkGateway -Name "ContosoVirtualGateway" -ResourceGroupName "ContosoResourceGroup" -Location "West US" -GatewayType "VPN" -IpConfigurations $Ipconfig -VPNType "RouteBased" -VpnClientRootCertificates $Certificate` +For more information, see the documentation for the New-AzVirtualNetworkGateway cmdlet. + +## EXAMPLES + +### Example 1: Create a client root certificate +```powershell +$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertificate.cer" +$CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text[$i]} +$Certificate = New-AzVpnClientRootCertificate -PublicCertData $CertificateText -Name "ContosoClientRootCertificate" +``` + +This example creates a client root certificate and store the certificate object in a variable named $Certificate. +This variable can then be used by the **New-AzVirtualNetworkGateway** cmdlet to add a root certificate to a new virtual network gateway. +The first command uses the **Get-Content** cmdlet to get a previously exported text representation of the root certificate; that text data is stored in a variable named $Text. +The second command then uses a for loop to extract all the text except for the first line and the last line, storing the extracted text in a variable named $CertificateText. +The third command uses the **New-AzVpnClientRootCertificate** cmdlet to create the certificate, storing the created object in a variable named $Certificate. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the new client root certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicCertData +Specifies a text representation of the root certificate to be added. +To obtain the text representation, export your certificate in .cer format (using Base64 encoding), then open the resulting file in a text editor. +You should see output similar to this (note that the actual output will contain many more lines of text than the abbreviated sample shown here): +----- BEGIN CERTIFICATE ----- +MIIC13FAAXC3671Auij9HHgUNEW8343NMJklo09982CVVFAw8w +----- END CERTIFICATE ----- +The PublicCertData is made up of all the lines between the first line (----- BEGIN CERTIFICATE -----) and the last line (----- END CERTIFICATE -----) in the file. +You can retrieve the PublicCertData by using Windows PowerShell commands similar to this: +$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertificate.cer" +$CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text\[$i\]} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate + +## NOTES + +## RELATED LINKS + +[Add-AzVpnClientRootCertificate](./Add-AzVpnClientRootCertificate.md) + +[Get-AzVpnClientRootCertificate](./Get-AzVpnClientRootCertificate.md) + +[Remove-AzVpnClientRootCertificate](./Remove-AzVpnClientRootCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/New-AzVpnConnection.md b/azps-10.1.0/Az.Network/New-AzVpnConnection.md new file mode 100644 index 0000000000..c5f0f4eb29 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnConnection.md @@ -0,0 +1,521 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpnconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnConnection.md +--- + +# New-AzVpnConnection + +## SYNOPSIS +Creates a IPSec connection that connects a VpnGateway to a remote customer branch represented in RM as a VpnSite. + +## SYNTAX + +### ByVpnGatewayNameByVpnSiteObject (Default) +``` +New-AzVpnConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + -VpnSite <PSVpnSite> [-SharedKey <SecureString>] [-ConnectionBandwidthInMbps <UInt32>] + [-IpSecPolicy <PSIpsecPolicy>] [-VpnConnectionProtocolType <String>] [-EnableBgp] [-UseLocalAzureIpAddress] + [-UsePolicyBasedTrafficSelectors] [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>] + [-EnableInternetSecurity] [-RoutingConfiguration <PSRoutingConfiguration>] + [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayNameByVpnSiteResourceId +``` +New-AzVpnConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> -VpnSiteId <String> + [-SharedKey <SecureString>] [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] + [-VpnConnectionProtocolType <String>] [-EnableBgp] [-UseLocalAzureIpAddress] [-UsePolicyBasedTrafficSelectors] + [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>] [-EnableInternetSecurity] + [-RoutingConfiguration <PSRoutingConfiguration>] [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayObjectByVpnSiteObject +``` +New-AzVpnConnection -ParentObject <PSVpnGateway> -Name <String> -VpnSite <PSVpnSite> + [-SharedKey <SecureString>] [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] + [-VpnConnectionProtocolType <String>] [-EnableBgp] [-UseLocalAzureIpAddress] [-UsePolicyBasedTrafficSelectors] + [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>] [-EnableInternetSecurity] + [-RoutingConfiguration <PSRoutingConfiguration>] [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayObjectByVpnSiteResourceId +``` +New-AzVpnConnection -ParentObject <PSVpnGateway> -Name <String> -VpnSiteId <String> [-SharedKey <SecureString>] + [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] [-VpnConnectionProtocolType <String>] + [-EnableBgp] [-UseLocalAzureIpAddress] [-UsePolicyBasedTrafficSelectors] + [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>] [-EnableInternetSecurity] + [-RoutingConfiguration <PSRoutingConfiguration>] [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayResourceIdByVpnSiteObject +``` +New-AzVpnConnection -ParentResourceId <String> -Name <String> -VpnSite <PSVpnSite> [-SharedKey <SecureString>] + [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] [-VpnConnectionProtocolType <String>] + [-EnableBgp] [-UseLocalAzureIpAddress] [-UsePolicyBasedTrafficSelectors] + [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>] [-EnableInternetSecurity] + [-RoutingConfiguration <PSRoutingConfiguration>] [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayResourceIdByVpnSiteResourceId +``` +New-AzVpnConnection -ParentResourceId <String> -Name <String> -VpnSiteId <String> [-SharedKey <SecureString>] + [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] [-VpnConnectionProtocolType <String>] + [-EnableBgp] [-UseLocalAzureIpAddress] [-UsePolicyBasedTrafficSelectors] + [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>] [-EnableInternetSecurity] + [-RoutingConfiguration <PSRoutingConfiguration>] [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a IPSec connection that connects a VpnGateway to a remote customer branch represented in RM as a VpnSite. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" +$vpnSite = New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" + +New-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite -ConnectionBandwidthInMbps 20 +``` + +```output +RemoteVpnSite : Microsoft.Azure.Commands.Network.Models.PSResourceId +SharedKey : +VpnConnectionProtocolType : IKEv2 +ConnectionStatus : +EgressBytesTransferred : 0 +IngressBytesTransferred : 0 +IpsecPolicies : {} +ConnectionBandwidth : 20 +EnableBgp : False +UseLocalAzureIpAddress : False +ProvisioningState : testConnection +Name : ps9709 +Etag : W/"4580a2e2-2fab-4cff-88eb-92013a76b5a8" +Id : /subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/vpnGateways/testvpngw/vpnConnections/testConnection +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite in West US in "testRG" resource group in Azure. +A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. + +Once the gateway has been created, it is connected to the VpnSite using the New-AzVpnConnection command. + +### Example 2 +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" + +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" + +$vpnSiteLink1 = New-AzVpnSiteLink -Name "testVpnSiteLink1" -IpAddress "15.25.35.45" -LinkProviderName "SomeTelecomProvider" -LinkSpeedInMbps "10" +$vpnSiteLink2 = New-AzVpnSiteLink -Name "testVpnSiteLink2" -IpAddress "15.25.35.55" -LinkProviderName "SomeTelecomProvider2" -LinkSpeedInMbps "100" +$vpnSite = New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -VpnSiteLink @($vpnSiteLink1, $vpnSiteLink2) + + +$vpnSiteLinkConnection1 = New-AzVpnSiteLinkConnection -Name "testLinkConnection1" -VpnSiteLink $vpnSite.VpnSiteLinks[0] -ConnectionBandwidth 100 +$vpnSiteLinkConnection2 = New-AzVpnSiteLinkConnection -Name "testLinkConnection2" -VpnSiteLink $vpnSite.VpnSiteLinks[1] -ConnectionBandwidth 10 + +New-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite -VpnSiteLinkConnection @($vpnSiteLinkConnection1, $vpnSiteLinkConnection2) +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite with 1 VpnSiteLinks in West US in "testRG" resource group in Azure. +A VPN gateway will be created thereafter in the Virtual Hub. +Once the gateway has been created, it is connected to the VpnSite using the New-AzVpnConnection command with 1 VpnSiteLinkConnections to the VpnSiteLink of the VpnSite. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionBandwidthInMbps +The bandwidth that needs to be handled by this connection in mbps. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBgp +Enable BGP for this connection + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternetSecurity +Enable internet security for this connection + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpSecPolicy +The bandwidth that needs to be handled by this connection in mbps. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VpnConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The parent VpnGateway for this connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnGateway +Parameter Sets: ByVpnGatewayObjectByVpnSiteObject, ByVpnGatewayObjectByVpnSiteResourceId +Aliases: ParentVpnGateway, VpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The resource id of the parent VpnGateway for this connection. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayResourceIdByVpnSiteObject, ByVpnGatewayResourceIdByVpnSiteResourceId +Aliases: ParentVpnGatewayId, VpnGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentResourceName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayNameByVpnSiteObject, ByVpnGatewayNameByVpnSiteResourceId +Aliases: ParentVpnGatewayName, VpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayNameByVpnSiteObject, ByVpnGatewayNameByVpnSiteResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingConfiguration +Routing configuration for this connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedKey +The shared key required to set this connection up. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficSelectorPolicy +A list of Traffic Selector policies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSTrafficSelectorPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UseLocalAzureIpAddress +Use local azure ip address as source address while initiating connection. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePolicyBasedTrafficSelectors +Use policy based traffic selectors for this connection. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnConnectionProtocolType +Gateway connection protocol:IKEv1/IKEv2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IKEv1, IKEv2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnSite +The remote vpn site to which this hub virtual network connection is connected. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnSite +Parameter Sets: ByVpnGatewayNameByVpnSiteObject, ByVpnGatewayObjectByVpnSiteObject, ByVpnGatewayResourceIdByVpnSiteObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnSiteId +The remote vpn site to which this hub virtual network connection is connected. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayNameByVpnSiteResourceId, ByVpnGatewayObjectByVpnSiteResourceId, ByVpnGatewayResourceIdByVpnSiteResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnSiteLinkConnection +The list of VpnSiteLinkConnections that this VpnConnection have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnSiteLinkConnection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnConnection + +## NOTES + +## RELATED LINKS + +[Get-AzVpnConnection](./Get-AzVpnConnection.md) + +[Remove-AzVpnConnection](./Remove-AzVpnConnection.md) + +[Update-AzVpnConnection](./Update-AzVpnConnection.md) + +[New-AzRoutingConfiguration](./New-AzRoutingConfiguration.md) diff --git a/azps-10.1.0/Az.Network/New-AzVpnGateway.md b/azps-10.1.0/Az.Network/New-AzVpnGateway.md new file mode 100644 index 0000000000..76150bd995 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnGateway.md @@ -0,0 +1,339 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpngateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnGateway.md +--- + +# New-AzVpnGateway + +## SYNOPSIS +Creates a Scalable VPN Gateway. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +New-AzVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubName <String> [-VpnConnection <PSVpnConnection[]>] [-EnableRoutingPreferenceInternetFlag] + [-EnableBgpRouteTranslationForNat] [-VpnGatewayNatRule <PSVpnGatewayNatRule[]>] [-Tag <Hashtable>] + [-Asn <UInt32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +New-AzVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHub <PSVirtualHub> [-VpnConnection <PSVpnConnection[]>] [-EnableRoutingPreferenceInternetFlag] + [-EnableBgpRouteTranslationForNat] [-VpnGatewayNatRule <PSVpnGatewayNatRule[]>] [-Tag <Hashtable>] + [-Asn <UInt32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +New-AzVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubId <String> [-VpnConnection <PSVpnConnection[]>] [-EnableRoutingPreferenceInternetFlag] + [-EnableBgpRouteTranslationForNat] [-VpnGatewayNatRule <PSVpnGatewayNatRule[]>] [-Tag <Hashtable>] + [-Asn <UInt32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +New-AzVpnGateway creates a scalable VPN Gateway. +This is software defined connectivity for site to site connections inside the VirtualHub. + +This gateway resizes and scales based on the scale unit specified in this or the Set-AzVpnGateway cmdlet. + +A connection is set up from a branch/Site known as VPNSite to the scalable gateway. +Each connection comprises of 2 Active-Active tunnels. + +The VpnGateway will be in the same location as the referenced VirtualHub. + +## EXAMPLES + +### Example 1 +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 -EnableRoutingPreferenceInternetFlag +``` + +```output +ResourceGroupName : testRG +Name : testvpngw +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnGateways/testvpngw +Location : West US +VpnGatewayScaleUnit : 2 +VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/Ali_pS_Test/providers/Microsoft.Network/virtualHubs/westushub +BgpSettings : {} +Type : Microsoft.Network/vpnGateways +ProvisioningState : Succeeded +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in West US in "testRG" resource group in Azure. +A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```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 +``` + +### -Asn +The vpn gateway's ASN for BGP over VPN + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBgpRouteTranslationForNat +Flag to enable Bgp route translation for NAT on this VpnGateway. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableRoutingPreferenceInternetFlag +Flag to enable Routing Preference Internet on this VpnGateway. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The VirtualHub this VpnGateway needs to be associated with. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubId +The Id of the VirtualHub this VpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualHubName +The Id of the VirtualHub this VpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnConnection +The list of VpnConnections that this VpnGateway needs to have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnConnection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnGatewayNatRule +The list of VpnGatewayNatRules that are associated with this VpnGateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnGatewayNatRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnGatewayScaleUnit +The scale unit for this VpnGateway. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub +### System.String +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGateway +## NOTES + +## RELATED LINKS + +[Get-AzVpnGateway]() + +[Remove-AzVpnGateway]() + +[Update-AzVpnGateway]() + diff --git a/azps-10.1.0/Az.Network/New-AzVpnGatewayNatRule.md b/azps-10.1.0/Az.Network/New-AzVpnGatewayNatRule.md new file mode 100644 index 0000000000..3df18902c2 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnGatewayNatRule.md @@ -0,0 +1,337 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpngatewaynatrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnGatewayNatRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnGatewayNatRule.md +--- + +# New-AzVpnGatewayNatRule + +## SYNOPSIS +Creates a NAT rule on a VpnGateway which can be associated with VpnSiteLinkConnection. + +## SYNTAX + +### ByVpnGatewayName (Default) +``` +New-AzVpnGatewayNatRule -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + [-Type <String>] [-Mode <String>] -InternalMapping <String[]> -ExternalMapping <String[]> + [-InternalPortRange <String[]>] [-ExternalPortRange <String[]>] [-IpConfigurationId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayObject +``` +New-AzVpnGatewayNatRule -ParentObject <PSVpnGateway> -Name <String> [-Type <String>] [-Mode <String>] + -InternalMapping <String[]> -ExternalMapping <String[]> [-InternalPortRange <String[]>] + [-ExternalPortRange <String[]>] [-IpConfigurationId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayResourceId +``` +New-AzVpnGatewayNatRule -ParentResourceId <String> -Name <String> [-Type <String>] [-Mode <String>] + -InternalMapping <String[]> -ExternalMapping <String[]> [-InternalPortRange <String[]>] + [-ExternalPortRange <String[]>] [-IpConfigurationId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a NAT rule on a VpnGateway which can be associated with VpnGateway. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" + +New-AzVpnGatewayNatRule -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testNatRule" -Type Static -Mode EgressSnat -InternalMapping "10.0.0.1/26" -ExternalMapping "192.168.0.0/26" -InternalPortRange "100-100" -ExternalPortRange "200-200" +``` + +```output +Type : Static +Mode : EgressSnat +VpnConnectionProtocolType : IKEv2 +InternalMappings : 10.0.0.1/26 +ExternalMappings : 192.168.0.0/26 +InternalPortRange : 100-100 +ExternalPortRange : 200-200 +IpConfigurationId : +IngressVpnSiteLinkConnections : [Microsoft.Azure.Commands.Network.Models.PSResourceId] +EgressVpnSiteLinkConnections : [Microsoft.Azure.Commands.Network.Models.PSResourceId] +ProvisioningState : Provisioned +Name : ps9709 +Etag : W/"4580a2e2-2fab-4cff-88eb-92013a76b5a8" +Id : /subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/vpnGateways/testvpngw/natRules/testNatRule +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub. Then, we will create VpnGateway under that Virtual Hub. Then, using this command: New-AzVpnGatewayNatRule, NAT rule can be createdand associated with created VpnGateway. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalMapping +The list of private IP address subnet external mappings for NAT + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalPortRange +The list of external port range mappings for NAT subnets + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalMapping +The list of private IP address subnet internal mappings for NAT + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalPortRange +The list of internal port range mappings for NAT subnets + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfigurationId +The IP Configuration ID this NAT rule applies to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Source NAT direction of a VPN NAT + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: EgressSnat, IngressSnat + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VpnGatewayNatRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The parent VpnGateway for this NAT Rule. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnGateway +Parameter Sets: ByVpnGatewayObject +Aliases: ParentVpnGateway, VpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The resource id of the parent VpnGateway for this NAT Rule. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayResourceId +Aliases: ParentVpnGatewayId, VpnGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentResourceName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: ParentVpnGatewayName, VpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The type of NAT rule for VPN NAT + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Static, Dynamic + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGatewayNatRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzVpnServerConfiguration.md b/azps-10.1.0/Az.Network/New-AzVpnServerConfiguration.md new file mode 100644 index 0000000000..63fecfde70 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnServerConfiguration.md @@ -0,0 +1,426 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpnserverconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnServerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnServerConfiguration.md +--- + +# New-AzVpnServerConfiguration + +## SYNOPSIS +Create a new VpnServerConfiguration for point to site connectivity. + +## SYNTAX + +``` +New-AzVpnServerConfiguration -ResourceGroupName <String> -Name <String> -Location <String> + [-VpnProtocol <String[]>] [-VpnAuthenticationType <String[]>] [-VpnClientRootCertificateFilesList <String[]>] + [-VpnClientRevokedCertificateFilesList <String[]>] [-RadiusServerAddress <String>] + [-RadiusServerSecret <SecureString>] [-RadiusServerList <PSRadiusServer[]>] + [-RadiusServerRootCertificateFilesList <String[]>] [-RadiusClientRootCertificateFilesList <String[]>] + [-AadTenant <String>] [-AadAudience <String>] [-AadIssuer <String>] [-VpnClientIpsecPolicy <PSIpsecPolicy[]>] + [-ConfigurationPolicyGroup <PSVpnServerConfigurationPolicyGroup[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzVpnServerConfiguration** cmdlet enables you to create a new VpnServerConfiguration with different VpnProtocols, VpnAuthenticationTypes, IpsecPolicies and to set selected vpn authentication type related parameters as per the customer's requirement for Point to site connectivity. + +## EXAMPLES + +### Example 1 +```powershell +$VpnServerConfigCertFilePath = Join-Path -Path $basedir -ChildPath "\ScenarioTests\Data\ApplicationGatewayAuthCert.cer" +$listOfCerts = New-Object "System.Collections.Generic.List[String]" +$listOfCerts.Add($VpnServerConfigCertFilePath) +New-AzVpnServerConfiguration -Name "test1config" -ResourceGroupName "P2SCortexGATesting" -VpnProtocol IkeV2 -VpnAuthenticationType Certificate -VpnClientRootCertificateFilesList $listOfCerts -VpnClientRevokedCertificateFilesList $listOfCerts -Location "westus" +``` + +```output +ResourceGroupName : P2SCortexGATesting +Name : test1config +Id : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/test1config +Location : westus +VpnProtocols : {IkeV2, OpenVPN} +VpnAuthenticationTypes : {Certificate} +VpnClientRootCertificates : +VpnClientRevokedCertificates : [ + { + "Name": "cert2", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] +RadiusServerAddress : +RadiusServerRootCertificates : [] +RadiusClientRootCertificates : [] +VpnClientIpsecPolicies : [] +AadAuthenticationParameters : null +P2sVpnGateways : [] +Type : Microsoft.Network/vpnServerConfigurations +ProvisioningState : Succeeded +``` + +The above command will create a new VpnServerConfiguration with VpnAuthenticationType as Certificate. + +### Example 2 + +Create a new VpnServerConfiguration for point to site connectivity. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzVpnServerConfiguration -AadAudience <String> -AadIssuer <String> -AadTenant <String> -Location 'westus' -Name 'test1config' -ResourceGroupName 'P2SCortexGATesting' -VpnAuthenticationType Certificate -VpnProtocol IkeV2 +``` + +## PARAMETERS + +### -AadAudience +AAD audience for P2S AAD authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AadIssuer +AAD issuer for P2S AAD authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AadTenant +AAD tenant for P2S AAD authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationPolicyGroup +The list of VpnServerConfigurationPolicyGroups that this P2SVpnGateway needs to have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnServerConfigurationPolicyGroup[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VpnServerConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RadiusClientRootCertificateFilesList +A list of RadiusClientRootCertificate files' paths + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RadiusServerAddress +P2S External Radius server address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RadiusServerList +P2S External multiple radius servers. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRadiusServer[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RadiusServerRootCertificateFilesList +A list of RadiusClientRootCertificate files' paths + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RadiusServerSecret +P2S External Radius server secret. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnAuthenticationType +The list of P2S VPN client tunneling protocols. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: Certificate, Radius, AAD + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnClientIpsecPolicy +A list of IPSec policies for VpnServerConfiguration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientRevokedCertificateFilesList +A list of VpnClientCertificates to be revoked files' paths + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnClientRootCertificateFilesList +A list of VpnClientRootCertificates to be added files' paths + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnProtocol +The list of P2S VPN client tunneling protocols. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: IkeV2, OpenVPN + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/New-AzVpnServerConfigurationPolicyGroup.md b/azps-10.1.0/Az.Network/New-AzVpnServerConfigurationPolicyGroup.md new file mode 100644 index 0000000000..44a434e569 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnServerConfigurationPolicyGroup.md @@ -0,0 +1,460 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpnserverconfigurationpolicygroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnServerConfigurationPolicyGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnServerConfigurationPolicyGroup.md +--- + +# New-AzP2sVpnGateway + +## SYNOPSIS +Create a new P2SVpnGateway under VirtualHub for point to site connectivity. + +## SYNTAX + +### ByVirtualHubNameByVpnServerConfigurationObject (Default) +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubName <String> [-VpnServerConfiguration <PSVpnServerConfiguration>] + [-VpnClientAddressPool <String[]>] [-CustomDnsServer <String[]>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] [-DisableInternetSecurityFlag] + [-EnableRoutingPreferenceInternetFlag] [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubNameByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubName <String> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObjectByVpnServerConfigurationObject +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHub <PSVirtualHub> [-VpnServerConfiguration <PSVpnServerConfiguration>] + [-VpnClientAddressPool <String[]>] [-CustomDnsServer <String[]>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] [-DisableInternetSecurityFlag] + [-EnableRoutingPreferenceInternetFlag] [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubObjectByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHub <PSVirtualHub> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByVpnServerConfigurationObject +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubId <String> [-VpnServerConfiguration <PSVpnServerConfiguration>] [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubId <String> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzP2sVpnGateway cmdlet enables you to create a new P2SVpnGateway under VirtualHub for Point to site connectivity from Point to site clients to Azure VirtualWan. + +## EXAMPLES + +### Example 1 +```powershell +$virtualHub = Get-AzVirtualHub -ResourceGroupName P2SCortexGATesting -Name WestUsVirtualHub +$vpnServerConfig1 = Get-AzVpnServerConfiguration -ResourceGroupName P2SCortexGATesting -Name WestUsConfig +$vpnClientAddressSpaces = New-Object string[] 1 +$vpnClientAddressSpaces[0] = "192.168.2.0/24" +$createdP2SVpnGateway = New-AzP2sVpnGateway -ResourceGroupName P2SCortexGATesting -Name 683482ade8564515aed4b8448c9757ea-westus-gw -VirtualHub $virtualHub -VpnGatewayScaleUnit 1 -VpnClientAddressPool $vpnClientAddressSpaces -VpnServerConfiguration $vpnServerConfig1 -EnableInternetSecurityFlag -EnableRoutingPreferenceInternetFlag +``` + +```output +ResourceGroupName : P2SCortexGATesting +Name : 683482ade8564515aed4b8448c9757ea-westus-gw +Id : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482ade8564515a + ed4b8448c9757ea-westus-gw +Location : westus +VpnGatewayScaleUnit : 1 +VirtualHub : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub +VpnServerConfiguration : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/WestUsConfig +VpnServerConfigurationLocation : +VpnClientConnectionHealth : null +Type : Microsoft.Network/p2sVpnGateways +ProvisioningState : Succeeded +P2SConnectionConfigurations : [ + { + "ProvisioningState": "Succeeded", + "VpnClientAddressPool": { + "AddressPrefixes": [ + "192.168.2.0/24" + ] + }, + "EnableInternetSecurity": True, + "RoutingConfiguration": { + "AssociatedRouteTable": { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + }, + "Name": "P2SConnectionConfigDefault", + "Etag": "W/\"4b96e6a2-b4d8-46b3-9210-76d40f359bef\"", + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482 + ade8564515aed4b8448c9757ea-westus-gw/p2sConnectionConfigurations/P2SConnectionConfigDefault" + } + ] +``` + +The New-AzP2sVpnGateway cmdlet enables you to create a new P2SVpnGateway under VirtualHub for Point to site connectivity. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```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 +``` + +### -CustomDnsServer +The list of Custom Dns Servers. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableInternetSecurityFlag +Flag to disable internet security feature on this P2SVpnGateway P2SConnectionConfiguration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternetSecurityFlag +Enable internet security flag for this P2SVpnGateway connections + +```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 +``` + +### -EnableRoutingPreferenceInternetFlag +Flag to enable Routing Preference Internet on this P2SVpnGateway. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, P2SVpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -P2SConnectionConfiguration +The list of P2SConnectionConfigurations that this P2SVpnGateway needs to have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSP2SConnectionConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingConfiguration +Routing configuration for this connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObjectByVpnServerConfigurationObject, ByVirtualHubObjectByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubId +The Id of the VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceIdByVpnServerConfigurationObject, ByVirtualHubResourceIdByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualHubName +The Id of the VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationObject, ByVirtualHubNameByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnClientAddressPool +P2S VpnClient AddressPool for this P2SVpnGateway P2SConnectionConfiguration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnGatewayScaleUnit +The scale unit for this P2SVpnGateway. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnServerConfiguration +The VpnServerConfiguration to be attached to this P2SVpnGateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationObject, ByVirtualHubObjectByVpnServerConfigurationObject, ByVirtualHubResourceIdByVpnServerConfigurationObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VpnServerConfigurationId +The id of Vpn server configuration object this P2SVpnGateway will be attached to. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationResourceId, ByVirtualHubObjectByVpnServerConfigurationResourceId, ByVirtualHubResourceIdByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub +System.String Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +## NOTES + +## RELATED LINKS + +[New-AzRoutingConfiguration]() + diff --git a/azps-10.1.0/Az.Network/New-AzVpnSite.md b/azps-10.1.0/Az.Network/New-AzVpnSite.md new file mode 100644 index 0000000000..a77ce750c0 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnSite.md @@ -0,0 +1,500 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpnsite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnSite.md +--- + +# New-AzVpnSite + +## SYNOPSIS +Creates a new Azure VpnSite resource. This is an RM representation of customer branches that are uploaded to Azure +for S2S connectivity with a Cortex virtual hub. + +## SYNTAX + +### ByVirtualWanNameByVpnSiteIpAddress (Default) +``` +New-AzVpnSite -ResourceGroupName <String> -Name <String> -Location <String> + -VirtualWanResourceGroupName <String> -VirtualWanName <String> -IpAddress <String> [-AddressSpace <String[]>] + [-DeviceModel <String>] [-DeviceVendor <String>] [-IsSecuritySite] [-LinkSpeedInMbps <UInt32>] + [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] + [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanNameByVpnSiteLinkObject +``` +New-AzVpnSite -ResourceGroupName <String> -Name <String> -Location <String> + -VirtualWanResourceGroupName <String> -VirtualWanName <String> [-AddressSpace <String[]>] + [-DeviceModel <String>] [-DeviceVendor <String>] [-IsSecuritySite] -VpnSiteLink <PSVpnSiteLink[]> + [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanObjectByVpnSiteIpAddress +``` +New-AzVpnSite -ResourceGroupName <String> -Name <String> -Location <String> -VirtualWan <PSVirtualWan> + -IpAddress <String> [-AddressSpace <String[]>] [-DeviceModel <String>] [-DeviceVendor <String>] + [-IsSecuritySite] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] + [-BgpPeeringWeight <UInt32>] [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanObjectByVpnSiteLinkObject +``` +New-AzVpnSite -ResourceGroupName <String> -Name <String> -Location <String> -VirtualWan <PSVirtualWan> + [-AddressSpace <String[]>] [-DeviceModel <String>] [-DeviceVendor <String>] [-IsSecuritySite] + -VpnSiteLink <PSVpnSiteLink[]> [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanResourceIdByVpnSiteIpAddress +``` +New-AzVpnSite -ResourceGroupName <String> -Name <String> -Location <String> -VirtualWanId <String> + -IpAddress <String> [-AddressSpace <String[]>] [-DeviceModel <String>] [-DeviceVendor <String>] + [-IsSecuritySite] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] + [-BgpPeeringWeight <UInt32>] [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanResourceIdByVpnSiteLinkObject +``` +New-AzVpnSite -ResourceGroupName <String> -Name <String> -Location <String> -VirtualWanId <String> + [-AddressSpace <String[]>] [-DeviceModel <String>] [-DeviceVendor <String>] [-IsSecuritySite] + -VpnSiteLink <PSVpnSiteLink[]> [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Azure VpnSite resource. This is an RM representation of customer branches that are uploaded to Azure +for S2S connectivity with a Cortex virtual hub. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "East US" -Name "nonlinkSite" +$virtualWan = New-AzVirtualWan -ResourceGroupName "nonlinkSite" -Name myVirtualWAN -Location "East US" + +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" + +New-AzVpnSite -ResourceGroupName "nonlinkSite" -Name "testVpnSite" -Location "East US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" +``` + +```output +ResourceGroupName : nonlinkSite +Name : testVpnSite +Id : /subscriptions/{subscriptionId}/resourceGroups/nonlinkSite/providers/Microsoft.Network/vpnSites/testVpnSite +Location : eastus2euap +IpAddress : 1.2.3.4 +VirtualWan : /subscriptions/{subscriptionId}/resourceGroups/nonlinkSite/providers/Microsoft.Network/virtualWans/myVirtualWAN +AddressSpace : {192.168.2.0/24, 192.168.3.0/24} +BgpSettings : +Type : Microsoft.Network/vpnSites +ProvisioningState : Succeeded +``` + +The above will create a resource group, Virtual WAN in East US in "nonlinkSite" resource group in Azure. + +Then it creates a VpnSite to represent a customer branch and links it to the Virtual WAN. + +An IPSec connection can then be setup with this branch and a VpnGateway using the New-AzVpnConnection command. + +### Example 2 +```powershell +New-AzResourceGroup -Location "East US" -Name "multilink" +$virtualWan = New-AzVirtualWan -ResourceGroupName multilink -Name myVirtualWAN -Location "East US" +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" + +$vpnSiteLink = New-AzVpnSiteLink -Name "testVpnSiteLink1" -IpAddress "15.25.35.45" -LinkProviderName "SomeTelecomProvider" -LinkSpeedInMbps "10" +$vpnSiteLink2 = New-AzVpnSiteLink -Name "testVpnSiteLink2" -IpAddress "15.25.35.55" -LinkProviderName "SomeTelecomProvider2" -LinkSpeedInMbps "100" +$vpnSite = New-AzVpnSite -ResourceGroupName "multilink" -Name "testVpnSite" -Location "East US" -VirtualWan $virtualWan -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -VpnSiteLink @($vpnSiteLink1, $vpnSiteLink2) +``` + +The above will create a resource group, Virtual WAN and a VpnSite with 1 VpnSiteLinks in East US in "multilink" resource group in Azure. + +### Example 3 + +Creates a new Azure VpnSite resource. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzVpnSite -AddressSpace <String[]> -DeviceModel 'SomeDevice' -DeviceVendor 'SomeDeviceVendor' -IpAddress '1.2.3.4' -LinkSpeedInMbps '10' -Location 'East US' -Name 'testVpnSite' -ResourceGroupName 'multilink' -VirtualWanName <String> -VirtualWanResourceGroupName <String> +``` + +## PARAMETERS + +### -AddressSpace +The address prefixes of the virtual network. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpAsn +The BGP ASN for this VpnSite. + +```yaml +Type: System.UInt32 +Parameter Sets: ByVirtualWanNameByVpnSiteIpAddress, ByVirtualWanObjectByVpnSiteIpAddress, ByVirtualWanResourceIdByVpnSiteIpAddress +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpPeeringAddress +The BGP Peering Address for this VpnSite. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanNameByVpnSiteIpAddress, ByVirtualWanObjectByVpnSiteIpAddress, ByVirtualWanResourceIdByVpnSiteIpAddress +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpPeeringWeight +The BGP Peering weight for this VpnSite. + +```yaml +Type: System.UInt32 +Parameter Sets: ByVirtualWanNameByVpnSiteIpAddress, ByVirtualWanObjectByVpnSiteIpAddress, ByVirtualWanResourceIdByVpnSiteIpAddress +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceModel +The device model of the remote vpn device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceVendor +The device vendor of the remote vpn device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddress +The IPAddress for this VpnSite. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanNameByVpnSiteIpAddress, ByVirtualWanObjectByVpnSiteIpAddress, ByVirtualWanResourceIdByVpnSiteIpAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsSecuritySite +if vpn site is a security site. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkSpeedInMbps +The device model of the remote vpn device. + +```yaml +Type: System.UInt32 +Parameter Sets: ByVirtualWanNameByVpnSiteIpAddress, ByVirtualWanObjectByVpnSiteIpAddress, ByVirtualWanResourceIdByVpnSiteIpAddress +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, VpnSiteName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -O365Policy +The office 365 traffic breakout policy for this VpnSite. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSO365PolicyProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualWan +The VirtualWan this VpnSite needs to be connected to. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan +Parameter Sets: ByVirtualWanObjectByVpnSiteIpAddress, ByVirtualWanObjectByVpnSiteLinkObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualWanId +The ResourceId VirtualWan this VpnSite needs to be connected to. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanResourceIdByVpnSiteIpAddress, ByVirtualWanResourceIdByVpnSiteLinkObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualWanName +The name of the VirtualWan this VpnSite needs to be connected to. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanNameByVpnSiteIpAddress, ByVirtualWanNameByVpnSiteLinkObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualWanResourceGroupName +The resource group name of the VirtualWan this VpnSite needs to be connected to. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanNameByVpnSiteIpAddress, ByVirtualWanNameByVpnSiteLinkObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnSiteLink +The list of VpnSiteLinks that this VpnSite have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnSiteLink[] +Parameter Sets: ByVirtualWanNameByVpnSiteLinkObject, ByVirtualWanObjectByVpnSiteLinkObject, ByVirtualWanResourceIdByVpnSiteLinkObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnSite +## NOTES + +## RELATED LINKS + +[Get-AzVpnSite](./Get-AzVpnSite.md) + +[Remove-AzVpnSite](./Remove-AzVpnSite.md) + +[Update-AzVpnSite](./Update-AzVpnSite.md) diff --git a/azps-10.1.0/Az.Network/New-AzVpnSiteLink.md b/azps-10.1.0/Az.Network/New-AzVpnSiteLink.md new file mode 100644 index 0000000000..2d87076742 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnSiteLink.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpnsitelink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnSiteLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnSiteLink.md +--- + +# New-AzVpnSiteLink + +## SYNOPSIS +Creates an Azure VpnSiteLink object. + +## SYNTAX + +### ByVpnSiteLinkIpAddress +``` +New-AzVpnSiteLink -Name <String> -IPAddress <String> [-LinkProviderName <String>] [-LinkSpeedInMbps <UInt32>] + [-BGPAsn <UInt32>] [-BGPPeeringAddress <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByVpnSiteLinkFqdn +``` +New-AzVpnSiteLink -Name <String> -Fqdn <String> [-LinkProviderName <String>] [-LinkSpeedInMbps <UInt32>] + [-BGPAsn <UInt32>] [-BGPPeeringAddress <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates an Azure VpnSiteLink object. + +## EXAMPLES + +### Example 1 +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" + +$vpnSiteLink = New-AzVpnSiteLink -Name "testVpnSiteLink1" -IpAddress "15.25.35.45" -LinkProviderName "SomeTelecomProvider" -LinkSpeedInMbps "10" +$vpnSite = New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -VpnSiteLink @($vpnSiteLink) +``` + +The above will create a resource group, Virtual WAN and a VpnSite with 1 VpnSiteLinks in West US in "testRG" resource group in Azure. + +### Example 2 + +Creates an Azure VpnSiteLink object. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzVpnSiteLink -BGPAsn <UInt32> -BGPPeeringAddress <String> -IPAddress '15.25.35.45' -LinkProviderName 'SomeTelecomProvider' -LinkSpeedInMbps '10' -Name 'testVpnSiteLink1' +``` + +## PARAMETERS + +### -BGPAsn +The BGP ASN for this VpnSiteLink. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BGPPeeringAddress +The BGP Peering Address for this VpnSiteLink. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fqdn +The Next Hop Fqdn. + +```yaml +Type: System.String +Parameter Sets: ByVpnSiteLinkFqdn +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddress +The Next Hop IpAddress. + +```yaml +Type: System.String +Parameter Sets: ByVpnSiteLinkIpAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkProviderName +Link Provider Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkSpeedInMbps +Link Speed In Mbps. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnSiteLink + +## NOTES + +## RELATED LINKS + +[New-AzVpnSite](./New-AzVpnSite.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/New-AzVpnSiteLinkConnection.md b/azps-10.1.0/Az.Network/New-AzVpnSiteLinkConnection.md new file mode 100644 index 0000000000..e281324620 --- /dev/null +++ b/azps-10.1.0/Az.Network/New-AzVpnSiteLinkConnection.md @@ -0,0 +1,318 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/new-azvpnsitelinkconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnSiteLinkConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/New-AzVpnSiteLinkConnection.md +--- + +# New-AzVpnSiteLinkConnection + +## SYNOPSIS +Creates an Azure VpnSiteLinkConnection object. + +## SYNTAX + +``` +New-AzVpnSiteLinkConnection -Name <String> -VpnSiteLink <PSVpnSiteLink> [-SharedKey <SecureString>] + [-ConnectionBandwidth <UInt32>] [-RoutingWeight <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] + [-VpnConnectionProtocolType <String>] [-EnableBgp] [-UseLocalAzureIpAddress] [-UsePolicyBasedTrafficSelectors] + [-IngressNatRule <PSResourceId[]>] [-EgressNatRule <PSResourceId[]>] + [-VpnGatewayCustomBgpAddress <PSGatewayCustomBgpIpConfiguration[]>] [-VpnLinkConnectionMode <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an Azure VpnSiteLinkConnection object. + +## EXAMPLES + +### Example 1 +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" + +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" + +$vpnSiteLink = New-AzVpnSiteLink -Name "testVpnSiteLink1" -IpAddress "15.25.35.45" -LinkProviderName "SomeTelecomProvider" -LinkSpeedInMbps "10" +$vpnSite = New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -VpnSiteLink @($vpnSiteLink) + + +$vpnSiteLinkConnection = New-AzVpnSiteLinkConnection -Name "testLinkConnection1" -VpnSiteLink $vpnSite.VpnSiteLinks[0] -ConnectionBandwidth 100 + +New-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite -VpnSiteLinkConnection @($vpnSiteLinkConnection) +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite with 1 VpnSiteLinks in West US in "testRG" resource group in Azure. +A VPN gateway will be created thereafter in the Virtual Hub. +Once the gateway has been created, it is connected to the VpnSite using the New-AzVpnConnection command with 1 VpnSiteLinkConnections to the VpnSiteLink of the VpnSite. + +### Example 2 VpnGatewayCustomBgpAddress +```powershell +$vpnSite = Get-AzVpnSite -ResourceGroupName PS_testing -Name testsite +$vpnGateway = Get-AzVpnGateway -ResourceGroupName PS_testing -Name 196ddf92afae40e4b20edc32dfb48a63-eastus-gw + +$address = New-AzGatewayCustomBgpIpConfigurationObject -IpConfigurationId "Instance0" -CustomBgpIpAddress "169.254.22.1" +$address2 = New-AzGatewayCustomBgpIpConfigurationObject -IpConfigurationId "Instance1" -CustomBgpIpAddress "169.254.22.3" + +$vpnSiteLinkConnection = New-AzVpnSiteLinkConnection -Name "testLinkConnection1" -VpnSiteLink $vpnSite.VpnSiteLinks[0] -ConnectionBandwidth 100 -VpnGatewayCustomBgpAddress $address,$address2 -EnableBgp + +New-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite -VpnSiteLinkConnection @($vpnSiteLinkConnection) +``` + +The above will create AzGatewayCustomBgpIpConfigurationObject 1 VpnSiteLinks with VpnConnection in "PS_testing" resource group in Azure. +Once connection is created, it is connected to the VpnSite using the New-AzVpnConnection command with 1 VpnSiteLinkConnections to the VpnSiteLink of the VpnSite. +This connection will use provided GatewayCustomBgpIpAddress for Bgp connection at VpnGateway side. + +## PARAMETERS + +### -ConnectionBandwidth +The bandwidth that needs to be handled by this link connection in mbps. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EgressNatRule +The list of egress NAT rules that are associated with this link Connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSResourceId[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBgp +Enable BGP for this link connection + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngressNatRule +The list of ingress NAT rules that are associated with this link Connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSResourceId[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpSecPolicy +IpSec Policy to be considered for this link connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +VpnSiteLinkConnection Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingWeight +Routing Weight + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedKey +The shared key required to set this link connection up. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseLocalAzureIpAddress +Use local azure ip address as source ip for this link connection. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePolicyBasedTrafficSelectors +Use policy based traffic selectors for this link connection. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnConnectionProtocolType +Gateway connection protocol:IKEv1/IKEv2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IKEv1, IKEv2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnGatewayCustomBgpAddress +The GatewayCustomBgpIpAddress of Vpngateway used in this link connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSGatewayCustomBgpIpConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnLinkConnectionMode +The connection mode for this link connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnSiteLink +The vpn site link object to connect to. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnSiteLink +Parameter Sets: (All) +Aliases: InputObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnSiteLink + +### Microsoft.Azure.Commands.Network.Models.PSGatewayCustomBgpIpConfiguration[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnSiteLinkConnection + +## NOTES + +## RELATED LINKS + +[New-AzVpnConnection](./New-AzVpnConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGateway.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGateway.md new file mode 100644 index 0000000000..35cc2ef7e6 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGateway.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: E9390015-FD5C-4015-BA81-3445ADF8F8BF +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGateway.md +--- + +# Remove-AzApplicationGateway + +## SYNOPSIS +Removes an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGateway -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGateway** cmdlet removes an application gateway. + +## EXAMPLES + +### Example 1: Remove a specified application gateway +```powershell +Remove-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +``` + +This command removes the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that the cmdlet forces the deletion of the application gateway regardless of whether resources are assigned to it. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the application gateway to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group name that the application gateway belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Set-AzApplicationGateway](./Set-AzApplicationGateway.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayAuthenticationCertificate.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayAuthenticationCertificate.md new file mode 100644 index 0000000000..cddafbcca4 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayAuthenticationCertificate.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 29BB24C4-1EC9-47DE-A5B8-5EEA4525AE3A +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayauthenticationcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayAuthenticationCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayAuthenticationCertificate.md +--- + +# Remove-AzApplicationGatewayAuthenticationCertificate + +## SYNOPSIS +Removes an authentication certificate from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayAuthenticationCertificate -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayAuthenticationCertificate** cmdlet removes an authentication certificate from an Azure application gateway. + +## EXAMPLES + +### Example 1: Remove an authentication certificate from an application gateway +```powershell +$appgw = Get-AzApplicationGateway -ResourceGroupName "rg" -Name "appGwName" +$appgw = Remove-AzApplicationGatewayAuthenticationCertificate -ApplicationGateway $appgw -Name "cert01" +$appgw = Set-AzApplicationGateway -ApplicationGateway $appgw +``` + +The first command gets the application gateway named appGwName and stores the result in the $appgw variable. +The second command removes the authentication certificate named cert01 from the application gateway. +The third command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the name of application gateway from which this cmdlet removes an authentication certificate. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the authentication certificate that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Add-AzApplicationGatewayAuthenticationCertificate](./Add-AzApplicationGatewayAuthenticationCertificate.md) + +[Get-AzApplicationGatewayAuthenticationCertificate](./Get-AzApplicationGatewayAuthenticationCertificate.md) + +[New-AzApplicationGatewayAuthenticationCertificate](./New-AzApplicationGatewayAuthenticationCertificate.md) + +[Set-AzApplicationGatewayAuthenticationCertificate](./Set-AzApplicationGatewayAuthenticationCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayAutoscaleConfiguration.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayAutoscaleConfiguration.md new file mode 100644 index 0000000000..3db4007879 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayAutoscaleConfiguration.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayautoscaleconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayAutoscaleConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayAutoscaleConfiguration.md +--- + +# Remove-AzApplicationGatewayAutoscaleConfiguration + +## SYNOPSIS +Removes Autoscale Configuration from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayAutoscaleConfiguration -ApplicationGateway <PSApplicationGateway> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayAutoscaleConfiguration** cmdlet removes Autoscale Configuration from an existing Application Gateway. + +## EXAMPLES + +### Example 1 +```powershell +$gw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $resgpName +$gw = Remove-AzApplicationGatewayAutoscaleConfiguration -ApplicationGateway $gw +$gw = Set-AzApplicationGateway -ApplicationGateway $gw +``` + +The first command gets the application gateway and stores it in $gw variable. +The second command removes the autoscale configuration from the application gateway. +The third command updates the application gateway on Azure. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayAutoscaleConfiguration](./Get-AzApplicationGatewayAutoscaleConfiguration.md) + +[New-AzApplicationGatewayAutoscaleConfiguration](./New-AzApplicationGatewayAutoscaleConfiguration.md) + +[Set-AzApplicationGatewayAutoscaleConfiguration](./Set-AzApplicationGatewayAutoscaleConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayBackendAddressPool.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayBackendAddressPool.md new file mode 100644 index 0000000000..b8eb99d84a --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayBackendAddressPool.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: F34C5D18-C505-4815-9DDB-C563E205515C +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewaybackendaddresspool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayBackendAddressPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayBackendAddressPool.md +--- + +# Remove-AzApplicationGatewayBackendAddressPool + +## SYNOPSIS +Removes a back-end address pool from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayBackendAddressPool -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayBackendAddressPool** cmdlet removes a back-end address pool from an Azure application gateway. + +## EXAMPLES + +### Example 1: Remove a back-end address pool from an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "BackEndPool02" +Set-AzApplicationGateway -ApplicationGateway $AppGw +``` + +The first command gets the application gateway named ApplicationGateway01 belonging to the resource group named ResourceGroup01 and saves it in the $AppGw variable. +The second command removes the back-end address pool named BackEndPool02 from the application gateway. Finally, the third command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway from which this cmdlet removes a back-end address pool. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the back-end address pool that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayBackendAddressPool](./Add-AzApplicationGatewayBackendAddressPool.md) + +[Get-AzApplicationGatewayBackendAddressPool](./Get-AzApplicationGatewayBackendAddressPool.md) + +[New-AzApplicationGatewayBackendAddressPool](./New-AzApplicationGatewayBackendAddressPool.md) + +[Set-AzApplicationGatewayBackendAddressPool](./Set-AzApplicationGatewayBackendAddressPool.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayBackendHttpSetting.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayBackendHttpSetting.md new file mode 100644 index 0000000000..1e568020ac --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayBackendHttpSetting.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewaybackendhttpsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayBackendHttpSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayBackendHttpSetting.md +--- + +# Remove-AzApplicationGatewayBackendHttpSetting + +## SYNOPSIS +Removes back-end HTTP settings from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayBackendHttpSetting -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzApplicationGatewayBackendHttpSetting cmdlet removes back-end Hypertext Transfer Protocol (HTTP) settings from an Azure application gateway. + +## EXAMPLES + +### Example 1: Remove back-end HTTP settings from an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewayBackendHttpSetting -ApplicationGateway $AppGw -Name "BackEndSetting02" +Set-AzApplicationGateway -ApplicationGateway $AppGW +``` + +The first command gets an application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command removes the back-end HTTP setting named BackEndSetting02 from the application gateway stored in $AppGw. Finally, the third command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway from which this cmdlet removes back-end HTTP settings. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the back-end HTTP settings that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayBackendHttpSetting](./Add-AzApplicationGatewayBackendHttpSetting.md) + +[New-AzApplicationGatewayBackendHttpSetting](./New-AzApplicationGatewayBackendHttpSetting.md) + +[Get-AzApplicationGatewayBackendHttpSetting](./Get-AzApplicationGatewayBackendHttpSetting.md) + +[Set-AzApplicationGatewayBackendHttpSetting](./Set-AzApplicationGatewayBackendHttpSetting.md) + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayBackendSetting.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayBackendSetting.md new file mode 100644 index 0000000000..6f45f9cc83 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayBackendSetting.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewaybackendsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayBackendSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayBackendSetting.md +--- + +# Remove-AzApplicationGatewayBackendSetting + +## SYNOPSIS +Removes back-end TCP\TLS settings from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayBackendSetting -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzApplicationGatewayBackendSetting cmdlet removes back-end TCP\TLS settings from an Azure application gateway. + +## EXAMPLES + +### Example 1: Remove back-end TCP\TLS settings from an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewayBackendSetting -ApplicationGateway $AppGw -Name "BackEndSetting02" +Set-AzApplicationGateway -ApplicationGateway $AppGW +``` + +The first command gets an application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command removes the back-end TCP\TLS setting named BackEndSetting02 from the application gateway stored in $AppGw. Finally, the third command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the backend settings + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayBackendSetting](./Add-AzApplicationGatewayBackendSetting.md) + +[New-AzApplicationGatewayBackendSetting](./New-AzApplicationGatewayBackendSetting.md) + +[Get-AzApplicationGatewayBackendSetting](./Get-AzApplicationGatewayBackendSetting.md) + +[Set-AzApplicationGatewayBackendSetting](./Set-AzApplicationGatewayBackendSetting.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayClientAuthConfiguration.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayClientAuthConfiguration.md new file mode 100644 index 0000000000..8add1e9a61 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayClientAuthConfiguration.md @@ -0,0 +1,88 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayclientauthconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayClientAuthConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayClientAuthConfiguration.md +--- + +# Remove-AzApplicationGatewayClientAuthConfiguration + +## SYNOPSIS +Removes the client authentication configuration of a SSL profile object. + +## SYNTAX + +``` +Remove-AzApplicationGatewayClientAuthConfiguration -SslProfile <PSApplicationGatewaySslProfile> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayClientAuthConfiguration** cmdlet removes the client authentication configuration of a SSL profile object. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$profile = Get-AzApplicationGatewaySslProfile -Name "Profile01" -ApplicationGateway $AppGw +Remove-AzApplicationGatewayClientAuthConfiguration -SslProfile $profile +Set-AzApplicationGateway -ApplicationGateway $AppGW +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. The second command gets the SSL profile named Profile01 for $AppGw and stores it in the $profile variable. The next command removes the client authentication configuration of the ssl profile stored in $profile. The last command updates the application gateway. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfile +The ssl profile + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayClientAuthConfiguration](./New-AzApplicationGatewayClientAuthConfiguration.md) + +[Get-AzApplicationGatewayClientAuthConfiguration](./Get-AzApplicationGatewayClientAuthConfiguration.md) + +[Set-AzApplicationGatewayClientAuthConfiguration](./Set-AzApplicationGatewayClientAuthConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayConnectionDraining.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayConnectionDraining.md new file mode 100644 index 0000000000..7d752dcdd6 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayConnectionDraining.md @@ -0,0 +1,95 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayconnectiondraining +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayConnectionDraining.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayConnectionDraining.md +--- + +# Remove-AzApplicationGatewayConnectionDraining + +## SYNOPSIS +Removes the connection draining configuration of a back-end HTTP settings object. + +## SYNTAX + +``` +Remove-AzApplicationGatewayConnectionDraining -BackendHttpSettings <PSApplicationGatewayBackendHttpSettings> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayConnectionDraining** cmdlet removes the connection draining configuration of a back-end HTTP settings object. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Settings = Get-AzApplicationGatewayBackendHttpSetting -Name "Settings01" -ApplicationGateway $AppGw +Remove-AzApplicationGatewayConnectionDraining -BackendHttpSettings $Settings +Set-AzApplicationGateway -ApplicationGateway $AppGW +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command gets the back-end HTTP settings named Settings01 for $AppGw and stores the settings in the $Settings variable. +The third command removes the connection draining configuration of the back-end HTTP settings stored in $Settings. And, the last command updates the application gateway. + +## PARAMETERS + +### -BackendHttpSettings +The backend http settings + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGateway](./Get-AzApplicationGateway.md) + +[Get-AzApplicationGatewayBackendHttpSetting](./Get-AzApplicationGatewayBackendHttpSetting.md) + +[Get-AzApplicationGatewayConnectionDraining](./Get-AzApplicationGatewayConnectionDraining.md) + +[New-AzApplicationGatewayConnectionDraining](./New-AzApplicationGatewayConnectionDraining.md) + +[Set-AzApplicationGatewayConnectionDraining](./Set-AzApplicationGatewayConnectionDraining.md) + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayCustomError.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayCustomError.md new file mode 100644 index 0000000000..905647ba67 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayCustomError.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewaycustomerror +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayCustomError.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayCustomError.md +--- + +# Remove-AzApplicationGatewayCustomError + +## SYNOPSIS +Removes a custom error from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayCustomError -StatusCode <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayCustomError** cmdlet removes a custom error from an application gateway. + +## EXAMPLES + +### Example 1: Removes custom error from an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewayCustomError -ApplicationGateway $AppGw -StatusCode HttpStatus502 +Set-AzApplicationGateway -ApplicationGateway $AppGW +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command removes the custom error for HTTP Status Code 502 from the application gateway and returns the updated gateway. +The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The Application Gateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusCode +Status code of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayCustomError](./Add-AzApplicationGatewayCustomError.md) + +[Get-AzApplicationGatewayCustomError](./Get-AzApplicationGatewayCustomError.md) + +[New-AzApplicationGatewayCustomError](./New-AzApplicationGatewayCustomError.md) + +[Set-AzApplicationGatewayCustomError](./Set-AzApplicationGatewayCustomError.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayFirewallPolicy.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayFirewallPolicy.md new file mode 100644 index 0000000000..de4b38e4ef --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayFirewallPolicy.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayfirewallpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayFirewallPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayFirewallPolicy.md +--- + +# Remove-AzApplicationGatewayFirewallPolicy + +## SYNOPSIS +Removes an application gateway firewall policy. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzApplicationGatewayFirewallPolicy -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Remove-AzApplicationGatewayFirewallPolicy -InputObject <PSApplicationGatewayWebApplicationFirewallPolicy> + [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzApplicationGatewayFirewallPolicy -ResourceId <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayFirewallPolicy** cmdlet removes an application gateway firewall policy. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzApplicationGatewayFirewallPolicy -Name "ApplicationGatewayFirewallPolicy01" -ResourceGroupName "ResourceGroup01" +``` + +This command removes the application gateway firewall policy named ApplicationGatewayFirewallPolicy01 in the resource group named ResourceGroup01. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The firewall policy object + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallPolicy +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayFrontendIPConfig.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayFrontendIPConfig.md new file mode 100644 index 0000000000..580167e763 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayFrontendIPConfig.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 289B761C-1A1D-46D2-8755-B6B6A4758EFC +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayfrontendipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayFrontendIPConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayFrontendIPConfig.md +--- + +# Remove-AzApplicationGatewayFrontendIPConfig + +## SYNOPSIS +Removes a front-end IP configuration from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayFrontendIPConfig -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayFrontendIPConfig** cmdlet removes frontend IP from an Azure application gateway. + +## EXAMPLES + +### Example 1: Remove a front-end IP configuration +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontEndIP02" +Set-AzApplicationGateway -ApplicationGateway $AppGW +``` + +The first command gets an application gateway named ApplicationGateway01 and stores it in the $AppGw variable. +The second command removes the front-end IP configuration named FrontEndIP02 from the application gateway stored in $AppGw. +The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies an application gateway from which to remove a front-end IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a front-end IP configuration to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayFrontendIPConfig](./Add-AzApplicationGatewayFrontendIPConfig.md) + +[Get-AzApplicationGatewayFrontendIPConfig](./Get-AzApplicationGatewayFrontendIPConfig.md) + +[New-AzApplicationGatewayFrontendIPConfig](./New-AzApplicationGatewayFrontendIPConfig.md) + +[Set-AzApplicationGatewayFrontendIPConfig](./Set-AzApplicationGatewayFrontendIPConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayFrontendPort.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayFrontendPort.md new file mode 100644 index 0000000000..60459b897c --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayFrontendPort.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: A698954A-994E-45AD-BA36-1E03196CFCB0 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayfrontendport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayFrontendPort.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayFrontendPort.md +--- + +# Remove-AzApplicationGatewayFrontendPort + +## SYNOPSIS +Removes a front-end port from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayFrontendPort -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayFrontendPort** cmdlet removes a front-end port from an Azure application gateway. + +## EXAMPLES + +### Example: Remove a front-end port from an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewayFrontendPort -ApplicationGateway $AppGw -Name "FrontEndPort02" +Set-AzApplicationGateway -ApplicationGateway $AppGW +``` + +The first command gets an application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores the gateway in $AppGw variable. +The second command removes the port named FrontEndPort02 from the application gateway. +The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway from which to remove a front-end port. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies name of the frontend port to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayFrontendPort](./Add-AzApplicationGatewayFrontendPort.md) + +[Get-AzApplicationGatewayFrontendPort](./Get-AzApplicationGatewayFrontendPort.md) + +[New-AzApplicationGatewayFrontendPort](./New-AzApplicationGatewayFrontendPort.md) + +[Set-AzApplicationGatewayFrontendPort](./Set-AzApplicationGatewayFrontendPort.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayHttpListener.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayHttpListener.md new file mode 100644 index 0000000000..63f37fbce0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayHttpListener.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 6C90AF6C-3193-4D75-A78F-3EC315C6D7DF +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayhttplistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayHttpListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayHttpListener.md +--- + +# Remove-AzApplicationGatewayHttpListener + +## SYNOPSIS +Removes an HTTP listener from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayHttpListener -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayHttpListener** cmdlet removes an HTTP listener from an Azure application gateway. + +## EXAMPLES + +### Example 1: Remove an application gateway HTTP listener +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "Listener02" +Set-AzApplicationGateway -ApplicationGateway $AppGW +``` + +The first command gets an application gateway and stores it in the $AppGw variable. +The second command removes the HTTP listener named Listener02 from the application gateway stored in $AppGw. +The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway from which to remove an HTTP listener. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the HTTP listener that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayHttpListener](./Add-AzApplicationGatewayHttpListener.md) + +[Get-AzApplicationGatewayHttpListener](./Get-AzApplicationGatewayHttpListener.md) + +[New-AzApplicationGatewayHttpListener](./New-AzApplicationGatewayHttpListener.md) + +[Set-AzApplicationGatewayHttpListener](./Set-AzApplicationGatewayHttpListener.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayHttpListenerCustomError.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayHttpListenerCustomError.md new file mode 100644 index 0000000000..1653a84b79 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayHttpListenerCustomError.md @@ -0,0 +1,101 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayhttplistenercustomerror +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayHttpListenerCustomError.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayHttpListenerCustomError.md +--- + +# Remove-AzApplicationGatewayHttpListenerCustomError + +## SYNOPSIS +Removes a custom error from a http listener of an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayHttpListenerCustomError -StatusCode <String> + -HttpListener <PSApplicationGatewayHttpListener> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayHttpListenerCustomError** cmdlet removes a custom error from a http listener of an application gateway. + +## EXAMPLES + +### Example 1: Removes custom error from a http listener +```powershell +Remove-AzApplicationGatewayHttpListenerCustomError -HttpListener $listener01 -StatusCode HttpStatus502 +``` + +This command removes the custom error of http status code 502 from the http listener $listener01, and return the updated listener. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpListener +The Application Gateway Http Listener + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StatusCode +Status code of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayHttpListenerCustomError](./Add-AzApplicationGatewayHttpListenerCustomError.md) + +[Get-AzApplicationGatewayHttpListenerCustomError](./Get-AzApplicationGatewayHttpListenerCustomError.md) + +[Set-AzApplicationGatewayHttpListenerCustomError](./Set-AzApplicationGatewayHttpListenerCustomError.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayIPConfiguration.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayIPConfiguration.md new file mode 100644 index 0000000000..e32550e231 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayIPConfiguration.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 6943BB5C-D709-4A80-AF5E-DC9501C20680 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayipconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayIPConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayIPConfiguration.md +--- + +# Remove-AzApplicationGatewayIPConfiguration + +## SYNOPSIS +Removes an IP configuration from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayIPConfiguration -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayIPConfiguration** cmdlet removes an IP configuration from an Azure application gateway. + +## EXAMPLES + +### Example 1: Remove an IP configuration from an Azure application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewayIPConfiguration -ApplicationGateway $AppGw -Name "Subnet02" +Set-AzApplicationGateway -ApplicationGateway $AppGW +``` + +The first command gets an application gateway and stores it in the $AppGw variable. +The second command removes the IP configuration named Subnet02 from the application gateway stored in $AppGw. +The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway from which to remove an IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the IP configuration to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayIPConfiguration](./Add-AzApplicationGatewayIPConfiguration.md) + +[Get-AzApplicationGatewayIPConfiguration](./Get-AzApplicationGatewayIPConfiguration.md) + +[New-AzApplicationGatewayIPConfiguration](./New-AzApplicationGatewayIPConfiguration.md) + +[Set-AzApplicationGatewayIPConfiguration](./Set-AzApplicationGatewayIPConfiguration.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayIdentity.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayIdentity.md new file mode 100644 index 0000000000..4805c7eb85 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayIdentity.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayidentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayIdentity.md +--- + +# Remove-AzApplicationGatewayIdentity + +## SYNOPSIS +Removes a identity from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayIdentity -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +**Remove-AzApplicationGatewayIdentity** cmdlet removes identity from an application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$appgw = Remove-AzApplicationGatewayIdentity -ApplicationGateway $appgw +$updatedgateway = Set-AzApplicationGateway -ApplicationGateway $appgw +``` + +In this example, we remove identity from an existing application gateway. +Note: If the gateway is referencing a keyvault secret, then it is also important to remove those ssl certificate references along this operation. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayListener.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayListener.md new file mode 100644 index 0000000000..3fed4230f4 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayListener.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewaylistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayListener.md +--- + +# Remove-AzApplicationGatewayListener + +## SYNOPSIS +Removes a TCP\TLS listener from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayListener -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayListener** cmdlet removes a TCP\TLS listener from an Azure application gateway. + +## EXAMPLES + +### Example 1: Remove an application gateway TCP\TLS listener +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewayListener -ApplicationGateway $AppGw -Name "Listener02" +Set-AzApplicationGateway -ApplicationGateway $AppGW +``` + +The first command gets an application gateway and stores it in the $AppGw variable. +The second command removes the TCP\TLS listener named Listener02 from the application gateway stored in $AppGw. +The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the application gateway listener + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayListener](./Add-AzApplicationGatewayListener.md) + +[Get-AzApplicationGatewayListener](./Get-AzApplicationGatewayListener.md) + +[New-AzApplicationGatewayListener](./New-AzApplicationGatewayListener.md) + +[Set-AzApplicationGatewayListener](./Set-AzApplicationGatewayListener.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayPrivateLinkConfiguration.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayPrivateLinkConfiguration.md new file mode 100644 index 0000000000..036c39c6c0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayPrivateLinkConfiguration.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayprivatelinkconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayPrivateLinkConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayPrivateLinkConfiguration.md +--- + +# Remove-AzApplicationGatewayPrivateLinkConfiguration + +## SYNOPSIS +Removes a privateLink configuration from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayPrivateLinkConfiguration -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayPrivateLinkConfiguration** cmdlet removes an privateLink configuration from an Azure application gateway. + +## EXAMPLES + +### Example 1: Remove an application gateway PrivateLink Configuration +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewayPrivateLinkConfiguration -ApplicationGateway $AppGw -Name "privateLinkConfig01" +Set-AzApplicationGateway -ApplicationGateway $AppGW +``` + +The first command gets an application gateway and stores it in the $AppGw variable. +The second command removes the privateLink configuration named privateLinkConfig01 from the application gateway stored in $AppGw. +The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the application gateway privateLink configuration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayPrivateLinkConfiguration](./New-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Add-AzApplicationGatewayPrivateLinkConfiguration](./Add-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Get-AzApplicationGatewayPrivateLinkConfiguration](./Get-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Set-AzApplicationGatewayPrivateLinkConfiguration](./Set-AzApplicationGatewayPrivateLinkConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayProbeConfig.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayProbeConfig.md new file mode 100644 index 0000000000..3ea56f29a8 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayProbeConfig.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayprobeconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayProbeConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayProbeConfig.md +--- + +# Remove-AzApplicationGatewayProbeConfig + +## SYNOPSIS +Removes a health probe from an existing application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayProbeConfig -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzApplicationGatewayProbeConfig cmdlet removes a heath probe from an existing application gateway. + +## EXAMPLES + +### Example 1: Remove a health probe from an existing application gateway +```powershell +$Gateway = Remove-AzApplicationGatewayProbeConfig -ApplicationGateway Gateway -Name "Probe04" +``` + +This command removes the health probe named Probe04 from the application gateway named Gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway to which this cmdlet removes a probe. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the probe for which this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Remove a probe from an existing application gateway](https://azure.microsoft.com/en-us/documentation/articles/application-gateway-create-probe-ps/#remove-a-probe-from-an-existing-application-gateway) + +[Add-AzApplicationGatewayProbeConfig](./Add-AzApplicationGatewayProbeConfig.md) + +[Get-AzApplicationGatewayProbeConfig](./Get-AzApplicationGatewayProbeConfig.md) + +[New-AzApplicationGatewayProbeConfig](./New-AzApplicationGatewayProbeConfig.md) + +[Set-AzApplicationGatewayProbeConfig](./Set-AzApplicationGatewayProbeConfig.md) + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayRedirectConfiguration.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayRedirectConfiguration.md new file mode 100644 index 0000000000..5bc03ef0f2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayRedirectConfiguration.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayredirectconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayRedirectConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayRedirectConfiguration.md +--- + +# Remove-AzApplicationGatewayRedirectConfiguration + +## SYNOPSIS +Removes a redirect configuration from an existing Application Gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayRedirectConfiguration -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayRedirectConfiguration** cmdlet removes a redirect configuration from an existing Application Gateway. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Remove-AzApplicationGatewayRedirectConfiguration -ApplicationGateway $AppGw -Name "Redirect01" +Set-AzApplicationGateway -ApplicationGateway $AppGw +``` + +The first command gets an application gateway and stores it in the $AppGw variable. +The second command removes the redirect configuration named Redirect01 from the application gateway stored in $AppGw. +The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the redirect configuration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRedirectConfiguration](./Add-AzApplicationGatewayRedirectConfiguration.md) + +[Get-AzApplicationGatewayRedirectConfiguration](./Get-AzApplicationGatewayRedirectConfiguration.md) + +[New-AzApplicationGatewayRedirectConfiguration](./New-AzApplicationGatewayRedirectConfiguration.md) + +[Set-AzApplicationGatewayRedirectConfiguration](./Set-AzApplicationGatewayRedirectConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayRequestRoutingRule.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayRequestRoutingRule.md new file mode 100644 index 0000000000..76fde46078 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayRequestRoutingRule.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: CC033DA8-FACC-44E2-82F9-E30FADBF8926 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayrequestroutingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayRequestRoutingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayRequestRoutingRule.md +--- + +# Remove-AzApplicationGatewayRequestRoutingRule + +## SYNOPSIS +Removes a request routing rule from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayRequestRoutingRule -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayRequestRoutingRule** cmdlet removes a request routing rule from an Azure application gateway. + +## EXAMPLES + +### Example 1: Remove a request routing rule from an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewayRequestRoutingRule -ApplicationGateway $AppGw -Name "Rule02" +Set-AzApplicationGateway -ApplicationGateway $AppGw +``` + +The first command gets an application gateway and stores it in the $AppGw variable. +The second command removes the request routing rule named Rule02 from the application gateway stored in $AppGw. +The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway from which to remove a request routing rule. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the request routing rule for which this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRequestRoutingRule](./Add-AzApplicationGatewayRequestRoutingRule.md) + +[Get-AzApplicationGatewayRequestRoutingRule](./Get-AzApplicationGatewayRequestRoutingRule.md) + +[New-AzApplicationGatewayRequestRoutingRule](./New-AzApplicationGatewayRequestRoutingRule.md) + +[Set-AzApplicationGatewayRequestRoutingRule](./Set-AzApplicationGatewayRequestRoutingRule.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayRewriteRuleSet.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayRewriteRuleSet.md new file mode 100644 index 0000000000..9d1e4b46a2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayRewriteRuleSet.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayrewriteruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayRewriteRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayRewriteRuleSet.md +--- + +# Remove-AzApplicationGatewayRewriteRuleSet + +## SYNOPSIS +Removes a rewrite rule set from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayRewriteRuleSet -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayRewriteRuleSet** cmdlet removes a rewrite rule set from an Azure application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewayRewriteRuleSet -ApplicationGateway $AppGw -Name "RuleSet02" +Set-AzApplicationGateway -ApplicationGateway $AppGw +``` + +The first command gets an application gateway and stores it in the $AppGw variable. +The second command removes the rewrite rule set named RuleSet02 from the application gateway stored in $AppGw. +The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the application gateway RewriteRuleSet + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRewriteRuleSet](./Add-AzApplicationGatewayRewriteRuleSet.md) + +[Get-AzApplicationGatewayRewriteRuleSet](./Get-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRuleSet](./New-AzApplicationGatewayRewriteRuleSet.md) + +[Set-AzApplicationGatewayRewriteRuleSet](./Set-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRule](./New-AzApplicationGatewayRewriteRule.md) + +[New-AzApplicationGatewayRewriteRuleActionSet](./New-AzApplicationGatewayRewriteRuleActionSet.md) + +[New-AzApplicationGatewayRewriteRuleHeaderConfiguration](./New-AzApplicationGatewayRewriteRuleHeaderConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayRoutingRule.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayRoutingRule.md new file mode 100644 index 0000000000..4ef25d8836 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayRoutingRule.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayroutingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayRoutingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayRoutingRule.md +--- + +# Remove-AzApplicationGatewayRoutingRule + +## SYNOPSIS +Removes a routing rule from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayRoutingRule -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayRoutingRule** cmdlet removes a routing rule from an Azure application gateway. + +## EXAMPLES + +### Example 1: Remove a routing rule from an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewayRoutingRule -ApplicationGateway $AppGw -Name "Rule02" +Set-AzApplicationGateway -ApplicationGateway $AppGw +``` + +The first command gets an application gateway and stores it in the $AppGw variable. +The second command removes the routing rule named Rule02 from the application gateway stored in $AppGw. +The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the routing rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRoutingRule](./Add-AzApplicationGatewayRoutingRule.md) + +[Get-AzApplicationGatewayRoutingRule](./Get-AzApplicationGatewayRoutingRule.md) + +[New-AzApplicationGatewayRoutingRule](./New-AzApplicationGatewayRoutingRule.md) + +[Set-AzApplicationGatewayRoutingRule](./Set-AzApplicationGatewayRoutingRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewaySslCertificate.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewaySslCertificate.md new file mode 100644 index 0000000000..0048bc87ba --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewaySslCertificate.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 5D788B84-0179-4A35-AC35-27C6F5FECB39 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewaysslcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewaySslCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewaySslCertificate.md +--- + +# Remove-AzApplicationGatewaySslCertificate + +## SYNOPSIS +Removes an SSL certificate from an Azure application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewaySslCertificate -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewaySslCertificate** cmdlet removes a Secure Sockets Layer (SSL) certificate from an Azure application gateway. + +## EXAMPLES + +### Example 1: Remove an SSL certificate from an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewaySslCertificate -ApplicationGateway $AppGw -Name "Cert02" +Set-AzApplicationGateway -ApplicationGateway $AppGw +``` + +The first command gets the application gateway named ApplicationGateway01 and stores the result in the variable named $AppGw. +The second command removes the SSL certificate named Cert02 from the application gateway stored in the $AppGw variable. +The last command "Set-AzApplicationGateway" updates the application gateway configuration changes to the $AppGw variable that holds the current configuration of Application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway from which this cmdlet removes an SSL certificate. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an SSL certificate that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewaySslCertificate](./Add-AzApplicationGatewaySslCertificate.md) + +[Get-AzApplicationGatewaySslCertificate](./Get-AzApplicationGatewaySslCertificate.md) + +[New-AzApplicationGatewaySslCertificate](./New-AzApplicationGatewaySslCertificate.md) + +[Set-AzApplicationGatewaySslCertificate](./Set-AzApplicationGatewaySslCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewaySslPolicy.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewaySslPolicy.md new file mode 100644 index 0000000000..da0b611fc7 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewaySslPolicy.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: A308E4DD-49FA-4905-94A7-CEA3AAEC3959 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewaysslpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewaySslPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewaySslPolicy.md +--- + +# Remove-AzApplicationGatewaySslPolicy + +## SYNOPSIS +Removes an SSL policy from an Azure application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewaySslPolicy -ApplicationGateway <PSApplicationGateway> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzApplicationGatewaySslPolicy cmdlet removes SSL policy from an Azure application gateway. + +## EXAMPLES + +### Example 1: Remove an SSL policy from an application gateway +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGW = Remove-AzApplicationGatewaySslPolicy -ApplicationGateway $AppGW +Set-AzApplicationGateway -ApplicationGateway $AppGW +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGW variable. +The second command removes the SSL policy from the application gateway. +The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway from which this cmdlet removes SSL policy. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Set-AzApplicationGatewaySslPolicy](./Set-AzApplicationGatewaySslPolicy.md) + +[New-AzApplicationGatewaySslPolicy](./New-AzApplicationGatewaySslPolicy.md) + +[Get-AzApplicationGatewaySslPolicy](./Get-AzApplicationGatewaySslPolicy.md) + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewaySslProfile.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewaySslProfile.md new file mode 100644 index 0000000000..9f107cde88 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewaySslProfile.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewaysslprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewaySslProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewaySslProfile.md +--- + +# Remove-AzApplicationGatewaySslProfile + +## SYNOPSIS +Removes the ssl profile from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewaySslProfile -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewaySslProfile** cmdlet removes the ssl profile from an application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Remove-AzApplicationGatewaySslProfile -ApplicationGateway $AppGw -Name "SslProfile01" +Set-AzApplicationGateway -ApplicationGateway $AppGw +``` + +The first command gets an application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. The second command removes the ssl profile named SslProfile01 from the application gateway stored in $AppGw. +The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ssl profile + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewaySslProfile](./New-AzApplicationGatewaySslProfile.md) + +[Add-AzApplicationGatewaySslProfile](./Add-AzApplicationGatewaySslProfile.md) + +[Get-AzApplicationGatewaySslProfile](./Get-AzApplicationGatewaySslProfile.md) + +[Set-AzApplicationGatewaySslProfile](./Set-AzApplicationGatewaySslProfile.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewaySslProfilePolicy.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewaySslProfilePolicy.md new file mode 100644 index 0000000000..7efa53b692 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewaySslProfilePolicy.md @@ -0,0 +1,85 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewaysslprofilepolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewaySslProfilePolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewaySslProfilePolicy.md +--- + +# Remove-AzApplicationGatewaySslProfilePolicy + +## SYNOPSIS +Removes an SSL policy from an Azure application gateway SSL profile. + +## SYNTAX + +``` +Remove-AzApplicationGatewaySslProfilePolicy -SslProfile <PSApplicationGatewaySslProfile> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzApplicationGatewaySslProfilePolicy cmdlet removes an SSL policy from an Azure application gateway SSL profile. + +## EXAMPLES + +### Example 1 +```powershell +$AppGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$profile = Get-AzApplicationGatewaySslProfile -Name "Profile01" -ApplicationGateway $AppGw +$profile = Remove-AzApplicationGatewaySslProfilePolicy -SslProfile $profile +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. The second command gets the SSL profile named Profile01 for $AppGw and stores it in the $profile variable. The last command removes the ssl policy of the ssl profile stored in $profile. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfile +The applicationGateway SSL profile + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewaySslProfilePolicy](./Get-AzApplicationGatewaySslProfilePolicy.md) + +[Set-AzApplicationGatewaySslProfilePolicy](./Set-AzApplicationGatewaySslProfilePolicy.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayTrustedClientCertificate.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayTrustedClientCertificate.md new file mode 100644 index 0000000000..6db84a78e3 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayTrustedClientCertificate.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewaytrustedclientcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayTrustedClientCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayTrustedClientCertificate.md +--- + +# Remove-AzApplicationGatewayTrustedClientCertificate + +## SYNOPSIS +Removes the trusted client CA certificate chain object from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayTrustedClientCertificate -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayTrustedClientCertificate** cmdlet removes the trusted client CA certificate chain object from an application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$gw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $resgpName +$gw = Remove-AzApplicationGatewayTrustedClientCertificate -ApplicationGateway $gw -Name "TrustedClientCertificate01" +Set-AzApplicationGateway -ApplicationGateway $gw +``` + +The first command gets an application gateway and stores it in the $gw variable. The second command removes the trusted client CA certificate chain named "TrustedClientCertificate01" from the application gateway stored in $gw. The last command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the trusted client CA certificate chain + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayTrustedClientCertificate](./New-AzApplicationGatewayTrustedClientCertificate.md) + +[Add-AzApplicationGatewayTrustedClientCertificate](./Add-AzApplicationGatewayTrustedClientCertificate.md) + +[Get-AzApplicationGatewayTrustedClientCertificate](./Get-AzApplicationGatewayTrustedClientCertificate.md) + +[Set-AzApplicationGatewayTrustedClientCertificate](./Set-AzApplicationGatewayTrustedClientCertificate.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayTrustedRootCertificate.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayTrustedRootCertificate.md new file mode 100644 index 0000000000..5e2086d9f6 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayTrustedRootCertificate.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewaytrustedrootcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayTrustedRootCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayTrustedRootCertificate.md +--- + +# Remove-AzApplicationGatewayTrustedRootCertificate + +## SYNOPSIS +Removes a Trusted Root Certificate from an application gateway. + +## SYNTAX + +``` +Remove-AzApplicationGatewayTrustedRootCertificate -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayTrustedRootCertificate** cmdlet removes a Trusted Root Certificate from an existing Application Gateway. + +## EXAMPLES + +### Example 1 +```powershell +$gw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $resgpName +$gw = Remove-AzApplicationGatewayTrustedRootCertificate -ApplicationGateway $gw -Name "myRootCA" +$gw = Set-AzApplicationGateway -ApplicationGateway $gw +``` + +The first command gets an application gateway and stores it in the $gw variable. +The second command removes the trusted root certificate named myRootCA from the application gateway stored in $gw. +The third command updates the application gateway on Azure. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the TrustedRoot certificate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayTrustedRootCertificate](./Add-AzApplicationGatewayTrustedRootCertificate.md) + +[Get-AzApplicationGatewayTrustedRootCertificate](./Get-AzApplicationGatewayTrustedRootCertificate.md) + +[New-AzApplicationGatewayTrustedRootCertificate](./New-AzApplicationGatewayTrustedRootCertificate.md) + +[Set-AzApplicationGatewayTrustedRootCertificate](./Set-AzApplicationGatewayTrustedRootCertificate.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayUrlPathMapConfig.md b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayUrlPathMapConfig.md new file mode 100644 index 0000000000..dfc7a8eae5 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationGatewayUrlPathMapConfig.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: E43C8D2A-A6B5-4259-94B9-353FBC15F5A8 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationgatewayurlpathmapconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayUrlPathMapConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationGatewayUrlPathMapConfig.md +--- + +# Remove-AzApplicationGatewayUrlPathMapConfig + +## SYNOPSIS +Removes URL path mappings to a backend server pool. + +## SYNTAX + +``` +Remove-AzApplicationGatewayUrlPathMapConfig -Name <String> -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationGatewayUrlPathMapConfig** cmdlet removes URL path mappings to a backend server pool. + +## EXAMPLES + +### Example 1: Remove an URL path mapping from an application gateway +```powershell +$appgw = Get-AzApplicationGateway -ResourceGroupName "rg" -Name "appGwName" +$appgw = Remove-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway $appgw -Name "map01" +$appgw = Set-AzApplicationGateway -ApplicationGateway $appgw +``` + +The first command gets the application gateway named appGwName and stores the result in the $appgw variable. +The second command removes the URL path mapping named map01 from the application gateway. +The third command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway to which this cmdlet removes URL path map configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the URL path map name that this cmdlet removes from the backend server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayUrlPathMapConfig](./Add-AzApplicationGatewayUrlPathMapConfig.md) + +[Get-AzApplicationGatewayUrlPathMapConfig](./Get-AzApplicationGatewayUrlPathMapConfig.md) + +[New-AzApplicationGatewayUrlPathMapConfig](./New-AzApplicationGatewayUrlPathMapConfig.md) + +[Set-AzApplicationGatewayUrlPathMapConfig](./Set-AzApplicationGatewayUrlPathMapConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzApplicationSecurityGroup.md b/azps-10.1.0/Az.Network/Remove-AzApplicationSecurityGroup.md new file mode 100644 index 0000000000..b7f394a00d --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzApplicationSecurityGroup.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azapplicationsecuritygroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationSecurityGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzApplicationSecurityGroup.md +--- + +# Remove-AzApplicationSecurityGroup + +## SYNOPSIS +Removes an application security group. + +## SYNTAX + +``` +Remove-AzApplicationSecurityGroup -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzApplicationSecurityGroup** cmdlet removes an application security group. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzApplicationSecurityGroup -Name "MyApplicationSecurityGrouo" -ResourceGroupName "MyResourceGroup" +``` + +This command deletes an application security group named MyApplicationSecurityGroup in the resource group named MyResourceGroup. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to delete resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the application security group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the application security group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzApplicationSecurityGroup](./New-AzApplicationSecurityGroup.md) + +[Get-AzApplicationSecurityGroup](./Get-AzApplicationSecurityGroup.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzBastion.md b/azps-10.1.0/Az.Network/Remove-AzBastion.md new file mode 100644 index 0000000000..6ed43c3018 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzBastion.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azbastion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzBastion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzBastion.md +--- + +# Remove-AzBastion + +## SYNOPSIS +Removes a bastion resource. + +## SYNTAX + +### ByResourceGroupName (Default) +``` +Remove-AzBastion -ResourceGroupName <String> -Name <String> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzBastion -InputObject <PSBastion> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzBastion -ResourceId <String> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes a bastion resource.Example1 deletes the bastion using its ResourceGroupName and ResourceName. Example2 deletes the bastion using its object with pipeline. Example3 deletes the bastion using its object. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzBastion -ResourceGroupName "BastionPowershellTest" -Name "testBastion2" +``` + +### Example 2 +```powershell +Get-AzBastion -ResourceGroupName "BastionPowershellTest" -Name "testBastion" | Remove-AzBastion +``` + +### Example 3 +```powershell +$bastion = Get-AzBastion -ResourceGroupName "BastionPowershellTest" -Name "testBastion" +Remove-AzBastion -InputObject $bastion +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Bastion object to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBastion +Parameter Sets: ByInputObject +Aliases: Bastion, BastionObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The bastion resource name to be deleted. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupName +Aliases: ResourceName, BastionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name where bastion exists. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID for the Bastion to be deleted. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: BastionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBastion + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzBastion](./Get-AzBastion.md) + +[New-AzBastion](./New-AzBastion.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzCustomIpPrefix.md b/azps-10.1.0/Az.Network/Remove-AzCustomIpPrefix.md new file mode 100644 index 0000000000..d744f31526 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzCustomIpPrefix.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azcustomipprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzCustomIpPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzCustomIpPrefix.md +--- + +# Remove-AzCustomIpPrefix + +## SYNOPSIS +Removes a CustomIpPrefix + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzCustomIpPrefix -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzCustomIpPrefix -ResourceId <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzCustomIpPrefix -InputObject <PSCustomIpPrefix> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzCustomIpPrefix** cmdlet removes a CustomIpPrefix. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName +``` + +Removes the CustomIpPrefix with Name $prefixName from resource group $rgName + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +A customIpPrefix object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSCustomIpPrefix +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSCustomIpPrefix + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzCustomIpPrefix](./Get-AzCustomIpPrefix.md) + +[New-AzCustomIpPrefix](./New-AzCustomIpPrefix.md) + +[Update-AzCustomIpPrefix](./Update-AzCustomIpPrefix.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzDdosProtectionPlan.md b/azps-10.1.0/Az.Network/Remove-AzDdosProtectionPlan.md new file mode 100644 index 0000000000..ecddbb11cb --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzDdosProtectionPlan.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azddosprotectionplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzDdosProtectionPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzDdosProtectionPlan.md +--- + +# Remove-AzDdosProtectionPlan + +## SYNOPSIS +Removes a DDoS protection plan. + +## SYNTAX + +``` +Remove-AzDdosProtectionPlan -ResourceGroupName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzDdosProtectionPlan cmdlet removes a DDoS protection plan. + +## EXAMPLES + +### Example 1: Remove an empty DDoS protection plan +```powershell +Remove-AzDdosProtectionPlan -ResourceGroupName ResourceGroupName -Name DdosProtectionPlan +``` + +In this case, we remove a DDoS protection plan as specified. + +### Example 2: Remove a DDoS protection plan associated with a virtual network +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$vnet = Get-AzVirtualNetwork -Name VnetName -ResourceGroupName ResourceGroupName +$vnet.DdosProtectionPlan = $null +$vnet.EnableDdosProtection = $false +$vnet | Set-AzVirtualNetwork + +Name : VnetName +ResourceGroupName : ResourceGroupName +Location : westus +Id : /subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName +Etag : W/"65947351-747e-4686-aa8b-c40da58f6c8b" +ResourceGuid : fcb7bc1e-ee0d-4005-b3f1-feda76e3756c +ProvisioningState : Succeeded +Tags : +AddressSpace : { + "AddressPrefixes": [ + "10.0.0.0/16" + ] + } +DhcpOptions : { + "DnsServers": [ + "8.8.8.8" + ] + } +Subnets : [ + { + "Name": "SubnetName", + "Etag": "W/\"65947351-747e-4686-aa8b-c40da58f6c8b\"", + "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName/subnets/SubnetName", + "AddressPrefix": "10.0.1.0/24", + "IpConfigurations": [], + "ResourceNavigationLinks": [], + "ServiceEndpoints": [], + "ProvisioningState": "Succeeded" + } + ] +VirtualNetworkPeerings : [] +EnableDdosProtection : false +DdosProtectionPlan : null +EnableVmProtection : false + + +Remove-AzDdosProtectionPlan -ResourceGroupName ResourceGroupName -Name DdosProtectionPlan +``` + +DDoS protection plans cannot be deleted if they are associated with a virtual network. So the first step is to disassociate both objects. Here, we get the most updated version of the virtual network associated with the plan, and we set the property **DdosProtectionPlan** to an empty value and the flag **EnableDdosProtection** (this flag cannot be true without a plan). +Then, we persist the new state by piping the local variable into **Set-AzVirtualNetwork**. At this point, the plan is no longer associated with the virtual network. +If this is the last one associated with the plan, we can remove the DDoS protection plan by using the command Remove-AzDdosProtectionPlan. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the DDoS protection plan to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group of the DDoS protection plan to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzDdosProtectionPlan](./New-AzDdosProtectionPlan.md) + +[Get-AzDdosProtectionPlan](./Get-AzDdosProtectionPlan.md) + +[New-AzVirtualNetwork](./New-AzVirtualNetwork.md) + +[Set-AzVirtualNetwork](./Set-AzVirtualNetwork.md) + +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzDelegation.md b/azps-10.1.0/Az.Network/Remove-AzDelegation.md new file mode 100644 index 0000000000..8efb837048 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzDelegation.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azdelegation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzDelegation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzDelegation.md +--- + +# Remove-AzDelegation + +## SYNOPSIS +Removes a service delegation from the provided subnet. + +## SYNTAX + +``` +Remove-AzDelegation -Name <String> -Subnet <PSSubnet> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDelegation** cmdlet takes in a Subnet with delegations and removes the named delegation from that subnet. + +## EXAMPLES + +### Example 1 +```powershell +# Add a delegation to an existing subnet +$vnet = Get-AzVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" +$subnet = Get-AzVirtualNetworkSubnetConfig -Name "mySubnet" -VirtualNetwork $vnet +$subnet = Add-AzDelegation -Name "myDelegation" -ServiceName "Microsoft.Sql/servers" -Subnet $subnet +Set-AzVirtualNetwork -VirtualNetwork $vnet + +# Remove the delegation +$vnet = Get-AzVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" +$subnet = Get-AzVirtualNetworkSubnetConfig -Name "mySubnet" -VirtualNetwork $vnet +$subnet = Remove-AzDelegation -Name "myDelegation" -Subnet $subnet +Set-AzVirtualNetwork -VirtualNetwork $vnet +``` + +In this example, the first half (found under _"Add a delegation to an existing subnet"_) is identical to [Add-AzDelegation](./Add-AzDelegation.md). In the second half, the first two cmdlets retrieve the subnet of interest, refreshing the local copy with what's on the server. The third cmdlet removes the delegation that was created in the first half from _mySubnet_ and stores the updated subnet in _$subnet_. The final cmdlet updates the server with the removed delegation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the delegation + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Subnet +The subnet from which to remove the delegation + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSSubnet + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSSubnet + +## NOTES + +## RELATED LINKS + +[Add-AzDelegation](./Add-AzDelegation.md) +[Get-AzDelegation](./Get-AzDelegation.md) +[New-AzDelegation](./New-AzDelegation.md) +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) +[Get-AzVirtualNetworkSubnetConfig](./Get-AzVirtualNetworkSubnetConfig.md) +[Set-AzVirtualNetwork](./Set-AzVirtualNetwork.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzExpressRouteCircuit.md b/azps-10.1.0/Az.Network/Remove-AzExpressRouteCircuit.md new file mode 100644 index 0000000000..da758f02ec --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzExpressRouteCircuit.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: EDB94194-650C-4892-8DDC-E67D435522DD +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azexpressroutecircuit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteCircuit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteCircuit.md +--- + +# Remove-AzExpressRouteCircuit + +## SYNOPSIS +Removes an ExpressRoute circuit. + +## SYNTAX + +``` +Remove-AzExpressRouteCircuit -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzExpressRouteCircuit** cmdlet removes an ExpressRoute circuit. + +## EXAMPLES + +### Example 1: Delete an ExpressRoute circuit +```powershell +Remove-AzExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg +``` + +### Example 2: Delete an ExpressRoute circuit using the pipeline +```powershell +Get-AzExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg | Remove-AzExpressRouteCircuit +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ExpressRoute circuit to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. By default, this cmdlet does +not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that this ExpressRoute circuit belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuit](Get-AzExpressRouteCircuit.md) + +[Move-AzExpressRouteCircuit](Move-AzExpressRouteCircuit.md) + +[New-AzExpressRouteCircuit](New-AzExpressRouteCircuit.md) + +[Set-AzExpressRouteCircuit](Set-AzExpressRouteCircuit.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzExpressRouteCircuitAuthorization.md b/azps-10.1.0/Az.Network/Remove-AzExpressRouteCircuitAuthorization.md new file mode 100644 index 0000000000..b7d2f64084 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzExpressRouteCircuitAuthorization.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 38D57CE4-6994-4BDA-A50E-28680EF4E568 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azexpressroutecircuitauthorization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteCircuitAuthorization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteCircuitAuthorization.md +--- + +# Remove-AzExpressRouteCircuitAuthorization + +## SYNOPSIS +Removes an existing ExpressRoute configuration authorization. + +## SYNTAX + +``` +Remove-AzExpressRouteCircuitAuthorization [-Name <String>] -ExpressRouteCircuit <PSExpressRouteCircuit> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzExpressRouteCircuitAuthorization** cmdlet removes an authorization assigned to +an ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to Azure by using a +connectivity provider instead of the public Internet. The owner of an ExpressRoute circuit can +create as many as 10 authorizations for each circuit; these authorizations generate an +authorization key that can be used by a virtual network owner to connect his or her network to the +circuit. There can only be one authorization per virtual network. At any time, however, the circuit +owner can use **Remove-AzExpressRouteCircuitAuthorization** to remove the authorization +assigned to a virtual network. When that happens the corresponding virtual network is no longer +able to use the ExpressRoute circuit to connect to Azure. + +## EXAMPLES + +### Example 1: Remove a circuit authorization from an ExpressRoute circuit +```powershell +$Circuit = Get-AzExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup" +Remove-AzExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" -ExpressRouteCircuit $Circuit +Set-AzExpressRouteCircuit -ExpressRouteCircuit $Circuit +``` + +This example removes a circuit authorization from an ExpressRoute circuit. The first command uses +the **Get-AzExpressRouteCircuit** cmdlet to create an object reference to an ExpressRoute +circuit named ContosoCircuit and stores the result in the variable named $Circuit. +The second command marks the circuit authorization ContosoCircuitAuthorization for removal. +The third command uses the Set-AzExpressRouteCircuit cmdlet to confirm the removal of the +ExpressRoute circuit stored in the $Circuit variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuit +Specifies the ExpressRouteCircuit object that this cmdlet removes. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the circuit authorization that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## NOTES + +## RELATED LINKS + +[Add-AzExpressRouteCircuitAuthorization](./Add-AzExpressRouteCircuitAuthorization.md) + +[Get-AzExpressRouteCircuit](./Get-AzExpressRouteCircuit.md) + +[Get-AzExpressRouteCircuitAuthorization](./Get-AzExpressRouteCircuitAuthorization.md) + +[New-AzExpressRouteCircuitAuthorization](./New-AzExpressRouteCircuitAuthorization.md) + +[Set-AzExpressRouteCircuit](./Set-AzExpressRouteCircuit.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzExpressRouteCircuitConnectionConfig.md b/azps-10.1.0/Az.Network/Remove-AzExpressRouteCircuitConnectionConfig.md new file mode 100644 index 0000000000..3dc26d6384 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzExpressRouteCircuitConnectionConfig.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: cc944e06-4fa0-4ce5-88e9-ea6454b41d55 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azexpressroutecircuitconnectionconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteCircuitConnectionConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteCircuitConnectionConfig.md +--- + +# Remove-AzExpressRouteCircuitConnectionConfig + +## SYNOPSIS +Removes an ExpressRoute circuit connection configuration. + +## SYNTAX + +``` +Remove-AzExpressRouteCircuitConnectionConfig [-Name] <String> [-ExpressRouteCircuit] <PSExpressRouteCircuit> + [-AddressPrefixType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzExpressRouteCircuitConnectionConfig** cmdlet removes an ExpressRoute circuit +connection configuration associated with a given Express Route Circuit. + +## EXAMPLES + +### Example 1: Remove a circuit connection configuration from an ExpressRoute circuit +```powershell +$circuit_init = Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg +Remove-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init +Set-AzExpressRouteCircuit -ExpressRouteCircuit $circuit_init +``` + +### Example 2: Remove a circuit connection configuration using Piping from an ExpressRoute Circuit +```powershell +Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Remove-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName|Set-AzExpressRouteCircuit +``` + +### Example 3: Remove a circuit connection configuration from an ExpressRoute circuit for a specific address family +```powershell +$circuit_init = Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg +Remove-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init -AddressPrefixType IPv4 +Set-AzExpressRouteCircuit -ExpressRouteCircuit $circuit_init +``` + +### Example 4: Remove a circuit connection configuration using Piping from an ExpressRoute Circuit for a specific address family +```powershell +Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Remove-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -AddressPrefixType IPv6|Set-AzExpressRouteCircuit +``` + +## PARAMETERS + +### -AddressPrefixType +Specifies the address family that needs to be removed from the config + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6, All + +Required: False +Position: Named +Default value: IPv4 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuit +The ExpressRoute circuit containing the peering configuration to be removed. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the circuit connection configuration to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuit](Get-AzExpressRouteCircuit.md) + +[Get-AzExpressRouteCircuitConnectionConfig](Get-AzExpressRouteCircuitConnectionConfig.md) + +[Add-AzExpressRouteCircuitConnectionConfig](Add-AzExpressRouteCircuitConnectionConfig.md) + +[Set-AzExpressRouteCircuitConnectionConfig](Set-AzExpressRouteCircuitConnectionConfig.md) + +[Set-AzExpressRouteCircuit](Set-AzExpressRouteCircuit.md) + +[Get-AzExpressRouteCircuit](Get-AzExpressRouteCircuit.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzExpressRouteCircuitPeeringConfig.md b/azps-10.1.0/Az.Network/Remove-AzExpressRouteCircuitPeeringConfig.md new file mode 100644 index 0000000000..d2f717f77e --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzExpressRouteCircuitPeeringConfig.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 462F3EF7-4C15-41F8-853D-CDCC8E67673D +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azexpressroutecircuitpeeringconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteCircuitPeeringConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteCircuitPeeringConfig.md +--- + +# Remove-AzExpressRouteCircuitPeeringConfig + +## SYNOPSIS +Removes an ExpressRoute circuit peering configuration. + +## SYNTAX + +``` +Remove-AzExpressRouteCircuitPeeringConfig [-Name <String>] -ExpressRouteCircuit <PSExpressRouteCircuit> + [-PeerAddressType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzExpressRouteCircuitPeeringConfig** cmdlet removes an ExpressRoute circuit +peering configuration. + +## EXAMPLES + +### Example 1: Remove a peering configuration from an ExpressRoute circuit +```powershell +$circuit = Get-AzExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg +Remove-AzExpressRouteCircuitPeeringConfig -Name 'AzurePrivatePeering' -ExpressRouteCircuit $circuit +Set-AzExpressRouteCircuit -ExpressRouteCircuit $circuit +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuit +The ExpressRoute circuit containing the peering configuration to be removed. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the peering configuration to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerAddressType +The Address family of the peering + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## NOTES + +## RELATED LINKS + +[Add-AzExpressRouteCircuitPeeringConfig](Add-AzExpressRouteCircuitPeeringConfig.md) + +[Get-AzExpressRouteCircuit](Get-AzExpressRouteCircuit.md) + +[New-AzExpressRouteCircuitPeeringConfig](New-AzExpressRouteCircuitPeeringConfig.md) + +[Set-AzExpressRouteCircuit](Set-AzExpressRouteCircuit.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzExpressRouteConnection.md b/azps-10.1.0/Az.Network/Remove-AzExpressRouteConnection.md new file mode 100644 index 0000000000..73a47f4900 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzExpressRouteConnection.md @@ -0,0 +1,249 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azexpressrouteconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteConnection.md +--- + +# Remove-AzExpressRouteConnection + +## SYNOPSIS +Removes a ExpressRouteConnection. + +## SYNTAX + +### ByExpressRouteConnectionName (Default) +``` +Remove-AzExpressRouteConnection -ResourceGroupName <String> -ExpressRouteGatewayName <String> -Name <String> + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByExpressRouteConnectionResourceId +``` +Remove-AzExpressRouteConnection -ResourceId <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByExpressRouteConnectionObject +``` +Remove-AzExpressRouteConnection -InputObject <PSExpressRouteConnection> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes a ExpressRouteConnection. + +## EXAMPLES + +### Example 1 +```powershell +New-AzResourceGroup -Location "West Central US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West Central US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" -VirtualHubId $virtualHub.Id -MinScaleUnits 2 +$ExpressRouteGateway = Get-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" +$ExpressRouteCircuit = New-AzExpressRouteCircuit -ResourceGroupName "testRG" -Name "testExpressRouteCircuit" -Location "West Central US" -SkuTier Premium -SkuFamily MeteredData -ServiceProviderName "Equinix" -PeeringLocation "Silicon Valley" -BandwidthInMbps 200 +Add-AzExpressRouteCircuitPeeringConfig -Name "AzurePrivatePeering" -ExpressRouteCircuit $ExpressRouteCircuit -PeeringType AzurePrivatePeering -PeerASN 100 -PrimaryPeerAddressPrefix "123.0.0.0/30" -SecondaryPeerAddressPrefix "123.0.0.4/30" -VlanId 300 +$ExpressRouteCircuit = Set-AzExpressRouteCircuit -ExpressRouteCircuit $ExpressRouteCircuit +$ExpressRouteCircuitPeeringId = $ExpressRouteCircuit.Peerings[0].Id +New-AzExpressRouteConnection -ResourceGroupName $ExpressRouteGateway.ResourceGroupName -ExpressRouteGatewayName $ExpressRouteGateway.Name -Name "testConnection" -ExpressRouteCircuitPeeringId $ExpressRouteCircuitPeeringId -RoutingWeight 20 +Remove-AzExpressRouteConnection -ResourceGroupName $ExpressRouteGateway.ResourceGroupName -ExpressRouteGatewayName $ExpressRouteGateway.Name -Name "testConnection" +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in West US in "testRG" resource group in Azure. +A ExpressRoute gateway will be created thereafter in the Virtual Hub with 2 scale units. + +Once the gateway has been created, it is connected to the ExpressRouteSite using the New-AzExpressRouteConnection command. + +Then it removes the connection using the connection name. + +### Example 2 + +```powershell +New-AzResourceGroup -Location "West Central US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West Central US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" -VirtualHubId $virtualHub.Id -MinScaleUnits 2 +$ExpressRouteGateway = Get-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" +$ExpressRouteCircuit = New-AzExpressRouteCircuit -ResourceGroupName "testRG" -Name "testExpressRouteCircuit" -Location "West Central US" -SkuTier Premium -SkuFamily MeteredData -ServiceProviderName "Equinix" -PeeringLocation "Silicon Valley" -BandwidthInMbps 200 +Add-AzExpressRouteCircuitPeeringConfig -Name "AzurePrivatePeering" -ExpressRouteCircuit $ExpressRouteCircuit -PeeringType AzurePrivatePeering -PeerASN 100 -PrimaryPeerAddressPrefix "123.0.0.0/30" -SecondaryPeerAddressPrefix "123.0.0.4/30" -VlanId 300 +$ExpressRouteCircuit = Set-AzExpressRouteCircuit -ExpressRouteCircuit $ExpressRouteCircuit +$ExpressRouteCircuitPeeringId = $ExpressRouteCircuit.Peerings[0].Id +New-AzExpressRouteConnection -ResourceGroupName $ExpressRouteGateway.ResourceGroupName -ExpressRouteGatewayName $ExpressRouteGateway.Name -Name "testConnection" -ExpressRouteCircuitPeeringId $ExpressRouteCircuitPeeringId -RoutingWeight 20 +Get-AzExpressRouteConnection -ResourceGroupName $ExpressRouteGateway.ResourceGroupName -ExpressRouteGatewayName $ExpressRouteGateway.Name -Name "testConnection" | Remove-AzExpressRouteConnection +``` + +Same as example 1, but it now removes the connection using the piped object from Get-AzExpressRouteConnection. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteGatewayName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteConnectionName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The ExpressRouteConnection object to update. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteConnection +Parameter Sets: ByExpressRouteConnectionObject +Aliases: ExpressRouteConnection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteConnectionName +Aliases: ResourceName, ExpressRouteConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteConnectionName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ExpressRouteConnection object to delete. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteConnectionResourceId +Aliases: ExpressRouteConnectionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteConnection + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzExpressRouteCrossConnectionPeering.md b/azps-10.1.0/Az.Network/Remove-AzExpressRouteCrossConnectionPeering.md new file mode 100644 index 0000000000..316d92b426 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzExpressRouteCrossConnectionPeering.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 462F3EF7-4C15-41F8-853D-CDCC8E67673D +online version: https://learn.microsoft.com/powershell/module/az.network/Remove-AzExpressRouteCrossConnectionPeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteCrossConnectionPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteCrossConnectionPeering.md +--- + +# Remove-AzExpressRouteCrossConnectionPeering + +## SYNOPSIS +Removes an ExpressRoute cross connection peering configuration. + +## SYNTAX + +``` +Remove-AzExpressRouteCrossConnectionPeering -ExpressRouteCrossConnection <PSExpressRouteCrossConnection> + [-Name <String>] [-PeerAddressType <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzExpressRouteCrossConnectionPeering** cmdlet removes an ExpressRoute cross connection +peering configuration. + +## EXAMPLES + +### Example 1: Remove a peering configuration from an ExpressRoute cross connection +```powershell +$cc = Get-AzExpressRouteCrossConnection -Name $CrossConnectionName -ResourceGroupName $rg +Remove-AzExpressRouteCrossConnectionPeering -Name 'AzurePrivatePeering' -ExpressRouteCrossConnection $cc +Set-AzExpressRouteCrossConnection -ExpressRouteCrossConnection $cc +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCrossConnection +The ExpressRoute cross connection containing the peering configuration to be removed. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCrossConnection +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the peering configuration to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerAddressType +The Address family of the peering + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PSExpressRouteCrossConnection +Parameter 'ExpressRouteCrossConnection' accepts value of type 'PSExpressRouteCrossConnection' from the pipeline + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCrossConnection + +## NOTES + +## RELATED LINKS + +[Add-AzExpressRouteCrossConnectionPeering](Add-AzExpressRouteCrossConnectionPeering.md) + +[Get-AzExpressRouteCrossConnectionPeering](./Get-AzExpressRouteCrossConnectionPeering.md) + +[Get-AzExpressRouteCrossConnection](Get-AzExpressRouteCrossConnection.md) + +[Set-AzExpressRouteCrossConnection](Set-AzExpressRouteCrossConnection.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzExpressRouteGateway.md b/azps-10.1.0/Az.Network/Remove-AzExpressRouteGateway.md new file mode 100644 index 0000000000..6da3d5c6eb --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzExpressRouteGateway.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azexpressroutegateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRouteGateway.md +--- + +# Remove-AzExpressRouteGateway + +## SYNOPSIS +The Remove-AzExpressRouteGateway cmdlet removes an Azure ExpressRoute gateway. This is a gateway specific to Azure Virtual WAN's software defined connectivity. + +## SYNTAX + +### ByExpressRouteGatewayName (Default) +``` +Remove-AzExpressRouteGateway -ResourceGroupName <String> -Name <String> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByExpressRouteGatewayObject +``` +Remove-AzExpressRouteGateway -InputObject <PSExpressRouteGateway> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByExpressRouteGatewayResourceId +``` +Remove-AzExpressRouteGateway -ResourceId <String> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzExpressRouteGateway cmdlet removes an Azure ExpressRoute gateway. This is a gateway specific to Azure Virtual WAN's software defined connectivity. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West Central US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West Central US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" -VirtualHubId $virtualHub.Id -MinScaleUnits 2 +Remove-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" -Passthru +``` + +This example creates a Resource group, Virtual WAN, Virtual Hub, scalable ExpressRoute gateway in Central US and then immediately deletes it. +To suppress the prompt when deleting the Virtual Gateway, use the -Force flag. +This will delete the ExpressRouteGateway and all ExpressRouteConnections attached to it. + +### Example 2 + +```powershell +New-AzResourceGroup -Location "West Central US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West Central US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" -VirtualHubId $virtualHub.Id -MinScaleUnits 2 +Get-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" | Remove-AzExpressRouteGateway -Passthru +``` + +This example creates a Resource group, Virtual WAN, Virtual Hub, scalable ExpressRoute gateway in West Central US and then immediately deletes it. +This deletion happens using powershell piping, which uses the ExpressRouteGateway object returned by the Get-AzExpressRouteGateway command. +To suppress the prompt when deleting the Virtual Gateway, use the -Force flag. +This will delete the ExpressRouteGateway and all ExpressRouteConnections attached to it. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The ExpressRouteGateway object to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteGateway +Parameter Sets: ByExpressRouteGatewayObject +Aliases: ExpressRouteGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The ExpressRouteGateway name. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteGatewayName +Aliases: ResourceName, ExpressRouteGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID for the ExpressRouteGateway to be deleted. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteGatewayResourceId +Aliases: expressRouteGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteGateway + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzExpressRoutePort.md b/azps-10.1.0/Az.Network/Remove-AzExpressRoutePort.md new file mode 100644 index 0000000000..9ac93b1012 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzExpressRoutePort.md @@ -0,0 +1,236 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azexpressrouteport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRoutePort.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRoutePort.md +--- + +# Remove-AzExpressRoutePort + +## SYNOPSIS +Removes an ExpressRoutePort. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Remove-AzExpressRoutePort -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzExpressRoutePort -InputObject <PSExpressRoutePort> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzExpressRoutePort -ResourceId <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzExpressRoutePort** cmdlet removes an ExpressRoutePort. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzExpressRoutePort -Name $PortName -ResourceGroupName $rg +``` + +Removes $PortName ExpressRoutePort resource in $rg resource group in your subscription. + +### Example 2 +```powershell +Remove-AzExpressRoutePort -InputObject $Port +``` + +Removes the ExpressRoutePort resource in InputObject. + +### Example 3 +```powershell +Remove-AzExpressRoutePort -ResourceId $id +``` + +Removes the ExpressRoutePort resource with ResourceId $id. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to delete resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The express route port object + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ExpressRoutePort. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. By default, this cmdlet does +not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the ExpressRoutePort. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the express route port. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRoutePort](./Get-AzExpressRoutePort.md) + +[New-AzExpressRoutePort](./New-AzExpressRoutePort.md) + +[Set-AzExpressRoutePort](./Set-AzExpressRoutePort.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzExpressRoutePortAuthorization.md b/azps-10.1.0/Az.Network/Remove-AzExpressRoutePortAuthorization.md new file mode 100644 index 0000000000..ba1dfd6865 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzExpressRoutePortAuthorization.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azexpressrouteportauthorization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRoutePortAuthorization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRoutePortAuthorization.md +--- + +# Remove-AzExpressRoutePortAuthorization + +## SYNOPSIS +Removes an existing ExpressRoutePort authorization. + +## SYNTAX + +``` +Remove-AzExpressRoutePortAuthorization -Name <String> -ExpressRoutePortObject <PSExpressRoutePort> [-Force] + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzExpressRoutePortAuthorization** cmdlet removes an authorization assigned to an ExpressRoutePort. + +## EXAMPLES + +### Example 1 +```powershell +$ERPort = Get-AzExpressRoutePort -Name "ContosoPort" -ResourceGroupName "ContosoResourceGroup" +``` + +```output +Name : ContosoPort +ResourceGroupName : ContosoResourceGroup +Location : westcentralus +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/ContosoResourceGroup/pr + oviders/Microsoft.Network/expressRoutePorts/ContosoPort +Etag : W/"cf987288-013e-40bf-a2aa-b29d017e7b7f" +ResourceGuid : 4c0e5cdb-79e1-4cb8-a430-0ce9b24472ca +ProvisioningState : Succeeded +PeeringLocation : Area51-ERDirect +BandwidthInGbps : 100 +ProvisionedBandwidthInGbps : 0 +Encapsulation : QinQ +Mtu : 1500 +EtherType : 0x8100 +AllocationDate : Thursday, March 31, 2022 +Identity : null +Links : [ + { + "Name": "link1", + "Etag": "W/\"cf987288-013e-40bf-a2aa-b29d017e7b7f\"", + "Id": "/subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/ContosoResou + rceGroup/providers/Microsoft.Network/expressRoutePorts/ContosoPort/links/link1", + "RouterName": "a51-test-06gmr-cis-3", + "InterfaceName": "HundredGigE15/15/19", + "PatchPanelId": "PP:0123:1110201 - Port 42", + "RackId": "A51 02050-0123-L", + "ConnectorType": "LC", + "AdminState": "Disabled", + "ProvisioningState": "Succeeded", + "MacSecConfig": { + "SciState": "Disabled", + "Cipher": "GcmAes128" + } + }, + { + "Name": "link2", + "Etag": "W/\"cf987288-013e-40bf-a2aa-b29d017e7b7f\"", + "Id": "/subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/ContosoResou + rceGroup/providers/Microsoft.Network/expressRoutePorts/ContosoPort/links/link2", + "RouterName": "a51-test-06gmr-cis-4", + "InterfaceName": "HundredGigE15/15/19", + "PatchPanelId": "2050:0124:1110854 - Port 42", + "RackId": "A51 02050-0124-L", + "ConnectorType": "LC", + "AdminState": "Disabled", + "ProvisioningState": "Succeeded", + "MacSecConfig": { + "SciState": "Disabled", + "Cipher": "GcmAes128" + } + } + ] +Circuits : [] +``` + +```powershell +Remove-AzExpressRoutePortAuthorization -Name "ContosoPortAuthorization" -ExpressRoutePortObject $ERPort +``` + +```output +Confirm +Are you sure you want to remove resource 'ContosoPortAuthorization' +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +``` + +This example removes an authorization from an ExpressRoutePort. The first command uses +the **Get-AzExpressRoutePort** cmdlet to create an object reference to an ExpressRoutePort +named ContosoPort and stores the result in the variable named $ERPort. +The second command removes the ExpressRoutePort authorization ContosoPortAuthorization from +the ContosoPort. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRoutePortObject +The ExpressRoutePort Object + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to delete resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the ExpressRoutePort authorization that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRoutePortAuthorization](./Get-AzExpressRoutePortAuthorization.md) + +[Add-AzExpressRoutePortAuthorization](./Add-AzExpressRoutePortAuthorization.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzExpressRoutePortIdentity.md b/azps-10.1.0/Az.Network/Remove-AzExpressRoutePortIdentity.md new file mode 100644 index 0000000000..13e370f694 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzExpressRoutePortIdentity.md @@ -0,0 +1,83 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azexpressrouteportidentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRoutePortIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzExpressRoutePortIdentity.md +--- + +# Remove-AzExpressRoutePortIdentity + +## SYNOPSIS +Removes a identity from an ExpressRoutePort. + +## SYNTAX + +``` +Remove-AzExpressRoutePortIdentity -ExpressRoutePort <PSExpressRoutePort> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzExpressRoutePortIdentity** cmdlet removes identity from a local Azure ExpressRoutePort object. Use **Remove-AzExpressRoutePort** to remove it to from ExpressRoutePort. + +## EXAMPLES + +### Example 1 +```powershell +$expressroutePort = Remove-AzExpressRoutePortIdentity -ExpressRoutePort $expressroutePort +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRoutePort +The ExpressRoutePort + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRoutePortIdentity](./Get-AzExpressRoutePortIdentity.md) + +[New-AzExpressRoutePortIdentity](./New-AzExpressRoutePortIdentity.md) + +[Set-AzExpressRoutePortIdentity](./Set-AzExpressRoutePortIdentity.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzFirewall.md b/azps-10.1.0/Az.Network/Remove-AzFirewall.md new file mode 100644 index 0000000000..6d446c1952 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzFirewall.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 9DBD5ADF-C30E-4D1A-A4CB-4D70C21088F3 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azfirewall +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzFirewall.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzFirewall.md +--- + +# Remove-AzFirewall + +## SYNOPSIS +Remove a Firewall. + +## SYNTAX + +``` +Remove-AzFirewall -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzFirewall** cmdlet removes an Azure Firewall. + +## EXAMPLES + +### Example 1: Create and delete a Firewall +```powershell +New-AzFirewall -Name "azFw" -ResourceGroupName "rgName" -Location centralus + +Remove-AzFirewall -Name "azFw" -ResourceGroupName "rgName" +``` + +```output +Confirm +Are you sure you want to remove resource 'azFw' +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +``` + +This example creates a Firewall and then deletes it. To suppress the prompt when deleting the Firewall, use the -Force flag. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the firewall that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the firewall that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzFirewall](./Get-AzFirewall.md) + +[New-AzFirewall](./New-AzFirewall.md) + +[Set-AzFirewall](./Set-AzFirewall.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzFirewallPolicy.md b/azps-10.1.0/Az.Network/Remove-AzFirewallPolicy.md new file mode 100644 index 0000000000..23081baa67 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzFirewallPolicy.md @@ -0,0 +1,230 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azfirewallpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzFirewallPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzFirewallPolicy.md +--- + +# Remove-AzFirewallPolicy + +## SYNOPSIS +Removes an Azure Firewall Policy + +## SYNTAX + +### RemoveByNameParameterSet (Default) +``` +Remove-AzFirewallPolicy -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByResourceIdParameterSet +``` +Remove-AzFirewallPolicy [-Force] [-PassThru] [-AsJob] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObjectParameterSet +``` +Remove-AzFirewallPolicy [-Force] [-PassThru] [-AsJob] -InputObject <PSAzureFirewallPolicy> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzFirewallPolicy** cmdlet removes an Azure Firewall Policy. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzFirewallPolicy -Name firewallpolicy -ResourceGroupName TestRg +``` + +This example removes the firewall policy named "firewallpolicy" in the resourcegroup "TestRg" + +### Example 2 +```powershell +Remove-AzFirewallPolicy -ResourceId "/subscriptions/12345/resourceGroups/TestRg/providers/Microsoft.Network/firewallpolicies/firewallPolicy1" +``` + +This example removes the firewall policy by the Id. + +### Example 3 +```powershell +Remove-AzFirewallPolicy -InputObject $fp +``` + +This example removes the firewall policy $fp + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The AzureFirewall Policy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicy +Parameter Sets: RemoveByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id. + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicy + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzFirewallPolicyRuleCollectionGroup.md b/azps-10.1.0/Az.Network/Remove-AzFirewallPolicyRuleCollectionGroup.md new file mode 100644 index 0000000000..bf212f5573 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzFirewallPolicyRuleCollectionGroup.md @@ -0,0 +1,276 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azfirewallpolicyrulecollectiongroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzFirewallPolicyRuleCollectionGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzFirewallPolicyRuleCollectionGroup.md +--- + +# Remove-AzFirewallPolicyRuleCollectionGroup + +## SYNOPSIS +Removes a Azure Firewall Policy Rule Collection Group in a Azure firewall policy + +## SYNTAX + +### RemoveByNameParameterSet (Default) +``` +Remove-AzFirewallPolicyRuleCollectionGroup -Name <String> -ResourceGroupName <String> + -AzureFirewallPolicyName <String> [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByParentInputObjectParameterSet +``` +Remove-AzFirewallPolicyRuleCollectionGroup -Name <String> -FirewallPolicyObject <PSAzureFirewallPolicy> + [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RemoveByInputObjectParameterSet +``` +Remove-AzFirewallPolicyRuleCollectionGroup -InputObject <PSAzureFirewallPolicyRuleCollectionGroupWrapper> + [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RemoveByResourceIdParameterSet +``` +Remove-AzFirewallPolicyRuleCollectionGroup -ResourceId <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzFirewallPolicyRuleCollectionGroup** cmdlet removes a rule collection group from an Azure Firewall Policy. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzFirewallPolicyRuleCollectionGroup -Name testRcGroup -FirewallPolicyObject $fp +``` + +This example removes the firewall policy rule colelction group named "testRcGroup" in the firewall policy object $fp + +### Example 2 +```powershell +Remove-AzFirewallPolicyRuleCollectionGroup -Name testRcGroup -ResourceGroupName testRg -AzureFirewallPolicyName fpName +``` + +This example removes the firewall policy rule colelction group named "testRcGroup" in the firewall named "fpName" frpm the resourcegroup names "testRg" + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureFirewallPolicyName +The name of the firewall policy + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicyObject +Firewall Policy. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicy +Parameter Sets: RemoveByParentInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Firewall Policy Rule collection group object + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyRuleCollectionGroupWrapper +Parameter Sets: RemoveByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: RemoveByParentInputObjectParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id of the Rule collection groupy + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicy + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyRuleCollectionGroupWrapper + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzIpAllocation.md b/azps-10.1.0/Az.Network/Remove-AzIpAllocation.md new file mode 100644 index 0000000000..16da30791d --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzIpAllocation.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azipallocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzIpAllocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzIpAllocation.md +--- + +# Remove-AzIpAllocation + +## SYNOPSIS +Deletes an Azure IpAllocation. + +## SYNTAX + +### DeleteByNameParameterSet +``` +Remove-AzIpAllocation -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzIpAllocation -InputObject <PSTopLevelResource> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzIpAllocation -ResourceId <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzIpAllocation** cmdlet deletes an Azure IpAllocation + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIpAllocation -ResourceGroupName 'TestResourceGroup' -Name 'TestIpAllocation' +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +{{ Fill InputObject Description }} + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSTopLevelResource +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +IpAllocation resource id. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzIpGroup.md b/azps-10.1.0/Az.Network/Remove-AzIpGroup.md new file mode 100644 index 0000000000..3620a54e59 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzIpGroup.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azipgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzIpGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzIpGroup.md +--- + +# Remove-AzIpGroup + +## SYNOPSIS +Deletes an Azure IpGroup. + +## SYNTAX + +### IpGroupNameParameterSet (Default) +``` +Remove-AzIpGroup -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IpGroupInputObjectParameterSet +``` +Remove-AzIpGroup -IpGroup <PSIpGroup> [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IpGroupResourceIdParameterSet +``` +Remove-AzIpGroup -ResourceId <String> [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzIpGroup** cmdlet deletes an Azure IpGroup + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIpGroup -ResourceGroupName ipGroupRG -Name ipGroup +``` + +### Example 2 +```powershell +$ipGroupId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/ipGroupRG/providers/Microsoft.Network/ipGroups/ipGroup' +Remove-AzIpGroup -ResourceId $ipGroupId +``` + +### Example 3 +```powershell +$ipGroup = Get-AzIpGroup -ResourceGroupName ipGroupRG -Name ipGroup +Remove-AzIpGroup -IpGroup $ipGroup +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpGroup +The ipGroup input object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpGroup +Parameter Sets: IpGroupInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the ipgroup. + +```yaml +Type: System.String +Parameter Sets: IpGroupNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the ipgroup. + +```yaml +Type: System.String +Parameter Sets: IpGroupNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The ipgroup resource Id. + +```yaml +Type: System.String +Parameter Sets: IpGroupResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSIpGroup + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzLoadBalancer.md b/azps-10.1.0/Az.Network/Remove-AzLoadBalancer.md new file mode 100644 index 0000000000..e5a7df951c --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzLoadBalancer.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 31B0FBEF-366A-41AF-9182-2EB087019F36 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azloadbalancer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancer.md +--- + +# Remove-AzLoadBalancer + +## SYNOPSIS +Removes a load balancer. + +## SYNTAX + +``` +Remove-AzLoadBalancer -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzLoadBalancer** cmdlet removes an Azure load balancer. + +## EXAMPLES + +### Example 1: Remove a load balancer +```powershell +Remove-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +``` + +This command deletes a load balancer named MyLoadBalancer in the resource group named MyResourceGroup. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet removes the load balancer regardless of whether resources are assigned to it. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the load balancer to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the load balancer to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[New-AzLoadBalancer](./New-AzLoadBalancer.md) + +[Set-AzLoadBalancer](./Set-AzLoadBalancer.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzLoadBalancerBackendAddressPool.md b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerBackendAddressPool.md new file mode 100644 index 0000000000..5b9fb2af4c --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerBackendAddressPool.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azloadbalancerbackendaddresspool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerBackendAddressPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerBackendAddressPool.md +--- + +# Remove-AzLoadBalancerBackendAddressPool + +## SYNOPSIS +Removes a backend pool from a load balancer + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzLoadBalancerBackendAddressPool -ResourceGroupName <String> -Name <String> [-LoadBalancerName <String>] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByParentObjectParameterSet +``` +Remove-AzLoadBalancerBackendAddressPool -Name <String> [-LoadBalancerName <String>] + -LoadBalancer <PSLoadBalancer> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzLoadBalancerBackendAddressPool [-LoadBalancerName <String>] -InputObject <PSBackendAddressPool> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzLoadBalancerBackendAddressPool [-LoadBalancerName <String>] -ResourceId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes a backend pool from a load balancer + +## EXAMPLES + +### Example 1 +```powershell +##removing by passing lb object via pipeline +$lb | Remove-AzLoadBalancerBackendAddressPool -Name $backendPool1 +``` + +### Example 2 +```powershell +##removing by passing input object +Remove-AzLoadBalancerBackendAddressPool -InputObject $backendPoolObject +``` + +### Example 3 +```powershell +##removing by passing input object +Remove-AzLoadBalancerBackendAddressPool -ResourceId $backendPoolObject.Id +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The backend address pool to remove + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LoadBalancer +The load balancer resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: DeleteByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LoadBalancerName +The name of the load balancer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the load balancer. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet, DeleteByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the load balancer. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzLoadBalancerBackendAddressPoolConfig.md b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerBackendAddressPoolConfig.md new file mode 100644 index 0000000000..8abc874abc --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerBackendAddressPoolConfig.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: F965A9DE-645C-471B-84E8-58D648B1CA57 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azloadbalancerbackendaddresspoolconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerBackendAddressPoolConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerBackendAddressPoolConfig.md +--- + +# Remove-AzLoadBalancerBackendAddressPoolConfig + +## SYNOPSIS +Removes a backend address pool configuration from a load balancer. + +## SYNTAX + +``` +Remove-AzLoadBalancerBackendAddressPoolConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzLoadBalancerBackendAddressPoolConfig** cmdlet removes a backend address pool from a load balancer. + +## EXAMPLES + +### Example 1: Remove a backend address pool configuration from a load balancer +```powershell +Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" | Remove-AzLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool02" | Set-AzLoadBalancer +``` + +This command gets the load balancer named MyLoadBalancer and passes it to **Remove-AzLoadBalancerBackendAddressPoolConfig**, which removes the BackendAddressPool02 configuration from MyLoadBalancer. +Finally, the Set-AzLoadBalancer cmdlet updates MyLoadBalancer. +Note that a backend address pool configuration must exist before you can delete it. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies the load balancer that contains the backend address pool to remove. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the backend address pool that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerBackendAddressPoolConfig](./Add-AzLoadBalancerBackendAddressPoolConfig.md) + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[Get-AzLoadBalancerBackendAddressPoolConfig](./Get-AzLoadBalancerBackendAddressPoolConfig.md) + +[New-AzLoadBalancerBackendAddressPoolConfig](./New-AzLoadBalancerBackendAddressPoolConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzLoadBalancerFrontendIpConfig.md b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerFrontendIpConfig.md new file mode 100644 index 0000000000..a168cf3a77 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerFrontendIpConfig.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 5F8E11DF-D560-44D7-99CA-C425951A56D6 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azloadbalancerfrontendipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerFrontendIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerFrontendIpConfig.md +--- + +# Remove-AzLoadBalancerFrontendIpConfig + +## SYNOPSIS +Removes a front-end IP configuration from a load balancer. + +## SYNTAX + +``` +Remove-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzLoadBalancerFrontendIpConfig** cmdlet removes a front-end IP configuration from an Azure load balancer. + +## EXAMPLES + +### Example 1: Remove a front-end IP configuration from a load balancer +```powershell +$loadbalancer = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +Remove-AzLoadBalancerFrontendIpConfig -Name "frontendName" -LoadBalancer $loadbalancer +``` + +The first command gets the load balancer that is associated with the front-end IP configuration you want to remove, and then stores it in the $loadbalancer variable. +The second command removes the associated frontend IP configuration from the load balancer in $loadbalancer. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies the load balancer that contains the front-end IP configuration to remove. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the front-end IP address configuration to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerFrontendIpConfig](./Add-AzLoadBalancerFrontendIpConfig.md) + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[Get-AzLoadBalancerFrontendIpConfig](./Get-AzLoadBalancerFrontendIpConfig.md) + +[New-AzLoadBalancerFrontendIpConfig](./New-AzLoadBalancerFrontendIpConfig.md) + +[Set-AzLoadBalancerFrontendIpConfig](./Set-AzLoadBalancerFrontendIpConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzLoadBalancerInboundNatPoolConfig.md b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerInboundNatPoolConfig.md new file mode 100644 index 0000000000..30317aa127 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerInboundNatPoolConfig.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 98D2EB70-440F-45C4-A79A-EB87BBDC6256 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azloadbalancerinboundnatpoolconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerInboundNatPoolConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerInboundNatPoolConfig.md +--- + +# Remove-AzLoadBalancerInboundNatPoolConfig + +## SYNOPSIS +Removes an inbound NAT pool configuration from a load balancer. + +## SYNTAX + +``` +Remove-AzLoadBalancerInboundNatPoolConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzLoadBalancerInboundNatPoolConfig** cmdlet removes an inbound NAT pool configuration from a load balancer. + +## EXAMPLES + +### 1: Remove +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +Remove-AzLoadBalancerInboundNatPoolConfig -Name myinboundnatpool -LoadBalancer $slb +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerInboundNatPoolConfig](./Add-AzLoadBalancerInboundNatPoolConfig.md) + +[Get-AzLoadBalancerInboundNatPoolConfig](./Get-AzLoadBalancerInboundNatPoolConfig.md) + +[New-AzLoadBalancerInboundNatPoolConfig](./New-AzLoadBalancerInboundNatPoolConfig.md) + +[Set-AzLoadBalancerInboundNatPoolConfig](./Set-AzLoadBalancerInboundNatPoolConfig.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzLoadBalancerInboundNatRuleConfig.md b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerInboundNatRuleConfig.md new file mode 100644 index 0000000000..196ecfec99 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerInboundNatRuleConfig.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: D818C404-60E4-42DB-AADF-063305D9541B +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azloadbalancerinboundnatruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerInboundNatRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerInboundNatRuleConfig.md +--- + +# Remove-AzLoadBalancerInboundNatRuleConfig + +## SYNOPSIS +Removes an inbound NAT rule configuration from a load balancer. + +## SYNTAX + +``` +Remove-AzLoadBalancerInboundNatRuleConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzLoadBalancerInboundNatRuleConfig** cmdlet removes an inbound network address translation (NAT) rule configuration from an Azure load balancer. + +## EXAMPLES + +### 1: Delete an inbound NAT rule from an Azure load balancer +```powershell +$loadbalancer = Get-AzLoadBalancer -Name mylb -ResourceGroupName myrg + +Remove-AzLoadBalancerInboundNatRuleConfig -Name "myinboundnatrule" -LoadBalancer $loadbalancer +``` + +The first command loads an already existing load balancer called "mylb" and stores it in the variable $load + balancer. The second command removes the inbound NAT rule associated with this load balancer. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies the **LoadBalancer** object that contains the inbound NAT rule configuration that this cmdlet removes. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the inbound NAT rule configuration that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerInboundNatRuleConfig](./Add-AzLoadBalancerInboundNatRuleConfig.md) + +[Get-AzLoadBalancerInboundNatRuleConfig](./Get-AzLoadBalancerInboundNatRuleConfig.md) + +[New-AzLoadBalancerInboundNatRuleConfig](./New-AzLoadBalancerInboundNatRuleConfig.md) + +[Set-AzLoadBalancerInboundNatRuleConfig](./Set-AzLoadBalancerInboundNatRuleConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzLoadBalancerOutboundRuleConfig.md b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerOutboundRuleConfig.md new file mode 100644 index 0000000000..c8f23e2ffc --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerOutboundRuleConfig.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azloadbalanceroutboundruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerOutboundRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerOutboundRuleConfig.md +--- + +# Remove-AzLoadBalancerOutboundRuleConfig + +## SYNOPSIS +Removes an outbound rule configuration from a load balancer. + +## SYNTAX + +``` +Remove-AzLoadBalancerOutboundRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzLoadBalancerOutboundRuleConfig** cmdlet removes an outbound rule configuration from an Azure load balancer. + +## EXAMPLES + +### Example 1: Delete an outbound rule from an Azure load balancer +```powershell +$slb = Get-AzLoadBalancer -ResourceGroupName "MyResourceGroup" -Name "MyLoadBalancer" +Remove-AzLoadBalancerOutboundRuleConfig -Name "RuleName" -LoadBalancer $slb +Set-AzLoadBalancer -LoadBalancer $slb +``` + +The first command gets the load balancer that is associated with the outbound rule configuration you want to remove, and then stores it in the $slb variable. +The second command removes the associated outbound rule configuration from the load balancer. +The third command updates the load balancer. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +The reference of the load balancer resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +The Name of outbound rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerOutboundRuleConfig](./Add-AzLoadBalancerOutboundRuleConfig.md) + +[Get-AzLoadBalancerOutboundRuleConfig](./Get-AzLoadBalancerOutboundRuleConfig.md) + +[New-AzLoadBalancerOutboundRuleConfig](./New-AzLoadBalancerOutboundRuleConfig.md) + +[Set-AzLoadBalancerOutboundRuleConfig](./Set-AzLoadBalancerOutboundRuleConfig.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzLoadBalancerProbeConfig.md b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerProbeConfig.md new file mode 100644 index 0000000000..1fb6641768 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerProbeConfig.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 2B15B224-E36C-454B-B6C2-F2BE032AE962 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azloadbalancerprobeconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerProbeConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerProbeConfig.md +--- + +# Remove-AzLoadBalancerProbeConfig + +## SYNOPSIS +Removes a probe configuration from a load balancer. + +## SYNTAX + +``` +Remove-AzLoadBalancerProbeConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzLoadBalancerProbeConfig** cmdlet removes a probe configuration from a load balancer. + +## EXAMPLES + +### Example 1: Remove a probe configuration from a load balancer +```powershell +$loadbalancer = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +Remove-AzLoadBalancerProbeConfig -Name "MyProbe" -LoadBalancer $loadbalancer +``` + +The first command gets the load balancer named MyLoadBalancer, and then stores it in the $loadbalancer variable. +The second command deletes the configuration named MyProbe from the load balancer in $loadbalancer. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies the load balancer that contains the probe configuration that this cmdlet removes. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the probe configuration that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerProbeConfig](./Add-AzLoadBalancerProbeConfig.md) + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[Get-AzLoadBalancerProbeConfig](./Get-AzLoadBalancerProbeConfig.md) + +[New-AzLoadBalancerProbeConfig](./New-AzLoadBalancerProbeConfig.md) + +[Set-AzLoadBalancerProbeConfig](./Set-AzLoadBalancerProbeConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzLoadBalancerRuleConfig.md b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerRuleConfig.md new file mode 100644 index 0000000000..14a11def10 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzLoadBalancerRuleConfig.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: DEBD58A3-AFAF-485C-8708-53228625138F +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azloadbalancerruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLoadBalancerRuleConfig.md +--- + +# Remove-AzLoadBalancerRuleConfig + +## SYNOPSIS +Removes a rule configuration for a load balancer. + +## SYNTAX + +``` +Remove-AzLoadBalancerRuleConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzLoadBalancerRuleConfig** cmdlet removes a rule configuration for an Azure load balancer. + +## EXAMPLES + +### Example 1: Remove a rule configuration from a load balancer +```powershell +$loadbalancer = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +Remove-AzLoadBalancerRuleConfig -Name "MyLBruleName" -LoadBalancer $loadbalancer +``` + +The first command gets the load balancer named MyLoadBalancer, and then stores it in the $loadbalancer variable. +The second command removes the rule configuration named MyLBruleName from the load balancer in $loadbalancer. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies the **LoadBalancer** object that contains the rule configuration that this cmdlet removes. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the load balancer rule configuration that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerRuleConfig](./Add-AzLoadBalancerRuleConfig.md) + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[Get-AzLoadBalancerRuleConfig](./Get-AzLoadBalancerRuleConfig.md) + +[New-AzLoadBalancerRuleConfig](./New-AzLoadBalancerRuleConfig.md) + +[Set-AzLoadBalancerRuleConfig](./Set-AzLoadBalancerRuleConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzLocalNetworkGateway.md b/azps-10.1.0/Az.Network/Remove-AzLocalNetworkGateway.md new file mode 100644 index 0000000000..688c9bac6e --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzLocalNetworkGateway.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 75E30205-97AD-44E3-A61F-62B81ADB532C +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azlocalnetworkgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLocalNetworkGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzLocalNetworkGateway.md +--- + +# Remove-AzLocalNetworkGateway + +## SYNOPSIS +Deletes a Local Network Gateway + +## SYNTAX + +``` +Remove-AzLocalNetworkGateway -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Local Network Gateway is the object representing your VPN device On-Premises. +The **Remove-AzLocalNetworkGateway** cmdlet deletes the object representing your on-prem gateway based on Name and Resource Group Name. + +## EXAMPLES + +### Example 1: Delete a Local Network Gateway +```powershell +Remove-AzLocalNetworkGateway -Name myLocalGW -ResourceGroupName myRG +``` + +Deletes the object of the Local Network Gateway with the name "myLocalGW" within the resource group "myRG" +Note: You must first delete all connections to the Local Network Gateway using the **Remove-AzVirtualNetworkGatewayConnection** cmdlet. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the local network gateway that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the local network gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzLocalNetworkGateway](./Get-AzLocalNetworkGateway.md) + +[New-AzLocalNetworkGateway](./New-AzLocalNetworkGateway.md) + +[Set-AzLocalNetworkGateway](./Set-AzLocalNetworkGateway.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzNatGateway.md b/azps-10.1.0/Az.Network/Remove-AzNatGateway.md new file mode 100644 index 0000000000..10e51bdb50 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNatGateway.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznatgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNatGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNatGateway.md +--- + +# Remove-AzNatGateway + +## SYNOPSIS +Remove Nat Gateway resource. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzNatGateway -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzNatGateway -InputObject <PSNatGateway> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzNatGateway -ResourceId <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove Nat Gateway Resource + +## EXAMPLES + +### Example 1 +```powershell +$nat = Get-AzNatGateway -ResourceGroupName "natgateway_test" -Name "nat_gateway" +Remove-AzNatGateway -InputObject $nat +Remove-AzNatGateway -ResourceId "/subscriptions/<subid>/resourceGroups/natgateway_test/providers/Microsoft.Network/natGateways/natgateway" +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to delete resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the Nat Gateway resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNatGateway +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: NatGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Nat Gateway resource. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id associated with the Nat Gateway. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: NatGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNatGateway + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkInterface.md b/azps-10.1.0/Az.Network/Remove-AzNetworkInterface.md new file mode 100644 index 0000000000..a0d8037fc7 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkInterface.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C83A0465-45EF-4FCC-B706-D5DF819664F0 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkinterface +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkInterface.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkInterface.md +--- + +# Remove-AzNetworkInterface + +## SYNOPSIS +Removes a network interface. + +## SYNTAX + +``` +Remove-AzNetworkInterface -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkInterface** cmdlet removes an Azure network interface. + +## EXAMPLES + +### Example 1: Remove a network interface +```powershell +Remove-AzNetworkInterface -Name "NetworkInterface1" -ResourceGroupName "ResourceGroup1" +``` + +This command removes the network interface NetworkInterface1 in resource group ResourceGroup1. +Because the *Force* parameter is not used, the user will be prompted to confirm this action. + +### Example 2: Remove a network interface +```powershell +Get-AzNetworkInterface -ResourceGroupName "ResourceGroup1" | Remove-AzNetworkInterface -Force +``` + +This command removes all network interfaces in resource group ResourceGroup1. +Because the *Force* parameter is used, the user is not prompted for confirmation. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network interface that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains the network interface that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkInterface](./Get-AzNetworkInterface.md) + +[New-AzNetworkInterface](./New-AzNetworkInterface.md) + +[Set-AzNetworkInterface](./Set-AzNetworkInterface.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkInterfaceIpConfig.md b/azps-10.1.0/Az.Network/Remove-AzNetworkInterfaceIpConfig.md new file mode 100644 index 0000000000..ad79d65823 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkInterfaceIpConfig.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 015C7DB7-2B08-4033-9B6E-1738D4DDACDA +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkinterfaceipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkInterfaceIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkInterfaceIpConfig.md +--- + +# Remove-AzNetworkInterfaceIpConfig + +## SYNOPSIS +Removes a network interface IP configuration from a network interface. + +## SYNTAX + +``` +Remove-AzNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkInterfaceIpConfig** cmdlet removes a network interface IP configuration from an Azure network interface. + +## EXAMPLES + +### Example 1: Delete an IP configuration from a network interface +```powershell +$nic = Get-AzNetworkInterface -Name mynic -ResourceGroupName myrg + +Remove-AzNetworkInterfaceIpConfig -Name IPConfig-1 -NetworkInterface $nic + +Set-AzNetworkInterface -NetworkInterface $nic +``` + +The first command gets a network interface called mynic and stores it in the variable $nic. The second command + removes the IP configuration called IPConfig-1 associated with this network interface. The third command sets changes made to the network interface. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network interface IP configuration to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterface +Specifies a **NetworkInterface** object. +This object contains the network interface IP configuration to remove. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterface +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Add-AzNetworkInterfaceIpConfig](./Add-AzNetworkInterfaceIpConfig.md) + +[Get-AzNetworkInterfaceIpConfig](./Get-AzNetworkInterfaceIpConfig.md) + +[New-AzNetworkInterfaceIpConfig](./New-AzNetworkInterfaceIpConfig.md) + +[Set-AzNetworkInterfaceIpConfig](./Set-AzNetworkInterfaceIpConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkInterfaceTapConfig.md b/azps-10.1.0/Az.Network/Remove-AzNetworkInterfaceTapConfig.md new file mode 100644 index 0000000000..77bf14a0f9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkInterfaceTapConfig.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/Remove-aznetworkinterfacetapconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkInterfaceTapConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkInterfaceTapConfig.md +--- + +# Remove-AzNetworkInterfaceTapConfig + +## SYNOPSIS +Removes a tap configuration from given network interface + +## SYNTAX + +### RemoveByNameParameterSet (Default) +``` +Remove-AzNetworkInterfaceTapConfig -ResourceGroupName <String> -NetworkInterfaceName <String> -Name <String> + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzNetworkInterfaceTapConfig -ResourceId <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzNetworkInterfaceTapConfig -InputObject <PSNetworkInterfaceTapConfiguration> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkInterfaceTapConfig** cmdlet removes an Azure tap configuration from a network interface list. + +## EXAMPLES + +### Example 1: Remove a tap configuration +```powershell +Remove-AzNetworkInterfaceTapConfig -Name "TapConfiguration" -NetworkInterfaceName "NetworkInterface1" -ResourceGroupName "ResourceGroup1" +``` + +This command removes the TapConfiguration from NetworkInterface1 in a resource group ResourceGroup1. +Because the *Force* parameter is not used, the user will be prompted to confirm this action. + +### Example 2: Remove a network interface +```powershell +Get-AzNetworkInterfaceTapConfig -Name "TapConfiguration" -NetworkInterfaceName "NetworkInterface1" -ResourceGroupName "ResourceGroup1" | Remove-AzNetworkInterfaceTapConfig -Force +``` + +This command removes the TapConfiguration from NetworkInterface1 in a resource group ResourceGroup1. +Because the *Force* parameter is used, the user is not prompted for confirmation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Reference to NetworkInterfaceTapConfig. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceTapConfiguration +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The virtual network peering name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkInterfaceName +The virtual network name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +NetworkInterfaceTapConfig resource id. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceTapConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +## NOTES + +## RELATED LINKS + +[Add-AzNetworkInterfaceTapConfig](./Add-AzNetworkInterfaceTapConfig.md) + +[Get-AzNetworkInterfaceTapConfig](./Get-AzNetworkInterfaceTapConfig.md) + +[Set-AzNetworkInterfaceTapConfig](./Set-AzNetworkInterfaceTapConfig.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkManager.md b/azps-10.1.0/Az.Network/Remove-AzNetworkManager.md new file mode 100644 index 0000000000..94991366f6 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkManager.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkmanager +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManager.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManager.md +--- + +# Remove-AzNetworkManager + +## SYNOPSIS +Removes a network manager. + +## SYNTAX + +``` +Remove-AzNetworkManager -Name <String> -ResourceGroupName <String> [-ForceDelete] [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkManager** cmdlet removes an Azure network manager. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetworkManager -Name TestNMName -ResourceGroupName TestRGName +``` + +Deletes a network manager. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDelete +Deletes the resource even if it is part of a deployed configuration. +If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManager](./Get-AzNetworkManager.md) + +[New-AzNetworkManager](./New-AzNetworkManager.md) + +[Set-AzNetworkManager](./Set-AzNetworkManager.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkManagerConnectivityConfiguration.md b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerConnectivityConfiguration.md new file mode 100644 index 0000000000..23bf7bd816 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerConnectivityConfiguration.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkmanagerconnectivityconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerConnectivityConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerConnectivityConfiguration.md +--- + +# Remove-AzNetworkManagerConnectivityConfiguration + +## SYNOPSIS +Removes a connectivity configuration. + +## SYNTAX + +``` +Remove-AzNetworkManagerConnectivityConfiguration -Name <String> -NetworkManagerName <String> + -ResourceGroupName <String> [-ForceDelete] [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkManagerConnectivityConfiguration** cmdlet removes a connectivity configuration. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetworkManagerConnectivityConfiguration -Name TestConnConfigName -NetworkManagerName TestNMName -ResourceGroupName TestRGName -ForceDelete +``` + +Removes a connectivity configuration. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDelete +Deletes the resource even if it is deployed. +If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerConnectivityConfiguration](./New-AzNetworkManagerConnectivityConfiguration.md) + +[Get-AzNetworkManagerConnectivityConfiguration](./Get-AzNetworkManagerConnectivityConfiguration.md) + +[Set-AzNetworkManagerConnectivityConfiguration](./Set-AzNetworkManagerConnectivityConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkManagerGroup.md b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerGroup.md new file mode 100644 index 0000000000..65cfa68cd0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerGroup.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkmanagergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerGroup.md +--- + +# Remove-AzNetworkManagerGroup + +## SYNOPSIS +Removes a network Group. + +## SYNTAX + +``` +Remove-AzNetworkManagerGroup -Name <String> -NetworkManagerName <String> -ResourceGroupName <String> + [-ForceDelete] [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkManagerGroup** cmdlet removes an network Group. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetworkManagerGroup -Name TestNetworkGroupName -NetworkManagerName TestNMName -ResourceGroupName TestRGName -ForceDelete +``` + +Deletes a network Group. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDelete +Deletes the resource even if it is part of a deployed configuration. +If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerGroup](./Get-AzNetworkManagerGroup.md) + +[New-AzNetworkManagerGroup](./New-AzNetworkManagerGroup.md) + +[Set-AzNetworkManagerGroup](./Set-AzNetworkManagerGroup.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkManagerManagementGroupConnection.md b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerManagementGroupConnection.md new file mode 100644 index 0000000000..a40001faaf --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerManagementGroupConnection.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkmanagermanagementgroupconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerManagementGroupConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerManagementGroupConnection.md +--- + +# Remove-AzNetworkManagerManagementGroupConnection + +## SYNOPSIS +Removes a network manager management group connection. + +## SYNTAX + +``` +Remove-AzNetworkManagerManagementGroupConnection -ManagementGroupId <String> -Name <String> [-Force] + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkManagerManagementGroupConnection** cmdlet removes a network manager management group connection. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetworkManagerManagementGroupConnection -ManagementGroupId "newMG" -Name "psConnection" -Force +``` + +Removes a network manager management group connection. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Set-AzNetworkManagerManagementGroupConnection](./Set-AzNetworkManagerManagementGroupConnection.md) + +[Get-AzNetworkManagerManagementGroupConnection](./Get-AzNetworkManagerManagementGroupConnection.md) + +[New-AzNetworkManagerManagementGroupConnection](./New-AzNetworkManagerManagementGroupConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkManagerScopeConnection.md b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerScopeConnection.md new file mode 100644 index 0000000000..4bd7d3ff65 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerScopeConnection.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkmanagerscopeconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerScopeConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerScopeConnection.md +--- + +# Remove-AzNetworkManagerScopeConnection + +## SYNOPSIS +Removes a network manager scope connection. + +## SYNTAX + +``` +Remove-AzNetworkManagerScopeConnection -Name <String> -NetworkManagerName <String> -ResourceGroupName <String> + [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkManagerScopeConnection** cmdlet removes an Azure network manager scope connection. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetworkManagerScopeConnection -ResourceGroupName "testRG" -NetworkManagerName "TestNM" -Name "TestScopeConn" -PassThru -Force -AsJob +``` + +Deletes a network manager scope connection. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerScopeConnection](./Get-AzNetworkManagerScopeConnection.md) + +[New-AzNetworkManagerScopeConnection](./New-AzNetworkManagerScopeConnection.md) + +[Set-AzNetworkManagerScopeConnection](./Set-AzNetworkManagerScopeConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkManagerSecurityAdminConfiguration.md b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerSecurityAdminConfiguration.md new file mode 100644 index 0000000000..af5b9b4abf --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerSecurityAdminConfiguration.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkmanagersecurityadminconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerSecurityAdminConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerSecurityAdminConfiguration.md +--- + +# Remove-AzNetworkManagerSecurityAdminConfiguration + +## SYNOPSIS +Removes a security admin configuration. + +## SYNTAX + +``` +Remove-AzNetworkManagerSecurityAdminConfiguration -Name <String> -NetworkManagerName <String> + -ResourceGroupName <String> [-ForceDelete] [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkManagerSecurityAdminConfiguration** cmdlet removes a security admin configuration.} + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetworkManagerSecurityAdminConfiguration -Name TestAdminConfigName -NetworkManagerName TestNMName -ResourceGroupName TestRGName -ForceDelete +``` + +Removes a security admin configuration. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDelete +Deletes the resource even if it is deployed. +If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerSecurityAdminConfiguration](./Get-AzNetworkManagerSecurityAdminConfiguration.md) + +[New-AzNetworkManagerSecurityAdminConfiguration](./New-AzNetworkManagerSecurityAdminConfiguration.md) + +[Set-AzNetworkManagerSecurityAdminConfiguration](./Set-AzNetworkManagerSecurityAdminConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkManagerSecurityAdminRule.md b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerSecurityAdminRule.md new file mode 100644 index 0000000000..668736fb96 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerSecurityAdminRule.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkmanagersecurityadminrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerSecurityAdminRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerSecurityAdminRule.md +--- + +# Remove-AzNetworkManagerSecurityAdminRule + +## SYNOPSIS +Removes a security admin rule. + +## SYNTAX + +``` +Remove-AzNetworkManagerSecurityAdminRule -Name <String> -RuleCollectionName <String> + -SecurityAdminConfigurationName <String> -NetworkManagerName <String> -ResourceGroupName <String> + [-ForceDelete] [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkManagerSecurityAdminRule** cmdlet removes a security admin rule. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetworkManagerSecurityAdminRule -Name TestAdminRuleName -RuleCollectionName TestRuleCollectionName -SecurityAdminConfigurationName TestAdminConfigName -NetworkManagerName TestNMName -ResourceGroupName TestRGName +``` + +Removes a security admin rule. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDelete +Deletes the resource even if it is part of a deployed configuration. +If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleCollectionName +The network manager security admin rule collection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SecurityAdminConfigurationName +The network manager security admin configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConfigName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerSecurityAdminRule](./Get-AzNetworkManagerSecurityAdminRule.md) + +[New-AzNetworkManagerSecurityAdminRule](./New-AzNetworkManagerSecurityAdminRule.md) + +[Set-AzNetworkManagerSecurityAdminRule](./Set-AzNetworkManagerSecurityAdminRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkManagerSecurityAdminRuleCollection.md b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerSecurityAdminRuleCollection.md new file mode 100644 index 0000000000..cfe3de81a9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerSecurityAdminRuleCollection.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkmanagersecurityadminrulecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerSecurityAdminRuleCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerSecurityAdminRuleCollection.md +--- + +# Remove-AzNetworkManagerSecurityAdminRuleCollection + +## SYNOPSIS +Removes a security admin rule collection. + +## SYNTAX + +``` +Remove-AzNetworkManagerSecurityAdminRuleCollection -Name <String> -SecurityAdminConfigurationName <String> + -NetworkManagerName <String> -ResourceGroupName <String> [-ForceDelete] [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkManagerSecurityAdminRuleCollection** cmdlet removes a security admin rule collection. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetworkManagerSecurityAdminRuleCollection -Name TestRuleCollectionName -SecurityAdminConfigurationName TestAdminConfigName -NetworkManagerName TestNMName -ResourceGroupName TestRGName +``` + +Removes a security admin rule collection. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDelete +Deletes the resource even if it is part of a deployed configuration. +If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SecurityAdminConfigurationName +The network manager security admin configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConfigName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerSecurityAdminRuleCollection](./Get-AzNetworkManagerSecurityAdminRuleCollection.md) + +[New-AzNetworkManagerSecurityAdminRuleCollection](./New-AzNetworkManagerSecurityAdminRuleCollection.md) + +[Set-AzNetworkManagerSecurityAdminRuleCollection](./Set-AzNetworkManagerSecurityAdminRuleCollection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkManagerStaticMember.md b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerStaticMember.md new file mode 100644 index 0000000000..c082272a23 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerStaticMember.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkmanagerstaticmember +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerStaticMember.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerStaticMember.md +--- + +# Remove-AzNetworkManagerStaticMember + +## SYNOPSIS +Removes a network manager static member. + +## SYNTAX + +``` +Remove-AzNetworkManagerStaticMember -Name <String> -NetworkGroupName <String> -NetworkManagerName <String> + -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkManagerStaticMember** cmdlet removes a network manager static member. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetworkManagerStaticMember -Name "TestStaticMember" -NetworkManagerName "TestNMName" -ResourceGroupName "TestRG" -NetworkGroupName "TestNetworkGroup" +``` + +Removes a network manager static member. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkGroupName +The network manager group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NetworkManagerName +The network manager name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManagerStaticMember](./New-AzNetworkManagerStaticMember.md) + +[Get-AzNetworkManagerStaticMember](./Get-AzNetworkManagerStaticMember.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkManagerSubscriptionConnection.md b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerSubscriptionConnection.md new file mode 100644 index 0000000000..51603b0ff4 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkManagerSubscriptionConnection.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkmanagersubscriptionconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerSubscriptionConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkManagerSubscriptionConnection.md +--- + +# Remove-AzNetworkManagerSubscriptionConnection + +## SYNOPSIS +Remove a network manager subscription connection. + +## SYNTAX + +``` +Remove-AzNetworkManagerSubscriptionConnection -Name <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkManagerSubscriptionConnection** cmdlet removes a network manager subscription connection. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetworkManagerSubscriptionConnection -Name psNetworkManagerConnection +``` + +Removes a network manager subscription connection. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Set-AzNetworkManagerManagementGroupConnection](./Set-AzNetworkManagerManagementGroupConnection.md) + +[Get-AzNetworkManagerManagementGroupConnection](./Get-AzNetworkManagerManagementGroupConnection.md) + +[New-AzNetworkManagerManagementGroupConnection](./New-AzNetworkManagerManagementGroupConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkProfile.md b/azps-10.1.0/Az.Network/Remove-AzNetworkProfile.md new file mode 100644 index 0000000000..e782b2a168 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkProfile.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkProfile.md +--- + +# Remove-AzNetworkProfile + +## SYNOPSIS +Removes a network profile. + +## SYNTAX + +### RemoveByNameParameterSet (Default) +``` +Remove-AzNetworkProfile -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByResourceIdParameterSet +``` +Remove-AzNetworkProfile -ResourceId <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObjectParameterSet +``` +Remove-AzNetworkProfile -InputObject <PSNetworkProfile> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkProfile** cmdlet removes a network profile if no container network interfaces (as contrasted to a container network interface **configuration**) have been created. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetworkProfile -Name np1 -ResourceGroupName rg1 +``` + +This removes the network profile with name np1 from the resource group rg1. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to delete resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Network profile object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkProfile +Parameter Sets: RemoveByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the network profile. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the network profile. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource manager resource ID of the network profile. + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSNetworkProfile + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkProfile](./Get-AzNetworkProfile.md) + +[New-AzNetworkProfile](./New-AzNetworkProfile.md) + +[Set-AzNetworkProfile](./Set-AzNetworkProfile.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkSecurityGroup.md b/azps-10.1.0/Az.Network/Remove-AzNetworkSecurityGroup.md new file mode 100644 index 0000000000..1a3da4875d --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkSecurityGroup.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 01F56553-1685-43D4-89E6-DDCDF17D1E00 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworksecuritygroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkSecurityGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkSecurityGroup.md +--- + +# Remove-AzNetworkSecurityGroup + +## SYNOPSIS +Removes a network security group. + +## SYNTAX + +``` +Remove-AzNetworkSecurityGroup -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkSecurityGroup** cmdlet removes an Azure network security group. + +## EXAMPLES + +### Example 1: Remove a network security group +```powershell +Remove-AzNetworkSecurityGroup -Name "NSG-FrontEnd" -ResourceGroupName "TestRG" +``` + +This command removes the security group named NSG-FrontEnd in the resource group named TestRG. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network security group that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that this cmdlet removes a network security group from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkSecurityGroup](./Get-AzNetworkSecurityGroup.md) + +[New-AzNetworkSecurityGroup](./New-AzNetworkSecurityGroup.md) + +[Set-AzNetworkSecurityGroup](./Set-AzNetworkSecurityGroup.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkSecurityRuleConfig.md b/azps-10.1.0/Az.Network/Remove-AzNetworkSecurityRuleConfig.md new file mode 100644 index 0000000000..d714c36906 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkSecurityRuleConfig.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 2E43D0D8-EF93-443B-AA8F-58C992026E95 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworksecurityruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkSecurityRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkSecurityRuleConfig.md +--- + +# Remove-AzNetworkSecurityRuleConfig + +## SYNOPSIS +Removes a network security rule from a network security group. + +## SYNTAX + +``` +Remove-AzNetworkSecurityRuleConfig [-Name <String>] -NetworkSecurityGroup <PSNetworkSecurityGroup> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNetworkSecurityRuleConfig** cmdlet removes a network security rule configuration from an Azure network security group. + +## EXAMPLES + +### Example 1: Remove a network security rule configuration +```powershell +$rule1 = New-AzNetworkSecurityRuleConfig -Name "rdp-rule" -Description "Allow RDP" -Access "Allow" -Protocol "Tcp" -Direction "Inbound" -Priority 100 -SourceAddressPrefix "Internet" -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 +$nsg = New-AzNetworkSecurityGroup -ResourceGroupName "TestRG" -Location "westus" -Name "NSG-FrontEnd" -SecurityRules $rule1 +Remove-AzNetworkSecurityRuleConfig -Name "rdp-rule" -NetworkSecurityGroup $nsg +$nsg | Set-AzNetworkSecurityGroup +``` + +The first command creates a network security rule configuration named rdp-rule, and then stores it in the $rule1 variable. +The second command creates a network security group using the rule in $rule1, and then stores the network security group in the $nsg variable. +The third command removes the network security rule configuration named rdp-rule from the network security group in $nsg. +The forth command saves the change. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network security rule configuration that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSecurityGroup +Specifies a **NetworkSecurityGroup** object. +This object contains the network security rule configuration to remove. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +## NOTES + +## RELATED LINKS + +[Add-AzNetworkSecurityRuleConfig](./Add-AzNetworkSecurityRuleConfig.md) + +[Get-AzNetworkSecurityRuleConfig](./Get-AzNetworkSecurityRuleConfig.md) + +[New-AzNetworkSecurityGroup](./New-AzNetworkSecurityGroup.md) + +[New-AzNetworkSecurityRuleConfig](./New-AzNetworkSecurityRuleConfig.md) + +[Set-AzNetworkSecurityRuleConfig](./Set-AzNetworkSecurityRuleConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkVirtualAppliance.md b/azps-10.1.0/Az.Network/Remove-AzNetworkVirtualAppliance.md new file mode 100644 index 0000000000..bc04c6cf82 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkVirtualAppliance.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkvirtualappliance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkVirtualAppliance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkVirtualAppliance.md +--- + +# Remove-AzNetworkVirtualAppliance + +## SYNOPSIS +Remove a Network Virtual Appliance resource. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Remove-AzNetworkVirtualAppliance -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzNetworkVirtualAppliance -ResourceId <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceObjectParameterSet +``` +Remove-AzNetworkVirtualAppliance -NetworkVirtualAppliance <PSNetworkVirtualAppliance> [-Force] [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzNetworkVirtualAppliance command removes a Network Virtual Appliance resource. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetworkVirtualAppliance -ResourceGroupName testrg -Name nva +``` + +Delete a Network Virtual Appliance resource. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkVirtualAppliance +The resource object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualAppliance +Parameter Sets: ResourceObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualAppliance + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkWatcher.md b/azps-10.1.0/Az.Network/Remove-AzNetworkWatcher.md new file mode 100644 index 0000000000..f84120f009 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkWatcher.md @@ -0,0 +1,258 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkwatcher +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkWatcher.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkWatcher.md +--- + +# Remove-AzNetworkWatcher + +## SYNOPSIS +Removes a Network Watcher. + +## SYNTAX + +### SetByResource +``` +Remove-AzNetworkWatcher -NetworkWatcher <PSNetworkWatcher> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByName +``` +Remove-AzNetworkWatcher -Name <String> -ResourceGroupName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +Remove-AzNetworkWatcher -Location <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzNetworkWatcher cmdlet removes a Network Watcher resource. + +## EXAMPLES + +### Example 1: Create and delete a Network Watcher +```powershell +New-AzResourceGroup -Name NetworkWatcherRG -Location westcentralus +New-AzNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroupName NetworkWatcherRG -Location westcentralus +Remove-AzNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroupName NetworkWatcherRG +``` + +This example creates a Network Watcher in a resource group and then immediately deletes it. Note that only one Network Watcher can be created per region per subscription. +To suppress the prompt when deleting the virtual network, use the -Force flag. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. + +```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. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkWatcherConnectionMonitor.md b/azps-10.1.0/Az.Network/Remove-AzNetworkWatcherConnectionMonitor.md new file mode 100644 index 0000000000..e94b0fa8ee --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkWatcherConnectionMonitor.md @@ -0,0 +1,326 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkwatcherconnectionmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkWatcherConnectionMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkWatcherConnectionMonitor.md +--- + +# Remove-AzNetworkWatcherConnectionMonitor + +## SYNOPSIS +Remove connection monitor. + +## SYNTAX + +### SetByName (Default) +``` +Remove-AzNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> + -Name <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByResource +``` +Remove-AzNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +Remove-AzNetworkWatcherConnectionMonitor -Location <String> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Remove-AzNetworkWatcherConnectionMonitor -ResourceId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObject +``` +Remove-AzNetworkWatcherConnectionMonitor -InputObject <PSConnectionMonitorResult> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The remove-AzNetworkWatcherConnectionMonitor cmdlet removes the specified connection monitor. + +## EXAMPLES + +### Example 1: Remove the specified connection monitor +```powershell +Remove-AzNetworkWatcherConnectionMonitor -Location centraluseuap -Name cm +``` + +In this example we delete the connection monitor specified by location and name. + +### Example 2 + +Remove connection monitor. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Remove-AzNetworkWatcherConnectionMonitor -Name cm -NetworkWatcherName nw1 -ResourceGroupName myresourcegroup +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Connection monitor object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult +Parameter Sets: SetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The connection monitor name. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: ConnectionMonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. + +```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 network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult + +## OUTPUTS + +### System.Boolean + +## NOTES +Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkWatcherFlowLog.md b/azps-10.1.0/Az.Network/Remove-AzNetworkWatcherFlowLog.md new file mode 100644 index 0000000000..bb8c98b236 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkWatcherFlowLog.md @@ -0,0 +1,317 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkwatcherflowlog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkWatcherFlowLog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkWatcherFlowLog.md +--- + +# Remove-AzNetworkWatcherFlowLog + +## SYNOPSIS +Deletes the specified flow log resource. + +## SYNTAX + +### SetByName (Default) +``` +Remove-AzNetworkWatcherFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResource +``` +Remove-AzNetworkWatcherFlowLog -NetworkWatcher <PSNetworkWatcher> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +Remove-AzNetworkWatcherFlowLog -Location <String> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Remove-AzNetworkWatcherFlowLog -ResourceId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObject +``` +Remove-AzNetworkWatcherFlowLog -InputObject <PSFlowLogResource> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified flow log resource. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzNetworkWatcherFlowLog -Location eastus -Name pstest +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Flow log object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFlowLogResource +Parameter Sets: SetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The flow log name. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: FlowLogName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSFlowLogResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherFlowLog](./New-AzNetworkWatcherFlowLog.md) + +[Set-AzNetworkWatcherFlowLog](./Set-AzNetworkWatcherFlowLog.md) + +[Get-AzNetworkWatcherFlowLog](./Get-AzNetworkWatcherFlowLog.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzNetworkWatcherPacketCapture.md b/azps-10.1.0/Az.Network/Remove-AzNetworkWatcherPacketCapture.md new file mode 100644 index 0000000000..75f2297696 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzNetworkWatcherPacketCapture.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-aznetworkwatcherpacketcapture +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkWatcherPacketCapture.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzNetworkWatcherPacketCapture.md +--- + +# Remove-AzNetworkWatcherPacketCapture + +## SYNOPSIS +Removes a packet capture resource. + +## SYNTAX + +### SetByResource (Default) +``` +Remove-AzNetworkWatcherPacketCapture -NetworkWatcher <PSNetworkWatcher> -PacketCaptureName <String> [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByName +``` +Remove-AzNetworkWatcherPacketCapture -NetworkWatcherName <String> -ResourceGroupName <String> + -PacketCaptureName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +Remove-AzNetworkWatcherPacketCapture -Location <String> -PacketCaptureName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzNetworkWatcherPacketCapture removes a packet capture resource. +It is recommended to call Stop-AzNetworkWatcherPacketCapture before calling Remove-AzNetworkWatcherPacketCapture. +If the packet capture session is running when Remove-AzNetworkWatcherPacketCapture is called the packet capture may not be saved. If the session is stopped prior to removal the .cap file containing capture data is not removed. + +## EXAMPLES + +### Example 1: Remove a packet capture session +```powershell +Remove-AzNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -PacketCaptureName "PacketCaptureTest" +``` + +In this example we remove an existing packet capture session named "PacketCaptureTest". + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PacketCaptureName +The packet capture name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. + +```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 network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic, remove + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzP2sVpnGateway.md b/azps-10.1.0/Az.Network/Remove-AzP2sVpnGateway.md new file mode 100644 index 0000000000..ec6506c358 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzP2sVpnGateway.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azp2svpngateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzP2sVpnGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzP2sVpnGateway.md +--- + +# Remove-AzP2sVpnGateway + +## SYNOPSIS +Removes an existing P2SVpnGateway. + +## SYNTAX + +### ByP2SVpnGatewayName (Default) +``` +Remove-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayObject +``` +Remove-AzP2sVpnGateway -InputObject <PSP2SVpnGateway> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayResourceId +``` +Remove-AzP2sVpnGateway -ResourceId <String> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzP2sVpnGateway** cmdlet enables you to remove an existing P2SVpnGateway under VirtualHub. All the point to site clients connectivity will fail after P2SVpnGateway is removed. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzP2sVpnGateway -Name 683482ade8564515aed4b8448c9757ea-westus-gw -ResourceGroupName P2SCortexGATesting -Force -PassThru +``` + +The **Remove-AzP2sVpnGateway** cmdlet enables you to remove an existing P2SVpnGateway under VirtualHub. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The p2sVpnGateway object to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +Parameter Sets: ByP2SVpnGatewayObject +Aliases: P2SVpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The P2SVpnGateway name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayName +Aliases: ResourceName, P2SVpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID for the p2sVpnGateway to be deleted. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayResourceId +Aliases: p2sVpnGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzPrivateDnsZoneGroup.md b/azps-10.1.0/Az.Network/Remove-AzPrivateDnsZoneGroup.md new file mode 100644 index 0000000000..fa9a3795ba --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzPrivateDnsZoneGroup.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azprivatednszonegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzPrivateDnsZoneGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzPrivateDnsZoneGroup.md +--- + +# Remove-AzPrivateDnsZoneGroup + +## SYNOPSIS +Removes a DNS zone group. + +## SYNTAX + +``` +Remove-AzPrivateDnsZoneGroup -ResourceGroupName <String> -PrivateEndpointName <String> -Name <String> [-Force] + [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPrivateDnsZoneGroup** cmdlet removes a DNS zone group. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzPrivateDnsZoneGroup -ResourceGroupName "rg" -PrivateEndpointName "test-pr-endpoint" -name dnsgroup1 +``` + +Above example removes a DNS zone grup named dnsgroup1 from endpoint test-pr-endpoint. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to delete resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the private dns zone group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PrivateDnsZoneGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateEndpointName +The name of the private endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzPrivateEndpoint.md b/azps-10.1.0/Az.Network/Remove-AzPrivateEndpoint.md new file mode 100644 index 0000000000..6b09c7220e --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzPrivateEndpoint.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azprivateendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzPrivateEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzPrivateEndpoint.md +--- + +# Remove-AzPrivateEndpoint + +## SYNOPSIS +Removes a private endpoint. + +## SYNTAX + +``` +Remove-AzPrivateEndpoint -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPrivateEndpoint** cmdlet removes a private endpoint. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzPrivateEndpoint -Name MyPrivateEndpoint1 -ResourceGroupName TestResourceGroup +``` + +This example remove a private endpoint named MyPrivateEndpoint1. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to delete resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the private endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the private endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzPrivateEndpoint](./Get-AzPrivateEndpoint.md) + +[New-AzPrivateEndpoint](./New-AzPrivateEndpoint.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzPrivateEndpointConnection.md b/azps-10.1.0/Az.Network/Remove-AzPrivateEndpointConnection.md new file mode 100644 index 0000000000..78ce522133 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzPrivateEndpointConnection.md @@ -0,0 +1,248 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzPrivateEndpointConnection.md +--- + +# Remove-AzPrivateEndpointConnection + +## SYNOPSIS +Removes a private endpoint connection. + +## SYNTAX + +### ByResourceId (Default) +``` +Remove-AzPrivateEndpointConnection [-Description <String>] [-Force] [-AsJob] [-PassThru] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResource +``` +Remove-AzPrivateEndpointConnection -Name <String> [-Description <String>] [-Force] [-AsJob] [-PassThru] + -ResourceGroupName <String> -ServiceName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] -PrivateLinkResourceType <String> [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPrivateEndpointConnection** cmdlet removes a private endpoint connection. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzPrivateEndpointConnection -Name MyPrivateEndpointConnection1 -ResourceGroupName TestResourceGroup -ServiceName MyPrivateLinkServiceName -PrivateLinkResourceType Microsoft.Network/privateLinkServices +``` + +This example remove a private endpoint connection named MyPrivateEndpointConnection1 + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The reason of action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to delete resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkResourceType +The private link resource type. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: +Accepted values: Microsoft.AgFoodPlatform/farmBeats, Microsoft.ApiManagement/service, Microsoft.AppConfiguration/configurationStores, Microsoft.Attestation/attestationProviders, Microsoft.Authorization/resourceManagementPrivateLinks, Microsoft.Automation/automationAccounts, Microsoft.Batch/batchAccounts, Microsoft.Cache/Redis, Microsoft.Cache/redisEnterprise, Microsoft.CognitiveServices/accounts, Microsoft.Compute/diskAccesses, Microsoft.ContainerRegistry/registries, Microsoft.ContainerService/managedClusters, Microsoft.Databricks/workspaces, Microsoft.DataFactory/factories, Microsoft.DBforMariaDB/servers, Microsoft.DBforMySQL/servers, Microsoft.DBforPostgreSQL/servers, Microsoft.DesktopVirtualization/hostpools, Microsoft.DesktopVirtualization/workspaces, Microsoft.Devices/IotHubs, Microsoft.Devices/ProvisioningServices, Microsoft.DeviceUpdate/accounts, Microsoft.DigitalTwins/digitalTwinsInstances, Microsoft.DocumentDB/databaseAccounts, Microsoft.EventGrid/topics, Microsoft.EventGrid/domains, Microsoft.EventHub/namespaces, Microsoft.HardwareSecurityModules/cloudHsmClusters, Microsoft.HealthcareApis/services, Microsoft.HDInsight/clusters, Microsoft.HybridCompute/privateLinkScopes, Microsoft.Insights/privateLinkScopes, Microsoft.KeyVault/vaults, Microsoft.Keyvault/managedHSMs, Microsoft.MachineLearningServices/workspaces, Microsoft.MachineLearningServices/registries, Microsoft.Media/mediaservices, Microsoft.Media/videoanalyzers, Microsoft.Migrate/assessmentProjects, Microsoft.Migrate/migrateProjects, Microsoft.Monitor/accounts, Microsoft.Network/applicationgateways, Microsoft.Network/privateLinkServices, Microsoft.OffAzure/masterSites, Microsoft.PowerBI/privateLinkServicesForPowerBI, Microsoft.Purview/accounts, Microsoft.RecoveryServices/vaults, Microsoft.Relay/namespaces, Microsoft.Search/searchServices, Microsoft.ServiceBus/namespaces, Microsoft.SignalRService/signalr, Microsoft.SignalRService/webPubSub, Microsoft.Sql/servers, Microsoft.Storage/storageAccounts, Microsoft.StorageSync/storageSyncServices, Microsoft.Synapse/privateLinkHubs, Microsoft.Synapse/workspaces, Microsoft.Web/sites, Microsoft.Web/staticSites, Microsoft.Web/hostingEnvironments, Microsoft.BotService/botServices, Microsoft.OpenEnergyPlatform/energyServices, Microsoft.DBforMySQL/flexibleServers + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource manager id of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +The name of service that the private endpoint connection belong to. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Approve-AzPrivateEndpointConnection](./Approve-AzPrivateEndpointConnection.md) + +[Deny-AzPrivateEndpointConnection](./Deny-AzPrivateEndpointConnection.md) + +[Get-AzPrivateEndpointConnection](./Get-AzPrivateEndpointConnection.md) + +[Set-AzPrivateEndpointConnection](./Set-AzPrivateEndpointConnection.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzPrivateLinkService.md b/azps-10.1.0/Az.Network/Remove-AzPrivateLinkService.md new file mode 100644 index 0000000000..75d6cec62a --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzPrivateLinkService.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azprivatelinkservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzPrivateLinkService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzPrivateLinkService.md +--- + +# Remove-AzPrivateLinkService + +## SYNOPSIS +Removes a private link service + +## SYNTAX + +``` +Remove-AzPrivateLinkService -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPrivateLinkService** cmdlet removes a private link service + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzPrivateLinkService -ResourceGroupName TestResourceGroup -Name TestPrivateLinkService +``` + +This example removes a private link service named TestPrivateLinkService. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to delete resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the private link service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzPrivateLinkService](./Get-AzPrivateLinkService.md) + +[New-AzPrivateLinkService](./New-AzPrivateLinkService.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzPublicIpAddress.md b/azps-10.1.0/Az.Network/Remove-AzPublicIpAddress.md new file mode 100644 index 0000000000..fa19136a17 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzPublicIpAddress.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 00236BC2-61D8-49C2-91BE-923C567153F3 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azpublicipaddress +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzPublicIpAddress.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzPublicIpAddress.md +--- + +# Remove-AzPublicIpAddress + +## SYNOPSIS +Removes a public IP address. + +## SYNTAX + +``` +Remove-AzPublicIpAddress -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPublicIpAddress** cmdlet removes an Azure public IP address. + +## EXAMPLES + +### 1: Remove a public IP address resource +```powershell +Remove-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName +``` + +This command removes the public IP address resource named $publicIpName in the resource group $rgName. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the public IP address that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the public IP address that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzPublicIpAddress](./Get-AzPublicIpAddress.md) + +[New-AzPublicIpAddress](./New-AzPublicIpAddress.md) + +[Set-AzPublicIpAddress](./Set-AzPublicIpAddress.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzPublicIpPrefix.md b/azps-10.1.0/Az.Network/Remove-AzPublicIpPrefix.md new file mode 100644 index 0000000000..be24be9985 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzPublicIpPrefix.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azpublicipprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzPublicIpPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzPublicIpPrefix.md +--- + +# Remove-AzPublicIpPrefix + +## SYNOPSIS +Removes a public IP prefix + +## SYNTAX + +### RemoveByNameParameterSet (Default) +``` +Remove-AzPublicIpPrefix -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzPublicIpPrefix -ResourceId <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzPublicIpPrefix -InputObject <PSPublicIpPrefix> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPublicIpPrefix** cmdlet removes an Azure public IP prefix as long as there are no public IP addresses allocated from it. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzPublicIpPrefix -Name $prefixName -ResourceGroupName $rgName +``` + +Removes the public IP prefix with Name $prefixName from resource group $rgName + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +A PublicIpPrefix object + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resourceId for the resource to remove + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzPublicIpPrefix](./Get-AzPublicIpPrefix.md) + +[New-AzPublicIpPrefix](./New-AzPublicIpPrefix.md) + +[Set-AzPublicIpPrefix](./Set-AzPublicIpPrefix.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzRouteConfig.md b/azps-10.1.0/Az.Network/Remove-AzRouteConfig.md new file mode 100644 index 0000000000..96e677bcad --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzRouteConfig.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 03285628-6BD3-4F2F-8129-E3CAE4C70EC8 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azrouteconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteConfig.md +--- + +# Remove-AzRouteConfig + +## SYNOPSIS +Removes a route from a route table. + +## SYNTAX + +``` +Remove-AzRouteConfig -RouteTable <PSRouteTable> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRouteConfig** cmdlet removes a route from an Azure route table. + +## EXAMPLES + +### Example 1: Remove a route +```powershell +Get-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Remove-AzRouteConfig -Name "Route02" | Set-AzRouteTable +``` + +```output +Name : RouteTable01 +ResourceGroupName : ResourceGroup11 +Location : eastus +Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ + k/routeTables/RouteTable01 +Etag : W/"47099b62-60ec-4bc1-b87b-fad56cb8bed1" +ProvisioningState : Succeeded +Tags : +Routes : [ + { + "Name": "Route07", + "Etag": "W/\"47099b62-60ec-4bc1-b87b-fad56cb8bed1\"", + "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro + soft.Network/routeTables/RouteTable01/routes/Route07", + "AddressPrefix": "10.1.0.0/16", + "NextHopType": "VnetLocal", + "NextHopIpAddress": null, + "ProvisioningState": "Succeeded" + } + ] +Subnets : [] +``` + +This command gets the route table named RouteTable01 by using the **Get-AzRouteTable** cmdlet. +The command passes that table to the current cmdlet by using the pipeline operator. +The current cmdlet remove the route named Route02, and the passes the result to the **Set-AzRouteTable** cmdlet, which updates the table to reflect your changes. +The table no longer contains the route named Route02. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the route that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteTable +Specifies the route table that contains the route that this cmdlet deletes. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +## NOTES + +## RELATED LINKS + +[Add-AzRouteConfig](./Add-AzRouteConfig.md) + +[Get-AzRouteConfig](./Get-AzRouteConfig.md) + +[New-AzRouteConfig](./New-AzRouteConfig.md) + +[Set-AzRouteConfig](./Set-AzRouteConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzRouteFilter.md b/azps-10.1.0/Az.Network/Remove-AzRouteFilter.md new file mode 100644 index 0000000000..a44f138f07 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzRouteFilter.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azroutefilter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteFilter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteFilter.md +--- + +# Remove-AzRouteFilter + +## SYNOPSIS +Removes a route filter. + +## SYNTAX + +``` +Remove-AzRouteFilter -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRouteFilter** cmdlet removes a route filter. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzRouteFilter -Name "RouteFilter01" -ResourceGroupName "ResourceGroup01" +``` + +The command removes the route filter named RouteFilter01 in the resource group named ResourceGroup01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzRouteFilter](./Get-AzRouteFilter.md) + +[New-AzRouteFilter](./New-AzRouteFilter.md) + +[Set-AzRouteFilter](./Set-AzRouteFilter.md) + +[Add-AzRouteFilterRuleConfig](./Add-AzRouteFilterRuleConfig.md) + +[Get-AzRouteFilterRuleConfig](./Get-AzRouteFilterRuleConfig.md) + +[New-AzRouteFilterRuleConfig](./New-AzRouteFilterRuleConfig.md) + +[Remove-AzRouteFilterRuleConfig](./Remove-AzRouteFilterRuleConfig.md) + +[Set-AzRouteFilterRuleConfig](./Set-AzRouteFilterRuleConfig.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzRouteFilterRuleConfig.md b/azps-10.1.0/Az.Network/Remove-AzRouteFilterRuleConfig.md new file mode 100644 index 0000000000..85fcc68aa2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzRouteFilterRuleConfig.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azroutefilterruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteFilterRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteFilterRuleConfig.md +--- + +# Remove-AzRouteFilterRuleConfig + +## SYNOPSIS +Removes a route filter rule from a route filter. + +## SYNTAX + +``` +Remove-AzRouteFilterRuleConfig -Name <String> -RouteFilter <PSRouteFilter> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRouteFilterRuleConfig** cmdlet removes a route filter rule from a route filter. + +## EXAMPLES + +### Example 1 +```powershell +$rf = Get-AzRouteFilter -Name "RouteFilter01" -ResourceGroupName "ResourceGroup01" +Remove-AzRouteFilterRuleConfig -RouteFilter $rf -Name "Rule01" +``` + +The first command gets a route filter named RouteFilter01 that belongs to the resource group named ResourceGroup01 and stores it in the $rf variable. +The second command removes the route filter rule named Rule01 from the route filter stored in $rf. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the route filter rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteFilter +The RouteFilter + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilter + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule + +## NOTES + +## RELATED LINKS + +[Add-AzRouteFilterRuleConfig](./Add-AzRouteFilterRuleConfig.md) + +[Get-AzRouteFilterRuleConfig](./Get-AzRouteFilterRuleConfig.md) + +[New-AzRouteFilterRuleConfig](./New-AzRouteFilterRuleConfig.md) + +[Set-AzRouteFilterRuleConfig](./Set-AzRouteFilterRuleConfig.md) + +[Get-AzRouteFilter](./Get-AzRouteFilter.md) + +[New-AzRouteFilter](./New-AzRouteFilter.md) + +[Remove-AzRouteFilter](./Remove-AzRouteFilter.md) + +[Set-AzRouteFilter](./Set-AzRouteFilter.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzRouteMap.md b/azps-10.1.0/Az.Network/Remove-AzRouteMap.md new file mode 100644 index 0000000000..b9d439bddc --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzRouteMap.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azroutemap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteMap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteMap.md +--- + +# Remove-AzRouteMap + +## SYNOPSIS +Remove a route map from a VirtualHub. + +## SYNTAX + +### ByRouteMapName (Default) +``` +Remove-AzRouteMap [-ResourceGroupName <String>] [-VirtualHubName <String>] [-Name <String>] [-AsJob] [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Remove-AzRouteMap [-Name <String>] [-VirtualHubObject <PSVirtualHub>] [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRouteMapObject +``` +Remove-AzRouteMap [-InputObject <PSRouteMap>] [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRouteMapResourceId +``` +Remove-AzRouteMap [-ResourceId <String>] [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a route map from a VirtualHub. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" + +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" + +# creating new route map rules and a new route map resource and new routing configuration +$routeMapMatchCriterion1 = New-AzRouteMapRuleCriterion -MatchCondition "Contains" -RoutePrefix @("10.0.0.0/16") +$routeMapActionParameter1 = New-AzRouteMapRuleActionParameter -AsPath @("12345") +$routeMapAction1 = New-AzRouteMapRuleAction -Type "Add" -Parameter @($routeMapActionParameter1) +$routeMapRule1 = New-AzRouteMapRule -Name "rule1" -MatchCriteria @($routeMapMatchCriterion1) -RouteMapRuleAction @($routeMapAction1) -NextStepIfMatched "Continue" + +$routeMapMatchCriterion2 = New-AzRouteMapRuleCriterion -MatchCondition "Equals" -AsPath @("12345") +$routeMapAction2 = New-AzRouteMapRuleAction -Type "Drop" +$routeMapRule2 = New-AzRouteMapRule -Name "rule2" -MatchCriteria @($routeMapMatchCriterion2) -RouteMapRuleAction @($routeMapAction2) -NextStepIfMatched "Terminate" + +New-AzRouteMap -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteMap" -RouteMapRule @($routeMapRule1, $routeMapRule2) +$routeMap1 = Get-AzRouteMap -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteMap" +Remove-AzRouteMap -InputObject $routeMap1 +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The route map object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteMap +Parameter Sets: ByRouteMapObject +Aliases: RouteMap + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The route map name. + +```yaml +Type: System.String +Parameter Sets: ByRouteMapName, ByVirtualHubObject +Aliases: ResourceName, RouteMapName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByRouteMapName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Route Map Resource Id. + +```yaml +Type: System.String +Parameter Sets: ByRouteMapResourceId +Aliases: RouteMapId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualHubName +The Virtual Hub name. + +```yaml +Type: System.String +Parameter Sets: ByRouteMapName +Aliases: ParentVirtualHubName, ParentResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubObject +The Virtual Hub Object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub, ParentVirtualHub + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteMap + +### System.String + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-AzRouteMap](./New-AzRouteMap.md) + +[New-AzRouteMapRule](./New-AzRouteMapRule.md) + +[Get-AzRouteMap](./Get-AzRouteMap.md) + +[Update-AzRouteMap](./Update-AzRouteMap.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzRouteServer.md b/azps-10.1.0/Az.Network/Remove-AzRouteServer.md new file mode 100644 index 0000000000..97501f7e50 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzRouteServer.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azrouteserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteServer.md +--- + +# Remove-AzRouteServer + +## SYNOPSIS +Deletes an Azure RouteServer. + +## SYNTAX + +### RouteServerNameParameterSet (Default) +``` +Remove-AzRouteServer -ResourceGroupName <String> -RouteServerName <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RouteServerInputObjectParameterSet +``` +Remove-AzRouteServer -InputObject <PSRouteServer> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RouteServerResourceIdParameterSet +``` +Remove-AzRouteServer -ResourceId <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRouteServer** cmdlet deletes an Azure RouteServer + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzRouteServer -ResourceGroupName routeServerRG -RouteServerName routeServer +``` + +### Example 2 +```powershell +$routeServerId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/routeServerRG/providers/Microsoft.Network/virtualHubs/routeServer' +Remove-AzRouteServer -ResourceId $routeServerId +``` + +### Example 3 +```powershell +$routeServer = Get-AzRouteServer -ResourceGroupName routeServerRG -RouteServerName routeServer +Remove-AzRouteServer -InputObject $routeServer +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The route server input object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteServer +Parameter Sets: RouteServerInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the route server. + +```yaml +Type: System.String +Parameter Sets: RouteServerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The route server resource Id. + +```yaml +Type: System.String +Parameter Sets: RouteServerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteServerName +The name of the route server. + +```yaml +Type: System.String +Parameter Sets: RouteServerNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSRouteServer + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzRouteServerPeer.md b/azps-10.1.0/Az.Network/Remove-AzRouteServerPeer.md new file mode 100644 index 0000000000..611ee6e11d --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzRouteServerPeer.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azrouteserverpeer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteServerPeer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteServerPeer.md +--- + +# Remove-AzRouteServerPeer + +## SYNOPSIS +Removes a Peer from an Azure RouteServer + +## SYNTAX + +### RouteServerNPeerNameParameterSet (Default) +``` +Remove-AzRouteServerPeer -ResourceGroupName <String> -PeerName <String> -RouteServerName <String> [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RouteServerNPeerInputObjectParameterSet +``` +Remove-AzRouteServerPeer -InputObject <PSRouteServerPeer> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RouteServerNPeerResourceIdParameterSet +``` +Remove-AzRouteServerPeer -ResourceId <String> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRouteServerPeer** cmdlet removes a RouteServer Peer from an Azure RouteServer + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzRouteServerPeer -PeerName peer -RouteServerName routeServer -ResourceGroupName routeServerRG +``` + +### Example 2 +```powershell +$routeServerPeerId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/routeServerRG/providers/Microsoft.Network/virtualHubs/routeServer/bgpConnections/peer' +Remove-AzRouteServerPeer -ResourceId $RouteServerPeerId +``` + +### Example 3 +```powershell +$routeServerPeer = Get-AzRouteServerPeer -ResourceGroupName routeServerRG -RouteServerName routeServer -PeerName peer +Remove-AzRouteServerPeer -InputObject $RouteServerPeer +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The route server peer input object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteServerPeer +Parameter Sets: RouteServerNPeerInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PeerName +The name of the route server Peer. + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the route server/peer. + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The route server peer resource Id. + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteServerName +The route server where peer exists. + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSRouteServerPeer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteServer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzRouteTable.md b/azps-10.1.0/Az.Network/Remove-AzRouteTable.md new file mode 100644 index 0000000000..453dd3ca4a --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzRouteTable.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: FDA33633-EB2E-4095-8498-DF8910F1D434 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRouteTable.md +--- + +# Remove-AzRouteTable + +## SYNOPSIS +Removes a route table. + +## SYNTAX + +``` +Remove-AzRouteTable -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRouteTable** cmdlet removes an Azure route table. + +## EXAMPLES + +### Example 1: Remove a route table +```powershell +Remove-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" +``` + +```output +Confirm +Are you sure you want to remove resource 'RouteTable01' +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +``` + +This command removes the route table named RouteTable01 in the resource group named ResourceGroup11. +The cmdlet prompts you for confirmation before it removes the table. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the route table that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the route table that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzRouteTable](./Get-AzRouteTable.md) + +[New-AzRouteTable](./New-AzRouteTable.md) + +[Set-AzRouteTable](./Set-AzRouteTable.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzRoutingIntent.md b/azps-10.1.0/Az.Network/Remove-AzRoutingIntent.md new file mode 100644 index 0000000000..b0f41ec0e7 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzRoutingIntent.md @@ -0,0 +1,260 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azroutingintent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRoutingIntent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRoutingIntent.md +--- + +# Remove-AzRoutingIntent + +## SYNOPSIS +Delete a routing intent resource associated with a VirtualHub. + +## SYNTAX + +### ByRoutingIntentName (Default) +``` +Remove-AzRoutingIntent -ResourceGroupName <String> -ParentResourceName <String> -Name <String> [-AsJob] + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Remove-AzRoutingIntent -Name <String> -ParentObject <PSVirtualHub> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRoutingIntentObject +``` +Remove-AzRoutingIntent -InputObject <PSRoutingIntent> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRoutingIntentResourceId +``` +Remove-AzRoutingIntent -ResourceId <String> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified routing intent that is associated with the specified virtual hub. + +## EXAMPLES + +### Example 1 +```powershell +$testRoutingIntent = Get-AzRoutingIntent -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRoutingIntent" +Remove-AzRoutingIntent -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRoutingIntent" +``` + +This command deletes the routing intent of the virtual hub. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The RoutingIntent resource to remove. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingIntent +Parameter Sets: ByRoutingIntentObject +Aliases: RoutingIntent + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByRoutingIntentName, ByVirtualHubObject +Aliases: ResourceName, RoutingIntentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The parent virtual hub object of this resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByRoutingIntentName +Aliases: VirtualHubName, ParentVirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByRoutingIntentName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the RoutingIntent resource to remove. + +```yaml +Type: System.String +Parameter Sets: ByRoutingIntentResourceId +Aliases: RoutingIntentId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### Microsoft.Azure.Commands.Network.Models.PSRoutingIntent + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzRoutingIntent](./Get-AzRoutingIntent.md) + +[New-AzRoutingIntent](./New-AzRoutingIntent.md) + +[Set-AzRoutingIntent](./Set-AzRoutingIntent.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzRoutingPolicy.md b/azps-10.1.0/Az.Network/Remove-AzRoutingPolicy.md new file mode 100644 index 0000000000..5440711942 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzRoutingPolicy.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azroutingpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRoutingPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzRoutingPolicy.md +--- + +# Remove-AzRoutingPolicy + +## SYNOPSIS +Removes the specified routing policy from a routing intent resource associated with a VirtualHub. + +## SYNTAX + +``` +Remove-AzRoutingPolicy -RoutingIntent <PSRoutingIntent> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes the specified routing Policy that is associated with the specified routing intent object and returns an in-memory routing intent object which can be piped to [Set-AzRoutingIntent](./Set-AzRoutingIntent.md) to update the actual routing intent resource. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" + +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" + +$fwIp = New-AzFirewallHubPublicIpAddress -Count 1 +$hubIpAddresses = New-AzFirewallHubIpAddress -PublicIP $fwIp + +New-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" -Location "westcentralus" -Sku AZFW_Hub -VirtualHubId $virtualHub.Id -HubIPAddress $hubIpAddresses +$firewall = Get-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" + +$policy1 = New-AzRoutingPolicy -Name "PrivateTraffic" -Destination @("PrivateTraffic") -NextHop $firewall.Id +$policy2 = New-AzRoutingPolicy -Name "PublicTraffic" -Destination @("Internet") -NextHop $firewall.Id + +New-AzRoutingIntent -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRoutingIntent" -RoutingPolicy @($policy1, $policy2) +$routingIntent = Get-AzRoutingIntent -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRoutingIntent" + +Remove-AzRoutingPolicy -Name "PrivateTraffic" -RoutingIntent $routingIntent +Set-AzRoutingIntent -InputObject $routingIntent +``` + +```output +ProvisioningState : Succeeded +RoutingPolicies : {PublicTraffic} +RoutingPoliciesText : [ + { + "Name": "PublicTraffic", + "DestinationType": "TrafficType", + "Destinations": [ + "Internet" + ], + "NextHopType": "ResourceId", + "NextHop": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall" + } + ] +Name : routingIntent1 +Etag : W/"etag" +Id : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub1/routingIntent/routingIntent1 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The policy name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingIntent +The routing intent object from which this rouing policy has to be removed. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingIntent +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRoutingIntent + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRoutingIntent + +## NOTES + +## RELATED LINKS + +[Add-AzRoutingPolicy](./Add-AzRoutingPolicy.md) + +[Get-AzRoutingIntent](./Get-AzRoutingIntent.md) + +[Get-AzRoutingPolicy](./Get-AzRoutingPolicy.md) + +[New-AzRoutingIntent](./New-AzRoutingIntent.md) + +[New-AzRoutingPolicy](./New-AzRoutingPolicy.md) + +[Remove-AzRoutingIntent](./Remove-AzRoutingIntent.md) + +[Set-AzRoutingIntent](./Set-AzRoutingIntent.md) + +[Set-AzRoutingPolicy](./Set-AzRoutingPolicy.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzSecurityPartnerProvider.md b/azps-10.1.0/Az.Network/Remove-AzSecurityPartnerProvider.md new file mode 100644 index 0000000000..7ab320e872 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzSecurityPartnerProvider.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azsecuritypartnerprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzSecurityPartnerProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzSecurityPartnerProvider.md +--- + +# Remove-AzSecurityPartnerProvider + +## SYNOPSIS +Deletes an Azure SecurityPartnerProvider. + +## SYNTAX + +### SecurityPartnerProviderNameParameterSet (Default) +``` +Remove-AzSecurityPartnerProvider -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SecurityPartnerProviderInputObjectParameterSet +``` +Remove-AzSecurityPartnerProvider -SecurityPartnerProvider <PSSecurityPartnerProvider> [-Force] [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SecurityPartnerProviderResourceIdParameterSet +``` +Remove-AzSecurityPartnerProvider -ResourceId <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSecurityPartnerProvider** cmdlet deletes an Azure SecurityPartnerProvider + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSecurityPartnerProvider -ResourceGroupName securityPartnerProviderRG -Name securityPartnerProvider +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: SecurityPartnerProviderNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: SecurityPartnerProviderNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The securityPartnerProvider resource Id. + +```yaml +Type: System.String +Parameter Sets: SecurityPartnerProviderResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecurityPartnerProvider +The securityPartnerProvider input object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSecurityPartnerProvider +Parameter Sets: SecurityPartnerProviderInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSSecurityPartnerProvider + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzServiceEndpointPolicy.md b/azps-10.1.0/Az.Network/Remove-AzServiceEndpointPolicy.md new file mode 100644 index 0000000000..0774a5aa87 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzServiceEndpointPolicy.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azserviceendpointpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzServiceEndpointPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzServiceEndpointPolicy.md +--- + +# Remove-AzServiceEndpointPolicy + +## SYNOPSIS +Removes a service endpoint policy. + +## SYNTAX + +### RemoveByNameParameterSet (Default) +``` +Remove-AzServiceEndpointPolicy -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzServiceEndpointPolicy -ResourceId <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzServiceEndpointPolicy -InputObject <PSServiceEndpointPolicy> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzServiceEndpointPolicy** cmdlet removes a service endpoint policy. + +## EXAMPLES + +### Example 1: Removes a service endpoint policy using name +```powershell +Remove-AzServiceEndpointPolicy -Name "Policy1" -ResourceGroupName "resourcegroup1" +``` + +This command removes a service endpoint policy with name Policy1 which belongs to resourcegroup with name "resourcegroup1" + +### Example 2: Remove a service endpoint policy using input object +```powershell +Remove-AzServiceEndpointPolicy -InputObject $Policy1 +``` + +This command removes a service endpoint policy object Policy1 which belongs to resourcegroup with name "resourcegroup1" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The service endpoint policy object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the service endpoint policy + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The ID of service endpoint policy. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzServiceEndpointPolicy](./Get-AzServiceEndpointPolicy.md) + +[New-AzServiceEndpointPolicy](./New-AzServiceEndpointPolicy.md) + +[Set-AzServiceEndpointPolicy](./Set-AzServiceEndpointPolicy.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzServiceEndpointPolicyDefinition.md b/azps-10.1.0/Az.Network/Remove-AzServiceEndpointPolicyDefinition.md new file mode 100644 index 0000000000..16917071aa --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzServiceEndpointPolicyDefinition.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azserviceendpointpolicydefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzServiceEndpointPolicyDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzServiceEndpointPolicyDefinition.md +--- + +# Remove-AzServiceEndpointPolicyDefinition + +## SYNOPSIS +Removes a service endpoint policy definition. + +## SYNTAX + +### RemoveByNameParameterSet (Default) +``` +Remove-AzServiceEndpointPolicyDefinition [-Name <String>] -ServiceEndpointPolicy <PSServiceEndpointPolicy> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzServiceEndpointPolicyDefinition -ResourceId <String> -ServiceEndpointPolicy <PSServiceEndpointPolicy> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzServiceEndpointPolicyDefinition -InputObject <PSServiceEndpointPolicyDefinition> + -ServiceEndpointPolicy <PSServiceEndpointPolicy> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzServiceEndpointPolicy** cmdlet removes a service endpoint policy. + +## EXAMPLES + +### Example 1: Removes a service endpoint policy using name +```powershell +Remove-AzServiceEndpointPolicyDefinition -Name "PolicyDef1" +``` + +This command removes a service endpoint policy with name PolicyDef1 + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The service endpoint policy definition object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicyDefinition +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the service endpoint definition + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The ID of the service endpoint definition. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceEndpointPolicy +The ServiceEndpointPolicy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicyDefinition + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy + +## NOTES + +## RELATED LINKS + +[Add-AzServiceEndpointPolicyDefinition](./Add-AzServiceEndpointPolicyDefinition.md) + +[Get-AzServiceEndpointPolicyDefinition](./Get-AzServiceEndpointPolicyDefinition.md) + +[New-AzServiceEndpointPolicyDefinition](./New-AzServiceEndpointPolicyDefinition.md) + +[Set-AzServiceEndpointPolicyDefinition](./Set-AzServiceEndpointPolicyDefinition.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzVHubRouteTable.md b/azps-10.1.0/Az.Network/Remove-AzVHubRouteTable.md new file mode 100644 index 0000000000..d226c5d45a --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVHubRouteTable.md @@ -0,0 +1,262 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvhubroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVHubRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVHubRouteTable.md +--- + +# Remove-AzVHubRouteTable + +## SYNOPSIS +Delete a hub route table resource associated with a VirtualHub. + +## SYNTAX + +### ByVHubRouteTableName (Default) +``` +Remove-AzVHubRouteTable -ResourceGroupName <String> -ParentResourceName <String> -Name <String> [-AsJob] + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Remove-AzVHubRouteTable -Name <String> -ParentObject <PSVirtualHub> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVHubRouteTableObject +``` +Remove-AzVHubRouteTable -InputObject <PSVHubRouteTable> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVHubRouteTableResourceId +``` +Remove-AzVHubRouteTable -ResourceId <String> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified hub route table that is associated with the specified virtual hub. + +## EXAMPLES + +### Example 1 +```powershell +$testRouteTable = Get-AzVHubRouteTable -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteTable" +Remove-AzVHubRouteTable -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteTable" +``` + +This command deletes the hub route table of the virtual hub. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The vhubroutetable resource to remove. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVHubRouteTable +Parameter Sets: ByVHubRouteTableObject +Aliases: VHubRouteTable, RouteTable + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVHubRouteTableName, ByVirtualHubObject +Aliases: ResourceName, VHubRouteTableName, RouteTableName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The parent virtual hub object of this resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVHubRouteTableName +Aliases: VirtualHubName, ParentVirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVHubRouteTableName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the vhubroutetable resource to remove. + +```yaml +Type: System.String +Parameter Sets: ByVHubRouteTableResourceId +Aliases: VHubRouteTableId, RouteTableId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### Microsoft.Azure.Commands.Network.Models.PSVHubRouteTable + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzVHubRouteTable](./Get-AzVHubRouteTable.md) + +[New-AzVHubRoute](./New-AzVHubRoute.md) + +[New-AzVHubRouteTable](./New-AzVHubRouteTable.md) + +[Update-AzVHubRouteTable](./Update-AzVHubRouteTable.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualApplianceSite.md b/azps-10.1.0/Az.Network/Remove-AzVirtualApplianceSite.md new file mode 100644 index 0000000000..697d5f5a74 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualApplianceSite.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualappliancesite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualApplianceSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualApplianceSite.md +--- + +# Remove-AzVirtualApplianceSite + +## SYNOPSIS +Remove a virtual appliance site from a Network Virtual Appliance resource. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Remove-AzVirtualApplianceSite -Name <String> -NetworkVirtualApplianceId <String> -ResourceGroupName <String> + [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzVirtualApplianceSite -ResourceId <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceObjectParameterSet +``` +Remove-AzVirtualApplianceSite -VirtualApplianceSite <PSVirtualApplianceSite> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzVirtualApplianceSite command removes a Virtual Appliance site from a Network Virtual Appliance resource. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzVirtualApplianceSite -Name testsite -ResourceGroupName testrg -NetworkVirtualApplianceId $nva.Id +``` + +Delete a Virtual Appliance site resource. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkVirtualApplianceId +The resource ID of the Network Virtual Appliance associated with this site. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualApplianceSite +The virtual appliance site object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceSite +Parameter Sets: ResourceObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceSite + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualHub.md b/azps-10.1.0/Az.Network/Remove-AzVirtualHub.md new file mode 100644 index 0000000000..30ec8148d1 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualHub.md @@ -0,0 +1,254 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualHub.md +--- + +# Remove-AzVirtualHub + +## SYNOPSIS +Removes an Azure VirtualHub resource. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +Remove-AzVirtualHub -ResourceGroupName <String> -Name <String> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +Remove-AzVirtualHub -ResourceId <String> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Remove-AzVirtualHub -InputObject <PSVirtualHub> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure VirtualHub resource. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +Remove-AzVirtualHub -ResourceGroupName "testRG" -Name "westushub" +``` + +The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". + +It then deletes the virtual hub using its ResourceGroupName and ResourceName. + +### Example 2 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +Remove-AzVirtualHub -InputObject $virtualHub +``` + +The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". + +It then deletes the virtual hub using an input object. The input object is of type PSVirtualHub. + +### Example 3 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +Get-AzVirtualHub -ResourceGroupName "testRG" -Name "westushub" | Remove-AzVirtualHub +``` + +The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". + +It then deletes the virtual hub using powershell piping using output from Get-AzVirtualHub. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Virtual hub object to be modified. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: ResourceName, VirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the Virtual hub to be modified. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualHub](./Get-AzVirtualHub.md) + +[New-AzVirtualHub](./New-AzVirtualHub.md) + +[Update-AzVirtualHub](./Update-AzVirtualHub.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualHubBgpConnection.md b/azps-10.1.0/Az.Network/Remove-AzVirtualHubBgpConnection.md new file mode 100644 index 0000000000..e47f3b9477 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualHubBgpConnection.md @@ -0,0 +1,274 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualhubbgpconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualHubBgpConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualHubBgpConnection.md +--- + +# Remove-AzVirtualHubBgpConnection + +## SYNOPSIS +The Remove-AzVirtualHubBgpConnection cmdlet removes a HubBgpConnection resource that peers the Azure Virtual WAN Hub Router with a BGP-enabled peer in a virtual network connected to the Virtual WAN Hub. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +Remove-AzVirtualHubBgpConnection -ResourceGroupName <String> -VirtualHubName <String> -Name <String> [-AsJob] + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Remove-AzVirtualHubBgpConnection -Name <String> -VirtualHub <PSVirtualHub> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByHubBgpConnectionObject +``` +Remove-AzVirtualHubBgpConnection -InputObject <PSBgpConnection> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByHubBgpConnectionResourceId +``` +Remove-AzVirtualHubBgpConnection -ResourceId <String> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzVirtualHubBgpConnection cmdlet removes a HubBgpConnection resource that peers Azure Virtual WAN Hub Router with a BGP-enabled peer in virtual network connected to the Virtual WAN Hub. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzVirtualHubBgpConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -Name "testBgpConnection" +``` + +The above will remove a Virtual WAN Hub BGP Connection using its resource group name, the Virtual WAN Hub name and the Connection name. + +### Example 2 +```powershell +Get-AzVirtualHubBgpConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -Name "testBgpConnection" | Remove-AzVirtualHubBgpConnection +``` + +The above will remove a Virtual WAN Hub BGP Connection using powershell piping on the output from Get-AzVirtualHubBgpConnection. + +### Example 3 +```powershell +$bgpConnectionId = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{bgpConnectionName}" +Remove-AzVirtualHubBgpConnection -ResourceId $bgpConnectionId +``` + +The above will remove a Virtual WAN Hub BGP Connection using the BGP Connection resource id. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual hub bgp connection resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBgpConnection +Parameter Sets: ByHubBgpConnectionObject +Aliases: VirtualHubBgpConnection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName, ByVirtualHubObject +Aliases: ResourceName, BgpConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id. + +```yaml +Type: System.String +Parameter Sets: ByHubBgpConnectionResourceId +Aliases: BgpConnectionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The virtual hub resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: ParentObject, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubName +The virtual hub name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: ParentResourceName, ParentVirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### Microsoft.Azure.Commands.Network.Models.PSBgpConnection + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualHubBgpConnection](./Get-AzVirtualHubBgpConnection.md) + +[New-AzVirtualHubBgpConnection](./Remove-AzVirtualHubBgpConnection.md) + +[Update-AzVirtualHubBgpConnection](./Update-AzVirtualHubBgpConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualHubRouteTable.md b/azps-10.1.0/Az.Network/Remove-AzVirtualHubRouteTable.md new file mode 100644 index 0000000000..0804be8641 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualHubRouteTable.md @@ -0,0 +1,253 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualhubroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualHubRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualHubRouteTable.md +--- + +# Remove-AzVirtualHubRouteTable + +## SYNOPSIS +Delete a virtual hub route table resource associated with a virtual hub. + +## SYNTAX + +### ByVirtualHubRouteTableName (Default) +``` +Remove-AzVirtualHubRouteTable -ResourceGroupName <String> -HubName <String> -Name <String> [-AsJob] [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Remove-AzVirtualHubRouteTable -Name <String> -VirtualHub <PSVirtualHub> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubRouteTableObject +``` +Remove-AzVirtualHubRouteTable [-InputObject <PSVirtualHubRouteTable>] [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubRouteTableResourceId +``` +Remove-AzVirtualHubRouteTable -ResourceId <String> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified route table that is associated with the specified virtual hub. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzVirtualHubRouteTable -ResourceGroupName "testRg" -HubName "westushub" -Name "routeTable1" +``` + +This command deletes the routeTable1 of the virtual hub westushub. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubRouteTableName +Aliases: VirtualHubName, ParentVirtualHubName, ParentResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtualhubroutetable resource to remove. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable +Parameter Sets: ByVirtualHubRouteTableObject +Aliases: VirtualHubRouteTable + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubRouteTableName, ByVirtualHubObject +Aliases: ResourceName, VirtualHubRouteTableName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubRouteTableName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the virtualhubroutetable resource to remove. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubRouteTableResourceId +Aliases: VirtualHubRouteTableId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualHub +{{ Fill VirtualHub Description }} + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: ParentVirtualHub, ParentObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualHubVnetConnection.md b/azps-10.1.0/Az.Network/Remove-AzVirtualHubVnetConnection.md new file mode 100644 index 0000000000..46badd0465 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualHubVnetConnection.md @@ -0,0 +1,263 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualhubvnetConnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualHubVnetConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualHubVnetConnection.md +--- + +# Remove-AzVirtualHubVnetConnection + +## SYNOPSIS +The Remove-AzVirtualHubVnetConnection cmdlet removes an Azure Virtual Network Connection which peers a remote VNET to the hub VNET. + +## SYNTAX + +### ByHubVirtualNetworkConnectionName (Default) +``` +Remove-AzVirtualHubVnetConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + [-AsJob] [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByHubVirtualNetworkConnectionObject +``` +Remove-AzVirtualHubVnetConnection [-InputObject <PSHubVirtualNetworkConnection>] [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByHubVirtualNetworkConnectionResourceId +``` +Remove-AzVirtualHubVnetConnection -ResourceId <String> [-AsJob] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzVirtualHubVnetConnection cmdlet removes an Azure Virtual Network Connection which peers a remote VNET to the hub VNET. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" +$remoteVirtualNetwork = New-AzVirtualNetwork -Name "MyVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +New-AzVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "westushub" -Name "testvnetconnection" -RemoteVirtualNetwork $remoteVirtualNetwork +Remove-AzVirtualHubVnetConnection -ResourceGroupName testRG -VirtualHubName westushub -Name testvnetconnection +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in Central US in that resource group in Azure. A Virtual Network Connection will be created thereafter which will peer the Virtual Network to the Virtual Hub. + +After the hub virtual network connection is created, it removes the hub virtual network connection using its resource group name, the hub name and the connection name. + +### Example 2 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" +$remoteVirtualNetwork = New-AzVirtualNetwork -Name "MyVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +New-AzVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "westushub" -Name "testvnetconnection" -RemoteVirtualNetwork $remoteVirtualNetwork +Get-AzVirtualHubVnetConnection -ResourceGroupName testRG -VirtualHubName westushub -Name testvnetconnection | Remove-AzVirtualHubVnetConnection +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in Central US in that resource group in Azure. A Virtual Network Connection will be created thereafter which will peer the Virtual Network to the Virtual Hub. + +After the hub virtual network connection is created, it removes the hub virtual network connection using powershell piping on the output from Get-AzHubVirtualNetworkConnection. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The hubvirtualnetworkconnection resource to modify. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection +Parameter Sets: ByHubVirtualNetworkConnectionObject +Aliases: HubVirtualNetworkConnection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByHubVirtualNetworkConnectionName +Aliases: ResourceName, HubVirtualNetworkConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByHubVirtualNetworkConnectionName +Aliases: VirtualHubName, ParentVirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByHubVirtualNetworkConnectionName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the hubvirtualnetworkconnection resource to modify. + +```yaml +Type: System.String +Parameter Sets: ByHubVirtualNetworkConnectionResourceId +Aliases: HubVirtualNetworkConnectionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualHubVnetConnection](./Get-AzVirtualHubVnetConnection.md) + +[New-AzVirtualHubVnetConnection](./New-AzVirtualHubVnetConnection.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualNetwork.md b/azps-10.1.0/Az.Network/Remove-AzVirtualNetwork.md new file mode 100644 index 0000000000..56733cb223 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualNetwork.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C48E204D-D7EC-4EFD-ADC5-C6F593313B9B +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualnetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetwork.md +--- + +# Remove-AzVirtualNetwork + +## SYNOPSIS +Removes a virtual network. + +## SYNTAX + +``` +Remove-AzVirtualNetwork -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVirtualNetwork** cmdlet removes an Azure virtual network. + +## EXAMPLES + +### 1: Create and delete a virtual network +```powershell +New-AzResourceGroup -Name TestResourceGroup -Location centralus +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" + +New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet + +Remove-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup +``` + +This example creates a virtual network in a resource group and then immediately deletes it. To suppress the prompt when deleting the virtual network, use the -Force flag. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual network that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the virtual network that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) + +[New-AzVirtualNetwork](./New-AzVirtualNetwork.md) + +[Set-AzVirtualNetwork](./Set-AzVirtualNetwork.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGateway.md b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGateway.md new file mode 100644 index 0000000000..bad7809363 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGateway.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: A35BB728-A7EF-4ADF-B1A9-25A156434E99 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualnetworkgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkGateway.md +--- + +# Remove-AzVirtualNetworkGateway + +## SYNOPSIS +Deletes a Virtual Network Gateway + +## SYNTAX + +``` +Remove-AzVirtualNetworkGateway -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Virtual Network Gateway is the object representing your gateway in Azure. +The **Get-AzVirtualNetworkGateway** cmdlet returns the object of your gateway in Azure based on Name and Resource Group Name. + +## EXAMPLES + +### Example 1: Delete a Virtual Network Gateway +```powershell +Remove-AzVirtualNetworkGateway -Name myGateway -ResourceGroupName myRG +``` + +Deletes the object of the Virtual Network Gateway with the name "myGateway" within the resource group "myRG" +Note: You must first delete all connections to the Virtual Network Gateway using the **Remove-AzVirtualNetworkGatewayConnection** cmdlet. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual network gateway that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the virtual network gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkGateway](./Get-AzVirtualNetworkGateway.md) + +[New-AzVirtualNetworkGateway](./New-AzVirtualNetworkGateway.md) + +[Reset-AzVirtualNetworkGateway](./Reset-AzVirtualNetworkGateway.md) + +[Resize-AzVirtualNetworkGateway](./Resize-AzVirtualNetworkGateway.md) + +[Set-AzVirtualNetworkGateway](./Set-AzVirtualNetworkGateway.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGatewayConnection.md b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGatewayConnection.md new file mode 100644 index 0000000000..d46c773d9f --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGatewayConnection.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 15958F3D-291A-4E49-A667-9792E9A1577A +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualnetworkgatewayconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkGatewayConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkGatewayConnection.md +--- + +# Remove-AzVirtualNetworkGatewayConnection + +## SYNOPSIS +Deletes a Virtual Network Gateway Connection + +## SYNTAX + +``` +Remove-AzVirtualNetworkGatewayConnection -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Virtual Network Gateway Connection is the object representing the IPsec tunnel (Site-to-Site or Vnet-to-Vnet) connected to your Virtual Network Gateway in Azure. +The **Remove-AzVirtualNetworkGatewayConnection** cmdlet deletes the object of your connection based on Name and Resource Group Name. + +## EXAMPLES + +### Example 1: Delete a Virtual Network Gateway Connection +```powershell +Remove-AzVirtualNetworkGatewayConnection -Name myTunnel -ResourceGroupName myRG +``` + +Deletes the object of the Virtual Network Gateway Connection with the name "myTunnel" within the resource group "myRG" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual network gateway connection that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the virtual network gateway connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkGatewayConnection](./Get-AzVirtualNetworkGatewayConnection.md) + +[New-AzVirtualNetworkGatewayConnection](./New-AzVirtualNetworkGatewayConnection.md) + +[Set-AzVirtualNetworkGatewayConnection](./Set-AzVirtualNetworkGatewayConnection.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGatewayDefaultSite.md b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGatewayDefaultSite.md new file mode 100644 index 0000000000..43991ac0de --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGatewayDefaultSite.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 65E9C4D5-4D2C-4039-A87B-4E693B97C4CB +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualnetworkgatewaydefaultsite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkGatewayDefaultSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkGatewayDefaultSite.md +--- + +# Remove-AzVirtualNetworkGatewayDefaultSite + +## SYNOPSIS +Removes the default site from a virtual network gateway. + +## SYNTAX + +``` +Remove-AzVirtualNetworkGatewayDefaultSite -VirtualNetworkGateway <PSVirtualNetworkGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVirtualNetworkGatewayDefaultSite** cmdlet removes the forced tunneling default site from a virtual network gateway. +Forced tunneling provides a way for you to redirect Internet-bound traffic from Azure virtual machines to your on-premises network; this enables you to inspect and audit traffic before releasing it. +Forced tunneling is carried out by using a virtual private network (VPN) tunnel; this tunnel requires a default site, a local gateway where all the Azure Internet-bound traffic is redirected. +**Remove-AzVirtualNetworkGatewayDefaultSite** removes the default site assigned to a gateway. +If you do this you will need to use Set-AzVirtualNetworkGatewayDefaultSite to assign a new default site before the gateway can be used for forced tunneling. + +## EXAMPLES + +### Example 1: Remove the default site assigned to a virtual network gateway +```powershell +$Gateway = Get-AzVirtualNetworkGateway -Name "ContosoVirtualGateway" +Remove-AzVirtualNetworkGatewayDefaultSite -VirtualNetworkGateway $Gateway +``` + +This example removes the default site currently assigned to a virtual network gateway named ContosoVirtualGateway. +The first command uses **Get-AzVirtualNetworkGateway** to create an object reference to the gateway; this object reference is stored in a variable named $Gateway. +The second command then uses **Remove-AzVirtualNetworkGatewayDefaultSite** to remove the default site assigned to that gateway. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkGateway +Specifies an object reference to the virtual network gateway containing the default site to be removed. +You can create an object reference to a virtual network gateway by using the Get-AzVirtualNetworkGateway and specifying the name of the gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkGateway](./Get-AzVirtualNetworkGateway.md) + +[Set-AzVirtualNetworkGatewayDefaultSite](./Set-AzVirtualNetworkGatewayDefaultSite.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGatewayIpConfig.md b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGatewayIpConfig.md new file mode 100644 index 0000000000..818f9c683d --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGatewayIpConfig.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 60DA2175-7970-410C-A13C-B1314716AD8A +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualnetworkgatewayipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkGatewayIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkGatewayIpConfig.md +--- + +# Remove-AzVirtualNetworkGatewayIpConfig + +## SYNOPSIS +Removes an IP Configuration from a Virtual Network Gateway + +## SYNTAX + +``` +Remove-AzVirtualNetworkGatewayIpConfig -VirtualNetworkGateway <PSVirtualNetworkGateway> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an IP Configuration from a Virtual Network Gateway + +## EXAMPLES + +### Example 1: +```powershell +Remove-AzVirtualNetworkGatewayIpConfig -VirtualNetworkGateway $gateway -Name ActiveActive +``` + +```output +Name : myGateway +ResourceGroupName : myRG +Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft + .Network/virtualNetworkGateways/VNet8GW +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +IpConfigurations : [ + { + "PrivateIpAllocationMethod": "Dynamic", + "Subnet": { + "Id": "/subscriptions/800000000-0000-0000-0000-000000000000/resourceGroups/myRG/provid + ers/Microsoft.Network/virtualNetworks/VNet8/subnets/GatewaySubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/provid + ers/Microsoft.Network/publicIPAddresses/VNet8GWIP" + }, + "Name": "gwipconfig1", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/provider + s/Microsoft.Network/virtualNetworkGateways/VNet8GW/ipConfigurations/gwipconfig1" + } + ] +GatewayType : Vpn +VpnType : RouteBased +EnableBgp : False +ActiveActive : True +GatewayDefaultSite : null +Sku : { + "Capacity": 2, + "Name": "VpnGw1", + "Tier": "VpnGw1" + } +VpnClientConfiguration : null +BgpSettings : { + "Asn": 65515, + "BgpPeeringAddress": "192.0.2.4,192.0.2.5", + "PeerWeight": 0 + } +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkGateway +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +## NOTES + +## RELATED LINKS + +[Add-AzVirtualNetworkGatewayIpConfig](./Add-AzVirtualNetworkGatewayIpConfig.md) + +[New-AzVirtualNetworkGatewayIpConfig](./New-AzVirtualNetworkGatewayIpConfig.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGatewayNatRule.md b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGatewayNatRule.md new file mode 100644 index 0000000000..1e9c071fe6 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkGatewayNatRule.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualnetworkgatewaynatrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkGatewayNatRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkGatewayNatRule.md +--- + +# Remove-AzVirtualNetworkGatewayNatRule + +## SYNOPSIS +Removes or Delete a Virtual Network Gateway NatRule. + +## SYNTAX + +### ByVirtualNetworkGatewayNatRuleName (Default) +``` +Remove-AzVirtualNetworkGatewayNatRule -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualNetworkGatewayNatRuleResourceId +``` +Remove-AzVirtualNetworkGatewayNatRule -ResourceId <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualNetworkGatewayNatRuleObject +``` +Remove-AzVirtualNetworkGatewayNatRule -InputObject <PSVirtualNetworkGatewayNatRule> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +**Remove-AzVirtualNetworkGatewayNatRule** cmdlet removes a virtual network gateway nat rule from your virtual network gateway. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzVirtualNetworkGatewayNatRule -ResourceGroupName rg1 -ParentResourceName gw1 -Name natRule3 +``` + +```output +Confirm +Are you sure you want to remove resource 'natRule3' +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to delete a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The VirtualNetworkGatewayNatRule object to update. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayNatRule +Parameter Sets: ByVirtualNetworkGatewayNatRuleObject +Aliases: VirtualNetworkGatewayNatRule + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualNetworkGatewayNatRuleName +Aliases: ResourceName, VirtualNetworkGatewayNatRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualNetworkGatewayNatRuleName +Aliases: ParentVirtualNetworkGatewayName, VirtualNetworkGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualNetworkGatewayNatRuleName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the VirtualNetworkGatewayNatRule object to delete. + +```yaml +Type: System.String +Parameter Sets: ByVirtualNetworkGatewayNatRuleResourceId +Aliases: VirtualNetworkGatewayNatRuleId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayNatRule + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkPeering.md b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkPeering.md new file mode 100644 index 0000000000..ed41dcbd86 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkPeering.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 1CE08F0F-A59E-46AC-B470-F1DCCD46513E +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualnetworkpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkPeering.md +--- + +# Remove-AzVirtualNetworkPeering + +## SYNOPSIS +Removes a virtual network peering. + +## SYNTAX + +``` +Remove-AzVirtualNetworkPeering -VirtualNetworkName <String> -Name <String> -ResourceGroupName <String> [-Force] + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes a virtual network peering. + +## EXAMPLES + +### Example 1: Remove a virtual network peering +```powershell +# Remove the virtual network peering named myVnet1TomyVnet2 located in myVnet1 in the resource group named myResourceGroup. + +Remove-AzVirtualNetworkPeering -Name "myVnet1TomyVnet2" -VirtualNetworkName "myVnet" -ResourceGroupName "myResourceGroup" +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The virtual network peering name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkName +The virtual network name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Add-AzVirtualNetworkPeering](./Add-AzVirtualNetworkPeering.md) + +[Get-AzVirtualNetworkPeering](./Get-AzVirtualNetworkPeering.md) + +[Set-AzVirtualNetworkPeering](./Set-AzVirtualNetworkPeering.md) + +[Sync-AzVirtualNetworkPeering](./Sync-AzVirtualNetworkPeering.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkSubnetConfig.md b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkSubnetConfig.md new file mode 100644 index 0000000000..4ca2e7e5ae --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkSubnetConfig.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 47FE9EF4-6000-4096-8F04-26A0C6661FDB +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualnetworksubnetconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkSubnetConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkSubnetConfig.md +--- + +# Remove-AzVirtualNetworkSubnetConfig + +## SYNOPSIS +Removes a subnet configuration from a virtual network. + +## SYNTAX + +``` +Remove-AzVirtualNetworkSubnetConfig [-Name <String>] -VirtualNetwork <PSVirtualNetwork> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVirtualNetworkSubnetConfig** cmdlet removes a subnet from an Azure virtual network. + +## EXAMPLES + +### 1: Remove a subnet from a virtual network and update the virtual network +```powershell +New-AzResourceGroup -Name TestResourceGroup -Location centralus +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" + +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" + +$virtualNetwork = New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet + +Remove-AzVirtualNetworkSubnetConfig -Name backendSubnet -VirtualNetwork $virtualNetwork +$virtualNetwork | Set-AzVirtualNetwork +``` + +This example creates a resource group and a virtual network with two subnets. It then + uses the Remove-AzVirtualNetworkSubnetConfig command to remove the backend subnet + from the in-memory representation of the virtual network. Set-AzVirtualNetwork is + then called to modify the virtual network on the server side. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the subnet configuration to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetwork +Specifies the **VirtualNetwork** object that contains the subnet configuration to remove. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +## NOTES + +## RELATED LINKS + +[Add-AzVirtualNetworkSubnetConfig](./Add-AzVirtualNetworkSubnetConfig.md) + +[Get-AzVirtualNetworkSubnetConfig](./Get-AzVirtualNetworkSubnetConfig.md) + +[New-AzVirtualNetworkSubnetConfig](./New-AzVirtualNetworkSubnetConfig.md) + +[Set-AzVirtualNetworkSubnetConfig](./Set-AzVirtualNetworkSubnetConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkTap.md b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkTap.md new file mode 100644 index 0000000000..f915b18729 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualNetworkTap.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualnetworktap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkTap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualNetworkTap.md +--- + +# Remove-AzVirtualNetworkTap + +## SYNOPSIS +Removes a virtual network tap. + +## SYNTAX + +### RemoveByNameParameterSet (Default) +``` +Remove-AzVirtualNetworkTap -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzVirtualNetworkTap -ResourceId <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzVirtualNetworkTap -InputObject <PSVirtualNetworkTap> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVirtualNetworkTap** cmdlet removes an Azure virtual network tap. + +## EXAMPLES + +### Example 1: Remove a virtual network tap +```powershell +Remove-AzNetworkInterface -Name "VirtualNetworkTap1" -ResourceGroupName "ResourceGroup1" +``` + +This command removes the VirtualNetworkTap1 in resource group ResourceGroup1. +Because the *Force* parameter is not used, the user will be prompted to confirm this action. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to delete resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Reference to VirtualNetworkTap resource + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the tap. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the virtual network tap. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +VirtualNetworkTap resourceId + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkTap](./Get-AzVirtualNetworkTap.md) + +[New-AzVirtualNetworkTap](./New-AzVirtualNetworkTap.md) + +[Set-AzVirtualNetworkTap](./Set-AzVirtualNetworkTap.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualRouter.md b/azps-10.1.0/Az.Network/Remove-AzVirtualRouter.md new file mode 100644 index 0000000000..e346cb0e94 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualRouter.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualrouter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualRouter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualRouter.md +--- + +# Remove-AzVirtualRouter + +## SYNOPSIS +Deletes an Azure VirtualRouter. + +## SYNTAX + +### VirtualRouterNameParameterSet (Default) +``` +Remove-AzVirtualRouter -ResourceGroupName <String> -RouterName <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### VirtualRouterInputObjectParameterSet +``` +Remove-AzVirtualRouter -InputObject <PSVirtualRouter> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### VirtualRouterResourceIdParameterSet +``` +Remove-AzVirtualRouter -ResourceId <String> [-Force] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVirtualRouter** cmdlet deletes an Azure VirtualRouter + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzVirtualRouter -ResourceGroupName virtualRouterRG -RouterName virtualRouter +``` + +### Example 2 +```powershell +$virtualRouterId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/virtualRouterRG/providers/Microsoft.Network/virtualRouters/virtualRouter' +Remove-AzVirtualRouter -ResourceId $virtualRouterId +``` + +### Example 3 +```powershell +$virtualRouter = Get-AzVirtualRouter -ResourceGroupName virtualRouterRG -RouterName virtualRouter +Remove-AzVirtualRouter -InputObject $virtualRouter +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual router input object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualRouter +Parameter Sets: VirtualRouterInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the virtual router. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The virtual router resource Id. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouterName +The name of the virtual router. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualRouter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualRouterPeer.md b/azps-10.1.0/Az.Network/Remove-AzVirtualRouterPeer.md new file mode 100644 index 0000000000..49d9e9e1f5 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualRouterPeer.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualrouterpeer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualRouterPeer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualRouterPeer.md +--- + +# Remove-AzVirtualRouterPeer + +## SYNOPSIS +Removes a Peer from an Azure VirtualRouter + +## SYNTAX + +### VirtualRouterPeerNameParameterSet (Default) +``` +Remove-AzVirtualRouterPeer -ResourceGroupName <String> -PeerName <String> -VirtualRouterName <String> [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### VirtualRouterPeerObjectParameterSet +``` +Remove-AzVirtualRouterPeer -InputObject <PSVirtualRouterPeer> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### VirtualRouterPeerResourceIdParameterSet +``` +Remove-AzVirtualRouterPeer -ResourceId <String> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVirtualRouterPeer** cmdlet removes a VirtualRouter Peer from an Azure VirtualRouter + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzVirtualRouterPeer -PeerName csr -VirtualRouterName virtualRouter -ResourceGroupName virtualRouterRG +``` + +### Example 2 +```powershell +$virtualRouterPeerId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/virtualRouterRG/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/csr' +Remove-AzVirtualRouterPeer -ResourceId $virtualRouterPeerId +``` + +### Example 3 +```powershell +$virtualRouterPeer = Get-AzVirtualRouterPeer -ResourceGroupName virtualRouter -VirtualRouterName virtualRouter -PeerName csr +Remove-AzVirtualRouterPeer -InputObject $virtualRouterPeer +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual router peer input object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualRouterPeer +Parameter Sets: VirtualRouterPeerObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PeerName +The name of the virtual router Peer. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the virtual router/peer. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The virtual router peer resource Id. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualRouterName +The virtual router where peer exists. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualRouterPeer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualRouter + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzVirtualWan.md b/azps-10.1.0/Az.Network/Remove-AzVirtualWan.md new file mode 100644 index 0000000000..1cdacf1a64 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVirtualWan.md @@ -0,0 +1,233 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvirtualwan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualWan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVirtualWan.md +--- + +# Remove-AzVirtualWan + +## SYNOPSIS +Removes an Azure Virtual WAN. + +## SYNTAX + +### ByVirtualWanName (Default) +``` +Remove-AzVirtualWan -ResourceGroupName <String> -Name <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanObject +``` +Remove-AzVirtualWan -InputObject <PSVirtualWan> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanResourceId +``` +Remove-AzVirtualWan -ResourceId <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure Virtual WAN. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Name "TestResourceGroup" -Location "Central US" +New-AzVirtualWan -Name "MyVirtualWan" -ResourceGroupName "TestResourceGroup" -Location "Central US" +Remove-AzVirtualWan -Name "MyVirtualWan" -ResourceGroupName "TestResourceGroup" -Passthru +``` + +This example creates a Virtual WAN in a resource group and then immediately deletes it. +To suppress the prompt when deleting the Virtual WAN, use the -Force flag. + +### Example 2 + +```powershell +New-AzResourceGroup -Name "TestResourceGroup" -Location "Central US" +$virtualWan = New-AzVirtualWan -Name "MyVirtualWan" -ResourceGroupName "TestResourceGroup" -Location "Central US" +Remove-AzVirtualWan -InputObject $virtualWan -Passthru +``` + +This example creates a Virtual WAN in a resource group and then immediately deletes it. This deletion happens using the virtual wan object returned by New-AzVirtualWan. +To suppress the prompt when deleting the Virtual WAN, use the -Force flag. + +### Example 3 + +```powershell +New-AzResourceGroup -Name "TestResourceGroup" -Location "Central US" +$virtualWan = New-AzVirtualWan -Name "MyVirtualWan" -ResourceGroupName "TestResourceGroup" -Location "Central US" +Remove-AzVirtualWan -ResourceId $virtualWan.Id -Passthru +``` + +This example creates a Virtual WAN in a resource group and then immediately deletes it. This deletion happens using the virtual wan resource id returned by New-AzVirtualWan. +To suppress the prompt when deleting the Virtual WAN, use the -Force flag. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual wan object to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan +Parameter Sets: ByVirtualWanObject +Aliases: VirtualWan + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The virtual wan name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanName +Aliases: ResourceName, VirtualWanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID for the virtual wan to be deleted. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanResourceId +Aliases: VirtualWanId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualWan + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualWan](./Get-AzVirtualWan.md) + +[New-AzVirtualWan](./New-AzVirtualWan.md) + +[Update-AzVirtualWan](./Update-AzVirtualWan.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzVpnClientIpsecParameter.md b/azps-10.1.0/Az.Network/Remove-AzVpnClientIpsecParameter.md new file mode 100644 index 0000000000..5512a55b9d --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVpnClientIpsecParameter.md @@ -0,0 +1,178 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvpnclientipsecparameter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnClientIpsecParameter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnClientIpsecParameter.md +--- + +# Remove-AzVpnClientIpsecParameter + +## SYNOPSIS +Removes Vpn custom ipsec policy set on Virtual Network Gateway resource. + +## SYNTAX + +### ByFactoryName (Default) +``` +Remove-AzVpnClientIpsecParameter -VirtualNetworkGatewayName <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Remove-AzVpnClientIpsecParameter -InputObject <PSVirtualNetworkGateway> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzVpnClientIpsecParameter -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Virtual Network Gateway is the object representing your gateway in Azure. +The **Remove-AzVpnClientIpsecParameter** cmdlet removes the vpn custom ipsec parameters set on your Virtual Network Gateway, which in turn sets default vpn ipsec policy on VPN gateway based on VirtualNetworkGateway Name and Resource Group Name passed. + +## EXAMPLES + +### Example 1: Deletes the set vpn ipsec parameters set on the Virtual Network Gateway +```powershell +$delete = Remove-AzVpnClientIpsecParameter -VirtualNetworkGatewayName myGateway -ResourceGroupName myRG +``` + +Deletes the vpn custom ipsec parameters set on your Virtual Network Gateway with the name "myGateway" within the resource group "myRG". This command returns bool object showing if removal was successful or failed. +Note: This will result in setting default vpn ipsec policy on your Virtual Network Gateway. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual network gateway object + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +The virtual network gateway name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzVpnClientIpsecParameter](./Get-AzVpnClientIpsecParameter.md) + +[New-AzVpnClientIpsecParameter](./New-AzVpnClientIpsecParameter.md) + +[Set-AzVpnClientIpsecParameter](./Set-AzVpnClientIpsecParameter.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzVpnClientRevokedCertificate.md b/azps-10.1.0/Az.Network/Remove-AzVpnClientRevokedCertificate.md new file mode 100644 index 0000000000..3c9f99fcb1 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVpnClientRevokedCertificate.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 818C2250-DE43-409E-AC68-B4A7E945401E +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvpnclientrevokedcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnClientRevokedCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnClientRevokedCertificate.md +--- + +# Remove-AzVpnClientRevokedCertificate + +## SYNOPSIS +Removes a VPN client-revocation certificate. + +## SYNTAX + +``` +Remove-AzVpnClientRevokedCertificate -VpnClientRevokedCertificateName <String> + -VirtualNetworkGatewayName <String> -ResourceGroupName <String> -Thumbprint <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVpnClientRevokedCertificate** cmdlet removes a client-revocation certificate from a virtual network gateway. +Client-revocation certificates prevent client computers from using the specified certificate for authentication. +If you remove a client-revocation certificate client computers can then use the previously-banned certificate to make a virtual private network (VPN) connection. + +## EXAMPLES + +### Example 1: Remove a client-revocation certificate from a virtual network gateway +```powershell +Remove-AzVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -VpnClientRevokedCertificateName "ContosoRevokedClientCertificate" -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" +``` + +This command removes a client-revocation certificate from a virtual network gateway named ContosoVirtualNetwork. +In order to remove a client-revocation certificate, you must specify both the certificate name and the certificate thumbprint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the virtual network gateway is assigned to. +Resource groups categorize items to help simplify inventory management and general Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Thumbprint +Specifies the unique identifier of the certificate being removed. +You can return thumbprint information for your certificates by using a Windows PowerShell command similar to this: +`Get-ChildItem -Path "Cert:\LocalMachine\Root"` +The preceding command returns information for all the Local Computer certificates found in the Root certificate store. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +Specifies the name of the virtual network gateway that the certificate is assigned to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientRevokedCertificateName +Specifies the name of the VPN client certificate being removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Add-AzVpnClientRevokedCertificate](./Add-AzVpnClientRevokedCertificate.md) + +[Get-AzVpnClientRevokedCertificate](./Get-AzVpnClientRevokedCertificate.md) + +[New-AzVpnClientRevokedCertificate](./New-AzVpnClientRevokedCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzVpnClientRootCertificate.md b/azps-10.1.0/Az.Network/Remove-AzVpnClientRootCertificate.md new file mode 100644 index 0000000000..9bc4da21bc --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVpnClientRootCertificate.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 5D857FF6-A27D-4031-948D-8A69D24B4AD4 +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvpnclientrootcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnClientRootCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnClientRootCertificate.md +--- + +# Remove-AzVpnClientRootCertificate + +## SYNOPSIS +Removes an existing VPN client root certificate. + +## SYNTAX + +``` +Remove-AzVpnClientRootCertificate -VpnClientRootCertificateName <String> -VirtualNetworkGatewayName <String> + -ResourceGroupName <String> -PublicCertData <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzVpnClientRootCertificate** cmdlet removes the specified root certificate from a virtual network gateway. +Root certificates are X.509 certificates that identify your Root Certification Authority: all other certificates used on the gateway trust the root certificate. +If you remove a root certificate computers that use the certificate for authentication purposes will no longer be able to connect to the gateway. +When you use **Remove-AzVpnClientRootCertificate**, you must supply both the certificate name and a text representation of the certificate data. +For more information about the text representation of a certificate see the *PublicCertData* parameter description. + +## EXAMPLES + +### Example 1: Remove a client root certificate from a virtual network gateway +```powershell +$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertificate.cer" +$CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text[$i]} +Remove-AzVpnClientRootCertificate -PublicCertData $CertificateText -ResourceGroupName "ContosoResourceGroup" -VirtualNetworkGatewayName "ContosoVirtualGateway" -VpnClientRootCertificateName "ContosoRootCertificate" +``` + +This example removes a client root certificate named ContosoRootCertificate from the virtual network gateway ContosoVirtualGateway. +The first command uses the **Get-Content** cmdlet to get a previously-exported text representation of the certificate; this text representation is stored in a variable named $Text. +The second command then uses a for loop to extract all the text in $Text except for the first line and the last line. +This extracted text is stored in a variable named $CertificateText. +The third command uses the information stored in the $CertificateText variable along with the **Remove-AzVpnClientRootCertificate** cmdlet to remove the certificate from the gateway. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicCertData +Specifies the text representation of the root certificate to be removed. +To obtain the text representation, export your certificate in .cer format (using Base64) encoding, then open the resulting file in a text editor. +You should see output similar to the following (note that the actual output will contain many more lines of text than the abbreviated sample shown here): +----- BEGIN CERTIFICATE ----- +MIIC13FAAXC3671Auij9HHgUNEW8343NMJklo09982CVVFAw8w +----- END CERTIFICATE ----- +The PublicCertData is made up of all the lines between the first line (----- BEGIN CERTIFICATE -----) and the last line (----- END CERTIFICATE -----) in the file. +You can retrieve the PublicCertData using Windows PowerShell commands similar to this: +$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertificate.cer" +$CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text\[$i\]} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the virtual network gateway is assigned to. +Resource groups categorize items to help simplify inventory management and general Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +Specifies the name of the virtual network gateway that the certificate is removed from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientRootCertificateName +Specifies the name of the client root certificate that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Add-AzVpnClientRootCertificate](./Add-AzVpnClientRootCertificate.md) + +[Get-AzVpnClientRootCertificate](./Get-AzVpnClientRootCertificate.md) + +[New-AzVpnClientRootCertificate](./New-AzVpnClientRootCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Remove-AzVpnConnection.md b/azps-10.1.0/Az.Network/Remove-AzVpnConnection.md new file mode 100644 index 0000000000..193b1ecaae --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVpnConnection.md @@ -0,0 +1,261 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvpnconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnConnection.md +--- + +# Remove-AzVpnConnection + +## SYNOPSIS +Removes a VpnConnection. + +## SYNTAX + +### ByVpnConnectionName (Default) +``` +Remove-AzVpnConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnConnectionResourceId +``` +Remove-AzVpnConnection -ResourceId <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnConnectionObject +``` +Remove-AzVpnConnection -InputObject <PSVpnConnection> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes a VpnConnection. + +## EXAMPLES + +### Example 1 +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" + +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" + +$vpnSite = New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" + +New-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite +Remove-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite in West US in "testRG" resource group in Azure. +A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. + +Once the gateway has been created, it is connected to the VpnSite using the New-AzVpnConnection command. + +Then it removes the connection using the connection name. + +### Example 2 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" + +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" + +$vpnSite = New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" + +New-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite +Get-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" | Remove-AzVpnConnection +``` + +Same as example 1, but it now removes the connection using the piped object from Get-AzVpnConnection. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The VpnConnection object to update. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnConnection +Parameter Sets: ByVpnConnectionObject +Aliases: VpnConnection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionName +Aliases: ResourceName, VpnConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionName +Aliases: ParentVpnGatewayName, VpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the VpnConnection object to delete. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionResourceId +Aliases: VpnConnectionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVpnConnection + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzVpnConnection](./Get-AzVpnConnection.md) + +[New-AzVpnConnection](./New-AzVpnConnection.md) + +[Update-AzVpnConnection](./Update-AzVpnConnection.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzVpnGateway.md b/azps-10.1.0/Az.Network/Remove-AzVpnGateway.md new file mode 100644 index 0000000000..5633c675e1 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVpnGateway.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvpngateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnGateway.md +--- + +# Remove-AzVpnGateway + +## SYNOPSIS +The Remove-AzVpnGateway cmdlet removes an Azure VPN gateway. This is a gateway specific to Azure Virtual WAN's software defined connectivity. + +## SYNTAX + +### ByVpnGatewayName (Default) +``` +Remove-AzVpnGateway -ResourceGroupName <String> -Name <String> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayObject +``` +Remove-AzVpnGateway -InputObject <PSVpnGateway> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayResourceId +``` +Remove-AzVpnGateway -ResourceId <String> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzVpnGateway cmdlet removes an Azure VPN gateway. This is a gateway specific to Azure Virtual WAN's software defined connectivity. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +Remove-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -Passthru +``` + +This example creates a Resource group, Virtual WAN, Virtual Hub, scalable VPN gateway in Central US and then immediately deletes it. +To suppress the prompt when deleting the Virtual Gateway, use the -Force flag. +This will delete the VpnGateway and all VpnConnections attached to it. + +### Example 2 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" | Remove-AzVpnGateway -Passthru +``` + +This example creates a Resource group, Virtual WAN, Virtual Hub, scalable VPN gateway in Central US and then immediately deletes it. +This deletion happens using powershell piping, which uses the VpnGateway object returned by the Get-AzVpnGateway command. +To suppress the prompt when deleting the Virtual Gateway, use the -Force flag. +This will delete the VpnGateway and all VpnConnections attached to it. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The vpnGateway object to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnGateway +Parameter Sets: ByVpnGatewayObject +Aliases: VpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The vpnGateway name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: ResourceName, VpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID for the vpnGateway to be deleted. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayResourceId +Aliases: vpnGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGateway + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzVpnGateway](./Get-AzVpnGateway.md) + +[New-AzVpnGateway](./New-AzVpnGateway.md) + +[Update-AzVpnGateway](./Update-AzVpnGateway.md) diff --git a/azps-10.1.0/Az.Network/Remove-AzVpnGatewayNatRule.md b/azps-10.1.0/Az.Network/Remove-AzVpnGatewayNatRule.md new file mode 100644 index 0000000000..c41f6f93c8 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVpnGatewayNatRule.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvpngatewaynatrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnGatewayNatRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnGatewayNatRule.md +--- + +# Remove-AzVpnGatewayNatRule + +## SYNOPSIS +Removes a NAT rule associated with VpnGateway. + +## SYNTAX + +### ByVpnGatewayNatRuleName (Default) +``` +Remove-AzVpnGatewayNatRule -ResourceGroupName <String> -ParentResourceName <String> -Name <String> [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayNatRuleResourceId +``` +Remove-AzVpnGatewayNatRule -ResourceId <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayNatRuleObject +``` +Remove-AzVpnGatewayNatRule -InputObject <PSVpnGatewayNatRule> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes a NAT rule associated with VpnGateway. + +## EXAMPLES + +### Example1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" +New-AzVpnGatewayNatRule -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testNatRule" -Type Static -Mode EgressSnat -InternalMapping "10.0.0.1/26" -ExternalMapping "192.168.0.0/26" +Remove-AzVpnGatewayNatRule -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testNatRule" +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub,VpnGateway and NAT rule associated with that VpnGateway. +Then it removes the NAT rule using the NAT rule name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to delete a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The VpnGatewayNatRule object to update. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnGatewayNatRule +Parameter Sets: ByVpnGatewayNatRuleObject +Aliases: VpnGatewayNatRule + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayNatRuleName +Aliases: ResourceName, VpnGatewayNatRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayNatRuleName +Aliases: ParentVpnGatewayName, VpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayNatRuleName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the VpnGatewayNatRule object to delete. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayNatRuleResourceId +Aliases: VpnGatewayNatRuleId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVpnGatewayNatRule + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzVpnServerConfiguration.md b/azps-10.1.0/Az.Network/Remove-AzVpnServerConfiguration.md new file mode 100644 index 0000000000..12d5679738 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVpnServerConfiguration.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvpnserverconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnServerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnServerConfiguration.md +--- + +# Remove-AzVpnServerConfiguration + +## SYNOPSIS +Removes an existing VpnServerConfiguration. + +## SYNTAX + +### ByVpnServerConfigurationName (Default) +``` +Remove-AzVpnServerConfiguration -ResourceGroupName <String> -Name <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnServerConfigurationObject +``` +Remove-AzVpnServerConfiguration -InputObject <PSVpnServerConfiguration> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnServerConfigurationResourceId +``` +Remove-AzVpnServerConfiguration -ResourceId <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an existing VpnServerConfiguration. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzVpnServerConfiguration -Name "test1config" -ResourceGroupName "P2SCortexGATesting" -Force -PassThru +``` + +The above command will remove an existing VpnServerConfiguration. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The vpnServerConfiguration object to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration +Parameter Sets: ByVpnServerConfigurationObject +Aliases: VpnServerConfiguration + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The vpnServerConfiguration name. + +```yaml +Type: System.String +Parameter Sets: ByVpnServerConfigurationName +Aliases: ResourceName, VpnServerConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item on which this operation is being performed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnServerConfigurationName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID for the vpnServerConfiguration to be deleted. + +```yaml +Type: System.String +Parameter Sets: ByVpnServerConfigurationResourceId +Aliases: VpnServerConfigurationId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration +System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Remove-AzVpnServerConfigurationPolicyGroup.md b/azps-10.1.0/Az.Network/Remove-AzVpnServerConfigurationPolicyGroup.md new file mode 100644 index 0000000000..3d908c7a44 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVpnServerConfigurationPolicyGroup.md @@ -0,0 +1,460 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvpnserverconfigurationpolicygroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnServerConfigurationPolicyGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnServerConfigurationPolicyGroup.md +--- + +# New-AzP2sVpnGateway + +## SYNOPSIS +Create a new P2SVpnGateway under VirtualHub for point to site connectivity. + +## SYNTAX + +### ByVirtualHubNameByVpnServerConfigurationObject (Default) +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubName <String> [-VpnServerConfiguration <PSVpnServerConfiguration>] + [-VpnClientAddressPool <String[]>] [-CustomDnsServer <String[]>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] [-DisableInternetSecurityFlag] + [-EnableRoutingPreferenceInternetFlag] [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubNameByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubName <String> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObjectByVpnServerConfigurationObject +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHub <PSVirtualHub> [-VpnServerConfiguration <PSVpnServerConfiguration>] + [-VpnClientAddressPool <String[]>] [-CustomDnsServer <String[]>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] [-DisableInternetSecurityFlag] + [-EnableRoutingPreferenceInternetFlag] [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubObjectByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHub <PSVirtualHub> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByVpnServerConfigurationObject +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubId <String> [-VpnServerConfiguration <PSVpnServerConfiguration>] [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubId <String> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzP2sVpnGateway cmdlet enables you to create a new P2SVpnGateway under VirtualHub for Point to site connectivity from Point to site clients to Azure VirtualWan. + +## EXAMPLES + +### Example 1 +```powershell +$virtualHub = Get-AzVirtualHub -ResourceGroupName P2SCortexGATesting -Name WestUsVirtualHub +$vpnServerConfig1 = Get-AzVpnServerConfiguration -ResourceGroupName P2SCortexGATesting -Name WestUsConfig +$vpnClientAddressSpaces = New-Object string[] 1 +$vpnClientAddressSpaces[0] = "192.168.2.0/24" +$createdP2SVpnGateway = New-AzP2sVpnGateway -ResourceGroupName P2SCortexGATesting -Name 683482ade8564515aed4b8448c9757ea-westus-gw -VirtualHub $virtualHub -VpnGatewayScaleUnit 1 -VpnClientAddressPool $vpnClientAddressSpaces -VpnServerConfiguration $vpnServerConfig1 -EnableInternetSecurityFlag -EnableRoutingPreferenceInternetFlag +``` + +```output +ResourceGroupName : P2SCortexGATesting +Name : 683482ade8564515aed4b8448c9757ea-westus-gw +Id : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482ade8564515a + ed4b8448c9757ea-westus-gw +Location : westus +VpnGatewayScaleUnit : 1 +VirtualHub : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub +VpnServerConfiguration : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/WestUsConfig +VpnServerConfigurationLocation : +VpnClientConnectionHealth : null +Type : Microsoft.Network/p2sVpnGateways +ProvisioningState : Succeeded +P2SConnectionConfigurations : [ + { + "ProvisioningState": "Succeeded", + "VpnClientAddressPool": { + "AddressPrefixes": [ + "192.168.2.0/24" + ] + }, + "EnableInternetSecurity": True, + "RoutingConfiguration": { + "AssociatedRouteTable": { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + }, + "Name": "P2SConnectionConfigDefault", + "Etag": "W/\"4b96e6a2-b4d8-46b3-9210-76d40f359bef\"", + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482 + ade8564515aed4b8448c9757ea-westus-gw/p2sConnectionConfigurations/P2SConnectionConfigDefault" + } + ] +``` + +The New-AzP2sVpnGateway cmdlet enables you to create a new P2SVpnGateway under VirtualHub for Point to site connectivity. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```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 +``` + +### -CustomDnsServer +The list of Custom Dns Servers. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableInternetSecurityFlag +Flag to disable internet security feature on this P2SVpnGateway P2SConnectionConfiguration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternetSecurityFlag +Enable internet security flag for this P2SVpnGateway connections + +```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 +``` + +### -EnableRoutingPreferenceInternetFlag +Flag to enable Routing Preference Internet on this P2SVpnGateway. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, P2SVpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -P2SConnectionConfiguration +The list of P2SConnectionConfigurations that this P2SVpnGateway needs to have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSP2SConnectionConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingConfiguration +Routing configuration for this connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObjectByVpnServerConfigurationObject, ByVirtualHubObjectByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubId +The Id of the VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceIdByVpnServerConfigurationObject, ByVirtualHubResourceIdByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualHubName +The Id of the VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationObject, ByVirtualHubNameByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnClientAddressPool +P2S VpnClient AddressPool for this P2SVpnGateway P2SConnectionConfiguration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnGatewayScaleUnit +The scale unit for this P2SVpnGateway. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnServerConfiguration +The VpnServerConfiguration to be attached to this P2SVpnGateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationObject, ByVirtualHubObjectByVpnServerConfigurationObject, ByVirtualHubResourceIdByVpnServerConfigurationObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VpnServerConfigurationId +The id of Vpn server configuration object this P2SVpnGateway will be attached to. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationResourceId, ByVirtualHubObjectByVpnServerConfigurationResourceId, ByVirtualHubResourceIdByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub +System.String Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +## NOTES + +## RELATED LINKS + +[New-AzRoutingConfiguration]() + diff --git a/azps-10.1.0/Az.Network/Remove-AzVpnSite.md b/azps-10.1.0/Az.Network/Remove-AzVpnSite.md new file mode 100644 index 0000000000..6c6b363db2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Remove-AzVpnSite.md @@ -0,0 +1,230 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/remove-azvpnsite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Remove-AzVpnSite.md +--- + +# Remove-AzVpnSite + +## SYNOPSIS +Removes an Azure VpnSite resource. + +## SYNTAX + +### ByVpnSiteName (Default) +``` +Remove-AzVpnSite -ResourceGroupName <String> -Name <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnSiteObject +``` +Remove-AzVpnSite -InputObject <PSVpnSite> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnSiteResourceId +``` +Remove-AzVpnSite -ResourceId <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an Azure VpnSite resource. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" +New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" +Remove-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" +``` + +The above will create a resource group, Virtual WAN in West US in "testRG" resource group in Azure. + +Then it creates a VpnSite to represent a customer branch and links it to the Virtual WAN. + +Once the site is created, it is immediately removed using the Remove-AzVpnSite command. + +### Example 2 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" +New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" +Get-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" | Remove-AzVpnSite +``` + +Same as example 1 but here the removal happens using the piped output from Get-AzVpnSite. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```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 +``` + +### -InputObject +The vpnSite object to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnSite +Parameter Sets: ByVpnSiteObject +Aliases: VpnSite + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The vpnSite name. + +```yaml +Type: System.String +Parameter Sets: ByVpnSiteName +Aliases: ResourceName, VpnSiteName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + +```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. + +```yaml +Type: System.String +Parameter Sets: ByVpnSiteName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID for the vpnSite to be deleted. + +```yaml +Type: System.String +Parameter Sets: ByVpnSiteResourceId +Aliases: VpnSiteId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnSite + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzVpnSite](./Get-AzVpnSite.md) + +[New-AzVpnSite](./New-AzVpnSite.md) + +[Update-AzVpnSite](./Update-AzVpnSite.md) diff --git a/azps-10.1.0/Az.Network/Reset-AzHubRouter.md b/azps-10.1.0/Az.Network/Reset-AzHubRouter.md new file mode 100644 index 0000000000..c5df2926f4 --- /dev/null +++ b/azps-10.1.0/Az.Network/Reset-AzHubRouter.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/reset-azhubrouter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzHubRouter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzHubRouter.md +--- + +# Reset-AzHubRouter + +## SYNOPSIS +Resets the RoutingState of a VirtualHub resource. + +## SYNTAX + +### ByVirtualHubObject (Default) +``` +Reset-AzHubRouter -InputObject <PSVirtualHub> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubName +``` +Reset-AzHubRouter -ResourceGroupName <String> -Name <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +Reset-AzHubRouter -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Resets the Routing State of an existing VirtualHub resource only if the Routing State of the virtual hub is not Provisioned. + +## EXAMPLES + +### Example 1 + +```powershell +Reset-AzHubRouter -ResourceGroupName "testRG" -Name "westushub" +``` + +Reset the routing state of the virtual hub using its ResourceGroupName and ResourceName. + +### Example 2 + +```powershell +Reset-AzHubRouter -ResourceId "/subscriptions/testSub/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub" +``` + +Reset the routing state of the virtual hub using its ResourceId. + +### Example 3 + +```powershell +Reset-AzHubRouter -InputObject $virtualHub +``` + +Reset the routing state of the virtual hub using an input object. The input object is of type PSVirtualHub. + +### Example 4 + +```powershell +Get-AzVirtualHub -ResourceGroupName "testRG" -Name "westushub" | Reset-AzHubRouter +``` + +An existing virtual hub object can be retrieved and then passed as input object to Reset-AzHubRouter. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Virtual hub object to be modified. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: ResourceName, VirtualHubName, HubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the Virtual hub to be modified. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualHub](./Get-AzVirtualHub.md) diff --git a/azps-10.1.0/Az.Network/Reset-AzP2sVpnGateway.md b/azps-10.1.0/Az.Network/Reset-AzP2sVpnGateway.md new file mode 100644 index 0000000000..566097f094 --- /dev/null +++ b/azps-10.1.0/Az.Network/Reset-AzP2sVpnGateway.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 443F6492-EFA7-4417-943A-3A8D47F8C83C +online version: https://learn.microsoft.com/powershell/module/az.network/reset-azp2svpngateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzP2sVpnGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzP2sVpnGateway.md +--- + +# Reset-AzP2sVpnGateway + +## SYNOPSIS +Resets the scalable P2S VPN gateway. + +## SYNTAX + +### ByP2SVpnGatewayName (Default) +``` +Reset-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayObject +``` +Reset-AzP2sVpnGateway -InputObject <PSP2SVpnGateway> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayResourceId +``` +Reset-AzP2sVpnGateway -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Resets the P2SVpnGateway + +## EXAMPLES + +### Example 1: +```powershell +$Gateway = Get-AzP2sVpnGateway -Name "ContosoVirtualGateway" -ResourceGroupName "RGName" +Reset-AzP2sVpnGateway -P2SVpnGateway $Gateway +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```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 credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The p2s vpn gateway to reset + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +Parameter Sets: ByP2SVpnGatewayObject +Aliases: P2SVpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The p2s vpn gateway name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayName +Aliases: ResourceName, P2SVpnGatewayName, GatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the P2SVpnGateway to reset. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway + +## NOTES + +## RELATED LINKS + +[Get-AzP2sVpnGateway](./Get-AzP2sVpnGateway.md) + +[New-AzP2sVpnGateway](./New-AzP2sVpnGateway.md) + +[Remove-AzP2sVpnGateway](./Remove-AzP2sVpnGateway.md) + +[Update-AzP2sVpnGateway](./Update-AzP2sVpnGateway.md) diff --git a/azps-10.1.0/Az.Network/Reset-AzVirtualNetworkGateway.md b/azps-10.1.0/Az.Network/Reset-AzVirtualNetworkGateway.md new file mode 100644 index 0000000000..15f35dc1b0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Reset-AzVirtualNetworkGateway.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 443F6492-EFA7-4417-943A-3A8D47F8C83C +online version: https://learn.microsoft.com/powershell/module/az.network/reset-azvirtualnetworkgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzVirtualNetworkGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzVirtualNetworkGateway.md +--- + +# Reset-AzVirtualNetworkGateway + +## SYNOPSIS +Resets the Virtual Network Gateway + +## SYNTAX + +``` +Reset-AzVirtualNetworkGateway -VirtualNetworkGateway <PSVirtualNetworkGateway> [-GatewayVip <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Resets the Virtual Network Gateway + +## EXAMPLES + +### Example 1: +```powershell +$Gateway = Get-AzVirtualNetworkGateway -Name myGateway1 -ResourceGroupName myRG +Reset-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayVip +The gateway vip in order to reset particular gateway instance (e.g. in case of Active-Active feature enabled gateways.) By default, gateway primary instance will be reset if no value is passed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualNetworkGateway +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkGateway](./Get-AzVirtualNetworkGateway.md) + +[New-AzVirtualNetworkGateway](./New-AzVirtualNetworkGateway.md) + +[Remove-AzVirtualNetworkGateway](./Remove-AzVirtualNetworkGateway.md) + +[Resize-AzVirtualNetworkGateway](./Resize-AzVirtualNetworkGateway.md) + +[Set-AzVirtualNetworkGateway](./Set-AzVirtualNetworkGateway.md) diff --git a/azps-10.1.0/Az.Network/Reset-AzVirtualNetworkGatewayConnection.md b/azps-10.1.0/Az.Network/Reset-AzVirtualNetworkGatewayConnection.md new file mode 100644 index 0000000000..18bf923332 --- /dev/null +++ b/azps-10.1.0/Az.Network/Reset-AzVirtualNetworkGatewayConnection.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/reset-azvirtualnetworkgatewayconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzVirtualNetworkGatewayConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzVirtualNetworkGatewayConnection.md +--- + +# Reset-AzVirtualNetworkGatewayConnection + +## SYNOPSIS +Reset a Virtual Network Gateway Connection + +## SYNTAX + +### ByName (Default) +``` +Reset-AzVirtualNetworkGatewayConnection -Name <String> -ResourceGroupName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Reset-AzVirtualNetworkGatewayConnection -InputObject <PSVirtualNetworkGatewayConnection> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Reset-AzVirtualNetworkGatewayConnection -ResourceId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Reset-AzVirtualNetworkGatewayConnection** cmdlet resets your virtual network gateway connection based on the Connection Name and Resource Group Name. + +## EXAMPLES + +### Example 1 +```powershell +Reset-AzVirtualNetworkGatewayConnection -ResourceGroupName myRG -Name myTunnel +``` + +Resets the Virtual Network Gateway Connection with the name "myTunnel" within the resource group "myRG" + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual network gateway connection object which has to be reset. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The virtual network gateway connection name which has to be reset. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ResourceName, ConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the Virtual Network Gateway Connection which has to be reset. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Reset-AzVirtualNetworkGatewayConnectionSharedKey.md b/azps-10.1.0/Az.Network/Reset-AzVirtualNetworkGatewayConnectionSharedKey.md new file mode 100644 index 0000000000..2703999a58 --- /dev/null +++ b/azps-10.1.0/Az.Network/Reset-AzVirtualNetworkGatewayConnectionSharedKey.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: AB370DAD-CED9-479D-BE08-B32EFF924A37 +online version: https://learn.microsoft.com/powershell/module/az.network/reset-azvirtualnetworkgatewayconnectionsharedkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzVirtualNetworkGatewayConnectionSharedKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzVirtualNetworkGatewayConnectionSharedKey.md +--- + +# Reset-AzVirtualNetworkGatewayConnectionSharedKey + +## SYNOPSIS +Resets the shared key of the virtual network gateway connection. + +## SYNTAX + +``` +Reset-AzVirtualNetworkGatewayConnectionSharedKey -Name <String> -ResourceGroupName <String> -KeyLength <UInt32> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Resets the shared key of the virtual network gateway connection. + +## EXAMPLES + +### Example 1: +```powershell +Reset-AzVirtualNetworkGatewayConnectionSharedKey -ResourceGroupName myRG -Name myConnection -KeyLength 32 +``` + +```output +Confirm +Are you sure you want to overwrite resource 'myConnection' +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +h0FmZA3BzXHqRE00J0wie0Mti0cCZwJm +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyLength +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.UInt32 + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkGatewayConnectionSharedKey](./Get-AzVirtualNetworkGatewayConnectionSharedKey.md) + +[Set-AzVirtualNetworkGatewayConnectionSharedKey](./Set-AzVirtualNetworkGatewayConnectionSharedKey.md) diff --git a/azps-10.1.0/Az.Network/Reset-AzVpnGateway.md b/azps-10.1.0/Az.Network/Reset-AzVpnGateway.md new file mode 100644 index 0000000000..0334cc7213 --- /dev/null +++ b/azps-10.1.0/Az.Network/Reset-AzVpnGateway.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 443F6492-EFA7-4417-943A-3A8D47F8C83C +online version: https://learn.microsoft.com/powershell/module/az.network/reset-azvpngateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzVpnGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzVpnGateway.md +--- + +# Reset-AzVpnGateway + +## SYNOPSIS +Resets the scalable VPN gateway. + +## SYNTAX + +### ByVpnGatewayName (Default) +``` +Reset-AzVpnGateway -ResourceGroupName <String> -Name <String> [-IpConfigurationId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayObject +``` +Reset-AzVpnGateway -InputObject <PSVpnGateway> [-IpConfigurationId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayResourceId +``` +Reset-AzVpnGateway -ResourceId <String> [-IpConfigurationId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Resets the VpnGateway + +## EXAMPLES + +### Example 1 +```powershell +$Gateway = Get-AzVpnGateway -Name "ContosoVirtualGateway" -ResourceGroupName "RGName" +Reset-AzVpnGateway -VpnGateway $Gateway -IpConfigurationId "Instance0" +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The vpn gateway to reset + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnGateway +Parameter Sets: ByVpnGatewayObject +Aliases: VpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IpConfigurationId +The Azure IpConfiguration ID of the VpnGateway to reset. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The vpn gateway name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: ResourceName, VpnGatewayName, GatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the VpnGateway to reset. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGateway + +## NOTES + +## RELATED LINKS + +[Get-AzVpnGateway](./Get-AzVpnGateway.md) + +[New-AzVpnGateway](./New-AzVpnGateway.md) + +[Remove-AzVpnGateway](./Remove-AzVpnGateway.md) + +[Update-AzVpnGateway](./Update-AzVpnGateway.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Reset-AzVpnSiteLinkConnection.md b/azps-10.1.0/Az.Network/Reset-AzVpnSiteLinkConnection.md new file mode 100644 index 0000000000..8ea487cb73 --- /dev/null +++ b/azps-10.1.0/Az.Network/Reset-AzVpnSiteLinkConnection.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/reset-azvpnsitelinkconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzVpnSiteLinkConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Reset-AzVpnSiteLinkConnection.md +--- + +# Reset-AzVpnSiteLinkConnection + +## SYNOPSIS +Reset a VPN Site Link Connection + +## SYNTAX + +### ByName (Default) +``` +Reset-AzVpnSiteLinkConnection -ResourceGroupName <String> -VpnGatewayName <String> -VpnConnectionName <String> + -Name <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Reset-AzVpnSiteLinkConnection -InputObject <PSVpnSiteLinkConnection> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Reset-AzVpnSiteLinkConnection -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Reset-AzVpnSiteLinkConnection** cmdlet resets your VPN Link Connection based on the VPN Site Link Connection Name, VPN Connection Name, VPN Gateway Name and Resource Group Name. + +## EXAMPLES + +### Example 1 +```powershell +Reset-AzVpnSiteLinkConnection -ResourceGroupName test-rg -VpnGatewayName test-gateway -VpnConnectionName test-connection -ResourceName test-linkConnection +``` + +Resets the VPN Site Link Connection with the name "test-linkConnection" within the resource group "test-rg" + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Vpn site link connection object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnSiteLinkConnection +Parameter Sets: ByInputObject +Aliases: VpnSiteLinkConnection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Vpn site link connection name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ResourceName, VpnSiteLinkConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the Vpn site link connection which has to be reset. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnConnectionName +The Vpn connection name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ParentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnGatewayName +The Vpn gateway name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: GrandParentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnSiteLinkConnection + +### System.String + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Resize-AzVirtualNetworkGateway.md b/azps-10.1.0/Az.Network/Resize-AzVirtualNetworkGateway.md new file mode 100644 index 0000000000..2f05cc1507 --- /dev/null +++ b/azps-10.1.0/Az.Network/Resize-AzVirtualNetworkGateway.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: DE2441FC-9504-4F3F-AEAF-37EDCD9B7275 +online version: https://learn.microsoft.com/powershell/module/az.network/resize-azvirtualnetworkgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Resize-AzVirtualNetworkGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Resize-AzVirtualNetworkGateway.md +--- + +# Resize-AzVirtualNetworkGateway + +## SYNOPSIS +Resizes an existing virtual network gateway. + +## SYNTAX + +``` +Resize-AzVirtualNetworkGateway -VirtualNetworkGateway <PSVirtualNetworkGateway> -GatewaySku <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Resize-AzVirtualNetworkGateway** cmdlet enables you to change the stock-keeping unit (SKU) for a virtual network gateway. +SKUs determine the capabilities of a gateway, including such things as throughput and the maximum number of IP tunnels that are allowed. +Azure supports Basic, Standard, High-Performance, VpnGw1, VpnGw2, VpnGw3, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, ErGw1AZ, ErGw2AZ, ErGw3AZ SKUs (sometimes referred to as Small, Medium, and Large SKUs). +For detailed information about the capabilities of each SKU type, see https://azure.microsoft.com/en-us/documentation/articles/vpn-gateway-about-vpngateways/. +Keep in mind that SKUs differ in pricing as well as capabilities. +For more information, see https://azure.microsoft.com/en-us/pricing/details/vpn-gateway/. + +## EXAMPLES + +### Example 1: Change the size of a virtual network gateway +```powershell +$Gateway = Get-AzVirtualNetworkGateway -Name "ContosoVirtualGateway" +Resize-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -GatewaySku "Basic" +``` + +This example changes the size of a virtual network gateway named ContosoVirtualGateway. +The first command creates an object reference to ContosoVirtualGateway; this object reference is stored in a variable named $Gateway. +The second command then uses the **Resize-AzVirtualNetworkGateway** cmdlet to set the *GatewaySku* property to Basic. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewaySku +Specifies the new type of gateway SKU. +The acceptable values for this parameter are: +- Basic +- Standard +- High Performance +- VpnGw1 +- VpnGw2 +- VpnGw3 +- VpnGw1AZ +- VpnGw2AZ +- VpnGw3AZ +- ErGw1AZ +- ErGw2AZ +- ErGw3AZ + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, ErGw1AZ, ErGw2AZ, ErGw3AZ + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGateway +Specifies an object reference to the virtual network gateway to be resized. +You can create this object reference by using the Get-AzVirtualNetworkGateway and specifying the name of the gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +## NOTES +You cannot resize from Basic/Standard/HighPerformance SKUs to the new VpnGw1/VpnGw2/VpnGw3 SKUs. Further resize is not allowed from/to VpnGw1AZ/VpnGw2AZ/VpnGw3AZ or ErGw1AZ/ErGw2AZ/ErGw3AZ. Resize is allowed only within the SKU 'series' e.g VpnGw1AZ can be resized to/from VpnGw2AZ/VpnGw3AZ and ErGw1AZ can be resized to/from ErGw2AZ/ErGw3AZ. See https://learn.microsoft.com/azure/vpn-gateway/vpn-gateway-about-vpngateways for instructions. + +## RELATED LINKS + +[Get-AzVirtualNetworkGateway](./Get-AzVirtualNetworkGateway.md) + +[New-AzVirtualNetworkGateway](./New-AzVirtualNetworkGateway.md) + +[Remove-AzVirtualNetworkGateway](./Remove-AzVirtualNetworkGateway.md) + +[Reset-AzVirtualNetworkGateway](./Reset-AzVirtualNetworkGateway.md) + +[Set-AzVirtualNetworkGateway](./Set-AzVirtualNetworkGateway.md) + +[Get-AzVpnClientPackage](./Get-AzVpnClientPackage.md) diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGateway.md b/azps-10.1.0/Az.Network/Set-AzApplicationGateway.md new file mode 100644 index 0000000000..dee17d5f23 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGateway.md @@ -0,0 +1,101 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 7C8B47B4-2F6A-45EF-A351-88C8C3F9D0D3 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGateway.md +--- + +# Set-AzApplicationGateway + +## SYNOPSIS +Updates an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGateway -ApplicationGateway <PSApplicationGateway> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGateway** cmdlet updates an Azure application gateway. + +## EXAMPLES + +### Example 1: Update an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name Test -ResourceGroupName Appgwtest +$AppGw.Tag = @{"key"="value"} +$UpdatedAppGw = Set-AzApplicationGateway -ApplicationGateway $AppGw +``` + +These commands update the application gateway with settings in the $AppGw variable and stores the updated gateway in the $UpdatedAppGw variable. + +## PARAMETERS + +### -ApplicationGateway +Specifies an application gateway object representing the state to which the application gateway should be set. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Start-AzApplicationGateway](./Start-AzApplicationGateway.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayAuthenticationCertificate.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayAuthenticationCertificate.md new file mode 100644 index 0000000000..546783359e --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayAuthenticationCertificate.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 0108A65B-E322-4783-AB6A-6AF1E1A58AC5 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayauthenticationcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayAuthenticationCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayAuthenticationCertificate.md +--- + +# Set-AzApplicationGatewayAuthenticationCertificate + +## SYNOPSIS +Updates an authentication certificate for an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayAuthenticationCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> + -CertificateFile <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayAuthenticationCertificate** cmdlet updates an authentication certificate for an Azure application gateway. + +## EXAMPLES + +### Example 1: Update an authentication certificate +```powershell +$appgw = Get-AzApplicationGateway -ResourceGroupName "rg" -Name "appGwName" +$appgw = Set-AzApplicationGatewayAuthenticationCertificate -ApplicationGateway $appgw -Name "cert01" -CertificateFile "C:\cert2.cer" +$appgw = Set-AzApplicationGateway -ApplicationGateway $appgw +``` + +The first command gets the application gateway named appGwName and stores the result in the $appgw variable. +The second command updates the authentication certificate named cert01 in the application gateway. +The third command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the name of application gateway for which this cmdlet updates an authentication certificate. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertificateFile +Specifies the path of the authentication certificate file with which this cmdlet updates the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the authentication certificate that this cmdlet updates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Add-AzApplicationGatewayAuthenticationCertificate](./Add-AzApplicationGatewayAuthenticationCertificate.md) + +[Get-AzApplicationGatewayAuthenticationCertificate](./Get-AzApplicationGatewayAuthenticationCertificate.md) + +[New-AzApplicationGatewayAuthenticationCertificate](./New-AzApplicationGatewayAuthenticationCertificate.md) + +[Remove-AzApplicationGatewayAuthenticationCertificate](./Remove-AzApplicationGatewayAuthenticationCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayAutoscaleConfiguration.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayAutoscaleConfiguration.md new file mode 100644 index 0000000000..6e531f798c --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayAutoscaleConfiguration.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayautoscaleconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayAutoscaleConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayAutoscaleConfiguration.md +--- + +# Set-AzApplicationGatewayAutoscaleConfiguration + +## SYNOPSIS +Updates Autoscale Configuration of an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayAutoscaleConfiguration -ApplicationGateway <PSApplicationGateway> -MinCapacity <Int32> + [-MaxCapacity <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayAutoscaleConfiguration** cmdlet modifies the existing autoscale configuration of an Application Gateway. + +## EXAMPLES + +### Example 1 +```powershell +$gw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $resgpName +$gw = Set-AzApplicationGatewayAutoscaleConfiguration -ApplicationGateway $gw -MinCapacity 5 +$gw = Set-AzApplicationGateway -ApplicationGateway $gw +``` + +The first command gets the application gateway and stores it in $gw variable. +The second command updates the autoscale configuration from the application gateway. +The third command updates the application gateway on Azure. + +### Example 2 + +Updates Autoscale Configuration of an application gateway. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzApplicationGatewayAutoscaleConfiguration -ApplicationGateway <PSApplicationGateway> -MaxCapacity 5 -MinCapacity 4 +``` + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCapacity +Maximum capacity for application gateway. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinCapacity +Minimum capacity for application gateway. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewayAutoscaleConfiguration](./Get-AzApplicationGatewayAutoscaleConfiguration.md) + +[New-AzApplicationGatewayAutoscaleConfiguration](./New-AzApplicationGatewayAutoscaleConfiguration.md) + +[Remove-AzApplicationGatewayAutoscaleConfiguration](./Remove-AzApplicationGatewayAutoscaleConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayBackendAddressPool.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayBackendAddressPool.md new file mode 100644 index 0000000000..7561f2b77c --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayBackendAddressPool.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C2C5E0C0-E212-4554-966B-940B1B6FE235 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewaybackendaddresspool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayBackendAddressPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayBackendAddressPool.md +--- + +# Set-AzApplicationGatewayBackendAddressPool + +## SYNOPSIS +Updates a back-end address pool for an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayBackendAddressPool -ApplicationGateway <PSApplicationGateway> -Name <String> + [-BackendIPAddresses <String[]>] [-BackendFqdns <String[]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayBackendAddressPool** cmdlet updates a back-end address pool for an Azure application gateway. +Back-end addresses can be specified as IP addresses or fully-qualified domain names (FQDN). + +## EXAMPLES + +### Example 1: Setting a back-end address pool by using FQDNs +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "Pool02" -BackendFqdns "contoso1.com", "contoso2.com" +Set-AzApplicationGateway -ApplicationGateway $AppGw +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The second command updates the back-end address pool of the application gateway in $AppGw by using FQDNs. + +### Example 2: Setting a back-end address pool by using backend server IP addresses +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "Pool02" -BackendIPAddresses "10.10.10.10", "10.10.10.11" +Set-AzApplicationGateway -ApplicationGateway $AppGw +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The second command updates the back-end address pool of the application gateway in $AppGw by using IP addresses. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway with which this cmdlet associates the back-end address pool. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -BackendFqdns +Specifies a list of back-end IP addresses to use as a back-end server pool. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendIPAddresses +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the back-end address pool. +This back-end address pool must exist in the application gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayBackendAddressPool](./Add-AzApplicationGatewayBackendAddressPool.md) + +[Get-AzApplicationGatewayBackendAddressPool](./Get-AzApplicationGatewayBackendAddressPool.md) + +[New-AzApplicationGatewayBackendAddressPool](./New-AzApplicationGatewayBackendAddressPool.md) + +[Remove-AzApplicationGatewayBackendAddressPool](./Remove-AzApplicationGatewayBackendAddressPool.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayBackendHttpSetting.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayBackendHttpSetting.md new file mode 100644 index 0000000000..3437592302 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayBackendHttpSetting.md @@ -0,0 +1,324 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewaybackendhttpsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayBackendHttpSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayBackendHttpSetting.md +--- + +# Set-AzApplicationGatewayBackendHttpSetting + +## SYNOPSIS +Updates back-end HTTP settings for an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayBackendHttpSetting -ApplicationGateway <PSApplicationGateway> -Name <String> + -Port <Int32> -Protocol <String> -CookieBasedAffinity <String> [-RequestTimeout <Int32>] + [-ConnectionDraining <PSApplicationGatewayConnectionDraining>] [-ProbeId <String>] + [-Probe <PSApplicationGatewayProbe>] + [-AuthenticationCertificates <PSApplicationGatewayAuthenticationCertificate[]>] + [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>] [-PickHostNameFromBackendAddress] + [-HostName <String>] [-AffinityCookieName <String>] [-Path <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzApplicationGatewayBackendHttpSetting cmdlet updates the back-end Hypertext Transfer Protocol (HTTP) settings for an Azure application gateway. +Back-end HTTP settings are applied to all back-end servers in a pool. + +## EXAMPLES + +### Example 1: Update the back-end HTTP settings for an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayBackendHttpSetting -ApplicationGateway $AppGw -Name "Setting02" -Port 88 -Protocol "Http" -CookieBasedAffinity "Disabled" +``` + +The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command updates the HTTP settings of the application gateway in the $AppGw variable to use port 88, the HTTP protocol and enables cookie-based affinity. + +### Example 2 + +Updates back-end HTTP settings for an application gateway. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzApplicationGatewayBackendHttpSetting -ApplicationGateway <PSApplicationGateway> -CookieBasedAffinity Enabled -Name 'Setting02' -Port 88 -Probe <PSApplicationGatewayProbe> -Protocol https -RequestTimeout <Int32> +``` + +## PARAMETERS + +### -AffinityCookieName +Cookie name to use for the affinity cookie + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationGateway +Specifies an application gateway object with which this cmdlet associates back-end HTTP settings. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AuthenticationCertificates +Specifies authentication certificates for the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionDraining +Connection draining of the backend http settings resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CookieBasedAffinity +Specifies whether cookie-based affinity should be enabled or disabled for the backend server pool. +The acceptable values for this parameter are: Disabled or Enabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +Sets host header to be sent to the backend servers. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the back-end HTTP settings object. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Path which should be used as a prefix for all HTTP requests. +If no value is provided for this parameter, then no path will be prefixed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PickHostNameFromBackendAddress +Flag if host header should be picked from the host name of the backend server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Specifies the port to use for each server in the back-end server pool. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Probe +Specifies a probe to associate with the back-end HTTP settings. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeId +Specifies the ID of the probe to associate with the back-end HTTP settings. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol to use for communication between the application gateway and back-end servers. +The acceptable values for this parameter are: Http and Https. +This parameter is case-sensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestTimeout +Specifies a request time-out value. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedRootCertificate +Application gateway Trusted Root Certificates + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayBackendHttpSetting](./Add-AzApplicationGatewayBackendHttpSetting.md) + +[Get-AzApplicationGatewayBackendHttpSetting](./Get-AzApplicationGatewayBackendHttpSetting.md) + +[New-AzApplicationGatewayBackendHttpSetting](./New-AzApplicationGatewayBackendHttpSetting.md) + +[Remove-AzApplicationGatewayBackendHttpSetting](./Remove-AzApplicationGatewayBackendHttpSetting.md) + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayBackendSetting.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayBackendSetting.md new file mode 100644 index 0000000000..920dbab84d --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayBackendSetting.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewaybackendsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayBackendSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayBackendSetting.md +--- + +# Set-AzApplicationGatewayBackendSetting + +## SYNOPSIS +Updates back-end TCP\TLS settings for an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayBackendSetting -ApplicationGateway <PSApplicationGateway> -Name <String> -Port <Int32> + -Protocol <String> [-Timeout <Int32>] [-ProbeId <String>] [-Probe <PSApplicationGatewayProbe>] + [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>] [-PickHostNameFromBackendAddress] + [-HostName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzApplicationGatewayBackendSetting cmdlet updates the back-end TCP\TLS settings for an Azure application gateway. +Back-end settings are applied to all back-end servers in a pool. + +## EXAMPLES + +### Example 1: Update the back-end TCP\TLS settings for an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayBackendSetting -ApplicationGateway $AppGw -Name "Setting02" -Port 88 -Protocol "Tcp" +``` + +The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command updates the Backend settings of the application gateway in the $AppGw variable to use port 88, the TCP protocol. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +Sets host header to be sent to the backend servers. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the backend settings + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PickHostNameFromBackendAddress +Flag if host header should be picked from the host name of the backend server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Port + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Probe +Application gateway Probe + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeId +ID of the application gateway Probe + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TCP, TLS + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +Timeout. +Default value 30 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedRootCertificate +Application gateway Trusted Root Certificates + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayBackendSetting](./Add-AzApplicationGatewayBackendSetting.md) + +[Get-AzApplicationGatewayBackendSetting](./Get-AzApplicationGatewayBackendSetting.md) + +[New-AzApplicationGatewayBackendSetting](./New-AzApplicationGatewayBackendSetting.md) + +[Remove-AzApplicationGatewayBackendSetting](./Remove-AzApplicationGatewayBackendSetting.md) diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayClientAuthConfiguration.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayClientAuthConfiguration.md new file mode 100644 index 0000000000..59cdbeefd9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayClientAuthConfiguration.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayclientauthconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayClientAuthConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayClientAuthConfiguration.md +--- + +# Set-AzApplicationGatewayClientAuthConfiguration + +## SYNOPSIS +Modifies the client auth configuration of a ssl profile object. + +## SYNTAX + +``` +Set-AzApplicationGatewayClientAuthConfiguration -SslProfile <PSApplicationGatewaySslProfile> + [-VerifyClientCertIssuerDN] [-VerifyClientRevocation <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayClientAuthConfiguration** cmdlet modifies the client auth configuration of a ssl profile object. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$profile = Get-AzApplicationGatewaySslProfile -Name "SslProfile01" -ApplicationGateway $AppGw +Set-AzApplicationGatewayClientAuthConfiguration -SslProfile $profile -VerifyClientCertIssuerDN -VerifyClientRevocation OCSP +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. The second command gets the ssl profile named SslProfile01 for $AppGw and stores the settings in the $profile variable. The last command modifies the client auth configuration of the ssl profile object stored in $profile. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfile +The ssl profile + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VerifyClientCertIssuerDN +Verify client certificate revocation status. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VerifyClientRevocation +Verify client certificate issuer name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, OCSP + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayClientAuthConfiguration](./New-AzApplicationGatewayClientAuthConfiguration.md) + +[Get-AzApplicationGatewayClientAuthConfiguration](./Get-AzApplicationGatewayClientAuthConfiguration.md) + +[Remove-AzApplicationGatewayClientAuthConfiguration](./Remove-AzApplicationGatewayClientAuthConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayConnectionDraining.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayConnectionDraining.md new file mode 100644 index 0000000000..943263fcfa --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayConnectionDraining.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayconnectiondraining +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayConnectionDraining.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayConnectionDraining.md +--- + +# Set-AzApplicationGatewayConnectionDraining + +## SYNOPSIS +Modifies the connection draining configuration of a back-end HTTP settings object. + +## SYNTAX + +``` +Set-AzApplicationGatewayConnectionDraining -BackendHttpSettings <PSApplicationGatewayBackendHttpSettings> + -Enabled <Boolean> -DrainTimeoutInSec <Int32> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayConnectionDraining** cmdlet modifies the connection draining configuration of a back-end HTTP settings object. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$Settings = Get-AzApplicationGatewayBackendHttpSetting -Name "Settings01" -ApplicationGateway $AppGw +Set-AzApplicationGatewayConnectionDraining -BackendHttpSettings $poolSetting02 -Enabled $False -DrainTimeoutInSec 3600 +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command gets the back-end HTTP settings named Settings01 for $AppGw and stores the settings in the $Settings variable. +The last command modifies the connection draining configuration of the back-end HTTP settings object stored in $Settings by setting Enabled to False and DrainTimeoutInSec to 3600. + +## PARAMETERS + +### -BackendHttpSettings +The backend http settings + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DrainTimeoutInSec +The number of seconds connection draining is active. +Acceptable values are from 1 second to 3600 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Whether connection draining is enabled or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGateway](./Get-AzApplicationGateway.md) + +[Get-AzApplicationGatewayBackendHttpSetting](./Get-AzApplicationGatewayBackendHttpSetting.md) + +[Get-AzApplicationGatewayConnectionDraining](./Get-AzApplicationGatewayConnectionDraining.md) + +[New-AzApplicationGatewayConnectionDraining](./New-AzApplicationGatewayConnectionDraining.md) + +[Remove-AzApplicationGatewayConnectionDraining](./Remove-AzApplicationGatewayConnectionDraining.md) + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayCustomError.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayCustomError.md new file mode 100644 index 0000000000..82bc08ad1b --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayCustomError.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewaycustomerror +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayCustomError.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayCustomError.md +--- + +# Set-AzApplicationGatewayCustomError + +## SYNOPSIS +Updates a custom error in an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayCustomError -ApplicationGateway <PSApplicationGateway> -StatusCode <String> + -CustomErrorPageUrl <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayCustomError** cmdlet updates a custom error in an application gateway. + +## EXAMPLES + +### Example 1: Updates custom error in an application gateway +```powershell +$customError502Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/502.htm" +$updatedgateway = Set-AzApplicationGatewayCustomError -ApplicationGateway $appgw -StatusCode HttpStatus502 -CustomErrorPageUrl $customError502Url +``` + +This command updates the custom error of http status code 502 in the application gateway $appgw, and returns the updated gateway. + +## PARAMETERS + +### -ApplicationGateway +The Application Gateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CustomErrorPageUrl +Error page URL of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusCode +Status code of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayCustomError](./Add-AzApplicationGatewayCustomError.md) + +[Get-AzApplicationGatewayCustomError](./Get-AzApplicationGatewayCustomError.md) + +[New-AzApplicationGatewayCustomError](./New-AzApplicationGatewayCustomError.md) + +[Remove-AzApplicationGatewayCustomError](./Remove-AzApplicationGatewayCustomError.md) diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayFirewallPolicy.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayFirewallPolicy.md new file mode 100644 index 0000000000..6cc9cc55fb --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayFirewallPolicy.md @@ -0,0 +1,236 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayfirewallpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayFirewallPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayFirewallPolicy.md +--- + +# Set-AzApplicationGatewayFirewallPolicy + +## SYNOPSIS +Updates an application gateway firewall policy. + +## SYNTAX + +### ByFactoryObject (Default) +``` +Set-AzApplicationGatewayFirewallPolicy -InputObject <PSApplicationGatewayWebApplicationFirewallPolicy> + [-CustomRule <PSApplicationGatewayFirewallCustomRule[]>] + [-PolicySetting <PSApplicationGatewayFirewallPolicySettings>] + [-ManagedRule <PSApplicationGatewayFirewallPolicyManagedRules>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByFactoryName +``` +Set-AzApplicationGatewayFirewallPolicy -Name <String> -ResourceGroupName <String> + [-CustomRule <PSApplicationGatewayFirewallCustomRule[]>] + [-PolicySetting <PSApplicationGatewayFirewallPolicySettings>] + [-ManagedRule <PSApplicationGatewayFirewallPolicyManagedRules>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzApplicationGatewayFirewallPolicy -ResourceId <String> + [-CustomRule <PSApplicationGatewayFirewallCustomRule[]>] + [-PolicySetting <PSApplicationGatewayFirewallPolicySettings>] + [-ManagedRule <PSApplicationGatewayFirewallPolicyManagedRules>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayFirewallPolicy** cmdlet updates an Azure application gateway firewall policy. + +## EXAMPLES + +### Example 1 +```powershell +$UpdatedAppGwFirewallPolicy = Set-AzApplicationGatewayFirewallPolicy -InputObject $AppGwFirewallPolicy +``` + +This command updates the application gateway firewall policy with settings in the $AppGwFirewallPolicy variable and stores the updated application gateway firewall policy in the $UpdatedAppGwFirewallPolicy variable. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomRule +The list of CustomRules + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallCustomRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The applicationGatewayFirewallPolicy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallPolicy +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagedRule +ManagedRules of the firewall policy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicyManagedRules +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The Firewall Policy Name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicySetting +Policysettings of the firewall policy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallPolicySettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByFactoryName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayFrontendIPConfig.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayFrontendIPConfig.md new file mode 100644 index 0000000000..1798d9bde0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayFrontendIPConfig.md @@ -0,0 +1,264 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 2C024C32-1B03-4BAA-AD31-4974D414C998 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayfrontendipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayFrontendIPConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayFrontendIPConfig.md +--- + +# Set-AzApplicationGatewayFrontendIPConfig + +## SYNOPSIS +Modifies a front-end IP address configuration. + +## SYNTAX + +### SetByResourceId +``` +Set-AzApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + [-PrivateIPAddress <String>] [-SubnetId <String>] [-PublicIPAddressId <String>] + [-PrivateLinkConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +Set-AzApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + [-PrivateIPAddress <String>] [-Subnet <PSSubnet>] [-PublicIPAddress <PSPublicIpAddress>] + [-PrivateLinkConfiguration <PSApplicationGatewayPrivateLinkConfiguration>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayFrontendIPConfig** cmdlet updates a front-end IP configuration. +An application gateway supports two types of front-end IP addresses: +- Public IP addresses +- Private IP addresses for which the configuration uses Internal Load Balancing (ILB) +An application gateway can have at most one public IP address and one private IP address. +A public IP address and a private IP address should be added separately as front-end IP addresses. + +## EXAMPLES + +### Example 1: Set a public IP as front-end IP of an application gateway +```powershell +$PublicIp = New-AzPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIp01" -location "West US" -AllocationMethod Dynamic +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontEndIp01" -PublicIPAddress $PublicIp +``` + +The first command creates a public IP address object and stores it in the $PublicIp variable. +The second command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The third command updates the front-end IP configuration named FrontEndIp01, for the gateway in $AppGw, using the address stored in $PublicIp. + +### Example 2: Set a static private IP as the front-end IP of an application gateway +```powershell +$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" +$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontendIP02" -Subnet $Subnet -PrivateIPAddress 10.0.1.1 +``` + +The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. +The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. +The third command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command and the private IP address 10.0.1.1. + +### Example 3: Set a dynamic private IP as the front-end IP of an application gateway +```powershell +$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" +$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontendIP02" -Subnet $Subnet +``` + +The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. +The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. +The third command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command. + +## PARAMETERS + +### -ApplicationGateway +Specifies an application gateway object in which to modify the front-end IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the front-end IP configuration that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIPAddress +Specifies the private IP address. +If specified, this IP is statically allocated from the subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkConfiguration +PrivateLinkConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkConfigurationId +PrivateLinkConfigurationId + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIPAddress +Specifies the public IP address. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIPAddressId +Specifies the ID of the public IP address. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Specifies the subnet that the application gateway uses. +Specify this parameter if the gateway uses a private IP address. +If the *PrivateIPAddress* address is specified, it should belong to this subnet. +If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Specifies the subnet ID. +Specify this parameter if the gateway uses a private IP address. +If the *PrivateIPAddress* parameter is specified, it should belong to this subnet. +If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayFrontendIPConfig](./Add-AzApplicationGatewayFrontendIPConfig.md) + +[Add-AzApplicationGatewayFrontendIPConfig](./Add-AzApplicationGatewayFrontendIPConfig.md) + +[Get-AzApplicationGatewayFrontendIPConfig](./Get-AzApplicationGatewayFrontendIPConfig.md) + +[New-AzApplicationGatewayFrontendIPConfig](./New-AzApplicationGatewayFrontendIPConfig.md) + +[Remove-AzApplicationGatewayFrontendIPConfig](./Remove-AzApplicationGatewayFrontendIPConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayFrontendPort.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayFrontendPort.md new file mode 100644 index 0000000000..07a7bffec4 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayFrontendPort.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 85C0A1C3-FC6D-496A-B6B5-8DC2A73B8032 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayfrontendport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayFrontendPort.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayFrontendPort.md +--- + +# Set-AzApplicationGatewayFrontendPort + +## SYNOPSIS +Modifies a front-end port for an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayFrontendPort -ApplicationGateway <PSApplicationGateway> -Name <String> -Port <Int32> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayFrontendPort** cmdlet modifies a front-end port for an +application gateway. + +## EXAMPLES + +### Example 1: Set an application gateway front-end port to 80 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayFrontendPort -ApplicationGateway $AppGw -Name "FrontEndPort01" -Port 80 +``` + +The first command gets the application gateway named ApplicationGateway01 that belongs to the +resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command modifies the gateway in $AppGw to use port 80 for the front-end port named +FrontEndPort01. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway object with which this cmdlet associates the front-end port. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the front-end port to modify. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Specifies the port number to use for the front-end port. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayFrontendPort](./Add-AzApplicationGatewayFrontendPort.md) + +[Get-AzApplicationGatewayFrontendPort](./Get-AzApplicationGatewayFrontendPort.md) + +[New-AzApplicationGatewayFrontendPort](./New-AzApplicationGatewayFrontendPort.md) + +[Remove-AzApplicationGatewayFrontendPort](./Remove-AzApplicationGatewayFrontendPort.md) diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayHttpListener.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayHttpListener.md new file mode 100644 index 0000000000..8f6a529237 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayHttpListener.md @@ -0,0 +1,364 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: F8068AF1-3380-4E60-B6CF-CC584BD053A7 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayhttplistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayHttpListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayHttpListener.md +--- + +# Set-AzApplicationGatewayHttpListener + +## SYNOPSIS +Modifies an HTTP listener for an application gateway. + +## SYNTAX + +### SetByResourceId +``` +Set-AzApplicationGatewayHttpListener -ApplicationGateway <PSApplicationGateway> -Name <String> + [-FrontendIPConfigurationId <String>] [-FrontendPortId <String>] [-SslCertificateId <String>] + [-FirewallPolicyId <String>] [-SslProfileId <String>] [-HostName <String>] [-HostNames <String[]>] + [-RequireServerNameIndication <String>] -Protocol <String> + [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SetByResource +``` +Set-AzApplicationGatewayHttpListener -ApplicationGateway <PSApplicationGateway> -Name <String> + [-FrontendIPConfiguration <PSApplicationGatewayFrontendIPConfiguration>] + [-FrontendPort <PSApplicationGatewayFrontendPort>] + [-FirewallPolicy <PSApplicationGatewayWebApplicationFirewallPolicy>] + [-SslCertificate <PSApplicationGatewaySslCertificate>] [-SslProfile <PSApplicationGatewaySslProfile>] + [-HostName <String>] [-HostNames <String[]>] [-RequireServerNameIndication <String>] -Protocol <String> + [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayHttpListener** cmdlet modifies an HTTP listener for an Azure application gateway. + +## EXAMPLES + +### Example 1: Set an HTTP listener +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "Listener01" -Protocol Http -FrontendIpConfiguration $FIP01 -FrontendPort 80 +``` + +The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command sets the HTTP listener for the gateway to use the front-end configuration stored in $FIP01 with the HTTP protocol on port 80. + +### Example 2: Add a HTTPS listener with SSL and HostNames +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "Listener01" -Protocol "Https" -FrontendIpConfiguration $FIP01 -FrontendPort $FP01 -SslCertificate $SSLCert01 -HostNames "*.contoso.com,www.microsoft.com" +``` + +The first command gets the application gateway and stores it in the $AppGw variable. +The second command adds the listener, which uses the HTTPS protocol, with SSL Certificates and HostNames, to the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway with which this cmdlet associates the HTTP listener. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CustomErrorConfiguration +Customer error of an application gateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicy +FirewallPolicy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallPolicy +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicyId +FirewallPolicyId + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIPConfiguration +Specifies the front-end IP address of the application gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIPConfigurationId +Specifies the ID of the front-end IP address of the application gateway. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendPort +Specifies the application gateway front-end port. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendPortId +Specifies the application gateway front-end port ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +Specifies the host name that this cmdlet sends the HTTP listener to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostNames +Host names + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the HTTP listener. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol that the HTTP listener uses. +The acceptable values for this parameter are: +- Http +- Https + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireServerNameIndication +Specifies whether the cmdlet requires a server name indication. +The acceptable values for this parameter are: true or false. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: true, false + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificate +Specifies the SSL certificate of the HTTP listener. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificateId +Specifies the Secure Socket Layer (SSL) certificate ID of the HTTP listener. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfile +SslProfile + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfileId +SslProfileId + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayHttpListener](./Add-AzApplicationGatewayHttpListener.md) + +[Get-AzApplicationGatewayHttpListener](./Get-AzApplicationGatewayHttpListener.md) + +[New-AzApplicationGatewayHttpListener](./New-AzApplicationGatewayHttpListener.md) + +[Remove-AzApplicationGatewayHttpListener](./Remove-AzApplicationGatewayHttpListener.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayHttpListenerCustomError.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayHttpListenerCustomError.md new file mode 100644 index 0000000000..4f12e24c6b --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayHttpListenerCustomError.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayhttplistenercustomerror +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayHttpListenerCustomError.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayHttpListenerCustomError.md +--- + +# Set-AzApplicationGatewayHttpListenerCustomError + +## SYNOPSIS +Updates a custom error in a http listener of an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayHttpListenerCustomError -HttpListener <PSApplicationGatewayHttpListener> + -StatusCode <String> -CustomErrorPageUrl <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayHttpListenerCustomError** cmdlet updates a custom error in a http listener of an application gateway. + +## EXAMPLES + +### Example 1: Updates a custom error from a http listener +```powershell +$customError502Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/502.htm" +$updatedlistener = Set-AzApplicationGatewayHttpListenerCustomError -HttpListener $listener01 -StatusCode HttpStatus502 -CustomErrorPageUrl $customError502Url +``` + +This command updates the custom error of http status code 502 in the http listener $listener01, and returns the updated listener. + +## PARAMETERS + +### -CustomErrorPageUrl +Error page URL of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpListener +The Application Gateway Http Listener + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StatusCode +Status code of the application gateway customer error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayHttpListenerCustomError](./Add-AzApplicationGatewayHttpListenerCustomError.md) + +[Get-AzApplicationGatewayHttpListenerCustomError](./Get-AzApplicationGatewayHttpListenerCustomError.md) + +[Remove-AzApplicationGatewayHttpListenerCustomError](./Remove-AzApplicationGatewayHttpListenerCustomError.md) diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayIPConfiguration.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayIPConfiguration.md new file mode 100644 index 0000000000..bef99e1a73 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayIPConfiguration.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 4D5F469D-FF1F-4D49-AC42-26E6DECFAA26 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayipconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayIPConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayIPConfiguration.md +--- + +# Set-AzApplicationGatewayIPConfiguration + +## SYNOPSIS +Modifies an IP configuration for an application gateway. + +## SYNTAX + +### SetByResourceId +``` +Set-AzApplicationGatewayIPConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> + [-SubnetId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +Set-AzApplicationGatewayIPConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> + [-Subnet <PSSubnet>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayIPConfiguration** cmdlet modifies an IP configuration. +An IP configuration contains the subnet in which an application gateway is deployed. + +## EXAMPLES + +### Example 1: Update an IP configuration for an application gateway +```powershell +$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" +$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayIPConfiguration -ApplicationGateway $AppGw -Name "AppgwSubnet01" -Subnet $Subnet +``` + +The first command gets the virtual network named VNet01 that belongs to the resource group named ResourceGroup01 and stores it in the $VNet variable. +The second command gets the subnet configuration named Subnet01 using $VNet and stores it in the $Subnet variable. +The third command gets an application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The forth command sets the IP configuration of the application gateway stored in $AppGw to the subnet configuration stored in $Subnet. + +## PARAMETERS + +### -ApplicationGateway +Specifies an application gateway object with which this cmdlet associates an IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the IP configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Specifies the subnet. +This is the subnet in which the application gateway is deployed. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Specifies the subnet ID. +This is the subnet in which the application gateway is deployed. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayIPConfiguration](./Add-AzApplicationGatewayIPConfiguration.md) + +[Add-AzApplicationGatewayIPConfiguration](./Add-AzApplicationGatewayIPConfiguration.md) + +[Get-AzApplicationGatewayIPConfiguration](./Get-AzApplicationGatewayIPConfiguration.md) + +[New-AzApplicationGatewayIPConfiguration](./New-AzApplicationGatewayIPConfiguration.md) + +[Remove-AzApplicationGatewayIPConfiguration](./Remove-AzApplicationGatewayIPConfiguration.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayIdentity.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayIdentity.md new file mode 100644 index 0000000000..6cd3824ed2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayIdentity.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayidentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayIdentity.md +--- + +# Set-AzApplicationGatewayIdentity + +## SYNOPSIS +Updates a identity assigned to the application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayIdentity -ApplicationGateway <PSApplicationGateway> -UserAssignedIdentityId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayIdentity** cmdlet updates an identity assigned to application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$appgw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $rgName +$identity = New-AzUserAssignedIdentity -Name $identityName -ResourceGroupName $rgName -Location $location +$appgwIdentity = Set-AzApplicationGatewayIdentity -UserAssignedIdentity $identity.Id -ApplicationGateway $appgw +$updatedAppGw = Set-AzApplicationGateway -ApplicationGateway $appgw +``` + +In this example, we assign a user assigned identity to an existing application gateway. +Note: This identity should have access to the keyvault from which the certificates/secrets will be referenced. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +ResourceId of the user assigned identity to be assigned to Application Gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: UserAssignedIdentity + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayListener.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayListener.md new file mode 100644 index 0000000000..e1c0110c07 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayListener.md @@ -0,0 +1,260 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewaylistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayListener.md +--- + +# Set-AzApplicationGatewayListener + +## SYNOPSIS +Modifies a TCP\TLS listener for an application gateway. + +## SYNTAX + +### SetByResource (Default) +``` +Set-AzApplicationGatewayListener -ApplicationGateway <PSApplicationGateway> -Name <String> + [-FrontendIPConfiguration <PSApplicationGatewayFrontendIPConfiguration>] + [-FrontendPort <PSApplicationGatewayFrontendPort>] [-SslCertificate <PSApplicationGatewaySslCertificate>] + [-SslProfile <PSApplicationGatewaySslProfile>] -Protocol <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SetByResourceId +``` +Set-AzApplicationGatewayListener -ApplicationGateway <PSApplicationGateway> -Name <String> + [-FrontendIPConfigurationId <String>] [-FrontendPortId <String>] [-SslCertificateId <String>] + [-SslProfileId <String>] -Protocol <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayListener** cmdlet modifies a TCP\TLS listener for an Azure application gateway. + +## EXAMPLES + +### Example 1: Set a TCP listener +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayListener -ApplicationGateway $AppGw -Name "Listener01" -Protocol Tcp -FrontendIpConfiguration $FIP01 -FrontendPort 80 +``` + +The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command sets the listener for the gateway to use the front-end configuration stored in $FIP01 with the Tcp protocol on port 80. + +### Example 2: Add a TLS listener with SSL Certificate +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayListener -ApplicationGateway $AppGw -Name "Listener01" -Protocol "Tls" -FrontendIpConfiguration $FIP01 -FrontendPort $FP01 -SslCertificate $SSLCert01 +``` + +The first command gets the application gateway and stores it in the $AppGw variable. +The second command adds the listener, which uses the Tls protocol, with SSL Certificates , to the application gateway. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIPConfiguration +Application gateway FrontendIPConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIPConfigurationId +ID of the application gateway FrontendIPConfiguration + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendPort +Application gateway FrontendPort + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendPortId +ID of the application gateway FrontendPort + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Listener + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TCP, TLS + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificate +Application gateway SslCertificate + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificateId +ID of the application gateway SslCertificate + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfile +SslProfile + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfileId +SslProfileId + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayListener](./Add-AzApplicationGatewayListener.md) + +[Get-AzApplicationGatewayListener](./Get-AzApplicationGatewayListener.md) + +[New-AzApplicationGatewayListener](./New-AzApplicationGatewayListener.md) + +[Remove-AzApplicationGatewayListener](./Remove-AzApplicationGatewayListener.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayPrivateLinkConfiguration.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayPrivateLinkConfiguration.md new file mode 100644 index 0000000000..77340199b0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayPrivateLinkConfiguration.md @@ -0,0 +1,122 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayprivatelinkconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayPrivateLinkConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayPrivateLinkConfiguration.md +--- + +# Set-AzApplicationGatewayPrivateLinkConfiguration + +## SYNOPSIS +Modifies an PrivateLink Configuration for an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayPrivateLinkConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> + -IpConfiguration <PSApplicationGatewayPrivateLinkIpConfiguration[]> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayPrivateLinkConfiguration** cmdlet modifies an privateLink configuration for an Azure application gateway. + +## EXAMPLES + +### Example 1: Set a PrivateLink Configuration +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayPrivateLinkConfiguration -ApplicationGateway $AppGw -Name "privateLinkConfig01" -IpConfiguration $privateLinkIpConfiguration01 +``` + +The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. +The second command sets the privateLink configuration with name privateLinkConfig01 to use the ip configuration stored in $privateLinkIpConfiguration01 + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfiguration +The list of ipConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkIpConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the privateLink configuration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkIpConfiguration[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[New-AzApplicationGatewayPrivateLinkConfiguration](./New-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Add-AzApplicationGatewayPrivateLinkConfiguration](./Add-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Get-AzApplicationGatewayPrivateLinkConfiguration](./Get-AzApplicationGatewayPrivateLinkConfiguration.md) + +[Remove-AzApplicationGatewayPrivateLinkConfiguration](./Remove-AzApplicationGatewayPrivateLinkConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayProbeConfig.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayProbeConfig.md new file mode 100644 index 0000000000..f0baa21ada --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayProbeConfig.md @@ -0,0 +1,280 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayprobeconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayProbeConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayProbeConfig.md +--- + +# Set-AzApplicationGatewayProbeConfig + +## SYNOPSIS +Sets the health probe configuration on an existing Application Gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayProbeConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + -Protocol <String> [-HostName <String>] [-Path <String>] -Interval <Int32> -Timeout <Int32> + -UnhealthyThreshold <Int32> [-PickHostNameFromBackendHttpSettings] [-MinServers <Int32>] [-Port <Int32>] + [-Match <PSApplicationGatewayProbeHealthResponseMatch>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzApplicationGatewayProbeConfig cmdlet sets the health probe configuration on an existing Application Gateway. + +## EXAMPLES + +### Example 1: Set the configuration for a health probe on an application gateway +```powershell +Set-AzApplicationGatewayProbeConfig -ApplicationGateway Gateway -Name "Probe05" -Protocol Http -HostName "contoso.com" -Path "/path/custompath.htm" -Interval 30 -Timeout 120 -UnhealthyThreshold 8 +``` + +This command sets the configuration for a health probe named Probe05 for the application gateway named Gateway. +The command also sets the unhealthy threshold to 8 retries and times out after 120 seconds. + +### Example 2 + +Sets the health probe configuration on an existing Application Gateway. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzApplicationGatewayProbeConfig -ApplicationGateway Gateway -Interval 30 -Match <PSApplicationGatewayProbeHealthResponseMatch> -Name 'Probe05' -Path '/path/custompath.htm' -PickHostNameFromBackendHttpSettings -Protocol https -Timeout 120 -UnhealthyThreshold 8 +``` + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway to which this cmdlet sends a probe. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +Specifies the host name that this cmdlet sends the probe to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Interval +Specifies the probe interval in seconds. +This is the time interval between two consecutive probes. +This value is between 1 second and 86400 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Match +Body that must be contained in the health response. +Default value is empty + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbeHealthResponseMatch +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinServers +Minimum number of servers that are always marked healthy. +Default value is 0 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the probe. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the relative path of probe. +Valid paths start with the slash character (/). +The probe is sent to \<Protocol\>://\<host\>:\<port\>\<path\>. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PickHostNameFromBackendHttpSettings +Whether the host header should be picked from the backend http settings. +Default value is false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Port that is used for probing the backend server + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol used to send probe. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Http, Https, TCP, TLS + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +Specifies the probe timeout in seconds. +This cmdlet marks the probe as failed if a valid response is not received with this timeout period. +Valid values are between 1 second and 86400 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnhealthyThreshold +Specifies the probe retry count. +The backend server is marked down after consecutive probe failure count reaches the unhealthy threshold. +Valid values are between 1 second and 20 seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayProbeConfig](./Add-AzApplicationGatewayProbeConfig.md) + +[Get-AzApplicationGatewayProbeConfig](./Get-AzApplicationGatewayProbeConfig.md) + +[New-AzApplicationGatewayProbeConfig](./New-AzApplicationGatewayProbeConfig.md) + +[Remove-AzApplicationGatewayProbeConfig](./Remove-AzApplicationGatewayProbeConfig.md) + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayRedirectConfiguration.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayRedirectConfiguration.md new file mode 100644 index 0000000000..a5069231ed --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayRedirectConfiguration.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayredirectconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayRedirectConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayRedirectConfiguration.md +--- + +# Set-AzApplicationGatewayRedirectConfiguration + +## SYNOPSIS +Sets the redirect configuration on an existing Application Gateway. + +## SYNTAX + +### SetByResourceId +``` +Set-AzApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> + -RedirectType <String> [-TargetListenerID <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +Set-AzApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> + -RedirectType <String> [-TargetListener <PSApplicationGatewayHttpListener>] [-IncludePath <Boolean>] + [-IncludeQueryString <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByURL +``` +Set-AzApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> + -RedirectType <String> [-TargetUrl <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +**The Set-AzApplicationGatewayRequestRoutingRule** cmdlet modifies a redirect configuration. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayRedirectConfiguration -ApplicationGateway $appgw -Name "RedirectConfig01" -RedirectType Permanent -TargetUrl "https://www.contoso.com" +``` + +The first command gets the application gateway named ApplicationGateway01 and stores it in the $AppGw variable. +The second command modifies the redirect configuration for the application gateway to redirect type Permanent and use a target url. + +### Example 2 + +Sets the redirect configuration on an existing Application Gateway. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -IncludePath $false -IncludeQueryString $false -Name 'RedirectConfig01' -RedirectType Permanent -TargetListener <PSApplicationGatewayHttpListener> +``` + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePath +Include path in the redirected url. +Default is true. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeQueryString +Include query string in the redirected url. +Default is true. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Redirect Configuration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectType +The type of redirect + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Permanent, Found, SeeOther, Temporary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetListener +HTTP listener to redirect the request to + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetListenerID +ID of HTTP listener to redirect the request to + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetUrl +Target URL fo redirection + +```yaml +Type: System.String +Parameter Sets: SetByURL +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRedirectConfiguration](./Add-AzApplicationGatewayRedirectConfiguration.md) + +[Get-AzApplicationGatewayRedirectConfiguration](./Get-AzApplicationGatewayRedirectConfiguration.md) + +[New-AzApplicationGatewayRedirectConfiguration](./New-AzApplicationGatewayRedirectConfiguration.md) + +[Remove-AzApplicationGatewayRedirectConfiguration](./Remove-AzApplicationGatewayRedirectConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayRequestRoutingRule.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayRequestRoutingRule.md new file mode 100644 index 0000000000..d184f64af0 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayRequestRoutingRule.md @@ -0,0 +1,328 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 75A4826A-7A5F-4742-9DC4-DC728CED63D0 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayrequestroutingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayRequestRoutingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayRequestRoutingRule.md +--- + +# Set-AzApplicationGatewayRequestRoutingRule + +## SYNOPSIS +Modifies a request routing rule for an application gateway. + +## SYNTAX + +### SetByResourceId +``` +Set-AzApplicationGatewayRequestRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> + -RuleType <String> [-Priority <Int32>] [-BackendHttpSettingsId <String>] [-HttpListenerId <String>] + [-BackendAddressPoolId <String>] [-UrlPathMapId <String>] [-RewriteRuleSetId <String>] + [-RedirectConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResource +``` +Set-AzApplicationGatewayRequestRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> + -RuleType <String> [-Priority <Int32>] [-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] + [-HttpListener <PSApplicationGatewayHttpListener>] + [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] [-UrlPathMap <PSApplicationGatewayUrlPathMap>] + [-RewriteRuleSet <PSApplicationGatewayRewriteRuleSet>] + [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayRequestRoutingRule** cmdlet modifies a request routing rule. + +## EXAMPLES + +### Example 1: Update a request routing rule +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayRequestRoutingRule -ApplicationGateway $AppGw -Name "Rule01" -RuleType Basic -Priority 100 -BackendHttpSettings $Setting -HttpListener $Listener -BackendAddressPool $Pool +``` + +The first command gets the application gateway named ApplicationGateway01 and stores it in the $AppGw variable. +The second command modifies the request routing rule for the application gateway to use back-end HTTP settings specified in the $Setting variable, an HTTP listener specified in the $Listener variable, and a back-end address pool specified in the $Pool variable. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway object with which this cmdlet associates a request routing rule. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -BackendAddressPool +Specifies the application gateway back-end address pool. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +Specifies the application gateway back-end address pool ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendHttpSettings +Specifies the application gateway backend HTTP settings. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendHttpSettingsId +Specifies the application gateway back-end HTTP settings ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpListener +Specifies the application gateway HTTP listener. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpListenerId +Specifies the application gateway HTTP listener ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the request routing rule that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The priority of the rule + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectConfiguration +Application gateway RedirectConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectConfigurationId +ID of the application gateway RedirectConfiguration + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RewriteRuleSet +Application gateway RewriteRuleSet + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleSet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RewriteRuleSetId +ID of the application gateway RewriteRuleSet + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleType +Specifies the type of request routing rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, PathBasedRouting + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlPathMap +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlPathMapId +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRequestRoutingRule](./Add-AzApplicationGatewayRequestRoutingRule.md) + +[Get-AzApplicationGatewayRequestRoutingRule](./Get-AzApplicationGatewayRequestRoutingRule.md) + +[New-AzApplicationGatewayRequestRoutingRule](./New-AzApplicationGatewayRequestRoutingRule.md) + +[Remove-AzApplicationGatewayRequestRoutingRule](./Remove-AzApplicationGatewayRequestRoutingRule.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayRewriteRuleSet.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayRewriteRuleSet.md new file mode 100644 index 0000000000..85682397cf --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayRewriteRuleSet.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayrewriteruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayRewriteRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayRewriteRuleSet.md +--- + +# Set-AzApplicationGatewayRewriteRuleSet + +## SYNOPSIS +Modifies a rewrite rule set for an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayRewriteRuleSet -ApplicationGateway <PSApplicationGateway> -Name <String> + -RewriteRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRule]> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayRewriteRuleSet** cmdlet modifies a request routing rule. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayRewriteRuleSet -ApplicationGateway $AppGw -Name "ruleset1" -RewriteRule $rule +``` + +The first command gets the application gateway named ApplicationGateway01 and stores it in the $AppGw variable. +The second command modifies the rewrite rule set for the application gateway to use rewrite rules specified in the $rule variable. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the RewriteRuleSet + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RewriteRule +List of rewrite rules + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRule] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRewriteRuleSet](./Add-AzApplicationGatewayRewriteRuleSet.md) + +[Get-AzApplicationGatewayRewriteRuleSet](./Get-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRuleSet](./New-AzApplicationGatewayRewriteRuleSet.md) + +[Remove-AzApplicationGatewayRewriteRuleSet](./Remove-AzApplicationGatewayRewriteRuleSet.md) + +[New-AzApplicationGatewayRewriteRule](./New-AzApplicationGatewayRewriteRule.md) + +[New-AzApplicationGatewayRewriteRuleActionSet](./New-AzApplicationGatewayRewriteRuleActionSet.md) + +[New-AzApplicationGatewayRewriteRuleHeaderConfiguration](./New-AzApplicationGatewayRewriteRuleHeaderConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayRoutingRule.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayRoutingRule.md new file mode 100644 index 0000000000..1c6fc7ca13 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayRoutingRule.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayroutingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayRoutingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayRoutingRule.md +--- + +# Set-AzApplicationGatewayRoutingRule + +## SYNOPSIS +Modifies a routing rule for an application gateway. + +## SYNTAX + +### SetByResource (Default) +``` +Set-AzApplicationGatewayRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> + -RuleType <String> -Priority <Int32> [-BackendSettings <PSApplicationGatewayBackendSettings>] + [-Listener <PSApplicationGatewayListener>] [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +Set-AzApplicationGatewayRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> + -RuleType <String> -Priority <Int32> [-BackendSettingsId <String>] [-ListenerId <String>] + [-BackendAddressPoolId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayRoutingRule** cmdlet modifies a routing rule. + +## EXAMPLES + +### Example 1: Update a routing rule +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewayRoutingRule -ApplicationGateway $AppGw -Name "Rule01" -RuleType Basic -Priority 100 -BackendSettings $Setting -Listener $Listener -BackendAddressPool $Pool +``` + +The first command gets the application gateway named ApplicationGateway01 and stores it in the $AppGw variable. +The second command modifies the routing rule for the application gateway to use back-end settings specified in the $Setting variable, a listener specified in the $Listener variable, and a back-end address pool specified in the $Pool variable. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -BackendAddressPool +Application gateway BackendAddressPool + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +ID of the application gateway BackendAddressPool + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendSettings +Application gateway BackendSettings + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendSettings +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackendSettingsId +ID of the application gateway BackendSettings + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Listener +Application gateway Listener + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayListener +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListenerId +ID of the application gateway Listener + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Routing Rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The priority of the rule + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleType +The type of rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, PathBasedRouting + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayRoutingRule](./Add-AzApplicationGatewayRoutingRule.md) + +[Get-AzApplicationGatewayRoutingRule](./Get-AzApplicationGatewayRoutingRule.md) + +[New-AzApplicationGatewayRoutingRule](./New-AzApplicationGatewayRoutingRule.md) + +[Remove-AzApplicationGatewayRoutingRule](./Remove-AzApplicationGatewayRoutingRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySku.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySku.md new file mode 100644 index 0000000000..1ac983fc1b --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySku.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 3D88F561-7FE4-4017-BAC4-8F085AD037A9 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewaysku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewaySku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewaySku.md +--- + +# Set-AzApplicationGatewaySku + +## SYNOPSIS +Modifies the SKU of an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewaySku -ApplicationGateway <PSApplicationGateway> -Name <String> -Tier <String> + [-Capacity <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewaySku** cmdlet modifies the stock keeping unit (SKU) of an application gateway. + +## EXAMPLES + +### Example 1: Update the application gateway SKU +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewaySku -ApplicationGateway $AppGw -Name "Standard_Small" -Tier "Standard" -Capacity 2 +``` + +The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. +The second command updates the SKU of the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway object with which this cmdlet associates the SKU. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Capacity +Specifies the instance count of the application gateway. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the application gateway. +The acceptable values for this parameter are: +- Standard_Small +- Standard_Medium +- Standard_Large +- WAF_Medium +- WAF_Large + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Standard_Small, Standard_Medium, Standard_Large, WAF_Medium, WAF_Large, Standard_v2, WAF_v2 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tier +Specifies the tier of the application gateway. +The acceptable values for this parameter are: +- Standard +- WAF + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Standard, WAF, Standard_v2, WAF_v2 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewaySku](./Get-AzApplicationGatewaySku.md) + +[New-AzApplicationGatewaySku](./New-AzApplicationGatewaySku.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySslCertificate.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySslCertificate.md new file mode 100644 index 0000000000..6e5572e4ea --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySslCertificate.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: D7C275E5-BC43-454B-BF1E-48D639C4B4F0 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewaysslcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewaySslCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewaySslCertificate.md +--- + +# Set-AzApplicationGatewaySslCertificate + +## SYNOPSIS +Updates an SSL certificate for an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewaySslCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> + [-CertificateFile <String>] [-Password <SecureString>] [-KeyVaultSecretId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewaySslCertificate** cmdlet updates an SSL certificate for an application gateway. + +## EXAMPLES + +### Example 1: Update an existing SSL certificate on Application Gateway +```powershell +$appGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$password = ConvertTo-SecureString $passwordPlainString -AsPlainText -Force +$cert = Set-AzApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert01" -CertificateFile "D:\cert01.pfx" -Password $password +``` + +Update an existing SSL certificate for the application gateway named ApplicationGateway01. + +### Example 2: Update an existing SSL certificate using KeyVault Secret (version-less secretId) on Application Gateway +```powershell +$secret = Get-AzKeyVaultSecret -VaultName "keyvault01" -Name "sslCert01" +$secretId = $secret.Id.Replace($secret.Version, "") # https://<keyvaultname>.vault.azure.net/secrets/ +$cert = Set-AzApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert01" -KeyVaultSecretId $secretId +``` + +Get the secret and update an existing SSL Certificate using `Set-AzApplicationGatewaySslCertificate`. + +### Example 3: Update an existing SSL certificate using KeyVault Secret on Application Gateway +```powershell +$secret = Get-AzKeyVaultSecret -VaultName "keyvault01" -Name "sslCert01" +$secretId = $secret.Id # https://<keyvaultname>.vault.azure.net/secrets/<hash> +$cert = Set-AzApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert01" -KeyVaultSecretId $secretId +``` + +Get the secret and update an existing SSL Certificate using `Set-AzApplicationGatewaySslCertificate`. +Note: If it is required that Application Gateway syncs the certificate with the KeyVault, please provide the version-less secretId. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway with which the Secure Socket Layer (SSL) certificate is associated. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertificateFile +Specifies the path of the SSL certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultSecretId +SecretId (uri) of the KeyVault Secret. Use this option when a specific version of secret needs to be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the SSL certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Specifies the password of the SSL certificate. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewaySslCertificate](./Add-AzApplicationGatewaySslCertificate.md) + +[Get-AzApplicationGatewaySslCertificate](./Get-AzApplicationGatewaySslCertificate.md) + +[New-AzApplicationGatewaySslCertificate](./New-AzApplicationGatewaySslCertificate.md) + +[Remove-AzApplicationGatewaySslCertificate](./Remove-AzApplicationGatewaySslCertificate.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySslPolicy.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySslPolicy.md new file mode 100644 index 0000000000..9b3d066693 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySslPolicy.md @@ -0,0 +1,214 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 30A34CA8-AC07-4327-B7B9-19F001DA996A +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewaysslpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewaySslPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewaySslPolicy.md +--- + +# Set-AzApplicationGatewaySslPolicy + +## SYNOPSIS +Modifies the SSL policy of an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewaySslPolicy -ApplicationGateway <PSApplicationGateway> [-DisabledSslProtocols <String[]>] + [-PolicyType <String>] [-PolicyName <String>] [-CipherSuite <String[]>] [-MinProtocolVersion <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewaySslPolicy** cmdlet modifies the SSL policy of an application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewaySslPolicy -ApplicationGateway $getgw -PolicyType Predefined -PolicyName AppGwSslPolicy20170401 +``` + +The first command gets the application gateway named ApplicationGateway01 and stores it in the $AppGw variable. +This second command modifies the ssl policy to a policy type Predefined and policy name AppGwSslPolicy20170401. + +### Example 2 + +Modifies the SSL policy of an application gateway. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzApplicationGatewaySslPolicy -ApplicationGateway <PSApplicationGateway> -CipherSuite 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' -MinProtocolVersion TLSv1_0 -PolicyType Predefined +``` + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway of the SSL policy that this cmdlet modifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CipherSuite +Ssl cipher suites to be enabled in the specified order to application gateway + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledSslProtocols +Specifies which protocols are disabled. +The acceptable values for this parameter are: +- TLSv1_0 +- TLSv1_1 +- TLSv1_2 + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinProtocolVersion +Minimum version of Ssl protocol to be supported on application gateway + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Name of Ssl predefined policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyType +Type of Ssl Policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Predefined, Custom, CustomV2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Get-AzApplicationGatewaySslPolicy](./Get-AzApplicationGatewaySslPolicy.md) + +[New-AzApplicationGatewaySslPolicy](./New-AzApplicationGatewaySslPolicy.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySslProfile.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySslProfile.md new file mode 100644 index 0000000000..1ab3fee9e7 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySslProfile.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewaysslprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewaySslProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewaySslProfile.md +--- + +# Set-AzApplicationGatewaySslProfile + +## SYNOPSIS +Updates ssl profile for an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewaySslProfile -ApplicationGateway <PSApplicationGateway> -Name <String> + [-SslPolicy <PSApplicationGatewaySslPolicy>] + [-ClientAuthConfiguration <PSApplicationGatewayClientAuthConfiguration>] + [-TrustedClientCertificates <PSApplicationGatewayTrustedClientCertificate[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewaySslProfile** cmdlet updates the ssl profile for an Azure application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$AppGw = Set-AzApplicationGatewaySslProfile -ApplicationGateway $AppGw -Name "Profile01" -ClientAuthConfiguration $newclientconfig +``` + +The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. The second command updates the ssl profile of the application gateway in the $AppGw variable to update the client auth configuration to the new value stored in $newclientconfig. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ClientAuthConfiguration +Client authentication configuration settings + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayClientAuthConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the SSL profile + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslPolicy +SSL policy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedClientCertificates +The trusted client CA certificate chains + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedClientCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewaySslProfile](./Add-AzApplicationGatewaySslProfile.md) + +[New-AzApplicationGatewaySslProfile](./New-AzApplicationGatewaySslProfile.md) + +[Get-AzApplicationGatewaySslProfile](./Get-AzApplicationGatewaySslProfile.md) + +[Remove-AzApplicationGatewaySslProfile](./Remove-AzApplicationGatewaySslProfile.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySslProfilePolicy.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySslProfilePolicy.md new file mode 100644 index 0000000000..9c094258e3 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewaySslProfilePolicy.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewaysslprofilepolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewaySslProfilePolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewaySslProfilePolicy.md +--- + +# Set-AzApplicationGatewaySslProfilePolicy + +## SYNOPSIS +Modifies the SSL policy of an application gateway SSL profile. + +## SYNTAX + +``` +Set-AzApplicationGatewaySslProfilePolicy -SslProfile <PSApplicationGatewaySslProfile> + [-DisabledSslProtocols <String[]>] [-PolicyType <String>] [-PolicyName <String>] [-CipherSuite <String[]>] + [-MinProtocolVersion <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewaySslProfilePolicy** cmdlet modifies the SSL policy of an application gateway SSL profile. + +## EXAMPLES + +### Example 1 +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +$profile = Get-AzApplicationGatewaySslProfile -Name "SslProfile01" -ApplicationGateway $AppGw +$profile = Set-AzApplicationGatewaySslProfilePolicy -SslProfile $profile -PolicyType Predefined -PolicyName AppGwSslPolicy20170401 +``` + +The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. The second command gets the ssl profile named SslProfile01 for $AppGw and stores the settings in the $profile variable. The last command modifies the ssl policy of the ssl profile object stored in $profile. + +## PARAMETERS + +### -CipherSuite +Ssl cipher suites to be enabled in the specified order to application gateway + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledSslProtocols +List of SSL protocols to be disabled + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinProtocolVersion +Minimum version of Ssl protocol to be supported on application gateway + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Name of Ssl predefined policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyType +Type of Ssl Policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Predefined, Custom, CustomV2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslProfile +The application gateway SSL profile + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslProfile + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGatewaySslProfilePolicy](./Get-AzApplicationGatewaySslProfilePolicy.md) + +[Remove-AzApplicationGatewaySslProfilePolicy](./Remove-AzApplicationGatewaySslProfilePolicy.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayTrustedClientCertificate.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayTrustedClientCertificate.md new file mode 100644 index 0000000000..243879ce09 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayTrustedClientCertificate.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewaytrustedclientcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayTrustedClientCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayTrustedClientCertificate.md +--- + +# Set-AzApplicationGatewayTrustedClientCertificate + +## SYNOPSIS +Modifies the trusted client CA certificate chain of an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayTrustedClientCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> + -CertificateFile <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayTrustedClientCertificate** cmdlet modifies the trusted client CA certificate chain of an application gateway. + +## EXAMPLES + +### Example 1 +```powershell +$gw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $resgpName +$gw = Set-AzApplicationGatewayTrustedClientCertificate -ApplicationGateway $gw -Name $certName -CertificateFile ".\clientCAUpdated.cer" +$gw = Set-AzApplicationGateway -ApplicationGateway $gw +``` + +Above example scenarios shows how to update an existing trusted client CA certificate chain object. The first command gets an application gateway and stores it in the $gw variable. The second command modifies the existing trusted client CA certificate chain object with a new CA certificate chain file. The third command updates the application gateway on Azure. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertificateFile +Path of the trusted client CA certificate chain file + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the trusted client CA certificate chain + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayTrustedClientCertificate](./Add-AzApplicationGatewayTrustedClientCertificate.md) + +[New-AzApplicationGatewayTrustedClientCertificate](./New-AzApplicationGatewayTrustedClientCertificate.md) + +[Get-AzApplicationGatewayTrustedClientCertificate](./Get-AzApplicationGatewayTrustedClientCertificate.md) + +[Remove-AzApplicationGatewayTrustedClientCertificate](./Remove-AzApplicationGatewayTrustedClientCertificate.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayTrustedRootCertificate.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayTrustedRootCertificate.md new file mode 100644 index 0000000000..c1e38da85b --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayTrustedRootCertificate.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewaytrustedrootcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayTrustedRootCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayTrustedRootCertificate.md +--- + +# Set-AzApplicationGatewayTrustedRootCertificate + +## SYNOPSIS +Updates a Trusted Root Certificate of an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayTrustedRootCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> + -CertificateFile <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayTrustedRootCertificate** cmdlet modifies the existing trusted root certificate of an Application Gateway. + +## EXAMPLES + +### Example 1 +```powershell +$gw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $resgpName +$gw = Set-AzApplicationGatewayTrustedRootCertificate -ApplicationGateway $gw -Name $certName -CertificateFile ".\rootCAUpdated.cer" +$gw = Set-AzApplicationGateway -ApplicationGateway $gw +``` + +Above example scenarios shows how to update an existing trusted root certificate when a root certificate is rolled. +The first command gets an application gateway and stores it in the $gw variable. +The second command modifies the existing trusted root certificate with a new root certificate. +The third command updates the application gateway on Azure. + +## PARAMETERS + +### -ApplicationGateway +The applicationGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertificateFile +Path of certificate CER file + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the TrustedRoot certificate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayTrustedRootCertificate](./Add-AzApplicationGatewayTrustedRootCertificate.md) + +[Get-AzApplicationGatewayTrustedRootCertificate](./Get-AzApplicationGatewayTrustedRootCertificate.md) + +[New-AzApplicationGatewayTrustedRootCertificate](./New-AzApplicationGatewayTrustedRootCertificate.md) + +[Remove-AzApplicationGatewayTrustedRootCertificate](./Remove-AzApplicationGatewayTrustedRootCertificate.md) diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayUrlPathMapConfig.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayUrlPathMapConfig.md new file mode 100644 index 0000000000..7da025e11d --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayUrlPathMapConfig.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 9F5EC8E7-12E9-40E5-B98D-AAFD8F9F3C37 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewayurlpathmapconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayUrlPathMapConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayUrlPathMapConfig.md +--- + +# Set-AzApplicationGatewayUrlPathMapConfig + +## SYNOPSIS +Sets configuration for an array of URL path mappings to a backend server pool. + +## SYNTAX + +### BackendSetByResource (Default) +``` +Set-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + -PathRules <PSApplicationGatewayPathRule[]> + -DefaultBackendAddressPool <PSApplicationGatewayBackendAddressPool> + -DefaultBackendHttpSettings <PSApplicationGatewayBackendHttpSettings> + [-DefaultRewriteRuleSet <PSApplicationGatewayRewriteRuleSet>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### BackendSetByResourceId +``` +Set-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + -PathRules <PSApplicationGatewayPathRule[]> -DefaultBackendAddressPoolId <String> + -DefaultBackendHttpSettingsId <String> [-DefaultRewriteRuleSetId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RedirectSetByResource +``` +Set-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + -PathRules <PSApplicationGatewayPathRule[]> [-DefaultRewriteRuleSet <PSApplicationGatewayRewriteRuleSet>] + -DefaultRedirectConfiguration <PSApplicationGatewayRedirectConfiguration> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RedirectSetByResourceId +``` +Set-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> + -PathRules <PSApplicationGatewayPathRule[]> [-DefaultRewriteRuleSetId <String>] + -DefaultRedirectConfigurationId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayUrlPathMapConfig** cmdlet sets configuration for an array of URL path mappings to a backend server pool. + +## EXAMPLES + +### Example 1: Update an URL path mapping +```powershell +$appgw = Get-AzApplicationGateway -ResourceGroupName "rg" -Name "appGwName" +$appgw = Set-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway $appgw -Name "map01" +$appgw = Set-AzApplicationGateway -ApplicationGateway $appgw +``` + +The first command gets the application gateway named appGwName and stores the result in the $appgw variable. +The second command updates the URL path mapping named map01 in the application gateway. +The third command updates the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway to which this cmdlet sets a URL path map configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultBackendAddressPool +Specifies the default backend address pool to route in case none of the rules specified in the *pathRules* parameter match. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool +Parameter Sets: BackendSetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultBackendAddressPoolId +Specifies the default backend address pool ID. + +```yaml +Type: System.String +Parameter Sets: BackendSetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultBackendHttpSettings +Specifies the default backend HTTP settings to use in case none of the rules specified in the *pathRules* parameter match. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings +Parameter Sets: BackendSetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultBackendHttpSettingsId +Specifies the default backend HTTP settings ID. + +```yaml +Type: System.String +Parameter Sets: BackendSetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultRedirectConfiguration +Application gateway default RedirectConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration +Parameter Sets: RedirectSetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultRedirectConfigurationId +ID of the application gateway default RedirectConfiguration + +```yaml +Type: System.String +Parameter Sets: RedirectSetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultRewriteRuleSet +Application gateway default rewrite rule set + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRewriteRuleSet +Parameter Sets: BackendSetByResource, RedirectSetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultRewriteRuleSetId +ID of the application gateway default rewrite rule set + +```yaml +Type: System.String +Parameter Sets: BackendSetByResourceId, RedirectSetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the URL path map name in which this cmdlet sets configuration for. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PathRules +Specifies a list of path rules. +Note that the path rules are order sensitive, they are applied in order they are specified. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Add-AzApplicationGatewayUrlPathMapConfig](./Add-AzApplicationGatewayUrlPathMapConfig.md) + +[Get-AzApplicationGatewayUrlPathMapConfig](./Get-AzApplicationGatewayUrlPathMapConfig.md) + +[New-AzApplicationGatewayUrlPathMapConfig](./New-AzApplicationGatewayUrlPathMapConfig.md) + +[Remove-AzApplicationGatewayUrlPathMapConfig](./Remove-AzApplicationGatewayUrlPathMapConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzApplicationGatewayWebApplicationFirewallConfiguration.md b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayWebApplicationFirewallConfiguration.md new file mode 100644 index 0000000000..4ba53d9533 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzApplicationGatewayWebApplicationFirewallConfiguration.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 46FDE4D8-08E0-4465-8BF9-849A108628B8 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azapplicationgatewaywebapplicationfirewallconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayWebApplicationFirewallConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzApplicationGatewayWebApplicationFirewallConfiguration.md +--- + +# Set-AzApplicationGatewayWebApplicationFirewallConfiguration + +## SYNOPSIS +Modifies the WAF configuration of an application gateway. + +## SYNTAX + +``` +Set-AzApplicationGatewayWebApplicationFirewallConfiguration -ApplicationGateway <PSApplicationGateway> + -Enabled <Boolean> -FirewallMode <String> [-RuleSetType <String>] [-RuleSetVersion <String>] + [-DisabledRuleGroup <PSApplicationGatewayFirewallDisabledRuleGroup[]>] [-RequestBodyCheck <Boolean>] + [-MaxRequestBodySizeInKb <Int32>] [-FileUploadLimitInMb <Int32>] + [-Exclusion <PSApplicationGatewayFirewallExclusion[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGatewayWebApplicationFirewallConfiguration** cmdlet modifies the web application firewall (WAF) configuration of an application gateway. + +## EXAMPLES + +### Example 1: Update the application gateway web application firewall configuration +```powershell +$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" +Set-AzApplicationGatewayWebApplicationFirewallConfiguration -ApplicationGateway $AppGw -Enabled $True -FirewallMode "Detection" -RuleSetType "OWASP" -RuleSetVersion "3.0" +``` + +The first command gets the application gateway named ApplicationGateway01 and then stores it in the $AppGw variable. +The second command enables the firewall configuration for the application gateway stored in $AppGw and sets the firewall mode to "Detection", RuleSetType to "OWASP" and the RuleSetVersion to "3.0". + +## PARAMETERS + +### -ApplicationGateway +Specifies an application gateway object. +You can use the Get-AzApplicationGateway cmdlet to get an application gateway object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledRuleGroup +The disabled rule groups. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallDisabledRuleGroup[] +Parameter Sets: (All) +Aliases: DisabledRuleGroups + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Indicates whether the web application firewall is enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exclusion +The exclusion lists. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallExclusion[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileUploadLimitInMb +Max file upload limit in MB. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallMode +Specifies the web application firewall mode. +The acceptable values for this parameter are: +- Detection +- Prevention + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Detection, Prevention + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxRequestBodySizeInKb +Max request body size in KB. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestBodyCheck +Whether request body is checked or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSetType +The type of the web application firewall rule set. +The acceptable values for this parameter are: +- OWASP + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: OWASP + +Required: False +Position: Named +Default value: OWASP +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSetVersion +The version of the rule set type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 3.0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGateway](./Get-AzApplicationGateway.md) + +[Get-AzApplicationGatewayWebApplicationFirewallConfiguration](./Get-AzApplicationGatewayWebApplicationFirewallConfiguration.md) + +[New-AzApplicationGatewayWebApplicationFirewallConfiguration](./New-AzApplicationGatewayWebApplicationFirewallConfiguration.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzBastion.md b/azps-10.1.0/Az.Network/Set-AzBastion.md new file mode 100644 index 0000000000..a9569dc016 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzBastion.md @@ -0,0 +1,309 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azbastion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzBastion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzBastion.md +--- + +# Set-AzBastion + +## SYNOPSIS +Updates the Bastion Resource. + +## SYNTAX + +``` +Set-AzBastion -InputObject <PSBastion> [-Sku <String>] [-ScaleUnit <Int32>] [-Tag <Hashtable>] [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzBastion** cmdlet can be used to update the Sku, Scale Units or Tags of an existing BastionHost resource. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzBastion -InputObject $bastionObj -Sku "Standard" -ScaleUnit 10 -Force +``` + +```output +Name : MyBastion +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/bastionHosts/MyBastion +Etag : W/"000" +Type : Microsoft.Network/bastionHosts +Location : westus2 +Tag : +TagsTable : +ResourceGroupName : MyRg +DnsName : bst-00000000-0000-0000-0000-000000000001.test.bastion.azure.com +ResourceGuid : +ProvisioningState : Succeeded +IpConfigurationsText : [ + { + "Subnet": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/AzureBastionSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/publicIPAddresses/PublicIp1" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAllocationMethod": "Dynamic", + "Name": "IpConf", + "Etag": "W/\"000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/bastionHosts/MyBastion/bastionHostIpConfigurations/IpConf" + } + ] +Sku : { + "Name": "Standard" + } +Scale Units : 10 +``` + +Updates BastionHost resource with Basic Sku and 2 Scale Units to Standard Sku and 10 Scale Units + +### Example 2 +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$bastionObj = Get-AzBastion -ResourceGroupName "MyRg" -Name "MyBastion" +$bastionObj + +Name : MyBastion +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/bastionHosts/MyBastion +Etag : W/"000" +Type : Microsoft.Network/bastionHosts +Location : westus2 +Tag : +TagsTable : +ResourceGroupName : MyRg +DnsName : bst-00000000-0000-0000-0000-000000000001.test.bastion.azure.com +ResourceGuid : +ProvisioningState : Succeeded +IpConfigurationsText : [ + { + "Subnet": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/AzureBastionSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/publicIPAddresses/PublicIp1" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAllocationMethod": "Dynamic", + "Name": "IpConf", + "Etag": "W/\"000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/bastionHosts/MyBastion/bastionHostIpConfigurations/IpConf" + } + ] +Sku : { + "Name": "Basic" + } +Scale Units : 2 + +$bastionObj.Sku.Name = "Standard" +$bastionObj.ScaleUnit = 50 +Set-AzBastion -InputObject $bastionObj -Force +Name : MyBastion +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/bastionHosts/MyBastion +Etag : W/"000" +Type : Microsoft.Network/bastionHosts +Location : westus2 +Tag : +TagsTable : +ResourceGroupName : MyRg +DnsName : bst-00000000-0000-0000-0000-000000000001.test.bastion.azure.com +ResourceGuid : +ProvisioningState : Succeeded +IpConfigurationsText : [ + { + "Subnet": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/AzureBastionSubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/publicIPAddresses/PublicIp1" + }, + "ProvisioningState": "Succeeded", + "PrivateIpAllocationMethod": "Dynamic", + "Name": "IpConf", + "Etag": "W/\"000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/bastionHosts/MyBastion/bastionHostIpConfigurations/IpConf" + } + ] +Sku : { + "Name": "Standard" + } +Scale Units : 50 +``` + +Updates BastionHost resource with Basic Sku and 2 Scale Units to Standard Sku and 50 Scale Units + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +The BastionHost Object + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBastion +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ScaleUnit +The Bastion Scale Units + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 2 +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Sku +The Bastion Sku Tier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, Standard + +Required: False +Position: Named +Default value: Basic +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBastion + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=5.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Collections.Hashtable + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBastion + +## NOTES + +## RELATED LINKS + +[New-AzBastion](./New-AzBastion.md) + +[Get-AzBastion](./Get-AzBastion.md) + +[Remove-AzBastion](./Remove-AzBastion.md) diff --git a/azps-10.1.0/Az.Network/Set-AzExpressRouteCircuit.md b/azps-10.1.0/Az.Network/Set-AzExpressRouteCircuit.md new file mode 100644 index 0000000000..6eaff1adc9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzExpressRouteCircuit.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 2A3B7343-9AA0-4505-AEDE-31C0C5B98694 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azexpressroutecircuit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRouteCircuit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRouteCircuit.md +--- + +# Set-AzExpressRouteCircuit + +## SYNOPSIS +Modifies an ExpressRoute circuit. + +## SYNTAX + +``` +Set-AzExpressRouteCircuit -ExpressRouteCircuit <PSExpressRouteCircuit> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzExpressRouteCircuit** cmdlet saves the modified ExpressRoute circuit to Azure. + +## EXAMPLES + +### Example 1: Change the ServiceKey of an ExpressRoute circuit +```powershell +$ckt = Get-AzExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg +$ckt.ServiceKey = '64ce99dd-ee70-4e74-b6b8-91c6307433a0' +Set-AzExpressRouteCircuit -ExpressRouteCircuit $ckt +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuit +Specifies the **ExpressRouteCircuit** object that this cmdlet modifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuit](./Get-AzExpressRouteCircuit.md) + +[Move-AzExpressRouteCircuit](./Move-AzExpressRouteCircuit.md) + +[New-AzExpressRouteCircuit](./New-AzExpressRouteCircuit.md) + +[Remove-AzExpressRouteCircuit](./Remove-AzExpressRouteCircuit.md) diff --git a/azps-10.1.0/Az.Network/Set-AzExpressRouteCircuitConnectionConfig.md b/azps-10.1.0/Az.Network/Set-AzExpressRouteCircuitConnectionConfig.md new file mode 100644 index 0000000000..87484677ba --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzExpressRouteCircuitConnectionConfig.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 8b4a8c9f-874c-4a27-b87e-c8ad7e73188d +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRouteCircuitConnectionConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRouteCircuitConnectionConfig.md +--- + +# Set-AzExpressRouteCircuitConnectionConfig + +## SYNOPSIS +Updates a circuit connection configuration created in Private Peerings for an Express Route Circuit. + +## SYNTAX + +### SetByResource (Default) +``` +Set-AzExpressRouteCircuitConnectionConfig [-Name] <String> [-ExpressRouteCircuit] <PSExpressRouteCircuit> + [-AddressPrefix] <String> [-AddressPrefixType <String>] [-AuthorizationKey <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Set-AzExpressRouteCircuitConnectionConfig [-Name] <String> [-ExpressRouteCircuit] <PSExpressRouteCircuit> + [-PeerExpressRouteCircuitPeering] <String> [-AddressPrefix] <String> [-AddressPrefixType <String>] + [-AuthorizationKey <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzExpressRouteCircuitConnectionConfig** cmdlet updates a circuit connection configuration created in +private peering for an ExpressRoute circuit. This allows peering two Express Route Circuits +across regions or subscriptions. +Note that, before running **Set-AzExpressRouteCircuitConnectionConfig** you must add the circuit connection using +**Add-AzExpressRouteCircuitConnectionConfig**. +Also, after running **Set-AzExpressRouteCircuitPeeringConfig**, you must call the Set-AzExpressRouteCircuit cmdlet to activate the configuration. + +## EXAMPLES + +### Example 1: Update a circuit connection resource to an existing ExpressRoute circuit +```powershell +$circuit_init = Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg +$circuit_peer = Get-AzExpressRouteCircuit -Name $peeringCircuitName -ResourceGroupName $rg +$addressSpace = 'aa:bb::0/125' +$addressPrefixType = 'IPv6' +Set-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init -PeerExpressRouteCircuitPeering $circuit_peer.Peerings[0].Id -AddressPrefix $addressSpace -AddressPrefixType $addressPrefixType -AuthorizationKey $circuit_peer.Authorizations[0].AuthorizationKey +Set-AzExpressRouteCircuit -ExpressRouteCircuit $circuit_init +``` + +### Example 2: Set a circuit connection configuration using Piping to an existing ExpressRoute Circuit +```powershell +$circuit_peer = Get-AzExpressRouteCircuit -Name $peeringCircuitName -ResourceGroupName $rg +$addressSpace = '60.0.0.0/29' +Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Set-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -PeerExpressRouteCircuitPeering $circuit_peer.Peerings[0].Id -AddressPrefix $addressSpace -AuthorizationKey $circuit_peer.Authorizations[0].AuthorizationKey |Set-AzExpressRouteCircuit +``` + +## PARAMETERS + +### -AddressPrefix +A minimum /29 customer address space to create VxLan tunnels between Express Route Circuits for IPv4 tunnels. +or a minimum of /125 customer address space to create VxLan tunnels between Express Route Circuits for IPv6 tunnels. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressPrefixType +Specifies the address family that address prefix belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: IPv4 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizationKey +Authorization Key to peer Express Route Circuit in another subscription. Authorization on peer circuit can be created using existing commands. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuit +The ExpressRoute circuit being modified. This is Azure object returned by the +**Get-AzExpressRouteCircuit** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the circuit connection resource to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerExpressRouteCircuitPeering +Resource Id for Private Peering of remote circuit which will be peered with the current circuit. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCircuitConnectionConfig](Get-AzExpressRouteCircuitConnectionConfig.md) + +[Remove-AzExpressRouteCircuitConnectionConfig](Remove-AzExpressRouteCircuitConnectionConfig.md) + +[Add-AzExpressRouteCircuitConnectionConfig](Set-AzExpressRouteCircuitConnectionConfig.md) + +[Set-AzExpressRouteCircuit](Set-AzExpressRouteCircuit.md) + +[Get-AzExpressRouteCircuit](Get-AzExpressRouteCircuit.md) diff --git a/azps-10.1.0/Az.Network/Set-AzExpressRouteCircuitPeeringConfig.md b/azps-10.1.0/Az.Network/Set-AzExpressRouteCircuitPeeringConfig.md new file mode 100644 index 0000000000..80ce29c46b --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzExpressRouteCircuitPeeringConfig.md @@ -0,0 +1,373 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 6C0281EC-4D23-4BD0-A268-4C278ABC7B1A +online version: https://learn.microsoft.com/powershell/module/az.network/set-azexpressroutecircuitpeeringconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRouteCircuitPeeringConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRouteCircuitPeeringConfig.md +--- + +# Set-AzExpressRouteCircuitPeeringConfig + +## SYNOPSIS +Saves a modified ExpressRoute peering configuration. + +## SYNTAX + +### SetByResource (Default) +``` +Set-AzExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> + -PeeringType <String> -PeerASN <UInt32> -PrimaryPeerAddressPrefix <String> + -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] + [-MicrosoftConfigAdvertisedPublicPrefixes <String[]>] [-MicrosoftConfigCustomerAsn <Int32>] + [-MicrosoftConfigRoutingRegistryName <String>] [-PeerAddressType <String>] [-LegacyMode <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### MicrosoftPeeringConfigRoutFilterId +``` +Set-AzExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> + -PeeringType <String> -PeerASN <UInt32> -PrimaryPeerAddressPrefix <String> + -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] + [-MicrosoftConfigAdvertisedPublicPrefixes <String[]>] [-MicrosoftConfigCustomerAsn <Int32>] + [-MicrosoftConfigRoutingRegistryName <String>] -RouteFilterId <String> [-PeerAddressType <String>] + [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### MicrosoftPeeringConfigRoutFilter +``` +Set-AzExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> + -PeeringType <String> -PeerASN <UInt32> -PrimaryPeerAddressPrefix <String> + -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] + [-MicrosoftConfigAdvertisedPublicPrefixes <String[]>] [-MicrosoftConfigCustomerAsn <Int32>] + [-MicrosoftConfigRoutingRegistryName <String>] -RouteFilter <PSRouteFilter> [-PeerAddressType <String>] + [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzExpressRouteCircuitPeeringConfig** cmdlets saves a modified ExpressRoute peering +configuration back to Azure. + +## EXAMPLES + +### Example 1: Change an existing peering configuration +```powershell +$circuit = Get-AzExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg +$parameters = @{ + Name = 'AzurePrivatePeering' + Circuit = $circuit + PeeringType = 'AzurePrivatePeering' + PeerASN = 100 + PrimaryPeerAddressPrefix = '10.6.1.0/30' + SecondaryPeerAddressPrefix = '10.6.2.0/30' + VlanId = 201 +} +Set-AzExpressRouteCircuitPeeringConfig @parameters +Set-AzExpressRouteCircuit -ExpressRouteCircuit $circuit +``` + +### Example 2 + +Saves a modified ExpressRoute peering configuration. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzExpressRouteCircuitPeeringConfig -ExpressRouteCircuit <PSExpressRouteCircuit> -Name 'cert01' -PeerASN 100 -PeerAddressType IPv4 -PeeringType AzurePrivatePeering -PrimaryPeerAddressPrefix '123.0.0.0/30' -SecondaryPeerAddressPrefix '123.0.0.4/30' -VlanId 300 +``` + +### Example 3 + +Saves a modified ExpressRoute peering configuration. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzExpressRouteCircuitPeeringConfig -ExpressRouteCircuit <PSExpressRouteCircuit> -MicrosoftConfigAdvertisedPublicPrefixes <String[]> -MicrosoftConfigCustomerAsn <Int32> -MicrosoftConfigRoutingRegistryName <String> -Name 'cert01' -PeerASN 100 -PeerAddressType IPv4 -PeeringType AzurePrivatePeering -PrimaryPeerAddressPrefix '123.0.0.0/30' -SecondaryPeerAddressPrefix '123.0.0.4/30' -VlanId 300 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCircuit +The ExpressRoute circuit object containing the peering configuration to be modified. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LegacyMode +The legacy mode of the Peering + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MicrosoftConfigAdvertisedPublicPrefixes +For a PeeringType of MicrosoftPeering, you must provide a list of all prefixes you plan to +advertise over the BGP session. Only public IP address prefixes are accepted. You can send a comma +separated list if you plan to send a set of prefixes. These prefixes must be registered to you in +a Routing Registry Name (RIR / IRR). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftConfigCustomerAsn +If you are advertising prefixes that are not registered to the peering AS number, you can specify +the AS number to which they are registered. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftConfigRoutingRegistryName +The Routing Registry Name (RIR / IRR) to which the AS number and prefixes are registered. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the peering configuration to be modified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerAddressType +PeerAddressType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerASN +The AS number of your ExpressRoute circuit. This must be a Public ASN when the PeeringType is +AzurePublicPeering. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringType +The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and +`MicrosoftPeering` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryPeerAddressPrefix +This is the IP Address range for the primary routing path of this peering relationship. This must +be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your +router interface. Azure will configure the next even-numbered address to the Azure router interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteFilter +This is an existing RouteFilter object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter +Parameter Sets: MicrosoftPeeringConfigRoutFilter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteFilterId +This is the resource Id of an existing RouteFilter object. + +```yaml +Type: System.String +Parameter Sets: MicrosoftPeeringConfigRoutFilterId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryPeerAddressPrefix +This is the IP Address range for the secondary routing path of this peering relationship. This must +be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your +router interface. Azure will configure the next even-numbered address to the Azure router interface. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedKey +This is an optional MD5 hash used as a pre-shared key for the peering configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VlanId +This is the Id number of the VLAN assigned for this peering. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilter + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit + +## NOTES + +## RELATED LINKS + +[Add-AzExpressRouteCircuitPeeringConfig](Add-AzExpressRouteCircuitPeeringConfig.md) + +[Get-AzExpressRouteCircuit](Get-AzExpressRouteCircuit.md) + +[New-AzExpressRouteCircuitPeeringConfig](New-AzExpressRouteCircuitPeeringConfig.md) + +[Remove-AzExpressRouteCircuitPeeringConfig](Remove-AzExpressRouteCircuitPeeringConfig.md) diff --git a/azps-10.1.0/Az.Network/Set-AzExpressRouteConnection.md b/azps-10.1.0/Az.Network/Set-AzExpressRouteConnection.md new file mode 100644 index 0000000000..4bc2676b70 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzExpressRouteConnection.md @@ -0,0 +1,308 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azexpressrouteconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRouteConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRouteConnection.md +--- + +# Set-AzExpressRouteConnection + +## SYNOPSIS +Updates an express route connection created between an express route gateway and on-premise express route circuit peering. + +## SYNTAX + +### ByExpressRouteConnectionName (Default) +``` +Set-AzExpressRouteConnection -ResourceGroupName <String> -ExpressRouteGatewayName <String> -Name <String> + [-AuthorizationKey <String>] [-RoutingWeight <UInt32>] [-EnableInternetSecurity <Boolean>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByExpressRouteConnectionResourceId +``` +Set-AzExpressRouteConnection -ResourceId <String> [-AuthorizationKey <String>] [-RoutingWeight <UInt32>] + [-EnableInternetSecurity <Boolean>] [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByExpressRouteConnectionObject +``` +Set-AzExpressRouteConnection -InputObject <PSExpressRouteConnection> [-AuthorizationKey <String>] + [-RoutingWeight <UInt32>] [-EnableInternetSecurity <Boolean>] [-RoutingConfiguration <PSRoutingConfiguration>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzExpressRouteConnection** cmdlet updates an express route connection created between an express route gateway and on-premise express route circuit peering. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West Central US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West Central US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" -VirtualHubId $virtualHub.Id -MinScaleUnits 2 +$ExpressRouteGateway = Get-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" +$ExpressRouteCircuit = New-AzExpressRouteCircuit -ResourceGroupName "testRG" -Name "testExpressRouteCircuit" -Location "West Central US" -SkuTier Premium -SkuFamily MeteredData -ServiceProviderName "Equinix" -PeeringLocation "Silicon Valley" -BandwidthInMbps 200 +Add-AzExpressRouteCircuitPeeringConfig -Name "AzurePrivatePeering" -ExpressRouteCircuit $ExpressRouteCircuit -PeeringType AzurePrivatePeering -PeerASN 100 -PrimaryPeerAddressPrefix "123.0.0.0/30" -SecondaryPeerAddressPrefix "123.0.0.4/30" -VlanId 300 +$ExpressRouteCircuit = Set-AzExpressRouteCircuit -ExpressRouteCircuit $ExpressRouteCircuit +$ExpressRouteCircuitPeeringId = $ExpressRouteCircuit.Peerings[0].Id +New-AzExpressRouteConnection -ResourceGroupName $ExpressRouteGateway.ResourceGroupName -ExpressRouteGatewayName $ExpressRouteGateway.Name -Name "testConnection" -ExpressRouteCircuitPeeringId $ExpressRouteCircuitPeeringId -RoutingWeight 20 +Set-AzExpressRouteConnection -InputObject $ExpressRouteConnection -RoutingWeight 30 +``` + +```output +ExpressRouteCircuitPeeringId : Microsoft.Azure.Commands.Network.Models.PSResourceId +AuthorizationKey : +RoutingWeight : 30 +ProvisioningState : Succeeded +Name : testConnection +Etag : W/"4580a2e2-2fab-4cff-88eb-92013a76b5a8" +Id : /subscriptions/{subscriptionId}/resourceGroups/ps9361/providers/Microsoft.Network/ExpressRouteGateways/testExpressRoutegw/expressRouteConnections/testConnection +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a ExpressRouteSite in West US in "testRG" resource group in Azure. +A ExpressRoute gateway will be created thereafter in the Virtual Hub with 2 scale units. + +Once the gateway has been created, it is connected to the on premise ExpressRoute circuit peering using the New-AzExpressRouteConnection command. + +The connection is then updated to have a different RoutingWeight by using the Set-AzExpressRouteConnection command. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizationKey +The authorization key to be used to create the ExpressRoute gateway connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternetSecurity +Enable internet security for this ExpressRoute Gateway connection + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteGatewayName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteConnectionName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The ExpressRouteConnection object to update. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteConnection +Parameter Sets: ByExpressRouteConnectionObject +Aliases: ExpressRouteConnection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteConnectionName +Aliases: ResourceName, ExpressRouteConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteConnectionName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the ExpressRouteConnection object to delete. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteConnectionResourceId +Aliases: ExpressRouteConnectionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoutingConfiguration +Routing configuration for this connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingWeight +The weight that needs to be assigned to this connection for packet routing. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteConnection + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteConnection + +## NOTES + +## RELATED LINKS + +[New-AzRoutingConfiguration](./New-AzRoutingConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Set-AzExpressRouteCrossConnection.md b/azps-10.1.0/Az.Network/Set-AzExpressRouteCrossConnection.md new file mode 100644 index 0000000000..19c4d1f81a --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzExpressRouteCrossConnection.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 2A3B7343-9AA0-4505-AEDE-31C0C5B98694 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azexpressroutecrossconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRouteCrossConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRouteCrossConnection.md +--- + +# Set-AzExpressRouteCrossConnection + +## SYNOPSIS +Modifies an ExpressRoute cross connection. + +## SYNTAX + +### ModifyByCircuitReference +``` +Set-AzExpressRouteCrossConnection -ExpressRouteCrossConnection <PSExpressRouteCrossConnection> [-AsJob] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ModifyByParameterValues +``` +Set-AzExpressRouteCrossConnection -ResourceGroupName <String> -Name <String> + [-ServiceProviderProvisioningState <String>] [-ServiceProviderNotes <String>] + [-Peerings <PSExpressRouteCrossConnectionPeering[]>] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzExpressRouteCrossConnection** cmdlet saves the modified ExpressRoute cross connection to Azure. + +## EXAMPLES + +### Example 1: Change the Service Provider Provisioning State of an ExpressRoute cross connection +```powershell +$cc = Get-AzExpressRouteCrossConnection -Name $CrossConnectionName -ResourceGroupName $rg +$cc.ServiceProviderProvisioningState = 'Provisioned' +Set-AzExpressRouteCrossConnection -ExpressRouteCrossConnection $cc +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteCrossConnection +Specifies the **ExpressRouteCrossConnection** object that this cmdlet modifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCrossConnection +Parameter Sets: ModifyByCircuitReference +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of express route cross connection. + +```yaml +Type: System.String +Parameter Sets: ModifyByParameterValues +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Peerings +The list of peerings for the cross connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCrossConnectionPeering[] +Parameter Sets: ModifyByParameterValues +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The ExpressRouteCrossConnection + +```yaml +Type: System.String +Parameter Sets: ModifyByParameterValues +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ServiceProviderNotes +The service provider notes + +```yaml +Type: System.String +Parameter Sets: ModifyByParameterValues +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ServiceProviderProvisioningState +The service provider provisioning state to be set + +```yaml +Type: System.String +Parameter Sets: ModifyByParameterValues +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### PSExpressRouteCrossConnection +Parameter 'ExpressRouteCrossConnection' accepts value of type 'PSExpressRouteCrossConnection' from the pipeline + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCrossConnection + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRouteCrossConnection](./Get-AzExpressRouteCrossConnection.md) diff --git a/azps-10.1.0/Az.Network/Set-AzExpressRouteGateway.md b/azps-10.1.0/Az.Network/Set-AzExpressRouteGateway.md new file mode 100644 index 0000000000..cf24944a25 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzExpressRouteGateway.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azexpressroutegateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRouteGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRouteGateway.md +--- + +# Set-AzExpressRouteGateway + +## SYNOPSIS +Updates a Scalable ExpressRoute Gateway. + +## SYNTAX + +### ByExpressRouteGatewayName (Default) +``` +Set-AzExpressRouteGateway -ResourceGroupName <String> -Name <String> [-MinScaleUnits <UInt32>] + [-MaxScaleUnits <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByExpressRouteGatewayObject +``` +Set-AzExpressRouteGateway -InputObject <PSExpressRouteGateway> [-MinScaleUnits <UInt32>] + [-MaxScaleUnits <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByExpressRouteGatewayResourceId +``` +Set-AzExpressRouteGateway -ResourceId <String> [-MinScaleUnits <UInt32>] [-MaxScaleUnits <UInt32>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +The **Set-AzExpressRouteGateway** cmdlet enables you to update the scale units for an existing ExpressRouteGateway or update the resource tags. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testergw" -VirtualHubId $virtualHub.Id -MinScaleUnits 2 +Set-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testergw" -MinScaleUnits 3 +``` + +```output +ResourceGroupName : testRG +Name : testergw +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/expressRouteGateways/testergw +Location : West US +MinScaleUnits : 3 +Type : Microsoft.Network/expressRouteGateways +ProvisioningState : Succeeded +``` + +The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. +An ExpressRoute gateway will be created thereafter in the Virtual Hub with 2 scale units which will then be modified to 3 scale units. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The ExpressRouteGateway that needs to be updated. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteGateway +Parameter Sets: ByExpressRouteGatewayObject +Aliases: ExpressRouteGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaxScaleUnits +The maximum number of scale units for this ExpressRouteGateway. Valid range > 2 + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinScaleUnits +The minimum number of scale units for this ExpressRouteGateway. Valid range > 2 + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteGatewayName +Aliases: ResourceName, ExpressRouteGatewayName, GatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the ExpressRouteGateway to be updated. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Id of the ExpressRouteGateway that needs to be updated. + +```yaml +Type: System.String +Parameter Sets: ByExpressRouteGatewayResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRouteGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Set-AzExpressRoutePort.md b/azps-10.1.0/Az.Network/Set-AzExpressRoutePort.md new file mode 100644 index 0000000000..aa05b84b64 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzExpressRoutePort.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azexpressrouteport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRoutePort.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRoutePort.md +--- + +# Set-AzExpressRoutePort + +## SYNOPSIS +Modifies an ExpressRoutePort. + +## SYNTAX + +``` +Set-AzExpressRoutePort -ExpressRoutePort <PSExpressRoutePort> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzExpressRoutePort** cmdlet saves the modified ExpressRoutePort to Azure. + +## EXAMPLES + +### Example 1 +```powershell +$erport = Get-AzExpressRoutePort -Name $PortName -ResourceGroupName $rg +$erport.Links[0].AdminState = 'Enabled' +Set-AzExpressRoutePort -ExpressRoutePort $erport +``` + +### Example 2 +```powershell +$erport = Get-AzExpressRoutePort -Name $PortName -ResourceGroupName $rg +$erport.Links[0].AdminState = 'Enabled' +Set-AzExpressRoutePort -InputObject $erport +``` + +Modifies the admin state of a link of an ExpressRoutePort + +### Example 3 +```powershell +$erport = Get-AzExpressRoutePort -Name $PortName -ResourceGroupName $rg +$erport.Links[0].AdminState = 'Enabled' +$erport.SciState = 'Disabled' +Set-AzExpressRoutePort -ExpressRoutePort $erport +``` + +### Example 4 +```powershell +$erport = Get-AzExpressRoutePort -Name $PortName -ResourceGroupName $rg +$erport.BillingType = 'UnlimitedData' +Set-AzExpressRoutePort -ExpressRoutePort $erport +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRoutePort +The ExpressRoutePort object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort +Parameter Sets: (All) +Aliases: InputObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRoutePort](./Get-AzExpressRoutePort.md) + +[New-AzExpressRoutePort](./New-AzExpressRoutePort.md) + +[Remove-AzExpressRoutePort](./Remove-AzExpressRoutePort.md) diff --git a/azps-10.1.0/Az.Network/Set-AzExpressRoutePortIdentity.md b/azps-10.1.0/Az.Network/Set-AzExpressRoutePortIdentity.md new file mode 100644 index 0000000000..abb2cf92f3 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzExpressRoutePortIdentity.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azexpressrouteportidentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRoutePortIdentity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzExpressRoutePortIdentity.md +--- + +# Set-AzExpressRoutePortIdentity + +## SYNOPSIS +Updates a identity assigned to an ExpressRoutePort. + +## SYNTAX + +``` +Set-AzExpressRoutePortIdentity -ExpressRoutePort <PSExpressRoutePort> -UserAssignedIdentityId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzExpressRoutePortIdentity** cmdlet updates a local Azure ExpressRoutePort object. Use **Set-AzExpressRoutePort** to assign it to ExpressRoutePort. + +## EXAMPLES + +### Example 1 +```powershell +$exrport = Get-AzExpressRoutePort -Name $portName -ResourceGroupName $rgName +$identity = New-AzUserAssignedIdentity -Name $identityName -ResourceGroupName $rgName -Location $location +$exrPortIdentity = Set-AzExpressRoutePortIdentity -UserAssignedIdentity $identity.Id -ExpressRoutePort $exrPort +$updatedExrPort = Set-AzExpressRoutePort -ExpressRoutePort $exrPort +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRoutePort +The ExpressRoutePort + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +ResourceId of the user assigned identity to be assigned to ExpressRoutePort. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: UserAssignedIdentity + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort + +## NOTES + +## RELATED LINKS + +[Get-AzExpressRoutePortIdentity](./Get-AzExpressRoutePortIdentity.md) + +[New-AzExpressRoutePortIdentity](./New-AzExpressRoutePortIdentity.md) + +[Remove-AzExpressRoutePortIdentity](./Remove-AzExpressRoutePortIdentity.md) diff --git a/azps-10.1.0/Az.Network/Set-AzFirewall.md b/azps-10.1.0/Az.Network/Set-AzFirewall.md new file mode 100644 index 0000000000..befc92ad52 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzFirewall.md @@ -0,0 +1,332 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 40E56EC1-3327-4DFF-8262-E2EEBB5E4447 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azfirewall +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzFirewall.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzFirewall.md +--- + +# Set-AzFirewall + +## SYNOPSIS +Saves a modified Firewall. + +## SYNTAX + +``` +Set-AzFirewall -AzureFirewall <PSAzureFirewall> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzFirewall** cmdlet updates an Azure Firewall. + +## EXAMPLES + +### 1: Update priority of a Firewall application rule collection +```powershell +$azFw = Get-AzFirewall -Name "AzureFirewall" -ResourceGroupName "rg" +$ruleCollection = $azFw.GetApplicationRuleCollectionByName("ruleCollectionName") +$ruleCollection.Priority = 101 +Set-AzFirewall -AzureFirewall $azFw +``` + +This example updates the priority of an existing rule collection of an Azure Firewall. +Assuming Azure Firewall "AzureFirewall" in resource group "rg" contains an application rule collection named +"ruleCollectionName", the commands above will change the priority of that rule collection and update the +Azure Firewall afterwards. Without the Set-AzFirewall command, all operations performed on the local $azFw +object are not reflected on the server. + +### 2: Create a Azure Firewall and set an application rule collection later +```powershell +$azFw = New-AzFirewall -Name "AzureFirewall" -ResourceGroupName "rg" -VirtualNetworkName "vnet-name" -PublicIpName "pip-name" + +$rule = New-AzFirewallApplicationRule -Name R1 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" -SourceAddress "10.0.0.0" +$RuleCollection = New-AzFirewallApplicationRuleCollection -Name RC1 -Priority 100 -Rule $rule -ActionType "Allow" +$azFw.ApplicationRuleCollections = $RuleCollection + +$azFw | Set-AzFirewall +``` + +In this example, a Firewall is created first without any application rule collections. Afterwards a Application Rule +and Application Rule Collection are created, then the Firewall object is modified in memory, without affecting +the real configuration in cloud. For changes to be reflected in cloud, Set-AzFirewall must be called. + +### 3: Update Threat Intel operation mode of Azure Firewall +```powershell +$azFw = Get-AzFirewall -Name "AzureFirewall" -ResourceGroupName "rg" +$azFw.ThreatIntelMode = "Deny" +Set-AzFirewall -AzureFirewall $azFw +``` + +This example updates the Threat Intel operation mode of Azure Firewall "AzureFirewall" in resource group "rg". +Without the Set-AzFirewall command, all operations performed on the local $azFw object are not reflected on the server. + +### 4: Deallocate and allocate the Firewall +```powershell +$firewall=Get-AzFirewall -ResourceGroupName rgName -Name azFw +$firewall.Deallocate() +$firewall | Set-AzFirewall + +$vnet = Get-AzVirtualNetwork -ResourceGroupName rgName -Name anotherVNetName +$pip = Get-AzPublicIpAddress -ResourceGroupName rgName -Name publicIpName +$firewall.Allocate($vnet, $pip) +$firewall | Set-AzFirewall +``` + +This example retrieves a Firewall, deallocates the firewall, and saves it. The Deallocate command removes the running +service but preserves the firewall's configuration. For changes to be reflected in cloud, Set-AzFirewall must be called. +If user wants to start the service again, the Allocate method should be called on the firewall. +The new VNet and Public IP must be in the same resource group as the Firewall. Again, for changes to be reflected in cloud, +Set-AzFirewall must be called. + +### 5: Allocate with a management public IP address for forced tunneling scenarios +```powershell +$vnet = Get-AzVirtualNetwork -ResourceGroupName rgName -Name anotherVNetName +$pip = Get-AzPublicIpAddress -ResourceGroupName rgName -Name publicIpName +$mgmtPip = Get-AzPublicIpAddress -ResourceGroupName rgName -Name MgmtPublicIpName +$firewall.Allocate($vnet, $pip, $mgmtPip) +$firewall | Set-AzFirewall +``` + +This example allocates the firewall with a management public IP address and subnet for forced tunneling scenarios. The VNet must contain a subnet called "AzureFirewallManagementSubnet". + +### 6: Add a Public IP address to an Azure Firewall +```powershell +$pip = New-AzPublicIpAddress -Name "azFwPublicIp1" -ResourceGroupName "rg" -Sku "Standard" -Location "centralus" -AllocationMethod Static +$azFw = Get-AzFirewall -Name "AzureFirewall" -ResourceGroupName "rg" +$azFw.AddPublicIpAddress($pip) + +$azFw | Set-AzFirewall +``` + +In this example, the Public IP Address "azFwPublicIp1" as attached to the Firewall. + +### 7: Remove a Public IP address from an Azure Firewall +```powershell +$pip = Get-AzPublicIpAddress -Name "azFwPublicIp1" -ResourceGroupName "rg" +$azFw = Get-AzFirewall -Name "AzureFirewall" -ResourceGroupName "rg" +$azFw.RemovePublicIpAddress($pip) + +$azFw | Set-AzFirewall +``` + +In this example, the Public IP Address "azFwPublicIp1" as detached from the Firewall. + +### 8: Change the management public IP address on an Azure Firewall +```powershell +$newMgmtPip = New-AzPublicIpAddress -Name "azFwMgmtPublicIp2" -ResourceGroupName "rg" -Sku "Standard" -Location "centralus" -AllocationMethod Static +$azFw = Get-AzFirewall -Name "AzureFirewall" -ResourceGroupName "rg" +$azFw.ManagementIpConfiguration.PublicIpAddress = $newMgmtPip + +$azFw | Set-AzFirewall +``` + +In this example, the management public IP address of the firewall will be changed to "AzFwMgmtPublicIp2" + +### 9: Add DNS configuration to an Azure Firewall +```powershell +$dnsServers = @("10.10.10.1", "20.20.20.2") +$azFw = Get-AzFirewall -Name "AzureFirewall" -ResourceGroupName "rg" +$azFw.DNSEnableProxy = $true +$azFw.DNSServer = $dnsServers + +$azFw | Set-AzFirewall +``` + +In this example, DNS Proxy and DNS Server configuration is attached to the Firewall. + +### 10: Update destination of an existing rule within a Firewall application rule collection +```powershell +$azFw = Get-AzFirewall -Name "AzureFirewall" -ResourceGroupName "rg" +$ruleCollection = $azFw.GetNetworkRuleCollectionByName("ruleCollectionName") +$rule=$ruleCollection.GetRuleByName("ruleName") +$rule.DestinationAddresses = "10.10.10.10" +Set-AzFirewall -AzureFirewall $azFw +``` + +This example updates the destination of an existing rule within a rule collection of an Azure Firewall. This allows you to automatically update your rules when IP addresses change dynamically. + +### 11: Allow Active FTP on Azure Firewall +```powershell +$azFw = Get-AzFirewall -Name "AzureFirewall" -ResourceGroupName "rg" +$azFw.AllowActiveFTP = $true + +$azFw | Set-AzFirewall +``` + +In this example, Active FTP is allowed on the Firewall. + +### 12: Deallocate and allocate the Firewall from a Virtual Hub +```powershell +$firewall=Get-AzFirewall -ResourceGroupName rgName -Name azFw +$firewall.Deallocate() +$firewall | Set-AzFirewall + +$Hub = Get-AzVirtualHub -ResourceGroupName "testRG" -Name "westushub" +$firewall.Allocate($Hub.Id) +$firewall | Set-AzFirewall +``` + +This example retrieves a Hub Firewall, deallocates the hub firewall, and saves it. The Deallocate command removes the reference +to the virtual hub but preserves the firewall's configuration. For changes to be reflected in cloud, Set-AzFirewall must be called. +The Allocate method assigns the virtual hub reference to the firewall. Again, for changes to be reflected in cloud, +Set-AzFirewall must be called. + +### 13: Enable Fat Flow Logging on Azure Firewall +```powershell +$azFw = Get-AzFirewall -Name "ps184" -ResourceGroupName "ps774" +$azFw.EnableFatFlowLogging = $true + +$azFw | Set-AzFirewall +``` + +```output +AllowActiveFTP : null + ApplicationRuleCollections : Count = 0 + ApplicationRuleCollectionsText : "[]" + DNSEnableProxy : null + DNSServer : null + DNSServersText : "null" + Etag : "W/\"7533fa1b-8588-400d-857c-6bc372e14f1b\"" + FirewallPolicy : null + HubIPAddresses : null + Id : "/subscriptions/aeb5b02a-0f18-45a4-86d6-81808115cacf/resourceGroups/ps774/providers/Microsoft.Network/azureFirewalls/ps184" + EnableFatFlowLogging : "true" + IpConfigurations : Count = 0 + IpConfigurationsText : "[]" + Location : "eastus" + ManagementIpConfiguration : null + ManagementIpConfigurationText : "null" + Name : "ps184" + NatRuleCollections : Count = 0 + NatRuleCollectionsText : "[]" + NetworkRuleCollections : Count = 0 + NetworkRuleCollectionsText : "[]" + PrivateRange : null + PrivateRangeText : "null" + ProvisioningState : "Succeeded" + ResourceGroupName : "ps774" + ResourceGuid : null + Sku : {Microsoft.Azure.Commands.Network.Models.PSAzureFirewallSku} + Tag : null + TagsTable : null + ThreatIntelMode : "Alert" + ThreatIntelWhitelist : {Microsoft.Azure.Commands.Network.Models.PSAzureFirewallThreatIntelWhitelist} + ThreatIntelWhitelistText : "{\r\n \"FQDNs\": null,\r\n \"IpAddresses\": null\r\n}" + Type : "Microsoft.Network/azureFirewalls" + VirtualHub : null + Zones : Count = 0 + privateRange : null +``` + +In this example, Enable Fat Flow Logging is enabled on the Firewall. + +### 14: Upgrade Azure Firewall Standard to Premium +```powershell +$azfw = Get-AzFirewall -Name "AzureFirewall" -ResourceGroupName "rg" +$azfw.Sku.Tier="Premium" +Set-AzFirewall -AzureFirewall $azfw +``` + +This example upgrades your existing Azure Firewall Standard to Premium Firewall. Upgrade process may take several minutes and does not require service down time. After upgrade is completed successfully you may replace your exiting standard policy with premium. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureFirewall +The AzureFirewall + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewall +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewall + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewall + +## NOTES + +## RELATED LINKS + +[Get-AzFirewall](./Get-AzFirewall.md) + +[New-AzFirewall](./New-AzFirewall.md) + +[Remove-AzFirewall](./Remove-AzFirewall.md) diff --git a/azps-10.1.0/Az.Network/Set-AzFirewallPolicy.md b/azps-10.1.0/Az.Network/Set-AzFirewallPolicy.md new file mode 100644 index 0000000000..77e48e355e --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzFirewallPolicy.md @@ -0,0 +1,545 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azfirewallpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzFirewallPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzFirewallPolicy.md +--- + +# Set-AzFirewallPolicy + +## SYNOPSIS +Saves a modified azure firewall policy + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Set-AzFirewallPolicy -Name <String> -ResourceGroupName <String> [-AsJob] [-ThreatIntelMode <String>] + [-ThreatIntelWhitelist <PSAzureFirewallPolicyThreatIntelWhitelist>] [-BasePolicy <String>] + [-DnsSetting <PSAzureFirewallPolicyDnsSettings>] [-SqlSetting <PSAzureFirewallPolicySqlSetting>] + -Location <String> [-Tag <Hashtable>] [-IntrusionDetection <PSAzureFirewallPolicyIntrusionDetection>] + [-TransportSecurityName <String>] [-TransportSecurityKeyVaultSecretId <String>] [-SkuTier <String>] + [-UserAssignedIdentityId <String>] [-Identity <PSManagedServiceIdentity>] [-PrivateRange <String[]>] + [-ExplicitProxy <PSAzureFirewallPolicyExplicitProxy>] [-Snat <PSAzureFirewallPolicySNAT>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Set-AzFirewallPolicy [-Name <String>] -InputObject <PSAzureFirewallPolicy> [-AsJob] [-ThreatIntelMode <String>] + [-ThreatIntelWhitelist <PSAzureFirewallPolicyThreatIntelWhitelist>] [-BasePolicy <String>] + [-DnsSetting <PSAzureFirewallPolicyDnsSettings>] [-SqlSetting <PSAzureFirewallPolicySqlSetting>] + [-Location <String>] [-Tag <Hashtable>] [-IntrusionDetection <PSAzureFirewallPolicyIntrusionDetection>] + [-TransportSecurityName <String>] [-TransportSecurityKeyVaultSecretId <String>] [-SkuTier <String>] + [-UserAssignedIdentityId <String>] [-Identity <PSManagedServiceIdentity>] [-PrivateRange <String[]>] + [-ExplicitProxy <PSAzureFirewallPolicyExplicitProxy>] [-Snat <PSAzureFirewallPolicySNAT>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Set-AzFirewallPolicy [-AsJob] -ResourceId <String> [-ThreatIntelMode <String>] + [-ThreatIntelWhitelist <PSAzureFirewallPolicyThreatIntelWhitelist>] [-BasePolicy <String>] + [-DnsSetting <PSAzureFirewallPolicyDnsSettings>] [-SqlSetting <PSAzureFirewallPolicySqlSetting>] + -Location <String> [-Tag <Hashtable>] [-IntrusionDetection <PSAzureFirewallPolicyIntrusionDetection>] + [-TransportSecurityName <String>] [-TransportSecurityKeyVaultSecretId <String>] [-SkuTier <String>] + [-UserAssignedIdentityId <String>] [-Identity <PSManagedServiceIdentity>] [-PrivateRange <String[]>] + [-ExplicitProxy <PSAzureFirewallPolicyExplicitProxy>] [-Snat <PSAzureFirewallPolicySNAT>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzFirewallPolicy** cmdlet updates an Azure Firewall Policy. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzFirewallPolicy -InputObject $fp +``` + +This example sets the firewall policy with the new firewall policy value + +### Example 2 +```powershell +Set-AzFirewallPolicy -Name firewallPolicy1 -ResourceGroupName TestRg -Location westcentralus -ThreatIntelMode "Alert" +``` + +This example sets the firewall policy with the new threat intel mode + +### Example 3 +```powershell +$threatIntelWhitelist = New-AzFirewallPolicyThreatIntelWhitelist -IpAddress 23.46.72.91,192.79.236.79 -FQDN microsoft.com +Set-AzFirewallPolicy -Name firewallPolicy1 -ResourceGroupName TestRg -Location westcentralus -ThreatIntelWhitelist $threatIntelWhitelist +``` + +This example sets the firewall policy with the new threat intel whitelist + +### Example 4 +```powershell +$exProxy = New-AzFirewallPolicyExplicitProxy -EnableExplicitProxy -HttpPort 100 -HttpsPort 101 -EnablePacFile -PacFilePort 130 -PacFile "sampleurlfortesting.blob.core.windowsnet/nothing" +Set-AzFirewallPolicy -Name firewallPolicy1 -ResourceGroupName TestRg -Location westcentralus -ExplicitProxy $exProxy +``` + +```output +BasePolicy : null + DnsSettings : null + Etag : null + ExplicitProxy + EnableExplicitProxy : true + EnablePacFile : true + HttpPort : 100 + HttpsPort : 101 + PacFile : "sampleurlfortesting.blob.core.windowsnet/nothing" + PacFilePort : 130 + Id : null + Identity : null + IntrusionDetection : null + Location : "westcentralus" + Name : "firewallPolicy1" + PrivateRange : null + PrivateRangeText : "[]" + ProvisioningState : null + ResourceGroupName : "TestRg" + ResourceGuid : null + RuleCollectionGroups : null + Sku + Tier : "Standard" + Snat + AutoLearnPrivateRanges : null + PrivateRanges : null + SqlSetting : null + Tag : null + TagsTable : null + ThreatIntelMode : "Alert" + ThreatIntelWhitelist : null + TransportSecurity : null + Type : null +``` + +This example sets the firewall policy with the explicit proxy settings + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BasePolicy +The base policy to inherit from + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsSetting +The DNS Setting + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyDnsSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExplicitProxy +The Explicit Proxy Settings + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyExplicitProxy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Firewall Policy Identity to be assigned to Firewall Policy. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The AzureFirewall Policy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicy +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntrusionDetection +The Intrusion Detection Setting + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyIntrusionDetection +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +location. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: SetByInputObjectParameterSet +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PrivateRange +The Private IP Range + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +The resource Id. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -SkuTier +Firewall policy sku tier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Standard, Premium, Basic + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Snat +The private IP addresses/IP ranges to which traffic will not be SNAT in Firewall Policy. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicySNAT +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlSetting +The SQL related setting + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicySqlSetting +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ThreatIntelMode +The operation mode for Threat Intelligence. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Alert, Deny, Off + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ThreatIntelWhitelist +The whitelist for Threat Intelligence + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyThreatIntelWhitelist +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportSecurityKeyVaultSecretId +Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportSecurityName +Transport security name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +ResourceId of the user assigned identity to be assigned to Firewall Policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: UserAssignedIdentity + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicy + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewall + +## NOTES + +## RELATED LINKS + +[New-AzFirewallPolicyExplicitProxy](./New-AzFirewallPolicyExplicitProxy.md) +[New-AzFirewallPolicySnat](./New-AzFirewallPolicySnat.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzFirewallPolicyRuleCollectionGroup.md b/azps-10.1.0/Az.Network/Set-AzFirewallPolicyRuleCollectionGroup.md new file mode 100644 index 0000000000..e718f861c7 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzFirewallPolicyRuleCollectionGroup.md @@ -0,0 +1,275 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azfirewallpolicyrulecollectiongroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzFirewallPolicyRuleCollectionGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzFirewallPolicyRuleCollectionGroup.md +--- + +# Set-AzFirewallPolicyRuleCollectionGroup + +## SYNOPSIS +saves a modified azure firewall policy rule collection group + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Set-AzFirewallPolicyRuleCollectionGroup -Name <String> -ResourceGroupName <String> -FirewallPolicyName <String> + -Priority <UInt32> [-RuleCollection <PSAzureFirewallPolicyBaseRuleCollection[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByParentInputObjectParameterSet +``` +Set-AzFirewallPolicyRuleCollectionGroup -Name <String> -FirewallPolicyObject <PSAzureFirewallPolicy> + -Priority <UInt32> [-RuleCollection <PSAzureFirewallPolicyBaseRuleCollection[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Set-AzFirewallPolicyRuleCollectionGroup -InputObject <PSAzureFirewallPolicyRuleCollectionGroupWrapper> + [-Priority <UInt32>] [-RuleCollection <PSAzureFirewallPolicyBaseRuleCollection[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Set-AzFirewallPolicyRuleCollectionGroup -ResourceId <String> -Priority <UInt32> + [-RuleCollection <PSAzureFirewallPolicyBaseRuleCollection[]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzFirewallPolicyRuleCollectionGroup** cmdlet updates a rule collection groups in an Azure Firewall Policy. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzFirewallPolicyRuleCollectionGroup -Name rg1 -ResourceGroupName TestRg -Priority 200 -RuleCollection $filterRule1 -FirewallPolicyName "firewallPolicy" +``` + +This example updates a rule collection group in the firewall policy $fp + +### Example 2 + +saves a modified azure firewall policy rule collection group. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzFirewallPolicyRuleCollectionGroup -FirewallPolicyName <String> -Name rg1 -Priority 200 -ResourceGroupName TestRg -RuleCollection <PSAzureFirewallPolicyBaseRuleCollection[]> +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallPolicyName +The name of the firewall policy + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FirewallPolicyObject +Firewall Policy. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicy +Parameter Sets: SetByParentInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The list of rules + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyRuleCollectionGroupWrapper +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: SetByParentInputObjectParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Priority +The priority of the rule group + +```yaml +Type: System.UInt32 +Parameter Sets: SetByNameParameterSet, SetByParentInputObjectParameterSet, SetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.UInt32 +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id of the Rule collection groupy + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleCollection +The list of rule collections + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyBaseRuleCollection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallPolicyRuleCollectionGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Set-AzIpAllocation.md b/azps-10.1.0/Az.Network/Set-AzIpAllocation.md new file mode 100644 index 0000000000..de87bb21b1 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzIpAllocation.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azipallocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzIpAllocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzIpAllocation.md +--- + +# Set-AzIpAllocation + +## SYNOPSIS +Saves a modified IpAllocation. + +## SYNTAX + +### SetByNameParameterSet +``` +Set-AzIpAllocation -ResourceGroupName <String> -Name <String> [-IpAllocationTag <Hashtable>] [-Tag <Hashtable>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Set-AzIpAllocation -ResourceId <String> [-IpAllocationTag <Hashtable>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Set-AzIpAllocation -InputObject <PSIpAllocation> [-IpAllocationTag <Hashtable>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzIpAllocation** cmdlet updates an Azure IpAllocation + +## EXAMPLES + +### Example 1 +```powershell +Set-AzIpAllocation -ResourceGroupName 'TestResourceGroup' -Name 'TestIpAllocation' -IpAllocationTag @{"VnetId"="vnet1"} -Tag @{"TestTag"="TestValue"} +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The IpAllocation + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpAllocation +Parameter Sets: SetByInputObjectParameterSet +Aliases: IpAllocation + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IpAllocationTag +The allocation tags of the IP allocation + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +IpAllocation Id + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: IpAllocationId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIpAllocation + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIpAllocation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Set-AzIpGroup.md b/azps-10.1.0/Az.Network/Set-AzIpGroup.md new file mode 100644 index 0000000000..b3fc65aeed --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzIpGroup.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azipgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzIpGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzIpGroup.md +--- + +# Set-AzIpGroup + +## SYNOPSIS +Saves a modified Firewall. + +## SYNTAX + +``` +Set-AzIpGroup -IpGroup <PSIpGroup> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzIpGroup** cmdlet updates an Azure IpGroup + +## EXAMPLES + +### Example 1 +```powershell +$ipGroup = Get-AzIpGroup -ResourceGroupName ipGroupRG -Name ipGroup +$ipGroup.IpAddresses.Add("11.11.0.0/24") +Set-AzIpGroup -IpGroup $ipGroup +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpGroup +The IpGroup + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpGroup +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIpGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIpGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Set-AzLoadBalancer.md b/azps-10.1.0/Az.Network/Set-AzLoadBalancer.md new file mode 100644 index 0000000000..38e5875c45 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzLoadBalancer.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 494E185D-3746-4959-846E-660017A1F392 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azloadbalancer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancer.md +--- + +# Set-AzLoadBalancer + +## SYNOPSIS +Updates a load balancer. + +## SYNTAX + +``` +Set-AzLoadBalancer -LoadBalancer <PSLoadBalancer> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzLoadBalancer** cmdlet updates a load balancer. + +## EXAMPLES + +### Example 1: Modify a load balancer +```powershell +$slb = Get-AzLoadBalancer -Name "NRPLB" +$slb | Add-AzLoadBalancerInboundNatRuleConfig -Name "NewRule" -FrontendIpConfiguration $slb.FrontendIpConfigurations[0] -FrontendPort 81 -BackendPort 8181 -Protocol "TCP" +$slb | Set-AzLoadBalancer +``` + +The first command gets the load balancer named NRPLB, and then stores it in the $slb variable. +The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzLoadBalancerInboundNatRuleConfig, which adds an inbound NAT rule named NewRule. +The third command passes the load balancer to **Set-AzLoadBalancer**, which updates the load balancer configuration and saves it. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies a load balancer object representing the state to which the load balancer should be set. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[New-AzLoadBalancer](./New-AzLoadBalancer.md) + +[Remove-AzLoadBalancer](./Remove-AzLoadBalancer.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzLoadBalancerBackendAddressPool.md b/azps-10.1.0/Az.Network/Set-AzLoadBalancerBackendAddressPool.md new file mode 100644 index 0000000000..ffc6f3b4ba --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzLoadBalancerBackendAddressPool.md @@ -0,0 +1,292 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azloadbalancerbackendaddresspool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerBackendAddressPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerBackendAddressPool.md +--- + +# Set-AzLoadBalancerBackendAddressPool + +## SYNOPSIS +Updates the backend pool on a loadbalancer + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Set-AzLoadBalancerBackendAddressPool -ResourceGroupName <String> -LoadBalancerName <String> -Name <String> + -LoadBalancerBackendAddress <PSLoadBalancerBackendAddress[]> [-TunnelInterface <PSTunnelInterface[]>] [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByParentObjectParameterSet +``` +Set-AzLoadBalancerBackendAddressPool -Name <String> -LoadBalancer <PSLoadBalancer> + -LoadBalancerBackendAddress <PSLoadBalancerBackendAddress[]> [-TunnelInterface <PSTunnelInterface[]>] [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Set-AzLoadBalancerBackendAddressPool -InputObject <PSBackendAddressPool> + [-TunnelInterface <PSTunnelInterface[]>] [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Set-AzLoadBalancerBackendAddressPool -LoadBalancerBackendAddress <PSLoadBalancerBackendAddress[]> + -ResourceId <String> [-TunnelInterface <PSTunnelInterface[]>] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the backend pool on a loadbalancer + +## EXAMPLES + +### Example 1 +```powershell +# Set by name and modified input object +$virtualNetwork = Get-AzVirtualNetwork -Name $vnetName -ResourceGroupName $resourceGroup +$lb = Get-AzLoadBalancer -ResourceGroupName $resourceGroup -Name $loadBalancerName +$ip1 = New-AzLoadBalancerBackendAddressConfig -IpAddress "10.0.0.5" -Name "TestVNetRef" -VirtualNetworkId $virtualNetwork.Id +$ip2 = New-AzLoadBalancerBackendAddressConfig -IpAddress "10.0.0.6" -Name "TestVNetRef2" -VirtualNetworkId $virtualNetwork.Id +$ip3 = New-AzLoadBalancerBackendAddressConfig -IpAddress "10.0.0.7" -Name "TestVNetRef3" -VirtualNetworkId $virtualNetwork.id +$tunnelInterface1 = New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig -Protocol "Vxlan" -Type "Internal" -Port 2000 -Identifier 800 +$tunnelInterface2 = New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig -Protocol "Vxlan" -Type "External" -Port 2001 -Identifier 801 +New-AzLoadBalancerBackendAddressPool -ResourceGroupName $resourceGroup -LoadBalancerName $loadBalancerName -Name $backendPool3 -TunnelInterface $tunnelInterface1, $tunnelInterface2 +$ips = @($ip1, $ip2) +$b2 = Get-AzLoadBalancerBackendAddressPool -ResourceGroupName $resourceGroup -LoadBalancerName $loadBalancerName -Name $backendPool1 +$b2.LoadBalancerBackendAddresses.Add($ip3) + +Set-AzLoadBalancerBackendAddressPool -InputObject $b2 +``` + +### Example 2 +```powershell +# Set by specific backend from piped loadbalancer and set two IP's +$lb | Set-AzLoadBalancerBackendAddressPool -LoadBalancerBackendAddress $ips -Name $backendPool1 +``` + +### Example 3 +```powershell +# Set by ResourceId +Set-AzLoadBalancerBackendAddressPool -ResourceId $b2.Id -LoadBalancerBackendAddress $b2.LoadBalancerBackendAddresses +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The backend address pool to set + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LoadBalancer +The load balancer resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: SetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LoadBalancerBackendAddress +The backend addresses. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancerBackendAddress[] +Parameter Sets: SetByNameParameterSet, SetByParentObjectParameterSet, SetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerName +The name of the load balancer. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the backend pool. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet, SetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the load balancer. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TunnelInterface +Gateway Load Balancer provider configurations. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSTunnelInterface[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Set-AzLoadBalancerFrontendIpConfig.md b/azps-10.1.0/Az.Network/Set-AzLoadBalancerFrontendIpConfig.md new file mode 100644 index 0000000000..a3e04775f5 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzLoadBalancerFrontendIpConfig.md @@ -0,0 +1,351 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C23BEF37-D472-43EC-90AA-F8742247ABA2 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azloadbalancerfrontendipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerFrontendIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerFrontendIpConfig.md +--- + +# Set-AzLoadBalancerFrontendIpConfig + +## SYNOPSIS +Updates a front-end IP configuration for a load balancer. + +## SYNTAX + +### SetByResourceSubnet (Default) +``` +Set-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-PrivateIpAddress <String>] + [-PrivateIpAddressVersion <String>] [-Zone <String[]>] -Subnet <PSSubnet> [-GatewayLoadBalancerId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdSubnet +``` +Set-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-PrivateIpAddress <String>] + [-PrivateIpAddressVersion <String>] [-Zone <String[]>] -SubnetId <String> [-GatewayLoadBalancerId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdPublicIpAddress +``` +Set-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Zone <String[]>] + -PublicIpAddressId <String> [-GatewayLoadBalancerId <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourcePublicIpAddress +``` +Set-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Zone <String[]>] + -PublicIpAddress <PSPublicIpAddress> [-GatewayLoadBalancerId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdPublicIpAddressPrefix +``` +Set-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Zone <String[]>] + -PublicIpAddressPrefixId <String> [-GatewayLoadBalancerId <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourcePublicIpAddressPrefix +``` +Set-AzLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Zone <String[]>] + -PublicIpAddressPrefix <PSPublicIpPrefix> [-GatewayLoadBalancerId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzLoadBalancerFrontendIpConfig** cmdlet updates a front-end IP configuration for a load balancer. + +## EXAMPLES + +### Example 1: Modify the front-end IP configuration of a load balancer +```powershell +$Subnet = Get-AzVirtualNetwork -Name "MyVnet" -ResourceGroupName "MyResourceGroup" | Get-AzVirtualNetworkSubnetConfig -Name "Subnet" +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$slb | Add-AzLoadBalancerFrontendIpConfig -Name "NewFrontend" -Subnet $Subnet +$slb | Set-AzLoadBalancerFrontendIpConfig -Name "NewFrontend" -Subnet $Subnet +$slb | Set-AzLoadBalancer +``` + +The first command gets the virtual subnet named Subnet, and then stores it in the $Subnet variable. +The second command gets the associated load balancer named MyLoadBalancer, and then stores it in the $slb variable. +The third command uses the pipeline operator to pass the load balancer in $slb to Add-AzLoadBalancerFrontendIpConfig, which creates a front-end IP configuration named NewFrontend for $slb. +The fourth command passes the load balancer in $slb to **Set-AzLoadBalancerFrontendIpConfig**, which saves and updates the front-end IP configuration. + +### Example 2: Modify the front-end IP configuration of a load balancer with Gateway Load Balancer +```powershell +$slb1 = Get-AzLoadBalancer -Name "MyLoadBalancer1" -ResourceGroupName "MyResourceGroup" +$feip = Get-AzLoadBalancerFrontendIpConfig -Name "MyFrontEnd" -LoadBalancer $slb1 +$slb2 = Get-AzLoadBalancer -Name "MyLoadBalancer1" -ResourceGroupName "MyResourceGroup" +$slb2 | Set-AzLoadBalancerFrontendIpConfig -Name "NewFrontend" -PublicIpAddress $publicIp -GatewayLoadBalancerId $feip.Id +$slb2 | Set-AzLoadBalancer +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayLoadBalancerId +Specifies the ID of the Gateway Load Balancer Provider Frontend Ip Configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies a load balancer. +This cmdlet updates a front-end configuration for the load balancer that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the front-end IP configuration to set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddress +Specifies the private IP address of the load balancer that is associated with the front-end IP configuration to set. +Specify this parameter only if you also specify the *Subnet* parameter. + +```yaml +Type: System.String +Parameter Sets: SetByResourceSubnet, SetByResourceIdSubnet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateIpAddressVersion +The private IP address version of the IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceSubnet, SetByResourceIdSubnet +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddress +Specifies the **PublicIpAddress** object that is associated with the front-end IP configuration to set. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: SetByResourcePublicIpAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddressId +Specifies the ID of the **PublicIpAddress** object that is associated with the front-end IP configuration that this cmdlet sets. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdPublicIpAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicIpAddressPrefix +Specifies the **PublicIpAddressPrefix** object to associate with a front-end IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix +Parameter Sets: SetByResourcePublicIpAddressPrefix +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PublicIpAddressPrefixId +Specifies the ID of the **PublicIpAddressPrefix** object to associate with a front-end IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdPublicIpAddressPrefix +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Subnet +Specifies the **Subnet** object that contains the front-end IP configuration that this cmdlet sets. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResourceSubnet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubnetId +Specifies the ID of the subnet that contains the front-end IP configuration that this cmdlet sets. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdSubnet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +A list of availability zones denoting the IP allocated for the resource needs to come from. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +### System.String[] + +### Microsoft.Azure.Commands.Network.Models.PSSubnet + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerFrontendIpConfig](./Add-AzLoadBalancerFrontendIpConfig.md) + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[Get-AzLoadBalancerFrontendIpConfig](./Get-AzLoadBalancerFrontendIpConfig.md) + +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) + +[New-AzLoadBalancerFrontendIpConfig](./New-AzLoadBalancerFrontendIpConfig.md) + +[Remove-AzLoadBalancerFrontendIpConfig](./Remove-AzLoadBalancerFrontendIpConfig.md) diff --git a/azps-10.1.0/Az.Network/Set-AzLoadBalancerInboundNatPoolConfig.md b/azps-10.1.0/Az.Network/Set-AzLoadBalancerInboundNatPoolConfig.md new file mode 100644 index 0000000000..3148aae3e6 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzLoadBalancerInboundNatPoolConfig.md @@ -0,0 +1,271 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 355DF798-6233-45C6-9416-8AB0E0D7DC02 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azloadbalancerinboundnatpoolconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerInboundNatPoolConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerInboundNatPoolConfig.md +--- + +# Set-AzLoadBalancerInboundNatPoolConfig + +## SYNOPSIS +Sets an inbound NAT pool configuration for a load balancer. + +## SYNTAX + +### SetByResource (Default) +``` +Set-AzLoadBalancerInboundNatPoolConfig -LoadBalancer <PSLoadBalancer> -Name <String> -Protocol <String> + -FrontendPortRangeStart <Int32> -FrontendPortRangeEnd <Int32> -BackendPort <Int32> + [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-EnableTcpReset] + [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Set-AzLoadBalancerInboundNatPoolConfig -LoadBalancer <PSLoadBalancer> -Name <String> -Protocol <String> + -FrontendPortRangeStart <Int32> -FrontendPortRangeEnd <Int32> -BackendPort <Int32> + [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-EnableTcpReset] [-FrontendIpConfigurationId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzLoadBalancerInboundNatPoolConfig** cmdlet sets an inbound NAT pool configuration for a load balancer. + +## EXAMPLES + +### Example 1: Set +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$feIpConfig = Get-AzLoadBalancerFrontendIpConfig -Name "FrontendName" -LoadBalancer $slb +Set-AzLoadBalancerInboundNatPoolConfig -Name "myInboundNatPool" -LoadBalancer $slb -FrontendIpConfigurationId $inboundNatPoolConfig.FrontendIPConfiguration -Protocol TCP -FrontendPortRangeStart 2001 -FrontendPortRangeEnd 3000 -BackendPort 2001 +$slb | Set-AzLoadBalancer +``` + +## PARAMETERS + +### -BackendPort +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFloatingIP +Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTcpReset +Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIpConfiguration +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendIpConfigurationId +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPortRangeEnd +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPortRangeStart +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancer +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerInboundNatPoolConfig](./Add-AzLoadBalancerInboundNatPoolConfig.md) + +[Get-AzLoadBalancerInboundNatPoolConfig](./Get-AzLoadBalancerInboundNatPoolConfig.md) + +[New-AzLoadBalancerInboundNatPoolConfig](./New-AzLoadBalancerInboundNatPoolConfig.md) + +[Remove-AzLoadBalancerInboundNatPoolConfig](./Remove-AzLoadBalancerInboundNatPoolConfig.md) diff --git a/azps-10.1.0/Az.Network/Set-AzLoadBalancerInboundNatRuleConfig.md b/azps-10.1.0/Az.Network/Set-AzLoadBalancerInboundNatRuleConfig.md new file mode 100644 index 0000000000..fe8738a355 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzLoadBalancerInboundNatRuleConfig.md @@ -0,0 +1,366 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 87818605-EFA6-422E-9ECD-0A0BF269DCFD +online version: https://learn.microsoft.com/powershell/module/az.network/set-azloadbalancerinboundnatruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerInboundNatRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerInboundNatRuleConfig.md +--- + +# Set-AzLoadBalancerInboundNatRuleConfig + +## SYNOPSIS +Sets an inbound NAT rule configuration for a load balancer. + +## SYNTAX + +### SetByResource (Default) +``` +Set-AzLoadBalancerInboundNatRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] + [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] + [-EnableTcpReset] [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-FrontendPortRangeStart <Int32>] + [-FrontendPortRangeEnd <Int32>] [-BackendAddressPool <PSBackendAddressPool>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Set-AzLoadBalancerInboundNatRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] + [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] + [-EnableTcpReset] [-FrontendIpConfigurationId <String>] [-FrontendPortRangeStart <Int32>] + [-FrontendPortRangeEnd <Int32>] [-BackendAddressPoolId <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzLoadBalancerInboundNatRuleConfig** cmdlet sets an inbound network address translation (NAT) rule configuration for an Azure load balancer. + +## EXAMPLES + +### Example 1: Modify the inbound NAT rule configuration on a load balancer +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$slb | Add-AzLoadBalancerInboundNatRuleConfig -Name "NewNatRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP +$slb | Set-AzLoadBalancerInboundNatRuleConfig -Name "NewNatRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 +``` + +The first command gets the load balancer named MyLoadBalancer, and then stores it in the $slb variable. +The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzLoadBalancerInboundNatRuleConfig, which adds an inbound NAT rule configuration to it. +The third command passes the load balancer to **Set-AzLoadBalancerInboundNatRuleConfig**, which saves and updates the inbound NAT rule configuration. +Note that the rule configuration was set without enabling floating IP, which had been enabled by the previous command. + +### Example 2 + +Sets an inbound NAT rule configuration for a load balancer. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzLoadBalancerInboundNatRuleConfig -BackendPort 3350 -FrontendIpConfigurationId <String> -FrontendPort 3350 -LoadBalancer <PSLoadBalancer> -Name 'NewNatRule' -Protocol 'Tcp' +``` + +### Example 3: Modify the inbound NAT rule V2 configuration on a load balancer +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$slb | Add-AzLoadBalancerInboundNatRuleConfig -Name "NewNatRuleV2" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -IdleTimeoutInMinutes 10 -FrontendPortRangeStart 3389 -FrontendPortRangeEnd 4000 -BackendAddressPool $slb.BackendAddressPools[0] -BackendPort 3389 +$slb | Set-AzLoadBalancerInboundNatRuleConfig -Name "NewNatRuleV2" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -IdleTimeoutInMinutes 10 -FrontendPortRangeStart 3370 -FrontendPortRangeEnd 3389 -BackendAddressPool $slb.BackendAddressPools[0] -BackendPort 3380 +``` + +The first command gets the load balancer named MyLoadBalancer, and then stores it in the $slb variable. +The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzLoadBalancerInboundNatRuleConfig, which adds an inbound NAT rule V2 configuration to it. +The third command passes the load balancer to **Set-AzLoadBalancerInboundNatRuleConfig**, which saves and updates the inbound NAT rule V2 configuration. +Note that FrontendPortRangeStart, FrontendPortRangeEnd and BackendPort are changed in rule configuration. + +## PARAMETERS + +### -BackendAddressPool +Specifies the backend address pool to associate with an inbound NAT rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +Specifies the ID of a BackendAddressPool object to associate with an inbound NAT rule configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendPort +Specifies the backend port for traffic that is matched by this rule configuration. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFloatingIP +Indicates that this cmdlet enables a floating IP address for a rule configuration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTcpReset +Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIpConfiguration +Specifies a list of front-end IP addresses to associate with an inbound NAT rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendIpConfigurationId +Specifies the ID for a front-end IP address configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPort +Specifies the front-end port that is matched by a load balancer rule configuration. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPortRangeEnd +Specifies the last port number in the range of external ports that is used by a rule configuration. Acceptable values range between 1 and 65535. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPortRangeStart +Specifies the first port number in the range of external ports that is used by a rule configuration. Acceptable values range between 1 and 65534. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +Specifies the length of time, in minutes, that the state of conversations is maintained in a load balancer. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies a load balancer. +This cmdlet sets an inbound NAT rule configuration for the load balancer that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an inbound NAT rule configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol that is matched by an inbound NAT rule configuration. +The acceptable values for this parameter are: Tcp or Udp. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerInboundNatRuleConfig](./Add-AzLoadBalancerInboundNatRuleConfig.md) + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[Get-AzLoadBalancerInboundNatRuleConfig](./Get-AzLoadBalancerInboundNatRuleConfig.md) + +[New-AzLoadBalancerInboundNatRuleConfig](./New-AzLoadBalancerInboundNatRuleConfig.md) + +[Remove-AzLoadBalancerInboundNatRuleConfig](./Remove-AzLoadBalancerInboundNatRuleConfig.md) diff --git a/azps-10.1.0/Az.Network/Set-AzLoadBalancerOutboundRuleConfig.md b/azps-10.1.0/Az.Network/Set-AzLoadBalancerOutboundRuleConfig.md new file mode 100644 index 0000000000..bcfbc41da8 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzLoadBalancerOutboundRuleConfig.md @@ -0,0 +1,264 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azloadbalanceroutboundruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerOutboundRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerOutboundRuleConfig.md +--- + +# Set-AzLoadBalancerOutboundRuleConfig + +## SYNOPSIS +Sets an outbound rule configuration for a load balancer. + +## SYNTAX + +### SetByResource (Default) +``` +Set-AzLoadBalancerOutboundRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> + [-AllocatedOutboundPort <Int32>] -Protocol <String> [-EnableTcpReset] [-IdleTimeoutInMinutes <Int32>] + -FrontendIpConfiguration <PSResourceId[]> -BackendAddressPool <PSBackendAddressPool> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Set-AzLoadBalancerOutboundRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> + [-AllocatedOutboundPort <Int32>] -Protocol <String> [-EnableTcpReset] [-IdleTimeoutInMinutes <Int32>] + -FrontendIpConfiguration <PSResourceId[]> -BackendAddressPoolId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzLoadBalancerOutboundRuleConfig** cmdlet sets an outbound rule configuration for an Azure load balancer. + +## EXAMPLES + +### Example 1: Modify the outbound rule configuration on a load balancer +```powershell +$slb = Get-AzLoadBalancer -ResourceGroupName "MyResourceGroup" -Name "MyLoadBalancer" +$slb | Add-AzLoadBalancerOutboundRuleConfig -Name "NewRule" -Protocol "Tcp" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -BackendAddressPool $slb.BackendAddressPools[0] -IdleTimeoutInMinutes 5 +$slb | Set-AzLoadBalancerOutboundRuleConfig -Name "NewRule" -Protocol "Tcp" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -BackendAddressPool $slb.BackendAddressPools[0] -IdleTimeoutInMinutes 10 +``` + +The first command gets the load balancer named MyLoadBalancer, and then stores it in the $slb variable. +The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzLoadBalancerOutboundRuleConfig, which adds an outbound rule configuration to it. +The third command passes the load balancer to **Set-AzLoadBalancerOutboundRuleConfig**, which saves and updates the outbound rule configuration. + +## PARAMETERS + +### -AllocatedOutboundPort +The number of outbound ports to be used for NAT. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendAddressPool +A reference to a pool of DIPs. +Outbound traffic is randomly load balanced across IPs in the backend IPs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +A reference to a pool of DIPs. +Outbound traffic is randomly load balanced across IPs in the backend IPs. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTcpReset +Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. +This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIpConfiguration +The Frontend IP addresses of the load balancer. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSResourceId[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +The timeout for the TCP idle connection + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancer +The reference of the load balancer resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the outbound rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol - TCP, UDP or All + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.Int32 + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSResourceId[] + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerOutboundRuleConfig](./Add-AzLoadBalancerOutboundRuleConfig.md) + +[Get-AzLoadBalancerOutboundRuleConfig](./Get-AzLoadBalancerOutboundRuleConfig.md) + +[New-AzLoadBalancerOutboundRuleConfig](./New-AzLoadBalancerOutboundRuleConfig.md) + +[Remove-AzLoadBalancerOutboundRuleConfig](./Remove-AzLoadBalancerOutboundRuleConfig.md) diff --git a/azps-10.1.0/Az.Network/Set-AzLoadBalancerProbeConfig.md b/azps-10.1.0/Az.Network/Set-AzLoadBalancerProbeConfig.md new file mode 100644 index 0000000000..7316c6abd2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzLoadBalancerProbeConfig.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: C8B91455-C1A7-43BD-9E63-A20E2694371F +online version: https://learn.microsoft.com/powershell/module/az.network/set-azloadbalancerprobeconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerProbeConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerProbeConfig.md +--- + +# Set-AzLoadBalancerProbeConfig + +## SYNOPSIS +Updates a probe configuration for a load balancer. + +## SYNTAX + +``` +Set-AzLoadBalancerProbeConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] -Port <Int32> + -IntervalInSeconds <Int32> -ProbeCount <Int32> [-ProbeThreshold <Int32>] [-RequestPath <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzLoadBalancerProbeConfig** cmdlet updates a probe configuration for a load balancer. + +## EXAMPLES + +### Example 1: Modify the probe configuration on a load balancer +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$slb | Add-AzLoadBalancerProbeConfig -Name "NewProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -ProbeThreshold 2 -RequestPath "healthcheck.aspx" +$slb | Set-AzLoadBalancerProbeConfig -Name "NewProbe" -Port 80 -IntervalInSeconds 15 -ProbeCount 2 +``` + +The first command gets the loadbalancer named MyLoadBalancer, and then stores it in the $slb variable. +The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzLoadBalancerProbeConfig, which adds a new probe configuration to it. +The third command passes the load balancer to **Set-AzLoadBalancerProbeConfig**, which sets the new configuration. +Note that it is necessary to specify several of the same parameters that were specified in the previous command because they are required by the current cmdlet. + +### Example 2 + +Updates a probe configuration for a load balancer. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzLoadBalancerProbeConfig -IntervalInSeconds 15 -Name 'NewProbe' -Port 443 -ProbeCount 2 -Protocol https -LoadBalancer <PSLoadBalancer> +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntervalInSeconds +Specifies the interval, in seconds, between probes to each instance of the load-balanced service. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies a load balancer. +This cmdlet updates a probe configuration for the load balancer that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the probe configuration that this cmdlet sets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Specifies the port on which probes should connect to a load-balanced service. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProbeCount +Specifies the number of per-instance consecutive failures for an instance to be considered unhealthy. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProbeThreshold +Specifies the number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol to use for the probing. +The acceptable values for this parameter are: Tcp or Http. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RequestPath +Specifies the path in the load-balanced service to probe to determine health. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerProbeConfig](./Add-AzLoadBalancerProbeConfig.md) + +[Get-AzLoadBalancer](./Get-AzLoadBalancer.md) + +[Get-AzLoadBalancerProbeConfig](./Get-AzLoadBalancerProbeConfig.md) + +[New-AzLoadBalancerProbeConfig](./New-AzLoadBalancerProbeConfig.md) + +[Remove-AzLoadBalancerProbeConfig](./Remove-AzLoadBalancerProbeConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzLoadBalancerRuleConfig.md b/azps-10.1.0/Az.Network/Set-AzLoadBalancerRuleConfig.md new file mode 100644 index 0000000000..ab1b5d5103 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzLoadBalancerRuleConfig.md @@ -0,0 +1,388 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 2638B226-B974-43B6-ACC2-D67573CF6B56 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azloadbalancerruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLoadBalancerRuleConfig.md +--- + +# Set-AzLoadBalancerRuleConfig + +## SYNOPSIS +Updates a rule configuration for a load balancer. + +## SYNTAX + +### SetByResource (Default) +``` +Set-AzLoadBalancerRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] + [-LoadDistribution <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] + [-EnableFloatingIP] [-EnableTcpReset] [-DisableOutboundSNAT] + [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-BackendAddressPool <PSBackendAddressPool[]>] + [-Probe <PSProbe>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Set-AzLoadBalancerRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] + [-LoadDistribution <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] + [-EnableFloatingIP] [-EnableTcpReset] [-DisableOutboundSNAT] [-FrontendIpConfigurationId <String>] + [-BackendAddressPoolId <String[]>] [-ProbeId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzLoadBalancerRuleConfig** cmdlet updates a rule configuration for a load balancer. + +## EXAMPLES + +### Example 1: Modify a load balancing rule configuration +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$slb | Add-AzLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP +$slb | Set-AzLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 +$slb | Set-AzLoadBalancer +``` + +### Example 2: Modify a load balancing rule configuration to have two backend address pools +```powershell +$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" +$MyBackendPool1 = Get-AzLoadBalancerBackendAddressPool -ResourceGroupName $resourceGroup -LoadBalancerName $MyLoadBalancer -Name $backendPool1Name +$MyBackendPool2 = Get-AzLoadBalancerBackendAddressPool -ResourceGroupName $resourceGroup -LoadBalancerName $MyLoadBalancer -Name $backendPool2Name +$slb | Set-AzLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "All" -FrontendPort 0 -BackendPort 0 -BackendAddressPool $MyBackendPool1, $MyBackendPool2 +$slb | Set-AzLoadBalancer +``` + +The first command gets the load balancer named MyLoadBalancer, and then stores it in the $slb variable. +The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzLoadBalancerRuleConfig, which adds a rule named NewRule to it. +The third command passes the load balancer to **Set-AzLoadBalancerRuleConfig**, which sets the new rule configuration. +Note that the configuration does not enable a floating IP address, which had been enabled by the previous command. + +## PARAMETERS + +### -BackendAddressPool +Specifies a **BackendAddressPool** object to associate with a load balancer rule. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendAddressPoolId +Specifies the ID of a **BackendAddressPool** object to associate with a load balancer rule configuration. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackendPort +Specifies the backend port for traffic that is matched by this rule configuration. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableOutboundSNAT +Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFloatingIP +Indicates that this cmdlet enables a floating IP address for a rule configuration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTcpReset +Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FrontendIpConfiguration +Specifies a list of front-end IP addresses to associate with a load balancer rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendIpConfigurationId +Specifies the ID for a front-end IP address configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrontendPort +Specifies the front-end port that is matched by a load balancer rule configuration. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +Specifies the length of time, in minutes, for which the state of conversations is maintained in a load balancer. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancer +Specifies a load balancer. +This cmdlet updates a rule configuration for the load balancer that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LoadDistribution +Specifies a load distribution. +The acceptable values for this parameter are: SourceIP and SourceIPProtocol. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a load balancer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Probe +Specifies a probe to associate with a load balancer rule configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSProbe +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProbeId +Specifies the ID of the probe to associate with a load balancer rule configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol that is matched by a load balancer rule. +The acceptable values for this parameter are: Tcp or Udp. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +### System.String + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool + +### Microsoft.Azure.Commands.Network.Models.PSProbe + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer + +## NOTES + +## RELATED LINKS + +[Add-AzLoadBalancerRuleConfig](./Add-AzLoadBalancerRuleConfig.md) + +[Add-AzLoadBalancerRuleConfig](./Add-AzLoadBalancerRuleConfig.md) + +[Get-AzLoadBalancerRuleConfig](./Get-AzLoadBalancerRuleConfig.md) + +[New-AzLoadBalancerRuleConfig](./New-AzLoadBalancerRuleConfig.md) + +[Remove-AzLoadBalancerRuleConfig](./Remove-AzLoadBalancerRuleConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzLocalNetworkGateway.md b/azps-10.1.0/Az.Network/Set-AzLocalNetworkGateway.md new file mode 100644 index 0000000000..3ee247122b --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzLocalNetworkGateway.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: F8C1DF39-1DAF-4BDB-8B0E-1BC3B5E82185 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azlocalnetworkgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLocalNetworkGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzLocalNetworkGateway.md +--- + +# Set-AzLocalNetworkGateway + +## SYNOPSIS +Modifies a local network gateway. + +## SYNTAX + +``` +Set-AzLocalNetworkGateway -LocalNetworkGateway <PSLocalNetworkGateway> [-AddressPrefix <String[]>] + [-Asn <UInt32>] [-BgpPeeringAddress <String>] [-PeerWeight <Int32>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzLocalNetworkGateway** cmdlet modifies a local network gateway. + +## EXAMPLES + +### Example 1 +Set configuration for an existing gateway + + +```powershell +$lgw = Get-AzLocalNetworkGateway -Name myLocalGW -ResourceGroupName myRG +Set-AzLocalNetworkGateway -LocalNetworkGateway $lgw +``` + +```output +Name : myLocalGW +ResourceGroupName : TestRG1 +Location : westus +Id : /subscriptions/81ab786c-56eb-4a4d-bb5f-f60329772466/resourceGroups/TestRG1/providers/Microso + ft.Network/localNetworkGateways/myLocalGW +Etag : W/"d2de6968-315e-411d-a4b8-a8c335abe61b" +ResourceGuid : 393acf8b-dbb8-4b08-a9ea-c714570710e1 +ProvisioningState : Succeeded +Tags : +GatewayIpAddress : 1.2.3.4 +LocalNetworkAddressSpace : { + "AddressPrefixes": [] + } +BgpSettings : null +``` + +## PARAMETERS + +### -AddressPrefix +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Asn +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BgpPeeringAddress +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalNetworkGateway +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PeerWeight +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway + +### System.String[] + +### System.UInt32 + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway + +## NOTES + +## RELATED LINKS + +[Get-AzLocalNetworkGateway](./Get-AzLocalNetworkGateway.md) + +[New-AzLocalNetworkGateway](./New-AzLocalNetworkGateway.md) + +[Remove-AzLocalNetworkGateway](./Remove-AzLocalNetworkGateway.md) diff --git a/azps-10.1.0/Az.Network/Set-AzNatGateway.md b/azps-10.1.0/Az.Network/Set-AzNatGateway.md new file mode 100644 index 0000000000..f3b6a5952c --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNatGateway.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznatgateway.md +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNatGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNatGateway.md +--- + +# Set-AzNatGateway + +## SYNOPSIS +Update Nat Gateway Resource with Public Ip Address, Public Ip Prefix and IdleTimeoutInMinutes. + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Set-AzNatGateway -ResourceGroupName <String> -Name <String> [-PublicIpAddress <PSResourceId[]>] + [-PublicIpPrefix <PSResourceId[]>] [-AsJob] [-IdleTimeoutInMinutes <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Set-AzNatGateway -ResourceId <String> [-PublicIpAddress <PSResourceId[]>] [-PublicIpPrefix <PSResourceId[]>] + [-AsJob] [-IdleTimeoutInMinutes <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Set-AzNatGateway -InputObject <PSNatGateway> [-PublicIpAddress <PSResourceId[]>] + [-PublicIpPrefix <PSResourceId[]>] [-AsJob] [-IdleTimeoutInMinutes <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update Nat Gateway Resource with Public Ip Address, Public Ip Prefix and IdleTimeoutInMinutes. + +## EXAMPLES + +### Example 1 +```powershell +$nGateway = Get-AzNatGateway -ResourceGroupName "natgateway_test" -Name "ng1" +$pipArray = $pip, $pip2 +$natUpdate = Set-AzNatGateway -InputObject $nGateway -IdleTimeoutInMinutes 5 -PublicIpAddress $pipArray +$natUpdate = Set-AzNatGateway -ResourceGroupName "natgateway_test" -Name "ng1" -PublicIpAddress $pipArray +$natUpdate = Set-AzNatGateway -ResourceId "natgateway_id" -PublicIpAddress $pipArray +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdleTimeoutInMinutes +The idle timeout of the nat gateway. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies Nat Gateway Resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNatGateway +Parameter Sets: SetByInputObjectParameterSet +Aliases: NatGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Nat Gateway Resource. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddress +An array of public ip addresses associated with the nat gateway resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSResourceId[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpPrefix +An array of public ip prefixes associated with the nat gateway resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSResourceId[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource Group. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the Id of the Nat Gateway resource. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: NatGatewayId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSNatGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNatGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkInterface.md b/azps-10.1.0/Az.Network/Set-AzNetworkInterface.md new file mode 100644 index 0000000000..08435df6a7 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkInterface.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: DDB38A77-E5C0-47DD-BADD-94488F661CD5 +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkinterface +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkInterface.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkInterface.md +--- + +# Set-AzNetworkInterface + +## SYNOPSIS +Updates a network interface. + +## SYNTAX + +``` +Set-AzNetworkInterface -NetworkInterface <PSNetworkInterface> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkInterface** updates a network interface. + +## EXAMPLES + +### Example 1: Configure a network interface +```powershell +$Nic = Get-AzNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" +$Nic.IpConfigurations[0].PrivateIpAddress = "10.0.1.20" +$Nic.IpConfigurations[0].PrivateIpAllocationMethod = "Static" +$Nic.Tag = @{Name = "Name"; Value = "Value"} +Set-AzNetworkInterface -NetworkInterface $Nic +``` + +This example configures a network interface. +The first command gets a network interface named NetworkInterface1 in resource group ResourceGroup1. +The second command sets the private IP address of the IP configuration. +The third command sets the private IP allocation method to Static. +The fourth command sets a tag on the network interface. +The fifth command uses the information stored in the $Nic variable to set the network interface. + +### Example 2: Change DNS settings on a network interface +```powershell +$nic = Get-AzNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" +$nic.DnsSettings.DnsServers.Add("192.168.1.100") +$nic | Set-AzNetworkInterface +``` + +The first command gets a network interface named NetworkInterface1 that exists within resource group ResourceGroup1. The second command adds DNS server 192.168.1.100 to this interface. The third command applies these changes to the network interface. To remove a DNS server, follow the commands listed above, but replace ".Add" with ".Remove" in the second command. + +### Example 3: Enable IP forwarding on a network interface +```powershell +$nic = Get-AzNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" +$nic.EnableIPForwarding = 1 +$nic | Set-AzNetworkInterface +``` + +The first command gets an existing network interface called NetworkInterface1 and stores it in the $nic variable. The second command changes the IP forwarding value to true. Finally, the third command applies the changes to the network interface. To disable IP forwarding on a network interface, follow the sample example, but be sure to change the second command to "$nic.EnableIPForwarding = 0". + +### Example 4: Change the subnet of a network interface +```powershell +$nic = Get-AzNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" +$vnet = Get-AzVirtualNetwork -Name VNet1 -ResourceGroupName crosssubcrossversionpeering +$subnet2 = Get-AzVirtualNetworkSubnetConfig -Name Subnet2 -VirtualNetwork $vnet +$nic.IpConfigurations[0].Subnet.Id = $subnet2.Id +$nic | Set-AzNetworkInterface +``` + +The first command gets the network interface NetworkInterface1 and stores it in the $nic variable. The second command gets the virtual network associated with the subnet that the network interface is going to be associated with. The second command gets the subnet and stores it in the $subnet2 variable. The third command associated the primary private IP address of the network interface with the new subnet. Finally the last command applied these changes on the network interface. +>[!NOTE] +>The IP configurations must be dynamic before you can change the subnet. If you have static IP configurations, change then to dynamic before proceeding. +>[!NOTE] +>If the network interface has multiple IP configurations, the fourth command must be done for all these IP configurations before the final Set-AzNetworkInterface command is executed. This can be done as in the fourth command but by replacing "0" with the appropriate number. If a network interface has N IP configurations, then N-1 of these commands must exist. + +### Example 5: Associate/Dissociate a Network Security Group to a network interface +```powershell +$nic = Get-AzNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" +$nsg = Get-AzNetworkSecurityGroup -ResourceGroupName "ResourceGroup1" -Name "MyNSG" +$nic.NetworkSecurityGroup = $nsg +$nic | Set-AzNetworkInterface +``` + +The first command gets an existing network interface called NetworkInterface1 and stores it in the $nic variable. The second command gets an existing network security group called MyNSG and stores it in the $nsg variable. The third command assigns the $nsg to the $nic. Finally, the fourth command applies the changes to the Network interface. To dissociate network security groups from a network interface, simple replace $nsg in the third command with $null. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterface +Specifies a network interface object representing the state to which the network interface should be set. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterface +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkInterface](./Get-AzNetworkInterface.md) + +[Get-AzNetworkInterface](./Get-AzNetworkInterface.md) + +[New-AzNetworkInterface](./New-AzNetworkInterface.md) + +[Remove-AzNetworkInterface](./Remove-AzNetworkInterface.md) diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkInterfaceIpConfig.md b/azps-10.1.0/Az.Network/Set-AzNetworkInterfaceIpConfig.md new file mode 100644 index 0000000000..e5fcec6d13 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkInterfaceIpConfig.md @@ -0,0 +1,417 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 13EF1028-43DE-424D-8185-EC45B5CEF2C1 +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkinterfaceipconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkInterfaceIpConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkInterfaceIpConfig.md +--- + +# Set-AzNetworkInterfaceIpConfig + +## SYNOPSIS +Updates an IP configuration for a network interface. + +## SYNTAX + +### SetByResource (Default) +``` +Set-AzNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> + [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] [-Primary] [-Subnet <PSSubnet>] + [-PublicIpAddress <PSPublicIpAddress>] [-LoadBalancerBackendAddressPool <PSBackendAddressPool[]>] + [-LoadBalancerInboundNatRule <PSInboundNatRule[]>] + [-ApplicationGatewayBackendAddressPool <PSApplicationGatewayBackendAddressPool[]>] + [-ApplicationSecurityGroup <PSApplicationSecurityGroup[]>] [-GatewayLoadBalancerId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +Set-AzNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> + [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] [-Primary] [-SubnetId <String>] + [-PublicIpAddressId <String>] [-LoadBalancerBackendAddressPoolId <String[]>] + [-LoadBalancerInboundNatRuleId <String[]>] [-ApplicationGatewayBackendAddressPoolId <String[]>] + [-ApplicationSecurityGroupId <String[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkInterfaceIpConfig** cmdlet updates an IP configuration for a network interface. + +## EXAMPLES + +### 1: Changing the IP address of an IP configuration +```powershell +$vnet = Get-AzVirtualNetwork -Name myvnet -ResourceGroupName myrg +$subnet = Get-AzVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet + +$nic = Get-AzNetworkInterface -Name nic1 -ResourceGroupName myrg + +$nic | Set-AzNetworkInterfaceIpConfig -Name ipconfig1 -PrivateIpAddress 10.0.0.11 -Subnet $subnet -Primary + +$nic | Set-AzNetworkInterface +``` + +The first two commands get a virtual network called myvnet and a subnet called mysubnet and store it in the + variables $vnet and $subnet respectively. The third command gets the network interface nic1 associated with the IP + configuration that needs to be updated. The third command sets the private IP address of the primary IP + configuration ipconfig1 to 10.0.0.11. Finally, the last command updates the network interface ensuring the changes + have been made successfully. + + +### 2: Associating an IP configuration with an application security group +```powershell +$vnet = Get-AzVirtualNetwork -Name myvnet -ResourceGroupName myrg +$subnet = Get-AzVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet +$asg = Get-AzApplicationSecurityGroup -Name myasg -ResourceGroupName myrg + +$nic = Get-AzNetworkInterface -Name nic1 -ResourceGroupName myrg + +$nic | Set-AzNetworkInterfaceIpConfig -Name ipconfig1 -PrivateIpAddress 10.0.0.11 -Subnet $subnet -ApplicationSecurityGroup $asg -Primary + +$nic | Set-AzNetworkInterface +``` + +In this example, the variable $asg contains a reference to an application security group. + The fourth command gets the network interface nic1 associated with the IP + configuration that needs to be updated. The Set-AzNetworkInterfaceIpConfig sets the private IP address of the primary IP + configuration ipconfig1 to 10.0.0.11 and creates an association with the retrieved application security group. + Finally, the last command updates the network interface ensuring the changes + have been made successfully. + +### 3: Disassociating an IP configuration with an application gateway backend address pool +```powershell +$nic = Get-AzNetworkInterface -Name nic1 -ResourceGroupName myrg + +$nic | Set-AzNetworkInterfaceIpConfig -Name ipconfig1 -ApplicationGatewayBackendAddressPool $null + +$nic | Set-AzNetworkInterface +``` + +The Set-AzNetworkInterfaceIpConfig sets the application gateway backend address pool of the IP configuration ipconfig1 to null and disassociate with the network interface. Finally, the last command updates the network interface ensuring the changes have been made successfully. + +## PARAMETERS + +### -ApplicationGatewayBackendAddressPool +Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationGatewayBackendAddressPoolId +Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationSecurityGroup +Specifies a collection of application security group references to which this network interface IP configuration belongs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationSecurityGroupId +Specifies a collection of application security group references to which this network interface IP configuration belongs. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayLoadBalancerId +Specifies the ID of the Gateway Load Balancer Provider Frontend Ip Configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerBackendAddressPool +Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerBackendAddressPoolId +Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerInboundNatRule +Specifies a collection of load balancer inbound network address translation (NAT) rule references to which this network interface IP configuration belongs. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSInboundNatRule[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LoadBalancerInboundNatRuleId +Specifies a collection of load balancer inbound NAT rule references to which this network interface IP configuration belongs. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network IP configuration for which this cmdlet sets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterface +Specifies a **NetworkInterface** object. +This cmdlet adds a network interface IP configuration to the object that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterface +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Primary +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddress +Specifies the static IP address of the network interface IP configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIpAddressVersion +Specifies the IP address version of a network interface IP configuration. +The acceptable values for this parameter are: +- IPv4 +- IPv6 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: IPv4, IPv6 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddress +Specifies a **PublicIPAddress** object. +This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddressId +This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Specifies a **Subnet** object. +This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSubnet +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +### System.String[] + +### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool[] + +### Microsoft.Azure.Commands.Network.Models.PSInboundNatRule[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool[] + +### Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, network, networking + +## RELATED LINKS + +[Add-AzNetworkInterfaceIpConfig](./Add-AzNetworkInterfaceIpConfig.md) + +[Get-AzNetworkInterfaceIpConfig](./Get-AzNetworkInterfaceIpConfig.md) + +[New-AzNetworkInterfaceIpConfig](./New-AzNetworkInterfaceIpConfig.md) + +[Remove-AzNetworkInterfaceIpConfig](./Remove-AzNetworkInterfaceIpConfig.md) diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkInterfaceTapConfig.md b/azps-10.1.0/Az.Network/Set-AzNetworkInterfaceTapConfig.md new file mode 100644 index 0000000000..289da1081a --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkInterfaceTapConfig.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkinterfacetapconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkInterfaceTapConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkInterfaceTapConfig.md +--- + +# Set-AzNetworkInterfaceTapConfig + +## SYNOPSIS +Updates a tap configuration for a network interface. + +## SYNTAX + +``` +Set-AzNetworkInterfaceTapConfig -NetworkInterfaceTapConfig <PSNetworkInterfaceTapConfiguration> [-AsJob] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkInterfaceTapConfig** updates a tap configuration for a network interface. + +## EXAMPLES + +### Example 1: Set the TapConfiguration with updated TapConfig name +```powershell +$tapConfig = Get-AzNetworkInterfaceTapConfig -ResourceGroupName "ResourceGroup1" -NetworkInterfaceName "sourceNicName" -Name "tapconfigName" +$tapConfig.Name = "NewTapName" +Set-AzNetworkInterfaceTapConfig -NetworkInterfaceTapConfig $tapConfig +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterfaceTapConfig +The NetworkInterface Tap configuration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceTapConfiguration +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceTapConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface + +## NOTES + +## RELATED LINKS + +[Add-AzNetworkInterfaceTapConfig](./Add-AzNetworkInterfaceTapConfig.md) + +[Get-AzNetworkInterfaceTapConfig](./Get-AzNetworkInterfaceTapConfig.md) + +[Remove-AzNetworkInterfaceTapConfig](./Remove-AzNetworkInterfaceTapConfig.md) diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkManager.md b/azps-10.1.0/Az.Network/Set-AzNetworkManager.md new file mode 100644 index 0000000000..3470224b7d --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkManager.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkmanager +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManager.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManager.md +--- + +# Set-AzNetworkManager + +## SYNOPSIS +Updates a network manager.. + +## SYNTAX + +``` +Set-AzNetworkManager -InputObject <PSNetworkManager> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkManager** cmdlet updates a network manager. + +## EXAMPLES + +### Example 1 +```powershell +$networkManager = Get-AzNetworkManager -ResourceGroupName "psResourceGroup" -Name "psNetworkManager" +$networkManager.Description = "updated description" +Set-AzNetworkManager -InputObject $networkManager +``` + +```output +Location : westus +Tag : {} +NetworkManagerScopes : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopes +NetworkManagerScopeAccesses : {Connectivity, SecurityAdmin} +NetworkManagerScopeAccessesText : [ + "Connectivity", + "SecurityAdmin" + ] +NetworkManagerScopesText : { + "ManagementGroups": [ + "/providers/Microsoft.Management/managementGroups/PowerShellTest" + ], + "Subscriptions": [ + "/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884" + ] + } +TagsTable : +DisplayName : +Description : updated description +Type : Microsoft.Network/networkManagers +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T04:12:51.7463424Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-08T00:50:28.6707606Z" + } +Name : psNetworkManager +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager +``` + +Example to update the description of a network manager. + +### Example 2 +```powershell +$networkManager = Get-AzNetworkManager -ResourceGroupName "psResourceGroup" -Name "psNetworkManager" +$access = @("Connectivity", "SecurityAdmin") +$networkManager.NetworkManagerScopeAccesses = $access +Set-AzNetworkManager -InputObject $networkManager +``` + +```output +Location : westus +Tag : {} +NetworkManagerScopes : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopes +NetworkManagerScopeAccesses : {Connectivity, SecurityAdmin} +NetworkManagerScopeAccessesText : [ + "Connectivity", + "SecurityAdmin" + ] +NetworkManagerScopesText : { + "ManagementGroups": [ + "/providers/Microsoft.Management/managementGroups/PowerShellTest" + ], + "Subscriptions": [ + "/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884" + ] + } +TagsTable : +DisplayName : +Description : updated description +Type : Microsoft.Network/networkManagers +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T04:12:51.7463424Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-08T00:52:45.0100913Z" + } +Name : psNetworkManager +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager +``` + +Updates a network manager scope access. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Network Manager + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManager +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManager + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManager + +## NOTES + +## RELATED LINKS + +[New-AzNetworkManager](./New-AzNetworkManager.md) + +[Get-AzNetworkManager](./Get-AzNetworkManager.md) + +[Remove-AzNetworkManager](./Remove-AzNetworkManager.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkManagerConnectivityConfiguration.md b/azps-10.1.0/Az.Network/Set-AzNetworkManagerConnectivityConfiguration.md new file mode 100644 index 0000000000..514cf5fcf1 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkManagerConnectivityConfiguration.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkmanagerconnectivityconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerConnectivityConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerConnectivityConfiguration.md +--- + +# Set-AzNetworkManagerConnectivityConfiguration + +## SYNOPSIS +Updates a connectivity configuration. + +## SYNTAX + +``` +Set-AzNetworkManagerConnectivityConfiguration -InputObject <PSNetworkManagerConnectivityConfiguration> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkManagerConnectivityConfiguration** cmdlet updates a connectivity configuration. + +## EXAMPLES + +### Example 1 +```powershell +$ConnectivityConfiguration = Get-AzNetworkManagerConnectivityConfiguration -Name "psConnectivityConfig" -NetworkManagerName "psNetworkManager" -ResourceGroupName "psResourceGroup" +$connectivityGroupItem = New-AzNetworkManagerConnectivityGroupItem -NetworkGroupId "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup" +$connectivityGroupItem2 = New-AzNetworkManagerConnectivityGroupItem -NetworkGroupId "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup2" +[System.Collections.Generic.List[Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnectivityGroupItem]]$connectivityGroup = @() +$connectivityGroup.Add($connectivityGroupItem) +$connectivityGroup.Add($connectivityGroupItem2) +$ConnectivityConfiguration.AppliesToGroups = $connectivityGroup +Set-AzNetworkManagerConnectivityConfiguration -InputObject $ConnectivityConfiguration +``` + +```output +ConnectivityTopology : HubAndSpoke +Hubs : {/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884/resourceGroups/jaredgorthy-PowerShellTestResources/providers/Microsoft.Network/virtualNetworks/powerShellTestVnetHub} +DeleteExistingPeering : True +IsGlobal : False +AppliesToGroups : {/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup, + /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup2} +AppliesToGroupsText : [ + { + "NetworkGroupId": + "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup", + "UseHubGateway": "False", + "IsGlobal": "False", + "GroupConnectivity": "None" + }, + { + "NetworkGroupId": + "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup2", + "UseHubGateway": "False", + "IsGlobal": "False", + "GroupConnectivity": "None" + } + ] +HubsText : [ + { + "ResourceId": "/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884/resourceGroups/jaredgorthy-PowerShellTestResources/providers/Microsoft.Network/virtualNetworks/powerShellTestVnetHub", + "ResourceType": "Microsoft.Network/virtualNetworks" + } + ] +DisplayName : +Description : +Type : Microsoft.Network/networkManagers/connectivityConfigurations +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T04:37:43.1186543Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-08T00:58:41.1751638Z" + } +Name : psConnectivityConfig +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/connectivityConfigurations/psConnectivityConfig +``` + +Updates a connectivity configuration's group members. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The NetworkManagerConnectivityConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnectivityConfiguration +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnectivityConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnectivityConfiguration + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerConnectivityConfiguration](./Get-AzNetworkManagerConnectivityConfiguration.md) + +[New-AzNetworkManagerConnectivityConfiguration](./New-AzNetworkManagerConnectivityConfiguration.md) + +[Remove-AzNetworkManagerConnectivityConfiguration](./Remove-AzNetworkManagerConnectivityConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkManagerGroup.md b/azps-10.1.0/Az.Network/Set-AzNetworkManagerGroup.md new file mode 100644 index 0000000000..7a4cfd5211 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkManagerGroup.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkmanagergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerGroup.md +--- + +# Set-AzNetworkManagerGroup + +## SYNOPSIS +Updates a network manager group. + +## SYNTAX + +``` +Set-AzNetworkManagerGroup -InputObject <PSNetworkManagerGroup> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkManagerGroup** cmdlet updates a network manager group. + +## EXAMPLES + +### Example 1 +```powershell +$networkGroup = Get-AzNetworkManagerGroup -Name "psNetworkGroup" -NetworkManagerName psNetworkManager -ResourceGroupName psResourceGroup +$networkGroup.description = "new description" +Set-AzNetworkManagerGroup -InputObject $networkGroup +``` + +```output +MemberType : +DisplayName : +Description : new description +Type : Microsoft.Network/networkManagers/networkGroups +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T04:32:21.6585296Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-07T05:12:06.8159045Z" + } +Name : psNetworkGroup +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup +``` + +Updates a network manager group decription. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Network Group + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerGroup +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerGroup + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerGroup](./Get-AzNetworkManagerGroup.md) + +[New-AzNetworkManagerGroup](./New-AzNetworkManagerGroup.md) + +[Remove-AzNetworkManagerGroup](./Remove-AzNetworkManagerGroup.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkManagerManagementGroupConnection.md b/azps-10.1.0/Az.Network/Set-AzNetworkManagerManagementGroupConnection.md new file mode 100644 index 0000000000..9b3341fc8d --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkManagerManagementGroupConnection.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkmanagermanagementgroupconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerManagementGroupConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerManagementGroupConnection.md +--- + +# Set-AzNetworkManagerManagementGroupConnection + +## SYNOPSIS +Update a network manger management group connection + +## SYNTAX + +``` +Set-AzNetworkManagerManagementGroupConnection -InputObject <PSNetworkManagerConnection> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkManagerManagementGroupConnection** cmdlet update a network manger management group connection. + +## EXAMPLES + +### Example 1 +```powershell +$networkManagerConnection = Get-AzNetworkManagerManagementGroupConnection -ManagementGroupId "newMG" -Name "psConnection" +$networkManagerConnection.description = "new description" +Set-AzNetworkManagerManagementGroupConnection -InputObject $networkManagerConnection +``` + +```output +NetworkManagerId : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager +ConnectionState : Pending +DisplayName : +Description : new description +Type : Microsoft.Network/networkManagerConnections +ProvisioningState : +SystemData : +SystemDataText : null +Name : psConnection +Etag : +Id : /providers/Microsoft.Management/managementGroups/newMG/providers/Microsoft.Network/networkManagerConnections/psConnection +``` + +Updates a network manger management group connection. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The NetworkManagerSubscriptionConnection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnection +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnection + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnection + +## NOTES + +## RELATED LINKS + +[Remove-AzNetworkManagerManagementGroupConnection](./Remove-AzNetworkManagerManagementGroupConnection.md) + +[Get-AzNetworkManagerManagementGroupConnection](./Get-AzNetworkManagerManagementGroupConnection.md) + +[New-AzNetworkManagerManagementGroupConnection](./New-AzNetworkManagerManagementGroupConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkManagerScopeConnection.md b/azps-10.1.0/Az.Network/Set-AzNetworkManagerScopeConnection.md new file mode 100644 index 0000000000..3a3b34105e --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkManagerScopeConnection.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkmanagerscopeconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerScopeConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerScopeConnection.md +--- + +# Set-AzNetworkManagerScopeConnection + +## SYNOPSIS +Update a network manager scope connection. + +## SYNTAX + +``` +Set-AzNetworkManagerScopeConnection -InputObject <PSNetworkManagerScopeConnection> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkManagerScopeConnection** cmdlet updates a network manager scope connection. + +## EXAMPLES + +### Example 1 +```powershell +$scopeConnection = Get-AzNetworkManagerScopeConnection -ResourceGroupName "psResourceGroup" -NetworkManagerName "psNetworkManager" -Name "mgConnection" +$scopeConnection.description = "new description" +Set-AzNetworkManagerScopeConnection -InputObject $scopeConnection +``` + +```output +TenantId : 72f988bf-86f1-41af-91ab-2d7cd011db47 +ResourceId : /providers/Microsoft.Management/managementGroups/newMG +ConnectionState : Pending +DisplayName : +Description : new description +Type : Microsoft.Network/networkManagers/scopeConnections +ProvisioningState : +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-08T00:08:30.7250851Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-08T00:08:30.7250851Z" + } +Name : mgConnection +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/scopeConnections/mgConnection +``` + +Updates a scope connection description. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The NetworkManagerScopeConnection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopeConnection +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopeConnection + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopeConnection + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerScopeConnection](./Get-AzNetworkManagerScopeConnection.md) + +[New-AzNetworkManagerScopeConnection](./New-AzNetworkManagerScopeConnection.md) + +[Remove-AzNetworkManagerScopeConnection](./Remove-AzNetworkManagerScopeConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkManagerSecurityAdminConfiguration.md b/azps-10.1.0/Az.Network/Set-AzNetworkManagerSecurityAdminConfiguration.md new file mode 100644 index 0000000000..90d0c0476a --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkManagerSecurityAdminConfiguration.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkmanagersecurityadminconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerSecurityAdminConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerSecurityAdminConfiguration.md +--- + +# Set-AzNetworkManagerSecurityAdminConfiguration + +## SYNOPSIS +Updates a network manager security admin configuration. + +## SYNTAX + +``` +Set-AzNetworkManagerSecurityAdminConfiguration -InputObject <PSNetworkManagerSecurityAdminConfiguration> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkManagerSecurityAdminConfiguration** cmdlet updates a network manager security admin configuration. + +## EXAMPLES + +### Example 1 +```powershell +$NetworkManagerSecurityConfiguration = Get-AzNetworkManagerSecurityAdminConfiguration -Name "psSecurityAdminConfig" -NetworkManagerName "psNetworkManager" -ResourceGroupName "psResourceGroup" +$NetworkManagerSecurityConfiguration.applyOnNetworkIntentPolicyBasedServices = @("None") +Set-AzNetworkManagerSecurityAdminConfiguration -InputObject $NetworkManagerSecurityConfiguration +``` + +```output +SecurityType : +ApplyOnNetworkIntentPolicyBasedServices : {None} +ApplyOnNetworkIntentPolicyBasedServicesText : [ + "None" + ] +DeleteExistingNSGs : +DisplayName : +Description : TestDescription +Type : Microsoft.Network/networkManagers/securityAdminConfigurations +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-07T23:58:54.8549506Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-08T01:14:53.4574151Z" + } +Name : psSecurityAdminConfig +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/securityAdminConfigurations/psSecurityAdminConfig +``` + +Updates a network manager security admin configuration apply on network intent policy based services property. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The NetworkManagerSecurityAdminConfiguration + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityAdminConfiguration +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityAdminConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityAdminConfiguration + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerSecurityAdminConfiguration](./Get-AzNetworkManagerSecurityAdminConfiguration.md) + +[New-AzNetworkManagerSecurityAdminConfiguration](./New-AzNetworkManagerSecurityAdminConfiguration.md) + +[Remove-AzNetworkManagerSecurityAdminConfiguration](./Remove-AzNetworkManagerSecurityAdminConfiguration.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkManagerSecurityAdminRule.md b/azps-10.1.0/Az.Network/Set-AzNetworkManagerSecurityAdminRule.md new file mode 100644 index 0000000000..7e0fbea7de --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkManagerSecurityAdminRule.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkmanagersecurityadminrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerSecurityAdminRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerSecurityAdminRule.md +--- + +# Set-AzNetworkManagerSecurityAdminRule + +## SYNOPSIS +Updates a network manager security admin rule. + +## SYNTAX + +``` +Set-AzNetworkManagerSecurityAdminRule -InputObject <PSNetworkManagerSecurityBaseAdminRule> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkManagerSecurityAdminRule** cmdlet updates a network manager security admin rule. + +## EXAMPLES + +### Example 1 +```powershell +$SecurityAdminRule = Get-AzNetworkManagerSecurityAdminRule -Name "psRule" -RuleCollectionName "psRuleCollection" -SecurityAdminConfigurationName "psSecurityAdminConfig" -NetworkManagerName "psNetworkManager" -ResourceGroupName "psResourceGroup" +$SecurityAdminRule.priority = 50 +Set-AzNetworkManagerSecurityAdminRule -InputObject $SecurityAdminRule +``` + +```output +Protocol : Tcp +Direction : Inbound +Sources : {Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerAddressPrefixItem} +Destinations : {Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerAddressPrefixItem} +SourcePortRanges : {100} +DestinationPortRanges : {99} +Access : Allow +Priority : 50 +SourcesText : [ + { + "AddressPrefix": "Internet", + "AddressPrefixType": "ServiceTag" + } + ] +DestinationsText : [ + { + "AddressPrefix": "10.0.0.1", + "AddressPrefixType": "IPPrefix" + } + ] +SourcePortRangesText : [ + "100" + ] +DestinationPortRangesText : [ + "99" + ] +DisplayName : +Description : TestDescription +Type : Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-08T00:39:56.4512419Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-08T01:23:18.6454664Z" + } +Name : psRule +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/securityAdminConfigurations/psSecurityAdminConfig/ruleCollections/psRuleCollection/rules/psRule +``` + +Updates a network manager security admin rule's priority'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Network Manager Security Admin Rule + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityBaseAdminRule +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityBaseAdminRule + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityBaseAdminRule + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerSecurityAdminRule](./Get-AzNetworkManagerSecurityAdminRule.md) + +[New-AzNetworkManagerSecurityAdminRule](./New-AzNetworkManagerSecurityAdminRule.md) + +[Remove-AzNetworkManagerSecurityAdminRule](./Remove-AzNetworkManagerSecurityAdminRule.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkManagerSecurityAdminRuleCollection.md b/azps-10.1.0/Az.Network/Set-AzNetworkManagerSecurityAdminRuleCollection.md new file mode 100644 index 0000000000..3d0705bbc6 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkManagerSecurityAdminRuleCollection.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkmanagersecurityadminrulecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerSecurityAdminRuleCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerSecurityAdminRuleCollection.md +--- + +# Set-AzNetworkManagerSecurityAdminRuleCollection + +## SYNOPSIS +Updates a network manager security admin rule collection. + +## SYNTAX + +``` +Set-AzNetworkManagerSecurityAdminRuleCollection -InputObject <PSNetworkManagerSecurityAdminRuleCollection> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkManagerSecurityAdminRuleCollection** cmdlet updates a network manager security admin rule collection. + +## EXAMPLES + +### Example 1 +```powershell +$NetworkManagerSecurityAdminRuleCollection = Get-AzNetworkManagerSecurityAdminRuleCollection -SecurityAdminConfigurationName "psSecurityAdminConfig" -Name "psRuleCollection" -NetworkManagerName "psNetworkManager" -ResourceGroupName "psResourceGroup" +$groupItem = New-AzNetworkManagerSecurityGroupItem -NetworkGroupId "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup" +$groupItem2 = New-AzNetworkManagerSecurityGroupItem -NetworkGroupId "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup2" +[System.Collections.Generic.List[Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityGroupItem]]$configGroup = @() +$configGroup.Add($groupItem) +$configGroup.Add($groupItem2) +$NetworkManagerSecurityAdminRuleCollection.AppliesToGroups = $configGroup +Set-AzNetworkManagerSecurityAdminRuleCollection -InputObject $NetworkManagerSecurityAdminRuleCollection +``` + +```output +AppliesToGroups : {/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup, + /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup2} +AppliesToGroupsText : [ + { + "NetworkGroupId": + "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup" + }, + { + "NetworkGroupId": + "/subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/networkGroups/psNetworkGroup2" + } + ] +DisplayName : +Description : +Type : Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections +ProvisioningState : Succeeded +SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData +SystemDataText : { + "CreatedBy": "jaredgorthy@microsoft.com", + "CreatedByType": "User", + "CreatedAt": "2022-08-08T00:34:32.030751Z", + "LastModifiedBy": "jaredgorthy@microsoft.com", + "LastModifiedByType": "User", + "LastModifiedAt": "2022-08-08T01:19:40.2407843Z" + } +Name : psRuleCollection +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/securityAdminConfigurations/psSecurityAdminConfig/ruleCollections/psRuleCollection +``` + +Updates a network manager security admin rule collection to include new network groups. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The NetworkManagerSecurityAdminRuleCollection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityAdminRuleCollection +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityAdminRuleCollection + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerSecurityAdminRuleCollection + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkManagerSecurityAdminRuleCollection](./Get-AzNetworkManagerSecurityAdminRuleCollection.md) + +[New-AzNetworkManagerSecurityAdminRuleCollection](./New-AzNetworkManagerSecurityAdminRuleCollection.md) + +[Remove-AzNetworkManagerSecurityAdminRuleCollection](./Remove-AzNetworkManagerSecurityAdminRuleCollection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkManagerSubscriptionConnection.md b/azps-10.1.0/Az.Network/Set-AzNetworkManagerSubscriptionConnection.md new file mode 100644 index 0000000000..49edc0d51b --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkManagerSubscriptionConnection.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkmanagersubscriptionconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerSubscriptionConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkManagerSubscriptionConnection.md +--- + +# Set-AzNetworkManagerSubscriptionConnection + +## SYNOPSIS +Update a network manager subscription connection. + +## SYNTAX + +``` +Set-AzNetworkManagerSubscriptionConnection -InputObject <PSNetworkManagerConnection> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkManagerSubscriptionConnection** cmdlet update a network manager subscription connection. + +## EXAMPLES + +### Example 1 +```powershell +$networkManagerConnection = Get-AzNetworkManagerSubscriptionConnection -Name "subConnection" +$networkManagerConnection.description = " new description" +Set-AzNetworkManagerSubscriptionConnection -InputObject $networkManagerConnection +``` + +```output +NetworkManagerId : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager +ConnectionState : Conflict +DisplayName : +Description : new description +Type : Microsoft.Network/networkManagerConnections +ProvisioningState : +SystemData : +SystemDataText : null +Name : subConnection +Etag : +Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/providers/Microsoft.Network/networkManagerConnections/subConnection +``` + +Updates a network manager subscription connection description. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The NetworkManagerSubscriptionConnection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnection +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnection + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerConnection + +## NOTES + +## RELATED LINKS + +[Remove-AzNetworkManagerManagementGroupConnection](./Remove-AzNetworkManagerManagementGroupConnection.md) + +[Get-AzNetworkManagerManagementGroupConnection](./Get-AzNetworkManagerManagementGroupConnection.md) + +[New-AzNetworkManagerManagementGroupConnection](./New-AzNetworkManagerManagementGroupConnection.md) diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkProfile.md b/azps-10.1.0/Az.Network/Set-AzNetworkProfile.md new file mode 100644 index 0000000000..01eae2f086 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkProfile.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkProfile.md +--- + +# Set-AzNetworkProfile + +## SYNOPSIS +Updates a network profile. + +## SYNTAX + +``` +Set-AzNetworkProfile -NetworkProfile <PSNetworkProfile> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPublicIpPrefix** cmdlet updates a network profile. + +## EXAMPLES + +### Example 1 +```powershell +$networkProfile = Get-AzNetworkProfile -Name np1 -ResourceGroupName rg1 + +$networkProfile.Tags = "TestTag" + +$networkProfile.ContainerNetworkInterfaceConfigurations = New-AzContainerNicConfig -Name cnicconfig1 + +$networkProfile | Set-AzNetworkProfile +``` + +The first command gets an existing network profile. The second command updates a tag and the third adds a network interface configuration on the network profile. The fourth command updates the network profile. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfile +The network profile + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkProfile + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkProfile](./Get-AzNetworkProfile.md) + +[New-AzNetworkProfile](./New-AzNetworkProfile.md) + +[Remove-AzNetworkProfile](./Remove-AzNetworkProfile.md) diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkSecurityGroup.md b/azps-10.1.0/Az.Network/Set-AzNetworkSecurityGroup.md new file mode 100644 index 0000000000..647b19f0e8 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkSecurityGroup.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 9F69DAEF-F2ED-449B-B75F-FCA7ED73D98F +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworksecuritygroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkSecurityGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkSecurityGroup.md +--- + +# Set-AzNetworkSecurityGroup + +## SYNOPSIS +Updates a network security group. + +## SYNTAX + +``` +Set-AzNetworkSecurityGroup -NetworkSecurityGroup <PSNetworkSecurityGroup> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkSecurityGroup** cmdlet updates a network security group. + +## EXAMPLES + +### Example 1: Update an existing network security group +```powershell +Get-AzNetworkSecurityGroup -Name "Nsg1" -ResourceGroupName "Rg1" | Add-AzNetworkSecurityRuleConfig -Name "Rdp-Rule" -Description "Allow RDP" -Access "Allow" -Protocol "Tcp" -Direction "Inbound" -Priority 100 -SourceAddressPrefix "Internet" -SourcePortRange "*" -DestinationAddressPrefix "*" -DestinationPortRange "3389" | Set-AzNetworkSecurityGroup +``` + +This command gets the Azure network security group named Nsg1, and adds a network security rule named Rdp-Rule to allow Internet traffic on port 3389 to the retrieved network security group object using Add-AzNetworkSecurityRuleConfig. +The command persists the modified Azure network security group using **Set-AzNetworkSecurityGroup**. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSecurityGroup +Specifies a network security group object representing the state to which the network security group should be set. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +## NOTES + +## RELATED LINKS + +[Get-AzNetworkSecurityGroup](./Get-AzNetworkSecurityGroup.md) + +[New-AzNetworkSecurityGroup](./New-AzNetworkSecurityGroup.md) + +[Remove-AzNetworkSecurityGroup](./Remove-AzNetworkSecurityGroup.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkSecurityRuleConfig.md b/azps-10.1.0/Az.Network/Set-AzNetworkSecurityRuleConfig.md new file mode 100644 index 0000000000..c06afcebca --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkSecurityRuleConfig.md @@ -0,0 +1,385 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 7EFFFF43-501E-4955-A4EE-2C09B8863B30 +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworksecurityruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkSecurityRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkSecurityRuleConfig.md +--- + +# Set-AzNetworkSecurityRuleConfig + +## SYNOPSIS +Updates a network security rule configuration for a network security group. + +## SYNTAX + +### SetByResource (Default) +``` +Set-AzNetworkSecurityRuleConfig -Name <String> -NetworkSecurityGroup <PSNetworkSecurityGroup> + [-Description <String>] [-Protocol <String>] [-SourcePortRange <String[]>] [-DestinationPortRange <String[]>] + [-SourceAddressPrefix <String[]>] [-DestinationAddressPrefix <String[]>] + [-SourceApplicationSecurityGroup <PSApplicationSecurityGroup[]>] + [-DestinationApplicationSecurityGroup <PSApplicationSecurityGroup[]>] [-Access <String>] [-Priority <Int32>] + [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +Set-AzNetworkSecurityRuleConfig -Name <String> -NetworkSecurityGroup <PSNetworkSecurityGroup> + [-Description <String>] [-Protocol <String>] [-SourcePortRange <String[]>] [-DestinationPortRange <String[]>] + [-SourceAddressPrefix <String[]>] [-DestinationAddressPrefix <String[]>] + [-SourceApplicationSecurityGroupId <String[]>] [-DestinationApplicationSecurityGroupId <String[]>] + [-Access <String>] [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNetworkSecurityRuleConfig** cmdlet updates a network security rule configuration for a network security group. + +## EXAMPLES + +### Example 1: Change the access configuration in a network security rule +```powershell +$nsg = Get-AzNetworkSecurityGroup -Name "NSG-FrontEnd" -ResourceGroupName "TestRG" +$nsg | Get-AzNetworkSecurityRuleConfig -Name "rdp-rule" +Set-AzNetworkSecurityRuleConfig -Name "rdp-rule" -NetworkSecurityGroup $nsg -Access "Deny" +``` + +The first command gets the network security group named NSG-FrontEnd, and then stores it in the variable $nsg. +The second command uses the pipeline operator to pass the security group in $nsg to Get-AzNetworkSecurityRuleConfig, which gets the security rule configuration named rdp-rule. +The third command changes the access configuration of rdp-rule to Deny. However, this overwrites the rule and only sets the parameters that are passed to the Set-AzNetworkSecurityRuleConfig function. NOTE: There is no way to change a single attribute + +### Example 2 + +Updates a network security rule configuration for a network security group. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzNetworkSecurityRuleConfig -Access Allow -DestinationAddressPrefix * -DestinationPortRange 3389 -Direction Inbound -Name 'rdp-rule' -NetworkSecurityGroup <PSNetworkSecurityGroup> -Priority 1 -Protocol Tcp -SourceAddressPrefix 'Internet' -SourcePortRange * +``` + +### Example 3 + +Updates a network security rule configuration for a network security group. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzNetworkSecurityRuleConfig -Access Allow -Description 'Allow RDP' -DestinationAddressPrefix * -DestinationPortRange 3389 -Direction Inbound -Name 'rdp-rule' -NetworkSecurityGroup <PSNetworkSecurityGroup> -Priority 1 -Protocol Tcp -SourceAddressPrefix 'Internet' -SourcePortRange * +``` + +### Example 4 + +Updates a network security rule configuration for a network security group (Source IP address) + +```powershell +$nsg = Get-AzNetworkSecurityGroup -ResourceGroupName "MyResource" -Name "MyNsg" +($nsg.SecurityRules | Where-Object {$_.Name -eq "RuleName"}).SourceAddressPrefix = ([System.String[]] @("xxx.xxx.xxx.xxx")) +$nsg | Set-AzNetworkSecurityGroup | Get-AzNetworkSecurityRuleConfig -Name "RuleName" +``` + +## PARAMETERS + +### -Access +Specifies whether network traffic is allowed or denied. +The acceptable values for this parameter are: Allow and Deny. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for a rule configuration. +The maximum size is 140 characters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationAddressPrefix +Specifies a destination address prefix. +The acceptable values for this parameter are: +- A Classless Interdomain Routing (CIDR) address +- A destination IP address range +- A wildcard character (*) to match any IP address. +You can use tags such as VirtualNetwork, AzureLoadBalancer, and Internet. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationApplicationSecurityGroup +The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationApplicationSecurityGroupId +The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPortRange +Specifies a destination port or range. +The acceptable values for this parameter are: +- An integer +- A range of integers between 0 and 65535 +- A wildcard character (*) to match any port + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Specifies whether a rule is evaluated for incoming or outgoing traffic. +The acceptable values for this parameter are: Inbound and Outbound. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Inbound, Outbound + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the network security rule configuration that this cmdlet sets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSecurityGroup +Specifies the **NetworkSecurityGroup** object that contains the network security rule configuration to set. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Priority +Specifies the priority of a rule configuration. +The acceptable values for this parameter are:An integer between 100 and 4096. +The priority number must be unique for each rule in the collection. +The lower the priority number, the higher the priority of the rule. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the network protocol that a rule configuration applies to. +The acceptable values for this parameter are: +- Tcp +- Udp +- Icmp +- Esp +- Ah +- Wildcard character (*) to match all + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Tcp, Udp, Icmp, Esp, Ah, * + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceAddressPrefix +Specifies a source address prefix. +The acceptable values for this parameter are: +- A CIDR +- A source IP range +- A wildcard character (*) to match any IP address. +You can also use tags such as VirtualNetwork, AzureLoadBalancer and Internet. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceApplicationSecurityGroup +The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[] +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceApplicationSecurityGroupId +The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. + +```yaml +Type: System.String[] +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourcePortRange +Specifies the source port or range. +The acceptable values for this parameter are: +- An integer +- A range of integers between 0 and 65535 +- A wildcard character (*) to match any port + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +## NOTES + +## RELATED LINKS + +[Add-AzNetworkSecurityRuleConfig](./Add-AzNetworkSecurityRuleConfig.md) + +[Get-AzNetworkSecurityRuleConfig](./Get-AzNetworkSecurityRuleConfig.md) + +[New-AzNetworkSecurityRuleConfig](./New-AzNetworkSecurityRuleConfig.md) + +[Remove-AzNetworkSecurityRuleConfig](./Remove-AzNetworkSecurityRuleConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkWatcherConfigFlowLog.md b/azps-10.1.0/Az.Network/Set-AzNetworkWatcherConfigFlowLog.md new file mode 100644 index 0000000000..376196465c --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkWatcherConfigFlowLog.md @@ -0,0 +1,636 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkwatcherconfigflowlog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkWatcherConfigFlowLog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkWatcherConfigFlowLog.md +--- + +# Set-AzNetworkWatcherConfigFlowLog + +## SYNOPSIS +Configures flow logging for a target resource. + +## SYNTAX + +### SetFlowlogByResourceWithoutTA (Default) +``` +Set-AzNetworkWatcherConfigFlowLog -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> + -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] + [-FormatType <String>] [-FormatVersion <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetFlowlogByResourceWithTAByResource +``` +Set-AzNetworkWatcherConfigFlowLog -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> + -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] + [-FormatType <String>] [-FormatVersion <Int32>] [-AsJob] [-EnableTrafficAnalytics] + -Workspace <IOperationalInsightWorkspace> [-TrafficAnalyticsInterval <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetFlowlogByResourceWithTAByDetails +``` +Set-AzNetworkWatcherConfigFlowLog -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> + -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] + [-FormatType <String>] [-FormatVersion <Int32>] [-AsJob] [-EnableTrafficAnalytics] + -WorkspaceResourceId <String> -WorkspaceGUID <String> -WorkspaceLocation <String> + [-TrafficAnalyticsInterval <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetFlowlogByNameWithTAByResource +``` +Set-AzNetworkWatcherConfigFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> + -TargetResourceId <String> -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] + [-RetentionInDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>] [-AsJob] [-EnableTrafficAnalytics] + -Workspace <IOperationalInsightWorkspace> [-TrafficAnalyticsInterval <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetFlowlogByNameWithTAByDetails +``` +Set-AzNetworkWatcherConfigFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> + -TargetResourceId <String> -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] + [-RetentionInDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>] [-AsJob] [-EnableTrafficAnalytics] + -WorkspaceResourceId <String> -WorkspaceGUID <String> -WorkspaceLocation <String> + [-TrafficAnalyticsInterval <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetFlowlogByNameWithoutTA +``` +Set-AzNetworkWatcherConfigFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> + -TargetResourceId <String> -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] + [-RetentionInDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetFlowlogByLocationWithTAByResource +``` +Set-AzNetworkWatcherConfigFlowLog -Location <String> -TargetResourceId <String> -EnableFlowLog <Boolean> + -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] [-FormatType <String>] + [-FormatVersion <Int32>] [-AsJob] [-EnableTrafficAnalytics] -Workspace <IOperationalInsightWorkspace> + [-TrafficAnalyticsInterval <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetFlowlogByLocationWithTAByDetails +``` +Set-AzNetworkWatcherConfigFlowLog -Location <String> -TargetResourceId <String> -EnableFlowLog <Boolean> + -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] [-FormatType <String>] + [-FormatVersion <Int32>] [-AsJob] [-EnableTrafficAnalytics] -WorkspaceResourceId <String> + -WorkspaceGUID <String> -WorkspaceLocation <String> [-TrafficAnalyticsInterval <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetFlowlogByLocationWithoutTA +``` +Set-AzNetworkWatcherConfigFlowLog -Location <String> -TargetResourceId <String> -EnableFlowLog <Boolean> + -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] [-FormatType <String>] + [-FormatVersion <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzNetworkWatcherConfigFlowLog configures flow logging for a target resource. +Properties to configure include: whether or not flow logging is enabled for the resource provided, the configured storage account to send logs, the flow logging format, and the retention policy for the logs. +Currently Network Security Groups are supported for flow logging. + +## EXAMPLES + +### Example 1: Configure Flow Logging for a Specified NSG +```powershell +$NW = Get-AzNetworkWatcher -ResourceGroupName NetworkWatcherRg -Name NetworkWatcher_westcentralus +$nsg = Get-AzNetworkSecurityGroup -ResourceGroupName NSGRG -Name appNSG +$storageId = "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123" + + +Set-AzNetworkWatcherConfigFlowLog -NetworkWatcher $NW -TargetResourceId $nsg.Id -EnableFlowLog $true -StorageAccountId $storageID +``` + +```output +TargetResourceId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Network/networkSecurityGroups/appNSG +StorageId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123 +Enabled : True +RetentionPolicy : { + "Days": 0, + "Enabled": false + } +Format : { + "Type ": "Json", + "Version": 1 + } +``` + +In this example we configure flow logging status for a Network Security Group. In the response, we see the specified NSG has flow logging enabled, default format, and no retention policy set. + +### Example 2: Configure Flow Logging for a Specified NSG and set the version of flow logging to 2. +```powershell +$NW = Get-AzNetworkWatcher -ResourceGroupName NetworkWatcherRg -Name NetworkWatcher_westcentralus +$nsg = Get-AzNetworkSecurityGroup -ResourceGroupName NSGRG -Name appNSG +$storageId = "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123" + + +Set-AzNetworkWatcherConfigFlowLog -NetworkWatcher $NW -TargetResourceId $nsg.Id -EnableFlowLog $true -StorageAccountId $storageID -FormatVersion 2 +``` + +```output +TargetResourceId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Network/networkSecurityGroups/appNSG +StorageId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123 +Enabled : True +RetentionPolicy : { + "Days": 0, + "Enabled": false + } +Format : { + "Type ": "Json", + "Version": 2 + } +``` + +In this example, we configure flow logging on a Network Security Group (NSG) with version 2 logs specified. In the response, we see the specified NSG has flow logging enabled, the format is set, and there is no retention policy configured. If the region does not support version you specified, Network Watcher will write the default supported version in the region. + +### Example 3: Configure Flow Logging and Traffic Analytics for a Specified NSG +```powershell +$NW = Get-AzNetworkWatcher -ResourceGroupName NetworkWatcherRg -Name NetworkWatcher_westcentralus +$nsg = Get-AzNetworkSecurityGroup -ResourceGroupName NSGRG -Name appNSG +$storageId = "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123" +$workspace = Get-AzOperationalInsightsWorkspace -Name WorkspaceName -ResourceGroupName WorkspaceRg + + +Set-AzNetworkWatcherConfigFlowLog -NetworkWatcher $NW -TargetResourceId $nsg.Id -EnableFlowLog $true -StorageAccountId $storageID -EnableTrafficAnalytics -Workspace $workspace -TrafficAnalyticsInterval 60 +``` + +```output +TargetResourceId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Network/networkSecurityGroups/appNSG +StorageId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123 +Enabled : True +RetentionPolicy : { + "Days": 0, + "Enabled": false + } +Format : { + "Type ": "Json", + "Version": 1 + } +FlowAnalyticsConfiguration : { + "networkWatcherFlowAnalyticsConfiguration": { + "enabled": true, + "workspaceId": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", + "workspaceRegion": "WorkspaceLocation", + "workspaceResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourcegroups/WorkspaceRg/providers/microsoft.operationalinsights/workspaces/WorkspaceName", + "TrafficAnalyticsInterval": 60 + } + } +``` + +In this example we configure flow logging status and Traffic Analytics for a Network Security Group. In the response, we see the specified NSG has flow logging and Traffic Analytics enabled, default format, and no retention policy set. + +### Example 4: Disable Traffic Analytics for a Specified NSG with Flow Logging and Traffic Analytics configured +```powershell +$NW = Get-AzNetworkWatcher -ResourceGroupName NetworkWatcherRg -Name NetworkWatcher_westcentralus +$nsg = Get-AzNetworkSecurityGroup -ResourceGroupName NSGRG -Name appNSG +$storageId = "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123" +$workspace = Get-AzOperationalInsightsWorkspace -Name WorkspaceName -ResourceGroupName WorkspaceRg +Set-AzNetworkWatcherConfigFlowLog -NetworkWatcher $NW -TargetResourceId $nsg.Id -EnableFlowLog $true -StorageAccountId $storageID -EnableTrafficAnalytics -Workspace $workspace -TrafficAnalyticsInterval 60 + + +Set-AzNetworkWatcherConfigFlowLog -NetworkWatcher $NW -TargetResourceId $nsg.Id -EnableFlowLog $true -StorageAccountId $storageID -EnableTrafficAnalytics:$false -Workspace $workspace +``` + +```output +TargetResourceId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Network/networkSecurityGroups/appNSG +StorageId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123 +Enabled : True +RetentionPolicy : { + "Days": 0, + "Enabled": false + } +Format : { + "Type ": "Json", + "Version": 1 + } +FlowAnalyticsConfiguration : { + "networkWatcherFlowAnalyticsConfiguration": { + "enabled": false, + "workspaceId": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", + "workspaceRegion": "WorkspaceLocation", + "workspaceResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourcegroups/WorkspaceRg/providers/microsoft.operationalinsights/workspaces/WorkspaceName", + "TrafficAnalyticsInterval": 60 + } + } +``` + +In this example we disable Traffic Analytics for a Network Security Group which has flow logging and Traffic Analytics configured earlier. In the response, we see the specified NSG has flow logging enabled but Traffic Analytics disabled. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFlowLog +Flag to enable/disable flow logging. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableRetention +Flag to enable/disable retention. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnableTrafficAnalytics +Flag to enable/disable retention. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetFlowlogByResourceWithTAByResource, SetFlowlogByResourceWithTAByDetails, SetFlowlogByNameWithTAByResource, SetFlowlogByNameWithTAByDetails, SetFlowlogByLocationWithTAByResource, SetFlowlogByLocationWithTAByDetails +Aliases: EnableTA + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FormatType +Type of flow log format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FormatVersion +Version of flow log format. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetFlowlogByLocationWithTAByResource, SetFlowlogByLocationWithTAByDetails, SetFlowlogByLocationWithoutTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetFlowlogByResourceWithoutTA, SetFlowlogByResourceWithTAByResource, SetFlowlogByResourceWithTAByDetails +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetFlowlogByNameWithTAByResource, SetFlowlogByNameWithTAByDetails, SetFlowlogByNameWithoutTA +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetFlowlogByNameWithTAByResource, SetFlowlogByNameWithTAByDetails, SetFlowlogByNameWithoutTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionInDays +Number of days to retain flow log records. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountId +ID of the storage account which is used to store the flow log. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceId +The target resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TrafficAnalyticsInterval +Gets or sets the interval (in minutes) which would decide how frequently TA service should do flow analytics. Supported values are 10 and 60 minutes. + +```yaml +Type: System.Int32 +Parameter Sets: SetFlowlogByResourceWithTAByResource, SetFlowlogByResourceWithTAByDetails, SetFlowlogByNameWithTAByResource, SetFlowlogByNameWithTAByDetails, SetFlowlogByLocationWithTAByResource, SetFlowlogByLocationWithTAByDetails +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workspace +The WS object which is used to store the traffic analytics data. + +```yaml +Type: Microsoft.Azure.Management.Internal.Network.Common.IOperationalInsightWorkspace +Parameter Sets: SetFlowlogByResourceWithTAByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Management.Internal.Network.Common.IOperationalInsightWorkspace +Parameter Sets: SetFlowlogByNameWithTAByResource, SetFlowlogByLocationWithTAByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceGUID +GUID of the WS which is used to store the traffic analytics data. + +```yaml +Type: System.String +Parameter Sets: SetFlowlogByResourceWithTAByDetails, SetFlowlogByNameWithTAByDetails, SetFlowlogByLocationWithTAByDetails +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceLocation +Azure Region of the WS which is used to store the traffic analytics data. + +```yaml +Type: System.String +Parameter Sets: SetFlowlogByResourceWithTAByDetails, SetFlowlogByNameWithTAByDetails, SetFlowlogByLocationWithTAByDetails +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +Subscription of the WS which is used to store the traffic analytics data. + +```yaml +Type: System.String +Parameter Sets: SetFlowlogByResourceWithTAByDetails, SetFlowlogByNameWithTAByDetails, SetFlowlogByLocationWithTAByDetails +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +### System.Boolean + +### System.Int32 + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Management.Internal.Network.Common.IOperationalInsightWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSFlowLog + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, watcher, flow, logs, flowlog, logging + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkWatcherConnectionMonitor.md b/azps-10.1.0/Az.Network/Set-AzNetworkWatcherConnectionMonitor.md new file mode 100644 index 0000000000..0143bb1671 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkWatcherConnectionMonitor.md @@ -0,0 +1,506 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkwatcherconnectionmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkWatcherConnectionMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkWatcherConnectionMonitor.md +--- + +# Set-AzNetworkWatcherConnectionMonitor + +## SYNOPSIS +Updates connection monitor resource. + +## SYNTAX + +### SetByName (Default) +``` +Set-AzNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String> + -SourceResourceId <String> [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] + [-DestinationResourceId <String>] -DestinationPort <Int32> [-DestinationAddress <String>] [-ConfigureOnly] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByResource +``` +Set-AzNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> -Name <String> + -SourceResourceId <String> [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] + [-DestinationResourceId <String>] -DestinationPort <Int32> [-DestinationAddress <String>] [-ConfigureOnly] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByResourceV2 +``` +Set-AzNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> -Name <String> + -TestGroup <PSNetworkWatcherConnectionMonitorTestGroupObject[]> + [-Output <PSNetworkWatcherConnectionMonitorOutputObject[]>] [-Note <String>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByNameV2 +``` +Set-AzNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String> + -TestGroup <PSNetworkWatcherConnectionMonitorTestGroupObject[]> + [-Output <PSNetworkWatcherConnectionMonitorOutputObject[]>] [-Note <String>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +Set-AzNetworkWatcherConnectionMonitor -Location <String> -Name <String> -SourceResourceId <String> + [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] [-DestinationResourceId <String>] + -DestinationPort <Int32> [-DestinationAddress <String>] [-ConfigureOnly] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocationV2 +``` +Set-AzNetworkWatcherConnectionMonitor -Location <String> -Name <String> + -TestGroup <PSNetworkWatcherConnectionMonitorTestGroupObject[]> + [-Output <PSNetworkWatcherConnectionMonitorOutputObject[]>] [-Note <String>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Set-AzNetworkWatcherConnectionMonitor -ResourceId <String> -SourceResourceId <String> + [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] [-DestinationResourceId <String>] + -DestinationPort <Int32> [-DestinationAddress <String>] [-ConfigureOnly] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdV2 +``` +Set-AzNetworkWatcherConnectionMonitor -ResourceId <String> + -TestGroup <PSNetworkWatcherConnectionMonitorTestGroupObject[]> + [-Output <PSNetworkWatcherConnectionMonitorOutputObject[]>] [-Note <String>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObject +``` +Set-AzNetworkWatcherConnectionMonitor -InputObject <PSConnectionMonitorResult> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzNetworkWatcherConnectionMonitor cmdlet updates connection monitor resource. + +## EXAMPLES + +### Example 1: Update a connection monitor +```powershell +Set-AzNetworkWatcherConnectionMonitor -Location centraluseuap -Name cm -SourceResourceId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RgCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm ` +-DestinationAddress google.com -DestinationPort 80 -Tag @{"key1" = "value1"} +``` + +```output +Name : cm +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGro + ups/NetworkWatcherRG/providers/Microsoft.Network/networkWatcher + s/NetworkWatcher_centraluseuap/connectionMonitors/cm +Etag : W/"5b2b20e8-0ce0-417e-9607-76208149bb67" +ProvisioningState : Succeeded +Source : { + "ResourceId": "/subscriptions/00000000-0000-0000-0000-0000000 + 00000/RgCentralUSEUAP/providers/Microsoft.Compute/virtualMach + ines/vm", + "Port": 0 + } +Destination : { + "Address": "google.com", + "Port": 80 + } +MonitoringIntervalInSeconds : 60 +AutoStart : True +StartTime : 1/12/2018 7:19:28 PM +MonitoringStatus : Running +Location : centraluseuap +Type : Microsoft.Network/networkWatchers/connectionMonitors +Tags : { + "key1": "value1" + } +``` + +In this example we update existing connection monitor by changing destinationAddress and adding tags. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigureOnly +Configure connection monitor, but do not start it + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetByName, SetByResource, SetByLocation, SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationAddress +Address of the connection monitor destination (IP or domain name). + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPort +The destination port used by connection monitor. + +```yaml +Type: System.Int32 +Parameter Sets: SetByName, SetByResource, SetByLocation, SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationResourceId +The ID of the resource used as the destination by connection monitor. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByLocation, SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Connection monitor object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult +Parameter Sets: SetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation, SetByLocationV2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoringIntervalInSeconds +Monitoring interval in seconds. Default value is 60 seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: SetByName, SetByResource, SetByLocation, SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The connection monitor name. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByResourceV2, SetByNameV2, SetByLocation, SetByLocationV2 +Aliases: ConnectionMonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource, SetByResourceV2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByNameV2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +Notes associated with connection monitor. + +```yaml +Type: System.String +Parameter Sets: SetByResourceV2, SetByNameV2, SetByLocationV2, SetByResourceIdV2 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Output +Describes a connection monitor output destinations. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorOutputObject[] +Parameter Sets: SetByResourceV2, SetByNameV2, SetByLocationV2, SetByResourceIdV2 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByNameV2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ConnectionMonitor resource ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId, SetByResourceIdV2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourcePort +The source port used by connection monitor. + +```yaml +Type: System.Int32 +Parameter Sets: SetByName, SetByResource, SetByLocation, SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceResourceId +The ID of the resource used as the source by connection monitor. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByLocation, SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetByName, SetByResource, SetByResourceV2, SetByNameV2, SetByLocation, SetByLocationV2, SetByResourceId, SetByResourceIdV2 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestGroup +The list of test groups. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorTestGroupObject[] +Parameter Sets: SetByResourceV2, SetByNameV2, SetByLocationV2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherConnectionMonitorTestGroupObject[] +Parameter Sets: SetByResourceIdV2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResultV1 + +### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResultV2 + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Set-AzNetworkWatcherFlowLog.md b/azps-10.1.0/Az.Network/Set-AzNetworkWatcherFlowLog.md new file mode 100644 index 0000000000..faeb193dba --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzNetworkWatcherFlowLog.md @@ -0,0 +1,549 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-aznetworkwatcherflowlog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkWatcherFlowLog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzNetworkWatcherFlowLog.md +--- + +# Set-AzNetworkWatcherFlowLog + +## SYNOPSIS +Updates flow log resource. + +## SYNTAX + +### SetByName (Default) +``` +Set-AzNetworkWatcherFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String> + -TargetResourceId <String> -StorageId <String> -Enabled <Boolean> [-EnableRetention <Boolean>] + [-RetentionPolicyDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResource +``` +Set-AzNetworkWatcherFlowLog -NetworkWatcher <PSNetworkWatcher> -Name <String> -TargetResourceId <String> + -StorageId <String> -Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] + [-FormatType <String>] [-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceWithTA +``` +Set-AzNetworkWatcherFlowLog -NetworkWatcher <PSNetworkWatcher> -Name <String> -TargetResourceId <String> + -StorageId <String> -Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] + [-FormatType <String>] [-FormatVersion <Int32>] [-EnableTrafficAnalytics] + [-TrafficAnalyticsWorkspaceId <String>] [-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByNameWithTA +``` +Set-AzNetworkWatcherFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String> + -TargetResourceId <String> -StorageId <String> -Enabled <Boolean> [-EnableRetention <Boolean>] + [-RetentionPolicyDays <Int32>] [-FormatType <String>] [-FormatVersion <Int32>] [-EnableTrafficAnalytics] + [-TrafficAnalyticsWorkspaceId <String>] [-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +Set-AzNetworkWatcherFlowLog -Location <String> -Name <String> -TargetResourceId <String> -StorageId <String> + -Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>] + [-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetByLocationWithTA +``` +Set-AzNetworkWatcherFlowLog -Location <String> -Name <String> -TargetResourceId <String> -StorageId <String> + -Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>] + [-FormatVersion <Int32>] [-EnableTrafficAnalytics] [-TrafficAnalyticsWorkspaceId <String>] + [-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Set-AzNetworkWatcherFlowLog -ResourceId <String> -TargetResourceId <String> -StorageId <String> + -Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>] + [-FormatVersion <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdWithTA +``` +Set-AzNetworkWatcherFlowLog -ResourceId <String> -TargetResourceId <String> -StorageId <String> + -Enabled <Boolean> [-EnableRetention <Boolean>] [-RetentionPolicyDays <Int32>] [-FormatType <String>] + [-FormatVersion <Int32>] [-EnableTrafficAnalytics] [-TrafficAnalyticsWorkspaceId <String>] + [-TrafficAnalyticsInterval <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObject +``` +Set-AzNetworkWatcherFlowLog -InputObject <PSFlowLogResource> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates flow log resource. + +## EXAMPLES + +### Example 1 +```powershell +$flowLog = Get-AzNetworkWatcherFlowLog -Location eastus -Name pstest +$flowLog.Enabled = $true +$flowLog.Format.Version = 2 +$flowLog | Set-AzNetworkWatcherFlowLog -Force +``` + +```output +Name : pstest +Id : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NetworkWatcherRG/provid + ers/Microsoft.Network/networkWatchers/NetworkWatcher_eastus/FlowLogs/pstest +Etag : W/"e939e1e6-1509-4d7a-9e89-1ea532f6f222" +ProvisioningState : Succeeded +Location : eastus +TargetResourceId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/MyFlowLog/provide + rs/Microsoft.Network/networkSecurityGroups/MyNSG +StorageId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/FlowLogsV2Demo/provider + s/Microsoft.Storage/storageAccounts/MyStorage +Enabled : True +RetentionPolicy : { + "Days": 0, + "Enabled": false + } +Format : { + "Type": "JSON", + "Version": 2 + } +FlowAnalyticsConfiguration : {} +``` + +### Example 2 + +Updates flow log resource. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzNetworkWatcherFlowLog -Enabled $true -Name 'cert01' -NetworkWatcherName nw1 -ResourceGroupName myresourcegroup -StorageId /subscriptions/00000000-0000-0000-0000-00000000000000000/resourceGroups/FlowLogsV2Demo/providers/Microsoft.Storage/storageAccounts/MyStorage -TargetResourceId <String> +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Flag to enable/disable flow logging. + +```yaml +Type: System.Boolean +Parameter Sets: SetByName, SetByResource, SetByResourceWithTA, SetByNameWithTA, SetByLocation, SetByLocationWithTA, SetByResourceId, SetByResourceIdWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableRetention +Flag to enable/disable retention. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: SetByName, SetByResource, SetByResourceWithTA, SetByNameWithTA, SetByLocation, SetByLocationWithTA, SetByResourceId, SetByResourceIdWithTA +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTrafficAnalytics +Flag to enable/disable TrafficAnalytics + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetByResourceWithTA, SetByNameWithTA, SetByLocationWithTA, SetByResourceIdWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FormatType +The file type of flow log. +The only supported value now is 'JSON'. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByResourceWithTA, SetByNameWithTA, SetByLocation, SetByLocationWithTA, SetByResourceId, SetByResourceIdWithTA +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FormatVersion +The version (revision) of the flow log. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: SetByName, SetByResource, SetByResourceWithTA, SetByNameWithTA, SetByLocation, SetByLocationWithTA, SetByResourceId, SetByResourceIdWithTA +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Flow lof object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSFlowLogResource +Parameter Sets: SetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation, SetByLocationWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The flow log name. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByResourceWithTA, SetByNameWithTA, SetByLocation, SetByLocationWithTA +Aliases: FlowLogName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource, SetByResourceWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByNameWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByNameWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +FlowLog resource ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId, SetByResourceIdWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionPolicyDays +Number of days to retain flow log records. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: SetByName, SetByResource, SetByResourceWithTA, SetByNameWithTA, SetByLocation, SetByLocationWithTA, SetByResourceId, SetByResourceIdWithTA +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageId +ID of the storage account which is used to store the flow log. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByResourceWithTA, SetByNameWithTA, SetByLocation, SetByLocationWithTA, SetByResourceId, SetByResourceIdWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: SetByName, SetByResource, SetByResourceWithTA, SetByNameWithTA, SetByLocation, SetByLocationWithTA, SetByResourceId, SetByResourceIdWithTA +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceId +ID of network security group to which flow log will be applied. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByResourceWithTA, SetByNameWithTA, SetByLocation, SetByLocationWithTA, SetByResourceId, SetByResourceIdWithTA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficAnalyticsInterval +The interval in minutes which would decide how frequently TA service should do flow analytics. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: SetByResourceWithTA, SetByNameWithTA, SetByLocationWithTA, SetByResourceIdWithTA +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficAnalyticsWorkspaceId +Resource Id of the attached workspace. + +```yaml +Type: System.String +Parameter Sets: SetByResourceWithTA, SetByNameWithTA, SetByLocationWithTA, SetByResourceIdWithTA +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSFlowLogResource + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSFlowLogResource + +## NOTES + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherFlowLog](./New-AzNetworkWatcherFlowLog.md) + +[Get-AzNetworkWatcherFlowLog](./Get-AzNetworkWatcherFlowLog.md) + +[Remove-AzNetworkWatcherFlowLog](./Remove-AzNetworkWatcherFlowLog.md) diff --git a/azps-10.1.0/Az.Network/Set-AzPrivateDnsZoneGroup.md b/azps-10.1.0/Az.Network/Set-AzPrivateDnsZoneGroup.md new file mode 100644 index 0000000000..f85a662851 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzPrivateDnsZoneGroup.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azprivatednszonegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzPrivateDnsZoneGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzPrivateDnsZoneGroup.md +--- + +# Set-AzPrivateDnsZoneGroup + +## SYNOPSIS +Updates DNS zone group + +## SYNTAX + +``` +Set-AzPrivateDnsZoneGroup -ResourceGroupName <String> -PrivateEndpointName <String> -Name <String> + -PrivateDnsZoneConfig <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPrivateDnsZoneConfig]> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPrivateDnsZoneGroup** cmdlet updates DNS zone group. + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +Get-AzPrivateDnsZoneGroup -ResourceGroupName rg -PrivateEndpointName my-pr-endpoint -name dnsgroup1 + +Name : dnsgroup1 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/my-pr-endpoint/privateDnsZoneGroups/dnsgroup1 +ProvisioningState : Succeeded +PrivateDnsZoneConfigs : [ + { + "Name": "test-vault-azure-com", + "PrivateDnsZoneId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Network/privateDnsZones/test.vault.azure.com", + "RecordSets": [] + } + ] + +$zone1 = Get-AzPrivateDnsZone -ResourceGroupName rg -Name "test1.vault.azure.com" +$config = New-AzPrivateDnsZoneConfig -Name test1-vault-azure-com -PrivateDnsZoneId $zone1.ResourceId +Set-AzPrivateDnsZoneGroup -ResourceGroupName rg -PrivateEndpointName my-pr-endpoint -name dnsgroup1 -PrivateDnsZoneConfig $config + +Name : dnsgroup1 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/my-pr-endpoint/privateDnsZoneGroups/dnsgroup1 +ProvisioningState : Succeeded +PrivateDnsZoneConfigs : [ + { + "Name": "test1-vault-azure-com", + "PrivateDnsZoneId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Network/privateDnsZones/test1.vault.azure.com", + "RecordSets": [] + } + ] +``` + +Above example updates DNS zone group named dnsgroup1 with a new dnsconfig which links to another DNS zone. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the private dns zone group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PrivateDnsZoneGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateDnsZoneConfig +A collection of private dns zone configurations of the private dns zone group. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPrivateDnsZoneConfig] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateEndpointName +The name of the private endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSPrivateDnsZoneConfig, Microsoft.Azure.PowerShell.Cmdlets.Network, Version=2.5.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateDnsZoneGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Set-AzPrivateEndpoint.md b/azps-10.1.0/Az.Network/Set-AzPrivateEndpoint.md new file mode 100644 index 0000000000..9a75e50c27 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzPrivateEndpoint.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azprivateendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzPrivateEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzPrivateEndpoint.md +--- + +# Set-AzPrivateEndpoint + +## SYNOPSIS +Updates a private endpoint. + +## SYNTAX + +``` +Set-AzPrivateEndpoint -PrivateEndpoint <PSPrivateEndpoint> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPrivateEndpoint** cmdlet updates a private endpoint. + +## EXAMPLES + +### 1: Creates a private endpoint and replace one of its subnets to another +```powershell +$virtualNetwork = Get-AzVirtualNetwork -ResourceName MyVirtualNetwork -ResourceGroupName TestResourceGroup +$plsConnection= New-AzPrivateLinkServiceConnection -Name MyPLSConnections -PrivateLinkServiceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/privateLinkServices/privateLinkService" -RequestMessage "Please Approve my request" +$privateEndpoint = New-AzPrivateEndpoint -Name MyPrivateEndpoint -ResourceGroupName TestResourceGroup -Location centralus -PrivateLinkServiceConnection $plsConnection -Subnet $virtualNetwork.Subnets[0] + +$privateEndpoint.Subnet = $virtualNetwork.Subnet[1] + +$privateEndpoint | Set-AzPrivateEndpoint +``` + +This example creates a private endpoint with one subnet, then it replace to another subnet from the in-memory representation of the virtual network. The Set-PrivateEndpoint cmdlet is then used to write the modified private endpoint state on the service side. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateEndpoint +Specifies a private endpoint object representing the state to which the private endpoint should be set. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPrivateEndpoint +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateEndpoint + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateEndpoint + +## NOTES + +## RELATED LINKS + +[Get-AzPrivateEndpoint](./Get-AzPrivateEndpoint.md) + +[New-AzPrivateEndpoint](./New-AzPrivateEndpoint.md) + +[Remove-AzPrivateEndpoint](./Remove-AzPrivateEndpoint.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzPrivateEndpointConnection.md b/azps-10.1.0/Az.Network/Set-AzPrivateEndpointConnection.md new file mode 100644 index 0000000000..b056a2c730 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzPrivateEndpointConnection.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzPrivateEndpointConnection.md +--- + +# Set-AzPrivateEndpointConnection + +## SYNOPSIS +Updates a private endpoint connection state on private link service. + +## SYNTAX + +### ByResourceId (Default) +``` +Set-AzPrivateEndpointConnection -PrivateLinkServiceConnectionState <String> [-Description <String>] + -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResource +``` +Set-AzPrivateEndpointConnection -Name <String> -PrivateLinkServiceConnectionState <String> + [-Description <String>] -ResourceGroupName <String> -ServiceName <String> + [-DefaultProfile <IAzureContextContainer>] -PrivateLinkResourceType <String> [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPrivateEndpointConnection** cmdlet updates a private endpoint connection state on a private link service + +## EXAMPLES + +### Example 1 +```powershell +Set-AzPrivateEndpointConnection -Name TestPrivateEndpointConnection -ResourceGroupName TestResourceGroup -ServiceName TestPrivateLinkService -PrivateLinkResourceType Microsoft.Network/privateLinkServices -PrivateLinkServiceConnectionState "Approved" +``` + +This example updates a private endpoint connection state to Approved. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The reason of action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateLinkResourceType +The private link resource type. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: +Accepted values: Microsoft.AgFoodPlatform/farmBeats, Microsoft.ApiManagement/service, Microsoft.AppConfiguration/configurationStores, Microsoft.Attestation/attestationProviders, Microsoft.Authorization/resourceManagementPrivateLinks, Microsoft.Automation/automationAccounts, Microsoft.Batch/batchAccounts, Microsoft.Cache/Redis, Microsoft.Cache/redisEnterprise, Microsoft.CognitiveServices/accounts, Microsoft.Compute/diskAccesses, Microsoft.ContainerRegistry/registries, Microsoft.ContainerService/managedClusters, Microsoft.Databricks/workspaces, Microsoft.DataFactory/factories, Microsoft.DBforMariaDB/servers, Microsoft.DBforMySQL/servers, Microsoft.DBforPostgreSQL/servers, Microsoft.DesktopVirtualization/hostpools, Microsoft.DesktopVirtualization/workspaces, Microsoft.Devices/IotHubs, Microsoft.Devices/ProvisioningServices, Microsoft.DeviceUpdate/accounts, Microsoft.DigitalTwins/digitalTwinsInstances, Microsoft.DocumentDB/databaseAccounts, Microsoft.EventGrid/topics, Microsoft.EventGrid/domains, Microsoft.EventHub/namespaces, Microsoft.HardwareSecurityModules/cloudHsmClusters, Microsoft.HealthcareApis/services, Microsoft.HDInsight/clusters, Microsoft.HybridCompute/privateLinkScopes, Microsoft.Insights/privateLinkScopes, Microsoft.KeyVault/vaults, Microsoft.Keyvault/managedHSMs, Microsoft.MachineLearningServices/workspaces, Microsoft.MachineLearningServices/registries, Microsoft.Media/mediaservices, Microsoft.Media/videoanalyzers, Microsoft.Migrate/assessmentProjects, Microsoft.Migrate/migrateProjects, Microsoft.Monitor/accounts, Microsoft.Network/applicationgateways, Microsoft.Network/privateLinkServices, Microsoft.OffAzure/masterSites, Microsoft.PowerBI/privateLinkServicesForPowerBI, Microsoft.Purview/accounts, Microsoft.RecoveryServices/vaults, Microsoft.Relay/namespaces, Microsoft.Search/searchServices, Microsoft.ServiceBus/namespaces, Microsoft.SignalRService/signalr, Microsoft.SignalRService/webPubSub, Microsoft.Sql/servers, Microsoft.Storage/storageAccounts, Microsoft.StorageSync/storageSyncServices, Microsoft.Synapse/privateLinkHubs, Microsoft.Synapse/workspaces, Microsoft.Web/sites, Microsoft.Web/staticSites, Microsoft.Web/hostingEnvironments, Microsoft.BotService/botServices, Microsoft.OpenEnergyPlatform/energyServices, Microsoft.DBforMySQL/flexibleServers + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateLinkServiceConnectionState +Approved or rejected the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource manager id of the private endpoint connection. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +The private link service name. + +```yaml +Type: System.String +Parameter Sets: ByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateLinkService + +## NOTES + +## RELATED LINKS + +[Approve-AzPrivateEndpointConnection](./Approve-AzPrivateEndpointConnection.md) + +[Deny-AzPrivateEndpointConnection](./Deny-AzPrivateEndpointConnection.md) + +[Get-AzPrivateEndpointConnection](./Get-AzPrivateEndpointConnection.md) + +[Remove-AzPrivateEndpointConnection](./Remove-AzPrivateEndpointConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzPrivateLinkService.md b/azps-10.1.0/Az.Network/Set-AzPrivateLinkService.md new file mode 100644 index 0000000000..a833f642ff --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzPrivateLinkService.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azprivatelinkservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzPrivateLinkService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzPrivateLinkService.md +--- + +# Set-AzPrivateLinkService + +## SYNOPSIS +Updates a private link service. + +## SYNTAX + +``` +Set-AzPrivateLinkService -PrivateLinkService <PSPrivateLinkService> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPrivateLinkService** cmdlet updates a private link service. + +## EXAMPLES + +### 1: Creates a private link service and update its +```powershell +$vnet = Get-AzVirtualNetwork -ResourceName "myvnet" -ResourceGroupName "myresourcegroup" +$IPConfig = New-AzPrivateLinkServiceIpConfig -Name "IP-Config" -Subnet $vnet.subnets[1] -PrivateIpAddress "10.0.0.5" +$publicip = Get-AzPublicIpAddress -ResourceGroupName "myresourcegroup" +$frontend = New-AzLoadBalancerFrontendIpConfig -Name "FrontendIpConfig01" -PublicIpAddress $publicip +$lb = New-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "myresourcegroup" -Location "West US" -FrontendIpConfiguration $frontend +$privateLinkService = New-AzPrivateLinkService -ServiceName "mypls" -ResourceGroupName myresourcegroup -Location "West US" -LoadBalancerFrontendIpConfiguration $frontend -IpConfiguration $IPConfig + +$newIPConfig = New-AzPrivateLinkServiceIpConfig -Name "New-IP-Config" -Subnet $vnet.subnets[0] +$privateLinkService.IpConfigurations[0] = $newIPConfig +$privateLinkService | Set-AzPrivateLinkService +``` + +This example creates a private link service called mypls. Then it replace its ipConfigurations from the in-memory ipConfiguratiuon object. The Set-AzPrivateLinkService cmdlet is then used to write the modified private link service state on the service side. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkService +Specifies a private link service object representing the state to which the private link service should be set. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPrivateLinkService +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateLinkService + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPrivateLinkService + +## NOTES + +## RELATED LINKS + +[Get-AzPrivateLinkService](./Get-AzPrivateLinkService.md) + +[New-AzPrivateLinkService](./New-AzPrivateLinkService.md) + +[Remove-AzPrivateLinkService](./Remove-AzPrivateLinkService.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzPublicIpAddress.md b/azps-10.1.0/Az.Network/Set-AzPublicIpAddress.md new file mode 100644 index 0000000000..3f45917c59 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzPublicIpAddress.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: EC798838-1850-4E88-B17F-D2F00F2D4EE9 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azpublicipaddress +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzPublicIpAddress.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzPublicIpAddress.md +--- + +# Set-AzPublicIpAddress + +## SYNOPSIS +Updates a public IP address. + +## SYNTAX + +``` +Set-AzPublicIpAddress -PublicIpAddress <PSPublicIpAddress> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPublicIpAddress** cmdlet updates a public IP address. + +## EXAMPLES + +### 1: Change allocation method of a public IP address +```powershell +$publicIp = Get-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName + +$publicIp.PublicIpAllocationMethod = "Static" + +Set-AzPublicIpAddress -PublicIpAddress $publicIp + +Get-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName +``` + + First command gets the public IP address resource with name $publicIPName in the resource + group $rgName. + Second command sets the allocation method of the public IP address object to "Static". + Set-AzPublicIPAddress command updates the public IP address resource with the + updated object, and modifies the allocation method to 'Static'. A public IP address gets + allocated immediately. + +### 2: Add DNS domain label of a public IP address +```powershell +$publicIp = Get-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName + +$publicIp.DnsSettings = @{"DomainNameLabel" = "newdnsprefix"} + +Set-AzPublicIpAddress -PublicIpAddress $publicIp + +$publicIp = Get-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName +``` + +First command gets the public IP address resource with name $publicIPName in the resource + group $rgName. + Second command sets the DomainNameLabel property to the required dns prefix. + Set-AzPublicIPAddress command updates the public IP address resource with the + updated object. DomainNameLabel & Fqdn are modified as expected. + + +### 3: Change DNS domain label of a public IP address +```powershell +$publicIp = Get-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName + +$publicIp.DnsSettings.DomainNameLabel = "newdnsprefix" + +Set-AzPublicIpAddress -PublicIpAddress $publicIp + +$publicIp = Get-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName +``` + +First command gets the public IP address resource with name $publicIPName in the resource + group $rgName. + Second command sets the DomainNameLabel property to the required dns prefix. + Set-AzPublicIPAddress command updates the public IP address resource with the + updated object. DomainNameLabel & Fqdn are modified as expected. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddress +Specifies a public IP address object representing the state to which the public IP address should be set. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress + +## NOTES + +## RELATED LINKS + +[Get-AzPublicIpAddress](./Get-AzPublicIpAddress.md) + +[New-AzPublicIpAddress](./New-AzPublicIpAddress.md) + +[Remove-AzPublicIpAddress](./Remove-AzPublicIpAddress.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzPublicIpPrefix.md b/azps-10.1.0/Az.Network/Set-AzPublicIpPrefix.md new file mode 100644 index 0000000000..e9431afcf4 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzPublicIpPrefix.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azpublicipprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzPublicIpPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzPublicIpPrefix.md +--- + +# Set-AzPublicIpPrefix + +## SYNOPSIS +Sets the Tags for an existing PublicIpPrefix + +## SYNTAX + +``` +Set-AzPublicIpPrefix -PublicIpPrefix <PSPublicIpPrefix> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPublicIpPrefix** cmdlet sets the Tags for a public IP prefix. + +## EXAMPLES + +### Set the tags for public ip prefix +```powershell +$publicIpPrefix = Get-AzPublicIpPrefix -Name $prefixName -ResourceGroupName $rgName + +$publicIpPrefix.Tags = "TestTag" + +Set-AzPublicIpPrefix -PublicIpPrefix $publicIpPrefix +``` + +The first command gets an existing public IP Prefix, the second command sets the Tags Property and the third command updates the existing object. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpPrefix +The PublicIpPrefix + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix + +## NOTES + +## RELATED LINKS + +[Get-AzPublicIpPrefix](./Get-AzPublicIpPrefix.md) + +[New-AzPublicIpPrefix](./New-AzPublicIpPrefix.md) + +[Remove-AzPublicIpPrefix](./Remove-AzPublicIpPrefix.md) diff --git a/azps-10.1.0/Az.Network/Set-AzRouteConfig.md b/azps-10.1.0/Az.Network/Set-AzRouteConfig.md new file mode 100644 index 0000000000..7c831613fd --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzRouteConfig.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 6E967F9C-949E-4485-9B57-FC4F523D5DC9 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azrouteconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzRouteConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzRouteConfig.md +--- + +# Set-AzRouteConfig + +## SYNOPSIS +Updates a route configuration for a route table. + +## SYNTAX + +``` +Set-AzRouteConfig -RouteTable <PSRouteTable> [-Name <String>] [-AddressPrefix <String>] [-NextHopType <String>] + [-NextHopIpAddress <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzRouteConfig** cmdlet updates a route configuration for a route table. + +## EXAMPLES + +### Example 1: Modify a route +```powershell +Get-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Set-AzRouteConfig -Name "Route02" -AddressPrefix 10.4.0.0/16 -NextHopType VnetLocal | Set-AzRouteTable +``` + +```output +Name : Routetable01 +ResourceGroupName : ResourceGroup11 +Location : eastus +Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ + k/routeTables/RouteTable01 +Etag : W/"58c2922e-9efe-4554-a457-956ef44bc718" +ProvisioningState : Succeeded +Tags : +Routes : [ + { + "Name": "Route07", + "Etag": "W/\"58c2922e-9efe-4554-a457-956ef44bc718\"", + "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro + soft.Network/routeTables/Routetable01/routes/Route07", + "AddressPrefix": "10.1.0.0/16", + "NextHopType": "VnetLocal", + "NextHopIpAddress": null, + "ProvisioningState": "Succeeded" + }, + { + "Name": "route02", + "Etag": "W/\"58c2922e-9efe-4554-a457-956ef44bc718\"", + "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro + soft.Network/routeTables/routetable01/routes/route02", + "AddressPrefix": "10.4.0.0/16", + "NextHopType": "VnetLocal", + "NextHopIpAddress": null, + "ProvisioningState": "Succeeded" + } + ] +Subnets : [] +``` + +This command gets the route table named RouteTable01 by using the Get-AzRouteTable cmdlet. +The command passes that table to the current cmdlet by using the pipeline operator. +The current cmdlet modifies the route named Route02, and then passes the result to the **Set-AzRouteTable** cmdlet, which updates the table to reflect your changes. + +### Example 2: Modify a route using a Service Tag (Public Preview) +```powershell +Set-AzRouteConfig -Name "Route02" -AddressPrefix "AppService" -NextHopType "VirtualAppliance" -NextHopIpAddress "10.0.2.4" +``` + +This command modifies the route named Route02, supplying a Service Tag as the AddressPrefix parameter. + +## PARAMETERS + +### -AddressPrefix +Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies. You can also specify a Service Tag here (this feature is in Public Preview). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the route that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextHopIpAddress +Specifies the IP address of a virtual appliance that you add to your Azure virtual network. +This route forwards packets to that address. +Specify this parameter only if you specify a value of VirtualAppliance for the *NextHopType* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NextHopType +Specifies how this route forwards packets. +The acceptable values for this parameter are: +- Internet. +The default Internet gateway provided by Azure. +- None. +If you specify this value, the route does not forward packets. +- VirtualAppliance. +A virtual appliance that you add to your Azure virtual network. +- VirtualNetworkGateway. +An Azureserver-to-server virtual private network gateway. +- VnetLocal. +The local virtual network. +If you have two subnets, 10.1.0.0/16 and 10.2.0.0/16 in the same virtual network, select a value of VnetLocal for each subnet to forward to the other subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteTable +Specifies the route table with which this route is associated. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +## NOTES + +## RELATED LINKS + +[Add-AzRouteConfig](./Add-AzRouteConfig.md) + +[Get-AzRouteConfig](./Get-AzRouteConfig.md) + +[New-AzRouteConfig](./New-AzRouteConfig.md) + +[Remove-AzRouteConfig](./Remove-AzRouteConfig.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzRouteFilter.md b/azps-10.1.0/Az.Network/Set-AzRouteFilter.md new file mode 100644 index 0000000000..6bed07da8d --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzRouteFilter.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azroutefilter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzRouteFilter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzRouteFilter.md +--- + +# Set-AzRouteFilter + +## SYNOPSIS +Updates a route filter. + +## SYNTAX + +``` +Set-AzRouteFilter -RouteFilter <PSRouteFilter> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzApplicationGateway** cmdlet updates a route filter + +## EXAMPLES + +### Example 1 +```powershell +Set-AzRouteFilter -RouteFilter $rf +``` + +This command updates the route filter with settings in the $rf variable. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteFilter +The RouteFilter + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilter + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilter + +## NOTES + +## RELATED LINKS + +[Get-AzRouteFilter](./Get-AzRouteFilter.md) + +[New-AzRouteFilter](./New-AzRouteFilter.md) + +[Remove-AzRouteFilter](./Remove-AzRouteFilter.md) + +[Add-AzRouteFilterRuleConfig](./Add-AzRouteFilterRuleConfig.md) + +[Get-AzRouteFilterRuleConfig](./Get-AzRouteFilterRuleConfig.md) + +[New-AzRouteFilterRuleConfig](./New-AzRouteFilterRuleConfig.md) + +[Remove-AzRouteFilterRuleConfig](./Remove-AzRouteFilterRuleConfig.md) + +[Set-AzRouteFilterRuleConfig](./Set-AzRouteFilterRuleConfig.md) diff --git a/azps-10.1.0/Az.Network/Set-AzRouteFilterRuleConfig.md b/azps-10.1.0/Az.Network/Set-AzRouteFilterRuleConfig.md new file mode 100644 index 0000000000..a1f998398f --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzRouteFilterRuleConfig.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azroutefilterruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzRouteFilterRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzRouteFilterRuleConfig.md +--- + +# Set-AzRouteFilterRuleConfig + +## SYNOPSIS +Modifies the route filter rule of a route filter. + +## SYNTAX + +``` +Set-AzRouteFilterRuleConfig -RouteFilter <PSRouteFilter> [-Force] -Name <String> -Access <String> + -RouteFilterRuleType <String> -CommunityList <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzRouteFilterRuleConfig** cmdlet modifies the route filter rule of a route filter. + +## EXAMPLES + +### Example 1 +```powershell +$rf = Get-AzRouteFilter -Name "RouteFilter01" -ResourceGroupName "ResourceGroup01" +$rf = Set-AzRouteFilterRuleConfig -RouteFilter $rf -Name "Rule01" -Access Deny -RouteFilterRuleType Community -CommunityList "12076:5010","12076:5040" +Set-AzRouteFilter -RouteFilter $rf +``` + +The first command gets the route filter named RouteFilter01 and stores it in the $rf variable. +The second command modifies the route filter rule named Rule01 and stores updated route filter in the $rf variable. +The third command saves updated route filter. + +## PARAMETERS + +### -Access +The access type of the rule. +Possible values are: 'Allow', 'Deny' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommunityList +The list of community value that route filter will filter on + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the route filter rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteFilter +The RouteFilter + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RouteFilterRuleType +The route filter rule type of the rule. +Possible values are: 'Community' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Community + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilter + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteFilter + +## NOTES + +## RELATED LINKS + +[Add-AzRouteFilterRuleConfig](./Add-AzRouteFilterRuleConfig.md) + +[Get-AzRouteFilterRuleConfig](./Get-AzRouteFilterRuleConfig.md) + +[New-AzRouteFilterRuleConfig](./New-AzRouteFilterRuleConfig.md) + +[Remove-AzRouteFilterRuleConfig](./Remove-AzRouteFilterRuleConfig.md) + +[Get-AzRouteFilter](./Get-AzRouteFilter.md) + +[New-AzRouteFilter](./New-AzRouteFilter.md) + +[Remove-AzRouteFilter](./Remove-AzRouteFilter.md) + +[Set-AzRouteFilter](./Set-AzRouteFilter.md) diff --git a/azps-10.1.0/Az.Network/Set-AzRouteTable.md b/azps-10.1.0/Az.Network/Set-AzRouteTable.md new file mode 100644 index 0000000000..7008b9a3fb --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzRouteTable.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 1CE2A30A-6DF8-4C4C-8348-C3C1CD4D0146 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzRouteTable.md +--- + +# Set-AzRouteTable + +## SYNOPSIS +Updates a route table. + +## SYNTAX + +``` +Set-AzRouteTable -RouteTable <PSRouteTable> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzRouteTable** cmdlet updates a route table. + +## EXAMPLES + +### Example 1: Update a route table by adding route configuration to it +```powershell +Get-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Add-AzRouteConfig -Name "Route07" -AddressPrefix 10.2.0.0/16 -NextHopType "VnetLocal" | Set-AzRouteTable +``` + +```output +Name : RouteTable01 +ResourceGroupName : ResourceGroup11 +Location : eastus +Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ + k/routeTables/RouteTable01 +Etag : W/"f13e1bc8-d41f-44d0-882d-b8b5a1134f59" +ProvisioningState : Succeeded +Tags : +Routes : [ + { + "Name": "Route07", + "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"", + "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro + soft.Network/RouteTables/RouteTable01/routes/Route07", + "AddressPrefix": "10.1.0.0/16", + "NextHopType": "VnetLocal", + "NextHopIpAddress": null, + "ProvisioningState": "Succeeded" + }, + { + "Name": "Route07", + "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"", + "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro + soft.Network/RouteTables/RouteTable01/routes/Route07", + "AddressPrefix": "10.2.0.0/16", + "NextHopType": "VnetLocal", + "NextHopIpAddress": null, + "ProvisioningState": "Succeeded" + }, + { + "Name": "Route13", + "Etag": null, + "Id": null, + "AddressPrefix": "10.3.0.0/16", + "NextHopType": "VnetLocal", + "NextHopIpAddress": null, + "ProvisioningState": null + } + ] +Subnets : [] +``` + +This command gets the route table named RouteTable01 by using Get-AzRouteTable cmdlet. +The command passes that table to the Add-AzRouteConfig cmdlet by using the pipeline operator. +**Add-AzRouteConfig** adds the route named Route07, and then passes the result to the current cmdlet, which updates the table to reflect your changes. + +### Example 2: Modify route table +<!-- Skip: Output cannot be splitted from code --> + +```powershell +$rt = Get-AzRouteTable -ResourceGroupName "rgName" -Name "rtName" +$rt.DisableBgpRoutePropagation + +False + +$rt.DisableBgpRoutePropagation = $true +Set-AzRouteTable -RouteTable $rt +$rt = Get-AzRouteTable -ResourceGroupName "rgName" -Name "rtName" +$rt.DisableBgpRoutePropagation + +True +``` + +The first command gets the route table named rtName and stores it in the $rt variable. +The second command displays the value of DisableBgpRoutePropagation. +The third command updates value of DisableBgpRoutePropagation. +The fourth command updates route table on the server. +The fifth command gets updated route table and stores it in the $rt variable. +The sixth command displays the value of DisableBgpRoutePropagation. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteTable +Specifies a route table object representing the state to which the route table should be set. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +## NOTES + +## RELATED LINKS + +[Add-AzRouteConfig](./Add-AzRouteConfig.md) + +[Get-AzRouteTable](./Get-AzRouteTable.md) + +[New-AzRouteTable](./New-AzRouteTable.md) + +[Remove-AzRouteTable](./Remove-AzRouteTable.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzRoutingIntent.md b/azps-10.1.0/Az.Network/Set-AzRoutingIntent.md new file mode 100644 index 0000000000..ed863bf544 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzRoutingIntent.md @@ -0,0 +1,290 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azroutingintent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzRoutingIntent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzRoutingIntent.md +--- + +# Set-AzRoutingIntent + +## SYNOPSIS +Updates a routing intent resource associated with a VirtualHub. + +## SYNTAX + +### ByRoutingIntentName (Default) +``` +Set-AzRoutingIntent -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + [-RoutingPolicy <PSRoutingPolicy[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Set-AzRoutingIntent -Name <String> -ParentObject <PSVirtualHub> [-RoutingPolicy <PSRoutingPolicy[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRoutingIntentObject +``` +Set-AzRoutingIntent -InputObject <PSRoutingIntent> [-RoutingPolicy <PSRoutingPolicy[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRoutingIntentResourceId +``` +Set-AzRoutingIntent -ResourceId <String> [-RoutingPolicy <PSRoutingPolicy[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the specified routing intent that is associated with the specified virtual hub. If a list of routing policies is provided, these will overwrite the existing policies on the current routing intent resource. + +## EXAMPLES + +### Example 1 +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" + +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" + +$fwIp = New-AzFirewallHubPublicIpAddress -Count 1 +$hubIpAddresses = New-AzFirewallHubIpAddress -PublicIP $fwIp + +New-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" -Location "westcentralus" -Sku AZFW_Hub -VirtualHubId $virtualHub.Id -HubIPAddress $hubIpAddresses +$firewall = Get-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" + +$policy1 = New-AzRoutingPolicy -Name "PrivateTraffic" -Destination @("PrivateTraffic") -NextHop $firewall.Id +New-AzRoutingIntent -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRoutingIntent" -RoutingPolicy @($policy1) + +$policy2 = New-AzRoutingPolicy -Name "PublicTraffic" -Destination @("Internet") -NextHop $firewall.Id +Set-AzRoutingIntent -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRoutingIntent" -RoutingPolicy @($policy2) +``` + +```output +ProvisioningState : Succeeded +RoutingPolicies : {PublicTraffic} +RoutingPoliciesText : [ + { + "Name": "PublicTraffic", + "DestinationType": "TrafficType", + "Destinations": [ + "Internet" + ], + "NextHopType": "ResourceId", + "NextHop": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall" + } + ] +Name : testRoutingIntent +Etag : W/"etag" +Id : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/routingIntent/testRoutingIntent +``` + +This command deletes the hub RoutingPolicy table of the virtual hub. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The RoutingIntent resource to Set. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingIntent +Parameter Sets: ByRoutingIntentObject +Aliases: RoutingIntent + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByRoutingIntentName, ByVirtualHubObject +Aliases: ResourceName, RoutingIntentName, RouteTableName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The parent virtual hub object of this resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByRoutingIntentName +Aliases: VirtualHubName, ParentVirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByRoutingIntentName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the RoutingIntent resource to Set. + +```yaml +Type: System.String +Parameter Sets: ByRoutingIntentResourceId +Aliases: RoutingIntentId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoutingPolicy +The list of RoutingPolicies to update in this routing intent reesource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### Microsoft.Azure.Commands.Network.Models.PSRoutingIntent + +### Microsoft.Azure.Commands.Network.Models.PSRoutingPolicy + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRoutingIntent + +## NOTES + +## RELATED LINKS + +[Add-AzRoutingPolicy](./Add-AzRoutingPolicy.md) + +[Get-AzRoutingIntent](./Get-AzRoutingIntent.md) + +[Get-AzRoutingPolicy](./Get-AzRoutingPolicy.md) + +[New-AzRoutingPolicy](./New-AzRoutingPolicy.md) + +[Remove-AzRoutingIntent](./Remove-AzRoutingIntent.md) + +[Remove-AzRoutingPolicy](./Remove-AzRoutingPolicy.md) + +[Set-AzRoutingPolicy](./Set-AzRoutingPolicy.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzRoutingPolicy.md b/azps-10.1.0/Az.Network/Set-AzRoutingPolicy.md new file mode 100644 index 0000000000..6c6c818281 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzRoutingPolicy.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azroutingpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzRoutingPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzRoutingPolicy.md +--- + +# Set-AzRoutingPolicy + +## SYNOPSIS +Updates the destinations or nexthop for the specified Routing Policy of a Routing Intent object. + +## SYNTAX + +``` +Set-AzRoutingPolicy -RoutingIntent <PSRoutingIntent> -Destination <String[]> -NextHop <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzRoutingPolicy** cmdlet updates a RoutingPolicy of a RoutingIntent resource. This will only return an updated in-memory routing intent resource. Please use the [Set-AzRoutingIntent](./Set-AzRoutingIntent.md) cmdlet to update the actual resource and ensure that the policies take effect. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRg" +$firewallName = "testFirewall" +$firewall = Get-AzFirewall -Name $firewallName -ResourceGroupName $rgName +$routingIntent = Get-AzRoutingIntent -Name "routingIntent1" -HubName "hub1" -ResourceGroupName $rgName +Set-AzRoutingPolicy -Name "PrivateTraffic" -RoutingIntent $routingIntent -Destination @("PrivateTraffic") -NextHop $firewall.Id +``` + +```output +ProvisioningState : Succeeded +RoutingPolicies : {PrivateTraffic} +RoutingPoliciesText : [ + { + "Name": "PrivateTraffic", + "DestinationType": "TrafficType", + "Destinations": [ + "PrivateTraffic" + ], + "NextHopType": "ResourceId", + "NextHop": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall" + } + ] +Name : routingIntent1 +Etag : W/"etag" +Id : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub1/routingIntent/routingIntent1 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +The list of destinations. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the routing policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NextHop +Id of the next hop resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingIntent +The routing intent resource to which this rouing policy has to be added. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingIntent +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSRoutingIntent + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRoutingIntent + +## NOTES + +## RELATED LINKS + +[Get-AzRoutingIntent](./Get-AzRoutingIntent.md) + +[Get-AzRoutingPolicy](./Get-AzRoutingPolicy.md) + +[New-AzRoutingPolicy](./New-AzRoutingPolicy.md) + +[Remove-AzRoutingIntent](./Remove-AzRoutingIntent.md) + +[Remove-AzRoutingPolicy](./Remove-AzRoutingPolicy.md) + +[Set-AzRoutingIntent](./Set-AzRoutingIntent.md) + +[Set-AzRoutingPolicy](./Set-AzRoutingPolicy.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzSecurityPartnerProvider.md b/azps-10.1.0/Az.Network/Set-AzSecurityPartnerProvider.md new file mode 100644 index 0000000000..fd7b51cf0d --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzSecurityPartnerProvider.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azsecuritypartnerprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzSecurityPartnerProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzSecurityPartnerProvider.md +--- + +# Set-AzSecurityPartnerProvider + +## SYNOPSIS +Saves a modified Azure SecurityPartnerProvider. + +## SYNTAX + +``` +Set-AzSecurityPartnerProvider -SecurityPartnerProvider <PSSecurityPartnerProvider> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSecurityPartnerProvider** cmdlet updates an Azure SecurityPartnerProvider + +## EXAMPLES + +### Example 1 +```powershell +$securityPartnerProvider = Get-AzSecurityPartnerProvider -ResourceGroupName securityPartnerProviderRG -Name securityPartnerProvider +Set-AzSecurityPartnerProvider -SecurityPartnerProvider $securityPartnerProvider +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityPartnerProvider +The SecurityPartnerProvider + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSSecurityPartnerProvider +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSSecurityPartnerProvider + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSSecurityPartnerProvider + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Set-AzServiceEndpointPolicy.md b/azps-10.1.0/Az.Network/Set-AzServiceEndpointPolicy.md new file mode 100644 index 0000000000..0e83717a7b --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzServiceEndpointPolicy.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azserviceendpointpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzServiceEndpointPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzServiceEndpointPolicy.md +--- + +# Set-AzServiceEndpointPolicy + +## SYNOPSIS +Updates a service endpoint policy. + +## SYNTAX + +``` +Set-AzServiceEndpointPolicy -ServiceEndpointPolicy <PSServiceEndpointPolicy> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzServiceEndpointPolicy** cmdlet updates a service endpoint policy. + +## EXAMPLES + +### Example 1: Sets a service endpoint policy +```powershell +$serviceEndpointPolicy = Get-AzServiceEndpointPolicy -Name "Policy1" -ResourceGroupName "resourcegroup1" +Set-AzServiceEndpointPolicy -ServiceEndpointPolicy $serviceEndpointPolicy +``` + +This command updates a service endpoint policy named Policy1 defined by the object $serviceEndpointPolicy belong to the resourcegroup "resourcegroup1". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceEndpointPolicy +The ServiceEndpointPolicy + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy + +## NOTES + +## RELATED LINKS + +[Get-AzServiceEndpointPolicy](./Get-AzServiceEndpointPolicy.md) + +[New-AzServiceEndpointPolicy](./New-AzServiceEndpointPolicy.md) + +[Remove-AzServiceEndpointPolicy](./Remove-AzServiceEndpointPolicy.md) diff --git a/azps-10.1.0/Az.Network/Set-AzServiceEndpointPolicyDefinition.md b/azps-10.1.0/Az.Network/Set-AzServiceEndpointPolicyDefinition.md new file mode 100644 index 0000000000..18783f44ca --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzServiceEndpointPolicyDefinition.md @@ -0,0 +1,178 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azserviceendpointpolicydefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzServiceEndpointPolicyDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzServiceEndpointPolicyDefinition.md +--- + +# Set-AzServiceEndpointPolicyDefinition + +## SYNOPSIS +Updates a service endpoint policy definition. + +## SYNTAX + +``` +Set-AzServiceEndpointPolicyDefinition -Name <String> -ServiceEndpointPolicy <PSServiceEndpointPolicy> + [-Description <String>] [-ServiceResource <String[]>] [-Service <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzServiceEndpointPolicyDefinition** cmdlet create a service endpoint policy definition. + +## EXAMPLES + +### Example 1: Updates a service endpoint policy definition in a service endpoint policy +```powershell +$serviceEndpointPolicy = Set-AzServiceEndpointPolicyDefinition -Name "Policydef1" -ServiceEndpointPolicy $serviceEndpointPolicy +``` + +This command updates a service endpoint policy definition named Policydef1 in the service endpoint policy defined by the object $ServiceEndpointPolicy. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the definition + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Service +Name of the service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceEndpointPolicy +The NetworkSecurityGroup + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ServiceResource +List of service resources + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy + +## NOTES + +## RELATED LINKS + +[Add-AzServiceEndpointPolicyDefinition](./Add-AzServiceEndpointPolicyDefinition.md) + +[Get-AzServiceEndpointPolicyDefinition](./Get-AzServiceEndpointPolicyDefinition.md) + +[New-AzServiceEndpointPolicyDefinition](./New-AzServiceEndpointPolicyDefinition.md) + +[Remove-AzServiceEndpointPolicyDefinition](./Remove-AzServiceEndpointPolicyDefinition.md) diff --git a/azps-10.1.0/Az.Network/Set-AzVirtualHub.md b/azps-10.1.0/Az.Network/Set-AzVirtualHub.md new file mode 100644 index 0000000000..88a44b7d03 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzVirtualHub.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azvirtualhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualHub.md +--- + +# Set-AzVirtualHub + +## SYNOPSIS +Modifies a Virtual Hub to add a Virtual HUb Route Table to it. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +Set-AzVirtualHub -ResourceGroupName <String> -Name <String> -RouteTable <PSVirtualHubRouteTable[]> + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +Set-AzVirtualHub -ResourceId <String> -RouteTable <PSVirtualHubRouteTable[]> [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Set-AzVirtualHub -InputObject <PSVirtualHub> -RouteTable <PSVirtualHubRouteTable[]> [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVirtualHub** cmdlet modifies a Virtual Hub to add a Virtual HUb Route Table to it. + +## EXAMPLES + +### Example 1 +```powershell +$existingHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "westushub" +$route1 = Add-AzVirtualHubRoute -DestinationType "CIDR" -Destination @("10.4.0.0/16", "10.5.0.0/16") -NextHopType "IPAddress" -NextHop @("10.0.0.68") +$routeTable1 = Add-AzVirtualHubRouteTable -Route @($route1) -Connection @("All_Vnets") -Name "routeTable1" +Set-AzVirtualHub -VirtualHub $existingHub -RouteTable @($routeTable1) +``` + +```output +VirtualWan : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/testWan +ResourceGroupName : testRg +Name : westushub +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubswestushub +AddressPrefix : 10.40.0.0/16 +RouteTable : Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable +VirtualNetworkExpressRouteConnections : +RouteTables : {routeTable1} +Location : westus +Sku : Standard +Type : Microsoft.Network/virtualHubs +ProvisioningState : Succeeded +``` + +First we create a Virtual Hub Route object, and use it to create a Virtual Hub Route Table resource. Then we set this route table resource to the virtual hub using the +Set-AzVirtualHub command. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Virtual hub object to be modified. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: ResourceName, VirtualHubName, HubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the Virtual hub to be modified. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteTable +The route tables associated with this Virtual Hub. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Set-AzVirtualNetwork.md b/azps-10.1.0/Az.Network/Set-AzVirtualNetwork.md new file mode 100644 index 0000000000..ae58b608d5 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzVirtualNetwork.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 93D8A341-540A-43F1-8C62-28323EAA58E0 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azvirtualnetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetwork.md +--- + +# Set-AzVirtualNetwork + +## SYNOPSIS +Updates a virtual network. + +## SYNTAX + +``` +Set-AzVirtualNetwork -VirtualNetwork <PSVirtualNetwork> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVirtualNetwork** cmdlet updates a virtual network. + +## EXAMPLES + +### 1: Creates a virtual network and removes one of its subnets +```powershell +New-AzResourceGroup -Name TestResourceGroup -Location centralus ## Create resource group +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" ## Create frontend subnet +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" ## Create backend subnet + +$virtualNetwork = New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup ` + -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet ## Create virtual network + +Remove-AzVirtualNetworkSubnetConfig -Name backendSubnet -VirtualNetwork $virtualNetwork ## Remove subnet from in memory representation of virtual network + +$virtualNetwork | Set-AzVirtualNetwork ## Remove subnet from virtual network +``` + +This example creates a virtual network called TestResourceGroup with two subnets: frontendSubnet and backendSubnet. Then it removes backendSubnet subnet from the in-memory representation of the virtual network. The Set-AzVirtualNetwork cmdlet is then used to write the modified virtual network state on the service side. When the Set-AzVirtualNetwork cmdlet is executed, the backendSubnet is removed. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetwork +Specifies a virtual network object representing the state to which the virtual network should be set. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) + +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) + +[New-AzVirtualNetwork](./New-AzVirtualNetwork.md) + +[Remove-AzVirtualNetwork](./Remove-AzVirtualNetwork.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzVirtualNetworkGateway.md b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkGateway.md new file mode 100644 index 0000000000..c156dfe367 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkGateway.md @@ -0,0 +1,991 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 5C309071-A2ED-464C-9197-0A77859C8FBB +online version: https://learn.microsoft.com/powershell/module/az.network/set-azvirtualnetworkgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkGateway.md +--- + +# Set-AzVirtualNetworkGateway + +## SYNOPSIS +Updates a virtual network gateway. + +## SYNTAX + +### Default (Default) +``` +Set-AzVirtualNetworkGateway -VirtualNetworkGateway <PSVirtualNetworkGateway> [-GatewaySku <String>] + [-GatewayDefaultSite <PSLocalNetworkGateway>] [-VpnClientAddressPool <String[]>] + [-VpnClientProtocol <String[]>] [-VpnAuthenticationType <String[]>] + [-VpnClientRootCertificates <PSVpnClientRootCertificate[]>] + [-VpnClientRevokedCertificates <PSVpnClientRevokedCertificate[]>] [-VpnClientIpsecPolicy <PSIpsecPolicy[]>] + [-Asn <UInt32>] [-PeerWeight <Int32>] + [-IpConfigurationBgpPeeringAddresses <PSIpConfigurationBgpPeeringAddress[]>] [-EnableActiveActiveFeature] + [-EnablePrivateIpAddress <Boolean>] [-DisableActiveActiveFeature] [-RadiusServerAddress <String>] + [-RadiusServerSecret <SecureString>] [-RadiusServerList <PSRadiusServer[]>] [-AadTenantUri <String>] + [-AadAudienceId <String>] [-AadIssuerUri <String>] [-RemoveAadAuthentication] [-CustomRoute <String[]>] + [-NatRule <PSVirtualNetworkGatewayNatRule[]>] [-BgpRouteTranslationForNat <Boolean>] + [-VirtualNetworkGatewayPolicyGroup <PSVirtualNetworkGatewayPolicyGroup[]>] + [-ClientConnectionConfiguration <PSClientConnectionConfiguration[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateResourceWithTags +``` +Set-AzVirtualNetworkGateway -VirtualNetworkGateway <PSVirtualNetworkGateway> [-GatewaySku <String>] + [-GatewayDefaultSite <PSLocalNetworkGateway>] [-VpnClientAddressPool <String[]>] + [-VpnClientProtocol <String[]>] [-VpnAuthenticationType <String[]>] + [-VpnClientRootCertificates <PSVpnClientRootCertificate[]>] + [-VpnClientRevokedCertificates <PSVpnClientRevokedCertificate[]>] [-VpnClientIpsecPolicy <PSIpsecPolicy[]>] + [-Asn <UInt32>] [-PeerWeight <Int32>] + [-IpConfigurationBgpPeeringAddresses <PSIpConfigurationBgpPeeringAddress[]>] [-EnableActiveActiveFeature] + [-EnablePrivateIpAddress <Boolean>] [-DisableActiveActiveFeature] [-RadiusServerAddress <String>] + [-RadiusServerSecret <SecureString>] [-RadiusServerList <PSRadiusServer[]>] [-AadTenantUri <String>] + [-AadAudienceId <String>] [-AadIssuerUri <String>] [-RemoveAadAuthentication] [-CustomRoute <String[]>] + [-NatRule <PSVirtualNetworkGatewayNatRule[]>] [-BgpRouteTranslationForNat <Boolean>] + [-VirtualNetworkGatewayPolicyGroup <PSVirtualNetworkGatewayPolicyGroup[]>] + [-ClientConnectionConfiguration <PSClientConnectionConfiguration[]>] -Tag <Hashtable> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVirtualNetworkGateway** cmdlet updates a virtual network gateway. + +## EXAMPLES + +### Example 1: Update a virtual network gateway's ASN +```powershell +$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001" +Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -Asn 1337 +``` + +The first command gets a virtual network gateway named Gateway01 that belongs to resource group ResourceGroup001 and stores it to the variable named $Gateway +The second command updates the virtual network gateway stored in variable $Gateway. +The command also sets the ASN to 1337. + +### Example 2: Add IPsec policy to a virtual network gateway +```powershell +$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001" +$vpnclientipsecpolicy = New-AzVpnClientIpsecPolicy -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTime 86472 -SADataSize 429497 -IkeEncryption AES256 -IkeIntegrity SHA256 -DhGroup DHGroup2 -PfsGroup None +Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -VpnClientIpsecPolicy $vpnclientipsecpolicy +``` + +The first command gets a virtual network gateway named Gateway01 that belongs to resource group ResourceGroup001 and stores it to the variable named $Gateway +The second command creates the Vpn ipsec policy object as per specified ipsec parameters. +The third command updates the virtual network gateway stored in variable $Gateway. +The command also sets the custom vpn ipsec policy specified in the $vpnclientipsecpolicy object on Virtual network gateway. + +### Example 3: Add/Update Tags to an existing virtual network gateway +```powershell +$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001" +Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -Tag @{ testtagKey="SomeTagKey"; testtagValue="SomeKeyValue" } +``` + +```output +Name : Gateway001 +ResourceGroupName : ResourceGroup001 +Location : westus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : + Name Value + ============ ============ + testtagValue SomeKeyValue + testtagKey SomeTagKey + +IpConfigurations : [ + { + "PrivateIpAllocationMethod": "Dynamic", + "Subnet": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/GatewaySubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/publicIPAddresses/Gateway001Ip" + }, + "Name": "vng1ipConfig", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/Gateway001IpConfig" + } + ] +GatewayType : Vpn +VpnType : RouteBased +EnableBgp : False +ActiveActive : False +GatewayDefaultSite : null +Sku : { + "Capacity": 2, + "Name": "VpnGw1", + "Tier": "VpnGw1" + } +VpnClientConfiguration : null +BgpSettings : { + "Asn": 65515, + "BgpPeeringAddress": "1.2.3.4", + "PeerWeight": 0 + } +``` + +The first command gets a virtual network gateway named Gateway01 that belongs to resource group ResourceGroup001 and stores it to the variable named $Gateway +The second command updates the virtual network gateway Gateway01 with the tags @{ testtagKey="SomeTagKey"; testtagValue="SomeKeyValue" }. + +### Example 4: Add/Update AAD authentication configuration for VpnClient of an existing virtual network gateway +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001" +Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -AadTenantUri "https://login.microsoftonline.com/0ab2c4f4-81e6-44cc-a0b2-b3a47a1443f4" -AadIssuerUri "https://sts.windows.net/0ab2c4f4-81e6-44cc-a0b2-b3a47a1443f4/" -AadAudienceId "a21fce82-76af-45e6-8583-a08cb3b956f9" + +Name : Gateway001 +ResourceGroupName : ResourceGroup001 +Location : westus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : + Name Value + ============ ============ + testtagValue SomeKeyValue + testtagKey SomeTagKey + +IpConfigurations : [ + { + "PrivateIpAllocationMethod": "Dynamic", + "Subnet": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/GatewaySubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/publicIPAddresses/Gateway001Ip" + }, + "Name": "vng1ipConfig", + "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/Gateway001IpConfig" + } + ] +GatewayType : Vpn +VpnType : RouteBased +EnableBgp : False +ActiveActive : False +GatewayDefaultSite : null +Sku : { + "Capacity": 2, + "Name": "VpnGw1", + "Tier": "VpnGw1" + } +vpnClientConfiguration : { + "vpnClientProtocols": [ + "OpenVPN" + ], + + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.10.0.0/16" + ] + }, + "vpnClientRootCertificates": "", + "vpnClientRevokedCertificates": "", + + "radiusServerAddress": "", + "radiusServerSecret": "", + "aadTenantUri": "https://login.microsoftonline.com/0ab2c4f4-81e6-44cc-a0b2-b3a47a1443f4\", + "aadAudienceId": "a21fce82-76af-45e6-8583-a08cb3b956g9\", + "aadIssuerUri": "https://sts.windows.net/0ab2c4f4-81e6-44cc-a0b2-b3a47a1443f4/\" + }, +BgpSettings : { + "Asn": 65515, + "BgpPeeringAddress": "1.2.3.4", + "PeerWeight": 0 + } + +Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -VpnClientRootCertificates $rootCert -RemoveAadAuthentication +``` + +The first command gets a virtual network gateway named Gateway01 that belongs to resource group ResourceGroup001 and stores it to the variable named $Gateway +The second command updates the virtual network gateway Gateway01 with the AAD authentication configurations params:aadTenantUri, aadAudienceId, aadIssuerUri for VpnClient. +The third command removes the AAD authentication configuration from VpnClient of virtual network gateway. + +### Example 5: Add/Update IpConfigurationBgpPeeringAddresses to an existing virtual network gateway +```powershell +$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001" +$ipconfigurationId1 = '/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default' +$addresslist1 = @('169.254.21.25') +$gw1ipconfBgp1 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId1 -CustomAddress $addresslist1 +Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -IpConfigurationBgpPeeringAddresses $gw1ipconfBgp1 +``` + +```output +Name : Gateway001 +ResourceGroupName : ResourceGroup001 +Location : westcentralus +Id : /subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001 +Etag : W/"a08f13d3-6106-44e0-9127-e35e6f9793d5" +ResourceGuid : 30993429-a1ed-42ca-9862-9156b013626e +ProvisioningState : Succeeded +Tags : +IpConfigurations : [ + { + "PrivateIpAllocationMethod": "Dynamic", + "Subnet": { + "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworks/newApipaNet/subnets/GatewaySubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/publicIPAddresses/newapipaip" + }, + "Name": "default", + "Etag": "W/\"a08f13d3-6106-44e0-9127-e35e6f9793d5\"", + "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default" + } + ] +GatewayType : Vpn +VpnType : RouteBased +EnableBgp : False +ActiveActive : False +GatewayDefaultSite : null +Sku : { + "Capacity": 2, + "Name": "VpnGw1", + "Tier": "VpnGw1" + } +VpnClientConfiguration : null +BgpSettings : { + "Asn": 65515, + "BgpPeeringAddress": "10.1.255.30", + "PeerWeight": 0, + "BgpPeeringAddresses": [ + { + "IpconfigurationId": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default", + "DefaultBgpIpAddresses": [ + "10.1.255.30" + ], + "CustomBgpIpAddresses": [ + "169.254.21.55" + ], + "TunnelIpAddresses": [ + "13.78.146.151" + ] + } + ] + } +``` + +The first command gets a virtual network gateway named Gateway01 that belongs to resource group ResourceGroup001 and stores it to the variable named $Gateway +The second command assigns the value of virtual network gateway Gateway01 IpConfiguration Id into variable ipconfigurationId1. +The third command assigns the address list into addresslist1. +The fourth command created a PSIpConfigurationBgpPeeringAddress object. +The fifth command set this new created PSIpConfigurationBgpPeeringAddress to IpConfigurationBgpPeeringAddresses and update the gateway. + +### Example 6: Update/Remove CustomAddress to an existing IpConfigurationBgpPeeringAddresses of virtual network gateway +```powershell +$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001" +$ipconfigurationId1 = '/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default' +$addresslist1 = @() +$gw1ipconfBgp1 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId1 -CustomAddress $addresslist1 +Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -IpConfigurationBgpPeeringAddresses $gw1ipconfBgp1 +``` + +```output +Name : Gateway001 +ResourceGroupName : ResourceGroup001 +Location : westcentralus +Id : /subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001 +Etag : W/"a08f13d3-6106-44e0-9127-e35e6f9793d5" +ResourceGuid : 30993429-a1ed-42ca-9862-9156b013626e +ProvisioningState : Succeeded +Tags : +IpConfigurations : [ + { + "PrivateIpAllocationMethod": "Dynamic", + "Subnet": { + "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworks/newApipaNet/subnets/GatewaySubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/publicIPAddresses/newapipaip" + }, + "Name": "default", + "Etag": "W/\"a08f13d3-6106-44e0-9127-e35e6f9793d5\"", + "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default" + } + ] +GatewayType : Vpn +VpnType : RouteBased +EnableBgp : False +ActiveActive : False +GatewayDefaultSite : null +Sku : { + "Capacity": 2, + "Name": "VpnGw1", + "Tier": "VpnGw1" + } +VpnClientConfiguration : null +BgpSettings : { + "Asn": 65515, + "BgpPeeringAddress": "10.1.255.30", + "PeerWeight": 0, + "BgpPeeringAddresses": [ + { + "IpconfigurationId": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default", + "DefaultBgpIpAddresses": [ + "10.1.255.30" + ], + "CustomBgpIpAddresses": [], + "TunnelIpAddresses": [ + "13.78.146.151" + ] + } + ] + } +``` + +The first command gets a virtual network gateway named Gateway01 that belongs to resource group ResourceGroup001 and stores it to the variable named $Gateway +The second command assigns the value of virtual network gateway Gateway01 IpConfiguration Id into variable ipconfigurationId1. +The third command assigns the address list into addresslist1. +The fourth command created a PSIpConfigurationBgpPeeringAddress object. +The fifth command set this new created PSIpConfigurationBgpPeeringAddress to IpConfigurationBgpPeeringAddresses and update the gateway. + +### Example 7: Add/Update NatRules to an existing virtual network gateway +```powershell +$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001" +$vngNatRules = $Gateway.NatRules +$natRule = New-AzVirtualNetworkGatewayNatRule -Name "natRule1" -Type "Static" -Mode "IngressSnat" -InternalMapping @("25.0.0.0/16") -ExternalMapping @("30.0.0.0/16") +$vngNatRules.Add($natrule) +Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -NatRule $vngNatRules.NatRules -BgpRouteTranslationForNat $true +``` + +```output +Name : Gateway001 +ResourceGroupName : ResourceGroup001 +Location : westcentralus +Id : /subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001 +Etag : W/"a08f13d3-6106-44e0-9127-e35e6f9793d5" +ResourceGuid : 30993429-a1ed-42ca-9862-9156b013626e +ProvisioningState : Succeeded +Tags : +IpConfigurations : [ + { + "PrivateIpAllocationMethod": "Dynamic", + "Subnet": { + "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworks/newApipaNet/subnets/GatewaySubnet" + }, + "PublicIpAddress": { + "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/publicIPAddresses/newapipaip" + }, + "Name": "default", + "Etag": "W/\"a08f13d3-6106-44e0-9127-e35e6f9793d5\"", + "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default" + } + ] +GatewayType : Vpn +VpnType : RouteBased +EnableBgp : False +ActiveActive : False +GatewayDefaultSite : null +Sku : { + "Capacity": 2, + "Name": "VpnGw1", + "Tier": "VpnGw1" + } +VpnClientConfiguration : null +BgpSettings : { + "Asn": 65515, + "BgpPeeringAddress": "10.1.255.30", + "PeerWeight": 0, + "BgpPeeringAddresses": [ + { + "IpconfigurationId": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default", + "DefaultBgpIpAddresses": [ + "10.1.255.30" + ], + "CustomBgpIpAddresses": [ + "169.254.21.55" + ], + "TunnelIpAddresses": [ + "13.78.146.151" + ] + } + ] + } +NatRules : [ + { + "VirtualNetworkGatewayNatRulePropertiesType": "Static", + "Mode": "IngressSnat", + "InternalMappings": [ + { + "AddressSpace": "25.0.0.0/16" + } + ], + "ExternalMappings": [ + { + "AddressSpace": "30.0.0.0/16" + } + ], + "ProvisioningState": "Succeeded", + "Name": "natRule1", + "Etag": "W/\"5150d788-e165-42ba-99c4-8138a545fce9\"", + "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/natRules/natRule1" + } + ] +EnableBgpRouteTranslationForNat : True +``` + +The first command gets a virtual network gateway named Gateway01 that belongs to resource group ResourceGroup001 and stores it to the variable named $Gateway +The second command assigns the existing natrules into variable vngNatRules. +The third command assigns the value newly created PSVirtualNetworkGatewayNatRule object natrule into variable natRule. +The fourth command add this PSVirtualNetworkGatewayNatRule object into vngNatRules list. +The fifth command set this new created PSVirtualNetworkGatewayNatRule to NatRules of gateway and update the gateway. + +### Example 8: Delete multiple expired VpnClientRootCertificates of an existing virtual network gateway +```powershell +$Gateway=Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001" + +$rootCerts=$Gateway.VpnClientConfiguration.VpnClientRootCertificates + +$rootCerts.Count +$rootCerts[0] +$rootCerts[1] +$rootCerts.Remove($rootCerts[1]) + +$Gateway1 = Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -VpnClientRootCertificates $rootCerts +``` + +The first command gets a virtual network gateway named Gateway01 that belongs to resource group ResourceGroup001 and stores it to the variable named $Gateway +The second command gets all the root certificates on VirtualNetworkGateway and save it to another variable $rootCerts +The third command shows total existing root certs on VirtualNetworkGateway. +The forth & fifth commands print root certificates at those corresponding indices for customer to see which ones they want to delete. +The sixth command removes expired root certificate by using that index e.g. here 1. Repeat same steps to remove multiple expired certificates from variable: $rootCerts +The seventh command updates VirtualNetworkGateway to set valid root certificates i.e. certificates that exists in variable: $rootCerts + +## PARAMETERS + +### -AadAudienceId +P2S AAD authentication option:AadAudienceId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AadIssuerUri +P2S AAD authentication option:AadIssuerUri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AadTenantUri +P2S AAD authentication option:AadTenantUri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Asn +The virtual network gateway's ASN, used to set up BGP sessions inside IPsec tunnels + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BgpRouteTranslationForNat +This will enable and disable BgpRouteTranslationForNat on this VirtualNetworkGateway + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientConnectionConfiguration +P2S Client Connection Configuration that assiociate between address and policy group + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSClientConnectionConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CustomRoute +Custom routes AddressPool specified by customer + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableActiveActiveFeature +Flag to disable Active Active feature on virtual network gateway + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableActiveActiveFeature +Flag to enable Active Active feature on virtual network gateway + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePrivateIpAddress +Flag to enable Active Active feature on virtual network gateway + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayDefaultSite +The default site to use for force tunneling. +If a default site is specified, all internet traffic from the gateway's vnet is routed to that site. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GatewaySku +The virtual network gateway's SKU + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3, VpnGw4, VpnGw5, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, VpnGw4AZ, VpnGw5AZ, ErGw1AZ, ErGw2AZ, ErGw3AZ + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpConfigurationBgpPeeringAddresses +The BgpPeeringAddresses for Virtual network gateway bgpsettings. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpConfigurationBgpPeeringAddress[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NatRule +The NatRules for Virtual network gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayNatRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerWeight +The weight added to routes learned over BGP from this virtual network gateway + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RadiusServerAddress +P2S External Radius server address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RadiusServerList +P2S multiple external Radius servers. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRadiusServer[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RadiusServerSecret +P2S External Radius server secret. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RemoveAadAuthentication +Flag to remove AAD authentication for P2S client from virtual network gateway. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +P2S External Radius server address. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateResourceWithTags +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkGateway +The virtual network gateway object to base modifications off of. +This can be retrieved using Get-AzVirtualNetworkGateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayPolicyGroup +P2S policy group added to this gateway + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayPolicyGroup[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnAuthenticationType +The list of P2S VPN client authentication types. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: Certificate, Radius, AAD + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientAddressPool +The address space to allocate VPN client IP addresses from. +This should not overlap with virtual network or on-premise ranges. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientIpsecPolicy +A list of IPSec policies for P2S VPN client tunneling protocols. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientProtocol +A list of P2S VPN client tunneling protocols + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: SSTP, IkeV2, OpenVPN + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientRevokedCertificates +A list of revoked VPN client certificates. +A VPN client presenting a certificate that matches one of these will be told to go away. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VpnClientRootCertificates +A list of VPN client root certificates to use for VPN client authentication. +Connecting VPN clients must present certificates generated from one of these root certificates. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway + +### System.String[] + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate[] + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate[] + +### Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy[] + +### System.UInt32 + +### System.Int32 + +### Microsoft.Azure.Commands.Network.Models.PSIpConfigurationBgpPeeringAddress[] + +### System.Security.SecureString + +### Microsoft.Azure.Commands.Network.Models.PSRadiusServer[] + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayNatRule[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Set-AzVirtualNetworkGatewayConnection.md b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkGatewayConnection.md new file mode 100644 index 0000000000..d30a0813d7 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkGatewayConnection.md @@ -0,0 +1,543 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: D7065B04-1A01-4BB4-A519-1DA9002CDE02 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azvirtualnetworkgatewayconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkGatewayConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkGatewayConnection.md +--- + +# Set-AzVirtualNetworkGatewayConnection + +## SYNOPSIS +Configures a virtual network gateway connection. + +## SYNTAX + +### Default (Default) +``` +Set-AzVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection <PSVirtualNetworkGatewayConnection> + [-EnableBgp <Boolean>] [-DpdTimeoutInSeconds <Int32>] [-ConnectionMode <String>] + [-UsePolicyBasedTrafficSelectors <Boolean>] [-UseLocalAzureIpAddress <Boolean>] + [-IpsecPolicies <PSIpsecPolicy[]>] [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] + [-IngressNatRule <PSResourceId[]>] [-EgressNatRule <PSResourceId[]>] + [-GatewayCustomBgpIpAddress <PSGatewayCustomBgpIpConfiguration[]>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateResourceWithTags +``` +Set-AzVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection <PSVirtualNetworkGatewayConnection> + [-EnableBgp <Boolean>] [-DpdTimeoutInSeconds <Int32>] [-ConnectionMode <String>] + [-UsePolicyBasedTrafficSelectors <Boolean>] [-UseLocalAzureIpAddress <Boolean>] + [-IpsecPolicies <PSIpsecPolicy[]>] [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] + [-IngressNatRule <PSResourceId[]>] [-EgressNatRule <PSResourceId[]>] + [-GatewayCustomBgpIpAddress <PSGatewayCustomBgpIpConfiguration[]>] -Tag <Hashtable> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVirtualNetworkGatewayConnection** cmdlet configures a virtual network gateway connection. + +## EXAMPLES + +### Example 1: +```powershell +$conn = Get-AzVirtualNetworkGatewayConnection -Name 1 -ResourceGroupName myRG +Set-AzVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection $conn +``` + +```output +Confirm +Are you sure you want to overwrite resource '1' +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y + + +Name : 1 +ResourceGroupName : myRG +Location : westus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Mi + crosoft.Network/connections/1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : +AuthorizationKey : +VirtualNetworkGateway1 : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/M + icrosoft.Network/virtualNetworkGateways/myGateway" +VirtualNetworkGateway2 : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/S2SVnetConn/providers/Mic + rosoft.Network/virtualNetworkGateways/S2SConnGW" +LocalNetworkGateway2 : +Peer : +RoutingWeight : 0 +SharedKey : +ConnectionStatus : Connected +EgressBytesTransferred : 91334484 +IngressBytesTransferred : 100386089 +TunnelConnectionStatus : [] +``` + +### Example 2: Add/Update tags to an existing VirtualNetworkGatewayConnection +```powershell +$conn = Get-AzVirtualNetworkGatewayConnection -Name 1 -ResourceGroupName myRG +Set-AzVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection $conn -Tag @{ testtagKey="SomeTagKey"; testtagValue="SomeKeyValue" } +``` + +```output +Confirm +Are you sure you want to overwrite resource '1' +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y + + +Name : 1 +ResourceGroupName : myRG +Location : westus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Mi + crosoft.Network/connections/1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : + Name Value + ============ ============ + testtagValue SomeKeyValue + testtagKey SomeTagKey +AuthorizationKey : +VirtualNetworkGateway1 : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/M + icrosoft.Network/virtualNetworkGateways/myGateway" +VirtualNetworkGateway2 : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/S2SVnetConn/providers/Mic + rosoft.Network/virtualNetworkGateways/S2SConnGW" +LocalNetworkGateway2 : +Peer : +RoutingWeight : 0 +SharedKey : +ConnectionStatus : Connected +EgressBytesTransferred : 91334484 +IngressBytesTransferred : 100386089 +TunnelConnectionStatus : [] +``` + +### Example 3: Add/Remove natRules to an existing VirtualNetworkGatewayConnection +```powershell +$conn = Get-AzVirtualNetworkGatewayConnection -Name 1 -ResourceGroupName myRG +$egressNatrule = Get-AzVirtualNetworkGatewayNatRule -ResourceGroupName myRG -Name "natRule1" -ParentResourceName "gw1" +Set-AzVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection $conn -IngressNatRule @() -EgressNatRule $egressNatrule +``` + +```output +Confirm +Are you sure you want to overwrite resource '1' +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y + + +Name : 1 +ResourceGroupName : myRG +Location : westus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Mi + crosoft.Network/connections/1 +Etag : W/"00000000-0000-0000-0000-000000000000" +ResourceGuid : 00000000-0000-0000-0000-000000000000 +ProvisioningState : Succeeded +Tags : + Name Value + ============ ============ + testtagValue SomeKeyValue + testtagKey SomeTagKey +AuthorizationKey : +VirtualNetworkGateway1 : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/M + icrosoft.Network/virtualNetworkGateways/myGateway" +VirtualNetworkGateway2 : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/S2SVnetConn/providers/Mic + rosoft.Network/virtualNetworkGateways/S2SConnGW" +LocalNetworkGateway2 : +Peer : +RoutingWeight : 0 +SharedKey : +ConnectionStatus : Connected +EgressBytesTransferred : 91334484 +IngressBytesTransferred : 100386089 +TunnelConnectionStatus : [] +IngressNatRules : [] +EgressNatRules : [ + { + "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworkGateways/gw1/natRules/natRule1" + } + ] +``` + +The first command gets a virtual network gateway connection named 1 that belongs to resource group myRG and stores it to the variable named $conn. +The second command gets the virtual network gateway natRule named natRule1 and stores it to the variable named $egressNatrule. +The third command sets virtual network gateway connection with removed all IngressNatRules and add egressNatrule into EgressNatRules. + +### Example 3: Add/Remove GatewayCustomBgpIpAddress to an existing VirtualNetworkGatewayConnection +```powershell +$address1 = New-AzGatewayCustomBgpIpConfigurationObject -IpConfigurationId "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw/ipConfigurations/default" -CustomBgpIpAddress "169.254.21.1" +$address2 = New-AzGatewayCustomBgpIpConfigurationObject -IpConfigurationId "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw/ipConfigurations/ActiveActive" -CustomBgpIpAddress "169.254.21.3" +$conn = Get-AzVirtualNetworkGatewayConnection -ResourceGroupName PS_testing -ResourceName Conn + +Set-AzVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection $conn -GatewayCustomBgpIpAddress $address1,$address2 +``` + +```output +Name : Conn +ResourceGroupName : PS_testing +Location : eastus +Id : /subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/connections/Conn +Etag : W/"e867e7bb-fa2e-436e-8822-70c556ec0f03" +ResourceGuid : 9c33f4f7-b09c-4080-932e-a44405a8c252 +ProvisioningState : Succeeded +Tags : +AuthorizationKey : +VirtualNetworkGateway1 : "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw" +VirtualNetworkGateway2 : +LocalNetworkGateway2 : "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/localNetworkGateways/testLng" +Peer : +RoutingWeight : 3 +SharedKey : abc +ExpressRouteGatewayBypass : False +EnablePrivateLinkFastPath : False +ConnectionStatus : Unknown +EgressBytesTransferred : 0 +IngressBytesTransferred : 0 +TunnelConnectionStatus : [] +IngressNatRules : [] +EgressNatRules : [] +GatewayCustomBgpIpAddresses : [ + { + "IpconfigurationId": + "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw/ipConfigurations/default", + "CustomBgpIpAddress": "169.254.21.1" + }, + { + "IpconfigurationId": + "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw/ipConfigurations/ActiveActive", + "CustomBgpIpAddress": "169.254.21.3" + } + ] +``` + +This will create new AzGatewayCustomBgpIpConfigurationObjects and update gateway connection with these GatewayCustomBgpIpAddress. + +### Example 4: Remove GatewayCustomBgpIpAddress to an existing VirtualNetworkGatewayConnection +```powershell +$conn = Get-AzVirtualNetworkGatewayConnection -ResourceGroupName PS_testing -ResourceName Conn +Set-AzVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection $conn -GatewayCustomBgpIpAddress @() +``` + +```output +Name : Conn +ResourceGroupName : PS_testing +Location : eastus +Id : /subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/connections/Conn +Etag : W/"863d9b89-a030-42ba-9f71-58d5bc3336a9" +ResourceGuid : 9c33f4f7-b09c-4080-932e-a44405a8c252 +ProvisioningState : Succeeded +Tags : +AuthorizationKey : +VirtualNetworkGateway1 : "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw" +VirtualNetworkGateway2 : +LocalNetworkGateway2 : "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/localNetworkGateways/testLng" +Peer : +RoutingWeight : 3 +SharedKey : abc +ExpressRouteGatewayBypass : False +EnablePrivateLinkFastPath : False +ConnectionStatus : NotConnected +EgressBytesTransferred : 0 +IngressBytesTransferred : 0 +TunnelConnectionStatus : [] +IngressNatRules : [] +EgressNatRules : [] +GatewayCustomBgpIpAddresses : [] +``` + +This will update gateway connection with removing these GatewayCustomBgpIpAddress. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionMode +Virtual Network Gateway Connection Mode. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DpdTimeoutInSeconds +Dead Peer Detection Timeout of the connection in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EgressNatRule +The list of egress NAT rules that are associated with this Connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSResourceId[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBgp +Whether to use a BGP session over a S2S VPN tunnel + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayCustomBgpIpAddress +The GatewayCustomBgpIpAddress of Virtual network gateway used in this connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSGatewayCustomBgpIpConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IngressNatRule +The list of ingress NAT rules that are associated with this Connection. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSResourceId[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpsecPolicies +A list of IPSec policies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateResourceWithTags +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficSelectorPolicy +A list of traffic selector policies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSTrafficSelectorPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UseLocalAzureIpAddress +Whether to use PrivateIP for a S2S connection + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePolicyBasedTrafficSelectors +Whether to use policy-based traffic selectors for a S2S connection + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayConnection +The VirtualNetworkGatewayConnection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection + +### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +### Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy[] + +### Microsoft.Azure.Commands.Network.Models.PSTrafficSelectorPolicy[] + +### Microsoft.Azure.Commands.Network.Models.PSGatewayCustomBgpIpConfiguration[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkGatewayConnection](./Get-AzVirtualNetworkGatewayConnection.md) + +[New-AzVirtualNetworkGatewayConnection](./New-AzVirtualNetworkGatewayConnection.md) + +[Remove-AzVirtualNetworkGatewayConnection](./Remove-AzVirtualNetworkGatewayConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Set-AzVirtualNetworkGatewayConnectionSharedKey.md b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkGatewayConnectionSharedKey.md new file mode 100644 index 0000000000..7ca9880024 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkGatewayConnectionSharedKey.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 78BADAF3-6001-4A25-A74D-F6B50079FCB4 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azvirtualnetworkgatewayconnectionsharedkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkGatewayConnectionSharedKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkGatewayConnectionSharedKey.md +--- + +# Set-AzVirtualNetworkGatewayConnectionSharedKey + +## SYNOPSIS +Configures the shared key of the virtual network gateway connection. + +## SYNTAX + +``` +Set-AzVirtualNetworkGatewayConnectionSharedKey -Name <String> -ResourceGroupName <String> -Value <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVirtualNetworkGatewayConnectionSharedKey** cmdlet configures the shared key of the virtual network gateway connection. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzVirtualNetworkGatewayConnectionSharedKey -ResourceGroupName VPNGatewayV3 -Name VNet1toVNet2 -Value abcd1234 +``` + +```output +Confirm +Are you sure you want to overwrite resource 'VNet1toVNet2' +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +abcd1234 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual network gateway shared key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the virtual network gateway belongs to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Specifies the value of the shared key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkGatewayConnectionSharedKey](./Get-AzVirtualNetworkGatewayConnectionSharedKey.md) + +[Reset-AzVirtualNetworkGatewayConnectionSharedKey](./Reset-AzVirtualNetworkGatewayConnectionSharedKey.md) diff --git a/azps-10.1.0/Az.Network/Set-AzVirtualNetworkGatewayDefaultSite.md b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkGatewayDefaultSite.md new file mode 100644 index 0000000000..9e3be307d6 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkGatewayDefaultSite.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: A27EE9C0-C7F5-4BF6-AE52-58087BD1B1C3 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azvirtualnetworkgatewaydefaultsite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkGatewayDefaultSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkGatewayDefaultSite.md +--- + +# Set-AzVirtualNetworkGatewayDefaultSite + +## SYNOPSIS +Sets the default site for a virtual network gateway. + +## SYNTAX + +``` +Set-AzVirtualNetworkGatewayDefaultSite -VirtualNetworkGateway <PSVirtualNetworkGateway> + -GatewayDefaultSite <PSLocalNetworkGateway> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVirtualNetworkGatewayDefaultSite** cmdlet assigns a forced tunneling default site to a virtual network gateway. +Forced tunneling provides a way for you to redirect Internet-bound traffic from Azure virtual machines to your on-premises network; this enables you to inspect and audit traffic before releasing it. +Forced tunneling is carried out by using a virtual private network (VPN) tunnel; this tunnel requires a default site, a local gateway where all the Azure Internet-bound traffic is redirected. +**Set-AzVirtualNetworkGatewayDefaultSite** provides a way to change the default site assigned to a gateway. + +## EXAMPLES + +### Example 1: Assign a default site to a virtual network gateway +```powershell +$LocalGateway = Get-AzLocalNetworkGateway -Name "ContosoLocalGateway " -ResourceGroupName "ContosoResourceGroup" +$VirtualGateway = Get-AzVirtualNetworkGateway -Name "ContosoVirtualGateway" +Set-AzVirtualNetworkGatewayDefaultSite -GatewayDefaultSite $LocalGateway -VirtualNetworkGateway $VirtualGateway +``` + +This example assigns a default site to a virtual network gateway named ContosoVirtualGateway. +The first command creates an object reference to a local gateway named ContosoLocalGateway. +This object reference that is stored in the variable named $LocalGateway represents the gateway to be configured as the default site +. +The second command then creates an object reference to the virtual network gateway and stores the result in the variable named $VirtualGateway. +The third command uses the **Set-AzVirtualNetworkGatewayDefaultSite** cmdlet to assign the default site to ContosoVirtualGateway. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayDefaultSite +Specifies an object reference to the local network gateway to be assigned as the default site for the specified virtual network. +You can use the Get-AzLocalNetworkGateway cmdlet to create an object reference to a local gateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGateway +Specifies an object reference to the virtual network gateway where the default site will be assigned. +You can create an object reference to a virtual network gateway by using the **Get-AzVirtualNetworkGateway** and specifying the name of the gateway. +The variable $VirtualGateway can then be used as the parameter value for the *VirtualNetworkGateway* parameter: + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +## NOTES + +## RELATED LINKS + +[Get-AzLocalNetworkGateway](./Get-AzLocalNetworkGateway.md) + +[Get-AzVirtualNetworkGateway](./Get-AzVirtualNetworkGateway.md) + +[Remove-AzVirtualNetworkGatewayDefaultSite](./Remove-AzVirtualNetworkGatewayDefaultSite.md) + + diff --git a/azps-10.1.0/Az.Network/Set-AzVirtualNetworkPeering.md b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkPeering.md new file mode 100644 index 0000000000..ab398100e8 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkPeering.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 06DAD751-3A43-4EF6-94C5-AA7AC1A67FC8 +online version: https://learn.microsoft.com/powershell/module/az.network/set-azvirtualnetworkpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkPeering.md +--- + +# Set-AzVirtualNetworkPeering + +## SYNOPSIS +Configures a virtual network peering. + +## SYNTAX + +``` +Set-AzVirtualNetworkPeering -VirtualNetworkPeering <PSVirtualNetworkPeering> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVirtualNetworkPeering** cmdlet configures a virtual network peering. + +## EXAMPLES + +### Example 1: Change forwarded traffic configuration of a virtual network peering +```powershell +# Get the virtual network peering you want to update information for +$myVnet1ToMyVnet2 = Get-AzVirtualNetworkPeering -VirtualNetworkName "myVnet1" -ResourceGroupName "ResourceGroup" -Name "myVnet1ToMyVnet2" + +# Change value of AllowForwardedTraffic property +$myVnet1ToMyVnet2.AllowForwardedTraffic = $True + +# Update the peering with changes made +Set-AzVirtualNetworkPeering -VirtualNetworkPeering $myVnet1ToMyVnet2 +``` + +### Example 2: Change virtual network access of a virtual network peering +```powershell +# Get the virtual network peering +$myVnet1TomyVnet2 = Get-AzVirtualNetworkPeering -VirtualNetworkName "myVnet1" -ResourceGroupName "myResourceGroup" -Name "myVnet1TomyVnet2" + +# Change AllowVirtualNetworkAccess property +$myVnet1TomyVnet2.AllowVirtualNetworkAccess = $False + +# Update virtual network peering +Set-AzVirtualNetworkPeering -VirtualNetworkPeering $myVnet1TomyVnet2 +``` + +### Example 3: Change gateway transit property configuration of a virtual network peering +```powershell +# Get the virtual network peering +$myVnet1TomyVnet2 = Get-AzVirtualNetworkPeering -VirtualNetworkName "myVnet1" -ResourceGroupName "myResourceGroup" -Name "myVnet1TomyVnet2" + +# Change AllowGatewayTransit property +$myVnet1TomyVnet2.AllowGatewayTransit = $True + +# Update the virtual network peering +Set-AzVirtualNetworkPeering -VirtualNetworkPeering $myVnet1TomyVnet2 +``` + +### Example 4: Use remote gateways in virtual network peering +```powershell +# Get the virtual network peering +$myVnet1TomyVnet2 = Get-AzVirtualNetworkPeering -VirtualNetworkName "myVnet1" -ResourceGroupName "ResourceGroup001" -Name "myVnet1TomyVnet2" + +# Change the UseRemoteGateways property +$myVnet1TomyVnet2.UseRemoteGateways = $True + +# Update the virtual network peering +Set-AzVirtualNetworkPeering -VirtualNetworkPeering $myVnet1TomyVnet2 +``` + +By changing this property to $True, your peer's VNet gateway can be used. +However, the peer VNet must have a gateway configured and **AllowGatewayTransit** must have a value of $True. +This property cannot be used if a gateway has already been configured. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkPeering +Specifies the virtual network peering. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering + +## NOTES + +## RELATED LINKS + +[Add-AzVirtualNetworkPeering](./Add-AzVirtualNetworkPeering.md) + +[Get-AzVirtualNetworkPeering](./Get-AzVirtualNetworkPeering.md) + +[Remove-AzVirtualNetworkPeering](./Remove-AzVirtualNetworkPeering.md) + +[Sync-AzVirtualNetworkPeering](./Sync-AzVirtualNetworkPeering.md) diff --git a/azps-10.1.0/Az.Network/Set-AzVirtualNetworkSubnetConfig.md b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkSubnetConfig.md new file mode 100644 index 0000000000..d6452c0b55 --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkSubnetConfig.md @@ -0,0 +1,377 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: D1D51DEF-05DE-45C4-9013-A02A5B248EAC +online version: https://learn.microsoft.com/powershell/module/az.network/set-azvirtualnetworksubnetconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkSubnetConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkSubnetConfig.md +--- + +# Set-AzVirtualNetworkSubnetConfig + +## SYNOPSIS +Updates a subnet configuration for a virtual network. + +## SYNTAX + +### SetByResource (Default) +``` +Set-AzVirtualNetworkSubnetConfig -Name <String> -VirtualNetwork <PSVirtualNetwork> -AddressPrefix <String[]> + [-NetworkSecurityGroup <PSNetworkSecurityGroup>] [-RouteTable <PSRouteTable>] [-InputObject <PSNatGateway>] + [-ServiceEndpoint <String[]>] [-ServiceEndpointPolicy <PSServiceEndpointPolicy[]>] + [-Delegation <PSDelegation[]>] [-PrivateEndpointNetworkPoliciesFlag <String>] + [-PrivateLinkServiceNetworkPoliciesFlag <String>] [-IpAllocation <PSIpAllocation[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceId +``` +Set-AzVirtualNetworkSubnetConfig -Name <String> -VirtualNetwork <PSVirtualNetwork> -AddressPrefix <String[]> + [-NetworkSecurityGroupId <String>] [-RouteTableId <String>] [-ResourceId <String>] + [-ServiceEndpoint <String[]>] [-ServiceEndpointPolicy <PSServiceEndpointPolicy[]>] + [-Delegation <PSDelegation[]>] [-PrivateEndpointNetworkPoliciesFlag <String>] + [-PrivateLinkServiceNetworkPoliciesFlag <String>] [-IpAllocation <PSIpAllocation[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVirtualNetworkSubnetConfig** cmdlet updates a subnet configuration for a virtual network. + +## EXAMPLES + +### 1: Modify the address prefix of a subnet +```powershell +New-AzResourceGroup -Name TestResourceGroup -Location centralus + +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" + +$virtualNetwork = New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet + +Set-AzVirtualNetworkSubnetConfig -Name frontendSubnet -VirtualNetwork $virtualNetwork -AddressPrefix "10.0.3.0/23" + +$virtualNetwork | Set-AzVirtualNetwork +``` + +This example creates a virtual network with one subnet. Then is calls + Set-AzVirtualNetworkSubnetConfig to modify the AddressPrefix of the subnet. This + only impacts the in-memory representation of the virtual network. + Set-AzVirtualNetwork is then called to modify the virtual network in Azure. + +### 2: Add a network security group to a subnet +```powershell +New-AzResourceGroup -Name TestResourceGroup -Location centralus + +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" + +$virtualNetwork = New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet + +$rdpRule = New-AzNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 + +$networkSecurityGroup = New-AzNetworkSecurityGroup -ResourceGroupName TestResourceGroup -Location centralus -Name "NSG-FrontEnd" -SecurityRules $rdpRule + +Set-AzVirtualNetworkSubnetConfig -Name frontendSubnet -VirtualNetwork $virtualNetwork -AddressPrefix "10.0.1.0/24" -NetworkSecurityGroupId $networkSecurityGroup.Id + +$virtualNetwork | Set-AzVirtualNetwork +``` + +This example creates a resource group with one virtual network containing just one + subnet. It then creates a network security group with an allow rule for RDP traffic. The + Set-AzVirtualNetworkSubnetConfig cmdlet is used to modify the in-memory + representation of the frontend subnet so that it points to the newly created network + security group. The Set-AzVirtualNetwork cmdlet is then called to write the modified + state back to the service. + +### 3: Attach a Nat Gateway to a subnet +```powershell +$pip = New-AzPublicIpAddress -Name "pip" -ResourceGroupName "natgateway_test" ` + -Location "eastus2" -Sku "Standard" -IdleTimeoutInMinutes 4 -AllocationMethod "static" + +$natGateway = New-AzNatGateway -ResourceGroupName "natgateway_test" -Name "nat_gateway" ` + -IdleTimeoutInMinutes 4 -Sku "Standard" -Location "eastus2" -PublicIpAddress $pip + +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" + +$virtualNetwork = New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet + +Set-AzVirtualNetworkSubnetConfig -Name frontendSubnet -VirtualNetwork $virtualNetwork -InputObject $natGateway + +$virtualNetwork | Set-AzVirtualNetwork +``` + +## PARAMETERS + +### -AddressPrefix +Specifies a range of IP addresses for a subnet configuration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delegation +List of services that have permission to perform operations on this subnet. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSDelegation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +Specifies the nat gateway associated with the subnet configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNatGateway +Parameter Sets: SetByResource +Aliases: NatGateway + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IpAllocation +Specifies IpAllocations for a subnet. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpAllocation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a subnet configuration that this cmdlet configures. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSecurityGroup +Specifies a **NetworkSecurityGroup** object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkSecurityGroupId +Specifies the ID of a network security group. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateEndpointNetworkPoliciesFlag +Configure to enable or disable applying network policies on private endpoint in the subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateLinkServiceNetworkPoliciesFlag +Configure to enable or disable applying network policies on private link service in the subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the Id of NAT Gateway resource associated with the subnet configuration. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: NatGatewayId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteTable +Specifies the route table object that is associated with the network security group. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable +Parameter Sets: SetByResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteTableId +Specifies the ID of the route table object that is associated with the network security group. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceEndpoint +Service Endpoint Value + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceEndpointPolicy +Service Endpoint Policies + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetwork +Specifies the **VirtualNetwork** object that contains the subnet configuration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup + +### Microsoft.Azure.Commands.Network.Models.PSRouteTable + +### System.String[] + +### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy[] + +### Microsoft.Azure.Commands.Network.Models.PSDelegation[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +## NOTES + +## RELATED LINKS + +[Add-AzVirtualNetworkSubnetConfig](./Add-AzVirtualNetworkSubnetConfig.md) + +[Get-AzVirtualNetworkSubnetConfig](./Get-AzVirtualNetworkSubnetConfig.md) + +[New-AzVirtualNetworkSubnetConfig](./New-AzVirtualNetworkSubnetConfig.md) + +[Remove-AzVirtualNetworkSubnetConfig](./Remove-AzVirtualNetworkSubnetConfig.md) diff --git a/azps-10.1.0/Az.Network/Set-AzVirtualNetworkTap.md b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkTap.md new file mode 100644 index 0000000000..5b9bf34ced --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzVirtualNetworkTap.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azvirtualnetworktap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkTap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVirtualNetworkTap.md +--- + +# Set-AzVirtualNetworkTap + +## SYNOPSIS +Updates a virtual network tap. + +## SYNTAX + +``` +Set-AzVirtualNetworkTap -VirtualNetworkTap <PSVirtualNetworkTap> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVirtualNetworkTap** cmdlet updates a virtual network tap. + +## EXAMPLES + +### Example 1: Configure a Virtual network tap +```powershell +$vTap = Get-AzVirtualNetworkTap -ResourceGroupName "ResourceGroup1" -Name "VirtualTap1" +$vTap.DestinationNetworkInterfaceIPConfiguration = $newDestinationNic.IpConfigurations[0] +Set-AzVirtualNetworkTap -VirtualNetworkTap $vTap +``` + +The command updates the Destination IpConfiguration and updates the Virtual network tap. +If there are any tap configurations referencing it, then all the source traffic will not start be mirrored to new destination ip configuration post update. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkTap +The virtual network tap + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkTap](./Get-AzVirtualNetworkTap.md) + +[New-AzVirtualNetworkTap](./New-AzVirtualNetworkTap.md) + +[Remove-AzVirtualNetworkTap](./Remove-AzVirtualNetworkTap.md) diff --git a/azps-10.1.0/Az.Network/Set-AzVpnClientIpsecParameter.md b/azps-10.1.0/Az.Network/Set-AzVpnClientIpsecParameter.md new file mode 100644 index 0000000000..341a01aa0b --- /dev/null +++ b/azps-10.1.0/Az.Network/Set-AzVpnClientIpsecParameter.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/set-azvpnclientipsecparameter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVpnClientIpsecParameter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Set-AzVpnClientIpsecParameter.md +--- + +# Set-AzVpnClientIpsecParameter + +## SYNOPSIS +Sets the vpn ipsec parameters for existing virtual network gateway. + +## SYNTAX + +### ByFactoryName (Default) +``` +Set-AzVpnClientIpsecParameter -VirtualNetworkGatewayName <String> -ResourceGroupName <String> + -VpnClientIPsecParameter <PSVpnClientIPsecParameters> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByFactoryObject +``` +Set-AzVpnClientIpsecParameter -VirtualNetworkGatewayName <String> -ResourceGroupName <String> + -VpnClientIPsecParameter <PSVpnClientIPsecParameters> -InputObject <PSVirtualNetworkGateway> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzVpnClientIpsecParameter -VirtualNetworkGatewayName <String> -ResourceGroupName <String> + -VpnClientIPsecParameter <PSVpnClientIPsecParameters> -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzVpnClientIpsecParameter** cmdlet sets the vpn ipsec parameters for existing virtual network gateway. +When Virtual network gateway is created, it sets the set of default vpn ipsec policies on Gateway. In case, Point to site user wants to use certain custom ipsec policy to connect to VPN Gateway, user has to set that ipsec policy on VPN Gateway first. **Set-AzVpnClientIpsecParameter** provides a way to do that. + +## EXAMPLES + +### Example 1: Sets a custom vpn ipsec policy to existing virtual network gateway. +```powershell +$vpnclientipsecparams = New-AzVpnClientIpsecParameter -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTime 86473 -SADataSize 429498 -IkeEncryption AES256 -IkeIntegrity SHA384 -DhGroup DHGroup2 -PfsGroup PFS2 +$setvpnIpsecParams = Set-AzVpnClientIpsecParameter -VirtualNetworkGatewayName "ContosoLocalGateway" -ResourceGroupName "ContosoResourceGroup" -VpnClientIPsecParameter $vpnclientipsecparams +``` + +This example sets custom vpn ipsec policy to existing virtual network gateway named ContosoVirtualGateway from Resource group named ContosoResourceGroup. +New-AzVpnClientIpsecParameter cmdlet is used to create the vpn ipsec parameters object of using the passed one or all parameters' values which user can set for any existing Virtual network gateway in ResourceGroup. +This created VpnClientIPsecParameters object is passed to Set-AzVpnClientIpsecParameter command to set the specified Vpn ipsec custom policy on Virtual network gateway as shown in above example. This command returns object of VpnClientIPsecParameters which shows set parameters. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual network gateway object + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: ByFactoryObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkGatewayName +The virtual network gateway name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnClientIPsecParameter +Vpn client ipsec parameters. This parameter value can be constructed using PS command let:New-AzVpnClientIpsecParameter + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnClientIPsecParameters +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientIPsecParameters + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnClientIPsecParameters + +## NOTES + +## RELATED LINKS + +[Get-AzVpnClientIpsecParameter](./Get-AzVpnClientIpsecParameter.md) + +[New-AzVpnClientIpsecParameter](./New-AzVpnClientIpsecParameter.md) + +[Remove-AzVpnClientIpsecParameter](./Remove-AzVpnClientIpsecParameter.md) diff --git a/azps-10.1.0/Az.Network/Start-AzApplicationGateway.md b/azps-10.1.0/Az.Network/Start-AzApplicationGateway.md new file mode 100644 index 0000000000..fd1fc95f2b --- /dev/null +++ b/azps-10.1.0/Az.Network/Start-AzApplicationGateway.md @@ -0,0 +1,85 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 95731734-EDCA-432A-A7BF-94D1E3725FB2 +online version: https://learn.microsoft.com/powershell/module/az.network/start-azapplicationgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzApplicationGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzApplicationGateway.md +--- + +# Start-AzApplicationGateway + +## SYNOPSIS +Starts an application gateway. + +## SYNTAX + +``` +Start-AzApplicationGateway -ApplicationGateway <PSApplicationGateway> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzApplicationGateway** cmdlet starts an Azure application gateway + +## EXAMPLES + +### Example1: Start an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name Test -ResourceGroupName Appgwtest +Start-AzApplicationGateway -ApplicationGateway $AppGw +``` + +This command starts the application gateway stored in the $AppGw variable. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway that this cmdlet starts. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Stop-AzApplicationGateway](./Stop-AzApplicationGateway.md) + + diff --git a/azps-10.1.0/Az.Network/Start-AzNetworkWatcherConnectionMonitor.md b/azps-10.1.0/Az.Network/Start-AzNetworkWatcherConnectionMonitor.md new file mode 100644 index 0000000000..f8a31e0c15 --- /dev/null +++ b/azps-10.1.0/Az.Network/Start-AzNetworkWatcherConnectionMonitor.md @@ -0,0 +1,314 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/start-aznetworkwatcherconnectionmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzNetworkWatcherConnectionMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzNetworkWatcherConnectionMonitor.md +--- + +# Start-AzNetworkWatcherConnectionMonitor + +## SYNOPSIS +Start a connection monitor + +## SYNTAX + +### SetByName (Default) +``` +Start-AzNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResource +``` +Start-AzNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +Start-AzNetworkWatcherConnectionMonitor -Location <String> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Start-AzNetworkWatcherConnectionMonitor -ResourceId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObject +``` +Start-AzNetworkWatcherConnectionMonitor -InputObject <PSConnectionMonitorResult> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Start-AzNetworkWatcherConnectionMonitor cmdlet starts the specified connection monitor. + +## EXAMPLES + +### Example 1: Start a connection monitor +```powershell +Start-AzNetworkWatcherConnectionMonitor -NetworkWatcherName NetworkWatcher_centraluseuap -ResourceGroupName NetworkWatcherRG -Name cm +``` + +In this example we start connection monitor specified by name and network watcher + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Connection monitor object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult +Parameter Sets: SetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The connection monitor name. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: ConnectionMonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. + +```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 network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult + +## OUTPUTS + +### System.Boolean + +## NOTES +Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) diff --git a/azps-10.1.0/Az.Network/Start-AzNetworkWatcherResourceTroubleshooting.md b/azps-10.1.0/Az.Network/Start-AzNetworkWatcherResourceTroubleshooting.md new file mode 100644 index 0000000000..e460e0bbbd --- /dev/null +++ b/azps-10.1.0/Az.Network/Start-AzNetworkWatcherResourceTroubleshooting.md @@ -0,0 +1,247 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/start-aznetworkwatcherresourcetroubleshooting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzNetworkWatcherResourceTroubleshooting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzNetworkWatcherResourceTroubleshooting.md +--- + +# Start-AzNetworkWatcherResourceTroubleshooting + +## SYNOPSIS +Starts troubleshooting on a Networking resource in Azure. + +## SYNTAX + +### SetByResource (Default) +``` +Start-AzNetworkWatcherResourceTroubleshooting -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> + -StorageId <String> -StoragePath <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByName +``` +Start-AzNetworkWatcherResourceTroubleshooting -NetworkWatcherName <String> -ResourceGroupName <String> + -TargetResourceId <String> -StorageId <String> -StoragePath <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Start-AzNetworkWatcherResourceTroubleshooting -Location <String> -TargetResourceId <String> -StorageId <String> + -StoragePath <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Start-AzNetworkWatcherResourceTroubleshooting cmdlet starts troubleshooting for a Networking resource in Azure and returns information about potential issues and mitigations. Currently Virtual Network Gateways and Connections are supported. + +## EXAMPLES + +### Example 1: Start Troubleshooting on a Virtual Network Gateway +```powershell +$nw = Get-AzResource | Where-Object {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } +$networkWatcher = Get-AzNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName + +$target = '/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{vnetGatewayName}' +$storageId = '/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{storageAccountName}' +$storagePath = 'https://{storageAccountName}.blob.core.windows.net/troubleshoot' + +Start-AzNetworkWatcherResourceTroubleshooting -NetworkWatcher $networkWatcher -TargetResourceId $target -StorageId $storageId -StoragePath $storagePath +``` + +The above sample starts troubleshooting on a virtual network gateway. The operation may take a few minutes to complete. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageId +The storage ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StoragePath +The storage path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetResourceId +Specifies the resource id of the resource to troubleshoot. Example format: "/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.Network/connections/${connectionName}" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSTroubleshootingResult + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, troubleshoot, VPN, connection + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Start-AzVirtualNetworkGatewayConnectionPacketCapture.md b/azps-10.1.0/Az.Network/Start-AzVirtualNetworkGatewayConnectionPacketCapture.md new file mode 100644 index 0000000000..164f338328 --- /dev/null +++ b/azps-10.1.0/Az.Network/Start-AzVirtualNetworkGatewayConnectionPacketCapture.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/start-azvirtualnetworkgatewayconnectionpacketcapture +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzVirtualNetworkGatewayConnectionPacketCapture.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzVirtualNetworkGatewayConnectionPacketCapture.md +--- + +# Start-AzVirtualNetworkGatewayConnectionPacketCapture + +## SYNOPSIS +Starts Packet Capture Operation on a Virtual Network Gateway Connection. + +## SYNTAX + +### ByName (Default) +``` +Start-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName <String> -Name <String> + [-FilterData <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObject +``` +Start-AzVirtualNetworkGatewayConnectionPacketCapture -InputObject <PSVirtualNetworkGatewayConnection> + [-FilterData <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Start-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceId <String> [-FilterData <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Starts Packet Capture Operation on a Virtual Network Gateway Connection. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2Site1Cn" +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:52:37 AM +StartTime : 10/1/2019 12:52:25 AM +ResultsText : +ResourceGroupName : PktCaptureTestSite2RG +Location : centraluseuap +ResourceGuid : ac70028f-5b88-4ad4-93d3-0b9a9172c382 +Type : +Tag : +TagsTable : +Name : PktCaptureTestSite2Site1Cn +Etag : +Id : +``` + +### Example 2 +```powershell +$a="{`"TracingFlags`":11,`"MaxPacketBufferSize`":120,`"MaxFileSize`":500,`"Filters`":[{`"SourceSubnets`":[`"10.19.0.4/32`",`"10.20.0.4/32`"],`"DestinationSubnets`":[`"10.20.0.4/32`",`"10.19.0.4/32`"],`"TcpFlags`":-1,`"Protocol`":[6],`"CaptureSingleDirectionTrafficOnly`":true}]}" +Start-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2Site1Cn" -FilterData $a +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:52:37 AM +StartTime : 10/1/2019 12:52:25 AM +ResultsText : +ResourceGroupName : PktCaptureTestSite2RG +Location : centraluseuap +ResourceGuid : ac70028f-5b88-4ad4-93d3-0b9a9172c382 +Type : +Tag : +TagsTable : +Name : PktCaptureTestSite2Site1Cn +Etag : +Id : +``` + +### Example 3 +Packet Capture example for capture all inner and outer packets + + +```powershell +$a = "{`"TracingFlags`": 11,`"MaxPacketBufferSize`": 120,`"MaxFileSize`": 500,`"Filters`" :[{`"CaptureSingleDirectionTrafficOnly`": false}]}" +Start-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2Site1Cn" -FilterData $a +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:52:37 AM +StartTime : 10/1/2019 12:52:25 AM +ResultsText : +ResourceGroupName : PktCaptureTestSite2RG +Location : centraluseuap +ResourceGuid : ac70028f-5b88-4ad4-93d3-0b9a9172c382 +Type : +Tag : +TagsTable : +Name : PktCaptureTestSite2Site1Cn +Etag : +Id : +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterData +Filter options for start packet capture on virtual network gateway connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual network gateway connection object where packet capture to be started. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection +Parameter Sets: ByInputObject +Aliases: VirtualNetworkGatewayConnection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The virtual network gateway connection name where packet capture to be started. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ResourceName, VirtualNetworkGatewayConnectionName, ConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the VirtualNetworkGatewayConnection where packet capture to be started. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayPacketCaptureResult + +## NOTES + +## RELATED LINKS + +[Stop-AzVirtualNetworkGatewayConnectionPacketCapture](./Stop-AzVirtualNetworkGatewayConnectionPacketCapture.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Start-AzVirtualnetworkGatewayPacketCapture.md b/azps-10.1.0/Az.Network/Start-AzVirtualnetworkGatewayPacketCapture.md new file mode 100644 index 0000000000..c67186fe03 --- /dev/null +++ b/azps-10.1.0/Az.Network/Start-AzVirtualnetworkGatewayPacketCapture.md @@ -0,0 +1,263 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/start-azvirtualnetworkgatewaypacketcapture +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzVirtualnetworkGatewayPacketCapture.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzVirtualnetworkGatewayPacketCapture.md +--- + +# Start-AzVirtualnetworkGatewayPacketCapture + +## SYNOPSIS +Starts Packet Capture Operation on a Virtual Network Gateway. + +## SYNTAX + +### ByName (Default) +``` +Start-AzVirtualnetworkGatewayPacketCapture -ResourceGroupName <String> -Name <String> [-FilterData <String>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Start-AzVirtualnetworkGatewayPacketCapture -InputObject <PSVirtualNetworkGateway> [-FilterData <String>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Start-AzVirtualnetworkGatewayPacketCapture -ResourceId <String> [-FilterData <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Starts Packet Capture Operation on a Virtual Network Gateway. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzVirtualnetworkGatewayPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2VNG" +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:57:27 AM +StartTime : 10/1/2019 12:57:16 AM +ResultsText : +ResourceGroupName : PktCaptureTestSite2RG +Location : centraluseuap +ResourceGuid : 161c0fff-f3fd-4698-9ab3-8ca9470de975 +Type : +Tag : +TagsTable : +Name : PktCaptureTestSite2VNG +Etag : +Id : +``` + +### Example 2 +```powershell +$a="{`"TracingFlags`":11,`"MaxPacketBufferSize`":120,`"MaxFileSize`":500,`"Filters`":[{`"SourceSubnets`":[`"10.19.0.4/32`",`"10.20.0.4/32`"],`"DestinationSubnets`":[`"10.20.0.4/32`",`"10.19.0.4/32`"],`"TcpFlags`":-1,`"Protocol`":[6],`"CaptureSingleDirectionTrafficOnly`":true}]}" +Start-AzVirtualnetworkGatewayPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2VNG" -FilterData $a +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:57:27 AM +StartTime : 10/1/2019 12:57:16 AM +ResultsText : +ResourceGroupName : PktCaptureTestSite2RG +Location : centraluseuap +ResourceGuid : 161c0fff-f3fd-4698-9ab3-8ca9470de975 +Type : +Tag : +TagsTable : +Name : PktCaptureTestSite2VNG +Etag : +Id : +``` + +### Example 3 +Packet Capture example for capture all inner and outer packets + + +```powershell +$a = "{`"TracingFlags`": 11,`"MaxPacketBufferSize`": 120,`"MaxFileSize`": 500,`"Filters`" :[{`"CaptureSingleDirectionTrafficOnly`": false}]}" +Start-AzVirtualnetworkGatewayPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2VNG" -FilterData $a +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:57:27 AM +StartTime : 10/1/2019 12:57:16 AM +ResultsText : +ResourceGroupName : PktCaptureTestSite2RG +Location : centraluseuap +ResourceGuid : 161c0fff-f3fd-4698-9ab3-8ca9470de975 +Type : +Tag : +TagsTable : +Name : PktCaptureTestSite2VNG +Etag : +Id : +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterData +Filter options for start packet capture on virtual network gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual network gateway object where packet capture to be started. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: ByInputObject +Aliases: VirtualNetworkGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The virtual network gateway name where packet capture is to be started. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ResourceName, VirtualNetworkGatewayName, GatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the VirtualNetworkGateway where packet capture to be started. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayPacketCaptureResult + +## NOTES + +## RELATED LINKS + +[Stop-AzVirtualnetworkGatewayPacketCapture](./Stop-AzVirtualnetworkGatewayPacketCapture.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Start-AzVpnConnectionPacketCapture.md b/azps-10.1.0/Az.Network/Start-AzVpnConnectionPacketCapture.md new file mode 100644 index 0000000000..7eb666ef55 --- /dev/null +++ b/azps-10.1.0/Az.Network/Start-AzVpnConnectionPacketCapture.md @@ -0,0 +1,272 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/start-azvpnconnectionpacketcapture +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzVpnConnectionPacketCapture.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzVpnConnectionPacketCapture.md +--- + +# Start-AzVpnConnectionPacketCapture + +## SYNOPSIS +Starts Packet Capture Operation on a Vpn Connection. + +## SYNTAX + +### ByVpnConnectionName (Default) +``` +Start-AzVpnConnectionPacketCapture -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + [-FilterData <String>] -LinkConnectionName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnConnectionObject +``` +Start-AzVpnConnectionPacketCapture -InputObject <PSVpnConnection> [-FilterData <String>] + -LinkConnectionName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVpnConnectionResourceId +``` +Start-AzVpnConnectionPacketCapture -ResourceId <String> [-FilterData <String>] -LinkConnectionName <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Starts Packet Capture Operation on a Vpn Connection. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzVpnConnectionPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2Site1Cn" -ParentResourceName "VpnGw1" -LinkConnectionName "PktCaptureTestSite2Site1CnLink1" +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:52:37 AM +StartTime : 10/1/2019 12:52:25 AM +ResultsText : +LinkConnectionName: PktCaptureTestSite2Site1CnLink1 +ResourceGroupName : PktCaptureTestSite2RG +Location : centraluseuap +ResourceGuid : ac70028f-5b88-4ad4-93d3-0b9a9172c382 +Type : +Tag : +TagsTable : +Name : PktCaptureTestSite2Site1Cn +Etag : +Id : +``` + +### Example 2 +```powershell +$a="{`"TracingFlags`":11,`"MaxPacketBufferSize`":120,`"MaxFileSize`":500,`"Filters`":[{`"SourceSubnets`":[`"10.19.0.4/32`",`"10.20.0.4/32`"],`"DestinationSubnets`":[`"10.20.0.4/32`",`"10.19.0.4/32`"],`"IpSubnetValueAsAny`":true,`"TcpFlags`":-1,`"PortValueAsAny`":true,`"CaptureSingleDirectionTrafficOnly`":true}]}" +Start-AzVpnConnectionPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2Site1Cn" -ParentResourceName "VpnGw1" -LinkConnectionName "PktCaptureTestSite2Site1CnLink1,PktCaptureTestSite2Site1CnLink1" -FilterData $a +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:52:37 AM +StartTime : 10/1/2019 12:52:25 AM +ResultsText : +LinkConnectionName: PktCaptureTestSite2Site1CnLink1,PktCaptureTestSite2Site1CnLink1 +ResourceGroupName : PktCaptureTestSite2RG +Location : centraluseuap +ResourceGuid : ac70028f-5b88-4ad4-93d3-0b9a9172c382 +Type : +Tag : +TagsTable : +Name : PktCaptureTestSite2Site1Cn +Etag : +Id : +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterData +Filter options for start packet capture on Vpn connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Vpn connection object where packet capture to be started. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnConnection +Parameter Sets: ByVpnConnectionObject +Aliases: VpnConnection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkConnectionName +The names of the SiteLinkConnection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Vpn connection name where packet capture to be started. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionName +Aliases: ResourceName, VpnConnectionName, ConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The name of the Parent Vpngateway. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionName +Aliases: ParentVpnGatewayName, VpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the VpnConnection where packet capture to be started. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnConnection + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnConnectionPacketCaptureResult + +## NOTES + +## RELATED LINKS + +[Stop-AzVpnConnectionPacketCapture](./Stop-AzVpnConnectionPacketCapture.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Start-AzVpnGatewayPacketCapture.md b/azps-10.1.0/Az.Network/Start-AzVpnGatewayPacketCapture.md new file mode 100644 index 0000000000..c24baae9ce --- /dev/null +++ b/azps-10.1.0/Az.Network/Start-AzVpnGatewayPacketCapture.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/Start-AzVpnGatewayPacketCapture +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzVpnGatewayPacketCapture.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Start-AzVpnGatewayPacketCapture.md +--- + +# Start-AzVpnGatewayPacketCapture + +## SYNOPSIS +Starts Packet Capture Operation on a Vpn Gateway. + +## SYNTAX + +### ByVpnGatewayName (Default) +``` +Start-AzVpnGatewayPacketCapture -ResourceGroupName <String> -Name <String> [-FilterData <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayObject +``` +Start-AzVpnGatewayPacketCapture -InputObject <PSVpnGateway> [-FilterData <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayResourceId +``` +Start-AzVpnGatewayPacketCapture -ResourceId <String> [-FilterData <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Starts Packet Capture Operation on a Vpn Gateway. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzVpnGatewayPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2VNG" +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:57:27 AM +StartTime : 10/1/2019 12:57:16 AM +ResultsText : +ResourceGroupName : PktCaptureTestSite2RG +Location : centraluseuap +ResourceGuid : 161c0fff-f3fd-4698-9ab3-8ca9470de975 +Type : +Tag : +TagsTable : +Name : PktCaptureTestSite2VNG +Etag : +Id : +``` + +### Example 2 +```powershell +$a="{`"TracingFlags`":11,`"MaxPacketBufferSize`":120,`"MaxFileSize`":500,`"Filters`":[{`"SourceSubnets`":[`"10.19.0.4/32`",`"10.20.0.4/32`"],`"DestinationSubnets`":[`"10.20.0.4/32`",`"10.19.0.4/32`"],`"TcpFlags`":-1,`"Protocol`":[6],`"CaptureSingleDirectionTrafficOnly`":true}]}" +Start-AzVpnGatewayPacketCapture -ResourceGroupName "PktCaptureTestSite2RG" -Name "PktCaptureTestSite2VNG" -FilterData $a +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:57:27 AM +StartTime : 10/1/2019 12:57:16 AM +ResultsText : +ResourceGroupName : PktCaptureTestSite2RG +Location : centraluseuap +ResourceGuid : 161c0fff-f3fd-4698-9ab3-8ca9470de975 +Type : +Tag : +TagsTable : +Name : PktCaptureTestSite2VNG +Etag : +Id : +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterData +Filter options for start packet capture on Vpn Gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Vpn Gateway object where packet capture to be started. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnGateway +Parameter Sets: ByVpnGatewayObject +Aliases: VpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Vpn Gateway name where packet capture is to be started. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: ResourceName, VpnGatewayName, GatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the VpnGateway where packet capture to be started. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGatewayPacketCaptureResult + +## NOTES + +## RELATED LINKS + +[Stop-AzVpnGatewayPacketCapture](./Stop-AzVpnGatewayPacketCapture.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Stop-AzApplicationGateway.md b/azps-10.1.0/Az.Network/Stop-AzApplicationGateway.md new file mode 100644 index 0000000000..1063c3be7e --- /dev/null +++ b/azps-10.1.0/Az.Network/Stop-AzApplicationGateway.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 2C9609E8-0D8B-471B-9F0E-672BF55C3A0E +online version: https://learn.microsoft.com/powershell/module/az.network/stop-azapplicationgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzApplicationGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzApplicationGateway.md +--- + +# Stop-AzApplicationGateway + +## SYNOPSIS +Stops an application gateway + +## SYNTAX + +``` +Stop-AzApplicationGateway -ApplicationGateway <PSApplicationGateway> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzApplicationGateway** cmdlet stops an application gateway. + +## EXAMPLES + +### Example 1: Stop an application gateway +```powershell +$AppGw = Get-AzApplicationGateway -Name Test -ResourceGroupName Appgwtest +Stop-AzApplicationGateway -ApplicationGateway $AppGw +``` + +These commands set the $AppGw variable to an application gateway and then stops the application gateway. + +## PARAMETERS + +### -ApplicationGateway +Specifies the application gateway that this cmdlet stops. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway + +## NOTES + +## RELATED LINKS + +[Get-AzApplicationGateway](./Get-AzApplicationGateway.md) + +[New-AzApplicationGateway](./New-AzApplicationGateway.md) + +[Remove-AzApplicationGateway](./Remove-AzApplicationGateway.md) + +[Set-AzApplicationGateway](./Set-AzApplicationGateway.md) + +[Start-AzApplicationGateway](./Start-AzApplicationGateway.md) + + diff --git a/azps-10.1.0/Az.Network/Stop-AzNetworkWatcherConnectionMonitor.md b/azps-10.1.0/Az.Network/Stop-AzNetworkWatcherConnectionMonitor.md new file mode 100644 index 0000000000..500e5fe6cd --- /dev/null +++ b/azps-10.1.0/Az.Network/Stop-AzNetworkWatcherConnectionMonitor.md @@ -0,0 +1,325 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/stop-aznetworkwatcherconnectionmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzNetworkWatcherConnectionMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzNetworkWatcherConnectionMonitor.md +--- + +# Stop-AzNetworkWatcherConnectionMonitor + +## SYNOPSIS +Stop a connection monitor + +## SYNTAX + +### SetByName (Default) +``` +Stop-AzNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> -Name <String> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResource +``` +Stop-AzNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +Stop-AzNetworkWatcherConnectionMonitor -Location <String> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Stop-AzNetworkWatcherConnectionMonitor -ResourceId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObject +``` +Stop-AzNetworkWatcherConnectionMonitor -InputObject <PSConnectionMonitorResult> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Stop-AzNetworkWatcherConnectionMonitor cmdlet stops the specified connection monitor. + +## EXAMPLES + +### Example 1: Stop a connection monitor +```powershell +Stop-AzNetworkWatcherConnectionMonitor -NetworkWatcher $nw -Name cm +``` + +In this example we stop connection monitor specified by name and network watcher + +### Example 2 + +Stop a connection monitor. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Stop-AzNetworkWatcherConnectionMonitor -Name cm -NetworkWatcherName nw1 -ResourceGroupName myresourcegroup +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Connection monitor object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult +Parameter Sets: SetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The connection monitor name. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByResource, SetByLocation +Aliases: ConnectionMonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. + +```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 network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult + +## OUTPUTS + +### System.Boolean + +## NOTES +Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) diff --git a/azps-10.1.0/Az.Network/Stop-AzNetworkWatcherPacketCapture.md b/azps-10.1.0/Az.Network/Stop-AzNetworkWatcherPacketCapture.md new file mode 100644 index 0000000000..38fba52296 --- /dev/null +++ b/azps-10.1.0/Az.Network/Stop-AzNetworkWatcherPacketCapture.md @@ -0,0 +1,271 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/stop-aznetworkwatcherpacketcapture +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzNetworkWatcherPacketCapture.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzNetworkWatcherPacketCapture.md +--- + +# Stop-AzNetworkWatcherPacketCapture + +## SYNOPSIS +Stops a running packet capture session + +## SYNTAX + +### SetByResource (Default) +``` +Stop-AzNetworkWatcherPacketCapture -NetworkWatcher <PSNetworkWatcher> -PacketCaptureName <String> [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByName +``` +Stop-AzNetworkWatcherPacketCapture -NetworkWatcherName <String> -ResourceGroupName <String> + -PacketCaptureName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetByLocation +``` +Stop-AzNetworkWatcherPacketCapture -Location <String> -PacketCaptureName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Stop-AzNetworkWatcherPacketCapture stops a running packet capture session. After the session is stopped, the packet capture file is uploaded to storage and/or saved locally on the VM depending on its configuration. + +## EXAMPLES + +### Example 1: Stop a packet capture session +```powershell +Stop-AzNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -PacketCaptureName "PacketCaptureTest" +``` + +In this example we stop a running packet capture session named "PacketCaptureTest". After the session is stopped, the packet capture file is uploaded to storage and/or saved locally on the VM depending on its configuration. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PacketCaptureName +The packet capture name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic + +## RELATED LINKS + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Stop-AzVirtualNetworkGatewayConnectionPacketCapture.md b/azps-10.1.0/Az.Network/Stop-AzVirtualNetworkGatewayConnectionPacketCapture.md new file mode 100644 index 0000000000..d2e798714b --- /dev/null +++ b/azps-10.1.0/Az.Network/Stop-AzVirtualNetworkGatewayConnectionPacketCapture.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/stop-azvirtualnetworkgatewayconnectionpacketcapture +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzVirtualNetworkGatewayConnectionPacketCapture.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzVirtualNetworkGatewayConnectionPacketCapture.md +--- + +# Stop-AzVirtualNetworkGatewayConnectionPacketCapture + +## SYNOPSIS +Stops Packet Capture Operation on a Virtual Network Gateway connection + +## SYNTAX + +### ByName (Default) +``` +Stop-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName <String> -Name <String> -SasUrl <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Stop-AzVirtualNetworkGatewayConnectionPacketCapture -InputObject <PSVirtualNetworkGatewayConnection> + -SasUrl <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Stop-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceId <String> -SasUrl <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Stops Packet Capture Operation on a Virtual Network Gateway connection and will upload the result on given SasUrl of storage container. + +## EXAMPLES + +### Example 1 +```powershell +$rgname = "testRg" +$storeName = "teststorage" +$containerName = "packetcaptureresults" +$key = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $storeName +$context = New-AzStorageContext -StorageAccountName $storeName -StorageAccountKey $key[0].Value +New-AzStorageContainer -Name $containerName -Context $context +$container = Get-AzStorageContainer -Name $containerName -Context $context +$now = Get-Date +$sasurl = New-AzStorageContainerSASToken -Name $containerName -Context $context -Permission "rwd" -StartTime $now.AddHours(-1) -ExpiryTime $now.AddDays(1) -FullUri +Stop-AzVirtualNetworkGatewayConnectionPacketCapture -ResourceGroupName $rgname -Name "testconn" -SasUrl $sasurl +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:54:51 AM +StartTime : 10/1/2019 12:53:40 AM +ResultsText : +ResourceGroupName : testRg +Location : centraluseuap +ResourceGuid : ac70028f-5b88-4ad4-93d3-0b9a9172c382 +Type : +Tag : +TagsTable : +Name : testconn +Etag : +Id : +``` + +### Example 2 +```powershell +$rgname = "testRg" +$storeName = "teststorage" +$containerName = "packetcaptureresults" +$key = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $storeName +$context = New-AzStorageContext -StorageAccountName $storeName -StorageAccountKey $key[0].Value +$container = Get-AzStorageContainer -Name $containerName -Context $context +$now = Get-Date +$sasurl = New-AzStorageContainerSASToken -Name $containerName -Context $context -Permission "rwd" -StartTime $now.AddHours(-1) -ExpiryTime $now.AddDays(1) -FullUri +$conn = Get-AzVirtualNetworkGatewayConnection -name "testconn" -ResourceGroupName $rgname +Stop-AzVirtualNetworkGatewayConnectionPacketCapture -InputObject $conn -SasUrl $sasurl +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:54:51 AM +StartTime : 10/1/2019 12:53:40 AM +ResultsText : +ResourceGroupName : testRg +Location : centraluseuap +ResourceGuid : ac70028f-5b88-4ad4-93d3-0b9a9172c382 +Type : +Tag : +TagsTable : +Name : testconn +Etag : +Id : +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual network gateway connection object where packet capture to be started. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection +Parameter Sets: ByInputObject +Aliases: VirtualNetworkGatewayConnection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The virtual network gateway connection name where packet capture is to be started. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ResourceName, ConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the VirtualNetworkGatewayConnection where packet capture to be started. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SasUrl +SAS Url for stop packet capture on virtual network gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayPacketCaptureResult + +## NOTES + +## RELATED LINKS + +[Start-AzVirtualnetworkGatewayConnectionPacketCapture](./Start-AzVirtualnetworkGatewayConnectionPacketCapture.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Stop-AzVirtualNetworkGatewayPacketCapture.md b/azps-10.1.0/Az.Network/Stop-AzVirtualNetworkGatewayPacketCapture.md new file mode 100644 index 0000000000..03f3b4cc48 --- /dev/null +++ b/azps-10.1.0/Az.Network/Stop-AzVirtualNetworkGatewayPacketCapture.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/stop-azvirtualnetworkgatewaypacketcapture +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzVirtualNetworkGatewayPacketCapture.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzVirtualNetworkGatewayPacketCapture.md +--- + +# Stop-AzVirtualNetworkGatewayPacketCapture + +## SYNOPSIS +Stops Packet Capture Operation on a Virtual Network Gateway. + +## SYNTAX + +### ByName (Default) +``` +Stop-AzVirtualNetworkGatewayPacketCapture -ResourceGroupName <String> -Name <String> -SasUrl <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Stop-AzVirtualNetworkGatewayPacketCapture -InputObject <PSVirtualNetworkGateway> -SasUrl <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Stop-AzVirtualNetworkGatewayPacketCapture -ResourceId <String> -SasUrl <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Stops Packet Capture Operation on a Virtual Network Gateway and will upload the result on given SasUrl of storage container. + +## EXAMPLES + +### Example 1 +```powershell +$rgname = "testRg" +$storeName = "teststorage" +$containerName = "packetcaptureresults" +$key = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $storeName +$context = New-AzStorageContext -StorageAccountName $storeName -StorageAccountKey $key[0].Value +New-AzStorageContainer -Name $containerName -Context $context +$container = Get-AzStorageContainer -Name $containerName -Context $context +$now = Get-Date +$sasurl = New-AzStorageContainerSASToken -Name $containerName -Context $context -Permission "rwd" -StartTime $now.AddHours(-1) -ExpiryTime $now.AddDays(1) -FullUri +Stop-AzVirtualNetworkGatewayPacketCapture -ResourceGroupName $rgname -Name "testgw" -SasUrl $sasurl +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:59:37 AM +StartTime : 10/1/2019 12:58:26 AM +ResultsText : +ResourceGroupName : testRg +Location : centraluseuap +ResourceGuid : 161c0fff-f3fd-4698-9ab3-8ca9470de975 +Type : +Tag : +TagsTable : +Name : testgw +Etag : +Id : +``` + +### Example 2 +```powershell +$rgname = "testRg" +$storeName = "teststorage" +$containerName = "packetcaptureresults" +$key = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $storeName +$context = New-AzStorageContext -StorageAccountName $storeName -StorageAccountKey $key[0].Value +$container = Get-AzStorageContainer -Name $containerName -Context $context +$now = Get-Date +$sasurl = New-AzStorageContainerSASToken -Name $containerName -Context $context -Permission "rwd" -StartTime $now.AddHours(-1) -ExpiryTime $now.AddDays(1) -FullUri +$gw = Get-AzVirtualNetworkGateway -ResourceGroupName $rgname -name "testGw" +Stop-AzVirtualNetworkGatewayPacketCapture -InputObject $gw -SasUrl $sasurl +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:59:37 AM +StartTime : 10/1/2019 12:58:26 AM +ResultsText : +ResourceGroupName : testRg +Location : centraluseuap +ResourceGuid : 161c0fff-f3fd-4698-9ab3-8ca9470de975 +Type : +Tag : +TagsTable : +Name : testgw +Etag : +Id : +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual network gateway object where packet capture to be started. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway +Parameter Sets: ByInputObject +Aliases: VirtualNetworkGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The virtual network gateway name where packet capture to be started. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ResourceName, VirtualNetworkGatewayName, GatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the VirtualNetworkGateway where packet capture to be started. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SasUrl +SAS URL packet capture on virtual network gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayPacketCaptureResult + +## NOTES + +## RELATED LINKS + +[Start-AzVirtualnetworkGatewayPacketCapture](./Stop-AzVirtualnetworkGatewayPacketCapture.md) diff --git a/azps-10.1.0/Az.Network/Stop-AzVpnConnectionPacketCapture.md b/azps-10.1.0/Az.Network/Stop-AzVpnConnectionPacketCapture.md new file mode 100644 index 0000000000..348828ae55 --- /dev/null +++ b/azps-10.1.0/Az.Network/Stop-AzVpnConnectionPacketCapture.md @@ -0,0 +1,288 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/stop-azvpnconnectionpacketcapture +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzVpnConnectionPacketCapture.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzVpnConnectionPacketCapture.md +--- + +# Stop-AzVpnConnectionPacketCapture + +## SYNOPSIS +Stops Packet Capture Operation on a Vpn connection + +## SYNTAX + +### ByVpnConnectionName (Default) +``` +Stop-AzVpnConnectionPacketCapture -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + -LinkConnectionName <String> -SasUrl <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByVpnConnectionObject +``` +Stop-AzVpnConnectionPacketCapture -InputObject <PSVpnConnection> -LinkConnectionName <String> -SasUrl <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnConnectionResourceId +``` +Stop-AzVpnConnectionPacketCapture -ResourceId <String> -LinkConnectionName <String> -SasUrl <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Stops Packet Capture Operation on a Vpn connection and will upload the result on given SasUrl of storage container. + +## EXAMPLES + +### Example 1 +```powershell +$rgname = "testRg" +$storeName = "teststorage" +$containerName = "packetcaptureresults" +$key = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $storeName +$context = New-AzStorageContext -StorageAccountName $storeName -StorageAccountKey $key[0].Value +New-AzStorageContainer -Name $containerName -Context $context +$container = Get-AzStorageContainer -Name $containerName -Context $context +$now = Get-Date +$sasurl = New-AzStorageContainerSASToken -Name $containerName -Context $context -Permission "rwd" -StartTime $now.AddHours(-1) -ExpiryTime $now.AddDays(1) -FullUri +Stop-AzVpnConnectionPacketCapture -ResourceGroupName $rgname -Name "testconn" -ParentResourceName "VpnGw1" -LinkConnectionName "SiteLink1,SiteLink2" -SasUrl $sasurl +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:54:51 AM +StartTime : 10/1/2019 12:53:40 AM +ResultsText : +LinkConnectionName: SiteLink1,SiteLink2 +ResourceGroupName : testRg +Location : centraluseuap +ResourceGuid : ac70028f-5b88-4ad4-93d3-0b9a9172c382 +Type : +Tag : +TagsTable : +Name : testconn +Etag : +Id : +``` + +### Example 2 +```powershell +$rgname = "testRg" +$storeName = "teststorage" +$containerName = "packetcaptureresults" +$key = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $storeName +$context = New-AzStorageContext -StorageAccountName $storeName -StorageAccountKey $key[0].Value +$container = Get-AzStorageContainer -Name $containerName -Context $context +$now = Get-Date +$sasurl = New-AzStorageContainerSASToken -Name $containerName -Context $context -Permission "rwd" -StartTime $now.AddHours(-1) -ExpiryTime $now.AddDays(1) -FullUri +$conn = Get-AzVpnConnection -name "testconn" -ResourceGroupName $rgname +Stop-AzVpnConnectionPacketCapture -InputObject $conn -SasUrl $sasurl -LinkConnectionName "SiteLink1,SiteLink2" +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:54:51 AM +StartTime : 10/1/2019 12:53:40 AM +ResultsText : +LinkConnectionName: SiteLink1,SiteLink2 +ResourceGroupName : testRg +Location : centraluseuap +ResourceGuid : ac70028f-5b88-4ad4-93d3-0b9a9172c382 +Type : +Tag : +TagsTable : +Name : testconn +Etag : +Id : +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Vpn connection object where packet capture to be started. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnConnection +Parameter Sets: ByVpnConnectionObject +Aliases: VpnConnection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkConnectionName +The names of the SiteLinkConnection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Vpn connection name where packet capture is to be started. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionName +Aliases: ResourceName, ConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionName +Aliases: ParentVpnGatewayName, VpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the VpnConnection where packet capture to be started. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SasUrl +SAS Url for stop packet capture on Vpn. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnConnection + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnPacketCaptureResult + +## NOTES + +## RELATED LINKS + +[Start-AzVpnConnectionPacketCapture](./Start-AzVpnConnectionPacketCapture.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Stop-AzVpnGatewayPacketCapture.md b/azps-10.1.0/Az.Network/Stop-AzVpnGatewayPacketCapture.md new file mode 100644 index 0000000000..fc31900f91 --- /dev/null +++ b/azps-10.1.0/Az.Network/Stop-AzVpnGatewayPacketCapture.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/Stop-AzVpnGatewayPacketCapture +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzVpnGatewayPacketCapture.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Stop-AzVpnGatewayPacketCapture.md +--- + +# Stop-AzVpnGatewayPacketCapture + +## SYNOPSIS +Stops Packet Capture Operation on a Vpn Gateway. + +## SYNTAX + +### ByVpnGatewayName (Default) +``` +Stop-AzVpnGatewayPacketCapture -ResourceGroupName <String> -Name <String> -SasUrl <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayObject +``` +Stop-AzVpnGatewayPacketCapture -InputObject <PSVpnGateway> -SasUrl <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayResourceId +``` +Stop-AzVpnGatewayPacketCapture -ResourceId <String> -SasUrl <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Stops Packet Capture Operation on a Vpn Gateway and will upload the result on given SasUrl of storage container. + +## EXAMPLES + +### Example 1 +```powershell +$rgname = "testRg" +$storeName = "teststorage" +$containerName = "packetcaptureresults" +$key = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $storeName +$context = New-AzStorageContext -StorageAccountName $storeName -StorageAccountKey $key[0].Value +New-AzStorageContainer -Name $containerName -Context $context +$container = Get-AzStorageContainer -Name $containerName -Context $context +$now = Get-Date +$sasurl = New-AzStorageContainerSASToken -Name $containerName -Context $context -Permission "rwd" -StartTime $now.AddHours(-1) -ExpiryTime $now.AddDays(1) -FullUri +Stop-AzVpnGatewayPacketCapture -ResourceGroupName $rgname -Name "testgw" -SasUrl $sasurl +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:59:37 AM +StartTime : 10/1/2019 12:58:26 AM +ResultsText : +ResourceGroupName : testRg +Location : centraluseuap +ResourceGuid : 161c0fff-f3fd-4698-9ab3-8ca9470de975 +Type : +Tag : +TagsTable : +Name : testgw +Etag : +Id : +``` + +### Example 2 +```powershell +$rgname = "testRg" +$storeName = "teststorage" +$containerName = "packetcaptureresults" +$key = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $storeName +$context = New-AzStorageContext -StorageAccountName $storeName -StorageAccountKey $key[0].Value +$container = Get-AzStorageContainer -Name $containerName -Context $context +$now = Get-Date +$sasurl = New-AzStorageContainerSASToken -Name $containerName -Context $context -Permission "rwd" -StartTime $now.AddHours(-1) -ExpiryTime $now.AddDays(1) -FullUri +$gw = Get-AzVpnGateway -ResourceGroupName $rgname -name "testGw" +Stop-AzVpnGatewayPacketCapture -InputObject $gw -SasUrl $sasurl +``` + +```output +Code : Succeeded +EndTime : 10/1/2019 12:59:37 AM +StartTime : 10/1/2019 12:58:26 AM +ResultsText : +ResourceGroupName : testRg +Location : centraluseuap +ResourceGuid : 161c0fff-f3fd-4698-9ab3-8ca9470de975 +Type : +Tag : +TagsTable : +Name : testgw +Etag : +Id : +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Vpn Gateway object where packet capture to be started. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnGateway +Parameter Sets: ByVpnGatewayObject +Aliases: VpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Vpn Gateway name where packet capture to be started. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: ResourceName, VpnGatewayName, GatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the VpnGateway where packet capture to be started. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SasUrl +SAS URL packet capture on Vpn Gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGatewayPacketCaptureResult + +## NOTES + +## RELATED LINKS + +[Start-AzVpnGatewayPacketCapture](./Start-AzVpnGatewayPacketCapture.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Sync-AzVirtualNetworkPeering.md b/azps-10.1.0/Az.Network/Sync-AzVirtualNetworkPeering.md new file mode 100644 index 0000000000..6f2c428ca5 --- /dev/null +++ b/azps-10.1.0/Az.Network/Sync-AzVirtualNetworkPeering.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/sync-azvirtualnetworkpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Sync-AzVirtualNetworkPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Sync-AzVirtualNetworkPeering.md +--- + +# Sync-AzVirtualNetworkPeering + +## SYNOPSIS +Command to sync the address space on the peering link if the remote virtual network has a new address space. + +## SYNTAX + +### Fields (Default) +``` +Sync-AzVirtualNetworkPeering -VirtualNetworkName <String> -ResourceGroupName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Object +``` +Sync-AzVirtualNetworkPeering -VirtualNetworkPeering <PSVirtualNetworkPeering> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updating the address space on peered virtual networks is now supported. However, to sync the latest address space on the peering link, this commandlet needs to be called on the (peered) remote virtual network. When invoked, it would sync the address space on the peering link with the latest address space of the (peered) remote virtual network. + +## EXAMPLES + +### Example 1 +```powershell +Sync-AzVirtualNetworkPeering -Name 'peering2' -VirtualNetworkName 'vnet1' -ResourceGroupName 'rg1' +``` + +Syncs the address space on the peering, peering2 in the virtual network, vnet1 within the resource group, rg1. + +### Example 2 +```powershell +$s1h1 = Get-AzVirtualNetworkPeering -Name 'spoke1-hub1' -VirtualNetworkName 'spoke1' -ResourceGroupName 'HUB1-RG' +$s1h1 | Sync-AzVirtualNetworkPeering +``` + +The first commandlet gets the virtual network peering. The second piped commandlet applies the sync operation on the peering. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The virtual network peering name. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkName +The virtual network name. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkPeering +The virtual network peering + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering + +## NOTES + +## RELATED LINKS + +[Add-AzVirtualNetworkPeering](./Add-AzVirtualNetworkPeering.md) + +[Get-AzVirtualNetworkPeering](./Get-AzVirtualNetworkPeering.md) + +[Remove-AzVirtualNetworkPeering](./Remove-AzVirtualNetworkPeering.md) + +[Set-AzVirtualNetworkPeering](./Set-AzVirtualNetworkPeering.md) diff --git a/azps-10.1.0/Az.Network/Test-AzDnsAvailability.md b/azps-10.1.0/Az.Network/Test-AzDnsAvailability.md new file mode 100644 index 0000000000..034b49ac8b --- /dev/null +++ b/azps-10.1.0/Az.Network/Test-AzDnsAvailability.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 556A9F12-DF72-468F-9C3F-A747CC70BD2F +online version: https://learn.microsoft.com/powershell/module/az.network/test-azdnsavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Test-AzDnsAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Test-AzDnsAvailability.md +--- + +# Test-AzDnsAvailability + +## SYNOPSIS +Checks whether a domain name in the cloudapp.azure.com zone is available for use. + +## SYNTAX + +``` +Test-AzDnsAvailability -DomainNameLabel <String> -Location <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Checks whether a domain name in the cloudapp.azure.com zone is available for use. + +## EXAMPLES + +### Example 1: Check if contoso.westus.cloudapp.azure.com is available for use. +```powershell +Test-AzDnsAvailability -DomainNameLabel contoso -Location westus +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainNameLabel +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DomainQualifiedName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Test-AzNetworkWatcherConnectivity.md b/azps-10.1.0/Az.Network/Test-AzNetworkWatcherConnectivity.md new file mode 100644 index 0000000000..8bfb507bc2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Test-AzNetworkWatcherConnectivity.md @@ -0,0 +1,325 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/test-aznetworkwatcherconnectivity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Test-AzNetworkWatcherConnectivity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Test-AzNetworkWatcherConnectivity.md +--- + +# Test-AzNetworkWatcherConnectivity + +## SYNOPSIS +Returns connectivity information for a specified source VM and a destination. + +## SYNTAX + +### SetByResource (Default) +``` +Test-AzNetworkWatcherConnectivity -NetworkWatcher <PSNetworkWatcher> -SourceId <String> [-SourcePort <Int32>] + [-DestinationId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] + [-ProtocolConfiguration <PSNetworkWatcherProtocolConfiguration>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByName +``` +Test-AzNetworkWatcherConnectivity -NetworkWatcherName <String> -ResourceGroupName <String> -SourceId <String> + [-SourcePort <Int32>] [-DestinationId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] + [-ProtocolConfiguration <PSNetworkWatcherProtocolConfiguration>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Test-AzNetworkWatcherConnectivity -Location <String> -SourceId <String> [-SourcePort <Int32>] + [-DestinationId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] + [-ProtocolConfiguration <PSNetworkWatcherProtocolConfiguration>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Test-AzNetworkWatcherConnectivity cmdlet returns connectivity information for a specified source VM and a destination. If connectivity between the source and destination cannot be established, the cmdlet returns details about the issue. + +## EXAMPLES + +### Example 1: Test Network Watcher Connectivity from a VM to a website +```powershell +Test-AzNetworkWatcherConnectivity -NetworkWatcherName NetworkWatcher -ResourceGroupName NetworkWatcherRG -SourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoRG/providers/Microsoft.Compute/virtualMachines/MultiTierApp0" -DestinationAddress "bing.com" -DestinationPort 80 +``` + +```output +ConnectionStatus : Reachable +AvgLatencyInMs : 4 +MinLatencyInMs : 2 +MaxLatencyInMs : 15 +ProbesSent : 15 +ProbesFailed : 0 +Hops : [ + { + "Type": "Source", + "Id": "f8cff464-e13f-457f-a09e-4dcd53d38a85", + "Address": "10.1.1.4", + "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoRG/provi iders/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", + "NextHopIds": [ + "1034b1bf-0b1b-4f0a-93b2-900477f45485" + ], + "Issues": [] + }, + { + "Type": "Internet", + "Id": "1034b1bf-0b1b-4f0a-93b2-900477f45485", + "Address": "13.107.21.200", + "ResourceId": "Internet", + "NextHopIds": [], + "Issues": [] + } + ] +``` + +In this example we test connectivity from a VM in Azure to www.bing.com. + +### Example 2 + +Returns connectivity information for a specified source VM and a destination. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Test-AzNetworkWatcherConnectivity -DestinationAddress 'bing.com' -DestinationPort 80 -NetworkWatcher <PSNetworkWatcher> -SourceId '/subscriptions/00000000-0000-0000-0000-00000000000000000/resourceGroups/ContosoRG/providers/Microsoft.Compute/virtualMachines/MultiTierApp0' +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationAddress +The IP address or URI the resource to which a connection attempt will be made. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationId +The ID of the resource to which a connection attempt will be made. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPort +Port on which check connectivity will be performed. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProtocolConfiguration +Protocol configuration on which check connectivity will be performed. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherProtocolConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceId +The ID of the resource from which a connectivity check will be initiated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourcePort +The source port from which a connectivity check will be performed. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSConnectivityInformation + +## NOTES +Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Test-AzNetworkWatcherIPFlow.md b/azps-10.1.0/Az.Network/Test-AzNetworkWatcherIPFlow.md new file mode 100644 index 0000000000..baeb85c01f --- /dev/null +++ b/azps-10.1.0/Az.Network/Test-AzNetworkWatcherIPFlow.md @@ -0,0 +1,343 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/test-aznetworkwatcheripflow +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Test-AzNetworkWatcherIPFlow.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Test-AzNetworkWatcherIPFlow.md +--- + +# Test-AzNetworkWatcherIPFlow + +## SYNOPSIS +Returns whether the packet is allowed or denied to or from a particular destination. + +## SYNTAX + +### SetByResource (Default) +``` +Test-AzNetworkWatcherIPFlow -NetworkWatcher <PSNetworkWatcher> -TargetVirtualMachineId <String> + -Direction <String> -Protocol <String> -RemoteIPAddress <String> -LocalIPAddress <String> -LocalPort <String> + [-RemotePort <String>] [-TargetNetworkInterfaceId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByName +``` +Test-AzNetworkWatcherIPFlow -NetworkWatcherName <String> -ResourceGroupName <String> + -TargetVirtualMachineId <String> -Direction <String> -Protocol <String> -RemoteIPAddress <String> + -LocalIPAddress <String> -LocalPort <String> [-RemotePort <String>] [-TargetNetworkInterfaceId <String>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByLocation +``` +Test-AzNetworkWatcherIPFlow -Location <String> -TargetVirtualMachineId <String> -Direction <String> + -Protocol <String> -RemoteIPAddress <String> -LocalIPAddress <String> -LocalPort <String> + [-RemotePort <String>] [-TargetNetworkInterfaceId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Test-AzNetworkWatcherIPFlow cmdlet, for a specified VM resource and a packet with specified direction using local and remote, IP addresses and ports, returns whether the packet is allowed or denied. + +## EXAMPLES + +### Example 1: Run Test-AzNetworkWatcherIPFlow +```powershell +$nw = Get-AzResource | Where-Object {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } +$networkWatcher = Get-AzNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName +$VM = Get-AzVM -ResourceGroupName testResourceGroup -Name VM0 +$Nics = Get-AzNetworkInterface | Where-Object { $vm.NetworkProfile.NetworkInterfaces.Id -contains $_.Id } + +Test-AzNetworkWatcherIPFlow -NetworkWatcher $networkWatcher -TargetVirtualMachineId $VM.Id -Direction Outbound -Protocol TCP -LocalIPAddress $nics[0].IpConfigurations[0].PrivateIpAddress -LocalPort 6895 -RemoteIPAddress 204.79.197.200 -RemotePort 80 +``` + +Gets the Network Watcher in West Central US for this subscription, then gets the VM and it's associated Network Interfaces. +Then for the first Network Interface, runs Test-AzNetworkWatcherIPFlow using the first IP from the first Network Interface for an outbound connection to an IP on the internet. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Direction. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Inbound, Outbound + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalIPAddress +Local IP Address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LocalPort +Local Port. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Location of the network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkWatcher +The network watcher resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher +Parameter Sets: SetByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NetworkWatcherName +The name of network watcher. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Protocol +Protocol. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TCP, UDP + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteIPAddress +Remote IP Address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RemotePort +Remote port. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the network watcher resource group. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetNetworkInterfaceId +Target network interface Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVirtualMachineId +The target virtual machine ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIPFlowVerifyResult + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, flow, ip + +## RELATED LINKS + +[New-AzNetworkWatcher](./New-AzNetworkWatcher.md) + +[Get-AzNetworkWatcher](./Get-AzNetworkWatcher.md) + +[Remove-AzNetworkWatcher](./Remove-AzNetworkWatcher.md) + +[Get-AzNetworkWatcherNextHop](./Get-AzNetworkWatcherNextHop.md) + +[Get-AzNetworkWatcherSecurityGroupView](./Get-AzNetworkWatcherSecurityGroupView.md) + +[Get-AzNetworkWatcherTopology](./Get-AzNetworkWatcherTopology.md) + +[Start-AzNetworkWatcherResourceTroubleshooting](./Start-AzNetworkWatcherResourceTroubleshooting.md) + +[New-AzNetworkWatcherPacketCapture](./New-AzNetworkWatcherPacketCapture.md) + +[New-AzPacketCaptureFilterConfig](./New-AzPacketCaptureFilterConfig.md) + +[Get-AzNetworkWatcherPacketCapture](./Get-AzNetworkWatcherPacketCapture.md) + +[Remove-AzNetworkWatcherPacketCapture](./Remove-AzNetworkWatcherPacketCapture.md) + +[Stop-AzNetworkWatcherPacketCapture](./Stop-AzNetworkWatcherPacketCapture.md) + +[New-AzNetworkWatcherProtocolConfiguration](./New-AzNetworkWatcherProtocolConfiguration.md) + +[Test-AzNetworkWatcherIPFlow](./Test-AzNetworkWatcherIPFlow.md) + +[Test-AzNetworkWatcherConnectivity](./Test-AzNetworkWatcherConnectivity.md) + +[Stop-AzNetworkWatcherConnectionMonitor](./Stop-AzNetworkWatcherConnectionMonitor.md) + +[Start-AzNetworkWatcherConnectionMonitor](./Start-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConnectionMonitor](./Set-AzNetworkWatcherConnectionMonitor.md) + +[Set-AzNetworkWatcherConfigFlowLog](./Set-AzNetworkWatcherConfigFlowLog.md) + +[Remove-AzNetworkWatcherConnectionMonitor](./Remove-AzNetworkWatcherConnectionMonitor.md) + +[New-AzNetworkWatcherConnectionMonitor](./New-AzNetworkWatcherConnectionMonitor.md) + +[Get-AzNetworkWatcherTroubleshootingResult](./Get-AzNetworkWatcherTroubleshootingResult.md) + +[Get-AzNetworkWatcherReachabilityReport](./Get-AzNetworkWatcherReachabilityReport.md) + +[Get-AzNetworkWatcherReachabilityProvidersList](./Get-AzNetworkWatcherReachabilityProvidersList.md) + +[Get-AzNetworkWatcherFlowLogStatus](./Get-AzNetworkWatcherFlowLogStatus.md) + +[Get-AzNetworkWatcherConnectionMonitorReport](./Get-AzNetworkWatcherConnectionMonitorReport.md) + +[Get-AzNetworkWatcherConnectionMonitor](./Get-AzNetworkWatcherConnectionMonitor.md) diff --git a/azps-10.1.0/Az.Network/Test-AzPrivateIPAddressAvailability.md b/azps-10.1.0/Az.Network/Test-AzPrivateIPAddressAvailability.md new file mode 100644 index 0000000000..81b4a399f1 --- /dev/null +++ b/azps-10.1.0/Az.Network/Test-AzPrivateIPAddressAvailability.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +ms.assetid: 0780CB09-9C3B-468A-A718-3A646FE3D152 +online version: https://learn.microsoft.com/powershell/module/az.network/test-azprivateipaddressavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Test-AzPrivateIPAddressAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Test-AzPrivateIPAddressAvailability.md +--- + +# Test-AzPrivateIPAddressAvailability + +## SYNOPSIS +Test availability of a private IP address in a virtual network. + +## SYNTAX + +### TestByResource +``` +Test-AzPrivateIPAddressAvailability -VirtualNetwork <PSVirtualNetwork> -IPAddress <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### TestByResourceId +``` +Test-AzPrivateIPAddressAvailability -ResourceGroupName <String> -VirtualNetworkName <String> + -IPAddress <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzPrivateIPAddressAvailability** cmdlet tests whether a specified private IP address is available in a virtual network. +This cmdlet returns a list of available private IP addresses if the requested private IP address is taken. + +## EXAMPLES + +### Example 1: Test whether an IP address is available using the pipeline +```powershell +Get-AzVirtualNetwork -Name $vnetName -ResourceGroupName $rgname | Test-AzPrivateIPAddressAvailability -IPAddress "10.0.1.10" +``` + +This command gets a virtual network and uses the pipeline operator to pass it to **Test-AzPrivateIPAddressAvailability**, which tests whether the specified private IP address is available. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddress +Specifies the IP address to test. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for the virtual network. + +```yaml +Type: System.String +Parameter Sets: TestByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetwork +Specifies a **PSVirtualNetwork** object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork +Parameter Sets: TestByResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualNetworkName +Specifies the name of the virtual network. + +```yaml +Type: System.String +Parameter Sets: TestByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSIPAddressAvailabilityResult + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetwork](./Get-AzVirtualNetwork.md) + + diff --git a/azps-10.1.0/Az.Network/Test-AzPrivateLinkServiceVisibility.md b/azps-10.1.0/Az.Network/Test-AzPrivateLinkServiceVisibility.md new file mode 100644 index 0000000000..986b1a7282 --- /dev/null +++ b/azps-10.1.0/Az.Network/Test-AzPrivateLinkServiceVisibility.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/test-azprivatelinkservicevisibility +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Test-AzPrivateLinkServiceVisibility.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Test-AzPrivateLinkServiceVisibility.md +--- + +# Test-AzPrivateLinkServiceVisibility + +## SYNOPSIS +The **Test-AzPrivateLinkServiceVisibility** checks whether a private link service is visible for current use. + +## SYNTAX + +``` +Test-AzPrivateLinkServiceVisibility -Location <String> [-ResourceGroupName <String>] + -PrivateLinkServiceAlias <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Check whether a private link service is visible for current use. + +## EXAMPLES + +### Example 1: Check if contoso.cloudapp.azure.com is available for use. +```powershell +Test-AzPrivateLinkServiceVisibility -Location westus -PrivateLinkServiceAlias "TestPLS.00000000-0000-0000-0000-000000000000.azure.privatelinkservice" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateLinkServiceAlias +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Update-AzCustomIpPrefix.md b/azps-10.1.0/Az.Network/Update-AzCustomIpPrefix.md new file mode 100644 index 0000000000..6e508859db --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzCustomIpPrefix.md @@ -0,0 +1,348 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azcustomipprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzCustomIpPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzCustomIpPrefix.md +--- + +# Update-AzCustomIpPrefix + +## SYNOPSIS +Updates a CustomIpPrefix + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Update-AzCustomIpPrefix -Name <String> -ResourceGroupName <String> [-Commission] [-Decommission] [-Provision] + [-Deprovision] [-NoInternetAdvertise] [-Cidr <String>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzCustomIpPrefix -InputObject <PSCustomIpPrefix> [-Commission] [-Decommission] [-Provision] + [-Deprovision] [-NoInternetAdvertise] [-Cidr <String>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByResourceIdParameterSet +``` +Update-AzCustomIpPrefix -ResourceId <String> [-Commission] [-Decommission] [-Provision] [-Deprovision] + [-NoInternetAdvertise] [-Cidr <String>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzCustomIpPrefix** cmdlet allows the user to provision, commission, deprovision or decommission their CustomIpPrefix, or edit the tags or Cidr of the resource. + +## EXAMPLES + +### Example 1 : Commission the CustomIpPrefix +```powershell +Update-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Commission +``` + +The above command will start the commissioning process of the CustomIpPrefix. + +### Example 2 : Decommission the CustomIpPrefix +```powershell +Update-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Decommission +``` + +The above command will start the de-commissioning process of the CustomIpPrefix. + +### Example 3 : Provision the CustomIpPrefix +```powershell +Update-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Provision +``` + +The above command will start the provisioning process of the CustomIpPrefix. + +### Example 4 : Deprovision the CustomIpPrefix +```powershell +Update-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Deprovision +``` + +The above command will start the deprovisioning process of the CustomIpPrefix. + +### Example 5 : Update tags for the CustomIpPrefix +```powershell +Update-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Tag $tags +``` + +The above command will update the tags for the CustomIpPrefix. + +### Example 6 : Update CIDR for the CustomIpPrefix +```powershell +Update-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Cidr $cidr +``` + +The above command will update the cidr for the CustomIpPrefix. This would work only when resource is in validationfailed state. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cidr +The CIDR to update. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Commission +Commission the CustomIpPrefix resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Decommission +start decommissioning process. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: Decomission + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Deprovision +Deprovision the CustomIpPrefix resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The CustomIpPrefix to set. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSCustomIpPrefix +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -NoInternetAdvertise +Commission the CustomIpPrefix resource with no internet advertise + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Provision +Provision the CustomIpPrefix resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +The resource Id. + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateByInputObjectParameterSet, UpdateByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSCustomIpPrefix + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSCustomIpPrefix + +## NOTES + +## RELATED LINKS + +[Get-AzCustomIpPrefix](./Get-AzCustomIpPrefix.md) + +[New-AzCustomIpPrefix](./New-AzCustomIpPrefix.md) + +[Remove-AzCustomIpPrefix](./Remove-AzCustomIpPrefix.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Update-AzNetworkVirtualAppliance.md b/azps-10.1.0/Az.Network/Update-AzNetworkVirtualAppliance.md new file mode 100644 index 0000000000..305954f4d6 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzNetworkVirtualAppliance.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-aznetworkvirtualappliance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzNetworkVirtualAppliance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzNetworkVirtualAppliance.md +--- + +# Update-AzNetworkVirtualAppliance + +## SYNOPSIS +Update or Change a Network Virtual Appliance resource. + +## SYNTAX + +``` +Update-AzNetworkVirtualAppliance -Name <String> -ResourceGroupName <String> + [-Sku <PSVirtualApplianceSkuProperties>] [-VirtualApplianceAsn <Int32>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Update-AzNetworkVirtualAppliance modifies a Network Virtual Appliance resource. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzNetworkVirtualAppliance -ResourceGroupName testrg -Name nva -VirtualApplianceAsn 1234 +``` + +Modify the Virtual Appliance ASN number. + +### Example 2 + +Update or Change a Network Virtual Appliance resource. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Update-AzNetworkVirtualAppliance -Name nva -ResourceGroupName testrg -Sku <PSVirtualApplianceSkuProperties> +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +The Sku of the Virtual Appliance. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceSkuProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualApplianceAsn +The ASN number of the Virtual Appliance. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceSkuProperties + +### System.Int32 + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSNetworkVirtualAppliance + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Update-AzP2sVpnGateway.md b/azps-10.1.0/Az.Network/Update-AzP2sVpnGateway.md new file mode 100644 index 0000000000..94e43c20e9 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzP2sVpnGateway.md @@ -0,0 +1,464 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azp2svpngateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzP2sVpnGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzP2sVpnGateway.md +--- + +# Update-AzP2sVpnGateway + +## SYNOPSIS +Update an existing P2SVpnGateway under VirtualHub for point to site connectivity. + +## SYNTAX + +### ByP2SVpnGatewayNameNoVpnServerConfigurationUpdate (Default) +``` +Update-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> [-VpnClientAddressPool <String[]>] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-VpnGatewayScaleUnit <UInt32>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayNameByVpnServerConfigurationObject +``` +Update-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> [-VpnClientAddressPool <String[]>] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] + [-VpnServerConfiguration <PSVpnServerConfiguration>] [-VpnGatewayScaleUnit <UInt32>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayNameByVpnServerConfigurationResourceId +``` +Update-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> [-VpnClientAddressPool <String[]>] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] -VpnServerConfigurationId <String> + [-VpnGatewayScaleUnit <UInt32>] [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] + [-EnableInternetSecurityFlag] [-DisableInternetSecurityFlag] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayObjectNoVpnServerConfigurationUpdate +``` +Update-AzP2sVpnGateway -InputObject <PSP2SVpnGateway> [-VpnClientAddressPool <String[]>] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-VpnGatewayScaleUnit <UInt32>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayObjectByVpnServerConfigurationObject +``` +Update-AzP2sVpnGateway -InputObject <PSP2SVpnGateway> [-VpnClientAddressPool <String[]>] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] + [-VpnServerConfiguration <PSVpnServerConfiguration>] [-VpnGatewayScaleUnit <UInt32>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayObjectByVpnServerConfigurationResourceId +``` +Update-AzP2sVpnGateway -InputObject <PSP2SVpnGateway> [-VpnClientAddressPool <String[]>] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] -VpnServerConfigurationId <String> + [-VpnGatewayScaleUnit <UInt32>] [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] + [-EnableInternetSecurityFlag] [-DisableInternetSecurityFlag] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayResourceIdNoVpnServerConfigurationUpdate +``` +Update-AzP2sVpnGateway -ResourceId <String> [-VpnClientAddressPool <String[]>] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-VpnGatewayScaleUnit <UInt32>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayResourceIdByVpnServerConfigurationObject +``` +Update-AzP2sVpnGateway -ResourceId <String> [-VpnClientAddressPool <String[]>] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] + [-VpnServerConfiguration <PSVpnServerConfiguration>] [-VpnGatewayScaleUnit <UInt32>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByP2SVpnGatewayResourceIdByVpnServerConfigurationResourceId +``` +Update-AzP2sVpnGateway -ResourceId <String> [-VpnClientAddressPool <String[]>] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] -VpnServerConfigurationId <String> + [-VpnGatewayScaleUnit <UInt32>] [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] + [-EnableInternetSecurityFlag] [-DisableInternetSecurityFlag] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzP2sVpnGateway** cmdlet enables you to update an existing P2SVpnGateway under VirtualHub with new VpnClientAddressPool or new VpnServerConfiguration or change of VpnGatewayScaleUnit. + +## EXAMPLES + +### Example 1 +```powershell +$vpnClientAddressSpaces = New-Object string[] 1 +$vpnClientAddressSpaces[0] = "101.10.0.0/16" +Update-AzP2sVpnGateway -ResourceGroupName P2SCortexGATesting -Name 683482ade8564515aed4b8448c9757ea-westus-gw -VpnClientAddressPool $vpnClientAddressSpaces -EnableInternetSecurityFlag +``` + +```output +ResourceGroupName : P2SCortexGATesting +Name : 683482ade8564515aed4b8448c9757ea-westus-gw +Id : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482ade8564515a + ed4b8448c9757ea-westus-gw +Location : westus +VpnGatewayScaleUnit : 1 +VirtualHub : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/NilamdWestUsVirtualH + ub +VpnServerConfiguration : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/NilamdWe + stUsConfig +VpnServerConfigurationLocation : +VpnClientConnectionHealth : null +Type : Microsoft.Network/p2sVpnGateways +ProvisioningState : Succeeded +P2SConnectionConfigurations : [ + { + "ProvisioningState": "Succeeded", + "VpnClientAddressPool": { + "AddressPrefixes": [ + "101.10.0.0/16" + ] + }, + "EnableInternetSecurity": True, + "RoutingConfiguration": { + "AssociatedRouteTable": { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + }, + "Name": "P2SConnectionConfigDefault", + "Etag": "W/\"d7debc2f-ccbb-4f00-bddc-42c99b52fda3\"", + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482 + ade8564515aed4b8448c9757ea-westus-gw/p2sConnectionConfigurations/P2SConnectionConfigDefault" + } + ] +``` + +The **Update-AzP2sVpnGateway** cmdlet enables you to update an existing P2SVpnGateway under VirtualHub with new VpnClientAddressPool. When Point to site client connects with this P2SVpnGateway, one of the ip address from this VpnClientAddressPool gets allocated to that client. + +### Example 2 + +Update an existing P2SVpnGateway under VirtualHub for point to site connectivity. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Update-AzP2sVpnGateway -AsJob -Name 00000000-0000-0000-0000-00000000000000000-westus-gw -ResourceGroupName P2SCortexGATesting -VpnClientAddressPool <String[]> -VpnGatewayScaleUnit 1 -VpnServerConfiguration <PSVpnServerConfiguration> +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDnsServer +The list of Custom Dns Servers. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableInternetSecurityFlag +Disable internet security flag for this P2SVpnGateway connections + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternetSecurityFlag +Enable internet security flag for this P2SVpnGateway connections + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The p2s vpn gateway object to be modified + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +Parameter Sets: ByP2SVpnGatewayObjectNoVpnServerConfigurationUpdate, ByP2SVpnGatewayObjectByVpnServerConfigurationObject, ByP2SVpnGatewayObjectByVpnServerConfigurationResourceId +Aliases: P2SVpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The P2S vpn gateway name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayNameNoVpnServerConfigurationUpdate, ByP2SVpnGatewayNameByVpnServerConfigurationObject, ByP2SVpnGatewayNameByVpnServerConfigurationResourceId +Aliases: ResourceName, P2SVpnGatewayName, GatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -P2SConnectionConfiguration +The list of P2SConnectionConfigurations that this P2SVpnGateway needs to have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSP2SConnectionConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayNameNoVpnServerConfigurationUpdate, ByP2SVpnGatewayNameByVpnServerConfigurationObject, ByP2SVpnGatewayNameByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the P2SVpnGateway to be modified. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayResourceIdNoVpnServerConfigurationUpdate, ByP2SVpnGatewayResourceIdByVpnServerConfigurationObject, ByP2SVpnGatewayResourceIdByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoutingConfiguration +Routing configuration for this connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnClientAddressPool +P2S VpnClient AddressPool for this P2SVpnGateway P2SConnectionConfiguration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnGatewayScaleUnit +The scale unit for this P2SVpnGateway. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnServerConfiguration +The VpnServerConfiguration to be attached to this P2SVpnGateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration +Parameter Sets: ByP2SVpnGatewayNameByVpnServerConfigurationObject, ByP2SVpnGatewayObjectByVpnServerConfigurationObject, ByP2SVpnGatewayResourceIdByVpnServerConfigurationObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VpnServerConfigurationId +The id of Vpn server configuration object this P2SVpnGateway will be attached to. + +```yaml +Type: System.String +Parameter Sets: ByP2SVpnGatewayNameByVpnServerConfigurationResourceId, ByP2SVpnGatewayObjectByVpnServerConfigurationResourceId, ByP2SVpnGatewayResourceIdByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +System.String +Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway + +## NOTES + +## RELATED LINKS + +[New-AzRoutingConfiguration](./New-AzRoutingConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Update-AzRouteMap.md b/azps-10.1.0/Az.Network/Update-AzRouteMap.md new file mode 100644 index 0000000000..f649478b86 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzRouteMap.md @@ -0,0 +1,291 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azroutemap +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzRouteMap.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzRouteMap.md +--- + +# Update-AzRouteMap + +## SYNOPSIS +Update a route map of a VirtualHub. + +## SYNTAX + +### ByRouteMapName (Default) +``` +Update-AzRouteMap [-ResourceGroupName <String>] [-VirtualHubName <String>] [-Name <String>] + [-RouteMapRule <PSRouteMapRule[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Update-AzRouteMap [-Name <String>] [-VirtualHubObject <PSVirtualHub>] [-RouteMapRule <PSRouteMapRule[]>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRouteMapObject +``` +Update-AzRouteMap [-InputObject <PSRouteMap>] [-RouteMapRule <PSRouteMapRule[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRouteMapResourceId +``` +Update-AzRouteMap [-ResourceId <String>] [-RouteMapRule <PSRouteMapRule[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update a route map of a VirtualHub. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" + +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" + +# creating new route map rules and a new route map resource and new routing configuration +$routeMapMatchCriterion1 = New-AzRouteMapRuleCriterion -MatchCondition "Contains" -RoutePrefix @("10.0.0.0/16") +$routeMapActionParameter1 = New-AzRouteMapRuleActionParameter -AsPath @("12345") +$routeMapAction1 = New-AzRouteMapRuleAction -Type "Add" -Parameter @($routeMapActionParameter1) +$routeMapRule1 = New-AzRouteMapRule -Name "rule1" -MatchCriteria @($routeMapMatchCriterion1) -RouteMapRuleAction @($routeMapAction1) -NextStepIfMatched "Continue" + +$routeMapMatchCriterion2 = New-AzRouteMapRuleCriterion -MatchCondition "Equals" -AsPath @("12345") +$routeMapAction2 = New-AzRouteMapRuleAction -Type "Drop" +$routeMapRule2 = New-AzRouteMapRule -Name "rule2" -MatchCriteria @($routeMapMatchCriterion2) -RouteMapRuleAction @($routeMapAction2) -NextStepIfMatched "Terminate" + +New-AzRouteMap -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteMap" -RouteMapRule @($routeMapRule1, $routeMapRule2) +Update-AzRouteMap -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteMap" -RouteMapRule @($routeMapRule2) +``` + +```output +Name : testRouteMap +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/routemap0419/providers/Microsoft.Network/virtualHubs/westcentralus_hub1/routeMaps/tes + tRouteMap +ProvisioningState : Succeeded +RouteMapRules : [ + { + "MatchCriteria": [ + { + "MatchCondition": "Equals", + "RoutePrefix": [], + "Community": [], + "AsPath": [ + "12345" + ] + } + ], + "Actions": [ + { + "Type": "Drop", + "Parameters": [] + } + ], + "NextStepIfMatched": "Terminate", + "Name": "rule2" + } + ] +AssociatedInboundConnections : [] +AssociatedOutboundConnections : [] +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The route map object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteMap +Parameter Sets: ByRouteMapObject +Aliases: RouteMap + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The route map name. + +```yaml +Type: System.String +Parameter Sets: ByRouteMapName, ByVirtualHubObject +Aliases: ResourceName, RouteMapName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByRouteMapName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Route Map Resource Id. + +```yaml +Type: System.String +Parameter Sets: ByRouteMapResourceId +Aliases: RouteMapId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteMapRule +List of route map rules in the route map. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteMapRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubName +The Virtual Hub name. + +```yaml +Type: System.String +Parameter Sets: ByRouteMapName +Aliases: ParentVirtualHubName, ParentResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubObject +The Virtual Hub Object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub, ParentVirtualHub + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteMap + +## NOTES + +## RELATED LINKS + +[New-AzRouteMap](./New-AzRouteMap.md) + +[New-AzRouteMapRule](./New-AzRouteMapRule.md) + +[Get-AzRouteMap](./Get-AzRouteMap.md) + +[Remove-AzRouteMap](./Remove-AzRouteMap.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Update-AzRouteServer.md b/azps-10.1.0/Az.Network/Update-AzRouteServer.md new file mode 100644 index 0000000000..0ac3040af7 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzRouteServer.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azrouteserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzRouteServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzRouteServer.md +--- + +# Update-AzRouteServer + +## SYNOPSIS +Update an Azure RouteServer. + +## SYNTAX + +### RouteServerNameParameterSet (Default) +``` +Update-AzRouteServer -ResourceGroupName <String> -RouteServerName <String> [-AllowBranchToBranchTraffic] + [-HubRoutingPreference <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RouteServerResourceIdParameterSet +``` +Update-AzRouteServer [-AllowBranchToBranchTraffic] -ResourceId <String> [-HubRoutingPreference <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzRouteServer** cmdlet switches the branch-to-branch traffic to an Azure RouteServer. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzRouteServer -ResourceGroupName $rgname -RouteServerName $routeServerName -AllowBranchToBranchTraffic +``` + +To enable branch to branch traffic for route server. + +### Example 2 +```powershell +Update-AzRouteServer -ResourceGroupName $rgname -RouteServerName $routeServerName +``` + +To disable branch to branch traffic for route server. + +### Example 3 +```powershell +Update-AzRouteServer -ResourceGroupName $rgname -RouteServerName $routeServerName -HubRoutingPreference "AsPath" +``` + +To change routing preference for route server. + +## PARAMETERS + +### -AllowBranchToBranchTraffic +Flag to allow branch to branch traffic for route server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubRoutingPreference +Routing Preference to route traffic + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: ExpressRoute, VpnGateway, ASPath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the route server. + +```yaml +Type: System.String +Parameter Sets: RouteServerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +ResourceId of the route server. + +```yaml +Type: System.String +Parameter Sets: RouteServerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteServerName +The name of the route server. + +```yaml +Type: System.String +Parameter Sets: RouteServerNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteServer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Update-AzRouteServerPeer.md b/azps-10.1.0/Az.Network/Update-AzRouteServerPeer.md new file mode 100644 index 0000000000..bf765e0f27 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzRouteServerPeer.md @@ -0,0 +1,264 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azrouteserverpeer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzRouteServerPeer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzRouteServerPeer.md +--- + +# Update-AzRouteServerPeer + +## SYNOPSIS +Update a Peer in an Azure RouteServer + +## SYNTAX + +### RouteServerNameParameterSet (Default) +``` +Update-AzRouteServerPeer -ResourceGroupName <String> -RouteServerName <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RouteServerNPeerNameParameterSet +``` +Update-AzRouteServerPeer -ResourceGroupName <String> -PeerName <String> -PeerIp <String> -PeerAsn <UInt32> + -RouteServerName <String> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RouteServerNPeerInputObjectParameterSet +``` +Update-AzRouteServerPeer -ResourceGroupName <String> -RouteServerName <String> -InputObject <PSRouteServerPeer> + [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RouteServerNPeerResourceIdParameterSet +``` +Update-AzRouteServerPeer -ResourceGroupName <String> -RouteServerName <String> -ResourceId <String> [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzRouteServerPeer** cmdlet updates a RouteServer Peer to an Azure RouteServer + +## EXAMPLES + +### Example 1 +```powershell +Update-AzRouteServerPeer -PeerName csr -PeerIp 10.0.1.5 -PeerAsn 63000 -RouteServerName routeServer -ResourceGroupName routeServerRG +``` + +### Example 2 +```powershell +$routeServerPeerId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/routeServerRG/providers/Microsoft.Network/virtualHubs/routeServer/bgpConnections/csr' +Update-AzRouteServerPeer -ResourceId $routeServerPeerId -RouteServerName routeServer -ResourceGroupName routeServerRG +``` + +### Example 3 +```powershell +$routeServerPeer = Get-AzRouteServerPeer -ResourceGroupName routeServer -RouteServerName routeServer -PeerName csr +Update-AzRouteServerPeer -ResourceGroupName routeServerRG -InputObject $routeServerPeer -RouteServerName routeServer +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The route server peer input object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRouteServerPeer +Parameter Sets: RouteServerNPeerInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PeerAsn +ASN of remote route server peer. + +```yaml +Type: System.UInt32 +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerIp +Ip of remote route server peer. + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerName +The name of the route server Peer. + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the route server/peer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The route server peer resource Id. + +```yaml +Type: System.String +Parameter Sets: RouteServerNPeerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteServerName +The route server where peer exists. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.UInt32 + +### Microsoft.Azure.Commands.Network.Models.PSRouteServerPeer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSRouteServer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Update-AzVHubRouteTable.md b/azps-10.1.0/Az.Network/Update-AzVHubRouteTable.md new file mode 100644 index 0000000000..8e5127a907 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVHubRouteTable.md @@ -0,0 +1,300 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvhubroutetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVHubRouteTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVHubRouteTable.md +--- + +# Update-AzVHubRouteTable + +## SYNOPSIS +Delete a hub route table resource associated with a VirtualHub. + +## SYNTAX + +### ByVHubRouteTableName (Default) +``` +Update-AzVHubRouteTable -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + [-Route <PSVHubRoute[]>] [-Label <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Update-AzVHubRouteTable -Name <String> -ParentObject <PSVirtualHub> [-Route <PSVHubRoute[]>] + [-Label <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVHubRouteTableObject +``` +Update-AzVHubRouteTable -InputObject <PSVHubRouteTable> [-Route <PSVHubRoute[]>] [-Label <String[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVHubRouteTableResourceId +``` +Update-AzVHubRouteTable -ResourceId <String> [-Route <PSVHubRoute[]>] [-Label <String[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the specified route table that is associated with the specified virtual hub with the provided routes or the labels. + +## EXAMPLES + +### Example 1 +```powershell +New-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" -Location "westcentralus" -VirtualWANType "Standard" -AllowVnetToVnetTraffic -AllowBranchToBranchTraffic +$virtualWan = Get-AzVirtualWan -ResourceGroupName "testRg" -Name "testWan" + +New-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" -Location "westcentralus" -AddressPrefix "10.0.0.0/16" -VirtualWan $virtualWan +$virtualHub = Get-AzVirtualHub -ResourceGroupName "testRg" -Name "testHub" + +$fwIp = New-AzFirewallHubPublicIpAddress -Count 1 +$hubIpAddresses = New-AzFirewallHubIpAddress -PublicIP $fwIp +New-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" -Location "westcentralus" -Sku AZFW_Hub -VirtualHubId $virtualHub.Id -HubIPAddress $hubIpAddresses +$firewall = Get-AzFirewall -Name "testFirewall" -ResourceGroupName "testRg" + +$route1 = New-AzVHubRoute -Name "private-traffic" -Destination @("10.30.0.0/16", "10.40.0.0/16") -DestinationType "CIDR" -NextHop $firewall.Id -NextHopType "ResourceId" +New-AzVHubRouteTable -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteTable" -Route @($route1) -Label @("testLabel") +Get-AzVHubRouteTable -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteTable" + +$route2 = New-AzVHubRoute -Name "internet-traffic" -Destination @("0.0.0.0/0") -DestinationType "CIDR" -NextHop $firewall.Id -NextHopType "ResourceId" +Update-AzVHubRouteTable -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteTable" -Route @($route2) +Get-AzVHubRouteTable -ResourceGroupName "testRg" -VirtualHubName "testHub" -Name "testRouteTable" +``` + +```output +Name : testRouteTable +Id : /subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/testHub/hubRouteTables/testRouteTable +ProvisioningState : Succeeded +Labels : {testLabel} +Routes : [ + { + "Name": "internet-traffic", + "DestinationType": "CIDR", + "Destinations": [ + "0.0.0.0/0" + ], + "NextHopType": "ResourceId", + "NextHop": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/azureFirewalls/testFirewall" + } + ] +AssociatedConnections : [] +PropagatingConnections : [] +``` + +This command deletes the hub route table of the virtual hub. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The vhubroutetable resource to Update. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVHubRouteTable +Parameter Sets: ByVHubRouteTableObject +Aliases: VHubRouteTable, RouteTable + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Label +The list of labels. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVHubRouteTableName, ByVirtualHubObject +Aliases: ResourceName, VHubRouteTableName, RouteTableName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The parent virtual hub object of this resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVHubRouteTableName +Aliases: VirtualHubName, ParentVirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVHubRouteTableName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the vhubroutetable resource to Update. + +```yaml +Type: System.String +Parameter Sets: ByVHubRouteTableResourceId +Aliases: VHubRouteTableId, RouteTableId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Route +The list of routes for this route table. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVHubRoute[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### Microsoft.Azure.Commands.Network.Models.PSVHubRouteTable + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVHubRouteTable + +## NOTES + +## RELATED LINKS + +[Get-AzVHubRouteTable](./Get-AzVHubRouteTable.md) + +[New-AzVHubRoute](./New-AzVHubRoute.md) + +[New-AzVHubRouteTable](./New-AzVHubRouteTable.md) + +[Remove-AzVHubRouteTable](./Remove-AzVHubRouteTable.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Network/Update-AzVirtualApplianceSite.md b/azps-10.1.0/Az.Network/Update-AzVirtualApplianceSite.md new file mode 100644 index 0000000000..bbbba2910a --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVirtualApplianceSite.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvirtualappliancesite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualApplianceSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualApplianceSite.md +--- + +# Update-AzVirtualApplianceSite + +## SYNOPSIS +Change or Modify a Virtual Appliance site connected to a Network Virtual Appliance resource. + +## SYNTAX + +``` +Update-AzVirtualApplianceSite -Name <String> -ResourceGroupName <String> -NetworkVirtualApplianceId <String> + [-AddresssPrefix <String>] [-O365Policy <PSOffice365PolicyProperties>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Update-AzVirtualApplianceSite command modifies a Virtual Appliance site resource. + +## EXAMPLES + +### Example 1 +```powershell +$nva=Get-AzNetworkVirtualAppliance -ResourceGroupName testrg -Name nva +Update-AzVirtualApplianceSite -Name testsite -ResourceGroupName testrg -AddresssPrefix 10.0.4.0/24 -NetworkVirtualApplianceId $nva.Id +``` + +Modify the address prefix for a Virtual Appliance site resource. + +## PARAMETERS + +### -AddresssPrefix +The address prefix for the site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkVirtualApplianceId +Network virtual appliance that this site is attached to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -O365Policy +Office 365 breakout policy. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSOffice365PolicyProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSOffice365PolicyProperties + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualApplianceSite + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Update-AzVirtualHub.md b/azps-10.1.0/Az.Network/Update-AzVirtualHub.md new file mode 100644 index 0000000000..fb1cc78452 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVirtualHub.md @@ -0,0 +1,411 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvirtualhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualHub.md +--- + +# Update-AzVirtualHub + +## SYNOPSIS +Updates a virtual hub. + +## SYNTAX + +### ByVirtualHubName (Default) +``` +Update-AzVirtualHub -ResourceGroupName <String> -Name <String> [-AddressPrefix <String>] + [-HubVnetConnection <PSHubVirtualNetworkConnection[]>] [-RouteTable <PSVirtualHubRouteTable>] + [-Tag <Hashtable>] [-Sku <String>] [-PreferredRoutingGateway <String>] [-HubRoutingPreference <String>] + [-VirtualRouterAsn <UInt32>] [-VirtualRouterAutoScaleConfiguration <PSVirtualRouterAutoScaleConfiguration>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceId +``` +Update-AzVirtualHub -ResourceId <String> [-AddressPrefix <String>] + [-HubVnetConnection <PSHubVirtualNetworkConnection[]>] [-RouteTable <PSVirtualHubRouteTable>] + [-Tag <Hashtable>] [-Sku <String>] [-PreferredRoutingGateway <String>] [-HubRoutingPreference <String>] + [-VirtualRouterAsn <UInt32>] [-VirtualRouterAutoScaleConfiguration <PSVirtualRouterAutoScaleConfiguration>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObject +``` +Update-AzVirtualHub -InputObject <PSVirtualHub> [-AddressPrefix <String>] + [-HubVnetConnection <PSHubVirtualNetworkConnection[]>] [-RouteTable <PSVirtualHubRouteTable>] + [-Tag <Hashtable>] [-Sku <String>] [-PreferredRoutingGateway <String>] [-HubRoutingPreference <String>] + [-VirtualRouterAsn <UInt32>] [-VirtualRouterAutoScaleConfiguration <PSVirtualRouterAutoScaleConfiguration>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzVirtualHub** cmdlet updates a virtual hub. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +Update-AzVirtualHub -InputObject $virtualHub -AddressPrefix "10.0.2.0/24" +``` + +```output +VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +ResourceGroupName : testRG +Name : westushub +Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub +AddressPrefix : 10.0.2.0/24 +RouteTable : +VirtualNetworkConnections : {} +Location : West US +Sku : Standard +Type : Microsoft.Network/virtualHubs +ProvisioningState : Succeeded +``` + +The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". + +### Example 2 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +$route1 = New-AzVirtualHubRoute -AddressPrefix @("10.0.0.0/16", "11.0.0.0/16") -NextHopIpAddress "12.0.0.5" +$route2 = New-AzVirtualHubRoute -AddressPrefix @("13.0.0.0/16") -NextHopIpAddress "14.0.0.5" +$routeTable = New-AzVirtualHubRouteTable -Route @($route1, $route2) +Update-AzVirtualHub -ResourceGroupName "testRG" -Name "westushub" -RouteTable $routeTable +``` + +```output +VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +ResourceGroupName : testRG +Name : westushub +Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub +AddressPrefix : 192.168.2.0/24 +RouteTable : Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable +VirtualNetworkConnections : {} +Location : West US +Sku : Standard +Type : Microsoft.Network/virtualHubs +ProvisioningState : Succeeded +``` + +The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". +This example is similar to Example 1, but also attaches a route table to the virtual hub. + +### Example 3 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +Update-AzVirtualHub -ResourceGroupName "testRG" -Name "westushub" -HubRoutingPreference "VpnGateway" +``` + +```output +VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +ResourceGroupName : testRG +Name : westushub +Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub +AddressPrefix : 10.0.1.0/24 +RouteTable : +Location : West US +Sku : Standard +HubRoutingPreference : VpnGateway +VirtualNetworkConnections : {} +Location : West US +Type : Microsoft.Network/virtualHubs +ProvisioningState : Succeeded +``` + +The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have preferred routing gateway as ExpressRoute initially and will then be updated to VpnGateway. + +## PARAMETERS + +### -AddressPrefix +The address space string for this virtual hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubRoutingPreference +Virtual Hub Routing Preference to route traffic + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: ExpressRoute, VpnGateway, ASPath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubVnetConnection +The hub virtual network connections associated with this Virtual Hub. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Virtual hub object to be modified. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObject +Aliases: VirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: ResourceName, VirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredRoutingGateway +Preferred Routing Gateway to Route On-Prem traffic from VNET (Deprecated, please use HubRoutingPreference) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: ExpressRoute, VpnGateway + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the Virtual hub to be modified. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceId +Aliases: VirtualHubId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouteTable +The route table associated with this Virtual Hub. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The sku of the Virtual Hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualRouterAsn +The ASN of this virtual hub + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualRouterAutoScaleConfiguration +Autoscale configuration for the hub router + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualRouterAutoScaleConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualHub](./Get-AzVirtualHub.md) + +[New-AzVirtualHub](./New-AzVirtualHub.md) + +[Remove-AzVirtualHub](./Remove-AzVirtualHub.md) diff --git a/azps-10.1.0/Az.Network/Update-AzVirtualHubBgpConnection.md b/azps-10.1.0/Az.Network/Update-AzVirtualHubBgpConnection.md new file mode 100644 index 0000000000..cc6a2baac2 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVirtualHubBgpConnection.md @@ -0,0 +1,395 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvirtualhubbgpconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualHubBgpConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualHubBgpConnection.md +--- + +# Update-AzVirtualHubBgpConnection + +## SYNOPSIS +The Update-AzVirtualHubBgpConnection cmdlet updates an existing HubBgpConnection resource (Virtual WAN Hub BGP Connection). + +## SYNTAX + +### ByVirtualHubNameByHubVirtualNetworkConnectionObject (Default) +``` +Update-AzVirtualHubBgpConnection -ResourceGroupName <String> -VirtualHubName <String> -Name <String> + -PeerIp <String> -PeerAsn <UInt32> -VirtualHubVnetConnection <PSHubVirtualNetworkConnection> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubNameByHubVirtualNetworkConnectionResourceId +``` +Update-AzVirtualHubBgpConnection -ResourceGroupName <String> -VirtualHubName <String> -Name <String> + -PeerIp <String> -PeerAsn <UInt32> -VirtualHubVnetConnectionId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObjectByHubVirtualNetworkConnectionObject +``` +Update-AzVirtualHubBgpConnection -Name <String> -PeerIp <String> -PeerAsn <UInt32> + -VirtualHubVnetConnection <PSHubVirtualNetworkConnection> -VirtualHub <PSVirtualHub> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId +``` +Update-AzVirtualHubBgpConnection -Name <String> -PeerIp <String> -PeerAsn <UInt32> + -VirtualHubVnetConnectionId <String> -VirtualHub <PSVirtualHub> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionObject +``` +Update-AzVirtualHubBgpConnection -PeerIp <String> -PeerAsn <UInt32> + -VirtualHubVnetConnection <PSHubVirtualNetworkConnection> -ResourceId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionResourceId +``` +Update-AzVirtualHubBgpConnection -PeerIp <String> -PeerAsn <UInt32> -VirtualHubVnetConnectionId <String> + -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByHubBgpConnectionObjectByHubVirtualNetworkConnectionObject +``` +Update-AzVirtualHubBgpConnection [-PeerIp <String>] [-PeerAsn <UInt32>] + -VirtualHubVnetConnection <PSHubVirtualNetworkConnection> -InputObject <PSBgpConnection> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByHubBgpConnectionObjectByHubVirtualNetworkConnectionResourceId +``` +Update-AzVirtualHubBgpConnection [-PeerIp <String>] [-PeerAsn <UInt32>] -VirtualHubVnetConnectionId <String> + -InputObject <PSBgpConnection> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByHubBgpConnectionObject +``` +Update-AzVirtualHubBgpConnection [-PeerIp <String>] [-PeerAsn <UInt32>] + [-VirtualHubVnetConnection <PSHubVirtualNetworkConnection>] [-VirtualHubVnetConnectionId <String>] + -InputObject <PSBgpConnection> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The Update-AzVirtualHubBgpConnection cmdlet updates an existing HubBgpConnection resource (Virtual WAN Hub BGP Connection). + +## EXAMPLES + +### Example 1 +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "192.168.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "192.168.2.0/24" +$remoteVirtualNetwork = New-AzVirtualNetwork -Name "testVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "192.168.0.0/16" -Subnet $frontendSubnet,$backendSubnet +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "testWan" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "testHub" -AddressPrefix "10.0.1.0/24" +$hubVnetConnection = New-AzVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -Name "testVnetConnection" -RemoteVirtualNetwork $remoteVirtualNetwork +New-AzVirtualHubBgpConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -PeerIp 192.168.1.5 -PeerAsn 20000 -Name "testBgpConnection" -VirtualHubVnetConnection $hubVnetConnection +Update-AzVirtualHubBgpConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -PeerIp 192.168.1.6 -PeerAsn 20000 -Name "testBgpConnection" -VirtualHubVnetConnection $hubVnetConnection +``` + +```output +Name : testBgpConnection +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/bgpConnections/testBgpConnection +HubVirtualNetworkConnection : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/hubVirtualNetworkConnections/testVnetConnection +PeerAsn : 20000 +PeerIp : 192.168.1.6 +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual WAN Hub in West US and connect the Virtual Network to the Virtual WAN Hub in that resource group in Azure. A Virtual WAN Hub BGP Connection will be created thereafter which will peer the Virtual WAN Hub with the network appliance deployed in the Virtual Network. This Virtual WAN Hub BGP Connection is then updated to have a different Peer IP. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual hub bgp connection resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSBgpConnection +Parameter Sets: ByHubBgpConnectionObjectByHubVirtualNetworkConnectionObject, ByHubBgpConnectionObjectByHubVirtualNetworkConnectionResourceId, ByHubBgpConnectionObject +Aliases: VirtualHubBgpConnection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByHubVirtualNetworkConnectionObject, ByVirtualHubNameByHubVirtualNetworkConnectionResourceId, ByVirtualHubObjectByHubVirtualNetworkConnectionObject, ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId +Aliases: ResourceName, BgpConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerAsn +The peer ASN. + +```yaml +Type: System.UInt32 +Parameter Sets: ByVirtualHubNameByHubVirtualNetworkConnectionObject, ByVirtualHubNameByHubVirtualNetworkConnectionResourceId, ByVirtualHubObjectByHubVirtualNetworkConnectionObject, ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId, ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionObject, ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.UInt32 +Parameter Sets: ByHubBgpConnectionObjectByHubVirtualNetworkConnectionObject, ByHubBgpConnectionObjectByHubVirtualNetworkConnectionResourceId, ByHubBgpConnectionObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerIp +The peer IP. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByHubVirtualNetworkConnectionObject, ByVirtualHubNameByHubVirtualNetworkConnectionResourceId, ByVirtualHubObjectByHubVirtualNetworkConnectionObject, ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId, ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionObject, ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByHubBgpConnectionObjectByHubVirtualNetworkConnectionObject, ByHubBgpConnectionObjectByHubVirtualNetworkConnectionResourceId, ByHubBgpConnectionObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByHubVirtualNetworkConnectionObject, ByVirtualHubNameByHubVirtualNetworkConnectionResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id. + +```yaml +Type: System.String +Parameter Sets: ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionObject, ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionResourceId +Aliases: BgpConnectionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The virtual hub resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObjectByHubVirtualNetworkConnectionObject, ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId +Aliases: ParentObject, ParentVirtualHub + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubName +The virtual hub name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByHubVirtualNetworkConnectionObject, ByVirtualHubNameByHubVirtualNetworkConnectionResourceId +Aliases: ParentResourceName, ParentVirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubVnetConnection +The VirtualHubVnetConnection resource. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection +Parameter Sets: ByVirtualHubNameByHubVirtualNetworkConnectionObject, ByVirtualHubObjectByHubVirtualNetworkConnectionObject, ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionObject, ByHubBgpConnectionObjectByHubVirtualNetworkConnectionObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection +Parameter Sets: ByHubBgpConnectionObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHubVnetConnectionId +The VirtualHubVnetConnection resource id. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByHubVirtualNetworkConnectionResourceId, ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId, ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionResourceId, ByHubBgpConnectionObjectByHubVirtualNetworkConnectionResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByHubBgpConnectionObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub + +### Microsoft.Azure.Commands.Network.Models.PSBgpConnection + +### Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSBgpConnection + +## NOTES + +## RELATED LINKS + +[New-AzVirtualHubBgpConnection](./Update-AzVirtualHubBgpConnection.md) + +[Get-AzVirtualHubBgpConnection](./Get-AzVirtualHubBgpConnection.md) + +[Remove-AzVirtualHubBgpConnection](./Remove-AzVirtualHubBgpConnection.md) diff --git a/azps-10.1.0/Az.Network/Update-AzVirtualHubVnetConnection.md b/azps-10.1.0/Az.Network/Update-AzVirtualHubVnetConnection.md new file mode 100644 index 0000000000..ba8467f0b7 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVirtualHubVnetConnection.md @@ -0,0 +1,266 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvirtualhubvnetconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualHubVnetConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualHubVnetConnection.md +--- + +# Update-AzVirtualHubVnetConnection + +## SYNOPSIS +Updates an existing HubVirtualNetworkConnection. + +## SYNTAX + +### ByHubVirtualNetworkConnectionName (Default) +``` +Update-AzVirtualHubVnetConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + [-EnableInternetSecurity <Boolean>] [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByHubVirtualNetworkConnectionObject +``` +Update-AzVirtualHubVnetConnection -InputObject <PSHubVirtualNetworkConnection> + [-EnableInternetSecurity <Boolean>] [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByHubVirtualNetworkConnectionResourceId +``` +Update-AzVirtualHubVnetConnection -ResourceId <String> [-EnableInternetSecurity <Boolean>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing HubVirtualNetworkConnection. + +## EXAMPLES + +### Example 1 +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" +$backendSubnet = New-AzVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" +$remoteVirtualNetwork = New-AzVirtualNetwork -Name "MyVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet +$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" +New-AzVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "westushub" -Name "testvnetconnection" -RemoteVirtualNetwork $remoteVirtualNetwork +Update-AzVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "westushub" -Name "testvnetconnection" -EnableInternetSecurity $true +``` + +```output +Name : testvnetconnection +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubVirtualNetworkConnections/testvnetconnection +RemoteVirtualNetwork : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork +EnableInternetSecurity : True +ProvisioningState : Succeeded +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + }, + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in Central US in that resource group in Azure. A Virtual Network Connection is also created which is peer the Virtual Network to the Virtual Hub. This Virtual Network Connection is then updated to enable internet security. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternetSecurity +Enable internet security for this connection. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The hubvirtualnetworkconnection resource to modify. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection +Parameter Sets: ByHubVirtualNetworkConnectionObject +Aliases: HubVirtualNetworkConnection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByHubVirtualNetworkConnectionName +Aliases: ResourceName, HubVirtualNetworkConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByHubVirtualNetworkConnectionName +Aliases: VirtualHubName, ParentVirtualHubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByHubVirtualNetworkConnectionName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the hubvirtualnetworkconnection resource to modify. + +```yaml +Type: System.String +Parameter Sets: ByHubVirtualNetworkConnectionResourceId +Aliases: HubVirtualNetworkConnectionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoutingConfiguration +Routing configuration for this connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection + +## NOTES + +## RELATED LINKS + +[New-AzRoutingConfiguration](./New-AzRoutingConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Update-AzVirtualNetworkGatewayNatRule.md b/azps-10.1.0/Az.Network/Update-AzVirtualNetworkGatewayNatRule.md new file mode 100644 index 0000000000..0a0d304098 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVirtualNetworkGatewayNatRule.md @@ -0,0 +1,305 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvirtualnetworkgatewaynatrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualNetworkGatewayNatRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualNetworkGatewayNatRule.md +--- + +# Update-AzVirtualNetworkGatewayNatRule + +## SYNOPSIS +Updates a Virtual Network Gateway NatRule. + +## SYNTAX + +### ByVirtualNetworkGatewayNatRuleName (Default) +``` +Update-AzVirtualNetworkGatewayNatRule -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + [-InternalMapping <String[]>] [-ExternalMapping <String[]>] [-InternalPortRange <String[]>] + [-ExternalPortRange <String[]>] [-IpConfigurationId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualNetworkGatewayNatRuleResourceId +``` +Update-AzVirtualNetworkGatewayNatRule -ResourceId <String> [-InternalMapping <String[]>] + [-ExternalMapping <String[]>] [-InternalPortRange <String[]>] [-ExternalPortRange <String[]>] + [-IpConfigurationId <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualNetworkGatewayNatRuleObject +``` +Update-AzVirtualNetworkGatewayNatRule -InputObject <PSVirtualNetworkGatewayNatRule> + [-InternalMapping <String[]>] [-ExternalMapping <String[]>] [-InternalPortRange <String[]>] + [-ExternalPortRange <String[]>] [-IpConfigurationId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +**Update-AzVirtualNetworkGatewayNatRule** cmdlet sets or updates a virtual network gateway nat rule. + +## EXAMPLES + +### Example 1: +```powershell +$natRule1 = Get-AzVirtualNetworkGatewayNatRule -ResourceGroupName "rg1" -Name "natRule1" -ParentResourceName "gw1" +Update-AzVirtualNetworkGatewayNatRule -InputObject $natRule1 -ExternalMapping @("30.0.0.0/16") -InternalMapping @("25.0.0.0/16") -IpConfigurationId "/subscriptions/7afd8f92-c220-4f53-886e-1df53a69afd4/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gw1/ipConfigurations/default" +``` + +```output +Name : natRule1 +ProvisioningState : Succeeded +Type : Static +Mode : IngressSnat +InternalMappings : [ + { + "AddressSpace": "25.0.0.0/16" + } + ] +ExternalMappings : [ + { + "AddressSpace": "30.0.0.0/16" + } + ] +IpConfigurationId : /subscriptions/7afd8f92-c220-4f53-886e-1df53a69afd4/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gw1/ipConfigurations/default +Id : /subscriptions/7afd8f92-c220-4f53-886e-1df53a69afd4/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gw1/natRules/natRule1 +Etag : W/"5150d788-e165-42ba-99c4-8138a545fce9" +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalMapping +The list of private IP address subnet external mappings for NAT + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalPortRange +The list of external port range mappings for NAT subnets + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The VirtualNetworkGatewayNatRule object to update. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayNatRule +Parameter Sets: ByVirtualNetworkGatewayNatRuleObject +Aliases: VirtualNetworkGatewayNatRule + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InternalMapping +The list of private IP address subnet internal mappings for NAT + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalPortRange +The list of internal port range mappings for NAT subnets + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfigurationId +The IP Configuration ID this NAT rule applies to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualNetworkGatewayNatRuleName +Aliases: ResourceName, VirtualNetworkGatewayNatRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualNetworkGatewayNatRuleName +Aliases: ParentVirtualNetworkGatewayName, VirtualNetworkGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualNetworkGatewayNatRuleName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the VirtualNetworkGatewayNatRule object to update. + +```yaml +Type: System.String +Parameter Sets: ByVirtualNetworkGatewayNatRuleResourceId +Aliases: VirtualNetworkGatewayNatRuleResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayNatRule + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayNatRule + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualNetworkGatewayNatRule](./Get-AzVirtualNetworkGatewayNatRule.md) + +[Remove-AzVirtualNetworkGatewayNatRule](./Remove-AzVirtualNetworkGatewayNatRule.md) + +[New-AzVirtualNetworkGatewayNatRule](./New-AzVirtualNetworkGatewayNatRule.md) diff --git a/azps-10.1.0/Az.Network/Update-AzVirtualRouter.md b/azps-10.1.0/Az.Network/Update-AzVirtualRouter.md new file mode 100644 index 0000000000..7a61c20a05 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVirtualRouter.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvirtualrouter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualRouter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualRouter.md +--- + +# Update-AzVirtualRouter + +## SYNOPSIS +Updates a Virtual Router. + +## SYNTAX + +### VirtualRouterNameParameterSet (Default) +``` +Update-AzVirtualRouter -ResourceGroupName <String> -RouterName <String> [-AllowBranchToBranchTraffic] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### VirtualRouterResourceIdParameterSet +``` +Update-AzVirtualRouter [-AllowBranchToBranchTraffic] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates Virtual Router to enable or disable branch to branch traffic. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzVirtualRouter -ResourceGroupName $rgname -RouterName $virtualRouterName -AllowBranchToBranchTraffic +``` + +Updates the Virtual Router to allow branch to branch traffic + +### Example 2 +```powershell +Update-AzVirtualRouter -ResourceGroupName $rgname -RouterName $virtualRouterName +``` + +Updates the Virtual Router to block branch to branch traffic + +## PARAMETERS + +### -AllowBranchToBranchTraffic +Flag to allow branch to branch traffic for virtual router. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the virtual router. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceId +ResourceId of the virtual router. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RouterName +The name of the virtual router. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualRouter + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Update-AzVirtualRouterPeer.md b/azps-10.1.0/Az.Network/Update-AzVirtualRouterPeer.md new file mode 100644 index 0000000000..35a77a657a --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVirtualRouterPeer.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvirtualrouterpeer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualRouterPeer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualRouterPeer.md +--- + +# Update-AzVirtualRouterPeer + +## SYNOPSIS +Update a Peer in an Azure VirtualRouter + +## SYNTAX + +### VirtualRouterNameParameterSet (Default) +``` +Update-AzVirtualRouterPeer -ResourceGroupName <String> -VirtualRouterName <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### VirtualRouterPeerNameParameterSet +``` +Update-AzVirtualRouterPeer -ResourceGroupName <String> -PeerName <String> -PeerIp <String> -PeerAsn <UInt32> + -VirtualRouterName <String> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### VirtualRouterPeerObjectParameterSet +``` +Update-AzVirtualRouterPeer -ResourceGroupName <String> -VirtualRouterName <String> + -InputObject <PSVirtualRouterPeer> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### VirtualRouterPeerResourceIdParameterSet +``` +Update-AzVirtualRouterPeer -ResourceGroupName <String> -VirtualRouterName <String> -ResourceId <String> + [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzVirtualRouterPeer** cmdlet updates a VirtualRouter Peer to an Azure VirtualRouter + +## EXAMPLES + +### Example 1 +```powershell +Update-AzVirtualRouterPeer -PeerName csr -PeerIp 10.0.1.5 -PeerAsn 63000 -VirtualRouterName virtualRouter -ResourceGroupName virtualRouterRG +``` + +### Example 2 +```powershell +$virtualRouterPeerId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/virtualRouterRG/providers/Microsoft.Network/virtualRouters/testVirtualRouter/peerings/csr' +Update-AzVirtualRouterPeer -ResourceId $virtualRouterPeerId -VirtualRouterName virtualRouter -ResourceGroupName virtualRouterRG +``` + +### Example 3 +```powershell +$virtualRouterPeer = Get-AzVirtualRouterPeer -ResourceGroupName testVirtualRouter -VirtualRouterName virtualRouter -PeerName csr +Update-AzVirtualRouterPeer -ResourceGroupName virtualRouterRG -InputObject $virtualRouterPeer -VirtualRouterName virtualRouter +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual router peer input object. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualRouterPeer +Parameter Sets: VirtualRouterPeerObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PeerAsn +Peer ASN. + +```yaml +Type: System.UInt32 +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerIp +Peer Ip. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PeerName +The name of the virtual router Peer. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerNameParameterSet +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the virtual router/peer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The virtual router peer resource Id. + +```yaml +Type: System.String +Parameter Sets: VirtualRouterPeerResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualRouterName +The virtual router where peer exists. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.UInt32 + +### Microsoft.Azure.Commands.Network.Models.PSVirtualRouterPeer + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualRouter + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Update-AzVirtualWan.md b/azps-10.1.0/Az.Network/Update-AzVirtualWan.md new file mode 100644 index 0000000000..ee78d9a9e8 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVirtualWan.md @@ -0,0 +1,283 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvirtualwan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualWan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVirtualWan.md +--- + +# Update-AzVirtualWan + +## SYNOPSIS +Updates an Azure Virtual WAN. + +## SYNTAX + +### ByVirtualWanName (Default) +``` +Update-AzVirtualWan -ResourceGroupName <String> -Name <String> [-AllowVnetToVnetTraffic <Boolean>] + [-AllowBranchToBranchTraffic <Boolean>] [-Tag <Hashtable>] [-VirtualWANType <String>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanObject +``` +Update-AzVirtualWan -InputObject <PSVirtualWan> [-AllowVnetToVnetTraffic <Boolean>] + [-AllowBranchToBranchTraffic <Boolean>] [-Tag <Hashtable>] [-VirtualWANType <String>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualWanResourceId +``` +Update-AzVirtualWan -ResourceId <String> [-AllowVnetToVnetTraffic <Boolean>] + [-AllowBranchToBranchTraffic <Boolean>] [-Tag <Hashtable>] [-VirtualWANType <String>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an Azure Virtual WAN. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +New-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" +Update-AzVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -AllowBranchToBranchTraffic $true -AllowVnetToVnetTraffic $false +``` + +```output +Name : testRG +Id : /subscriptions/{SubscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +AllowVnetToVnetTraffic : False +AllowBranchToBranchTraffic : True +Location : West US +VirtualWANType : Standard +Type : Microsoft.Network/virtualWans +ProvisioningState : Succeeded +``` + +The above will create a resource group "testRG" in region "West US" and an Azure Virtual WAN in that resource group in Azure. VirtualWan is updated with new properties. + +## PARAMETERS + +### -AllowBranchToBranchTraffic +Allow branch to branch traffic for VirtualWan. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowVnetToVnetTraffic +Allow vnet to vnet traffic for VirtualWan. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation if you want to overwrite a resource + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual wan object to be modified + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan +Parameter Sets: ByVirtualWanObject +Aliases: VirtualWan + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanName +Aliases: ResourceName, VirtualWanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID for the virtual wan. + +```yaml +Type: System.String +Parameter Sets: ByVirtualWanResourceId +Aliases: VirtualWanId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualWANType +The type of the Virtual Wan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualWan + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualWan + +## NOTES + +## RELATED LINKS + +[Get-AzVirtualWan](./Get-AzVirtualWan.md) + +[New-AzVirtualWan](./New-AzVirtualWan.md) + +[Remove-AzVirtualWan](./Remove-AzVirtualWan.md) diff --git a/azps-10.1.0/Az.Network/Update-AzVpnConnection.md b/azps-10.1.0/Az.Network/Update-AzVpnConnection.md new file mode 100644 index 0000000000..a51804ebc8 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVpnConnection.md @@ -0,0 +1,495 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvpnconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVpnConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVpnConnection.md +--- + +# Update-AzVpnConnection + +## SYNOPSIS +Updates a VPN connection. + +## SYNTAX + +### ByVpnConnectionName (Default) +``` +Update-AzVpnConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + [-SharedKey <SecureString>] [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] + [-EnableBgp <Boolean>] [-UseLocalAzureIpAddress <Boolean>] [-UsePolicyBasedTrafficSelectors <Boolean>] + [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>] [-EnableInternetSecurity <Boolean>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-VpnLinkConnectionMode <String>] + [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnConnectionResourceId +``` +Update-AzVpnConnection -ResourceId <String> [-SharedKey <SecureString>] [-ConnectionBandwidthInMbps <UInt32>] + [-IpSecPolicy <PSIpsecPolicy>] [-EnableBgp <Boolean>] [-UseLocalAzureIpAddress <Boolean>] + [-UsePolicyBasedTrafficSelectors <Boolean>] [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>] + [-EnableInternetSecurity <Boolean>] [-RoutingConfiguration <PSRoutingConfiguration>] + [-VpnLinkConnectionMode <String>] [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnConnectionObject +``` +Update-AzVpnConnection -InputObject <PSVpnConnection> [-SharedKey <SecureString>] + [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] [-EnableBgp <Boolean>] + [-UseLocalAzureIpAddress <Boolean>] [-UsePolicyBasedTrafficSelectors <Boolean>] + [-VpnSiteLinkConnection <PSVpnSiteLinkConnection[]>] [-EnableInternetSecurity <Boolean>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-VpnLinkConnectionMode <String>] + [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzVpnConnection** cmdlet updates a VPN connection. +VPN connection creates an IPsec connection that connects a VPN gateway to a remote customer branch represented in Azure as a VPN site. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" +$vpnSite = New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" +$vpnConnection = New-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite +$ipsecPolicy = New-AzIpsecPolicy -SALifeTimeSeconds 1000 -SADataSizeKilobytes 2000 -IpsecEncryption "GCMAES256" -IpsecIntegrity "GCMAES256" -IkeEncryption "AES256" -IkeIntegrity "SHA256" -DhGroup "DHGroup14" -PfsGroup "PFS2048" +Update-AzVpnConnection -InputObject $vpnConnection -IpSecPolicy $ipsecPolicy +``` + +```output +RemoteVpnSite : Microsoft.Azure.Commands.Network.Models.PSResourceId +SharedKey : +VpnConnectionProtocolType : IKEv2 +ConnectionStatus : +EgressBytesTransferred : 0 +IngressBytesTransferred : 0 +IpsecPolicies : {Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy} +ConnectionBandwidth : 20 +EnableBgp : False +UseLocalAzureIpAddress : False +ProvisioningState : testConnection +Name : ps9709 +Etag : W/"4580a2e2-2fab-4cff-88eb-92013a76b5a8" +Id : /subscriptions/{subscriptionId}/resourceGroups/ps9361/providers/Microsoft.Network/vpnGateways/testvpngw/vpnConnections/testConnection +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite in West US in "testRG" resource group in Azure. +A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. + +Once the gateway has been created, it is connected to the VpnSite using the New-AzVpnConnection command. + +The connection is then updated to have a new IpSecPolicy by using the Set-AzVpnConnection command. + +### Example 2 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" +$vpnSite = New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" +$vpnConnection = New-AzVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite +$Secure_String_Pwd = Read-Host -AsSecureString +Update-AzVpnConnection -InputObject $vpnConnection -SharedKey $Secure_String_Pwd +``` + +```output +RemoteVpnSite : Microsoft.Azure.Commands.Network.Models.PSResourceId +SharedKey : +VpnConnectionProtocolType : IKEv2 +ConnectionStatus : +EgressBytesTransferred : 0 +IngressBytesTransferred : 0 +IpsecPolicies : {Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy} +ConnectionBandwidth : 20 +EnableBgp : False +UseLocalAzureIpAddress : False +ProvisioningState : testConnection +Name : ps9709 +Etag : W/"4580a2e2-2fab-4cff-88eb-92013a76b5a8" +Id : /subscriptions/{subscriptionId}/resourceGroups/ps9361/providers/Microsoft.Network/vpnGateways/testvpngw/vpnConnections/testConnection +RoutingConfiguration : { + "AssociatedRouteTable": { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/westushub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + } +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite in West US in "testRG" resource group in Azure. +A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. + +Once the gateway has been created, it is connected to the VpnSite using the New-AzVpnConnection command. + +The connection is then updated to have a new shared key using the secure string construct. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionBandwidthInMbps +The bandwidth that needs to be handled by this connection in mbps. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBgp +Enable BGP for this connection + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternetSecurity +Enable internet security for this connection + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The VpnConnection object to update. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnConnection +Parameter Sets: ByVpnConnectionObject +Aliases: VpnConnection + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IpSecPolicy +The bandwidth that needs to be handled by this connection in mbps. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionName +Aliases: ResourceName, VpnConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionName +Aliases: ParentVpnGatewayName, VpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the VpnConnection object to delete. + +```yaml +Type: System.String +Parameter Sets: ByVpnConnectionResourceId +Aliases: VpnConnectionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoutingConfiguration +Routing configuration for this connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedKey +The shared key required to set this connection up. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficSelectorPolicy +A list of Traffic Selector policies. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSTrafficSelectorPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UseLocalAzureIpAddress +Use local azure ip address as source address while initiating connection. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePolicyBasedTrafficSelectors +Use policy based traffic selectors for this connection. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnLinkConnectionMode +The connection mode for all VpnSiteLinkConnections in this VpnConnection + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Default +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnSiteLinkConnection +The list of VpnSiteLinkConnections that this VpnConnection needs to have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnSiteLinkConnection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVpnConnection + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnConnection + +## NOTES + +## RELATED LINKS + +[Get-AzVpnConnection](./Get-AzVpnConnection.md) + +[New-AzVpnConnection](./New-AzVpnConnection.md) + +[Remove-AzVpnConnection](./Remove-AzVpnConnection.md) + +[New-AzRoutingConfiguration](./New-AzRoutingConfiguration.md) diff --git a/azps-10.1.0/Az.Network/Update-AzVpnGateway.md b/azps-10.1.0/Az.Network/Update-AzVpnGateway.md new file mode 100644 index 0000000000..2a0f51c0cf --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVpnGateway.md @@ -0,0 +1,394 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvpngateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVpnGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVpnGateway.md +--- + +# Update-AzVpnGateway + +## SYNOPSIS +Updates a scalable VPN gateway. + +## SYNTAX + +### ByVpnGatewayName (Default) +``` +Update-AzVpnGateway -ResourceGroupName <String> -Name <String> [-VpnConnection <PSVpnConnection[]>] + [-VpnGatewayNatRule <PSVpnGatewayNatRule[]>] [-VpnGatewayScaleUnit <UInt32>] + [-BgpPeeringAddress <PSIpConfigurationBgpPeeringAddress[]>] [-EnableBgpRouteTranslationForNat <Boolean>] + [-Tag <Hashtable>] [-Asn <UInt32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVpnGatewayObject +``` +Update-AzVpnGateway -InputObject <PSVpnGateway> [-VpnConnection <PSVpnConnection[]>] + [-VpnGatewayNatRule <PSVpnGatewayNatRule[]>] [-VpnGatewayScaleUnit <UInt32>] + [-BgpPeeringAddress <PSIpConfigurationBgpPeeringAddress[]>] [-EnableBgpRouteTranslationForNat <Boolean>] + [-Tag <Hashtable>] [-Asn <UInt32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVpnGatewayResourceId +``` +Update-AzVpnGateway -ResourceId <String> [-VpnConnection <PSVpnConnection[]>] + [-VpnGatewayNatRule <PSVpnGatewayNatRule[]>] [-VpnGatewayScaleUnit <UInt32>] + [-BgpPeeringAddress <PSIpConfigurationBgpPeeringAddress[]>] [-EnableBgpRouteTranslationForNat <Boolean>] + [-Tag <Hashtable>] [-Asn <UInt32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzVpnGateway** cmdlet updates a scalable VPN gateway. +An Azure VPN gateway is a software defined connectivity for site to site connections inside the VirtualHub. This gateway resizes and scales based on the scale unit specified by the user. A connection can be set up from a branch/site known as VPN site to the scalable gateway. Each connection comprises of 2 Active-Active tunnels + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +$vpnGateway = New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +Update-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VpnGatewayScaleUnit 3 +``` + +```output +ResourceGroupName : testRG +Name : testvpngw +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnGateways/testvpngw +Location : West US +VpnGatewayScaleUnit : 3 +VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/Ali_pS_Test/providers/Microsoft.Network/virtualHubs/westushub +BgpSettings : {} +Type : Microsoft.Network/vpnGateways +ProvisioningState : Succeeded +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in West US in "testRG" resource group in Azure. +A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. + +After the gateway has been created, it uses Update-AzVpnGateway to upgrade the gateway to 3 scale units. + +### Example 2 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +$vpnGateway = New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$ipconfigurationId1 = 'Instance0' +$addresslist1 = @('169.254.21.5') +$gw1ipconfBgp1 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId1 -CustomAddress $addresslist1 +$ipconfigurationId2 = 'Instance1' +$addresslist2 = @('169.254.21.10') +$gw1ipconfBgp2 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId2 -CustomAddress $addresslist2 +$gw = Get-AzVpnGateway -ResourceGroupName testRg -Name testgw +Update-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -BgpPeeringAddress @($gw1ipconfBgp1,$gw1ipconfBgp2) +``` + +```output +ResourceGroupName : testRG +Name : testvpngw +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnGateways/testvpngw +Location : West US +VpnGatewayScaleUnit : 3 +VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/Ali_pS_Test/providers/Microsoft.Network/virtualHubs/westushub +BgpSettings : {} +Type : Microsoft.Network/vpnGateways +ProvisioningState : Succeeded +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in West US in "testRG" resource group in Azure. +A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. + +After the gateway has been created, it uses Set-AzVpnGateway to update BgpPeeringAddress. + +### Example 3 + +```powershell +$gw = Get-AzVpnGateway -ResourceGroupName "testRg" -Name "testgw" +$gw.BgpSettings.BgpPeeringAddresses +$gw.BgpSettings.BgpPeeringAddresses[0].CustomBgpIpAddresses=$null +$gw.BgpSettings.BgpPeeringAddresses[1].CustomBgpIpAddresses=$null +$gw.BgpSettings.BgpPeeringAddresses +Update-AzVpnGateway -InputObject $gw +``` + +The above example will update the Virtual WAN VPN Gateway to use the default BgpPeeringAddress. + +### Example 4 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +$vpnGateway = New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$ipconfigurationId1 = 'Instance0' +$addresslist1 = @() +$gw1ipconfBgp1 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId1 -CustomAddress $addresslist1 +$ipconfigurationId2 = 'Instance1' +$addresslist2 = @() +$gw1ipconfBgp2 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId2 -CustomAddress $addresslist2 +$gw = Get-AzVpnGateway -ResourceGroupName testRg -Name testgw +Update-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -BgpPeeringAddress @($gw1ipconfBgp1,$gw1ipconfBgp2) +``` + +The above example will update the Virtual WAN VPN Gateway to use the default BgpPeeringAddress. + +It uses Update-AzVpnGateway to update BgpPeeringAddress + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Asn +The vpn gateway's ASN for BGP over VPN + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpPeeringAddress +The BGP peering addresses for this VpnGateway bgpsettings. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpConfigurationBgpPeeringAddress[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBgpRouteTranslationForNat +Flag to enable/disable Bgp route translation for NAT on this VpnGateway. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The vpn gateway object to be modified + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnGateway +Parameter Sets: ByVpnGatewayObject +Aliases: VpnGateway + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The vpn gateway name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: ResourceName, VpnGatewayName, GatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID of the VpnGateway to be modified. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnConnection +The list of VpnConnections that this VpnGateway needs to have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnConnection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnGatewayNatRule +The list of VpnGatewayNatRules that are associated with this VpnGateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnGatewayNatRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnGatewayScaleUnit +The scale unit for this VpnGateway. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGateway + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGateway + +## NOTES + +## RELATED LINKS + +[Get-AzVpnGateway](./Get-AzVpnGateway.md) + +[New-AzVpnGateway](./New-AzVpnGateway.md) + +[Remove-AzVpnGateway](./Remove-AzVpnGateway.md) diff --git a/azps-10.1.0/Az.Network/Update-AzVpnGatewayNatRule.md b/azps-10.1.0/Az.Network/Update-AzVpnGatewayNatRule.md new file mode 100644 index 0000000000..4e869c8b17 --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVpnGatewayNatRule.md @@ -0,0 +1,337 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvpngatewaynatrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVpnGatewayNatRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVpnGatewayNatRule.md +--- + +# Update-AzVpnGatewayNatRule + +## SYNOPSIS +Updates a NAT rule associated with VpnGateway. + +## SYNTAX + +### ByVpnGatewayNatRuleName (Default) +``` +Update-AzVpnGatewayNatRule -ResourceGroupName <String> -ParentResourceName <String> -Name <String> + [-Type <String>] [-Mode <String>] [-InternalMapping <String[]>] [-ExternalMapping <String[]>] + [-InternalPortRange <String[]>] [-ExternalPortRange <String[]>] [-IpConfigurationId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnGatewayNatRuleResourceId +``` +Update-AzVpnGatewayNatRule -ResourceId <String> [-Type <String>] [-Mode <String>] [-InternalMapping <String[]>] + [-ExternalMapping <String[]>] [-InternalPortRange <String[]>] [-ExternalPortRange <String[]>] + [-IpConfigurationId <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVpnGatewayNatRuleObject +``` +Update-AzVpnGatewayNatRule -InputObject <PSVpnGatewayNatRule> [-Type <String>] [-Mode <String>] + [-InternalMapping <String[]>] [-ExternalMapping <String[]>] [-InternalPortRange <String[]>] + [-ExternalPortRange <String[]>] [-IpConfigurationId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzVpnGatewayNatRule** cmdlet updates a NAT rule associated with VpnGateway. + +## EXAMPLES + +### Example + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" +New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2 +$vpnGateway = Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" +New-AzVpnGatewayNatRule -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testNatRule" -Type Static -Mode EgressSnat -InternalMapping "10.0.0.1/26" -ExternalMapping "192.168.0.0/26" +$natRule = Get-AzVpnGatewayNatRule -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testNatRule" +Update-AzVpnGatewayNatRule -InputObject $natRule -Type Dynamic -Mode IngressSnat +``` + +```output +Type : Dynamic +Mode : IngressSnat +VpnConnectionProtocolType : IKEv2 +InternalMappings : 10.0.0.1/26 +ExternalMappings : 192.168.0.0/26 +IpConfigurationId : +IngressVpnSiteLinkConnections : [Microsoft.Azure.Commands.Network.Models.PSResourceId] +EgressVpnSiteLinkConnections : [Microsoft.Azure.Commands.Network.Models.PSResourceId] +ProvisioningState : Provisioned +Name : ps9709 +Etag : W/"4580a2e2-2fab-4cff-88eb-92013a76b5a8" +Id : /subscriptions/{subscriptionId}/resourceGroups/testRg/providers/Microsoft.Network/vpnGateways/testvpngw/natRules/testNatRule +``` + +The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub. Then, we will create VpnGateway under that Virtual Hub. Then, create new NAT rule associated with created VpnGateway. +Using this command: Update-AzVpnGatewayNatRule, update NAT rule. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalMapping +The list of private IP address subnet external mappings for NAT + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalPortRange +The list of external port range mappings for NAT subnets + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The VpnGatewayNatRule object to update. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnGatewayNatRule +Parameter Sets: ByVpnGatewayNatRuleObject +Aliases: VpnGatewayNatRule + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InternalMapping +The list of private IP address subnet internal mappings for NAT + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InternalPortRange +The list of internal port range mappings for NAT subnets + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfigurationId +The IP Configuration ID this NAT rule applies to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Source NAT direction of a VPN NAT + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: EgressSnat, IngressSnat + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayNatRuleName +Aliases: ResourceName, VpnGatewayNatRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceName +The parent resource name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayNatRuleName +Aliases: ParentVpnGatewayName, VpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayNatRuleName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the VpnGatewayNatRule object to delete. + +```yaml +Type: System.String +Parameter Sets: ByVpnGatewayNatRuleResourceId +Aliases: VpnGatewayNatRuleResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +The type of NAT rule for VPN NAT + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Static, Dynamic + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Network.Models.PSVpnGatewayNatRule + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnGatewayNatRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Update-AzVpnServerConfiguration.md b/azps-10.1.0/Az.Network/Update-AzVpnServerConfiguration.md new file mode 100644 index 0000000000..87e1f1110f --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVpnServerConfiguration.md @@ -0,0 +1,456 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvpnserverconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVpnServerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVpnServerConfiguration.md +--- + +# Update-AzVpnServerConfiguration + +## SYNOPSIS +Updates an existing VpnServerConfiguration. + +## SYNTAX + +### ByVpnServerConfigurationName (Default) +``` +Update-AzVpnServerConfiguration -ResourceGroupName <String> -Name <String> [-VpnProtocol <String[]>] + [-VpnAuthenticationType <String[]>] [-VpnClientRootCertificateFilesList <String[]>] + [-VpnClientRevokedCertificateFilesList <String[]>] [-RadiusServerAddress <String>] + [-RadiusServerSecret <SecureString>] [-RadiusServerList <PSRadiusServer[]>] + [-RadiusServerRootCertificateFilesList <String[]>] [-RadiusClientRootCertificateFilesList <String[]>] + [-AadTenant <String>] [-AadAudience <String>] [-AadIssuer <String>] [-VpnClientIpsecPolicy <PSIpsecPolicy[]>] + [-ConfigurationPolicyGroup <PSVpnServerConfigurationPolicyGroup[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnServerConfigurationObject +``` +Update-AzVpnServerConfiguration -InputObject <PSVpnServerConfiguration> [-VpnProtocol <String[]>] + [-VpnAuthenticationType <String[]>] [-VpnClientRootCertificateFilesList <String[]>] + [-VpnClientRevokedCertificateFilesList <String[]>] [-RadiusServerAddress <String>] + [-RadiusServerSecret <SecureString>] [-RadiusServerList <PSRadiusServer[]>] + [-RadiusServerRootCertificateFilesList <String[]>] [-RadiusClientRootCertificateFilesList <String[]>] + [-AadTenant <String>] [-AadAudience <String>] [-AadIssuer <String>] [-VpnClientIpsecPolicy <PSIpsecPolicy[]>] + [-ConfigurationPolicyGroup <PSVpnServerConfigurationPolicyGroup[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnServerConfigurationResourceId +``` +Update-AzVpnServerConfiguration -ResourceId <String> [-VpnProtocol <String[]>] + [-VpnAuthenticationType <String[]>] [-VpnClientRootCertificateFilesList <String[]>] + [-VpnClientRevokedCertificateFilesList <String[]>] [-RadiusServerAddress <String>] + [-RadiusServerSecret <SecureString>] [-RadiusServerList <PSRadiusServer[]>] + [-RadiusServerRootCertificateFilesList <String[]>] [-RadiusClientRootCertificateFilesList <String[]>] + [-AadTenant <String>] [-AadAudience <String>] [-AadIssuer <String>] [-VpnClientIpsecPolicy <PSIpsecPolicy[]>] + [-ConfigurationPolicyGroup <PSVpnServerConfigurationPolicyGroup[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzVpnServerConfiguration** cmdlet enables you to update the existing VpnServerConfiguration with different VpnProtocols, VpnAuthenticationTypes, IpsecPolicies and to set selected vpn authentication type related parameters as per the customer's requirement for Point to site connectivity. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzVpnServerConfiguration -Name "test1config" -ResourceGroupName "P2SCortexGATesting" -VpnProtocol IkeV2 + +New-AzVpnServerConfiguration -Name "test1config" -ResourceGroupName "P2SCortexGATesting" -VpnProtocol IkeV2 -VpnAuthenticationType Certificate -VpnClientRootCertificateFilesList $listOfCerts -VpnClientRevokedCertificateFilesList $listOfCerts -Location "westus" +``` + +```output +ResourceGroupName : P2SCortexGATesting +Name : test1config +Id : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/test1config +Location : westus +VpnProtocols : {IkeV2} +VpnAuthenticationTypes : {Certificate} +VpnClientRootCertificates : +VpnClientRevokedCertificates : [ + { + "Name": "cert2", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] +RadiusServerAddress : +RadiusServerRootCertificates : [] +RadiusClientRootCertificates : [] +VpnClientIpsecPolicies : [] +AadAuthenticationParameters : null +P2sVpnGateways : [] +Type : Microsoft.Network/vpnServerConfigurations +ProvisioningState : Succeeded +``` + +The above command will update an existing VpnServerConfiguration with VpnProtocol as IkeV2. + +## PARAMETERS + +### -AadAudience +AAD audience for P2S AAD authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AadIssuer +AAD issuer for P2S AAD authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AadTenant +AAD tenant for P2S AAD authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationPolicyGroup +The list of VpnServerConfigurationPolicyGroups that this P2SVpnGateway needs to have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnServerConfigurationPolicyGroup[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The vpn server configuration object to be modified + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration +Parameter Sets: ByVpnServerConfigurationObject +Aliases: VpnServerConfiguration + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVpnServerConfigurationName +Aliases: ResourceName, VpnServerConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RadiusClientRootCertificateFilesList +A list of RadiusClientRootCertificate files' paths + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RadiusServerAddress +P2S External Radius server address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RadiusServerList +P2S External multiple radius servers. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRadiusServer[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RadiusServerRootCertificateFilesList +A list of RadiusClientRootCertificate files' paths + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RadiusServerSecret +P2S External Radius server secret. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnServerConfigurationName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID for the vpn server configuration. + +```yaml +Type: System.String +Parameter Sets: ByVpnServerConfigurationResourceId +Aliases: VpnServerConfigurationId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnAuthenticationType +The list of P2S VPN client tunneling protocols. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: Certificate, Radius, AAD + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnClientIpsecPolicy +A list of IPSec policies for VpnServerConfiguration. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VpnClientRevokedCertificateFilesList +A list of VpnClientCertificates to be revoked files' paths + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnClientRootCertificateFilesList +A list of VpnClientRootCertificates to be added files' paths + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnProtocol +The list of P2S VPN client tunneling protocols. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: IkeV2, OpenVPN + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration +System.String +Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Network/Update-AzVpnServerConfigurationPolicyGroup.md b/azps-10.1.0/Az.Network/Update-AzVpnServerConfigurationPolicyGroup.md new file mode 100644 index 0000000000..c167f912bd --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVpnServerConfigurationPolicyGroup.md @@ -0,0 +1,460 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvpnserverconfigurationpolicygroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVpnServerConfigurationPolicyGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVpnServerConfigurationPolicyGroup.md +--- + +# New-AzP2sVpnGateway + +## SYNOPSIS +Create a new P2SVpnGateway under VirtualHub for point to site connectivity. + +## SYNTAX + +### ByVirtualHubNameByVpnServerConfigurationObject (Default) +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubName <String> [-VpnServerConfiguration <PSVpnServerConfiguration>] + [-VpnClientAddressPool <String[]>] [-CustomDnsServer <String[]>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] [-DisableInternetSecurityFlag] + [-EnableRoutingPreferenceInternetFlag] [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubNameByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubName <String> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubObjectByVpnServerConfigurationObject +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHub <PSVirtualHub> [-VpnServerConfiguration <PSVpnServerConfiguration>] + [-VpnClientAddressPool <String[]>] [-CustomDnsServer <String[]>] + [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] [-DisableInternetSecurityFlag] + [-EnableRoutingPreferenceInternetFlag] [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVirtualHubObjectByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHub <PSVirtualHub> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByVpnServerConfigurationObject +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubId <String> [-VpnServerConfiguration <PSVpnServerConfiguration>] [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVirtualHubResourceIdByVpnServerConfigurationResourceId +``` +New-AzP2sVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> + -VirtualHubId <String> -VpnServerConfigurationId <String> [-VpnClientAddressPool <String[]>] + [-CustomDnsServer <String[]>] [-RoutingConfiguration <PSRoutingConfiguration>] [-EnableInternetSecurityFlag] + [-DisableInternetSecurityFlag] [-EnableRoutingPreferenceInternetFlag] + [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzP2sVpnGateway cmdlet enables you to create a new P2SVpnGateway under VirtualHub for Point to site connectivity from Point to site clients to Azure VirtualWan. + +## EXAMPLES + +### Example 1 +```powershell +$virtualHub = Get-AzVirtualHub -ResourceGroupName P2SCortexGATesting -Name WestUsVirtualHub +$vpnServerConfig1 = Get-AzVpnServerConfiguration -ResourceGroupName P2SCortexGATesting -Name WestUsConfig +$vpnClientAddressSpaces = New-Object string[] 1 +$vpnClientAddressSpaces[0] = "192.168.2.0/24" +$createdP2SVpnGateway = New-AzP2sVpnGateway -ResourceGroupName P2SCortexGATesting -Name 683482ade8564515aed4b8448c9757ea-westus-gw -VirtualHub $virtualHub -VpnGatewayScaleUnit 1 -VpnClientAddressPool $vpnClientAddressSpaces -VpnServerConfiguration $vpnServerConfig1 -EnableInternetSecurityFlag -EnableRoutingPreferenceInternetFlag +``` + +```output +ResourceGroupName : P2SCortexGATesting +Name : 683482ade8564515aed4b8448c9757ea-westus-gw +Id : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482ade8564515a + ed4b8448c9757ea-westus-gw +Location : westus +VpnGatewayScaleUnit : 1 +VirtualHub : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub +VpnServerConfiguration : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/WestUsConfig +VpnServerConfigurationLocation : +VpnClientConnectionHealth : null +Type : Microsoft.Network/p2sVpnGateways +ProvisioningState : Succeeded +P2SConnectionConfigurations : [ + { + "ProvisioningState": "Succeeded", + "VpnClientAddressPool": { + "AddressPrefixes": [ + "192.168.2.0/24" + ] + }, + "EnableInternetSecurity": True, + "RoutingConfiguration": { + "AssociatedRouteTable": { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + "PropagatedRouteTables": { + "Labels": [], + "Ids": [ + { + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable" + } + ] + }, + "VnetRoutes": { + "StaticRoutes": [] + } + }, + "Name": "P2SConnectionConfigDefault", + "Etag": "W/\"4b96e6a2-b4d8-46b3-9210-76d40f359bef\"", + "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482 + ade8564515aed4b8448c9757ea-westus-gw/p2sConnectionConfigurations/P2SConnectionConfigDefault" + } + ] +``` + +The New-AzP2sVpnGateway cmdlet enables you to create a new P2SVpnGateway under VirtualHub for Point to site connectivity. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```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 +``` + +### -CustomDnsServer +The list of Custom Dns Servers. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableInternetSecurityFlag +Flag to disable internet security feature on this P2SVpnGateway P2SConnectionConfiguration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInternetSecurityFlag +Enable internet security flag for this P2SVpnGateway connections + +```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 +``` + +### -EnableRoutingPreferenceInternetFlag +Flag to enable Routing Preference Internet on this P2SVpnGateway. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName, P2SVpnGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -P2SConnectionConfiguration +The list of P2SConnectionConfigurations that this P2SVpnGateway needs to have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSP2SConnectionConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingConfiguration +Routing configuration for this connection + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSRoutingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualHub +The VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub +Parameter Sets: ByVirtualHubObjectByVpnServerConfigurationObject, ByVirtualHubObjectByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VirtualHubId +The Id of the VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubResourceIdByVpnServerConfigurationObject, ByVirtualHubResourceIdByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualHubName +The Id of the VirtualHub this P2SVpnGateway needs to be associated with. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationObject, ByVirtualHubNameByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnClientAddressPool +P2S VpnClient AddressPool for this P2SVpnGateway P2SConnectionConfiguration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnGatewayScaleUnit +The scale unit for this P2SVpnGateway. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnServerConfiguration +The VpnServerConfiguration to be attached to this P2SVpnGateway. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationObject, ByVirtualHubObjectByVpnServerConfigurationObject, ByVirtualHubResourceIdByVpnServerConfigurationObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VpnServerConfigurationId +The id of Vpn server configuration object this P2SVpnGateway will be attached to. + +```yaml +Type: System.String +Parameter Sets: ByVirtualHubNameByVpnServerConfigurationResourceId, ByVirtualHubObjectByVpnServerConfigurationResourceId, ByVirtualHubResourceIdByVpnServerConfigurationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVirtualHub +System.String Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway +## NOTES + +## RELATED LINKS + +[New-AzRoutingConfiguration]() + diff --git a/azps-10.1.0/Az.Network/Update-AzVpnSite.md b/azps-10.1.0/Az.Network/Update-AzVpnSite.md new file mode 100644 index 0000000000..daec88c02c --- /dev/null +++ b/azps-10.1.0/Az.Network/Update-AzVpnSite.md @@ -0,0 +1,532 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml +Module Name: Az.Network +online version: https://learn.microsoft.com/powershell/module/az.network/update-azvpnsite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVpnSite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Network/Network/help/Update-AzVpnSite.md +--- + +# Update-AzVpnSite + +## SYNOPSIS +Updates a VPN site. + +## SYNTAX + +### ByVpnSiteNameNoVirtualWanUpdate (Default) +``` +Update-AzVpnSite -ResourceGroupName <String> -Name <String> [-IpAddress <String>] [-AddressSpace <String[]>] + [-DeviceModel <String>] [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] + [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] [-VpnSiteLink <PSVpnSiteLink[]>] + [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnSiteNameByVirtualWanName +``` +Update-AzVpnSite -ResourceGroupName <String> -Name <String> -VirtualWanResourceGroupName <String> + -VirtualWanName <String> [-IpAddress <String>] [-AddressSpace <String[]>] [-DeviceModel <String>] + [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] + [-BgpPeeringWeight <UInt32>] [-VpnSiteLink <PSVpnSiteLink[]>] [-O365Policy <PSO365PolicyProperties>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByVpnSiteNameByVirtualWanResourceId +``` +Update-AzVpnSite -ResourceGroupName <String> -Name <String> -VirtualWanId <String> [-IpAddress <String>] + [-AddressSpace <String[]>] [-DeviceModel <String>] [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] + [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] [-VpnSiteLink <PSVpnSiteLink[]>] + [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnSiteNameByVirtualWanObject +``` +Update-AzVpnSite -ResourceGroupName <String> -Name <String> -VirtualWan <PSVirtualWan> [-IpAddress <String>] + [-AddressSpace <String[]>] [-DeviceModel <String>] [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] + [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] [-VpnSiteLink <PSVpnSiteLink[]>] + [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnSiteObjectByVirtualWanName +``` +Update-AzVpnSite -InputObject <PSVpnSite> -VirtualWanResourceGroupName <String> -VirtualWanName <String> + [-IpAddress <String>] [-AddressSpace <String[]>] [-DeviceModel <String>] [-DeviceVendor <String>] + [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] + [-VpnSiteLink <PSVpnSiteLink[]>] [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnSiteObjectByVirtualWanResourceId +``` +Update-AzVpnSite -InputObject <PSVpnSite> -VirtualWanId <String> [-IpAddress <String>] + [-AddressSpace <String[]>] [-DeviceModel <String>] [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] + [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] [-VpnSiteLink <PSVpnSiteLink[]>] + [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnSiteObjectByVirtualWanObject +``` +Update-AzVpnSite -InputObject <PSVpnSite> -VirtualWan <PSVirtualWan> [-IpAddress <String>] + [-AddressSpace <String[]>] [-DeviceModel <String>] [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] + [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] [-VpnSiteLink <PSVpnSiteLink[]>] + [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnSiteObjectNoVirtualWanUpdate +``` +Update-AzVpnSite -InputObject <PSVpnSite> [-IpAddress <String>] [-AddressSpace <String[]>] + [-DeviceModel <String>] [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] + [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] [-VpnSiteLink <PSVpnSiteLink[]>] + [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnSiteResourceIdByVirtualWanName +``` +Update-AzVpnSite -ResourceId <String> -VirtualWanResourceGroupName <String> -VirtualWanName <String> + [-IpAddress <String>] [-AddressSpace <String[]>] [-DeviceModel <String>] [-DeviceVendor <String>] + [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] + [-VpnSiteLink <PSVpnSiteLink[]>] [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnSiteResourceIdByVirtualWanResourceId +``` +Update-AzVpnSite -ResourceId <String> -VirtualWanId <String> [-IpAddress <String>] [-AddressSpace <String[]>] + [-DeviceModel <String>] [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] + [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] [-VpnSiteLink <PSVpnSiteLink[]>] + [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnSiteResourceIdByVirtualWanObject +``` +Update-AzVpnSite -ResourceId <String> -VirtualWan <PSVirtualWan> [-IpAddress <String>] + [-AddressSpace <String[]>] [-DeviceModel <String>] [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] + [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] [-VpnSiteLink <PSVpnSiteLink[]>] + [-O365Policy <PSO365PolicyProperties>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByVpnSiteResourceIdNoVirtualWanUpdate +``` +Update-AzVpnSite -ResourceId <String> [-IpAddress <String>] [-AddressSpace <String[]>] [-DeviceModel <String>] + [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] + [-BgpPeeringWeight <UInt32>] [-VpnSiteLink <PSVpnSiteLink[]>] [-O365Policy <PSO365PolicyProperties>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzVpnSite** cmdlet updates a VPN site. + +## EXAMPLES + +### Example 1 + +```powershell +New-AzResourceGroup -Location "West US" -Name "testRG" +$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" +$vpnSiteAddressSpaces = New-Object string[] 2 +$vpnSiteAddressSpaces[0] = "192.168.2.0/24" +$vpnSiteAddressSpaces[1] = "192.168.3.0/24" +New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" +New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "2.3.5.5" +``` + +```output +ResourceGroupName : testRG +Name : testVpnSite +Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnSites/testVpnSite +Location : eastus2euap +IpAddress : 2.3.4.5 +VirtualWan : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN +AddressSpace : {192.168.2.0/24, 192.168.3.0/24} +BgpSettings : +Type : Microsoft.Network/vpnSites +ProvisioningState : Succeeded +``` + +The above will create a resource group, Virtual WAN in West US in "testRG" resource group in Azure. + +Then it creates a VpnSite to represent a customer branch and links it to the Virtual WAN. + +Once the site is created, it updates the IpAddress of the site using the Set-AzVpnSite command. + +## PARAMETERS + +### -AddressSpace +The address prefixes of the virtual network. +Use this or AddressSpaceObject but not both. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpAsn +The BGP ASN for this VpnSite. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpPeeringAddress +The BGP Peering Address for this VpnSite. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpPeeringWeight +The BGP Peering weight for this VpnSite. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceModel +The device model of the remote vpn device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceVendor +The device vendor of the remote vpn device. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The vpn site object to be modified + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnSite +Parameter Sets: ByVpnSiteObjectByVirtualWanName, ByVpnSiteObjectByVirtualWanResourceId, ByVpnSiteObjectByVirtualWanObject, ByVpnSiteObjectNoVirtualWanUpdate +Aliases: VpnSite + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IpAddress +IP address of local network gateway. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkSpeedInMbps +The device model of the remote vpn device. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name. + +```yaml +Type: System.String +Parameter Sets: ByVpnSiteNameNoVirtualWanUpdate, ByVpnSiteNameByVirtualWanName, ByVpnSiteNameByVirtualWanResourceId, ByVpnSiteNameByVirtualWanObject +Aliases: ResourceName, VpnSiteName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -O365Policy +The office 365 traffic breakout policy for this VpnSite. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSO365PolicyProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByVpnSiteNameNoVirtualWanUpdate, ByVpnSiteNameByVirtualWanName, ByVpnSiteNameByVirtualWanResourceId, ByVpnSiteNameByVirtualWanObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource ID for the vpn site. + +```yaml +Type: System.String +Parameter Sets: ByVpnSiteResourceIdByVirtualWanName, ByVpnSiteResourceIdByVirtualWanResourceId, ByVpnSiteResourceIdByVirtualWanObject, ByVpnSiteResourceIdNoVirtualWanUpdate +Aliases: VpnSiteId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualWan +The VirtualWan this VpnSite needs to be connected to. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan +Parameter Sets: ByVpnSiteNameByVirtualWanObject, ByVpnSiteObjectByVirtualWanObject, ByVpnSiteResourceIdByVirtualWanObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualWanId +The ResourceId VirtualWan this VpnSite needs to be connected to. + +```yaml +Type: System.String +Parameter Sets: ByVpnSiteNameByVirtualWanResourceId, ByVpnSiteObjectByVirtualWanResourceId, ByVpnSiteResourceIdByVirtualWanResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualWanName +The name of the VirtualWan this VpnSite needs to be connected to. + +```yaml +Type: System.String +Parameter Sets: ByVpnSiteNameByVirtualWanName, ByVpnSiteObjectByVirtualWanName, ByVpnSiteResourceIdByVirtualWanName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualWanResourceGroupName +The resource group name of the VirtualWan this VpnSite needs to be connected to. + +```yaml +Type: System.String +Parameter Sets: ByVpnSiteNameByVirtualWanName, ByVpnSiteObjectByVirtualWanName, ByVpnSiteResourceIdByVirtualWanName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpnSiteLink +The list of VpnSiteLinks that this VpnSite have. + +```yaml +Type: Microsoft.Azure.Commands.Network.Models.PSVpnSiteLink[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnSite + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Network.Models.PSVpnSite + +## NOTES + +## RELATED LINKS + +[Get-AzVpnSite](./Get-AzVpnSite.md) + +[New-AzVpnSite](./New-AzVpnSite.md) + +[Remove-AzVpnSite](./Remove-AzVpnSite.md) diff --git a/azps-10.1.0/Az.NetworkFunction/Az.NetworkFunction.md b/azps-10.1.0/Az.NetworkFunction/Az.NetworkFunction.md new file mode 100644 index 0000000000..8dda635eb3 --- /dev/null +++ b/azps-10.1.0/Az.NetworkFunction/Az.NetworkFunction.md @@ -0,0 +1,45 @@ +--- +Module Name: Az.NetworkFunction +Module Guid: 1d339b1c-5a86-4fbd-9a2e-d0497c39b397 +Download Help Link: https://learn.microsoft.com/powershell/module/az.networkfunction +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Az.NetworkFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Az.NetworkFunction.md +--- + +# Az.NetworkFunction Module +## Description +Microsoft Azure PowerShell: NetworkFunction cmdlets + +## Az.NetworkFunction Cmdlets +### [Get-AzNetworkFunctionCollectorPolicy](Get-AzNetworkFunctionCollectorPolicy.md) +Gets the collector policy in a specified Traffic Collector + +### [Get-AzNetworkFunctionTrafficCollector](Get-AzNetworkFunctionTrafficCollector.md) +Gets the specified Azure Traffic Collector in a specified resource group + +### [New-AzNetworkFunctionCollectorPolicy](New-AzNetworkFunctionCollectorPolicy.md) +Creates or updates a Collector Policy resource + +### [New-AzNetworkFunctionTrafficCollector](New-AzNetworkFunctionTrafficCollector.md) +Creates or updates a Azure Traffic Collector resource + +### [Remove-AzNetworkFunctionCollectorPolicy](Remove-AzNetworkFunctionCollectorPolicy.md) +Deletes a specified Collector Policy resource. + +### [Remove-AzNetworkFunctionTrafficCollector](Remove-AzNetworkFunctionTrafficCollector.md) +Deletes a specified Azure Traffic Collector resource. + +### [Update-AzNetworkFunctionCollectorPolicy](Update-AzNetworkFunctionCollectorPolicy.md) +Creates or updates a Collector Policy resource + +### [Update-AzNetworkFunctionCollectorPolicyTag](Update-AzNetworkFunctionCollectorPolicyTag.md) +Updates the specified Collector Policy tags. + +### [Update-AzNetworkFunctionTrafficCollector](Update-AzNetworkFunctionTrafficCollector.md) +Creates or updates a Azure Traffic Collector resource + +### [Update-AzNetworkFunctionTrafficCollectorTag](Update-AzNetworkFunctionTrafficCollectorTag.md) +Updates the specified Azure Traffic Collector tags. + diff --git a/azps-10.1.0/Az.NetworkFunction/Get-AzNetworkFunctionCollectorPolicy.md b/azps-10.1.0/Az.NetworkFunction/Get-AzNetworkFunctionCollectorPolicy.md new file mode 100644 index 0000000000..4c6272e4b3 --- /dev/null +++ b/azps-10.1.0/Az.NetworkFunction/Get-AzNetworkFunctionCollectorPolicy.md @@ -0,0 +1,198 @@ +--- +external help file: +Module Name: Az.NetworkFunction +online version: https://learn.microsoft.com/powershell/module/az.networkfunction/get-aznetworkfunctioncollectorpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Get-AzNetworkFunctionCollectorPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Get-AzNetworkFunctionCollectorPolicy.md +--- + +# Get-AzNetworkFunctionCollectorPolicy + +## SYNOPSIS +Gets the collector policy in a specified Traffic Collector + +## SYNTAX + +### List (Default) +``` +Get-AzNetworkFunctionCollectorPolicy -AzureTrafficCollectorName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzNetworkFunctionCollectorPolicy -AzureTrafficCollectorName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzNetworkFunctionCollectorPolicy -InputObject <INetworkFunctionIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the collector policy in a specified Traffic Collector + +## EXAMPLES + +### Example 1: Get list of collector policies by atc name and resource group +```powershell +Get-AzNetworkFunctionCollectorPolicy -AzureTrafficCollectorName test -resourcegroupname test | Format-List +``` + +```output +Name : cp1 +Etag : cf0336a2-7454-4aa4-add9-1de3e2291143 +Id : /subscriptions/subid/resourceGroups/test/providers/Microsoft.NetworkFunction/azureTrafficCollectors/test/collectorPolicies/cp1 +Type : Microsoft.NetworkFunction/azureTrafficCollectors/collectorPolicies +Properties : { + "ingestionPolicy": { + "ingestionType": "IPFIX", + "ingestionSources": [ + { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "sourceType": "Resource" + } + ] + }, + "emissionPolicies": [ + { + "emissionType": "IPFIX", + "emissionDestinations": [ + { + "destinationType": "AzureMonitor" + } + ] + } + ], + "provisioningState": "Succeeded" + } +``` + +This cmdlet gets list of traffic collector policies by atc name and resource group. + +## PARAMETERS + +### -AzureTrafficCollectorName +Azure Traffic Collector name + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.INetworkFunctionIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Collector Policy Name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CollectorPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.INetworkFunctionIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.Api20221101.ICollectorPolicy + +## 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 <INetworkFunctionIdentity>`: Identity Parameter + - `[AzureTrafficCollectorName <String>]`: Azure Traffic Collector name + - `[CollectorPolicyName <String>]`: Collector Policy Name + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.NetworkFunction/Get-AzNetworkFunctionTrafficCollector.md b/azps-10.1.0/Az.NetworkFunction/Get-AzNetworkFunctionTrafficCollector.md new file mode 100644 index 0000000000..a62599df28 --- /dev/null +++ b/azps-10.1.0/Az.NetworkFunction/Get-AzNetworkFunctionTrafficCollector.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.NetworkFunction +online version: https://learn.microsoft.com/powershell/module/az.networkfunction/get-aznetworkfunctiontrafficcollector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Get-AzNetworkFunctionTrafficCollector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Get-AzNetworkFunctionTrafficCollector.md +--- + +# Get-AzNetworkFunctionTrafficCollector + +## SYNOPSIS +Gets the specified Azure Traffic Collector in a specified resource group + +## SYNTAX + +### List (Default) +``` +Get-AzNetworkFunctionTrafficCollector [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzNetworkFunctionTrafficCollector -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzNetworkFunctionTrafficCollector -InputObject <INetworkFunctionIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzNetworkFunctionTrafficCollector -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the specified Azure Traffic Collector in a specified resource group + +## EXAMPLES + +### Example 1: Get list of traffic collectors in selected subscription +```powershell +Get-AzNetworkFunctionTrafficCollector | Format-List +``` + +```output +CollectorPolicies : {} +Etag : cf0336a2-7454-4aa4-add9-1de3e2291143 +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/atcTest/providers/Microsoft.NetworkFunction/azureTrafficCollectors/pstestjuly18 +Location : eastus +Name : pstestjuly18 +ProvisioningState : Failed +Tags : Microsoft.Azure.PowerShell.Cmdlets.AzureTrafficCollector.Models.ResourceTags +Type : Microsoft.NetworkFunction/AzureTrafficCollectors + +CollectorPolicies : {} +Etag : cedea0e9-e9e4-4b2e-816f-dad184d6b424 +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/atcTest/providers/Microsoft.NetworkFunction/azureTrafficCollectors/newpsatc +Location : eastus +Name : newpsatc +ProvisioningState : Succeeded +Tags : Microsoft.Azure.PowerShell.Cmdlets.AzureTrafficCollector.Models.ResourceTags +Type : Microsoft.NetworkFunction/AzureTrafficCollectors +``` + +This cmdlet gets list of traffic collectors in selected subscription. + +### Example 2: Get list of traffic collectors by resource group +```powershell +Get-AzNetworkFunctionTrafficCollector -ResourceGroupName test | Format-List +``` + +```output +CollectorPolicies : {} +Etag : cedea0e9-e9e4-4b2e-816f-dad184d6b424 +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/test/providers/Microsoft.NetworkFunction/azureTrafficCollectors/newpsatc +Location : eastus +Name : newpsatc +ProvisioningState : Succeeded +Tags : Microsoft.Azure.PowerShell.Cmdlets.AzureTrafficCollector.Models.ResourceTags +Type : Microsoft.NetworkFunction/AzureTrafficCollectors +``` + +This cmdlet gets list of traffic collectors by resource group. + +### Example 3: Get list of traffic collectors by name +```powershell +Get-AzNetworkFunctionTrafficCollector -ResourceGroupName test -name test | Format-List +``` + +```output +CollectorPolicies : {} +Etag : cedea0e9-e9e4-4b2e-816f-dad184d6b424 +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/test/providers/Microsoft.NetworkFunction/azureTrafficCollectors/test +Location : eastus +Name : newpsatc +ProvisioningState : Succeeded +Tags : Microsoft.Azure.PowerShell.Cmdlets.AzureTrafficCollector.Models.ResourceTags +Type : Microsoft.NetworkFunction/AzureTrafficCollectors +``` + +This cmdlet gets list of traffic collectors by name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.INetworkFunctionIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure Traffic Collector name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AzureTrafficCollectorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.INetworkFunctionIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.Api20221101.IAzureTrafficCollector + +## 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 <INetworkFunctionIdentity>`: Identity Parameter + - `[AzureTrafficCollectorName <String>]`: Azure Traffic Collector name + - `[CollectorPolicyName <String>]`: Collector Policy Name + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.NetworkFunction/New-AzNetworkFunctionCollectorPolicy.md b/azps-10.1.0/Az.NetworkFunction/New-AzNetworkFunctionCollectorPolicy.md new file mode 100644 index 0000000000..a8c05f287b --- /dev/null +++ b/azps-10.1.0/Az.NetworkFunction/New-AzNetworkFunctionCollectorPolicy.md @@ -0,0 +1,311 @@ +--- +external help file: +Module Name: Az.NetworkFunction +online version: https://learn.microsoft.com/powershell/module/az.networkfunction/new-aznetworkfunctioncollectorpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/New-AzNetworkFunctionCollectorPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/New-AzNetworkFunctionCollectorPolicy.md +--- + +# New-AzNetworkFunctionCollectorPolicy + +## SYNOPSIS +Creates or updates a Collector Policy resource + +## SYNTAX + +``` +New-AzNetworkFunctionCollectorPolicy -AzureTrafficCollectorName <String> -Name <String> + -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-EmissionPolicy <IEmissionPoliciesPropertiesFormat[]>] + [-IngestionPolicyIngestionSource <IIngestionSourcesPropertiesFormat[]>] + [-IngestionPolicyIngestionType <IngestionType>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a Collector Policy resource + +## EXAMPLES + +### Example 1: Create a new traffic collector policy +```powershell +New-AzNetworkFunctionCollectorPolicy -collectorpolicyname cp1 -azuretrafficcollectorname atc -resourcegroupname rg1 -location eastus | Format-List +``` + +```output +Name : cp1 +Etag : cf0336a2-7454-4aa4-add9-1de3e2291143 +Id : /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc/collectorPolicies/cp1 +Type : Microsoft.NetworkFunction/azureTrafficCollectors/collectorPolicies +Properties : { + "ingestionPolicy": { + "ingestionType": "IPFIX", + "ingestionSources": [ + { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "sourceType": "Resource" + } + ] + }, + "emissionPolicies": [ + { + "emissionType": "IPFIX", + "emissionDestinations": [ + { + "destinationType": "AzureMonitor" + } + ] + } + ], + "provisioningState": "Succeeded" + } +``` + +This cmdlet creates a new traffic collector policy. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureTrafficCollectorName +Azure Traffic Collector name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmissionPolicy +Emission policies. +To construct, see NOTES section for EMISSIONPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.Api20221101.IEmissionPoliciesPropertiesFormat[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngestionPolicyIngestionSource +Ingestion Sources. +To construct, see NOTES section for INGESTIONPOLICYINGESTIONSOURCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.Api20221101.IIngestionSourcesPropertiesFormat[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngestionPolicyIngestionType +The ingestion type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Support.IngestionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Collector Policy Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CollectorPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.Api20221101.ICollectorPolicy + +## 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. + + +`EMISSIONPOLICY <IEmissionPoliciesPropertiesFormat[]>`: Emission policies. + - `[EmissionDestination <IEmissionPolicyDestination[]>]`: Emission policy destinations. + - `[DestinationType <DestinationType?>]`: Emission destination type. + - `[EmissionType <EmissionType?>]`: Emission format type. + +`INGESTIONPOLICYINGESTIONSOURCE <IIngestionSourcesPropertiesFormat[]>`: Ingestion Sources. + - `[ResourceId <String>]`: Resource ID. + - `[SourceType <SourceType?>]`: Ingestion source type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.NetworkFunction/New-AzNetworkFunctionTrafficCollector.md b/azps-10.1.0/Az.NetworkFunction/New-AzNetworkFunctionTrafficCollector.md new file mode 100644 index 0000000000..7f0f2db4fe --- /dev/null +++ b/azps-10.1.0/Az.NetworkFunction/New-AzNetworkFunctionTrafficCollector.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.NetworkFunction +online version: https://learn.microsoft.com/powershell/module/az.networkfunction/new-aznetworkfunctiontrafficcollector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/New-AzNetworkFunctionTrafficCollector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/New-AzNetworkFunctionTrafficCollector.md +--- + +# New-AzNetworkFunctionTrafficCollector + +## SYNOPSIS +Creates or updates a Azure Traffic Collector resource + +## SYNTAX + +``` +New-AzNetworkFunctionTrafficCollector -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a Azure Traffic Collector resource + +## EXAMPLES + +### Example 1: Create a new traffic collector +```powershell +New-AzNetworkFunctionTrafficCollector -name atctestps -resourcegroupname test -location eastus | Format-List +``` + +```output +CollectorPolicies : {} +Etag : cf0336a2-7454-4aa4-add9-1de3e2291143 +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/test/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atctestps +Location : eastus +Name : atctestps +ProvisioningState : Succeeded +Tags : Microsoft.Azure.PowerShell.Cmdlets.AzureTrafficCollector.Models.ResourceTags +Type : Microsoft.NetworkFunction/AzureTrafficCollectors +``` + +This cmdlet creates a new traffic collector. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure Traffic Collector name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AzureTrafficCollectorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.Api20221101.IAzureTrafficCollector + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.NetworkFunction/Remove-AzNetworkFunctionCollectorPolicy.md b/azps-10.1.0/Az.NetworkFunction/Remove-AzNetworkFunctionCollectorPolicy.md new file mode 100644 index 0000000000..b47e382176 --- /dev/null +++ b/azps-10.1.0/Az.NetworkFunction/Remove-AzNetworkFunctionCollectorPolicy.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.NetworkFunction +online version: https://learn.microsoft.com/powershell/module/az.networkfunction/remove-aznetworkfunctioncollectorpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Remove-AzNetworkFunctionCollectorPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Remove-AzNetworkFunctionCollectorPolicy.md +--- + +# Remove-AzNetworkFunctionCollectorPolicy + +## SYNOPSIS +Deletes a specified Collector Policy resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzNetworkFunctionCollectorPolicy -AzureTrafficCollectorName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzNetworkFunctionCollectorPolicy -InputObject <INetworkFunctionIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a specified Collector Policy resource. + +## EXAMPLES + +### Example 1: Delete a new traffic collector policy +```powershell +Remove-AzNetworkFunctionCollectorPolicy -azuretrafficcollectorname atctestps -collectorpolicyname cp1 -resourcegroupname test +``` + +This cmdlet deletes a traffic collector policy. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureTrafficCollectorName +Azure Traffic Collector name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.INetworkFunctionIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Collector Policy Name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CollectorPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.INetworkFunctionIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <INetworkFunctionIdentity>`: Identity Parameter + - `[AzureTrafficCollectorName <String>]`: Azure Traffic Collector name + - `[CollectorPolicyName <String>]`: Collector Policy Name + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.NetworkFunction/Remove-AzNetworkFunctionTrafficCollector.md b/azps-10.1.0/Az.NetworkFunction/Remove-AzNetworkFunctionTrafficCollector.md new file mode 100644 index 0000000000..c4952019da --- /dev/null +++ b/azps-10.1.0/Az.NetworkFunction/Remove-AzNetworkFunctionTrafficCollector.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.NetworkFunction +online version: https://learn.microsoft.com/powershell/module/az.networkfunction/remove-aznetworkfunctiontrafficcollector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Remove-AzNetworkFunctionTrafficCollector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Remove-AzNetworkFunctionTrafficCollector.md +--- + +# Remove-AzNetworkFunctionTrafficCollector + +## SYNOPSIS +Deletes a specified Azure Traffic Collector resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzNetworkFunctionTrafficCollector -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzNetworkFunctionTrafficCollector -InputObject <INetworkFunctionIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a specified Azure Traffic Collector resource. + +## EXAMPLES + +### Example 1: Delete a new traffic collector +```powershell +Remove-AzNetworkFunctionTrafficCollector -name atctestps -resourcegroupname SEA-Cust10 +``` + +This cmdlet deletes a traffic collector. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.INetworkFunctionIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure Traffic Collector name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AzureTrafficCollectorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.INetworkFunctionIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <INetworkFunctionIdentity>`: Identity Parameter + - `[AzureTrafficCollectorName <String>]`: Azure Traffic Collector name + - `[CollectorPolicyName <String>]`: Collector Policy Name + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.NetworkFunction/Update-AzNetworkFunctionCollectorPolicy.md b/azps-10.1.0/Az.NetworkFunction/Update-AzNetworkFunctionCollectorPolicy.md new file mode 100644 index 0000000000..d7f4d6f339 --- /dev/null +++ b/azps-10.1.0/Az.NetworkFunction/Update-AzNetworkFunctionCollectorPolicy.md @@ -0,0 +1,310 @@ +--- +external help file: +Module Name: Az.NetworkFunction +online version: https://learn.microsoft.com/powershell/module/az.networkfunction/update-aznetworkfunctioncollectorpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Update-AzNetworkFunctionCollectorPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Update-AzNetworkFunctionCollectorPolicy.md +--- + +# Update-AzNetworkFunctionCollectorPolicy + +## SYNOPSIS +Creates or updates a Collector Policy resource + +## SYNTAX + +``` +Update-AzNetworkFunctionCollectorPolicy -AzureTrafficCollectorName <String> -Name <String> + -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-EmissionPolicy <IEmissionPoliciesPropertiesFormat[]>] + [-IngestionPolicyIngestionSource <IIngestionSourcesPropertiesFormat[]>] + [-IngestionPolicyIngestionType <IngestionType>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a Collector Policy resource + +## EXAMPLES + +### Example 1: Update a traffic collector policy +```powershell +Update-AzNetworkFunctionCollectorPolicy -collectorpolicyname cp1 -azuretrafficcollectorname atc -resourcegroupname rg1 -location eastus | Format-List +``` + +```output +Name : cp1 +Etag : cf0336a2-7454-4aa4-add9-1de3e2291143 +Id : /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc/collectorPolicies/cp1 +Type : Microsoft.NetworkFunction/azureTrafficCollectors/collectorPolicies +Properties : { + "ingestionPolicy": { + "ingestionType": "IPFIX", + "ingestionSources": [ + { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "sourceType": "Resource" + } + ] + }, + "emissionPolicies": [ + { + "emissionType": "IPFIX", + "emissionDestinations": [ + { + "destinationType": "AzureMonitor" + } + ] + } + ], + "provisioningState": "Succeeded" + } +``` + +This cmdlet updates a traffic collector policy. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureTrafficCollectorName +Azure Traffic Collector name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmissionPolicy +Emission policies. +To construct, see NOTES section for EMISSIONPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.Api20221101.IEmissionPoliciesPropertiesFormat[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngestionPolicyIngestionSource +Ingestion Sources. +To construct, see NOTES section for INGESTIONPOLICYINGESTIONSOURCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.Api20221101.IIngestionSourcesPropertiesFormat[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IngestionPolicyIngestionType +The ingestion type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Support.IngestionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Collector Policy Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CollectorPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.Api20221101.ICollectorPolicy + +## 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. + + +`EMISSIONPOLICY <IEmissionPoliciesPropertiesFormat[]>`: Emission policies. + - `[EmissionDestination <IEmissionPolicyDestination[]>]`: Emission policy destinations. + - `[DestinationType <DestinationType?>]`: Emission destination type. + - `[EmissionType <EmissionType?>]`: Emission format type. + +`INGESTIONPOLICYINGESTIONSOURCE <IIngestionSourcesPropertiesFormat[]>`: Ingestion Sources. + - `[ResourceId <String>]`: Resource ID. + - `[SourceType <SourceType?>]`: Ingestion source type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.NetworkFunction/Update-AzNetworkFunctionCollectorPolicyTag.md b/azps-10.1.0/Az.NetworkFunction/Update-AzNetworkFunctionCollectorPolicyTag.md new file mode 100644 index 0000000000..5beff9fee2 --- /dev/null +++ b/azps-10.1.0/Az.NetworkFunction/Update-AzNetworkFunctionCollectorPolicyTag.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: Az.NetworkFunction +online version: https://learn.microsoft.com/powershell/module/az.networkfunction/update-aznetworkfunctioncollectorpolicytag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Update-AzNetworkFunctionCollectorPolicyTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Update-AzNetworkFunctionCollectorPolicyTag.md +--- + +# Update-AzNetworkFunctionCollectorPolicyTag + +## SYNOPSIS +Updates the specified Collector Policy tags. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzNetworkFunctionCollectorPolicyTag -AzureTrafficCollectorName <String> -CollectorPolicyName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzNetworkFunctionCollectorPolicyTag -InputObject <INetworkFunctionIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the specified Collector Policy tags. + +## EXAMPLES + +### Example 1: Updates a traffic collector tag +```powershell +Update-AzNetworkFunctionCollectorPolicyTag -collectorpolicyname cp1 -azuretrafficcollectorname atc -resourcegroupname rg1 | Format-List +``` + +```output +Name : cp1 +Etag : 72090554-7e3b-43f2-80ad-99a9020dcb11 +Id : /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc/collectorPolicies/cp1 +Type : Microsoft.NetworkFunction/azureTrafficCollectors/collectorPolicies +Location : West US +Tags : { + "key1": "value1", + "key2": "value2" + } +Properties : { + "ingestionPolicy": { + "ingestionType": "IPFIX", + "ingestionSources": [ + { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "sourceType": "Resource" + } + ] + }, + "emissionPolicies": [ + { + "emissionType": "IPFIX", + "emissionDestinations": [ + { + "destinationType": "AzureMonitor" + } + ] + } + ], + "provisioningState": "Succeeded" + } +``` + +This cmdlet updates a collector policy tag. + +## PARAMETERS + +### -AzureTrafficCollectorName +Azure Traffic Collector name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectorPolicyName +Collector Policy Name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.INetworkFunctionIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.INetworkFunctionIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.Api20221101.ICollectorPolicy + +## 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 <INetworkFunctionIdentity>`: Identity Parameter + - `[AzureTrafficCollectorName <String>]`: Azure Traffic Collector name + - `[CollectorPolicyName <String>]`: Collector Policy Name + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.NetworkFunction/Update-AzNetworkFunctionTrafficCollector.md b/azps-10.1.0/Az.NetworkFunction/Update-AzNetworkFunctionTrafficCollector.md new file mode 100644 index 0000000000..dbb9baa1c1 --- /dev/null +++ b/azps-10.1.0/Az.NetworkFunction/Update-AzNetworkFunctionTrafficCollector.md @@ -0,0 +1,252 @@ +--- +external help file: +Module Name: Az.NetworkFunction +online version: https://learn.microsoft.com/powershell/module/az.networkfunction/update-aznetworkfunctiontrafficcollector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Update-AzNetworkFunctionTrafficCollector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Update-AzNetworkFunctionTrafficCollector.md +--- + +# Update-AzNetworkFunctionTrafficCollector + +## SYNOPSIS +Creates or updates a Azure Traffic Collector resource + +## SYNTAX + +``` +Update-AzNetworkFunctionTrafficCollector -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-CollectorPolicy <ICollectorPolicy[]>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a Azure Traffic Collector resource + +## EXAMPLES + +### Example 1: Updates a traffic collector +```powershell +Update-AzNetworkFunctionTrafficCollector -name atctestps -resourcegroupname test -location eastus | Format-List +``` + +```output +CollectorPolicies : {} +Etag : cf0336a2-7454-4aa4-add9-1de3e2291143 +Id : /subscriptions/62364504-2406-418e-971c-05822ff72fad/resourceGroups/test/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atctestps +Location : eastus +Name : atctestps +ProvisioningState : Succeeded +Tags : Microsoft.Azure.PowerShell.Cmdlets.AzureTrafficCollector.Models.ResourceTags +Type : Microsoft.NetworkFunction/AzureTrafficCollectors +``` + +This cmdlet updates a traffic collector. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectorPolicy +Collector Policies for Azure Traffic Collector. +To construct, see NOTES section for COLLECTORPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.Api20221101.ICollectorPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure Traffic Collector name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AzureTrafficCollectorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.Api20221101.IAzureTrafficCollector + +## 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. + + +`COLLECTORPOLICY <ICollectorPolicy[]>`: Collector Policies for Azure Traffic Collector. + - `Location <String>`: Resource location. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[EmissionPolicy <IEmissionPoliciesPropertiesFormat[]>]`: Emission policies. + - `[EmissionDestination <IEmissionPolicyDestination[]>]`: Emission policy destinations. + - `[DestinationType <DestinationType?>]`: Emission destination type. + - `[EmissionType <EmissionType?>]`: Emission format type. + - `[IngestionPolicyIngestionSource <IIngestionSourcesPropertiesFormat[]>]`: Ingestion Sources. + - `[ResourceId <String>]`: Resource ID. + - `[SourceType <SourceType?>]`: Ingestion source type. + - `[IngestionPolicyIngestionType <IngestionType?>]`: The ingestion type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.NetworkFunction/Update-AzNetworkFunctionTrafficCollectorTag.md b/azps-10.1.0/Az.NetworkFunction/Update-AzNetworkFunctionTrafficCollectorTag.md new file mode 100644 index 0000000000..ea02b70db4 --- /dev/null +++ b/azps-10.1.0/Az.NetworkFunction/Update-AzNetworkFunctionTrafficCollectorTag.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: Az.NetworkFunction +online version: https://learn.microsoft.com/powershell/module/az.networkfunction/update-aznetworkfunctiontrafficcollectortag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Update-AzNetworkFunctionTrafficCollectorTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NetworkFunction/help/Update-AzNetworkFunctionTrafficCollectorTag.md +--- + +# Update-AzNetworkFunctionTrafficCollectorTag + +## SYNOPSIS +Updates the specified Azure Traffic Collector tags. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzNetworkFunctionTrafficCollectorTag -AzureTrafficCollectorName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzNetworkFunctionTrafficCollectorTag -InputObject <INetworkFunctionIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the specified Azure Traffic Collector tags. + +## EXAMPLES + +### Example 1: Updates a traffic collector tag +```powershell +Update-AzNetworkFunctionTrafficCollectorTag -azuretrafficcollectorname atc -resourcegroupname rg1 | Format-List +``` + +```output +Name : atc +Etag : cf0336a2-7454-4aa4-add9-1de3e2291143 +Id : /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc +Type : Microsoft.NetworkFunction/azureTrafficCollectors +Location : West US +Tags : { + "key1": "value1", + "key2": "value2" + } +Properties : { + "collectorPolicies": [], + "provisioningState": "Succeeded" + } +``` + +This cmdlet updates a traffic collector tag. + +## PARAMETERS + +### -AzureTrafficCollectorName +Azure Traffic Collector name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.INetworkFunctionIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.INetworkFunctionIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.NetworkFunction.Models.Api20221101.IAzureTrafficCollector + +## 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 <INetworkFunctionIdentity>`: Identity Parameter + - `[AzureTrafficCollectorName <String>]`: Azure Traffic Collector name + - `[CollectorPolicyName <String>]`: Collector Policy Name + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/Az.Nginx.md b/azps-10.1.0/Az.Nginx/Az.Nginx.md new file mode 100644 index 0000000000..526e29a75d --- /dev/null +++ b/azps-10.1.0/Az.Nginx/Az.Nginx.md @@ -0,0 +1,57 @@ +--- +Module Name: Az.Nginx +Module Guid: a6006217-b983-465f-9b21-5017989fa14f +Download Help Link: https://learn.microsoft.com/powershell/module/az.nginx +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Az.Nginx.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Az.Nginx.md +--- + +# Az.Nginx Module +## Description +Microsoft Azure PowerShell: Nginx cmdlets + +## Az.Nginx Cmdlets +### [Get-AzNginxCertificate](Get-AzNginxCertificate.md) +Get a certificate of given Nginx deployment + +### [Get-AzNginxConfiguration](Get-AzNginxConfiguration.md) +Get the Nginx configuration of given Nginx deployment + +### [Get-AzNginxDeployment](Get-AzNginxDeployment.md) +Get the Nginx deployment + +### [New-AzNginxCertificate](New-AzNginxCertificate.md) +Create or update the Nginx certificates for given Nginx deployment + +### [New-AzNginxConfiguration](New-AzNginxConfiguration.md) +Create or update the Nginx configuration for given Nginx deployment + +### [New-AzNginxConfigurationFileObject](New-AzNginxConfigurationFileObject.md) +Create an in-memory object for NginxConfigurationFile. + +### [New-AzNginxDeployment](New-AzNginxDeployment.md) +Create or update the Nginx deployment + +### [New-AzNginxNetworkProfileObject](New-AzNginxNetworkProfileObject.md) +Create an in-memory object for NginxNetworkProfile. + +### [New-AzNginxPrivateIPAddressObject](New-AzNginxPrivateIPAddressObject.md) +Create an in-memory object for NginxPrivateIPAddress. + +### [New-AzNginxPublicIPAddressObject](New-AzNginxPublicIPAddressObject.md) +Create an in-memory object for NginxPublicIPAddress. + +### [Remove-AzNginxCertificate](Remove-AzNginxCertificate.md) +Deletes a certificate from the nginx deployment + +### [Remove-AzNginxConfiguration](Remove-AzNginxConfiguration.md) +Reset the Nginx configuration of given Nginx deployment to default + +### [Remove-AzNginxDeployment](Remove-AzNginxDeployment.md) +Delete the Nginx deployment resource + +### [Update-AzNginxDeployment](Update-AzNginxDeployment.md) +Update the Nginx deployment + diff --git a/azps-10.1.0/Az.Nginx/Get-AzNginxCertificate.md b/azps-10.1.0/Az.Nginx/Get-AzNginxCertificate.md new file mode 100644 index 0000000000..0f862e4e3a --- /dev/null +++ b/azps-10.1.0/Az.Nginx/Get-AzNginxCertificate.md @@ -0,0 +1,189 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.nginx/get-aznginxcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Get-AzNginxCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Get-AzNginxCertificate.md +--- + +# Get-AzNginxCertificate + +## SYNOPSIS +Get a certificate of given Nginx deployment + +## SYNTAX + +### List (Default) +``` +Get-AzNginxCertificate -DeploymentName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzNginxCertificate -DeploymentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzNginxCertificate -InputObject <INginxIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a certificate of given Nginx deployment + +## EXAMPLES + +### Example 1: List all certificates under a NGINX deployment +```powershell +Get-AzNginxCertificate -DeploymentName nginx-test -ResourceGroupName nginx-test-rg +``` + +```output +Location Name +-------- ---- +westcentralus cert +westcentralus cert1 +``` + +This command lists all certificates under a NGINX deployment. + +### Example 2: Get a certificate +```powershell +Get-AzNginxCertificate -DeploymentName nginx-test -Name cert -ResourceGroupName nginx-test-rg +``` + +```output +Location Name +-------- ---- +westcentralus cert +``` + +This command gets a certificate. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The name of targeted Nginx deployment + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of certificate + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.INginxCertificate + +## 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 <INginxIdentity>`: Identity Parameter + - `[CertificateName <String>]`: The name of certificate + - `[ConfigurationName <String>]`: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf + - `[DeploymentName <String>]`: The name of targeted Nginx deployment + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/Get-AzNginxConfiguration.md b/azps-10.1.0/Az.Nginx/Get-AzNginxConfiguration.md new file mode 100644 index 0000000000..23a9c818d8 --- /dev/null +++ b/azps-10.1.0/Az.Nginx/Get-AzNginxConfiguration.md @@ -0,0 +1,175 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.nginx/get-aznginxconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Get-AzNginxConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Get-AzNginxConfiguration.md +--- + +# Get-AzNginxConfiguration + +## SYNOPSIS +Get the Nginx configuration of given Nginx deployment + +## SYNTAX + +### List (Default) +``` +Get-AzNginxConfiguration -DeploymentName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzNginxConfiguration -DeploymentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzNginxConfiguration -InputObject <INginxIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the Nginx configuration of given Nginx deployment + +## EXAMPLES + +### Example 1: Get the default configuration +```powershell +Get-AzNginxConfiguration -DeploymentName nginx-test -Name default -ResourceGroupName nginx-test-rg +``` + +```output +Location Name +-------- ---- + default +``` + +Get a default configuration. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The name of targeted Nginx deployment + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of configuration, only 'default' is supported value due to the singleton of Nginx conf + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.INginxConfiguration + +## 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 <INginxIdentity>`: Identity Parameter + - `[CertificateName <String>]`: The name of certificate + - `[ConfigurationName <String>]`: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf + - `[DeploymentName <String>]`: The name of targeted Nginx deployment + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/Get-AzNginxDeployment.md b/azps-10.1.0/Az.Nginx/Get-AzNginxDeployment.md new file mode 100644 index 0000000000..45b34d5849 --- /dev/null +++ b/azps-10.1.0/Az.Nginx/Get-AzNginxDeployment.md @@ -0,0 +1,195 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.nginx/get-aznginxdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Get-AzNginxDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Get-AzNginxDeployment.md +--- + +# Get-AzNginxDeployment + +## SYNOPSIS +Get the Nginx deployment + +## SYNTAX + +### List (Default) +``` +Get-AzNginxDeployment [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzNginxDeployment -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzNginxDeployment -InputObject <INginxIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzNginxDeployment -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the Nginx deployment + +## EXAMPLES + +### Example 1: Get a NGINX deployment with name +```powershell +Get-AzNginxDeployment -Name nginx-test -ResourceGroupName nginx-test-rg +``` + +```output +Location Name +-------- ---- +westcentralus nginx-test +``` + +This command gets a NGINX deployment in a resource group. + +### Example 2: List all NGINX deployments in a subscription +```powershell +Get-AzNginxDeployment +``` + +```output +Location Name +-------- ---- +westcentralus nginx-test +westcentralus nginx-test1 +eastus2 nginx-test2 + +``` + +This command lists all NGINX deployments in a subscription. + +### Example 3: List all NGINX deployments in a resource group +```powershell +Get-AzNginxDeployment -ResourceGroupName nginx-test-rg +``` + +```output +Location Name +-------- ---- +westcentralus nginx-test +westcentralus nginx-test1 +``` + +This command lists all NGINX deployments in a resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of targeted Nginx deployment + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DeploymentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.INginxDeployment + +## 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 <INginxIdentity>`: Identity Parameter + - `[CertificateName <String>]`: The name of certificate + - `[ConfigurationName <String>]`: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf + - `[DeploymentName <String>]`: The name of targeted Nginx deployment + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/New-AzNginxCertificate.md b/azps-10.1.0/Az.Nginx/New-AzNginxCertificate.md new file mode 100644 index 0000000000..f5e48c9df9 --- /dev/null +++ b/azps-10.1.0/Az.Nginx/New-AzNginxCertificate.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.nginx/new-aznginxcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxCertificate.md +--- + +# New-AzNginxCertificate + +## SYNOPSIS +Create or update the Nginx certificates for given Nginx deployment + +## SYNTAX + +``` +New-AzNginxCertificate -DeploymentName <String> -Name <String> -ResourceGroupName <String> + -CertificateVirtualPath <String> -KeyVaultSecretId <String> -KeyVirtualPath <String> + [-SubscriptionId <String>] [-Location <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update the Nginx certificates for given Nginx deployment + +## EXAMPLES + +### Example 1: Create a certificate for a NGINX deployment +```powershell +New-AzNginxCertificate -DeploymentName nginx-test -Name cert-test -ResourceGroupName nginx-test-rg -CertificateVirtualPath /etc/nginx/test.cert -KeyVirtualPath /etc/nginx/test.key -KeyVaultSecretId https://tests-kv.vault.azure.net/secrets/newcert +``` + +```output +Location Name +-------- ---- + cert-test +``` + +This commond creates a certificate for a NGINX deployment. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateVirtualPath +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The name of targeted Nginx deployment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultSecretId +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVirtualPath +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of certificate + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Dictionary of \<string\> + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.INginxCertificate + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/New-AzNginxConfiguration.md b/azps-10.1.0/Az.Nginx/New-AzNginxConfiguration.md new file mode 100644 index 0000000000..df0c858a36 --- /dev/null +++ b/azps-10.1.0/Az.Nginx/New-AzNginxConfiguration.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.nginx/new-aznginxconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxConfiguration.md +--- + +# New-AzNginxConfiguration + +## SYNOPSIS +Create or update the Nginx configuration for given Nginx deployment + +## SYNTAX + +``` +New-AzNginxConfiguration -DeploymentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-File <INginxConfigurationFile[]>] [-Location <String>] [-PackageData <String>] + [-ProtectedFile <INginxConfigurationFile[]>] [-RootFile <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update the Nginx configuration for given Nginx deployment + +## EXAMPLES + +### Example 1: Create or update the Nginx configuration for given Nginx deployment +```powershell +New-AzNginxConfiguration -DeploymentName nginx-test -Name default -ResourceGroupName nginx-test-rg -File $confFile -RootFile nginx.conf +``` + +```output +Location Name +-------- ---- + default +``` + +This command creates or updates the Nginx configuration for given Nginx deployment. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The name of targeted Nginx deployment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +. +To construct, see NOTES section for FILE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.INginxConfigurationFile[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of configuration, only 'default' is supported value due to the singleton of Nginx conf + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageData +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectedFile +. +To construct, see NOTES section for PROTECTEDFILE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.INginxConfigurationFile[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RootFile +. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Dictionary of \<string\> + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.INginxConfiguration + +## 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. + + +`FILE <INginxConfigurationFile[]>`: . + - `[Content <String>]`: + - `[VirtualPath <String>]`: + +`PROTECTEDFILE <INginxConfigurationFile[]>`: . + - `[Content <String>]`: + - `[VirtualPath <String>]`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/New-AzNginxConfigurationFileObject.md b/azps-10.1.0/Az.Nginx/New-AzNginxConfigurationFileObject.md new file mode 100644 index 0000000000..697ccc644b --- /dev/null +++ b/azps-10.1.0/Az.Nginx/New-AzNginxConfigurationFileObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.Nginx/new-AzNginxConfigurationFileObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxConfigurationFileObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxConfigurationFileObject.md +--- + +# New-AzNginxConfigurationFileObject + +## SYNOPSIS +Create an in-memory object for NginxConfigurationFile. + +## SYNTAX + +``` +New-AzNginxConfigurationFileObject [-Content <String>] [-VirtualPath <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for NginxConfigurationFile. + +## EXAMPLES + +### Example 1: Create an in-memory object for NginxConfigurationFile +```powershell +New-AzNginxConfigurationFileObject -Content aHR0cCB7 -VirtualPath nginx.conf +``` + +```output +Content VirtualPath +------- ----------- +aHR0cCB7 nginx.conf +``` + +Create an in-memory object for NginxConfigurationFile. + +## PARAMETERS + +### -Content + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualPath + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.NginxConfigurationFile + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/New-AzNginxDeployment.md b/azps-10.1.0/Az.Nginx/New-AzNginxDeployment.md new file mode 100644 index 0000000000..6020aa31ec --- /dev/null +++ b/azps-10.1.0/Az.Nginx/New-AzNginxDeployment.md @@ -0,0 +1,348 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.nginx/new-aznginxdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxDeployment.md +--- + +# New-AzNginxDeployment + +## SYNOPSIS +Create or update the Nginx deployment + +## SYNTAX + +``` +New-AzNginxDeployment -Name <String> -ResourceGroupName <String> -Location <String> + -NetworkProfile <INginxNetworkProfile> -SkuName <String> [-SubscriptionId <String>] + [-EnableDiagnosticsSupport] [-IdentityType <IdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] + [-ManagedResourceGroup <String>] [-StorageAccountContainerName <String>] [-StorageAccountName <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update the Nginx deployment + +## EXAMPLES + +### Example 1: Create or update the Nginx deployment +```powershell +New-AzNginxDeployment -Name nginx-test -ResourceGroupName nginx-test-rg -Location westcentralus -NetworkProfile $networkProfile -SkuName preview_Monthly_gmz7xq9ge3py +``` + +```output +Location Name +-------- ---- +westcentralus nginx-test +``` + +This command creates or updates the Nginx deployment. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDiagnosticsSupport +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Support.IdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +Dictionary of \<UserIdentityProperties\> + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedResourceGroup +The managed resource group to deploy VNet injection related network resources. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of targeted Nginx deployment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfile +. +To construct, see NOTES section for NETWORKPROFILE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.INginxNetworkProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name of the SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountContainerName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Dictionary of \<string\> + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.INginxDeployment + +## 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. + + +`NETWORKPROFILE <INginxNetworkProfile>`: . + - `[FrontEndIPConfiguration <INginxFrontendIPConfiguration>]`: + - `[PrivateIPAddress <INginxPrivateIPAddress[]>]`: + - `[PrivateIPAddress <String>]`: + - `[PrivateIPAllocationMethod <NginxPrivateIPAllocationMethod?>]`: + - `[SubnetId <String>]`: + - `[PublicIPAddress <INginxPublicIPAddress[]>]`: + - `[Id <String>]`: + - `[NetworkInterfaceConfiguration <INginxNetworkInterfaceConfiguration>]`: + - `[SubnetId <String>]`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/New-AzNginxNetworkProfileObject.md b/azps-10.1.0/Az.Nginx/New-AzNginxNetworkProfileObject.md new file mode 100644 index 0000000000..5738e6ae8e --- /dev/null +++ b/azps-10.1.0/Az.Nginx/New-AzNginxNetworkProfileObject.md @@ -0,0 +1,102 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.Nginx/new-AzNginxNetworkProfileObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxNetworkProfileObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxNetworkProfileObject.md +--- + +# New-AzNginxNetworkProfileObject + +## SYNOPSIS +Create an in-memory object for NginxNetworkProfile. + +## SYNTAX + +``` +New-AzNginxNetworkProfileObject [-FrontEndIPConfiguration <INginxFrontendIPConfiguration>] + [-NetworkInterfaceConfiguration <INginxNetworkInterfaceConfiguration>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for NginxNetworkProfile. + +## EXAMPLES + +### Example 1: Create an in-memory object for NginxNetworkProfile +```powershell +New-AzNginxNetworkProfileObject -FrontEndIPConfiguration @{PublicIPAddress=@($publicIp)} -NetworkInterfaceConfiguration @{SubnetId='/subscriptions/xxxxxxxxxx-xxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/nginx-test-rg/providers/Microsoft.Network/virtualNetworks/nginx-test-vnet/subnets/default'} +``` + +```output +FrontEndIPConfiguration NetworkInterfaceConfiguration +----------------------- ----------------------------- +{… {… +``` + +Create an in-memory object for NginxNetworkProfile. + +## PARAMETERS + +### -FrontEndIPConfiguration +To construct, see NOTES section for FRONTENDIPCONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.INginxFrontendIPConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkInterfaceConfiguration +To construct, see NOTES section for NETWORKINTERFACECONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.INginxNetworkInterfaceConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.NginxNetworkProfile + +## 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. + + +`FRONTENDIPCONFIGURATION <INginxFrontendIPConfiguration>`: + - `[PrivateIPAddress <INginxPrivateIPAddress[]>]`: + - `[PrivateIPAddress <String>]`: + - `[PrivateIPAllocationMethod <NginxPrivateIPAllocationMethod?>]`: + - `[SubnetId <String>]`: + - `[PublicIPAddress <INginxPublicIPAddress[]>]`: + - `[Id <String>]`: + +`NETWORKINTERFACECONFIGURATION <INginxNetworkInterfaceConfiguration>`: + - `[SubnetId <String>]`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/New-AzNginxPrivateIPAddressObject.md b/azps-10.1.0/Az.Nginx/New-AzNginxPrivateIPAddressObject.md new file mode 100644 index 0000000000..872b30d1b1 --- /dev/null +++ b/azps-10.1.0/Az.Nginx/New-AzNginxPrivateIPAddressObject.md @@ -0,0 +1,101 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.Nginx/new-AzNginxPrivateIPAddressObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxPrivateIPAddressObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxPrivateIPAddressObject.md +--- + +# New-AzNginxPrivateIPAddressObject + +## SYNOPSIS +Create an in-memory object for NginxPrivateIPAddress. + +## SYNTAX + +``` +New-AzNginxPrivateIPAddressObject [-PrivateIPAddress <String>] + [-PrivateIPAllocationMethod <NginxPrivateIPAllocationMethod>] [-SubnetId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for NginxPrivateIPAddress. + +## EXAMPLES + +### Example 1: Create an in-memory object for NginxPrivateIPAddress +```powershell +New-AzNginxPrivateIPAddressObject -PrivateIPAddress 10.0.0.0 -PrivateIPAllocationMethod Static -SubnetId /subscriptions/xxxxxxxxxx-xxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/nginx-test-rg/providers/Microsoft.Network/virtualNetworks/nginx-test-vnet/subnets/default +``` + +```output +PrivateIPAddress PrivateIPAllocationMethod SubnetId +---------------- ------------------------- -------- +10.0.0.0 Static /subscriptions/xxxxxxxxxx-xxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/nginx-test-rg/providers/Microsoft.Network/virtualNetworks/nginx-test-vnet/subnets/default +``` + +Create an in-memory object for NginxPrivateIPAddress. + +## PARAMETERS + +### -PrivateIPAddress + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIPAllocationMethod + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Support.NginxPrivateIPAllocationMethod +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.NginxPrivateIPAddress + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/New-AzNginxPublicIPAddressObject.md b/azps-10.1.0/Az.Nginx/New-AzNginxPublicIPAddressObject.md new file mode 100644 index 0000000000..533cc13abc --- /dev/null +++ b/azps-10.1.0/Az.Nginx/New-AzNginxPublicIPAddressObject.md @@ -0,0 +1,70 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.Nginx/new-AzNginxPublicIPAddressObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxPublicIPAddressObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/New-AzNginxPublicIPAddressObject.md +--- + +# New-AzNginxPublicIPAddressObject + +## SYNOPSIS +Create an in-memory object for NginxPublicIPAddress. + +## SYNTAX + +``` +New-AzNginxPublicIPAddressObject [-Id <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for NginxPublicIPAddress. + +## EXAMPLES + +### Example 1: Create an in-memory object for NginxPublicIPAddress +```powershell +New-AzNginxPublicIPAddressObject -Id /subscriptions/xxxxxxxxxx-xxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/nginx-test-rg/providers/Microsoft.Network/publicIPAddresses/nginx-test-ip +``` + +```output +Id +-- +/subscriptions/xxxxxxxxxx-xxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/nginx-test-rg/providers/Microsoft.Network/publicIPAddresses/nginx-test-ip +``` + +Create an in-memory object for NginxPublicIPAddress. + +## PARAMETERS + +### -Id + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.NginxPublicIPAddress + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/Remove-AzNginxCertificate.md b/azps-10.1.0/Az.Nginx/Remove-AzNginxCertificate.md new file mode 100644 index 0000000000..c8b988a45b --- /dev/null +++ b/azps-10.1.0/Az.Nginx/Remove-AzNginxCertificate.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.nginx/remove-aznginxcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Remove-AzNginxCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Remove-AzNginxCertificate.md +--- + +# Remove-AzNginxCertificate + +## SYNOPSIS +Deletes a certificate from the nginx deployment + +## SYNTAX + +### Delete (Default) +``` +Remove-AzNginxCertificate -DeploymentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzNginxCertificate -InputObject <INginxIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a certificate from the nginx deployment + +## EXAMPLES + +### Example 1: Remove a certificate of NGINX deployment by name +```powershell +Remove-AzNginxCertificate -DeploymentName nginx-test -Name cert -ResourceGroupName nginx-test-rg +``` + +This command removes a certificate of NGINX deployment by name + +### Example 2: Remove a certificate of NGINX deployment by object +```powershell +Get-AzNginxCertificate -DeploymentName nginx-test -Name cert -ResourceGroupName nginx-test-rg | Remove-AzNginxCertificate +``` + +This command remove a certificate of NGINX deployment by object + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The name of targeted Nginx deployment + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of certificate + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <INginxIdentity>`: Identity Parameter + - `[CertificateName <String>]`: The name of certificate + - `[ConfigurationName <String>]`: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf + - `[DeploymentName <String>]`: The name of targeted Nginx deployment + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/Remove-AzNginxConfiguration.md b/azps-10.1.0/Az.Nginx/Remove-AzNginxConfiguration.md new file mode 100644 index 0000000000..8dce1a2695 --- /dev/null +++ b/azps-10.1.0/Az.Nginx/Remove-AzNginxConfiguration.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.nginx/remove-aznginxconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Remove-AzNginxConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Remove-AzNginxConfiguration.md +--- + +# Remove-AzNginxConfiguration + +## SYNOPSIS +Reset the Nginx configuration of given Nginx deployment to default + +## SYNTAX + +### Delete (Default) +``` +Remove-AzNginxConfiguration -DeploymentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzNginxConfiguration -InputObject <INginxIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Reset the Nginx configuration of given Nginx deployment to default + +## EXAMPLES + +### Example 1: Remove a configuration of NGINX deployment by name +```powershell +Remove-AzNginxConfiguration -DeploymentName nginx-test -Name default -ResourceGroupName nginx-test-rg +``` + +This command removes a configuration of NGINX deployment by name + +### Example 2: Remove a configuration of NGINX deployment by object +```powershell +Get-AzNginxConfiguration -DeploymentName nginx-test -Name default -ResourceGroupName nginx-test-rg | Remove-AzNginxConfiguration +``` + +This command removes a configuration of NGINX deployment by object + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The name of targeted Nginx deployment + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of configuration, only 'default' is supported value due to the singleton of Nginx conf + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <INginxIdentity>`: Identity Parameter + - `[CertificateName <String>]`: The name of certificate + - `[ConfigurationName <String>]`: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf + - `[DeploymentName <String>]`: The name of targeted Nginx deployment + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/Remove-AzNginxDeployment.md b/azps-10.1.0/Az.Nginx/Remove-AzNginxDeployment.md new file mode 100644 index 0000000000..2d184e0796 --- /dev/null +++ b/azps-10.1.0/Az.Nginx/Remove-AzNginxDeployment.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.nginx/remove-aznginxdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Remove-AzNginxDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Remove-AzNginxDeployment.md +--- + +# Remove-AzNginxDeployment + +## SYNOPSIS +Delete the Nginx deployment resource + +## SYNTAX + +### Delete (Default) +``` +Remove-AzNginxDeployment -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzNginxDeployment -InputObject <INginxIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the Nginx deployment resource + +## EXAMPLES + +### Example 1: Remove a NGINX deployment by name +```powershell +Remove-AzNginxDeployment -Name nginx-test -ResourceGroupName nginx-test-rg +``` + +This command removes a deployment by name + +### Example 2: Remove a NGINX deployment by object +```powershell +Get-AzNginxDeployment -Name nginx-test -ResourceGroupName nginx-test-rg | Remove-AzNginxDeployment +``` + +This command removes a NGINX deployment by object + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of targeted Nginx deployment + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DeploymentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <INginxIdentity>`: Identity Parameter + - `[CertificateName <String>]`: The name of certificate + - `[ConfigurationName <String>]`: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf + - `[DeploymentName <String>]`: The name of targeted Nginx deployment + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Nginx/Update-AzNginxDeployment.md b/azps-10.1.0/Az.Nginx/Update-AzNginxDeployment.md new file mode 100644 index 0000000000..1c96375554 --- /dev/null +++ b/azps-10.1.0/Az.Nginx/Update-AzNginxDeployment.md @@ -0,0 +1,354 @@ +--- +external help file: +Module Name: Az.Nginx +online version: https://learn.microsoft.com/powershell/module/az.nginx/update-aznginxdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Update-AzNginxDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Nginx/help/Update-AzNginxDeployment.md +--- + +# Update-AzNginxDeployment + +## SYNOPSIS +Update the Nginx deployment + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzNginxDeployment -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-EnableDiagnosticsSupport] [-IdentityType <IdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] + [-Location <String>] [-SkuName <String>] [-StorageAccountContainerName <String>] + [-StorageAccountName <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzNginxDeployment -InputObject <INginxIdentity> [-EnableDiagnosticsSupport] + [-IdentityType <IdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] [-Location <String>] + [-SkuName <String>] [-StorageAccountContainerName <String>] [-StorageAccountName <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update the Nginx deployment + +## EXAMPLES + +### Example 1: Enable the diagnotics support for a NGINX deployment +```powershell +Update-AzNginxDeployment -Name nginx-test -ResourceGroupName nginx-test-rg -EnableDiagnosticsSupport +``` + +```output +Location Name +-------- ---- +westcentralus nginx-test +``` + +This command enables the diagnotics support for a NGINX deployment. + +### Example 2: Disable the diagnotics support for a NGINX deployment +```powershell +Update-AzNginxDeployment -Name nginx-test -ResourceGroupName nginx-test-rg -EnableDiagnosticsSupport:$false +``` + +```output +Location Name +-------- ---- +westcentralus nginx-test +``` + +This command disables the diagnotics support for a NGINX deployment. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDiagnosticsSupport +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Support.IdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +Dictionary of \<UserIdentityProperties\> + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of targeted Nginx deployment + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: DeploymentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +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 +``` + +### -StorageAccountContainerName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +. + +```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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Dictionary of \<string\> + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api20220801.INginxDeployment + +## 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 <INginxIdentity>`: Identity Parameter + - `[CertificateName <String>]`: The name of certificate + - `[ConfigurationName <String>]`: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf + - `[DeploymentName <String>]`: The name of targeted Nginx deployment + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.NotificationHubs/Az.NotificationHubs.md b/azps-10.1.0/Az.NotificationHubs/Az.NotificationHubs.md new file mode 100644 index 0000000000..0d43fc5846 --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Az.NotificationHubs.md @@ -0,0 +1,78 @@ +--- +Module Name: Az.NotificationHubs +Module Guid: f875725d-8ce4-423f-a6af-ea880bc63f13 +Download Help Link: https://learn.microsoft.com/powershell/module/az.notificationhubs +Help Version: 4.1.1.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Az.NotificationHubs.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Az.NotificationHubs.md +--- + +# Az.NotificationHubs Module +## Description +This topic displays help topics for the Azure Notification Hub cmdlets. Notification hubs are used to send push notifications to multiple clients regardless of the platform (iOS, Android, Windows Phone 8, Windows Store, etc.) used by those clients. These hubs are roughly equivalent to individual apps: each of your apps will typically have its own notification hub. Notification hubs are organized within logical containers known as namespaces, and Shared Access Signature (SAS) authorization rules are used to manage access to hubs and namespaces. All of these elements can be administered by using the Notification Hub cmdlets. + +## Az.NotificationHubs Cmdlets +### [Get-AzNotificationHub](Get-AzNotificationHub.md) +Gets information about your notification hubs. + +### [Get-AzNotificationHubAuthorizationRule](Get-AzNotificationHubAuthorizationRule.md) +Gets information about the authorization rules associated with a notification hub. + +### [Get-AzNotificationHubListKey](Get-AzNotificationHubListKey.md) +Gets the primary and secondary connection strings associated with a notification hub authorization rule. + +### [Get-AzNotificationHubPNSCredential](Get-AzNotificationHubPNSCredential.md) +Gets the PNS credentials for a notification hub. + +### [Get-AzNotificationHubsNamespace](Get-AzNotificationHubsNamespace.md) +Gets information about a notification hub namespace. + +### [Get-AzNotificationHubsNamespaceAuthorizationRule](Get-AzNotificationHubsNamespaceAuthorizationRule.md) +Gets information about the authorization rules associated with a notification hub namespace. + +### [Get-AzNotificationHubsNamespaceListKey](Get-AzNotificationHubsNamespaceListKey.md) +Gets the primary and secondary connection strings associated with a notification hub namespace authorization rule. + +### [New-AzNotificationHub](New-AzNotificationHub.md) +Creates a notification hub. + +### [New-AzNotificationHubAuthorizationRule](New-AzNotificationHubAuthorizationRule.md) +Creates an authorization rule and assigns the rule to a notification hub. + +### [New-AzNotificationHubKey](New-AzNotificationHubKey.md) +Regenerate the Authorization Rule Key for a NotificationHub . + +### [New-AzNotificationHubsNamespace](New-AzNotificationHubsNamespace.md) +Creates a notification hub namespace. + +### [New-AzNotificationHubsNamespaceAuthorizationRule](New-AzNotificationHubsNamespaceAuthorizationRule.md) +Creates an authorization rule and assigns that rule to a notification hub namespace. + +### [New-AzNotificationHubsNamespaceKey](New-AzNotificationHubsNamespaceKey.md) +Regenerate the Authorization Rule Key for a Namespace. + +### [Remove-AzNotificationHub](Remove-AzNotificationHub.md) +Removes an existing notification hub. + +### [Remove-AzNotificationHubAuthorizationRule](Remove-AzNotificationHubAuthorizationRule.md) +Removes an authorization rule from a notification hub. + +### [Remove-AzNotificationHubsNamespace](Remove-AzNotificationHubsNamespace.md) +Removes a notification hub namespace. + +### [Remove-AzNotificationHubsNamespaceAuthorizationRule](Remove-AzNotificationHubsNamespaceAuthorizationRule.md) +Removes an authorization rule from a notification hub namespace. + +### [Set-AzNotificationHub](Set-AzNotificationHub.md) +Sets property values for a notification hub. + +### [Set-AzNotificationHubAuthorizationRule](Set-AzNotificationHubAuthorizationRule.md) +Sets authorization rules for a notification hub. + +### [Set-AzNotificationHubsNamespace](Set-AzNotificationHubsNamespace.md) +Sets property values for a notification hub namespace. + +### [Set-AzNotificationHubsNamespaceAuthorizationRule](Set-AzNotificationHubsNamespaceAuthorizationRule.md) +Sets authorization rules for a notification hub namespace. + diff --git a/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHub.md b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHub.md new file mode 100644 index 0000000000..b8416c01d3 --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHub.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 796396B4-1F9D-4D53-AD2E-4CE83B563E93 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/get-aznotificationhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHub.md +--- + +# Get-AzNotificationHub + +## SYNOPSIS +Gets information about your notification hubs. + +## SYNTAX + +``` +Get-AzNotificationHub [-ResourceGroup] <String> [-Namespace] <String> [[-NotificationHub] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNotificationHub** cmdlet gets information about the notification hubs in a specified namespace and assigned to a specified resource group. +For example, you can get information for all the notification hubs in the namespace ContosoNamespace and assigned to the ContosoNotificationsGroup resource group. +Alternatively, you can use the *NotificationHub* parameter to limit the returned data to information about a specific notification hub. +Notification hubs are used to send push notifications to multiple clients regardless of the platform, such as iOS, Android, Windows Phone 8, and Windows Store, used by those clients. +These hubs are roughly equivalent to individual apps and each of your apps will typically have its own notification hub. +This cmdlet only gets information about the hub itself. +Other cmdlets, such as Get-AzNotificationHubAuthorizationRules, Get-AzNotificationHubListKeys, and Get-AzNotificationHubPNSCredentials, are needed to get information about a hub's authorization rules, connection strings, and platform notification service credentials. + +## EXAMPLES + +### Example 1: Get information for all notification hubs in a specific namespace +```powershell +Get-AzNotificationHub -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" +``` + +This command gets information for all the notification hubs in the namespace named ContosoNamespace that have been assigned to the resource group ContosoNotificationsGroup. + +### Example 2 + +Gets information about your notification hubs. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzNotificationHub -Namespace 'ContosoNamespace' -NotificationHub 'ContosoInternalHub' -ResourceGroup 'ContosoNotificationsGroup' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace to which the notification hub is assigned. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotificationHub +Specifies the name of the notification hub that this cmdlet gets. +Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the notification hub is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubAuthorizationRule](./Get-AzNotificationHubAuthorizationRule.md) + +[Get-AzNotificationHubListKey](./Get-AzNotificationHubListKey.md) + +[Get-AzNotificationHubPNSCredential](./Get-AzNotificationHubPNSCredential.md) + +[New-AzNotificationHub](./New-AzNotificationHub.md) + +[Remove-AzNotificationHub](./Remove-AzNotificationHub.md) + +[Set-AzNotificationHub](./Set-AzNotificationHub.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubAuthorizationRule.md b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubAuthorizationRule.md new file mode 100644 index 0000000000..8f6037b486 --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubAuthorizationRule.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 7A9D8F5A-6035-411B-8FDB-96ABFEED05A2 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/get-aznotificationhubauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHubAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHubAuthorizationRule.md +--- + +# Get-AzNotificationHubAuthorizationRule + +## SYNOPSIS +Gets information about the authorization rules associated with a notification hub. + +## SYNTAX + +``` +Get-AzNotificationHubAuthorizationRule [-ResourceGroup] <String> [-Namespace] <String> + [-NotificationHub] <String> [[-AuthorizationRule] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNotificationHubAuthorizationRule** cmdlet gets information about the Shared Access Signature (SAS) authorization rules associated with a notification hub. +The cmdlet returns information about all the rules associated with a hub or, by including the *AuthorizationRule* parameter, gets information about a specific rule. +Authorization rules manage access to your notification hubs. +An authorization rule will create links, as a URI, based on different permission levels. +Clients are directed to one of these URIs based on the appropriate permission level. +For instance, a client with the Listen permission will be directed to the URI for that permission. +The **Get-AzNotificationHubAuthorizationRule** cmdlet only gets information about the authorization rules associated with a notification hub. +To get information about the hub itself, use Get-AzNotificationHub. + +## EXAMPLES + +### Example 1: Get information for all authorization rules assigned to a notification hub +```powershell +Get-AzNotificationHubAuthorizationRule -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -NotificationHub "ContosoInternalHub" +``` + +This command gets information for all the authorization rules assigned to the notification hub named ContosoInternalHub in the namespace ContosoNamespace. +You must specify the namespace where the hub is located as well as the resource group that the hub has been assigned to. + +### Example 2: Get information for an authorization rules assigned to a notification hub +```powershell +Get-AzNotificationHubAuthorizationRule -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -NotificationHub "ContosoInternalHub" -AuthorizationRule "ListenRule" +``` + +This command gets information for all the authorization rules assigned to the notification hub named ContosoInternalHub in the namespace ContosoNamespace. +The command uses the *AuthorizationRule* parameter to limit the returned data to a single authorization rule named ListenRule. + +## PARAMETERS + +### -AuthorizationRule +Specifies the name of an SAS authentication rule. +These rules determine the type of access that users have to the notification hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace to which the notification hub is assigned. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotificationHub +Specifies the notification hub that this cmdlet assigns authorization rules. +Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the notification hub is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simplify inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubsNamespaceAuthorizationRule](./Get-AzNotificationHubsNamespaceAuthorizationRule.md) + +[New-AzNotificationHubAuthorizationRule](./New-AzNotificationHubAuthorizationRule.md) + +[Remove-AzNotificationHubAuthorizationRule](./Remove-AzNotificationHubAuthorizationRule.md) + +[Set-AzNotificationHubAuthorizationRule](./Set-AzNotificationHubAuthorizationRule.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubListKey.md b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubListKey.md new file mode 100644 index 0000000000..c66089bb67 --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubListKey.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 326C87EB-EC3B-4B04-B593-EAC56FFA854A +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/get-aznotificationhublistkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHubListKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHubListKey.md +--- + +# Get-AzNotificationHubListKey + +## SYNOPSIS +Gets the primary and secondary connection strings associated with a notification hub authorization rule. + +## SYNTAX + +``` +Get-AzNotificationHubListKey [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> + [-AuthorizationRule] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNotificationHubListKey** cmdlet returns the primary and secondary connection strings of a notification hub Shared Access Signature (SAS) authorization rule. +Authorization rules manage user rights to the hub. +Each rule includes a primary and a secondary connection string. +These connection strings (URIs) perform the following: +- Point users to a resource. +- Include a token containing query parameters. +One of these parameters, the signature, is used to authenticate the user and provide the specified level of access. + +## EXAMPLES + +### Example 1: Get the primary and secondary connection strings for an authorization rule +```powershell +Get-AzNotificationHubListKey -Namespace "ContosoNamespace" -NotificationHub "ContosoInternalHub" -ResourceGroup "ContosoNotificationsGroup" -AuthorizationRule "ListenRule" +``` + +This command gets the primary and secondary connection strings for the authorization rule ListenRule, a rule assigned to the ContosoInternalHub notification hub. +The command must include the hub namespace and resource group. + +## PARAMETERS + +### -AuthorizationRule +Specifies the name of a Shared Access Signature (SAS) authentication rule. +These rules determine the type of access that users have to the notification hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace to which the notification hub is assigned. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotificationHub +Specifies the notification hub that this cmdlet assigns an authorization rule to. +Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the notification hub is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.NotificationHubs.Models.ResourceListKeys + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubAuthorizationRule](./Get-AzNotificationHubAuthorizationRule.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubPNSCredential.md b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubPNSCredential.md new file mode 100644 index 0000000000..71c2c1e917 --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubPNSCredential.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 2CCDF339-9D6E-4B0C-9201-BE641C8827F6 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/get-aznotificationhubpnscredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHubPNSCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHubPNSCredential.md +--- + +# Get-AzNotificationHubPNSCredential + +## SYNOPSIS +Gets the PNS credentials for a notification hub. + +## SYNTAX + +``` +Get-AzNotificationHubPNSCredential [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNotificationHubPNSCredential** cmdlet gets the platform notification service (PNS) credentials for a notification hub. +Each notification hub has a single set of PNS credentials. +These credentials are applied to individual push notification services such as, but not limited to; the iOS push notification service, the Android push notification service, and Windows Phone 8. + +## EXAMPLES + +### Example 1: Get PNS credentials for a specific notification hub +```powershell +Get-AzNotificationHubPNSCredential -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -NotificationHub "ContosoInternalHub" +``` + +This command gets the PNS credentials for the notification hub named ContosoInternalHub that belongs to the resource group named ContosoNotificationsGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace to which the notification hub is assigned. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotificationHub +Specifies the notification hub that the PNS credentials are assigned to. +Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the notification hub is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHub](./Get-AzNotificationHub.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubsNamespace.md b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubsNamespace.md new file mode 100644 index 0000000000..bbda4566e4 --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubsNamespace.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 9805B3F1-C6BB-4A0F-A7C3-1DD1ACB75CDA +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/get-aznotificationhubsnamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHubsNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHubsNamespace.md +--- + +# Get-AzNotificationHubsNamespace + +## SYNOPSIS +Gets information about a notification hub namespace. + +## SYNTAX + +``` +Get-AzNotificationHubsNamespace [[-ResourceGroup] <String>] [[-Namespace] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +**The Get-AzNotificationHubsNamespace** cmdlet gets information about notification hub namespaces. +This cmdlet provides you the option of getting information for all your namespaces, information about the namespaces assigned to a specified resource group; or for returning information about a specific namespace. +Namespaces are logical containers that help you organize and manage your notification hubs. +You must have at least one notification hub namespace: all notification hubs must be assigned to a namespace. +A single namespace can house multiple hubs which means that you might only need one namespace in your organization. +However, you can also have multiple namespaces to better organize your hubs, or to give specific individuals permission to manage a selected subset of hubs. +The **Get-AzNotificationHubsNamespace** cmdlet returns basic information about the namespace itself. +To get information about the authorization rules associated with a namespace use Get-AzNotificationHubsNamespaceAuthorizationRules. + +## EXAMPLES + +### Example 1: Get information for all notification hub namespaces +```powershell +Get-AzNotificationHubsNamespace +``` + +This command returns information for all your notification hub namespaces. + +### Example 2: Get information for a single notification hub namespace +```powershell +Get-AzNotificationHubsNamespace -Namespace "ContosoNamespace" +``` + +This command gets information for a single notification hub namespace: ContosoNamespace. + +### Example 3: Get information for all notification hubs assigned to a specific namespace +```powershell +Get-AzNotificationHubsNamespace -ResourceGroup "ContosoNotificationsGroup" +``` + +This command gets information for all notification hub namespaces assigned to the resource group ContosoNotificationsGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies a unique name for the namespace. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the namespace is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NotificationHubs.Models.NamespaceAttributes + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubsNamespaceAuthorizationRule](./Get-AzNotificationHubsNamespaceAuthorizationRule.md) + +[New-AzNotificationHubsNamespace](./New-AzNotificationHubsNamespace.md) + +[Remove-AzNotificationHubsNamespace](./Remove-AzNotificationHubsNamespace.md) + +[Set-AzNotificationHubsNamespace](./Set-AzNotificationHubsNamespace.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubsNamespaceAuthorizationRule.md b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubsNamespaceAuthorizationRule.md new file mode 100644 index 0000000000..3c084e5847 --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubsNamespaceAuthorizationRule.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 08D03498-D18D-47FE-8916-702FA2E7D719 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/get-aznotificationhubsnamespaceauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHubsNamespaceAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHubsNamespaceAuthorizationRule.md +--- + +# Get-AzNotificationHubsNamespaceAuthorizationRule + +## SYNOPSIS +Gets information about the authorization rules associated with a notification hub namespace. + +## SYNTAX + +``` +Get-AzNotificationHubsNamespaceAuthorizationRule [-ResourceGroup] <String> [-Namespace] <String> + [[-AuthorizationRule] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNotificationHubsNamespaceAuthorizationRule** cmdlet returns information about the Shared Access Signature (SAS) authorization rules associated with a notification hub namespace. +You can return information about all the rules associated with the namespace. +Alternatively, and by including the *AuthorizationRule* parameter, you can return information for a specific rule. +Authorization rules manage access to namespaces. +This is done through the creation of links, as URIs, based on different permission levels. +Platform levels can be one of the following: +- Listen +- Send +- Manage +Clients are directed to one of these URIs based on the appropriate permission level. +For instance, a client given the Listen permission will be directed to the URI for that permission. +This cmdlet only gets the authorization rules associated with a namespace. +To get information about the namespace itself, use Get-AzNotificationHubsNamespace. + +## EXAMPLES + +### Example 1: Get information about all authorization rules assigned to namespaces +```powershell +Get-AzNotificationHubsNamespaceAuthorizationRule -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" +``` + +This command gets information about all the authorization rules assigned to both the namespace ContosoNamespace and the ContosoNotificationsGroup resource group. + +### Example 2: Get information about an authorization rule +```powershell +Get-AzNotificationHubsNamespaceAuthorizationRule -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -AuthorizationRule "ListenRule" +``` + +This command gets information about a single namespace authorization rule named ListenRule. +You must include the namespace and the resource group when you get information for a specific authorization rule. + +## PARAMETERS + +### -AuthorizationRule +Specifies the name of a SAS authentication rule. +These rules determine the type of access that users have to the namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace to which the authorization rules are assigned. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the authorization rules are assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubsNamespace](./Get-AzNotificationHubsNamespace.md) + +[New-AzNotificationHubsNamespace](./New-AzNotificationHubsNamespace.md) + +[Remove-AzNotificationHubsNamespace](./Remove-AzNotificationHubsNamespace.md) + +[Set-AzNotificationHubsNamespace](./Set-AzNotificationHubsNamespace.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubsNamespaceListKey.md b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubsNamespaceListKey.md new file mode 100644 index 0000000000..9983626247 --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Get-AzNotificationHubsNamespaceListKey.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: F769A8AB-E025-49EE-AEA4-0D27EAEE341F +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/get-aznotificationhubsnamespacelistkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHubsNamespaceListKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Get-AzNotificationHubsNamespaceListKey.md +--- + +# Get-AzNotificationHubsNamespaceListKey + +## SYNOPSIS +Gets the primary and secondary connection strings associated with a notification hub namespace authorization rule. + +## SYNTAX + +``` +Get-AzNotificationHubsNamespaceListKey [-ResourceGroup] <String> [-Namespace] <String> + [-AuthorizationRule] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzNotificationHubsNamespaceListKey** cmdlet returns the primary and secondary connection strings for a Shared Access Signature (SAS) authorization rule assigned to a notification hub namespace. +Authorization rules manage user rights to a notification hub namespace. +Each rule includes a primary and a secondary connection string. + +## EXAMPLES + +### Example 1: Get the primary and secondary connection strings for an authorization rule +```powershell +Get-AzNotificationHubsNamespaceListKey -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -AuthorizationRule "ListenRule" +``` + +This command returns the primary and secondary connection strings for the authorization rule named ListenRule assigned to the ContosoNamespace namespace. +When you run this command you must include the name of the resource group that the namespace is assigned to. + +## PARAMETERS + +### -AuthorizationRule +Specifies the name of a SAS authentication rule. +These rules determine the type of access that users have to the notification hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace containing the connection strings that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the namespace is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.NotificationHubs.Models.ResourceListKeys + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubsNamespace](./Get-AzNotificationHubsNamespace.md) + +[Get-AzNotificationHubsNamespaceAuthorizationRule](./Get-AzNotificationHubsNamespaceAuthorizationRule.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHub.md b/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHub.md new file mode 100644 index 0000000000..920dc27744 --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHub.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 8EDDA991-55B6-4151-8619-E13E14599ECD +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/new-aznotificationhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/New-AzNotificationHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/New-AzNotificationHub.md +--- + +# New-AzNotificationHub + +## SYNOPSIS +Creates a notification hub. + +## SYNTAX + +### InputFileParameterSet +``` +New-AzNotificationHub [-ResourceGroup] <String> [-Namespace] <String> [-InputFile] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NotificationHubParameterSet +``` +New-AzNotificationHub [-ResourceGroup] <String> [-Namespace] <String> + [-NotificationHubObj] <NotificationHubAttributes> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNotificationHub** cmdlet creates a notification hub. +Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. +Notification hubs are roughly equivalent to individual apps: each of your apps will typically have its own notification hub. +The **New-AzNotificationHub** cmdlet provides two ways to create a new notification hub. +You can create an instance of the **NotificationHubAttributes** object and then configure that object. +You can then copy those property values to your new hub by through the *NotificationHubObj* parameter. +Alternatively, you can create a JSON (JavaScript Object Notation) file containing the relevant configuration values and then apply those values by using the *InputFile* parameter. +When used in conjunction with the **New-AzNotificationHub** cmdlet, the preceding JSON sample creates a notification hub named ContosoNotificationHub located on the West US datacenter. + +## EXAMPLES + +### Example 1: Create a notification hub +```powershell +New-AzNotificationHub -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -InputFile "C:\Configurations\InternalHub.json" +``` + +This command creates a notification hub in the namespace ContosoNamespace. +The new hub will be assigned to the ContosoNotificationsGroup. +You do not need to specify a name or any other configuration information for the hub; that information will be taken from the input file C:\Configurations\InternalHub.json. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +Specifies the path to a JSON file containing configuration values for the new notification hub. + +```yaml +Type: System.String +Parameter Sets: InputFileParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace to which the notification hub will be assigned. +Namespaces provide a way to group and categorize notification hubs. +Notification hubs must be assigned to an existing namespace. +The **New-AzNotificationHub** cmdlet cannot create a new namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotificationHubObj +Specifies the **NotificationHubAttributes** object that contains configuration information for the new hub. + +```yaml +Type: Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes +Parameter Sets: NotificationHubParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the notification hub will be assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. +You must use an existing resource group. +The **New-AzNotificationHub** cmdlet cannot create a new resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHub](./Get-AzNotificationHub.md) + +[Remove-AzNotificationHub](./Remove-AzNotificationHub.md) + +[Set-AzNotificationHub](./Set-AzNotificationHub.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubAuthorizationRule.md b/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubAuthorizationRule.md new file mode 100644 index 0000000000..b849ea5437 --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubAuthorizationRule.md @@ -0,0 +1,197 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 7E9CBEE9-DD5F-4552-9187-ECBBEF6174B0 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/new-aznotificationhubauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/New-AzNotificationHubAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/New-AzNotificationHubAuthorizationRule.md +--- + +# New-AzNotificationHubAuthorizationRule + +## SYNOPSIS +Creates an authorization rule and assigns the rule to a notification hub. + +## SYNTAX + +### InputFileParameterSet +``` +New-AzNotificationHubAuthorizationRule [-ResourceGroup] <String> [-Namespace] <String> + [-NotificationHub] <String> [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SASRuleParameterSet +``` +New-AzNotificationHubAuthorizationRule [-ResourceGroup] <String> [-Namespace] <String> + [-NotificationHub] <String> [-SASRule] <SharedAccessAuthorizationRuleAttributes> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNotificationHubAuthorizationRule** cmdlet creates a notification hub Shared Access Signature (SAS) authorization rule. +Authorization rules are used to manage access to your notification hubs. +This is done by the creation of links, as URIs, based on different permission levels. +Clients are directed to one of these URIs based on the appropriate permission level. +For example, a client given the Listen permission will be directed to the URI for that permission. + +## EXAMPLES + +### Example 1: Create a notification hub authorization rule +```powershell +New-AzNotificationHubAuthorizationRule -Namespace "ContosoNamespace" -NotificationHub "ContosoInternalHub" -ResourceGroup "ContosoNotificationsGroup" -InputFile "C:\Configuration\ExternalAccessRule.json" +``` + +This command creates a new authorization rule and assigns it to the notification hub named ContosoInternalHub. +This hub is located in the ContosoNamespace namespace and is assigned to the ContosoNotificationsGroup resource group. +Note that all the configuration information for the rule, including the rule name, will be taken from the input file C:\Configuration\ExternalAccessRule.json. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +Specifies the input file for the authorization rule that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: InputFileParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace to which the authorization rules are assigned. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotificationHub +Specifies the notification hub that the authorization rules will be assigned to. +Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. +Note that you must specify the name of an existing notification hub. +The **New-AzNotificationHubAuthorizationRule** cmdlet cannot create new notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group that the notification hub is assigned to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SASRule +Specifies the **SharedAccessAuthorizationRuleAttributes** object containing configuration information for the new rules. + +```yaml +Type: Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes +Parameter Sets: SASRuleParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubAuthorizationRule](./Get-AzNotificationHubAuthorizationRule.md) + +[Remove-AzNotificationHubAuthorizationRule](./Remove-AzNotificationHubAuthorizationRule.md) + +[Set-AzNotificationHubAuthorizationRule](./Set-AzNotificationHubAuthorizationRule.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubKey.md b/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubKey.md new file mode 100644 index 0000000000..6f34ada49b --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubKey.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: A03F32C3-BB01-46A5-86C5-B7A4DDC42351 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/new-aznotificationhubkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/New-AzNotificationHubKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/New-AzNotificationHubKey.md +--- + +# New-AzNotificationHubKey + +## SYNOPSIS +Regenerate the Authorization Rule Key for a NotificationHub . + +## SYNTAX + +``` +New-AzNotificationHubKey [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> + [[-AuthorizationRule] <String>] [-PolicyKey] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +New-AzNotificationHubKey cmdlet regenerates the Primary Key/Secondary Key for the NotificationHub Authorization Rule. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNotificationHubKey -ResourceGroup "ContosoNotificationsGroup" -Namespace "ContosoNamespace" -NotificationHub "ContosoInternalHub" -AuthorizationRule "DefaultListenSharedAccessSignature" -PolicyKey "PrimaryKey" +``` + +```Output +PrimaryConnectionString : Endpoint=sb://contosonamespace.servicebus.windows.net/;SharedAccessKeyName=DefaultListenShare + dAccessSignature;SharedAccessKey=VUhKcGJXRnllVU52Ym01bFkzUnBiMjVUZEhKcGJtYz0= +SecondaryConnectionString : Endpoint=sb://contosonamespace.servicebus.windows.net/;SharedAccessKeyName=DefaultListenShare + dAccessSignature;SharedAccessKey=VTJWamIyNWtZWEo1UTI5dWJtVmpkR2x2YmxOMGNtbHV= +PrimaryKey : VUhKcGJXRnllVU52Ym01bFkzUnBiMjVUZEhKcGJtYz0= +SecondaryKey : VTJWamIyNWtZWEo1UTI5dWJtVmpkR2x2YmxOMGNtbHV= +KeyName : DefaultListenSharedAccessSignature +``` + +## PARAMETERS + +### -AuthorizationRule +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotificationHub +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyKey +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: PrimaryKey, SecondaryKey + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.NotificationHubs.Models.ResourceListKeys + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubsNamespace.md b/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubsNamespace.md new file mode 100644 index 0000000000..837fc1df8a --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubsNamespace.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 3BA94976-DE88-4F07-9C06-41FEEDE1B829 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/new-aznotificationhubsnamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/New-AzNotificationHubsNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/New-AzNotificationHubsNamespace.md +--- + +# New-AzNotificationHubsNamespace + +## SYNOPSIS +Creates a notification hub namespace. + +## SYNTAX + +``` +New-AzNotificationHubsNamespace [-ResourceGroup] <String> [-Namespace] <String> [-Location] <String> + [[-Tag] <Hashtable>] [[-SkuTier] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNotificationHubsNamespace** cmdlet creates a notification hub namespace. +Namespaces are logical containers that help you organize and manage your notification hubs. +You must have at least one notification hub namespace. +A single namespace can house multiple hubs. +You can have multiple namespaces to organize your hubs, or to give specific individuals permission to manage a selected subset of your hubs. +To create a namespace, make sure that you specify a unique name for the namespace; specify the datacenter where the namespace will be located; and, specify the resource group that the namespace will be assigned to. +After the namespace has been created you can use the New-AzNotificationHubsNamespaceAuthorizationRules cmdlet to assign authorization rules to that namespace. +Authorization rules are used to manage permissions to the namespace. + +## EXAMPLES + +### Example 1: Create a notification hub +```powershell +New-AzNotificationHubsNamespace -ResourceGroup "ContosoNotificationsGroup" -Location "West US" -Namespace "ContosoPartners" +``` + +This command creates a notification hub named ContosoPartners. +The namespace will be located in the West US datacenter and be assigned to the ContosoNotificationsGroup resource group. + +### Example 2: Create a notification hub with tags +```powershell +New-AzNotificationHubsNamespace -ResourceGroup "ContosoNotificationsGroup" -Location "West US" -Namespace "ContosoPartners" -Tag @{Name="Audience";Value="PartnerOrganizations"} +``` + +This command creates a notification hub named ContosoPartners. +The namespace will be located in the West US datacenter and be assigned to the ContosoNotificationsGroup resource group. +In addition, this command creates a tag with the name Audience and the value PartnerOrganizations and is assigned to the namespace. +This ensures that the namespace will be displayed any time you filter for items where the Audience tag is set to PartnerOrganizations. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the display name of the datacenter that will host the Namespace. +Although you can set this parameter to any valid location, for optimal performance you might want to use a datacenter located near the majority of your users. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Namespace +Specifies the name of the new namespace. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the namespace will be assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuTier +Sku tier of the namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specifies name-value pairs that can be used to categorize and organize Azure items. +Tags function similar to keywords, and operate across a deployment. +For example, if you search for all items with the tag Department:IT the search will return all the Azure items that have that tag, regardless of such things as item type, location, or resource group. +An individual tag consists of two parts: the *Name* and, optionally, the *Value*. +For instance, in Department:IT, the tag name is Department and the tag value is IT. +To add a tag, use hash table syntax similar to this, which creates the tag CalendarYear:2016: + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.NotificationHubs.Models.NamespaceAttributes + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubsNamespace](./Get-AzNotificationHubsNamespace.md) + +[Remove-AzNotificationHubsNamespace](./Remove-AzNotificationHubsNamespace.md) + +[Set-AzNotificationHubsNamespace](./Set-AzNotificationHubsNamespace.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubsNamespaceAuthorizationRule.md b/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubsNamespaceAuthorizationRule.md new file mode 100644 index 0000000000..736cc2fccb --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubsNamespaceAuthorizationRule.md @@ -0,0 +1,197 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 3F59F7E8-CD32-40CB-9DE0-3FB044439DD0 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/new-aznotificationhubsnamespaceauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/New-AzNotificationHubsNamespaceAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/New-AzNotificationHubsNamespaceAuthorizationRule.md +--- + +# New-AzNotificationHubsNamespaceAuthorizationRule + +## SYNOPSIS +Creates an authorization rule and assigns that rule to a notification hub namespace. + +## SYNTAX + +### InputFileParameterSet +``` +New-AzNotificationHubsNamespaceAuthorizationRule [-ResourceGroup] <String> [-Namespace] <String> + [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SASRuleParameterSet +``` +New-AzNotificationHubsNamespaceAuthorizationRule [-ResourceGroup] <String> [-Namespace] <String> + [-SASRule] <SharedAccessAuthorizationRuleAttributes> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzNotificationHubsNamespaceAuthorizationRule** cmdlet creates a Shared Access Signature (SAS) authorization rule and assigns it to a notification hub namespace. +Authorization rules manage user rights to the namespace and to the notification hubs contained with that namespace. +This cmdlet provides two ways to create a new authorization rule and assign it to a namespace. +You can create an instance of the **SharedAccessAuthorizationRuleAttributes** object and then configure that object with the property values you want the new rule to possess. +This can be done using .NET Framework. +You can then copy those property values to your new rule by using *SASRule* parameter. +Alternatively, you can create a JSON (JavaScript Object Notation) file containing the relevant configuration values and then apply those values by using the *InputFile* parameter. +A JSON file is a text file that uses syntax similar to the following: +{ + "Name": "ContosoAuthorizationRule", + "PrimaryKey": "WE4qH0398AyXjlekt56gg1gMR3NHoMs29KkUnnpUk01Y=", + "Rights": \[ + "Listen", + "Send" + \] +} +When used in conjunction with the **New-AzNotificationHubsNamespaceAuthorizationRule** cmdlet, the preceding JSON sample creates an authorization rule named ContosoAuthorizationRule that gives users Listen and Send rights to the namespace. +The *PrimaryKey* that is used for authentication, can be randomly generated by using the following Windows PowerShell command: +\[Convert\]::ToBase64String((1..32 |% { \[byte/](Get-Random -Minimum 0 -Maximum 255) })) + +## EXAMPLES + +### Example 1: Create an authorization rule and assign it to a namespace +```powershell +New-AzNotificationHubAuthorizationRule -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -InputFile "C:\Configuration\NamespaceAuthorizationRules.json" +``` + +This command creates an authorization rule and assigns that rule to the namespace ContosoNamespace. +When creating this rule you must specify the appropriate namespace and the resource group that the namespace is assigned to. +However, you do not need to specify any information about the rule itself: rule information will be taken from the input file C:\Configuration\NamespaceAuthorizationRules.json. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +Specifies the path to a JSON file containing configuration information for the new authorization rule. + +```yaml +Type: System.String +Parameter Sets: InputFileParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace to which the authorization rules will be assigned. +Namespaces provide a way to group and categorize notification hubs. +The new rules must be assigned to an existing namespace. +The **New-AzNotificationHubsNamespaceAuthorizationRule** cmdlet cannot create a new namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the namespace is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. +You must use an existing resource group. +This cmdlet cannot create a new resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SASRule +Specifies the **SharedAccessAuthorizationRuleAttributes** object containing configuration information for the new rules. + +```yaml +Type: Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes +Parameter Sets: SASRuleParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubAuthorizationRule](./Get-AzNotificationHubAuthorizationRule.md) + +[Remove-AzNotificationHubAuthorizationRule](./Remove-AzNotificationHubAuthorizationRule.md) + +[Set-AzNotificationHubAuthorizationRule](./Set-AzNotificationHubAuthorizationRule.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubsNamespaceKey.md b/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubsNamespaceKey.md new file mode 100644 index 0000000000..ca496960bb --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/New-AzNotificationHubsNamespaceKey.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 1EC19069-B64C-4F0F-99A3-07C16E46C0A0 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/new-aznotificationhubsnamespacekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/New-AzNotificationHubsNamespaceKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/New-AzNotificationHubsNamespaceKey.md +--- + +# New-AzNotificationHubsNamespaceKey + +## SYNOPSIS +Regenerate the Authorization Rule Key for a Namespace. + +## SYNTAX + +``` +New-AzNotificationHubsNamespaceKey [-ResourceGroup] <String> [-Namespace] <String> + [[-AuthorizationRule] <String>] [-PolicyKey] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +New-AzNotificationHubsNamespaceKey cmdlet regenerates the Primary Key/Secondary Key for the Namespace Authorization Rule. + +## EXAMPLES + +### Example 1 +```powershell +New-AzNotificationHubsNamespaceKey -ResourceGroup "ContosoNotificationsGroup" -Namespace "ContosoNamespace" -AuthorizationRule "RootManageSharedAccessKey" -PolicyKey "PrimaryKey" +``` + +```Output +PrimaryConnectionString : Endpoint=sb://contosonamespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAc + cessKey;SharedAccessKey=VUhKcGJXRnllVU52Ym01bFkzUnBiMjVUZEhKcGJtYz0= +SecondaryConnectionString : Endpoint=sb://contosonamespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAc + cessKey;SharedAccessKey=VTJWamIyNWtZWEo1UTI5dWJtVmpkR2x2YmxOMGNtbHV= +PrimaryKey : VUhKcGJXRnllVU52Ym01bFkzUnBiMjVUZEhKcGJtYz0= +SecondaryKey : VTJWamIyNWtZWEo1UTI5dWJtVmpkR2x2YmxOMGNtbHV= +KeyName : RootManageSharedAccessKey +``` + +## PARAMETERS + +### -AuthorizationRule +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyKey +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: PrimaryKey, SecondaryKey + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.NotificationHubs.Models.ResourceListKeys + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.NotificationHubs/Remove-AzNotificationHub.md b/azps-10.1.0/Az.NotificationHubs/Remove-AzNotificationHub.md new file mode 100644 index 0000000000..dd612faf8f --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Remove-AzNotificationHub.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 62631E1C-FB43-4E87-82C2-159A9D1D4221 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/remove-aznotificationhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Remove-AzNotificationHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Remove-AzNotificationHub.md +--- + +# Remove-AzNotificationHub + +## SYNOPSIS +Removes an existing notification hub. + +## SYNTAX + +``` +Remove-AzNotificationHub [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNotificationHub** cmdlet removes an existing notification hub. +Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. +Platforms include, but are not limited to: iOS, Android, Windows Phone 8, and Windows Store. +Notification hubs are roughly equivalent to individual apps: each of your apps will typically have its own notification hub. +You can remove an existing notification hub by using the **Remove-AzNotificationHub** cmdlet. +After a hub has been removed you can no longer use that hub to send push notifications to users. + +## EXAMPLES + +### Example 1: Remove a notification hub +```powershell +Remove-AzNotificationHub -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -NotificationHub "ContosoInternalHub" +``` + +This command removes the notification hub named ContosoInternalHub. +In order to remove the hub, you must specify the namespace where the hub is located as well as the resource group the hub is assigned to. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace to which the notification hub is assigned. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotificationHub +Specifies the notification hub to be removed. +Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the notification hub is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHub](./Get-AzNotificationHub.md) + +[New-AzNotificationHub](./New-AzNotificationHub.md) + +[Set-AzNotificationHub](./Set-AzNotificationHub.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/Remove-AzNotificationHubAuthorizationRule.md b/azps-10.1.0/Az.NotificationHubs/Remove-AzNotificationHubAuthorizationRule.md new file mode 100644 index 0000000000..157e96ebbf --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Remove-AzNotificationHubAuthorizationRule.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 715F8821-BBD1-440A-AD54-E960939E288A +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/remove-aznotificationhubauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Remove-AzNotificationHubAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Remove-AzNotificationHubAuthorizationRule.md +--- + +# Remove-AzNotificationHubAuthorizationRule + +## SYNOPSIS +Removes an authorization rule from a notification hub. + +## SYNTAX + +``` +Remove-AzNotificationHubAuthorizationRule [-ResourceGroup] <String> [-Namespace] <String> + [-NotificationHub] <String> [-AuthorizationRule] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNotificationHubAuthorizationRule** cmdlet removes a Shared Access Signature (SAS) authorization rule from a notification hub. +Authorization rules manage access to your notification hubs through the creation of links, as URIs, based on different permission levels. +Permission levels can be one of the following: +- Listen +- Send +- Manage +Clients are directed to one of these URIs based on the appropriate permission level. +For instance, a client given the Listen permission will be directed to the URI for that permission. +Removing an authorization rule also removes the corresponding user permission. + +## EXAMPLES + +### Example 1: Remove an authorization rule from a notification hub +```powershell +Remove-AzNotificationHubAuthorizationRule -Namespace "ContosoNamespace" -NotificationHub "ContosoExternalHub" -ResourceGroup "ContosoNotificationsGroup" -AuthorizationRule "ListenRule" +``` + +This command removes the authorization rule named ListenRule from the notification hub named ContosoExternalHub. +When you run this command you must specify both the namespace and the resource group that the hub is assigned to. + +## PARAMETERS + +### -AuthorizationRule +Specifies the name of the SAS authentication rule that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace to which the notification hub is assigned. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotificationHub +Specifies the notification hub the authorization rules are assigned to. +Notification hubs are used to send push notifications to multiple clients regardless of the platform. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the notification hub is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubAuthorizationRule](./Get-AzNotificationHubAuthorizationRule.md) + +[New-AzNotificationHubAuthorizationRule](./New-AzNotificationHubAuthorizationRule.md) + +[Set-AzNotificationHubAuthorizationRule](./Set-AzNotificationHubAuthorizationRule.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/Remove-AzNotificationHubsNamespace.md b/azps-10.1.0/Az.NotificationHubs/Remove-AzNotificationHubsNamespace.md new file mode 100644 index 0000000000..b7223db71c --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Remove-AzNotificationHubsNamespace.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 5EDFBF19-928F-4F95-BD93-CF8BAEA11C52 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/remove-aznotificationhubsnamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Remove-AzNotificationHubsNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Remove-AzNotificationHubsNamespace.md +--- + +# Remove-AzNotificationHubsNamespace + +## SYNOPSIS +Removes a notification hub namespace. + +## SYNTAX + +``` +Remove-AzNotificationHubsNamespace [-ResourceGroup] <String> [-Namespace] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNotificationHubsNamespace** cmdlet removes a notification hub namespace from your deployment. +Namespaces are logical containers that help you organize and manage your notification hubs. +The **Remove-AzNotificationHubsNamespace** cmdlet removes a notification hub namespace from your deployment. +When you run this cmdlet, the specified namespace will be deleted along with all the notification hubs associated with that namespace. + +## EXAMPLES + +### Example 1: Remove a notification hub namespace +```powershell +Remove-AzNotificationHubsNamespace -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" +``` + +This command removes the namespace named ContosoNamespace. +You must specify the resource group the namespace is assigned to. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace that this cmdlet removes. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the namespace is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubsNamespace](./Get-AzNotificationHubsNamespace.md) + +[New-AzNotificationHubsNamespace](./New-AzNotificationHubsNamespace.md) + +[Set-AzNotificationHubsNamespace](./Set-AzNotificationHubsNamespace.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/Remove-AzNotificationHubsNamespaceAuthorizationRule.md b/azps-10.1.0/Az.NotificationHubs/Remove-AzNotificationHubsNamespaceAuthorizationRule.md new file mode 100644 index 0000000000..7a1f1135f7 --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Remove-AzNotificationHubsNamespaceAuthorizationRule.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 860AB403-3F99-45FA-8E6A-8C9872C121E8 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/remove-aznotificationhubsnamespaceauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Remove-AzNotificationHubsNamespaceAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Remove-AzNotificationHubsNamespaceAuthorizationRule.md +--- + +# Remove-AzNotificationHubsNamespaceAuthorizationRule + +## SYNOPSIS +Removes an authorization rule from a notification hub namespace. + +## SYNTAX + +``` +Remove-AzNotificationHubsNamespaceAuthorizationRule [-ResourceGroup] <String> [-Namespace] <String> + [-AuthorizationRule] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzNotificationHubsNamespaceAuthorizationRule** cmdlet removes a Shared Access Signature (SAS) authorization rule from a notification hub namespace. +Authorization rules manage access to a namespace. +This is done by through the creation of links, as URIs, based on different permission levels. +Permission levels can be of the following: +- Listen +- Send +- Manage +Clients are directed to one of these URIs based on the appropriate permission level. +For instance, a client given the Listen permission is directed to the URI for that permission. +Removing an authorization rule also removes the corresponding user permission. + +## EXAMPLES + +### Example 1: Remove an authorization rule from a namespace +```powershell +Remove-AzNotificationHubsNamespaceAuthorizationRule -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -AuthorizationRule "ListenRule" +``` + +This command removes the authorization rule named ListenRule from the namespace named ContosoNamespace. +When you run this command you must specify the resource group that the namespace is assigned to. + +## PARAMETERS + +### -AuthorizationRule +Specifies the name of the SAS authentication rule to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace to which the authorization rules are assigned. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the namespace is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubsNamespaceAuthorizationRule](./Get-AzNotificationHubsNamespaceAuthorizationRule.md) + +[New-AzNotificationHubsNamespaceAuthorizationRule](./New-AzNotificationHubsNamespaceAuthorizationRule.md) + +[Set-AzNotificationHubsNamespaceAuthorizationRule](./Set-AzNotificationHubsNamespaceAuthorizationRule.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/Set-AzNotificationHub.md b/azps-10.1.0/Az.NotificationHubs/Set-AzNotificationHub.md new file mode 100644 index 0000000000..87fac283ff --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Set-AzNotificationHub.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: F7BBEF57-0DC2-4EFF-9AA2-119B3BD19AE6 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/set-aznotificationhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Set-AzNotificationHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Set-AzNotificationHub.md +--- + +# Set-AzNotificationHub + +## SYNOPSIS +Sets property values for a notification hub. + +## SYNTAX + +### InputFileParameterSet +``` +Set-AzNotificationHub [-ResourceGroup] <String> [-Namespace] <String> [-InputFile] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NotificationHubParameterSet +``` +Set-AzNotificationHub [-ResourceGroup] <String> [-Namespace] <String> + [-NotificationHubObj] <NotificationHubAttributes> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNotificationHub** cmdlet modifies the property values of a notification hub. +You can modify a notification hub property value in two ways. +For one, you can create an instance of the **NotificationHubAttributes** object and then configure that object with the property values you want the new hub to possess. +This can be done through the .NET Framework. +You can then copy those property values to your hub by through the *NotificationHubObj* parameter. +Alternatively, you can create a JSON (JavaScript Object Notation) file that contains the relevant configuration values, then apply those values by through the *InputFile* parameter. +A JSON file is a text file that uses syntax similar to the following: +{ + "Name": "ContosoNotificationHub", + "Location": "West US", +} +When used in conjunction with the **Set-AzNotificationHub** cmdlet, the preceding JSON sample sets the Location value of a notification hub named ContosoNotificationHub to West US. + +## EXAMPLES + +### Example 1: Modify the property values for a notification hub +```powershell +Set-AzNotificationHub -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -InputFile "C:\Configuration\Hubs.json" +``` + +This command modifies the property values for a notification hub found in the ContosoNamespace namespace and assigned it to the resource group ContosoNotificationsGroup. +The property values, as well as the name of the hub to be modified, are not specified in the command. +Instead, that information is contained in the input file C:\Configuration\Hubs.json. + +### Example 2 + +Sets property values for a notification hub. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Set-AzNotificationHub -Namespace 'ContosoNamespace' -NotificationHubObj <NotificationHubAttributes> -ResourceGroup 'ContosoNotificationsGroup' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +Specifies the path to a JSON file that contains configuration information for the notification hub. + +```yaml +Type: System.String +Parameter Sets: InputFileParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace to which the notification hub is assigned. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotificationHubObj +Specifies the **NotificationHubAttributes** object that contains configuration information for the hub that this cmdlet modifies. + +```yaml +Type: Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes +Parameter Sets: NotificationHubParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the notification hub is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHub](./Get-AzNotificationHub.md) + +[New-AzNotificationHub](./New-AzNotificationHub.md) + +[Remove-AzNotificationHub](./Remove-AzNotificationHub.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/Set-AzNotificationHubAuthorizationRule.md b/azps-10.1.0/Az.NotificationHubs/Set-AzNotificationHubAuthorizationRule.md new file mode 100644 index 0000000000..4268f58e50 --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Set-AzNotificationHubAuthorizationRule.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: BD311CEF-378B-463E-8998-CC3E9A5B3A7B +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/set-aznotificationhubauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Set-AzNotificationHubAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Set-AzNotificationHubAuthorizationRule.md +--- + +# Set-AzNotificationHubAuthorizationRule + +## SYNOPSIS +Sets authorization rules for a notification hub. + +## SYNTAX + +### InputFileParameterSet +``` +Set-AzNotificationHubAuthorizationRule [-ResourceGroup] <String> [-Namespace] <String> + [-NotificationHub] <String> [-InputFile] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SASRuleParameterSet +``` +Set-AzNotificationHubAuthorizationRule [-ResourceGroup] <String> [-Namespace] <String> + [-NotificationHub] <String> [-SASRule] <SharedAccessAuthorizationRuleAttributes> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNotificationHubAuthorizationRule** cmdlet modifies a Shared Access Signature (SAS) authorization rule assigned to a notification hub. +Authorization rules manage access to your notification hubs by the creation of links, as URIs, based on different permission levels. +Permission levels can be one of the following: +- Listen +- Send +- Manage +Clients are directed to one of these URIs based on the appropriate permission level. +For example, a client given the Listen permission will be directed to the URI for that permission. +This cmdlet provides two ways to modify an authorization rule assigned to a notification hub. +For one, you can create an instance of the **SharedAccessAuthorizationRuleAttributes** object and then configure that object with the property values you want the rule to possess. +You can configure the object through the .NET Framework. +You can then copy those property values to your rule by using *SASRule* parameter. +Alternatively, you can create a JSON (JavaScript Object Notation) file containing the relevant configuration values and then apply those values through the *InputFile* parameter. +A JSON file is a text file that uses syntax similar to this: +{ "Name": "ContosoAuthorizationRule", + "PrimaryKey": "WE4qH0398AyXjlekt56gg1gMR3NHoMs29KkUnnpUk01Y=", + "Rights": \[ + "Listen", + "Send" + \] +} +When used in conjunction with the New-AzNotificationHubAuthorizationRule cmdlet, the preceding JSON sample modifies an authorization rule named ContosoAuthorizationRule in order to give users Listen and Send rights to the hub. + +## EXAMPLES + +### Example 1: Modify an authorization rule assigned to a notification hub +```powershell +Set-AzNotificationHubAuthorizationRule -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationGroup" -NotificationHub "ContosoExternalHub" -InputFile "C:\Configuration\AuthorizationRules.json" +``` + +This command modifies an authorization rule assigned to the notification hub named ContosoExternalHub. +You must specify the namespace where the hub is located as well as the resource group that the hub is assigned. +Information about the rule that is modified is not included in the command itself. +Instead, that information is found in the input file C:\Configuration\AuthorizationRules.json. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +Specifies the path to a JSON file containing configuration information for the new rule. + +```yaml +Type: System.String +Parameter Sets: InputFileParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace to which the notification hub is assigned. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotificationHub +Specifies the notification hub that this cmdlet assigns authorization rules to. +Notification hubs are used to send push notifications to multiple clients regardless of the used by those clients. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the notification hub is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SASRule +Specifies the **SharedAccessAuthorizationRuleAttributes** object that contains configuration information for the authorization rules that are modified. + +```yaml +Type: Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes +Parameter Sets: SASRuleParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubAuthorizationRule](./Get-AzNotificationHubAuthorizationRule.md) + +[New-AzNotificationHubAuthorizationRule](./New-AzNotificationHubAuthorizationRule.md) + +[Remove-AzNotificationHubAuthorizationRule](./Remove-AzNotificationHubAuthorizationRule.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/Set-AzNotificationHubsNamespace.md b/azps-10.1.0/Az.NotificationHubs/Set-AzNotificationHubsNamespace.md new file mode 100644 index 0000000000..26893d0f94 --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Set-AzNotificationHubsNamespace.md @@ -0,0 +1,263 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: 1B2AA717-ECD6-4CC0-AB6D-A199AF21A4A5 +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/set-aznotificationhubsnamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Set-AzNotificationHubsNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Set-AzNotificationHubsNamespace.md +--- + +# Set-AzNotificationHubsNamespace + +## SYNOPSIS +Sets property values for a notification hub namespace. + +## SYNTAX + +``` +Set-AzNotificationHubsNamespace [-ResourceGroup] <String> [-Namespace] <String> [-Location] <String> + [[-State] <NamespaceState>] [[-Critical] <Boolean>] [[-Tag] <Hashtable>] [[-SkuTier] <String>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNotificationHubsNamespace** cmdlet sets the property values of an existing notification hub namespace. +Namespaces are logical containers that help you organize and manage your notification hubs. +You must have at least one notification hub namespace. +Additionally, all notification hubs must have an assigned namespace. +This cmdlet is primarily used to enable and disable a namespace. +When a namespace is disabled, users cannot connect to any of the notification hubs in the namespace, nor can administrators use those hubs to send push notifications. +To re-enable a disabled namespace, use this cmdlet to set the **State** property of the namespace to Active. +You can also use this cmdlet to tag a namespace as critical. +This prevents the namespace from being deleted. +To remove a critical namespace you must first remove the Critical tag. + +## EXAMPLES + +### Example 1: Disable a namespace +```powershell +Set-AzNotificationHubsNamespace -Namespace "ContosoPartners" -Location "West US" -ResourceGroup "ContosoNotificationsGroup" -State "Disabled" -SkuTier "Standard" +``` + +This command disables the Standard tier namespace named ContosoPartners located in the West US datacenter and assigned to the ContosoNotificationsGroup resource group. + +### Example 2: Enable a namespace +```powershell +Set-AzNotificationHubsNamespace -Namespace "ContosoPartners" -Location "West US" -ResourceGroup "ContosoNotificationsGroup" -State "Active" -SkuTier "Standard" +``` + +This command enables the Standard tier namespace named ContosoPartners located in the West US datacenter and assigned to the ContosoNotificationsGroup resource group. + +## PARAMETERS + +### -Critical +Indicates whether the namespace is a critical namespace. +Critical namespaces cannot be deleted. +To delete a critical namespace, you must set the value of this property to False in order to mark the namespace as non-critical. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the display name of the datacenter that hosts the namespace. +Although you can set this parameter to any valid Azure location, for optimal performance you should use a datacenter located near the majority of your users. +To get an up-to-date list of Azure locations run the following command: +`Get-AzLocation | Select-Object DisplayName` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace that this cmdlet modifies. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the namespace is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuTier +Sku tier of the namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the current state of the namespace. +The acceptable values for this parameter are: Active and Disabled. + +```yaml +Type: Microsoft.Azure.Commands.NotificationHubs.Models.NamespaceState +Parameter Sets: (All) +Aliases: +Accepted values: Unknown, Active, Disabled + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specifies name-value pairs that can be used to categorize and organize Azure items. +Tags function similar to keywords, and operate across a deployment. +For example, if you search for all items with the tag Department:IT the search will return all the Azure items that have that tag, regardless of such things as item type, location, or resource group. +An individual tag consists of two parts: the *Name* and (optionally) the *Value*. +For example, in Department:IT, the tag name is Department and the tag value is IT. +To add a tag, use hash table syntax similar to this, which creates the tag CalendarYear:2016: +-Tags @{Name="CalendarYear";Value="2016"} +To add multiple tags in the same command, separate the individual tags by using commas: +-Tag @{Name="CalendarYear";Value="2016"}, @{Name="FiscalYear";Value="2017"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.NotificationHubs.Models.NamespaceState + +### System.Boolean + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.NotificationHubs.Models.NamespaceAttributes + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubsNamespace](./Get-AzNotificationHubsNamespace.md) + +[New-AzNotificationHubsNamespace](./New-AzNotificationHubsNamespace.md) + +[Remove-AzNotificationHubsNamespace](./Remove-AzNotificationHubsNamespace.md) + + diff --git a/azps-10.1.0/Az.NotificationHubs/Set-AzNotificationHubsNamespaceAuthorizationRule.md b/azps-10.1.0/Az.NotificationHubs/Set-AzNotificationHubsNamespaceAuthorizationRule.md new file mode 100644 index 0000000000..320f9fcdac --- /dev/null +++ b/azps-10.1.0/Az.NotificationHubs/Set-AzNotificationHubsNamespaceAuthorizationRule.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.NotificationHubs.dll-Help.xml +Module Name: Az.NotificationHubs +ms.assetid: F0981A7A-1B17-4141-A267-927E5B78BE5F +online version: https://learn.microsoft.com/powershell/module/az.notificationhubs/set-aznotificationhubsnamespaceauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Set-AzNotificationHubsNamespaceAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/NotificationHubs/NotificationHubs/help/Set-AzNotificationHubsNamespaceAuthorizationRule.md +--- + +# Set-AzNotificationHubsNamespaceAuthorizationRule + +## SYNOPSIS +Sets authorization rules for a notification hub namespace. + +## SYNTAX + +### InputFileParameterSet +``` +Set-AzNotificationHubsNamespaceAuthorizationRule [-ResourceGroup] <String> [-Namespace] <String> + [-InputFile] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SASRuleParameterSet +``` +Set-AzNotificationHubsNamespaceAuthorizationRule [-ResourceGroup] <String> [-Namespace] <String> + [-SASRule] <SharedAccessAuthorizationRuleAttributes> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzNotificationHubsNamespaceAuthorizationRule** cmdlet modifies a Shared Access Signature (SAS) authorization rule assigned to a notification hub namespace. +Authorization rules manage user rights to the namespace and to the notification hubs contained in that namespace. +This cmdlet provides two ways to modify an authorization rule assigned to a namespace. +For one, you can create an instance of the **SharedAccessAuthorizationRuleAttributes** object and then configure that object with the property values you want the rule to possess. +You can use the .NET Framework to accomplish this. +You can then copy those property values to the rule through the *SASRule* parameter. +Alternatively, you can create a JSON (JavaScript Object Notation) file containing the relevant configuration values and then apply those values through the *InputFile* parameter. +A JSON file is a text file that uses syntax similar to this: +{ + "Name": "ContosoAuthorizationRule", + "PrimaryKey": "WE4qH0398AyXjlekt56gg1gMR3NHoMs29KkUnnpUk01Y=", + "Rights": \[ + "Listen", + "Send" + \] +} +When used in conjunction with the **Set-AzNotificationHubsNamespaceAuthorizationRule** cmdlet, the preceding JSON sample modifies an authorization rule named ContosoAuthorizationRule to give users Listen and Send rights to the namespace. + +## EXAMPLES + +### Example 1: Modify an authorization rule assigned to a namespace +```powershell +Set-AzNotificationHubsNamespaceAuthorizationRule -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationGroup" -InputFile "C:\Configuration\AuthorizationRules.json" +``` + +This command modifies an authorization rule assigned to the namespace named ContosoNamespace. +You must specify the resource group that the namespace is assigned to. +Information about the authorization rule is not included in the command itself. +Instead, that information is obtained from the input file C:\Configuration\AuthorizationRules.json. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +Specifies the path to a JSON file containing configuration information for the new rule. + +```yaml +Type: System.String +Parameter Sets: InputFileParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +Specifies the namespace that contains the authorization rules that this cmdlet modifies. +Namespaces provide a way to group and categorize notification hubs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroup +Specifies the resource group to which the namespace is assigned. +Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SASRule +Specifies the **SharedAccessAuthorizationRuleAttributes** object that contains configuration information for the authorization rules that this cmdlet modifies. + +```yaml +Type: Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes +Parameter Sets: SASRuleParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes + +## NOTES + +## RELATED LINKS + +[Get-AzNotificationHubsNamespaceAuthorizationRule](./Get-AzNotificationHubsNamespaceAuthorizationRule.md) + +[New-AzNotificationHubsNamespaceAuthorizationRule](./New-AzNotificationHubsNamespaceAuthorizationRule.md) + +[Remove-AzNotificationHubsNamespaceAuthorizationRule](./Remove-AzNotificationHubsNamespaceAuthorizationRule.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Az.OperationalInsights.md b/azps-10.1.0/Az.OperationalInsights/Az.OperationalInsights.md new file mode 100644 index 0000000000..cbf5de2da0 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Az.OperationalInsights.md @@ -0,0 +1,224 @@ +--- +Module Name: Az.OperationalInsights +Module Guid: e827799a-7abf-4538-a61f-94dc52a48bd4 +Download Help Link: https://learn.microsoft.com/powershell/module/az.operationalinsights +Help Version: 4.3.2.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Az.OperationalInsights.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Az.OperationalInsights.md +--- + +# Az.OperationalInsights Module +## Description +This topic displays help topics for the Azure Operational Insights Cmdlets. + +## Az.OperationalInsights Cmdlets +### [Disable-AzOperationalInsightsIISLogCollection](Disable-AzOperationalInsightsIISLogCollection.md) +Stops collection of IIS logs from computers. + +### [Disable-AzOperationalInsightsLinuxCustomLogCollection](Disable-AzOperationalInsightsLinuxCustomLogCollection.md) +Stops collection of custom logs from Linux computers. + +### [Disable-AzOperationalInsightsLinuxPerformanceCollection](Disable-AzOperationalInsightsLinuxPerformanceCollection.md) +Stops collection of performance counters from Linux computers. + +### [Disable-AzOperationalInsightsLinuxSyslogCollection](Disable-AzOperationalInsightsLinuxSyslogCollection.md) +Stops collection of syslog data from Linux computers. + +### [Enable-AzOperationalInsightsIISLogCollection](Enable-AzOperationalInsightsIISLogCollection.md) +Starts collection of IIS logs from computers in a workspace. + +### [Enable-AzOperationalInsightsLinuxCustomLogCollection](Enable-AzOperationalInsightsLinuxCustomLogCollection.md) +Starts collection of custom logs from Linux computers. + +### [Enable-AzOperationalInsightsLinuxPerformanceCollection](Enable-AzOperationalInsightsLinuxPerformanceCollection.md) +Starts collection of performance counters from Linux computers. + +### [Enable-AzOperationalInsightsLinuxSyslogCollection](Enable-AzOperationalInsightsLinuxSyslogCollection.md) +Starts collection of syslog data from Linux computers. + +### [Get-AzOperationalInsightsAvailableServiceTier](Get-AzOperationalInsightsAvailableServiceTier.md) +This command gets all available service tiers for a given worksapce. + +### [Get-AzOperationalInsightsCluster](Get-AzOperationalInsightsCluster.md) +Get or list clusters + +### [Get-AzOperationalInsightsDataExport](Get-AzOperationalInsightsDataExport.md) +Get or list data exports for workspace. + +### [Get-AzOperationalInsightsDataSource](Get-AzOperationalInsightsDataSource.md) +Get datasources under Azure Log Analytics workspace. + +### [Get-AzOperationalInsightsDeletedWorkspace](Get-AzOperationalInsightsDeletedWorkspace.md) +List deleted workspaces. + +### [Get-AzOperationalInsightsIntelligencePack](Get-AzOperationalInsightsIntelligencePack.md) +Gets the available Intelligence Packs. + +> [!NOTE] +> Solutions is being deprecated, please use [az monitor log-analytics solution](https://learn.microsoft.com/en-us/cli/azure/monitor/log-analytics/solution?view=azure-cli-latest) and [Get-AzMonitorLogAnalyticsSolution](https://learn.microsoft.com/en-us/powershell/module/az.monitoringsolutions/get-azmonitorloganalyticssolution?view=azps-5.9.0) instead if this command. + +### [Get-AzOperationalInsightsLinkedService](Get-AzOperationalInsightsLinkedService.md) +Get or list linked service for workspace + +### [Get-AzOperationalInsightsLinkedStorageAccount](Get-AzOperationalInsightsLinkedStorageAccount.md) +Get or list linked storage account + +### [Get-AzOperationalInsightsOperation](Get-AzOperationalInsightsOperation.md) +Lists all of the available OperationalInsights Rest API operations. + +### [Get-AzOperationalInsightsOperationStatus](Get-AzOperationalInsightsOperationStatus.md) +Get the status of a long running azure asynchronous operation. + +### [Get-AzOperationalInsightsPurgeWorkspaceStatus](Get-AzOperationalInsightsPurgeWorkspaceStatus.md) +Gets status of an ongoing purge operation. + +### [Get-AzOperationalInsightsSavedSearch](Get-AzOperationalInsightsSavedSearch.md) +Returns all of the saved searches for a specified workspace. + +### [Get-AzOperationalInsightsSchema](Get-AzOperationalInsightsSchema.md) +Returns the schema associated with a workspace. + +### [Get-AzOperationalInsightsStorageInsight](Get-AzOperationalInsightsStorageInsight.md) +Gets information about a Storage Insight. + +### [Get-AzOperationalInsightsTable](Get-AzOperationalInsightsTable.md) +Get or list tables for workspace. + +### [Get-AzOperationalInsightsWorkspace](Get-AzOperationalInsightsWorkspace.md) +Gets information about a workspace. + +### [Get-AzOperationalInsightsWorkspaceManagementGroup](Get-AzOperationalInsightsWorkspaceManagementGroup.md) +Gets details of management groups connected to a workspace. + +### [Get-AzOperationalInsightsWorkspaceSharedKey](Get-AzOperationalInsightsWorkspaceSharedKey.md) +Gets the shared keys for a workspace. + +### [Get-AzOperationalInsightsWorkspaceUsage](Get-AzOperationalInsightsWorkspaceUsage.md) +Gets the usage data for a workspace. + +### [Invoke-AzOperationalInsightsMigrateTable](Invoke-AzOperationalInsightsMigrateTable.md) +Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs. + +### [Invoke-AzOperationalInsightsQuery](Invoke-AzOperationalInsightsQuery.md) +Returns search results based on the specified parameters. + +### [New-AzOperationalInsightsApplicationInsightsDataSource](New-AzOperationalInsightsApplicationInsightsDataSource.md) +Collect logs from given Application-Insights application. + +### [New-AzOperationalInsightsAzureActivityLogDataSource](New-AzOperationalInsightsAzureActivityLogDataSource.md) +Collect Azure Activity log from given subscription. + +### [New-AzOperationalInsightsCluster](New-AzOperationalInsightsCluster.md) +Create cluster + +### [New-AzOperationalInsightsComputerGroup](New-AzOperationalInsightsComputerGroup.md) +Creates a computer group. + +### [New-AzOperationalInsightsCustomLogDataSource](New-AzOperationalInsightsCustomLogDataSource.md) +Defines a custom log collection policy. + +### [New-AzOperationalInsightsDataExport](New-AzOperationalInsightsDataExport.md) +Create data export for workspace. + +### [New-AzOperationalInsightsLinkedStorageAccount](New-AzOperationalInsightsLinkedStorageAccount.md) +Create linked storage account for workspace + +### [New-AzOperationalInsightsLinuxPerformanceObjectDataSource](New-AzOperationalInsightsLinuxPerformanceObjectDataSource.md) +Adds performance counters to all Linux computers in a workspace. + +### [New-AzOperationalInsightsLinuxSyslogDataSource](New-AzOperationalInsightsLinuxSyslogDataSource.md) +Adds a data source to Linux computers. + +### [New-AzOperationalInsightsPurgeWorkspace](New-AzOperationalInsightsPurgeWorkspace.md) +Purges data in an Log Analytics workspace by a set of user-defined filters + +### [New-AzOperationalInsightsRestoreTable](New-AzOperationalInsightsRestoreTable.md) +Create a new Restore table + +### [New-AzOperationalInsightsSavedSearch](New-AzOperationalInsightsSavedSearch.md) +Creates a new saved search with the specified parameters. + +### [New-AzOperationalInsightsSearchTable](New-AzOperationalInsightsSearchTable.md) +Create a Search table + +### [New-AzOperationalInsightsStorageInsight](New-AzOperationalInsightsStorageInsight.md) +Creates a Storage Insight inside a workspace. + +### [New-AzOperationalInsightsTable](New-AzOperationalInsightsTable.md) +Creates a custom log table + +### [New-AzOperationalInsightsWindowsEventDataSource](New-AzOperationalInsightsWindowsEventDataSource.md) +Collects event logs from computers that run the Windows operating system. + +### [New-AzOperationalInsightsWindowsPerformanceCounterDataSource](New-AzOperationalInsightsWindowsPerformanceCounterDataSource.md) +Adds Windows performance counter data source for connected computers that run the Windows operating system. + +### [New-AzOperationalInsightsWorkspace](New-AzOperationalInsightsWorkspace.md) +Creates a workspace, or restore a soft-deleted workspace. + +### [Remove-AzOperationalInsightsCluster](Remove-AzOperationalInsightsCluster.md) +Delete cluster + +### [Remove-AzOperationalInsightsDataExport](Remove-AzOperationalInsightsDataExport.md) +Delete data export for workspace. + +### [Remove-AzOperationalInsightsDataSource](Remove-AzOperationalInsightsDataSource.md) +Deletes a data source. + +### [Remove-AzOperationalInsightsLinkedService](Remove-AzOperationalInsightsLinkedService.md) +Unlink service for workspace + +### [Remove-AzOperationalInsightsLinkedStorageAccount](Remove-AzOperationalInsightsLinkedStorageAccount.md) +Delete linked storage account for workspace + +### [Remove-AzOperationalInsightsSavedSearch](Remove-AzOperationalInsightsSavedSearch.md) +Removes a saved search from the workspace. + +### [Remove-AzOperationalInsightsStorageInsight](Remove-AzOperationalInsightsStorageInsight.md) +Removes a Storage Insight. + +### [Remove-AzOperationalInsightsTable](Remove-AzOperationalInsightsTable.md) +Delete a Log Analytics workspace table. + +### [Remove-AzOperationalInsightsWorkspace](Remove-AzOperationalInsightsWorkspace.md) +Removes a workspace. + +### [Restore-AzOperationalInsightsWorkspace](Restore-AzOperationalInsightsWorkspace.md) +Restore a deleted workspace. + +### [Set-AzOperationalInsightsDataSource](Set-AzOperationalInsightsDataSource.md) +Updates a data source. + +### [Set-AzOperationalInsightsIntelligencePack](Set-AzOperationalInsightsIntelligencePack.md) +Enables or disables the specified Intelligence Pack. +> [!NOTE] +> Solutions is being deprecated, please use [az monitor log-analytics solution](https://learn.microsoft.com/en-us/cli/azure/monitor/log-analytics/solution?view=azure-cli-latest) and [Get-AzMonitorLogAnalyticsSolution](https://learn.microsoft.com/en-us/powershell/module/az.monitoringsolutions/get-azmonitorloganalyticssolution?view=azps-5.9.0) instead if this command. + +### [Set-AzOperationalInsightsLinkedService](Set-AzOperationalInsightsLinkedService.md) +link service for workspace + +### [Set-AzOperationalInsightsLinkedStorageAccount](Set-AzOperationalInsightsLinkedStorageAccount.md) +Set linked storage account for workspace + +### [Set-AzOperationalInsightsSavedSearch](Set-AzOperationalInsightsSavedSearch.md) +Updates a saved search that already exists. + +### [Set-AzOperationalInsightsStorageInsight](Set-AzOperationalInsightsStorageInsight.md) +Updates a Storage Insight. + +### [Set-AzOperationalInsightsWorkspace](Set-AzOperationalInsightsWorkspace.md) +Updates a workspace. + +### [Update-AzOperationalInsightsCluster](Update-AzOperationalInsightsCluster.md) +update cluster + +### [Update-AzOperationalInsightsDataExport](Update-AzOperationalInsightsDataExport.md) +Update data export. + +### [Update-AzOperationalInsightsTable](Update-AzOperationalInsightsTable.md) +Update a Log Analytics workspace table. + +### [Update-AzOperationalInsightsWorkspaceSharedKey](Update-AzOperationalInsightsWorkspaceSharedKey.md) +Regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace. + diff --git a/azps-10.1.0/Az.OperationalInsights/Disable-AzOperationalInsightsIISLogCollection.md b/azps-10.1.0/Az.OperationalInsights/Disable-AzOperationalInsightsIISLogCollection.md new file mode 100644 index 0000000000..e2ad595eda --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Disable-AzOperationalInsightsIISLogCollection.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 95B54065-B6CC-4D10-A747-28CE3F412ABF +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/disable-azoperationalinsightsiislogcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Disable-AzOperationalInsightsIISLogCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Disable-AzOperationalInsightsIISLogCollection.md +--- + +# Disable-AzOperationalInsightsIISLogCollection + +## SYNOPSIS +Stops collection of IIS logs from computers. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +Disable-AzOperationalInsightsIISLogCollection [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +Disable-AzOperationalInsightsIISLogCollection [-Workspace] <PSWorkspace> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzOperationalInsightsIISLogCollection** cmdlet stops collection of Internet Information Services (IIS) logs from connected computers in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzOperationalInsightsIISLogCollection -ResourceGroupName test-rg -WorkspaceName OperationalInsight +``` + +```output +Name : DataSource_IISLogs +ResourceGroupName : test-rg +WorkspaceName : OperationalInsight +ResourceId : /subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/resourceGroups/test-rg/providers/Microsoft.OperationalInsights/wo + rkspaces/OperationalInsight/datasources/DataSource_IISLogs +Kind : IISLogs +Properties : {"state":"OnPremiseDisabled"} +``` + + Stops collection of Internet Information Services (IIS) logs from connected computers in a workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights + +## RELATED LINKS + +[Enable-AzOperationalInsightsIISLogCollection](./Enable-AzOperationalInsightsIISLogCollection.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Disable-AzOperationalInsightsLinuxCustomLogCollection.md b/azps-10.1.0/Az.OperationalInsights/Disable-AzOperationalInsightsLinuxCustomLogCollection.md new file mode 100644 index 0000000000..bd4fc72dc9 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Disable-AzOperationalInsightsLinuxCustomLogCollection.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: EF3FE3F1-1C8F-41EB-990E-F2B30BD9D082 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/disable-azoperationalinsightslinuxcustomlogcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Disable-AzOperationalInsightsLinuxCustomLogCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Disable-AzOperationalInsightsLinuxCustomLogCollection.md +--- + +# Disable-AzOperationalInsightsLinuxCustomLogCollection + +## SYNOPSIS +Stops collection of custom logs from Linux computers. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +Disable-AzOperationalInsightsLinuxCustomLogCollection [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +Disable-AzOperationalInsightsLinuxCustomLogCollection [-Workspace] <PSWorkspace> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzOperationalInsightsLinuxCustomLogCollection** cmdlet stops collection of custom logs from connected Linux computers in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzOperationalInsightsLinuxCustomLogCollection -ResourceGroupName test-rg -WorkspaceName OperationalInsight +``` + +```output +Name : DataSource_CustomLogCollection +ResourceGroupName : test-rg +WorkspaceName : OperationalInsight +ResourceId : /subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/resourceGroups/test-rg/providers/Microsoft.OperationalInsights/wo + rkspaces/OperationalInsight/datasources/DataSource_CustomLogCollection +Kind : CustomLogCollection +Properties : {"state":"LinuxLogsDisabled"} +``` + +Stops collection of custom logs from connected Linux computers in a workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains Linux computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights + +## RELATED LINKS + +[Enable-AzOperationalInsightsLinuxCustomLogCollection](./Enable-AzOperationalInsightsLinuxCustomLogCollection.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Disable-AzOperationalInsightsLinuxPerformanceCollection.md b/azps-10.1.0/Az.OperationalInsights/Disable-AzOperationalInsightsLinuxPerformanceCollection.md new file mode 100644 index 0000000000..510c9ef249 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Disable-AzOperationalInsightsLinuxPerformanceCollection.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 47AFBAC7-8818-4788-B685-7AB4DCD6C2DE +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/disable-azoperationalinsightslinuxperformancecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Disable-AzOperationalInsightsLinuxPerformanceCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Disable-AzOperationalInsightsLinuxPerformanceCollection.md +--- + +# Disable-AzOperationalInsightsLinuxPerformanceCollection + +## SYNOPSIS +Stops collection of performance counters from Linux computers. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +Disable-AzOperationalInsightsLinuxPerformanceCollection [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +Disable-AzOperationalInsightsLinuxPerformanceCollection [-Workspace] <PSWorkspace> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzOperationalInsightsLinuxPerformanceCollection** cmdlet stops collection of performance counters from connected Linux computers in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzOperationalInsightsLinuxPerformanceCollection -ResourceGroupName test-rg -WorkspaceName OperationalInsight +``` + +```output +Name : DataSource_LinuxPerformanceCollection +ResourceGroupName : test-rg +WorkspaceName : OperationalInsight +ResourceId : /subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/resourceGroups/test-rg/providers/Microsoft.OperationalInsights/wo + rkspaces/OperationalInsight/datasources/DataSource_LinuxPerformanceCollection +Kind : LinuxPerformanceCollection +Properties : {"state":"Disabled"} +``` + +Stops collection of performance counters from connected Linux computers in a workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains Linux computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights + +## RELATED LINKS + +[Enable-AzOperationalInsightsLinuxPerformanceCollection](./Enable-AzOperationalInsightsLinuxPerformanceCollection.md) + +[New-AzOperationalInsightsLinuxSyslogDataSource](./New-AzOperationalInsightsLinuxSyslogDataSource.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Disable-AzOperationalInsightsLinuxSyslogCollection.md b/azps-10.1.0/Az.OperationalInsights/Disable-AzOperationalInsightsLinuxSyslogCollection.md new file mode 100644 index 0000000000..a699ed87b9 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Disable-AzOperationalInsightsLinuxSyslogCollection.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 4A91EEDA-D8F0-4109-A32E-B83694952C06 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/disable-azoperationalinsightslinuxsyslogcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Disable-AzOperationalInsightsLinuxSyslogCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Disable-AzOperationalInsightsLinuxSyslogCollection.md +--- + +# Disable-AzOperationalInsightsLinuxSyslogCollection + +## SYNOPSIS +Stops collection of syslog data from Linux computers. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +Disable-AzOperationalInsightsLinuxSyslogCollection [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +Disable-AzOperationalInsightsLinuxSyslogCollection [-Workspace] <PSWorkspace> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzOperationalInsightsLinuxSyslogCollection** cmdlet stops collection of syslog data from connected Linux computers in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzOperationalInsightsLinuxSyslogCollection -ResourceGroupName test-rg -WorkspaceName OperationalInsights-1 +``` + +```output +Name : DataSource_LinuxSyslogCollection +ResourceGroupName : test-rg +WorkspaceName : OperationalInsights-1 +ResourceId : /subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/resourceGroups/test-rg/providers/Microsoft.OperationalInsights/wo + rkspaces/OperationalInsights-1/datasources/DataSource_LinuxSyslogCollection +Kind : LinuxSyslogCollection +Properties : {"state":"Disabled"} +``` + +Stops collection of syslog data from connected Linux computers in a workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains Linux computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights + +## RELATED LINKS + +[Enable-AzOperationalInsightsLinuxSyslogCollection](./Enable-AzOperationalInsightsLinuxSyslogCollection.md) + +[New-AzOperationalInsightsLinuxSyslogDataSource](./New-AzOperationalInsightsLinuxSyslogDataSource.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Enable-AzOperationalInsightsIISLogCollection.md b/azps-10.1.0/Az.OperationalInsights/Enable-AzOperationalInsightsIISLogCollection.md new file mode 100644 index 0000000000..39b345cea5 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Enable-AzOperationalInsightsIISLogCollection.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 26B1921E-6052-471B-B5B6-F2853536A425 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/enable-azoperationalinsightsiislogcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Enable-AzOperationalInsightsIISLogCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Enable-AzOperationalInsightsIISLogCollection.md +--- + +# Enable-AzOperationalInsightsIISLogCollection + +## SYNOPSIS +Starts collection of IIS logs from computers in a workspace. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +Enable-AzOperationalInsightsIISLogCollection [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +Enable-AzOperationalInsightsIISLogCollection [-Workspace] <PSWorkspace> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzOperationalInsightsIISLogCollection** cmdlet starts collection of Internet Information Services (IIS) logs from connected computers in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Enable-AzOperationalInsightsIISLogCollection -ResourceGroupName test-rg -WorkspaceName OperationalInsight +``` + +```output +Name : DataSource_IISLogs +ResourceGroupName : test-rg +WorkspaceName : OperationalInsight +ResourceId : /subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/resourceGroups/test-rg/providers/Microsoft.OperationalInsights/wo + rkspaces/OperationalInsight/datasources/DataSource_IISLogs +Kind : IISLogs +Properties : {"state":"OnPremiseEnabled"} +``` + +Starts collection of Internet Information Services (IIS) logs from connected computers in a workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES + +## RELATED LINKS + +[Disable-AzOperationalInsightsIISLogCollection](./Disable-AzOperationalInsightsIISLogCollection.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Enable-AzOperationalInsightsLinuxCustomLogCollection.md b/azps-10.1.0/Az.OperationalInsights/Enable-AzOperationalInsightsLinuxCustomLogCollection.md new file mode 100644 index 0000000000..9434bb4944 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Enable-AzOperationalInsightsLinuxCustomLogCollection.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 99865242-6623-425E-92F2-0B229FC4EDAC +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/enable-azoperationalinsightslinuxcustomlogcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Enable-AzOperationalInsightsLinuxCustomLogCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Enable-AzOperationalInsightsLinuxCustomLogCollection.md +--- + +# Enable-AzOperationalInsightsLinuxCustomLogCollection + +## SYNOPSIS +Starts collection of custom logs from Linux computers. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +Enable-AzOperationalInsightsLinuxCustomLogCollection [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +Enable-AzOperationalInsightsLinuxCustomLogCollection [-Workspace] <PSWorkspace> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzOperationalInsightsLinuxCustomLogCollection** cmdlet starts collection of custom logs from connected Linux computers in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Enable-AzOperationalInsightsLinuxCustomLogCollection -ResourceGroupName test-rg -WorkspaceName OperationalInsight +``` + +```output +Name : DataSource_CustomLogCollection +ResourceGroupName : test-rg +WorkspaceName : OperationalInsight +ResourceId : /subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/resourceGroups/test-rg/providers/Microsoft.OperationalInsights/wo + rkspaces/OperationalInsight/datasources/DataSource_CustomLogCollection +Kind : CustomLogCollection +Properties : {"state":"LinuxLogsEnabled"} +``` + +Starts collection of custom logs from connected Linux computers in a workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains Linux computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights + +## RELATED LINKS + +[Disable-AzOperationalInsightsLinuxCustomLogCollection](./Disable-AzOperationalInsightsLinuxCustomLogCollection.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Enable-AzOperationalInsightsLinuxPerformanceCollection.md b/azps-10.1.0/Az.OperationalInsights/Enable-AzOperationalInsightsLinuxPerformanceCollection.md new file mode 100644 index 0000000000..2cee4747e2 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Enable-AzOperationalInsightsLinuxPerformanceCollection.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 10141D75-B58D-42B0-B0A6-92FF630E534C +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/enable-azoperationalinsightslinuxperformancecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Enable-AzOperationalInsightsLinuxPerformanceCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Enable-AzOperationalInsightsLinuxPerformanceCollection.md +--- + +# Enable-AzOperationalInsightsLinuxPerformanceCollection + +## SYNOPSIS +Starts collection of performance counters from Linux computers. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +Enable-AzOperationalInsightsLinuxPerformanceCollection [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +Enable-AzOperationalInsightsLinuxPerformanceCollection [-Workspace] <PSWorkspace> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzOperationalInsightsLinuxPerformanceCollection** cmdlet starts collection of performance counters from connected Linux computers in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Enable-AzOperationalInsightsLinuxPerformanceCollection -ResourceGroupName test-rg -WorkspaceName OperationalInsight +``` + +```output +Name : DataSource_LinuxPerformanceCollection +ResourceGroupName : test-rg +WorkspaceName : OperationalInsight +ResourceId : /subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/resourceGroups/test-rg/providers/Microsoft.OperationalInsights/wo + rkspaces/OperationalInsight/datasources/DataSource_LinuxPerformanceCollection +Kind : LinuxPerformanceCollection +Properties : {"state":"Enabled"} +``` + +Starts collection of performance counters from connected Linux computers in a workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains Linux computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights + +## RELATED LINKS + +[Disable-AzOperationalInsightsLinuxPerformanceCollection](./Disable-AzOperationalInsightsLinuxPerformanceCollection.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Enable-AzOperationalInsightsLinuxSyslogCollection.md b/azps-10.1.0/Az.OperationalInsights/Enable-AzOperationalInsightsLinuxSyslogCollection.md new file mode 100644 index 0000000000..aad45d6c1b --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Enable-AzOperationalInsightsLinuxSyslogCollection.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 66DD5919-B6B7-4FE5-B45B-937013549882 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/enable-azoperationalinsightslinuxsyslogcollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Enable-AzOperationalInsightsLinuxSyslogCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Enable-AzOperationalInsightsLinuxSyslogCollection.md +--- + +# Enable-AzOperationalInsightsLinuxSyslogCollection + +## SYNOPSIS +Starts collection of syslog data from Linux computers. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +Enable-AzOperationalInsightsLinuxSyslogCollection [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +Enable-AzOperationalInsightsLinuxSyslogCollection [-Workspace] <PSWorkspace> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzOperationalInsightsLinuxSyslogCollection** cmdlet starts collection of syslog data from connected Linux computers in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Enable-AzOperationalInsightsLinuxSyslogCollection -ResourceGroupName test-rg -WorkspaceName OperationalInsight +``` + +```output +Name : DataSource_LinuxSyslogCollection +ResourceGroupName : test-rg +WorkspaceName : OperationalInsight +ResourceId : /subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/resourceGroups/test-rg/providers/Microsoft.OperationalInsights/wo + rkspaces/OperationalInsight/datasources/DataSource_LinuxSyslogCollection +Kind : LinuxSyslogCollection +Properties : {"state":"Enabled"} +``` + +Starts collection of syslog data from connected Linux computers in a workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains Linux computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights + +## RELATED LINKS + +[Disable-AzOperationalInsightsLinuxSyslogCollection](./Disable-AzOperationalInsightsLinuxSyslogCollection.md) + +[New-AzOperationalInsightsLinuxSyslogDataSource](./New-AzOperationalInsightsLinuxSyslogDataSource.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsAvailableServiceTier.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsAvailableServiceTier.md new file mode 100644 index 0000000000..a8767920fa --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsAvailableServiceTier.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-AzOperationalInsightsAvailableServiceTier +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsAvailableServiceTier.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsAvailableServiceTier.md +--- + +# Get-AzOperationalInsightsAvailableServiceTier + +## SYNOPSIS +This command gets all available service tiers for a given worksapce. + +## SYNTAX + +``` +Get-AzOperationalInsightsAvailableServiceTier [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This command gets all available service tiers for a given worksapce. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzOperationalInsightsAvailableServiceTier -ResourceGroupName ContosoResourceGroup -WorkspaceName MyWorkspace +``` + +```output +ServiceTier : PerGB2018 +Enabled : True +MinimumRetention : 30 +MaximumRetention : 730 +DefaultRetention : 30 +CapacityReservationLevel : +LastSkuUpdate : + +ServiceTier : CapacityReservation +Enabled : True +MinimumRetention : 30 +MaximumRetention : 730 +DefaultRetention : 31 +CapacityReservationLevel : +LastSkuUpdate : Tue, 16 Nov 2021 13:20:32 GMT +``` + +This command gets all available service tiers for a given worksapce. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that contains the table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSAvailableServiceTier + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsCluster.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsCluster.md new file mode 100644 index 0000000000..1c6d0ffa0b --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsCluster.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsCluster.md +--- + +# Get-AzOperationalInsightsCluster + +## SYNOPSIS +Get or list clusters + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzOperationalInsightsCluster [-ResourceGroupName <String>] [-ClusterName <String>] [-ResourceId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzOperationalInsightsCluster -ResourceGroupName <String> -ClusterName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzOperationalInsightsCluster -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get or list clusters, list clusters under resource group when "-ClusterName" was not provided, list clusters under subscription when "-ClusterName" and "ResourceGroupName" were not provided. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzOperationalInsightsCluster -ResourceGroupName "rg-name" -ClusterName "cluster-name" +``` + +```output +Identity : Microsoft.Azure.Commands.OperationalInsights.Models.PSIdentity +Sku : Microsoft.Azure.Commands.OperationalInsights.Models.PSClusterSku +ClusterId : {cluster-id} +ProvisioningState : Succeeded +IsDoubleEncryptionEnabled : True +IsAvailabilityZonesEnabled : False +BillingType : Cluster +KeyVaultProperties : Microsoft.Azure.Commands.OperationalInsights.Models.PSKeyVaultProperties +LastModifiedDate : Wed, 26 May 2021 15:19:38 GMT +CreatedDate : Sun, 27 Dec 2020 11:17:11 GMT +AssociatedWorkspaces : {workspaces} +CapacityReservationProperties : Microsoft.Azure.Management.OperationalInsights.Models.CapacityReservationProperties +Location : South Central US +Id : /subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.OperationalInsights/clusters/{cluster-name} +Name : {cluster-name} +Type : Microsoft.OperationalInsights/clusters +Tags : {} +``` + +Get cluster + +## PARAMETERS + +### -ClusterName +The cluster name. + +```yaml +Type: System.String +Parameter Sets: ListParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The destination resource ID. +This can be copied from the Properties entry of the destination resource in Azure. + +```yaml +Type: System.String +Parameter Sets: ListParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsDataExport.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsDataExport.md new file mode 100644 index 0000000000..06753aaebb --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsDataExport.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightsdataexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsDataExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsDataExport.md +--- + +# Get-AzOperationalInsightsDataExport + +## SYNOPSIS +Get or list data exports for workspace. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzOperationalInsightsDataExport [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzOperationalInsightsDataExport -ResourceGroupName <String> -WorkspaceName <String> + [-DataExportName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzOperationalInsightsDataExport -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a workspace's Data export by name or all existing workspace's data exports. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzOperationalInsightsDataExport -ResourceGroupName "rg-name" -WorkspaceName "workspace-name" -DataExportName "dataExportName" +``` + +```output +Name : {dataExportName} +Id : /subscriptions/{subscription}/resourcegroups/{rg-name}/providers/microsoft.operationalinsights/workspaces/{workspace-name}/dataexports/{dataExportName} +Type : Microsoft.OperationalInsights/workspaces/export +DataExportId : {GUID} +TableNames : {tbl1,tbl2} +ResourceId : /subscriptions/{resource_subscription}/resourceGroups/{resource_rg}/providers/Microsoft.Storage/storageAc + counts/{storage_name} +DataExportType : StorageAccount +EventHubName : +Enable : True +CreatedDate : +LastModifiedDate : +``` + +Gets a workspace's Data export. + +### Example 2 +```powershell +Get-AzOperationalInsightsDataExport -ResourceGroupName "rg-name" -WorkspaceName "workspace-name" +``` + +Gets all workspace's Data exports. + +## PARAMETERS + +### -DataExportName +The data export name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The destination resource ID. +This can be copied from the Properties entry of the destination resource in Azure. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that will contain the storage insight. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataExport + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsDataSource.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsDataSource.md new file mode 100644 index 0000000000..435a7b8ade --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsDataSource.md @@ -0,0 +1,254 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 1F094EBA-E4AE-4B3E-BA20-858818C6FD12 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightsdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsDataSource.md +--- + +# Get-AzOperationalInsightsDataSource + +## SYNOPSIS +Get datasources under Azure Log Analytics workspace. + +## SYNTAX + +### ByWorkspaceNameByKind (Default) +``` +Get-AzOperationalInsightsDataSource [[-ResourceGroupName] <String>] [[-WorkspaceName] <String>] + [-Kind] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByWorkspaceObjectByName +``` +Get-AzOperationalInsightsDataSource [-Workspace] <PSWorkspace> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByWorkspaceObjectByKind +``` +Get-AzOperationalInsightsDataSource [[-Workspace] <PSWorkspace>] [[-Kind] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByWorkspaceNameByName +``` +Get-AzOperationalInsightsDataSource [-ResourceGroupName] <String> [-WorkspaceName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzOperationalInsightsDataSource** cmdlet gets data sources. +You can specify a data source to get. +You can filter the results based on the kind of data source. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzOperationalInsightsDataSource -Kind CustomLog -ResourceGroupName testrg -WorkspaceName LogAnalyticsWorkspace +``` + +```output +Name : DataSource_CustomLog_Customlog_CL +ResourceGroupName : testrg +WorkspaceName : LogAnalyticsWorkspace +ResourceId : /subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/resourceGroups/testrg/providers/Microsoft.Ope + rationalInsights/workspaces/LogAnalyticsWorkspace/datasources/DataSource_CustomLog_Customlog_ + CL +Kind : CustomLog +Properties : {"customLogName":"Customlog_CL","description":"","extractions":[{"extractionName":"TimeGenerated"," + extractionProperties":{"dateTimeExtraction":{"joinStringRegex":null,"regex":null,"formatString":nul + l}},"extractionType":"DateTime"}],"inputs":[{"location":{"fileSystemLocations":{"linuxFileTypeLogPa + ths":null,"windowsFileTypeLogPaths":["D:\\logs.txt"]}},"recordDelimiter":{"regexDelimiter":{"matchI + ndex":0,"numberdGroup":null,"pattern":"\\n"}}}]} +``` + +Get data sources. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Specifies the kind of data sources to get. +The acceptable values for this parameter are: +- AzureActivityLog +- CustomLog +- LinuxPerformanceObject +- LinuxSyslog +- WindowsEvent +- WindowsPerformanceCounter + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceNameByKind +Aliases: +Accepted values: AzureAuditLog, AzureActivityLog, CustomLog, LinuxPerformanceObject, LinuxSyslog, WindowsEvent, WindowsPerformanceCounter, ApplicationInsights + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceObjectByKind +Aliases: +Accepted values: AzureAuditLog, AzureActivityLog, CustomLog, LinuxPerformanceObject, LinuxSyslog, WindowsEvent, WindowsPerformanceCounter, ApplicationInsights + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a data source to get. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceObjectByName +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceNameByName +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains data sources to get. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceNameByKind +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceNameByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObjectByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObjectByKind +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceNameByKind +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceNameByName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights + +## RELATED LINKS + +[Remove-AzOperationalInsightsDataSource](./Remove-AzOperationalInsightsDataSource.md) + +[Set-AzOperationalInsightsDataSource](./Set-AzOperationalInsightsDataSource.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsDeletedWorkspace.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsDeletedWorkspace.md new file mode 100644 index 0000000000..1d95904b44 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsDeletedWorkspace.md @@ -0,0 +1,81 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightsdeletedworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsDeletedWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsDeletedWorkspace.md +--- + +# Get-AzOperationalInsightsDeletedWorkspace + +## SYNOPSIS +List deleted workspaces. + +## SYNTAX + +``` +Get-AzOperationalInsightsDeletedWorkspace [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +List deleted workspaces. + +## EXAMPLES + +### Example 1 +```powershell +$workspace = New-AzOperationalInsightsWorkspace -ResourceGroupName "RG-NAME" -Name "WORKSPACE-NAME" -Location "LOCATION-VALUE" +$workspace | Remove-AzOperationalInsightsWorkspace +Get-AzOperationalInsightsDeletedWorkspace -ResourceGroupName "RG-NAME" +``` + +List deleted workspaces. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsIntelligencePack.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsIntelligencePack.md new file mode 100644 index 0000000000..394f537fe5 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsIntelligencePack.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 0F9D72C1-2E42-4A67-9FDE-6344F5DE6C30 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightsintelligencepack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsIntelligencePack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsIntelligencePack.md +--- + +# Get-AzOperationalInsightsIntelligencePack + +## SYNOPSIS +Gets the available Intelligence Packs. + +> [!NOTE] +> Solutions is being deprecated, please use [az monitor log-analytics solution](https://learn.microsoft.com/en-us/cli/azure/monitor/log-analytics/solution?view=azure-cli-latest) and [Get-AzMonitorLogAnalyticsSolution](https://learn.microsoft.com/en-us/powershell/module/az.monitoringsolutions/get-azmonitorloganalyticssolution?view=azps-5.9.0) instead if this command. + +## SYNTAX + +``` +Get-AzOperationalInsightsIntelligencePack [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzOperationalInsightsIntelligencePack** cmdlet gets the available Intelligence Packs. + +## EXAMPLES + +### Example 1: Get Intelligence Packs +```powershell +Get-AzOperationalInsightsStorageInsight -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" +``` + +This command gets the available Intelligence Packs. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group that contains a workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSIntelligencePack + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsLinkedService.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsLinkedService.md new file mode 100644 index 0000000000..2d5fca54d2 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsLinkedService.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightslinkedservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsLinkedService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsLinkedService.md +--- + +# Get-AzOperationalInsightsLinkedService + +## SYNOPSIS +Get or list linked service for workspace + +## SYNTAX + +``` +Get-AzOperationalInsightsLinkedService [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-LinkedServiceName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list linked service for workspace, list when "-LinkedServiceName" was not provided + +## EXAMPLES + +### Example 1 +```powershell +Get-AzOperationalInsightsLinkedService -ResourceGroupName "rg-name" -WorkspaceName "workspace-name" -LinkedServiceName cluster +``` + +```output +Id : /subscriptions/{subscription}/resourcegroups/{rg-name}/providers/microsoft.operationalinsights/workspaces/{workspace-name}/linkedservices/cluster +Name : {cluster-name}/Cluster +Type : Microsoft.OperationalInsights/workspaces/linkedServices +ResourceId : +WriteAccessResourceId : /subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.OperationalInsights/clusters/{cluster-name} +ProvisioningState : ProvisioningAccount +Tags : +``` + +Get linked service for workspace + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedServiceName +The linked service name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSLinkedService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsLinkedStorageAccount.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsLinkedStorageAccount.md new file mode 100644 index 0000000000..2026eb400e --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsLinkedStorageAccount.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightslinkedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsLinkedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsLinkedStorageAccount.md +--- + +# Get-AzOperationalInsightsLinkedStorageAccount + +## SYNOPSIS +Get or list linked storage account + +## SYNTAX + +``` +Get-AzOperationalInsightsLinkedStorageAccount [-ResourceGroupName] <String> [-WorkspaceName] <String> + [[-DataSourceType] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get linked storage account, list all linked storage accounts when "-DataSourceType" was not specified + +## EXAMPLES + +### Example 1 +```powershell +Get-AzOperationalInsightsLinkedStorageAccount -ResourceGroupName "rg-name" -WorkspaceName "workspace-name" +``` + +```output +Id : /subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.OperationalInsights/workspaces/{workspace-name}/linkedStorageAccounts/customlogs +Name : +Type : Microsoft.OperationalInsights/workspaces/linkedStorageAccounts +DataSourceType : CustomLogs +StorageAccountIds : {/subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.Storage/storageAccounts/{account}} +``` + +list linked storage accoounts for workspace {workspace-name} + +## PARAMETERS + +### -DataSourceType +Data Source Type should be one of 'CustomLogs', 'AzureWatson'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: CustomLogs, AzureWatson, Query, Alerts + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSLinkedStorageAccountsResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsOperation.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsOperation.md new file mode 100644 index 0000000000..1d314af519 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsOperation.md @@ -0,0 +1,77 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightsoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsOperation.md +--- + +# Get-AzOperationalInsightsOperation + +## SYNOPSIS +Lists all of the available OperationalInsights Rest API operations. + +## SYNTAX + +``` +Get-AzOperationalInsightsOperation [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all of the available OperationalInsights Rest API operations. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzOperationalInsightsOperation +``` + +```output +Name : microsoft.operationalinsights/workspaces/features/{resource_name0}/read +Provider : MicrosoftOperationalInsights +Resource : {resource_name0} +Operation : +Description : + +Name : microsoft.operationalinsights/workspaces/features/{resource_name0}/read +Provider : MicrosoftOperationalInsights +Resource : {resource_name1} +Operation : +Description : +``` + +This command gets all available OperationalInsights Rest API operations by tenant. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSOperation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsOperationStatus.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsOperationStatus.md new file mode 100644 index 0000000000..6295f9d0ed --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsOperationStatus.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/Get-AzOperationalInsightsOperationStatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsOperationStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsOperationStatus.md +--- + +# Get-AzOperationalInsightsOperationStatus + +## SYNOPSIS +Get the status of a long running azure asynchronous operation. + +## SYNTAX + +``` +Get-AzOperationalInsightsOperationStatus -Location <String> -OperationId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the status of a long running azure asynchronous operation. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzOperationalInsightsOperationStatus -Location "location" -OperationId "op_id" +``` + +gets a long running azure asynchronous operation + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The region name of operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationId +The Id (Guid) of the operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSOperationStatus + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsPurgeWorkspaceStatus.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsPurgeWorkspaceStatus.md new file mode 100644 index 0000000000..7087a26302 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsPurgeWorkspaceStatus.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/Get-AzOperationalInsightsPurgeWorkspaceStatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsPurgeWorkspaceStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsPurgeWorkspaceStatus.md +--- + +# Get-AzOperationalInsightsPurgeWorkspaceStatus + +## SYNOPSIS +Gets status of an ongoing purge operation. + +## SYNTAX + +``` +Get-AzOperationalInsightsPurgeWorkspaceStatus [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-PurgeId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets status of an ongoing purge operation. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzOperationalInsightsPurgeWorkspaceStatus -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "MyWorkspace" -PurgeId "cd944bc7-ba11-447e-910c-c6393ac020a9" +``` + +This command gets the status of an ongoing purge operation by resource group name, workspace name and the purge id returned from New-AzOperationalInsightsPurgeWorkspace command. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PurgeId +In a purge status request, this is the Id of the operation the status of which is returned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that contains the table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspacePurgeStatusResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsSavedSearch.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsSavedSearch.md new file mode 100644 index 0000000000..5d61e5bc78 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsSavedSearch.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: FB2C47AD-E103-409E-A23B-BC316FA32E8C +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightssavedsearch +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsSavedSearch.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsSavedSearch.md +--- + +# Get-AzOperationalInsightsSavedSearch + +## SYNOPSIS +Returns all of the saved searches for a specified workspace. + +## SYNTAX + +``` +Get-AzOperationalInsightsSavedSearch [-ResourceGroupName] <String> [-WorkspaceName] <String> + [[-SavedSearchId] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzOperationalInsightsSavedSearch** cmdlet returns all of the saved searches for a specified workspace within the resource group specified if you do not specify a saved search ID. +If you do specify a saved search ID, then the saved search corresponding to that ID is returned. + +## EXAMPLES + +### Example 1: Get all saved searches for a workspace +```powershell +Get-AzOperationalInsightsSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" +``` + +This command gets all of the saved resources associated with a workspace. + +### Example 2: Get a specific saved search by ID +```powershell +Get-AzOperationalInsightsSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -SavedSearchId "ContosoSavedSearchId" +``` + +This command gets a specific saved search by its ID. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group that contains a workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SavedSearchId +Specifies a saved search ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies a workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSSearchListSavedSearchResponse + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSSavedSearchValue + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsSchema.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsSchema.md new file mode 100644 index 0000000000..2b461d9f75 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsSchema.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 6A834F26-C3D1-46DA-A4A6-1BB5B69291D0 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightsschema +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsSchema.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsSchema.md +--- + +# Get-AzOperationalInsightsSchema + +## SYNOPSIS +Returns the schema associated with a workspace. + +## SYNTAX + +``` +Get-AzOperationalInsightsSchema [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzOperationalInsightsSchema** cmdlet returns the schema associated with the specified workspace within that resource group. + +## EXAMPLES + +### Example 1: Get the schemas for a workspace +```powershell +Get-AzOperationalInsightsSchema -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" +``` + +This command gets the schemas associated with a workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group that contains a workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies a workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSSearchGetSchemaResponse + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsStorageInsight.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsStorageInsight.md new file mode 100644 index 0000000000..6d51904ef0 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsStorageInsight.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 29ABCC1B-8590-4243-A629-709F207927B4 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightsstorageinsight +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsStorageInsight.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsStorageInsight.md +--- + +# Get-AzOperationalInsightsStorageInsight + +## SYNOPSIS +Gets information about a Storage Insight. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +Get-AzOperationalInsightsStorageInsight [-ResourceGroupName] <String> [-WorkspaceName] <String> + [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +Get-AzOperationalInsightsStorageInsight [-Workspace] <PSWorkspace> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzOperationalInsightsStorageInsight** cmdlet gets information about an existing Storage Insight. +If a Storage Insight name is specified, this cmdlet gets information about that Storage Insight. +If you do not specify a name, this cmdlet gets information about all storage insights in a workspace. + +## EXAMPLES + +### Example 1: Get a Storage Insight by name +```powershell +Get-AzOperationalInsightsStorageInsight -Name "MyStorageInsight" -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" +``` + +This command gets the storage insight named MyStorageInsight from the workspace named ContosoWorkspace. + +### Example 2: Get a Storage Insight by using a workspace object +```powershell +$Workspace = Get-AzOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" +Get-AzOperationalInsightsStorageInsight -Workspace $Workspace -Name "MyStorageInsight" +``` + +The first command uses the **Get-AzOperationalInsightsWorkspace** cmdlet to get an Operational Insights workspace, and then stores it in the $Workspace variable. +The second command gets the storage insight named MyStorageInsight for the workspace in $Workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the Storage Insight name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies the workspace that contains the Storage Insights. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of the workspace that contains the Storage Insights. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSStorageInsight + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsTable.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsTable.md new file mode 100644 index 0000000000..0faff1da2c --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsTable.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightstable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsTable.md +--- + +# Get-AzOperationalInsightsTable + +## SYNOPSIS +Get or list tables for workspace. + +## SYNTAX + +``` +Get-AzOperationalInsightsTable [-ResourceGroupName] <String> [-WorkspaceName] <String> [[-TableName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list tables for a workspace, list tables under workspace when "-TableName" was not provided. + +## EXAMPLES + +### Example 1: Get all tables for a workspace +```powershell +Get-AzOperationalInsightsTable -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" +``` + +This command gets all of the tables associated with a workspace. + +### Example 2: Get a specific table by name +```powershell +Get-AzOperationalInsightsTable -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -tableName "ContosoSavedTableName" +``` + +This command gets a specific table by its name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +The table name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that contains the table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSTable + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsWorkspace.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsWorkspace.md new file mode 100644 index 0000000000..8c540bbc4a --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsWorkspace.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: F94415DA-1A4A-4D37-A626-1EDF5D1EFE74 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightsworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsWorkspace.md +--- + +# Get-AzOperationalInsightsWorkspace + +## SYNOPSIS +Gets information about a workspace. + +## SYNTAX + +``` +Get-AzOperationalInsightsWorkspace [[-ResourceGroupName] <String>] [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzOperationalInsightsWorkspace** cmdlet gets information about an existing workspace. +If you specify a workspace name, this cmdlet gets information about that workspace. +If you do not specify a name, this cmdlet gets information about all workspaces in a resource group. +If you do not specify a name and resource group, this cmdlet gets information about all workspaces in a subscription. + +## EXAMPLES + +### Example 1: Get a workspace by name +```powershell +Get-AzOperationalInsightsWorkspace -Name "MyWorkspace" -ResourceGroupName "ContosoResourceGroup" +``` + +This command gets a workspace named MyWorkspace in the resource group named ContosoResourceGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsWorkspaceManagementGroup.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsWorkspaceManagementGroup.md new file mode 100644 index 0000000000..759751f1fd --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsWorkspaceManagementGroup.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: F29E0B9C-2479-44FB-B196-EAF97B69E6A6 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightsworkspacemanagementgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsWorkspaceManagementGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsWorkspaceManagementGroup.md +--- + +# Get-AzOperationalInsightsWorkspaceManagementGroup + +## SYNOPSIS +Gets details of management groups connected to a workspace. + +## SYNTAX + +``` +Get-AzOperationalInsightsWorkspaceManagementGroup [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzOperationalInsightsWorkspaceManagementGroup** cmdlet lists the management groups that are connected to a workspace. + +## EXAMPLES + +### Example 1: Get management groups by workspace name +```powershell +Get-AzOperationalInsightsWorkspaceManagementGroup -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" +``` + +This command gets the management groups for the workspace named MyWorkspace in the resource group named ContosoResourceGroup. + +### Example 2: Get management groups by using the pipeline +```powershell +Get-AzOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" | Get-AzOperationalInsightsWorkspaceManagementGroup +``` + +This command uses the Get-AzOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkspace, and then passes the workspace to the current cmdlet, which gets the management groups for that workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSManagementGroup + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + +[Get-AzOperationalInsightsWorkspace](./Get-AzOperationalInsightsWorkspace.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsWorkspaceSharedKey.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsWorkspaceSharedKey.md new file mode 100644 index 0000000000..418e3a54d0 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsWorkspaceSharedKey.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 112D5C69-3F4F-4BB6-9DA4-52757146B0EF +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightsworkspacesharedkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsWorkspaceSharedKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsWorkspaceSharedKey.md +--- + +# Get-AzOperationalInsightsWorkspaceSharedKey + +## SYNOPSIS +Gets the shared keys for a workspace. + +## SYNTAX + +``` +Get-AzOperationalInsightsWorkspaceSharedKey [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzOperationalInsightsWorkspaceSharedKey** cmdlet lists the shared keys for a workspace. +The keys are used to connect Operational Insights agents to the workspace. + +## EXAMPLES + +### Example 1: Get shared keys by workspace name +```powershell +Get-AzOperationalInsightsWorkspaceSharedKey -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" +``` + +This command gets the shared keys for the workspace named MyWorkspace in the resource group named ContosoResourceGroup. + +### Example 2: Get shared keys by using the pipeline +```powershell +Get-AzOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" | Get-AzOperationalInsightsWorkspaceSharedKey +``` + +This command gets the workspace named MyWorkspace using the Get-AzOperationalInsightsWorkspace cmdlet, and then passes the workspace to the **Get-AzOperationalInsightsWorkspaceSharedKey** cmdlet. +The command gets the shared keys for that workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspaceKeys + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + +[Get-AzOperationalInsightsWorkspace](./Get-AzOperationalInsightsWorkspace.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsWorkspaceUsage.md b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsWorkspaceUsage.md new file mode 100644 index 0000000000..5cc174748e --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Get-AzOperationalInsightsWorkspaceUsage.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 818A048F-7CBE-4845-BBC2-6420CE48199A +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/get-azoperationalinsightsworkspaceusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsWorkspaceUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Get-AzOperationalInsightsWorkspaceUsage.md +--- + +# Get-AzOperationalInsightsWorkspaceUsage + +## SYNOPSIS +Gets the usage data for a workspace. + +## SYNTAX + +``` +Get-AzOperationalInsightsWorkspaceUsage [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzOperationalInsightsWorkspaceUsage** cmdlet retrieves the usage data for a workspace. +This exposes how much data has been analyzed by the workspace over a certain period. + +## EXAMPLES + +### Example 1: Get usage data by workspace name +```powershell +Get-AzOperationalInsightsWorkspaceUsage -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" +``` + +This command gets the usage details for the workspace named MyWorkspace in the specified resource group. + +### Example 2: Get usage data using the pipeline +```powershell +Get-AzOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" | Get-AzOperationalInsightsWorkspaceUsage +``` + +This command gets the workspace named MyWorkSpace using the Get-AzOperationalInsightsWorkspace cmdlet, and then passes the workspace to the current cmdlet. +The command gets the usage details for that workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSUsageMetric + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + +[Get-AzOperationalInsightsWorkspace](./Get-AzOperationalInsightsWorkspace.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Invoke-AzOperationalInsightsMigrateTable.md b/azps-10.1.0/Az.OperationalInsights/Invoke-AzOperationalInsightsMigrateTable.md new file mode 100644 index 0000000000..e18a7e2fe4 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Invoke-AzOperationalInsightsMigrateTable.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/Invoke-AzOperationalInsightsMigrateTable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Invoke-AzOperationalInsightsMigrateTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Invoke-AzOperationalInsightsMigrateTable.md +--- + +# Invoke-AzOperationalInsightsMigrateTable + +## SYNOPSIS +Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs. + +## SYNTAX + +``` +Invoke-AzOperationalInsightsMigrateTable [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-TableName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzOperationalInsightsMigrateTable -ResourceGroupName RG-NAME -WorkspaceName WORKSPACE-NAME -TableName TABLE-NAME +``` + +```output +True +``` + +Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +The table name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that will contain the storage insight. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Invoke-AzOperationalInsightsQuery.md b/azps-10.1.0/Az.OperationalInsights/Invoke-AzOperationalInsightsQuery.md new file mode 100644 index 0000000000..6e325723e7 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Invoke-AzOperationalInsightsQuery.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/invoke-azoperationalinsightsquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Invoke-AzOperationalInsightsQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Invoke-AzOperationalInsightsQuery.md +--- + +# Invoke-AzOperationalInsightsQuery + +## SYNOPSIS +Returns search results based on the specified parameters. + +## SYNTAX + +### ByWorkspaceId (Default) +``` +Invoke-AzOperationalInsightsQuery -WorkspaceId <String> -Query <String> [-Timespan <TimeSpan>] [-Wait <Int32>] + [-IncludeRender] [-IncludeStatistics] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +Invoke-AzOperationalInsightsQuery -Workspace <PSWorkspace> -Query <String> [-Timespan <TimeSpan>] + [-Wait <Int32>] [-IncludeRender] [-IncludeStatistics] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzOperationalInsightsQuery** cmdlet returns the search results based on the specified parameters. +You can access the status of the search in the Metadata property of the returned object. +If the status is Pending, then the search has not completed, and the results will be from the archive. +You can retrieve the results of the search from the Value property of the returned object. +Please check detail of general query limits here: +https://learn.microsoft.com/azure/azure-monitor/service-limits#log-queries-and-language. + +## EXAMPLES + +### Example 1: Get search results using a query +```powershell +$query = "union * | take 10" +$queryResults = Invoke-AzOperationalInsightsQuery -WorkspaceId "63613592-b6f7-4c3d-a390-22ba13102111" -Query $query +$queryResults.Results +``` + +Once invoked, $queryResults.Results will contain all of the resulting rows from your query. + +### Example 2: Convert $results.Result IEnumerable to an array +```powershell +$query = "union * | take 10" +$queryResults = Invoke-AzOperationalInsightsQuery -WorkspaceId "63613592-b6f7-4c3d-a390-22ba13102111" -Query $query +$resultsArray = [System.Linq.Enumerable]::ToArray($queryResults.Results) +``` + +Some queries can result in very large data sets being returned. Because of this, the default behavior of the cmdlet is to return an IEnumerable to reduce memory costs. If you'd prefer to have an array of results, you can use the LINQ Enumerable.ToArray() extension method to convert the IEnumerable to an array. + +### Example 3: Get search results using a query over a specific timeframe +```powershell +$query = "union * | take 10" +$queryResults = Invoke-AzOperationalInsightsQuery -WorkspaceId "63613592-b6f7-4c3d-a390-22ba13102111" -Query $query -Timespan (New-TimeSpan -Hours 24) +$queryResults.Results +``` + +The results from this query will be limited to the past 24 hours. + +### Example 4: Include render & statistics in query result +```powershell +$query = "union * | take 10" +$queryResults = Invoke-AzOperationalInsightsQuery -WorkspaceId "63613592-b6f7-4c3d-a390-22ba13102111" -Query $query -IncludeRender -IncludeStatistics +$queryResults.Results + +$queryResults.Render + +$queryResults.Statistics +``` + +See [https://dev.loganalytics.io/documentation/Using-the-API/RequestOptions](https://dev.loganalytics.io/documentation/Using-the-API/RequestOptions) for details on the render and statistics info. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeRender +If specified, rendering information for metric queries will be included in the response. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeStatistics +If specified, query statistics will be included in the response. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +The query to execute. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timespan +The timespan to bound the query by. + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Puts an upper bound on the amount of time the server will spend processing the query. +See: https://dev.loganalytics.io/documentation/Using-the-API/Timeouts + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workspace +The workspace + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceId +The workspace ID. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSQueryResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsApplicationInsightsDataSource.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsApplicationInsightsDataSource.md new file mode 100644 index 0000000000..b09fe79c5c --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsApplicationInsightsDataSource.md @@ -0,0 +1,272 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: E3D7A3FE-40D4-4495-BA39-493F85F304AD +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightsapplicationinsightsdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsApplicationInsightsDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsApplicationInsightsDataSource.md +--- + +# New-AzOperationalInsightsApplicationInsightsDataSource + +## SYNOPSIS +Collect logs from given Application-Insights application. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +New-AzOperationalInsightsApplicationInsightsDataSource [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObjectByApplicationParameters +``` +New-AzOperationalInsightsApplicationInsightsDataSource [-Workspace] <PSWorkspace> + -ApplicationSubscriptionId <String> -ApplicationResourceGroupName <String> -ApplicationName <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObjectByApplicationResourceId +``` +New-AzOperationalInsightsApplicationInsightsDataSource [-Workspace] <PSWorkspace> + -ApplicationResourceId <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByWorkspaceNameByApplicationParameters +``` +New-AzOperationalInsightsApplicationInsightsDataSource [-ResourceGroupName] <String> [-WorkspaceName] <String> + -ApplicationSubscriptionId <String> -ApplicationResourceGroupName <String> -ApplicationName <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceNameByApplicationResourceId +``` +New-AzOperationalInsightsApplicationInsightsDataSource [-ResourceGroupName] <String> [-WorkspaceName] <String> + -ApplicationResourceId <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzOperationalInsightsApplicationInsightsDataSource** cmdlet enables the collection of logs from a given Application-Insights application. + +## EXAMPLES + +### Example 1: Create application-insights data source in workspace +```powershell +New-AzOperationalInsightsApplicationInsightsDataSource -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "MyWorkspace" -ApplicationSubscriptionId "e791a474-ee54-46a2-bb06-5e058302d234" -ApplicationResourceGroupName "ContosoResourceGroup" -ApplicationName "MyAIApplication" +``` + +```output +Name : subscriptions/e791a474-ee54-46a2-bb06-5e058302d234/resourceGroups/ContosoResourceGroup/providers/microsoft.insights/components/MyAIApplication +ResourceGroupName : ContosoResourceGroup +WorkspaceName : MyWorkspace +ResourceId : /subscriptions/e791a474-ee54-46a2-bb06-5e058302d234/resourceGroups/ContosoResourceGroup/providers/Microsoft.OperationalInsights/workspaces/MyWorkspace/datasources/subscriptions/e791a474-ee54-46a2-bb06-5e058302d234/resourceGroups/ContosoResourceGroup/providers/microsoft.insights/components/MyAIApplication +Kind : ApplicationInsights +Properties : {"linkedResourceId":"subscriptions/e791a474-ee54-46a2-bb06-5e058302d234/resourceGroups/ContosoResourceGroup/providers/microsoft.insights/components/MyAIApplication","status":"Succeeded"} +``` + +This command creates an application-insights data source of a given application in a given log analytics workspace. This enables the collection of logs from given application to the log analytics workspace. + +### Example 2: Get workspace object and create application-insights data source by the application resource id +```powershell +Get-AzOperationalInsightsWorkspace -Name "MyWorkspace" -ResourceGroupName "ContosoResourceGroup" | New-AzOperationalInsightsApplicationInsightsDataSource -ApplicationResourceId "/subscriptions/e791a474-ee54-46a2-bb06-5e058302d234/resourceGroups/ContosoResourceGroup/providers/microsoft.insights/components/MyAIApplication" +``` + +```output +Name : subscriptions/aaaaa474-ee54-4aaa-bb06-5e058302daaa/resourceGroups/ContosoResourceGroup/providers/microsoft.insights/components/MyAIApplication +ResourceGroupName : ContosoResourceGroup +WorkspaceName : MyWorkspace +ResourceId : /subscriptions/aaaaa474-ee54-4aaa-bb06-5e058302daaa/resourceGroups/ContosoResourceGroup/providers/Microsoft.OperationalInsights/workspaces/MyWorkspace/datasources/subscriptions/e791a474-ee54-46a2-bb06-5e058302d234/resourceGroups/ContosoResourceGroup/providers/microsoft.insights/components/MyAIApplication +Kind : ApplicationInsights +Properties : {"linkedResourceId":"subscriptions/e791a474-ee54-46a2-bb06-5e058302d234/resourceGroups/ContosoResourceGroup/providers/microsoft.insights/components/MyAIApplication","status":"Succeeded"} +``` + +This command demonstrates getting a log analytics workspace object and then passing the output to create an associated application-insights data source by the application resource id. + +## PARAMETERS + +### -ApplicationName +The name of the linked application. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceObjectByApplicationParameters, ByWorkspaceNameByApplicationParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationResourceGroupName +The resource group name of the linked application. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceObjectByApplicationParameters, ByWorkspaceNameByApplicationParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationResourceId +The linked application resource id. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceObjectByApplicationResourceId, ByWorkspaceNameByApplicationResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationSubscriptionId +The subscription id of the linked application. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceObjectByApplicationParameters, ByWorkspaceNameByApplicationParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceNameByApplicationParameters, ByWorkspaceNameByApplicationResourceId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +The workspace that will contain the data source. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObjectByApplicationParameters, ByWorkspaceObjectByApplicationResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that will contain the data source. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceNameByApplicationParameters, ByWorkspaceNameByApplicationResourceId +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsAzureActivityLogDataSource.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsAzureActivityLogDataSource.md new file mode 100644 index 0000000000..f1325c85a1 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsAzureActivityLogDataSource.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: B4EC9132-8DB9-498D-8B3F-2AB51D8EA03A +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightsazureactivitylogdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsAzureActivityLogDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsAzureActivityLogDataSource.md +--- + +# New-AzOperationalInsightsAzureActivityLogDataSource + +## SYNOPSIS +Collect Azure Activity log from given subscription. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +New-AzOperationalInsightsAzureActivityLogDataSource [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-Name] <String> [-SubscriptionId] <String> [-BackfillStartTime <DateTimeOffset>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +New-AzOperationalInsightsAzureActivityLogDataSource [-Workspace] <PSWorkspace> [-Name] <String> + [-SubscriptionId] <String> [-BackfillStartTime <DateTimeOffset>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzOperationalInsightsAzureActivityLogDataSource cmdlet enables Log Analytics to collect Azure activity log from given subscription. + +## EXAMPLES + +### Example 1 +```powershell +New-AzOperationalInsightsAzureActivityLogDataSource -ResourceGroupName testrg -WorkspaceName LogAnalyticsworkspace -Name test -SubscriptionId 0b1f6471-1bf0-4dda-aec3-cb9272f09590 +``` + +```output +Name : test +ResourceGroupName : testrg +WorkspaceName : LogAnalyticsworkspace +ResourceId : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/testrg/providers/Microsoft.OperationalInsights/workspaces/LogAnalyticsworkspace/datasources/test +Kind : AzureActivityLog +Properties : {"linkedResourceId":"/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/providers/microsoft.insights/eventtypes/management","backfillStartTime":"0001-01-01T00:00:00+00:00"} +``` + +This command enables Log Analytics to collect Azure activity log from given subscription. + +## PARAMETERS + +### -BackfillStartTime +You can choose to backfill logs from a week ago. + +```yaml +Type: System.DateTimeOffset +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +### System.DateTimeOffset + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsCluster.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsCluster.md new file mode 100644 index 0000000000..ae50e6485d --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsCluster.md @@ -0,0 +1,332 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsCluster.md +--- + +# New-AzOperationalInsightsCluster + +## SYNOPSIS +Create cluster + +## SYNTAX + +``` +New-AzOperationalInsightsCluster [-ResourceGroupName] <String> [-ClusterName] <String> [-Location] <String> + [-IdentityType <String>] [-SkuName <String>] -SkuCapacity <Int64> [-Tag <Hashtable>] [-KeyVaultUri <String>] + [-KeyName <String>] [-KeyVersion <String>] [-IsAvailabilityZonesEnabled <Boolean>] + [-IsDoubleEncryptionEnabled <Boolean>] [-BillingType <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +Create cluster + +## EXAMPLES + +### Example 1 +```powershell +New-AzOperationalInsightsCluster -ResourceGroupName "rg-name" -ClusterName "cluster-name" -Location eastus -IdentityType SystemAssigned -SkuName CapacityReservation -SkuCapacity 1000 +``` + +```output +Identity : Microsoft.Azure.Commands.OperationalInsights.Models.PSIdentity +Sku : Microsoft.Azure.Commands.OperationalInsights.Models.PSClusterSku +ClusterId : {cluster-id} +ProvisioningState : Succeeded +IsDoubleEncryptionEnabled : True +IsAvailabilityZonesEnabled : False +BillingType : Cluster +KeyVaultProperties : Microsoft.Azure.Commands.OperationalInsights.Models.PSKeyVaultProperties +LastModifiedDate : +CreatedDate : +AssociatedWorkspaces : {workspaces} +CapacityReservationProperties : Microsoft.Azure.Management.OperationalInsights.Models.CapacityReservationProperties +Location : South Central US +Id : /subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.OperationalInsights/clusters/{cluster-name} +Name : {cluster-name} +Type : Microsoft.OperationalInsights/clusters +Tags : {} +``` + +Create cluster + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingType +Billing type can be set as 'Cluster' or 'Workspaces' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Cluster, Workspaces + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The cluster name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +the identity type, value can be 'SystemAssigned', 'None', 'UserAssigned'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: SystemAssigned, None, UserAssigned + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAvailabilityZonesEnabled +Flag for availability Zones,can be set to true only in supported regions + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDoubleEncryptionEnabled +Flag for Double Encryption, can be set to true only in supported regions + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +Key Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultUri +Key Vault Uri + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVersion +Key Version + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geographic region that the cluster will be deployed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Sku Capacity, value need to be multiple of 100 and at least 1000. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Sku Name, now can be 'CapacityReservation' only + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: CapacityReservation + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags of the cluster + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsComputerGroup.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsComputerGroup.md new file mode 100644 index 0000000000..dc29c33249 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsComputerGroup.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: E68E90B3-0B6A-49E9-83CD-E73826571B04 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightscomputergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsComputerGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsComputerGroup.md +--- + +# New-AzOperationalInsightsComputerGroup + +## SYNOPSIS +Creates a computer group. + +## SYNTAX + +``` +New-AzOperationalInsightsComputerGroup [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-SavedSearchId] <String> [-DisplayName] <String> [-Category] <String> [-Query] <String> [[-Version] <Int64>] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzOperationalInsightsComputerGroup** cmdlet creates a computer group in a resource group and location. + +## EXAMPLES + +### Example 1 + +Creates a computer group. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzOperationalInsightsComputerGroup -Category 'ContosoSavedSearchCategory' -DisplayName 'ContosoSavedSearchDisplayName' -Query 'Type=Event' -ResourceGroupName myresourcegroup -SavedSearchId 'ContosoSavedSearchId' -Version 1 -WorkspaceName <String> +``` + +## PARAMETERS + +### -Category +Specifies the category of the computer group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies the display name of the computer group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Specifies the query of the computer group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +The cmdlet creates computer group in this resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SavedSearchId +Specifies the ID of the computer group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Specifies the version. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: 1 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Int64 + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSSavedSearchValue + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsCustomLogDataSource.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsCustomLogDataSource.md new file mode 100644 index 0000000000..4bbc667e86 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsCustomLogDataSource.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 6A08AF7C-1E18-40A1-B21E-12F94823D304 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightscustomlogdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsCustomLogDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsCustomLogDataSource.md +--- + +# New-AzOperationalInsightsCustomLogDataSource + +## SYNOPSIS +Defines a custom log collection policy. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +New-AzOperationalInsightsCustomLogDataSource [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-Name] <String> [-CustomLogRawJson] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +New-AzOperationalInsightsCustomLogDataSource [-Workspace] <PSWorkspace> [-Name] <String> + [-CustomLogRawJson] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzOperationalInsightsCustomLogDataSource** cmdlet defines a custom log collection policy. + +## EXAMPLES + +### Example 1: Defines a custom log collection policy + +```powershell +$customLogRawJson = '{"customLogName":"Validation_CL","description":"test","inputs":[{"location":{"fileSystemLocations":{"linuxFileTypeLogPaths":null,"windowsFileTypeLogPaths":["C:\\e2e\\Evan\\ArubaSECURITY\\*.log"]}},"recordDelimiter":{"regexDelimiter":{"pattern":"\\n","matchIndex":0}}}],"extractions":[{"extractionName":"TimeGenerated","extractionType":"DateTime","extractionProperties":{"dateTimeExtraction":{"regex":"((\\d{2})|(\\d{4}))-([0-1]\\d)-(([0-3]\\d)|(\\d))\\s((\\d)|([0-1]\\d)|(2[0-4])):[0-5][0-9]:[0-5][0-9]","joinStringRegex":null}}}]}' +New-AzOperationalInsightsCustomLogDataSource -ResourceGroupName rg-name -WorkspaceName workspace-name -CustomLogRawJson $customLogRawJson -Name "MyCustomLog" +``` + +```output +Name : MyCustomLog +ResourceGroupName : rg-name +WorkspaceName : workspace-name +ResourceId : /subscriptions/sub-id/resourceGroups/rg-name/providers/Microsoft.OperationalInsights/workspaces/workspace-name/datasources/MyCustomLog +Kind : CustomLog +Properties : {"customLogName":"Validation_CL","description":"test","extractions":[{"extractionName":"TimeGenerated","extractionProperties":{"dateTimeExtraction":{"joinStringRegex":null,"regex":[{"m + atchIndex":0,"numberdGroup":null,"pattern":"((\\d{2})|(\\d{4}))-([0-1]\\d)-(([0-3]\\d)|(\\d))\\s((\\d)|([0-1]\\d)|(2[0-4])):[0-5][0-9]:[0-5][0-9]"}],"formatString":null}},"extractionTy + pe":"DateTime"}],"inputs":[{"location":{"fileSystemLocations":{"linuxFileTypeLogPaths":null,"windowsFileTypeLogPaths":["C:\\e2e\\Evan\\ArubaSECURITY\\*.log"]}},"recordDelimiter":{"rege + xDelimiter":{"matchIndex":0,"numberdGroup":null,"pattern":"\\n"}}}]} +``` + +The response recieved after defining a custom log collection policy + +## PARAMETERS + +### -CustomLogRawJson +Specifies the custom collection policy as a raw JavaScript Object Notation (JSON) string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the data source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES + +## RELATED LINKS + +[Disable-AzOperationalInsightsLinuxCustomLogCollection](./Disable-AzOperationalInsightsLinuxCustomLogCollection.md) + +[Enable-AzOperationalInsightsLinuxCustomLogCollection](./Enable-AzOperationalInsightsLinuxCustomLogCollection.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsDataExport.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsDataExport.md new file mode 100644 index 0000000000..791a0706ed --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsDataExport.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightsdataexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsDataExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsDataExport.md +--- + +# New-AzOperationalInsightsDataExport + +## SYNOPSIS +Create data export for workspace. + +## SYNTAX + +``` +New-AzOperationalInsightsDataExport [-ResourceGroupName] <String> [-WorkspaceName] <String> + [[-DataExportName] <String>] [[-TableName] <String[]>] [-ResourceId <String>] [-EventHubName <String>] + [-Enable <Boolean>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates data export for a workspace. + +## EXAMPLES + +### Example 1 +```powershell +New-AzOperationalInsightsDataExport -ResourceGroupName "rg-name" -WorkspaceName "workspace-name" -DataExportName "dataExportName" -TableName "table_name" -ResourceId "resource_id" +``` + +```output +Name : {dataExportName} +Id : /subscriptions/{subscription}/resourcegroups/{rg-name}/providers/microsoft.operationalinsights/workspaces/{workspace-name}/dataexports/{dataExportName} +DataExportId : {GUID} +TableNames : {table_name} +ResourceId : /subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.EventHub/namespaces/{eventHub_namespace} +DataExportType : EventHub +EventHubName : +Enable : True +CreatedDate : +LastModifiedDate : +``` + +Creates data export for a workspace. + +## PARAMETERS + +### -DataExportName +The table name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Active when enabled. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +Optional. +Allows to define an Event Hub name. +Not applicable when destination is Storage Account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The destination resource ID. +This can be copied from the Properties entry of the destination resource in Azure. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableName +An array of tables to export, for example: ["Heartbeat, SecurityEvent"]. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that will contain the storage insight. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataExport + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsLinkedStorageAccount.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsLinkedStorageAccount.md new file mode 100644 index 0000000000..8c91f5deb5 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsLinkedStorageAccount.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightslinkedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsLinkedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsLinkedStorageAccount.md +--- + +# New-AzOperationalInsightsLinkedStorageAccount + +## SYNOPSIS +Create linked storage account for workspace + +## SYNTAX + +``` +New-AzOperationalInsightsLinkedStorageAccount [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DataSourceType] <String> [-StorageAccountId] <String[]> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create linked storage account for workspace + +## EXAMPLES + +### Example 1 +```powershell +$account = Get-AzStorageAccount -ResourceGroupName "rg-name" -Name "storage-account" + +New-AzOperationalInsightsLinkedStorageAccount -ResourceGroupName "rg-name" -WorkspaceName "workspace-name" -DataSourceType CustomLogs -StorageAccountId $account.Id +``` + +```output +Id : /subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.OperationalInsights/workspaces/{workspace-name}/linkedStorageAccounts/CustomLogs +Name : customlogs +Type : Microsoft.OperationalInsights/workspaces/linkedStorageAccounts +DataSourceType : CustomLogs +StorageAccountIds : {/subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.Storage/storageAccounts/{storage-account}} +``` + +Add linked storage for workspace + +## PARAMETERS + +### -DataSourceType +Data Source Type should be one of 'CustomLogs', 'AzureWatson'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: CustomLogs, AzureWatson, Query, Alerts + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountId +list of storage account Id. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSLinkedStorageAccountsResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsLinuxPerformanceObjectDataSource.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsLinuxPerformanceObjectDataSource.md new file mode 100644 index 0000000000..0af627f4d7 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsLinuxPerformanceObjectDataSource.md @@ -0,0 +1,264 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: F94F3FA8-08FD-4B25-B634-8E2EEBDDE36E +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightslinuxperformanceobjectdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsLinuxPerformanceObjectDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsLinuxPerformanceObjectDataSource.md +--- + +# New-AzOperationalInsightsLinuxPerformanceObjectDataSource + +## SYNOPSIS +Adds performance counters to all Linux computers in a workspace. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +New-AzOperationalInsightsLinuxPerformanceObjectDataSource [-ResourceGroupName] <String> + [-WorkspaceName] <String> [-Name] <String> [-ObjectName] <String> [-CounterNames] <String[]> + [-InstanceName <String>] [-IntervalSeconds <Int32>] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +New-AzOperationalInsightsLinuxPerformanceObjectDataSource [-Workspace] <PSWorkspace> [-Name] <String> + [-ObjectName] <String> [-CounterNames] <String[]> [-InstanceName <String>] [-IntervalSeconds <Int32>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzOperationalInsightsLinuxPerformanceObjectDataSource** cmdlet adds performance counters from which Azure Operational Insights collects data to all Linux computers in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +New-AzOperationalInsightsLinuxPerformanceObjectDataSource -ResourceGroupName testrg -WorkspaceName LogAnalyticsWorkspace -Name performance -ObjectName object -CounterNames counter +``` + +```output +Name : performance +ResourceGroupName : testrg +WorkspaceName : LogAnalyticsWorkspace +ResourceId : /subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/resourceGroups/testrg/providers/Microsoft.Ope + rationalInsights/workspaces/LogAnalyticsWorkspace/datasources/performance +Kind : LinuxPerformanceObject +Properties : {"objectName":"object","instanceName":"*","intervalSeconds":15,"performanceCounters":[{"counterName + ":"counter"}]} +``` + +Add performance counters from which Azure Operational Insights collects data to all Linux computers in a workspace + +## PARAMETERS + +### -CounterNames +Specifies an array of names of counters. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Specifies an instance name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IntervalSeconds +Specifies the interval of collection. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the data source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ObjectName +Specifies the name of an object. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains Linux computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +### System.String[] + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES + +## RELATED LINKS + +[Disable-AzOperationalInsightsLinuxPerformanceCollection](./Disable-AzOperationalInsightsLinuxPerformanceCollection.md) + +[Enable-AzOperationalInsightsLinuxPerformanceCollection](./Enable-AzOperationalInsightsLinuxPerformanceCollection.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsLinuxSyslogDataSource.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsLinuxSyslogDataSource.md new file mode 100644 index 0000000000..7db512e8e7 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsLinuxSyslogDataSource.md @@ -0,0 +1,362 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: D6CBDF09-E243-425B-8677-256163A6DFBF +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightslinuxsyslogdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsLinuxSyslogDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsLinuxSyslogDataSource.md +--- + +# New-AzOperationalInsightsLinuxSyslogDataSource + +## SYNOPSIS +Adds a data source to Linux computers. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +New-AzOperationalInsightsLinuxSyslogDataSource [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-Name] <String> [-Facility] <String> [-CollectEmergency] [-CollectAlert] [-CollectCritical] [-CollectError] + [-CollectWarning] [-CollectNotice] [-CollectDebug] [-CollectInformational] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +New-AzOperationalInsightsLinuxSyslogDataSource [-Workspace] <PSWorkspace> [-Name] <String> [-Facility] <String> + [-CollectEmergency] [-CollectAlert] [-CollectCritical] [-CollectError] [-CollectWarning] [-CollectNotice] + [-CollectDebug] [-CollectInformational] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzOperationalInsightsLinuxSyslogDataSource** cmdlet adds a syslog data source to connected Linux computers in a workspace. +Azure Operational Insights can collect syslog data. + +## EXAMPLES + +### Example 1: Create syslog data sources +```powershell +$FacilityNames = @() +$FacilityNames += 'auth' +$FacilityNames += 'authpriv' +$FacilityNames += 'cron' +$FacilityNames += 'daemon' +$FacilityNames += 'ftp' +$FacilityNames += 'kern' +$FacilityNames += 'mail' +$FacilityNames += 'syslog' +$FacilityNames += 'user' +$FacilityNames += 'uucp' +$ResourceGroupName = 'MyResourceGroup' +$WorkspaceName = 'MyWorkspaceName' + +$Count = 0 +foreach ($FacilityName in $FacilityNames) { + $Count++ + $null = New-AzOperationalInsightsLinuxSyslogDataSource ` + -ResourceGroupName $ResourceGroupName ` + -WorkspaceName $WorkspaceName ` + -Name "Linux-syslog-$($Count)" ` + -Facility $FacilityName ` + -CollectEmergency ` + -CollectAlert ` + -CollectCritical ` + -CollectError ` + -CollectWarning ` + -CollectNotice ` + -CollectDebug ` + -CollectInformational +} + +Get-AzOperationalInsightsDataSource ` + -ResourceGroupName $ResourceGroupName ` + -WorkspaceName $WorkspaceName ` + -Kind 'LinuxSyslog' +``` + +Adds a syslog data source to connected Linux computers in a workspace. +Azure Operational Insights can collect syslog data. + +## PARAMETERS + +### -CollectAlert +Indicates that Operational Insights collects alert messages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectCritical +Indicates that Operational Insights collects critical messages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectDebug +Indicates that Operational Insights collects debug messages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectEmergency +Indicates that Operational Insights collects emergency messages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectError +Indicates that Operational Insights collects error messages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectInformational +Indicates that Operational Insights collects informational messages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectNotice +Indicates that Operational Insights collects notice messages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectWarning +Indicates that the syslog includes warning messages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Facility +Specifies a facility code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the data source. The name is not exposed in the Azure Portal and any string can be used as long as it is unique. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains Linux computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES + +## RELATED LINKS + +[Disable-AzOperationalInsightsLinuxSyslogCollection](./Disable-AzOperationalInsightsLinuxSyslogCollection.md) + +[Enable-AzOperationalInsightsLinuxSyslogCollection](./Enable-AzOperationalInsightsLinuxSyslogCollection.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsPurgeWorkspace.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsPurgeWorkspace.md new file mode 100644 index 0000000000..1775590ee0 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsPurgeWorkspace.md @@ -0,0 +1,269 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/New-AzOperationalInsightsPurgeWorkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsPurgeWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsPurgeWorkspace.md +--- + +# New-AzOperationalInsightsPurgeWorkspace + +## SYNOPSIS +Purges data in an Log Analytics workspace by a set of user-defined filters + +## SYNTAX + +### CreateByNameParameterSet (Default) +``` +New-AzOperationalInsightsPurgeWorkspace [-ResourceGroupName] <String> [-WorkspaceName] <String> + -Column <String> -OperatorProperty <String> [-Value <Object>] [-Key <String>] -Table <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByObjectParameterSet +``` +New-AzOperationalInsightsPurgeWorkspace [-ResourceGroupName] <String> [-WorkspaceName] <String> + -PurgeBody <PSWorkspacePurgeBody> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Purges data in an Log Analytics workspace by a set of user-defined filters + +## EXAMPLES + +### Example 1 +```powershell +New-AzOperationalInsightsPurgeWorkspace -ResourceGroupName dabenham-dev -WorkspaceName dabenham-troubleShootingE2E -Column "Column_Name" -OperatorProperty "Operator" -Value "Value" -key "Key" -Table "Table_Name" +``` + +Purges data in an Log Analytics workspace's table + +## PARAMETERS + +### -Column +The column of the table over which the given query should run + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Key +When filtering over custom dimensions, this key will be used as the name of the custom dimension. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OperatorProperty +A query operator to evaluate over the provided column and value(s). +Supported operators are ==, =~, in, in~, \>, \>=, \<, \<=, between, and have the same behavior as they would in a KQL query. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PurgeBody +Specifies the table and filters to be purged. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspacePurgeBody +Parameter Sets: CreateByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: CreateByObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Table +Table name from which to purge data. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Value +the value for the operator to function over. +This can be a number (e.g., \> 100), a string (timestamp \>= '2017-09-01') or array of values. + +```yaml +Type: System.Object +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace to purge. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: CreateByObjectParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Object + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspacePurgeBody + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspacePurgeResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsRestoreTable.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsRestoreTable.md new file mode 100644 index 0000000000..b6f9e91141 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsRestoreTable.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightsrestoretable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsRestoreTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsRestoreTable.md +--- + +# New-AzOperationalInsightsRestoreTable + +## SYNOPSIS +Create a new Restore table + +## SYNTAX + +``` +New-AzOperationalInsightsRestoreTable [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-TableName] <String> -StartRestoreTime <String> -EndRestoreTime <String> -SourceTable <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a Restore table + +## EXAMPLES + +### Example 1 +```powershell +New-AzOperationalInsightsRestoreTable -ResourceGroupName RG-NAME -WorkspaceName WORKSPACE-NAME -TableName TABLE-NAME -StartRestoreTime "05-25-2022 12:26:36" -EndRestoreTime "05-28-2022 12:26:36" -SourceTable "Usage" +``` + +```output +TableName : TABLE-NAME +ResourceId : /subscriptions/SUBSCRIPTION-ID/resourcegroups/RG-NAME/providers/Microsoft.OperationalInsights/workspaces/WORKSPACE-NAME/tables/TABLE-NAME +RetentionInDays : +TotalRetentionInDays : +Plan : Analytics +Description : +Schema : Microsoft.Azure.Management.OperationalInsights.Models.Schema +ProvisioningState : Succeeded +ResourceGroupName : RG-NAME +WorkspaceName : WORKSPACE-NAME +``` + +Create a Restore table + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndRestoreTime +The timestamp to end the restore by (UTC). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceTable +The table to restore data from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartRestoreTime +The timestamp to start the restore from (UTC). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +The table name. +For Restore table the name should end with '_RST' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that will contain the storage insight. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSTable + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsSavedSearch.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsSavedSearch.md new file mode 100644 index 0000000000..90c147cc41 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsSavedSearch.md @@ -0,0 +1,269 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: DFEB9EA3-574A-463B-8B70-46D76ABCA84D +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightssavedsearch +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsSavedSearch.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsSavedSearch.md +--- + +# New-AzOperationalInsightsSavedSearch + +## SYNOPSIS +Creates a new saved search with the specified parameters. + +## SYNTAX + +``` +New-AzOperationalInsightsSavedSearch [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-SavedSearchId] <String> [-DisplayName] <String> [-Category] <String> [-Query] <String> [[-Tag] <Hashtable>] + [[-Version] <Int64>] [[-FunctionAlias] <String>] [[-FunctionParameter] <String>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzOperationalInsightsSavedSearch** cmdlet creates a new saved search with the specified parameters for the workspace. + +## EXAMPLES + +### Example 1: Create a new saved search +```powershell +New-AzOperationalInsightsSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -SavedSearchId "ContosoSavedSearchId" -DisplayName "ContosoSavedSearchDisplayName" -Category "ContosoSavedSearchCategory" -Query "*" -Version 1 -Force +``` + +This command creates a new saved search. + +## PARAMETERS + +### -Category +The saved search category. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The saved search display name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunctionAlias +The function alias if query serves as a function. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunctionParameter +The optional function parameters if query serves as a function. +Value should be in the following format: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. +For more examples and proper syntax please refer to https://learn.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FunctionParameters + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +The saved search query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SavedSearchId +The saved search id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The saved search tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +The saved search version. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +The workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Int64 + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSSavedSearchValue + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsSearchTable.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsSearchTable.md new file mode 100644 index 0000000000..b1cec0763a --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsSearchTable.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightssearchtable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsSearchTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsSearchTable.md +--- + +# New-AzOperationalInsightsSearchTable + +## SYNOPSIS +Create a Search table + +## SYNTAX + +``` +New-AzOperationalInsightsSearchTable [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-TableName] <String> [[-RetentionInDays] <Int32>] [-TotalRetentionInDays <Int32>] -SearchQuery <String> + -StartSearchTime <String> -EndSearchTime <String> [-Limit <Int32>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a Search table + +## EXAMPLES + +### Example 1 +```powershell +New-AzOperationalInsightsSearchTable -ResourceGroupName RG-NAME -WorkspaceName WORKSPACE-NAME -TableName TABLE-NAME -SearchQuery "Heartbeat" -StartSearchTime "05-27-2022 12:26:36" -EndSearchTime "05-28-2022 12:26:36" +``` + +```output +TableName : tableName_SRCH +ResourceId : /subscriptions/subscriptionID/resourcegroups/RG-NAME/providers/Microsoft.OperationalInsights/workspaces/WORKSPACE-NAME/tables/TABLE-NAME +RetentionInDays : 30 +TotalRetentionInDays : 30 +Plan : Analytics +Description : +Schema : Microsoft.Azure.Management.OperationalInsights.Models.Schema +ProvisioningState : Succeeded +ResourceGroupName : rgName +WorkspaceName : wsName +``` + +Creates a Search table + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndSearchTime +The timestamp to end the search by (UTC). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Limit +Limit the search job to return up to specified number of rows. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionInDays +The table retention in days, between 4 and 730. +Setting this property to -1 will default to the workspace retention + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SearchQuery +Search job query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartSearchTime +The timestamp to start the search from (UTC). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +The table name. +For Search table the name should end with '_SRCH' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TotalRetentionInDays +The table total retention in days, between 4 and 2555. +Setting this property to -1 will default to table retention. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that will contain the storage insight. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSTable + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsStorageInsight.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsStorageInsight.md new file mode 100644 index 0000000000..33a530451a --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsStorageInsight.md @@ -0,0 +1,307 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 7660F1A2-604D-4488-93F1-CB7C502F135E +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightsstorageinsight +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsStorageInsight.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsStorageInsight.md +--- + +# New-AzOperationalInsightsStorageInsight + +## SYNOPSIS +Creates a Storage Insight inside a workspace. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +New-AzOperationalInsightsStorageInsight [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-Name] <String> [-StorageAccountResourceId] <String> [-StorageAccountKey] <String> [[-Tables] <String[]>] + [[-Containers] <String[]>] [-ETag <String>] [-Tag <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +New-AzOperationalInsightsStorageInsight [-Workspace] <PSWorkspace> [-Name] <String> + [-StorageAccountResourceId] <String> [-StorageAccountKey] <String> [[-Tables] <String[]>] + [[-Containers] <String[]>] [-ETag <String>] [-Tag <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzOperationalInsightsStorageInsight** cmdlet creates a new Storage Insight in an existing workspace. + +## EXAMPLES + +### Example 1: Create a Storage Insight by name +```powershell +$Storage = Get-AzStorageAccount -ResourceGroupName "ContosoResourceGroup" -Name "ContosoStorage" + +$StorageKey = ($Storage | Get-AzStorageAccountKey).Value[0] + +New-AzOperationalInsightsStorageInsight -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "MyWorkspace" -Name "MyStorageInsight" -StorageAccountResourceId $Storage.Id -StorageAccountKey $StorageKey -Tables @("WADWindowsEventLogsTable") +``` + +The first command uses the Get-AzStorageAccount cmdlet to get the storage account named ContosoStorage, and then stores it in the $Storage variable. +The second command passes the storage account in $Storage to the Get-AzStorageAccountKey cmdlet by using the pipeline operator to get the specified storage account key, and then stores it in the $StorageKey variable. This example retrieves the first key. To retrieve the other one, use Value[1] instead of Value[0]. +The final command creates a storage insight named MyStorageInsight in the workspace named MyWorkspace. +This storage insight consumes data from the WADWindowsEventLogsTable table in the specified storage account resource. + +### Example 2: Create a Storage Insight by using a workspace object +```powershell +$Workspace = Get-AzOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" + +$Storage = Get-AzStorageAccount -ResourceGroupName "ContosoResourceGroup" -Name "ContosoStorage" + +$StorageKey = ($Storage | Get-AzStorageAccountKey).Value[0] + +New-AzOperationalInsightsStorageInsight -Workspace $Workspace -Name "MyStorageInsight" -StorageAccountResourceId $Storage.Id -StorageAccountKey $StorageKey -Tables @("WADWindowsEventLogsTable") +``` + +The first command uses the Get-AzOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkspace, and then stores it in the $Workspace variable. +The second command uses the Get-AzStorageAccount cmdlet to get the specified storage account, and then stores it in the $Storage variable. +The third command passes the storage account in $Storage to the Get-AzStorageAccountKey cmdlet by using the pipeline operator to get the specified key, and then stores it in the $StorageKey variable. This example retrieves the first key. To retrieve the other one, use Value[1] instead of Value[0]. +The final command creates a storage insight named MyStorageInsight in the workspace defined in $Workspace. +The Storage Insight consumes data from the WADWindowsEventLogsTable table in the specified storage account resource. + +## PARAMETERS + +### -Containers +Specifies the list of containers that contain the data. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETag +The ETag of the StorageInsight. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage Insight. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group that contains a workspace. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountKey +Specifies the access key for the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Specifies the Azure resource of a storage account. +This can be retrieved by executing the Get-AzStorageAccount cmdlet and accessing the *Id* parameter of the result. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tables +Specifies the list of tables that provide the data. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Tags of the Storage Insight + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workspace +Specifies the workspace for the new Storage Insight. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of an existing workspace. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSStorageInsight + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + +[Get-AzOperationalInsightsWorkspace](./Get-AzOperationalInsightsWorkspace.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsTable.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsTable.md new file mode 100644 index 0000000000..0ac4a80d2c --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsTable.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightstable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsTable.md +--- + +# New-AzOperationalInsightsTable + +## SYNOPSIS +Creates a custom log table + +## SYNTAX + +``` +New-AzOperationalInsightsTable [-ResourceGroupName] <String> [-WorkspaceName] <String> [-TableName] <String> + [[-RetentionInDays] <Int32>] [-TotalRetentionInDays <Int32>] [-Column <Hashtable>] [-Plan <String>] + [-Description <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a custom log table + +## EXAMPLES + +### Example 1 +```powershell +New-AzOperationalInsightsTable -ResourceGroupName RG-NAME -WorkspaceName WORKSPACE-NAME -TableName TABLE-NAME -RetentionInDays 25 -TotalRetentionInDays 30 -Column @{'ColName1' = 'string'; 'TimeGenerated' = 'DateTime'; 'ColName3' = 'int'} +``` + +```output +TableName : TABLE-NAME +ResourceId : /subscriptions/{subscriptionID}/resourcegroups/RG-NAME/providers/Microsoft.OperationalInsights/workspaces/WORKSPACE-NAME/tables/TABLE-NAME +RetentionInDays : 25 +TotalRetentionInDays : 30 +Plan : Analytics +Description : +Schema : Microsoft.Azure.Management.OperationalInsights.Models.Schema +ProvisioningState : Succeeded +ResourceGroupName : RG-NAME +WorkspaceName : WORKSPACE-NAME +``` + +Creates a custom log table with provided retention details and columns + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Column +The table column passed as @{ ColName1 = Type; ColName2 = Type; ColName3 = Type}. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Search job Description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Plan +Table plan can be 'Analytics' or 'Basic'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Analytics, Basic + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionInDays +The table retention in days, between 4 and 730. +Setting this property to -1 will default to the workspace retention + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +The table name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TotalRetentionInDays +The table total retention in days, between 4 and 2555. +Setting this property to -1 will default to table retention. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that will contain the storage insight. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSTable + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsWindowsEventDataSource.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsWindowsEventDataSource.md new file mode 100644 index 0000000000..32f85d33d7 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsWindowsEventDataSource.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 36B3B1AC-6E7F-4607-A024-91583D952B62 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightswindowseventdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsWindowsEventDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsWindowsEventDataSource.md +--- + +# New-AzOperationalInsightsWindowsEventDataSource + +## SYNOPSIS +Collects event logs from computers that run the Windows operating system. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +New-AzOperationalInsightsWindowsEventDataSource [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-Name] <String> [-EventLogName] <String> [-CollectErrors] [-CollectWarnings] [-CollectInformation] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +New-AzOperationalInsightsWindowsEventDataSource [-Workspace] <PSWorkspace> [-Name] <String> + [-EventLogName] <String> [-CollectErrors] [-CollectWarnings] [-CollectInformation] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzOperationalInsightsWindowsEventDataSource** cmdlet adds a data source that collects Windows event logs from connected computers that run the Windows operating system in Azure Operational Insights. + +## EXAMPLES + +### Example 1: Create system Windows event data source +```powershell +$EventLogNames = @() +$EventLogNames += 'Directory Service' +$EventLogNames += 'Microsoft-Windows-EventCollector/Operational' +$EventLogNames += 'System' +$ResourceGroupName = 'MyResourceGroup' +$WorkspaceName = 'MyWorkspaceName' + +$Count = 0 +foreach ($EventLogName in $EventLogNames) { + $Count++ + $null = New-AzOperationalInsightsWindowsEventDataSource ` + -ResourceGroupName $ResourceGroupName ` + -WorkspaceName $WorkspaceName ` + -Name "Windows-event-$($Count)" ` + -EventLogName $EventLogName ` + -CollectErrors ` + -CollectWarnings ` + -CollectInformation +} + +Get-AzOperationalInsightsDataSource ` + -ResourceGroupName $ResourceGroupName ` + -WorkspaceName $WorkspaceName ` + -Kind 'WindowsEvent' +``` + +Adds a data source that collects Windows event logs from connected computers that run the Windows operating system in Azure Operational Insights. + +## PARAMETERS + +### -CollectErrors +Indicates that Operational Insights collects error messages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectInformation +Indicates that Operational Insights collects information messages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectWarnings +Indicates that Operational Insights collects warning messages. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventLogName +Specifies the name of the event log. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the data source. The name is not exposed in the Azure Portal and any string can be used as long as it is unique. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsWindowsPerformanceCounterDataSource.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsWindowsPerformanceCounterDataSource.md new file mode 100644 index 0000000000..7528ab3fc3 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsWindowsPerformanceCounterDataSource.md @@ -0,0 +1,270 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 09CC097E-0210-4443-BCDB-5CF6C8300288 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightswindowsperformancecounterdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsWindowsPerformanceCounterDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsWindowsPerformanceCounterDataSource.md +--- + +# New-AzOperationalInsightsWindowsPerformanceCounterDataSource + +## SYNOPSIS +Adds Windows performance counter data source for connected computers that run the Windows operating system. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +New-AzOperationalInsightsWindowsPerformanceCounterDataSource [-ResourceGroupName] <String> + [-WorkspaceName] <String> [-Name] <String> [-ObjectName] <String> [-CounterName] <String> + [-InstanceName <String>] [-IntervalSeconds <Int32>] [-UseLegacyCollector] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +New-AzOperationalInsightsWindowsPerformanceCounterDataSource [-Workspace] <PSWorkspace> [-Name] <String> + [-ObjectName] <String> [-CounterName] <String> [-InstanceName <String>] [-IntervalSeconds <Int32>] + [-UseLegacyCollector] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzOperationalInsightsWindowsPerformanceCounterDataSource** cmdlet adds a Windows performance counter data source for connected computers that run the Windows operating system. + +## EXAMPLES + +### Example 1 +```powershell +New-AzOperationalInsightsWindowsPerformanceCounterDataSource -ResourceGroupName testrg -WorkspaceName LogAnalyticsWorkspace -Name performance1 -ObjectName object -CounterName counters +``` + +```output +Name : performance1 +ResourceGroupName : testrg +WorkspaceName : LogAnalyticsWorkspace +ResourceId : /subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/resourceGroups/testrg/providers/Microsoft.OperationalInsights/workspaces/LogAnalyticsWorkspace/datasources/performance1 +Kind : WindowsPerformanceCounter +Properties : {"objectName":"object","instanceName":"*","intervalSeconds":15,"counterName":"counters","collectorType":"Default"} +``` + +Add a Windows performance counter data source for connected computers that run the Windows operating system. + +## PARAMETERS + +### -CounterName +Specifies the name of a counter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Specifies an instance name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IntervalSeconds +Specifies the interval of collection. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the data source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ObjectName +Specifies the name of an object. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UseLegacyCollector +Use legacy collector or the default collector. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsWorkspace.md b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsWorkspace.md new file mode 100644 index 0000000000..7fbcc2c7e0 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/New-AzOperationalInsightsWorkspace.md @@ -0,0 +1,303 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 4682807D-34E8-4057-8894-36820447067B +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/new-azoperationalinsightsworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/New-AzOperationalInsightsWorkspace.md +--- + +# New-AzOperationalInsightsWorkspace + +## SYNOPSIS +Creates a workspace, or restore a soft-deleted workspace. + +## SYNTAX + +``` +New-AzOperationalInsightsWorkspace [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + [[-Sku] <String>] [-SkuCapacity <Int32>] [[-Tag] <Hashtable>] [[-RetentionInDays] <Int32>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [[-PublicNetworkAccessForIngestion] <String>] + [[-PublicNetworkAccessForQuery] <String>] [[-ForceCmkForQuery] <Boolean>] [[-DisableLocalAuth] <Boolean>] + [-DefaultDataCollectionRuleResourceId <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzOperationalInsightsWorkspace** cmdlet creates a workspace in the specified resource group and location. Or restore a soft-deleted workspace. + +## EXAMPLES + +### Example 1: Create a workspace by name +```powershell +New-AzOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -Location "East US" +``` + +This command creates a standard SKU workspace named MyWorkspace in the resource group named ContosoResourceGroup. + +## PARAMETERS + +### -DefaultDataCollectionRuleResourceId +The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Allow to opt-out of local authentication and ensure customers can use only MSI and AAD for exclusive authentication + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceCmkForQuery +Gets or sets indicates whether customer managed storage is mandatory for query management + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location in which to create the workspace, for example, East US or West Europe. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNetworkAccessForIngestion +The network access type for accessing workspace ingestion. Value should be 'Enabled' or 'Disabled' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccessForQuery +The network access type for accessing workspace query. Value should be 'Enabled' or 'Disabled' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. +The workspace is created in this resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionInDays +The workspace data retention in days. 730 days is the maximum allowed for all other Skus + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +The service tier of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuCapacity +Sku Capacity, value need to be multiple of 100 and at least 0. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The resource tags for the workspace. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +## NOTES + +A new pricing model has been released. If you are a CSP that means that you have to use "standalone" for the sku. Behind the scenes, the sku will be changed to pergb2018. For more information, please see the following: https://learn.microsoft.com/azure/monitoring-and-diagnostics/monitoring-usage-and-estimated-costs#new-pricing-model + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) diff --git a/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsCluster.md b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsCluster.md new file mode 100644 index 0000000000..afe96a7807 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsCluster.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/remove-azoperationalinsightscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsCluster.md +--- + +# Remove-AzOperationalInsightsCluster + +## SYNOPSIS +Delete cluster + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzOperationalInsightsCluster [-ResourceGroupName] <String> [-ClusterName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzOperationalInsightsCluster -InputCluster <PSCluster> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzOperationalInsightsCluster -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete cluster, only apply to clusters with provisioning state "Succeeded" + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzOperationalInsightsCluster -ResourceGroupName "rg-name" -ClusterName "cluster-name" +``` + +Delete cluster + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The cluster name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputCluster +{{ Fill InputCluster Description }} + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSCluster +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The destination resource ID. +This can be copied from the Properties entry of the destination resource in Azure. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSCluster + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsDataExport.md b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsDataExport.md new file mode 100644 index 0000000000..2bb44e623b --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsDataExport.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/remove-azoperationalinsightsdataexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsDataExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsDataExport.md +--- + +# Remove-AzOperationalInsightsDataExport + +## SYNOPSIS +Delete data export for workspace. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzOperationalInsightsDataExport [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DataExportName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzOperationalInsightsDataExport -InputDataExport <PSDataExport> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzOperationalInsightsDataExport -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a data export for a given worksace + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzOperationalInsightsDataExport -ResourceGroupName "rg-name" -WorkspaceName "workspace-name" -DataExportName "dataExportName" +``` + +removed data export + +## PARAMETERS + +### -DataExportName +The data export name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputDataExport +Specifies the DataExport to be updated. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSDataExport +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The destination resource ID. +This can be copied from the Properties entry of the destination resource in Azure. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that will contain the storage insight. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataExport + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsDataSource.md b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsDataSource.md new file mode 100644 index 0000000000..2ea1ea8dfd --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsDataSource.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 5C1C51FE-747F-4176-84ED-A28AA3475581 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/remove-azoperationalinsightsdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsDataSource.md +--- + +# Remove-AzOperationalInsightsDataSource + +## SYNOPSIS +Deletes a data source. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +Remove-AzOperationalInsightsDataSource [-ResourceGroupName] <String> [-WorkspaceName] <String> [-Name] <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +Remove-AzOperationalInsightsDataSource [-Workspace] <PSWorkspace> [-Name] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzOperationalInsightsDataSource** cmdlet deletes a data source. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzOperationalInsightsDataSource -ResourceGroupName testrg -WorkspaceName LogAnalyticsWorkspace -Name DataSource_CustomLog_Customlog_CL +``` + +Delete a data source. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a data source to delete. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains computers. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies a workspace in which this cmdlet operates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace in which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights + +## RELATED LINKS + +[Get-AzOperationalInsightsDataSource](./Get-AzOperationalInsightsDataSource.md) + +[Set-AzOperationalInsightsDataSource](./Set-AzOperationalInsightsDataSource.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsLinkedService.md b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsLinkedService.md new file mode 100644 index 0000000000..f53dfd0fb2 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsLinkedService.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/remove-azoperationalinsightslinkedservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsLinkedService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsLinkedService.md +--- + +# Remove-AzOperationalInsightsLinkedService + +## SYNOPSIS +Unlink service for workspace + +## SYNTAX + +``` +Remove-AzOperationalInsightsLinkedService [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-LinkedServiceName] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Unlink service for workspace + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzOperationalInsightsLinkedService -ResourceGroupName "rg-name" -WorkspaceName "workspace-name" -LinkedServiceName cluster +``` + +Unlink linked service for workspace + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedServiceName +The Workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The Workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsLinkedStorageAccount.md b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsLinkedStorageAccount.md new file mode 100644 index 0000000000..67202d961f --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsLinkedStorageAccount.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/remove-azoperationalinsightslinkedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsLinkedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsLinkedStorageAccount.md +--- + +# Remove-AzOperationalInsightsLinkedStorageAccount + +## SYNOPSIS +Delete linked storage account for workspace + +## SYNTAX + +``` +Remove-AzOperationalInsightsLinkedStorageAccount [-ResourceGroupName] <String> [-WorkspaceName] <String> + [[-DataSourceType] <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Delete linked storage account for workspace + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzOperationalInsightsLinkedStorageAccount -ResourceGroupName "rg-name" -WorkspaceName "workspace-name" -DataSourceType CustomLogs +``` + +Delete linked storage account with type "CustomLogs" for {workspace-name} + +## PARAMETERS + +### -DataSourceType +Data Source Type should be one of 'CustomLogs', 'AzureWatson'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: CustomLogs, AzureWatson, Query, Alerts + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsSavedSearch.md b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsSavedSearch.md new file mode 100644 index 0000000000..c5e3b6ecac --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsSavedSearch.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: D4A40E83-2969-40A2-AED0-A6073142CAF1 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/remove-azoperationalinsightssavedsearch +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsSavedSearch.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsSavedSearch.md +--- + +# Remove-AzOperationalInsightsSavedSearch + +## SYNOPSIS +Removes a saved search from the workspace. + +## SYNTAX + +``` +Remove-AzOperationalInsightsSavedSearch [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-SavedSearchId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzOperationalInsightsSavedSearch** cmdlet removes a saved search from the workspace. + +## EXAMPLES + +### Example 1: Remove a saved search +```powershell +Remove-AzOperationalInsightsSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -SavedSearchId "ContosoSavedSearchId" +``` + +This command removes a saved search from the workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SavedSearchId +Specifies the saved search ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsStorageInsight.md b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsStorageInsight.md new file mode 100644 index 0000000000..598dea0844 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsStorageInsight.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 92261663-CF50-4EBD-85D2-C2E254F39B41 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/remove-azoperationalinsightsstorageinsight +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsStorageInsight.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsStorageInsight.md +--- + +# Remove-AzOperationalInsightsStorageInsight + +## SYNOPSIS +Removes a Storage Insight. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +Remove-AzOperationalInsightsStorageInsight [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-Name] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +Remove-AzOperationalInsightsStorageInsight [-Workspace] <PSWorkspace> [-Name] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzOperationalInsightsStorageInsight** cmdlet deletes a Storage Insight from a workspace. + +## EXAMPLES + +### Example 1: Remove a Storage Insight by name +```powershell +Remove-AzOperationalInsightsStorageInsight -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "MyWorkspace" -Name "MyStorageInsight" +``` + +This command removes the Storage Insight named MyStorageInsight from the workspace named MyWorkspace in the specified resource group. +The command does not specify the *Force* parameter, so it prompts you for confirmation before removing the Storage Insight. + +### Example 2: Remove a Storage Insight without confirmation +```powershell +$Workspace = Get-AzOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" + +Remove-AzOperationalInsightsStorageInsight -Workspace $Workspace -Name "MyStorageInsight" -Force +``` + +The first command uses the Get-AzOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkspace, and then stores it in the $Workspace variable.The second command removes the storage insight named MyStorageInsight from $Workspace without prompting you for confirmation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage Insight. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies the workspace that contains the Storage Insight. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of the workspace that contains the Storage Insight. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + +[Get-AzOperationalInsightsWorkspace](./Get-AzOperationalInsightsWorkspace.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsTable.md b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsTable.md new file mode 100644 index 0000000000..5b44332303 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsTable.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/remove-azoperationalinsightstable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsTable.md +--- + +# Remove-AzOperationalInsightsTable + +## SYNOPSIS +Delete a Log Analytics workspace table. + +## SYNTAX + +``` +Remove-AzOperationalInsightsTable [-ResourceGroupName] <String> [-WorkspaceName] <String> [-TableName] <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a Log Analytics workspace table. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzOperationalInsightsTable -ResourceGroupName RG-NAME -WorkspaceName WS-NAME -TableName TABLE-NAME +``` + +```output +True +``` + +Deletes a table + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +The table name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that will contain the storage insight. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsWorkspace.md b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsWorkspace.md new file mode 100644 index 0000000000..90abeed8e5 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Remove-AzOperationalInsightsWorkspace.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 0C35E679-B991-49A8-890F-C8DAB68A8240 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/remove-azoperationalinsightsworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Remove-AzOperationalInsightsWorkspace.md +--- + +# Remove-AzOperationalInsightsWorkspace + +## SYNOPSIS +Removes a workspace. + +## SYNTAX + +``` +Remove-AzOperationalInsightsWorkspace [-ResourceGroupName] <String> [-Name] <String> [-ForceDelete] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzOperationalInsightsWorkspace** cmdlet deletes an existing workspace. +If this workspace was linked to an existing account via the *CustomerId* parameter at creation time the original account is not deleted in the Operational Insights portal. + +## EXAMPLES + +### Example 1: Remove a workspace by name +```powershell +Remove-AzOperationalInsightsWorkspace -ResourceGroupName "ContosResourceGroup" -Name "MyWorkspace" +``` + +This command removes the workspace named MyWorkspace from the resource group named ContosoResourceGroup. + +### Example 2: Remove a workspace by using the pipeline and without confirmation +```powershell +Get-AzOperationalInsightsWorkspace -ResourceGroupName "ContosResourceGroup" -Name "MyWorkspace" | Remove-AzOperationalInsightsWorkspace -Force +``` + +This command uses the Get-AzOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkspace, and then passes it to the **Remove-AzOperationalInsightsWorkspace** cmdlet by using the pipeline operator to remove it. +Since the *Force* parameter is specified, the command does not prompt you before removing the workspace. + +### Example 3: Force delete workspace (cannot be recovered) +```powershell +$workspace = New-AzOperationalInsightsWorkspace -ResourceGroupName "RG-NAME" -Name "WORKSPACE-NAME" -Location "REGION-VALUE" +$workspace | Remove-AzOperationalInsightsWorkspace -ForceDelete +``` + +Force delete a workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDelete +Force delete workspace. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + +[Get-AzOperationalInsightsWorkspace](./Get-AzOperationalInsightsWorkspace.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Restore-AzOperationalInsightsWorkspace.md b/azps-10.1.0/Az.OperationalInsights/Restore-AzOperationalInsightsWorkspace.md new file mode 100644 index 0000000000..c3cf512ec2 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Restore-AzOperationalInsightsWorkspace.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/restore-azoperationalinsightsworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Restore-AzOperationalInsightsWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Restore-AzOperationalInsightsWorkspace.md +--- + +# Restore-AzOperationalInsightsWorkspace + +## SYNOPSIS +Restore a deleted workspace. + +## SYNTAX + +``` +Restore-AzOperationalInsightsWorkspace -ResourceGroupName <String> -Name <String> -Location <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Restore a deleted workspace. + +## EXAMPLES + +### Example 1 +```powershell +$workspace = New-AzOperationalInsightsWorkspace -ResourceGroupName RG-NAME -Name WORKSPACE-NAME -Location LOCATION-VALUE +$workspace | Remove-AzOperationalInsightsWorkspace +$workspace = Restore-AzOperationalInsightsWorkspace -ResourceGroupName RG-NAME -Name WORKSPACE-NAME -Location LOCATION-VALUE +``` + +Restore deleted workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geographic region that the workspace will be created in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsDataSource.md b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsDataSource.md new file mode 100644 index 0000000000..aa5e649f04 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsDataSource.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 3992E6B5-F794-4C7A-BB59-C8D60E2CD7BC +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/set-azoperationalinsightsdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsDataSource.md +--- + +# Set-AzOperationalInsightsDataSource + +## SYNOPSIS +Updates a data source. + +## SYNTAX + +``` +Set-AzOperationalInsightsDataSource [-DataSource] <PSDataSource> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzOperationalInsightsDataSource** cmdlet updates a data source. + +## EXAMPLES + +### Example 1 +```powershell +$datasource = Get-AzOperationalInsightsDataSource -Kind CustomLog -ResourceGroupName testrg -WorkspaceName LogAnalyticsWorkspace +Set-AzOperationalInsightsDataSource -DataSource $datasource +``` + +```output +Name : DataSource_CustomLog_Customlog_CL +ResourceGroupName : testrg +WorkspaceName : LogAnalyticsWorkspace +ResourceId : /subscriptions/xxxx-xxxx-xxxx-xxxx-xxxx/resourceGroups/testrg/providers/Microsoft.Ope + rationalInsights/workspaces/LogAnalyticsWorkspace/datasources/DataSource_CustomLog_Customlog_ + CL +Kind : CustomLog +Properties : {"customLogName":"Customlog_CL","description":"","extractions":[{"extractionName":"TimeGenerated"," + extractionProperties":{"dateTimeExtraction":{"joinStringRegex":null,"regex":null,"formatString":nul + l}},"extractionType":"DateTime"}],"inputs":[{"location":{"fileSystemLocations":{"linuxFileTypeLogPa + ths":null,"windowsFileTypeLogPaths":["D:\\logs.txt"]}},"recordDelimiter":{"regexDelimiter":{"matchI + ndex":0,"numberdGroup":null,"pattern":"\\n"}}}]} +``` + +Update a data source. + +## PARAMETERS + +### -DataSource +Specifies the data source that this cmdlet updates. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights + +## RELATED LINKS + +[Get-AzOperationalInsightsDataSource](./Get-AzOperationalInsightsDataSource.md) + +[Remove-AzOperationalInsightsDataSource](./Remove-AzOperationalInsightsDataSource.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsIntelligencePack.md b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsIntelligencePack.md new file mode 100644 index 0000000000..24cf03b672 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsIntelligencePack.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 23ED4D24-66BD-46E9-BB57-6E0DA679B733 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/set-azoperationalinsightsintelligencepack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsIntelligencePack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsIntelligencePack.md +--- + +# Set-AzOperationalInsightsIntelligencePack + +## SYNOPSIS +Enables or disables the specified Intelligence Pack. +> [!NOTE] +> Solutions is being deprecated, please use [az monitor log-analytics solution](https://learn.microsoft.com/en-us/cli/azure/monitor/log-analytics/solution?view=azure-cli-latest) and [Get-AzMonitorLogAnalyticsSolution](https://learn.microsoft.com/en-us/powershell/module/az.monitoringsolutions/get-azmonitorloganalyticssolution?view=azps-5.9.0) instead if this command. + +## SYNTAX + +``` +Set-AzOperationalInsightsIntelligencePack [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-IntelligencePackName] <String> [-Enabled] <Boolean> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzOperationalInsightsIntelligencePack** cmdlet enables the specified Intelligence Pack if *Enabled* is set to $True and disables it if *Enabled* is set to $False. + +## EXAMPLES + +### Example 1: Set Intelligence Packs +```powershell +Set-AzOperationalInsightsIntelligencePack -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -IntelligencePackName "ContosoWorkspace" -Enabled $True +``` + +This command enables the specified Intelligence Pack. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IntelligencePackName +Specifies the Intelligence Pack name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSIntelligencePack + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsLinkedService.md b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsLinkedService.md new file mode 100644 index 0000000000..8c79acfbb2 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsLinkedService.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/set-azoperationalinsightslinkedservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsLinkedService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsLinkedService.md +--- + +# Set-AzOperationalInsightsLinkedService + +## SYNOPSIS +link service for workspace + +## SYNTAX + +``` +Set-AzOperationalInsightsLinkedService [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-LinkedServiceName] <String> [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-WriteAccessResourceId <String>] [-ResourceId <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +link service for workspace + +## EXAMPLES + +### Example 1 +```powershell +Set-AzOperationalInsightsLinkedService -ResourceGroupName "rg-name" -WorkspaceName "workspace-name" -LinkedServiceName cluster -WriteAccessResourceId "/subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.OperationalInsights/clusters/{cluster-name}" +``` + +```output +Id : /subscriptions/{subscription}/resourcegroups/{rg-name}/providers/microsoft.operationalinsights/workspaces/{workspace-name}/linkedservices/cluster +Name : {cluster-name}/Cluster +Type : Microsoft.OperationalInsights/workspaces/linkedServices +ResourceId : +WriteAccessResourceId : /subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.OperationalInsights/clusters/{cluster-name} +ProvisioningState : ProvisioningAccount +Tags : +``` + +link cluster for workspace + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedServiceName +The Workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the resource that will be linked to the workspace. +This should be used for linking resources which require read access + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags. + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The Workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WriteAccessResourceId +The resource id of the resource that will be linked to the workspace. +This should be used for linking resources which require write access. +Cluster must have provisioning state "Succeeded" and valid keyvault properties. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSLinkedService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsLinkedStorageAccount.md b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsLinkedStorageAccount.md new file mode 100644 index 0000000000..1828cdc001 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsLinkedStorageAccount.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/set-azoperationalinsightslinkedstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsLinkedStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsLinkedStorageAccount.md +--- + +# Set-AzOperationalInsightsLinkedStorageAccount + +## SYNOPSIS +Set linked storage account for workspace + +## SYNTAX + +``` +Set-AzOperationalInsightsLinkedStorageAccount [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-DataSourceType] <String> [-StorageAccountId] <String[]> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Set linked storage account for workspace + +## EXAMPLES + +### Example 1 +```powershell +$account = Get-AzStorageAccount -ResourceGroupName "rg-name" -Name "storage-account" + +Set-AzOperationalInsightsLinkedStorageAccount -ResourceGroupName "rg-name" -WorkspaceName "workspace-name" -DataSourceType CustomLogs -StorageAccountId $account.Id +``` + +```output +Id : /subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.OperationalInsights/workspaces/{workspace-name}/linkedStorageAccounts/CustomLogs +Name : customlogs +Type : Microsoft.OperationalInsights/workspaces/linkedStorageAccounts +DataSourceType : CustomLogs +StorageAccountIds : {/subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.Storage/storageAccounts/{storage-account}} +``` + +Set linked storage for workspace + +## PARAMETERS + +### -DataSourceType +Data Source Type should be one of 'CustomLogs', 'AzureWatson'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: CustomLogs, AzureWatson, Query, Alerts + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountId +list of storage account Id. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSLinkedStorageAccountsResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsSavedSearch.md b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsSavedSearch.md new file mode 100644 index 0000000000..52b7ec14b8 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsSavedSearch.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: A333A60D-CA76-4E4E-9C8B-72AAEF464F0A +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/set-azoperationalinsightssavedsearch +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsSavedSearch.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsSavedSearch.md +--- + +# Set-AzOperationalInsightsSavedSearch + +## SYNOPSIS +Updates a saved search that already exists. + +## SYNTAX + +``` +Set-AzOperationalInsightsSavedSearch [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-SavedSearchId] <String> [-DisplayName] <String> [-Category] <String> [-Query] <String> [[-Tag] <Hashtable>] + [[-Version] <Int64>] [[-ETag] <String>] [[-FunctionAlias] <String>] [[-FunctionParameter] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzOperationalInsightsSavedSearch** cmdlet updates a saved search that already exists. + +## EXAMPLES + +### Example 1: Sets a saved search with updated properties +```powershell +Set-AzOperationalInsightsSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -SavedSearchId "ContosoSavedSearchId" -DisplayName "ContosoSavedSearchDisplayName" -Category "ContosoSavedSearchCategory" -Query "Type=Event" -Version 1 -ETag "ContosoSavedSearchEtag" +``` + +This command sets a saved search with updated properties. + +## PARAMETERS + +### -Category +Specifies the category name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies the display name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ETag +Specifies the ETag name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FunctionAlias +The function alias if query serves as a function. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunctionParameter +The optional function parameters if query serves as a function. Value should be in the following format: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. For more examples and proper syntax please refer to https://learn.microsoft.com/azure/kusto/query/functions/user-defined-functions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FunctionParameters + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Specifies the query name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SavedSearchId +Specifies the saved search ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The saved search tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: 1 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Int64 + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSSavedSearchValue + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsStorageInsight.md b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsStorageInsight.md new file mode 100644 index 0000000000..471c9fce26 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsStorageInsight.md @@ -0,0 +1,276 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 010328F9-C878-4F16-AFD7-2135465A1968 +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/set-azoperationalinsightsstorageinsight +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsStorageInsight.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsStorageInsight.md +--- + +# Set-AzOperationalInsightsStorageInsight + +## SYNOPSIS +Updates a Storage Insight. + +## SYNTAX + +### ByWorkspaceName (Default) +``` +Set-AzOperationalInsightsStorageInsight [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-Name] <String> [[-StorageAccountKey] <String>] [-StorageAccountResourceId] <String> [[-Tables] <String[]>] + [[-Containers] <String[]>] [-ETag <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByWorkspaceObject +``` +Set-AzOperationalInsightsStorageInsight [-Workspace] <PSWorkspace> [-Name] <String> + [[-StorageAccountKey] <String>] [-StorageAccountResourceId] <String> [[-Tables] <String[]>] + [[-Containers] <String[]>] [-ETag <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzOperationalInsightsStorageInsight** cmdlet changes the configuration of a Storage Insight. + +## EXAMPLES + +### Example 1: Modify a Storage Insight by name +```powershell +Set-AzOperationalInsightsStorageInsight -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "MyWorkspace" -Name "MyStorageInsight" -Tables @("WADWindowsEventLogsTable") +``` + +This command modifies the tables from which the Storage Insight named MyStorageInsight reads. + +### Example 2: Modify a Storage Insight by using a workspace object +```powershell +$Workspace = Get-AzOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" + +Set-AzOperationalInsightsStorageInsight -Workspace $Workspace -Name "MyStorageInsight" -Containers @("wad-iis-logfiles") +``` + +The first command uses the Get-AzOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkspace, and then stores it in the $Workspace variable. +The second command modifies the containers from which the Storage Insight named MyStorageInsight reads. + +## PARAMETERS + +### -Containers +Specifies the list of containers that provide the data. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETag +The ETag of the StorageInsight. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a Storage Insight. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of an Azure resource group that contains a workspace. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountKey +Specifies the access key for the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The full Azure Resource Manager ID of the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tables +Specifies the list of tables that contain the data. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Tags of the Storage Insight + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workspace +Specifies the workspace that contains the Storage Insight. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByWorkspaceObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Specifies the name of a workspace. + +```yaml +Type: System.String +Parameter Sets: ByWorkspaceName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSStorageInsight + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + +[Get-AzOperationalInsightsWorkspace](./Get-AzOperationalInsightsWorkspace.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsWorkspace.md b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsWorkspace.md new file mode 100644 index 0000000000..299eb0f447 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Set-AzOperationalInsightsWorkspace.md @@ -0,0 +1,293 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +ms.assetid: 54DFBB63-AE8C-4918-870F-19FAD6CC5E4A +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/set-azoperationalinsightsworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Set-AzOperationalInsightsWorkspace.md +--- + +# Set-AzOperationalInsightsWorkspace + +## SYNOPSIS +Updates a workspace. + +## SYNTAX + +### ByName (Default) +``` +Set-AzOperationalInsightsWorkspace [-ResourceGroupName] <String> [-Name] <String> [[-Sku] <String>] + [-SkuCapacity <Int32>] [[-Tag] <Hashtable>] [-RetentionInDays <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-PublicNetworkAccessForIngestion <String>] + [-PublicNetworkAccessForQuery <String>] [-DailyQuotaGb <Int32>] [[-ForceCmkForQuery] <Boolean>] + [[-DisableLocalAuth] <Boolean>] [-DefaultDataCollectionRuleResourceId <String>] [<CommonParameters>] +``` + +### ByObject +``` +Set-AzOperationalInsightsWorkspace [-Workspace] <PSWorkspace> [[-Sku] <String>] [-SkuCapacity <Int32>] + [[-Tag] <Hashtable>] [-RetentionInDays <Int32>] [-DefaultProfile <IAzureContextContainer>] + [-PublicNetworkAccessForIngestion <String>] [-PublicNetworkAccessForQuery <String>] [-DailyQuotaGb <Int32>] + [[-ForceCmkForQuery] <Boolean>] [[-DisableLocalAuth] <Boolean>] + [-DefaultDataCollectionRuleResourceId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzOperationalInsightsWorkspace** cmdlet changes the configuration of a workspace. + +## EXAMPLES + +### Example 1: Modify a workspace by name +```powershell +Set-AzOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -Sku Standard -Tag @{ "Department" = "IT" } +``` + +This command modifies the SKU and tags of the workspace named MyWorkspace in the resource group named ContosoResourceGroup. + +### Example 2: Update a workspace by using the pipeline +```powershell +Get-AzOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" | Set-AzOperationalInsightsWorkspace -Sku "Premium" +``` + +This command uses the Get-AzOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkSpace, and then passes it to the **Set-AzOperationalInsightsWorkspace** cmdlet by using the pipeline operator to set the SKU to Premium. + +## PARAMETERS + +### -DailyQuotaGb +The daily volume cap for ingestion - number + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultDataCollectionRuleResourceId +The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +Allow to opt-out of local authentication and ensure customers can use only MSI and AAD for exclusive authentication + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceCmkForQuery +Gets or sets indicates whether customer managed storage is mandatory for query management + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the workspace name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PublicNetworkAccessForIngestion +The network access type for accessing workspace ingestion. Value should be 'Enabled' or 'Disabled' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccessForQuery +The network access type for accessing workspace query. Value should be 'Enabled' or 'Disabled' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the Azure resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionInDays +The workspace data retention in days. 730 days is the maximum allowed for all other Skus + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +The service tier of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: free, standard, premium, pernode, standalone, pergb2018, capacityreservation, lacluster + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkuCapacity +Sku Capacity, value need to be multiple of 100 and above 0. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The resource tags for the workspace. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Workspace +Specifies the workspace to be updated. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace +Parameter Sets: ByObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +### System.String + +### System.Collections.Hashtable + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +## NOTES + +## RELATED LINKS + +[Azure Operational Insights Cmdlets](./Az.OperationalInsights.md) + +[Get-AzOperationalInsightsWorkspace](./Get-AzOperationalInsightsWorkspace.md) + + diff --git a/azps-10.1.0/Az.OperationalInsights/Update-AzOperationalInsightsCluster.md b/azps-10.1.0/Az.OperationalInsights/Update-AzOperationalInsightsCluster.md new file mode 100644 index 0000000000..3b1f977791 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Update-AzOperationalInsightsCluster.md @@ -0,0 +1,390 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/update-azoperationalinsightscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Update-AzOperationalInsightsCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Update-AzOperationalInsightsCluster.md +--- + +# Update-AzOperationalInsightsCluster + +## SYNOPSIS +update cluster + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Update-AzOperationalInsightsCluster -ResourceGroupName <String> -ClusterName <String> [-SkuName <String>] + [-SkuCapacity <Int64>] [-KeyVaultUri <String>] [-KeyName <String>] [-KeyVersion <String>] [-Tag <Hashtable>] + [-IdentityType <String>] [-BillingType <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AllParameterSet +``` +Update-AzOperationalInsightsCluster [-ResourceGroupName <String>] [-ClusterName <String>] + [-ResourceId <String>] [-InputCluster <PSCluster>] [-SkuName <String>] [-SkuCapacity <Int64>] + [-KeyVaultUri <String>] [-KeyName <String>] [-KeyVersion <String>] [-Tag <Hashtable>] [-IdentityType <String>] + [-BillingType <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByResourceIdParameterSet +``` +Update-AzOperationalInsightsCluster -ResourceId <String> [-SkuName <String>] [-SkuCapacity <Int64>] + [-KeyVaultUri <String>] [-KeyName <String>] [-KeyVersion <String>] [-Tag <Hashtable>] [-IdentityType <String>] + [-BillingType <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzOperationalInsightsCluster -InputCluster <PSCluster> [-SkuName <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +update cluster + +## EXAMPLES + +### Example 1 +```powershell +Update-AzOperationalInsightsCluster -ResourceGroupName "rg-name" -ClusterName "cluster-name" -SkuName CapacityReservation -SkuCapacity 1200 -KeyVaultUri "uri" -KeyName "key-name" -KeyVersion "version" +``` + +```output +Identity : Microsoft.Azure.Commands.OperationalInsights.Models.PSIdentity +Sku : Microsoft.Azure.Commands.OperationalInsights.Models.PSClusterSku +ClusterId : {cluster-id} +ProvisioningState : Succeeded +IsDoubleEncryptionEnabled : True +IsAvailabilityZonesEnabled : False +BillingType : Cluster +KeyVaultProperties : Microsoft.Azure.Commands.OperationalInsights.Models.PSKeyVaultProperties +LastModifiedDate : +CreatedDate : +AssociatedWorkspaces : {workspaces} +CapacityReservationProperties : Microsoft.Azure.Management.OperationalInsights.Models.CapacityReservationProperties +Location : South Central US +Id : /subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.OperationalInsights/clusters/{cluster-name} +Name : {cluster-name} +Type : Microsoft.OperationalInsights/clusters +Tags : {} +``` + +update cluster with key vault properties and sku + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingType +Billing type can be set as 'Cluster' or 'Workspaces' + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, AllParameterSet, UpdateByResourceIdParameterSet +Aliases: +Accepted values: Cluster, Workspaces + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The cluster name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: AllParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +the identity type, value can be 'SystemAssigned', 'None', 'UserAssigned'. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, AllParameterSet, UpdateByResourceIdParameterSet +Aliases: +Accepted values: SystemAssigned, None, UserAssigned + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputCluster +Specifies the cluster to be updated. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSCluster +Parameter Sets: AllParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSCluster +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +Key Name + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, AllParameterSet, UpdateByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultUri +Key Vault Uri, "Purge Protection" and "Soft Delete" have to be enabled for this keyvault + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, AllParameterSet, UpdateByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVersion +Key Version + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, AllParameterSet, UpdateByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: AllParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The destination resource ID. +This can be copied from the Properties entry of the destination resource in Azure. + +```yaml +Type: System.String +Parameter Sets: AllParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Sku Capacity + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: UpdateByNameParameterSet, AllParameterSet, UpdateByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Sku Name, now can be 'CapacityReservation' only + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: CapacityReservation + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags of the cluster + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateByNameParameterSet, AllParameterSet, UpdateByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSCluster + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Update-AzOperationalInsightsDataExport.md b/azps-10.1.0/Az.OperationalInsights/Update-AzOperationalInsightsDataExport.md new file mode 100644 index 0000000000..79d50e7497 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Update-AzOperationalInsightsDataExport.md @@ -0,0 +1,264 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/update-azoperationalinsightsdataexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Update-AzOperationalInsightsDataExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Update-AzOperationalInsightsDataExport.md +--- + +# Update-AzOperationalInsightsDataExport + +## SYNOPSIS +Update data export. + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Update-AzOperationalInsightsDataExport -ResourceGroupName <String> -WorkspaceName <String> + [-DataExportName <String>] [-TableName <String[]>] [-DestinationResourceId <String>] [-EventHubName <String>] + [-Enable <Boolean>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByResourceIdParameterSet +``` +Update-AzOperationalInsightsDataExport -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzOperationalInsightsDataExport -InputDataExport <PSDataExport> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a data export. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzOperationalInsightsDataExport -ResourceGroupName "rg-name" -WorkspaceName "workspace-name" -DataExportName "dataExportName" -TableName "table_name" -Enable $true +``` + +```output +Name : {dataExportName} +Id : /subscriptions/{subscription}/resourcegroups/{rg-name}/providers/microsoft.operationalinsights/workspaces/{workspace-name}/dataexports/{dataExportName} +Type : Microsoft.OperationalInsights/workspaces/export +DataExportId : {GUID} +TableNames : {table_name} +ResourceId : /subscriptions/{resource_subscription}/resourceGroups/{resource_rg}/providers/Microsoft.Storage/storageAc + counts/{storage_name} +DataExportType : StorageAccount +EventHubName : +Enable : true +CreatedDate : +LastModifiedDate : +``` + +Updates a workspace's Data export. + +## PARAMETERS + +### -DataExportName +The data export name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationResourceId +The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Active when enabled. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +Optional. +Allows to define an Event Hub name. +Not applicable when destination is Storage Account. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputDataExport +Specifies the DataExport to be updated. + +```yaml +Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSDataExport +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The destination resource ID. +This can be copied from the Properties entry of the destination resource in Azure. + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +An array of tables to export, for example: \["Heartbeat, SecurityEvent"\]. + +```yaml +Type: System.String[] +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that will contain the storage insight. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataExport + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataExport + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Update-AzOperationalInsightsTable.md b/azps-10.1.0/Az.OperationalInsights/Update-AzOperationalInsightsTable.md new file mode 100644 index 0000000000..e5e57563f2 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Update-AzOperationalInsightsTable.md @@ -0,0 +1,253 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/Update-AzOperationalInsightsTable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Update-AzOperationalInsightsTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Update-AzOperationalInsightsTable.md +--- + +# Update-AzOperationalInsightsTable + +## SYNOPSIS +Update a Log Analytics workspace table. + +## SYNTAX + +``` +Update-AzOperationalInsightsTable [-ResourceGroupName] <String> [-WorkspaceName] <String> [-TableName] <String> + [[-RetentionInDays] <Int32>] [-TotalRetentionInDays <Int32>] [-Column <Hashtable>] [-Plan <String>] + [-Description <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Update a Log Analytics workspace table. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzOperationalInsightsTable -ResourceGroupName RG-NAME -WorkspaceName WORKSPACE-NAME -TableName TABLE-NAME -RetentionInDays 30 -TotalRetentionInDays 35 +``` + +```output +TableName : TABLE-NAME +ResourceId : /subscriptions/SubId/resourcegroups/RG-NAME/providers/Microsoft.OperationalInsights/workspaces/WORKSPACE-NAME/tables/TABLE-NAME +RetentionInDays : 30 +TotalRetentionInDays : 35 +Plan : Analytics +Description : +Schema : Microsoft.Azure.Management.OperationalInsights.Models.Schema +ProvisioningState : Succeeded +ResourceGroupName : RG-NAME +WorkspaceName : WORKSPACE-NAME +``` + +Update a Log Analytics workspace table. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Column +The table columns passed as Hashtable. +for example: @{ ColName1 = Type; ColName2 = Type; ColName3 = Type}. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Search job Description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Plan +Table plan can be 'Analytics' or 'Basic'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Analytics, Basic + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionInDays +The table retention in days, between 4 and 730. +Setting this property to -1 will default to the workspace retention + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +The table name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TotalRetentionInDays +The table total retention in days, between 4 and 2555. +Setting this property to -1 will default to table retention. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace that will contain the storage insight. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.OperationalInsights/Update-AzOperationalInsightsWorkspaceSharedKey.md b/azps-10.1.0/Az.OperationalInsights/Update-AzOperationalInsightsWorkspaceSharedKey.md new file mode 100644 index 0000000000..1ea5a7a038 --- /dev/null +++ b/azps-10.1.0/Az.OperationalInsights/Update-AzOperationalInsightsWorkspaceSharedKey.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml +Module Name: Az.OperationalInsights +online version: https://learn.microsoft.com/powershell/module/az.operationalinsights/Update-AzOperationalInsightsWorkspaceSharedKey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Update-AzOperationalInsightsWorkspaceSharedKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/OperationalInsights/OperationalInsights/help/Update-AzOperationalInsightsWorkspaceSharedKey.md +--- + +# Update-AzOperationalInsightsWorkspaceSharedKey + +## SYNOPSIS +Regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace. + +## SYNTAX + +``` +Update-AzOperationalInsightsWorkspaceSharedKey [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzOperationalInsightsWorkspaceSharedKey -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" +``` + +Regenerates the shared keys for a Log Analytics Workspace. returns Primary and Secondary shared keys + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The workspace name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspaceKeys + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Orbital/Az.Orbital.md b/azps-10.1.0/Az.Orbital/Az.Orbital.md new file mode 100644 index 0000000000..8a6c409cca --- /dev/null +++ b/azps-10.1.0/Az.Orbital/Az.Orbital.md @@ -0,0 +1,64 @@ +--- +Module Name: Az.Orbital +Module Guid: 4fb1d4af-9f8d-4a19-9f17-d8186bf02cfb +Download Help Link: https://learn.microsoft.com/powershell/module/az.orbital +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Az.Orbital.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Az.Orbital.md +--- + +# Az.Orbital Module +## Description +Microsoft Azure PowerShell: Orbital cmdlets + +## Az.Orbital Cmdlets +### [Get-AzOrbitalAvailableGroundStation](Get-AzOrbitalAvailableGroundStation.md) +Returns list of available ground stations. + +### [Get-AzOrbitalAvailableSpacecraftContact](Get-AzOrbitalAvailableSpacecraftContact.md) +Returns list of available contacts. +A contact is available if the spacecraft is visible from the ground station for more than the minimum viable contact duration provided in the contact profile. + +### [Get-AzOrbitalContactProfile](Get-AzOrbitalContactProfile.md) +Gets the specified contact Profile in a specified resource group. + +### [Get-AzOrbitalSpacecraft](Get-AzOrbitalSpacecraft.md) +Gets the specified spacecraft in a specified resource group. + +### [Get-AzOrbitalSpacecraftContact](Get-AzOrbitalSpacecraftContact.md) +Gets the specified contact in a specified resource group. + +### [New-AzOrbitalContactProfile](New-AzOrbitalContactProfile.md) +Creates or updates a contact profile. + +### [New-AzOrbitalContactProfileLinkChannelObject](New-AzOrbitalContactProfileLinkChannelObject.md) +Create an in-memory object for ContactProfileLinkChannel. + +### [New-AzOrbitalContactProfileLinkObject](New-AzOrbitalContactProfileLinkObject.md) +Create an in-memory object for ContactProfileLink. + +### [New-AzOrbitalSpacecraft](New-AzOrbitalSpacecraft.md) +Creates or updates a spacecraft resource. + +### [New-AzOrbitalSpacecraftContact](New-AzOrbitalSpacecraftContact.md) +Creates a contact. + +### [New-AzOrbitalSpacecraftLinkObject](New-AzOrbitalSpacecraftLinkObject.md) +Create an in-memory object for SpacecraftLink. + +### [Remove-AzOrbitalContactProfile](Remove-AzOrbitalContactProfile.md) +Deletes a specified contact profile resource. + +### [Remove-AzOrbitalSpacecraft](Remove-AzOrbitalSpacecraft.md) +Deletes a specified spacecraft resource. + +### [Remove-AzOrbitalSpacecraftContact](Remove-AzOrbitalSpacecraftContact.md) +Deletes a specified contact. + +### [Update-AzOrbitalContactProfile](Update-AzOrbitalContactProfile.md) +Updates the specified contact profile tags. + +### [Update-AzOrbitalSpacecraft](Update-AzOrbitalSpacecraft.md) +Updates the specified spacecraft tags. + diff --git a/azps-10.1.0/Az.Orbital/Get-AzOrbitalAvailableGroundStation.md b/azps-10.1.0/Az.Orbital/Get-AzOrbitalAvailableGroundStation.md new file mode 100644 index 0000000000..44367ddaa9 --- /dev/null +++ b/azps-10.1.0/Az.Orbital/Get-AzOrbitalAvailableGroundStation.md @@ -0,0 +1,109 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.orbital/get-azorbitalavailablegroundstation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Get-AzOrbitalAvailableGroundStation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Get-AzOrbitalAvailableGroundStation.md +--- + +# Get-AzOrbitalAvailableGroundStation + +## SYNOPSIS +Returns list of available ground stations. + +## SYNTAX + +``` +Get-AzOrbitalAvailableGroundStation -Capability <CapabilityParameter> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns list of available ground stations. + +## EXAMPLES + +### Example 1: Gets the specified available ground station. +```powershell +Get-AzOrbitalAvailableGroundStation -Capability 'EarthObservation' +``` + +```output +Location Name ProviderName City +-------- ---- ------------ ---- +westus2 Microsoft_Quincy Microsoft Quincy +westus2 KSAT_Awarua KSAT Awarua +westus2 KSAT_Hartebeesthoek KSAT Hartebeesthoek +westus2 KSAT_Athens KSAT Athens +westus2 KSAT_Svalbard KSAT Svalbard +swedencentral Microsoft_Gavle Microsoft Gavle +southeastasia Microsoft_Singapore Microsoft Singapore +brazilsouth Microsoft_Longovilo Microsoft Longovilo +``` + +Gets the specified available ground station. + +## PARAMETERS + +### -Capability +Ground Station Capability. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Support.CapabilityParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.IAvailableGroundStation + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/Get-AzOrbitalAvailableSpacecraftContact.md b/azps-10.1.0/Az.Orbital/Get-AzOrbitalAvailableSpacecraftContact.md new file mode 100644 index 0000000000..7466727aab --- /dev/null +++ b/azps-10.1.0/Az.Orbital/Get-AzOrbitalAvailableSpacecraftContact.md @@ -0,0 +1,292 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.orbital/get-azorbitalavailablespacecraftcontact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Get-AzOrbitalAvailableSpacecraftContact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Get-AzOrbitalAvailableSpacecraftContact.md +--- + +# Get-AzOrbitalAvailableSpacecraftContact + +## SYNOPSIS +Returns list of available contacts. +A contact is available if the spacecraft is visible from the ground station for more than the minimum viable contact duration provided in the contact profile. + +## SYNTAX + +### ListExpanded (Default) +``` +Get-AzOrbitalAvailableSpacecraftContact -Name <String> -ResourceGroupName <String> -ContactProfileId <String> + -EndTime <DateTime> -GroundStationName <String> -StartTime <DateTime> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### List +``` +Get-AzOrbitalAvailableSpacecraftContact -Name <String> -ResourceGroupName <String> + -Parameter <IContactParameters> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Returns list of available contacts. +A contact is available if the spacecraft is visible from the ground station for more than the minimum viable contact duration provided in the contact profile. + +## EXAMPLES + +### Example 1: Returns list of available contacts. +```powershell +$dateS = Get-Date -Day 9 -Month 5 -AsUTC +$dateE = Get-Date -Day 10 -Month 5 -AsUTC + +Get-AzOrbitalAvailableSpacecraftContact -Name SwedenAQUASpacecraft -ResourceGroupName azpstest-gp -EndTime $dateE -StartTime $dateS -GroundStationName Microsoft_Gavle -ContactProfileId /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/azpstest-gp/providers/Microsoft.Orbital/contactProfiles/Sweden-contactprofile +``` + +```output +GroundStationName StartAzimuthDegree EndAzimuthDegree StartElevationDegree EndElevationDegree MaximumElevationDegree RxStartTime RxEndTime +----------------- ------------------ ---------------- -------------------- ------------------ ---------------------- ----------- --------- +Microsoft_Gavle 13.77217 225.1679 4.999997 5.005328 44.586 5/9/2023 2:24:07 AM 5/9/2023 2:35:15 AM +Microsoft_Gavle 8.178263 275.0042 4.999985 5.018794 14.834 5/9/2023 4:02:13 AM 5/9/2023 4:10:34 AM +Microsoft_Gavle 4.437663 325.7795 4.999995 5.013724 6.46 5/9/2023 5:40:23 AM 5/9/2023 5:44:10 AM +Microsoft_Gavle 22.93799 355.8058 5.000004 5.007165 5.71 5/9/2023 7:16:26 AM 5/9/2023 7:19:06 AM +Microsoft_Gavle 73.33928 352.9607 5.000013 5.031366 11.955 5/9/2023 8:49:49 AM 5/9/2023 8:57:12 AM +Microsoft_Gavle 123.3645 347.7329 4.999993 5.041272 33.262 5/9/2023 10:24:39 AM 5/9/2023 10:35:21 AM +Microsoft_Gavle 173.6422 340.1027 4.999974 5.024394 61.188 5/9/2023 12:01:46 PM 5/9/2023 12:13:15 PM +Microsoft_Gavle 231.5447 325.2475 4.999982 5.020995 14.006 5/9/2023 1:42:01 PM 5/9/2023 1:50:22 PM +Microsoft_Gavle 30.4992 141.2818 5.000002 5.04285 18.785 5/9/2023 11:50:46 PM 5/10/2023 12:00:14 AM +Microsoft_Gavle 18.08898 196.4807 4.999971 5.052687 82.019 5/10/2023 1:28:09 AM 5/10/2023 1:39:43 AM +``` + +Returns list of available contacts. +A contact is available if the spacecraft is visible from the ground station for more than the minimum viable contact duration provided in the contact profile. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactProfileId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ListExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +End time of a contact (ISO 8601 UTC standard). + +```yaml +Type: System.DateTime +Parameter Sets: ListExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroundStationName +Name of Azure Ground Station. + +```yaml +Type: System.String +Parameter Sets: ListExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Spacecraft ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SpacecraftName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Parameters that define the contact resource. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.IContactParameters +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Start time of a contact (ISO 8601 UTC standard). + +```yaml +Type: System.DateTime +Parameter Sets: ListExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.IContactParameters + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.IAvailableContacts + +## 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. + + +`PARAMETER <IContactParameters>`: Parameters that define the contact resource. + - `ContactProfileId <String>`: Resource ID. + - `EndTime <DateTime>`: End time of a contact (ISO 8601 UTC standard). + - `GroundStationName <String>`: Name of Azure Ground Station. + - `StartTime <DateTime>`: Start time of a contact (ISO 8601 UTC standard). + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/Get-AzOrbitalContactProfile.md b/azps-10.1.0/Az.Orbital/Get-AzOrbitalContactProfile.md new file mode 100644 index 0000000000..3bedf848e5 --- /dev/null +++ b/azps-10.1.0/Az.Orbital/Get-AzOrbitalContactProfile.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.orbital/get-azorbitalcontactprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Get-AzOrbitalContactProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Get-AzOrbitalContactProfile.md +--- + +# Get-AzOrbitalContactProfile + +## SYNOPSIS +Gets the specified contact Profile in a specified resource group. + +## SYNTAX + +### List (Default) +``` +Get-AzOrbitalContactProfile [-SubscriptionId <String[]>] [-Skiptoken <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzOrbitalContactProfile -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzOrbitalContactProfile -InputObject <IOrbitalIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzOrbitalContactProfile -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Skiptoken <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the specified contact Profile in a specified resource group. + +## EXAMPLES + +### Example 1: List the specified contact Profile. +```powershell +Get-AzOrbitalContactProfile +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +azps-orbital-contactprofile westus2 succeeded azpstest-gp +``` + +List the specified contact Profile. + +### Example 2: Gets the specified contact Profile in a specified resource group. +```powershell +Get-AzOrbitalContactProfile -ResourceGroupName azpstest-gp +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +azps-orbital-contactprofile westus2 succeeded azpstest-gp +Sweden-contactprofile swedencentral succeeded azpstest-gp +``` + +Gets the specified contact Profile in a specified resource group. + +### Example 2: Get the specified contact Profile in a specified. +```powershell +Get-AzOrbitalContactProfile -ResourceGroupName azpstest-gp -Name azps-orbital-contactprofile +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +azps-orbital-contactprofile westus2 succeeded azpstest-gp +``` + +Get the specified contact Profile in a specified. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Contact Profile name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ContactProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skiptoken +An opaque string that the resource provider uses to skip over previously-returned results. +This is used when a previous list operation call returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.String +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.IContactProfile + +## 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 <IOrbitalIdentity>`: Identity Parameter + - `[ContactName <String>]`: Contact name. + - `[ContactProfileName <String>]`: Contact Profile name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SpacecraftName <String>]`: Spacecraft ID. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/Get-AzOrbitalSpacecraft.md b/azps-10.1.0/Az.Orbital/Get-AzOrbitalSpacecraft.md new file mode 100644 index 0000000000..d799225b21 --- /dev/null +++ b/azps-10.1.0/Az.Orbital/Get-AzOrbitalSpacecraft.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.orbital/get-azorbitalspacecraft +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Get-AzOrbitalSpacecraft.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Get-AzOrbitalSpacecraft.md +--- + +# Get-AzOrbitalSpacecraft + +## SYNOPSIS +Gets the specified spacecraft in a specified resource group. + +## SYNTAX + +### List (Default) +``` +Get-AzOrbitalSpacecraft [-SubscriptionId <String[]>] [-Skiptoken <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzOrbitalSpacecraft -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzOrbitalSpacecraft -InputObject <IOrbitalIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzOrbitalSpacecraft -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Skiptoken <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the specified spacecraft in a specified resource group. + +## EXAMPLES + +### Example 1: List the specified spacecraft. +```powershell +Get-AzOrbitalSpacecraft +``` + +```output +Name Location NoradId TitleLine ResourceGroupName +---- -------- ------- --------- ----------------- +azpstest-test-spacecraft westus2 12345 ISS (ZARYA) azpstest-gp +AQUA eastus 12345 ISS (ZARYA) azpstest-gp +``` + +List the specified spacecraft. + +### Example 2: Gets the specified spacecraft in a specified resource group. +```powershell +Get-AzOrbitalSpacecraft -ResourceGroupName azpstest-gp +``` + +```output +Name Location NoradId TitleLine ResourceGroupName +---- -------- ------- --------- ----------------- +AQUA westus2 27424 AQUA azpstest-gp +``` + +Gets the specified spacecraft in a specified resource group. + +### Example 3: Get the specified spacecraft in a specified Name. +```powershell +Get-AzOrbitalSpacecraft -ResourceGroupName azpstest-gp -Name AQUA +``` + +```output +Name Location NoradId TitleLine ResourceGroupName +---- -------- ------- --------- ----------------- +AQUA westus2 27424 AQUA azpstest-gp +``` + +Get the specified spacecraft in a specified Name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Spacecraft ID. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SpacecraftName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skiptoken +An opaque string that the resource provider uses to skip over previously-returned results. +This is used when a previous list operation call returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.String +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.ISpacecraft + +## 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 <IOrbitalIdentity>`: Identity Parameter + - `[ContactName <String>]`: Contact name. + - `[ContactProfileName <String>]`: Contact Profile name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SpacecraftName <String>]`: Spacecraft ID. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/Get-AzOrbitalSpacecraftContact.md b/azps-10.1.0/Az.Orbital/Get-AzOrbitalSpacecraftContact.md new file mode 100644 index 0000000000..3d6b6e8147 --- /dev/null +++ b/azps-10.1.0/Az.Orbital/Get-AzOrbitalSpacecraftContact.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.orbital/get-azorbitalspacecraftcontact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Get-AzOrbitalSpacecraftContact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Get-AzOrbitalSpacecraftContact.md +--- + +# Get-AzOrbitalSpacecraftContact + +## SYNOPSIS +Gets the specified contact in a specified resource group. + +## SYNTAX + +### List (Default) +``` +Get-AzOrbitalSpacecraftContact -ResourceGroupName <String> -SpacecraftName <String> + [-SubscriptionId <String[]>] [-Skiptoken <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzOrbitalSpacecraftContact -Name <String> -ResourceGroupName <String> -SpacecraftName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzOrbitalSpacecraftContact -InputObject <IOrbitalIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the specified contact in a specified resource group. + +## EXAMPLES + +### Example 1: Get the specified contact in a specified Name. +```powershell +Get-AzOrbitalSpacecraftContact -Name contact-05-09-2023-07:09:41 -ResourceGroupName azpstest-gp -SpacecraftName SwedenAQUASpacecraft +``` + +```output +Name GroundStationName Status ReservationStartTime ReservationEndTime ResourceGroupName +---- ----------------- ------ -------------------- ------------------ ----------------- +contact-05-09-2023-07:09:41 Microsoft_Gavle scheduled 5/9/2023 7:09:41 AM 5/9/2023 7:12:33 AM azpstest-gp +``` + +Get the specified contact in a specified Name. + +### Example 2: List the specified spacecraft contact in specified spacecraft. +```powershell +Get-AzOrbitalSpacecraftContact -ResourceGroupName azpstest-gp -SpacecraftName SwedenAQUASpacecraft +``` + +```output +Name GroundStationName Status ReservationStartTime ReservationEndTime ResourceGroupName +---- ----------------- ------ -------------------- ------------------ ----------------- +contact-05-08-2023-03:12:51 Microsoft_Gavle scheduled 5/8/2023 3:12:51 AM 5/8/2023 3:22:33 AM azpstest-gp +contact-05-10-2023-01:22:06 Microsoft_Gavle scheduled 5/10/2023 1:22:06 AM 5/10/2023 1:33:43 AM azpstest-gp +contact-05-09-2023-03:55:36 Microsoft_Gavle scheduled 5/9/2023 3:55:36 AM 5/9/2023 4:03:46 AM azpstest-gp +contact-05-09-2023-05:33:49 Microsoft_Gavle scheduled 5/9/2023 5:33:49 AM 5/9/2023 5:37:20 AM azpstest-gp +contact-05-09-2023-00:39:33 Microsoft_Gavle scheduled 5/9/2023 12:39:33 AM 5/9/2023 12:50:53 AM azpstest-gp +contact-05-09-2023-08:43:07 Microsoft_Gavle scheduled 5/9/2023 8:43:07 AM 5/9/2023 8:50:44 AM azpstest-gp +contact-05-10-2023-04:38:23 Microsoft_Gavle scheduled 5/10/2023 4:38:23 AM 5/10/2023 4:44:39 AM azpstest-gp +contact-05-10-2023-03:00:09 Microsoft_Gavle scheduled 5/10/2023 3:00:09 AM 5/10/2023 3:10:15 AM azpstest-gp +contact-05-09-2023-02:17:26 Microsoft_Gavle scheduled 5/9/2023 2:17:26 AM 5/9/2023 2:28:31 AM azpstest-gp +contact-05-09-2023-13:35:52 Microsoft_Gavle scheduled 5/9/2023 1:35:52 PM 5/9/2023 1:43:57 PM azpstest-gp +contact-05-09-2023-23:44:37 Microsoft_Gavle scheduled 5/9/2023 11:44:37 PM 5/9/2023 11:54:23 PM azpstest-gp +contact-05-08-2023-11:12:43 Microsoft_Gavle scheduled 5/8/2023 11:12:43 AM 5/8/2023 11:24:16 AM azpstest-gp +contact-05-09-2023-11:55:23 Microsoft_Gavle scheduled 5/9/2023 11:55:23 AM 5/9/2023 12:06:52 PM azpstest-gp +contact-05-08-2023-12:51:37 Microsoft_Gavle scheduled 5/8/2023 12:51:37 PM 5/8/2023 1:01:53 PM azpstest-gp +contact-05-08-2023-08:02:19 Microsoft_Gavle scheduled 5/8/2023 8:02:19 AM 5/8/2023 8:07:57 AM azpstest-gp +contact-05-09-2023-07:09:41 Microsoft_Gavle scheduled 5/9/2023 7:09:41 AM 5/9/2023 7:12:33 AM azpstest-gp +contact-05-10-2023-06:16:21 Microsoft_Gavle scheduled 5/10/2023 6:16:21 AM 5/10/2023 6:18:01 AM azpstest-gp +contact-05-09-2023-10:18:06 Microsoft_Gavle scheduled 5/9/2023 10:18:06 AM 5/9/2023 10:28:55 AM azpstest-gp +contact-05-08-2023-23:02:44 Microsoft_Gavle scheduled 5/8/2023 11:02:44 PM 5/8/2023 11:09:47 PM azpstest-gp +contact-05-08-2023-09:36:30 Microsoft_Gavle scheduled 5/8/2023 9:36:30 AM 5/8/2023 9:46:11 AM azpstest-gp +``` + +Gets the specified spacecraft contact in a specified resource group and specified spacecraft. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Contact name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ContactName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skiptoken +An opaque string that the resource provider uses to skip over previously-returned results. +This is used when a previous list operation call returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpacecraftName +Spacecraft ID. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.IContact + +## 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 <IOrbitalIdentity>`: Identity Parameter + - `[ContactName <String>]`: Contact name. + - `[ContactProfileName <String>]`: Contact Profile name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SpacecraftName <String>]`: Spacecraft ID. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/New-AzOrbitalContactProfile.md b/azps-10.1.0/Az.Orbital/New-AzOrbitalContactProfile.md new file mode 100644 index 0000000000..d588da5e47 --- /dev/null +++ b/azps-10.1.0/Az.Orbital/New-AzOrbitalContactProfile.md @@ -0,0 +1,358 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.orbital/new-azorbitalcontactprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/New-AzOrbitalContactProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/New-AzOrbitalContactProfile.md +--- + +# New-AzOrbitalContactProfile + +## SYNOPSIS +Creates or updates a contact profile. + +## SYNTAX + +``` +New-AzOrbitalContactProfile -Name <String> -ResourceGroupName <String> -Link <IContactProfileLink[]> + -Location <String> -NetworkConfigurationSubnetId <String> [-SubscriptionId <String>] + [-AutoTrackingConfiguration <AutoTrackingConfiguration>] [-EventHubUri <String>] + [-MinimumElevationDegree <Single>] [-MinimumViableContactDuration <String>] [-Tag <Hashtable>] + [-ThirdPartyConfiguration <IContactProfileThirdPartyConfiguration[]>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a contact profile. + +## EXAMPLES + +### Example 1: Creates or updates a contact profile. +```powershell +$linkChannel = New-AzOrbitalContactProfileLinkChannelObject -BandwidthMHz 15 -CenterFrequencyMHz 8160 -EndPointIPAddress 10.0.1.0 -EndPointName AQUA_VM -EndPointPort 51103 -EndPointProtocol TCP -Name channel1 -DecodingConfiguration na -DemodulationConfiguration na -EncodingConfiguration na -ModulationConfiguration aqua_direct_broadcast + +$profileLink = New-AzOrbitalContactProfileLinkObject -Channel $linkChannel -Direction Downlink -Name RHCP_Downlink -Polarization RHCP -EirpdBw 0 -GainOverTemperature 0 + +New-AzOrbitalContactProfile -Name azps-orbital-contactprofile -ResourceGroupName azpstest-gp -Location westus2 -AutoTrackingConfiguration xBand -EventHubUri /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/azpstest-gp/providers/Microsoft.EventHub/namespaces/eventhub-test -Link $profileLink -MinimumElevationDegree 5 -MinimumViableContactDuration PT1M -NetworkConfigurationSubnetId /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/azpstest-gp/providers/Microsoft.Network/virtualNetworks/orbital-virtualnetwork/subnets/orbital-vn +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +azps-orbital-contactprofile westus2 succeeded azpstest-gp +``` + +Creates or updates a contact profile. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoTrackingConfiguration +Auto-tracking configuration. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Support.AutoTrackingConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubUri +ARM resource identifier of the Event Hub used for telemetry. +Requires granting Orbital Resource Provider the rights to send telemetry into the hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Link +Links of the Contact Profile. +Describes RF links, modem processing, and IP endpoints. +To construct, see NOTES section for LINK properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.IContactProfileLink[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumElevationDegree +Minimum viable elevation for the contact in decimal degrees. +Used for listing the available contacts with a spacecraft at a given ground station. + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumViableContactDuration +Minimum viable contact duration in ISO 8601 format. +Used for listing the available contacts with a spacecraft at a given ground station. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Contact Profile name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ContactProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkConfigurationSubnetId +ARM resource identifier of the subnet delegated to the Microsoft.Orbital/orbitalGateways. +Needs to be at least a class C subnet, and should not have any IP created in it. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThirdPartyConfiguration +Third-party mission configuration of the Contact Profile. +Describes RF links, modem processing, and IP endpoints. +To construct, see NOTES section for THIRDPARTYCONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.IContactProfileThirdPartyConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.IContactProfile + +## 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. + + +`LINK <IContactProfileLink[]>`: Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints. + - `Channel <IContactProfileLinkChannel[]>`: Contact Profile Link Channel. + - `BandwidthMHz <Single>`: Bandwidth in MHz. + - `CenterFrequencyMHz <Single>`: Center Frequency in MHz. + - `EndPointIPAddress <String>`: IP Address (IPv4). + - `EndPointName <String>`: Name of an end point. + - `EndPointPort <String>`: TCP port to listen on to receive data. + - `EndPointProtocol <Protocol>`: Protocol either UDP or TCP. + - `Name <String>`: Channel name. + - `[DecodingConfiguration <String>]`: Currently unused. + - `[DemodulationConfiguration <String>]`: Copy of the modem configuration file such as Kratos QRadio or Kratos QuantumRx. Only valid for downlink directions. If provided, the modem connects to the customer endpoint and sends demodulated data instead of a VITA.49 stream. + - `[EncodingConfiguration <String>]`: Currently unused. + - `[ModulationConfiguration <String>]`: Copy of the modem configuration file such as Kratos QRadio. Only valid for uplink directions. If provided, the modem connects to the customer endpoint and accepts commands from the customer instead of a VITA.49 stream. + - `Direction <Direction>`: Direction (Uplink or Downlink). + - `Name <String>`: Link name. + - `Polarization <Polarization>`: Polarization. e.g. (RHCP, LHCP). + - `[EirpdBw <Single?>]`: Effective Isotropic Radiated Power (EIRP) in dBW. It is the required EIRP by the customer. Not used yet. + - `[GainOverTemperature <Single?>]`: Gain to noise temperature in db/K. It is the required G/T by the customer. Not used yet. + +`THIRDPARTYCONFIGURATION <IContactProfileThirdPartyConfiguration[]>`: Third-party mission configuration of the Contact Profile. Describes RF links, modem processing, and IP endpoints. + - `MissionConfiguration <String>`: Name of string referencing the configuration describing contact set-up for a particular mission. Expected values are those which have been created in collaboration with the partner network. + - `ProviderName <String>`: Name of the third-party provider. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/New-AzOrbitalContactProfileLinkChannelObject.md b/azps-10.1.0/Az.Orbital/New-AzOrbitalContactProfileLinkChannelObject.md new file mode 100644 index 0000000000..ce93b0a295 --- /dev/null +++ b/azps-10.1.0/Az.Orbital/New-AzOrbitalContactProfileLinkChannelObject.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.Orbital/new-AzOrbitalContactProfileLinkChannelObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/New-AzOrbitalContactProfileLinkChannelObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/New-AzOrbitalContactProfileLinkChannelObject.md +--- + +# New-AzOrbitalContactProfileLinkChannelObject + +## SYNOPSIS +Create an in-memory object for ContactProfileLinkChannel. + +## SYNTAX + +``` +New-AzOrbitalContactProfileLinkChannelObject -BandwidthMHz <Single> -CenterFrequencyMHz <Single> + -EndPointIPAddress <String> -EndPointName <String> -EndPointPort <String> -EndPointProtocol <Protocol> + -Name <String> [-DecodingConfiguration <String>] [-DemodulationConfiguration <String>] + [-EncodingConfiguration <String>] [-ModulationConfiguration <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ContactProfileLinkChannel. + +## EXAMPLES + +### Example 1: Create a ContactProfileLinkChannel object. +```powershell +New-AzOrbitalContactProfileLinkChannelObject -BandwidthMHz 0.036 -CenterFrequencyMHz 2106.4063 -EndPointIPAddress 10.0.1.0 -EndPointName AQUA_command -EndPointPort 4000 -EndPointProtocol TCP -Name channel1 -DecodingConfiguration na -DemodulationConfiguration na -EncodingConfiguration AQUA_CMD_CCSDS -ModulationConfiguration AQUA_UPLINK_BPSK +``` + +```output +BandwidthMHz CenterFrequencyMHz DecodingConfiguration DemodulationConfiguration EncodingConfiguration ModulationConfiguration Name +------------ ------------------ --------------------- ------------------------- --------------------- ----------------------- ---- +0.036 2106.406 na na AQUA_CMD_CCSDS AQUA_UPLINK_BPSK channel1 +``` + +Create a ContactProfileLinkChannel object. + +## PARAMETERS + +### -BandwidthMHz +Bandwidth in MHz. + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CenterFrequencyMHz +Center Frequency in MHz. + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DecodingConfiguration +Configuration for decoding. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DemodulationConfiguration +Configuration for demodulation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncodingConfiguration +Configuration for encoding. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndPointIPAddress +IP Address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndPointName +Name of an end point. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndPointPort +TCP port to listen on to receive data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndPointProtocol +Protocol either UDP or TCP. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Support.Protocol +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModulationConfiguration +Configuration for modulation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Channel name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.ContactProfileLinkChannel + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/New-AzOrbitalContactProfileLinkObject.md b/azps-10.1.0/Az.Orbital/New-AzOrbitalContactProfileLinkObject.md new file mode 100644 index 0000000000..44c04ad1fb --- /dev/null +++ b/azps-10.1.0/Az.Orbital/New-AzOrbitalContactProfileLinkObject.md @@ -0,0 +1,169 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.Orbital/new-AzOrbitalContactProfileLinkObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/New-AzOrbitalContactProfileLinkObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/New-AzOrbitalContactProfileLinkObject.md +--- + +# New-AzOrbitalContactProfileLinkObject + +## SYNOPSIS +Create an in-memory object for ContactProfileLink. + +## SYNTAX + +``` +New-AzOrbitalContactProfileLinkObject -Channel <IContactProfileLinkChannel[]> -Direction <Direction> + -Name <String> -Polarization <Polarization> [-EirpdBw <Single>] [-GainOverTemperature <Single>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ContactProfileLink. + +## EXAMPLES + +### Example 1: Create a ContactProfileLink object. +```powershell +$linkChannel = New-AzOrbitalContactProfileLinkChannelObject -BandwidthMHz 0.036 -CenterFrequencyMHz 2106.4063 -EndPointIPAddress 10.0.1.0 -EndPointName AQUA_command -EndPointPort 4000 -EndPointProtocol TCP -Name channel1 -DecodingConfiguration na -DemodulationConfiguration na -EncodingConfiguration AQUA_CMD_CCSDS -ModulationConfiguration AQUA_UPLINK_BPSK + +New-AzOrbitalContactProfileLinkObject -Channel $linkChannel -Direction uplink -Name RHCP_UL -Polarization RHCP -EirpdBw 45 -GainOverTemperature 0 +``` + +```output +Direction EirpdBw GainOverTemperature Name Polarization +--------- ------- ------------------- ---- ------------ +uplink 45 0 RHCP_UL RHCP +``` + +Create a ContactProfileLink object. + +## PARAMETERS + +### -Channel +Contact Profile Link Channel. +To construct, see NOTES section for CHANNEL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.IContactProfileLinkChannel[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Direction (uplink or downlink). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Support.Direction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EirpdBw +Effective Isotropic Radiated Power (EIRP) in dBW. + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GainOverTemperature +Gain To Noise Temperature in db/K. + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Link name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Polarization +polarization. +eg (RHCP, LHCP). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Support.Polarization +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.ContactProfileLink + +## 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. + + +`CHANNEL <IContactProfileLinkChannel[]>`: Contact Profile Link Channel. + - `BandwidthMHz <Single>`: Bandwidth in MHz. + - `CenterFrequencyMHz <Single>`: Center Frequency in MHz. + - `EndPointIPAddress <String>`: IP Address (IPv4). + - `EndPointName <String>`: Name of an end point. + - `EndPointPort <String>`: TCP port to listen on to receive data. + - `EndPointProtocol <Protocol>`: Protocol either UDP or TCP. + - `Name <String>`: Channel name. + - `[DecodingConfiguration <String>]`: Currently unused. + - `[DemodulationConfiguration <String>]`: Copy of the modem configuration file such as Kratos QRadio or Kratos QuantumRx. Only valid for downlink directions. If provided, the modem connects to the customer endpoint and sends demodulated data instead of a VITA.49 stream. + - `[EncodingConfiguration <String>]`: Currently unused. + - `[ModulationConfiguration <String>]`: Copy of the modem configuration file such as Kratos QRadio. Only valid for uplink directions. If provided, the modem connects to the customer endpoint and accepts commands from the customer instead of a VITA.49 stream. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/New-AzOrbitalSpacecraft.md b/azps-10.1.0/Az.Orbital/New-AzOrbitalSpacecraft.md new file mode 100644 index 0000000000..bd06435028 --- /dev/null +++ b/azps-10.1.0/Az.Orbital/New-AzOrbitalSpacecraft.md @@ -0,0 +1,302 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.orbital/new-azorbitalspacecraft +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/New-AzOrbitalSpacecraft.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/New-AzOrbitalSpacecraft.md +--- + +# New-AzOrbitalSpacecraft + +## SYNOPSIS +Creates or updates a spacecraft resource. + +## SYNTAX + +``` +New-AzOrbitalSpacecraft -Name <String> -ResourceGroupName <String> -Link <ISpacecraftLink[]> + -Location <String> -TitleLine <String> -TleLine1 <String> -TleLine2 <String> [-SubscriptionId <String>] + [-NoradId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a spacecraft resource. + +## EXAMPLES + +### Example 1: Creates or updates a spacecraft resource. +```powershell +$linkObject = New-AzOrbitalSpacecraftLinkObject -BandwidthMHz 15 -CenterFrequencyMHz 8160 -Direction 'Downlink' -Name spacecraftlink -Polarization 'RHCP' + +New-AzOrbitalSpacecraft -Name AQUA -ResourceGroupName azpstest-gp -Location westus2 -Link $linkObject -NoradId 27424 -TitleLine "AQUA" -TleLine1 "1 27424U 02022A 23128.13172751 .00001518 00000+0 34030-3 0 9995" -TleLine2 "2 27424 98.2850 72.6931 0000969 56.1431 359.6436 14.58017750117525" +``` + +```output +Name Location NoradId TitleLine ResourceGroupName +---- -------- ------- --------- ----------------- +AQUA westus2 27424 AQUA azpstest-gp +``` + +Creates or updates a spacecraft resource. +Get an up-to-date Two-Line Element (TLE) for spacecraft by checking CelesTrak. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Link +Immutable list of Spacecraft links. +To construct, see NOTES section for LINK properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.ISpacecraftLink[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Spacecraft ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SpacecraftName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoradId +NORAD ID of the spacecraft. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TitleLine +Title line of the two-line element set (TLE). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TleLine1 +Line 1 of the two-line element set (TLE). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TleLine2 +Line 2 of the two-line element set (TLE). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.ISpacecraft + +## 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. + + +`LINK <ISpacecraftLink[]>`: Immutable list of Spacecraft links. + - `BandwidthMHz <Single>`: Bandwidth in MHz. + - `CenterFrequencyMHz <Single>`: Center Frequency in MHz. + - `Direction <Direction>`: Direction (Uplink or Downlink). + - `Name <String>`: Link name. + - `Polarization <Polarization>`: Polarization. e.g. (RHCP, LHCP). + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/New-AzOrbitalSpacecraftContact.md b/azps-10.1.0/Az.Orbital/New-AzOrbitalSpacecraftContact.md new file mode 100644 index 0000000000..ba6fb920fc --- /dev/null +++ b/azps-10.1.0/Az.Orbital/New-AzOrbitalSpacecraftContact.md @@ -0,0 +1,259 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.orbital/new-azorbitalspacecraftcontact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/New-AzOrbitalSpacecraftContact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/New-AzOrbitalSpacecraftContact.md +--- + +# New-AzOrbitalSpacecraftContact + +## SYNOPSIS +Creates a contact. + +## SYNTAX + +``` +New-AzOrbitalSpacecraftContact -Name <String> -ResourceGroupName <String> -SpacecraftName <String> + -ContactProfileId <String> -GroundStationName <String> -ReservationEndTime <DateTime> + -ReservationStartTime <DateTime> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a contact. + +## EXAMPLES + +### Example 1: Creates a contact. +```powershell +$dateS = Get-Date -Year 2023 -Month 5 -Day 10 -Hour 11 -Minute 06 -Second 07 +$dateE = Get-Date -Year 2023 -Month 5 -Day 10 -Hour 11 -Minute 16 -Second 21 + +New-AzOrbitalSpacecraftContact -Name azps-orbital-contact -ResourceGroupName azpstest-gp -SpacecraftName SwedenAQUASpacecraft -ContactProfileId "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/azpstest-gp/providers/Microsoft.Orbital/contactProfiles/Sweden-contactprofile" -GroundStationName "Microsoft_Gavle" -ReservationStartTime $dateS -ReservationEndTime $dateE +``` + +```output +Name GroundStationName Status ReservationStartTime ReservationEndTime ResourceGroupName +---- ----------------- ------ -------------------- ------------------ ----------------- +azps-orbital-contact Microsoft_Gavle scheduled 5/10/2023 3:06:07 AM 5/10/2023 3:16:21 AM azpstest-gp +``` + +Creates a contact. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContactProfileId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroundStationName +Azure Ground Station name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Contact name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ContactName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationEndTime +Reservation end time of a contact (ISO 8601 UTC standard). + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationStartTime +Reservation start time of a contact (ISO 8601 UTC standard). + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpacecraftName +Spacecraft ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.IContact + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/New-AzOrbitalSpacecraftLinkObject.md b/azps-10.1.0/Az.Orbital/New-AzOrbitalSpacecraftLinkObject.md new file mode 100644 index 0000000000..2884c8d4bb --- /dev/null +++ b/azps-10.1.0/Az.Orbital/New-AzOrbitalSpacecraftLinkObject.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.Orbital/new-AzOrbitalSpacecraftLinkObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/New-AzOrbitalSpacecraftLinkObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/New-AzOrbitalSpacecraftLinkObject.md +--- + +# New-AzOrbitalSpacecraftLinkObject + +## SYNOPSIS +Create an in-memory object for SpacecraftLink. + +## SYNTAX + +``` +New-AzOrbitalSpacecraftLinkObject -BandwidthMHz <Single> -CenterFrequencyMHz <Single> -Direction <Direction> + -Name <String> -Polarization <Polarization> [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SpacecraftLink. + +## EXAMPLES + +### Example 1: Create a SpacecraftLink object for OrbitalSpacecraft. +```powershell +New-AzOrbitalSpacecraftLinkObject -BandwidthMHz 50 -CenterFrequencyMHz 50 -Direction 'Uplink' -Name spacecraftlink -Polarization 'LHCP' +``` + +```output +BandwidthMHz CenterFrequencyMHz Direction Name Polarization +------------ ------------------ --------- ---- ------------ +50 50 Uplink spacecraftlink LHCP +``` + +Create a SpacecraftLink object for OrbitalSpacecraft. + +## PARAMETERS + +### -BandwidthMHz +Bandwidth in MHz. + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CenterFrequencyMHz +Center Frequency in MHz. + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Direction (uplink or downlink). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Support.Direction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Link name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Polarization +polarization. +eg (RHCP, LHCP). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Support.Polarization +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.SpacecraftLink + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/Remove-AzOrbitalContactProfile.md b/azps-10.1.0/Az.Orbital/Remove-AzOrbitalContactProfile.md new file mode 100644 index 0000000000..1184c534e6 --- /dev/null +++ b/azps-10.1.0/Az.Orbital/Remove-AzOrbitalContactProfile.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.orbital/remove-azorbitalcontactprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Remove-AzOrbitalContactProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Remove-AzOrbitalContactProfile.md +--- + +# Remove-AzOrbitalContactProfile + +## SYNOPSIS +Deletes a specified contact profile resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzOrbitalContactProfile -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzOrbitalContactProfile -InputObject <IOrbitalIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a specified contact profile resource. + +## EXAMPLES + +### Example 1: Deletes a specified contact profile resource. +```powershell +Remove-AzOrbitalContactProfile -Name azps-orbital-contactprofile -ResourceGroupName azpstest-gp +``` + +Deletes a specified contact profile resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Contact Profile name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ContactProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IOrbitalIdentity>`: Identity Parameter + - `[ContactName <String>]`: Contact name. + - `[ContactProfileName <String>]`: Contact Profile name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SpacecraftName <String>]`: Spacecraft ID. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/Remove-AzOrbitalSpacecraft.md b/azps-10.1.0/Az.Orbital/Remove-AzOrbitalSpacecraft.md new file mode 100644 index 0000000000..70c16e18bf --- /dev/null +++ b/azps-10.1.0/Az.Orbital/Remove-AzOrbitalSpacecraft.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.orbital/remove-azorbitalspacecraft +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Remove-AzOrbitalSpacecraft.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Remove-AzOrbitalSpacecraft.md +--- + +# Remove-AzOrbitalSpacecraft + +## SYNOPSIS +Deletes a specified spacecraft resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzOrbitalSpacecraft -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzOrbitalSpacecraft -InputObject <IOrbitalIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a specified spacecraft resource. + +## EXAMPLES + +### Example 1: Deletes a specified spacecraft resource. +```powershell +Remove-AzOrbitalSpacecraft -ResourceGroupName azpstest-gp -Name AQUA +``` + +Deletes a specified spacecraft resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Spacecraft ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SpacecraftName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IOrbitalIdentity>`: Identity Parameter + - `[ContactName <String>]`: Contact name. + - `[ContactProfileName <String>]`: Contact Profile name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SpacecraftName <String>]`: Spacecraft ID. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/Remove-AzOrbitalSpacecraftContact.md b/azps-10.1.0/Az.Orbital/Remove-AzOrbitalSpacecraftContact.md new file mode 100644 index 0000000000..6be521ea18 --- /dev/null +++ b/azps-10.1.0/Az.Orbital/Remove-AzOrbitalSpacecraftContact.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.orbital/remove-azorbitalspacecraftcontact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Remove-AzOrbitalSpacecraftContact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Remove-AzOrbitalSpacecraftContact.md +--- + +# Remove-AzOrbitalSpacecraftContact + +## SYNOPSIS +Deletes a specified contact. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzOrbitalSpacecraftContact -Name <String> -ResourceGroupName <String> -SpacecraftName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzOrbitalSpacecraftContact -InputObject <IOrbitalIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a specified contact. + +## EXAMPLES + +### Example 1: Deletes a specified contact. +```powershell +Remove-AzOrbitalSpacecraftContact -Name azps-orbital-contact -ResourceGroupName azpstest-gp -SpacecraftName AQUA +``` + +Deletes a specified contact. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Contact name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ContactName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpacecraftName +Spacecraft ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IOrbitalIdentity>`: Identity Parameter + - `[ContactName <String>]`: Contact name. + - `[ContactProfileName <String>]`: Contact Profile name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SpacecraftName <String>]`: Spacecraft ID. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/Update-AzOrbitalContactProfile.md b/azps-10.1.0/Az.Orbital/Update-AzOrbitalContactProfile.md new file mode 100644 index 0000000000..facb66026e --- /dev/null +++ b/azps-10.1.0/Az.Orbital/Update-AzOrbitalContactProfile.md @@ -0,0 +1,247 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.orbital/update-azorbitalcontactprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Update-AzOrbitalContactProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Update-AzOrbitalContactProfile.md +--- + +# Update-AzOrbitalContactProfile + +## SYNOPSIS +Updates the specified contact profile tags. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzOrbitalContactProfile -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzOrbitalContactProfile -InputObject <IOrbitalIdentity> [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the specified contact profile tags. + +## EXAMPLES + +### Example 1: Updates the specified contact profile tags. +```powershell +Update-AzOrbitalContactProfile -Name azps-orbital-contactprofile -ResourceGroupName azpstest-gp -Tag @{"123"="abc"} +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +azps-orbital-contactprofile westus2 succeeded azpstest-gp +``` + +Updates the specified contact profile tags. + +### Example 2: Updates the specified contact profile tags. +```powershell +Get-AzOrbitalContactProfile -ResourceGroupName azpstest-gp -Name azps-orbital-contactprofile | Update-AzOrbitalContactProfile -Tag @{"123"="abc"} +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +azps-orbital-contactprofile westus2 succeeded azpstest-gp +``` + +Updates the specified contact profile tags. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Contact Profile name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.IContactProfile + +## 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 <IOrbitalIdentity>`: Identity Parameter + - `[ContactName <String>]`: Contact name. + - `[ContactProfileName <String>]`: Contact Profile name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SpacecraftName <String>]`: Spacecraft ID. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Orbital/Update-AzOrbitalSpacecraft.md b/azps-10.1.0/Az.Orbital/Update-AzOrbitalSpacecraft.md new file mode 100644 index 0000000000..0283d5dbb2 --- /dev/null +++ b/azps-10.1.0/Az.Orbital/Update-AzOrbitalSpacecraft.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.Orbital +online version: https://learn.microsoft.com/powershell/module/az.orbital/update-azorbitalspacecraft +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Update-AzOrbitalSpacecraft.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Orbital/help/Update-AzOrbitalSpacecraft.md +--- + +# Update-AzOrbitalSpacecraft + +## SYNOPSIS +Updates the specified spacecraft tags. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzOrbitalSpacecraft -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzOrbitalSpacecraft -InputObject <IOrbitalIdentity> [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the specified spacecraft tags. + +## EXAMPLES + +### Example 1: Updates the specified spacecraft tags. +```powershell +Update-AzOrbitalSpacecraft -ResourceGroupName azpstest-gp -Name AQUA -Tag @{"123"="abc"} +``` + +```output +Name Location NoradId TitleLine ResourceGroupName +---- -------- ------- --------- ----------------- +AQUA westus2 27424 AQUA azpstest-gp +``` + +Updates the specified spacecraft tags. + +### Example 2: Updates the specified spacecraft tags. +```powershell +$spacecraftObject = Get-AzOrbitalSpacecraft -ResourceGroupName azpstest-gp -Name AQUA +Update-AzOrbitalSpacecraft -InputObject $spacecraftObject -Tag @{"123"="abc"} +``` + +```output +Name Location NoradId TitleLine ResourceGroupName +---- -------- ------- --------- ----------------- +AQUA westus2 27424 AQUA azpstest-gp +``` + +Updates the specified spacecraft tags. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Spacecraft ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.IOrbitalIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Orbital.Models.Api20221101.ISpacecraft + +## 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 <IOrbitalIdentity>`: Identity Parameter + - `[ContactName <String>]`: Contact name. + - `[ContactProfileName <String>]`: Contact Profile name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SpacecraftName <String>]`: Spacecraft ID. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Az.Peering.md b/azps-10.1.0/Az.Peering/Az.Peering.md new file mode 100644 index 0000000000..b6c25d6d07 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Az.Peering.md @@ -0,0 +1,132 @@ +--- +Module Name: Az.Peering +Module Guid: 78c6a853-5ea3-4374-9c5f-5b532d62c892 +Download Help Link: https://learn.microsoft.com/powershell/module/az.peering +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Az.Peering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Az.Peering.md +--- + +# Az.Peering Module +## Description +Microsoft Azure PowerShell: Peering cmdlets + +## Az.Peering Cmdlets +### [Get-AzPeering](Get-AzPeering.md) +Gets an existing peering with the specified name under the given subscription and resource group. + +### [Get-AzPeeringAsn](Get-AzPeeringAsn.md) +Gets the peer ASN with the specified name under the given subscription. + +### [Get-AzPeeringCdnPrefix](Get-AzPeeringCdnPrefix.md) +Lists all of the advertised prefixes for the specified peering location + +### [Get-AzPeeringConnectionMonitorTest](Get-AzPeeringConnectionMonitorTest.md) +Gets an existing connection monitor test with the specified name under the given subscription, resource group and peering service. + +### [Get-AzPeeringLegacy](Get-AzPeeringLegacy.md) +Lists all of the legacy peerings under the given subscription matching the specified kind and location. + +### [Get-AzPeeringLocation](Get-AzPeeringLocation.md) +Lists all of the available peering locations for the specified kind of peering. + +### [Get-AzPeeringReceivedRoute](Get-AzPeeringReceivedRoute.md) +Lists the prefixes received over the specified peering under the given subscription and resource group. + +### [Get-AzPeeringRegisteredAsn](Get-AzPeeringRegisteredAsn.md) +Gets an existing registered ASN with the specified name under the given subscription, resource group and peering. + +### [Get-AzPeeringRegisteredPrefix](Get-AzPeeringRegisteredPrefix.md) +Gets an existing registered prefix with the specified name under the given subscription, resource group and peering. + +### [Get-AzPeeringRpUnbilledPrefix](Get-AzPeeringRpUnbilledPrefix.md) +Lists all of the RP unbilled prefixes for the specified peering + +### [Get-AzPeeringService](Get-AzPeeringService.md) +Gets an existing peering service with the specified name under the given subscription and resource group. + +### [Get-AzPeeringServiceCountry](Get-AzPeeringServiceCountry.md) +Lists all of the available countries for peering service. + +### [Get-AzPeeringServiceLocation](Get-AzPeeringServiceLocation.md) +Lists all of the available locations for peering service. + +### [Get-AzPeeringServicePrefix](Get-AzPeeringServicePrefix.md) +Gets an existing prefix with the specified name under the given subscription, resource group and peering service. + +### [Get-AzPeeringServiceProvider](Get-AzPeeringServiceProvider.md) +Lists all of the available peering service locations for the specified kind of peering. + +### [Initialize-AzPeeringServiceConnectionMonitor](Initialize-AzPeeringServiceConnectionMonitor.md) +Initialize Peering Service for Connection Monitor functionality + +### [New-AzPeering](New-AzPeering.md) +Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group. + +### [New-AzPeeringAsn](New-AzPeeringAsn.md) +Creates a new peer ASN or updates an existing peer ASN with the specified name under the given subscription. + +### [New-AzPeeringCheckServiceProviderAvailabilityInputObject](New-AzPeeringCheckServiceProviderAvailabilityInputObject.md) +Create an in-memory object for CheckServiceProviderAvailabilityInput. + +### [New-AzPeeringConnectionMonitorTest](New-AzPeeringConnectionMonitorTest.md) +Creates or updates a connection monitor test with the specified name under the given subscription, resource group and peering service. + +### [New-AzPeeringContactDetailObject](New-AzPeeringContactDetailObject.md) +Create an in-memory object for ContactDetail. + +### [New-AzPeeringDirectConnectionObject](New-AzPeeringDirectConnectionObject.md) +Create an in-memory object for DirectConnection. + +### [New-AzPeeringExchangeConnectionObject](New-AzPeeringExchangeConnectionObject.md) +Create an in-memory object for ExchangeConnection. + +### [New-AzPeeringRegisteredAsn](New-AzPeeringRegisteredAsn.md) +Creates a new registered ASN with the specified name under the given subscription, resource group and peering. + +### [New-AzPeeringRegisteredPrefix](New-AzPeeringRegisteredPrefix.md) +Creates a new registered prefix with the specified name under the given subscription, resource group and peering. + +### [New-AzPeeringService](New-AzPeeringService.md) +Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group. + +### [New-AzPeeringServicePrefix](New-AzPeeringServicePrefix.md) +Creates a new prefix with the specified name under the given subscription, resource group and peering service. + +### [Remove-AzPeering](Remove-AzPeering.md) +Deletes an existing peering with the specified name under the given subscription and resource group. + +### [Remove-AzPeeringAsn](Remove-AzPeeringAsn.md) +Deletes an existing peer ASN with the specified name under the given subscription. + +### [Remove-AzPeeringConnectionMonitorTest](Remove-AzPeeringConnectionMonitorTest.md) +Deletes an existing connection monitor test with the specified name under the given subscription, resource group and peering service. + +### [Remove-AzPeeringRegisteredAsn](Remove-AzPeeringRegisteredAsn.md) +Deletes an existing registered ASN with the specified name under the given subscription, resource group and peering. + +### [Remove-AzPeeringRegisteredPrefix](Remove-AzPeeringRegisteredPrefix.md) +Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering. + +### [Remove-AzPeeringService](Remove-AzPeeringService.md) +Deletes an existing peering service with the specified name under the given subscription and resource group. + +### [Remove-AzPeeringServicePrefix](Remove-AzPeeringServicePrefix.md) +Deletes an existing prefix with the specified name under the given subscription, resource group and peering service. + +### [Start-AzPeeringInvokeLookingGlass](Start-AzPeeringInvokeLookingGlass.md) +Run looking glass functionality + +### [Test-AzPeeringRegisteredPrefix](Test-AzPeeringRegisteredPrefix.md) +Validates an existing registered prefix with the specified name under the given subscription, resource group and peering. + +### [Test-AzPeeringServiceProviderAvailability](Test-AzPeeringServiceProviderAvailability.md) +Checks if the peering service provider is present within 1000 miles of customer's location + +### [Update-AzPeering](Update-AzPeering.md) +Updates tags for a peering with the specified name under the given subscription and resource group. + +### [Update-AzPeeringService](Update-AzPeeringService.md) +Updates tags for a peering service with the specified name under the given subscription and resource group. + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeering.md b/azps-10.1.0/Az.Peering/Get-AzPeering.md new file mode 100644 index 0000000000..d545727d05 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeering.md @@ -0,0 +1,188 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeering.md +--- + +# Get-AzPeering + +## SYNOPSIS +Gets an existing peering with the specified name under the given subscription and resource group. + +## SYNTAX + +### List1 (Default) +``` +Get-AzPeering [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPeering -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPeering -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzPeering -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an existing peering with the specified name under the given subscription and resource group. + +## EXAMPLES + +### Example 1: List all peerings +```powershell + Get-AzPeering +``` + +```output +Name SkuName Kind PeeringLocation ProvisioningState Location +---- ------- ---- --------------- ----------------- -------- +DemoComp1 Premium_Direct_Free Direct Dallas Succeeded South Central US +DemoPeering Premium_Direct_Free Direct Dallas Succeeded South Central US +TestEdgeZone Premium_Direct_Free Direct Atlanta Succeeded East US 2 +MapsIxRs Premium_Direct_Free Direct Ashburn Succeeded East US +DemoMapsConfig Premium_Direct_Free Direct Seattle Succeeded West US 2 +testexchange Basic_Exchange_Free Exchange Amsterdam Succeeded West Europe +TestPeer1 Basic_Direct_Free Direct Amsterdam Succeeded West Europe +test1 Basic_Direct_Free Direct Athens Succeeded France Central +``` + +List all peerings in subscription + +### Example 2: Get specific peering by name and resource group +```powershell +Get-AzPeering -Name DemoPeering -ResourceGroupName DemoRG +``` + +```output +Name SkuName Kind PeeringLocation ProvisioningState Location +---- ------- ---- --------------- ----------------- -------- +DemoPeering Premium_Direct_Free Direct Dallas Succeeded South Central US +``` + +Get a specific peering by resource group and name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the peering. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PeeringName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeering + +## 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 <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringAsn.md b/azps-10.1.0/Az.Peering/Get-AzPeeringAsn.md new file mode 100644 index 0000000000..80d6652b26 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringAsn.md @@ -0,0 +1,160 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringasn +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringAsn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringAsn.md +--- + +# Get-AzPeeringAsn + +## SYNOPSIS +Gets the peer ASN with the specified name under the given subscription. + +## SYNTAX + +### List (Default) +``` +Get-AzPeeringAsn [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPeeringAsn -Name <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPeeringAsn -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the peer ASN with the specified name under the given subscription. + +## EXAMPLES + +### Example 1: List PeerAsns +```powershell +Get-AzPeeringAsn +``` + +```output +Name PeerName PropertiesPeerAsn ValidationState PeerContactDetail +---- -------- ----------------- --------------- ----------------- +ContosoEdgeTest Contoso 65000 Approved {{…}} + +``` + +List all the peer asns under subscription + +### Example 2: Get Specific PeerAsn +```powershell +Get-AzPeeringAsn -Name ContosoEdgeTest +``` + +```output +Name PeerName PropertiesPeerAsn ValidationState PeerContactDetail +---- -------- ----------------- --------------- ----------------- +ContosoEdgeTest Contoso 65000 Approved {{…}} +``` + +Get peer asn by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The peer ASN name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PeerAsnName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeerAsn + +## 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 <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringCdnPrefix.md b/azps-10.1.0/Az.Peering/Get-AzPeeringCdnPrefix.md new file mode 100644 index 0000000000..bec4e3642e --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringCdnPrefix.md @@ -0,0 +1,108 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringcdnprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringCdnPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringCdnPrefix.md +--- + +# Get-AzPeeringCdnPrefix + +## SYNOPSIS +Lists all of the advertised prefixes for the specified peering location + +## SYNTAX + +``` +Get-AzPeeringCdnPrefix -PeeringLocation <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Lists all of the advertised prefixes for the specified peering location + +## EXAMPLES + +### Example 1: Get Cdn prefixes +```powershell +Get-AzPeeringCdnPrefix -PeeringLocation Seattle +``` + +```output +Prefix AzureRegion AzureService IsPrimaryRegion BgpCommunity +------ ----------- ------------ --------------- ------------ +20.157.110.0/24 West US 2 AzureCompute True 8069:51026 +20.157.118.0/24 West US 2 AzureCompute True 8069:51026 +20.157.125.0/24 West US 2 AzureCompute True 8069:51026 +20.157.180.0/24 West US 2 AzureStorage True 8069:52026 +20.157.25.0/24 West US 2 AzureCompute True 8069:51026 +20.157.50.0/23 West US 2 AzureStorage True 8069:52026 +20.47.120.0/23 West US 2 AzureCompute True 8069:51026 +20.47.62.0/23 West US 2 AzureStorage True 8069:52026 +``` + +Get all cdn prefixes for subscription + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringLocation +The peering location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.ICdnPeeringPrefix + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringConnectionMonitorTest.md b/azps-10.1.0/Az.Peering/Get-AzPeeringConnectionMonitorTest.md new file mode 100644 index 0000000000..6633469f8b --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringConnectionMonitorTest.md @@ -0,0 +1,193 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringconnectionmonitortest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringConnectionMonitorTest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringConnectionMonitorTest.md +--- + +# Get-AzPeeringConnectionMonitorTest + +## SYNOPSIS +Gets an existing connection monitor test with the specified name under the given subscription, resource group and peering service. + +## SYNTAX + +### List (Default) +``` +Get-AzPeeringConnectionMonitorTest -PeeringServiceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPeeringConnectionMonitorTest -Name <String> -PeeringServiceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPeeringConnectionMonitorTest -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an existing connection monitor test with the specified name under the given subscription, resource group and peering service. + +## EXAMPLES + +### Example 1: Lists all connection monitor tests +```powershell + Get-AzPeeringConnectionMonitorTest -ResourceGroupName DemoRG -PeeringServiceName DRTest +``` + +```output +SourceAgent Destination DestinationPort TestFrequency Sucessful ProvisioningState +----------- ----------- --------------- ------------- --------- ----------------- +Agent 1 1.1.1.1 80 30 True Succeeded +Agent 2 8.8.8.8 80 30 True Succeeded +``` + +Lists all connection monitor test objects + +### Example 2: Get single connection monitor test +```powershell + Get-AzPeeringConnectionMonitorTest -ResourceGroupName DemoRG -PeeringServiceName DRTest -Name TestName +``` + +```output +SourceAgent Destination DestinationPort TestFrequency Sucessful ProvisioningState +----------- ----------- --------------- ------------- --------- ----------------- +Agent 1 1.1.1.1 80 30 True Succeeded +``` + +Gets a single connection monitor test + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the connection monitor test + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ConnectionMonitorTestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringServiceName +The name of the peering service. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IConnectionMonitorTest + +## 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 <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringLegacy.md b/azps-10.1.0/Az.Peering/Get-AzPeeringLegacy.md new file mode 100644 index 0000000000..ea8c41e12a --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringLegacy.md @@ -0,0 +1,148 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringlegacy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringLegacy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringLegacy.md +--- + +# Get-AzPeeringLegacy + +## SYNOPSIS +Lists all of the legacy peerings under the given subscription matching the specified kind and location. + +## SYNTAX + +``` +Get-AzPeeringLegacy -Kind <LegacyPeeringsKind> -PeeringLocation <String> [-SubscriptionId <String[]>] + [-Asn <Int32>] [-DirectPeeringType <DirectPeeringType>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all of the legacy peerings under the given subscription matching the specified kind and location. + +## EXAMPLES + +### Example 1: Gets legacy peering object +```powershell +Get-AzPeeringLegacy -Kind Direct -PeeringLocation Seattle +``` + +```output +Name SkuName Kind PeeringLocation ProvisioningState Location +---- ------- ---- --------------- ----------------- -------- +DemoComp1 Premium_Direct_Free Direct Dallas Succeeded South Central US +DemoPeering Premium_Direct_Free Direct Dallas Succeeded South Central US +TestEdgeZone Premium_Direct_Free Direct Atlanta Succeeded East US 2 +``` + +Gets legacy peering object + +## PARAMETERS + +### -Asn +The ASN number associated with a legacy peering. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectPeeringType +The direct peering type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Support.DirectPeeringType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +The kind of the peering. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Support.LegacyPeeringsKind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringLocation +The location of the peering. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeering + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringLocation.md b/azps-10.1.0/Az.Peering/Get-AzPeeringLocation.md new file mode 100644 index 0000000000..47bb0c7c27 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringLocation.md @@ -0,0 +1,125 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringlocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringLocation.md +--- + +# Get-AzPeeringLocation + +## SYNOPSIS +Lists all of the available peering locations for the specified kind of peering. + +## SYNTAX + +``` +Get-AzPeeringLocation -Kind <PeeringLocationsKind> [-SubscriptionId <String[]>] + [-DirectPeeringType <PeeringLocationsDirectPeeringType>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all of the available peering locations for the specified kind of peering. + +## EXAMPLES + +### Example 1: Get all direct peering locations +```powershell +Get-AzPeeringLocation -Kind Direct +``` + +```output +Get-AzPeeringLocation -Kind Direct + +Name Country AzureRegion Kind +---- ------- ----------- ---- +Amsterdam NL West Europe Direct +Ashburn US East US Direct +Athens GR France Central Direct +Atlanta US East US 2 Direct +Auckland NZ Australia East Direct +Barcelona ES France Central Direct +Berlin DE West Europe Direct +... +``` + +Gets all peering locations for direct peers + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectPeeringType +The type of direct peering. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Support.PeeringLocationsDirectPeeringType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +The kind of the peering. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Support.PeeringLocationsKind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringLocation + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringReceivedRoute.md b/azps-10.1.0/Az.Peering/Get-AzPeeringReceivedRoute.md new file mode 100644 index 0000000000..3bb96cf413 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringReceivedRoute.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringreceivedroute +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringReceivedRoute.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringReceivedRoute.md +--- + +# Get-AzPeeringReceivedRoute + +## SYNOPSIS +Lists the prefixes received over the specified peering under the given subscription and resource group. + +## SYNTAX + +``` +Get-AzPeeringReceivedRoute -PeeringName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-AsPath <String>] [-OriginAsValidationState <String>] [-Prefix <String>] [-RpkiValidationState <String>] + [-SkipToken <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists the prefixes received over the specified peering under the given subscription and resource group. + +## EXAMPLES + +### Example 1: Get all received routes for a specific peering +```powershell +Get-AzPeeringReceivedRoute -PeeringName DemoPeering -ResourceGroupName DemoRG +``` + +```output +AsPath NextHop OriginAsValidationState Prefix ReceivedTimestamp RpkiValidationState TrustAnchor +------ ------- ----------------------- ------ ----------------- ------------------- ----------- +7018 13335 12.90.152.69 Valid 1.0.0.0/24 2022-12-05T11:51:51.2062620Z Valid None +7018 13335 12.90.152.69 Valid 1.1.1.0/24 2022-12-05T11:51:51.2062620Z Valid None +7018 4837 4808 12.90.152.69 Valid 1.119.192.0/21 2021-12-07T05:21:11.7043790Z Unknown None +7018 4837 4808 12.90.152.69 Valid 1.119.200.0/22 2021-12-07T05:21:11.7043790Z Unknown None +7018 4837 4808 59034 12.90.152.69 Valid 1.119.204.0/24 2021-12-07T05:21:13.7045170Z Unknown None +7018 9680 9680 3462 12.90.152.69 Valid 1.160.0.0/12 2022-11-29T07:46:45.2062680Z Valid None +7018 9680 9680 3462 12.90.152.69 Valid 1.160.0.0/16 2022-11-29T07:46:45.2062680Z Valid None +7018 9680 9680 3462 12.90.152.69 Valid 1.161.0.0/16 2022-11-29T07:46:45.2062680Z Valid None +7018 9680 9680 3462 12.90.152.69 Valid 1.162.0.0/16 2022-11-29T07:46:45.2062680Z Valid None +7018 9680 9680 3462 12.90.152.69 Valid 1.163.0.0/16 2022-11-29T07:46:45.2062680Z Valid None +7018 15169 396982 12.90.152.69 Unknown 1.179.112.0/20 2021-12-07T05:21:16.7056160Z Unknown None +7018 9680 9680 3462 12.90.152.69 Valid 1.164.0.0/16 2022-11-29T07:46:45.2062680Z Valid None +7018 9680 9680 3462 12.90.152.69 Valid 1.165.0.0/16 2022-11-29T07:46:45.2062680Z Valid None +7018 9680 9680 3462 12.90.152.69 Valid 1.166.0.0/16 2022-11-29T07:46:45.2062680Z Valid None +7018 9680 9680 3462 12.90.152.69 Valid 1.167.0.0/16 2022-11-29T07:46:45.2062680Z Valid None +... +``` + +Gets all the received routes for a specific peering + +### Example 2: Filter received routes based on optional parameters +```powershell +Get-AzPeeringReceivedRoute -PeeringName DemoPeering -ResourceGroupName DemoRG -AsPath "7018 9680 9680 3462" +``` + +```output +AsPath NextHop OriginAsValidationState Prefix ReceivedTimestamp RpkiValidationState TrustAnchor +------ ------- ----------------------- ------ ----------------- ------------------- ----------- +7018 9680 9680 3462 12.90.152.69 Valid 1.160.0.0/12 2022-11-29T07:46:45.2062680Z Valid None +7018 9680 9680 3462 12.90.152.69 Valid 1.160.0.0/16 2022-11-29T07:46:45.2062680Z Valid None +7018 9680 9680 3462 12.90.152.69 Valid 1.161.0.0/16 2022-11-29T07:46:45.2062680Z Valid None +7018 9680 9680 3462 12.90.152.69 Valid 1.162.0.0/16 2022-11-29T07:46:45.2062680Z Valid None +7018 9680 9680 3462 12.90.152.69 Valid 1.163.0.0/16 2022-11-29T07:46:45.2062680Z Valid None +7018 9680 9680 3462 12.90.152.69 Valid 1.164.0.0/16 2022-11-29T07:46:45.2062680Z Valid None +... +``` + +Gets all received routes of a peering with a specific AsPath + +## PARAMETERS + +### -AsPath +The optional AS path that can be used to filter the routes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginAsValidationState +The optional origin AS validation state that can be used to filter the routes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringName +The name of the peering. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Prefix +The optional prefix that can be used to filter the routes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RpkiValidationState +The optional RPKI validation state that can be used to filter the routes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +The optional page continuation token that is used in the event of paginated result. + +```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 Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringReceivedRoute + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringRegisteredAsn.md b/azps-10.1.0/Az.Peering/Get-AzPeeringRegisteredAsn.md new file mode 100644 index 0000000000..09f2d808c8 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringRegisteredAsn.md @@ -0,0 +1,193 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringregisteredasn +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringRegisteredAsn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringRegisteredAsn.md +--- + +# Get-AzPeeringRegisteredAsn + +## SYNOPSIS +Gets an existing registered ASN with the specified name under the given subscription, resource group and peering. + +## SYNTAX + +### List (Default) +``` +Get-AzPeeringRegisteredAsn -PeeringName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPeeringRegisteredAsn -Name <String> -PeeringName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPeeringRegisteredAsn -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets an existing registered ASN with the specified name under the given subscription, resource group and peering. + +## EXAMPLES + +### Example 1: List all registered asns for peering +```powershell +Get-AzPeeringRegisteredAsn -PeeringName MapsIxRs -ResourceGroupName MAPSDemo +``` + +```output +Name Asn PeeringServicePrefixKey ProvisioningState +---- --- ----------------------- ----------------- +fgfg 6500 767c9f30-7388-49ef-ba8e-e2d16d1c08e4 Succeeded +homedepottest 65000 32259ee0-ea01-495e-8279-06c24ef7aae0 Succeeded +JonOrmondTest 62540 e3f552c5-909e-434b-8fab-93e524a1aeed Succeeded +``` + +Lists all registered asn's for a peering + +### Example 2: Get specific registered asn for peering +```powershell +Get-AzPeeringRegisteredAsn -PeeringName MapsIxRs -ResourceGroupName MAPSDemo -Name fgfg +``` + +```output +Name Asn PeeringServicePrefixKey ProvisioningState +---- --- ----------------------- ----------------- +fgfg 6500 767c9f30-7388-49ef-ba8e-e2d16d1c08e4 Succeeded +``` + +Gets a specific registered asn for a peering by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the registered ASN. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RegisteredAsnName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringName +The name of the peering. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringRegisteredAsn + +## 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 <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringRegisteredPrefix.md b/azps-10.1.0/Az.Peering/Get-AzPeeringRegisteredPrefix.md new file mode 100644 index 0000000000..77f1b1495e --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringRegisteredPrefix.md @@ -0,0 +1,196 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringregisteredprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringRegisteredPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringRegisteredPrefix.md +--- + +# Get-AzPeeringRegisteredPrefix + +## SYNOPSIS +Gets an existing registered prefix with the specified name under the given subscription, resource group and peering. + +## SYNTAX + +### List (Default) +``` +Get-AzPeeringRegisteredPrefix -PeeringName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPeeringRegisteredPrefix -Name <String> -PeeringName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPeeringRegisteredPrefix -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an existing registered prefix with the specified name under the given subscription, resource group and peering. + +## EXAMPLES + +### Example 1: List all registered prefixes for a peering +```powershell +Get-AzPeeringRegisteredPrefix -PeeringName DemoPeering -ResourceGroupName DemoRG +``` + +```output +Name Prefix PeeringServicePrefixKey PrefixValidationState ProvisioningState +---- ------ ----------------------- --------------------- ----------------- +accessibilityTesting1 240.0.0.0/24 f5947454-80e3-4ce5-bcb3-2501537b6952 Failed Succeeded +accessibilityTesting2 240.0.1.0/24 249aa0dd-6177-4105-94fe-dfefcbf5ab48 Failed Succeeded +accessibilityTesting3 240.0.2.0/24 4fb59e9e-d4eb-4847-b2ad-9939edda750b Failed Succeeded +accessibilityTesting4 240.0.4.0/24 b725f16c-759b-4144-93ed-ed4eb89cb8f7 Failed Succeeded +accessibilityTesting5 240.0.3.0/24 bb1262ca-0b31-45f3-a301-105b0615b21c Failed Succeeded +``` + +List all registered prefixes + +### Example 2: Get specific registered prefix for a peering +```powershell +Get-AzPeeringRegisteredPrefix -PeeringName DemoPeering -ResourceGroupName DemoRG -Name accessibilityTesting1 +``` + +```output +Name Prefix PeeringServicePrefixKey PrefixValidationState ProvisioningState +---- ------ ----------------------- --------------------- ----------------- +accessibilityTesting1 240.0.0.0/24 f5947454-80e3-4ce5-bcb3-2501537b6952 Failed Succeeded +``` + +Get a specific registered prefix by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the registered prefix. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RegisteredPrefixName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringName +The name of the peering. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringRegisteredPrefix + +## 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 <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringRpUnbilledPrefix.md b/azps-10.1.0/Az.Peering/Get-AzPeeringRpUnbilledPrefix.md new file mode 100644 index 0000000000..e0c39f4910 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringRpUnbilledPrefix.md @@ -0,0 +1,133 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringrpunbilledprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringRpUnbilledPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringRpUnbilledPrefix.md +--- + +# Get-AzPeeringRpUnbilledPrefix + +## SYNOPSIS +Lists all of the RP unbilled prefixes for the specified peering + +## SYNTAX + +``` +Get-AzPeeringRpUnbilledPrefix -PeeringName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Consolidate] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all of the RP unbilled prefixes for the specified peering + +## EXAMPLES + +### Example 1: List all unbilled prefixes for a peering +```powershell +Get-AzPeeringRpUnbilledPrefix -PeeringName DemoPeering -ResourceGroupName DemoRG +``` + +```output +Prefix AzureRegion PeerASN +------ ----------- ------- +2.16.0.0/13 West US 2 65010 +23.0.0.0/12 West US 2 65010 +... +``` + +Lists all the unbilled prefixes for a peering + +## PARAMETERS + +### -Consolidate +Flag to enable consolidation prefixes + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringName +The peering name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Azure resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IRpUnbilledPrefix + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringService.md b/azps-10.1.0/Az.Peering/Get-AzPeeringService.md new file mode 100644 index 0000000000..44a6bbfaa9 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringService.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringService.md +--- + +# Get-AzPeeringService + +## SYNOPSIS +Gets an existing peering service with the specified name under the given subscription and resource group. + +## SYNTAX + +### List1 (Default) +``` +Get-AzPeeringService [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPeeringService -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPeeringService -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzPeeringService -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an existing peering service with the specified name under the given subscription and resource group. + +## EXAMPLES + +### Example 1: List all peering services under subscription +```powershell +Get-AzPeeringService +``` + +```output +Name ResourceGroupName PeeringServiceLocation Provider ProvisioningState Location +---- ----------------- ---------------------- -------- ----------------- -------- +TestPrefixForAtlanta DemoRG Georgia MicrosoftEdge Succeeded East US 2 +TestExtension DemoRG Virginia MicrosoftEdge Succeeded East US +TestExtension2 DemoRG Virginia MicrosoftEdge Succeeded East US +DemoPeeringServiceInterCloudLondon DemoRG London InterCloud Succeeded UK South +DRTestInterCloud DemoRG Ile-de-France InterCloud Succeeded UK South +Gaurav Thareja DemoRG Ile-de-France InterCloud Succeeded UK South +TestDRInterCloudZurich DemoRG Zurich InterCloud Succeeded France Central +DRTest DemoRG Ile-de-France InterCloud Succeeded France Central +``` + +Lists all peering services under default subscription + +### Example 2: List all peering services under a specific resource group +```powershell +Get-AzPeeringService -ResourceGroupName DemoRG +``` + +```output +Name ResourceGroupName PeeringServiceLocation Provider ProvisioningState Location +---- ----------------- ---------------------- -------- ----------------- -------- +TestPrefixForAtlanta DemoRG Georgia MicrosoftEdge Succeeded East US 2 +TestExtension DemoRG Virginia MicrosoftEdge Succeeded East US +TestExtension2 DemoRG Virginia MicrosoftEdge Succeeded East US +DemoPeeringServiceInterCloudLondon DemoRG London InterCloud Succeeded UK South +DRTestInterCloud DemoRG Ile-de-France InterCloud Succeeded UK South +Gaurav Thareja DemoRG Ile-de-France InterCloud Succeeded UK South +TestDRInterCloudZurich DemoRG Zurich InterCloud Succeeded France Central +DRTest DemoRG Ile-de-France InterCloud Succeeded France Central +``` + +Lists all the peering services under a resource group + +### Example 3: List all peering services under a specific resource group +```powershell +Get-AzPeeringService -ResourceGroupName DemoRG -Name TestExtension +``` + +```output +Name ResourceGroupName PeeringServiceLocation Provider ProvisioningState Location +---- ----------------- ---------------------- -------- ----------------- -------- +TestExtension DemoRG Virginia MicrosoftEdge Succeeded East US +``` + +Gets a peering service with matching name and resource group + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the peering. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PeeringServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringService + +## 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 <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringServiceCountry.md b/azps-10.1.0/Az.Peering/Get-AzPeeringServiceCountry.md new file mode 100644 index 0000000000..fde208b62d --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringServiceCountry.md @@ -0,0 +1,100 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringservicecountry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringServiceCountry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringServiceCountry.md +--- + +# Get-AzPeeringServiceCountry + +## SYNOPSIS +Lists all of the available countries for peering service. + +## SYNTAX + +``` +Get-AzPeeringServiceCountry [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all of the available countries for peering service. + +## EXAMPLES + +### Example 1: Lists all the peering service countries +```powershell +Get-AzPeeringServiceCountry +``` + +```output +Name +---- +Australia +Belgium +Brazil +Canada +Denmark +Finland +France +Germany +Hong Kong +Japan +Kenya +Korea, South +Malaysia +Netherlands +New Zealand +... +``` + +Lists the countries available for peering service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringServiceLocation.md b/azps-10.1.0/Az.Peering/Get-AzPeeringServiceLocation.md new file mode 100644 index 0000000000..8e7864e98c --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringServiceLocation.md @@ -0,0 +1,147 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringservicelocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringServiceLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringServiceLocation.md +--- + +# Get-AzPeeringServiceLocation + +## SYNOPSIS +Lists all of the available locations for peering service. + +## SYNTAX + +``` +Get-AzPeeringServiceLocation [-SubscriptionId <String[]>] [-Country <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Lists all of the available locations for peering service. + +## EXAMPLES + +### Example 1: List all peering service locations +```powershell +Get-AzPeeringServiceLocation +``` + +```output +Name State Country AzureRegion +---- ----- ------- ----------- +Obwalden Obwalden Switzerland France Central +Sankt Gallen Sankt Gallen Switzerland France Central +Schaffhausen Schaffhausen Switzerland France Central +Schwyz Schwyz Switzerland France Central +Solothurn Solothurn Switzerland France Central +Thurgau Thurgau Switzerland France Central +Ticino Ticino Switzerland France Central +Uri Uri Switzerland France Central +Valais Valais Switzerland France Central +Vaud Vaud Switzerland France Central +Zug Zug Switzerland France Central +Zurich Zurich Switzerland France Central +Aberdeen City Aberdeen City United Kingdom UK West +Angus Angus United Kingdom UK West +Antrim and Newtownabbey Antrim and Newtownabbey United Kingdom North Europe +Ards and North Down Ards and North Down United Kingdom North Europe +Argyll and Bute Argyll and Bute United Kingdom North Europe +Armagh, Banbridge and Craigavon Armagh, Banbridge and Craigavon United Kingdom North Europe +Barking and Dagenham Barking and Dagenham United Kingdom UK South +... +``` + +Retrieves all peering service locations + +### Example 2: List all peering service +```powershell +Get-AzPeeringServiceLocation -Country Japan +``` + +```output +Name State Country AzureRegion +---- ----- ------- ----------- +Aichi Aichi Japan Japan West +Akita Akita Japan Japan East +Aomori Aomori Japan Japan East +Chiba Chiba Japan Japan East +Ehime Ehime Japan Japan West +Fukui Fukui Japan Japan West +Fukuoka Fukuoka Japan Japan West +Fukushima Fukushima Japan Japan East +Gifu Gifu Japan Japan West +Gunma Gunma Japan Japan East +Hiroshima Hiroshima Japan Japan West +Hyogo Hyogo Japan Japan West +Ibaraki Ibaraki Japan Japan East +Ishikawa Ishikawa Japan Japan West +... +``` + +Retrieves all peering service locations for a specific country + +## PARAMETERS + +### -Country +The country of interest, in which the locations are to be present. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringServiceLocation + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringServicePrefix.md b/azps-10.1.0/Az.Peering/Get-AzPeeringServicePrefix.md new file mode 100644 index 0000000000..5de25ea2bc --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringServicePrefix.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringserviceprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringServicePrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringServicePrefix.md +--- + +# Get-AzPeeringServicePrefix + +## SYNOPSIS +Gets an existing prefix with the specified name under the given subscription, resource group and peering service. + +## SYNTAX + +### List (Default) +``` +Get-AzPeeringServicePrefix -PeeringServiceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-Expand <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPeeringServicePrefix -Name <String> -PeeringServiceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-Expand <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPeeringServicePrefix -InputObject <IPeeringIdentity> [-Expand <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an existing prefix with the specified name under the given subscription, resource group and peering service. + +## EXAMPLES + +### Example 1: List all peering service prefixes +```powershell +Get-AzPeeringServicePrefix -PeeringServiceName TestDRInterCloudZurich -ResourceGroupName DemoRG +``` + +```output +Name Prefix Key PrefixValidationState LearnedType ProvisioningState +---- ------ --- --------------------- ----------- ----------------- +TestPrefix 91.194.255.0/24 6a7f0d42-e49c-4eea-a930-280610671c3f Failed None Succeeded +TestPrefix2 240.0.0.0/24 Failed None Succeeded +``` + +Lists all peering service prefixes for the peering service + +### Example 2: Get specific peering service prefix +```powershell +Get-AzPeeringServicePrefix -PeeringServiceName TestDRInterCloudZurich -ResourceGroupName DemoRG -Name TestPrefix +``` + +```output +Name Prefix Key PrefixValidationState LearnedType ProvisioningState +---- ------ --- --------------------- ----------- ----------------- +TestPrefix 91.194.255.0/24 6a7f0d42-e49c-4eea-a930-280610671c3f Failed None Succeeded +``` + +Gets a specific peering service prefix + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +The properties to be expanded. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the prefix. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PrefixName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringServiceName +The name of the peering service. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringServicePrefix + +## 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 <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Get-AzPeeringServiceProvider.md b/azps-10.1.0/Az.Peering/Get-AzPeeringServiceProvider.md new file mode 100644 index 0000000000..8719bf5bf1 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Get-AzPeeringServiceProvider.md @@ -0,0 +1,100 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/get-azpeeringserviceprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringServiceProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Get-AzPeeringServiceProvider.md +--- + +# Get-AzPeeringServiceProvider + +## SYNOPSIS +Lists all of the available peering service locations for the specified kind of peering. + +## SYNTAX + +``` +Get-AzPeeringServiceProvider [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all of the available peering service locations for the specified kind of peering. + +## EXAMPLES + +### Example 1: List all peering service providers +```powershell +Get-AzPeeringServiceProvider +``` + +```output +Name PeeringLocation ServiceProviderName +---- --------------- ------------------- +IIJ {Osaka, Tokyo} IIJ +NTTCom {Osaka, Tokyo} NTTCom +Kordia Limited {Auckland, Sydney} Kordia Limited +Liquid Telecommunications Ltd {Cape Town, Johannesburg, Nairobi} Liquid Telecommunications Ltd +InterCloud {london, Paris, Zurich, Geneva} InterCloud +Computer Concepts Limited {Auckland} Computer Concepts Limited +Singnet {singapore} Singnet +NTT Communications - Flexible InterConnect {Osaka, Tokyo} NTT Communications - Flexible InterConnect +NAPAfrica {Johannesburg, Cape Town} NAPAfrica +Vocusgroup NZ {Sydney, Auckland} Vocusgroup NZ +CMC NETWORKS {Johannesburg, Nairobi, cape Town} CMC NETWORKS +MainOne {Lisbon, Lagos} MainOne +Swisscom Switzerland Ltd {Geneva, Zurich} Swisscom Switzerland Ltd +DE-CIX {Frankfurt, Marseille, Newark, Madrid…} DE-CIX +Lumen Technologies {denver, los Angeles} Lumen Technologies +Colt Technology Services {Amsterdam, Barcelona, Berlin, Frankfurt…} Colt Technology Services +``` + +Lists all peering service providers + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringServiceProvider + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Initialize-AzPeeringServiceConnectionMonitor.md b/azps-10.1.0/Az.Peering/Initialize-AzPeeringServiceConnectionMonitor.md new file mode 100644 index 0000000000..154ccdd738 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Initialize-AzPeeringServiceConnectionMonitor.md @@ -0,0 +1,168 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/initialize-azpeeringserviceconnectionmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Initialize-AzPeeringServiceConnectionMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Initialize-AzPeeringServiceConnectionMonitor.md +--- + +# Initialize-AzPeeringServiceConnectionMonitor + +## SYNOPSIS +Initialize Peering Service for Connection Monitor functionality + +## SYNTAX + +### Initialize (Default) +``` +Initialize-AzPeeringServiceConnectionMonitor [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### InitializeViaIdentity +``` +Initialize-AzPeeringServiceConnectionMonitor -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Initialize Peering Service for Connection Monitor functionality + +## EXAMPLES + +### Example 1: Initialize connection monitor functionality +```powershell +Initialize-AzPeeringServiceConnectionMonitor +``` + +Initialize connection monitor functionality + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: InitializeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Initialize +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/New-AzPeering.md b/azps-10.1.0/Az.Peering/New-AzPeering.md new file mode 100644 index 0000000000..cb88e7b401 --- /dev/null +++ b/azps-10.1.0/Az.Peering/New-AzPeering.md @@ -0,0 +1,339 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/new-azpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeering.md +--- + +# New-AzPeering + +## SYNOPSIS +Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group. + +## SYNTAX + +``` +New-AzPeering -Name <String> -ResourceGroupName <String> -Kind <Kind> -Location <String> + [-SubscriptionId <String>] [-DirectConnection <IDirectConnection[]>] [-DirectPeerAsnId <String>] + [-DirectPeeringType <DirectPeeringType>] [-ExchangeConnection <IExchangeConnection[]>] + [-ExchangePeerAsnId <String>] [-PeeringLocation <String>] [-Sku <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group. + +## EXAMPLES + +### Example 1: Create a new direct peering object +```powershell +$peerAsnId = "/subscriptions/{subId}/providers/Microsoft.Peering/peerAsns/ContosoEdgeTest" +$directConnections = New-AzPeeringDirectConnectionObject -BandwidthInMbps 10000 -BgpSessionMaxPrefixesAdvertisedV4 20000 + +New-AzPeering -Name TestPeeringPs -ResourceGroupName DemoRG -Kind Direct -Location "South Central US" -DirectConnection $directConnections -DirectPeeringType Cdn -DirectPeerAsnId $peerAsnId -PeeringLocation Dallas -Sku Premium_Direct_Unlimited +``` + +```output +Name SkuName Kind PeeringLocation ProvisioningState Location +---- ------- ---- --------------- ----------------- -------- +TestPeering Premium_Direct_Unlimited Direct Dallas Succeeded South Central US +``` + +Create a new direct peering object + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectConnection +The set of connections that constitute a direct peering. +To construct, see NOTES section for DIRECTCONNECTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IDirectConnection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectPeerAsnId +The identifier of the referenced resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectPeeringType +The type of direct peering. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Support.DirectPeeringType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeConnection +The set of connections that constitute an exchange peering. +To construct, see NOTES section for EXCHANGECONNECTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IExchangeConnection[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangePeerAsnId +The identifier of the referenced resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +The kind of the peering. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the peering. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PeeringName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringLocation +The location of the peering. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the peering SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SkuName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeering + +## 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. + + +`DIRECTCONNECTION <IDirectConnection[]>`: The set of connections that constitute a direct peering. + - `[BandwidthInMbps <Int32?>]`: The bandwidth of the connection. + - `[BgpSessionMaxPrefixesAdvertisedV4 <Int32?>]`: The maximum number of prefixes advertised over the IPv4 session. + - `[BgpSessionMaxPrefixesAdvertisedV6 <Int32?>]`: The maximum number of prefixes advertised over the IPv6 session. + - `[BgpSessionMd5AuthenticationKey <String>]`: The MD5 authentication key of the session. + - `[BgpSessionMicrosoftSessionIPv4Address <String>]`: The IPv4 session address on Microsoft's end. + - `[BgpSessionMicrosoftSessionIPv6Address <String>]`: The IPv6 session address on Microsoft's end. + - `[BgpSessionPeerSessionIPv4Address <String>]`: The IPv4 session address on peer's end. + - `[BgpSessionPeerSessionIPv6Address <String>]`: The IPv6 session address on peer's end. + - `[BgpSessionPrefixV4 <String>]`: The IPv4 prefix that contains both ends' IPv4 addresses. + - `[BgpSessionPrefixV6 <String>]`: The IPv6 prefix that contains both ends' IPv6 addresses. + - `[ConnectionIdentifier <String>]`: The unique identifier (GUID) for the connection. + - `[PeeringDbFacilityId <Int32?>]`: The PeeringDB.com ID of the facility at which the connection has to be set up. + - `[SessionAddressProvider <SessionAddressProvider?>]`: The field indicating if Microsoft provides session ip addresses. + - `[UseForPeeringService <Boolean?>]`: The flag that indicates whether or not the connection is used for peering service. + +`EXCHANGECONNECTION <IExchangeConnection[]>`: The set of connections that constitute an exchange peering. + - `[BgpSessionMaxPrefixesAdvertisedV4 <Int32?>]`: The maximum number of prefixes advertised over the IPv4 session. + - `[BgpSessionMaxPrefixesAdvertisedV6 <Int32?>]`: The maximum number of prefixes advertised over the IPv6 session. + - `[BgpSessionMd5AuthenticationKey <String>]`: The MD5 authentication key of the session. + - `[BgpSessionMicrosoftSessionIPv4Address <String>]`: The IPv4 session address on Microsoft's end. + - `[BgpSessionMicrosoftSessionIPv6Address <String>]`: The IPv6 session address on Microsoft's end. + - `[BgpSessionPeerSessionIPv4Address <String>]`: The IPv4 session address on peer's end. + - `[BgpSessionPeerSessionIPv6Address <String>]`: The IPv6 session address on peer's end. + - `[BgpSessionPrefixV4 <String>]`: The IPv4 prefix that contains both ends' IPv4 addresses. + - `[BgpSessionPrefixV6 <String>]`: The IPv6 prefix that contains both ends' IPv6 addresses. + - `[ConnectionIdentifier <String>]`: The unique identifier (GUID) for the connection. + - `[PeeringDbFacilityId <Int32?>]`: The PeeringDB.com ID of the facility at which the connection has to be set up. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/New-AzPeeringAsn.md b/azps-10.1.0/Az.Peering/New-AzPeeringAsn.md new file mode 100644 index 0000000000..9e094809e7 --- /dev/null +++ b/azps-10.1.0/Az.Peering/New-AzPeeringAsn.md @@ -0,0 +1,191 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/new-azpeeringasn +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringAsn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringAsn.md +--- + +# New-AzPeeringAsn + +## SYNOPSIS +Creates a new peer ASN or updates an existing peer ASN with the specified name under the given subscription. + +## SYNTAX + +``` +New-AzPeeringAsn -Name <String> [-SubscriptionId <String>] [-PeerAsn <Int32>] + [-PeerContactDetail <IContactDetail[]>] [-PeerName <String>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new peer ASN or updates an existing peer ASN with the specified name under the given subscription. + +## EXAMPLES + +### Example 1: Create a new peering asn +```powershell +$contactDetail = New-AzPeeringContactDetailObject -Email "abc@xyz.com" -Phone 1234567890 -Role "Noc" +$PeerContactList = ,$contactDetail +New-AzPeeringAsn -Name PsTestAsn -PeerAsn 65001 -PeerContactDetail $PeerContactList -PeerName DemoPeering +``` + +```output +Name PeerName PropertiesPeerAsn ValidationState PeerContactDetail +---- -------- ----------------- --------------- ----------------- +PsTestAsn DemoPeering 65001 Pending {{… +``` + +Create a new peering asn with the specified properties + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The peer ASN name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PeerAsnName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerAsn +The Autonomous System Number (ASN) of the peer. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerContactDetail +The contact details of the peer. +To construct, see NOTES section for PEERCONTACTDETAIL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IContactDetail[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerName +The name of the peer. + +```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 Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeerAsn + +## 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. + + +`PEERCONTACTDETAIL <IContactDetail[]>`: The contact details of the peer. + - `[Email <String>]`: The e-mail address of the contact. + - `[Phone <String>]`: The phone number of the contact. + - `[Role <Role?>]`: The role of the contact. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/New-AzPeeringCheckServiceProviderAvailabilityInputObject.md b/azps-10.1.0/Az.Peering/New-AzPeeringCheckServiceProviderAvailabilityInputObject.md new file mode 100644 index 0000000000..ee5943cf78 --- /dev/null +++ b/azps-10.1.0/Az.Peering/New-AzPeeringCheckServiceProviderAvailabilityInputObject.md @@ -0,0 +1,86 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.Peering/new-AzPeeringCheckServiceProviderAvailabilityInputObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringCheckServiceProviderAvailabilityInputObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringCheckServiceProviderAvailabilityInputObject.md +--- + +# New-AzPeeringCheckServiceProviderAvailabilityInputObject + +## SYNOPSIS +Create an in-memory object for CheckServiceProviderAvailabilityInput. + +## SYNTAX + +``` +New-AzPeeringCheckServiceProviderAvailabilityInputObject [-PeeringServiceLocation <String>] + [-PeeringServiceProvider <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for CheckServiceProviderAvailabilityInput. + +## EXAMPLES + +### Example 1: Create a check service provider availability object +```powershell +New-AzPeeringCheckServiceProviderAvailabilityInputObject -PeeringServiceLocation Osaka -PeeringServiceProvider IIJ +``` + +```output +PeeringServiceLocation PeeringServiceProvider +---------------------- ---------------------- +Osaka IIJ +``` + +Creates a CheckServiceProviderAvailabilityInputObject with the specified location and provider and stores it in memory + +## PARAMETERS + +### -PeeringServiceLocation +Gets or sets the peering service location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringServiceProvider +Gets or sets the peering service provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.CheckServiceProviderAvailabilityInput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/New-AzPeeringConnectionMonitorTest.md b/azps-10.1.0/Az.Peering/New-AzPeeringConnectionMonitorTest.md new file mode 100644 index 0000000000..91d6b856b1 --- /dev/null +++ b/azps-10.1.0/Az.Peering/New-AzPeeringConnectionMonitorTest.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/new-azpeeringconnectionmonitortest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringConnectionMonitorTest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringConnectionMonitorTest.md +--- + +# New-AzPeeringConnectionMonitorTest + +## SYNOPSIS +Creates or updates a connection monitor test with the specified name under the given subscription, resource group and peering service. + +## SYNTAX + +``` +New-AzPeeringConnectionMonitorTest -Name <String> -PeeringServiceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Destination <String>] [-DestinationPort <Int32>] [-SourceAgent <String>] + [-TestFrequencyInSec <Int32>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a connection monitor test with the specified name under the given subscription, resource group and peering service. + +## EXAMPLES + +### Example 1: Create a new connection monitor test +```powershell +New-AzPeeringConnectionMonitorTest -Name TestName -PeeringServiceName DRTest -ResourceGroupName DemoRG +``` + +```output +SourceAgent Destination DestinationPort TestFrequency Sucessful ProvisioningState +----------- ----------- --------------- ------------- --------- ----------------- +Agent 1 1.1.1.1 80 30 True Succeeded +``` + +Creates a connection monitor test for the peering service + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +The Connection Monitor test destination + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPort +The Connection Monitor test destination port + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the connection monitor test + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConnectionMonitorTestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringServiceName +The name of the peering service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceAgent +The Connection Monitor test source agent + +```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 Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestFrequencyInSec +The Connection Monitor test frequency in seconds + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IConnectionMonitorTest + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/New-AzPeeringContactDetailObject.md b/azps-10.1.0/Az.Peering/New-AzPeeringContactDetailObject.md new file mode 100644 index 0000000000..1229b4341f --- /dev/null +++ b/azps-10.1.0/Az.Peering/New-AzPeeringContactDetailObject.md @@ -0,0 +1,100 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.Peering/new-AzPeeringContactDetailObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringContactDetailObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringContactDetailObject.md +--- + +# New-AzPeeringContactDetailObject + +## SYNOPSIS +Create an in-memory object for ContactDetail. + +## SYNTAX + +``` +New-AzPeeringContactDetailObject [-Email <String>] [-Phone <String>] [-Role <Role>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ContactDetail. + +## EXAMPLES + +### Example 1: Create a Contact Detail object +```powershell +New-AzPeeringContactDetailObject -Email "abc@xyz.com" -Phone 1234567890 -Role "Noc" +``` + +```output +Email Phone Role +----- ----- ---- +abc@xyz.com 1234567890 Noc +``` + +Creates a ContactDetail object with the specified email phone and role stores it in memory + +## PARAMETERS + +### -Email +The e-mail address of the contact. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Phone +The phone number of the contact. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The role of the contact. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Support.Role +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.ContactDetail + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/New-AzPeeringDirectConnectionObject.md b/azps-10.1.0/Az.Peering/New-AzPeeringDirectConnectionObject.md new file mode 100644 index 0000000000..7dfef0201a --- /dev/null +++ b/azps-10.1.0/Az.Peering/New-AzPeeringDirectConnectionObject.md @@ -0,0 +1,274 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.Peering/new-AzPeeringDirectConnectionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringDirectConnectionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringDirectConnectionObject.md +--- + +# New-AzPeeringDirectConnectionObject + +## SYNOPSIS +Create an in-memory object for DirectConnection. + +## SYNTAX + +``` +New-AzPeeringDirectConnectionObject [-BandwidthInMbps <Int32>] [-BgpSessionMaxPrefixesAdvertisedV4 <Int32>] + [-BgpSessionMaxPrefixesAdvertisedV6 <Int32>] [-BgpSessionMd5AuthenticationKey <String>] + [-BgpSessionMicrosoftSessionIPv4Address <String>] [-BgpSessionMicrosoftSessionIPv6Address <String>] + [-BgpSessionPeerSessionIPv4Address <String>] [-BgpSessionPeerSessionIPv6Address <String>] + [-BgpSessionPrefixV4 <String>] [-BgpSessionPrefixV6 <String>] [-ConnectionIdentifier <String>] + [-PeeringDbFacilityId <Int32>] [-SessionAddressProvider <SessionAddressProvider>] + [-UseForPeeringService <Boolean>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for DirectConnection. + +## EXAMPLES + +### Example 1: Create a direct connection object +```powershell +$md5Key = "******" + +New-AzPeeringDirectConnectionObject -BandwidthInMbps 10000 -BgpSessionMaxPrefixesAdvertisedV4 20000 -BgpSessionMaxPrefixesAdvertisedV6 0 -BgpSessionMd5AuthenticationKey $md5Key -BgpSessionMicrosoftSessionIPv4Address 1.1.1.1 -BgpSessionPeerSessionIPv4Address 1.1.1.0 -BgpSessionPrefixV4 1.1.1.1/31 -PeeringDbFacilityId 82 -SessionAddressProvider Peer -ConnectionIdentifier c111111111111 +``` + +```output +BandwidthInMbps ConnectionIdentifier ConnectionState ErrorMessage MicrosoftTrackingId PeeringDbFacilityId ProvisionedBandwidthInMbps +--------------- -------------------- --------------- ------------ ------------------- ------------------- -------------------------- +10000 c111111111111 PendingApproval 82 + +``` + +Creates an in-memory direct connection object + +## PARAMETERS + +### -BandwidthInMbps +The bandwidth of the connection. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionMaxPrefixesAdvertisedV4 +The maximum number of prefixes advertised over the IPv4 session. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionMaxPrefixesAdvertisedV6 +The maximum number of prefixes advertised over the IPv6 session. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionMd5AuthenticationKey +The MD5 authentication key of the session. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionMicrosoftSessionIPv4Address +The IPv4 session address on Microsoft's end. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionMicrosoftSessionIPv6Address +The IPv6 session address on Microsoft's end. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionPeerSessionIPv4Address +The IPv4 session address on peer's end. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionPeerSessionIPv6Address +The IPv6 session address on peer's end. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionPrefixV4 +The IPv4 prefix that contains both ends' IPv4 addresses. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionPrefixV6 +The IPv6 prefix that contains both ends' IPv6 addresses. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionIdentifier +The unique identifier (GUID) for the connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringDbFacilityId +The PeeringDB.com ID of the facility at which the connection has to be set up. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionAddressProvider +The field indicating if Microsoft provides session ip addresses. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Support.SessionAddressProvider +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseForPeeringService +The flag that indicates whether or not the connection is used for peering service. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.DirectConnection + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/New-AzPeeringExchangeConnectionObject.md b/azps-10.1.0/Az.Peering/New-AzPeeringExchangeConnectionObject.md new file mode 100644 index 0000000000..9d7122b1e0 --- /dev/null +++ b/azps-10.1.0/Az.Peering/New-AzPeeringExchangeConnectionObject.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.Peering/new-AzPeeringExchangeConnectionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringExchangeConnectionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringExchangeConnectionObject.md +--- + +# New-AzPeeringExchangeConnectionObject + +## SYNOPSIS +Create an in-memory object for ExchangeConnection. + +## SYNTAX + +``` +New-AzPeeringExchangeConnectionObject [-BgpSessionMaxPrefixesAdvertisedV4 <Int32>] + [-BgpSessionMaxPrefixesAdvertisedV6 <Int32>] [-BgpSessionMd5AuthenticationKey <String>] + [-BgpSessionMicrosoftSessionIPv4Address <String>] [-BgpSessionMicrosoftSessionIPv6Address <String>] + [-BgpSessionPeerSessionIPv4Address <String>] [-BgpSessionPeerSessionIPv6Address <String>] + [-BgpSessionPrefixV4 <String>] [-BgpSessionPrefixV6 <String>] [-ConnectionIdentifier <String>] + [-PeeringDbFacilityId <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ExchangeConnection. + +## EXAMPLES + +### Example 1: Create an exchange connection object +```powershell +$md5Key = "******" + +New-AzPeeringExchangeConnectionObject -BgpSessionMaxPrefixesAdvertisedV4 20000 -BgpSessionMaxPrefixesAdvertisedV6 0 -BgpSessionMd5AuthenticationKey $md5Key -BgpSessionMicrosoftSessionIPv4Address 1.1.1.1 -BgpSessionPeerSessionIPv4Address 1.1.1.0 -BgpSessionPrefixV4 1.1.1.1/31 -PeeringDbFacilityId 82 -ConnectionIdentifier c111111111111 +``` + +```output +ConnectionIdentifier ConnectionState ErrorMessage PeeringDbFacilityId +-------------------- --------------- ------------ ------------------- +c111111111111 82 +``` + +Create a exchange connection object in memory + +## PARAMETERS + +### -BgpSessionMaxPrefixesAdvertisedV4 +The maximum number of prefixes advertised over the IPv4 session. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionMaxPrefixesAdvertisedV6 +The maximum number of prefixes advertised over the IPv6 session. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionMd5AuthenticationKey +The MD5 authentication key of the session. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionMicrosoftSessionIPv4Address +The IPv4 session address on Microsoft's end. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionMicrosoftSessionIPv6Address +The IPv6 session address on Microsoft's end. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionPeerSessionIPv4Address +The IPv4 session address on peer's end. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionPeerSessionIPv6Address +The IPv6 session address on peer's end. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionPrefixV4 +The IPv4 prefix that contains both ends' IPv4 addresses. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BgpSessionPrefixV6 +The IPv6 prefix that contains both ends' IPv6 addresses. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionIdentifier +The unique identifier (GUID) for the connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringDbFacilityId +The PeeringDB.com ID of the facility at which the connection has to be set up. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.ExchangeConnection + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/New-AzPeeringRegisteredAsn.md b/azps-10.1.0/Az.Peering/New-AzPeeringRegisteredAsn.md new file mode 100644 index 0000000000..f24841c01b --- /dev/null +++ b/azps-10.1.0/Az.Peering/New-AzPeeringRegisteredAsn.md @@ -0,0 +1,178 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/new-azpeeringregisteredasn +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringRegisteredAsn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringRegisteredAsn.md +--- + +# New-AzPeeringRegisteredAsn + +## SYNOPSIS +Creates a new registered ASN with the specified name under the given subscription, resource group and peering. + +## SYNTAX + +``` +New-AzPeeringRegisteredAsn -Name <String> -PeeringName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Asn <Int32>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new registered ASN with the specified name under the given subscription, resource group and peering. + +## EXAMPLES + +### Example 1: Create registered asn +```powershell +New-AzPeeringRegisteredAsn -Name TestAsn -PeeringName MapsIxRs -ResourceGroupName MAPSDemo -Asn 65001 +``` + +```output +Name Asn PeeringServicePrefixKey ProvisioningState +---- --- ----------------------- ----------------- +TestAsn 65001 45a8db73-4b7c-4800-bb0f-d304a747d6f1 Succeeded +``` + +Create a new registered asn for a peering + +## PARAMETERS + +### -Asn +The customer's ASN from which traffic originates. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ASN. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RegisteredAsnName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringName +The name of the peering. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringRegisteredAsn + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/New-AzPeeringRegisteredPrefix.md b/azps-10.1.0/Az.Peering/New-AzPeeringRegisteredPrefix.md new file mode 100644 index 0000000000..1342305f7b --- /dev/null +++ b/azps-10.1.0/Az.Peering/New-AzPeeringRegisteredPrefix.md @@ -0,0 +1,178 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/new-azpeeringregisteredprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringRegisteredPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringRegisteredPrefix.md +--- + +# New-AzPeeringRegisteredPrefix + +## SYNOPSIS +Creates a new registered prefix with the specified name under the given subscription, resource group and peering. + +## SYNTAX + +``` +New-AzPeeringRegisteredPrefix -Name <String> -PeeringName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Prefix <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new registered prefix with the specified name under the given subscription, resource group and peering. + +## EXAMPLES + +### Example 1: Create a new registered prefix +```powershell +New-AzPeeringRegisteredPrefix -Name accessibilityTesting6 -PeeringName DemoPeering -ResourceGroupName DemoRG -Prefix 240.0.5.0/24 +``` + +```output +Name Prefix PeeringServicePrefixKey PrefixValidationState ProvisioningState +---- ------ ----------------------- --------------------- ----------------- +accessibilityTesting6 240.0.5.0/24 f5947454-80e3-4ce5-bcb3-2501537b6952 Pending Updating +``` + +Create a new registered prefix object + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the registered prefix. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RegisteredPrefixName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringName +The name of the peering. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Prefix +The customer's prefix from which traffic originates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringRegisteredPrefix + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/New-AzPeeringService.md b/azps-10.1.0/Az.Peering/New-AzPeeringService.md new file mode 100644 index 0000000000..771d26f5cb --- /dev/null +++ b/azps-10.1.0/Az.Peering/New-AzPeeringService.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/new-azpeeringservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringService.md +--- + +# New-AzPeeringService + +## SYNOPSIS +Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group. + +## SYNTAX + +``` +New-AzPeeringService -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-PeeringServiceLocation <String>] [-PeeringServiceProvider <String>] + [-ProviderBackupPeeringLocation <String>] [-ProviderPrimaryPeeringLocation <String>] [-Sku <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group. + +## EXAMPLES + +### Example 1: Create a new peering service +```powershell +New-AzPeeringService -Name TestPeeringService -ResourceGroupName DemoRG -Location "East US 2" -PeeringServiceLocation Georgia -PeeringServiceProvider MicrosoftEdge -ProviderPrimaryPeeringLocation Atlanta +``` + +```output +Name ResourceGroupName PeeringServiceLocation Provider ProvisioningState Location +---- ----------------- ---------------------- -------- ----------------- -------- +TestPeeringService DemoRG Georgia MicrosoftEdge ProvisioningStarted East US 2 +``` + +Create a new peering service in the resource group + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the peering service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PeeringServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringServiceLocation +The location (state/province) of the customer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringServiceProvider +The name of the service provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderBackupPeeringLocation +The backup peering (Microsoft/service provider) location to be used for customer traffic. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderPrimaryPeeringLocation +The primary peering (Microsoft/service provider) location to be used for customer traffic. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the peering service SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SkuName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringService + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/New-AzPeeringServicePrefix.md b/azps-10.1.0/Az.Peering/New-AzPeeringServicePrefix.md new file mode 100644 index 0000000000..0261c04b67 --- /dev/null +++ b/azps-10.1.0/Az.Peering/New-AzPeeringServicePrefix.md @@ -0,0 +1,193 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/new-azpeeringserviceprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringServicePrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/New-AzPeeringServicePrefix.md +--- + +# New-AzPeeringServicePrefix + +## SYNOPSIS +Creates a new prefix with the specified name under the given subscription, resource group and peering service. + +## SYNTAX + +``` +New-AzPeeringServicePrefix -Name <String> -PeeringServiceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-PeeringServicePrefixKey <String>] [-Prefix <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new prefix with the specified name under the given subscription, resource group and peering service. + +## EXAMPLES + +### Example 1: Create Peering service prefix +```powershell +New-AzPeeringServicePrefix -Name TestPrefix -PeeringServiceName TestDRInterCloudZurich -ResourceGroupName DemoRG -PeeringServicePrefixKey 6a7f0d42-e49c-4eea-a930-280610671c3f -Prefix 91.194.255.0/24 +``` + +```output +Name Prefix Key PrefixValidationState LearnedType ProvisioningState +---- ------ --- --------------------- ----------- ----------------- +TestPrefix 91.194.255.0/24 6a7f0d42-e49c-4eea-a930-280610671c3f Failed None Succeeded +``` + +Create a peering service prefix + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the prefix. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PrefixName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringServiceName +The name of the peering service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringServicePrefixKey +The peering service prefix key + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Prefix +The prefix from which your traffic originates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringServicePrefix + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Remove-AzPeering.md b/azps-10.1.0/Az.Peering/Remove-AzPeering.md new file mode 100644 index 0000000000..0d6a7c7740 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Remove-AzPeering.md @@ -0,0 +1,198 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/remove-azpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeering.md +--- + +# Remove-AzPeering + +## SYNOPSIS +Deletes an existing peering with the specified name under the given subscription and resource group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPeering -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPeering -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing peering with the specified name under the given subscription and resource group. + +## EXAMPLES + +### Example 1: Remove peering +```powershell +Remove-AzPeering -Name TestPeering -ResourceGroupName DemoRG +``` + +Remove a peering from the given resource group + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the peering. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: PeeringName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Remove-AzPeeringAsn.md b/azps-10.1.0/Az.Peering/Remove-AzPeeringAsn.md new file mode 100644 index 0000000000..9328da0a3a --- /dev/null +++ b/azps-10.1.0/Az.Peering/Remove-AzPeeringAsn.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/remove-azpeeringasn +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeeringAsn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeeringAsn.md +--- + +# Remove-AzPeeringAsn + +## SYNOPSIS +Deletes an existing peer ASN with the specified name under the given subscription. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPeeringAsn -Name <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPeeringAsn -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing peer ASN with the specified name under the given subscription. + +## EXAMPLES + +### Example 1: Remove peer asn +```powershell +Remove-AzPeeringAsn -Name PsTestAsn +``` + +Removes peer asn with the name specified + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The peer ASN name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: PeerAsnName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Remove-AzPeeringConnectionMonitorTest.md b/azps-10.1.0/Az.Peering/Remove-AzPeeringConnectionMonitorTest.md new file mode 100644 index 0000000000..517d930ed7 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Remove-AzPeeringConnectionMonitorTest.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/remove-azpeeringconnectionmonitortest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeeringConnectionMonitorTest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeeringConnectionMonitorTest.md +--- + +# Remove-AzPeeringConnectionMonitorTest + +## SYNOPSIS +Deletes an existing connection monitor test with the specified name under the given subscription, resource group and peering service. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPeeringConnectionMonitorTest -Name <String> -PeeringServiceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPeeringConnectionMonitorTest -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing connection monitor test with the specified name under the given subscription, resource group and peering service. + +## EXAMPLES + +### Example 1: Remove connection monitor test +```powershell +Remove-AzPeeringConnectionMonitorTest -Name TestName -PeeringServiceName TestDRInterCloudZurich -ResourceGroupName DemoRG +``` + +Removes the given connection monitor test from the peering service + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the connection monitor test + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ConnectionMonitorTestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringServiceName +The name of the peering service. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Remove-AzPeeringRegisteredAsn.md b/azps-10.1.0/Az.Peering/Remove-AzPeeringRegisteredAsn.md new file mode 100644 index 0000000000..0e8549a96d --- /dev/null +++ b/azps-10.1.0/Az.Peering/Remove-AzPeeringRegisteredAsn.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/remove-azpeeringregisteredasn +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeeringRegisteredAsn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeeringRegisteredAsn.md +--- + +# Remove-AzPeeringRegisteredAsn + +## SYNOPSIS +Deletes an existing registered ASN with the specified name under the given subscription, resource group and peering. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPeeringRegisteredAsn -Name <String> -PeeringName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPeeringRegisteredAsn -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing registered ASN with the specified name under the given subscription, resource group and peering. + +## EXAMPLES + +### Example 1: Remove a registered asn from the peering +```powershell +Remove-AzPeeringRegisteredAsn -Name TestAsn -PeeringName MapsIxRs -ResourceGroupName MAPSDemo +``` + +Remove a registered asn from the peering object + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the registered ASN. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: RegisteredAsnName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringName +The name of the peering. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Remove-AzPeeringRegisteredPrefix.md b/azps-10.1.0/Az.Peering/Remove-AzPeeringRegisteredPrefix.md new file mode 100644 index 0000000000..4ba4a17394 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Remove-AzPeeringRegisteredPrefix.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/remove-azpeeringregisteredprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeeringRegisteredPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeeringRegisteredPrefix.md +--- + +# Remove-AzPeeringRegisteredPrefix + +## SYNOPSIS +Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPeeringRegisteredPrefix -Name <String> -PeeringName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPeeringRegisteredPrefix -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering. + +## EXAMPLES + +### Example 1: Remove registered prefix +```powershell +Remove-AzPeeringRegisteredPrefix -Name accessibilityTesting6 -PeeringName DemoPeering -ResourceGroupName DemoRG +``` + +Removes the specified registered prefix from peering + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the registered prefix. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: RegisteredPrefixName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringName +The name of the peering. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Remove-AzPeeringService.md b/azps-10.1.0/Az.Peering/Remove-AzPeeringService.md new file mode 100644 index 0000000000..02190805bf --- /dev/null +++ b/azps-10.1.0/Az.Peering/Remove-AzPeeringService.md @@ -0,0 +1,198 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/remove-azpeeringservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeeringService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeeringService.md +--- + +# Remove-AzPeeringService + +## SYNOPSIS +Deletes an existing peering service with the specified name under the given subscription and resource group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPeeringService -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPeeringService -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing peering service with the specified name under the given subscription and resource group. + +## EXAMPLES + +### Example 1: Remove peering service +```powershell +Remove-AzPeeringService -Name TestPeeringService -ResourceGroupName DemoRG +``` + +Removes a peering service from the given resource group + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the peering service. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: PeeringServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Remove-AzPeeringServicePrefix.md b/azps-10.1.0/Az.Peering/Remove-AzPeeringServicePrefix.md new file mode 100644 index 0000000000..7ffda80143 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Remove-AzPeeringServicePrefix.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/remove-azpeeringserviceprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeeringServicePrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Remove-AzPeeringServicePrefix.md +--- + +# Remove-AzPeeringServicePrefix + +## SYNOPSIS +Deletes an existing prefix with the specified name under the given subscription, resource group and peering service. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPeeringServicePrefix -Name <String> -PeeringServiceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPeeringServicePrefix -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing prefix with the specified name under the given subscription, resource group and peering service. + +## EXAMPLES + +### Example 1: Remove peering service prefix +```powershell +Remove-AzPeeringServicePrefix -Name TestPrefix -PeeringServiceName TestDRInterCloudZurich -ResourceGroupName DemoRG +``` + +Removes peering service prefix from peering + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the prefix. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: PrefixName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringServiceName +The name of the peering service. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Start-AzPeeringInvokeLookingGlass.md b/azps-10.1.0/Az.Peering/Start-AzPeeringInvokeLookingGlass.md new file mode 100644 index 0000000000..3a9f767e9c --- /dev/null +++ b/azps-10.1.0/Az.Peering/Start-AzPeeringInvokeLookingGlass.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/start-azpeeringinvokelookingglass +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Start-AzPeeringInvokeLookingGlass.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Start-AzPeeringInvokeLookingGlass.md +--- + +# Start-AzPeeringInvokeLookingGlass + +## SYNOPSIS +Run looking glass functionality + +## SYNTAX + +### Invoke (Default) +``` +Start-AzPeeringInvokeLookingGlass -Command <LookingGlassCommand> -DestinationIP <String> + -SourceLocation <String> -SourceType <LookingGlassSourceType> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### InvokeViaIdentity +``` +Start-AzPeeringInvokeLookingGlass -InputObject <IPeeringIdentity> -Command <LookingGlassCommand> + -DestinationIP <String> -SourceLocation <String> -SourceType <LookingGlassSourceType> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Run looking glass functionality + +## EXAMPLES + +### Example 1: Invoke looking glass command +```powershell +Start-AzPeeringInvokeLookingGlass -Command Ping -DestinationIp 1.1.1.1 -SourceLocation Seattle -SourceType EdgeSite +``` + +```output +Command Output +------- ------ +Ping PING 1.1.1.1 (1.1.1.1): 56 data bytes… +``` + +Invoke the given looking glass command + +## PARAMETERS + +### -Command +The command to be executed: ping, traceroute, bgpRoute. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Support.LookingGlassCommand +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationIP +The IP address of the destination. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: InvokeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SourceLocation +The location of the source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceType +The type of the source: Edge site or Azure Region. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Support.LookingGlassSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Invoke +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.ILookingGlassOutput + +## 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 <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Test-AzPeeringRegisteredPrefix.md b/azps-10.1.0/Az.Peering/Test-AzPeeringRegisteredPrefix.md new file mode 100644 index 0000000000..4f57603680 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Test-AzPeeringRegisteredPrefix.md @@ -0,0 +1,204 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/test-azpeeringregisteredprefix +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Test-AzPeeringRegisteredPrefix.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Test-AzPeeringRegisteredPrefix.md +--- + +# Test-AzPeeringRegisteredPrefix + +## SYNOPSIS +Validates an existing registered prefix with the specified name under the given subscription, resource group and peering. + +## SYNTAX + +### Validate (Default) +``` +Test-AzPeeringRegisteredPrefix -Name <String> -PeeringName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ValidateViaIdentity +``` +Test-AzPeeringRegisteredPrefix -InputObject <IPeeringIdentity> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Validates an existing registered prefix with the specified name under the given subscription, resource group and peering. + +## EXAMPLES + +### Example 1: Test registered prefix +```powershell +Test-AzPeeringRegisteredPrefix -Name accessibilityTesting2 -PeeringName DemoPeering -ResourceGroupName DemoRG +``` + +```output +Name Prefix PeeringServicePrefixKey PrefixValidationState ProvisioningState +---- ------ ----------------------- --------------------- ----------------- +accessibilityTesting2 240.0.1.0/24 249aa0dd-6177-4105-94fe-dfefcbf5ab48 Pending Succeeded +``` + +Tests the validity of the given registered prefix (shown in prefix validation state) + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: ValidateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the registered prefix. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: RegisteredPrefixName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringName +The name of the peering. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringRegisteredPrefix + +## 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 <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Test-AzPeeringServiceProviderAvailability.md b/azps-10.1.0/Az.Peering/Test-AzPeeringServiceProviderAvailability.md new file mode 100644 index 0000000000..d6ee6cde96 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Test-AzPeeringServiceProviderAvailability.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/test-azpeeringserviceprovideravailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Test-AzPeeringServiceProviderAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Test-AzPeeringServiceProviderAvailability.md +--- + +# Test-AzPeeringServiceProviderAvailability + +## SYNOPSIS +Checks if the peering service provider is present within 1000 miles of customer's location + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzPeeringServiceProviderAvailability [-SubscriptionId <String>] [-PeeringServiceLocation <String>] + [-PeeringServiceProvider <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Check +``` +Test-AzPeeringServiceProviderAvailability + -CheckServiceProviderAvailabilityInput <ICheckServiceProviderAvailabilityInput> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CheckViaIdentity +``` +Test-AzPeeringServiceProviderAvailability -InputObject <IPeeringIdentity> + -CheckServiceProviderAvailabilityInput <ICheckServiceProviderAvailabilityInput> [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzPeeringServiceProviderAvailability -InputObject <IPeeringIdentity> [-PeeringServiceLocation <String>] + [-PeeringServiceProvider <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Checks if the peering service provider is present within 1000 miles of customer's location + +## EXAMPLES + +### Example 1: Check if provider is available at a location +```powershell +$providerAvailability = New-AzPeeringCheckServiceProviderAvailabilityInputObject -PeeringServiceLocation Osaka -PeeringServiceProvider IIJ +Test-AzPeeringServiceProviderAvailability -CheckServiceProviderAvailabilityInput $providerAvailability +``` + +```output +"Available" +``` + +Check whether the given provider is available at the given location + +## PARAMETERS + +### -CheckServiceProviderAvailabilityInput +Class for CheckServiceProviderAvailabilityInput +To construct, see NOTES section for CHECKSERVICEPROVIDERAVAILABILITYINPUT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.ICheckServiceProviderAvailabilityInput +Parameter Sets: Check, CheckViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: CheckViaIdentity, CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PeeringServiceLocation +Gets or sets the peering service location. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeeringServiceProvider +Gets or sets the peering service provider. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: Check, CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.ICheckServiceProviderAvailabilityInput + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`CHECKSERVICEPROVIDERAVAILABILITYINPUT <ICheckServiceProviderAvailabilityInput>`: Class for CheckServiceProviderAvailabilityInput + - `[PeeringServiceLocation <String>]`: Gets or sets the peering service location. + - `[PeeringServiceProvider <String>]`: Gets or sets the peering service provider. + +`INPUTOBJECT <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Update-AzPeering.md b/azps-10.1.0/Az.Peering/Update-AzPeering.md new file mode 100644 index 0000000000..da1f5bb999 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Update-AzPeering.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/update-azpeering +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Update-AzPeering.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Update-AzPeering.md +--- + +# Update-AzPeering + +## SYNOPSIS +Updates tags for a peering with the specified name under the given subscription and resource group. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPeering -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPeering -InputObject <IPeeringIdentity> [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates tags for a peering with the specified name under the given subscription and resource group. + +## EXAMPLES + +### Example 1: Update peering tags +```powershell +$tags=@{hello='world'} +Update-AzPeering -Name DemoPeering -ResourceGroupName DemoRG -Tag $tags +``` + +```output +Name SkuName Kind PeeringLocation ProvisioningState Location +---- ------- ---- --------------- ----------------- -------- +DemoPeering Premium_Direct_Free Direct Dallas Succeeded South Central US +``` + +Updates the specified peering's tags + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the peering. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: PeeringName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets the tags, a dictionary of descriptors arm object + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeering + +## 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 <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Peering/Update-AzPeeringService.md b/azps-10.1.0/Az.Peering/Update-AzPeeringService.md new file mode 100644 index 0000000000..91771dfaa2 --- /dev/null +++ b/azps-10.1.0/Az.Peering/Update-AzPeeringService.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.Peering +online version: https://learn.microsoft.com/powershell/module/az.peering/update-azpeeringservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Update-AzPeeringService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Peering/help/Update-AzPeeringService.md +--- + +# Update-AzPeeringService + +## SYNOPSIS +Updates tags for a peering service with the specified name under the given subscription and resource group. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPeeringService -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPeeringService -InputObject <IPeeringIdentity> [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates tags for a peering service with the specified name under the given subscription and resource group. + +## EXAMPLES + +### Example 1: Update peering service tags +```powershell +$tags=@{hello='world'} +Update-AzPeeringService -Name DRTestInterCloud -ResourceGroupName DemoRG -Tag $tags +``` + +```output +Name ResourceGroupName PeeringServiceLocation Provider ProvisioningState Location +---- ----------------- ---------------------- -------- ----------------- -------- +DRTestInterCloud DemoRG Ile-de-France InterCloud Succeeded UK South +``` + +Updates the peering service tags + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the peering service. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: PeeringServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets the tags, a dictionary of descriptors arm object + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.IPeeringIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.Api20221001.IPeeringService + +## 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 <IPeeringIdentity>`: Identity Parameter + - `[ConnectionMonitorTestName <String>]`: The name of the connection monitor test + - `[Id <String>]`: Resource identity path + - `[PeerAsnName <String>]`: The peer ASN name. + - `[PeeringName <String>]`: The name of the peering. + - `[PeeringServiceName <String>]`: The name of the peering service. + - `[PrefixName <String>]`: The name of the prefix. + - `[RegisteredAsnName <String>]`: The name of the registered ASN. + - `[RegisteredPrefixName <String>]`: The name of the registered prefix. + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PolicyInsights/Az.PolicyInsights.md b/azps-10.1.0/Az.PolicyInsights/Az.PolicyInsights.md new file mode 100644 index 0000000000..4bbc129bc5 --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/Az.PolicyInsights.md @@ -0,0 +1,54 @@ +--- +Module Name: Az.PolicyInsights +Module Guid: B1876B47-3652-4265-9AD5-782EC3E98319 +Download Help Link: https://learn.microsoft.com/powershell/module/az.policyinsights +Help Version: 1.1.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Az.PolicyInsights.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Az.PolicyInsights.md +--- + +# Az.PolicyInsights Module +## Description +This topic displays help for the Azure Policy Insights cmdlets. + +## Az.PolicyInsights Cmdlets +### [Get-AzPolicyAttestation](Get-AzPolicyAttestation.md) +Gets policy attestations. + +### [Get-AzPolicyEvent](Get-AzPolicyEvent.md) +Gets policy evaluation events generated as resources are created or updated. + +### [Get-AzPolicyMetadata](Get-AzPolicyMetadata.md) +Gets Policy Metadata resources + +### [Get-AzPolicyRemediation](Get-AzPolicyRemediation.md) +Gets policy remediations. + +### [Get-AzPolicyState](Get-AzPolicyState.md) +Gets policy compliance states for resources. + +### [Get-AzPolicyStateSummary](Get-AzPolicyStateSummary.md) +Gets latest policy compliance states summary for resources. + +### [New-AzPolicyAttestation](New-AzPolicyAttestation.md) +Creates a new policy attestation for a policy assignment. + +### [Remove-AzPolicyAttestation](Remove-AzPolicyAttestation.md) +Deletes a policy attestation. + +### [Remove-AzPolicyRemediation](Remove-AzPolicyRemediation.md) +Deletes a policy remediation. + +### [Set-AzPolicyAttestation](Set-AzPolicyAttestation.md) +Modifies a policy attestation. + +### [Start-AzPolicyComplianceScan](Start-AzPolicyComplianceScan.md) +Triggers a policy compliance evaluation for all resources in a subscription or resource group. + +### [Start-AzPolicyRemediation](Start-AzPolicyRemediation.md) +Creates and starts a policy remediation for a policy assignment. + +### [Stop-AzPolicyRemediation](Stop-AzPolicyRemediation.md) +Cancels an in-progress policy remediation. + diff --git a/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyAttestation.md b/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyAttestation.md new file mode 100644 index 0000000000..6fce96ce6f --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyAttestation.md @@ -0,0 +1,342 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.dll-Help.xml +Module Name: Az.PolicyInsights +online version: https://learn.microsoft.com/powershell/module/az.policyinsights/get-azpolicyattestation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Get-AzPolicyAttestation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Get-AzPolicyAttestation.md +--- + +# Get-AzPolicyAttestation + +## SYNOPSIS +Gets policy attestations. + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzPolicyAttestation [-Top <Int32>] [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByName +``` +Get-AzPolicyAttestation -Name <String> [-Scope <String>] [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GenericScope +``` +Get-AzPolicyAttestation -Scope <String> [-Top <Int32>] [-Filter <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupScope +``` +Get-AzPolicyAttestation -ResourceGroupName <String> [-Top <Int32>] [-Filter <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzPolicyAttestation -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPolicyAttestation** cmdlet gets all policy attestations in a scope or a particular attestation. + +## EXAMPLES + +### Example 1: Get all policy attestations in the current subscription +```powershell +Set-AzContext -Subscription "d1acb22b-c876-44f7-b08e-3fcf9f6767f4" +Get-AzPolicyAttestation +``` + +```output +Id : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.policyinsights/attestations/ + attestation-subscription +Name : attestation-subscription +Type : Microsoft.PolicyInsights/attestations +PolicyAssignmentId : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignme + nts/psattestationsubassignment +PolicyDefinitionReferenceId : +ComplianceState : NonCompliant +ExpiresOn : +Owner : +Comment : Setting the state to non compliant +Evidence : +ProvisioningState : Succeeded +LastComplianceStateChangeAt : 1/27/2023 4:00:04 PM +AssessmentDate : +Metadata : +SystemData : + +Id : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/resourcegroups/ps-attestation-test-rg/providers/ + microsoft.policyinsights/attestations/attestation-rg +Name : attestation-rg +Type : Microsoft.PolicyInsights/attestations +PolicyAssignmentId : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignme + nts/psattestationrgassignment +PolicyDefinitionReferenceId : +ComplianceState : +ExpiresOn : 1/27/2024 4:04:24 PM +Owner : +Comment : +Evidence : +ProvisioningState : Succeeded +LastComplianceStateChangeAt : 1/27/2023 4:04:11 PM +AssessmentDate : +Metadata : +SystemData : + +Id : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/resourcegroups/ps-attestation-test-rg/providers/ + microsoft.network/networksecuritygroups/pstests0/providers/microsoft.policyinsights/attestations/att + estation-resource +Name : attestation-resource +Type : Microsoft.PolicyInsights/attestations +PolicyAssignmentId : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignme + nts/psattestationresourceassignment +PolicyDefinitionReferenceId : +ComplianceState : NonCompliant +ExpiresOn : +Owner : Test Owner 2 +Comment : +Evidence : +ProvisioningState : Succeeded +LastComplianceStateChangeAt : 1/27/2023 2:38:17 AM +AssessmentDate : +Metadata : +SystemData : + +Id : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/resourcegroups/ps-attestation-test-rg/providers/ + microsoft.policyinsights/attestations/attestationrgallprops +Name : attestationRGAllProps +Type : Microsoft.PolicyInsights/attestations +PolicyAssignmentId : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignme + nts/psattestationinitiativergassignment +PolicyDefinitionReferenceId : pstestattestationrg_1 +ComplianceState : +ExpiresOn : 1/27/2024 2:51:54 AM +Owner : Test Owner +Comment : +Evidence : {Microsoft.Azure.Commands.PolicyInsights.Models.Attestations.PSAttestationEvidence} +ProvisioningState : Succeeded +LastComplianceStateChangeAt : 1/27/2023 2:51:57 AM +AssessmentDate : 1/25/2024 2:51:54 AM +Metadata : { + "TestKey": "TestValue" + } +SystemData : +``` + +This command gets all the attestations created at or underneath a subscription with id d1acb22b-c876-44f7-b08e-3fcf9f6767f4. + +### Example 2: Get a specific policy attestation +```powershell +Get-AzPolicyAttestation -ResourceGroupName "ps-attestation-test-rg" -Name "attestation-RG" +``` + +```output +Id : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/resourcegroups/ps-attestation-test-rg/providers/ + microsoft.policyinsights/attestations/attestation-rg +Name : attestation-rg +Type : Microsoft.PolicyInsights/attestations +PolicyAssignmentId : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignme + nts/psattestationrgassignment +PolicyDefinitionReferenceId : +ComplianceState : +ExpiresOn : 1/27/2024 4:04:24 PM +Owner : +Comment : +Evidence : +ProvisioningState : Succeeded +LastComplianceStateChangeAt : 1/27/2023 4:04:11 PM +AssessmentDate : +Metadata : +SystemData : +``` + +This command gets the attestation named 'attestation-RG' at the resource group 'ps-attestation-test-rg'. + +### Example 3: Get 5 policy attestations in a subscription with optional filters +```powershell +Set-AzContext -Subscription "d1acb22b-c876-44f7-b08e-3fcf9f6767f4" +Get-AzPolicyAttestation -Top 5 -Filter "PolicyAssignmentId eq '/subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignments/psattestationresourceassignment'" +``` + +```output +Id : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/resourcegroups/ps-attestation-test-rg/providers/ + microsoft.network/networksecuritygroups/pstests0/providers/microsoft.policyinsights/attestations/att + estation-resource +Name : attestation-resource +Type : Microsoft.PolicyInsights/attestations +PolicyAssignmentId : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignme + nts/psattestationresourceassignment +PolicyDefinitionReferenceId : +ComplianceState : NonCompliant +ExpiresOn : +Owner : Test Owner 2 +Comment : +Evidence : +ProvisioningState : Succeeded +LastComplianceStateChangeAt : 1/27/2023 2:38:17 AM +AssessmentDate : +Metadata : +SystemData : +``` + +This command gets a max of 5 policy attestations underneath the subscription with id d1acb22b-c876-44f7-b08e-3fcf9f6767f4. Only policy attestations for the given policy assignment will be retrieved. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter expression using OData notation. + +```yaml +Type: System.String +Parameter Sets: SubscriptionScope, GenericScope, ResourceGroupScope +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ResourceGroupScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Scope of the resource. +E.g. +'/subscriptions/{subscriptionId}/resourceGroups/{rgName}'. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GenericScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +Maximum number of records to return. +If not provided, the maximum number of records returned is determined by the Azure Policy service (currently 1000). + +```yaml +Type: System.Int32 +Parameter Sets: SubscriptionScope, GenericScope, ResourceGroupScope +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.PolicyInsights.Models.Attestations.PSAttestation + +## NOTES + +## RELATED LINKS +[New-AzPolicyAttestation](./New-AzPolicyAttestation.md) + +[Remove-AzPolicyAttestation](./Remove-AzPolicyAttestation.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyEvent.md b/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyEvent.md new file mode 100644 index 0000000000..9d529c5be1 --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyEvent.md @@ -0,0 +1,478 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.dll-Help.xml +Module Name: Az.PolicyInsights +online version: https://learn.microsoft.com/powershell/module/az.policyinsights/get-azpolicyevent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Get-AzPolicyEvent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Get-AzPolicyEvent.md +--- + +# Get-AzPolicyEvent + +## SYNOPSIS +Gets policy evaluation events generated as resources are created or updated. + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzPolicyEvent [-SubscriptionId <String>] [-Top <Int32>] [-OrderBy <String>] [-Select <String>] + [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ManagementGroupScope +``` +Get-AzPolicyEvent -ManagementGroupName <String> [-Top <Int32>] [-OrderBy <String>] [-Select <String>] + [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupScope +``` +Get-AzPolicyEvent [-SubscriptionId <String>] -ResourceGroupName <String> [-Top <Int32>] [-OrderBy <String>] + [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicySetDefinitionScope +``` +Get-AzPolicyEvent [-SubscriptionId <String>] -PolicySetDefinitionName <String> [-Top <Int32>] + [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] + [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicyDefinitionScope +``` +Get-AzPolicyEvent [-SubscriptionId <String>] -PolicyDefinitionName <String> [-Top <Int32>] [-OrderBy <String>] + [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelPolicyAssignmentScope +``` +Get-AzPolicyEvent [-SubscriptionId <String>] -PolicyAssignmentName <String> [-Top <Int32>] [-OrderBy <String>] + [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupLevelPolicyAssignmentScope +``` +Get-AzPolicyEvent [-SubscriptionId <String>] -ResourceGroupName <String> -PolicyAssignmentName <String> + [-Top <Int32>] [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] + [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceScope +``` +Get-AzPolicyEvent -ResourceId <String> [-Top <Int32>] [-OrderBy <String>] [-Select <String>] [-From <DateTime>] + [-To <DateTime>] [-Filter <String>] [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets policy evaluation events generated as resources are created or updated. Policy event records can be queried at various scopes based on the time interval specified (defaults to last day). Results can be filtered, grouped, and group aggregations can be computed. + +## EXAMPLES + +### Example 1: Get policy events in current subscription scope +```powershell +Get-AzPolicyEvent +``` + +Gets policy event records generated in the last day for all resources within the subscription in current session context. + +### Example 2: Get policy events in the specified subscription scope +```powershell +Get-AzPolicyEvent -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" +``` + +Gets policy event records generated in the last day for all resources within the specified subscription. + +### Example 3: Get policy events in management group scope +```powershell +Get-AzPolicyEvent -ManagementGroupName "myManagementGroup" +``` + +Gets policy event records generated in the last day for all resources within the specified management group. + +### Example 4: Get policy events in resource group scope in current subscription +```powershell +Get-AzPolicyEvent -ResourceGroupName "myResourceGroup" +``` + +Gets policy event records generated in the last day for all resources within the specified resource group (in the subscription in current session context). + +### Example 5: Get policy events in resource group scope in the specified subscription +```powershell +Get-AzPolicyEvent -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -ResourceGroupName "myResourceGroup" +``` + +Gets policy event records generated in the last day for all resources within the specified resource group (in the specified subscription). + +### Example 6: Get policy events for a resource +```powershell +Get-AzPolicyEvent -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myns1/eventhubs/eh1/consumergroups/cg1" +``` + +Gets policy event records generated in the last day for the specified resource. + +### Example 7: Get policy events for a policy set definition in current subscription +```powershell +Get-AzPolicyEvent -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" +``` + +Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy set definition (that exists in the subscription in current session context). + +### Example 8: Get policy events for a policy set definition in the specified subscription +```powershell +Get-AzPolicyEvent -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" +``` + +Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy set definition (that exists in the specified subscription). + +### Example 9: Get policy events for a policy definition in current subscription +```powershell +Get-AzPolicyEvent -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" +``` + +Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy definition (that exists in the subscription in current session context). + +### Example 10: Get policy events for a policy definition in the specified subscription +```powershell +Get-AzPolicyEvent -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" +``` + +Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy definition (that exists in the specified subscription). + +### Example 11: Get policy events for a policy assignment in current subscription +```powershell +Get-AzPolicyEvent -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" +``` + +Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the subscription in current session context). + +### Example 12: Get policy events for a policy assignment in the specified subscription +```powershell +Get-AzPolicyEvent -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" +``` + +Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the specified subscription). + +### Example 13: Get policy events for a policy assignment in the specified resource group in the current subscription +```powershell +Get-AzPolicyEvent -ResourceGroupName "myResourceGroup" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" +``` + +Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the resource group in the subscription in current session context). + +### Example 14: Get policy events in current subscription scope, with OrderBy, Top and Select query options +```powershell +Get-AzPolicyEvent -OrderBy "Timestamp desc, PolicyAssignmentName asc" -Top 5 -Select "Timestamp, ResourceId, PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionId" +``` + +Gets policy event records generated in the last day for all resources within the subscription in current session context. +The command orders the results by timestamp and policy assignment name properties, and takes only top 5 of those listed in that order. +It also selects to list only a subset of the columns for each record. + +### Example 15: Get policy events in current subscription scope, with From and To query options +```powershell +Get-AzPolicyEvent -From "2018-03-08 00:00:00Z" -To "2018-03-15 00:00:00Z" +``` + +Gets policy event records generated within the date range specified for all resources within the subscription in current session context. + +### Example 16: Get policy events in current subscription scope, with Filter query option +```powershell +Get-AzPolicyEvent -Filter "(PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit') and ResourceLocation ne 'eastus'" +``` + +Gets policy event records generated in the last day for all resources within the subscription in current session context. +The command limits the results returned by filtering based on policy definition action (includes deny or audit actions) and resource location (excludes eastus location). + +### Example 17: Get policy events in current subscription scope, with Apply specifying row count aggregation +```powershell +Get-AzPolicyEvent -Apply "aggregate(`$count as NumberOfRecords)" +``` + +Gets the number of policy event records generated in the last day for all resources within the subscription in current session context. +The command returns the count of the policy event records only, which is returned inside AdditionalProperties property. + +### Example 18: Get policy events in current subscription scope, with Apply specifying grouping with aggregation +```powershell +Get-AzPolicyEvent -Filter "PolicyDefinitionAction eq 'audit' or PolicyDefinitionAction eq 'deny'" -Apply "groupby((PolicyAssignmentId, PolicyDefinitionId, PolicyDefinitionAction, ResourceId), aggregate(`$count as NumEvents))" -OrderBy "NumEvents desc" -Top 5 +``` + +Gets policy event records generated in the last day for all resources within the subscription in current session context. +The command limits the results returned by filtering based on policy definition action (includes only audit and deny events). +It groups the results based on policy assignment, policy definition, policy definition action, and resource id, and computes the number of records in each group, which is returned inside AdditionalProperties property. +It orders the results by the count aggregation in descending order, and takes only top 5 of those listed in that order. + +### Example 19: Get policy events in current subscription scope, with Apply specifying grouping without aggregation +```powershell +Get-AzPolicyEvent -Filter "PolicyDefinitionAction eq 'audit' or PolicyDefinitionAction eq 'deny'" -Apply "groupby((ResourceId))" +``` + +Gets policy event records generated in the last day for all resources within the subscription in current session context. +The command limits the results returned by filtering based on policy definition action (includes only audit and deny events). +It groups the results based on resource id. +This generates the list of all resources within the subscription that generated a policy event for at least one audit or deny policy. + +### Example 20: Get policy events in current subscription scope, with Apply specifying multiple groupings +```powershell +Get-AzPolicyEvent -Filter "PolicyDefinitionAction eq 'deny'" -Apply "groupby((PolicyAssignmentId, PolicyDefinitionId, ResourceId))/groupby((PolicyAssignmentId, PolicyDefinitionId), aggregate(`$count as NumDeniedResources))" -OrderBy "NumDeniedResources desc" -Top 5 +``` + +Gets policy event records generated in the last day for all resources within the subscription in current session context. +The command limits the results returned by filtering based on policy definition action (includes only deny events). +It groups the results first based on policy assignment, policy definition, and resource id. +Then, it further groups the results of this grouping with the same properties except for resource id, and computes the number of records in each of these groups, which is returned inside AdditionalProperties property. +It orders the results by the count aggregation in descending order, and takes only top 5 of those listed in that order. +This generates the top 5 deny policies with the most number of denied resources. + +## PARAMETERS + +### -Apply +Apply expression for aggregations using OData notation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter expression using OData notation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +ISO 8601 formatted timestamp specifying the start time of the interval to query. +When not specified, defaults to 'To' parameter value minus 1 day. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupName +Management group name. + +```yaml +Type: System.String +Parameter Sets: ManagementGroupScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OrderBy +Ordering expression using OData notation. +One or more comma-separated column names with an optional 'desc' (the default) or 'asc'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyAssignmentName +Policy assignment name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelPolicyAssignmentScope, ResourceGroupLevelPolicyAssignmentScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinitionName +Policy definition name. + +```yaml +Type: System.String +Parameter Sets: PolicyDefinitionScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicySetDefinitionName +Policy set definition name. + +```yaml +Type: System.String +Parameter Sets: PolicySetDefinitionScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupScope, ResourceGroupLevelPolicyAssignmentScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Select +Select expression using OData notation. +One or more comma-separated column names. +Limits the columns on each record to just those requested. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID. + +```yaml +Type: System.String +Parameter Sets: SubscriptionScope, ResourceGroupScope, PolicySetDefinitionScope, PolicyDefinitionScope, SubscriptionLevelPolicyAssignmentScope, ResourceGroupLevelPolicyAssignmentScope +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -To +ISO 8601 formatted timestamp specifying the end time of the interval to query. +When not specified, defaults to time of request. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Maximum number of records to return. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.PolicyInsights.Models.PolicyEvent + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyMetadata.md b/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyMetadata.md new file mode 100644 index 0000000000..9a5d19e4ee --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyMetadata.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.dll-Help.xml +Module Name: Az.PolicyInsights +online version: https://learn.microsoft.com/powershell/module/az.policyinsights/get-azpolicymetadata +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Get-AzPolicyMetadata.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Get-AzPolicyMetadata.md +--- + +# Get-AzPolicyMetadata + +## SYNOPSIS +Gets Policy Metadata resources + +## SYNTAX + +``` +Get-AzPolicyMetadata [-Name <String>] [-Top <Int32>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPolicyRemediation** cmdlet gets all policy metadata resources or a particular policy metadata resource. + +## EXAMPLES + +### Example 1: Get all policy metadata resources +```powershell +Get-AzPolicyMetadata +``` + +This command gets all policy metadata resources + +### Example 2: Get a collection of 10 policy metadata resources +```powershell +Get-AzPolicyMetadata -Top 10 +``` + +This command gets a collection of 10 policy metadata resources + +### Example 3: Get a single policy metadata resource with the name 'ACF1348' +```powershell +Get-AzPolicyMetadata -Name ACF1348 +``` + +This command gets a single policy metadata resource with the name 'ACF1348' + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +Maximum number of policy metadata resources to return. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.PolicyInsights.Models.PSPolicyMetadata + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyRemediation.md b/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyRemediation.md new file mode 100644 index 0000000000..42de39fa30 --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyRemediation.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.dll-Help.xml +Module Name: Az.PolicyInsights +online version: https://learn.microsoft.com/powershell/module/az.policyinsights/get-azpolicyremediation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Get-AzPolicyRemediation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Get-AzPolicyRemediation.md +--- + +# Get-AzPolicyRemediation + +## SYNOPSIS +Gets policy remediations. + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzPolicyRemediation [-Top <Int32>] [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByName +``` +Get-AzPolicyRemediation -Name <String> [-Scope <String>] [-ManagementGroupName <String>] + [-ResourceGroupName <String>] [-Top <Int32>] [-IncludeDetail] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GenericScope +``` +Get-AzPolicyRemediation -Scope <String> [-Top <Int32>] [-Filter <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ManagementGroupScope +``` +Get-AzPolicyRemediation -ManagementGroupName <String> [-Top <Int32>] [-Filter <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupScope +``` +Get-AzPolicyRemediation -ResourceGroupName <String> [-Top <Int32>] [-Filter <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzPolicyRemediation -ResourceId <String> [-Top <Int32>] [-IncludeDetail] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPolicyRemediation** cmdlet gets all policy remediations in a scope or a particular remediation. + +## EXAMPLES + +### Example 1: Get all policy remediations in the current subscription +```powershell +Set-AzContext -Subscription "My Subscription" +Get-AzPolicyRemediation +``` + +This command gets all the remediations created at or underneath a subscription named 'My Subscription'. + +### Example 2: Get a specific policy remediation and the deployment details +```powershell +Get-AzPolicyRemediation -ResourceGroupName "myResourceGroup" -Name "remediation1" -IncludeDetail +``` + +This command gets the remediation named 'remediation1' from resource group 'myResourceGroup'. The details of the resources being remediated will be included. + +### Example 3: Get 10 policy remediations in a management group with optional filters +```powershell +Get-AzPolicyRemediation -ManagementGroupName "mg1" -Top 10 -Filter "PolicyAssignmentId eq '/providers/Microsoft.Management/managementGroups/mg1/providers/Microsoft.Authorization/policyAssignments/pa1'" +``` + +This command gets a max of 10 policy remediations from a management group named 'mg1'. Only policy remediations for the given policy assignment will be retrieved. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter expression using OData notation. + +```yaml +Type: System.String +Parameter Sets: SubscriptionScope, GenericScope, ManagementGroupScope, ResourceGroupScope +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDetail +Include details of the deployments created by the remediation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByName, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupName +Management group ID. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ManagementGroupScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ResourceGroupScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Scope of the resource. For example, '/subscriptions/{subscriptionId}/resourceGroups/{rgName}'. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GenericScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +Maximum number of records to return. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyState.md b/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyState.md new file mode 100644 index 0000000000..c4a80481dd --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyState.md @@ -0,0 +1,556 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.dll-Help.xml +Module Name: Az.PolicyInsights +online version: https://learn.microsoft.com/powershell/module/az.policyinsights/get-azpolicystate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Get-AzPolicyState.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Get-AzPolicyState.md +--- + +# Get-AzPolicyState + +## SYNOPSIS +Gets policy compliance states for resources. + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzPolicyState [-All] [-SubscriptionId <String>] [-Top <Int32>] [-OrderBy <String>] [-Select <String>] + [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ManagementGroupScope +``` +Get-AzPolicyState [-All] -ManagementGroupName <String> [-Top <Int32>] [-OrderBy <String>] [-Select <String>] + [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupScope +``` +Get-AzPolicyState [-All] [-SubscriptionId <String>] -ResourceGroupName <String> [-Top <Int32>] + [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] + [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceScope +``` +Get-AzPolicyState [-All] -ResourceId <String> [-Top <Int32>] [-OrderBy <String>] [-Select <String>] + [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] [-Expand <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicySetDefinitionScope +``` +Get-AzPolicyState [-All] [-SubscriptionId <String>] -PolicySetDefinitionName <String> [-Top <Int32>] + [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] + [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicyDefinitionScope +``` +Get-AzPolicyState [-All] [-SubscriptionId <String>] -PolicyDefinitionName <String> [-Top <Int32>] + [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] + [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelPolicyAssignmentScope +``` +Get-AzPolicyState [-All] [-SubscriptionId <String>] -PolicyAssignmentName <String> [-Top <Int32>] + [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] + [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupLevelPolicyAssignmentScope +``` +Get-AzPolicyState [-All] [-SubscriptionId <String>] -ResourceGroupName <String> -PolicyAssignmentName <String> + [-Top <Int32>] [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] + [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets policy compliance states for resources. Policy state records can be queried at various scopes. Based on the time interval specified (defaults to last day), either latest policy states or all policy state transitions can be queried. Results can be filtered, grouped, and group aggregations can be computed. + +## EXAMPLES + +### Example 1: Get latest policy states in current subscription scope +```powershell +Get-AzPolicyState +``` + +Gets latest policy state records generated in the last day for all resources within the subscription in current session context. + +### Example 2: Get latest policy states in the specified subscription scope +```powershell +Get-AzPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" +``` + +Gets latest policy state records generated in the last day for all resources within the specified subscription. + +### Example 3: Get all policy states in current subscription scope +```powershell +Get-AzPolicyState -All +``` + +Gets all historical policy state records (including latest) generated in the last day for all resources within the subscription in current session context. + +### Example 4: Get latest policy states in management group scope +```powershell +Get-AzPolicyState -ManagementGroupName "myManagementGroup" +``` + +Gets latest policy state records generated in the last day for all resources within the specified management group. + +### Example 5: Get latest policy states in resource group scope in current subscription +```powershell +Get-AzPolicyState -ResourceGroupName "myResourceGroup" +``` + +Gets latest policy state records generated in the last day for all resources within the specified resource group (in the subscription in current session context). + +### Example 6: Get latest policy states in resource group scope in the specified subscription +```powershell +Get-AzPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -ResourceGroupName "myResourceGroup" +``` + +Gets latest policy state records generated in the last day for all resources within the specified resource group (in the specified subscription). + +### Example 7: Get latest policy states for a resource +```powershell +Get-AzPolicyState -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myns1/eventhubs/eh1/consumergroups/cg1" +``` + +Gets latest policy state records generated in the last day for the specified resource. + +### Example 8: Get latest policy states for a policy set definition in current subscription +```powershell +Get-AzPolicyState -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" +``` + +Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy set definition (that exists in the subscription in current session context). + +### Example 9: Get latest policy states for a policy set definition in the specified subscription +```powershell +Get-AzPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" +``` + +Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy set definition (that exists in the specified subscription). + +### Example 10: Get latest policy states for a policy definition in current subscription +```powershell +Get-AzPolicyState -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" +``` + +Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy definition (that exists in the subscription in current session context). + +### Example 11: Get latest policy states for a policy definition in the specified subscription +```powershell +Get-AzPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" +``` + +Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy definition (that exists in the specified subscription). + +### Example 12: Get latest policy states for a policy assignment in current subscription +```powershell +Get-AzPolicyState -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" +``` + +Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists at subscription scope in the subscription in current session context). + +### Example 13: Get latest policy states for a policy assignment with the same scope as the specified subscription +```powershell +Get-AzPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" +``` + +Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists at subscription scope in the specified subscription). + +### Example 14: Get latest policy states for a policy assignment in the specified resource group in the current subscription +```powershell +Get-AzPolicyState -ResourceGroupName "myResourceGroup" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" +``` + +Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the resource group in the subscription in current session context). + +### Example 15: Get latest policy states in current subscription scope, with OrderBy, Top and Select query options +```powershell +Get-AzPolicyState -OrderBy "Timestamp desc, PolicyAssignmentName asc" -Top 5 -Select "Timestamp, ResourceId, PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionId, IsCompliant" +``` + +Gets latest policy state records generated in the last day for all resources within the subscription in current session context. +The command orders the results by timestamp and policy assignment name properties, and takes only top 5 of those listed in that order. +It also selects to list only a subset of the columns for each record. + +### Example 16: Get latest policy states in current subscription scope, with From and To query options +```powershell +Get-AzPolicyState -From "2018-03-08 00:00:00Z" -To "2018-03-15 00:00:00Z" +``` + +Gets latest policy state records generated within the date range specified for all resources within the subscription in current session context. + +### Example 17: Get latest policy states in current subscription scope, with Filter query option +```powershell +Get-AzPolicyState -Filter "(PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit') and ComplianceState eq 'NonCompliant' and ResourceLocation ne 'eastus'" +``` + +Gets latest policy state records generated in the last day for all resources within the subscription in current session context. +The command limits the results returned by filtering based on policy definition action (includes deny or audit actions), compliance status (includes only non-compliant status) and resource location (excludes eastus location). + +### Example 18: Get latest policy states in current subscription scope, with Apply specifying row count aggregation +```powershell +Get-AzPolicyState -Apply "aggregate(`$count as NumberOfRecords)" +``` + +Gets the number of latest policy state records generated in the last day for all resources within the subscription in current session context. +The command returns the count of the policy state records only, which is returned inside AdditionalProperties property. + +### Example 19: Get latest policy states in current subscription scope, with Apply specifying grouping with aggregation +```powershell +Get-AzPolicyState -Filter "ComplianceState eq 'NonCompliant'" -Apply "groupby((PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionReferenceId, PolicyDefinitionId), aggregate(`$count as NumStates))" -OrderBy "NumStates desc" -Top 5 +``` + +Gets latest policy state records generated in the last day for all resources within the subscription in current session context. +The command limits the results returned by filtering based on compliance status (includes only non-compliant status). +It groups the results based on policy assignment, policy set definition, and policy definition, and computes the number of records in each group, which is returned inside AdditionalProperties property. +It orders the results by the count aggregation in descending order, and takes only top 5 of those listed in that order. + +### Example 20: Get latest policy states in current subscription scope, with Apply specifying grouping without aggregation +```powershell +Get-AzPolicyState -Filter "ComplianceState eq 'NonCompliant'" -Apply "groupby((ResourceId))" +``` + +Gets latest policy state records generated in the last day for all resources within the subscription in current session context. +The command limits the results returned by filtering based on compliance status (includes only non-compliant status). +It groups the results based on resource id. +This generates the list of all resources within the subscription that are non-compliant for at least one policy. + +### Example 21: Get latest policy states in current subscription scope, with Apply specifying multiple groupings +```powershell +Get-AzPolicyState -Filter "ComplianceState eq 'NonCompliant'" -Apply "groupby((PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionReferenceId, PolicyDefinitionId, ResourceId))/groupby((PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionReferenceId, PolicyDefinitionId), aggregate(`$count as NumNonCompliantResources))" -OrderBy "NumNonCompliantResources desc" -Top 5 +``` + +Gets latest policy state records generated in the last day for all resources within the subscription in current session context. +The command limits the results returned by filtering based on compliance status (includes only non-compliant status). +It groups the results first based on policy assignment, policy set definition, policy definition, and resource id. +Then, it further groups the results of this grouping with the same properties except for resource id, and computes the number of records in each of these groups, which is returned inside AdditionalProperties property. +It orders the results by the count aggregation in descending order, and takes only top 5 of those listed in that order. +This generates the top 5 policies with the most number of non-compliant resources. + +### Example 22: Get latest policy states including policy evaluation details for a resource +```powershell +Get-AzPolicyState -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myns1/eventhubs/eh1/consumergroups/cg1" -Expand "PolicyEvaluationDetails" +``` + +Gets latest policy state records generated in the last day for the specified resource and expand policyEvaluationDetails. + +### Example 23: Get latest component policy states for a resource (eg. vault) given a resource provider mode policy assignment +```powershell +Get-AzPolicyState -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myvault" -Filter "policyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/ddd8ef92e3714a5ea3d208c1'" -Expand "Components(`$filter=ComplianceState eq 'NonCompliant' or ComplianceState eq 'Compliant')" +``` + +Gets latest component policy state records generated in the last day for the specified resource, given a resource provider mode policy assignment that references a resource provider mode policy definition. + +### Example 24: Get latest component policy states for a resource (eg. vault) given a policy initiative assignment that contains a resource provider mode policy definition +```powershell +Get-AzPolicyState -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myvault" -Filter "policyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/ddd8ef92e3714a5ea3d208c1' and policyDefinitionReferenceId eq 'myResourceProviderModeDefinitionReferenceId'" -Expand "Components(`$filter=ComplianceState eq 'NonCompliant' or ComplianceState eq 'Compliant')" +``` + +Gets latest component policy state records generated in the last day for the specified resource, given a resource provider mode policy assignment that references an initiative containing a resource provider mode policy definition. + +### Example 25: Get latest component counts by compliance state for a resource (eg. vault) given a resource provider mode policy assignment +```powershell +Get-AzPolicyState -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myvault" -Filter "policyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/ddd8ef92e3714a5ea3d208c1'" -Expand "Components(`$filter=ComplianceState eq 'NonCompliant' or ComplianceState eq 'Compliant' or ComplianceState eq 'Conflict';`$apply=groupby((complianceState),aggregate(`$count as count)))" +``` + +Gets latest component counts generated in the last day grouped by compliance state for the specified resource, given a resource provider mode policy assignment. + +### Example 26: Get policy states for a management group scope policy assignment +```powershell +Get-AzPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -Filter "policyAssignmentId eq '/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ddd8ef92e3714a5ea3d208c1'" +``` + +Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) in the specified subscription affected by the specified policy assignment (which is assigned to a management group which is an ancestor of the specified subscription). + +## PARAMETERS + +### -All +Within the specified time interval, get all policy states instead of the latest only. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Apply +Apply expression for aggregations using OData notation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Expand expression using OData notation. + +```yaml +Type: System.String +Parameter Sets: ResourceScope +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter expression using OData notation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +ISO 8601 formatted timestamp specifying the start time of the interval to query. +When not specified, defaults to 'To' parameter value minus 1 day. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupName +Management group name. + +```yaml +Type: System.String +Parameter Sets: ManagementGroupScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OrderBy +Ordering expression using OData notation. +One or more comma-separated column names with an optional 'desc' (the default) or 'asc'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyAssignmentName +The name of a policy assignment. +This policy assignment must have exactly the same scope as the parameter set. It cannot be a management group scope policy assignment. +For example: if `-SubscriptionId` and `ResourceGroupName` are specified, the policy assignment must be assigned to that resource group. If only `-SubscriptionId` is specified, then the policy assignment must be assigned to that subscription. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelPolicyAssignmentScope, ResourceGroupLevelPolicyAssignmentScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinitionName +The name of a policy definition. +This policy definition must exist in the subscription being queried. It cannot be a management group scope policy definition. + +```yaml +Type: System.String +Parameter Sets: PolicyDefinitionScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicySetDefinitionName +The name of a policy set definition. +This policy set definition must exist in the subscription being queried. It cannot be a management group scope policy set definition. + +```yaml +Type: System.String +Parameter Sets: PolicySetDefinitionScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupScope, ResourceGroupLevelPolicyAssignmentScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Select +Select expression using OData notation. +One or more comma-separated column names. +Limits the columns on each record to just those requested. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID. + +```yaml +Type: System.String +Parameter Sets: SubscriptionScope, ResourceGroupScope, PolicySetDefinitionScope, PolicyDefinitionScope, SubscriptionLevelPolicyAssignmentScope, ResourceGroupLevelPolicyAssignmentScope +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -To +ISO 8601 formatted timestamp specifying the end time of the interval to query. +When not specified, defaults to time of request. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Maximum number of records to return. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.PolicyInsights.Models.PolicyState + +## NOTES + +## RELATED LINKS + +[Get-AzPolicyStateSummary](./Get-AzPolicyStateSummary.md) diff --git a/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyStateSummary.md b/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyStateSummary.md new file mode 100644 index 0000000000..0122fbb5af --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/Get-AzPolicyStateSummary.md @@ -0,0 +1,388 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.dll-Help.xml +Module Name: Az.PolicyInsights +online version: https://learn.microsoft.com/powershell/module/az.policyinsights/get-azpolicystatesummary +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Get-AzPolicyStateSummary.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Get-AzPolicyStateSummary.md +--- + +# Get-AzPolicyStateSummary + +## SYNOPSIS +Gets latest policy compliance states summary for resources. + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzPolicyStateSummary [-SubscriptionId <String>] [-Top <Int32>] [-From <DateTime>] [-To <DateTime>] + [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ManagementGroupScope +``` +Get-AzPolicyStateSummary -ManagementGroupName <String> [-Top <Int32>] [-From <DateTime>] [-To <DateTime>] + [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupScope +``` +Get-AzPolicyStateSummary [-SubscriptionId <String>] -ResourceGroupName <String> [-Top <Int32>] + [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### PolicySetDefinitionScope +``` +Get-AzPolicyStateSummary [-SubscriptionId <String>] -PolicySetDefinitionName <String> [-Top <Int32>] + [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### PolicyDefinitionScope +``` +Get-AzPolicyStateSummary [-SubscriptionId <String>] -PolicyDefinitionName <String> [-Top <Int32>] + [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SubscriptionLevelPolicyAssignmentScope +``` +Get-AzPolicyStateSummary [-SubscriptionId <String>] -PolicyAssignmentName <String> [-Top <Int32>] + [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceGroupLevelPolicyAssignmentScope +``` +Get-AzPolicyStateSummary [-SubscriptionId <String>] -ResourceGroupName <String> -PolicyAssignmentName <String> + [-Top <Int32>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceScope +``` +Get-AzPolicyStateSummary -ResourceId <String> [-Top <Int32>] [-From <DateTime>] [-To <DateTime>] + [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a summary view of latest policy compliance state numbers at various scopes, broken down into policy assignments and policy definitions. It includes only non-compliant policy states. + +## EXAMPLES + +### Example 1: Get latest non-compliant policy states summary in current subscription scope +```powershell +Get-AzPolicyStateSummary +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources within the subscription in current session context. + +### Example 2: Get latest non-compliant policy states summary in the specified subscription scope +```powershell +Get-AzPolicyStateSummary -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources within the specified subscription. + +### Example 3: Get latest non-compliant policy states summary in management group scope +```powershell +Get-AzPolicyStateSummary -ManagementGroupName "myManagementGroup" +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources within the specified management group. + +### Example 4: Get latest non-compliant policy states summary in resource group scope in current subscription +```powershell +Get-AzPolicyStateSummary -ResourceGroupName "myResourceGroup" +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources within the specified resource group (in the subscription in current session context). + +### Example 5: Get latest non-compliant policy states summary in resource group scope in the specified subscription +```powershell +Get-AzPolicyStateSummary -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -ResourceGroupName "myResourceGroup" +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources within the specified resource group (in the specified subscription). + +### Example 6: Get latest non-compliant policy states summary for a resource +```powershell +Get-AzPolicyStateSummary -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myns1/eventhubs/eh1/consumergroups/cg1" +``` + +Gets the summary view of latest policy compliance states generated in the last day for the specified resource. + +### Example 7: Get latest non-compliant policy states summary for a policy set definition in current subscription +```powershell +Get-AzPolicyStateSummary -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy set definition (that exists in the subscription in current session context). + +### Example 8: Get latest non-compliant policy states summary for a policy set definition in the specified subscription +```powershell +Get-AzPolicyStateSummary -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy set definition (that exists in the specified subscription). + +### Example 9: Get latest non-compliant policy states summary for a policy definition in current subscription +```powershell +Get-AzPolicyStateSummary -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy definition (that exists in the subscription in current session context). + +### Example 10: Get latest non-compliant policy states summary for a policy definition in the specified subscription +```powershell +Get-AzPolicyStateSummary -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy definition (that exists in the specified subscription). + +### Example 11: Get latest non-compliant policy states summary for a policy assignment in current subscription +```powershell +Get-AzPolicyStateSummary -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the subscription in current session context). + +### Example 12: Get latest non-compliant policy states summary for a policy assignment in the specified subscription +```powershell +Get-AzPolicyStateSummary -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the specified subscription). + +### Example 13: Get latest non-compliant policy states summary for a policy assignment in the specified resource group in the current subscription +```powershell +Get-AzPolicyStateSummary -ResourceGroupName "myResourceGroup" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the resource group in the subscription in current session context). + +### Example 14: Get latest non-compliant policy states summary in current subscription scope, with Top query option +```powershell +Get-AzPolicyStateSummary -Top 5 +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources within the subscription in current session context. +The command orders the policy assignment summaries in the results by non-compliant resource counts in descending order, and takes only top 5 of those policy assignment summaries. + +### Example 15: Get latest non-compliant policy states summary in current subscription scope, with From and To query options +```powershell +Get-AzPolicyStateSummary -From "2018-03-08 00:00:00Z" -To "2018-03-15 00:00:00Z" +``` + +Gets the summary view of latest policy compliance states generated within the date range specified for all resources within the subscription in current session context. + +### Example 16: Get latest non-compliant policy states summary in current subscription scope, with Filter query option +```powershell +Get-AzPolicyStateSummary -Filter "(PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit') and ResourceLocation ne 'eastus'" +``` + +Gets the summary view of latest policy compliance states generated in the last day for all resources within the subscription in current session context. +The command limits the results returned by filtering based on policy definition action (includes deny or audit actions), and resource location (excludes eastus location). + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter expression using OData notation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +ISO 8601 formatted timestamp specifying the start time of the interval to query. +When not specified, defaults to 'To' parameter value minus 1 day. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupName +Management group name. + +```yaml +Type: System.String +Parameter Sets: ManagementGroupScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyAssignmentName +Policy assignment name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelPolicyAssignmentScope, ResourceGroupLevelPolicyAssignmentScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinitionName +Policy definition name. + +```yaml +Type: System.String +Parameter Sets: PolicyDefinitionScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicySetDefinitionName +Policy set definition name. + +```yaml +Type: System.String +Parameter Sets: PolicySetDefinitionScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupScope, ResourceGroupLevelPolicyAssignmentScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID. + +```yaml +Type: System.String +Parameter Sets: SubscriptionScope, ResourceGroupScope, PolicySetDefinitionScope, PolicyDefinitionScope, SubscriptionLevelPolicyAssignmentScope, ResourceGroupLevelPolicyAssignmentScope +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -To +ISO 8601 formatted timestamp specifying the end time of the interval to query. +When not specified, defaults to time of request. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Maximum number of records to return. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.PolicyInsights.Models.PolicyStateSummary + +## NOTES + +## RELATED LINKS + +[Get-AzPolicyState](./Get-AzPolicyState.md) diff --git a/azps-10.1.0/Az.PolicyInsights/New-AzPolicyAttestation.md b/azps-10.1.0/Az.PolicyInsights/New-AzPolicyAttestation.md new file mode 100644 index 0000000000..f3aaf46e32 --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/New-AzPolicyAttestation.md @@ -0,0 +1,469 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.dll-Help.xml +Module Name: Az.PolicyInsights +online version: https://learn.microsoft.com/powershell/module/az.policyinsights/new-azpolicyattestation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/New-AzPolicyAttestation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/New-AzPolicyAttestation.md +--- + +# New-AzPolicyAttestation + +## SYNOPSIS +Creates a new policy attestation for a policy assignment. + +## SYNTAX + +### ByName (Default) +``` +New-AzPolicyAttestation -Name <String> [-Scope <String>] [-ResourceGroupName <String>] + -PolicyAssignmentId <String> [-ComplianceState <String>] [-PolicyDefinitionReferenceId <String>] + [-ExpiresOn <DateTime>] [-Owner <String>] [-Comment <String>] [-Evidence <PSAttestationEvidence[]>] + [-AssessmentDate <DateTime>] [-Metadata <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +New-AzPolicyAttestation -ResourceId <String> -PolicyAssignmentId <String> [-ComplianceState <String>] + [-PolicyDefinitionReferenceId <String>] [-ExpiresOn <DateTime>] [-Owner <String>] [-Comment <String>] + [-Evidence <PSAttestationEvidence[]>] [-AssessmentDate <DateTime>] [-Metadata <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPolicyAttestation** cmdlet creates a policy attestation for a particular policy assignment. Attestations are used by Azure Policy to set compliance states of resources or scopes targeted by manual policies. They also allow users to provide additional metadata or link to evidence which accompanies the attested compliance state. + +## EXAMPLES + +### Example 1: Create an attestation at subscription scope +```powershell +Set-AzContext -Subscription "d1acb22b-c876-44f7-b08e-3fcf9f6767f4" +$policyAssignmentId = "/subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignments/psattestationsubassignment" +$attestationName = "attestation-subscription" +New-AzPolicyAttestation -PolicyAssignmentId $policyAssignmentId -Name $attestationName -ComplianceState "Compliant" +``` + +```output +Id : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.policyinsights + /attestations/attestation-subscription +Name : attestation-subscription +Type : Microsoft.PolicyInsights/attestations +PolicyAssignmentId : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/ + policyassignments/psattestationsubassignment +PolicyDefinitionReferenceId : +ComplianceState : Compliant +ExpiresOn : +Owner : +Comment : +Evidence : +ProvisioningState : Succeeded +LastComplianceStateChangeAt : 1/27/2023 2:26:24 AM +AssessmentDate : +Metadata : +SystemData : +``` + +This command creates a new policy attestation at subscription 'd1acb22b-c876-44f7-b08e-3fcf9f6767f4' for the given policy assignment. + +>**Note:** +>This command creates an attestation for the subscription and not the resources underneath it. For ease of management, manual policies should be designed to target the scope which defines the boundary of resources whose compliance state needs to be attested. In this case, the manual policy should be targeting `Microsoft.Resources/subscriptions`. For more information, go to https://learn.microsoft.com/en-us/azure/governance/policy/concepts/attestation-structure to understand the best practices for creating attestations. + +### Example 2: Create an attestation at resource group +```powershell +$policyAssignmentId = "/subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignments/psattestationrgassignment" +$attestationName = "attestation-RG" +$rgName = "ps-attestation-test-rg" +New-AzPolicyAttestation -ResourceGroupName $RGName -PolicyAssignmentId $policyAssignmentId -Name $attestationName -ComplianceState "Compliant" +``` + +```output +Id : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/resourcegroups/ps-attestation-test + -rg/providers/microsoft.policyinsights/attestations/attestation-rg +Name : attestation-RG +Type : Microsoft.PolicyInsights/attestations +PolicyAssignmentId : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/ + policyassignments/psattestationrgassignment +PolicyDefinitionReferenceId : +ComplianceState : Compliant +ExpiresOn : +Owner : +Comment : +Evidence : +ProvisioningState : Succeeded +LastComplianceStateChangeAt : 1/27/2023 2:35:28 AM +AssessmentDate : +Metadata : +SystemData : +``` + +This command creates a new policy attestation at the resource group 'ps-attestation-test-rg' for the given policy assignment. + +>**Note:** +>This command creates an attestation for the resource group and not the resources underneath it. For ease of management, manual policies should be designed to target the scope which defines the boundary of resources whose compliance state needs to be attested. In this case, the manual policy should be targeting `Microsoft.Resources/subscriptions/resourceGroups`. For more information, go to https://learn.microsoft.com/en-us/azure/governance/policy/concepts/attestation-structure to understand the best practices for creating attestations. + +### Example 3: Create an attestation at resource +```powershell +$policyAssignmentId = "/subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignments/psattestationresourceassignment" +$attestationName = "attestation-resource" +$scope = "/subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/resourceGroups/ps-attestation-test-rg/providers/Microsoft.Network/networkSecurityGroups/pstests0" +New-AzPolicyAttestation ` + -PolicyAssignmentId $policyAssignmentId ` + -Name $attestationName ` + -Scope $scope ` + -ComplianceState "NonCompliant" +``` + +```output +Id : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/resourcegroups/ps-attestation-test + -rg/providers/microsoft.network/networksecuritygroups/pstests0/providers/microsoft.pol + icyinsights/attestations/attestation-resource +Name : attestation-resource +Type : Microsoft.PolicyInsights/attestations +PolicyAssignmentId : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/ + policyassignments/psattestationresourceassignment +PolicyDefinitionReferenceId : +ComplianceState : NonCompliant +ExpiresOn : +Owner : +Comment : +Evidence : +ProvisioningState : Succeeded +LastComplianceStateChangeAt : 1/27/2023 2:38:17 AM +AssessmentDate : +Metadata : +SystemData : +``` + +This command creates an attestation for the resource 'pstests0' for the given policy assignment. + +### Example 4: Create an attestation with all properties at resource group +```powershell +$attestationName = "attestationRGAllProps" +$policyInitiativeAssignmentId = "/subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignments/psattestationinitiativergassignment" + +$policyDefinitionReferenceId = "PSTestAttestationRG_1" +$RGName = "ps-attestation-test-rg" +$description = "This is a test description" +$sourceURI = "https://contoso.org/test.pdf" +$evidence = @{ + "Description"=$description + "SourceUri"=$sourceURI +} +$policyEvidence = @($evidence) +$owner = "Test Owner" +$expiresOn = [datetime]::UtcNow.AddYears(1) +$metadata = '{"TestKey":"TestValue"}' + +New-AzPolicyAttestation ` + -Name $attestationName ` + -ResourceGroupName $RGName ` + -PolicyAssignmentId $policyInitiativeAssignmentId ` + -PolicyDefinitionReferenceId $policyDefinitionReferenceId ` + -ComplianceState $Compliant ` + -Comment $comment ` + -Evidence $policyEvidence ` + -ExpiresOn $expiresOn ` + -AssessmentDate $expiresOn.AddDays(-2) ` + -Owner $owner ` + -Metadata $metadata +``` + +```output +Id : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/resourcegroups/ps-attestation-test + -rg/providers/microsoft.policyinsights/attestations/attestationrgallprops +Name : attestationRGAllProps +Type : Microsoft.PolicyInsights/attestations +PolicyAssignmentId : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/ + policyassignments/psattestationinitiativergassignment +PolicyDefinitionReferenceId : pstestattestationrg_1 +ComplianceState : +ExpiresOn : 1/27/2024 2:51:54 AM +Owner : Test Owner +Comment : +Evidence : {Microsoft.Azure.Commands.PolicyInsights.Models.Attestations.PSAttestationEvidence} +ProvisioningState : Succeeded +LastComplianceStateChangeAt : 1/27/2023 2:51:57 AM +AssessmentDate : 1/25/2024 2:51:54 AM +Metadata : { + "TestKey": "TestValue" + } +SystemData : +``` + +## PARAMETERS + +### -AssessmentDate +The time the evidence of an attestation was assessed. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Comment +Comments describing why this attestation was created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ComplianceState +The Compliance State of the resource. +E.g. +'Compliant', 'NonCompliant', 'Unknown' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Evidence +The evidence supporting the compliance state set in this attestation. + +```yaml +Type: Microsoft.Azure.Commands.PolicyInsights.Models.Attestations.PSAttestationEvidence[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpiresOn +The time the compliance state set in the attestation should expire. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Metadata +Additional metadata for the attestation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Owner +The person responsible for setting the state of the resource. +This value is typically an Azure Active Directory object ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyAssignmentId +Policy assignment ID. +E.g. +'/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments/{assignmentName}'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinitionReferenceId +The policy definition reference ID of the individual definition. +Required when the policy assignment assigns a policy set definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Scope of the resource. +E.g. +'/subscriptions/{subscriptionId}/resourceGroups/{rgName}'. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.PolicyInsights.Models.Attestations.PSAttestationEvidence[] + +### System.Object + +## OUTPUTS + +### Microsoft.Azure.Commands.PolicyInsights.Models.Attestations.PSAttestation + +## NOTES + +## RELATED LINKS +[Get-AzPolicyAttestation](./Get-AzPolicyAttestation.md) + +[Set-AzPolicyAttestation](./Set-AzPolicyAttestation.md) + +[Remove-AzPolicyAttestation](./Remove-AzPolicyAttestation.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.PolicyInsights/Remove-AzPolicyAttestation.md b/azps-10.1.0/Az.PolicyInsights/Remove-AzPolicyAttestation.md new file mode 100644 index 0000000000..a12d9d4e92 --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/Remove-AzPolicyAttestation.md @@ -0,0 +1,226 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.dll-Help.xml +Module Name: Az.PolicyInsights +online version: https://learn.microsoft.com/powershell/module/az.policyinsights/remove-azpolicyattestation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Remove-AzPolicyAttestation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Remove-AzPolicyAttestation.md +--- + +# Remove-AzPolicyAttestation + +## SYNOPSIS +Deletes a policy attestation. + +## SYNTAX + +### ByName (Default) +``` +Remove-AzPolicyAttestation -Name <String> [-Scope <String>] [-ResourceGroupName <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzPolicyAttestation -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzPolicyAttestation -InputObject <PSAttestation> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPolicyAttestation** cmdlet deletes a policy attestation. + +## EXAMPLES + +### Example 1: Delete a policy remediation by name at subscription scope. +```powershell +Set-AzContext -Subscription "d1acb22b-c876-44f7-b08e-3fcf9f6767f4" +Remove-AzPolicyAttestation -Name "attestation-subscription" -PassThru +``` + +```output +True +``` + +This command deletes the attestation named 'attestation-subscription' in subscription "d1acb22b-c876-44f7-b08e-3fcf9f6767f4". The `-PassThru` switch forces the cmdlet to return the status of the operation. + +### Example 2: Delete a policy remediation via piping at resource group. +```powershell +$rgName = "ps-attestation-test-rg" +Get-AzPolicyAttestation -Name "attestation-RG" -ResourceGroupName $rgName | Remove-AzPolicyAttestation +``` + +This command deletes the attestation named 'attestation-RG' at resource group 'ps-attestation-test-rg' using input object given by the **Get-AzPolicyAttestation** cmdlet. + +### Example 3: Delete a policy remediation using ResourceId. +```powershell +$scope = "/subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/resourceGroups/ps-attestation-test-rg/providers/Microsoft.Network/networkSecurityGroups/pstests0" +$attestationToDelete = Get-AzPolicyAttestation -Name "attestation-resource" -Scope $scope +Remove-AzPolicyAttestation -Id $attestationToDelete.Id +``` + +The first command gets an attestation named 'attestation-resource' with a resource id supplied as scope. +The second command then deletes the attestation using the resource id of the stored attestation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Attestation object. + +```yaml +Type: Microsoft.Azure.Commands.PolicyInsights.Models.Attestations.PSAttestation +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Return True if the command completes successfully. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Scope of the resource. +E.g. +'/subscriptions/{subscriptionId}/resourceGroups/{rgName}'. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.PolicyInsights.Models.Attestations.PSAttestation + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS +[Get-AzPolicyAttestation](./Get-AzPolicyAttestation.md) diff --git a/azps-10.1.0/Az.PolicyInsights/Remove-AzPolicyRemediation.md b/azps-10.1.0/Az.PolicyInsights/Remove-AzPolicyRemediation.md new file mode 100644 index 0000000000..d175ec0511 --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/Remove-AzPolicyRemediation.md @@ -0,0 +1,263 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.dll-Help.xml +Module Name: Az.PolicyInsights +online version: https://learn.microsoft.com/powershell/module/az.policyinsights/remove-azpolicyremediation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Remove-AzPolicyRemediation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Remove-AzPolicyRemediation.md +--- + +# Remove-AzPolicyRemediation + +## SYNOPSIS +Deletes a policy remediation. + +## SYNTAX + +### ByName (Default) +``` +Remove-AzPolicyRemediation -Name <String> [-Scope <String>] [-ManagementGroupName <String>] + [-ResourceGroupName <String>] [-AllowStop] [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzPolicyRemediation -ResourceId <String> [-AllowStop] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzPolicyRemediation -InputObject <PSRemediation> [-AllowStop] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPolicyRemediation** cmdlet deletes a policy remediation. + +## EXAMPLES + +### Example 1: Delete a policy remediation at resource group scope +```powershell +Remove-AzPolicyRemediation -ResourceGroupName "myRG" -Name "remediation1" +``` + +This command deletes the remediation named 'remediation1' in resource group 'myRG'. + +### Example 2: Delete a management group remediation via piping +```powershell +$remediation = Get-AzPolicyRemediation -ManagementGroupName "mg1" -Name "remediation1" +$remediation | Remove-AzPolicyRemediation -Confirm +``` + +This command deletes the remediation named 'remediation1' from management group 'mg1'. A confirmation prompt will be presented before deleting the resource. + +### Example 3: Cancel and delete a policy remediation +```powershell +Remove-AzPolicyRemediation -ResourceGroupName "myRG" -Name "remediation1" -AllowStop +``` + +This command deletes the remediation named 'remediation1' in resource group 'myRG'. If the remediation is in-progress it will be canceled before being deleted. + +## PARAMETERS + +### -AllowStop +Allow the remediation to be canceled if it is in-progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Remediation object. + +```yaml +Type: Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediation +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagementGroupName +Management group ID. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Return True if the command completes successfully. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Scope of the resource. +E.g. +'/subscriptions/{subscriptionId}/resourceGroups/{rgName}'. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediation + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.PolicyInsights/Set-AzPolicyAttestation.md b/azps-10.1.0/Az.PolicyInsights/Set-AzPolicyAttestation.md new file mode 100644 index 0000000000..99c12a5b5a --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/Set-AzPolicyAttestation.md @@ -0,0 +1,447 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.dll-Help.xml +Module Name: Az.PolicyInsights +online version: https://learn.microsoft.com/powershell/module/az.policyinsights/set-azpolicyattestation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Set-AzPolicyAttestation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Set-AzPolicyAttestation.md +--- + +# Set-AzPolicyAttestation + +## SYNOPSIS +Modifies a policy attestation. + +## SYNTAX + +### ByName (Default) +``` +Set-AzPolicyAttestation -Name <String> [-Scope <String>] [-ResourceGroupName <String>] + [-PolicyAssignmentId <String>] [-ComplianceState <String>] [-PolicyDefinitionReferenceId <String>] + [-ExpiresOn <DateTime>] [-Owner <String>] [-Comment <String>] [-Evidence <PSAttestationEvidence[]>] + [-AssessmentDate <DateTime>] [-Metadata <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzPolicyAttestation -ResourceId <String> [-PolicyAssignmentId <String>] [-ComplianceState <String>] + [-PolicyDefinitionReferenceId <String>] [-ExpiresOn <DateTime>] [-Owner <String>] [-Comment <String>] + [-Evidence <PSAttestationEvidence[]>] [-AssessmentDate <DateTime>] [-Metadata <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Set-AzPolicyAttestation -InputObject <PSAttestation> [-PolicyAssignmentId <String>] [-ComplianceState <String>] + [-PolicyDefinitionReferenceId <String>] [-ExpiresOn <DateTime>] [-Owner <String>] [-Comment <String>] + [-Evidence <PSAttestationEvidence[]>] [-AssessmentDate <DateTime>] [-Metadata <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPolicyAttestation** cmdlet modifies a policy attestation. Specify an attestation by Id or by Name and scope, or via piping. + +>**Note:** +>An existing policy attestation's `policyAssignmentId` or `policyDefinitionReferenceId` cannot be modified. + +## EXAMPLES + +### Example 1: Update an attestation by name +```powershell +Set-AzContext -Subscription "d1acb22b-c876-44f7-b08e-3fcf9f6767f4" +# Update the existing attestation by resource name at subscription scope (default) +$comment = "Setting the state to non compliant" +$attestationName = "attestation-subscription" +$policyAssignmentId = "/subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/Microsoft.Authorization/policyAssignments/PSAttestationSubAssignment" +Set-AzPolicyAttestation -PolicyAssignmentId $policyAssignmentId -Name $attestationName -ComplianceState "NonCompliant" -Comment $comment +``` + +```output +Id : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.policyinsights/attestations/ + attestation-subscription +Name : attestation-subscription +Type : Microsoft.PolicyInsights/attestations +PolicyAssignmentId : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignme + nts/psattestationsubassignment +PolicyDefinitionReferenceId : +ComplianceState : NonCompliant +ExpiresOn : +Owner : +Comment : Setting the state to non compliant +Evidence : +ProvisioningState : Succeeded +LastComplianceStateChangeAt : 1/27/2023 4:00:04 PM +AssessmentDate : +Metadata : +SystemData : +``` + +The command here sets the compliance state and adds a comment to an existing attestation with name 'attestation-subscription' in the subscription with id 'd1acb22b-c876-44f7-b08e-3fcf9f6767f4' + +### Example 2: Update an attestation by ResourceId +```powershell +# Get an attestation +$rgName = "ps-attestation-test-rg" +$attestationName = "attestation-RG" +$attestation = Get-AzPolicyAttestation -ResourceGroupName $rgName -Name $attestationName + +# Update the existing attestation by resource ID at RG +$expiresOn = [System.DateTime]::UtcNow.AddYears(1) +Set-AzPolicyAttestation -Id $attestation.Id -ExpiresOn $expiresOn +``` + +```output +Id : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/resourcegroups/ps-attestation-test-rg/providers/ + microsoft.policyinsights/attestations/attestation-rg +Name : attestation-rg +Type : Microsoft.PolicyInsights/attestations +PolicyAssignmentId : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignme + nts/psattestationrgassignment +PolicyDefinitionReferenceId : +ComplianceState : +ExpiresOn : 1/27/2024 4:04:24 PM +Owner : +Comment : +Evidence : +ProvisioningState : Succeeded +LastComplianceStateChangeAt : 1/27/2023 4:04:11 PM +AssessmentDate : +Metadata : +SystemData : +``` + +The first command gets an existing attestation at the resource group 'ps-attestation-test-rg' with the name 'attestation-RG'. + +The final command updates the expiry time of the policy attestation by the **ResourceId** property of the existing attestation. + +### Example 3: Update an attestation by input object +```powershell +# Get an attestation +$attestationName = "attestation-resource" +$scope = "/subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/resourceGroups/ps-attestation-test-rg/providers/Microsoft.Network/networkSecurityGroups/pstests0" +$attestation = Get-AzPolicyAttestation -Name $attestationName -Scope $scope + +# Update attestation by input object +$newOwner = "Test Owner 2" +$attestation | Set-AzPolicyAttestation -Owner $newOwner +``` + +```output +Id : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/resourcegroups/ps-attestation-test-rg/providers/ + microsoft.network/networksecuritygroups/pstests0/providers/microsoft.policyinsights/attestations/att + estation-resource +Name : attestation-resource +Type : Microsoft.PolicyInsights/attestations +PolicyAssignmentId : /subscriptions/d1acb22b-c876-44f7-b08e-3fcf9f6767f4/providers/microsoft.authorization/policyassignme + nts/psattestationresourceassignment +PolicyDefinitionReferenceId : +ComplianceState : NonCompliant +ExpiresOn : +Owner : Test Owner 2 +Comment : +Evidence : +ProvisioningState : Succeeded +LastComplianceStateChangeAt : 1/27/2023 2:38:17 AM +AssessmentDate : +Metadata : +SystemData : +``` + +The first command gets an existing attestation with name 'attestation-resource' for the given resource using its resource id as the scope + +The final command updates the owner of the policy attestation by using piping. + +## PARAMETERS + +### -AssessmentDate +The time the evidence of an attestation was assessed. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Comment +Comments describing why this attestation was created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ComplianceState +The Compliance State of the resource. +E.g. +'Compliant', 'NonCompliant', 'Unknown' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Evidence +The evidence supporting the compliance state set in this attestation. + +```yaml +Type: Microsoft.Azure.Commands.PolicyInsights.Models.Attestations.PSAttestationEvidence[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpiresOn +The time the compliance state set in the attestation should expire. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The Attestation object. + +```yaml +Type: Microsoft.Azure.Commands.PolicyInsights.Models.Attestations.PSAttestation +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Metadata +Additional metadata for the attestation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Owner +The person responsible for setting the state of the resource. +This value is typically an Azure Active Directory object ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyAssignmentId +Policy assignment ID. +E.g. +'/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments/{assignmentName}'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinitionReferenceId +The policy definition reference ID of the individual definition. +Required when the policy assignment assigns a policy set definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Scope of the resource. +E.g. +'/subscriptions/{subscriptionId}/resourceGroups/{rgName}'. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.PolicyInsights.Models.Attestations.PSAttestation + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.PolicyInsights.Models.Attestations.PSAttestationEvidence[] + +### System.Object + +## OUTPUTS + +### Microsoft.Azure.Commands.PolicyInsights.Models.Attestations.PSAttestation + +## NOTES + +## RELATED LINKS +[New-AzPolicyAttestation](./New-AzPolicyAttestation.md) + +[Remove-AzPolicyAttestation](./Remove-AzPolicyAttestation.md) + +[Get-AzPolicyAttestation](./Get-AzPolicyAttestation.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.PolicyInsights/Start-AzPolicyComplianceScan.md b/azps-10.1.0/Az.PolicyInsights/Start-AzPolicyComplianceScan.md new file mode 100644 index 0000000000..17965b6788 --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/Start-AzPolicyComplianceScan.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.dll-Help.xml +Module Name: Az.PolicyInsights +online version: https://learn.microsoft.com/powershell/module/az.policyinsights/start-azpolicycompliancescan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Start-AzPolicyComplianceScan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Start-AzPolicyComplianceScan.md +--- + +# Start-AzPolicyComplianceScan + +## SYNOPSIS +Triggers a policy compliance evaluation for all resources in a subscription or resource group. + +## SYNTAX + +``` +Start-AzPolicyComplianceScan [-ResourceGroupName <String>] [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzPolicyComplianceScan** cmdlet starts a policy compliance evaluation for a subscription or resource group. All resources within that scope will have their compliance state evaluated against all assigned policies. + +## EXAMPLES + +### Example 1: Start a compliance scan at subscription scope +```powershell +Start-AzPolicyComplianceScan +``` + +This command starts a policy compliance evaluation for the active subscription. + +### Example 2: Start a compliance scan at resource group scope +```powershell +Start-AzPolicyComplianceScan -ResourceGroupName "myRG" +``` + +This command starts a policy compliance evaluation for the "myRG" resource group in the active subscription. + +### Example 3: Start a compliance scan and wait for it to complete in the background +```powershell +$job = Start-AzPolicyComplianceScan -AsJob +$job | Wait-Job +``` + +This command starts a policy compliance evaluation for the active subscription. It will wait for the scan to complete. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return True if the command completes successfully. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.PolicyInsights/Start-AzPolicyRemediation.md b/azps-10.1.0/Az.PolicyInsights/Start-AzPolicyRemediation.md new file mode 100644 index 0000000000..3a33abb24b --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/Start-AzPolicyRemediation.md @@ -0,0 +1,375 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.dll-Help.xml +Module Name: Az.PolicyInsights +online version: https://learn.microsoft.com/powershell/module/az.policyinsights/start-azpolicyremediation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Start-AzPolicyRemediation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Start-AzPolicyRemediation.md +--- + +# Start-AzPolicyRemediation + +## SYNOPSIS +Creates and starts a policy remediation for a policy assignment. + +## SYNTAX + +### ByName (Default) +``` +Start-AzPolicyRemediation -Name <String> [-Scope <String>] [-ManagementGroupName <String>] + [-ResourceGroupName <String>] -PolicyAssignmentId <String> [-PolicyDefinitionReferenceId <String>] + [-LocationFilter <String[]>] [-ResourceDiscoveryMode <String>] [-ResourceCount <Int32>] + [-ParallelDeploymentCount <Int32>] [-FailureThreshold <Double>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Start-AzPolicyRemediation -ResourceId <String> -PolicyAssignmentId <String> + [-PolicyDefinitionReferenceId <String>] [-LocationFilter <String[]>] [-ResourceDiscoveryMode <String>] + [-ResourceCount <Int32>] [-ParallelDeploymentCount <Int32>] [-FailureThreshold <Double>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzPolicyRemediation** cmdlet creates a policy remediation for a particular policy assignment. All non-compliant resources at or below the remediation's scope will be remediated. Remediation is only supported for policies with the 'deployIfNotExists' effect. + +## EXAMPLES + +### Example 1: Start a remediation at subscription scope +```powershell +$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309" +Set-AzContext -Subscription "My Subscription" +Start-AzPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1" +``` + +This command creates a new policy remediation in subscription 'My Subscription' for the given policy assignment. + +### Example 2: Start a remediation at management group scope with optional filters +```powershell +$policyAssignmentId = "/providers/Microsoft.Management/managementGroups/mg1/providers/Microsoft.Authorization/policyAssignments/pa1" +Start-AzPolicyRemediation -ManagementGroupName "mg1" -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -LocationFilter "westus","eastus" +``` + +This command creates a new policy remediation in management group 'mg1' for the given policy assignment. Only resources in the 'westus' or 'eastus' locations will be remediated. + +### Example 3: Start a remediation at resource group scope for a policy set definition assignment +```powershell +$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/resourceGroups/myRG/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309" +Start-AzPolicyRemediation -ResourceGroupName "myRG" -PolicyAssignmentId $policyAssignmentId -PolicyDefinitionReferenceId "0349234412441" -Name "remediation1" +``` + +This command creates a new policy remediation in resource group 'myRG' for the given policy assignment. The policy assignment assigns a policy set definition (also known as an initiative). The policy definition reference ID indicates which policy within the initiative should be remediated. + +### Example 4: Start a remediation and wait for it to complete in the background +```powershell +$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309" +Set-AzContext -Subscription f0710c27-9663-4c05-19f8-1b4be01e86a5 +$job = Start-AzPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -AsJob +$job | Wait-Job +$remediation = $job | Receive-Job +``` + +This command starts a new policy remediation in subscription 'My Subscription' for the given policy assignment. It will wait for the remediation to complete before returning the final remediation status. + +### Example 5: Start a remediation that will discover non-compliant resources before remediating +```powershell +$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309" +Set-AzContext -Subscription "My Subscription" +Start-AzPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -ResourceDiscoveryMode ReEvaluateCompliance +``` + +This command creates a new policy remediation in subscription 'My Subscription' for the given policy assignment. The compliance state of resources in the subscription will be re-evaluated against the policy assignment and non-compliant resources will be remediated. + +### Example 6: Start a remediation that will remediate up to 10,000 non-compliant resources +```powershell +$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309" +Set-AzContext -Subscription "My Subscription" +Start-AzPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -ResourceCount 10000 +``` + +### Example 7: Start a remediation that will remediate 30 resources in parallel +```powershell +$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309" +Set-AzContext -Subscription "My Subscription" +Start-AzPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -ParallelDeploymentCount 30 +``` + +### Example 8: Start a remediation that will terminate if more than half of the remediation deployments fail +```powershell +$policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309" +Set-AzContext -Subscription "My Subscription" +Start-AzPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -FailureThreshold 0.5 +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailureThreshold +Number between 0.0 to 1.0 representing the percentage failure threshold. The remediation will fail if the percentage of failed remediation operations (i.e. failed deployments) exceeds this threshold. + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LocationFilter +The resource locations that should be included in the remediation. +Resources that don't reside in these locations will not be remediated. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagementGroupName +Management group ID. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParallelDeploymentCount +How many resources to remediate at any given time. Can be used to control the pace of the remediation. If not provided, the default parallel deployments value is used. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyAssignmentId +Policy assignment ID. +E.g. +'/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments/{assignmentName}'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinitionReferenceId +Gets the policy definition reference ID of the individual definition that is being remediated. +Required when the policy assignment assigns a policy set definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceCount +Maximum number of non-compliant resources that will be remediated. If not provided, the default resource count is used. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceDiscoveryMode +Describes how the remediation task will discover resources that need to be remediated. +ReEvaluateCompliance is not supported when remediating management group scopes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: ExistingNonCompliant, ReEvaluateCompliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Scope of the resource. +E.g. +'/subscriptions/{subscriptionId}/resourceGroups/{rgName}'. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[System.Double, System.Private.CoreLib, Version=7.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.PolicyInsights/Stop-AzPolicyRemediation.md b/azps-10.1.0/Az.PolicyInsights/Stop-AzPolicyRemediation.md new file mode 100644 index 0000000000..bdf5e64658 --- /dev/null +++ b/azps-10.1.0/Az.PolicyInsights/Stop-AzPolicyRemediation.md @@ -0,0 +1,241 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.dll-Help.xml +Module Name: Az.PolicyInsights +online version: https://learn.microsoft.com/powershell/module/az.policyinsights/stop-azpolicyremediation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Stop-AzPolicyRemediation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/help/Stop-AzPolicyRemediation.md +--- + +# Stop-AzPolicyRemediation + +## SYNOPSIS +Cancels an in-progress policy remediation. + +## SYNTAX + +### ByName (Default) +``` +Stop-AzPolicyRemediation -Name <String> [-Scope <String>] [-ManagementGroupName <String>] + [-ResourceGroupName <String>] [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Stop-AzPolicyRemediation -ResourceId <String> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Stop-AzPolicyRemediation -InputObject <PSRemediation> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzPolicyRemediation** cmdlet cancels an in-progress policy remediation. Active deployments will be canceled and no new deployments will be created. + +## EXAMPLES + +### Example 1: Cancel a policy remediation at resource group scope +```powershell +Stop-AzPolicyRemediation -ResourceGroupName "myRG" -Name "remediation1" +``` + +This command cancels the remediation named 'remediation1' in resource group 'myRG'. + +### Example 2: Cancel a management group remediation via piping +```powershell +$remediation = Get-AzPolicyRemediation -ManagementGroupName "mg1" -Name "remediation1" +$remediation | Stop-AzPolicyRemediation +``` + +This command cancels the remediation named 'remediation1' in management group 'mg1'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Remediation object. + +```yaml +Type: Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediation +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagementGroupName +Management group ID. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Return True if the command completes successfully. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Scope of the resource. +E.g. +'/subscriptions/{subscriptionId}/resourceGroups/{rgName}'. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediation + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Portal/Az.Portal.md b/azps-10.1.0/Az.Portal/Az.Portal.md new file mode 100644 index 0000000000..749a20fd13 --- /dev/null +++ b/azps-10.1.0/Az.Portal/Az.Portal.md @@ -0,0 +1,30 @@ +--- +Module Name: Az.Portal +Module Guid: abd8c13e-6209-4e5a-a276-61e7a80845f9 +Download Help Link: https://learn.microsoft.com/powershell/module/az.portal +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Portal/help/Az.Portal.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Portal/help/Az.Portal.md +--- + +# Az.Portal Module +## Description +Microsoft Azure PowerShell: Portal Dashboard cmdlets + +## Az.Portal Cmdlets +### [Get-AzPortalDashboard](Get-AzPortalDashboard.md) +Gets the Dashboard. + +### [New-AzPortalDashboard](New-AzPortalDashboard.md) +Creates or updates a Dashboard. + +### [Remove-AzPortalDashboard](Remove-AzPortalDashboard.md) +Deletes the Dashboard. + +### [Set-AzPortalDashboard](Set-AzPortalDashboard.md) +Creates or updates a Dashboard. + +### [Update-AzPortalDashboard](Update-AzPortalDashboard.md) +Updates an existing Dashboard. + diff --git a/azps-10.1.0/Az.Portal/Get-AzPortalDashboard.md b/azps-10.1.0/Az.Portal/Get-AzPortalDashboard.md new file mode 100644 index 0000000000..d52b805d31 --- /dev/null +++ b/azps-10.1.0/Az.Portal/Get-AzPortalDashboard.md @@ -0,0 +1,178 @@ +--- +external help file: +Module Name: Az.Portal +online version: https://learn.microsoft.com/powershell/module/az.portal/get-azportaldashboard +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Portal/help/Get-AzPortalDashboard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Portal/help/Get-AzPortalDashboard.md +--- + +# Get-AzPortalDashboard + +## SYNOPSIS +Gets the Dashboard. + +## SYNTAX + +### List1 (Default) +``` +Get-AzPortalDashboard [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPortalDashboard -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPortalDashboard -InputObject <IPortalIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzPortalDashboard -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the Dashboard. + +## EXAMPLES + +### Example 1: List all dashboards in a subscription +```powershell +Get-AzPortalDashboard +``` + +```output +Location Name Type +-------- ---- ---- +eastasia my-custom-dashboard1 Microsoft.Portal/dashboards +westus my-second-custom-dashboard1 Microsoft.Portal/dashboards +``` + +List all dashboards in a subscription + +### Example 2: Get details for a single Portal Dashboard +```powershell +Get-AzPortalDashboard -ResourceGroupName my-rg -Name mydashboard +``` + +```output +Location Name Type +-------- ---- ---- +eastus mydashboard Microsoft.Portal/dashboards +``` + +Get details for a single dashboard + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Portal.Models.IPortalIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the dashboard. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DashboardName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Portal.Models.IPortalIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Portal.Models.Api201901Preview.IDashboard + +## 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 `<IPortalIdentity>`: Identity Parameter + - `[DashboardName <String>]`: The name of the dashboard. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Portal/New-AzPortalDashboard.md b/azps-10.1.0/Az.Portal/New-AzPortalDashboard.md new file mode 100644 index 0000000000..1cbbeb1549 --- /dev/null +++ b/azps-10.1.0/Az.Portal/New-AzPortalDashboard.md @@ -0,0 +1,271 @@ +--- +external help file: +Module Name: Az.Portal +online version: https://learn.microsoft.com/powershell/module/az.portal/new-azportaldashboard +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Portal/help/New-AzPortalDashboard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Portal/help/New-AzPortalDashboard.md +--- + +# New-AzPortalDashboard + +## SYNOPSIS +Creates or updates a Dashboard. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPortalDashboard -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-Lens <Hashtable>] [-Metadata <Hashtable>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzPortalDashboard -Name <String> -ResourceGroupName <String> -Dashboard <IDashboard> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateByFile +``` +New-AzPortalDashboard -Name <String> -ResourceGroupName <String> -DashboardPath <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a Dashboard. + +## EXAMPLES + +### Example 1: Create a dashboard using a dashboard template file +```powershell +New-AzPortalDashboard -DashboardPath .\resources\dash1.json -ResourceGroupName mydash-rg -DashboardName my-dashboard03 +``` + +```output +Location Name Type +-------- ---- ---- +eastasia my-dashboard03 Microsoft.Portal/dashboards +``` + +Create a new dashboard using the provided dashboard template file. + +## PARAMETERS + +### -Dashboard +The shared dashboard resource definition. +To construct, see NOTES section for DASHBOARD properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Portal.Models.Api201901Preview.IDashboard +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DashboardPath +The Path to an existing dashboard template. +Dashboard templates may be downloaded from the portal. + +```yaml +Type: System.String +Parameter Sets: CreateByFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Lens +The dashboard lenses. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +The dashboard metadata. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the dashboard. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DashboardName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Portal.Models.Api201901Preview.IDashboard + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Portal.Models.Api201901Preview.IDashboard + +## 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. + + +DASHBOARD `<IDashboard>`: The shared dashboard resource definition. + - `Location <String>`: Resource location + - `[Lens <IDashboardPropertiesLenses>]`: The dashboard lenses. + - `[(Any) <IDashboardLens>]`: This indicates any property can be added to this object. + - `[Metadata <IDashboardPropertiesMetadata>]`: The dashboard metadata. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[Tag <IDashboardTags>]`: Resource tags + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Portal/Remove-AzPortalDashboard.md b/azps-10.1.0/Az.Portal/Remove-AzPortalDashboard.md new file mode 100644 index 0000000000..1b33ee2192 --- /dev/null +++ b/azps-10.1.0/Az.Portal/Remove-AzPortalDashboard.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.Portal +online version: https://learn.microsoft.com/powershell/module/az.portal/remove-azportaldashboard +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Portal/help/Remove-AzPortalDashboard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Portal/help/Remove-AzPortalDashboard.md +--- + +# Remove-AzPortalDashboard + +## SYNOPSIS +Deletes the Dashboard. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPortalDashboard -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPortalDashboard -InputObject <IPortalIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the Dashboard. + +## EXAMPLES + +### Example 1: Remove a Dashboard +```powershell +Remove-AzPortalDashboard -ResourceGroupName my-rg -DashboardName dashbase02 +``` + +Remove a Dashbaord using resource group name and dashboard name. + +### Example 2: Remove a Dashboard using the pipeline +```powershell +Get-AzPortalDashboard -ResourceGroupName my-rg -DashboardName dashbase02 | Remove-AzPortalDashboard +``` + +Remove the dashboard returned from a Get-AzDashboard call. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Portal.Models.IPortalIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the dashboard. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DashboardName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Portal.Models.IPortalIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPortalIdentity>`: Identity Parameter + - `[DashboardName <String>]`: The name of the dashboard. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Portal/Set-AzPortalDashboard.md b/azps-10.1.0/Az.Portal/Set-AzPortalDashboard.md new file mode 100644 index 0000000000..aebf6fe979 --- /dev/null +++ b/azps-10.1.0/Az.Portal/Set-AzPortalDashboard.md @@ -0,0 +1,163 @@ +--- +external help file: +Module Name: Az.Portal +online version: https://learn.microsoft.com/powershell/module/az.portal/set-azportaldashboard +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Portal/help/Set-AzPortalDashboard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Portal/help/Set-AzPortalDashboard.md +--- + +# Set-AzPortalDashboard + +## SYNOPSIS +Creates or updates a Dashboard. + +## SYNTAX + +``` +Set-AzPortalDashboard -Name <String> -ResourceGroupName <String> -DashboardPath <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a Dashboard. + +## EXAMPLES + +### Example 1: Update the dashboard definition using a dashboard template +```powershell +Set-AzPortalDashboard -DashboardPath .\resources\dash1-update.json -ResourceGroupName my-rg -DashboardName dashbase03 +``` + +```output +Location Name Type +-------- ---- ---- +eastasia dashbase03 Microsoft.Portal/dashboards +``` + +Update a dashboard definition using a dashbaord template file. + +## PARAMETERS + +### -DashboardPath +The Path to an existing dashboard template. +Dashboard templates may be downloaded from the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DashboardName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Portal.Models.Api201901Preview.IDashboard + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Portal/Update-AzPortalDashboard.md b/azps-10.1.0/Az.Portal/Update-AzPortalDashboard.md new file mode 100644 index 0000000000..1f35b87454 --- /dev/null +++ b/azps-10.1.0/Az.Portal/Update-AzPortalDashboard.md @@ -0,0 +1,246 @@ +--- +external help file: +Module Name: Az.Portal +online version: https://learn.microsoft.com/powershell/module/az.portal/update-azportaldashboard +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Portal/help/Update-AzPortalDashboard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Portal/help/Update-AzPortalDashboard.md +--- + +# Update-AzPortalDashboard + +## SYNOPSIS +Updates an existing Dashboard. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPortalDashboard -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Lens <Hashtable>] [-Metadata <Hashtable>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPortalDashboard -InputObject <IPortalIdentity> [-Lens <Hashtable>] [-Metadata <Hashtable>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing Dashboard. + +## EXAMPLES + +### Example 1: Update the Tags of a Dashboard +```powershell +Update-AzPortalDashboard -ResourceGroupName my-rg -Name dashbase03 -Tag @{'hidden-title'="My Dashboard Title"; NewTag="NewValue"} +``` + +```output +Location Name Type +-------- ---- ---- +eastasia dashbase03 Microsoft.Portal/dashboards +``` + +Update the tags in a dashboard. +Tags are represented as an inline hashtable. + +### Example 2: Update Dashboard tags using the pipeline +```powershell +Get-AzPortalDashboard -ResourceGroupName my-rg -Name dashbase03 | Update-AzPortalDashboard -Tag @{'hidden-title'="My Dashboard Title"; NewTag="NewValue"} +``` + +```output +Location Name Type +-------- ---- ---- +eastasia dashbase03 Microsoft.Portal/dashboards +``` + +Update the Tags in a Dashboard retried using Get-AzPortalDashboard. +This can be used to update the tags over a single dashboard, or multiple dashboardfs. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Portal.Models.IPortalIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Lens +The dashboard lenses. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +The dashboard metadata. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the dashboard. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: DashboardName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000) + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Portal.Models.IPortalIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Portal.Models.Api201901Preview.IDashboard + +## 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 `<IPortalIdentity>`: Identity Parameter + - `[DashboardName <String>]`: The name of the dashboard. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Az.PostgreSql.md b/azps-10.1.0/Az.PostgreSql/Az.PostgreSql.md new file mode 100644 index 0000000000..73880095b0 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Az.PostgreSql.md @@ -0,0 +1,138 @@ +--- +Module Name: Az.PostgreSql +Module Guid: b09b1b72-75a0-43a4-a342-b69a27eb64b5 +Download Help Link: https://learn.microsoft.com/powershell/module/az.postgresql +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Az.PostgreSql.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Az.PostgreSql.md +--- + +# Az.PostgreSql Module +## Description +Microsoft Azure PowerShell: PostgreSql cmdlets + +## Az.PostgreSql Cmdlets +### [Get-AzPostgreSqlConfiguration](Get-AzPostgreSqlConfiguration.md) +Gets information about a configuration of server. + +### [Get-AzPostgreSqlConnectionString](Get-AzPostgreSqlConnectionString.md) +Get the connection string according to client connection provider. + +### [Get-AzPostgreSqlFirewallRule](Get-AzPostgreSqlFirewallRule.md) +Gets information about a server firewall rule. + +### [Get-AzPostgreSqlFlexibleServer](Get-AzPostgreSqlFlexibleServer.md) +Gets information about a server. + +### [Get-AzPostgreSqlFlexibleServerConfiguration](Get-AzPostgreSqlFlexibleServerConfiguration.md) +Gets information about a configuration of server. + +### [Get-AzPostgreSqlFlexibleServerConnectionString](Get-AzPostgreSqlFlexibleServerConnectionString.md) +Get the connection string according to client connection provider. + +### [Get-AzPostgreSqlFlexibleServerDatabase](Get-AzPostgreSqlFlexibleServerDatabase.md) +Gets information about a database. + +### [Get-AzPostgreSqlFlexibleServerFirewallRule](Get-AzPostgreSqlFlexibleServerFirewallRule.md) +List all the firewall rules in a given server. + +### [Get-AzPostgreSqlFlexibleServerLocationBasedCapability](Get-AzPostgreSqlFlexibleServerLocationBasedCapability.md) +Get the available SKU information for the location + +### [Get-AzPostgreSqlReplica](Get-AzPostgreSqlReplica.md) +List all the replicas for a given server. + +### [Get-AzPostgreSqlServer](Get-AzPostgreSqlServer.md) +Gets information about a server. + +### [Get-AzPostgreSqlVirtualNetworkRule](Get-AzPostgreSqlVirtualNetworkRule.md) +Gets a virtual network rule. + +### [New-AzPostgreSqlFirewallRule](New-AzPostgreSqlFirewallRule.md) +Creates a new firewall rule or updates an existing firewall rule. + +### [New-AzPostgreSqlFlexibleServer](New-AzPostgreSqlFlexibleServer.md) +Creates a new server. + +### [New-AzPostgreSqlFlexibleServerDatabase](New-AzPostgreSqlFlexibleServerDatabase.md) +Creates a new database or updates an existing database. + +### [New-AzPostgreSqlFlexibleServerFirewallRule](New-AzPostgreSqlFlexibleServerFirewallRule.md) +Creates a new firewall rule or updates an existing firewall rule. + +### [New-AzPostgreSqlReplica](New-AzPostgreSqlReplica.md) +Creates a new replica from an existing database. + +### [New-AzPostgreSqlServer](New-AzPostgreSqlServer.md) +Creates a new server. + +### [New-AzPostgreSqlVirtualNetworkRule](New-AzPostgreSqlVirtualNetworkRule.md) +Creates or updates an existing virtual network rule. + +### [Remove-AzPostgreSqlFirewallRule](Remove-AzPostgreSqlFirewallRule.md) +Deletes a server firewall rule. + +### [Remove-AzPostgreSqlFlexibleServer](Remove-AzPostgreSqlFlexibleServer.md) +Deletes a server. + +### [Remove-AzPostgreSqlFlexibleServerDatabase](Remove-AzPostgreSqlFlexibleServerDatabase.md) +Deletes a database. + +### [Remove-AzPostgreSqlFlexibleServerFirewallRule](Remove-AzPostgreSqlFlexibleServerFirewallRule.md) +Deletes a PostgreSQL server firewall rule. + +### [Remove-AzPostgreSqlServer](Remove-AzPostgreSqlServer.md) +Deletes a server. + +### [Remove-AzPostgreSqlVirtualNetworkRule](Remove-AzPostgreSqlVirtualNetworkRule.md) +Deletes the virtual network rule with the given name. + +### [Restart-AzPostgreSqlFlexibleServer](Restart-AzPostgreSqlFlexibleServer.md) +Restarts a server. + +### [Restart-AzPostgreSqlServer](Restart-AzPostgreSqlServer.md) +Restarts a server. + +### [Restore-AzPostgreSqlFlexibleServer](Restore-AzPostgreSqlFlexibleServer.md) +Restore a server from an existing backup + +### [Restore-AzPostgreSqlServer](Restore-AzPostgreSqlServer.md) +Restore a server from an existing backup + +### [Start-AzPostgreSqlFlexibleServer](Start-AzPostgreSqlFlexibleServer.md) +Starts a server. + +### [Stop-AzPostgreSqlFlexibleServer](Stop-AzPostgreSqlFlexibleServer.md) +Stops a server. + +### [Test-AzPostgreSqlFlexibleServerConnect](Test-AzPostgreSqlFlexibleServerConnect.md) +Test out the connection to the database server + +### [Update-AzPostgreSqlConfiguration](Update-AzPostgreSqlConfiguration.md) +Updates a configuration of a server. +Use Update-AzPostgreSqlServer instead if you want update AdministratorLoginPassword, sku, etc. + +### [Update-AzPostgreSqlFirewallRule](Update-AzPostgreSqlFirewallRule.md) +Creates a new firewall rule or updates an existing firewall rule. + +### [Update-AzPostgreSqlFlexibleServer](Update-AzPostgreSqlFlexibleServer.md) +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzPostSqlFlexibleServerConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +### [Update-AzPostgreSqlFlexibleServerConfiguration](Update-AzPostgreSqlFlexibleServerConfiguration.md) +Updates a configuration of a server. +Use Update-AzPostgreSqlFlexibleServer instead if you want update AdministratorLoginPassword, sku, etc. + +### [Update-AzPostgreSqlFlexibleServerFirewallRule](Update-AzPostgreSqlFlexibleServerFirewallRule.md) +Creates a new firewall rule or updates an existing firewall rule. + +### [Update-AzPostgreSqlServer](Update-AzPostgreSqlServer.md) +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzPostSqlConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +### [Update-AzPostgreSqlVirtualNetworkRule](Update-AzPostgreSqlVirtualNetworkRule.md) +Creates or updates an existing virtual network rule. + diff --git a/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlConfiguration.md b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlConfiguration.md new file mode 100644 index 0000000000..9733da5170 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlConfiguration.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/get-azpostgresqlconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlConfiguration.md +--- + +# Get-AzPostgreSqlConfiguration + +## SYNOPSIS +Gets information about a configuration of server. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlConfiguration -ResourceGroupName <String> -ServerName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPostgreSqlConfiguration -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlConfiguration -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a configuration of server. + +## EXAMPLES + +### Example 1: List all configurations in PostgreSql server +```powershell +Get-AzPostgreSqlConfiguration -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer +``` + +```output +Name Value +---- ----- +array_nulls on +backslash_quote safe_encoding +bytea_output hex +check_function_bodies on +client_encoding sql_ascii +... +azure.replication_support REPLICA +max_wal_senders 10 +max_replication_slots 10 +hot_standby_feedback off +logging_collector on +``` + +This cmdlet lists all configurations in specified PostgreSql server. + +### Example 2: Get specified PostgreSql configuration by name +```powershell +Get-AzPostgreSqlConfiguration -Name timezone -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer +``` + +```output +Name Value +---- ----- +timezone UTC +``` + +This cmdlet gets specified PostgreSql configuration by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server configuration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IConfiguration + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlConnectionString.md b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlConnectionString.md new file mode 100644 index 0000000000..de0f007fc9 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlConnectionString.md @@ -0,0 +1,197 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/get-azpostgresqlconnectionstring +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlConnectionString.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlConnectionString.md +--- + +# Get-AzPostgreSqlConnectionString + +## SYNOPSIS +Get the connection string according to client connection provider. + +## SYNTAX + +### Get (Default) +``` +Get-AzPostgreSqlConnectionString -Client <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlConnectionString -Client <String> -InputObject <IServer> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the connection string according to client connection provider. + +## EXAMPLES + +### Example 1: Get PostgreSql server connection string by resource group and server name +```powershell +Get-AzPostgreSqlConnectionString -Client ADO.NET -Name PostgreSqlTestServer -ResourceGroupName PostgreSqlTestRG +``` + +```output +Server=postgresqltestserver.postgres.database.azure.com;Database={your_database};Port=5432;User Id=pwsh@postgresqltestserver;Password={your_password};Ssl Mode=Require; +``` + +This cmdlet gets PostgreSql server connection string by resource group and server name. + +### Example 2: Get PostgreSql server connection string by identity +```powershell +Get-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer | Get-AzPostgreSqlConnectionString -Client PHP +``` + +```output +host=postgresqltestserver.postgres.database.azure.com port=5432 dbname={your_database} user=pwsh@postgresqltestserver password={your_password} sslmode=require +``` + +This cmdlet gets PostgreSql server connection string by identity. + +## PARAMETERS + +### -Client +Client connection provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The server for the connection string +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IServer +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IServer + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IServer>`: The server for the connection string + - `Location <String>`: The geo-location where the resource lives + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdministratorLogin <String>]`: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). + - `[EarliestRestoreDate <DateTime?>]`: Earliest restore point creation time (ISO8601 format) + - `[FullyQualifiedDomainName <String>]`: The fully qualified domain name of a server. + - `[IdentityType <IdentityType?>]`: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + - `[InfrastructureEncryption <InfrastructureEncryption?>]`: Status showing whether the server enabled infrastructure encryption. + - `[MasterServerId <String>]`: The master server id of a replica server. + - `[MinimalTlsVersion <MinimalTlsVersionEnum?>]`: Enforce a minimal Tls version for the server. + - `[PublicNetworkAccess <PublicNetworkAccessEnum?>]`: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' + - `[ReplicaCapacity <Int32?>]`: The maximum number of replicas that a master server can have. + - `[ReplicationRole <String>]`: The replication role of the server. + - `[SkuCapacity <Int32?>]`: The scale up/out capacity, representing server's compute units. + - `[SkuFamily <String>]`: The family of hardware. + - `[SkuName <String>]`: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. + - `[SkuSize <String>]`: The size code, to be interpreted by resource as appropriate. + - `[SkuTier <SkuTier?>]`: The tier of the particular SKU, e.g. Basic. + - `[SslEnforcement <SslEnforcementEnum?>]`: Enable ssl enforcement or not when connect to server. + - `[StorageProfileBackupRetentionDay <Int32?>]`: Backup retention days for the server. + - `[StorageProfileGeoRedundantBackup <GeoRedundantBackup?>]`: Enable Geo-redundant or not for server backup. + - `[StorageProfileStorageAutogrow <StorageAutogrow?>]`: Enable Storage Auto Grow. + - `[StorageProfileStorageMb <Int32?>]`: Max storage allowed for a server. + - `[UserVisibleState <ServerState?>]`: A state of a server that is visible to user. + - `[Version <ServerVersion?>]`: Server version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFirewallRule.md b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFirewallRule.md new file mode 100644 index 0000000000..8afeb9510f --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFirewallRule.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/get-azpostgresqlfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFirewallRule.md +--- + +# Get-AzPostgreSqlFirewallRule + +## SYNOPSIS +Gets information about a server firewall rule. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFirewallRule -ResourceGroupName <String> -ServerName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPostgreSqlFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFirewallRule -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a server firewall rule. + +## EXAMPLES + +### Example 1: Lists all the Firewall Rules in specified PostgreSql server +```powershell +Get-AzPostgreSqlFirewallRule -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.0 0.0.0.1 +``` + +This cmdlet lists all the Firewall Rule in specified PostgreSql server. + +### Example 2: Get Firewall Rule by name +```powershell +Get-AzPostgreSqlFirewallRule -Name rule -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.0 0.0.0.1 +``` + +This cmdlet gets Firewall Rule by name. + +### Example 3: Get Firewall Rule by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.DBforPostgreSQL/servers/PostgreSqlTestServer/firewallRules/rule" +Get-AzPostgreSqlFirewallRule -InputObject $ID +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.0 0.0.0.1 +``` + +This cmdlet gets Firewall Rule by identity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IFirewallRule + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServer.md b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServer.md new file mode 100644 index 0000000000..d044a6f78b --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/get-azpostgresqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFlexibleServer.md +--- + +# Get-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Gets information about a server. + +## SYNTAX + +### List1 (Default) +``` +Get-AzPostgreSqlFlexibleServer [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServer -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzPostgreSqlFlexibleServer -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a server. + +## EXAMPLES + +### Example 1: Get PostgreSql servers in the subscription +```powershell +Get-AzPostgreSqlFlexibleServer +``` + +```output +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128 +postgresql-test-2 East US Standard_D2s_v3 GeneralPurpose daeunyim 128 +postgresql-test-3 East US Standard_D2s_v3 GeneralPurpose daeunyim 128 + +``` + +This cmdlet gets PostgreSql servers with default context. + +### Example 2: Get PostgreSql server by resource group and server name +```powershell +Get-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test +``` + +```output +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128 +``` + +This cmdlet gets PostgreSql servers by resource group and server name. + +### Example 3: Lists all the PostgreSql servers in specified resource group +```powershell +Get-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest +``` + +```output +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128 +postgresql-test-2 East US Standard_D2s_v3 GeneralPurpose daeunyim 128 +``` + +This cmdlet lists all the PostgreSql servers in the specified resource group. + +### Example 4: Get PostgreSql server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresql-test" +Get-AzPostgreSqlFlexibleServer -InputObject $ID +``` + +```output +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128 +``` + +This cmdlet lists gets PostgreSql servers by identity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IServerAutoGenerated + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerConfiguration.md b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerConfiguration.md new file mode 100644 index 0000000000..2c2fc0171b --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerConfiguration.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/get-azpostgresqlflexibleserverconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFlexibleServerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFlexibleServerConfiguration.md +--- + +# Get-AzPostgreSqlFlexibleServerConfiguration + +## SYNOPSIS +Gets information about a configuration of server. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerConfiguration -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerConfiguration -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerConfiguration -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a configuration of server. + +## EXAMPLES + +### Example 1: Get specified PostgreSql configuration by name +```powershell +Get-AzPostgreSqlFlexibleServerConfiguration -Name work_mem -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test +``` + +```output +Name Value AllowedValue Source DefaultValue +---- ----- ------------ ------ ------------ +work_mem 4096 4096-2097151 system-default 4096 +``` + +This cmdlet gets specified PostgreSql configuration by name. + +### Example 2: List all configurations in specified PostgreSql server +```powershell +Get-AzPostgreSqlFlexibleServerConfiguration -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test +``` + +```output +Name Value AllowedValue +---- ----- ------------ +application_name [A-Za-z0-9._-]* +array_nulls on on,off +autovacuum on on,off +autovacuum_analyze_scale_factor 0.1 0-100 +... +work_mem 4096 4096-2097151 +xmlbinary base64 base64,hex +xmloption content content,document +intelligent_tuning off on,off +require_secure_transport on on,off +pgbouncer.enabled false true, false +``` + +This cmdlet lists all configurations in specified PostgreSql server. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server configuration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IConfigurationAutoGenerated + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerConnectionString.md b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerConnectionString.md new file mode 100644 index 0000000000..13f9b32426 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerConnectionString.md @@ -0,0 +1,204 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/get-azpostgresqlflexibleserverconnectionstring +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFlexibleServerConnectionString.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFlexibleServerConnectionString.md +--- + +# Get-AzPostgreSqlFlexibleServerConnectionString + +## SYNOPSIS +Get the connection string according to client connection provider. + +## SYNTAX + +### Get (Default) +``` +Get-AzPostgreSqlFlexibleServerConnectionString -Client <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerConnectionString -Client <String> -InputObject <IServerAutoGenerated> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the connection string according to client connection provider. + +## EXAMPLES + +### Example 1: Get connection string by name +```powershell +Get-AzPostgreSqlFlexibleServerConnectionString -Client ADO.NET -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test +``` + +```output +Server=postgresql-test.postgres.database.azure.com;Database={your_database};Port=5432;User Id=adminuser;Password={your_password}; +``` + +This cmdlet shows connection string of a client by server name. + +### Example 2: Get PostgreSql server connection string by identity +```powershell +Get-AzPostgreSqlFlexibleServer -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer | Get-AzPostgreSqlFlexibleServerConnectionString -Client PHP +``` + +```output +host=postgresqltestserver.postgres.database.azure.com port=5432 dbname={your_database} user=pwsh password={your_password} sslmode=require +``` + +This cmdlet gets PostgreSql server connection string by identity. + +## PARAMETERS + +### -Client +Client connection provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The server for the connection string +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IServerAutoGenerated +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IServerAutoGenerated + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IServerAutoGenerated>`: The server for the connection string + - `Location <String>`: The geo-location where the resource lives + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdministratorLogin <String>]`: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). + - `[AdministratorLoginPassword <SecureString>]`: The administrator login password (required for server creation). + - `[AvailabilityZone <String>]`: availability zone information of the server. + - `[BackupGeoRedundantBackup <GeoRedundantBackupEnum?>]`: A value indicating whether Geo-Redundant backup is enabled on the server. + - `[BackupRetentionDay <Int32?>]`: Backup retention days for the server. + - `[CreateMode <CreateMode?>]`: The mode to create a new PostgreSQL server. + - `[HighAvailabilityMode <HighAvailabilityMode?>]`: The HA mode for the server. + - `[HighAvailabilityStandbyAvailabilityZone <String>]`: availability zone information of the standby. + - `[IdentityType <ResourceIdentityType?>]`: The identity type. + - `[MaintenanceWindowCustomWindow <String>]`: indicates whether custom window is enabled or disabled + - `[MaintenanceWindowDayOfWeek <Int32?>]`: day of week for maintenance window + - `[MaintenanceWindowStartHour <Int32?>]`: start hour for maintenance window + - `[MaintenanceWindowStartMinute <Int32?>]`: start minute for maintenance window + - `[NetworkDelegatedSubnetResourceId <String>]`: delegated subnet arm resource id. + - `[NetworkPrivateDnsZoneArmResourceId <String>]`: private dns zone arm resource id. + - `[PointInTimeUtc <DateTime?>]`: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'. + - `[PropertiesTag <IServerPropertiesTags>]`: Application-specific metadata in the form of key-value pairs. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[SkuName <String>]`: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. + - `[SkuTier <SkuTier?>]`: The tier of the particular SKU, e.g. Burstable. + - `[SourceServerResourceId <String>]`: The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'. + - `[StorageSizeGb <Int32?>]`: Max storage allowed for a server. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Version <ServerVersion?>]`: PostgreSQL Server version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerDatabase.md b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 0000000000..e29213a853 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,209 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/get-azpostgresqlflexibleserverdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFlexibleServerDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFlexibleServerDatabase.md +--- + +# Get-AzPostgreSqlFlexibleServerDatabase + +## SYNOPSIS +Gets information about a database. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerDatabase -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerDatabase -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerDatabase -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a database. + +## EXAMPLES + +### Example 1: Get databases of a PostgreSql server +```powershell +Get-AzPostgreSqlFlexibleServerDatabase -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test +``` + +```output +Name Charset Collation +---- ------- --------- +azure_maintenance UTF8 en_US.utf8 +postgres UTF8 en_US.utf8 +azure_sys UTF8 en_US.utf8 +flexibleserverdb UTF8 en_US.utf8 +``` + +Get databases of a flexible server + +### Example 2: Get a database of a PostgreSql server +```powershell +Get-AzPostgreSqlFlexibleServerDatabase -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test -Name flexibleserverdb +``` + +```output +Name Charset Collation +---- ------- --------- +flexibleserverdb UTF8 en_US.utf8 +``` + +Get a database of a flexible server by name + +### Example 3: Get a database of a PostgreSql server +```powershell +Get-AzPostgreSqlFlexibleServerDatabase -InputObject /subscriptions/0000000000-0000-0000-0000-000000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresql-test/databases/flexibleserverdb +``` + +```output +Name Charset Collation +---- ------- --------- +flexibleserverdb UTF8 en_US.utf8 +``` + +Get a database of a flexible server by resource Id + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the database. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DatabaseName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IDatabaseAutoGenerated + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerFirewallRule.md b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 0000000000..52f117f760 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/get-azpostgresqlflexibleserverfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFlexibleServerFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFlexibleServerFirewallRule.md +--- + +# Get-AzPostgreSqlFlexibleServerFirewallRule + +## SYNOPSIS +List all the firewall rules in a given server. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerFirewallRule -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerFirewallRule -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +List all the firewall rules in a given server. + +## EXAMPLES + +### Example 1: Get firewall rules by name +```powershell +Get-AzPostgreSqlFlexibleServerFirewallRule -Name firewallrule-test -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test +``` + +```output +FirewallRuleName StartIPAddress EndIPAddress +----------------- --------------- --------------- +firewallrule-test 12.12.12.12 23.23.23.23 +``` + +This cmdlet gets firewall rules by name. + +### Example 2: Get firewall rules by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.DBforPostgreSQL/servers/postgresql-test/firewallRules/firewallrule-test" +Get-AzPostgreSqlFlexibleServerFirewallRule -InputObject $ID +``` + +```output +FirewallRuleName StartIPAddress EndIPAddress +----------------- --------------- --------------- +firewallrule-test 12.12.12.12 23.23.23.23 +``` + +This cmdlet gets firewall rules by identity. + +### Example 3: Lists all the firewall rules in the specified PostgreSql server +```powershell +Get-AzPostgreSqlFlexibleServerFirewallRule -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test +``` + +```output +FirewallRuleName StartIPAddress EndIPAddress +----------------- --------------- --------------- +firewallrule-test 12.12.12.12 23.23.23.23 +firewallrule-test2 12.12.12.15 23.23.23.25 +``` + +This cmdlet lists all the firewall rule in specified PostgreSql server. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IFirewallRuleAutoGenerated + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerLocationBasedCapability.md b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerLocationBasedCapability.md new file mode 100644 index 0000000000..44fe72ab3b --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlFlexibleServerLocationBasedCapability.md @@ -0,0 +1,130 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/get-azpostgresqlflexibleserverlocationbasedcapability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFlexibleServerLocationBasedCapability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlFlexibleServerLocationBasedCapability.md +--- + +# Get-AzPostgreSqlFlexibleServerLocationBasedCapability + +## SYNOPSIS +Get the available SKU information for the location + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerLocationBasedCapability -Location <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the available SKU information for the location + +## EXAMPLES + +### Example 1: Get location capabilities by location name +```powershell +Get-AzPostgreSqlFlexibleServerLocationBasedCapability -Location eastus +``` + +```output +SKU Memory vCore Tier +--- ------ ----- ---- +Standard_B1ms 2048 1 Burstable +Standard_B2s 2048 2 Burstable +Standard_D2s_v3 4096 2 GeneralPurpose +Standard_D4s_v3 4096 4 GeneralPurpose +Standard_D8s_v3 4096 8 GeneralPurpose +Standard_D16s_v3 4096 16 GeneralPurpose +Standard_D32s_v3 4096 32 GeneralPurpose +Standard_D48s_v3 4096 48 GeneralPurpose +Standard_D64s_v3 4096 64 GeneralPurpose +Standard_D2ds_v4 4096 2 GeneralPurpose +Standard_D4ds_v4 4096 4 GeneralPurpose +Standard_D8ds_v4 4096 8 GeneralPurpose +Standard_D16ds_v4 4096 16 GeneralPurpose +Standard_D32ds_v4 4096 32 GeneralPurpose +Standard_D48ds_v4 4096 48 GeneralPurpose +Standard_D64ds_v4 4096 64 GeneralPurpose +Standard_E2s_v3 8192 2 MemoryOptimized +Standard_E4s_v3 8192 4 MemoryOptimized +Standard_E8s_v3 8192 8 MemoryOptimized +Standard_E16s_v3 8192 16 MemoryOptimized +Standard_E32s_v3 8192 32 MemoryOptimized +Standard_E48s_v3 8192 48 MemoryOptimized +Standard_E64s_v3 6912 64 MemoryOptimized +Standard_E2ds_v4 8192 2 MemoryOptimized +Standard_E4ds_v4 8192 4 MemoryOptimized +Standard_E8ds_v4 8192 8 MemoryOptimized +Standard_E16ds_v4 8192 16 MemoryOptimized +Standard_E20ds_v4 8192 20 MemoryOptimized +Standard_E32ds_v4 8192 32 MemoryOptimized +Standard_E48ds_v4 8192 48 MemoryOptimized +Standard_E64ds_v4 6912 64 MemoryOptimized +``` +This cmdlet shows basic sku information of the provided location. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The name of the location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.ICapabilityProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlReplica.md b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlReplica.md new file mode 100644 index 0000000000..fd9b782f19 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlReplica.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/get-azpostgresqlreplica +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlReplica.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlReplica.md +--- + +# Get-AzPostgreSqlReplica + +## SYNOPSIS +List all the replicas for a given server. + +## SYNTAX + +``` +Get-AzPostgreSqlReplica -ResourceGroupName <String> -ServerName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List all the replicas for a given server. + +## EXAMPLES + +### Example 1: Get PostgreSql server replica by resource group and server name +```powershell +Get-AzPostgreSqlReplica -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +postgresqltestserverreplica eastus pwsh 9.6 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This cmdlet gets PostgreSql server replica by resource group and server name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IServer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlServer.md b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlServer.md new file mode 100644 index 0000000000..991fbb2936 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlServer.md @@ -0,0 +1,209 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/get-azpostgresqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlServer.md +--- + +# Get-AzPostgreSqlServer + +## SYNOPSIS +Gets information about a server. + +## SYNTAX + +### List1 (Default) +``` +Get-AzPostgreSqlServer [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPostgreSqlServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlServer -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzPostgreSqlServer -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a server. + +## EXAMPLES + +### Example 1: Get PostgreSql server with default context +```powershell +Get-AzPostgreSqlServer +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +postgresqltestserver eastus pwsh 9.6 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This cmdlet gets PostgreSql server with default context. + +### Example 2: Get PostgreSql server by resource group and server name +```powershell +Get-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG -Name PostgreSqlTestServer +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +postgresqltestserver eastus pwsh 9.6 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This cmdlet gets PostgreSql server by resource group and server name. + +### Example 3: Lists all the PostgreSql servers in specified resource group +```powershell +Get-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +postgresqltestserver eastus pwsh 9.6 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This cmdlet lists all the PostgreSql servers in specified resource group. + +### Example 4: Get PostgreSql server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.DBforPostgreSQL/servers/postgresqltestserver" +Get-AzPostgreSqlServer -InputObject $ID +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +postgresqltestserver eastus pwsh 9.6 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This cmdlet lists gets PostgreSql server by identity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IServer + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlVirtualNetworkRule.md b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlVirtualNetworkRule.md new file mode 100644 index 0000000000..08a8512e0e --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Get-AzPostgreSqlVirtualNetworkRule.md @@ -0,0 +1,222 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/get-azpostgresqlvirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Get-AzPostgreSqlVirtualNetworkRule.md +--- + +# Get-AzPostgreSqlVirtualNetworkRule + +## SYNOPSIS +Gets a virtual network rule. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlVirtualNetworkRule -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### Get +``` +Get-AzPostgreSqlVirtualNetworkRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlVirtualNetworkRule -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a virtual network rule. + +## EXAMPLES + +### Example 1: Lists all the Virtual Network Rules in specified PostgreSql server +```powershell +Get-AzPostgreSqlVirtualNetworkRule -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer +``` + +```output +Name Type +---- ---- +vnet Microsoft.DBforPostgreSQL/servers/virtualNetworkRules +``` + +This cmdlet lists all the Virtual Network Rules in specified PostgreSql server. + +### Example 2: Get Virtual Network Rule by name +```powershell +Get-AzPostgreSqlVirtualNetworkRule -Name vnet -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer +``` + +```output +Name Type +---- ---- +vnet Microsoft.DBforPostgreSQL/servers/virtualNetworkRules +``` + +This cmdlet gets Virtual Network Rule by name. + +### Example 3: Get Virtual Network Rule by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.DBforPostgreSQL/servers/PostgreSqlTestServer/virtualNetworkRules/vnet" +Get-AzPostgreSqlVirtualNetworkRule -InputObject $ID +``` + +```output +Name Type +---- ---- +vnet Microsoft.DBforPostgreSQL/servers/virtualNetworkRules +``` + +This cmdlet gets Virtual Network Rule by identity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: VirtualNetworkRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IVirtualNetworkRule + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlFirewallRule.md b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlFirewallRule.md new file mode 100644 index 0000000000..e27683ba21 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlFirewallRule.md @@ -0,0 +1,298 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/new-azpostgresqlfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlFirewallRule.md +--- + +# New-AzPostgreSqlFirewallRule + +## SYNOPSIS +Creates a new firewall rule or updates an existing firewall rule. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFirewallRule -ResourceGroupName <String> -ServerName <String> -EndIPAddress <String> + -StartIPAddress <String> [-Name <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### AllowAll +``` +New-AzPostgreSqlFirewallRule -ResourceGroupName <String> -ServerName <String> -AllowAll [-Name <String>] + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### ClientIPAddress +``` +New-AzPostgreSqlFirewallRule -ResourceGroupName <String> -ServerName <String> -ClientIPAddress <String> + [-Name <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new firewall rule or updates an existing firewall rule. + +## EXAMPLES + +### Example 1: Create a new PostgreSql server Firewall Rule +```powershell +New-AzPostgreSqlFirewallRule -Name rule -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer -EndIPAddress 0.0.0.1 -StartIPAddress 0.0.0.0 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.0 0.0.0.1 +``` + +This cmdlets create a PostgreSql server Firewall Rule. + +### Example 2: Create a new PostgreSql Firewall Rule using -ClientIPAddress. +```powershell +New-AzPostgreSqlFirewallRule -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer -ClientIPAddress 0.0.0.1 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +ClientIPAddress_2020-08-11_18-19-27 0.0.0.1 0.0.0.1 +``` + +This cmdlets create a PostgreSql Firewall Rule using -ClientIPAddress. + +### Example 3: Create a new PostgreSql Firewall Rule to allow all IPs +```powershell +New-AzPostgreSqlFirewallRule -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer -AllowAll +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +AllowAll_2020-08-11_18-19-27 0.0.0.0 255.255.255.255 +``` + +This cmdlets create a new PostgreSql Firewall Rule to allow all IPs. + +## PARAMETERS + +### -AllowAll +Present to allow all range IPs, from 0.0.0.0 to 255.255.255.255. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AllowAll +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientIPAddress +Client specified single IP of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIPAddress +The end IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FirewallRuleName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +The start IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IFirewallRule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlFlexibleServer.md b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlFlexibleServer.md new file mode 100644 index 0000000000..ddaf5550f0 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,606 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/new-azpostgresqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlFlexibleServer.md +--- + +# New-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Creates a new server. + +## SYNTAX + +``` +New-AzPostgreSqlFlexibleServer [-Name <String>] [-ResourceGroupName <String>] [-SubscriptionId <String>] + [-AdministratorLoginPassword <SecureString>] [-AdministratorUserName <String>] [-BackupRetentionDay <Int32>] + [-HaEnabled <String>] [-Location <String>] [-PrivateDnsZone <String>] [-PublicAccess <String>] + [-Sku <String>] [-SkuTier <String>] [-StorageInMb <Int32>] [-Subnet <String>] [-SubnetPrefix <String>] + [-Tag <Hashtable>] [-Version <ServerVersion>] [-Vnet <String>] [-VnetPrefix <String>] [-Zone <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new server. + +## EXAMPLES + +### Example 1: Create a new PostgreSql flexible server with arguments +```powershell +New-AzPostgreSqlFlexibleServer -Name postgresql-test -ResourceGroupName PowershellPostgreSqlTest ` +-Location eastus -AdministratorUserName postgresqltest -AdministratorLoginPassword $password -Sku Standard_D2s_v3 -SkuTier GeneralPurpose -Version 12 -StorageInMb 131072 -PublicAccess none +``` + +```output +Checking the existence of the resource group PowershellPostgreSqlTest ... +Resource group PowershellPostgreSqlTest exists ? : True +Creating PostgreSQL server postgresql-test in group PostgreSqlTest... +Your server postgresql-test is using sku Standard_D2s_v3 (Paid Tier). +Please refer to https://aka.ms/postgresql-pricing for pricing details + +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128 + +``` + +### Example 2: Create a new PostgreSql flexible server with default setting +```powershell +$server = New-AzPostgreSqlFlexibleServer +``` + +```output +Creating resource group group00000000... +Creating PostgreSQL server server00000000 in group group00000000... +Your server postgresql-test is using sku Standard_D2s_v3 (Paid Tier). +Please refer to https://aka.ms/postgresql-pricing for pricing details + +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128 +``` +This cmdlet creates PostgreSql flexible server with default parameter values and provision the server with public access enabled. +The default values of location is East US 2, Sku is Standard_D2s_v3, Sku tier is GeneralPurpose, and storage size is 128GiB. + + +If you want to find the auto-generated password for your server, use ConvertFrom-SecureString to convert 'SecuredPassword' property to plain text. +(E.g., $server.SecuredPassword | ConvertFrom-SecureString -AsPlainText) + +### Example 3: Create a new PostgreSql flexible server with existing Subnet +```powershell +$Subnet = '/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnetname' +$DnsZone = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/postgresqltest/providers/Microsoft.Network/privateDnsZones/testserver.private.postgres.database.azure.com' +New-AzPostgreSqlFlexibleServer -ResourceGroupName postgresqltest -ServerName testserver -Subnet $Subnet -PrivateDnsZone $DnsZone +``` + +```output +Resource group PowershellPostgreSqlTest exists ? : True +You have supplied a subnet Id. +Verifying its existence... +Creating PostgreSQL server testserver in group PowershellPostgreSqlTest... +Your server server00000000 is using sku Standard_D2s_v3 (Paid Tier). +Please refer to https://aka.ms/postgresql-pricing for pricing details +Creating database flexibleserverdb... + +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128 + +``` +This cmdlet creates PostgreSql flexible server with an existing Subnet Id provided by a user. +The subnet will be delegated to PostgreSQL flexible server if not already delegated. +You cannot use a subnet delegated to different services. +the subnet can be in a different resource group. + +### Example 4: Create a new PostgreSql flexible server with virtual network and subnet name +```powershell +New-AzPostgreSqlFlexibleServer -Name postgresql-test -ResourceGroupName PowershellPostgreSqlTest -Vnet postgresql-vnet -Subnet postgresql-subnet -VnetPrefix 10.0.0.0/16 -SubnetPrefix 10.0.0.0/24 -PrivateDnsZone /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.Network/privateDnsZones/postgresql-test.private.postgres.database.azure.com +``` + +```output +Resource group PowershellPostgreSqlTest exists ? : True +Creating new vnet postgresql-vnet in resource group PowershellPostgreSqlTest +Creating new subnet postgresql-subnet in resource group PowershellPostgreSqlTest and delegating it to Microsoft.DBforPostgreSQL/flexibleServers +Creating PostgreSQL server postgresql-test in group PowershellPostgreSqlTest... +Your server postgresql-test is using sku Standard_D2s_v3 (Paid Tier). +Please refer to https://aka.ms/postgresql-pricing for pricing details +Creating database flexibleserverdb... + +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128 + +``` +This cmdlet creates PostgreSql flexible server with vnet name, subnet name, vnet prefix, and subnet prefix. +If the virtual network and subnet don't exist, the cmdlet creates one. + +### Example 5: Create a new PostgreSql flexible server with virtual network +```powershell +$Vnet = 'vnetname' +New-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Vnet $Vnet -PrivateDnsZone /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.Network/privateDnsZones/testserver.private.postgres.database.azure.com + +# or + +$Vnet = '/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.Network/virtualNetworks/vnetname' +New-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Vnet $Vnet -PrivateDnsZone /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.Network/privateDnsZones/testserver.private.postgres.database.azure.com +``` + +```output +Resource group PowershellPostgreSqlTest exists ? : True +You have supplied a vnet Id/name. +Verifying its existence... +Creating new vnet vnetname in resource group PowershellPostgreSqlTest +Creating new subnet Subnetserver00000000 in resource group PowershellPostgreSqlTest and delegating it to Microsoft.DBforPostgreSQL/flexibleServers +Creating PostgreSQL server server00000000 in group PowershellPostgreSqlTest... +Your server server00000000 is using sku Standard_D2s_v3 (Paid Tier). +Please refer to https://aka.ms/postgresql-pricing for pricing details +Creating database flexibleserverdb... + +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128 +``` +This cmdlet creates PostgreSql flexible server with vnet id or vnet name provided by a user. +If the virtual network doesn't exist, the cmdlet creates one. + +### Example 6: Create a new PostgreSql flexible server with public access to all IPs +```powershell +New-AzPostgreSqlFlexibleServer -Name postgresql-test -ResourceGroupName PowershellPostgreSqlTest -PublicAccess All +``` + +```output +Resource group PowershellPostgreSqlTest exists ? : True +Creating PostgreSQL server postgresql-test in group PowershellPostgreSqlTest... +Your server postgresql-test is using sku Standard_D2s_v3 (Paid Tier). +Please refer to https://aka.ms/postgresql-pricing for pricing details +Creating database flexibleserverdb... +Configuring server firewall rule to accept connections from 0.0.0.0 to 255.255.255.255 + +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128 +``` +This cmdlet creates PostgreSql flexible server open to all IP addresses. + +### Example 7: Create a new PostgreSql flexible server with firewall +```powershell +New-AzPostgreSqlFlexibleServer -Name postgresql-test -ResourceGroupName PowershellPostgreSqlTest -PublicAccess 10.10.10.10-10.10.10.12 +``` + +```output +Resource group PowershellPostgreSqlTest exists ? : True +Creating PostgreSQL server postgresql-test in group PowershellPostgreSqlTest... +Your server postgresql-test is using sku Standard_D2s_v3 (Paid Tier). +Please refer to https://aka.ms/postgresql-pricing for pricing details +Creating database flexibleserverdb... +Configuring server firewall rule to accept connections from 10.10.10.10 to 10.10.10.12 + +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 128 + +``` +This cmdlet creates PostgreSql flexible server open to specified IP addresses. + +## PARAMETERS + +### -AdministratorLoginPassword +The password of the administrator. +Minimum 8 characters and maximum 128 characters. +Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorUserName +Administrator username for the server. +Once set, it cannot be changed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. +Day count is between 7 and 35. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HaEnabled +Enable or disable high availability feature. +Allowed values: Enabled, Disabled + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location the resource resides in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServerName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateDnsZone +The id of an existing private dns zone. +You can use the + private dns zone from same resource group, different resource group, or + different subscription. +The suffix of dns zone has to be same as that of fully qualified domain of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicAccess +Determines the public access. +Enter single or range of IP addresses to be + included in the allowed list of IPs. +IP address ranges must be dash- + separated and not contain any spaces. +Specifying 0.0.0.0 allows public + access from any resources deployed within Azure to access your server. + Specifying no IP address sets the server in public access mode but does + not create a firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +Standard_B1ms, Standard_D2s_v3. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +Compute tier of the server. +Accepted values: Burstable, GeneralPurpose, Memory Optimized. +Default: Burstable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageInMb +Max storage allowed for a server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +The Name or Id of an existing Subnet or name of a new one to create. +Please note that the subnet will be delegated to Microsoft.DBforPostgreSQL/flexibleServers. +After delegation, this subnet cannot be used for any other type of Azure resources. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetPrefix +The subnet IP address prefix to use when creating a new vnet in CIDR format. +Default value is 10.0.0.0/24. + +```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 subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Server version. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Support.ServerVersion +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vnet +The Name or Id of an existing virtual network or name of a new one to create. +The name must be between 2 to 64 characters. +The name must begin with a letter or number, end with a letter, number or underscore, and may contain only letters, numbers, underscores, periods, or hyphens. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetPrefix +The IP address prefix to use when creating a new vnet in CIDR format. +Default value is 10.0.0.0/16. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +Availability zone into which to provision the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IServerAutoGenerated + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlFlexibleServerDatabase.md b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 0000000000..551569d168 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/new-azpostgresqlflexibleserverdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlFlexibleServerDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlFlexibleServerDatabase.md +--- + +# New-AzPostgreSqlFlexibleServerDatabase + +## SYNOPSIS +Creates a new database or updates an existing database. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerDatabase -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-Charset <String>] [-Collation <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzPostgreSqlFlexibleServerDatabase -InputObject <IPostgreSqlIdentity> [-Charset <String>] + [-Collation <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new database or updates an existing database. + +## EXAMPLES + +### Example 1: Add a new database to PostgreSQL server. +```powershell +New-AzPostgreSqlFlexibleServerDatabase -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql -Name testdb -Charset utf8 -Collation en_US.utf8 +``` + +```output +Name Charset Collation +---- ------- --------- +testdb UTF8 en_US.utf8 +``` + +Add a new database to PostgreSQL server. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Charset +The charset of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Collation +The collation of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the database. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: DatabaseName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IDatabaseAutoGenerated + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlFlexibleServerFirewallRule.md b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 0000000000..07f58f8c7d --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/new-azpostgresqlflexibleserverfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlFlexibleServerFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlFlexibleServerFirewallRule.md +--- + +# New-AzPostgreSqlFlexibleServerFirewallRule + +## SYNOPSIS +Creates a new firewall rule or updates an existing firewall rule. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerFirewallRule -ResourceGroupName <String> -ServerName <String> + -EndIPAddress <String> -StartIPAddress <String> [-Name <String>] [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### AllowAll +``` +New-AzPostgreSqlFlexibleServerFirewallRule -ResourceGroupName <String> -ServerName <String> -AllowAll + [-Name <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### ClientIPAddress +``` +New-AzPostgreSqlFlexibleServerFirewallRule -ResourceGroupName <String> -ServerName <String> + -ClientIPAddress <String> [-Name <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new firewall rule or updates an existing firewall rule. + +## EXAMPLES + +### Example 1: Create a new PostgreSql server Firewall Rule +```powershell +New-AzPostgreSqlFlexibleServerFirewallRule -Name firewallrule-test -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test -EndIPAddress 0.0.0.1 -StartIPAddress 0.0.0.0 +``` + +```output +Name StartIPAddress EndIPAddress +----------------- -------------- ------------ +firewallrule-test 0.0.0.0 0.0.0.1 +``` + +This cmdlets create a PostgreSql server Firewall Rule. + +### Example 2: Create a new PostgreSql Firewall Rule using -ClientIPAddress. +```powershell +New-AzPostgreSqlFlexibleServerFirewallRule -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test -ClientIPAddress 0.0.0.1 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +ClientIPAddress_2020-08-11_18-19-27 0.0.0.1 0.0.0.1 +``` + +This cmdlets create a PostgreSql Firewall Rule using -ClientIPAddress. + +### Example 3: Create a new PostgreSql Firewall Rule to allow all IPs +```powershell +New-AzPostgreSqlFlexibleServerFirewallRule -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test -AllowAll +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +AllowAll_2020-08-11_18-19-27 0.0.0.0 255.255.255.255 +``` + +This cmdlets create a new PostgreSql Firewall Rule to allow all IPs. + +## PARAMETERS + +### -AllowAll +Present to allow all range IPs, from 0.0.0.0 to 255.255.255.255. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AllowAll +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientIPAddress +Client specified single IP of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIPAddress +The end IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. +If not specified, the default is undefined. +If AllowAll is present, the default name is AllowAll_yyyy-MM-dd_HH-mm-ss. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FirewallRuleName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +The start IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IFirewallRule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlReplica.md b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlReplica.md new file mode 100644 index 0000000000..004e5b7b34 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlReplica.md @@ -0,0 +1,273 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/new-azpostgresqlreplica +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlReplica.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlReplica.md +--- + +# New-AzPostgreSqlReplica + +## SYNOPSIS +Creates a new replica from an existing database. + +## SYNTAX + +``` +New-AzPostgreSqlReplica -ReplicaName <String> -ResourceGroupName <String> -Master <IServer> + [-SubscriptionId <String>] [-Location <String>] [-Sku <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new replica from an existing database. + +## EXAMPLES + +### Example 1: Create a new PostgreSql server replica +```powershell +Get-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer | New-AzPostgreSqlReplica -ReplicaName PostgreSqlTestServerReplica -ResourceGroupName PostgreSqlTestRG +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +postgresqltestserverreplica eastus pwsh 9.6 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This cmdlet creates a new PostgreSql server replica. + +### Example 2: Create a new PostgreSql server replica +```powershell +$pgDb = Get-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer +New-AzPostgreSqlReplica -Master $pgDb -ReplicaName PostgreSqlTestServerReplica -ResourceGroupName PostgreSqlTestRG +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +postgresqltestserverreplica eastus pwsh 9.6 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This cmdlet creates a new PostgreSql server replica. + +## PARAMETERS + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location the resource resides in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Master +The source server object to create replica from. +To construct, see NOTES section for MASTER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IServer +Parameter Sets: (All) +Aliases: InputObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ReplicaServerName, Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +B_Gen4_1, GP_Gen5_8. + +```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 subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IServer + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IServer + +## 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. + + +MASTER `<IServer>`: The source server object to create replica from. + - `Location <String>`: The geo-location where the resource lives + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdministratorLogin <String>]`: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). + - `[EarliestRestoreDate <DateTime?>]`: Earliest restore point creation time (ISO8601 format) + - `[FullyQualifiedDomainName <String>]`: The fully qualified domain name of a server. + - `[IdentityType <IdentityType?>]`: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + - `[InfrastructureEncryption <InfrastructureEncryption?>]`: Status showing whether the server enabled infrastructure encryption. + - `[MasterServerId <String>]`: The master server id of a replica server. + - `[MinimalTlsVersion <MinimalTlsVersionEnum?>]`: Enforce a minimal Tls version for the server. + - `[PublicNetworkAccess <PublicNetworkAccessEnum?>]`: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' + - `[ReplicaCapacity <Int32?>]`: The maximum number of replicas that a master server can have. + - `[ReplicationRole <String>]`: The replication role of the server. + - `[SkuCapacity <Int32?>]`: The scale up/out capacity, representing server's compute units. + - `[SkuFamily <String>]`: The family of hardware. + - `[SkuName <String>]`: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. + - `[SkuSize <String>]`: The size code, to be interpreted by resource as appropriate. + - `[SkuTier <SkuTier?>]`: The tier of the particular SKU, e.g. Basic. + - `[SslEnforcement <SslEnforcementEnum?>]`: Enable ssl enforcement or not when connect to server. + - `[StorageProfileBackupRetentionDay <Int32?>]`: Backup retention days for the server. + - `[StorageProfileGeoRedundantBackup <GeoRedundantBackup?>]`: Enable Geo-redundant or not for server backup. + - `[StorageProfileStorageAutogrow <StorageAutogrow?>]`: Enable Storage Auto Grow. + - `[StorageProfileStorageMb <Int32?>]`: Max storage allowed for a server. + - `[UserVisibleState <ServerState?>]`: A state of a server that is visible to user. + - `[Version <ServerVersion?>]`: Server version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlServer.md b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlServer.md new file mode 100644 index 0000000000..dc175ca5e3 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlServer.md @@ -0,0 +1,367 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/new-azpostgresqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlServer.md +--- + +# New-AzPostgreSqlServer + +## SYNOPSIS +Creates a new server. + +## SYNTAX + +``` +New-AzPostgreSqlServer -Name <String> -ResourceGroupName <String> -AdministratorLoginPassword <SecureString> + -AdministratorUserName <String> -Location <String> -Sku <String> [-SubscriptionId <String>] + [-BackupRetentionDay <Int32>] [-GeoRedundantBackup <GeoRedundantBackup>] + [-MinimalTlsVersion <MinimalTlsVersionEnum>] [-SslEnforcement <SslEnforcementEnum>] + [-StorageAutogrow <StorageAutogrow>] [-StorageInMb <Int32>] [-Tag <Hashtable>] [-Version <ServerVersion>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new server. + +## EXAMPLES + +### Example 1: Create a new PostgreSql server +```powershell +New-AzPostgreSqlServer -Name PostgreSqlTestServer -ResourceGroupName PostgreSqlTestRG -Location eastus -AdministratorUserName pwsh -AdministratorLoginPassword $password -Sku GP_Gen5_4 +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +postgresqltestserver eastus pwsh 9.6 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +These cmdlets create a new PostgreSql server. + +## PARAMETERS + +### -AdministratorLoginPassword +The password of the administrator. +Minimum 8 characters and maximum 128 characters. +Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorUserName +Administrator username for the server. +Once set, it cannot be changed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. +Day count is between 7 and 35. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeoRedundantBackup +Enable Geo-redundant or not for server backup. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Support.GeoRedundantBackup +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location the resource resides in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimalTlsVersion +Set the minimal TLS version for connections to server when SSL is enabled. +Default is TLSEnforcementDisabled.accepted values: TLS1_0, TLS1_1, TLS1_2, TLSEnforcementDisabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Support.MinimalTlsVersionEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +B_Gen4_1, GP_Gen5_8. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslEnforcement +Enable ssl enforcement or not when connect to server. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Support.SslEnforcementEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAutogrow +Enable Storage Auto Grow. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Support.StorageAutogrow +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageInMb +Max storage allowed for a server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Server version. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Support.ServerVersion +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IServer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlVirtualNetworkRule.md b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlVirtualNetworkRule.md new file mode 100644 index 0000000000..a69178c856 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/New-AzPostgreSqlVirtualNetworkRule.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/new-azpostgresqlvirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/New-AzPostgreSqlVirtualNetworkRule.md +--- + +# New-AzPostgreSqlVirtualNetworkRule + +## SYNOPSIS +Creates or updates an existing virtual network rule. + +## SYNTAX + +``` +New-AzPostgreSqlVirtualNetworkRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -SubnetId <String> [-SubscriptionId <String>] [-IgnoreMissingVnetServiceEndpoint] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an existing virtual network rule. + +## EXAMPLES + +### Example 1: Create a new PostgreSql server Virtual Network Rule +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.Network/virtualNetworks/PostgreSqlVNet/subnets/default" +New-AzPostgreSqlVirtualNetworkRule -Name vnet -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer -SubnetId $ID +``` + +```output +Name Type +---- ---- +vnet Microsoft.DBforPostgreSQL/servers/virtualNetworkRules +``` + +These cmdlets create a PostgreSql server Virtual Network Rule. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreMissingVnetServiceEndpoint +Create firewall rule before the virtual network has vnet service endpoint enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VirtualNetworkRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The ARM resource id of the virtual network subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IVirtualNetworkRule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlFirewallRule.md b/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlFirewallRule.md new file mode 100644 index 0000000000..48200257b6 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlFirewallRule.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/remove-azpostgresqlfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Remove-AzPostgreSqlFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Remove-AzPostgreSqlFirewallRule.md +--- + +# Remove-AzPostgreSqlFirewallRule + +## SYNOPSIS +Deletes a server firewall rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFirewallRule -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a server firewall rule. + +## EXAMPLES + +### Example 1: Remove PostgreSql Firewall Rule by name +```powershell +Remove-AzPostgreSqlFirewallRule -Name rule -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer + +``` + +This cmdlet removes PostgreSql Firewall Rule by name. + +### Example 2: Remove PostgreSql Firewall Rule by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.DBforPostgreSQL/servers/PostgreSqlTestServer/firewallRules/rule" +Remove-AzPostgreSqlFirewallRule -InputObject $ID + +``` + +These cmdlets remove PostgreSql Firewall Rule by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlFlexibleServer.md b/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlFlexibleServer.md new file mode 100644 index 0000000000..75d12fec26 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,237 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/remove-azpostgresqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Remove-AzPostgreSqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Remove-AzPostgreSqlFlexibleServer.md +--- + +# Remove-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Deletes a server. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServer -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a server. + +## EXAMPLES + +### Example 1: Remove PostgreSql server by resourceGroup and server name +```powershell +Remove-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test +``` + +This cmdlet removes PostgreSql server by resourceGroup and server name. + +### Example 2: Remove PostgreSql server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresql-test" +Remove-AzPostgreSqlFlexibleServer -InputObject $ID +``` + +These cmdlets remove PostgreSql server by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlFlexibleServerDatabase.md b/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 0000000000..d49d66a033 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/remove-azpostgresqlflexibleserverdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Remove-AzPostgreSqlFlexibleServerDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Remove-AzPostgreSqlFlexibleServerDatabase.md +--- + +# Remove-AzPostgreSqlFlexibleServerDatabase + +## SYNOPSIS +Deletes a database. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServerDatabase -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServerDatabase -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a database. + +## EXAMPLES + +### Example 1: Remove a database by name +```powershell +Remove-AzPostgreSqlFlexibleServerDatabase -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql -Name testdb + +``` + +Remove a database by name + +### Example 2: Remove a database by Id +```powershell +Remove-AzPostgreSqlFlexibleServerDatabase -InputObject /subscriptions/0000000000-0000-0000-0000-000000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresql-test/databases/flexibleserverdb + +``` + +Remove a database by Id + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the database. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DatabaseName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlFlexibleServerFirewallRule.md b/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 0000000000..ec88ccbe32 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/remove-azpostgresqlflexibleserverfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Remove-AzPostgreSqlFlexibleServerFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Remove-AzPostgreSqlFlexibleServerFirewallRule.md +--- + +# Remove-AzPostgreSqlFlexibleServerFirewallRule + +## SYNOPSIS +Deletes a PostgreSQL server firewall rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServerFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServerFirewallRule -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a PostgreSQL server firewall rule. + +## EXAMPLES + +### Example 1: Remove PostgreSql Firewall Rule by name +```powershell +Remove-AzPostgreSqlFlexibleServerFirewallRule -Name firewall-rule-test -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test + +``` + +This cmdlet removes PostgreSql Firewall Rule by name. + +### Example 2: Remove PostgreSql Firewall Rule by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresql-test/firewallRules/firewall-rule-test" +Remove-AzPostgreSqlFlexibleServerFirewallRule -InputObject $ID + +``` + +These cmdlets remove PostgreSql Firewall Rule by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlServer.md b/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlServer.md new file mode 100644 index 0000000000..14933e6b50 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlServer.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/remove-azpostgresqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Remove-AzPostgreSqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Remove-AzPostgreSqlServer.md +--- + +# Remove-AzPostgreSqlServer + +## SYNOPSIS +Deletes a server. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlServer -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a server. + +## EXAMPLES + +### Example 1: Remove PostgreSql server by resourceGroup and server name +```powershell +Remove-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG -Name PostgreSqlTestServer + +``` + +This cmdlet removes PostgreSql server by resourceGroup and server name. + +### Example 2: Remove PostgreSql server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.DBforPostgreSQL/servers/PostgreSqlTestServer" +Remove-AzPostgreSqlServer -InputObject $ID + +``` + +These cmdlets remove PostgreSql server by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlVirtualNetworkRule.md b/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlVirtualNetworkRule.md new file mode 100644 index 0000000000..6e0fd02109 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Remove-AzPostgreSqlVirtualNetworkRule.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/remove-azpostgresqlvirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Remove-AzPostgreSqlVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Remove-AzPostgreSqlVirtualNetworkRule.md +--- + +# Remove-AzPostgreSqlVirtualNetworkRule + +## SYNOPSIS +Deletes the virtual network rule with the given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlVirtualNetworkRule -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlVirtualNetworkRule -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the virtual network rule with the given name. + +## EXAMPLES + +### Example 1: Remove PostgreSql server Virtual Network Rule by name +```powershell +Remove-AzPostgreSqlVirtualNetworkRule -Name vnet -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer + +``` + +This cmdlet removes PostgreSql server Virtual Network Rule by name. + +### Example 2: Remove PostgreSql server Virtual Network Rule by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.DBforPostgreSQL/servers/PostgreSqlTestServer/virtualNetworkRules/vnet" +Remove-AzPostgreSqlVirtualNetworkRule -InputObject $ID + +``` + +These cmdlets remove PostgreSql server Virtual Network Rule by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: VirtualNetworkRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Restart-AzPostgreSqlFlexibleServer.md b/azps-10.1.0/Az.PostgreSql/Restart-AzPostgreSqlFlexibleServer.md new file mode 100644 index 0000000000..0dbe7d7089 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Restart-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,318 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/restart-azpostgresqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Restart-AzPostgreSqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Restart-AzPostgreSqlFlexibleServer.md +--- + +# Restart-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Restarts a server. + +## SYNTAX + +### RestartExpanded (Default) +``` +Restart-AzPostgreSqlFlexibleServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-FailoverMode <String>] [-RestartWithFailover] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Restart +``` +Restart-AzPostgreSqlFlexibleServer -Name <String> -ResourceGroupName <String> -Parameter <IRestartParameter> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### RestartViaIdentity +``` +Restart-AzPostgreSqlFlexibleServer -InputObject <IPostgreSqlIdentity> -Parameter <IRestartParameter> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RestartViaIdentityExpanded +``` +Restart-AzPostgreSqlFlexibleServer -InputObject <IPostgreSqlIdentity> [-FailoverMode <String>] + [-RestartWithFailover] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Restarts a server. + +## EXAMPLES + +### Example 1: Restart the server by resource name +```powershell +Restart-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test +``` + +Restart the server by name + +### Example 2: Restart the server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.DBForPostgreSql/flexibleServers/postgresql-test/restart" +Restart-AzPostgreSqlFlexibleServer -InputObject $ID +``` + +Restart the server by identity + +### Example 3: Restart the server with planned failover +```powershell +Restart-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test -RestartWithFailover -FailoverMode PlannedFailover +``` + +Restart the server by name with planned failover + +### Example 4: Restart the server with forced failover +```powershell +Restart-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test -RestartWithFailover -FailoverMode ForcedFailover +``` + +Restart the server by name with forced failover + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverMode +Failover mode. + +```yaml +Type: System.String +Parameter Sets: RestartExpanded, RestartViaIdentityExpanded +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.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: RestartViaIdentity, RestartViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Restart, RestartExpanded +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Represents server restart parameters. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IRestartParameter +Parameter Sets: Restart, RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Restart, RestartExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestartWithFailover +Indicates whether to restart the server with failover. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RestartExpanded, RestartViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Restart, RestartExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IRestartParameter + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +PARAMETER `<IRestartParameter>`: Represents server restart parameters. + - `[FailoverMode <String>]`: Failover mode. + - `[RestartWithFailover <Boolean?>]`: Indicates whether to restart the server with failover. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Restart-AzPostgreSqlServer.md b/azps-10.1.0/Az.PostgreSql/Restart-AzPostgreSqlServer.md new file mode 100644 index 0000000000..4e2c45c618 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Restart-AzPostgreSqlServer.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/restart-azpostgresqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Restart-AzPostgreSqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Restart-AzPostgreSqlServer.md +--- + +# Restart-AzPostgreSqlServer + +## SYNOPSIS +Restarts a server. + +## SYNTAX + +### Restart (Default) +``` +Restart-AzPostgreSqlServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RestartViaIdentity +``` +Restart-AzPostgreSqlServer -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Restarts a server. + +## EXAMPLES + +### Example 1: Restart PostgreSql server by resource group and server name +```powershell +Restart-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG -Name PostgreSqlTestServer + +``` + +This cmdlet restarts PostgreSql server by resource group and server name. + +### Example 2: Restart PostgreSql server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.DBforPostgreSQL/servers/PostgreSqlTestServer/restart" +Restart-AzPostgreSqlServer -InputObject $ID + +``` + +These cmdlets restart PostgreSql server by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Restore-AzPostgreSqlFlexibleServer.md b/azps-10.1.0/Az.PostgreSql/Restore-AzPostgreSqlFlexibleServer.md new file mode 100644 index 0000000000..0ba0c2adeb --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Restore-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,277 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/restore-azpostgresqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Restore-AzPostgreSqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Restore-AzPostgreSqlFlexibleServer.md +--- + +# Restore-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Restore a server from an existing backup + +## SYNTAX + +``` +Restore-AzPostgreSqlFlexibleServer -Name <String> -ResourceGroupName <String> -SourceServerName <String> + -RestorePointInTime <DateTime> [-SubscriptionId <String>] [-PrivateDnsZone <String>] [-Subnet <String>] + [-Zone <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Restore a server from an existing backup + +## EXAMPLES + +### Example 1: Restore PostgreSql server using PointInTime Restore +```powershell +$restorePointInTime = (Get-Date).AddMinutes(-10) +Restore-AzPostgreSqlFlexibleServer -Name pg-restore -ResourceGroupName PowershellPostgreSqlTest -SourceServerName postgresql-test -RestorePointInTime $restorePointInTime +``` + +```output +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +pg-restore East US Standard_D2s_v3 GeneralPurpose daeunyim 128 +``` + +These cmdlets restore PostgreSql server using PointInTime Restore. + +### Example 1: Restore PostgreSql server using PointInTime Restore with different network resource +```powershell + +$Subnet = '/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnetname' +$DnsZone = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/postgresqltest/providers/Microsoft.Network/privateDnsZones/testserver.private.postgres.database.azure.com' +$restorePointInTime = (Get-Date).AddMinutes(-10) +Restore-AzPostgreSqlFlexibleServer -Name pg-restore -ResourceGroupName PowershellPostgreSqlTest -SourceServerName postgresql-test -RestorePointInTime $restorePointInTime -Subnet $subnet -PrivateDnsZone $DnsZone +``` + +```output +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +pg-restore East US Standard_D2s_v3 GeneralPurpose daeunyim 128 +``` + +These cmdlets restore PostgreSql server using PointInTime Restore. + +## PARAMETERS + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateDnsZone +The id of an existing private dns zone. +You can use the + private dns zone from same resource group, different resource group, or + different subscription. +The suffix of dns zone has to be same as that of fully qualified domain of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestorePointInTime +The point in time to restore from (ISO8601 format), e.g., 2017-04-26T02:10:00+08:00. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceServerName +The name of the source server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +The id of an existing Subnet the private access server will created to. +Please note that the subnet will be delegated to Microsoft.DBforPostgreSQL/flexibleServers. +After delegation, this subnet cannot be used for any other type of Azure resources. + +```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 subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +Availability zone into which to provision the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IServerAutoGenerated + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Restore-AzPostgreSqlServer.md b/azps-10.1.0/Az.PostgreSql/Restore-AzPostgreSqlServer.md new file mode 100644 index 0000000000..7f5fa67bd7 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Restore-AzPostgreSqlServer.md @@ -0,0 +1,342 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/restore-azpostgresqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Restore-AzPostgreSqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Restore-AzPostgreSqlServer.md +--- + +# Restore-AzPostgreSqlServer + +## SYNOPSIS +Restore a server from an existing backup + +## SYNTAX + +### GeoRestore (Default) +``` +Restore-AzPostgreSqlServer -Name <String> -ResourceGroupName <String> -InputObject <IServer> -UseGeoRestore + [-SubscriptionId <String>] [-Location <String>] [-Sku <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### PointInTimeRestore +``` +Restore-AzPostgreSqlServer -Name <String> -ResourceGroupName <String> -InputObject <IServer> + -RestorePointInTime <DateTime> -UsePointInTimeRestore [-SubscriptionId <String>] [-Location <String>] + [-Sku <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Restore a server from an existing backup + +## EXAMPLES + +### Example 1: Restore PostgreSql server using GeoReplica Restore +```powershell +Get-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG -ServerName postgresqltestserverreplica | Restore-AzPostgreSqlServer -Name PostgreSqlTestServer -ResourceGroupName PostgreSqlTestRG -UseGeoRestore +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +postgresqltestserver eastus pwsh 9.6 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +This cmdlet restores PostgreSql server using GeoReplica Restore. + +### Example 2: Restore PostgreSql server using PointInTime Restore +```powershell +$restorePointInTime = (Get-Date).AddMinutes(-10) +Get-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer | Restore-AzPostgreSqlServer -Name PostgreSqlTestServerGEO -ResourceGroupName PostgreSqlTestRG -RestorePointInTime $restorePointInTime -UsePointInTimeRestore +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +postgresqltestservergeo eastus pwsh 9.6 5120 GP_Gen5_4 GeneralPurpose Enabled +``` + +These cmdlets restore PostgreSql server using PointInTime Restore. + +## PARAMETERS + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The source server object to restore from. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IServer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location the resource resides in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestorePointInTime +The location the resource resides in. + +```yaml +Type: System.DateTime +Parameter Sets: PointInTimeRestore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +B_Gen4_1, GP_Gen5_8. + +```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 subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseGeoRestore +Use Geo mode to restore + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GeoRestore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePointInTimeRestore +Use PointInTime mode to restore + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PointInTimeRestore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IServer + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IServer + +## 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 `<IServer>`: The source server object to restore from. + - `Location <String>`: The geo-location where the resource lives + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[AdministratorLogin <String>]`: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). + - `[EarliestRestoreDate <DateTime?>]`: Earliest restore point creation time (ISO8601 format) + - `[FullyQualifiedDomainName <String>]`: The fully qualified domain name of a server. + - `[IdentityType <IdentityType?>]`: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + - `[InfrastructureEncryption <InfrastructureEncryption?>]`: Status showing whether the server enabled infrastructure encryption. + - `[MasterServerId <String>]`: The master server id of a replica server. + - `[MinimalTlsVersion <MinimalTlsVersionEnum?>]`: Enforce a minimal Tls version for the server. + - `[PublicNetworkAccess <PublicNetworkAccessEnum?>]`: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' + - `[ReplicaCapacity <Int32?>]`: The maximum number of replicas that a master server can have. + - `[ReplicationRole <String>]`: The replication role of the server. + - `[SkuCapacity <Int32?>]`: The scale up/out capacity, representing server's compute units. + - `[SkuFamily <String>]`: The family of hardware. + - `[SkuName <String>]`: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. + - `[SkuSize <String>]`: The size code, to be interpreted by resource as appropriate. + - `[SkuTier <SkuTier?>]`: The tier of the particular SKU, e.g. Basic. + - `[SslEnforcement <SslEnforcementEnum?>]`: Enable ssl enforcement or not when connect to server. + - `[StorageProfileBackupRetentionDay <Int32?>]`: Backup retention days for the server. + - `[StorageProfileGeoRedundantBackup <GeoRedundantBackup?>]`: Enable Geo-redundant or not for server backup. + - `[StorageProfileStorageAutogrow <StorageAutogrow?>]`: Enable Storage Auto Grow. + - `[StorageProfileStorageMb <Int32?>]`: Max storage allowed for a server. + - `[UserVisibleState <ServerState?>]`: A state of a server that is visible to user. + - `[Version <ServerVersion?>]`: Server version. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Start-AzPostgreSqlFlexibleServer.md b/azps-10.1.0/Az.PostgreSql/Start-AzPostgreSqlFlexibleServer.md new file mode 100644 index 0000000000..3cdd5fcf59 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Start-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,237 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/start-azpostgresqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Start-AzPostgreSqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Start-AzPostgreSqlFlexibleServer.md +--- + +# Start-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Starts a server. + +## SYNTAX + +### Start (Default) +``` +Start-AzPostgreSqlFlexibleServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzPostgreSqlFlexibleServer -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Starts a server. + +## EXAMPLES + +### Example 1: Start the server by resource name +```powershell +Start-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test +``` + +Start the server by name + +### Example 2: Start the server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresql-test/start" +Start-AzPostgreSqlFlexibleServer -InputObject $ID +``` + +Start the server by identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Stop-AzPostgreSqlFlexibleServer.md b/azps-10.1.0/Az.PostgreSql/Stop-AzPostgreSqlFlexibleServer.md new file mode 100644 index 0000000000..88f67ba55b --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Stop-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,237 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/stop-azpostgresqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Stop-AzPostgreSqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Stop-AzPostgreSqlFlexibleServer.md +--- + +# Stop-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Stops a server. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzPostgreSqlFlexibleServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzPostgreSqlFlexibleServer -InputObject <IPostgreSqlIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Stops a server. + +## EXAMPLES + +### Example 1: Stop the server by resource name +```powershell +Stop-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test +``` + +Stop the server by name + +### Example 2: Stop the server by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresql-test/stop" +Stop-AzPostgreSqlFlexibleServer -InputObject $ID +``` + +Stop the server by identity + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Test-AzPostgreSqlFlexibleServerConnect.md b/azps-10.1.0/Az.PostgreSql/Test-AzPostgreSqlFlexibleServerConnect.md new file mode 100644 index 0000000000..9f8750b505 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Test-AzPostgreSqlFlexibleServerConnect.md @@ -0,0 +1,264 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/test-azpostgresqlflexibleserverconnect +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Test-AzPostgreSqlFlexibleServerConnect.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Test-AzPostgreSqlFlexibleServerConnect.md +--- + +# Test-AzPostgreSqlFlexibleServerConnect + +## SYNOPSIS +Test out the connection to the database server + +## SYNTAX + +### Test (Default) +``` +Test-AzPostgreSqlFlexibleServerConnect -Name <String> -ResourceGroupName <String> + -AdministratorLoginPassword <SecureString> [-DatabaseName <String>] [-AdministratorUserName <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### TestAndQuery +``` +Test-AzPostgreSqlFlexibleServerConnect -Name <String> -QueryText <String> -ResourceGroupName <String> + -AdministratorLoginPassword <SecureString> [-DatabaseName <String>] [-AdministratorUserName <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### TestViaIdentity +``` +Test-AzPostgreSqlFlexibleServerConnect -AdministratorLoginPassword <SecureString> + -InputObject <IPostgreSqlIdentity> [-DatabaseName <String>] [-AdministratorUserName <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### TestViaIdentityAndQuery +``` +Test-AzPostgreSqlFlexibleServerConnect -QueryText <String> -AdministratorLoginPassword <SecureString> + -InputObject <IPostgreSqlIdentity> [-DatabaseName <String>] [-AdministratorUserName <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Test out the connection to the database server + +## EXAMPLES + +### Example 1: Test connection by name +```powershell +$password = ConvertTo-SecureString <YourPassword> -AsPlainText +Test-AzPostgreSqlFlexibleServerConnect -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test -AdministratorLoginPassword $password +``` + +```output +The connection testing to postgresql-test.database.azure.com was successful! +``` + +Test connection by the resource group and the server name + +### Example 2: Test connection by identity +```powershell +$password = ConvertTo-SecureString <YourPassword> -AsPlainText +Get-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test | Test-AzPostgreSqlFlexibleServerConnect -AdministratorLoginPassword $password +``` + +```output +The connection testing to postgresql-test.database.azure.com was successful! +``` + +Test connection by the identity + +### Example 3: Test query by name +```powershell +$password = ConvertTo-SecureString <YourPassword> -AsPlainText +Test-AzPostgreSqlFlexibleServerConnect -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test -AdministratorLoginPassword $password -QueryText "SELECT * FROM test" +``` + +```output +col +----- +1 +2 +3 +``` + +Test a query by the resource group and the server name + +### Example 4: Test connection by identity +```powershell +Get-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test | Test-AzPostgreSqlFlexibleServerConnect -QueryText "SELECT * FROM test" -AdministratorLoginPassword $password +``` + +```output +col +----- +1 +2 +3 +``` + +Test a query by the identity + +## PARAMETERS + +### -AdministratorLoginPassword +The password of the administrator. +Minimum 8 characters and maximum 128 characters. +Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorUserName +Administrator username for the server. +Once set, it cannot be changed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The database name to connect. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The server to connect. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: TestViaIdentity, TestViaIdentityAndQuery +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server to connect. + +```yaml +Type: System.String +Parameter Sets: Test, TestAndQuery +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryText +The query for the database to test + +```yaml +Type: System.String +Parameter Sets: TestAndQuery, TestViaIdentityAndQuery +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource, You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Test, TestAndQuery +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPostgreSqlIdentity>`: The server to connect. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlConfiguration.md b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlConfiguration.md new file mode 100644 index 0000000000..9a8d4e3b66 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlConfiguration.md @@ -0,0 +1,282 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/update-azpostgresqlconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlConfiguration.md +--- + +# Update-AzPostgreSqlConfiguration + +## SYNOPSIS +Updates a configuration of a server. +Use Update-AzPostgreSqlServer instead if you want update AdministratorLoginPassword, sku, etc. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlConfiguration -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-Source <String>] [-Value <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlConfiguration -InputObject <IPostgreSqlIdentity> [-Source <String>] [-Value <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a configuration of a server. +Use Update-AzPostgreSqlServer instead if you want update AdministratorLoginPassword, sku, etc. + +## EXAMPLES + +### Example 1: Update PostgreSql configuration by name +```powershell +Update-AzPostgreSqlConfiguration -Name intervalstyle -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer -Value SQL_STANDARD +``` + +```output +Name Value +---- ----- +intervalstyle SQL_STANDARD +``` + +This cmdlet updates PostgreSql configuration by name. + +### Example 2: Update PostgreSql configuration by identity. +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.DBforPostgreSQL/servers/PostgreSqlTestServer/configurations/deadlock_timeout" +Update-AzPostgreSqlConfiguration -InputObject $ID -Value 2000 +``` + +```output +Name Value +---- ----- +deadlock_timeout 2000 +``` + +These cmdlets update PostgreSql configuration by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server configuration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Source of the configuration. + +```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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Value of the configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IConfiguration + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlFirewallRule.md b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlFirewallRule.md new file mode 100644 index 0000000000..e187cd12e9 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlFirewallRule.md @@ -0,0 +1,326 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/update-azpostgresqlfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlFirewallRule.md +--- + +# Update-AzPostgreSqlFirewallRule + +## SYNOPSIS +Creates a new firewall rule or updates an existing firewall rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -EndIPAddress <String> -StartIPAddress <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ClientIPAddress +``` +Update-AzPostgreSqlFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -ClientIPAddress <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ClientIPAddressViaIdentity +``` +Update-AzPostgreSqlFirewallRule -InputObject <IPostgreSqlIdentity> -ClientIPAddress <String> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFirewallRule -InputObject <IPostgreSqlIdentity> -EndIPAddress <String> + -StartIPAddress <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new firewall rule or updates an existing firewall rule. + +## EXAMPLES + +### Example 1: Update PostgreSql Firewall Rule by name +```powershell +Update-AzPostgreSqlFirewallRule -Name rule -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer -EndIPAddress 0.0.0.3 -StartIPAddress 0.0.0.2 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.2 0.0.0.3 +``` + +This cmdlet updates PostgreSql Firewall Rule by name. + +### Example 2: Update PostgreSql Firewall Rule by identity. +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.DBforPostgreSQL/servers/PostgreSqlTestServer/firewallRules/rule" +Update-AzPostgreSqlFirewallRule -InputObject $ID -EndIPAddress 0.0.0.1 -StartIPAddress 0.0.0.0 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.0 0.0.0.1 +``` + +These cmdlets update PostgreSql Firewall Rule by identity. + +### Example 3: Update PostgreSql Firewall Rule by -ClientIPAddress. +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.DBforPostgreSQL/servers/PostgreSqlTestServer/firewallRules/rule" +Update-AzPostgreSqlFirewallRule -InputObject $ID -ClientIPAddress 0.0.0.2 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.2 0.0.0.2 +``` + +These cmdlets update PostgreSql Firewall Rule by -ClientIPAddress. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientIPAddress +Client specified single IP of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, ClientIPAddressViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIPAddress +The end IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: ClientIPAddressViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +The start IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IFirewallRule + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlFlexibleServer.md b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlFlexibleServer.md new file mode 100644 index 0000000000..15f8b64ca5 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,368 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/update-azpostgresqlflexibleserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlFlexibleServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlFlexibleServer.md +--- + +# Update-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzPostSqlFlexibleServerConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AdministratorLoginPassword <SecureString>] [-BackupRetentionDay <Int32>] [-HaEnabled <Object>] + [-MaintenanceWindow <String>] [-Sku <String>] [-SkuTier <SkuTier>] [-StorageInMb <Int32>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServer -InputObject <IPostgreSqlIdentity> + [-AdministratorLoginPassword <SecureString>] [-BackupRetentionDay <Int32>] [-HaEnabled <Object>] + [-MaintenanceWindow <String>] [-Sku <String>] [-SkuTier <SkuTier>] [-StorageInMb <Int32>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzPostgreSqlFlexibleServerConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +## EXAMPLES + +### Example 1: Update PostgreSql server by resource group and server name +```powershell +Update-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -Name postgresql-test -Sku Standard_D4s_v3 +``` + +```output +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +postgresql-test East US Standard_D4s_v3 GeneralPurpose daeunyim 256 GeneralPurpose +``` + +This cmdlet updates PostgreSql server by resource group and server name. + +### Example 2: Update PostgreSql server by identity. +```powershell +Get-AzPostgreSqlFlexibleServer -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test | Update-AzPostgreSqlFlexibleServer -BackupRetentionDay 23 -StorageInMb 262144 +``` + +```output +Name Location SkuName SkuTier AdministratorLogin StorageSizeGb +---- -------- ------- ------- ------------------ ------------- +postgresql-test East US Standard_D2s_v3 GeneralPurpose daeunyim 256 +``` + +This cmdlet updates PostgreSql server by identity. + +## PARAMETERS + +### -AdministratorLoginPassword +The password of the administrator login. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. +Day count is between 7 and 35. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HaEnabled +Enable or disable high availability feature. +Allowed values: Enabled, Disabled + +```yaml +Type: System.Object +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.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaintenanceWindow +Period of time (UTC) designated for maintenance. +Examples: "Sun:23:30" to schedule on Sunday, 11:30pm UTC. +To set back to default pass in "Disabled" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, e.g. +Burstable_B1ms, Standard_D2ds_v4 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +The tier of the particular SKU. +Accepted values: Burstable, GeneralPurpose, Memory Optimized. +Default: Burstable. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageInMb +Max storage allowed for a server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IServerAutoGenerated + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlFlexibleServerConfiguration.md b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlFlexibleServerConfiguration.md new file mode 100644 index 0000000000..92a78be629 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlFlexibleServerConfiguration.md @@ -0,0 +1,283 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/update-azpostgresqlflexibleserverconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlFlexibleServerConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlFlexibleServerConfiguration.md +--- + +# Update-AzPostgreSqlFlexibleServerConfiguration + +## SYNOPSIS +Updates a configuration of a server. +Use Update-AzPostgreSqlFlexibleServer instead if you want update AdministratorLoginPassword, sku, etc. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServerConfiguration -Name <String> -ResourceGroupName <String> -ServerName <String> + [-SubscriptionId <String>] [-Source <String>] [-Value <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServerConfiguration -InputObject <IPostgreSqlIdentity> [-Source <String>] + [-Value <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a configuration of a server. +Use Update-AzPostgreSqlFlexibleServer instead if you want update AdministratorLoginPassword, sku, etc. + +## EXAMPLES + +### Example 1: Updatae specified PostgreSql configuration by name +```powershell +Update-AzPostgreSqlFlexibleServerConfiguration -Name work_mem -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test -Value 8192 +``` + +```output +Name Value AllowedValue Source DefaultValue +---- ----- ------------ ------ ------------ +work_mem 8192 4096-2097151 system-default 4096 + +``` + +This cmdlet updates specified PostgreSql configuration by name. + +### Example 2: Updatae specified PostgreSql configuration by identity +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresql-test/configurations/work_mem" +Update-AzPostgreSqlFlexibleServerConfiguration -Name work_mem -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test -Value 8192 +``` + +```output +Name Value AllowedValue Source DefaultValue +---- ----- ------------ ------ ------------ +work_mem 8192 4096-2097151 system-default 4096 +``` + +This cmdlet updates specified PostgreSql configuration by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server configuration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Source of the configuration. + +```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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Value of the configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20210601.IConfigurationAutoGenerated + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlFlexibleServerFirewallRule.md b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 0000000000..a45ba36eb8 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,312 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/update-azpostgresqlflexibleserverfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlFlexibleServerFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlFlexibleServerFirewallRule.md +--- + +# Update-AzPostgreSqlFlexibleServerFirewallRule + +## SYNOPSIS +Creates a new firewall rule or updates an existing firewall rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServerFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -EndIPAddress <String> -StartIPAddress <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ClientIPAddress +``` +Update-AzPostgreSqlFlexibleServerFirewallRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -ClientIPAddress <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ClientIPAddressViaIdentity +``` +Update-AzPostgreSqlFlexibleServerFirewallRule -InputObject <IPostgreSqlIdentity> -ClientIPAddress <String> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServerFirewallRule -InputObject <IPostgreSqlIdentity> -EndIPAddress <String> + -StartIPAddress <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new firewall rule or updates an existing firewall rule. + +## EXAMPLES + +### Example 1: Update PostgreSql Firewall Rule by name +```powershell +Update-AzPostgreSqlFlexibleServerFirewallRule -Name rule -ResourceGroupName PowershellPostgreSqlTest -ServerName postgresql-test -EndIPAddress 0.0.0.3 -StartIPAddress 0.0.0.2 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.2 0.0.0.3 +``` + +This cmdlet updates PostgreSql Firewall Rule by name. + +### Example 2: Update PostgreSql Firewall Rule by identity. +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PowershellPostgreSqlTest/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresql-test/firewallRules/rule" +Update-AzPostgreSqlFlexibleServerFirewallRule -InputObject $ID -EndIPAddress 0.0.0.3 -StartIPAddress 0.0.0.2 +``` + +```output +Name StartIPAddress EndIPAddress +---- -------------- ------------ +rule 0.0.0.2 0.0.0.3 +``` + +These cmdlets update PostgreSql Firewall Rule by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientIPAddress +Client specified single IP of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, ClientIPAddressViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIPAddress +The end IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: ClientIPAddressViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +The start IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: ClientIPAddress, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IFirewallRule + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlServer.md b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlServer.md new file mode 100644 index 0000000000..f8cdd752dc --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlServer.md @@ -0,0 +1,444 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/update-azpostgresqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlServer.md +--- + +# Update-AzPostgreSqlServer + +## SYNOPSIS +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzPostSqlConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AdministratorLoginPassword <SecureString>] [-BackupRetentionDay <Int32>] + [-MinimalTlsVersion <MinimalTlsVersionEnum>] [-PublicNetworkAccess <PublicNetworkAccessEnum>] + [-ReplicationRole <String>] [-Sku <String>] [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuTier <SkuTier>] + [-SslEnforcement <SslEnforcementEnum>] [-StorageAutogrow <StorageAutogrow>] [-StorageInMb <Int32>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlServer -InputObject <IPostgreSqlIdentity> [-AdministratorLoginPassword <SecureString>] + [-BackupRetentionDay <Int32>] [-MinimalTlsVersion <MinimalTlsVersionEnum>] + [-PublicNetworkAccess <PublicNetworkAccessEnum>] [-ReplicationRole <String>] [-Sku <String>] + [-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuTier <SkuTier>] [-SslEnforcement <SslEnforcementEnum>] + [-StorageAutogrow <StorageAutogrow>] [-StorageInMb <Int32>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. +Use Update-AzPostSqlConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count. + +## EXAMPLES + +### Example 1: Update PostgreSql server by resource group and server name +```powershell +Update-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer -SslEnforcement Disabled +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +postgresqltestserver eastus pwsh 9.6 5120 GP_Gen5_4 GeneralPurpose Disabled +``` + +This cmdlet updates PostgreSql server by resource group and server name. + +### Example 2: Update PostgreSql server by identity. +```powershell +Get-AzPostgreSqlServer -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer | Update-AzPostgreSqlServer -BackupRetentionDay 23 +``` + +```output +Name Location AdministratorLogin Version StorageProfileStorageMb SkuName SkuTier SslEnforcement +---- -------- ------------------ ------- ----------------------- ------- ------- -------------- +postgresqltestserver eastus pwsh 9.6 5120 GP_Gen5_4 GeneralPurpose Disabled +``` + +This cmdlet updates PostgreSql server by identity. + +## PARAMETERS + +### -AdministratorLoginPassword +The password of the administrator login. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. +Day count is between 7 and 35. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MinimalTlsVersion +Set the minimal TLS version for connections to server when SSL is enabled. +Default is TLSEnforcementDisabled.accepted values: TLS1_0, TLS1_1, TLS1_2, TLSEnforcementDisabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Support.MinimalTlsVersionEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Enable or disable public network access + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Support.PublicNetworkAccessEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationRole +The replication role of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the sku, typically, tier + family + cores, e.g. +B_Gen4_1, GP_Gen5_8. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +The scale up/out capacity, representing server's compute units. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +The family of hardware. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +The tier of the particular SKU, e.g. +Basic. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslEnforcement +Enable ssl enforcement or not when connect to server. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Support.SslEnforcementEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAutogrow +Enable Storage Auto Grow. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Support.StorageAutogrow +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageInMb +Max storage allowed for a server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IServer + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter. + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlVirtualNetworkRule.md b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlVirtualNetworkRule.md new file mode 100644 index 0000000000..cb0321eaa0 --- /dev/null +++ b/azps-10.1.0/Az.PostgreSql/Update-AzPostgreSqlVirtualNetworkRule.md @@ -0,0 +1,298 @@ +--- +external help file: +Module Name: Az.PostgreSql +online version: https://learn.microsoft.com/powershell/module/az.postgresql/update-azpostgresqlvirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PostgreSql/help/Update-AzPostgreSqlVirtualNetworkRule.md +--- + +# Update-AzPostgreSqlVirtualNetworkRule + +## SYNOPSIS +Creates or updates an existing virtual network rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlVirtualNetworkRule -Name <String> -ResourceGroupName <String> -ServerName <String> + -SubnetId <String> [-SubscriptionId <String>] [-IgnoreMissingVnetServiceEndpoint] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlVirtualNetworkRule -InputObject <IPostgreSqlIdentity> -SubnetId <String> + [-IgnoreMissingVnetServiceEndpoint] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an existing virtual network rule. + +## EXAMPLES + +### Example 1: Update PostgreSql Virtual Network Rule by name +```powershell +$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.Network/virtualNetworks/PostgreSqlVNet/subnets/default2" +Update-AzPostgreSqlVirtualNetworkRule -Name vnet -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer -SubnetId $ID +``` + +```output +Name Type +---- ---- +vnet Microsoft.DBforPostgreSQL/servers/virtualNetworkRules +``` + +This cmdlet updates PostgreSql Virtual Network Rule by name. + +### Example 2: Update PostgreSql Virtual Network Rule by identity. +```powershell +$SubnetID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.Network/virtualNetworks/PostgreSqlVNet/subnets/default" +$VNetID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.DBforPostgreSQL/servers/PostgreSqlTestServer/virtualNetworkRules/vnet" +Update-AzPostgreSqlVirtualNetworkRule -InputObject $VNetID -SubnetId $SubnetID +``` + +```output +Name Type +---- ---- +vnet Microsoft.DBforPostgreSQL/servers/virtualNetworkRules +``` + +These cmdlets update PostgreSql Virtual Network Rule by identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreMissingVnetServiceEndpoint +Create firewall rule before the virtual network has vnet service endpoint enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the virtual network rule. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: VirtualNetworkRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The ARM resource id of the virtual network subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.IPostgreSqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSql.Models.Api20171201.IVirtualNetworkRule + +## 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 `<IPostgreSqlIdentity>`: Identity Parameter + - `[ConfigurationName <String>]`: The name of the server configuration. + - `[DatabaseName <String>]`: The name of the database. + - `[FirewallRuleName <String>]`: The name of the server firewall rule. + - `[Id <String>]`: Resource identity path + - `[LocationName <String>]`: The name of the location. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName <SecurityAlertPolicyName?>]`: The name of the security alert policy. + - `[ServerName <String>]`: The name of the server. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VirtualNetworkRuleName <String>]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.PowerBIEmbedded/Az.PowerBIEmbedded.md b/azps-10.1.0/Az.PowerBIEmbedded/Az.PowerBIEmbedded.md new file mode 100644 index 0000000000..73c6276ed3 --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/Az.PowerBIEmbedded.md @@ -0,0 +1,54 @@ +--- +Module Name: Az.PowerBIEmbedded +Module Guid: 868389ce-dd36-4f57-a674-0970db085d9a +Download Help Link: https://learn.microsoft.com/powershell/module/az.powerbiembedded +Help Version: 4.1.4.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Az.PowerBIEmbedded.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Az.PowerBIEmbedded.md +--- + +# Az.PowerBIEmbedded Module +## Description +This topic displays help topics for the Azure Power BI Embedded Cmdlets. + +## Az.PowerBIEmbedded Cmdlets +### [Get-AzPowerBIEmbeddedCapacity](Get-AzPowerBIEmbeddedCapacity.md) +Gets the details of a PowerBI Embedded Capacity. + +### [Get-AzPowerBIWorkspace](Get-AzPowerBIWorkspace.md) +Gets the workspaces in a Power BI workspace collection. + +### [Get-AzPowerBIWorkspaceCollection](Get-AzPowerBIWorkspaceCollection.md) +Gets Power BI workspace collections. + +### [Get-AzPowerBIWorkspaceCollectionAccessKey](Get-AzPowerBIWorkspaceCollectionAccessKey.md) +Gets the current access keys associated with a Power BI workspace collection. + +### [New-AzPowerBIEmbeddedCapacity](New-AzPowerBIEmbeddedCapacity.md) +Creates a new PowerBI Embedded Capacity. + +### [New-AzPowerBIWorkspaceCollection](New-AzPowerBIWorkspaceCollection.md) +Creates a Power BI workspace collection. + +### [Remove-AzPowerBIEmbeddedCapacity](Remove-AzPowerBIEmbeddedCapacity.md) +Deletes an instance of PowerBI Embedded Capacity. + +### [Remove-AzPowerBIWorkspaceCollection](Remove-AzPowerBIWorkspaceCollection.md) +Removes a Power BI workspace collection. + +### [Reset-AzPowerBIWorkspaceCollectionAccessKey](Reset-AzPowerBIWorkspaceCollectionAccessKey.md) +Resets the specified access key. + +### [Resume-AzPowerBIEmbeddedCapacity](Resume-AzPowerBIEmbeddedCapacity.md) +Resumes an instance of PowerBI Embedded Capacity. + +### [Suspend-AzPowerBIEmbeddedCapacity](Suspend-AzPowerBIEmbeddedCapacity.md) +Suspends an instance of PowerBI Embedded Capacity. + +### [Test-AzPowerBIEmbeddedCapacity](Test-AzPowerBIEmbeddedCapacity.md) +Tests the existence of an instance of PowerBI Embedded Capacity. + +### [Update-AzPowerBIEmbeddedCapacity](Update-AzPowerBIEmbeddedCapacity.md) +Modifies an instance of PowerBI Embedded Capacity. + diff --git a/azps-10.1.0/Az.PowerBIEmbedded/Get-AzPowerBIEmbeddedCapacity.md b/azps-10.1.0/Az.PowerBIEmbedded/Get-AzPowerBIEmbeddedCapacity.md new file mode 100644 index 0000000000..56a37130bd --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/Get-AzPowerBIEmbeddedCapacity.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PowerBI.dll-Help.xml +Module Name: Az.PowerBIEmbedded +ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 +online version: https://learn.microsoft.com/powershell/module/az.powerbiembedded/get-azpowerbiembeddedcapacity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Get-AzPowerBIEmbeddedCapacity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Get-AzPowerBIEmbeddedCapacity.md +--- + +# Get-AzPowerBIEmbeddedCapacity + +## SYNOPSIS +Gets the details of a PowerBI Embedded Capacity. + +## SYNTAX + +### ByCapacityOrResourceGroupOrSubscription (Default) +``` +Get-AzPowerBIEmbeddedCapacity [-ResourceGroupName <String>] [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzPowerBIEmbeddedCapacity -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzPowerBIEmbeddedCapacity cmdlet gets the details of a PowerBI Embedded Capacity. + +## EXAMPLES + +### Example 1: Get resource group capacities +```powershell +Get-AzPowerBIEmbeddedCapacity -ResourceGroupName "testRG" +``` + +```output +Type : Microsoft.PowerBIDedicated/capacities +Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity +ResourceGroup : testRG +Name : testcapacity +Location : West Central US +State : Succeeded +Administrator : {admin@microsoft.com} +Sku : A1 +Tier : PBIE_Azure +Tag : {} + +Type : Microsoft.PowerBIDedicated/capacities +Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/mycapacity +ResourceGroup : testRG +Name : mycapacity +Location : West Central US +State : Succeeded +Administrator : {admin@microsoft.com} +Sku : A4 +Tier : PBIE_Azure +Tag : {} +``` + +This command gets all Azure PowerBI Embedded Capacity in the resource group named testRG + +### Example 2: Get a capacity +```powershell +Get-AzPowerBIEmbeddedCapacity -ResourceGroupName "testRG" -Name "testcapacity" +``` + +```output +Type : Microsoft.PowerBIDedicated/capacities +Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity +ResourceGroup : testRG +Name : testcapacity +Location : West Central US +State : Succeeded +Administrator : {admin@microsoft.com} +Sku : A1 +Tier : PBIE_Azure +Tag : {} +``` + +This command gets the Azure PowerBI Embedded Capacity named testcapacity in the resource group named testRG. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the PowerBI Embedded Capacity + +```yaml +Type: System.String +Parameter Sets: ByCapacityOrResourceGroupOrSubscription +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure resource group to which the capacity belongs + +```yaml +Type: System.String +Parameter Sets: ByCapacityOrResourceGroupOrSubscription +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure resource ID + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity + +## NOTES + +## RELATED LINKS + +[New-AzPowerBIEmbeddedCapacity ](./New-AzPowerBIEmbeddedCapacity.md) + +[Remove-AzPowerBIEmbeddedCapacity ](./Remove-AzPowerBIEmbeddedCapacity.md) diff --git a/azps-10.1.0/Az.PowerBIEmbedded/Get-AzPowerBIWorkspace.md b/azps-10.1.0/Az.PowerBIEmbedded/Get-AzPowerBIWorkspace.md new file mode 100644 index 0000000000..8f750cbb0d --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/Get-AzPowerBIWorkspace.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PowerBIEmbedded.dll-Help.xml +Module Name: Az.PowerBIEmbedded +ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 +online version: https://learn.microsoft.com/powershell/module/az.powerbiembedded/get-azpowerbiworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Get-AzPowerBIWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Get-AzPowerBIWorkspace.md +--- + +# Get-AzPowerBIWorkspace + +## SYNOPSIS +Gets the workspaces in a Power BI workspace collection. + +## SYNTAX + +``` +Get-AzPowerBIWorkspace [-ResourceGroupName] <String> [-WorkspaceCollectionName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPowerBIWorkspace** cmdlet gets the workspaces in a Power BI workspace collection. + +## EXAMPLES + +### Example 1: Get workspaces of a workspace collection +```powershell +Get-AzPowerBIWorkspace -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" +``` + +This command gets the workspaces that belong to the workspace collection named WCN11 in the specified resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the workspace collection belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceCollectionName +Specifies the name of the workspace collection for which this cmdlet gets workspaces. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspace + +## NOTES + +## RELATED LINKS + +[Get-AzPowerBIWorkspaceCollection](./Get-AzPowerBIWorkspaceCollection.md) + + diff --git a/azps-10.1.0/Az.PowerBIEmbedded/Get-AzPowerBIWorkspaceCollection.md b/azps-10.1.0/Az.PowerBIEmbedded/Get-AzPowerBIWorkspaceCollection.md new file mode 100644 index 0000000000..6d7c89c22c --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/Get-AzPowerBIWorkspaceCollection.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PowerBIEmbedded.dll-Help.xml +Module Name: Az.PowerBIEmbedded +ms.assetid: EEF32F48-00F6-4C57-B4F1-B58B566EAFEF +online version: https://learn.microsoft.com/powershell/module/az.powerbiembedded/get-azpowerbiworkspacecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Get-AzPowerBIWorkspaceCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Get-AzPowerBIWorkspaceCollection.md +--- + +# Get-AzPowerBIWorkspaceCollection + +## SYNOPSIS +Gets Power BI workspace collections. + +## SYNTAX + +### ResourceGroupParameterSet +``` +Get-AzPowerBIWorkspaceCollection [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### WorkspaceCollectionNameParameterSet +``` +Get-AzPowerBIWorkspaceCollection [-ResourceGroupName] <String> [-WorkspaceCollectionName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPowerBIWorkspaceCollection** cmdlet gets Power BI workspace collections in your Azure subscription and resource group, or by collection name. + +## EXAMPLES + +### Example 1: Get all workspace collections in a resource group +```powershell +Get-AzPowerBIWorkspaceCollection -ResourceGroupName "ResourceGroup17" +``` + +This command gets the workspace collections that belong to the resource group named ResourceGroup17. + +### Example 2: Get a workspace collection by using its name +```powershell +Get-AzPowerBIWorkspaceCollection -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" +``` + +This command gets the workspace collection named WCN11 in the specified resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group from which this cmdlet gets workspace collections. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: WorkspaceCollectionNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceCollectionName +Specifies the name of the Power BI workspace collection that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: WorkspaceCollectionNameParameterSet +Aliases: Name, ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspaceCollection + +## NOTES + +## RELATED LINKS + +[New-AzPowerBIWorkspaceCollection](./New-AzPowerBIWorkspaceCollection.md) + +[Remove-AzPowerBIWorkspaceCollection](./Remove-AzPowerBIWorkspaceCollection.md) + + diff --git a/azps-10.1.0/Az.PowerBIEmbedded/Get-AzPowerBIWorkspaceCollectionAccessKey.md b/azps-10.1.0/Az.PowerBIEmbedded/Get-AzPowerBIWorkspaceCollectionAccessKey.md new file mode 100644 index 0000000000..eda9c093c2 --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/Get-AzPowerBIWorkspaceCollectionAccessKey.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PowerBIEmbedded.dll-Help.xml +Module Name: Az.PowerBIEmbedded +ms.assetid: 3FED0088-47DA-4565-B9F0-DACF9B2DC0C7 +online version: https://learn.microsoft.com/powershell/module/az.powerbiembedded/get-azpowerbiworkspacecollectionaccesskey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Get-AzPowerBIWorkspaceCollectionAccessKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Get-AzPowerBIWorkspaceCollectionAccessKey.md +--- + +# Get-AzPowerBIWorkspaceCollectionAccessKey + +## SYNOPSIS +Gets the current access keys associated with a Power BI workspace collection. + +## SYNTAX + +``` +Get-AzPowerBIWorkspaceCollectionAccessKey [-ResourceGroupName] <String> [-WorkspaceCollectionName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPowerBIWorkspaceCollectionAccessKey** cmdlet gets the current access keys associated with a Power BI workspace collection. + +## EXAMPLES + +### Example 1: Get access keys +```powershell +Get-AzPowerBIWorkspaceCollectionAccessKey -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" +``` + +This command gets access keys for the workspace collection named WCN11 in the specified resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the collection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceCollectionName +Specifies the name of the Power BI workspace collection on which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspaceCollectionAccessKey + +## NOTES + +## RELATED LINKS + +[Reset-AzPowerBIWorkspaceCollectionAccessKey](./Reset-AzPowerBIWorkspaceCollectionAccessKey.md) + + diff --git a/azps-10.1.0/Az.PowerBIEmbedded/New-AzPowerBIEmbeddedCapacity.md b/azps-10.1.0/Az.PowerBIEmbedded/New-AzPowerBIEmbeddedCapacity.md new file mode 100644 index 0000000000..c3ecf774c1 --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/New-AzPowerBIEmbeddedCapacity.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PowerBI.dll-Help.xml +Module Name: Az.PowerBIEmbedded +ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 +online version: https://learn.microsoft.com/powershell/module/az.powerbiembedded/new-azpowerbiembeddedcapacity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/New-AzPowerBIEmbeddedCapacity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/New-AzPowerBIEmbeddedCapacity.md +--- + +# New-AzPowerBIEmbeddedCapacity + +## SYNOPSIS +Creates a new PowerBI Embedded Capacity. + +## SYNTAX + +``` +New-AzPowerBIEmbeddedCapacity [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + [-Sku] <String> [-Administrator] <String[]> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzPowerBIEmbeddedCapacity cmdlet creates a new PowerBI Embedded Capacity + +## EXAMPLES + +### Example 1 +```powershell +New-AzPowerBIEmbeddedCapacity -ResourceGroupName "testRG" -Name "testcapacity" -Location "West Central US" -Sku "A1" -Administrator admin@microsoft.com +``` + +```output +Type : Microsoft.PowerBIDedicated/capacities +Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity +ResourceGroup : testRG +Name : testcapacity +Location : West Central US +State : Succeeded +Administrator : {admin@microsoft.com} +Sku : A1 +Tier : PBIE_Azure +Tag : {} +``` + +Creates a capacity named testcapacity in the Azure region West Central US and in resource group testRG. The sku level for the capacity will be A1. + +## PARAMETERS + +### -Administrator +A comma separated names to set as administrator on the capacity + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The Azure region where the PowerBI Embedded Capacity is hosted + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the PowerBI Embedded Capacity + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure resource group to which the capacity belongs + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +The name of the Sku for the capacity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: A1, A2, A3, A4, A5, A6, A7, A8 + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table set as tags on the capacity. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts user to confirm whether to perform the operation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes the actions the current operation will perform without actually performing them + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity + +## NOTES + +## RELATED LINKS + +[Get-AzPowerBIEmbeddedCapacity](./Get-AzPowerBIEmbeddedCapacity.md) + +[Remove-AzPowerBIEmbeddedCapacity](./Remove-AzPowerBIEmbeddedCapacity.md) diff --git a/azps-10.1.0/Az.PowerBIEmbedded/New-AzPowerBIWorkspaceCollection.md b/azps-10.1.0/Az.PowerBIEmbedded/New-AzPowerBIWorkspaceCollection.md new file mode 100644 index 0000000000..e3aa0d5996 --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/New-AzPowerBIWorkspaceCollection.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PowerBIEmbedded.dll-Help.xml +Module Name: Az.PowerBIEmbedded +ms.assetid: 9F9E4273-6747-4963-AF1F-C0AEB46770A4 +online version: https://learn.microsoft.com/powershell/module/az.powerbiembedded/new-azpowerbiworkspacecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/New-AzPowerBIWorkspaceCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/New-AzPowerBIWorkspaceCollection.md +--- + +# New-AzPowerBIWorkspaceCollection + +## SYNOPSIS +Creates a Power BI workspace collection. + +## SYNTAX + +``` +New-AzPowerBIWorkspaceCollection [-ResourceGroupName] <String> [-WorkspaceCollectionName] <String> + [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPowerBIWorkspaceCollection** cmdlet creates a Power BI workspace collection for your Azure subscription in the specified resource group and location. + +## EXAMPLES + +### Example 1: Create a workspace collection +```powershell +New-AzPowerBIWorkspaceCollection -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" -Location "Japan West" +``` + +This command creates a workspace collection named WCN11 in the specified resource group in the specified location. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the Azure location in which this cmdlet creates a workspace collection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group in which this cmdlet creates a workspace collection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceCollectionName +Specifies a name for the Power BI workspace collection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspaceCollection + +## NOTES + +## RELATED LINKS + +[Get-AzPowerBIWorkspaceCollection](./Get-AzPowerBIWorkspaceCollection.md) + +[Remove-AzPowerBIWorkspaceCollection](./Remove-AzPowerBIWorkspaceCollection.md) + + diff --git a/azps-10.1.0/Az.PowerBIEmbedded/Remove-AzPowerBIEmbeddedCapacity.md b/azps-10.1.0/Az.PowerBIEmbedded/Remove-AzPowerBIEmbeddedCapacity.md new file mode 100644 index 0000000000..3ba51b288f --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/Remove-AzPowerBIEmbeddedCapacity.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PowerBI.dll-Help.xml +Module Name: Az.PowerBIEmbedded +ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 +online version: https://learn.microsoft.com/powershell/module/az.powerbiembedded/remove-azpowerbiembeddedcapacity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Remove-AzPowerBIEmbeddedCapacity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Remove-AzPowerBIEmbeddedCapacity.md +--- + +# Remove-AzPowerBIEmbeddedCapacity + +## SYNOPSIS +Deletes an instance of PowerBI Embedded Capacity. + +## SYNTAX + +### ByNameAndResourceGroup (Default) +``` +Remove-AzPowerBIEmbeddedCapacity [-Name] <String> [-ResourceGroupName <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzPowerBIEmbeddedCapacity [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzPowerBIEmbeddedCapacity [-InputObject] <PSPowerBIEmbeddedCapacity> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzPowerBIEmbeddedCapacity cmdlet deletes an instance of PowerBI Embedded Capacity + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzPowerBIEmbeddedCapacity -Name "testcapacity" -ResourceGroupName "testRG" +``` + +```output +Type : Microsoft.PowerBIDedicated/capacities +Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity +ResourceGroup : testRG +Name : testcapacity +Location : West Central US +State : Succeeded +Administrator : {admin@microsoft.com} +Sku : A1 +Tier : PBIE_Azure +Tag : {} +``` + +This command will remove the capacity named testcapacity in the resourcegroup testRG + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input object for Piping + +```yaml +Type: Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the PowerBI Embedded Capacity + +```yaml +Type: System.String +Parameter Sets: ByNameAndResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure resource group to which the capacity belongs + +```yaml +Type: System.String +Parameter Sets: ByNameAndResourceGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure resource ID + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts user to confirm whether to perform the operation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes the actions the current operation will perform without actually performing them + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity + +## OUTPUTS + +### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity + +## NOTES + +## RELATED LINKS + +[Get-AzPowerBIEmbeddedCapacity](./Get-AzPowerBIEmbeddedCapacity.md) + +[New-AzPowerBIEmbeddedCapacity](./New-AzPowerBIEmbeddedCapacity.md) diff --git a/azps-10.1.0/Az.PowerBIEmbedded/Remove-AzPowerBIWorkspaceCollection.md b/azps-10.1.0/Az.PowerBIEmbedded/Remove-AzPowerBIWorkspaceCollection.md new file mode 100644 index 0000000000..df49f38152 --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/Remove-AzPowerBIWorkspaceCollection.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PowerBIEmbedded.dll-Help.xml +Module Name: Az.PowerBIEmbedded +ms.assetid: 2D63CC6D-AB02-4299-A922-4057D6F595D7 +online version: https://learn.microsoft.com/powershell/module/az.powerbiembedded/remove-azpowerbiworkspacecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Remove-AzPowerBIWorkspaceCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Remove-AzPowerBIWorkspaceCollection.md +--- + +# Remove-AzPowerBIWorkspaceCollection + +## SYNOPSIS +Removes a Power BI workspace collection. + +## SYNTAX + +``` +Remove-AzPowerBIWorkspaceCollection [-ResourceGroupName] <String> [-WorkspaceCollectionName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPowerBIWorkspaceCollection** cmdlet removes a Power BI workspace collection from your Azure subscription and resource group. + +## EXAMPLES + +### Example 1: Remove a workspace collection +```powershell +Remove-AzPowerBIWorkspaceCollection -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" +``` + +This command removes the workspace collection named WCN11 in the specified resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group from which this cmdlet removes a workspace collection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceCollectionName +Specifies the name of the Power BI workspace collection that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzPowerBIWorkspaceCollection](./Get-AzPowerBIWorkspaceCollection.md) + +[New-AzPowerBIWorkspaceCollection](./New-AzPowerBIWorkspaceCollection.md) + + diff --git a/azps-10.1.0/Az.PowerBIEmbedded/Reset-AzPowerBIWorkspaceCollectionAccessKey.md b/azps-10.1.0/Az.PowerBIEmbedded/Reset-AzPowerBIWorkspaceCollectionAccessKey.md new file mode 100644 index 0000000000..901885511a --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/Reset-AzPowerBIWorkspaceCollectionAccessKey.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PowerBIEmbedded.dll-Help.xml +Module Name: Az.PowerBIEmbedded +ms.assetid: 8FB2D9A0-BF7A-482D-B3A2-566FCA8C62A1 +online version: https://learn.microsoft.com/powershell/module/az.powerbiembedded/reset-azpowerbiworkspacecollectionaccesskey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Reset-AzPowerBIWorkspaceCollectionAccessKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Reset-AzPowerBIWorkspaceCollectionAccessKey.md +--- + +# Reset-AzPowerBIWorkspaceCollectionAccessKey + +## SYNOPSIS +Resets the specified access key. + +## SYNTAX + +``` +Reset-AzPowerBIWorkspaceCollectionAccessKey [-ResourceGroupName] <String> [-WorkspaceCollectionName] <String> + [-Key1] [-Key2] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Reset-AzPowerBIWorkspaceCollectionAccessKey** cmdlet resets the specified access key in your Power BI workspace collection. + +## EXAMPLES + +### Example 1: Reset the primary access key +```powershell +Reset-AzPowerBIWorkspaceCollectionAccessKey -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" -Key1 +``` + +This command resets the primary access key for the workspace collection named WCN11 in the specified resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Key1 +Indicates that this cmdlet resets the primary access key. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Key2 +Indicates that this cmdlet resets the secondary access key. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the collection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceCollectionName +Specifies the name of the Power BI workspace collection on which this cmdlet operates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, ResourceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspaceCollectionAccessKey + +## NOTES + +## RELATED LINKS + +[Get-AzPowerBIWorkspaceCollectionAccessKey](./Get-AzPowerBIWorkspaceCollectionAccessKey.md) + + diff --git a/azps-10.1.0/Az.PowerBIEmbedded/Resume-AzPowerBIEmbeddedCapacity.md b/azps-10.1.0/Az.PowerBIEmbedded/Resume-AzPowerBIEmbeddedCapacity.md new file mode 100644 index 0000000000..ce17fc57f6 --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/Resume-AzPowerBIEmbeddedCapacity.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PowerBI.dll-Help.xml +Module Name: Az.PowerBIEmbedded +ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 +online version: https://learn.microsoft.com/powershell/module/az.powerbiembedded/resume-azpowerbiembeddedcapacity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Resume-AzPowerBIEmbeddedCapacity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Resume-AzPowerBIEmbeddedCapacity.md +--- + +# Resume-AzPowerBIEmbeddedCapacity + +## SYNOPSIS +Resumes an instance of PowerBI Embedded Capacity. + +## SYNTAX + +### ByNameAndResourceGroup (Default) +``` +Resume-AzPowerBIEmbeddedCapacity [-Name] <String> [-ResourceGroupName <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Resume-AzPowerBIEmbeddedCapacity [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Resume-AzPowerBIEmbeddedCapacity [-InputObject] <PSPowerBIEmbeddedCapacity> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Resume-AzPowerBIEmbeddedCapacity cmdlet resumes an instance of PowerBI Embedded Capacity + +## EXAMPLES + +### Example 1 +```powershell +Resume-AzPowerBIEmbeddedCapacity -Name "testcapacity" -ResourceGroupName "testRG" -PassThru +``` + +```output +Type : Microsoft.PowerBIDedicated/capacities +Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity +ResourceGroup : testRG +Name : testcapacity +Location : West Central US +State : Succeeded +Administrator : {admin@microsoft.com} +Sku : A1 +Tier : PBIE_Azure +Tag : {} +``` + +This command will resume a paused capacity named testcapacity in the resourcegroup testRG + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input object for Piping + +```yaml +Type: Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the PowerBI Embedded Capacity + +```yaml +Type: System.String +Parameter Sets: ByNameAndResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure resource group to which the capacity belongs + +```yaml +Type: System.String +Parameter Sets: ByNameAndResourceGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure resource ID + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts user to confirm whether to perform the operation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes the actions the current operation will perform without actually performing them + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity + +## OUTPUTS + +### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity + +## NOTES + +## RELATED LINKS + +[Get-AzPowerBIEmbeddedCapacity](./Get-AzPowerBIEmbeddedCapacity.md) + +[Suspend-AzPowerBIEmbeddedCapacity](./Suspend-AzPowerBIEmbeddedCapacity.md) diff --git a/azps-10.1.0/Az.PowerBIEmbedded/Suspend-AzPowerBIEmbeddedCapacity.md b/azps-10.1.0/Az.PowerBIEmbedded/Suspend-AzPowerBIEmbeddedCapacity.md new file mode 100644 index 0000000000..e29c7bd489 --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/Suspend-AzPowerBIEmbeddedCapacity.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PowerBI.dll-Help.xml +Module Name: Az.PowerBIEmbedded +ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 +online version: https://learn.microsoft.com/powershell/module/az.powerbiembedded/suspend-azpowerbiembeddedcapacity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Suspend-AzPowerBIEmbeddedCapacity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Suspend-AzPowerBIEmbeddedCapacity.md +--- + +# Suspend-AzPowerBIEmbeddedCapacity + +## SYNOPSIS +Suspends an instance of PowerBI Embedded Capacity. + +## SYNTAX + +### ByNameAndResourceGroup (Default) +``` +Suspend-AzPowerBIEmbeddedCapacity [-Name] <String> [-ResourceGroupName <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Suspend-AzPowerBIEmbeddedCapacity [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Suspend-AzPowerBIEmbeddedCapacity [-InputObject] <PSPowerBIEmbeddedCapacity> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Suspend-AzPowerBIEmbeddedCapacity cmdlet suspends an instance of PowerBI Embedded Capacity + +## EXAMPLES + +### Example 1 +```powershell +Suspend-AzPowerBIEmbeddedCapacity -Name "testcapacity" -ResourceGroupName "testRG" -PassThru +``` + +```output +Type : Microsoft.PowerBIDedicated/capacities +Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity +ResourceGroup : testRG +Name : testcapacity +Location : West Central US +State : Paused +Administrator : {admin@microsoft.com} +Sku : A1 +Tier : PBIE_Azure +Tag : {} +``` + +This command will suspend an active capacity named testcapacity in the resourcegroup testgroup + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input object for Piping + +```yaml +Type: Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the PowerBI Embedded Capacity + +```yaml +Type: System.String +Parameter Sets: ByNameAndResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure resource group to which the capacity belongs + +```yaml +Type: System.String +Parameter Sets: ByNameAndResourceGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure resource ID + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts user to confirm whether to perform the operation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes the actions the current operation will perform without actually performing them + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity + +## OUTPUTS + +### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity + +## NOTES + +## RELATED LINKS + +[Get-AzPowerBIEmbeddedCapacity](./Get-AzPowerBIEmbeddedCapacity.md) + +[Resume-AzPowerBIEmbeddedCapacity](./Resume-AzPowerBIEmbeddedCapacity.md) + diff --git a/azps-10.1.0/Az.PowerBIEmbedded/Test-AzPowerBIEmbeddedCapacity.md b/azps-10.1.0/Az.PowerBIEmbedded/Test-AzPowerBIEmbeddedCapacity.md new file mode 100644 index 0000000000..af0ebd8c29 --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/Test-AzPowerBIEmbeddedCapacity.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PowerBI.dll-Help.xml +Module Name: Az.PowerBIEmbedded +ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 +online version: https://learn.microsoft.com/powershell/module/az.powerbiembedded/test-azpowerbiembeddedcapacity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Test-AzPowerBIEmbeddedCapacity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Test-AzPowerBIEmbeddedCapacity.md +--- + +# Test-AzPowerBIEmbeddedCapacity + +## SYNOPSIS +Tests the existence of an instance of PowerBI Embedded Capacity. + +## SYNTAX + +``` +Test-AzPowerBIEmbeddedCapacity [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Test-AzPowerBIEmbeddedCapacity cmdlet tests the existence of an instance of PowerBI Embedded Capacity + +## EXAMPLES + +### Example 1 +```powershell +Test-AzPowerBIEmbeddedCapacity -Name "testcapacity" +``` + +```output +True +``` + +This command will test if there is a capacity named testcapacity + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the PowerBI Embedded Capacity + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzPowerBIEmbeddedCapacity](./Get-AzPowerBIEmbeddedCapacity.md) + +[Remove-AzPowerBIEmbeddedCapacity](./Remove-AzPowerBIEmbeddedCapacity.md) diff --git a/azps-10.1.0/Az.PowerBIEmbedded/Update-AzPowerBIEmbeddedCapacity.md b/azps-10.1.0/Az.PowerBIEmbedded/Update-AzPowerBIEmbeddedCapacity.md new file mode 100644 index 0000000000..271aab2ac4 --- /dev/null +++ b/azps-10.1.0/Az.PowerBIEmbedded/Update-AzPowerBIEmbeddedCapacity.md @@ -0,0 +1,251 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PowerBI.dll-Help.xml +Module Name: Az.PowerBIEmbedded +ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 +online version: https://learn.microsoft.com/powershell/module/az.powerbiembedded/update-azpowerbiembeddedcapacity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Update-AzPowerBIEmbeddedCapacity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PowerBIEmbedded/PowerBIEmbedded/help/Update-AzPowerBIEmbeddedCapacity.md +--- + +# Update-AzPowerBIEmbeddedCapacity + +## SYNOPSIS +Modifies an instance of PowerBI Embedded Capacity. + +## SYNTAX + +### ByNameAndResourceGroup (Default) +``` +Update-AzPowerBIEmbeddedCapacity [-Name] <String> [-ResourceGroupName <String>] [-Sku <String>] + [-Tag <Hashtable>] [-Administrator <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Update-AzPowerBIEmbeddedCapacity [-Sku <String>] [-Tag <Hashtable>] [-Administrator <String[]>] + [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObject +``` +Update-AzPowerBIEmbeddedCapacity [-Sku <String>] [-Tag <Hashtable>] [-Administrator <String[]>] + [-InputObject] <PSPowerBIEmbeddedCapacity> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Update-AzPowerBIEmbeddedCapacity cmdlet modifies an instance of PowerBI Embedded Capacity + +## EXAMPLES + +### Example 1 +```powershell +Update-AzPowerBIEmbeddedCapacity -Name "testcapacity" -Tag @{"key1" = "value1";"key2" = "value2"} -Administrator "testuser1@contoso.com", "testuser2@contoso.com", "9035a021-a96f-43ea-acbf-864227c2abbb@45119f4f-c71b-4420-b6ec-60e503450098" -PassThru +``` + +```output +Type : Microsoft.PowerBIDedicated/capacities +Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity +ResourceGroup : testRG +Name : testcapacity +Location : West Central US +State : Succeeded +Administrator : {testuser1@contoso.com, testuser2@contoso.com, 9035a021-a96f-43ea-acbf-864227c2abbb@45119f4f-c71b-4420-b6ec-60e503450098} +Sku : A1 +Tier : PBIE_Azure +Tag : {[key1, value1], [key2, value2]} +``` + +Modifies the capacity named testcapacity in resourcegroup testgroup to set the tags as key1:value1 and key2:value2 and administrator to testuser1@contoso.com , testuser2@contoso.com and the service principal: 9035a021-a96f-43ea-acbf-864227c2abbb@45119f4f-c71b-4420-b6ec-60e503450098 + +## PARAMETERS + +### -Administrator +A comma separated names to set as administrators on the capacity. For service principal: `<service principal object id>@<tenant id>` + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input object for Piping + +```yaml +Type: Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the PowerBI Embedded Capacity + +```yaml +Type: System.String +Parameter Sets: ByNameAndResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Azure resource group to which the capacity belongs + +```yaml +Type: System.String +Parameter Sets: ByNameAndResourceGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +PowerBI Embedded Capacity ResourceID. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +The name of the Sku for the capacity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: A1, A2, A3, A4, A5, A6, A7, A8 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table set as tags on the capacity. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts user to confirm whether to perform the operation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes the actions the current operation will perform without actually performing them + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity + +## OUTPUTS + +### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity + +## NOTES + +## RELATED LINKS + +[Get-AzPowerBIEmbeddedCapacity](./Get-AzPowerBIEmbeddedCapacity.md) + +[Remove-AzPowerBIEmbeddedCapacity](./Remove-AzPowerBIEmbeddedCapacity.md) diff --git a/azps-10.1.0/Az.PrivateDns/Add-AzPrivateDnsRecordConfig.md b/azps-10.1.0/Az.PrivateDns/Add-AzPrivateDnsRecordConfig.md new file mode 100644 index 0000000000..b7ebbb5623 --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/Add-AzPrivateDnsRecordConfig.md @@ -0,0 +1,471 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +online version: https://learn.microsoft.com/powershell/module/az.privatedns/add-azprivatednsrecordconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Add-AzPrivateDnsRecordConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Add-AzPrivateDnsRecordConfig.md +--- + +# Add-AzPrivateDnsRecordConfig + +## SYNOPSIS +Adds a Private DNS record to a local record set object. + +## SYNTAX + +### A (Default) +``` +Add-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Ipv4Address <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AAAA +``` +Add-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Ipv6Address <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### MX +``` +Add-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Exchange <String> -Preference <UInt16> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PTR +``` +Add-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Ptrdname <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### TXT +``` +Add-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Value <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SRV +``` +Add-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Priority <UInt16> -Target <String> + -Port <UInt16> -Weight <UInt16> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### CNAME +``` +Add-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Cname <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Add-AzPrivateDnsRecordConfig cmdlet adds a Private Domain Name System (DNS) record to a RecordSet object. The RecordSet object is an offline object, and changes to it do not change the Private DNS responses until after you run the Set-AzPrivateDnsRecordSet cmdlet to persist the change to the Microsoft Azure Private DNS service. SOA records are created when a Private DNS zone is created, and are removed when the Private DNS zone is deleted. You cannot add or remove SOA records, but you can edit them. You can pass the RecordSet object to this cmdlet as a parameter or by using the pipeline operator. + +## EXAMPLES + +### Example 1: Add an A record to a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name www -RecordType A -ResourceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzPrivateDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# You can also pipe the above sequence: + +Get-AzPrivateDnsRecordSet -Name www -RecordType A -ResourceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzPrivateDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/A/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {1.2.3.4} +Metadata : +IsAutoRegistered : +``` + +This example adds an A record to an existing record set. + +### Example 2: Add an AAAA record to a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name www -RecordType AAAAA -ResourceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzPrivateDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# You can also pipe the above sequence: + +Get-AzPrivateDnsRecordSet -Name www -RecordType AAAAA -ResourceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzPrivateDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/AAAA/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : AAAA +Records : {2001:DB80:4009:1803::1005} +Metadata : +IsAutoRegistered : +``` + +This example adds an AAAAA record to an existing record set. + +### Example 3: Add a CNAME record to a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name www -RecordType CNAME -ResourceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzPrivateDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# You can also pipe the above sequence: + +Get-AzPrivateDnsRecordSet -Name www -RecordType CNAME -ResourceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzPrivateDnsRecordConfig -Cname contoso.com | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/CNAME/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : CNAME +Records : {www.contoso.com} +Metadata : +IsAutoRegistered : +``` + +This example adds a CNAME record to an existing record set. + +### Example 4: Add a MX record to a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name "@" -RecordType MX -ResourceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzPrivateDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# You can also pipe the above sequence: + +Get-AzPrivateDnsRecordSet -Name "@" -RecordType MX -ResourceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzPrivateDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/MX/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : MX +Records : {[5,mail.microsoft.com]} +Metadata : +IsAutoRegistered : +``` + +This example adds a MX record to an existing record set. + +### Example 5: Add a PTR record to a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name 4 -RecordType PTR -ResourceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa +Add-AzPrivateDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# You can also pipe the above sequence: + +Get-AzPrivateDnsRecordSet -Name 4 -RecordType PTR -ResourceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa | Add-AzPrivateDnsRecordConfig -Ptrdname www.contoso.com | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/3.2.1.in-addr.arpa/PTR/4 +Name : 4 +ZoneName : 3.2.1.in-addr.arpa +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : PTR +Records : {www.contoso.com} +Metadata : +IsAutoRegistered : +``` + +This example adds a PTR record to an existing record set. + +### Example 6: Add a SRV record to a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name _sip._tcp -RecordType SRV -ResourceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzPrivateDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# You can also pipe the above sequence: + +Get-AzPrivateDnsRecordSet -Name _sip._tcp -RecordType SRV -ResourceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzPrivateDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/SRV/_sip._tcp +Name : _sip._tcp +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : SRV +Records : {[0,5,8080,sipservice.contoso.com]} +Metadata : +IsAutoRegistered : +``` + +This example adds a SRV record to an existing record set. + +### Example 7: Add a TXT record to a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name text -RecordType TXT -ResourceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzPrivateDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# You can also pipe the above sequence: + +Get-AzPrivateDnsRecordSet -Name text -RecordType TXT -ResourceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzPrivateDnsRecordConfig -Value "This is a TXT Record" | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/TXT/text +Name : text +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : TXT +Records : {This is a TXT Record} +Metadata : +IsAutoRegistered : +``` + +This example adds a TXT record to an existing record set. + +## PARAMETERS + +### -Cname +The canonical name for the CNAME record to add. +Must not be relative to the name of the zone. +Must not have a terminating dot + +```yaml +Type: System.String +Parameter Sets: CNAME +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exchange +The mail exchange host for the MX record to add. +Must not be relative to the name of the zone. +Must not have a terminating dot + +```yaml +Type: System.String +Parameter Sets: MX +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ipv4Address +The IPv4 address for the A record to add. + +```yaml +Type: System.String +Parameter Sets: A +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ipv6Address +The IPv6 address for the AAAA record to add. + +```yaml +Type: System.String +Parameter Sets: AAAA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +The port number for the SRV record to add. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Preference +The preference value for the MX record to add. + +```yaml +Type: System.UInt16 +Parameter Sets: MX +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The priority value SRV record to add. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ptrdname +The target host for the PTR record to add. +Must not be relative to the name of the zone. +Must not have a terminating dot + +```yaml +Type: System.String +Parameter Sets: PTR +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordSet +The record set in which to add the record. + +```yaml +Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Target +The target host for the SRV record to add. +Must not be relative to the name of the zone. +Must not have a terminating dot + +```yaml +Type: System.String +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The text value for the TXT record to add. + +```yaml +Type: System.String +Parameter Sets: TXT +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Weight +The weight value for the SRV record to add. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet + +## OUTPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.PrivateDns/Az.PrivateDNS.md b/azps-10.1.0/Az.PrivateDns/Az.PrivateDNS.md new file mode 100644 index 0000000000..69a0374745 --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/Az.PrivateDNS.md @@ -0,0 +1,60 @@ +--- +Module Name: Az.PrivateDns +Module Guid: f9850afe-b631-4369-ab61-eca7023f2f53 +Download Help Link: https://learn.microsoft.com/powershell/module/az.privatedns +Help Version: 1.0.0 +Locale: +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Az.PrivateDNS.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Az.PrivateDNS.md +--- + +# Az.PrivateDns Module +## Description +This topic displays help topics for the Azure private DNS Cmdlets. + +## Az.PrivateDns Cmdlets +### [Add-AzPrivateDnsRecordConfig](Add-AzPrivateDnsRecordConfig.md) +Adds a Private DNS record to a local record set object. + +### [Get-AzPrivateDnsRecordSet](Get-AzPrivateDnsRecordSet.md) +Gets a record set from a Private DNS zone. + +### [Get-AzPrivateDnsVirtualNetworkLink](Get-AzPrivateDnsVirtualNetworkLink.md) +Gets a virtual network link associated with the specified Private DNS zone. + +### [Get-AzPrivateDnsZone](Get-AzPrivateDnsZone.md) +Gets a Private DNS zone. + +### [New-AzPrivateDnsRecordConfig](New-AzPrivateDnsRecordConfig.md) +Creates a new Private DNS record local object. + +### [New-AzPrivateDnsRecordSet](New-AzPrivateDnsRecordSet.md) +Creates a record set in a Private DNS zone. + +### [New-AzPrivateDnsVirtualNetworkLink](New-AzPrivateDnsVirtualNetworkLink.md) +Creates a new private DNS virtual network link. + +### [New-AzPrivateDnsZone](New-AzPrivateDnsZone.md) +Creates a new private DNS zone. + +### [Remove-AzPrivateDnsRecordConfig](Remove-AzPrivateDnsRecordConfig.md) +Removes a Private DNS record from a local record set object. + +### [Remove-AzPrivateDnsRecordSet](Remove-AzPrivateDnsRecordSet.md) +Deletes a record set from a Private DNS zone. + +### [Remove-AzPrivateDnsVirtualNetworkLink](Remove-AzPrivateDnsVirtualNetworkLink.md) +Removes a virtual network link from a resource group. + +### [Remove-AzPrivateDnsZone](Remove-AzPrivateDnsZone.md) +Removes a private DNS zone from a resource group. + +### [Set-AzPrivateDnsRecordSet](Set-AzPrivateDnsRecordSet.md) +Updates/Sets a record set in a Private DNS zone. + +### [Set-AzPrivateDnsVirtualNetworkLink](Set-AzPrivateDnsVirtualNetworkLink.md) +Updates/Sets a virtual network link associated with a private zone and a resource group. + +### [Set-AzPrivateDnsZone](Set-AzPrivateDnsZone.md) +Updates a Private DNS zone from a resource group. + diff --git a/azps-10.1.0/Az.PrivateDns/Get-AzPrivateDnsRecordSet.md b/azps-10.1.0/Az.PrivateDns/Get-AzPrivateDnsRecordSet.md new file mode 100644 index 0000000000..3f6051829f --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/Get-AzPrivateDnsRecordSet.md @@ -0,0 +1,315 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +online version: https://learn.microsoft.com/powershell/module/az.privatedns/get-azprivatednsrecordset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Get-AzPrivateDnsRecordSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Get-AzPrivateDnsRecordSet.md +--- + +# Get-AzPrivateDnsRecordSet + +## SYNOPSIS +Gets a record set from a Private DNS zone. + +## SYNTAX + +### FieldsWithNoName (Default) +``` +Get-AzPrivateDnsRecordSet -ResourceGroupName <String> -ZoneName <String> [-RecordType <RecordType>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Fields +``` +Get-AzPrivateDnsRecordSet -ResourceGroupName <String> -ZoneName <String> -Name <String> + -RecordType <RecordType> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Object +``` +Get-AzPrivateDnsRecordSet -Zone <PSPrivateDnsZone> -Name <String> -RecordType <RecordType> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ObjectWithNoName +``` +Get-AzPrivateDnsRecordSet -Zone <PSPrivateDnsZone> [-RecordType <RecordType>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzPrivateDnsRecordSet -ParentResourceId <String> -Name <String> -RecordType <RecordType> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdWithNoName +``` +Get-AzPrivateDnsRecordSet -ParentResourceId <String> [-RecordType <RecordType>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzPrivateDnsRecordSet cmdlet gets the Private Domain Name System (DNS) record set with the specified name and type, in the specified private zone. If you do not specify the Name or RecordType parameters, this cmdlet returns all record sets of the specified type in the private zone. If you specify the RecordType parameter but not the Name parameter, this cmdlet returns all record sets of the specified record type. You can use the pipeline operator to pass a PSPrivateDnsZone object to this cmdlet, or you can pass a PSPrivateDnsZone object as the Zone parameter, or alternatively you can specify the zone and resource group by name. You can also specify the private zone using the Resource Id of the private zone. + +## EXAMPLES + +### Example 1: Get record sets with a specified name and type +```powershell +Get-AzPrivateDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -Name "www" -RecordType A +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/AAAA/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {1.2.3.4} +Metadata : +IsAutoRegistered : +``` + +This command gets the record set of record type A named www in the specified resource group and private zone, and then stores it in the $RecordSet variable. Because the Name and RecordType parameters are specified, only one RecordSet object is returned. + +### Example 2: Get record sets of a specified type +```powershell +Get-AzPrivateDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -RecordType A +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/AAAA/www1 +Name : www1 +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {1.2.3.4} +Metadata : +IsAutoRegistered : + +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/AAAA/www2 +Name : www2 +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {2.3.4.5} +Metadata : +IsAutoRegistered : +``` + +This command gets an array of all record sets of record type A in the private zone named myzone.com in the resource group named MyResourceGroup, and then stores them in the $RecordSets variable. + +### Example 3: Get all record sets in a private zone +```powershell +Get-AzPrivateDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/AAAA/www1 +Name : www1 +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {1.2.3.4} +Metadata : +IsAutoRegistered : + +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/AAAA/www1 +Name : www1 +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : AAAA +Records : {2001:DB80:4009:1803::1005} +Metadata : +IsAutoRegistered : +``` + +This command gets an array of all record sets in the private zone named myzone.com in the resource group named MyResourceGroup, and then stores them in the $RecordSets variable. + +### Example 4: Get all record sets in a private zone, using a PSPrivateDnsZone object +```powershell +$Zone = Get-AzPrivateDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" +Get-AzPrivateDnsRecordSet -Zone $Zone +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/AAAA/www1 +Name : www1 +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {1.2.3.4} +Metadata : +IsAutoRegistered : + +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/AAAA/www1 +Name : www1 +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : AAAA +Records : {2001:DB80:4009:1803::1005} +Metadata : +IsAutoRegistered : +``` + +This example is equivalent to Example 3 above. This time, the private zone is specified using a private zone object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the records in this record set (relative to the name of the zone and without a terminating dot). + +```yaml +Type: System.String +Parameter Sets: Fields, Object, ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceId +Private DNS Zone ResourceID. + +```yaml +Type: System.String +Parameter Sets: ResourceId, ResourceIdWithNoName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecordType +The type of DNS records in this record set. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.PrivateDns.Models.RecordType] +Parameter Sets: FieldsWithNoName, ObjectWithNoName, ResourceIdWithNoName +Aliases: +Accepted values: A, AAAA, CNAME, MX, PTR, SOA, SRV, TXT + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.PrivateDns.Models.RecordType] +Parameter Sets: Fields, Object, ResourceId +Aliases: +Accepted values: A, AAAA, CNAME, MX, PTR, SOA, SRV, TXT + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group to which the zone belongs. + +```yaml +Type: System.String +Parameter Sets: FieldsWithNoName, Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +The DnsZone object representing the zone in which to create the record set. + +```yaml +Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone +Parameter Sets: Object, ObjectWithNoName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ZoneName +The zone in which to create the record set (without a terminating dot). + +```yaml +Type: System.String +Parameter Sets: FieldsWithNoName, Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.PrivateDns/Get-AzPrivateDnsVirtualNetworkLink.md b/azps-10.1.0/Az.PrivateDns/Get-AzPrivateDnsVirtualNetworkLink.md new file mode 100644 index 0000000000..b728bfe432 --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/Get-AzPrivateDnsVirtualNetworkLink.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +ms.assetid: B831ABE6-348C-4DD6-9295-18D23A1FDF63 +online version: https://learn.microsoft.com/powershell/module/az.privatedns/get-azprivatednsvirtualnetworklink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Get-AzPrivateDnsVirtualNetworkLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Get-AzPrivateDnsVirtualNetworkLink.md +--- + +# Get-AzPrivateDnsVirtualNetworkLink + +## SYNOPSIS +Gets a virtual network link associated with the specified Private DNS zone. + +## SYNTAX + +``` +Get-AzPrivateDnsVirtualNetworkLink -ResourceGroupName <String> -ZoneName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPrivateDnsVirtualNetworkLink** cmdlet gets virtual network links associated with a particular Private DNS zone from the specified resource group. +If you specify the *Name* parameter, a single **PSPrivateDnsVirtualNetworkLink** object is returned. +If you do not specify the *Name* parameter, an array containing all of the links associated with the zone in the specified resource group is returned. +You can use the **PSPrivateDnsVirtualNetworkLink** object to update the link. + +## EXAMPLES + +### Example 1: Get a virtual network link. +```powershell +$Link = Get-AzPrivateDnsVirtualNetworkLink -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -Name "mylink" +``` + +```output +The link object returned looks like the following: + +Name : mylink +ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N + etwork/privateDnsZones/myzone.com/virtualNetworkLinks/mylink +ResourceGroupName : MyResourceGroup +ZoneName : myzone.com +VirtualNetworkId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N + etwork/virtualNetworks/myvirtualnetwork +Location : +Etag : "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +Tags : {tag1} +RegistrationEnabled : True +VirtualNetworkLinkState : Completed +ProvisioningState : Succeeded +``` + +This example gets the virtual network link mylink associated with the Private DNS zone named myzone.com from the specified resource group, and then stores it in the $Link variable. + +### Example 2: Get all of the links associated with a zone in a resource group. +```powershell +$Links = Get-AzPrivateDnsVirtualNetworkLink -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +``` + +```output +Name : mylink1 +ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N + etwork/privateDnsZones/myzone.com/virtualNetworkLinks/mylink1 +ResourceGroupName : MyResourceGroup +ZoneName : myzone.com +VirtualNetworkId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N + etwork/virtualNetworks/myvirtualnetwork +Location : +Etag : "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +Tags : {tag1} +RegistrationEnabled : True +VirtualNetworkLinkState : Completed +ProvisioningState : Succeeded + +Name : mylink2 +ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N + etwork/privateDnsZones/myzone.com/virtualNetworkLinks/mylink2 +ResourceGroupName : MyResourceGroup +ZoneName : myzone.com +VirtualNetworkId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N + etwork/virtualNetworks/myvirtualnetwork +Location : +Etag : "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +Tags : {tag1} +RegistrationEnabled : True +VirtualNetworkLinkState : Completed +ProvisioningState : Succeeded +``` + +This example gets all of the virtual network links associated with the Private DNS zone "myzone.com" in the specified resource group, and then stores it in the $Links variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual network link to get. +If you do not specify a value for the *Name* parameter, this cmdlet gets all links associated with the specified Private DNS zone in the specified resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the virtual network link to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneName +Specifies the name of the Private DNS zone that the virtual network link is linked to. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsVirtualNetworkLink + +## NOTES + +## RELATED LINKS + +[New-AzPrivateDnsVirtualNetworkLink](./New-AzPrivateDnsVirtualNetworkLink.md) + +[Remove-AzPrivateDnsVirtualNetworkLink](./Remove-AzPrivateDnsVirtualNetworkLink.md) + +[Set-AzPrivateDnsVirtualNetworkLink](./Set-AzPrivateDnsVirtualNetworkLink.md) diff --git a/azps-10.1.0/Az.PrivateDns/Get-AzPrivateDnsZone.md b/azps-10.1.0/Az.PrivateDns/Get-AzPrivateDnsZone.md new file mode 100644 index 0000000000..117e698be2 --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/Get-AzPrivateDnsZone.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +online version: https://learn.microsoft.com/powershell/module/az.privatedns/get-azprivatednszone +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Get-AzPrivateDnsZone.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Get-AzPrivateDnsZone.md +--- + +# Get-AzPrivateDnsZone + +## SYNOPSIS +Gets a Private DNS zone. + +## SYNTAX + +``` +Get-AzPrivateDnsZone [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPrivateDnsZone** cmdlet gets a Private Domain Name System (DNS) zone from the specified resource group. +If you specify the *Name* parameter, a single **PrivateDnsZone** object is returned. +If you do not specify the *Name* parameter, an array containing all of the zones in the specified resource group is returned. +You can use the **PrivateDnsZone** object to update the zone, for example you can add **RecordSet** objects to it. + +## EXAMPLES + +### Example 1: Get a zone +```powershell +$Zone = Get-AzPrivateDnsZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com" +``` + +```output +Name : myzone.com +ResourceId: : "/subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/PrivateZones/myzone.com" +ResourceGroupName : MyResourceGroup +Location : +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Tags : {} +NumberOfRecordSets : 1 +MaxNumberOfRecordSets : 5000 +``` +This example gets the Private DNS zone named myzone.com from the specified resource group, and then stores it in the $Zone variable. + +### Example 2: Get all of the zones in a resource group +```powershell +$Zones = Get-AzPrivateDnsZone -ResourceGroupName "MyResourceGroup" +``` + +```output +Name : zone1.com +ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Micros + oft.Network/privateDnsZones/zone1.com +ResourceGroupName : MyResourceGroup +Location : +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Tags : +NumberOfRecordSets : 1 +MaxNumberOfRecordSets : 5000 + +Name : zone2.com +ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Micros + oft.Network/privateDnsZones/zone2.com +ResourceGroupName : MyResourceGroup +Location : +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Tags : +NumberOfRecordSets : 1 +MaxNumberOfRecordSets : 5000 +``` + +This example gets all of the Private DNS zones in the specified resource group, and then stores it in the $Zones variable. + +### Example 3: Get all of the zones in a subscription +```powershell +$Zones = Get-AzPrivateDnsZone +``` + +```output +Name : zone1.com +ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup1/providers/Micros + oft.Network/privateDnsZones/zone1.com +ResourceGroupName : MyResourceGroup1 +Location : +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Tags : +NumberOfRecordSets : 1 +MaxNumberOfRecordSets : 5000 + +Name : zone2.com +ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup2/providers/Micros + oft.Network/privateDnsZones/zone2.com +ResourceGroupName : MyResourceGroup2 +Location : +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Tags : +NumberOfRecordSets : 1 +MaxNumberOfRecordSets : 5000 +``` + +This example gets all of the Private DNS zones in the current Azure subscription, and then stores them in the $Zones variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Private DNS zone to get. +If you do not specify a value for the *Name* parameter, this cmdlet gets all Private DNS zones in the specified resource group. +If you also omit the *ResourceGroupName* parameter, this cmdlet gets all Private DNS zones in the current Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Private DNS zone to get. +If you do not specify the *ResourceGroupName*, then you must also omit the *Name* parameter. +In this case, this cmdlet gets all Private DNS zones in the current Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone + +## NOTES + +## RELATED LINKS + +[New-AzPrivateDnsZone](./New-AzPrivateDnsZone.md) + +[Remove-AzPrivateDnsZone](./Remove-AzPrivateDnsZone.md) + +[Set-AzPrivateDnsZone](./Set-AzPrivateDnsZone.md) diff --git a/azps-10.1.0/Az.PrivateDns/New-AzPrivateDnsRecordConfig.md b/azps-10.1.0/Az.PrivateDns/New-AzPrivateDnsRecordConfig.md new file mode 100644 index 0000000000..46ed240716 --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/New-AzPrivateDnsRecordConfig.md @@ -0,0 +1,449 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +online version: https://learn.microsoft.com/powershell/module/az.privatedns/new-azprivatednsrecordconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/New-AzPrivateDnsRecordConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/New-AzPrivateDnsRecordConfig.md +--- + +# New-AzPrivateDnsRecordConfig + +## SYNOPSIS +Creates a new Private DNS record local object. + +## SYNTAX + +### A (Default) +``` +New-AzPrivateDnsRecordConfig -Ipv4Address <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### AAAA +``` +New-AzPrivateDnsRecordConfig -Ipv6Address <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### MX +``` +New-AzPrivateDnsRecordConfig -Exchange <String> -Preference <UInt16> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### PTR +``` +New-AzPrivateDnsRecordConfig -Ptrdname <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### TXT +``` +New-AzPrivateDnsRecordConfig -Value <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SRV +``` +New-AzPrivateDnsRecordConfig -Priority <UInt16> -Target <String> -Port <UInt16> -Weight <UInt16> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### CNAME +``` +New-AzPrivateDnsRecordConfig -Cname <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzPrivateDnsRecordConfig cmdlet creates a local PSPrivateDnsRecord object. An array of these objects is passed to the New-AzPrivateDnsRecordSet cmdlet using the PrivateDnsRecord parameter to specify the records to create in the record set. + +## EXAMPLES + +### Example 1: Create a RecordSet of type A +<!-- Skip: Output cannot be splitted from code --> +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -IPv4Address 1.2.3.4 +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records + +# When creating a RecordSet containing a single record, the above sequence can also be condensed into a single line: + +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords (New-AzPrivateDnsRecordConfig -IPv4Address 1.2.3.4) + +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Netwo + rk/privateDnsZones/myzone.com/A/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {1.2.3.4} +Metadata : +IsAutoRegistered : + + +# To create a record set containing multiple records, use New-AzPrivateDnsRecordConfig to add each record to the $Records array, +# then call New-AzPrivateDnsRecordSet, as follows: + +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -IPv4Address 1.2.3.4 +$Records += New-AzPrivateDnsRecordConfig -IPv4Address 5.6.7.8 +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records + +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Netwo + rk/privateDnsZones/myzone.com/A/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {1.2.3.4, 5.6.7.8} +Metadata : +IsAutoRegistered : +``` + +This example creates a RecordSet named www in the private zone myzone.com. The record set is of type A and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record. + +### Example 2: Create a RecordSet of type AAAA +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Ipv6Address 2001:db8::1 +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/AAAA/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : AAAA +Records : {2001:db8::1} +Metadata : +IsAutoRegistered : +``` + +This example creates a RecordSet named www in the private zone myzone.com. The record set is of type AAAA and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 3: Create a RecordSet of type CNAME +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Cname www.contoso.com +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/CNAME/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : CNAME +Records : {www.contoso.com} +Metadata : +IsAutoRegistered : +``` + +This example creates a RecordSet named www in the private zone myzone.com. The record set is of type CNAME and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 4: Create a RecordSet of type MX +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType MX -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/MX/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : MX +Records : {[5,mail.microsoft.com]} +Metadata : +IsAutoRegistered : +``` + +This command creates a RecordSet named www in the private zone myzone.com. The record set is of type MX and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 5: Create a RecordSet of type PTR +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Ptrdname www.contoso.com +$RecordSet = New-AzPrivateDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/3.2.1.in-addr.arpa/PTR/4 +Name : 4 +ZoneName : 3.2.1.in-addr.arpa +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : PTR +Records : {www.contoso.com} +Metadata : +IsAutoRegistered : +``` + +This command creates a RecordSet named 4 in the private zone 3.2.1.in-addr.arpa. The record set is of type PTR and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 6: Create a RecordSet of type SRV +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com +$RecordSet = New-AzPrivateDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/SRV/_sip._tcp +Name : _sip._tcp +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : SRV +Records : {[0,5,8080,sipservice.contoso.com]} +Metadata : +IsAutoRegistered : +``` + +This command creates a RecordSet named _sip._tcp in the private zone myzone.com. The record set is of type SRV and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record, pointing to the IP address 2001.2.3.4. The service (sip) and the protocol (tcp) are specified as part of the record set name, not as part of the record data. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 7: Create a RecordSet of type TXT +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Value "This is a TXT Record" +$RecordSet = New-AzPrivateDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/TXT/text +Name : text +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : TXT +Records : {This is a TXT Record} +Metadata : +IsAutoRegistered : +``` + +This command creates a RecordSet named text in the private zone myzone.com. The record set is of type TXT and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +## PARAMETERS + +### -Cname +The canonical name for the CNAME record to add. +Must not be relative to the name of the zone. +Must not have a terminating dot + +```yaml +Type: System.String +Parameter Sets: CNAME +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exchange +The mail exchange host for the MX record to add. +Must not be relative to the name of the zone. +Must not have a terminating dot + +```yaml +Type: System.String +Parameter Sets: MX +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ipv4Address +The IPv4 address for the A record to add. + +```yaml +Type: System.String +Parameter Sets: A +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ipv6Address +The IPv6 address for the AAAA record to add. + +```yaml +Type: System.String +Parameter Sets: AAAA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +The port number for the SRV record to add. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Preference +The preference value for the MX record to add. + +```yaml +Type: System.UInt16 +Parameter Sets: MX +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The priority value SRV record to add. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ptrdname +The target host for the PTR record to add. +Must not be relative to the name of the zone. +Must not have a terminating dot + +```yaml +Type: System.String +Parameter Sets: PTR +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Target +The target host for the SRV record to add. +Must not be relative to the name of the zone. +Must not have a terminating dot + +```yaml +Type: System.String +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The text value for the TXT record to add. + +```yaml +Type: System.String +Parameter Sets: TXT +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Weight +The weight value for the SRV record to add. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.PrivateDns/New-AzPrivateDnsRecordSet.md b/azps-10.1.0/Az.PrivateDns/New-AzPrivateDnsRecordSet.md new file mode 100644 index 0000000000..b3983db442 --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/New-AzPrivateDnsRecordSet.md @@ -0,0 +1,519 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +online version: https://learn.microsoft.com/powershell/module/az.privatedns/new-azprivatednsrecordset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/New-AzPrivateDnsRecordSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/New-AzPrivateDnsRecordSet.md +--- + +# New-AzPrivateDnsRecordSet + +## SYNOPSIS +Creates a record set in a Private DNS zone. + +## SYNTAX + +### Fields (Default) +``` +New-AzPrivateDnsRecordSet -ResourceGroupName <String> -ZoneName <String> -Name <String> + -RecordType <RecordType> -Ttl <UInt32> [-Metadata <Hashtable>] [-PrivateDnsRecord <PSPrivateDnsRecordBase[]>] + [-Overwrite] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Object +``` +New-AzPrivateDnsRecordSet -Zone <PSPrivateDnsZone> -Name <String> -RecordType <RecordType> -Ttl <UInt32> + [-Metadata <Hashtable>] [-PrivateDnsRecord <PSPrivateDnsRecordBase[]>] [-Overwrite] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +New-AzPrivateDnsRecordSet -ParentResourceId <String> -Name <String> -RecordType <RecordType> -Ttl <UInt32> + [-Metadata <Hashtable>] [-PrivateDnsRecord <PSPrivateDnsRecordBase[]>] [-Overwrite] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzPrivateDnsRecordSet cmdlet creates a new Private Domain Name System (DNS) record set with the specified name and type in the specified private zone. A RecordSet object is a set of Private DNS records with the same name and type. Note that the name is relative to the private zone and not the fully qualified name. The PrivateDnsRecord parameter specifies the records in the record set. This parameter takes an array of Private DNS records, constructed using New-AzPrivateDnsRecordConfig. You can use the pipeline operator to pass a PSPrivateDnsZone object to this cmdlet, or you can pass a PSPrivateDnsZone object as the Zone parameter, or you can specify the zone by its ResourceId, or alternatively you can specify the zone by name. You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. If a matching RecordSet already exists (same name and record type), you must specify the Overwrite parameter, otherwise the cmdlet will not create a new RecordSet . + +## EXAMPLES + +### Example 1: Create a RecordSet of type A +<!-- Skip: Output cannot be splitted from code --> +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -IPv4Address 1.2.3.4 +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records + +# When creating a RecordSet containing a single record, the above sequence can also be condensed into a single line: + +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords (New-AzPrivateDnsRecordConfig -IPv4Address 1.2.3.4) + +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Netwo + rk/privateDnsZones/myzone.com/A/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {1.2.3.4} +Metadata : +IsAutoRegistered : + + +# To create a record set containing multiple records, use New-AzPrivateDnsRecordConfig to add each record to the $Records array, +# then call New-AzPrivateDnsRecordSet, as follows: + +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -IPv4Address 1.2.3.4 +$Records += New-AzPrivateDnsRecordConfig -IPv4Address 5.6.7.8 +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records + +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Netwo + rk/privateDnsZones/myzone.com/A/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {1.2.3.4, 5.6.7.8} +Metadata : +IsAutoRegistered : +``` + +This example creates a RecordSet named www in the private zone myzone.com. The record set is of type A and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record. + +### Example 2: Create a RecordSet of type AAAA +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Ipv6Address 2001:db8::1 +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/AAAA/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : AAAA +Records : {2001:db8::1} +Metadata : +IsAutoRegistered : +``` + +This example creates a RecordSet named www in the private zone myzone.com. The record set is of type AAAA and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 3: Create a RecordSet of type CNAME +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Cname www.contoso.com +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/CNAME/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : CNAME +Records : {www.contoso.com} +Metadata : +IsAutoRegistered : +``` + +This example creates a RecordSet named www in the private zone myzone.com. The record set is of type CNAME and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 4: Create a RecordSet of type MX +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType MX -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/MX/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : MX +Records : {[5,mail.microsoft.com]} +Metadata : +IsAutoRegistered : +``` + +This command creates a RecordSet named www in the private zone myzone.com. The record set is of type MX and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 5: Create a RecordSet of type PTR +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Ptrdname www.contoso.com +$RecordSet = New-AzPrivateDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/3.2.1.in-addr.arpa/PTR/4 +Name : 4 +ZoneName : 3.2.1.in-addr.arpa +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : PTR +Records : {www.contoso.com} +Metadata : +IsAutoRegistered : +``` + +This command creates a RecordSet named 4 in the private zone 3.2.1.in-addr.arpa. The record set is of type PTR and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 6: Create a RecordSet of type SRV +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com +$RecordSet = New-AzPrivateDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/SRV/_sip._tcp +Name : _sip._tcp +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : SRV +Records : {[0,5,8080,sipservice.contoso.com]} +Metadata : +IsAutoRegistered : +``` + +This command creates a RecordSet named _sip._tcp in the private zone myzone.com. The record set is of type SRV and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record, pointing to the IP address 2001.2.3.4. The service (sip) and the protocol (tcp) are specified as part of the record set name, not as part of the record data. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 7: Create a RecordSet of type TXT +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Value "This is a TXT Record" +$RecordSet = New-AzPrivateDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/TXT/text +Name : text +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : TXT +Records : {This is a TXT Record} +Metadata : +IsAutoRegistered : +``` + +This command creates a RecordSet named text in the private zone myzone.com. The record set is of type TXT and has a TTL of 1 hour (3600 seconds). It contains a single Private DNS record. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 8: Create a RecordSet at the zone apex +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Ipv4Address 1.2.3.4 +$RecordSet = New-AzPrivateDnsRecordSet -Name "@" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/A/@ +Name : @ +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {1.2.3.4} +Metadata : +IsAutoRegistered : +``` + +This command creates a RecordSet at the apex (or root) of the private zone myzone.com. To do this, the record set name is specified as "@" (including the double-quotes). You cannot create CNAME records at the apex of a zone. This is a constraint of the DNS standards; it is not a limitation of Azure Private DNS. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 9: Create a wildcard Record Set + +```powershell +$Records = @() +$Records += New-AzPrivateDnsRecordConfig -Ipv4Address 1.2.3.4 +$RecordSet = New-AzPrivateDnsRecordSet -Name "*" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords $Records +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/A/@ +Name : * +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {1.2.3.4} +Metadata : +IsAutoRegistered : +``` + +This command creates a RecordSet named * in the private zone myzone.com. This is a wildcard record set. To create a RecordSet using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. + +### Example 10: Create an empty Record Set + +```powershell +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords @() +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/A/@ +Name : * +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {} +Metadata : +IsAutoRegistered : +``` + +This command creates a RecordSet named * in the private zone myzone.com. The record set is of type A and has a TTL of 1 hour (3600 seconds). This is an empty record set, which acts as a placeholder to which you can later add records. + +### Example 11: Create a record set and suppress all confirmation + +```powershell +$RecordSet = New-AzPrivateDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -PrivateDnsRecords (New-AzDnsRecordConfig -Ipv4Address 1.2.3.4) -Confirm:$False -Overwrite +``` + +This command creates a RecordSet. The Overwrite parameter ensures that this record set overwrites any pre-existing record set with the same name and type (existing records in that record set are lost). The Confirm parameter with a value of $False suppresses the confirmation prompt. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the records in this record set (relative to the name of the zone and without a terminating dot). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overwrite +Do not fail if the record set already exists. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentResourceId +Private DNS Zone ResourceID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrivateDnsRecord +The private dns records that are part of this record set. + +```yaml +Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordBase[] +Parameter Sets: (All) +Aliases: PrivateDnsRecords + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordType +The type of Private DNS records in this record set. + +```yaml +Type: Microsoft.Azure.Management.PrivateDns.Models.RecordType +Parameter Sets: (All) +Aliases: +Accepted values: A, AAAA, CNAME, MX, PTR, SOA, SRV, TXT + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group to which the zone belongs. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ttl +The TTL value of all the records in this record set. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +The PrivateDnsZone object representing the zone in which to create the record set. + +```yaml +Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ZoneName +The zone in which to create the record set (without a terminating dot). + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.PrivateDns/New-AzPrivateDnsVirtualNetworkLink.md b/azps-10.1.0/Az.PrivateDns/New-AzPrivateDnsVirtualNetworkLink.md new file mode 100644 index 0000000000..136047aad2 --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/New-AzPrivateDnsVirtualNetworkLink.md @@ -0,0 +1,257 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +ms.assetid: B78F3E8B-C7D2-458C-AB23-06F584FE97E0 +online version: https://learn.microsoft.com/powershell/module/az.privatedns/New-AzPrivateDnsVirtualNetworkLink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/New-AzPrivateDnsVirtualNetworkLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/New-AzPrivateDnsVirtualNetworkLink.md +--- + +# New-AzPrivateDnsVirtualNetworkLink + +## SYNOPSIS +Creates a new private DNS virtual network link. + +## SYNTAX + +### VirtualNetworkId (Default) +``` +New-AzPrivateDnsVirtualNetworkLink -ResourceGroupName <String> -ZoneName <String> -Name <String> + -VirtualNetworkId <String> [-EnableRegistration] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### VirtualNetworkObject +``` +New-AzPrivateDnsVirtualNetworkLink -ResourceGroupName <String> -ZoneName <String> -Name <String> + -VirtualNetwork <VirtualNetwork> [-EnableRegistration] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoteVirtualNetworkId +``` +New-AzPrivateDnsVirtualNetworkLink -ResourceGroupName <String> -ZoneName <String> -Name <String> + -RemoteVirtualNetworkId <String> [-EnableRegistration] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPrivateDnsVirtualNetworkLink** cmdlet creates a new private Domain Name System (DNS) virtual network link in the specified +resource group and private zone. You must specify a unique link name for the *Name* parameter or the cmdlet will +return an error. +You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control +whether the cmdlet prompts you for confirmation. + +## EXAMPLES + +### Example 1: Create a Private DNS virtual network link +```powershell +$Link = New-AzPrivateDnsVirtualNetworkLink -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" -Name "mylink" -VirtualNetworkId "/subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork" -EnableRegistration +``` + +```output +Name : mylink +ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N + etwork/privateDnsZones/myzone.com/virtualNetworkLinks/mylink +ResourceGroupName : MyResourceGroup +ZoneName : myzone.com +VirtualNetworkId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N + etwork/virtualNetworks/myvirtualnetwork +Location : +Etag : "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +Tags : {} +RegistrationEnabled : True +VirtualNetworkLinkState : Completed +ProvisioningState : Succeeded +``` + +This command creates a new virtual network link associated with the private DNS zone named myzone.com and virtual network "myvirtualnetwork" (which has already been created in the resource group) in the specified resource group, and then stores it in the $Link variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableRegistration +Switch parameter that represents if the link is registration enabled or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the virtual network link to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteVirtualNetworkId +The resource id of the virtual network in another tenant. + +```yaml +Type: System.String +Parameter Sets: RemoteVirtualNetworkId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group in which to create the link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetwork +The virtual network object associated with the link. + +```yaml +Type: Microsoft.Azure.Management.Internal.Network.Common.IVirtualNetwork +Parameter Sets: VirtualNetworkObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkId +The resource id of the virtual network associated with the link. + +```yaml +Type: System.String +Parameter Sets: VirtualNetworkId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneName +Specifies the name of the zone which will be linked to the virtual network link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsVirtualNetworkLink + +## NOTES + +## RELATED LINKS + +[Get-AzPrivateDnsVirtualNetworkLink](./Get-AzPrivateDnsVirtualNetworkLink.md) + +[Set-AzPrivateDnsVirtualNetworkLink](./Set-AzPrivateDnsVirtualNetworkLink.md) + +[Remove-AzPrivateDnsVirtualNetworkLink](./Remove-AzPrivateDnsVirtualNetworkLink.md) diff --git a/azps-10.1.0/Az.PrivateDns/New-AzPrivateDnsZone.md b/azps-10.1.0/Az.PrivateDns/New-AzPrivateDnsZone.md new file mode 100644 index 0000000000..003258125a --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/New-AzPrivateDnsZone.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +online version: https://learn.microsoft.com/powershell/module/az.privatedns/new-azprivatednszone +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/New-AzPrivateDnsZone.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/New-AzPrivateDnsZone.md +--- + +# New-AzPrivateDnsZone + +## SYNOPSIS +Creates a new private DNS zone. + +## SYNTAX + +``` +New-AzPrivateDnsZone -ResourceGroupName <String> -Name <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPrivateDnsZone** cmdlet creates a new private Domain Name System (DNS) zone in the specified +resource group. You must specify a unique private DNS zone name for the *Name* parameter or the cmdlet will +return an error. After the zone is created, use the New-AzPrivateDnsRecordSet cmdlet to create record +sets in the zone. +You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control +whether the cmdlet prompts you for confirmation. + +## EXAMPLES + +### Example 1: Create a Private DNS zone +```powershell +$Zone = New-AzPrivateDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" +``` + +```output +Name : myzone.com +ResourceId : "/subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/PrivateZones/myzone.com" +ResourceGroupName : MyResourceGroup +Location : +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Tags : {} +NumberOfRecordSets : 1 +MaxNumberOfRecordSets : 5000 +``` +This command creates a new private DNS zone named myzone.com in the specified resource group, and then +stores it in the $Zone variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the private DNS zone to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group in which to create the zone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone + +## NOTES + +## RELATED LINKS + +[Get-AzPrivateDnsZone](./Get-AzPrivateDnsZone.md) + +[New-AzPrivateDnsRecordSet](./New-AzPrivateDnsRecordSet.md) + +[Remove-AzPrivateDnsZone](./Remove-AzPrivateDnsZone.md) diff --git a/azps-10.1.0/Az.PrivateDns/Remove-AzPrivateDnsRecordConfig.md b/azps-10.1.0/Az.PrivateDns/Remove-AzPrivateDnsRecordConfig.md new file mode 100644 index 0000000000..fbd36524d5 --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/Remove-AzPrivateDnsRecordConfig.md @@ -0,0 +1,471 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +online version: https://learn.microsoft.com/powershell/module/az.privatedns/remove-azprivatednsrecordconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Remove-AzPrivateDnsRecordConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Remove-AzPrivateDnsRecordConfig.md +--- + +# Remove-AzPrivateDnsRecordConfig + +## SYNOPSIS +Removes a Private DNS record from a local record set object. + +## SYNTAX + +### A (Default) +``` +Remove-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Ipv4Address <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AAAA +``` +Remove-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Ipv6Address <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### MX +``` +Remove-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Exchange <String> -Preference <UInt16> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PTR +``` +Remove-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Ptrdname <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### TXT +``` +Remove-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Value <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SRV +``` +Remove-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Priority <UInt16> -Target <String> + -Port <UInt16> -Weight <UInt16> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### CNAME +``` +Remove-AzPrivateDnsRecordConfig -RecordSet <PSPrivateDnsRecordSet> -Cname <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzPrivateDnsRecordConfig cmdlet removes a Private Domain Name System (DNS) record from a record set. The RecordSet object is an offline object, and changes to it do not change the Private DNS responses until after you run the Set-AzPrivateDnsRecordSet cmdlet to persist the change to the Microsoft Azure Private DNS service. To remove a record, all the fields for that record type must match exactly. You cannot add or remove SOA records. SOA records are automatically created when a Private DNS zone is created and automatically deleted when the Private DNS zone is deleted. You can pass the RecordSet object to this cmdlet as a parameter or by using the pipeline operator. + +## EXAMPLES + +### Example 1: Remove an A record from a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzPrivateDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzPrivateDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzPrivateDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/A/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {} +Metadata : +IsAutoRegistered : +``` + +This example removes an A record from an existing record set. If this is the only record in the record set, the result will be an empty record set. To remove a record set entirely, see Remove-AzPrivateDnsRecordSet. + +### Example 2: Remove an AAAA record from a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzPrivateDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzPrivateDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzPrivateDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/AAAA/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : AAAA +Records : {} +Metadata : +IsAutoRegistered : +``` + +This example removes an AAAA record from an existing record set. If this is the only record in the record set, the result will be an empty record set. To remove a record set entirely, see Remove-AzPrivateDnsRecordSet. + +### Example 3: Remove a CNAME record from a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzPrivateDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzPrivateDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzPrivateDnsRecordConfig -Cname contoso.com | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/CNAME/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : CNAME +Records : {} +Metadata : +IsAutoRegistered : +``` + +This example removes a CNAME record from an existing record set. Because a CNAME record set can contain at most one record, the result is an empty record set. + +### Example 4: Remove a MX record from a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name "@" -RecordType MX -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzPrivateDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzPrivateDnsRecordSet -Name "@" -RecordType MX -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzPrivateDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/MX/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : MX +Records : {} +Metadata : +IsAutoRegistered : +``` + +This example removes an MX record from an existing record set. The record name "@" indicates a record set at the zone apex. If this is the only record in the record set, the result is an empty record set. To remove a record set entirely, see Remove-AzPrivateDnsRecordSet. + +### Example 5: Remove a PTR record from a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -ZoneName 3.2.1.in-addr.arpa +Remove-AzPrivateDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzPrivateDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -ZoneName "3.2.1.in-addr.arpa" | Remove-AzPrivateDnsRecordConfig -Ptrdname www.contoso.com | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/3.2.1.in-addr.arpa/PTR/4 +Name : 4 +ZoneName : 3.2.1.in-addr.arpa +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : PTR +Records : {} +Metadata : +IsAutoRegistered : +``` + +This example removes a PTR record from an existing record set. If this is the only record in the record set, the result is an empty record set. To remove a record set entirely, see Remove-AzPrivateDnsRecordSet. + +### Example 6: Remove a SRV record from a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzPrivateDnsRecordConfig -RecordSet $RecordSet -Priority 0 -Weight 5 -Port 8080 -Target target.example.com +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzPrivateDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzPrivateDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/SRV/_sip._tcp +Name : _sip._tcp +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : SRV +Records : {} +Metadata : +IsAutoRegistered : +``` + +This example removes an SRV record from an existing record set. If this is the only record in the record set, the result is an empty record set. To remove a record set entirely, see Remove-AzPrivateDnsRecordSet. + +### Example 7: Remove a TXT record from a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzPrivateDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# The above sequence can also be piped: + +Get-AzPrivateDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzPrivateDnsRecordConfig -Value "This is a TXT Record" | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/TXT/text +Name : text +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : TXT +Records : {} +Metadata : +IsAutoRegistered : +``` + +This example removes a TXT record from an existing record set. If this is the only record in the record set, the result is an empty record set. To remove a record set entirely, see Remove-AzPrivateDnsRecordSet. + +## PARAMETERS + +### -Cname +The canonical name of the CNAME record to remove. +Must not be relative to the name of the zone. +Must not have a terminating dot + +```yaml +Type: System.String +Parameter Sets: CNAME +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exchange +The mail exchange host of the MX record to remove. +Must not be relative to the name of the zone. +Must not have a terminating dot + +```yaml +Type: System.String +Parameter Sets: MX +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ipv4Address +The IPv4 address of the A record to remove. + +```yaml +Type: System.String +Parameter Sets: A +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ipv6Address +The IPv6 address of the AAAA record to remove. + +```yaml +Type: System.String +Parameter Sets: AAAA +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +The port number of the SRV record to remove. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Preference +The preference value of the MX record to remove. + +```yaml +Type: System.UInt16 +Parameter Sets: MX +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The priority value of the SRV record to remove. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ptrdname +The target host of the PTR record to remove. +Must not be relative to the name of the zone. +Must not have a terminating dot + +```yaml +Type: System.String +Parameter Sets: PTR +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordSet +The record set from which to remove the record. + +```yaml +Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Target +The target host of the SRV record to remove. +Must not be relative to the name of the zone. +Must not have a terminating dot + +```yaml +Type: System.String +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The text value of the TXT record to remove. + +```yaml +Type: System.String +Parameter Sets: TXT +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Weight +The weight value of the SRV record to remove. + +```yaml +Type: System.UInt16 +Parameter Sets: SRV +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet + +## OUTPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.PrivateDns/Remove-AzPrivateDnsRecordSet.md b/azps-10.1.0/Az.PrivateDns/Remove-AzPrivateDnsRecordSet.md new file mode 100644 index 0000000000..0472bcf9d8 --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/Remove-AzPrivateDnsRecordSet.md @@ -0,0 +1,270 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +online version: https://learn.microsoft.com/powershell/module/az.privatedns/remove-azprivatednsrecordset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Remove-AzPrivateDnsRecordSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Remove-AzPrivateDnsRecordSet.md +--- + +# Remove-AzPrivateDnsRecordSet + +## SYNOPSIS +Deletes a record set from a Private DNS zone. + +## SYNTAX + +### Fields (Default) +``` +Remove-AzPrivateDnsRecordSet -ResourceGroupName <String> -ZoneName <String> -Name <String> + -RecordType <RecordType> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Mixed +``` +Remove-AzPrivateDnsRecordSet -Zone <PSPrivateDnsZone> -Name <String> -RecordType <RecordType> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Object +``` +Remove-AzPrivateDnsRecordSet -RecordSet <PSPrivateDnsRecordSet> [-Overwrite] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzPrivateDnsRecordSet -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzPrivateDnsRecordSet cmdlet deletes the specified record set from the specified zone. You cannot delete SOA records that are automatically created at the private zone apex. You can pass a RecordSet object to this cmdlet by using the pipeline operator or as a parameter or as a ResourceId. To identify a record set by name and type without using a RecordSet object, you must pass the zone as a PSPrivateDnsZone object to this cmdlet by using the pipeline operator or as a parameter, or alternatively you can specify the ZoneName and ResourceGroupName parameters. You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. When specifying the record set using a RecordSet object, the record set is not deleted if it has been changed in Azure Private DNS since the local RecordSet object was retrieved. This provides protection for concurrent changes. You can suppress this by using the Overwrite parameter, which deletes the record set regardless of concurrent changes. + +## EXAMPLES + +### Example 1: Remove a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name "www" -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzPrivateDnsRecordSet -RecordSet $RecordSet +``` + +The first command gets the specified record set, and then stores it in the $RecordSet variable.The second command removes the record set in $RecordSet. + +### Example 2: Remove a record set and suppress all confirmation +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" +Remove-AzPrivateDnsRecordSet -RecordSet $RecordSet -Confirm:$False -Overwrite + +# Alternatively, the record set can be removed as follows. In this case, +# because the record set is specified by name rather than by object, the +# Overwrite parameter is not applicable. + +Remove-AzPrivateDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" -Confirm:$False +``` + +The first command gets the specified record set. The second command deletes the record set, even if it has changed in the meantime. Confirmation prompts are suppressed. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the records in the record set (relative to the name of the zone and without a terminating dot). + +```yaml +Type: System.String +Parameter Sets: Fields, Mixed +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overwrite +Do not use the ETag field of the RecordSet parameter for optimistic concurrency checks. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Object +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Used for passing the result (boolean) of the operation delete private zone further down the pipeline. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordSet +The record set in which to add the record. + +```yaml +Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RecordType +The type of Private DNS records in the record set. + +```yaml +Type: Microsoft.Azure.Management.PrivateDns.Models.RecordType +Parameter Sets: Fields, Mixed +Aliases: +Accepted values: A, AAAA, CNAME, MX, PTR, SOA, SRV, TXT + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group to which the zone belongs. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Private DNS RecordSet ResourceID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +The PrivateDnsZone object representing the zone in which to create the record set. + +```yaml +Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone +Parameter Sets: Mixed +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ZoneName +The zone in which the record set exists (without a terminating dot). + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.PrivateDns/Remove-AzPrivateDnsVirtualNetworkLink.md b/azps-10.1.0/Az.PrivateDns/Remove-AzPrivateDnsVirtualNetworkLink.md new file mode 100644 index 0000000000..16ef55fe1b --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/Remove-AzPrivateDnsVirtualNetworkLink.md @@ -0,0 +1,233 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +ms.assetid: A8E230A0-5057-40BC-81CD-6D397A503A84 +online version: https://learn.microsoft.com/powershell/module/az.privatedns/remove-azprivatednsvirtualnetworklink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Remove-AzPrivateDnsVirtualNetworkLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Remove-AzPrivateDnsVirtualNetworkLink.md +--- + +# Remove-AzPrivateDnsVirtualNetworkLink + +## SYNOPSIS +Removes a virtual network link from a resource group. + +## SYNTAX + +### Fields (Default) +``` +Remove-AzPrivateDnsVirtualNetworkLink -ResourceGroupName <String> -ZoneName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Object +``` +Remove-AzPrivateDnsVirtualNetworkLink -InputObject <PSPrivateDnsVirtualNetworkLink> [-Overwrite] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzPrivateDnsVirtualNetworkLink -ResourceId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPrivateDnsVirtualNetworkLink** cmdlet permanently deletes a private Domain Name System (DNS) link from a specified resource group. +You can pass a **PSPrivateDnsVirtualNetworkLink** object using the *Link* parameter or by using the pipeline operator, or alternatively you can specify the *Name* *ZoneName* and *ResourceGroupName* parameters. +You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. +When specifying the link using a **PSPrivateDnsVirtualNetworkLink** object (passed via the pipeline or *Link* parameter), the link is not deleted if it has been changed in Azure Private DNS since the local **PSPrivateDnsVirtualNetworkLink** object was retrieved. This provides protection for concurrent zone changes. This can be suppressed using the *Overwrite* parameter, which deletes the zone regardless of concurrent changes. + +## EXAMPLES + +### Example 1: Remove a link +```powershell +Remove-AzPrivateDnsVirtualNetworkLink -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -Name "mylink" +``` + +This command removes the link named mylink linked to zone myzone.com from the resource group named MyResourceGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual network link object to remove. + +```yaml +Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsVirtualNetworkLink +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the link to be deleted. +You must also specify the *ResourceGroupName* and *ZoneName* parameter. +Alternatively, you can specify the link using the *Link* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overwrite +When specifying the zone using a **PSPrivateDnsVirtualNetworkLink** object (passed via the pipeline or *Link* parameter), the zone is not deleted if it has been changed in Azure DNS since the local **PSPrivateDnsVirtualNetworkLink** object was retrieved. +This provides protection for concurrent zone changes. +This can be suppressed using the *Overwrite* parameter, which deletes the zone regardless of concurrent changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Object +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Used for passing the result (boolean) of the operation delete virtual network link further down the pipeline. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the link to remove. +You must also specify the *ZoneName* and *Name* parameter. +Alternatively, you can specify the DNS zone using a **PSPrivateDnsVirtualNetworkLink** object, passed via either the pipeline or the *Link* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the ARM resource ID of the link. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ZoneName +Specifies the name of the private DNS zone that the link is associated with. +You must also specify the *ResourceGroupName* and *Name* parameter. +Alternatively, you can specify the link using the *Link* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsVirtualNetworkLink + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzPrivateDnsVirtualNetworkLink](./Get-AzPrivateDnsVirtualNetworkLink.md) + +[New-AzPrivateDnsVirtualNetworkLink](./New-AzPrivateDnsVirtualNetworkLink.md) + +[Set-AzPrivateDnsVirtualNetworkLink](./Set-AzPrivateDnsVirtualNetworkLink.md) diff --git a/azps-10.1.0/Az.PrivateDns/Remove-AzPrivateDnsZone.md b/azps-10.1.0/Az.PrivateDns/Remove-AzPrivateDnsZone.md new file mode 100644 index 0000000000..f299bd3ce0 --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/Remove-AzPrivateDnsZone.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +online version: https://learn.microsoft.com/powershell/module/az.privatedns/remove-azprivatednszone +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Remove-AzPrivateDnsZone.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Remove-AzPrivateDnsZone.md +--- + +# Remove-AzPrivateDnsZone + +## SYNOPSIS +Removes a private DNS zone from a resource group. + +## SYNTAX + +### Fields (Default) +``` +Remove-AzPrivateDnsZone -ResourceGroupName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Object +``` +Remove-AzPrivateDnsZone -PrivateZone <PSPrivateDnsZone> [-Overwrite] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzPrivateDnsZone -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPrivateDnsZone** cmdlet permanently deletes a private Domain Name System (DNS) zone from a specified resource group. +All record sets contained in the zone are also deleted. +You can pass a **PrivateDnsZone** object using the *PrivateZone* parameter or by using the pipeline operator, or alternatively you can specify the *Name* and *ResourceGroupName* parameters. +You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. +When specifying the zone using a **PrivateDnsZone** object (passed via the pipeline or *Zone* parameter), the zone is not deleted if it has been changed in Azure DNS since the local **PrivateDnsZone** object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). +This provides protection for concurrent zone changes. +This can be suppressed using the *Overwrite* parameter, which deletes the zone regardless of concurrent changes. + +## EXAMPLES + +### Example 1: Remove a private zone +```powershell +Remove-AzPrivateDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" +``` + +This command removes the zone named myzone.com from the resource group named MyResourceGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the private DNS zone that this cmdlet removes. +You must also specify the *ResourceGroupName* parameter. +Alternatively, you can specify the DNS zone using the *Zone* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overwrite +When specifying the zone using a **PrivateDnsZone** object (passed via the pipeline or *Zone* parameter), the zone is not deleted if it has been changed in Azure DNS since the local **PrivateDnsZone** object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). +This provides protection for concurrent zone changes. +This can be suppressed using the *Overwrite* parameter, which deletes the zone regardless of concurrent changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Object +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Used for passing the result (boolean) of the operation delete private zone further down the pipeline. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateZone +The private zone object to delete. + +```yaml +Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the zone to remove. +You must also specify the *ZoneName* parameter. +Alternatively, you can specify the DNS zone using a **PrivateDnsZone** object, passed via either the pipeline or the *Zone* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Private DNS Zone ResourceID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzPrivateDnsZone](./Get-AzPrivateDnsZone.md) + +[New-AzPrivateDnsZone](./New-AzPrivateDnsZone.md) + +[Set-AzPrivateDnsZone](./Set-AzPrivateDnsZone.md) diff --git a/azps-10.1.0/Az.PrivateDns/Set-AzPrivateDnsRecordSet.md b/azps-10.1.0/Az.PrivateDns/Set-AzPrivateDnsRecordSet.md new file mode 100644 index 0000000000..acb2457222 --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/Set-AzPrivateDnsRecordSet.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +online version: https://learn.microsoft.com/powershell/module/az.privatedns/Set-AzPrivateDnsRecordSet +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Set-AzPrivateDnsRecordSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Set-AzPrivateDnsRecordSet.md +--- + +# Set-AzPrivateDnsRecordSet + +## SYNOPSIS +Updates/Sets a record set in a Private DNS zone. + +## SYNTAX + +``` +Set-AzPrivateDnsRecordSet -RecordSet <PSPrivateDnsRecordSet> [-Overwrite] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzPrivateDnsRecordSet cmdlet updates a record set in the Azure Private DNS service from a local RecordSet object. You can pass a RecordSet object as a parameter or by using the pipeline operator. You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. The record set is not updated if it has been changed in Azure Private DNS since the local RecordSet object was retrieved. This provides protection for concurrent changes. You can suppress this behavior using the Overwrite parameter, which updates the record set regardless of concurrent changes. + +## EXAMPLES + +### Example 1: Update a record set +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A +Add-AzPrivateDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 172.16.0.0 +Add-AzPrivateDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 172.31.255.255 +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet + +# These cmdlets can also be piped: + +Get-AzPrivateDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A | Add-AzPrivateDnsRecordConfig -Ipv4Address 172.16.0.0 | Add-AzPrivateDnsRecordConfig -Ipv4Address 172.31.255.255 | Set-AzPrivateDnsRecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Netwo + rk/privateDnsZones/myzone.com/A/www +Name : www +ZoneName : myzone.com +ResourceGroupName : MyResourceGroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : A +Records : {1.2.3.4, 172.16.0.0, 172.31.255.255} +Metadata : +IsAutoRegistered : +``` + +The first command uses the Get-AzPrivateDnsRecordSet cmdlet to get the specified record set, and then stores it in the $RecordSet variable. The second and third commands are off-line operations to add two A records to the record set. The final command uses the Set-AzPrivateDnsRecordSet cmdlet to commit the update. + +### Example 2: Update an SOA record +```powershell +$RecordSet = Get-AzPrivateDnsRecordSet -Name "@" -RecordType SOA -Zone $Zone +$RecordSet.Records[0].Email = "admin.myzone.com" +Set-AzPrivateDnsRecordSet -RecordSet $RecordSet +``` + +```output +Id : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micros + oft.Network/privateDnsZones/myzone.com/SOA/@ +Name : @ +ZoneName : myzone.com +ResourceGroupName : Myresourcegroup +Ttl : 3600 +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +RecordType : SOA +Records : {[internal.cloudapp.net,admin.myzone.com,3600,300,2419200,300]} +Metadata : +IsAutoRegistered : +``` + +The first command uses the Get-AzPrivateDnsRecordSet cmdlet to get the specified record set, and then stores it in the $RecordSet variable. The second command updates the specified SOA record in $RecordSet. The final command uses the Set-AzPrivateDnsRecordSet cmdlet to propagate the update in $RecordSet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overwrite +Do not use the ETag field of the RecordSet parameter for optimistic concurrency checks. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordSet +The record set in which to add the record. + +```yaml +Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet + +## OUTPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsRecordSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.PrivateDns/Set-AzPrivateDnsVirtualNetworkLink.md b/azps-10.1.0/Az.PrivateDns/Set-AzPrivateDnsVirtualNetworkLink.md new file mode 100644 index 0000000000..3939e30356 --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/Set-AzPrivateDnsVirtualNetworkLink.md @@ -0,0 +1,266 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +ms.assetid: A8E230A0-5057-40BC-81CD-6D397A503A84 +online version: https://learn.microsoft.com/powershell/module/az.privatedns/Set-AzPrivateDnsVirtualNetworkLink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Set-AzPrivateDnsVirtualNetworkLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Set-AzPrivateDnsVirtualNetworkLink.md +--- + +# Set-AzPrivateDnsVirtualNetworkLink + +## SYNOPSIS +Updates/Sets a virtual network link associated with a private zone and a resource group. + +## SYNTAX + +### Fields (Default) +``` +Set-AzPrivateDnsVirtualNetworkLink -ResourceGroupName <String> -ZoneName <String> -Name <String> + [-IsRegistrationEnabled <Boolean>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### Object +``` +Set-AzPrivateDnsVirtualNetworkLink -InputObject <PSPrivateDnsVirtualNetworkLink> + [-IsRegistrationEnabled <Boolean>] [-Tag <Hashtable>] [-Overwrite] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Set-AzPrivateDnsVirtualNetworkLink -ResourceId <String> [-IsRegistrationEnabled <Boolean>] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPrivateDnsVirtualNetworkLink** cmdlet updates a link associated with a zone from a specified resource group. +You can pass a **PSPrivateDnsVirtualNetworkLink** object using the *Link* parameter or by using the pipeline operator, or alternatively you can specify the *Name* *ZoneName* and *ResourceGroupName* parameters. +You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. +When specifying the zone using a **PSPrivateDnsVirtualNetworkLink** object (passed via the pipeline or *Link* parameter), the link is not updated if it has been changed in Azure DNS since the local **PSPrivateDnsVirtualNetworkLink** object was retrieved. This provides protection for concurrent link changes. This can be suppressed using the *Overwrite* parameter, which updates the link regardless of concurrent changes. + +## EXAMPLES + +### Example 1: Set a link +```powershell +Set-AzPrivateDnsVirtualNetworkLink -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" -Name "mylink" -Tag @{} -IsRegistrationEnabled $true +``` + +```output +Name : mylink +ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N + etwork/privateDnsZones/myzone.com/virtualNetworkLinks/mylink +ResourceGroupName : MyResourceGroup +ZoneName : myzone.com +VirtualNetworkId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N + etwork/virtualNetworks/myvirtualnetwork +Location : +Etag : "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +Tags : {} +RegistrationEnabled : True +VirtualNetworkLinkState : Completed +ProvisioningState : Succeeded +``` + +This command sets IsRegistrationEnabled to True for the link named mylink, linked to zone named myzone.com from the resource group named MyResourceGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The virtual network link object to set. + +```yaml +Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsVirtualNetworkLink +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsRegistrationEnabled +Boolean that represents if registration is enabled on the virtual network link. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the link that this cmdlet removes. +You must also specify the *ResourceGroupName* and *ZoneName* parameter. +Alternatively, you can specify the private DNS link using the *link* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overwrite +When specifying the link using a **PSPrivateDnsVirtualNetworkLink** object (passed via the pipeline or *Link* parameter), the link is not deleted if it has been changed in Azure DNS since the local **PSPrivateDnsVirtualNetworkLink** object was retrieved. +This provides protection for concurrent link changes. +This can be suppressed using the *Overwrite* parameter, which deletes the link regardless of concurrent changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Object +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the link to remove. +You must also specify the *ZoneName* and *Name* parameter. +Alternatively, you can specify the virtual network link using a **PSPrivateDnsVirtualNetworkLink** object, passed via either the pipeline or the *Link* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Private DNS Zone ResourceID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneName +Specifies the name of the DNS zone that this cmdlet removes. +You must also specify the *Name* and *ResourceGroupName* parameter. +Alternatively, you can specify the private DNS link using the *link* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsVirtualNetworkLink + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsVirtualNetworkLink + +## NOTES + +## RELATED LINKS + +[Get-AzPrivateDnsVirtualNetworkLink](./Get-AzPrivateDnsVirtualNetworkLink.md) + +[New-AzPrivateDnsVirtualNetworkLink](./New-AzPrivateDnsVirtualNetworkLink.md) + +[Set-AzPrivateDnsVirtualNetworkLink](./Set-AzPrivateDnsVirtualNetworkLink.md) diff --git a/azps-10.1.0/Az.PrivateDns/Set-AzPrivateDnsZone.md b/azps-10.1.0/Az.PrivateDns/Set-AzPrivateDnsZone.md new file mode 100644 index 0000000000..9c0a2109bb --- /dev/null +++ b/azps-10.1.0/Az.PrivateDns/Set-AzPrivateDnsZone.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml +Module Name: Az.PrivateDns +online version: https://learn.microsoft.com/powershell/module/az.privatedns/Set-AzPrivateDnsZone +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Set-AzPrivateDnsZone.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/PrivateDns/PrivateDns/help/Set-AzPrivateDnsZone.md +--- + +# Set-AzPrivateDnsZone + +## SYNOPSIS +Updates a Private DNS zone from a resource group. + +## SYNTAX + +### Fields (Default) +``` +Set-AzPrivateDnsZone -ResourceGroupName <String> -Name <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Set-AzPrivateDnsZone -ResourceId <String> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Object +``` +Set-AzPrivateDnsZone -PrivateZone <PSPrivateDnsZone> [-Tag <Hashtable>] [-Overwrite] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPrivateDnsZone** cmdlet permanently updates a private Domain Name System (DNS) zone from a specified resource group. +You can pass a **PrivateDnsZone** object using the *PrivateZone* parameter or by using the pipeline operator, or alternatively you can specify the *Name* and *ResourceGroupName* parameters. +You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. +When specifying the zone using a **PrivateDnsZone** object (passed via the pipeline or *Zone* parameter), the zone is not updated if it has been changed in Azure DNS since the local **PrivateDnsZone** object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). +This provides protection for concurrent zone changes. +This can be suppressed using the *Overwrite* parameter, which updates the zone regardless of concurrent changes. + +## EXAMPLES + +### Example 1: Updates a private zone +```powershell +Set-AzPrivateDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" -Tag @{tag1="value1";tag2="value2"} +``` + +```output +Name : myzone.com +ResourceId : "/subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/PrivateZones/myzone.com" +ResourceGroupName : MyResourceGroup +Location : +Etag : xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Tags : {tag1="value1";tag2="value2"} +NumberOfRecordSets : 1 +MaxNumberOfRecordSets : 5000 +``` +This command updates the zone named myzone.com from the resource group named MyResourceGroup with the tags provided. Use Get-AzPrivateDnsZone to retrieve the updated zone. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Private DNS zone that this cmdlet updates. +You must also specify the *ResourceGroupName* parameter. +Alternatively, you can specify the private DNS zone using the *Zone* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overwrite +When specifying the zone using a **PrivateDnsZone** object (passed via the pipeline or *Zone* parameter), the zone is not updated if it has been changed in Azure DNS since the local **DnsZone** object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). +This provides protection for concurrent zone changes. +This can be suppressed using the *Overwrite* parameter, which updates the zone regardless of concurrent changes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Object +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateZone +The zone object to set. + +```yaml +Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the zone to be updated. +You must also specify the *ZoneName* parameter. +Alternatively, you can specify the private DNS zone using a **DnsZone** object, passed via either the pipeline or the *Zone* parameter. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Private DNS Zone ResourceID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone + +## OUTPUTS + +### Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsZone + +## NOTES + +## RELATED LINKS + +[Get-AzPrivateDnsZone](./Get-AzPrivateDnsZone.md) + +[New-AzPrivateDnsZone](./New-AzPrivateDnsZone.md) + +[Set-AzPrivateDnsZone](./Set-AzPrivateDnsZone.md) diff --git a/azps-10.1.0/Az.ProviderHub/Az.ProviderHub.md b/azps-10.1.0/Az.ProviderHub/Az.ProviderHub.md new file mode 100644 index 0000000000..f03cf05836 --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Az.ProviderHub.md @@ -0,0 +1,76 @@ +--- +Module Name: Az.ProviderHub +Module Guid: b1f92a18-bc07-49c3-9938-cde7ef64659f +Download Help Link: https://learn.microsoft.com/powershell/module/az.providerhub +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Az.ProviderHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Az.ProviderHub.md +--- + +# Az.ProviderHub Module +## Description +Microsoft Azure PowerShell: ProviderHub cmdlets + +## Az.ProviderHub Cmdlets +### [Get-AzProviderHubCustomRollout](Get-AzProviderHubCustomRollout.md) +Gets the custom rollout details. + +### [Get-AzProviderHubDefaultRollout](Get-AzProviderHubDefaultRollout.md) +Gets the default rollout details. + +### [Get-AzProviderHubNotificationRegistration](Get-AzProviderHubNotificationRegistration.md) +Gets the notification registration details. + +### [Get-AzProviderHubProviderRegistration](Get-AzProviderHubProviderRegistration.md) +Gets the provider registration details. + +### [Get-AzProviderHubResourceTypeRegistration](Get-AzProviderHubResourceTypeRegistration.md) +Gets a resource type details in the given subscription and provider. + +### [Get-AzProviderHubSku](Get-AzProviderHubSku.md) +Gets the sku details for the given resource type and sku name. + +### [Invoke-AzProviderHubManifestCheckin](Invoke-AzProviderHubManifestCheckin.md) +Checkin the manifest. + +### [New-AzProviderHubCustomRollout](New-AzProviderHubCustomRollout.md) +Creates or updates the rollout details. + +### [New-AzProviderHubDefaultRollout](New-AzProviderHubDefaultRollout.md) +Creates or updates the rollout details. + +### [New-AzProviderHubManifest](New-AzProviderHubManifest.md) +Generates the manifest for the given provider. + +### [New-AzProviderHubNotificationRegistration](New-AzProviderHubNotificationRegistration.md) +Creates or updates a notification registration. + +### [New-AzProviderHubProviderRegistration](New-AzProviderHubProviderRegistration.md) +Creates or updates the provider registration. + +### [New-AzProviderHubResourceTypeRegistration](New-AzProviderHubResourceTypeRegistration.md) +Creates or updates a resource type. + +### [New-AzProviderHubSku](New-AzProviderHubSku.md) +Creates or updates the resource type skus in the given resource type. + +### [Remove-AzProviderHubDefaultRollout](Remove-AzProviderHubDefaultRollout.md) +Deletes the rollout resource. +Rollout must be in terminal state. + +### [Remove-AzProviderHubNotificationRegistration](Remove-AzProviderHubNotificationRegistration.md) +Deletes a notification registration. + +### [Remove-AzProviderHubProviderRegistration](Remove-AzProviderHubProviderRegistration.md) +Deletes a provider registration. + +### [Remove-AzProviderHubResourceTypeRegistration](Remove-AzProviderHubResourceTypeRegistration.md) +Deletes a resource type + +### [Remove-AzProviderHubSku](Remove-AzProviderHubSku.md) +Deletes a resource type sku. + +### [Stop-AzProviderHubDefaultRollout](Stop-AzProviderHubDefaultRollout.md) +Stops or cancels the rollout, if in progress. + diff --git a/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubCustomRollout.md b/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubCustomRollout.md new file mode 100644 index 0000000000..beeb77eda5 --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubCustomRollout.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/get-azproviderhubcustomrollout +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Get-AzProviderHubCustomRollout.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Get-AzProviderHubCustomRollout.md +--- + +# Get-AzProviderHubCustomRollout + +## SYNOPSIS +Gets the custom rollout details. + +## SYNTAX + +### List (Default) +``` +Get-AzProviderHubCustomRollout -ProviderNamespace <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzProviderHubCustomRollout -ProviderNamespace <String> -RolloutName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzProviderHubCustomRollout -InputObject <IProviderHubIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the custom rollout details. + +## EXAMPLES + +### Example 1: Get a custom rollout by rollout name. +```powershell +Get-AzProviderHubCustomRollout -ProviderNamespace "Microsft.Contoso" -RolloutName "customRollout1" +``` + +```output +Name Type +---- ---- +customRollout1 Microsoft.ProviderHub/providerRegistrations/customRollouts +``` + +Get a custom rollout by rollout name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RolloutName +The rollout name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.ICustomRollout + +## 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 `<IProviderHubIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[NestedResourceTypeFirst <String>]`: The first child resource type. + - `[NestedResourceTypeSecond <String>]`: The second child resource type. + - `[NestedResourceTypeThird <String>]`: The third child resource type. + - `[NotificationRegistrationName <String>]`: The notification registration. + - `[ProviderNamespace <String>]`: The name of the resource provider hosted within ProviderHub. + - `[ResourceType <String>]`: The resource type. + - `[RolloutName <String>]`: The rollout name. + - `[Sku <String>]`: The SKU. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubDefaultRollout.md b/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubDefaultRollout.md new file mode 100644 index 0000000000..f7b66864d9 --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubDefaultRollout.md @@ -0,0 +1,178 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/get-azproviderhubdefaultrollout +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Get-AzProviderHubDefaultRollout.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Get-AzProviderHubDefaultRollout.md +--- + +# Get-AzProviderHubDefaultRollout + +## SYNOPSIS +Gets the default rollout details. + +## SYNTAX + +### List (Default) +``` +Get-AzProviderHubDefaultRollout -ProviderNamespace <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzProviderHubDefaultRollout -ProviderNamespace <String> -RolloutName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzProviderHubDefaultRollout -InputObject <IProviderHubIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the default rollout details. + +## EXAMPLES + +### Example 1: List all default rollouts under the resource provider. +```powershell +Get-AzProviderHubDefaultRollout -ProviderNamespace "Microsoft.Contoso" +``` + +```output +Name Type +---- ---- +defaultRollout2021w10 Microsoft.ProviderHub/providerRegistrations/defaultRollouts +defaultRollout2021w11 Microsoft.ProviderHub/providerRegistrations/defaultRollouts +``` + +List all default rollouts under the resource provider. + +### Example 2: Get a specific rollout by name. +```powershell +Get-AzProviderHubDefaultRollout -ProviderNamespace "Microsoft.Contoso" -RolloutName "defaultRollout2021w10" +``` + +```output +Name Type +---- ---- +defaultRollout2021w10 Microsoft.ProviderHub/providerRegistrations/defaultRollouts +``` + +Get a specific rollout by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RolloutName +The rollout name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IDefaultRollout + +## 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 `<IProviderHubIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[NestedResourceTypeFirst <String>]`: The first child resource type. + - `[NestedResourceTypeSecond <String>]`: The second child resource type. + - `[NestedResourceTypeThird <String>]`: The third child resource type. + - `[NotificationRegistrationName <String>]`: The notification registration. + - `[ProviderNamespace <String>]`: The name of the resource provider hosted within ProviderHub. + - `[ResourceType <String>]`: The resource type. + - `[RolloutName <String>]`: The rollout name. + - `[Sku <String>]`: The SKU. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubNotificationRegistration.md b/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubNotificationRegistration.md new file mode 100644 index 0000000000..e3dcfbdccd --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubNotificationRegistration.md @@ -0,0 +1,178 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/get-azproviderhubnotificationregistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Get-AzProviderHubNotificationRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Get-AzProviderHubNotificationRegistration.md +--- + +# Get-AzProviderHubNotificationRegistration + +## SYNOPSIS +Gets the notification registration details. + +## SYNTAX + +### List (Default) +``` +Get-AzProviderHubNotificationRegistration -ProviderNamespace <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzProviderHubNotificationRegistration -Name <String> -ProviderNamespace <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzProviderHubNotificationRegistration -InputObject <IProviderHubIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the notification registration details. + +## EXAMPLES + +### Example 1: List all the notification registration by ProviderNamespace. +```powershell +Get-AzProviderHubNotificationRegistration -ProviderNamespace "Microsoft.Contoso" +``` + +```output +Name +---- +notificationRegistrationTest1 +notificationRegistrationTest2 +``` + +List all the notification registration in the provider namespace. + +### Example 2: Get the notification registration by name. +```powershell +Get-AzProviderHubNotificationRegistration -ProviderNamespace "Microsoft.Contoso" -Name "notificationRegistrationTest" +``` + +```output +Name +---- +notificationRegistrationTest +``` + +Get the notification registration by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The notification registration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: NotificationRegistrationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.INotificationRegistration + +## 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 `<IProviderHubIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[NestedResourceTypeFirst <String>]`: The first child resource type. + - `[NestedResourceTypeSecond <String>]`: The second child resource type. + - `[NestedResourceTypeThird <String>]`: The third child resource type. + - `[NotificationRegistrationName <String>]`: The notification registration. + - `[ProviderNamespace <String>]`: The name of the resource provider hosted within ProviderHub. + - `[ResourceType <String>]`: The resource type. + - `[RolloutName <String>]`: The rollout name. + - `[Sku <String>]`: The SKU. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubProviderRegistration.md b/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubProviderRegistration.md new file mode 100644 index 0000000000..b1877e4a94 --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubProviderRegistration.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/get-azproviderhubproviderregistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Get-AzProviderHubProviderRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Get-AzProviderHubProviderRegistration.md +--- + +# Get-AzProviderHubProviderRegistration + +## SYNOPSIS +Gets the provider registration details. + +## SYNTAX + +### List (Default) +``` +Get-AzProviderHubProviderRegistration [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzProviderHubProviderRegistration -ProviderNamespace <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzProviderHubProviderRegistration -InputObject <IProviderHubIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the provider registration details. + +## EXAMPLES + +### Example 1: Get the provider registration. +```powershell +Get-AzProviderHubProviderRegistration -ProviderNamespace "Microsoft.Contoso" +``` + +```output +Name Type +---- ---- +Microsoft.Contoso Microsoft.ProviderHub/providerRegistrations +``` + +Get the provider registration. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IProviderRegistration + +## 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 `<IProviderHubIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[NestedResourceTypeFirst <String>]`: The first child resource type. + - `[NestedResourceTypeSecond <String>]`: The second child resource type. + - `[NestedResourceTypeThird <String>]`: The third child resource type. + - `[NotificationRegistrationName <String>]`: The notification registration. + - `[ProviderNamespace <String>]`: The name of the resource provider hosted within ProviderHub. + - `[ResourceType <String>]`: The resource type. + - `[RolloutName <String>]`: The rollout name. + - `[Sku <String>]`: The SKU. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubResourceTypeRegistration.md b/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubResourceTypeRegistration.md new file mode 100644 index 0000000000..dab4d730de --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubResourceTypeRegistration.md @@ -0,0 +1,191 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/get-azproviderhubresourcetyperegistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Get-AzProviderHubResourceTypeRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Get-AzProviderHubResourceTypeRegistration.md +--- + +# Get-AzProviderHubResourceTypeRegistration + +## SYNOPSIS +Gets a resource type details in the given subscription and provider. + +## SYNTAX + +### List (Default) +``` +Get-AzProviderHubResourceTypeRegistration -ProviderNamespace <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzProviderHubResourceTypeRegistration -ProviderNamespace <String> -ResourceType <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzProviderHubResourceTypeRegistration -InputObject <IProviderHubIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a resource type details in the given subscription and provider. + +## EXAMPLES + +### Example 1: List all resource types under the resource provider namespace. +```powershell +Get-AzProviderHubResourceTypeRegistration -ProviderNamespace "Microsoft.Contoso" +``` + +```output +Name Type +---- ---- +testResourceType1 Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations +testResourceType2 Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations +``` + +List all resource types under the resource provider namespace. + +### Example 2: Gets a resource type by name. +```powershell +Get-AzProviderHubResourceTypeRegistration -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType1" +``` + +```output +Name Type +---- ---- +testResourceType1 Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations +``` + +Gets a resource type by name. + +### Example 3: Gets a nested resource type by name. +```powershell +Get-AzProviderHubResourceTypeRegistration -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType1/nestedResourceType" +``` + +```output +Name Type +---- ---- +testResourceType1/nestedResourceType Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations +``` + +Gets a resource type by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IResourceTypeRegistration + +## 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 `<IProviderHubIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[NestedResourceTypeFirst <String>]`: The first child resource type. + - `[NestedResourceTypeSecond <String>]`: The second child resource type. + - `[NestedResourceTypeThird <String>]`: The third child resource type. + - `[NotificationRegistrationName <String>]`: The notification registration. + - `[ProviderNamespace <String>]`: The name of the resource provider hosted within ProviderHub. + - `[ResourceType <String>]`: The resource type. + - `[RolloutName <String>]`: The rollout name. + - `[Sku <String>]`: The SKU. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubSku.md b/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubSku.md new file mode 100644 index 0000000000..ddc7c52525 --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Get-AzProviderHubSku.md @@ -0,0 +1,256 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/get-azproviderhubsku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Get-AzProviderHubSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Get-AzProviderHubSku.md +--- + +# Get-AzProviderHubSku + +## SYNOPSIS +Gets the sku details for the given resource type and sku name. + +## SYNTAX + +### List (Default) +``` +Get-AzProviderHubSku -ProviderNamespace <String> -ResourceType <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzProviderHubSku -ProviderNamespace <String> -ResourceType <String> -Sku <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzProviderHubSku -InputObject <IProviderHubIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzProviderHubSku -NestedResourceTypeFirst <String> -ProviderNamespace <String> -ResourceType <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List2 +``` +Get-AzProviderHubSku -NestedResourceTypeFirst <String> -NestedResourceTypeSecond <String> + -ProviderNamespace <String> -ResourceType <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List3 +``` +Get-AzProviderHubSku -NestedResourceTypeFirst <String> -NestedResourceTypeSecond <String> + -NestedResourceTypeThird <String> -ProviderNamespace <String> -ResourceType <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the sku details for the given resource type and sku name. + +## EXAMPLES + +### Example 1: Get the resource SKU definition. +```powershell +Get-AzProviderHubSku -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType" -Sku "default" +``` + +```output +Name Type +---- ---- +testResourceType Microsoft.ProviderHub/providerRegistrations/skus +``` + +Get the resource SKU definition. + +### Example 2: Get the nested resource type SKU definition. +```powershell +Get-AzProviderHubSku -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType/nestedResourceType" -Sku "default" +``` + +```output +Name Type +---- ---- +testResourceType/nestedResourceType Microsoft.ProviderHub/providerRegistrations/skus +``` + +Get the nested resource type SKU definition. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NestedResourceTypeFirst +The first child resource type. + +```yaml +Type: System.String +Parameter Sets: List1, List2, List3 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NestedResourceTypeSecond +The second child resource type. + +```yaml +Type: System.String +Parameter Sets: List2, List3 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NestedResourceTypeThird +The third child resource type. + +```yaml +Type: System.String +Parameter Sets: List3 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: Get, List, List1, List2, List3 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. + +```yaml +Type: System.String +Parameter Sets: Get, List, List1, List2, List3 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SKU. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1, List2, List3 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.ISkuResource + +## 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 `<IProviderHubIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[NestedResourceTypeFirst <String>]`: The first child resource type. + - `[NestedResourceTypeSecond <String>]`: The second child resource type. + - `[NestedResourceTypeThird <String>]`: The third child resource type. + - `[NotificationRegistrationName <String>]`: The notification registration. + - `[ProviderNamespace <String>]`: The name of the resource provider hosted within ProviderHub. + - `[ResourceType <String>]`: The resource type. + - `[RolloutName <String>]`: The rollout name. + - `[Sku <String>]`: The SKU. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/Invoke-AzProviderHubManifestCheckin.md b/azps-10.1.0/Az.ProviderHub/Invoke-AzProviderHubManifestCheckin.md new file mode 100644 index 0000000000..394266cb5e --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Invoke-AzProviderHubManifestCheckin.md @@ -0,0 +1,176 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/invoke-azproviderhubmanifestcheckin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Invoke-AzProviderHubManifestCheckin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Invoke-AzProviderHubManifestCheckin.md +--- + +# Invoke-AzProviderHubManifestCheckin + +## SYNOPSIS +Checkin the manifest. + +## SYNTAX + +``` +Invoke-AzProviderHubManifestCheckin -ProviderNamespace <String> -BaselineArmManifestLocation <String> + -Environment <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Checkin the manifest. + +## EXAMPLES + +### Example 1: Checkin the resource provider manifest. +```powershell +Invoke-AzProviderHubManifestCheckin -ProviderNamespace "Microsoft.Contoso" -BaselineArmManifestLocation "NorthEurope" -Environment "Canary" +``` + +```output +CommitId IsCheckedIn PullRequest StatusMessage +-------- ----------- ----------- ------------- + False Manifest is successfully merged. +``` + +Checkin the resource provider manifest. + +### Example 2: Checkin the resource provider manifest. +```powershell +Invoke-AzProviderHubManifestCheckin -ProviderNamespace "Microsoft.Contoso" -BaselineArmManifestLocation "EastUS2EUAP" -Environment "Prod" +``` + +```output +CommitId IsCheckedIn PullRequest StatusMessage +-------- ----------- ----------- ------------- + False Manifest is successfully merged. +``` + +Checkin the resource provider manifest. + +## PARAMETERS + +### -BaselineArmManifestLocation +The baseline ARM manifest location supplied to the checkin manifest operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Environment +The environment supplied to the checkin manifest operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.ICheckinManifestInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/New-AzProviderHubCustomRollout.md b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubCustomRollout.md new file mode 100644 index 0000000000..26e4e71eed --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubCustomRollout.md @@ -0,0 +1,365 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/new-azproviderhubcustomrollout +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubCustomRollout.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubCustomRollout.md +--- + +# New-AzProviderHubCustomRollout + +## SYNOPSIS +Creates or updates the rollout details. + +## SYNTAX + +``` +New-AzProviderHubCustomRollout -ProviderNamespace <String> -RolloutName <String> [-SubscriptionId <String>] + [-CanaryRegion <String[]>] [-ProvisioningState <ProvisioningState>] + [-SpecificationProviderRegistration <IProviderRegistration>] + [-SpecificationResourceTypeRegistration <IResourceTypeRegistration[]>] [-StatusCompletedRegion <String[]>] + [-StatusFailedOrSkippedRegion <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the rollout details. + +## EXAMPLES + +### Example 1: Create/Update a resource provider custom rollout. +```powershell +New-AzProviderHubCustomRollout -ProviderNamespace "Microsoft.Contoso" -RolloutName "customRollout1" -CanaryRegion "Eastus2EUAP" +``` + +```output +Name Type +---- ---- +customRollout1 Microsoft.ProviderHub/providerRegistrations/customRollouts +``` + +Create/Update a resource provider custom rollout. + +## PARAMETERS + +### -CanaryRegion +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisioningState +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.ProvisioningState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RolloutName +The rollout name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpecificationProviderRegistration +. +To construct, see NOTES section for SPECIFICATIONPROVIDERREGISTRATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IProviderRegistration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpecificationResourceTypeRegistration +. +To construct, see NOTES section for SPECIFICATIONRESOURCETYPEREGISTRATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IResourceTypeRegistration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusCompletedRegion +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusFailedOrSkippedRegion +Dictionary of \<ExtendedErrorInfo\> + +```yaml +Type: System.Collections.Hashtable +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.ICustomRollout + +## 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. + + +SPECIFICATIONPROVIDERREGISTRATION `<IProviderRegistration>`: . + - `[Capability <IResourceProviderCapabilities[]>]`: + - `Effect <ResourceProviderCapabilitiesEffect>`: + - `QuotaId <String>`: + - `[RequiredFeature <String[]>]`: + - `[FeatureRuleRequiredFeaturesPolicy <String>]`: + - `[ManagementIncidentContactEmail <String>]`: + - `[ManagementIncidentRoutingService <String>]`: + - `[ManagementIncidentRoutingTeam <String>]`: + - `[ManagementManifestOwner <String[]>]`: + - `[ManagementResourceAccessPolicy <String>]`: + - `[ManagementResourceAccessRole <IAny[]>]`: + - `[ManagementSchemaOwner <String[]>]`: + - `[ManagementServiceTreeInfo <IServiceTreeInfo[]>]`: + - `[ComponentId <String>]`: + - `[ServiceId <String>]`: + - `[Metadata <IAny>]`: Any object + - `[Namespace <String>]`: + - `[ProviderAuthenticationAllowedAudience <String[]>]`: + - `[ProviderAuthorization <IResourceProviderAuthorization[]>]`: + - `[ApplicationId <String>]`: + - `[ManagedByRoleDefinitionId <String>]`: + - `[RoleDefinitionId <String>]`: + - `[ProviderHubMetadataProviderAuthenticationAllowedAudience <String[]>]`: + - `[ProviderHubMetadataProviderAuthorization <IResourceProviderAuthorization[]>]`: + - `[ProviderType <ResourceProviderType?>]`: + - `[ProviderVersion <String>]`: + - `[ProvisioningState <ProvisioningState?>]`: + - `[RequestHeaderOptionOptInHeader <OptInHeaderType?>]`: + - `[RequiredFeature <String[]>]`: + - `[SubscriptionLifecycleNotificationSpecificationSoftDeleteTtl <TimeSpan?>]`: + - `[SubscriptionLifecycleNotificationSpecificationSubscriptionStateOverrideAction <ISubscriptionStateOverrideAction[]>]`: + - `Action <SubscriptionNotificationOperation>`: + - `State <SubscriptionTransitioningState>`: + - `[TemplateDeploymentOptionPreflightOption <PreflightOption[]>]`: + - `[TemplateDeploymentOptionPreflightSupported <Boolean?>]`: + - `[ThirdPartyProviderAuthorizationAuthorization <ILightHouseAuthorization[]>]`: + - `PrincipalId <String>`: + - `RoleDefinitionId <String>`: + - `[ThirdPartyProviderAuthorizationManagedByTenantId <String>]`: + +SPECIFICATIONRESOURCETYPEREGISTRATION <IResourceTypeRegistration[]>: . + - `[AllowedUnauthorizedAction <String[]>]`: + - `[AuthorizationActionMapping <IAuthorizationActionMapping[]>]`: + - `[Desired <String>]`: + - `[Original <String>]`: + - `[CheckNameAvailabilitySpecificationEnableDefaultValidation <Boolean?>]`: + - `[CheckNameAvailabilitySpecificationResourceTypesWithCustomValidation <String[]>]`: + - `[DefaultApiVersion <String>]`: + - `[DisallowedActionVerb <String[]>]`: + - `[EnableAsyncOperation <Boolean?>]`: + - `[EnableThirdPartyS2S <Boolean?>]`: + - `[Endpoint <IResourceTypeEndpoint[]>]`: + - `[ApiVersion <String[]>]`: + - `[Enabled <Boolean?>]`: + - `[Extension <IResourceTypeExtension[]>]`: + - `[EndpointUri <String>]`: + - `[ExtensionCategory <ExtensionCategory[]>]`: + - `[Timeout <TimeSpan?>]`: + - `[FeatureRuleRequiredFeaturesPolicy <String>]`: + - `[Location <String[]>]`: + - `[RequiredFeature <String[]>]`: + - `[Timeout <TimeSpan?>]`: + - `[ExtendedLocation <IExtendedLocationOptions[]>]`: + - `[SupportedPolicy <String>]`: + - `[Type <String>]`: + - `[FeatureRuleRequiredFeaturesPolicy <String>]`: + - `[IdentityManagementApplicationId <String>]`: + - `[IdentityManagementType <IdentityManagementTypes?>]`: + - `[IsPureProxy <Boolean?>]`: + - `[LinkedAccessCheck <ILinkedAccessCheck[]>]`: + - `[ActionName <String>]`: + - `[LinkedAction <String>]`: + - `[LinkedActionVerb <String>]`: + - `[LinkedProperty <String>]`: + - `[LinkedType <String>]`: + - `[LoggingRule <ILoggingRule[]>]`: + - `Action <String>`: + - `DetailLevel <LoggingDetails>`: + - `Direction <LoggingDirections>`: + - `[HiddenPropertyPathHiddenPathsOnRequest <String[]>]`: + - `[HiddenPropertyPathHiddenPathsOnResponse <String[]>]`: + - `[MarketplaceType <String>]`: + - `[ProvisioningState <ProvisioningState?>]`: + - `[Regionality <Regionality?>]`: + - `[RequestHeaderOptionOptInHeader <OptInHeaderType?>]`: + - `[RequiredFeature <String[]>]`: + - `[ResourceCreationBeginRequest <ExtensionOptionType[]>]`: + - `[ResourceCreationBeginResponse <ExtensionOptionType[]>]`: + - `[ResourceDeletionPolicy <ResourceDeletionPolicy?>]`: + - `[ResourceMovePolicyCrossResourceGroupMoveEnabled <Boolean?>]`: + - `[ResourceMovePolicyCrossSubscriptionMoveEnabled <Boolean?>]`: + - `[ResourceMovePolicyValidationRequired <Boolean?>]`: + - `[RoutingType <RoutingType?>]`: + - `[ServiceTreeInfo <IServiceTreeInfo[]>]`: + - `[ComponentId <String>]`: + - `[ServiceId <String>]`: + - `[SubscriptionLifecycleNotificationSpecificationSoftDeleteTtl <TimeSpan?>]`: + - `[SubscriptionLifecycleNotificationSpecificationSubscriptionStateOverrideAction <ISubscriptionStateOverrideAction[]>]`: + - `Action <SubscriptionNotificationOperation>`: + - `State <SubscriptionTransitioningState>`: + - `[SubscriptionStateRule <ISubscriptionStateRule[]>]`: + - `[AllowedAction <String[]>]`: + - `[State <SubscriptionState?>]`: + - `[SwaggerSpecification <ISwaggerSpecification[]>]`: + - `[ApiVersion <String[]>]`: + - `[SwaggerSpecFolderUri <String>]`: + - `[TemplateDeploymentOptionPreflightOption <PreflightOption[]>]`: + - `[TemplateDeploymentOptionPreflightSupported <Boolean?>]`: + - `[ThrottlingRule <IThrottlingRule[]>]`: + - `Action <String>`: + - `Metric <IThrottlingMetric[]>`: + - `Limit <Int64>`: + - `Type <ThrottlingMetricType>`: + - `[Interval <TimeSpan?>]`: + - `[RequiredFeature <String[]>]`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/New-AzProviderHubDefaultRollout.md b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubDefaultRollout.md new file mode 100644 index 0000000000..c7eeaa0c35 --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubDefaultRollout.md @@ -0,0 +1,611 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/new-azproviderhubdefaultrollout +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubDefaultRollout.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubDefaultRollout.md +--- + +# New-AzProviderHubDefaultRollout + +## SYNOPSIS +Creates or updates the rollout details. + +## SYNTAX + +``` +New-AzProviderHubDefaultRollout -ProviderNamespace <String> -RolloutName <String> [-SubscriptionId <String>] + [-CanaryRegion <String[]>] [-CanarySkipRegion <String[]>] [-HighTrafficRegion <String[]>] + [-HighTrafficWaitDuration <TimeSpan>] [-LowTrafficRegion <String[]>] [-LowTrafficWaitDuration <TimeSpan>] + [-MediumTrafficRegion <String[]>] [-MediumTrafficWaitDuration <TimeSpan>] + [-ProvisioningState <ProvisioningState>] [-RestOfTheWorldGroupOneRegion <String[]>] + [-RestOfTheWorldGroupOneWaitDuration <TimeSpan>] [-RestOfTheWorldGroupTwoRegion <String[]>] + [-RestOfTheWorldGroupTwoWaitDuration <TimeSpan>] [-SpecificationProviderRegistration <IProviderRegistration>] + [-SpecificationResourceTypeRegistration <IResourceTypeRegistration[]>] [-StatusCompletedRegion <String[]>] + [-StatusFailedOrSkippedRegion <Hashtable>] [-StatusNextTrafficRegion <TrafficRegionCategory>] + [-StatusNextTrafficRegionScheduledTime <DateTime>] + [-StatusSubscriptionReregistrationResult <SubscriptionReregistrationResult>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the rollout details. + +## EXAMPLES + +### Example 1: Create/Update a resource provider default rollout. +```powershell +New-AzProviderHubDefaultRollout -ProviderNamespace "Microsoft.Contoso" -RolloutName "defaultRollout2021w10" -CanarySkipRegion "brazilus" -NoWait +``` + +```output +Name Type +---- ---- +defaultRollout2021w10 Microsoft.ProviderHub/providerRegistrations/defaultRollouts +``` + +Create/Update a resource provider default rollout. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CanaryRegion +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CanarySkipRegion +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighTrafficRegion +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighTrafficWaitDuration +. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LowTrafficRegion +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LowTrafficWaitDuration +. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MediumTrafficRegion +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MediumTrafficWaitDuration +. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisioningState +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.ProvisioningState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestOfTheWorldGroupOneRegion +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestOfTheWorldGroupOneWaitDuration +. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestOfTheWorldGroupTwoRegion +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestOfTheWorldGroupTwoWaitDuration +. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RolloutName +The rollout name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpecificationProviderRegistration +. +To construct, see NOTES section for SPECIFICATIONPROVIDERREGISTRATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IProviderRegistration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpecificationResourceTypeRegistration +. +To construct, see NOTES section for SPECIFICATIONRESOURCETYPEREGISTRATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IResourceTypeRegistration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusCompletedRegion +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusFailedOrSkippedRegion +Dictionary of \<ExtendedErrorInfo\> + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusNextTrafficRegion +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.TrafficRegionCategory +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusNextTrafficRegionScheduledTime +. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusSubscriptionReregistrationResult +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.SubscriptionReregistrationResult +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IDefaultRollout + +## 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. + + +SPECIFICATIONPROVIDERREGISTRATION `<IProviderRegistration>`: . + - `[Capability <IResourceProviderCapabilities[]>]`: + - `Effect <ResourceProviderCapabilitiesEffect>`: + - `QuotaId <String>`: + - `[RequiredFeature <String[]>]`: + - `[FeatureRuleRequiredFeaturesPolicy <String>]`: + - `[ManagementIncidentContactEmail <String>]`: + - `[ManagementIncidentRoutingService <String>]`: + - `[ManagementIncidentRoutingTeam <String>]`: + - `[ManagementManifestOwner <String[]>]`: + - `[ManagementResourceAccessPolicy <String>]`: + - `[ManagementResourceAccessRole <IAny[]>]`: + - `[ManagementSchemaOwner <String[]>]`: + - `[ManagementServiceTreeInfo <IServiceTreeInfo[]>]`: + - `[ComponentId <String>]`: + - `[ServiceId <String>]`: + - `[Metadata <IAny>]`: Any object + - `[Namespace <String>]`: + - `[ProviderAuthenticationAllowedAudience <String[]>]`: + - `[ProviderAuthorization <IResourceProviderAuthorization[]>]`: + - `[ApplicationId <String>]`: + - `[ManagedByRoleDefinitionId <String>]`: + - `[RoleDefinitionId <String>]`: + - `[ProviderHubMetadataProviderAuthenticationAllowedAudience <String[]>]`: + - `[ProviderHubMetadataProviderAuthorization <IResourceProviderAuthorization[]>]`: + - `[ProviderType <ResourceProviderType?>]`: + - `[ProviderVersion <String>]`: + - `[ProvisioningState <ProvisioningState?>]`: + - `[RequestHeaderOptionOptInHeader <OptInHeaderType?>]`: + - `[RequiredFeature <String[]>]`: + - `[SubscriptionLifecycleNotificationSpecificationSoftDeleteTtl <TimeSpan?>]`: + - `[SubscriptionLifecycleNotificationSpecificationSubscriptionStateOverrideAction <ISubscriptionStateOverrideAction[]>]`: + - `Action <SubscriptionNotificationOperation>`: + - `State <SubscriptionTransitioningState>`: + - `[TemplateDeploymentOptionPreflightOption <PreflightOption[]>]`: + - `[TemplateDeploymentOptionPreflightSupported <Boolean?>]`: + - `[ThirdPartyProviderAuthorizationAuthorization <ILightHouseAuthorization[]>]`: + - `PrincipalId <String>`: + - `RoleDefinitionId <String>`: + - `[ThirdPartyProviderAuthorizationManagedByTenantId <String>]`: + +SPECIFICATIONRESOURCETYPEREGISTRATION <IResourceTypeRegistration[]>: . + - `[AllowedUnauthorizedAction <String[]>]`: + - `[AuthorizationActionMapping <IAuthorizationActionMapping[]>]`: + - `[Desired <String>]`: + - `[Original <String>]`: + - `[CheckNameAvailabilitySpecificationEnableDefaultValidation <Boolean?>]`: + - `[CheckNameAvailabilitySpecificationResourceTypesWithCustomValidation <String[]>]`: + - `[DefaultApiVersion <String>]`: + - `[DisallowedActionVerb <String[]>]`: + - `[EnableAsyncOperation <Boolean?>]`: + - `[EnableThirdPartyS2S <Boolean?>]`: + - `[Endpoint <IResourceTypeEndpoint[]>]`: + - `[ApiVersion <String[]>]`: + - `[Enabled <Boolean?>]`: + - `[Extension <IResourceTypeExtension[]>]`: + - `[EndpointUri <String>]`: + - `[ExtensionCategory <ExtensionCategory[]>]`: + - `[Timeout <TimeSpan?>]`: + - `[FeatureRuleRequiredFeaturesPolicy <String>]`: + - `[Location <String[]>]`: + - `[RequiredFeature <String[]>]`: + - `[Timeout <TimeSpan?>]`: + - `[ExtendedLocation <IExtendedLocationOptions[]>]`: + - `[SupportedPolicy <String>]`: + - `[Type <String>]`: + - `[FeatureRuleRequiredFeaturesPolicy <String>]`: + - `[IdentityManagementApplicationId <String>]`: + - `[IdentityManagementType <IdentityManagementTypes?>]`: + - `[IsPureProxy <Boolean?>]`: + - `[LinkedAccessCheck <ILinkedAccessCheck[]>]`: + - `[ActionName <String>]`: + - `[LinkedAction <String>]`: + - `[LinkedActionVerb <String>]`: + - `[LinkedProperty <String>]`: + - `[LinkedType <String>]`: + - `[LoggingRule <ILoggingRule[]>]`: + - `Action <String>`: + - `DetailLevel <LoggingDetails>`: + - `Direction <LoggingDirections>`: + - `[HiddenPropertyPathHiddenPathsOnRequest <String[]>]`: + - `[HiddenPropertyPathHiddenPathsOnResponse <String[]>]`: + - `[MarketplaceType <String>]`: + - `[ProvisioningState <ProvisioningState?>]`: + - `[Regionality <Regionality?>]`: + - `[RequestHeaderOptionOptInHeader <OptInHeaderType?>]`: + - `[RequiredFeature <String[]>]`: + - `[ResourceCreationBeginRequest <ExtensionOptionType[]>]`: + - `[ResourceCreationBeginResponse <ExtensionOptionType[]>]`: + - `[ResourceDeletionPolicy <ResourceDeletionPolicy?>]`: + - `[ResourceMovePolicyCrossResourceGroupMoveEnabled <Boolean?>]`: + - `[ResourceMovePolicyCrossSubscriptionMoveEnabled <Boolean?>]`: + - `[ResourceMovePolicyValidationRequired <Boolean?>]`: + - `[RoutingType <RoutingType?>]`: + - `[ServiceTreeInfo <IServiceTreeInfo[]>]`: + - `[ComponentId <String>]`: + - `[ServiceId <String>]`: + - `[SubscriptionLifecycleNotificationSpecificationSoftDeleteTtl <TimeSpan?>]`: + - `[SubscriptionLifecycleNotificationSpecificationSubscriptionStateOverrideAction <ISubscriptionStateOverrideAction[]>]`: + - `Action <SubscriptionNotificationOperation>`: + - `State <SubscriptionTransitioningState>`: + - `[SubscriptionStateRule <ISubscriptionStateRule[]>]`: + - `[AllowedAction <String[]>]`: + - `[State <SubscriptionState?>]`: + - `[SwaggerSpecification <ISwaggerSpecification[]>]`: + - `[ApiVersion <String[]>]`: + - `[SwaggerSpecFolderUri <String>]`: + - `[TemplateDeploymentOptionPreflightOption <PreflightOption[]>]`: + - `[TemplateDeploymentOptionPreflightSupported <Boolean?>]`: + - `[ThrottlingRule <IThrottlingRule[]>]`: + - `Action <String>`: + - `Metric <IThrottlingMetric[]>`: + - `Limit <Int64>`: + - `Type <ThrottlingMetricType>`: + - `[Interval <TimeSpan?>]`: + - `[RequiredFeature <String[]>]`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/New-AzProviderHubManifest.md b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubManifest.md new file mode 100644 index 0000000000..8be6be43b4 --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubManifest.md @@ -0,0 +1,187 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/new-azproviderhubmanifest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubManifest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubManifest.md +--- + +# New-AzProviderHubManifest + +## SYNOPSIS +Generates the manifest for the given provider. + +## SYNTAX + +### Generate (Default) +``` +New-AzProviderHubManifest -ProviderNamespace <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### GenerateViaIdentity +``` +New-AzProviderHubManifest -InputObject <IProviderHubIdentity> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Generates the manifest for the given provider. + +## EXAMPLES + +### Example 1: Generate the resource provider manifest. +```powershell +New-AzProviderHubManifest -ProviderNamespace "Microsoft.Contoso" +``` + +```output +Namespace ProviderType ProviderVersion RequiredFeature +--------- ------------ --------------- --------------- +Microsoft.Contoso Internal, Hidden 2.0 +``` + +Generate the resource provider manifest. + +### Example 2: Generate the resource provider manifest. +```powershell +New-AzProviderHubManifest -ProviderNamespace "Microsoft.Contoso" +``` + +```output +Namespace ProviderType ProviderVersion RequiredFeature +--------- ------------ --------------- --------------- +Microsoft.Contoso Internal, Hidden 2.0 +``` + +Generate the resource provider manifest. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity +Parameter Sets: GenerateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: Generate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Generate +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IResourceProviderManifest + +## 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 `<IProviderHubIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[NestedResourceTypeFirst <String>]`: The first child resource type. + - `[NestedResourceTypeSecond <String>]`: The second child resource type. + - `[NestedResourceTypeThird <String>]`: The third child resource type. + - `[NotificationRegistrationName <String>]`: The notification registration. + - `[ProviderNamespace <String>]`: The name of the resource provider hosted within ProviderHub. + - `[ResourceType <String>]`: The resource type. + - `[RolloutName <String>]`: The rollout name. + - `[Sku <String>]`: The SKU. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/New-AzProviderHubNotificationRegistration.md b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubNotificationRegistration.md new file mode 100644 index 0000000000..2e9052aa5c --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubNotificationRegistration.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/new-azproviderhubnotificationregistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubNotificationRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubNotificationRegistration.md +--- + +# New-AzProviderHubNotificationRegistration + +## SYNOPSIS +Creates or updates a notification registration. + +## SYNTAX + +``` +New-AzProviderHubNotificationRegistration -Name <String> -ProviderNamespace <String> + [-SubscriptionId <String>] [-IncludedEvent <String[]>] [-MessageScope <MessageScope>] + [-NotificationEndpoint <INotificationEndpoint[]>] [-NotificationMode <NotificationMode>] + [-ProvisioningState <ProvisioningState>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a notification registration. + +## EXAMPLES + +### Example 1: Create/Update a notification registration. +```powershell +New-AzProviderHubNotificationRegistration -ProviderNamespace "Microsoft.Contoso" -Name "notificationRegistrationTest" -NotificationMode "EventHub" -MessageScope "RegisteredSubscriptions" -IncludedEvent "*/write", "Microsoft.Contoso/testResourceType/delete" -NotificationEndpoint @{Location = "", "East US"; NotificationDestination = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications"} +``` + +```output +Name +---- +notificationRegistrationTest +``` + +Create/Update a notification registration. + +### Example 2: Create/Update a notification registration. +```powershell +New-AzProviderHubNotificationRegistration -ProviderNamespace "Microsoft.Contoso" -Name "notificationRegistrationTest" -NotificationMode "EventHub" -MessageScope "RegisteredSubscriptions" -IncludedEvent "*/write", "Microsoft.Contoso/testResourceType/delete" -NotificationEndpoint @{Location = "", "East US"; NotificationDestination = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications"} +``` + +```output +Name +---- +notificationRegistrationTest +``` + +Create/Update a notification registration. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedEvent +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageScope +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.MessageScope +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The notification registration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: NotificationRegistrationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEndpoint +. +To construct, see NOTES section for NOTIFICATIONENDPOINT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.INotificationEndpoint[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationMode +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.NotificationMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisioningState +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.ProvisioningState +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.INotificationRegistration + +## 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. + + +NOTIFICATIONENDPOINT <INotificationEndpoint[]>: . + - `[Location <String[]>]`: + - `[NotificationDestination <String>]`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/New-AzProviderHubProviderRegistration.md b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubProviderRegistration.md new file mode 100644 index 0000000000..0fbbfe2e5f --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubProviderRegistration.md @@ -0,0 +1,634 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/new-azproviderhubproviderregistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubProviderRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubProviderRegistration.md +--- + +# New-AzProviderHubProviderRegistration + +## SYNOPSIS +Creates or updates the provider registration. + +## SYNTAX + +``` +New-AzProviderHubProviderRegistration -ProviderNamespace <String> [-SubscriptionId <String>] + [-Capability <IResourceProviderCapabilities[]>] [-FeatureRuleRequiredFeaturesPolicy <String>] + [-ManagementIncidentContactEmail <String>] [-ManagementIncidentRoutingService <String>] + [-ManagementIncidentRoutingTeam <String>] [-ManagementManifestOwner <String[]>] + [-ManagementResourceAccessPolicy <String>] [-ManagementResourceAccessRole <IAny[]>] + [-ManagementSchemaOwner <String[]>] [-ManagementServiceTreeInfo <IServiceTreeInfo[]>] [-Metadata <IAny>] + [-Namespace <String>] [-ProviderAuthenticationAllowedAudience <String[]>] + [-ProviderAuthorization <IResourceProviderAuthorization[]>] + [-ProviderHubMetadataProviderAuthenticationAllowedAudience <String[]>] + [-ProviderHubMetadataProviderAuthorization <IResourceProviderAuthorization[]>] + [-ProviderType <ResourceProviderType>] [-ProviderVersion <String>] [-ProvisioningState <ProvisioningState>] + [-RequestHeaderOptionOptInHeader <OptInHeaderType>] [-RequiredFeature <String[]>] + [-SubscriptionLifecycleNotificationSpecificationSoftDeleteTtl <TimeSpan>] + [-SubscriptionLifecycleNotificationSpecificationSubscriptionStateOverrideAction <ISubscriptionStateOverrideAction[]>] + [-TemplateDeploymentOptionPreflightOption <PreflightOption[]>] [-TemplateDeploymentOptionPreflightSupported] + [-ThirdPartyProviderAuthorizationAuthorization <ILightHouseAuthorization[]>] + [-ThirdPartyProviderAuthorizationManagedByTenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the provider registration. + +## EXAMPLES + +### Example 1: Create/Update a provider registration. +```powershell +New-AzProviderHubProviderRegistration -ProviderNamespace "Microsoft.Contoso" -ProviderHubMetadataProviderAuthenticationAllowedAudience "https://management.core.windows.net/" -ProviderHubMetadataProviderAuthorization @{ApplicationId = "00000000-0000-0000-0000-000000000000"; RoleDefinitionId = "00000000-0000-0000-0000-000000000000"} -Namespace "Microsoft.Contoso" -ProviderVersion "2.0" -ProviderType "Internal" -ManagementManifestOwner "SPARTA-PlatformServiceAdministrator" -ManagementIncidentContactEmail "help@microsoft.com" -ManagementIncidentRoutingService "Contoso Service" -ManagementIncidentRoutingTeam "Contoso Team" -ManagementServiceTreeInfo @{ComponentId = "00000000-0000-0000-0000-000000000000"; ServiceId = "00000000-0000-0000-0000-000000000000"} -Capability @{QuotaId = "CSP_2015-05-01"; Effect = "Allow"}, @{QuotaId = "CSP_MG_2017-12-01"; Effect = "Allow"} +``` + +```output +Name Type +---- ---- +Microsoft.Contoso Microsoft.ProviderHub/providerRegistrations +``` + +Create/Update a provider registration. + +### Example 2: Create/Update a provider registration. +```powershell +New-AzProviderHubProviderRegistration -ProviderNamespace "Microsoft.Contoso" -ProviderHubMetadataProviderAuthenticationAllowedAudience "https://management.core.windows.net/" -ProviderHubMetadataProviderAuthorization @{ApplicationId = "00000000-0000-0000-0000-000000000000"; RoleDefinitionId = "00000000-0000-0000-0000-000000000000"} -Namespace "Microsoft.Contoso" -ProviderVersion "2.0" -ProviderType "Hidden" -ManagementManifestOwner "SPARTA-PlatformServiceAdministrator" -ManagementIncidentContactEmail "help@microsoft.com" -ManagementIncidentRoutingService "Contoso Service" -ManagementIncidentRoutingTeam "Contoso Team" -ManagementServiceTreeInfo @{ComponentId = "00000000-0000-0000-0000-000000000000"; ServiceId = "00000000-0000-0000-0000-000000000000"} -Capability @{QuotaId = "CSP_2015-05-01"; Effect = "Allow"}, @{QuotaId = "CSP_MG_2017-12-01"; Effect = "Allow"} +``` + +```output +Name Type +---- ---- +Microsoft.Contoso Microsoft.ProviderHub/providerRegistrations +``` + +Create/Update a provider registration. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Capability +. +To construct, see NOTES section for CAPABILITY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IResourceProviderCapabilities[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureRuleRequiredFeaturesPolicy +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementIncidentContactEmail +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementIncidentRoutingService +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementIncidentRoutingTeam +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementManifestOwner +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementResourceAccessPolicy +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementResourceAccessRole +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IAny[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementSchemaOwner +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementServiceTreeInfo +. +To construct, see NOTES section for MANAGEMENTSERVICETREEINFO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IServiceTreeInfo[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Any object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IAny +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderAuthenticationAllowedAudience +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderAuthorization +. +To construct, see NOTES section for PROVIDERAUTHORIZATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IResourceProviderAuthorization[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderHubMetadataProviderAuthenticationAllowedAudience +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderHubMetadataProviderAuthorization +. +To construct, see NOTES section for PROVIDERHUBMETADATAPROVIDERAUTHORIZATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IResourceProviderAuthorization[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderType +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.ResourceProviderType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderVersion +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisioningState +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.ProvisioningState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestHeaderOptionOptInHeader +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.OptInHeaderType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredFeature +. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionLifecycleNotificationSpecificationSoftDeleteTtl +. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionLifecycleNotificationSpecificationSubscriptionStateOverrideAction +. +To construct, see NOTES section for SUBSCRIPTIONLIFECYCLENOTIFICATIONSPECIFICATIONSUBSCRIPTIONSTATEOVERRIDEACTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.ISubscriptionStateOverrideAction[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateDeploymentOptionPreflightOption +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.PreflightOption[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateDeploymentOptionPreflightSupported +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThirdPartyProviderAuthorizationAuthorization +. +To construct, see NOTES section for THIRDPARTYPROVIDERAUTHORIZATIONAUTHORIZATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.ILightHouseAuthorization[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThirdPartyProviderAuthorizationManagedByTenantId +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IProviderRegistration + +## 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. + + +CAPABILITY <IResourceProviderCapabilities[]>: . + - `Effect <ResourceProviderCapabilitiesEffect>`: + - `QuotaId <String>`: + - `[RequiredFeature <String[]>]`: + +MANAGEMENTSERVICETREEINFO <IServiceTreeInfo[]>: . + - `[ComponentId <String>]`: + - `[ServiceId <String>]`: + +PROVIDERAUTHORIZATION <IResourceProviderAuthorization[]>: . + - `[ApplicationId <String>]`: + - `[ManagedByRoleDefinitionId <String>]`: + - `[RoleDefinitionId <String>]`: + +PROVIDERHUBMETADATAPROVIDERAUTHORIZATION <IResourceProviderAuthorization[]>: . + - `[ApplicationId <String>]`: + - `[ManagedByRoleDefinitionId <String>]`: + - `[RoleDefinitionId <String>]`: + +SUBSCRIPTIONLIFECYCLENOTIFICATIONSPECIFICATIONSUBSCRIPTIONSTATEOVERRIDEACTION <ISubscriptionStateOverrideAction[]>: . + - `Action <SubscriptionNotificationOperation>`: + - `State <SubscriptionTransitioningState>`: + +THIRDPARTYPROVIDERAUTHORIZATIONAUTHORIZATION <ILightHouseAuthorization[]>: . + - `PrincipalId <String>`: + - `RoleDefinitionId <String>`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/New-AzProviderHubResourceTypeRegistration.md b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubResourceTypeRegistration.md new file mode 100644 index 0000000000..5916fcbda8 --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubResourceTypeRegistration.md @@ -0,0 +1,823 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/new-azproviderhubresourcetyperegistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubResourceTypeRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubResourceTypeRegistration.md +--- + +# New-AzProviderHubResourceTypeRegistration + +## SYNOPSIS +Creates or updates a resource type. + +## SYNTAX + +``` +New-AzProviderHubResourceTypeRegistration -ProviderNamespace <String> -ResourceType <String> + [-SubscriptionId <String>] [-AllowedUnauthorizedAction <String[]>] + [-AuthorizationActionMapping <IAuthorizationActionMapping[]>] + [-CheckNameAvailabilitySpecificationEnableDefaultValidation] + [-CheckNameAvailabilitySpecificationResourceTypesWithCustomValidation <String[]>] + [-DefaultApiVersion <String>] [-DisallowedActionVerb <String[]>] [-EnableAsyncOperation] + [-EnableThirdPartyS2S] [-Endpoint <IResourceTypeEndpoint[]>] [-ExtendedLocation <IExtendedLocationOptions[]>] + [-FeatureRuleRequiredFeaturesPolicy <String>] [-IdentityManagementApplicationId <String>] + [-IdentityManagementType <IdentityManagementTypes>] [-IsPureProxy] + [-LinkedAccessCheck <ILinkedAccessCheck[]>] [-LoggingRule <ILoggingRule[]>] [-MarketplaceType <String>] + [-ProvisioningState <ProvisioningState>] [-Regionality <Regionality>] + [-RequestHeaderOptionOptInHeader <OptInHeaderType>] [-RequiredFeature <String[]>] + [-ResourceCreationBeginRequest <ExtensionOptionType[]>] + [-ResourceCreationBeginResponse <ExtensionOptionType[]>] [-ResourceDeletionPolicy <ResourceDeletionPolicy>] + [-ResourceMovePolicyCrossResourceGroupMoveEnabled] [-ResourceMovePolicyCrossSubscriptionMoveEnabled] + [-ResourceMovePolicyValidationRequired] [-RoutingType <RoutingType>] [-ServiceTreeInfo <IServiceTreeInfo[]>] + [-SubscriptionLifecycleNotificationSpecificationSoftDeleteTtl <TimeSpan>] + [-SubscriptionLifecycleNotificationSpecificationSubscriptionStateOverrideAction <ISubscriptionStateOverrideAction[]>] + [-SubscriptionStateRule <ISubscriptionStateRule[]>] [-SwaggerSpecification <ISwaggerSpecification[]>] + [-TemplateDeploymentOptionPreflightOption <PreflightOption[]>] [-TemplateDeploymentOptionPreflightSupported] + [-ThrottlingRule <IThrottlingRule[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a resource type. + +## EXAMPLES + +### Example 1: Create/Update a resource type registration. +```powershell +New-AzProviderHubResourceTypeRegistration -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType" -RoutingType "Default" -Regionality "Regional" -Endpoint @{ApiVersion = "2021-01-01-preview"; Location = "West US 2", "East US 2 EUAP"; RequiredFeature = "Microsoft.Contoso/SampleApp" } -SwaggerSpecification @{ApiVersion = "2021-01-01-preview"; SwaggerSpecFolderUri = "https://github.com/Azure/azure-rest-api-specs-pr/blob/RPSaaSMaster/specification/rpsaas/resource-manager/Microsoft.Contoso/" } -EnableAsyncOperation +``` + +```output +Name Type +---- ---- +testResourceType Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations +``` + +Create/Update a resource type registration. + +### Example 2: Create/Update a nested resource type registration. +```powershell +New-AzProviderHubResourceTypeRegistration -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType/nestedResourceType" -RoutingType "Default" -Regionality "Global" -Endpoint @{ApiVersion = "2021-01-01-preview"; Location = ""; RequiredFeature = "Microsoft.Contoso/SampleApp" } -SwaggerSpecification @{ApiVersion = "2021-01-01-preview"; SwaggerSpecFolderUri = "https://github.com/Azure/azure-rest-api-specs-pr/blob/RPSaaSMaster/specification/rpsaas/resource-manager/Microsoft.Contoso/" } +``` + +```output +Name Type +---- ---- +testResourceType/nestedResourceType Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations +``` + +Create/Update a nested resource type registration. + +## PARAMETERS + +### -AllowedUnauthorizedAction +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizationActionMapping +. +To construct, see NOTES section for AUTHORIZATIONACTIONMAPPING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IAuthorizationActionMapping[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CheckNameAvailabilitySpecificationEnableDefaultValidation +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CheckNameAvailabilitySpecificationResourceTypesWithCustomValidation +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultApiVersion +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisallowedActionVerb +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAsyncOperation +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableThirdPartyS2S +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +. +To construct, see NOTES section for ENDPOINT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IResourceTypeEndpoint[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedLocation +. +To construct, see NOTES section for EXTENDEDLOCATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IExtendedLocationOptions[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureRuleRequiredFeaturesPolicy +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityManagementApplicationId +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityManagementType +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.IdentityManagementTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsPureProxy +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedAccessCheck +. +To construct, see NOTES section for LINKEDACCESSCHECK properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.ILinkedAccessCheck[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoggingRule +. +To construct, see NOTES section for LOGGINGRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.ILoggingRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceType +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisioningState +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.ProvisioningState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Regionality +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.Regionality +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestHeaderOptionOptInHeader +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.OptInHeaderType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredFeature +. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceCreationBeginRequest +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.ExtensionOptionType[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceCreationBeginResponse +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.ExtensionOptionType[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceDeletionPolicy +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.ResourceDeletionPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceMovePolicyCrossResourceGroupMoveEnabled +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceMovePolicyCrossSubscriptionMoveEnabled +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceMovePolicyValidationRequired +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingType +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.RoutingType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceTreeInfo +. +To construct, see NOTES section for SERVICETREEINFO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IServiceTreeInfo[] +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionLifecycleNotificationSpecificationSoftDeleteTtl +. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionLifecycleNotificationSpecificationSubscriptionStateOverrideAction +. +To construct, see NOTES section for SUBSCRIPTIONLIFECYCLENOTIFICATIONSPECIFICATIONSUBSCRIPTIONSTATEOVERRIDEACTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.ISubscriptionStateOverrideAction[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionStateRule +. +To construct, see NOTES section for SUBSCRIPTIONSTATERULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.ISubscriptionStateRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SwaggerSpecification +. +To construct, see NOTES section for SWAGGERSPECIFICATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.ISwaggerSpecification[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateDeploymentOptionPreflightOption +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.PreflightOption[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateDeploymentOptionPreflightSupported +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottlingRule +. +To construct, see NOTES section for THROTTLINGRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IThrottlingRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.IResourceTypeRegistration + +## 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. + + +AUTHORIZATIONACTIONMAPPING <IAuthorizationActionMapping[]>: . + - `[Desired <String>]`: + - `[Original <String>]`: + +ENDPOINT <IResourceTypeEndpoint[]>: . + - `[ApiVersion <String[]>]`: + - `[Enabled <Boolean?>]`: + - `[Extension <IResourceTypeExtension[]>]`: + - `[EndpointUri <String>]`: + - `[ExtensionCategory <ExtensionCategory[]>]`: + - `[Timeout <TimeSpan?>]`: + - `[FeatureRuleRequiredFeaturesPolicy <String>]`: + - `[Location <String[]>]`: + - `[RequiredFeature <String[]>]`: + - `[Timeout <TimeSpan?>]`: + +EXTENDEDLOCATION <IExtendedLocationOptions[]>: . + - `[SupportedPolicy <String>]`: + - `[Type <String>]`: + +LINKEDACCESSCHECK <ILinkedAccessCheck[]>: . + - `[ActionName <String>]`: + - `[LinkedAction <String>]`: + - `[LinkedActionVerb <String>]`: + - `[LinkedProperty <String>]`: + - `[LinkedType <String>]`: + +LOGGINGRULE <ILoggingRule[]>: . + - `Action <String>`: + - `DetailLevel <LoggingDetails>`: + - `Direction <LoggingDirections>`: + - `[HiddenPropertyPathHiddenPathsOnRequest <String[]>]`: + - `[HiddenPropertyPathHiddenPathsOnResponse <String[]>]`: + +SERVICETREEINFO <IServiceTreeInfo[]>: . + - `[ComponentId <String>]`: + - `[ServiceId <String>]`: + +SUBSCRIPTIONLIFECYCLENOTIFICATIONSPECIFICATIONSUBSCRIPTIONSTATEOVERRIDEACTION <ISubscriptionStateOverrideAction[]>: . + - `Action <SubscriptionNotificationOperation>`: + - `State <SubscriptionTransitioningState>`: + +SUBSCRIPTIONSTATERULE <ISubscriptionStateRule[]>: . + - `[AllowedAction <String[]>]`: + - `[State <SubscriptionState?>]`: + +SWAGGERSPECIFICATION <ISwaggerSpecification[]>: . + - `[ApiVersion <String[]>]`: + - `[SwaggerSpecFolderUri <String>]`: + +THROTTLINGRULE <IThrottlingRule[]>: . + - `Action <String>`: + - `Metric <IThrottlingMetric[]>`: + - `Limit <Int64>`: + - `Type <ThrottlingMetricType>`: + - `[Interval <TimeSpan?>]`: + - `[RequiredFeature <String[]>]`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/New-AzProviderHubSku.md b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubSku.md new file mode 100644 index 0000000000..1273bcdd65 --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/New-AzProviderHubSku.md @@ -0,0 +1,241 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/new-azproviderhubsku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/New-AzProviderHubSku.md +--- + +# New-AzProviderHubSku + +## SYNOPSIS +Creates or updates the resource type skus in the given resource type. + +## SYNTAX + +``` +New-AzProviderHubSku -ProviderNamespace <String> -ResourceType <String> -Sku <String> + -SkuSetting <ISkuSetting[]> [-SubscriptionId <String>] [-ProvisioningState <ProvisioningState>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the resource type skus in the given resource type. + +## EXAMPLES + +### Example 1: Create/Update a resource SKU definition. +```powershell +New-AzProviderHubSku -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType" -Sku "default" -SkuSetting @{Name = "freeSku"; Tier = "Tier1"; Kind = "Standard"} +``` + +```output +Name Type +---- ---- +default Microsoft.ProviderHub/providerRegistrations/skus +``` + +Create/Update a resource SKU definition. + +### Example 2: Create/Update a nested resource type SKU definition. +```powershell +New-AzProviderHubSku -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType/nestedResourceType" -Sku "default" -SkuSetting @{Name = "freeSku"; Tier = "Tier1"; Kind = "Standard"} +``` + +```output +Name Type +---- ---- +default Microsoft.ProviderHub/providerRegistrations/skus +``` + +Create/Update a nested resource type SKU definition. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisioningState +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Support.ProvisioningState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSetting +. +To construct, see NOTES section for SKUSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.ISkuSetting[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.Api20201120.ISkuResource + +## 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. + + +SKUSETTING <ISkuSetting[]>: . + - `Name <String>`: + - `[Capability <ISkuCapability[]>]`: + - `Name <String>`: + - `Value <String>`: + - `[CapacityDefault <Int32?>]`: + - `[CapacityMaximum <Int32?>]`: + - `[CapacityMinimum <Int32?>]`: + - `[CapacityScaleType <SkuScaleType?>]`: + - `[Cost <ISkuCost[]>]`: + - `MeterId <String>`: + - `[ExtendedUnit <String>]`: + - `[Quantity <Int32?>]`: + - `[Family <String>]`: + - `[Kind <String>]`: + - `[Location <String[]>]`: + - `[LocationInfo <ISkuLocationInfo[]>]`: + - `Location <String>`: + - `[ExtendedLocation <String[]>]`: + - `[Type <String>]`: + - `[Zone <String[]>]`: + - `[ZoneDetail <ISkuZoneDetail[]>]`: + - `[Capability <ISkuCapability[]>]`: + - `[Name <String[]>]`: + - `[RequiredFeature <String[]>]`: + - `[RequiredQuotaId <String[]>]`: + - `[Size <String>]`: + - `[Tier <String>]`: + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubDefaultRollout.md b/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubDefaultRollout.md new file mode 100644 index 0000000000..8e23c6286c --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubDefaultRollout.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/remove-azproviderhubdefaultrollout +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Remove-AzProviderHubDefaultRollout.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Remove-AzProviderHubDefaultRollout.md +--- + +# Remove-AzProviderHubDefaultRollout + +## SYNOPSIS +Deletes the rollout resource. +Rollout must be in terminal state. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzProviderHubDefaultRollout -ProviderNamespace <String> -RolloutName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzProviderHubDefaultRollout -InputObject <IProviderHubIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the rollout resource. +Rollout must be in terminal state. + +## EXAMPLES + +### Example 1: Delete a default rollout by name. +```powershell +Remove-AzProviderHubDefaultRollout -ProviderNamespace "Microsoft.Contoso" -RolloutName "defaultRollout2021w10" +``` + +Delete a default rollout by name. + +### Example 2: Delete a default rollout by name. +```powershell +Remove-AzProviderHubDefaultRollout -ProviderNamespace "Microsoft.Contoso" -RolloutName "defaultRollout2021w10" +``` + +Delete a default rollout by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RolloutName +The rollout name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IProviderHubIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[NestedResourceTypeFirst <String>]`: The first child resource type. + - `[NestedResourceTypeSecond <String>]`: The second child resource type. + - `[NestedResourceTypeThird <String>]`: The third child resource type. + - `[NotificationRegistrationName <String>]`: The notification registration. + - `[ProviderNamespace <String>]`: The name of the resource provider hosted within ProviderHub. + - `[ResourceType <String>]`: The resource type. + - `[RolloutName <String>]`: The rollout name. + - `[Sku <String>]`: The SKU. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubNotificationRegistration.md b/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubNotificationRegistration.md new file mode 100644 index 0000000000..d69b644cd3 --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubNotificationRegistration.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/remove-azproviderhubnotificationregistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Remove-AzProviderHubNotificationRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Remove-AzProviderHubNotificationRegistration.md +--- + +# Remove-AzProviderHubNotificationRegistration + +## SYNOPSIS +Deletes a notification registration. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzProviderHubNotificationRegistration -Name <String> -ProviderNamespace <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzProviderHubNotificationRegistration -InputObject <IProviderHubIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a notification registration. + +## EXAMPLES + +### Example 1: Delete a notification registration by name. +```powershell +Remove-AzProviderHubNotificationRegistration -ProviderNamespace "Microsoft.Contoso" -Name "notificationRegistrationTest" +``` + +Delete a notification registration by name. + +### Example 2: Delete a notification registration by name. +```powershell +Remove-AzProviderHubNotificationRegistration -ProviderNamespace "Microsoft.Contoso" -Name "notificationRegistrationTest" +``` + +Delete a notification registration by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The notification registration. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: NotificationRegistrationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IProviderHubIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[NestedResourceTypeFirst <String>]`: The first child resource type. + - `[NestedResourceTypeSecond <String>]`: The second child resource type. + - `[NestedResourceTypeThird <String>]`: The third child resource type. + - `[NotificationRegistrationName <String>]`: The notification registration. + - `[ProviderNamespace <String>]`: The name of the resource provider hosted within ProviderHub. + - `[ResourceType <String>]`: The resource type. + - `[RolloutName <String>]`: The rollout name. + - `[Sku <String>]`: The SKU. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubProviderRegistration.md b/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubProviderRegistration.md new file mode 100644 index 0000000000..d86b65f497 --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubProviderRegistration.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/remove-azproviderhubproviderregistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Remove-AzProviderHubProviderRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Remove-AzProviderHubProviderRegistration.md +--- + +# Remove-AzProviderHubProviderRegistration + +## SYNOPSIS +Deletes a provider registration. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzProviderHubProviderRegistration -ProviderNamespace <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzProviderHubProviderRegistration -InputObject <IProviderHubIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a provider registration. + +## EXAMPLES + +### Example 1: Delete a provider registration by resource provider name. +```powershell +Remove-AzProviderHubProviderRegistration -ProviderNamespace "Microsoft.Contoso" +``` + +Delete a provider registration by resource provider name. + +### Example 2: Delete a provider registration by resource provider name. +```powershell +Remove-AzProviderHubProviderRegistration -ProviderNamespace "Microsoft.Contoso" +``` + +Delete a provider registration by resource provider name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IProviderHubIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[NestedResourceTypeFirst <String>]`: The first child resource type. + - `[NestedResourceTypeSecond <String>]`: The second child resource type. + - `[NestedResourceTypeThird <String>]`: The third child resource type. + - `[NotificationRegistrationName <String>]`: The notification registration. + - `[ProviderNamespace <String>]`: The name of the resource provider hosted within ProviderHub. + - `[ResourceType <String>]`: The resource type. + - `[RolloutName <String>]`: The rollout name. + - `[Sku <String>]`: The SKU. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubResourceTypeRegistration.md b/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubResourceTypeRegistration.md new file mode 100644 index 0000000000..95dbcec229 --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubResourceTypeRegistration.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/remove-azproviderhubresourcetyperegistration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Remove-AzProviderHubResourceTypeRegistration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Remove-AzProviderHubResourceTypeRegistration.md +--- + +# Remove-AzProviderHubResourceTypeRegistration + +## SYNOPSIS +Deletes a resource type + +## SYNTAX + +### Delete (Default) +``` +Remove-AzProviderHubResourceTypeRegistration -ProviderNamespace <String> -ResourceType <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzProviderHubResourceTypeRegistration -InputObject <IProviderHubIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a resource type + +## EXAMPLES + +### Example 1: Delete a resource type registration by name. +```powershell +Remove-AzProviderHubResourceTypeRegistration -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType" +``` + +Delete a resource type registration by name. + +### Example 2: Delete a nested resource type registration by name. +```powershell +Remove-AzProviderHubResourceTypeRegistration -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType/nestedResourceType" +``` + +Delete a nested resource type registration by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IProviderHubIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[NestedResourceTypeFirst <String>]`: The first child resource type. + - `[NestedResourceTypeSecond <String>]`: The second child resource type. + - `[NestedResourceTypeThird <String>]`: The third child resource type. + - `[NotificationRegistrationName <String>]`: The notification registration. + - `[ProviderNamespace <String>]`: The name of the resource provider hosted within ProviderHub. + - `[ResourceType <String>]`: The resource type. + - `[RolloutName <String>]`: The rollout name. + - `[Sku <String>]`: The SKU. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubSku.md b/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubSku.md new file mode 100644 index 0000000000..8f1c477f3d --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Remove-AzProviderHubSku.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/remove-azproviderhubsku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Remove-AzProviderHubSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Remove-AzProviderHubSku.md +--- + +# Remove-AzProviderHubSku + +## SYNOPSIS +Deletes a resource type sku. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzProviderHubSku -ProviderNamespace <String> -ResourceType <String> -Sku <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzProviderHubSku -InputObject <IProviderHubIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a resource type sku. + +## EXAMPLES + +### Example 1: Delete a resource SKU definition. +```powershell +Remove-AzProviderHubSku -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType" -Sku "default" +``` + +Delete a resource type SKU definition. + +### Example 2: Delete a nested resource SKU definition. +```powershell +Remove-AzProviderHubSku -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType/nestedResourceType" -Sku "default" +``` + +Delete a nested resource type SKU definition. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SKU. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IProviderHubIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[NestedResourceTypeFirst <String>]`: The first child resource type. + - `[NestedResourceTypeSecond <String>]`: The second child resource type. + - `[NestedResourceTypeThird <String>]`: The third child resource type. + - `[NotificationRegistrationName <String>]`: The notification registration. + - `[ProviderNamespace <String>]`: The name of the resource provider hosted within ProviderHub. + - `[ResourceType <String>]`: The resource type. + - `[RolloutName <String>]`: The rollout name. + - `[Sku <String>]`: The SKU. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ProviderHub/Stop-AzProviderHubDefaultRollout.md b/azps-10.1.0/Az.ProviderHub/Stop-AzProviderHubDefaultRollout.md new file mode 100644 index 0000000000..d33c9d14f3 --- /dev/null +++ b/azps-10.1.0/Az.ProviderHub/Stop-AzProviderHubDefaultRollout.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.ProviderHub +online version: https://learn.microsoft.com/powershell/module/az.providerhub/stop-azproviderhubdefaultrollout +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Stop-AzProviderHubDefaultRollout.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ProviderHub/help/Stop-AzProviderHubDefaultRollout.md +--- + +# Stop-AzProviderHubDefaultRollout + +## SYNOPSIS +Stops or cancels the rollout, if in progress. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzProviderHubDefaultRollout -ProviderNamespace <String> -RolloutName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzProviderHubDefaultRollout -InputObject <IProviderHubIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Stops or cancels the rollout, if in progress. + +## EXAMPLES + +### Example 1: Cancel a default rollout by rollout name. +```powershell +Stop-AzProviderHubDefaultRollout -ProviderNamespace "Microsoft.Contoso" -RolloutName "defaultRollout2021w10" +``` + +Cancel a default rollout by rollout name. + +### Example 2: Cancel a default rollout by rollout name. +```powershell +Stop-AzProviderHubDefaultRollout -ProviderNamespace "Microsoft.Contoso" -RolloutName "defaultRollout2021w10" +``` + +Cancel a default rollout by rollout name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The name of the resource provider hosted within ProviderHub. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RolloutName +The rollout name. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ProviderHub.Models.IProviderHubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IProviderHubIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[NestedResourceTypeFirst <String>]`: The first child resource type. + - `[NestedResourceTypeSecond <String>]`: The second child resource type. + - `[NestedResourceTypeThird <String>]`: The third child resource type. + - `[NotificationRegistrationName <String>]`: The notification registration. + - `[ProviderNamespace <String>]`: The name of the resource provider hosted within ProviderHub. + - `[ResourceType <String>]`: The resource type. + - `[RolloutName <String>]`: The rollout name. + - `[Sku <String>]`: The SKU. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Purview/Add-AzPurviewAccountRootCollectionAdmin.md b/azps-10.1.0/Az.Purview/Add-AzPurviewAccountRootCollectionAdmin.md new file mode 100644 index 0000000000..98bb053d7a --- /dev/null +++ b/azps-10.1.0/Az.Purview/Add-AzPurviewAccountRootCollectionAdmin.md @@ -0,0 +1,217 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/add-azpurviewaccountrootcollectionadmin +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Add-AzPurviewAccountRootCollectionAdmin.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Add-AzPurviewAccountRootCollectionAdmin.md +--- + +# Add-AzPurviewAccountRootCollectionAdmin + +## SYNOPSIS +Add the administrator for root collection associated with this account. + +## SYNTAX + +### AddExpanded (Default) +``` +Add-AzPurviewAccountRootCollectionAdmin -AccountName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -ObjectId <String> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AddViaIdentityExpanded +``` +Add-AzPurviewAccountRootCollectionAdmin -InputObject <IPurviewIdentity> -ObjectId <String> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Add the administrator for root collection associated with this account. + +## EXAMPLES + +### Example 1: Add the administrator for root collection +```powershell +Add-AzPurviewAccountRootCollectionAdmin -AccountName test-pa -ResourceGroupName test-rg -ObjectId xxxxxxxx-5be9-4f43-abd2-04561777c8b0 +``` + +Add the administrator for root collection associated with the account named 'test-pa'. + +### Example 2: Add the administrator for root collection by InputObject +```powershell +$got = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg +Add-AzPurviewAccountRootCollectionAdmin -InputObject $got -ObjectId xxxxxxxx-5be9-4f43-abd2-04561777c8b0 +``` + +Add the administrator for root collection associated with the account named 'test-pa' by InputObject. + +## PARAMETERS + +### -AccountName +The name of the account. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.IPurviewIdentity +Parameter Sets: AddViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ObjectId +Gets or sets the object identifier of the admin. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.IPurviewIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPurviewIdentity>`: Identity Parameter + - `[AccountName <String>]`: The name of the account. + - `[GroupId <String>]`: The group identifier. + - `[Id <String>]`: Resource identity path + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The resource group name. + - `[SubscriptionId <String>]`: The subscription identifier + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Az.Purview.md b/azps-10.1.0/Az.Purview/Az.Purview.md new file mode 100644 index 0000000000..a58432086d --- /dev/null +++ b/azps-10.1.0/Az.Purview/Az.Purview.md @@ -0,0 +1,360 @@ +--- +Module Name: Az.Purview +Module Guid: accceef6-8113-453a-a31c-4f2ce57893d6 +Download Help Link: https://learn.microsoft.com/powershell/module/az.purview +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Az.Purview.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Az.Purview.md +--- + +# Az.Purview Module +## Description +Microsoft Azure PowerShell: Purview cmdlets + +## Az.Purview Cmdlets +### [Add-AzPurviewAccountRootCollectionAdmin](Add-AzPurviewAccountRootCollectionAdmin.md) +Add the administrator for root collection associated with this account. + +### [Get-AzPurviewAccount](Get-AzPurviewAccount.md) +Get an account + +### [Get-AzPurviewAccountKey](Get-AzPurviewAccountKey.md) +List the authorization keys associated with this account. + +### [Get-AzPurviewClassificationRule](Get-AzPurviewClassificationRule.md) +Get a classification rule + +### [Get-AzPurviewClassificationRuleVersion](Get-AzPurviewClassificationRuleVersion.md) +Lists the rule versions of a classification rule + +### [Get-AzPurviewDataSource](Get-AzPurviewDataSource.md) +Get a data source + +### [Get-AzPurviewDefaultAccount](Get-AzPurviewDefaultAccount.md) +Get the default account for the scope. + +### [Get-AzPurviewFilter](Get-AzPurviewFilter.md) +Get a filter + +### [Get-AzPurviewKeyVaultConnection](Get-AzPurviewKeyVaultConnection.md) +Gets key vault information + +### [Get-AzPurviewScan](Get-AzPurviewScan.md) +Gets a scan information + +### [Get-AzPurviewScanResultScanHistory](Get-AzPurviewScanResultScanHistory.md) +Lists the scan history of a scan + +### [Get-AzPurviewScanRuleset](Get-AzPurviewScanRuleset.md) +Get a scan ruleset + +### [Get-AzPurviewSystemScanRuleset](Get-AzPurviewSystemScanRuleset.md) +Get a system scan ruleset for a data source + +### [Get-AzPurviewSystemScanRulesetLatest](Get-AzPurviewSystemScanRulesetLatest.md) +Get the latest version of a system scan ruleset + +### [Get-AzPurviewSystemScanRulesetVersion](Get-AzPurviewSystemScanRulesetVersion.md) +List system scan ruleset versions in Data catalog + +### [Get-AzPurviewTrigger](Get-AzPurviewTrigger.md) +Gets trigger information + +### [Invoke-AzPurviewTagClassificationRuleClassificationVersion](Invoke-AzPurviewTagClassificationRuleClassificationVersion.md) +Sets Classification Action on a specific classification rule version. + +### [New-AzPurviewAccount](New-AzPurviewAccount.md) +Creates or updates an account + +### [New-AzPurviewAdlsGen1CredentialScanObject](New-AzPurviewAdlsGen1CredentialScanObject.md) +Create an in-memory object for AdlsGen1CredentialScan. + +### [New-AzPurviewAdlsGen1DataSourceObject](New-AzPurviewAdlsGen1DataSourceObject.md) +Create an in-memory object for AdlsGen1DataSource. + +### [New-AzPurviewAdlsGen1MsiScanObject](New-AzPurviewAdlsGen1MsiScanObject.md) +Create an in-memory object for AdlsGen1MsiScan. + +### [New-AzPurviewAdlsGen1ScanRulesetObject](New-AzPurviewAdlsGen1ScanRulesetObject.md) +Create an in-memory object for AdlsGen1ScanRuleset. + +### [New-AzPurviewAdlsGen2CredentialScanObject](New-AzPurviewAdlsGen2CredentialScanObject.md) +Create an in-memory object for AdlsGen2CredentialScan. + +### [New-AzPurviewAdlsGen2DataSourceObject](New-AzPurviewAdlsGen2DataSourceObject.md) +Create an in-memory object for AdlsGen2DataSource. + +### [New-AzPurviewAdlsGen2MsiScanObject](New-AzPurviewAdlsGen2MsiScanObject.md) +Create an in-memory object for AdlsGen2MsiScan. + +### [New-AzPurviewAdlsGen2ScanRulesetObject](New-AzPurviewAdlsGen2ScanRulesetObject.md) +Create an in-memory object for AdlsGen2ScanRuleset. + +### [New-AzPurviewAmazonAccountCredentialScanObject](New-AzPurviewAmazonAccountCredentialScanObject.md) +Create an in-memory object for AmazonAccountCredentialScan. + +### [New-AzPurviewAmazonAccountDataSourceObject](New-AzPurviewAmazonAccountDataSourceObject.md) +Create an in-memory object for AmazonAccountDataSource. + +### [New-AzPurviewAmazonPostgreSqlCredentialScanObject](New-AzPurviewAmazonPostgreSqlCredentialScanObject.md) +Create an in-memory object for AmazonPostgreSqlCredentialScan. + +### [New-AzPurviewAmazonPostgreSqlDataSourceObject](New-AzPurviewAmazonPostgreSqlDataSourceObject.md) +Create an in-memory object for AmazonPostgreSqlDataSource. + +### [New-AzPurviewAmazonPostgreSqlScanRulesetObject](New-AzPurviewAmazonPostgreSqlScanRulesetObject.md) +Create an in-memory object for AmazonPostgreSqlScanRuleset. + +### [New-AzPurviewAmazonS3CredentialScanObject](New-AzPurviewAmazonS3CredentialScanObject.md) +Create an in-memory object for AmazonS3CredentialScan. + +### [New-AzPurviewAmazonS3DataSourceObject](New-AzPurviewAmazonS3DataSourceObject.md) +Create an in-memory object for AmazonS3DataSource. + +### [New-AzPurviewAmazonS3ScanRulesetObject](New-AzPurviewAmazonS3ScanRulesetObject.md) +Create an in-memory object for AmazonS3ScanRuleset. + +### [New-AzPurviewAmazonSqlCredentialScanObject](New-AzPurviewAmazonSqlCredentialScanObject.md) +Create an in-memory object for AmazonSqlCredentialScan. + +### [New-AzPurviewAmazonSqlDataSourceObject](New-AzPurviewAmazonSqlDataSourceObject.md) +Create an in-memory object for AmazonSqlDataSource. + +### [New-AzPurviewAmazonSqlScanRulesetObject](New-AzPurviewAmazonSqlScanRulesetObject.md) +Create an in-memory object for AmazonSqlScanRuleset. + +### [New-AzPurviewAzureCosmosDbCredentialScanObject](New-AzPurviewAzureCosmosDbCredentialScanObject.md) +Create an in-memory object for AzureCosmosDbCredentialScan. + +### [New-AzPurviewAzureCosmosDbDataSourceObject](New-AzPurviewAzureCosmosDbDataSourceObject.md) +Create an in-memory object for AzureCosmosDbDataSource. + +### [New-AzPurviewAzureCosmosDbScanRulesetObject](New-AzPurviewAzureCosmosDbScanRulesetObject.md) +Create an in-memory object for AzureCosmosDbScanRuleset. + +### [New-AzPurviewAzureDataExplorerCredentialScanObject](New-AzPurviewAzureDataExplorerCredentialScanObject.md) +Create an in-memory object for AzureDataExplorerCredentialScan. + +### [New-AzPurviewAzureDataExplorerDataSourceObject](New-AzPurviewAzureDataExplorerDataSourceObject.md) +Create an in-memory object for AzureDataExplorerDataSource. + +### [New-AzPurviewAzureDataExplorerMsiScanObject](New-AzPurviewAzureDataExplorerMsiScanObject.md) +Create an in-memory object for AzureDataExplorerMsiScan. + +### [New-AzPurviewAzureDataExplorerScanRulesetObject](New-AzPurviewAzureDataExplorerScanRulesetObject.md) +Create an in-memory object for AzureDataExplorerScanRuleset. + +### [New-AzPurviewAzureFileServiceCredentialScanObject](New-AzPurviewAzureFileServiceCredentialScanObject.md) +Create an in-memory object for AzureFileServiceCredentialScan. + +### [New-AzPurviewAzureFileServiceDataSourceObject](New-AzPurviewAzureFileServiceDataSourceObject.md) +Create an in-memory object for AzureFileServiceDataSource. + +### [New-AzPurviewAzureFileServiceScanRulesetObject](New-AzPurviewAzureFileServiceScanRulesetObject.md) +Create an in-memory object for AzureFileServiceScanRuleset. + +### [New-AzPurviewAzureKeyVaultObject](New-AzPurviewAzureKeyVaultObject.md) +Create an in-memory object for AzureKeyVault. + +### [New-AzPurviewAzureMySqlCredentialScanObject](New-AzPurviewAzureMySqlCredentialScanObject.md) +Create an in-memory object for AzureMySqlCredentialScan. + +### [New-AzPurviewAzureMySqlDataSourceObject](New-AzPurviewAzureMySqlDataSourceObject.md) +Create an in-memory object for AzureMySqlDataSource. + +### [New-AzPurviewAzureMySqlScanRulesetObject](New-AzPurviewAzureMySqlScanRulesetObject.md) +Create an in-memory object for AzureMySqlScanRuleset. + +### [New-AzPurviewAzurePostgreSqlCredentialScanObject](New-AzPurviewAzurePostgreSqlCredentialScanObject.md) +Create an in-memory object for AzurePostgreSqlCredentialScan. + +### [New-AzPurviewAzurePostgreSqlDataSourceObject](New-AzPurviewAzurePostgreSqlDataSourceObject.md) +Create an in-memory object for AzurePostgreSqlDataSource. + +### [New-AzPurviewAzurePostgreSqlScanRulesetObject](New-AzPurviewAzurePostgreSqlScanRulesetObject.md) +Create an in-memory object for AzurePostgreSqlScanRuleset. + +### [New-AzPurviewAzureResourceGroupCredentialScanObject](New-AzPurviewAzureResourceGroupCredentialScanObject.md) +Create an in-memory object for AzureResourceGroupCredentialScan. + +### [New-AzPurviewAzureResourceGroupDataSourceObject](New-AzPurviewAzureResourceGroupDataSourceObject.md) +Create an in-memory object for AzureResourceGroupDataSource. + +### [New-AzPurviewAzureResourceGroupMsiScanObject](New-AzPurviewAzureResourceGroupMsiScanObject.md) +Create an in-memory object for AzureResourceGroupMsiScan. + +### [New-AzPurviewAzureSqlDatabaseCredentialScanObject](New-AzPurviewAzureSqlDatabaseCredentialScanObject.md) +Create an in-memory object for AzureSqlDatabaseCredentialScan. + +### [New-AzPurviewAzureSqlDatabaseDataSourceObject](New-AzPurviewAzureSqlDatabaseDataSourceObject.md) +Create an in-memory object for AzureSqlDatabaseDataSource. + +### [New-AzPurviewAzureSqlDatabaseManagedInstanceCredentialScanObject](New-AzPurviewAzureSqlDatabaseManagedInstanceCredentialScanObject.md) +Create an in-memory object for AzureSqlDatabaseManagedInstanceCredentialScan. + +### [New-AzPurviewAzureSqlDatabaseManagedInstanceDataSourceObject](New-AzPurviewAzureSqlDatabaseManagedInstanceDataSourceObject.md) +Create an in-memory object for AzureSqlDatabaseManagedInstanceDataSource. + +### [New-AzPurviewAzureSqlDatabaseManagedInstanceMsiScanObject](New-AzPurviewAzureSqlDatabaseManagedInstanceMsiScanObject.md) +Create an in-memory object for AzureSqlDatabaseManagedInstanceMsiScan. + +### [New-AzPurviewAzureSqlDatabaseManagedInstanceScanRulesetObject](New-AzPurviewAzureSqlDatabaseManagedInstanceScanRulesetObject.md) +Create an in-memory object for AzureSqlDatabaseManagedInstanceScanRuleset. + +### [New-AzPurviewAzureSqlDatabaseMsiScanObject](New-AzPurviewAzureSqlDatabaseMsiScanObject.md) +Create an in-memory object for AzureSqlDatabaseMsiScan. + +### [New-AzPurviewAzureSqlDatabaseScanRulesetObject](New-AzPurviewAzureSqlDatabaseScanRulesetObject.md) +Create an in-memory object for AzureSqlDatabaseScanRuleset. + +### [New-AzPurviewAzureSqlDataWarehouseCredentialScanObject](New-AzPurviewAzureSqlDataWarehouseCredentialScanObject.md) +Create an in-memory object for AzureSqlDataWarehouseCredentialScan. + +### [New-AzPurviewAzureSqlDataWarehouseDataSourceObject](New-AzPurviewAzureSqlDataWarehouseDataSourceObject.md) +Create an in-memory object for AzureSqlDataWarehouseDataSource. + +### [New-AzPurviewAzureSqlDataWarehouseMsiScanObject](New-AzPurviewAzureSqlDataWarehouseMsiScanObject.md) +Create an in-memory object for AzureSqlDataWarehouseMsiScan. + +### [New-AzPurviewAzureSqlDataWarehouseScanRulesetObject](New-AzPurviewAzureSqlDataWarehouseScanRulesetObject.md) +Create an in-memory object for AzureSqlDataWarehouseScanRuleset. + +### [New-AzPurviewAzureStorageCredentialScanObject](New-AzPurviewAzureStorageCredentialScanObject.md) +Create an in-memory object for AzureStorageCredentialScan. + +### [New-AzPurviewAzureStorageDataSourceObject](New-AzPurviewAzureStorageDataSourceObject.md) +Create an in-memory object for AzureStorageDataSource. + +### [New-AzPurviewAzureStorageMsiScanObject](New-AzPurviewAzureStorageMsiScanObject.md) +Create an in-memory object for AzureStorageMsiScan. + +### [New-AzPurviewAzureStorageScanRulesetObject](New-AzPurviewAzureStorageScanRulesetObject.md) +Create an in-memory object for AzureStorageScanRuleset. + +### [New-AzPurviewAzureSubscriptionCredentialScanObject](New-AzPurviewAzureSubscriptionCredentialScanObject.md) +Create an in-memory object for AzureSubscriptionCredentialScan. + +### [New-AzPurviewAzureSubscriptionDataSourceObject](New-AzPurviewAzureSubscriptionDataSourceObject.md) +Create an in-memory object for AzureSubscriptionDataSource. + +### [New-AzPurviewAzureSubscriptionMsiScanObject](New-AzPurviewAzureSubscriptionMsiScanObject.md) +Create an in-memory object for AzureSubscriptionMsiScan. + +### [New-AzPurviewAzureSynapseWorkspaceCredentialScanObject](New-AzPurviewAzureSynapseWorkspaceCredentialScanObject.md) +Create an in-memory object for AzureSynapseWorkspaceCredentialScan. + +### [New-AzPurviewAzureSynapseWorkspaceDataSourceObject](New-AzPurviewAzureSynapseWorkspaceDataSourceObject.md) +Create an in-memory object for AzureSynapseWorkspaceDataSource. + +### [New-AzPurviewAzureSynapseWorkspaceMsiScanObject](New-AzPurviewAzureSynapseWorkspaceMsiScanObject.md) +Create an in-memory object for AzureSynapseWorkspaceMsiScan. + +### [New-AzPurviewAzureSynapseWorkspaceScanRulesetObject](New-AzPurviewAzureSynapseWorkspaceScanRulesetObject.md) +Create an in-memory object for AzureSynapseWorkspaceScanRuleset. + +### [New-AzPurviewClassificationRule](New-AzPurviewClassificationRule.md) +Creates or Updates a classification rule + +### [New-AzPurviewCustomClassificationRuleObject](New-AzPurviewCustomClassificationRuleObject.md) +Create an in-memory object for CustomClassificationRule. + +### [New-AzPurviewDataSource](New-AzPurviewDataSource.md) +Creates or Updates a data source + +### [New-AzPurviewFilter](New-AzPurviewFilter.md) +Creates or updates a filter + +### [New-AzPurviewFilterObject](New-AzPurviewFilterObject.md) +Create an in-memory object for Filter. + +### [New-AzPurviewKeyVaultConnection](New-AzPurviewKeyVaultConnection.md) +Creates an instance of a key vault connection + +### [New-AzPurviewOracleDataSourceObject](New-AzPurviewOracleDataSourceObject.md) +Create an in-memory object for OracleDataSource. + +### [New-AzPurviewPowerBIDataSourceObject](New-AzPurviewPowerBIDataSourceObject.md) +Create an in-memory object for PowerBIDataSource. + +### [New-AzPurviewPowerBIDelegatedScanObject](New-AzPurviewPowerBIDelegatedScanObject.md) +Create an in-memory object for PowerBIDelegatedScan. + +### [New-AzPurviewPowerBIMsiScanObject](New-AzPurviewPowerBIMsiScanObject.md) +Create an in-memory object for PowerBIMsiScan. + +### [New-AzPurviewRegexClassificationRulePatternObject](New-AzPurviewRegexClassificationRulePatternObject.md) +Create an in-memory object for RegexClassificationRulePattern. + +### [New-AzPurviewSapEccDataSourceObject](New-AzPurviewSapEccDataSourceObject.md) +Create an in-memory object for SapEccDataSource. + +### [New-AzPurviewSapS4HanaDataSourceObject](New-AzPurviewSapS4HanaDataSourceObject.md) +Create an in-memory object for SapS4HanaDataSource. + +### [New-AzPurviewSapS4HanaSapS4HanaCredentialScanObject](New-AzPurviewSapS4HanaSapS4HanaCredentialScanObject.md) +Create an in-memory object for SapS4HanaSapS4HanaCredentialScan. + +### [New-AzPurviewScan](New-AzPurviewScan.md) +Creates an instance of a scan + +### [New-AzPurviewScanRuleset](New-AzPurviewScanRuleset.md) +Creates or Updates a scan ruleset + +### [New-AzPurviewSqlServerDatabaseCredentialScanObject](New-AzPurviewSqlServerDatabaseCredentialScanObject.md) +Create an in-memory object for SqlServerDatabaseCredentialScan. + +### [New-AzPurviewSqlServerDatabaseDataSourceObject](New-AzPurviewSqlServerDatabaseDataSourceObject.md) +Create an in-memory object for SqlServerDatabaseDataSource. + +### [New-AzPurviewSqlServerDatabaseScanRulesetObject](New-AzPurviewSqlServerDatabaseScanRulesetObject.md) +Create an in-memory object for SqlServerDatabaseScanRuleset. + +### [New-AzPurviewTeradataDataSourceObject](New-AzPurviewTeradataDataSourceObject.md) +Create an in-memory object for TeradataDataSource. + +### [New-AzPurviewTrigger](New-AzPurviewTrigger.md) +Creates an instance of a trigger + +### [New-AzPurviewTriggerObject](New-AzPurviewTriggerObject.md) +Create an in-memory object for Trigger. + +### [Remove-AzPurviewAccount](Remove-AzPurviewAccount.md) +Deletes an account resource + +### [Remove-AzPurviewClassificationRule](Remove-AzPurviewClassificationRule.md) +Deletes a classification rule + +### [Remove-AzPurviewDataSource](Remove-AzPurviewDataSource.md) +Deletes a data source + +### [Remove-AzPurviewDefaultAccount](Remove-AzPurviewDefaultAccount.md) +Removes the default account from the scope. + +### [Remove-AzPurviewKeyVaultConnection](Remove-AzPurviewKeyVaultConnection.md) +Deletes the key vault connection associated with the account + +### [Remove-AzPurviewScan](Remove-AzPurviewScan.md) +Deletes the scan associated with the data source + +### [Remove-AzPurviewScanRuleset](Remove-AzPurviewScanRuleset.md) +Deletes a scan ruleset + +### [Remove-AzPurviewTrigger](Remove-AzPurviewTrigger.md) +Deletes the trigger associated with the scan + +### [Set-AzPurviewDefaultAccount](Set-AzPurviewDefaultAccount.md) +Sets the default account for the scope. + +### [Start-AzPurviewScanResultScan](Start-AzPurviewScanResultScan.md) +Runs the scan + +### [Stop-AzPurviewScanResultScan](Stop-AzPurviewScanResultScan.md) +Cancels a scan + +### [Test-AzPurviewAccountNameAvailability](Test-AzPurviewAccountNameAvailability.md) +Checks if account name is available. + +### [Update-AzPurviewAccount](Update-AzPurviewAccount.md) +Updates an account + diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewAccount.md b/azps-10.1.0/Az.Purview/Get-AzPurviewAccount.md new file mode 100644 index 0000000000..7e8d89c4c1 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewAccount.md @@ -0,0 +1,221 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewAccount.md +--- + +# Get-AzPurviewAccount + +## SYNOPSIS +Get an account + +## SYNTAX + +### List1 (Default) +``` +Get-AzPurviewAccount [-SubscriptionId <String[]>] [-SkipToken <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzPurviewAccount -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzPurviewAccount -ResourceGroupName <String> [-SubscriptionId <String[]>] [-SkipToken <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzPurviewAccount -InputObject <IPurviewIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get an account + +## EXAMPLES + +### Example 1: List All Purview Accounts +```powershell +Get-AzPurviewAccount +``` + +```output +IdentityPrincipalId IdentityTenantId IdentityType Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType +------------------- ---------------- ------------ -------- ---- ------------------- ------------------- -------- +xxxxxxxx-a087-43aa-8a7f-c17a4bbd4d36 xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a SystemAssigned eastus pvac 8/4/2021 8:34:28 AM xxx@microsoft.com User +xxxxxxxx-bbe7-4506-a9c4-4d602d8e4e1c xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a SystemAssigned eastus purview-test 8/9/2021 9:38:47 AM xxxxxxxxx@microsoft.com User +xxxxxxxx-7956-4978-87e8-9ddd82cfe2b7 xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a SystemAssigned eastus test-pa 8/17/2021 6:18:57 AM xxxxxxxxxx@microsoft.com User +``` + +List all purview accounts. + +### Example 2: Get Purview Account by Resource Group Name and Name +```powershell +Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg +``` + +```output +IdentityPrincipalId IdentityTenantId IdentityType Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt +------------------- ---------------- ------------ -------- ---- ------------------- ------------------- ----------------------- ----------------- +xxxxxxxx-7956-4978-87e8-9ddd82cfe2b7 xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a SystemAssigned eastus test-pa 8/17/2021 6:18:57 AM xxxxxxxxxx@microsoft.com User 8/17/2021 6:18:5… +``` + +Get the purview account name test-rg in resource group test-pa + +### Example 3: List Purview Accounts in a Specified Resource Group +```powershell +Get-AzPurviewAccount -ResourceGroupName test-rg +``` + +```output +IdentityPrincipalId IdentityTenantId IdentityType Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt +------------------- ---------------- ------------ -------- ---- ------------------- ------------------- ----------------------- ----------------- +xxxxxxxx-7956-4978-87e8-9ddd82cfe2b7 xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a SystemAssigned eastus test-pa 8/17/2021 6:18:57 AM xxxxxxxxxx@microsoft.com User 8/17/2021 6:18:5… +``` + +List the purview accounts in resource group test-pa + +### Example 4: Get Purview Account by InputObject +```powershell +$got = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg +Get-AzADDomainService -InputObject $got +``` + +```output +IdentityPrincipalId IdentityTenantId IdentityType Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt +------------------- ---------------- ------------ -------- ---- ------------------- ------------------- ----------------------- ----------------- +xxxxxxxx-7956-4978-87e8-9ddd82cfe2b7 xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a SystemAssigned eastus test-pa 8/17/2021 6:18:57 AM xxxxxxxxxx@microsoft.com User 8/17/2021 6:18:5… +``` + +Get the purview account by InputObject + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.IPurviewIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +The skip token. + +```yaml +Type: System.String +Parameter Sets: List1, List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier + +```yaml +Type: System.String[] +Parameter Sets: List1, Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.IPurviewIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.Api20210701.IAccount + +## 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 `<IPurviewIdentity>`: Identity Parameter + - `[AccountName <String>]`: The name of the account. + - `[GroupId <String>]`: The group identifier. + - `[Id <String>]`: Resource identity path + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The resource group name. + - `[SubscriptionId <String>]`: The subscription identifier + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewAccountKey.md b/azps-10.1.0/Az.Purview/Get-AzPurviewAccountKey.md new file mode 100644 index 0000000000..65bf9154cc --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewAccountKey.md @@ -0,0 +1,146 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewAccountKey.md +--- + +# Get-AzPurviewAccountKey + +## SYNOPSIS +List the authorization keys associated with this account. + +## SYNTAX + +``` +Get-AzPurviewAccountKey -AccountName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +List the authorization keys associated with this account. + +## EXAMPLES + +### Example 1: List the authorization keys associated with a specified account. +```powershell +Get-AzPurviewAccountKey -AccountName test-pa -ResourceGroupName test-rg +``` + +```output +AtlasKafkaPrimaryEndpoint +------------------------- +Endpoint=sb://atlas-xxxxxxxx-5348-4811-a336-759242a25d37.servicebus.windows.net/;SharedAccessKeyName=AlternateSharedAccessKey;SharedAcces… +``` + +List the authorization keys associated with account 'test-pa'. + +## PARAMETERS + +### -AccountName +The name of the account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.Api20210701.IAccessKeys + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewClassificationRule.md b/azps-10.1.0/Az.Purview/Get-AzPurviewClassificationRule.md new file mode 100644 index 0000000000..9e8400e56e --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewClassificationRule.md @@ -0,0 +1,172 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewclassificationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewClassificationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewClassificationRule.md +--- + +# Get-AzPurviewClassificationRule + +## SYNOPSIS +Get a classification rule + +## SYNTAX + +### List (Default) +``` +Get-AzPurviewClassificationRule -Endpoint <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPurviewClassificationRule -Endpoint <String> -Name <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a classification rule + +## EXAMPLES + +### Example 1: Get custom classification rule by name +```powershell +Get-AzPurviewClassificationRule -Endpoint https://parv-brs-2.purview.azure.com/ -Name ClassificationRule1 +``` + +```output +ClassificationAction : Keep +ClassificationName : ClassificationName1 +ColumnPattern : {{ + "kind": "Regex", + "pattern": "column1" + }} +CreatedAt : 1/27/2022 4:36:25 AM +DataPattern : {{ + "kind": "Regex", + "pattern": "^\\d{5}$" + }} +Description : This is a description +Id : classificationrules/ClassificationRule1 +Kind : Custom +LastModifiedAt : 1/27/2022 4:36:25 AM +MinimumPercentageMatch : 60 +Name : ClassificationRule1 +RuleStatus : Enabled +Version : 1 +``` + +Get classification rule named Classification1 + +### Example 2: Get all custom classification rules +```powershell +Get-AzPurviewClassificationRule -Endpoint https://parv-brs-2.purview.azure.com/ +``` + +```output +ClassificationAction : Keep +ClassificationName : ClassificationName1 +ColumnPattern : {{ + "kind": "Regex", + "pattern": "column1" + }} +CreatedAt : 1/27/2022 4:36:25 AM +DataPattern : {{ + "kind": "Regex", + "pattern": "^\\d{5}$" + }} +Description : This is a description +Id : classificationrules/ClassificationRule1 +Kind : Custom +LastModifiedAt : 1/27/2022 4:36:25 AM +MinimumPercentageMatch : 60 +Name : ClassificationRule1 +RuleStatus : Enabled +Version : 1 + +ClassificationAction : Keep +ClassificationName : ClassificationName2 +ColumnPattern : {{ + "kind": "Regex", + "pattern": "column2" + }} +CreatedAt : 1/27/2022 4:37:09 AM +DataPattern : {{ + "kind": "Regex", + "pattern": "^\\d{6}$" + }} +Description : This is description +Id : classificationrules/ClassificationRule2 +Kind : Custom +LastModifiedAt : 1/27/2022 4:37:09 AM +MinimumPercentageMatch : 60 +Name : ClassificationRule2 +RuleStatus : Enabled +Version : 1 +``` + +Get all custom classification rules + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ClassificationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IClassificationRule + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewClassificationRuleVersion.md b/azps-10.1.0/Az.Purview/Get-AzPurviewClassificationRuleVersion.md new file mode 100644 index 0000000000..5b593feb0f --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewClassificationRuleVersion.md @@ -0,0 +1,137 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewclassificationruleversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewClassificationRuleVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewClassificationRuleVersion.md +--- + +# Get-AzPurviewClassificationRuleVersion + +## SYNOPSIS +Lists the rule versions of a classification rule + +## SYNTAX + +``` +Get-AzPurviewClassificationRuleVersion -Endpoint <String> -ClassificationRuleName <String> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists the rule versions of a classification rule + +## EXAMPLES + +### Example 1: Get all version of a custom classification rule +```powershell +Get-AzPurviewClassificationRuleVersion -Endpoint https://parv-brs-2.purview.azure.com -ClassificationRuleName 'ClassificationRule5' +``` + +```output +ClassificationAction : Keep +ClassificationName : ClassificationRule4 +ColumnPattern : {{ + "kind": "Regex", + "pattern": "^col1$" + }, { + "kind": "Regex", + "pattern": "^col2$" + }} +CreatedAt : 2/8/2022 10:04:55 PM +DataPattern : {} +Description : This is a rule2 +Id : classificationrules/ClassificationRule5/versions/1 +Kind : Custom +LastModifiedAt : 2/8/2022 10:04:55 PM +MinimumPercentageMatch : +Name : ClassificationRule5 +RuleStatus : Enabled +Version : 1 + +ClassificationAction : Keep +ClassificationName : ClassificationRule4 +ColumnPattern : {{ + "kind": "Regex", + "pattern": "^col1$" + }, { + "kind": "Regex", + "pattern": "^col2$" + }} +CreatedAt : 2/8/2022 10:04:55 PM +DataPattern : {} +Description : This is a rule2 +Id : classificationrules/ClassificationRule5/versions/2 +Kind : Custom +LastModifiedAt : 2/14/2022 9:00:32 AM +MinimumPercentageMatch : +Name : ClassificationRule5 +RuleStatus : Enabled +Version : 2 +``` + +Get all version of a custom classification rule + +## PARAMETERS + +### -ClassificationRuleName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IClassificationRule + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewDataSource.md b/azps-10.1.0/Az.Purview/Get-AzPurviewDataSource.md new file mode 100644 index 0000000000..ce1e2ccc71 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewDataSource.md @@ -0,0 +1,156 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewDataSource.md +--- + +# Get-AzPurviewDataSource + +## SYNOPSIS +Get a data source + +## SYNTAX + +### List (Default) +``` +Get-AzPurviewDataSource -Endpoint <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPurviewDataSource -Endpoint <String> -Name <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a data source + +## EXAMPLES + +### Example 1: Get a data source by name +```powershell +Get-AzPurviewDataSource -Endpoint 'https://brs-2.purview.azure.com/' -Name 'NewDataSource' +``` + +```output +CollectionLastModifiedAt : 2/9/2022 2:49:14 AM +CollectionReferenceName : brs-2 +CollectionType : CollectionReference +CreatedAt : 2/9/2022 2:49:14 AM +Endpoint : https://data123scantest.blob.core.windows.net/ +Id : datasources/NewDataSource +Kind : AzureStorage +LastModifiedAt : 2/9/2022 3:02:56 AM +Location : westus +Name : NewDataSource +ResourceGroup : rg +ResourceName : datascantest +Scan : +SubscriptionId : 4348d67b-ffc5-465d-b5dd-xxxxxxxxx +``` + +Get a data source named 'NewDataSource' + +### Example 2: Get all data sources +```powershell +Get-AzPurviewDataSource -Endpoint 'https://brs-2.purview.azure.com/' +``` + +```output +CollectionLastModifiedAt : 1/31/2022 10:28:16 AM +CollectionReferenceName : brs-2 +CollectionType : CollectionReference +CreatedAt : 1/31/2022 10:28:16 AM +Endpoint : https://0cb22aa692584b54b09files.file.core.windows.net/ +Id : datasources/AzureFileStorage-f1B +Kind : AzureFileService +LastModifiedAt : 1/31/2022 10:28:16 AM +Location : westus2 +Name : AzureFileStorage-f1B +ResourceGroup : scanning-wus2-df-files +ResourceName : 0cb22aa692584b54b09files +Scan : +SubscriptionId : aa41bbd9-a6aa-44a8-b5cb-xxxxxxxxx + +CollectionLastModifiedAt : 2/9/2022 2:49:14 AM +CollectionReferenceName : brs-2 +CollectionType : CollectionReference +CreatedAt : 2/9/2022 2:49:14 AM +Endpoint : https://datascan123test.blob.core.windows.net/ +Id : datasources/NewDataSource +Kind : AzureStorage +LastModifiedAt : 2/9/2022 3:02:56 AM +Location : westus +Name : NewDataSource +ResourceGroup : rg +ResourceName : datascantest +Scan : +SubscriptionId : 4348d67b-ffc5-465d-b5dd-xxxxxxxxx +``` + +Get all data sources + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DataSourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewDefaultAccount.md b/azps-10.1.0/Az.Purview/Get-AzPurviewDefaultAccount.md new file mode 100644 index 0000000000..7d0afc556a --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewDefaultAccount.md @@ -0,0 +1,115 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewdefaultaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewDefaultAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewDefaultAccount.md +--- + +# Get-AzPurviewDefaultAccount + +## SYNOPSIS +Get the default account for the scope. + +## SYNTAX + +``` +Get-AzPurviewDefaultAccount -ScopeTenantId <String> -ScopeType <ScopeType> [-Scope <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the default account for the scope. + +## EXAMPLES + +### Example 1: Get the default account for the scope Tenant. +```powershell +Get-AzPurviewDefaultAccount -ScopeTenantId xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a -ScopeType Tenant +``` + +```output +AccountName ResourceGroupName Scope ScopeTenantId ScopeType SubscriptionId +----------- ----------------- ----- ------------- --------- -------------- +test-pa test-rg xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a Tenant xxxxxxxx-1bf0-4dda-aec3 +``` + + Get the default account for the scope Tenant + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeTenantId +The tenant ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeType +The scope for the default account. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purview.Support.ScopeType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.Api20210701.IDefaultAccountPayload + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewFilter.md b/azps-10.1.0/Az.Purview/Get-AzPurviewFilter.md new file mode 100644 index 0000000000..0316b6db89 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewFilter.md @@ -0,0 +1,118 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewfilter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewFilter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewFilter.md +--- + +# Get-AzPurviewFilter + +## SYNOPSIS +Get a filter + +## SYNTAX + +``` +Get-AzPurviewFilter -Endpoint <String> -DataSourceName <String> -ScanName <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a filter + +## EXAMPLES + +### Example 1: Get the scope filters of the scan +```powershell +Get-AzPurviewFilter -Endpoint 'https://brs-2.purview.azure.com/' -DataSourceName 'DataScanTestData' -ScanName 'Scan1ForDemo' +``` + +```output +ExcludeUriPrefix : {https://foo.file.core.windows.net/share1/user/temp} +Id : datasources/DataScanTestData/scans/Scan1ForDemo/filters/custom +IncludeUriPrefix : {https://foo.file.core.windows.net/share1/user, + https://foo.file.core.windows.net/share1/aggregated} +Name : custom +``` + +Get the scope filters of the scan named 'Scan1ForDemo' for datasource 'DataScanTestData' + +## PARAMETERS + +### -DataSourceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IFilter + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewKeyVaultConnection.md b/azps-10.1.0/Az.Purview/Get-AzPurviewKeyVaultConnection.md new file mode 100644 index 0000000000..ae239038b6 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewKeyVaultConnection.md @@ -0,0 +1,127 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewkeyvaultconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewKeyVaultConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewKeyVaultConnection.md +--- + +# Get-AzPurviewKeyVaultConnection + +## SYNOPSIS +Gets key vault information + +## SYNTAX + +### List (Default) +``` +Get-AzPurviewKeyVaultConnection -Endpoint <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPurviewKeyVaultConnection -Endpoint <String> -KeyVaultName <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets key vault information + +## EXAMPLES + +### Example 1: Get key vault connection by name +```powershell +Get-AzPurviewKeyVaultConnection -Endpoint 'https://parv-brs-2.purview.azure.com/' -KeyVaultName 'KeyVaultConnection1' +``` + +```output +BaseUrl : https://datascantestcases.vault.azure.net/ +Description : This is a Key Vault connection +Id : keyVaults/KeyVaultConnection1 +Name : KeyVaultConnection1 +``` + +Get key vault connection named 'KeyVaultConnection1' + +### Example 2: Get all key vault connections +```powershell +Get-AzPurviewKeyVaultConnection -Endpoint 'https://parv-brs-2.purview.azure.com/' +``` + +```output +BaseUrl : https://datascantestcases.vault.azure.net/ +Description : This is a Key Vault connection +Id : keyVaults/KeyVaultConnection1 +Name : KeyVaultConnection1 + +BaseUrl : https://datascankv.vault.azure.net/ +Description : This is a key vault +Id : keyVaults/KeyVaultConnection2 +Name : KeyVaultConnection2 +``` + +Get all key vault connections + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultName +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IAzureKeyVault + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewScan.md b/azps-10.1.0/Az.Purview/Get-AzPurviewScan.md new file mode 100644 index 0000000000..de19095ac7 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewScan.md @@ -0,0 +1,175 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewscan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewScan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewScan.md +--- + +# Get-AzPurviewScan + +## SYNOPSIS +Gets a scan information + +## SYNTAX + +### List (Default) +``` +Get-AzPurviewScan -Endpoint <String> -DataSourceName <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPurviewScan -Endpoint <String> -DataSourceName <String> -Name <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a scan information + +## EXAMPLES + +### Example 1: Get scan instance within a data source +```powershell +Get-AzPurviewScan -Endpoint 'https://parv-brs-2.purview.azure.com/' -DataSourceName 'DataScanTestData-Parv' -Name 'ScanTest' +``` + +```output +CollectionLastModifiedAt : 2/15/2022 3:49:23 PM +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : 2/15/2022 3:49:23 PM +CredentialReferenceName : datascantestdataparv-accountkey +CredentialType : AccountKey +Id : datasources/DataScanTestData-Parv/scans/ScanTest +Kind : AzureStorageCredential +LastModifiedAt : 2/15/2022 11:46:29 PM +Name : ScanTest +Result : +ScanRulesetName : AzureStorage +ScanRulesetType : System +Worker : +``` + +Get scan instance named 'ScanTest' within a data source + +### Example 2: Get all scan instances within a data source +```powershell +Get-AzPurviewScan -Endpoint 'https://parv-brs-2.purview.azure.com/' -DataSourceName 'DataScanTestData-Parv' +``` + +```output +CollectionLastModifiedAt : 2/13/2022 3:16:24 PM +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : 2/13/2022 3:16:24 PM +CredentialReferenceName : datascantestdataparv-accountkey +CredentialType : AccountKey +Id : datasources/DataScanTestData-Parv/scans/Scan1ForDemo +Kind : AzureStorageCredential +LastModifiedAt : 2/13/2022 3:16:24 PM +Name : Scan1ForDemo +Result : +ScanRulesetName : AzureStorage +ScanRulesetType : System +Worker : + +CollectionLastModifiedAt : 2/15/2022 3:49:23 PM +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : 2/15/2022 3:49:23 PM +CredentialReferenceName : datascantestdataparv-accountkey +CredentialType : AccountKey +Id : datasources/DataScanTestData-Parv/scans/ScanTest +Kind : AzureStorageCredential +LastModifiedAt : 2/15/2022 11:46:29 PM +Name : ScanTest +Result : +ScanRulesetName : AzureStorage +ScanRulesetType : System +Worker : +``` + +Get all scan instances within a data source + +## PARAMETERS + +### -DataSourceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ScanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewScanResultScanHistory.md b/azps-10.1.0/Az.Purview/Get-AzPurviewScanResultScanHistory.md new file mode 100644 index 0000000000..05c43b1c3a --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewScanResultScanHistory.md @@ -0,0 +1,160 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewscanresultscanhistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewScanResultScanHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewScanResultScanHistory.md +--- + +# Get-AzPurviewScanResultScanHistory + +## SYNOPSIS +Lists the scan history of a scan + +## SYNTAX + +``` +Get-AzPurviewScanResultScanHistory -Endpoint <String> -DataSourceName <String> -ScanName <String> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists the scan history of a scan + +## EXAMPLES + +### Example 1: List all scan runs within a scan instance of a data source +```powershell +Get-AzPurviewScanResultScanHistory -Endpoint 'https://parv-brs-2.purview.azure.com/' -DataSourceName 'DataScanTestData-Parv' -ScanName 'Scan1ForDemo' | Format-List +``` + +```output +AssetsClassified : 62 +AssetsDiscovered : 97 +Code : +DataSourceType : AzureStorage +Detail : +DiagnosticExceptionCountMap : { + } +DiagnosticNotification : {} +EndTime : 2/15/2022 2:42:22 PM +ErrorMessage : +Id : 758a0499-b45e-40e3-9c06-408e2f3ac050 +Message : +ParentId : +PipelineStartTime : 2/15/2022 2:36:21 PM +QueuedTime : 2/15/2022 2:34:06 PM +ResourceId : /subscriptions/xxxxxxxx-ffc5-465d-b5dd-xxxxxxxx/resourceGroups/datascan-dev-tests/providers/Microsoft.Storage/storageAccounts/datascan +RunType : Manual +ScanLevelType : Full +ScanRulesetType : System +ScanRulesetVersion : 4 +StartTime : 2/15/2022 2:34:06 PM +Status : Succeeded +Target : + +AssetsClassified : 62 +AssetsDiscovered : 97 +Code : +DataSourceType : AzureStorage +Detail : +DiagnosticExceptionCountMap : { + } +DiagnosticNotification : {} +EndTime : 2/13/2022 3:23:53 PM +ErrorMessage : +Id : a81d7a0f-149b-4c57-80ae-0f4640ee5a29 +Message : +ParentId : +PipelineStartTime : 2/13/2022 3:17:02 PM +QueuedTime : 2/13/2022 3:16:34 PM +ResourceId : /subscriptions/xxxxxxxx-ffc5-465d-b5dd-xxxxxxxx/resourceGroups/datascan-dev-tests/providers/Microsoft.Storage/storageAccounts/datascan +RunType : Manual +ScanLevelType : Full +ScanRulesetType : System +ScanRulesetVersion : 4 +StartTime : 2/13/2022 3:16:34 PM +Status : Succeeded +Target : +``` + +List all scan runs within a scan instance of a data source + +## PARAMETERS + +### -DataSourceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IScanResult + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewScanRuleset.md b/azps-10.1.0/Az.Purview/Get-AzPurviewScanRuleset.md new file mode 100644 index 0000000000..6a588faca9 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewScanRuleset.md @@ -0,0 +1,154 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewscanruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewScanRuleset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewScanRuleset.md +--- + +# Get-AzPurviewScanRuleset + +## SYNOPSIS +Get a scan ruleset + +## SYNTAX + +### List (Default) +``` +Get-AzPurviewScanRuleset -Endpoint <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPurviewScanRuleset -Endpoint <String> -Name <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a scan ruleset + +## EXAMPLES + +### Example 1: Get all custom scanrulesets +```powershell +Get-AzPurviewScanRuleset -Endpoint https://parv-brs-2.purview.azure.com/ +``` + +```output +CreatedAt : 1/25/2022 2:01:38 AM +Description : asdasd +ExcludedSystemClassification : {MICROSOFT.GOVERNMENT.CYPRUS.TAX.IDENTIFICATION.NUMBER, MICROSOFT.GOVERNMENT.CHILE.CDI_NUMBER, MICROSOFT.GOVERNMENT.MALTA.DRIVERS.LICENSE.NUMBER, + MICROSOFT.GOVERNMENT.TURKEY.TURKISH_NATIONAL_IDENTIFICATION_NUMBER…} +Id : scanrulesets/DummySRSFOrDemo +IncludedCustomClassificationRuleName : {} +Kind : AzureStorage +LastModifiedAt : 1/27/2022 4:37:15 AM +Name : DummySRSFOrDemo +ScanningRuleCustomFileExtension : +ScanningRuleFileExtension : {CSV, JSON, PSV, SSV…} +Status : Enabled +Type : Custom +Version : 4 + +CreatedAt : 2/17/2022 2:30:15 PM +Description : test desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS, MICROSOFT.MISCELLANEOUS.IPADDRESS} +Id : scanrulesets/TestRule +IncludedCustomClassificationRuleName : {ClassificationRule5, ClassificationRule2} +Kind : AzureStorage +LastModifiedAt : 2/17/2022 2:32:02 PM +Name : TestRule +ScanningRuleCustomFileExtension : +ScanningRuleFileExtension : {CSV, JSON, PSV, SSV…} +Status : Enabled +Type : Custom +Version : 2 +``` + +Get all custom scanrulesets + +### Example 2: Get custom scanruleset by name +```powershell +Get-AzPurviewScanRuleset -Endpoint https://parv-brs-2.purview.azure.com/ -Name TestRule +``` + +```output +CreatedAt : 2/17/2022 2:30:15 PM +Description : test desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS, MICROSOFT.MISCELLANEOUS.IPADDRESS} +Id : scanrulesets/TestRule +IncludedCustomClassificationRuleName : {ClassificationRule5, ClassificationRule2} +Kind : AzureStorage +LastModifiedAt : 2/17/2022 2:32:02 PM +Name : TestRule +ScanningRuleCustomFileExtension : +ScanningRuleFileExtension : {CSV, JSON, PSV, SSV…} +Status : Enabled +Type : Custom +Version : 2 +``` + +Get custom scanruleset by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ScanRulesetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewSystemScanRuleset.md b/azps-10.1.0/Az.Purview/Get-AzPurviewSystemScanRuleset.md new file mode 100644 index 0000000000..fee24176bf --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewSystemScanRuleset.md @@ -0,0 +1,202 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewsystemscanruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewSystemScanRuleset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewSystemScanRuleset.md +--- + +# Get-AzPurviewSystemScanRuleset + +## SYNOPSIS +Get a system scan ruleset for a data source + +## SYNTAX + +### List (Default) +``` +Get-AzPurviewSystemScanRuleset -Endpoint <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get1 +``` +Get-AzPurviewSystemScanRuleset -Endpoint <String> [-DataSourceType <DataSourceType>] -Version <Int32> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzPurviewSystemScanRuleset -Endpoint <String> -DataSourceType <DataSourceType> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a system scan ruleset for a data source + +## EXAMPLES + +### Example 1: Get all system scanrulesets +```powershell +Get-AzPurviewSystemScanRuleset -Endpoint https://parv-brs-2.purview.azure.com/ +``` + +```output +Id : systemscanrulesets/AmazonMySql +Kind : AmazonMySql +Name : AmazonMySql +ResourceGroupName : +Status : Enabled +Type : System +Version : 2 + +Id : systemscanrulesets/AzureMySql +Kind : AzureMySql +Name : AzureMySql +ResourceGroupName : +Status : Enabled +Type : System +Version : 2 + +Id : systemscanrulesets/AmazonPostgreSql +Kind : AmazonPostgreSql +Name : AmazonPostgreSql +ResourceGroupName : +Status : Enabled +Type : System +Version : 2 + +Id : systemscanrulesets/Teradata +Kind : Teradata +Name : Teradata +ResourceGroupName : +Status : Enabled +Type : System +Version : 1 +``` + +Get all system scanrulesets + +### Example 2: Get system scanruleset for a data source type +```powershell +Get-AzPurviewSystemScanRuleset -Endpoint https://parv-brs-2.purview.azure.com/ -DataSourceType 'AdlsGen2' +``` + +```output +Id : systemscanrulesets/AdlsGen2 +Kind : AdlsGen2 +Name : AdlsGen2 +ResourceGroupName : +Status : Enabled +Type : System +Version : 3 +``` + +Get system scanruleset for a data source type + +### Example 3: Get system scanruleset for a data source type and specific version +```powershell +Get-AzPurviewSystemScanRuleset -Endpoint https://parv-brs-2.purview.azure.com/ -DataSourceType 'AdlsGen2' -Version 2 +``` + +```output +Id : systemscanrulesets/AdlsGen2 +Kind : AdlsGen2 +Name : AdlsGen2 +ResourceGroupName : +Status : Enabled +Type : System +Version : 2 +``` + +Get system scanruleset for a data source type and specific version + +## PARAMETERS + +### -DataSourceType +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: Get1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +. + +```yaml +Type: System.Int32 +Parameter Sets: Get1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.ISystemScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewSystemScanRulesetLatest.md b/azps-10.1.0/Az.Purview/Get-AzPurviewSystemScanRulesetLatest.md new file mode 100644 index 0000000000..accea724a8 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewSystemScanRulesetLatest.md @@ -0,0 +1,105 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewsystemscanrulesetlatest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewSystemScanRulesetLatest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewSystemScanRulesetLatest.md +--- + +# Get-AzPurviewSystemScanRulesetLatest + +## SYNOPSIS +Get the latest version of a system scan ruleset + +## SYNTAX + +``` +Get-AzPurviewSystemScanRulesetLatest -Endpoint <String> [-DataSourceType <DataSourceType>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the latest version of a system scan ruleset + +## EXAMPLES + +### Example 1: Get latest system scan ruleset available for a data source +```powershell +Get-AzPurviewSystemScanRulesetLatest -Endpoint https://parv-brs-2.purview.azure.com/ -DataSourceType 'AzureStorage' +``` + +```output +Id : systemscanrulesets/AzureStorage +Kind : AzureStorage +Name : AzureStorage +ResourceGroupName : +Status : Enabled +Type : System +Version : 4 +``` + +Get latest system scan ruleset available for a data source + +## PARAMETERS + +### -DataSourceType +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.ISystemScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewSystemScanRulesetVersion.md b/azps-10.1.0/Az.Purview/Get-AzPurviewSystemScanRulesetVersion.md new file mode 100644 index 0000000000..d382832e90 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewSystemScanRulesetVersion.md @@ -0,0 +1,129 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewsystemscanrulesetversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewSystemScanRulesetVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewSystemScanRulesetVersion.md +--- + +# Get-AzPurviewSystemScanRulesetVersion + +## SYNOPSIS +List system scan ruleset versions in Data catalog + +## SYNTAX + +``` +Get-AzPurviewSystemScanRulesetVersion -Endpoint <String> [-DataSourceType <DataSourceType>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List system scan ruleset versions in Data catalog + +## EXAMPLES + +### Example 1: Get all versions of system scanruleset available for a data source +```powershell +Get-AzPurviewSystemScanRulesetVersion -Endpoint https://parv-brs-2.purview.azure.com/ -DataSourceType 'AzureStorage' +``` + +```output +Id : systemscanrulesets/AzureStorage +Kind : AzureStorage +Name : AzureStorage +ResourceGroupName : +Status : Enabled +Type : System +Version : 4 + +Id : systemscanrulesets/AzureStorage +Kind : AzureStorage +Name : AzureStorage +ResourceGroupName : +Status : Enabled +Type : System +Version : 3 + +Id : systemscanrulesets/AzureStorage +Kind : AzureStorage +Name : AzureStorage +ResourceGroupName : +Status : Enabled +Type : System +Version : 2 + +Id : systemscanrulesets/AzureStorage +Kind : AzureStorage +Name : AzureStorage +ResourceGroupName : +Status : Enabled +Type : System +Version : 1 +``` + +Get all versions of system scanruleset available for a data source + +## PARAMETERS + +### -DataSourceType +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.ISystemScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Get-AzPurviewTrigger.md b/azps-10.1.0/Az.Purview/Get-AzPurviewTrigger.md new file mode 100644 index 0000000000..d234fd17ce --- /dev/null +++ b/azps-10.1.0/Az.Purview/Get-AzPurviewTrigger.md @@ -0,0 +1,134 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/get-azpurviewtrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Get-AzPurviewTrigger.md +--- + +# Get-AzPurviewTrigger + +## SYNOPSIS +Gets trigger information + +## SYNTAX + +``` +Get-AzPurviewTrigger -Endpoint <String> -DataSourceName <String> -ScanName <String> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets trigger information + +## EXAMPLES + +### Example 1: Get trigger schedule for scan run +```powershell +Get-AzPurviewTrigger -Endpoint https://parv-brs-2.purview.azure.com/ -DataSourceName 'DataScanTestData-Parv' -ScanName 'Scan-6HK' +``` + +```output +CreatedAt : 2/17/2022 1:35:12 PM +Id : datasources/DataScanTestData-Parv/scans/Scan-6HK/triggers/default +IncrementalScanStartTime : +Interval : 1 +LastModifiedAt : 2/17/2022 1:35:12 PM +LastScheduled : +Name : default +RecurrenceEndTime : 7/20/2022 12:00:00 AM +RecurrenceFrequency : Month +RecurrenceInterval : +RecurrenceStartTime : 2/17/2022 1:32:00 PM +RecurrenceTimeZone : +ResourceGroupName : +ScanLevel : Incremental +ScheduleAdditionalProperty : { + } +ScheduleHour : {9} +ScheduleMinute : {0} +ScheduleMonthDay : {10} +ScheduleMonthlyOccurrence : +ScheduleWeekDay : +``` + +Get trigger schedule for scan run + +## PARAMETERS + +### -DataSourceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.ITrigger + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Invoke-AzPurviewTagClassificationRuleClassificationVersion.md b/azps-10.1.0/Az.Purview/Invoke-AzPurviewTagClassificationRuleClassificationVersion.md new file mode 100644 index 0000000000..58b510aad8 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Invoke-AzPurviewTagClassificationRuleClassificationVersion.md @@ -0,0 +1,163 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/invoke-azpurviewtagclassificationruleclassificationversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Invoke-AzPurviewTagClassificationRuleClassificationVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Invoke-AzPurviewTagClassificationRuleClassificationVersion.md +--- + +# Invoke-AzPurviewTagClassificationRuleClassificationVersion + +## SYNOPSIS +Sets Classification Action on a specific classification rule version. + +## SYNTAX + +``` +Invoke-AzPurviewTagClassificationRuleClassificationVersion -Endpoint <String> -ClassificationRuleName <String> + -ClassificationRuleVersion <Int32> -Action <ClassificationAction> [-DefaultProfile <PSObject>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets Classification Action on a specific classification rule version. + +## EXAMPLES + +### Example 1: Set Classification Action on specific rule version +```powershell +Invoke-AzPurviewTagClassificationRuleClassificationVersion -Endpoint 'https://parv-brs-2.purview.azure.com/' -ClassificationRuleName 'ClassificationRule2' -ClassificationRuleVersion 1 -Action 'Delete' +``` + +```output +EndTime ScanResultId StartTime Status +------- ------------ --------- ------ + Accepted +``` + +Set Classification Action on specific rule version + +## PARAMETERS + +### -Action +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ClassificationAction +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationRuleName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationRuleVersion +. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IOperationResponse + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAccount.md b/azps-10.1.0/Az.Purview/New-AzPurviewAccount.md new file mode 100644 index 0000000000..4d523ff655 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAccount.md @@ -0,0 +1,284 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/new-azpurviewaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAccount.md +--- + +# New-AzPurviewAccount + +## SYNOPSIS +Creates or updates an account + +## SYNTAX + +``` +New-AzPurviewAccount -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] -IdentityType <Type> + -Location <String> -SkuCapacity <Int32> -SkuName <Name> [-ManagedResourceGroupName <String>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an account + +## EXAMPLES + +### Example 1: Create a purview account +```powershell +New-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg -Location eastus -IdentityType SystemAssigned -SkuCapacity 4 -SkuName Standard +``` + +```output +IdentityPrincipalId IdentityTenantId IdentityType Location Name SystemDataCreatedAt SystemDataCreatedBy +------------------- ---------------- ------------ -------- ---- ------------------- ----------- +xxxxxxxx-9e08-4873-8b0d-1442be9e5b14 54826b22-38d6-4fb2-bad9-b7b93a3e9c5a SystemAssigned eastus test-pa 8/17/2021 7:47:10 AM xxx.xxx… +``` + +Create a purview account named 'test-pa'. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Identity Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purview.Support.Type +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Gets or sets the location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedResourceGroupName +Gets or sets the managed resource group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Gets or sets the public network access. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purview.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Gets or sets the sku capacity. +Possible values include: 4, 16 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Gets or sets the sku name. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purview.Support.Name +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags on the azure resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.Api20210701.IAccount + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen1CredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen1CredentialScanObject.md new file mode 100644 index 0000000000..5f5566b0f8 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen1CredentialScanObject.md @@ -0,0 +1,195 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAdlsGen1CredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen1CredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen1CredentialScanObject.md +--- + +# New-AzPurviewAdlsGen1CredentialScanObject + +## SYNOPSIS +Create an in-memory object for AdlsGen1CredentialScan. + +## SYNTAX + +``` +New-AzPurviewAdlsGen1CredentialScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-CredentialReferenceName <String>] + [-CredentialType <CredentialType>] [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] + [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AdlsGen1CredentialScan. + +## EXAMPLES + +### Example 1: Create AdlsGen1 Credential scan object +```powershell +New-AzPurviewAdlsGen1CredentialScanObject -Kind 'AdlsGen1Credential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'svcp' -CredentialType 'ServicePrincipal' -ScanRulesetName 'AdlsGen1' -ScanRulesetType 'System' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : svcp +CredentialType : ServicePrincipal +Id : +Kind : AdlsGen1Credential +LastModifiedAt : +Name : +Result : +ScanRulesetName : AdlsGen1 +ScanRulesetType : System +Worker : +``` + +Create AdlsGen1 Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AdlsGen1CredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen1DataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen1DataSourceObject.md new file mode 100644 index 0000000000..c78dfbfabb --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen1DataSourceObject.md @@ -0,0 +1,179 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAdlsGen1DataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen1DataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen1DataSourceObject.md +--- + +# New-AzPurviewAdlsGen1DataSourceObject + +## SYNOPSIS +Create an in-memory object for AdlsGen1DataSource. + +## SYNTAX + +``` +New-AzPurviewAdlsGen1DataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Endpoint <String>] [-Location <String>] [-ResourceGroup <String>] + [-ResourceName <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AdlsGen1DataSource. + +## EXAMPLES + +### Example 1: Create AdlsGen1 data source object +```powershell +New-AzPurviewAdlsGen1DataSourceObject -Kind 'AdlsGen1' -CollectionReferenceName parv-brs-2 -CollectionType 'CollectionReference' -Endpoint 'adl://adlsgen1datascan02ause.azuredatalakestore.net' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Endpoint : adl://adlsgen1datascan02ause.azuredatalakestore.net +Id : +Kind : AdlsGen1 +LastModifiedAt : +Location : +Name : +ResourceGroup : +ResourceName : +Scan : +SubscriptionId : +``` + +Create AdlsGen1 data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AdlsGen1DataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen1MsiScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen1MsiScanObject.md new file mode 100644 index 0000000000..5d74252da8 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen1MsiScanObject.md @@ -0,0 +1,164 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAdlsGen1MsiScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen1MsiScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen1MsiScanObject.md +--- + +# New-AzPurviewAdlsGen1MsiScanObject + +## SYNOPSIS +Create an in-memory object for AdlsGen1MsiScan. + +## SYNTAX + +``` +New-AzPurviewAdlsGen1MsiScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-ScanRulesetName <String>] + [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AdlsGen1MsiScan. + +## EXAMPLES + +### Example 1: Create AdlsGen1 Msi scan object +```powershell +New-AzPurviewAdlsGen1MsiScanObject -Kind 'AdlsGen1Msi' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ScanRulesetName 'AdlsGen1' -ScanRulesetType 'System' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +Id : +Kind : AdlsGen1Msi +LastModifiedAt : +Name : +Result : +ScanRulesetName : AdlsGen1 +ScanRulesetType : System +Worker : +``` + +Create AdlsGen1 Msi scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AdlsGen1MsiScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen1ScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen1ScanRulesetObject.md new file mode 100644 index 0000000000..2d8dd351ee --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen1ScanRulesetObject.md @@ -0,0 +1,178 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAdlsGen1ScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen1ScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen1ScanRulesetObject.md +--- + +# New-AzPurviewAdlsGen1ScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AdlsGen1ScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAdlsGen1ScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-ScanningRuleCustomFileExtension <ICustomFileExtension[]>] + [-ScanningRuleFileExtension <FileExtensionsType[]>] [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AdlsGen1ScanRuleset. + +## EXAMPLES + +### Example 1: Create AdlsGen1 custom scanruleset object +```powershell +New-AzPurviewAdlsGen1ScanRulesetObject -Kind 'AdlsGen1' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -ScanningRuleFileExtension @("CSV","JSON","PSV","SSV","TSV","TXT","XML","PARQUET","AVRO","ORC","Documents","GZ","DOC","DOCM","DOCX","DOT","ODP","ODS","ODT","PDF","POT","PPS","PPSX","PPT","PPTM","PPTX","XLC","XLS","XLSB","XLSM","XLSX","XLT") -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AdlsGen1 +LastModifiedAt : +Name : +ScanningRuleCustomFileExtension : +ScanningRuleFileExtension : {CSV, JSON, PSV, SSV…} +Status : +Type : Custom +Version : +``` + +Create AdlsGen1 custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanningRuleCustomFileExtension +To construct, see NOTES section for SCANNINGRULECUSTOMFILEEXTENSION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.ICustomFileExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanningRuleFileExtension + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.FileExtensionsType[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AdlsGen1ScanRuleset + +## 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. + + +SCANNINGRULECUSTOMFILEEXTENSION <ICustomFileExtension[]>: + - `[CustomFileTypeBuiltInType <FileExtensionsType?>]`: + - `[CustomFileTypeCustomDelimiter <String>]`: + - `[Description <String>]`: + - `[Enabled <Boolean?>]`: + - `[FileExtension <String>]`: + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen2CredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen2CredentialScanObject.md new file mode 100644 index 0000000000..0f4a8eaaf1 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen2CredentialScanObject.md @@ -0,0 +1,195 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAdlsGen2CredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen2CredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen2CredentialScanObject.md +--- + +# New-AzPurviewAdlsGen2CredentialScanObject + +## SYNOPSIS +Create an in-memory object for AdlsGen2CredentialScan. + +## SYNTAX + +``` +New-AzPurviewAdlsGen2CredentialScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-CredentialReferenceName <String>] + [-CredentialType <CredentialType>] [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] + [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AdlsGen2CredentialScan. + +## EXAMPLES + +### Example 1: Create AdlsGen2 Credential scan object +```powershell +New-AzPurviewAdlsGen2CredentialScanObject -Kind 'AdlsGen2Credential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'datascantestdataparv-accountkey' -CredentialType 'AccountKey' -ScanRulesetName 'AdlsGen2' -ScanRulesetType 'System' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : datascantestdataparv-accountkey +CredentialType : AccountKey +Id : +Kind : AdlsGen2Credential +LastModifiedAt : +Name : +Result : +ScanRulesetName : AdlsGen2 +ScanRulesetType : System +Worker : +``` + +Create AdlsGen2 Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AdlsGen2CredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen2DataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen2DataSourceObject.md new file mode 100644 index 0000000000..f6b081ccf8 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen2DataSourceObject.md @@ -0,0 +1,179 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAdlsGen2DataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen2DataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen2DataSourceObject.md +--- + +# New-AzPurviewAdlsGen2DataSourceObject + +## SYNOPSIS +Create an in-memory object for AdlsGen2DataSource. + +## SYNTAX + +``` +New-AzPurviewAdlsGen2DataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Endpoint <String>] [-Location <String>] [-ResourceGroup <String>] + [-ResourceName <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AdlsGen2DataSource. + +## EXAMPLES + +### Example 1: Create AdlsGen2 data source object +```powershell +New-AzPurviewAdlsGen2DataSourceObject -Kind 'AdlsGen2' -CollectionReferenceName parv-brs-2 -CollectionType 'CollectionReference' -Endpoint 'https://adlsgen2datascan.dfs.core.windows.net' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Endpoint : https://adlsgen2datascan.dfs.core.windows.net +Id : +Kind : AdlsGen2 +LastModifiedAt : +Location : +Name : +ResourceGroup : +ResourceName : +Scan : +SubscriptionId : +``` + +Create AdlsGen2 data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AdlsGen2DataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen2MsiScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen2MsiScanObject.md new file mode 100644 index 0000000000..b2ffcb7df9 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen2MsiScanObject.md @@ -0,0 +1,164 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAdlsGen2MsiScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen2MsiScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen2MsiScanObject.md +--- + +# New-AzPurviewAdlsGen2MsiScanObject + +## SYNOPSIS +Create an in-memory object for AdlsGen2MsiScan. + +## SYNTAX + +``` +New-AzPurviewAdlsGen2MsiScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-ScanRulesetName <String>] + [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AdlsGen2MsiScan. + +## EXAMPLES + +### Example 1: Create AdlsGen2 Msi scan object +```powershell +New-AzPurviewAdlsGen2MsiScanObject -Kind 'AdlsGen2Msi' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ScanRulesetName 'AdlsGen2' -ScanRulesetType 'System' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +Id : +Kind : AdlsGen2Msi +LastModifiedAt : +Name : +Result : +ScanRulesetName : AdlsGen2 +ScanRulesetType : System +Worker : +``` + +Create AdlsGen2 Msi scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AdlsGen2MsiScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen2ScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen2ScanRulesetObject.md new file mode 100644 index 0000000000..92d4c84806 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAdlsGen2ScanRulesetObject.md @@ -0,0 +1,178 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAdlsGen2ScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen2ScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAdlsGen2ScanRulesetObject.md +--- + +# New-AzPurviewAdlsGen2ScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AdlsGen2ScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAdlsGen2ScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-ScanningRuleCustomFileExtension <ICustomFileExtension[]>] + [-ScanningRuleFileExtension <FileExtensionsType[]>] [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AdlsGen2ScanRuleset. + +## EXAMPLES + +### Example 1: Create AdlsGen2 custom scanruleset object +```powershell +New-AzPurviewAdlsGen2ScanRulesetObject -Kind 'AdlsGen2' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -ScanningRuleFileExtension @("CSV","JSON","PSV","SSV","TSV","TXT","XML","PARQUET","AVRO","ORC","Documents","GZ","DOC","DOCM","DOCX","DOT","ODP","ODS","ODT","PDF","POT","PPS","PPSX","PPT","PPTM","PPTX","XLC","XLS","XLSB","XLSM","XLSX","XLT") -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AdlsGen2 +LastModifiedAt : +Name : +ScanningRuleCustomFileExtension : +ScanningRuleFileExtension : {CSV, JSON, PSV, SSV…} +Status : +Type : Custom +Version : +``` + +Create AdlsGen2 custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanningRuleCustomFileExtension +To construct, see NOTES section for SCANNINGRULECUSTOMFILEEXTENSION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.ICustomFileExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanningRuleFileExtension + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.FileExtensionsType[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AdlsGen2ScanRuleset + +## 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. + + +SCANNINGRULECUSTOMFILEEXTENSION <ICustomFileExtension[]>: + - `[CustomFileTypeBuiltInType <FileExtensionsType?>]`: + - `[CustomFileTypeCustomDelimiter <String>]`: + - `[Description <String>]`: + - `[Enabled <Boolean?>]`: + - `[FileExtension <String>]`: + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAmazonAccountCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonAccountCredentialScanObject.md new file mode 100644 index 0000000000..8401183792 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonAccountCredentialScanObject.md @@ -0,0 +1,404 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAmazonAccountCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonAccountCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonAccountCredentialScanObject.md +--- + +# New-AzPurviewAmazonAccountCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AmazonAccountCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAmazonAccountCredentialScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] + [-ResourceType <IExpandingResourceScanPropertiesResourceTypes>] [-ScanRulesetName <String>] + [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AmazonAccountCredentialScan. + +## EXAMPLES + +### Example 1: Create Amazon Account Credential scan object +```powershell +New-AzPurviewAmazonAccountCredentialScanObject -Kind 'AmazonAccountCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'rolearncred' -CredentialType 'AmazonARN' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : rolearncred +CredentialType : AmazonARN +Id : +Kind : AmazonAccountCredential +LastModifiedAt : +Name : +ResourceType : { + } +Result : +ScanRulesetName : AmazonAccount +ScanRulesetType : System +Worker : +``` + +Create Amazon Account Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +To construct, see NOTES section for RESOURCETYPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IExpandingResourceScanPropertiesResourceTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AmazonAccountCredentialScan + +## 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. + + +RESOURCETYPE `<IExpandingResourceScanPropertiesResourceTypes>`: + - `[AdlGen1ScanRulesetName <String>]`: + - `[AdlGen1ScanRulesetType <ScanRulesetType?>]`: + - `[AdlGen2ScanRulesetName <String>]`: + - `[AdlGen2ScanRulesetType <ScanRulesetType?>]`: + - `[AdlsGen1CredentialReferenceName <String>]`: + - `[AdlsGen1CredentialType <CredentialType?>]`: + - `[AdlsGen1ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterResource <String[]>]`: + - `[AdlsGen2CredentialReferenceName <String>]`: + - `[AdlsGen2CredentialType <CredentialType?>]`: + - `[AdlsGen2ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterResource <String[]>]`: + - `[AmazonAccountCredentialReferenceName <String>]`: + - `[AmazonAccountCredentialType <CredentialType?>]`: + - `[AmazonAccountResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterResource <String[]>]`: + - `[AmazonAccountScanRulesetName <String>]`: + - `[AmazonAccountScanRulesetType <ScanRulesetType?>]`: + - `[AmazonPostgreSqlCredentialReferenceName <String>]`: + - `[AmazonPostgreSqlCredentialType <CredentialType?>]`: + - `[AmazonPostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterResource <String[]>]`: + - `[AmazonPostgreSqlScanRulesetName <String>]`: + - `[AmazonPostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AmazonS3CredentialReferenceName <String>]`: + - `[AmazonS3CredentialType <CredentialType?>]`: + - `[AmazonS3ResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterResource <String[]>]`: + - `[AmazonS3ScanRulesetName <String>]`: + - `[AmazonS3ScanRulesetType <ScanRulesetType?>]`: + - `[AmazonSqlCredentialReferenceName <String>]`: + - `[AmazonSqlCredentialType <CredentialType?>]`: + - `[AmazonSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterResource <String[]>]`: + - `[AmazonSqlScanRulesetName <String>]`: + - `[AmazonSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmoDbScanRulesetName <String>]`: + - `[AzureCosmoDbScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmosDbCredentialReferenceName <String>]`: + - `[AzureCosmosDbCredentialType <CredentialType?>]`: + - `[AzureCosmosDbResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerCredentialReferenceName <String>]`: + - `[AzureDataExplorerCredentialType <CredentialType?>]`: + - `[AzureDataExplorerResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerScanRulesetName <String>]`: + - `[AzureDataExplorerScanRulesetType <ScanRulesetType?>]`: + - `[AzureFileServiceCredentialReferenceName <String>]`: + - `[AzureFileServiceCredentialType <CredentialType?>]`: + - `[AzureFileServiceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterResource <String[]>]`: + - `[AzureFileServiceScanRulesetName <String>]`: + - `[AzureFileServiceScanRulesetType <ScanRulesetType?>]`: + - `[AzureMySqlCredentialReferenceName <String>]`: + - `[AzureMySqlCredentialType <CredentialType?>]`: + - `[AzureMySqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterResource <String[]>]`: + - `[AzureMySqlScanRulesetName <String>]`: + - `[AzureMySqlScanRulesetType <ScanRulesetType?>]`: + - `[AzurePostgreSqlCredentialReferenceName <String>]`: + - `[AzurePostgreSqlCredentialType <CredentialType?>]`: + - `[AzurePostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterResource <String[]>]`: + - `[AzurePostgreSqlScanRulesetName <String>]`: + - `[AzurePostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureResourceGroupCredentialReferenceName <String>]`: + - `[AzureResourceGroupCredentialType <CredentialType?>]`: + - `[AzureResourceGroupResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterResource <String[]>]`: + - `[AzureResourceGroupScanRulesetName <String>]`: + - `[AzureResourceGroupScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDataWarehouseCredentialReferenceName <String>]`: + - `[AzureSqlDataWarehouseCredentialType <CredentialType?>]`: + - `[AzureSqlDataWarehouseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDataWarehouseScanRulesetName <String>]`: + - `[AzureSqlDataWarehouseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetName <String>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseScanRulesetName <String>]`: + - `[AzureSqlDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[AzureStorageCredentialReferenceName <String>]`: + - `[AzureStorageCredentialType <CredentialType?>]`: + - `[AzureStorageResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterResource <String[]>]`: + - `[AzureStorageScanRulesetName <String>]`: + - `[AzureStorageScanRulesetType <ScanRulesetType?>]`: + - `[AzureSubscriptionCredentialReferenceName <String>]`: + - `[AzureSubscriptionCredentialType <CredentialType?>]`: + - `[AzureSubscriptionResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterResource <String[]>]`: + - `[AzureSubscriptionScanRulesetName <String>]`: + - `[AzureSubscriptionScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseCredentialReferenceName <String>]`: + - `[AzureSynapseCredentialType <CredentialType?>]`: + - `[AzureSynapseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterResource <String[]>]`: + - `[AzureSynapseScanRulesetName <String>]`: + - `[AzureSynapseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseWorkspaceCredentialReferenceName <String>]`: + - `[AzureSynapseWorkspaceCredentialType <CredentialType?>]`: + - `[AzureSynapseWorkspaceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterResource <String[]>]`: + - `[AzureSynapseWorkspaceScanRulesetName <String>]`: + - `[AzureSynapseWorkspaceScanRulesetType <ScanRulesetType?>]`: + - `[NoneCredentialReferenceName <String>]`: + - `[NoneCredentialType <CredentialType?>]`: + - `[NoneResourceNameFilterExcludePrefix <String[]>]`: + - `[NoneResourceNameFilterIncludePrefix <String[]>]`: + - `[NoneResourceNameFilterResource <String[]>]`: + - `[NoneScanRulesetName <String>]`: + - `[NoneScanRulesetType <ScanRulesetType?>]`: + - `[OracleCredentialReferenceName <String>]`: + - `[OracleCredentialType <CredentialType?>]`: + - `[OracleResourceNameFilterExcludePrefix <String[]>]`: + - `[OracleResourceNameFilterIncludePrefix <String[]>]`: + - `[OracleResourceNameFilterResource <String[]>]`: + - `[OracleScanRulesetName <String>]`: + - `[OracleScanRulesetType <ScanRulesetType?>]`: + - `[PowerBiCredentialReferenceName <String>]`: + - `[PowerBiCredentialType <CredentialType?>]`: + - `[PowerBiResourceNameFilterExcludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterIncludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterResource <String[]>]`: + - `[PowerBiScanRulesetName <String>]`: + - `[PowerBiScanRulesetType <ScanRulesetType?>]`: + - `[SapEccCredentialReferenceName <String>]`: + - `[SapEccCredentialType <CredentialType?>]`: + - `[SapEccResourceNameFilterExcludePrefix <String[]>]`: + - `[SapEccResourceNameFilterIncludePrefix <String[]>]`: + - `[SapEccResourceNameFilterResource <String[]>]`: + - `[SapEccScanRulesetName <String>]`: + - `[SapEccScanRulesetType <ScanRulesetType?>]`: + - `[SapS4HanaCredentialReferenceName <String>]`: + - `[SapS4HanaCredentialType <CredentialType?>]`: + - `[SapS4HanaResourceNameFilterExcludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterIncludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterResource <String[]>]`: + - `[SapS4HanaScanRulesetName <String>]`: + - `[SapS4HanaScanRulesetType <ScanRulesetType?>]`: + - `[SqlServerDatabaseCredentialReferenceName <String>]`: + - `[SqlServerDatabaseCredentialType <CredentialType?>]`: + - `[SqlServerDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterResource <String[]>]`: + - `[SqlServerDatabaseScanRulesetName <String>]`: + - `[SqlServerDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[TeradataCredentialReferenceName <String>]`: + - `[TeradataCredentialType <CredentialType?>]`: + - `[TeradataResourceNameFilterExcludePrefix <String[]>]`: + - `[TeradataResourceNameFilterIncludePrefix <String[]>]`: + - `[TeradataResourceNameFilterResource <String[]>]`: + - `[TeradataScanRulesetName <String>]`: + - `[TeradataScanRulesetType <ScanRulesetType?>]`: + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAmazonAccountDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonAccountDataSourceObject.md new file mode 100644 index 0000000000..341246ce00 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonAccountDataSourceObject.md @@ -0,0 +1,133 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAmazonAccountDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonAccountDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonAccountDataSourceObject.md +--- + +# New-AzPurviewAmazonAccountDataSourceObject + +## SYNOPSIS +Create an in-memory object for AmazonAccountDataSource. + +## SYNTAX + +``` +New-AzPurviewAmazonAccountDataSourceObject -Kind <DataSourceType> [-AwsAccountId <String>] + [-CollectionReferenceName <String>] [-CollectionType <String>] [-RoleArn <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AmazonAccountDataSource. + +## EXAMPLES + +### Example 1: Create Amazon Account data source object +```powershell +New-AzPurviewAmazonAccountDataSourceObject -Kind 'AmazonAccount' -AwsAccountId 123456789012 -CollectionReferenceName parv-brs-2 -CollectionType 'CollectionReference' +``` + +```output +AwsAccountId : 123456789012 +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : AmazonAccount +LastModifiedAt : +Name : +RoleArn : +Scan : +``` + +Create Amazon Account data source object + +## PARAMETERS + +### -AwsAccountId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleArn + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AmazonAccountDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAmazonPostgreSqlCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonPostgreSqlCredentialScanObject.md new file mode 100644 index 0000000000..7b37ae54d4 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonPostgreSqlCredentialScanObject.md @@ -0,0 +1,256 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAmazonPostgreSqlCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonPostgreSqlCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonPostgreSqlCredentialScanObject.md +--- + +# New-AzPurviewAmazonPostgreSqlCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AmazonPostgreSqlCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAmazonPostgreSqlCredentialScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] [-DatabaseName <String>] + [-Port <Int32>] [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-ServerEndpoint <String>] + [-VpcEndpointServiceName <String>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AmazonPostgreSqlCredentialScan. + +## EXAMPLES + +### Example 1: Create Amazon Account PostgreSQL scan object +```powershell +New-AzPurviewAmazonPostgreSqlCredentialScanObject -Kind 'AmazonPostgreSqlCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'sqlauth' -CredentialType 'SqlAuth' -DatabaseName 'db' -Port 5432 -ScanRulesetName 'AmazonPostgreSql' -ScanRulesetType 'System' -ServerEndpoint 'DummyServer' -VpcEndpointServiceName 'com.amazonaws.ypce.wus.123456789' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : sqlauth +CredentialType : SqlAuth +DatabaseName : db +Id : +Kind : AmazonPostgreSqlCredential +LastModifiedAt : +Name : +Port : 5432 +Result : +ScanRulesetName : AmazonPostgreSql +ScanRulesetType : System +ServerEndpoint : DummyServer +VpcEndpointServiceName : com.amazonaws.ypce.wus.123456789 +Worker : +``` + +Create Amazon Account PostgreSQL scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpcEndpointServiceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AmazonPostgreSqlCredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAmazonPostgreSqlDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonPostgreSqlDataSourceObject.md new file mode 100644 index 0000000000..76cea50bc0 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonPostgreSqlDataSourceObject.md @@ -0,0 +1,149 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAmazonPostgreSqlDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonPostgreSqlDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonPostgreSqlDataSourceObject.md +--- + +# New-AzPurviewAmazonPostgreSqlDataSourceObject + +## SYNOPSIS +Create an in-memory object for AmazonPostgreSqlDataSource. + +## SYNTAX + +``` +New-AzPurviewAmazonPostgreSqlDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Port <Int32>] [-ServerEndpoint <String>] [-VpcEndpointServiceName <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AmazonPostgreSqlDataSource. + +## EXAMPLES + +### Example 1: Create Amazon PostgreSQL data source object +```powershell +New-AzPurviewAmazonPostgreSqlDataSourceObject -Kind 'AmazonPostgreSql' -Port 5432 -VpcEndpointServiceName 'com.amazonaws.ypce.wus.123456789' -ServerEndpoint 'DummyServer' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : AmazonPostgreSql +LastModifiedAt : +Name : +Port : 5432 +Scan : +ServerEndpoint : DummyServer +VpcEndpointServiceName : com.amazonaws.ypce.wus.123456789 +``` + +Create Amazon PostgreSQL data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpcEndpointServiceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AmazonPostgreSqlDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAmazonPostgreSqlScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonPostgreSqlScanRulesetObject.md new file mode 100644 index 0000000000..508f4ba796 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonPostgreSqlScanRulesetObject.md @@ -0,0 +1,134 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAmazonPostgreSqlScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonPostgreSqlScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonPostgreSqlScanRulesetObject.md +--- + +# New-AzPurviewAmazonPostgreSqlScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AmazonPostgreSqlScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAmazonPostgreSqlScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AmazonPostgreSqlScanRuleset. + +## EXAMPLES + +### Example 1: Create Amazon PostgreSql custom scanruleset object +```powershell +New-AzPurviewAmazonPostgreSqlScanRulesetObject -Kind 'AmazonPostgreSql' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AmazonPostgreSql +LastModifiedAt : +Name : +Status : +Type : Custom +Version : +``` + +Create Amazon PostgreSql custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AmazonPostgreSqlScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAmazonS3CredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonS3CredentialScanObject.md new file mode 100644 index 0000000000..578d869d4e --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonS3CredentialScanObject.md @@ -0,0 +1,225 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAmazonS3CredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonS3CredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonS3CredentialScanObject.md +--- + +# New-AzPurviewAmazonS3CredentialScanObject + +## SYNOPSIS +Create an in-memory object for AmazonS3CredentialScan. + +## SYNTAX + +``` +New-AzPurviewAmazonS3CredentialScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-CredentialReferenceName <String>] + [-CredentialType <CredentialType>] [-IsMauiScan <Boolean>] [-RoleArn <String>] [-ScanRulesetName <String>] + [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AmazonS3CredentialScan. + +## EXAMPLES + +### Example 1: Create Amazon S3 Credential scan object +```powershell +New-AzPurviewAmazonS3CredentialScanObject -Kind 'AmazonS3Credential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'rolearncred' -CredentialType 'AmazonARN' -ScanRulesetName 'AmazonS3' -ScanRulesetType 'System' -IsMauiScan $false +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : rolearncred +CredentialType : AmazonARN +Id : +IsMauiScan : False +Kind : AmazonS3Credential +LastModifiedAt : +Name : +Result : +RoleArn : +ScanRulesetName : AmazonS3 +ScanRulesetType : System +Worker : +``` + +Create Amazon S3 Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsMauiScan + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleArn + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AmazonS3CredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAmazonS3DataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonS3DataSourceObject.md new file mode 100644 index 0000000000..65cf01cfaf --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonS3DataSourceObject.md @@ -0,0 +1,134 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAmazonS3DataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonS3DataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonS3DataSourceObject.md +--- + +# New-AzPurviewAmazonS3DataSourceObject + +## SYNOPSIS +Create an in-memory object for AmazonS3DataSource. + +## SYNTAX + +``` +New-AzPurviewAmazonS3DataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-RoleArn <String>] [-ServiceUrl <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AmazonS3DataSource. + +## EXAMPLES + +### Example 1: Create AmazonS3 data source object +```powershell +New-AzPurviewAmazonS3DataSourceObject -Kind 'AmazonS3' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ServiceUrl s3://multicloud-e2e-2 +New-AzPurviewDataSource -Endpoint 'https://parv-brs-2.purview.azure.com/' -Name 'DS4' -Body $obj +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : AmazonS3 +LastModifiedAt : +Name : +RoleArn : +Scan : +ServiceUrl : s3://multicloud-e2e-2 +``` + +Create AmazonS3 data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleArn + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceUrl + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AmazonS3DataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAmazonS3ScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonS3ScanRulesetObject.md new file mode 100644 index 0000000000..7f90b094fa --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonS3ScanRulesetObject.md @@ -0,0 +1,178 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAmazonS3ScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonS3ScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonS3ScanRulesetObject.md +--- + +# New-AzPurviewAmazonS3ScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AmazonS3ScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAmazonS3ScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-ScanningRuleCustomFileExtension <ICustomFileExtension[]>] + [-ScanningRuleFileExtension <FileExtensionsType[]>] [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AmazonS3ScanRuleset. + +## EXAMPLES + +### Example 1: Create AmazonS3 custom scanruleset object +```powershell +New-AzPurviewAmazonS3ScanRulesetObject -Kind 'AmazonS3' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -ScanningRuleFileExtension @("CSV","JSON","PSV","SSV","TSV","TXT","XML","PARQUET","AVRO","ORC","Documents","GZ","DOC","DOCM","DOCX","DOT","ODP","ODS","ODT","PDF","POT","PPS","PPSX","PPT","PPTM","PPTX","XLC","XLS","XLSB","XLSM","XLSX","XLT") -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AmazonS3 +LastModifiedAt : +Name : +ScanningRuleCustomFileExtension : +ScanningRuleFileExtension : {CSV, JSON, PSV, SSV…} +Status : +Type : Custom +Version : +``` + +Create AmazonS3 custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanningRuleCustomFileExtension +To construct, see NOTES section for SCANNINGRULECUSTOMFILEEXTENSION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.ICustomFileExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanningRuleFileExtension + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.FileExtensionsType[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AmazonS3ScanRuleset + +## 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. + + +SCANNINGRULECUSTOMFILEEXTENSION <ICustomFileExtension[]>: + - `[CustomFileTypeBuiltInType <FileExtensionsType?>]`: + - `[CustomFileTypeCustomDelimiter <String>]`: + - `[Description <String>]`: + - `[Enabled <Boolean?>]`: + - `[FileExtension <String>]`: + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAmazonSqlCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonSqlCredentialScanObject.md new file mode 100644 index 0000000000..a1b7df399a --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonSqlCredentialScanObject.md @@ -0,0 +1,256 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAmazonSqlCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonSqlCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonSqlCredentialScanObject.md +--- + +# New-AzPurviewAmazonSqlCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AmazonSqlCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAmazonSqlCredentialScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-CredentialReferenceName <String>] + [-CredentialType <CredentialType>] [-DatabaseName <String>] [-Port <Int32>] [-ScanRulesetName <String>] + [-ScanRulesetType <ScanRulesetType>] [-ServerEndpoint <String>] [-VpcEndpointServiceName <String>] + [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AmazonSqlCredentialScan. + +## EXAMPLES + +### Example 1: Create Amazon Sql Credential scan object +```powershell +New-AzPurviewAmazonSqlCredentialScanObject -Kind 'AmazonSqlCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'sqlauth' -CredentialType 'SqlAuth' -DatabaseName 'db' -Port 5432 -ScanRulesetName 'AmazonSql' -ScanRulesetType 'System' -ServerEndpoint 'DummyServer' -VpcEndpointServiceName 'com.amazonaws.ypce.wus.123456789' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : sqlauth +CredentialType : SqlAuth +DatabaseName : db +Id : +Kind : AmazonSqlCredential +LastModifiedAt : +Name : +Port : 5432 +Result : +ScanRulesetName : AmazonSql +ScanRulesetType : System +ServerEndpoint : DummyServer +VpcEndpointServiceName : com.amazonaws.ypce.wus.123456789 +Worker : +``` + +Create Amazon Sql Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpcEndpointServiceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AmazonSqlCredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAmazonSqlDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonSqlDataSourceObject.md new file mode 100644 index 0000000000..8cf924b6c8 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonSqlDataSourceObject.md @@ -0,0 +1,149 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAmazonSqlDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonSqlDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonSqlDataSourceObject.md +--- + +# New-AzPurviewAmazonSqlDataSourceObject + +## SYNOPSIS +Create an in-memory object for AmazonSqlDataSource. + +## SYNTAX + +``` +New-AzPurviewAmazonSqlDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Port <Int32>] [-ServerEndpoint <String>] [-VpcEndpointServiceName <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AmazonSqlDataSource. + +## EXAMPLES + +### Example 1: Create Amazon SQL data source object +```powershell +New-AzPurviewAmazonSqlDataSourceObject -Kind 'AmazonSql' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -Port 1433 -ServerEndpoint DummyEdnpoint -VpcEndpointServiceName com.amazonaws.ypce.wus.123456789 +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : AmazonSql +LastModifiedAt : +Name : +Port : 1433 +Scan : +ServerEndpoint : DummyEdnpoint +VpcEndpointServiceName : com.amazonaws.ypce.wus.123456789 +``` + +Create Amazon SQL data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VpcEndpointServiceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AmazonSqlDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAmazonSqlScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonSqlScanRulesetObject.md new file mode 100644 index 0000000000..6aad2fc66a --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAmazonSqlScanRulesetObject.md @@ -0,0 +1,134 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAmazonSqlScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonSqlScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAmazonSqlScanRulesetObject.md +--- + +# New-AzPurviewAmazonSqlScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AmazonSqlScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAmazonSqlScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AmazonSqlScanRuleset. + +## EXAMPLES + +### Example 1: Create Amazon Sql custom scanruleset object +```powershell +New-AzPurviewAmazonSqlScanRulesetObject -Kind 'AmazonSql' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AmazonSql +LastModifiedAt : +Name : +Status : +Type : Custom +Version : +``` + +Create Amazon Sql custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AmazonSqlScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureCosmosDbCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureCosmosDbCredentialScanObject.md new file mode 100644 index 0000000000..79275ccd35 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureCosmosDbCredentialScanObject.md @@ -0,0 +1,210 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureCosmosDbCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureCosmosDbCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureCosmosDbCredentialScanObject.md +--- + +# New-AzPurviewAzureCosmosDbCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AzureCosmosDbCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAzureCosmosDbCredentialScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] [-DatabaseName <String>] + [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureCosmosDbCredentialScan. + +## EXAMPLES + +### Example 1: Create Azure CosmosDb Credential scan object +```powershell +New-AzPurviewAzureCosmosDbCredentialScanObject -Kind 'AzureCosmosDbCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'datascantestdataparv-accountkey' -CredentialType 'AccountKey' -ScanRulesetName 'AzureCosmosDb' -ScanRulesetType 'System' -DatabaseName 'db' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : datascantestdataparv-accountkey +CredentialType : AccountKey +DatabaseName : db +Id : +Kind : AzureCosmosDbCredential +LastModifiedAt : +Name : +Result : +ScanRulesetName : AzureCosmosDb +ScanRulesetType : System +Worker : +``` + +Create Azure CosmosDb Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureCosmosDbCredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureCosmosDbDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureCosmosDbDataSourceObject.md new file mode 100644 index 0000000000..e1da021024 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureCosmosDbDataSourceObject.md @@ -0,0 +1,179 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureCosmosDbDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureCosmosDbDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureCosmosDbDataSourceObject.md +--- + +# New-AzPurviewAzureCosmosDbDataSourceObject + +## SYNOPSIS +Create an in-memory object for AzureCosmosDbDataSource. + +## SYNTAX + +``` +New-AzPurviewAzureCosmosDbDataSourceObject -Kind <DataSourceType> [-AccountUri <String>] + [-CollectionReferenceName <String>] [-CollectionType <String>] [-Location <String>] [-ResourceGroup <String>] + [-ResourceName <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureCosmosDbDataSource. + +## EXAMPLES + +### Example 1: Create Azure CosmosDB data source object +```powershell +New-AzPurviewAzureCosmosDbDataSourceObject -Kind 'AzureCosmosDb' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -AccountUri 'https://cosmosd.documents.azure.com' +``` + +```output +AccountUri : https://cosmosd.documents.azure.com +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : AzureCosmosDb +LastModifiedAt : +Location : +Name : +ResourceGroup : +ResourceName : +Scan : +SubscriptionId : +``` + +Create Azure CosmosDB data source object + +## PARAMETERS + +### -AccountUri + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureCosmosDbDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureCosmosDbScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureCosmosDbScanRulesetObject.md new file mode 100644 index 0000000000..948df92efc --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureCosmosDbScanRulesetObject.md @@ -0,0 +1,134 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureCosmosDbScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureCosmosDbScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureCosmosDbScanRulesetObject.md +--- + +# New-AzPurviewAzureCosmosDbScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AzureCosmosDbScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAzureCosmosDbScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureCosmosDbScanRuleset. + +## EXAMPLES + +### Example 1: Create CosmosDB custom scanruleset object +```powershell +New-AzPurviewAzureCosmosDbScanRulesetObject -Kind 'AzureCosmosDb' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AzureCosmosDb +LastModifiedAt : +Name : +Status : +Type : Custom +Version : +``` + +Create CosmosDB custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureCosmosDbScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureDataExplorerCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureDataExplorerCredentialScanObject.md new file mode 100644 index 0000000000..71658b4253 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureDataExplorerCredentialScanObject.md @@ -0,0 +1,210 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureDataExplorerCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureDataExplorerCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureDataExplorerCredentialScanObject.md +--- + +# New-AzPurviewAzureDataExplorerCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AzureDataExplorerCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAzureDataExplorerCredentialScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] [-Database <String>] + [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureDataExplorerCredentialScan. + +## EXAMPLES + +### Example 1: Create Azure Data Explorer Credential scan object +```powershell +New-AzPurviewAzureDataExplorerCredentialScanObject -Kind 'AzureDataExplorerCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'svcp' -CredentialType 'ServicePrincipal' -ScanRulesetName 'AzureDataExplorer' -ScanRulesetType 'System' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : svcp +CredentialType : ServicePrincipal +Database : +Id : +Kind : AzureDataExplorerCredential +LastModifiedAt : +Name : +Result : +ScanRulesetName : AzureDataExplorer +ScanRulesetType : System +Worker : +``` + +Create Azure Data Explorer Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureDataExplorerCredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureDataExplorerDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureDataExplorerDataSourceObject.md new file mode 100644 index 0000000000..ce018a5a26 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureDataExplorerDataSourceObject.md @@ -0,0 +1,179 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureDataExplorerDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureDataExplorerDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureDataExplorerDataSourceObject.md +--- + +# New-AzPurviewAzureDataExplorerDataSourceObject + +## SYNOPSIS +Create an in-memory object for AzureDataExplorerDataSource. + +## SYNTAX + +``` +New-AzPurviewAzureDataExplorerDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Endpoint <String>] [-Location <String>] [-ResourceGroup <String>] + [-ResourceName <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureDataExplorerDataSource. + +## EXAMPLES + +### Example 1: Create Azure Data Explorer data source object +```powershell +New-AzPurviewAzureDataExplorerDataSourceObject -Kind 'AzureDataExplorer' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -Endpoint 'https://adxd.australiaeast.kusto.windows.net' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Endpoint : https://adxd.australiaeast.kusto.windows.net +Id : +Kind : AzureDataExplorer +LastModifiedAt : +Location : +Name : +ResourceGroup : +ResourceName : +Scan : +SubscriptionId : +``` + +Create Azure Data Explorer data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureDataExplorerDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureDataExplorerMsiScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureDataExplorerMsiScanObject.md new file mode 100644 index 0000000000..d64bbaec5a --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureDataExplorerMsiScanObject.md @@ -0,0 +1,179 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureDataExplorerMsiScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureDataExplorerMsiScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureDataExplorerMsiScanObject.md +--- + +# New-AzPurviewAzureDataExplorerMsiScanObject + +## SYNOPSIS +Create an in-memory object for AzureDataExplorerMsiScan. + +## SYNTAX + +``` +New-AzPurviewAzureDataExplorerMsiScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-Database <String>] + [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureDataExplorerMsiScan. + +## EXAMPLES + +### Example 1: Create Azure Data Explorer Msi scan object +```powershell +New-AzPurviewAzureDataExplorerMsiScanObject -Kind 'AzureDataExplorerMsi' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ScanRulesetName 'AzureDataExplorer' -ScanRulesetType 'System' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +Database : +Id : +Kind : AzureDataExplorerMsi +LastModifiedAt : +Name : +Result : +ScanRulesetName : AzureDataExplorer +ScanRulesetType : System +Worker : +``` + +Create Azure Data Explorer Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureDataExplorerMsiScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureDataExplorerScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureDataExplorerScanRulesetObject.md new file mode 100644 index 0000000000..04224e3e8b --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureDataExplorerScanRulesetObject.md @@ -0,0 +1,134 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureDataExplorerScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureDataExplorerScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureDataExplorerScanRulesetObject.md +--- + +# New-AzPurviewAzureDataExplorerScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AzureDataExplorerScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAzureDataExplorerScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureDataExplorerScanRuleset. + +## EXAMPLES + +### Example 1: Create Azure Data Explorer custom scanruleset object +```powershell +New-AzPurviewAzureDataExplorerScanRulesetObject -Kind 'AzureDataExplorer' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AzureDataExplorer +LastModifiedAt : +Name : +Status : +Type : Custom +Version : +``` + +Create Azure Data Explorer custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureDataExplorerScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureFileServiceCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureFileServiceCredentialScanObject.md new file mode 100644 index 0000000000..d27e091ef8 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureFileServiceCredentialScanObject.md @@ -0,0 +1,210 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureFileServiceCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureFileServiceCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureFileServiceCredentialScanObject.md +--- + +# New-AzPurviewAzureFileServiceCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AzureFileServiceCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAzureFileServiceCredentialScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] [-ScanRulesetName <String>] + [-ScanRulesetType <ScanRulesetType>] [-ShareName <String>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureFileServiceCredentialScan. + +## EXAMPLES + +### Example 1: Create Azure File Service Credential scan object +```powershell +New-AzPurviewAzureFileServiceCredentialScanObject -Kind 'AzureFileServiceCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'datascantestdataparv-accountkey' -CredentialType 'AccountKey' -ScanRulesetName 'AzureFileService' -ScanRulesetType 'System' -ShareName 'share' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : datascantestdataparv-accountkey +CredentialType : AccountKey +Id : +Kind : AzureFileServiceCredential +LastModifiedAt : +Name : +Result : +ScanRulesetName : AzureFileService +ScanRulesetType : System +ShareName : share +Worker : +``` + +Create Azure File Service Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureFileServiceCredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureFileServiceDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureFileServiceDataSourceObject.md new file mode 100644 index 0000000000..a7c65a3bac --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureFileServiceDataSourceObject.md @@ -0,0 +1,179 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureFileServiceDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureFileServiceDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureFileServiceDataSourceObject.md +--- + +# New-AzPurviewAzureFileServiceDataSourceObject + +## SYNOPSIS +Create an in-memory object for AzureFileServiceDataSource. + +## SYNTAX + +``` +New-AzPurviewAzureFileServiceDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Endpoint <String>] [-Location <String>] [-ResourceGroup <String>] + [-ResourceName <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureFileServiceDataSource. + +## EXAMPLES + +### Example 1: Create Azure File Service data source object +```powershell +New-AzPurviewAzureFileServiceDataSourceObject -Kind 'AzureFileService' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -Endpoint 'https://0cb22.file.core.windows.net/' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Endpoint : https://0cb22.file.core.windows.net/ +Id : +Kind : AzureFileService +LastModifiedAt : +Location : +Name : +ResourceGroup : +ResourceName : +Scan : +SubscriptionId : +``` + +Create Azure File Service data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureFileServiceDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureFileServiceScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureFileServiceScanRulesetObject.md new file mode 100644 index 0000000000..0a9568ba7b --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureFileServiceScanRulesetObject.md @@ -0,0 +1,178 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureFileServiceScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureFileServiceScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureFileServiceScanRulesetObject.md +--- + +# New-AzPurviewAzureFileServiceScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AzureFileServiceScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAzureFileServiceScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-ScanningRuleCustomFileExtension <ICustomFileExtension[]>] + [-ScanningRuleFileExtension <FileExtensionsType[]>] [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureFileServiceScanRuleset. + +## EXAMPLES + +### Example 1: Create Azure File Service custom scanruleset object +```powershell +New-AzPurviewAzureFileServiceScanRulesetObject -Kind 'AzureFileService' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -ScanningRuleFileExtension @("CSV","JSON","PSV","SSV","TSV","TXT","XML","PARQUET","AVRO","ORC","Documents","GZ","DOC","DOCM","DOCX","DOT","ODP","ODS","ODT","PDF","POT","PPS","PPSX","PPT","PPTM","PPTX","XLC","XLS","XLSB","XLSM","XLSX","XLT") -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AzureFileService +LastModifiedAt : +Name : +ScanningRuleCustomFileExtension : +ScanningRuleFileExtension : {CSV, JSON, PSV, SSV…} +Status : +Type : Custom +Version : +``` + +Create Azure File Service custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanningRuleCustomFileExtension +To construct, see NOTES section for SCANNINGRULECUSTOMFILEEXTENSION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.ICustomFileExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanningRuleFileExtension + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.FileExtensionsType[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureFileServiceScanRuleset + +## 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. + + +SCANNINGRULECUSTOMFILEEXTENSION <ICustomFileExtension[]>: + - `[CustomFileTypeBuiltInType <FileExtensionsType?>]`: + - `[CustomFileTypeCustomDelimiter <String>]`: + - `[Description <String>]`: + - `[Enabled <Boolean?>]`: + - `[FileExtension <String>]`: + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureKeyVaultObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureKeyVaultObject.md new file mode 100644 index 0000000000..a225bf4d66 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureKeyVaultObject.md @@ -0,0 +1,83 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureKeyVaultObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureKeyVaultObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureKeyVaultObject.md +--- + +# New-AzPurviewAzureKeyVaultObject + +## SYNOPSIS +Create an in-memory object for AzureKeyVault. + +## SYNTAX + +``` +New-AzPurviewAzureKeyVaultObject [-BaseUrl <String>] [-Description <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureKeyVault. + +## EXAMPLES + +### Example 1: Create a key vault connection object +```powershell +New-AzPurviewAzureKeyVaultObject -BaseUrl 'https://datascankv.vault.azure.net/' -Description 'This is a key vault' +``` + +```output +BaseUrl : https://datascankv.vault.azure.net/ +Description : This is a key vault +Id : +Name : +``` + +Create a key vault connection object. + +## PARAMETERS + +### -BaseUrl + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureKeyVault + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureMySqlCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureMySqlCredentialScanObject.md new file mode 100644 index 0000000000..d90a653479 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureMySqlCredentialScanObject.md @@ -0,0 +1,240 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureMySqlCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureMySqlCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureMySqlCredentialScanObject.md +--- + +# New-AzPurviewAzureMySqlCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AzureMySqlCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAzureMySqlCredentialScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-CredentialReferenceName <String>] + [-CredentialType <CredentialType>] [-DatabaseName <String>] [-Port <Int32>] [-ScanRulesetName <String>] + [-ScanRulesetType <ScanRulesetType>] [-ServerEndpoint <String>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureMySqlCredentialScan. + +## EXAMPLES + +### Example 1: Create Azure MySql Credential scan object +```powershell +New-AzPurviewAzureMySqlCredentialScanObject -Kind 'AzureMySqlCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'sqlauth' -CredentialType 'SqlAuth' -DatabaseName 'db' -Port 5432 -ScanRulesetName 'AzureMySql' -ScanRulesetType 'System' -ServerEndpoint 'tzn.mysql.database.azure.com' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : sqlauth +CredentialType : SqlAuth +DatabaseName : db +Id : +Kind : AzureMySqlCredential +LastModifiedAt : +Name : +Port : 5432 +Result : +ScanRulesetName : AzureMySql +ScanRulesetType : System +ServerEndpoint : tzn.mysql.database.azure.com +Worker : +``` + +Create Azure MySql Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureMySqlCredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureMySqlDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureMySqlDataSourceObject.md new file mode 100644 index 0000000000..43176bd85d --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureMySqlDataSourceObject.md @@ -0,0 +1,194 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureMySqlDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureMySqlDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureMySqlDataSourceObject.md +--- + +# New-AzPurviewAzureMySqlDataSourceObject + +## SYNOPSIS +Create an in-memory object for AzureMySqlDataSource. + +## SYNTAX + +``` +New-AzPurviewAzureMySqlDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Location <String>] [-Port <Int32>] [-ResourceGroup <String>] + [-ResourceName <String>] [-ServerEndpoint <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureMySqlDataSource. + +## EXAMPLES + +### Example 1: Create Azure MySQL data source object +```powershell +New-AzPurviewAzureMySqlDataSourceObject -Kind 'AzureMySql' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -Port 3306 -ServerEndpoint 'nause.mysql.database.azure.com' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : AzureMySql +LastModifiedAt : +Location : +Name : +Port : 3306 +ResourceGroup : +ResourceName : +Scan : +ServerEndpoint : nause.mysql.database.azure.com +SubscriptionId : +``` + +Create Azure MySQL data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureMySqlDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureMySqlScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureMySqlScanRulesetObject.md new file mode 100644 index 0000000000..66202f8ebe --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureMySqlScanRulesetObject.md @@ -0,0 +1,134 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureMySqlScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureMySqlScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureMySqlScanRulesetObject.md +--- + +# New-AzPurviewAzureMySqlScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AzureMySqlScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAzureMySqlScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureMySqlScanRuleset. + +## EXAMPLES + +### Example 1: Create Azure MySQL custom scanruleset object +```powershell +New-AzPurviewAzureMySqlScanRulesetObject -Kind 'AzureMySql' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AzureMySql +LastModifiedAt : +Name : +Status : +Type : Custom +Version : +``` + +Create Azure MySQL custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureMySqlScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzurePostgreSqlCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzurePostgreSqlCredentialScanObject.md new file mode 100644 index 0000000000..008a4db567 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzurePostgreSqlCredentialScanObject.md @@ -0,0 +1,256 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzurePostgreSqlCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzurePostgreSqlCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzurePostgreSqlCredentialScanObject.md +--- + +# New-AzPurviewAzurePostgreSqlCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AzurePostgreSqlCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAzurePostgreSqlCredentialScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] [-DatabaseName <String>] + [-Port <Int32>] [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-ServerEndpoint <String>] + [-SslMode <Int32>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzurePostgreSqlCredentialScan. + +## EXAMPLES + +### Example 1: Create Azure PostgreSql Credential scan object +```powershell +New-AzPurviewAzurePostgreSqlCredentialScanObject -Kind 'AzurePostgreSqlCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'sqlauth' -CredentialType 'SqlAuth' -DatabaseName 'db' -Port 5432 -SslMode 1 -ScanRulesetName 'AzurePostgreSql' -ScanRulesetType 'System' -ServerEndpoint 'anstzn.postgres.database.azure.com' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : sqlauth +CredentialType : SqlAuth +DatabaseName : db +Id : +Kind : AzurePostgreSqlCredential +LastModifiedAt : +Name : +Port : 5432 +Result : +ScanRulesetName : AzurePostgreSql +ScanRulesetType : System +ServerEndpoint : anstzn.postgres.database.azure.com +SslMode : 1 +Worker : +``` + +Create Azure PostgreSql Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslMode + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzurePostgreSqlCredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzurePostgreSqlDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzurePostgreSqlDataSourceObject.md new file mode 100644 index 0000000000..ca51669380 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzurePostgreSqlDataSourceObject.md @@ -0,0 +1,194 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzurePostgreSqlDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzurePostgreSqlDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzurePostgreSqlDataSourceObject.md +--- + +# New-AzPurviewAzurePostgreSqlDataSourceObject + +## SYNOPSIS +Create an in-memory object for AzurePostgreSqlDataSource. + +## SYNTAX + +``` +New-AzPurviewAzurePostgreSqlDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Location <String>] [-Port <Int32>] [-ResourceGroup <String>] + [-ResourceName <String>] [-ServerEndpoint <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzurePostgreSqlDataSource. + +## EXAMPLES + +### Example 1: Create Azure PostgreSQL data source object +```powershell +New-AzPurviewAzurePostgreSqlDataSourceObject -Kind 'AzurePostgreSql' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -Port 5432 -ServerEndpoint 'nause.postgres.database.azure.com' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : AzurePostgreSql +LastModifiedAt : +Location : +Name : +Port : 5432 +ResourceGroup : +ResourceName : +Scan : +ServerEndpoint : nause.postgres.database.azure.com +SubscriptionId : +``` + +Create Azure PostgreSQL data source object0 + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzurePostgreSqlDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzurePostgreSqlScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzurePostgreSqlScanRulesetObject.md new file mode 100644 index 0000000000..42ddcba8af --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzurePostgreSqlScanRulesetObject.md @@ -0,0 +1,134 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzurePostgreSqlScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzurePostgreSqlScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzurePostgreSqlScanRulesetObject.md +--- + +# New-AzPurviewAzurePostgreSqlScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AzurePostgreSqlScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAzurePostgreSqlScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzurePostgreSqlScanRuleset. + +## EXAMPLES + +### Example 1: Create Azure PostgreSQL custom scanruleset object +```powershell +New-AzPurviewAzurePostgreSqlScanRulesetObject -Kind 'AzurePostgreSql' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AzurePostgreSql +LastModifiedAt : +Name : +Status : +Type : Custom +Version : +``` + +Create Azure PostgreSQL custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzurePostgreSqlScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureResourceGroupCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureResourceGroupCredentialScanObject.md new file mode 100644 index 0000000000..cbd088bc65 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureResourceGroupCredentialScanObject.md @@ -0,0 +1,404 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureResourceGroupCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureResourceGroupCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureResourceGroupCredentialScanObject.md +--- + +# New-AzPurviewAzureResourceGroupCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AzureResourceGroupCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAzureResourceGroupCredentialScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] + [-ResourceType <IExpandingResourceScanPropertiesResourceTypes>] [-ScanRulesetName <String>] + [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureResourceGroupCredentialScan. + +## EXAMPLES + +### Example 1: Create Azure resource group Credential scan object +```powershell +New-AzPurviewAzureResourceGroupCredentialScanObject -Kind 'AzureResourceGroupCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialType 'ServicePrincipal' -CredentialReferenceName 'svcp' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : svcp +CredentialType : ServicePrincipal +Id : +Kind : AzureResourceGroupCredential +LastModifiedAt : +Name : ScanTest +ResourceType : { + } +Result : +ScanRulesetName : +ScanRulesetType : +Worker : +``` + +Create Azure resource group Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +To construct, see NOTES section for RESOURCETYPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IExpandingResourceScanPropertiesResourceTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureResourceGroupCredentialScan + +## 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. + + +RESOURCETYPE `<IExpandingResourceScanPropertiesResourceTypes>`: + - `[AdlGen1ScanRulesetName <String>]`: + - `[AdlGen1ScanRulesetType <ScanRulesetType?>]`: + - `[AdlGen2ScanRulesetName <String>]`: + - `[AdlGen2ScanRulesetType <ScanRulesetType?>]`: + - `[AdlsGen1CredentialReferenceName <String>]`: + - `[AdlsGen1CredentialType <CredentialType?>]`: + - `[AdlsGen1ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterResource <String[]>]`: + - `[AdlsGen2CredentialReferenceName <String>]`: + - `[AdlsGen2CredentialType <CredentialType?>]`: + - `[AdlsGen2ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterResource <String[]>]`: + - `[AmazonAccountCredentialReferenceName <String>]`: + - `[AmazonAccountCredentialType <CredentialType?>]`: + - `[AmazonAccountResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterResource <String[]>]`: + - `[AmazonAccountScanRulesetName <String>]`: + - `[AmazonAccountScanRulesetType <ScanRulesetType?>]`: + - `[AmazonPostgreSqlCredentialReferenceName <String>]`: + - `[AmazonPostgreSqlCredentialType <CredentialType?>]`: + - `[AmazonPostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterResource <String[]>]`: + - `[AmazonPostgreSqlScanRulesetName <String>]`: + - `[AmazonPostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AmazonS3CredentialReferenceName <String>]`: + - `[AmazonS3CredentialType <CredentialType?>]`: + - `[AmazonS3ResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterResource <String[]>]`: + - `[AmazonS3ScanRulesetName <String>]`: + - `[AmazonS3ScanRulesetType <ScanRulesetType?>]`: + - `[AmazonSqlCredentialReferenceName <String>]`: + - `[AmazonSqlCredentialType <CredentialType?>]`: + - `[AmazonSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterResource <String[]>]`: + - `[AmazonSqlScanRulesetName <String>]`: + - `[AmazonSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmoDbScanRulesetName <String>]`: + - `[AzureCosmoDbScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmosDbCredentialReferenceName <String>]`: + - `[AzureCosmosDbCredentialType <CredentialType?>]`: + - `[AzureCosmosDbResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerCredentialReferenceName <String>]`: + - `[AzureDataExplorerCredentialType <CredentialType?>]`: + - `[AzureDataExplorerResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerScanRulesetName <String>]`: + - `[AzureDataExplorerScanRulesetType <ScanRulesetType?>]`: + - `[AzureFileServiceCredentialReferenceName <String>]`: + - `[AzureFileServiceCredentialType <CredentialType?>]`: + - `[AzureFileServiceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterResource <String[]>]`: + - `[AzureFileServiceScanRulesetName <String>]`: + - `[AzureFileServiceScanRulesetType <ScanRulesetType?>]`: + - `[AzureMySqlCredentialReferenceName <String>]`: + - `[AzureMySqlCredentialType <CredentialType?>]`: + - `[AzureMySqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterResource <String[]>]`: + - `[AzureMySqlScanRulesetName <String>]`: + - `[AzureMySqlScanRulesetType <ScanRulesetType?>]`: + - `[AzurePostgreSqlCredentialReferenceName <String>]`: + - `[AzurePostgreSqlCredentialType <CredentialType?>]`: + - `[AzurePostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterResource <String[]>]`: + - `[AzurePostgreSqlScanRulesetName <String>]`: + - `[AzurePostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureResourceGroupCredentialReferenceName <String>]`: + - `[AzureResourceGroupCredentialType <CredentialType?>]`: + - `[AzureResourceGroupResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterResource <String[]>]`: + - `[AzureResourceGroupScanRulesetName <String>]`: + - `[AzureResourceGroupScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDataWarehouseCredentialReferenceName <String>]`: + - `[AzureSqlDataWarehouseCredentialType <CredentialType?>]`: + - `[AzureSqlDataWarehouseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDataWarehouseScanRulesetName <String>]`: + - `[AzureSqlDataWarehouseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetName <String>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseScanRulesetName <String>]`: + - `[AzureSqlDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[AzureStorageCredentialReferenceName <String>]`: + - `[AzureStorageCredentialType <CredentialType?>]`: + - `[AzureStorageResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterResource <String[]>]`: + - `[AzureStorageScanRulesetName <String>]`: + - `[AzureStorageScanRulesetType <ScanRulesetType?>]`: + - `[AzureSubscriptionCredentialReferenceName <String>]`: + - `[AzureSubscriptionCredentialType <CredentialType?>]`: + - `[AzureSubscriptionResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterResource <String[]>]`: + - `[AzureSubscriptionScanRulesetName <String>]`: + - `[AzureSubscriptionScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseCredentialReferenceName <String>]`: + - `[AzureSynapseCredentialType <CredentialType?>]`: + - `[AzureSynapseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterResource <String[]>]`: + - `[AzureSynapseScanRulesetName <String>]`: + - `[AzureSynapseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseWorkspaceCredentialReferenceName <String>]`: + - `[AzureSynapseWorkspaceCredentialType <CredentialType?>]`: + - `[AzureSynapseWorkspaceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterResource <String[]>]`: + - `[AzureSynapseWorkspaceScanRulesetName <String>]`: + - `[AzureSynapseWorkspaceScanRulesetType <ScanRulesetType?>]`: + - `[NoneCredentialReferenceName <String>]`: + - `[NoneCredentialType <CredentialType?>]`: + - `[NoneResourceNameFilterExcludePrefix <String[]>]`: + - `[NoneResourceNameFilterIncludePrefix <String[]>]`: + - `[NoneResourceNameFilterResource <String[]>]`: + - `[NoneScanRulesetName <String>]`: + - `[NoneScanRulesetType <ScanRulesetType?>]`: + - `[OracleCredentialReferenceName <String>]`: + - `[OracleCredentialType <CredentialType?>]`: + - `[OracleResourceNameFilterExcludePrefix <String[]>]`: + - `[OracleResourceNameFilterIncludePrefix <String[]>]`: + - `[OracleResourceNameFilterResource <String[]>]`: + - `[OracleScanRulesetName <String>]`: + - `[OracleScanRulesetType <ScanRulesetType?>]`: + - `[PowerBiCredentialReferenceName <String>]`: + - `[PowerBiCredentialType <CredentialType?>]`: + - `[PowerBiResourceNameFilterExcludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterIncludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterResource <String[]>]`: + - `[PowerBiScanRulesetName <String>]`: + - `[PowerBiScanRulesetType <ScanRulesetType?>]`: + - `[SapEccCredentialReferenceName <String>]`: + - `[SapEccCredentialType <CredentialType?>]`: + - `[SapEccResourceNameFilterExcludePrefix <String[]>]`: + - `[SapEccResourceNameFilterIncludePrefix <String[]>]`: + - `[SapEccResourceNameFilterResource <String[]>]`: + - `[SapEccScanRulesetName <String>]`: + - `[SapEccScanRulesetType <ScanRulesetType?>]`: + - `[SapS4HanaCredentialReferenceName <String>]`: + - `[SapS4HanaCredentialType <CredentialType?>]`: + - `[SapS4HanaResourceNameFilterExcludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterIncludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterResource <String[]>]`: + - `[SapS4HanaScanRulesetName <String>]`: + - `[SapS4HanaScanRulesetType <ScanRulesetType?>]`: + - `[SqlServerDatabaseCredentialReferenceName <String>]`: + - `[SqlServerDatabaseCredentialType <CredentialType?>]`: + - `[SqlServerDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterResource <String[]>]`: + - `[SqlServerDatabaseScanRulesetName <String>]`: + - `[SqlServerDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[TeradataCredentialReferenceName <String>]`: + - `[TeradataCredentialType <CredentialType?>]`: + - `[TeradataResourceNameFilterExcludePrefix <String[]>]`: + - `[TeradataResourceNameFilterIncludePrefix <String[]>]`: + - `[TeradataResourceNameFilterResource <String[]>]`: + - `[TeradataScanRulesetName <String>]`: + - `[TeradataScanRulesetType <ScanRulesetType?>]`: + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureResourceGroupDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureResourceGroupDataSourceObject.md new file mode 100644 index 0000000000..dd206a0ec3 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureResourceGroupDataSourceObject.md @@ -0,0 +1,133 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureResourceGroupDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureResourceGroupDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureResourceGroupDataSourceObject.md +--- + +# New-AzPurviewAzureResourceGroupDataSourceObject + +## SYNOPSIS +Create an in-memory object for AzureResourceGroupDataSource. + +## SYNTAX + +``` +New-AzPurviewAzureResourceGroupDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ResourceGroup <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureResourceGroupDataSource. + +## EXAMPLES + +### Example 1: Create Azure resource group data source object +```powershell +New-AzPurviewAzureResourceGroupDataSourceObject -Kind 'AzureResourceGroup' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ResourceGroup 'rg' -SubscriptionId '6810b9ce-82d3-4562-9658-xxxxxxxxxx' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : AzureResourceGroup +LastModifiedAt : +Name : +ResourceGroup : rg +Scan : +SubscriptionId : 6810b9ce-82d3-4562-9658-xxxxxxxxxx +``` + +Create Azure resource group data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureResourceGroupDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureResourceGroupMsiScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureResourceGroupMsiScanObject.md new file mode 100644 index 0000000000..a2179f2779 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureResourceGroupMsiScanObject.md @@ -0,0 +1,403 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureResourceGroupMsiScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureResourceGroupMsiScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureResourceGroupMsiScanObject.md +--- + +# New-AzPurviewAzureResourceGroupMsiScanObject + +## SYNOPSIS +Create an in-memory object for AzureResourceGroupMsiScan. + +## SYNTAX + +``` +New-AzPurviewAzureResourceGroupMsiScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-CredentialReferenceName <String>] + [-CredentialType <CredentialType>] [-ResourceType <IExpandingResourceScanPropertiesResourceTypes>] + [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureResourceGroupMsiScan. + +## EXAMPLES + +### Example 1: Create Azure resource group Msi scan object +```powershell +New-AzPurviewAzureResourceGroupMsiScanObject -Kind 'AzureResourceGroupMsi' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : +CredentialType : +Id : +Kind : AzureResourceGroupMsi +LastModifiedAt : +Name : +ResourceType : { + } +Result : +ScanRulesetName : +ScanRulesetType : +Worker : +``` + +Create Azure resource group Msi scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +To construct, see NOTES section for RESOURCETYPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IExpandingResourceScanPropertiesResourceTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureResourceGroupMsiScan + +## 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. + + +RESOURCETYPE `<IExpandingResourceScanPropertiesResourceTypes>`: + - `[AdlGen1ScanRulesetName <String>]`: + - `[AdlGen1ScanRulesetType <ScanRulesetType?>]`: + - `[AdlGen2ScanRulesetName <String>]`: + - `[AdlGen2ScanRulesetType <ScanRulesetType?>]`: + - `[AdlsGen1CredentialReferenceName <String>]`: + - `[AdlsGen1CredentialType <CredentialType?>]`: + - `[AdlsGen1ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterResource <String[]>]`: + - `[AdlsGen2CredentialReferenceName <String>]`: + - `[AdlsGen2CredentialType <CredentialType?>]`: + - `[AdlsGen2ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterResource <String[]>]`: + - `[AmazonAccountCredentialReferenceName <String>]`: + - `[AmazonAccountCredentialType <CredentialType?>]`: + - `[AmazonAccountResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterResource <String[]>]`: + - `[AmazonAccountScanRulesetName <String>]`: + - `[AmazonAccountScanRulesetType <ScanRulesetType?>]`: + - `[AmazonPostgreSqlCredentialReferenceName <String>]`: + - `[AmazonPostgreSqlCredentialType <CredentialType?>]`: + - `[AmazonPostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterResource <String[]>]`: + - `[AmazonPostgreSqlScanRulesetName <String>]`: + - `[AmazonPostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AmazonS3CredentialReferenceName <String>]`: + - `[AmazonS3CredentialType <CredentialType?>]`: + - `[AmazonS3ResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterResource <String[]>]`: + - `[AmazonS3ScanRulesetName <String>]`: + - `[AmazonS3ScanRulesetType <ScanRulesetType?>]`: + - `[AmazonSqlCredentialReferenceName <String>]`: + - `[AmazonSqlCredentialType <CredentialType?>]`: + - `[AmazonSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterResource <String[]>]`: + - `[AmazonSqlScanRulesetName <String>]`: + - `[AmazonSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmoDbScanRulesetName <String>]`: + - `[AzureCosmoDbScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmosDbCredentialReferenceName <String>]`: + - `[AzureCosmosDbCredentialType <CredentialType?>]`: + - `[AzureCosmosDbResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerCredentialReferenceName <String>]`: + - `[AzureDataExplorerCredentialType <CredentialType?>]`: + - `[AzureDataExplorerResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerScanRulesetName <String>]`: + - `[AzureDataExplorerScanRulesetType <ScanRulesetType?>]`: + - `[AzureFileServiceCredentialReferenceName <String>]`: + - `[AzureFileServiceCredentialType <CredentialType?>]`: + - `[AzureFileServiceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterResource <String[]>]`: + - `[AzureFileServiceScanRulesetName <String>]`: + - `[AzureFileServiceScanRulesetType <ScanRulesetType?>]`: + - `[AzureMySqlCredentialReferenceName <String>]`: + - `[AzureMySqlCredentialType <CredentialType?>]`: + - `[AzureMySqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterResource <String[]>]`: + - `[AzureMySqlScanRulesetName <String>]`: + - `[AzureMySqlScanRulesetType <ScanRulesetType?>]`: + - `[AzurePostgreSqlCredentialReferenceName <String>]`: + - `[AzurePostgreSqlCredentialType <CredentialType?>]`: + - `[AzurePostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterResource <String[]>]`: + - `[AzurePostgreSqlScanRulesetName <String>]`: + - `[AzurePostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureResourceGroupCredentialReferenceName <String>]`: + - `[AzureResourceGroupCredentialType <CredentialType?>]`: + - `[AzureResourceGroupResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterResource <String[]>]`: + - `[AzureResourceGroupScanRulesetName <String>]`: + - `[AzureResourceGroupScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDataWarehouseCredentialReferenceName <String>]`: + - `[AzureSqlDataWarehouseCredentialType <CredentialType?>]`: + - `[AzureSqlDataWarehouseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDataWarehouseScanRulesetName <String>]`: + - `[AzureSqlDataWarehouseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetName <String>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseScanRulesetName <String>]`: + - `[AzureSqlDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[AzureStorageCredentialReferenceName <String>]`: + - `[AzureStorageCredentialType <CredentialType?>]`: + - `[AzureStorageResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterResource <String[]>]`: + - `[AzureStorageScanRulesetName <String>]`: + - `[AzureStorageScanRulesetType <ScanRulesetType?>]`: + - `[AzureSubscriptionCredentialReferenceName <String>]`: + - `[AzureSubscriptionCredentialType <CredentialType?>]`: + - `[AzureSubscriptionResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterResource <String[]>]`: + - `[AzureSubscriptionScanRulesetName <String>]`: + - `[AzureSubscriptionScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseCredentialReferenceName <String>]`: + - `[AzureSynapseCredentialType <CredentialType?>]`: + - `[AzureSynapseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterResource <String[]>]`: + - `[AzureSynapseScanRulesetName <String>]`: + - `[AzureSynapseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseWorkspaceCredentialReferenceName <String>]`: + - `[AzureSynapseWorkspaceCredentialType <CredentialType?>]`: + - `[AzureSynapseWorkspaceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterResource <String[]>]`: + - `[AzureSynapseWorkspaceScanRulesetName <String>]`: + - `[AzureSynapseWorkspaceScanRulesetType <ScanRulesetType?>]`: + - `[NoneCredentialReferenceName <String>]`: + - `[NoneCredentialType <CredentialType?>]`: + - `[NoneResourceNameFilterExcludePrefix <String[]>]`: + - `[NoneResourceNameFilterIncludePrefix <String[]>]`: + - `[NoneResourceNameFilterResource <String[]>]`: + - `[NoneScanRulesetName <String>]`: + - `[NoneScanRulesetType <ScanRulesetType?>]`: + - `[OracleCredentialReferenceName <String>]`: + - `[OracleCredentialType <CredentialType?>]`: + - `[OracleResourceNameFilterExcludePrefix <String[]>]`: + - `[OracleResourceNameFilterIncludePrefix <String[]>]`: + - `[OracleResourceNameFilterResource <String[]>]`: + - `[OracleScanRulesetName <String>]`: + - `[OracleScanRulesetType <ScanRulesetType?>]`: + - `[PowerBiCredentialReferenceName <String>]`: + - `[PowerBiCredentialType <CredentialType?>]`: + - `[PowerBiResourceNameFilterExcludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterIncludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterResource <String[]>]`: + - `[PowerBiScanRulesetName <String>]`: + - `[PowerBiScanRulesetType <ScanRulesetType?>]`: + - `[SapEccCredentialReferenceName <String>]`: + - `[SapEccCredentialType <CredentialType?>]`: + - `[SapEccResourceNameFilterExcludePrefix <String[]>]`: + - `[SapEccResourceNameFilterIncludePrefix <String[]>]`: + - `[SapEccResourceNameFilterResource <String[]>]`: + - `[SapEccScanRulesetName <String>]`: + - `[SapEccScanRulesetType <ScanRulesetType?>]`: + - `[SapS4HanaCredentialReferenceName <String>]`: + - `[SapS4HanaCredentialType <CredentialType?>]`: + - `[SapS4HanaResourceNameFilterExcludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterIncludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterResource <String[]>]`: + - `[SapS4HanaScanRulesetName <String>]`: + - `[SapS4HanaScanRulesetType <ScanRulesetType?>]`: + - `[SqlServerDatabaseCredentialReferenceName <String>]`: + - `[SqlServerDatabaseCredentialType <CredentialType?>]`: + - `[SqlServerDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterResource <String[]>]`: + - `[SqlServerDatabaseScanRulesetName <String>]`: + - `[SqlServerDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[TeradataCredentialReferenceName <String>]`: + - `[TeradataCredentialType <CredentialType?>]`: + - `[TeradataResourceNameFilterExcludePrefix <String[]>]`: + - `[TeradataResourceNameFilterIncludePrefix <String[]>]`: + - `[TeradataResourceNameFilterResource <String[]>]`: + - `[TeradataScanRulesetName <String>]`: + - `[TeradataScanRulesetType <ScanRulesetType?>]`: + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDataWarehouseCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDataWarehouseCredentialScanObject.md new file mode 100644 index 0000000000..3b3b16c96c --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDataWarehouseCredentialScanObject.md @@ -0,0 +1,226 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSqlDataWarehouseCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDataWarehouseCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDataWarehouseCredentialScanObject.md +--- + +# New-AzPurviewAzureSqlDataWarehouseCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AzureSqlDataWarehouseCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAzureSqlDataWarehouseCredentialScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] [-DatabaseName <String>] + [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-ServerEndpoint <String>] [-Worker <Int32>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSqlDataWarehouseCredentialScan. + +## EXAMPLES + +### Example 1: Create Azure Sql Data Warehouse Credential scan object +```powershell +New-AzPurviewAzureSqlDataWarehouseCredentialScanObject -Kind 'AzureSqlDataWarehouseCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -DatabaseName 'db' -ScanRulesetName 'AzureSqlDataWarehouse' -ScanRulesetType 'System' -ServerEndpoint 'canstzn.database.windows.net' -CredentialReferenceName 'sqlauth' -CredentialType 'SqlAuth' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : sqlauth +CredentialType : SqlAuth +DatabaseName : db +Id : +Kind : AzureSqlDataWarehouseCredential +LastModifiedAt : +Name : +Result : +ScanRulesetName : AzureSqlDataWarehouse +ScanRulesetType : System +ServerEndpoint : canstzn.database.windows.net +Worker : +``` + +Create Azure Sql Data Warehouse Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSqlDataWarehouseCredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDataWarehouseDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDataWarehouseDataSourceObject.md new file mode 100644 index 0000000000..96c9578da6 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDataWarehouseDataSourceObject.md @@ -0,0 +1,179 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSqlDataWarehouseDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDataWarehouseDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDataWarehouseDataSourceObject.md +--- + +# New-AzPurviewAzureSqlDataWarehouseDataSourceObject + +## SYNOPSIS +Create an in-memory object for AzureSqlDataWarehouseDataSource. + +## SYNTAX + +``` +New-AzPurviewAzureSqlDataWarehouseDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Location <String>] [-ResourceGroup <String>] [-ResourceName <String>] + [-ServerEndpoint <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSqlDataWarehouseDataSource. + +## EXAMPLES + +### Example 1: Create Azure SQL datawarehouse data source object +```powershell +New-AzPurviewAzureSqlDataWarehouseDataSourceObject -Kind 'AzureSqlDataWarehouse' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ServerEndpoint 'ause.database.windows.net' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : AzureSqlDataWarehouse +LastModifiedAt : +Location : +Name : +ResourceGroup : +ResourceName : +Scan : +ServerEndpoint : ause.database.windows.net +SubscriptionId : +``` + +Create Azure SQL datawarehouse data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSqlDataWarehouseDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDataWarehouseMsiScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDataWarehouseMsiScanObject.md new file mode 100644 index 0000000000..f9e3e78a18 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDataWarehouseMsiScanObject.md @@ -0,0 +1,195 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSqlDataWarehouseMsiScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDataWarehouseMsiScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDataWarehouseMsiScanObject.md +--- + +# New-AzPurviewAzureSqlDataWarehouseMsiScanObject + +## SYNOPSIS +Create an in-memory object for AzureSqlDataWarehouseMsiScan. + +## SYNTAX + +``` +New-AzPurviewAzureSqlDataWarehouseMsiScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-DatabaseName <String>] [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] + [-ServerEndpoint <String>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSqlDataWarehouseMsiScan. + +## EXAMPLES + +### Example 1: Create Azure Sql Data Warehouse Msi scan object +```powershell +New-AzPurviewAzureSqlDataWarehouseMsiScanObject -Kind 'AzureSqlDataWarehouseMsi' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -DatabaseName 'db' -ScanRulesetName 'AzureSqlDataWarehouse' -ScanRulesetType 'System' -ServerEndpoint 'canstzn.database.windows.net' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +DatabaseName : db +Id : +Kind : AzureSqlDataWarehouseMsi +LastModifiedAt : +Name : +Result : +ScanRulesetName : AzureSqlDataWarehouse +ScanRulesetType : System +ServerEndpoint : canstzn.database.windows.net +Worker : +``` + +Create Azure Sql Data Warehouse Msi scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSqlDataWarehouseMsiScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDataWarehouseScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDataWarehouseScanRulesetObject.md new file mode 100644 index 0000000000..59f91342ed --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDataWarehouseScanRulesetObject.md @@ -0,0 +1,134 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSqlDataWarehouseScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDataWarehouseScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDataWarehouseScanRulesetObject.md +--- + +# New-AzPurviewAzureSqlDataWarehouseScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AzureSqlDataWarehouseScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAzureSqlDataWarehouseScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSqlDataWarehouseScanRuleset. + +## EXAMPLES + +### Example 1: Create Azure SQL Data Warehouse custom scanruleset object +```powershell +New-AzPurviewAzureSqlDataWarehouseScanRulesetObject -Kind 'AzureSqlDataWarehouse' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AzureSqlDataWarehouse +LastModifiedAt : +Name : +Status : +Type : Custom +Version : +``` + +Create Azure SQL Data Warehouse custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSqlDataWarehouseScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseCredentialScanObject.md new file mode 100644 index 0000000000..700b059958 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseCredentialScanObject.md @@ -0,0 +1,226 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSqlDatabaseCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseCredentialScanObject.md +--- + +# New-AzPurviewAzureSqlDatabaseCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AzureSqlDatabaseCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAzureSqlDatabaseCredentialScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] [-DatabaseName <String>] + [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-ServerEndpoint <String>] [-Worker <Int32>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSqlDatabaseCredentialScan. + +## EXAMPLES + +### Example 1: Create Azure Sql Db Credential scan object +```powershell +New-AzPurviewAzureSqlDatabaseCredentialScanObject -Kind 'AzureSqlDatabaseCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'sqlauth' -CredentialType 'SqlAuth' -DatabaseName 'db' -ScanRulesetName 'AzureSqlDatabase' -ScanRulesetType 'System' -ServerEndpoint 'stzn.database.windows.net' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : sqlauth +CredentialType : SqlAuth +DatabaseName : db +Id : +Kind : AzureSqlDatabaseCredential +LastModifiedAt : +Name : +Result : +ScanRulesetName : AzureSqlDatabase +ScanRulesetType : System +ServerEndpoint : stzn.database.windows.net +Worker : +``` + +Create Azure Sql Db Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSqlDatabaseCredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseDataSourceObject.md new file mode 100644 index 0000000000..5ecf6a5ba4 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseDataSourceObject.md @@ -0,0 +1,179 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSqlDatabaseDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseDataSourceObject.md +--- + +# New-AzPurviewAzureSqlDatabaseDataSourceObject + +## SYNOPSIS +Create an in-memory object for AzureSqlDatabaseDataSource. + +## SYNTAX + +``` +New-AzPurviewAzureSqlDatabaseDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Location <String>] [-ResourceGroup <String>] [-ResourceName <String>] + [-ServerEndpoint <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSqlDatabaseDataSource. + +## EXAMPLES + +### Example 1: Create Azure SQL database data source object +```powershell +New-AzPurviewAzureSqlDatabaseDataSourceObject -Kind 'AzureSqlDatabase' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ServerEndpoint 'ause.database.windows.net' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : AzureSqlDatabase +LastModifiedAt : +Location : +Name : +ResourceGroup : +ResourceName : +Scan : +ServerEndpoint : ause.database.windows.net +SubscriptionId : +``` + +Create Azure SQL database data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSqlDatabaseDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseManagedInstanceCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseManagedInstanceCredentialScanObject.md new file mode 100644 index 0000000000..cfa0d0f55f --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseManagedInstanceCredentialScanObject.md @@ -0,0 +1,226 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSqlDatabaseManagedInstanceCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseManagedInstanceCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseManagedInstanceCredentialScanObject.md +--- + +# New-AzPurviewAzureSqlDatabaseManagedInstanceCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AzureSqlDatabaseManagedInstanceCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAzureSqlDatabaseManagedInstanceCredentialScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] [-DatabaseName <String>] + [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-ServerEndpoint <String>] [-Worker <Int32>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSqlDatabaseManagedInstanceCredentialScan. + +## EXAMPLES + +### Example 1: Create Azure Sql Database Managed Instance Credential scan object +```powershell +New-AzPurviewAzureSqlDatabaseManagedInstanceCredentialScanObject -Kind 'AzureSqlDatabaseManagedInstanceCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'sqlauth' -CredentialType 'SqlAuth' -DatabaseName 'db' -ScanRulesetName 'AzureSqlDatabaseManagedInstance' -ScanRulesetType 'System' -ServerEndpoint 'tcp:sqstzn.public.5aaf14.database.windows.net,3342' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : sqlauth +CredentialType : SqlAuth +DatabaseName : db +Id : +Kind : AzureSqlDatabaseManagedInstanceCredential +LastModifiedAt : +Name : +Result : +ScanRulesetName : AzureSqlDatabaseManagedInstance +ScanRulesetType : System +ServerEndpoint : tcp:sqstzn.public.5aaf14.database.windows.net,3342 +Worker : +``` + +Create Azure Sql Database Managed Instance Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSqlDatabaseManagedInstanceCredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseManagedInstanceDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseManagedInstanceDataSourceObject.md new file mode 100644 index 0000000000..b15ba56a5a --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseManagedInstanceDataSourceObject.md @@ -0,0 +1,179 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSqlDatabaseManagedInstanceDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseManagedInstanceDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseManagedInstanceDataSourceObject.md +--- + +# New-AzPurviewAzureSqlDatabaseManagedInstanceDataSourceObject + +## SYNOPSIS +Create an in-memory object for AzureSqlDatabaseManagedInstanceDataSource. + +## SYNTAX + +``` +New-AzPurviewAzureSqlDatabaseManagedInstanceDataSourceObject -Kind <DataSourceType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-Location <String>] [-ResourceGroup <String>] + [-ResourceName <String>] [-ServerEndpoint <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSqlDatabaseManagedInstanceDataSource. + +## EXAMPLES + +### Example 1: Create Azure SQL database managed instance data source object +```powershell +New-AzPurviewAzureSqlDatabaseManagedInstanceDataSourceObject -Kind 'AzureSqlDatabaseManagedInstance' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ServerEndpoint 'tcp:sqlause.public.3b6a39.database.windows.net,3342' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : AzureSqlDatabaseManagedInstance +LastModifiedAt : +Location : +Name : +ResourceGroup : +ResourceName : +Scan : +ServerEndpoint : tcp:sqlause.public.3b6a39.database.windows.net,3342 +SubscriptionId : +``` + +Create Azure SQL database managed instance data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSqlDatabaseManagedInstanceDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseManagedInstanceMsiScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseManagedInstanceMsiScanObject.md new file mode 100644 index 0000000000..d2dd02a715 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseManagedInstanceMsiScanObject.md @@ -0,0 +1,195 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSqlDatabaseManagedInstanceMsiScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseManagedInstanceMsiScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseManagedInstanceMsiScanObject.md +--- + +# New-AzPurviewAzureSqlDatabaseManagedInstanceMsiScanObject + +## SYNOPSIS +Create an in-memory object for AzureSqlDatabaseManagedInstanceMsiScan. + +## SYNTAX + +``` +New-AzPurviewAzureSqlDatabaseManagedInstanceMsiScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-DatabaseName <String>] [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] + [-ServerEndpoint <String>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSqlDatabaseManagedInstanceMsiScan. + +## EXAMPLES + +### Example 1: Create Azure Sql Database Managed Instance Msi scan object +```powershell +New-AzPurviewAzureSqlDatabaseManagedInstanceMsiScanObject -Kind 'AzureSqlDatabaseManagedInstanceMsi' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -DatabaseName 'db' -ScanRulesetName 'AzureSqlDatabaseManagedInstance' -ScanRulesetType 'System' -ServerEndpoint 'tcp:sqstzn.public.5aaf14.database.windows.net,3342' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +DatabaseName : db +Id : +Kind : AzureSqlDatabaseManagedInstanceMsi +LastModifiedAt : +Name : +Result : +ScanRulesetName : AzureSqlDatabaseManagedInstance +ScanRulesetType : System +ServerEndpoint : tcp:sqstzn.public.5aaf14.database.windows.net,3342 +Worker : +``` + +Create Azure Sql Database Managed Instance Msi scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSqlDatabaseManagedInstanceMsiScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseManagedInstanceScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseManagedInstanceScanRulesetObject.md new file mode 100644 index 0000000000..75c1da0104 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseManagedInstanceScanRulesetObject.md @@ -0,0 +1,134 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSqlDatabaseManagedInstanceScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseManagedInstanceScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseManagedInstanceScanRulesetObject.md +--- + +# New-AzPurviewAzureSqlDatabaseManagedInstanceScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AzureSqlDatabaseManagedInstanceScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAzureSqlDatabaseManagedInstanceScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSqlDatabaseManagedInstanceScanRuleset. + +## EXAMPLES + +### Example 1: Create Azure SQL Database Managed Instance custom scanruleset object +```powershell +New-AzPurviewAzureSqlDatabaseManagedInstanceScanRulesetObject -Kind 'AzureSqlDatabaseManagedInstance' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AzureSqlDatabaseManagedInstance +LastModifiedAt : +Name : +Status : +Type : Custom +Version : +``` + +Create Azure SQL Database Managed Instance custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSqlDatabaseManagedInstanceScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseMsiScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseMsiScanObject.md new file mode 100644 index 0000000000..2b5a2aa853 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseMsiScanObject.md @@ -0,0 +1,195 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSqlDatabaseMsiScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseMsiScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseMsiScanObject.md +--- + +# New-AzPurviewAzureSqlDatabaseMsiScanObject + +## SYNOPSIS +Create an in-memory object for AzureSqlDatabaseMsiScan. + +## SYNTAX + +``` +New-AzPurviewAzureSqlDatabaseMsiScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-DatabaseName <String>] + [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-ServerEndpoint <String>] [-Worker <Int32>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSqlDatabaseMsiScan. + +## EXAMPLES + +### Example 1: Create Azure Sql Db Msi scan object +```powershell +New-AzPurviewAzureSqlDatabaseMsiScanObject -Kind 'AzureSqlDatabaseMsi' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -DatabaseName 'db' -ScanRulesetName 'AzureSqlDatabase' -ScanRulesetType 'System' -ServerEndpoint 'stzn.database.windows.net' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +DatabaseName : db +Id : +Kind : AzureSqlDatabaseMsi +LastModifiedAt : +Name : +Result : +ScanRulesetName : AzureSqlDatabase +ScanRulesetType : System +ServerEndpoint : stzn.database.windows.net +Worker : +``` + +Create Azure Sql Db Msi scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSqlDatabaseMsiScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseScanRulesetObject.md new file mode 100644 index 0000000000..9aa5c0ffa5 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSqlDatabaseScanRulesetObject.md @@ -0,0 +1,134 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSqlDatabaseScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSqlDatabaseScanRulesetObject.md +--- + +# New-AzPurviewAzureSqlDatabaseScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AzureSqlDatabaseScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAzureSqlDatabaseScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSqlDatabaseScanRuleset. + +## EXAMPLES + +### Example 1: Create Azure SQL Database custom scanruleset object +```powershell +New-AzPurviewAzureSqlDatabaseScanRulesetObject -Kind 'AzureSqlDatabase' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AzureSqlDatabase +LastModifiedAt : +Name : +Status : +Type : Custom +Version : +``` + +Create Azure SQL Database custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSqlDatabaseScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureStorageCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureStorageCredentialScanObject.md new file mode 100644 index 0000000000..c719ccf9a3 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureStorageCredentialScanObject.md @@ -0,0 +1,195 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureStorageCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureStorageCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureStorageCredentialScanObject.md +--- + +# New-AzPurviewAzureStorageCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AzureStorageCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAzureStorageCredentialScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-CredentialReferenceName <String>] + [-CredentialType <CredentialType>] [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] + [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureStorageCredentialScan. + +## EXAMPLES + +### Example 1: Create Azure Storage Credential scan object +```powershell +New-AzPurviewAzureStorageCredentialScanObject -Kind 'AzureStorageCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'datascantestdataparv-accountkey' -CredentialType 'AccountKey' -ScanRulesetName 'AzureStorage' -ScanRulesetType 'System' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : datascantestdataparv-accountkey +CredentialType : AccountKey +Id : +Kind : AzureStorageCredential +LastModifiedAt : +Name : +Result : +ScanRulesetName : AzureStorage +ScanRulesetType : System +Worker : +``` + +Create Azure Storage Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureStorageCredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureStorageDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureStorageDataSourceObject.md new file mode 100644 index 0000000000..45b9ac013f --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureStorageDataSourceObject.md @@ -0,0 +1,179 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureStorageDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureStorageDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureStorageDataSourceObject.md +--- + +# New-AzPurviewAzureStorageDataSourceObject + +## SYNOPSIS +Create an in-memory object for AzureStorageDataSource. + +## SYNTAX + +``` +New-AzPurviewAzureStorageDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Endpoint <String>] [-Location <String>] [-ResourceGroup <String>] + [-ResourceName <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureStorageDataSource. + +## EXAMPLES + +### Example 1: Create Azure Storage data source object +```powershell +New-AzPurviewAzureStorageDataSourceObject -Kind 'AzureStorage' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -Endpoint 'https://bnsrpause.blob.core.windows.net' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Endpoint : https://bnsrpause.blob.core.windows.net +Id : +Kind : AzureStorage +LastModifiedAt : +Location : +Name : +ResourceGroup : +ResourceName : +Scan : +SubscriptionId : +``` + +Create Azure Storage data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureStorageDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureStorageMsiScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureStorageMsiScanObject.md new file mode 100644 index 0000000000..c830025afb --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureStorageMsiScanObject.md @@ -0,0 +1,164 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureStorageMsiScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureStorageMsiScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureStorageMsiScanObject.md +--- + +# New-AzPurviewAzureStorageMsiScanObject + +## SYNOPSIS +Create an in-memory object for AzureStorageMsiScan. + +## SYNTAX + +``` +New-AzPurviewAzureStorageMsiScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-ScanRulesetName <String>] + [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureStorageMsiScan. + +## EXAMPLES + +### Example 1: Create Azure Storage Msi scan object +```powershell +New-AzPurviewAzureStorageMsiScanObject -Kind 'AzureStorageMsi' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ScanRulesetName 'AzureStorage' -ScanRulesetType 'System' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +Id : +Kind : AzureStorageMsi +LastModifiedAt : +Name : +Result : +ScanRulesetName : AzureStorage +ScanRulesetType : System +Worker : +``` + +Create Azure Storage Msi scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureStorageMsiScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureStorageScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureStorageScanRulesetObject.md new file mode 100644 index 0000000000..be6e9d44c5 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureStorageScanRulesetObject.md @@ -0,0 +1,178 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureStorageScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureStorageScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureStorageScanRulesetObject.md +--- + +# New-AzPurviewAzureStorageScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AzureStorageScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAzureStorageScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-ScanningRuleCustomFileExtension <ICustomFileExtension[]>] + [-ScanningRuleFileExtension <FileExtensionsType[]>] [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureStorageScanRuleset. + +## EXAMPLES + +### Example 1: Create Azure Storage custom scanruleset object +```powershell +New-AzPurviewAzureStorageScanRulesetObject -Kind 'AzureStorage' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -ScanningRuleFileExtension @("CSV","JSON","PSV","SSV","TSV","TXT","XML","PARQUET","AVRO","ORC","Documents","GZ","DOC","DOCM","DOCX","DOT","ODP","ODS","ODT","PDF","POT","PPS","PPSX","PPT","PPTM","PPTX","XLC","XLS","XLSB","XLSM","XLSX","XLT") -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AzureStorage +LastModifiedAt : +Name : +ScanningRuleCustomFileExtension : +ScanningRuleFileExtension : {CSV, JSON, PSV, SSV…} +Status : +Type : Custom +Version : +``` + +Create Azure Storage custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanningRuleCustomFileExtension +To construct, see NOTES section for SCANNINGRULECUSTOMFILEEXTENSION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.ICustomFileExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanningRuleFileExtension + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.FileExtensionsType[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureStorageScanRuleset + +## 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. + + +SCANNINGRULECUSTOMFILEEXTENSION <ICustomFileExtension[]>: + - `[CustomFileTypeBuiltInType <FileExtensionsType?>]`: + - `[CustomFileTypeCustomDelimiter <String>]`: + - `[Description <String>]`: + - `[Enabled <Boolean?>]`: + - `[FileExtension <String>]`: + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSubscriptionCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSubscriptionCredentialScanObject.md new file mode 100644 index 0000000000..3b93b60c62 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSubscriptionCredentialScanObject.md @@ -0,0 +1,404 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSubscriptionCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSubscriptionCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSubscriptionCredentialScanObject.md +--- + +# New-AzPurviewAzureSubscriptionCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AzureSubscriptionCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAzureSubscriptionCredentialScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] + [-ResourceType <IExpandingResourceScanPropertiesResourceTypes>] [-ScanRulesetName <String>] + [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSubscriptionCredentialScan. + +## EXAMPLES + +### Example 1: Create Azure resource sub Credential scan object +```powershell +New-AzPurviewAzureSubscriptionCredentialScanObject -Kind 'AzureSubscriptionCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialType 'ServicePrincipal' -CredentialReferenceName 'svcp' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : svcp +CredentialType : ServicePrincipal +Id : +Kind : AzureSubscriptionCredential +LastModifiedAt : +Name : +ResourceType : { + } +Result : +ScanRulesetName : +ScanRulesetType : +Worker : +``` + +Create Azure resource sub Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +To construct, see NOTES section for RESOURCETYPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IExpandingResourceScanPropertiesResourceTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSubscriptionCredentialScan + +## 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. + + +RESOURCETYPE `<IExpandingResourceScanPropertiesResourceTypes>`: + - `[AdlGen1ScanRulesetName <String>]`: + - `[AdlGen1ScanRulesetType <ScanRulesetType?>]`: + - `[AdlGen2ScanRulesetName <String>]`: + - `[AdlGen2ScanRulesetType <ScanRulesetType?>]`: + - `[AdlsGen1CredentialReferenceName <String>]`: + - `[AdlsGen1CredentialType <CredentialType?>]`: + - `[AdlsGen1ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterResource <String[]>]`: + - `[AdlsGen2CredentialReferenceName <String>]`: + - `[AdlsGen2CredentialType <CredentialType?>]`: + - `[AdlsGen2ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterResource <String[]>]`: + - `[AmazonAccountCredentialReferenceName <String>]`: + - `[AmazonAccountCredentialType <CredentialType?>]`: + - `[AmazonAccountResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterResource <String[]>]`: + - `[AmazonAccountScanRulesetName <String>]`: + - `[AmazonAccountScanRulesetType <ScanRulesetType?>]`: + - `[AmazonPostgreSqlCredentialReferenceName <String>]`: + - `[AmazonPostgreSqlCredentialType <CredentialType?>]`: + - `[AmazonPostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterResource <String[]>]`: + - `[AmazonPostgreSqlScanRulesetName <String>]`: + - `[AmazonPostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AmazonS3CredentialReferenceName <String>]`: + - `[AmazonS3CredentialType <CredentialType?>]`: + - `[AmazonS3ResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterResource <String[]>]`: + - `[AmazonS3ScanRulesetName <String>]`: + - `[AmazonS3ScanRulesetType <ScanRulesetType?>]`: + - `[AmazonSqlCredentialReferenceName <String>]`: + - `[AmazonSqlCredentialType <CredentialType?>]`: + - `[AmazonSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterResource <String[]>]`: + - `[AmazonSqlScanRulesetName <String>]`: + - `[AmazonSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmoDbScanRulesetName <String>]`: + - `[AzureCosmoDbScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmosDbCredentialReferenceName <String>]`: + - `[AzureCosmosDbCredentialType <CredentialType?>]`: + - `[AzureCosmosDbResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerCredentialReferenceName <String>]`: + - `[AzureDataExplorerCredentialType <CredentialType?>]`: + - `[AzureDataExplorerResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerScanRulesetName <String>]`: + - `[AzureDataExplorerScanRulesetType <ScanRulesetType?>]`: + - `[AzureFileServiceCredentialReferenceName <String>]`: + - `[AzureFileServiceCredentialType <CredentialType?>]`: + - `[AzureFileServiceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterResource <String[]>]`: + - `[AzureFileServiceScanRulesetName <String>]`: + - `[AzureFileServiceScanRulesetType <ScanRulesetType?>]`: + - `[AzureMySqlCredentialReferenceName <String>]`: + - `[AzureMySqlCredentialType <CredentialType?>]`: + - `[AzureMySqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterResource <String[]>]`: + - `[AzureMySqlScanRulesetName <String>]`: + - `[AzureMySqlScanRulesetType <ScanRulesetType?>]`: + - `[AzurePostgreSqlCredentialReferenceName <String>]`: + - `[AzurePostgreSqlCredentialType <CredentialType?>]`: + - `[AzurePostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterResource <String[]>]`: + - `[AzurePostgreSqlScanRulesetName <String>]`: + - `[AzurePostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureResourceGroupCredentialReferenceName <String>]`: + - `[AzureResourceGroupCredentialType <CredentialType?>]`: + - `[AzureResourceGroupResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterResource <String[]>]`: + - `[AzureResourceGroupScanRulesetName <String>]`: + - `[AzureResourceGroupScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDataWarehouseCredentialReferenceName <String>]`: + - `[AzureSqlDataWarehouseCredentialType <CredentialType?>]`: + - `[AzureSqlDataWarehouseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDataWarehouseScanRulesetName <String>]`: + - `[AzureSqlDataWarehouseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetName <String>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseScanRulesetName <String>]`: + - `[AzureSqlDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[AzureStorageCredentialReferenceName <String>]`: + - `[AzureStorageCredentialType <CredentialType?>]`: + - `[AzureStorageResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterResource <String[]>]`: + - `[AzureStorageScanRulesetName <String>]`: + - `[AzureStorageScanRulesetType <ScanRulesetType?>]`: + - `[AzureSubscriptionCredentialReferenceName <String>]`: + - `[AzureSubscriptionCredentialType <CredentialType?>]`: + - `[AzureSubscriptionResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterResource <String[]>]`: + - `[AzureSubscriptionScanRulesetName <String>]`: + - `[AzureSubscriptionScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseCredentialReferenceName <String>]`: + - `[AzureSynapseCredentialType <CredentialType?>]`: + - `[AzureSynapseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterResource <String[]>]`: + - `[AzureSynapseScanRulesetName <String>]`: + - `[AzureSynapseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseWorkspaceCredentialReferenceName <String>]`: + - `[AzureSynapseWorkspaceCredentialType <CredentialType?>]`: + - `[AzureSynapseWorkspaceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterResource <String[]>]`: + - `[AzureSynapseWorkspaceScanRulesetName <String>]`: + - `[AzureSynapseWorkspaceScanRulesetType <ScanRulesetType?>]`: + - `[NoneCredentialReferenceName <String>]`: + - `[NoneCredentialType <CredentialType?>]`: + - `[NoneResourceNameFilterExcludePrefix <String[]>]`: + - `[NoneResourceNameFilterIncludePrefix <String[]>]`: + - `[NoneResourceNameFilterResource <String[]>]`: + - `[NoneScanRulesetName <String>]`: + - `[NoneScanRulesetType <ScanRulesetType?>]`: + - `[OracleCredentialReferenceName <String>]`: + - `[OracleCredentialType <CredentialType?>]`: + - `[OracleResourceNameFilterExcludePrefix <String[]>]`: + - `[OracleResourceNameFilterIncludePrefix <String[]>]`: + - `[OracleResourceNameFilterResource <String[]>]`: + - `[OracleScanRulesetName <String>]`: + - `[OracleScanRulesetType <ScanRulesetType?>]`: + - `[PowerBiCredentialReferenceName <String>]`: + - `[PowerBiCredentialType <CredentialType?>]`: + - `[PowerBiResourceNameFilterExcludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterIncludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterResource <String[]>]`: + - `[PowerBiScanRulesetName <String>]`: + - `[PowerBiScanRulesetType <ScanRulesetType?>]`: + - `[SapEccCredentialReferenceName <String>]`: + - `[SapEccCredentialType <CredentialType?>]`: + - `[SapEccResourceNameFilterExcludePrefix <String[]>]`: + - `[SapEccResourceNameFilterIncludePrefix <String[]>]`: + - `[SapEccResourceNameFilterResource <String[]>]`: + - `[SapEccScanRulesetName <String>]`: + - `[SapEccScanRulesetType <ScanRulesetType?>]`: + - `[SapS4HanaCredentialReferenceName <String>]`: + - `[SapS4HanaCredentialType <CredentialType?>]`: + - `[SapS4HanaResourceNameFilterExcludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterIncludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterResource <String[]>]`: + - `[SapS4HanaScanRulesetName <String>]`: + - `[SapS4HanaScanRulesetType <ScanRulesetType?>]`: + - `[SqlServerDatabaseCredentialReferenceName <String>]`: + - `[SqlServerDatabaseCredentialType <CredentialType?>]`: + - `[SqlServerDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterResource <String[]>]`: + - `[SqlServerDatabaseScanRulesetName <String>]`: + - `[SqlServerDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[TeradataCredentialReferenceName <String>]`: + - `[TeradataCredentialType <CredentialType?>]`: + - `[TeradataResourceNameFilterExcludePrefix <String[]>]`: + - `[TeradataResourceNameFilterIncludePrefix <String[]>]`: + - `[TeradataResourceNameFilterResource <String[]>]`: + - `[TeradataScanRulesetName <String>]`: + - `[TeradataScanRulesetType <ScanRulesetType?>]`: + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSubscriptionDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSubscriptionDataSourceObject.md new file mode 100644 index 0000000000..8469b1d923 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSubscriptionDataSourceObject.md @@ -0,0 +1,118 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSubscriptionDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSubscriptionDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSubscriptionDataSourceObject.md +--- + +# New-AzPurviewAzureSubscriptionDataSourceObject + +## SYNOPSIS +Create an in-memory object for AzureSubscriptionDataSource. + +## SYNTAX + +``` +New-AzPurviewAzureSubscriptionDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSubscriptionDataSource. + +## EXAMPLES + +### Example 1: Create Azure Subscription data source object +```powershell +New-AzPurviewAzureSubscriptionDataSourceObject -Kind 'AzureSubscription' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -SubscriptionId '6810b9ce-82d3-4562-9658-xxxxxxxxxx' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : AzureSubscription +LastModifiedAt : +Name : +Scan : +SubscriptionId : 6810b9ce-82d3-4562-9658-xxxxxxxxxx +``` + +Create Azure Subscription data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSubscriptionDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSubscriptionMsiScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSubscriptionMsiScanObject.md new file mode 100644 index 0000000000..5b9e225e45 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSubscriptionMsiScanObject.md @@ -0,0 +1,403 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSubscriptionMsiScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSubscriptionMsiScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSubscriptionMsiScanObject.md +--- + +# New-AzPurviewAzureSubscriptionMsiScanObject + +## SYNOPSIS +Create an in-memory object for AzureSubscriptionMsiScan. + +## SYNTAX + +``` +New-AzPurviewAzureSubscriptionMsiScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-CredentialReferenceName <String>] + [-CredentialType <CredentialType>] [-ResourceType <IExpandingResourceScanPropertiesResourceTypes>] + [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSubscriptionMsiScan. + +## EXAMPLES + +### Example 1: Create Azure resource sub Msi scan object +```powershell +New-AzPurviewAzureSubscriptionMsiScanObject -Kind 'AzureSubscriptionMsi' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : +CredentialType : +Id : +Kind : AzureSubscriptionMsi +LastModifiedAt : +Name : +ResourceType : { + } +Result : +ScanRulesetName : +ScanRulesetType : +Worker : +``` + +Create Azure resource sub Msi scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +To construct, see NOTES section for RESOURCETYPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IExpandingResourceScanPropertiesResourceTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSubscriptionMsiScan + +## 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. + + +RESOURCETYPE `<IExpandingResourceScanPropertiesResourceTypes>`: + - `[AdlGen1ScanRulesetName <String>]`: + - `[AdlGen1ScanRulesetType <ScanRulesetType?>]`: + - `[AdlGen2ScanRulesetName <String>]`: + - `[AdlGen2ScanRulesetType <ScanRulesetType?>]`: + - `[AdlsGen1CredentialReferenceName <String>]`: + - `[AdlsGen1CredentialType <CredentialType?>]`: + - `[AdlsGen1ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterResource <String[]>]`: + - `[AdlsGen2CredentialReferenceName <String>]`: + - `[AdlsGen2CredentialType <CredentialType?>]`: + - `[AdlsGen2ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterResource <String[]>]`: + - `[AmazonAccountCredentialReferenceName <String>]`: + - `[AmazonAccountCredentialType <CredentialType?>]`: + - `[AmazonAccountResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterResource <String[]>]`: + - `[AmazonAccountScanRulesetName <String>]`: + - `[AmazonAccountScanRulesetType <ScanRulesetType?>]`: + - `[AmazonPostgreSqlCredentialReferenceName <String>]`: + - `[AmazonPostgreSqlCredentialType <CredentialType?>]`: + - `[AmazonPostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterResource <String[]>]`: + - `[AmazonPostgreSqlScanRulesetName <String>]`: + - `[AmazonPostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AmazonS3CredentialReferenceName <String>]`: + - `[AmazonS3CredentialType <CredentialType?>]`: + - `[AmazonS3ResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterResource <String[]>]`: + - `[AmazonS3ScanRulesetName <String>]`: + - `[AmazonS3ScanRulesetType <ScanRulesetType?>]`: + - `[AmazonSqlCredentialReferenceName <String>]`: + - `[AmazonSqlCredentialType <CredentialType?>]`: + - `[AmazonSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterResource <String[]>]`: + - `[AmazonSqlScanRulesetName <String>]`: + - `[AmazonSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmoDbScanRulesetName <String>]`: + - `[AzureCosmoDbScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmosDbCredentialReferenceName <String>]`: + - `[AzureCosmosDbCredentialType <CredentialType?>]`: + - `[AzureCosmosDbResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerCredentialReferenceName <String>]`: + - `[AzureDataExplorerCredentialType <CredentialType?>]`: + - `[AzureDataExplorerResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerScanRulesetName <String>]`: + - `[AzureDataExplorerScanRulesetType <ScanRulesetType?>]`: + - `[AzureFileServiceCredentialReferenceName <String>]`: + - `[AzureFileServiceCredentialType <CredentialType?>]`: + - `[AzureFileServiceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterResource <String[]>]`: + - `[AzureFileServiceScanRulesetName <String>]`: + - `[AzureFileServiceScanRulesetType <ScanRulesetType?>]`: + - `[AzureMySqlCredentialReferenceName <String>]`: + - `[AzureMySqlCredentialType <CredentialType?>]`: + - `[AzureMySqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterResource <String[]>]`: + - `[AzureMySqlScanRulesetName <String>]`: + - `[AzureMySqlScanRulesetType <ScanRulesetType?>]`: + - `[AzurePostgreSqlCredentialReferenceName <String>]`: + - `[AzurePostgreSqlCredentialType <CredentialType?>]`: + - `[AzurePostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterResource <String[]>]`: + - `[AzurePostgreSqlScanRulesetName <String>]`: + - `[AzurePostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureResourceGroupCredentialReferenceName <String>]`: + - `[AzureResourceGroupCredentialType <CredentialType?>]`: + - `[AzureResourceGroupResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterResource <String[]>]`: + - `[AzureResourceGroupScanRulesetName <String>]`: + - `[AzureResourceGroupScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDataWarehouseCredentialReferenceName <String>]`: + - `[AzureSqlDataWarehouseCredentialType <CredentialType?>]`: + - `[AzureSqlDataWarehouseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDataWarehouseScanRulesetName <String>]`: + - `[AzureSqlDataWarehouseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetName <String>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseScanRulesetName <String>]`: + - `[AzureSqlDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[AzureStorageCredentialReferenceName <String>]`: + - `[AzureStorageCredentialType <CredentialType?>]`: + - `[AzureStorageResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterResource <String[]>]`: + - `[AzureStorageScanRulesetName <String>]`: + - `[AzureStorageScanRulesetType <ScanRulesetType?>]`: + - `[AzureSubscriptionCredentialReferenceName <String>]`: + - `[AzureSubscriptionCredentialType <CredentialType?>]`: + - `[AzureSubscriptionResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterResource <String[]>]`: + - `[AzureSubscriptionScanRulesetName <String>]`: + - `[AzureSubscriptionScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseCredentialReferenceName <String>]`: + - `[AzureSynapseCredentialType <CredentialType?>]`: + - `[AzureSynapseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterResource <String[]>]`: + - `[AzureSynapseScanRulesetName <String>]`: + - `[AzureSynapseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseWorkspaceCredentialReferenceName <String>]`: + - `[AzureSynapseWorkspaceCredentialType <CredentialType?>]`: + - `[AzureSynapseWorkspaceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterResource <String[]>]`: + - `[AzureSynapseWorkspaceScanRulesetName <String>]`: + - `[AzureSynapseWorkspaceScanRulesetType <ScanRulesetType?>]`: + - `[NoneCredentialReferenceName <String>]`: + - `[NoneCredentialType <CredentialType?>]`: + - `[NoneResourceNameFilterExcludePrefix <String[]>]`: + - `[NoneResourceNameFilterIncludePrefix <String[]>]`: + - `[NoneResourceNameFilterResource <String[]>]`: + - `[NoneScanRulesetName <String>]`: + - `[NoneScanRulesetType <ScanRulesetType?>]`: + - `[OracleCredentialReferenceName <String>]`: + - `[OracleCredentialType <CredentialType?>]`: + - `[OracleResourceNameFilterExcludePrefix <String[]>]`: + - `[OracleResourceNameFilterIncludePrefix <String[]>]`: + - `[OracleResourceNameFilterResource <String[]>]`: + - `[OracleScanRulesetName <String>]`: + - `[OracleScanRulesetType <ScanRulesetType?>]`: + - `[PowerBiCredentialReferenceName <String>]`: + - `[PowerBiCredentialType <CredentialType?>]`: + - `[PowerBiResourceNameFilterExcludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterIncludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterResource <String[]>]`: + - `[PowerBiScanRulesetName <String>]`: + - `[PowerBiScanRulesetType <ScanRulesetType?>]`: + - `[SapEccCredentialReferenceName <String>]`: + - `[SapEccCredentialType <CredentialType?>]`: + - `[SapEccResourceNameFilterExcludePrefix <String[]>]`: + - `[SapEccResourceNameFilterIncludePrefix <String[]>]`: + - `[SapEccResourceNameFilterResource <String[]>]`: + - `[SapEccScanRulesetName <String>]`: + - `[SapEccScanRulesetType <ScanRulesetType?>]`: + - `[SapS4HanaCredentialReferenceName <String>]`: + - `[SapS4HanaCredentialType <CredentialType?>]`: + - `[SapS4HanaResourceNameFilterExcludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterIncludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterResource <String[]>]`: + - `[SapS4HanaScanRulesetName <String>]`: + - `[SapS4HanaScanRulesetType <ScanRulesetType?>]`: + - `[SqlServerDatabaseCredentialReferenceName <String>]`: + - `[SqlServerDatabaseCredentialType <CredentialType?>]`: + - `[SqlServerDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterResource <String[]>]`: + - `[SqlServerDatabaseScanRulesetName <String>]`: + - `[SqlServerDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[TeradataCredentialReferenceName <String>]`: + - `[TeradataCredentialType <CredentialType?>]`: + - `[TeradataResourceNameFilterExcludePrefix <String[]>]`: + - `[TeradataResourceNameFilterIncludePrefix <String[]>]`: + - `[TeradataResourceNameFilterResource <String[]>]`: + - `[TeradataScanRulesetName <String>]`: + - `[TeradataScanRulesetType <ScanRulesetType?>]`: + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSynapseWorkspaceCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSynapseWorkspaceCredentialScanObject.md new file mode 100644 index 0000000000..7666a737c3 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSynapseWorkspaceCredentialScanObject.md @@ -0,0 +1,404 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSynapseWorkspaceCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSynapseWorkspaceCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSynapseWorkspaceCredentialScanObject.md +--- + +# New-AzPurviewAzureSynapseWorkspaceCredentialScanObject + +## SYNOPSIS +Create an in-memory object for AzureSynapseWorkspaceCredentialScan. + +## SYNTAX + +``` +New-AzPurviewAzureSynapseWorkspaceCredentialScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] + [-ResourceType <IExpandingResourceScanPropertiesResourceTypes>] [-ScanRulesetName <String>] + [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSynapseWorkspaceCredentialScan. + +## EXAMPLES + +### Example 1: Create Azure Synapse Workspace Credential scan object +```powershell +New-AzPurviewAzureSynapseWorkspaceCredentialScanObject -Kind 'AzureSynapseWorkspaceCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialType 'ServicePrincipal' -CredentialReferenceName 'svcp' -ScanRulesetName 'AzureSynapseSQL' -ScanRulesetType 'System' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : svcp +CredentialType : ServicePrincipal +Id : +Kind : AzureSynapseWorkspaceCredential +LastModifiedAt : +Name : +ResourceType : { + } +Result : +ScanRulesetName : AzureSynapseSQL +ScanRulesetType : System +Worker : +``` + +Create Azure Synapse Workspace Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +To construct, see NOTES section for RESOURCETYPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IExpandingResourceScanPropertiesResourceTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSynapseWorkspaceCredentialScan + +## 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. + + +RESOURCETYPE `<IExpandingResourceScanPropertiesResourceTypes>`: + - `[AdlGen1ScanRulesetName <String>]`: + - `[AdlGen1ScanRulesetType <ScanRulesetType?>]`: + - `[AdlGen2ScanRulesetName <String>]`: + - `[AdlGen2ScanRulesetType <ScanRulesetType?>]`: + - `[AdlsGen1CredentialReferenceName <String>]`: + - `[AdlsGen1CredentialType <CredentialType?>]`: + - `[AdlsGen1ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterResource <String[]>]`: + - `[AdlsGen2CredentialReferenceName <String>]`: + - `[AdlsGen2CredentialType <CredentialType?>]`: + - `[AdlsGen2ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterResource <String[]>]`: + - `[AmazonAccountCredentialReferenceName <String>]`: + - `[AmazonAccountCredentialType <CredentialType?>]`: + - `[AmazonAccountResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterResource <String[]>]`: + - `[AmazonAccountScanRulesetName <String>]`: + - `[AmazonAccountScanRulesetType <ScanRulesetType?>]`: + - `[AmazonPostgreSqlCredentialReferenceName <String>]`: + - `[AmazonPostgreSqlCredentialType <CredentialType?>]`: + - `[AmazonPostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterResource <String[]>]`: + - `[AmazonPostgreSqlScanRulesetName <String>]`: + - `[AmazonPostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AmazonS3CredentialReferenceName <String>]`: + - `[AmazonS3CredentialType <CredentialType?>]`: + - `[AmazonS3ResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterResource <String[]>]`: + - `[AmazonS3ScanRulesetName <String>]`: + - `[AmazonS3ScanRulesetType <ScanRulesetType?>]`: + - `[AmazonSqlCredentialReferenceName <String>]`: + - `[AmazonSqlCredentialType <CredentialType?>]`: + - `[AmazonSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterResource <String[]>]`: + - `[AmazonSqlScanRulesetName <String>]`: + - `[AmazonSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmoDbScanRulesetName <String>]`: + - `[AzureCosmoDbScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmosDbCredentialReferenceName <String>]`: + - `[AzureCosmosDbCredentialType <CredentialType?>]`: + - `[AzureCosmosDbResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerCredentialReferenceName <String>]`: + - `[AzureDataExplorerCredentialType <CredentialType?>]`: + - `[AzureDataExplorerResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerScanRulesetName <String>]`: + - `[AzureDataExplorerScanRulesetType <ScanRulesetType?>]`: + - `[AzureFileServiceCredentialReferenceName <String>]`: + - `[AzureFileServiceCredentialType <CredentialType?>]`: + - `[AzureFileServiceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterResource <String[]>]`: + - `[AzureFileServiceScanRulesetName <String>]`: + - `[AzureFileServiceScanRulesetType <ScanRulesetType?>]`: + - `[AzureMySqlCredentialReferenceName <String>]`: + - `[AzureMySqlCredentialType <CredentialType?>]`: + - `[AzureMySqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterResource <String[]>]`: + - `[AzureMySqlScanRulesetName <String>]`: + - `[AzureMySqlScanRulesetType <ScanRulesetType?>]`: + - `[AzurePostgreSqlCredentialReferenceName <String>]`: + - `[AzurePostgreSqlCredentialType <CredentialType?>]`: + - `[AzurePostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterResource <String[]>]`: + - `[AzurePostgreSqlScanRulesetName <String>]`: + - `[AzurePostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureResourceGroupCredentialReferenceName <String>]`: + - `[AzureResourceGroupCredentialType <CredentialType?>]`: + - `[AzureResourceGroupResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterResource <String[]>]`: + - `[AzureResourceGroupScanRulesetName <String>]`: + - `[AzureResourceGroupScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDataWarehouseCredentialReferenceName <String>]`: + - `[AzureSqlDataWarehouseCredentialType <CredentialType?>]`: + - `[AzureSqlDataWarehouseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDataWarehouseScanRulesetName <String>]`: + - `[AzureSqlDataWarehouseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetName <String>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseScanRulesetName <String>]`: + - `[AzureSqlDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[AzureStorageCredentialReferenceName <String>]`: + - `[AzureStorageCredentialType <CredentialType?>]`: + - `[AzureStorageResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterResource <String[]>]`: + - `[AzureStorageScanRulesetName <String>]`: + - `[AzureStorageScanRulesetType <ScanRulesetType?>]`: + - `[AzureSubscriptionCredentialReferenceName <String>]`: + - `[AzureSubscriptionCredentialType <CredentialType?>]`: + - `[AzureSubscriptionResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterResource <String[]>]`: + - `[AzureSubscriptionScanRulesetName <String>]`: + - `[AzureSubscriptionScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseCredentialReferenceName <String>]`: + - `[AzureSynapseCredentialType <CredentialType?>]`: + - `[AzureSynapseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterResource <String[]>]`: + - `[AzureSynapseScanRulesetName <String>]`: + - `[AzureSynapseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseWorkspaceCredentialReferenceName <String>]`: + - `[AzureSynapseWorkspaceCredentialType <CredentialType?>]`: + - `[AzureSynapseWorkspaceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterResource <String[]>]`: + - `[AzureSynapseWorkspaceScanRulesetName <String>]`: + - `[AzureSynapseWorkspaceScanRulesetType <ScanRulesetType?>]`: + - `[NoneCredentialReferenceName <String>]`: + - `[NoneCredentialType <CredentialType?>]`: + - `[NoneResourceNameFilterExcludePrefix <String[]>]`: + - `[NoneResourceNameFilterIncludePrefix <String[]>]`: + - `[NoneResourceNameFilterResource <String[]>]`: + - `[NoneScanRulesetName <String>]`: + - `[NoneScanRulesetType <ScanRulesetType?>]`: + - `[OracleCredentialReferenceName <String>]`: + - `[OracleCredentialType <CredentialType?>]`: + - `[OracleResourceNameFilterExcludePrefix <String[]>]`: + - `[OracleResourceNameFilterIncludePrefix <String[]>]`: + - `[OracleResourceNameFilterResource <String[]>]`: + - `[OracleScanRulesetName <String>]`: + - `[OracleScanRulesetType <ScanRulesetType?>]`: + - `[PowerBiCredentialReferenceName <String>]`: + - `[PowerBiCredentialType <CredentialType?>]`: + - `[PowerBiResourceNameFilterExcludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterIncludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterResource <String[]>]`: + - `[PowerBiScanRulesetName <String>]`: + - `[PowerBiScanRulesetType <ScanRulesetType?>]`: + - `[SapEccCredentialReferenceName <String>]`: + - `[SapEccCredentialType <CredentialType?>]`: + - `[SapEccResourceNameFilterExcludePrefix <String[]>]`: + - `[SapEccResourceNameFilterIncludePrefix <String[]>]`: + - `[SapEccResourceNameFilterResource <String[]>]`: + - `[SapEccScanRulesetName <String>]`: + - `[SapEccScanRulesetType <ScanRulesetType?>]`: + - `[SapS4HanaCredentialReferenceName <String>]`: + - `[SapS4HanaCredentialType <CredentialType?>]`: + - `[SapS4HanaResourceNameFilterExcludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterIncludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterResource <String[]>]`: + - `[SapS4HanaScanRulesetName <String>]`: + - `[SapS4HanaScanRulesetType <ScanRulesetType?>]`: + - `[SqlServerDatabaseCredentialReferenceName <String>]`: + - `[SqlServerDatabaseCredentialType <CredentialType?>]`: + - `[SqlServerDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterResource <String[]>]`: + - `[SqlServerDatabaseScanRulesetName <String>]`: + - `[SqlServerDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[TeradataCredentialReferenceName <String>]`: + - `[TeradataCredentialType <CredentialType?>]`: + - `[TeradataResourceNameFilterExcludePrefix <String[]>]`: + - `[TeradataResourceNameFilterIncludePrefix <String[]>]`: + - `[TeradataResourceNameFilterResource <String[]>]`: + - `[TeradataScanRulesetName <String>]`: + - `[TeradataScanRulesetType <ScanRulesetType?>]`: + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSynapseWorkspaceDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSynapseWorkspaceDataSourceObject.md new file mode 100644 index 0000000000..ffda6b0ca9 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSynapseWorkspaceDataSourceObject.md @@ -0,0 +1,194 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSynapseWorkspaceDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSynapseWorkspaceDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSynapseWorkspaceDataSourceObject.md +--- + +# New-AzPurviewAzureSynapseWorkspaceDataSourceObject + +## SYNOPSIS +Create an in-memory object for AzureSynapseWorkspaceDataSource. + +## SYNTAX + +``` +New-AzPurviewAzureSynapseWorkspaceDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-DedicatedSqlEndpoint <String>] [-Location <String>] [-ResourceGroup <String>] + [-ResourceName <String>] [-ServerlessSqlEndpoint <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSynapseWorkspaceDataSource. + +## EXAMPLES + +### Example 1: Create Azure Synapse workspace data source object +```powershell +New-AzPurviewAzureSynapseWorkspaceDataSourceObject -Kind 'AzureSynapseWorkspace' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -DedicatedSqlEndpoint 'g1euap.sql.azuresynapse.net' -ServerlessSqlEndpoint 'rg1euap-ondemand.sql.azuresynapse.net' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +DedicatedSqlEndpoint : g1euap.sql.azuresynapse.net +Id : +Kind : AzureSynapseWorkspace +LastModifiedAt : +Location : +Name : +ResourceGroup : +ResourceName : +Scan : +ServerlessSqlEndpoint : rg1euap-ondemand.sql.azuresynapse.net +SubscriptionId : +``` + +Create Azure Synapse workspace data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DedicatedSqlEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerlessSqlEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSynapseWorkspaceDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSynapseWorkspaceMsiScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSynapseWorkspaceMsiScanObject.md new file mode 100644 index 0000000000..fe9369322c --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSynapseWorkspaceMsiScanObject.md @@ -0,0 +1,404 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSynapseWorkspaceMsiScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSynapseWorkspaceMsiScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSynapseWorkspaceMsiScanObject.md +--- + +# New-AzPurviewAzureSynapseWorkspaceMsiScanObject + +## SYNOPSIS +Create an in-memory object for AzureSynapseWorkspaceMsiScan. + +## SYNTAX + +``` +New-AzPurviewAzureSynapseWorkspaceMsiScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] + [-ResourceType <IExpandingResourceScanPropertiesResourceTypes>] [-ScanRulesetName <String>] + [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSynapseWorkspaceMsiScan. + +## EXAMPLES + +### Example 1: Create Azure Synapse Workspace Msi scan object +```powershell +New-AzPurviewAzureSynapseWorkspaceMsiScanObject -Kind 'AzureSynapseWorkspaceMsi' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ScanRulesetName 'AzureSynapseSQL' -ScanRulesetType 'System' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +CredentialReferenceName : +CredentialType : +Id : +Kind : AzureSynapseWorkspaceMsi +LastModifiedAt : +Name : +ResourceType : { + } +Result : +ScanRulesetName : AzureSynapseSQL +ScanRulesetType : System +Worker : +``` + +Create Azure Synapse Workspace Msi scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +To construct, see NOTES section for RESOURCETYPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IExpandingResourceScanPropertiesResourceTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSynapseWorkspaceMsiScan + +## 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. + + +RESOURCETYPE `<IExpandingResourceScanPropertiesResourceTypes>`: + - `[AdlGen1ScanRulesetName <String>]`: + - `[AdlGen1ScanRulesetType <ScanRulesetType?>]`: + - `[AdlGen2ScanRulesetName <String>]`: + - `[AdlGen2ScanRulesetType <ScanRulesetType?>]`: + - `[AdlsGen1CredentialReferenceName <String>]`: + - `[AdlsGen1CredentialType <CredentialType?>]`: + - `[AdlsGen1ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen1ResourceNameFilterResource <String[]>]`: + - `[AdlsGen2CredentialReferenceName <String>]`: + - `[AdlsGen2CredentialType <CredentialType?>]`: + - `[AdlsGen2ResourceNameFilterExcludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterIncludePrefix <String[]>]`: + - `[AdlsGen2ResourceNameFilterResource <String[]>]`: + - `[AmazonAccountCredentialReferenceName <String>]`: + - `[AmazonAccountCredentialType <CredentialType?>]`: + - `[AmazonAccountResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonAccountResourceNameFilterResource <String[]>]`: + - `[AmazonAccountScanRulesetName <String>]`: + - `[AmazonAccountScanRulesetType <ScanRulesetType?>]`: + - `[AmazonPostgreSqlCredentialReferenceName <String>]`: + - `[AmazonPostgreSqlCredentialType <CredentialType?>]`: + - `[AmazonPostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonPostgreSqlResourceNameFilterResource <String[]>]`: + - `[AmazonPostgreSqlScanRulesetName <String>]`: + - `[AmazonPostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AmazonS3CredentialReferenceName <String>]`: + - `[AmazonS3CredentialType <CredentialType?>]`: + - `[AmazonS3ResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonS3ResourceNameFilterResource <String[]>]`: + - `[AmazonS3ScanRulesetName <String>]`: + - `[AmazonS3ScanRulesetType <ScanRulesetType?>]`: + - `[AmazonSqlCredentialReferenceName <String>]`: + - `[AmazonSqlCredentialType <CredentialType?>]`: + - `[AmazonSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AmazonSqlResourceNameFilterResource <String[]>]`: + - `[AmazonSqlScanRulesetName <String>]`: + - `[AmazonSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmoDbScanRulesetName <String>]`: + - `[AzureCosmoDbScanRulesetType <ScanRulesetType?>]`: + - `[AzureCosmosDbCredentialReferenceName <String>]`: + - `[AzureCosmosDbCredentialType <CredentialType?>]`: + - `[AzureCosmosDbResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureCosmosDbResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerCredentialReferenceName <String>]`: + - `[AzureDataExplorerCredentialType <CredentialType?>]`: + - `[AzureDataExplorerResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureDataExplorerResourceNameFilterResource <String[]>]`: + - `[AzureDataExplorerScanRulesetName <String>]`: + - `[AzureDataExplorerScanRulesetType <ScanRulesetType?>]`: + - `[AzureFileServiceCredentialReferenceName <String>]`: + - `[AzureFileServiceCredentialType <CredentialType?>]`: + - `[AzureFileServiceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureFileServiceResourceNameFilterResource <String[]>]`: + - `[AzureFileServiceScanRulesetName <String>]`: + - `[AzureFileServiceScanRulesetType <ScanRulesetType?>]`: + - `[AzureMySqlCredentialReferenceName <String>]`: + - `[AzureMySqlCredentialType <CredentialType?>]`: + - `[AzureMySqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureMySqlResourceNameFilterResource <String[]>]`: + - `[AzureMySqlScanRulesetName <String>]`: + - `[AzureMySqlScanRulesetType <ScanRulesetType?>]`: + - `[AzurePostgreSqlCredentialReferenceName <String>]`: + - `[AzurePostgreSqlCredentialType <CredentialType?>]`: + - `[AzurePostgreSqlResourceNameFilterExcludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterIncludePrefix <String[]>]`: + - `[AzurePostgreSqlResourceNameFilterResource <String[]>]`: + - `[AzurePostgreSqlScanRulesetName <String>]`: + - `[AzurePostgreSqlScanRulesetType <ScanRulesetType?>]`: + - `[AzureResourceGroupCredentialReferenceName <String>]`: + - `[AzureResourceGroupCredentialType <CredentialType?>]`: + - `[AzureResourceGroupResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureResourceGroupResourceNameFilterResource <String[]>]`: + - `[AzureResourceGroupScanRulesetName <String>]`: + - `[AzureResourceGroupScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDataWarehouseCredentialReferenceName <String>]`: + - `[AzureSqlDataWarehouseCredentialType <CredentialType?>]`: + - `[AzureSqlDataWarehouseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDataWarehouseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDataWarehouseScanRulesetName <String>]`: + - `[AzureSqlDataWarehouseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialReferenceName <String>]`: + - `[AzureSqlDatabaseManagedInstanceCredentialType <CredentialType?>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetName <String>]`: + - `[AzureSqlDatabaseManagedInstanceScanRulesetType <ScanRulesetType?>]`: + - `[AzureSqlDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSqlDatabaseResourceNameFilterResource <String[]>]`: + - `[AzureSqlDatabaseScanRulesetName <String>]`: + - `[AzureSqlDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[AzureStorageCredentialReferenceName <String>]`: + - `[AzureStorageCredentialType <CredentialType?>]`: + - `[AzureStorageResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureStorageResourceNameFilterResource <String[]>]`: + - `[AzureStorageScanRulesetName <String>]`: + - `[AzureStorageScanRulesetType <ScanRulesetType?>]`: + - `[AzureSubscriptionCredentialReferenceName <String>]`: + - `[AzureSubscriptionCredentialType <CredentialType?>]`: + - `[AzureSubscriptionResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSubscriptionResourceNameFilterResource <String[]>]`: + - `[AzureSubscriptionScanRulesetName <String>]`: + - `[AzureSubscriptionScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseCredentialReferenceName <String>]`: + - `[AzureSynapseCredentialType <CredentialType?>]`: + - `[AzureSynapseResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseResourceNameFilterResource <String[]>]`: + - `[AzureSynapseScanRulesetName <String>]`: + - `[AzureSynapseScanRulesetType <ScanRulesetType?>]`: + - `[AzureSynapseWorkspaceCredentialReferenceName <String>]`: + - `[AzureSynapseWorkspaceCredentialType <CredentialType?>]`: + - `[AzureSynapseWorkspaceResourceNameFilterExcludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterIncludePrefix <String[]>]`: + - `[AzureSynapseWorkspaceResourceNameFilterResource <String[]>]`: + - `[AzureSynapseWorkspaceScanRulesetName <String>]`: + - `[AzureSynapseWorkspaceScanRulesetType <ScanRulesetType?>]`: + - `[NoneCredentialReferenceName <String>]`: + - `[NoneCredentialType <CredentialType?>]`: + - `[NoneResourceNameFilterExcludePrefix <String[]>]`: + - `[NoneResourceNameFilterIncludePrefix <String[]>]`: + - `[NoneResourceNameFilterResource <String[]>]`: + - `[NoneScanRulesetName <String>]`: + - `[NoneScanRulesetType <ScanRulesetType?>]`: + - `[OracleCredentialReferenceName <String>]`: + - `[OracleCredentialType <CredentialType?>]`: + - `[OracleResourceNameFilterExcludePrefix <String[]>]`: + - `[OracleResourceNameFilterIncludePrefix <String[]>]`: + - `[OracleResourceNameFilterResource <String[]>]`: + - `[OracleScanRulesetName <String>]`: + - `[OracleScanRulesetType <ScanRulesetType?>]`: + - `[PowerBiCredentialReferenceName <String>]`: + - `[PowerBiCredentialType <CredentialType?>]`: + - `[PowerBiResourceNameFilterExcludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterIncludePrefix <String[]>]`: + - `[PowerBiResourceNameFilterResource <String[]>]`: + - `[PowerBiScanRulesetName <String>]`: + - `[PowerBiScanRulesetType <ScanRulesetType?>]`: + - `[SapEccCredentialReferenceName <String>]`: + - `[SapEccCredentialType <CredentialType?>]`: + - `[SapEccResourceNameFilterExcludePrefix <String[]>]`: + - `[SapEccResourceNameFilterIncludePrefix <String[]>]`: + - `[SapEccResourceNameFilterResource <String[]>]`: + - `[SapEccScanRulesetName <String>]`: + - `[SapEccScanRulesetType <ScanRulesetType?>]`: + - `[SapS4HanaCredentialReferenceName <String>]`: + - `[SapS4HanaCredentialType <CredentialType?>]`: + - `[SapS4HanaResourceNameFilterExcludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterIncludePrefix <String[]>]`: + - `[SapS4HanaResourceNameFilterResource <String[]>]`: + - `[SapS4HanaScanRulesetName <String>]`: + - `[SapS4HanaScanRulesetType <ScanRulesetType?>]`: + - `[SqlServerDatabaseCredentialReferenceName <String>]`: + - `[SqlServerDatabaseCredentialType <CredentialType?>]`: + - `[SqlServerDatabaseResourceNameFilterExcludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterIncludePrefix <String[]>]`: + - `[SqlServerDatabaseResourceNameFilterResource <String[]>]`: + - `[SqlServerDatabaseScanRulesetName <String>]`: + - `[SqlServerDatabaseScanRulesetType <ScanRulesetType?>]`: + - `[TeradataCredentialReferenceName <String>]`: + - `[TeradataCredentialType <CredentialType?>]`: + - `[TeradataResourceNameFilterExcludePrefix <String[]>]`: + - `[TeradataResourceNameFilterIncludePrefix <String[]>]`: + - `[TeradataResourceNameFilterResource <String[]>]`: + - `[TeradataScanRulesetName <String>]`: + - `[TeradataScanRulesetType <ScanRulesetType?>]`: + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewAzureSynapseWorkspaceScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSynapseWorkspaceScanRulesetObject.md new file mode 100644 index 0000000000..4d216bb428 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewAzureSynapseWorkspaceScanRulesetObject.md @@ -0,0 +1,134 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewAzureSynapseWorkspaceScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSynapseWorkspaceScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewAzureSynapseWorkspaceScanRulesetObject.md +--- + +# New-AzPurviewAzureSynapseWorkspaceScanRulesetObject + +## SYNOPSIS +Create an in-memory object for AzureSynapseWorkspaceScanRuleset. + +## SYNTAX + +``` +New-AzPurviewAzureSynapseWorkspaceScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureSynapseWorkspaceScanRuleset. + +## EXAMPLES + +### Example 1: Create Azure Synapse Workspace custom scanruleset object +```powershell +New-AzPurviewAzureSynapseWorkspaceScanRulesetObject -Kind 'AzureSynapseWorkspace' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AzureSynapseWorkspace +LastModifiedAt : +Name : +Status : +Type : Custom +Version : +``` + +Create Azure Synapse Workspace custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.AzureSynapseWorkspaceScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewClassificationRule.md b/azps-10.1.0/Az.Purview/New-AzPurviewClassificationRule.md new file mode 100644 index 0000000000..9481b1e7a8 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewClassificationRule.md @@ -0,0 +1,178 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/new-azpurviewclassificationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewClassificationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewClassificationRule.md +--- + +# New-AzPurviewClassificationRule + +## SYNOPSIS +Creates or Updates a classification rule + +## SYNTAX + +``` +New-AzPurviewClassificationRule -Endpoint <String> -Name <String> -Body <IClassificationRule> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or Updates a classification rule + +## EXAMPLES + +### Example 1: Create custom classification object +```powershell +$reg1 = New-AzPurviewRegexClassificationRulePatternObject -Pattern '^col1$' +$reg2 = New-AzPurviewRegexClassificationRulePatternObject -Pattern '^col2$' +$regexarr = @($reg1, $reg2) +$obj = New-AzPurviewCustomClassificationRuleObject -Kind 'Custom' -ClassificationName ClassificationRule4 -RuleStatus 'Enabled' -Description 'This is a rule2' -ColumnPattern $regexarr +New-AzPurviewClassificationRule -Endpoint https://parv-brs-2.purview.azure.com -ClassificationRuleName ClassificationRule5 -Body $obj +``` + +```output +ClassificationAction : Keep +ClassificationName : ClassificationRule4 +ColumnPattern : {{ + "kind": "Regex", + "pattern": "^col1$" + }, { + "kind": "Regex", + "pattern": "^col2$" + }} +CreatedAt : 2/8/2022 10:04:55 PM +DataPattern : {} +Description : This is a rule2 +Id : classificationrules/ClassificationRule5 +Kind : Custom +LastModifiedAt : 2/14/2022 9:00:32 AM +MinimumPercentageMatch : +Name : ClassificationRule5 +RuleStatus : Enabled +Version : 2 +``` + +Create custom classification object named 'ClassificationRule4' + +## PARAMETERS + +### -Body +. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IClassificationRule +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClassificationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IClassificationRule + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IClassificationRule + +## 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. + + +BODY `<IClassificationRule>`: . + - `Kind <ClassificationRuleType>`: + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewCustomClassificationRuleObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewCustomClassificationRuleObject.md new file mode 100644 index 0000000000..1d30096200 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewCustomClassificationRuleObject.md @@ -0,0 +1,174 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewCustomClassificationRuleObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewCustomClassificationRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewCustomClassificationRuleObject.md +--- + +# New-AzPurviewCustomClassificationRuleObject + +## SYNOPSIS +Create an in-memory object for CustomClassificationRule. + +## SYNTAX + +``` +New-AzPurviewCustomClassificationRuleObject -Kind <ClassificationRuleType> [-ClassificationName <String>] + [-ColumnPattern <IClassificationRulePattern[]>] [-DataPattern <IClassificationRulePattern[]>] + [-Description <String>] [-MinimumPercentageMatch <Double>] [-RuleStatus <ClassificationRuleStatus>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for CustomClassificationRule. + +## EXAMPLES + +### Example 1: Create custom classification rule object +```powershell +$reg1 = New-AzPurviewRegexClassificationRulePatternObject -Pattern '^col1$' +$reg2 = New-AzPurviewRegexClassificationRulePatternObject -Pattern '^col2$' +$regexarr = @($reg1, $reg2) +New-AzPurviewCustomClassificationRuleObject -Kind 'Custom' -ClassificationName ClassificationRule4 -MinimumPercentageMatch 60 -RuleStatus 'Enabled' -Description 'This is a rule2' -ColumnPattern $regexarr +``` + +```output +ClassificationAction : +ClassificationName : ClassificationRule4 +ColumnPattern : {{ + "kind": "Regex", + "pattern": "^col1$" + }, { + "kind": "Regex", + "pattern": "^col2$" + }} +CreatedAt : +DataPattern : +Description : This is a rule2 +Id : +Kind : Custom +LastModifiedAt : +MinimumPercentageMatch : 60 +Name : +RuleStatus : Enabled +Version : +``` + +Create custom classification rule object + +## PARAMETERS + +### -ClassificationName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ColumnPattern + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IClassificationRulePattern[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataPattern + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IClassificationRulePattern[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ClassificationRuleType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumPercentageMatch + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleStatus + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ClassificationRuleStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.CustomClassificationRule + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewDataSource.md b/azps-10.1.0/Az.Purview/New-AzPurviewDataSource.md new file mode 100644 index 0000000000..759c97faef --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewDataSource.md @@ -0,0 +1,170 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/new-azpurviewdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewDataSource.md +--- + +# New-AzPurviewDataSource + +## SYNOPSIS +Creates or Updates a data source + +## SYNTAX + +``` +New-AzPurviewDataSource -Endpoint <String> -Name <String> -Body <IDataSource> [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or Updates a data source + +## EXAMPLES + +### Example 1: Create a data source +```powershell +$obj = New-AzPurviewAzureStorageDataSourceObject -Kind 'AzureStorage' -CollectionReferenceName parv-brs-2 -CollectionType 'CollectionReference' -Endpoint https://datascantest.blob.core.windows.net/ +New-AzPurviewDataSource -Endpoint 'https://parv-brs-2.purview.azure.com/' -Name 'NewDataSource' -Body $obj +``` + +```output +CollectionLastModifiedAt : 2/15/2022 10:36:25 AM +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : 2/15/2022 10:36:25 AM +Endpoint : https://datascantest.blob.core.windows.net/ +Id : datasources/NewDataSource +Kind : AzureStorage +LastModifiedAt : 2/15/2022 10:36:25 AM +Location : +Name : NewDataSource +ResourceGroup : +ResourceName : +Scan : +SubscriptionId : +``` + +Create a data source named 'NewDataSource' + +## PARAMETERS + +### -Body +. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IDataSource +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DataSourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IDataSource + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IDataSource + +## 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. + + +BODY `<IDataSource>`: . + - `Kind <DataSourceType>`: + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewFilter.md b/azps-10.1.0/Az.Purview/New-AzPurviewFilter.md new file mode 100644 index 0000000000..aea5a10b08 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewFilter.md @@ -0,0 +1,177 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/new-azpurviewfilter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewFilter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewFilter.md +--- + +# New-AzPurviewFilter + +## SYNOPSIS +Creates or updates a filter + +## SYNTAX + +``` +New-AzPurviewFilter -Endpoint <String> -DataSourceName <String> -ScanName <String> -Body <IFilter> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a filter + +## EXAMPLES + +### Example 1: Create the scope filters of the scan +```powershell +$filterObj = New-AzPurviewFilterObject -ExcludeUriPrefix @('https://foo.file.core.windows.net/share1/user/temp') -IncludeUriPrefix @('https://foo.file.core.windows.net/share1/user','https://foo.file.core.windows.net/share1/aggregated') +New-AzPurviewFilter -Endpoint 'https://parv-brs-2.purview.azure.com/' -DataSourceName 'DataScanTestData-Parv' -ScanName 'Scan1ForDemo' -Body $filterObj +``` + +```output +ExcludeUriPrefix : {https://foo.file.core.windows.net/share1/user/temp} +Id : datasources/DataScanTestData-Parv/scans/Scan1ForDemo/filters/custom +IncludeUriPrefix : {https://foo.file.core.windows.net/share1/user, + https://foo.file.core.windows.net/share1/aggregated} +Name : custom +``` + +Create the scope filters of the scan named 'Scan1ForDemo' for datasource 'DataScanTestData' + +## PARAMETERS + +### -Body +. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IFilter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataSourceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IFilter + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IFilter + +## 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. + + +BODY `<IFilter>`: . + - `[ExcludeUriPrefix <String[]>]`: + - `[IncludeUriPrefix <String[]>]`: + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewFilterObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewFilterObject.md new file mode 100644 index 0000000000..6cabf70b6f --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewFilterObject.md @@ -0,0 +1,84 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewFilterObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewFilterObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewFilterObject.md +--- + +# New-AzPurviewFilterObject + +## SYNOPSIS +Create an in-memory object for Filter. + +## SYNTAX + +``` +New-AzPurviewFilterObject [-ExcludeUriPrefix <String[]>] [-IncludeUriPrefix <String[]>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for Filter. + +## EXAMPLES + +### Example 1: Create filter object +```powershell +New-AzPurviewFilterObject -ExcludeUriPrefix @('https://foo.file.core.windows.net/share1/user/temp') -IncludeUriPrefix @('https://foo.file.core.windows.net/share1/user','https://foo.file.core.windows.net/share1/aggregated') +``` + +```output +ExcludeUriPrefix : {https://foo.file.core.windows.net/share1/user/temp} +Id : +IncludeUriPrefix : {https://foo.file.core.windows.net/share1/user, + https://foo.file.core.windows.net/share1/aggregated} +Name : +``` + +Create filter object + +## PARAMETERS + +### -ExcludeUriPrefix + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeUriPrefix + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.Filter + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewKeyVaultConnection.md b/azps-10.1.0/Az.Purview/New-AzPurviewKeyVaultConnection.md new file mode 100644 index 0000000000..e57425e205 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewKeyVaultConnection.md @@ -0,0 +1,161 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/new-azpurviewkeyvaultconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewKeyVaultConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewKeyVaultConnection.md +--- + +# New-AzPurviewKeyVaultConnection + +## SYNOPSIS +Creates an instance of a key vault connection + +## SYNTAX + +``` +New-AzPurviewKeyVaultConnection -Endpoint <String> -KeyVaultName <String> -Body <IAzureKeyVault> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an instance of a key vault connection + +## EXAMPLES + +### Example 1: Create a key vault connection +```powershell +$kvConn = New-AzPurviewAzureKeyVaultObject -BaseUrl 'https://datascankv.vault.azure.net/' -Description 'This is a key vault' +New-AzPurviewKeyVaultConnection -Endpoint 'https://parv-brs-2.purview.azure.com/' -KeyVaultName KeyVaultConnection2 -Body $kvConn +``` + +```output +BaseUrl : https://datascankv.vault.azure.net/ +Description : This is a key vault +Id : keyVaults/KeyVaultConnection2 +Name : KeyVaultConnection2 +``` + +Create a key vault connection named 'KeyVaultConnection2' in Purview. + +## PARAMETERS + +### -Body +. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IAzureKeyVault +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IAzureKeyVault + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IAzureKeyVault + +## 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. + + +BODY `<IAzureKeyVault>`: . + - `[BaseUrl <String>]`: + - `[Description <String>]`: + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewOracleDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewOracleDataSourceObject.md new file mode 100644 index 0000000000..b4f01697a7 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewOracleDataSourceObject.md @@ -0,0 +1,148 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewOracleDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewOracleDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewOracleDataSourceObject.md +--- + +# New-AzPurviewOracleDataSourceObject + +## SYNOPSIS +Create an in-memory object for OracleDataSource. + +## SYNTAX + +``` +New-AzPurviewOracleDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Host <String>] [-Port <String>] [-Service <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for OracleDataSource. + +## EXAMPLES + +### Example 1: Create Azure Synapse workspace data source object +```powershell +New-AzPurviewOracleDataSourceObject -Kind 'Oracle' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -Host '13.1.0.46' -Port 1521 -Service 'xe' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Host : 13.1.0.46 +Id : +Kind : Oracle +LastModifiedAt : +Name : +Port : 1521 +Scan : +Service : xe +``` + +Create Azure Synapse workspace data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Host + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Service + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.OracleDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewPowerBIDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewPowerBIDataSourceObject.md new file mode 100644 index 0000000000..530e995f5c --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewPowerBIDataSourceObject.md @@ -0,0 +1,118 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewPowerBIDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewPowerBIDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewPowerBIDataSourceObject.md +--- + +# New-AzPurviewPowerBIDataSourceObject + +## SYNOPSIS +Create an in-memory object for PowerBIDataSource. + +## SYNTAX + +``` +New-AzPurviewPowerBIDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Tenant <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for PowerBIDataSource. + +## EXAMPLES + +### Example 1: Create PowerBI data source object +```powershell +New-AzPurviewPowerBIDataSourceObject -Kind 'PowerBI' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -Tenant 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : PowerBI +LastModifiedAt : +Name : +Scan : +Tenant : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx +``` + +Create PowerBI data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.PowerBiDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewPowerBIDelegatedScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewPowerBIDelegatedScanObject.md new file mode 100644 index 0000000000..f8c50eb0e1 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewPowerBIDelegatedScanObject.md @@ -0,0 +1,256 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewPowerBIDelegatedScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewPowerBIDelegatedScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewPowerBIDelegatedScanObject.md +--- + +# New-AzPurviewPowerBIDelegatedScanObject + +## SYNOPSIS +Create an in-memory object for PowerBIDelegatedScan. + +## SYNTAX + +``` +New-AzPurviewPowerBIDelegatedScanObject -Kind <ScanAuthorizationType> [-AuthenticationType <String>] + [-ClientId <String>] [-CollectionReferenceName <String>] [-CollectionType <String>] + [-ConnectedViaReferenceName <String>] [-IncludePersonalWorkspace <Boolean>] [-Password <String>] + [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-Tenant <String>] [-UserName <String>] + [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for PowerBIDelegatedScan. + +## EXAMPLES + +### Example 1: Create PowerBI delegated scan object +```powershell +New-AzPurviewPowerBIDelegatedScanObject -Kind 'PowerBIDelegated' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -IncludePersonalWorkspace $true -ClientId 'xxxxxxx-cdfd-4016-9e80-xxxxxxxx' -UserName 'abcd@msft.com' -Password 'pwd' +``` + +```output +AuthenticationType : +ClientId : xxxxxxx-cdfd-4016-9e80-xxxxxxxx +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +Id : +IncludePersonalWorkspace : True +Kind : PowerBIDelegated +LastModifiedAt : +Name : +Password : pwd +Result : +ScanRulesetName : +ScanRulesetType : +Tenant : +UserName : abcd@msft.com +Worker : +``` + +Create PowerBI delegated scan object + +## PARAMETERS + +### -AuthenticationType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePersonalWorkspace + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.PowerBiDelegatedScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewPowerBIMsiScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewPowerBIMsiScanObject.md new file mode 100644 index 0000000000..75ac790bff --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewPowerBIMsiScanObject.md @@ -0,0 +1,179 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewPowerBIMsiScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewPowerBIMsiScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewPowerBIMsiScanObject.md +--- + +# New-AzPurviewPowerBIMsiScanObject + +## SYNOPSIS +Create an in-memory object for PowerBIMsiScan. + +## SYNTAX + +``` +New-AzPurviewPowerBIMsiScanObject -Kind <ScanAuthorizationType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-ConnectedViaReferenceName <String>] [-IncludePersonalWorkspace <Boolean>] + [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for PowerBIMsiScan. + +## EXAMPLES + +### Example 1: Create PowerBI delegated scan object +```powershell +New-AzPurviewPowerBIMsiScanObject -Kind 'PowerBIMsi' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -IncludePersonalWorkspace $true +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : +Id : +IncludePersonalWorkspace : True +Kind : PowerBIMsi +LastModifiedAt : +Name : +Result : +ScanRulesetName : +ScanRulesetType : +Worker : +``` + +Create PowerBI delegated scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePersonalWorkspace + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.PowerBiMsiScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewRegexClassificationRulePatternObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewRegexClassificationRulePatternObject.md new file mode 100644 index 0000000000..feb003f31d --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewRegexClassificationRulePatternObject.md @@ -0,0 +1,68 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewRegexClassificationRulePatternObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewRegexClassificationRulePatternObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewRegexClassificationRulePatternObject.md +--- + +# New-AzPurviewRegexClassificationRulePatternObject + +## SYNOPSIS +Create an in-memory object for RegexClassificationRulePattern. + +## SYNTAX + +``` +New-AzPurviewRegexClassificationRulePatternObject [-Pattern <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for RegexClassificationRulePattern. + +## EXAMPLES + +### Example 1: Create Regex Classification Rule Pattern Object +```powershell +New-AzPurviewRegexClassificationRulePatternObject -Pattern '^col1$' +``` + +```output +Kind Pattern +---- ------- +Regex ^col1$ +``` + +Create Regex Classification Rule Pattern Object + +## PARAMETERS + +### -Pattern + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.RegexClassificationRulePattern + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewSapEccDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewSapEccDataSourceObject.md new file mode 100644 index 0000000000..ca9ff86ab4 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewSapEccDataSourceObject.md @@ -0,0 +1,133 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewSapEccDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewSapEccDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewSapEccDataSourceObject.md +--- + +# New-AzPurviewSapEccDataSourceObject + +## SYNOPSIS +Create an in-memory object for SapEccDataSource. + +## SYNTAX + +``` +New-AzPurviewSapEccDataSourceObject -Kind <DataSourceType> [-ApplicationServer <String>] + [-CollectionReferenceName <String>] [-CollectionType <String>] [-SystemNumber <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SapEccDataSource. + +## EXAMPLES + +### Example 1: Create SAPECC data source object +```powershell +New-AzPurviewSapEccDataSourceObject -Kind 'SapEcc' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ApplicationServer '12.13.14.12' -SystemNumber 32 +``` + +```output +ApplicationServer : 12.13.14.12 +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : SapEcc +LastModifiedAt : +Name : +Scan : +SystemNumber : 32 +``` + +Create SAPECC data source object + +## PARAMETERS + +### -ApplicationServer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemNumber + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.SapEccDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewSapS4HanaDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewSapS4HanaDataSourceObject.md new file mode 100644 index 0000000000..fd2edf1d98 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewSapS4HanaDataSourceObject.md @@ -0,0 +1,133 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewSapS4HanaDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewSapS4HanaDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewSapS4HanaDataSourceObject.md +--- + +# New-AzPurviewSapS4HanaDataSourceObject + +## SYNOPSIS +Create an in-memory object for SapS4HanaDataSource. + +## SYNTAX + +``` +New-AzPurviewSapS4HanaDataSourceObject -Kind <DataSourceType> [-ApplicationServer <String>] + [-CollectionReferenceName <String>] [-CollectionType <String>] [-SystemNumber <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SapS4HanaDataSource. + +## EXAMPLES + +### Example 1: Create SAPS4Hana data source object +```powershell +New-AzPurviewSapS4HanaDataSourceObject -Kind 'SapS4Hana' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ApplicationServer '12.13.14.12' -SystemNumber 32 +``` + +```output +ApplicationServer : 12.13.14.12 +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : SapS4Hana +LastModifiedAt : +Name : +Scan : +SystemNumber : 32 +``` + +Create SAPS4 data source object + +## PARAMETERS + +### -ApplicationServer + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SystemNumber + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.SapS4HanaDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewSapS4HanaSapS4HanaCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewSapS4HanaSapS4HanaCredentialScanObject.md new file mode 100644 index 0000000000..4d04074094 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewSapS4HanaSapS4HanaCredentialScanObject.md @@ -0,0 +1,256 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewSapS4HanaSapS4HanaCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewSapS4HanaSapS4HanaCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewSapS4HanaSapS4HanaCredentialScanObject.md +--- + +# New-AzPurviewSapS4HanaSapS4HanaCredentialScanObject + +## SYNOPSIS +Create an in-memory object for SapS4HanaSapS4HanaCredentialScan. + +## SYNTAX + +``` +New-AzPurviewSapS4HanaSapS4HanaCredentialScanObject -Kind <ScanAuthorizationType> [-ClientId <String>] + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] [-JCoLibraryPath <String>] + [-MaximumMemoryAllowedInGb <String>] [-MitiCache <String>] [-ScanRulesetName <String>] + [-ScanRulesetType <ScanRulesetType>] [-Worker <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SapS4HanaSapS4HanaCredentialScan. + +## EXAMPLES + +### Example 1: Create SAPS4 Hana Credential Scan Object +```powershell +New-AzPurviewSapS4HanaSapS4HanaCredentialScanObject -Kind 'SapS4HanaSapS4HanaCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ClientId '444' -CredentialReferenceName 'fdsafsdf' -CredentialType 'BasicAuth' -MaximumMemoryAllowedInGb 4 -JCoLibraryPath 'file://asdas' -ConnectedViaReferenceName 'IntegrationRuntime-NJh' +``` + +```output +ClientId : 444 +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : IntegrationRuntime-NJh +CreatedAt : +CredentialReferenceName : fdsafsdf +CredentialType : BasicAuth +Id : +JCoLibraryPath : file://asdas +Kind : SapS4HanaSapS4HanaCredential +LastModifiedAt : +MaximumMemoryAllowedInGb : 4 +MitiCache : +Name : +Result : +ScanRulesetName : +ScanRulesetType : +Worker : +``` + +Create SAPS4 Hana Credential Scan Object + +## PARAMETERS + +### -ClientId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JCoLibraryPath + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumMemoryAllowedInGb + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MitiCache + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.SapS4HanaSapS4HanaCredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewScan.md b/azps-10.1.0/Az.Purview/New-AzPurviewScan.md new file mode 100644 index 0000000000..20220a1827 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewScan.md @@ -0,0 +1,186 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/new-azpurviewscan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewScan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewScan.md +--- + +# New-AzPurviewScan + +## SYNOPSIS +Creates an instance of a scan + +## SYNTAX + +``` +New-AzPurviewScan -Endpoint <String> -DataSourceName <String> -Name <String> -Body <IScan> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an instance of a scan + +## EXAMPLES + +### Example 1: Create a scan instance under a data source +```powershell +$obj = New-AzPurviewAzureStorageCredentialScanObject -Kind 'AzureStorageCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'datascantestdataparv-accountkey' -CredentialType 'AccountKey' -ScanRulesetName 'AzureStorage' -ScanRulesetType 'System' +New-AzPurviewScan -Endpoint 'https://parv-brs-2.purview.azure.com/' -DataSourceName 'DataScanTestData-Parv' -Name 'ScanTest' -Body $obj +``` + +```output +CollectionLastModifiedAt : 2/15/2022 3:49:23 PM +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : 2/15/2022 3:49:23 PM +CredentialReferenceName : datascantestdataparv-accountkey +CredentialType : AccountKey +Id : datasources/DataScanTestData-Parv/scans/ScanTest +Kind : AzureStorageCredential +LastModifiedAt : 2/15/2022 11:46:29 PM +Name : ScanTest +Result : +ScanRulesetName : AzureStorage +ScanRulesetType : System +Worker : +``` + +Create a scan instance 'ScanTest' under data source + +## PARAMETERS + +### -Body +. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IScan +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataSourceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ScanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IScan + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IScan + +## 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. + + +BODY `<IScan>`: . + - `Kind <ScanAuthorizationType>`: + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewScanRuleset.md b/azps-10.1.0/Az.Purview/New-AzPurviewScanRuleset.md new file mode 100644 index 0000000000..1783940ae5 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewScanRuleset.md @@ -0,0 +1,170 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/new-azpurviewscanruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewScanRuleset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewScanRuleset.md +--- + +# New-AzPurviewScanRuleset + +## SYNOPSIS +Creates or Updates a scan ruleset + +## SYNTAX + +``` +New-AzPurviewScanRuleset -Endpoint <String> -Name <String> -Body <IScanRuleset> [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or Updates a scan ruleset + +## EXAMPLES + +### Example 1: Create custom scanruleset +```powershell +$obj = New-AzPurviewAdlsGen1ScanRulesetObject -Kind 'AdlsGen1' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -ScanningRuleFileExtension @("CSV","JSON","PSV","SSV","TSV","TXT","XML","PARQUET","AVRO","ORC","Documents","GZ","DOC","DOCM","DOCX","DOT","ODP","ODS","ODT","PDF","POT","PPS","PPSX","PPT","PPTM","PPTX","XLC","XLS","XLSB","XLSM","XLSX","XLT") -Type 'Custom' +New-AzPurviewScanRuleset -Endpoint 'https://parv-brs-2.purview.azure.com/' -Name 'Rule1' -Body $obj +``` + +```output +CreatedAt : 2/17/2022 3:35:07 PM +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : scanrulesets/Rule1 +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : AdlsGen1 +LastModifiedAt : 2/17/2022 3:35:07 PM +Name : Rule1 +ScanningRuleCustomFileExtension : +ScanningRuleFileExtension : {CSV, JSON, PSV, SSV…} +Status : Enabled +Type : Custom +Version : 1 +``` + +Create custom scanruleset + +## PARAMETERS + +### -Body +. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IScanRuleset +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ScanRulesetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IScanRuleset + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IScanRuleset + +## 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. + + +BODY `<IScanRuleset>`: . + - `Kind <DataSourceType>`: + - `[Type <ScanRulesetType?>]`: + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewSqlServerDatabaseCredentialScanObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewSqlServerDatabaseCredentialScanObject.md new file mode 100644 index 0000000000..88c1653b4f --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewSqlServerDatabaseCredentialScanObject.md @@ -0,0 +1,226 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewSqlServerDatabaseCredentialScanObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewSqlServerDatabaseCredentialScanObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewSqlServerDatabaseCredentialScanObject.md +--- + +# New-AzPurviewSqlServerDatabaseCredentialScanObject + +## SYNOPSIS +Create an in-memory object for SqlServerDatabaseCredentialScan. + +## SYNTAX + +``` +New-AzPurviewSqlServerDatabaseCredentialScanObject -Kind <ScanAuthorizationType> + [-CollectionReferenceName <String>] [-CollectionType <String>] [-ConnectedViaReferenceName <String>] + [-CredentialReferenceName <String>] [-CredentialType <CredentialType>] [-DatabaseName <String>] + [-ScanRulesetName <String>] [-ScanRulesetType <ScanRulesetType>] [-ServerEndpoint <String>] [-Worker <Int32>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SqlServerDatabaseCredentialScan. + +## EXAMPLES + +### Example 1: Create Sql Server DB Credential scan object +```powershell +New-AzPurviewSqlServerDatabaseCredentialScanObject -Kind 'SqlServerDatabaseCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'sqlauth' -CredentialType 'SqlAuth' -DatabaseName 'db' -ScanRulesetName 'SqlServer' -ScanRulesetType 'Custom' -ServerEndpoint '10.1.2.1' -ConnectedViaReferenceName 'IntegrationRuntime-NJh' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : IntegrationRuntime-NJh +CreatedAt : +CredentialReferenceName : sqlauth +CredentialType : SqlAuth +DatabaseName : db +Id : +Kind : SqlServerDatabaseCredential +LastModifiedAt : +Name : +Result : +ScanRulesetName : SqlServer +ScanRulesetType : Custom +ServerEndpoint : 10.1.2.1 +Worker : +``` + +Create Swl Server DB Credential scan object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectedViaReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.CredentialType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanAuthorizationType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanRulesetType + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Worker + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.SqlServerDatabaseCredentialScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewSqlServerDatabaseDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewSqlServerDatabaseDataSourceObject.md new file mode 100644 index 0000000000..6872644623 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewSqlServerDatabaseDataSourceObject.md @@ -0,0 +1,179 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewSqlServerDatabaseDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewSqlServerDatabaseDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewSqlServerDatabaseDataSourceObject.md +--- + +# New-AzPurviewSqlServerDatabaseDataSourceObject + +## SYNOPSIS +Create an in-memory object for SqlServerDatabaseDataSource. + +## SYNTAX + +``` +New-AzPurviewSqlServerDatabaseDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Location <String>] [-ResourceGroup <String>] [-ResourceName <String>] + [-ServerEndpoint <String>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SqlServerDatabaseDataSource. + +## EXAMPLES + +### Example 1: Create SQL Server Database data source object +```powershell +New-AzPurviewSqlServerDatabaseDataSourceObject -Kind 'SqlServerDatabase' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -ServerEndpoint '12.13.14.12' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Id : +Kind : SqlServerDatabase +LastModifiedAt : +Location : +Name : +ResourceGroup : +ResourceName : +Scan : +ServerEndpoint : 12.13.14.12 +SubscriptionId : +``` + +Create SQL Server Database data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerEndpoint + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.SqlServerDatabaseDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewSqlServerDatabaseScanRulesetObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewSqlServerDatabaseScanRulesetObject.md new file mode 100644 index 0000000000..a42b477d8b --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewSqlServerDatabaseScanRulesetObject.md @@ -0,0 +1,134 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewSqlServerDatabaseScanRulesetObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewSqlServerDatabaseScanRulesetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewSqlServerDatabaseScanRulesetObject.md +--- + +# New-AzPurviewSqlServerDatabaseScanRulesetObject + +## SYNOPSIS +Create an in-memory object for SqlServerDatabaseScanRuleset. + +## SYNTAX + +``` +New-AzPurviewSqlServerDatabaseScanRulesetObject -Kind <DataSourceType> [-Description <String>] + [-ExcludedSystemClassification <String[]>] [-IncludedCustomClassificationRuleName <String[]>] + [-Type <ScanRulesetType>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SqlServerDatabaseScanRuleset. + +## EXAMPLES + +### Example 1: Create Sql Server Db custom scanruleset object +```powershell +New-AzPurviewSqlServerDatabaseScanRulesetObject -Kind 'SqlServerDatabase' -Description 'desc' -ExcludedSystemClassification @('MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER','MICROSOFT.SECURITY.COMMON_PASSWORDS') -IncludedCustomClassificationRuleName @('ClassificationRule2') -Type 'Custom' +``` + +```output +CreatedAt : +Description : desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS} +Id : +IncludedCustomClassificationRuleName : {ClassificationRule2} +Kind : SqlServerDatabase +LastModifiedAt : +Name : +Status : +Type : Custom +Version : +``` + +Create Sql Server Db custom scanruleset object + +## PARAMETERS + +### -Description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedSystemClassification + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedCustomClassificationRuleName + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanRulesetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.SqlServerDatabaseScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewTeradataDataSourceObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewTeradataDataSourceObject.md new file mode 100644 index 0000000000..8c27baf7c6 --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewTeradataDataSourceObject.md @@ -0,0 +1,118 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewTeradataDataSourceObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewTeradataDataSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewTeradataDataSourceObject.md +--- + +# New-AzPurviewTeradataDataSourceObject + +## SYNOPSIS +Create an in-memory object for TeradataDataSource. + +## SYNTAX + +``` +New-AzPurviewTeradataDataSourceObject -Kind <DataSourceType> [-CollectionReferenceName <String>] + [-CollectionType <String>] [-Host <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for TeradataDataSource. + +## EXAMPLES + +### Example 1: Create Teradata data source object +```powershell +New-AzPurviewTeradataDataSourceObject -Kind 'Teradata' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -Host '12.13.14.12' +``` + +```output +CollectionLastModifiedAt : +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +CreatedAt : +Host : 12.13.14.12 +Id : +Kind : Teradata +LastModifiedAt : +Name : +Scan : +``` + +Create Teradata data source object + +## PARAMETERS + +### -CollectionReferenceName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Host + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DataSourceType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.TeradataDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewTrigger.md b/azps-10.1.0/Az.Purview/New-AzPurviewTrigger.md new file mode 100644 index 0000000000..f261b1a1fe --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewTrigger.md @@ -0,0 +1,210 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/new-azpurviewtrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewTrigger.md +--- + +# New-AzPurviewTrigger + +## SYNOPSIS +Creates an instance of a trigger + +## SYNTAX + +``` +New-AzPurviewTrigger -Endpoint <String> -DataSourceName <String> -ScanName <String> -Body <ITrigger> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an instance of a trigger + +## EXAMPLES + +### Example 1: Create trigger schedule for scan run +```powershell +$obj = New-AzPurviewTriggerObject -RecurrenceEndTime '7/20/2022 12:00:00 AM' -RecurrenceStartTime '2/17/2022 1:32:00 PM' -Interval 1 -RecurrenceFrequency 'Month' -ScanLevel 'Full' -ScheduleHour $(9) -ScheduleMinute $(0) -ScheduleMonthDay $(10) +New-AzPurviewTrigger -Endpoint https://parv-brs-2.purview.azure.com/ -DataSourceName 'DataScanTestData-Parv' -ScanName 'Scan-6HK' -Body $obj +``` + +```output +CreatedAt : 2/17/2022 1:35:12 PM +Id : datasources/DataScanTestData-Parv/scans/Scan-6HK/triggers/default +IncrementalScanStartTime : +Interval : 1 +LastModifiedAt : 2/17/2022 1:46:22 PM +LastScheduled : +Name : default +RecurrenceEndTime : 7/20/2022 12:00:00 AM +RecurrenceFrequency : Month +RecurrenceInterval : +RecurrenceStartTime : 2/17/2022 1:32:00 PM +RecurrenceTimeZone : +ResourceGroupName : +ScanLevel : Full +ScheduleAdditionalProperty : { + } +ScheduleHour : {9} +ScheduleMinute : {0} +ScheduleMonthDay : {10} +ScheduleMonthlyOccurrence : +ScheduleWeekDay : +``` + +Create trigger for a full scan starting 02/17/22 1:31 PM UTC and ending 7/20/2022 12:00:00 AM, occuring every 1 month, on 10th of the month, at 09:00 AM UTC + +## PARAMETERS + +### -Body +. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.ITrigger +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DataSourceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.ITrigger + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.ITrigger + +## 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. + + +BODY `<ITrigger>`: . + - `[IncrementalScanStartTime <DateTime?>]`: + - `[Interval <Int32?>]`: + - `[RecurrenceEndTime <DateTime?>]`: + - `[RecurrenceFrequency <TriggerFrequency?>]`: + - `[RecurrenceInterval <String>]`: + - `[RecurrenceStartTime <DateTime?>]`: + - `[RecurrenceTimeZone <String>]`: + - `[ScanLevel <ScanLevelType?>]`: + - `[ScheduleAdditionalProperty <IRecurrenceScheduleAdditionalProperties>]`: Dictionary of `<any>` + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ScheduleHour <Int32[]>]`: + - `[ScheduleMinute <Int32[]>]`: + - `[ScheduleMonthDay <Int32[]>]`: + - `[ScheduleMonthlyOccurrence <IRecurrenceScheduleOccurrence[]>]`: + - `[AdditionalProperty <IRecurrenceScheduleOccurrenceAdditionalProperties>]`: Dictionary of `<any>` + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[Day <DayOfWeek?>]`: + - `[Occurrence <Int32?>]`: + - `[ScheduleWeekDay <DaysOfWeek[]>]`: + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/New-AzPurviewTriggerObject.md b/azps-10.1.0/Az.Purview/New-AzPurviewTriggerObject.md new file mode 100644 index 0000000000..4fbe119a0a --- /dev/null +++ b/azps-10.1.0/Az.Purview/New-AzPurviewTriggerObject.md @@ -0,0 +1,291 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.Purview/new-AzPurviewTriggerObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewTriggerObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/New-AzPurviewTriggerObject.md +--- + +# New-AzPurviewTriggerObject + +## SYNOPSIS +Create an in-memory object for Trigger. + +## SYNTAX + +``` +New-AzPurviewTriggerObject [-IncrementalScanStartTime <DateTime>] [-Interval <Int32>] + [-RecurrenceEndTime <DateTime>] [-RecurrenceFrequency <TriggerFrequency>] [-RecurrenceInterval <String>] + [-RecurrenceStartTime <DateTime>] [-RecurrenceTimeZone <String>] [-ScanLevel <ScanLevelType>] + [-ScheduleAdditionalProperty <IRecurrenceScheduleAdditionalProperties>] [-ScheduleHour <Int32[]>] + [-ScheduleMinute <Int32[]>] [-ScheduleMonthDay <Int32[]>] + [-ScheduleMonthlyOccurrence <IRecurrenceScheduleOccurrence[]>] [-ScheduleWeekDay <DaysOfWeek[]>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for Trigger. + +## EXAMPLES + +### Example 1: Create trigger object +```powershell +New-AzPurviewTriggerObject -RecurrenceEndTime '7/20/2022 12:00:00 AM' -RecurrenceStartTime '2/17/2022 1:32:00 PM' -Interval 1 -RecurrenceFrequency 'Month' -ScanLevel 'Full' -ScheduleHour $(9) -ScheduleMinute $(0) -ScheduleMonthDay $(10) +``` + +```output +CreatedAt : +Id : +IncrementalScanStartTime : +Interval : 1 +LastModifiedAt : +LastScheduled : +Name : +RecurrenceEndTime : 7/20/2022 12:00:00 AM +RecurrenceFrequency : Month +RecurrenceInterval : +RecurrenceStartTime : 2/17/2022 1:32:00 PM +RecurrenceTimeZone : +ResourceGroupName : +ScanLevel : Full +ScheduleAdditionalProperty : { + } +ScheduleHour : {9} +ScheduleMinute : {0} +ScheduleMonthDay : {10} +ScheduleMonthlyOccurrence : +ScheduleWeekDay : +``` + +Create trigger object + +## PARAMETERS + +### -IncrementalScanStartTime + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Interval + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrenceEndTime + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrenceFrequency + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.TriggerFrequency +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrenceInterval + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrenceStartTime + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurrenceTimeZone + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanLevel + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanLevelType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleAdditionalProperty +Dictionary of \<any\>. +To construct, see NOTES section for SCHEDULEADDITIONALPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IRecurrenceScheduleAdditionalProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleHour + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleMinute + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleMonthDay + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleMonthlyOccurrence +To construct, see NOTES section for SCHEDULEMONTHLYOCCURRENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IRecurrenceScheduleOccurrence[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleWeekDay + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.DaysOfWeek[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.Trigger + +## 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. + + +SCHEDULEADDITIONALPROPERTY `<IRecurrenceScheduleAdditionalProperties>`: Dictionary of `<any>`. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + +SCHEDULEMONTHLYOCCURRENCE <IRecurrenceScheduleOccurrence[]>: + - `[AdditionalProperty <IRecurrenceScheduleOccurrenceAdditionalProperties>]`: Dictionary of `<any>` + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[Day <DayOfWeek?>]`: + - `[Occurrence <Int32?>]`: + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Remove-AzPurviewAccount.md b/azps-10.1.0/Az.Purview/Remove-AzPurviewAccount.md new file mode 100644 index 0000000000..e28d1f6e1e --- /dev/null +++ b/azps-10.1.0/Az.Purview/Remove-AzPurviewAccount.md @@ -0,0 +1,231 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/remove-azpurviewaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewAccount.md +--- + +# Remove-AzPurviewAccount + +## SYNOPSIS +Deletes an account resource + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPurviewAccount -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzPurviewAccount -InputObject <IPurviewIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an account resource + +## EXAMPLES + +### Example 1: Delete a purview account +```powershell +Remove-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg +``` + +Delete a purview account named 'test-pa' + +### Example 2: Delete a purview account by InputObject +```powershell +$get = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg +Remove-AzPurviewAccount -InputObject $get +``` + +Delete a purview account named 'test-pa' by InputObject + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.IPurviewIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the account. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.IPurviewIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IPurviewIdentity>`: Identity Parameter + - `[AccountName <String>]`: The name of the account. + - `[GroupId <String>]`: The group identifier. + - `[Id <String>]`: Resource identity path + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The resource group name. + - `[SubscriptionId <String>]`: The subscription identifier + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Remove-AzPurviewClassificationRule.md b/azps-10.1.0/Az.Purview/Remove-AzPurviewClassificationRule.md new file mode 100644 index 0000000000..74999c8def --- /dev/null +++ b/azps-10.1.0/Az.Purview/Remove-AzPurviewClassificationRule.md @@ -0,0 +1,163 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/remove-azpurviewclassificationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewClassificationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewClassificationRule.md +--- + +# Remove-AzPurviewClassificationRule + +## SYNOPSIS +Deletes a classification rule + +## SYNTAX + +``` +Remove-AzPurviewClassificationRule -Endpoint <String> -Name <String> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a classification rule + +## EXAMPLES + +### Example 1: Delete custom classification rule by name +```powershell +Remove-AzPurviewClassificationRule -Endpoint https://parv-brs-2.purview.azure.com -ClassificationRuleName 'RuleDUmmy' +``` + +```output +ClassificationAction : Keep +ClassificationName : MICROSOFT.GOVERNMENT.AUSTRALIA.DRIVERS_LICENSE_NUMBER +ColumnPattern : {{ + "kind": "Regex", + "pattern": "Column1" + }, { + "kind": "Regex", + "pattern": "Column2" + }} +CreatedAt : 2/3/2022 11:28:58 AM +DataPattern : {} +Description : Description +Id : classificationrules/RuleDUmmy +Kind : Custom +LastModifiedAt : 2/3/2022 11:28:58 AM +MinimumPercentageMatch : +Name : RuleDUmmy +RuleStatus : Enabled +Version : 1 +``` + +Delete custom classification rule named 'ClassificationRule4' + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClassificationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IClassificationRule + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Remove-AzPurviewDataSource.md b/azps-10.1.0/Az.Purview/Remove-AzPurviewDataSource.md new file mode 100644 index 0000000000..fba3e9acf2 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Remove-AzPurviewDataSource.md @@ -0,0 +1,158 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/remove-azpurviewdatasource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewDataSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewDataSource.md +--- + +# Remove-AzPurviewDataSource + +## SYNOPSIS +Deletes a data source + +## SYNTAX + +``` +Remove-AzPurviewDataSource -Endpoint <String> -Name <String> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a data source + +## EXAMPLES + +### Example 1: Remove a data source by name +```powershell +Remove-AzPurviewDataSource -Endpoint 'https://rs-2.purview.azure.com/' -Name 'NewDataSource' +``` + +```output +CollectionLastModifiedAt : 2/9/2022 2:49:14 AM +CollectionReferenceName : brs-2 +CollectionType : CollectionReference +CreatedAt : 2/9/2022 2:49:14 AM +Endpoint : https://data123scantest.blob.core.windows.net/ +Id : datasources/NewDataSource +Kind : AzureStorage +LastModifiedAt : 2/9/2022 3:02:56 AM +Location : westus +Name : NewDataSource +ResourceGroup : rg +ResourceName : datascantest +Scan : +SubscriptionId : 4348d67b-ffc5-465d-b5dd-xxxxxxxxxx +``` + +Remove a data source by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DataSourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IDataSource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Remove-AzPurviewDefaultAccount.md b/azps-10.1.0/Az.Purview/Remove-AzPurviewDefaultAccount.md new file mode 100644 index 0000000000..979b6f5429 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Remove-AzPurviewDefaultAccount.md @@ -0,0 +1,155 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/remove-azpurviewdefaultaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewDefaultAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewDefaultAccount.md +--- + +# Remove-AzPurviewDefaultAccount + +## SYNOPSIS +Removes the default account from the scope. + +## SYNTAX + +``` +Remove-AzPurviewDefaultAccount -ScopeTenantId <String> -ScopeType <ScopeType> [-Scope <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes the default account from the scope. + +## EXAMPLES + +### Example 1: Removes the default account from the scope +```powershell +Remove-AzPurviewDefaultAccount -ScopeTenantId xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a -ScopeType Tenant +``` + +Removes the default account from the scope Tenant. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeTenantId +The tenant ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeType +The scope for the default account. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purview.Support.ScopeType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Remove-AzPurviewKeyVaultConnection.md b/azps-10.1.0/Az.Purview/Remove-AzPurviewKeyVaultConnection.md new file mode 100644 index 0000000000..2b3b80a491 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Remove-AzPurviewKeyVaultConnection.md @@ -0,0 +1,148 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/remove-azpurviewkeyvaultconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewKeyVaultConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewKeyVaultConnection.md +--- + +# Remove-AzPurviewKeyVaultConnection + +## SYNOPSIS +Deletes the key vault connection associated with the account + +## SYNTAX + +``` +Remove-AzPurviewKeyVaultConnection -Endpoint <String> -KeyVaultName <String> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the key vault connection associated with the account + +## EXAMPLES + +### Example 1: Remove a key vault connection +```powershell +Remove-AzPurviewKeyVaultConnection -Endpoint 'https://parv-brs-2.purview.azure.com/' -KeyVaultName 'KeyVaultConnection5' +``` + +```output +BaseUrl : https://datascankv.vault.azure.net/ +Description : This is a key vault +Id : keyVaults/KeyVaultConnection5 +Name : KeyVaultConnection5 +``` + +Remove key vault connection named 'KeyVaultConnection5' + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IAzureKeyVault + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Remove-AzPurviewScan.md b/azps-10.1.0/Az.Purview/Remove-AzPurviewScan.md new file mode 100644 index 0000000000..802c0ed0a2 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Remove-AzPurviewScan.md @@ -0,0 +1,174 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/remove-azpurviewscan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewScan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewScan.md +--- + +# Remove-AzPurviewScan + +## SYNOPSIS +Deletes the scan associated with the data source + +## SYNTAX + +``` +Remove-AzPurviewScan -Endpoint <String> -DataSourceName <String> -Name <String> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the scan associated with the data source + +## EXAMPLES + +### Example 1: Delete a scan instance by name +```powershell +Remove-AzPurviewScan -Endpoint 'https://parv-brs-2.purview.azure.com/' -DataSourceName 'DataScanTestData-Parv' -Name 'ScanTest' +``` + +```output +CollectionLastModifiedAt : 2/15/2022 3:49:23 PM +CollectionReferenceName : parv-brs-2 +CollectionType : CollectionReference +ConnectedViaReferenceName : +CreatedAt : 2/15/2022 3:49:23 PM +CredentialReferenceName : datascantestdataparv-accountkey +CredentialType : AccountKey +Id : datasources/DataScanTestData-Parv/scans/ScanTest +Kind : AzureStorageCredential +LastModifiedAt : 2/15/2022 11:46:29 PM +Name : ScanTest +Result : +ScanRulesetName : AzureStorage +ScanRulesetType : System +Worker : +``` + +Delete a scan instance named 'ScanTest' + +## PARAMETERS + +### -DataSourceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ScanName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IScan + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Remove-AzPurviewScanRuleset.md b/azps-10.1.0/Az.Purview/Remove-AzPurviewScanRuleset.md new file mode 100644 index 0000000000..03bc1cdc3e --- /dev/null +++ b/azps-10.1.0/Az.Purview/Remove-AzPurviewScanRuleset.md @@ -0,0 +1,157 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/remove-azpurviewscanruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewScanRuleset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewScanRuleset.md +--- + +# Remove-AzPurviewScanRuleset + +## SYNOPSIS +Deletes a scan ruleset + +## SYNTAX + +``` +Remove-AzPurviewScanRuleset -Endpoint <String> -Name <String> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a scan ruleset + +## EXAMPLES + +### Example 1: Remove custom scanruleset by name +```powershell +Remove-AzPurviewScanRuleset -Endpoint https://parv-brs-2.purview.azure.com/ -Name TestRule +``` + +```output +CreatedAt : 2/17/2022 2:30:15 PM +Description : test desc +ExcludedSystemClassification : {MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER, MICROSOFT.SECURITY.COMMON_PASSWORDS, MICROSOFT.MISCELLANEOUS.IPADDRESS} +Id : scanrulesets/TestRule +IncludedCustomClassificationRuleName : {ClassificationRule5, ClassificationRule2} +Kind : AzureStorage +LastModifiedAt : 2/17/2022 2:32:02 PM +Name : TestRule +ScanningRuleCustomFileExtension : +ScanningRuleFileExtension : {CSV, JSON, PSV, SSV…} +Status : Enabled +Type : Custom +Version : 2 +``` + +Remove custom scanruleset by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ScanRulesetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IScanRuleset + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Remove-AzPurviewTrigger.md b/azps-10.1.0/Az.Purview/Remove-AzPurviewTrigger.md new file mode 100644 index 0000000000..00eb5d4e62 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Remove-AzPurviewTrigger.md @@ -0,0 +1,180 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/remove-azpurviewtrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Remove-AzPurviewTrigger.md +--- + +# Remove-AzPurviewTrigger + +## SYNOPSIS +Deletes the trigger associated with the scan + +## SYNTAX + +``` +Remove-AzPurviewTrigger -Endpoint <String> -DataSourceName <String> -ScanName <String> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the trigger associated with the scan + +## EXAMPLES + +### Example 1: Remove trigger schedule for a scan +```powershell +Remove-AzPurviewTrigger -Endpoint https://parv-brs-2.purview.azure.com/ -DataSourceName 'DataScanTestData-Parv' -ScanName 'Scan-6HK' +``` + +```output +CreatedAt : 2/17/2022 1:35:12 PM +Id : datasources/DataScanTestData-Parv/scans/Scan-6HK/triggers/default +IncrementalScanStartTime : +Interval : 1 +LastModifiedAt : 2/17/2022 1:46:22 PM +LastScheduled : +Name : default +RecurrenceEndTime : 7/20/2022 12:00:00 AM +RecurrenceFrequency : Month +RecurrenceInterval : +RecurrenceStartTime : 2/17/2022 1:32:00 PM +RecurrenceTimeZone : +ResourceGroupName : +ScanLevel : Full +ScheduleAdditionalProperty : { + } +ScheduleHour : {9} +ScheduleMinute : {0} +ScheduleMonthDay : {10} +ScheduleMonthlyOccurrence : +ScheduleWeekDay : +``` + +Remove trigger schedule for a scan + +## PARAMETERS + +### -DataSourceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.ITrigger + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Set-AzPurviewDefaultAccount.md b/azps-10.1.0/Az.Purview/Set-AzPurviewDefaultAccount.md new file mode 100644 index 0000000000..c242a1115d --- /dev/null +++ b/azps-10.1.0/Az.Purview/Set-AzPurviewDefaultAccount.md @@ -0,0 +1,193 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/set-azpurviewdefaultaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Set-AzPurviewDefaultAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Set-AzPurviewDefaultAccount.md +--- + +# Set-AzPurviewDefaultAccount + +## SYNOPSIS +Sets the default account for the scope. + +## SYNTAX + +``` +Set-AzPurviewDefaultAccount -AccountName <String> -ResourceGroupName <String> -ScopeTenantId <String> + [-Scope <String>] [-ScopeType <ScopeType>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets the default account for the scope. + +## EXAMPLES + +### Example 1: Sets the default account for the scope. +```powershell +Set-AzPurviewDefaultAccount -AccountName test-pa -ResourceGroupName test-rg -ScopeTenantId xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a +``` + +```output +AccountName ResourceGroupName Scope ScopeTenantId ScopeType SubscriptionId +----------- ----------------- ----- ------------- --------- -------------- +test-pa test-rg xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a Tenant xxxxxxxx-1bf0-4dda-aec3 +``` + +Sets `test-pa` as the default account for the scope. + +## PARAMETERS + +### -AccountName +The name of the account that is set as the default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name of the account that is set as the default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope object ID. +For example, sub ID or tenant ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeTenantId +The scope tenant in which the default account is set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopeType +The scope where the default account is set. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purview.Support.ScopeType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID of the account that is set as the default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.Api20210701.IDefaultAccountPayload + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Start-AzPurviewScanResultScan.md b/azps-10.1.0/Az.Purview/Start-AzPurviewScanResultScan.md new file mode 100644 index 0000000000..3316281b5c --- /dev/null +++ b/azps-10.1.0/Az.Purview/Start-AzPurviewScanResultScan.md @@ -0,0 +1,177 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/start-azpurviewscanresultscan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Start-AzPurviewScanResultScan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Start-AzPurviewScanResultScan.md +--- + +# Start-AzPurviewScanResultScan + +## SYNOPSIS +Runs the scan + +## SYNTAX + +``` +Start-AzPurviewScanResultScan -Endpoint <String> -DataSourceName <String> -RunId <String> -ScanName <String> + [-ScanLevel <ScanLevelType>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Runs the scan + +## EXAMPLES + +### Example 1: Start a Scan Run +```powershell +Start-AzPurviewScanResultScan -Endpoint 'https://parv-brs-2.purview.azure.com/' -DataSourceName 'DataScanTestData-Parv' -ScanName 'Scan1ForDemo' -RunId '758a0499-b45e-40e3-9c06-408e2f3ac050' -ScanLevel 'Full' +``` + +```output +EndTime ScanResultId StartTime Status +------- ------------ --------- ------ + 758a0499-b45e-40e3-9c06-408e2f3ac050 2/15/2022 2:34:06 PM Accepted +``` + +Start a Scan Run with scanResultId '758a0499-b45e-40e3-9c06-408e2f3ac050' + +## PARAMETERS + +### -DataSourceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunId +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanLevel +. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Support.ScanLevelType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IOperationResponse + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Stop-AzPurviewScanResultScan.md b/azps-10.1.0/Az.Purview/Stop-AzPurviewScanResultScan.md new file mode 100644 index 0000000000..78e3cdea26 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Stop-AzPurviewScanResultScan.md @@ -0,0 +1,162 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/stop-azpurviewscanresultscan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Stop-AzPurviewScanResultScan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Stop-AzPurviewScanResultScan.md +--- + +# Stop-AzPurviewScanResultScan + +## SYNOPSIS +Cancels a scan + +## SYNTAX + +``` +Stop-AzPurviewScanResultScan -Endpoint <String> -DataSourceName <String> -RunId <String> -ScanName <String> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Cancels a scan + +## EXAMPLES + +### Example 1: Stop a scan run by run id +```powershell +Stop-AzPurviewScanResultScan -Endpoint 'https://parv-brs-2.purview.azure.com/' -DataSourceName 'DataScanTestData-Parv' -ScanName 'Scan1ForDemo' -RunId '663623f3-8728-4b10-b5c8-8ed8dbc2ae7e' +``` + +```output +EndTime ScanResultId StartTime Status +------- ------------ --------- ------ + 2/15/2022 2:47:55 PM Accepted +``` + +Stop a scan run by run id '663623f3-8728-4b10-b5c8-8ed8dbc2ae7e' + +## PARAMETERS + +### -DataSourceName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The scanning endpoint of your purview account. +Example: https://{accountName}.purview.azure.com + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunId +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purviewdata.Models.Api20211001Preview.IOperationResponse + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Test-AzPurviewAccountNameAvailability.md b/azps-10.1.0/Az.Purview/Test-AzPurviewAccountNameAvailability.md new file mode 100644 index 0000000000..427cb4f594 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Test-AzPurviewAccountNameAvailability.md @@ -0,0 +1,146 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/test-azpurviewaccountnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Test-AzPurviewAccountNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Test-AzPurviewAccountNameAvailability.md +--- + +# Test-AzPurviewAccountNameAvailability + +## SYNOPSIS +Checks if account name is available. + +## SYNTAX + +``` +Test-AzPurviewAccountNameAvailability [-SubscriptionId <String>] -Name <String> -Type <String> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Checks if account name is available. + +## EXAMPLES + +### Example 1: Check if account name is available +```powershell +Test-AzPurviewAccountNameAvailability -Name test-pa -Type Tenant +``` + +```output +Message NameAvailable Reason +------- ------------- ------ +The name test-pa is invalid, please use another name. False Invalid +``` + +Check if account name 'test-pa' is available. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name to verify for availability + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Fully qualified resource type which includes provider namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.Api20210701.ICheckNameAvailabilityResult + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Purview/Update-AzPurviewAccount.md b/azps-10.1.0/Az.Purview/Update-AzPurviewAccount.md new file mode 100644 index 0000000000..edfa60fee7 --- /dev/null +++ b/azps-10.1.0/Az.Purview/Update-AzPurviewAccount.md @@ -0,0 +1,369 @@ +--- +external help file: Az.Purview-help.xml +Module Name: Az.Purview +online version: https://learn.microsoft.com/powershell/module/az.purview/update-azpurviewaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Update-AzPurviewAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Purview/Purview/help/Update-AzPurviewAccount.md +--- + +# Update-AzPurviewAccount + +## SYNOPSIS +Updates an account + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPurviewAccount -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-ManagedResourceGroupName <String>] [-PublicNetworkAccess <PublicNetworkAccess>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPurviewAccount -InputObject <IPurviewIdentity> [-ManagedResourceGroupName <String>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an account + +## EXAMPLES + +### Example 1: Update a purview account +```powershell +Update-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg -Tag @{"k"="v"} | Format-List +``` + +```output +CloudConnectorAwsExternalId : xxxxxxxxxx-d074-4f8f-9d7f-10811b250738 +CreatedAt : 8/17/2021 6:18:57 AM +CreatedBy : xxxxx.Zhou@microsoft.com +CreatedByObjectId : xxxxxxx-5be9-4f43-abd2-04561777c8b0 +EndpointCatalog : https://test-pa.catalog.purview.azure.com +EndpointGuardian : https://test-pa.guardian.purview.azure.com +EndpointScan : https://test-pa.scan.purview.azure.com +FriendlyName : test-pa +Id : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/bez-rg/providers/Microsoft.Purview/a + ccounts/bez-pa +Identity : { + "principalId": "xxxxxxxx-7956-4978-87e8-9ddd82cfe2b7", + "tenantId": "xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a", + "type": "SystemAssigned" + } +IdentityPrincipalId : xxxxxxxx-7956-4978-87e8-9ddd82cfe2b7 +IdentityTenantId : xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a +IdentityType : SystemAssigned +Location : eastus +ManagedResourceEventHubNamespace : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/managed-rg-bbcpgdj/providers/Microso + ft.EventHub/namespaces/Atlas-2bb7cf0b-5348-4811-a336-759242a25d37 +ManagedResourceGroup : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/managed-rg-bbcpgdj +ManagedResourceGroupName : managed-rg-bbcpgdj +ManagedResourceStorageAccount : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/managed-rg-bbcpgdj/providers/Microso + ft.Storage/storageAccounts/scaneastusnkcccgc +Name : test-pa +PrivateEndpointConnection : {} +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +ResourceGroupName : test-rg +SkuCapacity : 1 +SkuName : Standard +SystemData : { + "createdAt": "2021-08-17T06:18:57.7274115Z", + "createdBy": "xxxxx.Zhou@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "xxxxxx-08-17T06:18:57.7274115Z", + "lastModifiedBy": "Beisi.Zhou@microsoft.com", + "lastModifiedByType": "User" + } +SystemDataCreatedAt : 8/17/2021 6:18:57 AM +SystemDataCreatedBy : xxxxx.Zhou@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/17/2021 6:18:57 AM +SystemDataLastModifiedBy : xxxxxx.Zhou@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "k": "v" + } +Type : Microsoft.Purview/account +``` + +Update the tag of a purview account named 'test-pa' + +### Example 2: Update a purview account by InputObject +```powershell +$get = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg +Update-AzPurviewAccount -InputObject $get -Tag @{"k"="v"} +``` + +```output +CloudConnectorAwsExternalId : xxxxxxxxxx-d074-4f8f-9d7f-10811b250738 +CreatedAt : 8/17/2021 6:18:57 AM +CreatedBy : xxxxx.Zhou@microsoft.com +CreatedByObjectId : xxxxxxx-5be9-4f43-abd2-04561777c8b0 +EndpointCatalog : https://test-pa.catalog.purview.azure.com +EndpointGuardian : https://test-pa.guardian.purview.azure.com +EndpointScan : https://test-pa.scan.purview.azure.com +FriendlyName : test-pa +Id : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/bez-rg/providers/Microsoft.Purview/a + ccounts/bez-pa +Identity : { + "principalId": "xxxxxxxx-7956-4978-87e8-9ddd82cfe2b7", + "tenantId": "xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a", + "type": "SystemAssigned" + } +IdentityPrincipalId : xxxxxxxx-7956-4978-87e8-9ddd82cfe2b7 +IdentityTenantId : xxxxxxxx-38d6-4fb2-bad9-b7b93a3e9c5a +IdentityType : SystemAssigned +Location : eastus +ManagedResourceEventHubNamespace : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/managed-rg-bbcpgdj/providers/Microso + ft.EventHub/namespaces/Atlas-2bb7cf0b-5348-4811-a336-759242a25d37 +ManagedResourceGroup : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/managed-rg-bbcpgdj +ManagedResourceGroupName : managed-rg-bbcpgdj +ManagedResourceStorageAccount : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/managed-rg-bbcpgdj/providers/Microso + ft.Storage/storageAccounts/scaneastusnkcccgc +Name : test-pa +PrivateEndpointConnection : {} +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +ResourceGroupName : test-rg +SkuCapacity : 1 +SkuName : Standard +SystemData : { + "createdAt": "2021-08-17T06:18:57.7274115Z", + "createdBy": "xxxxx.Zhou@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "xxxxxx-08-17T06:18:57.7274115Z", + "lastModifiedBy": "Beisi.Zhou@microsoft.com", + "lastModifiedByType": "User" + } +SystemDataCreatedAt : 8/17/2021 6:18:57 AM +SystemDataCreatedBy : xxxxx.Zhou@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/17/2021 6:18:57 AM +SystemDataLastModifiedBy : xxxxxx.Zhou@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "k": "v" + } +Type : Microsoft.Purview/account +``` + +Update the tag of a purview account named 'test-pa' by InputObject + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.IPurviewIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagedResourceGroupName +Gets or sets the managed resource group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Gets or sets the public network access. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Purview.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags on the azure resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.IPurviewIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Purview.Models.Api20210701.IAccount + +## 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 `<IPurviewIdentity>`: Identity Parameter + - `[AccountName <String>]`: The name of the account. + - `[GroupId <String>]`: The group identifier. + - `[Id <String>]`: Resource identity path + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: The resource group name. + - `[SubscriptionId <String>]`: The subscription identifier + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Qumulo/Az.Qumulo.md b/azps-10.1.0/Az.Qumulo/Az.Qumulo.md new file mode 100644 index 0000000000..06186e5454 --- /dev/null +++ b/azps-10.1.0/Az.Qumulo/Az.Qumulo.md @@ -0,0 +1,27 @@ +--- +Module Name: Az.Qumulo +Module Guid: 181af76f-3704-40ce-9fa9-c5826313916c +Download Help Link: https://learn.microsoft.com/powershell/module/az.qumulo +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Qumulo/help/Az.Qumulo.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Qumulo/help/Az.Qumulo.md +--- + +# Az.Qumulo Module +## Description +Microsoft Azure PowerShell: Qumulo cmdlets + +## Az.Qumulo Cmdlets +### [Get-AzQumuloFileSystem](Get-AzQumuloFileSystem.md) +Get a file system resource + +### [New-AzQumuloFileSystem](New-AzQumuloFileSystem.md) +Create a file system resource + +### [Remove-AzQumuloFileSystem](Remove-AzQumuloFileSystem.md) +Delete a file system resource + +### [Update-AzQumuloFileSystem](Update-AzQumuloFileSystem.md) +Update a file system resource + diff --git a/azps-10.1.0/Az.Qumulo/Get-AzQumuloFileSystem.md b/azps-10.1.0/Az.Qumulo/Get-AzQumuloFileSystem.md new file mode 100644 index 0000000000..549d1bc9e6 --- /dev/null +++ b/azps-10.1.0/Az.Qumulo/Get-AzQumuloFileSystem.md @@ -0,0 +1,197 @@ +--- +external help file: +Module Name: Az.Qumulo +online version: https://learn.microsoft.com/powershell/module/az.qumulo/get-azqumulofilesystem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Qumulo/help/Get-AzQumuloFileSystem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Qumulo/help/Get-AzQumuloFileSystem.md +--- + +# Get-AzQumuloFileSystem + +## SYNOPSIS +Get a file system resource + +## SYNTAX + +### List (Default) +``` +Get-AzQumuloFileSystem [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzQumuloFileSystem -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzQumuloFileSystem -InputObject <IQumuloIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzQumuloFileSystem -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a file system resource + +## EXAMPLES + +### Example 1: List by subscription +```powershell +Get-AzQumuloFileSystem -SubscriptionId fc35d936-3b89-41f8-8110-a24b56826c37 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +eastus fileSystem01 6/24/2023 5:22:01 AM user@organization.com User 6/24/2023 5:22:01 AM 13c34964-a135-4390-aa53-32f3c7251982 Application ps-test +eastus qumulo-01 6/24/2023 5:27:12 AM user@organization.com User 6/24/2023 5:27:12 AM 13c34964-a135-4390-aa53-32f3c7251982 Application ps-test +eastus qumulo-02 6/24/2023 5:31:50 AM user@organization.com User 6/24/2023 5:31:50 AM 13c34964-a135-4390-aa53-32f3c7251982 Application ps-test +eastus fileSystem 5/24/2023 7:10:01 AM user@organization.com User 5/24/2023 7:19:16 AM 13c34964-a135-4390-aa53-32f3c7251982 Application ps-joyer-test +eastus qumulo-resource-01 5/24/2023 7:27:12 AM user@organization.com User 5/24/2023 7:42:17 AM 13c34964-a135-4390-aa53-32f3c7251982 Application ps-joyer-test +eastus qumulo-resource-02 5/24/2023 9:31:50 AM user@organization.com User 5/24/2023 9:41:10 AM 13c34964-a135-4390-aa53-32f3c7251982 Application ps-joyer-test +``` + +Get list of file system resources by subscription + +### Example 2: List by resource group +```powershell +Get-AzQumuloFileSystem -ResourceGroupName ps-joyer-test +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +eastus fileSystem 5/24/2023 7:10:01 AM user@organization.com User 5/24/2023 7:19:16 AM 13c34964-a135-4390-aa53-32f3c7251982 Application ps-joyer-test +eastus qumulo-resource-01 5/24/2023 7:27:12 AM user@organization.com User 5/24/2023 7:42:17 AM 13c34964-a135-4390-aa53-32f3c7251982 Application ps-joyer-test +eastus qumulo-resource-02 5/24/2023 9:31:50 AM user@organization.com User 5/24/2023 9:41:10 AM 13c34964-a135-4390-aa53-32f3c7251982 Application ps-joyer-test +``` + +Get list of file system resources by resource group + +### Example 3: Get specific resource with specified resource group +```powershell +Get-AzQumuloFileSystem -ResourceGroupName azpstest-gp -Name fileSystem +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +eastus qumulo-resource-01 5/24/2023 7:27:12 AM user@organization.com User 5/24/2023 9:58:45 AM user@organization.com User ps-joyer-test +``` + +Get specific file system resource with specified resource group + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Qumulo.Models.IQumuloIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the File System resource + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: FileSystemName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Qumulo.Models.IQumuloIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Qumulo.Models.Api20221012Preview.IFileSystemResource + +## 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 <IQumuloIdentity>`: Identity Parameter + - `[FileSystemName <String>]`: Name of the File System resource + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Qumulo/New-AzQumuloFileSystem.md b/azps-10.1.0/Az.Qumulo/New-AzQumuloFileSystem.md new file mode 100644 index 0000000000..40ce482bb0 --- /dev/null +++ b/azps-10.1.0/Az.Qumulo/New-AzQumuloFileSystem.md @@ -0,0 +1,444 @@ +--- +external help file: +Module Name: Az.Qumulo +online version: https://learn.microsoft.com/powershell/module/az.qumulo/new-azqumulofilesystem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Qumulo/help/New-AzQumuloFileSystem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Qumulo/help/New-AzQumuloFileSystem.md +--- + +# New-AzQumuloFileSystem + +## SYNOPSIS +Create a file system resource + +## SYNTAX + +``` +New-AzQumuloFileSystem -Name <String> -ResourceGroupName <String> -AdminPassword <SecureString> + -DelegatedSubnetId <String> -InitialCapacity <Int32> -Location <String> -MarketplaceOfferId <String> + -MarketplacePlanId <String> -MarketplacePublisherId <String> -StorageSku <StorageSku> -UserEmail <String> + [-SubscriptionId <String>] [-AvailabilityZone <String>] [-ClusterLoginUrl <String>] + [-IdentityType <ManagedServiceIdentityType>] [-MarketplaceSubscriptionId <String>] [-PrivateIP <String[]>] + [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a file system resource + +## EXAMPLES + +### Example 1: Create a minimum set file system resource +```powershell +$password = ConvertTo-SecureString "1qaz@WSX" -AsPlainText + +New-AzQumuloFileSystem -Name qumulo01 -ResourceGroupName ps-joyer-test -DelegatedSubnetId /subscriptions/fc35d936-3b89-41f8-8110-a24b56826c37/resourceGroups/ps-joyer-test/providers/Microsoft.Network/virtualNetworks/eastus-ps-virtualnetwork/subnets/qumulo-vn -InitialCapacity 50 -Location eastus -MarketplaceOfferId "qumulo-saas-mpp" -MarketplacePlanId "qumulo-on-azure-v1%%gmz7xq9ge3py%%P1M" -MarketplacePublisherId qumulo1584033880660 -StorageSku Standard -UserEmail user@organization.com -AdminPassword $password +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +eastus qumulo01 5/24/2023 7:27:12 AM user@organization.com User 5/24/2023 7:42:17 AM 13c34964-a135-4390-aa53-32f3c7251982 Application ps-joyer-test +``` + +Create a file system resource. +The password must contain at least 8 characters and have at least 1 letter, 1 number and 1 special character. + +### Example 2: Create a file system resource with other settings +```powershell +$password = ConvertTo-SecureString "2wsx#EDC" -AsPlainText + +New-AzQumuloFileSystem -Name qumulo02 -ResourceGroupName ps-joyer-test -AdminPassword $password -DelegatedSubnetId /subscriptions/fc35d936-3b89-41f8-8110-a24b56826c37/resourceGroups/ps-joyer-test/providers/Microsoft.Network/virtualNetworks/eastus-ps-virtualnetwork/subnets/qumulo-vn -InitialCapacity 50 -Location eastus -MarketplaceOfferId "qumulo-saas-mpp" -MarketplacePlanId "qumulo-on-azure-v1%%gmz7xq9ge3py%%P1M" -MarketplacePublisherId qumulo1584033880660 -StorageSku Standard -UserEmail user@organization.com -AvailabilityZone 1 -Tag @{"123"="abc"} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +eastus qumulo02 5/24/2023 9:31:50 AM user@organization.com User 5/24/2023 9:41:10 AM 13c34964-a135-4390-aa53-32f3c7251982 Application ps-joyer-test +``` + +Create a file system resource with a maximum set + +## PARAMETERS + +### -AdminPassword +Initial administrator password of the resource + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityZone +Availability zone + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterLoginUrl +File system Id of the resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelegatedSubnetId +Delegated subnet id for Vnet injection + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Qumulo.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialCapacity +Storage capacity in TB + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceOfferId +Offer Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplacePlanId +Plan Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplacePublisherId +Publisher Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceSubscriptionId +Marketplace Subscription Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the File System resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FileSystemName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIP +Private IPs of the resource + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSku +Storage Sku + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Qumulo.Support.StorageSku +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEmail +User Email + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Qumulo.Models.Api20221012Preview.IFileSystemResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Qumulo/Remove-AzQumuloFileSystem.md b/azps-10.1.0/Az.Qumulo/Remove-AzQumuloFileSystem.md new file mode 100644 index 0000000000..55f997dd07 --- /dev/null +++ b/azps-10.1.0/Az.Qumulo/Remove-AzQumuloFileSystem.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Qumulo +online version: https://learn.microsoft.com/powershell/module/az.qumulo/remove-azqumulofilesystem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Qumulo/help/Remove-AzQumuloFileSystem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Qumulo/help/Remove-AzQumuloFileSystem.md +--- + +# Remove-AzQumuloFileSystem + +## SYNOPSIS +Delete a file system resource + +## SYNTAX + +### Delete (Default) +``` +Remove-AzQumuloFileSystem -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzQumuloFileSystem -InputObject <IQumuloIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a file system resource + +## EXAMPLES + +### Example 1: Remove specific resource with specified resource group +```powershell +Remove-AzQumuloFileSystem -Name qumulo01 -ResourceGroupName ps-joyer-test02 +``` + +Remove specific resource with specified resource group + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Qumulo.Models.IQumuloIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the File System resource + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: FileSystemName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Qumulo.Models.IQumuloIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IQumuloIdentity>`: Identity Parameter + - `[FileSystemName <String>]`: Name of the File System resource + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Qumulo/Update-AzQumuloFileSystem.md b/azps-10.1.0/Az.Qumulo/Update-AzQumuloFileSystem.md new file mode 100644 index 0000000000..1749126cd7 --- /dev/null +++ b/azps-10.1.0/Az.Qumulo/Update-AzQumuloFileSystem.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.Qumulo +online version: https://learn.microsoft.com/powershell/module/az.qumulo/update-azqumulofilesystem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Qumulo/help/Update-AzQumuloFileSystem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Qumulo/help/Update-AzQumuloFileSystem.md +--- + +# Update-AzQumuloFileSystem + +## SYNOPSIS +Update a file system resource + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzQumuloFileSystem -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzQumuloFileSystem -InputObject <IQumuloIdentity> [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a file system resource + +## EXAMPLES + +### Example 1: Update tags with specific name and group +```powershell +Update-AzQumuloFileSystem -ResourceGroupName ps-joyer-test -Name qumulo-resource-01 -Tag @{"123"="abc"} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGrou + pName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ------------ +eastus qumulo-resource-01 6/8/2023 9:49:18 AM user@organization.com User 6/21/2023 6:27:53 AM user@organization.com User ps-joyer-te… +``` + +Update tags with specific name and group + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Qumulo.Models.IQumuloIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the File System resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: FileSystemName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Qumulo.Models.IQumuloIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Qumulo.Models.Api20221012Preview.IFileSystemResource + +## 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 <IQumuloIdentity>`: Identity Parameter + - `[FileSystemName <String>]`: Name of the File System resource + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Quota/Az.Quota.md b/azps-10.1.0/Az.Quota/Az.Quota.md new file mode 100644 index 0000000000..c413868dea --- /dev/null +++ b/azps-10.1.0/Az.Quota/Az.Quota.md @@ -0,0 +1,47 @@ +--- +Module Name: Az.Quota +Module Guid: bd26548c-ac2c-4447-9d5d-2e4d8c622495 +Download Help Link: https://learn.microsoft.com/powershell/module/az.quota +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/Az.Quota.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/Az.Quota.md +--- + +# Az.Quota Module +## Description +Microsoft Azure PowerShell: Quota cmdlets + +## Az.Quota Cmdlets +### [Get-AzQuota](Get-AzQuota.md) +Get the quota limit of a resource. +The response can be used to determine the remaining quota to calculate a new quota limit that can be submitted with a PUT request. + +### [Get-AzQuotaOperation](Get-AzQuotaOperation.md) +List all the operations supported by the Microsoft.Quota resource provider. + +### [Get-AzQuotaRequestStatus](Get-AzQuotaRequestStatus.md) +Get the quota request details and status by quota request ID for the resources of the resource provider at a specific location. +The quota request ID **id** is returned in the response of the PUT operation. + +### [Get-AzQuotaUsage](Get-AzQuotaUsage.md) +Get the current usage of a resource. + +### [New-AzQuota](New-AzQuota.md) +Create or update the quota limit for the specified resource with the requested value. +To update the quota, follow these steps:\n1. +Use the GET operation for quotas and usages to determine how much quota remains for the specific resource and to calculate the new quota limit. +These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670).\n2. +Use this PUT operation to update the quota limit. +Please check the URI in location header for the detailed status of the request. + +### [New-AzQuotaLimitObject](New-AzQuotaLimitObject.md) +Create an in-memory object for LimitObject. + +### [Update-AzQuota](Update-AzQuota.md) +Update the quota limit for a specific resource to the specified value:\n1. +Use the Usages-GET and Quota-GET operations to determine the remaining quota for the specific resource and to calculate the new quota limit. +These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670).\n2. +Use this PUT operation to update the quota limit. +Please check the URI in location header for the detailed status of the request. + diff --git a/azps-10.1.0/Az.Quota/Get-AzQuota.md b/azps-10.1.0/Az.Quota/Get-AzQuota.md new file mode 100644 index 0000000000..a25f1d4478 --- /dev/null +++ b/azps-10.1.0/Az.Quota/Get-AzQuota.md @@ -0,0 +1,168 @@ +--- +external help file: +Module Name: Az.Quota +online version: https://learn.microsoft.com/powershell/module/az.quota/get-azquota +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/Get-AzQuota.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/Get-AzQuota.md +--- + +# Get-AzQuota + +## SYNOPSIS +Get the quota limit of a resource. +The response can be used to determine the remaining quota to calculate a new quota limit that can be submitted with a PUT request. + +## SYNTAX + +### List (Default) +``` +Get-AzQuota -Scope <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzQuota -ResourceName <String> -Scope <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzQuota -InputObject <IQuotaIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the quota limit of a resource. +The response can be used to determine the remaining quota to calculate a new quota limit that can be submitted with a PUT request. + +## EXAMPLES + +### Example 1: List the quota limits of a scope +```powershell +Get-AzQuota -Scope "subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/providers/Microsoft.Network/locations/eastus" +``` + +```output +Name ResourceGroupName Unit ETag +---- ----------------- ---- ---- +VirtualNetworks Count +StaticPublicIPAddresses Count +NetworkSecurityGroups Count +PublicIPAddresses Count +CustomIpPrefixes Count +PublicIpPrefixes Count +``` + +This command lists the quota limits of a scope. + +### Example 2: Get the quota limit of a resource +```powershell +Get-AzQuota -Scope "subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/providers/Microsoft.Network/locations/eastus" -ResourceName "MinPublicIpInterNetworkPrefixLength" +``` + +```output +Name NameLocalizedValue Unit ETag +---- ------------------ ---- ---- +MinPublicIpInterNetworkPrefixLength Public IPv4 Prefix Length Count +``` + +This command gets the quota limit of a resource. +The response can be used to determine the remaining quota to calculate a new quota limit that can be submitted with a PUT request. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Quota.Models.IQuotaIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceName +Resource name for a given resource provider. +For example: +- SKU name for Microsoft.Compute +- SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices + For Microsoft.Network PublicIPAddresses. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The target Azure resource URI. +For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. +This is the target Azure resource URI for the List GET operation. +If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Quota.Models.IQuotaIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Quota.Models.Api20210315Preview.ICurrentQuotaLimitBase + +## 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 `<IQuotaIdentity>`: Identity Parameter + - `[Id <String>]`: Quota request ID. + - `[Id1 <String>]`: Resource identity path + - `[ResourceName <String>]`: Resource name for a given resource provider. For example: - SKU name for Microsoft.Compute - SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices For Microsoft.Network PublicIPAddresses. + - `[Scope <String>]`: The target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Quota/Get-AzQuotaOperation.md b/azps-10.1.0/Az.Quota/Get-AzQuotaOperation.md new file mode 100644 index 0000000000..1c7cd1f60c --- /dev/null +++ b/azps-10.1.0/Az.Quota/Get-AzQuotaOperation.md @@ -0,0 +1,75 @@ +--- +external help file: +Module Name: Az.Quota +online version: https://learn.microsoft.com/powershell/module/az.quota/get-azquotaoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/Get-AzQuotaOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/Get-AzQuotaOperation.md +--- + +# Get-AzQuotaOperation + +## SYNOPSIS +List all the operations supported by the Microsoft.Quota resource provider. + +## SYNTAX + +``` +Get-AzQuotaOperation [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List all the operations supported by the Microsoft.Quota resource provider. + +## EXAMPLES + +### Example 1: List the quota operation +```powershell +Get-AzQuotaOperation +``` + +```output +Name Origin +---- ------ +Microsoft.Quota/quotas/read +Microsoft.Quota/quotas/write +Microsoft.Quota/quotaRequests/read +Microsoft.Quota/usages/read +Microsoft.Quota/operations/read +Microsoft.Quota/register/action +``` + +This command lists all the operations supported by the Microsoft.Quota resource provider. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Quota.Models.Api20210315Preview.IOperationResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Quota/Get-AzQuotaRequestStatus.md b/azps-10.1.0/Az.Quota/Get-AzQuotaRequestStatus.md new file mode 100644 index 0000000000..0ac3ab2b37 --- /dev/null +++ b/azps-10.1.0/Az.Quota/Get-AzQuotaRequestStatus.md @@ -0,0 +1,185 @@ +--- +external help file: +Module Name: Az.Quota +online version: https://learn.microsoft.com/powershell/module/az.quota/get-azquotarequeststatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/Get-AzQuotaRequestStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/Get-AzQuotaRequestStatus.md +--- + +# Get-AzQuotaRequestStatus + +## SYNOPSIS +Get the quota request details and status by quota request ID for the resources of the resource provider at a specific location. +The quota request ID **id** is returned in the response of the PUT operation. + +## SYNTAX + +### List (Default) +``` +Get-AzQuotaRequestStatus -Scope <String> [-Filter <String>] [-Skiptoken <String>] [-Top <Int32>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzQuotaRequestStatus -Id <String> -Scope <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the quota request details and status by quota request ID for the resources of the resource provider at a specific location. +The quota request ID **id** is returned in the response of the PUT operation. + +## EXAMPLES + +### Example 1: List the quota request details and status for the scope +```powershell +Get-AzQuotaRequestStatus -Scope "subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/providers/Microsoft.Network/locations/eastus" +``` + +```output +Name ProvisioningState ErrorMessage Code +---- ----------------- ------------ ---- +171f4e10-f396-48bc-a93f-245cfd7ebe75 Succeeded +0f5636d8-9377-4aec-9a57-5cdeded08615 Succeeded +3ae1cf1d-c792-448f-b2ff-33334ea1a28b Succeeded +5698cdd1-6b4b-4ec1-9a39-a4b5963094dd Succeeded +fb507eaa-f45f-476d-a1a5-77c74b1224b2 Succeeded +22f8a9f1-a003-42a0-9892-474a0478ceea Succeeded +103e114c-3894-4b33-a673-b3d814eea753 Succeeded +9decdd61-be39-4815-96d7-dfad78674940 Succeeded +3a4c474e-cfb1-4af6-baff-0f0bfea67b61 Succeeded +``` + +This command lists the quota request details and status for the scope. + +### Example 2: Get the quota request details and status by quota request ID for the resources of the resource provider at a specific location +```powershell +Get-AzQuotaRequestStatus -Scope "subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/providers/Microsoft.Network/locations/eastus" -Id "6cf5716a-3df8-421a-8457-719e10381dbc" +``` + +```output +Name ProvisioningState ErrorMessage Code +---- ----------------- ------------ ---- +6cf5716a-3df8-421a-8457-719e10381dbc Failed Request failed. QuotaReductionNotSupported +``` + +This command gets the quota request details and status by quota request ID for the resources of the resource provider at a specific location. +The quota request ID **id** is returned in the response of the PUT operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +| Field | Supported operators +|---------------------|------------------------ + +|requestSubmitTime | ge, le, eq, gt, lt + |provisioningState eq {QuotaRequestState} + |resourceName eq {resourceName} + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Quota request ID. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The target Azure resource URI. +For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. +This is the target Azure resource URI for the List GET operation. +If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skiptoken +The **Skiptoken** parameter is used only if a previous operation returned a partial result. +If a previous response contains a **nextLink** element, its value includes a **skiptoken** parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Number of records to return. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Quota.Models.Api20210315Preview.IQuotaRequestDetails + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Quota/Get-AzQuotaUsage.md b/azps-10.1.0/Az.Quota/Get-AzQuotaUsage.md new file mode 100644 index 0000000000..b95ec0c6b3 --- /dev/null +++ b/azps-10.1.0/Az.Quota/Get-AzQuotaUsage.md @@ -0,0 +1,140 @@ +--- +external help file: +Module Name: Az.Quota +online version: https://learn.microsoft.com/powershell/module/az.quota/get-azquotausage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/Get-AzQuotaUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/Get-AzQuotaUsage.md +--- + +# Get-AzQuotaUsage + +## SYNOPSIS +Get the current usage of a resource. + +## SYNTAX + +### List (Default) +``` +Get-AzQuotaUsage -Scope <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzQuotaUsage -Name <String> -Scope <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the current usage of a resource. + +## EXAMPLES + +### Example 1: List the currents usage of a resource +```powershell +Get-AzQuotaUsage -Scope "subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/providers/Microsoft.Network/locations/eastus" +``` + +```output +Name ResourceGroupName UsageUsagesType UsageValue ETag +---- ----------------- --------------- ---------- ---- +VirtualNetworks 0 +StaticPublicIPAddresses 0 +NetworkSecurityGroups 0 +PublicIPAddresses 0 +CustomIpPrefixes 0 +PublicIpPrefixes 0 +NatGateways 0 +NetworkInterfaces 0 +PrivateEndpoints 0 +PrivateEndpointRedirectMaps 0 +LoadBalancers 0 +PrivateLinkServices 0 +ApplicationGateways 0 +RouteTables 0 +RouteFilters 0 +``` + +This command lists the currents usage of a resource + +### Example 2: Get the current usage of a resource +```powershell +Get-AzQuotaUsage -Scope "subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/providers/Microsoft.Network/locations/eastus" -Name "MinPublicIpInterNetworkPrefixLength" +``` + +```output +Name NameLocalizedValue UsageUsagesType UsageValue ETag +---- ------------------ --------------- ---------- ---- +MinPublicIpInterNetworkPrefixLength Public IPv4 Prefix Length 0 +``` + +This command lists the currents usage of a resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name for a given resource provider. +For example: +- SKU name for Microsoft.Compute +- SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices + For Microsoft.Network PublicIPAddresses. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The target Azure resource URI. +For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. +This is the target Azure resource URI for the List GET operation. +If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Quota.Models.Api20210315Preview.ICurrentUsagesBase + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Quota/New-AzQuota.md b/azps-10.1.0/Az.Quota/New-AzQuota.md new file mode 100644 index 0000000000..e1e6d78b78 --- /dev/null +++ b/azps-10.1.0/Az.Quota/New-AzQuota.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.Quota +online version: https://learn.microsoft.com/powershell/module/az.quota/new-azquota +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/New-AzQuota.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/New-AzQuota.md +--- + +# New-AzQuota + +## SYNOPSIS +Create or update the quota limit for the specified resource with the requested value. +To update the quota, follow these steps:\n1. +Use the GET operation for quotas and usages to determine how much quota remains for the specific resource and to calculate the new quota limit. +These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670).\n2. +Use this PUT operation to update the quota limit. +Please check the URI in location header for the detailed status of the request. + +## SYNTAX + +``` +New-AzQuota -ResourceName <String> -Scope <String> [-Limit <ILimitJsonObject>] [-Name <String>] + [-ResourceType <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update the quota limit for the specified resource with the requested value. +To update the quota, follow these steps:\n1. +Use the GET operation for quotas and usages to determine how much quota remains for the specific resource and to calculate the new quota limit. +These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670).\n2. +Use this PUT operation to update the quota limit. +Please check the URI in location header for the detailed status of the request. + +## EXAMPLES + +### Example 1: Create or update the quota limit for the specified resource with the requested value +```powershell +$limit = New-AzQuotaLimitObject -Value 1003 +New-AzQuota -Scope "subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/providers/Microsoft.Network/locations/eastus2" -ResourceName "PublicIPAddresses" -Name "PublicIPAddresses" -Limit $limit +``` + +```output +Name NameLocalizedValue Unit ETag +---- ------------------ ---- ---- +PublicIPAddresses Public IP Addresses - Basic Count +``` + +This command create or update the quota limit for the specified resource with the requested value. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Limit +Resource quota limit properties. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Quota.Models.Api20210315Preview.ILimitJsonObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +Resource name for a given resource provider. +For example: +- SKU name for Microsoft.Compute +- SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices + For Microsoft.Network PublicIPAddresses. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +Resource type name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The target Azure resource URI. +For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. +This is the target Azure resource URI for the List GET operation. +If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Quota.Models.Api20210315Preview.ICurrentQuotaLimitBase + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Quota/New-AzQuotaLimitObject.md b/azps-10.1.0/Az.Quota/New-AzQuotaLimitObject.md new file mode 100644 index 0000000000..90961e0fe9 --- /dev/null +++ b/azps-10.1.0/Az.Quota/New-AzQuotaLimitObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.Quota +online version: https://learn.microsoft.com/powershell/module/az.Quota/New-AzQuotaLimitObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/New-AzQuotaLimitObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/New-AzQuotaLimitObject.md +--- + +# New-AzQuotaLimitObject + +## SYNOPSIS +Create an in-memory object for LimitObject. + +## SYNTAX + +``` +New-AzQuotaLimitObject -Value <Int32> [-LimitType <QuotaLimitTypes>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for LimitObject. + +## EXAMPLES + +### Example 1: Create an in-memory object for LimitValue +```powershell +New-AzQuotaLimitObject -Value 1003 +``` + +```output +LimitObjectType LimitType Value +--------------- --------- ----- +LimitValue 1003 +``` + +This command create an in-memory object for LimitValue as value of the parameter Limit in the New/Update-AzQuota cmdlet. + +## PARAMETERS + +### -LimitType +The quota or usages limit types. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Quota.Support.QuotaLimitTypes +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The quota/limit value. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Quota.Models.Api20210315Preview.LimitObject + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Quota/Update-AzQuota.md b/azps-10.1.0/Az.Quota/Update-AzQuota.md new file mode 100644 index 0000000000..cb93ac531c --- /dev/null +++ b/azps-10.1.0/Az.Quota/Update-AzQuota.md @@ -0,0 +1,275 @@ +--- +external help file: +Module Name: Az.Quota +online version: https://learn.microsoft.com/powershell/module/az.quota/update-azquota +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/Update-AzQuota.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Quota/help/Update-AzQuota.md +--- + +# Update-AzQuota + +## SYNOPSIS +Update the quota limit for a specific resource to the specified value:\n1. +Use the Usages-GET and Quota-GET operations to determine the remaining quota for the specific resource and to calculate the new quota limit. +These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670).\n2. +Use this PUT operation to update the quota limit. +Please check the URI in location header for the detailed status of the request. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzQuota -ResourceName <String> -Scope <String> [-Limit <ILimitJsonObject>] [-Name <String>] + [-ResourceType <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzQuota -InputObject <IQuotaIdentity> [-Limit <ILimitJsonObject>] [-Name <String>] + [-ResourceType <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Update the quota limit for a specific resource to the specified value:\n1. +Use the Usages-GET and Quota-GET operations to determine the remaining quota for the specific resource and to calculate the new quota limit. +These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670).\n2. +Use this PUT operation to update the quota limit. +Please check the URI in location header for the detailed status of the request. + +## EXAMPLES + +### Example 1: Update the quota limit for a specific resource to the specified value +```powershell +$limit = New-AzQuotaLimitObject -Value 1001 +Update-AzQuota -Scope "subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/providers/Microsoft.Network/locations/eastus2" -ResourceName "PublicIPAddresses" -Name "PublicIPAddresses" -Limit $limit +``` + +```output +Name NameLocalizedValue UsageUsagesType UsageValue ETag +---- ------------------ --------------- ---------- ---- +PublicIPAddresses Public IP Addresses - Basic 0 +``` + +This command update the quota limit for a specific resource to the specified value. + +### Example 2: Update the quota limit for a specific resource to the specified value by pipeline +```powershell +$limit = New-AzQuotaLimitObject -Value 1007 +Get-AzQuota -Scope "subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/providers/Microsoft.Network/locations/eastus2" -ResourceName "PublicIPAddresses" | Update-AzQuota -Name "PublicIPAddresses" -Limit $limit +``` + +```output +Name NameLocalizedValue UsageUsagesType UsageValue ETag +---- ------------------ --------------- ---------- ---- +PublicIPAddresses Public IP Addresses - Basic 0 +``` + +This command update the quota limit for a specific resource to the specified value by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Quota.Models.IQuotaIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Limit +Resource quota limit properties. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Quota.Models.Api20210315Preview.ILimitJsonObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +Resource name for a given resource provider. +For example: +- SKU name for Microsoft.Compute +- SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices + For Microsoft.Network PublicIPAddresses. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +Resource type name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The target Azure resource URI. +For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. +This is the target Azure resource URI for the List GET operation. +If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Quota.Models.IQuotaIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Quota.Models.Api20210315Preview.ICurrentQuotaLimitBase + +## 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 `<IQuotaIdentity>`: Identity Parameter + - `[Id <String>]`: Quota request ID. + - `[Id1 <String>]`: Resource identity path + - `[ResourceName <String>]`: Resource name for a given resource provider. For example: - SKU name for Microsoft.Compute - SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices For Microsoft.Network PublicIPAddresses. + - `[Scope <String>]`: The target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RecoveryServices/Add-AzRecoveryServicesAsrReplicationProtectedItemDisk.md b/azps-10.1.0/Az.RecoveryServices/Add-AzRecoveryServicesAsrReplicationProtectedItemDisk.md new file mode 100644 index 0000000000..cfa4bbe9b4 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Add-AzRecoveryServicesAsrReplicationProtectedItemDisk.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/add-azrecoveryservicesasrreplicationprotecteditemdisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Add-AzRecoveryServicesAsrReplicationProtectedItemDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Add-AzRecoveryServicesAsrReplicationProtectedItemDisk.md +--- + +# Add-AzRecoveryServicesAsrReplicationProtectedItemDisk + +## SYNOPSIS +Add the disk for protection for already protected azure virtual machine. + +## SYNTAX + +``` +Add-AzRecoveryServicesAsrReplicationProtectedItemDisk -InputObject <ASRReplicationProtectedItem> + -AzureToAzureDiskReplicationConfiguration <ASRAzuretoAzureDiskReplicationConfig[]> [-WaitForCompletion] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzRecoveryServicesAsrReplicationProtectedItemDisk** cmdlet add the disk for protection for already protected azure virtual machine. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzRecoveryServicesAsrReplicationProtectedItemDisk -ReplicationProtectedItem $rpi -AzureToAzureDiskReplicationConfiguration $disk1,$disk2 +``` + +Start the operation to add specified disk configuration for protection. + +### Example 2 +```powershell +$ReplicationProtectedItem |Add-AzRecoveryServicesAsrReplicationProtectedItemDisk -AzureToAzureDiskReplicationConfiguration $disk1,$disk2 +``` + +Start the operation to add specified disk configuration for protection.Piping input replication protected item. + +## PARAMETERS + +### -AzureToAzureDiskReplicationConfiguration +Specifies the disk configuration to used for disk protection for Azure to Azure disaster recovery scenario. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRAzuretoAzureDiskReplicationConfig[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The input object to the cmdlet: The ASR replication protected item object corresponding to which new disk should be protected. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: (All) +Aliases: ReplicationProtectedItem + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WaitForCompletion +Wait For Completion + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Az.RecoveryServices.md b/azps-10.1.0/Az.RecoveryServices/Az.RecoveryServices.md new file mode 100644 index 0000000000..8d4f1b7420 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Az.RecoveryServices.md @@ -0,0 +1,367 @@ +--- +Module Name: Az.RecoveryServices +Module Guid: 4aa53b7e-fcfe-4e22-979c-9a4e6380de58 +Download Help Link: https://learn.microsoft.com/powershell/module/az.recoveryservices +Help Version: 4.1.2.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Az.RecoveryServices.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Az.RecoveryServices.md +--- + +# Az.RecoveryServices Module +## Description +This topic displays help topics for the Azure Recovery Services cmdlets. + +## Az.RecoveryServices Cmdlets +### [Add-AzRecoveryServicesAsrReplicationProtectedItemDisk](Add-AzRecoveryServicesAsrReplicationProtectedItemDisk.md) +Add the disk for protection for already protected azure virtual machine. + +### [Backup-AzRecoveryServicesBackupItem](Backup-AzRecoveryServicesBackupItem.md) +Starts a backup for a Backup item. + +### [Copy-AzRecoveryServicesVault](Copy-AzRecoveryServicesVault.md) +Copies data from a vault in one region to a vault in another region. + +### [Disable-AzRecoveryServicesBackupAutoProtection](Disable-AzRecoveryServicesBackupAutoProtection.md) +Disables auto backup for a protectable item. + +### [Disable-AzRecoveryServicesBackupProtection](Disable-AzRecoveryServicesBackupProtection.md) +Disables protection for a Backup-protected item. + +### [Disable-AzRecoveryServicesBackupRPMountScript](Disable-AzRecoveryServicesBackupRPMountScript.md) +Dismounts all the files of the recovery point. + +### [Edit-AzRecoveryServicesAsrRecoveryPlan](Edit-AzRecoveryServicesAsrRecoveryPlan.md) +Edits a Site Recovery plan. + +### [Enable-AzRecoveryServicesBackupAutoProtection](Enable-AzRecoveryServicesBackupAutoProtection.md) +The **Enable-AzRecoveryServicesBackupAutoProtection** cmdlet sets up automatic protection of current and any future SQL DBs within the given instance with the supplied policy. + +### [Enable-AzRecoveryServicesBackupProtection](Enable-AzRecoveryServicesBackupProtection.md) +Enables or resumes backup for an item with a specified Backup protection policy. + +### [Get-AzRecoveryServicesAsrAlertSetting](Get-AzRecoveryServicesAsrAlertSetting.md) +Gets the configured Azure Site Recovery notification settings for the vault. + +### [Get-AzRecoveryServicesAsrEvent](Get-AzRecoveryServicesAsrEvent.md) +Gets details of Azure Site Recovery events in the vault. + +### [Get-AzRecoveryServicesAsrFabric](Get-AzRecoveryServicesAsrFabric.md) +Get the details of an Azure Site Recovery Fabric. + +### [Get-AzRecoveryServicesAsrJob](Get-AzRecoveryServicesAsrJob.md) +Gets the details of the specified ASR job or the list of recent ASR jobs in the Recovery Services vault. + +### [Get-AzRecoveryServicesAsrNetwork](Get-AzRecoveryServicesAsrNetwork.md) +Gets information about the networks managed by Site Recovery for the current vault. + +### [Get-AzRecoveryServicesAsrNetworkMapping](Get-AzRecoveryServicesAsrNetworkMapping.md) +Gets information about Site Recovery network mappings for the current vault. + +### [Get-AzRecoveryServicesAsrPolicy](Get-AzRecoveryServicesAsrPolicy.md) +Gets ASR replication policies. + +### [Get-AzRecoveryServicesAsrProtectableItem](Get-AzRecoveryServicesAsrProtectableItem.md) +Get the protectable items in an ASR protection container. + +### [Get-AzRecoveryServicesAsrProtectionContainer](Get-AzRecoveryServicesAsrProtectionContainer.md) +Gets ASR protection containers in the Recovery Services vault. + +### [Get-AzRecoveryServicesAsrProtectionContainerMapping](Get-AzRecoveryServicesAsrProtectionContainerMapping.md) +Gets Azure Site Recovery Protection Container mappings. + +### [Get-AzRecoveryServicesAsrRecoveryPlan](Get-AzRecoveryServicesAsrRecoveryPlan.md) +Gets a recovery plan or all the recovery plans in the Recovery Services vault + +### [Get-AzRecoveryServicesAsrRecoveryPoint](Get-AzRecoveryServicesAsrRecoveryPoint.md) +Gets the available recovery points for a replication protected item. + +### [Get-AzRecoveryServicesAsrReplicationProtectedItem](Get-AzRecoveryServicesAsrReplicationProtectedItem.md) +Gets the properties of an Azure Site Recovery Replication Protected Items. + +### [Get-AzRecoveryServicesAsrServicesProvider](Get-AzRecoveryServicesAsrServicesProvider.md) +Gets the details of the ASR recovery services providers registered to the Recovery Services vault. + +### [Get-AzRecoveryServicesAsrStorageClassification](Get-AzRecoveryServicesAsrStorageClassification.md) +Gets the available(discovered) ASR storage classifications in the Recovery Services vault. + +### [Get-AzRecoveryServicesAsrStorageClassificationMapping](Get-AzRecoveryServicesAsrStorageClassificationMapping.md) +Gets ASR storage classification mappings. + +### [Get-AzRecoveryServicesAsrVaultContext](Get-AzRecoveryServicesAsrVaultContext.md) +Gets ASR vault settings information for the Recovery Services vault. + +### [Get-AzRecoveryServicesAsrvCenter](Get-AzRecoveryServicesAsrvCenter.md) +Gets details of the vCenter servers registered for discovery on the Configuration server specified by the ASR fabric. + +### [Get-AzRecoveryServicesBackupContainer](Get-AzRecoveryServicesBackupContainer.md) +Gets Backup containers. + +### [Get-AzRecoveryServicesBackupItem](Get-AzRecoveryServicesBackupItem.md) +Gets the items from a container in Backup. + +### [Get-AzRecoveryServicesBackupJob](Get-AzRecoveryServicesBackupJob.md) +Gets Backup jobs. + +### [Get-AzRecoveryServicesBackupJobDetail](Get-AzRecoveryServicesBackupJobDetail.md) +Gets details for a Backup job. + +### [Get-AzRecoveryServicesBackupManagementServer](Get-AzRecoveryServicesBackupManagementServer.md) +Gets SCDPM and Azure Backup management servers. + +### [Get-AzRecoveryServicesBackupProperty](Get-AzRecoveryServicesBackupProperty.md) +Gets Backup properties. + +### [Get-AzRecoveryServicesBackupProtectableItem](Get-AzRecoveryServicesBackupProtectableItem.md) +This command will retrieve all protectable items within a certain container or across all registered containers. It will consist of all the elements of the hierarchy of the application. Returns DBs and their upper tier entities like Instance, AvailabilityGroup etc. + +### [Get-AzRecoveryServicesBackupProtectionPolicy](Get-AzRecoveryServicesBackupProtectionPolicy.md) +Gets Backup protection policies for a vault. + +### [Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup](Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup.md) +Gets the recovery points which are recommended to be moved together to VaultArchive tier. + +### [Get-AzRecoveryServicesBackupRecoveryLogChain](Get-AzRecoveryServicesBackupRecoveryLogChain.md) +This command lists the start and end points of the unbroken log chain of the given backup item. Use it to determine whether the point-in-time, to which the user wants the DB to be restored, is valid or not. + +### [Get-AzRecoveryServicesBackupRecoveryPoint](Get-AzRecoveryServicesBackupRecoveryPoint.md) +Gets the recovery points for a backed up item. + +### [Get-AzRecoveryServicesBackupRetentionPolicyObject](Get-AzRecoveryServicesBackupRetentionPolicyObject.md) +Gets a base retention policy object. + +### [Get-AzRecoveryServicesBackupRPMountScript](Get-AzRecoveryServicesBackupRPMountScript.md) +Downloads a script to mount all the files of the recovery point. + +### [Get-AzRecoveryServicesBackupSchedulePolicyObject](Get-AzRecoveryServicesBackupSchedulePolicyObject.md) +Gets a base schedule policy object. + +### [Get-AzRecoveryServicesBackupStatus](Get-AzRecoveryServicesBackupStatus.md) +Checks whether your ARM resource is backed up or not. + +### [Get-AzRecoveryServicesBackupWorkloadRecoveryConfig](Get-AzRecoveryServicesBackupWorkloadRecoveryConfig.md) +This command constructs the recovery configuration of a backed up item such as SQL DB. The configuration object stores all details such as the recovery mode, target destinations for the restore and application specific parameters like target physical paths for SQL. + +### [Get-AzRecoveryServicesResourceGuardMapping](Get-AzRecoveryServicesResourceGuardMapping.md) +Gets the resource guard mapping added to the recovery services vault. + +### [Get-AzRecoveryServicesVault](Get-AzRecoveryServicesVault.md) +Gets a list of Recovery Services vaults. + +### [Get-AzRecoveryServicesVaultProperty](Get-AzRecoveryServicesVaultProperty.md) +Returns the properties of a Recovery Services Vault. + +### [Get-AzRecoveryServicesVaultSettingsFile](Get-AzRecoveryServicesVaultSettingsFile.md) +Gets the Azure Site Recovery vault settings file. + +### [Import-AzRecoveryServicesAsrVaultSettingsFile](Import-AzRecoveryServicesAsrVaultSettingsFile.md) +Imports the specified ASR vault settings file to set the vault context(PowerShell session context) for subsequent ASR operations in the PowerShell session. + +### [Initialize-AzRecoveryServicesBackupProtectableItem](Initialize-AzRecoveryServicesBackupProtectableItem.md) +This command triggers the discovery of any unprotected items of the given workload type in the given container. If the DB application is not auto-protected use this command to discover new DBs whenever they are added and proceed to protect them. + +### [Initialize-AzRecoveryServicesDSMove](Initialize-AzRecoveryServicesDSMove.md) +Initializes DS move for Copy-AzRecoveryServicesVault. + +### [Move-AzRecoveryServicesBackupRecoveryPoint](Move-AzRecoveryServicesBackupRecoveryPoint.md) +Moves the recovery point from source tier to destination tier. + +### [New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig](New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig.md) +Creates a disk mapping object for Azure virtual machine disks to be replicated. + +### [New-AzRecoveryServicesAsrFabric](New-AzRecoveryServicesAsrFabric.md) +Creates an Azure Site Recovery Fabric. + +### [New-AzRecoveryServicesAsrInMageAzureV2DiskInput](New-AzRecoveryServicesAsrInMageAzureV2DiskInput.md) +Creates a disk mapping object for vMWare virtual machine disks to be replicated. + +### [New-AzRecoveryServicesAsrInMageRcmDiskInput](New-AzRecoveryServicesAsrInMageRcmDiskInput.md) +Creates Azure Site Recovery Disk replication configuration for VMware To Azure replication. + +### [New-AzRecoveryServicesAsrNetworkMapping](New-AzRecoveryServicesAsrNetworkMapping.md) +Creates an ASR network mapping between two networks. + +### [New-AzRecoveryServicesAsrPolicy](New-AzRecoveryServicesAsrPolicy.md) +Creates an Azure Site Recovery replication policy. + +### [New-AzRecoveryServicesAsrProtectableItem](New-AzRecoveryServicesAsrProtectableItem.md) +Add(Discover) a physical server to the list of protectable items. + +### [New-AzRecoveryServicesAsrProtectionContainer](New-AzRecoveryServicesAsrProtectionContainer.md) +Creates an Azure Site Recovery Protection Container within the specified fabric. + +### [New-AzRecoveryServicesAsrProtectionContainerMapping](New-AzRecoveryServicesAsrProtectionContainerMapping.md) +Creates an Azure Site Recovery Protection Container mapping by associating the specified replication policy to the specified ASR protection container. + +### [New-AzRecoveryServicesAsrRecoveryPlan](New-AzRecoveryServicesAsrRecoveryPlan.md) +Creates an ASR recovery plan. + +### [New-AzRecoveryServicesAsrReplicationProtectedItem](New-AzRecoveryServicesAsrReplicationProtectedItem.md) +Enables replication for an ASR protectable item by creating a replication protected item. + +### [New-AzRecoveryServicesAsrStorageClassificationMapping](New-AzRecoveryServicesAsrStorageClassificationMapping.md) +Creates an ASR storage classification mapping in the Recovery Services vault. + +### [New-AzRecoveryServicesAsrvCenter](New-AzRecoveryServicesAsrvCenter.md) +Adds a vCenter server to discover protectable items from. + +### [New-AzRecoveryServicesBackupProtectionPolicy](New-AzRecoveryServicesBackupProtectionPolicy.md) +Creates a Backup protection policy. + +### [New-AzRecoveryServicesVault](New-AzRecoveryServicesVault.md) +Creates a new Recovery Services vault. + +### [Register-AzRecoveryServicesBackupContainer](Register-AzRecoveryServicesBackupContainer.md) +The **Register-AzRecoveryServicesBackupContainer** cmdlet registers an Azure VM for AzureWorkloads with specific workloadType. + +### [Remove-AzRecoveryServicesAsrFabric](Remove-AzRecoveryServicesAsrFabric.md) +Deletes the specified Azure Site Recovery Fabric from the Recovery Services vault. + +### [Remove-AzRecoveryServicesAsrNetworkMapping](Remove-AzRecoveryServicesAsrNetworkMapping.md) +Deletes the specified ASR network mapping from the Recovery Services vault. + +### [Remove-AzRecoveryServicesAsrPolicy](Remove-AzRecoveryServicesAsrPolicy.md) +Deletes the specified ASR replication policy from the Recovery Services vault. + +### [Remove-AzRecoveryServicesAsrProtectionContainer](Remove-AzRecoveryServicesAsrProtectionContainer.md) +Deletes the specified Protection Container from its Fabric. + +### [Remove-AzRecoveryServicesAsrProtectionContainerMapping](Remove-AzRecoveryServicesAsrProtectionContainerMapping.md) +Deletes the specified Azure Site Recovery protection container mapping. + +### [Remove-AzRecoveryServicesAsrRecoveryPlan](Remove-AzRecoveryServicesAsrRecoveryPlan.md) +Deletes the specified ASR recovery plan from Recovery Services vault. + +### [Remove-AzRecoveryServicesAsrReplicationProtectedItem](Remove-AzRecoveryServicesAsrReplicationProtectedItem.md) +Stops/Disables replication for an Azure Site Recovery replication protected item. + +### [Remove-AzRecoveryServicesAsrServicesProvider](Remove-AzRecoveryServicesAsrServicesProvider.md) +Deletes/unregister the specified Azure Site Recovery recovery services provider from the recovery services vault. + +### [Remove-AzRecoveryServicesAsrStorageClassificationMapping](Remove-AzRecoveryServicesAsrStorageClassificationMapping.md) +Deletes the specified ASR storage classification mapping. + +### [Remove-AzRecoveryServicesAsrvCenter](Remove-AzRecoveryServicesAsrvCenter.md) +Removes the vCenter server from the ASR fabric and stops discovery of virtual machines from the vCenter server. + +### [Remove-AzRecoveryServicesBackupProtectionPolicy](Remove-AzRecoveryServicesBackupProtectionPolicy.md) +Deletes a Backup protection policy from a vault. + +### [Remove-AzRecoveryServicesResourceGuardMapping](Remove-AzRecoveryServicesResourceGuardMapping.md) +Deletes the resource guard mapping added to the recovery services vault. + +### [Remove-AzRecoveryServicesVault](Remove-AzRecoveryServicesVault.md) +Deletes a Recovery Services vault. + +### [Restart-AzRecoveryServicesAsrJob](Restart-AzRecoveryServicesAsrJob.md) +Restarts an Azure Site Recovery job. + +### [Restore-AzRecoveryServicesBackupItem](Restore-AzRecoveryServicesBackupItem.md) +Restores the data and configuration for a Backup item to the specified recovery point. The required parameters vary with the backup item type. +The same command is used to restore Azure Virtual machines, databases running within Azure Virtual machines and Azure file shares as well. + +### [Resume-AzRecoveryServicesAsrJob](Resume-AzRecoveryServicesAsrJob.md) +Resumes a suspended Azure Site Recovery job. + +### [Set-AzRecoveryServicesAsrAlertSetting](Set-AzRecoveryServicesAsrAlertSetting.md) +Configure Azure Site Recovery notification settings (email notification) for the vault. + +### [Set-AzRecoveryServicesAsrReplicationProtectedItem](Set-AzRecoveryServicesAsrReplicationProtectedItem.md) +Sets recovery properties such as target network and virtual machine size for the specified replication protected item. + +### [Set-AzRecoveryServicesAsrVaultContext](Set-AzRecoveryServicesAsrVaultContext.md) +Sets the Recovery Services vault context to be used for subsequent Azure Site Recovery operations in the current PowerShell session. + +### [Set-AzRecoveryServicesBackupProperty](Set-AzRecoveryServicesBackupProperty.md) +Sets the properties for backup management. + +### [Set-AzRecoveryServicesBackupProtectionPolicy](Set-AzRecoveryServicesBackupProtectionPolicy.md) +Modifies a Backup protection policy. + +### [Set-AzRecoveryServicesResourceGuardMapping](Set-AzRecoveryServicesResourceGuardMapping.md) +Sets the resource guard mapping to the recovery services vault. + +### [Set-AzRecoveryServicesVaultContext](Set-AzRecoveryServicesVaultContext.md) +Sets vault context. + +### [Set-AzRecoveryServicesVaultProperty](Set-AzRecoveryServicesVaultProperty.md) +Updates properties of a Vault. + +### [Start-AzRecoveryServicesAsrApplyRecoveryPoint](Start-AzRecoveryServicesAsrApplyRecoveryPoint.md) +Changes a recovery point for a failed over protected item before committing the failover operation. + +### [Start-AzRecoveryServicesAsrCancelFailoverJob](Start-AzRecoveryServicesAsrCancelFailoverJob.md) +Starts the cancel failover action for a Site Recovery object. + +### [Start-AzRecoveryServicesAsrCommitFailoverJob](Start-AzRecoveryServicesAsrCommitFailoverJob.md) +Starts the commit failover action for a Site Recovery object. + +### [Start-AzRecoveryServicesAsrPlannedFailoverJob](Start-AzRecoveryServicesAsrPlannedFailoverJob.md) +Starts a planned failover operation. + +### [Start-AzRecoveryServicesAsrResynchronizeReplicationJob](Start-AzRecoveryServicesAsrResynchronizeReplicationJob.md) +Starts replication resynchronization. + +### [Start-AzRecoveryServicesAsrSwitchAppliance](Start-AzRecoveryServicesAsrSwitchAppliance.md) +Starts the switch appliance action for a Site Recovery object. + +### [Start-AzRecoveryServicesAsrSwitchProcessServerJob](Start-AzRecoveryServicesAsrSwitchProcessServerJob.md) +Switch replication from one Process server to another for load balancing. + +### [Start-AzRecoveryServicesAsrTestFailoverCleanupJob](Start-AzRecoveryServicesAsrTestFailoverCleanupJob.md) +Starts the test failover cleanup operation. + +### [Start-AzRecoveryServicesAsrTestFailoverJob](Start-AzRecoveryServicesAsrTestFailoverJob.md) +Starts a test failover operation. + +### [Start-AzRecoveryServicesAsrUnplannedFailoverJob](Start-AzRecoveryServicesAsrUnplannedFailoverJob.md) +Starts an unplanned failover operation. + +### [Stop-AzRecoveryServicesAsrJob](Stop-AzRecoveryServicesAsrJob.md) +Stops an Azure Site Recovery job. + +### [Stop-AzRecoveryServicesBackupJob](Stop-AzRecoveryServicesBackupJob.md) +Cancels a running job. + +### [Test-AzRecoveryServicesDSMove](Test-AzRecoveryServicesDSMove.md) +This cmdlet performs necessary validations for DS Move. + +### [Undo-AzRecoveryServicesBackupItemDeletion](Undo-AzRecoveryServicesBackupItemDeletion.md) +If a backup item is deleted and present in a soft-deleted state, this command brings the item back to a state where the data is retained forever + +### [Unregister-AzRecoveryServicesBackupContainer](Unregister-AzRecoveryServicesBackupContainer.md) +Unregisters a Windows Server or other container from the vault. + +### [Unregister-AzRecoveryServicesBackupManagementServer](Unregister-AzRecoveryServicesBackupManagementServer.md) +Unregisters a SCDPM server or Backup server from the vault. + +### [Update-AzRecoveryServicesAsrMobilityService](Update-AzRecoveryServicesAsrMobilityService.md) +Push mobility service agent updates to protected machines. + +### [Update-AzRecoveryServicesAsrNetworkMapping](Update-AzRecoveryServicesAsrNetworkMapping.md) +Updates the specified azure site recovery network mapping. + +### [Update-AzRecoveryServicesAsrPolicy](Update-AzRecoveryServicesAsrPolicy.md) +Updates an Azure Site Recovery replication policy. + +### [Update-AzRecoveryServicesAsrProtectionContainerMapping](Update-AzRecoveryServicesAsrProtectionContainerMapping.md) +Update the Azure site recovery protection container mapping. + +### [Update-AzRecoveryServicesAsrProtectionDirection](Update-AzRecoveryServicesAsrProtectionDirection.md) +Updates the replication direction for the specified replication protected item or recovery plan. Used to re-protect/reverse replicate a failed over replicated item or recovery plan. + +### [Update-AzRecoveryServicesAsrRecoveryPlan](Update-AzRecoveryServicesAsrRecoveryPlan.md) +Updates the contents of an Azure Site recovery plan. + +### [Update-AzRecoveryServicesAsrServicesProvider](Update-AzRecoveryServicesAsrServicesProvider.md) +Refreshes (Refresh server) the information received from the Azure Site Recovery Services Provider. + +### [Update-AzRecoveryServicesAsrvCenter](Update-AzRecoveryServicesAsrvCenter.md) +Update discovery details for a registered vCenter. + +### [Update-AzRecoveryServicesVault](Update-AzRecoveryServicesVault.md) +Updates MSIdentity to the recovery services vault. + +### [Wait-AzRecoveryServicesBackupJob](Wait-AzRecoveryServicesBackupJob.md) +Waits for a Backup job to finish. + diff --git a/azps-10.1.0/Az.RecoveryServices/Backup-AzRecoveryServicesBackupItem.md b/azps-10.1.0/Az.RecoveryServices/Backup-AzRecoveryServicesBackupItem.md new file mode 100644 index 0000000000..bb9bb92070 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Backup-AzRecoveryServicesBackupItem.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 04D7317E-2089-4197-909D-89F0CEC4851A +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/backup-azrecoveryservicesbackupitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Backup-AzRecoveryServicesBackupItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Backup-AzRecoveryServicesBackupItem.md +--- + +# Backup-AzRecoveryServicesBackupItem + +## SYNOPSIS + +Starts a backup for a Backup item. + +## SYNTAX + +``` +Backup-AzRecoveryServicesBackupItem -Item <ItemBase> [-ExpiryDateTimeUTC <DateTime>] [-BackupType <BackupType>] + [-EnableCompression] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +The **Backup-AzRecoveryServicesBackupItem** cmdlet takes an adhoc backup of protected Azure backup item. +Using this cmdlet you can do an initial backup immediately after you enable protection or start a backup if a scheduled backup fails. +This cmdlet can also be used for custom retention with or without expiry date - refer parameters help text for more details. + +## EXAMPLES + +### Example 1: Start a backup for a Backup item + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$NamedContainer = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVM -FriendlyName "pstestv2vm1" -VaultId $vault.ID +$Item = Get-AzRecoveryServicesBackupItem -Container $NamedContainer -WorkloadType AzureVM -VaultId $vault.ID +$Job = Backup-AzRecoveryServicesBackupItem -Item $Item -VaultId $vault.ID -ExpiryDateTimeUTC (Get-Date).ToUniversalTime().AddDays(60) +$Job +``` + +```output +Operation Status StartTime EndTime JOBID +------------ --------- ------ --------- ------- +pstestv2vm1 Backup InProgress 4/23/2016 5:00:30 PM cf4b3ef5-2fac-4c8e-a215-d2eba4124f27 +``` + +The first command gets the Backup container of type AzureVM named pstestv2vm1, and then stores it in the $NamedContainer variable. +The second command gets the Backup item corresponding to the container in $NamedContainer, and then stores it in the $Item variable. +The last command triggers the backup job for the Backup item in $Item with an expiry time of 60 days from now, default value for expiry time is 30 days if not specified. + +### Example 2 + +Starts a backup for a Backup item. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Backup-AzRecoveryServicesBackupItem -ExpiryDateTimeUTC <DateTime> -Item $Item -VaultId $vault.ID +``` + +## PARAMETERS + +### -BackupType + +Type of backup to be performed + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupType +Parameter Sets: (All) +Aliases: +Accepted values: Full, Differential, Log, CopyOnlyFull + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCompression + +If enabling compression is required + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryDateTimeUTC + +Specifies an expiry time for the Recovery point as a DateTime object, if nothing is given it takes the default value of 30 days. Applicable to VM, SQL (for only Copy-only-full backup type), AFS backup items. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Item + +Specifies a Backup item for which this cmdlet starts a backup operation. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VaultId + +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupContainer](./Get-AzRecoveryServicesBackupContainer.md) + +[Get-AzRecoveryServicesBackupItem](./Get-AzRecoveryServicesBackupItem.md) + +[Restore-AzRecoveryServicesBackupItem](./Restore-AzRecoveryServicesBackupItem.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Copy-AzRecoveryServicesVault.md b/azps-10.1.0/Az.RecoveryServices/Copy-AzRecoveryServicesVault.md new file mode 100644 index 0000000000..cf94c36885 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Copy-AzRecoveryServicesVault.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/copy-azrecoveryservicesvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Copy-AzRecoveryServicesVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Copy-AzRecoveryServicesVault.md +--- + +# Copy-AzRecoveryServicesVault + +## SYNOPSIS +Copies data from a vault in one region to a vault in another region. + +## SYNTAX + +### AzureRSVaultDataMoveParameterSet (Default) +``` +Copy-AzRecoveryServicesVault [-Force] [-DefaultProfile <IAzureContextContainer>] [-SourceVault] <ARSVault> + [-TargetVault] <ARSVault> [-RetryOnlyFailed] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureRSVaultTriggerMoveParameterSet +``` +Copy-AzRecoveryServicesVault [-Force] -CorrelationIdForDataMove <String> + [-DefaultProfile <IAzureContextContainer>] [-SourceVault] <ARSVault> [-TargetVault] <ARSVault> [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Copy-AzRecoveryServicesVault** cmdlet copies data from a vault in one region to a vault in another region. Currently we only support vault level data move. + +## EXAMPLES + +### Example 1: Copy data from vault1 to vault2 + +```powershell +$sourceVault = Get-AzRecoveryServicesVault -ResourceGroupName "rgName1" -Name "vault1" +$targetVault = Get-AzRecoveryServicesVault -ResourceGroupName "rgName2" -Name "vault2" +Copy-AzRecoveryServicesVault -SourceVault $sourceVault -TargetVault $targetVault +``` + +The first two cmdlets fetch Recovery Services Vault - vault1 and vault2 respectively. The second command triggers a complete data move from vault1 to vault2. +$sourceVault and $targetVault can also belong to different subscription within same tanent, can be fetched by setting different subscription contexts. + +### Example 2: Copy data from vault1 to vault2 with only failed items + +```powershell +$sourceVault = Get-AzRecoveryServicesVault -ResourceGroupName "rgName1" -Name "vault1" +$targetVault = Get-AzRecoveryServicesVault -ResourceGroupName "rgName2" -Name "vault2" +Copy-AzRecoveryServicesVault -SourceVault $sourceVault -TargetVault $targetVault -RetryOnlyFailed +``` + +The first two cmdlets fetch Recovery Services Vault - vault1 and vault2 respectively. +The second command triggers a partial data move from vault1 to vault2 with only those items which failed in previous move operations. +$sourceVault and $targetVault can also belong to different subscription within same tanent, can be fetched by setting different subscription contexts. + +## PARAMETERS + +### -CorrelationIdForDataMove +Correlation Id for triggering DS Move. + +```yaml +Type: System.String +Parameter Sets: AzureRSVaultTriggerMoveParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the data move operation (prevents confirmation dialog) without asking confirmation for target vault storage redundancy type. This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetryOnlyFailed +Switch parameter to try data move only for containers in the source vault which are not yet moved. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureRSVaultDataMoveParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceVault +The source vault object to be moved. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TargetVault +The target vault object where the data has to be moved. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.ARSVault + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Disable-AzRecoveryServicesBackupAutoProtection.md b/azps-10.1.0/Az.RecoveryServices/Disable-AzRecoveryServicesBackupAutoProtection.md new file mode 100644 index 0000000000..423e9439ed --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Disable-AzRecoveryServicesBackupAutoProtection.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/disable-azrecoveryservicesbackupautoprotection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Disable-AzRecoveryServicesBackupAutoProtection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Disable-AzRecoveryServicesBackupAutoProtection.md +--- + +# Disable-AzRecoveryServicesBackupAutoProtection + +## SYNOPSIS +Disables auto backup for a protectable item. + +## SYNTAX + +``` +Disable-AzRecoveryServicesBackupAutoProtection [-InputItem] <ProtectableItemBase> + [-BackupManagementType] <BackupManagementType> [-WorkloadType] <WorkloadType> [-PassThru] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzRecoveryServicesBackupAutoProtection** cmdlet disables protection on a protectable item. + +## EXAMPLES + +### Example 1 +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVMAppContainer -Status "Registered" -FriendlyName "TestSQLServerVM" -VaultId $vault.ID +Get-AzRecoveryServicesBackupProtectableItem -Container $container -WorkloadType "MSSQL" -ItemType "SQLInstance" -Name "MSSQLInstance" | Disable-AzRecoveryServicesBackupAutoProtection -BackupManagementType "AzureWorkload" -WorkloadType "MSSQL" +``` + +The first cmdlet gets the Backup container of type AzureVMAppContainer. The second cmdlet gets the protectable BackupItem and disables auto protection. + +### Example 2 + +Disables auto backup for a protectable item. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Disable-AzRecoveryServicesBackupAutoProtection -BackupManagementType AzureVM -InputItem <ProtectableItemBase> -VaultId $vault.ID -WorkloadType AzureVM +``` + +## PARAMETERS + +### -BackupManagementType +The class of resources being protected. Currently the value supported for this cmdlet is AzureWorkload + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType +Parameter Sets: (All) +Aliases: +Accepted values: AzureWorkload + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputItem +Item Id + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ProtectableItemBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Return the result for auto protection. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkloadType +Workload type of the resource. The current supported value is "MSSQL" + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType +Parameter Sets: (All) +Aliases: +Accepted values: MSSQL + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Disable-AzRecoveryServicesBackupProtection.md b/azps-10.1.0/Az.RecoveryServices/Disable-AzRecoveryServicesBackupProtection.md new file mode 100644 index 0000000000..8ebaf37646 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Disable-AzRecoveryServicesBackupProtection.md @@ -0,0 +1,234 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: ECD3F05A-9350-407E-8B48-67443547652F +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/disable-azrecoveryservicesbackupprotection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Disable-AzRecoveryServicesBackupProtection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Disable-AzRecoveryServicesBackupProtection.md +--- + +# Disable-AzRecoveryServicesBackupProtection + +## SYNOPSIS +Disables protection for a Backup-protected item. + +## SYNTAX + +``` +Disable-AzRecoveryServicesBackupProtection [-Item] <ItemBase> [-RemoveRecoveryPoints] + [-RetainRecoveryPointsAsPerPolicy] [-Force] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + [-Token <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzRecoveryServicesBackupProtection** cmdlet disables protection for an Azure Backup-protected item. +This cmdlet stops regular scheduled backup of an item and retain forever. +This cmdlet can also delete existing recovery points for the backup item if executed with RemoveRecoveryPoints parameter. +This cmdlet can suspend backup of an item and retain recovery points as per backup policy if used with RetainRecoveryPointsAsPerPolicy parameter. One condition with this scenario is that backups can't be suspended until immutability is enabled on the vault. To enable immutability on a recovery services vault, pls follow Update-AzRecoveryServicesVault cmdlet. +Set the vault context by using the Set-AzRecoveryServicesVaultContext cmdlet before you use the current cmdlet. + +## EXAMPLES + +### Example 1: Disable Backup protection +```powershell +$Cont = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVM +$PI = Get-AzRecoveryServicesBackupItem -Container $Cont[0] -WorkloadType AzureVM +Disable-AzRecoveryServicesBackupProtection -Item $PI[0] +``` + +The first command gets an array of backup containers, and then stores it in the $Cont array. +The second command gets the Backup item corresponding to the first container item, and then stores it in the $PI variable. +The last command disables Backup protection for the item in $PI\[0\], but retains the data. + +### Example 2 + +Disables protection for a Backup-protected item. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Disable-AzRecoveryServicesBackupProtection -Item $PI[0] -RemoveRecoveryPoints -VaultId $vault.ID +``` + +### Example 3: Disable protection with retain recovery points as per policy + +```powershell +$item = Get-AzRecoveryServicesBackupItem -VaultId $suspendVault.ID -BackupManagementType AzureVM -WorkloadType AzureVM +Disable-AzRecoveryServicesBackupProtection -Item $item[0] -RetainRecoveryPointsAsPerPolicy -VaultId $vault.ID -Force +$item = Get-AzRecoveryServicesBackupItem -VaultId $suspendVault.ID -BackupManagementType AzureVM -WorkloadType AzureVM + $item[0].ProtectionState +``` +```output +BackupsSuspended +``` + +The first cmdlet fetches the AzureVM backup items for the recovery services vault. +The second cmdlet is used to suspend backup for $item[0] of the recovery services vault. One condition with this scenario is that backups can't be suspended until immutability is enabled on the vault. To enable immutability on a recovery services vault, pls follow Update-AzRecoveryServicesVault cmdlet. +The third and fourth command are used to fetch the updated backup item and its protection state. +To resume protection back, please use Enable-AzRecoveryServicesBackupProtection with parameter -Item. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Item +Specifies the Backup item for which this cmdlet disables protection. +To obtain an **AzureRmRecoveryServicesBackupItem**, use the Get-AzRecoveryServicesBackupItem cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RemoveRecoveryPoints +Indicates that this cmdlet deletes existing recovery points. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetainRecoveryPointsAsPerPolicy +If this option is used, all the recovery points for this item will expire as per the retention policy. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Token +Auxiliary access token for authenticating critical operation to resource guard subscription + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase + +## NOTES + +## RELATED LINKS + +[Enable-AzRecoveryServicesBackupProtection](./Enable-AzRecoveryServicesBackupProtection.md) + +[Get-AzRecoveryServicesBackupContainer](./Get-AzRecoveryServicesBackupContainer.md) + +[Get-AzRecoveryServicesBackupItem](./Get-AzRecoveryServicesBackupItem.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Disable-AzRecoveryServicesBackupRPMountScript.md b/azps-10.1.0/Az.RecoveryServices/Disable-AzRecoveryServicesBackupRPMountScript.md new file mode 100644 index 0000000000..206d481cf9 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Disable-AzRecoveryServicesBackupRPMountScript.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/disable-azrecoveryservicesbackuprpmountscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Disable-AzRecoveryServicesBackupRPMountScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Disable-AzRecoveryServicesBackupRPMountScript.md +--- + +# Disable-AzRecoveryServicesBackupRPMountScript + +## SYNOPSIS +Dismounts all the files of the recovery point. + +## SYNTAX + +``` +Disable-AzRecoveryServicesBackupRPMountScript [-RecoveryPoint] <RecoveryPointBase> [-PassThru] + [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Disable-AzRecoveryServicesBackupRPMountScript cmdlet dismounts the files of the recovery point which were mounted earlier using the Get-AzRecoveryServicesBackupRPMountScript cmdlet. + +## EXAMPLES + +### Example 1: Dismount a recovery point +<!-- Skip: Output cannot be splitted from code --> +```powershell +$namedContainer = Get-AzRecoveryServicesBackupContainer -ContainerType "AzureVM" -Status "Registered" -FriendlyName "V2VM" +$backupitem = Get-AzRecoveryServicesBackupItem -Container $namedContainer -WorkloadType "AzureVM" +$startDate = (Get-Date).AddDays(-7) +$endDate = Get-Date +$rp = Get-AzRecoveryServicesBackupRecoveryPoint -Item $backupitem -StartDate $startdate.ToUniversalTime() -EndDate $enddate.ToUniversalTime() + +<# To mount files of the latest recovery point, obtain the script by #> + +Get-AzRecoveryServicesBackupRPMountScript -RecoveryPoint $rp[0] + +OsType Password Filename +------ -------- -------- +Windows e3632984e51f496 V2VM_wus2_8287309959960546283_451516692429_cbd6061f7fc543c489f1974d33659fed07a6e0c2e08740.exe + +<# When the script is run, it will mount the files of the recovery point $rp[0] + +After the relevant files are copied, then you remove the files of the recovery point by running the disable cmdlet #> + +Disable-AzRecoveryServicesBackupRPMountScript -RecoveryPoint $rp[0] +``` + +### Example 2 + +Dismounts all the files of the recovery point. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Disable-AzRecoveryServicesBackupRPMountScript -Confirm -RecoveryPoint $rp[0] -VaultId $vault.ID +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the recovery point. + +```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 +``` + +### -RecoveryPoint +Recovery point object to be restored + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Edit-AzRecoveryServicesAsrRecoveryPlan.md b/azps-10.1.0/Az.RecoveryServices/Edit-AzRecoveryServicesAsrRecoveryPlan.md new file mode 100644 index 0000000000..91e46a777c --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Edit-AzRecoveryServicesAsrRecoveryPlan.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/edit-azrecoveryservicesasrrecoveryplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Edit-AzRecoveryServicesAsrRecoveryPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Edit-AzRecoveryServicesAsrRecoveryPlan.md +--- + +# Edit-AzRecoveryServicesAsrRecoveryPlan + +## SYNOPSIS +Edits a Site Recovery plan. + +## SYNTAX + +### AppendGroup (Default) +``` +Edit-AzRecoveryServicesAsrRecoveryPlan -InputObject <ASRRecoveryPlan> [-AppendGroup] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveGroup +``` +Edit-AzRecoveryServicesAsrRecoveryPlan -InputObject <ASRRecoveryPlan> -RemoveGroup <ASRRecoveryPlanGroup> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AddReplicationProtectedItems +``` +Edit-AzRecoveryServicesAsrRecoveryPlan -InputObject <ASRRecoveryPlan> -Group <ASRRecoveryPlanGroup> + -AddProtectedItem <ASRReplicationProtectedItem[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### RemoveReplicationProtectedItems +``` +Edit-AzRecoveryServicesAsrRecoveryPlan -InputObject <ASRRecoveryPlan> -Group <ASRRecoveryPlanGroup> + -RemoveProtectedItem <ASRReplicationProtectedItem[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Edit-AzRecoveryServicesAsrRecoveryPlan** cmdlet edits an Azure Site Recovery plan. + +## EXAMPLES + +### Example 1 +```powershell +$RP = Edit-AzRecoveryServicesAsrRecoveryPlan -RecoveryPlan $RP -AppendGroup +``` + +Appends a group to existing Azure Site Recovery plan and returns the in-memory updated recovery plan. + +### Example 2 + +Edits a Site Recovery plan. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Edit-AzRecoveryServicesAsrRecoveryPlan -AddProtectedItem <ASRReplicationProtectedItem[]> -Group <ASRRecoveryPlanGroup> -InputObject $RP +``` + +## PARAMETERS + +### -AddProtectedItem +List of ASR replication protected items to be added to the recovery plan group in the recovery plan object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem[] +Parameter Sets: AddReplicationProtectedItems +Aliases: AddProtectedItems + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppendGroup +Switch parameter to append a recovery plan group to the recovery plan object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AppendGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies a recovery plan group. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlanGroup +Parameter Sets: AddReplicationProtectedItems, RemoveReplicationProtectedItems +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The ASR recovery plan object to be edited (In memory operation. To update the recovery plan run Update-AzASRRecoveryPlan with the edited recovery plan object.) + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan +Parameter Sets: (All) +Aliases: RecoveryPlan + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RemoveGroup +Removes the specified group from the recovery plan object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlanGroup +Parameter Sets: RemoveGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveProtectedItem +List of ASR replication protected items to be removed from the recovery plan group in the recovery plan object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem[] +Parameter Sets: RemoveReplicationProtectedItems +Aliases: RemoveProtectedItems + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrRecoveryPlan](./Get-AzRecoveryServicesAsrRecoveryPlan.md) + +[New-AzRecoveryServicesAsrRecoveryPlan](./New-AzRecoveryServicesAsrRecoveryPlan.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Enable-AzRecoveryServicesBackupAutoProtection.md b/azps-10.1.0/Az.RecoveryServices/Enable-AzRecoveryServicesBackupAutoProtection.md new file mode 100644 index 0000000000..b021d1eba8 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Enable-AzRecoveryServicesBackupAutoProtection.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/enable-azrecoveryservicesbackupautoprotection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Enable-AzRecoveryServicesBackupAutoProtection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Enable-AzRecoveryServicesBackupAutoProtection.md +--- + +# Enable-AzRecoveryServicesBackupAutoProtection + +## SYNOPSIS +The **Enable-AzRecoveryServicesBackupAutoProtection** cmdlet sets up automatic protection of current and any future SQL DBs within the given instance with the supplied policy. + +## SYNTAX + +``` +Enable-AzRecoveryServicesBackupAutoProtection [-InputItem] <ProtectableItemBase> + [-BackupManagementType] <BackupManagementType> [-WorkloadType] <WorkloadType> [-Policy] <PolicyBase> + [-PassThru] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This command allows users to automatically protect all existing unprotected SQL DBs and any DB which will be added later with the given policy. Since the instruction is to back up all future DBs, the operation is done at a SQLInstance level, Azure backup service will then regularly scan auto-protected containers for any new DBs and automatically protect them. + +## EXAMPLES + +### Example 1 +```powershell +$Pol = Get-AzRecoveryServicesBackupProtectionPolicy -Name "DefaultSQLPolicy" +$SQLInstance = Get-AzRecoveryServicesBackupProtectableItem -workloadType MSSQL -ItemType SQLInstance -VaultId $targetVault.ID -Name "MSSQLInstance" -ServerName "TestSQLServer" +Enable-AzRecoveryServicesBackupAutoProtection -InputItem $SQLInstance -BackupManagementType AzureWorkload -WorkloadType MSSQL -Policy $Pol -VaultId $targetvault.ID +``` + +The first cmdlet gets a default policy object, and then stores it in the $Pol variable. +The second cmdlet fetches the relevant SQLInstance which is a protectable item. The 3rd command then sets up auto protection for this instance using the policy in $Pol. + +### Example 2 + +This commands allows users to automatically protect all existing unprotected DBs and any DB which will be added later with the given policy. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Enable-AzRecoveryServicesBackupAutoProtection -BackupManagementType AzureVM -InputItem <ProtectableItemBase> -Policy $Pol -VaultId $vault.ID -WorkloadType AzureVM +``` + +## PARAMETERS + +### -BackupManagementType +The class of resources being protected. Currently the values supported for this cmdlet are MAB, AzureWorkload, AzureVM + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType +Parameter Sets: (All) +Aliases: +Accepted values: AzureWorkload + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputItem +Specifies the protectable item object that can be passed as an input. The current supported value is a protectableItem object of type "SQLInstance". + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ProtectableItemBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Return the result for auto protection. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Protection policy object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkloadType +Workload type of the resource. The current supported values are AzureVM, WindowsServer, MSSQL + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType +Parameter Sets: (All) +Aliases: +Accepted values: MSSQL, SAPHanaDatabase + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Enable-AzRecoveryServicesBackupProtection.md b/azps-10.1.0/Az.RecoveryServices/Enable-AzRecoveryServicesBackupProtection.md new file mode 100644 index 0000000000..8898a626ec --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Enable-AzRecoveryServicesBackupProtection.md @@ -0,0 +1,351 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 44622461-E567-4A0A-8F18-2D7B1BF86DA2 +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/enable-azrecoveryservicesbackupprotection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Enable-AzRecoveryServicesBackupProtection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Enable-AzRecoveryServicesBackupProtection.md +--- + +# Enable-AzRecoveryServicesBackupProtection + +## SYNOPSIS +Enables or resumes backup for an item with a specified Backup protection policy. + +## SYNTAX + +### AzureVMComputeEnableProtection (Default) +``` +Enable-AzRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-Name] <String> [-ResourceGroupName] <String> + [-InclusionDisksList <String[]>] [-ExclusionDisksList <String[]>] [-ExcludeAllDataDisks] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureVMClassicComputeEnableProtection +``` +Enable-AzRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-Name] <String> [-ServiceName] <String> + [-InclusionDisksList <String[]>] [-ExclusionDisksList <String[]>] [-ExcludeAllDataDisks] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureFileShareEnableProtection +``` +Enable-AzRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-Name] <String> + [-StorageAccountName] <String> [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AzureWorkloadEnableProtection +``` +Enable-AzRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-ProtectableItem] <ProtectableItemBase> + [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ModifyProtection +``` +Enable-AzRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-Item] <ItemBase> + [-InclusionDisksList <String[]>] [-ExclusionDisksList <String[]>] [-ResetExclusionSettings] + [-ExcludeAllDataDisks] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-Token <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzRecoveryServicesBackupProtection** cmdlet enables the backup by associating a protection policy with the item. If policy ID is not present or the backup item is not associated with any policy, then this command will expect a policyID. You can also use the same command to resume backup for a resource for which you've stopped protection with the data retention option. Set the vault context by using the Set-AzRecoveryServicesVaultContext cmdlet before you use the current cmdlet. + +## EXAMPLES + +### Example 1: Enable Backup protection for an item +```powershell +$Pol = Get-AzRecoveryServicesBackupProtectionPolicy -Name "DefaultPolicy" +$inclusionDiskLUNS = ("1", "2") +Enable-AzRecoveryServicesBackupProtection -Policy $Pol -Name "V2VM" -ResourceGroupName "RGName1" -InclusionDisksList $inclusionDiskLUNS +``` + +```output +WorkloadName Operation Status StartTime EndTime +------------ --------- ------ --------- ------- +co03-vm ConfigureBackup Completed 11-Apr-16 12:19:49 PM 11-Apr-16 12:19:54 PM +``` + +The first cmdlet gets a default policy object, and then stores it in the $Pol variable. +The second cmdlet specifies the disk LUNs which are to be backed up and stores it in $inclusionDiskLUNS variable. +The third cmdlet sets the Backup protection policy for the ARM virtual machine named V2VM, in a resource group named RGName1, using the policy in $Pol. + +### Example 2 +Enables backup for an item with a specified Backup protection policy or resumes backup for an item that has data retained when backup was stopped. + +<!-- Aladdin Generated Example --> + + +```powershell +Enable-AzRecoveryServicesBackupProtection -ResourceGroupName $ResourceGroupName -Item $Item -Policy $Pol -VaultId $vault +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeAllDataDisks +Option to specify to backup OS disks only + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureVMComputeEnableProtection, AzureVMClassicComputeEnableProtection, ModifyProtection +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionDisksList +List of Disk LUNs to be excluded in backup and the rest are automatically included. + +```yaml +Type: System.String[] +Parameter Sets: AzureVMComputeEnableProtection, AzureVMClassicComputeEnableProtection, ModifyProtection +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InclusionDisksList +List of Disk LUNs to be included in backup and the rest are automatically excluded except OS disk. + +```yaml +Type: System.String[] +Parameter Sets: AzureVMComputeEnableProtection, AzureVMClassicComputeEnableProtection, ModifyProtection +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Item +Specifies the Backup item for which this cmdlet enables protection. +To obtain an **AzureRmRecoveryServicesBackupItem**, use the Get-AzRecoveryServicesBackupItem cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase +Parameter Sets: ModifyProtection +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Backup item. + +```yaml +Type: System.String +Parameter Sets: AzureVMComputeEnableProtection, AzureVMClassicComputeEnableProtection, AzureFileShareEnableProtection +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Policy +Specifies protection policy that this cmdlet associates with an item. +To obtain an **AzureRmRecoveryServicesBackupProtectionPolicy** object, use the Get-AzRecoveryServicesBackupProtectionPolicy cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectableItem +Specifies the item to be protected with the given policy. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ProtectableItemBase +Parameter Sets: AzureWorkloadEnableProtection +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResetExclusionSettings +Specifies to reset disk exclusion setting associated with the item + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ModifyProtection +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of a virtual machine. +Specify this parameter only for ARM virtual machines. + +```yaml +Type: System.String +Parameter Sets: AzureVMComputeEnableProtection +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +Cloud Service Name for Azure Classic Compute VM. + +```yaml +Type: System.String +Parameter Sets: AzureVMClassicComputeEnableProtection +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountName +Azure file share storage account name + +```yaml +Type: System.String +Parameter Sets: AzureFileShareEnableProtection +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Token +Auxiliary access token for authenticating critical operation to resource guard subscription + +```yaml +Type: System.String +Parameter Sets: ModifyProtection +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase + +## NOTES + +## RELATED LINKS + +[Disable-AzRecoveryServicesBackupProtection](./Disable-AzRecoveryServicesBackupProtection.md) + +[Get-AzRecoveryServicesBackupProtectionPolicy](./Get-AzRecoveryServicesBackupProtectionPolicy.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrAlertSetting.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrAlertSetting.md new file mode 100644 index 0000000000..ff06cd22d5 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrAlertSetting.md @@ -0,0 +1,69 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasralertsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrAlertSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrAlertSetting.md +--- + +# Get-AzRecoveryServicesAsrAlertSetting + +## SYNOPSIS +Gets the configured Azure Site Recovery notification settings for the vault. + +## SYNTAX + +``` +Get-AzRecoveryServicesAsrAlertSetting [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrAlertSetting** cmdlet gets the configured Azure Site Recovery notification settings for the vault. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRecoveryServicesAsrAlertSetting +``` + +```output +CustomEmailAddress EmailSubscriptionOwner Locale +------------------ ---------------------- ------ +{abcxxxx@xxxx.com} On en-US +``` + +Get Alert / Notification Setting for Azure Site Recovery. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRAlertSetting + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrEvent.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrEvent.md new file mode 100644 index 0000000000..e4303f85d4 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrEvent.md @@ -0,0 +1,256 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrevent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrEvent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrEvent.md +--- + +# Get-AzRecoveryServicesAsrEvent + +## SYNOPSIS +Gets details of Azure Site Recovery events in the vault. + +## SYNTAX + +### ByParam (Default) +``` +Get-AzRecoveryServicesAsrEvent [-AffectedObjectFriendlyName <String>] [-Fabric <ASRFabric>] + [-Severity <String>] [-StartTime <DateTime>] [-EndTime <DateTime>] [-EventType <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzRecoveryServicesAsrEvent -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByFabricId +``` +Get-AzRecoveryServicesAsrEvent -FabricId <String> [-AffectedObjectFriendlyName <String>] [-Severity <String>] + [-StartTime <DateTime>] [-EndTime <DateTime>] [-EventType <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByName +``` +Get-AzRecoveryServicesAsrEvent -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrEvent** gets the list of events in the vault based on the specified selection filters. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRecoveryServicesAsrEvent +``` + +List of all events. + +### Example 2 +```powershell +Get-AzRecoveryServicesAsrEvent -Name "VmMonitoringEvent;9091897569816476200_84576304-bafc-4714-8ba6-197a5d09d84f" +``` + +```output +AffectedObjectFriendlyName : V2A-W2K12-400 +Description : Virtual machine health is in Critical state. +EventCode : SRSVMHealthChanged +EventSpecificDetails : +EventType : AgentHealth +FabricId : /Subscriptions/xxxxxxxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxxxxxxxxx/replicationFabrics/xxxxxxxxxxxx +HealthErrors : {} +Name : VmMonitoringEvent;9091897569816476200_84576304-bafc-4714-8ba6-197a5d09d84f +ProviderSpecificEventDetails : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRInMageAzureV2EventDetails +Severity : Critical +TimeOfOccurence : 8/17/2017 12:31:43 PM +``` + +Get event by name. + +### Example 3 +```powershell +Get-AzRecoveryServicesAsrEvent -AffectedObjectFriendlyName xxxxxxxxxxxxx +``` + +List of event for affected Object. + +### Example 4 +```powershell +Get-AzRecoveryServicesAsrEvent -AffectedObjectFriendlyName xxxxxxxxxxxx -StartTime "8/17/2017 12:31:40 PM" -EndTime "8/17/2017 12:31:44 PM" -Severity Critical -EventType VmHealth +``` + +List of event between time start time and end time , severity critical and health type VmHealth. + +## PARAMETERS + +### -AffectedObjectFriendlyName +Specifies AffectedObject FriendlyName for the search. + +```yaml +Type: System.String +Parameter Sets: ByParam, ByFabricId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +Specifies the end time of the search window. Use this parameter to get only those events that have occurred before the specified time. + +```yaml +Type: System.DateTime +Parameter Sets: ByParam, ByFabricId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +Filter events by the event type. + +```yaml +Type: System.String +Parameter Sets: ByParam, ByFabricId +Aliases: +Accepted values: VmHealth, ServerHealth, AgentHealth + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fabric +Filter events by the specified fabric. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: ByParam +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FabricId +Specifies the fabricId to filter. + +```yaml +Type: System.String +Parameter Sets: ByFabricId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies name of the event for search. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the event ResourceId of event. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Severity +Event severity to filter on. + +```yaml +Type: System.String +Parameter Sets: ByParam, ByFabricId +Aliases: +Accepted values: Critical, Warning, OK, Unknown + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies the start time of the search window. Use this parameter to get only those events that have occurred after the specified time. + +```yaml +Type: System.DateTime +Parameter Sets: ByParam, ByFabricId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASREvent + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrFabric.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrFabric.md new file mode 100644 index 0000000000..0ded9c982f --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrFabric.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrfabric +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrFabric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrFabric.md +--- + +# Get-AzRecoveryServicesAsrFabric + +## SYNOPSIS +Get the details of an Azure Site Recovery Fabric. + +## SYNTAX + +### Default (Default) +``` +Get-AzRecoveryServicesAsrFabric [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByName +``` +Get-AzRecoveryServicesAsrFabric -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFriendlyName +``` +Get-AzRecoveryServicesAsrFabric -FriendlyName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrFabric** cmdlet gets the properties of a specified Azure Site Recovery Fabric or all Azure Site Recovery Fabrics in a Recovery Service vault. + +## EXAMPLES + +### Example 1 +```powershell +$fabrics = Get-AzRecoveryServicesAsrFabric +``` + +Returns all the Azure Site Recovery fabrics in the vault. + +### Example 2 +```powershell +$fabric = Get-AzRecoveryServicesAsrFabric -Name xxxx +``` + +```output +Name : xxxx +FriendlyName : XXXXXXXXXX +ID : /Subscriptions/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/XXXXXXXXXXXXX/replicationFabrics/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +FabricType : VMware +SiteIdentifier : XXXXXXXXxxxxxxxxxxx +FabricSpecificDetails : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVMWareSpecificDetails +``` + +Return azure site recovery fabric with name xxxx. + +### Example 3 +```powershell +$fabric = Get-AzRecoveryServicesAsrFabric -FriendlyName XXXXXXXXXX +``` + +```output +Name : xxxx +FriendlyName : XXXXXXXXXX +ID : /Subscriptions/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/XXXXXXXXXXXXX/replicationFabrics/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +FabricType : VMware +SiteIdentifier : XXXXXXXXxxxxxxxxxxx +FabricSpecificDetails : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVMWareSpecificDetails +``` + +Return azure site recovery fabric with friendly name xxxx. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Search for the ASR fabric by the friendly name of the fabric. + +```yaml +Type: System.String +Parameter Sets: ByFriendlyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Search for the ASR fabric by the name of the fabric. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric + +## NOTES + +## RELATED LINKS + +[New-AzRecoveryServicesAsrFabric](./New-AzRecoveryServicesAsrFabric.md) + +[Remove-AzRecoveryServicesAsrFabric](./Remove-AzRecoveryServicesAsrFabric.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrJob.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrJob.md new file mode 100644 index 0000000000..33d157bf79 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrJob.md @@ -0,0 +1,197 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrJob.md +--- + +# Get-AzRecoveryServicesAsrJob + +## SYNOPSIS +Gets the details of the specified ASR job or the list of recent ASR jobs in the Recovery Services vault. + +## SYNTAX + +### ByParam (Default) +``` +Get-AzRecoveryServicesAsrJob [-StartTime <DateTime>] [-EndTime <DateTime>] [-TargetObjectId <String>] + [-State <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByName +``` +Get-AzRecoveryServicesAsrJob -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObject +``` +Get-AzRecoveryServicesAsrJob -Job <ASRJob> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrJob** cmdlet gets Azure Site Recovery jobs. +You can use this cmdlet to view the ASR jobs in the Recovery Services vault. + +## EXAMPLES + +### Example 1 +```powershell +$jobs = Get-AzRecoveryServicesAsrJob -TargetObjectId $ASRObjectId +``` + +Returns all the jobs on a particular ASR object(reference the ASR object such as replicated item or recovery plan by its ID.) + +### Example 2 + +Gets the details of the specified ASR job or the list of recent ASR jobs in the Recovery Services vault. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzRecoveryServicesAsrJob -Job $Job +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +Specifies the end time for the jobs. +This cmdlet gets all jobs that started before the specified time. +To obtain a **DateTime** object for this parameter, use the Get-Date cmdlet. +For more information, type `Get-Help Get-Date`. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: ByParam +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Job +Specifies the ASR job object to get updated details for. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob +Parameter Sets: ByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the ASR job by name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies the start time for the jobs. +This cmdlet gets all jobs that started after the specified time. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: ByParam +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Specifies the state for a ASR job. +This cmdlet gets all jobs that match the specified state. +The acceptable values for this parameter are: + +- NotStarted +- InProgress +- Succeeded +- Other +- Failed +- Cancelled +- Suspended + +```yaml +Type: System.String +Parameter Sets: ByParam +Aliases: +Accepted values: NotStarted, InProgress, Succeeded, Other, Failed, Cancelled, Suspended + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectId +Specifies the ID of the object. Used to search for jobs on the specified object. + +```yaml +Type: System.String +Parameter Sets: ByParam +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Restart-AzRecoveryServicesAsrJob](./Restart-AzRecoveryServicesAsrJob.md) + +[Resume-AzRecoveryServicesAsrJob](./Resume-AzRecoveryServicesAsrJob.md) + +[Stop-AzRecoveryServicesAsrJob](./Stop-AzRecoveryServicesAsrJob.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrNetwork.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrNetwork.md new file mode 100644 index 0000000000..838df1e83a --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrNetwork.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrnetwork +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrNetwork.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrNetwork.md +--- + +# Get-AzRecoveryServicesAsrNetwork + +## SYNOPSIS +Gets information about the networks managed by Site Recovery for the current vault. + +## SYNTAX + +### ByFabricObject (Default) +``` +Get-AzRecoveryServicesAsrNetwork -Fabric <ASRFabric> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByName +``` +Get-AzRecoveryServicesAsrNetwork -Fabric <ASRFabric> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByFriendlyName +``` +Get-AzRecoveryServicesAsrNetwork -Fabric <ASRFabric> -FriendlyName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrNetwork** cmdlet gets information about Azure Site Recovery networks for the current Azure Site Recovery vault. + +## EXAMPLES + +### Example 1 +```powershell +$Networks = Get-AzRecoveryServicesAsrNetwork -Fabric $Fabric +``` + +Gets all known networks in the specified fabric. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fabric +ASR fabric object + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -FriendlyName +Friendly name of network ASR object. + +```yaml +Type: System.String +Parameter Sets: ByFriendlyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of network ASR object. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrNetworkMapping.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrNetworkMapping.md new file mode 100644 index 0000000000..4c76b96009 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrNetworkMapping.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrnetworkmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrNetworkMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrNetworkMapping.md +--- + +# Get-AzRecoveryServicesAsrNetworkMapping + +## SYNOPSIS +Gets information about Site Recovery network mappings for the current vault. + +## SYNTAX + +### ByObject (Default) +``` +Get-AzRecoveryServicesAsrNetworkMapping [-Name <String>] -Network <ASRNetwork> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFabricObject +``` +Get-AzRecoveryServicesAsrNetworkMapping [-Name <String>] -PrimaryFabric <ASRFabric> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrNetworkMapping** cmdlet gets information about Azure Site Recovery network mappings for the Recovery Services vault. + +## EXAMPLES + +### Example 1 +```powershell +$Networkmappings = Get-AzRecoveryServicesAsrNetworkMapping -Network $Network +``` + +Gets all networks mappings for the passed Network. + +### Example 2 +```powershell +$primaryFabric = Get-AzRecoveryServicesAsrFabric -Name xxxx +$Networkmappings = Get-AzRecoveryServicesAsrNetworkMapping -Name $networkMappingName -PrimaryFabric $primaryFabric +``` + +Gets networks mapping with provided name in specified azure site recovery fabric. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the ASR network mapping object to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Network +Get the ASR network mappings corresponding to the specified network ASR object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork +Parameter Sets: ByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrimaryFabric +Get the ASR network mappings corresponding to the specified primary fabric object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: ByFabricObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetworkMapping + +## NOTES + +## RELATED LINKS + +[New-AzRecoveryServicesAsrNetworkMapping](./New-AzRecoveryServicesAsrNetworkMapping.md) + +[Remove-AzRecoveryServicesAsrNetworkMapping](./Remove-AzRecoveryServicesAsrNetworkMapping.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrPolicy.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrPolicy.md new file mode 100644 index 0000000000..0efbd20df6 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrPolicy.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrPolicy.md +--- + +# Get-AzRecoveryServicesAsrPolicy + +## SYNOPSIS +Gets ASR replication policies. + +## SYNTAX + +### Default (Default) +``` +Get-AzRecoveryServicesAsrPolicy [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByName +``` +Get-AzRecoveryServicesAsrPolicy -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFriendlyName +``` +Get-AzRecoveryServicesAsrPolicy -FriendlyName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrPolicy** cmdlet gets the list of configured Azure Site Recovery replication policies or a specific replication policy by name. + +## EXAMPLES + +### Example 1 +```powershell +$Policy = Get-AzRecoveryServicesAsrPolicy +``` + +Returns the list of replication policies + +### Example 2 +```powershell +Get-AzRecoveryServicesAsrPolicy -Name abc +``` + +```output +FriendlyName : abc +Name : abc +ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxxxxx/replicationPolicies/abc +Type : Microsoft.RecoveryServices/vaults/replicationPolicies +ReplicationProvider : HyperVReplicaAzure +ReplicationProviderSettings : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRHyperVReplicaAzurePolicyDetails +``` + +Returns replication policy with name. + +### Example 3 +```powershell +Get-AzRecoveryServicesAsrPolicy -FriendlyName abc +``` + +```output +FriendlyName : abc +Name : abc +ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxxxxx/replicationPolicies/abc +Type : Microsoft.RecoveryServices/vaults/replicationPolicies +ReplicationProvider : HyperVReplicaAzure +ReplicationProviderSettings : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRHyperVReplicaAzurePolicyDetails +``` + +Returns the replication policy with the specified friendly name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Specifies the friendly name of the ASR replication policy. + +```yaml +Type: System.String +Parameter Sets: ByFriendlyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the ASR replication policy. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy + +## NOTES + +## RELATED LINKS + +[New-AzRecoveryServicesAsrPolicy](./New-AzRecoveryServicesAsrPolicy.md) + +[Remove-AzRecoveryServicesAsrPolicy](./Remove-AzRecoveryServicesAsrPolicy.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrProtectableItem.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrProtectableItem.md new file mode 100644 index 0000000000..6f620f49b9 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrProtectableItem.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrprotectableitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrProtectableItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrProtectableItem.md +--- + +# Get-AzRecoveryServicesAsrProtectableItem + +## SYNOPSIS +Get the protectable items in an ASR protection container. + +## SYNTAX + +### ByObject (Default) +``` +Get-AzRecoveryServicesAsrProtectableItem -ProtectionContainer <ASRProtectionContainer> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectWithName +``` +Get-AzRecoveryServicesAsrProtectableItem -Name <String> -ProtectionContainer <ASRProtectionContainer> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectWithFriendlyName +``` +Get-AzRecoveryServicesAsrProtectableItem -FriendlyName <String> -ProtectionContainer <ASRProtectionContainer> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectWithSiteIdAndFriendlyName +``` +Get-AzRecoveryServicesAsrProtectableItem -FriendlyName <String> -SiteId <String> + -ProtectionContainer <ASRProtectionContainer> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectWithSiteId +``` +Get-AzRecoveryServicesAsrProtectableItem -SiteId <String> -ProtectionContainer <ASRProtectionContainer> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrProtectableItem** cmdlet gets the protectable items in an Azure Site Recovery Protection Container. + +## EXAMPLES + +### Example 1 +```powershell +$ProtectableItems = Get-AzRecoveryServicesAsrProtectableItem -ProtectionContainer $Container +``` + +Gets all the protectable items in specified ASR protection container. + +### Example 2 +```powershell +Get-AzRecoveryServicesAsrProtectableItem -ProtectionContainer $pc -FriendlyName $piFriendlyName +``` + +```output +Disks : {} +FabricObjectId : +FabricSpecificVMDetails : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVMWareSpecificVMDetails +FriendlyName : V2A-W2K12-400 +ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/IbizaV2ATest/replicationFabrics/d011a5abf48190235963ee3a88ad188ee6bca8a4c6cd0c8d7ce5d439aa77ffd9/replicationProt + ectionContainers/cloud_5dc96260-9f00-42e4-aca7-24ad27fc2078/replicationProtectableItems/22d47502-7df0-11e7-9373-0050568f2e8f +Name : 22d47502-7df0-11e7-9373-0050568f2e8f +OS : WINDOWS +OSDiskId : +OSDiskName : +ProtectionContainerId : cloud_5dc96260-9f00-42e4-aca7-24ad27fc2078 +ProtectionReadinessErrors : +ProtectionStatus : Unprotected +ReplicationProtectedItemId : +SupportedReplicationProviders : {InMage, InMageAzureV2} +``` + +Get the protectable items in specified ASR protection container and with given friendly name. + +### Example 3 +```powershell +Get-AzRecoveryServicesAsrProtectableItem -ProtectionContainer $pc -Name $piName +``` + +```output +Disks : {} +FabricObjectId : +FabricSpecificVMDetails : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVMWareSpecificVMDetails +FriendlyName : V2A-W2K12-400 +ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/IbizaV2ATest/replicationFabrics/d011a5abf48190235963ee3a88ad188ee6bca8a4c6cd0c8d7ce5d439aa77ffd9/replicationProt + ectionContainers/cloud_5dc96260-9f00-42e4-aca7-24ad27fc2078/replicationProtectableItems/22d47502-7df0-11e7-9373-0050568f2e8f +Name : 22d47502-7df0-11e7-9373-0050568f2e8f +OS : WINDOWS +OSDiskId : +OSDiskName : +ProtectionContainerId : cloud_5dc96260-9f00-42e4-aca7-24ad27fc2078 +ProtectionReadinessErrors : +ProtectionStatus : Unprotected +ReplicationProtectedItemId : +SupportedReplicationProviders : {InMage, InMageAzureV2} +``` + +Gets all the protectable items in specified ASR protection container. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Specifies the friendly name of the ASR protectable item. + +```yaml +Type: System.String +Parameter Sets: ByObjectWithFriendlyName, ByObjectWithSiteIdAndFriendlyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the ASR protectable item. + +```yaml +Type: System.String +Parameter Sets: ByObjectWithName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionContainer +Specifies the Azure Site Recovery Protection Container object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SiteId +Specifies the VMware site Id where the protectable item was discovered (Applicable only for VMware to Azure replication scenario). +Use site Id from fabric specific details in the ASR fabric to specify one. + +```yaml +Type: System.String +Parameter Sets: ByObjectWithSiteIdAndFriendlyName, ByObjectWithSiteId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectableItem + +## NOTES + +## RELATED LINKS + +[Azure Recovery Services cmdlets](/powershell/module/az.recoveryservices) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrProtectionContainer.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrProtectionContainer.md new file mode 100644 index 0000000000..d950ecc534 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrProtectionContainer.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrprotectioncontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrProtectionContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrProtectionContainer.md +--- + +# Get-AzRecoveryServicesAsrProtectionContainer + +## SYNOPSIS +Gets ASR protection containers in the Recovery Services vault. + +## SYNTAX + +### ByFabricObject (Default) +``` +Get-AzRecoveryServicesAsrProtectionContainer -Fabric <ASRFabric> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByObjectWithName +``` +Get-AzRecoveryServicesAsrProtectionContainer -Name <String> -Fabric <ASRFabric> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectWithFriendlyName +``` +Get-AzRecoveryServicesAsrProtectionContainer -FriendlyName <String> -Fabric <ASRFabric> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrProtectionContainer** cmdlet gets Azure Site Recovery protection containers in the Recovery Services vault. +A protection container is a logical container for protectable(discovered) and protected objects such as virtual machines. +Replication policies define replication settings for protected items and can be associated with a protection container and applied to a protectable item. + +## EXAMPLES + +### Example 1 +```powershell +$ProtectionContainers = Get-AzRecoveryServicesAsrProtectionContainer -Fabric $fabric +``` + +List of protection container in fabric $fabric. + +### Example 2 +```powershell +Get-AzRecoveryServicesAsrProtectionContainer -Name xxxxx -Fabric $fabric +``` + +```output +FriendlyName : xxxxxxxx +Name : xxxxx +ID : /Subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxxx/replicationFabrics/xxxxxxxxxxxxxxxxxxxxxxxxx/replicationProtectionContainers/xxxxxxxxxxxxxxxxxxxxxxxxx +Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers +FabricFriendlyName : xxxxxxxxxxxxxxxxxxxxxxxxx +FabricType : VMware +Role : Primary +AvailablePolicies : {V2aTestPolicy, v2ahydra, v2aswag-failback, v2aswag} +ProtectionContainerMappings : {pcmmapping, v2aPowerold, 636569dc-79bc-4f50-b83d-89f58717f0b2, df7aa204-b0ef-4d62-943e-324551030e5b} +``` + +Protection container in fabric $fabric with name. + +### Example 3 +```powershell +Get-AzRecoveryServicesAsrProtectionContainer -FriendlyName xxxxxxxx -Fabric $fabric +``` + +```output +FriendlyName : xxxxxxxx +Name : xxxxx +ID : /Subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxxx/replicationFabrics/xxxxxxxxxxxxxxxxxxxxxxxxx/replicationProtectionContainers/xxxxxxxxxxxxxxxxxxxxxxxxx +Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers +FabricFriendlyName : xxxxxxxxxxxxxxxxxxxxxxxxx +FabricType : VMware +Role : Primary +AvailablePolicies : {V2aTestPolicy, v2ahydra, v2aswag-failback, v2aswag} +ProtectionContainerMappings : {pcmmapping, v2aPowerold, 636569dc-79bc-4f50-b83d-89f58717f0b2, df7aa204-b0ef-4d62-943e-324551030e5b} +``` + +Protection container in fabric $fabric with friendly Name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fabric +Look for the protection container in the specified ASR fabric. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -FriendlyName +Specifies the friendly name of the ASR protection container to look for. + +```yaml +Type: System.String +Parameter Sets: ByObjectWithFriendlyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the ASR protection container to look for. + +```yaml +Type: System.String +Parameter Sets: ByObjectWithName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrProtectionContainerMapping.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrProtectionContainerMapping.md new file mode 100644 index 0000000000..14f6630273 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrProtectionContainerMapping.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrprotectioncontainermapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrProtectionContainerMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrProtectionContainerMapping.md +--- + +# Get-AzRecoveryServicesAsrProtectionContainerMapping + +## SYNOPSIS +Gets Azure Site Recovery Protection Container mappings. + +## SYNTAX + +### ByObject (Default) +``` +Get-AzRecoveryServicesAsrProtectionContainerMapping -ProtectionContainer <ASRProtectionContainer> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectWithName +``` +Get-AzRecoveryServicesAsrProtectionContainerMapping -Name <String> + -ProtectionContainer <ASRProtectionContainer> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrProtectionContainerMapping** cmdlet gets information about the protection container to replication policy mappings(association) in the vault for the specified ASR protection container. + +## EXAMPLES + +### Example 1 +```powershell +$ProtectionContainerMappings = Get-AzRecoveryServicesAsrProtectionContainerMapping -ProtectionContainer $Container +``` + +List of protection container mappings for container. + +### Example 2 +```powershell +$ProtectionContainerMappings = Get-AzRecoveryServicesAsrProtectionContainerMapping -ProtectionContainer $Container -Name $PrimaryProtectionContainerMapping +``` + +```output +Name : pcmmapping +ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/IbizaV2ATest/replicationFabrics/d011a5abf48190235963ee3a88ad188ee6bca8a4c6cd0c8d7ce5d439aa77ffd9/replica + tionProtectionContainers/cloud_5dc96260-9f00-42e4-aca7-24ad27fc2078/replicationProtectionContainerMappings/pcmmapping +Health : Normal +HealthErrorDetails : {} +PolicyFriendlyName : V2aTestPolicy +PolicyId : /Subscriptions/xxxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/IbizaV2ATest/replicationPolicies/V2aTestPolicy +SourceFabricFriendlyName : V2A-W2K12-400 +SourceProtectionContainerFriendlyName : V2A-W2K12-400 +State : Paired +TargetFabricFriendlyName : Microsoft Azure +TargetProtectionContainerFriendlyName : Microsoft Azure +TargetProtectionContainerId : Microsoft Azure +``` + +Gets all protection container mappings for the specified protection container. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the protection container mapping to get. + +```yaml +Type: System.String +Parameter Sets: ByObjectWithName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionContainer +Get protection container mappings corresponding to the specified ASR protection container object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainerMapping + +## NOTES + +## RELATED LINKS + +[New-AzRecoveryServicesAsrProtectionContainerMapping](./New-AzRecoveryServicesAsrProtectionContainerMapping.md) + +[Remove-AzRecoveryServicesAsrProtectionContainerMapping](./Remove-AzRecoveryServicesAsrProtectionContainerMapping.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrRecoveryPlan.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrRecoveryPlan.md new file mode 100644 index 0000000000..a024601014 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrRecoveryPlan.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrrecoveryplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrRecoveryPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrRecoveryPlan.md +--- + +# Get-AzRecoveryServicesAsrRecoveryPlan + +## SYNOPSIS +Gets a recovery plan or all the recovery plans in the Recovery Services vault + +## SYNTAX + +### Default (Default) +``` +Get-AzRecoveryServicesAsrRecoveryPlan [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByName +``` +Get-AzRecoveryServicesAsrRecoveryPlan -Name <String> [[-Path] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFriendlyName +``` +Get-AzRecoveryServicesAsrRecoveryPlan -FriendlyName <String> [[-Path] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrRecoveryPlan** cmdlet gets the details of the specified recovery plan or all recovery plans in the Recovery Services vault. + +## EXAMPLES + +### Example 1 +```powershell +$RP = Get-AzRecoveryServicesAsrRecoveryPlan -Name $RPName +``` + +Gets the recovery plan with the specified name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Specifies the friendly name of the recovery plan to get. + +```yaml +Type: System.String +Parameter Sets: ByFriendlyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the recovery plan to get. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the file path to which this cmdlet saves the recovery plan json definition. The json definition can be edited to modify the recovery plan and used to update the recovery plan through the Update-AzRecoveryServicesASRRecoveryPlan cmdlet + +```yaml +Type: System.String +Parameter Sets: ByName, ByFriendlyName +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan + +## NOTES + +## RELATED LINKS + +[New-AzRecoveryServicesAsrRecoveryPlan](./New-AzRecoveryServicesAsrRecoveryPlan.md) + +[Remove-AzRecoveryServicesAsrRecoveryPlan](./Remove-AzRecoveryServicesAsrRecoveryPlan.md) + +[Update-AzRecoveryServicesAsrRecoveryPlan](./Update-AzRecoveryServicesAsrRecoveryPlan.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrRecoveryPoint.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrRecoveryPoint.md new file mode 100644 index 0000000000..dc193b62d4 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrRecoveryPoint.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrrecoverypoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrRecoveryPoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrRecoveryPoint.md +--- + +# Get-AzRecoveryServicesAsrRecoveryPoint + +## SYNOPSIS +Gets the available recovery points for a replication protected item. + +## SYNTAX + +### ByObject (Default) +``` +Get-AzRecoveryServicesAsrRecoveryPoint -ReplicationProtectedItem <ASRReplicationProtectedItem> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectWithName +``` +Get-AzRecoveryServicesAsrRecoveryPoint -Name <String> -ReplicationProtectedItem <ASRReplicationProtectedItem> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrRecoveryPoint** cmdlet gets the list of available recovery points for a replication protected item. The list is in order from latest to oldest Recovery Points, the first one being the Latest Processed (lowest RTO). + +## EXAMPLES + +### Example 1 +```powershell +$RecoveryPoints = Get-AzRecoveryServicesAsrRecoveryPoint -ReplicationProtectedItem $ReplicationProtectedItem +``` + +Gets recovery points for the specified ASR replication protected item. $RecoveryPoints[0] will have the Latest Processed Recovery Point (for Lowest RTO). + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the recovery point to get. + +```yaml +Type: System.String +Parameter Sets: ByObjectWithName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +Specifies the Azure Site Recovery Replication Protected Item object for which to get the list of available recovery points. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPoint + +## NOTES + +## RELATED LINKS + +[Edit-AzRecoveryServicesAsrRecoveryPlan](./Edit-AzRecoveryServicesAsrRecoveryPlan.md) + +[Get-AzRecoveryServicesAsrRecoveryPlan](./Get-AzRecoveryServicesAsrRecoveryPlan.md) + +[New-AzRecoveryServicesAsrRecoveryPlan](./New-AzRecoveryServicesAsrRecoveryPlan.md) + +[Remove-AzRecoveryServicesAsrRecoveryPlan](./Remove-AzRecoveryServicesAsrRecoveryPlan.md) + +[Update-AzRecoveryServicesAsrRecoveryPlan](./Update-AzRecoveryServicesAsrRecoveryPlan.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrReplicationProtectedItem.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrReplicationProtectedItem.md new file mode 100644 index 0000000000..6a86873cb2 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrReplicationProtectedItem.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrreplicationprotecteditem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrReplicationProtectedItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrReplicationProtectedItem.md +--- + +# Get-AzRecoveryServicesAsrReplicationProtectedItem + +## SYNOPSIS +Gets the properties of an Azure Site Recovery Replication Protected Items. + +## SYNTAX + +### ByObject (Default) +``` +Get-AzRecoveryServicesAsrReplicationProtectedItem -ProtectionContainer <ASRProtectionContainer> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectWithName +``` +Get-AzRecoveryServicesAsrReplicationProtectedItem -Name <String> -ProtectionContainer <ASRProtectionContainer> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectWithFriendlyName +``` +Get-AzRecoveryServicesAsrReplicationProtectedItem -FriendlyName <String> + -ProtectionContainer <ASRProtectionContainer> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByProtectableItemObject +``` +Get-AzRecoveryServicesAsrReplicationProtectedItem -ProtectableItem <ASRProtectableItem> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrReplicationProtectedItem** cmdlet gets the properties of all or the specified ASR replication protected item from the specified ASR protection container. + +## EXAMPLES + +### Example 1 +```powershell +$ReplicationProtectedItems = Get-AzRecoveryServicesAsrReplicationProtectedItem -ProtectionContainer $PrimaryContainer +``` + +Lists all replication protected items in the specified ASR protection container. + +### Example 2 + +Gets the properties of an Azure Site Recovery Replication Protected Items. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzRecoveryServicesAsrReplicationProtectedItem -FriendlyName XXXXXXXXXX -ProtectionContainer $PrimaryContainer +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Specifies the friendly name of the replication protected item to get. + +```yaml +Type: System.String +Parameter Sets: ByObjectWithFriendlyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the replication protected item to get. + +```yaml +Type: System.String +Parameter Sets: ByObjectWithName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectableItem +Specifies an ASR protectable item object. The cmdlet gets the ASR replication protected item corresponding to the specified ASR protectable item if the item is protected. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectableItem +Parameter Sets: ByProtectableItemObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProtectionContainer +Specifies the ASR protection container object of the ASR protection container corresponding to the replication protected item. To get the ASR protection container in the Recovery Service Container run the [Get-AzRecoveryServicesAsrProtectionContainer](/powershell/module/az.recoveryservices/get-azrecoveryservicesasrprotectioncontainer) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer +Parameter Sets: ByObject, ByObjectWithName, ByObjectWithFriendlyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectableItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## NOTES + +## RELATED LINKS + +[New-AzRecoveryServicesAsrReplicationProtectedItem](./New-AzRecoveryServicesAsrReplicationProtectedItem.md) + +[Remove-AzRecoveryServicesAsrReplicationProtectedItem](./Remove-AzRecoveryServicesAsrReplicationProtectedItem.md) + +[Set-AzRecoveryServicesAsrReplicationProtectedItem](./Set-AzRecoveryServicesAsrReplicationProtectedItem.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrServicesProvider.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrServicesProvider.md new file mode 100644 index 0000000000..a785887537 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrServicesProvider.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrservicesprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrServicesProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrServicesProvider.md +--- + +# Get-AzRecoveryServicesAsrServicesProvider + +## SYNOPSIS +Gets the details of the ASR recovery services providers registered to the Recovery Services vault. + +## SYNTAX + +### Default (Default) +``` +Get-AzRecoveryServicesAsrServicesProvider -Fabric <ASRFabric> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByName +``` +Get-AzRecoveryServicesAsrServicesProvider -Name <String> -Fabric <ASRFabric> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByFriendlyName +``` +Get-AzRecoveryServicesAsrServicesProvider -FriendlyName <String> -Fabric <ASRFabric> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrServicesProvider** cmdlet gets information on the Azure Site Recovery providers in the vault. + +## EXAMPLES + +### Example 1 +```powershell +$RSPs = Get-AzRecoveryServicesAsrFabric | Get-AzRecoveryServicesAsrServicesProvider +``` + +List all ASR replication services providers registered to the Recovery Services vault corresponding to the specified fabric. + +### Example 2 + +Gets the details of the ASR recovery services providers registered to the Recovery Services vault. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzRecoveryServicesAsrServicesProvider -Fabric $Fabric +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fabric +Specifies the ASR fabric object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -FriendlyName +Specifies the friendly name of the ASR recovery services provider to get details for. + +```yaml +Type: System.String +Parameter Sets: ByFriendlyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the ASR recovery services provider to get details for. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryServicesProvider + +## NOTES + +## RELATED LINKS + +[Remove-AzRecoveryServicesAsrServicesProvider](./Remove-AzRecoveryServicesAsrServicesProvider.md) + +[Update-AzRecoveryServicesAsrServicesProvider](./Update-AzRecoveryServicesAsrServicesProvider.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrStorageClassification.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrStorageClassification.md new file mode 100644 index 0000000000..838a072f17 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrStorageClassification.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrstorageclassification +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrStorageClassification.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrStorageClassification.md +--- + +# Get-AzRecoveryServicesAsrStorageClassification + +## SYNOPSIS +Gets the available(discovered) ASR storage classifications in the Recovery Services vault. + +## SYNTAX + +### ByFabricObject (Default) +``` +Get-AzRecoveryServicesAsrStorageClassification -Fabric <ASRFabric> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByObjectWithName +``` +Get-AzRecoveryServicesAsrStorageClassification -Name <String> -Fabric <ASRFabric> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectWithFriendlyName +``` +Get-AzRecoveryServicesAsrStorageClassification -FriendlyName <String> -Fabric <ASRFabric> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrStorageClassification** cmdlet gets details of the discovered ASR storage classifications in the Recovery Services vault. + +## EXAMPLES + +### Example 1 +```powershell +$StorageClassifications = Get-AzRecoveryServicesAsrStorageClassification -Fabric $Fabric +``` + +List the discovered storage classifications corresponding to the specified ASR fabric. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fabric +Specifies an ASR fabric object. The cmdlet gets the details of discovered storage classifications corresponding to the specified ASR fabric. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -FriendlyName +Specifies the friendly name of the storage classification object to get. + +```yaml +Type: System.String +Parameter Sets: ByObjectWithFriendlyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the storage classification object to get. + +```yaml +Type: System.String +Parameter Sets: ByObjectWithName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassification + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrStorageClassificationMapping.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrStorageClassificationMapping.md new file mode 100644 index 0000000000..23c1f7941f --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrStorageClassificationMapping.md @@ -0,0 +1,107 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrstorageclassificationmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrStorageClassificationMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrStorageClassificationMapping.md +--- + +# Get-AzRecoveryServicesAsrStorageClassificationMapping + +## SYNOPSIS +Gets ASR storage classification mappings. + +## SYNTAX + +### ByObject (Default) +``` +Get-AzRecoveryServicesAsrStorageClassificationMapping -StorageClassification <ASRStorageClassification> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByObjectWithName +``` +Get-AzRecoveryServicesAsrStorageClassificationMapping -Name <String> + -StorageClassification <ASRStorageClassification> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrStorageClassificationMapping** cmdlet gets the details of an ASR storage classification mapping. + +## EXAMPLES + +### Example 1 +```powershell +$StorageClassificationMappings = Get-AzRecoveryServicesAsrStorageClassificationMapping -StorageClassification $StorageClassification +``` + +List all storage classification mappings corresponding to the specified storage classification. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the storage classification mapping to get. + +```yaml +Type: System.String +Parameter Sets: ByObjectWithName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageClassification +Specifies an ASR storage classification object. The cmdlet gets ASR storage classification mappings corresponding to the specified storage classification + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassification +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassification + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassificationMapping + +## NOTES + +## RELATED LINKS + +[New-AzRecoveryServicesAsrStorageClassificationMapping](./New-AzRecoveryServicesAsrStorageClassificationMapping.md) + +[Remove-AzRecoveryServicesAsrStorageClassificationMapping](./Remove-AzRecoveryServicesAsrStorageClassificationMapping.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrVaultContext.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrVaultContext.md new file mode 100644 index 0000000000..0bf8eeac57 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrVaultContext.md @@ -0,0 +1,63 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrvaultcontext +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrVaultContext.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrVaultContext.md +--- + +# Get-AzRecoveryServicesAsrVaultContext + +## SYNOPSIS +Gets ASR vault settings information for the Recovery Services vault. + +## SYNTAX + +``` +Get-AzRecoveryServicesAsrVaultContext [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrVaultContext** cmdlet gets ASR vault settings information related to the Recovery Services vault. + +## EXAMPLES + +### Example 1 +```powershell +$VaultSettings = Get-AzRecoveryServicesAsrVaultContext +``` + +Gets the ASR vault settings for the currently active(in the PowerShell session) Recovery Services vault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVaultSettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrvCenter.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrvCenter.md new file mode 100644 index 0000000000..749f933ac8 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesAsrvCenter.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesasrvcenter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrvCenter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesAsrvCenter.md +--- + +# Get-AzRecoveryServicesAsrvCenter + +## SYNOPSIS +Gets details of the vCenter servers registered for discovery on the Configuration server specified by the ASR fabric. + +## SYNTAX + +### ByFabricObject (Default) +``` +Get-AzRecoveryServicesAsrvCenter -Fabric <ASRFabric> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzRecoveryServicesAsrvCenter -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByName +``` +Get-AzRecoveryServicesAsrvCenter -Fabric <ASRFabric> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesAsrvCenter** cmdlet gets details of the vCenter servers registered for discovery on the Configuration server specified by the ASR fabric. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRecoveryServicesAsrvCenter -Fabric $Fabric -Name $Name +``` + +```output +FriendlyName : inmtest81 +Server : 10.150.209.27 +Port : 443 +Name : inmtest81 +ID : /Subscriptions/xxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxx/replicationFabrics/xxxxxxxxxxxxxxxxx/replicationvCenters/inmtest81 +FabricArmResourceName : d011a5abf48190235963ee3a88ad188ee6bca8a4c6cd0c8d7ce5d439aa77ffd9 +ProcessServerId : 526C9B6C-4039-D841-97A92FB0BD153B53 +AccountId : 2 +DiscoveryStatus : Pending +LastHeartbeat : +``` + +Get azure site recovery vCenter by fabric name and name of vCenter. + +### Example 2 +```powershell +Get-AzRecoveryServicesAsrvCenter -Fabric $Fabric +``` + +Get azure site recovery vCenter list by fabric name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fabric +ASR fabric object representing the Configuration Server. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: ByFabricObject, ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the vCenter server. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the resourceId of vCenter. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRvCenter + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupContainer.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupContainer.md new file mode 100644 index 0000000000..b56d56ffe1 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupContainer.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 1097FF29-1C23-4960-930C-5C1227419359 +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackupcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupContainer.md +--- + +# Get-AzRecoveryServicesBackupContainer + +## SYNOPSIS + +Gets Backup containers. + +## SYNTAX + +``` +Get-AzRecoveryServicesBackupContainer [-ContainerType] <ContainerType> [[-BackupManagementType] <String>] + [[-FriendlyName] <String>] [[-ResourceGroupName] <String>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION + +The **Get-AzRecoveryServicesBackupContainer** cmdlet gets a backup container. A Backup container encapsulates data sources that are modelled as backup items. +For Container type "Azure VM" , the output lists all the containers whose name exactly matches to the one passed as the value for Friendly Name parameter. +For other container types, output gives a list of containers with name similar to the value passed for Friendly name parameter. +Set the vault context by using the -VaultId parameter. + +## EXAMPLES + +### Example 1: Get a specific container + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +Get-AzRecoveryServicesBackupContainer -ContainerType "AzureVM" -FriendlyName "V2VM" -VaultId $vault.ID +``` + +This command gets the container named V2VM of type AzureVM. + +### Example 2: Get all containers of a specific type + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +Get-AzRecoveryServicesBackupContainer -ContainerType Windows -BackupManagementType MAB -VaultId $vault.ID +``` + +This command gets all Windows containers that are protected by Azure Backup agent. +The **BackupManagementType** parameter is only required for Windows containers. + +## PARAMETERS + +### -BackupManagementType + +The class of resources being protected. The acceptable values for this parameter are: + +- AzureVM +- MAB +- AzureWorkload +- AzureStorage + +This parameter is used to differentiate Windows machines that are backed up using MARS agent or other backup engines. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzureVM, AzureStorage, AzureWorkload, MAB + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerType + +Specifies the backup container type. +The acceptable values for this parameter are: + +- AzureVM +- Windows +- AzureStorage +- AzureVMAppContainer + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerType +Parameter Sets: (All) +Aliases: +Accepted values: AzureVM, Windows, AzureStorage, AzureVMAppContainer + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName + +Specifies the friendly name of the container to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specifies the name of the resource group. +This parameter is for Azure virtual machines only. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId + +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupItem](./Get-AzRecoveryServicesBackupItem.md) + +[Get-AzRecoveryServicesBackupManagementServer](./Get-AzRecoveryServicesBackupManagementServer.md) + +[Unregister-AzRecoveryServicesBackupContainer](./Unregister-AzRecoveryServicesBackupContainer.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupItem.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupItem.md new file mode 100644 index 0000000000..de9b2e7eef --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupItem.md @@ -0,0 +1,324 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: DEB3D7B5-D974-472B-B8B4-9A19CA6AECCC +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackupitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupItem.md +--- + +# Get-AzRecoveryServicesBackupItem + +## SYNOPSIS + +Gets the items from a container in Backup. + +## SYNTAX + +### GetItemsForContainer (Default) +``` +Get-AzRecoveryServicesBackupItem [-Container] <ContainerBase> [[-Name] <String>] + [[-ProtectionStatus] <ItemProtectionStatus>] [[-ProtectionState] <ItemProtectionState>] + [-WorkloadType] <WorkloadType> [[-DeleteState] <ItemDeleteState>] [-FriendlyName <String>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-UseSecondaryRegion] [<CommonParameters>] +``` + +### GetItemsForVault +``` +Get-AzRecoveryServicesBackupItem [-BackupManagementType] <BackupManagementType> [[-Name] <String>] + [[-ProtectionStatus] <ItemProtectionStatus>] [[-ProtectionState] <ItemProtectionState>] + [-WorkloadType] <WorkloadType> [[-DeleteState] <ItemDeleteState>] [-FriendlyName <String>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-UseSecondaryRegion] [<CommonParameters>] +``` + +### GetItemsForPolicy +``` +Get-AzRecoveryServicesBackupItem [-Policy] <PolicyBase> [[-Name] <String>] + [[-ProtectionStatus] <ItemProtectionStatus>] [[-ProtectionState] <ItemProtectionState>] + [[-DeleteState] <ItemDeleteState>] [-FriendlyName <String>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-UseSecondaryRegion] [<CommonParameters>] +``` + +## DESCRIPTION + +The **Get-AzRecoveryServicesBackupItem** cmdlet gets the list of protected items in a container and the protection status of the items. +A container that is registered to an Azure Recovery Services vault can have one or more items that can be protected. +For Azure virtual machines, there can be only one backup item in the virtual machine container. +Set the vault context by using the -VaultId parameter. + +## EXAMPLES + +### Example 1: Get an item from a Backup container + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$Container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVM -FriendlyName "V2VM" -VaultId $vault.ID +$BackupItem = Get-AzRecoveryServicesBackupItem -Container $Container -WorkloadType AzureVM -VaultId $vault.ID +``` + +The first command gets the container of type AzureVM, and then stores it in the $Container variable. +The second command gets the Backup item named V2VM in $Container, and then stores it in the $BackupItem variable. + +### Example 2: Get an Azure File Share Item from FriendlyName + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$Container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureStorage -FriendlyName "StorageAccount1" -VaultId $vault.ID +$BackupItem = Get-AzRecoveryServicesBackupItem -Container $Container -WorkloadType AzureFiles -VaultId $vault.ID -FriendlyName "FileShareName" +``` + +The first command gets the container of type AzureStorage, and then stores it in the $Container variable. +The second command gets the Backup item whose friendlyName matches the value passed in FriendlyName Parameter, and then stores it in the $BackupItem variable. +Using FriendlyName parameter can result in returning more than one Azure File Share. In such cases, execute the cmdlet by passing value for -Name parameter as the Name property returned in the result set of $BackupItem. + +## PARAMETERS + +### -BackupManagementType + +The class of resources being protected. The acceptable values for this parameter are: + +- AzureVM +- MAB +- AzureStorage +- AzureWorkload + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType +Parameter Sets: GetItemsForVault +Aliases: +Accepted values: AzureVM, MAB, AzureStorage, AzureWorkload + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container + +Specifies a container object from which this cmdlet gets backup items. +To obtain an **AzureRmRecoveryServicesBackupContainer**, use the **Get-AzRecoveryServicesBackupContainer** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase +Parameter Sets: GetItemsForContainer +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteState +Specifies the deletestate of the item +The acceptable values for this parameter are: + +- ToBeDeleted +- NotDeleted + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemDeleteState +Parameter Sets: (All) +Aliases: +Accepted values: ToBeDeleted, NotDeleted + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +FriendlyName of the backed up item + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +Specifies the name of backup item. For file share, specify the unique ID of protected file share. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy + +Protection policy object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase +Parameter Sets: GetItemsForPolicy +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionState + +Specifies the state of protection. +The acceptable values for this parameter are: + +- IRPending. +Initial synchronization has not started and there is no recovery point yet. +- Protected. +Protection is ongoing. +- ProtectionError. +There is a protection error. +- ProtectionStopped. +Protection is disabled. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemProtectionState +Parameter Sets: (All) +Aliases: +Accepted values: IRPending, ProtectionError, Protected, ProtectionStopped, BackupsSuspended + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionStatus + +Specifies the overall protection status of an item in the container. +The acceptable values for this parameter are: + +- Healthy +- Unhealthy + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemProtectionStatus +Parameter Sets: (All) +Aliases: +Accepted values: Healthy, Unhealthy + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseSecondaryRegion +Filters from Secondary Region for Cross Region Restore + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId + +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkloadType + +Workload type of the resource. The acceptable values for this parameter are: + +- AzureVM +- AzureFiles +- MSSQL +- FileFolder +- SAPHanaDatabase + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType +Parameter Sets: GetItemsForContainer, GetItemsForVault +Aliases: +Accepted values: AzureVM, AzureFiles, MSSQL, FileFolder, SAPHanaDatabase + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase + +## NOTES + +## RELATED LINKS + +[Backup-AzRecoveryServicesBackupItem](./Backup-AzRecoveryServicesBackupItem.md) + +[Disable-AzRecoveryServicesBackupProtection](./Disable-AzRecoveryServicesBackupProtection.md) + +[Get-AzRecoveryServicesBackupRecoveryPoint](./Get-AzRecoveryServicesBackupRecoveryPoint.md) + +[Restore-AzRecoveryServicesBackupItem](./Restore-AzRecoveryServicesBackupItem.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupJob.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupJob.md new file mode 100644 index 0000000000..d90f88c325 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupJob.md @@ -0,0 +1,317 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 12F8A120-7282-4844-90E0-1C3393336E8A +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackupjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupJob.md +--- + +# Get-AzRecoveryServicesBackupJob + +## SYNOPSIS + +Gets Backup jobs. + +## SYNTAX + +``` +Get-AzRecoveryServicesBackupJob [[-Status] <JobStatus>] [[-Operation] <JobOperation>] [[-From] <DateTime>] + [[-To] <DateTime>] [[-JobId] <String>] [[-Job] <JobBase>] [-BackupManagementType <BackupManagementType>] + [-UseSecondaryRegion] [-VaultLocation <String>] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION + +The **Get-AzRecoveryServicesBackupJob** cmdlet gets Azure Backup jobs for a specific vault. +Set the vault context by using the -VaultId parameter. + +## EXAMPLES + +### Example 1: Get all in-progress jobs + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$Joblist = Get-AzRecoveryServicesBackupJob -Status InProgress -VaultId $vault.ID +$Joblist[0] +``` + +```output +WorkloadName Operation Status StartTime EndTime +------------ --------- ------ --------- ------- +V2VM Backup InProgress 4/23/2016 5:00:30 PM 1/1/2001 12:00:00 +``` + +The first command gets status of an in-progress jobs as an array, and then stores it in the $Joblist variable. +The second command displays the first item in the $Joblist array. + +### Example 2: Get all failed jobs in the last 7 days + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +Get-AzRecoveryServicesBackupJob -From (Get-Date).AddDays(-7).ToUniversalTime() -Status Failed -VaultId $vault.ID +``` + +This command gets failed jobs from the last week in the vault. +The *From* parameter specifies a time seven days in the past specified in UTC. +The command does not specify a value for the *To* parameter. +Therefore, it uses the default value of the current time. + +### Example 3: Get an in-progress job and wait for completion + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$Jobs = Get-AzRecoveryServicesBackupJob -Status InProgress -VaultId $vault.ID +$Job = $Jobs[0] +While ( $Job.Status -ne "Completed" ) { + Write-Host -Object "Waiting for completion..." + Start-Sleep -Seconds 10 + $Job = Get-AzRecoveryServicesBackupJob -Job $Job -VaultId $vault.ID +} +Write-Host -Object "Done!" +``` + +```output +Waiting for completion... +Waiting for completion... +Waiting for completion... +Done! +``` + +This script polls the first job that is currently in progress until the job has completed. + +Note: You can use **Wait-AzRecoveryServicesBackupJob** cmdlet to wait for an Azure Backup job to finish instead of While loop. + +### Example 4: Get all AzureVM jobs in last 2 days which finished successfully + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$Jobs = Get-AzRecoveryServicesBackupJob -VaultId $vault.ID -Status Completed -From (Get-Date).AddDays(-2).ToUniversalTime() -BackupManagementType AzureVM +``` + +First cmdlet fetches the vault object. Second cmdlet stores all the AzureVM jobs in the given vault which completed in last 2 days to $jobs. Change the value of BackupManagementType parameter to MAB in order to fetch MAB agent jobs. + +## PARAMETERS + +### -BackupManagementType + +The class of resources being protected. Currently the values supported for this cmdlet are AzureVM, AzureStorage, AzureWorkload, MAB. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType] +Parameter Sets: (All) +Aliases: +Accepted values: AzureVM, AzureStorage, AzureWorkload, MAB + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From + +Specifies the start, as a **DateTime** object, of a time range for the jobs that this cmdlet gets. +To obtain a **DateTime** object, use the **Get-Date** cmdlet. +For more information about **DateTime** objects, type `Get-Help Get-Date`. +Use UTC format for dates. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Job + +Specifies the job to get. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId + +Specifies the ID of a job that this cmdlet gets. +The ID is the JobId property of a **Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase** object. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operation + +Specifies an operation of the jobs that this cmdlet gets. +The acceptable values for this parameter are: + +- Backup +- ConfigureBackup +- DeleteBackupData +- DisableBackup +- Restore +- BackupDataMove + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobOperation] +Parameter Sets: (All) +Aliases: +Accepted values: Backup, Restore, ConfigureBackup, DisableBackup, DeleteBackupData, BackupDataMove, UpdateCustomerManagedKey + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status + +Specifies a status of the jobs that this cmdlet gets. +The acceptable values for this parameter are: + +- InProgress +- Failed +- Cancelled +- Cancelling +- Completed +- CompletedWithWarnings + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobStatus] +Parameter Sets: (All) +Aliases: +Accepted values: InProgress, Cancelling, Cancelled, Completed, CompletedWithWarnings, Failed + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -To + +Specifies the end, as a **DateTime** object, of a time range for the jobs that this cmdlet gets. +The default value is the current system time. +If you specify this parameter, you must also specify the **-From** parameter. +Use UTC format for dates. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseSecondaryRegion +Filters from Secondary Region for Cross Region Restore + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId + +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VaultLocation +Location of the Recovery Services Vault used to fetch the secondary region jobs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupJobDetail](./Get-AzRecoveryServicesBackupJobDetail.md) + +[Stop-AzRecoveryServicesBackupJob](./Stop-AzRecoveryServicesBackupJob.md) + +[Wait-AzRecoveryServicesBackupJob](./Wait-AzRecoveryServicesBackupJob.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupJobDetail.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupJobDetail.md new file mode 100644 index 0000000000..b690800910 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupJobDetail.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 707A3E57-AF46-44B3-A491-89554900EF03 +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackupjobdetail +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupJobDetail.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupJobDetail.md +--- + +# Get-AzRecoveryServicesBackupJobDetail + +## SYNOPSIS + +Gets details for a Backup job. + +## SYNTAX + +### JobFilterSet (Default) +``` +Get-AzRecoveryServicesBackupJobDetail [-Job] <JobBase> [-UseSecondaryRegion] [-VaultLocation <String>] + [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### IdFilterSet +``` +Get-AzRecoveryServicesBackupJobDetail [-JobId] <String> [-UseSecondaryRegion] [-VaultLocation <String>] + [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION + +The **Get-AzRecoveryServicesBackupJobDetail** cmdlet gets Azure Backup job details for a specified job. +Set the vault context by using the -VaultId parameter. + +Warning: **Get-AzRecoveryServicesBackupJobDetails** alias will be removed in a future breaking change release. + +## EXAMPLES + +### Example 1: Get Backup job details for failed jobs + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$Jobs = Get-AzRecoveryServicesBackupJob -Status Failed -VaultId $vault.ID +$JobDetails = Get-AzRecoveryServicesBackupJobDetail -Job $Jobs[0] -VaultId $vault.ID +$JobDetails.ErrorDetails +``` + +The first command fetches the relevant vault. The second command gets an array of failed jobs in the vault, and then stores them in the $Jobs array. +The third command gets the job details for the 1st failed job in $Jobs, and then stores them in the $JobDetails variable. +The final command displays error details for the failed jobs. + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Job + +Specifies the job to get. +To obtain a **BackupJob** object, use the **Get-AzRecoveryServicesBackupJob** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase +Parameter Sets: JobFilterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId + +Specifies the ID of a Backup job. +The ID is the JobId property of a **Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase** object. + +```yaml +Type: System.String +Parameter Sets: IdFilterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseSecondaryRegion +Filters from Secondary Region for Cross Region Restore + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId + +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VaultLocation +Location of the Recovery Services Vault used to fetch the secondary region jobs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupJob](./Get-AzRecoveryServicesBackupJob.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupManagementServer.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupManagementServer.md new file mode 100644 index 0000000000..d59b2924b4 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupManagementServer.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 4B7ACEC8-29BB-4791-8087-801300F246B4 +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackupmanagementserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupManagementServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupManagementServer.md +--- + +# Get-AzRecoveryServicesBackupManagementServer + +## SYNOPSIS +Gets SCDPM and Azure Backup management servers. + +## SYNTAX + +``` +Get-AzRecoveryServicesBackupManagementServer [[-Name] <String>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesBackupManagementServer** cmdlet gets a list of Backup management servers that are registered in a vault. +There are two types of Backup management servers: System Center Data Protection Manager (SCDPM) and Azure Backup management servers. +Backup management servers are installed separately to manage Backup orchestration. +Set the vault context by using the Set-AzRecoveryServicesVaultContext cmdlet before you use the current cmdlet. + +## EXAMPLES + +### Example 1: Get all Backup management servers +```powershell +Get-AzRecoveryServicesBackupManagementServer +``` + +This command gets all Backup management servers registered with the vault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Backup management server to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupEngineBase + +## NOTES + +## RELATED LINKS + +[Unregister-AzRecoveryServicesBackupManagementServer](./Unregister-AzRecoveryServicesBackupManagementServer.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupProperty.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupProperty.md new file mode 100644 index 0000000000..c5e57f1d25 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupProperty.md @@ -0,0 +1,81 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackupproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupProperty.md +--- + +# Get-AzRecoveryServicesBackupProperty + +## SYNOPSIS +Gets Backup properties. + +## SYNTAX + +``` +Get-AzRecoveryServicesBackupProperty -Vault <ARSVault> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesBackupProperty** cmdlet gets backup properties for a Recovery Services vault. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRecoveryServicesBackupProperty -Vault $vault +``` + +Get the backup vault property for vault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vault +Specifies the name of the vault. +The vault must be an **AzureRmRecoveryServicesVault** object. +Run the [Get-AzRecoveryServicesVault](https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesvault) cmdlet to get the recovery services vault details. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.ARSVault + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.ASRVaultBackupProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupProtectableItem.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupProtectableItem.md new file mode 100644 index 0000000000..a30a7ad85b --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupProtectableItem.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackupprotectableitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupProtectableItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupProtectableItem.md +--- + +# Get-AzRecoveryServicesBackupProtectableItem + +## SYNOPSIS +This command will retrieve all protectable items within a certain container or across all registered containers. It will consist of all the elements of the hierarchy of the application. Returns DBs and their upper tier entities like Instance, AvailabilityGroup etc. + +## SYNTAX + +### NoFilterParamSet (Default) +``` +Get-AzRecoveryServicesBackupProtectableItem [[-Container] <ContainerBase>] [-WorkloadType] <WorkloadType> + [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### FilterParamSet +``` +Get-AzRecoveryServicesBackupProtectableItem [[-Container] <ContainerBase>] [-WorkloadType] <WorkloadType> + [[-ItemType] <ProtectableItemType>] [-Name <String>] [-ServerName <String>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### IdParamSet +``` +Get-AzRecoveryServicesBackupProtectableItem [-ParentID] <String> [[-ItemType] <ProtectableItemType>] + [-Name <String>] [-ServerName <String>] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesBackupProtectableItem** cmdlet gets the list of protectable items in a container and the protection status of the items. +A container that is registered to an Azure Recovery Services vault can have one or more items that can be protected. + +## EXAMPLES + +### Example 1 +```powershell +$Vault = Get-AzRecoveryServicesVault -Name "MyRecoveryVault" +$Container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVMAppContainer -VaultId $Vault.Id +$Item = Get-AzRecoveryServicesBackupProtectableItem -Container $Container -ItemType "SQLInstance" -WorkloadType "MSSQL" -VaultId $Vault.ID +``` + +The first command gets the container of type MSSQL, and then stores it in the $Container variable. +The second command gets the Backup protectable item in $Container, and then stores it in the $Item variable. + +## PARAMETERS + +### -Container +Container where the item resides + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase +Parameter Sets: NoFilterParamSet, FilterParamSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemType +Specifies the type of protectable item. Applicable values: (SQLDataBase, SQLInstance, SQLAvailabilityGroup). + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ProtectableItemType +Parameter Sets: FilterParamSet, IdParamSet +Aliases: +Accepted values: SQLDataBase, SQLInstance, SQLAvailabilityGroup + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Database, Instance or AvailabilityGroup. + +```yaml +Type: System.String +Parameter Sets: FilterParamSet, IdParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentID +Specified the ARM ID of an Instance or AG. + +```yaml +Type: System.String +Parameter Sets: IdParamSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server to which the item belongs. + +```yaml +Type: System.String +Parameter Sets: FilterParamSet, IdParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkloadType +Workload type of the resource. The current supported values are AzureVM, WindowsServer, AzureFiles, MSSQL + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType +Parameter Sets: NoFilterParamSet, FilterParamSet +Aliases: +Accepted values: AzureVM, WindowsServer, AzureFiles, MSSQL + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase +System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ProtectableItemBase + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupProtectionPolicy.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupProtectionPolicy.md new file mode 100644 index 0000000000..ad212b61a0 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupProtectionPolicy.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 2E202D0D-076D-431D-9338-9A84ABC0B461 +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackupprotectionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupProtectionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupProtectionPolicy.md +--- + +# Get-AzRecoveryServicesBackupProtectionPolicy + +## SYNOPSIS +Gets Backup protection policies for a vault. + +## SYNTAX + +### NoParamSet (Default) +``` +Get-AzRecoveryServicesBackupProtectionPolicy [-IsArchiveSmartTieringEnabled <Boolean>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-PolicySubType <PSPolicyType>] [<CommonParameters>] +``` + +### PolicyNameParamSet +``` +Get-AzRecoveryServicesBackupProtectionPolicy [-Name] <String> [-IsArchiveSmartTieringEnabled <Boolean>] + [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-PolicySubType <PSPolicyType>] + [<CommonParameters>] +``` + +### WorkloadParamSet +``` +Get-AzRecoveryServicesBackupProtectionPolicy [-WorkloadType] <WorkloadType> + [-IsArchiveSmartTieringEnabled <Boolean>] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + [-PolicySubType <PSPolicyType>] [<CommonParameters>] +``` + +### WorkloadBackupManagementTypeParamSet +``` +Get-AzRecoveryServicesBackupProtectionPolicy [-WorkloadType] <WorkloadType> + [-BackupManagementType] <BackupManagementType> [-IsArchiveSmartTieringEnabled <Boolean>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-PolicySubType <PSPolicyType>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesBackupProtectionPolicy** cmdlet gets Azure Backup protection policies for a vault. +Set the vault context by using the Set-AzRecoveryServicesVaultContext cmdlet before you use the current cmdlet. + +## EXAMPLES + +### Example 1: Get all policies in the vault +```powershell +Get-AzRecoveryServicesBackupProtectionPolicy +``` + +```output +Name WorkloadType BackupManagementType BackupTime DaysOfWeek +---- ------------ -------------------- ---------- ---------- +DefaultPolicy AzureVM AzureVM 4/14/2016 5:00:00 PM +NewPolicy AzureVM AzureVM 4/23/2016 5:30:00 PM +NewPolicy2 AzureVM AzureVM 4/24/2016 1:30:00 AM +``` + +This command gets all protection policies created in the vault. + +### Example 2: Get a specific policy +```powershell +$Pol= Get-AzRecoveryServicesBackupProtectionPolicy -Name "DefaultPolicy" +``` + +This command gets the protection policy named DefaultPolicy, and then stores it in the $pol variable. + +### Example 3: Get only Enhanced policies in a vault +```powershell +$pol = Get-AzRecoveryServicesBackupProtectionPolicy -VaultId $vault.ID -BackupManagementType AzureVM -WorkloadType AzureVM -PolicySubType Enhanced +``` + +This command gets only the Enhanced protection policies in RS vault, and then stores it in the $pol variable. + +### Example 4: Get smart tiering enabled policies in a vault +```powershell +$pol = Get-AzRecoveryServicesBackupProtectionPolicy -VaultId $vault.ID -BackupManagementType AzureVM -WorkloadType AzureVM -IsArchiveSmartTieringEnabled $true +``` + +This command gets only the policies in RS vault for which archive smart tiering is enabled. To fetch the policies for which smart tiering is disabled, set IsArchiveSmartTieringEnabled parameter to $false. To fetch all the polcies, skip this parameter. + +## PARAMETERS + +### -BackupManagementType +The class of resources being protected. Currently the values supported for this cmdlet are AzureVM, AzureStorage, AzureWorkload + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType] +Parameter Sets: WorkloadBackupManagementTypeParamSet +Aliases: +Accepted values: AzureVM, SCDPM, AzureBackupServer, AzureStorage, AzureWorkload, MAB + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchiveSmartTieringEnabled +Parameter to list policies for which smart tiering is Enabled/Disabled. Allowed values are $true, $false. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the policy. + +```yaml +Type: System.String +Parameter Sets: PolicyNameParamSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicySubType +Type of policy to be fetched: Standard, Enhanced + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PSPolicyType +Parameter Sets: (All) +Aliases: +Accepted values: Standard, Enhanced + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkloadType +Workload type of the resource. The current supported values are AzureVM, AzureFiles, MSSQL + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType] +Parameter Sets: WorkloadParamSet, WorkloadBackupManagementTypeParamSet +Aliases: +Accepted values: AzureVM, AzureSQLDatabase, AzureFiles, MSSQL + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase + +## NOTES + +## RELATED LINKS + +[New-AzRecoveryServicesBackupProtectionPolicy](./New-AzRecoveryServicesBackupProtectionPolicy.md) + +[Remove-AzRecoveryServicesBackupProtectionPolicy](./Remove-AzRecoveryServicesBackupProtectionPolicy.md) + +[Set-AzRecoveryServicesBackupProtectionPolicy](./Set-AzRecoveryServicesBackupProtectionPolicy.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRPMountScript.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRPMountScript.md new file mode 100644 index 0000000000..7a5f193287 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRPMountScript.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackuprpmountscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupRPMountScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupRPMountScript.md +--- + +# Get-AzRecoveryServicesBackupRPMountScript + +## SYNOPSIS +Downloads a script to mount all the files of the recovery point. + +## SYNTAX + +``` +Get-AzRecoveryServicesBackupRPMountScript [-RecoveryPoint] <RecoveryPointBase> [[-Path] <String>] + [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzRecoveryServicesBackupRPMountScript cmdlet downloads a script which mounts the volumes of the recovery point on the machine where it is run. + +## EXAMPLES + +### Example 1: Mount a recovery point +```powershell +$namedContainer = Get-AzRecoveryServicesBackupContainer -ContainerType "AzureVM" -Status "Registered" -FriendlyName "V2VM" +$backupitem = Get-AzRecoveryServicesBackupItem -Container $namedContainer -WorkloadType "AzureVM" +$startDate = (Get-Date).AddDays(-7) +$endDate = Get-Date +$rp = Get-AzRecoveryServicesBackupRecoveryPoint -Item $backupitem -StartDate $startdate.ToUniversalTime() -EndDate $enddate.ToUniversalTime() + +<# To mount files of the latest recovery point, obtain the script by #> + +Get-AzRecoveryServicesBackupRPMountScript -RecoveryPoint $rp[0] +``` + +```output +OsType Password Filename +------ -------- -------- +Windows e3632984e51f496 V2VM_wus2_8287309959960546283_451516692429_cbd6061f7fc543c489f1974d33659fed07a6e0c2e08740.exe +``` + +When the script is run, it will mount the files of the recovery point $rp\[0\] + +### Example 2 + +Downloads a script to mount all the files of the recovery point. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzRecoveryServicesBackupRPMountScript -RecoveryPoint $rp[0] -VaultId $vault.ID +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Location where the file should be downloaded in the case of file recovery. If -Path is not provided, the script file will be downloaded in the current directory. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPoint +Recovery point object to be restored + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RPMountScriptDetails + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup.md new file mode 100644 index 0000000000..7cf596ffd2 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackuprecommendedarchivablerpgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup.md +--- + +# Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup + +## SYNOPSIS +Gets the recovery points which are recommended to be moved together to VaultArchive tier. + +## SYNTAX + +``` +Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup [-Item] <ItemBase> [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup** gets the recovery points which are recommended to be moved to VaultArchive tier. +These recovery points when moved together will lead to maximum savings. + +## EXAMPLES + +### Example 1: Fetch recommended rps to be moved to VaultArchive tier +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$item = Get-AzRecoveryServicesBackupItem -BackupManagementType "AzureVM" -WorkloadType "AzureVM" -VaultId $vault.ID +$rpGroup = Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup -Item $item[3] -VaultId $vault.ID +``` + +Here we use **Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup** cmdlet to fetch the recommended RPs list to be moved to VaultArchive tier +and assign to $rpGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Item +Protected Item object for which recovery point need to be fetched + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRecoveryLogChain.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRecoveryLogChain.md new file mode 100644 index 0000000000..5eabc4e167 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRecoveryLogChain.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackuprecoverylogchain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupRecoveryLogChain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupRecoveryLogChain.md +--- + +# Get-AzRecoveryServicesBackupRecoveryLogChain + +## SYNOPSIS +This command lists the start and end points of the unbroken log chain of the given backup item. Use it to determine whether the point-in-time, to which the user wants the DB to be restored, is valid or not. + +## SYNTAX + +### NoFilterParameterSet (Default) +``` +Get-AzRecoveryServicesBackupRecoveryLogChain [-Item] <ItemBase> [-UseSecondaryRegion] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DateTimeFilter +``` +Get-AzRecoveryServicesBackupRecoveryLogChain [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] + [-Item] <ItemBase> [-UseSecondaryRegion] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesBackupRecoveryLogChain** cmdlet gets the time range recovery points in time for a backed up Azure Backup item. +After an item has been backed up, an **AzRecoveryServicesBackupRecoveryLogChain** object has one or more recovery time ranges. + +## EXAMPLES + +### Example 1 +```powershell +$StartDate = (Get-Date).AddDays(-7) +$EndDate = Get-Date +$Container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureWorkload +$RP = Get-AzRecoveryServicesBackupItem -Container $Container -WorkloadType MSSQL | Get-AzRecoveryServicesBackupRecoveryLogChain -StartDate $Startdate.ToUniversalTime() -EndDate $Enddate.ToUniversalTime() +``` + +The first command gets the date from seven days ago, and then stores it in the $StartDate variable. +The second command gets today's date, and then stores it in the $EndDate variable. +The third command gets AzureWorkload backup containers, and stores them in the $Container variable. +The fourth command gets the backup item, and then shares it across the piped cmdlet as backup item object. +The last command gets an array of recovery point time ranges for the item in $BackupItem, and then stores them in the $RP variable. + +### Example 2 + +This command lists the start and end points of the unbroken log chain of the given backup item. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzRecoveryServicesBackupRecoveryLogChain -Item $Item -VaultId $vault.ID +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +End time of Time range for which recovery point need to be fetched + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: DateTimeFilter +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Item +Protected Item object for which recovery point need to be fetched + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StartDate +Start time of Time range for which recovery point need to be fetched + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: DateTimeFilter +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseSecondaryRegion +Filters from Secondary Region for Cross Region Restore + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase +System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRecoveryPoint.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRecoveryPoint.md new file mode 100644 index 0000000000..4b7c0cd6d6 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRecoveryPoint.md @@ -0,0 +1,345 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 838026E4-F001-434C-86F0-B2A838E93A9C +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackuprecoverypoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupRecoveryPoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupRecoveryPoint.md +--- + +# Get-AzRecoveryServicesBackupRecoveryPoint + +## SYNOPSIS + +Gets the recovery points for a backed up item. + +## SYNTAX + +### NoFilterParameterSet (Default) +``` +Get-AzRecoveryServicesBackupRecoveryPoint [-Item] <ItemBase> [-UseSecondaryRegion] [-Tier <RecoveryPointTier>] + [-IsReadyForMove <Boolean>] [-TargetTier <RecoveryPointTier>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DateTimeFilter +``` +Get-AzRecoveryServicesBackupRecoveryPoint [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [-Item] <ItemBase> + [-UseSecondaryRegion] [-Tier <RecoveryPointTier>] [-IsReadyForMove <Boolean>] + [-TargetTier <RecoveryPointTier>] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### RecoveryPointId +``` +Get-AzRecoveryServicesBackupRecoveryPoint [-Item] <ItemBase> [-RecoveryPointId] <String> + [[-KeyFileDownloadLocation] <String>] [-UseSecondaryRegion] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION + +The **Get-AzRecoveryServicesBackupRecoveryPoint** cmdlet gets the recovery points for a backed up Azure Backup item. +After an item has been backed up, an **AzureRmRecoveryServicesBackupRecoveryPoint** object has one or more recovery points. +Set the vault context by using the -VaultId parameter. + +## EXAMPLES + +### Example 1: Get recovery points from the last week for an item + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$startDate = (Get-Date).AddDays(-7) +$endDate = Get-Date +$container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVM -FriendlyName "V2VM" -VaultId $vault.ID +$backupItem = Get-AzRecoveryServicesBackupItem -Container $container -WorkloadType AzureVM -VaultId $vault.ID +$rp = Get-AzRecoveryServicesBackupRecoveryPoint -Item $backupItem -StartDate $startdate.ToUniversalTime() -EndDate $enddate.ToUniversalTime() -VaultId $vault.ID +``` + +The first command gets vault object based on vaultName. +The second command gets the date from seven days ago, and then stores it in the $startDate variable. +The third command gets today's date, and then stores it in the $endDate variable. +The fourth command gets AzureVM backup containers, and stores them in the $Container variable. +The fifth command gets the backup item based on workloadType, vaultId and then stores it in the $backupItem variable. +The last command gets an array of recovery points for the item in $BackupItem, and then stores them in the $rp variable. + +### Example 2: Get recovery points which are ready to be moved to VaultArchive + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$startDate = (Get-Date).AddDays(-7).ToUniversalTime() +$endDate = (Get-Date).ToUniversalTime() +$item = Get-AzRecoveryServicesBackupItem -BackupManagementType "AzureVM" -WorkloadType "AzureVM" -VaultId $vault.ID +$rp = Get-AzRecoveryServicesBackupRecoveryPoint -StartDate $startDate -EndDate $endDate -VaultId $vault.ID -Item $item[3] ` +-IsReadyForMove $true -TargetTier VaultArchive +``` + +The first command gets vault object based on vaultName. The second command gets the date from seven days ago, and then stores it in the $startDate variable. +The third command gets today's date, and then stores it in the $endDate variable. +The fourth command gets backup items based on backupManagementType and workloadType, vaultId and then stores it in the $item variable. +The last command gets an array of recovery points for the item in $backupItem which are ready to be moved to VaultArchive tier and +then stores them in the $rp variable. + +### Example 3: Get recovery points in a particular tier + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$startDate = (Get-Date).AddDays(-7).ToUniversalTime() +$endDate = (Get-Date).ToUniversalTime() +$item = Get-AzRecoveryServicesBackupItem -BackupManagementType "AzureVM" -WorkloadType "AzureVM" -VaultId $vault.ID +$rp = Get-AzRecoveryServicesBackupRecoveryPoint -StartDate $startDate -EndDate $endDate -VaultId $vault.ID -Item $item[3] ` +-Tier VaultStandard +``` + +The first command gets vault object based on vaultName. The second command gets the date from seven days ago, and then stores it in the $startDate variable. +The third command gets today's date, and then stores it in the $endDate variable. +The fourth command gets backup items based on backupManagementType and workloadType, vaultId and then stores it in the $item variable. +The last command gets an array of recovery points for the item in $backupItem which are ready to be moved to VaultArchive tier and +then stores them in the $rp variable. + +### Example 4: Getting pruned recovery points in last year after modify policy opertaion + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$startDate = (Get-Date).AddDays(-365).ToUniversalTime() +$endDate = (Get-Date).ToUniversalTime() +$item = Get-AzRecoveryServicesBackupItem -BackupManagementType "AzureVM" -WorkloadType "AzureVM" -VaultId $vault.ID +$rpsBefore = Get-AzRecoveryServicesBackupRecoveryPoint -Item $item[0] -StartDate $startDate -EndDate $endDate -VaultId $vault.ID + +# update policy +$pol = Get-AzRecoveryServicesBackupProtectionPolicy -VaultId $vault.ID -Name "policyName" +$pol.RetentionPolicy.IsWeeklyScheduleEnabled = $false +$pol.RetentionPolicy.IsMonthlyScheduleEnabled = $false +$pol.RetentionPolicy.IsYearlyScheduleEnabled = $false +Set-AzRecoveryServicesBackupProtectionPolicy -Policy $pol -VaultId $vault.ID -RetentionPolicy $pol.RetentionPolicy -Debug + +# wait until policy changes are applied to recovery points and they are pruned +$rpsAfter = Get-AzRecoveryServicesBackupRecoveryPoint -Item $item[0] -StartDate $startDate -EndDate $endDate -VaultId $vault.ID + +# compare the recovery points list before and after +$diff = Compare-Object $rpsBefore $rpsAfter +$rpsRemoved = $diff | Where-Object{ $_.SideIndicator -eq'<='} | Select-Object -ExpandProperty InputObject +$rpsRemoved +``` + +```output +RecoveryPointId RecoveryPointType RecoveryPointTime ContainerName ContainerType +--------------- ----------------- ----------------- ------------- ------------- +7397781054902 CrashConsistent 5/2/2023 3:28:35 AM iaasvmcontainerv2;test-rg;test-vm AzureVM +9722704411921 CrashConsistent 4/1/2023 3:32:26 AM iaasvmcontainerv2;test-rg;test-vm AzureVM +6543100104464 CrashConsistent 3/1/2023 3:26:27 AM iaasvmcontainerv2;test-rg;test-vm AzureVM +``` + +The first command gets vault object based on vaultName. The second command gets the date from one year days ago, and then stores it in the $startDate variable. +The third command gets today's date, and then stores it in the $endDate variable. +The fourth command gets backup items based on backupManagementType and workloadType, vaultId and then stores it in the $item variable. +The fifth command gets an array of recovery points for the item in $item which are present before the modify policy operation in last one year. +Now we move on to update the policy. The sixth command fetches the policy to be updated which is used to protect the backup item $item[0]. +The seventh, eight and ninth commands disable the yearly and monthly retention in the policy to prune the older recovery points. +The tenth command finally updates the retention policy. +The eleventh command waits in the same powershell session until the recovery points are pruned and fetches the recovery points within the same time range, after the policy changes are applied. +The twelth command takes a diff between recovery point list before and after pruning occurs. +The thirteenth command read the recovery points, from the diff, which were present before and are now pruned. +The last command displays the list of pruned recovery points. + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate + +Specifies the end of the date range. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: DateTimeFilter +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsReadyForMove + +Filters the Recovery Points based on whether RP is Ready to move to target tier. Use this along with target tier parameter. + +```yaml +Type: System.Boolean +Parameter Sets: NoFilterParameterSet, DateTimeFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Item + +Specifies the item for which this cmdlet gets recovery points. +To obtain an **AzureRmRecoveryServicesBackupItem** object, use the **Get-AzRecoveryServicesBackupItem** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyFileDownloadLocation + +Specifies the location to download the input file to restore the KeyVault key for an encrypted virtual machine. + +```yaml +Type: System.String +Parameter Sets: RecoveryPointId +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPointId + +Specifies the recovery point ID. + +```yaml +Type: System.String +Parameter Sets: RecoveryPointId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate + +Specifies the start of the date range. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: DateTimeFilter +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetTier + +Target tier to check move readiness of recovery point. Currently only valid value is 'VaultArchive'. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointTier +Parameter Sets: NoFilterParameterSet, DateTimeFilter +Aliases: +Accepted values: VaultArchive + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tier + +Filter recovery points based on tier value. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointTier +Parameter Sets: NoFilterParameterSet, DateTimeFilter +Aliases: +Accepted values: VaultStandard, Snapshot, VaultArchive, VaultStandardRehydrated, SnapshotAndVaultStandard, SnapshotAndVaultArchive + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseSecondaryRegion +Filters from Secondary Region for Cross Region Restore + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId + +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupContainer](./Get-AzRecoveryServicesBackupContainer.md) + +[Get-AzRecoveryServicesBackupItem](./Get-AzRecoveryServicesBackupItem.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRetentionPolicyObject.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRetentionPolicyObject.md new file mode 100644 index 0000000000..e56758a144 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupRetentionPolicyObject.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 476094CC-A320-4B2D-B53D-6BFFE30C76CC +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackupretentionpolicyobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupRetentionPolicyObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupRetentionPolicyObject.md +--- + +# Get-AzRecoveryServicesBackupRetentionPolicyObject + +## SYNOPSIS +Gets a base retention policy object. + +## SYNTAX + +``` +Get-AzRecoveryServicesBackupRetentionPolicyObject [-WorkloadType] <WorkloadType> + [[-BackupManagementType] <BackupManagementType>] [-DefaultProfile <IAzureContextContainer>] + [[-ScheduleRunFrequency] <ScheduleRunType>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesBackupRetentionPolicyObject** cmdlet gets a base **AzureRMRecoveryServicesRetentionPolicyObject**. +This object is not persisted in the system. +It is a temporary object that you can manipulate and use with the New-AzRecoveryServicesBackupProtectionPolicy cmdlet to create a new backup policy. + +## EXAMPLES + +### Example 1: Create a backup protection policy +```powershell +$RetPol = Get-AzRecoveryServicesBackupRetentionPolicyObject -WorkloadType AzureVM +$RetPol.DailySchedule.DurationCountInDays = 365 +$SchPol = Get-AzRecoveryServicesBackupSchedulePolicyObject -WorkloadType AzureVM +New-AzRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol +``` + +The first command gets the retention policy object, and then stores it in the $RetPol variable. +The second command sets the duration for the retention policy object to 365 days. +The third command gets the schedule policy object, and then stores it in the $SchPol variable. +The last command creates a backup protection policy using the retention policy and schedule policy created with the previous commands. + +### Example 2: Get base hourly retention object for fileshare policy +```powershell +$retentionPolicy = Get-AzRecoveryServicesBackupRetentionPolicyObject -WorkloadType AzureFiles -BackupManagementType AzureStorage -ScheduleRunFrequency Hourly +$retentionPolicy.DailySchedule.DurationCountInDays = 10 +``` + +The first command gets a base hourly **RetentionPolicy** object, and then stores it in the $retentionPolicy variable. Similarly the retention hourly policy can be fetched for enhanced hourly schedule for other workloads. +The second command sets the retention duration for daily recovery points to 10 days. + +## PARAMETERS + +### -BackupManagementType +The class of resources being protected. The acceptable values for this parameter are: +- AzureVM +- AzureWorkload +- AzureStorage + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType] +Parameter Sets: (All) +Aliases: +Accepted values: AzureVM, AzureStorage, AzureWorkload + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleRunFrequency +Frequency of the schedule for which base retention policy object is fetched. Acceptable values are Daily and Hourly. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ScheduleRunType +Parameter Sets: (All) +Aliases: +Accepted values: Daily, Hourly, Weekly + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkloadType +Workload type of the resource. The acceptable values for this parameter are: +- AzureVM +- AzureFiles +- MSSQL + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType +Parameter Sets: (All) +Aliases: +Accepted values: AzureVM, AzureFiles, MSSQL + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RetentionPolicyBase + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupSchedulePolicyObject](./Get-AzRecoveryServicesBackupSchedulePolicyObject.md) + +[New-AzRecoveryServicesBackupProtectionPolicy](./New-AzRecoveryServicesBackupProtectionPolicy.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupSchedulePolicyObject.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupSchedulePolicyObject.md new file mode 100644 index 0000000000..2d840a3724 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupSchedulePolicyObject.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: E247C6DF-B53D-487E-AAA2-551FCBFD77E7 +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackupschedulepolicyobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupSchedulePolicyObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupSchedulePolicyObject.md +--- + +# Get-AzRecoveryServicesBackupSchedulePolicyObject + +## SYNOPSIS +Gets a base schedule policy object. + +## SYNTAX + +``` +Get-AzRecoveryServicesBackupSchedulePolicyObject [-WorkloadType] <WorkloadType> + [[-BackupManagementType] <BackupManagementType>] [-DefaultProfile <IAzureContextContainer>] + [[-ScheduleRunFrequency] <ScheduleRunType>] [[-PolicySubType] <PSPolicyType>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesBackupSchedulePolicyObject** cmdlet gets a base **AzureRMRecoveryServicesSchedulePolicyObject**. +This object is not persisted in the system. +It is temporary object that you can manipulate and use with the New-AzRecoveryServicesBackupProtectionPolicy cmdlet to create a new backup protection policy. + +## EXAMPLES + +### Example 1: Set the schedule frequency to weekly +```powershell +$RetPol = Get-AzRecoveryServicesBackupRetentionPolicyObject -WorkloadType "AzureVM" +$SchPol = Get-AzRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM" +$SchPol.ScheduleRunFrequency = "Weekly" +New-AzRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol +``` + +The first command gets the retention policy object, and then stores it in the $RetPol variable. +The second command gets the schedule policy object, and then stores it in the $SchPol variable. +The third command changes the frequency for the schedule policy to weekly. +The last command creates a backup protection policy with the updated schedule. + +### Example 2: Set the backup time +```powershell +$SchPol = Get-AzRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM" +$SchPol.ScheduleRunTimes.RemoveAll() +$DT = Get-Date +$SchPol.ScheduleRunTimes.Add($DT.ToUniversalTime()) +New-AzRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol +``` + +The first command gets the schedule policy object, and then stores it in the $SchPol variable. +The second command removes all scheduled run times from $SchPol. +The third command gets the current date and time, and then stores it in the $DT variable. +The fourth command replaces the scheduled run times with the current time. +You can only backup AzureVM once per day, so to reset the backup time you must replace the original schedule. +The last command creates a backup protection policy using the new schedule. + +### Example 3: Get hourly schedule for fileshare policy +```powershell +$schedulePolicy = Get-AzRecoveryServicesBackupSchedulePolicyObject -WorkloadType AzureFiles -BackupManagementType AzureStorage -ScheduleRunFrequency Hourly +$timeZone = Get-TimeZone +$schedulePolicy.ScheduleRunTimeZone = $timeZone.Id +$startTime = Get-Date -Date "2021-12-22T06:00:00.00+00:00" +$schedulePolicy.ScheduleWindowStartTime = $startTime.ToUniversalTime() +$schedulePolicy.ScheduleInterval = 6 +$schedulePolicy.ScheduleWindowDuration = 14 +``` + +The first command gets a base hourly **SchedulePolicyObject**, and then stores it in the $schedulePolicy variable. +The second and third command fetches the timezone and updates the timezone in the $schedulePolicy. +The fourth and fifth command initializes the schedule window start time and updates the $schedulePolicy. Please note the start time must be in UTC even if the timezone is not UTC. +The sixth and seventh command updates the interval (in hours) after which the backup will be retriggered on the same day, duration (in hours) for which the schedule will run. + +### Example 4: Get enhanced hourly schedule for AzureVM policy +```powershell +$schedulePolicy = Get-AzRecoveryServicesBackupSchedulePolicyObject -WorkloadType AzureVM -BackupManagementType AzureVM -PolicySubType Enhanced -ScheduleRunFrequency Hourly +$timeZone = Get-TimeZone -ListAvailable | Where-Object { $_.Id -match "India" } +$schedulePolicy.ScheduleRunTimeZone = $timeZone.Id +$windowStartTime = (Get-Date -Date "2022-04-14T08:00:00.00+00:00").ToUniversalTime() +$schPol.HourlySchedule.WindowStartTime = $windowStartTime +$schedulePolicy.HourlySchedule.ScheduleInterval = 4 +$schedulePolicy.HourlySchedule.ScheduleWindowDuration = 23 +``` + +The first command gets a base enhanced hourly **SchedulePolicyObject** for WorkloadType AzureVM, and then stores it in the $schedulePolicy variable. +The second and third command fetches the India timezone and updates the timezone in the $schedulePolicy. +The fourth and fifth command initializes the schedule window start time and updates the $schedulePolicy. Please note that the start time must be in UTC even if the timezone is not UTC. +The sixth and seventh command updates the interval (in hours) after which the backup will be retriggered on the same day, duration (in hours) for which the schedule will run. + +## PARAMETERS + +### -BackupManagementType +The class of resources being protected. The acceptable values for this parameter are: +- AzureVM +- AzureStorage +- AzureWorkload + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType] +Parameter Sets: (All) +Aliases: +Accepted values: AzureVM, AzureStorage, AzureWorkload + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicySubType +Type of schedule policy to be fetched: Standard, Enhanced + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PSPolicyType +Parameter Sets: (All) +Aliases: +Accepted values: Standard, Enhanced + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleRunFrequency +Schedule run frequency for the policy schedule. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ScheduleRunType +Parameter Sets: (All) +Aliases: +Accepted values: Daily, Hourly, Weekly + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkloadType +Workload type of the resource. The acceptable values for this parameter are: +- AzureVM +- AzureFiles +- MSSQL + + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType +Parameter Sets: (All) +Aliases: +Accepted values: AzureVM, AzureFiles, MSSQL + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.SchedulePolicyBase + +## NOTES + +## RELATED LINKS + +[New-AzRecoveryServicesBackupProtectionPolicy](./New-AzRecoveryServicesBackupProtectionPolicy.md) + +[Set-AzRecoveryServicesBackupProtectionPolicy](./Set-AzRecoveryServicesBackupProtectionPolicy.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupStatus.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupStatus.md new file mode 100644 index 0000000000..8ba9be7b85 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupStatus.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackupstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupStatus.md +--- + +# Get-AzRecoveryServicesBackupStatus + +## SYNOPSIS +Checks whether your ARM resource is backed up or not. + +## SYNTAX + +### Name (Default) +``` +Get-AzRecoveryServicesBackupStatus -Name <String> -ResourceGroupName <String> -Type <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### IdWorkload +``` +Get-AzRecoveryServicesBackupStatus -Type <String> -ResourceId <String> -ProtectableObjectName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Id +``` +Get-AzRecoveryServicesBackupStatus -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The command returns null/empty if the specified resource is not protected under any Recovery Services vault in the subscription. +If it is protected, the relevant vault details will be returned. + +## EXAMPLES + +### Example 1 + +Checks whether your ARM resource is backed up or not. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzRecoveryServicesBackupStatus -Name 'myAzureVM' -ResourceGroupName 'myAzureVMRG' -Type AzureVM +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Resource whose representative item needs to be checked if it is already protected by some Recovery Services Vault in the subscription. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectableObjectName +Name of the Azure Resource whose representative item needs to be checked if it is already protected by some Recovery Services Vault in the subscription. + +```yaml +Type: System.String +Parameter Sets: IdWorkload +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group of the Azure Resource whose representative item needs to be checked if it is already protected by some RecoveryServices Vault in the subscription. + +```yaml +Type: System.String +Parameter Sets: Name +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the Azure Resource whose representative item needs to be checked if it is already protected by some RecoveryServices Vault in the subscription. + +```yaml +Type: System.String +Parameter Sets: IdWorkload, Id +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +Type of the Azure Resource whose representative item needs to be checked if it is already protected by some Recovery Services Vault in the subscription. + +```yaml +Type: System.String +Parameter Sets: Name, IdWorkload +Aliases: +Accepted values: AzureVM, AzureFiles + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ResourceBackupStatus + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupWorkloadRecoveryConfig.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupWorkloadRecoveryConfig.md new file mode 100644 index 0000000000..a14920ec6c --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesBackupWorkloadRecoveryConfig.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesbackupworkloadrecoveryconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupWorkloadRecoveryConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupWorkloadRecoveryConfig.md +--- + +# Get-AzRecoveryServicesBackupWorkloadRecoveryConfig + +## SYNOPSIS +This command constructs the recovery configuration of a backed up item such as SQL DB. The configuration object stores all details such as the recovery mode, target destinations for the restore and application specific parameters like target physical paths for SQL. + +## SYNTAX + +### RpParameterSet (Default) +``` +Get-AzRecoveryServicesBackupWorkloadRecoveryConfig [[-RecoveryPoint] <RecoveryPointBase>] + [[-TargetItem] <ProtectableItemBase>] [[-Item] <ItemBase>] [-OriginalWorkloadRestore] + [-AlternateWorkloadRestore] [-TargetContainer <ContainerBase>] [-RestoreAsFiles] + [-FromFull <RecoveryPointBase>] [-FilePath <String>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-UseSecondaryRegion] [<CommonParameters>] +``` + +### LogChainParameterSet +``` +Get-AzRecoveryServicesBackupWorkloadRecoveryConfig [[-PointInTime] <DateTime>] + [[-TargetItem] <ProtectableItemBase>] [[-Item] <ItemBase>] [-OriginalWorkloadRestore] + [-AlternateWorkloadRestore] [-TargetContainer <ContainerBase>] [-RestoreAsFiles] + [-FromFull <RecoveryPointBase>] [-FilePath <String>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-UseSecondaryRegion] [<CommonParameters>] +``` + +## DESCRIPTION +The command returns a recovery config for AzureWorkload items which is passed to the restore cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +$SQLRecoveryObject = Get-AzRecoveryServicesBackupRecoveryPoint -Item $SQLBkpItem $startdate $enddate | Get-AzRecoveryServicesBackupWorkloadRecoveryConfig -OriginalWorkloadRestore +$SQLRecoveryObject = Get-AzRecoveryServicesBackupRecoveryPoint -Item $SQLBkpItem $startdate $enddate | Get-AzRecoveryServicesBackupWorkloadRecoveryConfig -AlternateWorkloadRestore -TargetItem $SQLProtItem -TargetContainer $targetVMContainer +``` + +The first cmdlet is used to get the Recovery point object. +The second cmdlet creates a recovery plan for a original location restore. +THe third cmdlet creates a recovery plan for a alternate location restore. +Note: Parameter -TargetContainer is mandatory in case of AlternateLocationRestore or RestoreAsFiles. + +### Example 2 + +This command constructs the recovery configuration of a backed up item such as SQL DB. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Get-AzRecoveryServicesBackupWorkloadRecoveryConfig -AlternateWorkloadRestore -RecoveryPoint $rp[0] -TargetItem <ProtectableItemBase> -TargetContainer $targetVMContainer -VaultId $vault.ID +``` + +## PARAMETERS + +### -AlternateWorkloadRestore +Specifies that the backed up DB should be restored onto another selected server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +Specifies the filepath which is used for restore operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromFull +Specifies the Full RecoveryPoint to which Log backups will be applied. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Item +Specifies the backup item on which the restore operation is being performed. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OriginalWorkloadRestore +Specifies that the backed up DB is to be overwritten with the DB information present in the recovery point. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PointInTime +End time of Time range for which recovery point need to be fetched + +```yaml +Type: System.DateTime +Parameter Sets: LogChainParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPoint +Recovery point object to be restored + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase +Parameter Sets: RpParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RestoreAsFiles +Specifies to restore Database as files in a machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetContainer +Specifies the target machine on which DB Files need to be restored. TargetContainer is mandatory in case of AlternateLocationRestore or RestoreAsFiles. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetItem +Specifies the target on which the DB needs to be restored. For SQL restores, it needs to be of protectable item type SQLInstance only. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ProtectableItemBase +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseSecondaryRegion +Filters from Secondary Region for Cross Region Restore + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase +System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryConfigBase + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesResourceGuardMapping.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesResourceGuardMapping.md new file mode 100644 index 0000000000..c64682fb1a --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesResourceGuardMapping.md @@ -0,0 +1,80 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesresourceguardmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesResourceGuardMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesResourceGuardMapping.md +--- + +# Get-AzRecoveryServicesResourceGuardMapping + +## SYNOPSIS +Gets the resource guard mapping added to the recovery services vault. + +## SYNTAX + +``` +Get-AzRecoveryServicesResourceGuardMapping [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the resource guard mapping added to the recovery services vault. This cmdlet fetches the mapping between the recovery services vault and resource guard + +## EXAMPLES + +### Example 1 Fetch the resource guard mapping + +```powershell +Get-AzRecoveryServicesResourceGuardMapping -VaultId $vault.ID +``` + +The above command fetches the existing mapping between the vault and the resource guard. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.RecoveryServices.Backup.Models.ResourceGuardProxyBaseResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesVault.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesVault.md new file mode 100644 index 0000000000..1db215fce3 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesVault.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 818B5302-91EE-425F-B1CD-86B626F1B7A3 +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesVault.md +--- + +# Get-AzRecoveryServicesVault + +## SYNOPSIS + +Gets a list of Recovery Services vaults. + +## SYNTAX + +### ByTagNameValueParameterSet +``` +Get-AzRecoveryServicesVault [[-ResourceGroupName] <String>] [[-Name] <String>] [-TagName <String>] + [-TagValue <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTagObjectParameterSet +``` +Get-AzRecoveryServicesVault [[-ResourceGroupName] <String>] [[-Name] <String>] -Tag <Hashtable> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION + +The **Get-AzRecoveryServicesVault** cmdlet gets a list of Recovery Services vaults in the current subscription. + +## EXAMPLES + +### Example 1 + +```powershell +Get-AzRecoveryServicesVault +``` + +Get the list of vault in selected subscription. + +### Example 2 + +```powershell +Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" +``` + +Get the list of vault in resource group in selected subscription. + +### Example 3: Get vault MSI, PublicNetworkAccess, ImmutabilityState, CrossSubscriptionRestoreState + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$vault.Identity | Format-List +$vault.Properties.PublicNetworkAccess +$vault.Properties.ImmutabilitySettings.ImmutabilityState +$vault.Properties.RestoreSettings.CrossSubscriptionRestoreSettings.CrossSubscriptionRestoreState +``` + +```output +PrincipalId : XXXXXXXX-XXXX-XXXX +TenantId : XXXXXXXX-XXXX-XXXX +Type : SystemAssigned + +Enabled +Disabled +Enabled +``` + +The first cmdlet gets the vault in resource group with given name. Then we access the MSI information from the vault. Third and fourth commands are used to fetch the public network access, immutability state, cross subscription restore state of the vault. + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +Specifies the name of the vault to query for. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specifies the name of the Azure resource group from which to retrieve the specified Recovery Services object. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag + +Specifies the Tags to query for + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTagObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagName + +Specifies the Key of the Tag to query for + +```yaml +Type: System.String +Parameter Sets: ByTagNameValueParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagValue + +Specifies the Value of the Tag to query for + +```yaml +Type: System.String +Parameter Sets: ByTagNameValueParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.ARSVault + +## NOTES +Get-AzRecoveryServicesVault in old version of Az.RecoveryServices(<=2.10.0) cannot work with Az.Accounts(>=1.8.1) because of incorrect assembly reference. The module Az.RecoveryServices needs to be upgraded to 2.11.0 or newer if you are using the latest Az or Az.Accounts. + +## RELATED LINKS + +[Get-AzRecoveryServicesVaultSettingsFile](./Get-AzRecoveryServicesVaultSettingsFile.md) + +[New-AzRecoveryServicesVault](./New-AzRecoveryServicesVault.md) + +[Remove-AzRecoveryServicesVault](./Remove-AzRecoveryServicesVault.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesVaultProperty.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesVaultProperty.md new file mode 100644 index 0000000000..5d6f815235 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesVaultProperty.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: C2A7F37B-5713-4430-B83F-C6745692396D +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesvaultproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesVaultProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesVaultProperty.md +--- + +# Get-AzRecoveryServicesVaultProperty + +## SYNOPSIS +Returns the properties of a Recovery Services Vault. + +## SYNTAX + +``` +Get-AzRecoveryServicesVaultProperty [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesVaultProperty** cmdlet returns the properties of a Recovery services vault. + +## EXAMPLES + +### Example 1: Get Properties of a vault +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$vaultProperty = Get-AzRecoveryServicesVaultProperty -VaultId $vault.Id +$vaultProperty.encryptionProperties +``` + +The first command gets a Vault object and then stores it in the $vault variable. +The second command Gets the Vault Properties. Next we access the encryptionProperties of the vault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.RecoveryServices.Backup.Models.BackupResourceVaultConfigResource + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesVault](./Get-AzRecoveryServicesVault.md) + +[Set-AzRecoveryServicesVaultProperty](./Set-AzRecoveryServicesVaultProperty.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesVaultSettingsFile.md b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesVaultSettingsFile.md new file mode 100644 index 0000000000..7f7db6a24e --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Get-AzRecoveryServicesVaultSettingsFile.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 56074606-28A6-4F91-A56C-4C8A9A31543F +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/get-azrecoveryservicesvaultsettingsfile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesVaultSettingsFile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesVaultSettingsFile.md +--- + +# Get-AzRecoveryServicesVaultSettingsFile + +## SYNOPSIS +Gets the Azure Site Recovery vault settings file. + +## SYNTAX + +### ForSiteWithCertificate +``` +Get-AzRecoveryServicesVaultSettingsFile [-Vault] <ARSVault> [[-Path] <String>] -SiteIdentifier <String> + [-Certificate <String>] -SiteFriendlyName <String> [-SiteRecovery] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByDefaultWithCertificate +``` +Get-AzRecoveryServicesVaultSettingsFile [-Vault] <ARSVault> [[-Path] <String>] [-Certificate <String>] + [-SiteRecovery] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ForBackupVaultTypeWithCertificate +``` +Get-AzRecoveryServicesVaultSettingsFile [-Vault] <ARSVault> [[-Path] <String>] [-Certificate <String>] + [-Backup] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRecoveryServicesVaultSettingsFile** cmdlet gets the settings file for an Azure Site Recovery vault. + +## EXAMPLES + +### Example 1: Register a Windows Server or DPM machine for Azure Backup +```powershell +$Vault01 = Get-AzRecoveryServicesVault -Name "TestVault" +$CredsPath = "C:\Downloads" +$Credsfilename = Get-AzRecoveryServicesVaultSettingsFile -Backup -Vault $Vault01 -Path $CredsPath +``` + +The first command gets the vault named TestVault, and then stores it in the $Vault01 variable. +The second command sets the $CredsPath variable to C:\Downloads. +The last command gets the vault credentials file for $Vault01 using the credentials in $CredsPath for Azure Backup. + +### Example 2 +```powershell +$Credsfilename = Get-AzRecoveryServicesVaultSettingsFile -SiteRecovery -Vault $Vault01 +``` + +The command gets the vault credentials file for $Vault01 of vault type siteRecovery. + +## PARAMETERS + +### -Backup +Indicates the vault credentials file is applicable to Azure Backup. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ForBackupVaultTypeWithCertificate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Certificate +{{Fill Certificate Description}} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the path to the Azure Site Recovery vault settings file. +You can download this file from the Azure Site Recovery vault portal and store it locally. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteFriendlyName +Specifies the site friendly name. +Use this parameter if you are downloading the vault credentials for a Hyper-V site. + +```yaml +Type: System.String +Parameter Sets: ForSiteWithCertificate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteIdentifier +Specifies the site identifier. +Use this parameter if you are downloading the vault credentials for a Hyper-V site. + +```yaml +Type: System.String +Parameter Sets: ForSiteWithCertificate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteRecovery +Indicates the vault credentials file is applicable to Azure Site Recovery. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ForSiteWithCertificate, ByDefaultWithCertificate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vault +Specifies the Azure Site Recovery vault object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.ARSVault + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.VaultSettingsFilePath + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesVault](./Get-AzRecoveryServicesVault.md) + +[New-AzRecoveryServicesVault](./New-AzRecoveryServicesVault.md) + +[Remove-AzRecoveryServicesVault](./Remove-AzRecoveryServicesVault.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Import-AzRecoveryServicesAsrVaultSettingsFile.md b/azps-10.1.0/Az.RecoveryServices/Import-AzRecoveryServicesAsrVaultSettingsFile.md new file mode 100644 index 0000000000..c6e3d1befe --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Import-AzRecoveryServicesAsrVaultSettingsFile.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/import-azrecoveryservicesasrvaultsettingsfile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Import-AzRecoveryServicesAsrVaultSettingsFile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Import-AzRecoveryServicesAsrVaultSettingsFile.md +--- + +# Import-AzRecoveryServicesAsrVaultSettingsFile + +## SYNOPSIS +Imports the specified ASR vault settings file to set the vault context(PowerShell session context) for subsequent ASR operations in the PowerShell session. + +## SYNTAX + +``` +Import-AzRecoveryServicesAsrVaultSettingsFile [-Path] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Import-AzRecoveryServicesAsrVaultSettingsFile** cmdlet imports the Azure Site Recovery vault settings file. The vault settings file is used to set the vault context for subsequent Azure Site Recovery operations in the current session. + +## EXAMPLES + +### Example 1 +```powershell +$VaultSettings = Import-AzRecoveryServicesAsrVaultSettingsFile -Path $FilePath +``` + +Imports the specified Recovery Services vault settings file and returns settings of the imported vault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the folder path of the ASR vault settings file. +This file can be downloaded from the Recovery Services vault portal and stored locally. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVaultSettings + +## NOTES + +## RELATED LINKS + +[Azure Recovery Services cmdlets](/powershell/module/az.recoveryservices) diff --git a/azps-10.1.0/Az.RecoveryServices/Initialize-AzRecoveryServicesBackupProtectableItem.md b/azps-10.1.0/Az.RecoveryServices/Initialize-AzRecoveryServicesBackupProtectableItem.md new file mode 100644 index 0000000000..53c4a9c32a --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Initialize-AzRecoveryServicesBackupProtectableItem.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/initialize-azrecoveryservicesbackupprotectableitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Initialize-AzRecoveryServicesBackupProtectableItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Initialize-AzRecoveryServicesBackupProtectableItem.md +--- + +# Initialize-AzRecoveryServicesBackupProtectableItem + +## SYNOPSIS +This command triggers the discovery of any unprotected items of the given workload type in the given container. If the DB application is not auto-protected use this command to discover new DBs whenever they are added and proceed to protect them. + +## SYNTAX + +``` +Initialize-AzRecoveryServicesBackupProtectableItem [-Container] <ContainerBase> [-WorkloadType] <WorkloadType> + [-PassThru] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +the cmdlet enquires for specific workloads within a container. This triggers an operation which creates protectable items. + +## EXAMPLES + +### Example 1 +```powershell +Initialize-AzRecoveryServicesBackupProtectableItem -Container $Container -WorkloadType "MSSQL" +``` + +The cmdlet executes a discovery operation for new protectable items. + +### Example 2 + +This command triggers the discovery of any unprotected items of the given workload type in the given container. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Initialize-AzRecoveryServicesBackupProtectableItem -Container $Cont[0] -VaultId $vault.ID -WorkloadType AzureVM +``` + +## PARAMETERS + +### -Container +Container where the item resides + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns the container where the discovery is being triggered. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkloadType +Workload type of the resource. The current supported values are AzureVM, WindowsServer, AzureFiles, MSSQL + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType +Parameter Sets: (All) +Aliases: +Accepted values: AzureVM, WindowsServer, AzureFiles, MSSQL + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase +System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Initialize-AzRecoveryServicesDSMove.md b/azps-10.1.0/Az.RecoveryServices/Initialize-AzRecoveryServicesDSMove.md new file mode 100644 index 0000000000..c0667fcbda --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Initialize-AzRecoveryServicesDSMove.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/initialize-azrecoveryservicesdsmove +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Initialize-AzRecoveryServicesDSMove.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Initialize-AzRecoveryServicesDSMove.md +--- + +# Initialize-AzRecoveryServicesDSMove + +## SYNOPSIS +Initializes DS move for Copy-AzRecoveryServicesVault. + +## SYNTAX + +``` +Initialize-AzRecoveryServicesDSMove [-DefaultProfile <IAzureContextContainer>] [-SourceVault] <ARSVault> + [-TargetVault] <ARSVault> [-RetryOnlyFailed] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Initializes DS move for Copy-AzRecoveryServicesVault. It is mandatory to run Test-AzRecoveryServicesDSMove +cmdlet before this cmdlet. This cmdlet generates a Correlation Id which can be used as Input to +Copy-AzRecoveryServicesVault cmdlet. This cmdlet is useful for cross tenant DS move scenario. + +## EXAMPLES + +### Example 1: Initialize DS Move for cross subscription copy +```powershell +Set-AzContext -SubscriptionName $targetSubscription +$validated = Test-AzRecoveryServicesDSMove -SourceVault $srcVault -TargetVault $trgVault -Force +Set-AzContext -SubscriptionName $sourceSubscription +if($validated) { + $corr = Initialize-AzRecoveryServicesDSMove -SourceVault $srcVault -TargetVault $trgVault + } +``` + +First cmdlet sets target subscription context. +Second cmdlet triggers some mandatory validations on target vault. +Third cmdlet sets source subscription context. +Then based on Test-AzRecoveryServicesDSMove cmdlet state, we fetch CorrelationId using +Initialize-AzRecoveryServicesDSMove cmdlet. $corr can be input to the Copy cmdlet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetryOnlyFailed +Switch parameter to try data move only for containers in the source vault which are not yet moved. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceVault +The source vault object to trigger data move. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TargetVault +The target vault object where the data has to be moved. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.ARSVault + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Move-AzRecoveryServicesBackupRecoveryPoint.md b/azps-10.1.0/Az.RecoveryServices/Move-AzRecoveryServicesBackupRecoveryPoint.md new file mode 100644 index 0000000000..901ef633d6 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Move-AzRecoveryServicesBackupRecoveryPoint.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/move-azrecoveryservicesbackuprecoverypoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Move-AzRecoveryServicesBackupRecoveryPoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Move-AzRecoveryServicesBackupRecoveryPoint.md +--- + +# Move-AzRecoveryServicesBackupRecoveryPoint + +## SYNOPSIS +Moves the recovery point from source tier to destination tier. + +## SYNTAX + +``` +Move-AzRecoveryServicesBackupRecoveryPoint [-RecoveryPoint] <RecoveryPointBase> + [-SourceTier] <RecoveryPointTier> [-DestinationTier] <RecoveryPointTier> [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Move-AzRecoveryServicesBackupRecoveryPoint** cmdlet moves the recovery point from source tier to destination tier. +Currently only valid Source tier is VaultStandard, only valid destination tier is VaultArchive. + +## EXAMPLES + +### Example 1: Move recovery point from VaultStandard tier to VaultArchive tier + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$item = Get-AzRecoveryServicesBackupItem -BackupManagementType "AzureVM" -WorkloadType "AzureVM" -VaultId $vault.ID +$startDate = (Get-Date).AddDays(-7) +$endDate = Get-Date +$rp = Get-AzRecoveryServicesBackupRecoveryPoint -Item $item[3] -StartDate $startDate.ToUniversalTime() -EndDate $endDate.ToUniversalTime() -VaultId $vault.ID -Tier VaultStandard +Move-AzRecoveryServicesBackupRecoveryPoint -RecoveryPoint $rp[2] -SourceTier VaultStandard -DestinationTier VaultArchive -VaultId $vault.ID +``` + +First we get the recovery services vault, backup items list. Then, we fetch the recovery points for a particular backup item ($item[3] in this case) which are in +VaultStandard tier. Then we trigger move for one of the recovery points from the rp list to VaultArchive tier. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationTier +Destination Tier for Recovery Point move. +Currently the only acceptable value is 'VaultArchive' + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointTier +Parameter Sets: (All) +Aliases: +Accepted values: VaultArchive + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPoint +Recovery Point to move to archive + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SourceTier +Source Tier for Recovery Point move. +Currently the only acceptable value is 'VaultStandard' + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointTier +Parameter Sets: (All) +Aliases: +Accepted values: VaultStandard + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig.md new file mode 100644 index 0000000000..84601986ca --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig.md @@ -0,0 +1,359 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesasrazuretoazurediskreplicationconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig.md +--- + +# New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig + +## SYNOPSIS +Creates a disk mapping object for Azure virtual machine disks to be replicated. + +## SYNTAX + +### AzureToAzure (Default) +``` +New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig -VhdUri <String> -LogStorageAccountId <String> + -RecoveryAzureStorageAccountId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AzureToAzureManagedDisk +``` +New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig [-ManagedDisk] -LogStorageAccountId <String> + -DiskId <String> -RecoveryResourceGroupId <String> -RecoveryReplicaDiskAccountType <String> + -RecoveryTargetDiskAccountType <String> [-RecoveryDiskEncryptionSetId <String>] + [-DiskEncryptionVaultId <String>] [-DiskEncryptionSecretUrl <String>] [-KeyEncryptionKeyUrl <String>] + [-KeyEncryptionVaultId <String>] [-FailoverDiskName <String>] [-TfoDiskName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a disk mapping object that maps an Azure virtual machine disk to the cache storage account and target storage account (recovery region) to be used to replicate the disk. + +## EXAMPLES + +### Example 1 +```powershell +New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig -VhdUri $vhdUri -RecoveryAzureStorageAccountId $recoveryStorageAccountId -LogStorageAccountId $logStorageAccountId +``` + +Create a disk mapping object for Azure virtual machine disks to be replicated.Used during Azure to Azure EnableDr and re-protect operation. + +### Example 2 +```powershell +New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig -ManagedDisk -LogStorageAccountId $logStorageAccountId -DiskId $diskId -RecoveryResourceGroupId $RecoveryResourceGroupId ` +-RecoveryReplicaDiskAccountType $RecoveryReplicaDiskAccountType -RecoveryTargetDiskAccountType $RecoveryTargetDiskAccountType +``` + +Create a managed disk mapping object for Azure virtual machine disks to be replicated.Used during Azure to Azure EnableDr and re-protect operation. + +### Example 3 +```powershell +New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig -ManagedDisk -LogStorageAccountId $logStorageAccountId -DiskId $diskId -RecoveryResourceGroupId $RecoveryResourceGroupId ` +-RecoveryReplicaDiskAccountType $RecoveryReplicaDiskAccountType -RecoveryTargetDiskAccountType $RecoveryTargetDiskAccountType -DiskEncryptionVaultId $keyVaultId -DiskEncryptionSecretUrl $secret ` +-KeyEncryptionKeyUrl $keyUrl -KeyEncryptionVaultId $keyVaultId +``` + +Create a managed disk mapping object with one pass encryption settings for Azure virtual machine disks to be replicated.Used during Azure to Azure EnableDr and re-protect operation. + +### Example 4 +```powershell +New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig -ManagedDisk -LogStorageAccountId $logStorageAccountId -DiskId $diskId -RecoveryResourceGroupId $RecoveryResourceGroupId ` +-RecoveryReplicaDiskAccountType $RecoveryReplicaDiskAccountType -RecoveryTargetDiskAccountType $RecoveryTargetDiskAccountType -RecoveryDiskEncryptionSetId $RecoveryDiskEncryptionSetId +``` + +Create a managed disk mapping object with target disk encryption set Id, for Azure virtual machine disks to be replicated.Used during Azure to Azure EnableDr and re-protect operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSecretUrl +Specifies the disk encryption secret url. + +```yaml +Type: System.String +Parameter Sets: AzureToAzureManagedDisk +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionVaultId +Specifies the disk encryption key vault ARM Id. + +```yaml +Type: System.String +Parameter Sets: AzureToAzureManagedDisk +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskId +Specifies the disk id of managed disk. + +```yaml +Type: System.String +Parameter Sets: AzureToAzureManagedDisk +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverDiskName +Specifies the name of the disk created during failover. + +```yaml +Type: System.String +Parameter Sets: AzureToAzureManagedDisk +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyUrl +Specifies the key encryption Url. + +```yaml +Type: System.String +Parameter Sets: AzureToAzureManagedDisk +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionVaultId +Specifies the key encryption key vault ARM Id. + +```yaml +Type: System.String +Parameter Sets: AzureToAzureManagedDisk +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogStorageAccountId +Specifies the log or cache storage account Id to be used to store replication logs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedDisk +Specifies the input is for managed disk. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureToAzureManagedDisk +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryAzureStorageAccountId +Specifies the ID of the Azure storage account to replicate to. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryDiskEncryptionSetId +Specifies the ID of the Azure disk encryption set to be used for recovery disks. + +```yaml +Type: System.String +Parameter Sets: AzureToAzureManagedDisk +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryReplicaDiskAccountType +Specifies the account type of replicated managed disk. + +```yaml +Type: System.String +Parameter Sets: AzureToAzureManagedDisk +Aliases: +Accepted values: Premium_LRS, Premium_ZRS, Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryResourceGroupId +Specifies the recovery resource group id for replicated managed disk. + +```yaml +Type: System.String +Parameter Sets: AzureToAzureManagedDisk +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryTargetDiskAccountType +Specifies the recovery target disk for replicated managed disk. + +```yaml +Type: System.String +Parameter Sets: AzureToAzureManagedDisk +Aliases: +Accepted values: Premium_LRS, Premium_ZRS, Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TfoDiskName +Specifies the name of the disk created during test failover. + +```yaml +Type: System.String +Parameter Sets: AzureToAzureManagedDisk +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VhdUri +Specify the VHD URI of the disk that this mapping corresponds to. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRAzuretoAzureDiskReplicationConfig + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrFabric.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrFabric.md new file mode 100644 index 0000000000..2a81335daa --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrFabric.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesasrfabric +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrFabric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrFabric.md +--- + +# New-AzRecoveryServicesAsrFabric + +## SYNOPSIS +Creates an Azure Site Recovery Fabric. + +## SYNTAX + +### Default (Default) +``` +New-AzRecoveryServicesAsrFabric -Name <String> [-Type <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Azure +``` +New-AzRecoveryServicesAsrFabric [-Azure] -Name <String> -Location <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRecoveryServicesAsrFabric** cmdlet creates an Azure Site Recovery Fabric of the specified type. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = New-AzRecoveryServicesAsrFabric -Name $FabricName +``` + +Starts the fabric creation with passed name and returns the ASR job used to track the fabric creation operation. + +### Example 2 +```powershell +$currentJob = New-AzRecoveryServicesAsrFabric -Azure -Name $fabricName -Location "eastus" +Get-AzRecoveryServicesAsrJob -name $currentJob.id +``` + +Starts the azure fabric creation with passed name and returns the ASR job used to track the fabric creation operation. + +## PARAMETERS + +### -Azure +Switch parameter specifies to create azure fabric. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Azure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the Azure region corresponding to the Fabric object being created. The Azure Site Recovery fabric object represents a region. For virtual machines being replicated between two Azure regions a primary fabric represents the primary Azure region and the recovery fabric . + +```yaml +Type: System.String +Parameter Sets: Azure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Azure Site Recovery Fabric. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specifies the Azure Site Recovery Fabric Type. + +```yaml +Type: System.String +Parameter Sets: Default +Aliases: +Accepted values: HyperVSite + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrFabric](./Get-AzRecoveryServicesAsrFabric.md) + +[Remove-AzRecoveryServicesAsrFabric](./Remove-AzRecoveryServicesAsrFabric.md) diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrInMageAzureV2DiskInput.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrInMageAzureV2DiskInput.md new file mode 100644 index 0000000000..22657736b7 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrInMageAzureV2DiskInput.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesasrinmageazurev2diskinput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrInMageAzureV2DiskInput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrInMageAzureV2DiskInput.md +--- + +# New-AzRecoveryServicesAsrInMageAzureV2DiskInput + +## SYNOPSIS +Creates a disk mapping object for vMWare virtual machine disks to be replicated. + +## SYNTAX + +``` +New-AzRecoveryServicesAsrInMageAzureV2DiskInput -DiskId <String> -LogStorageAccountId <String> + -DiskType <String> [-DiskEncryptionSetId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a disk mapping object that maps an vMWare virtual machine disk to the cache storage account and target managed disk type (recovery region) to be used to replicate the disk. + +## EXAMPLES + +### Example 1 +```powershell +New-AzRecoveryServicesAsrInMageAzureV2DiskInput -DiskId $diskId -LogStorageAccountId $logStorageAccountId -DiskType $diskType +``` + +Create a disk mapping object for vMWare virtual machine disks to be replicated.Used during enable protection for vMWare machine. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of the disk encryption set, to be used for the encryption of the managed disks. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskId +Specify the DiskId of the disk that this mapping corresponds to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskType +Specifies the Recovery disk type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogStorageAccountId +Specifies the log or cache storage account Id to be used to store replication logs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.AsrInMageAzureV2DiskInput + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrInMageRcmDiskInput.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrInMageRcmDiskInput.md new file mode 100644 index 0000000000..ac00066f16 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrInMageRcmDiskInput.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesasrinmagercmdiskinput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrInMageRcmDiskInput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrInMageRcmDiskInput.md +--- + +# New-AzRecoveryServicesAsrInMageRcmDiskInput + +## SYNOPSIS +Creates Azure Site Recovery Disk replication configuration for VMware To Azure replication. + +## SYNTAX + +``` +New-AzRecoveryServicesAsrInMageRcmDiskInput -DiskId <String> -LogStorageAccountId <String> -DiskType <String> + [-DiskEncryptionSetId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a disk mapping object that maps an VMware virtual machine disk to the cache storage account and target managed disk type (recovery region) to be used to replicate the disk. + +## EXAMPLES + +### Example 1 +```powershell +New-AzRecoveryServicesAsrInMageRcmDiskInput -DiskId $diskId -LogStorageAccountId $logStorageAccountId -DiskType $diskType -DiskEncryptionSetId $diskEncryptionSetId +``` + +```output +DiskId : 6000C296-91a1-f649-6714-a02903020cbc +LogStorageAccountId : /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxx/providers/Microsoft.Storage/storageAccounts/xxxxxxxxxxxx +DiskType : Standard_LRS +DiskEncryptionSetId : 8010C296-91a1-a639-6714-a02903020cbc +``` + +Create a disk mapping object for VMware virtual machine disks to be replicated. Used during enable protection for VMware machine. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the disk encryption set ARM Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskId +Specify the DiskId of the disk that this mapping corresponds to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskType +Specifies the Recovery disk type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Standard_LRS, Premium_LRS, StandardSSD_LRS + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogStorageAccountId +Specifies the log or cache storage account Id to be used to store replication logs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRInMageRcmDiskInput + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrNetworkMapping.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrNetworkMapping.md new file mode 100644 index 0000000000..5294739b02 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrNetworkMapping.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesasrnetworkmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrNetworkMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrNetworkMapping.md +--- + +# New-AzRecoveryServicesAsrNetworkMapping + +## SYNOPSIS +Creates an ASR network mapping between two networks. + +## SYNTAX + +### EnterpriseToEnterprise (Default) +``` +New-AzRecoveryServicesAsrNetworkMapping -Name <String> -PrimaryNetwork <ASRNetwork> + -RecoveryNetwork <ASRNetwork> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AzureToAzure +``` +New-AzRecoveryServicesAsrNetworkMapping [-AzureToAzure] -Name <String> -PrimaryFabric <ASRFabric> + -PrimaryAzureNetworkId <String> -RecoveryFabric <ASRFabric> -RecoveryAzureNetworkId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EnterpriseToAzure +``` +New-AzRecoveryServicesAsrNetworkMapping -Name <String> -PrimaryNetwork <ASRNetwork> + -RecoveryAzureNetworkId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRecoveryServicesAsrNetworkMapping** cmdlet starts the operation of creating an ASR network mapping between two networks and returns the ASR job object for the ASR job used to track the operation. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = New-AzRecoveryServicesAsrNetworkMapping -Name $NetworkMapName -PrimaryNetwork $PrimaryNetwork -RecoveryNetwork $RecoveryNetwork +``` + +Starts the network mapping creation operation using the specified name, primary and recovery networks, and returns an ASR job to track the operation. + +### Example 2 +```powershell +$currentJob = New-AzRecoveryServicesAsrNetworkMapping -AzureToAzure -Name "mappingName" -PrimaryFabric $AzureFabric ` + -PrimaryAzureNetworkId $AzureNetworkId -RecoveryFabric $RecoveryAzureFabric -RecoveryAzureNetworkId $RecoveryNetworkId +``` + +Starts the network mapping for creation operation using the specified name, primary and recovery networks, and returns an ASR job to track the operation(Azure to Azure scenario). + +## PARAMETERS + +### -AzureToAzure +Flag to create AzureToAzure scenario. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the ASR network mapping to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryAzureNetworkId +Specifies the Azure virtual network ID of the primary network for the mapping. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryFabric +Specifies the ASR fabric where mapping should be created. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: AzureToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryNetwork +Specifies the primary network object for the ASR network mapping. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork +Parameter Sets: EnterpriseToEnterprise, EnterpriseToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RecoveryAzureNetworkId +Specifies the recovery azure network ID for the network mapping. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, EnterpriseToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryFabric +The Azure Site Recovery fabric object corresponding to the recovery Azure region. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: AzureToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryNetwork +Specifies the recovery network object for the ASR network mapping. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork +Parameter Sets: EnterpriseToEnterprise +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrNetworkMapping](./Get-AzRecoveryServicesAsrNetworkMapping.md) + +[Remove-AzRecoveryServicesAsrNetworkMapping](./Remove-AzRecoveryServicesAsrNetworkMapping.md) diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrPolicy.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrPolicy.md new file mode 100644 index 0000000000..855bad639b --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrPolicy.md @@ -0,0 +1,514 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesasrpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrPolicy.md +--- + +# New-AzRecoveryServicesAsrPolicy + +## SYNOPSIS +Creates an Azure Site Recovery replication policy. + +## SYNTAX + +### HyperVToAzure (Default) +``` +New-AzRecoveryServicesAsrPolicy [-HyperVToAzure] -Name <String> -ReplicationProvider <String> + -ReplicationFrequencyInSeconds <String> [-NumberOfRecoveryPointsToRetain <Int32>] + [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-ReplicationStartTime <TimeSpan>] + [-RecoveryAzureStorageAccountId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### VMwareToAzure +``` +New-AzRecoveryServicesAsrPolicy [-VMwareToAzure] -Name <String> -RecoveryPointRetentionInHours <Int32> + [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-MultiVmSyncStatus <String>] + -RPOWarningThresholdInMinutes <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AzureToVMware +``` +New-AzRecoveryServicesAsrPolicy [-AzureToVMware] -Name <String> -RecoveryPointRetentionInHours <Int32> + [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-MultiVmSyncStatus <String>] + -RPOWarningThresholdInMinutes <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AzureToAzure +``` +New-AzRecoveryServicesAsrPolicy [-AzureToAzure] -Name <String> -RecoveryPointRetentionInHours <Int32> + [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-MultiVmSyncStatus <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EnterpriseToEnterprise +``` +New-AzRecoveryServicesAsrPolicy [-VmmToVmm] -Name <String> -ReplicationProvider <String> + [-ReplicationMethod <String>] -ReplicationFrequencyInSeconds <String> + [-NumberOfRecoveryPointsToRetain <Int32>] [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] + [-Compression <String>] -ReplicationPort <UInt16> [-Authentication <String>] + [-ReplicationStartTime <TimeSpan>] [-ReplicaDeletion <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ReplicateVMwareToAzure +``` +New-AzRecoveryServicesAsrPolicy [-ReplicateVMwareToAzure] -Name <String> -RecoveryPointRetentionInHours <Int32> + [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-MultiVmSyncStatus <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRecoveryServicesAsrPolicy** cmdlet creates an Azure Site Recovery replication policy. +The replication policy is used to specify replication settings such as the replication frequency and number of recovery points. + +## EXAMPLES + +### Example 1 +```powershell +New-AzRecoveryServicesAsrPolicy -Name "abc" -ReplicationProvider HyperVReplicaAzure -ReplicationFrequencyInSeconds 30 -NumberOfRecoveryPointsToRetain 10 +``` + +Starts the replication policy creation operation using the specified parameters and returns the ASR job used to track the operation. + +### Example 2 +```powershell +New-AzRecoveryServicesAsrPolicy -Name "abc122" -ReplicationProvider HyperVReplica2012R2 -ReplicationFrequencyInSeconds 300 -ReplicationPort 211 +``` + +```output +Name : 1c609a5b-324e-461c-866f-ad58f944df25 +ID : /Subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxxxxx/replicationJobs/1c609a5b-324e-461c-866f-ad58f944df25 +Type : +JobType : AddProtectionProfile +DisplayName : Create replication policy +ClientRequestId : b10c83ee-fee2-42d4-ad1d-dfc3e166faab ActivityId: 67e8453c-fae0-465f-801c-dfa2e6e6ee23 +State : Succeeded +StateDescription : Completed +StartTime : 8/29/2017 10:18:10 AM +EndTime : 8/29/2017 10:18:11 AM +TargetObjectId : bb8e8c57-221d-5668-9d82-b15a3e19a6a3 +TargetObjectType : ProtectionProfile +TargetObjectName : abc122 +AllowedActions : +Tasks : {Prerequisites check for creating the replication policy, Creating the replication policy} +Errors : {} +``` + +Starts the replication policy creation operation using the specified parameters and returns the ASR job used to track the operation. + +### Example 3 +```powershell +$Job = New-AzRecoveryServicesAsrPolicy -Name $TestPolicy1 -AzureToAzure -RecoveryPointRetentionInHours 10 -ApplicationConsistentSnapshotFrequencyInHours 5 +Get-AzRecoveryServicesAsrJob -name $Job.id +``` + +Starts the replication policy creation operation using the specified parameters and returns the ASR job used to track the operation. + +## PARAMETERS + +### -ApplicationConsistentSnapshotFrequencyInHours +Specifies the frequency(in hours) at which to create application consistent recovery points. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authentication +Specifies the type of authentication used. +Valid values are: + +- Certificate +- Kerberos + +```yaml +Type: System.String +Parameter Sets: EnterpriseToEnterprise +Aliases: +Accepted values: Certificate, Kerberos + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureToAzure +Switch parameter specifies the scenario for azure to azure policy creation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureToVMware +Switch parameter specifies the scenario for azure to vMWare policy creation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureToVMware +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compression +Specifies if compression should be enabled. + +```yaml +Type: System.String +Parameter Sets: EnterpriseToEnterprise +Aliases: +Accepted values: Enable, Disable + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HyperVToAzure +Switch parameter to specify policy is to be used to replicate Hyper-V virtual machines to Azure + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: HyperVToAzure +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiVmSyncStatus +Specifies multiVm sync status for the policy. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzure, AzureToVMware, AzureToAzure, ReplicateVMwareToAzure +Aliases: +Accepted values: Enable, Disable + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the ASR replication policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfRecoveryPointsToRetain +Specifies the number recovery points to retain. + +```yaml +Type: System.Int32 +Parameter Sets: HyperVToAzure, EnterpriseToEnterprise +Aliases: RecoveryPoints + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryAzureStorageAccountId +Specifies the ID of the Azure storage account to replicate to. + +```yaml +Type: System.String +Parameter Sets: HyperVToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPointRetentionInHours +Retain the recovery points for given time in hours. + +```yaml +Type: System.Int32 +Parameter Sets: VMwareToAzure, AzureToVMware, AzureToAzure, ReplicateVMwareToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaDeletion +Specifies if the replica virtual machine should be deleted on disabling replication from a VMM managed site to another. + +```yaml +Type: System.String +Parameter Sets: EnterpriseToEnterprise +Aliases: +Accepted values: Required, NotRequired + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicateVMwareToAzure +Switch parameter specifying VMware to Azure replication scenario. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ReplicateVMwareToAzure +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationFrequencyInSeconds +Specifies the replication frequency interval in seconds. +Valid values are: + +- 30 +- 300 +- 900 + +```yaml +Type: System.String +Parameter Sets: HyperVToAzure, EnterpriseToEnterprise +Aliases: +Accepted values: 30, 300, 900 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationMethod +Specifies the replication method. +Valid values are: + +- Online +- Offline + +```yaml +Type: System.String +Parameter Sets: EnterpriseToEnterprise +Aliases: +Accepted values: Online, Offline + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationPort +Specifies the port used for replication. + +```yaml +Type: System.UInt16 +Parameter Sets: EnterpriseToEnterprise +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationProvider +Specifies the replication provider for the policy. + +```yaml +Type: System.String +Parameter Sets: HyperVToAzure, EnterpriseToEnterprise +Aliases: +Accepted values: HyperVReplica2012R2, HyperVReplica2012, HyperVReplicaAzure + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationStartTime +Specifies the replication start time. +It must be no later than 24-hours from the start of the job. + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: HyperVToAzure, EnterpriseToEnterprise +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RPOWarningThresholdInMinutes +The RPO threshold value in minutes to warn on. + +```yaml +Type: System.Int32 +Parameter Sets: VMwareToAzure, AzureToVMware +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmmToVmm +Switch parameter to specify policy is to be used to replicate between Hyper-V sites managed by a VMM server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EnterpriseToEnterprise +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMwareToAzure +Switch parameter specifying that the replication policy being created will be used to replicate VMware virtual machines and/or Physical servers to Azure. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: VMwareToAzure +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrPolicy](./Get-AzRecoveryServicesAsrPolicy.md) + +[Remove-AzRecoveryServicesAsrPolicy](./Remove-AzRecoveryServicesAsrPolicy.md) diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrProtectableItem.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrProtectableItem.md new file mode 100644 index 0000000000..888bb3f623 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrProtectableItem.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesasrprotectableitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrProtectableItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrProtectableItem.md +--- + +# New-AzRecoveryServicesAsrProtectableItem + +## SYNOPSIS +Add(Discover) a physical server to the list of protectable items. + +## SYNTAX + +``` +New-AzRecoveryServicesAsrProtectableItem -ProtectionContainer <ASRProtectionContainer> -FriendlyName <String> + -IPAddress <String> -OSType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRecoveryServicesAsrProtectableItem** adds a new protectable item to the list of discovered protectable items in a protection container within an ASR fabric (applicable only for the VMware fabric type). + +## EXAMPLES + +### Example 1 + +Add(Discover) a physical server to the list of protectable items. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +New-AzRecoveryServicesAsrProtectableItem -FriendlyName XXXXXXXXXX -IPAddress $ipaddresss -OSType Windows -ProtectionContainer $pc +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName +Friendly name for the protectable item. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddress +IP address of the protectable item. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSType +Operating System type (Windows/Linux) of the protectable item. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Windows, Linux + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionContainer +ASR Protection container object to which the protectable item should be added. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompt for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrProtectionContainer.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrProtectionContainer.md new file mode 100644 index 0000000000..c4443f5de6 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrProtectionContainer.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesasrprotectioncontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrProtectionContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrProtectionContainer.md +--- + +# New-AzRecoveryServicesAsrProtectionContainer + +## SYNOPSIS +Creates an Azure Site Recovery Protection Container within the specified fabric. + +## SYNTAX + +``` +New-AzRecoveryServicesAsrProtectionContainer -Name <String> -InputObject <ASRFabric> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzRecoveryServicesAsrProtectionContainer cmdlet creates a Protection Container under the specified Azure Site Recovery Fabric. + +## EXAMPLES + +### Example 1 +```powershell +$job = New-AzRecoveryServicesAsrProtectionContainer -Name xyz -Fabric $fabric +Get-AzRecoveryServicesAsrJob -name $job.id +``` + +Starts the creation of the protection container with the specified parameters, and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Creates the replication protection container in specified input Object (Azure Fabric). + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: (All) +Aliases: Fabric + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the protection container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrProtectionContainerMapping.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrProtectionContainerMapping.md new file mode 100644 index 0000000000..ff89915d4b --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrProtectionContainerMapping.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesasrprotectioncontainermapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrProtectionContainerMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrProtectionContainerMapping.md +--- + +# New-AzRecoveryServicesAsrProtectionContainerMapping + +## SYNOPSIS +Creates an Azure Site Recovery Protection Container mapping by associating the specified replication policy to the specified ASR protection container. + +## SYNTAX + +### EnterpriseToAzure (Default) +``` +New-AzRecoveryServicesAsrProtectionContainerMapping -Name <String> -Policy <ASRPolicy> + -PrimaryProtectionContainer <ASRProtectionContainer> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### EnterpriseToEnterprise +``` +New-AzRecoveryServicesAsrProtectionContainerMapping -Name <String> -Policy <ASRPolicy> + -PrimaryProtectionContainer <ASRProtectionContainer> -RecoveryProtectionContainer <ASRProtectionContainer> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRecoveryServicesAsrProtectionContainerMapping** cmdlet creates an Azure Site Recovery Protection Container mapping by associating the specified replication policy to the specified protection container. + +## EXAMPLES + +### Example 1 +```powershell +New-AzRecoveryServicesAsrProtectionContainerMapping -Name $ContainerMappingName -Policy $ProtectionProfile -PrimaryProtectionContainer $PrimaryContainer -RecoveryProtectionContainer $RecoveryContainer +``` + +```output +Name : 1f32fee1-05d0-4c11-a997-1618e14b4dab +ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/IbizaV2ATest/replicationJobs/1f32fee1-05d0-4c11-a997-1618e14b4dab +Type : +JobType : +DisplayName : +ClientRequestId : 2870d5ab-f9be-405e-87d5-5bf20387c623 ActivityId: 24b28fc5-509b-4ad3-92c0-c8bb7ced7fb6 +State : NotStarted +StateDescription : NotStarted +StartTime : +EndTime : +TargetObjectId : +TargetObjectType : +TargetObjectName : +AllowedActions : +Tasks : {} +Errors : {} +``` + +Starts the creation of the protection container mapping with the specified parameters, and returns the ASR job used to track the operation. + +### Example 2 +```powershell +New-AzRecoveryServicesAsrProtectionContainerMapping -Name $PrimaryProtectionContainerMapping -policy $Policy1 -PrimaryProtectionContainer $pc +``` + +```output +Name : 1f32fee1-05d0-4c11-a997-1618e14b4dab +ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/IbizaV2ATest/replicationJobs/1f32fee1-05d0-4c11-a997-1618e14b4dab +Type : +JobType : +DisplayName : +ClientRequestId : 2870d5ab-f9be-405e-87d5-5bf20387c623 ActivityId: 24b28fc5-509b-4ad3-92c0-c8bb7ced7fb6 +State : NotStarted +StateDescription : NotStarted +StartTime : +EndTime : +TargetObjectId : +TargetObjectType : +TargetObjectName : +AllowedActions : +Tasks : {} +Errors : {} +``` + +Starts the creation of the protection container mapping with the specified parameters, and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Protection Container mapping. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the ASR replication policy object for the replication policy to be used in the mapping. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrimaryProtectionContainer +Specifies the ASR protection container object for the primary protection container to be used in the mapping. To get the ASR protection container in the Recovery Service Container run the [Get-AzRecoveryServicesAsrProtectionContainer](/powershell/module/az.recoveryservices/get-azrecoveryservicesasrprotectioncontainer) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryProtectionContainer +Specifies the ASR protection container object for the recovery protection container to be used in the mapping (used if replicating to a recovery location that is not Azure.) + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer +Parameter Sets: EnterpriseToEnterprise +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrProtectionContainerMapping](./Get-AzRecoveryServicesAsrProtectionContainerMapping.md) + +[Remove-AzRecoveryServicesAsrProtectionContainerMapping](./Remove-AzRecoveryServicesAsrProtectionContainerMapping.md) diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrRecoveryPlan.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrRecoveryPlan.md new file mode 100644 index 0000000000..08a989ff59 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrRecoveryPlan.md @@ -0,0 +1,425 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesasrrecoveryplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrRecoveryPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrRecoveryPlan.md +--- + +# New-AzRecoveryServicesAsrRecoveryPlan + +## SYNOPSIS +Creates an ASR recovery plan. + +## SYNTAX + +### EnterpriseToEnterprise (Default) +``` +New-AzRecoveryServicesAsrRecoveryPlan -Name <String> -PrimaryFabric <ASRFabric> -RecoveryFabric <ASRFabric> + -ReplicationProtectedItem <ASRReplicationProtectedItem[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### EnterpriseToAzure +``` +New-AzRecoveryServicesAsrRecoveryPlan -Name <String> -PrimaryFabric <ASRFabric> [-Azure] + -FailoverDeploymentModel <String> -ReplicationProtectedItem <ASRReplicationProtectedItem[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureZoneToZone +``` +New-AzRecoveryServicesAsrRecoveryPlan -Name <String> -PrimaryFabric <ASRFabric> [-PrimaryZone <String>] + [-RecoveryZone <String>] [-PrimaryEdgeZone <String>] [-RecoveryEdgeZone <String>] [-AzureZoneToZone] + -ReplicationProtectedItem <ASRReplicationProtectedItem[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### EdgeZoneToAzure +``` +New-AzRecoveryServicesAsrRecoveryPlan -Name <String> -PrimaryFabric <ASRFabric> -PrimaryEdgeZone <String> + [-EdgeZoneToAzure] -ReplicationProtectedItem <ASRReplicationProtectedItem[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureToEdgeZone +``` +New-AzRecoveryServicesAsrRecoveryPlan -Name <String> -PrimaryFabric <ASRFabric> -RecoveryEdgeZone <String> + [-AzureToEdgeZone] -ReplicationProtectedItem <ASRReplicationProtectedItem[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EdgeZoneToEdgeZone +``` +New-AzRecoveryServicesAsrRecoveryPlan -Name <String> -PrimaryFabric <ASRFabric> -PrimaryEdgeZone <String> + -RecoveryEdgeZone <String> [-EdgeZoneToEdgeZone] -ReplicationProtectedItem <ASRReplicationProtectedItem[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRPFile +``` +New-AzRecoveryServicesAsrRecoveryPlan -Path <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRecoveryServicesAsrRecoveryPlan** cmdlet creates an Azure Site Recovery, recovery plan in the Recovery Services vault. + +A recovery plan gathers virtual machines belonging to an application into a unit to allow them to be recovered together. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = New-AzRecoveryServicesAsrRecoveryPlan -Name $RPName -PrimaryFabric $PrimaryFabric -RecoveryFabric $RecoveryFabric -ReplicationProtectedItem $RPI +``` + +Starts the recovery plan creation operation with the specified parameters and returns the ASR job used to track the operation. + +### Example 2 +```powershell +$currentJob = New-AzRecoveryServicesAsrRecoveryPlan -Name $RPName -PrimaryFabric $PrimaryFabric -PrimaryZone $pZone -RecoveryZone $rZone -ReplicationProtectedItem $RPI +``` + +Starts the recovery plan creation operation for Azure zone to zone replicated items and returns the ASR job used to track the operation. + +### Example 3 +```powershell +$currentJob = New-AzRecoveryServicesAsrRecoveryPlan -Name $RPName -PrimaryFabric $PrimaryFabric -PrimaryEdgeZone $pEdgeZone -RecoveryZone $rZone -ReplicationProtectedItem $RPI +``` + +Starts the recovery plan creation operation for Azure EdgeZone to Availability Zone replicated items and returns the ASR job used to track the operation. + +## PARAMETERS + +### -Azure +Switch parameter specifies the scenario for azure to azure disaster recovery, recovery plan creation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EnterpriseToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureToEdgeZone +Switch parameter specifies creating the replicated item in Azure to EdgeZone scenario. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureToEdgeZone +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureZoneToZone +Switch parameter specifies creating the replicated item in azure zone to zone scenario. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureZoneToZone +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZoneToAzure +Switch parameter specifies creating the replicated item in EdgeZone to Azure scenario. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EdgeZoneToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZoneToEdgeZone +Switch parameter specifies creating the replicated item EdgeZone to EdgeZone scenario. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EdgeZoneToEdgeZone +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverDeploymentModel +Specifies the failover deployment model (Classic or Resource Manager) of the replication protected items that will be part of this recovery plan. + +```yaml +Type: System.String +Parameter Sets: EnterpriseToAzure +Aliases: +Accepted values: Classic, ResourceManager + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the recovery plan. + +```yaml +Type: System.String +Parameter Sets: EnterpriseToEnterprise, EnterpriseToAzure, AzureZoneToZone, EdgeZoneToAzure, AzureToEdgeZone, EdgeZoneToEdgeZone +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the path to the recovery plan definition json file. A recovery plan definition json can be used to create the recovery plan. + +```yaml +Type: System.String +Parameter Sets: ByRPFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryEdgeZone +Specifies the primary edge zone of the replication protected items that will be part of this recovery plan. + +```yaml +Type: System.String +Parameter Sets: AzureZoneToZone +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: EdgeZoneToAzure, EdgeZoneToEdgeZone +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryFabric +Specifies the ASR fabric object for the primary ASR fabric of the replication protected items that will be part of this recovery plan. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: EnterpriseToEnterprise, EnterpriseToAzure, AzureZoneToZone, EdgeZoneToAzure, AzureToEdgeZone, EdgeZoneToEdgeZone +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryZone +Specifies the primary Availabilty zone of the replication protected items that will be part of this recovery plan. + +```yaml +Type: System.String +Parameter Sets: AzureZoneToZone +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryEdgeZone +Specifies the recovery edge zone of the replication protected items that will be part of this recovery plan. + +```yaml +Type: System.String +Parameter Sets: AzureZoneToZone +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: AzureToEdgeZone, EdgeZoneToEdgeZone +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryFabric +Specifies the ASR fabric object for the recovery ASR fabric of the replication protected items that will be part of this recovery plan. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: EnterpriseToEnterprise +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryZone +Specifies the primary Availabilty zone of the replication protected items that will be part of this recovery plan. + +```yaml +Type: System.String +Parameter Sets: AzureZoneToZone +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +The list of replication protected items to add to the first group of the recovery plan. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem[] +Parameter Sets: EnterpriseToEnterprise, EnterpriseToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem[] +Parameter Sets: AzureZoneToZone, EdgeZoneToAzure, AzureToEdgeZone, EdgeZoneToEdgeZone +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem[] + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrRecoveryPlan](./Get-AzRecoveryServicesAsrRecoveryPlan.md) + +[Remove-AzRecoveryServicesAsrRecoveryPlan](./Remove-AzRecoveryServicesAsrRecoveryPlan.md) + +[Update-AzRecoveryServicesAsrRecoveryPlan](./Update-AzRecoveryServicesAsrRecoveryPlan.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrReplicationProtectedItem.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrReplicationProtectedItem.md new file mode 100644 index 0000000000..54e7346f84 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrReplicationProtectedItem.md @@ -0,0 +1,1113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesasrreplicationprotecteditem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrReplicationProtectedItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrReplicationProtectedItem.md +--- + +# New-AzRecoveryServicesAsrReplicationProtectedItem + +## SYNOPSIS +Enables replication for an ASR protectable item by creating a replication protected item. + +## SYNTAX + +### EnterpriseToEnterprise (Default) +``` +New-AzRecoveryServicesAsrReplicationProtectedItem [-VmmToVmm] -ProtectableItem <ASRProtectableItem> + -Name <String> -ProtectionContainerMapping <ASRProtectionContainerMapping> + [-WaitForCompletion] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### VMwareToAzureWithDiskType +``` +New-AzRecoveryServicesAsrReplicationProtectedItem [-VMwareToAzure] -ProtectableItem <ASRProtectableItem> + -Name <String> [-RecoveryVmName <String>] -ProtectionContainerMapping <ASRProtectionContainerMapping> + -Account <ASRRunAsAccount> [-LogStorageAccountId <String>] -ProcessServer <ASRProcessServer> + [-RecoveryAzureNetworkId <String>] [-RecoveryAzureSubnetName <String>] -RecoveryResourceGroupId <String> + [-ReplicationGroupName <String>] [-RecoveryAvailabilityZone <String>] + [-RecoveryProximityPlacementGroupId <String>] [-RecoveryAvailabilitySetId <String>] [-Size <String>] + [-SqlServerLicenseType <String>] + [-RecoveryVmTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-DiskTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-RecoveryNicTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-WaitForCompletion] -DiskType <String> [-DiskEncryptionSetId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### VMwareToAzure +``` +New-AzRecoveryServicesAsrReplicationProtectedItem [-VMwareToAzure] -ProtectableItem <ASRProtectableItem> + -Name <String> [-RecoveryVmName <String>] -ProtectionContainerMapping <ASRProtectionContainerMapping> + -Account <ASRRunAsAccount> [-LogStorageAccountId <String>] + [-InMageAzureV2DiskInput <AsrInMageAzureV2DiskInput[]>] -ProcessServer <ASRProcessServer> + [-RecoveryAzureNetworkId <String>] [-RecoveryAzureSubnetName <String>] -RecoveryResourceGroupId <String> + [-ReplicationGroupName <String>] [-RecoveryAvailabilityZone <String>] + [-RecoveryProximityPlacementGroupId <String>] [-RecoveryAvailabilitySetId <String>] [-Size <String>] + [-SqlServerLicenseType <String>] + [-RecoveryVmTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-DiskTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-RecoveryNicTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-WaitForCompletion] [-DiskEncryptionSetId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EnterpriseToAzure +``` +New-AzRecoveryServicesAsrReplicationProtectedItem [-HyperVToAzure] -ProtectableItem <ASRProtectableItem> + -Name <String> [-RecoveryVmName <String>] -ProtectionContainerMapping <ASRProtectionContainerMapping> + -RecoveryAzureStorageAccountId <String> -RecoveryResourceGroupId <String> [-UseManagedDisk <String>] [-UseManagedDisksForReplication <String>] + [-WaitForCompletion] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HyperVSiteToAzure +``` +New-AzRecoveryServicesAsrReplicationProtectedItem [-HyperVToAzure] -ProtectableItem <ASRProtectableItem> + -Name <String> [-RecoveryVmName <String>] -ProtectionContainerMapping <ASRProtectionContainerMapping> + -RecoveryAzureStorageAccountId <String> -OSDiskName <String> -OS <String> [-LogStorageAccountId <String>] + [-IncludeDiskId <String[]>] [-RecoveryAzureNetworkId <String>] [-RecoveryAzureSubnetName <String>] + -RecoveryResourceGroupId <String> [-RecoveryAvailabilityZone <String>] + [-RecoveryProximityPlacementGroupId <String>] [-RecoveryAvailabilitySetId <String>] [-Size <String>] + [-SqlServerLicenseType <String>] + [-RecoveryVmTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-DiskTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-RecoveryNicTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-UseManagedDisk <String>] [-UseManagedDisksForReplication <String>] [-WaitForCompletion] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AzureToAzure +``` +New-AzRecoveryServicesAsrReplicationProtectedItem [-AzureToAzure] + -AzureToAzureDiskReplicationConfiguration <ASRAzuretoAzureDiskReplicationConfig[]> -AzureVmId <String> + -Name <String> [-RecoveryVmName <String>] -ProtectionContainerMapping <ASRProtectionContainerMapping> + [-RecoveryAzureNetworkId <String>] [-RecoveryAzureSubnetName <String>] -RecoveryResourceGroupId <String> + [-ReplicationGroupName <String>] [-RecoveryCloudServiceId <String>] [-RecoveryAvailabilityZone <String>] + [-RecoveryProximityPlacementGroupId <String>] [-RecoveryVirtualMachineScaleSetId <String>] + [-RecoveryCapacityReservationGroupId <String>] [-RecoveryAvailabilitySetId <String>] + [-RecoveryBootDiagStorageAccountId <String>] [-DiskEncryptionVaultId <String>] + [-DiskEncryptionSecretUrl <String>] [-KeyEncryptionKeyUrl <String>] [-KeyEncryptionVaultId <String>] + [-WaitForCompletion] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureToAzureWithoutDiskDetails +``` +New-AzRecoveryServicesAsrReplicationProtectedItem [-AzureToAzure] -AzureVmId <String> -Name <String> + [-RecoveryVmName <String>] -ProtectionContainerMapping <ASRProtectionContainerMapping> + [-RecoveryAzureStorageAccountId <String>] -LogStorageAccountId <String> [-RecoveryAzureNetworkId <String>] + [-RecoveryAzureSubnetName <String>] -RecoveryResourceGroupId <String> [-ReplicationGroupName <String>] + [-RecoveryAvailabilityZone <String>] [-RecoveryProximityPlacementGroupId <String>] + [-RecoveryVirtualMachineScaleSetId <String>] [-RecoveryCapacityReservationGroupId <String>] + [-RecoveryAvailabilitySetId <String>] [-RecoveryBootDiagStorageAccountId <String>] + [-DiskEncryptionVaultId <String>] [-DiskEncryptionSecretUrl <String>] [-KeyEncryptionKeyUrl <String>] + [-KeyEncryptionVaultId <String>] [-WaitForCompletion] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ReplicateVMwareToAzure +``` +New-AzRecoveryServicesAsrReplicationProtectedItem [-ReplicateVMwareToAzure] + -ProtectableItem <ASRProtectableItem> -Name <String> [-RecoveryVmName <String>] [-LicenseType <String>] + [-TestNetworkId <String>] [-TestSubnetName <String>] + -ProtectionContainerMapping <ASRProtectionContainerMapping> [-CredentialsToAccessVm <String>] + -LogStorageAccountId <String> -ApplianceName <String> -Fabric <ASRFabric> [-RecoveryAzureNetworkId <String>] + [-RecoveryAzureSubnetName <String>] -RecoveryResourceGroupId <String> [-ReplicationGroupName <String>] + [-RecoveryAvailabilityZone <String>] [-RecoveryProximityPlacementGroupId <String>] + [-RecoveryAvailabilitySetId <String>] [-Size <String>] + [-RecoveryBootDiagStorageAccountId <String>] [-WaitForCompletion] -DiskType <String> + [-DiskEncryptionSetId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ReplicateVMwareToAzureWithDiskInput +``` +New-AzRecoveryServicesAsrReplicationProtectedItem [-ReplicateVMwareToAzure] + -ProtectableItem <ASRProtectableItem> -InMageRcmDiskInput <ASRInMageRcmDiskInput[]> -Name <String> + [-RecoveryVmName <String>] [-LicenseType <String>] [-TestNetworkId <String>] [-TestSubnetName <String>] + -ProtectionContainerMapping <ASRProtectionContainerMapping> [-CredentialsToAccessVm <String>] + -ApplianceName <String> -Fabric <ASRFabric> [-RecoveryAzureNetworkId <String>] + [-RecoveryAzureSubnetName <String>] -RecoveryResourceGroupId <String> [-ReplicationGroupName <String>] + [-RecoveryAvailabilityZone <String>] [-RecoveryProximityPlacementGroupId <String>] + [-RecoveryAvailabilitySetId <String>] [-Size <String>] + [-RecoveryBootDiagStorageAccountId <String>] [-WaitForCompletion] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRecoveryServicesAsrReplicationProtectedItem** cmdlet creates a new replication protected item. +Use this cmdlet to enable replication for an ASR protectable item. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = New-AzRecoveryServicesAsrReplicationProtectedItem -ProtectableItem $VM -Name $VM.Name -ProtectionContainerMapping $ProtectionContainerMapping +``` + +Starts the replication protected item creation operation for the specified ASR protectable item and returns the ASR job used to track the operation. + +### Example 2 +```powershell +$job = New-AzRecoveryServicesAsrReplicationProtectedItem -VMwareToAzure -Account $fabric.FabricSpecificDetails.RunAsAccounts[0] ` +-RecoveryResourceGroupId $RecoveryResourceGroupId -RecoveryAzureNetworkId $RecoveryAzureNetworkId -name $name ` +-ProcessServer $fabric.FabricSpecificDetails.ProcessServers[0] -ProtectableItem $protectableItem -ProtectionContainerMapping $pcm ` +-RecoveryAzureSubnetName $RecoveryAzureSubnetName -RecoveryVmName $RecoveryVmName -LogStorageAccountId $LogStorageAccountId +``` + +Starts the replication protected item creation operation for the specified ASR protectable item and returns the ASR job used to track the operation(vmWare to Azure scenario). + +### Example 3 +```powershell +$job = New-AzRecoveryServicesAsrReplicationProtectedItem -AzureToAzure -AzureToAzureDiskReplicationConfiguration disk1,disk2 -AzureVmId $vmId ` +-Name "a2aprotectedItem" -ProtectionContainerMapping $pcmMapping -RecoveryResourceGroupId $recoveryResourceGroup +``` + +Starts the replication protected item creation operation for the specified ASR protectable item and returns the ASR job used to track the operation (Azure to Azure scenario). + +### Example 4 +```powershell +$disk1 = New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig -vhdUri $diskUri1 -RecoveryAzureStorageAccountId $recoveryAzureStorageAccountId ` +-LogStorageAccountId $logStorageAccountId +$disk2 = New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig -vhdUri $diskUri2 -RecoveryAzureStorageAccountId $recoveryAzureStorageAccountId ` +-LogStorageAccountId $logStorageAccountId +$enableDRjob = New-AzRecoveryServicesAsrReplicationProtectedItem -AzureToAzure -AzureVmId $vmId -Name $rpiName ` +-RecoveryCloudServiceId $recoveryCloudServiceId -ProtectionContainerMapping $pcm -RecoveryResourceGroupId $RecoveryResourceGroupId ` +-AzureToAzureDiskReplicationConfiguration $disk1,$disk2 -RecoveryAzureNetworkId $RecoveryAzureNetworkId -RecoveryAzureSubnetName $RecoveryAzureSubnetName +``` + +Starts the replication protected item creation operation for the specified VmId and returns the ASR job used to track the operation (Azure to Azure scenario). + +### Example 5 +```powershell +$disk1 = New-AzRecoveryServicesAsrInMageAzureV2DiskInput -DiskId $diskId -LogStorageAccountId $logStorageAccountId -DiskType $diskType +$disk2 = New-AzRecoveryServicesAsrInMageAzureV2DiskInput -DiskId $diskId2 -LogStorageAccountId $logStorageAccountId -DiskType $diskType2 +$job = New-AzRecoveryServicesAsrReplicationProtectedItem -VMwareToAzure -Account $fabric.FabricSpecificDetails.RunAsAccounts[0] -RecoveryResourceGroupId $RecoveryResourceGroupId ` +-RecoveryAzureNetworkId $RecoveryAzureNetworkId -name $name -ProcessServer $fabric.FabricSpecificDetails.ProcessServers[0] -ProtectableItem $protectableItem ` +-ProtectionContainerMapping $pcm -RecoveryAzureSubnetName $RecoveryAzureSubnetName -RecoveryVmName $RecoveryVmName ` +-LogStorageAccountId $LogStorageAccountId -InMageAzureV2DiskInput $disk1,$disk2 +``` + +Starts the replication protected item creation operation for the specified ASR protectable item including selective disks and returns the ASR job used to track the operation(vmWare to Azure scenario) with selected disks. + +### Example 6 +```powershell +$job = New-AzRecoveryServicesAsrReplicationProtectedItem -VMwareToAzure -Account $fabric.FabricSpecificDetails.RunAsAccounts[0] -RecoveryResourceGroupId $RecoveryResourceGroupId ` +-RecoveryAzureNetworkId $RecoveryAzureNetworkId -name $name -ProcessServer $fabric.FabricSpecificDetails.ProcessServers[0] -ProtectableItem $protectableItem ` +-ProtectionContainerMapping $pcm -RecoveryAzureSubnetName $RecoveryAzureSubnetName -RecoveryVmName $RecoveryVmName ` +-LogStorageAccountId $LogStorageAccountId -DiskType Standard_LRS +``` + +Starts the replication protected item creation operation for the specified ASR protectable item with default disk type and returns the ASR job used to track the operation(vmWare to Azure scenario). + +### Example 7 +```powershell +$disk1 = New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig -vhdUri $diskUri1 -RecoveryAzureStorageAccountId $recoveryAzureStorageAccountId -LogStorageAccountId $logStorageAccountId +$disk2 = New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig -vhdUri $diskUri2 -RecoveryAzureStorageAccountId $recoveryAzureStorageAccountId -LogStorageAccountId $logStorageAccountId +$enableDRjob = New-AzRecoveryServicesAsrReplicationProtectedItem -AzureToAzure -AzureVmId $vmId -Name $rpiName ` +-RecoveryCloudServiceId $recoveryCloudServiceId -ProtectionContainerMapping $pcm -RecoveryResourceGroupId $RecoveryResourceGroupId ` +-AzureToAzureDiskReplicationConfiguration $disk1,$disk2 -DiskEncryptionVaultId $DiskEncryptionVaultId -DiskEncryptionSecretUrl $DiskEncryptionSecertUrl ` + -KeyEncryptionVaultId $KeyEncryptionVaultId -KeyEncryptionKeyUrl $KeyEncryptionKeyUrl +``` + +Starts the replication protected item creation operation for the specified VmId and returns the ASR job used to track the operation (Azure to Azure scenario).For the failover VM details passed in cmdlet for encryption will be used . + +### Example 8 +```powershell +$job = New-AzRecoveryServicesAsrReplicationProtectedItem -AzureToAzure -AzureToAzureDiskReplicationConfiguration disk1,disk2 -AzureVmId $vmId ` +-Name "a2aprotectedItem" -ProtectionContainerMapping $pcmMapping -RecoveryResourceGroupId $recoveryResourceGroup -RecoveryProximityPlacementGroupId $ppg +``` + +Starts the replication protected item creation operation for a Virtual Machine inside Proximity placement group and returns the ASR job used to track the operation (Azure to Azure scenario). + +### Example 9 +```powershell +$job = New-AzRecoveryServicesAsrReplicationProtectedItem -AzureToAzure -AzureToAzureDiskReplicationConfiguration disk1,disk2 -AzureVmId $vmId ` +-Name "a2aprotectedItem" -ProtectionContainerMapping $pcmMapping -RecoveryResourceGroupId $recoveryResourceGroup -RecoveryVirtualMachineScaleSetId $vmss +``` + +Starts the replication protected item creation operation for a Virtual Machine with target virtual machine scale set configured and returns the ASR job used to track the operation (Azure to Azure scenario). + +## PARAMETERS + +### -Account +The run as account to be used to push install the Mobility service if needed. Must be one from the list of run as accounts in the ASR fabric. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRunAsAccount +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplianceName +Specifies the name of appliance to be used to replicate this machine. + +```yaml +Type: System.String +Parameter Sets: ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureToAzure +Switch parameter specifies creating the replicated item in azure to azure scenario. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureToAzure, AzureToAzureWithoutDiskDetails +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureToAzureDiskReplicationConfiguration +Specifies the disk configuration to used Vm for Azure to Azure disaster recovery scenario. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRAzuretoAzureDiskReplicationConfig[] +Parameter Sets: AzureToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureVmId +Specifies the Azure VM id for disaster recovery protection in recovery region. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithoutDiskDetails +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialsToAccessVm +Specifies the name of credentials to be used to push install the Mobility service on source machine if needed. + +```yaml +Type: System.String +Parameter Sets: ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSecretUrl +Specifies the disk encryption secret URL with version(Azure disk encryption) to be used be recovery VM after failover. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithoutDiskDetails +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId +Specifies the resource Id of the disk encryption set, to be used for the encryption of the managed disks. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, ReplicateVMwareToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionVaultId +Specifies the disk encryption secret vault ID(Azure disk encryption) to be used be recovery VM after failover. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithoutDiskDetails +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskTag +Specify the tags for the disks of the VM. + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, HyperVSiteToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskType +Specifies the Recovery VM managed disk type. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzureWithDiskType, ReplicateVMwareToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fabric +Specifies the ASR Fabric object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HyperVToAzure +Switch parameter to specify the replicated item is a Hyper-V virtual machine that is being replicated to Azure. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EnterpriseToAzure, HyperVSiteToAzure +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDiskId +The list of disks to include for replication. By default all disks are included. + +```yaml +Type: System.String[] +Parameter Sets: HyperVSiteToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMageAzureV2DiskInput +Specifies the disk configuration input for vMWare disk id to protect from specified protectable item. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.AsrInMageAzureV2DiskInput[] +Parameter Sets: VMwareToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMageRcmDiskInput +Specifies the disk input to be used for VMware to Azure disaster recovery scenario. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRInMageRcmDiskInput[] +Parameter Sets: ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyUrl +Specifies the disk encryption key URL with version(Azure disk encryption) to be used be recovery VM after failover. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithoutDiskDetails +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionVaultId +Specifies the disk encryption key key-vault ID(Azure disk encryption) to be used be recovery VM after failover. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithoutDiskDetails +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +Specifies the the license type. +The acceptable values for this parameter are: NoLicenseType or WindowsServer. + +```yaml +Type: System.String +Parameter Sets: ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: +Accepted values: NoLicenseType, WindowsServer + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogStorageAccountId +Specifies the log or cache storage account Id to be used to store replication logs. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, HyperVSiteToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: AzureToAzureWithoutDiskDetails, ReplicateVMwareToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the ASR replication protected item. The name must be unique within the vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OS +Specifies the operating system family. +The acceptable values for this parameter are: Windows or Linux. + +```yaml +Type: System.String +Parameter Sets: HyperVSiteToAzure +Aliases: +Accepted values: Windows, Linux + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSDiskName +Specifies the name of the operating system disk. + +```yaml +Type: System.String +Parameter Sets: HyperVSiteToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProcessServer +The Process Server to use to replicate this machine. Use the list of process servers in the ASR fabric corresponding to the Configuration server to specify one. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProcessServer +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectableItem +Specifies the ASR protectable item object for which replication is being enabled. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectableItem +Parameter Sets: EnterpriseToEnterprise, VMwareToAzureWithDiskType, VMwareToAzure, EnterpriseToAzure, HyperVSiteToAzure, ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ProtectionContainerMapping +Specifies the ASR protection container mapping object corresponding to the replication policy to be used for replication. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainerMapping +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryAvailabilitySetId +The ID of the AvailabilitySet to recover the machine to in the event of a failover. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, HyperVSiteToAzure, AzureToAzure, AzureToAzureWithoutDiskDetails, ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryAvailabilityZone +Specifies the recovery VM availability zone after failover. + + +```yaml +Type: System.String +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, HyperVSiteToAzure, AzureToAzure, AzureToAzureWithoutDiskDetails, ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryAzureNetworkId +The ID of the Azure virtual network to recover the machine to in the event of a failover. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, HyperVSiteToAzure, AzureToAzure, AzureToAzureWithoutDiskDetails, ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryAzureStorageAccountId +Specifies the ID of the Azure storage account to replicate to. + +```yaml +Type: System.String +Parameter Sets: EnterpriseToAzure, HyperVSiteToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: AzureToAzureWithoutDiskDetails +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryAzureSubnetName +The subnet within the recovery Azure virtual network to which the failed over virtual machine should be attached in the event of a failover. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, HyperVSiteToAzure, AzureToAzure, AzureToAzureWithoutDiskDetails, ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryBootDiagStorageAccountId +Specifies the storage account for boot diagnostics for recovery azure VM. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithoutDiskDetails, ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryCapacityReservationGroupId +Specify the capacity reservation group Id to be used by the failover VM in target recovery region. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithoutDiskDetails +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryCloudServiceId +Specifies the resource ID of the recovery cloud service to failover this virtual machine to. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryExtendedLocation +Specifies Recovery ExtendedLocation in case of EZ-to-EZ. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### -RecoveryNicTag +Specify the tags for the target NICs of the VM. + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, HyperVSiteToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryProximityPlacementGroupId +Specify the proximity placement group Id to used by the failover Vm in target recovery region. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, HyperVSiteToAzure, AzureToAzure, AzureToAzureWithoutDiskDetails, ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryResourceGroupId +Specifies the ARM identifier of the resource group in which the virtual machine will be created in the event of a failover. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, EnterpriseToAzure, HyperVSiteToAzure, AzureToAzure, AzureToAzureWithoutDiskDetails, ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryVirtualMachineScaleSetId +Specify the virtual machine scale set Id to used by the failover Vm in target recovery region. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithoutDiskDetails +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryVmName +Name of the recovery Vm created after failover. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, EnterpriseToAzure, HyperVSiteToAzure, AzureToAzure, AzureToAzureWithoutDiskDetails, ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryVmTag +Specify the tags for target VM. + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, HyperVSiteToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicateVMwareToAzure +Switch parameter to specify the replicated item is a VMware virtual machine that is being replicated to Azure. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationGroupName +Specifies the replication group name to use to create multi-VM consistent recovery points. By default each replication protected item is created in a group of its own and multi-VM consistent recovery points are not generated. Use this option only if you need to create multi-VM consistent recovery points across a group of machines by protecting all machines to the same replication group. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, AzureToAzure, AzureToAzureWithoutDiskDetails, ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Size +Specify the recovery virtual machine size. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, HyperVSiteToAzure, ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlServerLicenseType +Specify the SQL Server license type of the VM. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure, HyperVSiteToAzure +Aliases: +Accepted values: NoLicenseType, PAYG, AHUB + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNetworkId +Specifies the test network ARM Id. + +```yaml +Type: System.String +Parameter Sets: ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestSubnetName +Specifies the test network subnet name. + +```yaml +Type: System.String +Parameter Sets: ReplicateVMwareToAzure, ReplicateVMwareToAzureWithDiskInput +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseManagedDisk +Specifies if the Azure virtual machine that is created on failover should use managed disks. It Accepts either True or False. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: True, False + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseManagedDisksForReplication +Specifies if the managed disks needs to be used during replication. It Accepts either True or False. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: True, False + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmmToVmm +Switch parameter to specify the replicated item is a Hyper-V virtual machine that is being replicated between VMM managed Hyper-V sites. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EnterpriseToEnterprise +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMwareToAzure +Switch parameter to specify the replicated item is a VMware virtual machine or physical server that will be replicate to Azure. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: VMwareToAzureWithDiskType, VMwareToAzure +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitForCompletion +Specifies that the cmdlet should wait for completion of the operation before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts for confirmation before starting the operation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectableItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrReplicationProtectedItem](./Get-AzRecoveryServicesAsrReplicationProtectedItem.md) + +[Remove-AzRecoveryServicesAsrReplicationProtectedItem](./Remove-AzRecoveryServicesAsrReplicationProtectedItem.md) + +[Set-AzRecoveryServicesAsrReplicationProtectedItem](./Set-AzRecoveryServicesAsrReplicationProtectedItem.md) diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrStorageClassificationMapping.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrStorageClassificationMapping.md new file mode 100644 index 0000000000..c6f24a6dae --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrStorageClassificationMapping.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesasrstorageclassificationmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrStorageClassificationMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrStorageClassificationMapping.md +--- + +# New-AzRecoveryServicesAsrStorageClassificationMapping + +## SYNOPSIS +Creates an ASR storage classification mapping in the Recovery Services vault. + +## SYNTAX + +``` +New-AzRecoveryServicesAsrStorageClassificationMapping -Name <String> + -PrimaryStorageClassification <ASRStorageClassification> + -RecoveryStorageClassification <ASRStorageClassification> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRecoveryServicesAsrStorageClassificationMapping** cmdlet creates a storage classification mapping the Recovery Services vault. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = New-AzRecoveryServicesAsrStorageClassificationMapping -Name $StorageClassificationMappingName -PrimaryStorageClassification $PrimaryStorageClassification -RecoveryStorageClassification $RecoveryStorageClassification +``` + +Starts the storage classification mapping creation operation with the specified parameters and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the ASR storage classification mapping. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryStorageClassification +Specifies the primary ASR storage classification object for the mapping. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassification +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RecoveryStorageClassification +Specifies the recovery ASR storage classification object for the mapping. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassification +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassification + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrStorageClassificationMapping](./Get-AzRecoveryServicesAsrStorageClassificationMapping.md) + +[Remove-AzRecoveryServicesAsrStorageClassificationMapping](./Remove-AzRecoveryServicesAsrStorageClassificationMapping.md) diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrVMNicConfig.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrVMNicConfig.md new file mode 100644 index 0000000000..095e624f93 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrVMNicConfig.md @@ -0,0 +1,341 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/New-AzRecoveryServicesAsrVMNicConfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrVMNicConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrVMNicConfig.md +--- + +# New-AzRecoveryServicesAsrVMNicConfig + +## SYNOPSIS +Creates an ASR NIC config that contains the failover and test failover related configuration details. + +## SYNTAX + +``` +New-AzRecoveryServicesAsrVMNicConfig -NicId <String> -ReplicationProtectedItem <ASRReplicationProtectedItem> + [-RecoveryVMNetworkId <String>] [-RecoveryNicName <String>] [-RecoveryNicResourceGroupName <String>] + [-ReuseExistingNic] [-RecoveryNetworkSecurityGroupId <String>] [-EnableAcceleratedNetworkingOnRecovery] + [-TfoVMNetworkId <String>] [-TfoNicName <String>] [-TfoNicResourceGroupName <String>] [-TfoReuseExistingNic] + [-TfoNetworkSecurityGroupId <String>] [-EnableAcceleratedNetworkingOnTfo] + [-IPConfig <PSIPConfigInputDetails[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRecoveryServicesAsrVMNicConfig** cmdlet creates an ASR NIC config object that contains the failover and test failover related details. In case any information is not passed, the corresponding values are picked from the replication protected item to avoid these values being updated to null. + +> [!IMPORTANT] +> We have deprecated the parameters corresponding to IP Configs from the cmdlet, and encapsulated them into a new cmdlet object. Please create a new object using the cmdlet **New-AzRecoveryServicesAsrVMNicIPConfig** and pass that as a parameter. Please refer to the examples below for more clarity. + +## EXAMPLES + +### Example 1 +```powershell +$ipConfig1 = New-AzRecoveryServicesAsrVMNicIPConfig -IpConfigName "ipconfig1" -RecoverySubnetName "default" ` +-TfoSubnetName "default" -RecoveryStaticIPAddress "10.1.40.10" -TfoStaticIPAddress "10.3.4.33" +$ipConfig2 = New-AzRecoveryServicesAsrVMNicIPConfig -IpConfigName "ipconfig2" -IsSelectedForFailover -RecoverySubnetName "default" ` +-TfoSubnetName "default" -RecoveryStaticIPAddress "10.1.40.13" -TfoStaticIPAddress "10.3.4.32" +$ipConfigs = @($ipConfig1, $ipConfig2) +$nicConfig = New-AzRecoveryServicesAsrVMNicConfig -NicId $AsrNicGuid -ReplicationProtectedItem $Rpi -RecoveryVMNetworkId $recoveryNetworkId ` + -TfoVMNetworkId $tfoNetworkId -IPConfig $ipConfigs +``` + +Creates an ASRVmNicConfig object with the failover and test failover networking settings configured for the NIC. Any property that's not passed above is fetched from the protected item passed. + +### Example 2 +```powershell +$nicConfig = New-AzRecoveryServicesAsrVMNicConfig -NicId $AsrNicGuid -ReplicationProtectedItem $Rpi -TfoNicName $TfoNicName -TfoNicResourceGroupName $TfoNicRgName -TfoReuseExistingNic +``` + +Creates an ASRVmNicConfig object with the test faiover networking settings configured for the NIC renaming. Any property that's not passed above is fetched from the protected item passed. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAcceleratedNetworkingOnRecovery +Specifies whether accelerated networking is enabled on recovery NIC. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAcceleratedNetworkingOnTfo +Specifies whether accelerated networking is enabled on test failover NIC. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPConfig +Specifies test failover/failover settings of NIC IP configs. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.PSIPConfigInputDetails[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NicId +Specify the ASR NIC GUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryNetworkSecurityGroupId +Specifies the ID of the NSG associated with recovery NIC. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryNicName +Specifies the name of the recovery NIC. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryNicResourceGroupName +Specifies the name of the recovery NIC resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryVMNetworkId +Specifies the ID of the recovery virtual network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +Specify the ASR Replication Protected Item. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReuseExistingNic +Specifies whether an existing NIC can be used during failover. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TfoNetworkSecurityGroupId +Specifies the ID of the NSG associated with test failover NIC. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TfoNicName +Specifies the name of the test failover NIC. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TfoNicResourceGroupName +Specifies the name of the test failover NIC resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TfoReuseExistingNic +Specifies whether an existing NIC can be used during test failover. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TfoVMNetworkId +Specifies the ID of the test failover virtual network. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVMNicConfig + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrVMNicIPConfig.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrVMNicIPConfig.md new file mode 100644 index 0000000000..cd9846aa46 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrVMNicIPConfig.md @@ -0,0 +1,249 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/New-AzRecoveryServicesAsrVMNicIPConfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrVMNicIPConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrVMNicIPConfig.md +--- + +# New-AzRecoveryServicesAsrVMNicIPConfig + +## SYNOPSIS +Creates an ASR NIC IP config that contains the failover and test failover configuration details for each IP Config (Primary and Secondary) of the NIC. + +## SYNTAX + +``` +New-AzRecoveryServicesAsrVMNicIPConfig -IpConfigName <String> [-IsSelectedForFailover] + [-RecoverySubnetName <String>] [-RecoveryStaticIPAddress <String>] [-RecoveryPublicIPAddressId <String>] + [-RecoveryLBBackendAddressPoolId <String[]>] [-TfoSubnetName <String>] [-TfoStaticIPAddress <String>] + [-TfoPublicIPAddressId <String>] [-TfoLBBackendAddressPoolId <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRecoveryServicesAsrVMNicIPConfig** cmdlet creates an IP Config object that contains the failover and test failover details for each IP Config (Primary and Secondary) of the NIC. This further should be passed as a parameter to ** New-AzRecoveryServicesAsrVMNicConfig** for setting these values in the ASR NIC Config Object. + +## EXAMPLES + +### Example 1 +```powershell +$ipConfig = New-AzRecoveryServicesAsrVMNicIPConfig -IpConfigName "ipconfig1" -RecoverySubnetName "default" ` +-TfoSubnetName "default" -RecoveryStaticIPAddress "10.1.40.10" -TfoStaticIPAddress "10.3.4.33" +``` + +Creates an PSIPConfigInputDetails object with the failover and test failover networking settings configured for IP config of a NIC . + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfigName +Specify the IP config name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsSelectedForFailover +Specifies whether an existing IP config is selected for test failover/failover. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryLBBackendAddressPoolId +Specifies the IDs of backend address pools for the recovery IP config. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPublicIPAddressId +Specifies the ID of the public IP address associated with the recovery IP config. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryStaticIPAddress +Specifies the IP address of the recovery IP config. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoverySubnetName +Specifies the name of the recovery subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TfoLBBackendAddressPoolId +Specifies the IDs of backend address pools for the test failover IP config. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TfoPublicIPAddressId +Specifies the ID of the public IP address associated with the test failover IP config. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TfoStaticIPAddress +Specifies the IP address of the test failover IP config. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TfoSubnetName +Specifies the name of the test failover subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.PSIPConfigInputDetails + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrvCenter.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrvCenter.md new file mode 100644 index 0000000000..c3474d323e --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesAsrvCenter.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesasrvcenter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrvCenter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesAsrvCenter.md +--- + +# New-AzRecoveryServicesAsrvCenter + +## SYNOPSIS +Adds a vCenter server to discover protectable items from. + +## SYNTAX + +``` +New-AzRecoveryServicesAsrvCenter -Fabric <ASRFabric> -Name <String> -Account <ASRRunAsAccount> -Port <Int32> + -IpOrHostName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRecoveryServicesAsrvCenter** cmdlet adds a vCenter server to discover protectable items from. This cmdlet registers the vCenter server for discovery with the Configuration server. + +## EXAMPLES + +### Example 1 +```powershell +New-AzRecoveryServicesAsrvCenter -Account $ConfigServer.FabricSpecificDetails.RunAsAccounts[1] -Fabric $ConfigServer -Name InmTest59 -Port 443 -IpOrHostName 10.150.209.6 +``` + +```output +Asr Job for vCenter creation. +``` + +Adds a vCenter server to discover protectable items from. + +### Example 2 + +Adds a vCenter server to discover protectable items from. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +New-AzRecoveryServicesAsrvCenter -Account $fabric.FabricSpecificDetails.RunAsAccounts[0] -Fabric $Fabric -IpOrHostName <String> -Name 'V2VM' -Port <Int32> +``` + +## PARAMETERS + +### -Account +User login credential Account. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRunAsAccount +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fabric +ASR fabric corresponding to the Configuration server. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IpOrHostName +IPv4 address or FQDN of the vCenter server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +A friendly name for the vCenter server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +The TCP port on the vCenter server to use for discovery. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesBackupProtectionPolicy.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesBackupProtectionPolicy.md new file mode 100644 index 0000000000..00cc5b9a1f --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesBackupProtectionPolicy.md @@ -0,0 +1,380 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: C2A7F37B-5713-4430-B83F-C6745692396D +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesbackupprotectionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesBackupProtectionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesBackupProtectionPolicy.md +--- + +# New-AzRecoveryServicesBackupProtectionPolicy + +## SYNOPSIS +Creates a Backup protection policy. + +## SYNTAX + +``` +New-AzRecoveryServicesBackupProtectionPolicy [-Name] <String> [-WorkloadType] <WorkloadType> + [[-BackupManagementType] <BackupManagementType>] [[-RetentionPolicy] <RetentionPolicyBase>] + [[-SchedulePolicy] <SchedulePolicyBase>] [[-MoveToArchiveTier] <Boolean>] [[-TieringMode] <TieringMode>] + [[-TierAfterDuration] <Int32>] [[-TierAfterDurationType] <String>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRecoveryServicesBackupProtectionPolicy** cmdlet creates a Backup protection policy in a vault. +A protection policy is associated with at least one retention policy. +The retention policy defines how long a recovery point is kept with Azure Backup. +You can use the Get-AzRecoveryServicesBackupRetentionPolicyObject cmdlet to get the default retention policy. +And you can use the Get-AzRecoveryServicesBackupSchedulePolicyObject cmdlet to get the default schedule policy. +The **SchedulePolicy** and **RetentionPolicy** objects are used as inputs to the **New-AzRecoveryServicesBackupProtectionPolicy** cmdlet. +Set the vault context by using the Set-AzRecoveryServicesVaultContext cmdlet before you use the current cmdlet. + +## EXAMPLES + +### Example 1: Create a Backup protection policy +```powershell +$SchPol = Get-AzRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM" +$SchPol.ScheduleRunTimes.Clear() +$Dt = Get-Date +$SchPol.ScheduleRunTimes.Add($Dt.ToUniversalTime()) +$RetPol = Get-AzRecoveryServicesBackupRetentionPolicyObject -WorkloadType "AzureVM" +$RetPol.DailySchedule.DurationCountInDays = 365 +New-AzRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol +``` + +The first command gets a base **SchedulePolicyObject**, and then stores it in the $SchPol variable. +The second command removes all scheduled run times from the schedule policy in $SchPol. +The third command uses the Get-Date cmdlet to get the current date and time. +The fourth command adds the current date and time in $Dt as the scheduled run time to the schedule policy. +The fifth command gets a base **RetentionPolicy** object, and then stores it in the $RetPol variable. +The sixth command sets the retention duration policy to 365 days. +The final command creates a **BackupProtectionPolicy** object based on the schedule and retention policies created by the previous commands. + +### Example 2: Create a fileshare policy for multiple backups per day +```powershell +$schedulePolicy = Get-AzRecoveryServicesBackupSchedulePolicyObject -WorkloadType AzureFiles -BackupManagementType AzureStorage -ScheduleRunFrequency Hourly +$timeZone = Get-TimeZone +$schedulePolicy.ScheduleRunTimeZone = $timeZone.Id +$startTime = Get-Date -Date "2021-12-22T06:00:00.00+00:00" +$schedulePolicy.ScheduleWindowStartTime = $startTime.ToUniversalTime() +$schedulePolicy.ScheduleInterval = 6 +$schedulePolicy.ScheduleWindowDuration = 14 +$retentionPolicy = Get-AzRecoveryServicesBackupRetentionPolicyObject -WorkloadType AzureFiles -BackupManagementType AzureStorage -ScheduleRunFrequency Hourly +$retentionPolicy.DailySchedule.DurationCountInDays = 10 +New-AzRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $retentionPolicy -SchedulePolicy $schedulePolicy +``` + +The first command gets a base hourly **SchedulePolicyObject**, and then stores it in the $schedulePolicy variable. +The second and third command fetches the timezone and updates the timezone in the $schedulePolicy. +The fourth and fifth command initializes the schedule window start time and updates the $schedulePolicy. Please note the start time must be in UTC even if the timezone is not UTC. +The sixth and seventh command updates the interval (in hours) after which the backup will be retriggered on the same day, duration (in hours) for which the schedule will run. +The eighth command gets a base hourly **RetentionPolicy** object, and then stores it in the $retentionPolicy variable. +The ninth command sets the retention duration policy to 10 days. +The final command creates a **BackupProtectionPolicy** object based on the schedule and retention policies created by the previous commands. + +### Example 3 + +Creates a Backup protection policy. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzRecoveryServicesBackupProtectionPolicy -Name 'NewPolicy' -RetentionPolicy $RetPol -SchedulePolicy $SchPol -VaultId $vault.ID -WorkloadType AzureVM +``` + +### Example 4: Create new AzureVM policy to enable Archive smart tiering with TieringMode TierRecommended +```powershell +$pol = New-AzRecoveryServicesBackupProtectionPolicy -Name newTierRecommendedPolicy -WorkloadType AzureVM -BackupManagementType AzureVM -RetentionPolicy $retPol -SchedulePolicy $schPol -VaultId $vault.ID -MoveToArchiveTier $true -TieringMode TierRecommended +``` + +This command is used to create policy to enable archive smart tiering for tiering mode TierRecommended, we set -MoveToArchiveTier parameter to $true to enable smart tiering. We set TieringMode to TierRecommended to move all recommended recovery points to archive. Please note that tiering mode TierRecommended is only supported for workload type AzureVM. + +### Example 5: Create new policy with archive smart tiering disabled +```powershell +$pol = New-AzRecoveryServicesBackupProtectionPolicy -VaultId $vault.ID -WorkloadType AzureVM -BackupManagementType AzureVM -RetentionPolicy $retPol -SchedulePolicy $schPol -MoveToArchiveTier $false +``` + +This command is used to disable archive smart tiering while creating a policy, we set MoveToArchiveTier parameter to $false to disable tiering. + +### Example 6: Create a non UTC timezone standard policy for workloadType MSSQL +```powershell +$schedulePolicy = Get-AzRecoveryServicesBackupSchedulePolicyObject -WorkloadType MSSQL -BackupManagementType AzureWorkload -PolicySubType Standard + +$timeZone = Get-TimeZone -ListAvailable | Where-Object { $_.Id -match "Tokyo" } +$date= Get-Date -Hour 9 -Minute 0 -Second 0 -Year 2022 -Day 26 -Month 12 -Millisecond 0 +$date = [DateTime]::SpecifyKind($date,[DateTimeKind]::Utc) +$schedulePolicy.FullBackupSchedulePolicy.ScheduleRunFrequency = "Weekly" +$schedulePolicy.FullBackupSchedulePolicy.ScheduleRunTimes[0] = $date +$schedulePolicy.FullBackupSchedulePolicy.ScheduleRunTimeZone = $timeZone[0].Id + +$schedulePolicy.IsDifferentialBackupEnabled = $true +$schedulePolicy.DifferentialBackupSchedulePolicy.ScheduleRunDays[0] = "Wednesday" +$schedulePolicy.DifferentialBackupSchedulePolicy.ScheduleRunTimes[0] = $date.AddHours(1) + +$retentionPolicy = Get-AzRecoveryServicesBackupRetentionPolicyObject -WorkloadType MSSQL -BackupManagementType AzureWorkload + +$retentionPolicy.DifferentialBackupRetentionPolicy.RetentionCount = 15 + +$retentionPolicy.FullBackupRetentionPolicy.IsDailyScheduleEnabled = $false +$retentionPolicy.FullBackupRetentionPolicy.IsMonthlyScheduleEnabled = $false +$retentionPolicy.FullBackupRetentionPolicy.WeeklySchedule.DurationCountInWeeks = 35 +$retentionPolicy.FullBackupRetentionPolicy.YearlySchedule.DurationCountInYears = 2 + +New-AzRecoveryServicesBackupProtectionPolicy -Name "Tokyo-mssql-policy" -WorkloadType MSSQL -BackupManagementType AzureWorkload -RetentionPolicy $retentionPolicy -SchedulePolicy $schedulePolicy -VaultId $vault.ID +``` + +The first command gets a **SchedulePolicyObject**, and then stores it in the $schedulePolicy variable. +The second command block fetches the timezone and datetime (localtime marked as UTC) and updates the timezone and time in the $schedulePolicy. Please note that the datetime should always be marked as UTC as the timezone is given separately. Also note, for other workload types timezone should be given in $schedulePolicy.ScheduleRunTimeZone attribute. +The third command block updates the Differential schedule policy. +Then, we get the **RetentionPolicyObject** and update differential and full backup retention settings. +Finally we create a **BackupProtectionPolicy** object based on the schedule and retention policies created by the previous commands. + +## PARAMETERS + +### -BackupManagementType +The class of resources being protected. The acceptable values for this parameter are: +- AzureVM +- AzureStorage +- AzureWorkload + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType] +Parameter Sets: (All) +Aliases: +Accepted values: AzureVM, AzureStorage, AzureWorkload + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveToArchiveTier +Specifies whether recovery points should be moved to archive storage by the policy or not. Allowed values are $true, $false + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionPolicy +Specifies the base **RetentionPolicy** object. +You can use the Get-AzRecoveryServicesBackupRetentionPolicyObject cmdlet to get a **RetentionPolicy** object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RetentionPolicyBase +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchedulePolicy +Specifies the base **SchedulePolicy** object. +You can use the Get-AzRecoveryServicesBackupSchedulePolicyObject cmdlet to get a **SchedulePolicy** object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.SchedulePolicyBase +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TierAfterDuration +Specifies the duration after which recovery points should start moving to the archive tier, value can be in days or months. Applicable only when TieringMode is TierAllEligible + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TierAfterDurationType +Specifies whether the TierAfterDuration is in Days or Months + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Days, Months + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TieringMode +Specifies whether to move recommended or all eligible recovery points to archive + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.TieringMode +Parameter Sets: (All) +Aliases: +Accepted values: TierRecommended, TierAllEligible + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkloadType +Workload type of the resource. The acceptable values for this parameter are: +- AzureVM +- AzureFiles +- MSSQL + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType +Parameter Sets: (All) +Aliases: +Accepted values: AzureVM, AzureFiles, MSSQL + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType + +### System.Nullable`1[[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType, Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RetentionPolicyBase + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.SchedulePolicyBase + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase + +## NOTES + +## RELATED LINKS + +[Enable-AzRecoveryServicesBackupProtection](./Enable-AzRecoveryServicesBackupProtection.md) + +[Get-AzRecoveryServicesBackupProtectionPolicy](./Get-AzRecoveryServicesBackupProtectionPolicy.md) + +[Get-AzRecoveryServicesBackupRetentionPolicyObject](./Get-AzRecoveryServicesBackupRetentionPolicyObject.md) + +[Get-AzRecoveryServicesBackupSchedulePolicyObject](./Get-AzRecoveryServicesBackupSchedulePolicyObject.md) + +[Remove-AzRecoveryServicesBackupProtectionPolicy](./Remove-AzRecoveryServicesBackupProtectionPolicy.md) + +[Set-AzRecoveryServicesBackupProtectionPolicy](./Set-AzRecoveryServicesBackupProtectionPolicy.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesVault.md b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesVault.md new file mode 100644 index 0000000000..694453c57c --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/New-AzRecoveryServicesVault.md @@ -0,0 +1,237 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 9591E150-54DA-48B7-8656-3891833FE61E +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/new-azrecoveryservicesvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/New-AzRecoveryServicesVault.md +--- + +# New-AzRecoveryServicesVault + +## SYNOPSIS +Creates a new Recovery Services vault. + +## SYNTAX + +``` +New-AzRecoveryServicesVault -Name <String> -ResourceGroupName <String> -Location <String> [-Tag <Hashtable>] + [-DisableClassicAlerts <Boolean>] [-DisableAzureMonitorAlertsForJobFailure <Boolean>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-ImmutabilityState <ImmutabilityState>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRecoveryServicesVault** cmdlet creates a new Recovery Services vault. + +## EXAMPLES + +### Example 1 +```powershell +New-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "rg" -Location "eastasia" +``` + +Create recovery service vault in resource group and given location. + +### Example 2: reate recovery service vault with ImmutabilityState, PublicNetworkAccess options +```powershell +$tag= @{"tag1"="value1";"tag2"="value2"} +New-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "resourceGroupName" -Location "westus" -Tag $tag -ImmutabilityState "Unlocked" -PublicNetworkAccess "Disabled" +``` + +Create recovery service vault with options like ImmutabilityState, PublicNetworkAccess. Please note Public Network Access is by default enabled for RS vault (if not specified) and can be updated using Update-AzRecoveryServicesVault cmdlet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAzureMonitorAlertsForJobFailure +Boolean paramter to specify whether built-in Azure Monitor alerts should be received for every job failure. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableClassicAlerts +Boolean paramter to specify whether backup alerts from the classic solution should be disabled or enabled. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutabilityState +Immutability State of the vault. Allowed values are "Disabled", "Unlocked", "Locked". +Unlocked means Enabled and can be changed, Locked means Enabled and can't be changed. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.ImmutabilityState] +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, Unlocked + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the name of the geographic location of the vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the vault to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Parameter to Enable/Disable public network access of the vault. This setting is useful with Private Endpoints. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.PublicNetworkAccess] +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the Azure resource group in which to create or from which to retrieve the specified Recovery Services object. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag + +Specifies the Tags to add to the Recovery Services Vault + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.ARSVault + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesVault](./Get-AzRecoveryServicesVault.md) + +[Get-AzRecoveryServicesVaultSettingsFile](./Get-AzRecoveryServicesVaultSettingsFile.md) + +[Remove-AzRecoveryServicesVault](./Remove-AzRecoveryServicesVault.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Register-AzRecoveryServicesBackupContainer.md b/azps-10.1.0/Az.RecoveryServices/Register-AzRecoveryServicesBackupContainer.md new file mode 100644 index 0000000000..ea92acaaae --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Register-AzRecoveryServicesBackupContainer.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/register-azrecoveryservicesbackupcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Register-AzRecoveryServicesBackupContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Register-AzRecoveryServicesBackupContainer.md +--- + +# Register-AzRecoveryServicesBackupContainer + +## SYNOPSIS +The **Register-AzRecoveryServicesBackupContainer** cmdlet registers an Azure VM for AzureWorkloads with specific workloadType. + +## SYNTAX + +### Register (Default) +``` +Register-AzRecoveryServicesBackupContainer [-ResourceId] <String> + [-BackupManagementType] <BackupManagementType> [-WorkloadType] <WorkloadType> [-Force] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ReRegister +``` +Register-AzRecoveryServicesBackupContainer [-Container] <ContainerBase> + [-BackupManagementType] <BackupManagementType> [-WorkloadType] <WorkloadType> [-Force] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command allows Azure Backup to convert the Resource to a Backup Container which is then registered to the given Recovery services vault. The Azure Backup service can then discover workloads of the given workload type within this container to be protected later. + +## EXAMPLES + +### Example 1 Register a backup container +```powershell +Register-AzRecoveryServicesBackupContainer -ResourceId <AzureVMID> -VaultId <vaultID> -WorkloadType MSSQL -BackupManagementType AzureWorkload +``` + +The cmdlet registers an azure VM as a container for the workload MSSQL. + +### Example 2 Re-register a backup container +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "rgName" -Name "vaultName" +$container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVMAppContainer -VaultId $vault.ID +Register-AzRecoveryServicesBackupContainer -Container $container[-1] -BackupManagementType AzureWorkload -WorkloadType MSSQL -VaultId $vault.ID +``` + +The first command fetches the recovery services vault. The second command fetches all the backup containers registered with the recovery services vault. The third command triggers a re-register operation for the container $container[-1], to re-register an already registered container we pass -Container parameter. + +## PARAMETERS + +### -BackupManagementType +The class of resources being protected. Currently the value supported for this cmdlet is AzureWorkload + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType +Parameter Sets: (All) +Aliases: +Accepted values: AzureWorkload + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Container where the item resides + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase +Parameter Sets: ReRegister +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force registers container (prevents confirmation dialog). This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the Azure Resource whose representative item needs to be checked if it is already protected by some RecoveryServices Vault in the subscription. + +```yaml +Type: System.String +Parameter Sets: Register +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkloadType +Workload type of the resource. The current supported value is AzureVM, WindowsServer, AzureFiles, MSSQL + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType +Parameter Sets: (All) +Aliases: +Accepted values: AzureVM, AzureSQLDatabase, AzureFiles, MSSQL + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrFabric.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrFabric.md new file mode 100644 index 0000000000..688a2b6ecb --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrFabric.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesasrfabric +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrFabric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrFabric.md +--- + +# Remove-AzRecoveryServicesAsrFabric + +## SYNOPSIS +Deletes the specified Azure Site Recovery Fabric from the Recovery Services vault. + +## SYNTAX + +``` +Remove-AzRecoveryServicesAsrFabric -InputObject <ASRFabric> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRecoveryServicesAsrFabric** cmdlet removes the specified Azure Site Recovery fabric from the Recovery services vault. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Remove-AzRecoveryServicesAsrFabric -Fabric $Fabric +``` + +Starts the deletion of specified fabric and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force the command to run without providing an additional warning. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The input object to the cmdlet: The ASR fabric object corresponding to the fabric to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: (All) +Aliases: Fabric + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Specify if confirmation is required. Set the value of the confirm parameter to $false in order to skip confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet is executed without actually executing the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrFabric](./Get-AzRecoveryServicesAsrFabric.md) + +[New-AzRecoveryServicesAsrFabric](./New-AzRecoveryServicesAsrFabric.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrNetworkMapping.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrNetworkMapping.md new file mode 100644 index 0000000000..a2b8b73a4b --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrNetworkMapping.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesasrnetworkmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrNetworkMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrNetworkMapping.md +--- + +# Remove-AzRecoveryServicesAsrNetworkMapping + +## SYNOPSIS +Deletes the specified ASR network mapping from the Recovery Services vault. + +## SYNTAX + +``` +Remove-AzRecoveryServicesAsrNetworkMapping -InputObject <ASRNetworkMapping> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRecoveryServicesAsrNetworkMapping** cmdlet deletes the specified ASR network mapping. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Remove-AzRecoveryServicesAsrNetworkMapping -NetworkMapping $networkmapping +``` + +Starts the deletion of specified ASR network mapping and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The input object to the cmdlet: The ASR network mapping object corresponding to the ASR network mapping to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetworkMapping +Parameter Sets: (All) +Aliases: NetworkMapping + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetworkMapping + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrNetworkMapping](./Get-AzRecoveryServicesAsrNetworkMapping.md) + +[New-AzRecoveryServicesAsrNetworkMapping](./New-AzRecoveryServicesAsrNetworkMapping.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrPolicy.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrPolicy.md new file mode 100644 index 0000000000..34f0f71e28 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrPolicy.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesasrpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrPolicy.md +--- + +# Remove-AzRecoveryServicesAsrPolicy + +## SYNOPSIS +Deletes the specified ASR replication policy from the Recovery Services vault. + +## SYNTAX + +``` +Remove-AzRecoveryServicesAsrPolicy -InputObject <ASRPolicy> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRecoveryServicesAsrPolicy** cmdlet deleted the specified replication policy from the Recovery Services vault. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Remove-AzRecoveryServicesAsrPolicy -Policy $Policy +``` + +Starts the deletion of the specified replication policy and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The input object to the cmdlet: The ASR replication policy object corresponding to the replication policy to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy +Parameter Sets: (All) +Aliases: Policy + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrPolicy](./Get-AzRecoveryServicesAsrPolicy.md) + +[New-AzRecoveryServicesAsrPolicy](./New-AzRecoveryServicesAsrPolicy.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrProtectionContainer.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrProtectionContainer.md new file mode 100644 index 0000000000..cb2fb7475d --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrProtectionContainer.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesasrprotectioncontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrProtectionContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrProtectionContainer.md +--- + +# Remove-AzRecoveryServicesAsrProtectionContainer + +## SYNOPSIS +Deletes the specified Protection Container from its Fabric. + +## SYNTAX + +``` +Remove-AzRecoveryServicesAsrProtectionContainer -InputObject <ASRProtectionContainer> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzRecoveryServicesAsrProtectionContainer cmdlet deletes the specified Azure Site Recovery Protection Container. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRecoveryServicesAsrProtectionContainer -Name xxxxx -Fabric $fabric +Remove-AzRecoveryServicesAsrProtectionContainer -InputObject $protectionContainer +``` + +Starts the deletion of specified protection container and returns the ASR job used to track the remove operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the protection container to be removed . + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer +Parameter Sets: (All) +Aliases: ProtectionContainer + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrProtectionContainerMapping.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrProtectionContainerMapping.md new file mode 100644 index 0000000000..0ffb6be65e --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrProtectionContainerMapping.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesasrprotectioncontainermapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrProtectionContainerMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrProtectionContainerMapping.md +--- + +# Remove-AzRecoveryServicesAsrProtectionContainerMapping + +## SYNOPSIS +Deletes the specified Azure Site Recovery protection container mapping. + +## SYNTAX + +``` +Remove-AzRecoveryServicesAsrProtectionContainerMapping -InputObject <ASRProtectionContainerMapping> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRecoveryServicesAsrProtectionContainerMapping** cmdlet deletes the specified Azure Site Recovery protection container mapping. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Remove-AzRecoveryServicesAsrProtectionContainerMapping -ProtectionContainerMapping $ProtectionContainerMapping +``` + +Starts the deletion of specified protection container mapping and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force the command to run without providing an additional warning. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The input object to the cmdlet: the ASR protection container mapping object corresponding to the protection container to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainerMapping +Parameter Sets: (All) +Aliases: ProtectionContainerMapping + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Specify if confirmation is required. Set the value of the confirm parameter to $false in order to skip confirmation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet is executed without actually executing the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainerMapping + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrProtectionContainerMapping](./Get-AzRecoveryServicesAsrProtectionContainerMapping.md) + +[New-AzRecoveryServicesAsrProtectionContainerMapping](./New-AzRecoveryServicesAsrProtectionContainerMapping.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrRecoveryPlan.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrRecoveryPlan.md new file mode 100644 index 0000000000..ede45cfc57 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrRecoveryPlan.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesasrrecoveryplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrRecoveryPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrRecoveryPlan.md +--- + +# Remove-AzRecoveryServicesAsrRecoveryPlan + +## SYNOPSIS +Deletes the specified ASR recovery plan from Recovery Services vault. + +## SYNTAX + +### ByObject (Default) +``` +Remove-AzRecoveryServicesAsrRecoveryPlan -InputObject <ASRRecoveryPlan> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByName +``` +Remove-AzRecoveryServicesAsrRecoveryPlan -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRecoveryServicesAsrRecoveryPlan** cmdlet deletes the specified recovery plan from the Recovery Services vault. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Remove-AzRecoveryServicesAsrRecoveryPlan -RecoveryPlan $RP +``` + +Starts the deletion of specified recovery plan and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The input object to the cmdlet: The ASR recovery plan object corresponding to the recovery plan to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan +Parameter Sets: ByObject +Aliases: RecoveryPlan + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the recovery plan to be deleted. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrRecoveryPlan](./Get-AzRecoveryServicesAsrRecoveryPlan.md) + +[New-AzRecoveryServicesAsrRecoveryPlan](./New-AzRecoveryServicesAsrRecoveryPlan.md) + +[Update-AzRecoveryServicesAsrRecoveryPlan](./Update-AzRecoveryServicesAsrRecoveryPlan.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrReplicationProtectedItem.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrReplicationProtectedItem.md new file mode 100644 index 0000000000..7523afbc40 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrReplicationProtectedItem.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesasrreplicationprotecteditem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrReplicationProtectedItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrReplicationProtectedItem.md +--- + +# Remove-AzRecoveryServicesAsrReplicationProtectedItem + +## SYNOPSIS +Stops/Disables replication for an Azure Site Recovery replication protected item. + +## SYNTAX + +``` +Remove-AzRecoveryServicesAsrReplicationProtectedItem -InputObject <ASRReplicationProtectedItem> + [-WaitForCompletion] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRecoveryServicesAsrReplicationProtectedItem** cmdlet disables replication of the specified Azure Site Recovery replication protected item. +This operation causes replication to stop for the protected item. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Remove-AzRecoveryServicesAsrReplicationProtectedItem -ReplicationProtectedItem $ReplicationProtectedItem +``` + +Starts the disable replication operation for the specified replication protected item and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force the command to run without providing an additional warning. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The input object to the cmdlet: The ASR replication protected item object corresponding to the replication protected item for which replication is to be disabled. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: (All) +Aliases: ReplicationProtectedItem + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WaitForCompletion +Indicates that the cmdlet should wait for the operation to complete before returning. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Specify if confirmation is required. Set the value of the confirm parameter to $false in order to skip confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet is executed without actually executing the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrReplicationProtectedItem](./Get-AzRecoveryServicesAsrReplicationProtectedItem.md) + +[New-AzRecoveryServicesAsrReplicationProtectedItem](./New-AzRecoveryServicesAsrReplicationProtectedItem.md) + +[Set-AzRecoveryServicesAsrReplicationProtectedItem](./Set-AzRecoveryServicesAsrReplicationProtectedItem.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk.md new file mode 100644 index 0000000000..cf4c53d7ba --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesasrreplicationprotecteditemDisk +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk.md +--- + +# Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk + +## SYNOPSIS +Removes disks to replication protected item. + +## SYNTAX + +### AzureToAzure (Default) +``` +Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk -InputObject <ASRReplicationProtectedItem> + -VhdUri <String[]> [-WaitForCompletion] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AzureToAzureManagedDisk +``` +Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk -InputObject <ASRReplicationProtectedItem> + -DiskId <String[]> [-WaitForCompletion] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk** cmdlet removes the disk from the ASR replication protected item. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk -ReplicationProtectedItem $rpi -VhdUri $vhdUri +``` + +Start the operation to remove specified disk from protection VM for unManaged disk. + +### Example 2 +```powershell +Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk -ReplicationProtectedItem $rpi -DiskId $diskId +``` + +Start the operation to remove specified disk from protection VM for Managed disk. + +### Example 3 +```powershell +$currentJob = Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk -ReplicationProtectedItem $rpi -DiskId $diskId +Get-AzRecoveryServicesAsrJob -name $currentJob.id +``` + +Starts the operation to remove the specified disk and returns the ASR job used to track the remove protected disk operation. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskId +Specifies the list of managed disk Ids. + +```yaml +Type: String[] +Parameter Sets: AzureToAzureManagedDisk +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The input object to the cmdlet: The ASR replication protected item object corresponding to which disk is to be removed. + +```yaml +Type: ASRReplicationProtectedItem +Parameter Sets: (All) +Aliases: ReplicationProtectedItem + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VhdUri +Specifies the list of vhd Uri's. + +```yaml +Type: String[] +Parameter Sets: AzureToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitForCompletion +Wait For Completion + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrServicesProvider.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrServicesProvider.md new file mode 100644 index 0000000000..6f722c8292 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrServicesProvider.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesasrservicesprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrServicesProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrServicesProvider.md +--- + +# Remove-AzRecoveryServicesAsrServicesProvider + +## SYNOPSIS +Deletes/unregister the specified Azure Site Recovery recovery services provider from the recovery services vault. + +## SYNTAX + +``` +Remove-AzRecoveryServicesAsrServicesProvider -InputObject <ASRRecoveryServicesProvider> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRecoveryServicesAsrServicesProvider** cmdlet removes the specified Azure Site Recovery recovery services provider from the vault. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Remove-AzRecoveryServicesAsrServicesProvider -ServicesProvider $ServicesProvider +``` + +Starts the deletion/unregistration of the specified Azure Site Recovery services provider and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force the command to run without providing an additional warning. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The input object to the cmdlet: The ASR recovery services provider object corresponding to the ASR recovery services provider to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryServicesProvider +Parameter Sets: (All) +Aliases: ServicesProvider + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Specify if confirmation is required. Set the value of the confirm parameter to $false in order to skip confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet is executed without actually executing the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryServicesProvider + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrServicesProvider](./Get-AzRecoveryServicesAsrServicesProvider.md) + +[Update-AzRecoveryServicesAsrServicesProvider](./Update-AzRecoveryServicesAsrServicesProvider.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrStorageClassificationMapping.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrStorageClassificationMapping.md new file mode 100644 index 0000000000..47539d52a1 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrStorageClassificationMapping.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesasrstorageclassificationmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrStorageClassificationMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrStorageClassificationMapping.md +--- + +# Remove-AzRecoveryServicesAsrStorageClassificationMapping + +## SYNOPSIS +Deletes the specified ASR storage classification mapping. + +## SYNTAX + +``` +Remove-AzRecoveryServicesAsrStorageClassificationMapping -InputObject <ASRStorageClassificationMapping> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRecoveryServicesAsrStorageClassificationMapping** cmdlet deletes the specified Azure Site Recovery storage classification mapping. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Remove-AzRecoveryServicesAsrStorageClassificationMapping -StorageClassificationMapping $StorageClassificationMapping +``` + +Starts the deletion of specified storage classification mapping and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The input object to the cmdlet: The ASR storage classification mapping object corresponding to the ASR storage classification mapping to be deleted. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassificationMapping +Parameter Sets: (All) +Aliases: StorageClassificationMapping + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassificationMapping + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrStorageClassificationMapping](./Get-AzRecoveryServicesAsrStorageClassificationMapping.md) + +[New-AzRecoveryServicesAsrStorageClassificationMapping](./New-AzRecoveryServicesAsrStorageClassificationMapping.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrvCenter.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrvCenter.md new file mode 100644 index 0000000000..f26c941065 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesAsrvCenter.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesasrvcenter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrvCenter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesAsrvCenter.md +--- + +# Remove-AzRecoveryServicesAsrvCenter + +## SYNOPSIS +Removes the vCenter server from the ASR fabric and stops discovery of virtual machines from the vCenter server. + +## SYNTAX + +### Default (Default) +``` +Remove-AzRecoveryServicesAsrvCenter -InputObject <ASRvCenter> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzRecoveryServicesAsrvCenter -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByName +``` +Remove-AzRecoveryServicesAsrvCenter -Fabric <ASRFabric> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRecoveryServicesAsrvCenter** cmdlet removes the vCenter server from the ASR fabric and stops discovery of virtual machines from the vCenter server. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzRecoveryServicesAsrvCenter -InputObject $vCenter +``` + +Removes the vCenter server from the ASR fabric. + +### Example 2 + +Removes the vCenter server from the ASR fabric and stops discovery of virtual machines from the vCenter server. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Remove-AzRecoveryServicesAsrvCenter -Fabric $Fabric -Name 'V2VM' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fabric +ASR fabric object representing the Configuration Server. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +ASR vCenter object representing the vCenter server to be removed. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRvCenter +Parameter Sets: Default +Aliases: vCenter + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the vCenter Server. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the resourceId of vCenter to remove. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRvCenter + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesBackupProtectionPolicy.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesBackupProtectionPolicy.md new file mode 100644 index 0000000000..af9560e79f --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesBackupProtectionPolicy.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: BFE741CC-C166-4534-93F4-D21AAFAD9FF6 +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesbackupprotectionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesBackupProtectionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesBackupProtectionPolicy.md +--- + +# Remove-AzRecoveryServicesBackupProtectionPolicy + +## SYNOPSIS +Deletes a Backup protection policy from a vault. + +## SYNTAX + +### PolicyName (Default) +``` +Remove-AzRecoveryServicesBackupProtectionPolicy [-Name] <String> [-PassThru] [-Force] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PolicyObject +``` +Remove-AzRecoveryServicesBackupProtectionPolicy [-Policy] <PolicyBase> [-PassThru] [-Force] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRecoveryServicesBackupProtectionPolicy** cmdlet deletes backup policies for a vault. +Before you can delete a Backup protection policy, the policy must not have any associated Backup items. +Before you delete the policy, make sure that each associated item is associated with some other policy. +To associate another policy with a Backup item, use the Enable-AzRecoveryServicesBackupProtection cmdlet. +Set the vault context by using the Set-AzRecoveryServicesVaultContext cmdlet before you use the current cmdlet. + +## EXAMPLES + +### Example 1: Remove a policy +```powershell +$Pol= Get-AzRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" +Remove-AzRecoveryServicesBackupProtectionPolicy -Policy $Pol +``` + +The first command gets the Backup protection policy named NewPolicy, and then stores it in the $Pol variable. +The second command removes the policy object in $Pol. + +### Example 2 + +Deletes a Backup protection policy from a vault. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Remove-AzRecoveryServicesBackupProtectionPolicy -Name 'V2VM' -VaultId $vault.ID +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Backup protection policy to remove. + +```yaml +Type: System.String +Parameter Sets: PolicyName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the policy to be deleted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the Backup protection policy to remove. +To obtain an **BackupPolicy** object, use the Get-AzRecoveryServicesBackupProtectionPolicy cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase +Parameter Sets: PolicyObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupProtectionPolicy](./Get-AzRecoveryServicesBackupProtectionPolicy.md) + +[New-AzRecoveryServicesBackupProtectionPolicy](./New-AzRecoveryServicesBackupProtectionPolicy.md) + +[Set-AzRecoveryServicesBackupProtectionPolicy](./Set-AzRecoveryServicesBackupProtectionPolicy.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesResourceGuardMapping.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesResourceGuardMapping.md new file mode 100644 index 0000000000..4b06693aea --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesResourceGuardMapping.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesresourceguardmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesResourceGuardMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesResourceGuardMapping.md +--- + +# Remove-AzRecoveryServicesResourceGuardMapping + +## SYNOPSIS +Deletes the resource guard mapping added to the recovery services vault. + +## SYNTAX + +``` +Remove-AzRecoveryServicesResourceGuardMapping [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + [-Token <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet deletes the mapping between the RS vault and resource guard + +## EXAMPLES + +### Example 1 Delete the resource guard mapping in a cross tenant scenario + +```powershell +$token = (Get-AzAccessToken -TenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx").Token +Remove-AzRecoveryServicesResourceGuardMapping -VaultId $vault.ID -Token $token +``` + +The first command fetches the access token for the resource guard tenant where the resource guard is present. The second command deletes the mapping between the RSVault $vault and the resource guard. Please note that token parameter is optional and only needed to authenticate cross tenant protected opeartions. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Token +Auxiliary access token for authenticating critical operation to resource guard subscription + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesVault.md b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesVault.md new file mode 100644 index 0000000000..d2570a1485 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Remove-AzRecoveryServicesVault.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 466F6B7C-BA7E-4DFD-8504-5A196A335231 +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/remove-azrecoveryservicesvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Remove-AzRecoveryServicesVault.md +--- + +# Remove-AzRecoveryServicesVault + +## SYNOPSIS +Deletes a Recovery Services vault. + +## SYNTAX + +``` +Remove-AzRecoveryServicesVault -Vault <ARSVault> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRecoveryServicesVault** cmdlet deletes a Recovery Services vault. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzRecoveryServicesVault -Vault $vault +``` + +Deletes a Recovery Services vault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vault +Specifies an Azure Site Recovery vault object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.ARSVault + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.VaultOperationOutput + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesVault](./Get-AzRecoveryServicesVault.md) + +[Get-AzRecoveryServicesVaultSettingsFile](./Get-AzRecoveryServicesVaultSettingsFile.md) + +[New-AzRecoveryServicesVault](./New-AzRecoveryServicesVault.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Restart-AzRecoveryServicesAsrJob.md b/azps-10.1.0/Az.RecoveryServices/Restart-AzRecoveryServicesAsrJob.md new file mode 100644 index 0000000000..f206f768e8 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Restart-AzRecoveryServicesAsrJob.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/restart-azrecoveryservicesasrjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Restart-AzRecoveryServicesAsrJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Restart-AzRecoveryServicesAsrJob.md +--- + +# Restart-AzRecoveryServicesAsrJob + +## SYNOPSIS +Restarts an Azure Site Recovery job. + +## SYNTAX + +### ByObject (Default) +``` +Restart-AzRecoveryServicesAsrJob -InputObject <ASRJob> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByName +``` +Restart-AzRecoveryServicesAsrJob -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Restart-AzRecoveryServicesAsrJob** cmdlet restarts an Azure Site Recovery job. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Restart-AzRecoveryServicesAsrJob -Job $Job +``` + +Restarts the specified ASR job and returns the updated ASR job object of the ASR job. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The input object to the cmdlet: The ASR job object corresponding to the ASR job to be restarted + + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob +Parameter Sets: ByObject +Aliases: Job + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the job by name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrJob](./Get-AzRecoveryServicesAsrJob.md) + +[Resume-AzRecoveryServicesAsrJob](./Resume-AzRecoveryServicesAsrJob.md) + +[Stop-AzRecoveryServicesAsrJob](./Stop-AzRecoveryServicesAsrJob.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Restore-AzRecoveryServicesBackupItem.md b/azps-10.1.0/Az.RecoveryServices/Restore-AzRecoveryServicesBackupItem.md new file mode 100644 index 0000000000..361b1b1527 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Restore-AzRecoveryServicesBackupItem.md @@ -0,0 +1,900 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: F49FA524-28BC-464F-BD0A-F898E99C83D8 +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/restore-azrecoveryservicesbackupitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Restore-AzRecoveryServicesBackupItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Restore-AzRecoveryServicesBackupItem.md +--- + +# Restore-AzRecoveryServicesBackupItem + +## SYNOPSIS + +Restores the data and configuration for a Backup item to the specified recovery point. The required parameters vary with the backup item type. +The same command is used to restore Azure Virtual machines, databases running within Azure Virtual machines and Azure file shares as well. + +## SYNTAX + +### AzureManagedVMReplaceExistingParameterSet (Default) +``` +Restore-AzRecoveryServicesBackupItem [-VaultLocation <String>] [-RecoveryPoint] <RecoveryPointBase> + [-StorageAccountName] <String> [-StorageAccountResourceGroupName] <String> [-RestoreOnlyOSDisk] + [-RestoreDiskList <String[]>] [-DiskEncryptionSetId <String>] [-RestoreToSecondaryRegion] + [-TargetZoneNumber <Int32>] [-RehydratePriority <String>] [-UseSystemAssignedIdentity] + [-UserAssignedIdentityId <String>] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + [-RehydrateDuration <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureManagedVMCreateNewParameterSet +``` +Restore-AzRecoveryServicesBackupItem [-VaultLocation <String>] [-RecoveryPoint] <RecoveryPointBase> + [-StorageAccountName] <String> [-StorageAccountResourceGroupName] <String> [-TargetResourceGroupName] <String> + [-RestoreOnlyOSDisk] [-RestoreDiskList <String[]>] [-DiskEncryptionSetId <String>] [-RestoreToSecondaryRegion] + [-TargetZoneNumber <Int32>] [-RehydratePriority <String>] [-UseSystemAssignedIdentity] + [-UserAssignedIdentityId <String>] [-TargetVMName <String>] [-TargetVNetName <String>] + [-TargetVNetResourceGroup <String>] [-TargetSubnetName <String>] [-TargetSubscriptionId <String>] + [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-RehydrateDuration <String>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AzureFileShareParameterSet +``` +Restore-AzRecoveryServicesBackupItem [-VaultLocation <String>] [-RecoveryPoint] <RecoveryPointBase> + -ResolveConflict <RestoreFSResolveConflictOption> [-SourceFilePath <String>] + [-SourceFileType <SourceFileType>] [-TargetStorageAccountName <String>] [-TargetFileShareName <String>] + [-TargetFolder <String>] [-MultipleSourceFilePath <String[]>] [-RestoreToSecondaryRegion] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureVMRestoreManagedAsUnmanaged +``` +Restore-AzRecoveryServicesBackupItem [-VaultLocation <String>] [-RecoveryPoint] <RecoveryPointBase> + [-StorageAccountName] <String> [-StorageAccountResourceGroupName] <String> [-RestoreOnlyOSDisk] + [-RestoreDiskList <String[]>] [-RestoreAsUnmanagedDisks] [-RestoreToSecondaryRegion] + [-RehydratePriority <String>] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + [-RehydrateDuration <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureVMUnManagedDiskParameterSet +``` +Restore-AzRecoveryServicesBackupItem [-VaultLocation <String>] [-RecoveryPoint] <RecoveryPointBase> + [-StorageAccountName] <String> [-StorageAccountResourceGroupName] <String> [-UseOriginalStorageAccount] + [-RestoreOnlyOSDisk] [-RestoreDiskList <String[]>] [-RestoreToSecondaryRegion] [-RehydratePriority <String>] + [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-RehydrateDuration <String>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AzureVMRestoreUnmanagedAsManaged +``` +Restore-AzRecoveryServicesBackupItem [-VaultLocation <String>] [-RecoveryPoint] <RecoveryPointBase> + [-StorageAccountName] <String> [-StorageAccountResourceGroupName] <String> [-TargetResourceGroupName] <String> + [-UseOriginalStorageAccount] [-RestoreOnlyOSDisk] [-RestoreDiskList <String[]>] [-RestoreToSecondaryRegion] + [-RestoreAsManagedDisk] [-RehydratePriority <String>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-RehydrateDuration <String>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AzureWorkloadParameterSet +``` +Restore-AzRecoveryServicesBackupItem [-VaultLocation <String>] [-WLRecoveryConfig] <RecoveryConfigBase> + [-RestoreToSecondaryRegion] [-RehydratePriority <String>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-RehydrateDuration <String>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +The **Restore-AzRecoveryServicesBackupItem** cmdlet restores the data and configuration for an Azure Backup item to a specified recovery point. + +**For Azure VM backup** + +You can backup Azure virtual machines and restore disks (both managed and un-managed) using this command. The restore operation does not restore the full virtual machine. +If this is a managed disk VM, a target Resource group should be specified where the restored disks are kept. When target resource group is specified, if the snapshots are present in the resource group that was specified in backup policy, the restore operation will be instant and the disks are created from local snapshots and kept in target-resource group. There is also an option to restore them as un-managed disks but this will leverage the data present in Azure recovery services vault and hence will be lot slower. The configuration of the VM and the deployment template which can be used to create VM out of the restored disks will be downloaded to the specified storage account. +If this is an un-managed disk VM, then the snapshots are present in disk's original storage account and/or in the recovery services vault. If user gives an option to use Original storage account to restore, then instant restore can be provided. Otherwise, data is fetched from Azure Recovery services vault and disks are created in specified storage account along with the configuration of the VM and the deployment template. + +> [!IMPORTANT] +> By default, Azure VM backup backs up all disks. You can selectively backup relevant disks using the exclusionList or InclusionList parameters during Enable-Backup. The option to selectively restore disks is available only if one has selectively backed them up. + +Please refer to different possible parameter sets and parameter text for more information. + +> [!NOTE] +> If -VaultId parameter is used then -VaultLocation parameter should be used as well. + +**For Azure File share backup** + +You can restore an entire file share or specific/multiple files/folders on the share. You can restore to the original location or to an alternate location. + +**For Azure Workloads** + +You can restore SQL DBs within Azure VMs + +## EXAMPLES + +### Example 1: Restore the disks of a backed up Managed disk Azure VM from a given recovery point + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$BackupItem = Get-AzRecoveryServicesBackupItem -BackupManagementType "AzureVM" -WorkloadType "AzureVM" -Name "V2VM" -VaultId $vault.ID +$StartDate = (Get-Date).AddDays(-7) +$EndDate = Get-Date +$RP = Get-AzRecoveryServicesBackupRecoveryPoint -Item $BackupItem -StartDate $StartDate.ToUniversalTime() -EndDate $EndDate.ToUniversalTime() -VaultId $vault.ID +$RestoreJob = Restore-AzRecoveryServicesBackupItem -RecoveryPoint $RP[0] -TargetResourceGroupName "Target_RG" -StorageAccountName "DestAccount" -StorageAccountResourceGroupName "DestRG" -VaultId $vault.ID -VaultLocation $vault.Location +``` + +```output +WorkloadName Operation Status StartTime EndTime + ------------ --------- ------ --------- ------- + V2VM Restore InProgress 26-Apr-16 1:14:01 PM 01-Jan-01 12:00:00 AM +``` + +The first command gets the Recovery Services vault and stores it in $vault variable. +The second command gets the Backup item of type AzureVM, of the name "V2VM", and stores it in the $BackupItem variable. +The third command gets the date from seven days earlier, and then stores it in the $StartDate variable. +The fourth command gets the current date, and then stores it in the $EndDate variable. +The fifth command gets a list of recovery points for the specific backup item filtered by $StartDate and $EndDate. +The last command restores all the disks to the target Resource group Target_RG, and then provides the VM configuration information and the deployment template in the storage account DestAccount in the DestRG resource group. + +### Example 2: Restore a Managed AzureVM from a given recovery point to original/alternate location + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$BackupItem = Get-AzRecoveryServicesBackupItem -BackupManagementType "AzureVM" -WorkloadType "AzureVM" -Name "V2VM" -VaultId $vault.ID +$StartDate = (Get-Date).AddDays(-7) +$EndDate = Get-Date +$RP = Get-AzRecoveryServicesBackupRecoveryPoint -Item $BackupItem -StartDate $StartDate.ToUniversalTime() -EndDate $EndDate.ToUniversalTime() -VaultId $vault.ID +$AlternateLocationRestoreJob = Restore-AzRecoveryServicesBackupItem -RecoveryPoint $RP[0] -TargetResourceGroupName "Target_RG" -StorageAccountName "DestStorageAccount" -StorageAccountResourceGroupName "DestStorageAccRG" -TargetVMName "TagetVirtualMachineName" -TargetVNetName "Target_VNet" -TargetVNetResourceGroup "" -TargetSubnetName "subnetName" -VaultId $vault.ID -VaultLocation $vault.Location +$OriginalLocationRestoreJob = Restore-AzRecoveryServicesBackupItem -RecoveryPoint $RP[0] -StorageAccountName "DestStorageAccount" -StorageAccountResourceGroupName "DestStorageAccRG" -VaultId $vault.ID -VaultLocation $vault.Location +``` + +```output +WorkloadName Operation Status StartTime EndTime + ------------ --------- ------ --------- ------- + V2VM Restore InProgress 26-Apr-16 1:14:01 PM 01-Jan-01 12:00:00 AM +``` + +The first command gets the Recovery Services vault and stores it in $vault variable. +The second command gets the Backup item of type AzureVM, of the name "V2VM", and stores it in the $BackupItem variable. +The third command gets the date from seven days earlier, and then stores it in the $StartDate variable. +The fourth command gets the current date, and then stores it in the $EndDate variable. +The fifth command gets a list of recovery points for the specific backup item filtered by $StartDate and $EndDate. +The sixth command triggers an Alternate Location Restore (ALR) to create a new VM in Target_RG resource group as per the inputs specified by parameters TargetVMName, TargetVNetName, TargetVNetResourceGroup, TargetSubnetName. +Alternately, if a user wants to perform an in-place restore to the originally backed up VM in the original location, it can be done with the last command. Please **avoid** using TargetResourceGroupName, RestoreAsUnmanagedDisks, TargetVMName, TargetVNetName, TargetVNetResourceGroup, TargetSubnetName parameters for performing Original Location Restore (OLR). + +### Example 3: Restore specified disks of a backed up Managed disk Azure VM from a given recovery point + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$BackupItem = Get-AzRecoveryServicesBackupItem -BackupManagementType "AzureVM" -WorkloadType "AzureVM" -Name "V2VM" -VaultId $vault.ID +$StartDate = (Get-Date).AddDays(-7) +$EndDate = Get-Date +$RP = Get-AzRecoveryServicesBackupRecoveryPoint -Item $BackupItem -StartDate $StartDate.ToUniversalTime() -EndDate $EndDate.ToUniversalTime() -VaultId $vault.ID +$restoreDiskLUNs = ("0", "1") +$RestoreJob = Restore-AzRecoveryServicesBackupItem -RecoveryPoint $RP[0] -TargetResourceGroupName "Target_RG" -StorageAccountName "DestAccount" -StorageAccountResourceGroupName "DestRG" -RestoreDiskList $restoreDiskLUNs -VaultId $vault.ID -VaultLocation $vault.Location +``` + +```output +WorkloadName Operation Status StartTime EndTime + ------------ --------- ------ --------- ------- + V2VM Restore InProgress 26-Apr-16 1:14:01 PM 01-Jan-01 12:00:00 AM +``` + +The first command gets the Recovery Services vault and stores it in $vault variable. +The second command gets the Backup item of type AzureVM, of the name "V2VM", and stores it in the $BackupItem variable. +The third command gets the date from seven days earlier, and then stores it in the $StartDate variable. +The fourth command gets the current date, and then stores it in the $EndDate variable. +The fifth command gets a list of recovery points for the specific backup item filtered by $StartDate and $EndDate. +The sixth command stores the list of disks to be restored in the restoreDiskLUN variable. +The last command restores the given disks, of the specified LUNs, to the target Resource group Target_RG, and then provides the VM configuration information and the deployment template in the storage account DestAccount in the DestRG resource group. + +### Example 4: Restore disks of a managed VM as unmanaged Disks + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$BackupItem = Get-AzRecoveryServicesBackupItem -BackupManagementType "AzureVM" -WorkloadType "AzureVM" -Name "V2VM" -VaultId $vault.ID +$StartDate = (Get-Date).AddDays(-7) +$EndDate = Get-Date +$RP = Get-AzRecoveryServicesBackupRecoveryPoint -Item $BackupItem[0] -StartDate $StartDate.ToUniversalTime() -EndDate $EndDate.ToUniversalTime() -VaultId $vault.ID +$RestoreJob = Restore-AzRecoveryServicesBackupItem -RecoveryPoint $RP[0] -RestoreAsUnmanagedDisks -StorageAccountName "DestAccount" -StorageAccountResourceGroupName "DestRG" -VaultId $vault.ID -VaultLocation $vault.Location +``` + +```output +WorkloadName Operation Status StartTime EndTime + ------------ --------- ------ --------- ------- + V2VM Restore InProgress 26-Apr-16 1:14:01 PM 01-Jan-01 12:00:00 AM +``` + +The first command gets the RecoveryServices vault and stores it in $vault variable. +The second command gets the Backup item and then stores it in the $BackupItem variable. +The third command gets the date from seven days earlier, and then stores it in the $StartDate variable. +The fourth command gets the current date, and then stores it in the $EndDate variable. +The fifth command gets a list of recovery points for the specific backup item filtered by $StartDate and $EndDate. +The sixth command restores the disks as unmanaged disks. + +### Example 5: Restore an unmanaged VM as unmanaged Disks using original storage account + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$BackupItem = Get-AzRecoveryServicesBackupItem -BackupManagementType AzureVM -WorkloadType AzureVM -Name "UnManagedVM" -VaultId $vault.ID +$StartDate = (Get-Date).AddDays(-7) +$EndDate = Get-Date +$RP = Get-AzRecoveryServicesBackupRecoveryPoint -Item $BackupItem[0] -StartDate $StartDate.ToUniversalTime() -EndDate $EndDate.ToUniversalTime() -VaultId $vault.ID +$RestoreJob = Restore-AzRecoveryServicesBackupItem -RecoveryPoint $RP[0] -UseOriginalStorageAccount -StorageAccountName "DestAccount" -StorageAccountResourceGroupName "DestRG" -VaultId $vault.ID -VaultLocation $vault.Location +``` + +```output +WorkloadName Operation Status StartTime EndTime + ------------ --------- ------ --------- ------- + V2VM Restore InProgress 26-Apr-16 1:14:01 PM 01-Jan-01 12:00:00 AM +``` + +The first command gets the RecoveryServices vault and stores it in $vault variable. +The second command gets the Backup item and then stores it in the $BackupItem variable. +The third command gets the date from seven days earlier, and then stores it in the $StartDate variable. +The fourth command gets the current date, and then stores it in the $EndDate variable. +The fifth command gets a list of recovery points for the specific backup item filtered by $StartDate and $EndDate. +The sixth command restores the disks as unmanaged disks to their original storage accounts + +### Example 6: Restore Multiple files of an AzureFileShare item + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$BackupItem = Get-AzRecoveryServicesBackupItem -BackupManagementType AzureStorage -WorkloadType AzureVM -VaultId $vault.ID -Name "fileshareitem" +$RP = Get-AzRecoveryServicesBackupRecoveryPoint -Item $BackupItem -VaultId $vault.ID +$files = ("file1.txt", "file2.txt") +$RestoreJob = Restore-AzRecoveryServicesBackupItem -RecoveryPoint $RP[0] -MultipleSourceFilePath $files -SourceFileType File -ResolveConflict Overwrite -VaultId $vault.ID -VaultLocation $vault.Location +``` + +```output +WorkloadName Operation Status StartTime EndTime + ------------ --------- ------ --------- ------- + fileshareitem Restore InProgress 26-Apr-16 1:14:01 PM 01-Jan-01 12:00:00 AM +``` + +The first command gets the Recovery Services vault and stores it in $vault variable. +The second command gets the Backup item named fileshareitem and then stores it in the $BackupItem variable. +The third command gets a list of recovery points for the specific backup item. +The fourth command specifies which files to restore and stores it in $files variable. +The last command restores the specified files to its original location. + +### Example 7: Restore a SQL DB within an Azure VM to another target VM for a distinct full recovery point + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$BackupItem = Get-AzRecoveryServicesBackupItem -BackupManagementType AzureWorkload -WorkloadType MSSQL -VaultId $vault.ID -Name "MSSQLSERVER;model" +$StartDate = (Get-Date).AddDays(-7) +$EndDate = Get-Date +$FullRP = Get-AzRecoveryServicesBackupRecoveryPoint -Item $BackupItem -StartDate $StartDate.ToUniversalTime() -EndDate $EndDate.ToUniversalTime() -VaultId $vault.ID +$TargetInstance = Get-AzRecoveryServicesBackupProtectableItem -WorkloadType MSSQL -ItemType SQLInstance -Name "<SQLInstance Name>" -ServerName "<SQL VM name>" -VaultId $vault.ID +$AnotherInstanceWithFullConfig = Get-AzRecoveryServicesBackupWorkloadRecoveryConfig -RecoveryPoint $FullRP -TargetItem $TargetInstance -AlternateWorkloadRestore -VaultId $vault.ID +Restore-AzRecoveryServicesBackupItem -WLRecoveryConfig $AnotherInstanceWithLogConfig -VaultId $vault.ID +``` + +```output +WorkloadName Operation Status StartTime EndTime JobID + ------------ --------- ------ --------- ------- ----- + MSSQLSERVER/m... Restore InProgress 3/17/2019 10:02:45 AM 3274xg2b-e4fg-5952-89b4-8cb566gc1748 +``` + +### Example 8: Restore a SQL DB within an Azure VM to another target VM for a log recovery point + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$BackupItem = Get-AzRecoveryServicesBackupItem -BackupManagementType AzureWorkload -WorkloadType MSSQL -VaultId $vault.ID -Name "MSSQLSERVER;model" +$PointInTime = Get-Date -Date "2019-03-20 01:00:00Z" +$TargetInstance = Get-AzRecoveryServicesBackupProtectableItem -WorkloadType MSSQL -ItemType SQLInstance -Name "<SQLInstance Name>" -ServerName "<SQL VM name>" -VaultId $vault.ID +$AnotherInstanceWithLogConfig = Get-AzRecoveryServicesBackupWorkloadRecoveryConfig -PointInTime $PointInTime -Item $BackupItem -AlternateWorkloadRestore -VaultId $vault.ID +Restore-AzRecoveryServicesBackupItem -WLRecoveryConfig $AnotherInstanceWithLogConfig -VaultId $vault.ID +``` + +```output +WorkloadName Operation Status StartTime EndTime JobID + ------------ --------- ------ --------- ------- ----- + MSSQLSERVER/m... Restore InProgress 3/17/2019 10:02:45 AM 3274xg2b-e4fg-5952-89b4-8cb566gc1748 +``` + +### Example 9: Rehydrate Restore for IaasVM from an archived recovery point + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$item = Get-AzRecoveryServicesBackupItem -BackupManagementType AzureVM -WorkloadType AzureVM -VaultId $vault.ID +$rp = Get-AzRecoveryServicesBackupRecoveryPoint -StartDate (Get-Date).AddDays(-29).ToUniversalTime() -EndDate (Get-Date).AddDays(0).ToUniversalTime() -VaultId $vault.ID -Item $item[3] -Tier VaultArchive +$restoreJob = Restore-AzRecoveryServicesBackupItem -RecoveryPoint $rp[0] -RehydratePriority "Standard" -RehydrateDuration "13" -TargetResourceGroupName "Target_RG" -StorageAccountName "DestAccount" -StorageAccountResourceGroupName "DestRG" -RestoreDiskList $restoreDiskLUNs -VaultId $vault.ID -VaultLocation $vault.Location +``` + +Here we filter the recovery points present in the VaultArchive tier and trigger a restore with rehydration priority and rehydration duration. + +### Example 10: Cross zonal restore for non-ZonePinned VM in a ZRS vault + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$item = Get-AzRecoveryServicesBackupItem -BackupManagementType AzureVM -WorkloadType AzureVM -VaultId $vault.ID +$rp = Get-AzRecoveryServicesBackupRecoveryPoint -StartDate (Get-Date).AddDays(-29).ToUniversalTime() -EndDate (Get-Date).AddDays(0).ToUniversalTime() -VaultId $vault.ID -Item $item[3] -Tier VaultStandard +$restoreJob = Restore-AzRecoveryServicesBackupItem -VaultId $vault.ID -VaultLocation $vault.Location -RecoveryPoint $rp[0] -StorageAccountName "saName" -StorageAccountResourceGroupName $vault.ResourceGroupName -TargetResourceGroupName $vault.ResourceGroupName -TargetVMName "targetVMName" -TargetVNetName "targetVNet" -TargetVNetResourceGroup $vault.ResourceGroupName -TargetSubnetName "default" -TargetZoneNumber 2 +``` + +Here we filter the recovery points present in the VaultStandard tier and trigger a cross zonal restore for non-ZonePinned VM in a ZRS vault. For CZR we pass -TargetZoneNumber parameter. For Non-ZonedPinned VM, CZR is supported only for ZRS vaults. For ZonePinned VMs CZR is supported for ZRS vaults and cross region restore to secondary region for CRR enabled vaults. + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetId + +The DES ID to encrypt the restored disks. + +```yaml +Type: System.String +Parameter Sets: AzureManagedVMReplaceExistingParameterSet, AzureManagedVMCreateNewParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultipleSourceFilePath +Used for Multiple files restore from a file share. The paths of the items to be restored within the file share. + +```yaml +Type: System.String[] +Parameter Sets: AzureFileShareParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPoint + +Specifies the recovery point to which to restore the backup item. +To obtain an **AzureRmRecoveryServicesBackupRecoveryPoint** object, use the **Get-AzRecoveryServicesBackupRecoveryPoint** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase +Parameter Sets: AzureManagedVMReplaceExistingParameterSet, AzureFileShareParameterSet, AzureVMRestoreManagedAsUnmanaged, AzureManagedVMCreateNewParameterSet, AzureVMUnManagedDiskParameterSet, AzureVMRestoreUnmanagedAsManaged +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RehydrateDuration + +Duration in days for which to keep the archived recovery point rehydrated. Value can range from 10 to 30 days, default value is 15 days. + +```yaml +Type: System.String +Parameter Sets: AzureManagedVMReplaceExistingParameterSet, AzureVMRestoreManagedAsUnmanaged, AzureManagedVMCreateNewParameterSet, AzureVMUnManagedDiskParameterSet, AzureVMRestoreUnmanagedAsManaged, AzureWorkloadParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RehydratePriority + +Rehydration priority for an archived recovery point while triggering the restore. Acceptable values are Standard, High. + +```yaml +Type: System.String +Parameter Sets: AzureManagedVMReplaceExistingParameterSet, AzureVMRestoreManagedAsUnmanaged, AzureManagedVMCreateNewParameterSet, AzureVMUnManagedDiskParameterSet, AzureVMRestoreUnmanagedAsManaged, AzureWorkloadParameterSet +Aliases: +Accepted values: Standard, High + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResolveConflict + +In case the restored item also exists in the destination, use this to indicate whether to overwrite or not. +The acceptable values for this parameter are: + +- Overwrite +- Skip + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RestoreFSResolveConflictOption +Parameter Sets: AzureFileShareParameterSet +Aliases: +Accepted values: Overwrite, Skip + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreAsManagedDisk +Use this switch to specify to restore as managed disks. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureVMRestoreUnmanagedAsManaged +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreAsUnmanagedDisks +Use this switch to specify to restore as unmanaged disks + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureVMRestoreManagedAsUnmanaged +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreDiskList +Specify which disks to recover of the backed up VM + +```yaml +Type: System.String[] +Parameter Sets: AzureManagedVMReplaceExistingParameterSet, AzureVMRestoreManagedAsUnmanaged, AzureManagedVMCreateNewParameterSet, AzureVMUnManagedDiskParameterSet, AzureVMRestoreUnmanagedAsManaged +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreOnlyOSDisk +Use this switch to restore only OS disks of a backed up VM + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureManagedVMReplaceExistingParameterSet, AzureVMRestoreManagedAsUnmanaged, AzureManagedVMCreateNewParameterSet, AzureVMUnManagedDiskParameterSet, AzureVMRestoreUnmanagedAsManaged +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreToSecondaryRegion + +Use this switch to trigger the Cross region restore to secondary region. + +```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 +``` + +### -SourceFilePath + +Used for a particular item restore from a file share. The path of the item to be restored within the file share. + +```yaml +Type: System.String +Parameter Sets: AzureFileShareParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceFileType + +Used for a particular item restore from a file share. The type of the item to be restored within the file share. +The acceptable values for this parameter are: + +- File +- Directory + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.SourceFileType] +Parameter Sets: AzureFileShareParameterSet +Aliases: +Accepted values: File, Directory + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName + +Specifies the name of the target Storage account in your subscription. +As a part of the restore process, this cmdlet stores the disks and the configuration information in this Storage account. + +```yaml +Type: System.String +Parameter Sets: AzureManagedVMReplaceExistingParameterSet, AzureVMRestoreManagedAsUnmanaged, AzureManagedVMCreateNewParameterSet, AzureVMUnManagedDiskParameterSet, AzureVMRestoreUnmanagedAsManaged +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceGroupName + +Specifies the name of the resource group that contains the target Storage account in your subscription. +As a part of the restore process, this cmdlet stores the disks and the configuration information in this Storage account. + +```yaml +Type: System.String +Parameter Sets: AzureManagedVMReplaceExistingParameterSet, AzureVMRestoreManagedAsUnmanaged, AzureManagedVMCreateNewParameterSet, AzureVMUnManagedDiskParameterSet, AzureVMRestoreUnmanagedAsManaged +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetFileShareName + +The File Share to which the file share has to be restored to. + +```yaml +Type: System.String +Parameter Sets: AzureFileShareParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetFolder + +The folder under which the file share has to be restored to within the TargetFileShareName. If the backed-up content is to be restored to a root folder, give the target folder values as an empty string. + +```yaml +Type: System.String +Parameter Sets: AzureFileShareParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName + +The resource group to which the managed disks are restored. Applicable to backup of VM with managed disks + +```yaml +Type: System.String +Parameter Sets: AzureManagedVMCreateNewParameterSet, AzureVMRestoreUnmanagedAsManaged +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStorageAccountName + +The storage account to which the file share has to be restored to. + +```yaml +Type: System.String +Parameter Sets: AzureFileShareParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSubnetName +Name of the subnet in which the target VM should be created, in the case of Alternate Location restore to a new VM + +```yaml +Type: System.String +Parameter Sets: AzureManagedVMCreateNewParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSubscriptionId +ID of the target subscription to which the resource should be restored. Use this parameter for Cross subscription restore + +```yaml +Type: System.String +Parameter Sets: AzureManagedVMCreateNewParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMName +Name of the VM to which the data should be restored, in the case of Alternate Location restore to a new VM + +```yaml +Type: System.String +Parameter Sets: AzureManagedVMCreateNewParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVNetName +Name of the VNet in which the target VM should be created, in the case of Alternate Location restore to a new VM + +```yaml +Type: System.String +Parameter Sets: AzureManagedVMCreateNewParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVNetResourceGroup +Name of the resource group which contains the target VNet, in the case of Alternate Location restore to a new VM + +```yaml +Type: System.String +Parameter Sets: AzureManagedVMCreateNewParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetZoneNumber + +The target availability zone number where the restored disks are pinned. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: AzureManagedVMReplaceExistingParameterSet, AzureManagedVMCreateNewParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseOriginalStorageAccount + +Use this switch if the disks from the recovery point are to be restored to their original storage accounts. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureVMUnManagedDiskParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureVMRestoreUnmanagedAsManaged +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +UserAssigned Identity Id to trigger MSI based restore with UserAssigned Identity + +```yaml +Type: System.String +Parameter Sets: AzureManagedVMReplaceExistingParameterSet, AzureManagedVMCreateNewParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseSystemAssignedIdentity +Use this switch to trigger MSI based restore with SystemAssigned Identity + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureManagedVMReplaceExistingParameterSet, AzureManagedVMCreateNewParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId + +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VaultLocation + +Location of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WLRecoveryConfig + +Recovery config + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryConfigBase +Parameter Sets: AzureWorkloadParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase + +## NOTES + +## RELATED LINKS + +[Backup-AzRecoveryServicesBackupItem](./Backup-AzRecoveryServicesBackupItem.md) + +[Get-AzRecoveryServicesBackupItem](./Get-AzRecoveryServicesBackupItem.md) + +[Get-AzRecoveryServicesBackupRecoveryPoint](./Get-AzRecoveryServicesBackupRecoveryPoint.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Resume-AzRecoveryServicesAsrJob.md b/azps-10.1.0/Az.RecoveryServices/Resume-AzRecoveryServicesAsrJob.md new file mode 100644 index 0000000000..5b209553af --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Resume-AzRecoveryServicesAsrJob.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/resume-azrecoveryservicesasrjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Resume-AzRecoveryServicesAsrJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Resume-AzRecoveryServicesAsrJob.md +--- + +# Resume-AzRecoveryServicesAsrJob + +## SYNOPSIS +Resumes a suspended Azure Site Recovery job. + +## SYNTAX + +### ByObject (Default) +``` +Resume-AzRecoveryServicesAsrJob -InputObject <ASRJob> [-Comment <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByName +``` +Resume-AzRecoveryServicesAsrJob -Name <String> [-Comment <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Resume-AzRecoveryServicesAsrJob** cmdlet resumes a suspended Azure Site Recovery job. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Resume-AzRecoveryServicesAsrJob -Job $Job +``` + +Resume the specified job if it is in a waiting or suspended state and return the updated ASR job object corresponding to the ASR job. + +## PARAMETERS + +### -Comment +Comments for the job log. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Comments + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The input object to the cmdlet: The ASR Job object corresponding to the job to be resumed. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob +Parameter Sets: ByObject +Aliases: Job + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the ASR job by name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrJob](./Get-AzRecoveryServicesAsrJob.md) + +[Restart-AzRecoveryServicesAsrJob](./Restart-AzRecoveryServicesAsrJob.md) + +[Stop-AzRecoveryServicesAsrJob](./Stop-AzRecoveryServicesAsrJob.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesAsrAlertSetting.md b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesAsrAlertSetting.md new file mode 100644 index 0000000000..984e96feec --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesAsrAlertSetting.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/set-azrecoveryservicesasralertsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesAsrAlertSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesAsrAlertSetting.md +--- + +# Set-AzRecoveryServicesAsrAlertSetting + +## SYNOPSIS +Configure Azure Site Recovery notification settings (email notification) for the vault. + +## SYNTAX + +### Set (Default) +``` +Set-AzRecoveryServicesAsrAlertSetting [-CustomEmailAddress <String[]>] [-LocaleID <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EmailToSubscriptionOwner +``` +Set-AzRecoveryServicesAsrAlertSetting [-EnableEmailSubscriptionOwner] [-CustomEmailAddress <String[]>] + [-LocaleID <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DisableEmailToSubcriptionOwner +``` +Set-AzRecoveryServicesAsrAlertSetting [-DisableEmailToSubscriptionOwner] [-CustomEmailAddress <String[]>] + [-LocaleID <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Disable +``` +Set-AzRecoveryServicesAsrAlertSetting [-DisableNotification] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzRecoveryServicesAsrNotificationSetting** cmdlet configures Azure Site Recovery notification settings (email notification) for the vault. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzRecoveryServicesAsrAlertSetting -DisableNotification +``` + +```output +CustomEmailAddress EmailSubscriptionOwner Locale +------------------ ---------------------- ------ +{} Off en-US +``` + +Disable notification. + +### Example 2 +```powershell +Set-AzRecoveryServicesAsrAlertSetting -CustomEmailAddress "abcxxxx@xxxx.com" -EnableEmailSubscriptionOwner +``` + +```output +CustomEmailAddress EmailSubscriptionOwner Locale +------------------ ---------------------- ------ +{abcxxxx@xxxx.com} On en-US +``` + +Set notification for custom email address(s) and for subscription owner. + +### Example 3 + +Configure Azure Site Recovery notification settings (email notification) for the vault. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Set-AzRecoveryServicesAsrAlertSetting -CustomEmailAddress 'abcxxxx@xxxx.com' -DisableEmailToSubscriptionOwner +``` + +## PARAMETERS + +### -CustomEmailAddress +Alert / Notification sent to emails. + +```yaml +Type: System.String[] +Parameter Sets: Set, EmailToSubscriptionOwner, DisableEmailToSubcriptionOwner +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableEmailToSubscriptionOwner +Switch parameter specifies enable notification to subscription owner. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DisableEmailToSubcriptionOwner +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableNotification +Flag to disable all notification. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableEmailSubscriptionOwner +Switch parameter specifies enable notification to subscription owner. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EmailToSubscriptionOwner +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocaleID +Email language of alert /notification to user(supported culture codes from microsoft). + +```yaml +Type: System.String +Parameter Sets: Set, EmailToSubscriptionOwner, DisableEmailToSubcriptionOwner +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRAlertSetting + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesAsrReplicationProtectedItem.md b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesAsrReplicationProtectedItem.md new file mode 100644 index 0000000000..d6622bd8db --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesAsrReplicationProtectedItem.md @@ -0,0 +1,749 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/set-azrecoveryservicesasrreplicationprotecteditem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesAsrReplicationProtectedItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesAsrReplicationProtectedItem.md +--- + +# Set-AzRecoveryServicesAsrReplicationProtectedItem + +## SYNOPSIS +Sets recovery properties such as target network and virtual machine size for the specified replication protected item. + +## SYNTAX + +``` +Set-AzRecoveryServicesAsrReplicationProtectedItem -InputObject <ASRReplicationProtectedItem> [-Name <String>] + [-Size <String>] [-UpdateNic <String>] [-RecoveryNetworkId <String>] [-PrimaryNic <String>] + [-RecoveryCloudServiceId <String>] [-RecoveryNicSubnetName <String>] [-RecoveryNicStaticIPAddress <String>] + [-TestNicSubnetName <String>] [-TestNicStaticIPAddress <String>] [-NicSelectionType <String>] + [-RecoveryResourceGroupId <String>] [-LicenseType <String>] [-RecoveryAvailabilitySet <String>] + [-SqlServerLicenseType <String>] + [-RecoveryVmTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-DiskTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-RecoveryNicTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-RecoveryAvailabilityZone <String>] [-RecoveryProximityPlacementGroupId <String>] + [-RecoveryVirtualMachineScaleSetId <String>] [-RecoveryCapacityReservationGroupId <String>] + [-EnableAcceleratedNetworkingOnRecovery] [-RecoveryBootDiagStorageAccountId <String>] + [-AzureToAzureUpdateReplicationConfiguration <ASRAzuretoAzureDiskReplicationConfig[]>] + [-DiskEncryptionVaultId <String>] [-DiskEncryptionSecretUrl <String>] [-KeyEncryptionKeyUrl <String>] + [-KeyEncryptionVaultId <String>] [-UseManagedDisk <String>] + [-DiskIdToDiskEncryptionSetMap <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-RecoveryPublicIPAddressId <String>] [-RecoveryNetworkSecurityGroupId <String>] + [-RecoveryLBBackendAddressPoolId <String[]>] [-TfoAzureVMName <String>] + [-ASRVMNicConfiguration <ASRVMNicConfig[]>] [-TestNetworkId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzRecoveryServicesAsrReplicationProtectedItem** cmdlet sets the recovery properties for a Replication Protected Item. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Set-AzRecoveryServicesAsrReplicationProtectedItem -ReplicationProtectedItem $RPI -UpdateNic $NicId -RecoveryNetworkId $AzureNetworkID -RecoveryNicSubnetName $subnetName +``` + +Starts the operation of updating the replication protected item settings using the specified parameters and returns the ASR job used to track the operation. + +### Example 2 +```powershell +$currentJob = Set-AzRecoveryServicesAsrReplicationProtectedItem -InputObject $rpi -UpdateNic "00:50:56:8F:3F:7B" -RecoveryNetworkId $recoveryNetwork -RecoveryNicSubnetName $recoverySubnet -NicSelectionType NotSelected +``` + +Starts the operation of updating the replication protected item Network Interface card(NIC Reduction) settings using the specified parameters and returns the ASR job used to track the operation. + +### Example 3 +```powershell +$currentJob = Set-AzRecoveryServicesAsrReplicationProtectedItem -InputObject $rpi -PrimaryNic "00:50:56:8F:3F:7B" +``` + +Starts the operation of updating the replication protected item primary NIC(to used for recovered vm )settings using the specified parameters and returns the ASR job used to track the operation. + +### Example 4 +```powershell +Set-AzRecoveryServicesAsrReplicationProtectedItem -InputObject $rpi -UpdateNic $updateNic -RecoveryNetworkId $recoveryNetworkId -RecoveryNicSubnetName $recoveryNicSubnetName -NicSelectionType SelectedByUser +``` + +Starts the operation of updating the replication protected item NIC (to used for recovered vm )settings using the specified parameters and returns the ASR job used to track the operation. + +### Example 5 +```powershell +$currentJob = Set-AzRecoveryServicesAsrReplicationProtectedItem -InputObject $rpi -UpdateNic $updateNic ` + -RecoveryNetworkId $recoveryNetworkId -RecoveryNicSubnetName $recoveryNicSubnetName -EnableAcceleratedNetworkingOnRecovery +``` + +Starts the operation of updating the replication protected item selected noc tp enable accelerated networking on recovery VM(for Azure to Azure disaster recovery). +Don't pass -EnableAcceleratedNetworkingOnRecovery to disable accelerated Networking. + +### Example 6 +```powershell +$currentJob = Set-AzRecoveryServicesAsrReplicationProtectedItem -InputObject $rpi ` + -DiskEncryptionVaultId $DiskEncryptionVaultId -DiskEncryptionSecretUrl $DiskEncryptionSecertUrl ` + -KeyEncryptionVaultId $KeyEncryptionVaultId -KeyEncryptionKeyUrl $KeyEncryptionKeyUrl +``` + +Start the update operation for the specified encrypted replication protected item to use supplied encryption details for failover VM. + +### Example 7 +```powershell +$currentJob = Set-AzRecoveryServicesAsrReplicationProtectedItem -InputObject $rpi -RecoveryProximityPlacementGroupId $ppg +``` + +Start the update operation for the specified replication protected item to use the supplied proximity placement group for failover VM. + +### Example 8 +```powershell +$currentJob = Set-AzRecoveryServicesAsrReplicationProtectedItem -InputObject $rpi -RecoveryVirtualMachineScaleSetId $vmss +``` + +Start the update operation for the specified replication protected item to use the supplied virtual machine scale set for failover VM. + +## PARAMETERS + +### -ASRVMNicConfiguration +Specifies the test failover and failover NIC configuration details. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVMNicConfig[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureToAzureUpdateReplicationConfiguration +Specifies the disk configuration to updated for managed disk Vm (Azure to Azure DR scenrio). + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRAzuretoAzureDiskReplicationConfig[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSecretUrl +Specifies the disk encryption secret URL with version(Azure disk encryption) to be used be recovery VM after failover. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionVaultId +Specifies the disk encryption secret key vault ID(Azure disk encryption) to be used be recovery VM after failover. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskIdToDiskEncryptionSetMap +The dictionary of disk resource Id to disk encryption set ARM Id. + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskTag +Specify the tags for the disks of the VM. This is applicable for Vmware to Azure and HyperV to Azure providers. + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAcceleratedNetworkingOnRecovery +Specifies the specified NIC on recovery vm after failover uses accelerated networking. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The input object to the cmdlet: The ASR replication protected item object corresponding to the replication protected item to update. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: (All) +Aliases: ReplicationProtectedItem + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyUrl +Specifies the disk encryption key URL version(Azure disk encryption) to be used be recovery VM after failover. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionVaultId +Specifies the disk encryption key keyVault ID(Azure disk encryption) to be used be recovery VM after failover. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +Specifiy the license type selection to be used for Windows Server virtual machines. If you are entitled to use the Azure Hybrid Use Benefit (HUB) for migrations and would like to specify that the HUB setting be used while failing over this protected item set the license type to be WindowsServer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: NoLicenseType, WindowsServer + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the recovery virtual machine that will be created on failover. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NicSelectionType +Specifies the network interface card (NIC) properties set by user or set by default. +You can specify NotSelected to go back to the default values. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: NotSelected, SelectedByUser + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryNic +Specifies the NIC which will be used as primary NIC for recovery VM after after failover. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryAvailabilitySet +Availability set for replication protected item after failover. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryAvailabilityZone +Specifies availability zone for replication protected item after failover. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryBootDiagStorageAccountId +Specifies the storage account for boot diagnostics for recovery azure VM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryCapacityReservationGroupId +Specify the capacity reservation group Id to be used by the failover VM in target recovery region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryCloudServiceId +The resource ID of the recovery cloud service to failover this virtual machine to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryLBBackendAddressPoolId +Specifies the target backend address pools to be associated with the recovery NIC. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryNetworkId +Specifies the ID of the Azure virtual network to which the protected item should be failed over. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryNetworkSecurityGroupId +Specifies the ID of the network security group to be associated with the recovery NIC. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryNicStaticIPAddress +Specifies the static IP address that should be assigned to primary NIC on recovery. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryNicSubnetName +Specifies the name of the subnet on the recovery Azure virtual network to which this NIC of the protected item should be connected to on failover. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryNicTag +Specify the tags for the target NICs of the VM. This is applicable for Vmware to Azure and HyperV to Azure providers. + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryProximityPlacementGroupId +Specifies the Resource Id of the recovery proximity placement group to failover teh virtual machine to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPublicIPAddressId +Specifies the ID of the public IP address resource to be associated with the recovery NIC. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryResourceGroupId +The ID of the Azure resource group in the recovery region in which the protected item will be recovered on failover. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryVirtualMachineScaleSetId +Specifies the target virtual machine scale set to be configured. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryVmTag +Specify the tags for target VM. This is applicable for Vmware to Azure and HyperV to Azure providers. + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Size +Specifies the recovery virtual machine size. +The value should be from the set of sizes supported by Azure virtual machines. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlServerLicenseType +Specify the SQL Server license type of the VM. This is applicable for Vmware to Azure and HyperV to Azure providers. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: NoLicenseType, PAYG, AHUB + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNetworkId +Specifies the ARM Id of test network (Applicable only for VMware to Azure replication scenario). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNicStaticIPAddress +Specifies the test static IP address (Applicable only for VMware to Azure replication scenario). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNicSubnetName +Specifies the name of the test subnet (Applicable only for VMware to Azure replication scenario). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TfoAzureVMName +Specifies the name of the test failover VM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateNic +Specifies the NIC of the virtual machine for which this cmdlet sets the recovery network property needs to updated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseManagedDisk +Specifies if the Azure virtual machine that is created on failover should use managed disks. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: True, False + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrReplicationProtectedItem](./Get-AzRecoveryServicesAsrReplicationProtectedItem.md) + +[New-AzRecoveryServicesAsrReplicationProtectedItem](./New-AzRecoveryServicesAsrReplicationProtectedItem.md) + +[Remove-AzRecoveryServicesAsrReplicationProtectedItem](./Remove-AzRecoveryServicesAsrReplicationProtectedItem.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesAsrVaultContext.md b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesAsrVaultContext.md new file mode 100644 index 0000000000..90dcdfb547 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesAsrVaultContext.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/set-azrecoveryservicesasrvaultcontext +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesAsrVaultContext.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesAsrVaultContext.md +--- + +# Set-AzRecoveryServicesAsrVaultContext + +## SYNOPSIS +Sets the Recovery Services vault context to be used for subsequent Azure Site Recovery operations in the current PowerShell session. + +## SYNTAX + +``` +Set-AzRecoveryServicesAsrVaultContext -Vault <ARSVault> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzRecoveryServicesAsrVaultContext** cmdlet sets the Azure Site Recovery vault context for further operations. + +## EXAMPLES + +### Example 1 +```powershell +$vaultSettings = Set-AzRecoveryServicesAsrVaultContext -Vault $RecoveryServicesVault +``` + +Sets the vault context to the specified Recovery Services vault for subsequent Azure Site Recovery operations in the current PowerShell session. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vault +The Recovery Services vault object corresponding to the Recovery Services vault. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.ARSVault + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVaultSettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesBackupProperty.md b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesBackupProperty.md new file mode 100644 index 0000000000..de98e745e4 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesBackupProperty.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: C635D723-0F03-4EF8-9435-24DBE0859899 +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/set-azrecoveryservicesbackupproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesBackupProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesBackupProperty.md +--- + +# Set-AzRecoveryServicesBackupProperty + +## SYNOPSIS +Sets the properties for backup management. + +## SYNTAX + +``` +Set-AzRecoveryServicesBackupProperty -Vault <ARSVault> + [-BackupStorageRedundancy <AzureRmRecoveryServicesBackupStorageRedundancyType>] [-EnableCrossRegionRestore] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzRecoveryServicesBackupProperty** cmdlet sets backup storage properties for a Recovery Services vault. + +## EXAMPLES + +### Example 1: Set GeoRedundant storage for a vault +```powershell +$Vault01 = Get-AzRecoveryServicesVault -Name "TestVault" +Set-AzRecoveryServicesBackupProperty -Vault $Vault01 -BackupStorageRedundancy GeoRedundant +``` + +The first command gets the vault named TestVault, and then stores it in the $Vault01 variable. +The second command sets the backup storage redundancy for $Vault01 to GeoRedundant. + +## PARAMETERS + +### -BackupStorageRedundancy +Specifies the backup storage redundancy type. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.AzureRmRecoveryServicesBackupStorageRedundancyType] +Parameter Sets: (All) +Aliases: +Accepted values: GeoRedundant, ZoneRedundant, LocallyRedundant + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCrossRegionRestore +Enable CRR on a vault. Please make sure to set BackupStorageRedundancy to GeoRedundant before enabling CRR. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vault +Specifies the name of the vault. +The vault must be an **AzureRmRecoveryServicesVault** object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.ARSVault + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupProperty](./Get-AzRecoveryServicesBackupProperty.md) + +[Get-AzRecoveryServicesVault](./Get-AzRecoveryServicesVault.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesBackupProtectionPolicy.md b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesBackupProtectionPolicy.md new file mode 100644 index 0000000000..94a1a6a482 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesBackupProtectionPolicy.md @@ -0,0 +1,331 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: D614B509-82DD-42FB-B975-D72CD3355E3E +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/set-azrecoveryservicesbackupprotectionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesBackupProtectionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesBackupProtectionPolicy.md +--- + +# Set-AzRecoveryServicesBackupProtectionPolicy + +## SYNOPSIS +Modifies a Backup protection policy. + +## SYNTAX + +### ModifyPolicyParamSet +``` +Set-AzRecoveryServicesBackupProtectionPolicy [-Policy] <PolicyBase> [[-RetentionPolicy] <RetentionPolicyBase>] + [[-SchedulePolicy] <SchedulePolicyBase>] [-MoveToArchiveTier <Boolean>] [-TieringMode <TieringMode>] + [-TierAfterDuration <Int32>] [-TierAfterDurationType <String>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-Token <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FixPolicyParamSet +``` +Set-AzRecoveryServicesBackupProtectionPolicy [-Policy] <PolicyBase> [-FixForInconsistentItems] + [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzRecoveryServicesBackupProtectionPolicy** cmdlet modifies an existing Azure Backup protection policy. +You can modify the Backup schedule and retention policy components. +Any changes you make affect the backup and retention of the items associated with the policy. +Set the vault context by using the Set-AzRecoveryServicesVaultContext cmdlet before you use the current cmdlet. + +## EXAMPLES + +### Example 1: Modify a Backup protection policy +```powershell +$SchPol = Get-AzRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM" +$SchPol.ScheduleRunTimes.Clear() +$Time = Get-Date +$Time1 = Get-Date -Year $Time.Year -Month $Time.Month -Day $Time.Day -Hour $Time.Hour -Minute 0 -Second 0 -Millisecond 0 +$Time1 = $Time1.ToUniversalTime() +$SchPol.ScheduleRunTimes.Add($Time1) +$SchPol.ScheduleRunFrequency.Clear +$SchPol.ScheduleRunDays.Add("Monday") +$SchPol.ScheduleRunFrequency="Weekly" +$RetPol = Get-AzRecoveryServicesBackupRetentionPolicyObject -WorkloadType "AzureVM" +$RetPol.IsDailyScheduleEnabled=$false +$RetPol.DailySchedule.DurationCountInDays = 0 +$RetPol.IsWeeklyScheduleEnabled=$true +$RetPol.WeeklySchedule.DaysOfTheWeek.Add("Monday") +$RetPol.WeeklySchedule.DurationCountInWeeks = 365 +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "azurefiles" -Name "azurefilesvault" +$Pol= Get-AzRecoveryServicesBackupProtectionPolicy -Name "TestPolicy" -VaultId $vault.ID +$Pol.SnapshotRetentionInDays=5 +Set-AzRecoveryServicesBackupProtectionPolicy -Policy $Pol -SchedulePolicy $SchPol -RetentionPolicy $RetPol +``` + +Here is the high-level description of the steps to be followed for modifying a protection policy: +1. Get a base SchedulePolicyObject and base RetentionPolicyObject. Store them in some variable. +2. Set the different parameters of schedule and retention policy object as per your requirement. For example- In the above sample script, we are trying to set a weekly protection policy. Hence, we changed the schedule frequency to "Weekly" and also updated the schedule run time. In the retention policy object, we updated the weekly retention duration and set the correct "weekly schedule enabled" flag. In case you want to set a Daily policy, set the "daily schedule enabled" flag to true and assign appropriate values for other object parameters. +3. Get the backup protection policy that you want to modify and store it in a variable. In the above example, we retrieved the backup policy with the name "TestPolicy" that we wanted to modify. +4. Modify the backup protection policy retrieved in step 3 using the modified schedule policy object and retention policy object. + +### Example 2: Modify Azure fileshare policy for multiple backups per day +```powershell +$schedulePolicy = Get-AzRecoveryServicesBackupSchedulePolicyObject -WorkloadType AzureFiles -BackupManagementType AzureStorage -ScheduleRunFrequency Hourly +$retentionPolicy = Get-AzRecoveryServicesBackupRetentionPolicyObject -WorkloadType AzureFiles -BackupManagementType AzureStorage -ScheduleRunFrequency Hourly +$timeZone = Get-TimeZone +$schedulePolicy.ScheduleRunTimeZone = $timeZone.Id +$startTime = Get-Date -Date "2021-12-22T06:00:00.00+00:00" +$schedulePolicy.ScheduleWindowStartTime = $startTime.ToUniversalTime() +$schedulePolicy.ScheduleInterval = 6 +$schedulePolicy.ScheduleWindowDuration = 14 +$retentionPolicy.DailySchedule.DurationCountInDays = 6 +$policy = Get-AzRecoveryServicesBackupProtectionPolicy -Name "TestPolicy" -VaultId $vault.ID +Set-AzRecoveryServicesBackupProtectionPolicy -Policy $policy -VaultId $vault.ID -SchedulePolicy $schedulePolicy -RetentionPolicy $retentionPolicy +``` + +Here is the high-level description of the steps to be followed for modifying a fileshare policy for multiple backups per day: +1. Get a base hourly SchedulePolicyObject and base hourly RetentionPolicyObject. Store them in some variable. +2. Set the different parameters of schedule and retention policy object as per your requirement. For example- In the above sample script, we are trying to set the $timeZone in which we want to run the schedule we are setting the start time of the Hourly schedule, setting hourly interval (in hours), after which the backup will be retriggered on the same day, duration (in hours) for which the schedule will run. Next we are modifying the retention setting for daily recovery points. +3. Get the backup protection policy that you want to modify and store it in a variable. In the above example, we retrieved the backup policy with the name "TestPolicy" that we wanted to modify. +4. Modify the backup protection policy retrieved in step 3 using the modified schedule policy object and retention policy object. + +### Example 3: Modify AzureWorkload policy to enable Archive smart tiering +```powershell +$pol = Set-AzRecoveryServicesBackupProtectionPolicy -VaultId $vault.ID -Policy $policy -MoveToArchiveTier $true -TieringMode TierAllEligible -TierAfterDuration 60 -TierAfterDurationType Days +``` + +This command is used to modify policy to enable archive smart tiering for the policy $policy, we set -MoveToArchiveTier parameter to $true to enable tiering. We choose TieringMode to be TierAllEligible to move all eligible recovery points to archive after certain duration given by TierAfterDuration and TierAfterDurationType parameters. In order to move recommended recovery points to Archive for AzureVM use TieringMode TierRecommended. + +### Example 4: Disable smart tiering on an existing policy +```powershell +$pol = Set-AzRecoveryServicesBackupProtectionPolicy -VaultId $vault.ID -Policy $policy -MoveToArchiveTier $false +``` + +This command is used to disable archive smart tiering for the policy $policy, we set -MoveToArchiveTier parameter to $false. Please note that disabling archive smart tiering might have cost implications. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FixForInconsistentItems +Switch Parameter indicating whether or not to retry Policy Update for failed items. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FixPolicyParamSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveToArchiveTier +Specifies whether recovery points should be moved to archive storage by the policy or not. Allowed values are $true, $false + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: ModifyPolicyParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the Backup protection policy that this cmdlet modifies. +To obtain a **BackupProtectionPolicy** object, use the Get-AzRecoveryServicesBackupProtectionPolicy cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RetentionPolicy +Specifies the base retention policy. +To obtain a **RetentionPolicy** object, use the Get-AzRecoveryServicesBackupRetentionPolicyObject cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RetentionPolicyBase +Parameter Sets: ModifyPolicyParamSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchedulePolicy +Specifies the base schedule policy object. +To obtain a **SchedulePolicy** object, use the Get-AzRecoveryServicesBackupSchedulePolicyObject object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.SchedulePolicyBase +Parameter Sets: ModifyPolicyParamSet +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TierAfterDuration +Specifies the duration after which recovery points should start moving to the archive tier, value can be in days or months. Applicable only when TieringMode is TierAllEligible + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: ModifyPolicyParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TierAfterDurationType +Specifies whether the TierAfterDuration is in Days or Months + +```yaml +Type: System.String +Parameter Sets: ModifyPolicyParamSet +Aliases: +Accepted values: Days, Months + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TieringMode +Specifies whether to move recommended or all eligible recovery points to archive + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.TieringMode +Parameter Sets: ModifyPolicyParamSet +Aliases: +Accepted values: TierRecommended, TierAllEligible + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Token +Auxiliary access token for authenticating critical operation to resource guard subscription + +```yaml +Type: System.String +Parameter Sets: ModifyPolicyParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupProtectionPolicy](./Get-AzRecoveryServicesBackupProtectionPolicy.md) + +[Get-AzRecoveryServicesBackupRetentionPolicyObject](./Get-AzRecoveryServicesBackupRetentionPolicyObject.md) + +[New-AzRecoveryServicesBackupProtectionPolicy](./New-AzRecoveryServicesBackupProtectionPolicy.md) + +[Remove-AzRecoveryServicesBackupProtectionPolicy](./Remove-AzRecoveryServicesBackupProtectionPolicy.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesResourceGuardMapping.md b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesResourceGuardMapping.md new file mode 100644 index 0000000000..a0bf772886 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesResourceGuardMapping.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/set-azrecoveryservicesresourceguardmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesResourceGuardMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesResourceGuardMapping.md +--- + +# Set-AzRecoveryServicesResourceGuardMapping + +## SYNOPSIS +Sets the resource guard mapping to the recovery services vault. + +## SYNTAX + +``` +Set-AzRecoveryServicesResourceGuardMapping [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + -ResourceGuardId <String> [-Token <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets the resource guard mapping to the recovery services vault. This cmdlet creates a mapping between the RS vault and Resource guard, after this cmdlet is run, sensitive operations are protected by the resource guard as per MUA. + +## EXAMPLES + +### Example 1 Create a resource guard mapping in a cross tenant scenario + +```powershell +$token = (Get-AzAccessToken -TenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx").Token +Set-AzRecoveryServicesResourceGuardMapping -VaultId $vault.ID -ResourceGuardId "Resource-Guard-Id" -Token $token +``` + +The first command fetches the access token for the resource guard tenant where the resource guard is present. The second command creates a mapping between the RSVault $vault and Resource guard. Please note that token parameter is optional and only needed to authenticate cross tenant protected opeartions. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGuardId +ResourceGuardId of the ResourceGuard to be mapped with RecoveryServicesVault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Token +Auxiliary access token for authenticating critical operation to resource guard subscription + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.RecoveryServices.Backup.Models.ResourceGuardProxyBaseResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesVaultContext.md b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesVaultContext.md new file mode 100644 index 0000000000..dd72a06c92 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesVaultContext.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: 368DD95E-EA25-4FC4-8171-CB7348FE480C +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/set-azrecoveryservicesvaultcontext +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesVaultContext.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesVaultContext.md +--- + +# Set-AzRecoveryServicesVaultContext + +## SYNOPSIS + +Sets vault context. + +## SYNTAX + +``` +Set-AzRecoveryServicesVaultContext -Vault <ARSVault> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION + +The **Set-AzRecoveryServicesVaultContext** cmdlet sets the vault context for Azure Site Recovery services. + +Warning: This cmdlet is being deprecated in a future breaking change release. There will be no replacement for it. Please use the -VaultId parameter in all Recovery Services commands going forward. + +## EXAMPLES + +### Example 1 + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +Set-AzRecoveryServicesVaultContext -Vault $vault +``` + +Sets vault context. + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vault + +Specifies the name of the vault. +The vault must be an **AzureRmRecoveryServicesVault** object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.ARSVault + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesVaultProperty.md b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesVaultProperty.md new file mode 100644 index 0000000000..f796fa9a24 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Set-AzRecoveryServicesVaultProperty.md @@ -0,0 +1,284 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: C2A7F37B-5713-4430-B83F-C6745692396D +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/set-azrecoveryservicesvaultproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesVaultProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Set-AzRecoveryServicesVaultProperty.md +--- + +# Set-AzRecoveryServicesVaultProperty + +## SYNOPSIS +Updates properties of a Vault. + +## SYNTAX + +### AzureRSVaultSoftDelteParameterSet (Default) +``` +Set-AzRecoveryServicesVaultProperty [-SoftDeleteFeatureState <String>] + [-DisableHybridBackupSecurityFeature <Boolean>] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + [-Token <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureRSVaultCMKParameterSet +``` +Set-AzRecoveryServicesVaultProperty [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] + -EncryptionKeyId <String> [-KeyVaultSubscriptionId <String>] [-InfrastructureEncryption] + [-UseSystemAssignedIdentity <Boolean>] [-UserAssignedIdentity <String>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzRecoveryServicesVaultProperty** cmdlet updates properties of a Recovery services vault. This cmdlet can be used to enable/disable soft delete or set CMK encryption for a vault with two different parameter sets. +**SoftDeleteFeatureState** property of a vault can be disabled only if there are no registered containers in the vault. InfrastructurEncryption can only be set the first time a user updates the CMK vault. + +## EXAMPLES + +### Example 1: Update SoftDeleteFeatureState of a vault +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "rgName" -Name "vaultName" +$props = Set-AzRecoveryServicesVaultProperty -VaultId $vault.Id -SoftDeleteFeatureState Enable +``` + +The first command gets a Vault object and then stores it in the $vault variable. +The second command Updates the SoftDeleteFeatureState property of the vault to "Enabled" state. + +### Example 2: Update CMK encryption of a vault to use SystemAssigned MSIdentity + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "rgName" -Name "vaultName" +$keyVault = Get-AzKeyVault -VaultName "keyVaultName" -ResourceGroupName "RGName" +$key = Get-AzKeyVaultKey -VaultName "keyVaultName" -Name "keyName" +Set-AzRecoveryServicesVaultProperty -EncryptionKeyId $key.ID -InfrastructureEncryption -VaultId $vault.ID -UseSystemAssignedIdentity $true +``` + +First cmdlet gets the RSVault to update encryption properties. Second cmdlet gets the azure key vault. Third cmdlet gets the key from the key vault. +Fourth cmdlet updates the customer managed encryption key within the RSVault to be accessed via SystemAssigned identity. Use -InfrastructureEncryption param to enable infrastructure encryption for the first time update. + +### Example 3: Update CMK encryption of a vault to use userAssigned MSIdentity + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "rgName" -Name "vaultName" +$keyVault = Get-AzKeyVault -VaultName "keyVaultName" -ResourceGroupName "RGName" +$key = Get-AzKeyVaultKey -VaultName "keyVaultName" -Name "keyName" +Set-AzRecoveryServicesVaultProperty -EncryptionKeyId $key.ID -VaultId $vault.ID -UseSystemAssignedIdentity $false -UserAssignedIdentity $vault.Identity.UserAssignedIdentities.Keys[0] +``` + +First cmdlet gets the RSVault to update encryption properties. Second cmdlet gets the azure key vault. Third cmdlet gets the key from the key vault. +Fourth cmdlet updates the customer managed encryption key within the RSVault to be accessed via UserAssigned identity. + +### Example 4: Update HybridBackupSecurityFeature of a vault + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "rgName" -Name "vaultName" +$prop = Set-AzRecoveryServicesVaultProperty -VaultId $vault.Id -DisableHybridBackupSecurityFeature $false +``` + +The first command gets a Vault object and then stores it in the $vault variable. +The second command disables the HybridBackupSecurityFeature of the vault, set $true to enable it again. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableHybridBackupSecurityFeature +Optional flag ($true/$false) to disable/enable security setting for hybrid backups against accidental deletes and add additional layer of authentication for critical operations. Provide $false to enable the security. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: AzureRSVaultSoftDelteParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyId +KeyId of the encryption key to be used for CMK. + +```yaml +Type: System.String +Parameter Sets: AzureRSVaultCMKParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InfrastructureEncryption +Enables infrastructure encryption on this vault. Infrastructure encryption must be enabled when configuring encryption. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureRSVaultCMKParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultSubscriptionId +Subscription Id of the Key Vault. + +```yaml +Type: System.String +Parameter Sets: AzureRSVaultCMKParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeleteFeatureState +SoftDeleteFeatureState of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: AzureRSVaultSoftDelteParameterSet +Aliases: +Accepted values: Enable, Disable + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Token +Auxiliary access token for authenticating critical operation to resource guard subscription + +```yaml +Type: System.String +Parameter Sets: AzureRSVaultSoftDelteParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +ARM Id of UserAssigned Identity to be used for CMK encryption. Provide this parameter if UseSystemAssignedIdentity is $false. + +```yaml +Type: System.String +Parameter Sets: AzureRSVaultCMKParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseSystemAssignedIdentity +Boolean flag to indicate if SystemAssigned Identity will be used for CMK encryption. Accepted Vaules: $true, $false + +```yaml +Type: System.Boolean +Parameter Sets: AzureRSVaultCMKParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.VaultSoftDeleteFeatureState + +## OUTPUTS + +### Microsoft.Azure.Management.RecoveryServices.Backup.Models.BackupResourceVaultConfigResource + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesVault](./Get-AzRecoveryServicesVault.md) + +[Get-AzRecoveryServicesVaultProperty](./Get-AzRecoveryServicesVaultProperty.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrApplyRecoveryPoint.md b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrApplyRecoveryPoint.md new file mode 100644 index 0000000000..d6826ba0ca --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrApplyRecoveryPoint.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/start-azrecoveryservicesasrapplyrecoverypoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrApplyRecoveryPoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrApplyRecoveryPoint.md +--- + +# Start-AzRecoveryServicesAsrApplyRecoveryPoint + +## SYNOPSIS +Changes a recovery point for a failed over protected item before committing the failover operation. + +## SYNTAX + +``` +Start-AzRecoveryServicesAsrApplyRecoveryPoint -RecoveryPoint <ASRRecoveryPoint> + -ReplicationProtectedItem <ASRReplicationProtectedItem> [-DataEncryptionPrimaryCertFile <String>] + [-DataEncryptionSecondaryCertFile <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzRecoveryServicesAsrApplyRecoveryPoint** changes the recovery point for a failed over protected item before it commits the failover operation. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Start-AzRecoveryServicesAsrApplyRecoveryPoint -RecoveryPoint $RecoveryPoint -ReplicationProtectedItem $RPI +``` + +Starts applying the specified recovery point to the replication protected item and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DataEncryptionPrimaryCertFile +Specifies the primary certificate file if data encryption is being used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionSecondaryCertFile +Specifies the secondary certificate file if data encryption is being used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPoint +Specifies the recovery point object corresponding to the recovery point to be applied. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPoint +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +Specifies the ASR replication protected item object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Azure Recovery Services cmdlets](/powershell/module/az.recoveryservices) diff --git a/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrCancelFailoverJob.md b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrCancelFailoverJob.md new file mode 100644 index 0000000000..86556cc0f7 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrCancelFailoverJob.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/start-azrecoveryservicesasrcancelfailoverjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrCancelFailoverJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrCancelFailoverJob.md +--- + +# Start-AzRecoveryServicesAsrCancelFailoverJob + +## SYNOPSIS +Starts the cancel failover action for a Site Recovery object. + +## SYNTAX + +### ByRPIObject (Default) +``` +Start-AzRecoveryServicesAsrCancelFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRPObject +``` +Start-AzRecoveryServicesAsrCancelFailoverJob -RecoveryPlan <ASRRecoveryPlan> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzRecoveryServicesAsrCancelFailoverJob** cmdlet starts the cancel failover process for an Azure Site Recovery object. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Start-AzRecoveryServicesAsrCancelFailoverJob -RecoveryPlan $RP +``` + +Starts the cancel failover for the specified recovery plan and returns the ASR job used to track the operation. + +### Example 2 + +Starts the cancel failover action for a Site Recovery object. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Start-AzRecoveryServicesAsrCancelFailoverJob -ReplicationProtectedItem $ReplicationProtectedItem +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPlan +Specifies an ASR recovery plan object corresponding to recovery plan to be failovered. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan +Parameter Sets: ByRPObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +Specifies an ASR replication protected item object corresponding to replication protected item to be failovered. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: ByRPIObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrCommitFailoverJob.md b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrCommitFailoverJob.md new file mode 100644 index 0000000000..47ccf774de --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrCommitFailoverJob.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/start-azrecoveryservicesasrcommitfailoverjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrCommitFailoverJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrCommitFailoverJob.md +--- + +# Start-AzRecoveryServicesAsrCommitFailoverJob + +## SYNOPSIS +Starts the commit failover action for a Site Recovery object. + +## SYNTAX + +### ByRPIObject (Default) +``` +Start-AzRecoveryServicesAsrCommitFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRPObject +``` +Start-AzRecoveryServicesAsrCommitFailoverJob -RecoveryPlan <ASRRecoveryPlan> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzRecoveryServicesAsrCommitFailoverJob** cmdlet starts the commit failover process for an Azure Site Recovery object after a failover operation. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Start-AzRecoveryServicesAsrCommitFailoverJob -RecoveryPlan $RP +``` + +Starts the commit failover for the specified recovery plan and returns the ASR job used to track the operation. + +### Example 2 + +Starts the commit failover action for a Site Recovery object. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Start-AzRecoveryServicesAsrCommitFailoverJob -ReplicationProtectedItem $ReplicationProtectedItem +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPlan +Specifies an ASR recovery plan object corresponding to recovery plan to be failovered. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan +Parameter Sets: ByRPObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +Specifies an ASR replication protected item object corresponding to replication protected item to be failovered. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: ByRPIObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrPlannedFailoverJob.md b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrPlannedFailoverJob.md new file mode 100644 index 0000000000..778af5e8b4 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrPlannedFailoverJob.md @@ -0,0 +1,294 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/start-azrecoveryservicesasrplannedfailoverjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrPlannedFailoverJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrPlannedFailoverJob.md +--- + +# Start-AzRecoveryServicesAsrPlannedFailoverJob + +## SYNOPSIS +Starts a planned failover operation. + +## SYNTAX + +### ByRPIObject (Default) +``` +Start-AzRecoveryServicesAsrPlannedFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> + -Direction <String> [-Optimize <String>] [-CreateVmIfNotFound <String>] + [-ServicesProvider <ASRRecoveryServicesProvider>] [-DataEncryptionPrimaryCertFile <String>] + [-DataEncryptionSecondaryCertFile <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByRPObject +``` +Start-AzRecoveryServicesAsrPlannedFailoverJob -RecoveryPlan <ASRRecoveryPlan> -Direction <String> + [-Optimize <String>] [-CreateVmIfNotFound <String>] [-DataEncryptionPrimaryCertFile <String>] + [-DataEncryptionSecondaryCertFile <String>] [-MultiVmSyncPoint <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRPIObjectWithRecoveryTag +``` +Start-AzRecoveryServicesAsrPlannedFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> + -Direction <String> [-Optimize <String>] [-CreateVmIfNotFound <String>] + [-DataEncryptionPrimaryCertFile <String>] [-DataEncryptionSecondaryCertFile <String>] -RecoveryTag <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzRecoveryServicesAsrPlannedFailoverJob** cmdlet starts a planned failover for an Azure Site Recovery replication protected item or recovery plan. +You can check whether the job succeeds by using the Get-AzRecoveryServicesAsrJob cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Start-AzRecoveryServicesAsrPlannedFailoverJob -RecoveryPlan $RP -Direction PrimaryToRecovery +``` + +Starts the planned failover for the specified ASR recovery plan and returns the ASR job used to track the operation. + +## PARAMETERS + +### -CreateVmIfNotFound +Create the virtual machine if not found while failing back to the primary region (used in alternate location recovery.) The acceptable values for this parameter are: + +- Yes +- No + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Yes, No + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionPrimaryCertFile +Specifies the primary certificate file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionSecondaryCertFile +Specifies the secondary certificate file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Specifies the direction of the failover. +The acceptable values for this parameter are: + +- PrimaryToRecovery +- RecoveryToPrimary + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: PrimaryToRecovery, RecoveryToPrimary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiVmSyncPoint +Specifies whether to enable multi VM sync points for failover of multi VM sync enabled VMs (Applicable only for VMware to Azure replication scenario). + +```yaml +Type: System.String +Parameter Sets: ByRPObject +Aliases: +Accepted values: Enable, Disable + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Optimize +Specifies what to optimize for. +This parameter applies when failover is done from an Azure site to an on-premise site which requires substantial data synchronization. +Valid values are: + +- ForDowntime +- ForSynchronization + +When **ForDowntime** is specified, this indicates that data is synchronized before failover to minimize downtime. +Synchronization is performed without shutting down the virtual machine. +After synchronization is complete, the job is suspended. +Resume the job to do an additional synchronization operation that shuts down the virtual machine. + +When **ForSynchronization** is specified, this indicates that data is synchronized during failover only so data synchronization is minimized. +With this setting enabled, the virtual machine is shut down immediately. +Synchronization starts after shutdown to complete the failover operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: ForDownTime, ForSynchronization + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPlan +Specifies the ASR Recovery plan object corresponding to the recovery plan to be failed over. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan +Parameter Sets: ByRPObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RecoveryTag +Specifies the recovery tag: RecoveryTagApplicationConsistent, RecoveryTagCrashConsistent (Applicable only for VMware to Azure replication scenario). + +```yaml +Type: System.String +Parameter Sets: ByRPIObjectWithRecoveryTag +Aliases: +Accepted values: RecoveryTagApplicationConsistent, RecoveryTagCrashConsistent + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +Specifies the ASR replication protected item object corresponding to the replication protected item to be failed over. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: ByRPIObject, ByRPIObjectWithRecoveryTag +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ServicesProvider +Identifies the host to on which to create the virtual machine while failing over to an alternate location by specifying the ASR services provider object corresponding to the ASR services provider running on the host. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryServicesProvider +Parameter Sets: ByRPIObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrResynchronizeReplicationJob.md b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrResynchronizeReplicationJob.md new file mode 100644 index 0000000000..0dac82a2f7 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrResynchronizeReplicationJob.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/start-azrecoveryservicesasrresynchronizereplicationjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrResynchronizeReplicationJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrResynchronizeReplicationJob.md +--- + +# Start-AzRecoveryServicesAsrResynchronizeReplicationJob + +## SYNOPSIS +Starts replication resynchronization. + +## SYNTAX + +### Default (Default) +``` +Start-AzRecoveryServicesAsrResynchronizeReplicationJob -ReplicationProtectedItem <ASRReplicationProtectedItem> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Start-AzRecoveryServicesAsrResynchronizeReplicationJob -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzRecoveryServicesAsrResynchronizeReplicationJob** cmdlet start resynchronization of replication for the specified protected item if the protected is in a resynchronization required state. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzRecoveryServicesAsrResynchronizeReplicationJob -ReplicationProtectedItem $rpi +``` + +Starts job to resynchronize replication on passed replication protected item. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +ASR replication protected item to resynchronize replication for. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: Default +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id of replication protected item to resynchronize. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrSwitchAppliance.md b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrSwitchAppliance.md new file mode 100644 index 0000000000..6687a8d4ac --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrSwitchAppliance.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/start-azrecoveryservicesasrswitchappliance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrSwitchAppliance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrSwitchAppliance.md +--- + +# Start-AzRecoveryServicesAsrSwitchAppliance + +## SYNOPSIS +Starts the switch appliance action for a Site Recovery object. + +## SYNTAX + +``` +Start-AzRecoveryServicesAsrSwitchAppliance -Fabric <ASRFabric> + -ReplicationProtectedItem <ASRReplicationProtectedItem> -TargetApplianceName <String> + [-CredentialsToAccessVm <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzRecoveryServicesAsrSwitchAppliance** cmdlet starts the switch appliance process for an Azure Site Recovery object. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Start-AzRecoveryServicesAsrSwitchAppliance -Fabric $Fabric ` +-ReplicationProtectedItem $RPI -TargetApplianceName $TargetApplianceName +``` + +Starts the switch appliance for the specified replicated protected item and returns the ASR job used to track the operation. + +## PARAMETERS + +### -CredentialsToAccessVm +Specifies the name of credentials to be used to push install the Mobility service on source machine if needed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fabric +Specifies the ASR Fabric object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +Specifies an ASR replication protected item object to be switched to new appliance. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: (All) +Aliases: ReplicatedItem + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TargetApplianceName +Specifies the name of appliance to be used to replicate this machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrSwitchProcessServerJob.md b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrSwitchProcessServerJob.md new file mode 100644 index 0000000000..ac3b588786 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrSwitchProcessServerJob.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/start-azrecoveryservicesasrswitchprocessserverjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrSwitchProcessServerJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrSwitchProcessServerJob.md +--- + +# Start-AzRecoveryServicesAsrSwitchProcessServerJob + +## SYNOPSIS +Switch replication from one Process server to another for load balancing. + +## SYNTAX + +``` +Start-AzRecoveryServicesAsrSwitchProcessServerJob -Fabric <ASRFabric> -SourceProcessServer <ASRProcessServer> + -TargetProcessServer <ASRProcessServer> [-ReplicationProtectedItem <ASRReplicationProtectedItem[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzRecoveryServicesAsrSwitchProcessServerJob** switches replication data movement for the specified virtual machines or a specified Process server to the specified target Process server. Used for load balancing or switching replication between Process servers. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzRecoveryServicesAsrSwitchProcessServerJob -Fabric $fabric -SourceProcessServer $sourceProcessServer -TargetProcessServer $TargetProcessServer +``` + +Job to track switching process server for all replication protected item from source to target process server. + +### Example 2 +```powershell +Start-AzRecoveryServicesAsrSwitchProcessServerJob -Fabric $fabric -SourceProcessServer $sourceProcessServer -TargetProcessServer $TargetProcessServer -ReplicatedItem $rpList +``` + +Job to track switching process server for passed replication protected item from source to target process server. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fabric +Site recovery fabric corresponding to the Configuration Server. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: (All) +Aliases: ConfigServer + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +List of replication protected item whose process server to be switched. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem[] +Parameter Sets: (All) +Aliases: ReplicatedItem + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceProcessServer +The Process server to switch replication out from. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProcessServer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetProcessServer +The Process server to switch replication to. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProcessServer +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrTestFailoverCleanupJob.md b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrTestFailoverCleanupJob.md new file mode 100644 index 0000000000..e6ed5efb5d --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrTestFailoverCleanupJob.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/start-azrecoveryservicesasrtestfailovercleanupjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrTestFailoverCleanupJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrTestFailoverCleanupJob.md +--- + +# Start-AzRecoveryServicesAsrTestFailoverCleanupJob + +## SYNOPSIS +Starts the test failover cleanup operation. + +## SYNTAX + +### ByRPIObject (Default) +``` +Start-AzRecoveryServicesAsrTestFailoverCleanupJob -ReplicationProtectedItem <ASRReplicationProtectedItem> + [-Comment <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Start-AzRecoveryServicesAsrTestFailoverCleanupJob -ResourceId <String> [-Comment <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRPObject +``` +Start-AzRecoveryServicesAsrTestFailoverCleanupJob -RecoveryPlan <ASRRecoveryPlan> [-Comment <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzRecoveryServicesAsrTestFailoverCleanupJob** cmdlet starts the test failover cleanup operation on a replication protected item or recovery plan on which a test failover has been performed. + +## EXAMPLES + +### Example 1 + +Job to track test failover Cleanup of an Azure Site Recovery recoveryPlan. + +```powershell +Start-AzRecoveryServicesAsrTestFailoverCleanupJob -RecoveryPlan $recoveryPlan -Comment "testing done" +``` + +### Example 2 + +Starts the test failover cleanup operation. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Start-AzRecoveryServicesAsrTestFailoverCleanupJob -Comment 'testing done' -ReplicationProtectedItem $rpi +``` + +## PARAMETERS + +### -Comment +User Comment for Test Failover. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPlan +Recovery Plan to perform the test failover cleanup on. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan +Parameter Sets: ByRPObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +Replication Protected Item to perform the test failover cleanup on. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: ByRPIObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id of replication protected item / recovery plan for cleaningup test failover. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrTestFailoverJob.md b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrTestFailoverJob.md new file mode 100644 index 0000000000..2199de2994 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrTestFailoverJob.md @@ -0,0 +1,325 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/start-azrecoveryservicesasrtestfailoverjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrTestFailoverJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrTestFailoverJob.md +--- + +# Start-AzRecoveryServicesAsrTestFailoverJob + +## SYNOPSIS +Starts a test failover operation. + +## SYNTAX + +### ByRPIObject (Default) +``` +Start-AzRecoveryServicesAsrTestFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> + -Direction <String> [-CloudServiceCreationOption <String>] [-DataEncryptionPrimaryCertFile <String>] + [-DataEncryptionSecondaryCertFile <String>] [-RecoveryPoint <ASRRecoveryPoint>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRPObject +``` +Start-AzRecoveryServicesAsrTestFailoverJob -RecoveryPlan <ASRRecoveryPlan> -Direction <String> + [-CloudServiceCreationOption <String>] [-DataEncryptionPrimaryCertFile <String>] + [-DataEncryptionSecondaryCertFile <String>] [-RecoveryTag <String>] [-MultiVmSyncPoint <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRPObjectWithVMNetwork +``` +Start-AzRecoveryServicesAsrTestFailoverJob -RecoveryPlan <ASRRecoveryPlan> -Direction <String> + -VMNetwork <ASRNetwork> [-DataEncryptionPrimaryCertFile <String>] [-DataEncryptionSecondaryCertFile <String>] + [-RecoveryTag <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRPObjectWithAzureVMNetworkId +``` +Start-AzRecoveryServicesAsrTestFailoverJob -RecoveryPlan <ASRRecoveryPlan> -Direction <String> + -AzureVMNetworkId <String> [-CloudServiceCreationOption <String>] [-DataEncryptionPrimaryCertFile <String>] + [-DataEncryptionSecondaryCertFile <String>] [-RecoveryTag <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRPIObjectWithVMNetwork +``` +Start-AzRecoveryServicesAsrTestFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> + -Direction <String> -VMNetwork <ASRNetwork> [-DataEncryptionPrimaryCertFile <String>] + [-DataEncryptionSecondaryCertFile <String>] [-RecoveryPoint <ASRRecoveryPoint>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRPIObjectWithAzureVMNetworkId +``` +Start-AzRecoveryServicesAsrTestFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> + -Direction <String> -AzureVMNetworkId <String> [-CloudServiceCreationOption <String>] + [-DataEncryptionPrimaryCertFile <String>] [-DataEncryptionSecondaryCertFile <String>] + [-RecoveryPoint <ASRRecoveryPoint>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzRecoveryServicesAsrTestFailoverJob** cmdlet starts test failover of an Azure Site Recovery replication protected item or recovery plan. +You can check whether the job succeeded by using the Get-AzRecoveryServicesAsrJob cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Start-AzRecoveryServicesAsrTestFailoverJob -RecoveryPlan $RP -Direction PrimaryToRecovery -VMNetwork $TestRecoveryNetwork +``` + +Starts the test failover operation for the recovery plan with the specified parameters and returns the ASR job used to track the operation. + +### Example 2 + +Starts a test failover operation. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Start-AzRecoveryServicesAsrTestFailoverJob -AzureVMNetworkId <String> -Direction PrimaryToRecovery -RecoveryPlan $RP +``` + +## PARAMETERS + +### -AzureVMNetworkId +Specifies the Azure vm network id for recovery VM after failover. + +```yaml +Type: System.String +Parameter Sets: ByRPObjectWithAzureVMNetworkId, ByRPIObjectWithAzureVMNetworkId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudServiceCreationOption +Specifies whether a new cloud service should be created or the recovery cloud service configured for the VM should be used for the test failover. + +```yaml +Type: System.String +Parameter Sets: ByRPIObject, ByRPObject, ByRPObjectWithAzureVMNetworkId, ByRPIObjectWithAzureVMNetworkId +Aliases: +Accepted values: UseRecoveryCloudService, AutoCreateCloudService + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionPrimaryCertFile +Specifies the primary certificate file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionSecondaryCertFile +Specifies the secondary certificate file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Specifies the failover direction. +The acceptable values for this parameter are: + +- PrimaryToRecovery +- RecoveryToPrimary + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: PrimaryToRecovery, RecoveryToPrimary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiVmSyncPoint +Specifies whether to enable multi VM sync points for failover of multi VM sync enabled VMs (Applicable only for VMware to Azure replication scenario). + +```yaml +Type: System.String +Parameter Sets: ByRPObject +Aliases: +Accepted values: Enable, Disable + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPlan +Specifies an ASR recovery plan object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan +Parameter Sets: ByRPObject, ByRPObjectWithVMNetwork, ByRPObjectWithAzureVMNetworkId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RecoveryPoint +Specifies a custom recovery point to test failover the protected machine to. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPoint +Parameter Sets: ByRPIObject, ByRPIObjectWithVMNetwork, ByRPIObjectWithAzureVMNetworkId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryTag +Specifies the recovery tag to test failover to + +```yaml +Type: System.String +Parameter Sets: ByRPObject, ByRPObjectWithVMNetwork, ByRPObjectWithAzureVMNetworkId +Aliases: +Accepted values: Latest, LatestAvailable, LatestAvailableApplicationConsistent + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +Specifies an ASR replication protected item. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: ByRPIObject, ByRPIObjectWithVMNetwork, ByRPIObjectWithAzureVMNetworkId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMNetwork +Specifies the Site Recovery virtual machine network to connect the test failover virtual machine(s) to. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork +Parameter Sets: ByRPObjectWithVMNetwork, ByRPIObjectWithVMNetwork +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrJob](./Get-AzRecoveryServicesAsrJob.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrUnplannedFailoverJob.md b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrUnplannedFailoverJob.md new file mode 100644 index 0000000000..cd1f8f0f48 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Start-AzRecoveryServicesAsrUnplannedFailoverJob.md @@ -0,0 +1,283 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/start-azrecoveryservicesasrunplannedfailoverjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrUnplannedFailoverJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrUnplannedFailoverJob.md +--- + +# Start-AzRecoveryServicesAsrUnplannedFailoverJob + +## SYNOPSIS +Starts an unplanned failover operation. + +## SYNTAX + +### ByRPIObject (Default) +``` +Start-AzRecoveryServicesAsrUnplannedFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> + -Direction <String> [-PerformSourceSideAction] [-DataEncryptionPrimaryCertFile <String>] + [-DataEncryptionSecondaryCertFile <String>] [-RecoveryPoint <ASRRecoveryPoint>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRPObject +``` +Start-AzRecoveryServicesAsrUnplannedFailoverJob -RecoveryPlan <ASRRecoveryPlan> -Direction <String> + [-PerformSourceSideAction] [-DataEncryptionPrimaryCertFile <String>] + [-DataEncryptionSecondaryCertFile <String>] [-RecoveryTag <String>] [-MultiVmSyncPoint <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRPIObjectWithRecoveryTag +``` +Start-AzRecoveryServicesAsrUnplannedFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> + -Direction <String> [-PerformSourceSideAction] [-DataEncryptionPrimaryCertFile <String>] + [-DataEncryptionSecondaryCertFile <String>] -RecoveryTag <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzRecoveryServicesAsrUnplannedFailoverJob** cmdlet starts unplanned failover of an Azure Site Recovery replication protected item or recovery plan. +You can check whether the job succeeded by using the Get-AzRecoveryServicesAsrJob cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzRecoveryServicesAsrUnplannedFailoverJob -RecoveryPlan $RP -Direction PrimaryToRecovery +``` + +Starts the unplanned failover operation for the recovery plan with the specified parameters and returns the ASR job used to track the operation. + +### Example 2 + +Starts an unplanned failover operation. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Start-AzRecoveryServicesAsrUnplannedFailoverJob -Direction PrimaryToRecovery -RecoveryPoint $rp[0] -ReplicationProtectedItem $ReplicationProtectedItem +``` + +## PARAMETERS + +### -DataEncryptionPrimaryCertFile +Specifies the data encryption primary certificate file path for failover of Protected Item. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionSecondaryCertFile +Specifies the data encryption secondary certificate file path for failover of Protected Item. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Specifies the failover direction. +The acceptable values for this parameter are: + +- PrimaryToRecovery +- RecoveryToPrimary + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: PrimaryToRecovery, RecoveryToPrimary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiVmSyncPoint +Specifies whether to enable multi VM sync points for failover of multi VM sync enabled VMs (Applicable only for VMware to Azure replication scenario). + +```yaml +Type: System.String +Parameter Sets: ByRPObject +Aliases: +Accepted values: Enable, Disable + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PerformSourceSideAction +Perform operation in source side before starting unplanned failover. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: PerformSourceSideActions + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPlan +Specifies an ASR recovery plan object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan +Parameter Sets: ByRPObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RecoveryPoint +Specifies a custom recovery point to failover the protected machine to. If not specified, ASR will process the pending writes and pick the latest recovery point (lowest RPO). + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPoint +Parameter Sets: ByRPIObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryTag +Specifies the recovery tag to failover to. + +```yaml +Type: System.String +Parameter Sets: ByRPObject +Aliases: +Accepted values: Latest, LatestAvailable, LatestAvailableApplicationConsistent, LatestAvailableCrashConsistent + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ByRPIObjectWithRecoveryTag +Aliases: +Accepted values: Latest, LatestAvailable, LatestAvailableApplicationConsistent, LatestAvailableCrashConsistent + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +Specifies an azure site recovery replication protected item. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: ByRPIObject, ByRPIObjectWithRecoveryTag +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrJob](./Get-AzRecoveryServicesAsrJob.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Stop-AzRecoveryServicesAsrJob.md b/azps-10.1.0/Az.RecoveryServices/Stop-AzRecoveryServicesAsrJob.md new file mode 100644 index 0000000000..2ba4fab478 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Stop-AzRecoveryServicesAsrJob.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/stop-azrecoveryservicesasrjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Stop-AzRecoveryServicesAsrJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Stop-AzRecoveryServicesAsrJob.md +--- + +# Stop-AzRecoveryServicesAsrJob + +## SYNOPSIS +Stops an Azure Site Recovery job. + +## SYNTAX + +### ByObject (Default) +``` +Stop-AzRecoveryServicesAsrJob -InputObject <ASRJob> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByName +``` +Stop-AzRecoveryServicesAsrJob -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzRecoveryServicesAsrJob** cmdlet stops the specified Azure Site Recovery job. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Stop-AzRecoveryServicesAsrJob -Job $Job +``` + +Attempts to stop the specified job and returns an updated ASR job object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object: Specify the ASR job object corresponding to the ASR job to be stopped + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob +Parameter Sets: ByObject +Aliases: Job + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the ASR Job to be stopped by the ASR job name. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrJob](./Get-AzRecoveryServicesAsrJob.md) + +[Restart-AzRecoveryServicesAsrJob](./Restart-AzRecoveryServicesAsrJob.md) + +[Resume-AzRecoveryServicesAsrJob](./Resume-AzRecoveryServicesAsrJob.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Stop-AzRecoveryServicesBackupJob.md b/azps-10.1.0/Az.RecoveryServices/Stop-AzRecoveryServicesBackupJob.md new file mode 100644 index 0000000000..cb65ebc276 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Stop-AzRecoveryServicesBackupJob.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: A8FDC5A3-F309-49B3-B417-8E0A1535BAF4 +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/stop-azrecoveryservicesbackupjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Stop-AzRecoveryServicesBackupJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Stop-AzRecoveryServicesBackupJob.md +--- + +# Stop-AzRecoveryServicesBackupJob + +## SYNOPSIS +Cancels a running job. + +## SYNTAX + +### JobFilterSet (Default) +``` +Stop-AzRecoveryServicesBackupJob [-Job] <JobBase> [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdFilterSet +``` +Stop-AzRecoveryServicesBackupJob [-JobId] <String> [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzRecoveryServicesBackupJob** cmdlet cancels an existing Azure Backup job. +Use this cmdlet to stop a job that takes too long and blocks other activities. +You can cancel only Backup and Restore job types. +Set the vault context by using the Set-AzRecoveryServicesVaultContext cmdlet before you use the current cmdlet. + +## EXAMPLES + +### Example 1: Stop a backup job +```powershell +$Job = Get-AzRecoveryServicesBackupJob -Operation Backup +Stop-AzRecoveryServicesBackupJob -JobID $Job.InstanceId +``` + +The first command gets a backup job, and then stores the job in the $Job variable. +The last command stops the job by specifying the Instance ID of the backup job in $Job. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Job +Specifies a job that this cmdlet cancels. +To obtain a **BackupJob** object, use the Get-AzRecoveryServicesBackupJob cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase +Parameter Sets: JobFilterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobId +Specifies the ID of the job to cancel. +The ID is the InstanceId property of a **BackupJob** object. +To obtain an **BackupJob** object, use Get-AzRecoveryServicesBackupJob. + +```yaml +Type: System.String +Parameter Sets: IdFilterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupJob](./Get-AzRecoveryServicesBackupJob.md) + +[Wait-AzRecoveryServicesBackupJob](./Wait-AzRecoveryServicesBackupJob.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Test-AzRecoveryServicesDSMove.md b/azps-10.1.0/Az.RecoveryServices/Test-AzRecoveryServicesDSMove.md new file mode 100644 index 0000000000..9cd70e4e9a --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Test-AzRecoveryServicesDSMove.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/test-azrecoveryservicesdsmove +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Test-AzRecoveryServicesDSMove.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Test-AzRecoveryServicesDSMove.md +--- + +# Test-AzRecoveryServicesDSMove + +## SYNOPSIS +This cmdlet performs necessary validations for DS Move. + +## SYNTAX + +``` +Test-AzRecoveryServicesDSMove [-Force] [-DefaultProfile <IAzureContextContainer>] [-SourceVault] <ARSVault> + [-TargetVault] <ARSVault> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet performs necessary validations for DS Move. This cmdlet generates a boolean true if +all validations pass successfully. It is mandatory to run this cmdlet before Initialize-AzRecoveryServicesDSMove +cmdlet. This cmdlet is useful for cross tenant DS move scenario. + +## EXAMPLES + +### Example 1: Initialize DS Move for cross subscription copy +```powershell +Set-AzContext -SubscriptionName $targetSubscription +$validated = Test-AzRecoveryServicesDSMove -SourceVault $srcVault -TargetVault $trgVault -Force +Set-AzContext -SubscriptionName $sourceSubscription +if($validated) { + $corr = Initialize-AzRecoveryServicesDSMove -SourceVault $srcVault -TargetVault $trgVault + } +``` + +First cmdlet sets target subscription context. +Second cmdlet triggers some mandatory validations on target vault. +Third cmdlet sets source subscription context. +Then based on Test-AzRecoveryServicesDSMove cmdlet state, we fetch CorrelationId using +Initialize-AzRecoveryServicesDSMove cmdlet. $corr can be input to the Copy cmdlet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the data move operation (prevents confirmation dialog). +This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceVault +The source vault object to trigger data move. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TargetVault +The target vault object where the data has to be moved. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.ARSVault + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Undo-AzRecoveryServicesBackupItemDeletion.md b/azps-10.1.0/Az.RecoveryServices/Undo-AzRecoveryServicesBackupItemDeletion.md new file mode 100644 index 0000000000..17e38de7f3 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Undo-AzRecoveryServicesBackupItemDeletion.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/undo-azrecoveryservicesbackupitemdeletion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Undo-AzRecoveryServicesBackupItemDeletion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Undo-AzRecoveryServicesBackupItemDeletion.md +--- + +# Undo-AzRecoveryServicesBackupItemDeletion + +## SYNOPSIS +If a backup item is deleted and present in a soft-deleted state, this command brings the item back to a state where the data is retained forever + +## SYNTAX + +``` +Undo-AzRecoveryServicesBackupItemDeletion [-Item] <ItemBase> [-Force] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Undo-AzRecoveryServicesBackupItemDeletion cmdlet reverts a soft-deleted item to a state where the protection is stopped but data is retained forever. + +## EXAMPLES + +### Example 1 +```powershell +$Cont = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVM +$PI = Get-AzRecoveryServicesBackupItem -Container $Cont[0] -WorkloadType AzureVM +Disable-AzRecoveryServicesBackupProtection -Item $PI[0] -RemoveRecoveryPoints +$PI = Get-AzRecoveryServicesBackupItem -Container $Cont[0] -WorkloadType AzureVM | Where-Object {$_.DeleteState -eq "ToBeDeleted"} +Undo-AzRecoveryServicesBackupItemDeletion -Item $PI[0] +``` + +The first command gets an array of backup containers, and then stores it in the $Cont array. +The second command gets the Backup item corresponding to the first container item, and then stores it in the $PI variable. +The third command disables Backup protection for the item in $PI\[0\] and puts the item in a softdeleted state. +The fourth command gets the item which is in a softdeleted state. +The last command brings the softdeleted VM to a state where the protection is stopped but data is retained forever. + +### Example 2 + +Rehydrates a soft-deleted Item. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Undo-AzRecoveryServicesBackupItemDeletion -Item $PI[0] -VaultId $vault.ID +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force disables backup protection (prevents confirmation dialog). +This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Item +Specifies the backup item for which this cmdlet reverts the deletion. +To obtain an AzureRmRecoveryServicesBackupItem , use the Get-AzRecoveryServicesBackupItem cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupContainer]() + +[Get-AzRecoveryServicesBackupItem]() + diff --git a/azps-10.1.0/Az.RecoveryServices/Unregister-AzRecoveryServicesBackupContainer.md b/azps-10.1.0/Az.RecoveryServices/Unregister-AzRecoveryServicesBackupContainer.md new file mode 100644 index 0000000000..785a1cd253 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Unregister-AzRecoveryServicesBackupContainer.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: A10DC2A2-A732-416F-9C68-6533C143AE8F +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/unregister-azrecoveryservicesbackupcontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Unregister-AzRecoveryServicesBackupContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Unregister-AzRecoveryServicesBackupContainer.md +--- + +# Unregister-AzRecoveryServicesBackupContainer + +## SYNOPSIS +Unregisters a Windows Server or other container from the vault. + +## SYNTAX + +``` +Unregister-AzRecoveryServicesBackupContainer [-Container] <ContainerBase> [-PassThru] [-Force] + [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Unregister-AzRecoveryServicesBackupContainer** cmdlet unregisters a Windows Server or other Backup container from the vault. +This cmdlet removes references to a container from the vault. +Before you can unregister a container, you must delete any protected data associated with that container. +Set the vault context by using the Set-AzRecoveryServicesVaultContext cmdlet before you use the current cmdlet. + +## EXAMPLES + +### Example 1: Unregister a Windows Server from the vault +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$Cont = Get-AzRecoveryServicesBackupContainer -ContainerType "Windows" -BackupManagementType MAB -VaultId $vault.ID +Unregister-AzRecoveryServicesBackupContainer -Container $Cont +``` + +The first command gets the Windows container named server01.contoso.com that is registered in the vault, and then stores it in the $Cont variable. +The second command unregisters the specified Windows Server from the Azure Backup vault. + +### Example 2 + +Unregisters a Windows Server or other container from the vault. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Unregister-AzRecoveryServicesBackupContainer -Container $Cont -VaultId $vault.ID +``` + +## PARAMETERS + +### -Container +Specifies a Backup container object to unregister. +To obtain a **BackupContainer** object, use the Get-AzRecoveryServicesBackupContainer cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force unregisters container (prevents confirmation dialog). This parameter is optional. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the container to be deleted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupContainer](./Get-AzRecoveryServicesBackupContainer.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Unregister-AzRecoveryServicesBackupManagementServer.md b/azps-10.1.0/Az.RecoveryServices/Unregister-AzRecoveryServicesBackupManagementServer.md new file mode 100644 index 0000000000..3276b5ea3a --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Unregister-AzRecoveryServicesBackupManagementServer.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: BBF12B16-C5FD-4AE2-B5D7-AFDC29CEE4D3 +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/unregister-azrecoveryservicesbackupmanagementserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Unregister-AzRecoveryServicesBackupManagementServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Unregister-AzRecoveryServicesBackupManagementServer.md +--- + +# Unregister-AzRecoveryServicesBackupManagementServer + +## SYNOPSIS +Unregisters a SCDPM server or Backup server from the vault. + +## SYNTAX + +``` +Unregister-AzRecoveryServicesBackupManagementServer [-AzureRmBackupManagementServer] <BackupEngineBase> + [-PassThru] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Unregister-AzRecoveryServicesBackupManagementServer** cmdlet unregisters a System Center Data Protection Manager (SCDPM) server or an Azure Backup server from the vault. +This cmdlet removes references to the servers that are unregistered from the vault. +Before you can unregister a container, you must delete any protected data associated with that container. +Set the vault context by using the Set-AzRecoveryServicesVaultContext cmdlet before you use the current cmdlet. + +## EXAMPLES + +### Example 1: Unregister an SCDPM server from the vault +```powershell +$BMS = Get-AzRecoveryServicesBackupManagementServer -Name "dpmserver01.contoso.com" +Unregister-AzRecoveryServicesBackupManagementServer -AzureRmBackupManagementServer $BMS +``` + +The first command gets the Backup management server named dpmserver01.contoso.com, and then stores it in the $BMS variable. +The second command unregisters the SCDPM server from the vault. + +### Example 2 + +Unregisters a SCDPM server or Backup server from the vault. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Unregister-AzRecoveryServicesBackupManagementServer -AzureRmBackupManagementServer <BackupEngineBase> -VaultId $vault.ID +``` + +## PARAMETERS + +### -AzureRmBackupManagementServer +The recovery services backup container. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupEngineBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the Backup Management Server to be deleted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupEngineBase + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupManagementServer](./Get-AzRecoveryServicesBackupManagementServer.md) + + diff --git a/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrMobilityService.md b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrMobilityService.md new file mode 100644 index 0000000000..c293cda8bd --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrMobilityService.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/update-azrecoveryservicesasrmobilityservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrMobilityService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrMobilityService.md +--- + +# Update-AzRecoveryServicesAsrMobilityService + +## SYNOPSIS +Push mobility service agent updates to protected machines. + +## SYNTAX + +``` +Update-AzRecoveryServicesAsrMobilityService [-Account <ASRRunAsAccount>] + -ReplicationProtectedItem <ASRReplicationProtectedItem> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzRecoveryServicesAsrMobilityService** cmdlet attempts to push mobility service agent updates to protected machines(if an update is available.) + +## EXAMPLES + +### Example 1 +```powershell +Update-AzRecoveryServicesAsrMobilityService -ReplicationProtectedItem $rpi -Account $fabric.fabricSpecificDetails.RunAsAccounts[0] +``` + +Job to track Update Replication Protected Item's Mobility Service Agent. + +## PARAMETERS + +### -Account +The run as account ID to be used to push the update. Must be one from the list of run as accounts in the ASR fabric corresponding to machine being updated. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRunAsAccount +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +Azure Site Recovery replication protected item to be updated. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrNetworkMapping.md b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrNetworkMapping.md new file mode 100644 index 0000000000..f5b7c23fa0 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrNetworkMapping.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/update-azrecoveryservicesasrnetworkmapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrNetworkMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrNetworkMapping.md +--- + +# Update-AzRecoveryServicesAsrNetworkMapping + +## SYNOPSIS +Updates the specified azure site recovery network mapping. + +## SYNTAX + +### ByNetworkObject (Default) +``` +Update-AzRecoveryServicesAsrNetworkMapping -InputObject <ASRNetworkMapping> -RecoveryNetwork <ASRNetwork> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ById +``` +Update-AzRecoveryServicesAsrNetworkMapping -InputObject <ASRNetworkMapping> -RecoveryAzureNetworkId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzRecoveryServicesAsrNetworkMapping** cmdlet updates the specified Azure Site Recovery network mapping. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzRecoveryServicesAsrNetworkMapping -InputObject $NetworkMapping -RecoveryNetwork $RecoveryNetwork +``` + +Starts the update network mapping operation using the specified parameters and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object: Specifies the ASR network mapping object corresponding to the ASR network mapping to be updated. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetworkMapping +Parameter Sets: (All) +Aliases: NetworkMapping + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RecoveryAzureNetworkId +Specifies the recovery azure network ID for the network mapping. + +```yaml +Type: System.String +Parameter Sets: ById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryNetwork +Specifies the recovery network object for the network mapping. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork +Parameter Sets: ByNetworkObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetworkMapping + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrPolicy.md b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrPolicy.md new file mode 100644 index 0000000000..58ebc2c9e1 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrPolicy.md @@ -0,0 +1,470 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/update-azrecoveryservicesasrpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrPolicy.md +--- + +# Update-AzRecoveryServicesAsrPolicy + +## SYNOPSIS +Updates an Azure Site Recovery replication policy. + +## SYNTAX + +### Default (Default) +``` +Update-AzRecoveryServicesAsrPolicy -InputObject <ASRPolicy> [-ReplicationMethod <String>] + [-ReplicationFrequencyInSeconds <String>] [-NumberOfRecoveryPointsToRetain <Int32>] + [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-Compression <String>] [-ReplicationPort <UInt16>] + [-Authentication <String>] [-ReplicationStartTime <TimeSpan>] [-ReplicaDeletion <String>] + [-RecoveryAzureStorageAccountId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### VMwareToAzure +``` +Update-AzRecoveryServicesAsrPolicy [-VMwareToAzure] -InputObject <ASRPolicy> + [-RecoveryPointRetentionInHours <Int32>] [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] + [-MultiVmSyncStatus <String>] [-RPOWarningThresholdInMinutes <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureToAzure +``` +Update-AzRecoveryServicesAsrPolicy [-AzureToAzure] -InputObject <ASRPolicy> + [-RecoveryPointRetentionInHours <Int32>] [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] + [-MultiVmSyncStatus <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AzureToVMware +``` +Update-AzRecoveryServicesAsrPolicy [-AzureToVMware] -InputObject <ASRPolicy> + [-RecoveryPointRetentionInHours <Int32>] [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] + [-MultiVmSyncStatus <String>] [-RPOWarningThresholdInMinutes <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HyperVToAzure +``` +Update-AzRecoveryServicesAsrPolicy [-HyperVToAzure] -InputObject <ASRPolicy> + [-ReplicationFrequencyInSeconds <String>] [-NumberOfRecoveryPointsToRetain <Int32>] + [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-ReplicationStartTime <TimeSpan>] + [-RecoveryAzureStorageAccountId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### EnterpriseToEnterprise +``` +Update-AzRecoveryServicesAsrPolicy [-VmmToVmm] -InputObject <ASRPolicy> [-ReplicationMethod <String>] + [-ReplicationFrequencyInSeconds <String>] [-NumberOfRecoveryPointsToRetain <Int32>] + [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-Compression <String>] [-ReplicationPort <UInt16>] + [-Authentication <String>] [-ReplicationStartTime <TimeSpan>] [-ReplicaDeletion <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ReplicateVMwareToAzure +``` +Update-AzRecoveryServicesAsrPolicy [-ReplicateVMwareToAzure] -InputObject <ASRPolicy> + [-RecoveryPointRetentionInHours <Int32>] [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] + [-MultiVmSyncStatus <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzRecoveryServicesAsrPolicy** cmdlet updates the specified Azure Site Recovery replication policy. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Update-AzRecoveryServicesAsrPolicy -Policy $Policy -ReplicationFrequencyInSeconds 900 +``` + +Starts the update replication policy operation using the specified parameters and returns the ASR job used to track the operation. + +### Example 2 +```powershell +$currentJob = Update-AzRecoveryServicesAsrPolicy -AzureToAzure -InputObject $Policy -RecoveryPointRetentionInHours 20 +``` + +Starts the update azure to azure replication policy using the specified parameters and returns the ASR job used to track the operation. + +## PARAMETERS + +### -ApplicationConsistentSnapshotFrequencyInHours +Specifies the frequency(in hours) at which to create application consistent recovery points. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authentication +Specifies the type of authentication used. + +```yaml +Type: System.String +Parameter Sets: Default, EnterpriseToEnterprise +Aliases: +Accepted values: Certificate, Kerberos + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureToAzure +Specifies the Azure to Azure disaster recovery. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureToVMware +Specifies the Azure to vMWare disaster recovery. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureToVMware +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compression +Specifies if compression should be enabled. + +```yaml +Type: System.String +Parameter Sets: Default, EnterpriseToEnterprise +Aliases: +Accepted values: Enable, Disable + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HyperVToAzure +Switch parameter indicating that the specified policy is used to replicate Hyper-V virtual machines to Azure. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: HyperVToAzure +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input object for the cmdlet: Specifies the ASR replication policy object corresponding to the replication policy to be updated. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy +Parameter Sets: (All) +Aliases: Policy + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MultiVmSyncStatus +Specifies multiVm sync status for the policy. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzure, AzureToAzure, AzureToVMware, ReplicateVMwareToAzure +Aliases: +Accepted values: Enable, Disable + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfRecoveryPointsToRetain +Specifies the number recovery points to retain. + +```yaml +Type: System.Int32 +Parameter Sets: Default, HyperVToAzure, EnterpriseToEnterprise +Aliases: RecoveryPoints + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryAzureStorageAccountId +Specifies the Azure storage account ID of the replication target. Used as the target storage account for replication if an alternate is not provided while enabling replication using the New-AzRecoveryServicesASRReplicationProtectedItem cmdlet. + + +```yaml +Type: System.String +Parameter Sets: Default, HyperVToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPointRetentionInHours +Time in hours to retain recovery points after creation. + +```yaml +Type: System.Int32 +Parameter Sets: VMwareToAzure, AzureToAzure, AzureToVMware, ReplicateVMwareToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaDeletion +Specifies if the replica virtual machine should be deleted on disabling replication from a VMM managed site to another. + +```yaml +Type: System.String +Parameter Sets: Default, EnterpriseToEnterprise +Aliases: +Accepted values: Required, NotRequired + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicateVMwareToAzure +Switch parameter specifying VMware to Azure replication scenario. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ReplicateVMwareToAzure +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationFrequencyInSeconds +Specifies the replication frequency interval in seconds. +Valid values are: + +- 30 +- 300 +- 900 + +```yaml +Type: System.String +Parameter Sets: Default, HyperVToAzure, EnterpriseToEnterprise +Aliases: +Accepted values: 30, 300, 900 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationMethod +Specifies the replication method. + +```yaml +Type: System.String +Parameter Sets: Default, EnterpriseToEnterprise +Aliases: +Accepted values: Online, Offline + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationPort +Specifies the port used for replication. + +```yaml +Type: System.UInt16 +Parameter Sets: Default, EnterpriseToEnterprise +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationStartTime +Specifies the replication start time. +It must be no later than 24-hours from the start of the job. + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: Default, HyperVToAzure, EnterpriseToEnterprise +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RPOWarningThresholdInMinutes +The RPO threshold value in minutes to warn on. + +```yaml +Type: System.Int32 +Parameter Sets: VMwareToAzure, AzureToVMware +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmmToVmm +Switch parameter indicating that the specified policy is used to replicate VMM managed Hyper-V virtual machines between two Hyper-V sites. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EnterpriseToEnterprise +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMwareToAzure +Switch parameter indicating that the specified policy is used to replicate VMware virtual machines to Azure. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: VMwareToAzure +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrProtectionContainerMapping.md b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrProtectionContainerMapping.md new file mode 100644 index 0000000000..1475ce56ae --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrProtectionContainerMapping.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/update-azrecoveryservicesasrprotectioncontainermapping +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrProtectionContainerMapping.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrProtectionContainerMapping.md +--- + +# Update-AzRecoveryServicesAsrProtectionContainerMapping + +## SYNOPSIS +Update the Azure site recovery protection container mapping. + +## SYNTAX + +### AzureToAzureEnableAutoUpdate (Default) +``` +Update-AzRecoveryServicesAsrProtectionContainerMapping -InputObject <ASRProtectionContainerMapping> + [-AzureToAzure] [-EnableAutoUpdate] -AutomationAccountId <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureToAzureDisableAutoUpdate +``` +Update-AzRecoveryServicesAsrProtectionContainerMapping -InputObject <ASRProtectionContainerMapping> + [-AzureToAzure] [-DisableAutoUpdate] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzRecoveryServicesAsrProtectionContainerMapping** cmdlet updates the specified Azure Site Recovery protection container mapping. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzRecoveryServicesAsrProtectionContainerMapping -InputObject $ASRProtectionContainerMapping -AzureToAzure -DisableAutoUpdate +``` + +Start the operation to disable auto update for container. + +### Example 2 +```powershell +Update-AzRecoveryServicesAsrProtectionContainerMapping -InputObject $ASRProtectionContainerMapping -AzureToAzure -EnableAutoUpdate -AutomationAccountId $automationAccountId +``` + +Start the operation to disable enable auto update for container. + +## PARAMETERS + +### -AutomationAccountId +Specifies the automation accountId used for auto update. + +```yaml +Type: System.String +Parameter Sets: AzureToAzureEnableAutoUpdate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureToAzure +Specifies Azure to Azure protection container. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAutoUpdate +Switch parameter to disable auto update. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureToAzureDisableAutoUpdate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoUpdate +Switch parameter to enable auto update. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureToAzureEnableAutoUpdate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Object for protection container mapping. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainerMapping +Parameter Sets: (All) +Aliases: ProtectionContainerMapping + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainerMapping + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrProtectionDirection.md b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrProtectionDirection.md new file mode 100644 index 0000000000..82ad75f942 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrProtectionDirection.md @@ -0,0 +1,784 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/update-azrecoveryservicesasrprotectiondirection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrProtectionDirection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrProtectionDirection.md +--- + +# Update-AzRecoveryServicesAsrProtectionDirection + +## SYNOPSIS +Updates the replication direction for the specified replication protected item or recovery plan. Used to re-protect/reverse replicate a failed over replicated item or recovery plan. + +## SYNTAX + +### ByRPIObject (Default) +``` +Update-AzRecoveryServicesAsrProtectionDirection -ReplicationProtectedItem <ASRReplicationProtectedItem> + -Direction <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureToVMware +``` +Update-AzRecoveryServicesAsrProtectionDirection [-AzureToVMware] [-Account <ASRRunAsAccount>] + -DataStore <ASRDataStore> [-MasterTarget <ASRMasterTargetServer>] -ProcessServer <ASRProcessServer> + -ProtectionContainerMapping <ASRProtectionContainerMapping> + -ReplicationProtectedItem <ASRReplicationProtectedItem> -Direction <String> + -RetentionVolume <ASRRetentionVolume> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### VMwareToAzure +``` +Update-AzRecoveryServicesAsrProtectionDirection [-VMwareToAzure] -Account <ASRRunAsAccount> + [-MasterTarget <ASRMasterTargetServer>] -ProcessServer <ASRProcessServer> + -ProtectionContainerMapping <ASRProtectionContainerMapping> [-LogStorageAccountId <String>] + [-RecoveryAzureStorageAccountId <String>] -ReplicationProtectedItem <ASRReplicationProtectedItem> + -Direction <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ReplicateAzureToVMware +``` +Update-AzRecoveryServicesAsrProtectionDirection [-ReplicateAzureToVMware] + -ProtectionContainerMapping <ASRProtectionContainerMapping> -DataStoreName <String> -ApplianceName <String> + -Fabric <ASRFabric> -LogStorageAccountId <String> -ReplicationProtectedItem <ASRReplicationProtectedItem> + -Direction <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ReplicateVMwareToAzure +``` +Update-AzRecoveryServicesAsrProtectionDirection [-ReplicateVMwareToAzure] -SiteId <String> + -CredentialsToAccessVm <String> -ProtectionContainerMapping <ASRProtectionContainerMapping> + -ApplianceName <String> -Fabric <ASRFabric> -ReplicationProtectedItem <ASRReplicationProtectedItem> + -Direction <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### HyperVToAzure +``` +Update-AzRecoveryServicesAsrProtectionDirection [-HyperVToAzure] [-LogStorageAccountId <String>] + [-RecoveryAzureStorageAccountId <String>] -ReplicationProtectedItem <ASRReplicationProtectedItem> + -Direction <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EnterpriseToEnterprise +``` +Update-AzRecoveryServicesAsrProtectionDirection [-VmmToVmm] + -ReplicationProtectedItem <ASRReplicationProtectedItem> -Direction <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureToAzure +``` +Update-AzRecoveryServicesAsrProtectionDirection [-AzureToAzure] + -ProtectionContainerMapping <ASRProtectionContainerMapping> -LogStorageAccountId <String> + [-RecoveryAzureStorageAccountId <String>] -ReplicationProtectedItem <ASRReplicationProtectedItem> + [-RecoveryResourceGroupId <String>] [-RecoveryCloudServiceId <String>] [-RecoveryAvailabilitySetId <String>] + [-RecoveryProximityPlacementGroupId <String>] [-RecoveryVirtualMachineScaleSetId <String>] + [-RecoveryCapacityReservationGroupId <String>] [-RecoveryBootDiagStorageAccountId <String>] + [-DiskEncryptionVaultId <String>] [-DiskEncryptionSecretUrl <String>] [-KeyEncryptionKeyUrl <String>] + [-KeyEncryptionVaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AzureToAzureWithMultipleStorageAccount +``` +Update-AzRecoveryServicesAsrProtectionDirection [-AzureToAzure] + -ProtectionContainerMapping <ASRProtectionContainerMapping> + -AzureToAzureDiskReplicationConfiguration <ASRAzuretoAzureDiskReplicationConfig[]> + -ReplicationProtectedItem <ASRReplicationProtectedItem> [-RecoveryResourceGroupId <String>] + [-RecoveryCloudServiceId <String>] [-RecoveryAvailabilitySetId <String>] + [-RecoveryProximityPlacementGroupId <String>] [-RecoveryVirtualMachineScaleSetId <String>] + [-RecoveryCapacityReservationGroupId <String>] [-RecoveryBootDiagStorageAccountId <String>] + [-DiskEncryptionVaultId <String>] [-DiskEncryptionSecretUrl <String>] [-KeyEncryptionKeyUrl <String>] + [-KeyEncryptionVaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByRPObject +``` +Update-AzRecoveryServicesAsrProtectionDirection -RecoveryPlan <ASRRecoveryPlan> -Direction <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByPEObject +``` +Update-AzRecoveryServicesAsrProtectionDirection -Direction <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzRecoveryServicesAsrProtectionDirection** cmdlet updates the replication direction for the specified Azure Site Recovery object after the completion of a commit failover operation. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Update-AzRecoveryServicesAsrProtectionDirection -RecoveryPlan $RP -Direction PrimaryToRecovery +``` + +Start the update direction operation for the specified recovery plan and returns the ASR job object used to track the operation. + +### Example 2 +```powershell +$currentJob = Update-AzRecoveryServicesAsrProtectionDirection -AzureToAzure -ProtectionContainerMapping $B2ApcmMapping -LogStorageAccountId $cacheStorageId ` + -ReplicationProtectedItem $rpi +``` + +Start the update direction operation for the specified replication protected item in target azure region defined by protection container mapping and using cache storage (in same region as VM). + +### Example 3 +```powershell +$currentJob = Update-AzRecoveryServicesAsrProtectionDirection -AzureToAzure -ProtectionContainerMapping $B2ApcmMapping ` + -AzureToAzureDiskReplicationConfiguration $disk1,$disk2 -ReplicationProtectedItem $rpi +``` + +Start the update direction operation for the specified replication protected item in target azure region defined by protection container mapping and provided disk replication configuration. + +### Example 4 +```powershell +$currentJob = Update-AzRecoveryServicesAsrProtectionDirection -AzureToAzure -ProtectionContainerMapping $B2ApcmMapping ` + -AzureToAzureDiskReplicationConfiguration $disk1,$disk2 -ReplicationProtectedItem $rpi ` + -DiskEncryptionVaultId $DiskEncryptionVaultId -DiskEncryptionSecretUrl $DiskEncryptionSecertUrl ` + -KeyEncryptionVaultId $KeyEncryptionVaultId -KeyEncryptionKeyUrl $KeyEncryptionKeyUrl +``` + + +Start the update direction operation for the specified encrypted replication protected item in target azure region defined by protection container mapping and provided disk replication configuration. + +### Example 5 +```powershell +$currentJob = Update-AzRecoveryServicesAsrProtectionDirection -AzureToAzure -ProtectionContainerMapping $B2ApcmMapping -LogStorageAccountId $cacheStorageId ` + -ReplicationProtectedItem $rpi -RecoveryProximityPlacementGroupId $ppg +``` + +Start the update direction operation for the specified replication protected item in target azure region defined by protection container mapping and using cache storage (in same region as VM) and proximity placement group. + +### Example 6 +```powershell +$currentJob = Update-AzRecoveryServicesAsrProtectionDirection -AzureToAzure -ProtectionContainerMapping $B2ApcmMapping -LogStorageAccountId $cacheStorageId ` + -ReplicationProtectedItem $rpi -RecoveryVirtualMachineScaleSetId $vmss +``` + +Start the update direction operation for the specified replication protected item in target azure region defined by protection container mapping and using cache storage (in same region as VM) and virtual machine scale set. + +## PARAMETERS + +### -Account +The run as account to be used to push install the Mobility service if needed. Must be one from the list of run as accounts in the ASR fabric. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRunAsAccount +Parameter Sets: AzureToVMware +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRunAsAccount +Parameter Sets: VMwareToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplianceName +Specifies the name of appliance to be used to replicate this machine. + +```yaml +Type: System.String +Parameter Sets: ReplicateAzureToVMware, ReplicateVMwareToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureToAzure +Specifies the Azure to Azure disaster recovery. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureToAzureDiskReplicationConfiguration +Specifies the disk configuration for disaster recovery. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRAzuretoAzureDiskReplicationConfig[] +Parameter Sets: AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureToVMware +Specifies the switch azure to vMWare scenario. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureToVMware +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialsToAccessVm +Specifies the name of credentials to be used to push install the Mobility service on source machine if needed. + +```yaml +Type: System.String +Parameter Sets: ReplicateVMwareToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataStore +The VMware data-store to be used for the vmdisk's. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRDataStore +Parameter Sets: AzureToVMware +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataStoreName +Name of the VMware data store to be used for the VM disk's. + +```yaml +Type: System.String +Parameter Sets: ReplicateAzureToVMware +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Specifies the direction to be used for the update operation post a failover. +The acceptable values for this parameter are: + +- PrimaryToRecovery +- RecoveryToPrimary + +```yaml +Type: System.String +Parameter Sets: ByRPIObject, AzureToVMware, VMwareToAzure, ReplicateAzureToVMware, ReplicateVMwareToAzure, HyperVToAzure, EnterpriseToEnterprise, ByRPObject, ByPEObject +Aliases: +Accepted values: PrimaryToRecovery, RecoveryToPrimary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSecretUrl +Specifies the disk encryption secret URL with version(Azure disk encryption) to be used be recovery VM after failover. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionVaultId +Specifies the disk encryption secret vault ID(Azure disk encryption) to be used be recovery VM after failover. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fabric +Specifies the ASR Fabric object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric +Parameter Sets: ReplicateAzureToVMware, ReplicateVMwareToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HyperVToAzure +Reprotect a Hyper-V virtual machine after failback. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: HyperVToAzure +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyUrl +Specifies the disk encryption key URL(Azure disk encryption) to be used be recovery VM after failover. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionVaultId +Specifies the disk encryption key keyVault ID(Azure disk encryption) to be used be recovery VM after failover. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogStorageAccountId +Specifies the storage account ID to store the replication log of VMs. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzure, HyperVToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ReplicateAzureToVMware, AzureToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MasterTarget +Master Target Server Details. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRMasterTargetServer +Parameter Sets: AzureToVMware, VMwareToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProcessServer +Process Server to be used for replication. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProcessServer +Parameter Sets: AzureToVMware, VMwareToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionContainerMapping +Protection containerMapping to be used for replication. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainerMapping +Parameter Sets: AzureToVMware, VMwareToAzure, ReplicateAzureToVMware, ReplicateVMwareToAzure, AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryAvailabilitySetId +The availability set that the virtual machine should be created in upon failover + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryAzureStorageAccountId +Specifies the ID of the Azure storage account to replicate to. + +```yaml +Type: System.String +Parameter Sets: VMwareToAzure, HyperVToAzure, AzureToAzure +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryBootDiagStorageAccountId +Specifies the storage account for boot diagnostics for recovery azure VM. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryCapacityReservationGroupId +Specify the capacity reservation group Id to be used by the failover VM in target recovery region. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryCloudServiceId +The resource ID of the recovery cloud service to failover this virtual machine to. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryPlan +Specifies an ASR recovery plan object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan +Parameter Sets: ByRPObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RecoveryProximityPlacementGroupId +The resource ID of the recovery proximity placement group to failover this virtual machine to. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryResourceGroupId +Recovery resourceGroup id for protected Vm. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryVirtualMachineScaleSetId +Specifies the reccovery virtual machine scale set id. + +```yaml +Type: System.String +Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicateAzureToVMware +Switch parameter specifying Azure to VMware replication scenario.. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ReplicateAzureToVMware +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicateVMwareToAzure +Switch parameter specifying VMware to Azure replication scenario.. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ReplicateVMwareToAzure +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationProtectedItem +Specifies an ASR replication protected item. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem +Parameter Sets: ByRPIObject, AzureToVMware, VMwareToAzure, ReplicateAzureToVMware, ReplicateVMwareToAzure, HyperVToAzure, EnterpriseToEnterprise, AzureToAzure, AzureToAzureWithMultipleStorageAccount +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RetentionVolume +Retention Volume on the master target server to be used. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRetentionVolume +Parameter Sets: AzureToVMware +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteId +Specifies the VMware site Id where the protectable item was discovered. +Use site Id from fabric specific details in the ASR fabric to specify one. + +```yaml +Type: System.String +Parameter Sets: ReplicateVMwareToAzure +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmmToVmm +Update replication direction for a failed over Hyper-V virtual machine that is protected between two VMM managed Hyper-V sites. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EnterpriseToEnterprise +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMwareToAzure +Update replication direction from VMware to Azure. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: VMwareToAzure +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrRecoveryPlan.md b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrRecoveryPlan.md new file mode 100644 index 0000000000..d456a32543 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrRecoveryPlan.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/update-azrecoveryservicesasrrecoveryplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrRecoveryPlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrRecoveryPlan.md +--- + +# Update-AzRecoveryServicesAsrRecoveryPlan + +## SYNOPSIS +Updates the contents of an Azure Site recovery plan. + +## SYNTAX + +### ByRPObject (Default) +``` +Update-AzRecoveryServicesAsrRecoveryPlan -InputObject <ASRRecoveryPlan> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByRPFile +``` +Update-AzRecoveryServicesAsrRecoveryPlan -Path <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzRecoveryServicesAsrRecoveryPlan** cmdlet updates the contents of a recovery plan using the contents of the specified ASR recovery plan object or ASR recovery plan definition json file. + +## EXAMPLES + +### Example 1: Update a recovery plan +```powershell +$currentJob = Update-AzRecoveryServicesAsrRecoveryPlan -RecoveryPlan $RP +``` + +Start the operation of updating a recovery plan using the contents of the specified ASR recovery plan object and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object to the cmdlet: Specifies an ASR recovery plan object, the contents of which are used to update the recovery plan referred to by the object. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan +Parameter Sets: ByRPObject +Aliases: RecoveryPlan + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Path +Specifies the path of the recovery plan definition json file used to update the recovery plan. + +```yaml +Type: System.String +Parameter Sets: ByRPFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrRecoveryPlan](./Get-AzRecoveryServicesAsrRecoveryPlan.md) + +[New-AzRecoveryServicesAsrRecoveryPlan](./New-AzRecoveryServicesAsrRecoveryPlan.md) + +[Remove-AzRecoveryServicesAsrRecoveryPlan](./Remove-AzRecoveryServicesAsrRecoveryPlan.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrServicesProvider.md b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrServicesProvider.md new file mode 100644 index 0000000000..ca607a6dd0 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrServicesProvider.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/update-azrecoveryservicesasrservicesprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrServicesProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrServicesProvider.md +--- + +# Update-AzRecoveryServicesAsrServicesProvider + +## SYNOPSIS +Refreshes (Refresh server) the information received from the Azure Site Recovery Services Provider. + +## SYNTAX + +``` +Update-AzRecoveryServicesAsrServicesProvider -InputObject <ASRRecoveryServicesProvider> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzRecoveryServicesAsrServicesProvider** cmdlet updates the information received from the Azure Site Recovery Services Provider. You can use this cmdlet to trigger a refresh of the information received from the Recovery Services Provider. + +## EXAMPLES + +### Example 1 +```powershell +$currentJob = Update-AzRecoveryServicesAsrServicesProvider -InputObject $ServicesProvider +``` + +Starts the operation of refreshing the information from the specified ASR services provider and returns the ASR job used to track the operation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the ASR services provider object that identifies the server for which information is to updated(refreshed.) + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryServicesProvider +Parameter Sets: (All) +Aliases: ServicesProvider + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryServicesProvider + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesAsrServicesProvider](./Get-AzRecoveryServicesAsrServicesProvider.md) + +[Remove-AzRecoveryServicesAsrServicesProvider](./Remove-AzRecoveryServicesAsrServicesProvider.md) diff --git a/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrvCenter.md b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrvCenter.md new file mode 100644 index 0000000000..70bc83d559 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesAsrvCenter.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.SiteRecovery.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/update-azrecoveryservicesasrvcenter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrvCenter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesAsrvCenter.md +--- + +# Update-AzRecoveryServicesAsrvCenter + +## SYNOPSIS +Update discovery details for a registered vCenter. + +## SYNTAX + +### Default (Default) +``` +Update-AzRecoveryServicesAsrvCenter -InputObject <ASRvCenter> [-Account <ASRRunAsAccount>] [-Port <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Update-AzRecoveryServicesAsrvCenter -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzRecoveryServicesAsrvCenter** cmdlet is updates discovery details for a registered vCenter. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzRecoveryServicesAsrvCenter -Account $fabric.fabricSpecificDetails.RunAsAccounts[1] -InputObject $vCenter +``` + +```output +Returns ASRJOB for update vCenter. +``` + +Update discovery details for a registered vCenter. + +## PARAMETERS + +### -Account +vCenter login credentials account. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRunAsAccount +Parameter Sets: Default +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The vCenter server object to update discovery details for. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRvCenter +Parameter Sets: Default +Aliases: vCenter + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Port +The TCP port on the vCenter server to use for discovery. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: Default +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the resourceId of vCenter. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRvCenter + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesVault.md b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesVault.md new file mode 100644 index 0000000000..02fedfae98 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Update-AzRecoveryServicesVault.md @@ -0,0 +1,358 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.dll-Help.xml +Module Name: Az.RecoveryServices +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/update-azrecoveryservicesvault +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesVault.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Update-AzRecoveryServicesVault.md +--- + +# Update-AzRecoveryServicesVault + +## SYNOPSIS +Updates MSIdentity to the recovery services vault. + +## SYNTAX + +### AzureRSVaultRemoveMSIdentity (Default) +``` +Update-AzRecoveryServicesVault [-ResourceGroupName] <String> [-Name] <String> [-IdentityId <String[]>] + [-RemoveUserAssigned] [-RemoveSystemAssigned] [-DisableClassicAlerts <Boolean>] + [-DisableAzureMonitorAlertsForJobFailure <Boolean>] [-PublicNetworkAccess <PublicNetworkAccess>] + [-ImmutabilityState <ImmutabilityState>] [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureRSVaultAddMSIdentity +``` +Update-AzRecoveryServicesVault [-ResourceGroupName] <String> [-Name] <String> -IdentityType <MSIdentity> + [-IdentityId <String[]>] [-DisableClassicAlerts <Boolean>] [-DisableAzureMonitorAlertsForJobFailure <Boolean>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-ImmutabilityState <ImmutabilityState>] + [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet is used to add or remove the MSI from the recovery services vault. Use -IdentityType param to add a SystemAssigned/UserAssigned identity to the RSVault. Use RemoveSystemAssigned/RemoveUserAssigned switch to remove the MSI from the vault. + +## EXAMPLES + +### Example 1: Add SystemAssigned identity to the recovery services vault +```powershell +Update-AzRecoveryServicesVault -ResourceGroupName "rgName" -Name "vaultName" -IdentityType SystemAssigned +``` + +This cmdlet is used to add a SystemAssigned identity to a recovery services vault. + +### Example 2: Add UserAssigned identity to the recovery services vault +```powershell +$vault = Get-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "resourceGroupName" +$identity1 = Get-AzUserAssignedIdentity -ResourceGroupName "resourceGroupName" -Name "UserIdentity1" +$identity2 = Get-AzUserAssignedIdentity -ResourceGroupName "resourceGroupName" -Name "UserIdentity2" +$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -IdentityType UserAssigned -IdentityId $identity1.Id, $identity2.Id +$updatedVault.Identity | Format-List +``` + +```output +PrincipalId : +TenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Type : UserAssigned +UserAssignedIdentities : {[/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/UserIdentity1, + Microsoft.Azure.Management.RecoveryServices.Models.UserIdentity], + [/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/UserIdentity2, + Microsoft.Azure.Management.RecoveryServices.Models.UserIdentity]} +``` + +The first cmdlet fetches the recovery services vault. +The second and third cmdlet fetches the user created MSIs. +The fourth cmdlet adds the user MSIs to the vault. +The fifth cmdlet shows the Identities added to the vault. + +### Example 3: Remove SystemAssigned and UserAssigned identities from the vault +```powershell +$vault = Get-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "resourceGroupName" +$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -RemoveSystemAssigned +$AllUserIdentities = $vault.Identity.UserAssignedIdentities.Keys | ForEach-Object {$_} +$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -RemoveUserAssigned -IdentityId $AllUserIdentities +$updatedVault.Identity | Format-List +``` + +```output +PrincipalId : +TenantId : +Type : None +UserAssignedIdentities : +``` + +The first cmdlet fetches the recovery services vault. +The second cmdlet removes the SystemAssigned identity from the vault. +The third cmdlet fetches all the user MSIs as a list from the vault. +The fourth cmdlet removes all the user MSIs from the vault. In case you want, you can provide selected user identities to be removed as comma separated, like in previous example. +The fifth cmdlet shows the identities in the vault, as we removed all the identites, Type is displayed as None. + +### Example 4: Update PublicNetworkAccess, ImmutabilityState of recovery services vault +```powershell +$vault = Get-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "resourceGroupName" +$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -PublicNetworkAccess "Disabled" -ImmutabilityState "Unlocked" +$updatedVault.Properties.PublicNetworkAccess +$updatedVault.Properties.ImmutabilitySettings.ImmutabilityState +``` + +```output +Disabled +Unlocked +``` + +The first cmdlet fetches the recovery services vault. +The second cmdlet updates PublicNetworkAccess, ImmutabilityState properties of the recovery services vault. +The third and fourth command are used to fetch the public network access and immutability state of the vault. + +### Example 5: Enable/Disable CrossSubscriptionRestore for recovery services vault +```powershell +$vault = Get-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "resourceGroupName" +$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -CrossSubscriptionRestoreState Disabled +$updatedVault.Properties.RestoreSettings.CrossSubscriptionRestoreSettings.CrossSubscriptionRestoreState +``` + +```output +Disabled +``` + +The first cmdlet fetches the recovery services vault. +The second cmdlet updates CrossSubscriptionRestoreState of the recovery services vault. +The third command gets the cross subscription restore state of the vault. + +## PARAMETERS + +### -CrossSubscriptionRestoreState +Cross subscription restore state of the vault. Allowed values are "Enabled", "Disabled", "PermanentlyDisabled". + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.CrossSubscriptionRestoreState] +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled, PermanentlyDisabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAzureMonitorAlertsForJobFailure +Boolean paramter to specify whether built-in Azure Monitor alerts should be received for every job failure. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableClassicAlerts +Boolean paramter to specify whether backup alerts from the classic solution should be disabled or enabled. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityId +ARM Ids of the UserAssigned Identity to be added/removed. This is a comma separated list of Identity Ids. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The MSI type assigned to Recovery Services Vault. + +```yaml +Type: Microsoft.Azure.Commands.RecoveryServices.MSIdentity +Parameter Sets: AzureRSVaultAddMSIdentity +Aliases: +Accepted values: SystemAssigned, None, UserAssigned + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutabilityState +Immutability State of the vault. Allowed values are "Disabled", "Unlocked", "Locked". +Unlocked means Enabled and can be changed, Locked means Enabled and can't be changed. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.ImmutabilityState] +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, Unlocked, Locked + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +Specifies the name of the recovery services vault to update. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Parameter to Enable/Disable public network access of the vault. This setting is useful with Private Endpoints. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.PublicNetworkAccess] +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSystemAssigned +Provide this switch to remove SystemAssigned Identity from the vault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureRSVaultRemoveMSIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveUserAssigned +Provide this switch to remove UserAssigned Identity from the vault. Also, provide IdenityId parameter along with this switch. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureRSVaultRemoveMSIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specifies the name of the Azure resource group where recovery services vault is present. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.RecoveryServices.Models.Vault + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.RecoveryServices/Wait-AzRecoveryServicesBackupJob.md b/azps-10.1.0/Az.RecoveryServices/Wait-AzRecoveryServicesBackupJob.md new file mode 100644 index 0000000000..76cba3d337 --- /dev/null +++ b/azps-10.1.0/Az.RecoveryServices/Wait-AzRecoveryServicesBackupJob.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.Backup.dll-Help.xml +Module Name: Az.RecoveryServices +ms.assetid: F671A7CC-2A27-460E-B064-2FBF1B9C6A0B +online version: https://learn.microsoft.com/powershell/module/az.recoveryservices/wait-azrecoveryservicesbackupjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Wait-AzRecoveryServicesBackupJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RecoveryServices/RecoveryServices/help/Wait-AzRecoveryServicesBackupJob.md +--- + +# Wait-AzRecoveryServicesBackupJob + +## SYNOPSIS + +Waits for a Backup job to finish. + +## SYNTAX + +``` +Wait-AzRecoveryServicesBackupJob [-Job] <Object> [[-Timeout] <Int64>] [-VaultId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION + +The **Wait-AzRecoveryServicesBackupJob** cmdlet waits for an Azure Backup job to finish. +Backup jobs can take a long time. +If you run a backup job as part of a script, you may want to force the script to wait for job to finish before it continues to other tasks. +A script that includes this cmdlet can be simpler than one that polls the Backup service for the job status. +Set the vault context by using the -VaultId parameter. + +## EXAMPLES + +### Example 1: Wait for a job to finish + +```powershell +$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" +$Jobs = Get-AzRecoveryServicesBackupJob -Status InProgress -VaultId $vault.ID +Wait-AzRecoveryServicesBackupJob -Job $Jobs[0] -VaultId $vault.ID -Timeout 3600 +``` + +This script polls the first job that is currently in progress until the job has completed or timeout period of 1 hour expired. + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Job + +Specifies the job to wait for. +To obtain a **BackupJob** object, use the **Get-AzRecoveryServicesBackupJob** cmdlet. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Timeout + +Specifies the maximum time, in seconds, that this cmdlet waits for the job to finish. +It is recommended to specify a time-out value. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultId + +ARM ID of the Recovery Services Vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase + +## NOTES + +## RELATED LINKS + +[Get-AzRecoveryServicesBackupJob](./Get-AzRecoveryServicesBackupJob.md) diff --git a/azps-10.1.0/Az.RedisCache/Az.RedisCache.md b/azps-10.1.0/Az.RedisCache/Az.RedisCache.md new file mode 100644 index 0000000000..d290f60ee5 --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Az.RedisCache.md @@ -0,0 +1,78 @@ +--- +Module Name: Az.RedisCache +Module Guid: 820628d7-6938-488a-8760-43373a5ffce6 +Download Help Link: https://learn.microsoft.com/powershell/module/az.rediscache +Help Version: 4.1.2.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Az.RedisCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Az.RedisCache.md +--- + +# Az.RedisCache Module +## Description +This topic displays help topics for the Azure Redis Cache cmdlets. + +## Az.RedisCache Cmdlets +### [Export-AzRedisCache](Export-AzRedisCache.md) +Exports data from Azure Redis Cache to a container. + +### [Get-AzRedisCache](Get-AzRedisCache.md) +Gets a Redis Cache. + +### [Get-AzRedisCacheFirewallRule](Get-AzRedisCacheFirewallRule.md) +Get firewall rules set on Redis Cache. + +### [Get-AzRedisCacheKey](Get-AzRedisCacheKey.md) +Gets the access keys for a Redis Cache. + +### [Get-AzRedisCacheLink](Get-AzRedisCacheLink.md) +Get geo replication link for Redis Cache. + +### [Get-AzRedisCachePatchSchedule](Get-AzRedisCachePatchSchedule.md) +Gets a patch schedule. + +### [Import-AzRedisCache](Import-AzRedisCache.md) +Imports data from blobs to Azure Redis Cache. + +### [New-AzRedisCache](New-AzRedisCache.md) +Creates a Redis Cache. + +### [New-AzRedisCacheFirewallRule](New-AzRedisCacheFirewallRule.md) +Create a firewall rule on a Redis Cache. + +### [New-AzRedisCacheKey](New-AzRedisCacheKey.md) +Regenerates the access key of a Redis Cache. + +### [New-AzRedisCacheLink](New-AzRedisCacheLink.md) +Create a geo replication link between two Redis Caches. + +### [New-AzRedisCachePatchSchedule](New-AzRedisCachePatchSchedule.md) +Adds a patch schedule. + +### [New-AzRedisCacheScheduleEntry](New-AzRedisCacheScheduleEntry.md) +Creates a schedule entry. + +### [Remove-AzRedisCache](Remove-AzRedisCache.md) +Removes a Redis Cache. + +### [Remove-AzRedisCacheDiagnostic](Remove-AzRedisCacheDiagnostic.md) +Disables diagnostics on an Azure Redis Cache. + +### [Remove-AzRedisCacheFirewallRule](Remove-AzRedisCacheFirewallRule.md) +Remove a firewall rule from a Redis Cache. + +### [Remove-AzRedisCacheLink](Remove-AzRedisCacheLink.md) +Remove a geo replication link between two Redis Caches. + +### [Remove-AzRedisCachePatchSchedule](Remove-AzRedisCachePatchSchedule.md) +Removes the patch schedule. + +### [Reset-AzRedisCache](Reset-AzRedisCache.md) +Restarts nodes of a cache. + +### [Set-AzRedisCache](Set-AzRedisCache.md) +Modifies an Azure Cache for Redis. + +### [Set-AzRedisCacheDiagnostic](Set-AzRedisCacheDiagnostic.md) +Enables diagnostics on an Azure Redis Cache. + diff --git a/azps-10.1.0/Az.RedisCache/Export-AzRedisCache.md b/azps-10.1.0/Az.RedisCache/Export-AzRedisCache.md new file mode 100644 index 0000000000..c86c352269 --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Export-AzRedisCache.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: B447E492-D87E-4DA3-A8B0-0BAF603CCC26 +online version: https://learn.microsoft.com/powershell/module/az.rediscache/export-azrediscache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Export-AzRedisCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Export-AzRedisCache.md +--- + +# Export-AzRedisCache + +## SYNOPSIS +Exports data from Azure Redis Cache to a container. + +## SYNTAX + +``` +Export-AzRedisCache [-ResourceGroupName <String>] -Name <String> -Prefix <String> -Container <String> + [-Format <String>] [-PreferredDataArchiveAuthMethod <String>] [-StorageSubscriptionId <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Export-AzRedisCache** cmdlet exports data from Azure Redis Cache to a container. + +## EXAMPLES + +### Example 1: Export data +```powershell +Export-AzRedisCache -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" -Prefix "blobprefix" -Container "https://mystorageaccount.blob.core.windows.net/container18?sv=2015-04-05&sr=c&sig=HezZtBZ3DURmEGDduauE7pvETY4kqlPI8JCNa8ATmaw%3D&st=2016-05-27T00%3A00%3A00Z&se=2016-05-28T00%3A00%3A00Z&sp=rwdl" +``` + +This command exports data from an Azure Redis Cache instance into the container that is specified by the SAS URL. + +### Example 2: Export data using managed identity + +```powershell +Export-AzRedisCache -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" -Prefix "blobprefix" -Container "https://mystorageaccount.blob.core.windows.net/container18" -PreferredDataArchiveAuthMethod ManagedIdentity +``` + +This command exports data from an Azure Redis Cache instance into the container using managed identity as the authorization method. It assumes that both the cache and storage account have been configured to use managed identity. + +## PARAMETERS + +### -Container +Specifies the Service SAS URL of container where this cmdlet exports data. You can generate a Service SAS URL using the following PowerShell commands: +$storageAccountContext = New-AzStorageContext -StorageAccountName "storageName" -StorageAccountKey "key" +$sasKeyForContainer = New-AzStorageContainerSASToken -Name "containername" -Permission "rwdl" -StartTime ([System.DateTime]::Now).AddMinutes(-15) -ExpiryTime ([System.DateTime]::Now).AddHours(5) -Context $storageAccountContext -FullUri +Export-AzRedisCache -ResourceGroupName "ResourceGroupName" -Name "cacheName" -Prefix "blobprefix" -Container ($sasKeyForContainer) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +Specifies a format for the blob. +Currently rdb is the only supported format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a Boolean that indicates whether the operation succeeds. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredDataArchiveAuthMethod +Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Prefix +Specifies a prefix to use for blob names. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSubscriptionId +Subscription id of the storage container for data to be exported using ManagedIdentity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website + +## RELATED LINKS + +[Import-AzRedisCache](./Import-AzRedisCache.md) + +[New-AzRedisCache](./New-AzRedisCache.md) + +[Remove-AzRedisCache](./Remove-AzRedisCache.md) + +[Reset-AzRedisCache](./Reset-AzRedisCache.md) + +[Set-AzRedisCache](./Set-AzRedisCache.md) + + diff --git a/azps-10.1.0/Az.RedisCache/Get-AzRedisCache.md b/azps-10.1.0/Az.RedisCache/Get-AzRedisCache.md new file mode 100644 index 0000000000..8733518b1b --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Get-AzRedisCache.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: 8EF45FCE-5475-4A18-BFB0-C016E239612E +online version: https://learn.microsoft.com/powershell/module/az.rediscache/get-azrediscache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Get-AzRedisCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Get-AzRedisCache.md +--- + +# Get-AzRedisCache + +## SYNOPSIS +Gets a Redis Cache. + +## SYNTAX + +``` +Get-AzRedisCache [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRedisCache** cmdlet gets the specified Azure Redis Cache. +If you specify no parameters, this operation gets every Redis Cache for the current subscription. + +## EXAMPLES + +### Example 1: Get a Redis Cache by name +```powershell +Get-AzRedisCache -Name "myexists" +``` + +```output + ResourceGroupName : myGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myexists + Location : North Central US + Name : myexists + Type : Microsoft.Cache/Redis + HostName : myexists.redis.cache.windows.net + Port : 6379 + ProvisioningState : succeeded + SslPort : 6380 + RedisConfiguration : {} + EnableNonSslPort : False + RedisVersion : 2.8 + Size : 1GB + Sku : Basic + Tag : {} + Zone : [] +``` + +This command gets the Redis Cache named myexists. + +### Example 2: Get every Redis Cache in a resource group +```powershell +Get-AzRedisCache -ResourceGroupName "myGroup" +``` + +```output + ResourceGroupName : myGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myexists + Location : North Central US + Name : myexists + Type : Microsoft.Cache/Redis + HostName : myexists.redis.cache.windows.net + Port : 6379 + ProvisioningState : succeeded + SslPort : 6380 + RedisConfiguration : {} + EnableNonSslPort : False + RedisVersion : 2.8 + Size : 1GB + Sku : Basic + Tag : {} + Zone : [] + + ResourceGroupName : myGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myearlier + Location : North Central US + Name : myearlier + Type : Microsoft.Cache/Redis + HostName : myearlier.redis.cache.windows.net + Port : 6379 + ProvisioningState : succeeded + SslPort : 6380 + RedisConfiguration : {} + EnableNonSslPort : True + RedisVersion : 2.8 + Size : 250MB + Sku : Standard + Tag : {} + Zone : [] +``` + +This command gets every Redis Cache in the specified resource group. + +### Example 3: Get every Redis Cache in the current subscription +```powershell +Get-AzRedisCache +``` + +```output + ResourceGroupName : myGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myexists + Location : North Central US + Name : myexists + Type : Microsoft.Cache/Redis + HostName : myexists.redis.cache.windows.net + Port : 6379 + ProvisioningState : succeeded + SslPort : 6380 + RedisConfiguration : {} + EnableNonSslPort : False + RedisVersion : 2.8 + Size : 1GB + Sku : Basic + Tag : {} + Zone : [] + + ResourceGroupName : myGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myearlier + Location : North Central US + Name : myearlier + Type : Microsoft.Cache/Redis + HostName : myearlier.redis.cache.windows.net + Port : 6379 + ProvisioningState : succeeded + SslPort : 6380 + RedisConfiguration : {} + EnableNonSslPort : True + RedisVersion : 2.8 + Size : 250MB + Sku : Standard + Tag : {} + Zone : [] + + ResourceGroupName : myGroup2 + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup2/providers/Microsoft.Cache/Redis/myearlier2 + Location : North Central US + Name : myearlier2 + Type : Microsoft.Cache/Redis + HostName : myearlier2.redis.cache.windows.net + Port : 6379 + ProvisioningState : succeeded + SslPort : 6380 + RedisConfiguration : {} + EnableNonSslPort : False + RedisVersion : 2.8 + Size : 250MB + Sku : Basic + Tag : {} + Zone : [] +``` + +This command gets every Redis Cache in the current subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Redis Cache to get. +Use with the *ResourceGroupName* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Redis Cache to get. +If you specify only the *ResourceGroupName* parameter, this operation gets every Redis Cache in the specified resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RedisCache.Models.RedisCacheAttributes + +## NOTES + +## RELATED LINKS + +[New-AzRedisCache](./New-AzRedisCache.md) + +[Remove-AzRedisCache](./Remove-AzRedisCache.md) + +[Set-AzRedisCache](./Set-AzRedisCache.md) + + diff --git a/azps-10.1.0/Az.RedisCache/Get-AzRedisCacheFirewallRule.md b/azps-10.1.0/Az.RedisCache/Get-AzRedisCacheFirewallRule.md new file mode 100644 index 0000000000..748d0fc23a --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Get-AzRedisCacheFirewallRule.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +online version: https://learn.microsoft.com/powershell/module/az.rediscache/get-azrediscachefirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Get-AzRedisCacheFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Get-AzRedisCacheFirewallRule.md +--- + +# Get-AzRedisCacheFirewallRule + +## SYNOPSIS +Get firewall rules set on Redis Cache. + +## SYNTAX + +``` +Get-AzRedisCacheFirewallRule [-ResourceGroupName <String>] -Name <String> [-RuleName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +If **RuleName** parameter if provided, **Get-AzRedisCacheFirewallRule** cmdlet gets detail about the specified firewall rule on Azure Redis Cache. If only **Name** is specified this operation gets all firewall rules available on that Redis Cache. + +## EXAMPLES + +### Example 1: Get a single firewall rule +```powershell +Get-AzRedisCacheFirewallRule -Name "mycache" -RuleName "ruleone" +``` + +```output + ResourceGroupName : myGroup + Name : mycache + FirewallRuleId : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/mycache/firewallRules/ruleone + RuleName : ruleone + Type : Microsoft.Cache/Redis/firewallRules + StartIP : 10.0.0.1 + EndIP : 10.0.0.32 +``` + +This command gets firewall rule named ruleone from Redis Cache named mycache. + +### Example 2: Get all firewall rules +```powershell +Get-AzRedisCacheFirewallRule -Name "mycache" +``` + +```output + ResourceGroupName : myGroup + Name : mycache + FirewallRuleId : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/mycache/firewallRules/ruleone + RuleName : ruleone + Type : Microsoft.Cache/Redis/firewallRules + StartIP : 10.0.0.1 + EndIP : 10.0.0.32 + + ResourceGroupName : myGroup + Name : mycache + FirewallRuleId : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/mycache/firewallRules/ruletwo + RuleName : ruletwo + Type : Microsoft.Cache/Redis/firewallRules + StartIP : 10.0.0.33 + EndIP : 10.0.0.64 +``` + +This command gets all firewall rules from Redis Cache named mycache. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of redis cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group in which cache exists. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleName +Name of firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RedisCache.Models.PSRedisFirewallRule + +## NOTES + +## RELATED LINKS + +[New-AzRedisCacheFirewallRule](./New-AzRedisCacheFirewallRule.md) + +[Remove-AzRedisCacheFirewallRule](./Remove-AzRedisCacheFirewallRule.md) + +[Get-AzRedisCache](./Get-AzRedisCache.md) + +[New-AzRedisCache](./New-AzRedisCache.md) + +[Remove-AzRedisCache](./Remove-AzRedisCache.md) + +[Set-AzRedisCache](./Set-AzRedisCache.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.RedisCache/Get-AzRedisCacheKey.md b/azps-10.1.0/Az.RedisCache/Get-AzRedisCacheKey.md new file mode 100644 index 0000000000..2ea4a07f2d --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Get-AzRedisCacheKey.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: C0BEC701-8CE2-4B19-9F04-D32A42D9249E +online version: https://learn.microsoft.com/powershell/module/az.rediscache/get-azrediscachekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Get-AzRedisCacheKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Get-AzRedisCacheKey.md +--- + +# Get-AzRedisCacheKey + +## SYNOPSIS +Gets the access keys for a Redis Cache. + +## SYNTAX + +``` +Get-AzRedisCacheKey [-ResourceGroupName <String>] -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRedisCacheKey** cmdlet gets the access keys for an Azure Redis Cache. + +## EXAMPLES + +### Example 1: Get the access keys for a Redis Cache +```powershell +Get-AzRedisCacheKey -ResourceGroupName "MyResourceGroup" -Name "MyCacheKey" +``` + +```output +PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= +SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= +``` + +This command gets the access keys named MyCacheKey. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a Redis Cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Redis Cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Redis.Models.RedisAccessKeys + +## NOTES + +## RELATED LINKS + +[New-AzRedisCacheKey](./New-AzRedisCacheKey.md) + + diff --git a/azps-10.1.0/Az.RedisCache/Get-AzRedisCacheLink.md b/azps-10.1.0/Az.RedisCache/Get-AzRedisCacheLink.md new file mode 100644 index 0000000000..fe9b70697e --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Get-AzRedisCacheLink.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +online version: https://learn.microsoft.com/powershell/module/az.rediscache/get-azrediscachelink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Get-AzRedisCacheLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Get-AzRedisCacheLink.md +--- + +# Get-AzRedisCacheLink + +## SYNOPSIS +Get geo replication link for Redis Cache. + +## SYNTAX + +### AllLinksForCache (Default) +``` +Get-AzRedisCacheLink -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AllLinksForPrimaryCache +``` +Get-AzRedisCacheLink -PrimaryServerName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SingleLink +``` +Get-AzRedisCacheLink -PrimaryServerName <String> -SecondaryServerName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AllLinksForSecondaryCache +``` +Get-AzRedisCacheLink -SecondaryServerName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +There are four different ways to get geo-replication link detail. Either provide parameter Name or PrimaryServerName and/or SecondaryServerName. Name is given then all link where cache exists will be returned. If only PrimaryServerName is given then all links where cache is primary will be returned. If only SecondaryServerName is given then all links where cache is secondary will be returned. If PrimaryServerName and SecondaryServerName both are given then specific link with correct role will be returned. + +## EXAMPLES + +### Example 1: Get using parameter set AllLinksForCache +```powershell +Get-AzRedisCacheLink -Name "mycache1" +``` + +```output + PrimaryServerName : mycache1 + SecondaryServerName : mycache2 + ProvisioningState : Succeeded + LinkedRedisCacheLocation : East US + ServerRole : Secondary + PrimaryHostName : mycache1.redis.cache.windows.net + GeoReplicatedPrimaryHostName : mycache2.geo.redis.cache.windows.net +``` + +This command gets all geo-replication links for Redis Cache named mycache1. + +### Example 2: Get using parameter set AllLinksForPrimaryCache +```powershell +Get-AzRedisCacheLink -PrimaryServerName "mycache1" +``` + +```output + PrimaryServerName : mycache1 + SecondaryServerName : mycache2 + ProvisioningState : Succeeded + LinkedRedisCacheLocation : East US + ServerRole : Secondary + PrimaryHostName : mycache1.redis.cache.windows.net + GeoReplicatedPrimaryHostName : mycache2.geo.redis.cache.windows.net +``` + +This command gets geo-replication links where Redis Cache named mycache1 is primary. + +### Example 3: Get using parameter set AllLinksForSecondaryCache +```powershell +Get-AzRedisCacheLink -SecondaryServerName "mycache2" +``` + +```output + PrimaryServerName : mycache1 + SecondaryServerName : mycache2 + ProvisioningState : Succeeded + LinkedRedisCacheLocation : East US + ServerRole : Secondary + PrimaryHostName : mycache1.redis.cache.windows.net + GeoReplicatedPrimaryHostName : mycache2.geo.redis.cache.windows.net +``` + +This command gets geo-replication links where Redis Cache named mycache2 is secondary. + +### Example 4: Get using parameter set SingleLink +```powershell +Get-AzRedisCacheLink -PrimaryServerName "mycache1" -SecondaryServerName "mycache2" +``` + +```output + PrimaryServerName : mycache1 + SecondaryServerName : mycache2 + ProvisioningState : Succeeded + LinkedRedisCacheLocation : East US + ServerRole : Secondary + PrimaryHostName : mycache1.redis.cache.windows.net + GeoReplicatedPrimaryHostName : mycache2.geo.redis.cache.windows.net +``` + +This command gets a single geo-replication links where Redis Cache named mycache1 is primary and Redis Cache named mycache2 is secondary. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of redis cache. + +```yaml +Type: System.String +Parameter Sets: AllLinksForCache +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PrimaryServerName +Name of primary redis cache in link. + +```yaml +Type: System.String +Parameter Sets: AllLinksForPrimaryCache, SingleLink +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryServerName +Name of secondary redis cache in link. + +```yaml +Type: System.String +Parameter Sets: SingleLink, AllLinksForSecondaryCache +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RedisCache.Models.PSRedisLinkedServer + +## NOTES + +## RELATED LINKS + +[New-AzRedisCacheLink](./New-AzRedisCacheLink.md) + +[Remove-AzRedisCacheLink](./Remove-AzRedisCacheLink.md) + +[Get-AzRedisCache](./Get-AzRedisCache.md) + +[New-AzRedisCache](./New-AzRedisCache.md) + +[Remove-AzRedisCache](./Remove-AzRedisCache.md) + +[Set-AzRedisCache](./Set-AzRedisCache.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.RedisCache/Get-AzRedisCachePatchSchedule.md b/azps-10.1.0/Az.RedisCache/Get-AzRedisCachePatchSchedule.md new file mode 100644 index 0000000000..7b241e900e --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Get-AzRedisCachePatchSchedule.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: DA180A4A-88B6-4359-94E0-CF72F66D1FE4 +online version: https://learn.microsoft.com/powershell/module/az.rediscache/get-azrediscachepatchschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Get-AzRedisCachePatchSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Get-AzRedisCachePatchSchedule.md +--- + +# Get-AzRedisCachePatchSchedule + +## SYNOPSIS +Gets a patch schedule. + +## SYNTAX + +``` +Get-AzRedisCachePatchSchedule [-ResourceGroupName <String>] -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRedisCachePatchSchedule** cmdlet gets a patch schedule for a cache in Azure Redis Cache. + +## EXAMPLES + +### Example 1: Get the patch schedule +```powershell +Get-AzRedisCachePatchSchedule -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" +``` + +This command gets the patch schedule from the cache named RedisCache06. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group which contains the cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RedisCache.Models.PSScheduleEntry + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website + +## RELATED LINKS + +[New-AzRedisCachePatchSchedule](./New-AzRedisCachePatchSchedule.md) + +[New-AzRedisCacheScheduleEntry](./New-AzRedisCacheScheduleEntry.md) + +[Remove-AzRedisCachePatchSchedule](./Remove-AzRedisCachePatchSchedule.md) + + diff --git a/azps-10.1.0/Az.RedisCache/Import-AzRedisCache.md b/azps-10.1.0/Az.RedisCache/Import-AzRedisCache.md new file mode 100644 index 0000000000..a433b2ba94 --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Import-AzRedisCache.md @@ -0,0 +1,244 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: BC00DEF9-6A93-4DF5-8E5B-C488551BA1D1 +online version: https://learn.microsoft.com/powershell/module/az.rediscache/import-azrediscache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Import-AzRedisCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Import-AzRedisCache.md +--- + +# Import-AzRedisCache + +## SYNOPSIS +Imports data from blobs to Azure Redis Cache. + +## SYNTAX + +``` +Import-AzRedisCache [-ResourceGroupName <String>] -Name <String> -Files <String[]> [-Format <String>] + [-PreferredDataArchiveAuthMethod <String>] [-StorageSubscriptionId <String>] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Import-AzRedisCache** cmdlet imports data from blobs into Azure Redis Cache. + +## EXAMPLES + +### Example 1: Import data +```powershell +Import-AzRedisCache -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" -Files @("https://mystorageaccount.blob.core.windows.net/container22/blobname?sv=2015-04-05&sr=b&sig=caIwutG2uDa0NZ8mjdNJdgOY8%2F8mhwRuGNdICU%2B0pI4%3D&st=2016-05-27T00%3A00%3A00Z&se=2016-05-28T00%3A00%3A00Z&sp=rwd") -Force +``` + +This command imports data from the blob that is specified by the SAS URL into Azure Redis Cache. + +### Example 2: Import data using managed identity +```powershell +Import-AzRedisCache -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" -Files @("https://mystorageaccount.blob.core.windows.net/container22/blobname") -Force -PreferredDataArchiveAuthMethod ManagedIdentity +``` + +This command imports data from the blob that is specified into Azure Redis Cache using managed identity as the authorization method. It assumes that both the cache and storage account have been configured to use managed identity. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Files +Specifies the SAS URLs of blobs whose content this cmdlet imports into the cache. You can generate the SAS URLs using the following PowerShell commands: +$storageAccountContext = New-AzStorageContext -StorageAccountName "storageName" -StorageAccountKey "key" +$sasKeyForBlob = New-AzStorageBlobSASToken -Container "containerName" -blob "blobName" -Permission "rwdl" -StartTime ([System.DateTime]::Now).AddMinutes(-15) -ExpiryTime ([System.DateTime]::Now).AddHours(5) -Context $storageAccountContext -FullUri +Import-AzRedisCache -ResourceGroupName "ResourceGroupName" -Name "cacheName" -Files ($sasKeyForBlob) -Force + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +Specifies the format of the blob. +Currently rdb is the only supported format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a Boolean that indicates whether the operation succeeds. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredDataArchiveAuthMethod +Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSubscriptionId +Subscription id of the storage container containing files to import using Managed Identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### System.Boolean + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website + +## RELATED LINKS + +[Export-AzRedisCache](./Export-AzRedisCache.md) + +[New-AzRedisCache](./New-AzRedisCache.md) + +[Remove-AzRedisCache](./Remove-AzRedisCache.md) + +[Reset-AzRedisCache](./Reset-AzRedisCache.md) + +[Set-AzRedisCache](./Set-AzRedisCache.md) + + diff --git a/azps-10.1.0/Az.RedisCache/New-AzRedisCache.md b/azps-10.1.0/Az.RedisCache/New-AzRedisCache.md new file mode 100644 index 0000000000..3f4fdde9fc --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/New-AzRedisCache.md @@ -0,0 +1,665 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: 81179AFE-6524-4F59-8BC2-3E152F51D1DD +online version: https://learn.microsoft.com/powershell/module/az.rediscache/new-azrediscache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/New-AzRedisCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/New-AzRedisCache.md +--- + +# New-AzRedisCache + +## SYNOPSIS +Creates a Redis Cache. + +## SYNTAX + +``` +New-AzRedisCache -ResourceGroupName <String> -Name <String> -Location <String> [-Size <String>] [-Sku <String>] + [-RedisConfiguration <Hashtable>] [-EnableNonSslPort <Boolean>] [-TenantSettings <Hashtable>] + [-ShardCount <Int32>] [-MinimumTlsVersion <String>] [-SubnetId <String>] [-StaticIP <String>] + [-Tag <Hashtable>] [-Zone <String[]>] [-RedisVersion <String>] [-IdentityType <String>] + [-UserAssignedIdentity <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRedisCache** cmdlet creates an Azure Redis Cache. + +## EXAMPLES + +### Example 1: Create a Redis Cache +```powershell +New-AzRedisCache -ResourceGroupName "MyGroup" -Name "MyCache" -Location "North Central US" +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/mycache + Location : North Central US + Name : MyCache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : creating + SslPort : 6380 + RedisConfiguration : {} + EnableNonSslPort : False + RedisVersion : 2.8 + Size : 1GB + Sku : Standard + Tag : {} + Zone : [] +``` + +This command creates a Redis Cache. + +### Example 2: Create a Standard SKU Redis Cache +```powershell +New-AzRedisCache -ResourceGroupName "MyGroup" -Name "MyCache" -Location "North Central US" -Size 250MB -Sku "Standard" -RedisConfiguration @{"maxmemory-policy" = "allkeys-random"} +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache + Location : North Central US + Name : mycache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : creating + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random]} + EnableNonSslPort : False + RedisVersion : 2.8 + Size : 250MB + Sku : Standard + Tag : {} + Zone : [] +``` + +This cmdlet creates a cache using Azure Cache for Redis. + +### Example 3: Create a Zone Redundant Cache + +```powershell +New-AzRedisCache -ResourceGroupName "MyGroup" -Name "MyCache" -Location "Central US" -Size P1 -Sku "Premium" -Zone @("1","2") +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache + Location : Central US + Name : mycache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : creating + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random], [maxclients, 7500], [maxmemory-reserved, 200], + [maxfragmentationmemory-reserved, 300]...} + EnableNonSslPort : False + RedisVersion : 4.0.14 + Size : 6GB + Sku : Premium + Tag : {} + Zone : {1, 2} +``` + +This command creates Azure cache for Redis instance in mutliple zones. + +### Example 4: Create a Virtual Network enable Cache + +Requirements for creating Virtual Network enable cache. +1. Create the virtual network in same resource group in which you want to create your redis cache. You can create virtual network from [New-AzVirtualNetwork](/powershell/module/az.network/new-azvirtualnetwork) powershell command. +1. You will need SubnetID for VNET enable cache. Syntax of SubnetID is given below. + +Format of SubnetID: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/providers/Microsoft.ClassicNetwork/VirtualNetworks/{vnetName}/subnets/{subnetName} + +```powershell +New-AzRedisCache -ResourceGroupName "MyGroup" -Name "MyCache" -Location "Central US" -Size P1 -Sku "Premium" -SubnetId "/subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Network/virtualNetworks/MyNet/subnets/MySubnet" +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache + Location : Central US + Name : mycache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : creating + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random], [maxclients, 7500], [maxmemory-reserved, 200], + [maxfragmentationmemory-reserved, 300]...} + EnableNonSslPort : False + RedisVersion : 4.0.14 + Size : 6GB + Sku : Premium + SubnetId : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Network/virtualNetworks/MyNet/subnets/MySubnet + StaticIP : 10.0.0.4 + Tag : {} + Zone : [] +``` + +### Example 5: Configure data persistence for a Premium Azure Cache for Redis + +Persistence writes Redis data into an Azure Storage account that you own and manage. So before configuring data persistence you need to have [storage account](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-powershell) in same resource group. Choose a storage account in the same region and subscription as the cache, and a Premium Storage account is recommended because premium storage has higher throughput. + +After creating a storage account, get the storage account connection string using this procedure. + +1. Run this command **Get-AzStorageAccountKey -ResourceGroupName $resourceGroupName -Name $storageAccountName** in powershell. +1. From the output of above, copy any key. +1. Put the storage account key and the storage account name in format below to get the connection string of your storage account. + +Connection String Format :- "DefaultEndpointsProtocol=https;AccountName={storageAccountName};AccountKey={storageAccountKey};EndpointSuffix=mySuffix"</br> + +You must have the specific Redis configuration settings to enable data persistence. + +For RDB backup enable +- rdb-backup-enabled (Set true or false) +- rdb-storage-connection-string (Give connection string in above format.) +- rdb-backup-frequency (Set a backup interval in minutes. You can only choose from - 15, 30, 60, 360, 720 and 1440 minutes.) + + + +```powershell +New-AzRedisCache -ResourceGroupName "MyGroup" -Name "MyCache" -Location "Central US" -Size P1 -Sku "Premium" -RedisConfiguration @{"rdb-backup-enabled" = "true"; "rdb-storage-connection-string" = "DefaultEndpointsProtocol=https;AccountName=mystorageaccount;AccountKey=pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo=;EndpointSuffix=mySuffix"; "rdb-backup-frequency" = "30"} +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache + Location : Central US + Name : mycache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : creating + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random], [maxclients, 7500], [maxmemory-reserved, 200], + [maxfragmentationmemory-reserved, 300], [rdb-backup-enabled, true]....} + EnableNonSslPort : False + RedisVersion : 4.0.14 + Size : 6GB + Sku : Premium + Tag : {} + Zone : [] +``` + +### Example 6: Configure data persistence for a Premium Azure Cache for Redis - AOF backup enabled + +For AOF back up enabled. +- aof-backup-enabled (Set true or false), +- aof-storage-connection-string-0 (Give connection string in above format.) +- aof-storage-connection-string-1 (You can optionally configure another storage account. If a second storage account is configured, the writes to the replica cache are written to this second storage account.) + +```powershell +New-AzRedisCache -ResourceGroupName "MyGroup" -Name "MyCache" -Location "Central US" -Size P1 -Sku "Premium" -RedisConfiguration @{"aof-backup-enabled" = "true"; "aof-storage-connection-string-0" = "DefaultEndpointsProtocol=https;AccountName=mystorageaccount;AccountKey=pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo=;EndpointSuffix=mySuffix"} +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache + Location : Central US + Name : mycache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : creating + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random], [maxclients, 7500], [maxmemory-reserved, 200], + [maxfragmentationmemory-reserved, 300], [aof-backup-enabled, true]...} + EnableNonSslPort : False + RedisVersion : 4.0.14 + Size : 6GB + Sku : Premium + Tag : {} + Zone : [] +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNonSslPort +Indicates whether the non-SSL port is enabled. +The default value is $False (the non-SSL port is disabled). + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityType +Specifies the type of identity used for the Azure Cache for Redis. Valid values: "SystemAssigned" or "UserAssigned" or "SystemAssignedUserAssigned" or "None" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the location in which to create a Redis Cache. +Valid values are: +- North Central US +- South Central US +- Central US +- West Europe +- North Europe +- West US +- East US +- East US 2 +- Japan East +- Japan West +- Brazil South +- Southeast Asia +- East Asia +- Australia East +- Australia Southeast + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +Specify the TLS version required by clients to connect to cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Redis Cache to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RedisConfiguration +Specifies Redis configuration settings. +The acceptable values for this parameter are: +- rdb-backup-enabled. +Specifies that Redis data persistence is enabled. +Premium tier only. +- rdb-storage-connection-string. +Specifies the connection string to the Storage account for Redis data persistence. +Premium tier only. +- rdb-backup-frequency. +Specifies the backup frequency for Redis data persistence. +Premium tier only. +- maxmemory-reserved. +Configures the memory reserved for non-cache processes. +Standard and Premium tiers. +- maxmemory-policy. +Configures the eviction policy for the cache. +All pricing tiers. +- notify-keyspace-events. +Configures keyspace notifications. +Standard and premium tiers. +- hash-max-ziplist-entries. +Configures memory optimization for small aggregate data types. +Standard and Premium tiers. +- hash-max-ziplist-value. +Configures memory optimization for small aggregate data types. +Standard and Premium tiers. +- set-max-intset-entries. +Configures memory optimization for small aggregate data types. +Standard and Premium tiers. +- zset-max-ziplist-entries. +Configures memory optimization for small aggregate data types. +Standard and Premium tiers. +- zset-max-ziplist-value. +Configures memory optimization for small aggregate data types. +Standard and Premium tiers. +- databases. +Configures the number of databases. +This property can be configured only at cache creation. +Standard and Premium tiers. +For more information, see Manage Azure Redis Cache with Azure PowerShellhttp://go.microsoft.com/fwlink/?LinkId=800051 (http://go.microsoft.com/fwlink/?LinkId=800051). +- preferred-data-archive-auth-method +Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS +- preferred-data-persistence-auth-method +Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RedisVersion +Redis version. This should be in the form 'major[.minor]' (only 'major' is required) or the value 'latest' which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is 'latest'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group in which to create the Redis Cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShardCount +Specifies the number of shards to create on a Premium cluster cache. +The acceptable values for this parameter are: +- 1 +- 2 +- 3 +- 4 +- 5 +- 6 +- 7 +- 8 +- 9 +- 10 + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Size +Specifies the size of the Redis Cache. +Valid values are: +- P1 +- P2 +- P3 +- P4 +- P5 +- C0 +- C1 +- C2 +- C3 +- C4 +- C5 +- C6 +- 250MB +- 1GB +- 2.5GB +- 6GB +- 13GB +- 26GB +- 53GB +The default value is 1GB or C1. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Specifies the SKU of the Redis Cache to create. +Valid values are: +- Basic +- Standard +- Premium +The default value is Standard. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, Standard, Premium + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StaticIP +Specifies a unique IP address in the subnet for the Redis Cache. +If you do not specify a value for this parameter, this cmdlet chooses an IP address from the subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubnetId +The full resource ID of a subnet in a virtual network to deploy the Azure Cache for Redis in. +Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/{vnetName}/subnets/{subnetName} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantSettings +This parameter has been deprecated. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +Specifies one or more comma seperated user identities to be associated with the Azure Cache for Redis. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Zone +List of Azure regions with [Availability zones](https://learn.microsoft.com/en-us/azure/availability-zones/az-region#azure-services-supporting-availability-zones). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.RedisCache.Models.RedisCacheAttributesWithAccessKeys + +## NOTES + +## RELATED LINKS + +[Get-AzRedisCache](./Get-AzRedisCache.md) + +[Remove-AzRedisCache](./Remove-AzRedisCache.md) + +[Set-AzRedisCache](./Set-AzRedisCache.md) + + diff --git a/azps-10.1.0/Az.RedisCache/New-AzRedisCacheFirewallRule.md b/azps-10.1.0/Az.RedisCache/New-AzRedisCacheFirewallRule.md new file mode 100644 index 0000000000..415c0e8aad --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/New-AzRedisCacheFirewallRule.md @@ -0,0 +1,237 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +online version: https://learn.microsoft.com/powershell/module/az.rediscache/new-azrediscachefirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/New-AzRedisCacheFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/New-AzRedisCacheFirewallRule.md +--- + +# New-AzRedisCacheFirewallRule + +## SYNOPSIS +Create a firewall rule on a Redis Cache. + +## SYNTAX + +### NormalParameterSet (Default) +``` +New-AzRedisCacheFirewallRule [-ResourceGroupName <String>] -Name <String> -RuleName <String> -StartIP <String> + -EndIP <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RedisCacheAttributesObject +``` +New-AzRedisCacheFirewallRule -InputObject <RedisCacheAttributes> -RuleName <String> -StartIP <String> + -EndIP <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +New-AzRedisCacheFirewallRule -ResourceId <String> -RuleName <String> -StartIP <String> -EndIP <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a firewall rule on a Redis Cache. + +## EXAMPLES + +### Example 1: Create a firewall rule +```powershell +New-AzRedisCacheFirewallRule -Name "mycache" -RuleName "ruleone" -StartIP "10.0.0.1" -EndIP "10.0.0.32" +``` + +```output + ResourceGroupName : myGroup + Name : mycache + FirewallRuleId : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/mycache/firewallRules/ruleone + RuleName : ruleone + Type : Microsoft.Cache/Redis/firewallRules + StartIP : 10.0.0.1 + EndIP : 10.0.0.32 +``` + +This command creates firewall rule named ruleone on Redis Cache named mycache. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIP +Ending IP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +object of type RedisCacheAttributes + +```yaml +Type: Microsoft.Azure.Commands.RedisCache.Models.RedisCacheAttributes +Parameter Sets: RedisCacheAttributesObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of redis cache. + +```yaml +Type: System.String +Parameter Sets: NormalParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group in which cache exists. + +```yaml +Type: System.String +Parameter Sets: NormalParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +ARM Id of Redis Cache. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleName +Name of firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartIP +Starting IP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.RedisCache.Models.RedisCacheAttributes + +## OUTPUTS + +### Microsoft.Azure.Commands.RedisCache.Models.PSRedisFirewallRule + +## NOTES + +## RELATED LINKS + +[Get-AzRedisCacheFirewallRule](./Get-AzRedisCacheFirewallRule.md) + +[Remove-AzRedisCacheFirewallRule](./Remove-AzRedisCacheFirewallRule.md) + +[Get-AzRedisCache](./Get-AzRedisCache.md) + +[New-AzRedisCache](./New-AzRedisCache.md) + +[Remove-AzRedisCache](./Remove-AzRedisCache.md) + +[Set-AzRedisCache](./Set-AzRedisCache.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.RedisCache/New-AzRedisCacheKey.md b/azps-10.1.0/Az.RedisCache/New-AzRedisCacheKey.md new file mode 100644 index 0000000000..e04a3e4a17 --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/New-AzRedisCacheKey.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: 1F86CE62-AA01-44FB-A935-484EC51DDE5A +online version: https://learn.microsoft.com/powershell/module/az.rediscache/new-azrediscachekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/New-AzRedisCacheKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/New-AzRedisCacheKey.md +--- + +# New-AzRedisCacheKey + +## SYNOPSIS +Regenerates the access key of a Redis Cache. + +## SYNTAX + +``` +New-AzRedisCacheKey [-ResourceGroupName <String>] -Name <String> -KeyType <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRedisCacheKey** cmdlet regenerates the access key of an Azure Redis Cache. + +## EXAMPLES + +### Example 1: Regenerate a primary key +```powershell +New-AzRedisCacheKey -ResourceGroupName "ResourceGroup03" -Name "myCache" -KeyType "Primary" -Force +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= +``` + +This command regenerates the primary key of a Redis Cache. + +### Example 2: Regenerate a secondary key +```powershell +New-AzRedisCacheKey -ResourceGroupName "ResourceGroup03" -Name "myCache" -KeyType "Secondary" -Force +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= +``` + +This command regenerates the secondary key of a Redis Cache. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyType +Specifies whether to regenerate the primary or secondary access key. +Valid values are: Primary, Secondary. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Redis Cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Redis Cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Redis.Models.RedisAccessKeys + +## NOTES + +## RELATED LINKS + +[Get-AzRedisCacheKey](./Get-AzRedisCacheKey.md) + + diff --git a/azps-10.1.0/Az.RedisCache/New-AzRedisCacheLink.md b/azps-10.1.0/Az.RedisCache/New-AzRedisCacheLink.md new file mode 100644 index 0000000000..e11bc0fb9a --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/New-AzRedisCacheLink.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +online version: https://learn.microsoft.com/powershell/module/az.rediscache/new-azrediscachelink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/New-AzRedisCacheLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/New-AzRedisCacheLink.md +--- + +# New-AzRedisCacheLink + +## SYNOPSIS +Create a geo replication link between two Redis Caches. + +## SYNTAX + +``` +New-AzRedisCacheLink -PrimaryServerName <String> -SecondaryServerName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a geo replication link between two Redis Caches. + +## EXAMPLES + +### Example 1: Create a link between two caches +```powershell +New-AzRedisCacheLink -PrimaryServerName "mycache1" -SecondaryServerName "mycache2" +``` + +```output + PrimaryServerName : mycache1 + SecondaryServerName : mycache2 + ProvisioningState : Creating + LinkedRedisCacheLocation : East US + ServerRole : Secondary + PrimaryHostName : mycache1.redis.cache.windows.net + GeoReplicatedPrimaryHostName : mycache2.geo.redis.cache.windows.net +``` + +This command creates geo-replication link between Redis Cache mycache1 and mycache2. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryServerName +Name of primary redis cache in link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryServerName +Name of secondary redis cache in link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.RedisCache.Models.PSRedisLinkedServer + +## NOTES + +## RELATED LINKS + +[Get-AzRedisCacheLink](./Get-AzRedisCacheLink.md) + +[Remove-AzRedisCacheLink](./Remove-AzRedisCacheLink.md) + +[Get-AzRedisCache](./Get-AzRedisCache.md) + +[New-AzRedisCache](./New-AzRedisCache.md) + +[Remove-AzRedisCache](./Remove-AzRedisCache.md) + +[Set-AzRedisCache](./Set-AzRedisCache.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.RedisCache/New-AzRedisCachePatchSchedule.md b/azps-10.1.0/Az.RedisCache/New-AzRedisCachePatchSchedule.md new file mode 100644 index 0000000000..c19a948197 --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/New-AzRedisCachePatchSchedule.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: F7FAFF52-5E07-4D88-B48F-BC70C43E8691 +online version: https://learn.microsoft.com/powershell/module/az.rediscache/new-azrediscachepatchschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/New-AzRedisCachePatchSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/New-AzRedisCachePatchSchedule.md +--- + +# New-AzRedisCachePatchSchedule + +## SYNOPSIS +Adds a patch schedule. + +## SYNTAX + +``` +New-AzRedisCachePatchSchedule [-ResourceGroupName <String>] -Name <String> -Entries <PSScheduleEntry[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRedisCachePatchSchedule** cmdlet adds a patch schedule to a cache in Azure Redis Cache. + +## EXAMPLES + +### Example 1: Create and add a patch schedule on a cache +```powershell +New-AzRedisCachePatchSchedule -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" -Entries @(New-AzRedisCacheScheduleEntry -DayOfWeek "Weekend" -StartHourUtc 2 -MaintenanceWindow "06:00:00") +``` + +This command adds a patch schedule to the cache named RedisCache06. +The Entries parameter takes as its value a command that uses **New-AzRedisCacheScheduleEntry** to create a schedule. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Entries +Specifies an array of schedules that this cmdlet sets on a cache. +To obtain a **PSScheduleEntry** object, use the New-AzRedisCacheScheduleEntry cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.RedisCache.Models.PSScheduleEntry[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group which contains the cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.RedisCache.Models.PSScheduleEntry[] + +## OUTPUTS + +### Microsoft.Azure.Commands.RedisCache.Models.PSScheduleEntry + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website + +## RELATED LINKS + +[Get-AzRedisCachePatchSchedule](./Get-AzRedisCachePatchSchedule.md) + +[New-AzRedisCacheScheduleEntry](./New-AzRedisCacheScheduleEntry.md) + +[Remove-AzRedisCachePatchSchedule](./Remove-AzRedisCachePatchSchedule.md) + + diff --git a/azps-10.1.0/Az.RedisCache/New-AzRedisCacheScheduleEntry.md b/azps-10.1.0/Az.RedisCache/New-AzRedisCacheScheduleEntry.md new file mode 100644 index 0000000000..7309d76aae --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/New-AzRedisCacheScheduleEntry.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: ACB53C23-99E0-4A0A-A44E-0D3FDB12450B +online version: https://learn.microsoft.com/powershell/module/az.rediscache/new-azrediscachescheduleentry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/New-AzRedisCacheScheduleEntry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/New-AzRedisCacheScheduleEntry.md +--- + +# New-AzRedisCacheScheduleEntry + +## SYNOPSIS +Creates a schedule entry. + +## SYNTAX + +``` +New-AzRedisCacheScheduleEntry -DayOfWeek <String> -StartHourUtc <Int32> [-MaintenanceWindow <TimeSpan>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRedisCacheScheduleEntry** cmdlet creates a **PSScheduleEntry** object. +Azure Redis Cache patch schedule cmdlets, such as the New-AzRedisCachePatchSchedule cmdlet, require schedule entry objects. + +## EXAMPLES + +### Example 1: Create a schedule entry for weekends +```powershell +New-AzRedisCacheScheduleEntry -DayOfWeek "Weekend" -StartHourUtc 2 -MaintenanceWindow "06:00:00" +``` + +This command creates a **PSScheduleEntry** object that represents a weekend schedule that has the specified start time and window. + +## PARAMETERS + +### -DayOfWeek +Specifies the day of the week for the schedule entry. +The acceptable values for this parameter are: +- Everyday +- Weekend +- Monday +- Tuesday +- Wednesday +- Thursday +- Friday +- Saturday +- Sunday + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Everyday, Weekend, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceWindow +Specifies the amount of time window allowed for updates. + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartHourUtc +Specifies an hour of the day when the schedule starts. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +### System.Nullable`1[[System.TimeSpan, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.RedisCache.Models.PSScheduleEntry + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website + +## RELATED LINKS + +[Get-AzRedisCachePatchSchedule](./Get-AzRedisCachePatchSchedule.md) + +[New-AzRedisCachePatchSchedule](./New-AzRedisCachePatchSchedule.md) + +[Remove-AzRedisCachePatchSchedule](./Remove-AzRedisCachePatchSchedule.md) + + diff --git a/azps-10.1.0/Az.RedisCache/Remove-AzRedisCache.md b/azps-10.1.0/Az.RedisCache/Remove-AzRedisCache.md new file mode 100644 index 0000000000..2b01c0a95d --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Remove-AzRedisCache.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: A22D930B-5026-4915-B498-EE31153E1E9A +online version: https://learn.microsoft.com/powershell/module/az.rediscache/remove-azrediscache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Remove-AzRedisCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Remove-AzRedisCache.md +--- + +# Remove-AzRedisCache + +## SYNOPSIS +Removes a Redis Cache. + +## SYNTAX + +``` +Remove-AzRedisCache [-ResourceGroupName <String>] -Name <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRedisCache** cmdlet removes an Azure Redis Cache. + +## EXAMPLES + +### Example 1: Remove a Redis Cache and return the result +```powershell +Remove-AzRedisCache -ResourceGroupName "ResourceGroup03" -Name "myCache" -Force -PassThru +``` + +```output +True +``` + +This command removes a Redis Cache and displays whether the operation is successful. + +### Example 2: Remove a Redis Cache and do not display the result +```powershell +Remove-AzRedisCache -ResourceGroupName "ResourceGroup03" -Name "myCache" -Force +``` + +This command removes a Redis Cache. +Because the *PassThru* parameter is not specified, the result of the operation is not displayed. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Redis Cache to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Redis Cache to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzRedisCache](./Get-AzRedisCache.md) + +[New-AzRedisCache](./New-AzRedisCache.md) + +[Set-AzRedisCache](./Set-AzRedisCache.md) + + diff --git a/azps-10.1.0/Az.RedisCache/Remove-AzRedisCacheDiagnostic.md b/azps-10.1.0/Az.RedisCache/Remove-AzRedisCacheDiagnostic.md new file mode 100644 index 0000000000..b7a6392900 --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Remove-AzRedisCacheDiagnostic.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: BCF989AE-A718-4AFE-B7C0-8B148468D4EE +online version: https://learn.microsoft.com/powershell/module/az.rediscache/remove-azrediscachediagnostic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Remove-AzRedisCacheDiagnostic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Remove-AzRedisCacheDiagnostic.md +--- + +# Remove-AzRedisCacheDiagnostic + +## SYNOPSIS +Disables diagnostics on an Azure Redis Cache. + +## SYNTAX + +``` +Remove-AzRedisCacheDiagnostic [-ResourceGroupName <String>] -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRedisCacheDiagnostic** cmdlet disables diagnostics on an Azure Redis Cache. + +## EXAMPLES + +### Example 1: Disable diagnostics +```powershell +Remove-AzRedisCacheDiagnostic -ResourceGroupName "ContosoResourceGroup" -Name "PeakCache" +``` + +This command disables diagnostics on specified Azure Redis Cache. +This disables diagnostics for all Azure Redis Caches in the same region for the subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website + +## RELATED LINKS + +[Set-AzRedisCacheDiagnostic](./Set-AzRedisCacheDiagnostic.md) + + diff --git a/azps-10.1.0/Az.RedisCache/Remove-AzRedisCacheFirewallRule.md b/azps-10.1.0/Az.RedisCache/Remove-AzRedisCacheFirewallRule.md new file mode 100644 index 0000000000..9c7fc65dd3 --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Remove-AzRedisCacheFirewallRule.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +online version: https://learn.microsoft.com/powershell/module/az.rediscache/remove-azrediscachefirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Remove-AzRedisCacheFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Remove-AzRedisCacheFirewallRule.md +--- + +# Remove-AzRedisCacheFirewallRule + +## SYNOPSIS +Remove a firewall rule from a Redis Cache. + +## SYNTAX + +### NormalParameterSet (Default) +``` +Remove-AzRedisCacheFirewallRule [-ResourceGroupName <String>] -Name <String> -RuleName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PSRedisFirewallRuleObject +``` +Remove-AzRedisCacheFirewallRule -InputObject <PSRedisFirewallRule> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a firewall rule from a Redis Cache. + +## EXAMPLES + +### Example 1: Remove a single firewall rule +```powershell +Remove-AzRedisCacheFirewallRule -Name "mycache" -RuleName "ruleone" -PassThru +``` + +```output +True +``` + +This command removes a firewall rule named ruleone from Redis Cache named mycache. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +object of type PSRedisFirewallRule + +```yaml +Type: Microsoft.Azure.Commands.RedisCache.Models.PSRedisFirewallRule +Parameter Sets: PSRedisFirewallRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of redis cache. + +```yaml +Type: System.String +Parameter Sets: NormalParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of resource group in which cache exists. + +```yaml +Type: System.String +Parameter Sets: NormalParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleName +Name of firewall rule. + +```yaml +Type: System.String +Parameter Sets: NormalParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.RedisCache.Models.PSRedisFirewallRule + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzRedisCacheFirewallRule](./New-AzRedisCacheFirewallRule.md) + +[Get-AzRedisCacheFirewallRule](./Get-AzRedisCacheFirewallRule.md) + +[Get-AzRedisCache](./Get-AzRedisCache.md) + +[New-AzRedisCache](./New-AzRedisCache.md) + +[Remove-AzRedisCache](./Remove-AzRedisCache.md) + +[Set-AzRedisCache](./Set-AzRedisCache.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.RedisCache/Remove-AzRedisCacheLink.md b/azps-10.1.0/Az.RedisCache/Remove-AzRedisCacheLink.md new file mode 100644 index 0000000000..351e9e2a5d --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Remove-AzRedisCacheLink.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +online version: https://learn.microsoft.com/powershell/module/az.rediscache/remove-azrediscachelink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Remove-AzRedisCacheLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Remove-AzRedisCacheLink.md +--- + +# Remove-AzRedisCacheLink + +## SYNOPSIS +Remove a geo replication link between two Redis Caches. + +## SYNTAX + +``` +Remove-AzRedisCacheLink -PrimaryServerName <String> -SecondaryServerName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a geo replication link between two Redis Caches. + +## EXAMPLES + +### Example 1: Remove a geo replication link +```powershell +Remove-AzRedisCacheLink -PrimaryServerName "mycache1" -SecondaryServerName "mycache2" +``` + +This command removes a geo-replication links where Redis Cache named mycache1 is primary and Redis Cache named mycache2 is secondary. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryServerName +Name of primary redis cache in link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryServerName +Name of secondary redis cache in link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzRedisCacheLink](./New-AzRedisCacheLink.md) + +[Get-AzRedisCacheLink](./Get-AzRedisCacheLink.md) + +[Get-AzRedisCache](./Get-AzRedisCache.md) + +[New-AzRedisCache](./New-AzRedisCache.md) + +[Remove-AzRedisCache](./Remove-AzRedisCache.md) + +[Set-AzRedisCache](./Set-AzRedisCache.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.RedisCache/Remove-AzRedisCachePatchSchedule.md b/azps-10.1.0/Az.RedisCache/Remove-AzRedisCachePatchSchedule.md new file mode 100644 index 0000000000..286e19d6c4 --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Remove-AzRedisCachePatchSchedule.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: 2EA765B8-D82B-4789-8F10-88F79BDF44D0 +online version: https://learn.microsoft.com/powershell/module/az.rediscache/remove-azrediscachepatchschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Remove-AzRedisCachePatchSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Remove-AzRedisCachePatchSchedule.md +--- + +# Remove-AzRedisCachePatchSchedule + +## SYNOPSIS +Removes the patch schedule. + +## SYNTAX + +``` +Remove-AzRedisCachePatchSchedule [-ResourceGroupName <String>] -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRedisCachePatchSchedule** cmdlet removes the patch schedule from a cache in Azure Redis Cache. + +## EXAMPLES + +### Example 1: Remove the patch schedule +```powershell +Remove-AzRedisCachePatchSchedule -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" +``` + +This command removes the patch schedule from the cache named RedisCache06. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group which contains the cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website + +## RELATED LINKS + +[Get-AzRedisCachePatchSchedule](./Get-AzRedisCachePatchSchedule.md) + +[New-AzRedisCachePatchSchedule](./New-AzRedisCachePatchSchedule.md) + +[New-AzRedisCacheScheduleEntry](./New-AzRedisCacheScheduleEntry.md) + + diff --git a/azps-10.1.0/Az.RedisCache/Reset-AzRedisCache.md b/azps-10.1.0/Az.RedisCache/Reset-AzRedisCache.md new file mode 100644 index 0000000000..9f8ece500c --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Reset-AzRedisCache.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: A73D4DDD-387A-4468-AC6E-F15BF473527E +online version: https://learn.microsoft.com/powershell/module/az.rediscache/reset-azrediscache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Reset-AzRedisCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Reset-AzRedisCache.md +--- + +# Reset-AzRedisCache + +## SYNOPSIS +Restarts nodes of a cache. + +## SYNTAX + +``` +Reset-AzRedisCache [-ResourceGroupName <String>] -Name <String> -RebootType <String> [-ShardId <Int32>] + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Reset-AzRedisCache** cmdlet restarts nodes of an Azure Redis Cache instance. + +## EXAMPLES + +### Example 1: Restart both nodes +```powershell +Reset-AzRedisCache -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" -RebootType "AllNodes" -Force +``` + +This command restarts both nodes for the cache named RedisCache06. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a Boolean that indicates whether the operation succeeds. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RebootType +Specifies which node or nodes to restart. +The acceptable values for this parameter are: +- PrimaryNode +- SecondaryNode +- AllNodes + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: PrimaryNode, SecondaryNode, AllNodes + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShardId +Specifies the ID of the shard that this cmdlet restarts for a premium cache with clustering enabled. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### System.Boolean + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website + +## RELATED LINKS + +[Export-AzRedisCache](./Export-AzRedisCache.md) + +[Import-AzRedisCache](./Import-AzRedisCache.md) + +[New-AzRedisCache](./New-AzRedisCache.md) + +[Remove-AzRedisCache](./Remove-AzRedisCache.md) + +[Set-AzRedisCache](./Set-AzRedisCache.md) + + diff --git a/azps-10.1.0/Az.RedisCache/Set-AzRedisCache.md b/azps-10.1.0/Az.RedisCache/Set-AzRedisCache.md new file mode 100644 index 0000000000..77b89b9c4a --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Set-AzRedisCache.md @@ -0,0 +1,643 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: 6234F211-6ED4-443F-9B83-DEB9AC51B763 +online version: https://learn.microsoft.com/powershell/module/az.rediscache/set-azrediscache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Set-AzRedisCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Set-AzRedisCache.md +--- + +# Set-AzRedisCache + +## SYNOPSIS +Modifies an Azure Cache for Redis. + +## SYNTAX + +``` +Set-AzRedisCache [-ResourceGroupName <String>] -Name <String> [-Size <String>] [-Sku <String>] + [-RedisConfiguration <Hashtable>] [-EnableNonSslPort <Boolean>] [-TenantSettings <Hashtable>] + [-ShardCount <Int32>] [-MinimumTlsVersion <String>] [-RedisVersion <String>] [-Tag <Hashtable>] + [-IdentityType <String>] [-UserAssignedIdentity <String[]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzRedisCache** cmdlet modifies an Azure Cache for Redis. + +## EXAMPLES + +### Example 1: Modify Azure Cache for Redis +```powershell +Set-AzRedisCache -ResourceGroupName "MyGroup" -Name "MyCache" -RedisConfiguration @{"maxmemory-policy" = "allkeys-random"} +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : mygroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/myCache + Location : North Central US + Name : MyCache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : creating + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random]} + EnableNonSslPort : False + RedisVersion : 2.8 + Size : 250MB + Sku : Standard + Tag : {} + Zone : [] +``` + +This command updates the maxmemory-policy for your Azure Cache fo Redis named *MyCache*. + +### Example 2: Modify Azure Cache for Redis - If you want to Disable RDB or AOF Data Persistence. +```powershell +Set-AzRedisCache -Name "MyCache" -RedisConfiguration @{"rdb-backup-enabled" = "false"} +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache + Location : Central US + Name : mycache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : Succeeded + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random], [maxclients, 7500], [maxmemory-reserved, 200], + [maxfragmentationmemory-reserved, 300], [rdb-backup-enabled, false]...} + EnableNonSslPort : False + RedisVersion : 4.0.14 + Size : 6GB + Sku : Premium + Tag : {} + Zone : [] +``` + + + +This cmdlet disables RDB backup data persistence for Azure Cache for Redis. You can also disable AOF backup persistent cache. + +### Example 3: Modify Azure Cache for Redis - If you want to add data persistence after azure redis cache created. +```powershell +Set-AzRedisCache -Name "MyCache" -RedisConfiguration @{"rdb-backup-enabled" = "true"; "rdb-storage-connection-string" = "DefaultEndpointsProtocol=https;AccountName=mystorageaccount;AccountKey=pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo=;EndpointSuffix=mySuffix"; "rdb-backup-frequency" = "30"} +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache + Location : Central US + Name : mycache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : Succeeded + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random], [maxclients, 7500], [maxmemory-reserved, 200], + [maxfragmentationmemory-reserved, 300], [rdb-backup-enabled, true]....} + EnableNonSslPort : False + RedisVersion : 4.0.14 + Size : 6GB + Sku : Premium + Tag : {} + Zone : [] +``` + +This cmdlet enables rdb-backup persistence on an already existing cache. You can also enable aof-backup persistence. + +### Example 4: Modify Azure Cache for Redis - If you want to change rdb back up frequency. + +For example - Currently you are taking RDB snapshot in every 30 minute, but you want to change to take snapshot 15 minutes. + +```powershell +Set-AzRedisCache -Name "MyCache" -RedisConfiguration @{"rdb-backup-frequency" = "15"} +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache + Location : Central US + Name : mycache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : Succeeded + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random], [maxclients, 7500], [maxmemory-reserved, 200], + [maxfragmentationmemory-reserved, 300], [rdb-backup-enabled, true]....} + EnableNonSslPort : False + RedisVersion : 4.0.14 + Size : 6GB + Sku : Premium + Tag : {} + Zone : [] +``` + +### Example 5: Modify Azure Cache for Redis - If you want to change AOF back up data persistence to RDB back up. + +```powershell +Set-AzRedisCache -Name "MyCache" -RedisConfiguration @{"aof-backup-enabled"= "false"; "rdb-backup-enabled" = "true"; "rdb-storage-connection-string" = "DefaultEndpointsProtocol=https;AccountName=mystorageaccount;AccountKey=pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo=;EndpointSuffix=mySuffix"; "rdb-backup-frequency" = "30"} +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache + Location : Central US + Name : mycache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : Succeeded + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random], [maxclients, 7500], [maxmemory-reserved, 200], + [maxfragmentationmemory-reserved, 300], [rdb-backup-enabled, true]....} + EnableNonSslPort : False + RedisVersion : 4.0.14 + Size : 6GB + Sku : Premium + Tag : {} + Zone : [] +``` + + +This cmdlet helps in changing persistence method. + +### Example 6: Scale an Azure Cache for Redis Instance - Update to different size. + +```powershell +Set-AzRedisCache -Name "MyCache" -Size "P2" -Sku "Premium" +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache + Location : Central US + Name : mycache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : Scaling + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random], [maxclients, 7500], [maxmemory-reserved, 200], + [maxfragmentationmemory-reserved, 300]....} + EnableNonSslPort : False + RedisVersion : 4.0.14 + Size : 6GB + Sku : Premium + Tag : {} + Zone : [] +``` + +This command increases or decreases the memory size of your instance. + +### Example 7: Scale an Azure Cache for Redis Instance - Update to different tier. + +```powershell +Set-AzRedisCache -Name "MyCache" -Size "P1" -Sku "Premium" +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache + Location : Central US + Name : mycache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : Scaling + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random], [maxclients, 7500], [maxmemory-reserved, 200], + [maxfragmentationmemory-reserved, 300]....} + EnableNonSslPort : False + RedisVersion : 4.0.14 + Size : 1GB + Sku : Standard + Tag : {} + Zone : [] +``` + +This command helps you change the tier of your cache. You can change from Basic to Standard, or Standard to Premium. + +### Example 8: Scale an Azure Cache for Redis Instance - Enable Redis Clustering. + +```powershell +Set-AzRedisCache -Name "MyCache" -ShardCount 1 +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache + Location : Central US + Name : mycache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : Scaling + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random], [maxclients, 7500], [maxmemory-reserved, 200], + [maxfragmentationmemory-reserved, 300]....} + EnableNonSslPort : False + RedisVersion : 4.0.14 + Size : 6GB + Sku : Premium + ShardCount : + Tag : {} + Zone : [] +``` + +This cmdlet helps you in enable clustering for your Azure Cache for Redis instance. For increasing the shard count, must enable clustering first. + +### Example 9: Scale an Azure Cache for Redis Instance - Use Redis Cluster to scale in/out. + +```powershell +Set-AzRedisCache -Name "MyCache" -ShardCount 2 +``` + +```output + PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= + ResourceGroupName : MyGroup + Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache + Location : Central US + Name : mycache + Type : Microsoft.Cache/Redis + HostName : mycache.redis.cache.windows.net + Port : 6379 + ProvisioningState : Scaling + SslPort : 6380 + RedisConfiguration : {[maxmemory-policy, allkeys-random], [maxclients, 7500], [maxmemory-reserved, 200], + [maxfragmentationmemory-reserved, 300]....} + EnableNonSslPort : False + RedisVersion : 4.0.14 + Size : 6GB + Sku : Premium + ShardCount : 1 + Tag : {} + Zone : [] +``` + +This command increases or decreases the cluster size. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNonSslPort +Indicates whether the non-SSL port is enabled. +The default value is $False (the non-SSL port is disabled). + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityType +Specifies the type of identity used for the Azure Cache for Redis. Valid values: "SystemAssigned" or "UserAssigned" or "SystemAssignedUserAssigned" or "None" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +Specify the TLS version required by clients to connect to cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Azure Cache for Redis to update. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RedisConfiguration +Specifies Redis configuration settings. +The acceptable values for this parameter are: +- rdb-backup-enabled. +Specifies that Redis data persistence is enabled. +Premium tier only. +- rdb-storage-connection-string. +Specifies the connection string to the Storage account for Redis data persistence. +Premium tier only. +- rdb-backup-frequency. +Specifies the backup frequency for Redis data persistence. +Premium tier only. +- maxmemory-reserved. +Configures the memory reserved for non-cache processes. +Standard and Premium tiers. +- maxmemory-policy. +Configures the eviction policy for the cache. +All pricing tiers. +- notify-keyspace-events. +Configures keyspace notifications. +Standard and premium tiers. +- hash-max-ziplist-entries. +Configures memory optimization for small aggregate data types. +Standard and Premium tiers. +- hash-max-ziplist-value. +Configures memory optimization for small aggregate data types. +Standard and Premium tiers. +- set-max-intset-entries. +Configures memory optimization for small aggregate data types. +Standard and Premium tiers. +- zset-max-ziplist-entries. +Configures memory optimization for small aggregate data types. +Standard and Premium tiers. +- zset-max-ziplist-value. +Configures memory optimization for small aggregate data types. +Standard and Premium tiers. +- databases. +Configures the number of databases. +This property can be configured only at cache creation. +Standard and Premium tiers. +For more information, see Manage Azure Redis Cache with Azure PowerShellhttp://go.microsoft.com/fwlink/?LinkId=800051 (http://go.microsoft.com/fwlink/?LinkId=800051). +- preferred-data-archive-auth-method +Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS +- preferred-data-persistence-auth-method +Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RedisVersion +Redis version. This should be in the form 'major[.minor]' (only 'major' is required) or the value 'latest' which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is 'latest'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Redis Cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShardCount +Specifies the number of shards to create on a Premium cluster cache. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Size +Specifies the size of the Redis Cache. +Valid values are: +- P1 +- P2 +- P3 +- P4 +- P5 +- C0 +- C1 +- C2 +- C3 +- C4 +- C5 +- C6 +- 250MB +- 1GB +- 2.5GB +- 6GB +- 13GB +- 26GB +- 53GB +- 120GB +The default value is 1GB or C1. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Specifies the SKU of the Redis Cache to create. +Valid values are: +- Basic +- Standard +- Premium +The default value is Standard. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Basic, Standard, Premium + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantSettings +This parameter has been deprecated. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +Specifies one or more comma seperated user identities to be associated with the Azure Cache for Redis. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.RedisCache.Models.RedisCacheAttributesWithAccessKeys + +## NOTES + +## RELATED LINKS + +[Get-AzRedisCache](./Get-AzRedisCache.md) + +[New-AzRedisCache](./New-AzRedisCache.md) + +[Remove-AzRedisCache](./Remove-AzRedisCache.md) + + diff --git a/azps-10.1.0/Az.RedisCache/Set-AzRedisCacheDiagnostic.md b/azps-10.1.0/Az.RedisCache/Set-AzRedisCacheDiagnostic.md new file mode 100644 index 0000000000..2e27b9afda --- /dev/null +++ b/azps-10.1.0/Az.RedisCache/Set-AzRedisCacheDiagnostic.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.RedisCache.dll-Help.xml +Module Name: Az.RedisCache +ms.assetid: FA99C137-68E3-47D3-A0AC-FE33A481BE66 +online version: https://learn.microsoft.com/powershell/module/az.rediscache/set-azrediscachediagnostic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Set-AzRedisCacheDiagnostic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisCache/RedisCache/help/Set-AzRedisCacheDiagnostic.md +--- + +# Set-AzRedisCacheDiagnostic + +## SYNOPSIS +Enables diagnostics on an Azure Redis Cache. + +## SYNTAX + +``` +Set-AzRedisCacheDiagnostic [-ResourceGroupName <String>] -Name <String> -StorageAccountId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzRedisCacheDiagnostic** cmdlet enables diagnostics for an Azure Redis Cache. + +## EXAMPLES + +### Example 1: Enable diagnostics +```powershell +Set-AzRedisCacheDiagnostic -ResourceGroupName "ContosoResourceGroup" -Name "PeakCache" -StorageAccountId "/subscriptions/fffff139-aaaa-bbbb-cccc-21f21f35806e/resourcegroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount" +``` + +This command enables diagnostics for an Azure Redis cache. +This command will enable diagnostics or update the storage account for all Azure Redis Caches in the same region for the subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the cache. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountId +Specifies the resource ID of the storage account used to store the diagnostics data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website + +## RELATED LINKS + +[Remove-AzRedisCacheDiagnostic](./Remove-AzRedisCacheDiagnostic.md) + + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/Az.RedisEnterpriseCache.md b/azps-10.1.0/Az.RedisEnterpriseCache/Az.RedisEnterpriseCache.md new file mode 100644 index 0000000000..53bbab448c --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/Az.RedisEnterpriseCache.md @@ -0,0 +1,60 @@ +--- +Module Name: Az.RedisEnterpriseCache +Module Guid: 0b3b43eb-9078-4d06-8c79-d156a1410906 +Download Help Link: https://learn.microsoft.com/powershell/module/az.redisenterprisecache +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Az.RedisEnterpriseCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Az.RedisEnterpriseCache.md +--- + +# Az.RedisEnterpriseCache Module +## Description +Microsoft Azure PowerShell: RedisEnterpriseCache cmdlets + +## Az.RedisEnterpriseCache Cmdlets +### [Export-AzRedisEnterpriseCache](Export-AzRedisEnterpriseCache.md) +Exports a database file from target database. + +### [Get-AzRedisEnterpriseCache](Get-AzRedisEnterpriseCache.md) +Gets information about a Redis Enterprise cluster and its associated databases. + +### [Get-AzRedisEnterpriseCacheDatabase](Get-AzRedisEnterpriseCacheDatabase.md) +Gets information about a database in a Redis Enterprise cluster. + +### [Get-AzRedisEnterpriseCacheKey](Get-AzRedisEnterpriseCacheKey.md) +Retrieves all access keys for a Redis Enterprise database. + +### [Get-AzRedisEnterpriseCacheOperationStatus](Get-AzRedisEnterpriseCacheOperationStatus.md) +Gets the status of operation. + +### [Import-AzRedisEnterpriseCache](Import-AzRedisEnterpriseCache.md) +Imports a database file to target database. + +### [Invoke-AzRedisEnterpriseCacheDatabaseFlush](Invoke-AzRedisEnterpriseCacheDatabaseFlush.md) +Flushes all the keys in this database and also from its linked databases. + +### [Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink](Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink.md) +Forcibly removes the link to the specified database resource. + +### [New-AzRedisEnterpriseCache](New-AzRedisEnterpriseCache.md) +Creates a Redis Enterprise cache. + +### [New-AzRedisEnterpriseCacheDatabase](New-AzRedisEnterpriseCacheDatabase.md) +Creates a database for a Redis Enterprise cache. + +### [New-AzRedisEnterpriseCacheKey](New-AzRedisEnterpriseCacheKey.md) +Regenerates an access key for a Redis Enterprise database. + +### [Remove-AzRedisEnterpriseCache](Remove-AzRedisEnterpriseCache.md) +Deletes a RedisEnterprise cache cluster. + +### [Remove-AzRedisEnterpriseCacheDatabase](Remove-AzRedisEnterpriseCacheDatabase.md) +Deletes a single database in a Redis Enterprise cache. + +### [Update-AzRedisEnterpriseCache](Update-AzRedisEnterpriseCache.md) +Updates an existing RedisEnterprise cluster + +### [Update-AzRedisEnterpriseCacheDatabase](Update-AzRedisEnterpriseCacheDatabase.md) +Updates an existing Redis Enterprise database + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/Export-AzRedisEnterpriseCache.md b/azps-10.1.0/Az.RedisEnterpriseCache/Export-AzRedisEnterpriseCache.md new file mode 100644 index 0000000000..848d923179 --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/Export-AzRedisEnterpriseCache.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/export-azredisenterprisecache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Export-AzRedisEnterpriseCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Export-AzRedisEnterpriseCache.md +--- + +# Export-AzRedisEnterpriseCache + +## SYNOPSIS +Exports a database file from target database. + +## SYNTAX + +``` +Export-AzRedisEnterpriseCache -ClusterName <String> -ResourceGroupName <String> -SasUri <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Exports a database file from target database. + +## EXAMPLES + +### Example 1: Export database to file +```powershell +Export-AzRedisEnterpriseCache -Name "MyCache" -ResourceGroupName "MyGroup" -SasUri "https://mystorageaccount.blob.core.windows.net/mycontainer?sp=signedPermissions&se=signedExpiry&sv=signedVersion&sr=signedResource&sig=signature;mystoragekey" +``` + +This command exports the database of the Redis Enterprise cache named MyCache to a database file. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Redis Enterprise cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SasUri +SAS URI for the target directory to export to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +Export-AzRedisEnterpriseCacheDatabase + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/Get-AzRedisEnterpriseCache.md b/azps-10.1.0/Az.RedisEnterpriseCache/Get-AzRedisEnterpriseCache.md new file mode 100644 index 0000000000..eca52313f2 --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/Get-AzRedisEnterpriseCache.md @@ -0,0 +1,162 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/get-azredisenterprisecache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Get-AzRedisEnterpriseCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Get-AzRedisEnterpriseCache.md +--- + +# Get-AzRedisEnterpriseCache + +## SYNOPSIS +Gets information about a Redis Enterprise cluster and its associated databases. + +## SYNTAX + +### ListBySubscriptionId (Default) +``` +Get-AzRedisEnterpriseCache [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzRedisEnterpriseCache -ClusterName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ListByResourceGroup +``` +Get-AzRedisEnterpriseCache -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a Redis Enterprise cluster and its associated databases. + +## EXAMPLES + +### Example 1: Get a Redis Enterprise cache by name +```powershell +Get-AzRedisEnterpriseCache -ResourceGroupName "MyGroup" -Name "MyCache" +``` + +```output +Location Name Type Zone Database +-------- ---- ---- ---- -------- +West US MyCache Microsoft.Cache/redisEnterprise {default} + +``` + +This command gets information about the Redis Enterprise cache named MyCache. + +### Example 2: List every Redis Enterprise cache in a resource group +```powershell +Get-AzRedisEnterpriseCache -ResourceGroupName "MyGroup" +``` + +```output +Location Name Type Zone Database +-------- ---- ---- ---- -------- +East US MyCache1 Microsoft.Cache/redisEnterprise {default} +East US MyCache2 Microsoft.Cache/redisEnterprise {1, 2, 3} {default} + +``` + +This command gets information about every Redis Enterprise cache in the specified resource group. + +### Example 3: List every Redis Enterprise cache in a subscription +```powershell +Get-AzRedisEnterpriseCache +``` + +```output +Location Name Type Zone Database +-------- ---- ---- ---- -------- +East US MyCache1 Microsoft.Cache/redisEnterprise {default} +East US MyCache2 Microsoft.Cache/redisEnterprise {1, 2, 3} {default} +West US MyCache3 Microsoft.Cache/redisEnterprise {default} +Central US MyCache4 Microsoft.Cache/redisEnterprise {1, 2, 3} {default} + +``` + +This command gets information about every Redis Enterprise cache in the current subscription. + +## PARAMETERS + +### -ClusterName +The name of the Redis Enterprise cluster. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, ListByResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.ICluster + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/Get-AzRedisEnterpriseCacheDatabase.md b/azps-10.1.0/Az.RedisEnterpriseCache/Get-AzRedisEnterpriseCacheDatabase.md new file mode 100644 index 0000000000..e5074e3435 --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/Get-AzRedisEnterpriseCacheDatabase.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/get-azredisenterprisecachedatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Get-AzRedisEnterpriseCacheDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Get-AzRedisEnterpriseCacheDatabase.md +--- + +# Get-AzRedisEnterpriseCacheDatabase + +## SYNOPSIS +Gets information about a database in a Redis Enterprise cluster. + +## SYNTAX + +``` +Get-AzRedisEnterpriseCacheDatabase -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about a database in a Redis Enterprise cluster. + +## EXAMPLES + +### Example 1: Get database information +```powershell +Get-AzRedisEnterpriseCacheDatabase -Name "MyCache" -ResourceGroupName "MyGroup" +``` + +```output +Name Type +---- ---- +default Microsoft.Cache/redisEnterprise/databases + +``` + +This command gets information about a database in the Redis Enterprise cache named MyCache. + +## PARAMETERS + +### -ClusterName +The name of the Redis Enterprise cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.IDatabase + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/Get-AzRedisEnterpriseCacheKey.md b/azps-10.1.0/Az.RedisEnterpriseCache/Get-AzRedisEnterpriseCacheKey.md new file mode 100644 index 0000000000..1e5e167479 --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/Get-AzRedisEnterpriseCacheKey.md @@ -0,0 +1,153 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/get-azredisenterprisecachekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Get-AzRedisEnterpriseCacheKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Get-AzRedisEnterpriseCacheKey.md +--- + +# Get-AzRedisEnterpriseCacheKey + +## SYNOPSIS +Retrieves all access keys for a Redis Enterprise database. + +## SYNTAX + +``` +Get-AzRedisEnterpriseCacheKey -ClusterName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves all access keys for a Redis Enterprise database. + +## EXAMPLES + +### Example 1: Get database access keys +```powershell +Get-AzRedisEnterpriseCacheKey -Name "MyCache" -ResourceGroupName "MyGroup" +``` + +```output +PrimaryKey SecondaryKey +---------- ------------ +primary-key secondary-key + +``` + +This command gets the secret access keys used for authenticating connections to the database of the Redis Enterprise cache named MyCache. + +## PARAMETERS + +### -ClusterName +The name of the Redis Enterprise cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.IAccessKeys + +## NOTES + +ALIASES + +Get-AzRedisEnterpriseCacheDatabaseKey + +Get-AzRedisEnterpriseCacheAccessKey + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/Get-AzRedisEnterpriseCacheOperationStatus.md b/azps-10.1.0/Az.RedisEnterpriseCache/Get-AzRedisEnterpriseCacheOperationStatus.md new file mode 100644 index 0000000000..6c64cdc230 --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/Get-AzRedisEnterpriseCacheOperationStatus.md @@ -0,0 +1,118 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/get-azredisenterprisecacheoperationstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Get-AzRedisEnterpriseCacheOperationStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Get-AzRedisEnterpriseCacheOperationStatus.md +--- + +# Get-AzRedisEnterpriseCacheOperationStatus + +## SYNOPSIS +Gets the status of operation. + +## SYNTAX + +``` +Get-AzRedisEnterpriseCacheOperationStatus -Location <String> -OperationId <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the status of operation. + +## EXAMPLES + +### Example 1: Get operation status +```powershell +Get-AzRedisEnterpriseCacheOperationStatus -Location "East US" -OperationId "6432a8f9-0fe6-4339-9303-772c92f35d02" +``` + +```output +EndTime Name StartTime Status +------- ---- --------- ------ +2020-12-01T00:12:45.7107366+00:00 6432a8f9-0fe6-4339-9303-772c92f35d02 2020-12-01T00:04:35.7061294+00:00 Succeeded + +``` + +This command gets the status of an operation. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The name of Azure region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationId +The ID of an ongoing async operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.IOperationStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/Import-AzRedisEnterpriseCache.md b/azps-10.1.0/Az.RedisEnterpriseCache/Import-AzRedisEnterpriseCache.md new file mode 100644 index 0000000000..db2085f0bc --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/Import-AzRedisEnterpriseCache.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/import-azredisenterprisecache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Import-AzRedisEnterpriseCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Import-AzRedisEnterpriseCache.md +--- + +# Import-AzRedisEnterpriseCache + +## SYNOPSIS +Imports a database file to target database. + +## SYNTAX + +``` +Import-AzRedisEnterpriseCache -ClusterName <String> -ResourceGroupName <String> -SasUri <String[]> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Imports a database file to target database. + +## EXAMPLES + +### Example 1: Import database from file +```powershell +Import-AzRedisEnterpriseCache -ClusterName "MyCache1" -ResourceGroupName "MyGroup" -SasUri @("<sas-uri>") +``` + +This command imports data from a database file into the database of the Redis Enterprise cache named MyCache. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Redis Enterprise cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SasUri +SAS URIs for the target blobs to import from + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +Import-AzRedisEnterpriseCacheDatabase + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/Invoke-AzRedisEnterpriseCacheDatabaseFlush.md b/azps-10.1.0/Az.RedisEnterpriseCache/Invoke-AzRedisEnterpriseCacheDatabaseFlush.md new file mode 100644 index 0000000000..a864599fa6 --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/Invoke-AzRedisEnterpriseCacheDatabaseFlush.md @@ -0,0 +1,279 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/invoke-azredisenterprisecachedatabaseflush +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Invoke-AzRedisEnterpriseCacheDatabaseFlush.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Invoke-AzRedisEnterpriseCacheDatabaseFlush.md +--- + +# Invoke-AzRedisEnterpriseCacheDatabaseFlush + +## SYNOPSIS +Flushes all the keys in this database and also from its linked databases. + +## SYNTAX + +### FlushExpanded (Default) +``` +Invoke-AzRedisEnterpriseCacheDatabaseFlush -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Id <String[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Flush +``` +Invoke-AzRedisEnterpriseCacheDatabaseFlush -ClusterName <String> -ResourceGroupName <String> + -Parameter <IFlushParameters> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### FlushViaIdentity +``` +Invoke-AzRedisEnterpriseCacheDatabaseFlush -InputObject <IRedisEnterpriseCacheIdentity> + -Parameter <IFlushParameters> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### FlushViaIdentityExpanded +``` +Invoke-AzRedisEnterpriseCacheDatabaseFlush -InputObject <IRedisEnterpriseCacheIdentity> [-Id <String[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Flushes all the keys in this database and also from its linked databases. + +## EXAMPLES + +### Example 1: Flush Cache +```powershell +Invoke-AzRedisEnterpriseCacheDatabaseFlush -ClusterName "MyCache" -ResourceGroupName "MyResourceGroup" -Id @("Mydatabase1") , @("MyLinkedDatabase1") +``` + +Flushes all the keys in this database and also from its linked databases. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the RedisEnterprise cluster. + +```yaml +Type: System.String +Parameter Sets: Flush, FlushExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The resource identifiers of all the other database resources in the georeplication group to be flushed + +```yaml +Type: System.String[] +Parameter Sets: FlushExpanded, FlushViaIdentityExpanded +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.RedisEnterpriseCache.Models.IRedisEnterpriseCacheIdentity +Parameter Sets: FlushViaIdentity, FlushViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Parameters for a Redis Enterprise active geo-replication flush operation. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.IFlushParameters +Parameter Sets: Flush, FlushViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Flush, FlushExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Flush, FlushExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.IFlushParameters + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.IRedisEnterpriseCacheIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IRedisEnterpriseCacheIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the RedisEnterprise cluster. + - `[DatabaseName <String>]`: The name of the database. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`PARAMETER <IFlushParameters>`: Parameters for a Redis Enterprise active geo-replication flush operation. + - `[Id <String[]>]`: The resource identifiers of all the other database resources in the georeplication group to be flushed + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink.md b/azps-10.1.0/Az.RedisEnterpriseCache/Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink.md new file mode 100644 index 0000000000..91a22d3335 --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink.md @@ -0,0 +1,279 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/invoke-azredisenterprisecacheforcedatabaseunlink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink.md +--- + +# Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink + +## SYNOPSIS +Forcibly removes the link to the specified database resource. + +## SYNTAX + +### ForceExpanded (Default) +``` +Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink -ClusterName <String> -ResourceGroupName <String> + -Id <String[]> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Force +``` +Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink -ClusterName <String> -ResourceGroupName <String> + -Parameter <IForceUnlinkParameters> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ForceViaIdentity +``` +Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink -InputObject <IRedisEnterpriseCacheIdentity> + -Parameter <IForceUnlinkParameters> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### ForceViaIdentityExpanded +``` +Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink -InputObject <IRedisEnterpriseCacheIdentity> -Id <String[]> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Forcibly removes the link to the specified database resource. + +## EXAMPLES + +### Example 1: Unlink database +```powershell +Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink -ResourceGroupName "MyGroup" -ClusterName "MyCache3" -Id @("databaseId") +``` + +Forcibly removes the link to the database resource whose id is given, from the georeplication group the specified cache belongs to + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the RedisEnterprise cluster. + +```yaml +Type: System.String +Parameter Sets: Force, ForceExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The resource IDs of the database resources to be unlinked. + +```yaml +Type: System.String[] +Parameter Sets: ForceExpanded, ForceViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.IRedisEnterpriseCacheIdentity +Parameter Sets: ForceViaIdentity, ForceViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Parameters for a Redis Enterprise Active Geo Replication Force Unlink operation. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.IForceUnlinkParameters +Parameter Sets: Force, ForceViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Force, ForceExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Force, ForceExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.IForceUnlinkParameters + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.IRedisEnterpriseCacheIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IRedisEnterpriseCacheIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the RedisEnterprise cluster. + - `[DatabaseName <String>]`: The name of the database. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`PARAMETER <IForceUnlinkParameters>`: Parameters for a Redis Enterprise Active Geo Replication Force Unlink operation. + - `Id <String[]>`: The resource IDs of the database resources to be unlinked. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/New-AzRedisEnterpriseCache.md b/azps-10.1.0/Az.RedisEnterpriseCache/New-AzRedisEnterpriseCache.md new file mode 100644 index 0000000000..58e03f8630 --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/New-AzRedisEnterpriseCache.md @@ -0,0 +1,620 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/new-azredisenterprisecache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/New-AzRedisEnterpriseCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/New-AzRedisEnterpriseCache.md +--- + +# New-AzRedisEnterpriseCache + +## SYNOPSIS +Creates a Redis Enterprise cache. + +## SYNTAX + +### CreateClusterWithDatabase (Default) +``` +New-AzRedisEnterpriseCache -ClusterName <String> -ResourceGroupName <String> -Location <String> -Sku <SkuName> + [-SubscriptionId <String>] [-AofPersistenceEnabled] [-AofPersistenceFrequency <AofFrequency>] + [-Capacity <Int32>] [-ClientProtocol <Protocol>] [-ClusteringPolicy <ClusteringPolicy>] + [-CustomerManagedKeyEncryptionKeyUrl <String>] [-EvictionPolicy <EvictionPolicy>] [-GroupNickname <String>] + [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] + [-KeyEncryptionKeyIdentityType <CmkIdentityType>] + [-KeyEncryptionKeyIdentityUserAssignedIdentityResourceId <String>] [-LinkedDatabase <ILinkedDatabase[]>] + [-MinimumTlsVersion <TlsVersion>] [-Module <IModule[]>] [-Port <Int32>] [-RdbPersistenceEnabled] + [-RdbPersistenceFrequency <RdbFrequency>] [-Tag <Hashtable>] [-Zone <String[]>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateClusterOnly +``` +New-AzRedisEnterpriseCache -ClusterName <String> -ResourceGroupName <String> -Location <String> -Sku <SkuName> + -NoDatabase [-SubscriptionId <String>] [-Capacity <Int32>] [-CustomerManagedKeyEncryptionKeyUrl <String>] + [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] + [-KeyEncryptionKeyIdentityType <CmkIdentityType>] + [-KeyEncryptionKeyIdentityUserAssignedIdentityResourceId <String>] [-MinimumTlsVersion <TlsVersion>] + [-Tag <Hashtable>] [-Zone <String[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster with an associated database. + +## EXAMPLES + +### Example 1: Create a Redis Enterprise cache +```powershell +New-AzRedisEnterpriseCache -Name "MyCache" -ResourceGroupName "MyGroup" -Location "West US" -Sku "Enterprise_E10" +``` + +```output +Location Name Type Zone Database +-------- ---- ---- ---- -------- +West US MyCache Microsoft.Cache/redisEnterprise {default} + +``` + +This command creates a Redis Enterprise cache named MyCache with an associated database named default. + +### Example 2: Create a Redis Enterprise cache using some optional parameters +```powershell +New-AzRedisEnterpriseCache -Name "MyCache" -ResourceGroupName "MyGroup" -Location "East US" -Sku "Enterprise_E20" -Capacity 4 -MinimumTlsVersion "1.2" -Zone "1","2","3" -Tag @{"tag1" = "value1"} -Module "{name:RedisBloom, args:`"ERROR_RATE 0.00 INITIAL_SIZE 400`"}","{name:RedisTimeSeries, args:`"RETENTION_POLICY 20`"}","{name:RediSearch}" -ClientProtocol "Plaintext" -EvictionPolicy "NoEviction" -ClusteringPolicy "EnterpriseCluster" -AofPersistenceEnabled -AofPersistenceFrequency "1s" +``` + +```output +Location Name Type Zone Database +-------- ---- ---- ---- -------- +East US MyCache Microsoft.Cache/redisEnterprise {1, 2, 3} {default} + +``` + +This command creates a Redis Enterprise cache named MyCache with an associated database named default, using some optional parameters. + +### Example 3: Advanced - Create a Redis Enterprise cache cluster without an associated database +```powershell +New-AzRedisEnterpriseCache -Name "MyCache" -ResourceGroupName "MyGroup" -Location "East US" -Sku "EnterpriseFlash_F300" -NoDatabase +``` + +```output +Location Name Type Zone Database +-------- ---- ---- ---- -------- +East US MyCache Microsoft.Cache/redisEnterprise {} + +``` + +Warning: This command creates a Redis Enterprise cache cluster named MyCache without any associated database to hold data. + +### Example 4: Create a Redis Enterprise cache with a georeplicated database +```powershell +New-AzRedisEnterpriseCache -Name "MyCache" -ResourceGroupName "MyGroup" -Location "West US" -Sku "Enterprise_E10" -ClientProtocol "Encrypted" -EvictionPolicy "NoEviction" -ClusteringPolicy "EnterpriseCluster" -GroupNickname "GroupNickname" -LinkedDatabase '{id:"/subscriptions/6b9ac7d2-7f6d-4de4-962c-43fda44bc3f2/resourceGroups/MyGroup/providers/Microsoft.Cache/redisEnterprise/MyCache/databases/default"}' +``` + +```output +Location Name Type Zone Database +-------- ---- ---- ---- -------- +West US MyCache Microsoft.Cache/redisEnterprise {default} + +``` + +This command creates a cache name MyCache with a georeplicated database named default + +## PARAMETERS + +### -AofPersistenceEnabled +[Preview] Sets whether AOF persistence is enabled. +After enabling AOF persistence, you will be unable to disable it. +Support for disabling AOF persistence after enabling will be added at a later date. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateClusterWithDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AofPersistenceFrequency +[Preview] Sets the frequency at which data is written to disk if AOF persistence is enabled. +Allowed values: 1s, always + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.AofFrequency +Parameter Sets: CreateClusterWithDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Capacity +The size of the Redis Enterprise cluster - defaults to 2 or 3 depending on SKU. +Allowed values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: SkuCapacity + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientProtocol +Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols - default is Encrypted +Allowed values: Encrypted, Plaintext + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.Protocol +Parameter Sets: CreateClusterWithDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusteringPolicy +Clustering policy - default is OSSCluster +Specified at create time. +Allowed values: EnterpriseCluster, OSSCluster + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.ClusteringPolicy +Parameter Sets: CreateClusterWithDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Redis Enterprise cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerManagedKeyEncryptionKeyUrl +Key encryption key Url versioned only. +Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EvictionPolicy +Redis eviction policy - default is VolatileLRU +Allowed values: AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom, NoEviction + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.EvictionPolicy +Parameter Sets: CreateClusterWithDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupNickname +Name for the group of linked database resources + +```yaml +Type: System.String +Parameter Sets: CreateClusterWithDatabase +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). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyIdentityType +Only userAssignedIdentity is supported in this API version; other types may be supported in the future + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.CmkIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyIdentityUserAssignedIdentityResourceId +User assigned identity to use for accessing key encryption key Url. +Ex: /subscriptions/\<sub uuid\>/resourceGroups/\<resource group\>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedDatabase +List of database resources to link with this database +To construct, see NOTES section for GEOREPLICATIONLINKEDDATABASE properties and create a hash table. +To construct, see NOTES section for LINKEDDATABASE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.ILinkedDatabase[] +Parameter Sets: CreateClusterWithDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +The minimum TLS version for the cluster to support - default is 1.2 +Allowed values: 1.0, 1.1, 1.2 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.TlsVersion +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Module +Optional set of redis modules to enable in this database - modules can only be added at create time. +To construct, see NOTES section for MODULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.IModule[] +Parameter Sets: CreateClusterWithDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoDatabase +Advanced - Do not automatically create a default database. +Warning: The cache will not be usable until you create a database. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateClusterOnly +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +TCP port of the database endpoint - defaults to an available port +Specified at create time. + +```yaml +Type: System.Int32 +Parameter Sets: CreateClusterWithDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RdbPersistenceEnabled +[Preview] Sets whether RDB persistence is enabled. +After enabling RDB persistence, you will be unable to disable it. +Support for disabling RDB persistence after enabling will be added at a later date. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateClusterWithDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RdbPersistenceFrequency +[Preview] Sets the frequency at which a snapshot of the database is created if RDB persistence is enabled. +Allowed values: 1h, 6h, 12h + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.RdbFrequency +Parameter Sets: CreateClusterWithDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The type of Redis Enterprise cluster to deploy. +Allowed values: Enterprise_E10, Enterprise_E20, Enterprise_E50, Enterprise_E100, EnterpriseFlash_F300, EnterpriseFlash_F700, EnterpriseFlash_F1500 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.SkuName +Parameter Sets: (All) +Aliases: SkuName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Cluster resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +The Availability Zones where this cluster will be deployed. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.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. + + +`LINKEDDATABASE <ILinkedDatabase[]>`: List of database resources to link with this database To construct, see NOTES section for GEOREPLICATIONLINKEDDATABASE properties and create a hash table. + - `[Id <String>]`: Resource ID of a database resource to link with this database. + +`MODULE <IModule[]>`: Optional set of redis modules to enable in this database - modules can only be added at create time. + - `Name <String>`: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' + - `[Arg <String>]`: Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/New-AzRedisEnterpriseCacheDatabase.md b/azps-10.1.0/Az.RedisEnterpriseCache/New-AzRedisEnterpriseCacheDatabase.md new file mode 100644 index 0000000000..1b4c6b2152 --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/New-AzRedisEnterpriseCacheDatabase.md @@ -0,0 +1,389 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/new-azredisenterprisecachedatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/New-AzRedisEnterpriseCacheDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/New-AzRedisEnterpriseCacheDatabase.md +--- + +# New-AzRedisEnterpriseCacheDatabase + +## SYNOPSIS +Creates a database for a Redis Enterprise cache. + +## SYNTAX + +``` +New-AzRedisEnterpriseCacheDatabase -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AofPersistenceEnabled] [-AofPersistenceFrequency <AofFrequency>] + [-ClientProtocol <Protocol>] [-ClusteringPolicy <ClusteringPolicy>] [-EvictionPolicy <EvictionPolicy>] + [-GroupNickname <String>] [-LinkedDatabase <ILinkedDatabase[]>] [-Module <IModule[]>] [-Port <Int32>] + [-RdbPersistenceEnabled] [-RdbPersistenceFrequency <RdbFrequency>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a database for a Redis Enterprise cache. + +## EXAMPLES + +### Example 1: Create a database for a Redis Enterprise cache +```powershell +New-AzRedisEnterpriseCacheDatabase -Name "MyCache" -ResourceGroupName "MyGroup" -Module "{name:RedisBloom, args:`"ERROR_RATE 0.00 INITIAL_SIZE 400`"}","{name:RedisTimeSeries, args:`"RETENTION_POLICY 20`"}","{name:RediSearch}" -ClientProtocol "Plaintext" -EvictionPolicy "NoEviction" -ClusteringPolicy "EnterpriseCluster" -Port 10000 -AofPersistenceEnabled -AofPersistenceFrequency "always" +``` + +```output +Location Name Type Zone Database +-------- ---- ---- ---- -------- +West US MyCache Microsoft.Cache/redisEnterprise {default} + +``` + +This command creates a database named default for a Redis Enterprise cache named MyCache. + +### Example 2: Create a georeplicated database for a Redis Enterprise cache +```powershell +New-AzRedisEnterpriseCacheDatabase -Name "MyCache2" -ResourceGroupName "MyGroup" -ClientProtocol "Encrypted" -EvictionPolicy "NoEviction" -ClusteringPolicy "EnterpriseCluster" -GroupNickname "GroupNickname" -LinkedDatabase '{id:"/subscriptions/sub1/resourceGroups/MyGroup/providers/Microsoft.Cache/redisEnterprise/MyCache1/databases/default"}','{id:"/subscriptions/sub1/resourceGroups/MyGroup/providers/Microsoft.Cache/redisEnterprise/MyCache2/databases/default"}' +``` + +```output +Name Type +---- ---- +default Microsoft.Cache/redisEnterprise/databases + +``` + +This command creates a georeplicated database named default for a Redis Enterprise cache named MyCache2. +This database is supposed to be linked with a database default of a preexisting cache MyCache1 + +## PARAMETERS + +### -AofPersistenceEnabled +[Preview] Sets whether AOF persistence is enabled. +After enabling AOF persistence, you will be unable to disable it. +Support for disabling AOF persistence after enabling will be added at a later date. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AofPersistenceFrequency +[Preview] Sets the frequency at which data is written to disk if AOF persistence is enabled. +Allowed values: 1s, always + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.AofFrequency +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientProtocol +Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols - default is Encrypted +Allowed values: Encrypted, Plaintext + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.Protocol +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusteringPolicy +Clustering policy - default is OSSCluster +Specified at create time. +Allowed values: EnterpriseCluster, OSSCluster + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.ClusteringPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Redis Enterprise cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EvictionPolicy +Redis eviction policy - default is VolatileLRU +Allowed values: AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom, NoEviction + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.EvictionPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupNickname +Name for the group of linked database resources + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedDatabase +List of database resources to link with this database +To construct, see NOTES section for GEOREPLICATIONLINKEDDATABASE properties and create a hash table. +To construct, see NOTES section for LINKEDDATABASE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.ILinkedDatabase[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Module +Optional set of redis modules to enable in this database - modules can only be added at create time. +To construct, see NOTES section for MODULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.IModule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +TCP port of the database endpoint - defaults to an available port +Specified at create time. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RdbPersistenceEnabled +[Preview] Sets whether RDB persistence is enabled. +After enabling RDB persistence, you will be unable to disable it. +Support for disabling RDB persistence after enabling will be added at a later date. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RdbPersistenceFrequency +[Preview] Sets the frequency at which a snapshot of the database is created if RDB persistence is enabled. +Allowed values: 1h, 6h, 12h + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.RdbFrequency +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.IDatabase + +## 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. + + +`LINKEDDATABASE <ILinkedDatabase[]>`: List of database resources to link with this database To construct, see NOTES section for GEOREPLICATIONLINKEDDATABASE properties and create a hash table. + - `[Id <String>]`: Resource ID of a database resource to link with this database. + +`MODULE <IModule[]>`: Optional set of redis modules to enable in this database - modules can only be added at create time. + - `Name <String>`: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' + - `[Arg <String>]`: Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/New-AzRedisEnterpriseCacheKey.md b/azps-10.1.0/Az.RedisEnterpriseCache/New-AzRedisEnterpriseCacheKey.md new file mode 100644 index 0000000000..1bcf04a17a --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/New-AzRedisEnterpriseCacheKey.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/new-azredisenterprisecachekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/New-AzRedisEnterpriseCacheKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/New-AzRedisEnterpriseCacheKey.md +--- + +# New-AzRedisEnterpriseCacheKey + +## SYNOPSIS +Regenerates an access key for a Redis Enterprise database. + +## SYNTAX + +``` +New-AzRedisEnterpriseCacheKey -ClusterName <String> -ResourceGroupName <String> -KeyType <AccessKeyType> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Regenerates an access key for a Redis Enterprise database. + +## EXAMPLES + +### Example 1: Regenerate primary access key +```powershell +New-AzRedisEnterpriseCacheKey -Name "MyCache" -ResourceGroupName "MyGroup" -KeyType "Primary" +``` + +```output +PrimaryKey SecondaryKey +---------- ------------ +new-primary-key secondary-key + +``` + +This command regenerates the primary secret access key used for authenticating connections to the database of the Redis Enterprise cache named MyCache. + +### Example 2: Regenerate secondary access key +```powershell +New-AzRedisEnterpriseCacheKey -Name "MyCache" -ResourceGroupName "MyGroup" -KeyType "Secondary" +``` + +```output +PrimaryKey SecondaryKey +---------- ------------ +primary-key new-secondary-key + +``` + +This command regenerates the secondary secret access key used for authenticating connections to the database of the Redis Enterprise cache named MyCache. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Redis Enterprise cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyType +Which access key to regenerate. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.AccessKeyType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.IAccessKeys + +## NOTES + +ALIASES + +New-AzRedisEnterpriseCacheDatabaseKey + +New-AzRedisEnterpriseCacheAccessKey + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/Remove-AzRedisEnterpriseCache.md b/azps-10.1.0/Az.RedisEnterpriseCache/Remove-AzRedisEnterpriseCache.md new file mode 100644 index 0000000000..dd30bc9e97 --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/Remove-AzRedisEnterpriseCache.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/remove-azredisenterprisecache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Remove-AzRedisEnterpriseCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Remove-AzRedisEnterpriseCache.md +--- + +# Remove-AzRedisEnterpriseCache + +## SYNOPSIS +Deletes a RedisEnterprise cache cluster. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzRedisEnterpriseCache -ClusterName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzRedisEnterpriseCache -InputObject <IRedisEnterpriseCacheIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a RedisEnterprise cache cluster. + +## EXAMPLES + +### Example 1: Remove a Redis Enterprise cache and return the result +```powershell +Remove-AzRedisEnterpriseCache -Name "MyCache" -ResourceGroupName "MyGroup" -PassThru +``` + +```output +True +``` + +This command removes a Redis Enterprise cache and displays whether the operation is successful. + +### Example 2: Remove a Redis Enterprise cache and do not display the result +```powershell +Remove-AzRedisEnterpriseCache -Name "MyCache" -ResourceGroupName "MyGroup" +``` + +This command removes a Redis Enterprise cache. +Because the PassThru parameter is not specified, the result of the operation is not displayed. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the RedisEnterprise cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.IRedisEnterpriseCacheIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.IRedisEnterpriseCacheIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IRedisEnterpriseCacheIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the RedisEnterprise cluster. + - `[DatabaseName <String>]`: The name of the database. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/Remove-AzRedisEnterpriseCacheDatabase.md b/azps-10.1.0/Az.RedisEnterpriseCache/Remove-AzRedisEnterpriseCacheDatabase.md new file mode 100644 index 0000000000..f8df4bdc12 --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/Remove-AzRedisEnterpriseCacheDatabase.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/remove-azredisenterprisecachedatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Remove-AzRedisEnterpriseCacheDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Remove-AzRedisEnterpriseCacheDatabase.md +--- + +# Remove-AzRedisEnterpriseCacheDatabase + +## SYNOPSIS +Deletes a single database in a Redis Enterprise cache. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzRedisEnterpriseCacheDatabase -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzRedisEnterpriseCacheDatabase -InputObject <IRedisEnterpriseCacheIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a single database in a Redis Enterprise cache. + +## EXAMPLES + +### Example 1: Remove a database in a Redis Enterprise cache and return the result +```powershell +Remove-AzRedisEnterpriseCacheDatabase -Name "MyCache" -ResourceGroupName "MyGroup" -PassThru +``` + +```output +True +``` + +This command removes a database in a Redis Enterprise cache and displays whether the operation is successful. + +### Example 2: Remove a database in a Redis Enterprise cache and do not display the result +```powershell +Remove-AzRedisEnterpriseCacheDatabase -Name "MyCache" -ResourceGroupName "MyGroup" +``` + +This command removes a database in a Redis Enterprise cache. +Because the PassThru parameter is not specified, the result of the operation is not displayed. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Redis Enterprise cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.IRedisEnterpriseCacheIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.IRedisEnterpriseCacheIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IRedisEnterpriseCacheIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the RedisEnterprise cluster. + - `[DatabaseName <String>]`: The name of the database. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/Update-AzRedisEnterpriseCache.md b/azps-10.1.0/Az.RedisEnterpriseCache/Update-AzRedisEnterpriseCache.md new file mode 100644 index 0000000000..ddf7ca9eb3 --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/Update-AzRedisEnterpriseCache.md @@ -0,0 +1,372 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/update-azredisenterprisecache +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Update-AzRedisEnterpriseCache.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Update-AzRedisEnterpriseCache.md +--- + +# Update-AzRedisEnterpriseCache + +## SYNOPSIS +Updates an existing RedisEnterprise cluster + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzRedisEnterpriseCache -ClusterName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Capacity <Int32>] [-CustomerManagedKeyEncryptionKeyUrl <String>] + [-IdentityType <ManagedServiceIdentityType>] [-IdentityUserAssignedIdentity <Hashtable>] + [-KeyEncryptionKeyIdentityType <CmkIdentityType>] + [-KeyEncryptionKeyIdentityUserAssignedIdentityResourceId <String>] [-MinimumTlsVersion <TlsVersion>] + [-Sku <SkuName>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzRedisEnterpriseCache -InputObject <IRedisEnterpriseCacheIdentity> [-Capacity <Int32>] + [-CustomerManagedKeyEncryptionKeyUrl <String>] [-IdentityType <ManagedServiceIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-KeyEncryptionKeyIdentityType <CmkIdentityType>] + [-KeyEncryptionKeyIdentityUserAssignedIdentityResourceId <String>] [-MinimumTlsVersion <TlsVersion>] + [-Sku <SkuName>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing RedisEnterprise cluster + +## EXAMPLES + +### Example 1: Update Redis Enterprise cache +```powershell +Update-AzRedisEnterpriseCache -Name "MyCache" -ResourceGroupName "MyGroup" -MinimumTlsVersion "1.2" -Tag @{"tag1" = "value1"} +``` + +```output +Location Name Type Zone Database +-------- ---- ---- ---- -------- +West US MyCache Microsoft.Cache/redisEnterprise {default} + +``` + +This command updates the minimum TLS version and adds a tag to the Redis Enterprise cache named MyCache. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Capacity +The size of the RedisEnterprise cluster. +Defaults to 2 or 3 depending on SKU. +Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: SkuCapacity + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the RedisEnterprise cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerManagedKeyEncryptionKeyUrl +Key encryption key Url, versioned only. +Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +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. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.IRedisEnterpriseCacheIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyIdentityType +Only userAssignedIdentity is supported in this API version; other types may be supported in the future + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.CmkIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyEncryptionKeyIdentityUserAssignedIdentityResourceId +User assigned identity to use for accessing key encryption key Url. +Ex: /subscriptions/\<sub uuid\>/resourceGroups/\<resource group\>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +The minimum TLS version for the cluster to support, e.g. +'1.2' + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.TlsVersion +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The type of RedisEnterprise cluster to deploy. +Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.) + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.SkuName +Parameter Sets: (All) +Aliases: SkuName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.IRedisEnterpriseCacheIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.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 <IRedisEnterpriseCacheIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the RedisEnterprise cluster. + - `[DatabaseName <String>]`: The name of the database. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.RedisEnterpriseCache/Update-AzRedisEnterpriseCacheDatabase.md b/azps-10.1.0/Az.RedisEnterpriseCache/Update-AzRedisEnterpriseCacheDatabase.md new file mode 100644 index 0000000000..9f7e619247 --- /dev/null +++ b/azps-10.1.0/Az.RedisEnterpriseCache/Update-AzRedisEnterpriseCacheDatabase.md @@ -0,0 +1,336 @@ +--- +external help file: +Module Name: Az.RedisEnterpriseCache +online version: https://learn.microsoft.com/powershell/module/az.redisenterprisecache/update-azredisenterprisecachedatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Update-AzRedisEnterpriseCacheDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/RedisEnterpriseCache/help/Update-AzRedisEnterpriseCacheDatabase.md +--- + +# Update-AzRedisEnterpriseCacheDatabase + +## SYNOPSIS +Updates an existing Redis Enterprise database + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzRedisEnterpriseCacheDatabase -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AofPersistenceEnabled] [-AofPersistenceFrequency <AofFrequency>] + [-ClientProtocol <Protocol>] [-EvictionPolicy <EvictionPolicy>] [-RdbPersistenceEnabled] + [-RdbPersistenceFrequency <RdbFrequency>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzRedisEnterpriseCacheDatabase -InputObject <IRedisEnterpriseCacheIdentity> [-AofPersistenceEnabled] + [-AofPersistenceFrequency <AofFrequency>] [-ClientProtocol <Protocol>] [-EvictionPolicy <EvictionPolicy>] + [-RdbPersistenceEnabled] [-RdbPersistenceFrequency <RdbFrequency>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing Redis Enterprise database + +## EXAMPLES + +### Example 1: Update client protocol property of a database +```powershell +Update-AzRedisEnterpriseCacheDatabase -Name "MyCache" -ResourceGroupName "MyGroup" -ClientProtocol "Plaintext" +``` + +```output +Name Type +---- ---- +default Microsoft.Cache/redisEnterprise/databases + +``` + +This command updates the client protocol of the database for the Redis Enterprise cache named MyCache. + +### Example 2: Update client protocol and eviction policy properties of a database +```powershell +Update-AzRedisEnterpriseCacheDatabase -Name "MyCache" -ResourceGroupName "MyGroup" -ClientProtocol "Encrypted" -EvictionPolicy "NoEviction" +``` + +```output +Name Type +---- ---- +default Microsoft.Cache/redisEnterprise/databases + +``` + +This command updates the client protocol and eviction policy of the database for the Redis Enterprise cache named MyCache. + +## PARAMETERS + +### -AofPersistenceEnabled +[Preview] Sets whether AOF persistence is enabled. +After enabling AOF persistence, you will be unable to disable it. +Support for disabling AOF persistence after enabling will be added at a later date. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AofPersistenceFrequency +[Preview] Sets the frequency at which data is written to disk if AOF persistence is enabled. +Allowed values: 1s, always + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.AofFrequency +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientProtocol +Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. +Allowed values: Encrypted, Plaintext + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.Protocol +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the Redis Enterprise cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EvictionPolicy +Redis eviction policy. +Allowed values: AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom, NoEviction + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.EvictionPolicy +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.RedisEnterpriseCache.Models.IRedisEnterpriseCacheIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RdbPersistenceEnabled +[Preview] Sets whether RDB persistence is enabled. +After enabling RDB persistence, you will be unable to disable it. +Support for disabling RDB persistence after enabling will be added at a later date. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RdbPersistenceFrequency +[Preview] Sets the frequency at which a snapshot of the database is created if RDB persistence is enabled. +Allowed values: 1h, 6h, 12h + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Support.RdbFrequency +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.IRedisEnterpriseCacheIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.Api20230301Preview.IDatabase + +## 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 <IRedisEnterpriseCacheIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the RedisEnterprise cluster. + - `[DatabaseName <String>]`: The name of the database. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[OperationId <String>]`: The ID of an ongoing async operation. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection associated with the Azure resource + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Az.Relay.md b/azps-10.1.0/Az.Relay/Az.Relay.md new file mode 100644 index 0000000000..8ceef8b779 --- /dev/null +++ b/azps-10.1.0/Az.Relay/Az.Relay.md @@ -0,0 +1,88 @@ +--- +Module Name: Az.Relay +Module Guid: 14fdcc41-318e-4838-8905-9cf090a8339c +Download Help Link: https://learn.microsoft.com/powershell/module/az.relay +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Az.Relay.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Az.Relay.md +--- + +# Az.Relay Module +## Description +Microsoft Azure PowerShell: Relay cmdlets + +## Az.Relay Cmdlets +### [Get-AzRelayAuthorizationRule](Get-AzRelayAuthorizationRule.md) +Authorization rule for a namespace by name. + +### [Get-AzRelayHybridConnection](Get-AzRelayHybridConnection.md) +Returns the description for the specified hybrid connection. + +### [Get-AzRelayKey](Get-AzRelayKey.md) +Primary and secondary connection strings to the namespace. + +### [Get-AzRelayNamespace](Get-AzRelayNamespace.md) +Returns the description for the specified namespace. + +### [Get-AzRelayNamespaceNetworkRuleSet](Get-AzRelayNamespaceNetworkRuleSet.md) +Gets NetworkRuleSet for a Namespace. + +### [Get-AzWcfRelay](Get-AzWcfRelay.md) +Returns the description for the specified WCF relay. + +### [New-AzRelayAuthorizationRule](New-AzRelayAuthorizationRule.md) +Creates or updates an authorization rule for a namespace. + +### [New-AzRelayHybridConnection](New-AzRelayHybridConnection.md) +Creates or updates a service hybrid connection. +This operation is idempotent. + +### [New-AzRelayKey](New-AzRelayKey.md) +Regenerates the primary or secondary connection strings to the namespace. + +### [New-AzRelayNamespace](New-AzRelayNamespace.md) +Create Azure Relay namespace. + +### [New-AzRelayNetworkRuleSetIPRuleObject](New-AzRelayNetworkRuleSetIPRuleObject.md) +Create an in-memory object for NwRuleSetIPRules. + +### [New-AzWcfRelay](New-AzWcfRelay.md) +Creates or updates a WCF relay. +This operation is idempotent. + +### [Remove-AzRelayAuthorizationRule](Remove-AzRelayAuthorizationRule.md) +Deletes a namespace authorization rule. + +### [Remove-AzRelayHybridConnection](Remove-AzRelayHybridConnection.md) +Deletes a hybrid connection. + +### [Remove-AzRelayNamespace](Remove-AzRelayNamespace.md) +Deletes an existing namespace. +This operation also removes all associated resources under the namespace. + +### [Remove-AzWcfRelay](Remove-AzWcfRelay.md) +Deletes a WCF relay. + +### [Set-AzRelayAuthorizationRule](Set-AzRelayAuthorizationRule.md) +Creates or updates an authorization rule for a namespace. + +### [Set-AzRelayHybridConnection](Set-AzRelayHybridConnection.md) +Creates or updates a service hybrid connection. +This operation is idempotent. + +### [Set-AzRelayNamespaceNetworkRuleSet](Set-AzRelayNamespaceNetworkRuleSet.md) +Update NetworkRuleSet for a Namespace. + +### [Set-AzWcfRelay](Set-AzWcfRelay.md) +Creates or updates a WCF relay. +This operation is idempotent. + +### [Test-AzRelayName](Test-AzRelayName.md) +Check the specified namespace name availability. + +### [Update-AzRelayNamespace](Update-AzRelayNamespace.md) +Creates or updates a namespace. +Once created, this namespace's resource manifest is immutable. +This operation is idempotent. + diff --git a/azps-10.1.0/Az.Relay/Get-AzRelayAuthorizationRule.md b/azps-10.1.0/Az.Relay/Get-AzRelayAuthorizationRule.md new file mode 100644 index 0000000000..61cb1cbbb0 --- /dev/null +++ b/azps-10.1.0/Az.Relay/Get-AzRelayAuthorizationRule.md @@ -0,0 +1,342 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/get-azrelayauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Get-AzRelayAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Get-AzRelayAuthorizationRule.md +--- + +# Get-AzRelayAuthorizationRule + +## SYNOPSIS +Authorization rule for a namespace by name. + +## SYNTAX + +### List (Default) +``` +Get-AzRelayAuthorizationRule -Namespace <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzRelayAuthorizationRule -Name <String> -Namespace <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get1 +``` +Get-AzRelayAuthorizationRule -HybridConnection <String> -Name <String> -Namespace <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get2 +``` +Get-AzRelayAuthorizationRule -Name <String> -Namespace <String> -ResourceGroupName <String> -WcfRelay <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzRelayAuthorizationRule -InputObject <IRelayIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzRelayAuthorizationRule -HybridConnection <String> -Namespace <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List2 +``` +Get-AzRelayAuthorizationRule -Namespace <String> -ResourceGroupName <String> -WcfRelay <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Authorization rule for a namespace by name. + +## EXAMPLES + +### Example 1: List all Authorization Rules of the Relay namespace +```powershell +Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus RootManageSharedAccessKey lucas-relay-rg +eastus authRule-03 lucas-relay-rg +``` + +This cmdlet lists all Authorization Rules of the Relay namespace. + +### Example 2: Get the specified authorization rule description for a given Relay namespace +```powershell +Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name authRule-03 | Format-List +``` + +```output +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa + ce-pwsh01/authorizationrules/authRule-03 +Location : eastus +Name : authRule-03 +ResourceGroupName : lucas-relay-rg +Rights : {Listen, Send} +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/Namespaces/AuthorizationRules +``` + +This cmdlet gets the specified authorization rule description for a given Relay namespace. + +### Example 3: List all Authorization Rules of the Hybrid Connection +```powershell +Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -HybridConnection connection-01 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus authRule-01 lucas-relay-rg +``` + +This cmdlet lists all Authorization Rules of the Hybrid Connection. + +### Example 4: Get the specified authorization rule description for a given Hybrid Connection +```powershell +Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -HybridConnection connection-01 -Name authRule-01 | Format-List +``` + +```output +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa + ce-pwsh01/hybridconnections/connection-01/authorizationrules/authRule-01 +Location : eastus +Name : authRule-01 +ResourceGroupName : lucas-relay-rg +Rights : {Listen, Send} +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/hybridconnections/authorizationrules +``` + +This cmdlet gets the specified authorization rule description for a given Hybrid Connection. + +### Example 5: List all Authorization Rules of the Wcf Relay +```powershell +Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -WcfRelay wcf-01 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus authRule-01 lucas-relay-rg +``` + +This cmdlet lists all Authorization Rules of the Wcf Relay. + +### Example 6: Get the specified authorization rule description for a given Wcf Relay +```powershell +Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -WcfRelay connection-01 -Name authRule-01 | Format-List +``` + +```output +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa + ce-pwsh01/wcfrelays/connection-01/authorizationrules/authRule-01 +Location : eastus +Name : authRule-01 +ResourceGroupName : lucas-relay-rg +Rights : {Listen, Send} +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/wcfrelays/authorizationrules +``` + +This cmdlet gets the specified authorization rule description for a given Wcf Relay. + +### Example 7: Get the specified authorization rule description by pipeline +```powershell +Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 | Get-AzRelayAuthorizationRule +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus RootManageSharedAccessKey lucas-relay-rg +eastus authRule-03 lucas-relay-rg +``` + +This cmdlet gets the specified authorization rule description by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridConnection +The hybrid connection name. + +```yaml +Type: System.String +Parameter Sets: Get1, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The authorization rule name. + +```yaml +Type: System.String +Parameter Sets: Get, Get1, Get2 +Aliases: AuthorizationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: Get, Get1, Get2, List, List1, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, Get1, Get2, List, List1, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, Get1, Get2, List, List1, List2 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WcfRelay +The relay name. + +```yaml +Type: System.String +Parameter Sets: Get2, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IAuthorizationRule + +## 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 <IRelayIdentity>`: Identity Parameter + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[HybridConnectionName <String>]`: The hybrid connection name. + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[PrivateLinkResourceName <String>]`: The PrivateLinkResource name + - `[RelayName <String>]`: The relay name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Get-AzRelayHybridConnection.md b/azps-10.1.0/Az.Relay/Get-AzRelayHybridConnection.md new file mode 100644 index 0000000000..f371e2b6c9 --- /dev/null +++ b/azps-10.1.0/Az.Relay/Get-AzRelayHybridConnection.md @@ -0,0 +1,219 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/get-azrelayhybridconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Get-AzRelayHybridConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Get-AzRelayHybridConnection.md +--- + +# Get-AzRelayHybridConnection + +## SYNOPSIS +Returns the description for the specified hybrid connection. + +## SYNTAX + +### List (Default) +``` +Get-AzRelayHybridConnection -Namespace <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzRelayHybridConnection -Name <String> -Namespace <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzRelayHybridConnection -InputObject <IRelayIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns the description for the specified hybrid connection. + +## EXAMPLES + +### Example 1: List all Hybrid Connections within the Relay namespace +```powershell +Get-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus connection-01 lucas-relay-rg +``` + +This cmdlet lists all Hybrid Connections within the Relay namespace. + +### Example 2: Gets a HybridConnection within the Relay namespace +```powershell +Get-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-01 | Format-List +``` + +```output +CreatedAt : 12/20/2022 6:29:13 AM +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microso + ft.Relay/namespaces/namespace-pwsh01/hybridconnections/connection-01 +ListenerCount : 0 +Location : eastus +Name : connection-01 +RequiresClientAuthorization : True +ResourceGroupName : lucas-relay-rg +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/hybridconnections +UpdatedAt : 12/20/2022 6:29:40 AM +UserMetadata : +``` + +This cmdlet gets a HybridConnection within the Relay namespace. + +### Example 3: Gets a HybridConnection within the Relay namespace by pipeline +```powershell +Get-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 | Get-AzRelayHybridConnection +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus connection-01 lucas-relay-rg +``` + +This command gets a HybridConnection within the Relay namespace by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The hybrid connection name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: HybridConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IHybridConnection + +## 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 <IRelayIdentity>`: Identity Parameter + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[HybridConnectionName <String>]`: The hybrid connection name. + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[PrivateLinkResourceName <String>]`: The PrivateLinkResource name + - `[RelayName <String>]`: The relay name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Get-AzRelayKey.md b/azps-10.1.0/Az.Relay/Get-AzRelayKey.md new file mode 100644 index 0000000000..b604dfad7f --- /dev/null +++ b/azps-10.1.0/Az.Relay/Get-AzRelayKey.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/get-azrelaykey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Get-AzRelayKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Get-AzRelayKey.md +--- + +# Get-AzRelayKey + +## SYNOPSIS +Primary and secondary connection strings to the namespace. + +## SYNTAX + +### List (Default) +``` +Get-AzRelayKey -Name <String> -Namespace <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### List1 +``` +Get-AzRelayKey -HybridConnection <String> -Name <String> -Namespace <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### List2 +``` +Get-AzRelayKey -Name <String> -Namespace <String> -ResourceGroupName <String> -WcfRelay <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Primary and secondary connection strings to the namespace. + +## EXAMPLES + +### Example 1: Get the primary and secondary connection strings for the given Relay namespace +```powershell +Get-AzRelayKey -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name authRule-01 +``` + +```output +KeyName : authRule-01 +PrimaryConnectionString : Endpoint=sb://namespace-pwsh01.servicebus.windows.net/;SharedAccessKeyName=authRule-01;SharedAccessKey=xxxxxxxxxxxxxxxxx +PrimaryKey : xxxxxxxxxxxxxxxxx +SecondaryConnectionString : Endpoint=sb://namespace-pwsh01.servicebus.windows.net/;SharedAccessKeyName=authRule-01;SharedAccessKey=xxxxxxxxxxxxxxxxx +SecondaryKey : xxxxxxxxxxxxxxxxx +``` + +This cmdlet gets the primary and secondary connection strings for the given Relay namespace. + +### Example 2: Get the primary and secondary connection strings for the given Hybrid Connection +```powershell +Get-AzRelayKey -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -HybridConnection connection-01 -Name authRule-01 +``` + +```output +KeyName : authRule-01 +PrimaryConnectionString : Endpoint=sb://namespace-pwsh01.servicebus.windows.net/;SharedAccessKeyName=authRule-01;SharedAccessKey=xxxxxxxxxxxxxxxxx +PrimaryKey : xxxxxxxxxxxxxxxxx +SecondaryConnectionString : Endpoint=sb://namespace-pwsh01.servicebus.windows.net/;SharedAccessKeyName=authRule-01;SharedAccessKey=xxxxxxxxxxxxxxxxx +SecondaryKey : xxxxxxxxxxxxxxxxx +``` + +This cmdlet gets the primary and secondary connection strings for the given Hybrid Connection. + +### Example 3: Get the primary and secondary connection strings for the given Wcf Relay +```powershell +Get-AzRelayKey -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -WcfRelay wcf-01 -Name authRule-01 | Format-List +``` + +```output +KeyName : authRule-01 +PrimaryConnectionString : Endpoint=sb://namespace-pwsh01.servicebus.windows.net/;SharedAccessKeyName=authRule-01;SharedAccessKey=xxxxxxxxxxxxxxxxx +PrimaryKey : xxxxxxxxxxxxxxxxx +SecondaryConnectionString : Endpoint=sb://namespace-pwsh01.servicebus.windows.net/;SharedAccessKeyName=authRule-01;SharedAccessKey=xxxxxxxxxxxxxxxxx +SecondaryKey : xxxxxxxxxxxxxxxxx +``` + +This cmdlet gets the primary and secondary connection strings for the given Wcf Relay. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridConnection +The hybrid connection name. + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The authorization rule name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WcfRelay +The relay name. + +```yaml +Type: System.String +Parameter Sets: List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IAccessKeys + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Get-AzRelayNamespace.md b/azps-10.1.0/Az.Relay/Get-AzRelayNamespace.md new file mode 100644 index 0000000000..7e0126a537 --- /dev/null +++ b/azps-10.1.0/Az.Relay/Get-AzRelayNamespace.md @@ -0,0 +1,218 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/get-azrelaynamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Get-AzRelayNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Get-AzRelayNamespace.md +--- + +# Get-AzRelayNamespace + +## SYNOPSIS +Returns the description for the specified namespace. + +## SYNTAX + +### List (Default) +``` +Get-AzRelayNamespace [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzRelayNamespace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzRelayNamespace -InputObject <IRelayIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzRelayNamespace -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns the description for the specified namespace. + +## EXAMPLES + +### Example 1: List all Relay namespaces within the resource group +```powershell +Get-AzRelayNamespace -ResourceGroupName lucas-relay-rg +``` + +```output +Name ResourceGroupName Location Status SkuName ServiceBusEndpoint +---- ----------------- -------- ------ ------- ------------------ +lucasrelay lucas-relay-rg West Central US Active Standard https://lucasrelay.servicebus.windows.net:443/ +namespace-pwsh01 lucas-relay-rg East US Active Standard https://namespace-pwsh01.servicebus.windows.net:443/ +``` + +The cmdlet lists all Relay namespaces within the resource group. + +### Example 2: Gets a description for the specified Relay namespace within the resource group +```powershell +Get-AzRelayNamespace -ResourceGroupName lucas-relay-rg -Name namespace-pwsh01 | Format-List +``` + +```output +CreatedAt : 12/20/2022 3:20:46 AM +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microso + ft.Relay/namespaces/namespace-pwsh01 +Location : East US +MetricId : 9e223dbe-3399-4e19-88eb-0975f02ac87f:namespace-pwsh01 +Name : namespace-pwsh01 +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : lucas-relay-rg +ServiceBusEndpoint : https://namespace-pwsh01.servicebus.windows.net:443/ +SkuName : Standard +SkuTier : Standard +Status : Active +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : { + } +Type : Microsoft.Relay/Namespaces +UpdatedAt : 12/20/2022 3:21:28 AM +``` + +The cmdlet gets a description for the specified Relay namespace within the resource group. + +### Example 3: Gets a description for the specified Relay namespace by pipeline +```powershell +$namespaces = Get-AzRelayNamespace -ResourceGroupName lucas-relay-rg +$namespaces[0] | Get-AzRelayNamespace +``` + +```output +Name ResourceGroupName Location Status SkuName ServiceBusEndpoint +---- ----------------- -------- ------ ------- ------------------ +lucasrelay lucas-relay-rg West Central US Active Standard https://lucasrelay.servicebus.windows.net:443/ +``` + +The cmdlet gets a description for the specified Relay namespace by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The namespace name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: NamespaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IRelayNamespace + +## 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 <IRelayIdentity>`: Identity Parameter + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[HybridConnectionName <String>]`: The hybrid connection name. + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[PrivateLinkResourceName <String>]`: The PrivateLinkResource name + - `[RelayName <String>]`: The relay name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Get-AzRelayNamespaceNetworkRuleSet.md b/azps-10.1.0/Az.Relay/Get-AzRelayNamespaceNetworkRuleSet.md new file mode 100644 index 0000000000..9148fc273b --- /dev/null +++ b/azps-10.1.0/Az.Relay/Get-AzRelayNamespaceNetworkRuleSet.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/get-azrelaynamespacenetworkruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Get-AzRelayNamespaceNetworkRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Get-AzRelayNamespaceNetworkRuleSet.md +--- + +# Get-AzRelayNamespaceNetworkRuleSet + +## SYNOPSIS +Gets NetworkRuleSet for a Namespace. + +## SYNTAX + +### Get (Default) +``` +Get-AzRelayNamespaceNetworkRuleSet -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzRelayNamespaceNetworkRuleSet -InputObject <IRelayIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets NetworkRuleSet for a Namespace. + +## EXAMPLES + +### Example 1: Gets NetworkRuleSet for a Relay Namespace +```powershell +Get-AzRelayNamespaceNetworkRuleSet -ResourceGroupName lucas-relay-rg -NamespaceName namespace-pwsh01 | Format-List +``` + +```output +DefaultAction : Deny +IPRule : {{ + "ipMask": "1.1.1.1", + "action": "Allow" + }, { + "ipMask": "1.1.1.2", + "action": "Allow" + }, { + "ipMask": "1.1.1.3", + "action": "Allow" + }} +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa + ce-pwsh01/networkRuleSets/default +Name : default +PublicNetworkAccess : Enabled +ResourceGroupName : lucas-relay-rg +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/Namespaces/NetworkRuleSets +``` + +This cmdlet gets NetworkRuleSet for a Relay Namespace. + +### Example 2: Gets NetworkRuleSet for a Relay Namespace by pipeline +```powershell +$rules = @() +$rules += New-AzRelayNetworkRuleSetIPRuleObject -Action 'Allow' -IPMask "1.1.1.1" +$rules += New-AzRelayNetworkRuleSetIPRuleObject -Action 'Allow' -IPMask "1.1.1.2" +$rules += New-AzRelayNetworkRuleSetIPRuleObject -Action 'Allow' -IPMask "1.1.1.3" +Set-AzRelayNamespaceNetworkRuleSet -ResourceGroupName lucas-relay-rg -NamespaceName namespace-pwsh01 -DefaultAction 'Deny' -IPRule $rules | Get-AzRelayNamespaceNetworkRuleSet | Format-List +``` + +```output +DefaultAction : Deny +IPRule : {{ + "ipMask": "1.1.1.1", + "action": "Allow" + }, { + "ipMask": "1.1.1.2", + "action": "Allow" + }, { + "ipMask": "1.1.1.3", + "action": "Allow" + }} +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa + ce-pwsh01/networkRuleSets/default +Name : default +PublicNetworkAccess : Enabled +ResourceGroupName : lucas-relay-rg +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/Namespaces/NetworkRuleSets +``` + +This cmdlet gets NetworkRuleSet for a Relay Namespace by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.INetworkRuleSet + +## 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 <IRelayIdentity>`: Identity Parameter + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[HybridConnectionName <String>]`: The hybrid connection name. + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[PrivateLinkResourceName <String>]`: The PrivateLinkResource name + - `[RelayName <String>]`: The relay name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Get-AzWcfRelay.md b/azps-10.1.0/Az.Relay/Get-AzWcfRelay.md new file mode 100644 index 0000000000..d6a33a10dc --- /dev/null +++ b/azps-10.1.0/Az.Relay/Get-AzWcfRelay.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/get-azwcfrelay +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Get-AzWcfRelay.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Get-AzWcfRelay.md +--- + +# Get-AzWcfRelay + +## SYNOPSIS +Returns the description for the specified WCF relay. + +## SYNTAX + +### List (Default) +``` +Get-AzWcfRelay -Namespace <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWcfRelay -Name <String> -Namespace <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWcfRelay -InputObject <IRelayIdentity> [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>] +``` + +## DESCRIPTION +Returns the description for the specified WCF relay. + +## EXAMPLES + +### Example 1: List all Wcf Relays within the Relay namespace +```powershell +Get-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus wcf-02 lucas-relay-rg +eastus wcf-03 lucas-relay-rg +``` + +This cmdlet lists all Wcf Relays within the Relay namespace. + +### Example 2: Get a Wcf Relay +```powershell +Get-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02 | Format-List +``` + +```output +CreatedAt : 12/20/2022 9:01:10 AM +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa + ce-pwsh01/wcfrelays/wcf-02 +IsDynamic : False +ListenerCount : 0 +Location : eastus +Name : wcf-02 +RelayType : NetTcp +RequiresClientAuthorization : False +RequiresTransportSecurity : False +ResourceGroupName : lucas-relay-rg +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/wcfrelays +UpdatedAt : 12/20/2022 9:21:58 AM +UserMetadata : User Date +``` + +This cmdlet gets a Wcf Relay. + +### Example 3: Get a Wcf Relay by pipeline +```powershell +Get-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 | Get-AzWcfRelay +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus wcf-02 lucas-relay-rg +eastus wcf-03 lucas-relay-rg +``` + +This cmdlet gets a Wcf Relay by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The relay name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IWcfRelay + +## 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 <IRelayIdentity>`: Identity Parameter + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[HybridConnectionName <String>]`: The hybrid connection name. + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[PrivateLinkResourceName <String>]`: The PrivateLinkResource name + - `[RelayName <String>]`: The relay name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/New-AzRelayAuthorizationRule.md b/azps-10.1.0/Az.Relay/New-AzRelayAuthorizationRule.md new file mode 100644 index 0000000000..7fe01e6c77 --- /dev/null +++ b/azps-10.1.0/Az.Relay/New-AzRelayAuthorizationRule.md @@ -0,0 +1,280 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/new-azrelayauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/New-AzRelayAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/New-AzRelayAuthorizationRule.md +--- + +# New-AzRelayAuthorizationRule + +## SYNOPSIS +Creates or updates an authorization rule for a namespace. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzRelayAuthorizationRule -Name <String> -Namespace <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Rights <AccessRights[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CreateExpanded1 +``` +New-AzRelayAuthorizationRule -HybridConnection <String> -Name <String> -Namespace <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-Rights <AccessRights[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateExpanded2 +``` +New-AzRelayAuthorizationRule -Name <String> -Namespace <String> -ResourceGroupName <String> -WcfRelay <String> + [-SubscriptionId <String>] [-Rights <AccessRights[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an authorization rule for a namespace. + +## EXAMPLES + +### Example 1: Creates Authorization Rule with Listen rights for the Relay namespace +```powershell +New-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name authRule-03 -Rights 'Listen','Send' +``` + +```output +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa + ce-pwsh01/authorizationrules/authRule-03 +Location : eastus +Name : authRule-03 +ResourceGroupName : lucas-relay-rg +Rights : {Listen, Send} +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/Namespaces/AuthorizationRules +``` + +This cmdlet creates Authorization Rule with Listen rights for the Relay namespace. + +### Example 2: Creates Authorization Rule with Listen rights for the Hybrid Connection +```powershell +New-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -HybridConnection connection-01 -Name authRule-01 -Rights 'Listen','Send' | Format-List +``` + +```output +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa + ce-pwsh01/hybridConnections/connection-01/authorizationRules/authRule-01 +Location : +Name : authRule-01 +ResourceGroupName : lucas-relay-rg +Rights : {Listen, Send} +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/hybridconnections/authorizationrules +``` + +This cmdlet creates Authorization Rule with Listen rights for the Hybrid Connection. + +### Example 3: Creates Authorization Rule with Listen rights for the Wcf Relay +```powershell +New-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -WcfRelay wcf-01 -Name authRule-01 -Rights 'Listen','Send' | Format-List +``` + +```output +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespace-pwsh01/wcfRelays/wcf-01/authorizationRules/authRule-01 +Location : +Name : authRule-01 +ResourceGroupName : lucas-relay-rg +Rights : {Listen, Send} +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/wcfrelays/authorizationrules +``` + +This cmdlet creates Authorization Rule with Listen rights for for the Wcf Relay. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridConnection +The hybrid connection name. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The authorization rule name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AuthorizationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rights +The rights associated with the rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.AccessRights[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WcfRelay +The relay name. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IAuthorizationRule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/New-AzRelayHybridConnection.md b/azps-10.1.0/Az.Relay/New-AzRelayHybridConnection.md new file mode 100644 index 0000000000..cfb32d91d6 --- /dev/null +++ b/azps-10.1.0/Az.Relay/New-AzRelayHybridConnection.md @@ -0,0 +1,312 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/new-azrelayhybridconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/New-AzRelayHybridConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/New-AzRelayHybridConnection.md +--- + +# New-AzRelayHybridConnection + +## SYNOPSIS +Creates or updates a service hybrid connection. +This operation is idempotent. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzRelayHybridConnection -Name <String> -Namespace <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-RequiresClientAuthorization] [-UserMetadata <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzRelayHybridConnection -Name <String> -Namespace <String> -ResourceGroupName <String> + -InputObject <IHybridConnection> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a service hybrid connection. +This operation is idempotent. + +## EXAMPLES + +### Example 1: Creates a Hybrid Connection in the specified Relay namespace +```powershell +New-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-01 -UserMetadata "test 01" | Format-List +``` + +```output +CreatedAt : 1/1/0001 12:00:00 AM +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microso + ft.Relay/namespaces/namespace-pwsh01/hybridconnections/connection-01 +ListenerCount : 0 +Location : eastus +Name : connection-01 +RequiresClientAuthorization : True +ResourceGroupName : lucas-relay-rg +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/hybridconnections +UpdatedAt : 1/1/0001 12:00:00 AM +UserMetadata : +``` + +This cmdlet creates a Hybrid Connection in the specified Relay namespace. + +### Example 2: Create a new Hybrid Connection using an existing Hybrid Connection as a parameter +```powershell +$connection = Get-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-01 +$connection.RequiresClientAuthorization = $false +New-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-02 -InputObject $connection | Format-List +``` + +```output +CreatedAt : 12/20/2022 9:13:18 AM +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa + ce-pwsh01/hybridconnections/connection-02 +ListenerCount : 0 +Location : eastus +Name : connection-02 +RequiresClientAuthorization : False +ResourceGroupName : lucas-relay-rg +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/hybridconnections +UpdatedAt : 12/20/2022 9:13:18 AM +UserMetadata : test 03 +``` + +This cmdlet creates a new Hybrid Connection using an existing Hybrid Connection as a parameter. + +### Example 3: Update an existing Hybrid Connection +```powershell +$connection = Get-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-02 +$connection.UserMetadata = "TestHybirdConnection2" +New-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-02 -InputObject $connection | Format-List +``` + +```output +CreatedAt : 1/1/0001 12:00:00 AM +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa + ce-pwsh01/hybridconnections/connection-02 +ListenerCount : 0 +Location : eastus +Name : connection-02 +RequiresClientAuthorization : False +ResourceGroupName : lucas-relay-rg +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/hybridconnections +UpdatedAt : 1/1/0001 12:00:00 AM +UserMetadata : TestHybirdConnection2 +``` + +This cmdlet updates an existing Hybrid Connection. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Description of hybrid connection resource. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IHybridConnection +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The hybrid connection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HybridConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiresClientAuthorization +Returns true if client authorization is needed for this hybrid connection; otherwise, false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserMetadata +The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. +For example, it can be used to store descriptive data, such as a list of teams and their contact information. +Also, user-defined configuration settings can be stored. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IHybridConnection + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IHybridConnection + +## 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 <IHybridConnection>`: Description of hybrid connection resource. + - `[RequiresClientAuthorization <Boolean?>]`: Returns true if client authorization is needed for this hybrid connection; otherwise, false. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[UserMetadata <String>]`: The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/New-AzRelayKey.md b/azps-10.1.0/Az.Relay/New-AzRelayKey.md new file mode 100644 index 0000000000..443ef05740 --- /dev/null +++ b/azps-10.1.0/Az.Relay/New-AzRelayKey.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/new-azrelaykey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/New-AzRelayKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/New-AzRelayKey.md +--- + +# New-AzRelayKey + +## SYNOPSIS +Regenerates the primary or secondary connection strings to the namespace. + +## SYNTAX + +### RegenerateExpanded (Default) +``` +New-AzRelayKey -Name <String> -Namespace <String> -ResourceGroupName <String> -RegenerateKey <KeyType> + [-SubscriptionId <String>] [-KeyValue <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### RegenerateExpanded1 +``` +New-AzRelayKey -HybridConnection <String> -Name <String> -Namespace <String> -ResourceGroupName <String> + -RegenerateKey <KeyType> [-SubscriptionId <String>] [-KeyValue <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RegenerateExpanded2 +``` +New-AzRelayKey -Name <String> -Namespace <String> -ResourceGroupName <String> -WcfRelay <String> + -RegenerateKey <KeyType> [-SubscriptionId <String>] [-KeyValue <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerates the primary or secondary connection strings to the namespace. + +## EXAMPLES + +### Example 1: Regenerates the primary or secondary connection strings for the given Relay namespace +```powershell +New-AzRelayKey -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name authRule-01 -RegenerateKey 'PrimaryKey' +``` + +```output +KeyName PrimaryConnectionString +------- ----------------------- +authRule-01 Endpoint=sb://namespace-pwsh01.servicebus.windows.net/;SharedAccessKeyName=authRule-01;SharedAccessKey=xxxxxxxxxxxxxxxxx +``` + +This cmdlet regenerates the primary or secondary connection strings for the given Relay namespace. + +### Example 2: Regenerates the primary or secondary connection strings for the given Hybrid Connection +```powershell +New-AzRelayKey -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -HybridConnection connection-01 -Name authRule-01 -RegenerateKey 'PrimaryKey' +``` + +```output +KeyName PrimaryConnectionString +------- ----------------------- +authRule-01 Endpoint=sb://namespace-pwsh01.servicebus.windows.net/;SharedAccessKeyName=authRule-01;SharedAccessKey=xxxxxxxxxxxxxxxxx +``` + +This cmdlet regenerates the primary or secondary connection strings for the given Hybrid Connection. + +### Example 3: Regenerates the primary or secondary connection strings for the given Wcf Relay +```powershell +New-AzRelayKey -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -WcfRelay wcf-01 -Name authRule-01 -RegenerateKey 'PrimaryKey' +``` + +```output +KeyName PrimaryConnectionString +------- ----------------------- +authRule-01 Endpoint=sb://namespace-pwsh01.servicebus.windows.net/;SharedAccessKeyName=authRule-01;SharedAccessKey=xxxxxxxxxxxxxxxxx +``` + +This cmdlet regenerates the primary or secondary connection strings for the given Wcf Relay. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridConnection +The hybrid connection name. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyValue +Optional. +If the key value is provided, this is set to key type, or autogenerated key value set for key type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The authorization rule name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RegenerateKey +The access key to regenerate. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.KeyType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WcfRelay +The relay name. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IAccessKeys + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/New-AzRelayNamespace.md b/azps-10.1.0/Az.Relay/New-AzRelayNamespace.md new file mode 100644 index 0000000000..4160504f3b --- /dev/null +++ b/azps-10.1.0/Az.Relay/New-AzRelayNamespace.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/new-azrelaynamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/New-AzRelayNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/New-AzRelayNamespace.md +--- + +# New-AzRelayNamespace + +## SYNOPSIS +Create Azure Relay namespace. + +## SYNTAX + +``` +New-AzRelayNamespace -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-SkuTier <SkuTier>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create Azure Relay namespace. + +## EXAMPLES + +### Example 1: Creates a new Relay namespace +```powershell +New-AzRelayNamespace -ResourceGroupName lucas-relay-rg -Name namespace-pwsh01 -Location eastus +``` + +```output +New-AzRelayNamespace -ResourceGroupName lucas-relay-rg -Name namespace-pwsh01 -Location eastus + +Name ResourceGroupName Location Status SkuName ServiceBusEndpoint +---- ----------------- -------- ------ ------- ------------------ +namespace-pwsh01 lucas-relay-rg East US Active Standard https://namespace-pwsh01.servicebus.windows.net:443/ +``` + +The cmdlet creates a new Relay namespace. +Once created, the namespace resource manifest is immutable. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: NamespaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +The tier of this SKU. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IRelayNamespace + +## 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. + + +`PRIVATEENDPOINTCONNECTION <IPrivateEndpointConnection[]>`: List of private endpoint connections. + - `[PrivateEndpointId <String>]`: The ARM identifier for Private Endpoint. + - `[PrivateLinkServiceConnectionStateDescription <String>]`: Description of the connection state. + - `[PrivateLinkServiceConnectionStateStatus <PrivateLinkConnectionStatus?>]`: Status of the connection. + - `[ProvisioningState <EndPointProvisioningState?>]`: Provisioning state of the Private Endpoint Connection. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/New-AzRelayNetworkRuleSetIPRuleObject.md b/azps-10.1.0/Az.Relay/New-AzRelayNetworkRuleSetIPRuleObject.md new file mode 100644 index 0000000000..d49fec1758 --- /dev/null +++ b/azps-10.1.0/Az.Relay/New-AzRelayNetworkRuleSetIPRuleObject.md @@ -0,0 +1,82 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.Relay/new-AzRelayNetworkRuleSetIPRuleObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/New-AzRelayNetworkRuleSetIPRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/New-AzRelayNetworkRuleSetIPRuleObject.md +--- + +# New-AzRelayNetworkRuleSetIPRuleObject + +## SYNOPSIS +Create an in-memory object for NwRuleSetIPRules. + +## SYNTAX + +``` +New-AzRelayNetworkRuleSetIPRuleObject [-Action <NetworkRuleIPAction>] [-IPMask <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for NwRuleSetIPRules. + +## EXAMPLES + +### Example 1: Create an in-memory object for NwRuleSetIPRules +```powershell +$rules = @() +$rules += New-AzRelayNetworkRuleSetIPRuleObject -Action 'Allow' -IPMask "1.1.1.1" +$rules += New-AzRelayNetworkRuleSetIPRuleObject -Action 'Allow' -IPMask "1.1.1.2" +$rules += New-AzRelayNetworkRuleSetIPRuleObject -Action 'Allow' -IPMask "1.1.1.3" +``` + +This cmdlet creates an in-memory object for NwRuleSetIPRules as the value of the `IPRule` parameter in `New-AzRelayNamespaceNetworkRuleSet`. + +## PARAMETERS + +### -Action +The IP Filter Action. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.NetworkRuleIPAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPMask +IP Mask. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.NwRuleSetIPRules + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/New-AzWcfRelay.md b/azps-10.1.0/Az.Relay/New-AzWcfRelay.md new file mode 100644 index 0000000000..e4628e93c1 --- /dev/null +++ b/azps-10.1.0/Az.Relay/New-AzWcfRelay.md @@ -0,0 +1,318 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/new-azwcfrelay +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/New-AzWcfRelay.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/New-AzWcfRelay.md +--- + +# New-AzWcfRelay + +## SYNOPSIS +Creates or updates a WCF relay. +This operation is idempotent. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzWcfRelay -Name <String> -Namespace <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-RequiresClientAuthorization] [-RequiresTransportSecurity] [-UserMetadata <String>] + [-WcfRelayType <Relaytype>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzWcfRelay -Name <String> -Namespace <String> -ResourceGroupName <String> -InputObject <IWcfRelay> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a WCF relay. +This operation is idempotent. + +## EXAMPLES + +### Example 1: Create a new Wcf Relay +```powershell +New-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02 -WcfRelayType 'NetTcp' -UserMetadata "test 01" +``` + +```output +CreatedAt : 12/20/2022 9:01:10 AM +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa + ce-pwsh01/wcfrelays/wcf-02 +IsDynamic : False +ListenerCount : 0 +Location : eastus +Name : wcf-02 +RelayType : NetTcp +RequiresClientAuthorization : False +RequiresTransportSecurity : False +ResourceGroupName : lucas-relay-rg +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/wcfrelays +UpdatedAt : 12/20/2022 9:01:10 AM +UserMetadata : test 01 +``` + +This command creates a new Wcf Relay. + +### Example 2: Create a new Wcf Relay using an existing Wcf Relay as a parameter +```powershell +$wcf = Get-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02 +$wcf.UserMetadata = "User Date" +New-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-03 -InputObject $wcf +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus wcf-03 lucas-relay-rg +``` + +This command creates a new Wcf Relay using an existing Wcf Relay as a parameter. + +### Example 3: Update an existing Wcf Relay +```powershell +$wcf = Get-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02 +$wcf.UserMetadata = "User Date" +New-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02 -InputObject $wcf +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus wcf-02 lucas-relay-rg +``` + +This command updates an existing Wcf Relay. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Description of the WCF relay resource. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IWcfRelay +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The relay name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiresClientAuthorization +Returns true if client authorization is needed for this relay; otherwise, false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiresTransportSecurity +Returns true if transport security is needed for this relay; otherwise, false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserMetadata +The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. +For example, it can be used to store descriptive data, such as list of teams and their contact information. +Also, user-defined configuration settings can be stored. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WcfRelayType +WCF relay type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.Relaytype +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IWcfRelay + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IWcfRelay + +## 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 <IWcfRelay>`: Description of the WCF relay resource. + - `[RelayType <Relaytype?>]`: WCF relay type. + - `[RequiresClientAuthorization <Boolean?>]`: Returns true if client authorization is needed for this relay; otherwise, false. + - `[RequiresTransportSecurity <Boolean?>]`: Returns true if transport security is needed for this relay; otherwise, false. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[UserMetadata <String>]`: The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Remove-AzRelayAuthorizationRule.md b/azps-10.1.0/Az.Relay/Remove-AzRelayAuthorizationRule.md new file mode 100644 index 0000000000..d651acea5f --- /dev/null +++ b/azps-10.1.0/Az.Relay/Remove-AzRelayAuthorizationRule.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/remove-azrelayauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Remove-AzRelayAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Remove-AzRelayAuthorizationRule.md +--- + +# Remove-AzRelayAuthorizationRule + +## SYNOPSIS +Deletes a namespace authorization rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzRelayAuthorizationRule -Name <String> -Namespace <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Delete1 +``` +Remove-AzRelayAuthorizationRule -HybridConnection <String> -Name <String> -Namespace <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### Delete2 +``` +Remove-AzRelayAuthorizationRule -Name <String> -Namespace <String> -ResourceGroupName <String> + -WcfRelay <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzRelayAuthorizationRule -InputObject <IRelayIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a namespace authorization rule. + +## EXAMPLES + +### Example 1: Remove an authorization rule description of the Relay namespace +```powershell +Remove-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name authRule-03 +``` + +This cmdlet removes an authorization rule description of the Relay namespace. + +### Example 2: Remove an authorization rule description of the Hybrid Connection +```powershell +Remove-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -HybridConnection connection-01 -Name authRule-01 +``` + +This cmdlet removes an authorization rule description of the Hybrid Connection. + +### Example 3: Remove an authorization rule description of the Wcf Relay +```powershell +Remove-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -WcfRelay wcf-02 -Name authRule-01 +``` + +This cmdlet removes an authorization rule description of the Wcf Relay. + +### Example 4: Remove authorization rule by pipeline +```powershell +Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -WcfRelay wcf-02 | Remove-AzRelayAuthorizationRule +``` + +This cmdlet removes authorization rule by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridConnection +The hybrid connection name. + +```yaml +Type: System.String +Parameter Sets: Delete1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The authorization rule name. + +```yaml +Type: System.String +Parameter Sets: Delete, Delete1, Delete2 +Aliases: AuthorizationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: Delete, Delete1, Delete2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete, Delete1, Delete2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete, Delete1, Delete2 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WcfRelay +The relay name. + +```yaml +Type: System.String +Parameter Sets: Delete2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IRelayIdentity>`: Identity Parameter + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[HybridConnectionName <String>]`: The hybrid connection name. + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[PrivateLinkResourceName <String>]`: The PrivateLinkResource name + - `[RelayName <String>]`: The relay name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Remove-AzRelayHybridConnection.md b/azps-10.1.0/Az.Relay/Remove-AzRelayHybridConnection.md new file mode 100644 index 0000000000..29c8db468f --- /dev/null +++ b/azps-10.1.0/Az.Relay/Remove-AzRelayHybridConnection.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/remove-azrelayhybridconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Remove-AzRelayHybridConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Remove-AzRelayHybridConnection.md +--- + +# Remove-AzRelayHybridConnection + +## SYNOPSIS +Deletes a hybrid connection. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzRelayHybridConnection -Name <String> -Namespace <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzRelayHybridConnection -InputObject <IRelayIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a hybrid connection. + +## EXAMPLES + +### Example 1: Removes the HybridConnection from the specified HybridConnection namespace +```powershell +Remove-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-01 +``` + +This command removes the HybridConnection from the specified HybridConnection namespace. + +### Example 2: Removes the HybridConnection from the specified HybridConnection namespace by pipeline +```powershell +Get-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-01 | Remove-AzRelayHybridConnection +``` + +This command removes the HybridConnection from the specified HybridConnection namespace by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The hybrid connection name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: HybridConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IRelayIdentity>`: Identity Parameter + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[HybridConnectionName <String>]`: The hybrid connection name. + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[PrivateLinkResourceName <String>]`: The PrivateLinkResource name + - `[RelayName <String>]`: The relay name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Remove-AzRelayNamespace.md b/azps-10.1.0/Az.Relay/Remove-AzRelayNamespace.md new file mode 100644 index 0000000000..51d81ae1f1 --- /dev/null +++ b/azps-10.1.0/Az.Relay/Remove-AzRelayNamespace.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/remove-azrelaynamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Remove-AzRelayNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Remove-AzRelayNamespace.md +--- + +# Remove-AzRelayNamespace + +## SYNOPSIS +Deletes an existing namespace. +This operation also removes all associated resources under the namespace. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzRelayNamespace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzRelayNamespace -InputObject <IRelayIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing namespace. +This operation also removes all associated resources under the namespace. + +## EXAMPLES + +### Example 1: Remove a relay namespace +```powershell +Remove-AzRelayNamespace -ResourceGroupName lucas-relay-rg -Name namespace-pwsh01 +``` + +This cmdlet removes a relay namespace. + +### Example 2: Remove a relay namespace by pipeline +```powershell +Get-AzRelayNamespace -ResourceGroupName lucas-relay-rg -Name namespace-pwsh01 | Remove-AzRelayNamespace +``` + +This cmdlet removes a relay namespace by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: NamespaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IRelayIdentity>`: Identity Parameter + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[HybridConnectionName <String>]`: The hybrid connection name. + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[PrivateLinkResourceName <String>]`: The PrivateLinkResource name + - `[RelayName <String>]`: The relay name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Remove-AzWcfRelay.md b/azps-10.1.0/Az.Relay/Remove-AzWcfRelay.md new file mode 100644 index 0000000000..59e3e5182b --- /dev/null +++ b/azps-10.1.0/Az.Relay/Remove-AzWcfRelay.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/remove-azwcfrelay +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Remove-AzWcfRelay.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Remove-AzWcfRelay.md +--- + +# Remove-AzWcfRelay + +## SYNOPSIS +Deletes a WCF relay. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWcfRelay -Name <String> -Namespace <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWcfRelay -InputObject <IRelayIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a WCF relay. + +## EXAMPLES + +### Example 1: Remove a Wcf Relay +```powershell +Remove-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02 +``` + +This cmdlet removes a Wcf Relay. + +### Example 2: Remove a Wcf Relay by pipeline +```powershell +Get-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-03 | Remove-AzWcfRelay +``` + +This cmdlet removes a Wcf Relay by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The relay name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IRelayIdentity>`: Identity Parameter + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[HybridConnectionName <String>]`: The hybrid connection name. + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[PrivateLinkResourceName <String>]`: The PrivateLinkResource name + - `[RelayName <String>]`: The relay name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Set-AzRelayAuthorizationRule.md b/azps-10.1.0/Az.Relay/Set-AzRelayAuthorizationRule.md new file mode 100644 index 0000000000..777e509168 --- /dev/null +++ b/azps-10.1.0/Az.Relay/Set-AzRelayAuthorizationRule.md @@ -0,0 +1,409 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/set-azrelayauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Set-AzRelayAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Set-AzRelayAuthorizationRule.md +--- + +# Set-AzRelayAuthorizationRule + +## SYNOPSIS +Creates or updates an authorization rule for a namespace. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzRelayAuthorizationRule -Name <String> -Namespace <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Rights <AccessRights[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Update +``` +Set-AzRelayAuthorizationRule -Name <String> -Namespace <String> -ResourceGroupName <String> + -InputObject <IAuthorizationRule> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### Update1 +``` +Set-AzRelayAuthorizationRule -HybridConnection <String> -Name <String> -Namespace <String> + -ResourceGroupName <String> -InputObject <IAuthorizationRule> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Update2 +``` +Set-AzRelayAuthorizationRule -Name <String> -Namespace <String> -ResourceGroupName <String> -WcfRelay <String> + -InputObject <IAuthorizationRule> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateExpanded1 +``` +Set-AzRelayAuthorizationRule -HybridConnection <String> -Name <String> -Namespace <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-Rights <AccessRights[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateExpanded2 +``` +Set-AzRelayAuthorizationRule -Name <String> -Namespace <String> -ResourceGroupName <String> -WcfRelay <String> + [-SubscriptionId <String>] [-Rights <AccessRights[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an authorization rule for a namespace. + +## EXAMPLES + +### Example 1: Adds Listen from the access rights of the authorization rule for the Relay namespace +```powershell +Set-AzRelayAuthorizationRule -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name authRule-01 -Rights 'Listen' | Format-List +``` + +```output +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/Relay-ServiceBus-EastUS/providers/Microsoft.Relay/namespaces/namespace-pwsh01/authorizationRu + les/authRule-01 +Location : eastus +Name : authRule-01 +ResourceGroupName : Relay-ServiceBus-EastUS +Rights : {Listen} +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/Namespaces/AuthorizationRules +``` + +This cmdlet adds Listen from the access rights of the authorization rule for the Relay namespace. + +### Example 2: Adds Send from the access rights of the authorization rule for the Relay namespace with InputeObject parameter +```powershell +$authRule = Get-AzRelayAuthorizationRule -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name authRule-01 +$authRule.Rights += 'Send' +Set-AzRelayAuthorizationRule -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name authRule-01 -InputObject $authRule | Format-List +``` + +```output +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/Relay-ServiceBus-EastUS/providers/Microsoft.Relay/namespaces/namespace-pwsh01/authorizationRu + les/authRule-01 +Location : eastus +Name : authRule-01 +ResourceGroupName : Relay-ServiceBus-EastUS +Rights : {Listen, Send} +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/Namespaces/AuthorizationRules +``` + +This cmdlet adds Send from the access rights of the authorization rule for the Relay namespace with InputeObject parameter. + +### Example 3: Set or update Listen from the access rights of the authorization rule for the Hybrid Connection +```powershell +Set-AzRelayAuthorizationRule -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -HybridConnection connection-01 -Name authRule-02 -Rights 'Listen' | Format-List +``` + +```output +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/Relay-ServiceBus-EastUS/providers/Microsoft.Relay/namespaces/namespace-pwsh01/hybridConnectio + ns/connection-01/authorizationRules/authRule-02 +Location : +Name : authRule-02 +ResourceGroupName : Relay-ServiceBus-EastUS +Rights : {Listen} +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/hybridconnections/authorizationrules +``` + +This cmdlet set or update Listen from the access rights of the authorization rule for the Hybrid Connection. + +### Example 4: Adds Send from the access rights of the authorization rule for the Hybrid Connection with InputeObject parameter +```powershell +$authRule = Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -HybridConnection connection-01 -Name authRule-01 +$authRule.Rights += 'Send' +Set-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -HybridConnection connection-01 -Name authRule-01 -InputObject $authRule | Format-List +``` + +```output +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespace + -pwsh01/hybridConnections/connection-01/authorizationRules/authRule-01 +Location : +Name : authRule-01 +ResourceGroupName : lucas-relay-rg +Rights : {Listen, Send} +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/hybridconnections/authorizationrules +``` + +This cmdlet adds Send from the access rights of the authorization rule for the Hybrid Connection with InputeObject parameter. + +### Example 5: Adds Send from the access rights of the authorization rule for the Wcf Relay +```powershell +Set-AzRelayAuthorizationRule -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -WcfRelay wcfrelay-01 -Name authRule-03 -Rights 'Listen' | Format-List +``` + +```output +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/Relay-ServiceBus-EastUS/providers/Microsoft.Relay/namespaces/namespace-pwsh01/wcfRelays/wcfre + lay-01/authorizationRules/authRule-03 +Location : +Name : authRule-03 +ResourceGroupName : Relay-ServiceBus-EastUS +Rights : {Listen} +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/wcfrelays/authorizationrules +``` + +This cmdlet adds Send from the access rights of the authorization rule for the Wcf Relay. + +### Example 6: Adds Send from the access rights of the authorization rule for the Wcf Relay with InputeObject parameter +```powershell +$authRule = Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -WcfRelay wcf-01 -Name authRule-01 +$authRule.Rights += 'Send' +Set-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -WcfRelay wcf-01 -Name authRule-01 -InputObject $authRule | Format-List +``` + +```output +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespace-pwsh01/wcfRela + ys/wcf-01/authorizationRules/authRule-01 +Location : +Name : authRule-01 +ResourceGroupName : lucas-relay-rg +Rights : {Listen, Send} +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/wcfrelays/authorizationrules +``` + +This cmdlet adds Send from the access rights of the authorization rule for the Wcf Relay with InputeObject parameter. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridConnection +The hybrid connection name. + +```yaml +Type: System.String +Parameter Sets: Update1, UpdateExpanded1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Single item in a List or Get AuthorizationRule operation +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IAuthorizationRule +Parameter Sets: Update, Update1, Update2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The authorization rule name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AuthorizationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rights +The rights associated with the rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.AccessRights[] +Parameter Sets: UpdateExpanded, UpdateExpanded1, UpdateExpanded2 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WcfRelay +The relay name. + +```yaml +Type: System.String +Parameter Sets: Update2, UpdateExpanded2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IAuthorizationRule + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IAuthorizationRule + +## 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 <IAuthorizationRule>`: Single item in a List or Get AuthorizationRule operation + - `[Rights <AccessRights[]>]`: The rights associated with the rule. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Set-AzRelayHybridConnection.md b/azps-10.1.0/Az.Relay/Set-AzRelayHybridConnection.md new file mode 100644 index 0000000000..1c285dd3c9 --- /dev/null +++ b/azps-10.1.0/Az.Relay/Set-AzRelayHybridConnection.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/set-azrelayhybridconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Set-AzRelayHybridConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Set-AzRelayHybridConnection.md +--- + +# Set-AzRelayHybridConnection + +## SYNOPSIS +Creates or updates a service hybrid connection. +This operation is idempotent. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzRelayHybridConnection -Name <String> -Namespace <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-UserMetadata <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Update +``` +Set-AzRelayHybridConnection -Name <String> -Namespace <String> -ResourceGroupName <String> + -InputObject <IHybridConnection> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a service hybrid connection. +This operation is idempotent. + +## EXAMPLES + +### Example 1: Updates the specified HybridConnection with a new UserMetadata in the specified namespace. +```powershell +Set-AzRelayHybridConnection -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name connection-01 -UserMetadata "Update UserMetaData" | Format-List +``` + +```output +CreatedAt : 1/1/0001 12:00:00 AM +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/Relay-ServiceBus-EastUS/providers/Microsoft.Relay/namespaces/namespace-pwsh01/hybridconnectio + ns/connection-01 +ListenerCount : 0 +Location : eastus +Name : connection-01 +RequiresClientAuthorization : True +ResourceGroupName : Relay-ServiceBus-EastUS +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/hybridconnections +UpdatedAt : 1/1/0001 12:00:00 AM +UserMetadata : Update UserMetaData +``` + +This command updates the specified HybridConnection with a new UserMetadata in the specified namespace. +This example updates the UserMetadata property with new value. + +### Example 2: Updates a HybridConnection in the specified Relay namespace +```powershell +$connection = Get-AzRelayHybridConnection -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name connection-01 +$connection.UserMetadata = "testHybirdConnection" +Set-AzRelayHybridConnection -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name connection-01 -InputObject $connection | Format-List +``` + +```output +CreatedAt : 3/30/2023 3:34:25 AM +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/Relay-ServiceBus-EastUS/providers/Microsoft.Relay/namespaces/namespace-pwsh01/hybridconnectio + ns/connection-01 +ListenerCount : 0 +Location : eastus +Name : connection-01 +RequiresClientAuthorization : True +ResourceGroupName : Relay-ServiceBus-EastUS +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/hybridconnections +UpdatedAt : 3/30/2023 6:28:37 AM +UserMetadata : testHybirdConnection +``` + +This command updates a HybridConnection in the specified Relay namespace. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Description of hybrid connection resource. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IHybridConnection +Parameter Sets: Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The hybrid connection name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HybridConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserMetadata +The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. +For example, it can be used to store descriptive data, such as a list of teams and their contact information. +Also, user-defined configuration settings can be stored. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IHybridConnection + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IHybridConnection + +## 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 <IHybridConnection>`: Description of hybrid connection resource. + - `[RequiresClientAuthorization <Boolean?>]`: Returns true if client authorization is needed for this hybrid connection; otherwise, false. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[UserMetadata <String>]`: The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Set-AzRelayNamespaceNetworkRuleSet.md b/azps-10.1.0/Az.Relay/Set-AzRelayNamespaceNetworkRuleSet.md new file mode 100644 index 0000000000..69836f96bd --- /dev/null +++ b/azps-10.1.0/Az.Relay/Set-AzRelayNamespaceNetworkRuleSet.md @@ -0,0 +1,306 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/set-azrelaynamespacenetworkruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Set-AzRelayNamespaceNetworkRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Set-AzRelayNamespaceNetworkRuleSet.md +--- + +# Set-AzRelayNamespaceNetworkRuleSet + +## SYNOPSIS +Update NetworkRuleSet for a Namespace. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzRelayNamespaceNetworkRuleSet -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultAction <DefaultAction>] [-IPRule <INwRuleSetIPRules[]>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Set-AzRelayNamespaceNetworkRuleSet -InputObject <IRelayIdentity> [-DefaultAction <DefaultAction>] + [-IPRule <INwRuleSetIPRules[]>] [-PublicNetworkAccess <PublicNetworkAccess>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update NetworkRuleSet for a Namespace. + +## EXAMPLES + +### Example 1: Update NetworkRuleSet for a Relay Namespace +```powershell +$rules = @() +$rules += New-AzRelayNetworkRuleSetIPRuleObject -Action 'Allow' -IPMask "1.1.1.1" +$rules += New-AzRelayNetworkRuleSetIPRuleObject -Action 'Allow' -IPMask "1.1.1.2" +$rules += New-AzRelayNetworkRuleSetIPRuleObject -Action 'Allow' -IPMask "1.1.1.3" +Set-AzRelayNamespaceNetworkRuleSet -ResourceGroupName Relay-ServiceBus-EastUS -NamespaceName namespace-pwsh01 -DefaultAction 'Deny' -IPRule $rules | Format-List +``` + +```output +DefaultAction : Deny +IPRule : {{ + "ipMask": "1.1.1.1", + "action": "Allow" + }, { + "ipMask": "1.1.1.2", + "action": "Allow" + }, { + "ipMask": "1.1.1.3", + "action": "Allow" + }} +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/Relay-ServiceBus-EastUS/providers/Microsoft.Relay/namespaces/namespace-pwsh01/networkRuleSets + /default +Name : default +PublicNetworkAccess : Enabled +ResourceGroupName : Relay-ServiceBus-EastUS +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/Namespaces/NetworkRuleSets +``` + +This cmdlet update NetworkRuleSet for a Relay Namespace. +Updates the specified NetworkRuleSet with a new IPRule in the specified namespace. + +### Example 2: Update NetworkRuleSet for a Relay Namespace +```powershell +$rules = @() +$rules += New-AzRelayNetworkRuleSetIPRuleObject -Action 'Allow' -IPMask "1.1.1.1" +$rules += New-AzRelayNetworkRuleSetIPRuleObject -Action 'Allow' -IPMask "1.1.1.2" +$rules += New-AzRelayNetworkRuleSetIPRuleObject -Action 'Allow' -IPMask "1.1.1.3" +Get-AzRelayNamespaceNetworkRuleSet -ResourceGroupName Relay-ServiceBus-EastUS -NamespaceName namespace-pwsh01 | Set-AzRelayNamespaceNetworkRuleSet -DefaultAction 'Deny' -IPRule $rules -PublicNetworkAccess 'Enabled' | Format-List +``` + +```output +DefaultAction : Deny +IPRule : {{ + "ipMask": "1.1.1.1", + "action": "Allow" + }, { + "ipMask": "1.1.1.2", + "action": "Allow" + }, { + "ipMask": "1.1.1.3", + "action": "Allow" + }} +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/Relay-ServiceBus-EastUS/providers/Microsoft.Relay/namespaces/namespace-pwsh01/networkRuleSets + /default +Name : default +PublicNetworkAccess : Enabled +ResourceGroupName : Relay-ServiceBus-EastUS +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/Namespaces/NetworkRuleSets +``` + +This cmdlet update the specified NetworkRuleSet for a Relay Namespace. + +## PARAMETERS + +### -DefaultAction +Default Action for Network Rule Set + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.DefaultAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IPRule +List of IpRules +To construct, see NOTES section for IPRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.INwRuleSetIPRules[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +This determines if traffic is allowed over public network. +By default it is enabled + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.INetworkRuleSet + +## 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 <IRelayIdentity>`: Identity Parameter + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[HybridConnectionName <String>]`: The hybrid connection name. + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[PrivateLinkResourceName <String>]`: The PrivateLinkResource name + - `[RelayName <String>]`: The relay name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`IPRULE <INwRuleSetIPRules[]>`: List of IpRules + - `[Action <NetworkRuleIPAction?>]`: The IP Filter Action + - `[IPMask <String>]`: IP Mask + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Set-AzWcfRelay.md b/azps-10.1.0/Az.Relay/Set-AzWcfRelay.md new file mode 100644 index 0000000000..8da9827417 --- /dev/null +++ b/azps-10.1.0/Az.Relay/Set-AzWcfRelay.md @@ -0,0 +1,292 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/set-azwcfrelay +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Set-AzWcfRelay.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Set-AzWcfRelay.md +--- + +# Set-AzWcfRelay + +## SYNOPSIS +Creates or updates a WCF relay. +This operation is idempotent. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzWcfRelay -Name <String> -Namespace <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-UserMetadata <String>] [-WcfRelayType <Relaytype>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Update +``` +Set-AzWcfRelay -Name <String> -Namespace <String> -ResourceGroupName <String> -InputObject <IWcfRelay> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a WCF relay. +This operation is idempotent. + +## EXAMPLES + +### Example 1: Updates the description for the WcfRelay in the specified Relay namespace with InputObject +```powershell +$wcf = Get-AzWcfRelay -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name wcfRelay-01 +$wcf.UserMetadata = "User Meta Data" +Set-AzWcfRelay -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name wcfRelay-01 -InputObject $wcf | Format-List +``` + +```output +CreatedAt : 1/1/0001 12:00:00 AM +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/Relay-ServiceBus-EastUS/providers/Microsoft.Relay/namespaces/namespace-pwsh01/wcfrelays/wcfRe + lay-01 +IsDynamic : False +ListenerCount : 0 +Location : eastus +Name : wcfRelay-01 +RelayType : NetTcp +RequiresClientAuthorization : False +RequiresTransportSecurity : False +ResourceGroupName : Relay-ServiceBus-EastUS +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/wcfrelays +UpdatedAt : 1/1/0001 12:00:00 AM +UserMetadata : User Meta Data +``` + +This command updates the description for the WcfRelay in the specified Relay namespace. + +### Example 2: Updates the description for the WcfRelay in the specified Relay namespace with Properties +```powershell +Set-AzWcfRelay -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name wcfRelay-01 -UserMetadata "usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored." | Format-List +``` + +```output +CreatedAt : 3/30/2023 1:56:56 AM +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/Relay-ServiceBus-EastUS/providers/Microsoft.Relay/namespaces/namespace-pwsh01/wcfrelays/wcfRe + lay-01 +IsDynamic : False +ListenerCount : 0 +Location : eastus +Name : wcfRelay-01 +RelayType : NetTcp +RequiresClientAuthorization : False +RequiresTransportSecurity : False +ResourceGroupName : Relay-ServiceBus-EastUS +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.Relay/namespaces/wcfrelays +UpdatedAt : 3/30/2023 2:53:03 AM +UserMetadata : usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store descriptive data, such as list + of teams and their contact information also user-defined configuration settings can be stored. +``` + +This command updates the specified WcfRelay with a new description in the specified namespace. +This example updates the UserMetadata property with new value. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Description of the WCF relay resource. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IWcfRelay +Parameter Sets: Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The relay name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserMetadata +The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. +For example, it can be used to store descriptive data, such as list of teams and their contact information. +Also, user-defined configuration settings can be stored. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WcfRelayType +WCF relay type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.Relaytype +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IWcfRelay + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IWcfRelay + +## 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 <IWcfRelay>`: Description of the WCF relay resource. + - `[RelayType <Relaytype?>]`: WCF relay type. + - `[RequiresClientAuthorization <Boolean?>]`: Returns true if client authorization is needed for this relay; otherwise, false. + - `[RequiresTransportSecurity <Boolean?>]`: Returns true if transport security is needed for this relay; otherwise, false. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[UserMetadata <String>]`: The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Test-AzRelayName.md b/azps-10.1.0/Az.Relay/Test-AzRelayName.md new file mode 100644 index 0000000000..b5fb6fdf05 --- /dev/null +++ b/azps-10.1.0/Az.Relay/Test-AzRelayName.md @@ -0,0 +1,136 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/test-azrelayname +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Test-AzRelayName.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Test-AzRelayName.md +--- + +# Test-AzRelayName + +## SYNOPSIS +Check the specified namespace name availability. + +## SYNTAX + +``` +Test-AzRelayName -Namespace <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Check the specified namespace name availability. + +## EXAMPLES + +### Example 1: Check the specified namespace name availability +```powershell +Test-AzRelayName -Namespace 'relaynamespace-01' +``` + +```output +Message NameAvailable Reason +------- ------------- ------ + True None +``` + +This cmdlet checks the specified namespace name availability. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Namespace +The namespace name to check for availability. +The namespace name can contain only letters, numbers, and hyphens. +The namespace must start with a letter, and it must end with a letter or number. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.ICheckNameAvailabilityResult + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Relay/Update-AzRelayNamespace.md b/azps-10.1.0/Az.Relay/Update-AzRelayNamespace.md new file mode 100644 index 0000000000..3c0647822d --- /dev/null +++ b/azps-10.1.0/Az.Relay/Update-AzRelayNamespace.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.Relay +online version: https://learn.microsoft.com/powershell/module/az.relay/update-azrelaynamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Update-AzRelayNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Relay/help/Update-AzRelayNamespace.md +--- + +# Update-AzRelayNamespace + +## SYNOPSIS +Creates or updates a namespace. +Once created, this namespace's resource manifest is immutable. +This operation is idempotent. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzRelayNamespace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzRelayNamespace -InputObject <IRelayIdentity> [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a namespace. +Once created, this namespace's resource manifest is immutable. +This operation is idempotent. + +## EXAMPLES + +### Example 1: Updates a Relay namespace +```powershell +Update-AzRelayNamespace -ResourceGroupName lucas-relay-rg -Name namespace-pwsh01 -Tag @{'k'='v'} +``` + +```output +Name ResourceGroupName Location Status SkuName ServiceBusEndpoint +---- ----------------- -------- ------ ------- ------------------ +namespace-pwsh01 lucas-relay-rg East US Activating Standard https://namespace-pwsh01.servicebus.windows.net:443/ +``` + +This cmdlet updates a Relay namespace. + +### Example 2: Updates a Relay namespace by pipeline +```powershell +Get-AzRelayNamespace -ResourceGroupName lucas-relay-rg -Name namespace-pwsh01 | Update-AzRelayNamespace -Tag @{'k'='v'} +``` + +```output +Name ResourceGroupName Location Status SkuName ServiceBusEndpoint +---- ----------------- -------- ------ ------- ------------------ +namespace-pwsh01 lucas-relay-rg East US Activating Standard https://namespace-pwsh01.servicebus.windows.net:443/ +``` + +This cmdlet updates a Relay namespace by pipeline. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The namespace name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: NamespaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.IRelayIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Relay.Models.Api20211101.IRelayNamespace + +## 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 <IRelayIdentity>`: Identity Parameter + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[HybridConnectionName <String>]`: The hybrid connection name. + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[PrivateLinkResourceName <String>]`: The PrivateLinkResource name + - `[RelayName <String>]`: The relay name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[SubscriptionId <String>]`: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`PRIVATEENDPOINTCONNECTION <IPrivateEndpointConnection[]>`: List of private endpoint connections. + - `[PrivateEndpointId <String>]`: The ARM identifier for Private Endpoint. + - `[PrivateLinkServiceConnectionStateDescription <String>]`: Description of the connection state. + - `[PrivateLinkServiceConnectionStateStatus <PrivateLinkConnectionStatus?>]`: Status of the connection. + - `[ProvisioningState <EndPointProvisioningState?>]`: Provisioning state of the Private Endpoint Connection. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Az.Reservations.md b/azps-10.1.0/Az.Reservations/Az.Reservations.md new file mode 100644 index 0000000000..dd3aeb62e1 --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Az.Reservations.md @@ -0,0 +1,69 @@ +--- +Module Name: Az.Reservations +Module Guid: 59d3f19f-af05-4d96-a9a8-ff647983b57f +Download Help Link: https://learn.microsoft.com/powershell/module/az.reservations +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Az.Reservations.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Az.Reservations.md +--- + +# Az.Reservations Module +## Description +Microsoft Azure PowerShell: Reservations cmdlets + +## Az.Reservations Cmdlets +### [Get-AzReservation](Get-AzReservation.md) +Get specific `Reservation` details. + +### [Get-AzReservationAvailableScope](Get-AzReservationAvailableScope.md) +Check whether the scopes from request is valid for `Reservation`.\n + +### [Get-AzReservationCatalog](Get-AzReservationCatalog.md) +Get the regions and skus that are available for RI purchase for the specified Azure subscription. + +### [Get-AzReservationHistory](Get-AzReservationHistory.md) +List of all the revisions for the `Reservation`. + +### [Get-AzReservationOrder](Get-AzReservationOrder.md) +Get the details of the `ReservationOrder`. + +### [Get-AzReservationOrderId](Get-AzReservationOrderId.md) +Get applicable `Reservation`s that are applied to this subscription or a resource group under this subscription. + +### [Get-AzReservationQuote](Get-AzReservationQuote.md) +Calculate price for placing a `ReservationOrder`. + +### [Invoke-AzReservationArchiveReservation](Invoke-AzReservationArchiveReservation.md) +Archiving a `Reservation` moves it to `Archived` state. + +### [Invoke-AzReservationCalculateExchange](Invoke-AzReservationCalculateExchange.md) +Calculates price for exchanging `Reservations` if there are no policy errors.\n + +### [Invoke-AzReservationCalculateRefund](Invoke-AzReservationCalculateRefund.md) +Calculate price for returning `Reservations` if there are no policy errors.\n + +### [Invoke-AzReservationExchange](Invoke-AzReservationExchange.md) +Returns one or more `Reservations` in exchange for one or more `Reservation` purchases.\n + +### [Invoke-AzReservationReturn](Invoke-AzReservationReturn.md) +Return a Reservation. + +### [Invoke-AzReservationUnarchiveReservation](Invoke-AzReservationUnarchiveReservation.md) +Restores a `Reservation` to the state it was before archiving.\n + +### [Merge-AzReservation](Merge-AzReservation.md) +Merge two reservations into one reservation within the same reservation order. + +### [Move-AzReservationDirectory](Move-AzReservationDirectory.md) +Change directory (tenant) of `ReservationOrder` and all `Reservation` under it to specified tenant id + +### [New-AzReservation](New-AzReservation.md) +Purchase `ReservationOrder` and create resource under the specified URI. + +### [Split-AzReservation](Split-AzReservation.md) +Split a Reservation order. + +### [Update-AzReservation](Update-AzReservation.md) +Updates the applied scopes of the `Reservation`. + diff --git a/azps-10.1.0/Az.Reservations/Get-AzReservation.md b/azps-10.1.0/Az.Reservations/Get-AzReservation.md new file mode 100644 index 0000000000..8245322e2d --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Get-AzReservation.md @@ -0,0 +1,263 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/get-azreservation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservation.md +--- + +# Get-AzReservation + +## SYNOPSIS +Get specific `Reservation` details. + +## SYNTAX + +### List1 (Default) +``` +Get-AzReservation [-Filter <String>] [-Orderby <String>] [-SelectedState <String>] [-First <UInt64>] + [-Skip <UInt64>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzReservation -Id <String> -OrderId <String> [-Expand <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzReservation -InputObject <IReservationsIdentity> [-Expand <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzReservation -OrderId <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get specific `Reservation` details. + +## EXAMPLES + +### Example 1: Get the list of reservation orders in the current tenant +```powershell +Get-AzReservation +``` + +```output +Location ReservationOrderId/ReservationId Sku State BenefitStartTime ExpiryDate LastUpdatedDateTime SkuDescription +-------- -------------------------------- --- ----- ---------------- ---------- ------------------- -------------- +centralus a87c1742-0080-5b4d-b953-8531ad46fdc8/cad6fef7-ae86-4d47-91d0-67c897934bfe Standard_B1s Succeeded 6/1/2024 12:00:00 AM +westeurope c5cf5c26-1920-4895-bf34-098ed1c69b92/6540137e-5a4f-4a14-bd17-3f2ea72b1ff4 premium_ssd_managed_disks_p30 Succeeded 6/1/2022 12:00:00 AM +centralus bd82bff8-4d29-9375-8194-ce0709fc1691/f2c3a058-b469-4529-88fa-1bae251c4a47 Standard_B1s Cancelled 6/1/2024 12:00:00 AM +``` + +Get the list of reservation orders in the current tenant. +By design, some propeties do not have data due to the api response(e.g. +LastUpdatedDateTime and SkuDescription). +In this case please get the single reservation with command in example 2 to get the missing data. + +Some data might be trucated due to the width of powershell view, appending this to the end of the command to show the truncated data: | ft -Wrap + +### Example 2: Get the reservation details given ReservationOrderId and ReservationId +```powershell +Get-AzReservation -ReservationOrderId a87c1742-0080-5b4d-b953-8531ad46fdc8 -ReservationId cad6fef7-ae86-4d47-91d0-67c897934bfe +``` + +```output +Location ReservationOrderId/ReservationId Sku State BenefitStartTime ExpiryDate LastUpdatedDateTime SkuDescription +-------- -------------------------------- --- ----- ---------------- ---------- ------------------- -------------- +centralus a87c1742-0080-5b4d-b953-8531ad46fdc8/cad6fef7-ae86-4d47-91d0-67c897934bfe Standard_B1s Succeeded 6/1/2021 5:01:58 PM 6/1/2024 12:00:00 AM 6/1/2021 5:02:09 PM Reserved VM Instance, Standard_B1s, US Central, 3 Years +``` + +Get the details of a single reservation. +Some data might be trucated due to the width of powershell view, appending this to the end of the command to show the truncated data: | ft -Wrap + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Supported value of this query is renewProperties + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +May be used to filter by reservation properties. +The filter supports 'eq', 'or', and 'and'. +It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. +Reservation properties include sku/name, properties/{appliedScopeType, archived, displayName, displayProvisioningState, effectiveDateTime, expiryDate, expiryDateTime, provisioningState, quantity, renew, reservedResourceType, term, userFriendlyAppliedScopeType, userFriendlyRenewState} + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Gets only the first 'n' objects. + +```yaml +Type: System.UInt64 +Parameter Sets: List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of the reservation item + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ReservationId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Orderby +May be used to sort order by reservation properties. + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderId +Order Id of the reservation + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: ReservationOrderId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SelectedState +The selected provisioning state + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Ignores the first 'n' objects and then gets the remaining objects. + +```yaml +Type: System.UInt64 +Parameter Sets: List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IReservationResponse + +## 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 <IReservationsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ReservationId <String>]`: Id of the reservation item + - `[ReservationOrderId <String>]`: Order Id of the reservation + - `[SubscriptionId <String>]`: Id of the subscription + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Get-AzReservationAvailableScope.md b/azps-10.1.0/Az.Reservations/Get-AzReservationAvailableScope.md new file mode 100644 index 0000000000..6944fb0bc4 --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Get-AzReservationAvailableScope.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/get-azreservationavailablescope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservationAvailableScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservationAvailableScope.md +--- + +# Get-AzReservationAvailableScope + +## SYNOPSIS +Check whether the scopes from request is valid for `Reservation`.\n + +## SYNTAX + +### AvailableExpanded (Default) +``` +Get-AzReservationAvailableScope -ReservationId <String> -ReservationOrderId <String> [-Scope <String[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Available +``` +Get-AzReservationAvailableScope -ReservationId <String> -ReservationOrderId <String> + -Body <IAvailableScopeRequest> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### AvailableViaIdentity +``` +Get-AzReservationAvailableScope -InputObject <IReservationsIdentity> -Body <IAvailableScopeRequest> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### AvailableViaIdentityExpanded +``` +Get-AzReservationAvailableScope -InputObject <IReservationsIdentity> [-Scope <String[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Check whether the scopes from request is valid for `Reservation`.\n + +## EXAMPLES + +### Example 1: List available reservation scope +```powershell +Get-AzReservationAvailableScope -ReservationId 2ef560a7-f469-4b62-87b7-5312d588ce2a -ReservationOrderId 2b9b9372-24e1-4a07-a354-2078fe347cf9 -Scope "/subscriptions/3f0487ff-27ca-4b9c-2a23-000770724b1b" +``` + +```output +Scope Valid +----- ----- +/subscriptions/3f0487fd-27ca-4f9c-8a23-000770724b1b True +``` + +List available reservation scope + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +Available scope +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IAvailableScopeRequest +Parameter Sets: Available, AvailableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity +Parameter Sets: AvailableViaIdentity, AvailableViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationId +Id of the reservation item + +```yaml +Type: System.String +Parameter Sets: Available, AvailableExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationOrderId +Order Id of the reservation + +```yaml +Type: System.String +Parameter Sets: Available, AvailableExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +. + +```yaml +Type: System.String[] +Parameter Sets: AvailableExpanded, AvailableViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IAvailableScopeRequest + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.ISubscriptionScopeProperties + +## 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. + + +`BODY <IAvailableScopeRequest>`: Available scope + - `[Scope <String[]>]`: + +`INPUTOBJECT <IReservationsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ReservationId <String>]`: Id of the reservation item + - `[ReservationOrderId <String>]`: Order Id of the reservation + - `[SubscriptionId <String>]`: Id of the subscription + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Get-AzReservationCatalog.md b/azps-10.1.0/Az.Reservations/Get-AzReservationCatalog.md new file mode 100644 index 0000000000..7b882cabb4 --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Get-AzReservationCatalog.md @@ -0,0 +1,306 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/get-azreservationcatalog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservationCatalog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservationCatalog.md +--- + +# Get-AzReservationCatalog + +## SYNOPSIS +Get the regions and skus that are available for RI purchase for the specified Azure subscription. + +## SYNTAX + +### Get (Default) +``` +Get-AzReservationCatalog [-SubscriptionId <String[]>] [-Filter <String>] [-Location <String>] + [-OfferId <String>] [-PlanId <String>] [-PublisherId <String>] [-ReservedResourceType <String>] + [-Skip <Single>] [-Take <Single>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzReservationCatalog -InputObject <IReservationsIdentity> [-Filter <String>] [-Location <String>] + [-OfferId <String>] [-PlanId <String>] [-PublisherId <String>] [-ReservedResourceType <String>] + [-Skip <Single>] [-Take <Single>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the regions and skus that are available for RI purchase for the specified Azure subscription. + +## EXAMPLES + +### Example 1: Get the list of reserved resource type skus with location +```powershell +Get-AzReservationCatalog -SubscriptionId "10000000-aaaa-bbbb-cccc-100000000001" -Location "westus" -ReservedResourceType "VirtualMachine" +``` + +```output +ResourceType Terms Name Locations +------------ ----- ---- --------- +virtualMachines {P1Y, P3Y, P5Y} Standard_B12ms {westus} +virtualMachines {P1Y, P3Y, P5Y} Standard_B16ms {westus} +virtualMachines {P1Y, P3Y, P5Y} Standard_B1ls {westus} +virtualMachines {P1Y, P3Y, P5Y} Standard_B1ms {westus} +virtualMachines {P1Y, P3Y, P5Y} Standard_B1s {westus} +virtualMachines {P1Y, P3Y, P5Y} Standard_B20ms {westus} +virtualMachines {P1Y, P3Y, P5Y} Standard_B2ms {westus} +virtualMachines {P1Y, P3Y, P5Y} Standard_B2s {westus} +virtualMachines {P1Y, P3Y, P5Y} Standard_B4ms {westus} +``` + +This command gets a catlog of reserved resource type skus with location + +### Example 2: Get the list of reserved resource type skus without location +```powershell +Get-AzReservationCatalog -SubscriptionId "10000000-aaaa-bbbb-cccc-100000000001" -ReservedResourceType "SuseLinux" +``` + +```output +ResourceType Terms Name Locations +------------ ----- ---- --------- +SuseLinux {P1Y, P3Y, P5Y} sles_hpc_standard_3-4_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_hpc_standard_1-2_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_hpc_standard_5plus_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_hpc_priority_1-2_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_hpc_priority_5plus_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_hpc_priority_3-4_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_standard_5plus_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_standard_3-4_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_standard_1-2_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_priority_6_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_priority_2-4_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_priority_1_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_priority_8plus_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_sap_priority_5plus_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_sap_priority_1-2_vcpu_vm +SuseLinux {P1Y, P3Y, P5Y} sles_sap_priority_3-4_vcpu_vm +``` + +This command gets a catlog of reserved resource type skus without location + +### Example 3: Get the list of eligible 3pp reserved resource type skus with publisher id, offer id, plan id +```powershell +Get-AzReservationCatalog -SubscriptionId "10000000-aaaa-bbbb-cccc-100000000001" -ReservedResourceType "VirtualMachineSoftware" -PublisherId canonical -OfferId 0001-com-ubuntu-pro-xenial -PlanId pro-16_04-lts +``` + +```output +ResourceType Terms Name Locations +------------ ----- ---- --------- +VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.10core +VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.416core +VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.2core +VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.36core +VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.80core +VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.72core +VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.sharedcore +VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.20core +VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.40core +VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.48core +VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.4core +``` + +This command gets a catlog of eligible 3pp reserved resource type skus with publisher id, offer id, plan id + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +May be used to filter by Catalog properties. +The filter supports 'eq', 'or', and 'and'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Filters the skus based on the location specified in this parameter. +This can be an Azure region or global + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferId +Offer id used to get the third party products + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanId +Plan id used to get the third party products + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublisherId +Publisher id used to get the third party products + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservedResourceType +The type of the resource for which the skus should be provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +The number of reservations to skip from the list before returning results + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Id of the subscription + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Take +To number of reservations to return + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.ICatalog + +## 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 <IReservationsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ReservationId <String>]`: Id of the reservation item + - `[ReservationOrderId <String>]`: Order Id of the reservation + - `[SubscriptionId <String>]`: Id of the subscription + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Get-AzReservationHistory.md b/azps-10.1.0/Az.Reservations/Get-AzReservationHistory.md new file mode 100644 index 0000000000..357f60848e --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Get-AzReservationHistory.md @@ -0,0 +1,111 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/get-azreservationhistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservationHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservationHistory.md +--- + +# Get-AzReservationHistory + +## SYNOPSIS +List of all the revisions for the `Reservation`. + +## SYNTAX + +``` +Get-AzReservationHistory -ReservationId <String> -ReservationOrderId <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +List of all the revisions for the `Reservation`. + +## EXAMPLES + +### Example 1: Get the revision of a reservation +```powershell +Get-AzReservationHistory -ReservationId 2ef560a7-f469-4b62-87b7-5312d588ce2a -ReservationOrderId 2b9b9372-24e1-4a07-a354-2078fe347cf9 +``` + +```output +Location ReservationOrderId/ReservationId Sku State BenefitStartTime ExpiryDate LastUpdatedDateTime SkuDescription +-------- -------------------------------- --- ----- ---------------- ---------- ------------------- -------------- +westus 2b9b9372-24e1-4a07-a354-2078fe347cf9/2ef560a7-f469-4b62-87b7-5312d588ce2a/9 Standard_B1ls Succeeded 6/24/2022 10:06:39 PM 6/24/2023 12:00:00 AM 6/24/2022 10:06:43 PM Reserved VM Instance, Standard_B1ls, US West,… +westus 2b9b9372-24e1-4a07-a354-2078fe347cf9/2ef560a7-f469-4b62-87b7-5312d588ce2a/8 Standard_B1ls Succeeded 6/24/2022 10:06:39 PM 6/24/2023 12:00:00 AM 6/24/2022 10:06:43 PM Reserved VM Instance, Standard_B1ls, US West,… +westus 2b9b9372-24e1-4a07-a354-2078fe347cf9/2ef560a7-f469-4b62-87b7-5312d588ce2a/7 Standard_B1ls ConfirmedBilling 6/24/2022 10:06:17 PM Reserved VM Instance, Standard_B1ls, US West,… +westus 2b9b9372-24e1-4a07-a354-2078fe347cf9/2ef560a7-f469-4b62-87b7-5312d588ce2a/6 Standard_B1ls PendingBilling 6/24/2022 10:04:04 PM Reserved VM Instance, Standard_B1ls, US West,… +westus 2b9b9372-24e1-4a07-a354-2078fe347cf9/2ef560a7-f469-4b62-87b7-5312d588ce2a/5 Standard_B1ls ConfirmedCapacity 6/24/2022 10:03:44 PM Reserved VM Instance, Standard_B1ls, US West,… +westus 2b9b9372-24e1-4a07-a354-2078fe347cf9/2ef560a7-f469-4b62-87b7-5312d588ce2a/4 Standard_B1ls PendingCapacity 6/24/2022 10:03:34 PM Reserved VM Instance, Standard_B1ls, US West,… +westus 2b9b9372-24e1-4a07-a354-2078fe347cf9/2ef560a7-f469-4b62-87b7-5312d588ce2a/3 Standard_B1ls Creating 6/24/2022 10:03:17 PM Reserved VM Instance, Standard_B1ls, US West,… +westus 2b9b9372-24e1-4a07-a354-2078fe347cf9/2ef560a7-f469-4b62-87b7-5312d588ce2a/2 Standard_B1ls Creating 6/24/2022 10:03:04 PM Reserved VM Instance, Standard_B1ls, US West,… +westus 2b9b9372-24e1-4a07-a354-2078fe347cf9/2ef560a7-f469-4b62-87b7-5312d588ce2a/1 Standard_B1ls Creating 6/24/2022 10:02:52 PM Reserved VM Instance, Standard_B1ls, US West,… +``` + +Get the revision of a reservation. +Some data might be trucated due to the width of powershell view, appending this to the end of the command to show the truncated data: | ft -Wrap + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationId +Id of the reservation item + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationOrderId +Order Id of the reservation + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IReservationResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Get-AzReservationOrder.md b/azps-10.1.0/Az.Reservations/Get-AzReservationOrder.md new file mode 100644 index 0000000000..fac309d8ba --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Get-AzReservationOrder.md @@ -0,0 +1,160 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/get-azreservationorder +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservationOrder.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservationOrder.md +--- + +# Get-AzReservationOrder + +## SYNOPSIS +Get the details of the `ReservationOrder`. + +## SYNTAX + +### List (Default) +``` +Get-AzReservationOrder [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzReservationOrder -Id <String> [-Expand <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzReservationOrder -InputObject <IReservationsIdentity> [-Expand <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the details of the `ReservationOrder`. + +## EXAMPLES + +### Example 1: Get the list of reservation orders in the current tenant +```powershell +Get-AzReservationOrder +``` + +```output +ReservationOrderId DisplayName Term State Quantity Reservations +------------------ ----------- ---- ----- -------- ------------ +179de21b-90ec-4fe4-9423-f804b856dfee VM_RI_08-20-2021_15-47 P3Y Succeeded 1 {{… +0de8d259-d48v-4db2-8fd9-ae4dd2bd2227 VM_RI_04-19-2021_13-48 P3Y Cancelled 4 {{… +02ffwsb1-4369-4m8s-b118-12efbfddd3fc VM_RI_04-19-2021_12-48 P3Y Succeeded 1 {{… +06629f91-b216-4d6f-80cd-fa91c8ba61b8 VM_RI_04-19-2021_19-48 P3Y Succeeded 1 {{… +``` + +Get the list of reservation orders in the current tenant. +Some data might be trucated due to the width of powershell view, appending this to the end of the command to show the truncated data: | ft -Wrap + +### Example 2: Get the reservation order in the current tenant, given reservation order Id +```powershell +Get-AzReservationOrder -ReservationOrderId 179de21b-90ec-4fe4-9423-f804b856dfee +``` + +```output +ReservationOrderId DisplayName Term State Quantity Reservations +------------------ ----------- ---- ----- -------- ------------ +179ef21b-90ec-4fe4-9423-f794b856dfee VM_RI_08-20-2021_15-47 P3Y Succeeded 1 {{… +``` + +Get the reservation order in the current tenant, given reservation order Id. +Some data might be trucated due to the width of powershell view, appending this to the end of the command to show the truncated data: | ft -Wrap + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +May be used to expand the planInformation. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Order Id of the reservation + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ReservationOrderId, ReservationId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IReservationOrderResponse + +## 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 <IReservationsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ReservationId <String>]`: Id of the reservation item + - `[ReservationOrderId <String>]`: Order Id of the reservation + - `[SubscriptionId <String>]`: Id of the subscription + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Get-AzReservationOrderId.md b/azps-10.1.0/Az.Reservations/Get-AzReservationOrderId.md new file mode 100644 index 0000000000..b16f786917 --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Get-AzReservationOrderId.md @@ -0,0 +1,128 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/get-azreservationorderid +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservationOrderId.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservationOrderId.md +--- + +# Get-AzReservationOrderId + +## SYNOPSIS +Get applicable `Reservation`s that are applied to this subscription or a resource group under this subscription. + +## SYNTAX + +### Get (Default) +``` +Get-AzReservationOrderId [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzReservationOrderId -InputObject <IReservationsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get applicable `Reservation`s that are applied to this subscription or a resource group under this subscription. + +## EXAMPLES + +### Example 1: Get list of applicable ReservationOrder Ids. +```powershell +Get-AzReservationOrderId -SubscriptionId '10000000-aaaa-bbbb-cccc-100000000005' +``` + +```output +Id : /subscriptions/10000000-aaaa-bbbb-cccc-100000000005/providers/microsoft.capacity/AppliedReservations/default +Name : default +ReservationOrderIdNextLink : +ReservationOrderIdValue : {/providers/Microsoft.Capacity/reservationorders/7c6192be-7543-40c3-93e1-3d7f0b15203f, + /providers/Microsoft.Capacity/reservationorders/aa6c95fe-f25b-4f2e-864f-3860ef5d5bd0, + /providers/Microsoft.Capacity/reservationorders/d9e3935c-288e-4ef5-81a0-55201c1a6a67, + /providers/Microsoft.Capacity/reservationorders/b60911ea-d990-4795-818a-b7396abdb13b…} +ResourceGroupName : +Type : Microsoft.Capacity/AppliedReservations +``` + +Get Ids of applicable ReservationOrders that can be applied to this subscription. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Id of the subscription + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IAppliedReservations + +## 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 <IReservationsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ReservationId <String>]`: Id of the reservation item + - `[ReservationOrderId <String>]`: Order Id of the reservation + - `[SubscriptionId <String>]`: Id of the subscription + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Get-AzReservationQuote.md b/azps-10.1.0/Az.Reservations/Get-AzReservationQuote.md new file mode 100644 index 0000000000..d97befa180 --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Get-AzReservationQuote.md @@ -0,0 +1,504 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/get-azreservationquote +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservationQuote.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Get-AzReservationQuote.md +--- + +# Get-AzReservationQuote + +## SYNOPSIS +Calculate price for placing a `ReservationOrder`. + +## SYNTAX + +### CalculateExpanded (Default) +``` +Get-AzReservationQuote [-AppliedScope <String[]>] [-AppliedScopePropertyDisplayName <String>] + [-AppliedScopePropertyManagementGroupId <String>] [-AppliedScopePropertyResourceGroupId <String>] + [-AppliedScopePropertySubscriptionId <String>] [-AppliedScopePropertyTenantId <String>] + [-AppliedScopeType <AppliedScopeType>] [-BillingPlan <ReservationBillingPlan>] [-BillingScopeId <String>] + [-DisplayName <String>] [-InstanceFlexibility <InstanceFlexibility>] [-Location <String>] [-Quantity <Int32>] + [-Renew] [-ReservedResourceType <ReservedResourceType>] [-ReviewDateTime <DateTime>] [-Sku <String>] + [-Term <ReservationTerm>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Calculate +``` +Get-AzReservationQuote -Body <IPurchaseRequest> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Calculate price for placing a `ReservationOrder`. + +## EXAMPLES + +### Example 1: Get reservation price with 'Upfront' billing plan +```powershell +Get-AzReservationQuote -AppliedScopeType 'Shared' -BillingPlan 'Upfront' -billingScopeId '/subscriptions/b0f278e1-1f18-4378-84d7-b44dfa708665' -DisplayName 'yourRIName' -Location 'westus' -Quantity 1 -ReservedResourceType 'VirtualMachines' -Sku 'Standard_b1ls' -Term 'P1Y' +``` + +```output +BillingCurrencyTotal : { + "currencyCode": "GBP", + "amount": 24 + } +GrandTotal : 0 +IsBillingPartnerManaged : +IsTaxIncluded : +NetTotal : 0 +PaymentSchedule : +PricingCurrencyTotal : { + "currencyCode": "GBP", + "amount": 24 + } +ReservationOrderId : 846655fa-d9e7-4fb8-9512-3ab7367352f1 +SkuDescription : Standard_b1ls +SkuTitle : Reserved VM Instance, Standard_B1ls, US West, 1 Year +TaxTotal : 0 +``` + +Get reservation price with 'Upfront' billing plan + +### Example 2: Get reservation price with 'Monthly' billing plan +```powershell +Get-AzReservationQuote -AppliedScopeType 'Shared' -BillingPlan 'Monthly' -billingScopeId '/subscriptions/b0f278e1-1f18-4378-84d7-b44dfa708665' -DisplayName 'yourRIName' -Location 'westus' -Quantity 1 -ReservedResourceType 'VirtualMachines' -Sku 'Standard_b1ls' -Term 'P1Y' +``` + +```output +BillingCurrencyTotal : { + "currencyCode": "GBP", + "amount": 24 + } +GrandTotal : 0 +IsBillingPartnerManaged : +IsTaxIncluded : +NetTotal : 0 +PaymentSchedule : {{ + "dueDate": "2022-07-07", + "pricingCurrencyTotal": { + "currencyCode": "GBP", + "amount": 2 + }, + "billingCurrencyTotal": { + "currencyCode": "GBP", + "amount": 2 + }, + "status": "Scheduled" + }, { + "dueDate": "2022-08-07", + "pricingCurrencyTotal": { + "currencyCode": "GBP", + "amount": 2 + }, + "status": "Scheduled" + }, { + "dueDate": "2022-09-07", + "pricingCurrencyTotal": { + "currencyCode": "GBP", + "amount": 2 + }, + "status": "Scheduled" + }, { + "dueDate": "2022-10-07", + "pricingCurrencyTotal": { + "currencyCode": "GBP", + "amount": 2 + }, + "status": "Scheduled" + }…} +PricingCurrencyTotal : { + "currencyCode": "GBP", + "amount": 24 + } +ReservationOrderId : 23d4106a-8ec0-4709-839f-0e8073459e83 +SkuDescription : Standard_b1ls +SkuTitle : Reserved VM Instance, Standard_B1ls, US West, 1 Year +TaxTotal : 0 +``` + +Get reservation price with 'Monthly' billing plan + +## PARAMETERS + +### -AppliedScope +List of the subscriptions that the benefit will be applied. +Do not specify if AppliedScopeType is Shared. +This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. + +```yaml +Type: System.String[] +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyDisplayName +Display name + +```yaml +Type: System.String +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyManagementGroupId +Fully-qualified identifier of the management group where the benefit must be applied. + +```yaml +Type: System.String +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyResourceGroupId +Fully-qualified identifier of the resource group. + +```yaml +Type: System.String +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertySubscriptionId +Fully-qualified identifier of the subscription. + +```yaml +Type: System.String +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyTenantId +Tenant ID where the savings plan should apply benefit. + +```yaml +Type: System.String +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopeType +Type of the Applied Scope. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Support.AppliedScopeType +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingPlan +Represent the billing plans. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Support.ReservationBillingPlan +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingScopeId +Subscription that will be charged for purchasing reservation or savings plan + +```yaml +Type: System.String +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +The request for reservation purchase +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IPurchaseRequest +Parameter Sets: Calculate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Friendly name of the reservation + +```yaml +Type: System.String +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceFlexibility +Turning this on will apply the reservation discount to other VMs in the same VM size group. +Only specify for VirtualMachines reserved resource type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Support.InstanceFlexibility +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The Azure region where the reserved resource lives. + +```yaml +Type: System.String +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quantity +Quantity of the skus that are part of the reservation. + +```yaml +Type: System.Int32 +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Renew +Setting this to true will automatically purchase a new reservation on the expiration date time. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservedResourceType +The type of the resource that is being reserved. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Support.ReservedResourceType +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReviewDateTime +This is the date-time when the Azure hybrid benefit needs to be reviewed. + +```yaml +Type: System.DateTime +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +. + +```yaml +Type: System.String +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Term +Represent the term of reservation. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Support.ReservationTerm +Parameter Sets: CalculateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IPurchaseRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.ICalculatePriceResponseProperties + +## 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. + + +`BODY <IPurchaseRequest>`: The request for reservation purchase + - `[AppliedScopePropertyDisplayName <String>]`: Display name + - `[AppliedScopePropertyManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId <String>]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the savings plan should apply benefit. + - `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope. + - `[AppliedScopes <String[]>]`: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. + - `[BillingPlan <ReservationBillingPlan?>]`: Represent the billing plans. + - `[BillingScopeId <String>]`: Subscription that will be charged for purchasing reservation or savings plan + - `[DisplayName <String>]`: Friendly name of the reservation + - `[InstanceFlexibility <InstanceFlexibility?>]`: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. + - `[Location <String>]`: The Azure region where the reserved resource lives. + - `[Quantity <Int32?>]`: Quantity of the skus that are part of the reservation. + - `[Renew <Boolean?>]`: Setting this to true will automatically purchase a new reservation on the expiration date time. + - `[ReservedResourceType <ReservedResourceType?>]`: The type of the resource that is being reserved. + - `[ReviewDateTime <DateTime?>]`: This is the date-time when the Azure hybrid benefit needs to be reviewed. + - `[Sku <String>]`: + - `[Term <ReservationTerm?>]`: Represent the term of reservation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Invoke-AzReservationArchiveReservation.md b/azps-10.1.0/Az.Reservations/Invoke-AzReservationArchiveReservation.md new file mode 100644 index 0000000000..8cd2ed94fd --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Invoke-AzReservationArchiveReservation.md @@ -0,0 +1,182 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/invoke-azreservationarchivereservation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Invoke-AzReservationArchiveReservation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Invoke-AzReservationArchiveReservation.md +--- + +# Invoke-AzReservationArchiveReservation + +## SYNOPSIS +Archiving a `Reservation` moves it to `Archived` state. + +## SYNTAX + +### Archive (Default) +``` +Invoke-AzReservationArchiveReservation -ReservationId <String> -ReservationOrderId <String> + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ArchiveViaIdentity +``` +Invoke-AzReservationArchiveReservation -InputObject <IReservationsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Archiving a `Reservation` moves it to `Archived` state. + +## EXAMPLES + +### Example 1: Archive Reservation which is in cancelled/expired/failed state +```powershell +Invoke-AzReservationArchiveReservation -ReservationId "50000000-aaaa-bbbb-cccc-100000000003" -ReservationOrderId "30000000-aaaa-bbbb-cccc-100000000003" +``` + +```output +200 +``` + +Archive Reservation which is in cancelled/expired/failed state + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity +Parameter Sets: ArchiveViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationId +Id of the reservation item + +```yaml +Type: System.String +Parameter Sets: Archive +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationOrderId +Order Id of the reservation + +```yaml +Type: System.String +Parameter Sets: Archive +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IReservationsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ReservationId <String>]`: Id of the reservation item + - `[ReservationOrderId <String>]`: Order Id of the reservation + - `[SubscriptionId <String>]`: Id of the subscription + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Invoke-AzReservationCalculateExchange.md b/azps-10.1.0/Az.Reservations/Invoke-AzReservationCalculateExchange.md new file mode 100644 index 0000000000..d2bed4df2d --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Invoke-AzReservationCalculateExchange.md @@ -0,0 +1,331 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/invoke-azreservationcalculateexchange +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Invoke-AzReservationCalculateExchange.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Invoke-AzReservationCalculateExchange.md +--- + +# Invoke-AzReservationCalculateExchange + +## SYNOPSIS +Calculates price for exchanging `Reservations` if there are no policy errors.\n + +## SYNTAX + +### PostExpanded (Default) +``` +Invoke-AzReservationCalculateExchange [-ReservationsToExchange <IReservationToReturn[]>] + [-ReservationsToPurchase <IPurchaseRequest[]>] [-SavingsPlansToPurchase <ISavingsPlanPurchaseRequest[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Post +``` +Invoke-AzReservationCalculateExchange -Body <ICalculateExchangeRequest> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Calculates price for exchanging `Reservations` if there are no policy errors.\n + +## EXAMPLES + +### Example 1: Calculate reservations exchange +```powershell +$reservationToReturn1 = @{ + Quantity = 1 + ReservationId = "/providers/microsoft.capacity/reservationOrders/85a61229-7b4b-4565-8dee-632280b27370/reservations/4b0a0a3f-83db-429f-9ef3-015b6935f300" +} +$reservationToReturn2 = @{ + Quantity = 1 + ReservationId = "/providers/microsoft.capacity/reservationOrders/9f9d7d79-907e-4405-8764-d54a75f3d887/reservations/4c2008fe-b8cc-4291-b98a-d29792b73b9f" +} +$reservationsToReturn = @($reservationToReturn1, $reservationToReturn2) +$reservationToPurchase1Properties = @{ + AppliedScopeType = "Shared" + BillingPlan = "Upfront" + BillingScopeId = "/subscriptions/3f0487fd-27ca-4f9c-8a23-000770724b1b" + DisplayName = "PSExchange" + Term = "P3Y" + Quantity = 1 + ReservedResourceType = "VirtualMachines" +} +$reservationToPurchase2Properties = @{ + AppliedScopeType = "Shared" + BillingPlan = "Upfront" + BillingScopeId = "/subscriptions/3f0487fd-27ca-4f9c-8a23-000770724b1b" + DisplayName = "PSExchange2" + Quantity = 2 + ReservedResourceType = "VirtualMachines" + Term = "P3Y" +} +$reservationToPurchase1 = @{ + Location = "westeurope" + Sku = "Standard_B20ms" + Properties = $reservationToPurchase1Properties +} +$reservationToPurchase2 = @{ + Location = "westeurope" + Sku = "Standard_B8ms" + Properties = $reservationToPurchase2Properties +} +$reservationsToPurchase = @($reservationToPurchase1, $reservationToPurchase2) + +Invoke-AzReservationCalculateExchange -ReservationsToExchange $reservationsToReturn -ReservationsToPurchase $reservationsToPurchase +``` + +```output +SessionId Status +--------- ------ +8982593c-679e-4d4e-b971-c48b6d824cba Succeeded +``` + +Calculate reservations exchange. +The SessionId in the response is a required input parameter for cmdlet Invoke-AzReservationExchange + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +Calculate exchange request +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.ICalculateExchangeRequest +Parameter Sets: Post +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationsToExchange +List of reservations that are being returned in this exchange. +To construct, see NOTES section for RESERVATIONSTOEXCHANGE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IReservationToReturn[] +Parameter Sets: PostExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationsToPurchase +List of reservations that are being purchased in this exchange. +To construct, see NOTES section for RESERVATIONSTOPURCHASE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IPurchaseRequest[] +Parameter Sets: PostExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SavingsPlansToPurchase +List of savings plans that are being purchased in this exchange. +To construct, see NOTES section for SAVINGSPLANSTOPURCHASE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.ISavingsPlanPurchaseRequest[] +Parameter Sets: PostExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.ICalculateExchangeRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.ICalculateExchangeOperationResultResponse + +## 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. + + +`BODY <ICalculateExchangeRequest>`: Calculate exchange request + - `[ReservationsToExchange <IReservationToReturn[]>]`: List of reservations that are being returned in this exchange. + - `[Quantity <Int32?>]`: Quantity to be returned. Must be greater than zero. + - `[ReservationId <String>]`: Fully qualified identifier of the reservation being returned + - `[ReservationsToPurchase <IPurchaseRequest[]>]`: List of reservations that are being purchased in this exchange. + - `[AppliedScopePropertyDisplayName <String>]`: Display name + - `[AppliedScopePropertyManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId <String>]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the savings plan should apply benefit. + - `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope. + - `[AppliedScopes <String[]>]`: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. + - `[BillingPlan <ReservationBillingPlan?>]`: Represent the billing plans. + - `[BillingScopeId <String>]`: Subscription that will be charged for purchasing reservation or savings plan + - `[DisplayName <String>]`: Friendly name of the reservation + - `[InstanceFlexibility <InstanceFlexibility?>]`: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. + - `[Location <String>]`: The Azure region where the reserved resource lives. + - `[Quantity <Int32?>]`: Quantity of the skus that are part of the reservation. + - `[Renew <Boolean?>]`: Setting this to true will automatically purchase a new reservation on the expiration date time. + - `[ReservedResourceType <ReservedResourceType?>]`: The type of the resource that is being reserved. + - `[ReviewDateTime <DateTime?>]`: This is the date-time when the Azure hybrid benefit needs to be reviewed. + - `[Sku <String>]`: + - `[Term <ReservationTerm?>]`: Represent the term of reservation. + - `[SavingsPlansToPurchase <ISavingsPlanPurchaseRequest[]>]`: List of savings plans that are being purchased in this exchange. + - `[AppliedScopePropertyDisplayName <String>]`: Display name + - `[AppliedScopePropertyManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId <String>]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the savings plan should apply benefit. + - `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope. + - `[BillingPlan <BillingPlan?>]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. + - `[BillingScopeId <String>]`: Subscription that will be charged for purchasing reservation or savings plan + - `[CommitmentAmount <Double?>]`: + - `[CommitmentCurrencyCode <String>]`: The ISO 4217 3-letter currency code for the currency used by this purchase record. + - `[CommitmentGrain <CommitmentGrain?>]`: Commitment grain. + - `[DisplayName <String>]`: Friendly name of the savings plan + - `[SkuName <String>]`: + - `[Term <SavingsPlanTerm?>]`: Represent savings plan term in ISO 8601 format. + +`RESERVATIONSTOEXCHANGE <IReservationToReturn[]>`: List of reservations that are being returned in this exchange. + - `[Quantity <Int32?>]`: Quantity to be returned. Must be greater than zero. + - `[ReservationId <String>]`: Fully qualified identifier of the reservation being returned + +`RESERVATIONSTOPURCHASE <IPurchaseRequest[]>`: List of reservations that are being purchased in this exchange. + - `[AppliedScopePropertyDisplayName <String>]`: Display name + - `[AppliedScopePropertyManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId <String>]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the savings plan should apply benefit. + - `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope. + - `[AppliedScopes <String[]>]`: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. + - `[BillingPlan <ReservationBillingPlan?>]`: Represent the billing plans. + - `[BillingScopeId <String>]`: Subscription that will be charged for purchasing reservation or savings plan + - `[DisplayName <String>]`: Friendly name of the reservation + - `[InstanceFlexibility <InstanceFlexibility?>]`: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. + - `[Location <String>]`: The Azure region where the reserved resource lives. + - `[Quantity <Int32?>]`: Quantity of the skus that are part of the reservation. + - `[Renew <Boolean?>]`: Setting this to true will automatically purchase a new reservation on the expiration date time. + - `[ReservedResourceType <ReservedResourceType?>]`: The type of the resource that is being reserved. + - `[ReviewDateTime <DateTime?>]`: This is the date-time when the Azure hybrid benefit needs to be reviewed. + - `[Sku <String>]`: + - `[Term <ReservationTerm?>]`: Represent the term of reservation. + +`SAVINGSPLANSTOPURCHASE <ISavingsPlanPurchaseRequest[]>`: List of savings plans that are being purchased in this exchange. + - `[AppliedScopePropertyDisplayName <String>]`: Display name + - `[AppliedScopePropertyManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId <String>]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the savings plan should apply benefit. + - `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope. + - `[BillingPlan <BillingPlan?>]`: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. + - `[BillingScopeId <String>]`: Subscription that will be charged for purchasing reservation or savings plan + - `[CommitmentAmount <Double?>]`: + - `[CommitmentCurrencyCode <String>]`: The ISO 4217 3-letter currency code for the currency used by this purchase record. + - `[CommitmentGrain <CommitmentGrain?>]`: Commitment grain. + - `[DisplayName <String>]`: Friendly name of the savings plan + - `[SkuName <String>]`: + - `[Term <SavingsPlanTerm?>]`: Represent savings plan term in ISO 8601 format. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Invoke-AzReservationCalculateRefund.md b/azps-10.1.0/Az.Reservations/Invoke-AzReservationCalculateRefund.md new file mode 100644 index 0000000000..1b500d939e --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Invoke-AzReservationCalculateRefund.md @@ -0,0 +1,292 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/invoke-azreservationcalculaterefund +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Invoke-AzReservationCalculateRefund.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Invoke-AzReservationCalculateRefund.md +--- + +# Invoke-AzReservationCalculateRefund + +## SYNOPSIS +Calculate price for returning `Reservations` if there are no policy errors.\n + +## SYNTAX + +### PostExpanded (Default) +``` +Invoke-AzReservationCalculateRefund -ReservationOrderId <String> [-Id <String>] + [-ReservationToReturnQuantity <Int32>] [-ReservationToReturnReservationId <String>] [-Scope <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Post +``` +Invoke-AzReservationCalculateRefund -ReservationOrderId <String> -Body <ICalculateRefundRequest> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### PostViaIdentity +``` +Invoke-AzReservationCalculateRefund -InputObject <IReservationsIdentity> -Body <ICalculateRefundRequest> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### PostViaIdentityExpanded +``` +Invoke-AzReservationCalculateRefund -InputObject <IReservationsIdentity> [-Id <String>] + [-ReservationToReturnQuantity <Int32>] [-ReservationToReturnReservationId <String>] [-Scope <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Calculate price for returning `Reservations` if there are no policy errors.\n + +## EXAMPLES + +### Example 1: Calculate price for returning reservations +```powershell +$orderId = "50000000-aaaa-bbbb-cccc-100000000003" +$fullyQualifiedId = "/providers/microsoft.capacity/reservationOrders/50000000-aaaa-bbbb-cccc-100000000003/reservations/30000000-aaaa-bbbb-cccc-100000000003" +$fullyQualifiedOrderId = "/providers/microsoft.capacity/reservationOrders/50000000-aaaa-bbbb-cccc-100000000003" + +Invoke-AzReservationCalculateRefund -ReservationOrderId $orderId -ReservationToReturnQuantity 1 -ReservationToReturnReservationId $fullyQualifiedId -Id $fullyQualifiedOrderId -Scope "Reservation" +``` + +```output +BillingInformationBillingCurrencyProratedAmount : { + "currencyCode": "USD", + "amount": 25.05 + } +BillingInformationBillingCurrencyRemainingCommitmentAmount : { + "currencyCode": "USD", + "amount": 18.06 + } +BillingInformationBillingCurrencyTotalPaidAmount : { + "currencyCode": "USD", + "amount": 25.8 + } +BillingInformationBillingPlan : Monthly +BillingInformationCompletedTransaction : 5 +BillingInformationTotalTransaction : 12 +BillingRefundAmount : { + "currencyCode": "USD", + "amount": 0.75 + } +ConsumedRefundsTotal : { + "currencyCode": "USD", + "amount": 365.43 + } +Id : /providers/Microsoft.Capacity/reservationOrders/4336d060-da34-4228-91b0-feab5b2a1e1d/reservations/5e012942-5692-41c0-bc71-86303e11104d +MaxRefundLimit : { + "currencyCode": "USD", + "amount": 50000 + } +PolicyError : {} +PricingRefundAmount : { + "currencyCode": "USD", + "amount": 0.75 + } +Quantity : 1 +ResourceGroupName : +SessionId : b0a96155-5f75-4138-b01f-443130f5516e +``` + +Calculate reservations refund amount. +The SessionId in the response is a required input parameter for cmdlet Invoke-AzReservationReturn + +## PARAMETERS + +### -Body +Request containing information needed for calculating refund. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.ICalculateRefundRequest +Parameter Sets: Post, PostViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Fully qualified identifier of the reservation order being returned + +```yaml +Type: System.String +Parameter Sets: PostExpanded, PostViaIdentityExpanded +Aliases: ReservationId + +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.Reservations.Models.IReservationsIdentity +Parameter Sets: PostViaIdentity, PostViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReservationOrderId +Order Id of the reservation + +```yaml +Type: System.String +Parameter Sets: Post, PostExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationToReturnQuantity +Quantity to be returned. +Must be greater than zero. + +```yaml +Type: System.Int32 +Parameter Sets: PostExpanded, PostViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationToReturnReservationId +Fully qualified identifier of the reservation being returned + +```yaml +Type: System.String +Parameter Sets: PostExpanded, PostViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the refund, e.g. +Reservation + +```yaml +Type: System.String +Parameter Sets: PostExpanded, PostViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.ICalculateRefundRequest + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.ICalculateRefundResponse + +## 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. + + +`BODY <ICalculateRefundRequest>`: Request containing information needed for calculating refund. + - `[Id <String>]`: Fully qualified identifier of the reservation order being returned + - `[ReservationToReturnQuantity <Int32?>]`: Quantity to be returned. Must be greater than zero. + - `[ReservationToReturnReservationId <String>]`: Fully qualified identifier of the reservation being returned + - `[Scope <String>]`: The scope of the refund, e.g. Reservation + +`INPUTOBJECT <IReservationsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ReservationId <String>]`: Id of the reservation item + - `[ReservationOrderId <String>]`: Order Id of the reservation + - `[SubscriptionId <String>]`: Id of the subscription + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Invoke-AzReservationExchange.md b/azps-10.1.0/Az.Reservations/Invoke-AzReservationExchange.md new file mode 100644 index 0000000000..92c8474dc9 --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Invoke-AzReservationExchange.md @@ -0,0 +1,182 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/invoke-azreservationexchange +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Invoke-AzReservationExchange.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Invoke-AzReservationExchange.md +--- + +# Invoke-AzReservationExchange + +## SYNOPSIS +Returns one or more `Reservations` in exchange for one or more `Reservation` purchases.\n + +## SYNTAX + +### PostExpanded (Default) +``` +Invoke-AzReservationExchange [-SessionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### Post +``` +Invoke-AzReservationExchange -Body <IExchangeRequest> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Returns one or more `Reservations` in exchange for one or more `Reservation` purchases.\n + +## EXAMPLES + +### Example 1: Proceed reservations exchange with session ID obtained from Invoke-AzReservationCalculateExchange +```powershell +Invoke-AzReservationExchange -SessionId 8982593c-679e-4d4e-b971-c48b6d824cba +``` + +```output +SessionId Status +--------- ------ +8982593c-679e-4d4e-b971-c48b6d824cba Succeeded +``` + +Proceed reservations exchange with session ID obtained from Invoke-AzReservationCalculateExchange. +This is a long running POST operation which can take around 10ish mins. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +Exchange request +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IExchangeRequest +Parameter Sets: Post +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionId +SessionId that was returned by CalculateExchange API. + +```yaml +Type: System.String +Parameter Sets: PostExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IExchangeRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IExchangeOperationResultResponse + +## 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. + + +`BODY <IExchangeRequest>`: Exchange request + - `[SessionId <String>]`: SessionId that was returned by CalculateExchange API. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Invoke-AzReservationReturn.md b/azps-10.1.0/Az.Reservations/Invoke-AzReservationReturn.md new file mode 100644 index 0000000000..59e9532b2e --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Invoke-AzReservationReturn.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/invoke-azreservationreturn +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Invoke-AzReservationReturn.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Invoke-AzReservationReturn.md +--- + +# Invoke-AzReservationReturn + +## SYNOPSIS +Return a Reservation. + +## SYNTAX + +### PostExpanded (Default) +``` +Invoke-AzReservationReturn -ReservationOrderId <String> -ReservationToReturnQuantity <Int32> + -ReservationToReturnReservationId <String> -ReturnReason <String> -Scope <String> -SessionId <String> + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Post +``` +Invoke-AzReservationReturn -Body <IRefundRequest> -ReservationOrderId <String> [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### PostViaIdentity +``` +Invoke-AzReservationReturn -InputObject <IReservationsIdentity> -Body <IRefundRequest> [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### PostViaIdentityExpanded +``` +Invoke-AzReservationReturn -InputObject <IReservationsIdentity> -ReservationToReturnQuantity <Int32> + -ReservationToReturnReservationId <String> -ReturnReason <String> -Scope <String> -SessionId <String> + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Return a Reservation. + +## EXAMPLES + +### Example 1: Return a reservation using the session ID obtained from calculateRefund command. +```powershell +$orderId = "50000000-aaaa-bbbb-cccc-100000000003" +$fullyQualifiedId = "/providers/microsoft.capacity/reservationOrders/50000000-aaaa-bbbb-cccc-100000000003/reservations/30000000-aaaa-bbbb-cccc-100000000003" +$fullyQualifiedOrderId = "/providers/microsoft.capacity/reservationOrders/50000000-aaaa-bbbb-cccc-100000000003" + +Invoke-AzReservationCalculateRefund -ReservationOrderId $orderId -ReservationToReturnQuantity 1 -ReservationToReturnReservationId $fullyQualifiedId -Id $fullyQualifiedOrderId -Scope "Reservation" +``` + +```output +ReservationOrderId DisplayName Term State Quantity Reservations +------------------ ----------- ---- ----- -------- ------------ +179ef21b-90ec-4fe4-9423-f794b856dfee VM_RI_08-20-2021_15-47 P3Y Succeeded 1 {{… +``` + +Proceed reservations return with session ID obtained from Invoke-AzReservationCalculateRefund. + +## PARAMETERS + +### -Body +The return request body. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IRefundRequest +Parameter Sets: Post, PostViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity +Parameter Sets: PostViaIdentity, PostViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReservationOrderId +Reservation Order Id. + +```yaml +Type: System.String +Parameter Sets: Post, PostExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationToReturnQuantity +Quantity to return. + +```yaml +Type: System.Int32 +Parameter Sets: PostExpanded, PostViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationToReturnReservationId +Reservation Id to return. + +```yaml +Type: System.String +Parameter Sets: PostExpanded, PostViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReturnReason +The reason for this reservation return. + +```yaml +Type: System.String +Parameter Sets: PostExpanded, PostViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of this return, e.g. +Reservation. + +```yaml +Type: System.String +Parameter Sets: PostExpanded, PostViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionId +The session id obtained from Invoke-AzReservationCalculateRefund.. + +```yaml +Type: System.String +Parameter Sets: PostExpanded, PostViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IReservationOrderResponse + +## 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. + + +`BODY <IRefundRequest>`: The return request body. + - `[ReservationToReturnQuantity <Int32?>]`: Quantity to be returned. Must be greater than zero. + - `[ReservationToReturnReservationId <String>]`: Fully qualified identifier of the reservation being returned + - `[ReturnReason <String>]`: The reason of returning the reservation + - `[Scope <String>]`: The scope of the refund, e.g. Reservation + - `[SessionId <String>]`: SessionId that was returned by CalculateRefund API. + +`INPUTOBJECT <IReservationsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ReservationId <String>]`: Id of the reservation item + - `[ReservationOrderId <String>]`: Order Id of the reservation + - `[SubscriptionId <String>]`: Id of the subscription + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Invoke-AzReservationUnarchiveReservation.md b/azps-10.1.0/Az.Reservations/Invoke-AzReservationUnarchiveReservation.md new file mode 100644 index 0000000000..2d783fbed8 --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Invoke-AzReservationUnarchiveReservation.md @@ -0,0 +1,182 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/invoke-azreservationunarchivereservation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Invoke-AzReservationUnarchiveReservation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Invoke-AzReservationUnarchiveReservation.md +--- + +# Invoke-AzReservationUnarchiveReservation + +## SYNOPSIS +Restores a `Reservation` to the state it was before archiving.\n + +## SYNTAX + +### Unarchive (Default) +``` +Invoke-AzReservationUnarchiveReservation -ReservationId <String> -ReservationOrderId <String> + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UnarchiveViaIdentity +``` +Invoke-AzReservationUnarchiveReservation -InputObject <IReservationsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Restores a `Reservation` to the state it was before archiving.\n + +## EXAMPLES + +### Example 1: Unarchive Reservation which is in cancelled/expired/failed state +```powershell +Invoke-AzReservationUnarchiveReservation -ReservationId "50000000-aaaa-bbbb-cccc-100000000003" -ReservationOrderId "30000000-aaaa-bbbb-cccc-100000000003" +``` + +```output +200 +``` + +Unarchive Reservation which is in cancelled/expired/failed state + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity +Parameter Sets: UnarchiveViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationId +Id of the reservation item + +```yaml +Type: System.String +Parameter Sets: Unarchive +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationOrderId +Order Id of the reservation + +```yaml +Type: System.String +Parameter Sets: Unarchive +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IReservationsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ReservationId <String>]`: Id of the reservation item + - `[ReservationOrderId <String>]`: Order Id of the reservation + - `[SubscriptionId <String>]`: Id of the subscription + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Merge-AzReservation.md b/azps-10.1.0/Az.Reservations/Merge-AzReservation.md new file mode 100644 index 0000000000..326f230ffd --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Merge-AzReservation.md @@ -0,0 +1,137 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/merge-azreservation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Merge-AzReservation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Merge-AzReservation.md +--- + +# Merge-AzReservation + +## SYNOPSIS +Merge two reservations into one reservation within the same reservation order. + +## SYNTAX + +``` +Merge-AzReservation -OrderId <String> -ReservationId <String[]> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Merge two reservations into one reservation within the same reservation order. + +## EXAMPLES + +### Example 1: Merge two reservations into one single reservation +```powershell +$arr=@("72bc398d-b201-4a2e-a1fa-60fb48a85b23", "34f2474f-b4d7-41ec-a96d-d4bb7c2f85b6") +Merge-AzReservation -ReservationOrderId "79ebddac-4030-4296-ab93-1ad90f032058" -ReservationId $arr +``` + +```output +Location ReservationOrderId/ReservationId Sku State BenefitStartTime ExpiryDate LastUpdatedDateTime SkuDescription +-------- -------------------------------- --- ----- ---------------- ---------- ------------------- -------------- +westeurope 79ebddac-4030-4296-ab93-1ad90f032058/72bc398d-b201-4a2e-a1fa-60fb48a85b23/5 Standard_B1ls Cancelled 7/5/2022 1:24:21 AM 7/5/2025 12:00:00 AM 7/8/2022 1:09:29 AM Reserved VM Instan… +westeurope 79ebddac-4030-4296-ab93-1ad90f032058/34f2474f-b4d7-41ec-a96d-d4bb7c2f85b6/4 Standard_B1ls Cancelled 7/5/2022 1:24:21 AM 7/5/2025 12:00:00 AM 7/8/2022 1:09:29 AM Reserved VM Instan… +westeurope 79ebddac-4030-4296-ab93-1ad90f032058/5a91b7d0-9276-4bc9-adae-2a3f5c2ee076/2 Standard_B1ls Succeeded 7/5/2022 1:24:21 AM 7/5/2025 12:00:00 AM 7/8/2022 1:09:29 AM Reserved VM Instan… +``` + +Merge two reservations into one single reservation. +The two reservations must have the same reservation order id. +ReservationId can be either GUID form or fully qulified reservation id form "providers/Microsoft.Capacity/reservationOrders/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/reservations/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderId +Reservation Order Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ReservationOrderId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationId +Reservation Ids. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IReservationResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Move-AzReservationDirectory.md b/azps-10.1.0/Az.Reservations/Move-AzReservationDirectory.md new file mode 100644 index 0000000000..f9518fa8e8 --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Move-AzReservationDirectory.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/move-azreservationdirectory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Move-AzReservationDirectory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Move-AzReservationDirectory.md +--- + +# Move-AzReservationDirectory + +## SYNOPSIS +Change directory (tenant) of `ReservationOrder` and all `Reservation` under it to specified tenant id + +## SYNTAX + +### ChangeExpanded (Default) +``` +Move-AzReservationDirectory -ReservationOrderId <String> [-DestinationTenantId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Change +``` +Move-AzReservationDirectory -ReservationOrderId <String> -Body <IChangeDirectoryRequest> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ChangeViaIdentity +``` +Move-AzReservationDirectory -InputObject <IReservationsIdentity> -Body <IChangeDirectoryRequest> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ChangeViaIdentityExpanded +``` +Move-AzReservationDirectory -InputObject <IReservationsIdentity> [-DestinationTenantId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Change directory (tenant) of `ReservationOrder` and all `Reservation` under it to specified tenant id + +## EXAMPLES + +### Example 1: Move reservation order from one tenant to another +```powershell +Move-AzReservationDirectory -ReservationOrderId "7c31a9e8-8490-4002-88cd-3a16b71362a9" -DestinationTenantId "f65fbe9a-14b0-44c6-8c0d-2ef2c4543040" +``` + +```output +Reservation : {{ + "id": "e2ce59da-9753-47f6-8576-2a2fab559409", + "name": "VM_RI_05-26-2022_16-53", + "isSucceeded": true + }, { + "id": "9a852181-9cec-43a4-852e-8cfd0bec11aa", + "name": "VM_RI_05-26-2022_16-53", + "isSucceeded": true + }, { + "id": "6dc205d9-8049-4179-9d60-29eb1d0082b3", + "name": "VM_RI_05-26-2022_16-53", + "isSucceeded": true + }} +ReservationOrderError : +ReservationOrderId : 7c31a9e8-8490-4002-88cd-3a16b71362a9 +ReservationOrderIsSucceeded : True +ReservationOrderName : VM_RI_05-26-2022_16-53 +``` + +Move reservation order from one tenant to another + +## PARAMETERS + +### -Body +Request body for change directory of a reservation. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IChangeDirectoryRequest +Parameter Sets: Change, ChangeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationTenantId +Tenant id GUID that reservation order is to be transferred to + +```yaml +Type: System.String +Parameter Sets: ChangeExpanded, ChangeViaIdentityExpanded +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.Reservations.Models.IReservationsIdentity +Parameter Sets: ChangeViaIdentity, ChangeViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReservationOrderId +Order Id of the reservation + +```yaml +Type: System.String +Parameter Sets: Change, ChangeExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IChangeDirectoryRequest + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IChangeDirectoryResponse + +## 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. + + +`BODY <IChangeDirectoryRequest>`: Request body for change directory of a reservation. + - `[DestinationTenantId <String>]`: Tenant id GUID that reservation order is to be transferred to + +`INPUTOBJECT <IReservationsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ReservationId <String>]`: Id of the reservation item + - `[ReservationOrderId <String>]`: Order Id of the reservation + - `[SubscriptionId <String>]`: Id of the subscription + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/New-AzReservation.md b/azps-10.1.0/Az.Reservations/New-AzReservation.md new file mode 100644 index 0000000000..66f8c239aa --- /dev/null +++ b/azps-10.1.0/Az.Reservations/New-AzReservation.md @@ -0,0 +1,522 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/new-azreservation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/New-AzReservation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/New-AzReservation.md +--- + +# New-AzReservation + +## SYNOPSIS +Purchase `ReservationOrder` and create resource under the specified URI. + +## SYNTAX + +### PurchaseExpanded (Default) +``` +New-AzReservation -ReservationOrderId <String> [-AppliedScope <String[]>] + [-AppliedScopePropertyDisplayName <String>] [-AppliedScopePropertyManagementGroupId <String>] + [-AppliedScopePropertyResourceGroupId <String>] [-AppliedScopePropertySubscriptionId <String>] + [-AppliedScopePropertyTenantId <String>] [-AppliedScopeType <AppliedScopeType>] + [-BillingPlan <ReservationBillingPlan>] [-BillingScopeId <String>] [-DisplayName <String>] + [-InstanceFlexibility <InstanceFlexibility>] [-Location <String>] [-Quantity <Int32>] [-Renew] + [-ReservedResourceType <ReservedResourceType>] [-ReviewDateTime <DateTime>] [-Sku <String>] + [-Term <ReservationTerm>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Purchase +``` +New-AzReservation -ReservationOrderId <String> -Body <IPurchaseRequest> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### PurchaseViaIdentity +``` +New-AzReservation -InputObject <IReservationsIdentity> -Body <IPurchaseRequest> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### PurchaseViaIdentityExpanded +``` +New-AzReservation -InputObject <IReservationsIdentity> [-AppliedScope <String[]>] + [-AppliedScopePropertyDisplayName <String>] [-AppliedScopePropertyManagementGroupId <String>] + [-AppliedScopePropertyResourceGroupId <String>] [-AppliedScopePropertySubscriptionId <String>] + [-AppliedScopePropertyTenantId <String>] [-AppliedScopeType <AppliedScopeType>] + [-BillingPlan <ReservationBillingPlan>] [-BillingScopeId <String>] [-DisplayName <String>] + [-InstanceFlexibility <InstanceFlexibility>] [-Location <String>] [-Quantity <Int32>] [-Renew] + [-ReservedResourceType <ReservedResourceType>] [-ReviewDateTime <DateTime>] [-Sku <String>] + [-Term <ReservationTerm>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Purchase `ReservationOrder` and create resource under the specified URI. + +## EXAMPLES + +### Example 1: Create a new reservation +```powershell +New-AzReservation -AppliedScopeType 'Shared' -BillingPlan 'Upfront' -billingScopeId '/subscriptions/b0f278e1-1f18-4378-84d7-b44dfa708665' -DisplayName 'TestVm2222' -Location 'westus' -Quantity 1 -ReservedResourceType 'VirtualMachines' -Sku 'Standard_b1ls' -Term 'P1Y' -ReservationOrderId '846655fa-d9e7-4fb8-9512-3ab7367352f1' +``` + +```output +ReservationOrderId DisplayName Term State Quantity +------------------ ----------- ---- ----- -------- +846655fa-d9e7-4fb8-9512-3ab7367352f1 TestVm2222 P1Y Succeeded 1 +``` + +Proceed reservations purchase with reservation order ID obtained from Get-AzReservationQuote. +This is a long running POST operation which can take around 10ish mins. + +## PARAMETERS + +### -AppliedScope +List of the subscriptions that the benefit will be applied. +Do not specify if AppliedScopeType is Shared. +This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. + +```yaml +Type: System.String[] +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyDisplayName +Display name + +```yaml +Type: System.String +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyManagementGroupId +Fully-qualified identifier of the management group where the benefit must be applied. + +```yaml +Type: System.String +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyResourceGroupId +Fully-qualified identifier of the resource group. + +```yaml +Type: System.String +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertySubscriptionId +Fully-qualified identifier of the subscription. + +```yaml +Type: System.String +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyTenantId +Tenant ID where the savings plan should apply benefit. + +```yaml +Type: System.String +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopeType +Type of the Applied Scope. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Support.AppliedScopeType +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingPlan +Represent the billing plans. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Support.ReservationBillingPlan +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingScopeId +Subscription that will be charged for purchasing reservation or savings plan + +```yaml +Type: System.String +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +The request for reservation purchase +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IPurchaseRequest +Parameter Sets: Purchase, PurchaseViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Friendly name of the reservation + +```yaml +Type: System.String +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +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.Reservations.Models.IReservationsIdentity +Parameter Sets: PurchaseViaIdentity, PurchaseViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceFlexibility +Turning this on will apply the reservation discount to other VMs in the same VM size group. +Only specify for VirtualMachines reserved resource type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Support.InstanceFlexibility +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The Azure region where the reserved resource lives. + +```yaml +Type: System.String +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quantity +Quantity of the skus that are part of the reservation. + +```yaml +Type: System.Int32 +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Renew +Setting this to true will automatically purchase a new reservation on the expiration date time. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationOrderId +Order Id of the reservation + +```yaml +Type: System.String +Parameter Sets: Purchase, PurchaseExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservedResourceType +The type of the resource that is being reserved. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Support.ReservedResourceType +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReviewDateTime +This is the date-time when the Azure hybrid benefit needs to be reviewed. + +```yaml +Type: System.DateTime +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +. + +```yaml +Type: System.String +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Term +Represent the term of reservation. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Support.ReservationTerm +Parameter Sets: PurchaseExpanded, PurchaseViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IPurchaseRequest + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IReservationOrderResponse + +## 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. + + +`BODY <IPurchaseRequest>`: The request for reservation purchase + - `[AppliedScopePropertyDisplayName <String>]`: Display name + - `[AppliedScopePropertyManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId <String>]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the savings plan should apply benefit. + - `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope. + - `[AppliedScopes <String[]>]`: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. + - `[BillingPlan <ReservationBillingPlan?>]`: Represent the billing plans. + - `[BillingScopeId <String>]`: Subscription that will be charged for purchasing reservation or savings plan + - `[DisplayName <String>]`: Friendly name of the reservation + - `[InstanceFlexibility <InstanceFlexibility?>]`: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. + - `[Location <String>]`: The Azure region where the reserved resource lives. + - `[Quantity <Int32?>]`: Quantity of the skus that are part of the reservation. + - `[Renew <Boolean?>]`: Setting this to true will automatically purchase a new reservation on the expiration date time. + - `[ReservedResourceType <ReservedResourceType?>]`: The type of the resource that is being reserved. + - `[ReviewDateTime <DateTime?>]`: This is the date-time when the Azure hybrid benefit needs to be reviewed. + - `[Sku <String>]`: + - `[Term <ReservationTerm?>]`: Represent the term of reservation. + +`INPUTOBJECT <IReservationsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ReservationId <String>]`: Id of the reservation item + - `[ReservationOrderId <String>]`: Order Id of the reservation + - `[SubscriptionId <String>]`: Id of the subscription + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Split-AzReservation.md b/azps-10.1.0/Az.Reservations/Split-AzReservation.md new file mode 100644 index 0000000000..ed17b43af7 --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Split-AzReservation.md @@ -0,0 +1,152 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/split-azreservation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Split-AzReservation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Split-AzReservation.md +--- + +# Split-AzReservation + +## SYNOPSIS +Split a Reservation order. + +## SYNTAX + +``` +Split-AzReservation -OrderId <String> -Quantity <Int32[]> -ReservationId <String> [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Split a Reservation order. + +## EXAMPLES + +### Example 1: Split one reservation order into two reservations +```powershell +Split-AzReservation -ReservationOrderId "c615c897-aaaa-4123-8527-c42cc0da41e0" -ReservationId "1bdfaf4a-159d-46ec-be3a-f4aa527d423c" -Quantity @(2,8) + +``` + +```output +Location ReservationOrderId/ReservationId Sku State BenefitStartTime ExpiryDate LastUpdatedDateTime SkuDescription +-------- -------------------------------- --- ----- ---------------- ---------- ------------------- -------------- +westeurope c615c897-aaaa-4123-8527-c42cc0da41e0/f4f0f24c-30d4-4f5d-823c-4a9e1e18b381/2 Standard_B1ls Succeeded 7/7/2022 10:55:12 PM 7/7/2025 12:00:00 AM 7/7/2022 11:21:51 PM Reserved VM Ins… +westeurope c615c897-aaaa-4123-8527-c42cc0da41e0/85cd4ee6-654e-47df-b230-7fb2f1e86714/2 Standard_B1ls Succeeded 7/7/2022 10:55:12 PM 7/7/2025 12:00:00 AM 7/7/2022 11:21:51 PM Reserved VM Ins… +westeurope c615c897-aaaa-4123-8527-c42cc0da41e0/1bdfaf4a-159d-46ec-be3a-f4aa527d423c/12 Standard_B1ls Cancelled 7/7/2022 10:55:12 PM 7/7/2025 12:00:00 AM 7/7/2022 11:21:51 PM Reserved VM Ins… +``` + +Split one reservation order into two reservations, given the quantity of each reservation. +The quantity sum up should be equal to the original reservation before splitting. +ReservationId can be either GUID form or fully qulified reservation id form "providers/Microsoft.Capacity/reservationOrders/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/reservations/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderId +Reservation Order Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ReservationOrderId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quantity +Quantity. + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationId +Reservation Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IReservationResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Reservations/Update-AzReservation.md b/azps-10.1.0/Az.Reservations/Update-AzReservation.md new file mode 100644 index 0000000000..7c3599975b --- /dev/null +++ b/azps-10.1.0/Az.Reservations/Update-AzReservation.md @@ -0,0 +1,497 @@ +--- +external help file: +Module Name: Az.Reservations +online version: https://learn.microsoft.com/powershell/module/az.reservations/update-azreservation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Update-AzReservation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Reservations/help/Update-AzReservation.md +--- + +# Update-AzReservation + +## SYNOPSIS +Updates the applied scopes of the `Reservation`. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzReservation -Id <String> -OrderId <String> [-AppliedScope <String[]>] + [-AppliedScopePropertyDisplayName <String>] [-AppliedScopePropertyManagementGroupId <String>] + [-AppliedScopePropertyResourceGroupId <String>] [-AppliedScopePropertySubscriptionId <String>] + [-AppliedScopePropertyTenantId <String>] [-AppliedScopeType <AppliedScopeType>] + [-InstanceFlexibility <InstanceFlexibility>] [-Name <String>] [-Renew] + [-RenewProperty <IPatchPropertiesRenewProperties>] [-ReviewDateTime <DateTime>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Update +``` +Update-AzReservation -Id <String> -OrderId <String> -Reservation <IPatch> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzReservation -InputObject <IReservationsIdentity> -Reservation <IPatch> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzReservation -InputObject <IReservationsIdentity> [-AppliedScope <String[]>] + [-AppliedScopePropertyDisplayName <String>] [-AppliedScopePropertyManagementGroupId <String>] + [-AppliedScopePropertyResourceGroupId <String>] [-AppliedScopePropertySubscriptionId <String>] + [-AppliedScopePropertyTenantId <String>] [-AppliedScopeType <AppliedScopeType>] + [-InstanceFlexibility <InstanceFlexibility>] [-Name <String>] [-Renew] + [-RenewProperty <IPatchPropertiesRenewProperties>] [-ReviewDateTime <DateTime>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the applied scopes of the `Reservation`. + +## EXAMPLES + +### Example 1: Update Reservation's properties +```powershell +Update-AzReservation -ReservationOrderId "30000000-aaaa-bbbb-cccc-200000000013" -ReservationId "10000000-aaaa-bbbb-cccc-200000000007" -Name "testName" +``` + +```output +Location ReservationOrderId/ReservationId Sku State BenefitStartTime ExpiryDate LastUpdatedDateTime SkuDescription +-------- -------------------------------- --- ----- ---------------- ---------- ------------------- -------------- +westeurope 30000000-aaaa-bbbb-cccc-200000000013/10000000-aaaa-bbbb-cccc-200000000007/16 Standard_B4ms Succeeded 6/14/2022 9:41:17 PM 6/14/2025 12:00:00 AM 7/7/2022 11:37:58 PM Reserved VM In… +``` + +Update Reservation's properties including name, renew, appliedScopeType, appliedScope + +### Example 2: Update Reservation's AppliedScopeType +```powershell +# Shared scope: +Update-AzReservation -ReservationOrderId "30000000-aaaa-bbbb-cccc-200000000013" -ReservationId "10000000-aaaa-bbbb-cccc-200000000007" -AppliedScopeType "Shared" + +# Single scope: +Update-AzReservation -ReservationOrderId "30000000-aaaa-bbbb-cccc-200000000013" -ReservationId "10000000-aaaa-bbbb-cccc-200000000007" -AppliedScopeType "Single" -AppliedScope "/subscriptions/30000000-aaaa-bbbb-cccc-200000000018" + +# Single scope with resource group: +Update-AzReservation -ReservationOrderId "30000000-aaaa-bbbb-cccc-200000000013" -ReservationId "10000000-aaaa-bbbb-cccc-200000000007" -AppliedScopeType "Single" -AppliedScope "/subscriptions/30000000-aaaa-bbbb-cccc-200000000018/resourcegroups/{your resource group name}" +``` + +```output +Similar to example 1 +``` + +Update Reservation's applied scope type. +For Shared scope, don't pass in any applied scope id. +For Single scope, pass in applied scope id and for Single scope with resource group, also pass in resource group name in the applied scope id + +## PARAMETERS + +### -AppliedScope +List of the subscriptions that the benefit will be applied. +Do not specify if AppliedScopeType is Shared. +This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyDisplayName +Display name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyManagementGroupId +Fully-qualified identifier of the management group where the benefit must be applied. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyResourceGroupId +Fully-qualified identifier of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertySubscriptionId +Fully-qualified identifier of the subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopePropertyTenantId +Tenant ID where the savings plan should apply benefit. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppliedScopeType +Type of the Applied Scope. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Support.AppliedScopeType +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of the reservation item + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: ReservationId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceFlexibility +Turning this on will apply the reservation discount to other VMs in the same VM size group. +Only specify for VirtualMachines reserved resource type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Support.InstanceFlexibility +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Display name of the reservation + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderId +Order Id of the reservation + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: ReservationOrderId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Renew +Setting this to true will automatically purchase a new reservation on the expiration date time. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RenewProperty +. +To construct, see NOTES section for RENEWPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IPatchPropertiesRenewProperties +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reservation +The request for reservation patch +To construct, see NOTES section for RESERVATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IPatch +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReviewDateTime +This is the date-time when the Azure hybrid benefit needs to be reviewed. + +```yaml +Type: System.DateTime +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IPatch + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.Api20221101.IReservationResponse + +## 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 <IReservationsIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ReservationId <String>]`: Id of the reservation item + - `[ReservationOrderId <String>]`: Order Id of the reservation + - `[SubscriptionId <String>]`: Id of the subscription + +`RENEWPROPERTY <IPatchPropertiesRenewProperties>`: . + - `[PurchaseProperty <IPurchaseRequest>]`: The request for reservation purchase + - `[AppliedScopePropertyDisplayName <String>]`: Display name + - `[AppliedScopePropertyManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId <String>]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the savings plan should apply benefit. + - `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope. + - `[AppliedScopes <String[]>]`: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. + - `[BillingPlan <ReservationBillingPlan?>]`: Represent the billing plans. + - `[BillingScopeId <String>]`: Subscription that will be charged for purchasing reservation or savings plan + - `[DisplayName <String>]`: Friendly name of the reservation + - `[InstanceFlexibility <InstanceFlexibility?>]`: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. + - `[Location <String>]`: The Azure region where the reserved resource lives. + - `[Quantity <Int32?>]`: Quantity of the skus that are part of the reservation. + - `[Renew <Boolean?>]`: Setting this to true will automatically purchase a new reservation on the expiration date time. + - `[ReservedResourceType <ReservedResourceType?>]`: The type of the resource that is being reserved. + - `[ReviewDateTime <DateTime?>]`: This is the date-time when the Azure hybrid benefit needs to be reviewed. + - `[Sku <String>]`: + - `[Term <ReservationTerm?>]`: Represent the term of reservation. + +`RESERVATION <IPatch>`: The request for reservation patch + - `[AppliedScope <String[]>]`: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. + - `[AppliedScopePropertyDisplayName <String>]`: Display name + - `[AppliedScopePropertyManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId <String>]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the savings plan should apply benefit. + - `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope. + - `[InstanceFlexibility <InstanceFlexibility?>]`: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. + - `[Name <String>]`: Display name of the reservation + - `[Renew <Boolean?>]`: Setting this to true will automatically purchase a new reservation on the expiration date time. + - `[RenewProperty <IPatchPropertiesRenewProperties>]`: + - `[PurchaseProperty <IPurchaseRequest>]`: The request for reservation purchase + - `[AppliedScopePropertyDisplayName <String>]`: Display name + - `[AppliedScopePropertyManagementGroupId <String>]`: Fully-qualified identifier of the management group where the benefit must be applied. + - `[AppliedScopePropertyResourceGroupId <String>]`: Fully-qualified identifier of the resource group. + - `[AppliedScopePropertySubscriptionId <String>]`: Fully-qualified identifier of the subscription. + - `[AppliedScopePropertyTenantId <String>]`: Tenant ID where the savings plan should apply benefit. + - `[AppliedScopeType <AppliedScopeType?>]`: Type of the Applied Scope. + - `[AppliedScopes <String[]>]`: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. + - `[BillingPlan <ReservationBillingPlan?>]`: Represent the billing plans. + - `[BillingScopeId <String>]`: Subscription that will be charged for purchasing reservation or savings plan + - `[DisplayName <String>]`: Friendly name of the reservation + - `[InstanceFlexibility <InstanceFlexibility?>]`: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. + - `[Location <String>]`: The Azure region where the reserved resource lives. + - `[Quantity <Int32?>]`: Quantity of the skus that are part of the reservation. + - `[Renew <Boolean?>]`: Setting this to true will automatically purchase a new reservation on the expiration date time. + - `[ReservedResourceType <ReservedResourceType?>]`: The type of the resource that is being reserved. + - `[ReviewDateTime <DateTime?>]`: This is the date-time when the Azure hybrid benefit needs to be reviewed. + - `[Sku <String>]`: + - `[Term <ReservationTerm?>]`: Represent the term of reservation. + - `[ReviewDateTime <DateTime?>]`: This is the date-time when the Azure hybrid benefit needs to be reviewed. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceGraph/Az.ResourceGraph.md b/azps-10.1.0/Az.ResourceGraph/Az.ResourceGraph.md new file mode 100644 index 0000000000..fb327f5aa8 --- /dev/null +++ b/azps-10.1.0/Az.ResourceGraph/Az.ResourceGraph.md @@ -0,0 +1,30 @@ +--- +Module Name: Az.ResourceGraph +Module Guid: a290eead-f293-4588-b61e-b465b237591e +Download Help Link: https://learn.microsoft.com/powershell/module/az.resourcegraph +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceGraph/ResourceGraph/help/Az.ResourceGraph.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceGraph/ResourceGraph/help/Az.ResourceGraph.md +--- + +# Az.ResourceGraph Module +## Description +Microsoft Azure PowerShell: ResourceGraph cmdlets + +## Az.ResourceGraph Cmdlets +### [Get-AzResourceGraphQuery](Get-AzResourceGraphQuery.md) +Get a single graph query by its resourceName. + +### [New-AzResourceGraphQuery](New-AzResourceGraphQuery.md) +Create a new graph query. + +### [Remove-AzResourceGraphQuery](Remove-AzResourceGraphQuery.md) +Delete a graph query. + +### [Search-AzGraph](Search-AzGraph.md) +Queries the resources managed by Azure Resource Manager. + +### [Update-AzResourceGraphQuery](Update-AzResourceGraphQuery.md) +Updates a graph query that has already been added. + diff --git a/azps-10.1.0/Az.ResourceGraph/Get-AzResourceGraphQuery.md b/azps-10.1.0/Az.ResourceGraph/Get-AzResourceGraphQuery.md new file mode 100644 index 0000000000..abc677fe0c --- /dev/null +++ b/azps-10.1.0/Az.ResourceGraph/Get-AzResourceGraphQuery.md @@ -0,0 +1,185 @@ +--- +external help file: Az.ResourceGraph-help.xml +Module Name: Az.ResourceGraph +online version: https://learn.microsoft.com/powershell/module/az.resourcegraph/get-azresourcegraphquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceGraph/ResourceGraph/help/Get-AzResourceGraphQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceGraph/ResourceGraph/help/Get-AzResourceGraphQuery.md +--- + +# Get-AzResourceGraphQuery + +## SYNOPSIS +Get a single graph query by its resourceName. + +## SYNTAX + +### List (Default) +``` +Get-AzResourceGraphQuery -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzResourceGraphQuery -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzResourceGraphQuery -InputObject <IResourceGraphIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a single graph query by its resourceName. + +## EXAMPLES + +### Example 1: Get all resource graph queries under a resource group +```powershell +Get-AzResourceGraphQuery -ResourceGroupName azure-rg-test +``` + +```output +Location Name Type +-------- ---- ---- + global SharedQuery-t01 microsoft.resourcegraph/queries +``` + +This command gets all resource graph query under a resource group. + +### Example 2: Get a resource graph query by name +```powershell +Get-AzResourceGraphQuery -ResourceGroupName azure-rg-test -Name SharedQuery-t01 +``` + +```output +Location Name Type +-------- ---- ---- +global SharedQuery-t01 microsoft.resourcegraph/queries +``` + +This command gets a resource graph query by name. + +### Example 3: Get a resource graph query by object +```powershell +$query = New-AzResourceGraphQuery -ResourceGroupName azure-rg-test -Name query-t03 -Location 'global' -Query 'project id, name, type, location' -Description 'test' +Get-AzResourceGraphQuery -InputObject $query +``` + +```output +Location Name Type +-------- ---- ---- +global SharedQuery-t01 microsoft.resourcegraph/queries +``` + +This command gets a resource graph query by object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ResourceGraph.Models.IResourceGraphIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Graph Query resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription Id. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceGraph.Models.IResourceGraphIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceGraph.Models.Api20180901Preview.IGraphQueryResource + +## 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 `<IResourceGraphIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[ResourceName <String>]`: The name of the Graph Query resource. + - `[SubscriptionId <String>]`: The Azure subscription Id. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ResourceGraph/New-AzResourceGraphQuery.md b/azps-10.1.0/Az.ResourceGraph/New-AzResourceGraphQuery.md new file mode 100644 index 0000000000..906178b858 --- /dev/null +++ b/azps-10.1.0/Az.ResourceGraph/New-AzResourceGraphQuery.md @@ -0,0 +1,239 @@ +--- +external help file: Az.ResourceGraph-help.xml +Module Name: Az.ResourceGraph +online version: https://learn.microsoft.com/powershell/module/az.resourcegraph/new-azresourcegraphquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceGraph/ResourceGraph/help/New-AzResourceGraphQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceGraph/ResourceGraph/help/New-AzResourceGraphQuery.md +--- + +# New-AzResourceGraphQuery + +## SYNOPSIS +Create a new graph query. + +## SYNTAX + +``` +New-AzResourceGraphQuery -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Description <String>] [-Location <String>] [-Query <String>] [-File <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new graph query. + +## EXAMPLES + +### Example 1: Create a resource graph query by the query parameter +```powershell +New-AzResourceGraphQuery -Name query-t03 -ResourceGroupName azure-rg-test -Location "global" -Description "requesting a subset of resource fields." -Query "project id, name, type, location, tags" +``` + +```output +Location Name Type +-------- ---- ---- +global query-t03 microsoft.resourcegraph/queries +``` + +This command creates a resource graph query by the query parameter. + +### Example 2: Create a resource graph query by the file parameter +```powershell +New-AzResourceGraphQuery -Name query-t04 -ResourceGroupName azure-rg-test -Location "global" -Description "requesting a subset of resource fields." -File 'D:\azure-service\ResourceGraph.Autorest\azure-powershell\src\ResourceGraph\ResourceGraph.Autorest\test\Query.kql' +``` + +```output +Location Name Type +-------- ---- ---- +global query-t04 microsoft.resourcegraph/queries +``` + +This command creates a resource graph query by the file parameter. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of a graph query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +The content of the file will be passed to the query parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Graph Query resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +KQL query that will be graph. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceGraph.Models.Api20180901Preview.IGraphQueryResource + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceGraph.Models.IResourceGraphIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceGraph.Models.Api20180901Preview.IGraphQueryResource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ResourceGraph/Remove-AzResourceGraphQuery.md b/azps-10.1.0/Az.ResourceGraph/Remove-AzResourceGraphQuery.md new file mode 100644 index 0000000000..52421956e4 --- /dev/null +++ b/azps-10.1.0/Az.ResourceGraph/Remove-AzResourceGraphQuery.md @@ -0,0 +1,199 @@ +--- +external help file: Az.ResourceGraph-help.xml +Module Name: Az.ResourceGraph +online version: https://learn.microsoft.com/powershell/module/az.resourcegraph/remove-azresourcegraphquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceGraph/ResourceGraph/help/Remove-AzResourceGraphQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceGraph/ResourceGraph/help/Remove-AzResourceGraphQuery.md +--- + +# Remove-AzResourceGraphQuery + +## SYNOPSIS +Delete a graph query. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzResourceGraphQuery -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzResourceGraphQuery -InputObject <IResourceGraphIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a graph query. + +## EXAMPLES + +### Example 1: Remove a resource graph query by name +```powershell +Remove-AzResourceGraphQuery -ResourceGroupName azure-rg-test -Name query-t03 +``` + +This command removes a resource graph query by name. + +### Example 2: Remove a resource graph query by object +```powershell +$query = Get-AzResourceGraphQuery -ResourceGroupName azure-rg-test -Name query-t02 +Remove-AzResourceGraphQuery -InputObject $query +``` + +This command removes a resource graph query by object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ResourceGraph.Models.IResourceGraphIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Graph Query resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription Id. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceGraph.Models.IResourceGraphIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IResourceGraphIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[ResourceName <String>]`: The name of the Graph Query resource. + - `[SubscriptionId <String>]`: The Azure subscription Id. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ResourceGraph/Search-AzGraph.md b/azps-10.1.0/Az.ResourceGraph/Search-AzGraph.md new file mode 100644 index 0000000000..4802dbea94 --- /dev/null +++ b/azps-10.1.0/Az.ResourceGraph/Search-AzGraph.md @@ -0,0 +1,275 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceGraph.dll-Help.xml +Module Name: Az.ResourceGraph +online version: https://learn.microsoft.com/powershell/module/az.resourcegraph/search-azgraph +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceGraph/ResourceGraph/help/Search-AzGraph.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceGraph/ResourceGraph/help/Search-AzGraph.md +--- + +# Search-AzGraph + +## SYNOPSIS +Queries the resources managed by Azure Resource Manager. + +## SYNTAX + +### SubscriptionScopedQuery (Default) +``` +Search-AzGraph [-Query] <String> [-Subscription <String[]>] [-First <Int32>] [-Skip <Int32>] + [-SkipToken <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ManagementGroupScopedQuery +``` +Search-AzGraph [-Query] <String> -ManagementGroup <String[]> [-AllowPartialScope] [-First <Int32>] + [-Skip <Int32>] [-SkipToken <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### TenantScopedQuery +``` +Search-AzGraph [-Query] <String> [-UseTenantScope] [-AllowPartialScope] [-First <Int32>] [-Skip <Int32>] + [-SkipToken <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Learn more about the query syntax here: https://aka.ms/resource-graph/learntoquery + +## EXAMPLES + +### Example 1 +```powershell +Search-AzGraph "project id, name, type, location, tags" -First 3 +``` + +```output +id : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/Service-INT-a/providers/Microsoft.Compute/virtualMachineScaleSets/nt +name : nt +type : microsoft.compute/virtualmachinescalesets +location : eastus +tags : @{resourceType=Service Fabric; clusterName=gov-art-int-nt-a} +ResourceId : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/Service-INT-a/providers/Microsoft.Compute/virtualMachineScaleSets/nt + +id : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/Service-INT-a/providers/Microsoft.EventGrid/topics/egtopic-1 +name : egtopic-1 +type : microsoft.eventgrid/topics +location : westus2 +tags : +ResourceId : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/Service-INT-a/providers/Microsoft.EventGrid/topics/egtopic-1 +``` + +Simple resources query requesting a subset of resource fields. + +### Example 2 +```powershell +Search-AzGraph "project id, name, type, location | where type =~ 'Microsoft.Compute/virtualMachines' | summarize count() by location | top 3 by count_" +``` + +```output +location count_ +-------- ------ +eastus 66 +westcentralus 32 +westus 26 +``` + +A complex query on resources featuring field selection, filtering and summarizing. + +### Example 3 +```powershell +$response = Search-AzGraph -Query "project id, name, type, location" -First 2 +Search-AzGraph -Query "project id, name, type, location" -SkipToken $response.SkipToken +``` + +```output +id : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/test/providers/Microsoft.Network/networkInterfaces/17ni +name : 17ni +type : microsoft.network/networkinterfaces +location : westeurope +ResourceId : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/test/providers/Microsoft.Network/networkInterfaces/17ni + +id : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/test/providers/Microsoft.Network/networkSecurityGroups/17nsg +name : 17nsg +type : microsoft.network/networksecuritygroups +location : westeurope +ResourceId : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/test/providers/Microsoft.Network/networkSecurityGroups/17nsg +``` + +A query with the skip token passed from the previous query results. Please note that keeping id in the results is mandatory to get back a skip token. + +### Example 4 +```powershell +Search-AzGraph -Query "project id, name, type, location, tags" -First 2 -ManagementGroup MyManagementGroupId -AllowPartialScope +``` + +```output +id : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/Service-INT-a/providers/Microsoft.Compute/virtualMachineScaleSets/nt +name : nt +type : microsoft.compute/virtualmachinescalesets +location : eastus +tags : @{resourceType=Service Fabric; clusterName=gov-art-int-nt-a} +ResourceId : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/Service-INT-a/providers/Microsoft.Compute/virtualMachineScaleSets/nt + +id : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/Service-INT-a/providers/Microsoft.EventGrid/topics/egtopic-1 +name : egtopic-1 +type : microsoft.eventgrid/topics +location : westus2 +tags : +ResourceId : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/Service-INT-a/providers/Microsoft.EventGrid/topics/egtopic-1 +``` + +A query scoped to the management group that allows the query to succeed with partial scope result if MyManagementGroupId has more than N subscriptions underneath. +N is max number of subscriptions that can be processed by server. + +## PARAMETERS + +### -AllowPartialScope +Indicates if query should succeed when only partial number of subscriptions underneath can be processed by server + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ManagementGroupScopedQuery, TenantScopedQuery +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroup +Management group(s) to run query against. + +```yaml +Type: System.String[] +Parameter Sets: ManagementGroupScopedQuery +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Resource Graph query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipToken +The skip token to use for getting the next page of results if applicable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subscription +Subscription(s) to run query against. + +```yaml +Type: System.String[] +Parameter Sets: SubscriptionScopedQuery +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseTenantScope +Run query across all available subscriptions in the current tenant. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: TenantScopedQuery +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Ignores the first N objects and then gets the remaining objects. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +The maximum number of objects to return. Allowed values: 1-1000. +Default value is 100. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceGraph.Models.PSResourceGraphResponse`1[[System.Management.Automation.PSObject]] + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ResourceGraph/Update-AzResourceGraphQuery.md b/azps-10.1.0/Az.ResourceGraph/Update-AzResourceGraphQuery.md new file mode 100644 index 0000000000..843bda8278 --- /dev/null +++ b/azps-10.1.0/Az.ResourceGraph/Update-AzResourceGraphQuery.md @@ -0,0 +1,257 @@ +--- +external help file: Az.ResourceGraph-help.xml +Module Name: Az.ResourceGraph +online version: https://learn.microsoft.com/powershell/module/az.resourcegraph/update-azresourcegraphquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceGraph/ResourceGraph/help/Update-AzResourceGraphQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceGraph/ResourceGraph/help/Update-AzResourceGraphQuery.md +--- + +# Update-AzResourceGraphQuery + +## SYNOPSIS +Updates a graph query that has already been added. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzResourceGraphQuery -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Description <String>] [-Query <String>] [-File <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzResourceGraphQuery -InputObject <IResourceGraphIdentity> [-Description <String>] [-Query <String>] + [-File <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a graph query that has already been added. + +## EXAMPLES + +### Example 1: Update the parameter query and tag by name +```powershell +Update-AzResourceGraphQuery -ResourceGroupName azure-rg-test -Name query-t05 -Query "project id, name, type, location, tags" -Tag @{'key1'=1;'key2'=2} +``` + +```output +Location Name Type +-------- ---- ---- +global query-t05 microsoft.resourcegraph/queries +``` + +This command updates the parameter query and tag by name. + +### Example 2: Update the parameter file by object +```powershell +$query = Get-AzResourceGraphQuery -ResourceGroupName azure-rg-test -Name query-t05 +Update-AzResourceGraphQuery -InputObject $query -File './Query.kql' +``` + +```output +Location Name Type +-------- ---- ---- +global query-t05 microsoft.resourcegraph/queries +``` + +This command updates the parameter query and tag by object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of a graph query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +The content of the file will be passed to the query parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ResourceGraph.Models.IResourceGraphIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Graph Query resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +KQL query that will be graph. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Azure subscription Id. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceGraph.Models.IResourceGraphIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceGraph.Models.Api20180901Preview.IGraphQueryResource + +## 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 `<IResourceGraphIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. + - `[ResourceName <String>]`: The name of the Graph Query resource. + - `[SubscriptionId <String>]`: The Azure subscription Id. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ResourceMover/Add-AzResourceMoverMoveResource.md b/azps-10.1.0/Az.ResourceMover/Add-AzResourceMoverMoveResource.md new file mode 100644 index 0000000000..db2c104632 --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Add-AzResourceMoverMoveResource.md @@ -0,0 +1,384 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/add-azresourcemovermoveresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Add-AzResourceMoverMoveResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Add-AzResourceMoverMoveResource.md +--- + +# Add-AzResourceMoverMoveResource + +## SYNOPSIS +Creates or updates a Move Resource in the move collection. + +## SYNTAX + +``` +Add-AzResourceMoverMoveResource -MoveCollectionName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DependsOnOverride <IMoveResourceDependencyOverride[]>] + [-ExistingTargetId <String>] [-ResourceSetting <IResourceSettings>] [-SourceId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a Move Resource in the move collection. + +## EXAMPLES + +### Example 1: Add a resource to the Move Collection. +```powershell +$targetResourceSettingsObj = New-Object Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.VirtualMachineResourceSettings +$targetResourceSettingsObj.ResourceType = "Microsoft.Compute/virtualMachines" +$targetResourceSettingsObj.TargetResourceName = "PSDemoVM" + +Add-AzResourceMoverMoveResource -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -SourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Compute/virtualMachines/PSDemoVM" -Name "PSDemoVM" -ResourceSetting $targetResourceSettingsObj +``` + +```output +DependsOn : {} +DependsOnOverride : {} +ErrorsPropertiesCode : +ErrorsPropertiesDetail : +ErrorsPropertiesMessage : +ErrorsPropertiesTarget : +ExistingTargetId : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralus-demoRMS/moveResources/PSDemoVM +IsResolveRequired : False +JobStatusJobName : +JobStatusJobProgress : +MoveStatusErrorsPropertiesCode : DependencyComputationPending +MoveStatusErrorsPropertiesDetail : {} +MoveStatusErrorsPropertiesMessage : The dependency computation is not completed for resource - /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Compute/virtualMachines/PSDemoVM. Possible Causes: Dependency computation is pending for resource. Recommended Action: Validate dependencies to compute the dependencies. +MoveStatusErrorsPropertiesTarget : +MoveStatusMoveState : PreparePending +Name : PSDemoVM +ProvisioningState : Succeeded +ResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.VirtualMachineResourceSettings +SourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Compute/virtualMachines/PSDemoVM +SourceResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.VirtualMachineResourceSettings +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetId : +Type : +``` + +Add a resource to the Move Collection. + +### Example 2: Add a resource to the Move Collection that has existing target resource. +```powershell +Add-AzResourceMoverMoveResource -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -SourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm" -Name "psdemorm" -ExistingTargetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/PSDemoRM-target" +``` + +```output +DependsOn : {} +DependsOnOverride : {} +ErrorsPropertiesCode : +ErrorsPropertiesDetail : +ErrorsPropertiesMessage : +ErrorsPropertiesTarget : +ExistingTargetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/PSDemoRM-target +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralus-demoRMS/moveResources/psdemorm +IsResolveRequired : False +JobStatusJobName : +JobStatusJobProgress : +MoveStatusErrorsPropertiesCode : +MoveStatusErrorsPropertiesDetail : +MoveStatusErrorsPropertiesMessage : +MoveStatusErrorsPropertiesTarget : +MoveStatusMoveState : CommitPending +Name : psdemorm +ProvisioningState : Succeeded +ResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.ResourceSettings +SourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm +SourceResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.ResourceSettings +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetId : +Type : +``` + +Add a resource to the Move Collection that has existing target resource. + +### Example 3: Update target resource settings after the Move Resource has been added. +```powershell +$moveResourceObj = Get-AzResourceMoverMoveResource -MoveCollectionName "PS-centralus-westcentralus-demoRMS1" -ResourceGroupName "RG-MoveCollection-demoRMS" -Name "PSDemoVM" +$TargetResourceSettingObj = $moveResourceObj.ResourceSetting +$TargetResourceSettingObj.TargetResourceName = "PSDemoVM-target" + +Add-AzResourceMoverMoveResource -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -SourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Compute/virtualMachines/PSDemoVM" -Name "PSDemoVM" -ResourceSetting $TargetResourceSettingObj +``` + +```output +DependsOn : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Network/networkInterfaces/psdemov + m111, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/PSDemoRM} +DependsOnOverride : {} +ErrorsPropertiesCode : +ErrorsPropertiesDetail : +ErrorsPropertiesMessage : +ErrorsPropertiesTarget : +ExistingTargetId : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralus-demoRMS/moveResources/PSDemoVM +IsResolveRequired : True +JobStatusJobName : +JobStatusJobProgress : +MoveStatusErrorsPropertiesCode : +MoveStatusErrorsPropertiesDetail : +MoveStatusErrorsPropertiesMessage : +MoveStatusErrorsPropertiesTarget : +MoveStatusMoveState : PreparePending +Name : PSDemoVM +ProvisioningState : Succeeded +ResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.VirtualMachineResourceSettings +SourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Compute/virtualMachines/PSDemoVM +SourceResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.VirtualMachineResourceSettings +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetId : +Type : +``` + +Update target resource settings after the Move Resource has been added. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DependsOnOverride +Gets or sets the move resource dependencies overrides. +To construct, see NOTES section for DEPENDSONOVERRIDE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IMoveResourceDependencyOverride[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExistingTargetId +Gets or sets the existing target ARM Id of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCollectionName +The Move Collection Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Move Resource Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MoveResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceSetting +Gets or sets the resource settings. +To construct, see NOTES section for RESOURCESETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IResourceSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceId +Gets or sets the Source ARM Id of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IMoveResource + +## NOTES + +ALIASES + +Update-AzResourceMoverMoveResource + +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. + + +DEPENDSONOVERRIDE <IMoveResourceDependencyOverride[]>: Gets or sets the move resource dependencies overrides. + - `[Id <String>]`: Gets or sets the ARM ID of the dependent resource. + - `[TargetId <String>]`: Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. + +RESOURCESETTING `<IResourceSettings>`: Gets or sets the resource settings. + - `ResourceType <String>`: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. + - `TargetResourceName <String>`: Gets or sets the target Resource name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceMover/Az.ResourceMover.md b/azps-10.1.0/Az.ResourceMover/Az.ResourceMover.md new file mode 100644 index 0000000000..3c4f4682c3 --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Az.ResourceMover.md @@ -0,0 +1,67 @@ +--- +Module Name: Az.ResourceMover +Module Guid: 97d87543-8eef-4574-a70d-7317ec4abe54 +Download Help Link: https://learn.microsoft.com/powershell/module/az.resourcemover +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Az.ResourceMover.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Az.ResourceMover.md +--- + +# Az.ResourceMover Module +## Description +Microsoft Azure PowerShell: ResourceMover cmdlets + +## Az.ResourceMover Cmdlets +### [Add-AzResourceMoverMoveResource](Add-AzResourceMoverMoveResource.md) +Creates or updates a Move Resource in the move collection. + +### [Get-AzResourceMoverMoveCollection](Get-AzResourceMoverMoveCollection.md) +Gets the move collection. + +### [Get-AzResourceMoverMoveResource](Get-AzResourceMoverMoveResource.md) +Gets the Move Resource. + +### [Get-AzResourceMoverRequiredForResources](Get-AzResourceMoverRequiredForResources.md) +List of the move resources for which an arm resource is required for. + +### [Get-AzResourceMoverUnresolvedDependency](Get-AzResourceMoverUnresolvedDependency.md) +Gets a list of unresolved dependencies. + +### [Invoke-AzResourceMoverBulkRemove](Invoke-AzResourceMoverBulkRemove.md) +Removes the set of move resources included in the request body from move collection. +The orchestration is done by service. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +### [Invoke-AzResourceMoverCommit](Invoke-AzResourceMoverCommit.md) +Commits the set of resources included in the request body. +The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +### [Invoke-AzResourceMoverDiscard](Invoke-AzResourceMoverDiscard.md) +Discards the set of resources included in the request body. +The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +### [Invoke-AzResourceMoverInitiateMove](Invoke-AzResourceMoverInitiateMove.md) +Moves the set of resources included in the request body. +The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +### [Invoke-AzResourceMoverPrepare](Invoke-AzResourceMoverPrepare.md) +Initiates prepare for the set of resources included in the request body. +The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +### [New-AzResourceMoverMoveCollection](New-AzResourceMoverMoveCollection.md) +Creates or updates a move collection. + +### [Remove-AzResourceMoverMoveCollection](Remove-AzResourceMoverMoveCollection.md) +Deletes a move collection. + +### [Remove-AzResourceMoverMoveResource](Remove-AzResourceMoverMoveResource.md) +Deletes a Move Resource from the move collection. + +### [Resolve-AzResourceMoverMoveCollectionDependency](Resolve-AzResourceMoverMoveCollectionDependency.md) +Computes, resolves and validate the dependencies of the moveResources in the move collection. + diff --git a/azps-10.1.0/Az.ResourceMover/Get-AzResourceMoverMoveCollection.md b/azps-10.1.0/Az.ResourceMover/Get-AzResourceMoverMoveCollection.md new file mode 100644 index 0000000000..0000761e61 --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Get-AzResourceMoverMoveCollection.md @@ -0,0 +1,165 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/get-azresourcemovermovecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Get-AzResourceMoverMoveCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Get-AzResourceMoverMoveCollection.md +--- + +# Get-AzResourceMoverMoveCollection + +## SYNOPSIS +Gets the move collection. + +## SYNTAX + +### List (Default) +``` +Get-AzResourceMoverMoveCollection [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzResourceMoverMoveCollection -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzResourceMoverMoveCollection -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the move collection. + +## EXAMPLES + +### Example 1: Get details of all the Move collections in the subscription +```powershell +Get-AzResourceMoverMoveCollection -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +```output +Etag Location Name Type +---- -------- ---- ---- +"270119e0-0000-0c00-0000-5f5c94940000" centraluseuap PS-centralus-westcentralus-demoRMS Microsoft.Migrate/moveCollections +"39015ed4-0000-0c00-0000-5f5ce2760000" centraluseuap PS-centralus-westcentralus-demo2RMS Microsoft.Migrate/moveCollections +"1000b505-0000-0c00-0000-5f69db6e0000" centraluseuap MoveCollection-cus-eus-ccy Microsoft.Migrate/moveCollections + + +``` + +Get details of all the Move collections in the subscription. + +### Example 2: Get details of the Move collection with a specified move collection name in the subscription +```powershell +Get-AzResourceMoverMoveCollection -ResourceGroupName "RG-MoveCollection-demoRMS" -Name "PS-centralus-westcentralus-demoRMS" +``` + +```output +Etag Location Name Type +---- -------- ---- ---- +"22006609-0000-3300-0000-602169590000" centraluseuap PS-centralus-westcentralus-demoRMS Microsoft.Migrate/moveCollections + +``` + +Get details of the Move collection with a specified move collection name in the subscription. + +### Example 3: Get details of the Move collection with a specified resource group name in the subscription +```powershell +Get-AzResourceMoverMoveCollection -ResourceGroupName "RG-MoveCollection-demoRMS" +``` + +```output +Location Name Type +-------- ---- ---- +eastus2 PS-centralus-westcentralus-demoRM Microsoft.Migrate/moveCollections +Etag Location Name Type +---- -------- ---- ---- +"22006609-0000-3300-0000-602169590000" centraluseuap PS-centralus-westcentralus-demoRMS Microsoft.Migrate/moveCollections +"4e02b0a9-0000-0c00-0000-5fd101cc0000" centraluseuap PS-centralus-westcentralus-demo2RMS Microsoft.Migrate/moveCollections + +``` + +Get details of the Move Collection with a specified resource group name in the subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Move Collection Name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: MoveCollectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IMoveCollection + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceMover/Get-AzResourceMoverMoveResource.md b/azps-10.1.0/Az.ResourceMover/Get-AzResourceMoverMoveResource.md new file mode 100644 index 0000000000..0d6677af74 --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Get-AzResourceMoverMoveResource.md @@ -0,0 +1,398 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/get-azresourcemovermoveresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Get-AzResourceMoverMoveResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Get-AzResourceMoverMoveResource.md +--- + +# Get-AzResourceMoverMoveResource + +## SYNOPSIS +Gets the Move Resource. + +## SYNTAX + +### List (Default) +``` +Get-AzResourceMoverMoveResource -MoveCollectionName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-Filter <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzResourceMoverMoveResource -MoveCollectionName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the Move Resource. + +## EXAMPLES + +### Example 1: Get details of all the resources in the Move collection. +```powershell +Get-AzResourceMoverMoveResource -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -ResourceGroupName "RG-MoveCollection-demoRMS" +``` + +```output +DependsOn : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Network/networkInterfaces/psdemov + m111, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/PSDemoRM} +DependsOnOverride : {} +ErrorsPropertiesCode : +ErrorsPropertiesDetail : +ErrorsPropertiesMessage : +ErrorsPropertiesTarget : +ExistingTargetId : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveColle + ctions/PS-centralus-westcentralus-demoRMS1/moveResources/PSDemoVM +IsResolveRequired : False +JobStatusJobName : +JobStatusJobProgress : +MoveStatusErrorsPropertiesCode : +MoveStatusErrorsPropertiesDetail : +MoveStatusErrorsPropertiesMessage : +MoveStatusErrorsPropertiesTarget : +MoveStatusMoveState : PreparePending +Name : PSDemoVM +ProvisioningState : Succeeded +ResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.VirtualMachineResourceSettings +SourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Compute/virtualMachines/PSDemoVM +SourceResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.VirtualMachineResourceSettings +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetId : +Type : + +DependsOn : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/psdemorm/providers/Microsoft.Network/virtualNetworks/psdemorm- + vnet, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm/providers/microsoft.network/networksecuritygroup + s/psdemovm-nsg, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm} +DependsOnOverride : {} +ErrorsPropertiesCode : +ErrorsPropertiesDetail : +ErrorsPropertiesMessage : +ErrorsPropertiesTarget : +ExistingTargetId : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveColle + ctions/PS-centralus-westcentralus-demoRMS1/moveResources/psdemovm111 +IsResolveRequired : False +JobStatusJobName : +JobStatusJobProgress : +MoveStatusErrorsPropertiesCode : +MoveStatusErrorsPropertiesDetail : +MoveStatusErrorsPropertiesMessage : +MoveStatusErrorsPropertiesTarget : +MoveStatusMoveState : PreparePending +Name : psdemovm111 +ProvisioningState : Succeeded +ResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.NetworkInterfaceResourceSettings +SourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm/providers/microsoft.network/networkinterfaces/psdemovm + 111 +SourceResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.NetworkInterfaceResourceSettings +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetId : +Type : + +DependsOn : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm} +DependsOnOverride : {} +ErrorsPropertiesCode : +ErrorsPropertiesDetail : +ErrorsPropertiesMessage : +ErrorsPropertiesTarget : +ExistingTargetId : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveColle + ctions/PS-centralus-westcentralus-demoRMS1/moveResources/psdemorm-vnet +IsResolveRequired : False +JobStatusJobName : +JobStatusJobProgress : +MoveStatusErrorsPropertiesCode : +MoveStatusErrorsPropertiesDetail : +MoveStatusErrorsPropertiesMessage : +MoveStatusErrorsPropertiesTarget : +MoveStatusMoveState : PreparePending +Name : psdemorm-vnet +ProvisioningState : Succeeded +ResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.VirtualNetworkResourceSettings +SourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/psdemorm/providers/Microsoft.Network/virtualNetworks/psdemorm-v + net +SourceResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.VirtualNetworkResourceSettings +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetId : +Type : + +DependsOn : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm} +DependsOnOverride : {} +ErrorsPropertiesCode : +ErrorsPropertiesDetail : +ErrorsPropertiesMessage : +ErrorsPropertiesTarget : +ExistingTargetId : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveColle + ctions/PS-centralus-westcentralus-demoRMS1/moveResources/psdemovm-nsg +IsResolveRequired : False +JobStatusJobName : +JobStatusJobProgress : +MoveStatusErrorsPropertiesCode : +MoveStatusErrorsPropertiesDetail : +MoveStatusErrorsPropertiesMessage : +MoveStatusErrorsPropertiesTarget : +MoveStatusMoveState : PreparePending +Name : psdemovm-nsg +ProvisioningState : Succeeded +ResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.NetworkSecurityGroupResourceSettings +SourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm/providers/microsoft.network/networksecuritygroups/psde + movm-nsg +SourceResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.NetworkSecurityGroupResourceSettings +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetId : +Type : + +DependsOn : {} +DependsOnOverride : {} +ErrorsPropertiesCode : +ErrorsPropertiesDetail : +ErrorsPropertiesMessage : +ErrorsPropertiesTarget : +ExistingTargetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/PSDemoRM-target +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveColle + ctions/PS-centralus-westcentralus-demoRMS1/moveResources/psdemorm +IsResolveRequired : False +JobStatusJobName : +JobStatusJobProgress : +MoveStatusErrorsPropertiesCode : +MoveStatusErrorsPropertiesDetail : +MoveStatusErrorsPropertiesMessage : +MoveStatusErrorsPropertiesTarget : +MoveStatusMoveState : DeleteSourcePending +Name : psdemorm +ProvisioningState : Succeeded +ResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.ResourceSettings +SourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm +SourceResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.ResourceSettings +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/PSDemoRM-target +Type : + +``` + +Get details of all the resources in the move collection. + +### Example 2: Get details of a specific resources in a Move collection using move resource name . +```powershell +Get-AzResourceMoverMoveResource -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -ResourceGroupName "RG-MoveCollection-demoRMS" -Name "PSDemoVM" +``` + +```output +DependsOn : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Network/networkInterfaces/psdemov + m111, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/PSDemoRM} +DependsOnOverride : {} +ErrorsPropertiesCode : +ErrorsPropertiesDetail : +ErrorsPropertiesMessage : +ErrorsPropertiesTarget : +ExistingTargetId : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveColle + ctions/PS-centralus-westcentralus-demoRMS/moveResources/PSDemoVM +IsResolveRequired : False +JobStatusJobName : +JobStatusJobProgress : +MoveStatusErrorsPropertiesCode : +MoveStatusErrorsPropertiesDetail : +MoveStatusErrorsPropertiesMessage : +MoveStatusErrorsPropertiesTarget : +MoveStatusMoveState : PreparePending +Name : PSDemoVM +ProvisioningState : Succeeded +ResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.VirtualMachineResourceSettings +SourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Compute/virtualMachines/PSDemoVM +SourceResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.VirtualMachineResourceSettings +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetId : +Type : + +``` + +Get details of a specific resources in a Move collection using move resource name . + +### Example 3:Get details of a specific resources in a Move collection using filters such as : SourceResourceName, SourceId, MoveState, IsResolveRequired, ProvisioningState +```powershell +Get-AzResourceMoverMoveResource -MoveCollectionName "PS-centralus-westcentralus-demoRMS1" -ResourceGroupName "RG-MoveCollection-demoRMS" -Filter "Properties/SourceResourceName eq 'psdemovm111'" +``` + +```output +DependsOn : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/psdemorm/providers/Microsoft.Network/virtualNetworks/psdemorm- + vnet, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm/providers/microsoft.network/networksecuritygroup + s/psdemovm-nsg, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm} +DependsOnOverride : {} +ErrorsPropertiesCode : +ErrorsPropertiesDetail : +ErrorsPropertiesMessage : +ErrorsPropertiesTarget : +ExistingTargetId : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveColle + ctions/PS-centralus-westcentralus-demoRMS1/moveResources/psdemovm111 +IsResolveRequired : False +JobStatusJobName : +JobStatusJobProgress : +MoveStatusErrorsPropertiesCode : +MoveStatusErrorsPropertiesDetail : +MoveStatusErrorsPropertiesMessage : +MoveStatusErrorsPropertiesTarget : +MoveStatusMoveState : PreparePending +Name : psdemovm111 +ProvisioningState : Succeeded +ResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.NetworkInterfaceResourceSettings +SourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm/providers/microsoft.network/networkinterfaces/psdemovm + 111 +SourceResourceSetting : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.NetworkInterfaceResourceSettings +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetId : +Type : + +``` + +Get details of a specific resources in a Move collection using filter such as armid ,moveStatusMoveState(verify) etc. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply on the operation. +For example, you can use $filter=Properties/ProvisioningState eq 'Succeeded'. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCollectionName +The Move Collection Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Move Resource Name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: MoveResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IMoveResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceMover/Get-AzResourceMoverRequiredForResources.md b/azps-10.1.0/Az.ResourceMover/Get-AzResourceMoverRequiredForResources.md new file mode 100644 index 0000000000..5b1eca8085 --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Get-AzResourceMoverRequiredForResources.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/get-azresourcemoverrequiredforresources +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Get-AzResourceMoverRequiredForResources.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Get-AzResourceMoverRequiredForResources.md +--- + +# Get-AzResourceMoverRequiredForResources + +## SYNOPSIS +List of the move resources for which an arm resource is required for. + +## SYNTAX + +``` +Get-AzResourceMoverRequiredForResources -MoveCollectionName <String> -ResourceGroupName <String> + -SourceId <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List of the move resources for which an arm resource is required for. + +## EXAMPLES + +### Example 1: Get a list of required resource ARMIDs that are required to be added, to add the specified resource. +```powershell +Get-AzResourceMoverRequiredForResources -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -ResourceGroupName "RG-MoveCollection-demoRMS" -SourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups" +``` + +```output +/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Compute/virtualMachines/PSDemoVM +/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm/providers/microsoft.network/networkinterfaces/psdemovm111 +/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/psdemorm/providers/Microsoft.Network/virtualNetworks/psdemorm-vnet +/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm/providers/microsoft.network/networksecuritygroups/psdemovm-nsg +``` + +Get a list of required resource ARMIDs that are required to be added, to add the specified resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCollectionName +The Move Collection Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceId +The sourceId for which the api is invoked. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceMover/Get-AzResourceMoverUnresolvedDependency.md b/azps-10.1.0/Az.ResourceMover/Get-AzResourceMoverUnresolvedDependency.md new file mode 100644 index 0000000000..f72153df78 --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Get-AzResourceMoverUnresolvedDependency.md @@ -0,0 +1,167 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/get-azresourcemoverunresolveddependency +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Get-AzResourceMoverUnresolvedDependency.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Get-AzResourceMoverUnresolvedDependency.md +--- + +# Get-AzResourceMoverUnresolvedDependency + +## SYNOPSIS +Gets a list of unresolved dependencies. + +## SYNTAX + +``` +Get-AzResourceMoverUnresolvedDependency -MoveCollectionName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DependencyLevel <DependencyLevel>] [-Filter <String>] [-Orderby <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a list of unresolved dependencies. + +## EXAMPLES + +### Example 1: Get list of unresolved dependent resources for a Move Collection. +```powershell +Get-AzResourceMoverUnresolvedDependency -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -ResourceGroupName "RG-MoveCollection-demoRMS" -DependencyLevel Descendant +``` + +```output +Count Id +----- -- + 1 /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm/providers/microsoft.network/networkinterfaces/psdemovm111 + 1 /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/psdemorm/providers/Microsoft.Network/virtualNetworks/psdemorm-vnet + 1 /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm/providers/microsoft.network/networksecuritygroups/psdemovm-nsg + 3 /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm +``` + +Get a list of unresolved dependent resources for a Move Collection. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DependencyLevel +Defines the dependency level. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Support.DependencyLevel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply on the operation. +For example, $apply=filter(count eq 2). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCollectionName +The Move Collection Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orderby +OData order by query option. +For example, you can use $orderby=Count desc. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IUnresolvedDependency + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverBulkRemove.md b/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverBulkRemove.md new file mode 100644 index 0000000000..f5d5137631 --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverBulkRemove.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/invoke-azresourcemoverbulkremove +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Invoke-AzResourceMoverBulkRemove.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Invoke-AzResourceMoverBulkRemove.md +--- + +# Invoke-AzResourceMoverBulkRemove + +## SYNOPSIS +Removes the set of move resources included in the request body from move collection. +The orchestration is done by service. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +## SYNTAX + +``` +Invoke-AzResourceMoverBulkRemove -MoveCollectionName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-MoveResource <String[]>] [-MoveResourceInputType <MoveResourceInputType>] + [-ValidateOnly] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Removes the set of move resources included in the request body from move collection. +The orchestration is done by service. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +## EXAMPLES + +### Example 1: Validate the dependecies before remove of the Move Resources from Move Collection +```powershell +Invoke-AzResourceMoverBulkRemove -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('PSDemoVM') -MoveResourceInputType "MoveResourceId" -ValidateOnly +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/10/2021 12:52:28 PM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralu + s-demoRMS/operations/b4e3f140-b36b-4fd5-a507-b1e663ecf7a3 +Message : +Name : b4e3f140-b36b-4fd5-a507-b1e663ecf7a3 +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/10/2021 12:52:28 PM +Status : Succeeded + +``` + +Validate the dependecies before remove of the move resources from Move Collection. + +### Example 2: Remove the Move Resource from Move Collection using "MoveResource Name" as input +```powershell +Invoke-AzResourceMoverBulkRemove -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('PSDemoVM') -MoveResourceInputType "MoveResourceId" +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/10/2021 12:58:10 PM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralu + s-demoRMS/operations/d4827071-b797-45c5-b88c-00ddd7818d42 +Message : +Name : d4827071-b797-45c5-b88c-00ddd7818d42 +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/10/2021 12:57:08 PM +Status : Succeeded +``` + +Remove the Move Resource from Move Collection using "MoveResource Name" as input + +### Example 3: Remove the Move Resource from Move Collection using "SourceARMID" as input +```powershell +Invoke-AzResourceMoverBulkRemove -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Network/networkSecurityGroups/PSDemoVM-nsg') -MoveResourceInputType "MoveResourceSourceId" +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/10/2021 1:05:13 PM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralu + s-demoRMS/operations/7b6904e2-fc3f-400d-b248-8908fcb282fb +Message : +Name : 7b6904e2-fc3f-400d-b248-8908fcb282fb +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/10/2021 1:05:00 PM +Status : Succeeded +``` + +Remove the Move Resource from Move Collection using "SourceARMID" as input + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCollectionName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveResource +Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveResourceInputType +Defines the move resource input type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Support.MoveResourceInputType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidateOnly +Gets or sets a value indicating whether the operation needs to only run pre-requisite. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IOperationStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverCommit.md b/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverCommit.md new file mode 100644 index 0000000000..edfdbd37b4 --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverCommit.md @@ -0,0 +1,282 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/invoke-azresourcemovercommit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Invoke-AzResourceMoverCommit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Invoke-AzResourceMoverCommit.md +--- + +# Invoke-AzResourceMoverCommit + +## SYNOPSIS +Commits the set of resources included in the request body. +The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +## SYNTAX + +``` +Invoke-AzResourceMoverCommit -MoveCollectionName <String> -ResourceGroupName <String> -MoveResource <String[]> + [-SubscriptionId <String>] [-MoveResourceInputType <MoveResourceInputType>] [-ValidateOnly] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Commits the set of resources included in the request body. +The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +## EXAMPLES + +### Example 1: Validate the dependecies before commit of the resources. +```powershell +Invoke-AzResourceMoverCommit -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('psdemorm-vnet') -MoveResourceInputType "MoveResourceId" -ValidateOnly +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/10/2021 12:38:26 PM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralu + s-demoRMS/operations/c194298b-b2eb-4aab-80b4-129d1473b75c +Message : +Name : c194298b-b2eb-4aab-80b4-129d1473b75c +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/10/2021 12:38:25 PM +Status : Succeeded + +``` + +Validate the dependecies before commit of the resources. + +### Example 2: Commit the set of resources in the Move Collection using "MoveResource Name" as input. +```powershell +Invoke-AzResourceMoverCommit -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('psdemorm-vnet') -MoveResourceInputType "MoveResourceId" +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/10/2021 12:41:13 PM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralu + s-demoRMS/operations/80c04850-7f3f-4e9c-aa68-b868978b59f3 +Message : +Name : 80c04850-7f3f-4e9c-aa68-b868978b59f3 +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/10/2021 12:41:05 PM +Status : Succeeded + + +``` + +Commit the set of resources in the Move Collection using "MoveResource Name" as input. + +### Example 3: Commit the set of resources in the Move Collection using "SourceARMID" as input. +```powershell +Invoke-AzResourceMoverCommit -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Network/networkSecurityGroups/PSDemoVM-nsg') -MoveResourceInputType "MoveResourceSourceId" +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/10/2021 12:42:46 PM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralu + s-demoRMS/operations/d36ca519-8ced-48c9-a968-cb5e9c4db731 +Message : +Name : d36ca519-8ced-48c9-a968-cb5e9c4db731 +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/10/2021 12:42:41 PM +Status : Succeeded + + +``` + +Commit the set of resources in the Move Collection using "SourceARMID" as input. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCollectionName +The Move Collection Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveResource +Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveResourceInputType +Defines the move resource input type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Support.MoveResourceInputType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidateOnly +Gets or sets a value indicating whether the operation needs to only run pre-requisite. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IOperationStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverDiscard.md b/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverDiscard.md new file mode 100644 index 0000000000..404235c213 --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverDiscard.md @@ -0,0 +1,281 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/invoke-azresourcemoverdiscard +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Invoke-AzResourceMoverDiscard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Invoke-AzResourceMoverDiscard.md +--- + +# Invoke-AzResourceMoverDiscard + +## SYNOPSIS +Discards the set of resources included in the request body. +The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +## SYNTAX + +``` +Invoke-AzResourceMoverDiscard -Name <String> -ResourceGroupName <String> -MoveResource <String[]> + [-SubscriptionId <String>] [-MoveResourceInputType <MoveResourceInputType>] [-ValidateOnly] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Discards the set of resources included in the request body. +The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +## EXAMPLES + +### Example 1: Validate the dependecies before Discard of the resources. +```powershell +Invoke-AzResourceMoverInitiateMove -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('psdemorm-vnet') -MoveResourceInputType "MoveResourceId" -ValidateOnly +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/10/2021 12:39:48 PM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralus-demoRMS/operations/095f3d5 + 1-ebd1-4c5b-9a65-d78ebe3ac345 +Message : +Name : 095f3d51-ebd1-4c5b-9a65-d78ebe3ac345 +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/10/2021 12:39:37 PM +Status : Succeeded + +``` + +Validate the dependecies before Discard of the resources. + +### Example 2: Discards the move of the resources using "MoveResource Name" as input. +```powershell +Invoke-AzResourceMoverDiscard -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('psdemorm-vnet') -MoveResourceInputType "MoveResourceId" +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/10/2021 12:56:33 PM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralu + s-demoRMS/operations/290472e3-c8de-4c55-aba1-3a34a7a4ab38 +Message : +Name : 290472e3-c8de-4c55-aba1-3a34a7a4ab38 +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/10/2021 12:55:21 PM +Status : Succeeded + +``` + +Discards the move of the resources using "MoveResource Name" as input. + +### Example 3: Discards the move of the resources using "SourceARMID" as input. +```powershell +Invoke-AzResourceMoverDiscard -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Network/networkSecurityGroups/PSDemoVM-nsg') -MoveResourceInputType "MoveResourceSourceId" +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/10/2021 1:01:32 PM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralu + s-demoRMS/operations/955fd43c-10b6-481e-888b-d26d6ec42aea +Message : +Name : 955fd43c-10b6-481e-888b-d26d6ec42aea +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/10/2021 1:00:00 PM +Status : Succeeded + + +``` + +Discards the move of the resources using "SourceARMID" as input. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveResource +Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveResourceInputType +Defines the move resource input type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Support.MoveResourceInputType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Move Collection Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MoveCollectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidateOnly +Gets or sets a value indicating whether the operation needs to only run pre-requisite. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IOperationStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverInitiateMove.md b/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverInitiateMove.md new file mode 100644 index 0000000000..f1b69e7a95 --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverInitiateMove.md @@ -0,0 +1,280 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/invoke-azresourcemoverinitiatemove +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Invoke-AzResourceMoverInitiateMove.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Invoke-AzResourceMoverInitiateMove.md +--- + +# Invoke-AzResourceMoverInitiateMove + +## SYNOPSIS +Moves the set of resources included in the request body. +The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +## SYNTAX + +``` +Invoke-AzResourceMoverInitiateMove -MoveCollectionName <String> -ResourceGroupName <String> + -MoveResource <String[]> [-SubscriptionId <String>] [-MoveResourceInputType <MoveResourceInputType>] + [-ValidateOnly] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Moves the set of resources included in the request body. +The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +## EXAMPLES + +### Example 1: Validate the dependecies before Initiate Move for the resources. +```powershell +Invoke-AzResourceMoverInitiateMove -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('psdemorm-vnet') -MoveResourceInputType "MoveResourceId" -ValidateOnly +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/10/2021 9:39:37 AM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralus-demoRMS/operations/095f3d5 + 1-ebd1-4c5b-9a65-d78ebe3ac345 +Message : +Name : 095f3d51-ebd1-4c5b-9a65-d78ebe3ac345 +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/10/2021 9:39:37 AM +Status : Succeeded + +``` + +Validate the dependecies before Initiate Move for the resources. + +### Example 2: Initiate Move for the set of resources in the Move collection using "MoveResource Name" as input. +```powershell +Invoke-AzResourceMoverInitiateMove -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('psdemorm-vnet') -MoveResourceInputType "MoveResourceId" +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/10/2021 11:56:33 AM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralu + s-demoRMS/operations/290472e3-c8de-4c55-aba1-3a34a7a4ab38 +Message : +Name : 290472e3-c8de-4c55-aba1-3a34a7a4ab38 +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/10/2021 11:55:21 AM +Status : Succeeded + +``` + +Initiate Move for the set of resources in the Move collection using "MoveResource Name" as input. + +### Example 3: Initiate Move for the set of resources in the Move Collection using "SourceARMID" as input. +```powershell +Invoke-AzResourceMoverInitiateMove -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRM/providers/Microsoft.Network/networkSecurityGroups/PSDemoVM-nsg') -MoveResourceInputType "MoveResourceSourceId" +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/10/2021 12:01:35 PM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralu + s-demoRMS/operations/955fd43c-10b6-481e-888b-d26d6ec42aea +Message : +Name : 955fd43c-10b6-481e-888b-d26d6ec42aea +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/10/2021 12:00:21 PM +Status : Succeeded + +``` + +Initiate Move for the set of resources in the Move collection using "SourceARMID" as input. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCollectionName +The Move Collection Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveResource +Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveResourceInputType +Defines the move resource input type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Support.MoveResourceInputType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidateOnly +Gets or sets a value indicating whether the operation needs to only run pre-requisite. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IOperationStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverPrepare.md b/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverPrepare.md new file mode 100644 index 0000000000..ce77924cb3 --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Invoke-AzResourceMoverPrepare.md @@ -0,0 +1,293 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/invoke-azresourcemoverprepare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Invoke-AzResourceMoverPrepare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Invoke-AzResourceMoverPrepare.md +--- + +# Invoke-AzResourceMoverPrepare + +## SYNOPSIS +Initiates prepare for the set of resources included in the request body. +The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +## SYNTAX + +``` +Invoke-AzResourceMoverPrepare -MoveCollectionName <String> -ResourceGroupName <String> + -MoveResource <String[]> [-SubscriptionId <String>] [-MoveResourceInputType <MoveResourceInputType>] + [-ValidateOnly] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Initiates prepare for the set of resources included in the request body. +The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. +To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + +## EXAMPLES + +### Example 1: Validate the dependecies before prepare of the resources. Get the required dependent resources that also need to be prepared. +<!-- Skip: Output cannot be splitted from code --> +```powershell +$resp = Invoke-AzResourceMoverPrepare -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('psdemovm') -ValidateOnly + +AdditionalInfo : {Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20191001Preview.OperationErrorAdditionalInfo} +Code : MoveCollectionMissingRequiredDependentResources +Detail : {} +EndTime : 2/9/2021 9:04:15 AM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RegionMoveRG-centralus-westcentralus/providers/Microsoft.Migr + ate/MoveCollections/PS-centralus-westcentralus-demoRMS/12d055bd-ac52-427f-8b05-b4b21c4b51e8 +Message : The operation has failed as required move resources are missing from the input. + Possible Causes: Dependent resources are missing from the input. + Recommended Action: Retry the operation with all required resources, if the issue persist contact support. + +Name : 12d055bd-ac52-427f-8b05-b4b21c4b51e8 +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/9/2021 9:04:14 AM +Status : Failed + +$resp.Code +MoveCollectionMissingRequiredDependentResources + +$resp.AdditionalInfo[0].InfoMoveResource + +SourceId +-------- +/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm/providers/microsoft.network/networkinterfaces/psdemovm111 +/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/psdemorm/providers/Microsoft.Network/virtualNetworks/psdemorm-vnet +/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/psdemorm/providers/microsoft.network/networksecuritygroups/psdemovm-nsg + +``` + +Validate the dependecies before prepare of the resources. +Get the required dependent resources that also need to be prepared. + +### Example 2: Initiate prepare for the set of resources in the Move Collection using "MoveResource Name" as input. +```powershell +Invoke-AzResourceMoverPrepare -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResource $('PSDemoVM','psdemovm111', 'PSDemoRM-vnet','PSDemoVM-nsg') +``` + +```output +AAdditionalInfo : +Code : +Detail : +EndTime : 2/9/2021 11:25:13 AM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralus-demoRMS/operations/49e4429 + 4-24ac-4eac-93da-e7e1c815554d +Message : +Name : 49e44294-24ac-4eac-93da-e7e1c815554d +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/9/2021 10:55:53 AM +Status : Succeeded +``` + +Initiate prepare for the set of resources in the Move Collection using "MoveResource Name" as input. + +### Example 3: Initiate prepare for the set of resources in the Move Collection using "SourceARMID". +```powershell +Invoke-AzResourceMoverPrepare -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -MoveResourceInputType MoveResourceSourceId -MoveResource $('/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/PSDemoRMS/providers/Microsoft.Network/networkSecurityGroups/PSDemoVM-nsg') +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/9/2021 11:09:30 AM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/MoveColl + ections/PS-centralus-westcentralus-demoRMS/operations/c7b13d43-a6fe-48e3-bb8c-3ad9e6ba3355 +Message : +Name : c7b13d43-a6fe-48e3-bb8c-3ad9e6ba3355 +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/9/2021 11:05:27 AM +Status : Succeeded + +``` + +Initiate prepare for the set of resources in the Move Collection using "SourceARMID". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCollectionName +The Move Collection Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveResource +Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveResourceInputType +Defines the move resource input type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Support.MoveResourceInputType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidateOnly +Gets or sets a value indicating whether the operation needs to only run pre-requisite. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IOperationStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceMover/New-AzResourceMoverMoveCollection.md b/azps-10.1.0/Az.ResourceMover/New-AzResourceMoverMoveCollection.md new file mode 100644 index 0000000000..0ffd26d1f2 --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/New-AzResourceMoverMoveCollection.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/new-azresourcemovermovecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/New-AzResourceMoverMoveCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/New-AzResourceMoverMoveCollection.md +--- + +# New-AzResourceMoverMoveCollection + +## SYNOPSIS +Creates or updates a move collection. + +## SYNTAX + +``` +New-AzResourceMoverMoveCollection -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IdentityPrincipalId <String>] [-IdentityTenantId <String>] [-IdentityType <ResourceIdentityType>] + [-Location <String>] [-SourceRegion <String>] [-Tag <Hashtable>] [-TargetRegion <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a move collection. + +## EXAMPLES + +### Example 1: Create a new Move collection. +```powershell +New-AzResourceMoverMoveCollection -Name "PS-centralus-westcentralus-demoRMS" -ResourceGroupName "RG-MoveCollection-demoRMS" -SourceRegion "centralus" -TargetRegion "westcentralus" -Location "centraluseuap" -IdentityType "SystemAssigned" +``` + +```output +Etag Location Name Type +---- -------- ---- ---- +"0200d92f-0000-3300-0000-6021e9ec0000" centraluseuap PS-centralus-westcentralus-demoRMs Microsoft.Migrate/moveCollections +``` + +Create a new Move Collection. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityPrincipalId +Gets or sets the principal id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityTenantId +Gets or sets the tenant id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The type of identity used for the resource mover service. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Move Collection Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MoveCollectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceRegion +Gets or sets the source region. + +```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 Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetRegion +Gets or sets the target region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IMoveCollection + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceMover/Remove-AzResourceMoverMoveCollection.md b/azps-10.1.0/Az.ResourceMover/Remove-AzResourceMoverMoveCollection.md new file mode 100644 index 0000000000..26b904b82f --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Remove-AzResourceMoverMoveCollection.md @@ -0,0 +1,200 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/remove-azresourcemovermovecollection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Remove-AzResourceMoverMoveCollection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Remove-AzResourceMoverMoveCollection.md +--- + +# Remove-AzResourceMoverMoveCollection + +## SYNOPSIS +Deletes a move collection. + +## SYNTAX + +``` +Remove-AzResourceMoverMoveCollection -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a move collection. + +## EXAMPLES + +### Example 1: Remove the Move Collection. +```powershell +Remove-AzResourceMoverMoveCollection -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralu + s-demoRMS/operations/ec788761-2f1b-46a2-97b7-f5056afd334d +Message : +Name : +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : +Status : Succeeded +``` + +Remove the Move Collection. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Move Collection Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MoveCollectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IOperationStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceMover/Remove-AzResourceMoverMoveResource.md b/azps-10.1.0/Az.ResourceMover/Remove-AzResourceMoverMoveResource.md new file mode 100644 index 0000000000..cdd1e35ff0 --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Remove-AzResourceMoverMoveResource.md @@ -0,0 +1,217 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/remove-azresourcemovermoveresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Remove-AzResourceMoverMoveResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Remove-AzResourceMoverMoveResource.md +--- + +# Remove-AzResourceMoverMoveResource + +## SYNOPSIS +Deletes a Move Resource from the move collection. + +## SYNTAX + +``` +Remove-AzResourceMoverMoveResource -MoveCollectionName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Move Resource from the move collection. + +## EXAMPLES + +### Example 1: Remove one Move Rresource from the Move Collection. +```powershell +Remove-AzResourceMoverMoveResource -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" -Name "psdemorm-vnet" +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 2/10/2021 1:08:49 PM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralu + s-demoRMS/operations/bee69758-c7cb-4160-b3e0-8e4b69ec3731 +Message : +Name : bee69758-c7cb-4160-b3e0-8e4b69ec3731 +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/10/2021 1:08:47 PM +Status : Succeeded + +``` + +Remove one Move Rresource from the Move Collection. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCollectionName +The Move Collection Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Move Resource Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MoveResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IOperationStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ResourceMover/Resolve-AzResourceMoverMoveCollectionDependency.md b/azps-10.1.0/Az.ResourceMover/Resolve-AzResourceMoverMoveCollectionDependency.md new file mode 100644 index 0000000000..68aa0a5b3e --- /dev/null +++ b/azps-10.1.0/Az.ResourceMover/Resolve-AzResourceMoverMoveCollectionDependency.md @@ -0,0 +1,189 @@ +--- +external help file: +Module Name: Az.ResourceMover +online version: https://learn.microsoft.com/powershell/module/az.resourcemover/resolve-azresourcemovermovecollectiondependency +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Resolve-AzResourceMoverMoveCollectionDependency.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ResourceMover/help/Resolve-AzResourceMoverMoveCollectionDependency.md +--- + +# Resolve-AzResourceMoverMoveCollectionDependency + +## SYNOPSIS +Computes, resolves and validate the dependencies of the moveResources in the move collection. + +## SYNTAX + +``` +Resolve-AzResourceMoverMoveCollectionDependency -MoveCollectionName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Computes, resolves and validate the dependencies of the moveResources in the move collection. + +## EXAMPLES + +### Example 1: Compute, resolve and validate the dependencies of the Move Resources in the Move collection. +```powershell +Resolve-AzResourceMoverMoveCollectionDependency -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveCollectionName "PS-centralus-westcentralus-demoRMS" +``` + +```output +AdditionalInfo : +Code : MoveCollectionResolveDependenciesOperationFailed +Detail : {} +EndTime : 2/9/2021 2:05:04 AM +Id : /subscriptions/e80eb9fa-c996-4435-aa32-5af6f3d3077c/resourceGroups/RG-MoveCollection-demoRMS/providers/Microsoft.Migrate/moveCollections/PS-centralus-westcentralus-demoRMS/operations/c2ad006 + 6-6a69-45fe-aa70-193c240a9bc0 +Message : The resolve dependencies operation of one or more resources has failed. Check the move status of the resource for more details. + Possible Causes: The resolve dependencies operation of one ore more resources has failed. + Recommended Action: Retry the operation after resolving errors if any. If issue persists, contact support. + +Name : c2ad0066-6a69-45fe-aa70-193c240a9bc0 +Property : Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Any +StartTime : 2/9/2021 2:05:00 AM +Status : Succeeded +``` + +Compute, resolve and validate the dependencies of the Move Resources in the Move collection. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCollectionName +The Move Collection Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ResourceMover.Models.Api20210801.IOperationStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Resources/Add-AzADAppPermission.md b/azps-10.1.0/Az.Resources/Add-AzADAppPermission.md new file mode 100644 index 0000000000..df3b759bee --- /dev/null +++ b/azps-10.1.0/Az.Resources/Add-AzADAppPermission.md @@ -0,0 +1,195 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/add-azadapppermission +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Add-AzADAppPermission.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Add-AzADAppPermission.md +--- + +# Add-AzADAppPermission + +## SYNOPSIS +Adds an API permission. + +## SYNTAX + +### ObjectIdParameterSet (Default) +``` +Add-AzADAppPermission -ApiId <Guid> -PermissionId <String> -ObjectId <Guid> [-Type <String>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AppIdParameterSet +``` +Add-AzADAppPermission -ApiId <Guid> -PermissionId <String> [-Type <String>] -ApplicationId <Guid> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Adds an API permission. +The list of available permissions of API is property of application represented by service principal in tenant. + +For instance, to get available permissions for Graph API: +* Azure Active Directory Graph: `Get-AzAdServicePrincipal -ApplicationId 00000002-0000-0000-c000-000000000000` +* Microsoft Graph: `Get-AzAdServicePrincipal -ApplicationId 00000003-0000-0000-c000-000000000000` + +Application permissions under the `appRoles` property correspond to `Role` in `-Type`. +Delegated permissions under the `oauth2Permissions` property correspond to `Scope` in `-Type`. + +User needs to grant consent via Azure Portal if the permission requires admin consent because Azure PowerShell doesn't support it yet. + +## EXAMPLES + +### Example 1: Add API Permission +```powershell +Add-AzADAppPermission -ObjectId 9cc74d5e-1162-4b90-8696-65f3d6a3f7d0 -ApiId 00000003-0000-0000-c000-000000000000 -PermissionId 5f8c59db-677d-491f-a6b8-5f174b11ec1d +``` + +Add delegated permission "Group.Read.All" of Microsoft Graph API to AD Application (9cc74d5e-1162-4b90-8696-65f3d6a3f7d0) + +### Example 2: Add API Permission +```powershell +Add-AzADAppPermission -ObjectId 9cc74d5e-1162-4b90-8696-65f3d6a3f7d0 -ApiId 00000003-0000-0000-c000-000000000000 -PermissionId 1138cb37-bd11-4084-a2b7-9f71582aeddb -Type Role +``` + +Add application permission "Device.ReadWrite.All" of Microsoft Graph API to AD Application (9cc74d5e-1162-4b90-8696-65f3d6a3f7d0) + +## PARAMETERS + +### -ApiId +The unique identifier for the resource that the application requires access to. +This should be equal to the appId declared on the target resource application. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +The application Id. + +```yaml +Type: System.Guid +Parameter Sets: AppIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The unique identifier in Azure AD. + +```yaml +Type: System.Guid +Parameter Sets: ObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionId +The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specifies whether the id property references an oauth2PermissionScopes(Scope, delegated permission) or an appRole(Role, application permission). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Add-AzADGroupMember.md b/azps-10.1.0/Az.Resources/Add-AzADGroupMember.md new file mode 100644 index 0000000000..df8bae2d32 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Add-AzADGroupMember.md @@ -0,0 +1,558 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/add-azadgroupmember +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Add-AzADGroupMember.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Add-AzADGroupMember.md +--- + +# Add-AzADGroupMember + +## SYNOPSIS +Adds member to group. + +## SYNTAX + +### MemberObjectIdWithGroupObjectIdParameterSet (Default) +``` +Add-AzADGroupMember -TargetGroupObjectId <String> -MemberObjectId <String[]> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MemberUPNWithGroupObjectIdParameterSet +``` +Add-AzADGroupMember -TargetGroupObjectId <String> -MemberUserPrincipalName <String[]> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MemberObjectIdWithGroupObjectParameterSet +``` +Add-AzADGroupMember -MemberObjectId <String[]> -TargetGroupObject <MicrosoftGraphGroup> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MemberObjectIdWithGroupDisplayNameParameterSet +``` +Add-AzADGroupMember -MemberObjectId <String[]> -TargetGroupDisplayName <String> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MemberUPNWithGroupObjectParameterSet +``` +Add-AzADGroupMember -MemberUserPrincipalName <String[]> -TargetGroupObject <MicrosoftGraphGroup> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MemberUPNWithGroupDisplayNameParameterSet +``` +Add-AzADGroupMember -MemberUserPrincipalName <String[]> -TargetGroupDisplayName <String> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Adds member to group. + +## EXAMPLES + +### Example 1: Add members to group +```powershell +$groupid=(Get-AzADGroup -DisplayName $gname).Id +$members=@() +$members+=(Get-AzADUser -DisplayName $uname).Id +$members+=(Get-AzADServicePrincipal -ApplicationId $appid).Id +Add-AzADGroupMember -TargetGroupObjectId $groupid -MemberObjectId $members +``` + +Add members to group + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberObjectId +The object Id of member to add to target group. + +```yaml +Type: System.String[] +Parameter Sets: MemberObjectIdWithGroupObjectIdParameterSet, MemberObjectIdWithGroupObjectParameterSet, MemberObjectIdWithGroupDisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberUserPrincipalName +The user principal name of member to add to target group. + +```yaml +Type: System.String[] +Parameter Sets: MemberUPNWithGroupObjectIdParameterSet, MemberUPNWithGroupObjectParameterSet, MemberUPNWithGroupDisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetGroupDisplayName +The display name of target group. + +```yaml +Type: System.String +Parameter Sets: MemberObjectIdWithGroupDisplayNameParameterSet, MemberUPNWithGroupDisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetGroupObject +The target group object, could be used as pipeline input. +To construct, see NOTES section for TARGETGROUPOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphGroup +Parameter Sets: MemberObjectIdWithGroupObjectParameterSet, MemberUPNWithGroupObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TargetGroupObjectId +The object Id of target group. + +```yaml +Type: System.String +Parameter Sets: MemberObjectIdWithGroupObjectIdParameterSet, MemberUPNWithGroupObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphGroup + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +TARGETGROUPOBJECT <MicrosoftGraphGroup>: The target group object, could be used as pipeline input. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]`: Represents the app roles a group has been granted for an application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[CreatedDateTime <DateTime?>]`: The time when the app role assignment was created.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[PrincipalDisplayName <String>]`: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith). + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[PrincipalType <String>]`: The type of the assigned principal. This can either be User, Group or ServicePrincipal. Read-only. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[Classification <String>]`: Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[AccountEnabled <Boolean?>]`: true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in). + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. + - `[AlternativeName <String[]>]`: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, NOT, ge, le, startsWith). + - `[AppDescription <String>]`: The description exposed by the associated application. + - `[AppDisplayName <String>]`: The display name exposed by the associated application. + - `[AppId <String>]`: The unique identifier for the associated application (its appId property). + - `[AppOwnerOrganizationId <String>]`: Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le). + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. + - `[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignment for another app or service, granted to this service principal. Supports $expand. + - `[AppRoleAssignmentRequired <Boolean?>]`: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT). + - `[ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]`: The claimsMappingPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]`: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. + - `[Classification <String>]`: permissionClassificationType + - `[PermissionId <String>]`: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter. + - `[PermissionName <String>]`: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Does not support $filter. + - `[Description <String>]`: Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[Endpoint <IMicrosoftGraphEndpoint[]>]`: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. + - `[Homepage <String>]`: Home page or landing page of the application. + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[LoginUrl <String>]`: Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. + - `[Note <String>]`: Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters. + - `[NotificationEmailAddress <String[]>]`: Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the service principal. Not nullable. + - `[PreferredSingleSignOnMode <String>]`: Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc. + - `[PreferredTokenSigningKeyThumbprint <String>]`: Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions. + - `[ReplyUrl <String[]>]`: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. + - `[SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]`: samlSingleSignOnSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RelayState <String>]`: The relative URI the service provider would redirect to after completion of the single sign-on flow. + - `[ServicePrincipalName <String[]>]`: Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[ServicePrincipalType <String>]`: Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: The tokenIssuancePolicies assigned to this service principal. Supports $expand. + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this service principal. Supports $expand. + - `[TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]`: + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]`: Represents the app roles a group has been granted for an application. Supports $expand. + - `[Classification <String>]`: Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[Description <String>]`: An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[GroupType <String[]>]`: Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT). + - `[HasMembersWithLicenseError <Boolean?>]`: Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). Supports $filter (eq). + - `[IsArchived <Boolean?>]`: + - `[IsAssignableToRole <Boolean?>]`: Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must also be assigned the Directory.AccessAsUser.All permission to set this property. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT). + - `[MailEnabled <Boolean?>]`: Specifies whether the group is mail-enabled. Returned by default. Supports $filter (eq, ne, NOT). + - `[MailNickname <String>]`: The mail alias for the group, unique in the organization. This property must be specified when a group is created. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[MembershipRule <String>]`: The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[MembershipRuleProcessingState <String>]`: Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]`: The permissions that have been granted for a group to a specific application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[ClientAppId <String>]`: ID of the service principal of the Azure AD app that has been granted access. Read-only. + - `[ClientId <String>]`: ID of the Azure AD app that has been granted access. Read-only. + - `[Permission <String>]`: The name of the resource-specific permission. Read-only. + - `[PermissionType <String>]`: The type of permission. Possible values are: Application, Delegated. Read-only. + - `[ResourceAppId <String>]`: ID of the Azure AD app that is hosting the resource. Read-only. + - `[PreferredDataLocation <String>]`: The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default. + - `[PreferredLanguage <String>]`: The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[SecurityEnabled <Boolean?>]`: Specifies whether the group is a security group. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[SecurityIdentifier <String>]`: Security identifier of the group, used in Windows scenarios. Returned by default. + - `[Theme <String>]`: Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default. + - `[Visibility <String>]`: Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. + - `[Description <String>]`: An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[GroupType <String[]>]`: Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT). + - `[HasMembersWithLicenseError <Boolean?>]`: Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). Supports $filter (eq). + - `[IsArchived <Boolean?>]`: + - `[IsAssignableToRole <Boolean?>]`: Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must also be assigned the Directory.AccessAsUser.All permission to set this property. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT). + - `[MailEnabled <Boolean?>]`: Specifies whether the group is mail-enabled. Returned by default. Supports $filter (eq, ne, NOT). + - `[MailNickname <String>]`: The mail alias for the group, unique in the organization. This property must be specified when a group is created. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[MembershipRule <String>]`: The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[MembershipRuleProcessingState <String>]`: Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]`: The permissions that have been granted for a group to a specific application. Supports $expand. + - `[PreferredDataLocation <String>]`: The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default. + - `[PreferredLanguage <String>]`: The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[SecurityEnabled <Boolean?>]`: Specifies whether the group is a security group. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[SecurityIdentifier <String>]`: Security identifier of the group, used in Windows scenarios. Returned by default. + - `[Theme <String>]`: Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default. + - `[Visibility <String>]`: Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Az.Resources.md b/azps-10.1.0/Az.Resources/Az.Resources.md new file mode 100644 index 0000000000..6cd45777ad --- /dev/null +++ b/azps-10.1.0/Az.Resources/Az.Resources.md @@ -0,0 +1,610 @@ +--- +Module Name: Az.Resources +Module Guid: ab3ca893-26fe-44b0-bd3c-8933df144d7b +Download Help Link: https://learn.microsoft.com/powershell/module/az.resources +Help Version: 5.5.2.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Az.Resources.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Az.Resources.md +--- + +# Az.Resources Module +## Description +This topic displays help topics for the Azure Resource Manager Cmdlets. + +## Az.Resources Cmdlets +### [Add-AzADAppPermission](Add-AzADAppPermission.md) +Adds an API permission. + +### [Add-AzADGroupMember](Add-AzADGroupMember.md) +Adds member to group. + +### [Export-AzResourceGroup](Export-AzResourceGroup.md) +Captures a resource group as a template and saves it to a file. + +### [Export-AzTemplateSpec](Export-AzTemplateSpec.md) +Exports a Template Spec to the local filesystem + +### [Get-AzADAppCredential](Get-AzADAppCredential.md) +Lists key credentials and password credentials for an application. + +### [Get-AzADAppFederatedCredential](Get-AzADAppFederatedCredential.md) +Get federatedIdentityCredentials by Id from applications. + +### [Get-AzADApplication](Get-AzADApplication.md) +Lists entities from applications or get entity from applications by key + +### [Get-AzADAppPermission](Get-AzADAppPermission.md) +Lists API permissions the application has requested. + +### [Get-AzADGroup](Get-AzADGroup.md) +Lists entities from groups or get entity from groups by key + +### [Get-AzADGroupMember](Get-AzADGroupMember.md) +Lists members from group. + +### [Get-AzADOrganization](Get-AzADOrganization.md) +Retrieve a list of organization objects. + +### [Get-AzADServicePrincipal](Get-AzADServicePrincipal.md) +Lists entities from service principals or get entity from service principals by key + +### [Get-AzADSpCredential](Get-AzADSpCredential.md) +Lists key credentials and password credentials for an service principal. + +### [Get-AzADUser](Get-AzADUser.md) +Lists entities from users or get entity from users by key + +### [Get-AzDenyAssignment](Get-AzDenyAssignment.md) +Lists Azure RBAC deny assignments at the specified scope. +By default it lists all deny assignments in the selected Azure subscription. +Use respective parameters to list deny assignments to a specific user, or to list deny assignments on a specific resource group or resource. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /directoryObjects/{id} +- POST /directoryObjects/getByIds + +### [Get-AzDeployment](Get-AzDeployment.md) +Get deployment + +### [Get-AzDeploymentOperation](Get-AzDeploymentOperation.md) +Get deployment operation + +### [Get-AzDeploymentScript](Get-AzDeploymentScript.md) +Gets or lists deployment scripts. + +### [Get-AzDeploymentScriptLog](Get-AzDeploymentScriptLog.md) +Gets the log of a deployment script execution. + +### [Get-AzDeploymentWhatIfResult](Get-AzDeploymentWhatIfResult.md) +Gets a template What-If result for a deployment at subscription scope. + +### [Get-AzLocation](Get-AzLocation.md) +Gets all locations and the supported resource providers for each location. + +### [Get-AzManagedApplication](Get-AzManagedApplication.md) +Gets managed applications + +### [Get-AzManagedApplicationDefinition](Get-AzManagedApplicationDefinition.md) +Gets managed application definitions + +### [Get-AzManagementGroup](Get-AzManagementGroup.md) +Gets Management Group(s) + +### [Get-AzManagementGroupDeployment](Get-AzManagementGroupDeployment.md) +Get deployment at a management group + +### [Get-AzManagementGroupDeploymentOperation](Get-AzManagementGroupDeploymentOperation.md) +Get deployment operation for management group deployment + +### [Get-AzManagementGroupDeploymentWhatIfResult](Get-AzManagementGroupDeploymentWhatIfResult.md) +Gets a template What-If result for a deployment at management group scope. + +### [Get-AzManagementGroupEntity](Get-AzManagementGroupEntity.md) +Lists all Entities under the current Tenant + +### [Get-AzManagementGroupHierarchySetting](Get-AzManagementGroupHierarchySetting.md) +Gets the Hierarchy Settings under the current tenant + +### [Get-AzManagementGroupNameAvailability](Get-AzManagementGroupNameAvailability.md) +Checks if the Management Group name is available in the Tenant and a valid name. + +### [Get-AzManagementGroupSubscription](Get-AzManagementGroupSubscription.md) +Gets the details of Subscription(s) under a Management Group. + +### [Get-AzPolicyAlias](Get-AzPolicyAlias.md) +Get-AzPolicyAlias retrieves and outputs Azure provider resource types that have aliases defined and match the +given parameter values. If no parameters are provided, all provider resource types that contain an alias will be output. +The -ListAvailable switch modifies this behavior by listing all matching resource types including those without aliases. + +### [Get-AzPolicyAssignment](Get-AzPolicyAssignment.md) +Gets policy assignments. + +### [Get-AzPolicyDefinition](Get-AzPolicyDefinition.md) +Gets policy definitions. + +### [Get-AzPolicyExemption](Get-AzPolicyExemption.md) +Gets policy exemptions. + +### [Get-AzPolicySetDefinition](Get-AzPolicySetDefinition.md) +Gets policy set definitions. + +### [Get-AzPrivateLinkAssociation](Get-AzPrivateLinkAssociation.md) +Gets all the Azure Resource Management Private Link Association(s). + +### [Get-AzProviderFeature](Get-AzProviderFeature.md) +Gets information about Azure provider features. + +### [Get-AzProviderOperation](Get-AzProviderOperation.md) +Gets the operations for an Azure resource provider that are securable using Azure RBAC. + +### [Get-AzProviderPreviewFeature](Get-AzProviderPreviewFeature.md) +Gets a feature registration in your account. + +### [Get-AzResource](Get-AzResource.md) +Gets resources. + +### [Get-AzResourceGroup](Get-AzResourceGroup.md) +Gets resource groups. + +### [Get-AzResourceGroupDeployment](Get-AzResourceGroupDeployment.md) +Gets the deployments in a resource group. + +### [Get-AzResourceGroupDeploymentOperation](Get-AzResourceGroupDeploymentOperation.md) +Gets the resource group deployment operation + +### [Get-AzResourceGroupDeploymentWhatIfResult](Get-AzResourceGroupDeploymentWhatIfResult.md) +Gets a template What-If result for a deployment at resource group scope. + +### [Get-AzResourceLock](Get-AzResourceLock.md) +Gets a resource lock. + +### [Get-AzResourceManagementPrivateLink](Get-AzResourceManagementPrivateLink.md) +Gets Azure Resource Management Private Link(s) + +### [Get-AzResourceProvider](Get-AzResourceProvider.md) +Gets a resource provider. + +### [Get-AzRoleAssignment](Get-AzRoleAssignment.md) +Lists Azure RBAC role assignments at the specified scope. +By default it lists all role assignments in the selected Azure subscription. +Use respective parameters to list assignments to a specific user, or to list assignments on a specific resource group or resource. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /users/{id} +- GET /servicePrincipals/{id} +- GET /groups/{id} +- GET /directoryObjects/{id} +- POST /directoryObjects/getByIds + +Please notice that this cmdlet will mark `ObjectType` as `Unknown` in output if the object of role assignment is not found or current account has insufficient privileges to get object type. + +### [Get-AzRoleAssignmentSchedule](Get-AzRoleAssignmentSchedule.md) +Get the specified role assignment schedule for a resource scope + +### [Get-AzRoleAssignmentScheduleInstance](Get-AzRoleAssignmentScheduleInstance.md) +Gets the specified role assignment schedule instance. + +### [Get-AzRoleAssignmentScheduleRequest](Get-AzRoleAssignmentScheduleRequest.md) +Get the specified role assignment schedule request. + +### [Get-AzRoleDefinition](Get-AzRoleDefinition.md) +Lists all Azure RBAC roles that are available for assignment. + +### [Get-AzRoleEligibilitySchedule](Get-AzRoleEligibilitySchedule.md) +Get the specified role eligibility schedule for a resource scope + +### [Get-AzRoleEligibilityScheduleInstance](Get-AzRoleEligibilityScheduleInstance.md) +Gets the specified role eligibility schedule instance. + +### [Get-AzRoleEligibilityScheduleRequest](Get-AzRoleEligibilityScheduleRequest.md) +Get the specified role eligibility schedule request. + +### [Get-AzRoleEligibleChildResource](Get-AzRoleEligibleChildResource.md) +Get the child resources of a resource on which user has eligible access + +### [Get-AzRoleManagementPolicy](Get-AzRoleManagementPolicy.md) +Get the specified role management policy for a resource scope + +### [Get-AzRoleManagementPolicyAssignment](Get-AzRoleManagementPolicyAssignment.md) +Get the specified role management policy assignment for a resource scope + +### [Get-AzTag](Get-AzTag.md) +Gets predefined Azure tags | Gets the entire set of tags on a resource or subscription. + +### [Get-AzTemplateSpec](Get-AzTemplateSpec.md) +Gets or lists Template Specs + +### [Get-AzTenantBackfillStatus](Get-AzTenantBackfillStatus.md) +Get the current Tenant Backfill Subscription Status + +### [Get-AzTenantDeployment](Get-AzTenantDeployment.md) +Get deployment at tenant scope + +### [Get-AzTenantDeploymentOperation](Get-AzTenantDeploymentOperation.md) +Get deployment operation for deployment at tenant scope + +### [Get-AzTenantDeploymentWhatIfResult](Get-AzTenantDeploymentWhatIfResult.md) +Gets a template What-If result for a deployment at tenant scope. + +### [Invoke-AzResourceAction](Invoke-AzResourceAction.md) +Invokes an action on a resource. + +### [Move-AzResource](Move-AzResource.md) +Moves a resource to a different resource group or subscription. + +### [New-AzADAppCredential](New-AzADAppCredential.md) +Creates key credentials or password credentials for an application. + +### [New-AzADAppFederatedCredential](New-AzADAppFederatedCredential.md) +Create federatedIdentityCredential for applications. + +### [New-AzADApplication](New-AzADApplication.md) +Adds new entity to applications + +### [New-AzADGroup](New-AzADGroup.md) +Adds new entity to groups + +### [New-AzADServicePrincipal](New-AzADServicePrincipal.md) +Adds new entity to servicePrincipals + +### [New-AzADSpCredential](New-AzADSpCredential.md) +Creates key credentials or password credentials for an service principal. + +### [New-AzADUser](New-AzADUser.md) +Adds new entity to users + +### [New-AzDeployment](New-AzDeployment.md) +Create a deployment at the current subscription scope. + +### [New-AzManagedApplication](New-AzManagedApplication.md) +Creates an Azure managed application. + +### [New-AzManagedApplicationDefinition](New-AzManagedApplicationDefinition.md) +Creates a managed application definition. + +### [New-AzManagementGroup](New-AzManagementGroup.md) +Creates a Management Group + +### [New-AzManagementGroupDeployment](New-AzManagementGroupDeployment.md) +Create a deployment at a management group + +### [New-AzManagementGroupHierarchySetting](New-AzManagementGroupHierarchySetting.md) +Creates Hierarchy Settings under the current tenant + +### [New-AzManagementGroupSubscription](New-AzManagementGroupSubscription.md) +Adds a Subscription to a Management Group. + +### [New-AzPolicyAssignment](New-AzPolicyAssignment.md) +Creates a policy assignment. + +### [New-AzPolicyDefinition](New-AzPolicyDefinition.md) +Creates a policy definition. + +### [New-AzPolicyExemption](New-AzPolicyExemption.md) +Creates a policy exemption. + +### [New-AzPolicySetDefinition](New-AzPolicySetDefinition.md) +Creates a policy set definition. + +### [New-AzPrivateLinkAssociation](New-AzPrivateLinkAssociation.md) +Creates the Azure Resource Management Private Link Association. + +### [New-AzResource](New-AzResource.md) +Creates a resource. + +### [New-AzResourceGroup](New-AzResourceGroup.md) +Creates an Azure resource group. + +### [New-AzResourceGroupDeployment](New-AzResourceGroupDeployment.md) +Adds an Azure deployment to a resource group. + +### [New-AzResourceLock](New-AzResourceLock.md) +Creates a resource lock. + +### [New-AzResourceManagementPrivateLink](New-AzResourceManagementPrivateLink.md) +Create Azure Resource Management Private Link + +### [New-AzRoleAssignment](New-AzRoleAssignment.md) +Assigns the specified RBAC role to the specified principal, at the specified scope. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /users/{id} +- GET /servicePrincipals/{id} +- GET /groups/{id} +- GET /directoryObjects/{id} + +Please notice that this cmdlet will mark `ObjectType` as `Unknown` in output if the object of role assignment is not found or current account has insufficient privileges to get object type. + +### [New-AzRoleAssignmentScheduleRequest](New-AzRoleAssignmentScheduleRequest.md) +Creates a role assignment schedule request. + +### [New-AzRoleDefinition](New-AzRoleDefinition.md) +Creates a custom role in Azure RBAC. +Provide either a JSON role definition file or a PSRoleDefinition object as input. +First, use the Get-AzRoleDefinition command to generate a baseline role definition object. +Then, modify its properties as required. +Finally, use this command to create a custom role using role definition. + +### [New-AzRoleEligibilityScheduleRequest](New-AzRoleEligibilityScheduleRequest.md) +Creates a role eligibility schedule request. + +### [New-AzRoleManagementPolicyAssignment](New-AzRoleManagementPolicyAssignment.md) +Create a role management policy assignment + +### [New-AzTag](New-AzTag.md) +Creates a predefined Azure tag or adds values to an existing tag | Creates or updates the entire set of tags on a resource or subscription. + +### [New-AzTemplateSpec](New-AzTemplateSpec.md) +Creates a new Template Spec. + +### [New-AzTenantDeployment](New-AzTenantDeployment.md) +Create a deployment at tenant scope + +### [Publish-AzBicepModule](Publish-AzBicepModule.md) +Publishes a Bicep file to a registry. + +### [Register-AzProviderFeature](Register-AzProviderFeature.md) +Registers an Azure provider feature in your current subscription context. + +### [Register-AzProviderPreviewFeature](Register-AzProviderPreviewFeature.md) +Creates a feature registration in your account. + +### [Register-AzResourceProvider](Register-AzResourceProvider.md) +Registers a resource provider. + +### [Remove-AzADAppCredential](Remove-AzADAppCredential.md) +Removes key credentials or password credentials for an application. + +### [Remove-AzADAppFederatedCredential](Remove-AzADAppFederatedCredential.md) +Delete navigation property federatedIdentityCredentials for applications + +### [Remove-AzADApplication](Remove-AzADApplication.md) +Deletes entity from applications + +### [Remove-AzADAppPermission](Remove-AzADAppPermission.md) +Removes an API permission. + +### [Remove-AzADGroup](Remove-AzADGroup.md) +Deletes entity from groups. + +### [Remove-AzADGroupMember](Remove-AzADGroupMember.md) +Deletes member from group +Users, contacts, and groups that are members of this group. +HTTP Methods: GET (supported for all groups), POST (supported for security groups and mail-enabled security groups), DELETE (supported only for security groups) Read-only. +Nullable. +Supports $expand. + +### [Remove-AzADServicePrincipal](Remove-AzADServicePrincipal.md) +Deletes entity from service principal. + +### [Remove-AzADSpCredential](Remove-AzADSpCredential.md) +Removes key credentials or password credentials for an service principal. + +### [Remove-AzADUser](Remove-AzADUser.md) +Deletes entity from users. + +### [Remove-AzDeployment](Remove-AzDeployment.md) +Removes a deployment and any associated operations + +### [Remove-AzDeploymentScript](Remove-AzDeploymentScript.md) +Removes a deployment script and its associated resources. + +### [Remove-AzManagedApplication](Remove-AzManagedApplication.md) +Removes a managed application + +### [Remove-AzManagedApplicationDefinition](Remove-AzManagedApplicationDefinition.md) +Removes a managed application definition + +### [Remove-AzManagementGroup](Remove-AzManagementGroup.md) +Removes a Management Group + +### [Remove-AzManagementGroupDeployment](Remove-AzManagementGroupDeployment.md) +Removes a deployment at a management group and any associated operations + +### [Remove-AzManagementGroupHierarchySetting](Remove-AzManagementGroupHierarchySetting.md) +Deletes all Hierarchy Settings under the current tenant + +### [Remove-AzManagementGroupSubscription](Remove-AzManagementGroupSubscription.md) +Removes a Subscription from a Management Group. + +### [Remove-AzPolicyAssignment](Remove-AzPolicyAssignment.md) +Removes a policy assignment. + +### [Remove-AzPolicyDefinition](Remove-AzPolicyDefinition.md) +Removes a policy definition. + +### [Remove-AzPolicyExemption](Remove-AzPolicyExemption.md) +Removes a policy exemption. + +### [Remove-AzPolicySetDefinition](Remove-AzPolicySetDefinition.md) +Removes a policy set definition. + +### [Remove-AzPrivateLinkAssociation](Remove-AzPrivateLinkAssociation.md) +Delete a specific azure private link association. + +### [Remove-AzResource](Remove-AzResource.md) +Removes a resource. + +### [Remove-AzResourceGroup](Remove-AzResourceGroup.md) +Removes a resource group. + +### [Remove-AzResourceGroupDeployment](Remove-AzResourceGroupDeployment.md) +Removes a resource group deployment and any associated operations. + +### [Remove-AzResourceLock](Remove-AzResourceLock.md) +Removes a resource lock. + +### [Remove-AzResourceManagementPrivateLink](Remove-AzResourceManagementPrivateLink.md) +Deletes the Resource Manangement Private Link. + +### [Remove-AzRoleAssignment](Remove-AzRoleAssignment.md) +Removes a role assignment to the specified principal who is assigned to a particular role at a particular scope. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /users/{id} +- GET /servicePrincipals/{id} +- GET /groups/{id} +- GET /directoryObjects/{id} +- POST /directoryObjects/getByIds + +Please notice that this cmdlet will mark `ObjectType` as `Unknown` in output if the object of role assignment is not found or current account has insufficient privileges to get object type. + +### [Remove-AzRoleDefinition](Remove-AzRoleDefinition.md) +Deletes a custom role in Azure RBAC. +The role to be deleted is specified using the Id property of the role. +Delete will fail if there are existing role assignments made to the custom role. + +### [Remove-AzRoleManagementPolicy](Remove-AzRoleManagementPolicy.md) +Delete a role management policy + +### [Remove-AzRoleManagementPolicyAssignment](Remove-AzRoleManagementPolicyAssignment.md) +Delete a role management policy assignment + +### [Remove-AzTag](Remove-AzTag.md) +Deletes predefined Azure tags or values | Deletes the entire set of tags on a resource or subscription. + +### [Remove-AzTemplateSpec](Remove-AzTemplateSpec.md) +Removes a Template Spec + +### [Remove-AzTenantDeployment](Remove-AzTenantDeployment.md) +Removes a deployment at tenant scope and any associated operations + +### [Save-AzDeploymentScriptLog](Save-AzDeploymentScriptLog.md) +Saves the log of a deployment script execution to disk. + +### [Save-AzDeploymentTemplate](Save-AzDeploymentTemplate.md) +Saves a deployment template to a file. + +### [Save-AzManagementGroupDeploymentTemplate](Save-AzManagementGroupDeploymentTemplate.md) +Saves a deployment template to a file. + +### [Save-AzResourceGroupDeploymentTemplate](Save-AzResourceGroupDeploymentTemplate.md) +Saves a resource group deployment template to a file. + +### [Save-AzTenantDeploymentTemplate](Save-AzTenantDeploymentTemplate.md) +Saves a deployment template to a file. + +### [Set-AzManagedApplication](Set-AzManagedApplication.md) +Updates managed application + +### [Set-AzManagedApplicationDefinition](Set-AzManagedApplicationDefinition.md) +Updates managed application definition + +### [Set-AzPolicyAssignment](Set-AzPolicyAssignment.md) +Modifies a policy assignment. + +### [Set-AzPolicyDefinition](Set-AzPolicyDefinition.md) +Modifies a policy definition. + +### [Set-AzPolicyExemption](Set-AzPolicyExemption.md) +Modifies a policy exemption. + +### [Set-AzPolicySetDefinition](Set-AzPolicySetDefinition.md) +Modifies a policy set definition + +### [Set-AzResource](Set-AzResource.md) +Modifies a resource. + +### [Set-AzResourceGroup](Set-AzResourceGroup.md) +Modifies a resource group. + +### [Set-AzResourceLock](Set-AzResourceLock.md) +Modifies a resource lock. + +### [Set-AzRoleAssignment](Set-AzRoleAssignment.md) +Update an existing Role Assignment. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /users/{id} +- GET /servicePrincipals/{id} +- GET /groups/{id} +- GET /directoryObjects/{id} +- POST /directoryObjects/getByIds + +Please notice that this cmdlet will mark `ObjectType` as `Unknown` in output if the object of role assignment is not found or current account has insufficient privileges to get object type. + +### [Set-AzRoleDefinition](Set-AzRoleDefinition.md) +Modifies a custom role in Azure RBAC. +Provide the modified role definition either as a JSON file or as a PSRoleDefinition. +First, use the Get-AzRoleDefinition command to retrieve the custom role that you wish to modify. +Then, modify the properties that you wish to change. +Finally, save the role definition using this command. + +### [Set-AzTemplateSpec](Set-AzTemplateSpec.md) +Modifies a Template Spec. + +### [Start-AzTenantBackfill](Start-AzTenantBackfill.md) +Starts backfilling subscriptions for the current Tenant + +### [Stop-AzDeployment](Stop-AzDeployment.md) +Cancel a running deployment + +### [Stop-AzManagementGroupDeployment](Stop-AzManagementGroupDeployment.md) +Cancel a running deployment at a management group + +### [Stop-AzResourceGroupDeployment](Stop-AzResourceGroupDeployment.md) +Cancels a resource group deployment. + +### [Stop-AzRoleAssignmentScheduleRequest](Stop-AzRoleAssignmentScheduleRequest.md) +Cancels a pending role assignment schedule request. + +### [Stop-AzRoleEligibilityScheduleRequest](Stop-AzRoleEligibilityScheduleRequest.md) +Cancels a pending role eligibility schedule request. + +### [Stop-AzTenantDeployment](Stop-AzTenantDeployment.md) +Cancel a running deployment at tenant scope + +### [Test-AzDeployment](Test-AzDeployment.md) +Validates a deployment. + +### [Test-AzManagementGroupDeployment](Test-AzManagementGroupDeployment.md) +Validates a deployment at a management group. + +### [Test-AzResourceGroupDeployment](Test-AzResourceGroupDeployment.md) +Validates a resource group deployment. + +### [Test-AzTenantDeployment](Test-AzTenantDeployment.md) +Validates a deployment at tenant scope. + +### [Unregister-AzProviderFeature](Unregister-AzProviderFeature.md) +Unregisters an Azure provider feature in your account. + +### [Unregister-AzProviderPreviewFeature](Unregister-AzProviderPreviewFeature.md) +Removes a feature registration from your account. + +### [Unregister-AzResourceProvider](Unregister-AzResourceProvider.md) +Unregisters a resource provider. + +### [Update-AzADAppFederatedCredential](Update-AzADAppFederatedCredential.md) +Update the navigation property federatedIdentityCredentials in applications + +### [Update-AzADApplication](Update-AzADApplication.md) +Updates entity in applications + +### [Update-AzADGroup](Update-AzADGroup.md) +Update entity in groups + +### [Update-AzADServicePrincipal](Update-AzADServicePrincipal.md) +Updates entity in service principal + +### [Update-AzADUser](Update-AzADUser.md) +Updates entity in users + +### [Update-AzManagementGroup](Update-AzManagementGroup.md) +Updates a Management Group + +### [Update-AzManagementGroupHierarchySetting](Update-AzManagementGroupHierarchySetting.md) +Updates Hierarchy Settings under the current tenant + +### [Update-AzRoleManagementPolicy](Update-AzRoleManagementPolicy.md) +Update a role management policy + +### [Update-AzTag](Update-AzTag.md) +Selectively updates the set of tags on a resource or subscription. + diff --git a/azps-10.1.0/Az.Resources/Export-AzResourceGroup.md b/azps-10.1.0/Az.Resources/Export-AzResourceGroup.md new file mode 100644 index 0000000000..77958a3af7 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Export-AzResourceGroup.md @@ -0,0 +1,274 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 63BBDF98-75FC-4A44-9FD0-95AD21ED93A6 +online version: https://learn.microsoft.com/powershell/module/az.resources/export-azresourcegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Export-AzResourceGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Export-AzResourceGroup.md +--- + +# Export-AzResourceGroup + +## SYNOPSIS +Captures a resource group as a template and saves it to a file. + +## SYNTAX + +``` +Export-AzResourceGroup -ResourceGroupName <String> [-Path <String>] [-IncludeParameterDefaultValue] + [-IncludeComments] [-SkipResourceNameParameterization] [-SkipAllParameterization] [-Resource <String[]>] + [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Export-AzResourceGroup** cmdlet captures the specified resource group as a template and saves it to a JSON file.This can be useful in scenarios where you have already created some resources in your resource group, and then want to leverage the benefits of using template backed deployments. +This cmdlet gives you an easy start by generating the template for your existing resources in the resource group. +There might be some cases where this cmdlet fails to generate some parts of the template. +Warning messages will inform you of the resources that failed. +The template will still be generated for the parts that were successful. + +## EXAMPLES + +### Example 1: Export a resource group +```powershell +Export-AzResourceGroup -ResourceGroupName "TestGroup" +``` + +This command captures the resource group named TestGroup as a template, and saves it to a JSON file in the current directory. + +### Example 2: Export a single resource from a resource group +```powershell +Export-AzResourceGroup -ResourceGroupName "TestGroup" -Resource "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVirtualMachine" +``` + +This command captures the Virtual Machine resource named "TestVirtualMachine" from the "TestGroup" resource group as a template, and saves it to a JSON file in the current directory. + +### Example 3: Export a selection of resources from a resource group +```powershell +Export-AzResourceGroup -ResourceGroupName "TestGroup" -SkipAllParameterization -Resource @( + "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVm", + "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Network/networkInterfaces/TestNic" +) +``` + +This command captures two resources from the "TestGroup" resource group as a template, and saves it to a JSON file in the current directory. The generated template will not contain any generated parameters. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If not specified, the latest API version is used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeComments +Indicates that this operation exports the template with comments. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeParameterDefaultValue +Indicates that this operation exports the template parameter with the default value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the output path of the template file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet use pre-release API versions when automatically determining which API version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Resource +A list of resourceIds to filter the results by. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to export. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipAllParameterization +Skip all parameterization. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipResourceNameParameterization +Skip resource name parameterization. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS + +[Get-AzResourceGroup](./Get-AzResourceGroup.md) + + diff --git a/azps-10.1.0/Az.Resources/Export-AzTemplateSpec.md b/azps-10.1.0/Az.Resources/Export-AzTemplateSpec.md new file mode 100644 index 0000000000..fb57d2b6a7 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Export-AzTemplateSpec.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/export-aztemplatespec +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Export-AzTemplateSpec.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Export-AzTemplateSpec.md +--- + +# Export-AzTemplateSpec + +## SYNOPSIS +Exports a Template Spec to the local filesystem + +## SYNTAX + +### ExportByNameParameterSet (Default) +``` +Export-AzTemplateSpec [-ResourceGroupName] <String> [-Name] <String> -Version <String> -OutputFolder <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ExportByIdParameterSet +``` +Export-AzTemplateSpec [-ResourceId] <String> -Version <String> -OutputFolder <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Exports a specific Template Spec version to the local filesystem. + +## EXAMPLES + +### Example 1: Export by name +```powershell +Export-AzTemplateSpec -ResourceGroupName 'myRG' -Name 'MyTemplateSpec' -Version 'v1.0' -OutputFolder 'v1' +``` + +Exports version 'v1.0' of the Template Spec named 'MyTemplateSpec' within the resource group 'myRG' to the local output folder "v1". + +### Example 2: Export by resource id +```powershell +Export-AzTemplateSpec -ResourceId '/subscriptions/{subId}/resourceGroups/myRG/providers/Microsoft.Resources/templateSpecs/MyTemplateSpec' -Version 'v1.0' -OutputFolder 'v1' +``` + +Exports version 'v1.0' of the Template Spec named 'MyTemplateSpec' within the resource group 'myRG' of subscription \{subId\} to the local output folder "v1". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the template spec. + +```yaml +Type: System.String +Parameter Sets: ExportByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OutputFolder +The path to the folder where the template spec version will be output to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the template spec's resource group. + +```yaml +Type: System.String +Parameter Sets: ExportByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The fully qualified resource Id of the template spec. +Example: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName} + +```yaml +Type: System.String +Parameter Sets: ExportByIdParameterSet +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +The version of the template spec to export. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzADAppCredential.md b/azps-10.1.0/Az.Resources/Get-AzADAppCredential.md new file mode 100644 index 0000000000..28333ac6b3 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzADAppCredential.md @@ -0,0 +1,429 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azadappcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADAppCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADAppCredential.md +--- + +# Get-AzADAppCredential + +## SYNOPSIS +Lists key credentials and password credentials for an application. + +## SYNTAX + +### ApplicationObjectIdParameterSet (Default) +``` +Get-AzADAppCredential -ObjectId <String> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationIdParameterSet +``` +Get-AzADAppCredential -ApplicationId <Guid> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DisplayNameParameterSet +``` +Get-AzADAppCredential -DisplayName <String> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ApplicationObjectParameterSet +``` +Get-AzADAppCredential -ApplicationObject <IMicrosoftGraphApplication> [-DefaultProfile <PSObject>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Lists key credentials and password credentials for an application. + +## EXAMPLES + +### Example 1: List credentials from application by display name +```powershell +Get-AzADAppCredential -DisplayName $name +``` + +List credentials from application by display name + +## PARAMETERS + +### -ApplicationId +The application Id. + +```yaml +Type: System.Guid +Parameter Sets: ApplicationIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationObject +The application object, could be used as pipeline input. +To construct, see NOTES section for APPLICATIONOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication +Parameter Sets: ApplicationObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name of application. + +```yaml +Type: System.String +Parameter Sets: DisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The object Id of application. + +```yaml +Type: System.String +Parameter Sets: ApplicationObjectIdParameterSet +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphKeyCredential + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordCredential + +## 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. + + +APPLICATIONOBJECT <IMicrosoftGraphApplication>: The application object, could be used as pipeline input. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzADAppFederatedCredential.md b/azps-10.1.0/Az.Resources/Get-AzADAppFederatedCredential.md new file mode 100644 index 0000000000..160eb54e16 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzADAppFederatedCredential.md @@ -0,0 +1,509 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azadappfederatedcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADAppFederatedCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADAppFederatedCredential.md +--- + +# Get-AzADAppFederatedCredential + +## SYNOPSIS +Get federatedIdentityCredentials by Id from applications. + +## SYNTAX + +### ListByApplicationObjectId (Default) +``` +Get-AzADAppFederatedCredential -ApplicationObjectId <String> [-Expand <String[]>] [-Select <String[]>] [-Count] + [-Filter <String>] [-Orderby <String[]>] [-Search <String>] [-First <UInt64>] [-Skip <UInt64>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetByApplicationObjectId +``` +Get-AzADAppFederatedCredential -ApplicationObjectId <String> -FederatedCredentialId <String> + [-Expand <String[]>] [-Select <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetByApplicationObject +``` +Get-AzADAppFederatedCredential -FederatedCredentialId <String> -ApplicationObject <MicrosoftGraphApplication> + [-Expand <String[]>] [-Select <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ListByApplicationObject +``` +Get-AzADAppFederatedCredential -ApplicationObject <MicrosoftGraphApplication> [-Expand <String[]>] + [-Select <String[]>] [-Count] [-Filter <String>] [-Orderby <String[]>] [-Search <String>] [-First <UInt64>] + [-Skip <UInt64>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get federatedIdentityCredentials by Id from applications. + +## EXAMPLES + +### Example 1: List federated identity credentials for application +```powershell +Get-AzADApplication -ObjectId $app | Get-AzADAppFederatedCredential +``` + +List federated identity credentials for application + +### Example 2: Get federated identity credential by id +```powershell +Get-AzADAppFederatedCredential -ApplicationObjectId $appObjectId -FederatedCredentialId $credentialId +``` + +Get federated identity credential by id + +## PARAMETERS + +### -ApplicationObject +application object +To construct, see NOTES section for APPLICATIONOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphApplication +Parameter Sets: GetByApplicationObject, ListByApplicationObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationObjectId +key: id of application + +```yaml +Type: System.String +Parameter Sets: ListByApplicationObjectId, GetByApplicationObjectId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +Include count of items + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ListByApplicationObjectId, ListByApplicationObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Expand related entities + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedCredentialId +key: id of federatedIdentityCredential + +```yaml +Type: System.String +Parameter Sets: GetByApplicationObjectId, GetByApplicationObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter items by property values, for more detail about filter query please see: https://learn.microsoft.com/en-us/graph/filter-query-parameter + +```yaml +Type: System.String +Parameter Sets: ListByApplicationObjectId, ListByApplicationObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orderby +Order items by property values + +```yaml +Type: System.String[] +Parameter Sets: ListByApplicationObjectId, ListByApplicationObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Search +Search items by search phrases + +```yaml +Type: System.String +Parameter Sets: ListByApplicationObjectId, ListByApplicationObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Select properties to be returned + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Ignores the first 'n' objects and then gets the remaining objects. + +```yaml +Type: System.UInt64 +Parameter Sets: ListByApplicationObjectId, ListByApplicationObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Gets only the first 'n' objects. + +```yaml +Type: System.UInt64 +Parameter Sets: ListByApplicationObjectId, ListByApplicationObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphFederatedIdentityCredential + +## 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. + + +APPLICATIONOBJECT <MicrosoftGraphApplication>: application object + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzADAppPermission.md b/azps-10.1.0/Az.Resources/Get-AzADAppPermission.md new file mode 100644 index 0000000000..9700830169 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzADAppPermission.md @@ -0,0 +1,106 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azadapppermission +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADAppPermission.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADAppPermission.md +--- + +# Get-AzADAppPermission + +## SYNOPSIS +Lists API permissions the application has requested. + +## SYNTAX + +### ObjectIdParameterSet (Default) +``` +Get-AzADAppPermission -ObjectId <Guid> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### AppIdParameterSet +``` +Get-AzADAppPermission -ApplicationId <Guid> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists API permissions the application has requested. + +## EXAMPLES + +### Example 1: Get API permission +```powershell +Get-AzADAppPermission -ObjectId 18797549-86a9-4906-b2a9-54f08cd3c427 +``` + +```output +ApiId Id Type +----- -- ---- +00000003-0000-0000-c000-000000000000 df021288-bdef-4463-88db-98f22de89214 Scope +00000003-0000-0000-c000-000000000000 5b567255-7703-4780-807c-7be8301ae99b Scope +``` + +Fetches all API permissions of Azure AD object 18797549-86a9-4906-b2a9-54f08cd3c427 + +## PARAMETERS + +### -ApplicationId +The application Id. + +```yaml +Type: System.Guid +Parameter Sets: AppIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The object Id of application. + +```yaml +Type: System.Guid +Parameter Sets: ObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.MicrosoftGraphApplicationApiPermission + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzADApplication.md b/azps-10.1.0/Az.Resources/Get-AzADApplication.md new file mode 100644 index 0000000000..a6f72b4ea7 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzADApplication.md @@ -0,0 +1,387 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azadapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADApplication.md +--- + +# Get-AzADApplication + +## SYNOPSIS +Lists entities from applications or get entity from applications by key + +## SYNTAX + +### EmptyParameterSet (Default) +``` +Get-AzADApplication [-Select <String[]>] [-Count] [-Filter <String>] [-Orderby <String[]>] [-Search <String>] + [-ConsistencyLevel <String>] [-First <UInt64>] [-Skip <UInt64>] [-AppendSelected] [-DefaultProfile <PSObject>] + [-CountVariable <String>] [<CommonParameters>] +``` + +### ApplicationObjectIdParameterSet +``` +Get-AzADApplication -ObjectId <String> [-Select <String[]>] [-First <UInt64>] [-Skip <UInt64>] + [-AppendSelected] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### OwnedApplicationParameterSet +``` +Get-AzADApplication [-OwnedApplication] [-Select <String[]>] [-Orderby <String[]>] [-First <UInt64>] + [-Skip <UInt64>] [-AppendSelected] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### SearchStringParameterSet +``` +Get-AzADApplication [-Select <String[]>] -DisplayNameStartWith <String> [-First <UInt64>] [-Skip <UInt64>] + [-AppendSelected] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### DisplayNameParameterSet +``` +Get-AzADApplication [-Select <String[]>] -DisplayName <String> [-First <UInt64>] [-Skip <UInt64>] + [-AppendSelected] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ApplicationIdParameterSet +``` +Get-AzADApplication [-Select <String[]>] -ApplicationId <Guid> [-First <UInt64>] [-Skip <UInt64>] + [-AppendSelected] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ApplicationIdentifierUriParameterSet +``` +Get-AzADApplication [-Select <String[]>] -IdentifierUri <String> [-First <UInt64>] [-Skip <UInt64>] + [-AppendSelected] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists entities from applications or get entity from applications by key + +## EXAMPLES + +### Example 1: Get application by display name +```powershell +Get-AzADApplication -DisplayName $appname +``` + +Get application by display name + +### Example 2: List applications +```powershell +Get-AzADApplication -First 10 +``` + +List first 10 applications + +### Example 3: Search for application display name starts with +```powershell +Get-AzADApplication -DisplayNameStartsWith $prefix +``` + +Search for application display name starts with + +### Example 4: Get application by object Id +```powershell +Get-AzADApplication -ObjectId $id -Select Tags -AppendSelected +``` + +Get application by object Id and append property 'Tags' after default properties: 'DisplayName', 'Id', 'DeletedDateTime', 'IdentifierUris', 'Web', 'AppId', 'SignInAudience' + +### Example 5: Get applications owned by current user +```powershell +Get-AzADApplication -OwnedApplication +``` + +Get applications owned by current user + +### Example 6: Get applications with filter +```powershell +Get-AzADApplication -Filter "startsWith(DisplayName,'some-name')" +``` + +Get applications with filter + +### Example 7: Assign OdataCount to a variable +```powershell +Get-AzADApplication -First 10 -ConsistencyLevel eventual -Count -CountVariable 'result' +$result +``` + +Assign OdataCount to a variable + +## PARAMETERS + +### -AppendSelected +Append properties selected with default properties when this switch is on, only works with parameter '-Select'. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +application id + +```yaml +Type: System.Guid +Parameter Sets: ApplicationIdParameterSet +Aliases: AppId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsistencyLevel +Indicates the requested consistency level. +Documentation URL: https://developer.microsoft.com/en-us/office/blogs/microsoft-graph-advanced-queries-for-directory-objects-are-now-generally-available/ + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +Include count of items + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountVariable +Specifies a count of the total number of items in a collection. +By default, this variable will be set in the global scope. + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +application display name + +```yaml +Type: System.String +Parameter Sets: DisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayNameStartWith +application display name starts with + +```yaml +Type: System.String +Parameter Sets: SearchStringParameterSet +Aliases: DisplayNameStartsWith + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter items by property values, for more detail about filter query please see: https://learn.microsoft.com/en-us/graph/filter-query-parameter + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentifierUri +application identifier uri + +```yaml +Type: System.String +Parameter Sets: ApplicationIdentifierUriParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +key: id of application + +```yaml +Type: System.String +Parameter Sets: ApplicationObjectIdParameterSet +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orderby +Order items by property values + +```yaml +Type: System.String[] +Parameter Sets: EmptyParameterSet, OwnedApplicationParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnedApplication +get owned application + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: OwnedApplicationParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Search +Search items by search phrases + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Select properties to be returned + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Ignores the first 'n' objects and then gets the remaining objects. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Gets only the first 'n' objects. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzADGroup.md b/azps-10.1.0/Az.Resources/Get-AzADGroup.md new file mode 100644 index 0000000000..7e7c2ebe2f --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzADGroup.md @@ -0,0 +1,326 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azadgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADGroup.md +--- + +# Get-AzADGroup + +## SYNOPSIS +Lists entities from groups or get entity from groups by key + +## SYNTAX + +### EmptyParameterSet (Default) +``` +Get-AzADGroup [-Count] [-Expand <String[]>] [-Select <String[]>] [-Filter <String>] [-Orderby <String[]>] + [-Search <String>] [-ConsistencyLevel <String>] [-First <UInt64>] [-Skip <UInt64>] [-AppendSelected] + [-DefaultProfile <PSObject>] [-CountVariable <String>] [<CommonParameters>] +``` + +### DisplayNameParameterSet +``` +Get-AzADGroup [-Expand <String[]>] [-Select <String[]>] [-ConsistencyLevel <String>] [-First <UInt64>] + [-Skip <UInt64>] [-AppendSelected] -DisplayName <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### SearchStringParameterSet +``` +Get-AzADGroup [-Expand <String[]>] [-Select <String[]>] [-ConsistencyLevel <String>] [-First <UInt64>] + [-Skip <UInt64>] [-AppendSelected] -DisplayNameStartsWith <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### ObjectIdParameterSet +``` +Get-AzADGroup [-Expand <String[]>] [-Select <String[]>] [-ConsistencyLevel <String>] [-AppendSelected] + -ObjectId <Guid> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists entities from groups or get entity from groups by key + +## EXAMPLES + +### Example 1: Get group by display name +```powershell +Get-AzADGroup -DisplayName $gname +``` + +Get group by display name + +### Example 2: List groups +```powershell +Get-AzADGroup -First 10 +``` + +List first 10 groups + +### Example 3: Get group by object id +```powershell +Get-AzADGroup -ObjectId $id -Select groupTypes -AppendSelected +``` + +Get group by object id and append property 'groupTypes' after default properties: 'DisplayName', 'Id', 'DeletedDateTime', 'SecurityEnabled', 'MailEnabled', 'MailNickname', 'Description' + +### Example 4: Get group with filter +```powershell +Get-AzADGroup -Filter "startsWith(DisplayName,'some-name')" +``` + +Get group with filter + +### Example 5: Assign OdataCount to a variable +```powershell +Get-AzADGroup -First 10 -ConsistencyLevel eventual -Count -CountVariable 'result' +$result +``` + +Assign OdataCount to a variable + +## PARAMETERS + +### -AppendSelected +Append properties selected with default properties when this switch is on, only works with parameter '-Select'. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsistencyLevel +Indicates the requested consistency level. +Documentation URL: https://developer.microsoft.com/en-us/office/blogs/microsoft-graph-advanced-queries-for-directory-objects-are-now-generally-available/ + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +Include count of items + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountVariable +Specifies a count of the total number of items in a collection. +By default, this variable will be set in the global scope. + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name of the group. + +```yaml +Type: System.String +Parameter Sets: DisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayNameStartsWith +Used to find groups that begin with the provided string. + +```yaml +Type: System.String +Parameter Sets: SearchStringParameterSet +Aliases: SearchString + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Expand related entities + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter items by property values, for more detail about filter query please see: https://learn.microsoft.com/en-us/graph/filter-query-parameter + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +key: id of group + +```yaml +Type: System.Guid +Parameter Sets: ObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orderby +Order items by property values + +```yaml +Type: System.String[] +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Search +Search items by search phrases + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Select properties to be returned + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Ignores the first 'n' objects and then gets the remaining objects. + +```yaml +Type: System.UInt64 +Parameter Sets: EmptyParameterSet, DisplayNameParameterSet, SearchStringParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Gets only the first 'n' objects. + +```yaml +Type: System.UInt64 +Parameter Sets: EmptyParameterSet, DisplayNameParameterSet, SearchStringParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzADGroupMember.md b/azps-10.1.0/Az.Resources/Get-AzADGroupMember.md new file mode 100644 index 0000000000..cf2cd715d1 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzADGroupMember.md @@ -0,0 +1,575 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azadgroupmember +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADGroupMember.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADGroupMember.md +--- + +# Get-AzADGroupMember + +## SYNOPSIS +Lists members from group. + +## SYNTAX + +### ObjectIdParameterSet (Default) +``` +Get-AzADGroupMember -GroupObjectId <String> [-Expand <String[]>] [-Filter <String>] [-Orderby <String[]>] + [-Search <String>] [-Select <String[]>] [-First <UInt64>] [-Skip <UInt64>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### DisplayNameParameterSet +``` +Get-AzADGroupMember [-Expand <String[]>] [-Filter <String>] [-Orderby <String[]>] [-Search <String>] + [-Select <String[]>] [-First <UInt64>] [-Skip <UInt64>] -GroupDisplayName <String> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GroupObjectParameterSet +``` +Get-AzADGroupMember [-Expand <String[]>] [-Filter <String>] [-Orderby <String[]>] [-Search <String>] + [-Select <String[]>] [-First <UInt64>] [-Skip <UInt64>] -GroupObject <IMicrosoftGraphGroup> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists members from group. + +## EXAMPLES + +### Example 1: List members by group display name +```powershell +Get-AzADGroupMember -GroupDisplayName $name +``` + +List members by group display name + +### Example 2: List members by pipeline input +```powershell +Get-AzADGroup -DisplayName $name | Get-AzADGroupMember +``` + +List members by pipeline input + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Expand related entities + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter items by property values, for more detail about filter query please see: https://learn.microsoft.com/en-us/graph/filter-query-parameter + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupDisplayName +The display name of target group. + +```yaml +Type: System.String +Parameter Sets: DisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupObject +The target group object, could be used as pipeline input. +To construct, see NOTES section for GROUPOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup +Parameter Sets: GroupObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -GroupObjectId +The object Id of target group. + +```yaml +Type: System.String +Parameter Sets: ObjectIdParameterSet +Aliases: Id, ObjectId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orderby +Order items by property values + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Search +Search items by search phrases + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Select properties to be returned + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Ignores the first 'n' objects and then gets the remaining objects. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Gets only the first 'n' objects. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphDirectoryObject + +## 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. + + +GROUPOBJECT <IMicrosoftGraphGroup>: The target group object, could be used as pipeline input. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]`: Represents the app roles a group has been granted for an application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[CreatedDateTime <DateTime?>]`: The time when the app role assignment was created.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[PrincipalDisplayName <String>]`: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith). + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[PrincipalType <String>]`: The type of the assigned principal. This can either be User, Group or ServicePrincipal. Read-only. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[Classification <String>]`: Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[AccountEnabled <Boolean?>]`: true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in). + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. + - `[AlternativeName <String[]>]`: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, NOT, ge, le, startsWith). + - `[AppDescription <String>]`: The description exposed by the associated application. + - `[AppDisplayName <String>]`: The display name exposed by the associated application. + - `[AppId <String>]`: The unique identifier for the associated application (its appId property). + - `[AppOwnerOrganizationId <String>]`: Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le). + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. + - `[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignment for another app or service, granted to this service principal. Supports $expand. + - `[AppRoleAssignmentRequired <Boolean?>]`: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT). + - `[ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]`: The claimsMappingPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]`: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. + - `[Classification <String>]`: permissionClassificationType + - `[PermissionId <String>]`: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter. + - `[PermissionName <String>]`: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Does not support $filter. + - `[Description <String>]`: Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[Endpoint <IMicrosoftGraphEndpoint[]>]`: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. + - `[Homepage <String>]`: Home page or landing page of the application. + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[LoginUrl <String>]`: Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. + - `[Note <String>]`: Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters. + - `[NotificationEmailAddress <String[]>]`: Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the service principal. Not nullable. + - `[PreferredSingleSignOnMode <String>]`: Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc. + - `[PreferredTokenSigningKeyThumbprint <String>]`: Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions. + - `[ReplyUrl <String[]>]`: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. + - `[SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]`: samlSingleSignOnSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RelayState <String>]`: The relative URI the service provider would redirect to after completion of the single sign-on flow. + - `[ServicePrincipalName <String[]>]`: Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[ServicePrincipalType <String>]`: Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: The tokenIssuancePolicies assigned to this service principal. Supports $expand. + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this service principal. Supports $expand. + - `[TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]`: + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]`: Represents the app roles a group has been granted for an application. Supports $expand. + - `[Classification <String>]`: Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[Description <String>]`: An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[GroupType <String[]>]`: Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT). + - `[HasMembersWithLicenseError <Boolean?>]`: Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). Supports $filter (eq). + - `[IsArchived <Boolean?>]`: + - `[IsAssignableToRole <Boolean?>]`: Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must also be assigned the Directory.AccessAsUser.All permission to set this property. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT). + - `[MailEnabled <Boolean?>]`: Specifies whether the group is mail-enabled. Returned by default. Supports $filter (eq, ne, NOT). + - `[MailNickname <String>]`: The mail alias for the group, unique in the organization. This property must be specified when a group is created. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[MembershipRule <String>]`: The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[MembershipRuleProcessingState <String>]`: Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]`: The permissions that have been granted for a group to a specific application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[ClientAppId <String>]`: ID of the service principal of the Azure AD app that has been granted access. Read-only. + - `[ClientId <String>]`: ID of the Azure AD app that has been granted access. Read-only. + - `[Permission <String>]`: The name of the resource-specific permission. Read-only. + - `[PermissionType <String>]`: The type of permission. Possible values are: Application, Delegated. Read-only. + - `[ResourceAppId <String>]`: ID of the Azure AD app that is hosting the resource. Read-only. + - `[PreferredDataLocation <String>]`: The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default. + - `[PreferredLanguage <String>]`: The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[SecurityEnabled <Boolean?>]`: Specifies whether the group is a security group. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[SecurityIdentifier <String>]`: Security identifier of the group, used in Windows scenarios. Returned by default. + - `[Theme <String>]`: Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default. + - `[Visibility <String>]`: Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. + - `[Description <String>]`: An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[GroupType <String[]>]`: Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT). + - `[HasMembersWithLicenseError <Boolean?>]`: Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). Supports $filter (eq). + - `[IsArchived <Boolean?>]`: + - `[IsAssignableToRole <Boolean?>]`: Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must also be assigned the Directory.AccessAsUser.All permission to set this property. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT). + - `[MailEnabled <Boolean?>]`: Specifies whether the group is mail-enabled. Returned by default. Supports $filter (eq, ne, NOT). + - `[MailNickname <String>]`: The mail alias for the group, unique in the organization. This property must be specified when a group is created. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[MembershipRule <String>]`: The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[MembershipRuleProcessingState <String>]`: Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]`: The permissions that have been granted for a group to a specific application. Supports $expand. + - `[PreferredDataLocation <String>]`: The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default. + - `[PreferredLanguage <String>]`: The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[SecurityEnabled <Boolean?>]`: Specifies whether the group is a security group. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[SecurityIdentifier <String>]`: Security identifier of the group, used in Windows scenarios. Returned by default. + - `[Theme <String>]`: Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default. + - `[Visibility <String>]`: Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzADOrganization.md b/azps-10.1.0/Az.Resources/Get-AzADOrganization.md new file mode 100644 index 0000000000..d6928ad049 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzADOrganization.md @@ -0,0 +1,187 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azadorganization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADOrganization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADOrganization.md +--- + +# Get-AzADOrganization + +## SYNOPSIS +Retrieve a list of organization objects. + +## SYNTAX + +``` +Get-AzADOrganization [-Count] [-Expand <String[]>] [-Filter <String>] [-Orderby <String[]>] [-Search <String>] + [-Select <String[]>] [-First <UInt64>] [-Skip <UInt64>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve a list of organization objects. + +## EXAMPLES + +### Example 1: Get organization for current user +```powershell +Get-AzADOrganization +``` + +Get organization for current user + +## PARAMETERS + +### -Count +Include count of items + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Expand related entities + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter items by property values + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orderby +Order items by property values + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Search +Search items by search phrases + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Select properties to be returned + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Ignores the first 'n' objects and then gets the remaining objects. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Gets only the first 'n' objects. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphOrganization + +## NOTES + +ALIASES + +## RELATED LINKS + +[Find more info here](https://learn.microsoft.com/graph/api/organization-list?view=graph-rest-1.0) + diff --git a/azps-10.1.0/Az.Resources/Get-AzADServicePrincipal.md b/azps-10.1.0/Az.Resources/Get-AzADServicePrincipal.md new file mode 100644 index 0000000000..2ba19ab62e --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzADServicePrincipal.md @@ -0,0 +1,641 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azadserviceprincipal +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADServicePrincipal.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADServicePrincipal.md +--- + +# Get-AzADServicePrincipal + +## SYNOPSIS +Lists entities from service principals or get entity from service principals by key + +## SYNTAX + +### EmptyParameterSet (Default) +``` +Get-AzADServicePrincipal [-Select <String[]>] [-Count] [-Filter <String>] [-Orderby <String[]>] + [-Search <String>] [-ConsistencyLevel <String>] [-First <UInt64>] [-Skip <UInt64>] [-AppendSelected] + [-DefaultProfile <PSObject>] [-CountVariable <String>] [<CommonParameters>] +``` + +### ObjectIdParameterSet +``` +Get-AzADServicePrincipal -ObjectId <String> [-Select <String[]>] [-First <UInt64>] [-Skip <UInt64>] + [-AppendSelected] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### SearchStringParameterSet +``` +Get-AzADServicePrincipal [-Select <String[]>] -DisplayNameBeginsWith <String> [-First <UInt64>] + [-Skip <UInt64>] [-AppendSelected] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### DisplayNameParameterSet +``` +Get-AzADServicePrincipal [-Select <String[]>] -DisplayName <String> [-First <UInt64>] [-Skip <UInt64>] + [-AppendSelected] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ApplicationIdParameterSet +``` +Get-AzADServicePrincipal [-Select <String[]>] -ApplicationId <Guid> [-First <UInt64>] [-Skip <UInt64>] + [-AppendSelected] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### ApplicationObjectParameterSet +``` +Get-AzADServicePrincipal [-Select <String[]>] -ApplicationObject <IMicrosoftGraphApplication> [-First <UInt64>] + [-Skip <UInt64>] [-AppendSelected] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### SPNParameterSet +``` +Get-AzADServicePrincipal [-Select <String[]>] -ServicePrincipalName <String> [-First <UInt64>] [-Skip <UInt64>] + [-AppendSelected] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists entities from service principals or get entity from service principals by key + +## EXAMPLES + +### Example 1: Get service principal by display name +```powershell +Get-AzADServicePrincipal -DisplayName $name +``` + +Get service principal by display name + +### Example 2: Search for service principal display name starts with +```powershell +Get-AzADServicePrincipal -DisplayNameStartsWith $prefix +``` + +Search for service principal display name starts with + +### Example 3: List service principals +```powershell +Get-AzADServicePrincipal -First 10 -Select Tags -AppendSelected +``` + +List first 10 service principals and append property 'Tags' after default properties: 'DisplayName', 'Id', 'DeletedDateTime', 'ServicePrincipalNames', 'AppId' + +### Example 4: Get service principal by application Id +```powershell +Get-AzADServicePrincipal -ApplicationId $appId +``` + +Get service principal by application Id + +### Example 5: Get service principal by pipeline input +```powershell +Get-AzADApplication -DisplayName $name | Get-AzADServicePrincipal +``` + +Get service principal by pipeline input + +### Example 6: Get service principal with filter +```powershell +Get-AzADServicePrincipal -Filter "startsWith(DisplayName,'some-name')" +``` + +Get service principal with filter + +### Example 7: Assign OdataCount to a variable +```powershell +Get-AzADServicePrincipal -First 10 -ConsistencyLevel eventual -Count -CountVariable 'result' +$result +``` + +Assign OdataCount to a variable + +## PARAMETERS + +### -AppendSelected +Append properties selected with default properties when this switch is on, only works with parameter '-Select'. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +application id of serviceprincipal + +```yaml +Type: System.Guid +Parameter Sets: ApplicationIdParameterSet +Aliases: AppId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationObject +The service principal object, could be used as pipeline input. +To construct, see NOTES section for APPLICATIONOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication +Parameter Sets: ApplicationObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ConsistencyLevel +Indicates the requested consistency level. +Documentation URL: https://developer.microsoft.com/en-us/office/blogs/microsoft-graph-advanced-queries-for-directory-objects-are-now-generally-available/ + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +Include count of items + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountVariable +Specifies a count of the total number of items in a collection. +By default, this variable will be set in the global scope. + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +serviceprincipal display name + +```yaml +Type: System.String +Parameter Sets: DisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayNameBeginsWith +serviceprincipal display name starts with + +```yaml +Type: System.String +Parameter Sets: SearchStringParameterSet +Aliases: DisplayNameStartsWith, SearchString + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter items by property values, for more detail about filter query please see: https://learn.microsoft.com/en-us/graph/filter-query-parameter + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +key: id of servicePrincipal + +```yaml +Type: System.String +Parameter Sets: ObjectIdParameterSet +Aliases: ServicePrincipalId, Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orderby +Order items by property values + +```yaml +Type: System.String[] +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Search +Search items by search phrases + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Select properties to be returned + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalName +serviceprincipal name + +```yaml +Type: System.String +Parameter Sets: SPNParameterSet +Aliases: SPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Ignores the first 'n' objects and then gets the remaining objects. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Gets only the first 'n' objects. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal + +## 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. + + +APPLICATIONOBJECT <IMicrosoftGraphApplication>: The service principal object, could be used as pipeline input. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzADSpCredential.md b/azps-10.1.0/Az.Resources/Get-AzADSpCredential.md new file mode 100644 index 0000000000..c2081575b9 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzADSpCredential.md @@ -0,0 +1,457 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azadspcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADSpCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADSpCredential.md +--- + +# Get-AzADSpCredential + +## SYNOPSIS +Lists key credentials and password credentials for an service principal. + +## SYNTAX + +### ObjectIdParameterSet (Default) +``` +Get-AzADSpCredential -ObjectId <String> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SPNParameterSet +``` +Get-AzADSpCredential -ServicePrincipalName <String> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DisplayNameParameterSet +``` +Get-AzADSpCredential -DisplayName <String> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SPNObjectParameterSet +``` +Get-AzADSpCredential -ServicePrincipalObject <IMicrosoftGraphServicePrincipal> [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Lists key credentials and password credentials for an service principal. + +## EXAMPLES + +### Example 1: List credentials from service principal by display name +```powershell +Get-AzADSpCredential -DisplayName $name +``` + +List credentials from service principal by display name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display name of the service principal. + +```yaml +Type: System.String +Parameter Sets: DisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The object Id of service principal. + +```yaml +Type: System.String +Parameter Sets: ObjectIdParameterSet +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalName +The service principal name. + +```yaml +Type: System.String +Parameter Sets: SPNParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalObject +The service principal object, could be used as pipeline input. +To construct, see NOTES section for SERVICEPRINCIPALOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal +Parameter Sets: SPNObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphKeyCredential + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordCredential + +## NOTES + +ALIASES + +Get-AzADServicePrincipalCredential + +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. + + +SERVICEPRINCIPALOBJECT <IMicrosoftGraphServicePrincipal>: The service principal object, could be used as pipeline input. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AccountEnabled <Boolean?>]`: true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in). + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[AlternativeName <String[]>]`: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, NOT, ge, le, startsWith). + - `[AppDescription <String>]`: The description exposed by the associated application. + - `[AppDisplayName <String>]`: The display name exposed by the associated application. + - `[AppId <String>]`: The unique identifier for the associated application (its appId property). + - `[AppOwnerOrganizationId <String>]`: Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le). + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignment for another app or service, granted to this service principal. Supports $expand. + - `[AppRoleAssignmentRequired <Boolean?>]`: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT). + - `[ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]`: The claimsMappingPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]`: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. + - `[Classification <String>]`: permissionClassificationType + - `[PermissionId <String>]`: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter. + - `[PermissionName <String>]`: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Does not support $filter. + - `[Description <String>]`: Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[Endpoint <IMicrosoftGraphEndpoint[]>]`: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. + - `[Homepage <String>]`: Home page or landing page of the application. + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[LoginUrl <String>]`: Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. + - `[Note <String>]`: Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters. + - `[NotificationEmailAddress <String[]>]`: Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the service principal. Not nullable. + - `[PreferredSingleSignOnMode <String>]`: Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc. + - `[PreferredTokenSigningKeyThumbprint <String>]`: Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions. + - `[ReplyUrl <String[]>]`: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. + - `[SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]`: samlSingleSignOnSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RelayState <String>]`: The relative URI the service provider would redirect to after completion of the single sign-on flow. + - `[ServicePrincipalName <String[]>]`: Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[ServicePrincipalType <String>]`: Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: The tokenIssuancePolicies assigned to this service principal. Supports $expand. + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this service principal. Supports $expand. + - `[TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]`: + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzADUser.md b/azps-10.1.0/Az.Resources/Get-AzADUser.md new file mode 100644 index 0000000000..33d9f8a317 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzADUser.md @@ -0,0 +1,388 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azaduser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzADUser.md +--- + +# Get-AzADUser + +## SYNOPSIS +Lists entities from users or get entity from users by key + +## SYNTAX + +### List (Default) +``` +Get-AzADUser [-Count] [-Expand <String[]>] [-Select <String[]>] [-First <UInt64>] [-Skip <UInt64>] + [-AppendSelected] [-Filter <String>] [-Orderby <String[]>] [-Search <String>] [-ConsistencyLevel <String>] + [-DefaultProfile <PSObject>] [-CountVariable <String>] [<CommonParameters>] +``` + +### MailParameterSet +``` +Get-AzADUser [-Expand <String[]>] [-Select <String[]>] [-First <UInt64>] [-Skip <UInt64>] [-AppendSelected] + [-DefaultProfile <PSObject>] -Mail <String> [<CommonParameters>] +``` + +### DisplayNameParameterSet +``` +Get-AzADUser [-Expand <String[]>] [-Select <String[]>] [-First <UInt64>] [-Skip <UInt64>] [-AppendSelected] + [-DefaultProfile <PSObject>] -DisplayName <String> [<CommonParameters>] +``` + +### StartsWithParameterSet +``` +Get-AzADUser [-Expand <String[]>] [-Select <String[]>] [-First <UInt64>] [-Skip <UInt64>] [-AppendSelected] + [-DefaultProfile <PSObject>] -StartsWith <String> [<CommonParameters>] +``` + +### ObjectIdParameterSet +``` +Get-AzADUser [-Expand <String[]>] [-Select <String[]>] [-AppendSelected] [-DefaultProfile <PSObject>] + -ObjectId <String> [<CommonParameters>] +``` + +### UPNParameterSet +``` +Get-AzADUser [-Expand <String[]>] [-Select <String[]>] [-AppendSelected] [-DefaultProfile <PSObject>] + -UserPrincipalName <String> [<CommonParameters>] +``` + +### SignedInUser +``` +Get-AzADUser [-Expand <String[]>] [-Select <String[]>] [-AppendSelected] [-DefaultProfile <PSObject>] + [-SignedIn] [<CommonParameters>] +``` + +## DESCRIPTION +Lists entities from users or get entity from users by key + +## EXAMPLES + +### Example 1: Get signin user +```powershell +Get-AzADUser -SignedIn +``` + +Get signin user + +### Example 2: List users +```powershell +Get-AzADUser -First 10 -Select 'City' -AppendSelected +``` + +List first 10 users and append property 'City' after default properties: 'DisplayName', 'Id', 'DeletedDateTime', 'UserPrincipalName', 'UsageLocation', 'GivenName', 'SurName', 'AccountEnabled', 'MailNickName', 'Mail' + +### Example 3: Get user by display name +```powershell +Get-AzADUser -DisplayName $name +``` + +Get user by display name + +### Example 4: Get user with filter +```powershell +Get-AzADUser -Filter "startsWith(DisplayName,'some-name')" +``` + +Get user with filter + +### Example 5: Assign OdataCount to a variable +```powershell +Get-AzADUser -First 10 -ConsistencyLevel eventual -Count -CountVariable 'result' +$result +``` + +Assign OdataCount to a variable + +## PARAMETERS + +### -AppendSelected +Append properties selected with default properties when this switch is on, only works with parameter '-Select'. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsistencyLevel +Indicates the requested consistency level. +Documentation URL: https://developer.microsoft.com/en-us/office/blogs/microsoft-graph-advanced-queries-for-directory-objects-are-now-generally-available/ + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +Include count of items + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountVariable +Specifies a count of the total number of items in a collection. +By default, this variable will be set in the global scope. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +user display name + +```yaml +Type: System.String +Parameter Sets: DisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Expand related entities + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter items by property values, for more detail about filter query please see: https://learn.microsoft.com/en-us/graph/filter-query-parameter + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mail +user mail address + +```yaml +Type: System.String +Parameter Sets: MailParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +key: id of user + +```yaml +Type: System.String +Parameter Sets: ObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orderby +Order items by property values + +```yaml +Type: System.String[] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Search +Search items by search phrases + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +Select properties to be returned + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignedIn +user mail address + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SignedInUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartsWith +user display name starts with + +```yaml +Type: System.String +Parameter Sets: StartsWithParameterSet +Aliases: SearchString + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +user principal name + +```yaml +Type: System.String +Parameter Sets: UPNParameterSet +Aliases: UPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Ignores the first 'n' objects and then gets the remaining objects. + +```yaml +Type: System.UInt64 +Parameter Sets: List, MailParameterSet, DisplayNameParameterSet, StartsWithParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Gets only the first 'n' objects. + +```yaml +Type: System.UInt64 +Parameter Sets: List, MailParameterSet, DisplayNameParameterSet, StartsWithParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphUser + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzDenyAssignment.md b/azps-10.1.0/Az.Resources/Get-AzDenyAssignment.md new file mode 100644 index 0000000000..98f5e897ad --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzDenyAssignment.md @@ -0,0 +1,581 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azdenyassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzDenyAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzDenyAssignment.md +--- + +# Get-AzDenyAssignment + +## SYNOPSIS +Lists Azure RBAC deny assignments at the specified scope. +By default it lists all deny assignments in the selected Azure subscription. +Use respective parameters to list deny assignments to a specific user, or to list deny assignments on a specific resource group or resource. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /directoryObjects/{id} +- POST /directoryObjects/getByIds + +## SYNTAX + +### EmptyParameterSet (Default) +``` +Get-AzDenyAssignment [-Scope <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ObjectIdParameterSet +``` +Get-AzDenyAssignment -ObjectId <Guid> [-ExpandPrincipalGroups] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceGroupWithObjectIdParameterSet +``` +Get-AzDenyAssignment -ObjectId <Guid> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceWithObjectIdParameterSet +``` +Get-AzDenyAssignment -ObjectId <Guid> -ResourceGroupName <String> -ResourceName <String> -ResourceType <String> + [-ParentResource <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ScopeWithObjectIdParameterSet +``` +Get-AzDenyAssignment -ObjectId <Guid> -Scope <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceGroupWithSignInNameParameterSet +``` +Get-AzDenyAssignment -SignInName <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceWithSignInNameParameterSet +``` +Get-AzDenyAssignment -SignInName <String> -ResourceGroupName <String> -ResourceName <String> + -ResourceType <String> [-ParentResource <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ScopeWithSignInNameParameterSet +``` +Get-AzDenyAssignment -SignInName <String> -Scope <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SignInNameParameterSet +``` +Get-AzDenyAssignment -SignInName <String> [-ExpandPrincipalGroups] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceGroupWithSPNParameterSet +``` +Get-AzDenyAssignment -ServicePrincipalName <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceWithSPNParameterSet +``` +Get-AzDenyAssignment -ServicePrincipalName <String> -ResourceGroupName <String> -ResourceName <String> + -ResourceType <String> [-ParentResource <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ScopeWithSPNParameterSet +``` +Get-AzDenyAssignment -ServicePrincipalName <String> -Scope <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SPNParameterSet +``` +Get-AzDenyAssignment -ServicePrincipalName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceGroupParameterSet +``` +Get-AzDenyAssignment -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceParameterSet +``` +Get-AzDenyAssignment -ResourceGroupName <String> -ResourceName <String> -ResourceType <String> + [-ParentResource <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ScopeParameterSet +``` +Get-AzDenyAssignment -Scope <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DenyAssignmentIdParameterSet +``` +Get-AzDenyAssignment [-Scope <String>] -Id <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### DenyAssignmentNameParameterSet +``` +Get-AzDenyAssignment [-Scope <String>] -DenyAssignmentName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Use the Get-AzDenyAssignment command to list all deny assignments that are effective on a scope. +Without any parameters, this command returns all the deny assignments made under the subscription. +This list can be filtered using filtering parameters for principal, deny assignment name and scope. +To specify a user, use SignInName or Azure AD ObjectId parameters. +To specify a security group, use Azure AD ObjectId parameter. +And to specify an Azure AD application, use ServicePrincipalName or ObjectId parameters. +The scope at which access is being denied may be specified. +It defaults to the selected subscription. +The scope of the deny assignment can be specified using one of the following parameter combinations + a. +Scope - This is the fully qualified scope starting with /subscriptions/\<subscriptionId\>. +This will filter deny assignments that are effective at that particular scope i.e. +all deny assignments at that scope and above. + b. +ResourceGroupName - Name of any resource group under the subscription. +This will filter assignments effective at the specified resource group i.e. +all deny assignments at that scope and above. + c. +ResourceName, ResourceType, ResourceGroupName and (optionally) ParentResource - Identifies a particular resource under the subscription and will filter deny assignments effective at that resource scope. +To determine what access is denied for a particular user in the subscription, use the ExpandPrincipalGroups switch. +This will list all deny assignments assigned to the user, and to the groups that the user is member of. + +## EXAMPLES + +### Example 1 + +List all deny assignments in the subscription + +```powershell +Get-AzDenyAssignment +``` + +```output +Id : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/providers/Microsoft.Authorization/denyAssignments/22704996-fbd0-4ab1-8625-722d897825d2 +DenyAssignmentName : Test deny assignment 1 +Description : Test deny assignment for PS cmdlets +Actions : {foo/*} +NotActions : {foo/*/read} +DataActions : {foo/*} +NotDataActions : {} +Scope : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f +DoNotApplyToChildScopes : False +Principals : { + DisplayName: All Principals + ObjectType: SystemDefined + ObjectId: 00000000-0000-0000-0000-000000000000 + } +ExcludePrincipals : { + DisplayName: testuser + ObjectType: User + ObjectId: f8d526a0-54eb-4941-ae69-ebf4a334d0f0 + } +IsSystemProtected : True + +Id : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourcegroups/testRG/providers/Microsoft.Authorization/denyAssignments/43af7d0c-0bf8-407f-96c0-96a29d076431 +DenyAssignmentName : Test deny assignment 2 +Description : Test deny assignment for PS cmdlets +Actions : {foo/*} +NotActions : {foo/*/read} +DataActions : {foo/*} +NotDataActions : {} +Scope : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourcegroups/testRG +DoNotApplyToChildScopes : False +Principals : { + DisplayName: testuser + ObjectType: User + ObjectId: f8d526a0-54eb-4941-ae69-ebf4a334d0f0 + , + DisplayName: PowershellTestingApp + ObjectType: ServicePrincipal + ObjectId: f2dc21ac-702a-4bde-a4ce-146edf751d81 + } +ExcludePrincipals : {} +IsSystemProtected : True +``` + +### Example 2 + +Gets all deny assignments made to user john.doe@contoso.com at the scope testRG and above. + +```powershell +Get-AzDenyAssignment -ResourceGroupName testRG -SignInName john.doe@contoso.com +``` + +```output +Id : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/providers/Microsoft.Authorization/denyAssignments/22704996-fbd0-4ab1-8625-722d897825d2 +DenyAssignmentName : Test deny assignment 1 +Description : Test deny assignment for PS cmdlets +Actions : {foo/*} +NotActions : {foo/*/read} +DataActions : {foo/*} +NotDataActions : {} +Scope : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f +DoNotApplyToChildScopes : False +Principals : { + DisplayName: john.doe + ObjectType: User + ObjectId: f8d526a0-54eb-4941-ae69-ebf4a334d0f0 + } +ExcludePrincipals : {} +IsSystemProtected : True + +Id : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourcegroups/testRG/providers/Microsoft.Authorization/denyAssignments/43af7d0c-0bf8-407f-96c0-96a29d076431 +DenyAssignmentName : Test deny assignment +Description : Test deny assignment for PS cmdlets +Actions : {foo/*} +NotActions : {foo/*/read} +DataActions : {foo/*} +NotDataActions : {} +Scope : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourcegroups/testRG +DoNotApplyToChildScopes : False +Principals : { + DisplayName: john.doe + ObjectType: User + ObjectId: f8d526a0-54eb-4941-ae69-ebf4a334d0f0 + , + DisplayName: PowershellTestingApp + ObjectType: ServicePrincipal + ObjectId: f2dc21ac-702a-4bde-a4ce-146edf751d81 + } +ExcludePrincipals : {} +IsSystemProtected : True +``` + +### Example 3 + +Gets all deny assignments of the specified service principal + +```powershell +Get-AzDenyAssignment -ServicePrincipalName 'http://testapp1.com' +``` + +```output +Id : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourcegroups/testRG/providers/Microsoft.Authorization/denyAssignments/43af7d0c-0bf8-407f-96c0-96a29d076431 +DenyAssignmentName : Test deny assignment 1 +Description : Test deny assignment for PS cmdlets +Actions : {foo/*} +NotActions : {foo/*/read} +DataActions : {foo/*} +NotDataActions : {} +Scope : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourcegroups/testRG +DoNotApplyToChildScopes : False +Principals : { + DisplayName: TestApp + ObjectType: ServicePrincipal + ObjectId: f2dc21ac-702a-4bde-a4ce-146edf751d81 + } +ExcludePrincipals : {} +IsSystemProtected : True + +Id : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/testRG/providers/Microsoft.Web/sites/site1/providers/Microsoft.Authorization/denyAssignments/94e3d9da-3700-4113-aab4-15f6c173d794 +DenyAssignmentName : Test deny assignment 2 +Description : Test deny assignment for PS cmdlets +Actions : {foo/*} +NotActions : {foo/*/read} +DataActions : {foo/*} +NotDataActions : {} +Scope : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/testRG/providers/Microsoft.Web/sites/site1 +DoNotApplyToChildScopes : False +Principals : { + DisplayName: testuser + ObjectType: User + ObjectId: f8d526a0-54eb-4941-ae69-ebf4a334d0f0 + , + DisplayName: TestApp + ObjectType: ServicePrincipal + ObjectId: f2dc21ac-702a-4bde-a4ce-146edf751d81 + } +ExcludePrincipals : {} +IsSystemProtected : True +``` + +### Example 4 + +Gets deny assignments at the 'site1' website scope. + +```powershell +Get-AzDenyAssignment -Scope '/subscriptions/96231a05-34ce-4eb4-aa6a-70759cbb5e83/resourcegroups/testRG/providers/Microsoft.Web/sites/site1' +``` + +```output +Id : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourcegroups/testRG/providers/Microsoft.Authorization/denyAssignments/43af7d0c-0bf8-407f-96c0-96a29d076431 +DenyAssignmentName : Test deny assignment 1 +Description : Test deny assignment for PS cmdlets +Actions : {foo/*} +NotActions : {foo/*/read} +DataActions : {foo/*} +NotDataActions : {} +Scope : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourcegroups/testRG +DoNotApplyToChildScopes : False +Principals : { + DisplayName: testuser + ObjectType: User + ObjectId: f8d526a0-54eb-4941-ae69-ebf4a334d0f0 + } +ExcludePrincipals : {} +IsSystemProtected : True + +Id : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/testRG/providers/Microsoft.Web/sites/site1/providers/Microsoft.Authorization/denyAssignments/594e3d9da-3700-4113-aab4-15f6c173d794 +DenyAssignmentName : Test deny assignment 2 +Description : Test deny assignment for PS cmdlets +Actions : {foo/*} +NotActions : {foo/*/read} +DataActions : {foo/*} +NotDataActions : {} +Scope : /subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/testRG/providers/Microsoft.Web/sites/site1 +DoNotApplyToChildScopes : False +Principals : { + DisplayName: testuser + ObjectType: User + ObjectId: f8d526a0-54eb-4941-ae69-ebf4a334d0f0 + , + DisplayName: TestApp + ObjectType: ServicePrincipal + ObjectId: f2dc21ac-702a-4bde-a4ce-146edf751d81 + } +ExcludePrincipals : {} +IsSystemProtected : True +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenyAssignmentName +Name of the deny assignment. + +```yaml +Type: System.String +Parameter Sets: DenyAssignmentNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpandPrincipalGroups +If specified, returns deny assignments directly assigned to the user and to the groups of which the user is a member (transitively). +Supported only for a user principal. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ObjectIdParameterSet, SignInNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Deny assignment fully qualified ID or GUID. When Id is provided as a GUID, will take current subscription as default scope. + +```yaml +Type: System.String +Parameter Sets: DenyAssignmentIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ObjectId +The Azure AD ObjectId of the User, Group or Service Principal. +Filters all deny assignments that are made to the specified principal. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: ObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet +Aliases: PrincipalId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentResource +The parent resource in the hierarchy of the resource specified using ResourceName parameter. +Must be used in conjunction with ResourceGroupName, ResourceType, and ResourceName parameters. + +```yaml +Type: System.String +Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. +Lists deny assignments that are effective at the specified resource group. +When used in conjunction with ResourceName, ResourceType, and ParentResource parameters, the command lists deny assignments effective at resources within the resource group. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ResourceGroupParameterSet, ResourceParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +The resource name. +For e.g. +storageaccountprod. +Must be used in conjunction with ResourceGroupName, ResourceType, and (optionally)ParentResource parameters. + +```yaml +Type: System.String +Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. +For e.g. +Microsoft.Network/virtualNetworks. +Must be used in conjunction with ResourceGroupName, ResourceName, and (optionally)ParentResource parameters. + +```yaml +Type: System.String +Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +The Scope of the role assignment. +In the format of relative URI. +For e.g. +/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG. +It must start with "/subscriptions/{id}". +The command filters all deny assignments that are effective at that scope. + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet, DenyAssignmentIdParameterSet, DenyAssignmentNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ScopeWithObjectIdParameterSet, ScopeWithSignInNameParameterSet, ScopeWithSPNParameterSet, ScopeParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServicePrincipalName +The ServicePrincipalName of the service principal. +Filters all deny assignments that are made to the specified Azure AD application. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet, SPNParameterSet +Aliases: SPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SignInName +The email address or the user principal name of the user. +Filters all deny assignments that are made to the specified user. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, SignInNameParameterSet +Aliases: Email, UserPrincipalName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.Authorization.PSDenyAssignment + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzDeployment.md b/azps-10.1.0/Az.Resources/Get-AzDeployment.md new file mode 100644 index 0000000000..b992d89dae --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzDeployment.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzDeployment.md +--- + +# Get-AzDeployment + +## SYNOPSIS +Get deployment + +## SYNTAX + +### GetByDeploymentName (Default) +``` +Get-AzDeployment [[-Name] <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByDeploymentId +``` +Get-AzDeployment -Id <String> [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDeployment** cmdlet gets the deployments at the current subscription scope. +Specify the *Name* or *Id* parameter to filter the results. +By default, **Get-AzDeployment** gets all deployments at the current subscription scope. + +## EXAMPLES + +### Example 1: Get all deployments at subscription scope +```powershell +Get-AzDeployment +``` + +This command gets all deployments at the current subscription scope. + +### Example 2: Get a deployment by name +```powershell +Get-AzDeployment -Name "DeployRoles01" +``` + +This command gets the DeployRoles01 deployment at the current subscription scope. +You can assign a name to a deployment when you create it by using the **New-AzDeployment** cmdlets. +If you do not assign a name, the cmdlets provide a default name based on the template that is used to create the deployment. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified resource Id of the deployment. +example: /subscriptions/{subId}/providers/Microsoft.Resources/deployments/{deploymentName} + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentId +Aliases: DeploymentId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of deployment. + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentName +Aliases: DeploymentName + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzDeploymentOperation.md b/azps-10.1.0/Az.Resources/Get-AzDeploymentOperation.md new file mode 100644 index 0000000000..8518f5b7ed --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzDeploymentOperation.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azdeploymentoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzDeploymentOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzDeploymentOperation.md +--- + +# Get-AzDeploymentOperation + +## SYNOPSIS +Get deployment operation + +## SYNTAX + +### GetByDeploymentName (Default) +``` +Get-AzDeploymentOperation -DeploymentName <String> [-OperationId <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByDeploymentObject +``` +Get-AzDeploymentOperation -DeploymentObject <PSDeployment> [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDeploymentOperation** cmdlet lists all the operations that were part of a deployment to help you identify and give more information about the exact operations that failed for a particular deployment. +It can also show the response and the request content for each deployment operation. +This is the same information provided in the deployment details on the portal. + +To get the request and the response content, enable the setting when submitting a deployment through **New-AzDeployment**. +It can potentially log and expose secrets like passwords used in the resource property or **listKeys** operations that are then returned when you retrieve the deployment operations. +For more on this setting and how to enable it, see New-AzDeployment and Debugging ARM template deployments + +## EXAMPLES + +### Example 1: Get deployment operations given a deployment name +```powershell +Get-AzDeploymentOperation -DeploymentName test +``` + +Gets deployment operation with name "test" at the current subscription scope. + +### Example 2: Get a deployment and get its deployment operations +```powershell +Get-AzDeployment -Name "test" | Get-AzDeploymentOperation +``` + +This command gets the deployment "test" at the current subscription scope and get its deployment operations. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The deployment name. + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentObject +The deployment object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment +Parameter Sets: GetByDeploymentObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OperationId +The deployment operation Id. + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentOperation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzDeploymentScript.md b/azps-10.1.0/Az.Resources/Get-AzDeploymentScript.md new file mode 100644 index 0000000000..9e8cbe245e --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzDeploymentScript.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azdeploymentscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzDeploymentScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzDeploymentScript.md +--- + +# Get-AzDeploymentScript + +## SYNOPSIS +Gets or lists deployment scripts. + +## SYNTAX + +### ListDeploymentScript (Default) +``` +Get-AzDeploymentScript [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetDeploymentScriptByName +``` +Get-AzDeploymentScript [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetDeploymentScriptByResourceId +``` +Get-AzDeploymentScript [-Id] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDeploymentScript** cmdlet gets a single deployment script or a list of deployment scripts. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDeploymentScript +``` + +Lists deployment scripts in the subscription in current user's context. + +### Example 2 +```powershell +Get-AzDeploymentScript -ResourceGroupName DS-TestRg +``` + +Lists deployment scripts in resource group DS-TestRg. + +### Example 3 +```powershell +Get-AzDeploymentScript -Name MyDeploymentScript -ResourceGroupName DS-TestRg +``` + +Gets a deployment script with the name MyDeploymentScript in resource group DS-TestRG. + +### Example 4 +```powershell +Get-AzDeploymentScript -Id "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Resources/deploymentScripts/{deploymentScriptName}" +``` + +Gets a deployment script with the given resource Id. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified resource Id of the deployment script. +Example: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Resources/deploymentScripts/{deploymentScriptName} + +```yaml +Type: System.String +Parameter Sets: GetDeploymentScriptByResourceId +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the deployment script + +```yaml +Type: System.String +Parameter Sets: GetDeploymentScriptByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ListDeploymentScript +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetDeploymentScriptByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScript + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzDeploymentScriptLog.md b/azps-10.1.0/Az.Resources/Get-AzDeploymentScriptLog.md new file mode 100644 index 0000000000..46760e2956 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzDeploymentScriptLog.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azdeploymentscriptlog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzDeploymentScriptLog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzDeploymentScriptLog.md +--- + +# Get-AzDeploymentScriptLog + +## SYNOPSIS +Gets the log of a deployment script execution. + +## SYNTAX + +### GetDeploymentScriptLogByName (Default) +``` +Get-AzDeploymentScriptLog [-ResourceGroupName] <String> [-Name] <String> [[-Tail] <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetDeploymentScriptLogByResourceId +``` +Get-AzDeploymentScriptLog [-DeploymentScriptResourceId] <String> [[-Tail] <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetDeploymentScriptLogByInputObject +``` +Get-AzDeploymentScriptLog [-DeploymentScriptObject] <PsDeploymentScript> [[-Tail] <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDeploymentScriptLog** cmdlet gets the log of a deployment script execution. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDeploymentScriptLog -Name MyDeploymentScript -ResourceGroupName DS-TestRg +``` + +Gets the log of a deployment script with the name MyDeploymentScript in resource group DS-TestRG. + +### Example 2 +```powershell +Get-AzDeploymentScriptLog -Name MyDeploymentScript -ResourceGroupName DS-TestRg -Tail 3 +``` + +Gets the last 3 lines of the log of a deployment script with the name MyDeploymentScript in resource group DS-TestRG. + +### Example 3 +```powershell +$ds = Get-AzDeploymentScript -Name MyDeploymentScript -ResourceGroupName DS-TestRg +Get-AzDeploymentScriptLog -DeploymentScriptInputObject $ds +``` + +The first command gets a deployment script with the name MyDeploymentScript in resource group DS-TestRG. +The second command gets the log of given deployment script. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentScriptObject +The deployment script PowerShell object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScript +Parameter Sets: GetDeploymentScriptLogByInputObject +Aliases: DeploymentScriptInputObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DeploymentScriptResourceId +The fully qualified resource Id of the deployment script. +Example: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Resources/deploymentScripts/{deploymentScriptName} + +```yaml +Type: System.String +Parameter Sets: GetDeploymentScriptLogByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deployment script. + +```yaml +Type: System.String +Parameter Sets: GetDeploymentScriptLogByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: GetDeploymentScriptLogByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tail +Limit output to last n lines + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScript + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScriptLog + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzDeploymentWhatIfResult.md b/azps-10.1.0/Az.Resources/Get-AzDeploymentWhatIfResult.md new file mode 100644 index 0000000000..38f194a9b5 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzDeploymentWhatIfResult.md @@ -0,0 +1,396 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azdeploymentwhatifresult +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzDeploymentWhatIfResult.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzDeploymentWhatIfResult.md +--- + +# Get-AzDeploymentWhatIfResult + +## SYNOPSIS +Gets a template What-If result for a deployment at subscription scope. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterObject +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterObject +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterObject +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterFile +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterFile +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterFile +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParams +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterUri +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterUri +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterUri +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsUri +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectWithNoParameters +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceId +``` +Get-AzDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDeploymentWhatIfResult** cmdlet gets the ARM template What-If result for a template deployment at the current subscription scope. It returns a list of changes indicating what resources will be updated if the deployment is applied without making any changes to real resources. To specify the format for the returning result, use the *ResultFormat* parameter. + +## EXAMPLES + +### Example 1: Get a What-If result at subscription scope +```powershell +Get-AzDeploymentWhatIfResult ` + -DeploymentName "deploy-01" ` + -Location "West US" ` + -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" ` + -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" ` + -ResultFormat "FullResourcePayloads" +``` + +This command gets a What-If result at the current subscription scope by using a custom template file and a parameter file on disk. +The command uses the *Location* parameter to specify where to store the deployment data. +The command uses the *TemplateFile* parameter to specify a template file. +The command uses the *TemplateParameterFile* parameter to specify a template parameter file. +The command uses the *ResultFormat* parameter to set the What-If result to include full resource payloads. + +### Example 2: Get a What-If result at subscription scope with ResourceIdOnly +```powershell +Get-AzDeploymentWhatIfResult ` + -DeploymentName "deploy-01" ` + -Location "West US" ` + -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" ` + -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" ` + -ResultFormat "ResourceIdOnly" +``` + +This command gets a What-If result at the current subscription scope by using a custom template file and a parameter file on disk. +The command uses the *Location* parameter to specify where to store the deployment data. +The command uses the *TemplateFile* parameter to specify a template file. +The command uses the *TemplateParameterFile* parameter to specify a template parameter file. +The command uses the *ResultFormat* parameter to set the What-If result to only contain resource IDs. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeChangeType +Comma-separated list of resource change types to be excluded from What-If results. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location to store deployment data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. "20131223140835". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultFormat +The What-If result format. + +```yaml +Type: Microsoft.Azure.Management.ResourceManager.Models.WhatIfResultFormat +Parameter Sets: (All) +Aliases: +Accepted values: ResourceIdOnly, FullResourcePayloads + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. +This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. +For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +Local path to the template file. Supported template file type: json and bicep. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateObject +A hash table which represents the template. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateObjectAndParameterFile, ByTemplateObjectAndParameterUri, ByTemplateObjectWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +A file that has the template parameters. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterFile, ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile, ByTemplateSpecResourceIdAndParams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Uri to the template parameter file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterUri, ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri, ByTemplateSpecResourceIdAndParamsUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +Resource ID of the templateSpec to be deployed. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Uri to the template file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Hashtable + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.Deployments.PSWhatIfOperationResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzLocation.md b/azps-10.1.0/Az.Resources/Get-AzLocation.md new file mode 100644 index 0000000000..e32f5b7ece --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzLocation.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: DC870E11-2129-4906-8357-D9BC1CF2E08E +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azlocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzLocation.md +--- + +# Get-AzLocation + +## SYNOPSIS +Gets all locations and the supported resource providers for each location. + +## SYNTAX + +``` +Get-AzLocation [-ExtendedLocation <Boolean>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzLocation** cmdlet gets all locations and the supported resource providers for each location. + +## EXAMPLES + +### Example 1: Get all locations and the supported resource providers +```powershell +Get-AzLocation +``` + +This command gets all locations and the supported resource providers for each location. + +### Example 2: Get all locations supporting resource provider Microsoft.AppConfiguration +```powershell +Get-AzLocation | Where-Object {$_.Providers -contains "Microsoft.AppConfiguration"} +``` + +```output +Location : eastasia +DisplayName : East Asia +Providers : {Microsoft.Devices, Microsoft.Cache, Microsoft.AppConfiguration, microsoft.insights…} + +Location : southeastasia +DisplayName : Southeast Asia +Providers : {Microsoft.Devices, Microsoft.Cache, Microsoft.AppConfiguration, microsoft.insights…} + +Location : centralus +DisplayName : Central US +Providers : {Microsoft.Devices, Microsoft.Cache, Microsoft.AppConfiguration, microsoft.insights…} +... +``` + +This example gets all locations which supports resource provider "Microsoft.AppConfiguration". + +## PARAMETERS + +### -ApiVersion +Specifies the API version that is supported by the resource Provider. +You can specify a different version than the default version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedLocation +Whether to include extended locations. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceProviderLocation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzManagedApplication.md b/azps-10.1.0/Az.Resources/Get-AzManagedApplication.md new file mode 100644 index 0000000000..7e33e9f9ad --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzManagedApplication.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azmanagedapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagedApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagedApplication.md +--- + +# Get-AzManagedApplication + +## SYNOPSIS +Gets managed applications + +## SYNTAX + +### GetBySubscription (Default) +``` +Get-AzManagedApplication [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByNameAndResourceGroup +``` +Get-AzManagedApplication [-Name <String>] -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetById +``` +Get-AzManagedApplication -Id <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzManagedApplication** cmdlet gets managed applications + +## EXAMPLES + +### Example 1: Get all managed applications under a resource group +```powershell +Get-AzManagedApplication -ResourceGroupName "MyRG" +``` + +This command gets managed applications under resource group "MyRG" + +### Example 2: Get all managed applications +```powershell +Get-AzManagedApplication +``` + +This command get all managed applications under the current subscription + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified managed application Id, including the subscription. +e.g. +/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} + +```yaml +Type: System.String +Parameter Sets: GetById +Aliases: ResourceId, ManagedApplicationId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The managed application name. + +```yaml +Type: System.String +Parameter Sets: GetByNameAndResourceGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzManagedApplicationDefinition.md b/azps-10.1.0/Az.Resources/Get-AzManagedApplicationDefinition.md new file mode 100644 index 0000000000..4f1e6e9e02 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzManagedApplicationDefinition.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azmanagedapplicationdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagedApplicationDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagedApplicationDefinition.md +--- + +# Get-AzManagedApplicationDefinition + +## SYNOPSIS +Gets managed application definitions + +## SYNTAX + +### GetByNameAndResourceGroup (Default) +``` +Get-AzManagedApplicationDefinition [-Name <String>] -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetById +``` +Get-AzManagedApplicationDefinition -Id <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzManagedApplicationDefinition** cmdlet gets managed application definitions + +## EXAMPLES + +### Example 1: Get all managed application definitions under a resource group +```powershell +Get-AzManagedApplicationDefinition -ResourceGroupName "MyRG" +``` + +This command gets the managed application definitions under resource group "MyRG" + +### Example 2: Get a managed application definition +```powershell +Get-AzManagedApplicationDefinition -ResourceGroupName "MyRG" -Name "myManagedAppDef" +``` + +This command gets the managed application definition "myManagedAppDef" under resource group "MyRG" + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified managed application definition Id, including the subscription. +e.g. +/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} + +```yaml +Type: System.String +Parameter Sets: GetById +Aliases: ResourceId, ManagedApplicationDefinitionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The managed application definition name. + +```yaml +Type: System.String +Parameter Sets: GetByNameAndResourceGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzManagementGroup.md b/azps-10.1.0/Az.Resources/Get-AzManagementGroup.md new file mode 100644 index 0000000000..bc9b79f2e5 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzManagementGroup.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azmanagementgroup/ +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroup.md +--- + +# Get-AzManagementGroup + +## SYNOPSIS +Gets Management Group(s) + +## SYNTAX + +### ListOperation (Default) +``` +Get-AzManagementGroup [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GetOperation +``` +Get-AzManagementGroup [-GroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-Expand] [-Recurse] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzManagementGroup** cmdlet Gets all or a specific Management Group by its **GroupName**. + +## EXAMPLES + +### Example 1: Get all Management Groups +```powershell +Get-AzManagementGroup +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/TestGroup +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroup +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +DisplayName : TestGroupDisplayName + +Id : /providers/Microsoft.Management/managementGroups/TestGroupChild +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroupChild +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +DisplayName : TestGroupChildDisplayName +``` + +Get all Management Groups + +### Example 2: Get specific Management Group +```powershell +Get-AzManagementGroup -GroupName TestGroup +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/TestGroup +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroup +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +DisplayName : TestGroupDisplayName +UpdatedTime : 2/1/2018 11:16:12 AM +UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9 +ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent +ParentName : TestGroupParent +ParentDisplayName : TestGroupParent +``` + +Get specific Management Group + +### Example 3: Get specific Management Group and first level of hierarchy +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$reponse = Get-AzManagementGroup -GroupName TestGroupParent -Expand +$response + +Id : /providers/Microsoft.Management/managementGroups/TestGroupParent +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroupParent +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +DisplayName : TestGroupParent +UpdatedTime : 2/1/2018 11:15:46 AM +UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9 +ParentId : /providers/Microsoft.Management/managementGroups/6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +ParentName : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +ParentDisplayName : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +Children : {TestGroup1DisplayName, TestGroup2DisplayName} + +$response.Children[0] + +Type : /managementGroup +Id : /providers/Microsoft.Management/managementGroups/TestGroup1 +Name : TestGroup1 +DisplayName : TestGroup1DisplayName +Children : +``` + +With the `Expand` flag, one can navigate through the `Children` array and get details for each child. For example, `Children[0]` will give details for the group with display name `TestGroup1DisplayName`. + +### Example 4: Get specific Management Group and all levels of hierarchy +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$response = Get-AzManagementGroup -GroupName TestGroupParent -Expand -Recurse +$response + +Id : /providers/Microsoft.Management/managementGroups/TestGroupParent +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroupParent +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +DisplayName : TestGroupParent +UpdatedTime : 2/1/2018 11:15:46 AM +UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9 +ParentId : /providers/Microsoft.Management/managementGroups/6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +ParentName : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +ParentDisplayName : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +Children : {TestGroup1DisplayName, TestGroup2DisplayName} + +$response.Children[0] + +Type : /managementGroup +Id : /providers/Microsoft.Management/managementGroups/TestGroup1 +Name : TestGroup1 +DisplayName : TestGroup1DisplayName +Children : {TestRecurseChild} + +$response.Children[0].Children[0] + +Type : /managementGroup +Id : /providers/Microsoft.Management/managementGroups/TestRecurseChild +Name : TestRecurseChild +DisplayName : TestRecurseChild +Children : +``` + +Get specific Management Group and all levels of hierarchy + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Expand the output to list the children of the management group + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetOperation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Management Group Id + +```yaml +Type: System.String +Parameter Sets: GetOperation +Aliases: GroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recurse +Recursively list the children of the management group + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetOperation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroupInfo + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzManagementGroupDeployment.md b/azps-10.1.0/Az.Resources/Get-AzManagementGroupDeployment.md new file mode 100644 index 0000000000..ce92bc6a3a --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzManagementGroupDeployment.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azmanagementgroupdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupDeployment.md +--- + +# Get-AzManagementGroupDeployment + +## SYNOPSIS +Get deployment at a management group + +## SYNTAX + +### GetByDeploymentName (Default) +``` +Get-AzManagementGroupDeployment [-ManagementGroupId] <String> [[-Name] <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByDeploymentId +``` +Get-AzManagementGroupDeployment -Id <String> [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzManagementGroupDeployment** cmdlet gets the deployments at the a management group. +Specify the *Name* or *Id* parameter to filter the results. +By default, **Get-AzManagementGroupDeployment** gets all deployments at the management group. + +## EXAMPLES + +### Example 1: Get all deployments at a management group +```powershell +Get-AzManagementGroupDeployment -ManagementGroupId "myMG" +``` + +This command gets all deployments at the management group "myMG". + +### Example 2: Get a deployment by name +```powershell +Get-AzManagementGroupDeployment -ManagementGroupId "myMG" -Name "Deploy01" +``` + +This command gets the "Deploy01" deployment at the management group "myMG". +You can assign a name to a deployment when you create it by using the **New-AzManagementGroupDeployment** cmdlets. +If you do not assign a name, the cmdlets provide a default name based on the template that is used to create the deployment. + +### Example 3: Get a deployment by ID +```powershell +Get-AzDeployment -Id "/providers/Microsoft.Management/managementGroups/myMG/providers/Microsoft.Resources/deployments/Deploy01" +``` + +This command gets the "Deploy01" deployment at the management group "myMG". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified resource Id of the deployment. +example: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deployments/{deploymentName} + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentId +Aliases: DeploymentId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group id. + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of deployment. + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentName +Aliases: DeploymentName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzManagementGroupDeploymentOperation.md b/azps-10.1.0/Az.Resources/Get-AzManagementGroupDeploymentOperation.md new file mode 100644 index 0000000000..3d142c05db --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzManagementGroupDeploymentOperation.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azmanagementgroupdeploymentoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupDeploymentOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupDeploymentOperation.md +--- + +# Get-AzManagementGroupDeploymentOperation + +## SYNOPSIS +Get deployment operation for management group deployment + +## SYNTAX + +### GetByDeploymentName (Default) +``` +Get-AzManagementGroupDeploymentOperation -ManagementGroupId <String> -DeploymentName <String> + [-OperationId <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByDeploymentObject +``` +Get-AzManagementGroupDeploymentOperation -DeploymentObject <PSDeployment> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzManagementGroupDeploymentOperation** cmdlet lists all the operations that were part of a management group deployment to help you identify and give more information about the exact operations that failed for a particular deployment. +This is the same information provided in the deployment details on the portal. + +## EXAMPLES + +### Example 1: Get deployment operations given a deployment name +```powershell +Get-AzManagementGroupDeploymentOperation -ManagementGroupId myMG -DeploymentName Deploy01 +``` + +Gets deployment operations with name "Deploy01" at the management group "myMG". + +### Example 2: Get a deployment and get its deployment operations +```powershell +Get-AzManagementGroupDeployment -ManagementGroupId myMG -Name Deploy01 | Get-AzManagementGroupDeploymentOperation +``` + +This command gets the deployment "Deploy01" at the management group "myMG" and get its deployment operations. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The deployment name. + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentObject +The deployment object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment +Parameter Sets: GetByDeploymentObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group id. + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationId +The deployment operation Id. + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentOperation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzManagementGroupDeploymentStack.md b/azps-10.1.0/Az.Resources/Get-AzManagementGroupDeploymentStack.md new file mode 100644 index 0000000000..36241b7ba2 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzManagementGroupDeploymentStack.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/Get-AzManagementGroupDeploymentStack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupDeploymentStack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupDeploymentStack.md +--- + +# Get-AzManagementGroupDeploymentStack + +## SYNOPSIS +Gets Management Group scoped Deployment Stacks. + +## SYNTAX + +### ListByManagmentGroupId (Default) +``` +Get-AzManagementGroupDeploymentStack -ManagementGroupId <String> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByManagementGroupIdAndName +``` +Get-AzManagementGroupDeploymentStack [-Name] <String> -ManagementGroupId <String> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceId +``` +Get-AzManagementGroupDeploymentStack -ResourceId <String> [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve a mangement group scoped deployment stack. + +## EXAMPLES + +### Example 1: Retrieves the deployment stack MyMGStack in mangement group MyManagementGroup +```powershell +Get-AzManagementGroupDeploymentStack -ManagementGroupId MyMangementGroup -Name MyMGStack +``` + +Get a deployment stack named 'MyMGStack' under an MG named 'MyManagementGroup'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The id of the ManagementGroup where the DeploymentStack is deployed + +```yaml +Type: System.String +Parameter Sets: ListByManagmentGroupId, GetByManagementGroupIdAndName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the DeploymentStack to get + +```yaml +Type: System.String +Parameter Sets: GetByManagementGroupIdAndName +Aliases: StackName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the DeploymentStack to get + +```yaml +Type: System.String +Parameter Sets: GetByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStack + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzManagementGroupDeploymentWhatIfResult.md b/azps-10.1.0/Az.Resources/Get-AzManagementGroupDeploymentWhatIfResult.md new file mode 100644 index 0000000000..6ec90e3e41 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzManagementGroupDeploymentWhatIfResult.md @@ -0,0 +1,429 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azmanagementgroupdeploymentwhatifresult +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupDeploymentWhatIfResult.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupDeploymentWhatIfResult.md +--- + +# Get-AzManagementGroupDeploymentWhatIfResult + +## SYNOPSIS +Gets a template What-If result for a deployment at management group scope. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterObject +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterObject +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterObject +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterFile +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterFile +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterFile +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParams +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterUri +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterUri +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterUri +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsUri +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateObjectWithNoParameters +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceId +``` +Get-AzManagementGroupDeploymentWhatIfResult [-Name <String>] -ManagementGroupId <String> -Location <String> + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzManagementGroupDeploymentWhatIfResult** cmdlet gets the ARM template What-If result for a template deployment at the specified management group scope. It returns a list of changes indicating what resources will be updated if the deployment is applied without making any changes to real resources. To specify the format for the returning result, use the *ResultFormat* parameter. + +## EXAMPLES + +### Example 1: Get a What-If result at management group scope +```powershell +Get-AzManagementGroupDeploymentWhatIfResult ` + -DeploymentName "deploy-01" ` + -Location "West US" ` + -ManagementGroupId "myManagementGroup" ` + -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" ` + -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" ` + -ResultFormat "FullResourcePayloads" +``` + +This command gets a What-If result at management group scope by using a custom template file and a parameter file on disk. +The command uses the *Location* parameter to specify where to store the deployment data. +The command uses the *ManagementGroupId* parameter to specify the management group where the template will be deployed. +The command uses the *TemplateFile* parameter to specify a template file. +The command uses the *TemplateParameterFile* parameter to specify a template parameter file. +The command uses the *ResultFormat* parameter to set the What-If result to include full resource payloads. + +### Example 2: Get a What-If result at management group scope with ResourceIdOnly +```powershell +Get-AzManagementGroupDeploymentWhatIfResult ` + -DeploymentName "deploy-01" ` + -Location "West US" ` + -ManagementGroupId "myManagementGroup" ` + -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" ` + -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" ` + -ResultFormat "ResourceIdOnly" +``` + +This command gets a What-If result at management group scope by using a custom template file and a parameter file on disk. +The command uses the *Location* parameter to specify where to store the deployment data. +The command uses the *ManagementGroupId* parameter to specify the management group where the template will be deployed. +The command uses the *TemplateFile* parameter to specify a template file. +The command uses the *TemplateParameterFile* parameter to specify a template parameter file. +The command uses the *ResultFormat* parameter to set the What-If result to only contain resource IDs. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeChangeType +Comma-separated list of resource change types to be excluded from What-If results. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location to store deployment data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deployment it's going to create. +If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. +"20131223140835". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultFormat +The What-If result format. + +```yaml +Type: Microsoft.Azure.Management.ResourceManager.Models.WhatIfResultFormat +Parameter Sets: (All) +Aliases: +Accepted values: ResourceIdOnly, FullResourcePayloads + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. +This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. +For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +Local path to the template file. Supported template file type: json and bicep. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateObject +A hash table which represents the template. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateObjectAndParameterFile, ByTemplateObjectAndParameterUri, ByTemplateObjectWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +A file that has the template parameters. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterFile, ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile, ByTemplateSpecResourceIdAndParams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Uri to the template parameter file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterUri, ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri, ByTemplateSpecResourceIdAndParamsUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +Resource ID of the templateSpec to be deployed. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Uri to the template file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.Deployments.PSWhatIfOperationResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzManagementGroupEntity.md b/azps-10.1.0/Az.Resources/Get-AzManagementGroupEntity.md new file mode 100644 index 0000000000..a2e3058e87 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzManagementGroupEntity.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azmanagementgroupentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupEntity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupEntity.md +--- + +# Get-AzManagementGroupEntity + +## SYNOPSIS +Lists all Entities under the current Tenant + +## SYNTAX + +``` +Get-AzManagementGroupEntity [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzManagementGroupEntity** cmdlet gets all entities (Management Groups and Subscriptions) under the current tenant. + +## EXAMPLES + +### Example 1: Get all Management Groups +```powershell +Get-AzManagementGroupEntity +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/TestGroup +Type : Microsoft.Management/managementGroups +Name : TestGroup +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +DisplayName : TestGroupDisplayName + +Id : /providers/Microsoft.Management/managementGroups/TestGroupChild +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroupChild +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +DisplayName : TestGroupChildDisplayName +``` + +This cmdlet get all the ManagementGroupEntity under this tenant. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSEntityInfo + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSEntityInfo + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzManagementGroupHierarchySetting.md b/azps-10.1.0/Az.Resources/Get-AzManagementGroupHierarchySetting.md new file mode 100644 index 0000000000..c60ba378bc --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzManagementGroupHierarchySetting.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azmanagementgrouphierarchysetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupHierarchySetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupHierarchySetting.md +--- + +# Get-AzManagementGroupHierarchySetting + +## SYNOPSIS +Gets the Hierarchy Settings under the current tenant + +## SYNTAX + +### GroupOperations (Default) +``` +Get-AzManagementGroupHierarchySetting [-GroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentGroupObject +``` +Get-AzManagementGroupHierarchySetting [-GroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzManagementGroupHierarchySetting** cmdlet Gets all hierarchy settings under the current tenant using the **GroupName** parameter. + +## EXAMPLES + +### Example 1: Get Hierarchy Settings +```powershell +Get-AzManagementGroupHierarchySetting -GroupName c7a87cda-9a66-4920-b0f8-869baa04efe0 +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/c7a87cda-9a66-4920-b0f8-869baa04efe0/settings/default +Type : Microsoft.Management/managementGroups/settings +Name : default +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +RequireAuthorizationForGroupCreation : true +DefaultManagementGroup : TestGroup +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Management Group Id of the Root Management Group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSHierarchySettings + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSHierarchySettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzManagementGroupNameAvailability.md b/azps-10.1.0/Az.Resources/Get-AzManagementGroupNameAvailability.md new file mode 100644 index 0000000000..d2884fdf68 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzManagementGroupNameAvailability.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azmanagementgroupnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupNameAvailability.md +--- + +# Get-AzManagementGroupNameAvailability + +## SYNOPSIS +Checks if the Management Group name is available in the Tenant and a valid name. + +## SYNTAX + +``` +Get-AzManagementGroupNameAvailability [-GroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzManagementGroupNameAvailability** checks if a Management Group Name is Available and Valid + +## EXAMPLES + +### Example 1: Get the Name Availability for a Valid Name +```powershell +Get-AzManagementGroupNameAvailability -GroupName "testMG" +``` + +```output +Message : +NameAvailable : True +Reason : +``` + +### Example 2: Get the Name Availability for a name that is already taken +```powershell +Get-AzManagementGroupNameAvailability -GroupName "testMG3" +``` + +```output +Message : The group with the specified name already exists +NameAvailable : False +Reason : AlreadyExists +``` + +### Example 3: Get the Name Availability for a name that contains invalid characters +```powershell +Get-AzManagementGroupNameAvailability -GroupName "testMG!" +``` + +```output +Message : The provided management group name has invalid characters +NameAvailable : False +Reason : Invalid +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Management Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroupNameAvailabilityResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzManagementGroupSubscription.md b/azps-10.1.0/Az.Resources/Get-AzManagementGroupSubscription.md new file mode 100644 index 0000000000..678a725c5e --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzManagementGroupSubscription.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azmanagementgroupsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzManagementGroupSubscription.md +--- + +# Get-AzManagementGroupSubscription + +## SYNOPSIS +Gets the details of Subscription(s) under a Management Group. + +## SYNTAX + +``` +Get-AzManagementGroupSubscription [-GroupName] <String> [[-SubscriptionId] <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzManagementGroupSubscription** cmdlet gets the subscription info under a Management Group. Providing the **SubscriptionId** and **GroupName** will give only the Subscription details for that subscription. Providing only the **GroupName** will list the details for all Subscriptions under the Management Group. + +## EXAMPLES + +### Example 1: Get Subscription Details under a Management Group +```powershell +Get-AzManagementGroupSubscription -GroupName "TestGroup" -SubscriptionId 5602fbd9-fb0d-4fbb-98b3-10c8ea20b6de +``` + +```output +Name : 5602fbd9-fb0d-4fbb-98b3-10c8ea20b6de +Type : Microsoft.Management/managementGroups/subscriptions +Id : /providers/Microsoft.Management/managementGroups/TestGroup/subscriptions/5602fbd9-fb0d-4fbb-98b3-10c8ea20b6de +TenantId : 14307de0-5e6f-46cf-b2ba-64a062964d30 +DisplayName : Visual Studio Enterprise Subscription +ParentId : /providers/Microsoft.Management/managementGroups/TestGroup +State : Active +``` + +### Example 2: Get all Subscription Details under a Management Group +```powershell +Get-AzManagementGroupSubscription -GroupName "TestGroup" +``` + +```output +Name : 5602fbd9-fb0d-4fbb-98b3-10c8ea20b6de +Type : Microsoft.Management/managementGroups/subscriptions +Id : /providers/Microsoft.Management/managementGroups/TestGroup/subscriptions/5602fbd9-fb0d-4fbb-98b3-10c8ea20b6de +TenantId : 14307de0-5e6f-46cf-b2ba-64a062964d30 +DisplayName : Visual Studio Enterprise Subscription +ParentId : /providers/Microsoft.Management/managementGroups/TestGroup +State : Active + +Name : 2120692d-35c3-44c8-81f5-631fa7351726 +Type : Microsoft.Management/managementGroups/subscriptions +Id : /providers/Microsoft.Management/managementGroups/TestGroup/subscriptions/2120692d-35c3-44c8-81f5-631fa7351726 +TenantId : 14307de0-5e6f-46cf-b2ba-64a062964d30 +DisplayName : Test Subscription +ParentId : /providers/Microsoft.Management/managementGroups/TestGroup +State : Active +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Management Group Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return `true` on successful execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id of the subscription associated with the management + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroupSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzPolicyAlias.md b/azps-10.1.0/Az.Resources/Get-AzPolicyAlias.md new file mode 100644 index 0000000000..8a49c3cf39 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzPolicyAlias.md @@ -0,0 +1,398 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azpolicyalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzPolicyAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzPolicyAlias.md +--- + +# Get-AzPolicyAlias + +## SYNOPSIS +Get-AzPolicyAlias retrieves and outputs Azure provider resource types that have aliases defined and match the +given parameter values. If no parameters are provided, all provider resource types that contain an alias will be output. +The -ListAvailable switch modifies this behavior by listing all matching resource types including those without aliases. + +## SYNTAX + +``` +Get-AzPolicyAlias [-NamespaceMatch <String>] [-ResourceTypeMatch <String>] [-AliasMatch <String>] + [-PathMatch <String>] [-ApiVersionMatch <String>] [-LocationMatch <String>] [-ListAvailable] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPolicyAlias** cmdlet gets a listing of policy aliases. +Policy aliases are used by Azure Policy to refer to resource type properties. +Parameters are provided that limit items in the listing by matching various properties of the resource type or its aliases. +A given match value matches if the target string contains it using case insensitive comparison. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzPolicyAlias +``` + +```output +Namespace ResourceType Aliases +--------- ------------ ------- +Microsoft.AnalysisServices servers {Microsoft.AnalysisServices/servers/state, Microsoft.AnalysisServices/s... +Microsoft.Authorization roleAssignments {Microsoft.Authorization/roleAssignments/roleDefinitionId, Microsoft.Au... +Microsoft.Authorization roleDefinitions {Microsoft.Authorization/roleDefinitions/type, Microsoft.Authorization/... + +... ... ... + +Microsoft.Web hostingEnvironments {Microsoft.Web/hostingEnvironments/clusterSettings[*].name, Microsoft.W... +Microsoft.Web sites/config {Microsoft.Web/sites/config/httpLoggingEnabled, Microsoft.Web/sites/con... +Microsoft.GuestConfiguration guestConfigurationAssignments {Microsoft.GuestConfiguration/guestConfigurationAssignments/complianceS... +``` + +Lists all provider resource types that have an alias. + +### Example 2 +```powershell +Get-AzPolicyAlias -ListAvailable +``` + +```output +Namespace ResourceType Aliases +--------- ------------ ------- + +... ... ... + +Microsoft.AlertsManagement operations {} +Microsoft.AnalysisServices servers {Microsoft.AnalysisServices/servers/sta... +Microsoft.AnalysisServices locations {} + +... ... ... +``` + +Lists all provider resource types, including those without aliases. + +### Example 3 +```powershell +Get-AzPolicyAlias -NamespaceMatch 'compute' +``` + +```output +Namespace ResourceType Aliases +--------- ------------ ------- +Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Microsoft... +Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtualMachi... +Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineScaleSets/... +Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compute/virt... +Microsoft.Compute disks {Microsoft.Compute/imagePublisher, Microsoft.Compute/imageOffer, Microsoft.Compute/imageSku, Mi... +``` + +Lists all provider resource types whose namespace matches 'compute' and contain an alias. + +### Example 4 +```powershell +Get-AzPolicyAlias -ResourceTypeMatch 'virtual' +``` + +```output +Namespace ResourceType Aliases +--------- ------------ ------- +Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Micro... +Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtualM... +Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineScaleS... +Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compute/... +Microsoft.Network virtualNetworks {Microsoft.Network/virtualNetworks/subnets[*].routeTable.id, Microsoft.Network/virtualNetwo... +Microsoft.Network virtualNetworkGateways {Microsoft.Network/virtualNetworkGateways/sku.name, Microsoft.Network/virtualNetworkGateway... +Microsoft.Network virtualNetworks/subnets {Microsoft.Network/virtualNetworks/subnets/routeTable.id, Microsoft.Network/virtualNetworks... +Microsoft.Network virtualNetworks/virtualNetworkPeerings {Microsoft.Network/virtualNetworks/virtualNetworkPeerings/remoteVirtualNetwork.id} +Microsoft.Sql servers/virtualNetworkRules {Microsoft.Sql/servers/virtualNetworkRules/virtualNetworkSubnetId, Microsoft.Sql/servers/vi... +``` + +Lists all provider resource types whose resource type matches 'virtual' and contain an alias. + +### Example 5 +```powershell +Get-AzPolicyAlias -ResourceTypeMatch 'virtual' -ListAvailable +``` + +```output +Namespace ResourceType Aliases +--------- ------------ ------- + +... ... ... + +Microsoft.KeyVault locations/deleteVirtualNetworkOrSubnets {} +Microsoft.Network virtualNetworks {Microsoft.Network/virtualNetworks/subnets[*].routeTable.id,... +Microsoft.Network virtualNetworkGateways {Microsoft.Network/virtualNetworkGateways/sku.name, Microsof... +Microsoft.Network locations/virtualNetworkAvailableEndpointServices {} + +... ... ... +``` + +Lists all provider resource types whose resource type matches 'virtual', including those without aliases. + +### Example 6 +```powershell +Get-AzPolicyAlias -NamespaceMatch 'compute' -ResourceTypeMatch 'virtual' +``` + +```output +Namespace ResourceType Aliases +--------- ------------ ------- +Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Microsoft... +Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtualMachi... +Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineScaleSets/... +Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compute/virt... +``` + +Lists all provider resource types whose namespace matches 'compute' and resource type matches 'virtual' and contain an alias. +Note: -NamespaceMatch and -ResourceTypeMatch provide exclusive matches, whereas the others are inclusive. + +### Example 7 +```powershell +Get-AzPolicyAlias -AliasMatch 'virtual' +``` + +```output +Namespace ResourceType Aliases +--------- ------------ ------- +Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Mi... +Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtu... +Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineSca... +Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compu... +Microsoft.DocumentDB databaseAccounts {Microsoft.DocumentDB/databaseAccounts/sku.name, Microsoft.DocumentDB/databaseAccounts/v... +Microsoft.HDInsight clusters {Microsoft.HDInsight/clusters/clusterVersion, Microsoft.HDInsight/clusters/osType, Micro... +Microsoft.KeyVault vaults {Microsoft.KeyVault/vaults/sku.name, Microsoft.KeyVault/vaults/sku.family, Microsoft.Key... +Microsoft.Network virtualNetworks {Microsoft.Network/virtualNetworks/subnets[*].routeTable.id, Microsoft.Network/virtualNe... +Microsoft.Network virtualNetworkGateways {Microsoft.Network/virtualNetworkGateways/sku.name, Microsoft.Network/virtualNetworkGate... +Microsoft.Network virtualNetworks/subnets {Microsoft.Network/virtualNetworks/subnets/routeTable.id, Microsoft.Network/virtualNetwo... +Microsoft.Network virtualNetworks/virtualNetworkPeerings {Microsoft.Network/virtualNetworks/virtualNetworkPeerings/remoteVirtualNetwork.id} +Microsoft.Sql servers/virtualNetworkRules {Microsoft.Sql/servers/virtualNetworkRules/virtualNetworkSubnetId, Microsoft.Sql/servers... +Microsoft.Storage storageAccounts {Microsoft.Storage/storageAccounts/accountType, Microsoft.Storage/storageAccounts/sku.na... +``` + +Lists all provider resource types that contain an alias matching 'virtual'. + +### Example 8 +```powershell +Get-AzPolicyAlias -AliasMatch 'virtual' -PathMatch 'network' +``` + +```output +Namespace ResourceType Aliases +--------- ------------ ------- +Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Mi... +Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtu... +Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineSca... +Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compu... +Microsoft.DocumentDB databaseAccounts {Microsoft.DocumentDB/databaseAccounts/sku.name, Microsoft.DocumentDB/databaseAccounts/v... +Microsoft.HDInsight clusters {Microsoft.HDInsight/clusters/clusterVersion, Microsoft.HDInsight/clusters/osType, Micro... +Microsoft.KeyVault vaults {Microsoft.KeyVault/vaults/sku.name, Microsoft.KeyVault/vaults/sku.family, Microsoft.Key... +Microsoft.Network virtualNetworks {Microsoft.Network/virtualNetworks/subnets[*].routeTable.id, Microsoft.Network/virtualNe... +Microsoft.Network networkInterfaces {Microsoft.Network/networkInterfaces/ipconfigurations[*].subnet.id, Microsoft.Network/ne... +Microsoft.Network networkSecurityGroups {Microsoft.Network/networkSecurityGroups/securityRules[*].protocol, Microsoft.Network/ne... +Microsoft.Network virtualNetworkGateways {Microsoft.Network/virtualNetworkGateways/sku.name, Microsoft.Network/virtualNetworkGate... +Microsoft.Network virtualNetworks/subnets {Microsoft.Network/virtualNetworks/subnets/routeTable.id, Microsoft.Network/virtualNetwo... +Microsoft.Network virtualNetworks/virtualNetworkPeerings {Microsoft.Network/virtualNetworks/virtualNetworkPeerings/remoteVirtualNetwork.id} +Microsoft.Sql servers/virtualNetworkRules {Microsoft.Sql/servers/virtualNetworkRules/virtualNetworkSubnetId, Microsoft.Sql/servers... +Microsoft.Storage storageAccounts {Microsoft.Storage/storageAccounts/accountType, Microsoft.Storage/storageAccounts/sku.na... +``` + +Lists all provider resource types that contain an alias matching 'virtual' or an alias with a path matching 'network'. + +### Example 9 +```powershell +Get-AzPolicyAlias -ApiVersionMatch 'alpha' +``` + +```output +Namespace ResourceType Aliases +--------- ------------ ------- +Microsoft.Cache Redis {Microsoft.Cache/Redis/sku.name, Microsoft.Cache/Redis/sku.family, Microsoft.Cache/Redis/sku.capacity, Micros... +Microsoft.Cache Redis/firewallrules {Microsoft.Cache/Redis/firewallrules/startIP, Microsoft.Cache/Redis/firewallrules/endIP} +Microsoft.Security alerts {Microsoft.Security/alerts/state} +Microsoft.Security pricings {Microsoft.Security/pricings/pricingTier} +Microsoft.Security complianceResults {Microsoft.Security/complianceResults/resourceStatus} +``` + +Lists all provider resource types with alpha api version or containing an alias with an alpha api version. + +## PARAMETERS + +### -AliasMatch +Includes in the output items with aliases whose name matches this value. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Alias + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiVersion +When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiVersionMatch +Includes in the output items whose resource types or aliases have a matching api version. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListAvailable +Includes in the output matching items with and without aliases. + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: ShowAll + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationMatch +Includes in the output items whose resource types have a matching location. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Location + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceMatch +Limits the output to items whose namespace matches this value. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name, Namespace + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PathMatch +Includes in the output items with aliases containing a path that matches this value. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Path + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceTypeMatch +Limits the output to items whose resource type matches this value. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceType, Resource + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.PsResourceProviderAlias + +## NOTES + +* To expand the Aliases or any other property, pipe the output to `select -ExpandProperty <property>`. For example: `Get-AzPolicyAlias -NamespaceMatch 'Microsoft.Cache' -ApiVersionMatch 'alpha' | select -ExpandProperty Aliases | select -Property Name -ExpandProperty Paths` + +* Additional properties are available in the output and can be displayed by piping the output to `Format-List`. For example: `Get-AzPolicyAlias -NamespaceMatch 'Web' -ResourceTypeMatch site -PathMatch cert | Format-List` + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzPolicyAssignment.md b/azps-10.1.0/Az.Resources/Get-AzPolicyAssignment.md new file mode 100644 index 0000000000..bd46c7baf3 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzPolicyAssignment.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 2DBAF415-A039-479E-B3CA-E00FD5E476C9 +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azpolicyassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzPolicyAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzPolicyAssignment.md +--- + +# Get-AzPolicyAssignment + +## SYNOPSIS +Gets policy assignments. + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Get-AzPolicyAssignment [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### NameParameterSet +``` +Get-AzPolicyAssignment [-Name <String>] [-Scope <String>] [-PolicyDefinitionId <String>] [-ApiVersion <String>] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### IncludeDescendentParameterSet +``` +Get-AzPolicyAssignment [-Scope <String>] [-IncludeDescendent] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### IdParameterSet +``` +Get-AzPolicyAssignment -Id <String> [-PolicyDefinitionId <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPolicyAssignment** cmdlet gets all policy assignments or particular assignments. +Identify a policy assignment to get by name and scope or by ID. + +## EXAMPLES + +### Example 1: Get all policy assignments +```powershell +Get-AzPolicyAssignment +``` + +This command gets all the policy assignments. + +### Example 2: Get a specific policy assignment +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +Get-AzPolicyAssignment -Name 'PolicyAssignment07' -Scope $ResourceGroup.ResourceId +``` + +The first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet and stores it in the $ResourceGroup variable. +The second command gets the policy assignment named PolicyAssignment07 for the scope that the **ResourceId** property of $ResourceGroup identifies. + +### Example 3: Get all policy assignments assigned to a management group +```powershell +$mgId = 'myManagementGroup' +Get-AzPolicyAssignment -Scope '/providers/Microsoft.Management/managementgroups/$mgId' +``` + +The first command specifies the ID of the management group to query. +The second command gets all of the policy assignments that are assigned to the management group with ID 'myManagementGroup'. + +### Example 4: Get the scope, policy set definition identifier, and display name of all policy assignments formatted as a list + +```powershell +Get-AzPolicyAssignment | Select-Object -ExpandProperty properties | Select-Object -Property Scope, PolicyDefinitionID, DisplayName | Format-List +``` + +This command is useful when you need to find the reader-friendly **DisplayName** property of an Azure +Policy assignment. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the fully qualified resource ID for the policy assignment that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludeDescendent +Causes the list of returned policy assignments to include all assignments related to the given scope, including those from ancestor scopes and those from descendent scopes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: IncludeDescendentParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the policy assignment that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinitionId +Specifies the ID of the policy definition of the policy assignments that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet, IdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Specifies the scope at which the policy is applied for the assignment that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet, IncludeDescendentParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment + +## NOTES + +## RELATED LINKS + +[New-AzPolicyAssignment](./New-AzPolicyAssignment.md) + +[Remove-AzPolicyAssignment](./Remove-AzPolicyAssignment.md) + +[Set-AzPolicyAssignment](./Set-AzPolicyAssignment.md) + + diff --git a/azps-10.1.0/Az.Resources/Get-AzPolicyDefinition.md b/azps-10.1.0/Az.Resources/Get-AzPolicyDefinition.md new file mode 100644 index 0000000000..4f5f9a17f9 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzPolicyDefinition.md @@ -0,0 +1,288 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 6396AEC3-DFE6-45DA-BCF4-69C55C5D051B +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azpolicydefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzPolicyDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzPolicyDefinition.md +--- + +# Get-AzPolicyDefinition + +## SYNOPSIS +Gets policy definitions. + +## SYNTAX + +### NameParameterSet (Default) +``` +Get-AzPolicyDefinition [-Name <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ManagementGroupNameParameterSet +``` +Get-AzPolicyDefinition [-Name <String>] -ManagementGroupName <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionIdParameterSet +``` +Get-AzPolicyDefinition [-Name <String>] -SubscriptionId <Guid> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### IdParameterSet +``` +Get-AzPolicyDefinition -Id <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### BuiltinFilterParameterSet +``` +Get-AzPolicyDefinition [-ManagementGroupName <String>] [-SubscriptionId <Guid>] [-Builtin] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### CustomFilterParameterSet +``` +Get-AzPolicyDefinition [-ManagementGroupName <String>] [-SubscriptionId <Guid>] [-Custom] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPolicyDefinition** cmdlet gets a collection of policy definitions or a specific policy definition identified by name or ID. + +## EXAMPLES + +### Example 1: Get all policy definitions +```powershell +Get-AzPolicyDefinition +``` + +This command gets all the policy definitions. + +### Example 2: Get policy definition from current subscription by name +```powershell +Get-AzPolicyDefinition -Name 'VMPolicyDefinition' +``` + +This command gets the policy definition named VMPolicyDefinition from the current default subscription. + +### Example 3: Get policy definition from management group by name +```powershell +Get-AzPolicyDefinition -Name 'VMPolicyDefinition' -ManagementGroupName 'Dept42' +``` + +This command gets the policy definition named VMPolicyDefinition from the management group named Dept42. + +### Example 4: Get all built-in policy definitions from subscription +```powershell +Get-AzPolicyDefinition -SubscriptionId '3bf44b72-c631-427a-b8c8-53e2595398ca' -Builtin +``` + +This command gets all built-in policy definitions from the subscription with ID 3bf44b72-c631-427a-b8c8-53e2595398ca. + +### Example 5: Get policy definitions from a given category +```powershell +Get-AzPolicyDefinition | Where-Object {$_.Properties.metadata.category -eq 'Tags'} +``` + +This command gets all policy definitions in the category **Tags**. + +### Example 6: Get the display name, description, policy type, and metadata of all policy definitions formatted as a list + +```powershell +Get-AzPolicyDefinition | Select-Object -ExpandProperty properties | Select-Object -Property DisplayName, Description, PolicyType, Metadata | Format-List +``` + +This command is useful when you need to find the reader-friendly **DisplayName** property of an Azure +Policy definition. You can parse the **Metadata** property to discover the policy definition's version number and category assignment. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Builtin +Limits list of results to only built-in policy definitions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BuiltinFilterParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Custom +Limits list of results to only custom policy definitions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CustomFilterParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the fully qualified resource ID for the policy definition that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagementGroupName +The name of the management group of the policy definition(s) to get. + +```yaml +Type: System.String +Parameter Sets: ManagementGroupNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: BuiltinFilterParameterSet, CustomFilterParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the policy definition that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet, ManagementGroupNameParameterSet, SubscriptionIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID of the policy definition(s) to get. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: SubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: BuiltinFilterParameterSet, CustomFilterParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS + +[New-AzPolicyDefinition](./New-AzPolicyDefinition.md) + +[Remove-AzPolicyDefinition](./Remove-AzPolicyDefinition.md) + +[Set-AzPolicyDefinition](./Set-AzPolicyDefinition.md) + + diff --git a/azps-10.1.0/Az.Resources/Get-AzPolicyExemption.md b/azps-10.1.0/Az.Resources/Get-AzPolicyExemption.md new file mode 100644 index 0000000000..2bcb6f481d --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzPolicyExemption.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azpolicyexemption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzPolicyExemption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzPolicyExemption.md +--- + +# Get-AzPolicyExemption + +## SYNOPSIS +Gets policy exemptions. + +## SYNTAX + +### NameParameterSet (Default) +``` +Get-AzPolicyExemption [-Name <String>] [-Scope <String>] [-PolicyAssignmentIdFilter <String>] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### IncludeDescendentParameterSet +``` +Get-AzPolicyExemption [-Scope <String>] [-IncludeDescendent] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### IdParameterSet +``` +Get-AzPolicyExemption -Id <String> [-PolicyAssignmentIdFilter <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPolicyExemption** cmdlet gets all policy exemptions or particular exemptions. +Identify a policy exemption to get by name and scope or by ID. + +## EXAMPLES + +### Example 1 Get all policy exemptions +```powershell +Get-AzPolicyExemption +``` + +This command gets all the policy exemptions in the current subscription. If you need to list all the exemptions related to the given scope, including those from ancestor scopes and those from descendent scopes you need to pass the `-IncludeDescendent` parameter. + +### Example 2: Get a specific policy exemption +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +Get-AzPolicyExemption -Name 'PolicyExemption07' -Scope $ResourceGroup.ResourceId +``` + +The first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet and stores it in the $ResourceGroup variable. +The second command gets the policy exemption named PolicyExemption07 for the scope that the **ResourceId** property of $ResourceGroup identifies. + +### Example 3: Get all policy exemptions associated with a policy assignment +```powershell +$Assignment = Get-AzPolicyAssignment -Name 'PolicyAssignment07' +Get-AzPolicyExemption -PolicyAssignmentIdFilter $Assignment.ResourceId +``` + +The first command gets a policy assignment named PolicyAssignment07. +The second command gets all of the policy exemptions that are assigned with the policy assignment. + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified policy exemption ID to get, including the scope, e.g. +/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}. + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludeDescendent +Causes the list of returned policy exemptions to include all exemptions related to the given scope, including those from ancestor scopes and those from descendent scopes. +This parameter doesn't work when the requested scope is a management group scope. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: IncludeDescendentParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the policy exemption to get. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyAssignmentIdFilter +Limits the list of returned policy exemptions to those assigning the policy assignment identified by this fully qualified Id. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet, IdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the policy exemption to get, e.g. +/providers/managementGroups/{managementGroupName}, defaults to current subscription. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet, IncludeDescendentParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyExemption + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzPolicySetDefinition.md b/azps-10.1.0/Az.Resources/Get-AzPolicySetDefinition.md new file mode 100644 index 0000000000..3878862655 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzPolicySetDefinition.md @@ -0,0 +1,272 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azpolicysetdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzPolicySetDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzPolicySetDefinition.md +--- + +# Get-AzPolicySetDefinition + +## SYNOPSIS +Gets policy set definitions. + +## SYNTAX + +### NameParameterSet (Default) +``` +Get-AzPolicySetDefinition [-Name <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ManagementGroupNameParameterSet +``` +Get-AzPolicySetDefinition [-Name <String>] -ManagementGroupName <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionIdParameterSet +``` +Get-AzPolicySetDefinition [-Name <String>] -SubscriptionId <Guid> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### IdParameterSet +``` +Get-AzPolicySetDefinition -Id <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### BuiltinFilterParameterSet +``` +Get-AzPolicySetDefinition [-ManagementGroupName <String>] [-SubscriptionId <Guid>] [-Builtin] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### CustomFilterParameterSet +``` +Get-AzPolicySetDefinition [-ManagementGroupName <String>] [-SubscriptionId <Guid>] [-Custom] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzPolicySetDefinition** cmdlet gets a collection of policy set definitions or a specific policy set definition identified by name or ID. + +## EXAMPLES + +### Example 1: Get all policy set definitions +```powershell +Get-AzPolicySetDefinition +``` + +This command gets all the policy set definitions. + +### Example 2: Get policy set definition from current subscription by name +```powershell +Get-AzPolicySetDefinition -Name 'VMPolicySetDefinition' +``` + +This command gets the policy set definition named VMPolicySetDefinition from the current default subscription. + +### Example 3: Get policy set definition from subscription by name +```powershell +Get-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -subscriptionId '3bf44b72-c631-427a-b8c8-53e2595398ca' +``` + +This command gets the policy definition named VMPolicySetDefinition from the subscription with ID 3bf44b72-c631-427a-b8c8-53e2595398ca. + +### Example 4: Get all custom policy set definitions from management group +```powershell +Get-AzPolicySetDefinition -ManagementGroupName 'Dept42' -Custom +``` + +This command gets all custom policy set definitions from the management group named Dept42. + +### Example 5: Get policy set definitions from a given category +```powershell +Get-AzPolicySetDefinition | Where-Object {$_.Properties.metadata.category -eq "Virtual Machine"} +``` + +This command gets all policy set definitions in category "Virtual Machine". + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Builtin +Limits list of results to only built-in policy set definitions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BuiltinFilterParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Custom +Limits list of results to only custom policy set definitions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CustomFilterParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified policy set definition Id, including the subscription. +e.g. +/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagementGroupName +The name of the management group of the policy set definition(s) to get. + +```yaml +Type: System.String +Parameter Sets: ManagementGroupNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: BuiltinFilterParameterSet, CustomFilterParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The policy set definition name. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet, ManagementGroupNameParameterSet, SubscriptionIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID of the policy set definition(s) to get. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: SubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: BuiltinFilterParameterSet, CustomFilterParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzPrivateLinkAssociation.md b/azps-10.1.0/Az.Resources/Get-AzPrivateLinkAssociation.md new file mode 100644 index 0000000000..9f7481d705 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzPrivateLinkAssociation.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azprivatelinkassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzPrivateLinkAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzPrivateLinkAssociation.md +--- + +# Get-AzPrivateLinkAssociation + +## SYNOPSIS +Gets all the Azure Resource Management Private Link Association(s). + +## SYNTAX + +``` +Get-AzPrivateLinkAssociation [-ManagementGroupId] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzPrivateLinkAssociation cmdlet gets all of resource management private link at the scope. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzPrivateLinkAssociation -ManagementGroupId fc096d27-0434-4460-a3ea-110df0422a2d | Format-List +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/fc096d27-0434-4460-a3ea-110df0422a2d/providers/Microsoft. + Authorization/privateLinkAssociations/7afcb623-ff23-591c-8cdd-57f5357711f4 +Type : Microsoft.Authorization/privateLinkAssociations +Name : 7afcb623-ff23-591c-8cdd-57f5357711f4 +Properties : {"privateLink":"/subscriptions/aeb49941-36c3-4e7c-9ffd-16ba89d33ec4/resourceGroups/nrp-validate/providers/ + Microsoft.Authorization/resourceManagementPrivateLinks/DeepDiveRMPL","publicNetworkAccess":"Enabled","tena + ntID":"fc096d27-0434-4460-a3ea-110df0422a2d","scope":"/providers/Microsoft.Management/managementGroups/24f + 15700-370c-45bc-86a7-aee1b0c4eb8a"} + +Id : /providers/Microsoft.Management/managementGroups/fc096d27-0434-4460-a3ea-110df0422a2d/providers/Microsoft. + Authorization/privateLinkAssociations/1d7942d1-288b-48de-8d0f-2d2aa8e03ad4 +Type : Microsoft.Authorization/privateLinkAssociations +Name : 1d7942d1-288b-48de-8d0f-2d2aa8e03ad4 +Properties : {"privateLink":"/subscriptions/aeb49941-36c3-4e7c-9ffd-16ba89d33ec4/resourceGroups/nrp-validate/providers/ + Microsoft.Authorization/resourceManagementPrivateLinks/DeepDiveRMPL","publicNetworkAc + cess":"Enabled","tenantID":"fc096d27-0434-4460-a3ea-110df0422a2d","scope":"/providers/Microsoft.Management + /managementGroups/fc096d27-0434-4460-a3ea-110df0422a2d"} +``` + +Get all the private link associations at the managment group scope. + +### Example 2 +```powershell +Get-AzPrivateLinkAssociation -ManagementGroupId fc096d27-0434-4460-a3ea-110df0422a2d -Name 1d7942d1-288b-48de-8d0f-2d2aa8e03ad4 | Format-List +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/fc096d27-0434-4460-a3ea-110df0422a2d/providers/Microsoft. + Authorization/privateLinkAssociations/1d7942d1-288b-48de-8d0f-2d2aa8e03ad4 +Type : Microsoft.Authorization/privateLinkAssociations +Name : 1d7942d1-288b-48de-8d0f-2d2aa8e03ad4 +Properties : {"privateLink":"/subscriptions/aeb49941-36c3-4e7c-9ffd-16ba89d33ec4/resourceGroups/nrp-validate/providers/ + Microsoft.Authorization/resourceManagementPrivateLinks/DeepDiveRMPL","publicNetworkAc + cess":"Enabled","tenantID":"fc096d27-0434-4460-a3ea-110df0422a2d","scope":"/providers/Microsoft.Management + /managementGroups/fc096d27-0434-4460-a3ea-110df0422a2d"} +``` + +Get the specific private link associations at the managment group scope. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The private link association Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PrivateLinkAssociationId + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.PrivateLinks.PSResourceManagementPrivateLinkAssociation + +## NOTES + +## RELATED LINKS + +[Remove-AzPrivateLinkAssociation](./Remove-AzPrivateLinkAssociation.md) +[New-AzPrivateLinkAssociation](./New-AzPrivateLinkAssociation.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Resources/Get-AzProviderFeature.md b/azps-10.1.0/Az.Resources/Get-AzProviderFeature.md new file mode 100644 index 0000000000..9726c4b34b --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzProviderFeature.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 2970E81E-A788-4829-B1FF-B522A91DE4B1 +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azproviderfeature +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzProviderFeature.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzProviderFeature.md +--- + +# Get-AzProviderFeature + +## SYNOPSIS +Gets information about Azure provider features. + +## SYNTAX + +### ListAvailableParameterSet (Default) +``` +Get-AzProviderFeature [-ProviderNamespace <String>] [-ListAvailable] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetFeature +``` +Get-AzProviderFeature -ProviderNamespace <String> -FeatureName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzProviderFeature** cmdlet gets the feature name, provider name, and registration status for Azure provider features. + +## EXAMPLES + +### Example 1: Get all available features +```powershell +Get-AzProviderFeature -ListAvailable +``` + +This command gets all available features. + +### Example 2: Get information about a specific feature +```powershell +Get-AzProviderFeature -FeatureName "AllowPreReleaseRegions" -ProviderNamespace "Microsoft.Compute" +``` + +This command gets information for the feature named AllowPreReleaseRegions for the specified provider. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureName +Specifies the name of the feature to get. + +```yaml +Type: System.String +Parameter Sets: GetFeature +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListAvailable +Indicates that this cmdlet gets all features. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ListAvailableParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +Specifies the namespace for which this cmdlet gets provider features. + +```yaml +Type: System.String +Parameter Sets: ListAvailableParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetFeature +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSProviderFeature + +## NOTES + +## RELATED LINKS + +[Register-AzProviderFeature](./Register-AzProviderFeature.md) + + diff --git a/azps-10.1.0/Az.Resources/Get-AzProviderOperation.md b/azps-10.1.0/Az.Resources/Get-AzProviderOperation.md new file mode 100644 index 0000000000..cb31f0b4db --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzProviderOperation.md @@ -0,0 +1,93 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 6424B740-DBFB-490C-AEAA-EDD60952B435 +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azprovideroperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzProviderOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzProviderOperation.md +--- + +# Get-AzProviderOperation + +## SYNOPSIS +Gets the operations for an Azure resource provider that are securable using Azure RBAC. + +## SYNTAX + +``` +Get-AzProviderOperation [[-OperationSearchString] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzProviderOperation gets the operations exposed by Azure resource providers. +Operations can be composed to create custom roles in Azure RBAC. +The command takes as input an operation search string (with possible wildcard(*) character(s)) which determines the operations details to display. +Use Get-AzProviderOperation * to get all operations for all Azure resource providers. +Use Get-AzProviderOperation Microsoft.Compute/* to get all operations of Microsoft.Compute resource provider. + +## EXAMPLES + +### Example 1: Get all actions for all providers +```powershell +Get-AzProviderOperation * +``` + +### Example 2: Get actions for a particular resource provider +```powershell +Get-AzProviderOperation Microsoft.Insights/* +``` + +### Example 3: Get all actions that can be performed on virtual machines +```powershell +Get-AzProviderOperation */virtualMachines/* +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationSearchString +The operation search string (with possible wildcard (*) characters) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 0 +Default value: "*" +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.PSResourceProviderOperation + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzProviderPreviewFeature.md b/azps-10.1.0/Az.Resources/Get-AzProviderPreviewFeature.md new file mode 100644 index 0000000000..1c4d225faa --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzProviderPreviewFeature.md @@ -0,0 +1,98 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azproviderpreviewfeature +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzProviderPreviewFeature.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzProviderPreviewFeature.md +--- + +# Get-AzProviderPreviewFeature + +## SYNOPSIS +Gets a feature registration in your account. + +## SYNTAX + +``` +Get-AzProviderPreviewFeature [-Name <String>] -ProviderNamespace <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzProviderPreviewFeature** cmdlet gets a feature registration in your account. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzProviderPreviewFeature -FeatureName AllowApplicationSecurityGroups -ProviderNamespace Microsoft.Network +``` + +This gets the AllowApplicationSecurityGroups feature for Microsoft.Network in your account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The feature name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FeatureName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProviderNamespace +The resource provider namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.ResourceManager.Models.PSSubscriptionFeatureRegistration + +## NOTES + +## RELATED LINKS + +[Register-AzProviderPreviewFeature](./Register-AzProviderPreviewFeature.md) + +[Unregister-AzProviderPreviewFeature](./Unregister-AzProviderPreviewFeature.md) diff --git a/azps-10.1.0/Az.Resources/Get-AzResource.md b/azps-10.1.0/Az.Resources/Get-AzResource.md new file mode 100644 index 0000000000..4479f67ef5 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzResource.md @@ -0,0 +1,379 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: C2C608E5-3351-4D01-8533-9668B2E9F1D1 +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResource.md +--- + +# Get-AzResource + +## SYNOPSIS + +Gets resources. + +## SYNTAX + +### ByTagNameValueParameterSet (Default) +``` +Get-AzResource [-Name <String>] [-ResourceType <String>] [-ODataQuery <String>] [-ResourceGroupName <String>] + [-TagName <String>] [-TagValue <String>] [-ExpandProperties] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzResource -ResourceId <String> [-ODataQuery <String>] [-ExpandProperties] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTagObjectParameterSet +``` +Get-AzResource [-Name <String>] [-ResourceType <String>] [-ODataQuery <String>] [-ResourceGroupName <String>] + -Tag <Hashtable> [-ExpandProperties] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION + +The **Get-AzResource** cmdlet gets Azure resources. + +## EXAMPLES + +### Example 1: Get all resources in the current subscription + +```powershell +Get-AzResource | Format-Table +``` + +```output +Name ResourceGroupName ResourceType Location +---- ----------------- ------------ -------- +testVM testRG Microsoft.Compute/virtualMachines westus +disk testRG Microsoft.Compute/disks westus +nic testRG Microsoft.Network/networkInterfaces westus +nsg testRG Microsoft.Network/networkSecurityGroups westus +ip testRG Microsoft.Network/publicIPAddresses westus +vnet testRG Microsoft.Network/virtualNetworks westus +testKV otherRG Microsoft.KeyVault/vaults eastus +storage otherResourceGroup Microsoft.Storage/storageAccounts eastus +testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastus +``` + +This command gets all of the resources in the current subscription. + +### Example 2: Get all resources in a resource group + +```powershell +Get-AzResource -ResourceGroupName testRG | Format-Table +``` + +```output +Name ResourceGroupName ResourceType Location +---- ----------------- ------------ -------- +testVM testRG Microsoft.Compute/virtualMachines westus +disk testRG Microsoft.Compute/disks westus +nic testRG Microsoft.Network/networkInterfaces westus +nsg testRG Microsoft.Network/networkSecurityGroups westus +ip testRG Microsoft.Network/publicIPAddresses westus +vnet testRG Microsoft.Network/virtualNetworks westus +``` + +This command gets all of the resources in the resource group "testRG". + +### Example 3: Get all resources whose resource group matches the provided wildcard + +```powershell +Get-AzResource -ResourceGroupName other* | Format-Table +``` + +```output +Name ResourceGroupName ResourceType Location +---- ----------------- ------------ -------- +testKV otherRG Microsoft.KeyVault/vaults eastus +storage otherResourceGroup Microsoft.Storage/storageAccounts eastus +testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastus +``` + +This command gets all of the resources whose resource group they belong in beings with "other". + +### Example 4: Get all resources with a given name + +```powershell +Get-AzResource -Name testVM | Format-List +``` + +```output +Name : testVM +ResourceGroupName : testRG +ResourceType : Microsoft.Compute/virtualMachines +Location : westus +ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testVM +Tags : + Name Value + ====== ======== + Dept IT + Year 2002 + Status Approved +``` + +This command gets all of the resources whose resource name is "testVM". + +### Example 5: Get all resources whose name matches the provided wildcard + +```powershell +Get-AzResource -Name test* | Format-Table +``` + +```output +Name ResourceGroupName ResourceType Location +---- ----------------- ------------ -------- +testVM testRG Microsoft.Compute/virtualMachines westus +testKV otherRG Microsoft.KeyVault/vaults eastus +testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastus +``` + +This command gets all of the resources whose resource name begins with "test". + +### Example 6: Get all resources of a given resource type + +```powershell +Get-AzResource -ResourceType Microsoft.Compute/virtualMachines | Format-Table +``` + +```output +Name ResourceGroupName ResourceType Location +---- ----------------- ------------ -------- +testVM testRG Microsoft.Compute/virtualMachines westus +testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastus +``` + +This command gets all of the resources in the current subscriptions that are virtual machines. + +### Example 7: Get a resource by resource id + +```powershell +Get-AzResource -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testVM +``` + +```output +Name : testVM +ResourceGroupName : testRG +ResourceType : Microsoft.Compute/virtualMachines +Location : westus +ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testVM +Tags : + Name Value + ====== ======== + Dept IT + Year 2002 + Status Approved +``` + +This command gets the resource with the provided resource id, which is a virtual machine called "testVM" in the resource group "testRG". + +## PARAMETERS + +### -ApiVersion + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandProperties +When specified, expands the properties of the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the resource(s) to be retrieved. This parameter supports wildcards at the beginning and/or end of the string. + +```yaml +Type: System.String +Parameter Sets: ByTagNameValueParameterSet, ByTagObjectParameterSet +Aliases: ResourceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ODataQuery + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group the resource(s) that is retrieved belongs in. This parameter supports wildcards at the beginning and/or end of the string. + +```yaml +Type: System.String +Parameter Sets: ByTagNameValueParameterSet, ByTagObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceId +Specifies the fully qualified resource ID, as in the following example +`/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Compute/virtualMachines` + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +The resource type of the resource(s) to be retrieved. For example, Microsoft.Compute/virtualMachines + +```yaml +Type: System.String +Parameter Sets: ByTagNameValueParameterSet, ByTagObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag + +Gets resources that have the specified Azure tag. Enter a hash table with a Name key or Name and Value keys. Wildcard characters are not supported.A "tag" is a name-value pair that you can apply to resources and resource groups. Use tags to categorize your resources, such as by department or cost center, or to track notes or comments about the resources. To add a tag to a resource, use the Tag parameter of the New-AzResource or Set-AzResource cmdlets. To create a predefined tag, use the New-AzTag cmdlet. For help with hash tables in Windows PowerShell, run 'Get-Help about_Hashtables'. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTagObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagName +The key in the tag of the resource(s) to be retrieved. + +```yaml +Type: System.String +Parameter Sets: ByTagNameValueParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagValue +The value in the tag of the resource(s) to be retrieved. + +```yaml +Type: System.String +Parameter Sets: ByTagNameValueParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResource + +## NOTES + +## RELATED LINKS + +[Move-AzResource](./Move-AzResource.md) + +[New-AzResource](./New-AzResource.md) + +[Remove-AzResource](./Remove-AzResource.md) + +[Set-AzResource](./Set-AzResource.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Resources/Get-AzResourceGroup.md b/azps-10.1.0/Az.Resources/Get-AzResourceGroup.md new file mode 100644 index 0000000000..f66b7077b2 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzResourceGroup.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 5B17A241-BF36-48A6-BC29-4C32C08F5F94 +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azresourcegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceGroup.md +--- + +# Get-AzResourceGroup + +## SYNOPSIS +Gets resource groups. + +## SYNTAX + +### GetByResourceGroupName (Default) +``` +Get-AzResourceGroup [[-Name] <String>] [[-Location] <String>] [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceGroupId +``` +Get-AzResourceGroup [[-Location] <String>] [-Id <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzResourceGroup** cmdlet gets Azure resource groups in the current subscription. +You can get all resource groups, or specify a resource group by name or by other properties. +By default, this cmdlet gets all resource groups in the current subscription. +For more information about Azure resources and Azure resource groups, see the New-AzResourceGroup cmdlet. + +## EXAMPLES + +### Example 1: Get a resource group by name +```powershell +Get-AzResourceGroup -Name "EngineerBlog" +``` + +This command gets the Azure resource group in your subscription named EngineerBlog. + +### Example 2: Get all tags of a resource group +```powershell +(Get-AzResourceGroup -Name "ContosoRG").Tags +``` + +This command gets the resource group named ContosoRG, and displays the tags associated with that group. + +### Example 3: Get resource groups based on tag +```powershell +Get-AzResourceGroup -Tag @{'environment'='prod'} +``` + +### Example 4: Show the Resource groups by location +```powershell +Get-AzResourceGroup | + Sort-Object Location,ResourceGroupName | + Format-Table -GroupBy Location ResourceGroupName,ProvisioningState,Tags +``` + +### Example 5: Show the names of all the Resource groups in a particular location +```powershell +Get-AzResourceGroup -Location westus2 | + Sort-Object ResourceGroupName | + Format-Wide ResourceGroupName -Column 4 +``` + +### Example 6: Show the Resource groups whose names begin with WebServer +```powershell +Get-AzResourceGroup -Name WebServer* +``` + +## PARAMETERS + +### -ApiVersion +Specifies the API version that is supported by the resource Provider. +You can specify a different version than the default version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the resource group to get. +Wildcard characters are not permitted. + +```yaml +Type: System.String +Parameter Sets: GetByResourceGroupId +Aliases: ResourceGroupId, ResourceId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the resource group to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the resource group to get. This parameter supports wildcards at the beginning and/or the end of the string. + +```yaml +Type: System.String +Parameter Sets: GetByResourceGroupName +Aliases: ResourceGroupName + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tag hashtable to filter resource groups by. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: GetByResourceGroupName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceGroup + +## NOTES + +## RELATED LINKS + +[New-AzResourceGroup](./New-AzResourceGroup.md) + +[Remove-AzResourceGroup](./Remove-AzResourceGroup.md) + +[Set-AzResourceGroup](./Set-AzResourceGroup.md) + diff --git a/azps-10.1.0/Az.Resources/Get-AzResourceGroupDeployment.md b/azps-10.1.0/Az.Resources/Get-AzResourceGroupDeployment.md new file mode 100644 index 0000000000..a7e86717a1 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzResourceGroupDeployment.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 20CB842B-F7A9-4052-85D9-0DF9586D5FEA +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azresourcegroupdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceGroupDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceGroupDeployment.md +--- + +# Get-AzResourceGroupDeployment + +## SYNOPSIS +Gets the deployments in a resource group. + +## SYNTAX + +### GetByResourceGroupDeploymentName (Default) +``` +Get-AzResourceGroupDeployment [-ResourceGroupName] <String> [[-Name] <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceGroupDeploymentId +``` +Get-AzResourceGroupDeployment -Id <String> [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzResourceGroupDeployment** cmdlet gets the deployments in an Azure resource group. +Specify the *Name* or *Id* parameter to filter the results. +By default, **Get-AzResourceGroupDeployment** gets all deployments for a specified resource group. +An Azure resource is a user-managed Azure entity, such as a database server, database, or web site. +An Azure resource group is a collection of Azure resources that are deployed as a unit. +A deployment is the operation that makes the resources in the resource group available for use. +For more information about Azure resources and Azure resource groups, see the New-AzResourceGroup cmdlet. +You can use this cmdlet for tracking. +For debugging, use this cmdlet with the Get-AzLog cmdlet. + +## EXAMPLES + +### Example 1: Get all deployments for a resource group +```powershell +Get-AzResourceGroupDeployment -ResourceGroupName "ContosoLabsRG" +``` + +This command gets all deployments for the ContosoLabsRG resource group. +The output shows a deployment for a WordPress blog that used a gallery template. + +### Example 2: Get a deployment by name +```powershell +Get-AzResourceGroupDeployment -ResourceGroupName "ContosoLabsRG" -Name "DeployWebsite01" +``` + +This command gets the DeployWebsite01 deployment of the ContosoLabsRG resource group. +You can assign a name to a deployment when you create it by using the **New-AzResourceGroup** or **New-AzResourceGroupDeployment** cmdlets. +If you do not assign a name, the cmdlets provide a default name based on the template that is used to create the deployment. + +### Example 3: Get the deployments of all resource groups +```powershell +Get-AzResourceGroup | Get-AzResourceGroupDeployment | Format-Table ResourceGroupName, DeploymentName, ProvisioningState +``` + +This command gets all resource groups in your subscription by using the Get-AzResourceGroup cmdlet. +The command passes the resource groups to the current cmdlet by using the pipeline operator. +The current cmdlet gets all deployments of all resource groups in the subscription, and passes the results to the Format-Table cmdlet to display their **ResourceGroupName**, **DeploymentName**, and **ProvisioningState** property values. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the resource group deployment to get. + +```yaml +Type: System.String +Parameter Sets: GetByResourceGroupDeploymentId +Aliases: DeploymentId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the deployment to get. +Wildcard characters are not permitted. + +```yaml +Type: System.String +Parameter Sets: GetByResourceGroupDeploymentName +Aliases: DeploymentName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +The cmdlet gets the deployments for the resource group that this parameter specifies. +Wildcard characters are not permitted. +This parameter is required and you can specify only one resource group in each command. + +```yaml +Type: System.String +Parameter Sets: GetByResourceGroupDeploymentName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceGroupDeployment + +## NOTES + +## RELATED LINKS + +[Get-AzResourceGroup](./Get-AzResourceGroup.md) + +[New-AzResourceGroup](./New-AzResourceGroup.md) + +[New-AzResourceGroupDeployment](./New-AzResourceGroupDeployment.md) + +[Remove-AzResourceGroupDeployment](./Remove-AzResourceGroupDeployment.md) + +[Stop-AzResourceGroupDeployment](./Stop-AzResourceGroupDeployment.md) + +[Test-AzResourceGroupDeployment](./Test-AzResourceGroupDeployment.md) + + diff --git a/azps-10.1.0/Az.Resources/Get-AzResourceGroupDeploymentOperation.md b/azps-10.1.0/Az.Resources/Get-AzResourceGroupDeploymentOperation.md new file mode 100644 index 0000000000..5009fb751e --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzResourceGroupDeploymentOperation.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 9F29DFCB-A02B-45A5-99B9-C054BF4FCA6C +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azresourcegroupdeploymentoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceGroupDeploymentOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceGroupDeploymentOperation.md +--- + +# Get-AzResourceGroupDeploymentOperation + +## SYNOPSIS +Gets the resource group deployment operation + +## SYNTAX + +``` +Get-AzResourceGroupDeploymentOperation -DeploymentName <String> -ResourceGroupName <String> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzResourceGroupDeploymentOperation** cmdlet lists all the operations that were part of a deployment to help you identify and give more information about the exact operations that failed for a particular deployment. +It can also show the response and the request content for each deployment operation. +This is the same information provided in the deployment details on the portal. +To get the request and the response content, enable the setting when submitting a deployment through **New-AzResourceGroupDeployment**. +It can potentially log and expose secrets like passwords used in the resource property or **listKeys** operations that are then returned when you retrieve the deployment operations. +For more on this setting and how to enable it, see New-AzResourceGroupDeployment and Debugging ARM template deployments + +## EXAMPLES + +### Example 1: Get1 +```powershell +Get-AzResourceGroupDeploymentOperation -DeploymentName test -ResourceGroupName test +``` + +Gets deployment operation with name "test" under resource group "test" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The deployment name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentOperation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzResourceGroupDeploymentStack.md b/azps-10.1.0/Az.Resources/Get-AzResourceGroupDeploymentStack.md new file mode 100644 index 0000000000..73a1687d7f --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzResourceGroupDeploymentStack.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/Get-AzResourceGroupDeploymentStack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceGroupDeploymentStack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceGroupDeploymentStack.md +--- + +# Get-AzResourceGroupDeploymentStack + +## SYNOPSIS +Gets Resource Group scoped Deployment Stacks. + +## SYNTAX + +### ListByResourceGroupName (Default) +``` +Get-AzResourceGroupDeploymentStack [-ResourceGroupName] <String> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceId +``` +Get-AzResourceGroupDeploymentStack -ResourceId <String> [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByName +``` +Get-AzResourceGroupDeploymentStack [-ResourceGroupName] <String> [-Name] <String> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve a resource group scoped deployment stack. + +## EXAMPLES + +### Example 1: Retrieve a stack named MyRGStack from the resource group MyResourceGroup +```powershell +Get-AzResourceGroupDeploymentStack -ResourceGroupName MyResourceGroup -Name MyRGStack +``` + +Get a deployment stack named 'MyRGStack' under an RG named 'MyResourceGroup'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the DeploymentStack to get + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: StackName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The id of the ResourceGroup where the DeploymentStack is deployed + +```yaml +Type: System.String +Parameter Sets: ListByResourceGroupName, GetByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the DeploymentStack to get + +```yaml +Type: System.String +Parameter Sets: GetByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStack + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzResourceGroupDeploymentWhatIfResult.md b/azps-10.1.0/Az.Resources/Get-AzResourceGroupDeploymentWhatIfResult.md new file mode 100644 index 0000000000..009e140066 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzResourceGroupDeploymentWhatIfResult.md @@ -0,0 +1,426 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azresourcegroupdeploymentwhatifresult +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceGroupDeploymentWhatIfResult.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceGroupDeploymentWhatIfResult.md +--- + +# Get-AzResourceGroupDeploymentWhatIfResult + +## SYNOPSIS +Gets a template What-If result for a deployment at resource group scope. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterObject +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterObject +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterObject +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterFile +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterFile +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterFile +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParams +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterUri +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterUri +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterUri +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsUri +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateObjectWithNoParameters +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceId +``` +Get-AzResourceGroupDeploymentWhatIfResult [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-ResultFormat <WhatIfResultFormat>] [-ExcludeChangeType <String[]>] -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzResourceGroupDeploymentWhatIfResult** cmdlet gets the ARM template What-If result for a template deployment at the specified resource group scope. It returns a list of changes indicating what resources will be updated if the deployment is applied without making any changes to real resources. To specify the format for the returning result, use the *ResultFormat* parameter. + +## EXAMPLES + +### Example 1: Get a What-If result at resource group scope +```powershell +Get-AzResourceGroupDeploymentWhatIfResult ` + -DeploymentName "deploy-01" ` + -ResourceGroupName "myRG1" ` + -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" ` + -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" ` + -ResultFormat "FullResourcePayloads" +``` + +This command gets a What-If result at the specified resource group scope by using a custom template file and a parameter file on disk. +The command uses the *ResourceGroupName* parameter to specify a resource group where the template will be deployed. +The command uses the *TemplateFile* parameter to specify a template file. +The command uses the *TemplateParameterFile* parameter to specify a template parameter file. +The command uses the *ResultFormat* parameter to set the What-If result to include full resource payloads. + +### Example 2: Get a What-If result at resource group scope with ResourceIdOnly +```powershell +Get-AzResourceGroupDeploymentWhatIfResult ` + -DeploymentName "deploy-01" ` + -ResourceGroupName "myRG1" ` + -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" ` + -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" ` + -ResultFormat "ResourceIdOnly" +``` + +This command gets a What-If result at the specified resource group scope by using a custom template file and a parameter file on disk. +The command uses the *ResourceGroupName* parameter to specify a resource group where the template will be deployed. +The command uses the *TemplateFile* parameter to specify a template file. +The command uses the *TemplateParameterFile* parameter to specify a template parameter file. +The command uses the *ResultFormat* parameter to set the What-If result to only contain resource IDs. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeChangeType +Comma-separated resource change types to be excluded from What-If results. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The deployment mode. + +```yaml +Type: Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode +Parameter Sets: (All) +Aliases: +Accepted values: Incremental, Complete + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. "20131223140835". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResultFormat +The What-If result format. + +```yaml +Type: Microsoft.Azure.Management.ResourceManager.Models.WhatIfResultFormat +Parameter Sets: (All) +Aliases: +Accepted values: ResourceIdOnly, FullResourcePayloads + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. +This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. +For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +Local path to the template file. Supported template file type: json and bicep. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateObject +A hash table which represents the template. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateObjectAndParameterFile, ByTemplateObjectAndParameterUri, ByTemplateObjectWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +A file that has the template parameters. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterFile, ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile, ByTemplateSpecResourceIdAndParams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Uri to the template parameter file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterUri, ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri, ByTemplateSpecResourceIdAndParamsUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +Resource ID of the templateSpec to be deployed. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Uri to the template file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.Deployments.PSWhatIfOperationResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzResourceLock.md b/azps-10.1.0/Az.Resources/Get-AzResourceLock.md new file mode 100644 index 0000000000..5f6679381f --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzResourceLock.md @@ -0,0 +1,253 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 3FBF91B8-8EF9-4E05-AD7E-AEFC6EBBFB8E +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azresourcelock +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceLock.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceLock.md +--- + +# Get-AzResourceLock + +## SYNOPSIS +Gets a resource lock. + +## SYNTAX + +### ByResourceGroup +``` +Get-AzResourceLock [-LockName <String>] [-AtScope] -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceGroupLevel +``` +Get-AzResourceLock [-LockName <String>] [-AtScope] -ResourceName <String> -ResourceType <String> + -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### BySpecifiedScope +``` +Get-AzResourceLock [-LockName <String>] [-AtScope] -Scope <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### BySubscription +``` +Get-AzResourceLock [-LockName <String>] [-AtScope] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### BySubscriptionLevel +``` +Get-AzResourceLock [-LockName <String>] [-AtScope] -ResourceName <String> -ResourceType <String> + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByLockId +``` +Get-AzResourceLock [-AtScope] -LockId <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzResourceLock** cmdlet gets Azure resource locks. + +## EXAMPLES + +### Example 1: Get a lock +```powershell +Get-AzResourceLock -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites" -ResourceGroupName "ResourceGroup11" +``` + +This command gets the resource lock named ContosoSiteLock. + +### Example 2: Get locks at resource group level or higher +```powershell +Get-AzResourceLock -ResourceGroupName "ResourceGroup11" -AtScope +``` + +This command gets the resource locks on the resource group or the subscription. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AtScope +Indicates that this cmdlet returns all locks at or above the specified scope. +If you do not specify this parameter, the cmdlet returns all locks at, above, or below the scope. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LockId +Specifies the ID of the lock that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ByLockId +Aliases: Id, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LockName +Specifies the name of the lock that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup, ByResourceGroupLevel, BySpecifiedScope, BySubscription, BySubscriptionLevel +Aliases: ExtensionResourceName, Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which the lock applies. +This cmdlet gets locks for this resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup, ByResourceGroupLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +Specifies the name of the resource for which this lock applies. +This cmdlet gets locks for this resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +Specifies the resource type of the resource for which this lock applies. +This cmdlet gets locks for this resource. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Specifies the scope to which the lock applies. +The cmdlet gets locks for this scope. + +```yaml +Type: System.String +Parameter Sets: BySpecifiedScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS + +[New-AzResourceLock](./New-AzResourceLock.md) + +[Remove-AzResourceLock](./Remove-AzResourceLock.md) + +[Set-AzResourceLock](./Set-AzResourceLock.md) + + diff --git a/azps-10.1.0/Az.Resources/Get-AzResourceManagementPrivateLink.md b/azps-10.1.0/Az.Resources/Get-AzResourceManagementPrivateLink.md new file mode 100644 index 0000000000..b4a16b9738 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzResourceManagementPrivateLink.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azresourcemanagementprivatelink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceManagementPrivateLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceManagementPrivateLink.md +--- + +# Get-AzResourceManagementPrivateLink + +## SYNOPSIS +Gets Azure Resource Management Private Link(s) + +## SYNTAX + +``` +Get-AzResourceManagementPrivateLink [[-ResourceGroupName] <String>] [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzResourceManagementPrivateLink cmdlet gets a specific resource management private link. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzResourceManagementPrivateLink -ResourceGroupName PrivateLinkTestRG -Name NewPL +``` + +```output +Id : /subscriptions/aeb49941-36c3-4e7c-9ffd-16ba89d33ec4/resourceGroups/PrivateLinkTestRG/provi + ders/Microsoft.Authorization/resourceManagementPrivateLinks/NewPL +Type : Microsoft.Authorization/resourceManagementPrivateLinks +Name : NewPL +Location : centralus +PrivateEndpointConnections : {} +``` + +Get the resource management private link with the private endpoint connections associated with it. + +### Example 2 +```powershell +Get-AzResourceManagementPrivateLink +``` + +```output +Id : /subscriptions/aeb49941-36c3-4e7c-9ffd-16ba89d33ec4/resourceGroups/PrivateLinkTestRG/provi + ders/Microsoft.Authorization/resourceManagementPrivateLinks/NewPL +Type : Microsoft.Authorization/resourceManagementPrivateLinks +Name : NewPL +Location : centralus +PrivateEndpointConnections : {} + +Id : /subscriptions/aeb49941-36c3-4e7c-9ffd-16ba89d33ec4/resourceGroups/PrivateLinkTestRG/provi + ders/Microsoft.Authorization/resourceManagementPrivateLinks/NewPL2 +Type : Microsoft.Authorization/resourceManagementPrivateLinks +Name : NewPL2 +Location : centralus +PrivateEndpointConnections : {} +``` + +Gets all of the resoure management private links at the subscription scope. + +### Example 3 +```powershell +Get-AzResourceManagementPrivateLink -ResourceGroupName PrivateLinkTestRG +``` + +```output +Id : /subscriptions/aeb49941-36c3-4e7c-9ffd-16ba89d33ec4/resourceGroups/PrivateLinkTestRG/provi + ders/Microsoft.Authorization/resourceManagementPrivateLinks/NewPL +Type : Microsoft.Authorization/resourceManagementPrivateLinks +Name : NewPL +Location : centralus +PrivateEndpointConnections : {} + +Id : /subscriptions/aeb49941-36c3-4e7c-9ffd-16ba89d33ec4/resourceGroups/PrivateLinkTestRG/provi + ders/Microsoft.Authorization/resourceManagementPrivateLinks/NewPL2 +Type : Microsoft.Authorization/resourceManagementPrivateLinks +Name : NewPL2 +Location : centralus +PrivateEndpointConnections : {} +``` + +Gets all of the resoure management private links at the resource group scope. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the private link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PrivateLinkName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.PrivateLinks.PSResourceManagementPrivateLink + +## NOTES + +## RELATED LINKS + +[Remove-AzResourceManagementPrivateLink](./Remove-AzResourceManagementPrivateLink.md) +[New-AzResourceManagementPrivateLink](./New-AzResourceManagementPrivateLink.md) diff --git a/azps-10.1.0/Az.Resources/Get-AzResourceProvider.md b/azps-10.1.0/Az.Resources/Get-AzResourceProvider.md new file mode 100644 index 0000000000..4dd39f4ca5 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzResourceProvider.md @@ -0,0 +1,331 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 6AB09621-488B-4A16-92D9-9C47EB87DA95 +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azresourceprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzResourceProvider.md +--- + +# Get-AzResourceProvider + +## SYNOPSIS +Gets a resource provider. + +## SYNTAX + +### ListAvailable (Default) +``` +Get-AzResourceProvider [-Location <String>] [-ListAvailable] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### IndividualProvider +``` +Get-AzResourceProvider -ProviderNamespace <String[]> [-Location <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzResourceProvider** cmdlet gets an Azure resource provider. + +## EXAMPLES + +### Example 1: Get all resource providers registered with the current subscription + +```powershell +Get-AzResourceProvider +``` + +```output +ProviderNamespace : Microsoft.AppConfiguration +RegistrationState : Registered +ResourceTypes : {configurationStores, configurationStores/eventGridFilters, checkNameAvailability, locations…} +Locations : {West Central US, Central US, West US, East US…} + +ProviderNamespace : Microsoft.KeyVault +RegistrationState : Registered +ResourceTypes : {vaults, vaults/secrets, vaults/accessPolicies, operations…} +Locations : {North Central US, East US, North Europe, West Europe…} + +ProviderNamespace : Microsoft.Network +RegistrationState : Registered +ResourceTypes : {virtualNetworks, publicIPAddresses, networkInterfaces, privateEndpoints…} +Locations : {West US, East US, North Europe, West Europe…} + +ProviderNamespace : Microsoft.Compute +RegistrationState : Registered +ResourceTypes : {availabilitySets, virtualMachines, virtualMachines/extensions, virtualMachineScaleSets…} +Locations : {East US, East US 2, West US, Central US…} + +ProviderNamespace : Microsoft.Security +RegistrationState : Registered +ResourceTypes : {operations, securityStatuses, tasks, regulatoryComplianceStandards…} +Locations : {Central US, East US, West Europe, West Central US…} + +ProviderNamespace : Microsoft.ResourceHealth +RegistrationState : Registered +ResourceTypes : {availabilityStatuses, childAvailabilityStatuses, childResources, events…} +Locations : {Australia Southeast} + +ProviderNamespace : Microsoft.PolicyInsights +RegistrationState : Registered +ResourceTypes : {policyEvents, policyStates, operations, asyncOperationResults…} +Locations : {} + +ProviderNamespace : Microsoft.Storage +RegistrationState : Registered +ResourceTypes : {storageAccounts, operations, locations/asyncoperations, storageAccounts/listAccountSas…} +Locations : {East US, East US 2, West US, West Europe…} + +ProviderNamespace : Microsoft.Web +RegistrationState : Registered +ResourceTypes : {publishingUsers, ishostnameavailable, validate, isusernameavailable…} +Locations : {Central US, North Europe, West Europe, Southeast Asia…} + +ProviderNamespace : Sendgrid.Email +RegistrationState : Registered +ResourceTypes : {accounts, operations} +Locations : {Australia East, Australia Southeast, Brazil South, Canada Central…} + +ProviderNamespace : Microsoft.Authorization +RegistrationState : Registered +ResourceTypes : {roleAssignments, roleDefinitions, classicAdministrators, permissions…} +Locations : {} +... +``` + +This command gets all the resource providers from the subscription. + +### Example 2: Get all resource provider details from the given ProviderNamespace + +```powershell +Get-AzResourceProvider -ProviderNamespace Microsoft.Compute +``` + +```output +ProviderNamespace : Microsoft.Compute +RegistrationState : Registered +ResourceTypes : {availabilitySets} +Locations : {East US, East US 2, West US, Central US…} + +ProviderNamespace : Microsoft.Compute +RegistrationState : Registered +ResourceTypes : {virtualMachines} +Locations : {East US, East US 2, West US, Central US…} + +ProviderNamespace : Microsoft.Compute +RegistrationState : Registered +ResourceTypes : {virtualMachines/extensions} +Locations : {East US, East US 2, West US, Central US…} + +ProviderNamespace : Microsoft.Compute +RegistrationState : Registered +ResourceTypes : {virtualMachineScaleSets} +Locations : {East US, East US 2, West US, Central US…} + +ProviderNamespace : Microsoft.Compute +RegistrationState : Registered +ResourceTypes : {virtualMachineScaleSets/extensions} +Locations : {East US, East US 2, West US, Central US…} + +ProviderNamespace : Microsoft.Compute +RegistrationState : Registered +ResourceTypes : {virtualMachineScaleSets/virtualMachines} +Locations : {East US, East US 2, West US, Central US…} + +ProviderNamespace : Microsoft.Compute +RegistrationState : Registered +ResourceTypes : {virtualMachineScaleSets/networkInterfaces} +Locations : {East US, East US 2, West US, Central US…} +... +``` + +This command Gets all the resource providers under "Microsoft.Compute". + +### Example 3: Get all resource provider details from the given ProviderNamespace array + +```powershell +Get-AzResourceProvider -ProviderNamespace Microsoft.Compute,Microsoft.Network +``` + +```output +ProviderNamespace : Microsoft.Compute +RegistrationState : Registered +ResourceTypes : {availabilitySets} +Locations : {East US, East US 2, West US, Central US…} + +ProviderNamespace : Microsoft.Compute +RegistrationState : Registered +ResourceTypes : {virtualMachines} +Locations : {East US, East US 2, West US, Central US…} + +ProviderNamespace : Microsoft.Compute +RegistrationState : Registered +ResourceTypes : {virtualMachines/extensions} +Locations : {East US, East US 2, West US, Central US…} + +ProviderNamespace : Microsoft.Compute +RegistrationState : Registered +ResourceTypes : {virtualMachineScaleSets} +Locations : {East US, East US 2, West US, Central US…} + +ProviderNamespace : Microsoft.Compute +RegistrationState : Registered +ResourceTypes : {virtualMachineScaleSets/extensions} +Locations : {East US, East US 2, West US, Central US…} +... + +ProviderNamespace : Microsoft.Network +RegistrationState : Registered +ResourceTypes : {virtualNetworks} +Locations : {West US, East US, North Europe, West Europe…} + +ProviderNamespace : Microsoft.Network +RegistrationState : Registered +ResourceTypes : {publicIPAddresses} +Locations : {West US, East US, North Europe, West Europe…} + +ProviderNamespace : Microsoft.Network +RegistrationState : Registered +ResourceTypes : {networkInterfaces} +Locations : {West US, East US, North Europe, West Europe…} + +ProviderNamespace : Microsoft.Network +RegistrationState : Registered +ResourceTypes : {privateEndpoints} +Locations : {West US, East US, North Europe, West Europe…} + +ProviderNamespace : Microsoft.Network +RegistrationState : Registered +ResourceTypes : {privateEndpointRedirectMaps} +Locations : {West US, East US, North Europe, West Europe…} + +ProviderNamespace : Microsoft.Network +RegistrationState : Registered +ResourceTypes : {loadBalancers} +Locations : {West US, East US, North Europe, West Europe…} + +ProviderNamespace : Microsoft.Network +RegistrationState : Registered +ResourceTypes : {networkSecurityGroups} +Locations : {West US, East US, North Europe, West Europe…} +... +``` + +This command Gets all the resource providers under "Microsoft.Compute" and "Microsoft.Network". + +## PARAMETERS + +### -ApiVersion +Specifies the API version that is supported by the resource Provider. +You can specify a different version than the default version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListAvailable +Indicates that this operation gets all available resource providers. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ListAvailable +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the resource provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +Specifies the namespace of the resource provider. + +```yaml +Type: System.String[] +Parameter Sets: IndividualProvider +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceProvider + +## NOTES + +## RELATED LINKS + +[Register-AzResourceProvider](./Register-AzResourceProvider.md) + +[Unregister-AzResourceProvider](./Unregister-AzResourceProvider.md) + + diff --git a/azps-10.1.0/Az.Resources/Get-AzRoleAssignment.md b/azps-10.1.0/Az.Resources/Get-AzRoleAssignment.md new file mode 100644 index 0000000000..e5e12ca2f8 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzRoleAssignment.md @@ -0,0 +1,454 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 488229AF-FD6D-4E1B-B3DA-E57CA781D91E +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleAssignment.md +--- + +# Get-AzRoleAssignment + +## SYNOPSIS +Lists Azure RBAC role assignments at the specified scope. +By default it lists all role assignments in the selected Azure subscription. +Use respective parameters to list assignments to a specific user, or to list assignments on a specific resource group or resource. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /users/{id} +- GET /servicePrincipals/{id} +- GET /groups/{id} +- GET /directoryObjects/{id} +- POST /directoryObjects/getByIds + +Please notice that this cmdlet will mark `ObjectType` as `Unknown` in output if the object of role assignment is not found or current account has insufficient privileges to get object type. + +## SYNTAX + +### EmptyParameterSet (Default) +``` +Get-AzRoleAssignment [-RoleDefinitionName <String>] [-IncludeClassicAdministrators] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ObjectIdParameterSet +``` +Get-AzRoleAssignment -ObjectId <String> [-RoleDefinitionName <String>] [-ExpandPrincipalGroups] + [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupWithObjectIdParameterSet +``` +Get-AzRoleAssignment -ObjectId <String> -ResourceGroupName <String> [-RoleDefinitionName <String>] + [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceWithObjectIdParameterSet +``` +Get-AzRoleAssignment -ObjectId <String> -ResourceGroupName <String> -ResourceName <String> + -ResourceType <String> [-ParentResource <String>] [-RoleDefinitionName <String>] + [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ScopeWithObjectIdParameterSet +``` +Get-AzRoleAssignment -ObjectId <String> [-RoleDefinitionName <String>] -Scope <String> + [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RoleIdWithScopeAndObjectIdParameterSet +``` +Get-AzRoleAssignment [-ObjectId <String>] -RoleDefinitionId <Guid> [-Scope <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupWithSignInNameParameterSet +``` +Get-AzRoleAssignment -SignInName <String> -ResourceGroupName <String> [-RoleDefinitionName <String>] + [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceWithSignInNameParameterSet +``` +Get-AzRoleAssignment -SignInName <String> -ResourceGroupName <String> -ResourceName <String> + -ResourceType <String> [-ParentResource <String>] [-RoleDefinitionName <String>] + [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ScopeWithSignInNameParameterSet +``` +Get-AzRoleAssignment -SignInName <String> [-RoleDefinitionName <String>] -Scope <String> + [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SignInNameParameterSet +``` +Get-AzRoleAssignment -SignInName <String> [-RoleDefinitionName <String>] [-ExpandPrincipalGroups] + [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupWithSPNParameterSet +``` +Get-AzRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> [-RoleDefinitionName <String>] + [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceWithSPNParameterSet +``` +Get-AzRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> -ResourceName <String> + -ResourceType <String> [-ParentResource <String>] [-RoleDefinitionName <String>] + [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ScopeWithSPNParameterSet +``` +Get-AzRoleAssignment -ServicePrincipalName <String> [-RoleDefinitionName <String>] -Scope <String> + [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SPNParameterSet +``` +Get-AzRoleAssignment -ServicePrincipalName <String> [-RoleDefinitionName <String>] + [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupParameterSet +``` +Get-AzRoleAssignment -ResourceGroupName <String> [-RoleDefinitionName <String>] [-IncludeClassicAdministrators] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceParameterSet +``` +Get-AzRoleAssignment -ResourceGroupName <String> -ResourceName <String> -ResourceType <String> + [-ParentResource <String>] [-RoleDefinitionName <String>] [-IncludeClassicAdministrators] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ScopeParameterSet +``` +Get-AzRoleAssignment [-RoleDefinitionName <String>] -Scope <String> [-IncludeClassicAdministrators] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Use the Get-AzRoleAssignment command to list all role assignments that are effective on a scope. +Without any parameters, this command returns all the role assignments made under the subscription. +This list can be filtered using filtering parameters for principal, role and scope. +The subject of the assignment must be specified. +To specify a user, use SignInName or Azure AD ObjectId parameters. +To specify a security group, use Azure AD ObjectId parameter. +And to specify an Azure AD application, use ServicePrincipalName or ObjectId parameters. +The role that is being assigned must be specified using the RoleDefinitionName parameter. +The scope at which access is being granted may be specified. +It defaults to the selected subscription. +The scope of the assignment can be specified using one of the following parameter combinations + a. +Scope - This is the fully qualified scope starting with /subscriptions/\<subscriptionId\>. +This will filter assignments that are effective at that particular scope i.e. +all assignments at that scope and above. + b. +ResourceGroupName - Name of any resource group under the subscription. +This will filter assignments effective at the specified resource group + c. +ResourceName, ResourceType, ResourceGroupName and (optionally) ParentResource - Identifies a particular resource under the subscription and will filter assignments effective at that resource scope. +To determine what access a particular user has in the subscription, use the ExpandPrincipalGroups switch. +This will list all roles assigned to the user, and to the groups that the user is member of. +Use the IncludeClassicAdministrators switch to also display the subscription admins and co-admins. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRoleAssignment +``` + +List all role assignments in the subscription + +### Example 2 +```powershell +Get-AzRoleAssignment -ResourceGroupName testRG -SignInName john.doe@contoso.com +``` + +Gets all role assignments made to user john.doe@contoso.com, and the groups of which he is member, at the testRG scope or above. + +### Example 3 +```powershell +Get-AzRoleAssignment -ServicePrincipalName "http://testapp1.com" +``` + +Gets all role assignments of the specified service principal + +### Example 4 +```powershell +Get-AzRoleAssignment -Scope "/subscriptions/96231a05-34ce-4eb4-aa6a-70759cbb5e83/resourcegroups/rg1/providers/Microsoft.Web/sites/site1" +``` + +Gets role assignments at the 'site1' website scope. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandPrincipalGroups +If specified, returns roles directly assigned to the user and to the groups of which the user is a member (transitively). +Supported only for a user principal. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ObjectIdParameterSet, SignInNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeClassicAdministrators +If specified, also lists subscription classic administrators (co-admins, service admins, etc.) role assignments. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: EmptyParameterSet, ObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, SignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet, SPNParameterSet, ResourceGroupParameterSet, ResourceParameterSet, ScopeParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The Azure AD ObjectId of the User, Group or Service Principal. +Filters all assignments that are made to the specified principal. + +```yaml +Type: System.String +Parameter Sets: ObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet +Aliases: Id, PrincipalId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet +Aliases: Id, PrincipalId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentResource +The parent resource in the hierarchy of the resource specified using ResourceName parameter. +Must be used in conjunction with ResourceGroupName, ResourceType, and ResourceName parameters. + +```yaml +Type: System.String +Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. +Lists role assignments that are effective at the specified resource group. +When used in conjunction with ResourceName, ResourceType, and ParentResource parameters, the command lists assignments effective at resources within the resource group. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ResourceGroupParameterSet, ResourceParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +The resource name. +For e.g. +storageaccountprod. +Must be used in conjunction with ResourceGroupName, ResourceType, and (optionally)ParentResource parameters. + +```yaml +Type: System.String +Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. +For e.g. +Microsoft.Network/virtualNetworks. +Must be used in conjunction with ResourceGroupName, ResourceName, and (optionally)ParentResource parameters. + +```yaml +Type: System.String +Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoleDefinitionId +Id of the Role that is assigned to the principal. + +```yaml +Type: System.Guid +Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoleDefinitionName +Role that is assigned to the principal i.e. +Reader, Contributor, Virtual Network Administrator, etc. + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet, ObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, SignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet, SPNParameterSet, ResourceGroupParameterSet, ResourceParameterSet, ScopeParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +The Scope of the role assignment. +In the format of relative URI. +For e.g. +/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG. +It must start with "/subscriptions/{id}". +The command filters all assignments that are effective at that scope. + +```yaml +Type: System.String +Parameter Sets: ScopeWithObjectIdParameterSet, ScopeWithSignInNameParameterSet, ScopeWithSPNParameterSet, ScopeParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServicePrincipalName +The ServicePrincipalName of the service principal. +Filters all assignments that are made to the specified Azure AD application. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet, SPNParameterSet +Aliases: SPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SignInName +The email address or the user principal name of the user. +Filters all assignments that are made to the specified user. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, SignInNameParameterSet +Aliases: Email, UserPrincipalName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment + +## RELATED LINKS + +[New-AzRoleAssignment](./New-AzRoleAssignment.md) + +[Remove-AzRoleAssignment](./Remove-AzRoleAssignment.md) + +[Get-AzRoleDefinition](./Get-AzRoleDefinition.md) + diff --git a/azps-10.1.0/Az.Resources/Get-AzRoleAssignmentSchedule.md b/azps-10.1.0/Az.Resources/Get-AzRoleAssignmentSchedule.md new file mode 100644 index 0000000000..9cf5e86050 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzRoleAssignmentSchedule.md @@ -0,0 +1,236 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azroleassignmentschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleAssignmentSchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleAssignmentSchedule.md +--- + +# Get-AzRoleAssignmentSchedule + +## SYNOPSIS +Get the specified role assignment schedule for a resource scope + +## SYNTAX + +### List (Default) +``` +Get-AzRoleAssignmentSchedule -Scope <String> [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzRoleAssignmentSchedule -Name <String> -Scope <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzRoleAssignmentSchedule -InputObject <IAuthorizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the specified role assignment schedule for a resource scope + +## EXAMPLES + +### Example 1: List all role assignment schedules for a resource +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleAssignmentSchedule -Scope $scope +``` + +```output +Name Type Scope +---- ---- ----- +986d4ad8-f513-4a21-92e5-7163486e9e7c Microsoft.Authorization/roleAssignmentSchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +2066f412-e9bf-406a-962c-df8c16c9f9a0 Microsoft.Authorization/roleAssignmentSchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/resourceGroups/UTSept3/providers/Microsoft.Compute/virtualMachines/vmtest123 +f402cab4-83ab-4361-8725-2190bbe1ea6b Microsoft.Authorization/roleAssignmentSchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/resourceGroups/sbo-test/providers/Microsoft.Web/connections/office365-1 +5a12ea85-419e-426b-81f8-20e53808a14c Microsoft.Authorization/roleAssignmentSchedules /providers/Microsoft.Management/managementGroups/PrimaryMG1 +``` + +Returns all `roleAssignmentSchedules` for the `scope`. +To call the API, you must have access to the `Microsoft.Authorization/roleAssignments/read` operation at the specified scope. + +### Example 2: List all My role assignment schedules for a resource +```powershell +$scope = "/" # "/" stands for tenant level resource +Get-AzRoleAssignmentSchedule -Scope $scope -Filter "asTarget()" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleAssignmentSchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorizatio… +a1f32976-b8f4-4606-a91d-af097a2473a2 Microsoft.Authorization/roleAssignmentSchedules /providers/Microsoft.Management/managementGroups/MG-3 /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb… +4f9bdc29-3bb9-4ad7-9c1d-3f3f5ba3e1d9 Microsoft.Authorization/roleAssignmentSchedules /providers/Microsoft.Management/managementGroups/MG-2 /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb… +529e4bba-621c-4309-a4b2-73e3364d4dd3 Microsoft.Authorization/roleAssignmentSchedules /providers/Microsoft.Management/managementGroups/MG-1 /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb… +``` + +Returns all `roleAssignmentSchedules` for the `scope` which are assigned to the calling user. + +### Example 3: List all role assignment schedules for a resource with filters +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +$filter = "roleDefinitionId eq '/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635'" +Get-AzRoleAssignmentSchedule -Scope $scope -Filter $filter +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +314aa57e-064d-46c3-964e-a0d20989c1a2 Microsoft.Authorization/roleAssignmentSchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +496794ce-4465-4621-83aa-0b73b3c6fe17 Microsoft.Authorization/roleAssignmentSchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +6461530a-4d10-400e-9eb0-ff7cb73c4ffd Microsoft.Authorization/roleAssignmentSchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +d8daef6c-75da-42eb-9291-7cbc466d5b4b Microsoft.Authorization/roleAssignmentSchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +``` + +Supported filters: +| Filter | Description | +| --- | --- | +| `atScope()` | List role assignments for only the specified scope, not including the role assignments at subscopes. +| +| `principalId eq '{objectId}'` | List role assignments for a specified user, group, or service principal. +| +| `roleDefinitionId eq '{roleDefinitionId}'` | List role assignments for a specified role definition. +| +| `status eq '{status}'` | List role assignments for a specified status. +| +| `assignedTo('{objectId}')` | List role assignments for a specified user, including ones inherited from groups. +| +| `asTarget()` | List role assignments for the current user or service principal, including ones inherited from groups. +| +| `assignedTo('{objectId}')+and+atScope()` | List role assignments for a specified user, including ones inherited from groups for only the specified scope, not including the role assignments at subscopes.| + +### Example 4: Get a role assignment schedule by scope and name +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleAssignmentSchedule -Scope $scope -Name "4cd7e26b-8eca-425c-969d-ec708c88bf18" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleAssignmentSchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorization/… +``` + +Use the `Id` property to get `scope` and `name` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply on the operation. +Use $filter=atScope() to return all role assignment schedules at or above the scope. +Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. +Use $filter=assignedTo('{userId}') to return all role assignment schedules for the current user. +Use $filter=asTarget() to return all role assignment schedules created for the current user. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name (guid) of the role assignment schedule to get. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RoleAssignmentScheduleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role assignment schedule. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IRoleAssignmentSchedule + +## 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 <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzRoleAssignmentScheduleInstance.md b/azps-10.1.0/Az.Resources/Get-AzRoleAssignmentScheduleInstance.md new file mode 100644 index 0000000000..16414a2936 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzRoleAssignmentScheduleInstance.md @@ -0,0 +1,237 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azroleassignmentscheduleinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleAssignmentScheduleInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleAssignmentScheduleInstance.md +--- + +# Get-AzRoleAssignmentScheduleInstance + +## SYNOPSIS +Gets the specified role assignment schedule instance. + +## SYNTAX + +### List (Default) +``` +Get-AzRoleAssignmentScheduleInstance -Scope <String> [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzRoleAssignmentScheduleInstance -Name <String> -Scope <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzRoleAssignmentScheduleInstance -InputObject <IAuthorizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the specified role assignment schedule instance. + +## EXAMPLES + +### Example 1: List all role assignment schedule instances for a resource +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleAssignmentScheduleInstance -Scope $scope +``` + +```output +Name Type Scope +---- ---- ----- +986d4ad8-f513-4a21-92e5-7163486e9e7c Microsoft.Authorization/roleAssignmentScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +2066f412-e9bf-406a-962c-df8c16c9f9a0 Microsoft.Authorization/roleAssignmentScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/resourceGroups/UTSept3/providers/Microsoft.Compute/virtualMachines/vmtest123 +f402cab4-83ab-4361-8725-2190bbe1ea6b Microsoft.Authorization/roleAssignmentScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/resourceGroups/sbo-test/providers/Microsoft.Web/connections/office365-1 +5a12ea85-419e-426b-81f8-20e53808a14c Microsoft.Authorization/roleAssignmentScheduleInstances /providers/Microsoft.Management/managementGroups/PrimaryMG1 +``` + +Returns all `roleAssignmentScheduleInstances` for the `scope`. +To call the API, you must have access to the `Microsoft.Authorization/roleAssignments/read` operation at the specified scope. + +### Example 2: List all My role assignment schedule instances for a resource +```powershell +$scope = "/" # "/" stands for tenant level resource +Get-AzRoleAssignmentScheduleInstance -Scope $scope -Filter "asTarget()" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleAssignmentScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorizatio… +a1f32976-b8f4-4606-a91d-af097a2473a2 Microsoft.Authorization/roleAssignmentScheduleInstances /providers/Microsoft.Management/managementGroups/MG-3 /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb… +4f9bdc29-3bb9-4ad7-9c1d-3f3f5ba3e1d9 Microsoft.Authorization/roleAssignmentScheduleInstances /providers/Microsoft.Management/managementGroups/MG-2 /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb… +529e4bba-621c-4309-a4b2-73e3364d4dd3 Microsoft.Authorization/roleAssignmentScheduleInstances /providers/Microsoft.Management/managementGroups/MG-1 /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb… +``` + +Returns all `roleAssignmentScheduleInstances` for the `scope` which are assigned to the calling user. + +### Example 3: List all role assignment schedule instances for a resource with filters +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +$filter = "roleDefinitionId eq '/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635'" +Get-AzRoleAssignmentScheduleInstance -Scope $scope -Filter $filter +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +314aa57e-064d-46c3-964e-a0d20989c1a2 Microsoft.Authorization/roleAssignmentScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +496794ce-4465-4621-83aa-0b73b3c6fe17 Microsoft.Authorization/roleAssignmentScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +6461530a-4d10-400e-9eb0-ff7cb73c4ffd Microsoft.Authorization/roleAssignmentScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +d8daef6c-75da-42eb-9291-7cbc466d5b4b Microsoft.Authorization/roleAssignmentScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +``` + +Supported filters: +| Filter | Description | +| --- | --- | +| `atScope()` | List role assignments for only the specified scope, not including the role assignments at subscopes. +| +| `principalId eq '{objectId}'` | List role assignments for a specified user, group, or service principal. +| +| `roleDefinitionId eq '{roleDefinitionId}'` | List role assignments for a specified role definition. +| +| `status eq '{status}'` | List role assignments for a specified status. +| +| `assignedTo('{objectId}')` | List role assignments for a specified user, including ones inherited from groups. +| +| `asTarget()` | List role assignments for the current user or service principal, including ones inherited from groups. +| +| `assignedTo('{objectId}')+and+atScope()` | List role assignments for a specified user, including ones inherited from groups for only the specified scope, not including the role assignments at subscopes.| + +### Example 4: Get a role assignment schedule instances by scope and name +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleAssignmentScheduleInstance -Scope $scope -Name "4cd7e26b-8eca-425c-969d-ec708c88bf18" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleAssignmentScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorization/… +``` + +Use the `Id` property to get `scope` and `name` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply on the operation. +Use $filter=atScope() to return all role assignment schedules at or above the scope. +Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. +Use $filter=assignedTo('{userId}') to return all role assignment schedule instances for the user. +Use $filter=asTarget() to return all role assignment schedule instances created for the current user. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name (hash of schedule name + time) of the role assignment schedule to get. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RoleAssignmentScheduleInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role assignments schedules. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IRoleAssignmentScheduleInstance + +## 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 <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzRoleAssignmentScheduleRequest.md b/azps-10.1.0/Az.Resources/Get-AzRoleAssignmentScheduleRequest.md new file mode 100644 index 0000000000..42284066f9 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzRoleAssignmentScheduleRequest.md @@ -0,0 +1,219 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azroleassignmentschedulerequest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleAssignmentScheduleRequest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleAssignmentScheduleRequest.md +--- + +# Get-AzRoleAssignmentScheduleRequest + +## SYNOPSIS +Get the specified role assignment schedule request. + +## SYNTAX + +### List (Default) +``` +Get-AzRoleAssignmentScheduleRequest -Scope <String> [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzRoleAssignmentScheduleRequest -Name <String> -Scope <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzRoleAssignmentScheduleRequest -InputObject <IAuthorizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the specified role assignment schedule request. + +## EXAMPLES + +### Example 1: List all role assignment schedule requests for a resource +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleAssignmentScheduleRequest -Scope $scope +``` + +```output +Name Type Scope +---- ---- ----- +01b86d0b-2d7d-4ee2-bedb-68417ca9cc6a Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +06425dd7-102c-42c2-90c4-b5c630447356 Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +0988b71a-f813-467b-abc0-cef007eddbb5 Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +0cbb19d3-3804-404a-b74a-2f577f8aecbc Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +``` + +Returns all `roleAssignmentScheduleRequests` for the `scope`. + +### Example 2: List all My role assignment schedule requests for a resource +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleAssignmentScheduleRequest -Scope $scope -Filter "asTarget()" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +2cc018c2-27f8-4730-a0bc-b6a8fcee3e70 Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov… +31910719-4f82-443c-9e7a-6bfe4b918e0c Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov… +4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov… +``` + +Returns all `roleAssignmentScheduleRequests` for the `scope` which are assigned to the calling user. + +### Example 3: List all role assignment schedule requests for a resource where calling user is an approver +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleAssignmentScheduleRequest -Scope $scope -Filter "asApprover()" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +2cc018c2-27f8-4730-a0bc-b6a8fcee3e70 Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov… +31910719-4f82-443c-9e7a-6bfe4b918e0c Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov… +4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov… +``` + +Returns all `roleAssignmentScheduleRequests` for the `scope` on which the calling user is an approver. + +### Example 4: Get a role assignment schedule request by scope and name +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleAssignmentScheduleRequest -Scope $scope -Name "2cc018c2-27f8-4730-a0bc-b6a8fcee3e70" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +2cc018c2-27f8-4730-a0bc-b6a8fcee3e70 Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authoriz… +``` + +Use the `Id` property to get `scope` and `name` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply on the operation. +Use $filter=atScope() to return all role assignment schedule requests at or above the scope. +Use $filter=principalId eq {id} to return all role assignment schedule requests at, above or below the scope for the specified principal. +Use $filter=asRequestor() to return all role assignment schedule requests requested by the current user. +Use $filter=asTarget() to return all role assignment schedule requests created for the current user. +Use $filter=asApprover() to return all role assignment schedule requests where the current user is an approver. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name (guid) of the role assignment schedule request to get. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RoleAssignmentScheduleRequestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role assignment schedule request. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IRoleAssignmentScheduleRequest + +## 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 <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzRoleDefinition.md b/azps-10.1.0/Az.Resources/Get-AzRoleDefinition.md new file mode 100644 index 0000000000..61f823d628 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzRoleDefinition.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 7740AC3B-F643-4F8D-8DC5-ACBF59323BD8 +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleDefinition.md +--- + +# Get-AzRoleDefinition + +## SYNOPSIS +Lists all Azure RBAC roles that are available for assignment. + +## SYNTAX + +### RoleDefinitionNameParameterSet (Default) +``` +Get-AzRoleDefinition [[-Name] <String>] [-Scope <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### RoleDefinitionIdParameterSet +``` +Get-AzRoleDefinition -Id <Guid> [-Scope <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### RoleDefinitionCustomParameterSet +``` +Get-AzRoleDefinition [-Scope <String>] [-Custom] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Use the Get-AzRoleDefinition command with a particular role name to view its details. +To inspect individual operations that a role grants access to, review the Actions and NotActions properties of the role. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRoleDefinition -Name Reader +``` + +Get the Reader role definition + +### Example 2 +```powershell +Get-AzRoleDefinition +``` + +Lists all RBAC role definitions + +## PARAMETERS + +### -Custom +If specified, only displays the custom created roles in the directory. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RoleDefinitionCustomParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Role definition Id. + +```yaml +Type: System.Guid +Parameter Sets: RoleDefinitionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Role definition name. +For e.g. +Reader, Contributor, Virtual Machine Contributor. + +```yaml +Type: System.String +Parameter Sets: RoleDefinitionNameParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Role definition scope. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment + +## RELATED LINKS + +[New-AzRoleAssignment](./New-AzRoleAssignment.md) + +[Get-AzRoleAssignment](./Get-AzRoleAssignment.md) + +[New-AzRoleDefinition](./New-AzRoleDefinition.md) + +[Remove-AzRoleDefinition](./Remove-AzRoleDefinition.md) + diff --git a/azps-10.1.0/Az.Resources/Get-AzRoleEligibilitySchedule.md b/azps-10.1.0/Az.Resources/Get-AzRoleEligibilitySchedule.md new file mode 100644 index 0000000000..1c9054977d --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzRoleEligibilitySchedule.md @@ -0,0 +1,234 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azroleeligibilityschedule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleEligibilitySchedule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleEligibilitySchedule.md +--- + +# Get-AzRoleEligibilitySchedule + +## SYNOPSIS +Get the specified role eligibility schedule for a resource scope + +## SYNTAX + +### List (Default) +``` +Get-AzRoleEligibilitySchedule -Scope <String> [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzRoleEligibilitySchedule -Name <String> -Scope <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzRoleEligibilitySchedule -InputObject <IAuthorizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the specified role eligibility schedule for a resource scope + +## EXAMPLES + +### Example 1: List all role eligible schedules for a resource +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleEligibilitySchedule -Scope $scope +``` + +```output +Name Type Scope +---- ---- ----- +986d4ad8-f513-4a21-92e5-7163486e9e7c Microsoft.Authorization/roleEligibilitySchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +2066f412-e9bf-406a-962c-df8c16c9f9a0 Microsoft.Authorization/roleEligibilitySchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/resourceGroups/UTSept3/providers/Microsoft.Compute/virtualMachines/vmtest123 +f402cab4-83ab-4361-8725-2190bbe1ea6b Microsoft.Authorization/roleEligibilitySchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/resourceGroups/sbo-test/providers/Microsoft.Web/connections/office365-1 +5a12ea85-419e-426b-81f8-20e53808a14c Microsoft.Authorization/roleEligibilitySchedules /providers/Microsoft.Management/managementGroups/PrimaryMG1 +``` + +Returns all `roleEligibilitySchedules` for the `scope`. +To call the API, you must have access to the `Microsoft.Authorization/roleAssignments/read` operation at the specified scope. + +### Example 2: List all My role eligible schedules for a resource +```powershell +$scope = "/" # "/" stands for tenant level resource +Get-AzRoleEligibilitySchedule -Scope $scope -Filter "asTarget()" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleEligibilitySchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorizatio… +a1f32976-b8f4-4606-a91d-af097a2473a2 Microsoft.Authorization/roleEligibilitySchedules /providers/Microsoft.Management/managementGroups/MG-3 /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb… +4f9bdc29-3bb9-4ad7-9c1d-3f3f5ba3e1d9 Microsoft.Authorization/roleEligibilitySchedules /providers/Microsoft.Management/managementGroups/MG-2 /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb… +529e4bba-621c-4309-a4b2-73e3364d4dd3 Microsoft.Authorization/roleEligibilitySchedules /providers/Microsoft.Management/managementGroups/MG-1 /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb… +``` + +Returns all `roleEligibilitySchedules` for the `scope` which are assigned to the calling user. + +### Example 3: List all role eligible schedules for a resource with filters +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +$filter = "roleDefinitionId eq '/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635'" +Get-AzRoleEligibilitySchedule -Scope $scope -Filter $filter +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +314aa57e-064d-46c3-964e-a0d20989c1a2 Microsoft.Authorization/roleEligibilitySchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +496794ce-4465-4621-83aa-0b73b3c6fe17 Microsoft.Authorization/roleEligibilitySchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +6461530a-4d10-400e-9eb0-ff7cb73c4ffd Microsoft.Authorization/roleEligibilitySchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +d8daef6c-75da-42eb-9291-7cbc466d5b4b Microsoft.Authorization/roleEligibilitySchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +``` + +Supported filters: +| Filter | Description | +| --- | --- | +| `atScope()` | List role assignments for only the specified scope, not including the role assignments at subscopes. +| +| `principalId eq '{objectId}'` | List role assignments for a specified user, group, or service principal. +| +| `roleDefinitionId eq '{roleDefinitionId}'` | List role assignments for a specified role definition. +| +| `status eq '{status}'` | List role assignments for a specified status. +| +| `assignedTo('{objectId}')` | List role assignments for a specified user, including ones inherited from groups. +| +| `asTarget()` | List role assignments for the current user or service principal, including ones inherited from groups. +| +| `assignedTo('{objectId}')+and+atScope()` | List role assignments for a specified user, including ones inherited from groups for only the specified scope, not including the role assignments at subscopes.| + +### Example 4: Get a role eligible schedules by scope and name +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleEligibilitySchedule -Scope $scope -Name "4cd7e26b-8eca-425c-969d-ec708c88bf18" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleEligibilitySchedules /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorization/… +``` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply on the operation. +Use $filter=atScope() to return all role eligibility schedules at or above the scope. +Use $filter=principalId eq {id} to return all role eligibility schedules at, above or below the scope for the specified principal. +Use $filter=assignedTo('{userId}') to return all role eligibility schedules for the user. +Use $filter=asTarget() to return all role eligibility schedules created for the current user. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name (guid) of the role eligibility schedule to get. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RoleEligibilityScheduleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role eligibility schedule. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IRoleEligibilitySchedule + +## 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 <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzRoleEligibilityScheduleInstance.md b/azps-10.1.0/Az.Resources/Get-AzRoleEligibilityScheduleInstance.md new file mode 100644 index 0000000000..25c9221d82 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzRoleEligibilityScheduleInstance.md @@ -0,0 +1,237 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azroleeligibilityscheduleinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleEligibilityScheduleInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleEligibilityScheduleInstance.md +--- + +# Get-AzRoleEligibilityScheduleInstance + +## SYNOPSIS +Gets the specified role eligibility schedule instance. + +## SYNTAX + +### List (Default) +``` +Get-AzRoleEligibilityScheduleInstance -Scope <String> [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzRoleEligibilityScheduleInstance -Name <String> -Scope <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzRoleEligibilityScheduleInstance -InputObject <IAuthorizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the specified role eligibility schedule instance. + +## EXAMPLES + +### Example 1: List all role eligible schedule instances for a resource +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleEligibilityScheduleInstance -Scope $scope +``` + +```output +Name Type Scope +---- ---- ----- +986d4ad8-f513-4a21-92e5-7163486e9e7c Microsoft.Authorization/roleEligibilityScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +2066f412-e9bf-406a-962c-df8c16c9f9a0 Microsoft.Authorization/roleEligibilityScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/resourceGroups/UTSept3/providers/Microsoft.Compute/virtualMachines/vmtest123 +f402cab4-83ab-4361-8725-2190bbe1ea6b Microsoft.Authorization/roleEligibilityScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/resourceGroups/sbo-test/providers/Microsoft.Web/connections/office365-1 +5a12ea85-419e-426b-81f8-20e53808a14c Microsoft.Authorization/roleEligibilityScheduleInstances /providers/Microsoft.Management/managementGroups/PrimaryMG1 +``` + +Returns all `roleEligibilityScheduleInstances` for the `scope`. +To call the API, you must have access to the `Microsoft.Authorization/roleAssignments/read` operation at the specified scope. + +### Example 2: List all My role eligible schedule instances for a resource +```powershell +$scope = "/" # "/" stands for tenant level resource +Get-AzRoleEligibilityScheduleInstance -Scope $scope -Filter "asTarget()" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleEligibilityScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorizatio… +a1f32976-b8f4-4606-a91d-af097a2473a2 Microsoft.Authorization/roleEligibilityScheduleInstances /providers/Microsoft.Management/managementGroups/MG-3 /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb… +4f9bdc29-3bb9-4ad7-9c1d-3f3f5ba3e1d9 Microsoft.Authorization/roleEligibilityScheduleInstances /providers/Microsoft.Management/managementGroups/MG-2 /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb… +529e4bba-621c-4309-a4b2-73e3364d4dd3 Microsoft.Authorization/roleEligibilityScheduleInstances /providers/Microsoft.Management/managementGroups/MG-1 /providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb… +``` + +Returns all `roleEligibilityScheduleInstances` for the `scope` which are assigned to the calling user. + +### Example 3: List all role eligible schedule instances for a resource with filters +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +$filter = "roleDefinitionId eq '/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635'" +Get-AzRoleEligibilityScheduleInstance -Scope $scope -Filter $filter +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +314aa57e-064d-46c3-964e-a0d20989c1a2 Microsoft.Authorization/roleEligibilityScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +496794ce-4465-4621-83aa-0b73b3c6fe17 Microsoft.Authorization/roleEligibilityScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +6461530a-4d10-400e-9eb0-ff7cb73c4ffd Microsoft.Authorization/roleEligibilityScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +d8daef6c-75da-42eb-9291-7cbc466d5b4b Microsoft.Authorization/roleEligibilityScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/… +``` + +Supported filters: +| Filter | Description | +| --- | --- | +| `atScope()` | List role assignments for only the specified scope, not including the role assignments at subscopes. +| +| `principalId eq '{objectId}'` | List role assignments for a specified user, group, or service principal. +| +| `roleDefinitionId eq '{roleDefinitionId}'` | List role assignments for a specified role definition. +| +| `status eq '{status}'` | List role assignments for a specified status. +| +| `assignedTo('{objectId}')` | List role assignments for a specified user, including ones inherited from groups. +| +| `asTarget()` | List role assignments for the current user or service principal, including ones inherited from groups. +| +| `assignedTo('{objectId}')+and+atScope()` | List role assignments for a specified user, including ones inherited from groups for only the specified scope, not including the role assignments at subscopes.| + +### Example 4: Get a role eligible schedule instances by scope and name +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleEligibilityScheduleInstance -Scope $scope -Name "4cd7e26b-8eca-425c-969d-ec708c88bf18" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleEligibilityScheduleInstances /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorization/… +``` + +Use the `Id` property to get `scope` and `name` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply on the operation. +Use $filter=atScope() to return all role assignment schedules at or above the scope. +Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. +Use $filter=assignedTo('{userId}') to return all role eligibility schedules for the user. +Use $filter=asTarget() to return all role eligibility schedules created for the current user. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name (hash of schedule name + time) of the role eligibility schedule to get. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RoleEligibilityScheduleInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role eligibility schedules. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IRoleEligibilityScheduleInstance + +## 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 <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzRoleEligibilityScheduleRequest.md b/azps-10.1.0/Az.Resources/Get-AzRoleEligibilityScheduleRequest.md new file mode 100644 index 0000000000..9b309050d0 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzRoleEligibilityScheduleRequest.md @@ -0,0 +1,219 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azroleeligibilityschedulerequest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleEligibilityScheduleRequest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleEligibilityScheduleRequest.md +--- + +# Get-AzRoleEligibilityScheduleRequest + +## SYNOPSIS +Get the specified role eligibility schedule request. + +## SYNTAX + +### List (Default) +``` +Get-AzRoleEligibilityScheduleRequest -Scope <String> [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzRoleEligibilityScheduleRequest -Name <String> -Scope <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzRoleEligibilityScheduleRequest -InputObject <IAuthorizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the specified role eligibility schedule request. + +## EXAMPLES + +### Example 1: List all role assignment schedule requests for a resource +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleEligibilityScheduleRequest -Scope $scope +``` + +```output +Name Type Scope +---- ---- ----- +01b86d0b-2d7d-4ee2-bedb-68417ca9cc6a Microsoft.Authorization/roleEligibilityScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +06425dd7-102c-42c2-90c4-b5c630447356 Microsoft.Authorization/roleEligibilityScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +0988b71a-f813-467b-abc0-cef007eddbb5 Microsoft.Authorization/roleEligibilityScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +0cbb19d3-3804-404a-b74a-2f577f8aecbc Microsoft.Authorization/roleEligibilityScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +``` + +Returns all `roleEligibilityScheduleRequests` for the `scope`. + +### Example 2: List all My role assignment schedule requests for a resource +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleEligibilityScheduleRequest -Scope $scope -Filter "asTarget()" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +2cc018c2-27f8-4730-a0bc-b6a8fcee3e70 Microsoft.Authorization/roleEligibilityScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov… +31910719-4f82-443c-9e7a-6bfe4b918e0c Microsoft.Authorization/roleEligibilityScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov… +4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleEligibilityScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov… +``` + +Returns all `roleEligibilityScheduleRequests` for the `scope` which are assigned to the calling user. + +### Example 3: List all role assignment schedule requests for a resource where calling user is an approver +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleEligibilityScheduleRequest -Scope $scope -Filter "asApprover()" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +2cc018c2-27f8-4730-a0bc-b6a8fcee3e70 Microsoft.Authorization/roleEligibilityScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov… +31910719-4f82-443c-9e7a-6bfe4b918e0c Microsoft.Authorization/roleEligibilityScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov… +4cd7e26b-8eca-425c-969d-ec708c88bf18 Microsoft.Authorization/roleEligibilityScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/prov… +``` + +Returns all `roleEligibilitySchedules` for the `scope` on which the calling user is an approver. + +### Example 4: Get a role assignment schedule request by scope and name +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d" +Get-AzRoleEligibilityScheduleRequest -Scope $scope -Name "2cc018c2-27f8-4730-a0bc-b6a8fcee3e70" +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +2cc018c2-27f8-4730-a0bc-b6a8fcee3e70 Microsoft.Authorization/roleEligibilityScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authoriz… +``` + +Use the `Id` property to get `scope` and `name` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply on the operation. +Use $filter=atScope() to return all role eligibility schedule requests at or above the scope. +Use $filter=principalId eq {id} to return all role eligibility schedule requests at, above or below the scope for the specified principal. +Use $filter=asRequestor() to return all role eligibility schedule requests requested by the current user. +Use $filter=asTarget() to return all role eligibility schedule requests created for the current user. +Use $filter=asApprover() to return all role eligibility schedule requests where the current user is an approver. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name (guid) of the role eligibility schedule request to get. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RoleEligibilityScheduleRequestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role eligibility schedule request. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IRoleEligibilityScheduleRequest + +## 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 <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzRoleEligibleChildResource.md b/azps-10.1.0/Az.Resources/Get-AzRoleEligibleChildResource.md new file mode 100644 index 0000000000..19111f1f0b --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzRoleEligibleChildResource.md @@ -0,0 +1,167 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azroleeligiblechildresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleEligibleChildResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleEligibleChildResource.md +--- + +# Get-AzRoleEligibleChildResource + +## SYNOPSIS +Get the child resources of a resource on which user has eligible access + +## SYNTAX + +### Get (Default) +``` +Get-AzRoleEligibleChildResource -Scope <String> [-Filter <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzRoleEligibleChildResource -InputObject <IAuthorizationIdentity> [-Filter <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the child resources of a resource on which user has eligible access + +## EXAMPLES + +### Example 1: List all child resources +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +Get-AzRoleEligibleChildResource -Scope $scope +``` + +```output +Name Type +---- ---- +AnujRG resourcegroup +ARPJ-TESTRG-01 resourcegroup +AnujRG2 resourcegroup +asghodke-rg resourcegroup +``` + +Get all child resources of a resource `scope` that the calling user has eligible assignment(s) on. + +### Example 2: List all child resources filtered by resource type +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +$filter = "resoureType eq 'resourcegroup'" +Get-AzRoleEligibleChildResource -Scope $scope -Filter $filter +``` + +```output +Name Type +---- ---- +AnujRG resourcegroup +ARPJ-TESTRG-01 resourcegroup +AnujRG2 resourcegroup +asghodke-rg resourcegroup +``` + +You can filter by subscriptions, resourceGroups or any resource type. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to apply on the operation. +Use $filter=resourceType+eq+'Subscription' to filter on only resource of type = 'Subscription'. +Use $filter=resourceType+eq+'subscription'+or+resourceType+eq+'resourcegroup' to filter on resource of type = 'Subscription' or 'ResourceGroup' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Scope +The scope of the role management policy. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IEligibleChildResource + +## 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 <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzRoleManagementPolicy.md b/azps-10.1.0/Az.Resources/Get-AzRoleManagementPolicy.md new file mode 100644 index 0000000000..21efba1579 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzRoleManagementPolicy.md @@ -0,0 +1,165 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azrolemanagementpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleManagementPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleManagementPolicy.md +--- + +# Get-AzRoleManagementPolicy + +## SYNOPSIS +Get the specified role management policy for a resource scope + +## SYNTAX + +### List (Default) +``` +Get-AzRoleManagementPolicy -Scope <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzRoleManagementPolicy -Name <String> -Scope <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzRoleManagementPolicy -InputObject <IAuthorizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the specified role management policy for a resource scope + +## EXAMPLES + +### Example 1: List all role management policies under a resource scope +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +Get-AzRoleManagementPolicy -Scope $scope +``` + +```output +Name Type Scope +---- ---- ----- +588b80cc-f50c-4616-acc9-0003872624db Microsoft.Authorization/roleManagementPolicies /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +8dbbf139-4d46-4ad4-a56b-004156c117d2 Microsoft.Authorization/roleManagementPolicies /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +1c8bc687-402c-4e62-b38b-009d6fc244d3 Microsoft.Authorization/roleManagementPolicies /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +``` + +Returns all `roleManagementPolicies` for the `scope` + +### Example 2: Get a role management policy by Scope and Name +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +$name = "33b520ea-3544-4abc-8565-3588deb8e68e" +Get-AzRoleManagementPolicy -Scope $scope -Name $name +``` + +```output +Name Type Scope +---- ---- ----- +33b520ea-3544-4abc-8565-3588deb8e68e Microsoft.Authorization/roleManagementPolicies /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +``` + +Use the `Id` property to get `scope` and `name` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name (guid) of the role management policy to get. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RoleManagementPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role management policy. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IRoleManagementPolicy + +## 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 <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzRoleManagementPolicyAssignment.md b/azps-10.1.0/Az.Resources/Get-AzRoleManagementPolicyAssignment.md new file mode 100644 index 0000000000..b311e4d7ea --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzRoleManagementPolicyAssignment.md @@ -0,0 +1,167 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-azrolemanagementpolicyassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleManagementPolicyAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzRoleManagementPolicyAssignment.md +--- + +# Get-AzRoleManagementPolicyAssignment + +## SYNOPSIS +Get the specified role management policy assignment for a resource scope + +## SYNTAX + +### List (Default) +``` +Get-AzRoleManagementPolicyAssignment -Scope <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzRoleManagementPolicyAssignment -Name <String> -Scope <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzRoleManagementPolicyAssignment -InputObject <IAuthorizationIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the specified role management policy assignment for a resource scope + +## EXAMPLES + +### Example 1: List all role management policy assignments under a resource scope +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +Get-AzRoleManagementPolicyAssignment -Scope $scope +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +588b80cc-f50c-4616-acc9-0003872624db_00493d72-78f6-4148-b6c5-d3ce8e4799dd Microsoft.Authorization/roleManagementPolicyAssignment /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f… +8dbbf139-4d46-4ad4-a56b-004156c117d2_056cd41c-7e88-42e1-933e-88ba6a50c9c3 Microsoft.Authorization/roleManagementPolicyAssignment /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f… +1c8bc687-402c-4e62-b38b-009d6fc244d3_b97fb8bc-a8b2-4522-a38b-dd33c7e65ead Microsoft.Authorization/roleManagementPolicyAssignment /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f… +5d582357-e60a-4322-a299-00ab23713a07_70bbe301-9835-447d-afdd-19eb3167307c Microsoft.Authorization/roleManagementPolicyAssignment /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f… +``` + +Returns all `roleManagementPolicyAssignment` for the `scope` + +### Example 2: Get a role management policy assignment by Scope and Name +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +$name = "588b80cc-f50c-4616-acc9-0003872624db_00493d72-78f6-4148-b6c5-d3ce8e4799dd" +Get-AzRoleManagementPolicyAssignment -Scope $scope -Name $name +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +588b80cc-f50c-4616-acc9-0003872624db_00493d72-78f6-4148-b6c5-d3ce8e4799dd Microsoft.Authorization/roleManagementPolicyAssignment /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f… +``` + +Use the `Id` property to get `scope` and `name` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of format {guid_guid} the role management policy assignment to get. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RoleManagementPolicyAssignmentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role management policy. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IRoleManagementPolicyAssignment + +## 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 <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzSubscriptionDeploymentStack.md b/azps-10.1.0/Az.Resources/Get-AzSubscriptionDeploymentStack.md new file mode 100644 index 0000000000..84039b36f6 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzSubscriptionDeploymentStack.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/Get-AzSubscriptionDeploymentStack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzSubscriptionDeploymentStack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzSubscriptionDeploymentStack.md +--- + +# Get-AzSubscriptionDeploymentStack + +## SYNOPSIS +Gets Subscription scoped Deployment Stacks. + +## SYNTAX + +### ListDeploymentStacks (Default) +``` +Get-AzSubscriptionDeploymentStack [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByName +``` +Get-AzSubscriptionDeploymentStack [-Name] <String> [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceId +``` +Get-AzSubscriptionDeploymentStack -ResourceId <String> [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Retrieve a subscription scoped deployment stack. + +## EXAMPLES + +### Example 1: Retrieve a stack named MySubStack from the current subscription +```powershell +Get-AzSubscriptionDeploymentStack -Name MySubStack +``` + +Get a deployment stack named 'MySubStack' under the default subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the DeploymentStack to get + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: StackName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the DeploymentStack to get + +```yaml +Type: System.String +Parameter Sets: GetByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStack + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzTag.md b/azps-10.1.0/Az.Resources/Get-AzTag.md new file mode 100644 index 0000000000..b9046cd58f --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzTag.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Tags.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 726E01DD-D73C-4D4B-8FC0-52767927367C +online version: https://learn.microsoft.com/powershell/module/az.resources/get-aztag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzTag.md +--- + +# Get-AzTag + +## SYNOPSIS +Gets predefined Azure tags | Gets the entire set of tags on a resource or subscription. + +## SYNTAX + +### GetPredefinedTagParameterSet +``` +Get-AzTag [[-Name] <String>] [-Detailed] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzTag -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION + +**GetPredefinedTagSet**: The **Get-AzTag** cmdlet gets predefined Azure tags in your subscription. +This cmdlet returns basic information about the tags or detailed information about tags and their values. +All output objects include a Count property that represents the number of resources and resource groups to which the tags and values have been applied. +The Azure Tags module that **Get-AzTag** is a part of can help you manage predefined Azure tags. +An Azure tag is a name-value pair that you can use to categorize your Azure resources and resource groups, such as by department or cost center, or to track notes or comments about the resources and groups. +You can define and apply tags in a single step, but predefined tags let you establish standard, consistent, predictable names and values for the tags in your subscription. +To create a predefined tag, use the New-AzTag cmdlet. +To apply a predefined tag to a resource group, use the *Tag* parameter of the New-AzTag cmdlet. +To search resource groups for a specific tag name or name and value, use the *Tag* parameter of the Get-AzResourceGroup cmdlet. + +**GetByResourceIdParameterSet**: The **Get-AzTag** cmdlet with a **ResourceId** gets the entire set of tags on a resource or subscription. + +## EXAMPLES + +### Example 1: Get all predefined tags +```powershell +Get-AzTag +``` + +```output +Name Count +======== ===== + +Department 5 +FY2015 2 +CostCenter 20 +``` + +This command gets all predefined tags in the subscription. +The Count property shows how many times the tag has been applied to resources and resource groups in the subscription. + +### Example 2: Get a tag by name +```powershell +Get-AzTag -Name "Department" +``` + +```output +Name: Department +Count: 5 +Values: + + Name Count + ========== ===== + + Finance 2 + IT 3 +``` + +This command gets detailed information about the Department tag and its values. +The Count property shows how many times the tag and each of its values has been applied to resources and resource groups in the subscription. + +### Example 3: Get values of all tags +```powershell +Get-AzTag -Detailed +``` + +```output +Name: Department +Count: 5 +Values: + + Name Count + ========== ===== + + Finance 2 + IT 3 + + +Name: FY2015 +Count: 2 + + +Name: CostCenter +Count: 20 +Values: + + Name Count + ========== ===== + + 0001 5 + 0002 10 + 0003 5 +``` + +This command uses the *Detailed* parameter to get detailed information about all predefined tags in the subscription. +Using the *Detailed* parameter is the equivalent of using the *Name* parameter for every tag. + +### Example 4: Get the entire set of tags on a subscription + +```powershell +Get-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +``` + +```output +Id : {Id} +Name : {Name} +Type : {Type} +Properties : + Name Value + ======= ========= + tagKey1 tagValue1 + tagKey2 tagValue2 +``` + +This command gets the entire set of tags on the subscription with {subId}. + +### Example 5: Get the entire set of tags on a resource + +```powershell +Get-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/testrg/providers/Microsoft.Sql/servers/Server1 +``` + +```output +Id : {Id} +Name : {Name} +Type : {Type} +Properties : + Name Value + ======= ========= + Dept Finance + Status Normal +``` + +This command gets the entire set of tags on the resource with {resourceId}. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Detailed +Indicates that this operation adds information about tag values to the output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetPredefinedTagParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the predefined tag. +By default, **Get-AzTag** gets basic information about all predefined tags in the subscription. +When you specify the *Name* parameter, the *Detailed* parameter has no effect. + +```yaml +Type: System.String +Parameter Sets: GetPredefinedTagParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier for the tagged entity. A resource, a resource group or a subscription may be tagged. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Common.Tags.PSTag | Microsoft.Azure.Commands.Tags.Model.PSTagResource + +## NOTES + +## RELATED LINKS + +[New-AzTag](./New-AzTag.md) + +[Remove-AzTag](./Remove-AzTag.md) + +[Update-AzTag](./Update-AzTag.md) diff --git a/azps-10.1.0/Az.Resources/Get-AzTemplateSpec.md b/azps-10.1.0/Az.Resources/Get-AzTemplateSpec.md new file mode 100644 index 0000000000..98b62116bf --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzTemplateSpec.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-aztemplatespec +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzTemplateSpec.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzTemplateSpec.md +--- + +# Get-AzTemplateSpec + +## SYNOPSIS +Gets or lists Template Specs + +## SYNTAX + +### ListTemplateSpecsParameterSet (Default) +``` +Get-AzTemplateSpec [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetTemplateSpecByNameParameterSet +``` +Get-AzTemplateSpec [-ResourceGroupName] <String> [-Name] <String> [[-Version] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetTemplateSpecByIdParameterSet +``` +Get-AzTemplateSpec [[-Version] <String>] [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet can be used to list Template Specs in a subscription/resource group or get a specific Template Spec +by name or id. When getting a specific Template Spec by name/id a specific version can optionally be retrieved +by specifying a version name through the **-Version** parameter. When **-Version** is used, only the specific version +details will be present within **.Versions* on the returned Template Spec object. If no specific version +is specified when retrieving a Template Spec by name/id, all versions will be present within the **.Versions* +property of the returned object. + +**Note**: When listing all Template Specs within a subscription or resource group, each returned Template Spec's + *".Versions"* property will be *null*. Version information is only included when -Name or -ResourceId parameters +are provided (eg: you are requesting a specific template spec/version). + +## EXAMPLES + +### Example 1: List Template Specs in current subscription +```powershell +Get-AzTemplateSpec +``` + +Lists all Template Specs in the current subscription. + +### Example 2: List Template Specs in a resource group +```powershell +Get-AzTemplateSpec -ResourceGroupName 'myRG' +``` + +Lists all Template Specs in the resource group 'myRG' of the current subscription. + +### Example 3: Get Template Spec (with all versions) by name +```powershell +Get-AzTemplateSpec -ResourceGroupName 'myRG' -Name 'MyTemplateSpec' +``` + +Gets information about the Template Spec named 'MyTemplateSpec' within the resource group 'myRG'. + +**Note**: All of the Template Spec's versions will be present within the "*.Versions*" property +of the return object. + +### Example 4: Get Template Spec (specific version) by name +```powershell +Get-AzTemplateSpec -ResourceGroupName 'myRG' -Name 'MyTemplateSpec' -Version 'v1.0' +``` + +Gets information about version 'v1.0' of the Template Spec named 'MyTemplateSpec' within the resource group 'myRG'. + +**Note**: The *".Versions"* property of the returned object will contain only the specific version requested. + +### Example 5: Get Template Spec (with all versions) by resource id +```powershell +Get-AzTemplateSpec -ResourceId '/subscriptions/{subId}/resourceGroups/myRG/providers/Microsoft.Resources/templateSpecs/MyTemplateSpec' +``` + +Gets information about the Template Spec named 'MyTemplateSpec' within the resource group 'myRG' of subscription \{subId\}. + +**Note**: All of the Template Spec's versions will be present within the "*.Versions*" property +of the return object. + +### Example 6: Get Template Spec (specific version) by resource id +```powershell +Get-AzTemplateSpec -ResourceId '/subscriptions/{subId}/resourceGroups/myRG/providers/Microsoft.Resources/templateSpecs/MyTemplateSpec' -Version 'v1.0' +``` + +Gets information about version 'v1.0' of the Template Spec named 'MyTemplateSpec' within the resource group 'myRG' of subscription \{subId\}. + +**Note**: The *".Versions"* property of the returned object will contain only the specific version requested. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the template spec. + +```yaml +Type: System.String +Parameter Sets: GetTemplateSpecByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ListTemplateSpecsParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetTemplateSpecByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The fully qualified resource Id of the template spec. +Example: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName} + +```yaml +Type: System.String +Parameter Sets: GetTemplateSpecByIdParameterSet +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +The version of the template spec. + +```yaml +Type: System.String +Parameter Sets: GetTemplateSpecByNameParameterSet, GetTemplateSpecByIdParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSTemplateSpec + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzTenantBackfillStatus.md b/azps-10.1.0/Az.Resources/Get-AzTenantBackfillStatus.md new file mode 100644 index 0000000000..6de8605c4d --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzTenantBackfillStatus.md @@ -0,0 +1,96 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-aztenantbackfillstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzTenantBackfillStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzTenantBackfillStatus.md +--- + +# Get-AzTenantBackfillStatus + +## SYNOPSIS +Get the current Tenant Backfill Subscription Status + +## SYNTAX + +``` +Get-AzTenantBackfillStatus [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzTenantBackfillStatus** gets the Backfill Status for the current Tenant + +## EXAMPLES + +### Example 1: Get the Backfill Tenant Status +```powershell +Get-AzTenantBackfillStatus +``` + +```output +Name : Completed +Type : c7a87cda-9a66-4920-b0f8-869baa04efe0 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSBackfillStatus + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzTenantDeployment.md b/azps-10.1.0/Az.Resources/Get-AzTenantDeployment.md new file mode 100644 index 0000000000..3f0e682cf9 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzTenantDeployment.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-aztenantdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzTenantDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzTenantDeployment.md +--- + +# Get-AzTenantDeployment + +## SYNOPSIS +Get deployment at tenant scope + +## SYNTAX + +### GetByDeploymentName (Default) +``` +Get-AzTenantDeployment [[-Name] <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByDeploymentId +``` +Get-AzTenantDeployment -Id <String> [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzTenantDeployment** cmdlet gets the deployments at the tenant scope. +Specify the *Name* or *Id* parameter to filter the results. +By default, **Get-AzTenantDeployment** gets all deployments at the tenant scope. + +## EXAMPLES + +### Example 1: Get all deployments at the tenant scope +```powershell +Get-AzTenantDeployment +``` + +This command gets all deployments at the current tenant scope. + +### Example 2: Get a deployment by name +```powershell +Get-AzDeployment -Name "Deploy01" +``` + +This command gets the "Deploy01" deployment at the current tenant scope. +You can assign a name to a deployment when you create it by using the **New-AzTenantDeployment** cmdlets. +If you do not assign a name, the cmdlets provide a default name based on the template that is used to create the deployment. + +### Example 3: Get a deployment by ID +```powershell +Get-AzDeployment -Id "/providers/Microsoft.Resources/deployments/Deploy01" +``` + +This command gets the "Deploy01" deployment at the tenant scope. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified resource Id of the deployment. +example: /providers/Microsoft.Resources/deployments/{deploymentName} + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentId +Aliases: DeploymentId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of deployment. + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentName +Aliases: DeploymentName + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzTenantDeploymentOperation.md b/azps-10.1.0/Az.Resources/Get-AzTenantDeploymentOperation.md new file mode 100644 index 0000000000..3c2d9ca734 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzTenantDeploymentOperation.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-aztenantdeploymentoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzTenantDeploymentOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzTenantDeploymentOperation.md +--- + +# Get-AzTenantDeploymentOperation + +## SYNOPSIS +Get deployment operation for deployment at tenant scope + +## SYNTAX + +### GetByDeploymentName (Default) +``` +Get-AzTenantDeploymentOperation -DeploymentName <String> [-OperationId <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByDeploymentObject +``` +Get-AzTenantDeploymentOperation -DeploymentObject <PSDeployment> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzTenantDeploymentOperation** cmdlet lists all the operations that were part of deployment at the current tenant scope to help you identify and give more information about the exact operations that failed for a particular deployment. + +## EXAMPLES + +### Example 1: Get deployment operations given a deployment name +```powershell +Get-AzTenantDeploymentOperation -DeploymentName Deploy01 +``` + +Gets deployment operations with name "Deploy01" at the current tenant scope. + +### Example 2: Get a deployment and get its deployment operations +```powershell +Get-AzTenantDeployment -Name Deploy01 | Get-AzTenantDeploymentOperation +``` + +This command gets the deployment "Deploy01" at the current tenant scope and get its deployment operations. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The deployment name. + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentObject +The deployment object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment +Parameter Sets: GetByDeploymentObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OperationId +The deployment operation Id. + +```yaml +Type: System.String +Parameter Sets: GetByDeploymentName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentOperation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Get-AzTenantDeploymentWhatIfResult.md b/azps-10.1.0/Az.Resources/Get-AzTenantDeploymentWhatIfResult.md new file mode 100644 index 0000000000..ea73c33de7 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Get-AzTenantDeploymentWhatIfResult.md @@ -0,0 +1,398 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/get-aztenantdeploymentwhatifresult +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzTenantDeploymentWhatIfResult.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Get-AzTenantDeploymentWhatIfResult.md +--- + +# Get-AzTenantDeploymentWhatIfResult + +## SYNOPSIS +Gets a template What-If result for a deployment at tenant scope. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterObject +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterObject +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterObject +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterObject <Hashtable> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterFile +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterFile +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterFile +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParams +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterFile <String> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterUri +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterUri +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterUri +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsUri +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateParameterUri <String> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectWithNoParameters +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceId +``` +Get-AzTenantDeploymentWhatIfResult [-Name <String>] -Location <String> [-ResultFormat <WhatIfResultFormat>] + [-ExcludeChangeType <String[]>] -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzTenantDeploymentWhatIfResult** cmdlet gets the ARM template What-If result for a template deployment at the specified tenant scope. It returns a list of changes indicating what resources will be updated if the deployment is applied without making any changes to real resources. To specify the format for the returning result, use the *ResultFormat* parameter. + +## EXAMPLES + +### Example 1: Get a What-If result at tenant scope +```powershell +Get-AzTenantDeploymentWhatIfResult ` + -DeploymentName "deploy-01" ` + -Location "West US" ` + -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" ` + -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" ` + -ResultFormat "FullResourcePayloads" +``` + +This command gets a What-If result at tenant scope by using a custom template file and a parameter file on disk. +The command uses the *Location* parameter to specify where to store the deployment data. +The command uses the *TemplateFile* parameter to specify a template file. +The command uses the *TemplateParameterFile* parameter to specify a template parameter file. +The command uses the *ResultFormat* parameter to set the What-If result to include full resource payloads. + +### Example 2: Get a What-If result at tenant scope with ResourceIdOnly +```powershell +Get-AzTenantDeploymentWhatIfResult ` + -DeploymentName "deploy-01" ` + -Location "West US" ` + -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" ` + -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" ` + -ResultFormat "ResourceIdOnly" +``` + +This command gets a What-If result at tenant scope by using a custom template file and a parameter file on disk. +The command uses the *Location* parameter to specify where to store the deployment data. +The command uses the *TemplateFile* parameter to specify a template file. +The command uses the *TemplateParameterFile* parameter to specify a template parameter file. +The command uses the *ResultFormat* parameter to set the What-If result to only contain resource IDs. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeChangeType +Comma-separated list of resource change types to be excluded from What-If results. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location to store deployment data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deployment it's going to create. +If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. +"20131223140835". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultFormat +The What-If result format. + +```yaml +Type: Microsoft.Azure.Management.ResourceManager.Models.WhatIfResultFormat +Parameter Sets: (All) +Aliases: +Accepted values: ResourceIdOnly, FullResourcePayloads + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. +This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. +For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +Local path to the template file. Supported template file type: json and bicep. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateObject +A hash table which represents the template. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateObjectAndParameterFile, ByTemplateObjectAndParameterUri, ByTemplateObjectWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +A file that has the template parameters. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterFile, ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile, ByTemplateSpecResourceIdAndParams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Uri to the template parameter file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterUri, ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri, ByTemplateSpecResourceIdAndParamsUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +Resource ID of the templateSpec to be deployed. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Uri to the template file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.Deployments.PSWhatIfOperationResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Invoke-AzResourceAction.md b/azps-10.1.0/Az.Resources/Invoke-AzResourceAction.md new file mode 100644 index 0000000000..2e9eae8910 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Invoke-AzResourceAction.md @@ -0,0 +1,358 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 427F7300-0FEB-4F28-9C1D-27592AEBF6A0 +online version: https://learn.microsoft.com/powershell/module/az.resources/invoke-azresourceaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Invoke-AzResourceAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Invoke-AzResourceAction.md +--- + +# Invoke-AzResourceAction + +## SYNOPSIS +Invokes an action on a resource. + +## SYNTAX + +### ByResourceId (Default) +``` +Invoke-AzResourceAction [-Parameters <Hashtable>] -Action <String> -ResourceId <String> [-ODataQuery <String>] + [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BySubscriptionLevel +``` +Invoke-AzResourceAction [-Parameters <Hashtable>] -Action <String> -ResourceName <String> + -ResourceType <String> [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] + [-ODataQuery <String>] [-ResourceGroupName <String>] [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTenantLevel +``` +Invoke-AzResourceAction [-Parameters <Hashtable>] -Action <String> -ResourceName <String> + -ResourceType <String> [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] + [-ODataQuery <String>] [-TenantLevel] [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzResourceAction** cmdlet invokes an action on a specified Azure resource. +To get a list of supported actions, use the Azure Resource Explorer tool. + +## EXAMPLES + +### Example 1: Invoke starting a VM with ResourceId + +```powershell +Invoke-AzResourceAction -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testVM -Action start +``` + +```output +Confirm +Are you sure you want to invoke the 'start' action on the following resource: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testVM +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +``` + +This command starts the Virtual Machine with {ResourceId}. + +### Example 2: Invoke poweroffing a VM with ResourceName + +```powershell +Invoke-AzResourceAction -ResourceGroupName testGroup -ResourceName testVM -ResourceType Microsoft.Compute/virtualMachines/ -Action Poweroff -Force +``` + +This command stops the Virtual Machine with {ResourceId}. +The command specifies the *Force* parameter, therefore, it does not prompt you for confirmation. + +### Example 3: Invoke registering a resource provider with ResourceId + +```powershell +Invoke-AzResourceAction -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Network -action register -Force +``` + +```output +id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Network +namespace : Microsoft.Network +authorizations : {…} +resourceTypes : {@{resourceType=virtualNetworks; locations=System.Object[]; apiVersions=System.Object[]}, + @{resourceType=publicIPAddresses; locations=System.Object[]; apiVersions=System.Object[]}, + @{resourceType=networkInterfaces; locations=System.Object[]; apiVersions=System.Object[]}, + @{resourceType=privateEndpoints; locations=System.Object[]; apiVersions=System.Object[]}…} +registrationState : Registered +``` + +This command registers a resource provider "Microsoft.Network". +The command specifies the *Force* parameter, therefore, it does not prompt you for confirmation. + +## PARAMETERS + +### -Action +Specifies the name of the action to invoke. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ActionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionResourceName +Specifies the name of an extension resource for the resource on which this cmdlet invokes an action. +For instance, to specify a database, use the following format: +server name`/`database name + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExtensionResourceType +Specifies the type of the extension resource. +For instance: +`Microsoft.Sql/Servers/Databases` + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ODataQuery +Specifies an Open Data Protocol (OData) style filter. +This cmdlet appends this value to the request in addition to any other filters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameters +Specifies parameters, as a hash table, for the action that this cmdlet invokes. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Object + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group in which this cmdlet invokes an action. + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the fully qualified resource ID of the resource on which this cmdlet invokes an action. +The ID includes the subscription, as in the following example: +`/subscriptions/`subscription ID`/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase` + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +Specifies the name of the resource of the resource on which this cmdlet invokes an action. +For instance, to specify a database, use the following format: +`ContosoServer/ContosoDatabase` + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +Specifies the type of the resource. +For instance, for a database, the resource type is as follows: +`Microsoft.Sql/Servers/Databases` + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantLevel +Indicates that this cmdlet operates at the tenant level. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByTenantLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Move-AzResource.md b/azps-10.1.0/Az.Resources/Move-AzResource.md new file mode 100644 index 0000000000..6dd4bd14b7 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Move-AzResource.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 60BED40A-EEA4-4667-93E9-8A9B35037726 +online version: https://learn.microsoft.com/powershell/module/az.resources/move-azresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Move-AzResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Move-AzResource.md +--- + +# Move-AzResource + +## SYNOPSIS +Moves a resource to a different resource group or subscription. + +## SYNTAX + +``` +Move-AzResource -DestinationResourceGroupName <String> [-DestinationSubscriptionId <Guid>] + -ResourceId <String[]> [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Move-AzResource** cmdlet moves existing resources to a different resource group. +That resource group can be in a different subscription. + +## EXAMPLES + +### Example 1: Move a resource to a resource group +```powershell +$Resource = Get-AzResource -ResourceType "Microsoft.ClassicCompute/storageAccounts" -ResourceName "ContosoStorageAccount" +Move-AzResource -ResourceId $Resource.ResourceId -DestinationResourceGroupName "ResourceGroup14" +``` + +The first command gets a resource named ContosoStorageAccount by using the Get-AzResource cmdlet, and then stores that resource in the $Resource variable. +The second command moves that resource into the resource group named ResourceGroup14. +The command identifies the resource to move by using the **ResourceId** property of $Resource. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationResourceGroupName +Specifies the name of the resource group into which this cmdlet moves resources. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TargetResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationSubscriptionId +Specifies the ID of the subscription into which this cmdlet moves resources . + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: Id, SubscriptionId + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Specifies an array of IDs of the resources that this cmdlet moves. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String[] + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzResource](./Get-AzResource.md) + +[New-AzResource](./New-AzResource.md) + +[Remove-AzResource](./Remove-AzResource.md) + +[Set-AzResource](./Set-AzResource.md) + + diff --git a/azps-10.1.0/Az.Resources/New-AzADAppCredential.md b/azps-10.1.0/Az.Resources/New-AzADAppCredential.md new file mode 100644 index 0000000000..fe876e2997 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzADAppCredential.md @@ -0,0 +1,640 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azadappcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADAppCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADAppCredential.md +--- + +# New-AzADAppCredential + +## SYNOPSIS +Creates key credentials or password credentials for an application. + +## SYNTAX + +### ApplicationObjectIdWithPasswordParameterSet (Default) +``` +New-AzADAppCredential -ObjectId <String> [-StartDate <DateTime>] [-EndDate <DateTime>] + [-CustomKeyIdentifier <String>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationObjectIdWithCertValueParameterSet +``` +New-AzADAppCredential -ObjectId <String> [-StartDate <DateTime>] [-EndDate <DateTime>] + [-CustomKeyIdentifier <String>] -CertValue <String> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ApplicationObjectIdWithKeyCredentialParameterSet +``` +New-AzADAppCredential -ObjectId <String> [-CustomKeyIdentifier <String>] + -KeyCredentials <MicrosoftGraphKeyCredential[]> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ApplicationObjectIdWithPasswordCredentialParameterSet +``` +New-AzADAppCredential -ObjectId <String> [-CustomKeyIdentifier <String>] + -PasswordCredentials <MicrosoftGraphPasswordCredential[]> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ApplicationObjectWithPasswordParameterSet +``` +New-AzADAppCredential [-StartDate <DateTime>] [-EndDate <DateTime>] [-CustomKeyIdentifier <String>] + -ApplicationObject <IMicrosoftGraphApplication> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ApplicationObjectWithCertValueParameterSet +``` +New-AzADAppCredential [-StartDate <DateTime>] [-EndDate <DateTime>] [-CustomKeyIdentifier <String>] + -CertValue <String> -ApplicationObject <IMicrosoftGraphApplication> [-DefaultProfile <PSObject>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### DisplayNameWithPasswordParameterSet +``` +New-AzADAppCredential [-StartDate <DateTime>] [-EndDate <DateTime>] [-CustomKeyIdentifier <String>] + -DisplayName <String> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DisplayNameWithCertValueParameterSet +``` +New-AzADAppCredential [-StartDate <DateTime>] [-EndDate <DateTime>] [-CustomKeyIdentifier <String>] + -CertValue <String> -DisplayName <String> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ApplicationIdWithCertValueParameterSet +``` +New-AzADAppCredential [-StartDate <DateTime>] [-EndDate <DateTime>] [-CustomKeyIdentifier <String>] + -CertValue <String> -ApplicationId <Guid> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ApplicationIdWithPasswordParameterSet +``` +New-AzADAppCredential [-StartDate <DateTime>] [-EndDate <DateTime>] [-CustomKeyIdentifier <String>] + -ApplicationId <Guid> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationObjectWithPasswordCredentialParameterSet +``` +New-AzADAppCredential [-CustomKeyIdentifier <String>] -PasswordCredentials <MicrosoftGraphPasswordCredential[]> + -ApplicationObject <IMicrosoftGraphApplication> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DisplayNameWithPasswordCredentialParameterSet +``` +New-AzADAppCredential [-CustomKeyIdentifier <String>] -PasswordCredentials <MicrosoftGraphPasswordCredential[]> + -DisplayName <String> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationIdWithPasswordCredentialParameterSet +``` +New-AzADAppCredential [-CustomKeyIdentifier <String>] -PasswordCredentials <MicrosoftGraphPasswordCredential[]> + -ApplicationId <Guid> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationObjectWithKeyCredentialParameterSet +``` +New-AzADAppCredential [-CustomKeyIdentifier <String>] -KeyCredentials <MicrosoftGraphKeyCredential[]> + -ApplicationObject <IMicrosoftGraphApplication> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DisplayNameWithKeyCredentialParameterSet +``` +New-AzADAppCredential [-CustomKeyIdentifier <String>] -KeyCredentials <MicrosoftGraphKeyCredential[]> + -DisplayName <String> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationIdWithKeyCredentialParameterSet +``` +New-AzADAppCredential [-CustomKeyIdentifier <String>] -KeyCredentials <MicrosoftGraphKeyCredential[]> + -ApplicationId <Guid> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates key credentials or password credentials for an application. + +## EXAMPLES + +### Example 1: Create key credentials for application +```powershell +# ObjectId is the string representation of a GUID for directory object, application, in Azure AD. +$Id = "00000000-0000-0000-0000-000000000000" +# $cert is Base64 encoded content of certificate +$credential = New-Object -TypeName "Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphKeyCredential" ` + -Property @{'Key' = $cert; + 'Usage' = 'Verify'; + 'Type' = 'AsymmetricX509Cert' + } +New-AzADAppCredential -ObjectId $Id -KeyCredentials $credential +``` + +Create key credentials for application with object Id $Id + +### Example 2: Create password credentials for application +```powershell +# ApplicationId is AppId of Application object which is different from directory id in Azure AD. +Get-AzADApplication -ApplicationId $appId | New-AzADAppCredential -StartDate $startDate -EndDate $endDate +``` + +Create password credentials for application + +## PARAMETERS + +### -ApplicationId +The application Id. + +```yaml +Type: System.Guid +Parameter Sets: ApplicationIdWithCertValueParameterSet, ApplicationIdWithPasswordParameterSet, ApplicationIdWithPasswordCredentialParameterSet, ApplicationIdWithKeyCredentialParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationObject +The application object, could be used as pipeline input. +To construct, see NOTES section for APPLICATIONOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication +Parameter Sets: ApplicationObjectWithPasswordParameterSet, ApplicationObjectWithCertValueParameterSet, ApplicationObjectWithPasswordCredentialParameterSet, ApplicationObjectWithKeyCredentialParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertValue +The value of the 'asymmetric' credential type. +It represents the base 64 encoded certificate. + +```yaml +Type: System.String +Parameter Sets: ApplicationObjectIdWithCertValueParameterSet, ApplicationObjectWithCertValueParameterSet, DisplayNameWithCertValueParameterSet, ApplicationIdWithCertValueParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomKeyIdentifier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name of application. + +```yaml +Type: System.String +Parameter Sets: DisplayNameWithPasswordParameterSet, DisplayNameWithCertValueParameterSet, DisplayNameWithPasswordCredentialParameterSet, DisplayNameWithKeyCredentialParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The effective end date of the credential usage. +The default end date value is one year from today. +For an 'asymmetric' type credential, this must be set to on or before the date that the X509 certificate is valid. + +```yaml +Type: System.DateTime +Parameter Sets: ApplicationObjectIdWithPasswordParameterSet, ApplicationObjectIdWithCertValueParameterSet, ApplicationObjectWithPasswordParameterSet, ApplicationObjectWithCertValueParameterSet, DisplayNameWithPasswordParameterSet, DisplayNameWithCertValueParameterSet, ApplicationIdWithCertValueParameterSet, ApplicationIdWithPasswordParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyCredentials +key credentials associated with the application. +To construct, see NOTES section for KEYCREDENTIALS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphKeyCredential[] +Parameter Sets: ApplicationObjectIdWithKeyCredentialParameterSet, ApplicationObjectWithKeyCredentialParameterSet, DisplayNameWithKeyCredentialParameterSet, ApplicationIdWithKeyCredentialParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The object Id of application. + +```yaml +Type: System.String +Parameter Sets: ApplicationObjectIdWithPasswordParameterSet, ApplicationObjectIdWithCertValueParameterSet, ApplicationObjectIdWithKeyCredentialParameterSet, ApplicationObjectIdWithPasswordCredentialParameterSet +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordCredentials +Password credentials associated with the application. +To construct, see NOTES section for PASSWORDCREDENTIALS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphPasswordCredential[] +Parameter Sets: ApplicationObjectIdWithPasswordCredentialParameterSet, ApplicationObjectWithPasswordCredentialParameterSet, DisplayNameWithPasswordCredentialParameterSet, ApplicationIdWithPasswordCredentialParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The effective start date of the credential usage. +The default start date value is today. +For an 'asymmetric' type credential, this must be set to on or after the date that the X509 certificate is valid from. + +```yaml +Type: System.DateTime +Parameter Sets: ApplicationObjectIdWithPasswordParameterSet, ApplicationObjectIdWithCertValueParameterSet, ApplicationObjectWithPasswordParameterSet, ApplicationObjectWithCertValueParameterSet, DisplayNameWithPasswordParameterSet, DisplayNameWithCertValueParameterSet, ApplicationIdWithCertValueParameterSet, ApplicationIdWithPasswordParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphKeyCredential + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordCredential + +## 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. + + +APPLICATIONOBJECT <IMicrosoftGraphApplication>: The application object, could be used as pipeline input. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + +KEYCREDENTIALS <MicrosoftGraphKeyCredential[]>: key credentials associated with the application. + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + +PASSWORDCREDENTIALS <MicrosoftGraphPasswordCredential[]>: Password credentials associated with the application. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzADAppFederatedCredential.md b/azps-10.1.0/Az.Resources/New-AzADAppFederatedCredential.md new file mode 100644 index 0000000000..8226502f9c --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzADAppFederatedCredential.md @@ -0,0 +1,217 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azadappfederatedcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADAppFederatedCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADAppFederatedCredential.md +--- + +# New-AzADAppFederatedCredential + +## SYNOPSIS +Create federatedIdentityCredential for applications. + +## SYNTAX + +``` +New-AzADAppFederatedCredential -ApplicationObjectId <String> -Audience <String[]> -Issuer <String> + -Name <String> -Subject <String> [-AdditionalProperties <Hashtable>] [-Description <String>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create federatedIdentityCredential for applications. + +## EXAMPLES + +### Example 1: Create federated identity credential for application +```powershell +New-AzADAppFederatedCredential -ApplicationObjectId $appObjectId -Audience api://AzureADTokenExchange -Issuer https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0 -name 'test-cred' -Subject 'subject' +``` + +Create federated identity credential for application + +## PARAMETERS + +### -AdditionalProperties +Additional Parameters + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationObjectId +key: id of application + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Audience +Lists the audiences that can appear in the external token. +This field is mandatory, and defaults to 'api://AzureADTokenExchange'. +It says what Microsoft identity platform should accept in the aud claim in the incoming token. +This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. +Required. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The un-validated, user-provided description of the federated identity credential. +Optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Issuer +The URL of the external identity provider and must match the issuer claim of the external token being exchanged. +The combination of the values of issuer and subject must be unique on the app. +Required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. +It is immutable once created. +Required. +Not nullable. +Supports $filter (eq). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subject +Required. +The identifier of the external software workload within the external identity provider. +Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. +The value here must match the sub claim within the token presented to Azure AD. +The combination of issuer and subject must be unique on the app. +Supports $filter (eq). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphFederatedIdentityCredential + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzADApplication.md b/azps-10.1.0/Az.Resources/New-AzADApplication.md new file mode 100644 index 0000000000..99c579dae1 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzADApplication.md @@ -0,0 +1,1511 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azadapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADApplication.md +--- + +# New-AzADApplication + +## SYNOPSIS +Adds new entity to applications + +## SYNTAX + +### ApplicationWithoutCredentialParameterSet (Default) +``` +New-AzADApplication -DisplayName <String> [-AvailableToOtherTenants <Boolean>] [-HomePage <String>] + [-ReplyUrls <String[]>] [-IdentifierUri <String[]>] [-Web <IMicrosoftGraphWebApplication>] + [-AddIn <IMicrosoftGraphAddIn[]>] [-Api <IMicrosoftGraphApiApplication>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-ApplicationTemplateId <String>] [-CreatedOnBehalfOfDeletedDateTime <DateTime>] [-DeletedDateTime <DateTime>] + [-Description <String>] [-DisabledByMicrosoftStatus <String>] [-GroupMembershipClaim <String>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-IsDeviceOnlyAuthSupported] [-IsFallbackPublicClient] + [-LogoInputFile <String>] [-Note <String>] [-Oauth2RequirePostResponse] + [-OptionalClaim <IMicrosoftGraphOptionalClaims>] + [-ParentalControlSetting <IMicrosoftGraphParentalControlSettings>] [-PublicClientRedirectUri <String[]>] + [-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>] [-SignInAudience <String>] + [-SPARedirectUri <String[]>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] [-DefaultProfile <PSObject>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ApplicationWithKeyCredentialParameterSet +``` +New-AzADApplication -DisplayName <String> [-AvailableToOtherTenants <Boolean>] [-HomePage <String>] + [-ReplyUrls <String[]>] [-IdentifierUri <String[]>] [-Web <IMicrosoftGraphWebApplication>] + [-AddIn <IMicrosoftGraphAddIn[]>] [-Api <IMicrosoftGraphApiApplication>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-ApplicationTemplateId <String>] [-CreatedOnBehalfOfDeletedDateTime <DateTime>] [-DeletedDateTime <DateTime>] + [-Description <String>] [-DisabledByMicrosoftStatus <String>] [-GroupMembershipClaim <String>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-IsDeviceOnlyAuthSupported] [-IsFallbackPublicClient] + [-LogoInputFile <String>] [-Note <String>] [-Oauth2RequirePostResponse] + [-OptionalClaim <IMicrosoftGraphOptionalClaims>] + [-ParentalControlSetting <IMicrosoftGraphParentalControlSettings>] [-PublicClientRedirectUri <String[]>] + [-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>] [-SignInAudience <String>] + [-SPARedirectUri <String[]>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] -KeyCredentials <IMicrosoftGraphKeyCredential[]> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationWithPasswordCredentialParameterSet +``` +New-AzADApplication -DisplayName <String> [-AvailableToOtherTenants <Boolean>] [-HomePage <String>] + [-ReplyUrls <String[]>] [-IdentifierUri <String[]>] [-Web <IMicrosoftGraphWebApplication>] + [-AddIn <IMicrosoftGraphAddIn[]>] [-Api <IMicrosoftGraphApiApplication>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-ApplicationTemplateId <String>] [-CreatedOnBehalfOfDeletedDateTime <DateTime>] [-DeletedDateTime <DateTime>] + [-Description <String>] [-DisabledByMicrosoftStatus <String>] [-GroupMembershipClaim <String>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-IsDeviceOnlyAuthSupported] [-IsFallbackPublicClient] + [-LogoInputFile <String>] [-Note <String>] [-Oauth2RequirePostResponse] + [-OptionalClaim <IMicrosoftGraphOptionalClaims>] + [-ParentalControlSetting <IMicrosoftGraphParentalControlSettings>] [-PublicClientRedirectUri <String[]>] + [-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>] [-SignInAudience <String>] + [-SPARedirectUri <String[]>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] + -PasswordCredentials <IMicrosoftGraphPasswordCredential[]> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ApplicationWithKeyPlainParameterSet +``` +New-AzADApplication -DisplayName <String> [-AvailableToOtherTenants <Boolean>] [-HomePage <String>] + [-ReplyUrls <String[]>] [-IdentifierUri <String[]>] [-Web <IMicrosoftGraphWebApplication>] + [-AddIn <IMicrosoftGraphAddIn[]>] [-Api <IMicrosoftGraphApiApplication>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-ApplicationTemplateId <String>] [-CreatedOnBehalfOfDeletedDateTime <DateTime>] [-DeletedDateTime <DateTime>] + [-Description <String>] [-DisabledByMicrosoftStatus <String>] [-GroupMembershipClaim <String>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-IsDeviceOnlyAuthSupported] [-IsFallbackPublicClient] + [-LogoInputFile <String>] [-Note <String>] [-Oauth2RequirePostResponse] + [-OptionalClaim <IMicrosoftGraphOptionalClaims>] + [-ParentalControlSetting <IMicrosoftGraphParentalControlSettings>] [-PublicClientRedirectUri <String[]>] + [-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>] [-SignInAudience <String>] + [-SPARedirectUri <String[]>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] -CertValue <String> [-StartDate <DateTime>] + [-EndDate <DateTime>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationWithPasswordPlainParameterSet +``` +New-AzADApplication -DisplayName <String> [-AvailableToOtherTenants <Boolean>] [-HomePage <String>] + [-ReplyUrls <String[]>] [-IdentifierUri <String[]>] [-Web <IMicrosoftGraphWebApplication>] + [-AddIn <IMicrosoftGraphAddIn[]>] [-Api <IMicrosoftGraphApiApplication>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-ApplicationTemplateId <String>] [-CreatedOnBehalfOfDeletedDateTime <DateTime>] [-DeletedDateTime <DateTime>] + [-Description <String>] [-DisabledByMicrosoftStatus <String>] [-GroupMembershipClaim <String>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-IsDeviceOnlyAuthSupported] [-IsFallbackPublicClient] + [-LogoInputFile <String>] [-Note <String>] [-Oauth2RequirePostResponse] + [-OptionalClaim <IMicrosoftGraphOptionalClaims>] + [-ParentalControlSetting <IMicrosoftGraphParentalControlSettings>] [-PublicClientRedirectUri <String[]>] + [-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>] [-SignInAudience <String>] + [-SPARedirectUri <String[]>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] [-StartDate <DateTime>] [-EndDate <DateTime>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Adds new entity to applications + +## EXAMPLES + +### Example 1: Create application +```powershell +New-AzADApplication -SigninAudience AzureADandPersonalMicrosoftAccount +``` + +Create application with signin audience 'AzureADandPersonalMicrosoftAccount', other available options are: 'AzureADMyOrg', 'AzureADMultipleOrgs', 'PersonalMicrosoftAccount' + +## PARAMETERS + +### -AddIn +Defines custom behavior that a consuming service can use to call an app in specific contexts. +For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. +This will let services like Office 365 call the application in the context of a document the user is working on. +To construct, see NOTES section for ADDIN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAddIn[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Api +apiApplication +To construct, see NOTES section for API properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApiApplication +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationTemplateId +Unique identifier of the applicationTemplate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppRole +The collection of roles assigned to the application. +With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. +Not nullable. +To construct, see NOTES section for APPROLE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAppRole[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailableToOtherTenants +The value specifying whether the application is a single tenant or a multi-tenant. +Is equivalent to '-SignInAudience AzureADMultipleOrgs' when switch is on + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertValue +The value of the 'asymmetric' credential type. +It represents the base 64 encoded certificate. + +```yaml +Type: System.String +Parameter Sets: ApplicationWithKeyPlainParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreatedOnBehalfOfDeletedDateTime +. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedDateTime +. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +An optional description of the application. +Returned by default. +Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledByMicrosoftStatus +Specifies whether Microsoft has disabled the registered application. +Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). +Supports $filter (eq, ne, NOT). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name for the application. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and $orderBy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The effective end date of the credential usage. +The default end date value is one year from today. +For an 'asymmetric' type credential, this must be set to on or before the date that the X509 certificate is valid. + +```yaml +Type: System.DateTime +Parameter Sets: ApplicationWithKeyPlainParameterSet, ApplicationWithPasswordPlainParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMembershipClaim +Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. +To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HomePage +The URL to the application homepage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WebHomePageUrl + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HomeRealmDiscoveryPolicy +. +To construct, see NOTES section for HOMEREALMDISCOVERYPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphHomeRealmDiscoveryPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentifierUri +The URIs that identify the application. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: IdentifierUris + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Info +informationalUrl +To construct, see NOTES section for INFO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphInformationalUrl +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDeviceOnlyAuthSupported +Specifies whether this application supports device authentication without a user. +The default is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFallbackPublicClient +Specifies the fallback application type as public client, such as an installed application running on a mobile device. +The default value is false which means the fallback application type is confidential client such as a web app. +There are certain scenarios where Azure AD cannot determine the client application type. +For example, the ROPC flow where the application is configured without specifying a redirect URI. +In those cases Azure AD interprets the application type based on the value of this property. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyCredentials +key credentials associated with the application. +To construct, see NOTES section for KEYCREDENTIALS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphKeyCredential[] +Parameter Sets: ApplicationWithKeyCredentialParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogoInputFile +Input File for Logo (The main logo for the application. +Not nullable.) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +Notes relevant for the management of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Oauth2RequirePostResponse +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptionalClaim +optionalClaims +To construct, see NOTES section for OPTIONALCLAIM properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphOptionalClaims +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentalControlSetting +parentalControlSettings +To construct, see NOTES section for PARENTALCONTROLSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphParentalControlSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordCredentials +Password credentials associated with the application. +To construct, see NOTES section for PASSWORDCREDENTIALS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordCredential[] +Parameter Sets: ApplicationWithPasswordCredentialParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicClientRedirectUri + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyUrls +The application reply Urls. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: WebRedirectUri + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredResourceAccess +Specifies the resources that the application needs to access. +This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. +This configuration of access to the required resources drives the consent experience. +Not nullable. +Supports $filter (eq, NOT, ge, le). +To construct, see NOTES section for REQUIREDRESOURCEACCESS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphRequiredResourceAccess[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignInAudience +Specifies the Microsoft accounts that are supported for the current application. +Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. +See more in the table below. +Supports $filter (eq, ne, NOT). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SPARedirectUri + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The effective start date of the credential usage. +The default start date value is today. +For an 'asymmetric' type credential, this must be set to on or after the date that the X509 certificate is valid from. + +```yaml +Type: System.DateTime +Parameter Sets: ApplicationWithKeyPlainParameterSet, ApplicationWithPasswordPlainParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Custom strings that can be used to categorize and identify the application. +Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenEncryptionKeyId +Specifies the keyId of a public key from the keyCredentials collection. +When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. +The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenIssuancePolicy +. +To construct, see NOTES section for TOKENISSUANCEPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphTokenIssuancePolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenLifetimePolicy +The tokenLifetimePolicies assigned to this application. +Supports $expand. +To construct, see NOTES section for TOKENLIFETIMEPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphTokenLifetimePolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Web +webApplication +To construct, see NOTES section for WEB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphWebApplication +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication + +## 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. + + +ADDIN <IMicrosoftGraphAddIn[]>: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + +API <IMicrosoftGraphApiApplication>: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + +APPROLE <IMicrosoftGraphAppRole[]>: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + +HOMEREALMDISCOVERYPOLICY <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>: . + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +INFO <IMicrosoftGraphInformationalUrl>: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + +KEYCREDENTIALS <IMicrosoftGraphKeyCredential[]>: key credentials associated with the application. + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + +OPTIONALCLAIM <IMicrosoftGraphOptionalClaims>: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + +PARENTALCONTROLSETTING <IMicrosoftGraphParentalControlSettings>: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + +PASSWORDCREDENTIALS <IMicrosoftGraphPasswordCredential[]>: Password credentials associated with the application. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + +REQUIREDRESOURCEACCESS <IMicrosoftGraphRequiredResourceAccess[]>: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + +TOKENISSUANCEPOLICY <IMicrosoftGraphTokenIssuancePolicy[]>: . + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +TOKENLIFETIMEPOLICY <IMicrosoftGraphTokenLifetimePolicy[]>: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +WEB <IMicrosoftGraphWebApplication>: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzADGroup.md b/azps-10.1.0/Az.Resources/New-AzADGroup.md new file mode 100644 index 0000000000..f97ebe43e7 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzADGroup.md @@ -0,0 +1,577 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azadgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADGroup.md +--- + +# New-AzADGroup + +## SYNOPSIS +Adds new entity to groups + +## SYNTAX + +``` +New-AzADGroup -DisplayName <String> -MailNickname <String> [-AcceptedSender <IMicrosoftGraphDirectoryObject[]>] + [-AdditionalProperties <Hashtable>] [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>] + [-Classification <String>] [-CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>] [-DeletedDateTime <DateTime>] + [-Description <String>] [-GroupType <String[]>] [-HasMembersWithLicenseError] [-IsArchived] + [-IsAssignableToRole] [-MailEnabled] [-MembershipRule <String>] [-MembershipRuleProcessingState <String>] + [-PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>] [-PreferredDataLocation <String>] + [-PreferredLanguage <String>] [-SecurityEnabled] [-SecurityIdentifier <String>] [-Theme <String>] + [-TransitiveMember <IMicrosoftGraphDirectoryObject[]>] + [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>] [-Visibility <String>] [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Adds new entity to groups + +## EXAMPLES + +### Example 1: Create group +```powershell +New-AzADGroup -DisplayName $gname -MailNickname $nickname +``` + +Create group + +## PARAMETERS + +### -AcceptedSender +The list of users or groups that are allowed to create post's or calendar events in this group. +If this list is non-empty then only users or groups listed here are allowed to post. +To construct, see NOTES section for ACCEPTEDSENDER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphDirectoryObject[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdditionalProperties +Additional Parameters + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppRoleAssignment +Represents the app roles a group has been granted for an application. +Supports $expand. +To construct, see NOTES section for APPROLEASSIGNMENT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAppRoleAssignmentAutoGenerated[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Classification +Describes a classification for the group (such as low, medium or high business impact). +Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. +Supports $filter (eq, ne, NOT, ge, le, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreatedOnBehalfOf +Represents an Azure Active Directory object. +The directoryObject type is the base type for many other directory entity types. +To construct, see NOTES section for CREATEDONBEHALFOF properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphDirectoryObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedDateTime +. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +An optional description for the group. +Returned by default. +Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name for the group. +This property is required when a group is created and cannot be cleared during updates. +Returned by default. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and $orderBy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupType +Specifies the group type and its membership. +If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. +For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. +Returned by default. +Supports $filter (eq, NOT). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasMembersWithLicenseError +Indicates whether there are members in this group that have license errors from its group-based license assignment. +This property is never returned on a GET operation. +You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). +Supports $filter (eq). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchived +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAssignableToRole +Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable. +If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). +Only callers in Global administrator and Privileged role administrator roles can set this property. +The caller must also be assigned the Directory.AccessAsUser.All permission to set this property. +For more, see Using a group to manage Azure AD role assignmentsReturned by default. +Supports $filter (eq, ne, NOT). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailEnabled +Specifies whether the group is mail-enabled. +Returned by default. +Supports $filter (eq, ne, NOT). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailNickname +The mail alias for the group, unique in the organization. +This property must be specified when a group is created. +These characters cannot be used in the mailNickName: @()/[]';:.\<\>,SPACE. +Returned by default. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MembershipRule +The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). +For more information about the syntax of the membership rule, see Membership Rules syntax. +Returned by default. +Supports $filter (eq, ne, NOT, ge, le, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MembershipRuleProcessingState +Indicates whether the dynamic membership processing is on or paused. +Possible values are On or Paused. +Returned by default. +Supports $filter (eq, ne, NOT, in). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionGrant +The permissions that have been granted for a group to a specific application. +Supports $expand. +To construct, see NOTES section for PERMISSIONGRANT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphResourceSpecificPermissionGrant[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredDataLocation +The preferred data location for the group. +For more information, see OneDrive Online Multi-Geo. +Returned by default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredLanguage +The preferred language for a Microsoft 365 group. +Should follow ISO 639-1 Code; for example 'en-US'. +Returned by default. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityEnabled +Specifies whether the group is a security group. +Returned by default. +Supports $filter (eq, ne, NOT, in). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityIdentifier +Security identifier of the group, used in Windows scenarios. +Returned by default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Theme +Specifies a Microsoft 365 group's color theme. +Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. +Returned by default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransitiveMember +. +To construct, see NOTES section for TRANSITIVEMEMBER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphDirectoryObject[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransitiveMemberOf +. +To construct, see NOTES section for TRANSITIVEMEMBEROF properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphDirectoryObject[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Visibility +Specifies the group join policy and group content visibility for groups. +Possible values are: Private, Public, or Hiddenmembership. +Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. +It can't be updated later. +Other values of visibility can be updated after group creation. +If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. +See group visibility options to learn more. +Returned by default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup + +## 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. + + +ACCEPTEDSENDER <IMicrosoftGraphDirectoryObject[]>: The list of users or groups that are allowed to create post's or calendar events in this group. If this list is non-empty then only users or groups listed here are allowed to post. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +APPROLEASSIGNMENT <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>: Represents the app roles a group has been granted for an application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[CreatedDateTime <DateTime?>]`: The time when the app role assignment was created.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[PrincipalDisplayName <String>]`: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith). + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[PrincipalType <String>]`: The type of the assigned principal. This can either be User, Group or ServicePrincipal. Read-only. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + +CREATEDONBEHALFOF <IMicrosoftGraphDirectoryObject>: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +PERMISSIONGRANT <IMicrosoftGraphResourceSpecificPermissionGrant[]>: The permissions that have been granted for a group to a specific application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[ClientAppId <String>]`: ID of the service principal of the Azure AD app that has been granted access. Read-only. + - `[ClientId <String>]`: ID of the Azure AD app that has been granted access. Read-only. + - `[Permission <String>]`: The name of the resource-specific permission. Read-only. + - `[PermissionType <String>]`: The type of permission. Possible values are: Application, Delegated. Read-only. + - `[ResourceAppId <String>]`: ID of the Azure AD app that is hosting the resource. Read-only. + +TRANSITIVEMEMBER <IMicrosoftGraphDirectoryObject[]>: . + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +TRANSITIVEMEMBEROF <IMicrosoftGraphDirectoryObject[]>: . + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzADServicePrincipal.md b/azps-10.1.0/Az.Resources/New-AzADServicePrincipal.md new file mode 100644 index 0000000000..6dbcdbd111 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzADServicePrincipal.md @@ -0,0 +1,2168 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azadserviceprincipal +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADServicePrincipal.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADServicePrincipal.md +--- + +# New-AzADServicePrincipal + +## SYNOPSIS +Adds new entity to servicePrincipals + +## SYNTAX + +### SimpleParameterSet (Default) +``` +New-AzADServicePrincipal [-DisplayName <String>] [-Role <String>] [-Scope <String>] [-Homepage <String>] + [-ReplyUrl <String[]>] [-StartDate <DateTime>] [-EndDate <DateTime>] [-AccountEnabled] + [-AddIn <IMicrosoftGraphAddIn[]>] [-AlternativeName <String[]>] [-AppDescription <String>] + [-AppOwnerOrganizationId <String>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>] + [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>] [-AppRoleAssignmentRequired] + [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>] + [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>] + [-DeletedDateTime <DateTime>] [-Description <String>] [-DisabledByMicrosoftStatus <String>] + [-Endpoint <IMicrosoftGraphEndpoint[]>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-LoginUrl <String>] [-LogoutUrl <String>] [-Note <String>] + [-NotificationEmailAddress <String[]>] [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>] + [-PreferredSingleSignOnMode <String>] [-PreferredTokenSigningKeyThumbprint <String>] + [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>] [-ServicePrincipalName <String[]>] + [-ServicePrincipalType <String>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] + [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DisplayNameWithPasswordCredentialParameterSet +``` +New-AzADServicePrincipal -DisplayName <String> [-Role <String>] [-Scope <String>] [-Homepage <String>] + [-ReplyUrl <String[]>] [-AccountEnabled] [-AddIn <IMicrosoftGraphAddIn[]>] [-AlternativeName <String[]>] + [-AppDescription <String>] [-AppOwnerOrganizationId <String>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>] + [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>] [-AppRoleAssignmentRequired] + [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>] + [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>] + [-DeletedDateTime <DateTime>] [-Description <String>] [-DisabledByMicrosoftStatus <String>] + [-Endpoint <IMicrosoftGraphEndpoint[]>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-LoginUrl <String>] [-LogoutUrl <String>] [-Note <String>] + [-NotificationEmailAddress <String[]>] [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>] + [-PreferredSingleSignOnMode <String>] [-PreferredTokenSigningKeyThumbprint <String>] + [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>] [-ServicePrincipalName <String[]>] + [-ServicePrincipalType <String>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] + [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>] + -PasswordCredential <IMicrosoftGraphPasswordCredential[]> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DisplayNameWithKeyCredentialParameterSet +``` +New-AzADServicePrincipal -DisplayName <String> [-Role <String>] [-Scope <String>] [-Homepage <String>] + [-ReplyUrl <String[]>] [-AccountEnabled] [-AddIn <IMicrosoftGraphAddIn[]>] [-AlternativeName <String[]>] + [-AppDescription <String>] [-AppOwnerOrganizationId <String>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>] + [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>] [-AppRoleAssignmentRequired] + [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>] + [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>] + [-DeletedDateTime <DateTime>] [-Description <String>] [-DisabledByMicrosoftStatus <String>] + [-Endpoint <IMicrosoftGraphEndpoint[]>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-LoginUrl <String>] [-LogoutUrl <String>] [-Note <String>] + [-NotificationEmailAddress <String[]>] [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>] + [-PreferredSingleSignOnMode <String>] [-PreferredTokenSigningKeyThumbprint <String>] + [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>] [-ServicePrincipalName <String[]>] + [-ServicePrincipalType <String>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] + [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>] -KeyCredential <IMicrosoftGraphKeyCredential[]> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DisplayNameWithKeyPlainParameterSet +``` +New-AzADServicePrincipal -DisplayName <String> [-Role <String>] [-Scope <String>] [-Homepage <String>] + [-ReplyUrl <String[]>] [-StartDate <DateTime>] [-EndDate <DateTime>] [-AccountEnabled] + [-AddIn <IMicrosoftGraphAddIn[]>] [-AlternativeName <String[]>] [-AppDescription <String>] + [-AppOwnerOrganizationId <String>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>] + [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>] [-AppRoleAssignmentRequired] + [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>] + [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>] + [-DeletedDateTime <DateTime>] [-Description <String>] [-DisabledByMicrosoftStatus <String>] + [-Endpoint <IMicrosoftGraphEndpoint[]>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-LoginUrl <String>] [-LogoutUrl <String>] [-Note <String>] + [-NotificationEmailAddress <String[]>] [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>] + [-PreferredSingleSignOnMode <String>] [-PreferredTokenSigningKeyThumbprint <String>] + [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>] [-ServicePrincipalName <String[]>] + [-ServicePrincipalType <String>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] + [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>] -CertValue <String> [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationObjectParameterSet +``` +New-AzADServicePrincipal [-Role <String>] [-Scope <String>] [-Homepage <String>] [-ReplyUrl <String[]>] + [-AccountEnabled] [-AddIn <IMicrosoftGraphAddIn[]>] [-AlternativeName <String[]>] [-AppDescription <String>] + [-AppOwnerOrganizationId <String>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>] + [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>] [-AppRoleAssignmentRequired] + [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>] + [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>] + [-DeletedDateTime <DateTime>] [-Description <String>] [-DisabledByMicrosoftStatus <String>] + [-Endpoint <IMicrosoftGraphEndpoint[]>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-LoginUrl <String>] [-LogoutUrl <String>] [-Note <String>] + [-NotificationEmailAddress <String[]>] [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>] + [-PreferredSingleSignOnMode <String>] [-PreferredTokenSigningKeyThumbprint <String>] + [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>] [-ServicePrincipalName <String[]>] + [-ServicePrincipalType <String>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] + [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>] -ApplicationObject <IMicrosoftGraphApplication> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationIdParameterSet +``` +New-AzADServicePrincipal [-Role <String>] [-Scope <String>] [-Homepage <String>] [-ReplyUrl <String[]>] + [-AccountEnabled] [-AddIn <IMicrosoftGraphAddIn[]>] [-AlternativeName <String[]>] [-AppDescription <String>] + [-AppOwnerOrganizationId <String>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>] + [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>] [-AppRoleAssignmentRequired] + [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>] + [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>] + [-DeletedDateTime <DateTime>] [-Description <String>] [-DisabledByMicrosoftStatus <String>] + [-Endpoint <IMicrosoftGraphEndpoint[]>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-LoginUrl <String>] [-LogoutUrl <String>] [-Note <String>] + [-NotificationEmailAddress <String[]>] [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>] + [-PreferredSingleSignOnMode <String>] [-PreferredTokenSigningKeyThumbprint <String>] + [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>] [-ServicePrincipalName <String[]>] + [-ServicePrincipalType <String>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] + [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>] [-ApplicationId <Guid>] [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Adds new entity to servicePrincipals + +## EXAMPLES + +### Example 1: Create service principal without application or display name +```powershell +New-AzADServicePrincipal +``` + +Create application with display name "azure-powershell-MM-dd-yyyy-HH-mm-ss" and new service principal associate with it + +### Example 2: Create service principal with existing application +```powershell +New-AzADServicePrincipal -ApplicationId $appid +``` + +Create service principal with existing application + +### Example 3: Create application with display name and associated new service principal with it +```powershell +New-AzADServicePrincipal -DisplayName $name +``` + +Create application with display name and associated new service pincipal with it + +## PARAMETERS + +### -AccountEnabled +true if the service principal account is enabled; otherwise, false. +Supports $filter (eq, ne, NOT, in). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddIn +Defines custom behavior that a consuming service can use to call an app in specific contexts. +For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. +This will let services like Microsoft 365 call the application in the context of a document the user is working on. +To construct, see NOTES section for ADDIN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAddIn[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlternativeName +Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. +Supports $filter (eq, NOT, ge, le, startsWith). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppDescription +The description exposed by the associated application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +The unique identifier for the associated application (its appId property). + +```yaml +Type: System.Guid +Parameter Sets: ApplicationIdParameterSet +Aliases: AppId + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationObject +The application object, could be used as pipeline input. +To construct, see NOTES section for APPLICATIONOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication +Parameter Sets: ApplicationObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AppOwnerOrganizationId +Contains the tenant id where the application is registered. +This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppRole +The roles exposed by the application which this service principal represents. +For more information see the appRoles property definition on the application entity. +Not nullable. +To construct, see NOTES section for APPROLE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAppRole[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppRoleAssignedTo +App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. +To construct, see NOTES section for APPROLEASSIGNEDTO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAppRoleAssignment[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppRoleAssignment +App role assignment for another app or service, granted to this service principal. +Supports $expand. +To construct, see NOTES section for APPROLEASSIGNMENT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAppRoleAssignment[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppRoleAssignmentRequired +Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. +The default value is false. +Not nullable. +Supports $filter (eq, ne, NOT). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertValue +The value of the 'asymmetric' credential type. +It represents the base 64 encoded certificate. + +```yaml +Type: System.String +Parameter Sets: DisplayNameWithKeyPlainParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClaimsMappingPolicy +The claimsMappingPolicies assigned to this service principal. +Supports $expand. +To construct, see NOTES section for CLAIMSMAPPINGPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphClaimsMappingPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelegatedPermissionClassification +The permission classifications for delegated permissions exposed by the app that this service principal represents. +Supports $expand. +To construct, see NOTES section for DELEGATEDPERMISSIONCLASSIFICATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphDelegatedPermissionClassification[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedDateTime +. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Free text field to provide an internal end-user facing description of the service principal. +End-user portals such MyApps will display the application description in this field. +The maximum allowed size is 1024 characters. +Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledByMicrosoftStatus +Specifies whether Microsoft has disabled the registered application. +Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). +Supports $filter (eq, ne, NOT). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name for the service principal. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and $orderBy. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: DisplayNameWithPasswordCredentialParameterSet, DisplayNameWithKeyCredentialParameterSet, DisplayNameWithKeyPlainParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The effective end date of the credential usage. +The default end date value is one year from today. +For an 'asymmetric' type credential, this must be set to on or before the date that the X509 certificate is valid. + +```yaml +Type: System.DateTime +Parameter Sets: SimpleParameterSet, DisplayNameWithKeyPlainParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +Endpoints available for discovery. +Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. +To construct, see NOTES section for ENDPOINT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphEndpoint[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Homepage +Home page or landing page of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HomeRealmDiscoveryPolicy +The homeRealmDiscoveryPolicies assigned to this service principal. +Supports $expand. +To construct, see NOTES section for HOMEREALMDISCOVERYPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphHomeRealmDiscoveryPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Info +informationalUrl +To construct, see NOTES section for INFO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphInformationalUrl +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyCredential +key credentials associated with the service principal. +To construct, see NOTES section for KEYCREDENTIAL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphKeyCredential[] +Parameter Sets: DisplayNameWithKeyCredentialParameterSet +Aliases: KeyCredentials + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoginUrl +Specifies the URL where the service provider redirects the user to Azure AD to authenticate. +Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. +When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. +The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogoutUrl +Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +Free text field to capture information about the service principal, typically used for operational purposes. +Maximum allowed size is 1024 characters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEmailAddress +Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. +This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Oauth2PermissionScope +The delegated permissions exposed by the application. +For more information see the oauth2PermissionScopes property on the application entity's api property. +Not nullable. +To construct, see NOTES section for OAUTH2PERMISSIONSCOPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPermissionScope[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordCredential +Password credentials associated with the service principal. +To construct, see NOTES section for PASSWORDCREDENTIAL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordCredential[] +Parameter Sets: DisplayNameWithPasswordCredentialParameterSet +Aliases: PasswordCredentials + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredSingleSignOnMode +Specifies the single sign-on mode configured for this application. +Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. +The supported values are password, saml, notSupported, and oidc. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredTokenSigningKeyThumbprint +Reserved for internal use only. +Do not write or otherwise rely on this property. +May be removed in future versions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyUrl +The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. +Not nullable. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The role that the service principal has over the scope. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamlSingleSignOnSetting +samlSingleSignOnSettings +To construct, see NOTES section for SAMLSINGLESIGNONSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphSamlSingleSignOnSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope that the service principal has permissions for. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalName +Contains the list of identifiersUris, copied over from the associated application. +Additional values can be added to hybrid applications. +These values can be used to identify the permissions exposed by this app within Azure AD. +For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. +Not nullable. +Supports $filter (eq, NOT, ge, le, startsWith). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalType +Identifies if the service principal represents an application or a managed identity. +This is set by Azure AD internally. +For a service principal that represents an application this is set as Application. +For a service principal that represent a managed identity this is set as ManagedIdentity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The effective start date of the credential usage. +The default start date value is today. +For an 'asymmetric' type credential, this must be set to on or after the date that the X509 certificate is valid from. + +```yaml +Type: System.DateTime +Parameter Sets: SimpleParameterSet, DisplayNameWithKeyPlainParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Custom strings that can be used to categorize and identify the service principal. +Not nullable. +Supports $filter (eq, NOT, ge, le, startsWith). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenEncryptionKeyId +Specifies the keyId of a public key from the keyCredentials collection. +When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. +The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenIssuancePolicy +The tokenIssuancePolicies assigned to this service principal. +Supports $expand. +To construct, see NOTES section for TOKENISSUANCEPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphTokenIssuancePolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenLifetimePolicy +The tokenLifetimePolicies assigned to this service principal. +Supports $expand. +To construct, see NOTES section for TOKENLIFETIMEPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphTokenLifetimePolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransitiveMemberOf +. +To construct, see NOTES section for TRANSITIVEMEMBEROF properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphDirectoryObject[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal + +## 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. + + +ADDIN <IMicrosoftGraphAddIn[]>: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + +APPLICATIONOBJECT <IMicrosoftGraphApplication>: The application object, could be used as pipeline input. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + +APPROLE <IMicrosoftGraphAppRole[]>: The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + +APPROLEASSIGNEDTO <IMicrosoftGraphAppRoleAssignment[]>: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + +APPROLEASSIGNMENT <IMicrosoftGraphAppRoleAssignment[]>: App role assignment for another app or service, granted to this service principal. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + +CLAIMSMAPPINGPOLICY <IMicrosoftGraphClaimsMappingPolicy[]>: The claimsMappingPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +DELEGATEDPERMISSIONCLASSIFICATION <IMicrosoftGraphDelegatedPermissionClassification[]>: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. + - `[Classification <String>]`: permissionClassificationType + - `[PermissionId <String>]`: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter. + - `[PermissionName <String>]`: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Does not support $filter. + +ENDPOINT <IMicrosoftGraphEndpoint[]>: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +HOMEREALMDISCOVERYPOLICY <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +INFO <IMicrosoftGraphInformationalUrl>: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + +KEYCREDENTIAL <IMicrosoftGraphKeyCredential[]>: key credentials associated with the service principal. + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + +OAUTH2PERMISSIONSCOPE <IMicrosoftGraphPermissionScope[]>: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + +PASSWORDCREDENTIAL <IMicrosoftGraphPasswordCredential[]>: Password credentials associated with the service principal. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + +SAMLSINGLESIGNONSETTING <IMicrosoftGraphSamlSingleSignOnSettings>: samlSingleSignOnSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RelayState <String>]`: The relative URI the service provider would redirect to after completion of the single sign-on flow. + +TOKENISSUANCEPOLICY <IMicrosoftGraphTokenIssuancePolicy[]>: The tokenIssuancePolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +TOKENLIFETIMEPOLICY <IMicrosoftGraphTokenLifetimePolicy[]>: The tokenLifetimePolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +TRANSITIVEMEMBEROF <IMicrosoftGraphDirectoryObject[]>: . + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzADSpCredential.md b/azps-10.1.0/Az.Resources/New-AzADSpCredential.md new file mode 100644 index 0000000000..5862c9274d --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzADSpCredential.md @@ -0,0 +1,606 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azadspcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADSpCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADSpCredential.md +--- + +# New-AzADSpCredential + +## SYNOPSIS +Creates key credentials or password credentials for an service principal. + +## SYNTAX + +### SpObjectIdWithPasswordParameterSet (Default) +``` +New-AzADSpCredential -ObjectId <String> [-StartDate <DateTime>] [-EndDate <DateTime>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SpObjectIdWithCertValueParameterSet +``` +New-AzADSpCredential -ObjectId <String> [-StartDate <DateTime>] [-EndDate <DateTime>] -CertValue <String> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SpObjectIdWithKeyCredentialParameterSet +``` +New-AzADSpCredential -ObjectId <String> -KeyCredentials <MicrosoftGraphKeyCredential[]> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SpObjectIdWithPasswordCredentialParameterSet +``` +New-AzADSpCredential -ObjectId <String> -PasswordCredentials <MicrosoftGraphPasswordCredential[]> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ServicePrincipalObjectWithCertValueParameterSet +``` +New-AzADSpCredential [-StartDate <DateTime>] [-EndDate <DateTime>] -CertValue <String> + -ServicePrincipalObject <IMicrosoftGraphServicePrincipal> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ServicePrincipalObjectWithPasswordParameterSet +``` +New-AzADSpCredential [-StartDate <DateTime>] [-EndDate <DateTime>] + -ServicePrincipalObject <IMicrosoftGraphServicePrincipal> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SPNWithCertValueParameterSet +``` +New-AzADSpCredential [-StartDate <DateTime>] [-EndDate <DateTime>] -CertValue <String> + -ServicePrincipalName <String> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SPNWithPasswordParameterSet +``` +New-AzADSpCredential [-StartDate <DateTime>] [-EndDate <DateTime>] -ServicePrincipalName <String> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ServicePrincipalObjectWithPasswordCredentialParameterSet +``` +New-AzADSpCredential -PasswordCredentials <MicrosoftGraphPasswordCredential[]> + -ServicePrincipalObject <IMicrosoftGraphServicePrincipal> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SPNWithPasswordCredentialParameterSet +``` +New-AzADSpCredential -PasswordCredentials <MicrosoftGraphPasswordCredential[]> -ServicePrincipalName <String> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ServicePrincipalObjectWithKeyCredentialParameterSet +``` +New-AzADSpCredential -KeyCredentials <MicrosoftGraphKeyCredential[]> + -ServicePrincipalObject <IMicrosoftGraphServicePrincipal> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SPNWithKeyCredentialParameterSet +``` +New-AzADSpCredential -KeyCredentials <MicrosoftGraphKeyCredential[]> -ServicePrincipalName <String> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates key credentials or password credentials for an service principal. + +## EXAMPLES + +### Example 1: Create key credentials for service principal +```powershell +$credential = New-Object -TypeName "Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphKeyCredential" ` + -Property @{'Key' = $cert; + 'Usage' = 'Verify'; + 'Type' = 'AsymmetricX509Cert' + } +New-AzADSpCredential -ObjectId $Id -KeyCredentials $credential +``` + +Create key credentials for service principal + +### Example 2: Create password credentials for service principal +```powershell +Get-AzADServicePrincipal -ApplicationId $appId | New-AzADSpCredential -StartDate $startDate -EndDate $endDate +``` + +Create password credentials for service principal + +## PARAMETERS + +### -CertValue +The value of the 'asymmetric' credential type. +It represents the base 64 encoded certificate. + +```yaml +Type: System.String +Parameter Sets: SpObjectIdWithCertValueParameterSet, ServicePrincipalObjectWithCertValueParameterSet, SPNWithCertValueParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The effective end date of the credential usage. +The default end date value is one year from today. +For an 'asymmetric' type credential, this must be set to on or before the date that the X509 certificate is valid. + +```yaml +Type: System.DateTime +Parameter Sets: SpObjectIdWithPasswordParameterSet, SpObjectIdWithCertValueParameterSet, ServicePrincipalObjectWithCertValueParameterSet, ServicePrincipalObjectWithPasswordParameterSet, SPNWithCertValueParameterSet, SPNWithPasswordParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyCredentials +key credentials associated with the service principal. +To construct, see NOTES section for KEYCREDENTIALS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphKeyCredential[] +Parameter Sets: SpObjectIdWithKeyCredentialParameterSet, ServicePrincipalObjectWithKeyCredentialParameterSet, SPNWithKeyCredentialParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The object Id of application. + +```yaml +Type: System.String +Parameter Sets: SpObjectIdWithPasswordParameterSet, SpObjectIdWithCertValueParameterSet, SpObjectIdWithKeyCredentialParameterSet, SpObjectIdWithPasswordCredentialParameterSet +Aliases: Id, ServicePrincipalObjectId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordCredentials +Password credentials associated with the service principal. +To construct, see NOTES section for PASSWORDCREDENTIALS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphPasswordCredential[] +Parameter Sets: SpObjectIdWithPasswordCredentialParameterSet, ServicePrincipalObjectWithPasswordCredentialParameterSet, SPNWithPasswordCredentialParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalName +The service principal name. + +```yaml +Type: System.String +Parameter Sets: SPNWithCertValueParameterSet, SPNWithPasswordParameterSet, SPNWithPasswordCredentialParameterSet, SPNWithKeyCredentialParameterSet +Aliases: SPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalObject +The service principal object, could be used as pipeline input. +To construct, see NOTES section for SERVICEPRINCIPALOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal +Parameter Sets: ServicePrincipalObjectWithCertValueParameterSet, ServicePrincipalObjectWithPasswordParameterSet, ServicePrincipalObjectWithPasswordCredentialParameterSet, ServicePrincipalObjectWithKeyCredentialParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StartDate +The effective start date of the credential usage. +The default start date value is today. +For an 'asymmetric' type credential, this must be set to on or after the date that the X509 certificate is valid from. + +```yaml +Type: System.DateTime +Parameter Sets: SpObjectIdWithPasswordParameterSet, SpObjectIdWithCertValueParameterSet, ServicePrincipalObjectWithCertValueParameterSet, ServicePrincipalObjectWithPasswordParameterSet, SPNWithCertValueParameterSet, SPNWithPasswordParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphKeyCredential + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordCredential + +## NOTES + +ALIASES + +New-AzADServicePrincipalCredential + +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. + + +KEYCREDENTIALS <MicrosoftGraphKeyCredential[]>: key credentials associated with the service principal. + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + +PASSWORDCREDENTIALS <MicrosoftGraphPasswordCredential[]>: Password credentials associated with the service principal. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + +SERVICEPRINCIPALOBJECT <IMicrosoftGraphServicePrincipal>: The service principal object, could be used as pipeline input. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AccountEnabled <Boolean?>]`: true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in). + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[AlternativeName <String[]>]`: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, NOT, ge, le, startsWith). + - `[AppDescription <String>]`: The description exposed by the associated application. + - `[AppDisplayName <String>]`: The display name exposed by the associated application. + - `[AppId <String>]`: The unique identifier for the associated application (its appId property). + - `[AppOwnerOrganizationId <String>]`: Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le). + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignment for another app or service, granted to this service principal. Supports $expand. + - `[AppRoleAssignmentRequired <Boolean?>]`: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT). + - `[ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]`: The claimsMappingPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]`: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. + - `[Classification <String>]`: permissionClassificationType + - `[PermissionId <String>]`: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter. + - `[PermissionName <String>]`: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Does not support $filter. + - `[Description <String>]`: Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[Endpoint <IMicrosoftGraphEndpoint[]>]`: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. + - `[Homepage <String>]`: Home page or landing page of the application. + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[LoginUrl <String>]`: Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. + - `[Note <String>]`: Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters. + - `[NotificationEmailAddress <String[]>]`: Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the service principal. Not nullable. + - `[PreferredSingleSignOnMode <String>]`: Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc. + - `[PreferredTokenSigningKeyThumbprint <String>]`: Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions. + - `[ReplyUrl <String[]>]`: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. + - `[SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]`: samlSingleSignOnSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RelayState <String>]`: The relative URI the service provider would redirect to after completion of the single sign-on flow. + - `[ServicePrincipalName <String[]>]`: Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[ServicePrincipalType <String>]`: Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: The tokenIssuancePolicies assigned to this service principal. Supports $expand. + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this service principal. Supports $expand. + - `[TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]`: + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzADUser.md b/azps-10.1.0/Az.Resources/New-AzADUser.md new file mode 100644 index 0000000000..bd639b06f3 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzADUser.md @@ -0,0 +1,940 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azaduser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzADUser.md +--- + +# New-AzADUser + +## SYNOPSIS +Adds new entity to users + +## SYNTAX + +### WithPassword (Default) +``` +New-AzADUser -DisplayName <String> -MailNickname <String> -UserPrincipalName <String> -Password <SecureString> + [-AboutMe <String>] [-AccountEnabled <Boolean>] [-AgeGroup <String>] [-Birthday <DateTime>] [-City <String>] + [-CompanyName <String>] [-ConsentProvidedForMinor <String>] [-Country <String>] [-DeletedDateTime <DateTime>] + [-Department <String>] [-DeviceEnrollmentLimit <Int32>] [-EmployeeHireDate <DateTime>] [-EmployeeId <String>] + [-EmployeeType <String>] [-ExternalUserState <String>] [-ExternalUserStateChangeDateTime <DateTime>] + [-FaxNumber <String>] [-GivenName <String>] [-HireDate <DateTime>] [-Interest <String[]>] [-IsResourceAccount] + [-JobTitle <String>] [-Mail <String>] [-MobilePhone <String>] [-MySite <String>] [-OfficeLocation <String>] + [-ImmutableId <String>] [-OtherMail <String[]>] [-PasswordPolicy <String>] [-PostalCode <String>] + [-PreferredLanguage <String>] [-PreferredName <String>] [-Responsibility <String[]>] [-School <String[]>] + [-ShowInAddressList] [-Skill <String[]>] [-State <String>] [-StreetAddress <String>] [-Surname <String>] + [-UsageLocation <String>] [-UserType <String>] [-ForceChangePasswordNextLogin] [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WithPasswordProfile +``` +New-AzADUser -DisplayName <String> -MailNickname <String> -UserPrincipalName <String> [-AboutMe <String>] + [-AccountEnabled <Boolean>] [-AgeGroup <String>] [-Birthday <DateTime>] [-City <String>] + [-CompanyName <String>] [-ConsentProvidedForMinor <String>] [-Country <String>] [-DeletedDateTime <DateTime>] + [-Department <String>] [-DeviceEnrollmentLimit <Int32>] [-EmployeeHireDate <DateTime>] [-EmployeeId <String>] + [-EmployeeType <String>] [-ExternalUserState <String>] [-ExternalUserStateChangeDateTime <DateTime>] + [-FaxNumber <String>] [-GivenName <String>] [-HireDate <DateTime>] [-Interest <String[]>] [-IsResourceAccount] + [-JobTitle <String>] [-Mail <String>] [-MobilePhone <String>] [-MySite <String>] [-OfficeLocation <String>] + [-ImmutableId <String>] [-OtherMail <String[]>] [-PasswordPolicy <String>] [-PostalCode <String>] + [-PreferredLanguage <String>] [-PreferredName <String>] [-Responsibility <String[]>] [-School <String[]>] + [-ShowInAddressList] [-Skill <String[]>] [-State <String>] [-StreetAddress <String>] [-Surname <String>] + [-UsageLocation <String>] [-UserType <String>] -PasswordProfile <IMicrosoftGraphPasswordProfile> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Adds new entity to users + +## EXAMPLES + +### Example 1: Create user with password profile +```powershell +$password = "xxxxxxxxxx" +$pp = New-Object -TypeName "Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordProfile" -Property @{Password=$password} +New-AzADUser -DisplayName $uname -PasswordProfile $pp -AccountEnabled $true -MailNickname $nickname -UserPrincipalName $upn +``` + +Create user with password profile + +### Example 2: Create user with password +```powershell +$password = "xxxxxxxxxx" +$password = ConvertTo-SecureString -AsPlainText -Force $password +New-AzADUser -DisplayName $uname -Password $password -AccountEnabled $true -MailNickname $nickname -UserPrincipalName $upn +``` + +Create user with password + +## PARAMETERS + +### -AboutMe +A freeform text entry field for the user to describe themselves. +Returned only on $select. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountEnabled +true for enabling the account; otherwise, false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: EnableAccount + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgeGroup +Sets the age group of the user. +Allowed values: null, minor, notAdult and adult. +Refer to the legal age group property definitions for further information. +Supports $filter (eq, ne, NOT, and in). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Birthday +The birthday of the user. +The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. +For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Returned only on $select. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -City +The city in which the user is located. +Maximum length is 128 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +The company name which the user is associated. +This property can be useful for describing the company that an external user comes from. +The maximum length of the company name is 64 characters.Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsentProvidedForMinor +Sets whether consent has been obtained for minors. +Allowed values: null, granted, denied and notRequired. +Refer to the legal age group property definitions for further information. +Supports $filter (eq, ne, NOT, and in). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Country +The country/region in which the user is located; for example, US or UK. +Maximum length is 128 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedDateTime +. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Department +The name for the department in which the user works. +Maximum length is 64 characters.Supports $filter (eq, ne, NOT , ge, le, and in operators). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceEnrollmentLimit +The limit on the maximum number of devices that the user is permitted to enroll. +Allowed values are 5 or 1000. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The name displayed in the address book for the user. +This value is usually the combination of the user's first name, middle initial, and last name. +This property is required when a user is created and it cannot be cleared during updates. +Maximum length is 256 characters. +Supports $filter (eq, ne, NOT , ge, le, in, startsWith), $orderBy, and $search. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmployeeHireDate +The date and time when the user was hired or will start work in case of a future hire. +Supports $filter (eq, ne, NOT , ge, le, in). + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmployeeId +The employee identifier assigned to the user by the organization. +Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmployeeType +Captures enterprise worker type. +For example, Employee, Contractor, Consultant, or Vendor. +Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalUserState +For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. +For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. +Supports $filter (eq, ne, NOT , in). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalUserStateChangeDateTime +Shows the timestamp for the latest change to the externalUserState property. +Supports $filter (eq, ne, NOT , in). + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FaxNumber +The fax number of the user. +Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceChangePasswordNextLogin +It must be specified if the user must change the password on the next successful login (true). +Default behavior is (false) to not change the password on the next successful login. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WithPassword +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GivenName +The given name (first name) of the user. +Maximum length is 64 characters. +Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HireDate +The hire date of the user. +The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. +For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. +Returned only on $select. +Note: This property is specific to SharePoint Online. +We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutableId +This property is used to associate an on-premises Active Directory user account to their Azure AD user object. +This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's userPrincipalName (UPN) property. +NOTE: The $ and _ characters cannot be used when specifying this property. +Returned only on $select. +Supports $filter (eq, ne, NOT, ge, le, in).. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: OnPremisesImmutableId + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Interest +A list for the user to describe their interests. +Returned only on $select. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsResourceAccount +Do not use - reserved for future use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobTitle +The user's job title. +Maximum length is 128 characters. +Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mail +The SMTP address for the user, for example, admin@contoso.com. +Changes to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. +While this property can contain accent characters, using them can cause access issues with other Microsoft applications for the user. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailNickname +The mail alias for the user. +This property must be specified when a user is created. +Maximum length is 64 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobilePhone +The primary cellular telephone number for the user. +Read-only for users synced from on-premises directory. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MySite +The URL for the user's personal site. +Returned only on $select. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfficeLocation +The office location in the user's place of business. +Maximum length is 128 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OtherMail +A list of additional email addresses for the user; for example: ['bob@contoso.com', 'Robert@fabrikam.com'].NOTE: While this property can contain accent characters, they can cause access issues to first-party applications for the user.Supports $filter (eq, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Password for the user. +It must meet the tenant's password complexity requirements. +It is recommended to set a strong password. + +```yaml +Type: System.Security.SecureString +Parameter Sets: WithPassword +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordPolicy +Specifies password policies for the user. +This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. +DisablePasswordExpiration can also be specified. +The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.Supports $filter (ne, NOT). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordProfile +passwordProfile +To construct, see NOTES section for PASSWORDPROFILE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordProfile +Parameter Sets: WithPasswordProfile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostalCode +The postal code for the user's postal address. +The postal code is specific to the user's country/region. +In the United States of America, this attribute contains the ZIP code. +Maximum length is 40 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredLanguage +The preferred language for the user. +Should follow ISO 639-1 Code; for example en-US. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredName +The preferred name for the user. +Returned only on $select. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Responsibility +A list for the user to enumerate their responsibilities. +Returned only on $select. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -School +A list for the user to enumerate the schools they have attended. +Returned only on $select. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowInAddressList +true if the Outlook global address list should contain this user, otherwise false. +If not set, this will be treated as true. +For users invited through the invitation manager, this property will be set to false. +Supports $filter (eq, ne, NOT, in). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skill +A list for the user to enumerate their skills. +Returned only on $select. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The state or province in the user's address. +Maximum length is 128 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreetAddress +The street address of the user's place of business. +Maximum length is 1024 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Surname +The user's surname (family name or last name). +Maximum length is 64 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsageLocation +A two letter country code (ISO standard 3166). +Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. +Examples include: US, JP, and GB. +Not nullable. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +The user principal name (UPN) of the user. +The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. +By convention, this should map to the user's email name. +The general format is alias@domain, where domain must be present in the tenant's collection of verified domains. +This property is required when a user is created. +The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: While this property can contain accent characters, they can cause access issues to first-party applications for the user. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith) and $orderBy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserType +A string value that can be used to classify user types in your directory, such as Member and Guest. +Supports $filter (eq, ne, NOT, in,). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphUser + +## 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. + + +PASSWORDPROFILE <IMicrosoftGraphPasswordProfile>: passwordProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ForceChangePasswordNextSignIn <Boolean?>]`: true if the user must change her password on the next login; otherwise false. If not set, default is false. NOTE: For Azure B2C tenants, set to false and instead use custom policies and user flows to force password reset at first sign in. See Force password reset at first logon. + - `[ForceChangePasswordNextSignInWithMfa <Boolean?>]`: If true, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false. + - `[Password <String>]`: The password for the user. This property is required when a user is created. It can be updated, but the user will be required to change the password on the next login. The password must satisfy minimum requirements as specified by the user's passwordPolicies property. By default, a strong password is required. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzDeployment.md b/azps-10.1.0/Az.Resources/New-AzDeployment.md new file mode 100644 index 0000000000..1c599aaf06 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzDeployment.md @@ -0,0 +1,537 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzDeployment.md +--- + +# New-AzDeployment + +## SYNOPSIS +Create a deployment at the current subscription scope. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterObject +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateParameterObject <Hashtable> -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterObject +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateParameterObject <Hashtable> -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterObject +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateParameterObject <Hashtable> -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateParameterObject <Hashtable> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterFile +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateParameterFile <String> -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterFile +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateParameterFile <String> -TemplateFile <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterFile +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateParameterFile <String> -TemplateUri <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParams +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateParameterFile <String> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterUri +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateParameterUri <String> -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterUri +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateParameterUri <String> -TemplateFile <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterUri +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateParameterUri <String> -TemplateUri <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsUri +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateParameterUri <String> -TemplateSpecId <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateObjectWithNoParameters +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecResourceId +``` +New-AzDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] + [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] + [-QueryString <String>] -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDeployment** cmdlet adds a deployment at the current subscription scope. +This includes the resources that the deployment requires. + +An Azure resource is a user-managed Azure entity. A resource can live in a resource group, like database server, database, website, virtual machine, or Storage account. +Or, it can be a subscription level resource, like role definition, policy definition, etc. + +To add resources to a resource group, use the **New-AzResourceGroupDeployment** which creates a deployment at a resource group. +The **New-AzDeployment** cmdlet creates a deployment at the current subscription scope, which deploys subscription level resources. + +To add a deployment at subscription, specify the location and a template. +The location tells Azure Resource Manager where to store the deployment data. The template is a JSON string that contains individual resources to be deployed. +The template includes parameter placeholders for required resources and configurable property values, such as names and sizes. + +To use a custom template for the deployment, specify the *TemplateFile* parameter or *TemplateUri* parameter. +Each template has parameters for configurable properties. +To specify values for the template parameters, specify the *TemplateParameterFile* parameter or the *TemplateParameterObject* parameter. +Alternatively, you can use the template parameters that are dynamically added to the command when you specify a template. +To use dynamic parameters, type them at the command prompt, or type a minus sign (-) to indicate a parameter and use the Tab key to cycle through available parameters. +Template parameter values that you enter at the command prompt take precedence over values in a template parameter object or file. + +## EXAMPLES + +### Example 1: Use a custom template and parameter file to create a deployment +```powershell +New-AzDeployment -Location "West US" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json" -Tag @{"key1"="value1"; "key2"="value2";} +``` + +This command creates a new deployment at the current subscription scope by using a custom template and a template file on disk, with defined tags parameter. +The command uses the *TemplateFile* parameter to specify the template and the *TemplateParameterFile* parameter to specify a file that contains parameters and parameter values. + +### Example 2: Deploy a template stored in a non public storage account using a uri and SAS token +```powershell +New-AzDeployment -Location "West US" -TemplateUri "https://example.com/example.json" -QueryString "foo" +``` + +This command creates a new deployment using the template in TemplateUri which is not public and requires a token parameter to access which would be provided using the QueryString parameter. +Running this command effectively accesses the template using the url `https://example.com/example.json?foo`. +This can be used if you want to use a template in a storage account by providing the SAS token as the QueryString + +### Example 3: Use a custom template object and parameter file to create a deployment +```powershell +$TemplateFileText = [System.IO.File]::ReadAllText("D:\Azure\Templates\EngineeringSite.json") +$TemplateObject = ConvertFrom-Json $TemplateFileText -AsHashtable +New-AzDeployment -Location "West US" -TemplateObject $TemplateObject -TemplateParameterFile "D:\Azure\Templates\EngSiteParams.json" +``` + +This command creates a new deployment at the current subscription scope by using a custom template and a template file on disk that has been converted to an in-memory hashtable. +The first two commands read the text for the template file on disk and convert it to an in-memory hashtable. +The last command uses the *TemplateObject* parameter to specify this hashtable and the *TemplateParameterFile* parameter to specify a file that contains parameters and parameter values. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentDebugLogLevel +The deployment debug log level. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location to store deployment data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. "20131223140835". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProceedIfNoChange +Do not ask for confirmation if there is no changes in the What-If result. Applicable when the -Confirm switch is set. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to put on the deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +Local path to the template file. Supported template file type: json and bicep. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateObject +A hash table which represents the template. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateObjectAndParameterFile, ByTemplateObjectAndParameterUri, ByTemplateObjectWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +A file that has the template parameters. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterFile, ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile, ByTemplateSpecResourceIdAndParams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Uri to the template parameter file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterUri, ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri, ByTemplateSpecResourceIdAndParamsUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +Resource ID of the templateSpec to be deployed. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Uri to the template file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIfExcludeChangeType +Comma-separated resource change types to be excluded from What-If results. Applicable when the -WhatIf or -Confirm switch is set. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIfResultFormat +The What-If result format. + +```yaml +Type: Microsoft.Azure.Management.ResourceManager.Models.WhatIfResultFormat +Parameter Sets: (All) +Aliases: +Accepted values: ResourceIdOnly, FullResourcePayloads + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Hashtable + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzManagedApplication.md b/azps-10.1.0/Az.Resources/New-AzManagedApplication.md new file mode 100644 index 0000000000..08b44e1051 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzManagedApplication.md @@ -0,0 +1,268 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azmanagedapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagedApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagedApplication.md +--- + +# New-AzManagedApplication + +## SYNOPSIS +Creates an Azure managed application. + +## SYNTAX + +``` +New-AzManagedApplication -Name <String> -ResourceGroupName <String> -ManagedResourceGroupName <String> + [-ManagedApplicationDefinitionId <String>] -Location <String> [-Parameter <String>] -Kind <ApplicationKind> + [-Plan <Hashtable>] [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzManagedApplication** cmdlet creates an Azure Managed Application. + +## EXAMPLES + +### Example 1 +```powershell +New-AzManagedApplication -Name "myManagedApplication" -ResourceGroupName myRG -ManagedResourceGroupName myManagedRG -ManagedApplicationDefinitionId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Solutions/applicationDefinitions/myAppDef" -Location eastus2euap -Kind ServiceCatalog +``` + +This command creates a managed application + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +The managed application kind. +One of marketplace or servicecatalog + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Application.ApplicationKind +Parameter Sets: (All) +Aliases: +Accepted values: ServiceCatalog, MarketPlace + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedApplicationDefinitionId +The managed resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagedResourceGroupName +The managed resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The managed application name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameter +The JSON formatted string of parameters for managed application. +This can either be a path to a file name or uri containing the parameters, or the parameters as string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Plan +A hash table which represents managed application plan properties. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: PlanObject + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzManagedApplicationDefinition.md b/azps-10.1.0/Az.Resources/New-AzManagedApplicationDefinition.md new file mode 100644 index 0000000000..e16b54f55e --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzManagedApplicationDefinition.md @@ -0,0 +1,302 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azmanagedapplicationdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagedApplicationDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagedApplicationDefinition.md +--- + +# New-AzManagedApplicationDefinition + +## SYNOPSIS +Creates a managed application definition. + +## SYNTAX + +``` +New-AzManagedApplicationDefinition -Name <String> -ResourceGroupName <String> -DisplayName <String> + -Description <String> -Location <String> -LockLevel <ApplicationLockLevel> [-PackageFileUri <String>] + [-CreateUiDefinition <String>] [-MainTemplate <String>] -Authorization <String[]> [-Tag <Hashtable>] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzManagedApplicationDefinition** cmdlet creates a managed application definition. + +## EXAMPLES + +### Example 1 +```powershell +New-AzManagedApplicationDefinition -Name myAppDef -ResourceGroupName myRG -DisplayName test -Description "sample description" -Location westus -LockLevel ReadOnly -PackageFileUri https://sample.blob.core.windows.net/files/myPackage.zip -Authorization <principalId:roleDefinitionId> +``` + +This command creates a managed application definition + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +The managed application definition authorization. +Comma separated authorization pairs in a format of \<principalId\>:\<roleDefinitionId\> + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CreateUiDefinition +The managed application definition create ui definition + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The managed application definition description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +The managed application definition display name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +The resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LockLevel +The level of the lock for managed application definition. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Application.ApplicationLockLevel +Parameter Sets: (All) +Aliases: Level +Accepted values: None, CanNotDelete, ReadOnly + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MainTemplate +The managed application definition main template + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The managed application definition name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PackageFileUri +The managed application definition package file uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hashtable which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Application.ApplicationLockLevel + +### System.String[] + +### System.Collections.Hashtable + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzManagementGroup.md b/azps-10.1.0/Az.Resources/New-AzManagementGroup.md new file mode 100644 index 0000000000..ca1d8f4af0 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzManagementGroup.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azmanagementgroup/ +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagementGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagementGroup.md +--- + +# New-AzManagementGroup + +## SYNOPSIS +Creates a Management Group + +## SYNTAX + +### GroupOperations (Default) +``` +New-AzManagementGroup [-GroupName] <String> [-DisplayName <String>] [-ParentId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentGroupObject +``` +New-AzManagementGroup [-GroupName] <String> [-DisplayName <String>] [-DefaultProfile <IAzureContextContainer>] + -ParentObject <PSManagementGroup> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzManagementGroup** cmdlet creates a management group with name **GroupName**. The **DisplayName** and **ParentId** can also be set when creating a new Management Group. + +## EXAMPLES + +### Example 1: Create a Management Group +```powershell +New-AzManagementGroup -GroupName "TestGroup" +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/TestGroup +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroup +TenantId : 14307de0-5e6f-46cf-b2ba-64a062964d30 +DisplayName : TestGroup +UpdatedTime : 2/1/2018 11:06:27 AM +UpdatedBy : 14307de0-5e6f-46cf-b2ba-64a062964d30 +ParentId : /providers/Microsoft.Management/managementGroups/14307de0-5e6f-46cf-b2ba-64a062964d30 +ParentName : 14307de0-5e6f-46cf-b2ba-64a062964d30 +ParentDisplayName : 14307de0-5e6f-46cf-b2ba-64a062964d30 +``` + +Creation of a new group with `DisplayName` and `ParentId` set to `null`. The `DisplayName` will be same as the `GroupName` and the parent of the group will be the tenant. + +### Example 2: Create a Management Group with a display name +```powershell +New-AzManagementGroup -GroupName "TestGroup" -DisplayName "TestGroupDisplayName" +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/TestGroup +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroup +TenantId : 14307de0-5e6f-46cf-b2ba-64a062964d30 +DisplayName : TestGroup +UpdatedTime : 2/1/2018 11:06:27 AM +UpdatedBy : 14307de0-5e6f-46cf-b2ba-64a062964d30 +ParentId : /providers/Microsoft.Management/managementGroups/14307de0-5e6f-46cf-b2ba-64a062964d30 +ParentName : 14307de0-5e6f-46cf-b2ba-64a062964d30 +ParentDisplayName : 14307de0-5e6f-46cf-b2ba-64a062964d30 +``` + +In this case, the parent of the group will be the tenant and the `DisplayName` will be set to the value given. + +### Example 3: Create a Management Group with a parent and a display name +```powershell +New-AzManagementGroup -GroupName "TestGroup" -DisplayName "TestGroupDisplayName" -ParentId "/providers/Microsoft.Management/managementGroups/TestGroupParent" +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/TestGroup +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroup +TenantId : 14307de0-5e6f-46cf-b2ba-64a062964d30 +DisplayName : TestGroupDisplayName +UpdatedTime : 2/1/2018 11:16:12 AM +UpdatedBy : 14307de0-5e6f-46cf-b2ba-64a062964d30 +ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent +ParentName : TestGroupParent +ParentDisplayName : TestGroupParent +``` + +### Example 4: Create a Management Group with a parent (using a parent object) +```powershell +$parentObject = Get-AzManagementGroup -GroupName "TestGroupParent" +New-AzManagementGroup -GroupName "TestGroup" -ParentObject $parentObject +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/TestGroup +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroup +TenantId : 14307de0-5e6f-46cf-b2ba-64a062964d30 +DisplayName : TestGroupDisplayName +UpdatedTime : 2/1/2018 11:16:12 AM +UpdatedBy : 14307de0-5e6f-46cf-b2ba-64a062964d30 +ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent +ParentName : TestGroupParent +ParentDisplayName : TestGroupParent +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display Name of the management group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Management Group Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentId +Parent Id of the management group + +```yaml +Type: System.String +Parameter Sets: GroupOperations +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Parent Object + +```yaml +Type: Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup +Parameter Sets: ParentGroupObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup + +## NOTES + +## RELATED LINKS + +[Remove-AzManagementGroup](./Remove-AzManagementGroup.md) + +[Update-AzManagementGroup](./Update-AzManagementGroup.md) + +[Get-AzManagementGroup](./Get-AzManagementGroup.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Resources/New-AzManagementGroupDeployment.md b/azps-10.1.0/Az.Resources/New-AzManagementGroupDeployment.md new file mode 100644 index 0000000000..a93b94d226 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzManagementGroupDeployment.md @@ -0,0 +1,560 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azmanagementgroupdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagementGroupDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagementGroupDeployment.md +--- + +# New-AzManagementGroupDeployment + +## SYNOPSIS +Create a deployment at a management group + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterObject +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateParameterObject <Hashtable> -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterObject +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateParameterObject <Hashtable> -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterObject +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateParameterObject <Hashtable> -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateParameterObject <Hashtable> -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterFile +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateParameterFile <String> -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterFile +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateParameterFile <String> -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterFile +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateParameterFile <String> -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParams +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateParameterFile <String> -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterUri +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateParameterUri <String> -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterUri +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateParameterUri <String> -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterUri +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateParameterUri <String> -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsUri +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateParameterUri <String> -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateObjectWithNoParameters +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecResourceId +``` +New-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-DeploymentDebugLogLevel <String>] [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] + [-WhatIfExcludeChangeType <String[]>] [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzManagementGroupDeployment** cmdlet adds a deployment at a management group. + +To add a deployment at a management group, specify the management group, location and a template. +The location tells Azure Resource Manager where to store the deployment data. The template is a JSON string that contains individual resources to be deployed. +The template includes parameter placeholders for required resources and configurable property values, such as names and sizes. + +To use a custom template for the deployment, specify the *TemplateFile* parameter or *TemplateUri* parameter. +Each template has parameters for configurable properties. +To specify values for the template parameters, specify the *TemplateParameterFile* parameter or the *TemplateParameterObject* parameter. +Alternatively, you can use the template parameters that are dynamically added to the command when you specify a template. +To use dynamic parameters, type them at the command prompt, or type a minus sign (-) to indicate a parameter and use the Tab key to cycle through available parameters. +Template parameter values that you enter at the command prompt take precedence over values in a template parameter object or file. + +To add resources to a resource group, use the **New-AzResourceGroupDeployment** which creates a deployment at a resource group. +To add resources to a subscription, use the **New-AzSubscriptionDeployment** which creates a deployment at subscription scope, which deploys subscription level resources. +To add resources at tenant scope, use the **New-AzTenantDeployment** which creates a deployment at tenant scope. + +## EXAMPLES + +### Example 1: Use a custom template and parameter file to create a deployment +```powershell +New-AzManagementGroupDeployment -ManagementGroupId "myMG" -Location "West US" -TemplateFile "D:\Azure\Templates\OrgSetup.json" -TemplateParameterFile "D:\Azure\Templates\OrgParms.json" -Tag @{"key1"="value1"; "key2"="value2";} +``` + +This command creates a new deployment at the management group "myMG" by using a custom template and a template file on disk, with defined tags parameter. +The command uses the *TemplateFile* parameter to specify the template and the *TemplateParameterFile* parameter to specify a file that contains parameters and parameter values. + +### Example 2: Deploy a template stored in a non public storage account using a uri and SAS token +```powershell +New-AzManagementGroupDeployment -ManagementGroupId "myMG" -Location "West US" -TemplateUri "https://example.com/example.json" -QueryString "foo" +``` + +This command creates a new deployment using the template in TemplateUri which is not public and requires a token parameter to access which would be provided using the QueryString parameter. +Running this command effectively accesses the template using the url `https://example.com/example.json?foo`. +This can be used if you want to use a template in a storage account by providing the SAS token as the QueryString + +### Example 3: Use a custom template object and parameter file to create a deployment +```powershell +$TemplateFileText = [System.IO.File]::ReadAllText("D:\Azure\Templates\OrgSetup.json") +$TemplateObject = ConvertFrom-Json $TemplateFileText -AsHashtable +New-AzManagementGroupDeployment -ManagementGroupId "myMG" -Location "West US" -TemplateObject $TemplateObject -TemplateParameterFile "D:\Azure\Templates\OrgParams.json" +``` + +This command creates a new deployment at the management group "myMG" by using a custom template and a template file on disk that has been converted to an in-memory hashtable. +The first two commands read the text for the template file on disk and convert it to an in-memory hashtable. +The last command uses the *TemplateObject* parameter to specify this hashtable and the *TemplateParameterFile* parameter to specify a file that contains parameters and parameter values. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentDebugLogLevel +The deployment debug log level. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location to store deployment data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. "20131223140835". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProceedIfNoChange +Do not ask for confirmation if there is no changes in the What-If result. Applicable when the -Confirm switch is set. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. +This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. +For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to put on the deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +Local path to the template file. Supported template file type: json and bicep. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateObject +A hash table which represents the template. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateObjectAndParameterFile, ByTemplateObjectAndParameterUri, ByTemplateObjectWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +A file that has the template parameters. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterFile, ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile, ByTemplateSpecResourceIdAndParams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Uri to the template parameter file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterUri, ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri, ByTemplateSpecResourceIdAndParamsUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +Resource ID of the templateSpec to be deployed. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Uri to the template file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIfExcludeChangeType +Comma-separated resource change types to be excluded from What-If results. Applicable when the -WhatIf or -Confirm switch is set. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIfResultFormat +The What-If result format. Applicable when the -WhatIf or -Confirm switch is set. + +```yaml +Type: Microsoft.Azure.Management.ResourceManager.Models.WhatIfResultFormat +Parameter Sets: (All) +Aliases: +Accepted values: ResourceIdOnly, FullResourcePayloads + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Hashtable + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzManagementGroupDeploymentStack.md b/azps-10.1.0/Az.Resources/New-AzManagementGroupDeploymentStack.md new file mode 100644 index 0000000000..c1a003613b --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzManagementGroupDeploymentStack.md @@ -0,0 +1,586 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/New-AzManagementGroupDeploymentStack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagementGroupDeploymentStack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagementGroupDeploymentStack.md +--- + +# New-AzManagementGroupDeploymentStack + +## SYNOPSIS +Creates a new Management Group scoped Deployment Stack. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +New-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> [-Description <String>] + -Location <String> [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] -DeploymentSubscriptionId <String> + [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateFile <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateFileWithParameterFile +``` +New-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> [-Description <String>] + -Location <String> [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] -DeploymentSubscriptionId <String> + [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateFile <String> -TemplateParameterFile <String> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileWithParameterUri +``` +New-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> [-Description <String>] + -Location <String> [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] -DeploymentSubscriptionId <String> + [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateFile <String> -TemplateParameterUri <String> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileWithParameterObject +``` +New-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> [-Description <String>] + -Location <String> [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] -DeploymentSubscriptionId <String> + [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateFile <String> -TemplateParameterObject <Hashtable> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithParameterFile +``` +New-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> [-Description <String>] + -Location <String> [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] -DeploymentSubscriptionId <String> + [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateUri <String> -TemplateParameterFile <String> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithParameterUri +``` +New-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> [-Description <String>] + -Location <String> [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] -DeploymentSubscriptionId <String> + [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateUri <String> -TemplateParameterUri <String> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithParameterObject +``` +New-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> [-Description <String>] + -Location <String> [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] -DeploymentSubscriptionId <String> + [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateUri <String> -TemplateParameterObject <Hashtable> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +New-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> [-Description <String>] + -Location <String> [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] -DeploymentSubscriptionId <String> + [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateUri <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterFile +``` +New-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> [-Description <String>] + -Location <String> [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] -DeploymentSubscriptionId <String> + [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateSpecId <String> -TemplateParameterFile <String> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterUri +``` +New-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> [-Description <String>] + -Location <String> [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] -DeploymentSubscriptionId <String> + [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateSpecId <String> -TemplateParameterUri <String> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterObject +``` +New-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> [-Description <String>] + -Location <String> [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] -DeploymentSubscriptionId <String> + [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateSpecId <String> -TemplateParameterObject <Hashtable> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithNoParameters +``` +New-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> [-Description <String>] + -Location <String> [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] -DeploymentSubscriptionId <String> + [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateSpecId <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a management group scoped deployment stack. + +## EXAMPLES + +### Example 1: Creates a new stack MyMGStack at the MyManagementGroup management group and deploys it into the child subscription MySubId +```powershell +New-AzManagementGroupDeploymentStack -Name MyMGStack -ManagementGroupId MyMangementGroup -DeploymentSubscriptionId MySubId -TemplateFile myTemplate.json -Location westus -DenySettingsMode DenyDelete +``` + +Create a new management group scoped deployment stack named 'MyMGStack' in management group 'MyManagementGroup,' with the scope of the underlying deployment being MySubId and deny settings being DenyDelete. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteAll +Signal to delete both unmanaged Resources and ResourceGroups after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResourceGroups +Signal to delete unmanaged stack ResourceGroups after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResources +Signal to delete unmanaged stack Resources after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsApplyToChildScopes +Apply to child scopes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsExcludedAction +List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsExcludedPrincipal +List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsMode +Mode for DenySettings. +Possible values include: 'denyDelete', 'denyWriteAndDelete', and 'none'. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDenySettingsMode +Parameter Sets: (All) +Aliases: +Accepted values: None, DenyDelete, DenyWriteAndDelete + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentSubscriptionId +The subscription id at which the deployment should be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +Description for the stack + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation when overwriting an existing stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the stack + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagementGroupId +The id of the management group that the deploymentStack will be deployed into. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the deploymentStack to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StackName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to put on the deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +TemplateFile to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileWithParameterFile, ByTemplateFileWithParameterUri, ByTemplateFileWithParameterObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +Parameter file to use for the template. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithParameterFile, ByTemplateUriWithParameterFile, ByTemplateSpecWithParameterFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateFileWithParameterObject, ByTemplateUriWithParameterObject, ByTemplateSpecWithParameterObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Location of the Parameter file to use for the template. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithParameterUri, ByTemplateUriWithParameterUri, ByTemplateSpecWithParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +ResourceId of the TemplateSpec to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecWithParameterFile, ByTemplateSpecWithParameterUri, ByTemplateSpecWithParameterObject, ByTemplateSpecWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Location of the Template to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriWithParameterFile, ByTemplateUriWithParameterUri, ByTemplateUriWithParameterObject, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStack + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzManagementGroupHierarchySetting.md b/azps-10.1.0/Az.Resources/New-AzManagementGroupHierarchySetting.md new file mode 100644 index 0000000000..e54980c27d --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzManagementGroupHierarchySetting.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azmanagementgrouphierarchysetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagementGroupHierarchySetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagementGroupHierarchySetting.md +--- + +# New-AzManagementGroupHierarchySetting + +## SYNOPSIS +Creates Hierarchy Settings under the current tenant + +## SYNTAX + +### GroupOperations (Default) +``` +New-AzManagementGroupHierarchySetting [-GroupName] <String> [-Authorization <Boolean>] + [-DefaultManagementGroup <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ParentGroupObject +``` +New-AzManagementGroupHierarchySetting [-GroupName] <String> [-Authorization <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzManagementGroupHierarchySetting** cmdlet creates new hierarchy settings under the current tenant. Requiring **Authorization** and setting the **DefaultManagementGroup** that new groups get created under can be set. + +## EXAMPLES + +### Example 1: Create a Hierarchy Setting for an Authorization Requirement for Group Creation +```powershell +New-AzManagementGroupHierarchySetting -GroupName c7a87cda-9a66-4920-b0f8-869baa04efe0 -Authorization True +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/c7a87cda-9a66-4920-b0f8-869baa04efe0/settings/default +Type : Microsoft.Management/managementGroups/settings +Name : default +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +RequireAuthorizationForGroupCreation : true +DefaultManagementGroup : +``` + +### Example 2: Create a Hierarchy Setting for the default Management Group new Groups get placed under +```powershell +New-AzManagementGroupHierarchySetting -GroupName c7a87cda-9a66-4920-b0f8-869baa04efe0 -DefaultManagementGroup TestGroup +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/c7a87cda-9a66-4920-b0f8-869baa04efe0/settings/default +Type : Microsoft.Management/managementGroups/settings +Name : default +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +RequireAuthorizationForGroupCreation : false +DefaultManagementGroup : TestGroup +``` + +### Example 3: Create both Hierarchy Settings +```powershell +New-AzManagementGroupHierarchySetting -GroupName c7a87cda-9a66-4920-b0f8-869baa04efe0 -Authorization True -DefaultManagementGroup TestGroup +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/c7a87cda-9a66-4920-b0f8-869baa04efe0/settings/default +Type : Microsoft.Management/managementGroups/settings +Name : default +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +RequireAuthorizationForGroupCreation : true +DefaultManagementGroup : TestGroup +``` + +## PARAMETERS + +### -Authorization +Indicate whether RBAC access is required upon group creation under the root Management Group. True means user will require Microsoft.Management/managementGroups/write action on the root Management Group. Default setting is false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: RequireAuthorizationForGroupCreation + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultManagementGroup +Expand the output to list the children of the management group + +```yaml +Type: System.String +Parameter Sets: GroupOperations +Aliases: DefaultMG + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Management Group Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSHierarchySettings + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSHierarchySettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzManagementGroupSubscription.md b/azps-10.1.0/Az.Resources/New-AzManagementGroupSubscription.md new file mode 100644 index 0000000000..12be44ac40 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzManagementGroupSubscription.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azmanagementgroupsubscription/ +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagementGroupSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzManagementGroupSubscription.md +--- + +# New-AzManagementGroupSubscription + +## SYNOPSIS +Adds a Subscription to a Management Group. + +## SYNTAX + +``` +New-AzManagementGroupSubscription [-GroupName] <String> [-SubscriptionId] <Guid> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzManagementGroupSubscription** cmdlet adds a Subscription to a Management Group. + +## EXAMPLES + +### Example 1: Add Subscription to a Management Group +```powershell +New-AzManagementGroupSubscription -GroupName "TestGroup" -SubscriptionId 5602fbd9-fb0d-4fbb-98b3-10c8ea20b6de +``` + +```output +Name : 5602fbd9-fb0d-4fbb-98b3-10c8ea20b6de +Type : Microsoft.Management/managementGroups/subscriptions +Id : /providers/Microsoft.Management/managementGroups/TestGroup/subscriptions/5602fbd9-fb0d-4fbb-98b3-10c8ea20b6de +TenantId : 14307de0-5e6f-46cf-b2ba-64a062964d30 +DisplayName : Visual Studio Enterprise Subscription +ParentId : /providers/Microsoft.Management/managementGroups/TestGroup +State : Active +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Management Group Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return `true` on successful execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id of the subscription associated with the management + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroupSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzPolicyAssignment.md b/azps-10.1.0/Az.Resources/New-AzPolicyAssignment.md new file mode 100644 index 0000000000..5ca89445b2 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzPolicyAssignment.md @@ -0,0 +1,557 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: BA40BD11-8167-48D7-AC71-72B2FD9924F2 +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azpolicyassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzPolicyAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzPolicyAssignment.md +--- + +# New-AzPolicyAssignment + +## SYNOPSIS +Creates a policy assignment. + +## SYNTAX + +### DefaultParameterSet (Default) +``` +New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>] + [-Description <String>] [-PolicyDefinition <PsPolicyDefinition>] + [-PolicySetDefinition <PsPolicySetDefinition>] [-Metadata <String>] + [-EnforcementMode <PolicyAssignmentEnforcementMode>] [-AssignIdentity] [-IdentityType <ManagedIdentityType>] + [-IdentityId <String>] [-Location <String>] [-NonComplianceMessage <PsNonComplianceMessage[]>] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicyParameterObjectParameterSet +``` +New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>] + [-Description <String>] -PolicyDefinition <PsPolicyDefinition> [-PolicySetDefinition <PsPolicySetDefinition>] + -PolicyParameterObject <Hashtable> [-Metadata <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>] + [-AssignIdentity] [-IdentityType <ManagedIdentityType>] [-IdentityId <String>] [-Location <String>] + [-NonComplianceMessage <PsNonComplianceMessage[]>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicyParameterStringParameterSet +``` +New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>] + [-Description <String>] -PolicyDefinition <PsPolicyDefinition> [-PolicySetDefinition <PsPolicySetDefinition>] + -PolicyParameter <String> [-Metadata <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>] + [-AssignIdentity] [-IdentityType <ManagedIdentityType>] [-IdentityId <String>] [-Location <String>] + [-NonComplianceMessage <PsNonComplianceMessage[]>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicySetParameterObjectParameterSet +``` +New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>] + [-Description <String>] [-PolicyDefinition <PsPolicyDefinition>] -PolicySetDefinition <PsPolicySetDefinition> + -PolicyParameterObject <Hashtable> [-Metadata <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>] + [-AssignIdentity] [-IdentityType <ManagedIdentityType>] [-IdentityId <String>] [-Location <String>] + [-NonComplianceMessage <PsNonComplianceMessage[]>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicySetParameterStringParameterSet +``` +New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>] + [-Description <String>] [-PolicyDefinition <PsPolicyDefinition>] -PolicySetDefinition <PsPolicySetDefinition> + -PolicyParameter <String> [-Metadata <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>] + [-AssignIdentity] [-IdentityType <ManagedIdentityType>] [-IdentityId <String>] [-Location <String>] + [-NonComplianceMessage <PsNonComplianceMessage[]>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPolicyAssignment** cmdlet creates a policy assignment. +Specify a policy and scope. + +## EXAMPLES + +### Example 1: Policy assignment at subscription level +```powershell +$Subscription = Get-AzSubscription -SubscriptionName 'Subscription01' +$Policy = Get-AzPolicyDefinition -Name 'VirtualMachinePolicy' +New-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment' -PolicyDefinition $Policy -Scope "/subscriptions/$($Subscription.Id)" +``` + +The first command gets a subscription named Subscription01 by using the Get-AzSubscription cmdlet and stores it in the $Subscription variable. +The second command gets the policy definition named VirtualMachinePolicy by using the Get-AzPolicyDefinition cmdlet and stores it in the $Policy variable. +The final command assigns the policy in $Policy at the level of the subscription identified by the subscription scope string. + +### Example 2: Policy assignment at resource group level +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +$Policy = Get-AzPolicyDefinition -Name 'VirtualMachinePolicy' +New-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment' -PolicyDefinition $Policy -Scope $ResourceGroup.ResourceId +``` + +The first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet and stores it in the $ResourceGroup variable. +The second command gets the policy definition named VirtualMachinePolicy by using the Get-AzPolicyDefinition cmdlet and stores it in the $Policy variable. +The final command assigns the policy in $Policy at the level of the resource group identified by the **ResourceId** property of $ResourceGroup. + +### Example 3: Policy assignment at resource group level with policy parameter object +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +$Policy = Get-AzPolicyDefinition -BuiltIn | Where-Object {$_.Properties.DisplayName -eq 'Allowed locations'} +$Locations = Get-AzLocation | Where-Object displayname -like '*east*' +$AllowedLocations = @{'listOfAllowedLocations'=($Locations.location)} +New-AzPolicyAssignment -Name 'RestrictLocationPolicyAssignment' -PolicyDefinition $Policy -Scope $ResourceGroup.ResourceId -PolicyParameterObject $AllowedLocations +``` + +The first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet. +The command stores that object in the $ResourceGroup variable. +The second command gets the built-in policy definition for allowed locations by using the Get-AzPolicyDefinition cmdlet. +The command stores that object in the $Policy variable. +The third and fourth commands create an object containing all Azure regions with "east" in the name. +The commands store that object in the $AllowedLocations variable. +The final command assigns the policy in $Policy at the level of a resource group using the policy parameter object in $AllowedLocations. +The **ResourceId** property of $ResourceGroup identifies the resource group. + +### Example 4: Policy assignment at resource group level with policy parameter file +Create a file called _AllowedLocations.json_ in the local working directory with the following content. + + +```powershell +<#{ + "listOfAllowedLocations": { + "value": [ + "westus", + "westeurope", + "japanwest" + ] + } +}#> +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +$Policy = Get-AzPolicyDefinition -BuiltIn | Where-Object {$_.Properties.DisplayName -eq 'Allowed locations'} +New-AzPolicyAssignment -Name 'RestrictLocationPolicyAssignment' -PolicyDefinition $Policy -Scope $ResourceGroup.ResourceId -PolicyParameter .\AllowedLocations.json +``` + +The first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet and stores it in the $ResourceGroup variable. +The second command gets the built-in policy definition for allowed locations by using the Get-AzPolicyDefinition cmdlet and stores it in the $Policy variable. +The final command assigns the policy in $Policy at the resource group identified by the **ResourceId** property of $ResourceGroup using the policy parameter file AllowedLocations.json from the local working directory. + +### Example 5: Policy assignment with a system assigned managed identity +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +$Policy = Get-AzPolicyDefinition -Name 'VirtualMachinePolicy' +New-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment' -PolicyDefinition $Policy -Scope $ResourceGroup.ResourceId -Location 'eastus' -IdentityType 'SystemAssigned' +``` + +The first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet and stores it in the $ResourceGroup variable. +The second command gets the policy definition named VirtualMachinePolicy by using the Get-AzPolicyDefinition cmdlet and stores it in the $Policy variable. +The final command assigns the policy in $Policy to the resource group. A system assigned managed identity is automatically created and assigned to the policy assignment. + +### Example 6: Policy assignment with a user assigned managed identity +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +$Policy = Get-AzPolicyDefinition -Name 'VirtualMachinePolicy' +$UserAssignedIdentity = Get-AzUserAssignedIdentity -ResourceGroupName 'ResourceGroup1' -Name 'UserAssignedIdentity1' +New-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment' -PolicyDefinition $Policy -Scope $ResourceGroup.ResourceId -Location 'eastus' -IdentityType 'UserAssigned' -IdentityId $UserAssignedIdentity.Id +``` + +The first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet and stores it in the $ResourceGroup variable. +The second command gets the policy definition named VirtualMachinePolicy by using the Get-AzPolicyDefinition cmdlet and stores it in the $Policy variable. +The third command gets the user assigned managed identity named UserAssignedIdentity1 by using the Get-AzUserAssignedIdentity cmdlet and stores it in the $UserAssignedIdentity variable. +The final command assigns the policy in $Policy to the resource group. The user assigned managed identity identified by the **Id** property of $UserAssignedIdentity is assigned to the policy assignment by passing the **Id*** property to the IdentityId parameter. + +### Example 7: Policy assignment with an enforcement mode property +```powershell +$Subscription = Get-AzSubscription -SubscriptionName 'Subscription01' +$Policy = Get-AzPolicyDefinition -Name 'VirtualMachinePolicy' +New-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment' -PolicyDefinition $Policy -Scope "/subscriptions/$($Subscription.Id)" -EnforcementMode DoNotEnforce +``` + +The first command gets a subscription named Subscription01 by using the Get-AzSubscription cmdlet and stores it in the $Subscription variable. +The second command gets the policy definition named VirtualMachinePolicy by using the Get-AzPolicyDefinition cmdlet and stores it in the $Policy variable. +The final command assigns the policy in $Policy at the level of the subscription identified by the subscription scope string. +The assignment is set with an EnforcementMode value of _DoNotEnforce_ i.e. the policy effect is not enforced during resource creation or update. + +### Example 8: Policy assignment with non-compliance messages +```powershell +$PolicySet = Get-AzPolicySetDefinition -Name 'VirtualMachinePolicySet' +$NonComplianceMessages = @(@{Message="Only DsV2 SKUs are allowed."; PolicyDefinitionReferenceId="DefRef1"}, @{Message="Virtual machines must follow cost management best practices."}) +New-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment' -PolicySetDefinition $PolicySet -NonComplianceMessage $NonComplianceMessages +``` + +The first command gets the policy set definition named VirtualMachinePolicySet by using the Get-AzPolicySetDefinition cmdlet and stores it in the $PolicySet variable. +The second command creates an array of non-compliance messages. One general purpose message for the entire assignment and one message specific to a SKU restriction policy within the assigned policy set definition. +The final command assigns the policy set definition in $PolicySet to the subscription with two non-compliance messages that will be shown if a resource is denied by policy. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign a system assigned managed identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' and 'modify' policies. Location is required when assigning an identity. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for policy assignment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +Specifies a display name for the policy assignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnforcementMode +The enforcement mode for policy assignment. Currently, valid values are Default, DoNotEnforce. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy.PolicyAssignmentEnforcementMode] +Parameter Sets: (All) +Aliases: +Accepted values: Default, DoNotEnforce + +Required: False +Position: Named +Default value: Default +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityId +Specifies the Id of the user assigned managed identity to assign to this policy assignment. This value is required if the value 'UserAssigned' is passed to the -IdentityType parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Specifies the type of managed identity to assign to this policy assignment. If the 'SystemAssigned' value is provided, a system assigned managed identity is generated and assigned to this policy assignment. If the 'UserAssigned' value is provided, the user assigned identity passed via its Id to the -IdentityId parameter is assigned to this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' and 'modify' policies. Location is required when assigning an identity. Permissions must be granted to the identity using New-AzRoleAssignment after the system assigned identity is created. The IdentityType parameter will be given precedence if both the AssignIdentity and the IdentityType parameter are used. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Resources.ManagedIdentityType] +Parameter Sets: (All) +Aliases: +Accepted values: SystemAssigned, UserAssigned, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the policy assignment's resource identity. This is required when the -IdentityType value is provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Metadata +The metadata for the new policy assignment. This can either be a path to a file name containing the metadata, or the metadata as a string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the policy assignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NonComplianceMessage +The non-compliance messages that describe why a resource is non-compliant with the policy. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsNonComplianceMessage[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotScope +The not scopes for policy assignment. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinition +Specifies a policy, as a **PsPolicyDefinition** object that contains the policy rule. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyDefinition +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyDefinition +Parameter Sets: PolicyParameterObjectParameterSet, PolicyParameterStringParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyDefinition +Parameter Sets: PolicySetParameterObjectParameterSet, PolicySetParameterStringParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyParameter +The policy parameter file path or policy parameter string. + +```yaml +Type: System.String +Parameter Sets: PolicyParameterStringParameterSet, PolicySetParameterStringParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyParameterObject +The policy parameter object. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: PolicyParameterObjectParameterSet, PolicySetParameterObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicySetDefinition +The policy set definition object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicySetDefinition +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicySetDefinition +Parameter Sets: PolicyParameterObjectParameterSet, PolicyParameterStringParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicySetDefinition +Parameter Sets: PolicySetParameterObjectParameterSet, PolicySetParameterStringParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Specifies the scope at which to assign the policy. +For instance, to assign a policy to a resource group, specify the following: +`/subscriptions/`subscription ID`/resourcegroups/`resource group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyDefinition + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicySetDefinition + +### System.Nullable`1[[Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy.PolicyAssignmentEnforcementMode, Microsoft.Azure.PowerShell.Cmdlets.ResourceManager, Version=3.5.0.0, Culture=neutral, PublicKeyToken=null]] + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsNonComplianceMessage[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment + +## NOTES + +## RELATED LINKS + +[Get-AzPolicyDefinition](./Get-AzPolicyDefinition.md) + +[Get-AzPolicyAssignment](./Get-AzPolicyAssignment.md) + +[Remove-AzPolicyAssignment](./Remove-AzPolicyAssignment.md) + +[Set-AzPolicyAssignment](./Set-AzPolicyAssignment.md) + + diff --git a/azps-10.1.0/Az.Resources/New-AzPolicyDefinition.md b/azps-10.1.0/Az.Resources/New-AzPolicyDefinition.md new file mode 100644 index 0000000000..291ae77c18 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzPolicyDefinition.md @@ -0,0 +1,333 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 31F2AF24-488D-4CAF-A9C8-C8DAE76E031F +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azpolicydefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzPolicyDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzPolicyDefinition.md +--- + +# New-AzPolicyDefinition + +## SYNOPSIS +Creates a policy definition. + +## SYNTAX + +### NameParameterSet (Default) +``` +New-AzPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] -Policy <String> + [-Metadata <String>] [-Parameter <String>] [-Mode <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ManagementGroupNameParameterSet +``` +New-AzPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] -Policy <String> + [-Metadata <String>] [-Parameter <String>] [-Mode <String>] -ManagementGroupName <String> + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionIdParameterSet +``` +New-AzPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] -Policy <String> + [-Metadata <String>] [-Parameter <String>] [-Mode <String>] -SubscriptionId <Guid> [-ApiVersion <String>] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPolicyDefinition** cmdlet creates a policy definition that includes a policy rule in JavaScript Object Notation (JSON) format. + +## EXAMPLES + +### Example 1: Create a policy definition by using a policy file + +```powershell +<#{ + "if": { + "field": "location", + "notIn": ["eastus", "westus", "centralus"] + }, + "then": { + "effect": "audit" + } +}#> +New-AzPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json +``` + +This command creates a policy definition named LocationDefinition that contains the policy rule specified in C:\LocationPolicy.json. Example content for the LocationPolicy.json file is provided above. Three file content formats are supported: +1. Policy rule only (example above). +2. Policy properties object. This format is displayed in the portal when editing a policy definition and may include parameters. +3. Full policy object. This format is generated by the Azure Policy export function and may include parameters. + +Note: Values provided on the command line (e.g. parameters, metadata) override corresponding values present in the file. + +### Example 2: Create a parameterized policy definition using inline parameters + +```powershell +<#{ + "if": { + "field": "location", + "notIn": "[parameters('listOfAllowedLocations')]" + }, + "then": { + "effect": "audit" + } +}#> +New-AzPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json -Parameter '{ "listOfAllowedLocations": { "type": "array" } }' +``` + +This command creates a policy definition named LocationDefinition that contains the policy rule specified in C:\LocationPolicy.json. The parameter definition for the policy rule is provided inline. + +### Example 3: Create a policy definition inline in a management group +```powershell +New-AzPolicyDefinition -Name 'VMPolicyDefinition' -ManagementGroupName Dept42 -DisplayName 'Virtual Machine policy definition' -Policy '{"if":{"field":"type","equals":"Microsoft.Compute/virtualMachines"},"then":{"effect":"deny"}}' +``` + +This command creates a policy definition named VMPolicyDefinition in management group Dept42. +The command specifies the policy as a string in valid JSON format. + +### Example 4: Create a policy definition inline with metadata +```powershell +New-AzPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"category":"Virtual Machine"}' -Policy '{"if":{"field":"type","equals":"Microsoft.Compute/virtualMachines"},"then":{"effect":"deny"}}' +``` + +```output +Name : VMPolicyDefinition +ResourceId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition +ResourceName : VMPolicyDefinition +ResourceType : Microsoft.Authorization/policyDefinitions +SubscriptionId : 11111111-1111-1111-1111-111111111111 +Properties : @{displayName=VMPolicyDefinition; policyType=Custom; mode=All; metadata=; policyRule=} +PolicyDefinitionId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition +``` + +This command creates a policy definition named VMPolicyDefinition with metadata indicating its category is "Virtual Machine". +The command specifies the policy as a string in valid JSON format. + +### Example 5: Create a policy definition inline with mode +```powershell +New-AzPolicyDefinition -Name 'TagsPolicyDefinition' -Policy '{"if":{"value":"[less(length(field(''tags'')), 3)]","equals":true},"then":{"effect":"deny"}}' -Mode Indexed +``` + +```output +Name : TagsPolicyDefinition +ResourceId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/TagsPolicyDefinition +ResourceName : TagsPolicyDefinition +ResourceType : Microsoft.Authorization/policyDefinitions +SubscriptionId : 11111111-1111-1111-1111-111111111111 +Properties : @{displayName=TagsPolicyDefinition; policyType=Custom; mode=Indexed; metadata=; parameters=; policyRule=} +PolicyDefinitionId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/TagsPolicyDefinition +``` + +This command creates a policy definition named TagsPolicyDefinition with mode "Indexed" indicating the policy should be evaluated only for resource types that support tags and location. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a description for the policy definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +Specifies a display name for the policy definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagementGroupName +The name of the management group of the new policy definition. + +```yaml +Type: System.String +Parameter Sets: ManagementGroupNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Metadata +The metadata for policy definition. This can either be a path to a file name containing the metadata, or the metadata as string + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Mode +The mode of the policy definition + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: All +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the policy definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameter +The parameters declaration for policy definition. This can either be a path to a file name containing the parameters declaration, or the parameters declaration as string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Policy +Specifies a policy rule for the policy definition. +You can specify the path of a .json file or a string that contains the policy in JSON format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID of the new policy definition. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: SubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS + +[Get-AzPolicyDefinition](./Get-AzPolicyDefinition.md) + +[Remove-AzPolicyDefinition](./Remove-AzPolicyDefinition.md) + +[Set-AzPolicyDefinition](./Set-AzPolicyDefinition.md) + + diff --git a/azps-10.1.0/Az.Resources/New-AzPolicyExemption.md b/azps-10.1.0/Az.Resources/New-AzPolicyExemption.md new file mode 100644 index 0000000000..30f0d2742e --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzPolicyExemption.md @@ -0,0 +1,288 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azpolicyexemption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzPolicyExemption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzPolicyExemption.md +--- + +# New-AzPolicyExemption + +## SYNOPSIS +Creates a policy exemption. + +## SYNTAX + +``` +New-AzPolicyExemption -Name <String> [-Scope <String>] [-DisplayName <String>] [-Description <String>] + -ExemptionCategory <String> -PolicyAssignment <PsPolicyAssignment> [-PolicyDefinitionReferenceId <String[]>] + [-ExpiresOn <DateTime>] [-Metadata <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPolicyExemption** cmdlet creates a policy exemption. +Specify a policy assignment, exemption category and scope. + +## EXAMPLES + +### Example 1: Policy exemption at subscription level +```powershell +$Subscription = Get-AzSubscription -SubscriptionName 'Subscription01' +$Assignment = Get-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment' +New-AzPolicyExemption -Name 'VirtualMachinePolicyExemption' -PolicyAssignment $Assignment -Scope "/subscriptions/$($Subscription.Id)" -ExemptionCategory Waiver +``` + +The first command gets a subscription named Subscription01 by using the Get-AzSubscription cmdlet and stores it in the $Subscription variable. +The second command gets the policy assignment named VirtualMachinePolicyAssignment by using the Get-AzPolicyAssignment cmdlet and stores it in the $Assignment variable. +The final command exempts the policy assignment in $Assignment at the level of the subscription identified by the subscription scope string. + +### Example 2: Policy exemption at resource group level +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +$Assignment = Get-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment' +New-AzPolicyExemption -Name 'VirtualMachinePolicyAssignment' -PolicyAssignment $Assignment -Scope $ResourceGroup.ResourceId -ExemptionCategory Mitigated +``` + +The first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet and stores it in the $ResourceGroup variable. +The second command gets the policy assignment named VirtualMachinePolicyAssignment by using the Get-AzPolicyAssignment cmdlet and stores it in the $Assignment variable. +The final command exempts the policy assignment in $Assignment at the level of the resource group identified by the **ResourceId** property of $ResourceGroup. + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for the new policy exemption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +The display name for the new policy exemption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExemptionCategory +The policy exemption category of the new policy exemption. +Possible values are Waiver and Mitigated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Waiver, Mitigated + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpiresOn +The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the new policy exemption. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Metadata +The metadata for the new policy exemption. +This can either be a path to a file containing the metadata JSON, or the metadata as a JSON string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the new policy exemption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyAssignment +The referenced policy assignment Id for the new policy exemption. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyDefinitionReferenceId +The policy definition reference ID list when the associated policy assignment is for a policy set (initiative). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the new policy exemption, e.g. +/providers/managementGroups/{managementGroupName}, defaults to current subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment + +### System.String[] + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=5.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyExemption + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzPolicySetDefinition.md b/azps-10.1.0/Az.Resources/New-AzPolicySetDefinition.md new file mode 100644 index 0000000000..53e9fa66bb --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzPolicySetDefinition.md @@ -0,0 +1,341 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azpolicysetdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzPolicySetDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzPolicySetDefinition.md +--- + +# New-AzPolicySetDefinition + +## SYNOPSIS +Creates a policy set definition. + +## SYNTAX + +### NameParameterSet (Default) +``` +New-AzPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] [-Metadata <String>] + -PolicyDefinition <String> [-Parameter <String>] [-GroupDefinition <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ManagementGroupNameParameterSet +``` +New-AzPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] [-Metadata <String>] + -PolicyDefinition <String> [-Parameter <String>] -ManagementGroupName <String> [-GroupDefinition <String>] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SubscriptionIdParameterSet +``` +New-AzPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] [-Metadata <String>] + -PolicyDefinition <String> [-Parameter <String>] -SubscriptionId <Guid> [-GroupDefinition <String>] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzPolicySetDefinition** cmdlet creates a policy set definition. + +## EXAMPLES + +### Example 1: Create a policy set definition with metadata by using a policy set file + +```powershell +<#[ + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/2a0e14a6-b0a6-4fab-991a-187a4f81c498", + "parameters": { + "tagName": { + "value": "Business Unit" + }, + "tagValue": { + "value": "Finance" + } + } + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/464dbb85-3d5f-4a1d-bb09-95a9b5dd19cf" + } +]#> +New-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}' -PolicyDefinition C:\VMPolicySet.json +``` + +This command creates a policy set definition named VMPolicySetDefinition with metadata indicating its category is "Virtual Machine" that contains the policy definitions specified in C:\VMPolicy.json. Example content of the VMPolicy.json is provided above. + +### Example 2: Create a parameterized policy set definition + +```powershell +<#[ + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/2a0e14a6-b0a6-4fab-991a-187a4f81c498", + "parameters": { + "tagName": { + "value": "Business Unit" + }, + "tagValue": { + "value": "[parameters('buTagValue')]" + } + } + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/464dbb85-3d5f-4a1d-bb09-95a9b5dd19cf" + } +]#> +New-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -PolicyDefinition C:\VMPolicySet.json -Parameter '{ "buTagValue": { "type": "string" } }' +``` + +This command creates a parameterized policy set definition named VMPolicySetDefinition that contains the policy definitions specified in C:\VMPolicy.json. Example content of the VMPolicy.json is provided above. + +### Example 3: Create a policy set definition with policy definition groups + +```powershell +<#[ + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/2a0e14a6-b0a6-4fab-991a-187a4f81c498", + "groupNames": [ "group1" ] + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/464dbb85-3d5f-4a1d-bb09-95a9b5dd19cf", + "groupNames": [ "group2" ] + } +]#> +$groupsJson = ConvertTo-Json @{ name = "group1" }, @{ name = "group2" } +New-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition $groupsJson -PolicyDefinition C:\VMPolicySet.json +``` + +This command creates a policy set definition named VMPolicySetDefinition with grouping of policy definitions specified in C:\VMPolicy.json. Example content of the VMPolicy.json is provided above. + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for policy set definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +The display name for policy set definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GroupDefinition +The policy definition groups for the new policy set definition. This can either be a path to a file containing the groups, or the groups as a JSON string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagementGroupName +The name of the management group of the new policy set definition. + +```yaml +Type: System.String +Parameter Sets: ManagementGroupNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Metadata +The metadata for policy set definition. This can either be a path to a file name containing the metadata, or the metadata as a JSON string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The policy set definition name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameter +The parameters declaration for policy set definition. +This can either be a path to a file name containing the parameters declaration, or the parameters declaration as a JSON string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinition +The policy definitions. This can either be a path to a file name containing the policy definitions, or the policy definitions as a JSON string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID of the new policy set definition. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: SubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzPrivateLinkAssociation.md b/azps-10.1.0/Az.Resources/New-AzPrivateLinkAssociation.md new file mode 100644 index 0000000000..5624815d9e --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzPrivateLinkAssociation.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azprivatelinkassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzPrivateLinkAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzPrivateLinkAssociation.md +--- + +# New-AzPrivateLinkAssociation + +## SYNOPSIS +Creates the Azure Resource Management Private Link Association. + +## SYNTAX + +``` +New-AzPrivateLinkAssociation [-ManagementGroupId] <String> [-Name] <String> [-PrivateLink] <String> + [-PublicNetworkAccess] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzPrivateLinkAssociation cmdlet creates the private link assocaition at the scope. + +## EXAMPLES + +### Example 1 +```powershell +New-AzPrivateLinkAssociation -ManagementGroupId fc096d27-0434-4460-a3ea-110df0422a2d -Name 1d7942d1-288b-48de-8d0f-2d2aa8e03ad4 | Format-List +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/fc096d27-0434-4460-a3ea-110df0422a2d/providers/Microsoft. + Authorization/privateLinkAssociations/1d7942d1-288b-48de-8d0f-2d2aa8e03ad4 +Type : Microsoft.Authorization/privateLinkAssociations +Name : 1d7942d1-288b-48de-8d0f-2d2aa8e03ad4 +Properties : {"privateLink":"/subscriptions/aeb49941-36c3-4e7c-9ffd-16ba89d33ec4/resourceGroups/nrp-validate/providers/ + Microsoft.Authorization/resourceManagementPrivateLinks/DeepDiveRMPL","publicNetworkAc + cess":"Enabled","tenantID":"fc096d27-0434-4460-a3ea-110df0422a2d","scope":"/providers/Microsoft.Management + /managementGroups/fc096d27-0434-4460-a3ea-110df0422a2d"} +``` + +Creates the specific private link associations at the managment group scope. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The private link association Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PrivateLinkAssociationId + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLink +The name of the private link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +The public network access is enabled/disabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.PrivateLinks.PSResourceManagementPrivateLinkAssociation + +## NOTES + +## RELATED LINKS + +[Remove-AzPrivateLinkAssociation](./Remove-AzPrivateLinkAssociation.md) +[Get-AzPrivateLinkAssociation](./Get-AzPrivateLinkAssociation.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Resources/New-AzResource.md b/azps-10.1.0/Az.Resources/New-AzResource.md new file mode 100644 index 0000000000..665f9aed51 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzResource.md @@ -0,0 +1,442 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: D6FF6BDD-4515-438D-B39D-C0BFC3342F4E +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzResource.md +--- + +# New-AzResource + +## SYNOPSIS +Creates a resource. + +## SYNTAX + +### ByResourceId (Default) +``` +New-AzResource [-Location <String>] [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] + [-Sku <Hashtable>] [-Tag <Hashtable>] [-IsFullObject] [-AsJob] -ResourceId <String> [-ODataQuery <String>] + [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BySubscriptionLevel +``` +New-AzResource [-Location <String>] [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] + [-Sku <Hashtable>] [-Tag <Hashtable>] [-IsFullObject] [-AsJob] -ResourceName <String> -ResourceType <String> + [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] [-ODataQuery <String>] + [-ResourceGroupName <String>] [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTenantLevel +``` +New-AzResource [-Location <String>] [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] + [-Sku <Hashtable>] [-Tag <Hashtable>] [-IsFullObject] [-AsJob] -ResourceName <String> -ResourceType <String> + [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] [-ODataQuery <String>] [-TenantLevel] + [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzResource** cmdlet creates an Azure resource, such as a website, Azure SQL Database server, or Azure SQL Database, in a resource group. + +## EXAMPLES + +### Example 1: Create a resource +```powershell +New-AzResource -Location "West US" -Properties @{test="test"} -ResourceName TestSite06 -ResourceType microsoft.web/sites -ResourceGroupName ResourceGroup11 -Force +``` + +This command creates a resource that is a website in ResourceGroup11. + +### Example 2: Create a resource using splatting +```powershell +$prop = @{ + Location = "West US" + Properties = @{test = "test"} + ResourceName = "TestSite06" + ResourceType = "microsoft.web/sites" + ResourceGroupName = "ResourceGroup11" + Force = $true +} + +New-AzResource @prop +``` + +This command creates a resource that is a website in ResourceGroup11. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionResourceName +Specifies the name of an extension resource for the resource. For instance, to specify a database, use the following format: +server name`/`database name + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExtensionResourceType +Specifies the resource type for an extension resource. +For instance, if the extension resource is a database, specify the following type: +`Microsoft.Sql/Servers/Databases` + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFullObject +Indicates that the object that the *Properties* parameter specifies is the full object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Specifies the resource kind for the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the resource. +Specify data center location, such as Central US or Southeast Asia. +You can place a resource in any location that supports resources of that type. Resource groups can +contain resources from different locations. To determine which locations support each resource +type, use the Get-AzLocation cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ODataQuery +Specifies an Open Data Protocol (OData) style filter. This cmdlet appends this value to the request +in addition to any other filters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Plan +A hash table that represents resource plan properties. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: PlanObject + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Properties +Specifies resource properties for the resource. Use this parameter to specify the values of +properties that are specific to a resource type. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: PropertyObject + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group where this cmdlet creates the resource. + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the fully qualified resource ID, including the subscription, as in the following example: +`/subscriptions/`subscription ID`/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase` + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +Specifies the name of the resource. For instance, to specify a database, use the following format: +`ContosoServer/ContosoDatabase` + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +Specifies the type of the resource. +For instance, for a database, the resource type is as follows: +`Microsoft.Sql/Servers/Databases` + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +A hash table that represents sku properties. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: SkuObject + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantLevel +Indicates that this cmdlet operates at the tenant level. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByTenantLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.Collections.Hashtable + +### System.String + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS + +[Get-AzResource](./Get-AzResource.md) + +[Move-AzResource](./Move-AzResource.md) + +[Remove-AzResource](./Remove-AzResource.md) + +[Set-AzResource](./Set-AzResource.md) diff --git a/azps-10.1.0/Az.Resources/New-AzResourceGroup.md b/azps-10.1.0/Az.Resources/New-AzResourceGroup.md new file mode 100644 index 0000000000..348962e90c --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzResourceGroup.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 0632DAD6-F331-454F-9E7E-2164AB413E77 +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azresourcegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzResourceGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzResourceGroup.md +--- + +# New-AzResourceGroup + +## SYNOPSIS +Creates an Azure resource group. + +## SYNTAX + +``` +New-AzResourceGroup [-Name] <String> [-Location] <String> [-Tag <Hashtable>] [-Force] [-ApiVersion <String>] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzResourceGroup** cmdlet creates an Azure resource group. +You can create a resource group by using just a name and location, and then use the +New-AzResource cmdlet to create resources to add to the resource group. +To add a deployment to an existing resource group, use the New-AzResourceGroupDeployment +cmdlet. To add a resource to an existing resource group, use the **New-AzResource** cmdlet. An +Azure resource is a user-managed Azure entity, such as a database server, database, or website. An +Azure resource group is a collection of Azure resources that are deployed as a unit. + +## EXAMPLES + +### Example 1: Create an empty resource group +```powershell +New-AzResourceGroup -Name RG01 -Location "South Central US" +``` + +This command creates a resource group that has no resources. You can use the +**New-AzResource** or **New-AzResourceGroupDeployment** cmdlets to add resources and +deployments to this resource group. + +### Example 2: Create an empty resource group using positional parameters +```powershell +New-AzResourceGroup RG01 "South Central US" +``` + +This command creates a resource group that has no resources. + +### Example 3: Create a resource group with tags +```powershell +New-AzResourceGroup -Name RG01 -Location "South Central US" -Tag @{Empty=$null; Department="Marketing"} +``` + +This command creates an empty resource group. This command is the same as the command in Example 1, +except that it assigns tags to the resource group. The first tag, named Empty, can be used to +identify resource groups that have no resources. The second tag is named Department and has a value +of Marketing. You can use a tag such as this one to categorize resource groups for administration +or budgeting. + +## PARAMETERS + +### -ApiVersion +Specifies the API version that is supported by the resource Provider. +You can specify a different version than the default version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the resource group. Specify an Azure data center location, such as West +US or Southeast Asia. You can place a resource group in any location. The resource group does not +have to be in the same location your Azure subscription or in the same location as its resources. +To determine which location supports each resource type, use the Get-AzResourceProvider cmdlet +with the *ProviderNamespace* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the resource group. The resource name must be unique in the subscription. If a +resource group that has that name already exists, the command prompts you for confirmation before +replacing the existing resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroupName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} +To add or change a tag, you must replace the collection of tags for the resource group. +After you assign tags to resources and groups, you can use the *Tag* parameter of +Get-AzResource and Get-AzResourceGroup to search for resources and groups by tag name or +by name and value. You can use tags to categorize your resources, such as by department or cost +center, or to track notes or comments about the resources. +To get your predefined tags, use the Get-AzTag cmdlet. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceGroup + +## NOTES + +## RELATED LINKS + +[Get-AzResourceProvider](./Get-AzResourceProvider.md) + +[Get-AzResourceGroup](./Get-AzResourceGroup.md) + +[New-AzResource](./New-AzResource.md) + +[New-AzResourceGroupDeployment](./New-AzResourceGroupDeployment.md) + +[Remove-AzResourceGroup](./Remove-AzResourceGroup.md) + +[Set-AzResourceGroup](./Set-AzResourceGroup.md) diff --git a/azps-10.1.0/Az.Resources/New-AzResourceGroupDeployment.md b/azps-10.1.0/Az.Resources/New-AzResourceGroupDeployment.md new file mode 100644 index 0000000000..88308d470d --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzResourceGroupDeployment.md @@ -0,0 +1,659 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 6E2F0D5E-E683-46F3-B48B-55C4864F3308 +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azresourcegroupdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzResourceGroupDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzResourceGroupDeployment.md +--- + +# New-AzResourceGroupDeployment + +## SYNOPSIS +Adds an Azure deployment to a resource group. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateFile <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterObject +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterObject <Hashtable> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterObject +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterObject <Hashtable> + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterObject +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterObject <Hashtable> + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterObject <Hashtable> + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterFile +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterFile <String> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterFile +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterFile <String> -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterFile +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterFile <String> -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParams +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterFile <String> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterUri +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterUri <String> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterUri +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterUri <String> -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterUri +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterUri <String> -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsUri +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterUri <String> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateObjectWithNoParameters +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateUri <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecResourceId +``` +New-AzResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] + [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] [-Force] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateSpecId <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzResourceGroupDeployment** cmdlet adds a deployment to an existing resource group. +This includes the resources that the deployment requires. +An Azure resource is a user-managed Azure entity, such as a database server, database, website, virtual machine, or Storage account. +An Azure resource group is a collection of Azure resources that are deployed as a unit, such as the website, database server, and databases that are required for a financial website. +A resource group deployment uses a template to add resources to a resource group and publishes them so that they are available in Azure. +To add resources to a resource group without using a template, use the New-AzResource cmdlet. +To add a resource group deployment, specify the name of an existing resource group and a resource group template. +A resource group template is a JSON string that represents a resource group for a complex cloud-based service, such as a web portal. +The template includes parameter placeholders for required resources and configurable property values, such as names and sizes. +You can find many templates in the Azure template gallery or you can create your own templates. +To use a custom template to create a resource group, specify the *TemplateFile* parameter or *TemplateUri* parameter. +Each template has parameters for configurable properties. +To specify values for the template parameters, specify the *TemplateParameterFile* parameter or the *TemplateParameterObject* parameter. +Alternatively, you can use the template parameters that are dynamically added to the command when you specify a template. +To use dynamic parameters, type them at the command prompt, or type a minus sign (-) to indicate a parameter and use the Tab key to cycle through available parameters. +Template parameter values that you enter at the command prompt take precedence over values in a template parameter object or file. + +## EXAMPLES + +### Example 1: Use a custom template and parameter file to create a deployment +```powershell +New-AzResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json" -Tag @{"key1"="value1"; "key2"="value2";} +``` + +This command creates a new deployment by using a custom template and a template file on disk, with defined tags parameter. +The command uses the *TemplateFile* parameter to specify the template and the *TemplateParameterFile* parameter to specify a file that contains parameters and parameter values. + +### Example 2: Use a custom template object and parameter file to create a deployment +```powershell +$TemplateFileText = [System.IO.File]::ReadAllText("D:\Azure\Templates\EngineeringSite.json") +$TemplateObject = ConvertFrom-Json $TemplateFileText -AsHashtable +New-AzResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateObject $TemplateObject -TemplateParameterFile "D:\Azure\Templates\EngSiteParams.json" +``` + +This command creates a new deployment by using a custom and a template file on disk that has been converted to an in-memory hashtable. +The first two commands read the text for the template file on disk and convert it to an in-memory hashtable. +The last command uses the *TemplateObject* parameter to specify the hashtable and the *TemplateParameterFile* parameter to specify a file that contains parameters and parameter values. + +### Example 3 + +Adds an Azure deployment to a resource group. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzResourceGroupDeployment -DeploymentDebugLogLevel RequestContent -Name mynewstorageaccount -ResourceGroupName 'ContosoEngineering' -TemplateFile 'D:\Azure\Templates\EngineeringSite.json' -TemplateParameterObject <Hashtable> +``` + +### Example 4: Deploy a template stored in a non public storage account using a uri and SAS token +```powershell +New-AzResourceGroupDeployment -ResourceGroupName "RGName" -TemplateUri "https://example.com/example.json" -QueryString "foo" +``` + +This command creates a new deployment using the template in TemplateUri which is not public and requires a token parameter to access which would be provided using the QueryString parameter. +Running this command effectively accesses the template using the url `https://example.com/example.json?foo`. +This can be used if you want to use a template in a storage account by providing the SAS token as the QueryString + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentDebugLogLevel +Specifies a debug log level. +The acceptable values for this parameter are: +- RequestContent +- ResponseContent +- All +- None + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: RequestContent, ResponseContent, All, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Specifies the deployment mode. The acceptable values for this parameter are: +- Complete: In complete mode, Resource Manager deletes resources that exist in the resource group but are not +specified in the template. +- Incremental: In incremental mode, Resource Manager leaves unchanged resources that +exist in the resource group but are not specified in the template. + +```yaml +Type: Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode +Parameter Sets: (All) +Aliases: +Accepted values: Incremental, Complete + +Required: False +Position: Named +Default value: Incremental +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. "20131223140835". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProceedIfNoChange +Do not ask for confirmation if there is no changes in the What-If result. Applicable when the -Confirm switch is set. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to deploy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RollBackDeploymentName +Rollback to the successful deployment with the given name in the resource group, should not be used if -RollbackToLastDeployment is used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RollbackToLastDeployment +Rollback to the last successful deployment in the resource group, should not be present if -RollBackDeploymentName is used. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to put on the deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +Specifies the full path of a custom template file. Supported template file type: json and bicep. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateObject +A hash table which represents the template. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateObjectAndParameterFile, ByTemplateObjectAndParameterUri, ByTemplateObjectWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +Specifies the full path of a JSON file that contains the names and values of the template parameters. +If a template has parameters, you must specify the parameter values with the *TemplateParameterFile* parameter or the *TemplateParameterObject* parameter. +Template parameters are dynamically added to the command when you specify a template. +To use the dynamic parameters, type a minus sign (-) to indicate a parameter name and then use the Tab key to cycle through the available parameters. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterFile, ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile, ByTemplateSpecResourceIdAndParams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +Specifies a hash table of template parameter names and values. +For help with hash tables in Windows PowerShell, type `Get-Help about_Hash_Tables`. +If a template has parameters, you must specify parameter values. +Template parameters are dynamically added to the command when you specify a template. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Specifies the URI of a template parameters file. When using TemplateParameterUri any dynamic parameters that you use are disregarded. To use dynamic parameters you must instead use the *TemplateParameterFile* parameter + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterUri, ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri, ByTemplateSpecResourceIdAndParamsUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +Resource ID of the templateSpec to be deployed. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Specifies the URI of a custom template file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIfExcludeChangeType +Comma-separated resource change types to be excluded from What-If results. Applicable when the -WhatIf or -Confirm switch is set. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIfResultFormat +The What-If result format. + +```yaml +Type: Microsoft.Azure.Management.ResourceManager.Models.WhatIfResultFormat +Parameter Sets: (All) +Aliases: +Accepted values: ResourceIdOnly, FullResourcePayloads + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceGroupDeployment + +## NOTES + +## RELATED LINKS + +[Get-AzResourceGroupDeployment](./Get-AzResourceGroupDeployment.md) + +[New-AzResource](./New-AzResource.md) + +[New-AzResourceGroup](./New-AzResourceGroup.md) + +[Remove-AzResourceGroupDeployment](./Remove-AzResourceGroupDeployment.md) + +[Stop-AzResourceGroupDeployment](./Stop-AzResourceGroupDeployment.md) + +[Test-AzResourceGroupDeployment](./Test-AzResourceGroupDeployment.md) diff --git a/azps-10.1.0/Az.Resources/New-AzResourceGroupDeploymentStack.md b/azps-10.1.0/Az.Resources/New-AzResourceGroupDeploymentStack.md new file mode 100644 index 0000000000..e803c9a7b0 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzResourceGroupDeploymentStack.md @@ -0,0 +1,544 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/New-AzResourceGroupDeploymentStack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzResourceGroupDeploymentStack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzResourceGroupDeploymentStack.md +--- + +# New-AzResourceGroupDeploymentStack + +## SYNOPSIS +Creates a new Resource Group scoped Deployment Stack. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +New-AzResourceGroupDeploymentStack -Name <String> -ResourceGroupName <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileWithParameterFile +``` +New-AzResourceGroupDeploymentStack -Name <String> -ResourceGroupName <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateFile <String> + -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileWithParameterUri +``` +New-AzResourceGroupDeploymentStack -Name <String> -ResourceGroupName <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateFile <String> + -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileWithParameterObject +``` +New-AzResourceGroupDeploymentStack -Name <String> -ResourceGroupName <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateFile <String> + -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithParameterFile +``` +New-AzResourceGroupDeploymentStack -Name <String> -ResourceGroupName <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateUri <String> + -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithParameterUri +``` +New-AzResourceGroupDeploymentStack -Name <String> -ResourceGroupName <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateUri <String> + -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithParameterObject +``` +New-AzResourceGroupDeploymentStack -Name <String> -ResourceGroupName <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateUri <String> + -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +New-AzResourceGroupDeploymentStack -Name <String> -ResourceGroupName <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterFile +``` +New-AzResourceGroupDeploymentStack -Name <String> -ResourceGroupName <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateSpecId <String> + -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterUri +``` +New-AzResourceGroupDeploymentStack -Name <String> -ResourceGroupName <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateSpecId <String> + -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterObject +``` +New-AzResourceGroupDeploymentStack -Name <String> -ResourceGroupName <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateSpecId <String> + -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithNoParameters +``` +New-AzResourceGroupDeploymentStack -Name <String> -ResourceGroupName <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a resource group scoped deployment stack. + +## EXAMPLES + +### Example 1: Create the stack MyRGStack in the Resource Group MyResourceGroup +```powershell +New-AzResourceGroupDeploymentStack -Name MyRGStack -ResourceGroupName MyResourceGroup -TemplateFile myTemplate.json -DenySettingsMode DenyDelete +``` + +Create a new resource group scoped deployment stack named 'MyRGStack' in management group 'MyResoourceGroup,' with deny settings being DenyDelete. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteAll +Signal to delete both unmanaged Resources and ResourceGroups after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResourceGroups +Signal to delete unmanaged stack ResourceGroups after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResources +Signal to delete unmanaged stack Resources after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsApplyToChildScopes +Apply to child scopes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsExcludedAction +List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsExcludedPrincipal +List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsMode +Mode for DenySettings. +Possible values include: 'denyDelete', 'denyWriteAndDelete', and 'none'. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDenySettingsMode +Parameter Sets: (All) +Aliases: +Accepted values: None, DenyDelete, DenyWriteAndDelete + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description for the stack. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation when overwriting an existing stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the DeploymentStack to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StackName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the ResourceGroup to be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to put on the deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +TemplateFile to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileWithParameterFile, ByTemplateFileWithParameterUri, ByTemplateFileWithParameterObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +Parameter file to use for the template. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithParameterFile, ByTemplateUriWithParameterFile, ByTemplateSpecWithParameterFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateFileWithParameterObject, ByTemplateUriWithParameterObject, ByTemplateSpecWithParameterObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Location of the Parameter file to use for the template. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithParameterUri, ByTemplateUriWithParameterUri, ByTemplateSpecWithParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +ResourceId of the TemplateSpec to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecWithParameterFile, ByTemplateSpecWithParameterUri, ByTemplateSpecWithParameterObject, ByTemplateSpecWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Location of the Template to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriWithParameterFile, ByTemplateUriWithParameterUri, ByTemplateUriWithParameterObject, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStack + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzResourceLock.md b/azps-10.1.0/Az.Resources/New-AzResourceLock.md new file mode 100644 index 0000000000..1e86f93225 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzResourceLock.md @@ -0,0 +1,324 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 6847ECFD-2E3D-46F6-ABE9-9D8E08C7858F +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azresourcelock +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzResourceLock.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzResourceLock.md +--- + +# New-AzResourceLock + +## SYNOPSIS +Creates a resource lock. + +## SYNTAX + +### BySpecifiedScope (Default) +``` +New-AzResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] -Scope <String> + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceGroup +``` +New-AzResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] + -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceGroupLevel +``` +New-AzResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] + -ResourceName <String> -ResourceType <String> -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BySubscription +``` +New-AzResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BySubscriptionLevel +``` +New-AzResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] + -ResourceName <String> -ResourceType <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByLockId +``` +New-AzResourceLock -LockLevel <LockLevel> [-LockNotes <String>] [-Force] -LockId <String> + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzResourceLock** cmdlet creates a resource lock. + +## EXAMPLES + +### Example 1: Create a resource lock on a website +```powershell +New-AzResourceLock -LockLevel CanNotDelete -LockNotes "My lock notes" -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites" +``` + +This command creates a resource lock on a website. + +### Example 2: Create a resource lock on a database +```powershell +New-AzResourceLock -LockLevel CanNotDelete -LockNotes "Lock note" -LockName "db-lock" -ResourceName "server1/ContosoDB" -ResourceGroupName "RG1" -ResourceType "Microsoft.Sql/servers/databases" +``` + +This command creates a resource lock on a Azure database. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LockId +Specifies the ID of the lock. + +```yaml +Type: System.String +Parameter Sets: ByLockId +Aliases: Id, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LockLevel +Specifies the level for the lock. +Currently, valid values are CanNotDelete, ReadOnly. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Locks.LockLevel +Parameter Sets: (All) +Aliases: Level +Accepted values: CanNotDelete, ReadOnly + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LockName +Specifies the name of the lock. + +```yaml +Type: System.String +Parameter Sets: BySpecifiedScope, ByResourceGroup, ByResourceGroupLevel, BySubscription, BySubscriptionLevel +Aliases: ExtensionResourceName, Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LockNotes +Specifies the notes for the lock. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Notes + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group for which the lock applies or that contains the resource group for which the lock applies. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup, ByResourceGroupLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +Specifies the name of the resource for which the lock applies. +For instance, to specify a database, use the following format: +`ContosoServer/ContosoDatabase` + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +Specifies the resource type of the resource for which the lock applies. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Specifies the scope to which the lock applies. +For instance, to specify a database, use the following format: +`/subscriptions/`subscription ID`/resourceGroups/`resource group name`/providers/Microsoft.Sql/servers/`server name`/databases/`database name +To specify a resource group, use the following format: +`/subscriptions/`subscription ID`/resourceGroups/`resource group name + +```yaml +Type: System.String +Parameter Sets: BySpecifiedScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Locks.LockLevel + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS + +[Get-AzResourceLock](./Get-AzResourceLock.md) + +[Remove-AzResourceLock](./Remove-AzResourceLock.md) + +[Set-AzResourceLock](./Set-AzResourceLock.md) + + diff --git a/azps-10.1.0/Az.Resources/New-AzResourceManagementPrivateLink.md b/azps-10.1.0/Az.Resources/New-AzResourceManagementPrivateLink.md new file mode 100644 index 0000000000..f6462f6d75 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzResourceManagementPrivateLink.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azresourcemanagementprivatelink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzResourceManagementPrivateLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzResourceManagementPrivateLink.md +--- + +# New-AzResourceManagementPrivateLink + +## SYNOPSIS +Create Azure Resource Management Private Link + +## SYNTAX + +``` +New-AzResourceManagementPrivateLink [[-ResourceGroupName] <String>] [-Name] <String> [-Location] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzResourceManagementPrivateLink cmdlet create a specific resource management private link. + +## EXAMPLES + +### Example 1 +```powershell +New-AzResourceManagementPrivateLink -ResourceGroupName PrivateLinkTestRG -Name NewPL +``` + +```output +Id : /subscriptions/aeb49941-36c3-4e7c-9ffd-16ba89d33ec4/resourceGroups/PrivateLinkTestRG/provi + ders/Microsoft.Authorization/resourceManagementPrivateLinks/NewPL +Type : Microsoft.Authorization/resourceManagementPrivateLinks +Name : NewPL +Location : centralus +PrivateEndpointConnections : {} +``` + +Create the resource management private link. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The private link location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the private link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PrivateLinkName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.PrivateLinks.PSResourceManagementPrivateLink + +## NOTES + +## RELATED LINKS + +[Remove-AzResourceManagementPrivateLink](./Remove-AzResourceManagementPrivateLink.md) +[Get-AzResourceManagementPrivateLink](./Get-AzResourceManagementPrivateLink.md) diff --git a/azps-10.1.0/Az.Resources/New-AzRoleAssignment.md b/azps-10.1.0/Az.Resources/New-AzRoleAssignment.md new file mode 100644 index 0000000000..19c78b580c --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzRoleAssignment.md @@ -0,0 +1,479 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +ms.assetid: E460D108-2BF9-4F57-AF3D-13868DC73EA0 +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzRoleAssignment.md +--- + +# New-AzRoleAssignment + +## SYNOPSIS +Assigns the specified RBAC role to the specified principal, at the specified scope. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /users/{id} +- GET /servicePrincipals/{id} +- GET /groups/{id} +- GET /directoryObjects/{id} + +Please notice that this cmdlet will mark `ObjectType` as `Unknown` in output if the object of role assignment is not found or current account has insufficient privileges to get object type. + +## SYNTAX + +### EmptyParameterSet (Default) +``` +New-AzRoleAssignment -ObjectId <String> [-Scope <String>] -RoleDefinitionName <String> [-Description <String>] + [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>] [-AllowDelegation] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupWithObjectIdParameterSet +``` +New-AzRoleAssignment -ObjectId <String> -ResourceGroupName <String> -RoleDefinitionName <String> + [-Description <String>] [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>] + [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceWithObjectIdParameterSet +``` +New-AzRoleAssignment -ObjectId <String> -ResourceGroupName <String> -ResourceName <String> + -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-Description <String>] + [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>] [-AllowDelegation] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RoleIdWithScopeAndObjectIdParameterSet +``` +New-AzRoleAssignment -ObjectId <String> -Scope <String> [-Description <String>] [-Condition <String>] + [-ConditionVersion <String>] [-ObjectType <String>] -RoleDefinitionId <Guid> [-AllowDelegation] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupWithSignInNameParameterSet +``` +New-AzRoleAssignment -SignInName <String> -ResourceGroupName <String> -RoleDefinitionName <String> + [-Description <String>] [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>] + [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceWithSignInNameParameterSet +``` +New-AzRoleAssignment -SignInName <String> -ResourceGroupName <String> -ResourceName <String> + -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-Description <String>] + [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>] [-AllowDelegation] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ScopeWithSignInNameParameterSet +``` +New-AzRoleAssignment -SignInName <String> [-Scope <String>] -RoleDefinitionName <String> + [-Description <String>] [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>] + [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupWithSPNParameterSet +``` +New-AzRoleAssignment -ApplicationId <String> -ResourceGroupName <String> -RoleDefinitionName <String> + [-Description <String>] [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>] + [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceWithSPNParameterSet +``` +New-AzRoleAssignment -ApplicationId <String> -ResourceGroupName <String> -ResourceName <String> + -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-Description <String>] + [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>] [-AllowDelegation] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ScopeWithSPNParameterSet +``` +New-AzRoleAssignment -ApplicationId <String> [-Scope <String>] -RoleDefinitionName <String> + [-Description <String>] [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>] + [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputFileParameterSet +``` +New-AzRoleAssignment -InputFile <String> [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Use the New-AzRoleAssignment command to grant access. +Access is granted by assigning the appropriate RBAC role to them at the right scope. +To grant access to the entire subscription, assign a role at the subscription scope. +To grant access to a specific resource group within a subscription, assign a role at the resource group scope. +The subject of the assignment must be specified. +To specify a user, use SignInName or Azure AD ObjectId parameters. +To specify a security group, use Azure AD ObjectId parameter. +And to specify an Azure AD application, use ApplicationId or ObjectId parameters. +The role that is being assigned must be specified using the RoleDefinitionName parameter. +The scope at which access is being granted may be specified. +It defaults to the selected subscription. +The scope of the assignment can be specified using one of the following parameter combinations + a. +Scope - This is the fully qualified scope starting with /subscriptions/\<subscriptionId\> + b. +ResourceGroupName - to grant access to the specified resource group. + c. +ResourceName, ResourceType, ResourceGroupName and (optionally) ParentResource - to specify a particular resource within a resource group to grant access to. + +## EXAMPLES + +### Example 1 +```powershell +New-AzRoleAssignment -ResourceGroupName rg1 -SignInName allen.young@live.com -RoleDefinitionName Reader -AllowDelegation +``` + +Grant Reader role access to a user at a resource group scope with the Role Assignment being available for delegation + +### Example 2 +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +Get-AzADGroup -SearchString "Christine Koch Team" + + DisplayName Type Id + ----------- ---- -------- + Christine Koch Team 2f9d4375-cbf1-48e8-83c9-2a0be4cb33fb + +New-AzRoleAssignment -ObjectId 2f9d4375-cbf1-48e8-83c9-2a0be4cb33fb -RoleDefinitionName Contributor -ResourceGroupName rg1 +``` + +Grant access to a security group + +### Example 3 +```powershell +New-AzRoleAssignment -SignInName john.doe@contoso.com -RoleDefinitionName Owner -Scope "/subscriptions/86f81fc3-b00f-48cd-8218-3879f51ff362/resourcegroups/rg1/providers/Microsoft.Web/sites/site1" +``` + +Grant access to a user at a resource (website) + +### Example 4 +```powershell +New-AzRoleAssignment -ObjectId 5ac84765-1c8c-4994-94b2-629461bd191b -RoleDefinitionName "Virtual Machine Contributor" -ResourceName Devices-Engineering-ProjectRND -ResourceType Microsoft.Network/virtualNetworks/subnets -ParentResource virtualNetworks/VNET-EASTUS-01 -ResourceGroupName Network +``` + +Grant access to a group at a nested resource (subnet) + +### Example 5 +```powershell +$servicePrincipal = New-AzADServicePrincipal -DisplayName "testServiceprincipal" +New-AzRoleAssignment -RoleDefinitionName "Reader" -ApplicationId $servicePrincipal.ApplicationId +``` + +Grant reader access to a service principal + +## PARAMETERS + +### -AllowDelegation +The delegation flag while creating a Role assignment. + +```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 +``` + +### -ApplicationId +The Application ID of the ServicePrincipal + +```yaml +Type: System.String +Parameter Sets: ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet +Aliases: SPN, ServicePrincipalName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Condition +Condition to be applied to the RoleAssignment. + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, RoleIdWithScopeAndObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConditionVersion +Version of the condition. + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, RoleIdWithScopeAndObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Brief description of the role assignment. + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, RoleIdWithScopeAndObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputFile +Path to role assignment json + +```yaml +Type: System.String +Parameter Sets: InputFileParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ObjectId +Azure AD Objectid of the user, group or service principal. + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, RoleIdWithScopeAndObjectIdParameterSet +Aliases: Id, PrincipalId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ObjectType +To be used with ObjectId. Specifies the type of the asignee object + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, RoleIdWithScopeAndObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet +Aliases: PrincipalType + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentResource +The parent resource in the hierarchy(of the resource specified using ResourceName parameter). +Should only be used in conjunction with ResourceGroupName, ResourceType and ResourceName parameters to construct a hierarchical scope in the form of a relative URI that identifies a resource. + +```yaml +Type: System.String +Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. +Creates an assignment that is effective at the specified resource group. +When used in conjunction with ResourceName, ResourceType and (optionally)ParentResource parameters, the command constructs a hierarchical scope in the form of a relative URI that identifies a resource. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +The resource name. +For e.g. +storageaccountprod. +Should only be used in conjunction with ResourceGroupName, ResourceType and (optionally)ParentResource parameters to construct a hierarchical scope in the form of a relative URI that identifies a resource. + +```yaml +Type: System.String +Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. +For e.g. +Microsoft.Network/virtualNetworks. +Should only be used in conjunction with ResourceGroupName, ResourceName and (optionally)ParentResource parameters to construct a hierarchical scope in the form of a relative URI that identifies a resource. + +```yaml +Type: System.String +Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoleDefinitionId +Id of the RBAC role that needs to be assigned to the principal. + +```yaml +Type: System.Guid +Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoleDefinitionName +Name of the RBAC role that needs to be assigned to the principal i.e. +Reader, Contributor, Virtual Network Administrator, etc. + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +The Scope of the role assignment. +In the format of relative URI. +For e.g. +"/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG". +If not specified, will create the role assignment at subscription level. +If specified, it should start with "/subscriptions/{id}". + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet, ScopeWithSignInNameParameterSet, ScopeWithSPNParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SignInName +The email address or the user principal name of the user. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet +Aliases: Email, UserPrincipalName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment + +## RELATED LINKS + +[Get-AzRoleAssignment](./Get-AzRoleAssignment.md) + +[Remove-AzRoleAssignment](./Remove-AzRoleAssignment.md) + +[Get-AzRoleDefinition](./Get-AzRoleDefinition.md) diff --git a/azps-10.1.0/Az.Resources/New-AzRoleAssignmentScheduleRequest.md b/azps-10.1.0/Az.Resources/New-AzRoleAssignmentScheduleRequest.md new file mode 100644 index 0000000000..0d8e1a4f61 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzRoleAssignmentScheduleRequest.md @@ -0,0 +1,420 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azroleassignmentschedulerequest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzRoleAssignmentScheduleRequest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzRoleAssignmentScheduleRequest.md +--- + +# New-AzRoleAssignmentScheduleRequest + +## SYNOPSIS +Creates a role assignment schedule request. + +## SYNTAX + +``` +New-AzRoleAssignmentScheduleRequest -Name <String> -Scope <String> [-Condition <String>] + [-ConditionVersion <String>] [-ExpirationDuration <String>] [-ExpirationEndDateTime <DateTime>] + [-ExpirationType <Type>] [-Justification <String>] [-LinkedRoleEligibilityScheduleId <String>] + [-PrincipalId <String>] [-RequestType <RequestType>] [-RoleDefinitionId <String>] + [-ScheduleInfoStartDateTime <DateTime>] [-TargetRoleAssignmentScheduleId <String>] + [-TargetRoleAssignmentScheduleInstanceId <String>] [-TicketNumber <String>] [-TicketSystem <String>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a role assignment schedule request. + +## EXAMPLES + +### Example 1: Create a new role assignment schedule request as Admin +```powershell +$guid = "12f8978c-5d8d-4fbf-b4b6-2f43eeb43eca" +$startTime = Get-Date -Format o +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +New-AzRoleAssignmentScheduleRequest -Name $guid -Scope $scope -ExpirationDuration PT1H -ExpirationType AfterDuration -PrincipalId 5a4bdd72-ab3e-4d8e-ab0f-8dd8917481a2 -RequestType AdminAssign -RoleDefinitionId subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7 -ScheduleInfoStartDateTime $startTime +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +12f8978c-5d8d-4fbf-b4b6-2f43eeb43eca Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authori… +``` + +Creates a request to provision an active assignment of `roleDefinition` on the `scope` for the specified `principal` + +### Example 2: Remove a role assignment schedule request as Admin +```powershell +$guid = "13f8978c-5d8d-4fbf-b4b6-2f43eeb43eca" +$startTime = Get-Date -Format o +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +New-AzRoleAssignmentScheduleRequest -Name $guid -Scope $scope -ExpirationDuration PT1H -ExpirationType AfterDuration -PrincipalId 5a4bdd72-ab3e-4d8e-ab0f-8dd8917481a2 -RequestType AdminRemove -RoleDefinitionId subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7 -ScheduleInfoStartDateTime $startTime +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +13f8978c-5d8d-4fbf-b4b6-2f43eeb43eca Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authori… +``` + +Creates a request to remove an active assignment of `roleDefinition` on the `scope` for the specified `principal` + +### Example 3: Activate a new role assignment schedule request as user +```powershell +$guid = "12f8978c-5d8d-4fbf-b4b6-2f43eeb43eca" +$startTime = Get-Date -Format o +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +New-AzRoleAssignmentScheduleRequest -Name $guid -Scope $scope -ExpirationDuration PT1H -ExpirationType AfterDuration -PrincipalId 5a4bdd72-ab3e-4d8e-ab0f-8dd8917481a2 -RequestType SelfActivate -RoleDefinitionId subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7 -ScheduleInfoStartDateTime $startTime +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +12f8978c-5d8d-4fbf-b4b6-2f43eeb43eca Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authori… +``` + +Creates a request to activate an eligible assignment of `roleDefinition` on the `scope` for the specified `principal` + +### Example 4: Deactivate a role assignment schedule request as user +```powershell +$guid = "12f8978c-5d8d-4fbf-b4b6-2f43eeb43eca" +$startTime = Get-Date -Format o +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +New-AzRoleAssignmentScheduleRequest -Name $guid -Scope $scope -ExpirationDuration PT1H -ExpirationType AfterDuration -PrincipalId 5a4bdd72-ab3e-4d8e-ab0f-8dd8917481a2 -RequestType SelfDeactivate -RoleDefinitionId subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7 -ScheduleInfoStartDateTime $startTime +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +12f8978c-5d8d-4fbf-b4b6-2f43eeb43eca Microsoft.Authorization/roleAssignmentScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authori… +``` + +Creates a request to deactivate an eligible assignment of `roleDefinition` on the `scope` for the specified `principal` + +## PARAMETERS + +### -Condition +The conditions on the role assignment. +This limits the resources it can be assigned to. +e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionVersion +Version of the condition. +Currently accepted value is '2.0' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDuration +Duration of the role assignment schedule in TimeSpan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationEndDateTime +End DateTime of the role assignment schedule. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationType +Type of the role assignment schedule expiration + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Support.Type +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Justification +Justification for the role assignment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedRoleEligibilityScheduleId +The linked role eligibility schedule id - to activate an eligibility. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the role assignment to create. +It can be any valid GUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RoleAssignmentScheduleRequestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalId +The principal ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestType +The type of the role assignment schedule request. +Eg: SelfActivate, AdminAssign etc + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Support.RequestType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +The role definition ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInfoStartDateTime +Start DateTime of the role assignment schedule. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role assignment schedule request to create. +The scope can be any REST resource instance. +For example, use '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/' for a subscription, '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetRoleAssignmentScheduleId +The resultant role assignment schedule id or the role assignment schedule id being updated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetRoleAssignmentScheduleInstanceId +The role assignment schedule instance id being updated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TicketNumber +Ticket number for the role assignment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TicketSystem +Ticket system name for the role assignment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IRoleAssignmentScheduleRequest + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzRoleDefinition.md b/azps-10.1.0/Az.Resources/New-AzRoleDefinition.md new file mode 100644 index 0000000000..4ee56d929b --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzRoleDefinition.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 8300B143-E322-419E-BC98-DBA56DD90A59 +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzRoleDefinition.md +--- + +# New-AzRoleDefinition + +## SYNOPSIS +Creates a custom role in Azure RBAC. +Provide either a JSON role definition file or a PSRoleDefinition object as input. +First, use the Get-AzRoleDefinition command to generate a baseline role definition object. +Then, modify its properties as required. +Finally, use this command to create a custom role using role definition. + +## SYNTAX + +### InputFileParameterSet +``` +New-AzRoleDefinition [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RoleDefinitionParameterSet +``` +New-AzRoleDefinition [-Role] <PSRoleDefinition> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzRoleDefinition cmdlet creates a custom role in Azure Role-Based Access Control. +Provide a role definition as an input to the command as a JSON file or a PSRoleDefinition object. +The input role definition MUST contain the following properties: +1) DisplayName: the name of the custom role +2) Description: a short description of the role that summarizes the access that the role grants. +3) Actions: the set of operations to which the custom role grants access. +Use Get-AzProviderOperation to get the operation for Azure resource providers that can be secured using Azure RBAC. +Following are some valid operation strings: + - "*/read" grants access to read operations of all Azure resource providers. + - "Microsoft.Network/*/read" grants access to read operations for all resource types in the Microsoft.Network resource provider of Azure. + - "Microsoft.Compute/virtualMachines/*" grants access to all operations of virtual machines and its child resource types. +4) AssignableScopes: the set of scopes (Azure subscriptions or resource groups) in which the custom role will be available for assignment. +Using AssignableScopes you can make the custom role available for assignment in only the subscriptions or resource groups that need it, and not clutter the user experience for the rest of the subscriptions or resource groups. +Following are some valid assignable scopes: + - "/subscriptions/c276fc76-9cd4-44c9-99a7-4fd71546436e", "/subscriptions/e91d47c4-76f3-4271-a796-21b4ecfe3624": makes the role available for assignment in two subscriptions. + - "/subscriptions/c276fc76-9cd4-44c9-99a7-4fd71546436e": makes the role available for assignment in a single subscription. + - "/subscriptions/c276fc76-9cd4-44c9-99a7-4fd71546436e/resourceGroups/Network": makes the role available for assignment only in the Network resource group. +The input role definition MAY contain the following properties: +1) NotActions: the set of operations that must be excluded from the Actions to determine the effective actions for the custom role. +If there is a specific operation that you do not wish to grant access to in a custom role, it is convenient to use NotActions to exclude it, rather than specifying all operations other than that specific operation in Actions. +2) DataActions: the set of data operations to which the custom role grants access. +3) NotDataActions: the set of operations that must be excluded from the DataActions to determine the effective data actions for the custom role. +If there is a specific data operation that you do not wish to grant access to in a custom role, it is convenient to use NotDataActions to exclude it, rather than specifying all operations other than that specific operation in Actions. +NOTE: If a user is assigned a role that specifies an operation in NotActions and also assigned another role grants access to the same operation - the user will be able to perform that operation. +NotActions is not a deny rule - it is simply a convenient way to create a set of allowed operations when specific operations need to be excluded. +Following is a sample json role definition that can be provided as input +{ + "Name": "Updated Role", + "Description": "Can monitor all resources and start and restart virtual machines", + "Actions": + \[ + "*/read", + "Microsoft.ClassicCompute/virtualmachines/restart/action", + "Microsoft.ClassicCompute/virtualmachines/start/action" + \], + "NotActions": + \[ + "*/write" + \], + "DataActions": + \[ + "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read" + \], + "NotDataActions": + \[ + "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write" + \], + "AssignableScopes": \["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\] +} + +## EXAMPLES + +### Example 1: Create using PSRoleDefinitionObject +```powershell +$role = Get-AzRoleDefinition -Name "Virtual Machine Contributor" + +$role.Id = $null +$role.Name = "Virtual Machine Operator" +$role.Description = "Can monitor, start, and restart virtual machines." +$role.IsCustom = $True +$role.Actions.RemoveRange(0,$role.Actions.Count) +$role.Actions.Add("Microsoft.Compute/*/read") +$role.Actions.Add("Microsoft.Compute/virtualMachines/start/action") +$role.Actions.Add("Microsoft.Compute/virtualMachines/restart/action") +$role.Actions.Add("Microsoft.Compute/virtualMachines/downloadRemoteDesktopConnectionFile/action") +$role.Actions.Add("Microsoft.Network/*/read") +$role.Actions.Add("Microsoft.Storage/*/read") +$role.Actions.Add("Microsoft.Authorization/*/read") +$role.Actions.Add("Microsoft.Resources/subscriptions/resourceGroups/read") +$role.Actions.Add("Microsoft.Resources/subscriptions/resourceGroups/resources/read") +$role.Actions.Add("Microsoft.Insights/alertRules/*") +$role.Actions.Add("Microsoft.Support/*") +$role.AssignableScopes.Clear() +$role.AssignableScopes.Add("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") + +New-AzRoleDefinition -Role $role +``` + +### Example 2: Create using JSON file +```powershell +New-AzRoleDefinition -InputFile C:\Temp\roleDefinition.json +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +File name containing a single json role definition. + +```yaml +Type: System.String +Parameter Sets: InputFileParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +Role definition object. + +```yaml +Type: Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition +Parameter Sets: RoleDefinitionParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment + +## RELATED LINKS + +[Get-AzProviderOperation](./Get-AzProviderOperation.md) + +[Get-AzRoleDefinition](./Get-AzRoleDefinition.md) + +[Set-AzRoleDefinition](./Set-AzRoleDefinition.md) + +[Remove-AzRoleDefinition](./Remove-AzRoleDefinition.md) + diff --git a/azps-10.1.0/Az.Resources/New-AzRoleEligibilityScheduleRequest.md b/azps-10.1.0/Az.Resources/New-AzRoleEligibilityScheduleRequest.md new file mode 100644 index 0000000000..4edd47e822 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzRoleEligibilityScheduleRequest.md @@ -0,0 +1,373 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azroleeligibilityschedulerequest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzRoleEligibilityScheduleRequest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzRoleEligibilityScheduleRequest.md +--- + +# New-AzRoleEligibilityScheduleRequest + +## SYNOPSIS +Creates a role eligibility schedule request. + +## SYNTAX + +``` +New-AzRoleEligibilityScheduleRequest -Name <String> -Scope <String> [-Condition <String>] + [-ConditionVersion <String>] [-ExpirationDuration <String>] [-ExpirationEndDateTime <DateTime>] + [-ExpirationType <Type>] [-Justification <String>] [-PrincipalId <String>] [-RequestType <RequestType>] + [-RoleDefinitionId <String>] [-ScheduleInfoStartDateTime <DateTime>] + [-TargetRoleEligibilityScheduleId <String>] [-TargetRoleEligibilityScheduleInstanceId <String>] + [-TicketNumber <String>] [-TicketSystem <String>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a role eligibility schedule request. + +## EXAMPLES + +### Example 1: Create a new role eligibile schedule request as Admin +```powershell +$guid = "12f8978c-5d8d-4fbf-b4b6-2f43eeb43eca" +$startTime = Get-Date -Format o +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +New-AzRoleEligibilityScheduleRequest -Name $guid -Scope $scope -ExpirationDuration PT1H -ExpirationType AfterDuration -PrincipalId 5a4bdd72-ab3e-4d8e-ab0f-8dd8917481a2 -RequestType AdminAssign -RoleDefinitionId subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7 -ScheduleInfoStartDateTime $startTime +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +12f8978c-5d8d-4fbf-b4b6-2f43eeb43eca Microsoft.Authorization/roleEligibilityScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authori… +``` + +Creates a request to provision an eligible assignment of `roleDefinition` on the `scope` for the specified `principal` + +### Example 2: Remove a role eligibile schedule request as Admin +```powershell +$guid = "13f8978c-5d8d-4fbf-b4b6-2f43eeb43eca" +$startTime = Get-Date -Format o +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +New-AzRoleEligibilityScheduleRequest -Name $guid -Scope $scope -ExpirationDuration PT1H -ExpirationType AfterDuration -PrincipalId 5a4bdd72-ab3e-4d8e-ab0f-8dd8917481a2 -RequestType AdminRemove -RoleDefinitionId subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7 -ScheduleInfoStartDateTime $startTime +``` + +```output +Name Type Scope RoleDefinitionId +---- ---- ----- ---------------- +13f8978c-5d8d-4fbf-b4b6-2f43eeb43eca Microsoft.Authorization/roleEligibilityScheduleRequests /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/providers/Microsoft.Authori… +``` + +Creates a request to remove an eligible assignment of `roleDefinition` on the `scope` for the specified `principal` + +## PARAMETERS + +### -Condition +The conditions on the role assignment. +This limits the resources it can be assigned to. +e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConditionVersion +Version of the condition. +Currently accepted value is '2.0' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDuration +Duration of the role eligibility schedule in TimeSpan. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationEndDateTime +End DateTime of the role eligibility schedule. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationType +Type of the role eligibility schedule expiration + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Support.Type +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Justification +Justification for the role eligibility + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the role eligibility to create. +It can be any valid GUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RoleEligibilityScheduleRequestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalId +The principal ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestType +The type of the role assignment schedule request. +Eg: SelfActivate, AdminAssign etc + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Support.RequestType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +The role definition ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInfoStartDateTime +Start DateTime of the role eligibility schedule. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role eligibility schedule request to create. +The scope can be any REST resource instance. +For example, use '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/' for a subscription, '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetRoleEligibilityScheduleId +The resultant role eligibility schedule id or the role eligibility schedule id being updated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetRoleEligibilityScheduleInstanceId +The role eligibility schedule instance id being updated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TicketNumber +Ticket number for the role eligibility + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TicketSystem +Ticket system name for the role eligibility + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IRoleEligibilityScheduleRequest + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzRoleManagementPolicyAssignment.md b/azps-10.1.0/Az.Resources/New-AzRoleManagementPolicyAssignment.md new file mode 100644 index 0000000000..03f3a373ad --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzRoleManagementPolicyAssignment.md @@ -0,0 +1,161 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-azrolemanagementpolicyassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzRoleManagementPolicyAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzRoleManagementPolicyAssignment.md +--- + +# New-AzRoleManagementPolicyAssignment + +## SYNOPSIS +Create a role management policy assignment + +## SYNTAX + +``` +New-AzRoleManagementPolicyAssignment -Name <String> -Scope <String> [-PolicyId <String>] + [-RoleDefinitionId <String>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a role management policy assignment + +## EXAMPLES + +### Example 1: Create a new role management policy assignment +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +New-AzRoleManagementPolicyAssignment -Scope $scope -Name "0a4d3ef7-147b-4777-a958-ae9dfab3c331" +``` + +```output +The requested resource does not support http method 'PUT'. +``` + +This operation is currently not supported + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of format {guid_guid} the role management policy assignment to upsert. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RoleManagementPolicyAssignmentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +The policy id role management policy assignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +The role definition of management policy assignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role management policy assignment to upsert. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IRoleManagementPolicyAssignment + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzSubscriptionDeploymentStack.md b/azps-10.1.0/Az.Resources/New-AzSubscriptionDeploymentStack.md new file mode 100644 index 0000000000..ce8a76ff96 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzSubscriptionDeploymentStack.md @@ -0,0 +1,563 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/New-AzSubscriptionDeploymentStack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzSubscriptionDeploymentStack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzSubscriptionDeploymentStack.md +--- + +# New-AzSubscriptionDeploymentStack + +## SYNOPSIS +Creates a new Subscription scoped Deployment Stack. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +New-AzSubscriptionDeploymentStack [-Name] <String> [-Description <String>] -Location <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-DeploymentResourceGroupName <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileWithParameterFile +``` +New-AzSubscriptionDeploymentStack [-Name] <String> [-Description <String>] -Location <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-DeploymentResourceGroupName <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + -TemplateFile <String> -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileWithParameterUri +``` +New-AzSubscriptionDeploymentStack [-Name] <String> [-Description <String>] -Location <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-DeploymentResourceGroupName <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + -TemplateFile <String> -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileWithParameterObject +``` +New-AzSubscriptionDeploymentStack [-Name] <String> [-Description <String>] -Location <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-DeploymentResourceGroupName <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + -TemplateFile <String> -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriWithParameterFile +``` +New-AzSubscriptionDeploymentStack [-Name] <String> [-Description <String>] -Location <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-DeploymentResourceGroupName <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + -TemplateUri <String> -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithParameterUri +``` +New-AzSubscriptionDeploymentStack [-Name] <String> [-Description <String>] -Location <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-DeploymentResourceGroupName <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + -TemplateUri <String> -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithParameterObject +``` +New-AzSubscriptionDeploymentStack [-Name] <String> [-Description <String>] -Location <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-DeploymentResourceGroupName <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + -TemplateUri <String> -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +New-AzSubscriptionDeploymentStack [-Name] <String> [-Description <String>] -Location <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-DeploymentResourceGroupName <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterFile +``` +New-AzSubscriptionDeploymentStack [-Name] <String> [-Description <String>] -Location <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-DeploymentResourceGroupName <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + -TemplateSpecId <String> -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterUri +``` +New-AzSubscriptionDeploymentStack [-Name] <String> [-Description <String>] -Location <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-DeploymentResourceGroupName <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + -TemplateSpecId <String> -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterObject +``` +New-AzSubscriptionDeploymentStack [-Name] <String> [-Description <String>] -Location <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-DeploymentResourceGroupName <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + -TemplateSpecId <String> -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecWithNoParameters +``` +New-AzSubscriptionDeploymentStack [-Name] <String> [-Description <String>] -Location <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-DeploymentResourceGroupName <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a subscription scoped deployment stack. + +## EXAMPLES + +### Example 1: Create a subscription scoped deployment stack MySubStack at westus location +```powershell +New-AzSubscriptionDeploymentStack -Name MySubStack -TemplateFile myTemplate.json -Location westus -DenySettingsMode DenyDelete +``` + +Create a new subscription scoped deployment stack named 'MySubStack' in the default subscription, with deny settings being DenyDelete. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteAll +Signal to delete both resources and resource groups after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResourceGroups +Signal to delete unmanaged stack resource groups after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResources +Signal to delete unmanaged stack resources after upating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsApplyToChildScopes +Apply to child scopes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsExcludedAction +List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsExcludedPrincipal +List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsMode +Mode for DenySettings. +Possible values include: 'denyDelete', 'denyWriteAndDelete', and 'none'. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDenySettingsMode +Parameter Sets: (All) +Aliases: +Accepted values: None, DenyDelete, DenyWriteAndDelete + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentResourceGroupName +The ResourceGroup at which the deployment will be created. If none is specified, it will default to the subscription level scope of the deployment stack. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description for the stack. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation when overwriting an existing stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the stack. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the deploymentStack to create + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StackName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to put on the deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +TemplateFile to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileWithParameterFile, ByTemplateFileWithParameterUri, ByTemplateFileWithParameterObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +Parameter file to use for the template. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithParameterFile, ByTemplateUriWithParameterFile, ByTemplateSpecWithParameterFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateFileWithParameterObject, ByTemplateUriWithParameterObject, ByTemplateSpecWithParameterObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Location of the Parameter file to use for the template. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithParameterUri, ByTemplateUriWithParameterUri, ByTemplateSpecWithParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +ResourceId of the TemplateSpec to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecWithParameterFile, ByTemplateSpecWithParameterUri, ByTemplateSpecWithParameterObject, ByTemplateSpecWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Location of the Template to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriWithParameterFile, ByTemplateUriWithParameterUri, ByTemplateUriWithParameterObject, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStack + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzTag.md b/azps-10.1.0/Az.Resources/New-AzTag.md new file mode 100644 index 0000000000..730d212c21 --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzTag.md @@ -0,0 +1,344 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Tags.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 23DB0AD2-7EB7-4373-BB8D-BB6CB651DD54 +online version: https://learn.microsoft.com/powershell/module/az.resources/new-aztag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzTag.md +--- + +# New-AzTag + +## SYNOPSIS +Creates a predefined Azure tag or adds values to an existing tag | Creates or updates the entire set of tags on a resource or subscription. + +## SYNTAX + +### CreatePredefinedTagParameterSet +``` +New-AzTag [-Name] <String> [[-Value] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CreateByResourceIdParameterSet +``` +New-AzTag [-ResourceId] <String> [-Tag] <Hashtable> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +**CreatePredefinedTagSet**: The **New-AzTag** cmdlet creates a predefined Azure tag with an optional predefined value. +You can also use it to add additional values to existing predefined tags. +To create a predefined tag, enter a unique tag name. +To add a value to an existing predefined tag, specify the name of the existing tag and the new value. +This cmdlet returns an object that represents the new or modified tag with its values and the number of resources to which it has been applied. +The Azure Tags module that **New-AzTag** is part of can help you manage predefined Azure tags. +An Azure tag is a name-value pair that you can use to categorize your Azure resources and resource groups, such as by department or cost center, or to track notes or comments about the resources and groups. +You can define and apply tags in a single step, but predefined tags let you establish standard, consistent, predictable names and values for the tags in your subscription. +To apply a predefined tag to a resource or resource group, use the *Tag* parameter of the New-AzTag cmdlet. +To search for resource groups with a specified tag name or name and value, use the *Tag* parameter of the Get-AzResourceGroup cmdlet. +Every tag has a name. +The values are optional. +A predefined Azure tag can have multiple values, but when you apply the tag to a resource or resource group, you apply the tag name and only one of its values. +For example, you can create a predefined Department tag with a value for each department, such as Finance, Human Resources, and IT. +When you apply the Department tag to a resource, you apply only one predefined value, such as Finance. + +**CreateByResourceIdParameterSet**: The **New-AzTag** cmdlet with a **ResourceId** creates or updates the entire set of tags on a resource or subscription. +This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags. + +## EXAMPLES + +### Example 1: Create a predefined tag +```powershell +New-AzTag -Name "FY2015" +``` + +```output +Name ValuesTable Count Values +---- ----------- ----- ------ +FY2015 0 {} +``` + +This command creates a predefined tag named FY2015. +This tag has no values. +You can apply a tag with no values to a resource or resource group, or use **New-AzTag** to add values to the tag. +You can also specify a value when you apply the tag to the resource or resource group. + +### Example 2: Create a predefined tag with a value +```powershell +New-AzTag -Name "Department" -Value "Finance" +``` + +```output +Name: Department +Count: 0 +Values: + + Name Count + ========= ===== + Finance 0 +``` + +This command creates a predefined tag named Department with a value of Finance. + +### Example 3: Add a value to a predefined tag +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +New-AzTag -Name "Department" -Value "Finance" + +Name: Department +Count: 0 +Values: + Name Count + ========= ===== + Finance 0 +New-AzTag -Name "Department" -Value "IT" +Name: Department +Count: 0 +Values: + Name Count + ========= ===== + Finance 0 + IT 0 +``` + +These commands create a predefined tag named Department with two values. +If the tag name exists, **New-AzTag** adds the value to the existing tag instead of creating a new one. + +### Example 4: Use a predefined tag +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +New-AzTag -Name "CostCenter" -Value "0001" + +Name: CostCenter +Count: 0 +Values: + Name Count + ========= ===== + 0001 0 + +Set-AzResourceGroup -Name "EngineerBlog" -Tag @{Name="CostCenter";Value="0001"} + +Name: EngineerBlog +Location: East US +Resources: + + Name Type Location + =============== ======================= ======== + EngineerBlog Microsoft.Web/sites West US + EngSvr01 Microsoft.Sql/servers West US + EngDB02 Microsoft.Sql/databases West US +Tags: + Name Value + ========== ===== + CostCenter 0001 + +Get-AzTag -Name "CostCenter" + +Name: CostCenter +Count: 1 +Values: + Name Count + ========= ===== + 0001 1 + +Get-AzResourceGroup -Tag @{Name="CostCenter"} + +Name: EngineerBlog +Location: East US +Resources: + Name Type Location + =============== ======================= ======== + EngineerBlog Microsoft.Web/sites West US + + EngSvr01 Microsoft.Sql/servers West US + EngDB02 Microsoft.Sql/databases West US +Tags: + Name Value + ========== ===== + CostCenter 0001 +``` + +The commands in this example create and use a predefined tag. + +### Example 5: Creates or updates the entire set of tags on a subscription + +```powershell +$Tags = @{"tagKey1"="tagValue1"; "tagKey2"="tagValue2"} +New-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tag $Tags +``` + +```output +Id : {Id} +Name : {Name} +Type : {Type} +Properties : + Name Value + ======= ========= + tagKey1 tagValue1 + tagKey2 tagValue2 +``` + +This command creates or updates the entire set of tags on the subscription with {subId}. + +### Example 6: Creates or updates the entire set of tags on a resource + +```powershell +$Tags = @{"Dept"="Finance"; "Status"="Normal"} +New-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/testrg/providers/Microsoft.Sql/servers/Server1 -Tag $Tags +``` + +```output +Id : {Id} +Name : {Name} +Type : {Type} +Properties : + Name Value + ======= ========= + Dept Finance + Status Normal +``` + +This command creates or updates the entire set of tags on the resource with {resourceId}. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the predefined tag name. +To create a new predefined tag, enter a unique name. +To add a value to an existing tag, enter the name of the existing tag. +If an existing predefined tag has the specified name, **New-AzTag** adds the specified value, if any, to the tag with that name instead of creating a new tag. + +```yaml +Type: System.String +Parameter Sets: CreatePredefinedTagParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier for the entity being tagged. A resource, a resource group or a subscription may be tagged. + +```yaml +Type: System.String +Parameter Sets: CreateByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The tags to put on the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateByResourceIdParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Specifies a predefined tag value. +Predefined tags can have multiple values, but you can enter only one value in each command. +This parameter is optional, because tags can have names without values. + +```yaml +Type: System.String +Parameter Sets: CreatePredefinedTagParameterSet +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Common.Tags.PSTag | Microsoft.Azure.Commands.Tags.Model.PSTagResource + +## NOTES + +## RELATED LINKS + +[Get-AzTag](./Get-AzTag.md) + +[Remove-AzTag](./Remove-AzTag.md) + +[Update-AzTag](./Update-AzTag.md) diff --git a/azps-10.1.0/Az.Resources/New-AzTemplateSpec.md b/azps-10.1.0/Az.Resources/New-AzTemplateSpec.md new file mode 100644 index 0000000000..b2b7ff411d --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzTemplateSpec.md @@ -0,0 +1,326 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-aztemplatespec +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzTemplateSpec.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzTemplateSpec.md +--- + +# New-AzTemplateSpec + +## SYNOPSIS +Creates a new Template Spec. + +## SYNTAX + +### FromJsonStringParameterSet (Default) +``` +New-AzTemplateSpec [-ResourceGroupName] <String> [-Name] <String> -Version <String> [-Description <String>] + [-DisplayName <String>] [-Location <String>] [-Tag <Hashtable>] -TemplateJson <String> + [-VersionDescription <String>] [-Force] [-UIFormDefinitionFile <String>] [-UIFormDefinitionString <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FromJsonFileParameterSet +``` +New-AzTemplateSpec [-ResourceGroupName] <String> [-Name] <String> -Version <String> [-Description <String>] + [-DisplayName <String>] [-Location <String>] [-Tag <Hashtable>] -TemplateFile <String> + [-VersionDescription <String>] [-Force] [-UIFormDefinitionFile <String>] [-UIFormDefinitionString <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Template Spec version with the specified ARM Template content. The content can either come from a raw +JSON string (using **FromJsonStringParameterSet** parameter set) or from a specified JSON/Bicep file +(using **FromJsonFileParameterSet** parameter set). + +If the root Template Spec does not already exist it will be created along with the Template Spec version. If +a Template Spec already exists with the given name, it and the specified version will be updated (any other +existing versions will be preserved). + +## EXAMPLES + +### Example 1 +```powershell +$templateJson = @" +{ + "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#", + "contentVersion": "1.0.0.0", + "parameters": {}, + "resources": [] +} +"@ +New-AzTemplateSpec -ResourceGroupName 'myRG' -Name 'myTemplateSpec' -Version 'v1.0' -Location 'West US' -TemplateJson $templateJson +``` + +Creates a new Template Spec version "v1.0" in a Template Spec named "myTemplateSpec". The specified version +will have $templateJson as the version's ARM Template content. + + **Note:** The ARM Template in the example is a no-op as +it contains no actual resources. + +### Example 2 +```powershell +New-AzTemplateSpec -ResourceGroupName 'myRG' -Name 'myTemplateSpec' -Version 'v2.0' -Location 'West US' -TemplateFile 'myTemplateContent.json' +``` + +Creates a new Template Spec version "v2.0" in a Template Spec named "myTemplateSpec". The specified version +will have the content from the local file "myTemplateContent.json" as the version's ARM Template content. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the template spec. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +The display name of the template spec. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation when overwriting an existing version. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the template spec. Only required if the template spec does not already exist. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the template spec. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Hashtable of tags for the new template spec resource(s). + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +The file path to the local Azure Resource Manager template JSON/Bicep file. + +```yaml +Type: System.String +Parameter Sets: FromJsonFileParameterSet +Aliases: InputFile + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateJson +The Azure Resource Manager template JSON. + +```yaml +Type: System.String +Parameter Sets: FromJsonStringParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UIFormDefinitionFile +UIForm for the templatespec resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UIFormDefinitionString +UIForm for the templatespec resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +The version of the template spec. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VersionDescription +The description of the version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSTemplateSpec + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/New-AzTenantDeployment.md b/azps-10.1.0/Az.Resources/New-AzTenantDeployment.md new file mode 100644 index 0000000000..754124d06c --- /dev/null +++ b/azps-10.1.0/Az.Resources/New-AzTenantDeployment.md @@ -0,0 +1,533 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/new-aztenantdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzTenantDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/New-AzTenantDeployment.md +--- + +# New-AzTenantDeployment + +## SYNOPSIS +Create a deployment at tenant scope + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateFile <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterObject +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterObject <Hashtable> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterObject +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterObject <Hashtable> + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterObject +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterObject <Hashtable> + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterObject <Hashtable> + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterFile +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterFile <String> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterFile +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterFile <String> -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterFile +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterFile <String> -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParams +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterFile <String> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterUri +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterUri <String> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterUri +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterUri <String> -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterUri +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterUri <String> -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsUri +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateParameterUri <String> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateObjectWithNoParameters +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateUri <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecResourceId +``` +New-AzTenantDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] + [-Tag <Hashtable>] [-WhatIfResultFormat <WhatIfResultFormat>] [-WhatIfExcludeChangeType <String[]>] + [-ProceedIfNoChange] [-AsJob] [-QueryString <String>] -TemplateSpecId <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzTenantDeployment** cmdlet adds a deployment at the current tenant scope. + +To add a deployment at tenant scope, specify the location and a template. +The location tells Azure Resource Manager where to store the deployment data. The template is a JSON string that contains individual resources to be deployed. +The template includes parameter placeholders for required resources and configurable property values, such as names and sizes. + +To use a custom template for the deployment, specify the *TemplateFile* parameter or *TemplateUri* parameter. +Each template has parameters for configurable properties. +To specify values for the template parameters, specify the *TemplateParameterFile* parameter or the *TemplateParameterObject* parameter. +Alternatively, you can use the template parameters that are dynamically added to the command when you specify a template. +To use dynamic parameters, type them at the command prompt, or type a minus sign (-) to indicate a parameter and use the Tab key to cycle through available parameters. +Template parameter values that you enter at the command prompt take precedence over values in a template parameter object or file. + +To add resources to a resource group, use the **New-AzResourceGroupDeployment** which creates a deployment at a resource group. +To add resources to a subscription, use the **New-AzSubscriptionDeployment** which creates a deployment at subscription scope, which deploys subscription level resources. +To add resources at a management group, use the **New-AzManagementGroupDeployment** which creates a deployment at a management group. + +## EXAMPLES + +### Example 1: Use a custom template and parameter file to create a deployment +```powershell +New-AzTenantDeployment -Location "West US" -TemplateFile "D:\Azure\Templates\OrgSetup.json" -TemplateParameterFile "D:\Azure\Templates\OrgParms.json" -Tag @{"key1"="value1"; "key2"="value2";} +``` + +This command creates a new deployment at the current tenant scope by using a custom template and a template file on disk, with defined tags parameter. +The command uses the *TemplateFile* parameter to specify the template and the *TemplateParameterFile* parameter to specify a file that contains parameters and parameter values. + +### Example 2: Use a custom template object and parameter file to create a deployment +```powershell +$TemplateFileText = [System.IO.File]::ReadAllText("D:\Azure\Templates\OrgSetup.json") +$TemplateObject = ConvertFrom-Json $TemplateFileText -AsHashtable +New-AzTenantDeployment -Location "West US" -TemplateObject $TemplateObject -TemplateParameterFile "D:\Azure\Templates\OrgParams.json" +``` + +This command creates a new deployment at the current tenant by using a custom template and a template file on disk that has been converted to an in-memory hashtable. +The first two commands read the text for the template file on disk and convert it to an in-memory hashtable. +The last command uses the *TemplateObject* parameter to specify this hashtable and the *TemplateParameterFile* parameter to specify a file that contains parameters and parameter values. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentDebugLogLevel +The deployment debug log level. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location to store deployment data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. "20131223140835". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProceedIfNoChange +Do not ask for confirmation if there is no changes in the What-If result. Applicable when the -Confirm switch is set. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. +This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. +For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to put on the deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +Local path to the template file. Supported template file type: json and bicep. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateObject +A hash table which represents the template. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateObjectAndParameterFile, ByTemplateObjectAndParameterUri, ByTemplateObjectWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +A file that has the template parameters. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterFile, ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile, ByTemplateSpecResourceIdAndParams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Uri to the template parameter file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterUri, ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri, ByTemplateSpecResourceIdAndParamsUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +Resource ID of the templateSpec to be deployed. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Uri to the template file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIfExcludeChangeType +Comma-separated resource change types to be excluded from What-If results. Applicable when the -WhatIf or -Confirm switch is set. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIfResultFormat +The What-If result format. Applicable when the -WhatIf or -Confirm switch is set. + +```yaml +Type: Microsoft.Azure.Management.ResourceManager.Models.WhatIfResultFormat +Parameter Sets: (All) +Aliases: +Accepted values: ResourceIdOnly, FullResourcePayloads + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Hashtable + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Publish-AzBicepModule.md b/azps-10.1.0/Az.Resources/Publish-AzBicepModule.md new file mode 100644 index 0000000000..694b25f41a --- /dev/null +++ b/azps-10.1.0/Az.Resources/Publish-AzBicepModule.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/publish-azbicepmodule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Publish-AzBicepModule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Publish-AzBicepModule.md +--- + +# Publish-AzBicepModule + +## SYNOPSIS +Publishes a Bicep file to a registry. + +## SYNTAX + +``` +Publish-AzBicepModule -FilePath <String> -Target <String> [-DocumentationUri <String>] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Publish-AzBicepModule** cmdlet publishes a Bicep file to a registry as a module. To use the cmdlet, Bicep CLI (version 0.4.1008 or later) must be installed and added to PATH. + +## EXAMPLES + +### Example 1 +```powershell +Publish-AzBicepModule -FilePath 'main.bicep' -Target 'br:{registry}/{moduleName}:{tag}' +``` + +Publishes `main.bicep` to `br:{registry}/{moduleName}:{tag}`. + +### Example 2 +```powershell +Publish-AzBicepModule -FilePath 'main.bicep' -Target 'br:{registry}/{moduleName}:{tag}' -Force +``` + +Publishes `main.bicep` to `br:{registry}/{moduleName}:{tag}`, overwriting existing version. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentationUri +The documentation uri of the Bicep module.. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +Local path to the bicep file to publish. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Allows overwriting of existing module. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a boolean result. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Target +The target location where the bicep file will be published. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Register-AzProviderFeature.md b/azps-10.1.0/Az.Resources/Register-AzProviderFeature.md new file mode 100644 index 0000000000..e3cf0a234d --- /dev/null +++ b/azps-10.1.0/Az.Resources/Register-AzProviderFeature.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 83EE33E5-18EF-4A7A-AEF2-E93D7A3CA541 +online version: https://learn.microsoft.com/powershell/module/az.resources/register-azproviderfeature +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Register-AzProviderFeature.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Register-AzProviderFeature.md +--- + +# Register-AzProviderFeature + +## SYNOPSIS +Registers an Azure provider feature in your current subscription context. + +## SYNTAX + +``` +Register-AzProviderFeature -FeatureName <String> -ProviderNamespace <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Register-AzProviderFeature** cmdlet registers an Azure provider feature in your current subscription context. + +## EXAMPLES + +### Example 1: Register a feature +```powershell +Register-AzProviderFeature -FeatureName AllowApplicationSecurityGroups -ProviderNamespace Microsoft.Network +``` + +This adds the AllowApplicationSecurityGroups feature for Microsoft.Network to your current subscription context. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureName +Specifies the name of the feature that this cmdlet registers. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProviderNamespace +Specifies a namespace for which this cmdlet registers a provider feature. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSProviderFeature + +## NOTES + +## RELATED LINKS + +[Get-AzProviderFeature](./Get-AzProviderFeature.md) + + diff --git a/azps-10.1.0/Az.Resources/Register-AzProviderPreviewFeature.md b/azps-10.1.0/Az.Resources/Register-AzProviderPreviewFeature.md new file mode 100644 index 0000000000..2503453f19 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Register-AzProviderPreviewFeature.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/register-azproviderpreviewfeature +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Register-AzProviderPreviewFeature.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Register-AzProviderPreviewFeature.md +--- + +# Register-AzProviderPreviewFeature + +## SYNOPSIS +Creates a feature registration in your account. + +## SYNTAX + +``` +Register-AzProviderPreviewFeature -Name <String> -ProviderNamespace <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Register-AzProviderPreviewFeature** cmdlet creates a feature registration in your account. + +## EXAMPLES + +### Example 1: Creates a feature registration +```powershell +Register-AzProviderPreviewFeature -FeatureName AllowApplicationSecurityGroups -ProviderNamespace Microsoft.Network +``` + +This adds the AllowApplicationSecurityGroups feature for Microsoft.Network to your account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The feature name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FeatureName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProviderNamespace +The resource provider namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.ResourceManager.Models.SubscriptionFeatureRegistration + +## NOTES + +## RELATED LINKS + +[Get-AzProviderPreviewFeature](./Get-AzProviderPreviewFeature.md) + +[Unregister-AzProviderPreviewFeature](./Unregister-AzProviderPreviewFeature.md) diff --git a/azps-10.1.0/Az.Resources/Register-AzResourceProvider.md b/azps-10.1.0/Az.Resources/Register-AzResourceProvider.md new file mode 100644 index 0000000000..3b789777fe --- /dev/null +++ b/azps-10.1.0/Az.Resources/Register-AzResourceProvider.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: D5067FD8-2FB1-413C-9F59-84E83A74343E +online version: https://learn.microsoft.com/powershell/module/az.resources/register-azresourceprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Register-AzResourceProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Register-AzResourceProvider.md +--- + +# Register-AzResourceProvider + +## SYNOPSIS +Registers a resource provider. + +## SYNTAX + +``` +Register-AzResourceProvider -ProviderNamespace <String> [-ConsentToPermissions <Boolean>] [-AsJob] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Register-AzResourceProvider** cmdlet registers an Azure resource provider. + +## EXAMPLES + +### Example 1: Register a provider +```powershell +Register-AzResourceProvider -ProviderNamespace Microsoft.Network +``` + +This registers the Microsoft.Network provider for your account. + +## PARAMETERS + +### -ApiVersion +Specifies the API version that is supported by the resource Provider. +You can specify a different version than the default version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsentToPermissions +A value indicating whether permissions are consented or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +Specifies the namespace of the resource provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceProvider + +## NOTES + +## RELATED LINKS + +[Get-AzResourceProvider](./Get-AzResourceProvider.md) + +[Unregister-AzResourceProvider](./Unregister-AzResourceProvider.md) + + diff --git a/azps-10.1.0/Az.Resources/Remove-AzADAppCredential.md b/azps-10.1.0/Az.Resources/Remove-AzADAppCredential.md new file mode 100644 index 0000000000..e439815cd0 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzADAppCredential.md @@ -0,0 +1,465 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/Remove-azadappcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADAppCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADAppCredential.md +--- + +# Remove-AzADAppCredential + +## SYNOPSIS +Removes key credentials or password credentials for an application. + +## SYNTAX + +### ApplicationObjectIdWithKeyIdParameterSet (Default) +``` +Remove-AzADAppCredential -ObjectId <String> [-KeyId <Guid>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ApplicationIdWithKeyIdParameterSet +``` +Remove-AzADAppCredential [-KeyId <Guid>] -ApplicationId <Guid> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationDisplayNameParameterSet +``` +Remove-AzADAppCredential [-KeyId <Guid>] -DisplayName <String> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationObjectWithKeyIdParameterSet +``` +Remove-AzADAppCredential [-KeyId <Guid>] -ApplicationObject <IMicrosoftGraphApplication> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes key credentials or password credentials for an application. + +## EXAMPLES + +### Example 1: Remove credentials from application by key id +```powershell +Remove-AzADAppCredential -DisplayName $name -KeyId $keyid +``` + +Remove credentials from application by key id + +### Example 2: Remove all credentials from application +```powershell +Get-AzADApplication -DisplayName $name | Remove-AzADAppCredential +``` + +Remove all credentials from application + +## PARAMETERS + +### -ApplicationId +The application Id. + +```yaml +Type: System.Guid +Parameter Sets: ApplicationIdWithKeyIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationObject +The application object, could be used as pipeline input. +To construct, see NOTES section for APPLICATIONOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication +Parameter Sets: ApplicationObjectWithKeyIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name of application. + +```yaml +Type: System.String +Parameter Sets: ApplicationDisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyId +The key Id of credentials to be removed. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The object Id of application. + +```yaml +Type: System.String +Parameter Sets: ApplicationObjectIdWithKeyIdParameterSet +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +APPLICATIONOBJECT <IMicrosoftGraphApplication>: The application object, could be used as pipeline input. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzADAppFederatedCredential.md b/azps-10.1.0/Az.Resources/Remove-AzADAppFederatedCredential.md new file mode 100644 index 0000000000..fa3bde4eba --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzADAppFederatedCredential.md @@ -0,0 +1,155 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azadappfederatedcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADAppFederatedCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADAppFederatedCredential.md +--- + +# Remove-AzADAppFederatedCredential + +## SYNOPSIS +Delete navigation property federatedIdentityCredentials for applications + +## SYNTAX + +``` +Remove-AzADAppFederatedCredential -ApplicationObjectId <String> -FederatedCredentialId <String> + [-IfMatch <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete navigation property federatedIdentityCredentials for applications + +## EXAMPLES + +### Example 1: Delete federated identity credential for application +```powershell +Remove-AzADAppFederatedCredential -ApplicationObjectId $appObjectId -FederatedCredentialId $credentialId +``` + +Delete federated identity credential for application + +## PARAMETERS + +### -ApplicationObjectId +key: id of application + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedCredentialId +key: id of federatedIdentityCredential + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzADAppPermission.md b/azps-10.1.0/Az.Resources/Remove-AzADAppPermission.md new file mode 100644 index 0000000000..f4adb5a485 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzADAppPermission.md @@ -0,0 +1,147 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azadapppermission +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADAppPermission.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADAppPermission.md +--- + +# Remove-AzADAppPermission + +## SYNOPSIS +Removes an API permission. + +## SYNTAX + +### ObjectIdParameterSet (Default) +``` +Remove-AzADAppPermission -PermissionId <Guid> -ObjectId <Guid> [-DefaultProfile <PSObject>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AppIdParameterSet +``` +Remove-AzADAppPermission -PermissionId <Guid> -ApplicationId <Guid> [-DefaultProfile <PSObject>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes an API permission. + +## EXAMPLES + +### Example 1: Remove API Permission +```powershell +Remove-AzADAppPermission -ObjectId 9cc74d5e-1162-4b90-8696-65f3d6a3f7d0 -PermissionId 5f8c59db-677d-491f-a6b8-5f174b11ec1d +``` + +Remove delegated permission "Group.Read.All" of Microsoft Graph API from AD Application (9cc74d5e-1162-4b90-8696-65f3d6a3f7d0) + +## PARAMETERS + +### -ApplicationId +The unique identifier for the application that is assigned by Azure AD. + +```yaml +Type: System.Guid +Parameter Sets: AppIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The unique identifier in Azure AD. + +```yaml +Type: System.Guid +Parameter Sets: ObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionId +The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzADApplication.md b/azps-10.1.0/Az.Resources/Remove-AzADApplication.md new file mode 100644 index 0000000000..d82dea3a78 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzADApplication.md @@ -0,0 +1,450 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azadapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADApplication.md +--- + +# Remove-AzADApplication + +## SYNOPSIS +Deletes entity from applications + +## SYNTAX + +### ObjectIdParameterSet (Default) +``` +Remove-AzADApplication -ObjectId <String> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ApplicationIdParameterSet +``` +Remove-AzADApplication -ApplicationId <Guid> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ApplicationDisplayNameParameterSet +``` +Remove-AzADApplication -DisplayName <String> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzADApplication -InputObject <IMicrosoftGraphApplication> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes entity from applications + +## EXAMPLES + +### Example 1: Remove application by display name +```powershell +Remove-AzADApplication -DisplayName $name +``` + +Remove application by display name + +### Example 2: Remove application by pipeline input +```powershell +Get-AzADApplication -ObjectId $id | Remove-AzADApplication +``` + +Remove application by pipeline input + +## PARAMETERS + +### -ApplicationId +key: id of application + +```yaml +Type: System.Guid +Parameter Sets: ApplicationIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +key: display name of application + +```yaml +Type: System.String +Parameter Sets: ApplicationDisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The application object, could be used as pipeline input. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ObjectId +key: object id of application + +```yaml +Type: System.String +Parameter Sets: ObjectIdParameterSet +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT <IMicrosoftGraphApplication>: The application object, could be used as pipeline input. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzADGroup.md b/azps-10.1.0/Az.Resources/Remove-AzADGroup.md new file mode 100644 index 0000000000..1d19693e86 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzADGroup.md @@ -0,0 +1,528 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azadgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADGroup.md +--- + +# Remove-AzADGroup + +## SYNOPSIS +Deletes entity from groups. + +## SYNTAX + +### ObjectIdParameterSet (Default) +``` +Remove-AzADGroup -ObjectId <String> [-IfMatch <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### DisplayNameParameterSet +``` +Remove-AzADGroup [-IfMatch <String>] -DisplayName <String> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzADGroup [-IfMatch <String>] -InputObject <IMicrosoftGraphGroup> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes entity from groups. + +## EXAMPLES + +### Example 1: Remove group by display name +```powershell +Remove-AzADGroup -DisplayName $name +``` + +Remove group by display name + +### Example 2: Remove group by pipeline input +```powershell +Get-AzADGroup -ObjectId $id | Remove-AzADGroup +``` + +Remove group by pipeline input + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name of the group to be removed. + +```yaml +Type: System.String +Parameter Sets: DisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +user input object +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ObjectId +key: id of group + +```yaml +Type: System.String +Parameter Sets: ObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT <IMicrosoftGraphGroup>: user input object + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]`: Represents the app roles a group has been granted for an application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[CreatedDateTime <DateTime?>]`: The time when the app role assignment was created.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[PrincipalDisplayName <String>]`: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith). + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[PrincipalType <String>]`: The type of the assigned principal. This can either be User, Group or ServicePrincipal. Read-only. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[Classification <String>]`: Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[AccountEnabled <Boolean?>]`: true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in). + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. + - `[AlternativeName <String[]>]`: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, NOT, ge, le, startsWith). + - `[AppDescription <String>]`: The description exposed by the associated application. + - `[AppDisplayName <String>]`: The display name exposed by the associated application. + - `[AppId <String>]`: The unique identifier for the associated application (its appId property). + - `[AppOwnerOrganizationId <String>]`: Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le). + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. + - `[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignment for another app or service, granted to this service principal. Supports $expand. + - `[AppRoleAssignmentRequired <Boolean?>]`: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT). + - `[ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]`: The claimsMappingPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]`: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. + - `[Classification <String>]`: permissionClassificationType + - `[PermissionId <String>]`: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter. + - `[PermissionName <String>]`: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Does not support $filter. + - `[Description <String>]`: Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[Endpoint <IMicrosoftGraphEndpoint[]>]`: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. + - `[Homepage <String>]`: Home page or landing page of the application. + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[LoginUrl <String>]`: Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. + - `[Note <String>]`: Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters. + - `[NotificationEmailAddress <String[]>]`: Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the service principal. Not nullable. + - `[PreferredSingleSignOnMode <String>]`: Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc. + - `[PreferredTokenSigningKeyThumbprint <String>]`: Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions. + - `[ReplyUrl <String[]>]`: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. + - `[SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]`: samlSingleSignOnSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RelayState <String>]`: The relative URI the service provider would redirect to after completion of the single sign-on flow. + - `[ServicePrincipalName <String[]>]`: Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[ServicePrincipalType <String>]`: Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: The tokenIssuancePolicies assigned to this service principal. Supports $expand. + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this service principal. Supports $expand. + - `[TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]`: + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]`: Represents the app roles a group has been granted for an application. Supports $expand. + - `[Classification <String>]`: Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[Description <String>]`: An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[GroupType <String[]>]`: Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT). + - `[HasMembersWithLicenseError <Boolean?>]`: Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). Supports $filter (eq). + - `[IsArchived <Boolean?>]`: + - `[IsAssignableToRole <Boolean?>]`: Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must also be assigned the Directory.AccessAsUser.All permission to set this property. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT). + - `[MailEnabled <Boolean?>]`: Specifies whether the group is mail-enabled. Returned by default. Supports $filter (eq, ne, NOT). + - `[MailNickname <String>]`: The mail alias for the group, unique in the organization. This property must be specified when a group is created. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[MembershipRule <String>]`: The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[MembershipRuleProcessingState <String>]`: Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]`: The permissions that have been granted for a group to a specific application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[ClientAppId <String>]`: ID of the service principal of the Azure AD app that has been granted access. Read-only. + - `[ClientId <String>]`: ID of the Azure AD app that has been granted access. Read-only. + - `[Permission <String>]`: The name of the resource-specific permission. Read-only. + - `[PermissionType <String>]`: The type of permission. Possible values are: Application, Delegated. Read-only. + - `[ResourceAppId <String>]`: ID of the Azure AD app that is hosting the resource. Read-only. + - `[PreferredDataLocation <String>]`: The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default. + - `[PreferredLanguage <String>]`: The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[SecurityEnabled <Boolean?>]`: Specifies whether the group is a security group. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[SecurityIdentifier <String>]`: Security identifier of the group, used in Windows scenarios. Returned by default. + - `[Theme <String>]`: Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default. + - `[Visibility <String>]`: Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. + - `[Description <String>]`: An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[GroupType <String[]>]`: Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT). + - `[HasMembersWithLicenseError <Boolean?>]`: Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). Supports $filter (eq). + - `[IsArchived <Boolean?>]`: + - `[IsAssignableToRole <Boolean?>]`: Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must also be assigned the Directory.AccessAsUser.All permission to set this property. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT). + - `[MailEnabled <Boolean?>]`: Specifies whether the group is mail-enabled. Returned by default. Supports $filter (eq, ne, NOT). + - `[MailNickname <String>]`: The mail alias for the group, unique in the organization. This property must be specified when a group is created. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[MembershipRule <String>]`: The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[MembershipRuleProcessingState <String>]`: Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]`: The permissions that have been granted for a group to a specific application. Supports $expand. + - `[PreferredDataLocation <String>]`: The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default. + - `[PreferredLanguage <String>]`: The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[SecurityEnabled <Boolean?>]`: Specifies whether the group is a security group. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[SecurityIdentifier <String>]`: Security identifier of the group, used in Windows scenarios. Returned by default. + - `[Theme <String>]`: Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default. + - `[Visibility <String>]`: Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzADGroupMember.md b/azps-10.1.0/Az.Resources/Remove-AzADGroupMember.md new file mode 100644 index 0000000000..17e334da5e --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzADGroupMember.md @@ -0,0 +1,570 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azadgroupmember +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADGroupMember.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADGroupMember.md +--- + +# Remove-AzADGroupMember + +## SYNOPSIS +Deletes member from group +Users, contacts, and groups that are members of this group. +HTTP Methods: GET (supported for all groups), POST (supported for security groups and mail-enabled security groups), DELETE (supported only for security groups) Read-only. +Nullable. +Supports $expand. + +## SYNTAX + +### ExplicitParameterSet (Default) +``` +Remove-AzADGroupMember [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MemberObjectIdWithGroupObjectId +``` +Remove-AzADGroupMember -GroupObjectId <String> -MemberObjectId <String[]> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MemberUPNWithGroupObjectIdParameterSet +``` +Remove-AzADGroupMember -GroupObjectId <String> -MemberUserPrincipalName <String[]> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MemberUPNWithGroupObjectParameterSet +``` +Remove-AzADGroupMember -MemberUserPrincipalName <String[]> -GroupObject <MicrosoftGraphGroup> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MemberUPNWithGroupDisplayNameParameterSet +``` +Remove-AzADGroupMember -MemberUserPrincipalName <String[]> -GroupDisplayName <String> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MemberObjectIdWithGroupObject +``` +Remove-AzADGroupMember -MemberObjectId <String[]> -GroupObject <MicrosoftGraphGroup> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MemberObjectIdWithGroupDisplayName +``` +Remove-AzADGroupMember -MemberObjectId <String[]> -GroupDisplayName <String> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes member from group +Users, contacts, and groups that are members of this group. +HTTP Methods: GET (supported for all groups), POST (supported for security groups and mail-enabled security groups), DELETE (supported only for security groups) Read-only. +Nullable. +Supports $expand. + +## EXAMPLES + +### Example 1: Remove members from group +```powershell +$members = @() +$members += (Get-AzADUser -DisplayName $uname).Id +$members += (Get-AzADServicePrincipal -ApplicationId $appid).Id +Get-AzADGroupMember -GroupDisplayName $gname | Remove-AzADGroupMember -MemberObjectId $member +``` + +Remove members from group + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupDisplayName +The display name of target group. + +```yaml +Type: System.String +Parameter Sets: MemberUPNWithGroupDisplayNameParameterSet, MemberObjectIdWithGroupDisplayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupObject +The target group object, could be used as pipeline input. +To construct, see NOTES section for GROUPOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphGroup +Parameter Sets: MemberUPNWithGroupObjectParameterSet, MemberObjectIdWithGroupObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -GroupObjectId +The object Id of target group. + +```yaml +Type: System.String +Parameter Sets: MemberObjectIdWithGroupObjectId, MemberUPNWithGroupObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberObjectId +The object Id of member to be removed from target group. + +```yaml +Type: System.String[] +Parameter Sets: MemberObjectIdWithGroupObjectId, MemberObjectIdWithGroupObject, MemberObjectIdWithGroupDisplayName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberUserPrincipalName +The user principal name of member to be removed from target group. + +```yaml +Type: System.String[] +Parameter Sets: MemberUPNWithGroupObjectIdParameterSet, MemberUPNWithGroupObjectParameterSet, MemberUPNWithGroupDisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.MicrosoftGraphGroup + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +GROUPOBJECT <MicrosoftGraphGroup>: The target group object, could be used as pipeline input. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]`: Represents the app roles a group has been granted for an application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[CreatedDateTime <DateTime?>]`: The time when the app role assignment was created.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[PrincipalDisplayName <String>]`: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith). + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[PrincipalType <String>]`: The type of the assigned principal. This can either be User, Group or ServicePrincipal. Read-only. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[Classification <String>]`: Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[AccountEnabled <Boolean?>]`: true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in). + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. + - `[AlternativeName <String[]>]`: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, NOT, ge, le, startsWith). + - `[AppDescription <String>]`: The description exposed by the associated application. + - `[AppDisplayName <String>]`: The display name exposed by the associated application. + - `[AppId <String>]`: The unique identifier for the associated application (its appId property). + - `[AppOwnerOrganizationId <String>]`: Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le). + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. + - `[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignment for another app or service, granted to this service principal. Supports $expand. + - `[AppRoleAssignmentRequired <Boolean?>]`: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT). + - `[ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]`: The claimsMappingPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]`: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. + - `[Classification <String>]`: permissionClassificationType + - `[PermissionId <String>]`: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter. + - `[PermissionName <String>]`: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Does not support $filter. + - `[Description <String>]`: Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[Endpoint <IMicrosoftGraphEndpoint[]>]`: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. + - `[Homepage <String>]`: Home page or landing page of the application. + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[LoginUrl <String>]`: Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. + - `[Note <String>]`: Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters. + - `[NotificationEmailAddress <String[]>]`: Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the service principal. Not nullable. + - `[PreferredSingleSignOnMode <String>]`: Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc. + - `[PreferredTokenSigningKeyThumbprint <String>]`: Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions. + - `[ReplyUrl <String[]>]`: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. + - `[SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]`: samlSingleSignOnSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RelayState <String>]`: The relative URI the service provider would redirect to after completion of the single sign-on flow. + - `[ServicePrincipalName <String[]>]`: Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[ServicePrincipalType <String>]`: Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: The tokenIssuancePolicies assigned to this service principal. Supports $expand. + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this service principal. Supports $expand. + - `[TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]`: + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]`: Represents the app roles a group has been granted for an application. Supports $expand. + - `[Classification <String>]`: Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[Description <String>]`: An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[GroupType <String[]>]`: Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT). + - `[HasMembersWithLicenseError <Boolean?>]`: Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). Supports $filter (eq). + - `[IsArchived <Boolean?>]`: + - `[IsAssignableToRole <Boolean?>]`: Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must also be assigned the Directory.AccessAsUser.All permission to set this property. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT). + - `[MailEnabled <Boolean?>]`: Specifies whether the group is mail-enabled. Returned by default. Supports $filter (eq, ne, NOT). + - `[MailNickname <String>]`: The mail alias for the group, unique in the organization. This property must be specified when a group is created. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[MembershipRule <String>]`: The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[MembershipRuleProcessingState <String>]`: Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]`: The permissions that have been granted for a group to a specific application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[ClientAppId <String>]`: ID of the service principal of the Azure AD app that has been granted access. Read-only. + - `[ClientId <String>]`: ID of the Azure AD app that has been granted access. Read-only. + - `[Permission <String>]`: The name of the resource-specific permission. Read-only. + - `[PermissionType <String>]`: The type of permission. Possible values are: Application, Delegated. Read-only. + - `[ResourceAppId <String>]`: ID of the Azure AD app that is hosting the resource. Read-only. + - `[PreferredDataLocation <String>]`: The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default. + - `[PreferredLanguage <String>]`: The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[SecurityEnabled <Boolean?>]`: Specifies whether the group is a security group. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[SecurityIdentifier <String>]`: Security identifier of the group, used in Windows scenarios. Returned by default. + - `[Theme <String>]`: Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default. + - `[Visibility <String>]`: Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. + - `[Description <String>]`: An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[GroupType <String[]>]`: Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT). + - `[HasMembersWithLicenseError <Boolean?>]`: Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). Supports $filter (eq). + - `[IsArchived <Boolean?>]`: + - `[IsAssignableToRole <Boolean?>]`: Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must also be assigned the Directory.AccessAsUser.All permission to set this property. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT). + - `[MailEnabled <Boolean?>]`: Specifies whether the group is mail-enabled. Returned by default. Supports $filter (eq, ne, NOT). + - `[MailNickname <String>]`: The mail alias for the group, unique in the organization. This property must be specified when a group is created. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[MembershipRule <String>]`: The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[MembershipRuleProcessingState <String>]`: Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]`: The permissions that have been granted for a group to a specific application. Supports $expand. + - `[PreferredDataLocation <String>]`: The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default. + - `[PreferredLanguage <String>]`: The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[SecurityEnabled <Boolean?>]`: Specifies whether the group is a security group. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[SecurityIdentifier <String>]`: Security identifier of the group, used in Windows scenarios. Returned by default. + - `[Theme <String>]`: Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default. + - `[Visibility <String>]`: Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzADServicePrincipal.md b/azps-10.1.0/Az.Resources/Remove-AzADServicePrincipal.md new file mode 100644 index 0000000000..b1dcd57547 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzADServicePrincipal.md @@ -0,0 +1,780 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azadserviceprincipal +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADServicePrincipal.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADServicePrincipal.md +--- + +# Remove-AzADServicePrincipal + +## SYNOPSIS +Deletes entity from service principal. + +## SYNTAX + +### ObjectIdParameterSet (Default) +``` +Remove-AzADServicePrincipal -ObjectId <String> [-IfMatch <String>] [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationIdParameterSet +``` +Remove-AzADServicePrincipal -ApplicationId <Guid> [-IfMatch <String>] [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SPNParameterSet +``` +Remove-AzADServicePrincipal -ServicePrincipalName <String> [-IfMatch <String>] [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DisplayNameParameterSet +``` +Remove-AzADServicePrincipal -DisplayName <String> [-IfMatch <String>] [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzADServicePrincipal -InputObject <IMicrosoftGraphServicePrincipal> [-IfMatch <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationObjectParameterSet +``` +Remove-AzADServicePrincipal -ApplicationObject <IMicrosoftGraphApplication> [-IfMatch <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes entity from service principal. + +## EXAMPLES + +### Example 1: Remove service principal by display name +```powershell +Remove-AzADServicePrincipal -DisplayName $name +``` + +Remove service principal by display name + +### Example 2: Remove service principal by pipeline input +```powershell +Get-AzADServicePrincipal -ApplicationId $id | Remove-AzADServicePrincipal +``` + +Remove service principal by pipeline input + +## PARAMETERS + +### -ApplicationId +key: application id + +```yaml +Type: System.Guid +Parameter Sets: ApplicationIdParameterSet +Aliases: AppId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationObject +key: application object +To construct, see NOTES section for APPLICATIONOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication +Parameter Sets: ApplicationObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +key: display name + +```yaml +Type: System.String +Parameter Sets: DisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +key: service principal object +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ObjectId +key: id of servicePrincipal + +```yaml +Type: System.String +Parameter Sets: ObjectIdParameterSet +Aliases: ServicePrincipalId, Id, PrincipalId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalName +key: service principal name + +```yaml +Type: System.String +Parameter Sets: SPNParameterSet +Aliases: SPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +APPLICATIONOBJECT <IMicrosoftGraphApplication>: key: application object + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + +INPUTOBJECT <IMicrosoftGraphServicePrincipal>: key: service principal object + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AccountEnabled <Boolean?>]`: true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in). + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[AlternativeName <String[]>]`: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, NOT, ge, le, startsWith). + - `[AppDescription <String>]`: The description exposed by the associated application. + - `[AppDisplayName <String>]`: The display name exposed by the associated application. + - `[AppId <String>]`: The unique identifier for the associated application (its appId property). + - `[AppOwnerOrganizationId <String>]`: Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le). + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignment for another app or service, granted to this service principal. Supports $expand. + - `[AppRoleAssignmentRequired <Boolean?>]`: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT). + - `[ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]`: The claimsMappingPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]`: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. + - `[Classification <String>]`: permissionClassificationType + - `[PermissionId <String>]`: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter. + - `[PermissionName <String>]`: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Does not support $filter. + - `[Description <String>]`: Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[Endpoint <IMicrosoftGraphEndpoint[]>]`: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. + - `[Homepage <String>]`: Home page or landing page of the application. + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[LoginUrl <String>]`: Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. + - `[Note <String>]`: Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters. + - `[NotificationEmailAddress <String[]>]`: Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the service principal. Not nullable. + - `[PreferredSingleSignOnMode <String>]`: Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc. + - `[PreferredTokenSigningKeyThumbprint <String>]`: Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions. + - `[ReplyUrl <String[]>]`: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. + - `[SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]`: samlSingleSignOnSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RelayState <String>]`: The relative URI the service provider would redirect to after completion of the single sign-on flow. + - `[ServicePrincipalName <String[]>]`: Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[ServicePrincipalType <String>]`: Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: The tokenIssuancePolicies assigned to this service principal. Supports $expand. + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this service principal. Supports $expand. + - `[TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]`: + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzADSpCredential.md b/azps-10.1.0/Az.Resources/Remove-AzADSpCredential.md new file mode 100644 index 0000000000..2f31bf6cd7 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzADSpCredential.md @@ -0,0 +1,493 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azadspcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADSpCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADSpCredential.md +--- + +# Remove-AzADSpCredential + +## SYNOPSIS +Removes key credentials or password credentials for an service principal. + +## SYNTAX + +### ObjectIdWithKeyIdParameterSet (Default) +``` +Remove-AzADSpCredential -ObjectId <String> [-KeyId <Guid>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SPNWithKeyIdParameterSet +``` +Remove-AzADSpCredential [-KeyId <Guid>] -ServicePrincipalName <String> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DisplayNameWithKeyIdParameterSet +``` +Remove-AzADSpCredential [-KeyId <Guid>] -DisplayName <String> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ServicePrincipalObjectParameterSet +``` +Remove-AzADSpCredential [-KeyId <Guid>] -ServicePrincipalObject <IMicrosoftGraphServicePrincipal> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes key credentials or password credentials for an service principal. + +## EXAMPLES + +### Example 1: Remove service principal credentials by key id +```powershell +Remove-AzADSpCredential -DisplayName $name -KeyId $keyid +``` + +Remove service principal credentials by key id + +### Example 2: Remove all credentials from service principal +```powershell +Get-AzADServicePrincipal -DisplayName $name | Remove-AzADSpCredential +``` + +Remove all credentials from service principal + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name of service principal. + +```yaml +Type: System.String +Parameter Sets: DisplayNameWithKeyIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyId +The key Id of credentials to be removed. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The object Id of service principal. + +```yaml +Type: System.String +Parameter Sets: ObjectIdWithKeyIdParameterSet +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalName +The service principal name. + +```yaml +Type: System.String +Parameter Sets: SPNWithKeyIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalObject +The service principal object, could be used as pipeline input. +To construct, see NOTES section for SERVICEPRINCIPALOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal +Parameter Sets: ServicePrincipalObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +Remove-AzADServicePrincipalCredential + +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. + + +SERVICEPRINCIPALOBJECT <IMicrosoftGraphServicePrincipal>: The service principal object, could be used as pipeline input. + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AccountEnabled <Boolean?>]`: true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in). + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[AlternativeName <String[]>]`: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, NOT, ge, le, startsWith). + - `[AppDescription <String>]`: The description exposed by the associated application. + - `[AppDisplayName <String>]`: The display name exposed by the associated application. + - `[AppId <String>]`: The unique identifier for the associated application (its appId property). + - `[AppOwnerOrganizationId <String>]`: Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le). + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignment for another app or service, granted to this service principal. Supports $expand. + - `[AppRoleAssignmentRequired <Boolean?>]`: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT). + - `[ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]`: The claimsMappingPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]`: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. + - `[Classification <String>]`: permissionClassificationType + - `[PermissionId <String>]`: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter. + - `[PermissionName <String>]`: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Does not support $filter. + - `[Description <String>]`: Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[Endpoint <IMicrosoftGraphEndpoint[]>]`: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. + - `[Homepage <String>]`: Home page or landing page of the application. + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[LoginUrl <String>]`: Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. + - `[Note <String>]`: Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters. + - `[NotificationEmailAddress <String[]>]`: Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the service principal. Not nullable. + - `[PreferredSingleSignOnMode <String>]`: Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc. + - `[PreferredTokenSigningKeyThumbprint <String>]`: Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions. + - `[ReplyUrl <String[]>]`: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. + - `[SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]`: samlSingleSignOnSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RelayState <String>]`: The relative URI the service provider would redirect to after completion of the single sign-on flow. + - `[ServicePrincipalName <String[]>]`: Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[ServicePrincipalType <String>]`: Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: The tokenIssuancePolicies assigned to this service principal. Supports $expand. + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this service principal. Supports $expand. + - `[TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]`: + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzADUser.md b/azps-10.1.0/Az.Resources/Remove-AzADUser.md new file mode 100644 index 0000000000..f38e4832f4 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzADUser.md @@ -0,0 +1,642 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azaduser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzADUser.md +--- + +# Remove-AzADUser + +## SYNOPSIS +Deletes entity from users. + +## SYNTAX + +### UPNOrObjectIdParameterSet (Default) +``` +Remove-AzADUser -UPNOrObjectId <String> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectIdParameterSet +``` +Remove-AzADUser -ObjectId <String> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UPNParameterSet +``` +Remove-AzADUser -UserPrincipalName <String> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DisplayNameParameterSet +``` +Remove-AzADUser -DisplayName <String> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzADUser -InputObject <IMicrosoftGraphUser> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes entity from users. + +## EXAMPLES + +### Example 1: Remove user by display name +```powershell +Remove-AzADUser -DisplayName $name +``` + +Remove user by display name + +### Example 2: Remove user by pipeline input +```powershell +Get-AzADUser -UserPrincipalName $id | Remove-AzADUser +``` + +Remove user by pipeline input + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +user display name + +```yaml +Type: System.String +Parameter Sets: DisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +user input object +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphUser +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ObjectId +key: id of user + +```yaml +Type: System.String +Parameter Sets: ObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UPNOrObjectId +The userPrincipalName or ObjectId of the user to be deleted. + +```yaml +Type: System.String +Parameter Sets: UPNOrObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +user principal name + +```yaml +Type: System.String +Parameter Sets: UPNParameterSet +Aliases: UPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphUser + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT <IMicrosoftGraphUser>: user input object + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AccountEnabled <Boolean?>]`: true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, NOT, and in). + - `[AgeGroup <String>]`: Sets the age group of the user. Allowed values: null, minor, notAdult and adult. Refer to the legal age group property definitions for further information. Supports $filter (eq, ne, NOT, and in). + - `[ApproximateLastSignInDateTime <DateTime?>]`: The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderBy. + - `[City <String>]`: The city in which the user is located. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[CompanyName <String>]`: The company name which the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length of the company name is 64 characters.Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[ComplianceExpirationDateTime <DateTime?>]`: The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[ConsentProvidedForMinor <String>]`: Sets whether consent has been obtained for minors. Allowed values: null, granted, denied and notRequired. Refer to the legal age group property definitions for further information. Supports $filter (eq, ne, NOT, and in). + - `[Country <String>]`: The country/region in which the user is located; for example, US or UK. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[Department <String>]`: The name for the department in which the user works. Maximum length is 64 characters.Supports $filter (eq, ne, NOT , ge, le, and in operators). + - `[DeviceVersion <Int32?>]`: For internal use only. + - `[EmployeeHireDate <DateTime?>]`: The date and time when the user was hired or will start work in case of a future hire. Supports $filter (eq, ne, NOT , ge, le, in). + - `[EmployeeId <String>]`: The employee identifier assigned to the user by the organization. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[EmployeeOrgData <IMicrosoftGraphEmployeeOrgData>]`: employeeOrgData + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CostCenter <String>]`: The cost center associated with the user. Returned only on $select. Supports $filter. + - `[Division <String>]`: The name of the division in which the user works. Returned only on $select. Supports $filter. + - `[EmployeeType <String>]`: Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[ExternalUserState <String>]`: For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Supports $filter (eq, ne, NOT , in). + - `[ExternalUserStateChangeDateTime <DateTime?>]`: Shows the timestamp for the latest change to the externalUserState property. Supports $filter (eq, ne, NOT , in). + - `[FaxNumber <String>]`: The fax number of the user. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[GivenName <String>]`: The given name (first name) of the user. Maximum length is 64 characters. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[Identity <IMicrosoftGraphObjectIdentity[]>]`: Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value. Supports $filter (eq) only where the signInType is not userPrincipalName. + - `[Issuer <String>]`: Specifies the issuer of the identity, for example facebook.com.For local accounts (where signInType is not federated), this property is the local B2C tenant default domain name, for example contoso.onmicrosoft.com.For external users from other Azure AD organization, this will be the domain of the federated organization, for example contoso.com.Supports $filter. 512 character limit. + - `[IssuerAssignedId <String>]`: Specifies the unique identifier assigned to the user by the issuer. The combination of issuer and issuerAssignedId must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).When signInType is set to: emailAddress, (or a custom string that starts with emailAddress like emailAddress1) issuerAssignedId must be a valid email addressuserName, issuerAssignedId must be a valid local part of an email addressSupports $filter. 100 character limit. + - `[SignInType <String>]`: Specifies the user sign-in types in your directory, such as emailAddress, userName or federated. Here, federated represents a unique identifier for a user from an issuer, that can be in any format chosen by the issuer. Additional validation is enforced on issuerAssignedId when the sign-in type is set to emailAddress or userName. This property can also be set to any custom string. + - `[IsResourceAccount <Boolean?>]`: Do not use - reserved for future use. + - `[JobTitle <String>]`: The user's job title. Maximum length is 128 characters. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[Mail <String>]`: The SMTP address for the user, for example, admin@contoso.com. Changes to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. While this property can contain accent characters, using them can cause access issues with other Microsoft applications for the user. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith). + - `[MailNickname <String>]`: The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[Manager <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[AccountEnabled <Boolean?>]`: true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in). + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. + - `[AlternativeName <String[]>]`: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, NOT, ge, le, startsWith). + - `[AppDescription <String>]`: The description exposed by the associated application. + - `[AppDisplayName <String>]`: The display name exposed by the associated application. + - `[AppId <String>]`: The unique identifier for the associated application (its appId property). + - `[AppOwnerOrganizationId <String>]`: Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le). + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. + - `[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignment for another app or service, granted to this service principal. Supports $expand. + - `[AppRoleAssignmentRequired <Boolean?>]`: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT). + - `[ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]`: The claimsMappingPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]`: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. + - `[Classification <String>]`: permissionClassificationType + - `[PermissionId <String>]`: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter. + - `[PermissionName <String>]`: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Does not support $filter. + - `[Description <String>]`: Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[Endpoint <IMicrosoftGraphEndpoint[]>]`: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. + - `[Homepage <String>]`: Home page or landing page of the application. + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[LoginUrl <String>]`: Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. + - `[Note <String>]`: Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters. + - `[NotificationEmailAddress <String[]>]`: Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the service principal. Not nullable. + - `[PreferredSingleSignOnMode <String>]`: Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc. + - `[PreferredTokenSigningKeyThumbprint <String>]`: Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions. + - `[ReplyUrl <String[]>]`: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. + - `[SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]`: samlSingleSignOnSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RelayState <String>]`: The relative URI the service provider would redirect to after completion of the single sign-on flow. + - `[ServicePrincipalName <String[]>]`: Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[ServicePrincipalType <String>]`: Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: The tokenIssuancePolicies assigned to this service principal. Supports $expand. + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this service principal. Supports $expand. + - `[TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]`: + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[CreatedDateTime <DateTime?>]`: The time when the app role assignment was created.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[PrincipalDisplayName <String>]`: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith). + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[PrincipalType <String>]`: The type of the assigned principal. This can either be User, Group or ServicePrincipal. Read-only. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]`: Represents the app roles a group has been granted for an application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[CreatedDateTime <DateTime?>]`: The time when the app role assignment was created.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[PrincipalDisplayName <String>]`: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith). + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[PrincipalType <String>]`: The type of the assigned principal. This can either be User, Group or ServicePrincipal. Read-only. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[Classification <String>]`: Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[Description <String>]`: An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[GroupType <String[]>]`: Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT). + - `[HasMembersWithLicenseError <Boolean?>]`: Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). Supports $filter (eq). + - `[IsArchived <Boolean?>]`: + - `[IsAssignableToRole <Boolean?>]`: Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must also be assigned the Directory.AccessAsUser.All permission to set this property. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT). + - `[MailEnabled <Boolean?>]`: Specifies whether the group is mail-enabled. Returned by default. Supports $filter (eq, ne, NOT). + - `[MailNickname <String>]`: The mail alias for the group, unique in the organization. This property must be specified when a group is created. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[MembershipRule <String>]`: The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[MembershipRuleProcessingState <String>]`: Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]`: The permissions that have been granted for a group to a specific application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[ClientAppId <String>]`: ID of the service principal of the Azure AD app that has been granted access. Read-only. + - `[ClientId <String>]`: ID of the Azure AD app that has been granted access. Read-only. + - `[Permission <String>]`: The name of the resource-specific permission. Read-only. + - `[PermissionType <String>]`: The type of permission. Possible values are: Application, Delegated. Read-only. + - `[ResourceAppId <String>]`: ID of the Azure AD app that is hosting the resource. Read-only. + - `[PreferredDataLocation <String>]`: The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default. + - `[PreferredLanguage <String>]`: The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[SecurityEnabled <Boolean?>]`: Specifies whether the group is a security group. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[SecurityIdentifier <String>]`: Security identifier of the group, used in Windows scenarios. Returned by default. + - `[Theme <String>]`: Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default. + - `[Visibility <String>]`: Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. + - `[ClientAppId <String>]`: ID of the service principal of the Azure AD app that has been granted access. Read-only. + - `[ClientId <String>]`: ID of the Azure AD app that has been granted access. Read-only. + - `[Permission <String>]`: The name of the resource-specific permission. Read-only. + - `[PermissionType <String>]`: The type of permission. Possible values are: Application, Delegated. Read-only. + - `[ResourceAppId <String>]`: ID of the Azure AD app that is hosting the resource. Read-only. + - `[AccountEnabled <Boolean?>]`: true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, NOT, and in). + - `[AgeGroup <String>]`: Sets the age group of the user. Allowed values: null, minor, notAdult and adult. Refer to the legal age group property definitions for further information. Supports $filter (eq, ne, NOT, and in). + - `[ApproximateLastSignInDateTime <DateTime?>]`: The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderBy. + - `[City <String>]`: The city in which the user is located. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[CompanyName <String>]`: The company name which the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length of the company name is 64 characters.Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[ComplianceExpirationDateTime <DateTime?>]`: The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[ConsentProvidedForMinor <String>]`: Sets whether consent has been obtained for minors. Allowed values: null, granted, denied and notRequired. Refer to the legal age group property definitions for further information. Supports $filter (eq, ne, NOT, and in). + - `[Country <String>]`: The country/region in which the user is located; for example, US or UK. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[Department <String>]`: The name for the department in which the user works. Maximum length is 64 characters.Supports $filter (eq, ne, NOT , ge, le, and in operators). + - `[DeviceVersion <Int32?>]`: For internal use only. + - `[EmployeeHireDate <DateTime?>]`: The date and time when the user was hired or will start work in case of a future hire. Supports $filter (eq, ne, NOT , ge, le, in). + - `[EmployeeId <String>]`: The employee identifier assigned to the user by the organization. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[EmployeeOrgData <IMicrosoftGraphEmployeeOrgData>]`: employeeOrgData + - `[EmployeeType <String>]`: Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[ExternalUserState <String>]`: For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Supports $filter (eq, ne, NOT , in). + - `[ExternalUserStateChangeDateTime <DateTime?>]`: Shows the timestamp for the latest change to the externalUserState property. Supports $filter (eq, ne, NOT , in). + - `[FaxNumber <String>]`: The fax number of the user. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[GivenName <String>]`: The given name (first name) of the user. Maximum length is 64 characters. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[Identity <IMicrosoftGraphObjectIdentity[]>]`: Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value. Supports $filter (eq) only where the signInType is not userPrincipalName. + - `[IsResourceAccount <Boolean?>]`: Do not use - reserved for future use. + - `[JobTitle <String>]`: The user's job title. Maximum length is 128 characters. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[Mail <String>]`: The SMTP address for the user, for example, admin@contoso.com. Changes to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. While this property can contain accent characters, using them can cause access issues with other Microsoft applications for the user. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith). + - `[MailNickname <String>]`: The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[Manager <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[OfficeLocation <String>]`: The office location in the user's place of business. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[OnPremisesImmutableId <String>]`: This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property. Returned only on $select. Supports $filter (eq, ne, NOT, ge, le, in).. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in). + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values). + - `[OperatingSystem <String>]`: Operating system of the device. Windows, iOS, etc. This property is read-only. + - `[OperatingSystemVersion <String>]`: Operating system version of the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values). + - `[OtherMail <String[]>]`: A list of additional email addresses for the user; for example: ['bob@contoso.com', 'Robert@fabrikam.com'].NOTE: While this property can contain accent characters, they can cause access issues to first-party applications for the user.Supports $filter (eq, NOT, ge, le, in, startsWith). + - `[PasswordPolicy <String>]`: Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.Supports $filter (ne, NOT). + - `[PasswordProfile <IMicrosoftGraphPasswordProfile>]`: passwordProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ForceChangePasswordNextSignIn <Boolean?>]`: true if the user must change her password on the next login; otherwise false. If not set, default is false. NOTE: For Azure B2C tenants, set to false and instead use custom policies and user flows to force password reset at first sign in. See Force password reset at first logon. + - `[ForceChangePasswordNextSignInWithMfa <Boolean?>]`: If true, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false. + - `[Password <String>]`: The password for the user. This property is required when a user is created. It can be updated, but the user will be required to change the password on the next login. The password must satisfy minimum requirements as specified by the user's passwordPolicies property. By default, a strong password is required. + - `[PhysicalId <String[]>]`: For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith). + - `[PostalCode <String>]`: The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[PreferredLanguage <String>]`: The preferred language for the user. Should follow ISO 639-1 Code; for example en-US. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[ShowInAddressList <Boolean?>]`: true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false. Supports $filter (eq, ne, NOT, in). + - `[State <String>]`: The state or province in the user's address. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[StreetAddress <String>]`: The street address of the user's place of business. Maximum length is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[Surname <String>]`: The user's surname (family name or last name). Maximum length is 64 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[TrustType <String>]`: Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud only joined devices), ServerAd (on-premises domain joined devices joined to Azure AD). For more details, see Introduction to device management in Azure Active Directory + - `[UsageLocation <String>]`: A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[UserPrincipalName <String>]`: The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: While this property can contain accent characters, they can cause access issues to first-party applications for the user. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith) and $orderBy. + - `[UserType <String>]`: A string value that can be used to classify user types in your directory, such as Member and Guest. Supports $filter (eq, ne, NOT, in,). + - `[OfficeLocation <String>]`: The office location in the user's place of business. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[OnPremisesImmutableId <String>]`: This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property. Returned only on $select. Supports $filter (eq, ne, NOT, ge, le, in).. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in). + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values). + - `[OperatingSystem <String>]`: Operating system of the device. Windows, iOS, etc. This property is read-only. + - `[OperatingSystemVersion <String>]`: Operating system version of the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values). + - `[OtherMail <String[]>]`: A list of additional email addresses for the user; for example: ['bob@contoso.com', 'Robert@fabrikam.com'].NOTE: While this property can contain accent characters, they can cause access issues to first-party applications for the user.Supports $filter (eq, NOT, ge, le, in, startsWith). + - `[PasswordPolicy <String>]`: Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.Supports $filter (ne, NOT). + - `[PasswordProfile <IMicrosoftGraphPasswordProfile>]`: passwordProfile + - `[PhysicalId <String[]>]`: For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith). + - `[PostalCode <String>]`: The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[PreferredLanguage <String>]`: The preferred language for the user. Should follow ISO 639-1 Code; for example en-US. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[ShowInAddressList <Boolean?>]`: true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false. Supports $filter (eq, ne, NOT, in). + - `[State <String>]`: The state or province in the user's address. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[StreetAddress <String>]`: The street address of the user's place of business. Maximum length is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[Surname <String>]`: The user's surname (family name or last name). Maximum length is 64 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[TrustType <String>]`: Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud only joined devices), ServerAd (on-premises domain joined devices joined to Azure AD). For more details, see Introduction to device management in Azure Active Directory + - `[UsageLocation <String>]`: A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[UserPrincipalName <String>]`: The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: While this property can contain accent characters, they can cause access issues to first-party applications for the user. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith) and $orderBy. + - `[UserType <String>]`: A string value that can be used to classify user types in your directory, such as Member and Guest. Supports $filter (eq, ne, NOT, in,). + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzDeployment.md b/azps-10.1.0/Az.Resources/Remove-AzDeployment.md new file mode 100644 index 0000000000..4067433ffc --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzDeployment.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzDeployment.md +--- + +# Remove-AzDeployment + +## SYNOPSIS +Removes a deployment and any associated operations + +## SYNTAX + +### RemoveByDeploymentName (Default) +``` +Remove-AzDeployment [-Name] <String> [-AsJob] [-PassThru] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByDeploymentId +``` +Remove-AzDeployment -Id <String> [-AsJob] [-PassThru] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzDeployment -InputObject <PSDeployment> [-AsJob] [-PassThru] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDeployment** cmdlet removes an Azure deployment at subscription scope and any associated operations. + +## EXAMPLES + +### Example 1: Remove a deployment with a given name +```powershell +Remove-AzDeployment -Name "RolesDeployment" +``` + +This command removes the deployment "RolesDeployment" at the current subscription scope. + +### Example 2: Get a deployment and remove it +```powershell +Get-AzDeployment -Name "RolesDeployment" | Remove-AzDeployment +``` + +This command gets the deployment "RolesDeployment" at the current subscription scope and removes it. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified resource Id of the deployment. +example: /subscriptions/{subId}/providers/Microsoft.Resources/deployments/{deploymentName} + +```yaml +Type: System.String +Parameter Sets: RemoveByDeploymentId +Aliases: DeploymentId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The deployment object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the deployment. + +```yaml +Type: System.String +Parameter Sets: RemoveByDeploymentName +Aliases: DeploymentName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzDeploymentScript.md b/azps-10.1.0/Az.Resources/Remove-AzDeploymentScript.md new file mode 100644 index 0000000000..f7f41b89c1 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzDeploymentScript.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azdeploymentscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzDeploymentScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzDeploymentScript.md +--- + +# Remove-AzDeploymentScript + +## SYNOPSIS +Removes a deployment script and its associated resources. + +## SYNTAX + +### RemoveDeploymentScriptLogByName (Default) +``` +Remove-AzDeploymentScript [-ResourceGroupName] <String> [-Name] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveDeploymentScriptLogByResourceId +``` +Remove-AzDeploymentScript [-Id] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### RemoveDeploymentScriptLogByInputObject +``` +Remove-AzDeploymentScript [-InputObject] <PsDeploymentScript> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDeploymentScript** cmdlet removes a deployment script and its associated resources. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDeploymentScript -Name MyDeploymentScript -ResourceGroupName DS-TestRg +``` + +Deletes a deployment script with the name MyDeploymentScript in resource group DS-TestRG. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified resource Id of the deployment script. +Example: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Resources/deploymentScripts/{deploymentScriptName} + +```yaml +Type: System.String +Parameter Sets: RemoveDeploymentScriptLogByResourceId +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The deployment script PowerShell object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScript +Parameter Sets: RemoveDeploymentScriptLogByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: RemoveDeploymentScriptLogByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: RemoveDeploymentScriptLogByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScript + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScript + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzManagedApplication.md b/azps-10.1.0/Az.Resources/Remove-AzManagedApplication.md new file mode 100644 index 0000000000..048a62097d --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzManagedApplication.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azmanagedapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagedApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagedApplication.md +--- + +# Remove-AzManagedApplication + +## SYNOPSIS +Removes a managed application + +## SYNTAX + +### RemoveByNameAndResourceGroup (Default) +``` +Remove-AzManagedApplication -Name <String> -ResourceGroupName <String> [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveById +``` +Remove-AzManagedApplication -Id <String> [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzManagedApplication** cmdlet removes a managed application + +## EXAMPLES + +### Example 1: Remove managed application by resource ID +```powershell +$Application = Get-AzManagedApplication -Name "myApp" -ResourceGroupName "myRG" +Remove-AzManagedApplication -Id $Application.ResourceId -Force +``` + +The first command gets a managed application named myApp by using the Get-AzManagedApplication cmdlet. +The command stores it in the $Application variable. +The second command removes the managed application identified by the **ResourceId** property of $Application. + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified managed application Id, including the subscription. +e.g. +/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} + +```yaml +Type: System.String +Parameter Sets: RemoveById +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The managed application name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzManagedApplicationDefinition.md b/azps-10.1.0/Az.Resources/Remove-AzManagedApplicationDefinition.md new file mode 100644 index 0000000000..58e0f20364 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzManagedApplicationDefinition.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azmanagedapplicationdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagedApplicationDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagedApplicationDefinition.md +--- + +# Remove-AzManagedApplicationDefinition + +## SYNOPSIS +Removes a managed application definition + +## SYNTAX + +### RemoveByNameAndResourceGroup (Default) +``` +Remove-AzManagedApplicationDefinition -Name <String> -ResourceGroupName <String> [-Force] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RemoveById +``` +Remove-AzManagedApplicationDefinition -Id <String> [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzManagedApplicationDefinition** cmdlet removes a managed application definition + +## EXAMPLES + +### Example 1: Remove managed application definition by resource ID +```powershell +$ApplicationDefinition = Get-AzManagedApplicationDefinition -Name "myAppDef" -ResourceGroupName "myRG" +Remove-AzManagedApplicationDefinition -Id $ApplicationDefinition.ResourceId -Force +``` + +The first command gets a managed application definition named myAppDef by using the Get-AzManagedApplicationDefinition cmdlet. +The command stores it in the $ApplicationDefinition variable. +The second command removes the managed application definition identified by the **ResourceId** property of $ApplicationDefinition. + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified managed application definition Id, including the subscription. +e.g. +/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} + +```yaml +Type: System.String +Parameter Sets: RemoveById +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The managed application definition name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzManagementGroup.md b/azps-10.1.0/Az.Resources/Remove-AzManagementGroup.md new file mode 100644 index 0000000000..a0bf230780 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzManagementGroup.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azmanagementgroup/ +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagementGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagementGroup.md +--- + +# Remove-AzManagementGroup + +## SYNOPSIS +Removes a Management Group + +## SYNTAX + +### GroupOperations (Default) +``` +Remove-AzManagementGroup [-GroupName] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ManagementGroupObject +``` +Remove-AzManagementGroup -InputObject <PSManagementGroup> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzManagementGroup** cmdlet deletes a Management Group. + +## EXAMPLES + +### Example 1: Remove a Management Group +```powershell +Remove-AzManagementGroup -GroupName "TestGroup" +``` + +### Example 2: Remove a Management Group by piping PSManagementGroup Object +```powershell +Get-AzManagementGroup -GroupName "TestGroup" | Remove-AzManagementGroup +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Management Group Id + +```yaml +Type: System.String +Parameter Sets: GroupOperations +Aliases: GroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object from the Get call + +```yaml +Type: Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup +Parameter Sets: ManagementGroupObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Return `true` on successful execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzManagementGroupDeployment.md b/azps-10.1.0/Az.Resources/Remove-AzManagementGroupDeployment.md new file mode 100644 index 0000000000..1d0e564c10 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzManagementGroupDeployment.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azmanagementgroupdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagementGroupDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagementGroupDeployment.md +--- + +# Remove-AzManagementGroupDeployment + +## SYNOPSIS +Removes a deployment at a management group and any associated operations + +## SYNTAX + +### RemoveByDeploymentName (Default) +``` +Remove-AzManagementGroupDeployment [-ManagementGroupId] <String> [-Name] <String> [-AsJob] [-PassThru] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByDeploymentId +``` +Remove-AzManagementGroupDeployment -Id <String> [-AsJob] [-PassThru] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzManagementGroupDeployment -InputObject <PSDeployment> [-AsJob] [-PassThru] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzManagementGroupDeployment** cmdlet removes an Azure deployment at a management group and any associated operations. + +## EXAMPLES + +### Example 1: Remove a deployment with a given name +```powershell +Remove-AzManagementGroupDeployment -ManagementGroupId "myMG" -Name "RolesDeployment" +``` + +This command removes the deployment "RolesDeployment" at the management group "myMG". + +### Example 2: Get a deployment and remove it +```powershell +Get-AzManagementGroupDeployment -ManagementGroupId "myMG" -Name "RolesDeployment" | Remove-AzManagementGroupDeployment +``` + +This command gets the deployment "RolesDeployment" at the management group "myMG" and removes it. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified resource Id of the deployment. +example: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deployments/{deploymentName} + +```yaml +Type: System.String +Parameter Sets: RemoveByDeploymentId +Aliases: DeploymentId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The deployment object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group id. + +```yaml +Type: System.String +Parameter Sets: RemoveByDeploymentName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deployment. + +```yaml +Type: System.String +Parameter Sets: RemoveByDeploymentName +Aliases: DeploymentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzManagementGroupDeploymentStack.md b/azps-10.1.0/Az.Resources/Remove-AzManagementGroupDeploymentStack.md new file mode 100644 index 0000000000..6dc703a1e2 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzManagementGroupDeploymentStack.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/Remove-AzManagementGroupDeploymentStack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagementGroupDeploymentStack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagementGroupDeploymentStack.md +--- + +# Remove-AzManagementGroupDeploymentStack + +## SYNOPSIS +Removes a Management Group scoped Deployment Stack. + +## SYNTAX + +### RemoveByNameAndManagementGroupId (Default) +``` +Remove-AzManagementGroupDeploymentStack [-Name] <String> [-ManagementGroupId] <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] [-PassThru] [-Force] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByResourceId +``` +Remove-AzManagementGroupDeploymentStack -ResourceId <String> [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] [-PassThru] [-Force] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a management group scoped deployment stack. + +## EXAMPLES + +### Example 1: Deletes the management group scoped stack MyMGStack from MyManagementGroup +```powershell +Remove-AzManagementGroupDeploymentStack -ManagementGroupId MyManagementGroup -Name MyMGStack +``` + +Deletes a management group scoped deployment stack named 'MyMGStack' in management group 'MyManagementGroup,' with unmanaged resources and resource groups being detached on cleanup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteAll +Signal to delete both unmanaged Resources and ResourceGroups after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResourceGroups +Signal to delete unmanaged stack ResourceGroups after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResources +Signal to delete unmanaged stack Resources after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The id of the ManagementGroup where the DeploymentStack is being deleted + +```yaml +Type: System.String +Parameter Sets: RemoveByNameAndManagementGroupId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the DeploymentStack to delete + +```yaml +Type: System.String +Parameter Sets: RemoveByNameAndManagementGroupId +Aliases: StackName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If set, a boolean will be returned with value dependent on cmdlet success. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the DeploymentStack to delete + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzManagementGroupHierarchySetting.md b/azps-10.1.0/Az.Resources/Remove-AzManagementGroupHierarchySetting.md new file mode 100644 index 0000000000..0aeb7512ce --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzManagementGroupHierarchySetting.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azmanagementgrouphierarchysetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagementGroupHierarchySetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagementGroupHierarchySetting.md +--- + +# Remove-AzManagementGroupHierarchySetting + +## SYNOPSIS +Deletes all Hierarchy Settings under the current tenant + +## SYNTAX + +### GroupOperations (Default) +``` +Remove-AzManagementGroupHierarchySetting [-GroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentGroupObject +``` +Remove-AzManagementGroupHierarchySetting [-GroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzManagementGroupHierarchySetting cmdlet Removes all hierarchy settings under the current tenant. + +## EXAMPLES + +### Example 1: Remove Hierarchy Settings +```powershell +Remove-AzManagementGroupHierarchySetting -GroupName c7a87cda-9a66-4920-b0f8-869baa04efe0 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Management Group Id of the Root Management Group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzManagementGroupSubscription.md b/azps-10.1.0/Az.Resources/Remove-AzManagementGroupSubscription.md new file mode 100644 index 0000000000..8a932ff3c8 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzManagementGroupSubscription.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azmanagementgroupsubscription/ +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagementGroupSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzManagementGroupSubscription.md +--- + +# Remove-AzManagementGroupSubscription + +## SYNOPSIS +Removes a Subscription from a Management Group. + +## SYNTAX + +``` +Remove-AzManagementGroupSubscription [-GroupName] <String> [-SubscriptionId] <Guid> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzManagementGroupSubscription** cmdlet removes a Subscription from a Management Group. + +## EXAMPLES + +### Example 1: Remove Subscription from a Management Group +```powershell +Remove-AzManagementGroupSubscription -GroupName "TestGroup" -SubscriptionId 2120692d-35c3-44c8-81f5-631fa7351726 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Management Group Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return `true` on successful execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id of the subscription associated with the management + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzPolicyAssignment.md b/azps-10.1.0/Az.Resources/Remove-AzPolicyAssignment.md new file mode 100644 index 0000000000..d2fb432543 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzPolicyAssignment.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 36399302-3EA5-45A3-A042-536CC7EC2E6D +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azpolicyassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzPolicyAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzPolicyAssignment.md +--- + +# Remove-AzPolicyAssignment + +## SYNOPSIS +Removes a policy assignment. + +## SYNTAX + +### NameParameterSet (Default) +``` +Remove-AzPolicyAssignment -Name <String> [-Scope <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdParameterSet +``` +Remove-AzPolicyAssignment -Id <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzPolicyAssignment -InputObject <PsPolicyAssignment> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPolicyAssignment** cmdlet removes the specified policy assignment. + +## EXAMPLES + +### Example 1: Remove policy assignment by name and scope +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +Remove-AzPolicyAssignment -Name 'PolicyAssignment07' -Scope $ResourceGroup.ResourceId -Confirm:$false +``` + +The first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet. +The command stores that object in the $ResourceGroup variable. +The second command removes the policy assignment named PolicyAssignment07 that was assigned at a resource group level. +The **ResourceId** property of $ResourceGroup identifies the resource group. + +### Example 2: Remove policy assignment by ID +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +$PolicyAssignment = Get-AzPolicyAssignment -Name 'PolicyAssignment07' -Scope $ResourceGroup.ResourceId +Remove-AzPolicyAssignment -Id $PolicyAssignment.ResourceId -Confirm:$false +``` + +The first command gets a resource group named ResourceGroup11, and then stores that object in the $ResourceGroup variable. +The second command gets the policy assignment at a resource group level, and then stores it in the $PolicyAssignment variable. +The **ResourceId** property of $ResourceGroup identifies the resource group. +The final command removes the policy assignment that the **ResourceId** property of $PolicyAssignment identifies. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the fully qualified resource ID for the policy assignment that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The policy assignment object to remove that was output from another cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the policy assignment that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Specifies the scope at which the policy is applied. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzPolicyAssignment](./Get-AzPolicyAssignment.md) + +[New-AzPolicyAssignment](./New-AzPolicyAssignment.md) + +[Set-AzPolicyAssignment](./Set-AzPolicyAssignment.md) + + diff --git a/azps-10.1.0/Az.Resources/Remove-AzPolicyDefinition.md b/azps-10.1.0/Az.Resources/Remove-AzPolicyDefinition.md new file mode 100644 index 0000000000..2f8362b1ff --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzPolicyDefinition.md @@ -0,0 +1,274 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: DEC01722-EB1A-45CE-BD30-9DB861718573 +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azpolicydefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzPolicyDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzPolicyDefinition.md +--- + +# Remove-AzPolicyDefinition + +## SYNOPSIS +Removes a policy definition. + +## SYNTAX + +### NameParameterSet (Default) +``` +Remove-AzPolicyDefinition -Name <String> [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ManagementGroupNameParameterSet +``` +Remove-AzPolicyDefinition -Name <String> [-Force] -ManagementGroupName <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SubscriptionIdParameterSet +``` +Remove-AzPolicyDefinition -Name <String> [-Force] -SubscriptionId <Guid> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdParameterSet +``` +Remove-AzPolicyDefinition -Id <String> [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzPolicyDefinition [-Force] -InputObject <PsPolicyDefinition> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPolicyDefinition** cmdlet removes a policy definition. + +## EXAMPLES + +### Example 1: Remove the policy definition by name +```powershell +Remove-AzPolicyDefinition -Name 'VMPolicyDefinition' +``` + +This command removes the specified policy definition. + +### Example 2: Remove policy definition by resource ID +```powershell +$PolicyDefinition = Get-AzPolicyDefinition -Name 'VMPolicyDefinition' +Remove-AzPolicyDefinition -Id $PolicyDefinition.ResourceId -Force +``` + +The first command gets a policy definition named VMPolicyDefinition by using the Get-AzPolicyDefinition cmdlet. +The command stores it in the $PolicyDefinition variable. +The second command removes the policy definition identified by the **ResourceId** property of $PolicyDefinition. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the fully qualified resource ID for the policy definition that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The policy definition object to remove that was output from another cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyDefinition +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ManagementGroupName +The name of the management group of the policy definition to delete. + +```yaml +Type: System.String +Parameter Sets: ManagementGroupNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the policy definition that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ManagementGroupNameParameterSet, SubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID of the policy definition to delete. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: SubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzPolicyDefinition](./Get-AzPolicyDefinition.md) + +[New-AzPolicyDefinition](./New-AzPolicyDefinition.md) + +[Set-AzPolicyDefinition](./Set-AzPolicyDefinition.md) + + diff --git a/azps-10.1.0/Az.Resources/Remove-AzPolicyExemption.md b/azps-10.1.0/Az.Resources/Remove-AzPolicyExemption.md new file mode 100644 index 0000000000..d8b8e02109 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzPolicyExemption.md @@ -0,0 +1,234 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azpolicyexemption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzPolicyExemption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzPolicyExemption.md +--- + +# Remove-AzPolicyExemption + +## SYNOPSIS +Removes a policy exemption. + +## SYNTAX + +### NameParameterSet (Default) +``` +Remove-AzPolicyExemption -Name <String> [-Scope <String>] [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdParameterSet +``` +Remove-AzPolicyExemption -Id <String> [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzPolicyExemption [-Force] -InputObject <PsPolicyExemption> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPolicyExemption** cmdlet removes the specified policy exemption. + +## EXAMPLES + +### Example 1: Remove policy exemption by name and scope +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +Remove-AzPolicyExemption -Name 'PolicyExemption07' -Scope $ResourceGroup.ResourceId -Confirm +``` + +The first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet. +The command stores that object in the $ResourceGroup variable. +The second command removes the policy exemption named PolicyExemption07 that was assigned at a resource group level. +The **ResourceId** property of $ResourceGroup identifies the resource group. + +### Example 2: Remove policy exemption by ID +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +$PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07' -Scope $ResourceGroup.ResourceId +Remove-AzPolicyExemption -Id $PolicyExemption.ResourceId -Confirm +``` + +The first command gets a resource group named ResourceGroup11, and then stores that object in the $ResourceGroup variable. +The second command gets the policy exemption at a resource group level, and then stores it in the $PolicyExemption variable. +The **ResourceId** property of $ResourceGroup identifies the resource group. +The final command removes the policy exemption that the **ResourceId** property of $PolicyExemption identifies. + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified policy exemption ID to delete, including the scope, e.g. +/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}. + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The policy exemption object to remove that was output from another cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyExemption +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the policy exemption to delete. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the policy exemption to delete, e.g. +/providers/managementGroups/{managementGroupName}, defaults to current subscription. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyExemption + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzPolicySetDefinition.md b/azps-10.1.0/Az.Resources/Remove-AzPolicySetDefinition.md new file mode 100644 index 0000000000..cfb26978e0 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzPolicySetDefinition.md @@ -0,0 +1,260 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azpolicysetdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzPolicySetDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzPolicySetDefinition.md +--- + +# Remove-AzPolicySetDefinition + +## SYNOPSIS +Removes a policy set definition. + +## SYNTAX + +### NameParameterSet (Default) +``` +Remove-AzPolicySetDefinition -Name <String> [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ManagementGroupNameParameterSet +``` +Remove-AzPolicySetDefinition [-Name <String>] [-Force] -ManagementGroupName <String> [-ApiVersion <String>] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SubscriptionIdParameterSet +``` +Remove-AzPolicySetDefinition [-Name <String>] [-Force] -SubscriptionId <Guid> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdParameterSet +``` +Remove-AzPolicySetDefinition -Id <String> [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzPolicySetDefinition [-Force] -InputObject <PsPolicySetDefinition> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzPolicySetDefinition** cmdlet removes a policy definition. + +## EXAMPLES + +### Example 1: Remove policy set definition by resource ID +```powershell +$PolicySetDefinition = Get-AzPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition' +Remove-AzPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Force +``` + +The first command gets a policy set definition by using the Get-AzPolicySetDefinition cmdlet. +The command stores it in the $PolicySetDefinition variable. +The second command removes the policy set definition identified by the **ResourceId** property of $PolicySetDefinition. + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified policy set definition Id, including the subscription. +e.g. +/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The policy set definition object to remove that was output from another cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicySetDefinition +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ManagementGroupName +The name of the management group of the policy set definition to delete. + +```yaml +Type: System.String +Parameter Sets: ManagementGroupNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The policy set definition name. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ManagementGroupNameParameterSet, SubscriptionIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID of the policy set definition to delete. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: SubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzPrivateLinkAssociation.md b/azps-10.1.0/Az.Resources/Remove-AzPrivateLinkAssociation.md new file mode 100644 index 0000000000..4ebb41704b --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzPrivateLinkAssociation.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azprivatelinkassociation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzPrivateLinkAssociation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzPrivateLinkAssociation.md +--- + +# Remove-AzPrivateLinkAssociation + +## SYNOPSIS +Delete a specific azure private link association. + +## SYNTAX + +### DeletePLAOperation (Default) +``` +Remove-AzPrivateLinkAssociation [-ManagementGroupId] <String> [-Name] <String> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PrivateLinkAssociationObject +``` +Remove-AzPrivateLinkAssociation [-PassThru] [-Force] -InputObject <PSResourceManagementPrivateLinkAssociation> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzPrivateLinkAssociation cmdlet deletes a specific resource management private link association. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzPrivateLinkAssociation -ManagementGroupId 24f15700-370c-45bc-86a7-aee1b0c4eb8a -Name 1d7942d1-288b-48de-8d0f-2d2aa8e03ad4 +``` + +```output +True +``` + +Delete a specific private link association. + +### Example 2 +```powershell +Get-AzPrivateLinkAssociation -ManagementGroupId 24f15700-370c-45bc-86a7-aee1b0c4eb8a -Name 1d7942d1-288b-48de-8d0f-2d2aa8e03ad4 | Remove-AzPrivateLinkAssociation -Force +``` + +Delete a specific private link association. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The private link association object. + +```yaml +Type: Microsoft.Azure.Commands.Resources.Models.PrivateLinks.PSResourceManagementPrivateLinkAssociation +Parameter Sets: PrivateLinkAssociationObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group Id. + +```yaml +Type: System.String +Parameter Sets: DeletePLAOperation +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The private link association Id. + +```yaml +Type: System.String +Parameter Sets: DeletePLAOperation +Aliases: PrivateLinkAssociationId + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzPrivateLinkAssociation](./Get-AzPrivateLinkAssociation.md) +[New-AzPrivateLinkAssociation](./New-AzPrivateLinkAssociation.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Resources/Remove-AzResource.md b/azps-10.1.0/Az.Resources/Remove-AzResource.md new file mode 100644 index 0000000000..e2b18adec9 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzResource.md @@ -0,0 +1,318 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: A262DFD1-8B90-462C-A4E2-ABA0F51173FA +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzResource.md +--- + +# Remove-AzResource + +## SYNOPSIS +Removes a resource. + +## SYNTAX + +### ByResourceId (Default) +``` +Remove-AzResource [-AsJob] -ResourceId <String> [-ODataQuery <String>] [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BySubscriptionLevel +``` +Remove-AzResource [-AsJob] -ResourceName <String> -ResourceType <String> [-ExtensionResourceName <String>] + [-ExtensionResourceType <String>] [-ODataQuery <String>] [-ResourceGroupName <String>] [-Force] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTenantLevel +``` +Remove-AzResource [-AsJob] -ResourceName <String> -ResourceType <String> [-ExtensionResourceName <String>] + [-ExtensionResourceType <String>] [-ODataQuery <String>] [-TenantLevel] [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzResource** cmdlet removes an Azure resource. + +## EXAMPLES + +### Example 1: Remove a website resource +```powershell +Remove-AzResource -ResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup11/providers/Microsoft.Web/sites/ContosoSite" -Force +``` + +This command removes the website resource named ContosoSite. +The example uses a placeholder value for the subscription ID. +The command specifies the *Force* parameter. +Therefore, it does not prompt you for confirmation. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionResourceName +Specifies the name of an extension resource of the resource that this cmdlet removes. +For instance, to specify a database, use the following format: +server name`/`database name + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExtensionResourceType +Specifies the resource type for an extension resource. +Specifies the extension resource type for the resource. +For instance: +`Microsoft.Sql/Servers/Databases` + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ODataQuery +Specifies an Open Data Protocol (OData) style filter. +This cmdlet appends this value to the request in addition to any other filters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group from which this cmdlet removes a resource. + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the fully qualified resource ID of the resource that this cmdlet removes. +The ID includes the subscription, as in the following example: +`/subscriptions/`subscription ID`/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase` + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +Specifies the name of the resource that this cmdlet removes. +For instance, to specify a database, use the following format: +`ContosoServer/ContosoDatabase` + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +Specifies the type of the resource that this cmdlet removes. +For instance, for a database, the resource type is as follows: +`Microsoft.Sql/Servers/Databases` + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantLevel +Indicates that this cmdlet operates at the tenant level. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByTenantLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzResource](./Get-AzResource.md) + +[Move-AzResource](./Move-AzResource.md) + +[New-AzResource](./New-AzResource.md) + +[Set-AzResource](./Set-AzResource.md) + + diff --git a/azps-10.1.0/Az.Resources/Remove-AzResourceGroup.md b/azps-10.1.0/Az.Resources/Remove-AzResourceGroup.md new file mode 100644 index 0000000000..8827dfc2a4 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzResourceGroup.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 880D321E-30F2-4CAE-B14A-5F6DD8E1DB99 +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azresourcegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzResourceGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzResourceGroup.md +--- + +# Remove-AzResourceGroup + +## SYNOPSIS +Removes a resource group. + +## SYNTAX + +### RemoveByResourceGroupName (Default) +``` +Remove-AzResourceGroup [-Name] <String> [-Force] [-AsJob] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByResourceGroupId +``` +Remove-AzResourceGroup -Id <String> [-Force] [-AsJob] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzResourceGroup** cmdlet removes an Azure resource group and its resources from the current subscription. +To delete a resource, but leave the resource group, use the Remove-AzResource cmdlet. + +## EXAMPLES + +### Example 1: Remove a resource group +```powershell +Remove-AzResourceGroup -Name "ContosoRG01" +``` + +This command removes the ContosoRG01 resource group from the subscription. +The cmdlet prompts you for confirmation and returns no output. + +### Example 2: Remove a resource group without confirmation +```powershell +Get-AzResourceGroup -Name "ContosoRG01" | Remove-AzResourceGroup -Force +``` + +This command uses the Get-AzResourceGroup cmdlet to get the resource group ContosoRG01, and then passes it to **Remove-AzResourceGroup** by using the pipeline operator. The *Force* parameter suppresses the confirmation prompt. + +### Example 3: Remove all resource groups +```powershell +Get-AzResourceGroup | Remove-AzResourceGroup +``` + +This command uses the **Get-AzResourceGroup** cmdlet to get all resource groups, and then passes them to **Remove-AzResourceGroup** by using the pipeline operator. + +## PARAMETERS + +### -ApiVersion +Specifies the API version that is supported by the resource Provider. +You can specify a different version than the default version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of resource group to remove. +Wildcard characters are not permitted. + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceGroupId +Aliases: ResourceGroupId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the names of resource groups to remove. +Wildcard characters are not permitted. + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceGroupName +Aliases: ResourceGroupName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzResourceGroup](./Get-AzResourceGroup.md) + +[New-AzResourceGroup](./New-AzResourceGroup.md) + +[Set-AzResourceGroup](./Set-AzResourceGroup.md) + + diff --git a/azps-10.1.0/Az.Resources/Remove-AzResourceGroupDeployment.md b/azps-10.1.0/Az.Resources/Remove-AzResourceGroupDeployment.md new file mode 100644 index 0000000000..b4ae870f70 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzResourceGroupDeployment.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: C3DD193E-B8FE-468D-BEE7-00C3D99B469E +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azresourcegroupdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzResourceGroupDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzResourceGroupDeployment.md +--- + +# Remove-AzResourceGroupDeployment + +## SYNOPSIS +Removes a resource group deployment and any associated operations. + +## SYNTAX + +### RemoveByResourceGroupName (Default) +``` +Remove-AzResourceGroupDeployment [-ResourceGroupName] <String> [-Name] <String> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByResourceGroupDeploymentId +``` +Remove-AzResourceGroupDeployment -Id <String> [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The **Remove-AzResourceGroupDeployment** cmdlet removes an Azure resource group deployment and any associated operations. + +## EXAMPLES + +### Example 1: Removes a resource group deployment with ResourceId + +```powershell +Remove-AzResourceGroupDeployment -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testGroup/providers/Microsoft.Resources/deployments/testDeployment1 +``` + +```output +True +``` + +This command removes a resource group deployment with the fully qualified resource Id of the deployment. +Successful removal returns true. + +### Example 2: Removes a resource group deployment with ResourceGroupName and ResourceName + +```powershell +Remove-AzResourceGroupDeployment -ResourceGroupName testGroup -Name testDeployment1 +``` + +```output +True +``` + +This command removes a resource group deployment with the provided ResourceGroupName and ResourceName. +Successful removal returns true. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the resource group deployment to remove. + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceGroupDeploymentId +Aliases: DeploymentId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the resource group deployment to remove. + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceGroupName +Aliases: DeploymentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to remove. + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceGroupName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzResourceGroupDeployment](./Get-AzResourceGroupDeployment.md) + +[New-AzResourceGroupDeployment](./New-AzResourceGroupDeployment.md) + +[Stop-AzResourceGroupDeployment](./Stop-AzResourceGroupDeployment.md) + +[Test-AzResourceGroupDeployment](./Test-AzResourceGroupDeployment.md) + + diff --git a/azps-10.1.0/Az.Resources/Remove-AzResourceGroupDeploymentStack.md b/azps-10.1.0/Az.Resources/Remove-AzResourceGroupDeploymentStack.md new file mode 100644 index 0000000000..e353025891 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzResourceGroupDeploymentStack.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/Remove-AzResourceGroupDeploymentStack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzResourceGroupDeploymentStack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzResourceGroupDeploymentStack.md +--- + +# Remove-AzResourceGroupDeploymentStack + +## SYNOPSIS +Removes a Resource Group scoped Deployment Stack. + +## SYNTAX + +### RemoveByNameAndResourceGroupName (Default) +``` +Remove-AzResourceGroupDeploymentStack [-Name] <String> [-ResourceGroupName] <String> [-DeleteAll] + [-DeleteResources] [-DeleteResourceGroups] [-PassThru] [-Force] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByResourceId +``` +Remove-AzResourceGroupDeploymentStack -ResourceId <String> [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] [-PassThru] [-Force] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a resource group scoped deployment stack. + +## EXAMPLES + +### Example 1: Deletes the resource group deployment tsack MyRgStack from MyResourceGroup +```powershell +Remove-AzResourceGroupDeploymentStack -ResourceGroupName MyResourceGroup -Name MyRGStack +``` + +Deletes a resource group scoped deployment stack named 'MyRGStack' in resource group 'MyResourceGroup,' with unmanaged resources and resource groups being detached on cleanup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteAll +Signal to delete both unmanaged Resources and ResourceGroups after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResourceGroups +Signal to delete unmanaged stack ResourceGroups after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResources +Signal to delete unmanaged stack Resources after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deploymentStack to delete + +```yaml +Type: System.String +Parameter Sets: RemoveByNameAndResourceGroupName +Aliases: StackName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If set, a boolean will be returned with value dependent on cmdlet success. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the Resource Group with the stack to delete + +```yaml +Type: System.String +Parameter Sets: RemoveByNameAndResourceGroupName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the stack to delete + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzResourceLock.md b/azps-10.1.0/Az.Resources/Remove-AzResourceLock.md new file mode 100644 index 0000000000..ca6766969e --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzResourceLock.md @@ -0,0 +1,286 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 42EEAAA8-F13B-486B-82BD-F646EF0DCDBA +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azresourcelock +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzResourceLock.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzResourceLock.md +--- + +# Remove-AzResourceLock + +## SYNOPSIS +Removes a resource lock. + +## SYNTAX + +### ByLockId (Default) +``` +Remove-AzResourceLock [-Force] -LockId <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceGroup +``` +Remove-AzResourceLock -LockName <String> [-Force] -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceGroupLevel +``` +Remove-AzResourceLock -LockName <String> [-Force] -ResourceName <String> -ResourceType <String> + -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### BySpecifiedScope +``` +Remove-AzResourceLock -LockName <String> [-Force] -Scope <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BySubscription +``` +Remove-AzResourceLock -LockName <String> [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BySubscriptionLevel +``` +Remove-AzResourceLock -LockName <String> [-Force] -ResourceName <String> -ResourceType <String> + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzResourceLock** cmdlet removes an Azure resource lock. + +## EXAMPLES + +### Example 1: Remove a lock +```powershell +Remove-AzResourceLock -LockName "ContosoSiteLock" -ResourceName "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/mystorageaccount/providers/Microsoft.Authorization/locks/test" +``` + +This command removes the lock named ContosoSiteLock. + +### Example 2 + +Removes a resource lock. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Remove-AzResourceLock -LockName 'ContosoSiteLock' -ResourceGroupName myresourcegroup -ResourceName '/subscriptions/00000000-0000-0000-0000-00000000000000000/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/mystorageaccount/providers/Microsoft.Authorization/locks/test' -ResourceType 'Microsoft.ClassicCompute/storageAccounts' +``` + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LockId +Specifies the ID of the lock that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: ByLockId +Aliases: Id, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LockName +Specifies the name of the lock that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup, ByResourceGroupLevel, BySpecifiedScope, BySubscription, BySubscriptionLevel +Aliases: ExtensionResourceName, Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which the lock applies. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup, ByResourceGroupLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +Specifies the name of the resource for which the lock applies. +For instance, to specify a database, use the following format: +Server`/`Database + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +Specifies the resource type of the resource for which the lock applies. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Specifies the scope to which the lock applies. + +```yaml +Type: System.String +Parameter Sets: BySpecifiedScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS + +[Get-AzResourceLock](./Get-AzResourceLock.md) + +[New-AzResourceLock](./New-AzResourceLock.md) + +[Set-AzResourceLock](./Set-AzResourceLock.md) + + diff --git a/azps-10.1.0/Az.Resources/Remove-AzResourceManagementPrivateLink.md b/azps-10.1.0/Az.Resources/Remove-AzResourceManagementPrivateLink.md new file mode 100644 index 0000000000..68391fa388 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzResourceManagementPrivateLink.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azresourcemanagementprivatelink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzResourceManagementPrivateLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzResourceManagementPrivateLink.md +--- + +# Remove-AzResourceManagementPrivateLink + +## SYNOPSIS +Deletes the Resource Manangement Private Link. + +## SYNTAX + +### DeleteOperation (Default) +``` +Remove-AzResourceManagementPrivateLink [-ResourceGroupName] <String> [-Name] <String> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PrivateLinkObject +``` +Remove-AzResourceManagementPrivateLink [-PassThru] [-Force] -InputObject <PSResourceManagementPrivateLink> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzResourceManagementPrivateLink cmdlet deletes a specific resource management private link. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzResourceManagementPrivateLink -ResourceGroupName PrivateLinkTestRG -Name NewPL +``` + +```output +True +``` + +Delete the specific Resource Management Private Link. + +### Example 2 +```powershell +Get-AzResourceManagementPrivateLink -ResourceGroupName PrivateLinkTestRG -Name NewPL | Remove-AzResourceManagementPrivateLink -Force +``` + +Delete the specific Resource Management Private Link. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The private link association object. + +```yaml +Type: Microsoft.Azure.Commands.Resources.Models.PrivateLinks.PSResourceManagementPrivateLink +Parameter Sets: PrivateLinkObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the private link. + +```yaml +Type: System.String +Parameter Sets: DeleteOperation +Aliases: PrivateLinkName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DeleteOperation +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzResourceManagementPrivateLink](./Get-AzResourceManagementPrivateLink.md) +[New-AzResourceManagementPrivateLink](./New-AzResourceManagementPrivateLink.md) diff --git a/azps-10.1.0/Az.Resources/Remove-AzRoleAssignment.md b/azps-10.1.0/Az.Resources/Remove-AzRoleAssignment.md new file mode 100644 index 0000000000..e7ed40919b --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzRoleAssignment.md @@ -0,0 +1,409 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 8C1D738C-825D-4718-AD2A-9CFEAA7DBD3B +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzRoleAssignment.md +--- + +# Remove-AzRoleAssignment + +## SYNOPSIS +Removes a role assignment to the specified principal who is assigned to a particular role at a particular scope. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /users/{id} +- GET /servicePrincipals/{id} +- GET /groups/{id} +- GET /directoryObjects/{id} +- POST /directoryObjects/getByIds + +Please notice that this cmdlet will mark `ObjectType` as `Unknown` in output if the object of role assignment is not found or current account has insufficient privileges to get object type. + +## SYNTAX + +### EmptyParameterSet (Default) +``` +Remove-AzRoleAssignment -ObjectId <String> [-Scope <String>] -RoleDefinitionName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceWithObjectIdParameterSet +``` +Remove-AzRoleAssignment -ObjectId <String> -ResourceGroupName <String> -ResourceName <String> + -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceGroupWithObjectIdParameterSet +``` +Remove-AzRoleAssignment -ObjectId <String> -ResourceGroupName <String> -RoleDefinitionName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ScopeWithObjectIdParameterSet +``` +Remove-AzRoleAssignment -ObjectId <String> [-Scope <String>] -RoleDefinitionName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RoleIdWithScopeAndObjectIdParameterSet +``` +Remove-AzRoleAssignment -ObjectId <String> [-Scope <String>] -RoleDefinitionId <Guid> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceWithSignInNameParameterSet +``` +Remove-AzRoleAssignment -SignInName <String> -ResourceGroupName <String> -ResourceName <String> + -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceGroupWithSignInNameParameterSet +``` +Remove-AzRoleAssignment -SignInName <String> -ResourceGroupName <String> -RoleDefinitionName <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ScopeWithSignInNameParameterSet +``` +Remove-AzRoleAssignment -SignInName <String> [-Scope <String>] -RoleDefinitionName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceWithSPNParameterSet +``` +Remove-AzRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> -ResourceName <String> + -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceGroupWithSPNParameterSet +``` +Remove-AzRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> -RoleDefinitionName <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ScopeWithSPNParameterSet +``` +Remove-AzRoleAssignment -ServicePrincipalName <String> [-Scope <String>] -RoleDefinitionName <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RoleAssignmentParameterSet +``` +Remove-AzRoleAssignment [-PassThru] [-InputObject] <PSRoleAssignment> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use the Remove-AzRoleAssignment commandlet to revoke access to any principal at given scope and given role. +The object of the assignment i.e. +the principal MUST be specified. +The principal can be a user (use SignInName or ObjectId parameters to identify a user), security group (use ObjectId parameter to identify a group) or service principal (use ServicePrincipalName or ObjectId parameters to identify a ServicePrincipal. +The role that the principal is assigned to MUST be specified using the RoleDefinitionName parameter. +The scope of the assignment MAY be specified and if not specified, defaults to the subscription scope i.e. +it will try to delete an assignment to the specified principal and role at the subscription scope. +The scope of the assignment can be specified using one of the following parameters. + a. +Scope - This is the fully qualified scope starting with /subscriptions/\<subscriptionId\> + b. +ResourceGroupName - Name of any resource group under the subscription. + c. +ResourceName, ResourceType, ResourceGroupName and (optionally) ParentResource - Identifies a particular resource under the subscription. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzRoleAssignment -ResourceGroupName rg1 -SignInName john.doe@contoso.com -RoleDefinitionName Reader +``` + +Removes a role assignment for john.doe@contoso.com who is assigned to the Reader role at the rg1 resourcegroup scope. + +### Example 2 +```powershell +Remove-AzRoleAssignment -ObjectId 36f81fc3-b00f-48cd-8218-3879f51ff39f -RoleDefinitionName Reader +``` + +Removes the role assignment to the group principal identified by the ObjectId and assigned to the Reader role. +Defaults to using the current subscription as the scope to find the assignment to be deleted. + +### Example 3 +```powershell +$roleassignment = Get-AzRoleAssignment |Select-Object -First 1 -Wait +Remove-AzRoleAssignment -InputObject $roleassignment +``` + +Removes the first role assignment object which is fetched from the Get-AzRoleAssignment commandlet. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Role Assignment object. + +```yaml +Type: Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment +Parameter Sets: RoleAssignmentParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ObjectId +Azure AD ObjectId of the user, group or service principal. + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, RoleIdWithScopeAndObjectIdParameterSet +Aliases: Id, PrincipalId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentResource +The parent resource in the hierarchy(of the resource specified using ResourceName parameter), if any. +Must be used in conjunction with ResourceGroupName, ResourceType and ResourceName parameters to construct a hierarchical scope in the form of a relative URI that identifies the resource. + +```yaml +Type: System.String +Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If specified, displays the deleted role assignment + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name that the role is assigned to. +Attempts to delete an assignment at the specified resource group scope. +When used in conjunction with ResourceName, ResourceType and (optionally)ParentResource parameters, the command constructs a hierarchical scope in the form of a relative URI that identifies a resource. + +```yaml +Type: System.String +Parameter Sets: ResourceWithObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceGroupWithSPNParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +The resource name. +For e.g. +storageaccountprod. +Must be used in conjunction with ResourceGroupName, ResourceType and (optionally)ParentResource parameters, to construct a hierarchical scope in the form of a relative URI that identifies the resource and delete an assignment at that scope. + +```yaml +Type: System.String +Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +The resource type. +For e.g. +Microsoft.Network/virtualNetworks. +Must be used in conjunction with ResourceGroupName, ResourceName and (optionally)ParentResource parameters to construct a hierarchical scope in the form of a relative URI that identifies the resource and delete an assignment at that resource scope. + +```yaml +Type: System.String +Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoleDefinitionId +Id of the RBAC role for which the assignment needs to be deleted. + +```yaml +Type: System.Guid +Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoleDefinitionName +Name of the RBAC role for which the assignment needs to be deleted i.e. +Reader, Contributor, Virtual Network Administrator, etc. + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceGroupWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceGroupWithSPNParameterSet, ScopeWithSPNParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +The Scope of the role assignment to be deleted. +In the format of relative URI. +For e.g. +"/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG". +If not specified, will attempt to delete the role at subscription level. +If specified, it should start with "/subscriptions/{id}". + +```yaml +Type: System.String +Parameter Sets: EmptyParameterSet, ScopeWithObjectIdParameterSet, RoleIdWithScopeAndObjectIdParameterSet, ScopeWithSignInNameParameterSet, ScopeWithSPNParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServicePrincipalName +The ServicePrincipalName of the Azure AD application + +```yaml +Type: System.String +Parameter Sets: ResourceWithSPNParameterSet, ResourceGroupWithSPNParameterSet, ScopeWithSPNParameterSet +Aliases: SPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SignInName +The email address or the user principal name of the user. + +```yaml +Type: System.String +Parameter Sets: ResourceWithSignInNameParameterSet, ResourceGroupWithSignInNameParameterSet, ScopeWithSignInNameParameterSet +Aliases: Email, UserPrincipalName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment + +## RELATED LINKS + +[New-AzRoleAssignment](./New-AzRoleAssignment.md) + +[Get-AzRoleAssignment](./Get-AzRoleAssignment.md) + +[Get-AzRoleDefinition](./Get-AzRoleDefinition.md) + diff --git a/azps-10.1.0/Az.Resources/Remove-AzRoleDefinition.md b/azps-10.1.0/Az.Resources/Remove-AzRoleDefinition.md new file mode 100644 index 0000000000..574cf29e5f --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzRoleDefinition.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 2D882B33-2B62-4785-AF8F-5F4644E9504D +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzRoleDefinition.md +--- + +# Remove-AzRoleDefinition + +## SYNOPSIS +Deletes a custom role in Azure RBAC. +The role to be deleted is specified using the Id property of the role. +Delete will fail if there are existing role assignments made to the custom role. + +## SYNTAX + +### RoleDefinitionIdParameterSet (Default) +``` +Remove-AzRoleDefinition -Id <Guid> [-Scope <String>] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RoleDefinitionNameParameterSet +``` +Remove-AzRoleDefinition [-Name] <String> [-Scope <String>] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzRoleDefinition -InputObject <PSRoleDefinition> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzRoleDefinition cmdlet deletes a custom role in Azure Role-Based Access Control. + Provide the Id parameter of an existing custom role to delete that custom role. +By default, Remove-AzRoleDefinition prompts you for confirmation. +To suppress the prompt, use the Force parameter. +If there are existing role assignments made to the custom role to be deleted, the delete will fail. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRoleDefinition -Name "Virtual Machine Operator" | Remove-AzRoleDefinition +``` + +### Example 2 +```powershell +Remove-AzRoleDefinition -Id "52a6cc13-ff92-47a8-a39b-2a8205c3087e" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +If set, does not prompt for a confirmation before deleting the custom role + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of the Role definition to be deleted + +```yaml +Type: System.Guid +Parameter Sets: RoleDefinitionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The object representing the role definition to be removed. + +```yaml +Type: Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the Role definition to be deleted. + +```yaml +Type: System.String +Parameter Sets: RoleDefinitionNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Role definition scope. + +```yaml +Type: System.String +Parameter Sets: RoleDefinitionIdParameterSet, RoleDefinitionNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Guid + +### System.String + +### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition + +## OUTPUTS + +### System.Boolean + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment + +## RELATED LINKS + +[New-AzRoleDefinition](./New-AzRoleDefinition.md) + +[Get-AzRoleDefinition](./Get-AzRoleDefinition.md) + +[Set-AzRoleDefinition](./Set-AzRoleDefinition.md) + diff --git a/azps-10.1.0/Az.Resources/Remove-AzRoleManagementPolicy.md b/azps-10.1.0/Az.Resources/Remove-AzRoleManagementPolicy.md new file mode 100644 index 0000000000..9fa1cd7c1d --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzRoleManagementPolicy.md @@ -0,0 +1,188 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azrolemanagementpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzRoleManagementPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzRoleManagementPolicy.md +--- + +# Remove-AzRoleManagementPolicy + +## SYNOPSIS +Delete a role management policy + +## SYNTAX + +### Delete (Default) +``` +Remove-AzRoleManagementPolicy -Name <String> -Scope <String> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzRoleManagementPolicy -InputObject <IAuthorizationIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a role management policy + +## EXAMPLES + +### Example 1: Delete a role management policy +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +Remove-AzRoleManagementPolicy -Scope $scope -Name "0a4d3ef7-147b-4777-a958-ae9dfab3c331" +``` + +```output +The requested resource does not support http method 'DELETE'. +``` + +This operation is currently not supported + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name (guid) of the role management policy to upsert. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: RoleManagementPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role management policy to upsert. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzRoleManagementPolicyAssignment.md b/azps-10.1.0/Az.Resources/Remove-AzRoleManagementPolicyAssignment.md new file mode 100644 index 0000000000..b78ddd5438 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzRoleManagementPolicyAssignment.md @@ -0,0 +1,188 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-azrolemanagementpolicyassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzRoleManagementPolicyAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzRoleManagementPolicyAssignment.md +--- + +# Remove-AzRoleManagementPolicyAssignment + +## SYNOPSIS +Delete a role management policy assignment + +## SYNTAX + +### Delete (Default) +``` +Remove-AzRoleManagementPolicyAssignment -Name <String> -Scope <String> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzRoleManagementPolicyAssignment -InputObject <IAuthorizationIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a role management policy assignment + +## EXAMPLES + +### Example 1: Delete a role management policy assignment +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +Remove-AzRoleManagementPolicyAssignment -Scope $scope -Name "588b80cc-f50c-4616-acc9-0003872624db_00493d72-78f6-4148-b6c5-d3ce8e4799dd" +``` + +```output +Remove-AzRoleManagementPolicyAssignment_Delete: The requested resource does not support http method 'DELETE'. +``` + +This operation is currently not supported + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of format {guid_guid} the role management policy assignment to delete. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: RoleManagementPolicyAssignmentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role management policy assignment to delete. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzSubscriptionDeploymentStack.md b/azps-10.1.0/Az.Resources/Remove-AzSubscriptionDeploymentStack.md new file mode 100644 index 0000000000..fb4d183f37 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzSubscriptionDeploymentStack.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/Remove-AzSubscriptionDeploymentStack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzSubscriptionDeploymentStack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzSubscriptionDeploymentStack.md +--- + +# Remove-AzSubscriptionDeploymentStack + +## SYNOPSIS +Removes a Subscription scoped Deployment Stack. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSubscriptionDeploymentStack [-Name] <String> [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + [-PassThru] [-Force] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RemoveByResourceId +``` +Remove-AzSubscriptionDeploymentStack -ResourceId <String> [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] [-PassThru] [-Force] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a subscription scoped deployment stack. + +## EXAMPLES + +### Example 1: Deletes the subscription scoped deployment stack MySubStack from the current subscription +```powershell +Remove-AzSubscriptionDeploymentStack -Name MySubStack +``` + +Deletes a subscription scoped deployment stack named 'MySubStack' in default subscription, with unmanaged resources and resource groups being detached on cleanup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteAll +Signal to delete both unmanaged Resources and ResourceGroups after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResourceGroups +Signal to delete unmanaged stack ResourceGroups after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResources +Signal to delete unmanaged stack Resources after updating stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deploymentStack to delete + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: StackName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If set, a boolean will be returned with value dependent on cmdlet success. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the stack to delete + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzTag.md b/azps-10.1.0/Az.Resources/Remove-AzTag.md new file mode 100644 index 0000000000..91f3ebc038 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzTag.md @@ -0,0 +1,233 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Tags.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 66B25541-0FA5-46CF-90D8-FE9527BE11C6 +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-aztag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzTag.md +--- + +# Remove-AzTag + +## SYNOPSIS +Deletes predefined Azure tags or values | Deletes the entire set of tags on a resource or subscription. + +## SYNTAX + +### RemovePredefinedTagParameterSet +``` +Remove-AzTag [-Name] <String> [[-Value] <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByResourceIdParameterSet +``` +Remove-AzTag [-PassThru] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION + +**RemovePredefinedTagSet**: The **Remove-AzTag** cmdlet deletes predefined Azure tags and values from your subscription. +To delete particular values from a predefined tag, use the *Value* parameter. +By default, **Remove-AzTag** deletes the specified tag and all of its values.You cannot delete a tag or value that is currently applied to a resource or resource group. +Before using **Remove-AzTag**, use the *Tag* parameter of the Set-AzResourceGroup cmdlet to delete the tag or values from the resource or resource group. +The Azure Tags module that **Remove-AzTag** is part of can help you manage your predefined Azure tags. +An Azure tag is a name-value pair that you can use to categorize your Azure resources and resource groups, such as by department or cost center, or to track notes or comments about the resources and groups. +You can define and apply tags in a single step, but predefined tags let you establish standard, consistent, predictable names and values for the tags in your subscription. + +**RemoveByResourceIdParameterSet**: The **Remove-AzTag** cmdlet with a **ResourceId** deletes the entire set of tags on a resource or subscription. + +## EXAMPLES + +### Example 1: Delete a predefined tag +```powershell +Remove-AzTag -Name "Department" +``` + +This command deletes the predefined tag named Department and all of its values. +If the tag has been applied to any resources or resource groups, the command fails. + +### Example 2: Delete a value from a predefined tag +```powershell +Remove-AzTag -Name "Department" -Value "HumanResources" -PassThru +``` + +```output +Name: Department +Count: 14 +Values: + + Name Count + ========= ===== + + Finance 2 + IT 12 +``` + +This command deletes the HumanResources value from the predefined Department tag. +It does not delete the tag. +If the value has been applied to any resources or resource groups, the command fails. + +### Example 3: Deletes the entire set of tags on a subscription + +```powershell +Remove-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +``` + +This command deletes the entire set of tags on the subscription with {subId}. It will not return the object deleted if not passing in "-PassThru". + +### Example 4: Deletes the entire set of tags on a resource + +```powershell +Remove-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/testrg/providers/Microsoft.Sql/servers/Server1 -PassThru +``` + +```output +Id : {Id} +Name : {Name} +Type : {Type} +Properties : + Name Value + ======= ========= + Dept Finance + Status Normal +``` + +This command deletes the entire set of tags on the resource with {resourceId}. It returns the deleted oject when passing in "-PassThru". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the Name of the predefined tag to remove. +By default, **Remove-AzTag** removes the specified tag and all of its values. +To delete selected values, but not delete the tag, use the *Value* parameter. + +```yaml +Type: System.String +Parameter Sets: RemovePredefinedTagParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object that represents the deleted tag or the resulting tag with deleted valued. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier for the tagged entity. A resource, a resource group or a subscription may be tagged. + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Value +Deletes the specified values from the predefined tag, but does not delete the tag. + +```yaml +Type: System.String[] +Parameter Sets: RemovePredefinedTagParameterSet +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.String[] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Common.Tags.PSTag | Microsoft.Azure.Commands.Tags.Model.PSTagResource + +## NOTES + +## RELATED LINKS + +[Get-AzTag](./Get-AzTag.md) + +[New-AzTag](./New-AzTag.md) + +[Update-AzTag](./Update-AzTag.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Resources/Remove-AzTemplateSpec.md b/azps-10.1.0/Az.Resources/Remove-AzTemplateSpec.md new file mode 100644 index 0000000000..dfeff197c9 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzTemplateSpec.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-aztemplatespec +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzTemplateSpec.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzTemplateSpec.md +--- + +# Remove-AzTemplateSpec + +## SYNOPSIS +Removes a Template Spec + +## SYNTAX + +### RemoveByNameParameterSet (Default) +``` +Remove-AzTemplateSpec [-Force] [-ResourceGroupName] <String> [-Name] <String> [[-Version] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByIdParameterSet +``` +Remove-AzTemplateSpec [-Force] [[-Version] <String>] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes a specified Template Spec. If the version **-Version** parameter is provided, only the specified +version will be removed. If no specific version is provided, the Template Spec and all of its versions will +be removed. If the **-Force** flag is present there will be no confirmation prompt for removal. + +## EXAMPLES + +### Example 1: Removing a specific version by name +```powershell +Remove-AzTemplateSpec -ResourceGroupName 'myRG' -Name 'MyTemplateSpec' -Version 'v1.0' +``` + +Removes version 'v1.0' of the Template Spec named 'MyTemplateSpec' within the resource group 'myRG'. + +### Example 2: Removing a specific version by resource id +```powershell +Remove-AzTemplateSpec -ResourceId '/subscriptions/{subId}/resourceGroups/myRG/providers/Microsoft.Resources/templateSpecs/MyTemplateSpec' -Version 'v1.0' +``` + +Removes version 'v1.0' of the Template Spec named 'MyTemplateSpec' within the resource group 'myRG' of subscription \{subId\}. + +### Example 3: Removing a Template Spec and all versions by name +```powershell +Remove-AzTemplateSpec -ResourceGroupName 'myRG' -Name 'MyTemplateSpec' +``` + +Removes the Template Spec named 'MyTemplateSpec' and all of its versions within the resource group 'myRG'. + +### Example 4: Removing a Template Spec and all versions by resource id +```powershell +Remove-AzTemplateSpec -ResourceId '/subscriptions/{subId}/resourceGroups/myRG/providers/Microsoft.Resources/templateSpecs/MyTemplateSpec' +``` + +Removes the Template Spec named 'MyTemplateSpec' and all of its versions within the resource group 'myRG' of subscription \{subId\}. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the template spec. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the template spec's resource group. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The fully qualified resource Id of the template spec. +Example: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName} + +```yaml +Type: System.String +Parameter Sets: RemoveByIdParameterSet +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +The version of the template spec to delete. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Remove-AzTenantDeployment.md b/azps-10.1.0/Az.Resources/Remove-AzTenantDeployment.md new file mode 100644 index 0000000000..6b597666a8 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Remove-AzTenantDeployment.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/remove-aztenantdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzTenantDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Remove-AzTenantDeployment.md +--- + +# Remove-AzTenantDeployment + +## SYNOPSIS +Removes a deployment at tenant scope and any associated operations + +## SYNTAX + +### RemoveByDeploymentName (Default) +``` +Remove-AzTenantDeployment [-Name] <String> [-AsJob] [-PassThru] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByDeploymentId +``` +Remove-AzTenantDeployment -Id <String> [-AsJob] [-PassThru] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzTenantDeployment -InputObject <PSDeployment> [-AsJob] [-PassThru] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzTenantDeployment** cmdlet removes an Azure deployment at the current tenant scope and any associated operations. + +## EXAMPLES + +### Example 1: Remove a deployment with a given name +```powershell +Remove-AzTenantDeployment -Name "RolesDeployment" +``` + +This command removes the deployment "RolesDeployment" at the current tenant scope. + +### Example 2: Get a deployment and remove it +```powershell +Get-AzTenantDeployment -Name "RolesDeployment" | Remove-AzTenantDeployment +``` + +This command gets the deployment "RolesDeployment" at the current tenant scope and removes it. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified resource Id of the deployment. +example: /providers/Microsoft.Resources/deployments/{deploymentName} + +```yaml +Type: System.String +Parameter Sets: RemoveByDeploymentId +Aliases: DeploymentId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The deployment object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the deployment. + +```yaml +Type: System.String +Parameter Sets: RemoveByDeploymentName +Aliases: DeploymentName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Save-AzDeploymentScriptLog.md b/azps-10.1.0/Az.Resources/Save-AzDeploymentScriptLog.md new file mode 100644 index 0000000000..2fe79dd7ca --- /dev/null +++ b/azps-10.1.0/Az.Resources/Save-AzDeploymentScriptLog.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/save-azdeploymentscriptlog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzDeploymentScriptLog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzDeploymentScriptLog.md +--- + +# Save-AzDeploymentScriptLog + +## SYNOPSIS +Saves the log of a deployment script execution to disk. + +## SYNTAX + +### SaveDeploymentScriptLogByName (Default) +``` +Save-AzDeploymentScriptLog [-ResourceGroupName] <String> [-Name] <String> [-OutputPath] <String> + [[-Tail] <Int32>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SaveDeploymentScriptLogByResourceId +``` +Save-AzDeploymentScriptLog [-DeploymentScriptResourceId] <String> [-OutputPath] <String> [[-Tail] <Int32>] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SaveDeploymentScriptLogByInputObject +``` +Save-AzDeploymentScriptLog [-DeploymentScriptObject] <PsDeploymentScript> [-OutputPath] <String> + [[-Tail] <Int32>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Save-AzDeploymentScriptLog** saves the log of a deployment script execution to disk. + +## EXAMPLES + +### Example 1 +```powershell +Save-AzDeploymentScriptLog -Name MyDeploymentScript -ResourceGroupName DS-TestRg -OutputPath C:\Workspace +``` + +Saves the log of a deployment script with the given name and resource group. + +### Example 2 +```powershell +Save-AzDeploymentScriptLog -Name MyDeploymentScript -ResourceGroupName DS-TestRg -OutputPath C:\Workspace -Tail 3 +``` + +Saves the last 3 lines of the log of a deployment script with the given name and resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentScriptObject +The deployment script PowerShell object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScript +Parameter Sets: SaveDeploymentScriptLogByInputObject +Aliases: DeploymentScriptInputObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DeploymentScriptResourceId +The fully qualified resource Id of the deployment script. +Example: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Resources/deploymentScripts/{deploymentScriptName} + +```yaml +Type: System.String +Parameter Sets: SaveDeploymentScriptLogByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the overwrite of the existing file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deployment script. + +```yaml +Type: System.String +Parameter Sets: SaveDeploymentScriptLogByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OutputPath +The directory path to save deployment script log. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SaveDeploymentScriptLogByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tail +Limit output to last n lines + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScriptLogPath + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Save-AzDeploymentTemplate.md b/azps-10.1.0/Az.Resources/Save-AzDeploymentTemplate.md new file mode 100644 index 0000000000..930eed06e6 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Save-AzDeploymentTemplate.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/save-azdeploymenttemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzDeploymentTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzDeploymentTemplate.md +--- + +# Save-AzDeploymentTemplate + +## SYNOPSIS +Saves a deployment template to a file. + +## SYNTAX + +### SaveByDeploymentName (Default) +``` +Save-AzDeploymentTemplate -DeploymentName <String> [-Path <String>] [-Force] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SaveByDeploymentObject +``` +Save-AzDeploymentTemplate -DeploymentObject <PSDeployment> [-Path <String>] [-Force] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Save-AzDeploymentTemplate** cmdlet saves a deployment template to a JSON file. + +## EXAMPLES + +### Example 1 +```powershell +Save-AzDeploymentTemplate -DeploymentName "TestDeployment" +``` + +This command gets the deployment template from TestDeployment and saves it as a JSON file in the current directory. + +### Example 2: Get a deployment and save its template +```powershell +Get-AzDeployment -Name "RolesDeployment" | Save-AzDeploymentTemplate +``` + +This command gets the deployment "RolesDeployment" at the current subscription scope and saves its template. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The deployment name. + +```yaml +Type: System.String +Parameter Sets: SaveByDeploymentName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentObject +The deployment object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment +Parameter Sets: SaveByDeploymentObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The output path of the template file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSTemplatePath + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Save-AzManagementGroupDeploymentStackTemplate.md b/azps-10.1.0/Az.Resources/Save-AzManagementGroupDeploymentStackTemplate.md new file mode 100644 index 0000000000..95c6ced87f --- /dev/null +++ b/azps-10.1.0/Az.Resources/Save-AzManagementGroupDeploymentStackTemplate.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/Save-AzManagementGroupDeploymentStackTemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzManagementGroupDeploymentStackTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzManagementGroupDeploymentStackTemplate.md +--- + +# Save-AzManagementGroupDeploymentStackTemplate + +## SYNOPSIS +Saves a Management Group scoped Deployment Stack Template. + +## SYNTAX + +### SaveByNameAndManagmentGroupId (Default) +``` +Save-AzManagementGroupDeploymentStackTemplate [-StackName] <String> [-ManagementGroupId] <String> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SaveByResourceId +``` +Save-AzManagementGroupDeploymentStackTemplate -ResourceId <String> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Saves a template (or template link) for a management group scoped deployment stack. + +## EXAMPLES + +### Example 1: Save the template used for the deployment stack named MyManagementGroup at MyManagementGroup management group +```powershell +Save-AzManagementGroupDeploymentStackTemplate -ManagementGroupId MyManagementGroup -StackName MyMGStack +``` + +Save a template (or template link) from a stack named 'MyMGStack' under an MG named 'MyManagementGroup'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The id of the ManagementGroup where the DeploymentStack is deployed + +```yaml +Type: System.String +Parameter Sets: SaveByNameAndManagmentGroupId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the DeploymentStack to get + +```yaml +Type: System.String +Parameter Sets: SaveByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StackName +The name of the DeploymentStack to get + +```yaml +Type: System.String +Parameter Sets: SaveByNameAndManagmentGroupId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStackTemplateDefinition + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Save-AzManagementGroupDeploymentTemplate.md b/azps-10.1.0/Az.Resources/Save-AzManagementGroupDeploymentTemplate.md new file mode 100644 index 0000000000..2941d02211 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Save-AzManagementGroupDeploymentTemplate.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/save-azmanagementgroupdeploymenttemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzManagementGroupDeploymentTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzManagementGroupDeploymentTemplate.md +--- + +# Save-AzManagementGroupDeploymentTemplate + +## SYNOPSIS +Saves a deployment template to a file. + +## SYNTAX + +### SaveByDeploymentName (Default) +``` +Save-AzManagementGroupDeploymentTemplate -ManagementGroupId <String> -DeploymentName <String> [-Path <String>] + [-Force] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SaveByDeploymentObject +``` +Save-AzManagementGroupDeploymentTemplate -DeploymentObject <PSDeployment> [-Path <String>] [-Force] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Save-AzManagementGroupDeploymentTemplate** cmdlet saves a deployment template to a JSON file for a deployment at a management group. + +## EXAMPLES + +### Example 1 +```powershell +Save-AzManagementGroupDeploymentTemplate -ManagementGroupId "myMG" -DeploymentName "TestDeployment" +``` + +This command gets the deployment template from TestDeployment and saves it as a JSON file in the current directory. + +### Example 2: Get a deployment and save its template +```powershell +Get-AzManagementGroupDeployment -ManagementGroupId "myMG" -Name "RolesDeployment" | Save-AzManagementGroupDeploymentTemplate +``` + +This command gets the deployment "RolesDeployment" at the management group "myMG" and saves its template. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The deployment name. + +```yaml +Type: System.String +Parameter Sets: SaveByDeploymentName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentObject +The deployment object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment +Parameter Sets: SaveByDeploymentObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group id. + +```yaml +Type: System.String +Parameter Sets: SaveByDeploymentName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The output path of the template file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSTemplatePath + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Save-AzResourceGroupDeploymentStackTemplate.md b/azps-10.1.0/Az.Resources/Save-AzResourceGroupDeploymentStackTemplate.md new file mode 100644 index 0000000000..7be2abbfe2 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Save-AzResourceGroupDeploymentStackTemplate.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/Save-AzResourceGroupDeploymentStackTemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzResourceGroupDeploymentStackTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzResourceGroupDeploymentStackTemplate.md +--- + +# Save-AzResourceGroupDeploymentStackTemplate + +## SYNOPSIS +Saves a Resource Group scoped Deployment Stack Template. + +## SYNTAX + +### SaveByNameAndResourceGroupName (Default) +``` +Save-AzResourceGroupDeploymentStackTemplate [-ResourceGroupName] <String> [-StackName] <String> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SaveByResourceId +``` +Save-AzResourceGroupDeploymentStackTemplate -ResourceId <String> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Saves a template (or template link) for a resource group scoped deployment stack. + +## EXAMPLES + +### Example 1: Saves the template used for the deployment stack MyRGStack in the resource group MyResourceGroup +```powershell +Save-AzResourceGroupDeploymentStackTemplate -ResourceGroupName MyResourceGroup -StackName MyRGStack +``` + +Save a template from a stack named 'MyRGStack' under an RG named 'MyResourceGroup'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the ResourceGroup where the DeploymentStack is deployed + +```yaml +Type: System.String +Parameter Sets: SaveByNameAndResourceGroupName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the DeploymentStack to get + +```yaml +Type: System.String +Parameter Sets: SaveByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StackName +The name of the DeploymentStack to get + +```yaml +Type: System.String +Parameter Sets: SaveByNameAndResourceGroupName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStackTemplateDefinition + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Save-AzResourceGroupDeploymentTemplate.md b/azps-10.1.0/Az.Resources/Save-AzResourceGroupDeploymentTemplate.md new file mode 100644 index 0000000000..c22206edf5 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Save-AzResourceGroupDeploymentTemplate.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 8BB4AD6B-EBE3-442A-83E7-B77A31573208 +online version: https://learn.microsoft.com/powershell/module/az.resources/save-azresourcegroupdeploymenttemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzResourceGroupDeploymentTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzResourceGroupDeploymentTemplate.md +--- + +# Save-AzResourceGroupDeploymentTemplate + +## SYNOPSIS +Saves a resource group deployment template to a file. + +## SYNTAX + +``` +Save-AzResourceGroupDeploymentTemplate -ResourceGroupName <String> -DeploymentName <String> [-Path <String>] + [-Force] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Save-AzResourceGroupDeploymentTemplate** cmdlet saves a resource group deployment template to a JSON file. + +## EXAMPLES + +### Example 1: Save a deployment template +```powershell +Save-AzResourceGroupDeploymentTemplate -DeploymentName "TestDeployment" -ResourceGroupName "TestGroup" +``` + +This command gets the deployment template from TestDeployment and saves it as a JSON file in the current directory. + +### Example 2 + +Saves a resource group deployment template to a file. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Save-AzResourceGroupDeploymentTemplate -DeploymentName 'TestDeployment' -Path <String> -ResourceGroupName 'TestGroup' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +Specifies the name of the deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the output path of the template file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet use pre-release API versions when automatically determining which API version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Save-AzSubscriptionDeploymentStackTemplate.md b/azps-10.1.0/Az.Resources/Save-AzSubscriptionDeploymentStackTemplate.md new file mode 100644 index 0000000000..b87f2b6c00 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Save-AzSubscriptionDeploymentStackTemplate.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/Save-AzSubscriptionDeploymentStackTemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzSubscriptionDeploymentStackTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzSubscriptionDeploymentStackTemplate.md +--- + +# Save-AzSubscriptionDeploymentStackTemplate + +## SYNOPSIS +Saves a Subscription scoped Deployment Stack Template. + +## SYNTAX + +### SaveByName (Default) +``` +Save-AzSubscriptionDeploymentStackTemplate [-StackName] <String> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SaveByResourceId +``` +Save-AzSubscriptionDeploymentStackTemplate -ResourceId <String> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Saves a template (or template link) for a subscription scoped deployment stack. + +## EXAMPLES + +### Example 1: Saves the template used for the deployment stack MySubStack at the current subscription +```powershell +Save-AzSubscriptionDeploymentStackTemplate -StackName MySubStack +``` + +Save a template (or template link) for a stack named 'MySubStack' under the default subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ResourceId of the DeploymentStack to get + +```yaml +Type: System.String +Parameter Sets: SaveByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StackName +The name of the DeploymentStack to get + +```yaml +Type: System.String +Parameter Sets: SaveByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStackTemplateDefinition + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Save-AzTenantDeploymentTemplate.md b/azps-10.1.0/Az.Resources/Save-AzTenantDeploymentTemplate.md new file mode 100644 index 0000000000..edccece48f --- /dev/null +++ b/azps-10.1.0/Az.Resources/Save-AzTenantDeploymentTemplate.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/save-aztenantdeploymenttemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzTenantDeploymentTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Save-AzTenantDeploymentTemplate.md +--- + +# Save-AzTenantDeploymentTemplate + +## SYNOPSIS +Saves a deployment template to a file. + +## SYNTAX + +### SaveByDeploymentName (Default) +``` +Save-AzTenantDeploymentTemplate -DeploymentName <String> [-Path <String>] [-Force] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SaveByDeploymentObject +``` +Save-AzTenantDeploymentTemplate -DeploymentObject <PSDeployment> [-Path <String>] [-Force] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Save-AzTenantDeploymentTemplate** cmdlet saves a deployment template to a JSON file for a deployment at tenant scope. + +## EXAMPLES + +### Example 1 +```powershell +Save-AzTenantDeploymentTemplate -DeploymentName "TestDeployment" +``` + +This command gets the deployment template from TestDeployment and saves it as a JSON file in the current directory. + +### Example 2: Get a deployment and save its template +```powershell +Get-AzTenantDeployment -Name "RolesDeployment" | Save-AzTenantDeploymentTemplate +``` + +This command gets the deployment "RolesDeployment" at the current tenant scope and saves its template. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The deployment name. + +```yaml +Type: System.String +Parameter Sets: SaveByDeploymentName +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentObject +The deployment object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment +Parameter Sets: SaveByDeploymentObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The output path of the template file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSTemplatePath + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Set-AzManagedApplication.md b/azps-10.1.0/Az.Resources/Set-AzManagedApplication.md new file mode 100644 index 0000000000..3490bffe62 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzManagedApplication.md @@ -0,0 +1,276 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/set-azmanagedapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzManagedApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzManagedApplication.md +--- + +# Set-AzManagedApplication + +## SYNOPSIS +Updates managed application + +## SYNTAX + +### SetByNameAndResourceGroup (Default) +``` +Set-AzManagedApplication -Name <String> -ResourceGroupName <String> [-ManagedResourceGroupName <String>] + [-ManagedApplicationDefinitionId <String>] [-Parameter <String>] [-Kind <String>] [-Plan <Hashtable>] + [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetById +``` +Set-AzManagedApplication -Id <String> [-ManagedResourceGroupName <String>] + [-ManagedApplicationDefinitionId <String>] [-Parameter <String>] [-Kind <String>] [-Plan <Hashtable>] + [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzManagedApplication** cmdlet updates managed applications + +## EXAMPLES + +### Example 1: Update managed application definition description +```powershell +Set-AzManagedApplication -ResourceId "/subscriptions/mySubId/resourcegroups/myRG/Microsoft.Solutions/applications/myApp" -Tag @{"key" = "value"} +``` + +This command updates the managed application tag + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified managed application Id, including the subscription. e.g. /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName + +```yaml +Type: System.String +Parameter Sets: SetById +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Kind +The managed application kind. +One of marketplace or servicecatalog + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedApplicationDefinitionId +The managed resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagedResourceGroupName +The managed resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The managed application name. + +```yaml +Type: System.String +Parameter Sets: SetByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameter +The JSON formatted string of parameters for managed application. +This can either be a path to a file name or uri containing the parameters, or the parameters as string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Plan +A hash table which represents managed application plan properties. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: PlanObject + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: SetByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Set-AzManagedApplicationDefinition.md b/azps-10.1.0/Az.Resources/Set-AzManagedApplicationDefinition.md new file mode 100644 index 0000000000..cfd7b0c95a --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzManagedApplicationDefinition.md @@ -0,0 +1,272 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/set-azmanagedapplicationdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzManagedApplicationDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzManagedApplicationDefinition.md +--- + +# Set-AzManagedApplicationDefinition + +## SYNOPSIS +Updates managed application definition + +## SYNTAX + +### SetByNameAndResourceGroup (Default) +``` +Set-AzManagedApplicationDefinition -Name <String> -ResourceGroupName <String> [-DisplayName <String>] + [-Description <String>] [-PackageFileUri <String>] [-Authorization <String[]>] [-Tag <Hashtable>] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetById +``` +Set-AzManagedApplicationDefinition -Id <String> [-DisplayName <String>] [-Description <String>] + [-PackageFileUri <String>] [-Authorization <String[]>] [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzManagedApplicationDefinition** cmdlet updates managed application definitions + +## EXAMPLES + +### Example 1: Update managed application definition description +```powershell +Set-AzManagedApplicationDefinition -ResourceId "/subscriptions/mySubId/resourcegroups/myRG/Microsoft.Solutions/applicationDefinitions/myAppDef" -Description "Updated description here" +``` + +This command updates the managed application definition description + +### Example 2 + +Updates managed application definition. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzManagedApplicationDefinition -Id '/subscriptions/mySubId/resourcegroups/myRG/Microsoft.Solutions/applicationDefinitions/myAppDef' -PackageFileUri https://sample.blob.core.windows.net/files/myPackage.zip +``` + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +The managed application definition authorization. +Comma separated authorization pairs in a format of \<principalId\>:\<roleDefinitionId\> + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The managed application definition description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +The managed application definition display name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id +The fully qualified managed application definition Id, including the subscription. e.g. /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName + +```yaml +Type: System.String +Parameter Sets: SetById +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The managed application definition name. + +```yaml +Type: System.String +Parameter Sets: SetByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PackageFileUri +The managed application definition package file uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: SetByNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A hash table which represents resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Collections.Hashtable + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Set-AzManagementGroupDeploymentStack.md b/azps-10.1.0/Az.Resources/Set-AzManagementGroupDeploymentStack.md new file mode 100644 index 0000000000..c0f4ec9be6 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzManagementGroupDeploymentStack.md @@ -0,0 +1,583 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/Set-AzManagementGroupDeploymentStack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzManagementGroupDeploymentStack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzManagementGroupDeploymentStack.md +--- + +# Set-AzManagementGroupDeploymentStack + +## SYNOPSIS +Sets a new Management Group scoped Deployment Stack. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +Set-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> + -DeploymentSubscriptionId <String> -Location <String> [-Description <String>] [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateFile <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileWithParameterFile +``` +Set-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> + -DeploymentSubscriptionId <String> -Location <String> [-Description <String>] [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateFile <String> -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateFileWithParameterUri +``` +Set-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> + -DeploymentSubscriptionId <String> -Location <String> [-Description <String>] [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateFile <String> -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateFileWithParameterObject +``` +Set-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> + -DeploymentSubscriptionId <String> -Location <String> [-Description <String>] [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateFile <String> -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriWithParameterFile +``` +Set-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> + -DeploymentSubscriptionId <String> -Location <String> [-Description <String>] [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateUri <String> -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriWithParameterUri +``` +Set-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> + -DeploymentSubscriptionId <String> -Location <String> [-Description <String>] [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateUri <String> -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriWithParameterObject +``` +Set-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> + -DeploymentSubscriptionId <String> -Location <String> [-Description <String>] [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateUri <String> -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +Set-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> + -DeploymentSubscriptionId <String> -Location <String> [-Description <String>] [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateUri <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterFile +``` +Set-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> + -DeploymentSubscriptionId <String> -Location <String> [-Description <String>] [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateSpecId <String> -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterUri +``` +Set-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> + -DeploymentSubscriptionId <String> -Location <String> [-Description <String>] [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateSpecId <String> -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterObject +``` +Set-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> + -DeploymentSubscriptionId <String> -Location <String> [-Description <String>] [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateSpecId <String> -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecWithNoParameters +``` +Set-AzManagementGroupDeploymentStack -Name <String> -ManagementGroupId <String> + -DeploymentSubscriptionId <String> -Location <String> [-Description <String>] [-DeleteAll] [-DeleteResources] + [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update a management group scoped deployment stack. + +## EXAMPLES + +### Example 1: Updates the management group scoped stack MyMGStack at MyManagementGroup deployed to the child subscription MySubId +```powershell +Set-AzManagementGroupDeploymentStack -Name MyMGStack -ManagementGroupId MyMangementGroup -DeploymentSubscriptionId MySubId -TemplateFile myTemplate.json -Location westus -DenySettingsMode DenyDelete +``` + +Update a management group scoped deployment stack named 'MyMGStack' in management group 'MyManagementGroup,' with the scope of the underlying deployment being MySubId and deny settings being DenyDelete. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteAll +Signal to delete both unmanaged Resources and ResourceGroups after deleting stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResourceGroups +Signal to delete unmanaged stack ResourceGroups after deleting stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResources +Signal to delete unmanaged stack Resources after deleting stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsApplyToChildScopes +Apply to child scopes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsExcludedAction +List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsExcludedPrincipal +List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsMode +Mode for DenySettings. +Possible values include: 'denyDelete', 'denyWriteAndDelete', and 'none'. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDenySettingsMode +Parameter Sets: (All) +Aliases: +Accepted values: None, DenyDelete, DenyWriteAndDelete + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentSubscriptionId +The subscription Id at which the deployment should be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +Description for the stack. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation when overwriting an existing stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the stack. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagementGroupId +The id of the management group that the deploymentStack will be deployed into. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the deploymentStack to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StackName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to put on the deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +TemplateFile to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileWithParameterFile, ByTemplateFileWithParameterUri, ByTemplateFileWithParameterObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +Parameter file to use for the template. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithParameterFile, ByTemplateUriWithParameterFile, ByTemplateSpecWithParameterFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateFileWithParameterObject, ByTemplateUriWithParameterObject, ByTemplateSpecWithParameterObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Location of the Parameter file to use for the template. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithParameterUri, ByTemplateUriWithParameterUri, ByTemplateSpecWithParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +ResourceId of the TemplateSpec to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecWithParameterFile, ByTemplateSpecWithParameterUri, ByTemplateSpecWithParameterObject, ByTemplateSpecWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Location of the Template to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriWithParameterFile, ByTemplateUriWithParameterUri, ByTemplateUriWithParameterObject, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStack + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Set-AzPolicyAssignment.md b/azps-10.1.0/Az.Resources/Set-AzPolicyAssignment.md new file mode 100644 index 0000000000..6a19f3ea6b --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzPolicyAssignment.md @@ -0,0 +1,501 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: C3B2C33F-8BD4-4E31-9450-EF6A3A6A5325 +online version: https://learn.microsoft.com/powershell/module/az.resources/set-azpolicyassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzPolicyAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzPolicyAssignment.md +--- + +# Set-AzPolicyAssignment + +## SYNOPSIS +Modifies a policy assignment. + +## SYNTAX + +### NameParameterSet (Default) +``` +Set-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>] + [-Description <String>] [-Metadata <String>] [-AssignIdentity] [-Location <String>] + [-EnforcementMode <PolicyAssignmentEnforcementMode>] [-IdentityType <ManagedIdentityType>] + [-IdentityId <String>] [-NonComplianceMessage <PsNonComplianceMessage[]>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicyParameterNameObjectParameterSet +``` +Set-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>] + [-Description <String>] [-Metadata <String>] -PolicyParameterObject <Hashtable> [-AssignIdentity] + [-Location <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>] + [-IdentityType <ManagedIdentityType>] [-IdentityId <String>] + [-NonComplianceMessage <PsNonComplianceMessage[]>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicyParameterNameStringParameterSet +``` +Set-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>] + [-Description <String>] [-Metadata <String>] -PolicyParameter <String> [-AssignIdentity] [-Location <String>] + [-EnforcementMode <PolicyAssignmentEnforcementMode>] [-IdentityType <ManagedIdentityType>] + [-IdentityId <String>] [-NonComplianceMessage <PsNonComplianceMessage[]>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### IdParameterSet +``` +Set-AzPolicyAssignment [-NotScope <String[]>] -Id <String> [-DisplayName <String>] [-Description <String>] + [-Metadata <String>] [-AssignIdentity] [-Location <String>] + [-EnforcementMode <PolicyAssignmentEnforcementMode>] [-IdentityType <ManagedIdentityType>] + [-IdentityId <String>] [-NonComplianceMessage <PsNonComplianceMessage[]>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicyParameterIdObjectParameterSet +``` +Set-AzPolicyAssignment [-NotScope <String[]>] -Id <String> [-DisplayName <String>] [-Description <String>] + [-Metadata <String>] -PolicyParameterObject <Hashtable> [-AssignIdentity] [-Location <String>] + [-EnforcementMode <PolicyAssignmentEnforcementMode>] [-IdentityType <ManagedIdentityType>] + [-IdentityId <String>] [-NonComplianceMessage <PsNonComplianceMessage[]>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicyParameterIdStringParameterSet +``` +Set-AzPolicyAssignment [-NotScope <String[]>] -Id <String> [-DisplayName <String>] [-Description <String>] + [-Metadata <String>] -PolicyParameter <String> [-AssignIdentity] [-Location <String>] + [-EnforcementMode <PolicyAssignmentEnforcementMode>] [-IdentityType <ManagedIdentityType>] + [-IdentityId <String>] [-NonComplianceMessage <PsNonComplianceMessage[]>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Set-AzPolicyAssignment [-NotScope <String[]>] [-DisplayName <String>] [-Description <String>] + [-Metadata <String>] [-AssignIdentity] [-Location <String>] + [-EnforcementMode <PolicyAssignmentEnforcementMode>] [-IdentityType <ManagedIdentityType>] + [-IdentityId <String>] -InputObject <PsPolicyAssignment> [-NonComplianceMessage <PsNonComplianceMessage[]>] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPolicyAssignment** cmdlet modifies a policy assignment. +Specify an assignment by ID or by name and scope. + +## EXAMPLES + +### Example 1: Update the display name +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +$PolicyAssignment = Get-AzPolicyAssignment -Name 'PolicyAssignment' -Scope $ResourceGroup.ResourceId +Set-AzPolicyAssignment -Id $PolicyAssignment.ResourceId -DisplayName 'Do not allow VM creation' +``` + +The first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet. +The command stores that object in the $ResourceGroup variable. +The second command gets the policy assignment named PolicyAssignment by using the Get-AzPolicyAssignment cmdlet. +The command stores that object in the $PolicyAssignment variable. +The final command updates the display name on the policy assignment on the resource group identified by the **ResourceId** property of $ResourceGroup. + +### Example 2: Add a system assigned managed identity to the policy assignment +```powershell +$PolicyAssignment = Get-AzPolicyAssignment -Name 'PolicyAssignment' +Set-AzPolicyAssignment -Id $PolicyAssignment.ResourceId -IdentityType 'SystemAssigned' -Location 'westus' +``` + +The first command gets the policy assignment named PolicyAssignment from the current subscription by using the Get-AzPolicyAssignment cmdlet. +The command stores that object in the $PolicyAssignment variable. +The final command assigns a system assigned managed identity to the policy assignment. + +### Example 3: Add a user assigned managed identity to the policy assignment +```powershell +$PolicyAssignment = Get-AzPolicyAssignment -Name 'PolicyAssignment' +$UserAssignedIdentity = Get-AzUserAssignedIdentity -ResourceGroupName 'ResourceGroup1' -Name 'UserAssignedIdentity1' + Set-AzPolicyAssignment -Id $PolicyAssignment.ResourceId -IdentityType 'UserAssigned' -Location 'westus' -IdentityId $UserAssignedIdentity.Id +``` + +The first command gets the policy assignment named PolicyAssignment from the current subscription by using the Get-AzPolicyAssignment cmdlet. +The command stores that object in the $PolicyAssignment variable. +The second command gets the user assigned managed identity named UserAssignedIdentity1 by using the Get-AzUserAssignedIdentity cmdlet and stores it in the $UserAssignedIdentity variable. +The final command assigns the user assigned managed identity identified by the **Id** property of $UserAssignedIdentity to the policy assignment. + +### Example 4: Update policy assignment parameters with new policy parameter object +```powershell +$Locations = Get-AzLocation | Where-Object {($_.displayname -like 'france*') -or ($_.displayname -like 'uk*')} +$AllowedLocations = @{'listOfAllowedLocations'=($Locations.location)} +$PolicyAssignment = Get-AzPolicyAssignment -Name 'PolicyAssignment' +Set-AzPolicyAssignment -Id $PolicyAssignment.ResourceId -PolicyParameterObject $AllowedLocations +``` + +The first and second commands create an object containing all Azure regions whose names start with "france" or "uk". +The second command stores that object in the $AllowedLocations variable. +The third command gets the policy assignment named 'PolicyAssignment' +The command stores that object in the $PolicyAssignment variable. +The final command updates the parameter values on the policy assignment named PolicyAssignment. + +### Example 5: Update policy assignment parameters with policy parameter file +<!-- Skip: Output cannot be splitted from code --> +Create a file called _AllowedLocations.json_ in the local working directory with the following content. + +``` +{ + "listOfAllowedLocations": { + "value": [ + "uksouth", + "ukwest", + "francecentral", + "francesouth" + ] + } +} +``` + +```powershell +Set-AzPolicyAssignment -Name 'PolicyAssignment' -PolicyParameter .\AllowedLocations.json +``` + +The command updates the policy assignment named 'PolicyAssignment' using the policy parameter file AllowedLocations.json from the local working directory. + +### Example 6: Update an enforcementMode +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' +$PolicyAssignment = Get-AzPolicyAssignment -Name 'PolicyAssignment' -Scope $ResourceGroup.ResourceId +Set-AzPolicyAssignment -Id $PolicyAssignment.ResourceId -EnforcementMode Default +``` + +The first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet. +The command stores that object in the $ResourceGroup variable. +The second command gets the policy assignment named PolicyAssignment by using the Get-AzPolicyAssignment cmdlet. +The command stores that object in the $PolicyAssignment variable. +The final command updates the enforcementMode property on the policy assignment on the resource group identified by the **ResourceId** property of $ResourceGroup. + +### Example 7: Update non-compliance messages +```powershell +$PolicyAssignment = Get-AzPolicyAssignment -Name 'VirtualMachinePolicy' +Set-AzPolicyAssignment -Id $PolicyAssignment.ResourceId -NonComplianceMessage @{Message="All resources must follow resource naming guidelines."} +``` + +The first command gets the policy assignment named VirtualMachinePolicy by using the Get-AzPolicyAssignment cmdlet and stores it in the $PolicyAssignment variable. +The final command updates the non-compliance messages on the policy assignment with a new message that will be displayed if a resource is denied by the policy. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign a system assigned managed identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' and 'modify' policies. Location is required when assigning an identity. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for policy assignment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +Specifies a new display name for the policy assignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EnforcementMode +The enforcement mode for policy assignment. Currently, valid values are Default, DoNotEnforce. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy.PolicyAssignmentEnforcementMode] +Parameter Sets: (All) +Aliases: +Accepted values: Default, DoNotEnforce + +Required: False +Position: Named +Default value: Default +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id +Specifies the fully qualified resource ID for the policy assignment that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: IdParameterSet, PolicyParameterIdObjectParameterSet, PolicyParameterIdStringParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IdentityId +Specifies the Id of the user assigned managed identity to assign to this policy assignment. This value is required if the value 'UserAssigned' is passed to the -IdentityType parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Specifies the type of managed identity to assign to this policy assignment. If the 'SystemAssigned' value is provided, a system assigned managed identity is generated and assigned to this policy assignment. If the 'UserAssigned' value is provided, the user assigned identity passed via its Id to the -IdentityId parameter is assigned to this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' and 'modify' policies. Location is required when assigning an identity. Permissions must be granted to the identity using New-AzRoleAssignment after the system assigned identity is created. The IdentityType parameter will be given precedence if both the AssignIdentity and the IdentityType parameter are used. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Resources.ManagedIdentityType] +Parameter Sets: (All) +Aliases: +Accepted values: SystemAssigned, UserAssigned, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The policy assignment object to update that was output from another cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the policy assignment's resource identity. This is required when the -IdentityType value is provided. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Metadata +The updated metadata for the policy assignment. This can either be a path to a file name containing the metadata, or the metadata as a string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the policy assignment that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet, PolicyParameterNameObjectParameterSet, PolicyParameterNameStringParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NonComplianceMessage +The non-compliance messages that describe why a resource is non-compliant with the policy. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsNonComplianceMessage[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotScope +The policy assignment not scopes. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyParameter +The new policy parameters file path or string for the policy assignment. + +```yaml +Type: System.String +Parameter Sets: PolicyParameterNameStringParameterSet, PolicyParameterIdStringParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyParameterObject +The new policy parameters object for the policy assignment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: PolicyParameterNameObjectParameterSet, PolicyParameterIdObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Specifies the scope at which the policy is applied. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet, PolicyParameterNameObjectParameterSet, PolicyParameterNameStringParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Nullable`1[[Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy.PolicyAssignmentEnforcementMode, Microsoft.Azure.PowerShell.Cmdlets.ResourceManager, Version=3.5.0.0, Culture=neutral, PublicKeyToken=null]] + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsNonComplianceMessage[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment + +## NOTES + +## RELATED LINKS + +[Get-AzPolicyAssignment](./Get-AzPolicyAssignment.md) + +[New-AzPolicyAssignment](./New-AzPolicyAssignment.md) + +[Remove-AzPolicyAssignment](./Remove-AzPolicyAssignment.md) + + diff --git a/azps-10.1.0/Az.Resources/Set-AzPolicyDefinition.md b/azps-10.1.0/Az.Resources/Set-AzPolicyDefinition.md new file mode 100644 index 0000000000..5ddeab4ea8 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzPolicyDefinition.md @@ -0,0 +1,330 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: E1AC7139-786C-4DD6-A898-242723E0D159 +online version: https://learn.microsoft.com/powershell/module/az.resources/set-azpolicydefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzPolicyDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzPolicyDefinition.md +--- + +# Set-AzPolicyDefinition + +## SYNOPSIS +Modifies a policy definition. + +## SYNTAX + +### NameParameterSet (Default) +``` +Set-AzPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] [-Policy <String>] + [-Metadata <String>] [-Parameter <String>] [-Mode <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ManagementGroupNameParameterSet +``` +Set-AzPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] [-Policy <String>] + [-Metadata <String>] [-Parameter <String>] [-Mode <String>] -ManagementGroupName <String> + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionIdParameterSet +``` +Set-AzPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] [-Policy <String>] + [-Metadata <String>] [-Parameter <String>] [-Mode <String>] -SubscriptionId <Guid> [-ApiVersion <String>] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### IdParameterSet +``` +Set-AzPolicyDefinition -Id <String> [-DisplayName <String>] [-Description <String>] [-Policy <String>] + [-Metadata <String>] [-Parameter <String>] [-Mode <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Set-AzPolicyDefinition [-DisplayName <String>] [-Description <String>] [-Policy <String>] [-Metadata <String>] + [-Parameter <String>] [-Mode <String>] -InputObject <PsPolicyDefinition> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPolicyDefinition** cmdlet modifies a policy definition. + +## EXAMPLES + +### Example 1: Update the description of a policy definition +```powershell +$PolicyDefinition = Get-AzPolicyDefinition -Name 'VMPolicyDefinition' +Set-AzPolicyDefinition -Id $PolicyDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation' +``` + +The first command gets a policy definition named VMPolicyDefinition by using the Get-AzPolicyDefinition cmdlet. +The command stores that object in the $PolicyDefinition variable. +The second command updates the description of the policy definition identified by the **ResourceId** property of $PolicyDefinition. + +### Example 2: Update the mode of a policy definition +```powershell +Set-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All' +``` + +This command updates the policy definition named VMPolicyDefinition by using the Set-AzPolicyDefinition cmdlet to +set its mode property to 'All'. + +### Example 3: Update the metadata of a policy definition +```powershell +Set-AzPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"category":"Virtual Machine"}' +``` + +```output +Name : VMPolicyDefinition +ResourceId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition +ResourceName : VMPolicyDefinition +ResourceType : Microsoft.Authorization/policyDefinitions +SubscriptionId : 11111111-1111-1111-1111-111111111111 +Properties : @{displayName=VMPolicyDefinition; policyType=Custom; mode=All; metadata=; policyRule=} +PolicyDefinitionId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition +``` + +This command updates the metadata of a policy definition named VMPolicyDefinition to indicate its category is "Virtual Machine". + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies a new description for the policy definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +Specifies a new display name for the policy definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id +Specifies the fully qualified resource ID for the policy definition that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The policy definition object to update that was output from another cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyDefinition +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ManagementGroupName +The name of the management group of the policy definition to update. + +```yaml +Type: System.String +Parameter Sets: ManagementGroupNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Metadata +The metadata for policy definition. This can either be a path to a file name containing the metadata, or the metadata as string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Mode +The mode of the new policy definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the policy definition that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet, ManagementGroupNameParameterSet, SubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameter +The parameters declaration for policy definition. This can either be a path to a file name or uri containing the parameters declaration, or the parameters declaration as string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Policy +Specifies new policy rule for the policy definition. +You can specify the path of a .json file or a string that contains the policy in JavaScript Object Notation (JSON) format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID of the policy definition to update. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: SubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS + +[Get-AzPolicyDefinition](./Get-AzPolicyDefinition.md) + +[New-AzPolicyDefinition](./New-AzPolicyDefinition.md) + +[Remove-AzPolicyDefinition](./Remove-AzPolicyDefinition.md) + + diff --git a/azps-10.1.0/Az.Resources/Set-AzPolicyExemption.md b/azps-10.1.0/Az.Resources/Set-AzPolicyExemption.md new file mode 100644 index 0000000000..bc077f231d --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzPolicyExemption.md @@ -0,0 +1,364 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/set-azpolicyexemption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzPolicyExemption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzPolicyExemption.md +--- + +# Set-AzPolicyExemption + +## SYNOPSIS +Modifies a policy exemption. + +## SYNTAX + +### NameParameterSet (Default) +``` +Set-AzPolicyExemption -Name <String> [-Scope <String>] [-DisplayName <String>] [-Description <String>] + [-ExemptionCategory <String>] [-PolicyDefinitionReferenceId <String[]>] [-ExpiresOn <DateTime>] + [-ClearExpiration] [-Metadata <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### IdParameterSet +``` +Set-AzPolicyExemption -Id <String> [-DisplayName <String>] [-Description <String>] + [-ExemptionCategory <String>] [-PolicyDefinitionReferenceId <String[]>] [-ExpiresOn <DateTime>] + [-ClearExpiration] [-Metadata <String>] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Set-AzPolicyExemption [-DisplayName <String>] [-Description <String>] [-ExemptionCategory <String>] + [-PolicyDefinitionReferenceId <String[]>] [-ExpiresOn <DateTime>] [-ClearExpiration] [-Metadata <String>] + -InputObject <PsPolicyExemption> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPolicyExemption** cmdlet modifies a policy exemption. +Specify an exemption by ID or by name and scope. + +## EXAMPLES + +### Example 1: Update the display name +```powershell +$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11' + $PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07' -Scope $ResourceGroup.ResourceId +Set-AzPolicyExemption -Id $PolicyExemption.ResourceId -DisplayName 'Exempt VM creation limit' +``` + +The first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet. +The command stores that object in the $ResourceGroup variable. +The second command gets the policy exemption named PolicyExemption07 by using the Get-AzPolicyExemption cmdlet. +The command stores that object in the $PolicyExemption variable. +The final command updates the display name on the policy exemption on the resource group identified by the **ResourceId** property of $ResourceGroup. + +### Example 2: Update the expiration date time +```powershell +$NextMonth = (Get-Date).AddMonths(1) +$PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07' +Set-AzPolicyExemption -Id $PolicyExemption.ResourceId -ExpiresOn $NextMonth +``` + +The first command gets the current date time by using the Get-Date cmdlet and add 1 month to the current date time +The command stores that object in the $NextMonth variable. +The second command gets the policy exemption named PolicyExemption07 by using the Get-AzPolicyExemption cmdlet. +The command stores that object in the $PolicyExemption variable. +The final command updates the expiration date time for the policy exemption on the default subscription. + +### Example 3: Clear the expiration date time +```powershell +$PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07' +Set-AzPolicyExemption -Id $PolicyExemption.ResourceId -ClearExpiration +``` + +The first command gets the policy exemption named PolicyExemption07 by using the Get-AzPolicyExemption cmdlet. +The command stores that object in the $PolicyExemption variable. +The second command clears the expiration date time for the policy exemption on the default subscription. +The updated exemption will never expire. + +### Example 4: Update the expiration category +```powershell +$PolicyExemption = Get-AzPolicyExemption -Name 'PolicyExemption07' +Set-AzPolicyExemption -Id $PolicyExemption.ResourceId -ExemptionCategory Mitigated +``` + +The first command gets the policy exemption named PolicyExemption07 by using the Get-AzPolicyExemption cmdlet. +The command stores that object in the $PolicyExemption variable. +The second command updates the expiration category for the policy exemption on the default subscription. +The updated exemption will never expire. + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClearExpiration +If set, this switch clears the expiration date and time on the updated policy exemption. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for the updated policy exemption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +The display name for the updated policy exemption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExemptionCategory +The policy exemption category of the updated policy exemption. +Possible values are Waiver and Mitigated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Waiver, Mitigated + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpiresOn +The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the updated policy exemption. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id +The fully qualified policy exemption Id to update, including the scope, e.g. +/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}. + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The policy exemption object to update that was output from another cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyExemption +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Metadata +The metadata for the updated policy exemption. +This can either be a path to a file containing the metadata JSON, or the metadata as a JSON string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the policy exemption to update. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinitionReferenceId +The policy definition reference ID list when the associated policy assignment is for a policy set (initiative). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the updated policy exemption, e.g. +/providers/managementGroups/{managementGroupName}, defaults to current subscription. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=5.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Management.Automation.SwitchParameter + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyExemption + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyExemption + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Set-AzPolicySetDefinition.md b/azps-10.1.0/Az.Resources/Set-AzPolicySetDefinition.md new file mode 100644 index 0000000000..7cf7864fd4 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzPolicySetDefinition.md @@ -0,0 +1,364 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/set-azpolicysetdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzPolicySetDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzPolicySetDefinition.md +--- + +# Set-AzPolicySetDefinition + +## SYNOPSIS +Modifies a policy set definition + +## SYNTAX + +### NameParameterSet (Default) +``` +Set-AzPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] + [-PolicyDefinition <String>] [-Metadata <String>] [-Parameter <String>] [-GroupDefinition <String>] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ManagementGroupNameParameterSet +``` +Set-AzPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] + [-PolicyDefinition <String>] [-Metadata <String>] [-Parameter <String>] -ManagementGroupName <String> + [-GroupDefinition <String>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SubscriptionIdParameterSet +``` +Set-AzPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] + [-PolicyDefinition <String>] [-Metadata <String>] [-Parameter <String>] -SubscriptionId <Guid> + [-GroupDefinition <String>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### IdParameterSet +``` +Set-AzPolicySetDefinition -Id <String> [-DisplayName <String>] [-Description <String>] + [-PolicyDefinition <String>] [-Metadata <String>] [-Parameter <String>] [-GroupDefinition <String>] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Set-AzPolicySetDefinition [-DisplayName <String>] [-Description <String>] [-PolicyDefinition <String>] + [-Metadata <String>] [-Parameter <String>] -InputObject <PsPolicySetDefinition> [-GroupDefinition <String>] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzPolicySetDefinition** cmdlet modifies a policy definition. + +## EXAMPLES + +### Example 1: Update the description of a policy set definition +```powershell +$PolicySetDefinition = Get-AzPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition' +Set-AzPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation' +``` + +The first command gets a policy set definition by using the Get-AzPolicySetDefinition cmdlet. +The command stores that object in the $PolicySetDefinition variable. +The second command updates the description of the policy set definition identified by the **ResourceId** property of $PolicySetDefinition. + +### Example 2: Update the metadata of a policy set definition +```powershell +Set-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}' +``` + +```output +Name : VMPolicySetDefinition +ResourceId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policySetDefinitions/VMPolicySetDefinition +ResourceName : VMPolicySetDefinition +ResourceType : Microsoft.Authorization/policySetDefinitions +SubscriptionId : 11111111-1111-1111-1111-111111111111 +Properties : @{displayName=VMPolicySetDefinition; policyType=Custom; metadata=; parameters=; policyDefinitions=System.Object[]} +PolicySetDefinitionId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policySetDefinitions/VMPolicySetDefinition +``` + +This command updates the metadata of a policy set definition named VMPolicySetDefinition to indicate its category is "Virtual Machine". + +### Example 3: Update the groups of a policy set definition +```powershell +Set-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition '[{ "name": "group1", "displayName": "Virtual Machine Security" }, { "name": "group2" }]' +``` + +This command updates the groups of a policy set definition named VMPolicySetDefinition. + +### Example 4: Update the groups of a policy set definition using a hash table +```powershell +$groupsJson = ConvertTo-Json @{ name = "group1"; displayName = "Virtual Machine Security" }, @{ name = "group2" } +Set-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition $groupsJson +``` + +This command updates the groups of a policy set definition named VMPolicySetDefinition using a hash table to construct the groups. + +## PARAMETERS + +### -ApiVersion +When set, indicates the version of the resource provider API to use. +If not specified, the API version is automatically determined as the latest available. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for policy set definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +The display name for policy set definition. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -GroupDefinition +The policy definition groups of the updated policy set definition. This can either be a path to a file containing the groups, or the groups as a JSON string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id +The fully qualified policy definition Id, including the subscription. +e.g. +/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} + +```yaml +Type: System.String +Parameter Sets: IdParameterSet +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The policy set definition object to update that was output from another cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicySetDefinition +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ManagementGroupName +The name of the management group of the policy set definition to update. + +```yaml +Type: System.String +Parameter Sets: ManagementGroupNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Metadata +The metadata of the updated policy set definition. This can either be a path to a file name containing the metadata, or the metadata as a JSON string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The policy set definition name. + +```yaml +Type: System.String +Parameter Sets: NameParameterSet, ManagementGroupNameParameterSet, SubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameter +The parameters declaration of the updated policy set definition. This can either be a path to a file name or uri containing the parameters declaration, or the parameters declaration as a JSON string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyDefinition +The policy definitions. This can either be a path to a file name containing the policy definitions, or the policy definitions as a JSON string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription ID of the policy set definition to update. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: SubscriptionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Set-AzResource.md b/azps-10.1.0/Az.Resources/Set-AzResource.md new file mode 100644 index 0000000000..a323a03850 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzResource.md @@ -0,0 +1,477 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: A00160B9-831F-4A20-8D9D-9E89BC4F5C91 +online version: https://learn.microsoft.com/powershell/module/az.resources/set-azresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzResource.md +--- + +# Set-AzResource + +## SYNOPSIS +Modifies a resource. + +## SYNTAX + +### ByResourceId (Default) +``` +Set-AzResource [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] [-Sku <Hashtable>] + [-Tag <Hashtable>] [-UsePatchSemantics] [-AsJob] -ResourceId <String> [-ODataQuery <String>] [-Force] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObject +``` +Set-AzResource -InputObject <PSResource> [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] + [-Sku <Hashtable>] [-Tag <Hashtable>] [-UsePatchSemantics] [-AsJob] [-ODataQuery <String>] [-Force] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BySubscriptionLevel +``` +Set-AzResource [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] [-Sku <Hashtable>] + [-Tag <Hashtable>] [-UsePatchSemantics] [-AsJob] -ResourceName <String> -ResourceType <String> + [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] [-ODataQuery <String>] + [-ResourceGroupName <String>] [-Force] [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTenantLevel +``` +Set-AzResource [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] [-Sku <Hashtable>] + [-Tag <Hashtable>] [-UsePatchSemantics] [-AsJob] -ResourceName <String> -ResourceType <String> + [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] [-ODataQuery <String>] [-TenantLevel] + [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzResource** cmdlet modifies an existing Azure resource. +Specify a resource to modify by name and type or by ID. + +## EXAMPLES + +### Example 1: Modify a resource +```powershell +$Resource = Get-AzResource -ResourceType Microsoft.Web/sites -ResourceGroupName ResourceGroup11 -ResourceName ContosoSite +$Resource.Properties.Enabled = "False" +$Resource | Set-AzResource -Force +``` + +The first command gets the resource named ContosoSite by using the Get-AzResource cmdlet, and then stores it in the $Resource variable. +The second command modifies a property of $Resource. +The final command updates the resource to match $Resource. + +### Example 2: Modify all resources in a given resource group +```powershell +$Resource = Get-AzResource -ResourceGroupName testrg +$Resource | ForEach-Object { $_.Tags.Add("testkey", "testval") } +$Resource | Set-AzResource -Force +``` + +```output +Name : kv-test +ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/kv-test +ResourceName : kv-test +ResourceType : Microsoft.KeyVault/vaults +ResourceGroupName : testrg +Location : westus +SubscriptionId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Tags : {testrgkey, key} +Properties : @{} + +Name : testresource +ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Providers.Test/statefulResources/testresource +ResourceName : testresource +ResourceType : Providers.Test/statefulResources +ResourceGroupName : testrg +Location : West US 2 +SubscriptionId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Tags : {testrgkey, anothertesttag} +Properties : @{key=value} +Sku : @{name=A0} +``` + +The first command gets the resources in the testrg resource group, and then stores them in the $Resource variable. + +The second command iterates over each of these resources in the resource group and adds a new tag to them. + +The final command updates each of these resources. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionResourceName +Specifies the name of an extension resource for the resource. +For instance, to specify a database, use the following format: +server name`/`database name + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExtensionResourceType +Specifies the resource type for an extension resource. +For instance, if the extension resource is a database specify the following: +`Microsoft.Sql/Servers/Databases` + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The object representation of the resource to update. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResource +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Specifies the resource kind for the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ODataQuery +Specifies an Open Data Protocol (OData) style filter. +This cmdlet appends this value to the request in addition to any other filters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Plan +Specifies resource plan properties, as a hash table, for the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: PlanObject + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Properties +Specifies resource properties for the resource. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: PropertyObject + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group where this cmdlet modifies the resource. + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the fully qualified resource ID, including the subscription, as in the following example: +`/subscriptions/`subscription ID`/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase` + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +Specifies the name of the resource. +For instance, to specify a database, use the following format: +`ContosoServer/ContosoDatabase` + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +Specifies the type of the resource. +For instance, for a database, the resource type is as follows: +`Microsoft.Sql/Servers/Databases` + +```yaml +Type: System.String +Parameter Sets: BySubscriptionLevel, ByTenantLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Specifies the SKU object of the resource as a hash table. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: SkuObject + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantLevel +Indicates that this cmdlet operates at the tenant level. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByTenantLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePatchSemantics +Indicates that this cmdlet uses an HTTP PATCH to update the object, instead of an HTTP PUT. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResource + +### System.String + +### System.Management.Automation.PSObject + +### System.Collections.Hashtable + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS + +[Get-AzResource](./Get-AzResource.md) + +[Move-AzResource](./Move-AzResource.md) + +[New-AzResource](./New-AzResource.md) + +[Remove-AzResource](./Remove-AzResource.md) diff --git a/azps-10.1.0/Az.Resources/Set-AzResourceGroup.md b/azps-10.1.0/Az.Resources/Set-AzResourceGroup.md new file mode 100644 index 0000000000..990ee1db9d --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzResourceGroup.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 4E5C059B-36F3-41C8-9FDB-69F5318CF39B +online version: https://learn.microsoft.com/powershell/module/az.resources/set-azresourcegroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzResourceGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzResourceGroup.md +--- + +# Set-AzResourceGroup + +## SYNOPSIS +Modifies a resource group. + +## SYNTAX + +### SetByResourceGroupName (Default) +``` +Set-AzResourceGroup -Name <String> [-Tag] <Hashtable> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SetByResourceGroupId +``` +Set-AzResourceGroup [-Tag] <Hashtable> -Id <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzResourceGroup** cmdlet modifies the properties of a resource group. +You can use this cmdlet to add, change, or delete the Azure tags applied to a resource group. +Specify the *Name* parameter to identify the resource group and the *Tag* parameter to modify the tags. +You cannot use this cmdlet to change the name of a resource group. + +## EXAMPLES + +### Example 1: Apply a tag to a resource group +```powershell +Set-AzResourceGroup -Name "ContosoRG" -Tag @{Department="IT"} +``` + +This command applies a Department tag with a value of IT to a resource group that has no existing tags. + +### Example 2: Add tags to a resource group +```powershell +$Tags = (Get-AzResourceGroup -Name "ContosoRG").Tags +$Tags +$Tags += @{"Status"="Approved"; "FY2016"=$null} +Set-AzResourceGroup -Name "ContosoRG" -Tag $Tags +(Get-AzResourceGroup -Name "ContosoRG").Tags +``` + +This example adds a Status tag with a value of Approved and an FY2016 tag to a resource group that +has existing tags. Because the tags you specify replace the existing tags, you must include the +existing tags in the new tag collection or you will lose them. +The first command gets the ContosoRG resource group and uses the dot method to get the value of its +Tags property. The command stores the tags in the $Tags variable. +The second command gets the tags in the $Tags variable. +The third command uses the += assignment operator to add the Status and FY2016 tags to the array of +tags in the $Tags variable. +The fourth command uses the *Tag* parameter of **Set-AzResourceGroup** to apply the tags in +the $Tags variable to the ContosoRG resource group. +The fifth command gets all of the tags applied to the ContosoRG resource group. The output shows +that the resource group has the Department tag and the two new tags, Status and FY2015. + +### Example 3: Delete all tags for a resource group +```powershell +Set-AzResourceGroup -Name "ContosoRG" -Tag @{} +``` + +This command specifies the *Tag* parameter with an empty hash table value to delete all tags from +the ContosoRG resource group. + +## PARAMETERS + +### -ApiVersion +Specifies the API version that is supported by the resource Provider. +You can specify a different version than the default version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the resource group to modify. + +```yaml +Type: System.String +Parameter Sets: SetByResourceGroupId +Aliases: ResourceGroupId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the resource group to modify. + +```yaml +Type: System.String +Parameter Sets: SetByResourceGroupName +Aliases: ResourceGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} +A tag is a name-value pair that you can create and apply to resources and resource groups. After +you assign tags to resources and groups, you can use the *Tag* parameter of Get-AzResource and +Get-AzResourceGroup to search for resources and groups by tag name or name and value. You can +use tags to categorize your resources, such as by department or cost center, or to track notes or +comments about the resources. +To add or change a tag, you must replace the collection of tags for the resource group. To delete a +tag, enter a hash table with all tags currently applied to the resource group, from +**Get-AzResourceGroup**, except for the tag you want to delete. To delete all tags from a +resource group, specify an empty hash table: `@{}`. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceGroup + +## NOTES + +## RELATED LINKS + +[Get-AzResource](./Get-AzResource.md) + +[Get-AzResourceGroup](./Get-AzResourceGroup.md) + +[New-AzResourceGroup](./New-AzResourceGroup.md) + +[Remove-AzResourceGroup](./Remove-AzResourceGroup.md) diff --git a/azps-10.1.0/Az.Resources/Set-AzResourceGroupDeploymentStack.md b/azps-10.1.0/Az.Resources/Set-AzResourceGroupDeploymentStack.md new file mode 100644 index 0000000000..1773df0841 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzResourceGroupDeploymentStack.md @@ -0,0 +1,545 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/Set-AzResourceGroupDeploymentStack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzResourceGroupDeploymentStack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzResourceGroupDeploymentStack.md +--- + +# Set-AzResourceGroupDeploymentStack + +## SYNOPSIS +Sets a new Resource Group scoped Deployment Stack. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +Set-AzResourceGroupDeploymentStack [-Name] <String> [-ResourceGroupName] <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileWithParameterFile +``` +Set-AzResourceGroupDeploymentStack [-Name] <String> [-ResourceGroupName] <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateFile <String> + -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileWithParameterUri +``` +Set-AzResourceGroupDeploymentStack [-Name] <String> [-ResourceGroupName] <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateFile <String> + -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileWithParameterObject +``` +Set-AzResourceGroupDeploymentStack [-Name] <String> [-ResourceGroupName] <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateFile <String> + -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithParameterFile +``` +Set-AzResourceGroupDeploymentStack [-Name] <String> [-ResourceGroupName] <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateUri <String> + -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithParameterUri +``` +Set-AzResourceGroupDeploymentStack [-Name] <String> [-ResourceGroupName] <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateUri <String> + -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithParameterObject +``` +Set-AzResourceGroupDeploymentStack [-Name] <String> [-ResourceGroupName] <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateUri <String> + -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +Set-AzResourceGroupDeploymentStack [-Name] <String> [-ResourceGroupName] <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterFile +``` +Set-AzResourceGroupDeploymentStack [-Name] <String> [-ResourceGroupName] <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateSpecId <String> + -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterUri +``` +Set-AzResourceGroupDeploymentStack [-Name] <String> [-ResourceGroupName] <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateSpecId <String> + -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterObject +``` +Set-AzResourceGroupDeploymentStack [-Name] <String> [-ResourceGroupName] <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateSpecId <String> + -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithNoParameters +``` +Set-AzResourceGroupDeploymentStack [-Name] <String> [-ResourceGroupName] <String> [-Description <String>] + [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] -DenySettingsMode <PSDenySettingsMode> + [-DenySettingsExcludedPrincipal <String[]>] [-DenySettingsExcludedAction <String[]>] + [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] [-AsJob] -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update a resource group scoped deployment stack. + +## EXAMPLES + +### Example 1: Update the stack MyRGStack in the Resource Group MyResourceGroup +```powershell +Set-AzResourceGroupDeploymentStack -Name MyRGStack -ResourceGroupName MyResourceGroup -TemplateFile myTemplate.json -DenySettingsMode DenyDelete +``` + +Update a resource group scoped deployment stack named 'MyRGStack' in management group 'MyResoourceGroup,' with deny settings being DenyDelete. + + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteAll +Signal to delete both unmanaged Resources and ResourceGroups after deleting stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResourceGroups +Signal to delete unmanaged stack ResourceGroups after deleting stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResources +Signal to delete unmanaged stack Resources after deleting stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsApplyToChildScopes +Apply to child scopes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsExcludedAction +List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsExcludedPrincipal +List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsMode +Mode for DenySettings. +Possible values include: 'denyDelete', 'denyWriteAndDelete', and 'none'. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDenySettingsMode +Parameter Sets: (All) +Aliases: +Accepted values: None, DenyDelete, DenyWriteAndDelete + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description for the stack + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation when overwriting an existing stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deploymentStack to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StackName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the ResourceGroup to be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to put on the deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +TemplateFile to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileWithParameterFile, ByTemplateFileWithParameterUri, ByTemplateFileWithParameterObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +Parameter file to use for the template. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithParameterFile, ByTemplateUriWithParameterFile, ByTemplateSpecWithParameterFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateFileWithParameterObject, ByTemplateUriWithParameterObject, ByTemplateSpecWithParameterObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Location of the Parameter file to use for the template. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithParameterUri, ByTemplateUriWithParameterUri, ByTemplateSpecWithParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +ResourceId of the TemplateSpec to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecWithParameterFile, ByTemplateSpecWithParameterUri, ByTemplateSpecWithParameterObject, ByTemplateSpecWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Location of the Template to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriWithParameterFile, ByTemplateUriWithParameterUri, ByTemplateUriWithParameterObject, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStack + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Set-AzResourceLock.md b/azps-10.1.0/Az.Resources/Set-AzResourceLock.md new file mode 100644 index 0000000000..3e61435068 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzResourceLock.md @@ -0,0 +1,317 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 770093CD-CE2A-4076-8A28-F4DCFFB7A075 +online version: https://learn.microsoft.com/powershell/module/az.resources/set-azresourcelock +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzResourceLock.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzResourceLock.md +--- + +# Set-AzResourceLock + +## SYNOPSIS +Modifies a resource lock. + +## SYNTAX + +### BySpecifiedScope (Default) +``` +Set-AzResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] -Scope <String> + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceGroup +``` +Set-AzResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] + -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceGroupLevel +``` +Set-AzResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] + -ResourceName <String> -ResourceType <String> -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BySubscription +``` +Set-AzResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BySubscriptionLevel +``` +Set-AzResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] + -ResourceName <String> -ResourceType <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByLockId +``` +Set-AzResourceLock -LockLevel <LockLevel> [-LockNotes <String>] [-Force] -LockId <String> + [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzResourceLock** cmdlet modifies a resource lock. + +## EXAMPLES + +### Example 1: Update notes for a lock +```powershell +Set-AzResourceLock -LockLevel CanNotDelete -LockNotes "Updated note" -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites" -ResourceGroupName "ResourceGroup11" +``` + +This command updates the note for a lock named ContosoSiteLock. + +## PARAMETERS + +### -ApiVersion +Specifies the version of the resource provider API to use. +If you do not specify a version, this cmdlet uses the latest available version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LockId +Specifies the ID of the lock that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: ByLockId +Aliases: Id, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LockLevel +Specifies the level for the lock. +Currently, the only valid value is CanNotDelete. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Locks.LockLevel +Parameter Sets: (All) +Aliases: Level +Accepted values: CanNotDelete, ReadOnly + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LockName +Specifies the name of the lock that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: BySpecifiedScope, ByResourceGroup, ByResourceGroupLevel, BySubscription, BySubscriptionLevel +Aliases: ExtensionResourceName, Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LockNotes +Specifies the notes for the lock. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Notes + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for which the lock applies. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup, ByResourceGroupLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceName +Specifies the name of the resource for which the lock applies. +For instance, to specify a database, use the following format: +Server`/`Database + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +Specifies the resource type for which the lock applies. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +Specifies the scope to which the lock applies. +For instance, to specify a database, use the following format: +`/subscriptions/`subscription ID`/resourceGroups/`resource group name`/providers/Microsoft.Sql/servers/`server name`/databases/`database name +To specify a resource group, use the following format: +`/subscriptions/`subscription ID`/resourceGroups/`resource group name + +```yaml +Type: System.String +Parameter Sets: BySpecifiedScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Locks.LockLevel + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS + +[Get-AzResourceLock](./Get-AzResourceLock.md) + +[New-AzResourceLock](./New-AzResourceLock.md) + +[Remove-AzResourceLock](./Remove-AzResourceLock.md) + + diff --git a/azps-10.1.0/Az.Resources/Set-AzRoleAssignment.md b/azps-10.1.0/Az.Resources/Set-AzRoleAssignment.md new file mode 100644 index 0000000000..3bb15994a4 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzRoleAssignment.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/set-azroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzRoleAssignment.md +--- + +# Set-AzRoleAssignment + +## SYNOPSIS +Update an existing Role Assignment. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +- GET /users/{id} +- GET /servicePrincipals/{id} +- GET /groups/{id} +- GET /directoryObjects/{id} +- POST /directoryObjects/getByIds + +Please notice that this cmdlet will mark `ObjectType` as `Unknown` in output if the object of role assignment is not found or current account has insufficient privileges to get object type. + +## SYNTAX + +### RoleAssignmentParameterSet (Default) +``` +Set-AzRoleAssignment -InputObject <PSRoleAssignment> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputFileParameterSet +``` +Set-AzRoleAssignment -InputFile <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use the Set-AzRoleAssignment command to modify an existing assignment. +Descriptions can be any valid string, use that to diferentiate from one another. +if Condition is set Condition Version has to be set as well but if you're updating a Condition that is not necesary. +Condition Version can be upgraded from 1.0 to 2.0 but it can't not be downgraded back. Be cautious as 2.0 is not retrocompatible with 1.0. + +## EXAMPLES + +### Example 1 +```powershell +$ConditionVersion = "2.0" + $Description = "This is a new role assignment for John" + $Condition = "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers/blobs:Path] StringEqualsIgnoreCase 'foo_storage_container'" + + $roleAssignment = Get-AzRoleAssignment -Scope "/subscriptions/4e5329a6-39ce-4e13-b12e-11b30f015986/resourceGroups/contoso_rg" -PrincipalId "0c0f6cdc-90dd-4664-83c0-a0d986c4c604" + $roleAssignment.Description = $Description + $roleAssignment.Condition = $Condition + $roleAssignment.ConditionVersion = $ConditionVersion + + Set-AzRoleAssignment -InputObject $roleAssignment -PassThru +``` + +```output +RoleAssignmentId : /providers/Microsoft.Management/managementGroups/1273adef-00a3 + -4086-a51a-dbcce1857d36/providers/Microsoft.Authorization/role + Assignments/926c2a76-be19-4281-94de-38777629b9dc + Scope : /subscriptions/4e5329a6-39ce-4e13-b12e-11b30f015986/resourceGroups/contoso_rg + DisplayName : John Doe + SignInName : John.Doe@Contoso.com + RoleDefinitionName : Owner + RoleDefinitionId : 8e3af657-a8ff-443c-a75c-2fe8c4bcb635 + ObjectId : 0c0f6cdc-90dd-4664-83c0-a0d986c4c604 + ObjectType : User + CanDelegate : False + Description : This is a new role assignment for John + ConditionVersion : 2.0 + Condition : @Resource[Microsoft.Storage/storageAccounts/blobServices/containers/blobs:Path] StringEqualsIgnoreCase 'foo_storage_container' +``` + +Update an existing role assignment by modifying an object + +### Example 2 +```powershell +Set-AzRoleAssignment -InputFile "C:\RoleAssignments\example.json" -PassThru +``` + +```output +RoleAssignmentId : /providers/Microsoft.Management/managementGroups/1273adef-00a3 + -4086-a51a-dbcce1857d36/providers/Microsoft.Authorization/role + Assignments/926c2a76-be19-4281-94de-38777629b9dc + Scope : /subscriptions/4e5329a6-39ce-4e13-b12e-11b30f015986/resourceGroups/contoso_rg + DisplayName : John Doe + SignInName : John.Doe@Contoso.com + RoleDefinitionName : Owner + RoleDefinitionId : 8e3af657-a8ff-443c-a75c-2fe8c4bcb635 + ObjectId : 0c0f6cdc-90dd-4664-83c0-a0d986c4c604 + ObjectType : User + CanDelegate : False + Description : This is a new role assignment for John + ConditionVersion : 2.0 + Condition : @Resource[Microsoft.Storage/storageAccounts/blobServices/containers/blobs:Path] StringEqualsIgnoreCase 'foo_storage_container' +``` + +Update an existing role assignment by using a file + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +File name containing a single role definition. + +```yaml +Type: System.String +Parameter Sets: InputFileParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Role Assignment. + +```yaml +Type: Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment +Parameter Sets: RoleAssignmentParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If specified, displays the updated role assignment + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Set-AzRoleDefinition.md b/azps-10.1.0/Az.Resources/Set-AzRoleDefinition.md new file mode 100644 index 0000000000..bffb28ea39 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzRoleDefinition.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 115A7612-4856-47AE-AEE4-918350CD7009 +online version: https://learn.microsoft.com/powershell/module/az.resources/set-azroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzRoleDefinition.md +--- + +# Set-AzRoleDefinition + +## SYNOPSIS +Modifies a custom role in Azure RBAC. +Provide the modified role definition either as a JSON file or as a PSRoleDefinition. +First, use the Get-AzRoleDefinition command to retrieve the custom role that you wish to modify. +Then, modify the properties that you wish to change. +Finally, save the role definition using this command. + +## SYNTAX + +### InputFileParameterSet +``` +Set-AzRoleDefinition -InputFile <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### RoleDefinitionParameterSet +``` +Set-AzRoleDefinition -Role <PSRoleDefinition> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzRoleDefinition cmdlet updates an existing custom role in Azure Role-Based Access Control. Provide the updated role definition as an input to the command as a JSON file or a PSRoleDefinition object. The role definition for the updated custom role MUST contain the Id and all other required properties of the role even if they are not updated: DisplayName, Description, Actions, AssignableScopes. NotActions, DataActions, NotDataActions are optional. + +## EXAMPLES + +### Example 1: Update using PSRoleDefinitionObject +```powershell +$roleDef = Get-AzRoleDefinition "Contoso On-Call" +$roleDef.Actions.Add("Microsoft.ClassicCompute/virtualmachines/start/action") +$roleDef.Description = "Can monitor all resources and start and restart virtual machines" +$roleDef.AssignableScopes = @("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") +Set-AzRoleDefinition -Role $roleDef +``` + +### Example 2: Create using JSON file +```powershell +Set-AzRoleDefinition -InputFile C:\Temp\roleDefinition.json +<# +Following is a sample updated role definition json for Set-AzRoleDefinition: +{ + "Id": "52a6cc13-ff92-47a8-a39b-2a8205c3087e", + "Name": "Updated Role", + "Description": "Can monitor all resources and start and restart virtual machines", + "Actions": + [ + "*/read", + "Microsoft.ClassicCompute/virtualmachines/restart/action", + "Microsoft.ClassicCompute/virtualmachines/start/action" + ], + "NotActions": + [ + "*/write" + ], + "DataActions": + [ + "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read" + ], + "NotDataActions": + [ + "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write" + ], + "AssignableScopes": ["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] +} +#> +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputFile +File name containing a single json role definition to be updated. +Only include the properties that are to be updated in the JSON. +Id property is Required. + +```yaml +Type: System.String +Parameter Sets: InputFileParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +Role definition object to be updated + +```yaml +Type: Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition +Parameter Sets: RoleDefinitionParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition + +## NOTES +Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment + +## RELATED LINKS + +[Get-AzProviderOperation](./Get-AzProviderOperation.md) + +[Get-AzRoleDefinition](./Get-AzRoleDefinition.md) + +[New-AzRoleDefinition](./New-AzRoleDefinition.md) + +[Remove-AzRoleDefinition](./Remove-AzRoleDefinition.md) + diff --git a/azps-10.1.0/Az.Resources/Set-AzSubscriptionDeploymentStack.md b/azps-10.1.0/Az.Resources/Set-AzSubscriptionDeploymentStack.md new file mode 100644 index 0000000000..c04d392129 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzSubscriptionDeploymentStack.md @@ -0,0 +1,568 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/Set-AzSubscriptionDeploymentStack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzSubscriptionDeploymentStack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzSubscriptionDeploymentStack.md +--- + +# Set-AzSubscriptionDeploymentStack + +## SYNOPSIS +Sets a new Subscription scoped Deployment Stack. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +Set-AzSubscriptionDeploymentStack -Name <String> [-Description <String>] -Location <String> + [-DeploymentResourceGroupName <String>] [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateFile <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateFileWithParameterFile +``` +Set-AzSubscriptionDeploymentStack -Name <String> [-Description <String>] -Location <String> + [-DeploymentResourceGroupName <String>] [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateFile <String> -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateFileWithParameterUri +``` +Set-AzSubscriptionDeploymentStack -Name <String> [-Description <String>] -Location <String> + [-DeploymentResourceGroupName <String>] [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateFile <String> -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateFileWithParameterObject +``` +Set-AzSubscriptionDeploymentStack -Name <String> [-Description <String>] -Location <String> + [-DeploymentResourceGroupName <String>] [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateFile <String> -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriWithParameterFile +``` +Set-AzSubscriptionDeploymentStack -Name <String> [-Description <String>] -Location <String> + [-DeploymentResourceGroupName <String>] [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateUri <String> -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriWithParameterUri +``` +Set-AzSubscriptionDeploymentStack -Name <String> [-Description <String>] -Location <String> + [-DeploymentResourceGroupName <String>] [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateUri <String> -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriWithParameterObject +``` +Set-AzSubscriptionDeploymentStack -Name <String> [-Description <String>] -Location <String> + [-DeploymentResourceGroupName <String>] [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateUri <String> -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +Set-AzSubscriptionDeploymentStack -Name <String> [-Description <String>] -Location <String> + [-DeploymentResourceGroupName <String>] [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateUri <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterFile +``` +Set-AzSubscriptionDeploymentStack -Name <String> [-Description <String>] -Location <String> + [-DeploymentResourceGroupName <String>] [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateSpecId <String> -TemplateParameterFile <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterUri +``` +Set-AzSubscriptionDeploymentStack -Name <String> [-Description <String>] -Location <String> + [-DeploymentResourceGroupName <String>] [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateSpecId <String> -TemplateParameterUri <String> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecWithParameterObject +``` +Set-AzSubscriptionDeploymentStack -Name <String> [-Description <String>] -Location <String> + [-DeploymentResourceGroupName <String>] [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateSpecId <String> -TemplateParameterObject <Hashtable> [-SkipTemplateParameterPrompt] + [-QueryString <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByTemplateSpecWithNoParameters +``` +Set-AzSubscriptionDeploymentStack -Name <String> [-Description <String>] -Location <String> + [-DeploymentResourceGroupName <String>] [-DeleteAll] [-DeleteResources] [-DeleteResourceGroups] + -DenySettingsMode <PSDenySettingsMode> [-DenySettingsExcludedPrincipal <String[]>] + [-DenySettingsExcludedAction <String[]>] [-DenySettingsApplyToChildScopes] [-Tag <Hashtable>] [-Force] + [-AsJob] -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-QueryString <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update a subscription scoped deployment stack. + +## EXAMPLES + +### Example 1: Updates the subscription scoped deployment stack MySubStack at the current subscription +```powershell +Set-AzSubscriptionDeploymentStack -Name MySubStack -TemplateFile myTemplate.json -Location westus -DenySettingsMode DenyDelete +``` + +Update a subscription scoped deployment stack named 'MySubStack' in the default subscription, with deny settings being DenyDelete. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteAll +Signal to delete both unmanaged Resources and ResourceGroups after deleting stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResourceGroups +Signal to delete unmanaged stack ResourceGroups after deleting stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteResources +Signal to delete unmanaged stack Resources after deleting stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsApplyToChildScopes +Apply to child scopes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsExcludedAction +List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsExcludedPrincipal +List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenySettingsMode +Mode for DenySettings. +Possible values include: 'denyDelete', 'denyWriteAndDelete', and 'none'. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDenySettingsMode +Parameter Sets: (All) +Aliases: +Accepted values: None, DenyDelete, DenyWriteAndDelete + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentResourceGroupName +The ResourceGroup at which the deployment will be created. If none is specified, it will default to the subscription level scope of the deployment stack. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description for the stack. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation when overwriting an existing stack. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location of the stack. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the deploymentStack to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StackName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to put on the deployment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +TemplateFile to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileWithParameterFile, ByTemplateFileWithParameterUri, ByTemplateFileWithParameterObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +Parameter file to use for the template. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithParameterFile, ByTemplateUriWithParameterFile, ByTemplateSpecWithParameterFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateFileWithParameterObject, ByTemplateUriWithParameterObject, ByTemplateSpecWithParameterObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Location of the Parameter file to use for the template. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithParameterUri, ByTemplateUriWithParameterUri, ByTemplateSpecWithParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +ResourceId of the TemplateSpec to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecWithParameterFile, ByTemplateSpecWithParameterUri, ByTemplateSpecWithParameterObject, ByTemplateSpecWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Location of the Template to be used to create the stack. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriWithParameterFile, ByTemplateUriWithParameterUri, ByTemplateUriWithParameterObject, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStack + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Set-AzTemplateSpec.md b/azps-10.1.0/Az.Resources/Set-AzTemplateSpec.md new file mode 100644 index 0000000000..3dd13d710e --- /dev/null +++ b/azps-10.1.0/Az.Resources/Set-AzTemplateSpec.md @@ -0,0 +1,382 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/set-aztemplatespec +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzTemplateSpec.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Set-AzTemplateSpec.md +--- + +# Set-AzTemplateSpec + +## SYNOPSIS +Modifies a Template Spec. + +## SYNTAX + +### FromJsonStringParameterSet (Default) +``` +Set-AzTemplateSpec [-Location <String>] [-Tag <Hashtable>] [-UIFormDefinitionFile <String>] + [-UIFormDefinitionString <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByIdParameterSet +``` +Set-AzTemplateSpec [-ResourceId] <String> [[-Description] <String>] [[-DisplayName] <String>] + [-Location <String>] [-Tag <Hashtable>] [-UIFormDefinitionFile <String>] [-UIFormDefinitionString <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateVersionByIdFromJsonFileParameterSet +``` +Set-AzTemplateSpec [-ResourceId] <String> [-Version] <String> [[-Description] <String>] + [[-DisplayName] <String>] [-Location <String>] [-Tag <Hashtable>] -TemplateFile <String> + [-VersionDescription <String>] [-UIFormDefinitionFile <String>] [-UIFormDefinitionString <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateVersionByIdFromJsonParameterSet +``` +Set-AzTemplateSpec [-ResourceId] <String> [-Version] <String> [[-Description] <String>] + [[-DisplayName] <String>] [-Location <String>] [-Tag <Hashtable>] -TemplateJson <String> + [-VersionDescription <String>] [-UIFormDefinitionFile <String>] [-UIFormDefinitionString <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByNameParameterSet +``` +Set-AzTemplateSpec [-ResourceGroupName] <String> [-Name] <String> [[-Description] <String>] + [[-DisplayName] <String>] [-Location <String>] [-Tag <Hashtable>] [-UIFormDefinitionFile <String>] + [-UIFormDefinitionString <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateVersionByNameFromJsonFileParameterSet +``` +Set-AzTemplateSpec [-ResourceGroupName] <String> [-Name] <String> [-Version] <String> [[-Description] <String>] + [[-DisplayName] <String>] [-Location <String>] [-Tag <Hashtable>] -TemplateFile <String> + [-VersionDescription <String>] [-UIFormDefinitionFile <String>] [-UIFormDefinitionString <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateVersionByNameFromJsonParameterSet +``` +Set-AzTemplateSpec [-ResourceGroupName] <String> [-Name] <String> [-Version] <String> [[-Description] <String>] + [[-DisplayName] <String>] [-Location <String>] [-Tag <Hashtable>] -TemplateJson <String> + [-VersionDescription <String>] [-UIFormDefinitionFile <String>] [-UIFormDefinitionString <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Modifies a Templace Spec. If the Template Spec with the specified name and/or specific version does not already exist, it will be +created. + +When modifying a Template Spec version's ARM Template content, the content can either come from a raw +JSON string (using **UpdateVersionByNameFromJsonParameterSet** parameter set) or from a specified JSON/Bicep file +(using **UpdateVersionByNameFromJsonFileParameterSet** parameter set). + +## EXAMPLES + +### Example 1 +```powershell +$templateJson = @" +{ + "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#", + "contentVersion": "1.0.0.0", + "parameters": {}, + "resources": [] +} +"@ +Set-AzTemplateSpec -ResourceGroupName 'myRG' -Name 'myTemplateSpec' -Version 'v1.0' -Location 'West US' -TemplateJson $templateJson +``` + +Modifies version "v1.0" of a Template Spec named "myTemplateSpec". The specified version +will have $templateJson as the version's ARM Template content. If the root Template Spec and/or version +do not already exist they will be created. + + +**Notes:** + +* The ARM Template in the example is a no-op as it contains no actual resources. +* Location is only required when the Template Spec does not already exist + +### Example 2 +```powershell +Set-AzTemplateSpec -ResourceGroupName 'myRG' -Name 'myTemplateSpec' -Version 'v2.0' -Location 'West US' -TemplateFile 'myTemplateContent.json' +``` + +Modifies version "v2.0" of a Template Spec named "myTemplateSpec". The specified version +will have the content from the local file "myTemplateContent.json" as the version's ARM Template content. If the +root Template Spec and/or version do not already exist they will be created. + +**Note:** Location is only required when the Template Spec does not already exist + +### Example 3 +```powershell +Set-AzTemplateSpec -ResourceGroupName 'myRG' -Name 'myTemplateSpec' -Location 'West US' -Description 'My updated Template Spec' +``` + +Modifies the description of the Template Spec named "myTemplateSpec" in resource group "myRG". If the +Template Spec does not already exist it will be created. + +**Note:** Location is only required when the Template Spec does not already exist + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the template spec. + +```yaml +Type: System.String +Parameter Sets: UpdateByIdParameterSet, UpdateVersionByIdFromJsonFileParameterSet, UpdateVersionByIdFromJsonParameterSet, UpdateByNameParameterSet, UpdateVersionByNameFromJsonFileParameterSet, UpdateVersionByNameFromJsonParameterSet +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +The display name of the template spec. + +```yaml +Type: System.String +Parameter Sets: UpdateByIdParameterSet, UpdateVersionByIdFromJsonFileParameterSet, UpdateVersionByIdFromJsonParameterSet, UpdateByNameParameterSet, UpdateVersionByNameFromJsonFileParameterSet, UpdateVersionByNameFromJsonParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +The location of the template spec. +Only required if the template spec does not already exist. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the template spec. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, UpdateVersionByNameFromJsonFileParameterSet, UpdateVersionByNameFromJsonParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, UpdateVersionByNameFromJsonFileParameterSet, UpdateVersionByNameFromJsonParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The fully qualified resource Id of the template spec. +Example: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName} + +```yaml +Type: System.String +Parameter Sets: UpdateByIdParameterSet, UpdateVersionByIdFromJsonFileParameterSet, UpdateVersionByIdFromJsonParameterSet +Aliases: Id + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Hashtable of tags for the template spec and/or version + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +The file path to the local Azure Resource Manager template JSON/Bicep file. + +```yaml +Type: System.String +Parameter Sets: UpdateVersionByIdFromJsonFileParameterSet, UpdateVersionByNameFromJsonFileParameterSet +Aliases: InputFile + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateJson +The Azure Resource Manager template JSON. + +```yaml +Type: System.String +Parameter Sets: UpdateVersionByIdFromJsonParameterSet, UpdateVersionByNameFromJsonParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UIFormDefinitionFile +UIForm for the templatespec resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UIFormDefinitionString +UIForm for the templatespec resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +The version of the template spec. + +```yaml +Type: System.String +Parameter Sets: UpdateVersionByIdFromJsonFileParameterSet, UpdateVersionByIdFromJsonParameterSet, UpdateVersionByNameFromJsonFileParameterSet, UpdateVersionByNameFromJsonParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VersionDescription +The description of the version. + +```yaml +Type: System.String +Parameter Sets: UpdateVersionByIdFromJsonFileParameterSet, UpdateVersionByIdFromJsonParameterSet, UpdateVersionByNameFromJsonFileParameterSet, UpdateVersionByNameFromJsonParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSTemplateSpec + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Start-AzTenantBackfill.md b/azps-10.1.0/Az.Resources/Start-AzTenantBackfill.md new file mode 100644 index 0000000000..47af07c07a --- /dev/null +++ b/azps-10.1.0/Az.Resources/Start-AzTenantBackfill.md @@ -0,0 +1,96 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/start-aztenantbackfill +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Start-AzTenantBackfill.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Start-AzTenantBackfill.md +--- + +# Start-AzTenantBackfill + +## SYNOPSIS +Starts backfilling subscriptions for the current Tenant + +## SYNTAX + +``` +Start-AzTenantBackfill [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzTenantBackfill** starts backfilling subscriptions under the current tenant + +## EXAMPLES + +### Example 1: Start Backfilling the Current Tenant +```powershell +Start-AzTenantBackfill +``` + +```output +Name : Completed +Type : c7a87cda-9a66-4920-b0f8-869baa04efe0 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSBackfillStatus + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Stop-AzDeployment.md b/azps-10.1.0/Az.Resources/Stop-AzDeployment.md new file mode 100644 index 0000000000..876a50ed27 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Stop-AzDeployment.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/stop-azdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Stop-AzDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Stop-AzDeployment.md +--- + +# Stop-AzDeployment + +## SYNOPSIS +Cancel a running deployment + +## SYNTAX + +### StopByDeploymentName (Default) +``` +Stop-AzDeployment [-Name] <String> [-PassThru] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### StopByDeploymentId +``` +Stop-AzDeployment -Id <String> [-PassThru] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### StopByInputObject +``` +Stop-AzDeployment -InputObject <PSDeployment> [-PassThru] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzDeployment** cmdlet cancels a deployment at subscription scope that has started but not completed. +To stop a deployment, the deployment must have an incomplete provisioning state, such as Provisioning, and not a completed state, such as Provisioned or Failed. + +To create a deployment at subscription scope, use the New-AzDeployment cmdlet. + +This cmdlet stops only one running deployment. Use the *Name* parameter to stop a specific deployment. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzDeployment -Name "deployment01" +``` + +This command cancels a running deployment "deployment01" at the current subscription scope. + +### Example 2 +```powershell +Get-AzDeployment -Name "deployment01" | Stop-AzDeployment +``` + +This command gets the deployment "deployment01" at the current subscription scope and cancels it. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified resource Id of the deployment. +example: /subscriptions/{subId}/providers/Microsoft.Resources/deployments/{deploymentName} + +```yaml +Type: System.String +Parameter Sets: StopByDeploymentId +Aliases: DeploymentId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The deployment object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment +Parameter Sets: StopByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the deployment. + +```yaml +Type: System.String +Parameter Sets: StopByDeploymentName +Aliases: DeploymentName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Stop-AzManagementGroupDeployment.md b/azps-10.1.0/Az.Resources/Stop-AzManagementGroupDeployment.md new file mode 100644 index 0000000000..5178668b52 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Stop-AzManagementGroupDeployment.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/stop-azmanagementgroupdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Stop-AzManagementGroupDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Stop-AzManagementGroupDeployment.md +--- + +# Stop-AzManagementGroupDeployment + +## SYNOPSIS +Cancel a running deployment at a management group + +## SYNTAX + +### StopByDeploymentName (Default) +``` +Stop-AzManagementGroupDeployment [-ManagementGroupId] <String> [-Name] <String> [-PassThru] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByDeploymentId +``` +Stop-AzManagementGroupDeployment -Id <String> [-PassThru] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByInputObject +``` +Stop-AzManagementGroupDeployment -InputObject <PSDeployment> [-PassThru] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzManagementGroupDeployment** cmdlet cancels a deployment that has started but not completed at a management group. +To stop a deployment, the deployment must have an incomplete provisioning state, such as Provisioning, and not a completed state, such as Provisioned or Failed. + +To create a deployment at a management group, use the New-AzManagementGroupDeployment cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzManagementGroupDeployment -ManagementGroupId "myMG" -Name "deployment01" +``` + +This command cancels a running deployment "deployment01" at the management group "myMG". + +### Example 2 +```powershell +Get-AzManagementGroupDeployment -ManagementGroupId "myMG" -Name "deployment01" | Stop-AzManagementGroupDeployment +``` + +This command gets the deployment "deployment01" at the management group "myMG" and cancels it. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified resource Id of the deployment. +example: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deployments/{deploymentName} + +```yaml +Type: System.String +Parameter Sets: StopByDeploymentId +Aliases: DeploymentId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The deployment object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment +Parameter Sets: StopByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group id. + +```yaml +Type: System.String +Parameter Sets: StopByDeploymentName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deployment. + +```yaml +Type: System.String +Parameter Sets: StopByDeploymentName +Aliases: DeploymentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Stop-AzResourceGroupDeployment.md b/azps-10.1.0/Az.Resources/Stop-AzResourceGroupDeployment.md new file mode 100644 index 0000000000..73e49551d0 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Stop-AzResourceGroupDeployment.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 089954C3-7F3E-46C2-AA93-C0151EACDA2F +online version: https://learn.microsoft.com/powershell/module/az.resources/stop-azresourcegroupdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Stop-AzResourceGroupDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Stop-AzResourceGroupDeployment.md +--- + +# Stop-AzResourceGroupDeployment + +## SYNOPSIS +Cancels a resource group deployment. + +## SYNTAX + +### StopByResourceGroupDeploymentName (Default) +``` +Stop-AzResourceGroupDeployment [-ResourceGroupName] <String> [-Name] <String> [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByResourceGroupDeploymentId +``` +Stop-AzResourceGroupDeployment -Id <String> [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzResourceGroupDeployment** cmdlet cancels an Azure resource group deployment that has started but not completed. +To stop a deployment, the deployment must have an incomplete provisioning state, such as Provisioning, and not a completed state, such as Provisioned or Failed. +An Azure resource is a user-managed entity, such as a website, database, or database server. +A resource group is a collection of resources that are deployed as a unit. +To deploy a resource group, use the New-AzResourceGroupDeployment cmdlet. +The New-AzResource cmdlet creates a new resource, but it does not trigger a resource group deployment operation that this cmdlet can stop. +This cmdlet stops only one running deployment. +Use the *Name* parameter to stop a specific deployment. +If you omit the *Name* parameter, **Stop-AzResourceGroupDeployment** searches for a running deployment and stops it. +If the cmdlet finds more than one running deployment, the command fails. + +## EXAMPLES + +### Example 1: Starting and stopping a resource group deployment +<!-- Skip: Output cannot be splitted from code --> + +```powershell +New-AzResourceGroupDeployment -Name mynewstorageaccount -ResourceGroupName myrg -TemplateFile .\storage-account-create-azdeploy.json -TemplateParameterFile .\storage-account-create-azdeploy.parameters.json -AsJob + +Id Name PSJobTypeName State HasMoreData Location Command +-- ---- ------------- ----- ----------- -------- ------- +1 Long Running... AzureLongRun... Running True localhost New-AzResourceGro... + +Stop-AzResourceGroupDeployment -Name mynewstorageaccount -ResourceGroupName myrg + +True + +Get-Job 1 + +Id Name PSJobTypeName State HasMoreData Location Command +-- ---- ------------- ----- ----------- -------- ------- +1 Long Running... AzureLongRun... Failed True localhost New-AzResourceGro... +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Specifies the ID of the resource group deployment to stop. + +```yaml +Type: System.String +Parameter Sets: StopByResourceGroupDeploymentId +Aliases: DeploymentId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the resource group deployment to stop. +If you do not specify this parameter, this cmdlet searches for a running deployment in the resource group and stops it. +If it finds more than one running deployment, the command fails. +To get the deployment name, use the Get-AzResourceGroupDeployment cmdlet. + +```yaml +Type: System.String +Parameter Sets: StopByResourceGroupDeploymentName +Aliases: DeploymentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. +This cmdlet stops the deployment of the resource group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: StopByResourceGroupDeploymentName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzResourceGroupDeployment](./Get-AzResourceGroupDeployment.md) + +[New-AzResource](./New-AzResource.md) + +[New-AzResourceGroup](./New-AzResourceGroup.md) + +[New-AzResourceGroupDeployment](./New-AzResourceGroupDeployment.md) + +[Remove-AzResourceGroupDeployment](./Remove-AzResourceGroupDeployment.md) + +[Test-AzResourceGroupDeployment](./Test-AzResourceGroupDeployment.md) + + diff --git a/azps-10.1.0/Az.Resources/Stop-AzRoleAssignmentScheduleRequest.md b/azps-10.1.0/Az.Resources/Stop-AzRoleAssignmentScheduleRequest.md new file mode 100644 index 0000000000..69c34deecf --- /dev/null +++ b/azps-10.1.0/Az.Resources/Stop-AzRoleAssignmentScheduleRequest.md @@ -0,0 +1,185 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/stop-azroleassignmentschedulerequest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Stop-AzRoleAssignmentScheduleRequest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Stop-AzRoleAssignmentScheduleRequest.md +--- + +# Stop-AzRoleAssignmentScheduleRequest + +## SYNOPSIS +Cancels a pending role assignment schedule request. + +## SYNTAX + +### Cancel (Default) +``` +Stop-AzRoleAssignmentScheduleRequest -Name <String> -Scope <String> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CancelViaIdentity +``` +Stop-AzRoleAssignmentScheduleRequest -InputObject <IAuthorizationIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Cancels a pending role assignment schedule request. + +## EXAMPLES + +### Example 1: Cancel a pending role assignment schedule request +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +$name = "47f8978c-5d8d-4fbf-b4b6-2f43eeb43ec6" +Stop-AzRoleAssignmentScheduleRequest -Scope $scope -Name $name +``` + +You can use this operation to cancel a `roleAssignmentScheduleRequest` which has not been provisioned yet. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: CancelViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the role assignment request to cancel. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: RoleAssignmentScheduleRequestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role assignment request to cancel. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Stop-AzRoleEligibilityScheduleRequest.md b/azps-10.1.0/Az.Resources/Stop-AzRoleEligibilityScheduleRequest.md new file mode 100644 index 0000000000..cb651913f9 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Stop-AzRoleEligibilityScheduleRequest.md @@ -0,0 +1,185 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/stop-azroleeligibilityschedulerequest +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Stop-AzRoleEligibilityScheduleRequest.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Stop-AzRoleEligibilityScheduleRequest.md +--- + +# Stop-AzRoleEligibilityScheduleRequest + +## SYNOPSIS +Cancels a pending role eligibility schedule request. + +## SYNTAX + +### Cancel (Default) +``` +Stop-AzRoleEligibilityScheduleRequest -Name <String> -Scope <String> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CancelViaIdentity +``` +Stop-AzRoleEligibilityScheduleRequest -InputObject <IAuthorizationIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Cancels a pending role eligibility schedule request. + +## EXAMPLES + +### Example 1: Cancel a pending role eligibility schedule request +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +$name = "47f8978c-5d8d-4fbf-b4b6-2f43eeb43ec6" +Stop-AzRoleEligibilityScheduleRequest -Scope $scope -Name $name +``` + +You can use this operation to cancel a `roleEligibilityScheduleRequest` which has not been provisioned yet. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: CancelViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the role eligibility request to cancel. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: RoleEligibilityScheduleRequestName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role eligibility request to cancel. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Stop-AzTenantDeployment.md b/azps-10.1.0/Az.Resources/Stop-AzTenantDeployment.md new file mode 100644 index 0000000000..d3c076a292 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Stop-AzTenantDeployment.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/stop-aztenantdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Stop-AzTenantDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Stop-AzTenantDeployment.md +--- + +# Stop-AzTenantDeployment + +## SYNOPSIS +Cancel a running deployment at tenant scope + +## SYNTAX + +### StopByDeploymentName (Default) +``` +Stop-AzTenantDeployment [-Name] <String> [-PassThru] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByDeploymentId +``` +Stop-AzTenantDeployment -Id <String> [-PassThru] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### StopByInputObject +``` +Stop-AzTenantDeployment -InputObject <PSDeployment> [-PassThru] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzTenantDeployment** cmdlet cancels a deployment that has started but not completed at the current tenant scope. +To stop a deployment, the deployment must have an incomplete provisioning state, such as Provisioning, and not a completed state, such as Provisioned or Failed. + +To create a deployment at tenant scope, use the New-AzTenantDeployment cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzTenantDeployment -Name "deployment01" +``` + +This command cancels a running deployment "deployment01" at the current tenant scope. + +### Example 2 +```powershell +Get-AzTenantDeployment -Name "deployment01" | Stop-AzTenantDeployment +``` + +This command gets the deployment "deployment01" at the current tenant scope and cancels it. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The fully qualified resource Id of the deployment. +example: /providers/Microsoft.Resources/deployments/{deploymentName} + +```yaml +Type: System.String +Parameter Sets: StopByDeploymentId +Aliases: DeploymentId, ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The deployment object. + +```yaml +Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment +Parameter Sets: StopByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the deployment. + +```yaml +Type: System.String +Parameter Sets: StopByDeploymentName +Aliases: DeploymentName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Test-AzDeployment.md b/azps-10.1.0/Az.Resources/Test-AzDeployment.md new file mode 100644 index 0000000000..29f3fe0138 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Test-AzDeployment.md @@ -0,0 +1,369 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/test-azdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Test-AzDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Test-AzDeployment.md +--- + +# Test-AzDeployment + +## SYNOPSIS +Validates a deployment. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterObject +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterObject <Hashtable> -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterObject +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterObject <Hashtable> -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterObject +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterObject <Hashtable> -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterObject <Hashtable> -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterFile +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateParameterFile <String> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterFile +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateParameterFile <String> + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterFile +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateParameterFile <String> + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParams +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateParameterFile <String> + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterUri +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateParameterUri <String> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterUri +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateParameterUri <String> + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterUri +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateParameterUri <String> + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsUri +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateParameterUri <String> + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateObjectWithNoParameters +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceId +``` +Test-AzDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzDeployment** cmdlet determines whether a deployment template and its parameter values are valid. + +## EXAMPLES + +### Example 1: Test deployment with a custom template and parameter file +```powershell +Test-AzDeployment -Location "West US" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json" +``` + +This command tests a deployment at the current subscription scope using the given template file and parameters file. + +### Example 2: Test deployment with a custom template object and parameter file +```powershell +$TemplateFileText = [System.IO.File]::ReadAllText("D:\Azure\Templates\EngineeringSite.json") +$TemplateObject = ConvertFrom-Json $TemplateFileText -AsHashtable +Test-AzDeployment -Location "West US" -TemplateObject $TemplateObject -TemplateParameterFile "D:\Azure\Templates\EngSiteParams.json" +``` + +This command tests a deployment at the current subscription scope using the an in-memory hashtable created from the given template file and a parameter file. + +### Example 3 + +Validates a deployment. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Test-AzDeployment -Location 'West US' -SkipTemplateParameterPrompt -TemplateFile 'D:\Azure\Templates\EngineeringSite.json' -TemplateParameterFile 'D:\Azure\Templates\EngSiteParams.json' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location to store deployment data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deployment it's going to test. If not specified, defaults to the template file name when a template file is provided + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +Local path to the template file. Supported template file type: json and bicep. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateObject +A hash table which represents the template. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateObjectAndParameterFile, ByTemplateObjectAndParameterUri, ByTemplateObjectWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +A file that has the template parameters. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterFile, ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile, ByTemplateSpecResourceIdAndParams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Uri to the template parameter file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterUri, ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri, ByTemplateSpecResourceIdAndParamsUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +Resource ID of the templateSpec to be deployed. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Uri to the template file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Hashtable + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceManagerError + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Test-AzManagementGroupDeployment.md b/azps-10.1.0/Az.Resources/Test-AzManagementGroupDeployment.md new file mode 100644 index 0000000000..e1849bc4b9 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Test-AzManagementGroupDeployment.md @@ -0,0 +1,379 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/test-azmanagementgroupdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Test-AzManagementGroupDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Test-AzManagementGroupDeployment.md +--- + +# Test-AzManagementGroupDeployment + +## SYNOPSIS +Validates a deployment at a management group. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterObject +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateParameterObject <Hashtable> -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterObject +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateParameterObject <Hashtable> -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterObject +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateParameterObject <Hashtable> -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateParameterObject <Hashtable> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterFile +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateParameterFile <String> -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterFile +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateParameterFile <String> -TemplateFile <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterFile +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateParameterFile <String> -TemplateUri <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParams +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateParameterFile <String> -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterUri +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateParameterUri <String> -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterUri +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateParameterUri <String> -TemplateFile <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterUri +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateParameterUri <String> -TemplateUri <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsUri +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateParameterUri <String> -TemplateSpecId <String> [-SkipTemplateParameterPrompt] + [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectWithNoParameters +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceId +``` +Test-AzManagementGroupDeployment [-Name <String>] -ManagementGroupId <String> -Location <String> + [-QueryString <String>] -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzManagementGroupDeployment** cmdlet determines whether a deployment template and its parameter values are valid at a management group. + +## EXAMPLES + +### Example 1: Test deployment with a custom template and parameter file +```powershell +Test-AzManagementGroupDeployment -ManagementGroupId "myMG" -Location "West US" -TemplateFile "D:\Azure\Templates\OrgSetup.json" -TemplateParameterFile "D:\Azure\Templates\OrgParms.json" +``` + +This command tests a deployment at the management group "myMG" using the given template file and parameters file. + +### Example 2: Test deployment with a custom template object and parameter file +```powershell +$TemplateFileText = [System.IO.File]::ReadAllText("D:\Azure\Templates\OrgSetup.json") +$TemplateObject = ConvertFrom-Json $TemplateFileText -AsHashtable +Test-AzManagementGroupDeployment -ManagementGroupId "myMG" -Location "West US" -TemplateObject $TemplateObject -TemplateParameterFile "D:\Azure\Templates\EngSiteParams.json" +``` + +This command tests a deployment at the management group "myMG" using the an in-memory hashtable created from the given template file and a parameter file. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location to store deployment data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementGroupId +The management group id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deployment it's going to test. If not specified, defaults to the template file name when a template file is provided + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. +This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. +For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +Local path to the template file. Supported template file type: json and bicep. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateObject +A hash table which represents the template. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateObjectAndParameterFile, ByTemplateObjectAndParameterUri, ByTemplateObjectWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +A file that has the template parameters. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterFile, ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile, ByTemplateSpecResourceIdAndParams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Uri to the template parameter file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterUri, ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri, ByTemplateSpecResourceIdAndParamsUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +Resource ID of the templateSpec to be deployed. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Uri to the template file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Hashtable + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceManagerError + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Test-AzResourceGroupDeployment.md b/azps-10.1.0/Az.Resources/Test-AzResourceGroupDeployment.md new file mode 100644 index 0000000000..726d351572 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Test-AzResourceGroupDeployment.md @@ -0,0 +1,423 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 0143CE35-3B1D-4829-B880-A5CA25B83883 +online version: https://learn.microsoft.com/powershell/module/az.resources/test-azresourcegroupdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Test-AzResourceGroupDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Test-AzResourceGroupDeployment.md +--- + +# Test-AzResourceGroupDeployment + +## SYNOPSIS +Validates a resource group deployment. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterObject +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateParameterObject <Hashtable> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterObject +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateParameterObject <Hashtable> + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterObject +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateParameterObject <Hashtable> + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateParameterObject <Hashtable> + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterFile +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateParameterFile <String> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterFile +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateParameterFile <String> + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterFile +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateParameterFile <String> + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParams +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateParameterFile <String> + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterUri +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateParameterUri <String> + -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateFileAndParameterUri +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateParameterUri <String> + -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateUriAndParameterUri +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateParameterUri <String> + -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsUri +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateParameterUri <String> + -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByTemplateObjectWithNoParameters +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceId +``` +Test-AzResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] [-RollbackToLastDeployment] + [-RollBackDeploymentName <String>] [-QueryString <String>] -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzResourceGroupDeployment** cmdlet determines whether an Azure resource group deployment template and its parameter values are valid. + +## EXAMPLES + +### Example 1: Test deployment with a custom template object and parameter file + +```powershell +$TemplateFileText = [System.IO.File]::ReadAllText("D:\Azure\Templates\EngineeringSite.json") +$TemplateObject = ConvertFrom-Json $TemplateFileText -AsHashtable +Test-AzResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateObject $TemplateObject -TemplateParameterFile "D:\Azure\Templates\EngSiteParams.json" +``` + +This command tests a deployment in the given resource group using the an in-memory hashtable created from the given template file and a parameter file. + +### Example 2: Test deployment via template file and parameter file + +```powershell +Test-AzResourceGroupDeployment -ResourceGroupName testRG01 -TemplateFile "D:\Azure\Templates\sampleDeploymentTemplate.json" -TemplateParameterFile "D:\Azure\Templates\sampleDeploymentTemplateParams.json" +``` + +This command tests a deployment in the given resource group and resource using the provided template file and a parameter file. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +Specifies the deployment mode. +The acceptable values for this parameter are: +- Incremental +- Complete + +```yaml +Type: Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode +Parameter Sets: (All) +Aliases: +Accepted values: Incremental, Complete + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to test. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RollBackDeploymentName +Rollback to the successful deployment with the given name in the resource group, should not be used if -RollbackToLastDeployment is used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RollbackToLastDeployment +Rollback to the last successful deployment in the resource group, should not be present if -RollBackDeploymentName is used. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +Specifies the full path of a template file. Supported template file type: json and bicep. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateObject +A hash table which represents the template. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateObjectAndParameterFile, ByTemplateObjectAndParameterUri, ByTemplateObjectWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +Specifies the full path of a JSON file that contains the names and values of the template parameters. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterFile, ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile, ByTemplateSpecResourceIdAndParams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +Specifies a hash table of template parameter names and values. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Specifies the URI of a template parameters file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterUri, ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri, ByTemplateSpecResourceIdAndParamsUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +Resource ID of the templateSpec to be deployed. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Specifies the URI of a template file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceManagerError + +## NOTES + +## RELATED LINKS + +[Get-AzResourceGroupDeployment](./Get-AzResourceGroupDeployment.md) + +[New-AzResourceGroupDeployment](./New-AzResourceGroupDeployment.md) + +[Remove-AzResourceGroupDeployment](./Remove-AzResourceGroupDeployment.md) + +[Stop-AzResourceGroupDeployment](./Stop-AzResourceGroupDeployment.md) + + diff --git a/azps-10.1.0/Az.Resources/Test-AzTenantDeployment.md b/azps-10.1.0/Az.Resources/Test-AzTenantDeployment.md new file mode 100644 index 0000000000..434984cc5e --- /dev/null +++ b/azps-10.1.0/Az.Resources/Test-AzTenantDeployment.md @@ -0,0 +1,360 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/test-aztenantdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Test-AzTenantDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Test-AzTenantDeployment.md +--- + +# Test-AzTenantDeployment + +## SYNOPSIS +Validates a deployment at tenant scope. + +## SYNTAX + +### ByTemplateFileWithNoParameters (Default) +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateFile <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterObject +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterObject <Hashtable> -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterObject +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterObject <Hashtable> -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterObject +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterObject <Hashtable> -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsObject +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterObject <Hashtable> -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterFile +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterFile <String> -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterFile +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterFile <String> -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterFile +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterFile <String> -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParams +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterFile <String> -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectAndParameterUri +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterUri <String> -TemplateObject <Hashtable> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateFileAndParameterUri +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterUri <String> -TemplateFile <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriAndParameterUri +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterUri <String> -TemplateUri <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceIdAndParamsUri +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] + -TemplateParameterUri <String> -TemplateSpecId <String> [-SkipTemplateParameterPrompt] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateObjectWithNoParameters +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateObject <Hashtable> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateUriWithNoParameters +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateUri <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByTemplateSpecResourceId +``` +Test-AzTenantDeployment [-Name <String>] -Location <String> [-QueryString <String>] -TemplateSpecId <String> + [-SkipTemplateParameterPrompt] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzTenantDeployment** cmdlet determines whether a deployment template and its parameter values are valid at the current tenant scope. + +## EXAMPLES + +### Example 1: Test deployment with a custom template and parameter file +```powershell +Test-AzTenantDeployment -Location "West US" -TemplateFile "D:\Azure\Templates\OrgSetup.json" -TemplateParameterFile "D:\Azure\Templates\OrgParms.json" +``` + +This command tests a deployment at the current tenant scope using the given template file and parameters file. + +### Example 2: Test deployment with a custom template object and parameter file +```powershell +$TemplateFileText = [System.IO.File]::ReadAllText("D:\Azure\Templates\OrgSetup.json") +$TemplateObject = ConvertFrom-Json $TemplateFileText -AsHashtable +Test-AzTenantDeployment -Location "West US" -TemplateObject $TemplateObject -TemplateParameterFile "D:\Azure\Templates\EngSiteParams.json" +``` + +This command tests a deployment at the current tenant scope using the an in-memory hashtable created from the given template file and a parameter file. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location to store deployment data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deployment it's going to test. If not specified, defaults to the template file name when a template file is provided + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +The query string (for example, a SAS token) to be used with the TemplateUri parameter. Would be used in case of linked templates + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipTemplateParameterPrompt +Skips the PowerShell dynamic parameter processing that checks if the provided template parameter contains all necessary parameters used by the template. +This check would prompt the user to provide a value for the missing parameters, but providing the -SkipTemplateParameterPrompt will ignore this prompt and error out immediately if a parameter was found not to be bound in the template. +For non-interactive scripts, -SkipTemplateParameterPrompt can be provided to provide a better error message in the case where not all required parameters are satisfied. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateFile +Local path to the template file. Supported template file type: json and bicep. + +```yaml +Type: System.String +Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateObject +A hash table which represents the template. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateObjectAndParameterFile, ByTemplateObjectAndParameterUri, ByTemplateObjectWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterFile +A file that has the template parameters. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterFile, ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile, ByTemplateSpecResourceIdAndParams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterObject +A hash table which represents the parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByTemplateObjectAndParameterObject, ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject, ByTemplateSpecResourceIdAndParamsObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateParameterUri +Uri to the template parameter file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateObjectAndParameterUri, ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri, ByTemplateSpecResourceIdAndParamsUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateSpecId +Resource ID of the templateSpec to be deployed. + +```yaml +Type: System.String +Parameter Sets: ByTemplateSpecResourceIdAndParamsObject, ByTemplateSpecResourceIdAndParams, ByTemplateSpecResourceIdAndParamsUri, ByTemplateSpecResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TemplateUri +Uri to the template file. + +```yaml +Type: System.String +Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Collections.Hashtable + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceManagerError + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Unregister-AzProviderFeature.md b/azps-10.1.0/Az.Resources/Unregister-AzProviderFeature.md new file mode 100644 index 0000000000..de00482218 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Unregister-AzProviderFeature.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/unregister-azproviderfeature +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Unregister-AzProviderFeature.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Unregister-AzProviderFeature.md +--- + +# Unregister-AzProviderFeature + +## SYNOPSIS +Unregisters an Azure provider feature in your account. + +## SYNTAX + +``` +Unregister-AzProviderFeature -FeatureName <String> -ProviderNamespace <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Unregister-AzProviderFeature** cmdlet unregisters an Azure provider feature in your account. + +## EXAMPLES + +### Example 1: Unregister a feature +```powershell +Unregister-AzProviderFeature -FeatureName AllowApplicationSecurityGroups -ProviderNamespace Microsoft.Network +``` + +This unregisters the AllowApplicationSecurityGroups feature for Microsoft.Network from your account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureName +The feature name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProviderNamespace +The resource provider namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSProviderFeature + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Unregister-AzProviderPreviewFeature.md b/azps-10.1.0/Az.Resources/Unregister-AzProviderPreviewFeature.md new file mode 100644 index 0000000000..18c899f74b --- /dev/null +++ b/azps-10.1.0/Az.Resources/Unregister-AzProviderPreviewFeature.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/unregister-azproviderpreviewfeature +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Unregister-AzProviderPreviewFeature.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Unregister-AzProviderPreviewFeature.md +--- + +# Unregister-AzProviderPreviewFeature + +## SYNOPSIS +Removes a feature registration from your account. + +## SYNTAX + +``` +Unregister-AzProviderPreviewFeature -Name <String> -ProviderNamespace <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Unregister-AzProviderPreviewFeature** cmdlet removes a feature registration from your account. + +## EXAMPLES + +### Example 1: Removes a feature registration +```powershell +Unregister-AzProviderPreviewFeature -FeatureName AllowApplicationSecurityGroups -ProviderNamespace Microsoft.Network +``` + +This removes the AllowApplicationSecurityGroups feature for Microsoft.Network from your account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The feature name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FeatureName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +If specified, cmdlet will return true when the feature registration is deleted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +The resource provider namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +## RELATED LINKS + +[Get-AzProviderPreviewFeature](./Get-AzProviderPreviewFeature.md) + +[Register-AzProviderPreviewFeature](./Register-AzProviderPreviewFeature.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Resources/Unregister-AzResourceProvider.md b/azps-10.1.0/Az.Resources/Unregister-AzResourceProvider.md new file mode 100644 index 0000000000..166e9b33e2 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Unregister-AzResourceProvider.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml +Module Name: Az.Resources +ms.assetid: D5126B7B-7FBB-4C72-B77E-13ADE2BE9B1B +online version: https://learn.microsoft.com/powershell/module/az.resources/unregister-azresourceprovider +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Unregister-AzResourceProvider.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Unregister-AzResourceProvider.md +--- + +# Unregister-AzResourceProvider + +## SYNOPSIS +Unregisters a resource provider. + +## SYNTAX + +``` +Unregister-AzResourceProvider -ProviderNamespace <String> [-ApiVersion <String>] [-Pre] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Unregister-AzResourceProvider** cmdlet unregisters an Azure resource provider. + +## EXAMPLES + +### Example 1: Unregister resource provider with ProviderNamespace + +```powershell +Unregister-AzResourceProvider -ProviderNamespace "Microsoft.support" +``` + +This command unregisters the resource provider "Microsoft.support". + +## PARAMETERS + +### -ApiVersion +Specifies the API version that is supported by the resource Provider. +You can specify a different version than the default version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pre +Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderNamespace +Specifies the namespace of the resource provider. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceProvider + +## NOTES + +## RELATED LINKS + +[Get-AzResourceProvider](./Get-AzResourceProvider.md) + +[Register-AzResourceProvider](./Register-AzResourceProvider.md) + + diff --git a/azps-10.1.0/Az.Resources/Update-AzADAppFederatedCredential.md b/azps-10.1.0/Az.Resources/Update-AzADAppFederatedCredential.md new file mode 100644 index 0000000000..6960677f58 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Update-AzADAppFederatedCredential.md @@ -0,0 +1,228 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/update-azadappfederatedcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzADAppFederatedCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzADAppFederatedCredential.md +--- + +# Update-AzADAppFederatedCredential + +## SYNOPSIS +Update the navigation property federatedIdentityCredentials in applications + +## SYNTAX + +``` +Update-AzADAppFederatedCredential -ApplicationObjectId <String> -FederatedCredentialId <String> + [-AdditionalProperties <Hashtable>] [-Audience <String[]>] [-Description <String>] [-Issuer <String>] + [-Subject <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update the navigation property federatedIdentityCredentials in applications + +## EXAMPLES + +### Example 1: Update subject for federated identity credential +```powershell +Update-AzADAppFederatedCredential -ApplicationObjectId $appObjectId -FederatedCredentialId $credentialId -Subject 'subject' +``` + +Update subject for federated identity credential + +## PARAMETERS + +### -AdditionalProperties +Additional Parameters + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationObjectId +key: id of application + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Audience +Lists the audiences that can appear in the external token. +This field is mandatory, and defaults to 'api://AzureADTokenExchange'. +It says what Microsoft identity platform should accept in the aud claim in the incoming token. +This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. +Required. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The un-validated, user-provided description of the federated identity credential. +Optional. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedCredentialId +key: id of federatedIdentityCredential + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Issuer +The URL of the external identity provider and must match the issuer claim of the external token being exchanged. +The combination of the values of issuer and subject must be unique on the app. +Required. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subject +Required. +The identifier of the external software workload within the external identity provider. +Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. +The value here must match the sub claim within the token presented to Azure AD. +The combination of issuer and subject must be unique on the app. +Supports $filter (eq). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Update-AzADApplication.md b/azps-10.1.0/Az.Resources/Update-AzADApplication.md new file mode 100644 index 0000000000..12af74011a --- /dev/null +++ b/azps-10.1.0/Az.Resources/Update-AzADApplication.md @@ -0,0 +1,1693 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/update-azadapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzADApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzADApplication.md +--- + +# Update-AzADApplication + +## SYNOPSIS +Updates entity in applications + +## SYNTAX + +### ApplicationObjectIdWithUpdateParamsParameterSet (Default) +``` +Update-AzADApplication -ObjectId <String> [-HomePage <String>] [-ReplyUrl <String[]>] + [-AvailableToOtherTenants <Boolean>] [-AddIn <IMicrosoftGraphAddIn[]>] [-Api <IMicrosoftGraphApiApplication>] + [-AppRole <IMicrosoftGraphAppRole[]>] [-ApplicationTemplateId <String>] + [-CreatedOnBehalfOfDeletedDateTime <DateTime>] [-DeletedDateTime <DateTime>] [-Description <String>] + [-DisabledByMicrosoftStatus <String>] [-DisplayName <String>] [-GroupMembershipClaim <String>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] [-IdentifierUri <String[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-IsDeviceOnlyAuthSupported] [-IsFallbackPublicClient] + [-LogoInputFile <String>] [-Note <String>] [-Oauth2RequirePostResponse] + [-OptionalClaim <IMicrosoftGraphOptionalClaims>] + [-ParentalControlSetting <IMicrosoftGraphParentalControlSettings>] [-PublicClientRedirectUri <String[]>] + [-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>] [-SignInAudience <String>] + [-SPARedirectUri <String[]>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] [-Web <IMicrosoftGraphWebApplication>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ApplicationIdWithUpdateParamsParameterSet +``` +Update-AzADApplication -ApplicationId <Guid> [-HomePage <String>] [-ReplyUrl <String[]>] + [-AvailableToOtherTenants <Boolean>] [-AddIn <IMicrosoftGraphAddIn[]>] [-Api <IMicrosoftGraphApiApplication>] + [-AppRole <IMicrosoftGraphAppRole[]>] [-ApplicationTemplateId <String>] + [-CreatedOnBehalfOfDeletedDateTime <DateTime>] [-DeletedDateTime <DateTime>] [-Description <String>] + [-DisabledByMicrosoftStatus <String>] [-DisplayName <String>] [-GroupMembershipClaim <String>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] [-IdentifierUri <String[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-IsDeviceOnlyAuthSupported] [-IsFallbackPublicClient] + [-LogoInputFile <String>] [-Note <String>] [-Oauth2RequirePostResponse] + [-OptionalClaim <IMicrosoftGraphOptionalClaims>] + [-ParentalControlSetting <IMicrosoftGraphParentalControlSettings>] [-PublicClientRedirectUri <String[]>] + [-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>] [-SignInAudience <String>] + [-SPARedirectUri <String[]>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] [-Web <IMicrosoftGraphWebApplication>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectWithUpdateParamsParameterSet +``` +Update-AzADApplication -InputObject <IMicrosoftGraphApplication> [-HomePage <String>] [-ReplyUrl <String[]>] + [-AvailableToOtherTenants <Boolean>] [-AddIn <IMicrosoftGraphAddIn[]>] [-Api <IMicrosoftGraphApiApplication>] + [-AppRole <IMicrosoftGraphAppRole[]>] [-ApplicationTemplateId <String>] + [-CreatedOnBehalfOfDeletedDateTime <DateTime>] [-DeletedDateTime <DateTime>] [-Description <String>] + [-DisabledByMicrosoftStatus <String>] [-DisplayName <String>] [-GroupMembershipClaim <String>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] [-IdentifierUri <String[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-IsDeviceOnlyAuthSupported] [-IsFallbackPublicClient] + [-LogoInputFile <String>] [-Note <String>] [-Oauth2RequirePostResponse] + [-OptionalClaim <IMicrosoftGraphOptionalClaims>] + [-ParentalControlSetting <IMicrosoftGraphParentalControlSettings>] [-PublicClientRedirectUri <String[]>] + [-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>] [-SignInAudience <String>] + [-SPARedirectUri <String[]>] [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] [-Web <IMicrosoftGraphWebApplication>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates entity in applications + +## EXAMPLES + +### Example 1: Update application by display name +```powershell +Update-AzADApplication -DisplayName $name -HomePage $homepage +``` + +Update application by display name + +### Example 2: Update application by pipeline input +```powershell +Get-AzADApplication -ObjectId $id | Update-AzADApplication -ReplyUrl $replyurl +``` + +Update application by pipeline input + +## PARAMETERS + +### -AddIn +Defines custom behavior that a consuming service can use to call an app in specific contexts. +For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. +This will let services like Office 365 call the application in the context of a document the user is working on. +To construct, see NOTES section for ADDIN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAddIn[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Api +apiApplication +To construct, see NOTES section for API properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApiApplication +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +key: application id + +```yaml +Type: System.Guid +Parameter Sets: ApplicationIdWithUpdateParamsParameterSet +Aliases: AppId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationTemplateId +Unique identifier of the applicationTemplate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppRole +The collection of roles assigned to the application. +With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. +Not nullable. +To construct, see NOTES section for APPROLE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAppRole[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailableToOtherTenants +The value specifying whether the application is a single tenant or a multi-tenant. +Is equivalent to '-SignInAudience AzureADMultipleOrgs' when switch is on + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreatedOnBehalfOfDeletedDateTime +. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedDateTime +. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +An optional description of the application. +Returned by default. +Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledByMicrosoftStatus +Specifies whether Microsoft has disabled the registered application. +Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). +Supports $filter (eq, ne, NOT). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name for the application. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and $orderBy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMembershipClaim +Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. +To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HomePage +home page url for web + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WebHomePageUrl + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HomeRealmDiscoveryPolicy +. +To construct, see NOTES section for HOMEREALMDISCOVERYPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphHomeRealmDiscoveryPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentifierUri +The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. +For more information, see Application Objects and Service Principal Objects. +The any operator is required for filter expressions on multi-valued properties. +Not nullable. +Supports $filter (eq, ne, ge, le, startsWith). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: IdentifierUris + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Info +informationalUrl +To construct, see NOTES section for INFO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphInformationalUrl +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +key: application object +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication +Parameter Sets: InputObjectWithUpdateParamsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsDeviceOnlyAuthSupported +Specifies whether this application supports device authentication without a user. +The default is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFallbackPublicClient +Specifies the fallback application type as public client, such as an installed application running on a mobile device. +The default value is false which means the fallback application type is confidential client such as a web app. +There are certain scenarios where Azure AD cannot determine the client application type. +For example, the ROPC flow where the application is configured without specifying a redirect URI. +In those cases Azure AD interprets the application type based on the value of this property. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogoInputFile +Input File for Logo (The main logo for the application. +Not nullable.) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +Notes relevant for the management of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Oauth2RequirePostResponse +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +key: id of application + +```yaml +Type: System.String +Parameter Sets: ApplicationObjectIdWithUpdateParamsParameterSet +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptionalClaim +optionalClaims +To construct, see NOTES section for OPTIONALCLAIM properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphOptionalClaims +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentalControlSetting +parentalControlSettings +To construct, see NOTES section for PARENTALCONTROLSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphParentalControlSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicClientRedirectUri + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyUrl +The application reply Urls. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: ReplyUrls, WebRedirectUri + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredResourceAccess +Specifies the resources that the application needs to access. +This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. +This configuration of access to the required resources drives the consent experience. +Not nullable. +Supports $filter (eq, NOT, ge, le). +To construct, see NOTES section for REQUIREDRESOURCEACCESS properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphRequiredResourceAccess[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignInAudience +Specifies the Microsoft accounts that are supported for the current application. +Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. +See more in the table below. +Supports $filter (eq, ne, NOT). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SPARedirectUri + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Custom strings that can be used to categorize and identify the application. +Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenEncryptionKeyId +Specifies the keyId of a public key from the keyCredentials collection. +When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. +The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenIssuancePolicy +. +To construct, see NOTES section for TOKENISSUANCEPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphTokenIssuancePolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenLifetimePolicy +The tokenLifetimePolicies assigned to this application. +Supports $expand. +To construct, see NOTES section for TOKENLIFETIMEPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphTokenLifetimePolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Web +webApplication +To construct, see NOTES section for WEB properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphWebApplication +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +Set-AzADApplication + +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. + + +ADDIN <IMicrosoftGraphAddIn[]>: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + +API <IMicrosoftGraphApiApplication>: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + +APPROLE <IMicrosoftGraphAppRole[]>: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + +HOMEREALMDISCOVERYPOLICY <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>: . + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +INFO <IMicrosoftGraphInformationalUrl>: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + +INPUTOBJECT <IMicrosoftGraphApplication>: key: application object + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + +OPTIONALCLAIM <IMicrosoftGraphOptionalClaims>: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + +PARENTALCONTROLSETTING <IMicrosoftGraphParentalControlSettings>: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + +REQUIREDRESOURCEACCESS <IMicrosoftGraphRequiredResourceAccess[]>: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + +TOKENISSUANCEPOLICY <IMicrosoftGraphTokenIssuancePolicy[]>: . + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +TOKENLIFETIMEPOLICY <IMicrosoftGraphTokenLifetimePolicy[]>: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +WEB <IMicrosoftGraphWebApplication>: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Update-AzADGroup.md b/azps-10.1.0/Az.Resources/Update-AzADGroup.md new file mode 100644 index 0000000000..054fd1ee10 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Update-AzADGroup.md @@ -0,0 +1,542 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/update-azadgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzADGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzADGroup.md +--- + +# Update-AzADGroup + +## SYNOPSIS +Update entity in groups + +## SYNTAX + +``` +Update-AzADGroup -ObjectId <String> [-AdditionalProperties <Hashtable>] + [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>] [-Classification <String>] + [-CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>] [-DeletedDateTime <DateTime>] [-Description <String>] + [-DisplayName <String>] [-GroupType <String[]>] [-HasMembersWithLicenseError] [-IsArchived] + [-IsAssignableToRole] [-MailEnabled] [-MailNickname <String>] [-MembershipRule <String>] + [-MembershipRuleProcessingState <String>] + [-PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>] [-PreferredDataLocation <String>] + [-PreferredLanguage <String>] [-SecurityEnabled] [-SecurityIdentifier <String>] [-Theme <String>] + [-Visibility <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update entity in groups + +## EXAMPLES + +### Example 1: Update description for group +```powershell +Update-AzADGroup -ObjectId $objectid -Description $description +``` + +Update description for group. + +## PARAMETERS + +### -AdditionalProperties +Additional Parameters + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppRoleAssignment +Represents the app roles a group has been granted for an application. +Supports $expand. +To construct, see NOTES section for APPROLEASSIGNMENT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAppRoleAssignmentAutoGenerated[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Classification +Describes a classification for the group (such as low, medium or high business impact). +Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. +Supports $filter (eq, ne, NOT, ge, le, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreatedOnBehalfOf +Represents an Azure Active Directory object. +The directoryObject type is the base type for many other directory entity types. +To construct, see NOTES section for CREATEDONBEHALFOF properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphDirectoryObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedDateTime +. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +An optional description for the group. +Returned by default. +Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The name displayed in directory + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupType +Specifies the group type and its membership. +If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. +For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. +Returned by default. +Supports $filter (eq, NOT). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasMembersWithLicenseError +Indicates whether there are members in this group that have license errors from its group-based license assignment. +This property is never returned on a GET operation. +You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). +Supports $filter (eq). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsArchived +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAssignableToRole +Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable. +If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). +Only callers in Global administrator and Privileged role administrator roles can set this property. +The caller must also be assigned the Directory.AccessAsUser.All permission to set this property. +For more, see Using a group to manage Azure AD role assignmentsReturned by default. +Supports $filter (eq, ne, NOT). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailEnabled +Specifies whether the group is mail-enabled. +Returned by default. +Supports $filter (eq, ne, NOT). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailNickname +The mail alias for the group, unique in the organization. +This property must be specified when a group is created. +These characters cannot be used in the mailNickName: @()/[]';:.\<\>,SPACE. +Returned by default. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MembershipRule +The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). +For more information about the syntax of the membership rule, see Membership Rules syntax. +Returned by default. +Supports $filter (eq, ne, NOT, ge, le, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MembershipRuleProcessingState +Indicates whether the dynamic membership processing is on or paused. +Possible values are On or Paused. +Returned by default. +Supports $filter (eq, ne, NOT, in). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +key: id of group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GroupId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionGrant +The permissions that have been granted for a group to a specific application. +Supports $expand. +To construct, see NOTES section for PERMISSIONGRANT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphResourceSpecificPermissionGrant[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredDataLocation +The preferred data location for the group. +For more information, see OneDrive Online Multi-Geo. +Returned by default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredLanguage +The preferred language for a Microsoft 365 group. +Should follow ISO 639-1 Code; for example 'en-US'. +Returned by default. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityEnabled +Specifies whether the group is a security group. +Returned by default. +Supports $filter (eq, ne, NOT, in). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityIdentifier +Security identifier of the group, used in Windows scenarios. +Returned by default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Theme +Specifies a Microsoft 365 group's color theme. +Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. +Returned by default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Visibility +Specifies the group join policy and group content visibility for groups. +Possible values are: Private, Public, or Hiddenmembership. +Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. +It can't be updated later. +Other values of visibility can be updated after group creation. +If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. +See group visibility options to learn more. +Returned by default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +APPROLEASSIGNMENT <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>: Represents the app roles a group has been granted for an application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[CreatedDateTime <DateTime?>]`: The time when the app role assignment was created.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[PrincipalDisplayName <String>]`: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith). + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[PrincipalType <String>]`: The type of the assigned principal. This can either be User, Group or ServicePrincipal. Read-only. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + +CREATEDONBEHALFOF <IMicrosoftGraphDirectoryObject>: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +PERMISSIONGRANT <IMicrosoftGraphResourceSpecificPermissionGrant[]>: The permissions that have been granted for a group to a specific application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[ClientAppId <String>]`: ID of the service principal of the Azure AD app that has been granted access. Read-only. + - `[ClientId <String>]`: ID of the Azure AD app that has been granted access. Read-only. + - `[Permission <String>]`: The name of the resource-specific permission. Read-only. + - `[PermissionType <String>]`: The type of permission. Possible values are: Application, Delegated. Read-only. + - `[ResourceAppId <String>]`: ID of the Azure AD app that is hosting the resource. Read-only. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Update-AzADServicePrincipal.md b/azps-10.1.0/Az.Resources/Update-AzADServicePrincipal.md new file mode 100644 index 0000000000..6ed334e64b --- /dev/null +++ b/azps-10.1.0/Az.Resources/Update-AzADServicePrincipal.md @@ -0,0 +1,2106 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/update-azadserviceprincipal +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzADServicePrincipal.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzADServicePrincipal.md +--- + +# Update-AzADServicePrincipal + +## SYNOPSIS +Updates entity in service principal + +## SYNTAX + +### SpObjectIdWithDisplayNameParameterSet (Default) +``` +Update-AzADServicePrincipal -ObjectId <String> [-KeyCredential <IMicrosoftGraphKeyCredential[]>] + [-PasswordCredential <IMicrosoftGraphPasswordCredential[]>] [-IdentifierUri <String[]>] [-Homepage <String>] + [-AccountEnabled] [-AddIn <IMicrosoftGraphAddIn[]>] [-AlternativeName <String[]>] [-AppDescription <String>] + [-AppOwnerOrganizationId <String>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>] + [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>] [-AppRoleAssignmentRequired] + [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>] + [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>] + [-DeletedDateTime <DateTime>] [-Description <String>] [-DisabledByMicrosoftStatus <String>] + [-DisplayName <String>] [-Endpoint <IMicrosoftGraphEndpoint[]>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-LoginUrl <String>] [-LogoutUrl <String>] [-Note <String>] + [-NotificationEmailAddress <String[]>] [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>] + [-PreferredSingleSignOnMode <String>] [-PreferredTokenSigningKeyThumbprint <String>] [-ReplyUrl <String[]>] + [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>] [-ServicePrincipalType <String>] + [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] + [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SpApplicationIdWithDisplayNameParameterSet +``` +Update-AzADServicePrincipal [-KeyCredential <IMicrosoftGraphKeyCredential[]>] + [-PasswordCredential <IMicrosoftGraphPasswordCredential[]>] [-IdentifierUri <String[]>] [-Homepage <String>] + [-AccountEnabled] [-AddIn <IMicrosoftGraphAddIn[]>] [-AlternativeName <String[]>] [-AppDescription <String>] + [-AppOwnerOrganizationId <String>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>] + [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>] [-AppRoleAssignmentRequired] + [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>] + [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>] + [-DeletedDateTime <DateTime>] [-Description <String>] [-DisabledByMicrosoftStatus <String>] + [-DisplayName <String>] [-Endpoint <IMicrosoftGraphEndpoint[]>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-LoginUrl <String>] [-LogoutUrl <String>] [-Note <String>] + [-NotificationEmailAddress <String[]>] [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>] + [-PreferredSingleSignOnMode <String>] [-PreferredTokenSigningKeyThumbprint <String>] [-ReplyUrl <String[]>] + [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>] [-ServicePrincipalType <String>] + [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] + [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>] -ApplicationId <Guid> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectWithDisplayNameParameterSet +``` +Update-AzADServicePrincipal [-KeyCredential <IMicrosoftGraphKeyCredential[]>] + [-PasswordCredential <IMicrosoftGraphPasswordCredential[]>] [-IdentifierUri <String[]>] [-Homepage <String>] + [-AccountEnabled] [-AddIn <IMicrosoftGraphAddIn[]>] [-AlternativeName <String[]>] [-AppDescription <String>] + [-AppOwnerOrganizationId <String>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>] + [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>] [-AppRoleAssignmentRequired] + [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>] + [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>] + [-DeletedDateTime <DateTime>] [-Description <String>] [-DisabledByMicrosoftStatus <String>] + [-DisplayName <String>] [-Endpoint <IMicrosoftGraphEndpoint[]>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-LoginUrl <String>] [-LogoutUrl <String>] [-Note <String>] + [-NotificationEmailAddress <String[]>] [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>] + [-PreferredSingleSignOnMode <String>] [-PreferredTokenSigningKeyThumbprint <String>] [-ReplyUrl <String[]>] + [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>] [-ServicePrincipalType <String>] + [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] + [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>] -InputObject <IMicrosoftGraphServicePrincipal> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SPNWithDisplayNameParameterSet +``` +Update-AzADServicePrincipal [-KeyCredential <IMicrosoftGraphKeyCredential[]>] + [-PasswordCredential <IMicrosoftGraphPasswordCredential[]>] [-IdentifierUri <String[]>] [-Homepage <String>] + [-AccountEnabled] [-AddIn <IMicrosoftGraphAddIn[]>] [-AlternativeName <String[]>] [-AppDescription <String>] + [-AppOwnerOrganizationId <String>] [-AppRole <IMicrosoftGraphAppRole[]>] + [-AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>] + [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>] [-AppRoleAssignmentRequired] + [-ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>] + [-DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>] + [-DeletedDateTime <DateTime>] [-Description <String>] [-DisabledByMicrosoftStatus <String>] + [-DisplayName <String>] [-Endpoint <IMicrosoftGraphEndpoint[]>] + [-HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>] + [-Info <IMicrosoftGraphInformationalUrl>] [-LoginUrl <String>] [-LogoutUrl <String>] [-Note <String>] + [-NotificationEmailAddress <String[]>] [-Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>] + [-PreferredSingleSignOnMode <String>] [-PreferredTokenSigningKeyThumbprint <String>] [-ReplyUrl <String[]>] + [-SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>] [-ServicePrincipalType <String>] + [-Tag <String[]>] [-TokenEncryptionKeyId <String>] + [-TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>] + [-TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>] + [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>] -ServicePrincipalName <String> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates entity in service principal + +## EXAMPLES + +### Example 1: Update service principal and associated application by display name +```powershell +Update-AzADServicePrincipal -DisplayName $name -IdentifierUri $uri +``` + +Update service principal and associated application by display name, 'IdentifierUri', 'PasswordCredential', 'KeyCredential' will be assigned to application + +### Example 2: Update service principal by pipeline input +```powershell +Get-AzADServicePrincipal -ObjectId $id | Update-AzADServicePrincipal -Note $note +``` + +Update service principal and associated application by display name, 'IdentifierUri', 'PasswordCredential', 'KeyCredential' will be assigned to application + +## PARAMETERS + +### -AccountEnabled +true if the service principal account is enabled; otherwise, false. +Supports $filter (eq, ne, NOT, in). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddIn +Defines custom behavior that a consuming service can use to call an app in specific contexts. +For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. +This will let services like Microsoft 365 call the application in the context of a document the user is working on. +To construct, see NOTES section for ADDIN properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAddIn[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlternativeName +Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. +Supports $filter (eq, NOT, ge, le, startsWith). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppDescription +The description exposed by the associated application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +The unique identifier for the associated application (its appId property). + +```yaml +Type: System.Guid +Parameter Sets: SpApplicationIdWithDisplayNameParameterSet +Aliases: AppId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppOwnerOrganizationId +Contains the tenant id where the application is registered. +This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppRole +The roles exposed by the application which this service principal represents. +For more information see the appRoles property definition on the application entity. +Not nullable. +To construct, see NOTES section for APPROLE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAppRole[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppRoleAssignedTo +App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. +To construct, see NOTES section for APPROLEASSIGNEDTO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAppRoleAssignment[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppRoleAssignment +App role assignment for another app or service, granted to this service principal. +Supports $expand. +To construct, see NOTES section for APPROLEASSIGNMENT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphAppRoleAssignment[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppRoleAssignmentRequired +Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. +The default value is false. +Not nullable. +Supports $filter (eq, ne, NOT). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClaimsMappingPolicy +The claimsMappingPolicies assigned to this service principal. +Supports $expand. +To construct, see NOTES section for CLAIMSMAPPINGPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphClaimsMappingPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelegatedPermissionClassification +The permission classifications for delegated permissions exposed by the app that this service principal represents. +Supports $expand. +To construct, see NOTES section for DELEGATEDPERMISSIONCLASSIFICATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphDelegatedPermissionClassification[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedDateTime +. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Free text field to provide an internal end-user facing description of the service principal. +End-user portals such MyApps will display the application description in this field. +The maximum allowed size is 1024 characters. +Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledByMicrosoftStatus +Specifies whether Microsoft has disabled the registered application. +Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). +Supports $filter (eq, ne, NOT). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name for the service principal. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and $orderBy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +Endpoints available for discovery. +Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. +To construct, see NOTES section for ENDPOINT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphEndpoint[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Homepage +Home page or landing page of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HomeRealmDiscoveryPolicy +The homeRealmDiscoveryPolicies assigned to this service principal. +Supports $expand. +To construct, see NOTES section for HOMEREALMDISCOVERYPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphHomeRealmDiscoveryPolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentifierUri +The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. +For more information, see Application Objects and Service Principal Objects. +The any operator is required for filter expressions on multi-valued properties. +Not nullable. +Supports $filter (eq, ne, ge, le, startsWith). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Info +informationalUrl +To construct, see NOTES section for INFO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphInformationalUrl +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +service principal object +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal +Parameter Sets: InputObjectWithDisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyCredential +The collection of key credentials associated with the application. +Not nullable. +Supports $filter (eq, NOT, ge, le). +To construct, see NOTES section for KEYCREDENTIALS properties and create a hash table. +To construct, see NOTES section for KEYCREDENTIAL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphKeyCredential[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoginUrl +Specifies the URL where the service provider redirects the user to Azure AD to authenticate. +Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. +When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. +The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogoutUrl +Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +Free text field to capture information about the service principal, typically used for operational purposes. +Maximum allowed size is 1024 characters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEmailAddress +Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. +This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Oauth2PermissionScope +The delegated permissions exposed by the application. +For more information see the oauth2PermissionScopes property on the application entity's api property. +Not nullable. +To construct, see NOTES section for OAUTH2PERMISSIONSCOPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPermissionScope[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +key: id of servicePrincipal + +```yaml +Type: System.String +Parameter Sets: SpObjectIdWithDisplayNameParameterSet +Aliases: ServicePrincipalId, Id, ServicePrincipalObjectId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordCredential +The collection of password credentials associated with the application. +Not nullable. +To construct, see NOTES section for PASSWORDCREDENTIALS properties and create a hash table. +To construct, see NOTES section for PASSWORDCREDENTIAL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordCredential[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredSingleSignOnMode +Specifies the single sign-on mode configured for this application. +Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. +The supported values are password, saml, notSupported, and oidc. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredTokenSigningKeyThumbprint +Reserved for internal use only. +Do not write or otherwise rely on this property. +May be removed in future versions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyUrl +The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. +Not nullable. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamlSingleSignOnSetting +samlSingleSignOnSettings +To construct, see NOTES section for SAMLSINGLESIGNONSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphSamlSingleSignOnSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalName +Contains the list of identifiersUris, copied over from the associated application. +Additional values can be added to hybrid applications. +These values can be used to identify the permissions exposed by this app within Azure AD. +For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. +Not nullable. +Supports $filter (eq, NOT, ge, le, startsWith). + +```yaml +Type: System.String +Parameter Sets: SPNWithDisplayNameParameterSet +Aliases: SPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalType +Identifies if the service principal represents an application or a managed identity. +This is set by Azure AD internally. +For a service principal that represents an application this is set as Application. +For a service principal that represent a managed identity this is set as ManagedIdentity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Custom strings that can be used to categorize and identify the service principal. +Not nullable. +Supports $filter (eq, NOT, ge, le, startsWith). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenEncryptionKeyId +Specifies the keyId of a public key from the keyCredentials collection. +When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. +The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenIssuancePolicy +The tokenIssuancePolicies assigned to this service principal. +Supports $expand. +To construct, see NOTES section for TOKENISSUANCEPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphTokenIssuancePolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenLifetimePolicy +The tokenLifetimePolicies assigned to this service principal. +Supports $expand. +To construct, see NOTES section for TOKENLIFETIMEPOLICY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphTokenLifetimePolicy[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransitiveMemberOf +. +To construct, see NOTES section for TRANSITIVEMEMBEROF properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphDirectoryObject[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +Set-AzADServicePrincipal + +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. + + +ADDIN <IMicrosoftGraphAddIn[]>: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + +APPROLE <IMicrosoftGraphAppRole[]>: The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + +APPROLEASSIGNEDTO <IMicrosoftGraphAppRoleAssignment[]>: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + +APPROLEASSIGNMENT <IMicrosoftGraphAppRoleAssignment[]>: App role assignment for another app or service, granted to this service principal. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + +CLAIMSMAPPINGPOLICY <IMicrosoftGraphClaimsMappingPolicy[]>: The claimsMappingPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +DELEGATEDPERMISSIONCLASSIFICATION <IMicrosoftGraphDelegatedPermissionClassification[]>: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. + - `[Classification <String>]`: permissionClassificationType + - `[PermissionId <String>]`: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter. + - `[PermissionName <String>]`: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Does not support $filter. + +ENDPOINT <IMicrosoftGraphEndpoint[]>: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +HOMEREALMDISCOVERYPOLICY <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +INFO <IMicrosoftGraphInformationalUrl>: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + +INPUTOBJECT <IMicrosoftGraphServicePrincipal>: service principal object + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AccountEnabled <Boolean?>]`: true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in). + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[AlternativeName <String[]>]`: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, NOT, ge, le, startsWith). + - `[AppDescription <String>]`: The description exposed by the associated application. + - `[AppDisplayName <String>]`: The display name exposed by the associated application. + - `[AppId <String>]`: The unique identifier for the associated application (its appId property). + - `[AppOwnerOrganizationId <String>]`: Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le). + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignment for another app or service, granted to this service principal. Supports $expand. + - `[AppRoleAssignmentRequired <Boolean?>]`: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT). + - `[ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]`: The claimsMappingPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]`: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. + - `[Classification <String>]`: permissionClassificationType + - `[PermissionId <String>]`: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter. + - `[PermissionName <String>]`: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Does not support $filter. + - `[Description <String>]`: Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[Endpoint <IMicrosoftGraphEndpoint[]>]`: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. + - `[Homepage <String>]`: Home page or landing page of the application. + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[LoginUrl <String>]`: Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. + - `[Note <String>]`: Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters. + - `[NotificationEmailAddress <String[]>]`: Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the service principal. Not nullable. + - `[PreferredSingleSignOnMode <String>]`: Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc. + - `[PreferredTokenSigningKeyThumbprint <String>]`: Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions. + - `[ReplyUrl <String[]>]`: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. + - `[SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]`: samlSingleSignOnSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RelayState <String>]`: The relative URI the service provider would redirect to after completion of the single sign-on flow. + - `[ServicePrincipalName <String[]>]`: Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[ServicePrincipalType <String>]`: Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: The tokenIssuancePolicies assigned to this service principal. Supports $expand. + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this service principal. Supports $expand. + - `[TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]`: + +KEYCREDENTIAL <IMicrosoftGraphKeyCredential[]>: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). To construct, see NOTES section for KEYCREDENTIALS properties and create a hash table. + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + +OAUTH2PERMISSIONSCOPE <IMicrosoftGraphPermissionScope[]>: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + +PASSWORDCREDENTIAL <IMicrosoftGraphPasswordCredential[]>: The collection of password credentials associated with the application. Not nullable. To construct, see NOTES section for PASSWORDCREDENTIALS properties and create a hash table. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + +SAMLSINGLESIGNONSETTING <IMicrosoftGraphSamlSingleSignOnSettings>: samlSingleSignOnSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RelayState <String>]`: The relative URI the service provider would redirect to after completion of the single sign-on flow. + +TOKENISSUANCEPOLICY <IMicrosoftGraphTokenIssuancePolicy[]>: The tokenIssuancePolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +TOKENLIFETIMEPOLICY <IMicrosoftGraphTokenLifetimePolicy[]>: The tokenLifetimePolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +TRANSITIVEMEMBEROF <IMicrosoftGraphDirectoryObject[]>: . + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Update-AzADUser.md b/azps-10.1.0/Az.Resources/Update-AzADUser.md new file mode 100644 index 0000000000..71f9e2f4ed --- /dev/null +++ b/azps-10.1.0/Az.Resources/Update-AzADUser.md @@ -0,0 +1,1303 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/update-azaduser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzADUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzADUser.md +--- + +# Update-AzADUser + +## SYNOPSIS +Updates entity in users + +## SYNTAX + +### UPNOrObjectIdParameterSet (Default) +``` +Update-AzADUser -UPNOrObjectId <String> [-AccountEnabled <Boolean>] [-Password <SecureString>] + [-ForceChangePasswordNextLogin] [-AgeGroup <String>] [-City <String>] [-CompanyName <String>] + [-ConsentProvidedForMinor <String>] [-Country <String>] [-DeletedDateTime <DateTime>] [-Department <String>] + [-DisplayName <String>] [-EmployeeHireDate <DateTime>] [-EmployeeId <String>] [-EmployeeType <String>] + [-ExternalUserState <String>] [-ExternalUserStateChangeDateTime <DateTime>] [-FaxNumber <String>] + [-GivenName <String>] [-Id <String>] [-Identity <IMicrosoftGraphObjectIdentity[]>] [-IsResourceAccount] + [-JobTitle <String>] [-Mail <String>] [-MailNickname <String>] [-OfficeLocation <String>] + [-OnPremisesImmutableId <String>] [-OtherMail <String[]>] [-PasswordPolicy <String>] + [-PasswordProfile <IMicrosoftGraphPasswordProfile>] [-PostalCode <String>] [-PreferredLanguage <String>] + [-ShowInAddressList] [-State <String>] [-StreetAddress <String>] [-Surname <String>] [-UsageLocation <String>] + [-UserType <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectIdParameterSet +``` +Update-AzADUser [-AccountEnabled <Boolean>] [-Password <SecureString>] [-ForceChangePasswordNextLogin] + [-AgeGroup <String>] [-City <String>] [-CompanyName <String>] [-ConsentProvidedForMinor <String>] + [-Country <String>] [-DeletedDateTime <DateTime>] [-Department <String>] [-DisplayName <String>] + [-EmployeeHireDate <DateTime>] [-EmployeeId <String>] [-EmployeeType <String>] [-ExternalUserState <String>] + [-ExternalUserStateChangeDateTime <DateTime>] [-FaxNumber <String>] [-GivenName <String>] [-Id <String>] + [-Identity <IMicrosoftGraphObjectIdentity[]>] [-IsResourceAccount] [-JobTitle <String>] [-Mail <String>] + [-MailNickname <String>] [-OfficeLocation <String>] [-OnPremisesImmutableId <String>] [-OtherMail <String[]>] + [-PasswordPolicy <String>] [-PasswordProfile <IMicrosoftGraphPasswordProfile>] [-PostalCode <String>] + [-PreferredLanguage <String>] [-ShowInAddressList] [-State <String>] [-StreetAddress <String>] + [-Surname <String>] [-UsageLocation <String>] [-UserType <String>] -ObjectId <String> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Update-AzADUser [-AccountEnabled <Boolean>] [-Password <SecureString>] [-ForceChangePasswordNextLogin] + [-AgeGroup <String>] [-City <String>] [-CompanyName <String>] [-ConsentProvidedForMinor <String>] + [-Country <String>] [-DeletedDateTime <DateTime>] [-Department <String>] [-DisplayName <String>] + [-EmployeeHireDate <DateTime>] [-EmployeeId <String>] [-EmployeeType <String>] [-ExternalUserState <String>] + [-ExternalUserStateChangeDateTime <DateTime>] [-FaxNumber <String>] [-GivenName <String>] [-Id <String>] + [-Identity <IMicrosoftGraphObjectIdentity[]>] [-IsResourceAccount] [-JobTitle <String>] [-Mail <String>] + [-MailNickname <String>] [-OfficeLocation <String>] [-OnPremisesImmutableId <String>] [-OtherMail <String[]>] + [-PasswordPolicy <String>] [-PasswordProfile <IMicrosoftGraphPasswordProfile>] [-PostalCode <String>] + [-PreferredLanguage <String>] [-ShowInAddressList] [-State <String>] [-StreetAddress <String>] + [-Surname <String>] [-UsageLocation <String>] [-UserType <String>] -InputObject <IMicrosoftGraphUser> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UPNParameterSet +``` +Update-AzADUser [-AccountEnabled <Boolean>] [-Password <SecureString>] [-ForceChangePasswordNextLogin] + [-AgeGroup <String>] [-City <String>] [-CompanyName <String>] [-ConsentProvidedForMinor <String>] + [-Country <String>] [-DeletedDateTime <DateTime>] [-Department <String>] [-DisplayName <String>] + [-EmployeeHireDate <DateTime>] [-EmployeeId <String>] [-EmployeeType <String>] [-ExternalUserState <String>] + [-ExternalUserStateChangeDateTime <DateTime>] [-FaxNumber <String>] [-GivenName <String>] [-Id <String>] + [-Identity <IMicrosoftGraphObjectIdentity[]>] [-IsResourceAccount] [-JobTitle <String>] [-Mail <String>] + [-MailNickname <String>] [-OfficeLocation <String>] [-OnPremisesImmutableId <String>] [-OtherMail <String[]>] + [-PasswordPolicy <String>] [-PasswordProfile <IMicrosoftGraphPasswordProfile>] [-PostalCode <String>] + [-PreferredLanguage <String>] [-ShowInAddressList] [-State <String>] [-StreetAddress <String>] + [-Surname <String>] [-UsageLocation <String>] [-UserType <String>] -UserPrincipalName <String> + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates entity in users + +## EXAMPLES + +### Example 1: Update user by user principal name +```powershell +Update-AzADUser -UPNOrObjectId $upn -City $city +``` + +Update user by user principal name + +## PARAMETERS + +### -AccountEnabled +true for enabling the account; otherwise, false. +Always true when combined with `-Password`. +`-AccountEnabled $false` is ignored when changing the account's password. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: EnableAccount + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgeGroup +Sets the age group of the user. +Allowed values: null, minor, notAdult and adult. +Refer to the legal age group property definitions for further information. +Supports $filter (eq, ne, NOT, and in). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -City +The city in which the user is located. +Maximum length is 128 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyName +The company name which the user is associated. +This property can be useful for describing the company that an external user comes from. +The maximum length of the company name is 64 characters.Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsentProvidedForMinor +Sets whether consent has been obtained for minors. +Allowed values: null, granted, denied and notRequired. +Refer to the legal age group property definitions for further information. +Supports $filter (eq, ne, NOT, and in). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Country +The country/region in which the user is located; for example, US or UK. +Maximum length is 128 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedDateTime +. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Department +The name for the department in which the user works. +Maximum length is 64 characters.Supports $filter (eq, ne, NOT , ge, le, and in operators). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The name displayed in the address book for the user. +This value is usually the combination of the user's first name, middle initial, and last name. +This property is required when a user is created and it cannot be cleared during updates. +Maximum length is 256 characters. +Supports $filter (eq, ne, NOT , ge, le, in, startsWith), $orderBy, and $search. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmployeeHireDate +The date and time when the user was hired or will start work in case of a future hire. +Supports $filter (eq, ne, NOT , ge, le, in). + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmployeeId +The employee identifier assigned to the user by the organization. +Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmployeeType +Captures enterprise worker type. +For example, Employee, Contractor, Consultant, or Vendor. +Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalUserState +For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. +For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. +Supports $filter (eq, ne, NOT , in). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalUserStateChangeDateTime +Shows the timestamp for the latest change to the externalUserState property. +Supports $filter (eq, ne, NOT , in). + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FaxNumber +The fax number of the user. +Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceChangePasswordNextLogin +It must be specified if the user must change the password on the next successful login (true). +Default behavior is (false) to not change the password on the next successful login. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GivenName +The given name (first name) of the user. +Maximum length is 64 characters. +Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Read-only. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Represents the identities that can be used to sign in to this user account. +An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. +May contain multiple items with the same signInType value. +Supports $filter (eq) only where the signInType is not userPrincipalName. +To construct, see NOTES section for IDENTITY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphObjectIdentity[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +user input object +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphUser +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsResourceAccount +Do not use - reserved for future use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobTitle +The user's job title. +Maximum length is 128 characters. +Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mail +The SMTP address for the user, for example, admin@contoso.com. +Changes to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. +While this property can contain accent characters, using them can cause access issues with other Microsoft applications for the user. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailNickname +The mail alias for the user. +This property must be specified when a user is created. +Maximum length is 64 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The user principal name of the user to be updated. + +```yaml +Type: System.String +Parameter Sets: ObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfficeLocation +The office location in the user's place of business. +Maximum length is 128 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnPremisesImmutableId +This property is used to associate an on-premises Active Directory user account to their Azure AD user object. +This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's userPrincipalName (UPN) property. +NOTE: The $ and _ characters cannot be used when specifying this property. +Returned only on $select. +Supports $filter (eq, ne, NOT, ge, le, in).. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OtherMail +A list of additional email addresses for the user; for example: ['bob@contoso.com', 'Robert@fabrikam.com'].NOTE: While this property can contain accent characters, they can cause access issues to first-party applications for the user.Supports $filter (eq, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The password for the user. +This property is required when a user is created. + +It can be updated, but the user will be required to change the password on the next login. + +The password must satisfy minimum requirements as speci./fied by the user's passwordPolicies property. +By default, a strong password is required. +When changing the password using this method, AccountEnabled is set to true. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordPolicy +Specifies password policies for the user. +This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. +DisablePasswordExpiration can also be specified. +The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.Supports $filter (ne, NOT). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordProfile +passwordProfile +To construct, see NOTES section for PASSWORDPROFILE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordProfile +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostalCode +The postal code for the user's postal address. +The postal code is specific to the user's country/region. +In the United States of America, this attribute contains the ZIP code. +Maximum length is 40 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredLanguage +The preferred language for the user. +Should follow ISO 639-1 Code; for example en-US. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowInAddressList +true if the Outlook global address list should contain this user, otherwise false. +If not set, this will be treated as true. +For users invited through the invitation manager, this property will be set to false. +Supports $filter (eq, ne, NOT, in). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The state or province in the user's address. +Maximum length is 128 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreetAddress +The street address of the user's place of business. +Maximum length is 1024 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Surname +The user's surname (family name or last name). +Maximum length is 64 characters. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UPNOrObjectId +The user principal name or object id of the user to be updated. + +```yaml +Type: System.String +Parameter Sets: UPNOrObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsageLocation +A two letter country code (ISO standard 3166). +Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. +Examples include: US, JP, and GB. +Not nullable. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +The user principal name (UPN) of the user. +The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. +By convention, this should map to the user's email name. +The general format is alias@domain, where domain must be present in the tenant's collection of verified domains. +This property is required when a user is created. +The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: While this property can contain accent characters, they can cause access issues to first-party applications for the user. +Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith) and $orderBy. + +```yaml +Type: System.String +Parameter Sets: UPNParameterSet +Aliases: UPN + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserType +A string value that can be used to classify user types in your directory, such as Member and Guest. +Supports $filter (eq, ne, NOT, in,). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphUser + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +Set-AzADUser + +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. + + +IDENTITY <IMicrosoftGraphObjectIdentity[]>: Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value. Supports $filter (eq) only where the signInType is not userPrincipalName. + - `[Issuer <String>]`: Specifies the issuer of the identity, for example facebook.com.For local accounts (where signInType is not federated), this property is the local B2C tenant default domain name, for example contoso.onmicrosoft.com.For external users from other Azure AD organization, this will be the domain of the federated organization, for example contoso.com.Supports $filter. 512 character limit. + - `[IssuerAssignedId <String>]`: Specifies the unique identifier assigned to the user by the issuer. The combination of issuer and issuerAssignedId must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).When signInType is set to: emailAddress, (or a custom string that starts with emailAddress like emailAddress1) issuerAssignedId must be a valid email addressuserName, issuerAssignedId must be a valid local part of an email addressSupports $filter. 100 character limit. + - `[SignInType <String>]`: Specifies the user sign-in types in your directory, such as emailAddress, userName or federated. Here, federated represents a unique identifier for a user from an issuer, that can be in any format chosen by the issuer. Additional validation is enforced on issuerAssignedId when the sign-in type is set to emailAddress or userName. This property can also be set to any custom string. + +INPUTOBJECT <IMicrosoftGraphUser>: user input object + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AccountEnabled <Boolean?>]`: true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, NOT, and in). + - `[AgeGroup <String>]`: Sets the age group of the user. Allowed values: null, minor, notAdult and adult. Refer to the legal age group property definitions for further information. Supports $filter (eq, ne, NOT, and in). + - `[ApproximateLastSignInDateTime <DateTime?>]`: The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderBy. + - `[City <String>]`: The city in which the user is located. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[CompanyName <String>]`: The company name which the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length of the company name is 64 characters.Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[ComplianceExpirationDateTime <DateTime?>]`: The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[ConsentProvidedForMinor <String>]`: Sets whether consent has been obtained for minors. Allowed values: null, granted, denied and notRequired. Refer to the legal age group property definitions for further information. Supports $filter (eq, ne, NOT, and in). + - `[Country <String>]`: The country/region in which the user is located; for example, US or UK. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[Department <String>]`: The name for the department in which the user works. Maximum length is 64 characters.Supports $filter (eq, ne, NOT , ge, le, and in operators). + - `[DeviceVersion <Int32?>]`: For internal use only. + - `[EmployeeHireDate <DateTime?>]`: The date and time when the user was hired or will start work in case of a future hire. Supports $filter (eq, ne, NOT , ge, le, in). + - `[EmployeeId <String>]`: The employee identifier assigned to the user by the organization. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[EmployeeOrgData <IMicrosoftGraphEmployeeOrgData>]`: employeeOrgData + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CostCenter <String>]`: The cost center associated with the user. Returned only on $select. Supports $filter. + - `[Division <String>]`: The name of the division in which the user works. Returned only on $select. Supports $filter. + - `[EmployeeType <String>]`: Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[ExternalUserState <String>]`: For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Supports $filter (eq, ne, NOT , in). + - `[ExternalUserStateChangeDateTime <DateTime?>]`: Shows the timestamp for the latest change to the externalUserState property. Supports $filter (eq, ne, NOT , in). + - `[FaxNumber <String>]`: The fax number of the user. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[GivenName <String>]`: The given name (first name) of the user. Maximum length is 64 characters. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[Identity <IMicrosoftGraphObjectIdentity[]>]`: Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value. Supports $filter (eq) only where the signInType is not userPrincipalName. + - `[Issuer <String>]`: Specifies the issuer of the identity, for example facebook.com.For local accounts (where signInType is not federated), this property is the local B2C tenant default domain name, for example contoso.onmicrosoft.com.For external users from other Azure AD organization, this will be the domain of the federated organization, for example contoso.com.Supports $filter. 512 character limit. + - `[IssuerAssignedId <String>]`: Specifies the unique identifier assigned to the user by the issuer. The combination of issuer and issuerAssignedId must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).When signInType is set to: emailAddress, (or a custom string that starts with emailAddress like emailAddress1) issuerAssignedId must be a valid email addressuserName, issuerAssignedId must be a valid local part of an email addressSupports $filter. 100 character limit. + - `[SignInType <String>]`: Specifies the user sign-in types in your directory, such as emailAddress, userName or federated. Here, federated represents a unique identifier for a user from an issuer, that can be in any format chosen by the issuer. Additional validation is enforced on issuerAssignedId when the sign-in type is set to emailAddress or userName. This property can also be set to any custom string. + - `[IsResourceAccount <Boolean?>]`: Do not use - reserved for future use. + - `[JobTitle <String>]`: The user's job title. Maximum length is 128 characters. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[Mail <String>]`: The SMTP address for the user, for example, admin@contoso.com. Changes to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. While this property can contain accent characters, using them can cause access issues with other Microsoft applications for the user. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith). + - `[MailNickname <String>]`: The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[Manager <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AssignedPlan <IMicrosoftGraphAssignedPlan[]>]`: The collection of service plans associated with the tenant. Not nullable. + - `[AssignedDateTime <DateTime?>]`: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + - `[CapabilityStatus <String>]`: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value. + - `[Service <String>]`: The name of the service; for example, exchange. + - `[ServicePlanId <String>]`: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing. + - `[Branding <IMicrosoftGraphOrganizationalBranding>]`: organizationalBranding + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]`: Add different branding based on a locale. + - `[BackgroundColor <String>]`: Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF. + - `[BackgroundImage <Byte[]>]`: Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. + - `[BackgroundImageRelativeUrl <String>]`: A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[BannerLogo <Byte[]>]`: A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. + - `[BannerLogoRelativeUrl <String>]`: A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. + - `[CdnList <String[]>]`: A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. + - `[SignInPageText <String>]`: Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. + - `[SquareLogo <Byte[]>]`: A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. + - `[SquareLogoRelativeUrl <String>]`: A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. + - `[UsernameHintText <String>]`: String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[BusinessPhone <String[]>]`: Telephone number for the organization. Although this is a string collection, only one number can be set for this property. + - `[CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]`: Navigation property to manage certificate-based authentication configuration. Only a single instance of certificateBasedAuthConfiguration can be created in the collection. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]`: Collection of certificate authorities which creates a trusted certificate chain. + - `[Certificate <Byte[]>]`: Required. The base64 encoded string representing the public certificate. + - `[CertificateRevocationListUrl <String>]`: The URL of the certificate revocation list. + - `[DeltaCertificateRevocationListUrl <String>]`: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created. + - `[IsRootAuthority <Boolean?>]`: Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority. + - `[Issuer <String>]`: The issuer of the certificate, calculated from the certificate value. Read-only. + - `[IssuerSki <String>]`: The subject key identifier of the certificate, calculated from the certificate value. Read-only. + - `[City <String>]`: City name of the address for the organization. + - `[Country <String>]`: Country/region name of the address for the organization. + - `[CountryLetterCode <String>]`: Country or region abbreviation for the organization in ISO 3166-2 format. + - `[CreatedDateTime <DateTime?>]`: Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[Extension <IMicrosoftGraphExtension[]>]`: The collection of open extensions defined for the organization. Read-only. Nullable. + - `[Id <String>]`: The unique idenfier for an entity. Read-only. + - `[MarketingNotificationEmail <String[]>]`: Not nullable. + - `[MobileDeviceManagementAuthority <MdmAuthority?>]`: Mobile device management authority. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default). + - `[PostalCode <String>]`: Postal code of the address for the organization. + - `[PreferredLanguage <String>]`: The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. + - `[PrivacyProfile <IMicrosoftGraphPrivacyProfile>]`: privacyProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ContactEmail <String>]`: A valid smtp email address for the privacy statement contact. Not required. + - `[StatementUrl <String>]`: A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. + - `[ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]`: Not nullable. + - `[CapabilityStatus <String>]`: For example, 'Enabled'. + - `[ProvisioningStatus <String>]`: For example, 'Success'. + - `[Service <String>]`: The name of the service; for example, 'AccessControlS2S' + - `[SecurityComplianceNotificationMail <String[]>]`: + - `[SecurityComplianceNotificationPhone <String[]>]`: + - `[State <String>]`: State name of the address for the organization. + - `[Street <String>]`: Street name of the address for organization. + - `[TechnicalNotificationMail <String[]>]`: Not nullable. + - `[TenantType <String>]`: + - `[VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]`: The collection of domains associated with this tenant. Not nullable. + - `[Capability <String>]`: For example, Email, OfficeCommunicationsOnline. + - `[IsDefault <Boolean?>]`: true if this is the default domain associated with the tenant; otherwise, false. + - `[IsInitial <Boolean?>]`: true if this is the initial domain associated with the tenant; otherwise, false. + - `[Name <String>]`: The domain name; for example, contoso.onmicrosoft.com. + - `[Type <String>]`: For example, Managed. + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Office 365 call the application in the context of a document the user is working on. + - `[Id <String>]`: + - `[Property <IMicrosoftGraphKeyValue[]>]`: + - `[Key <String>]`: Key. + - `[Value <String>]`: Value. + - `[Type <String>]`: + - `[Api <IMicrosoftGraphApiApplication>]`: apiApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AcceptMappedClaim <Boolean?>]`: When true, allows an application to use claims mapping without specifying a custom signing key. + - `[KnownClientApplication <String[]>]`: Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes. + - `[AdminConsentDescription <String>]`: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences. + - `[AdminConsentDisplayName <String>]`: The permission's title, intended to be read by an administrator granting the permission on behalf of all users. + - `[Id <String>]`: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application. + - `[IsEnabled <Boolean?>]`: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. + - `[Origin <String>]`: + - `[Type <String>]`: Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. This will be the default behavior, but each customer can choose to customize the behavior in their organization (by allowing, restricting or limiting user consent to this delegated permission.) + - `[UserConsentDescription <String>]`: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[UserConsentDisplayName <String>]`: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves. + - `[Value <String>]`: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]`: Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. + - `[AppId <String>]`: The unique identifier for the application. + - `[DelegatedPermissionId <String[]>]`: The unique identifier for the oauth2PermissionScopes the application requires. + - `[RequestedAccessTokenVersion <Int32?>]`: Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount, the value for this property must be 2 + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. + - `[AllowedMemberType <String[]>]`: Specifies whether this app role can be assigned to users and groups (by setting to ['User']), to other application's (by setting to ['Application'], or both (by setting to ['User', 'Application']). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities. + - `[Description <String>]`: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. + - `[DisplayName <String>]`: Display name for the permission that appears in the app role assignment and consent experiences. + - `[Id <String>]`: Unique role identifier inside the appRoles collection. When creating a new app role, a new Guid identifier must be provided. + - `[IsEnabled <Boolean?>]`: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. + - `[Value <String>]`: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with .. + - `[ApplicationTemplateId <String>]`: Unique identifier of the applicationTemplate. + - `[CreatedOnBehalfOfDeletedDateTime <DateTime?>]`: + - `[CreatedOnBehalfOfDisplayName <String>]`: The name displayed in directory + - `[Description <String>]`: An optional description of the application. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: Federated identities for applications. Supports $expand and $filter (eq when counting empty collections). + - `[Audience <String[]>]`: Lists the audiences that can appear in the external token. This field is mandatory, and defaults to 'api://AzureADTokenExchange'. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. Required. + - `[Description <String>]`: The un-validated, user-provided description of the federated identity credential. Optional. + - `[Issuer <String>]`: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. Required. + - `[Name <String>]`: is the unique identifier for the federated identity credential, which has a character limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq). + - `[Subject <String>]`: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. Supports $filter (eq). + - `[GroupMembershipClaim <String>]`: Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[IdentifierUri <String[]>]`: The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see Application Objects and Service Principal Objects. The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[MarketingUrl <String>]`: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing + - `[PrivacyStatementUrl <String>]`: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy + - `[SupportUrl <String>]`: Link to the application's support page. For example, https://www.contoso.com/app/support + - `[TermsOfServiceUrl <String>]`: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice + - `[IsDeviceOnlyAuthSupported <Boolean?>]`: Specifies whether this application supports device authentication without a user. The default is false. + - `[IsFallbackPublicClient <Boolean?>]`: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where the application is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[CustomKeyIdentifier <Byte[]>]`: Custom key identifier + - `[DisplayName <String>]`: Friendly name for the key. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the credential expires.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Key <Byte[]>]`: Value for the key credential. Should be a base 64 encoded value. + - `[KeyId <String>]`: The unique identifier (GUID) for the key. + - `[StartDateTime <DateTime?>]`: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + - `[Type <String>]`: The type of key credential; for example, 'Symmetric'. + - `[Usage <String>]`: A string that describes the purpose for which the key can be used; for example, 'Verify'. + - `[Logo <Byte[]>]`: The main logo for the application. Not nullable. + - `[Note <String>]`: Notes relevant for the management of the application. + - `[Oauth2RequirePostResponse <Boolean?>]`: + - `[OptionalClaim <IMicrosoftGraphOptionalClaims>]`: optionalClaims + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[AccessToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT access token. + - `[AdditionalProperty <String[]>]`: Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. + - `[Essential <Boolean?>]`: If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. + - `[Name <String>]`: The name of the optional claim. + - `[Source <String>]`: The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. + - `[IdToken <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the JWT ID token. + - `[Saml2Token <IMicrosoftGraphOptionalClaim[]>]`: The optional claims returned in the SAML token. + - `[ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]`: parentalControlSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[CountriesBlockedForMinor <String[]>]`: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list. + - `[LegalAgeGroupRule <String>]`: Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.BlockMinorsBlocks minors from using the app. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the application. Not nullable. + - `[CustomKeyIdentifier <Byte[]>]`: Do not use. + - `[DisplayName <String>]`: Friendly name for the password. Optional. + - `[EndDateTime <DateTime?>]`: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[KeyId <String>]`: The unique identifier for the password. + - `[StartDateTime <DateTime?>]`: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. + - `[PublicClient <IMicrosoftGraphPublicClientApplication>]`: publicClientApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]`: Specifies the resources that the application needs to access. This property also specifies the set of OAuth permission scopes and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[ResourceAccess <IMicrosoftGraphResourceAccess[]>]`: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource. + - `[Id <String>]`: The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. + - `[Type <String>]`: Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. + - `[ResourceAppId <String>]`: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. + - `[SignInAudience <String>]`: Specifies the Microsoft accounts that are supported for the current application. Supported values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, NOT). + - `[Spa <IMicrosoftGraphSpaApplication>]`: spaApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the application. Not nullable.Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this application. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[Web <IMicrosoftGraphWebApplication>]`: webApplication + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[HomePageUrl <String>]`: Home page or landing page of the application. + - `[ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]`: implicitGrantSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[EnableAccessTokenIssuance <Boolean?>]`: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow. + - `[EnableIdTokenIssuance <Boolean?>]`: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols. + - `[RedirectUri <String[]>]`: Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. + - `[DataType <String>]`: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + - `[Name <String>]`: Name of the extension property. Not nullable. + - `[TargetObject <String[]>]`: Following values are supported. Not nullable. UserGroupOrganizationDeviceApplication + - `[Description <String>]`: Description for this policy. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[AccountEnabled <Boolean?>]`: true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in). + - `[AddIn <IMicrosoftGraphAddIn[]>]`: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. + - `[AlternativeName <String[]>]`: Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, NOT, ge, le, startsWith). + - `[AppDescription <String>]`: The description exposed by the associated application. + - `[AppDisplayName <String>]`: The display name exposed by the associated application. + - `[AppId <String>]`: The unique identifier for the associated application (its appId property). + - `[AppOwnerOrganizationId <String>]`: Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications.Supports $filter (eq, ne, NOT, ge, le). + - `[AppRole <IMicrosoftGraphAppRole[]>]`: The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. + - `[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]`: App role assignment for another app or service, granted to this service principal. Supports $expand. + - `[AppRoleAssignmentRequired <Boolean?>]`: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT). + - `[ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]`: The claimsMappingPolicies assigned to this service principal. Supports $expand. + - `[AppliesTo <IMicrosoftGraphDirectoryObject[]>]`: + - `[Definition <String[]>]`: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required. + - `[IsOrganizationDefault <Boolean?>]`: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. + - `[Description <String>]`: Description for this policy. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]`: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand. + - `[Classification <String>]`: permissionClassificationType + - `[PermissionId <String>]`: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter. + - `[PermissionName <String>]`: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Does not support $filter. + - `[Description <String>]`: Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[DisabledByMicrosoftStatus <String>]`: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + - `[Endpoint <IMicrosoftGraphEndpoint[]>]`: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]`: + - `[HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]`: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. + - `[Homepage <String>]`: Home page or landing page of the application. + - `[Info <IMicrosoftGraphInformationalUrl>]`: informationalUrl + - `[KeyCredentials <IMicrosoftGraphKeyCredential[]>]`: The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, NOT, ge, le). + - `[LoginUrl <String>]`: Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. + - `[LogoutUrl <String>]`: Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. + - `[Note <String>]`: Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters. + - `[NotificationEmailAddress <String[]>]`: Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. + - `[Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]`: The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. + - `[PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]`: The collection of password credentials associated with the service principal. Not nullable. + - `[PreferredSingleSignOnMode <String>]`: Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc. + - `[PreferredTokenSigningKeyThumbprint <String>]`: Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions. + - `[ReplyUrl <String[]>]`: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. + - `[SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]`: samlSingleSignOnSettings + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[RelayState <String>]`: The relative URI the service provider would redirect to after completion of the single sign-on flow. + - `[ServicePrincipalName <String[]>]`: Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[ServicePrincipalType <String>]`: Identifies if the service principal represents an application or a managed identity. This is set by Azure AD internally. For a service principal that represents an application this is set as Application. For a service principal that represent a managed identity this is set as ManagedIdentity. + - `[Tag <String[]>]`: Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + - `[TokenEncryptionKeyId <String>]`: Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. + - `[TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]`: The tokenIssuancePolicies assigned to this service principal. Supports $expand. + - `[TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]`: The tokenLifetimePolicies assigned to this service principal. Supports $expand. + - `[TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]`: + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[CreatedDateTime <DateTime?>]`: The time when the app role assignment was created.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[PrincipalDisplayName <String>]`: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith). + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[PrincipalType <String>]`: The type of the assigned principal. This can either be User, Group or ServicePrincipal. Read-only. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]`: Represents the app roles a group has been granted for an application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[AppRoleId <String>]`: The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. + - `[CreatedDateTime <DateTime?>]`: The time when the app role assignment was created.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[PrincipalDisplayName <String>]`: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith). + - `[PrincipalId <String>]`: The unique identifier (id) for the user, group or service principal being granted the app role. Required on create. + - `[PrincipalType <String>]`: The type of the assigned principal. This can either be User, Group or ServicePrincipal. Read-only. + - `[ResourceDisplayName <String>]`: The display name of the resource app's service principal to which the assignment is made. + - `[ResourceId <String>]`: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + - `[Classification <String>]`: Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[Description <String>]`: An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + - `[GroupType <String[]>]`: Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT). + - `[HasMembersWithLicenseError <Boolean?>]`: Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). Supports $filter (eq). + - `[IsArchived <Boolean?>]`: + - `[IsAssignableToRole <Boolean?>]`: Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must also be assigned the Directory.AccessAsUser.All permission to set this property. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT). + - `[MailEnabled <Boolean?>]`: Specifies whether the group is mail-enabled. Returned by default. Supports $filter (eq, ne, NOT). + - `[MailNickname <String>]`: The mail alias for the group, unique in the organization. This property must be specified when a group is created. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[MembershipRule <String>]`: The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + - `[MembershipRuleProcessingState <String>]`: Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]`: The permissions that have been granted for a group to a specific application. Supports $expand. + - `[DeletedDateTime <DateTime?>]`: + - `[DisplayName <String>]`: The name displayed in directory + - `[ClientAppId <String>]`: ID of the service principal of the Azure AD app that has been granted access. Read-only. + - `[ClientId <String>]`: ID of the Azure AD app that has been granted access. Read-only. + - `[Permission <String>]`: The name of the resource-specific permission. Read-only. + - `[PermissionType <String>]`: The type of permission. Possible values are: Application, Delegated. Read-only. + - `[ResourceAppId <String>]`: ID of the Azure AD app that is hosting the resource. Read-only. + - `[PreferredDataLocation <String>]`: The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default. + - `[PreferredLanguage <String>]`: The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[SecurityEnabled <Boolean?>]`: Specifies whether the group is a security group. Returned by default. Supports $filter (eq, ne, NOT, in). + - `[SecurityIdentifier <String>]`: Security identifier of the group, used in Windows scenarios. Returned by default. + - `[Theme <String>]`: Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default. + - `[Visibility <String>]`: Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default. + - `[ClientAppId <String>]`: ID of the service principal of the Azure AD app that has been granted access. Read-only. + - `[ClientId <String>]`: ID of the Azure AD app that has been granted access. Read-only. + - `[Permission <String>]`: The name of the resource-specific permission. Read-only. + - `[PermissionType <String>]`: The type of permission. Possible values are: Application, Delegated. Read-only. + - `[ResourceAppId <String>]`: ID of the Azure AD app that is hosting the resource. Read-only. + - `[AccountEnabled <Boolean?>]`: true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, NOT, and in). + - `[AgeGroup <String>]`: Sets the age group of the user. Allowed values: null, minor, notAdult and adult. Refer to the legal age group property definitions for further information. Supports $filter (eq, ne, NOT, and in). + - `[ApproximateLastSignInDateTime <DateTime?>]`: The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderBy. + - `[City <String>]`: The city in which the user is located. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[CompanyName <String>]`: The company name which the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length of the company name is 64 characters.Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[ComplianceExpirationDateTime <DateTime?>]`: The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. + - `[ConsentProvidedForMinor <String>]`: Sets whether consent has been obtained for minors. Allowed values: null, granted, denied and notRequired. Refer to the legal age group property definitions for further information. Supports $filter (eq, ne, NOT, and in). + - `[Country <String>]`: The country/region in which the user is located; for example, US or UK. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[Department <String>]`: The name for the department in which the user works. Maximum length is 64 characters.Supports $filter (eq, ne, NOT , ge, le, and in operators). + - `[DeviceVersion <Int32?>]`: For internal use only. + - `[EmployeeHireDate <DateTime?>]`: The date and time when the user was hired or will start work in case of a future hire. Supports $filter (eq, ne, NOT , ge, le, in). + - `[EmployeeId <String>]`: The employee identifier assigned to the user by the organization. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[EmployeeOrgData <IMicrosoftGraphEmployeeOrgData>]`: employeeOrgData + - `[EmployeeType <String>]`: Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[ExternalUserState <String>]`: For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Supports $filter (eq, ne, NOT , in). + - `[ExternalUserStateChangeDateTime <DateTime?>]`: Shows the timestamp for the latest change to the externalUserState property. Supports $filter (eq, ne, NOT , in). + - `[FaxNumber <String>]`: The fax number of the user. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[GivenName <String>]`: The given name (first name) of the user. Maximum length is 64 characters. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[Identity <IMicrosoftGraphObjectIdentity[]>]`: Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value. Supports $filter (eq) only where the signInType is not userPrincipalName. + - `[IsResourceAccount <Boolean?>]`: Do not use - reserved for future use. + - `[JobTitle <String>]`: The user's job title. Maximum length is 128 characters. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + - `[Mail <String>]`: The SMTP address for the user, for example, admin@contoso.com. Changes to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. While this property can contain accent characters, using them can cause access issues with other Microsoft applications for the user. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith). + - `[MailNickname <String>]`: The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[Manager <IMicrosoftGraphDirectoryObject>]`: Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. + - `[OfficeLocation <String>]`: The office location in the user's place of business. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[OnPremisesImmutableId <String>]`: This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property. Returned only on $select. Supports $filter (eq, ne, NOT, ge, le, in).. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in). + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values). + - `[OperatingSystem <String>]`: Operating system of the device. Windows, iOS, etc. This property is read-only. + - `[OperatingSystemVersion <String>]`: Operating system version of the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values). + - `[OtherMail <String[]>]`: A list of additional email addresses for the user; for example: ['bob@contoso.com', 'Robert@fabrikam.com'].NOTE: While this property can contain accent characters, they can cause access issues to first-party applications for the user.Supports $filter (eq, NOT, ge, le, in, startsWith). + - `[PasswordPolicy <String>]`: Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.Supports $filter (ne, NOT). + - `[PasswordProfile <IMicrosoftGraphPasswordProfile>]`: passwordProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ForceChangePasswordNextSignIn <Boolean?>]`: true if the user must change her password on the next login; otherwise false. If not set, default is false. NOTE: For Azure B2C tenants, set to false and instead use custom policies and user flows to force password reset at first sign in. See Force password reset at first logon. + - `[ForceChangePasswordNextSignInWithMfa <Boolean?>]`: If true, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false. + - `[Password <String>]`: The password for the user. This property is required when a user is created. It can be updated, but the user will be required to change the password on the next login. The password must satisfy minimum requirements as specified by the user's passwordPolicies property. By default, a strong password is required. + - `[PhysicalId <String[]>]`: For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith). + - `[PostalCode <String>]`: The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[PreferredLanguage <String>]`: The preferred language for the user. Should follow ISO 639-1 Code; for example en-US. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[ShowInAddressList <Boolean?>]`: true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false. Supports $filter (eq, ne, NOT, in). + - `[State <String>]`: The state or province in the user's address. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[StreetAddress <String>]`: The street address of the user's place of business. Maximum length is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[Surname <String>]`: The user's surname (family name or last name). Maximum length is 64 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[TrustType <String>]`: Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud only joined devices), ServerAd (on-premises domain joined devices joined to Azure AD). For more details, see Introduction to device management in Azure Active Directory + - `[UsageLocation <String>]`: A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[UserPrincipalName <String>]`: The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: While this property can contain accent characters, they can cause access issues to first-party applications for the user. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith) and $orderBy. + - `[UserType <String>]`: A string value that can be used to classify user types in your directory, such as Member and Guest. Supports $filter (eq, ne, NOT, in,). + - `[OfficeLocation <String>]`: The office location in the user's place of business. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[OnPremisesImmutableId <String>]`: This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property. Returned only on $select. Supports $filter (eq, ne, NOT, ge, le, in).. + - `[OnPremisesLastSyncDateTime <DateTime?>]`: The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in). + - `[OnPremisesSyncEnabled <Boolean?>]`: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values). + - `[OperatingSystem <String>]`: Operating system of the device. Windows, iOS, etc. This property is read-only. + - `[OperatingSystemVersion <String>]`: Operating system version of the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values). + - `[OtherMail <String[]>]`: A list of additional email addresses for the user; for example: ['bob@contoso.com', 'Robert@fabrikam.com'].NOTE: While this property can contain accent characters, they can cause access issues to first-party applications for the user.Supports $filter (eq, NOT, ge, le, in, startsWith). + - `[PasswordPolicy <String>]`: Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.Supports $filter (ne, NOT). + - `[PasswordProfile <IMicrosoftGraphPasswordProfile>]`: passwordProfile + - `[PhysicalId <String[]>]`: For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith). + - `[PostalCode <String>]`: The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[PreferredLanguage <String>]`: The preferred language for the user. Should follow ISO 639-1 Code; for example en-US. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[ShowInAddressList <Boolean?>]`: true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false. Supports $filter (eq, ne, NOT, in). + - `[State <String>]`: The state or province in the user's address. Maximum length is 128 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[StreetAddress <String>]`: The street address of the user's place of business. Maximum length is 1024 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[Surname <String>]`: The user's surname (family name or last name). Maximum length is 64 characters. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[TrustType <String>]`: Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud only joined devices), ServerAd (on-premises domain joined devices joined to Azure AD). For more details, see Introduction to device management in Azure Active Directory + - `[UsageLocation <String>]`: A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + - `[UserPrincipalName <String>]`: The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: While this property can contain accent characters, they can cause access issues to first-party applications for the user. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith) and $orderBy. + - `[UserType <String>]`: A string value that can be used to classify user types in your directory, such as Member and Guest. Supports $filter (eq, ne, NOT, in,). + +PASSWORDPROFILE <IMicrosoftGraphPasswordProfile>: passwordProfile + - `[(Any) <Object>]`: This indicates any property can be added to this object. + - `[ForceChangePasswordNextSignIn <Boolean?>]`: true if the user must change her password on the next login; otherwise false. If not set, default is false. NOTE: For Azure B2C tenants, set to false and instead use custom policies and user flows to force password reset at first sign in. See Force password reset at first logon. + - `[ForceChangePasswordNextSignInWithMfa <Boolean?>]`: If true, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false. + - `[Password <String>]`: The password for the user. This property is required when a user is created. It can be updated, but the user will be required to change the password on the next login. The password must satisfy minimum requirements as specified by the user's passwordPolicies property. By default, a strong password is required. + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Update-AzManagementGroup.md b/azps-10.1.0/Az.Resources/Update-AzManagementGroup.md new file mode 100644 index 0000000000..2b71aa2f69 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Update-AzManagementGroup.md @@ -0,0 +1,256 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/update-azmanagementgroup/ +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzManagementGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzManagementGroup.md +--- + +# Update-AzManagementGroup + +## SYNOPSIS +Updates a Management Group + +## SYNTAX + +### GroupOperations (Default) +``` +Update-AzManagementGroup -GroupName <String> [-DisplayName <String>] [-ParentId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentAndManagementGroupObject +``` +Update-AzManagementGroup -InputObject <PSManagementGroup> [-DisplayName <String>] + [-DefaultProfile <IAzureContextContainer>] -ParentObject <PSManagementGroup> [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ManagementGroupObject +``` +Update-AzManagementGroup -InputObject <PSManagementGroup> [-DisplayName <String>] [-ParentId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentGroupObject +``` +Update-AzManagementGroup -GroupName <String> [-DisplayName <String>] [-DefaultProfile <IAzureContextContainer>] + -ParentObject <PSManagementGroup> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzManagementGroup** cmdlet updates the **ParentId** or **DisplayName** for a Management Group. + +## EXAMPLES + +### Example 1: Update a Management Group's Display Name +```powershell +Update-AzManagementGroup -GroupName "TestGroup" -DisplayName "New Display Name" +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/TestGroup +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroup +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +DisplayName : New Display Name +UpdatedTime : 2/1/2018 12:03:37 PM +UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9 +ParentId : /providers/Microsoft.Management/managementGroups/6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +ParentName : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +ParentDisplayName : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +``` + +### Example 2: Update a Management Group's Parent +```powershell +Update-AzManagementGroup -GroupName "TestGroup" -ParentId "/providers/Microsoft.Management/managementGroups/TestGroupParent" +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/TestGroup +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroup +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +DisplayName : TestGroup +UpdatedTime : 2/1/2018 12:03:37 PM +UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9 +ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent +ParentName : TestGroupParent +ParentDisplayName : TestGroupParent +``` + +### Example 3: Update a Management Group by piping PSManagementGroup Object +```powershell +Get-AzManagementGroup -GroupName "TestGroup" | Update-AzManagementGroup -DisplayName "TestDisplayName" -ParentId "/providers/Microsoft.Management/managementGroups/TestGroupParent" +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/TestGroup +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroup +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +DisplayName : TestDisplayName +UpdatedTime : 2/1/2018 12:03:37 PM +UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9 +ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent +ParentName : TestGroupParent +ParentDisplayName : TestGroupParent +``` + +### Example 4: Update a Management Group's parent using the ParentObject +```powershell +$parentObject = Get-AzManagementGroup -GroupName "TestGroupParent" +Update-AzManagementGroup -GroupName "TestGroup" -ParentObject $parentObject +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/TestGroup +Type : /providers/Microsoft.Management/managementGroups +Name : TestGroup +TenantId : 14307de0-5e6f-46cf-b2ba-64a062964d30 +DisplayName : TestGroupDisplayName +UpdatedTime : 2/1/2018 11:16:12 AM +UpdatedBy : 14307de0-5e6f-46cf-b2ba-64a062964d30 +ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent +ParentName : TestGroupParent +ParentDisplayName : TestGroupParent +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display Name of the management group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Management Group Id + +```yaml +Type: System.String +Parameter Sets: GroupOperations, ParentGroupObject +Aliases: GroupId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object from the Get call + +```yaml +Type: Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup +Parameter Sets: ParentAndManagementGroupObject, ManagementGroupObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentId +Parent Id of the management group + +```yaml +Type: System.String +Parameter Sets: GroupOperations, ManagementGroupObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Input Object from the Get call + +```yaml +Type: Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup +Parameter Sets: ParentAndManagementGroupObject, ParentGroupObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Update-AzManagementGroupHierarchySetting.md b/azps-10.1.0/Az.Resources/Update-AzManagementGroupHierarchySetting.md new file mode 100644 index 0000000000..54f585dcea --- /dev/null +++ b/azps-10.1.0/Az.Resources/Update-AzManagementGroupHierarchySetting.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Resources.dll-Help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/update-azmanagementgrouphierarchysetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzManagementGroupHierarchySetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzManagementGroupHierarchySetting.md +--- + +# Update-AzManagementGroupHierarchySetting + +## SYNOPSIS +Updates Hierarchy Settings under the current tenant + +## SYNTAX + +### GroupOperations (Default) +``` +Update-AzManagementGroupHierarchySetting [-GroupName] <String> [-Authorization <Boolean>] + [-DefaultManagementGroup <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ParentGroupObject +``` +Update-AzManagementGroupHierarchySetting [-GroupName] <String> [-Authorization <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Update-AzManagementGroupHierarchySetting cmdlet updates the hierarchy settings under the current tenant. Requiring **Authorization** and setting the **DefaultManagementGroup** that new groups get created under can be updated. + +## EXAMPLES + +### Example 1: Update the Hierarchy Setting for Authorization Requirement for Group Creation +```powershell +Update-AzManagementGroupHierarchySetting -GroupName c7a87cda-9a66-4920-b0f8-869baa04efe0 -Authorization True +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/c7a87cda-9a66-4920-b0f8-869baa04efe0/settings/default +Type : Microsoft.Management/managementGroups/settings +Name : default +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +RequireAuthorizationForGroupCreation : true +DefaultManagementGroup : +``` + +### Example 2: Update the Hierarchy Setting that the default Management Group new Groups get placed under +```powershell +Update-AzManagementGroupHierarchySetting -GroupName c7a87cda-9a66-4920-b0f8-869baa04efe0 -DefaultManagementGroup TestGroup +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/c7a87cda-9a66-4920-b0f8-869baa04efe0/settings/default +Type : Microsoft.Management/managementGroups/settings +Name : default +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +RequireAuthorizationForGroupCreation : false +DefaultManagementGroup : TestGroup +``` + +### Example 3: Create both Hierarchy Settings +```powershell +Update-AzManagementGroupHierarchySetting -GroupName c7a87cda-9a66-4920-b0f8-869baa04efe0 -Authorization True -DefaultManagementGroup TestGroup +``` + +```output +Id : /providers/Microsoft.Management/managementGroups/c7a87cda-9a66-4920-b0f8-869baa04efe0/settings/default +Type : Microsoft.Management/managementGroups/settings +Name : default +TenantId : 6b2064b9-34bd-46e6-9092-52f2dd5f7fc0 +RequireAuthorizationForGroupCreation : true +DefaultManagementGroup : TestGroup +``` + +## PARAMETERS + +### -Authorization +Indicate whether RBAC access is required upon group creation under the root Management Group. True means user will require Microsoft.Management/managementGroups/write action on the root Management Group. Default setting is false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: RequireAuthorizationForGroupCreation + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultManagementGroup +Expand the output to list the children of the management group + +```yaml +Type: System.String +Parameter Sets: GroupOperations +Aliases: DefaultMG + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Management Group Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSHierarchySettings + +### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSHierarchySettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Update-AzRoleManagementPolicy.md b/azps-10.1.0/Az.Resources/Update-AzRoleManagementPolicy.md new file mode 100644 index 0000000000..ac1fd6ed02 --- /dev/null +++ b/azps-10.1.0/Az.Resources/Update-AzRoleManagementPolicy.md @@ -0,0 +1,303 @@ +--- +external help file: Az.Resources-help.xml +Module Name: Az.Resources +online version: https://learn.microsoft.com/powershell/module/az.resources/update-azrolemanagementpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzRoleManagementPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzRoleManagementPolicy.md +--- + +# Update-AzRoleManagementPolicy + +## SYNOPSIS +Update a role management policy + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzRoleManagementPolicy -Name <String> -Scope <String> [-Description <String>] [-DisplayName <String>] + [-IsOrganizationDefault] [-Rule <IRoleManagementPolicyRule[]>] [-DefaultProfile <PSObject>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzRoleManagementPolicy -InputObject <IAuthorizationIdentity> [-Description <String>] + [-DisplayName <String>] [-IsOrganizationDefault] [-Rule <IRoleManagementPolicyRule[]>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update a role management policy + +## EXAMPLES + +### Example 1: Update expiration rule of a policy +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +$expirationRule = [RoleManagementPolicyExpirationRule]@{ + isExpirationRequired = "false"; + maximumDuration = "P180D"; + id = "Expiration_Admin_Eligibility"; + ruleType = [RoleManagementPolicyRuleType]("RoleManagementPolicyExpirationRule"); + targetCaller = "Admin"; + targetOperation = @('All'); + targetLevel = "Eligibility"; + targetObject = $null; + targetInheritableSetting = $null; + targetEnforcedSetting = $null; + } +$rules = [IRoleManagementPolicyRule[]]@($expirationRule) +Update-AzRoleManagementPolicy -Scope $scope -Name "33b520ea-3544-4abc-8565-3588deb8e68e" -Rule $rules +``` + +```output +Name Type Scope +---- ---- ----- +33b520ea-3544-4abc-8565-3588deb8e68e Microsoft.Authorization/roleManagementPolicies /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +``` + +Each individual `Rule` on a policy can be update independently. + +### Example 2: Update expiration rule and a notification rule of a policy +```powershell +$scope = "/subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d/" +$expirationRule = [RoleManagementPolicyExpirationRule]@{ + isExpirationRequired = "false"; + maximumDuration = "P180D"; + id = "Expiration_Admin_Eligibility"; + ruleType = [RoleManagementPolicyRuleType]("RoleManagementPolicyExpirationRule"); + targetCaller = "Admin"; + targetOperation = @('All'); + targetLevel = "Eligibility"; + targetObject = $null; + targetInheritableSetting = $null; + targetEnforcedSetting = $null; + } +$notificationRule = [RoleManagementPolicyNotificationRule]@{ + notificationType = "Email"; + recipientType = "Approver"; + isDefaultRecipientsEnabled = "false"; + notificationLevel = "Critical"; + notificationRecipient = $null; + id = "Notification_Approver_Admin_Eligibility"; + ruleType = [RoleManagementPolicyRuleType]("RoleManagementPolicyNotificationRule"); + targetCaller = "Admin"; + targetOperation = @('All'); + targetLevel = "Eligibility"; + targetObject = $null; + targetInheritableSetting = $null; + targetEnforcedSetting = $null; + } +$rules = [IRoleManagementPolicyRule[]]@($expirationRule, $notificationRule) +Update-AzRoleManagementPolicy -Scope $scope -Name "33b520ea-3544-4abc-8565-3588deb8e68e" -Rule $rules +``` + +```output +Name Type Scope +---- ---- ----- +33b520ea-3544-4abc-8565-3588deb8e68e Microsoft.Authorization/roleManagementPolicies /subscriptions/38ab2ccc-3747-4567-b36b-9478f5602f0d +``` + +Multiple `Rule` can be updated together. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The role management policy description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The role management policy display name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsOrganizationDefault +The role management policy is default policy. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name (guid) of the role management policy to upsert. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: RoleManagementPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +The rule applied to the policy. +To construct, see NOTES section for RULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IRoleManagementPolicyRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +The scope of the role management policy to upsert. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.IAuthorizationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Resources.Authorization.Models.Api20201001Preview.IRoleManagementPolicy + +## 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 <IAuthorizationIdentity>`: Identity Parameter + - `[Id <String>]`: Resource identity path + - `[RoleAssignmentScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role assignment schedule to get. + - `[RoleAssignmentScheduleName <String>]`: The name (guid) of the role assignment schedule to get. + - `[RoleAssignmentScheduleRequestName <String>]`: The name of the role assignment to create. It can be any valid GUID. + - `[RoleEligibilityScheduleInstanceName <String>]`: The name (hash of schedule name + time) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleName <String>]`: The name (guid) of the role eligibility schedule to get. + - `[RoleEligibilityScheduleRequestName <String>]`: The name of the role eligibility to create. It can be any valid GUID. + - `[RoleManagementPolicyAssignmentName <String>]`: The name of format {guid_guid} the role management policy assignment to get. + - `[RoleManagementPolicyName <String>]`: The name (guid) of the role management policy to get. + - `[Scope <String>]`: The scope of the role management policy. + +`RULE <IRoleManagementPolicyRule[]>`: The rule applied to the policy. + - `RuleType <RoleManagementPolicyRuleType>`: The type of rule + - `[Id <String>]`: The id of the rule. + - `[TargetCaller <String>]`: The caller of the setting. + - `[TargetEnforcedSetting <String[]>]`: The list of enforced settings. + - `[TargetInheritableSetting <String[]>]`: The list of inheritable settings. + - `[TargetLevel <String>]`: The assignment level to which it is applied. + - `[TargetObject <String[]>]`: The list of target objects. + - `[TargetOperation <String[]>]`: The type of operation. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Resources/Update-AzTag.md b/azps-10.1.0/Az.Resources/Update-AzTag.md new file mode 100644 index 0000000000..26be9d140b --- /dev/null +++ b/azps-10.1.0/Az.Resources/Update-AzTag.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Tags.dll-Help.xml +Module Name: Az.Resources +ms.assetid: 07c6e327-05f4-4279-a5fb-d4e860c897d4 +online version: https://learn.microsoft.com/powershell/module/az.resources/update-aztag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Resources/Resources/help/Update-AzTag.md +--- + +# Update-AzTag + +## SYNOPSIS + +Selectively updates the set of tags on a resource or subscription. + +## SYNTAX + +``` +Update-AzTag [-ResourceId] <String> [-Tag] <Hashtable> [-Operation] <TagPatchOperation> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The **Update-AzTag** cmdlet with a **ResourceId** selectively updates the set of tags on a resource or subscription. +This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs. + +## EXAMPLES + +### Example 1: Selectively updates the set of tags on a subscription with "Merge" Operation + +```powershell +$mergedTags = @{"key1"="value1"; "key3"="value3";} +Update-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tag $mergedTags -Operation Merge +``` + +```output +Id : {Id} +Name : {Name} +Type : {Type} +Properties : + Name Value + ======= ========= + key1 value1 + key2 value2 + key3 value3 +``` + +This command Merges the set of tags on the subscription with "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx". + +### Example 2: Selectively updates the set of tags on a subscription with "Replace" Operation + +```powershell +$replacedTags = @{"key1"="value1"; "key3"="value3";} +Update-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tag $replacedTags -Operation Replace +``` + +```output +Id : {Id} +Name : {Name} +Type : {Type} +Properties : + Name Value + ======= ========= + key1 value1 + key3 value3 +``` + +This command Replaces the set of tags on the subscription with "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx". + +### Example 3: Selectively updates the set of tags on a subscription with "Delete" Operation + +```powershell +$deletedTags = @{"key1"="value1"} +Update-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tag $deletedTags -Operation Delete +``` + +```output +Id : {Id} +Name : {Name} +Type : {Type} +Properties : + Name Value + ======= ========= + key3 value3 +``` + +This command Deletes the set of tags on the subscription with "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operation +The update operation. Options are Merge, Replace and Delete. + +```yaml +Type: Microsoft.Azure.Commands.Tags.Model.TagPatchOperation +Parameter Sets: (All) +Aliases: +Accepted values: Merge, Replace, Delete + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier for the tagged entity. A resource, a resource group or a subscription may be tagged. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The set of tags to use for update. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Tags.Model.TagPatchOperation + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Tags.Model.PSTagResource + +## NOTES + +## RELATED LINKS + +[Get-AzTag](./Get-AzTag.md) + +[New-AzTag](./New-AzTag.md) + +[Remove-AzTag](./Remove-AzTag.md) diff --git a/azps-10.1.0/Az.Search/Az.Search.md b/azps-10.1.0/Az.Search/Az.Search.md new file mode 100644 index 0000000000..0e384c3539 --- /dev/null +++ b/azps-10.1.0/Az.Search/Az.Search.md @@ -0,0 +1,66 @@ +--- +Module Name: Az.Search +Module Guid: a2bb88dc-abd2-4275-9aae-bd98346f8c8a +Download Help Link: https://learn.microsoft.com/powershell/module/az.search +Help Version: 0.1.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Az.Search.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Az.Search.md +--- + +# Az.Search Module +## Description +This topic displays help topics for the Azure Cognitive Search Cmdlets. + +## Az.Search Cmdlets +### [Get-AzSearchAdminKeyPair](Get-AzSearchAdminKeyPair.md) +Gets admin key pair of the Azure Cognitive Search service. + +### [Get-AzSearchPrivateEndpointConnection](Get-AzSearchPrivateEndpointConnection.md) +Gets private endpoint connection(s) to the Azure Cognitive Search service. + +### [Get-AzSearchPrivateLinkResource](Get-AzSearchPrivateLinkResource.md) +Gets private link resource details for the Azure Cognitive Search service. + +### [Get-AzSearchQueryKey](Get-AzSearchQueryKey.md) +Gets query key(s) of the Azure Cognitive Search service. + +### [Get-AzSearchService](Get-AzSearchService.md) +Gets an Azure Cognitive Search service. + +### [Get-AzSearchSharedPrivateLinkResource](Get-AzSearchSharedPrivateLinkResource.md) +Gets shared private link resources(s) of the Azure Cognitive Search service. + +### [New-AzSearchAdminKey](New-AzSearchAdminKey.md) +Regenerates an admin key of the Azure Cognitive Search service. + +### [New-AzSearchQueryKey](New-AzSearchQueryKey.md) +Create a new query key for the Azure Cognitive Search service. + +### [New-AzSearchService](New-AzSearchService.md) +Creates an Azure Cognitive Search service. + +### [New-AzSearchSharedPrivateLinkResource](New-AzSearchSharedPrivateLinkResource.md) +Creates a shared private link resource for the Azure Cognitive Search service. + +### [Remove-AzSearchPrivateEndpointConnection](Remove-AzSearchPrivateEndpointConnection.md) +Remove the private endpoint connection from the Azure Cognitive Search service. + +### [Remove-AzSearchQueryKey](Remove-AzSearchQueryKey.md) +Remove the query key from the Azure Cognitive Search service. + +### [Remove-AzSearchService](Remove-AzSearchService.md) +Remove an Azure Cognitive Search service. + +### [Remove-AzSearchSharedPrivateLinkResource](Remove-AzSearchSharedPrivateLinkResource.md) +Remove the shared private link resource from the Azure Cognitive Search service. + +### [Set-AzSearchPrivateEndpointConnection](Set-AzSearchPrivateEndpointConnection.md) +Update the private endpoint connection to the Azure Cognitive Search service. + +### [Set-AzSearchService](Set-AzSearchService.md) +Update an Azure Cognitive Search service. + +### [Set-AzSearchSharedPrivateLinkResource](Set-AzSearchSharedPrivateLinkResource.md) +Update the shared private link resource for the Azure Cognitive Search service. + diff --git a/azps-10.1.0/Az.Search/Get-AzSearchAdminKeyPair.md b/azps-10.1.0/Az.Search/Get-AzSearchAdminKeyPair.md new file mode 100644 index 0000000000..5f5b3c5853 --- /dev/null +++ b/azps-10.1.0/Az.Search/Get-AzSearchAdminKeyPair.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/get-azsearchadminkeypair +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Get-AzSearchAdminKeyPair.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Get-AzSearchAdminKeyPair.md +--- + +# Get-AzSearchAdminKeyPair + +## SYNOPSIS +Gets admin key pair of the Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Get-AzSearchAdminKeyPair [-ResourceGroupName] <String> [-ServiceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ParentObjectParameterSet +``` +Get-AzSearchAdminKeyPair [-ParentObject] <PSSearchService> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ParentResourceIdParameterSet +``` +Get-AzSearchAdminKeyPair [-ParentResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSearchAdminKeyPair** cmdlet gets the admin key pair of the Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSearchAdminKeyPair -ResourceGroupName felixwa-01 -ServiceName felixwa-basic-search +``` + +```output +Primary Secondary +------- --------- +3B06A25BDADFF72EC132736BAA2547A1 E643B75A52E04DF13EB690807C451C55 +``` + +The example gets admin key pair of the Azure Cognitive Search service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Azure Cognitive Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +Azure Cognitive Search Service Resource Id. + +```yaml +Type: System.String +Parameter Sets: ParentResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchAdminKey + +## NOTES + +## RELATED LINKS + +[New-AzSearchAdminKey](./New-AzSearchAdminKey.md) diff --git a/azps-10.1.0/Az.Search/Get-AzSearchPrivateEndpointConnection.md b/azps-10.1.0/Az.Search/Get-AzSearchPrivateEndpointConnection.md new file mode 100644 index 0000000000..b2044fb2bc --- /dev/null +++ b/azps-10.1.0/Az.Search/Get-AzSearchPrivateEndpointConnection.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/get-azsearchprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Get-AzSearchPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Get-AzSearchPrivateEndpointConnection.md +--- + +# Get-AzSearchPrivateEndpointConnection + +## SYNOPSIS +Gets private endpoint connection(s) to the Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Get-AzSearchPrivateEndpointConnection [-ResourceGroupName] <String> [-ServiceName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentObjectParameterSet +``` +Get-AzSearchPrivateEndpointConnection [-ParentObject] <PSSearchService> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzSearchPrivateEndpointConnection [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSearchPrivateEndpointConnection** cmdlet gets the private endpoint connection(s) to the Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSearchPrivateEndpointConnection -ResourceGroupName arjagann -ServiceName arjagann-test-cuseuap +``` + +```output +Name Id +---- -- +arjagann-test-cuseuap-pe.4c74dd7c-7016-42ac-827a-8d5d1378f266 /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann/providers/Microsoft.Search/searchServices/arjagann-test-cuseuap/privateEndpointConnections/arjagann-test-cuseuap-pe.4c74dd7c-7016-42ac-827a-8d5d1378f266 +``` + +The example gets all the private endpoint connections to the Azure Cognitive Search service. + +### Example 2 +```powershell +Get-AzSearchPrivateEndpointConnection -ResourceGroupName arjagann -ServiceName arjagann-test-cuseuap -Name arjagann-test-cuseuap-pe.4c74dd7c-7016-42ac-827a-8d5d1378f266 | ConvertTo-Json +``` + +```output +{ + "Name": "arjagann-test-cuseuap-pe.4c74dd7c-7016-42ac-827a-8d5d1378f266", + "Id": "/subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann/providers/Microsoft.Search/searchServices/arjagann-test-cuseuap/privateEndpointConnections/arjagann-test-cuseuap-pe.4c74dd7c-7016-42ac-827a-8d5d1378f266", + "PrivateEndpoint": { + "Id": "/subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann2/providers/Microsoft.Network/privateEndpoints/arjagann-test-cuseuap-pe" + }, + "PrivateLinkServiceConnectionState": { + "Status": 1, + "Description": "Auto-approved", + "ActionsRequired": "None" + } +} +``` + +The example gets a specific private endpoint connection by name (converted to JSON for ease of reading) to the Azure Cognitive Search service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure Cognitive Search Service private endpoint connection name + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet, ParentObjectParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Azure Cognitive Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Private link service resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSPrivateEndpointConnection + +## NOTES + +## RELATED LINKS + +[Remove-AzSearchPrivateEndpointConnection.md](./Remove-AzSearchPrivateEndpointConnection.md) + +[Set-AzSearchPrivateEndpointConnection.md](./Set-AzSearchPrivateEndpointConnection.md) diff --git a/azps-10.1.0/Az.Search/Get-AzSearchPrivateLinkResource.md b/azps-10.1.0/Az.Search/Get-AzSearchPrivateLinkResource.md new file mode 100644 index 0000000000..c4e16371b0 --- /dev/null +++ b/azps-10.1.0/Az.Search/Get-AzSearchPrivateLinkResource.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/get-AzSearchPrivateLinkResource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Get-AzSearchPrivateLinkResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Get-AzSearchPrivateLinkResource.md +--- + +# Get-AzSearchPrivateLinkResource + +## SYNOPSIS +Gets private link resource details for the Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Get-AzSearchPrivateLinkResource [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzSearchPrivateLinkResource [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Get-AzSearchPrivateLinkResource [-InputObject] <PSSearchService> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSearchPrivateLinkResource** cmdlet gets private link resource details for the Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSearchPrivateLinkResource -ResourceGroupName arjagann -Name arjagann-test-cuseuap | ConvertTo-Json +``` + +```output +"Id": "/subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann/providers/Microsoft.Search/searchServices/arjagann-test-cuseuap/privateLinkResources/searchService", + "Type": "Microsoft.Search/searchServices/privateLinkResources", + "GroupId": "searchService", + "RequiredMembers": [ + "searchService" + ], + "RequiredZoneNames": [ + "privatelink.search-dogfood.windows-int.net" + ], + "ShareablePrivateLinkResourceTypes": [ + { + "Name": "blob", + "Description": "Azure Cognitive Search indexers can connect to blobs in Azure Storage for reading data (data source), for writing intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)", + "Type": "Microsoft.Storage/storageAccounts", + "GroupId": "blob" + }, + { + "Name": "table", + "Description": "Azure Cognitive Search indexers can connect to tables in Azure Storage for reading data (data source), for writing book-keeping information about intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)", + "Type": "Microsoft.Storage/storageAccounts", + "GroupId": "table" + }, + { + "Name": "Sql", + "Description": "Azure Cognitive Search indexers can connect to CosmosDB using the SQL head for reading data (data source).", + "Type": "Microsoft.DocumentDB/databaseAccounts", + "GroupId": "Sql" + }, + { + "Name": "plr", + "Description": "Azure Cognitive Search indexers can connect to AzureSQL databases in a SQL server for reading data (data source).", + "Type": "Microsoft.Sql/servers", + "GroupId": "sqlServer" + }, + { + "Name": "vault", + "Description": "Azure Cognitive Search can access keys in Azure Key Vault to encrypt search index and synonym map data", + "Type": "Microsoft.KeyVault/vaults", + "GroupId": "vault" + } + ] +} +``` + +The example shows how to get the private link resource details (in JSON form for convenience) for the Azure Cognitive Search service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure Cognitive Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure Cognitive Search Service Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSharedPrivateLinkResource + +## NOTES + +## RELATED LINKS + +[New-AzSearchSharedPrivateLinkResource.md](./New-AzSearchSharedPrivateLinkResource.md) + +[Get-AzSearchSharedPrivateLinkResource.md](./Get-AzSearchSharedPrivateLinkResource.md) + +[Remove-AzSearchSharedPrivateLinkResource.md](./Remove-AzSearchSharedPrivateLinkResource.md) + +[Set-AzSearchSharedPrivateLinkResource.md](./Set-AzSearchSharedPrivateLinkResource.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Search/Get-AzSearchQueryKey.md b/azps-10.1.0/Az.Search/Get-AzSearchQueryKey.md new file mode 100644 index 0000000000..5bad644afd --- /dev/null +++ b/azps-10.1.0/Az.Search/Get-AzSearchQueryKey.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/get-azsearchquerykey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Get-AzSearchQueryKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Get-AzSearchQueryKey.md +--- + +# Get-AzSearchQueryKey + +## SYNOPSIS +Gets query key(s) of the Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Get-AzSearchQueryKey [-ResourceGroupName] <String> [-ServiceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ParentObjectParameterSet +``` +Get-AzSearchQueryKey [-ParentObject] <PSSearchService> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ParentResourceIdParameterSet +``` +Get-AzSearchQueryKey [-ParentResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSearchQueryKey** cmdlet gets query key(s) of the Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSearchQueryKey -ResourceGroupName "TestAzureSearchPsGroup" -ServiceName "pstestazuresearch01" +``` + +```output +Name Key +---- --- + 896AA09C167541072D404E1BE0442CE9 +``` + +The example gets all query key(s) of the Azure Cognitive Search service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Azure Cognitive Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +Azure Cognitive Search Service Resource Id. + +```yaml +Type: System.String +Parameter Sets: ParentResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchQueryKey + +## NOTES + +## RELATED LINKS + +[New-AzSearchQueryKey.md](./New-AzSearchQueryKey.md) + +[Remove-AzSearchQueryKey.md](./Remove-AzSearchQueryKey.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Search/Get-AzSearchService.md b/azps-10.1.0/Az.Search/Get-AzSearchService.md new file mode 100644 index 0000000000..60d11decbc --- /dev/null +++ b/azps-10.1.0/Az.Search/Get-AzSearchService.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/get-azsearchservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Get-AzSearchService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Get-AzSearchService.md +--- + +# Get-AzSearchService + +## SYNOPSIS +Gets an Azure Cognitive Search service. + +## SYNTAX + +### ResourceGroupParameterSet (Default) +``` +Get-AzSearchService [-ResourceGroupName] <String> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzSearchService [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSearchService** cmdlet gets the specified Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSearchService -ResourceGroupName felixwa-01 +``` + +```output +ResourceGroupName : felixwa-01 +Name : felixwa-basic-search +Location : West US +Sku : Basic +ReplicaCount : 1 +PartitionCount : 1 +HostingMode : Default +Id : /subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/felixwa-01/providers/Microsoft.Search/searchServices/felixwa-basic-search +``` + +Get an Azure Cognitive Search service with specified parameters. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure Cognitive Search Service Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService + +## NOTES + +## RELATED LINKS + +[New-AzSearchService](./New-AzSearchService.md) + +[Set-AzSearchService](./Set-AzSearchService.md) + +[Remove-AzSearchService](./Remove-AzSearchService.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Search/Get-AzSearchSharedPrivateLinkResource.md b/azps-10.1.0/Az.Search/Get-AzSearchSharedPrivateLinkResource.md new file mode 100644 index 0000000000..87df70ed62 --- /dev/null +++ b/azps-10.1.0/Az.Search/Get-AzSearchSharedPrivateLinkResource.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/get-azsearchsharedprivatelinkresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Get-AzSearchSharedPrivateLinkResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Get-AzSearchSharedPrivateLinkResource.md +--- + +# Get-AzSearchSharedPrivateLinkResource + +## SYNOPSIS +Gets shared private link resources(s) of the Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Get-AzSearchSharedPrivateLinkResource [-ResourceGroupName] <String> [-ServiceName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentObjectParameterSet +``` +Get-AzSearchSharedPrivateLinkResource [-ParentObject] <PSSearchService> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzSearchSharedPrivateLinkResource [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSearchSharedPrivateLinkResource** cmdlet gets shared private link resources(s) of the Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSearchSharedPrivateLinkResource -ResourceGroupName arjagann -ServiceName arjagann-test-cuseuap +``` + +```output +Id : /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann/providers/Microsoft.Search/searchServices/arjagann-test-cuseuap/sharedPrivateLinkResources/table-pe +Type : Microsoft.Search/searchServices/sharedPrivateLinkResources +Status : Pending +Name : table-pe +GroupId : table +PrivateLinkResourceId : /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourcegroups/PETesting/providers/Microsoft.Storage/storageAccounts/petesting +ProvisioningState : Succeeded +RequestMessage : please approve +ResourceRegion : + +Id : /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann/providers/Microsoft.Search/searchServices/arjagann-test-cuseuap/sharedPrivateLinkResources/cosmos-pe +Type : Microsoft.Search/searchServices/sharedPrivateLinkResources +Status : Pending +Name : cosmos-pe +GroupId : Sql +PrivateLinkResourceId : /subscriptions/dc95d1b6-71a8-4dff-bcc9-a1c282bdbd8b/resourceGroups/arjagann/providers/Microsoft.DocumentDb/databaseAccounts/arjagann-sql +ProvisioningState : Succeeded +RequestMessage : please approve +ResourceRegion : + +Id : /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann/providers/Microsoft.Search/searchServices/arjagann-test-cuseuap/sharedPrivateLinkResources/blob-pe2 +Type : Microsoft.Search/searchServices/sharedPrivateLinkResources +Status : Pending +Name : blob-pe2 +GroupId : blob +PrivateLinkResourceId : /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourcegroups/PETesting/providers/Microsoft.Storage/storageAccounts/petesting2 +ProvisioningState : Succeeded +RequestMessage : please approve +ResourceRegion : +``` + +This example lists all the shared private link resources of the Azure Cognitive Search service. + +### Example 2 +```powershell +Get-AzSearchSharedPrivateLinkResource -ResourceGroupName arjagann -ServiceName arjagann-test-cuseuap -Name table-pe +``` + +```output +Id : /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann/providers/Microsoft.Search/searchServices/arjagann-test-cuseuap/sharedPrivateLinkResources/table-pe +Type : Microsoft.Search/searchServices/sharedPrivateLinkResources +Status : Pending +Name : table-pe +GroupId : table +PrivateLinkResourceId : /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourcegroups/PETesting/providers/Microsoft.Storage/storageAccounts/petesting +ProvisioningState : Succeeded +RequestMessage : please approve +ResourceRegion : +``` + +This example lists a specific shared private link resource by name of the Azure Cognitive Search service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure Cognitive Search Shared private link resource + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet, ParentObjectParameterSet +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Azure Cognitive Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Shared private link resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSharedPrivateLinkResource + +## NOTES + +## RELATED LINKS + +[New-AzSearchSharedPrivateLinkResource.md](./New-AzSearchSharedPrivateLinkResource.md) + +[Remove-AzSearchSharedPrivateLinkResource.md](./Remove-AzSearchSharedPrivateLinkResource.md) + +[Set-AzSearchSharedPrivateLinkResource.md](./Set-AzSearchSharedPrivateLinkResource.md) diff --git a/azps-10.1.0/Az.Search/New-AzSearchAdminKey.md b/azps-10.1.0/Az.Search/New-AzSearchAdminKey.md new file mode 100644 index 0000000000..aac2c608e5 --- /dev/null +++ b/azps-10.1.0/Az.Search/New-AzSearchAdminKey.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/new-azsearchadminkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/New-AzSearchAdminKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/New-AzSearchAdminKey.md +--- + +# New-AzSearchAdminKey + +## SYNOPSIS +Regenerates an admin key of the Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +New-AzSearchAdminKey [-ResourceGroupName] <String> [-ServiceName] <String> -KeyKind <PSSearchAdminKeyKind> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentObjectParameterSet +``` +New-AzSearchAdminKey [-ParentObject] <PSSearchService> -KeyKind <PSSearchAdminKeyKind> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentResourceIdParameterSet +``` +New-AzSearchAdminKey [-ParentResourceId] <String> -KeyKind <PSSearchAdminKeyKind> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSearchAdminKey** cmdlet regenerates an admin key of the Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSearchAdminKey -ResourceGroupName "TestAzureSearchPsGroup" -ServiceName "pstestazuresearch01" -KeyKind Primary +``` + +```output +Confirm +Are you sure you want to regenerate 'Primary' key for Search Service 'pstestazuresearch01'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y + +Primary Secondary +------- --------- +85B3813D11904B591BE8A196C2C743A1 CEF791D5BAC2E6C0B232C56702F21E87 +``` + +The example regenerates Primary key of the Azure Cognitive Search service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyKind +Azure Cognitive Search Service admin key kind (Primary/Secondary). + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchAdminKeyKind +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Azure Cognitive Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +Azure Cognitive Search Service Resource Id. + +```yaml +Type: System.String +Parameter Sets: ParentResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchAdminKey + +## NOTES + +## RELATED LINKS + +[Get-AzSearchAdminKeyPair](./Get-AzSearchAdminKeyPair.md) diff --git a/azps-10.1.0/Az.Search/New-AzSearchQueryKey.md b/azps-10.1.0/Az.Search/New-AzSearchQueryKey.md new file mode 100644 index 0000000000..b09ff6dc0c --- /dev/null +++ b/azps-10.1.0/Az.Search/New-AzSearchQueryKey.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/new-azsearchquerykey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/New-AzSearchQueryKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/New-AzSearchQueryKey.md +--- + +# New-AzSearchQueryKey + +## SYNOPSIS +Create a new query key for the Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +New-AzSearchQueryKey [-ResourceGroupName] <String> [-ServiceName] <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentObjectParameterSet +``` +New-AzSearchQueryKey [-ParentObject] <PSSearchService> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentResourceIdParameterSet +``` +New-AzSearchQueryKey [-ParentResourceId] <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSearchQueryKey** cmdlet creates a new query key for the Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSearchQueryKey -ResourceGroupName "TestAzureSearchPsGroup" -ServiceName "pstestazuresearch01" -Name "NewQueryKey1" +``` + +```output +Name Key +---- --- +NewQueryKey1 65FBCF561228C5F0E01F8F2114C80459 +``` + +The example creates a new query key for the Azure Cognitive Search service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure Cognitive Search Service query key name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Azure Cognitive Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +Azure Cognitive Search Service Resource Id. + +```yaml +Type: System.String +Parameter Sets: ParentResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchQueryKey + +## NOTES + +## RELATED LINKS + +[Get-AzSearchQueryKey.md](./Get-AzSearchQueryKey.md) + +[Remove-AzSearchQueryKey.md](./Remove-AzSearchQueryKey.md) diff --git a/azps-10.1.0/Az.Search/New-AzSearchService.md b/azps-10.1.0/Az.Search/New-AzSearchService.md new file mode 100644 index 0000000000..dec185e000 --- /dev/null +++ b/azps-10.1.0/Az.Search/New-AzSearchService.md @@ -0,0 +1,316 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/new-azsearchservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/New-AzSearchService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/New-AzSearchService.md +--- + +# New-AzSearchService + +## SYNOPSIS +Creates an Azure Cognitive Search service. + +## SYNTAX + +``` +New-AzSearchService [-ResourceGroupName] <String> [-Name] <String> [-Sku] <PSSkuName> [-Location] <String> + [-PartitionCount <Int32>] [-ReplicaCount <Int32>] [-HostingMode <PSHostingMode>] + [-PublicNetworkAccess <PSPublicNetworkAccess>] [-IdentityType <PSIdentityType>] [-IPRuleList <PSIpRule[]>] + [-DisableLocalAuth <Boolean>] [-AuthOption <PSAuthOptionName>] [-AadAuthFailureMode <PSAadAuthFailureMode>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSearchService** cmdlet creates an Azure Cognitive Search service with specified parameters. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSearchService -ResourceGroupName "TestAzureSearchPsGroup" -Name "pstestazuresearch01" -Sku "Standard" -Location "West US" -PartitionCount 1 -ReplicaCount 1 -HostingMode Default +``` + +```output +ResourceGroupName : TestAzureSearchPsGroup +Name : pstestazuresearch01 +Id : /subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/TestAzureSearchPsGroup/providers/Microsoft.Search/searchServices/pstestazuresearch01 +Location : West US +Sku : Standard +ReplicaCount : 1 +PartitionCount : 1 +HostingMode : Default +Tags : +``` + +The command creates an Azure Cognitive Search service. + +## PARAMETERS + +### -AadAuthFailureMode +(Optional) What status code to return when failing AAD authentication, if both api key and AAD authenticaiton are allowed for the Azure Cognitive Search service + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Management.Search.Models.PSAadAuthFailureMode] +Parameter Sets: (All) +Aliases: +Accepted values: Http403, Http401WithBearerChallenge + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthOption +(Optional) Whether to only allow API key authentication or both API key authentication and AAD authentication for the Azure Cognitive Search service + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Management.Search.Models.PSAuthOptionName] +Parameter Sets: (All) +Aliases: +Accepted values: ApiKeyOnly, AadOrApiKey + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +(Optional) Disable API key authentication for the Azure Cognitive Search service (true/false/null) + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostingMode +Azure Cognitive Search Service hosting mode. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Management.Search.Models.PSHostingMode] +Parameter Sets: (All) +Aliases: +Accepted values: Default, HighDensity + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +(Optional) Azure Cognitive Search Service Identity (None/SystemAssigned) + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Management.Search.Models.PSIdentityType] +Parameter Sets: (All) +Aliases: +Accepted values: None, SystemAssigned + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPRuleList +(Optional) Azure Cognitive Search Service IP rules + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSIpRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Azure Cognitive Search Service location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionCount +Azure Cognitive Search Service partition count. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +(Optional) Azure Cognitive Search Service public network access (Enabled/Disabled) + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Management.Search.Models.PSPublicNetworkAccess] +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaCount +Azure Cognitive Search Service replica count. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +Azure Cognitive Search Service Sku. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSkuName +Parameter Sets: (All) +Aliases: +Accepted values: Free, Basic, Standard, Standard2, Standard3, Storage_Optimized_L1, Storage_Optimized_L2 + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService + +## NOTES + +## RELATED LINKS + +[Get-AzSearchService](./Get-AzSearchService.md) + +[Set-AzSearchService](./Set-AzSearchService.md) + +[Remove-AzSearchService](./Remove-AzSearchService.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Search/New-AzSearchSharedPrivateLinkResource.md b/azps-10.1.0/Az.Search/New-AzSearchSharedPrivateLinkResource.md new file mode 100644 index 0000000000..21205903dd --- /dev/null +++ b/azps-10.1.0/Az.Search/New-AzSearchSharedPrivateLinkResource.md @@ -0,0 +1,234 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/new-azsearchsharedprivatelinkresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/New-AzSearchSharedPrivateLinkResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/New-AzSearchSharedPrivateLinkResource.md +--- + +# New-AzSearchSharedPrivateLinkResource + +## SYNOPSIS +Creates a shared private link resource for the Azure Cognitive Search service. + +## SYNTAX + +``` +New-AzSearchSharedPrivateLinkResource [-ResourceGroupName] <String> [-ServiceName] <String> [-Name] <String> + -PrivateLinkResourceId <String> -GroupId <String> -RequestMessage <String> [-ResourceRegion <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSearchSharedPrivateLinkResource** creates a shared private link resource for the Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSearchSharedPrivateLinkResource -ResourceGroupName arjagann -ServiceName arjagann-test-cuseuap -Name blob-pe -PrivateLinkResourceId /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourcegroups/PETesting/providers/Microsoft.Storage/storageAccounts/petesting -GroupId blob -RequestMessage "Please approve" +``` + +```output +Id : /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann/providers/Microsoft.Search/searchServices/arjagann-test-cuseuap/sharedPrivateLinkResources/blob-pe +Type : Microsoft.Search/searchServices/sharedPrivateLinkResources +Status : Pending +Name : blob-pe +GroupId : blob +PrivateLinkResourceId : /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourcegroups/PETesting/providers/Microsoft.Storage/storageAccounts/petesting +ProvisioningState : Succeeded +RequestMessage : Please approve +ResourceRegion : +``` + +This example creates a shared private link resource to the blob service of a storage account for the Azure Cognitive Search service. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +Shared private link resource group id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure Cognitive Search Shared private link resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkResourceId +Shared private link target resource id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestMessage +Shared private link resource request message + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceRegion +(Optional) Shared private link resource region + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSharedPrivateLinkResource + +## NOTES + +## RELATED LINKS + +[Get-AzSearchSharedPrivateLinkResource.md](./Get-AzSearchSharedPrivateLinkResource.md) + +[Remove-AzSearchSharedPrivateLinkResource.md](./Remove-AzSearchSharedPrivateLinkResource.md) + +[Set-AzSearchSharedPrivateLinkResource.md](./Set-AzSearchSharedPrivateLinkResource.md) diff --git a/azps-10.1.0/Az.Search/Remove-AzSearchPrivateEndpointConnection.md b/azps-10.1.0/Az.Search/Remove-AzSearchPrivateEndpointConnection.md new file mode 100644 index 0000000000..91699b007b --- /dev/null +++ b/azps-10.1.0/Az.Search/Remove-AzSearchPrivateEndpointConnection.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/remove-azsearchprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Remove-AzSearchPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Remove-AzSearchPrivateEndpointConnection.md +--- + +# Remove-AzSearchPrivateEndpointConnection + +## SYNOPSIS +Remove the private endpoint connection from the Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Remove-AzSearchPrivateEndpointConnection [-ResourceGroupName] <String> [-ServiceName] <String> [-Name] <String> + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentObjectParameterSet +``` +Remove-AzSearchPrivateEndpointConnection [-ParentObject] <PSSearchService> [-Name] <String> [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzSearchPrivateEndpointConnection [-InputObject] <PSPrivateEndpointConnection> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzSearchPrivateEndpointConnection [-ResourceId] <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSearchPrivateEndpointConnection** removes the private endpoint connection from the Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSearchPrivateEndpointConnection -ResourceGroupName arjagann -ServiceName arjagann-test-cuseuap -Name arjagann-test-cuseuap-pe.4c74dd7c-7016-42ac-827a-8d5d1378f266 +``` + +This example removes a private endpoint connection from the search service by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Private endpoint connection input object + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSPrivateEndpointConnection +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure Cognitive Search Service private endpoint connection name + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet, ParentObjectParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Azure Cognitive Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Private link service resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzSearchPrivateEndpointConnection.md](./Get-AzSearchPrivateEndpointConnection.md) + +[Set-AzSearchPrivateEndpointConnection.md](./Set-AzSearchPrivateEndpointConnection.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Search/Remove-AzSearchQueryKey.md b/azps-10.1.0/Az.Search/Remove-AzSearchQueryKey.md new file mode 100644 index 0000000000..f444bb6ff4 --- /dev/null +++ b/azps-10.1.0/Az.Search/Remove-AzSearchQueryKey.md @@ -0,0 +1,233 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/remove-azsearchquerykey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Remove-AzSearchQueryKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Remove-AzSearchQueryKey.md +--- + +# Remove-AzSearchQueryKey + +## SYNOPSIS +Remove the query key from the Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Remove-AzSearchQueryKey [-ResourceGroupName] <String> [-ServiceName] <String> -KeyValue <String> [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentObjectParameterSet +``` +Remove-AzSearchQueryKey [-ParentObject] <PSSearchService> -KeyValue <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentResourceIdParameterSet +``` +Remove-AzSearchQueryKey [-ParentResourceId] <String> -KeyValue <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSearchQueryKey** cmdlet removes the query key from the Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +Get-AzSearchQueryKey -ResourceGroupName "TestAzureSearchPsGroup" -ServiceName "pstestazuresearch01" + +Name Key +---- --- + D260F448EA192EBC19D59F7E5670E8BB +NewQueryKey1 B4C13E3F6FA76100D3488673CFDCD438 + +Remove-AzSearchQueryKey -ResourceGroupName "TestAzureSearchPsGroup" -ServiceName "pstestazuresearch01" -KeyValue B4C13E3F6FA76100D3488673CFDCD438 + +Confirm +Are you sure you want to remove query key 'B4C13E3F6FA76100D3488673CFDCD438'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +``` + +The example removes the query key from the Azure Cognitive Search service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyValue +Azure Cognitive Search Service query key value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Azure Cognitive Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +Azure Cognitive Search Service Resource Id. + +```yaml +Type: System.String +Parameter Sets: ParentResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzSearchQueryKey.md](./New-AzSearchQueryKey.md) + +[Get-AzSearchQueryKey.md](./Get-AzSearchQueryKey.md) diff --git a/azps-10.1.0/Az.Search/Remove-AzSearchService.md b/azps-10.1.0/Az.Search/Remove-AzSearchService.md new file mode 100644 index 0000000000..9170599f82 --- /dev/null +++ b/azps-10.1.0/Az.Search/Remove-AzSearchService.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/remove-azsearchservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Remove-AzSearchService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Remove-AzSearchService.md +--- + +# Remove-AzSearchService + +## SYNOPSIS +Remove an Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Remove-AzSearchService [-ResourceGroupName] <String> [-Name] <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzSearchService [-InputObject] <PSSearchService> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzSearchService [-ResourceId] <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSearchService** cmdlet removes an Azure Cognitive Search service with specified parameters. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSearchService -ResourceGroupName "TestAzureSearchPsGroup" -Name "pstestazuresearch01" +``` + +```output +Confirm +Are you sure you want to remove Search Service 'pstestazuresearch01'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +``` + +The example removes an Azure Cognitive Search service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure Cognitive Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Azure Cognitive Search Service Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzSearchService](./New-AzSearchService.md) + +[Get-AzSearchService](./Get-AzSearchService.md) + +[Set-AzSearchService](./Set-AzSearchService.md) diff --git a/azps-10.1.0/Az.Search/Remove-AzSearchSharedPrivateLinkResource.md b/azps-10.1.0/Az.Search/Remove-AzSearchSharedPrivateLinkResource.md new file mode 100644 index 0000000000..338c777213 --- /dev/null +++ b/azps-10.1.0/Az.Search/Remove-AzSearchSharedPrivateLinkResource.md @@ -0,0 +1,263 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/remove-azsearchsharedprivatelinkresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Remove-AzSearchSharedPrivateLinkResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Remove-AzSearchSharedPrivateLinkResource.md +--- + +# Remove-AzSearchSharedPrivateLinkResource + +## SYNOPSIS +Remove the shared private link resource from the Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Remove-AzSearchSharedPrivateLinkResource [-ResourceGroupName] <String> [-ServiceName] <String> [-Name] <String> + [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ParentObjectParameterSet +``` +Remove-AzSearchSharedPrivateLinkResource [-ParentObject] <PSSearchService> [-Name] <String> [-Force] + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzSearchSharedPrivateLinkResource [-ResourceId] <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzSearchSharedPrivateLinkResource [-InputObject] <PSSharedPrivateLinkResource> [-Force] [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSearchSharedPrivateLinkResource** cmdlet removes the shared private link resource from the Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSearchSharedPrivateLinkResource -ResourceGroupName arjagann -ServiceName arjagann-test-cuseuap -Name blob-pe +``` + +```output +Confirm +Remove Shared Private Link Resource 'blob-pe'. +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y +``` + +This example deletes a shared private link resource by name of the Azure Cognitive Search service. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Shared private link resource input object + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSharedPrivateLinkResource +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure Cognitive Search Shared private link resource + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet, ParentObjectParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Azure Cognitive Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Shared private link resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[New-AzSearchSharedPrivateLinkResource.md](./New-AzSearchSharedPrivateLinkResource.md) + +[Get-AzSearchSharedPrivateLinkResource.md](./Get-AzSearchSharedPrivateLinkResource.md) + +[Set-AzSearchSharedPrivateLinkResource.md](./Set-AzSearchSharedPrivateLinkResource.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Search/Set-AzSearchPrivateEndpointConnection.md b/azps-10.1.0/Az.Search/Set-AzSearchPrivateEndpointConnection.md new file mode 100644 index 0000000000..da9130824d --- /dev/null +++ b/azps-10.1.0/Az.Search/Set-AzSearchPrivateEndpointConnection.md @@ -0,0 +1,257 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/set-azsearchprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Set-AzSearchPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Set-AzSearchPrivateEndpointConnection.md +--- + +# Set-AzSearchPrivateEndpointConnection + +## SYNOPSIS +Update the private endpoint connection to the Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Set-AzSearchPrivateEndpointConnection [-ResourceGroupName] <String> [-ServiceName] <String> [-Name] <String> + -Status <PSPrivateLinkServiceConnectionStatus> [-Description <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentObjectParameterSet +``` +Set-AzSearchPrivateEndpointConnection [-ParentObject] <PSSearchService> [-Name] <String> + -Status <PSPrivateLinkServiceConnectionStatus> [-Description <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Set-AzSearchPrivateEndpointConnection [-ResourceId] <String> -Status <PSPrivateLinkServiceConnectionStatus> + [-Description <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Set-AzSearchPrivateEndpointConnection -Status <PSPrivateLinkServiceConnectionStatus> [-Description <String>] + [-InputObject] <PSPrivateEndpointConnection> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSearchPrivateEndpointConnection** updates the private endpoint connection to the Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSearchPrivateEndpointConnection -ResourceGroupName arjagann -ServiceName arjagann-test-cuseuap -Name arjagann-test-cuseuap-pe.4c74dd7c-7016-42ac-827a-8d5d1378f266 -Status Rejected -Description "Rejected" | ConvertTo-Json +``` + +```output +{ + "Name": "arjagann-test-cuseuap-pe.4c74dd7c-7016-42ac-827a-8d5d1378f266", + "Id": "/subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann/providers/Microsoft.Search/searchServices/arjagann-test-cuseuap/privateEndpointConnections/arjagann-test-cuseuap-pe.4c74dd7c-7016-42ac-827a-8d5d1378f266", + "PrivateEndpoint": { + "Id": "/subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann2/providers/Microsoft.Network/privateEndpoints/arjagann-test-cuseuap-pe" + }, + "PrivateLinkServiceConnectionState": { + "Status": 2, + "Description": "Rejected", + "ActionsRequired": "None" + } +} +``` + +This example updates a private endpoint connection's status of the Azure Cognitive Search service to be "Rejected". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Private endpoint connection description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Private endpoint connection input object + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSPrivateEndpointConnection +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure Cognitive Search Service private endpoint connection name + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet, ParentObjectParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Azure Cognitive Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Private link service resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceName +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Private link service connection status + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSPrivateLinkServiceConnectionStatus +Parameter Sets: (All) +Aliases: +Accepted values: Pending, Approved, Rejected, Disconnected + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSPrivateEndpointConnection + +## NOTES + +## RELATED LINKS + +[Get-AzSearchPrivateEndpointConnection.md](./Get-AzSearchPrivateEndpointConnection.md) + +[Remove-AzSearchPrivateEndpointConnection.md](./Remove-AzSearchPrivateEndpointConnection.md) diff --git a/azps-10.1.0/Az.Search/Set-AzSearchService.md b/azps-10.1.0/Az.Search/Set-AzSearchService.md new file mode 100644 index 0000000000..9709dd1586 --- /dev/null +++ b/azps-10.1.0/Az.Search/Set-AzSearchService.md @@ -0,0 +1,318 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/set-azsearchservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Set-AzSearchService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Set-AzSearchService.md +--- + +# Set-AzSearchService + +## SYNOPSIS +Update an Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Set-AzSearchService [-ResourceGroupName] <String> [-Name] <String> [-PartitionCount <Int32>] + [-ReplicaCount <Int32>] [-PublicNetworkAccess <PSPublicNetworkAccess>] [-IdentityType <PSIdentityType>] + [-IPRuleList <PSIpRule[]>] [-DisableLocalAuth <Boolean>] [-AuthOption <PSAuthOptionName>] + [-AadAuthFailureMode <PSAadAuthFailureMode>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Set-AzSearchService [-InputObject] <PSSearchService> [-PartitionCount <Int32>] [-ReplicaCount <Int32>] + [-PublicNetworkAccess <PSPublicNetworkAccess>] [-IdentityType <PSIdentityType>] [-IPRuleList <PSIpRule[]>] + [-DisableLocalAuth <Boolean>] [-AuthOption <PSAuthOptionName>] [-AadAuthFailureMode <PSAadAuthFailureMode>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Set-AzSearchService [-ResourceId] <String> [-PartitionCount <Int32>] [-ReplicaCount <Int32>] + [-PublicNetworkAccess <PSPublicNetworkAccess>] [-IdentityType <PSIdentityType>] [-IPRuleList <PSIpRule[]>] + [-DisableLocalAuth <Boolean>] [-AuthOption <PSAuthOptionName>] [-AadAuthFailureMode <PSAadAuthFailureMode>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSearchService** cmdlet modifies an Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSearchService -ResourceGroupName "TestAzureSearchPsGroup" -Name "pstestazuresearch01" -PartitionCount 2 -ReplicaCount 2 +``` + +```output +ResourceGroupName : TestAzureSearchPsGroup +Name : pstestazuresearch01 +Id : /subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/TestAzureSearchPsGroup/providers/Microsoft.Search/searchServices/pstestazuresearch01 +Location : West US +Sku : Standard +ReplicaCount : 2 +PartitionCount : 2 +HostingMode : Default +Tags : +``` + +The example changes partition count and replica count of the Azure Cognitive Search service to 2. + +## PARAMETERS + +### -AadAuthFailureMode +(Optional) What status code to return when failing AAD authentication, if both api key and AAD authenticaiton are allowed for the Azure Cognitive Search service + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Management.Search.Models.PSAadAuthFailureMode] +Parameter Sets: (All) +Aliases: +Accepted values: Http403, Http401WithBearerChallenge + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthOption +(Optional) Whether to only allow API key authentication or both API key authentication and AAD authentication for the Azure Cognitive Search service + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Management.Search.Models.PSAuthOptionName] +Parameter Sets: (All) +Aliases: +Accepted values: ApiKeyOnly, AadOrApiKey + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +(Optional) Disable API key authentication for the Azure Cognitive Search service (true/false/null) + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +(Optional) Azure Cognitive Search Service Identity (None/SystemAssigned) + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Management.Search.Models.PSIdentityType] +Parameter Sets: (All) +Aliases: +Accepted values: None, SystemAssigned + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IPRuleList +(Optional) Azure Cognitive Search Service IP rules + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSIpRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionCount +Search Service partition count. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +(Optional) Azure Cognitive Search Service public network access (Enabled/Disabled) + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.Management.Search.Models.PSPublicNetworkAccess] +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaCount +Search Service replica count. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Search Service Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService + +## NOTES + +## RELATED LINKS + +[New-AzSearchService](./New-AzSearchService.md) + +[Get-AzSearchService](./Get-AzSearchService.md) + +[Remove-AzSearchService](./Remove-AzSearchService.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Search/Set-AzSearchSharedPrivateLinkResource.md b/azps-10.1.0/Az.Search/Set-AzSearchSharedPrivateLinkResource.md new file mode 100644 index 0000000000..316c8cc888 --- /dev/null +++ b/azps-10.1.0/Az.Search/Set-AzSearchSharedPrivateLinkResource.md @@ -0,0 +1,254 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml +Module Name: Az.Search +online version: https://learn.microsoft.com/powershell/module/az.search/set-azsearchsharedprivatelinkresource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Set-AzSearchSharedPrivateLinkResource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Search/Search/help/Set-AzSearchSharedPrivateLinkResource.md +--- + +# Set-AzSearchSharedPrivateLinkResource + +## SYNOPSIS +Update the shared private link resource for the Azure Cognitive Search service. + +## SYNTAX + +### ResourceNameParameterSet (Default) +``` +Set-AzSearchSharedPrivateLinkResource [-ResourceGroupName] <String> [-ServiceName] <String> [-Name] <String> + -RequestMessage <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ParentObjectParameterSet +``` +Set-AzSearchSharedPrivateLinkResource [-ParentObject] <PSSearchService> [-Name] <String> + -RequestMessage <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Set-AzSearchSharedPrivateLinkResource [-ResourceId] <String> -RequestMessage <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Set-AzSearchSharedPrivateLinkResource -RequestMessage <String> [-InputObject] <PSSharedPrivateLinkResource> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This **Set-AzSearchSharedPrivateLinkResource** updates the shared private link resource for the Azure Cognitive Search service. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSearchSharedPrivateLinkResource -ResourceGroupName arjagann -ServiceName arjagann-test-cuseuap -Name blob-pe -RequestMessage "Please kindly approve" +``` + +```output +Id : /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourceGroups/arjagann/providers/Microsoft.Search/searchServices/arjagann-test-cuseuap/sharedPrivateLinkResources/blob-pe +Type : Microsoft.Search/searchServices/sharedPrivateLinkResources +Status : Pending +Name : blob-pe +GroupId : blob +PrivateLinkResourceId : /subscriptions/a4337210-c6b0-4de4-907a-688f1c120d9a/resourcegroups/PETesting/providers/Microsoft.Storage/storageAccounts/petesting +ProvisioningState : Succeeded +RequestMessage : Please kindly approve +ResourceRegion : +``` + +This example updates the request message for the pending shared private link resource for the Azure Cognitive Search service. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Shared private link resource input object + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSharedPrivateLinkResource +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure Cognitive Search Shared private link resource + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet, ParentObjectParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +Azure Cognitive Search Service Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService +Parameter Sets: ParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RequestMessage +Shared private link resource request message + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Shared private link resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Azure Cognitive Search Service name. + +```yaml +Type: System.String +Parameter Sets: ResourceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Search.Models.PSSharedPrivateLinkResource + +## NOTES + +## RELATED LINKS + +[New-AzSearchSharedPrivateLinkResource.md](./New-AzSearchSharedPrivateLinkResource.md) + +[Get-AzSearchSharedPrivateLinkResource.md](./Get-AzSearchSharedPrivateLinkResource.md) + +[Remove-AzSearchSharedPrivateLinkResource.md](./Remove-AzSearchSharedPrivateLinkResource.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Security/Add-AzSecurityAdaptiveNetworkHardening.md b/azps-10.1.0/Az.Security/Add-AzSecurityAdaptiveNetworkHardening.md new file mode 100644 index 0000000000..53ab20a394 --- /dev/null +++ b/azps-10.1.0/Az.Security/Add-AzSecurityAdaptiveNetworkHardening.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Add-AzSecurityAdaptiveNetworkHardening +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Add-AzSecurityAdaptiveNetworkHardening.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Add-AzSecurityAdaptiveNetworkHardening.md +--- + +# Add-AzSecurityAdaptiveNetworkHardening + +## SYNOPSIS +Enforces the given rules on the NSG(s) listed in the request + +## SYNTAX + +``` +Add-AzSecurityAdaptiveNetworkHardening -AdaptiveNetworkHardeningResourceName <String> + -ResourceGroupName <String> -ResourceName <String> -ResourceNamespace <String> -ResourceType <String> + -SubscriptionId <String> -Rule <PSSecurityAdaptiveNetworkHardeningsRule[]> + -NetworkSecurityGroup <System.Collections.Generic.List`1[System.String]> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Adaptive Network Hardenings are automatically calculated by Azure Security Center, use this cmdlet to enforces the given rules on the NSG(s) listed in the request. + +## EXAMPLES + +### Example 1 +```powershell +$anh = Get-AzSecurityAdaptiveNetworkHardening -AdaptiveNetworkHardeningResourceName default -ResourceGroupName myService1 -ResourceName myResource1 -ResourceNamespace Microsoft.Compute -ResourceType virtualMachines | Select-Object -First 1 +Add-AzSecurityAdaptiveNetworkHardening -AdaptiveNetworkHardeningResourceName default -ResourceGroupName myService1 -ResourceName myResource1 -ResourceNamespace Microsoft.Compute -ResourceType virtualMachines -SubscriptionId 3eeab341-f466-499c-a8be-85427e154baf7612f869 -Rule $anh.Properties.Rules -NetworkSecurityGroup $anh.Properties.EffectiveNetworkSecurityGroups[0].NetworkSecurityGroups +``` + +```output +True +``` + +Enforces the given rules on the NSG(s) listed in the request + +## PARAMETERS + +### -AdaptiveNetworkHardeningResourceName +The name of the Adaptive Network Hardening resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSecurityGroup +The Azure resource IDs of the effective network security groups + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return a value indicating success or failure + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +Resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceNamespace +The Namespace of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +The type of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +Rule to enforce + +```yaml +Type: Microsoft.Azure.Commands.SecurityCenter.Models.AdaptiveNetworkHardening.PSSecurityAdaptiveNetworkHardeningsRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.SecurityCenter.Models.AdaptiveNetworkHardenings.PSSecurityAdaptiveNetworkHardeningsRule + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Add-AzSecuritySqlVulnerabilityAssessmentBaseline.md b/azps-10.1.0/Az.Security/Add-AzSecuritySqlVulnerabilityAssessmentBaseline.md new file mode 100644 index 0000000000..2260fff1a1 --- /dev/null +++ b/azps-10.1.0/Az.Security/Add-AzSecuritySqlVulnerabilityAssessmentBaseline.md @@ -0,0 +1,351 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/add-azsecuritysqlvulnerabilityassessmentbaseline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Add-AzSecuritySqlVulnerabilityAssessmentBaseline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Add-AzSecuritySqlVulnerabilityAssessmentBaseline.md +--- + +# Add-AzSecuritySqlVulnerabilityAssessmentBaseline + +## SYNOPSIS +Add SQL vulnerability assessment baseline. + +## SYNTAX + +### ResourceIdWithBaselineObject (Default) +``` +Add-AzSecuritySqlVulnerabilityAssessmentBaseline -RuleId <String> [-Baseline <String[][]>] -ResourceId <String> + -WorkspaceId <String> -Server <String> -Database <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### OnPremMachinesWithBaselineObject +``` +Add-AzSecuritySqlVulnerabilityAssessmentBaseline -RuleId <String> [-Baseline <String[][]>] + -WorkspaceId <String> -Server <String> -Database <String> -ComputerName <String> -VmUuid <String> + -AgentId <String> -WorkspaceResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectWithResourceId +``` +Add-AzSecuritySqlVulnerabilityAssessmentBaseline -InputObject <PSSqlVulnerabilityAssessmentBaselineResults> + -ResourceId <String> -WorkspaceId <String> -Server <String> -Database <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectBaselineWithOnPrem +``` +Add-AzSecuritySqlVulnerabilityAssessmentBaseline -InputObject <PSSqlVulnerabilityAssessmentBaselineResults> + -WorkspaceId <String> -Server <String> -Database <String> -ComputerName <String> -VmUuid <String> + -AgentId <String> -WorkspaceResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Add SQL vulnerability assessment baseline + +## EXAMPLES + +### Example 1: Add results as baseline using resource id parameters. +```powershell +Add-AzSecuritySqlVulnerabilityAssessmentBaseline -ResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onPremiseMachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -RuleId "VA2108" -Baseline @( , @("dbo", "db_owner1", "SQL_USER")) +``` + +```output +Results Id +------- -- +{dbo db_owner1 SQL_USER} /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/sqlServ… +``` + +Example of resource id parameters. +Supported resources are: + +- ARC: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HybridCompute/machines/{machineName} +- VM: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{machineName} +- On-Premise: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.operationalinsights/workspaces/{workspaceName}/onPremiseMachines/{machineName} + +For on premise resources, the patameter machineName is composed as follows: +{ComputerName}_{AgentId}_{VmUuid} + +Notice the @(,@('a','b',...)) syntax for array of arrays of string with only one inner array. Eeach inner array represents a row in the query results. + +### Example 2: Add results as baseline using on premise parameters. +```powershell +Add-AzSecuritySqlVulnerabilityAssessmentBaseline -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -RuleId "VA2108" -Baseline @( , @("dbo", "db_owner1", "SQL_USER")) +``` + +```output +Results Id +------- -- +{dbo db_owner1 SQL_USER} /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/sqlServ… +``` + +Example of on premise parameters. + +### Example 3: Add results as baseline for specific rule. +```powershell +Add-AzSecuritySqlVulnerabilityAssessmentBaseline -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -RuleId "VA2108" +``` + +```output +Results Id +------- -- +{dbo db_owner1 SQL_USER} /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/sqlServ… +``` + +In this example when the -Baseline parameter is not supplied, latest results are set as baseline. + +### Example 4: Copy baseline from a database to an on prem database using pipe. +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentBaseline -ResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onPremiseMachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master | Add-AzSecuritySqlVulnerabilityAssessmentBaseline -ResourceId subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/talmachinegroupeuap/providers/microsoft.operationalinsights/workspaces/talworkspaceeuap2/onPremiseMachines/TAHERSCO-DEV.middleeast.corp.microsoft.com_7adcdd86-adb6-4008-a254-80e0fc425c55_4c4c4544-0058-3310-8032-c4c04f4a4e32 -WorkspaceId 806d6dfa-132f-488d-975b-9bcf2fcd6802 -Server SQLEXPRESS -Database master +``` + +```output +Results Id +------- -- +{dbo db_owner SQL_USER} /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/talmachinegroupeuap/providers/microsoft.operationalinsights/workspaces/talworkspaceeuap2/onpremisemachines/tahersco-dev.middleeast.corp.microsoft.com_7adcdd86-adb6-4008-a254-80e0fc425c55_4c… +``` + +>[!NOTE] +>In this example, we transfer baseline objects from database 'master' from one server to another using InputObjectWithResourceId parameter set. it is important that both source and destination server have matching platforms, versions, and ruleset otherwise the operation might fail. + +## PARAMETERS + +### -AgentId +Agent ID - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachinesWithBaselineObject, InputObjectBaselineWithOnPrem +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Baseline +Vulnerability assessment baseline object + +```yaml +Type: System.String[][] +Parameter Sets: ResourceIdWithBaselineObject, OnPremMachinesWithBaselineObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Computer full name - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachinesWithBaselineObject, InputObjectBaselineWithOnPrem +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database +Database name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.SecurityCenter.Models.SqlVulnerabilityAssessment.PSSqlVulnerabilityAssessmentBaselineResults +Parameter Sets: InputObjectWithResourceId, InputObjectBaselineWithOnPrem +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. +Supported resources are: + +- ARC: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HybridCompute/machines/{machineName} +- VM: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{machineName} +- On-Premise: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.operationalinsights/workspaces/{workspaceName}/onPremiseMachines/{machineName} + +```yaml +Type: System.String +Parameter Sets: ResourceIdWithBaselineObject, InputObjectWithResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Vulnerability assessment rule ID + +```yaml +Type: System.String +Parameter Sets: ResourceIdWithBaselineObject, OnPremMachinesWithBaselineObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +Server name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmUuid +Virtual machine universal unique identifier - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachinesWithBaselineObject, InputObjectBaselineWithOnPrem +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceId +Workspace ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +Workspace resource ID - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachinesWithBaselineObject, InputObjectBaselineWithOnPrem +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.SecurityCenter.Models.SqlVulnerabilityAssessment.PSSqlVulnerabilityAssessmentBaselineResults + +## OUTPUTS + +### Microsoft.Azure.Commands.SecurityCenter.Models.SqlVulnerabilityAssessment.PSSqlVulnerabilityAssessmentBaselineResults + +## NOTES + +## RELATED LINKS + +[Remove-AzSecuritySqlVulnerabilityAssessmentBaseline](https://learn.microsoft.com/powershell/module/az.security/remove-azsecuritysqlvulnerabilityassessmentbaseline) + +[Get-AzSecuritySqlVulnerabilityAssessmentBaseline](https://learn.microsoft.com/powershell/module/az.security/get-azsecuritysqlvulnerabilityassessmentbaseline) + +[Set-AzSecuritySqlVulnerabilityAssessmentBaseline](https://learn.microsoft.com/powershell/module/az.security/set-azsecuritysqlvulnerabilityassessmentbaseline) \ No newline at end of file diff --git a/azps-10.1.0/Az.Security/Az.Security.md b/azps-10.1.0/Az.Security/Az.Security.md new file mode 100644 index 0000000000..ccd465f371 --- /dev/null +++ b/azps-10.1.0/Az.Security/Az.Security.md @@ -0,0 +1,267 @@ +--- +Module Name: Az.Security +Module Guid: 5e312bb4-9d3a-4c88-94c3-8e5bbb2e3da4 +Download Help Link: https://learn.microsoft.com/powershell/module/az.security +Help Version: 0.1.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Az.Security.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Az.Security.md +--- + +# Az.Security Module +## Description +Azure Security Center gives you control over the security of your Azure subscriptions and other machines that you connected to it outside of Azure. + +## Az.Security Cmdlets +### [Add-AzSecurityAdaptiveNetworkHardening](Add-AzSecurityAdaptiveNetworkHardening.md) +Enforces the given rules on the NSG(s) listed in the request + +### [Add-AzSecuritySqlVulnerabilityAssessmentBaseline](Add-AzSecuritySqlVulnerabilityAssessmentBaseline.md) +Add SQL vulnerability assessment baseline. + +### [Confirm-AzSecurityAutomation](Confirm-AzSecurityAutomation.md) +Validates the security automation model before create or update. Any validation errors are returned to the client + +### [Disable-AzIotSecurityAnalyticsAggregatedAlert](Disable-AzIotSecurityAnalyticsAggregatedAlert.md) +Dismiss Iot aggregated alert + +### [Disable-AzSecurityAdvancedThreatProtection](Disable-AzSecurityAdvancedThreatProtection.md) +Disables the advanced threat protection policy for a storage / cosmosDB account. + +### [Enable-AzSecurityAdvancedThreatProtection](Enable-AzSecurityAdvancedThreatProtection.md) +Enables the advanced threat protection policy for a storage / cosmosDB account. + +### [Get-AzAlertsSuppressionRule](Get-AzAlertsSuppressionRule.md) +Gets alerts suppression rules. + +### [Get-AzAllowedConnection](Get-AzAllowedConnection.md) +Used to display allowed traffic between resources for the subscription + +### [Get-AzDeviceSecurityGroup](Get-AzDeviceSecurityGroup.md) +Get device security group (IoT Hub security) + +### [Get-AzDiscoveredSecuritySolution](Get-AzDiscoveredSecuritySolution.md) +Gets security solutions that were discovered by Azure Security Center + +### [Get-AzExternalSecuritySolution](Get-AzExternalSecuritySolution.md) +Get external security solution + +### [Get-AzIotSecurityAnalytics](Get-AzIotSecurityAnalytics.md) +Get IoT security analytics + +### [Get-AzIotSecurityAnalyticsAggregatedAlert](Get-AzIotSecurityAnalyticsAggregatedAlert.md) +Get IoT security aggregated alert + +### [Get-AzIotSecurityAnalyticsAggregatedRecommendation](Get-AzIotSecurityAnalyticsAggregatedRecommendation.md) +Get IoT security aggregated recommendation + +### [Get-AzIotSecuritySolution](Get-AzIotSecuritySolution.md) +Get IoT security solution + +### [Get-AzJitNetworkAccessPolicy](Get-AzJitNetworkAccessPolicy.md) +Gets the JIT network access policies + +### [Get-AzRegulatoryComplianceAssessment](Get-AzRegulatoryComplianceAssessment.md) +Gets regulatory compliance assessments + +### [Get-AzRegulatoryComplianceControl](Get-AzRegulatoryComplianceControl.md) +Gets regulatory compliance controls + +### [Get-AzRegulatoryComplianceStandard](Get-AzRegulatoryComplianceStandard.md) +Gets regulatory compliance standards + +### [Get-AzSecurityAdaptiveApplicationControl](Get-AzSecurityAdaptiveApplicationControl.md) +Gets a list of application control VM/server groups for the subscription. + +### [Get-AzSecurityAdaptiveApplicationControlGroup](Get-AzSecurityAdaptiveApplicationControlGroup.md) +Gets an application control VM/server group. + +### [Get-AzSecurityAdaptiveNetworkHardening](Get-AzSecurityAdaptiveNetworkHardening.md) +Gets a list of Adaptive Network Hardenings resources in scope of an extended resource. + +### [Get-AzSecurityAdvancedThreatProtection](Get-AzSecurityAdvancedThreatProtection.md) +Gets the advanced threat protection policy for a storage / cosmosDB account. + +### [Get-AzSecurityAlert](Get-AzSecurityAlert.md) +Gets security alerts that were detected by Azure Security Center + +### [Get-AzSecurityAssessment](Get-AzSecurityAssessment.md) +Gets security assessments and their results on a subscription + +### [Get-AzSecurityAssessmentMetadata](Get-AzSecurityAssessmentMetadata.md) +Gets security assessments types and metadta in a subscription. + +### [Get-AzSecurityAutomation](Get-AzSecurityAutomation.md) +Gets security automation(s) + +### [Get-AzSecurityAutoProvisioningSetting](Get-AzSecurityAutoProvisioningSetting.md) +Gets the security automatic provisioning settings + +### [Get-AzSecurityCompliance](Get-AzSecurityCompliance.md) +Get the security compliance of a subscription over time + +### [Get-AzSecurityContact](Get-AzSecurityContact.md) +Gets security contacts that were configured on this subscription + +### [Get-AzSecurityLocation](Get-AzSecurityLocation.md) +Gets the location where Azure Security Center will automatically save data for the specific subscription + +### [Get-AzSecurityPricing](Get-AzSecurityPricing.md) +Gets the Azure Defender plans for a subscription in Azure Security Center. + +### [Get-AzSecuritySecureScore](Get-AzSecuritySecureScore.md) +Gets security secure scores and their results on a subscription + +### [Get-AzSecuritySecureScoreControl](Get-AzSecuritySecureScoreControl.md) +Gets security secure score controls and their results on a subscription + +### [Get-AzSecuritySecureScoreControlDefinition](Get-AzSecuritySecureScoreControlDefinition.md) +Gets security secure score control definitions on a subscription + +### [Get-AzSecuritySetting](Get-AzSecuritySetting.md) +Get security settings in Azure Security Center + +### [Get-AzSecuritySqlVulnerabilityAssessmentBaseline](Get-AzSecuritySqlVulnerabilityAssessmentBaseline.md) +Get SQL vulnerability assessment baseline. + +### [Get-AzSecuritySqlVulnerabilityAssessmentScanRecord](Get-AzSecuritySqlVulnerabilityAssessmentScanRecord.md) +Gets SQL vulnerability assessment scan summary. + +### [Get-AzSecuritySqlVulnerabilityAssessmentScanResult](Get-AzSecuritySqlVulnerabilityAssessmentScanResult.md) +Gets SQL vulnerability assessment scan results. + +### [Get-AzSecuritySubAssessment](Get-AzSecuritySubAssessment.md) +Gets sub assessments results in a subscription. + +### [Get-AzSecurityTask](Get-AzSecurityTask.md) +Gets the security tasks that Azure Security Center recommends you to do in order to strengthen your security posture. + +### [Get-AzSecurityTopology](Get-AzSecurityTopology.md) +Gets a list of Security Topologies on a subscription + +### [Get-AzSecurityWorkspaceSetting](Get-AzSecurityWorkspaceSetting.md) +Gets the configured security workspace settings on a subscription. + +### [Get-AzSqlInformationProtectionPolicy](Get-AzSqlInformationProtectionPolicy.md) +Retrieves the effective tenant SQL information protection policy. + +### [New-AzAlertsSuppressionRuleScope](New-AzAlertsSuppressionRuleScope.md) +Helper cmdlet to create PSIScopeElement. + +### [New-AzDeviceSecurityGroupAllowlistCustomAlertRuleObject](New-AzDeviceSecurityGroupAllowlistCustomAlertRuleObject.md) +Create new allow list custom alert rule for device security group (IoT Security) + +### [New-AzDeviceSecurityGroupDenylistCustomAlertRuleObject](New-AzDeviceSecurityGroupDenylistCustomAlertRuleObject.md) +Create new deny list custom alert rule for device security group (IoT Security) + +### [New-AzDeviceSecurityGroupThresholdCustomAlertRuleObject](New-AzDeviceSecurityGroupThresholdCustomAlertRuleObject.md) +Create new threshold custom alert rule for device security group (IoT Security) + +### [New-AzDeviceSecurityGroupTimeWindowRuleObject](New-AzDeviceSecurityGroupTimeWindowRuleObject.md) +Create new time window rule for device security group (IoT Security) + +### [New-AzIotSecuritySolutionRecommendationConfigurationObject](New-AzIotSecuritySolutionRecommendationConfigurationObject.md) +Create new recommendation configuration for iot security solution + +### [New-AzIotSecuritySolutionUserDefinedResourcesObject](New-AzIotSecuritySolutionUserDefinedResourcesObject.md) +Create new user defined resources for iot security solution + +### [Remove-AzAlertsSuppressionRule](Remove-AzAlertsSuppressionRule.md) +Deletes an alerts suppression rule. + +### [New-AzSecurityAutomation](New-AzSecurityAutomation.md) +Creates new security automation + +### [New-AzSecurityAutomationActionObject](New-AzSecurityAutomationActionObject.md) +Creates new security automation action object + +### [New-AzSecurityAutomationRuleObject](New-AzSecurityAutomationRuleObject.md) +Creates new security automation rule object + +### [New-AzSecurityAutomationRuleSetObject](New-AzSecurityAutomationRuleSetObject.md) +Creates new security automation rule set object + +### [New-AzSecurityAutomationScopeObject](New-AzSecurityAutomationScopeObject.md) +Creates new security automation scope object + +### [New-AzSecurityAutomationSourceObject](New-AzSecurityAutomationSourceObject.md) +Creates new security automation source object + +### [Remove-AzDeviceSecurityGroup](Remove-AzDeviceSecurityGroup.md) +Delete device security group + +### [Remove-AzIotSecuritySolution](Remove-AzIotSecuritySolution.md) +Delete IoT security solution + +### [Remove-AzJitNetworkAccessPolicy](Remove-AzJitNetworkAccessPolicy.md) +Deletes a JIT network access policy. + +### [Remove-AzSecurityAssessment](Remove-AzSecurityAssessment.md) +Deletes a security assessment result from a subscription. + +### [Remove-AzSecurityAssessmentMetadata](Remove-AzSecurityAssessmentMetadata.md) +Deletes a security assessment metadata from a subscription. + +### [Remove-AzSecurityAutomation](Remove-AzSecurityAutomation.md) +Deletes security automation + +### [Remove-AzSecurityContact](Remove-AzSecurityContact.md) +Deletes a security contact. + +### [Remove-AzSecuritySqlVulnerabilityAssessmentBaseline](Remove-AzSecuritySqlVulnerabilityAssessmentBaseline.md) +Removes SQL vulnerability assessment baseline. + +### [Remove-AzSecurityWorkspaceSetting](Remove-AzSecurityWorkspaceSetting.md) +Deletes the security workspace setting for this subscription. + +### [Set-AzAlertsSuppressionRule](Set-AzAlertsSuppressionRule.md) +Create or update an alerts suppression rule. + +### [Set-AzDeviceSecurityGroup](Set-AzDeviceSecurityGroup.md) +Create or update device security group + +### [Set-AzIotSecuritySolution](Set-AzIotSecuritySolution.md) +Create or update IoT security solution + +### [Set-AzJitNetworkAccessPolicy](Set-AzJitNetworkAccessPolicy.md) +Updates JIT network access policy. + +### [Set-AzSecurityAlert](Set-AzSecurityAlert.md) +Updates a security alert state. + +### [Set-AzSecurityAssessment](Set-AzSecurityAssessment.md) +Create or update a security assessment result on a resource + +### [Set-AzSecurityAssessmentMetadata](Set-AzSecurityAssessmentMetadata.md) +Creates or updates a security assessment type. + +### [Set-AzSecurityAutomation](Set-AzSecurityAutomation.md) +Creates or updates a security automation. If a security automation is already created and a subsequent request is issued for the same automation id, then it will be updated. + +### [Set-AzSecurityAutoProvisioningSetting](Set-AzSecurityAutoProvisioningSetting.md) +Updates automatic provisioning setting + +### [Set-AzSecurityContact](Set-AzSecurityContact.md) +Updates a security contact for a subscription. + +### [Set-AzSecurityPricing](Set-AzSecurityPricing.md) +Enables or disables Azure Defender plans for a subscription in Azure Security Center. + +### [Set-AzSecuritySetting](Set-AzSecuritySetting.md) +Update a security setting in Azure Security Center + +### [Set-AzSecuritySqlVulnerabilityAssessmentBaseline](Set-AzSecuritySqlVulnerabilityAssessmentBaseline.md) +Sets new SQL vulnerability assessment baseline on a specific database discards old baseline if any exists. + +### [Set-AzSecurityWorkspaceSetting](Set-AzSecurityWorkspaceSetting.md) +Updates the workspace settings for the subscription. + +### [Set-AzSqlInformationProtectionPolicy](Set-AzSqlInformationProtectionPolicy.md) +Sets the effective tenant SQL information protection policy. + +### [Start-AzJitNetworkAccessPolicy](Start-AzJitNetworkAccessPolicy.md) +Invokes a temporary network access request. + +### [Update-AzIotSecuritySolution](Update-AzIotSecuritySolution.md) +Update one or more of the following properties in IoT security solution: tags, recommendation configuration, user defined resources + diff --git a/azps-10.1.0/Az.Security/Confirm-AzSecurityAutomation.md b/azps-10.1.0/Az.Security/Confirm-AzSecurityAutomation.md new file mode 100644 index 0000000000..7a13d2da36 --- /dev/null +++ b/azps-10.1.0/Az.Security/Confirm-AzSecurityAutomation.md @@ -0,0 +1,303 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/confirm-azsecurityautomation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Confirm-AzSecurityAutomation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Confirm-AzSecurityAutomation.md +--- + +# Confirm-AzSecurityAutomation + +## SYNOPSIS +Validates the security automation model before create or update. Any validation errors are returned to the client + +## SYNTAX + +### ResourceGroupLevelResource (Default) +``` +Confirm-AzSecurityAutomation -ResourceGroupName <String> -Name <String> -Location <String> [-Etag <String>] + [-Tag <Hashtable>] [-Description <String>] [-IsEnabled <Boolean>] -Scope <PSSecurityAutomationScope[]> + -Source <PSSecurityAutomationSource[]> -Action <PSSecurityAutomationAction[]> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Confirm-AzSecurityAutomation -ResourceId <String> -Location <String> [-Etag <String>] [-Tag <Hashtable>] + [-Description <String>] [-IsEnabled <Boolean>] -Scope <PSSecurityAutomationScope[]> + -Source <PSSecurityAutomationSource[]> -Action <PSSecurityAutomationAction[]> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObject +``` +Confirm-AzSecurityAutomation [-Location <String>] [-Etag <String>] [-Tag <Hashtable>] [-Description <String>] + [-IsEnabled <Boolean>] [-Scope <PSSecurityAutomationScope[]>] [-Source <PSSecurityAutomationSource[]>] + -Action <PSSecurityAutomationAction[]> -InputObject <PSSecurityAutomation> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Validates the security automation model before create or update. Any validation errors are returned to the client + +## EXAMPLES + +### Example 1 +```powershell +Confirm-AzSecurityAutomation -Name 'SampleAutomation' -ResourceGroupName 'SampleResourceGroup' -Description 'Sample security automation' -Scope $scopes -Source $sources -Action $actions +``` + +Validates that the creation of security automation named "SampleAutomation" under resource group named "SampleResourceGroup" + +## PARAMETERS + +### -Action +A collection of the actions which are triggered if all the configured rules evaluations, within at least one rule set, are true + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationAction[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The security automation description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Entity tag is used for comparing two or more entities from the same requested resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomation +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsEnabled +Is rule enabled. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +A collection of scopes on which the security automations logic is applied. +Supported scopes are the subscription itself or a resource group under that subscription. +The automation will only apply on defined scopes + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationScope[] +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationScope[] +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +A collection of the source event types which evaluate the security automation set of rules + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationSource[] +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationSource[] +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomation + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Disable-AzIotSecurityAnalyticsAggregatedAlert.md b/azps-10.1.0/Az.Security/Disable-AzIotSecurityAnalyticsAggregatedAlert.md new file mode 100644 index 0000000000..c957be0e77 --- /dev/null +++ b/azps-10.1.0/Az.Security/Disable-AzIotSecurityAnalyticsAggregatedAlert.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Disable-AzIotSecurityAnalyticsAggregatedAlert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Disable-AzIotSecurityAnalyticsAggregatedAlert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Disable-AzIotSecurityAnalyticsAggregatedAlert.md +--- + +# Disable-AzIotSecurityAnalyticsAggregatedAlert + +## SYNOPSIS +Dismiss Iot aggregated alert + +## SYNTAX + +### SolutionLevelResource (Default) +``` +Disable-AzIotSecurityAnalyticsAggregatedAlert -ResourceGroupName <String> -SolutionName <String> -Name <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Disable-AzIotSecurityAnalyticsAggregatedAlert -InputObject <PSIoTSecurityAggregatedAlert> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Disable-AzIotSecurityAnalyticsAggregatedAlert -ResourceId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Disable-AzIotSecurityAnalyticsAggregatedAlert cmdlet dismisses a specific aggragated alert on devices of iot hub. +The name of the aggregated alerts is a combination of the alert type and the alert aggragted date, separated by '/'. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzIotSecurityAnalyticsAggregatedAlert -ResourceGroupName "MyResourceGroup" -SolutionName "MySolutionName" -Name "IoT_SucessfulLocalLogin/2020-03-15" +``` + +Dismiss aggregated alert "IoT_SucessfulLocalLogin/2020-03-15" (name combined from alert type and its aggregated date) from the IoT security solution "MySolutionName" in resource group "MyResourceGroup" + +### Example 2 +```powershell +Disable-AzIotSecurityAnalyticsAggregatedAlert -ResourceId "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Security/iotSecuritySolutions/MySolutionName/analyticsModels/default/aggregatedAlerts/IoT_SucessfulLocalLogin/2020-03-15" +``` + +Dismiss aggregated alert with resource Id "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Security/iotSecuritySolutions/MySolutionName/analyticsModels/default/aggregatedAlerts/IoT_SucessfulLocalLogin/2020-03-15" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.IotSecuritySolutionAnalytics.PSIoTSecurityAggregatedAlert +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SolutionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the operation was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: SolutionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SolutionName +Solution name + +```yaml +Type: System.String +Parameter Sets: SolutionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutionAnalytics.PSIoTSecurityAggregatedAlert + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Disable-AzSecurityAdvancedThreatProtection.md b/azps-10.1.0/Az.Security/Disable-AzSecurityAdvancedThreatProtection.md new file mode 100644 index 0000000000..3de2af0a51 --- /dev/null +++ b/azps-10.1.0/Az.Security/Disable-AzSecurityAdvancedThreatProtection.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/disable-azsecurityadvancedthreatprotection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Disable-AzSecurityAdvancedThreatProtection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Disable-AzSecurityAdvancedThreatProtection.md +--- + +# Disable-AzSecurityAdvancedThreatProtection + +## SYNOPSIS +Disables the advanced threat protection policy for a storage / cosmosDB account. + +## SYNTAX + +``` +Disable-AzSecurityAdvancedThreatProtection -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The `Disable-AzSecurityAdvancedThreatProtection` cmdlet disables the threat protection policy for a storage / cosmosDB account. +To use this cmdlet, specify the *ResourceId* parameter. + +## EXAMPLES + +### Example 1 : Storage Account +```powershell +Disable-AzSecurityAdvancedThreatProtection -ResourceId "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount/" +``` + +```output +IsEnabled Id +--------- -- + False "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount/" +``` + +This command disables the advanced threat protection policy for resource id `"/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount/"`. + +### Example 2 : CosmosDB Account +```powershell +Disable-AzSecurityAdvancedThreatProtection -ResourceId "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDb/databaseAccounts/myCosmosDBAccount/" +``` + +```output +IsEnabled Id +--------- -- + False "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDb/databaseAccounts/myCosmosDBAccount/" +``` + +This command disables the advanced threat protection policy for resource id ` "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDb/databaseAccounts/myCosmosDBAccount/"`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AdvancedThreatProtection.PSAdvancedThreatProtection + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Enable-AzSecurityAdvancedThreatProtection.md b/azps-10.1.0/Az.Security/Enable-AzSecurityAdvancedThreatProtection.md new file mode 100644 index 0000000000..2a5e1a606f --- /dev/null +++ b/azps-10.1.0/Az.Security/Enable-AzSecurityAdvancedThreatProtection.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/enable-azsecurityadvancedthreatprotection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Enable-AzSecurityAdvancedThreatProtection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Enable-AzSecurityAdvancedThreatProtection.md +--- + +# Enable-AzSecurityAdvancedThreatProtection + +## SYNOPSIS +Enables the advanced threat protection policy for a storage / cosmosDB account. + +## SYNTAX + +``` +Enable-AzSecurityAdvancedThreatProtection -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The `Enable-AzSecurityAdvancedThreatProtection` cmdlet enables the threat protection policy for a storage / cosmosDB account. +To use this cmdlet, specify the *ResourceId* parameter. + +## EXAMPLES + +### Example 1: Storage Account +```powershell +Enable-AzSecurityAdvancedThreatProtection -ResourceId "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount/" +``` + +```output +IsEnabled Id +--------- -- + True "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount/" +``` + +This command enables the advanced threat protection policy for resource id `"/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount/"`. + +### Example 2: CosmosDB Account +```powershell +Enable-AzSecurityAdvancedThreatProtection -ResourceId "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDb/databaseAccounts/myCosmosDBAccount/" +``` + +```output +IsEnabled Id +--------- -- + True "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDb/databaseAccounts/myCosmosDBAccount/" +``` + +This command enables the advanced threat protection policy for resource id ` "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDb/databaseAccounts/myCosmosDBAccount/"`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AdvancedThreatProtection.PSAdvancedThreatProtection + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzAlertsSuppressionRule.md b/azps-10.1.0/Az.Security/Get-AzAlertsSuppressionRule.md new file mode 100644 index 0000000000..b153658bc2 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzAlertsSuppressionRule.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/get-azalertssuppressionrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzAlertsSuppressionRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzAlertsSuppressionRule.md +--- + +# Get-AzAlertsSuppressionRule + +## SYNOPSIS +Gets alerts suppression rules. + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzAlertsSuppressionRule [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzAlertsSuppressionRule -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzAlertsSuppressionRule -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets or list alerts suppression rules. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAlertsSuppressionRule +``` + +List all alerts suppression rules in the subscription. + +### Example 2 +```powershell +Get-AzAlertsSuppressionRule -Name "Example" +``` + +Gets an alerts suppression rule with the name "Example". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AlertsSuppressionRules.PSAlertsSuppressionRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzAllowedConnection.md b/azps-10.1.0/Az.Security/Get-AzAllowedConnection.md new file mode 100644 index 0000000000..740b829e93 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzAllowedConnection.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzAllowedConnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzAllowedConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzAllowedConnection.md +--- + +# Get-AzAllowedConnection + +## SYNOPSIS +Used to display allowed traffic between resources for the subscription + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzAllowedConnection [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupLevelResource +``` +Get-AzAllowedConnection -ResourceGroupName <String> -Name <String> -Location <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzAllowedConnection -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the list of all possible traffic between resources for the subscription and location, based on connection type. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAllowedConnection +``` + +```output +Id: /subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/allowedConnections/virtualMachines +Name: Internal +Type: Microsoft.Security/locations/allowedConnections +CalculatedDateTime: 03-Jun-20 3:03:48 PM +ConnectableResources: /subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/myvm +``` + +### Example 2 +```powershell +Get-AzAllowedConnection -ResourceGroupName "myService1" -Location "centralus" -Name "Internal" +``` + +```output +Id: /subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/allowedConnections/Internal +Name: virtualMachines +Type: Microsoft.Security/locations/allowedConnections +CalculatedDateTime: 03-Jun-20 3:03:48 PM +ConnectableResources: /subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/myvm +``` + +Gets the list of all possible traffic between resources for the subscription and location, based on connection type. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AllowedConnection.PSSecurityAllowedConnection + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzDeviceSecurityGroup.md b/azps-10.1.0/Az.Security/Get-AzDeviceSecurityGroup.md new file mode 100644 index 0000000000..aca1494382 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzDeviceSecurityGroup.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzDeviceSecurityGroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzDeviceSecurityGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzDeviceSecurityGroup.md +--- + +# Get-AzDeviceSecurityGroup + +## SYNOPSIS +Get device security group (IoT Hub security) + +## SYNTAX + +### ResourceIdScope (Default) +``` +Get-AzDeviceSecurityGroup -HubResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdLevelResource +``` +Get-AzDeviceSecurityGroup -HubResourceId <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzDeviceSecurityGroup cmdlet returns a device security group defined in iot security solution + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDeviceSecurityGroup -HubResourceId "/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Devices/IotHubs/MyHub" -Name "MySecurityGroup" +``` + +```output +Id: "/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Devices/IotHubs/MyHub/providers/Microsoft.Security/deviceSecurityGroups/MySecurityGroup" +Name: "MySecurityGroup" +Type: "Microsoft.Security/deviceSecurityGroups" +ThresholdRules: [] +TimeWindowRules: [ + { + RuleType: "ActiveConnectionsNotInAllowedRange" + DisplayName: "Number of active connections is not in allowed range" + Description: "Get an alert when the number of active connections of a device in the time window is not in the allowed range" + IsEnabled: false + MinThreshold: 0 + MaxThreshold: 0 + TimeWindowSize: "PT15M" + } + { + RuleType: "AmqpC2DMessagesNotInAllowedRange" + DisplayName: "Number of cloud to device messages (AMQP protocol) is not in allowed range" + Description: "Get an alert when the number of cloud to device messages (AMQP protocol) in the time window is not in the allowed range" + IsEnabled: false + MinThreshold: 0 + MaxThreshold: 0 + TimeWindowSize: "PT15M" + }] +AllowlistRules: [ + { + RuleType": "ConnectionToIpNotAllowed", + DisplayName: "Outbound connection to an ip that isn't allowed" + Description: "Get an alert when an outbound connection is created between your device and an ip that isn't allowed" + IsEnabled: false + ValueType: "IpCidr" + AllowlistValues: [] + }, + { + RuleType: "LocalUserNotAllowed" + DisplayName: "Login by a local user that isn't allowed" + Description: "Get an alert when a local user that isn't allowed logins to the device" + IsEnabled: false + ValueType: "String" + AllowlistValues: [] + }] +DenylistRules: [] +``` + +Get device security group "MySecurityGroup" in IoT Hub with reasource Id "/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Devices/IotHubs/MyHub" + +### Example 2 +```powershell +Get-AzDeviceSecurityGroup -HubResourceId "/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Devices/IotHubs/MyHub" +``` + +```output +Array of security group items like the item returned in example 1 +``` + +Get list of device security group in IoT Hub with reasource Id "/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Devices/IotHubs/MyHub" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceIdLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSDeviceSecurityGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzDiscoveredSecuritySolution.md b/azps-10.1.0/Az.Security/Get-AzDiscoveredSecuritySolution.md new file mode 100644 index 0000000000..dfc445efc5 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzDiscoveredSecuritySolution.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzDiscoveredSecuritySolution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzDiscoveredSecuritySolution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzDiscoveredSecuritySolution.md +--- + +# Get-AzDiscoveredSecuritySolution + +## SYNOPSIS +Gets security solutions that were discovered by Azure Security Center + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzDiscoveredSecuritySolution [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupLevelResource +``` +Get-AzDiscoveredSecuritySolution -ResourceGroupName <String> -Name <String> -Location <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzDiscoveredSecuritySolution -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Security solutions are automatically discovered by Azure Security Center, use this cmdlet to view the discovered security solutions + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDiscoveredSecuritySolution +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Secu + rity/locations/centralus/discoveredSecuritySolutions/ContosoWAF2 +Name : ContosoWAF2 +Offer : +Publisher : microsoft +SecurityFamily : SaasWaf +Sku : +``` + +Get all the discovered security solutions in the subscription + +### Example 2 +```powershell +Get-AzDiscoveredSecuritySolution -ResourceGroupName "myService1" -Location "centralus" -Name "ContosoWAF2" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Secu + rity/locations/centralus/discoveredSecuritySolutions/ContosoWAF2 +Name : ContosoWAF2 +Offer : +Publisher : microsoft +SecurityFamily : SaasWaf +Sku : +``` + +Get a specific discovered security solution + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.DiscoveredSecuritySolutions.PSSecurityDiscoveredSecuritySolution + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzExternalSecuritySolution.md b/azps-10.1.0/Az.Security/Get-AzExternalSecuritySolution.md new file mode 100644 index 0000000000..2b60d4243c --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzExternalSecuritySolution.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzExternalSecuritySolution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzExternalSecuritySolution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzExternalSecuritySolution.md +--- + +# Get-AzExternalSecuritySolution + +## SYNOPSIS +Get external security solution + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzExternalSecuritySolution [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupLevelResource +``` +Get-AzExternalSecuritySolution -ResourceGroupName <String> -Name <String> -Location <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzExternalSecuritySolution -Location <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzExternalSecuritySolution -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get external security solution + +## EXAMPLES + +### Example 1 +```powershell +Get-AzExternalSecuritySolution +``` + +```output +ConnectivityState : Discovered +DeviceType : Azure Active Directory Identity Protection +DeviceVendor : microsoft +Workspace : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provide + rs/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869-e + us +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/defaultresourcegroup-eus/provide + rs/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-487bb485-b + 5b0-471e-9c0d-10717612f869-eus +Name : aad_defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869-eus +Kind : AAD + +ConnectivityState : Discovered +DeviceType : Azure Active Directory Identity Protection +DeviceVendor : microsoft +Workspace : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-weu/provide + rs/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869-w + eu +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/defaultresourcegroup-weu/provide + rs/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-487bb485-b + 5b0-471e-9c0d-10717612f869-weu +Name : aad_defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869-weu +Kind : AAD + +ConnectivityState : Discovered +DeviceType : Azure Active Directory Identity Protection +DeviceVendor : microsoft +Workspace : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/mainws/providers/microsoft.opera + tionalinsights/workspaces/securityuserws +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/mainws/providers/Microsoft.Secur + ity/locations/centralus/externalSecuritySolutions/aad_securityuserws +Name : aad_securityuserws +Kind : AAD + +ConnectivityState : Discovered +DeviceType : Azure Active Directory Identity Protection +DeviceVendor : microsoft +Workspace : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/myservice1/providers/microsoft.o + perationalinsights/workspaces/testservicews +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myservice1/providers/Microsoft.S + ecurity/locations/centralus/externalSecuritySolutions/aad_testservicews +Name : aad_testservicews +Kind : AAD +``` + +Get all the external security solutions in the subscription + +### Example 2 +```powershell +Get-AzExternalSecuritySolution -ResourceGroupName "myservice1" -Location "centralus" -Name "aad_testservicews" +``` + +```output +ConnectivityState : Discovered +DeviceType : Azure Active Directory Identity Protection +DeviceVendor : microsoft +Workspace : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/myservice1/providers/microsoft.operationalinsights/workspaces/testservicews +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myservice1/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_testservicews +Name : aad_testservicews +Kind : AAD +``` + +Get a specific external security solution + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource, SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.ExternalSecuritySolutions.PSSecurityExternalSecuritySolution + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzIotSecurityAnalytics.md b/azps-10.1.0/Az.Security/Get-AzIotSecurityAnalytics.md new file mode 100644 index 0000000000..42a9da1e9c --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzIotSecurityAnalytics.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzIotSecurityAnalytics +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzIotSecurityAnalytics.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzIotSecurityAnalytics.md +--- + +# Get-AzIotSecurityAnalytics + +## SYNOPSIS +Get IoT security analytics + +## SYNTAX + +``` +Get-AzIotSecurityAnalytics -ResourceGroupName <String> -SolutionName <String> [-Default] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzIotSecurityAnalytics cmdlet returns a set of security analytics of a specific iot security solution + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotSecurityAnalytics -ResourceGroupName "MyResourceGroup" -SolutionName "MySolution" -Default +``` + +```output +Id: "/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Security/iotSecuritySolutions/MySolution/analyticsModels/default" +Name: "default" +Type: "Microsoft.Security/IoTSecuritySolutionAnalyticsModel" +Metrics: { + High": 5 + Medium: 200 + Low: 102 + } +UnhealthyDeviceCount: 1200 +DevicesMetrics: [ + { + Date: "2019-02-01T00:00:00Z" + DevicesMetrics: { + High: 3 + Medium: 15 + Low: 70 + } + } + { + Date: "2019-02-02T00:00:00Z" + DevicesMetrics: { + High: 3 + Medium: 45 + Low: 65 + } + } + ] +TopAlertedDevices: [ + { + DeviceId: "id1" + AlertsCount: 200 + } + { + DeviceId": "id2" + AlertsCount": 170 + } + { + DeviceId": "id3" + AlertsCount": 150 + } + ] +MostPrevalentDeviceAlerts: [ + { + AlertDisplayName: "Custom Alert - number of device to cloud messages in AMQP protocol is not in the allowed range" + ReportedSeverity: "Low" + AlertsCount: 200 + } + { + AlertDisplayName: "Custom Alert - execution of a process that is not allowed" + ReportedSeverity: "Medium" + AlertsCount: 170 + } + { + AlertDisplayName": "Successful Bruteforce" + ReportedSeverity": "Low" + AlertsCount": 150 + } + ] +MostPrevalentDeviceRecommendations: [ + { + RecommendationDisplayName: "Install the Azure Security of Things Agent" + ReportedSeverity: "Low" + DevicesCount: 200 + } + { + RecommendationDisplayName: "High level permissions configured in Edge model twin for Edge module" + ReportedSeverity: "Low" + DevicesCount: 170 + } + { + RrecommendationDisplayName: "Same Authentication Credentials used by multiple devices" + ReportedSeverity: "Medium" + DevicesCount: 150 + } + ] + } + } +``` + +Get the deafult IoT Security Analytics for Security Solution "MySolution" in reasource group "MyResourceGroup" + +## PARAMETERS + +### -Default +If present, get the default analytics set, otherwise, get the list of all analytics sets. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionName +Solution name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutionAnalytics.PSIotSecuritySolutionAnalytics + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzIotSecurityAnalyticsAggregatedAlert.md b/azps-10.1.0/Az.Security/Get-AzIotSecurityAnalyticsAggregatedAlert.md new file mode 100644 index 0000000000..76cfeb35e9 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzIotSecurityAnalyticsAggregatedAlert.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzIotSecurityAnalyticsAggregatedAlert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzIotSecurityAnalyticsAggregatedAlert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzIotSecurityAnalyticsAggregatedAlert.md +--- + +# Get-AzIotSecurityAnalyticsAggregatedAlert + +## SYNOPSIS +Get IoT security aggregated alert + +## SYNTAX + +### SolutionScope (Default) +``` +Get-AzIotSecurityAnalyticsAggregatedAlert -ResourceGroupName <String> -SolutionName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SolutionLevelResource +``` +Get-AzIotSecurityAnalyticsAggregatedAlert -ResourceGroupName <String> -SolutionName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzIotSecurityAnalyticsAggregatedAlert cmdlet returns one or more aggregated alerts on devices of iot hub. +The name of the aggregated alerts is a combination of the alert type and the alert aggragted date, separated by '/'. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotSecurityAnalyticsAggregatedAlert -ResourceGroupName "MyResourceGroup" -SolutionName "MySolution" -Name "IoT_Bruteforce_Fail/2019-02-02" +``` + +```output +Id: "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Security/iotSecuritySolutions/MySolution/analyticsModels/default/aggregatedAlerts/IoT_Bruteforce_Fail/2019-02-02" +Name: "IoT_Bruteforce_Fail/2019-02-02" +Type: "Microsoft.Security/IoTSecurityAggregatedAlert" +AlertType: "IoT_Bruteforce_Fail" +AlertDisplayName: "Failed Bruteforce" +AggregatedDateUtc: "2019-02-02" +VendorName: "Microsoft" +ReportedSeverity: "Low" +RemediationSteps: "" +Description: "Multiple unsuccsseful login attempts identified. A Bruteforce attack on the device failed." +Count: 50 +EffectedResourceType: "IoT Device" +SystemSource: "Devices" +ActionTaken: "Detected" +LogAnalyticsQuery: "SecurityAlert | where tolower(ResourceId) == tolower('/subscriptions/b77ec8a9-04ed-48d2-a87a-e5887b978ba6/resourceGroups/IoT-Solution-DemoEnv/providers/Microsoft.Devices/IotHubs/rtogm-hub') and tolower(AlertName) == tolower('Custom Alert - number of device to cloud messages in MQTT protocol is not in the allowed range') | extend DeviceId=parse_json(ExtendedProperties)['DeviceId'] | project DeviceId, TimeGenerated, DisplayName, AlertSeverity, Description, RemediationSteps, ExtendedProperties" +TopDevicesList: [ + { + DeviceId: "testDevice1" + AlertsCount: 45 + LastOccurrence: "10:42" + } + { + DeviceId: "testDevice2" + AlertsCount: 30 + LastOccurrence: "15:42" + } + ] +``` + +Get the aggregated alert "IoT_Bruteforce_Fail/2019-02-02" (the name combined from the alert type and its aggregated date) in solution "MySolution" and resource group "MyResourceGroup" + +### Example 2 +```powershell +Get-AzIotSecurityAnalyticsAggregatedAlert -ResourceGroupName "MyResourceGroup" -SolutionName "MySolution" +``` + +```output +Array of aggregated alert items as shown in example 1 +``` + +Get a list of all aggregated alerts in solution "MySolution" and resource group "MyResourceGroup" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SolutionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionName +Solution name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutionAnalytics.PSIoTSecurityAggregatedAlert + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzIotSecurityAnalyticsAggregatedRecommendation.md b/azps-10.1.0/Az.Security/Get-AzIotSecurityAnalyticsAggregatedRecommendation.md new file mode 100644 index 0000000000..9fd259b241 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzIotSecurityAnalyticsAggregatedRecommendation.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzIotSecurityAnalyticsAggregatedRecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzIotSecurityAnalyticsAggregatedRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzIotSecurityAnalyticsAggregatedRecommendation.md +--- + +# Get-AzIotSecurityAnalyticsAggregatedRecommendation + +## SYNOPSIS +Get IoT security aggregated recommendation + +## SYNTAX + +### SolutionScope (Default) +``` +Get-AzIotSecurityAnalyticsAggregatedRecommendation -ResourceGroupName <String> -SolutionName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SolutionLevelResource +``` +Get-AzIotSecurityAnalyticsAggregatedRecommendation -ResourceGroupName <String> -SolutionName <String> + -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzIotSecurityAnalyticsAggregatedAlert cmdlet returns one or more aggregated recommendations on devices of iot hub. +The name of an aggregated recommendation is its type + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotSecurityAnalyticsAggregatedRecommendation -ResourceGroupName "MyResourceGroup" -SolutionName "MySolution" -Name IoT_OpenPorts +``` + +```output +Id: "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Security/iotSecuritySolutions/MySolution/analyticsModels/default/aggregatedRecommendations/IoT_OpenPorts" +Name: "IoT_OpenPorts" +Type: "Microsoft.Security/IoTSecurityAggregatedRecommendation" +RecommendationName: "IoT_OpenPorts" +RecommendationDisplayName: "Device has open ports" +RecommendationTypeId: "" +DetectedBy: "IoTSecurity" +HealthyDevices: -1 +UnhealthyDeviceCount: 5 +RemediationSteps: "Review open ports on the device and make sure they belong to legitimate and necessary processes for the device to function correctly." +ReportedSeverity: "Medium" +Description: "Found a listening endpoint on the device." +LogAnalyticsQuery: "SecurityRecommendation | where tolower(AssessedResourceId) == tolower('/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourcegroups/iot-hub-demo/providers/microsoft.devices/iothubs/ascforiot-demo') and tolower(RecommendationName) == tolower('IoT_OpenPorts') and TimeGenerated < now()" +``` + +Get the aggregated recommendation "IoT_OpenPorts" in security solution "MySolution" and resource group "MyResourceGroup" + +### Example 2 +```powershell +Get-AzIotSecurityAnalyticsAggregatedRecommendation -ResourceGroupName "MyResourceGroup" -SolutionName "MySolution" +``` + +```output +Array of aggregated recommendation items as shown in example 1 +``` + +Get a list of aggregated recommendations in security solution "MySolution" and resource group "MyResourceGroup" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SolutionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionName +Solution name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutionAnalytics.PSIoTSecurityAggregatedRecommendation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzIotSecuritySolution.md b/azps-10.1.0/Az.Security/Get-AzIotSecuritySolution.md new file mode 100644 index 0000000000..f2f7d94ff1 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzIotSecuritySolution.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzIotSecuritySolution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzIotSecuritySolution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzIotSecuritySolution.md +--- + +# Get-AzIotSecuritySolution + +## SYNOPSIS +Get IoT security solution + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzIotSecuritySolution [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupScope +``` +Get-AzIotSecuritySolution -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceGroupLevelResource +``` +Get-AzIotSecuritySolution -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzIotSecuritySolution -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzIotSecuritySolution cmdlet returns one or more iot security solutions. +The IoT security solution collects security data and events from iot devices and iot hub to help prevent and detect threats. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzIotSecuritySolution -Name "MySample" -ResourceGroupName "MyResourceGroup" +``` + +```output +Id: "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Security/IoTSecuritySolutions/MySample" +Name: "MySample" +Type: "Microsoft.Security/IoTSecuritySolutions" +Location: "centraluseuap" +DisplayName: "MySample" +status: "Enabled" +Export: ["RawEvents"] +DisabledDataSources: ["TwinData"] +Workspace: "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourcegroups/MyResourceGroup/providers/microsoft.operationalinsights/workspaces/MyLA" +AdditionalWorkspaces: null +IotHubs: ["/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourcegroups/MyResourceGroup/providers/microsoft.devices/iothubs/MySample"] +UserDefinedResources: { + Query: "" + QuerySubscriptions: [] +} +RecommendationsConfiguration: [ +{ + RecommendationType: "IoT_ACRAuthentication" + Name: "Service prinicpal not used with ACR repository" + Status: "Enabled" +} +{ + RecommendationType: "IoT_AgentSendsUnutilizedMessages" + Name: "Agent sending underutilized messages" + Status: "Enabled" + }] +AutoDiscoveredResources: ["/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourcegroups/MyResourceGroup/providers/microsoft.devices/iothubs/MySample"] +UnmaskedIpLoggingStatus: "Enabled" +Tags: {} +``` + +Get the solution "MySample" in resource group "MyResourceGroup" + +### Example 2 +```powershell +Get-AzIotSecuritySolution -ResourceGroupName "MyResourceGroup" +``` + +```output +Array of security solution items as shown is example 1 +``` + +Get list of all security solutions in resource group "MyResourceGroup" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupScope, ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSIotSecuritySolution + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzJitNetworkAccessPolicy.md b/azps-10.1.0/Az.Security/Get-AzJitNetworkAccessPolicy.md new file mode 100644 index 0000000000..893d07fe00 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzJitNetworkAccessPolicy.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzJitNetworkAccessPolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzJitNetworkAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzJitNetworkAccessPolicy.md +--- + +# Get-AzJitNetworkAccessPolicy + +## SYNOPSIS +Gets the JIT network access policies + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzJitNetworkAccessPolicy [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupScope +``` +Get-AzJitNetworkAccessPolicy -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceGroupLevelResource +``` +Get-AzJitNetworkAccessPolicy -ResourceGroupName <String> -Location <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzJitNetworkAccessPolicy -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Just In Time (JIT) network access policies let you define a policy the will allow simple users to create a temporary network connection to a VM. +The policy defines what ports, protocol and source IP addresses can request a connection to a VM and the max duration before the connection will be closed automatically. +In the policy you can also see the connection request that were made with this policy. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzJitNetworkAccessPolicy +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/jitNetworkAccessPolicies/default +Name : default +Kind : Basic +VirtualMachines : {/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/testService} +Requests : {Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyRequest} +ProvisioningState : Succeeded + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/northeurope/jitNetworkAccessPolicies/default +Name : default +Kind : Basic +VirtualMachines : {/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/testService} +Requests : {Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyRequest} +ProvisioningState : Succeeded +``` + +Get all the JIT network access polices on a subscription + +### Example 2 +```powershell +Get-AzJitNetworkAccessPolicy -ResourceGroupName "myService1" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/jitNetworkAccessPolicies/default +Name : default +Kind : Basic +VirtualMachines : {/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/testService} +Requests : {Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyRequest} +ProvisioningState : Succeeded + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/northeurope/jitNetworkAccessPolicies/default +Name : default +Kind : Basic +VirtualMachines : {/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/testService} +Requests : {Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyRequest} +ProvisioningState : Succeeded +``` + +Get all the JIT network access polices on the "myService1" resource group + +### Example 3 +```powershell +Get-AzJitNetworkAccessPolicy -ResourceGroupName "myService1" -Location "centralus" -Name "default" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/jitNetworkAccessPolicies/default +Name : default +Kind : Basic +VirtualMachines : {/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/testService} +Requests : {Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyRequest} +ProvisioningState : Succeeded +``` + +Gets a specific JIT network access policy + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupScope, ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the jit Network Access Policy resource. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzRegulatoryComplianceAssessment.md b/azps-10.1.0/Az.Security/Get-AzRegulatoryComplianceAssessment.md new file mode 100644 index 0000000000..2d5ceb2392 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzRegulatoryComplianceAssessment.md @@ -0,0 +1,279 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzRegulatoryComplianceAssessment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzRegulatoryComplianceAssessment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzRegulatoryComplianceAssessment.md +--- + +# Get-AzRegulatoryComplianceAssessment + +## SYNOPSIS +Gets regulatory compliance assessments + +## SYNTAX + +### SubscriptionLevelResource (Default) +``` +Get-AzRegulatoryComplianceAssessment [-Name <String>] -StandardName <String> -ControlName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzRegulatoryComplianceAssessment -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a spcific assessment details or list all the assessments under specific control and regulatory compliance standard. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRegulatoryComplianceAssessment -StandardName "SOC TSP" -ControlName "CC5.8" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComp + lianceStandards/SOC-TSP/regulatoryComplianceControls/CC5.8/regulatoryComplianceAssessments/0392 + b393-395e-42bf-ba60-8d99efc4d2d4 +Name : 0392b393-395e-42bf-ba60-8d99efc4d2d4 +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls/regulatoryComplia + nceAssessments +Description : [CCE-10596-5] Deny log on as a batch job (Windows Server 2008 R2 Datacenter) +AssessmentType : RuleResult +AssessmentDetailsLink : +State : Passed +PassedResources : 2 +FailedResources : 0 +SkippedResources : 0 + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComp + lianceStandards/SOC-TSP/regulatoryComplianceControls/CC5.8/regulatoryComplianceAssessments/04c8 + 24de-a93c-49cf-bb22-997cdff9e9fc +Name : 04c824de-a93c-49cf-bb22-997cdff9e9fc +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls/regulatoryComplia + nceAssessments +Description : [CCE-24406-1] Allow log on through Remote Desktop Services (Windows Server 2012 Datacenter) +AssessmentType : RuleResult +AssessmentDetailsLink : +State : Passed +PassedResources : 2 +FailedResources : 0 +SkippedResources : 0 + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComp + lianceStandards/SOC-TSP/regulatoryComplianceControls/CC5.8/regulatoryComplianceAssessments/04e7 + 147b-0deb-9796-2e5c-0336343ceb3d +Name : 04e7147b-0deb-9796-2e5c-0336343ceb3d +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls/regulatoryComplia + nceAssessments +Description : External accounts with write permissions should be removed from your subscription +AssessmentType : AssessmentResult +AssessmentDetailsLink : +State : Passed +PassedResources : 1 +FailedResources : 0 +SkippedResources : 0 + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComp + lianceStandards/SOC-TSP/regulatoryComplianceControls/CC5.8/regulatoryComplianceAssessments/0515 + 45a4-179e-4c04-9e9b-8f33821ef36f +Name : 051545a4-179e-4c04-9e9b-8f33821ef36f +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls/regulatoryComplia + nceAssessments +Description : [CCE-37659-0] Configure 'Allow log on locally' (Windows Server 2016 Datacenter) +AssessmentType : RuleResult +AssessmentDetailsLink : +State : Failed +PassedResources : 1 +FailedResources : 1 +SkippedResources : 0 + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComp + lianceStandards/SOC-TSP/regulatoryComplianceControls/CC5.8/regulatoryComplianceAssessments/101e + af81-3dd3-4867-8871-f649131a06a9 +Name : 101eaf81-3dd3-4867-8871-f649131a06a9 +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls/regulatoryComplia + nceAssessments +Description : [CCE-38028-7] Audit Policy: Policy Change: Audit Policy Change (Windows Server 2012 R2 + Datacenter) +AssessmentType : RuleResult +AssessmentDetailsLink : +State : Passed +PassedResources : 2 +FailedResources : 0 +SkippedResources : 0 + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComp + lianceStandards/SOC-TSP/regulatoryComplianceControls/CC5.8/regulatoryComplianceAssessments/103d + e8e8-643e-4b0e-b4a4-a85830239a53 +Name : 103de8e8-643e-4b0e-b4a4-a85830239a53 +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls/regulatoryComplia + nceAssessments +Description : [CCE-37133-6] Ensure 'Audit Account Lockout' is set to 'Success and Failure' (Windows Server + 2016 Datacenter) +AssessmentType : RuleResult +AssessmentDetailsLink : +State : Failed +PassedResources : 1 +FailedResources : 1 +SkippedResources : 0 + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComp + lianceStandards/SOC-TSP/regulatoryComplianceControls/CC5.8/regulatoryComplianceAssessments/107b + 8424-7ee8-4b6a-a859-b5256aa6596e +Name : 107b8424-7ee8-4b6a-a859-b5256aa6596e +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls/regulatoryComplia + nceAssessments +Description : [CCE-37853-9] Audit Policy: System: IPsec Driver (Windows Server 2012 R2 Datacenter) +AssessmentType : RuleResult +AssessmentDetailsLink : +State : Passed +PassedResources : 2 +FailedResources : 0 +SkippedResources : 0 +``` + +Get all assessments under specific control and standard. + +### Example 2 +```powershell +Get-AzRegulatoryComplianceAssessment -StandardName "SOC TSP" -ControlName "CC5.8" -Name "fe48038b-f73a-4264-b499-0ff9dfaab05c" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComp + lianceStandards/SOC-TSP/regulatoryComplianceControls/CC5.8/regulatoryComplianceAssessments/fe48 + 038b-f73a-4264-b499-0ff9dfaab05c +Name : fe48038b-f73a-4264-b499-0ff9dfaab05c +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls/regulatoryComplia + nceAssessments +Description : [CCE-24187-7] Audit Policy: Logon-Logoff: Special Logon (Windows Server 2012 Datacenter) +AssessmentType : RuleResult +AssessmentDetailsLink : +State : Passed +PassedResources : 2 +FailedResources : 0 +SkippedResources : 0 +``` + +Get a specific assessment under specific control and standard according to assessment id. + +### Example 3 +```powershell +Get-AzRegulatoryComplianceAssessment -ResourceId "/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComplianceStandards/SOC-TSP/regulatoryComplianceControls/CC5.8/regulatoryComplianceAssessments/fe48038b-f73a-4264-b499-0ff9dfaab05c" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComp + lianceStandards/SOC-TSP/regulatoryComplianceControls/CC5.8/regulatoryComplianceAssessments/fe48 + 038b-f73a-4264-b499-0ff9dfaab05c +Name : fe48038b-f73a-4264-b499-0ff9dfaab05c +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls/regulatoryComplia + nceAssessments +Description : [CCE-24187-7] Audit Policy: Logon-Logoff: Special Logon (Windows Server 2012 Datacenter) +AssessmentType : RuleResult +AssessmentDetailsLink : +State : Passed +PassedResources : 2 +FailedResources : 0 +SkippedResources : 0 +``` + +Get a specific assessment under specific control and standard according to resource id. + +## PARAMETERS + +### -ControlName +Control Name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Assessment Id. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StandardName +Standard Name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.SecurityCenter.Models.RegulatoryCompliance.PSSecurityRegulatoryComplianceAssessment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzRegulatoryComplianceControl.md b/azps-10.1.0/Az.Security/Get-AzRegulatoryComplianceControl.md new file mode 100644 index 0000000000..c1379c26b2 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzRegulatoryComplianceControl.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzRegulatoryComplianceControl +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzRegulatoryComplianceControl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzRegulatoryComplianceControl.md +--- + +# Get-AzRegulatoryComplianceControl + +## SYNOPSIS +Gets regulatory compliance controls + +## SYNTAX + +### SubscriptionLevelResource (Default) +``` +Get-AzRegulatoryComplianceControl [-Name <String>] -StandardName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzRegulatoryComplianceControl -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a spcific control details or list all the controls under specific regulatory compliance standard. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRegulatoryComplianceControl -StandardName "SOC TSP" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComplia + nceStandards/SOC-TSP/regulatoryComplianceControls/A1.1 +Name : A1.1 +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls +Description : Current processing capacity and usage are maintained, monitored, and evaluated to manage capacity + demand and to enable the implementation of additional capacity to help meet the entity�s + availability commitments and system requirements. +State : Unsupported +PassedAssessments : 0 +FailedAssessments : 0 +SkippedAssessments : 0 + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComplia + nceStandards/SOC-TSP/regulatoryComplianceControls/A1.2 +Name : A1.2 +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls +Description : Environmental protections, software, data backup processes, and recovery infrastructure are + designed, developed, implemented, operated, maintained, and monitored to meet availability + commitments and requirements. +State : Passed +PassedAssessments : 3 +FailedAssessments : 0 +SkippedAssessments : 0 + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComplia + nceStandards/SOC-TSP/regulatoryComplianceControls/A1.3 +Name : A1.3 +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls +Description : Recovery plan procedures supporting system recovery are tested to help meet the entity�s + availability commitments and system requirements. +State : Unsupported +PassedAssessments : 0 +FailedAssessments : 0 +SkippedAssessments : 0 + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComplia + nceStandards/SOC-TSP/regulatoryComplianceControls/C1.1 +Name : C1.1 +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls +Description : Confidential information is protected during the system design, development, testing, + implementation, and change processes in accordance with confidentiality commitments and + requirements. +State : Unsupported +PassedAssessments : 0 +FailedAssessments : 0 +SkippedAssessments : 0 +``` + +Get all controls under specific regulatory standard. + +### Example 2 +```powershell +Get-AzRegulatoryComplianceControl -StandardName "SOC TSP" -Name "C1.2" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComplia + nceStandards/SOC-TSP/regulatoryComplianceControls/C1.2 +Name : C1.2 +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls +Description : Confidential information within the boundaries of the system is protected against unauthorized + access, use, and disclosure during input, processing, retention, output, and disposition in + accordance with confidentiality commitments and requirements. +State : Failed +PassedAssessments : 177 +FailedAssessments : 22 +SkippedAssessments : 0 +``` + +Get specific control details according to control id. + +### Example 3 +```powershell +Get-AzRegulatoryComplianceControl -ResourceId "/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComplianceStandards/SOC-TSP/regulatoryComplianceControls/C1.2" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComplia + nceStandards/SOC-TSP/regulatoryComplianceControls/C1.2 +Name : C1.2 +Type : Microsoft.Security/regulatoryComplianceStandards/regulatoryComplianceControls +Description : Confidential information within the boundaries of the system is protected against unauthorized + access, use, and disclosure during input, processing, retention, output, and disposition in + accordance with confidentiality commitments and requirements. +State : Failed +PassedAssessments : 177 +FailedAssessments : 22 +SkippedAssessments : 0 +``` + +Get specific control details according to resource id. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Control Id. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StandardName +Standard Name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.SecurityCenter.Models.RegulatoryCompliance.PSSecurityRegulatoryComplianceControl + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzRegulatoryComplianceStandard.md b/azps-10.1.0/Az.Security/Get-AzRegulatoryComplianceStandard.md new file mode 100644 index 0000000000..7718672078 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzRegulatoryComplianceStandard.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzRegulatoryComplianceStandard +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzRegulatoryComplianceStandard.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzRegulatoryComplianceStandard.md +--- + +# Get-AzRegulatoryComplianceStandard + +## SYNOPSIS +Gets regulatory compliance standards + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzRegulatoryComplianceStandard [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzRegulatoryComplianceStandard -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzRegulatoryComplianceStandard -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a specific regulatory compliance standard details or list all regulatory compliance standards under a specific subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzRegulatoryComplianceStandard +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryCompli + anceStandards/Azure-CIS-1.1.0 +Name : Azure-CIS-1.1.0 +Type : Microsoft.Security/regulatoryComplianceStandards +State : Failed +PassedControls : 20 +FailedControls : 4 +SkippedControls : 0 +UnsupportedControls : 87 + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryCompli + anceStandards/ISO-27001 +Name : ISO-27001 +Type : Microsoft.Security/regulatoryComplianceStandards +State : Failed +PassedControls : 9 +FailedControls : 10 +SkippedControls : 2 +UnsupportedControls : 93 + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryCompli + anceStandards/PCI-DSS-3.2.1 +Name : PCI-DSS-3.2.1 +Type : Microsoft.Security/regulatoryComplianceStandards +State : Failed +PassedControls : 13 +FailedControls : 32 +SkippedControls : 0 +UnsupportedControls : 187 + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryCompli + anceStandards/SOC-TSP +Name : SOC-TSP +Type : Microsoft.Security/regulatoryComplianceStandards +State : Failed +PassedControls : 2 +FailedControls : 11 +SkippedControls : 0 +UnsupportedControls : 24 +``` + +Get all regulatory compliance standards under a subscription. + +### Example 2 +```powershell +Get-AzRegulatoryComplianceStandard -Name "SOC-TSP" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryCompli + anceStandards/SOC-TSP +Name : SOC-TSP +Type : Microsoft.Security/regulatoryComplianceStandards +State : Failed +PassedControls : 2 +FailedControls : 11 +SkippedControls : 0 +UnsupportedControls : 24 +``` + +Get details of specific regulatory compliance standard according standard name. + +### Example 3 +```powershell +Get-AzRegulatoryComplianceStandard -ResourceId "/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryComplianceStandards/SOC-TSP" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/regulatoryCompli + anceStandards/SOC-TSP +Name : SOC-TSP +Type : Microsoft.Security/regulatoryComplianceStandards +State : Failed +PassedControls : 2 +FailedControls : 11 +SkippedControls : 0 +UnsupportedControls : 24 +``` + +Get details of specific regulatory compliance standard according resource id. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Standard name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.SecurityCenter.Models.RegulatoryCompliance.PSSecurityRegulatoryComplianceStandard + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityAdaptiveApplicationControl.md b/azps-10.1.0/Az.Security/Get-AzSecurityAdaptiveApplicationControl.md new file mode 100644 index 0000000000..32265b035e --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityAdaptiveApplicationControl.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityAdaptiveApplicationControl +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAdaptiveApplicationControl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAdaptiveApplicationControl.md +--- + +# Get-AzSecurityAdaptiveApplicationControl + +## SYNOPSIS +Gets a list of application control VM/server groups for the subscription. + +## SYNTAX + +``` +Get-AzSecurityAdaptiveApplicationControl [-SubscriptionId <String>] [-IncludePathRecommendation <Boolean>] + [-Summary <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Adaptive Application Controls are automatically calculated by Azure Security Center, use this cmdlet to get a list of Adaptive Application Controls resources in the scope of a subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityAdaptiveApplicationControl +``` + +```output +Id : /subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/GROUP2 +Name : GROUP2 +Type : Microsoft.Security/applicationWhitelistings +Location : centralus +Properties : Microsoft.Azure.Commands.SecurityCenter.Models.AdaptiveApplicationControls.PSSecurityAdaptiveApplicationControlsProperties + +Id : /subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/GROUP3 +Name : GROUP3 +Type : Microsoft.Security/applicationWhitelistings +Location : centralus +Properties : Microsoft.Azure.Commands.SecurityCenter.Models.AdaptiveApplicationControls.PSSecurityAdaptiveApplicationControlsProperties + +Id : /subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/GROUP4 +Name : GROUP5 +Type : Microsoft.Security/applicationWhitelistings +Location : centralus +Properties : Microsoft.Azure.Commands.SecurityCenter.Models.AdaptiveApplicationControls.PSSecurityAdaptiveApplicationControlsProperties +``` + +Gets a list of application control VM/server groups for the subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePathRecommendation +Include the policy rules + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Summary +Return output in a summarized form. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AdaptiveApplicationControls.PSSecurityAdaptiveApplicationControls + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityAdaptiveApplicationControlGroup.md b/azps-10.1.0/Az.Security/Get-AzSecurityAdaptiveApplicationControlGroup.md new file mode 100644 index 0000000000..3df14bae00 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityAdaptiveApplicationControlGroup.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityAdaptiveApplicationControlGroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAdaptiveApplicationControlGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAdaptiveApplicationControlGroup.md +--- + +# Get-AzSecurityAdaptiveApplicationControlGroup + +## SYNOPSIS +Gets an application control VM/server group. + +## SYNTAX + +``` +Get-AzSecurityAdaptiveApplicationControlGroup -GroupName <String> -AscLocation <String> + [-SubscriptionId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Adaptive Application Controls are automatically calculated by Azure Security Center, use this cmdlet to get an application control VM/server group. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityAdaptiveApplicationControlGroup -GroupName GROUP1 -AscLocation centralus +``` + +```output +Id : /subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/providers/Microsoft.Security/locations/centralus/applicationWhitelistings/GROUP1 +Name : GROUP1 +Type : Microsoft.Security/applicationWhitelistings +Location : centralus +Properties : Microsoft.Azure.Commands.SecurityCenter.Models.AdaptiveApplicationControls.PSSecurityAdaptiveApplicationControlsProperties +``` + +Gets an application control VM/server group. + +## PARAMETERS + +### -AscLocation +The location where ASC stores the data of the subscription. can be retrieved from Get locations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Name of an application control VM/server group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AdaptiveApplicationControls.PSSecurityAdaptiveApplicationControls + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityAdaptiveNetworkHardening.md b/azps-10.1.0/Az.Security/Get-AzSecurityAdaptiveNetworkHardening.md new file mode 100644 index 0000000000..94be36e9e9 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityAdaptiveNetworkHardening.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityAdaptiveNetworkHardening +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAdaptiveNetworkHardening.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAdaptiveNetworkHardening.md +--- + +# Get-AzSecurityAdaptiveNetworkHardening + +## SYNOPSIS +Gets a list of Adaptive Network Hardenings resources in scope of an extended resource. + +## SYNTAX + +``` +Get-AzSecurityAdaptiveNetworkHardening [-AdaptiveNetworkHardeningResourceName <String>] + -ResourceGroupName <String> -ResourceName <String> -ResourceNamespace <String> -ResourceType <String> + [-SubscriptionId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Adaptive Network Hardenings are automatically calculated by Azure Security Center, use this cmdlet to get a list of Adaptive Network Hardenings resources in scope of an extended resource. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityAdaptiveNetworkHardening -ResourceGroupName myService1 -ResourceName myResource1 -ResourceNamespace Microsoft.Compute -ResourceType virtualMachines -SubscriptionId 3eeab341-f466-499c-a8be-85427e154baf7612f869 +``` + +```output +Id Name Type Properties +-- ---- ---- ---------- +/subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/myResource1/providers/Microsoft.Security/adaptiveNetworkHardenings/default default Microsoft.Security/adaptiveNetworkHardenings Microsoft.Azure.Commands.SecurityCenter.Models… +``` + +Gets a list of Adaptive Network Hardenings resources in scope of an extended resource. + +### Example 2 +```powershell +Get-AzSecurityAdaptiveNetworkHardening -AdaptiveNetworkHardeningResourceName default -ResourceGroupName myService1 -ResourceName myResource1 -ResourceNamespace Microsoft.Compute -ResourceType virtualMachines -SubscriptionId 3eeab341-f466-499c-a8be-85427e154baf7612f869 +``` + +```output +Id Name Type Properties +-- ---- ---- ---------- +/subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/myResource1/providers/Microsoft.Security/adaptiveNetworkHardenings/default default Microsoft.Security/adaptiveNetworkHardenings Microsoft.Azure.Commands.SecurityCenter.Models… +``` + +Get a single Adaptive Network Hardenings resource + +## PARAMETERS + +### -AdaptiveNetworkHardeningResourceName +The name of the Adaptive Network Hardening resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +Resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceNamespace +The Namespace of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +The type of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AdaptiveNetworkHardenings.PSSecurityAdaptiveNetworkHardenings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityAdvancedThreatProtection.md b/azps-10.1.0/Az.Security/Get-AzSecurityAdvancedThreatProtection.md new file mode 100644 index 0000000000..3b49a46018 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityAdvancedThreatProtection.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/get-azsecurityadvancedthreatprotection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAdvancedThreatProtection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAdvancedThreatProtection.md +--- + +# Get-AzSecurityAdvancedThreatProtection + +## SYNOPSIS +Gets the advanced threat protection policy for a storage / cosmosDB account. + +## SYNTAX + +``` +Get-AzSecurityAdvancedThreatProtection -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The `Get-AzSecurityAdvancedThreatProtection` cmdlet gets the threat protection policy for a storage / cosmosDB account. +To use this cmdlet, specify the *ResourceId* parameter. + +## EXAMPLES + +### Example 1: Storage Account +```powershell +Get-AzSecurityAdvancedThreatProtection -ResourceId "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount/" +``` + +```output +IsEnabled Id +--------- -- + False "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount/" +``` + +This command gets the advanced threat protection policy for resource id `"/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount/"`. + +### Example 2: CosmosDB Account +```powershell +Get-AzSecurityAdvancedThreatProtection -ResourceId "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDb/databaseAccounts/myCosmosDBAccount/" +``` + +```output +IsEnabled Id +--------- -- + True "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDb/databaseAccounts/myCosmosDBAccount/" +``` + +This command gets the advanced threat protection policy for resource id ` "/subscriptions/xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDb/databaseAccounts/myCosmosDBAccount/"`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AdvancedThreatProtection.PSAdvancedThreatProtection + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityAlert.md b/azps-10.1.0/Az.Security/Get-AzSecurityAlert.md new file mode 100644 index 0000000000..bd9a1e267e --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityAlert.md @@ -0,0 +1,446 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityAlert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAlert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAlert.md +--- + +# Get-AzSecurityAlert + +## SYNOPSIS +Gets security alerts that were detected by Azure Security Center + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecurityAlert [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupScope +``` +Get-AzSecurityAlert -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupLevelResource +``` +Get-AzSecurityAlert -ResourceGroupName <String> -Name <String> -Location <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecurityAlert -Name <String> -Location <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzSecurityAlert -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets security alerts that were detected by Azure Security Center + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityAlert +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/RSG/providers/Microsoft.Securit + y/locations/centralus/alerts/2518710774294070750_FFF23C70-80EF-4A8B-9122-507B0EA8DFFF +Name : 2518710774294070750_FFF23C70-80EF-4A8B-9122-507B0EA8DFFF +ActionTaken : Undefined +AlertDisplayName : PREVIEW - Vulnerability scanner detected +AlertName : APPS_WpScanner +AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/RSG/providers/Microsoft.Web/sit + es/testSite1 +CanBeInvestigated : True +CompromisedEntity : testSite1 +ConfidenceReasons : {} +ConfidenceScore : +Description : Azure App Services activity log indicates a possible vulnerability scanner usage on your App + Service resource. + The suspicious activity detected resembles that of tools targeting WordPress applications. +DetectedTimeUtc : 10/07/2018 11:49:30 +Entities : {} +ExtendedProperties : {[sample User Agents, WPScan+v2.9.3+(http://wpscan.org)], [last Event Time, 6/23/2018 12:18:58 + AM], [sample URIs, /wp-config.php.original, /wp-includes/css/editor.min.css, + /wp-includes/js/wp-emoji.js, /wp-config.old, /xmlrpc.php, /wp-admin/css/wp-admin-rtl.css, + /#wp-config.php#, /wp-includes/js/tinymce/plugins/wplink/plugin.js, + /wp-includes/js/tinymce/plugins/wordpress/editor_plugin.js, /wp-admin/js/post.js], [sample + Referer, https://www.stone.com.br/]...} +InstanceId : fff23c70-80ef-4a8b-9122-507b0ea8dfff +RemediationSteps : 1. If WordPress is installed, make sure that the application is up to date and automatic updates + are enabled. + 2. If only specific IPs should access to the web application, use IP Restrictions + (https://learn.microsoft.com/azure/app-service/app-service-ip-restrictions). +ReportedSeverity : High +ReportedTimeUtc : 10/07/2018 16:31:52 +State : Active +SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 +SystemSource : +VendorName : Microsoft +WorkspaceArmId : + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/locations/central + us/alerts/2518710774894070750_EEE23C70-80EF-4A8B-9122-507B0EA8DFFF +Name : 2518710774894070750_EEE23C70-80EF-4A8B-9122-507B0EA8DFFF +ActionTaken : Undefined +AlertDisplayName : PREVIEW - Spam folder referrer detected +AlertName : APPS_SpamReferrer +AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Web/sites/testSite2 +CanBeInvestigated : True +CompromisedEntity : testSite2 +ConfidenceReasons : {} +ConfidenceScore : +Description : Azure App Services activity log indicates web activity that was identified as originating from a + web site associated with SPAM activity. + This could occur if your web site is compromised and used for spam activity. +DetectedTimeUtc : 10/07/2018 11:48:30 +Entities : {} +ExtendedProperties : {[sample User Agents, Mozilla/4.0+(compatible;+MSIE+6.0;+Windows+NT+5.1)], [last Event Time, + 6/23/2018 4:53:58 PM], [sample URIs, /acropolis.php, /wp-content/animator.php, /bandpass.php, + /wp-content/base.php, /candid.php, /wp-content/uploads/2018/christina.php, + /wp-content/climax.php, /wp-content/uploads/conditioning.php, /wp-content/corkscrew.php, + /wp-content/uploads/2018/countermeasures.php], [sample Referer, + https://google.com/mail/inbox/spam/]...} +InstanceId : eee23c70-80ef-4a8b-9122-507b0ea8dfff +RemediationSteps : Review the URIs in the alert details. Check whether the corresponding files contain malicious or + suspicious content. + If they do, escalate the alert to the information security team. +ReportedSeverity : High +ReportedTimeUtc : 10/07/2018 16:31:52 +State : Active +SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 +SystemSource : +VendorName : Microsoft +WorkspaceArmId : + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Security/locations/westeurope/alerts/2518675199999999999_0501972d-06cd-47c7-a276-036f67d89262 +Name : 2518675199999999999_0501972d-06cd-47c7-a276-036f67d89262 +ActionTaken : Detected +AlertDisplayName : PROTOCOL-ENFORCEMENT +AlertName : PROTOCOL-ENFORCEMENT +AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Network/applicationGateways/ContosoWAF +CanBeInvestigated : True +CompromisedEntity : 10.1.0.4 +ConfidenceReasons : {} +ConfidenceScore : +Description : Detail:Host header is a numeric IP address 13.69.131.117:80 +DetectedTimeUtc : 20/08/2018 16:00:00 +Entities : {} +ExtendedProperties : {[hit Count, 1], [source IPs, 177.189.28.238], [management URL, https://portal.azure.com#resource/ + subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.N + etwork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} +InstanceId : 0501972d-06cd-47c7-a276-036f67d89262 +RemediationSteps : +ReportedSeverity : Low +ReportedTimeUtc : 20/08/2018 17:00:18 +State : Active +SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 +SystemSource : Azure +VendorName : Microsoft WAF +WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid + ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 + -eus + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Security/locations/westeurope/alerts/2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 +Name : 2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 +ActionTaken : Detected +AlertDisplayName : PROTOCOL-ENFORCEMENT +AlertName : PROTOCOL-ENFORCEMENT +AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Network/applicationGateways/ContosoWAF +CanBeInvestigated : True +CompromisedEntity : 10.1.0.4 +ConfidenceReasons : {} +ConfidenceScore : +Description : Detail:Host header is a numeric IP address 13.69.131.117 +DetectedTimeUtc : 20/08/2018 15:00:00 +Entities : {} +ExtendedProperties : {[hit Count, 1], [source IPs, 217.91.251.86], [management URL, https://portal.azure.com#resource/s + ubscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Ne + twork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} +InstanceId : 0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 +RemediationSteps : +ReportedSeverity : Low +ReportedTimeUtc : 20/08/2018 16:00:03 +State : Active +SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 +SystemSource : Azure +VendorName : Microsoft WAF +WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid + ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 + -eus +``` + +Gets all the security alerts that were detected on resources inside a subscription + +### Example 2 +```powershell +Get-AzSecurityAlert -ResourceGroupName "myService1" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Security/locations/westeurope/alerts/2518675199999999999_0501972d-06cd-47c7-a276-036f67d89262 +Name : 2518675199999999999_0501972d-06cd-47c7-a276-036f67d89262 +ActionTaken : Detected +AlertDisplayName : PROTOCOL-ENFORCEMENT +AlertName : PROTOCOL-ENFORCEMENT +AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Network/applicationGateways/ContosoWAF +CanBeInvestigated : True +CompromisedEntity : 10.1.0.4 +ConfidenceReasons : {} +ConfidenceScore : +Description : Detail:Host header is a numeric IP address 13.69.131.117:80 +DetectedTimeUtc : 20/08/2018 16:00:00 +Entities : {} +ExtendedProperties : {[hit Count, 1], [source IPs, 177.189.28.238], [management URL, https://portal.azure.com#resource/ + subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.N + etwork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} +InstanceId : 0501972d-06cd-47c7-a276-036f67d89262 +RemediationSteps : +ReportedSeverity : Low +ReportedTimeUtc : 20/08/2018 17:00:18 +State : Active +SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 +SystemSource : Azure +VendorName : Microsoft WAF +WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid + ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 + -eus + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Security/locations/westeurope/alerts/2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 +Name : 2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 +ActionTaken : Detected +AlertDisplayName : PROTOCOL-ENFORCEMENT +AlertName : PROTOCOL-ENFORCEMENT +AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Network/applicationGateways/ContosoWAF +CanBeInvestigated : True +CompromisedEntity : 10.1.0.4 +ConfidenceReasons : {} +ConfidenceScore : +Description : Detail:Host header is a numeric IP address 13.69.131.117 +DetectedTimeUtc : 20/08/2018 15:00:00 +Entities : {} +ExtendedProperties : {[hit Count, 1], [source IPs, 217.91.251.86], [management URL, https://portal.azure.com#resource/s + ubscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Ne + twork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} +InstanceId : 0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 +RemediationSteps : +ReportedSeverity : Low +ReportedTimeUtc : 20/08/2018 16:00:03 +State : Active +SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 +SystemSource : Azure +VendorName : Microsoft WAF +WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid + ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 + -eus + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Security/locations/westeurope/alerts/2518675235999999999_3cc2c984-3d3d-4af2-a2d9-ed7c6d078315 +Name : 2518675235999999999_3cc2c984-3d3d-4af2-a2d9-ed7c6d078315 +ActionTaken : Detected +AlertDisplayName : PROTOCOL-ENFORCEMENT +AlertName : PROTOCOL-ENFORCEMENT +AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Network/applicationGateways/ContosoWAF +CanBeInvestigated : True +CompromisedEntity : 10.1.0.5 +ConfidenceReasons : {} +ConfidenceScore : +Description : Detail:Host header is a numeric IP address 13.69.131.117 +DetectedTimeUtc : 20/08/2018 15:00:00 +Entities : {} +ExtendedProperties : {[hit Count, 1], [source IPs, 217.91.251.86], [management URL, https://portal.azure.com#resource/s + ubscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Ne + twork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} +InstanceId : 3cc2c984-3d3d-4af2-a2d9-ed7c6d078315 +RemediationSteps : +ReportedSeverity : Low +ReportedTimeUtc : 20/08/2018 16:00:04 +State : Active +SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 +SystemSource : Azure +VendorName : Microsoft WAF +WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid + ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 + -eus + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Security/locations/westeurope/alerts/2518675307999999999_bbbda0ad-b149-49f4-a4ba-3e95540cbf1c +Name : 2518675307999999999_bbbda0ad-b149-49f4-a4ba-3e95540cbf1c +ActionTaken : Detected +AlertDisplayName : PROTOCOL-ENFORCEMENT +AlertName : PROTOCOL-ENFORCEMENT +AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Network/applicationGateways/ContosoWAF +CanBeInvestigated : True +CompromisedEntity : 10.1.0.4 +ConfidenceReasons : {} +ConfidenceScore : +Description : Detail:Host header is a numeric IP address 13.69.131.117:80 +DetectedTimeUtc : 20/08/2018 13:00:00 +Entities : {} +ExtendedProperties : {[hit Count, 1], [source IPs, 177.86.202.171], [management URL, https://portal.azure.com#resource/ + subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.N + etwork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} +InstanceId : bbbda0ad-b149-49f4-a4ba-3e95540cbf1c +RemediationSteps : +ReportedSeverity : Low +ReportedTimeUtc : 20/08/2018 14:00:36 +State : Active +SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 +SystemSource : Azure +VendorName : Microsoft WAF +WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid + ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 + -eus +``` + +Gets all the security alerts that were detected on resources inside the "myService1" resource group + +### Example 3 +```powershell +Get-AzSecurityAlert -ResourceGroupName "myService1" -Location "westeurope" -Name "2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Security/locations/westeurope/alerts/2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 +Name : 2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 +ActionTaken : Detected +AlertDisplayName : PROTOCOL-ENFORCEMENT +AlertName : PROTOCOL-ENFORCEMENT +AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. + Network/applicationGateways/ContosoWAF +CanBeInvestigated : True +CompromisedEntity : 10.1.0.4 +ConfidenceReasons : {} +ConfidenceScore : +Description : Detail:Host header is a numeric IP address 13.69.131.117 +DetectedTimeUtc : 20/08/2018 15:00:00 +Entities : {} +ExtendedProperties : {[hit Count, 1], [source IPs, 217.91.251.86], [management URL, https://portal.azure.com#resource/s + ubscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Ne + twork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} +InstanceId : 0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 +RemediationSteps : +ReportedSeverity : Low +ReportedTimeUtc : 20/08/2018 16:00:03 +State : Active +SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 +SystemSource : Azure +VendorName : Microsoft WAF +WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid + ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 + -eus +``` + +Gets a specific security alert that were detected on resources inside the "myService1" resource group + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource, SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource, SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupScope, ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Alerts.PSSecurityAlert + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityAssessment.md b/azps-10.1.0/Az.Security/Get-AzSecurityAssessment.md new file mode 100644 index 0000000000..d6216582e1 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityAssessment.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityAssessment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAssessment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAssessment.md +--- + +# Get-AzSecurityAssessment + +## SYNOPSIS +Gets security assessments and their results on a subscription + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecurityAssessment [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecurityAssessment -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdScope +``` +Get-AzSecurityAssessment -Name <String> -AssessedResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzSecurityAssessment -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets security assessment and their results on subscription. Security assessments will let you know which best practices are recommanded by Azure Security Center to be mitigated on your Azure subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityAssessment +``` + +Gets all the security assessment in a subscription + +## PARAMETERS + +### -AssessedResourceId +Full resource ID of the resource that the assessment is calculated on. + +```yaml +Type: System.String +Parameter Sets: ResourceIdScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ResourceIdScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Assessments.PSSecurityAssessment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityAssessmentMetadata.md b/azps-10.1.0/Az.Security/Get-AzSecurityAssessmentMetadata.md new file mode 100644 index 0000000000..49a0ae2216 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityAssessmentMetadata.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityAssessmentMetadata +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAssessmentMetadata.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAssessmentMetadata.md +--- + +# Get-AzSecurityAssessmentMetadata + +## SYNOPSIS +Gets security assessments types and metadta in a subscription. + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecurityAssessmentMetadata [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecurityAssessmentMetadata -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzSecurityAssessmentMetadata -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets security assessments types and metadta in a subscription. Security Assessment metadata include Built-In assessments and custom assessment types that the user can define. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityAssessmentMetadata +``` + +Gets all the built in assessments and the custom assessments that were configured on the current subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AssessmentMetadata.PSSecurityAssessmentMetadata + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityAutoProvisioningSetting.md b/azps-10.1.0/Az.Security/Get-AzSecurityAutoProvisioningSetting.md new file mode 100644 index 0000000000..c51bc7940b --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityAutoProvisioningSetting.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityAutoProvisioningSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAutoProvisioningSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAutoProvisioningSetting.md +--- + +# Get-AzSecurityAutoProvisioningSetting + +## SYNOPSIS +Gets the security automatic provisioning settings + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecurityAutoProvisioningSetting [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecurityAutoProvisioningSetting -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzSecurityAutoProvisioningSetting -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Automatic Provisioning Settings let you decide whether you want Azure Security Center to automatically provision a security agent that will be installed on your VMs. +The security agent will monitor your VM to create security alerts and monitor the security compliance of the VM. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityAutoProvisioningSetting -Name "default" +``` + +```output +Id Name AutoProvision +-- ---- ------------- +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/autoProvisioningSettings/default default On +``` + +Gets the auto provisioning setting for the subscription + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AutoProvisioningSettings.PSSecurityAutoProvisioningSetting + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityAutomation.md b/azps-10.1.0/Az.Security/Get-AzSecurityAutomation.md new file mode 100644 index 0000000000..79e4fa954c --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityAutomation.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/get-azsecurityautomation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAutomation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityAutomation.md +--- + +# Get-AzSecurityAutomation + +## SYNOPSIS +Gets security automations + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecurityAutomation [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupScope +``` +Get-AzSecurityAutomation -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceGroupLevelResource +``` +Get-AzSecurityAutomation -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzSecurityAutomation -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets security automations + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityAutomation +``` + +Gets all security automations under the subscription + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupScope, ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityCompliance.md b/azps-10.1.0/Az.Security/Get-AzSecurityCompliance.md new file mode 100644 index 0000000000..0bf38e7051 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityCompliance.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityCompliance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityCompliance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityCompliance.md +--- + +# Get-AzSecurityCompliance + +## SYNOPSIS +Get the security compliance of a subscription over time + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecurityCompliance [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecurityCompliance -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzSecurityCompliance -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the security compliance of a subscription based on the current healthy and non secured resources ratio on this subscription. +The security compliance is calculated every day and the history is saved. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityCompliance +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-20Z +Name : 2018-08-20Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 20/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-19Z +Name : 2018-08-19Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 19/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-18Z +Name : 2018-08-18Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 18/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-17Z +Name : 2018-08-17Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 17/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-16Z +Name : 2018-08-16Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 16/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-15Z +Name : 2018-08-15Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 15/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-14Z +Name : 2018-08-14Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 14/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-13Z +Name : 2018-08-13Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 13/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-12Z +Name : 2018-08-12Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 12/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-11Z +Name : 2018-08-11Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 11/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-10Z +Name : 2018-08-10Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 10/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-09Z +Name : 2018-08-09Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 09/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-08Z +Name : 2018-08-08Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 08/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} + +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-07Z +Name : 2018-08-07Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 07/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} +``` + +Gets the security compliance of a subscription for the last 14 days + +### Example 2 +```powershell +Get-AzSecurityCompliance -Name "2018-08-20Z" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-20Z +Name : 2018-08-20Z +ResourceCount : 18 +AssessmentTimestampUtcDate : 20/08/2018 00:00:00 +AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} +``` + +Gets the security compliance of a subscription on a specific date + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityCompliance + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityContact.md b/azps-10.1.0/Az.Security/Get-AzSecurityContact.md new file mode 100644 index 0000000000..7af271e966 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityContact.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityContact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityContact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityContact.md +--- + +# Get-AzSecurityContact + +## SYNOPSIS +Gets security contacts that were configured on this subscription + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecurityContact [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecurityContact -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzSecurityContact -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets security contacts that were configured on this subscription. +The security contact can get notifications on security alerts that happen on the subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityContact +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/securityContacts/default1 +Name : default1 +Email : ascasc@microsoft.com +Phone : 123123123 +AlertNotifications : On +AlertsToAdmins : On +``` + +Gets all the configured security contacts on the subscription + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.SecurityContacts.PSSecurityContact + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityLocation.md b/azps-10.1.0/Az.Security/Get-AzSecurityLocation.md new file mode 100644 index 0000000000..3ddeec560f --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityLocation.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityLocation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityLocation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityLocation.md +--- + +# Get-AzSecurityLocation + +## SYNOPSIS +Gets the location where Azure Security Center will automatically save data for the specific subscription + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecurityLocation [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecurityLocation -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzSecurityLocation -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Azure Security Center will automatically decide on a location to save some of your data. +Use this cmdlet to discover that location. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityLocation +``` + +```output +Id Name +-- ---- +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/locations/centralus centralus +``` + +Gets the location where Azure Security Center saves the calculated security data. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Locations.PSSecurityLocation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityPricing.md b/azps-10.1.0/Az.Security/Get-AzSecurityPricing.md new file mode 100644 index 0000000000..8564cbdebe --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityPricing.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityPricing +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityPricing.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityPricing.md +--- + +# Get-AzSecurityPricing + +## SYNOPSIS + +Gets the Azure Defender plans for a subscription in Azure Security Center. + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecurityPricing [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecurityPricing -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzSecurityPricing -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION + +You can view each Azure Defender plan, per subscription, using this cmdlet. + +For details about Azure Defender and the available plans, see [Introduction to Azure Defender](https://learn.microsoft.com/azure/security-center/azure-defender). + +## EXAMPLES + +### Example 1 + +```powershell +Get-AzSecurityPricing +``` + +```output +Id Name PricingTier SubPlan FreeTrialRemainingTime Deprecated ReplacedBy +-- ---- ----------- ------- ---------------------- ---------- ---------- +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/VirtualMachines VirtualMachines Standard P2 00:00:00 +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/SqlServers SqlServers Standard 00:00:00 +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/AppServices AppServices Standard 00:00:00 +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/StorageAccounts StorageAccounts Standard PerStorageAccount 00:00:00 +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/SqlServerVirtualMachines SqlServerVirtualMachines Standard 00:00:00 +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/KubernetesService KubernetesService Free 00:00:00 True [Containers] +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/ContainerRegistry ContainerRegistry Free 00:00:00 True [Containers] +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/KeyVaults KeyVaults Standard 00:00:00 +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/Dns Dns Standard 00:00:00 +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/Arm Arm Standard 00:00:00 +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/OpenSourceRelationalDatabases OpenSourceRelationalDatabases Standard 00:00:00 +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/CosmosDbs CosmosDbs Standard 00:00:00 +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/Containers Containers Standard 00:00:00 +/subscriptions/c32e05d9-7207-4e22-bdf4-4f7d9c72e5fd/providers/Microsoft.Security/pricings/CloudPosture CloudPosture Free 00:00:00 +``` + +Gets the status of each Azure Defender plan for the subscription. + +### Example 2 + +```powershell +Get-AzSecurityPricing -ResourceId '/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/VirtualMachines' +``` + +Gets pricing details of the specific resource ID. Where ResourceId is one of the IDs returned by `Get-AzSecurityPricing`. + +### Example 3 + +```powershell +Get-AzSecurityPricing -Name 'VirtualMachines' +``` + +Gets pricing details of the named Azure Defender plan. Where `name` is one of the names returned by `Get-AzSecurityPricing`. + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId + +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Pricings.PSSecurityPricing + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecuritySecureScore.md b/azps-10.1.0/Az.Security/Get-AzSecuritySecureScore.md new file mode 100644 index 0000000000..d767a5df74 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecuritySecureScore.md @@ -0,0 +1,95 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecuritySecureScore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySecureScore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySecureScore.md +--- + +# Get-AzSecuritySecureScore + +## SYNOPSIS +Gets security secure scores and their results on a subscription + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecuritySecureScore [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecuritySecureScore -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSecuritySecureScore comlet gets security secure scores and their results on a subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecuritySecureScore +``` + +```output +Id : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/providers/Microsoft.Security/secureScores/ascScore +Name : ascScore +Type : Microsoft.Security/secureScores +DisplayName : ASC score +CurrentScore : 18.38 +MaxScore : 56 +Percentage : 0.3282 +Weight : 1161 +``` + +Gets all the security secure scores in a subscription + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Assessments.PSSecuritySecureScore + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecuritySecureScoreControl.md b/azps-10.1.0/Az.Security/Get-AzSecuritySecureScoreControl.md new file mode 100644 index 0000000000..356969744c --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecuritySecureScoreControl.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecuritySecureScoreControl +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySecureScoreControl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySecureScoreControl.md +--- + +# Get-AzSecuritySecureScoreControl + +## SYNOPSIS +Gets security secure score controls and their results on a subscription + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecuritySecureScoreControl [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecuritySecureScoreControl -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSecuritySecureScoreControl comlet gets security secure score controls and their results on a subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecuritySecureScoreControl +``` + +```output +Id : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/providers/Microsoft.Security/secureSco +res/ascScore/secureScoreControls/8fd574ec-43cf-426e-a439-a67cbaf2d564 +Name : 8fd574ec-43cf-426e-a439-a67cbaf2d564 +Type : Microsoft.Security/secureScores/secureScoreControls +DisplayName : Enable encryption at rest +CurrentScore : 0 +MaxScore : 4 +Percentage : 0 +Weight : 6 +HealthyResourceCount : 0 +UnhealthyResourceCount : 6 +NotApplicableResourceCount : 0 +``` + +Gets all the security secure scores in a subscription + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Secure score name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Assessments.PSSecuritySecureScoreControl + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecuritySecureScoreControlDefinition.md b/azps-10.1.0/Az.Security/Get-AzSecuritySecureScoreControlDefinition.md new file mode 100644 index 0000000000..bf11153aea --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecuritySecureScoreControlDefinition.md @@ -0,0 +1,98 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecuritySecureScoreControlDefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySecureScoreControlDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySecureScoreControlDefinition.md +--- + +# Get-AzSecuritySecureScoreControlDefinition + +## SYNOPSIS +Gets security secure score control definitions on a subscription + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecuritySecureScoreControlDefinition [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecuritySecureScoreControlDefinition -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSecuritySecureScoreControlDefinition comlet gets security secure score control definitions on a subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecuritySecureScoreControlDefinition +``` + +```output +Id : /providers/Microsoft.Security/secureScoreControlDefinitions/a9909064-42b4-4d34-8143-275477afe18b +Name : a9909064-42b4-4d34-8143-275477afe18b +Type : Microsoft.Security/secureScoreControlDefinitions +DisplayName : Protect your applications with Azure advanced networking solutions +Description : +MaxScore : 2 +Source : BuiltIn +AssessmentDefinitions : {/providers/Microsoft.Security/assessmentMetadata/e3de1cc0-f4dd-3b34-e496-8b5381ba2d70, /providers/Microsoft.Security/assessmentMetadata/08e628db-e2ed-4793-bc91-d13e6 + 84401c3, /providers/Microsoft.Security/assessmentMetadata/0642d770-b189-42ef-a2ce-9dcc3ec6c169, /providers/Microsoft.Security/assessmentMetadata/405c9ae6-49f9-46c4-88 + 73-a86690f27818...} +``` + +Gets all the security secure score control definitions in a subscription + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Assessments.PSSecuritySecureScoreControlDefinition + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecuritySetting.md b/azps-10.1.0/Az.Security/Get-AzSecuritySetting.md new file mode 100644 index 0000000000..2facb4150a --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecuritySetting.md @@ -0,0 +1,93 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecuritySetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySetting.md +--- + +# Get-AzSecuritySetting + +## SYNOPSIS +Get security settings in Azure Security Center + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecuritySetting [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecuritySetting -SettingName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSecuritySetting cmdlet get security settings in Azure Security Center. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecuritySetting -SettingName "MCAS" +``` + +```output +Id: "/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/settings/MCAS" +Name: "MCAS" +Type: "Microsoft.Security/settings" +Enabled: true +``` + +Gets an MCAS data export setting + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SettingName +Setting name. (MCAS/WDATP/Sentinel) + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Settings.PSSecuritySetting +### Microsoft.Azure.Commands.Security.Models.Settings.PSSecurityDataExportSetting +### Microsoft.Azure.Commands.Security.Models.Settings.PSSecurityAlertSyncSettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecuritySolution.md b/azps-10.1.0/Az.Security/Get-AzSecuritySolution.md new file mode 100644 index 0000000000..fd5083d90d --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecuritySolution.md @@ -0,0 +1,80 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecuritySolutionsReferenceData +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySolution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySolution.md +--- + +# Get-AzSecuritySolution + +## SYNOPSIS +Get Security Solutions + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecuritySolution [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get Security Solutions + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecuritySolution +``` + +```output +Id : /subscriptions/67bc604b-54b2-4c78-a7ba-72504920a319/resourceGroups/QualysLICTest/providers/Microsoft.Security/locations/centralus/securitySolutions/QualysTest +Name : QualysLICTest +provisioningState : Succeeded +template : qualys.qualysAgent +SecurityFamily : Va +protectionStatus : Good + +Id : /subscriptions/67bc604b-54b2-4c78-a7ba-72504920a319/resourceGroups/OfriWafTest/providers/MicrosoftSecurity/locations/centralus/securitySolutions/WafTest +Name : WafTest +provisioningState : Succeeded +template : Microsoft.ApplicationGateway-ARM +SecurityFamily : SaasWaf +protectionStatus : Good +``` + +Get all Get Security Solutions in the subscription + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.ExternalSecuritySolutions.PSSecurityExternalSecuritySolution + +## NOTES + +## RELATED LINKS \ No newline at end of file diff --git a/azps-10.1.0/Az.Security/Get-AzSecuritySolutionsReferenceData.md b/azps-10.1.0/Az.Security/Get-AzSecuritySolutionsReferenceData.md new file mode 100644 index 0000000000..540f1d30d1 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecuritySolutionsReferenceData.md @@ -0,0 +1,88 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecuritySolutionsReferenceData +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySolutionsReferenceData.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySolutionsReferenceData.md +--- + +# Get-AzSecuritySolutionsReferenceData + +## SYNOPSIS +Get Security Solutions Reference Data + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecuritySolutionsReferenceData [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get Security Solutions Reference Data + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecuritySolutionsReferenceData +``` + +```output +Id : /subscriptions/67bc604b-54b2-4c78-a7ba-72504920a319/providers/Microsoft.Security/locations/centr + alus/securitySolutionsReferenceData/qualys.qualysAgent +Name : qualys.qualysAgent +SecurityFamily : Va +alertVendorName : +packageInfoUrl : +productName : +publisher : +publisherDisplayName : +template : qualys/qualysAgent + +Id : /subscriptions/67bc604b-54b2-4c78-a7ba-72504920a319/providers/Microsoft.Security/locations/centr + alus/securitySolutionsReferenceData/microsoft.ApplicationGateway-ARM +Name : microsoft.ApplicationGateway-ARM +SecurityFamily : SaasWaf +alertVendorName : +packageInfoUrl : +productName : +publisher : +publisherDisplayName : +template : microsoft/ApplicationGateway-ARM +``` + +Get all Get Security Solutions Reference Data in the subscription + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.ExternalSecuritySolutions.PSSecurityExternalSecuritySolution + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecuritySqlVulnerabilityAssessmentBaseline.md b/azps-10.1.0/Az.Security/Get-AzSecuritySqlVulnerabilityAssessmentBaseline.md new file mode 100644 index 0000000000..96e41f5faf --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecuritySqlVulnerabilityAssessmentBaseline.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/get-azsecuritysqlvulnerabilityassessmentbaseline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySqlVulnerabilityAssessmentBaseline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySqlVulnerabilityAssessmentBaseline.md +--- + +# Get-AzSecuritySqlVulnerabilityAssessmentBaseline + +## SYNOPSIS +Get SQL vulnerability assessment baseline. + +## SYNTAX + +### ResourceId (Default) +``` +Get-AzSecuritySqlVulnerabilityAssessmentBaseline [-RuleId <String>] -ResourceId <String> -WorkspaceId <String> + -Server <String> -Database <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### OnPremMachines +``` +Get-AzSecuritySqlVulnerabilityAssessmentBaseline [-RuleId <String>] -WorkspaceId <String> -Server <String> + -Database <String> -ComputerName <String> -VmUuid <String> -AgentId <String> -WorkspaceResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get SQL vulnerability assessment baseline. + +## EXAMPLES + +### Example 1: Get baseline on a specific rule using resource id paramaters +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentBaseline -ResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onPremiseMachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -RuleId "VA2108" +``` + +```output +Results WorkSpaceId +------- ----------- +{VA2108 => [[dbo, db_owner1, SQL_USER]]} ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 +``` + +Example of using resource id parameters. +Supported resources are: + +- ARC: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HybridCompute/machines/{machineName} +- VM: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{machineName} +- On-Premise: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.operationalinsights/workspaces/{workspaceName}/onPremiseMachines/{machineName} + +### Example 2: Get baseline on a specific rule using on premise paramaters +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentBaseline -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -RuleId "VA2108" +``` + +```output +Results WorkSpaceId +------- ----------- +{VA2108 => [[dbo, db_owner1, SQL_USER]]} ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 +``` + +Example of using on premise parameters. + +### Example 3: Get all baselines on a SQL Database +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentBaseline -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master +``` + +```output +Results WorkSpaceId +------- ----------- +{VA1017 => [], VA1018 => [[True]], VA1020 => [], VA1022 => [[False]]…} ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 +``` + +In this example a rule id is not specified, it returns all the baselines for that database. + +## PARAMETERS + +### -AgentId +Agent ID - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Computer full name - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database +Database name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. +Supported resources are: + +- ARC: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HybridCompute/machines/{machineName} +- VM: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{machineName} +- On-Premise: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.operationalinsights/workspaces/{workspaceName}/onPremiseMachines/{machineName} + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Vulnerability assessment rule ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +Server name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmUuid +Virtual machine universal unique identifier - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceId +Workspace ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +Workspace resource ID - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.SecurityCenter.Models.SqlVulnerabilityAssessment.PSSqlVulnerabilityAssessmentBaselineResults + +## NOTES + +## RELATED LINKS + +[Add-AzSecuritySqlVulnerabilityAssessmentBaseline](https://learn.microsoft.com/powershell/module/az.security/add-azsecuritysqlvulnerabilityassessmentbaseline) + +[Remove-AzSecuritySqlVulnerabilityAssessmentBaseline](https://learn.microsoft.com/powershell/module/az.security/remove-azsecuritysqlvulnerabilityassessmentbaseline) + +[Set-AzSecuritySqlVulnerabilityAssessmentBaseline](https://learn.microsoft.com/powershell/module/az.security/set-azsecuritysqlvulnerabilityassessmentbaseline) \ No newline at end of file diff --git a/azps-10.1.0/Az.Security/Get-AzSecuritySqlVulnerabilityAssessmentScanRecord.md b/azps-10.1.0/Az.Security/Get-AzSecuritySqlVulnerabilityAssessmentScanRecord.md new file mode 100644 index 0000000000..debd16d8b5 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecuritySqlVulnerabilityAssessmentScanRecord.md @@ -0,0 +1,384 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/get-azsecuritysqlvulnerabilityassessmentscanrecord +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySqlVulnerabilityAssessmentScanRecord.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySqlVulnerabilityAssessmentScanRecord.md +--- + +# Get-AzSecuritySqlVulnerabilityAssessmentScanRecord + +## SYNOPSIS +Gets SQL vulnerability assessment scan summary. + +## SYNTAX + +### ResourceId (Default) +``` +Get-AzSecuritySqlVulnerabilityAssessmentScanRecord [-ScanId <String>] -ResourceId <String> + -WorkspaceId <String> -Server <String> -Database <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### OnPremMachines +``` +Get-AzSecuritySqlVulnerabilityAssessmentScanRecord [-ScanId <String>] -WorkspaceId <String> -Server <String> + -Database <String> -ComputerName <String> -VmUuid <String> -AgentId <String> -WorkspaceResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets SQL vulnerability assessment scan summary. + +## EXAMPLES + +### Example 1: get scan summary for latest scan for SQL Database. +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentScanRecord -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -ScanId "latest" +``` + +```output +TriggerType : Recurring +State : Failed +Server : AHABASDEV01SRV +Database : master +SqlVersion : 14.0.1000.169 +StartTime : 3/17/2021 1:11:10 AM +EndTime : 12/31/9999 9:59:59 PM +HighSeverityFailedRulesCount : 9 +MediumSeverityFailedRulesCount : 2 +LowSeverityFailedRulesCount : 5 +TotalPassedRulesCount : 43 +TotalFailedRulesCount : 16 +TotalRulesCount : 59 +IsBaselineApplied : True +Id : /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/ + sqlServers/AHABASDEV01SRV/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/bdbdf860-5d58-464b-ad9a-0125af63c162 +Name : bdbdf860-5d58-464b-ad9a-0125af63c162 +Type : Microsoft.Security/sqlVulnerabilityAssessments/scans +``` + +Example for using scan id = "latest". + +### Example 2: Get all scan summaries on SQL Database. +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentScanRecord -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master +``` + +```output +TriggerType : Recurring +State : Failed +Server : AHABASDEV01SRV +Database : master +SqlVersion : 14.0.1000.169 +StartTime : 3/17/2021 1:11:10 AM +EndTime : 12/31/9999 9:59:59 PM +HighSeverityFailedRulesCount : 9 +MediumSeverityFailedRulesCount : 2 +LowSeverityFailedRulesCount : 5 +TotalPassedRulesCount : 43 +TotalFailedRulesCount : 16 +TotalRulesCount : 59 +IsBaselineApplied : True +Id : /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/ + sqlServers/AHABASDEV01SRV/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/bdbdf860-5d58-464b-ad9a-0125af63c162 +Name : bdbdf860-5d58-464b-ad9a-0125af63c162 +Type : Microsoft.Security/sqlVulnerabilityAssessments/scans + +TriggerType : Recurring +State : Failed +Server : AHABASDEV01SRV +Database : master +SqlVersion : 14.0.1000.169 +StartTime : 3/17/2021 12:41:14 AM +EndTime : 3/17/2021 1:11:10 AM +HighSeverityFailedRulesCount : 2 +MediumSeverityFailedRulesCount : 0 +LowSeverityFailedRulesCount : 0 +TotalPassedRulesCount : 57 +TotalFailedRulesCount : 2 +TotalRulesCount : 59 +IsBaselineApplied : True +Id : /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/ + sqlServers/AHABASDEV01SRV/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/8b2383c3-7c7e-4b6c-9b34-512ce99fd68a +Name : 8b2383c3-7c7e-4b6c-9b34-512ce99fd68a +Type : Microsoft.Security/sqlVulnerabilityAssessments/scans + +TriggerType : Recurring +State : Passed +Server : AHABASDEV01SRV +Database : master +SqlVersion : 14.0.1000.169 +StartTime : 2/14/2021 4:27:44 PM +EndTime : 3/17/2021 12:41:14 AM +HighSeverityFailedRulesCount : 0 +MediumSeverityFailedRulesCount : 0 +LowSeverityFailedRulesCount : 0 +TotalPassedRulesCount : 59 +TotalFailedRulesCount : 0 +TotalRulesCount : 59 +IsBaselineApplied : True +Id : /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/ + sqlServers/AHABASDEV01SRV/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/6845790d-6463-4f45-96e8-76286edf0267 +Name : 6845790d-6463-4f45-96e8-76286edf0267 +Type : Microsoft.Security/sqlVulnerabilityAssessments/scans + +TriggerType : Recurring +State : Failed +Server : AHABASDEV01SRV +Database : master +SqlVersion : 14.0.1000.169 +StartTime : 2/14/2021 3:57:44 PM +EndTime : 2/14/2021 4:27:44 PM +HighSeverityFailedRulesCount : 2 +MediumSeverityFailedRulesCount : 0 +LowSeverityFailedRulesCount : 0 +TotalPassedRulesCount : 57 +TotalFailedRulesCount : 2 +TotalRulesCount : 59 +IsBaselineApplied : True +Id : /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/ + sqlServers/AHABASDEV01SRV/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/2058a46e-cb5a-4a49-b28a-6576a540dd9d +Name : 2058a46e-cb5a-4a49-b28a-6576a540dd9d +Type : Microsoft.Security/sqlVulnerabilityAssessments/scans +``` + +Example for Listing all scan records when a scan id is not specified. + +### Example 3: Get scan summary using resource id parameters. +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentScanRecord -ResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onPremiseMachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -ScanId 169a5f78-acff-4e05-b597-6252af7e6677 +``` + +```output +TriggerType : Recurring +State : Failed +Server : AHABASDEV01SRV +Database : master +SqlVersion : 14.0.1000.169 +StartTime : 11/18/2020 1:10:34 AM +EndTime : 11/18/2020 1:40:20 AM +HighSeverityFailedRulesCount : 9 +MediumSeverityFailedRulesCount : 2 +LowSeverityFailedRulesCount : 5 +TotalPassedRulesCount : 43 +TotalFailedRulesCount : 16 +TotalRulesCount : 59 +IsBaselineApplied : True +Id : /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/provid + ers/microsoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas + -dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-003 + 0-4b10-8039-b8c04f4a3332/sqlServers/AHABASDEV01SRV/databases/master/providers/Microsof + t.Security/sqlVulnerabilityAssessments/default/scans/169a5f78-acff-4e05-b597-6252af7e6 + 677 +Name : 169a5f78-acff-4e05-b597-6252af7e6677 +Type : Microsoft.Security/sqlVulnerabilityAssessments/scans +``` + +Example for using azure resource id parameters. +Supported resources are: + +- ARC: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HybridCompute/machines/{machineName} +- VM: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{machineName} +- On-Premise: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.operationalinsights/workspaces/{workspaceName}/onPremiseMachines/{machineName} + +### Example 4: Get scan summary using on premise parameters. +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentScanRecord -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -ScanId bdbdf860-5d58-464b-ad9a-0125af63c162 +``` + +```output +TriggerType : Recurring +State : Failed +Server : AHABASDEV01SRV +Database : master +SqlVersion : 14.0.1000.169 +StartTime : 3/17/2021 1:11:10 AM +EndTime : 12/31/9999 9:59:59 PM +HighSeverityFailedRulesCount : 9 +MediumSeverityFailedRulesCount : 2 +LowSeverityFailedRulesCount : 5 +TotalPassedRulesCount : 43 +TotalFailedRulesCount : 16 +TotalRulesCount : 59 +IsBaselineApplied : True +Id : /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/ + sqlServers/AHABASDEV01SRV/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/bdbdf860-5d58-464b-ad9a-0125af63c162 +Name : bdbdf860-5d58-464b-ad9a-0125af63c162 +Type : Microsoft.Security/sqlVulnerabilityAssessments/scans +``` + +Example for using on premise parameters. + +## PARAMETERS + +### -AgentId +Agent ID - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Computer full name - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database +Database name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. +Supported resources are: + +- ARC: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HybridCompute/machines/{machineName} +- VM: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{machineName} +- On-Premise: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.operationalinsights/workspaces/{workspaceName}/onPremiseMachines/{machineName} + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanId +Vulnerability assessment scan ID - use scanId = 'latest' to get latest results + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +Server name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmUuid +Virtual machine universal unique identifier - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceId +Workspace ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +Workspace resource ID - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.SecurityCenter.Models.SqlVulnerabilityAssessment.PSSqlVulnerabilityAssessmentScanRecord + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecuritySqlVulnerabilityAssessmentScanResult.md b/azps-10.1.0/Az.Security/Get-AzSecuritySqlVulnerabilityAssessmentScanResult.md new file mode 100644 index 0000000000..7cac587693 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecuritySqlVulnerabilityAssessmentScanResult.md @@ -0,0 +1,520 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/get-azsecuritysqlvulnerabilityassessmentscanresult +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySqlVulnerabilityAssessmentScanResult.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySqlVulnerabilityAssessmentScanResult.md +--- + +# Get-AzSecuritySqlVulnerabilityAssessmentScanResult + +## SYNOPSIS +Gets SQL vulnerability assessment scan results. + +## SYNTAX + +### ResourceId (Default) +``` +Get-AzSecuritySqlVulnerabilityAssessmentScanResult [-ScanId <String>] [-RuleId <String>] -ResourceId <String> + -WorkspaceId <String> -Server <String> -Database <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### OnPremMachines +``` +Get-AzSecuritySqlVulnerabilityAssessmentScanResult [-ScanId <String>] [-RuleId <String>] -WorkspaceId <String> + -Server <String> -Database <String> -ComputerName <String> -VmUuid <String> -AgentId <String> + -WorkspaceResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets SQL vulnerability assessment scan results. + +## EXAMPLES + +### Example 1: Get all results from latest scan on a SQL Database +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentScanResult -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master +``` + +```output +RuleId : VA1017 +Status : NonFinding +IsTrimmed : False +QueryResults : {} +Remediation : { + Revoke EXECUTE permission on xp_cmdshell to all users (except dbo) + IsAutomated: False + Portal Link: + Script: + {} + } +BaselineAdjustedResult : {} +RuleMetadata : { + Rule id: VA1017 + Severity: High + Category: AuthenticationAndAuthorization + Rule type: NegativeList + Title: Execute permissions on xp_cmdshell from all users (except dbo) should be revoked. + Description: The xp_cmdshell extended stored procedure spawns a Windows command shell, passing in a string for execution. This rule checks that no users (except users with the CONTROL SERVER permission like members of the sysadmin server role) have permission to execute the xp_cmdshell ext + ended stored procedure. + Rationale: The xp_cmdshell extended stored procedure is a very powerful tool, but because of that, it is crucial that access to xp_cmdshell be tightly controlled. By default, only users with the CONTROL SERVER permission like members of the sysadmin server role can execute this extended + stored procedure. When first enabled, xp_cmdshell has the same security context as the SQL Server service account. The SQL Server service account is often more privileged than necessary for the work being performed by the process created by xp_cmdshell. As such, malicious users can attempt  + to elevate their privileges by using xp_cmdshell. See https://learn.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/xp-cmdshell-transact-sql for more information on xp_cmdshell. + Query check: + { + Query: + SELECT dpr.name AS [Principal] FROM sys.database_permissions AS dp JOIN sys.database_principals AS dpr ON dp.grantee_principal_id = dpr.principal_id WHERE major_id = OBJECT_ID('xp_cmdshell') AND dp.[type] = 'EX' AND [state] IN ( 'G' ,'W' ) + Column Names: + + Expected Results: + {}} + Benchmark References: + { + Benchmark: FedRAMP + Reference: + } + } +Id : /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/sqlServe + rs/AHABASDEV01SRV/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/bdbdf860-5d58-464b-ad9a-0125af63c162/scanResults/VA1017 +Name : VA1017 +Type : Microsoft.Security/sqlVulnerabilityAssessments/scans/scanResults + +RuleId : VA1018 +Status : Finding +IsTrimmed : False +QueryResults : {True} +Remediation : { + Install the latest SQL Server CU corresponding to your version of SQL Server. Go to https://technet.microsoft.com/en-us/sqlserver/ff803383.aspx to find and download the required CU. + IsAutomated: True + Portal Link: + Script: + {} + } +BaselineAdjustedResult : {} +RuleMetadata : { + Rule id: VA1018 + Severity: High + Category: InstallationUpdatesAndPatches + Rule type: Binary + Title: Latest updates should be installed + Description: Microsoft periodically releases Cumulative Updates (CUs) for each version of SQL Server. This rule checks whether the latest CU has been installed for the particular version of SQL Server being used. + Rationale: Running with the latest Cumulative Updates (CU) for any particular version of SQL Server is important as these CU are a collection of all available patches up-to-date, including all known security fixes. Microsoft officially recommends ongoing, proactive installation of SQL + Server CUs as they become available. + Query check: + { + Query: + SELECT CASE WHEN Serverproperty('ProductVersion') >= '14.0.3356.20' THEN 0 ELSE 1 END AS [Violation] + Column Names: + Violation + Expected Results: + {False}} + Benchmark References: + { + Benchmark: CIS + Reference: v1.0.0-08-11-2017:1.1 + }, { + Benchmark: FedRAMP + Reference: + } + } +... +``` + +In this example when the rule id is not specified all scan results all returned for the scan id in use. + +### Example 2: Get all results with scan id on a SQL Database +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentScanResult -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -ScanId 7db278d4-4629-4f75-ae0b-9c0e3d3b0816 +``` + +```output +RuleId : VA1017 +Status : NonFinding +IsTrimmed : False +QueryResults : {} +Remediation : { + Revoke EXECUTE permission on xp_cmdshell to all users (except dbo) + IsAutomated: False + Portal Link: + Script: + {} + } +BaselineAdjustedResult : {} +RuleMetadata : { + Rule id: VA1017 + Severity: High + Category: AuthenticationAndAuthorization + Rule type: NegativeList + Title: + Execute permissions on xp_cmdshell from all users (except dbo) should be revoked. + Description: The xp_cmdshell extended stored procedure spawns a Windows command shell, passin + g in a string for execution. This rule checks that no users (except users with the CONTROL SER + VER permission like members of the sysadmin server role) have permission to execute the xp_cmd + shell extended stored procedure. + Rationale: The xp_cmdshell extended stored procedure is a very powerful tool, but because o + f that, it is crucial that access to xp_cmdshell be tightly controlled. By default, only + users with the CONTROL SERVER permission like members of the sysadmin server role can execute + this extended stored procedure. When first enabled, xp_cmdshell has the same security context  + as the SQL Server service account. The SQL Server service account is often more privileged tha + n necessary for the work being performed by the process created by xp_cmdshell. As such, malic + ious users can attempt to elevate their privileges by using xp_cmdshell. See https://docs.micr + osoft.com/en-us/sql/relational-databases/system-stored-procedures/xp-cmdshell-transact-sql for +  more information on xp_cmdshell. + Query check: + { + Query: + SELECT dpr.name AS [Principal] FROM sys.database_permissions AS dp JOIN + sys.database_principals AS dpr ON dp.grantee_principal_id = dpr.principal_id WHERE + major_id = OBJECT_ID('xp_cmdshell') AND dp.[type] = 'EX' AND [state] IN ( 'G' + ,'W' ) + Column Names: + + Expected Results: + {}} + Benchmark References: + { + Benchmark: FedRAMP + Reference: + } + } +Id : /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/micr + osoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas-dev01.middleeas + t.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332 + /sqlServers/AHABASDEV01SRV/databases/master/providers/Microsoft.Security/sqlVulnerabilityAsses + sments/default/scans/7db278d4-4629-4f75-ae0b-9c0e3d3b0816/scanResults/VA1017 +Name : VA1017 +Type : Microsoft.Security/sqlVulnerabilityAssessments/scans/scanResults +... +``` + +### Example 3: Get result on a specific rule from latest scan on SQL Database +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentScanResult -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -RuleId "VA2108" +``` + +```output +RuleId : VA2108 +Status : Finding +IsTrimmed : False +QueryResults : {dbo db_owner SQL_USER} +Remediation : { + Remove members who should not have access to the database role + IsAutomated: True + Portal Link: + Script: + ALTER ROLE [db_owner] DROP MEMBER [dbo] + } +BaselineAdjustedResult : { + Status: Finding + Results not in baseline: + {dbo, db_owner, SQL_USER} + Results only in baseline: + {dbo, db_owner1, SQL_USER} + Baseline: + { + Update Time: 3/24/2021 3:59:39 PM + Expected Results: + {dbo, db_owner1, SQL_USER}} + } +RuleMetadata : { + Rule id: VA2108 + Severity: High + Category: AuthenticationAndAuthorization + Rule type: BaselineExpected + Title: Minimal set of principals should be members of fixed high impact database roles + Description: SQL Server provides roles to help manage the permissions. Roles are security principals that group other principals. Database-level roles are database-wide in their permission scope. This rule checks that a minimal set of principals are members of the fixed database roles. + Rationale: Fixed database roles may have administrative permissions on the system. Following the principle of least privilege, it is important to minimize membership in fixed database roles and keep a baseline of these memberships. See + https://learn.microsoft.com/en-us/sql/relational-databases/security/authentication-access/database-level-roles for additional information on database roles. + Query check: + { + Query: + SELECT user_name(sr.member_principal_id) as [Principal] ,user_name(sr.role_principal_id) as [Role] ,type_desc as [Principal Type] FROM sys.database_role_members AS sr INNER JOIN sys.database_principals sp ON sp.principal_id = sr.member_principal_id WHERE sr.role_principal_id IN + (user_id('bulkadmin'), user_id('db_accessadmin'), user_id('db_securityadmin'), user_id('db_ddladmin'), user_id('db_backupoperator'), + user_id('db_owner')) + Column Names: + Principal, Role, Principal Type + Expected Results: + {}} + Benchmark References: + { + Benchmark: FedRAMP + Reference: + } + } +Id : /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/sqlServe + rs/AHABASDEV01SRV/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/bdbdf860-5d58-464b-ad9a-0125af63c162/scanResults/VA2108 +Name : VA2108 +Type : Microsoft.Security/sqlVulnerabilityAssessments/scans/scanResults +``` + +Example for using on premise parameters. scan id is not specified so it gets results for latest. + +### Example 4: Get result on a specific rule using scan id parameter on SQL Database +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentScanResult -ResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onPremiseMachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -ScanId 5cded390-68c4-4f5b-9ce6-b8a7a12b288b -RuleId "VA2108" +``` + +```output +RuleId : VA2108 +Status : Finding +IsTrimmed : False +QueryResults : {dbo db_owner SQL_USER} +Remediation : { + Remove members who should not have access to the database role + IsAutomated: True + Portal Link: + Script: + ALTER ROLE [db_owner] DROP MEMBER [dbo] + } +BaselineAdjustedResult : { + Status: NonFinding + Results not in baseline:{} + Results only in baseline:{} + Baseline: + { + Update Time: 12/20/2020 3:33:31 PM + Expected Results: + {dbo, db_owner, SQL_USER} + } + } +RuleMetadata : { + Rule id: VA2108 + Severity: High + Category: AuthenticationAndAuthorization + Rule type: BaselineExpected + Title: Minimal set of principals should be members of fixed high impact database roles + Description: SQL Server provides roles to help manage the permissions. Roles are security + principals that group other principals. Database-level roles are database-wide in their + permission scope. This rule checks that a minimal set of principals are members of the fixed + database roles. + Rationale: Fixed database roles may have administrative permissions on the system. + Following the principle of least privilege, it is important to minimize membership in fixed + database roles and keep a baseline of these memberships. See https://learn.microsoft.com/en-us/ + sql/relational-databases/security/authentication-access/database-level-roles for additional + information on database roles. + Query check: + { + Query: + SELECT user_name(sr.member_principal_id) as [Principal] ,user_name(sr.role_principal_id) + as [Role] ,type_desc as [Principal Type] FROM sys.database_role_members AS sr INNER JOIN + sys.database_principals sp ON sp.principal_id = sr.member_principal_id WHERE + sr.role_principal_id IN (user_id('bulkadmin'), + user_id('db_accessadmin'), user_id('db_securityadmin'), + user_id('db_ddladmin'), + user_id('db_backupoperator'), user_id('db_owner')) + Column Names: + Principal, Role, Principal Type + Expected Results: + {} + } + Benchmark References: + { + Benchmark: FedRAMP + Reference: + } + } +Id : /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/micr + osoft.operationalinsights/workspaces/ahabas-workspace/onpremisemachines/ahabas-dev01.middleeas + t.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332 + /sqlServers/AHABASDEV01SRV/databases/master/providers/Microsoft.Security/sqlVulnerabilityAsses + sments/default/scans/5cded390-68c4-4f5b-9ce6-b8a7a12b288b/scanResults/VA2108 +Name : VA2108 +Type : Microsoft.Security/sqlVulnerabilityAssessments/scans/scanResults +``` + +Example of using resource id parameter set. +Supported resources are: + +- ARC: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HybridCompute/machines/{machineName} +- VM: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{machineName} +- On-Premise: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.operationalinsights/workspaces/{workspaceName}/onPremiseMachines/{machineName} + +## PARAMETERS + +### -AgentId +Agent ID - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Computer full name - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database +Database name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +Supported resources are: + +- ARC: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HybridCompute/machines/{machineName} +- VM: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{machineName} +- On-Premise: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.operationalinsights/workspaces/{workspaceName}/onPremiseMachines/{machineName} + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Vulnerability assessment rule ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanId +Vulnerability assessment scan ID - use scanId = 'latest' to get latest results + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +Server name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmUuid +Virtual machine universal unique identifier - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceId +Workspace ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +Workspace resource ID - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.SecurityCenter.Models.SqlVulnerabilityAssessment.PSSqlVulnerabilityAssessmentScanResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecuritySubAssessment.md b/azps-10.1.0/Az.Security/Get-AzSecuritySubAssessment.md new file mode 100644 index 0000000000..bbdf8a41a9 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecuritySubAssessment.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecuritySubAssessment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySubAssessment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecuritySubAssessment.md +--- + +# Get-AzSecuritySubAssessment + +## SYNOPSIS +Gets sub assessments results in a subscription. + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecuritySubAssessment [-AssessedResourceId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecuritySubAssessment -Name <String> [-AssessedResourceId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdLevelResource +``` +Get-AzSecuritySubAssessment -Name <String> -AssessmentName <String> [-AssessedResourceId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdScope +``` +Get-AzSecuritySubAssessment -AssessmentName <String> [-AssessedResourceId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzSecuritySubAssessment -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets sub assessments results in a subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecuritySubAssessment +``` + +Gets all the sub assessments results in a subscription. + +## PARAMETERS + +### -AssessedResourceId +Full resource ID of the resource that the assessment is calculated on. + +```yaml +Type: System.String +Parameter Sets: SubscriptionScope, SubscriptionLevelResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ResourceIdLevelResource, ResourceIdScope +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssessmentName +Name of the assessment resource. + +```yaml +Type: System.String +Parameter Sets: ResourceIdLevelResource, ResourceIdScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ResourceIdLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.SubAssessments.PSSecuritySubAssessment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityTask.md b/azps-10.1.0/Az.Security/Get-AzSecurityTask.md new file mode 100644 index 0000000000..88764d0f96 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityTask.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityTask +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityTask.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityTask.md +--- + +# Get-AzSecurityTask + +## SYNOPSIS +Gets the security tasks that Azure Security Center recommends you to do in order to strengthen your security posture. + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecurityTask [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupScope +``` +Get-AzSecurityTask -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupLevelResource +``` +Get-AzSecurityTask -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecurityTask -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzSecurityTask -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Azure Security Center scans your resources to detect potential security issues. +This cmdlet lets you discover the security tasks that Azure Security Center recommends you to do. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityTask +``` + +```output +Id Name RecommendationType ResourceId +-- ---- ------------------ ---------- +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/locations/centralus/tasks/08357a1e-c534-756f-cbb9-7b45e73f3137 08357a1e-c534-756f-cbb9-7b45e73f3137 Subscription has machines with failed baseline rule /subscriptions/48... +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/locations/centralus/tasks/0876feac-8c60-3fef-d95e-2c43b333ff14 0876feac-8c60-3fef-d95e-2c43b333ff14 Antimalware Health Issues /subscriptions/48... +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/locations/centralus/tasks/09ea0fa9-ce5a-d703-e17b-08f1d5246e2c 09ea0fa9-ce5a-d703-e17b-08f1d5246e2c Subscription has machines with failed baseline rule /subscriptions/48... +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/locations/centralus/tasks/11ff8541-820e-cecc-75de-91be7c0d8419 11ff8541-820e-cecc-75de-91be7c0d8419 Subscription has machines with failed baseline rule /subscriptions/48... +``` + +Gets all the security tasks that were discovered on resources inside a subscription. + +### Example 2 +```powershell +Get-AzSecurityTask -ResourceGroupName "myService1" +``` + +```output +Id Name RecommendationType ResourceI + d +-- ---- ------------------ --------- +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/22ef553d-f13a-5227-ee4c-7cc861d28c96 22ef553d-f13a-5227-ee4c-7cc861d28c96 Enable DDoS protection standard /subsc... +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/47f736fa-0ec8-a372-de49-8cf18527930c 47f736fa-0ec8-a372-de49-8cf18527930c ConfigureTier2Waf /subsc... +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/5696e90f-833d-494c-8833-f3be335fa9cb 5696e90f-833d-494c-8833-f3be335fa9cb NetworkSecurityGroupMissingOnVm /subsc... +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/MYSERVICE1/providers/Microsoft.Security/locations/centralus/tasks/65193cce-25a1-b30f-f94e-69d52e22923c 65193cce-25a1-b30f-f94e-69d52e22923c VulnerabilityAssessmentDeployment /subsc... +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/7e28a40d-e746-4751-8340-5126d6b77ae5 7e28a40d-e746-4751-8340-5126d6b77ae5 NetworkSecurityGroupMissingOnSubnet /subsc... +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/MYSERVICE1/providers/Microsoft.Security/locations/centralus/tasks/94867597-75e5-cfb6-8b71-e5e5253a24e1 94867597-75e5-cfb6-8b71-e5e5253a24e1 EncryptionOnVm /subsc... +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/MYSERVICE1/providers/Microsoft.Security/locations/centralus/tasks/a02fffd5-1956-a6d7-73da-a87a65ae02f4 a02fffd5-1956-a6d7-73da-a87a65ae02f4 VulnerabilityAssessmentDeployment /subsc... +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/bd382d04-b478-ac77-e89f-300789032367 bd382d04-b478-ac77-e89f-300789032367 ProvisionNgfw /subsc... +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/MYSERVICE1/providers/Microsoft.Security/locations/centralus/tasks/ce43626a-d56b-6a38-49ef-3ad7a731666e ce43626a-d56b-6a38-49ef-3ad7a731666e EncryptionOnVm /subsc... +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/dcfb6365-799e-5ed4-f344-d86a0a4c2992 dcfb6365-799e-5ed4-f344-d86a0a4c2992 Enable auditing for the SQL database /subsc... +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/ed736ed1-3f42-a95a-0b9e-458c44233937 ed736ed1-3f42-a95a-0b9e-458c44233937 Enable auditing for the SQL server /subsc... +``` + +Gets all the security tasks that were discovered on resources inside a resource group. + +### Example 3 +```powershell +Get-AzSecurityTask -ResourceGroupName "myService1" -Name "22ef553d-f13a-5227-ee4c-7cc861d28c96" +``` + +```output +Id Name RecommendationType ResourceId +-- ---- ------------------ ---------- +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/22ef553d-f13a-5227-ee4c-7cc861d28c96 22ef553d-f13a-5227-ee4c-7cc861d28c96 Enable DDoS protection standard /subscripti... +``` + +Gets a specific security task. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource, SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupScope, ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Tasks.PSSecurityTask + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityTopology.md b/azps-10.1.0/Az.Security/Get-AzSecurityTopology.md new file mode 100644 index 0000000000..0c489f3888 --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityTopology.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityTopology +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityTopology.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityTopology.md +--- + +# Get-AzSecurityTopology + +## SYNOPSIS +Gets a list of Security Topologies on a subscription + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecurityTopology [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupLevelResource +``` +Get-AzSecurityTopology -ResourceGroupName <String> -Name <String> -Location <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzSecurityTopology -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Security Topologies are automatically discovered by Azure Security Center, use this cmdlet to view security topologies. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityTopology +``` + +```output +Id: /subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/topologies/virtualMachines +Name: virtualMachines +Type: Microsoft.Security/locations/topologies +CalculatedDateTime: 03-Jun-20 3:03:48 PM +TopologyResources: /subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/myvm +``` + +View all security topologies in a subscription + +### Example 2 +```powershell +Get-AzSecurityTopology -ResourceGroupName "myService1" -Location "centralus" -Name "virtualMachines" +``` + +```output +Id: /subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/topologies/virtualMachines +Name: virtualMachines +Type: Microsoft.Security/locations/topologies +CalculatedDateTime: 03-Jun-20 3:03:48 PM +TopologyResources: /subscriptions/3eeab341-f466-499c-a8be-85427e154baf7612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/myvm +``` + +Get a specific security topologies + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Topology.PSSecurityTopologies + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSecurityWorkspaceSetting.md b/azps-10.1.0/Az.Security/Get-AzSecurityWorkspaceSetting.md new file mode 100644 index 0000000000..6f1786fcfe --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSecurityWorkspaceSetting.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSecurityWorkspaceSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityWorkspaceSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSecurityWorkspaceSetting.md +--- + +# Get-AzSecurityWorkspaceSetting + +## SYNOPSIS +Gets the configured security workspace settings on a subscription. + +## SYNTAX + +### SubscriptionScope (Default) +``` +Get-AzSecurityWorkspaceSetting [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SubscriptionLevelResource +``` +Get-AzSecurityWorkspaceSetting -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Get-AzSecurityWorkspaceSetting -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet lets you discover the configured workspace that will hold the security data that was collected by the security agent that is installed in VMs inside this subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSecurityWorkspaceSetting +``` + +```output +Id Name WorkspaceId +-- ---- ----------- +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/workspaceSettings/default default /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/mainws/providers/microsoft.operationalinsights/workspaces/securityus... +``` + +Gets the workspace settings for a subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.WorkspaceSettings.PSSecurityWorkspaceSetting + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Get-AzSqlInformationProtectionPolicy.md b/azps-10.1.0/Az.Security/Get-AzSqlInformationProtectionPolicy.md new file mode 100644 index 0000000000..0384e98a0e --- /dev/null +++ b/azps-10.1.0/Az.Security/Get-AzSqlInformationProtectionPolicy.md @@ -0,0 +1,76 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Get-AzSqlInformationProtectionPolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSqlInformationProtectionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Get-AzSqlInformationProtectionPolicy.md +--- + +# Get-AzSqlInformationProtectionPolicy + +## SYNOPSIS +Retrieves the effective tenant SQL information protection policy. + +## SYNTAX + +``` +Get-AzSqlInformationProtectionPolicy [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the effective tenant SQL information protection policy. + +## EXAMPLES + +### Example +```powershell +Get-AzSqlInformationProtectionPolicy +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.string + +## OUTPUTS + +### Microsoft.Azure.Commands.SecurityCenter.Models.SqlInformationProtectionPolicy.PSSqlInformationProtectionPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/New-AzAlertsSuppressionRuleScope.md b/azps-10.1.0/Az.Security/New-AzAlertsSuppressionRuleScope.md new file mode 100644 index 0000000000..f22f7f279d --- /dev/null +++ b/azps-10.1.0/Az.Security/New-AzAlertsSuppressionRuleScope.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/new-azalertssuppressionrulescope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzAlertsSuppressionRuleScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzAlertsSuppressionRuleScope.md +--- + +# New-AzAlertsSuppressionRuleScope + +## SYNOPSIS +Helper cmdlet to create PSIScopeElement. + +## SYNTAX + +``` +New-AzAlertsSuppressionRuleScope -Field <String> [-ContainsSubstring <String>] [-AnyOf <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Helper cmdlet to create PSIScopeElement. +Usable in Set-AzAlertsSuppressionRule as part of the -AllOf parameter. + +## EXAMPLES + +### Example 1 +```powershell +$scope1 = New-AzAlertsSuppressionRuleScope -Field "entities.account.name" -ContainsSubstring "Example" +``` + +Creates a PSScopeElementContains. + +### Example 2 +```powershell +$scope2 = New-AzAlertsSuppressionRuleScope -Field "entities.file.name" -AnyOf "FileName1","FileName2","FileName3" +``` + +Creates a PSScopeElementIn. + +## PARAMETERS + +### -AnyOf +Suppress only when field equals one of those values. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainsSubstring +Suppress only when field contains this specific value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Field +Entity field to scope by. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AlertsSuppressionRules.PSIScopeElement + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/New-AzDeviceSecurityGroupAllowlistCustomAlertRuleObject.md b/azps-10.1.0/Az.Security/New-AzDeviceSecurityGroupAllowlistCustomAlertRuleObject.md new file mode 100644 index 0000000000..664ce75be3 --- /dev/null +++ b/azps-10.1.0/Az.Security/New-AzDeviceSecurityGroupAllowlistCustomAlertRuleObject.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/New-AzDeviceSecurityGroupAllowlistCustomAlertRuleObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzDeviceSecurityGroupAllowlistCustomAlertRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzDeviceSecurityGroupAllowlistCustomAlertRuleObject.md +--- + +# New-AzDeviceSecurityGroupAllowlistCustomAlertRuleObject + +## SYNOPSIS +Create new allow list custom alert rule for device security group (IoT Security) + +## SYNTAX + +``` +New-AzDeviceSecurityGroupAllowlistCustomAlertRuleObject -Enabled <Boolean> -Type <String> + -AllowlistValue <String[]> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDeviceSecurityGroupAllowlistCustomAlertRuleObject cmdlet creates a new list of allowed custom alert rules for device security group in IoT security solution. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDeviceSecurityGroupAllowlistCustomAlertRuleObject -Enabled $false -Type "LocalUserNotAllowed" -AllowlistValue @() +``` + +```output +RuleType: "LocalUserNotAllowed" +DisplayName: "Login by a local user that isn't allowed" +Description: "Get an alert when a local user that isn't allowed logins to the device" +IsEnabled: false +ValueType: "String" +AllowlistValues: [] +``` + +Create new allow list custom alert rull from type "LocalUserNotAllowed" with status set to disable + +## PARAMETERS + +### -AllowlistValue +Allow list values. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Is rule enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Rule type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSAllowlistCustomAlertRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/New-AzDeviceSecurityGroupDenylistCustomAlertRuleObject.md b/azps-10.1.0/Az.Security/New-AzDeviceSecurityGroupDenylistCustomAlertRuleObject.md new file mode 100644 index 0000000000..35066dcdee --- /dev/null +++ b/azps-10.1.0/Az.Security/New-AzDeviceSecurityGroupDenylistCustomAlertRuleObject.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/New-AzDeviceSecurityGroupDenylistCustomAlertRuleObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzDeviceSecurityGroupDenylistCustomAlertRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzDeviceSecurityGroupDenylistCustomAlertRuleObject.md +--- + +# New-AzDeviceSecurityGroupDenylistCustomAlertRuleObject + +## SYNOPSIS +Create new deny list custom alert rule for device security group (IoT Security) + +## SYNTAX + +``` +New-AzDeviceSecurityGroupDenylistCustomAlertRuleObject -Enabled <Boolean> -Type <String> + -DenylistValue <String[]> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDeviceSecurityGroupDenylistCustomAlertRuleObject cmdlet creates a new list of denyed custom alert rules for device security group in IoT security solution. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDeviceSecurityGroupDenylistCustomAlertRuleObject -Enabled $false -Type "SomeRuleType" -DenylistValue @() +``` + +```output +RuleType: "SomeRuleType" +DisplayName: "Display name for some rule type" +Description: "Description for some rule type" +IsEnabled: false +ValueType: "String" +DenylistValues: [] +``` + +Create new deny list custom alert rule with rull type "SomeRuleType" and status set to desable + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenylistValue +Deny list values. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Is rule enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Rule type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSDenylistCustomAlertRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/New-AzDeviceSecurityGroupThresholdCustomAlertRuleObject.md b/azps-10.1.0/Az.Security/New-AzDeviceSecurityGroupThresholdCustomAlertRuleObject.md new file mode 100644 index 0000000000..e6fc594d71 --- /dev/null +++ b/azps-10.1.0/Az.Security/New-AzDeviceSecurityGroupThresholdCustomAlertRuleObject.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/New-AzDeviceSecurityGroupThresholdCustomAlertRuleObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzDeviceSecurityGroupThresholdCustomAlertRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzDeviceSecurityGroupThresholdCustomAlertRuleObject.md +--- + +# New-AzDeviceSecurityGroupThresholdCustomAlertRuleObject + +## SYNOPSIS +Create new threshold custom alert rule for device security group (IoT Security) + +## SYNTAX + +``` +New-AzDeviceSecurityGroupThresholdCustomAlertRuleObject -MinThreshold <Int32> -MaxThreshold <Int32> + -Enabled <Boolean> -Type <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDeviceSecurityGroupThresholdCustomAlertRuleObject cmdlet creates a new list of threshold custom alert rules for device security group in IoT security solution. + +## EXAMPLES + +### Example 1 +```powershell +New-AzDeviceSecurityGroupThresholdCustomAlertRuleObject -MinThreshold 0 -MaxThreshold 10 -Enabled $true -Type "SomeRuleType" +``` + +```output +RuleType: "SomeRuleType" +DisplayName: "Display name for some rule type" +Description: "Description for some rule type" +IsEnabled: false +MinThreshold: 0 +MaxThreshold: 10 +``` + +Create new threshold custom alert rule from type "SomeRuleType" with status enabled ant values for minimum and maximum threshold + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Is rule enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxThreshold +Maximum threshold. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinThreshold +Minimum threshold. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Rule type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSThresholdCustomAlertRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/New-AzDeviceSecurityGroupTimeWindowRuleObject.md b/azps-10.1.0/Az.Security/New-AzDeviceSecurityGroupTimeWindowRuleObject.md new file mode 100644 index 0000000000..4d234d8aa4 --- /dev/null +++ b/azps-10.1.0/Az.Security/New-AzDeviceSecurityGroupTimeWindowRuleObject.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/New-AzDeviceSecurityGroupTimeWindowRuleObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzDeviceSecurityGroupTimeWindowRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzDeviceSecurityGroupTimeWindowRuleObject.md +--- + +# New-AzDeviceSecurityGroupTimeWindowRuleObject + +## SYNOPSIS +Create new time window rule for device security group (IoT Security) + +## SYNTAX + +``` +New-AzDeviceSecurityGroupTimeWindowRuleObject -TimeWindowSize <TimeSpan> -MinThreshold <Int32> + -MaxThreshold <Int32> -Enabled <Boolean> -Type <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzDeviceSecurityGroupTimeWindowRuleObject cmdlet creates a new list of time window alert rules for device security group in IoT security solution. + +## EXAMPLES + +### Example 1 +```powershell +$TimeWindowSize = New-TimeSpan -Minutes 5 +New-AzDeviceSecurityGroupTimeWindowRuleObject -TimeWindowSize $TimeWindowSize -MinThreshold 0 -MaxThreshold 30 -Enabled $true -Type "ActiveConnectionsNotInAllowedRange" +``` + +```output +RuleType: "ActiveConnectionsNotInAllowedRange" +DisplayName: "Number of active connections is not in allowed range" +Description: "Get an alert when the number of active connections of a device in the time window is not in the allowed range" +IsEnabled: false +MinThreshold: 0 +MaxThreshold: 30 +TimeWindowSize: "PT5M" +``` + +Create new time window rule from "ActiveConnectionsNotInAllowedRange" type + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Is rule enabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxThreshold +Maximum threshold. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinThreshold +Minimum threshold. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeWindowSize +Time window size. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Rule type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSTimeWindowCustomAlertRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/New-AzIotSecuritySolutionRecommendationConfigurationObject.md b/azps-10.1.0/Az.Security/New-AzIotSecuritySolutionRecommendationConfigurationObject.md new file mode 100644 index 0000000000..402ad36962 --- /dev/null +++ b/azps-10.1.0/Az.Security/New-AzIotSecuritySolutionRecommendationConfigurationObject.md @@ -0,0 +1,101 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/New-AzIotSecuritySolutionRecommendationConfigurationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzIotSecuritySolutionRecommendationConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzIotSecuritySolutionRecommendationConfigurationObject.md +--- + +# New-AzIotSecuritySolutionRecommendationConfigurationObject + +## SYNOPSIS +Create new recommendation configuration for iot security solution + +## SYNTAX + +``` +New-AzIotSecuritySolutionRecommendationConfigurationObject -RecommendationType <String> -Enabled <Boolean> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The AzIotSecuritySolutionRecommendationConfigurationObject creates a new recommendation configuration object for iot security solution. +This way the status of a recommendation is configured, whether it is enabled or disabled. + +## EXAMPLES + +### Example 1 +```powershell +New-AzIotSecuritySolutionRecommendationConfigurationObject -RecommendationType "IoT_ACRAuthentication" -Enabled $false +``` + +```output +RecommendationType: "IoT_ACRAuthentication" +Name: "Service prinicpal not used with ACR repository" +Status: "Disabled" +``` + +Create new recommendation configuration for recommendation type "IoT_ACRAuthentication" with status set to disable + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Status . + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecommendationType +Recommendation type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSRecommendationConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/New-AzIotSecuritySolutionUserDefinedResourcesObject.md b/azps-10.1.0/Az.Security/New-AzIotSecuritySolutionUserDefinedResourcesObject.md new file mode 100644 index 0000000000..0189861f58 --- /dev/null +++ b/azps-10.1.0/Az.Security/New-AzIotSecuritySolutionUserDefinedResourcesObject.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/New-AzIotSecuritySolutionUserDefinedResourcesObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzIotSecuritySolutionUserDefinedResourcesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzIotSecuritySolutionUserDefinedResourcesObject.md +--- + +# New-AzIotSecuritySolutionUserDefinedResourcesObject + +## SYNOPSIS +Create new user defined resources for iot security solution + +## SYNTAX + +``` +New-AzIotSecuritySolutionUserDefinedResourcesObject -Query <String> -QuerySubscriptionList <String[]> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The AzIotSecuritySolutionUserDefinedResourcesObject cmdlet creates a new user defined resources object for the iot security solution. + +## EXAMPLES + +### Example 1 +```powershell +New-AzIotSecuritySolutionUserDefinedResourcesObject -Query 'where type != "microsoft.devices/iothubs" | where name contains "v2"' ` +-QuerySubscriptionList @("XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX") +``` + +```output +Query: 'where type != "microsoft.devices/iothubs" | where name contains "v2"' +QuerySubscriptions: ["XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX"] +``` + +Create new user defined resources + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuerySubscriptionList +Query subscriptions. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSUserDefinedResources + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/New-AzSecurityAutomation.md b/azps-10.1.0/Az.Security/New-AzSecurityAutomation.md new file mode 100644 index 0000000000..775d1f1cc4 --- /dev/null +++ b/azps-10.1.0/Az.Security/New-AzSecurityAutomation.md @@ -0,0 +1,334 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/new-azsecurityautomation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzSecurityAutomation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzSecurityAutomation.md +--- + +# New-AzSecurityAutomation + +## SYNOPSIS +Creates new security automation + +## SYNTAX + +### ResourceGroupLevelResource (Default) +``` +New-AzSecurityAutomation -ResourceGroupName <String> -Name <String> -Location <String> [-Etag <String>] + [-Tag <Hashtable>] [-Description <String>] [-IsEnabled <Boolean>] -Scope <PSSecurityAutomationScope[]> + -Source <PSSecurityAutomationSource[]> -Action <PSSecurityAutomationAction[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +New-AzSecurityAutomation -ResourceId <String> -Location <String> [-Etag <String>] [-Tag <Hashtable>] + [-Description <String>] [-IsEnabled <Boolean>] -Scope <PSSecurityAutomationScope[]> + -Source <PSSecurityAutomationSource[]> -Action <PSSecurityAutomationAction[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +New-AzSecurityAutomation [-Location <String>] [-Etag <String>] [-Tag <Hashtable>] [-Description <String>] + [-IsEnabled <Boolean>] [-Scope <PSSecurityAutomationScope[]>] [-Source <PSSecurityAutomationSource[]>] + -Action <PSSecurityAutomationAction[]> -InputObject <PSSecurityAutomation> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates new security automation + +## EXAMPLES + +### Example 1 +```powershell +New-AzSecurityAutomation -Name 'ampleAutomation' -ResourceGroupName 'SampleResourceGroup' -Description 'Sample security automation' -Scope $scopes -Source $sources -Action $actions +``` + +Creates new security automation named "SampleAutomation" under resource group named "SampleResourceGroup" + +## PARAMETERS + +### -Action +A collection of the actions which are triggered if all the configured rules evaluations, within at least one rule set, are true + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationAction[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The security automation description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Entity tag is used for comparing two or more entities from the same requested resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomation +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsEnabled +Is rule enabled. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope +A collection of scopes on which the security automations logic is applied. +Supported scopes are the subscription itself or a resource group under that subscription. +The automation will only apply on defined scopes + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationScope[] +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationScope[] +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +A collection of the source event types which evaluate the security automation set of rules + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationSource[] +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationSource[] +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomation + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomation + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/New-AzSecurityAutomationActionObject.md b/azps-10.1.0/Az.Security/New-AzSecurityAutomationActionObject.md new file mode 100644 index 0000000000..1de4169113 --- /dev/null +++ b/azps-10.1.0/Az.Security/New-AzSecurityAutomationActionObject.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/new-azsecurityautomationactionobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzSecurityAutomationActionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzSecurityAutomationActionObject.md +--- + +# New-AzSecurityAutomationActionObject + +## SYNOPSIS +Creates new security automation action object + +## SYNTAX + +### SecurityAutomationActionLogicApp (Default) +``` +New-AzSecurityAutomationActionObject -LogicAppResourceId <String> -Uri <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SecurityAutomationActionEventHub +``` +New-AzSecurityAutomationActionObject -EventHubResourceId <String> -ConnectionString <String> + [-SasPolicyName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SecurityAutomationActionWorkspace +``` +New-AzSecurityAutomationActionObject -WorkspaceResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates new security automation action object + +## EXAMPLES + +### Example 1 +```powershell +New-AzSecurityAutomationActionObject -WorkspaceResourceId '/subscriptions/64ac75e7-15ff-4963-8c07-a16016505e0f/resourceGroups/sampleResourceGroup/providers/Microsoft.OperationalInsights/workspaces/surashed-test' +``` + +Creates new security automation action with workspace type + +### Example 2 +```powershell +New-AzSecurityAutomationActionObject -LogicAppResourceId '/subscriptions/03b601f1-7eca-4496-8f8d-355219eee254/resourceGroups/sampleResourceGroup/providers/Microsoft.Logic/workflows/LA' -Uri 'https://dummy.com/' +``` + +Creates new security automation action with logicApp type + +### Example 3 +```powershell +New-AzSecurityAutomationActionObject -EventHubResourceId 'subscriptions/03b601f1-7eca-4496-8f8d-355219eee254/resourceGroups/sampleResourceGroup/providers/Microsoft.EventHub/namespaces/cus-wsp-fake-assessment/eventhubs/cus-wsp-fake-assessment' -ConnectionString 'Endpoint=sb://dummy/;SharedAccessKeyName=dummy;SharedAccessKey=dummy;EntityPath=dummy' +``` + +Creates new security automation action with even-hub type + +## PARAMETERS + +### -ConnectionString +The target Event Hub connection string + +```yaml +Type: String +Parameter Sets: SecurityAutomationActionEventHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubResourceId +The target Event Hub Azure Resource ID + +```yaml +Type: String +Parameter Sets: SecurityAutomationActionEventHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogicAppResourceId +The triggered Logic App Azure Resource ID. +This can also reside on other subscriptions, given that you have permissions to trigger the Logic App + +```yaml +Type: String +Parameter Sets: SecurityAutomationActionLogicApp +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SasPolicyName +The target Event Hub SAS policy name + +```yaml +Type: String +Parameter Sets: SecurityAutomationActionEventHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +The Logic App trigger URI endpoint (it will not be included in any response) + +```yaml +Type: String +Parameter Sets: SecurityAutomationActionLogicApp +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +The fully qualified Log Analytics Workspace Azure Resource ID + +```yaml +Type: String +Parameter Sets: SecurityAutomationActionWorkspace +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationAction + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/New-AzSecurityAutomationRuleObject.md b/azps-10.1.0/Az.Security/New-AzSecurityAutomationRuleObject.md new file mode 100644 index 0000000000..f8792932a0 --- /dev/null +++ b/azps-10.1.0/Az.Security/New-AzSecurityAutomationRuleObject.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/new-azsecurityautomationruleobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzSecurityAutomationRuleObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzSecurityAutomationRuleObject.md +--- + +# New-AzSecurityAutomationRuleObject + +## SYNOPSIS +Creates security automation rule object + +## SYNTAX + +``` +New-AzSecurityAutomationRuleObject -PropertyJPath <String> -Operator <String> -ExpectedValue <String> + -PropertyType <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates security automation rule object + +## EXAMPLES + +### Example 1 +```powershell +New-AzSecurityAutomationRuleObject -PropertyJPath 'properties.metadata.severity' -PropertyType 'String' -Operator 'Equals' -ExpectedValue 'High' +``` + +Creates security automation rule object that filters messages that with "High" severity + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpectedValue +The expected value + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operator +A valid comparer operator to use. +A case-insensitive comparison will be applied for String PropertyType + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertyJPath +The JPath of the entity model property that should be checked + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertyType +The data type of the compared operands (string, integer, floating point number or a boolean \[true/false\]\] + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationTriggeringRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/New-AzSecurityAutomationRuleSetObject.md b/azps-10.1.0/Az.Security/New-AzSecurityAutomationRuleSetObject.md new file mode 100644 index 0000000000..1887c72263 --- /dev/null +++ b/azps-10.1.0/Az.Security/New-AzSecurityAutomationRuleSetObject.md @@ -0,0 +1,81 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/new-azsecurityautomationrulesetobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzSecurityAutomationRuleSetObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzSecurityAutomationRuleSetObject.md +--- + +# New-AzSecurityAutomationRuleSetObject + +## SYNOPSIS +Creates security automation rule set object + +## SYNTAX + +``` +New-AzSecurityAutomationRuleSetObject -Rules <PSSecurityAutomationTriggeringRule[]> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates security automation rule set object + +## EXAMPLES + +### Example 1 +```powershell +New-AzSecurityAutomationRuleSetObject -Rule $rule +``` + +Creates security automation rule set object + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rules +A rule which is evaluated upon event interception. +The rule is configured by comparing a specific value from the event model to an expected value. +This comparison is done by using one of the supported operators set + +```yaml +Type: PSSecurityAutomationTriggeringRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationRuleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/New-AzSecurityAutomationScopeObject.md b/azps-10.1.0/Az.Security/New-AzSecurityAutomationScopeObject.md new file mode 100644 index 0000000000..367c87c3bf --- /dev/null +++ b/azps-10.1.0/Az.Security/New-AzSecurityAutomationScopeObject.md @@ -0,0 +1,95 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/new-azsecurityautomationscopeobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzSecurityAutomationScopeObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzSecurityAutomationScopeObject.md +--- + +# New-AzSecurityAutomationScopeObject + +## SYNOPSIS +Creates security automation scope object + +## SYNTAX + +``` +New-AzSecurityAutomationScopeObject -Description <String> -ScopePath <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates security automation scope object + +## EXAMPLES + +### Example 1 +```powershell +New-AzSecurityAutomationScopeObject -Description 'Security assessments that relate to the resource group myResourceGroup within the subscription a5caac9c-5c04-49af-b3d0-e204f40345d5' -ScopePath '/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/myResourceGroup' +``` + +Creates security automation scope object + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The resources scope description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScopePath +The resources scope path. +Can be the subscription on which the automation is defined on or a resource group under that subscription (fully qualified Azure resource IDs) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationScope + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/New-AzSecurityAutomationSourceObject.md b/azps-10.1.0/Az.Security/New-AzSecurityAutomationSourceObject.md new file mode 100644 index 0000000000..454f47024c --- /dev/null +++ b/azps-10.1.0/Az.Security/New-AzSecurityAutomationSourceObject.md @@ -0,0 +1,101 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/new-azsecurityautomationsourceobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzSecurityAutomationSourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/New-AzSecurityAutomationSourceObject.md +--- + +# New-AzSecurityAutomationSourceObject + +## SYNOPSIS +Creates security automation source object + +## SYNTAX + +### SecurityAutomationSource (Default) +``` +New-AzSecurityAutomationSourceObject [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SecurityAutomationActionLogicApp +``` +New-AzSecurityAutomationSourceObject -EventSource <String> -RuleSets <PSSecurityAutomationRuleSet[]> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates security automation source object + +## EXAMPLES + +### Example 1 +```powershell +New-AzSecurityAutomationSourceObject -EventSource 'Assessments' -RuleSet $ruleSet +``` + +Creates security automation source object + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSource +The triggered Logic App Azure Resource ID. +This can also reside on other subscriptions, given that you have permissions to trigger the Logic App + +```yaml +Type: String +Parameter Sets: SecurityAutomationActionLogicApp +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleSets +The Logic App trigger URI endpoint (it will not be included in any response) + +```yaml +Type: PSSecurityAutomationRuleSet[] +Parameter Sets: SecurityAutomationActionLogicApp +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomationSource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Remove-AzAlertsSuppressionRule.md b/azps-10.1.0/Az.Security/Remove-AzAlertsSuppressionRule.md new file mode 100644 index 0000000000..f6069ef367 --- /dev/null +++ b/azps-10.1.0/Az.Security/Remove-AzAlertsSuppressionRule.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/remove-azalertssuppressionrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzAlertsSuppressionRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzAlertsSuppressionRule.md +--- + +# Remove-AzAlertsSuppressionRule + +## SYNOPSIS +Deletes an alerts suppression rule. + +## SYNTAX + +### SubscriptionLevelResource (Default) +``` +Remove-AzAlertsSuppressionRule -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzAlertsSuppressionRule -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzAlertsSuppressionRule -InputObject <PSAlertsSuppressionRule> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an alerts suppression rule. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzAlertsSuppressionRule -Name "Example" +``` + +Deleted an alerts suppression rule with the name "Example" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.AlertsSuppressionRules.PSAlertsSuppressionRule +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the operation was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Models.AlertsSuppressionRules.PSAlertsSuppressionRule + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Remove-AzDeviceSecurityGroup.md b/azps-10.1.0/Az.Security/Remove-AzDeviceSecurityGroup.md new file mode 100644 index 0000000000..601aa5af99 --- /dev/null +++ b/azps-10.1.0/Az.Security/Remove-AzDeviceSecurityGroup.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Remove-AzDeviceSecurityGroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzDeviceSecurityGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzDeviceSecurityGroup.md +--- + +# Remove-AzDeviceSecurityGroup + +## SYNOPSIS +Delete device security group + +## SYNTAX + +### ResourceIdLevelResource (Default) +``` +Remove-AzDeviceSecurityGroup -Name <String> -HubResourceId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzDeviceSecurityGroup -InputObject <PSDeviceSecurityGroup> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzDeviceSecurityGroup -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzDeviceSecurityGroup cmdlet deletes a device security group defined in iot security solution. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzDeviceSecurityGroup -Name "MySecurityGroup" -HubResourceId "/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Devices/IotHubs/MyHub" +``` + +Delete the device security group "MySecurityGroup" of iot hub with resource id "/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Devices/IotHubs/MyHub" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceIdLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSDeviceSecurityGroup +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceIdLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the operation was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSDeviceSecurityGroup + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Remove-AzIotSecuritySolution.md b/azps-10.1.0/Az.Security/Remove-AzIotSecuritySolution.md new file mode 100644 index 0000000000..4bf8e77425 --- /dev/null +++ b/azps-10.1.0/Az.Security/Remove-AzIotSecuritySolution.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Remove-AzIotSecuritySolution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzIotSecuritySolution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzIotSecuritySolution.md +--- + +# Remove-AzIotSecuritySolution + +## SYNOPSIS +Delete IoT security solution + +## SYNTAX + +### ResourceGroupLevelResource (Default) +``` +Remove-AzIotSecuritySolution -Name <String> -ResourceGroupName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzIotSecuritySolution -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzIotSecuritySolution -InputObject <PSIotSecuritySolution> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzIotSecuritySolution cmdlet deletes a specific iot security solution. +The IoT security solution collects security data and events from iot devices and iot hub to help prevent and detect threats. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzIotSecuritySolution -Name "MySample" -ResourceGroupName "MyResourceGroup" +``` + +Delete IoT security solution "MySample" with resource group "MyResourceGroup" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSIotSecuritySolution +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the operation was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSIotSecuritySolution + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Remove-AzJitNetworkAccessPolicy.md b/azps-10.1.0/Az.Security/Remove-AzJitNetworkAccessPolicy.md new file mode 100644 index 0000000000..287db1b23f --- /dev/null +++ b/azps-10.1.0/Az.Security/Remove-AzJitNetworkAccessPolicy.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Remove-AzJitNetworkAccessPolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzJitNetworkAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzJitNetworkAccessPolicy.md +--- + +# Remove-AzJitNetworkAccessPolicy + +## SYNOPSIS +Deletes a JIT network access policy. + +## SYNTAX + +### ResourceGroupLevelResource (Default) +``` +Remove-AzJitNetworkAccessPolicy -ResourceGroupName <String> -Location <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzJitNetworkAccessPolicy -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzJitNetworkAccessPolicy -InputObject <PSSecurityJitNetworkAccessPolicy> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Just In Time network access policy. +After this action a user will not be able to request temporary network connection on the VMs that were configured inside the deleted policy. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzJitNetworkAccessPolicy -ResourceGroupName "myService1" -Location "centralus" -Name "default" +``` + +Deletes a Just In Time network access policy. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicy +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the operation was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the jit Network Access Policy resource. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicy + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Remove-AzSecurityAssessment.md b/azps-10.1.0/Az.Security/Remove-AzSecurityAssessment.md new file mode 100644 index 0000000000..778cee2daa --- /dev/null +++ b/azps-10.1.0/Az.Security/Remove-AzSecurityAssessment.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Remove-AzSecurityAssessment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzSecurityAssessment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzSecurityAssessment.md +--- + +# Remove-AzSecurityAssessment + +## SYNOPSIS +Deletes a security assessment result from a subscription. + +## SYNTAX + +### SubscriptionLevelResource (Default) +``` +Remove-AzSecurityAssessment -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceIdLevelResource +``` +Remove-AzSecurityAssessment -Name <String> [-AssessedResourceId <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzSecurityAssessment -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzSecurityAssessment -InputObject <PSSecurityAssessment> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a security assessment result from a subscription, usually used when a resoruce is deleted or when the assessment is not relevant for a specific resource anymore + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSecurityAssessment -Name 4FB6C0A0-1137-42C7-A1C7-4BD37C91DE8D +``` + +Deletes an assessment result on a subscription + +## PARAMETERS + +### -AssessedResourceId +Full resource ID of the resource that the assessment is calculated on. + +```yaml +Type: System.String +Parameter Sets: ResourceIdLevelResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Assessments.PSSecurityAssessment +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource, ResourceIdLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the operation was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Models.Assessments.PSSecurityAssessment + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Remove-AzSecurityAssessmentMetadata.md b/azps-10.1.0/Az.Security/Remove-AzSecurityAssessmentMetadata.md new file mode 100644 index 0000000000..aca88a90fd --- /dev/null +++ b/azps-10.1.0/Az.Security/Remove-AzSecurityAssessmentMetadata.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Remove-AzSecurityAssessmentMetadata +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzSecurityAssessmentMetadata.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzSecurityAssessmentMetadata.md +--- + +# Remove-AzSecurityAssessmentMetadata + +## SYNOPSIS +Deletes a security assessment metadata from a subscription. + +## SYNTAX + +### SubscriptionLevelResource (Default) +``` +Remove-AzSecurityAssessmentMetadata -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzSecurityAssessmentMetadata -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzSecurityAssessmentMetadata -InputObject <PSSecurityAssessmentMetadata> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a security assessment metadata from a subscription. This action will delete the assessment type and all the relevant assessment results from the subscription. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSecurityAssessmentMetadata -Name 4FB6C0A0-1137-42C7-A1C7-4BD37C91DE8D +``` + +Deletes an assessment type from a subscription + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.AssessmentMetadata.PSSecurityAssessmentMetadata +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the operation was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Models.AssessmentMetadata.PSSecurityAssessmentMetadata + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Remove-AzSecurityAutomation.md b/azps-10.1.0/Az.Security/Remove-AzSecurityAutomation.md new file mode 100644 index 0000000000..352e3da5bd --- /dev/null +++ b/azps-10.1.0/Az.Security/Remove-AzSecurityAutomation.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/remove-azsecurityautomation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzSecurityAutomation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzSecurityAutomation.md +--- + +# Remove-AzSecurityAutomation + +## SYNOPSIS +Deletes security automation + +## SYNTAX + +### ResourceGroupLevelResource (Default) +``` +Remove-AzSecurityAutomation -ResourceGroupName <String> -Name <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzSecurityAutomation -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzSecurityAutomation -InputObject <PSSecurityAutomation> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes security automation + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSecurityAutomation -ResourceGroupName 'sampleResourceGroup' -Name 'sampleAutomation' +``` + +Deletes security automation named 'sampleAutomation' under resource group named 'sampleResourceGroup' + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomation +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the operation was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Models.Automations.PSSecurityAutomation + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Remove-AzSecurityContact.md b/azps-10.1.0/Az.Security/Remove-AzSecurityContact.md new file mode 100644 index 0000000000..e73804b04a --- /dev/null +++ b/azps-10.1.0/Az.Security/Remove-AzSecurityContact.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Remove-AzSecurityContact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzSecurityContact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzSecurityContact.md +--- + +# Remove-AzSecurityContact + +## SYNOPSIS +Deletes a security contact. + +## SYNTAX + +### SubscriptionLevelResource (Default) +``` +Remove-AzSecurityContact -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzSecurityContact -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzSecurityContact -InputObject <PSSecurityContact> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a security contact. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSecurityContact -Name "default1" +``` + +Deletes the "default1" security contact + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.SecurityContacts.PSSecurityContact +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the operation was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Models.SecurityContacts.PSSecurityContact + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Remove-AzSecuritySqlVulnerabilityAssessmentBaseline.md b/azps-10.1.0/Az.Security/Remove-AzSecuritySqlVulnerabilityAssessmentBaseline.md new file mode 100644 index 0000000000..cd58552c31 --- /dev/null +++ b/azps-10.1.0/Az.Security/Remove-AzSecuritySqlVulnerabilityAssessmentBaseline.md @@ -0,0 +1,333 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/remove-azsecuritysqlvulnerabilityassessmentbaseline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzSecuritySqlVulnerabilityAssessmentBaseline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzSecuritySqlVulnerabilityAssessmentBaseline.md +--- + +# Remove-AzSecuritySqlVulnerabilityAssessmentBaseline + +## SYNOPSIS +Removes SQL vulnerability assessment baseline. + +## SYNTAX + +### ResourceId (Default) +``` +Remove-AzSecuritySqlVulnerabilityAssessmentBaseline -RuleId <String> [-PassThru] [-Force] -ResourceId <String> + -WorkspaceId <String> -Server <String> -Database <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### OnPremMachines +``` +Remove-AzSecuritySqlVulnerabilityAssessmentBaseline -RuleId <String> [-PassThru] [-Force] -WorkspaceId <String> + -Server <String> -Database <String> -ComputerName <String> -VmUuid <String> -AgentId <String> + -WorkspaceResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzSecuritySqlVulnerabilityAssessmentBaseline -InputObject <PSSqlVulnerabilityAssessmentBaselineResults> + [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes SQL vulnerability assessment baseline. + +## EXAMPLES + +### Example 1: Remove baseline on a specific rule with resource id parameters +```powershell +Remove-AzSecuritySqlVulnerabilityAssessmentBaseline -ResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onPremiseMachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -RuleId "VA2108" +``` + +```output +Removing baseline for VA2108 +Are you sure you want to proceed with removing baseline for rule VA2108 +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +``` + +Example of using resource id parameters. +Supported resources are: + +- ARC: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HybridCompute/machines/{machineName} +- VM: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{machineName} +- On-Premise: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.operationalinsights/workspaces/{workspaceName}/onPremiseMachines/{machineName} + +### Example 2: Remove baseline on a specific rule with on premise parameters +```powershell +Remove-AzSecuritySqlVulnerabilityAssessmentBaseline -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -RuleId "VA2108" +``` + +```output +Removing baseline for VA2108 +Are you sure you want to proceed with removing baseline for rule VA2108 +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +``` + +Example of using on premise parametes. + +### Example 3: Remove all baselines on SQL Database using pipe +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentBaseline -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master | Remove-AzSecuritySqlVulnerabilityAssessmentBaseline -Force +``` + +Example for force removing all the baslines for all rules on a specific database. + +## PARAMETERS + +### -AgentId +Agent ID - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Computer full name - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database +Database name + +```yaml +Type: System.String +Parameter Sets: ResourceId, OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force remove baseline without confirmation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.SecurityCenter.Models.SqlVulnerabilityAssessment.PSSqlVulnerabilityAssessmentBaselineResults +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Return whether the operation was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. +Supported resources are: + +- ARC: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HybridCompute/machines/{machineName} +- VM: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{machineName} +- On-Premise: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.operationalinsights/workspaces/{workspaceName}/onPremiseMachines/{machineName} + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Vulnerability assessment rule ID + +```yaml +Type: System.String +Parameter Sets: ResourceId, OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +Server name + +```yaml +Type: System.String +Parameter Sets: ResourceId, OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmUuid +Virtual machine universal unique identifier - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceId +Workspace ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId, OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +Workspace resource ID - on premise parameter + +```yaml +Type: System.String +Parameter Sets: OnPremMachines +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.SecurityCenter.Models.SqlVulnerabilityAssessment.PSSqlVulnerabilityAssessmentBaselineResults + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Add-AzSecuritySqlVulnerabilityAssessmentBaseline](https://learn.microsoft.com/powershell/module/az.security/add-azsecuritysqlvulnerabilityassessmentbaseline) + +[Get-AzSecuritySqlVulnerabilityAssessmentBaseline](https://learn.microsoft.com/powershell/module/az.security/get-azsecuritysqlvulnerabilityassessmentbaseline) + +[Set-AzSecuritySqlVulnerabilityAssessmentBaseline](https://learn.microsoft.com/powershell/module/az.security/set-azsecuritysqlvulnerabilityassessmentbaseline) \ No newline at end of file diff --git a/azps-10.1.0/Az.Security/Remove-AzSecurityWorkspaceSetting.md b/azps-10.1.0/Az.Security/Remove-AzSecurityWorkspaceSetting.md new file mode 100644 index 0000000000..e5444a224c --- /dev/null +++ b/azps-10.1.0/Az.Security/Remove-AzSecurityWorkspaceSetting.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Remove-AzSecurityWorkspaceSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzSecurityWorkspaceSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Remove-AzSecurityWorkspaceSetting.md +--- + +# Remove-AzSecurityWorkspaceSetting + +## SYNOPSIS +Deletes the security workspace setting for this subscription. + +## SYNTAX + +### SubscriptionLevelResource (Default) +``` +Remove-AzSecurityWorkspaceSetting -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Remove-AzSecurityWorkspaceSetting -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Remove-AzSecurityWorkspaceSetting -InputObject <PSSecurityWorkspaceSetting> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the security workspace setting for this subscription. +This action will make the newly installed security agents to report to the default workspace of this subscription. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSecurityWorkspaceSetting -Name "default" +``` + +Deletes the security workspace setting for this subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.WorkspaceSettings.PSSecurityWorkspaceSetting +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the operation was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Models.WorkspaceSettings.PSSecurityWorkspaceSetting + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Set-AzAlertsSuppressionRule.md b/azps-10.1.0/Az.Security/Set-AzAlertsSuppressionRule.md new file mode 100644 index 0000000000..a2afe3f68e --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzAlertsSuppressionRule.md @@ -0,0 +1,291 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/set-azalertssuppressionrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzAlertsSuppressionRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzAlertsSuppressionRule.md +--- + +# Set-AzAlertsSuppressionRule + +## SYNOPSIS +Create or update an alerts suppression rule. + +## SYNTAX + +### RuleNameWithParameters (Default) +``` +Set-AzAlertsSuppressionRule -Name <String> -AlertType <String> [-ExpirationDateUtc <DateTime>] -Reason <String> + -State <PSRuleState> [-Comment <String>] [-SuppressionAlertsScope <PSSuppressionAlertsScope>] + [-AllOf <PSIScopeElement[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObject +``` +Set-AzAlertsSuppressionRule -InputObject <PSAlertsSuppressionRule> [-Name <String>] [-AlertType <String>] + [-ExpirationDateUtc <DateTime>] [-Reason <String>] [-State <PSRuleState>] [-Comment <String>] + [-SuppressionAlertsScope <PSSuppressionAlertsScope>] [-AllOf <PSIScopeElement[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update an alerts suppression rule. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzAlertsSuppressionRule -Name "Example" -State Enabled -Comment "Example of a comment" -AlertType "AzureDNS_CurrencyMining" -Reason "Other" -AllOf @([Microsoft.Azure.Commands.Security.Models.AlertsSuppressionRules.PSScopeElementContains]::new("entities.account.name", "example")) -ExpirationDateUtc 2024-10-17T15:02:24.7511441Z +``` + +The above example creates a new suppression rule with the name "Example" to suppress alerts of type (Digital currency mining activity)[https://learn.microsoft.com/en-us/azure/defender-for-cloud/alerts-reference] that contains "example" as part of their account name. + +## PARAMETERS + +### -AlertType +Alert type to suppress. + +```yaml +Type: System.String +Parameter Sets: RuleNameWithParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllOf +Scope the suppression rule using specific entities. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.AlertsSuppressionRules.PSIScopeElement[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +Comment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDateUtc +Set an expiration data for the rule, expected to be in a UTC format. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.AlertsSuppressionRules.PSAlertsSuppressionRule +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Alert suppression rule name, needs to be unique per subscription. + +```yaml +Type: System.String +Parameter Sets: RuleNameWithParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reason +The reason for creating the suppression rule. + +```yaml +Type: System.String +Parameter Sets: RuleNameWithParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +State of the rule, Enabled/Disabled + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.AlertsSuppressionRules.PSRuleState +Parameter Sets: RuleNameWithParameters +Aliases: +Accepted values: Enabled, Disabled, Expired + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.AlertsSuppressionRules.PSRuleState +Parameter Sets: InputObject +Aliases: +Accepted values: Enabled, Disabled, Expired + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuppressionAlertsScope +Scope the suppression rule using specific entities. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.AlertsSuppressionRules.PSSuppressionAlertsScope +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Security.Models.AlertsSuppressionRules.PSAlertsSuppressionRule + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AlertsSuppressionRules.PSAlertsSuppressionRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Set-AzDeviceSecurityGroup.md b/azps-10.1.0/Az.Security/Set-AzDeviceSecurityGroup.md new file mode 100644 index 0000000000..a67b47811d --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzDeviceSecurityGroup.md @@ -0,0 +1,332 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Set-AzDeviceSecurityGroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzDeviceSecurityGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzDeviceSecurityGroup.md +--- + +# Set-AzDeviceSecurityGroup + +## SYNOPSIS +Create or update device security group + +## SYNTAX + +### ResourceIdLevelResource (Default) +``` +Set-AzDeviceSecurityGroup -Name <String> -HubResourceId <String> + [-ThresholdRule <PSThresholdCustomAlertRule[]>] [-TimeWindowRule <PSTimeWindowCustomAlertRule[]>] + [-AllowlistRule <PSAllowlistCustomAlertRule[]>] [-DenylistRule <PSDenylistCustomAlertRule[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Set-AzDeviceSecurityGroup [-ThresholdRule <PSThresholdCustomAlertRule[]>] + [-TimeWindowRule <PSTimeWindowCustomAlertRule[]>] [-AllowlistRule <PSAllowlistCustomAlertRule[]>] + [-DenylistRule <PSDenylistCustomAlertRule[]>] -InputObject <PSDeviceSecurityGroup> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Set-AzDeviceSecurityGroup [-ThresholdRule <PSThresholdCustomAlertRule[]>] + [-TimeWindowRule <PSTimeWindowCustomAlertRule[]>] [-AllowlistRule <PSAllowlistCustomAlertRule[]>] + [-DenylistRule <PSDenylistCustomAlertRule[]>] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzDeviceSecurityGroup cmdlet creates or updates a device security group defined in iot security solution. + +## EXAMPLES + +### Example 1 +```powershell +$TimeWindowSize = New-TimeSpan -Minutes 5 +$TimeWindowRule = New-AzDeviceSecurityGroupTimeWindowRuleObject -Type "ActiveConnectionsNotInAllowedRange" -Enabled $true ` +-MaxThreshold 30 -MinThreshold 0 -TimeWindowSize $TimeWindowSize +Set-AzDeviceSecurityGroup -Name "MySecurityGroup" ` +-HubResourceId "/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Devices/IotHubs/MyHub" ` +-TimeWindowRule $TimeWindowRules +``` + +```output +Id: "/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Devices/IotHubs/MyHub/providers/Microsoft.Security/deviceSecurityGroups/MySecurityGroup" +Name: "MySecurityGroup" +Type: "Microsoft.Security/deviceSecurityGroups" +ThresholdRules: [] +TimeWindowRules: [ + { + RuleType: "ActiveConnectionsNotInAllowedRange" + DisplayName: "Number of active connections is not in allowed range" + Description: "Get an alert when the number of active connections of a device in the time window is not in the allowed range" + IsEnabled: true + MinThreshold: 0 + MaxThreshold: 0 + TimeWindowSize: "PT5M" + }] +AllowlistRules: [ + { + RuleType": "ConnectionToIpNotAllowed", + DisplayName: "Outbound connection to an ip that isn't allowed" + Description: "Get an alert when an outbound connection is created between your device and an ip that isn't allowed" + IsEnabled: false + ValueType: "IpCidr" + AllowlistValues: [] + }, + { + RuleType: "LocalUserNotAllowed" + DisplayName: "Login by a local user that isn't allowed" + Description: "Get an alert when a local user that isn't allowed logins to the device" + IsEnabled: false + ValueType: "String" + AllowlistValues: [] + }] +DenylistRules: [] +``` + +Update existing device security group from IoT Hub "/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Devices/IotHubs/MyHub" with rule type "ActiveConnectionsNotInAllowedRange" + +## PARAMETERS + +### -AllowlistRule +Allow list rules. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSAllowlistCustomAlertRule[] +Parameter Sets: ResourceIdLevelResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSAllowlistCustomAlertRule[] +Parameter Sets: InputObject, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DenylistRule +Deny list rules. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSDenylistCustomAlertRule[] +Parameter Sets: ResourceIdLevelResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSDenylistCustomAlertRule[] +Parameter Sets: InputObject, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HubResourceId +IoT Hub resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSDeviceSecurityGroup +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceIdLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ThresholdRule +Threshold rules. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSThresholdCustomAlertRule[] +Parameter Sets: ResourceIdLevelResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSThresholdCustomAlertRule[] +Parameter Sets: InputObject, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeWindowRule +Time window rules. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSTimeWindowCustomAlertRule[] +Parameter Sets: ResourceIdLevelResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSTimeWindowCustomAlertRule[] +Parameter Sets: InputObject, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSThresholdCustomAlertRule[] + +### Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSTimeWindowCustomAlertRule[] + +### Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSAllowlistCustomAlertRule[] + +### Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSDenylistCustomAlertRule[] + +### Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSDeviceSecurityGroup + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.DeviceSecurityGroups.PSDeviceSecurityGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Set-AzIotSecuritySolution.md b/azps-10.1.0/Az.Security/Set-AzIotSecuritySolution.md new file mode 100644 index 0000000000..7c17734c64 --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzIotSecuritySolution.md @@ -0,0 +1,522 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Set-AzIotSecuritySolution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzIotSecuritySolution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzIotSecuritySolution.md +--- + +# Set-AzIotSecuritySolution + +## SYNOPSIS +Create or update IoT security solution + +## SYNTAX + +### ResourceGroupLevelResource (Default) +``` +Set-AzIotSecuritySolution -Name <String> -ResourceGroupName <String> [-Tag <Hashtable>] -Location <String> + -Workspace <String> -DisplayName <String> [-Enabled <Boolean>] [-Export <String[]>] + [-DisabledDataSource <String[]>] -IotHub <String[]> [-UserDefinedResource <PSUserDefinedResources>] + [-RecommendationsConfiguration <PSRecommendationConfiguration[]>] [-UnmaskedIpLoggingStatus <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Set-AzIotSecuritySolution -InputObject <PSIotSecuritySolution> [-Tag <Hashtable>] -Location <String> + -Workspace <String> -DisplayName <String> [-Enabled <Boolean>] [-Export <String[]>] + [-DisabledDataSource <String[]>] -IotHub <String[]> [-UserDefinedResource <PSUserDefinedResources>] + [-RecommendationsConfiguration <PSRecommendationConfiguration[]>] [-UnmaskedIpLoggingStatus <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Set-AzIotSecuritySolution -ResourceId <String> [-Tag <Hashtable>] -Location <String> -Workspace <String> + -DisplayName <String> [-Enabled <Boolean>] [-Export <String[]>] [-DisabledDataSource <String[]>] + -IotHub <String[]> [-UserDefinedResource <PSUserDefinedResources>] + [-RecommendationsConfiguration <PSRecommendationConfiguration[]>] [-UnmaskedIpLoggingStatus <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzIotSecuritySolution cmdlet creates or updates a specific iot security solution. +The IoT security solution collects security data and events from iot devices and iot hub to help prevent and detect threats. +The name of iot security solution should be identical to the name of the iot hub. + +## EXAMPLES + +### Example 1 +```powershell +$Workspace = "/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MichalResourceGroup/providers/Microsoft.OperationalInsights/workspaces/IoTHubWorkspace" +$IotHubs = @("/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MichalResourceGroup/providers/Microsoft.Devices/IotHubs/MySample") +Set-AzIotSecuritySolution -Name "MySample" -ResourceGroupName "MyResourceGroup" -Location "West US" ` +-Workspace $Workspace -DisplayName "MySample" -Enabled $true -IotHub $IotHubs +``` + +```output +Id: "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Security/IoTSecuritySolutions/MySample" +Name: "MySample" +Type: "Microsoft.Security/IoTSecuritySolutions" +Location: "westus" +DisplayName: "MySample" +status: "Enabled" +Export: ["RawEvents"] +DisabledDataSources: ["TwinData"] +Workspace: "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourcegroups/MyResourceGroup/providers/microsoft.operationalinsights/workspaces/MyLA" +AdditionalWorkspaces: null +IotHubs: ["/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourcegroups/MyResourceGroup/providers/microsoft.devices/iothubs/MySample"] +UserDefinedResources: { + Query: "" + QuerySubscriptions: [] +} +RecommendationsConfiguration: [ +{ + RecommendationType: "IoT_ACRAuthentication" + Name: "Service prinicpal not used with ACR repository" + Status: "Enabled" +} +{ + RecommendationType: "IoT_AgentSendsUnutilizedMessages" + Name: "Agent sending underutilized messages" + Status: "Enabled" + }] +AutoDiscoveredResources: ["/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourcegroups/MyResourceGroup/providers/microsoft.devices/iothubs/MySample"] +UnmaskedIpLoggingStatus: "Enabled" +Tags: {} +``` + +Create new iot security solution "MySample" for IoT hub with resource id "/subscriptions/XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MichalResourceGroup/providers/Microsoft.Devices/IotHubs/MySample" +(the name of the solution should be identical to the name of the IoT hub) + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisabledDataSource +Disabled data sources. + +```yaml +Type: System.String[] +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String[] +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Status . + +```yaml +Type: System.Boolean +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Boolean +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Export +Export data. + +```yaml +Type: System.String[] +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String[] +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSIotSecuritySolution +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHub +Iot hubs. + +```yaml +Type: System.String[] +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String[] +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecommendationsConfiguration +Recommendations configuration. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSRecommendationConfiguration[] +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSRecommendationConfiguration[] +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnmaskedIpLoggingStatus +Unmasked ip logging status. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserDefinedResource +User defined resources. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSUserDefinedResources +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSUserDefinedResources +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workspace +Workspace ID. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSIotSecuritySolution + +### System.String + +### System.Collections.Hashtable + +### System.String[] + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSUserDefinedResources + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSRecommendationConfiguration[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSIotSecuritySolution + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Set-AzJitNetworkAccessPolicy.md b/azps-10.1.0/Az.Security/Set-AzJitNetworkAccessPolicy.md new file mode 100644 index 0000000000..f55757b7dc --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzJitNetworkAccessPolicy.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Set-AzJitNetworkAccessPolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzJitNetworkAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzJitNetworkAccessPolicy.md +--- + +# Set-AzJitNetworkAccessPolicy + +## SYNOPSIS +Updates JIT network access policy. + +## SYNTAX + +``` +Set-AzJitNetworkAccessPolicy -ResourceGroupName <String> -Location <String> -Name <String> + -VirtualMachine <PSSecurityJitNetworkAccessPolicyVirtualMachine[]> -Kind <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates JIT network access policy. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzJitNetworkAccessPolicy -ResourceGroupName "myService1" -Location "centralus" -Name "default" -VirtualMachine $vmRules -Kind "Basic" +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/jitNetworkAccessPolicies/default +Name : default +Kind : Basic +VirtualMachines : {/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/testService} +Requests : {} +ProvisioningState : Succeeded +``` + +Updates a JIT network access policy with new VM rules. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Jit Network Access Policy Kind. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachine +Virtual Machines. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyVirtualMachine[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Set-AzSecurityAlert.md b/azps-10.1.0/Az.Security/Set-AzSecurityAlert.md new file mode 100644 index 0000000000..40b761a712 --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzSecurityAlert.md @@ -0,0 +1,253 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Set-AzSecurityAlert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityAlert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityAlert.md +--- + +# Set-AzSecurityAlert + +## SYNOPSIS +Updates a security alert state. + +## SYNTAX + +### SubscriptionLevelResource (Default) +``` +Set-AzSecurityAlert -Location <String> -Name <String> -ActionType <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceGroupLevelResource +``` +Set-AzSecurityAlert -ResourceGroupName <String> -Location <String> -Name <String> -ActionType <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Set-AzSecurityAlert -ActionType <String> -ResourceId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Set-AzSecurityAlert [-ActionType <String>] -InputObject <PSSecurityAlert> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectV3 +``` +Set-AzSecurityAlert -InputObjectV3 <PSSecurityAlertV3> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets a security alert state. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSecurityAlert -Location "centralus" -ResourceGroupName "RSG" -Name "2518710774294070750_FFF23C70-80EF-4A8B-9122-507B0EA8DFFF" -ActionType Dismiss +``` + +Dismisses a security alert that was raised. + +## PARAMETERS + +### -ActionType +Action Type. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource, ResourceGroupLevelResource, ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Alerts.PSSecurityAlert +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObjectV3 +Input Object V3. + +```yaml +Type: Microsoft.Azure.Commands.SecurityCenter.Models.Alerts.PSSecurityAlertV3 +Parameter Sets: InputObjectV3 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource, ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource, ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the operation was successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Models.Alerts.PSSecurityAlert + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Set-AzSecurityAssessment.md b/azps-10.1.0/Az.Security/Set-AzSecurityAssessment.md new file mode 100644 index 0000000000..cda9e6e6d3 --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzSecurityAssessment.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Set-AzSecurityAssessment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityAssessment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityAssessment.md +--- + +# Set-AzSecurityAssessment + +## SYNOPSIS +Create or update a security assessment result on a resource + +## SYNTAX + +### SubscriptionLevelResource (Default) +``` +Set-AzSecurityAssessment -Name <String> -StatusCode <String> [-StatusCause <String>] + [-StatusDescription <String>] + [-AdditionalData <System.Collections.Generic.Dictionary`2[System.String,System.String]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdLevelResource +``` +Set-AzSecurityAssessment -Name <String> -AssessedResourceId <String> -StatusCode <String> + [-StatusCause <String>] [-StatusDescription <String>] + [-AdditionalData <System.Collections.Generic.Dictionary`2[System.String,System.String]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a security assessment result on a resource, can be used to change the status of an existing result or add additional data. +can only be used for "CustomerManaged" assessment types and only after the matched assessment metadata is created. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSecurityAssessment -Name 4FB6C0A0-1137-42C7-A1C7-4BD37C91DE8D -StatusCode "Unhealthy" +``` + +Marks the subscription result as "Unhealthy" for assessment of type "4FB6C0A0-1137-42C7-A1C7-4BD37C91DE8D" - more details about the assessment type will be found under the assessmentMetadata type + +## PARAMETERS + +### -AdditionalData +Data that is attached to the assessment result for better investigations or status clarity. + +```yaml +Type: System.Collections.Generic.Dictionary`2[System.String,System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssessedResourceId +Full resource ID of the resource that the assessment is calculated on. + +```yaml +Type: System.String +Parameter Sets: ResourceIdLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusCause +Progremmatic code for the cause of the assessment's result. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusCode +Progremmatic code for the result of the assessment. +can be "Healthy", "Unhealthy" or "NotApplicable" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StatusDescription +Human readable description of the cause of the assessment's result. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Assessments.PSSecurityAssessment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Set-AzSecurityAssessmentMetadata.md b/azps-10.1.0/Az.Security/Set-AzSecurityAssessmentMetadata.md new file mode 100644 index 0000000000..1ce733bb69 --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzSecurityAssessmentMetadata.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Set-AzSecurityAssessmentMetadata +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityAssessmentMetadata.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityAssessmentMetadata.md +--- + +# Set-AzSecurityAssessmentMetadata + +## SYNOPSIS +Creates or updates a security assessment type. + +## SYNTAX + +``` +Set-AzSecurityAssessmentMetadata -Name <String> -DisplayName <String> -Description <String> + [-RemediationDescription <String>] -Severity <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a security assessment metadata, can be used to create and manage various assessment properties. +After this action you will be able to report assessment results on any resource in this subscription. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSecurityAssessmentMetadata -Name $assessmentGuid -DisplayName "Resource should be secured" -Severity "High" -Description "The resource should be secured according to my company's security policy" +``` + +Create a new assessment type in a subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Detailed string that will help users to understand the meaning of this assessment and how it was calculated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Human readable title for this object. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemediationDescription +Detailed string that will help users to understand the different ways to mitigate or fix the security issue. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity +Indicates the importance of the security risk if the assessment is unhealthy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AssessmentMetadata.PSSecurityAssessmentMetadata + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Set-AzSecurityAutoProvisioningSetting.md b/azps-10.1.0/Az.Security/Set-AzSecurityAutoProvisioningSetting.md new file mode 100644 index 0000000000..dcbc7a27ad --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzSecurityAutoProvisioningSetting.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Set-AzSecurityAutoProvisioningSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityAutoProvisioningSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityAutoProvisioningSetting.md +--- + +# Set-AzSecurityAutoProvisioningSetting + +## SYNOPSIS +Updates automatic provisioning setting + +## SYNTAX + +### SubscriptionLevelResource (Default) +``` +Set-AzSecurityAutoProvisioningSetting -Name <String> [-EnableAutoProvision] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Set-AzSecurityAutoProvisioningSetting [-EnableAutoProvision] -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Set-AzSecurityAutoProvisioningSetting -InputObject <PSSecurityAutoProvisioningSetting> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Turns on or off automatic provisioning settings for a subscription. +Automatic Provisioning Settings let you decide whether you want Azure Security Center to automatically provision a security agent that will be installed on your VMs. +The security agent will monitor your VM to create security alerts and monitor the security compliance of the VM. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSecurityAutoProvisioningSetting -Name "default" -EnableAutoProvision +``` + +```output +Id Name AutoProvision +-- ---- ------------- +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/autoProvisioningSettings/default default On +``` + +Turns on automatic provisioning setting for a subscription. + +### Example 2 +```powershell +Set-AzSecurityAutoProvisioningSetting -Name "default" +``` + +```output +Id Name +-- ---- +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/autoProvisioningSettings/default de... +``` + +Turns off automatic provisioning setting for a subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoProvision +Automatic Provisioning. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SubscriptionLevelResource, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.AutoProvisioningSettings.PSSecurityAutoProvisioningSetting +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Models.AutoProvisioningSettings.PSSecurityAutoProvisioningSetting + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.AutoProvisioningSettings.PSSecurityAutoProvisioningSetting + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Set-AzSecurityContact.md b/azps-10.1.0/Az.Security/Set-AzSecurityContact.md new file mode 100644 index 0000000000..9795cfff4b --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzSecurityContact.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Set-AzSecurityContact +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityContact.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityContact.md +--- + +# Set-AzSecurityContact + +## SYNOPSIS +Updates a security contact for a subscription. + +## SYNTAX + +``` +Set-AzSecurityContact -Name <String> -Email <String> [-Phone <String>] [-AlertAdmin] [-NotifyOnAlert] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a security contact for a subscription. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSecurityContact -Name "default1" -Email "john@contoso.com" -Phone "214275-4038" -AlertAdmin -NotifyOnAlert +``` + +```output +Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/securityContacts/ + default1 +Name : default1 +Email : john@contoso.com +Phone : 214275-4038 +AlertNotifications : On +AlertsToAdmins : On +``` + +Updates a security contact for a subscription. + +## PARAMETERS + +### -AlertAdmin +Alerts To Administrators. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +E-Mail. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyOnAlert +Alert Notifications. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Phone +Phone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.SecurityContacts.PSSecurityContact + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Set-AzSecurityPricing.md b/azps-10.1.0/Az.Security/Set-AzSecurityPricing.md new file mode 100644 index 0000000000..674baf58b7 --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzSecurityPricing.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Set-AzSecurityPricing +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityPricing.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityPricing.md +--- + +# Set-AzSecurityPricing + +## SYNOPSIS + +Enables or disables Azure Defender plans for a subscription in Azure Security Center. + +## SYNTAX + +### SubscriptionLevelResource (Default) +``` +Set-AzSecurityPricing -Name <String> -PricingTier <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SubscriptionLevelResource (With optional SubPlan) +``` +Set-AzSecurityPricing -Name <String> -PricingTier <String> -SubPlan <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Set-AzSecurityPricing -InputObject <PSSecurityPricing> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +Enable or disable any of the Azure Defender plans for a subscription. + +For details about Azure Defender and the available plans, see [Introduction to Azure Defender](https://learn.microsoft.com/azure/security-center/azure-defender). + +## EXAMPLES + +### Example 1 + +```powershell +Set-AzSecurityPricing -Name "AppServices" -PricingTier "Standard" +``` + +### Example 2 + +```powershell +Set-AzSecurityPricing -Name "VirtualMachines" -PricingTier "Standard" -SubPlan P2 +``` + +Enables **Azure Defender for servers** for the subscription. + +"Standard" refers to the "On" state for an Azure Defender plan as shown in Azure Security Center's pricing and settings area of the Azure portal. + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Pricings.PSSecurityPricing +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name + +Resource name. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PricingTier + +Pricing Tier. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubPlan + +Sub Plan. + +```yaml +Type: System.String +Parameter Sets: SubscriptionLevelResource +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Security.Models.Pricings.PSSecurityPricing + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Pricings.PSSecurityPricing + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Set-AzSecuritySetting.md b/azps-10.1.0/Az.Security/Set-AzSecuritySetting.md new file mode 100644 index 0000000000..10c11ff36c --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzSecuritySetting.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Set-AzSecuritySetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecuritySetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecuritySetting.md +--- + +# Set-AzSecuritySetting + +## SYNOPSIS +Update a security setting in Azure Security Center + +## SYNTAX + +### GeneralScope (Default) +``` +Set-AzSecuritySetting [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SettingsScope +``` +Set-AzSecuritySetting -SettingName <String> -SettingKind <String> -Enabled <Boolean> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Set-AzSecuritySetting -InputObject <PSSecuritySetting> [-Enabled <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzSecuritySetting cmdlet updates a specific security setting in Azure Security Center. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSecuritySetting -SettingName "MCAS" -SettingKind "DataExportSettings" -Enabled $true +``` + +```output +Id: "/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/settings/MCAS" +Name: "MCAS" +Type: "Microsoft.Security/settings" +Enabled: true +``` + +Updates an MCAS data export setting + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Enables the setting. + +```yaml +Type: System.Boolean +Parameter Sets: SettingsScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Boolean +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.Settings.PSSecuritySetting +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SettingKind +Setting kind. (DataExportSettings/AlertSyncSettings) + +```yaml +Type: System.String +Parameter Sets: SettingsScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SettingName +Setting name. (MCAS/WDATP/Sentinel) + +```yaml +Type: System.String +Parameter Sets: SettingsScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### Microsoft.Azure.Commands.Security.Models.Settings.PSSecuritySetting +### Microsoft.Azure.Commands.Security.Models.Settings.PSSecurityDataExportSetting +### Microsoft.Azure.Commands.Security.Models.Settings.PSSecurityAlertSyncSettings + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.Settings.PSSecuritySetting +### Microsoft.Azure.Commands.Security.Models.Settings.PSSecurityDataExportSetting +### Microsoft.Azure.Commands.Security.Models.Settings.PSSecurityAlertSyncSettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Set-AzSecuritySqlVulnerabilityAssessmentBaseline.md b/azps-10.1.0/Az.Security/Set-AzSecuritySqlVulnerabilityAssessmentBaseline.md new file mode 100644 index 0000000000..5bbd3512e6 --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzSecuritySqlVulnerabilityAssessmentBaseline.md @@ -0,0 +1,375 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/set-azsecuritysqlvulnerabilityassessmentbaseline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecuritySqlVulnerabilityAssessmentBaseline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecuritySqlVulnerabilityAssessmentBaseline.md +--- + +# Set-AzSecuritySqlVulnerabilityAssessmentBaseline + +## SYNOPSIS +Sets new SQL vulnerability assessment baseline on a specific database discards old baseline if any exists. + +## SYNTAX + +### ResourceIdWithBaselineObject (Default) +``` +Set-AzSecuritySqlVulnerabilityAssessmentBaseline [-BaselineSet <Hashtable>] [-Force] -ResourceId <String> + -WorkspaceId <String> -Server <String> -Database <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectWithResourceId +``` +Set-AzSecuritySqlVulnerabilityAssessmentBaseline -InputObject <PSSqlVulnerabilityAssessmentBaselineResults> + [-Force] -ResourceId <String> -WorkspaceId <String> -Server <String> -Database <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectBaselineWithOnPrem +``` +Set-AzSecuritySqlVulnerabilityAssessmentBaseline -InputObject <PSSqlVulnerabilityAssessmentBaselineResults> + [-Force] -WorkspaceId <String> -Server <String> -Database <String> -ComputerName <String> -VmUuid <String> + -AgentId <String> -WorkspaceResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### OnPremMachinesWithBaselineObject +``` +Set-AzSecuritySqlVulnerabilityAssessmentBaseline [-BaselineSet <Hashtable>] [-Force] -WorkspaceId <String> + -Server <String> -Database <String> -ComputerName <String> -VmUuid <String> -AgentId <String> + -WorkspaceResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Sets new SQL vulnerability assessment baseline on a specific database, discards old baseline if any exists. + +## EXAMPLES + +### Example 1: Set results as baseline using resource id parameters. +```powershell +Set-AzSecuritySqlVulnerabilityAssessmentBaseline -ResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onPremiseMachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -BaselineSet @{VA2108 = @( , @("dbo", "db_owner1", "SQL_USER"))} +``` + +```output +Setting baseline for +/subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onPremiseMachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/sqlServers/AHABASDEV01SRV/databas +es/master. +Are you sure you want to set baseline? - This will discard your old baseline work. +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y + +Results WorkSpaceId +------- ----------- +{VA2108 => [[dbo, db_owner1, SQL_USER]]} ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 +``` + +Example of using resource id parameters. +Supported resources are: + +- ARC: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HybridCompute/machines/{machineName} +- VM: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{machineName} +- On-Premise: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.operationalinsights/workspaces/{workspaceName}/onPremiseMachines/{machineName} + +For on premise resources, the patameter machineName is composed as follows: +{ComputerName}_{AgentId}_{VmUuid} + +### Example 2: Set results as baseline using on premise parameters. +```powershell +Set-AzSecuritySqlVulnerabilityAssessmentBaseline -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master -BaselineSet @{VA2108 = @( , @("dbo", "db_owner1", "SQL_USER"))} +``` + +```output +Setting baseline for +/subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onPremiseMachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/sqlServers/AHABASDEV01SRV/databas +es/master. +Are you sure you want to set baseline? - This will discard your old baseline work. +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y + +Results WorkSpaceId +------- ----------- +{VA2108 => [[dbo, db_owner1, SQL_USER]]} ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 +``` + +Example of using OnPremMachinesWithBaselineObject parameters. + +### Example 3: Set results as baseline for all checks on database. +```powershell +Set-AzSecuritySqlVulnerabilityAssessmentBaseline -WorkspaceResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace -ComputerName ahabas-dev01.middleeast.corp.microsoft.com -AgentId 49640166-652f-4ee6-b48b-cfb840b8afe2 -VmUuid 4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master +``` + +```output +Setting baseline for +/subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onPremiseMachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332/sqlServers/AHABASDEV01SRV/databas +es/master. +Are you sure you want to set baseline? - This will discard your old baseline work. +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y + +Results WorkSpaceId +------- ----------- +{VA1017 => [], VA1018 => [[True]], VA1020 => [], VA1022 => [[False]]…} ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 +``` + +In this example the BaselineSet is not specified thus setting all latest results as baseline. + +### Example 4: Copy baseline from a database to an on prem database using pipe. +```powershell +Get-AzSecuritySqlVulnerabilityAssessmentBaseline -ResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/ahmadtesting/providers/microsoft.operationalinsights/workspaces/ahabas-workspace/onPremiseMachines/ahabas-dev01.middleeast.corp.microsoft.com_49640166-652f-4ee6-b48b-cfb840b8afe2_4c4c4544-0030-4b10-8039-b8c04f4a3332 -WorkspaceId ba7c9d0e-a6e3-4997-b575-cf7a18a98a49 -Server AHABASDEV01SRV -Database master | Set-AzSecuritySqlVulnerabilityAssessmentBaseline -ResourceId /subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/talmachinegroupeuap/providers/microsoft.operationalinsights/workspaces/talworkspaceeuap2/onPremiseMachines/TAHERSCO-DEV.middleeast.corp.microsoft.com_7adcdd86-adb6-4008-a254-80e0fc425c55_4c4c4544-0058-3310-8032-c4c04f4a4e32 -WorkspaceId 806d6dfa-132f-488d-975b-9bcf2fcd6802 -Server SQLEXPRESS -Database master +``` + +```output +Setting baseline for +/subscriptions/f26d1f13-67d5-4ad6-9012-67ca12d2436f/resourcegroups/talmachinegroupeuap/providers/microsoft.operationalinsights/workspaces/talworkspaceeuap2/onPremiseMachines/TAHERSCO-DEV.middleeast.corp.microsoft.com_7adcdd86-adb6-4008-a254-80e0fc425c55_4c4c4544-0058-3310-8032-c4c04f4a4e32/sqlServers/SQLEXPRESS/dat +abases/master. +Are you sure you want to set baseline? - This will discard your old baseline work. +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y + +Results WorkSpaceId +------- ----------- +{VA2108 => [[dbo, db_owner1, SQL_USER]]} 806d6dfa-132f-488d-975b-9bcf2fcd6802 +``` + +>[!NOTE] +>In this example, we move all baseline objects from one database to another using InputObjectWithResourceId parameter set. It's important that all the rules in source database exist in the destination database otherwise the operation will fail. + +## PARAMETERS + +### -AgentId +Agent ID - on premise parameter + +```yaml +Type: System.String +Parameter Sets: InputObjectBaselineWithOnPrem, OnPremMachinesWithBaselineObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BaselineSet +Vulnerability assessment baseline object + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ResourceIdWithBaselineObject, OnPremMachinesWithBaselineObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Computer full name - on premise parameter + +```yaml +Type: System.String +Parameter Sets: InputObjectBaselineWithOnPrem, OnPremMachinesWithBaselineObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Database +Database name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force set baseline without confirmation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.SecurityCenter.Models.SqlVulnerabilityAssessment.PSSqlVulnerabilityAssessmentBaselineResults +Parameter Sets: InputObjectWithResourceId, InputObjectBaselineWithOnPrem +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. +Supported resources are: + +- ARC: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HybridCompute/machines/{machineName} +- VM: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{machineName} +- On-Premise: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.operationalinsights/workspaces/{workspaceName}/onPremiseMachines/{machineName} + + +```yaml +Type: System.String +Parameter Sets: ResourceIdWithBaselineObject, InputObjectWithResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +Server name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmUuid +Virtual machine universal unique identifier - on premise parameter + +```yaml +Type: System.String +Parameter Sets: InputObjectBaselineWithOnPrem, OnPremMachinesWithBaselineObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceId +Workspace ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +Workspace resource ID - on premise parameter + +```yaml +Type: System.String +Parameter Sets: InputObjectBaselineWithOnPrem, OnPremMachinesWithBaselineObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.SecurityCenter.Models.SqlVulnerabilityAssessment.PSSqlVulnerabilityAssessmentBaselineResults + +## OUTPUTS + +### Microsoft.Azure.Commands.SecurityCenter.Models.SqlVulnerabilityAssessment.PSSqlVulnerabilityAssessmentBaselineResults + +## NOTES + +## RELATED LINKS + +[Add-AzSecuritySqlVulnerabilityAssessmentBaseline](https://learn.microsoft.com/powershell/module/az.security/add-azsecuritysqlvulnerabilityassessmentbaseline) + +[Remove-AzSecuritySqlVulnerabilityAssessmentBaseline](https://learn.microsoft.com/powershell/module/az.security/remove-azsecuritysqlvulnerabilityassessmentbaseline) + +[Get-AzSecuritySqlVulnerabilityAssessmentBaseline](https://learn.microsoft.com/powershell/module/az.security/get-azsecuritysqlvulnerabilityassessmentbaseline) diff --git a/azps-10.1.0/Az.Security/Set-AzSecurityWorkspaceSetting.md b/azps-10.1.0/Az.Security/Set-AzSecurityWorkspaceSetting.md new file mode 100644 index 0000000000..ee87c9b8e0 --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzSecurityWorkspaceSetting.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Set-AzSecurityWorkspaceSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityWorkspaceSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSecurityWorkspaceSetting.md +--- + +# Set-AzSecurityWorkspaceSetting + +## SYNOPSIS +Updates the workspace settings for the subscription. + +## SYNTAX + +``` +Set-AzSecurityWorkspaceSetting -Name <String> -Scope <String> -WorkspaceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the workspace settings for the subscription. +The configured workspace will hold the security data that was collected by the Azure Log Analytics agent agent that is installed in VMs inside this subscription. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSecurityWorkspaceSetting -Name "default" -Scope "/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869" -WorkspaceId "/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/mainws/providers/microsoft.operationalinsights/workspaces/securityuserws" +``` + +```output +Id Name WorkspaceId +-- ---- ---- +/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/workspaceSettings/default default /... +``` + +Sets the "securityuserws" workspace to hold all the security data that was collected by the Azure Log Analytics agent. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Scope. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceId +Workspace ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.WorkspaceSettings.PSSecurityWorkspaceSetting + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Set-AzSqlInformationProtectionPolicy.md b/azps-10.1.0/Az.Security/Set-AzSqlInformationProtectionPolicy.md new file mode 100644 index 0000000000..60634eb924 --- /dev/null +++ b/azps-10.1.0/Az.Security/Set-AzSqlInformationProtectionPolicy.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Set-AzSqlInformationProtectionPolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSqlInformationProtectionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Set-AzSqlInformationProtectionPolicy.md +--- + +# Set-AzSqlInformationProtectionPolicy + +## SYNOPSIS +Sets the effective tenant SQL information protection policy. + +## SYNTAX + +### SQL Information Protection Policy (Default) +``` +Set-AzSqlInformationProtectionPolicy -Policy <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SQL Information Protection Policy File Path +``` +Set-AzSqlInformationProtectionPolicy -FilePath <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Sets the effective tenant SQL information protection policy. + +## EXAMPLES + +### Example +```powershell +Set-AzSqlInformationProtectionPolicy -FilePath "C:\Users\myUser\Desktop\policy.json" +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +Specifies a path of a .json file containing SQL Information Protection Policy definition. + +```yaml +Type: System.String +Parameter Sets: SQL Information Protection Policy File Path +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Policy +Specifies a SQL information protection policy definition. You can specify a path of a .json file or a JSON format string that defines the policy. + +```yaml +Type: System.String +Parameter Sets: SQL Information Protection Policy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.SecurityCenter.Models.SqlInformationProtectionPolicy.PSSqlInformationProtectionPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Start-AzJitNetworkAccessPolicy.md b/azps-10.1.0/Az.Security/Start-AzJitNetworkAccessPolicy.md new file mode 100644 index 0000000000..8d8ed03699 --- /dev/null +++ b/azps-10.1.0/Az.Security/Start-AzJitNetworkAccessPolicy.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Start-AzJitNetworkAccessPolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Start-AzJitNetworkAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Start-AzJitNetworkAccessPolicy.md +--- + +# Start-AzJitNetworkAccessPolicy + +## SYNOPSIS +Invokes a temporary network access request. + +## SYNTAX + +### ResourceGroupLevelResource (Default) +``` +Start-AzJitNetworkAccessPolicy -ResourceGroupName <String> -Location <String> -Name <String> + -VirtualMachine <PSSecurityJitNetworkAccessPolicyInitiateVirtualMachine[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Start-AzJitNetworkAccessPolicy -VirtualMachine <PSSecurityJitNetworkAccessPolicyInitiateVirtualMachine[]> + -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Start-AzJitNetworkAccessPolicy -InputObject <PSSecurityJitNetworkAccessPolicyInitiateInputObject> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Invokes a temporary network access request. +The request is validated against the configured JIT network access policy and if permitted, opens up a network connection according to the user's request. +The request will be logged in the policy for later review and will be terminated when the specified duration will be exceeded. + +## EXAMPLES + +### Example 1 +```powershell +$MyResource = Get-AzResource -Id /subscriptions/xxxxxxx-xxxxx-xxxxx-xxxxxxx/resourceGroups/PolicyDemo/providers/Microsoft.Compute/virtualMachines/PolicyDemoVM1 +$JitPolicy = (@{ + id = $MyResource.ResourceId; + ports = (@{ + number = 22 + endTimeUtc = Get-Date (Get-Date -AsUTC).AddHours(1) -Format O + allowedSourceAddressPrefix = @($MyPublicIP) + }) + }) +$ActivationVM = @($JitPolicy) +Start-AzJitNetworkAccessPolicy -ResourceGroupName $($MyResource.ResourceGroupName) -Location $MyResource.Location -Name "default" -VirtualMachine $ActivationVM +``` + +Opens up a network connection for 1 hour over port 22 from my public IP (not shown). + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Cmdlets.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyInitiateInputObject +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Location. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualMachine +Automatic Provisioning. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyInitiateVirtualMachine[] +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Cmdlets.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyInitiateInputObject + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Security/Update-AzIotSecuritySolution.md b/azps-10.1.0/Az.Security/Update-AzIotSecuritySolution.md new file mode 100644 index 0000000000..5d4350af90 --- /dev/null +++ b/azps-10.1.0/Az.Security/Update-AzIotSecuritySolution.md @@ -0,0 +1,304 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Security.dll-Help.xml +Module Name: Az.Security +online version: https://learn.microsoft.com/powershell/module/az.security/Update-AzIotSecuritySolution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Update-AzIotSecuritySolution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Security/Security/help/Update-AzIotSecuritySolution.md +--- + +# Update-AzIotSecuritySolution + +## SYNOPSIS +Update one or more of the following properties in IoT security solution: tags, recommendation configuration, user defined resources + +## SYNTAX + +### ResourceGroupLevelResource (Default) +``` +Update-AzIotSecuritySolution -Name <String> -ResourceGroupName <String> [-Tag <Hashtable>] + [-UserDefinedResource <PSUserDefinedResources>] + [-RecommendationsConfiguration <PSRecommendationConfiguration[]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceId +``` +Update-AzIotSecuritySolution -ResourceId <String> [-Tag <Hashtable>] + [-UserDefinedResource <PSUserDefinedResources>] + [-RecommendationsConfiguration <PSRecommendationConfiguration[]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObject +``` +Update-AzIotSecuritySolution -InputObject <PSIotSecuritySolution> [-Tag <Hashtable>] + [-UserDefinedResource <PSUserDefinedResources>] + [-RecommendationsConfiguration <PSRecommendationConfiguration[]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Update-AzIotSecuritySolution cmdlet updayes one or more of the following properties in a specific IoT security solution: tags, recommendation configuration, user defined resources. +Only the specified properties will be updated inside the iot security solution. +The IoT security solution collects security data and events from iot devices and iot hub to help prevent and detect threats. + +## EXAMPLES + +### Example 1 +```powershell +$RecConfig = New-AzIotSecuritySolutionRecommendationConfigurationObject -RecommendationType "IoT_OpenPorts" -Enabled $false +$UserDefinedResource = New-AzIotSecuritySolutionUserDefinedResourcesObject -Query 'where type != "microsoft.devices/iothubs" | where name contains "v2"' ` +-QuerySubscriptionList @("XXXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXXXXX") +Update-AzIotSecuritySolution -Name "MySample" -ResourceGroupName "MyResourceGroup" -RecommendationsConfiguration @($RecConfig) -UserDefinedResource $UserDefinedResource +``` + +```output +Id: "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroup/providers/Microsoft.Security/IoTSecuritySolutions/MySample" +Name: "MySample" +Type: "Microsoft.Security/IoTSecuritySolutions" +Location: "westus" +DisplayName: "MySample" +status: "Enabled" +Export: ["RawEvents"] +DisabledDataSources: ["TwinData"] +Workspace: "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourcegroups/MyResourceGroup/providers/microsoft.operationalinsights/workspaces/MyLA" +AdditionalWorkspaces: null +IotHubs: ["/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourcegroups/MyResourceGroup/providers/microsoft.devices/iothubs/MySample"] +UserDefinedResources: { + Query: 'where type != "microsoft.devices/iothubs" | where name contains "v2"' + QuerySubscriptions: ["XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"] +} +RecommendationsConfiguration: [ +{ + RecommendationType: "IoT_ACRAuthentication" + Name: "Service prinicpal not used with ACR repository" + Status: "Enabled" +} +{ + RecommendationType: "IoT_OpenPorts" + Name: "Device has open port" + Status: "Disabled" +} +{ + RecommendationType: "IoT_AgentSendsUnutilizedMessages" + Name: "Agent sending underutilized messages" + Status: "Enabled" +}] +AutoDiscoveredResources: ["/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourcegroups/MyResourceGroup/providers/microsoft.devices/iothubs/MySample"] +UnmaskedIpLoggingStatus: "Enabled" +``` + +Update iot security solution "MySample" from resource group "MyResourceGroup" with recommendation configuration and user defined resources + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input Object. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSIotSecuritySolution +Parameter Sets: InputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecommendationsConfiguration +Recommendations configuration. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSRecommendationConfiguration[] +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSRecommendationConfiguration[] +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupLevelResource +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ID of the security resource that you want to invoke the command on. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserDefinedResource +User defined resources. + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSUserDefinedResources +Parameter Sets: ResourceGroupLevelResource, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSUserDefinedResources +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSIotSecuritySolution + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSUserDefinedResources + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSRecommendationConfiguration[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Security.Models.IotSecuritySolutions.PSIotSecuritySolution + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SecurityInsights/Az.SecurityInsights.md b/azps-10.1.0/Az.SecurityInsights/Az.SecurityInsights.md new file mode 100644 index 0000000000..676b191473 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Az.SecurityInsights.md @@ -0,0 +1,201 @@ +--- +Module Name: Az.SecurityInsights +Module Guid: 453d4fb9-65ec-4cf1-8358-6a0fbd995d19 +Download Help Link: https://learn.microsoft.com/powershell/module/az.securityinsights +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Az.SecurityInsights.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Az.SecurityInsights.md +--- + +# Az.SecurityInsights Module +## Description +Microsoft Azure PowerShell: SecurityInsights cmdlets + +## Az.SecurityInsights Cmdlets +### [Get-AzSentinelAlertRule](Get-AzSentinelAlertRule.md) +Gets the alert rule. + +### [Get-AzSentinelAlertRuleAction](Get-AzSentinelAlertRuleAction.md) +Gets the action of alert rule. + +### [Get-AzSentinelAlertRuleTemplate](Get-AzSentinelAlertRuleTemplate.md) +Gets the alert rule template. + +### [Get-AzSentinelAutomationRule](Get-AzSentinelAutomationRule.md) +Gets the automation rule. + +### [Get-AzSentinelBookmark](Get-AzSentinelBookmark.md) +Gets a bookmark. + +### [Get-AzSentinelBookmarkRelation](Get-AzSentinelBookmarkRelation.md) +Gets a bookmark relation. + +### [Get-AzSentinelDataConnector](Get-AzSentinelDataConnector.md) +Gets a data connector. + +### [Get-AzSentinelEnrichment](Get-AzSentinelEnrichment.md) +Get geodata for a single IP address + +### [Get-AzSentinelEntity](Get-AzSentinelEntity.md) +Gets an entity. + +### [Get-AzSentinelEntityActivity](Get-AzSentinelEntityActivity.md) +Get Insights and Activities for an entity. + +### [Get-AzSentinelEntityInsight](Get-AzSentinelEntityInsight.md) +Execute Insights for an entity. + +### [Get-AzSentinelEntityQuery](Get-AzSentinelEntityQuery.md) +Gets an entity query. + +### [Get-AzSentinelEntityQueryTemplate](Get-AzSentinelEntityQueryTemplate.md) +Gets an entity query. + +### [Get-AzSentinelEntityRelation](Get-AzSentinelEntityRelation.md) +Gets an entity relation. + +### [Get-AzSentinelEntityTimeline](Get-AzSentinelEntityTimeline.md) +Timeline for an entity. + +### [Get-AzSentinelIncident](Get-AzSentinelIncident.md) +Gets an incident. + +### [Get-AzSentinelIncidentAlert](Get-AzSentinelIncidentAlert.md) +Gets all incident alerts. + +### [Get-AzSentinelIncidentBookmark](Get-AzSentinelIncidentBookmark.md) +Gets all incident bookmarks. + +### [Get-AzSentinelIncidentComment](Get-AzSentinelIncidentComment.md) +Gets an incident comment. + +### [Get-AzSentinelIncidentEntity](Get-AzSentinelIncidentEntity.md) +Gets all incident related entities. + +### [Get-AzSentinelIncidentRelation](Get-AzSentinelIncidentRelation.md) +Gets an incident relation. + +### [Get-AzSentinelMetadata](Get-AzSentinelMetadata.md) +Get a Metadata. + +### [Get-AzSentinelOnboardingState](Get-AzSentinelOnboardingState.md) +Get Sentinel onboarding state + +### [Get-AzSentinelSetting](Get-AzSentinelSetting.md) +Gets a setting. + +### [Get-AzSentinelThreatIntelligenceIndicator](Get-AzSentinelThreatIntelligenceIndicator.md) +View a threat intelligence indicator by name. + +### [Get-AzSentinelThreatIntelligenceIndicatorMetric](Get-AzSentinelThreatIntelligenceIndicatorMetric.md) +Get threat intelligence indicators metrics (Indicators counts by Type, Threat Type, Source). + +### [Invoke-AzSentinelThreatIntelligenceIndicatorQuery](Invoke-AzSentinelThreatIntelligenceIndicatorQuery.md) +Query threat intelligence indicators as per filtering criteria. + +### [New-AzSentinelAlertRule](New-AzSentinelAlertRule.md) +Creates the alert rule. + +### [New-AzSentinelAlertRuleAction](New-AzSentinelAlertRuleAction.md) +Creates or updates the action of alert rule. + +### [New-AzSentinelAutomationRule](New-AzSentinelAutomationRule.md) +Creates or updates the automation rule. + +### [New-AzSentinelBookmark](New-AzSentinelBookmark.md) +Creates or updates the bookmark. + +### [New-AzSentinelBookmarkRelation](New-AzSentinelBookmarkRelation.md) +Creates the bookmark relation. + +### [New-AzSentinelDataConnector](New-AzSentinelDataConnector.md) +Creates or updates the data connector. + +### [New-AzSentinelEntityQuery](New-AzSentinelEntityQuery.md) +Creates or updates the entity query. + +### [New-AzSentinelIncident](New-AzSentinelIncident.md) +Creates or updates the incident. + +### [New-AzSentinelIncidentComment](New-AzSentinelIncidentComment.md) +Creates or updates the incident comment. + +### [New-AzSentinelIncidentRelation](New-AzSentinelIncidentRelation.md) +Creates or updates the incident relation. + +### [New-AzSentinelIncidentTeam](New-AzSentinelIncidentTeam.md) +Creates a Microsoft team to investigate the incident by sharing information and insights between participants. + +### [New-AzSentinelOnboardingState](New-AzSentinelOnboardingState.md) +Create Sentinel onboarding state + +### [Remove-AzSentinelAlertRule](Remove-AzSentinelAlertRule.md) +Delete the alert rule. + +### [Remove-AzSentinelAlertRuleAction](Remove-AzSentinelAlertRuleAction.md) +Delete the action of alert rule. + +### [Remove-AzSentinelAutomationRule](Remove-AzSentinelAutomationRule.md) +Delete the automation rule. + +### [Remove-AzSentinelBookmark](Remove-AzSentinelBookmark.md) +Delete the bookmark. + +### [Remove-AzSentinelBookmarkRelation](Remove-AzSentinelBookmarkRelation.md) +Delete the bookmark relation. + +### [Remove-AzSentinelDataConnector](Remove-AzSentinelDataConnector.md) +Delete the data connector. + +### [Remove-AzSentinelEntityQuery](Remove-AzSentinelEntityQuery.md) +Delete the entity query. + +### [Remove-AzSentinelIncident](Remove-AzSentinelIncident.md) +Delete the incident. + +### [Remove-AzSentinelIncidentComment](Remove-AzSentinelIncidentComment.md) +Delete the incident comment. + +### [Remove-AzSentinelIncidentRelation](Remove-AzSentinelIncidentRelation.md) +Delete the incident relation. + +### [Remove-AzSentinelOnboardingState](Remove-AzSentinelOnboardingState.md) +Delete Sentinel onboarding state + +### [Test-AzSentinelDataConnectorCheckRequirement](Test-AzSentinelDataConnectorCheckRequirement.md) +Get requirements state for a data connector type. + +### [Update-AzSentinelAlertRule](Update-AzSentinelAlertRule.md) +Updates the alert rule. + +### [Update-AzSentinelAlertRuleAction](Update-AzSentinelAlertRuleAction.md) +Creates or updates the action of alert rule. + +### [Update-AzSentinelAutomationRule](Update-AzSentinelAutomationRule.md) +Creates or updates the automation rule. + +### [Update-AzSentinelBookmark](Update-AzSentinelBookmark.md) +Creates or updates the bookmark. + +### [Update-AzSentinelBookmarkRelation](Update-AzSentinelBookmarkRelation.md) +Creates the bookmark relation. + +### [Update-AzSentinelDataConnector](Update-AzSentinelDataConnector.md) +Updates the data connector. + +### [Update-AzSentinelEntityQuery](Update-AzSentinelEntityQuery.md) +Updates the entity query. + +### [Update-AzSentinelIncident](Update-AzSentinelIncident.md) +Creates or updates the incident. + +### [Update-AzSentinelIncidentComment](Update-AzSentinelIncidentComment.md) +Creates or updates the incident comment. + +### [Update-AzSentinelIncidentRelation](Update-AzSentinelIncidentRelation.md) +Creates or updates the incident relation. + +### [Update-AzSentinelSetting](Update-AzSentinelSetting.md) +Updates setting. + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelAlertRule.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelAlertRule.md new file mode 100644 index 0000000000..03165519bb --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelAlertRule.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelalertrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelAlertRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelAlertRule.md +--- + +# Get-AzSentinelAlertRule + +## SYNOPSIS +Gets the alert rule. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelAlertRule -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelAlertRule -ResourceGroupName <String> -RuleId <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelAlertRule -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the alert rule. + +## EXAMPLES + +### Example 1: List all Alert Rules +```powershell + Get-AzSentinelAlertRule -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +AlertDisplayName : (Preview) TI map IP entity to SigninLogs +FriendlyName : (Preview) TI map IP entity to SigninLogs +Description : Identifies a match in SigninLogs from any IP IOC from TI +Kind : SecurityAlert +Name : d1e4d1dd-8d16-1aed-59bd-a256266d7244 +ProductName : Azure Sentinel +Status : New +ProviderAlertId : d6c7a42b-c0da-41ef-9629-b3d2d407b181 +Tactic : {Impact} +``` + +This command lists all Alert Rules under a Microsoft Sentinel workspace. + +### Example 2: Get an Alert Rule +```powershell + Get-AzSentinelAlertRule -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -RuleId "d6c7a42b-c0da-41ef-9629-b3d2d407b181" +``` + +```output +AlertDisplayName : (Preview) TI map IP entity to SigninLogs +FriendlyName : (Preview) TI map IP entity to SigninLogs +Description : Identifies a match in SigninLogs from any IP IOC from TI +Kind : SecurityAlert +Name : d1e4d1dd-8d16-1aed-59bd-a256266d7244 +ProductName : Azure Sentinel +Status : New +ProviderAlertId : d6c7a42b-c0da-41ef-9629-b3d2d407b181 +Tactic : {Impact} +``` + +This command gets an Alert Rule. + +### Example 3: Get an Alert Rule by object Id +```powershell + $rules = Get-AzSentinelAlertRule -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" + $rules[0] | Get-AzSentinelAlertRule +``` + +```output +AlertDisplayName : (Preview) TI map IP entity to SigninLogs +FriendlyName : (Preview) TI map IP entity to SigninLogs +Description : Identifies a match in SigninLogs from any IP IOC from TI +Kind : SecurityAlert +Name : d1e4d1dd-8d16-1aed-59bd-a256266d7244 +ProductName : Azure Sentinel +Status : New +ProviderAlertId : d6c7a42b-c0da-41ef-9629-b3d2d407b181 +Tactic : {Impact} +``` + +This command gets an Alert Rule by object + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Alert rule ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IAlertRule + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelAlertRuleAction.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelAlertRuleAction.md new file mode 100644 index 0000000000..db304b895c --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelAlertRuleAction.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelalertruleaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelAlertRuleAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelAlertRuleAction.md +--- + +# Get-AzSentinelAlertRuleAction + +## SYNOPSIS +Gets the action of alert rule. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelAlertRuleAction -ResourceGroupName <String> -RuleId <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelAlertRuleAction -Id <String> -ResourceGroupName <String> -RuleId <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelAlertRuleAction -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the action of alert rule. + +## EXAMPLES + +### Example 1: List all Actions for a given Alert Rule +```powershell + Get-AzSentinelAlertRuleAction -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -RuleId "myRuleId" +``` + +```output +LogicAppResourceId : /subscriptions/174b1a81-c53c-4092-8d4a-7210f6a44a0c/resourceGroups/myResourceGroup/providers/Microsoft.Logic/workflows/A-Demo-1 +Name : f32239c5-cb9c-48da-a3f6-bd5bd3d924a4 +WorkflowId : 3c73d72560fa4cb6a72a0f10d3a80940 + +LogicAppResourceId : /subscriptions/274b1a41-c53c-4092-8d4a-7210f6a44a0c/resourceGroups/myResourceGroup/providers/Microsoft.Logic/workflows/EmptyPlaybook +Name : cf815c77-bc65-4c02-946f-d81e15e9a100 +WorkflowId : 1ac8ccb8bd134253b4baf0c75fe3ecc6 +``` + +This command lists all Actions for a given Alert Rule. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Action ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ActionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Alert rule ID + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IActionResponse + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelAlertRuleTemplate.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelAlertRuleTemplate.md new file mode 100644 index 0000000000..e97917276a --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelAlertRuleTemplate.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelalertruletemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelAlertRuleTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelAlertRuleTemplate.md +--- + +# Get-AzSentinelAlertRuleTemplate + +## SYNOPSIS +Gets the alert rule template. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelAlertRuleTemplate -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelAlertRuleTemplate -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelAlertRuleTemplate -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the alert rule template. + +## EXAMPLES + +### Example 1: List all Alert Rule Templates +```powershell + Get-AzSentinelAlertRuleTemplate -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +DisplayName : TI map IP entity to GitHub_CL +Description : Identifies a match in GitHub_CL table from any IP IOC from TI +CreatedDateUtc : 8/27/2019 12:00:00 AM +LastUpdatedDateUtc : 10/19/2021 12:00:00 AM +Kind : Scheduled +Severity : Medium +Name : aac495a9-feb1-446d-b08e-a1164a539452 + +DisplayName : Accessed files shared by temporary external user +Description : This detection identifies an external user is added to a Team or Teams chat + and shares a files which is accessed by many users (>10) and the users is removed within short period of time. This might be + an indicator of suspicious activity. +CreatedDateUtc : 8/18/2020 12:00:00 AM +LastUpdatedDateUtc : 1/3/2022 12:00:00 AM +Kind : Scheduled +Severity : Low +Name : bff058b2-500e-4ae5-bb49-a5b1423cbd5b +``` + +This command lists all Alert Rule Templates under a Microsoft Sentinel workspace. + +### Example 2: Get an Alert Rule Template +```powershell + Get-AzSentinelAlertRuleTemplate -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "myRuaac495a9-feb1-446d-b08e-a1164a539452leTemplateId" +``` + +```output +DisplayName : TI map IP entity to GitHub_CL +Description : Identifies a match in GitHub_CL table from any IP IOC from TI +CreatedDateUtc : 8/27/2019 12:00:00 AM +LastUpdatedDateUtc : 10/19/2021 12:00:00 AM +Kind : Scheduled +Severity : Medium +Name : aac495a9-feb1-446d-b08e-a1164a539452 +``` + +This command gets an Alert Rule Template. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Alert rule template ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AlertRuleTemplateId, TemplateId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IAlertRuleTemplate + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelAutomationRule.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelAutomationRule.md new file mode 100644 index 0000000000..d66a971e06 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelAutomationRule.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelautomationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelAutomationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelAutomationRule.md +--- + +# Get-AzSentinelAutomationRule + +## SYNOPSIS +Gets the automation rule. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelAutomationRule -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelAutomationRule -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelAutomationRule -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the automation rule. + +## EXAMPLES + +### Example 1: List all Automation Rules +```powershell + Get-AzSentinelAutomationRule -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +DisplayName : VIP automation rule +CreatedByEmail : luke@contoso.com +CreatedByUserPrincipalName : luke@contoso.com +TriggeringLogicIsEnabled : True +TriggeringLogicTriggersOn : Incidents +TriggeringLogicTriggersWhen : Created +Name : 2f32af32-ad13-4fbb-9fbc-e19e0e7ff767 + +``` + +This command lists all Automation Rules under a Microsoft Sentinel workspace. + +### Example 2: Get an Automation Rule +```powershell + Get-AzSentinelAutomationRule -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "2f32af32-ad13-4fbb-9fbc-e19e0e7ff767" +``` + +```output +DisplayName : VIP automation rule +CreatedByEmail : luke@contoso.com +CreatedByUserPrincipalName : luke@contoso.com +TriggeringLogicIsEnabled : True +TriggeringLogicTriggersOn : Incidents +TriggeringLogicTriggersWhen : Created +Name : 2f32af32-ad13-4fbb-9fbc-e19e0e7ff767 +``` + +This command gets an Automation Rule. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Automation rule ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AutomationRuleId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IAutomationRule + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelBookmark.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelBookmark.md new file mode 100644 index 0000000000..817e3ab0cc --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelBookmark.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelbookmark +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelBookmark.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelBookmark.md +--- + +# Get-AzSentinelBookmark + +## SYNOPSIS +Gets a bookmark. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelBookmark -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelBookmark -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelBookmark -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a bookmark. + +## EXAMPLES + +### Example 1: List all Bookmarks +```powershell + Get-AzSentinelBookmark -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +DisplayName : SecurityAlert - 28b401e1e0c9 +CreatedByEmail : john@contoso.com +CreatedByName : John Contoso +Label : {} +Note : This needs further investigation +Name : 515fc035-2ed8-4fa1-ad7d-28b401e1e0c9 + +``` + +This command lists all Bookmarks under a Microsoft Sentinel workspace. + +### Example 2: Get a Bookmark +```powershell + Get-AzSentinelBookmark -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "515fc035-2ed8-4fa1-ad7d-28b401e1e0c9" +``` + +```output +DisplayName : SecurityAlert - 28b401e1e0c9 +CreatedByEmail : john@contoso.com +CreatedByName : John Contoso +Label : {} +Note : This needs further investigation +Name : 515fc035-2ed8-4fa1-ad7d-28b401e1e0c9 +``` + +This command gets a Bookmark. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Bookmark ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: BookmarkId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IBookmark + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelBookmarkRelation.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelBookmarkRelation.md new file mode 100644 index 0000000000..3bc988acc2 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelBookmarkRelation.md @@ -0,0 +1,301 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelbookmarkrelation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelBookmarkRelation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelBookmarkRelation.md +--- + +# Get-AzSentinelBookmarkRelation + +## SYNOPSIS +Gets a bookmark relation. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelBookmarkRelation -BookmarkId <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-Filter <String>] [-Orderby <String>] [-SkipToken <String>] [-Top <Int32>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelBookmarkRelation -BookmarkId <String> -RelationName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelBookmarkRelation -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a bookmark relation. + +## EXAMPLES + +### Example 1: List all Bookmark Relations for a given Bookmark +```powershell + Get-AzSentinelBookmarkRelation -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -BookmarkId "myBookmarkId" +``` + +```output +Name : 83846045-d8dc-4d6b-abbe-7588219c474e +RelatedResourceName : 7cc984fe-61a2-43c2-a1a4-3583c8a89da2 +RelatedResourceType : Microsoft.SecurityInsights/Incidents +``` + +This command lists all Bookmark Relations for a given Bookmark. + +### Example 2: Get a Bookmark Relation +```powershell + Get-AzSentinelBookmarkRelation -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -BookmarkId "myBookmarkId" +``` + +```output +Name : 83846045-d8dc-4d6b-abbe-7588219c474e +RelatedResourceName : 7cc984fe-61a2-43c2-a1a4-3583c8a89da2 +RelatedResourceType : Microsoft.SecurityInsights/Incidents +``` + +This command gets a Bookmark Relation. + +### Example 3: Get a Bookmark Relation by object Id +```powershell + $Bookmarkrelations = Get-AzSentinelBookmarkRelation -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -BookmarkId "myBookmarkId" + $Bookmarkrelations[0] | Get-AzSentinelBookmarkRelation +``` + +```output +Name : 83846045-d8dc-4d6b-abbe-7588219c474e +RelatedResourceName : 7cc984fe-61a2-43c2-a1a4-3583c8a89da2 +RelatedResourceType : Microsoft.SecurityInsights/Incidents +``` + +This command gets a Bookmark by object + +## PARAMETERS + +### -BookmarkId +Bookmark ID + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filters the results, based on a Boolean condition. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Orderby +Sorts the results. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RelationName +Relation Name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +Skiptoken is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Returns only the first n results. +Optional. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IRelation + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelDataConnector.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelDataConnector.md new file mode 100644 index 0000000000..e90fb60e84 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelDataConnector.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentineldataconnector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelDataConnector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelDataConnector.md +--- + +# Get-AzSentinelDataConnector + +## SYNOPSIS +Gets a data connector. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a data connector. + +## EXAMPLES + +### Example 1: List all Data Connectors +```powershell + Get-AzSentinelDataConnector -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +Kind : AzureActiveDirectory +Name : 8207e1f9-a793-4869-afb1-5ad4540d66d1 + +Kind : AzureAdvancedThreatProtection +Name : 1d75aada-a558-4461-986b-c6822182e81d + +Kind : Office365 +Name : 6323c716-83ae-4cfd-bf93-58235c8beb23 + +``` + +This command lists all DataConnectors under a Microsoft Sentinel workspace. + +### Example 2: Get a specific Data Connector +```powershell + Get-AzSentinelDataConnector -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" | Where-Object {$_.kind -eq "Office365"} +``` + +```output +Kind : Office365 +Name : 6323c716-83ae-4cfd-bf93-58235c8beb23 +SharePointState : enabled +``` + +This command gets a specific DataConnector based on kind + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Connector ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DataConnectorId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IDataConnector + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEnrichment.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEnrichment.md new file mode 100644 index 0000000000..faf2c0a8b6 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEnrichment.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelenrichment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEnrichment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEnrichment.md +--- + +# Get-AzSentinelEnrichment + +## SYNOPSIS +Get geodata for a single IP address + +## SYNTAX + +### Get (Default) +``` +Get-AzSentinelEnrichment -ResourceGroupName <String> -IPAddress <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get1 +``` +Get-AzSentinelEnrichment -ResourceGroupName <String> -Domain <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelEnrichment -InputObject <ISecurityInsightsIdentity> -IPAddress <String> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity1 +``` +Get-AzSentinelEnrichment -InputObject <ISecurityInsightsIdentity> -Domain <String> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get geodata for a single IP address + +## EXAMPLES + +### Example 1: Get a Domain Enrichment +```powershell + Get-AzSentinelEnrichment -ResourceGroupName "myResourceGroupName" -Domain "microsoft.com" +``` + +```output +Created : 5/2/1991 12:00:00 AM +Domain : microsoft.com +Expire : 5/3/2022 12:00:00 AM +Server : whois.markmonitor.com +Updated : 3/12/2021 12:00:00 AM +``` + +This command gets an enrichment for a domain. + +### Example 2: Get a IP Enrichment +```powershell + Get-AzSentinelEnrichment -ResourceGroupName "myResourceGroupName" -IPAddress "1.1.1.1" +``` + +```output +Asn : 13335 +Carrier : cloudflare +City : ringwood +CityCf : 90 +Continent : oceania +Country : australia +CountryCf : 99 +IPAddr : 1.1.1.1 +IPRoutingType : fixed +Latitude : -37.8143 +Longitude : 145.2274 +Organization : apnic and cloudflare dns resolver project +OrganizationType : Internet Hosting Services +Region : +State : victoria +StateCf : 95 +StateCode : + +``` + +This command an enrichment for an IP Address. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +Domain name to be enriched + +```yaml +Type: System.String +Parameter Sets: Get1, GetViaIdentity1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity, GetViaIdentity1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IPAddress +IP address (v4 or v6) to be enriched + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, Get1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, Get1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IEnrichmentDomainWhois + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IEnrichmentIPGeodata + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntity.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntity.md new file mode 100644 index 0000000000..246fa8f178 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntity.md @@ -0,0 +1,237 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelentity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntity.md +--- + +# Get-AzSentinelEntity + +## SYNOPSIS +Gets an entity. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelEntity -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelEntity -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelEntity -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an entity. + +## EXAMPLES + +### Example 1: List all Entities +```powershell + Get-AzSentinelEntity -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +FriendlyName : WIN2019 +Kind : Host +Name : 8d036a2d-f37d-e936-6cca-4e172687cb79 + +FriendlyName : 186.120.101.12 +Kind : Ip +Name : bb590b07-5ef5-bf85-1c3e-2a04e1e137d2 +``` + +This command lists all Entities under a Microsoft Sentinel workspace. + +### Example 2: Get an Entity +```powershell + Get-AzSentinelEntity -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "8d036a2d-f37d-e936-6cca-4e172687cb79" +``` + +```output +FriendlyName : WIN2019 +Kind : Host +Name : 8d036a2d-f37d-e936-6cca-4e172687cb79 +``` + +This command gets an Entity. + +### Example 3: Get a Entity by object Id +```powershell + $Entitys = Get-AzSentinelEntity -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" + $Entitys[0] | Get-AzSentinelEntity +``` + +```output +FriendlyName : WIN2019 +Kind : Host +Name : 8d036a2d-f37d-e936-6cca-4e172687cb79 +``` + +This command gets an Entity by object + +### Example 4: Get a Entity by kind +```powershell + Get-AzSentinelEntity -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" | Where-Object {$_.Kind -eq "CloudApplication"} +``` + +```output +FriendlyName : Office 365 +Kind : CloudApplication +Name : 8fceb9c4-abe7-7174-aabf-f1dde96a945e +``` + +This command gets an Entity by kind + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +entity ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: EntityId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IEntity + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityActivity.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityActivity.md new file mode 100644 index 0000000000..44ad37bfb5 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityActivity.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelentityactivity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntityActivity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntityActivity.md +--- + +# Get-AzSentinelEntityActivity + +## SYNOPSIS +Get Insights and Activities for an entity. + +## SYNTAX + +``` +Get-AzSentinelEntityActivity -EntityId <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get Insights and Activities for an entity. + +## EXAMPLES + +### Example 1: Get Insights and Activities for an Entity +```powershell + Get-AzSentinelEntityActivity -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -EntityId "myEntityId" +``` + +```output +FriendlyName : WIN2019 +Kind : Host +Name : 8d036a2d-f37d-e936-6cca-4e172687cb79 + +FriendlyName : HackTool:Win32/Mimikatz.gen!H +Kind : Malware +Name : 876fda24-fe06-62b7-7dca-bced167a0ca3 + +FriendlyName : 52.166.111.66 +Kind : Ip +Name : 4ebb68f3-a435-fac0-d3b6-94712d246f0a +``` + +This command gets insights and activities for an Entity. + +### Example 2: Get Insights and Activities for an Entity by Id +```powershell + $Entity = Get-AzSentinelEntity -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -EntityId "4ebb68f3-a435-fac0-d3b6-94712d246f0a" + $Entity | Get-AzSentinelEntityActivity +``` + +This command gets insights and activies for an Entity by object + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityId +entity ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IEntityQueryItem + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityInsight.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityInsight.md new file mode 100644 index 0000000000..740f60d4e5 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityInsight.md @@ -0,0 +1,249 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelentityinsight +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntityInsight.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntityInsight.md +--- + +# Get-AzSentinelEntityInsight + +## SYNOPSIS +Execute Insights for an entity. + +## SYNTAX + +``` +Get-AzSentinelEntityInsight -EntityId <String> -ResourceGroupName <String> -WorkspaceName <String> + -EndTime <DateTime> -StartTime <DateTime> [-SubscriptionId <String[]>] [-AddDefaultExtendedTimeRange] + [-InsightQueryId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Execute Insights for an entity. + +## EXAMPLES + +### Example 1: Get Insights for an Entity for a given time range +```powershell + $startTime = (Get-Date).AddDays(-7).ToUniversalTime() | Get-Date -Format "yyyy-MM-ddThh:00:00.000Z" + $endTime = (Get-Date).ToUniversalTime() | Get-Date -Format "yyyy-MM-ddThh:00:00.000Z" + Get-AzSentinelEntityInsight -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -EntityId "myEntityId" -EndTime $endTime -StartTime $startTime +``` + +```output +QueryId : 4191a4d7-e72b-4564-b2fb-25580630384b +QueryTimeIntervalEndTime : 12/21/2021 10:00:00 AM +QueryTimeIntervalStartTime : 12/14/2021 10:00:00 AM +TableQueryResultColumn : {Activity, expectedCount, actualCount, anomalyScore…} +TableQueryResultRow : {4663 - An attempt was made to access an object. 0 3901 713.91 1 0} +``` + +This command gets insights for an Entity for a given time range. + +### Example 2: Get Insights for an Entity by entity Id for a given time range +```powershell + $startTime = (Get-Date).AddDays(-7).ToUniversalTime() | Get-Date -Format "yyyy-MM-ddThh:00:00.000Z" + $endTime = (Get-Date).ToUniversalTime() | Get-Date -Format "yyyy-MM-ddThh:00:00.000Z" + $Entity = Get-AzSentinelEntity -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -EntityId "8d036a2d-f37d-e936-6cca-4e172687cb79" + $Entity | Get-AzSentinelEntityInsight -EndTime $endTime -StartTime $startTime +``` + +```output +QueryId : 4191a4d7-e72b-4564-b2fb-25580630384b +QueryTimeIntervalEndTime : 12/21/2021 10:00:00 AM +QueryTimeIntervalStartTime : 12/14/2021 10:00:00 AM +TableQueryResultColumn : {Activity, expectedCount, actualCount, anomalyScore…} +TableQueryResultRow : {4663 - An attempt was made to access an object. 0 3901 713.91 1 0} +``` + +This command gets insights for an Entity by object for a given time range. + +## PARAMETERS + +### -AddDefaultExtendedTimeRange +Indicates if query time range should be extended with default time range of the query. +Default value is false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +The end timeline date, so the results returned are before this date. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityId +entity ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InsightQueryId +List of Insights Query Id. +If empty, default value is all insights of this entity + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +The start timeline date, so the results returned are after this date. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IEntityGetInsightsResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityQuery.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityQuery.md new file mode 100644 index 0000000000..269ed1caa3 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityQuery.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelentityquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntityQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntityQuery.md +--- + +# Get-AzSentinelEntityQuery + +## SYNOPSIS +Gets an entity query. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelEntityQuery -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-Kind <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelEntityQuery -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelEntityQuery -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an entity query. + +## EXAMPLES + +### Example 1: List all Entity Queries +```powershell + Get-AzSentinelEntityQuery -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +DisplayName : Related entities +DataSource : {SecurityAlert} +Name : 98b974fd-cc64-48b8-9bd0-3a209f5b944b +InputEntityType : SecurityAlert + +DisplayName : Related alerts +DataSource : {SecurityAlert} +Name : 055a5692-555f-42bd-ac17-923a5a9994ed +InputEntityType : Host +``` + +This command lists all Entity Queries under a Microsoft Sentinel workspace. + +### Example 2: Get an Entity Query +```powershell + Get-AzSentinelEntityQuery -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "myEntityQueryId" +``` + +```output +DisplayName : Related entities +DataSource : {SecurityAlert} +Name : 98b974fd-cc64-48b8-9bd0-3a209f5b944b +InputEntityType : SecurityAlert +QueryTemplate : let GetAlertRelatedEntities = (v_SecurityAlert_SystemAlertId:string){ + SecurityAlert + | where SystemAlertId == v_SecurityAlert_SystemAlertId + | project entities = todynamic(Entities) + | mv-expand entities + | project-rename entity=entities}; + GetAlertRelatedEntities('<systemAlertId>') +``` + +This command gets an Entity Query. + +### Example 3: Get an Entity Query by object Id +```powershell + $EntityQueries = Get-AzSentinelEntityQuery -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" + $EntityQueries[0] | Get-AzSentinelEntityQuery +``` + +```output +DisplayName : Related entities +DataSource : {SecurityAlert} +Name : 98b974fd-cc64-48b8-9bd0-3a209f5b944b +InputEntityType : SecurityAlert +QueryTemplate : let GetAlertRelatedEntities = (v_SecurityAlert_SystemAlertId:string){ + SecurityAlert + | where SystemAlertId == v_SecurityAlert_SystemAlertId + | project entities = todynamic(Entities) + | mv-expand entities + | project-rename entity=entities}; + GetAlertRelatedEntities('<systemAlertId>') +``` + +This command gets a Entity Query by object. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +entity query ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: EntityQueryId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +The entity query kind we want to fetch + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IEntityQuery + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityQueryTemplate.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityQueryTemplate.md new file mode 100644 index 0000000000..681840a772 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityQueryTemplate.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelentityquerytemplate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntityQueryTemplate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntityQueryTemplate.md +--- + +# Get-AzSentinelEntityQueryTemplate + +## SYNOPSIS +Gets an entity query. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelEntityQueryTemplate -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-Kind <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelEntityQueryTemplate -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelEntityQueryTemplate -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an entity query. + +## EXAMPLES + +### Example 1: List all Entity Query Templates +```powershell + Get-AzSentinelEntityQueryTemplate -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +Title : The user has created an account +Description : This activity displays account creation events performed by the user +InputEntityType : Account +Kind : Activity +Name : d6d08c94-455f-4ea5-8f76-fc6c0c442cfa + +Title : The user has deleted an account +Description : This activity displays account deletion events performed by the user +InputEntityType : Account +Kind : Activity +Name : e0459780-ac9d-4b72-8bd4-fecf6b46a0a1 +``` + +This command lists all Entity Query Templates under a Microsoft Sentinel workspace. + +### Example 2: Get an Entity Query Template +```powershell + Get-AzSentinelEntityQueryTemplate -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "d6d08c94-455f-4ea5-8f76-fc6c0c442cfa" +``` + +```output +Description : This activity displays account creation events performed by the user +InputEntityType : Account +Kind : Activity +Name : d6d08c94-455f-4ea5-8f76-fc6c0c442cfa +``` + +This command gets an Entity Query Template. + +### Example 3: Get an Entity Query Template by object Id +```powershell + $EntityQueryTemplates = Get-AzSentinelEntityQueryTemplate -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" + $EntityQueryTemplates[0] | Get-AzSentinelEntityQueryTemplate +``` + +```output +Description : This activity displays account creation events performed by the user +InputEntityType : Account +Kind : Activity +Name : d6d08c94-455f-4ea5-8f76-fc6c0c442cfa +``` + +This command gets a Entity Query Template by object. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +entity query template ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: EntityQueryTemplateId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +The entity template query kind we want to fetch + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IEntityQueryTemplate + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityRelation.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityRelation.md new file mode 100644 index 0000000000..746e7ea780 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityRelation.md @@ -0,0 +1,283 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelentityrelation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntityRelation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntityRelation.md +--- + +# Get-AzSentinelEntityRelation + +## SYNOPSIS +Gets an entity relation. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelEntityRelation -EntityId <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-Filter <String>] [-Orderby <String>] [-SkipToken <String>] [-Top <Int32>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelEntityRelation -EntityId <String> -RelationName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelEntityRelation -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an entity relation. + +## EXAMPLES + +### Example 1: List all Entity Relations for a given Entity +```powershell + Get-AzSentinelEntityRelation -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -EntityId "myEntityId" +``` + +This command lists all Entity Relations for a given Entity. + +### Example 2: Get an Entity Relation +```powershell + Get-AzSentinelEntityRelation -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -EntityId "myEntityId" -RelationName "myEntityRelationId" +``` + +This command gets an Entity Relation for a given Entity. + +### Example 3: Get an Entity Relation by object Id +```powershell + $EntityRelations = Get-AzSentinelEntityRelation -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -EntityId "myEntityId" + $EntityRelations[0] | Get-AzSentinelEntityRelation +``` + +This command gets a Entity Relation by object + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityId +entity ID + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filters the results, based on a Boolean condition. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Orderby +Sorts the results. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RelationName +Relation Name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +Skiptoken is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Returns only the first n results. +Optional. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IRelation + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityTimeline.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityTimeline.md new file mode 100644 index 0000000000..0d9fb66aad --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelEntityTimeline.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelentitytimeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntityTimeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelEntityTimeline.md +--- + +# Get-AzSentinelEntityTimeline + +## SYNOPSIS +Timeline for an entity. + +## SYNTAX + +``` +Get-AzSentinelEntityTimeline -EntityId <String> -ResourceGroupName <String> -WorkspaceName <String> + -EndTime <DateTime> -StartTime <DateTime> [-SubscriptionId <String[]>] [-Kind <EntityTimelineKind[]>] + [-NumberOfBucket <Int32>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Timeline for an entity. + +## EXAMPLES + +### Example 1: Get Timeline for an Entity for a given time range +```powershell + $startTime = (Get-Date).AddDays(-7).ToUniversalTime() | Get-Date -Format "yyyy-MM-ddThh:00:00.000Z" + $endTime = (Get-Date).ToUniversalTime() | Get-Date -Format "yyyy-MM-ddThh:00:00.000Z" + Get-AzSentinelEntityTimeline -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -EntityId "myEntityId" -EndTime $endTime -StartTime $startTime +``` + +```output +DisplayName : Suspicious process executed +Description : Machine logs indicate that a suspicious process often associated with attacker attempts to access credentials was running on the host. +Kind : SecurityAlert +ProductName : Azure Security Center +Severity : High +StartTimeUtc : 12/20/2021 3:04:17 PM +EndTimeUtc : 12/20/2021 3:04:17 PM +TimeGenerated : 12/20/2021 3:05:52 PM +``` + +This command gets the Timeline for an Entity for a given time range. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +The end timeline date, so the results returned are before this date. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityId +entity ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Array of timeline Item kinds. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.EntityTimelineKind[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfBucket +The number of bucket for timeline queries aggregation. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +The start timeline date, so the results returned are after this date. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IEntityTimelineResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncident.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncident.md new file mode 100644 index 0000000000..a778e9549e --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncident.md @@ -0,0 +1,280 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelincident +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelIncident.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelIncident.md +--- + +# Get-AzSentinelIncident + +## SYNOPSIS +Gets an incident. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelIncident -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-Filter <String>] [-Orderby <String>] [-SkipToken <String>] [-Top <Int32>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelIncident -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelIncident -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an incident. + +## EXAMPLES + +### Example 1: List all Incidents +```powershell + Get-AzSentinelIncident -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +Title : (Preview) TI map IP entity to AzureActivity +Description : Identifies a match in AzureActivity from any IP IOC from TI +Severity : Medium +Number : 754 +Label : {} +ProviderName : Azure Sentinel +Name : f5409f55-7dd8-4c73-9981-4627520b2db +``` + +This command lists all Incidents under a Microsoft Sentinel workspace. + +### Example 2: Get an Incident +```powershell + Get-AzSentinelIncident -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "f5409f55-7dd8-4c73-9981-4627520b2db" +``` + +```output +Title : (Preview) TI map IP entity to AzureActivity +Description : Identifies a match in AzureActivity from any IP IOC from TI +Severity : Medium +Number : 754 +Label : {} +ProviderName : Azure Sentinel +Name : f5409f55-7dd8-4c73-9981-4627520b2db +``` + +This command gets an Incident. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filters the results, based on a Boolean condition. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Incident ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: IncidentId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Orderby +Sorts the results. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +Skiptoken is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Returns only the first n results. +Optional. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IIncident + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentAlert.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentAlert.md new file mode 100644 index 0000000000..96c048001a --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentAlert.md @@ -0,0 +1,170 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelincidentalert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelIncidentAlert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelIncidentAlert.md +--- + +# Get-AzSentinelIncidentAlert + +## SYNOPSIS +Gets all incident alerts. + +## SYNTAX + +``` +Get-AzSentinelIncidentAlert -IncidentId <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Gets all incident alerts. + +## EXAMPLES + +### Example 1: List all Alerts for a given Incident +```powershell + Get-AzSentinelIncidentAlert -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -IncidentId "myIncidentId" +``` + +```output +AlertDisplayName : (Preview) TI map IP entity to SigninLogs +FriendlyName : (Preview) TI map IP entity to SigninLogs +Description : Identifies a match in SigninLogs from any IP IOC from TI +Kind : SecurityAlert +Name : d1e4d1dd-8d16-1aed-59bd-a256266d7244 +ProductName : Azure Sentinel +Status : New +ProviderAlertId : d6c7a42b-c0da-41ef-9629-b3d2d407b181 +Tactic : {Impact} +``` + +This command lists all Alerts for a given Incident. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentId +Incident ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ISecurityAlert + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentBookmark.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentBookmark.md new file mode 100644 index 0000000000..88bca65d1a --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentBookmark.md @@ -0,0 +1,169 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelincidentbookmark +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelIncidentBookmark.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelIncidentBookmark.md +--- + +# Get-AzSentinelIncidentBookmark + +## SYNOPSIS +Gets all incident bookmarks. + +## SYNTAX + +``` +Get-AzSentinelIncidentBookmark -IncidentId <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Gets all incident bookmarks. + +## EXAMPLES + +### Example 1: List all Bookmarks for a given Incident +```powershell + Get-AzSentinelIncidentBookmark -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -IncidentId "7f40bbbc-e205-404b-bc2b-5d71cd1017a8" +``` + +```output +DisplayName : My 2021 Bookmark +FriendlyName : My 2021 Bookmark +Label : {my Tags} +Note : my notes + 2nd line notes +CreatedByEmail : luke@contoso.com +CreatedByName : Luke +Name : 4557d832-41f0-456f-977e-78a2e129b8d0 +``` + +This command lists all Bookmarks for a given Incident. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentId +Incident ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IHuntingBookmark + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentComment.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentComment.md new file mode 100644 index 0000000000..cf32633c07 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentComment.md @@ -0,0 +1,294 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelincidentcomment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelIncidentComment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelIncidentComment.md +--- + +# Get-AzSentinelIncidentComment + +## SYNOPSIS +Gets an incident comment. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelIncidentComment -IncidentId <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-Filter <String>] [-Orderby <String>] [-SkipToken <String>] [-Top <Int32>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelIncidentComment -Id <String> -IncidentId <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelIncidentComment -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an incident comment. + +## EXAMPLES + +### Example 1: List all Incident Comments for a given Incident +```powershell + Get-AzSentinelIncidentComment -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -IncidentId "7a4c27ea-d61a-496b-b5c3-246770c857c1" +``` + +```output +AuthorEmail : john@contoso.com +AuthorName : John Contoso +AuthorUserPrincipalName : john@contoso.com +CreatedTimeUtc : 1/6/2022 2:15:44 PM +Message : This is my comment +Name : da0957c9-2f1a-44a2-bc83-a2c0696b2bf1 + +``` + +This command lists all Incident Comments for a given Incident. + +### Example 2: Get an Incident Comment +```powershell + Get-AzSentinelIncidentComment -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -IncidentId "7a4c27ea-d61a-496b-b5c3-246770c857c1" -Id "da0957c9-2f1a-44a2-bc83-a2c0696b2bf1" +``` + +```output +AuthorEmail : john@contoso.com +AuthorName : John Contoso +AuthorUserPrincipalName : john@contoso.com +CreatedTimeUtc : 1/6/2022 2:15:44 PM +Message : This is my comment +Name : da0957c9-2f1a-44a2-bc83-a2c0696b2bf1 +``` + +This command gets an Incident Comment. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filters the results, based on a Boolean condition. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Incident comment ID + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: IncidentCommentId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentId +Incident ID + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Orderby +Sorts the results. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +Skiptoken is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Returns only the first n results. +Optional. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IIncidentComment + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentEntity.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentEntity.md new file mode 100644 index 0000000000..8f8171e27f --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentEntity.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelincidententity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelIncidentEntity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelIncidentEntity.md +--- + +# Get-AzSentinelIncidentEntity + +## SYNOPSIS +Gets all incident related entities. + +## SYNTAX + +``` +Get-AzSentinelIncidentEntity -IncidentId <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Gets all incident related entities. + +## EXAMPLES + +### Example 1: List all Entities for a given Incident +```powershell + Get-AzSentinelIncidentEntity -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -IncidentId "0ddb580f-efd0-4076-bb77-77e9aef8a187" +``` + +```output +FriendlyName : win2019 +Kind : Host +Name : cb577adf-0266-8873-84d7-accf4b45417b +``` + +This command lists all Entities for a given Incident. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentId +Incident ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IIncidentEntitiesResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentRelation.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentRelation.md new file mode 100644 index 0000000000..a400c0d515 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelIncidentRelation.md @@ -0,0 +1,309 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelincidentrelation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelIncidentRelation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelIncidentRelation.md +--- + +# Get-AzSentinelIncidentRelation + +## SYNOPSIS +Gets an incident relation. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelIncidentRelation -IncidentId <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-Filter <String>] [-Orderby <String>] [-SkipToken <String>] [-Top <Int32>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelIncidentRelation -IncidentId <String> -RelationName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelIncidentRelation -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an incident relation. + +## EXAMPLES + +### Example 1: List all Incident Relations for a given Incident +```powershell + Get-AzSentinelIncidentRelation -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -IncidentId "myIncidentId" +``` + +```output +Name : 8969f5ea-4e92-433a-9b67-2f9233d8113f_457a48b2-9dfc-7054-64a5-e8a9d17489d7 +RelatedResourceName : 457a48b2-9dfc-7054-64a5-e8a9d17489d7 +RelatedResourceKind : SecurityAlert +RelatedResourceType : Microsoft.SecurityInsights/entities + +Name : 076bda5c-7d94-b6d8-8ef4-b0b2a0830dac_df9493a7-4f2e-84da-1f41-4914e8c029ba +RelatedResourceName : df9493a7-4f2e-84da-1f41-4914e8c029ba +RelatedResourceKind : SecurityAlert +RelatedResourceType : Microsoft.SecurityInsights/entities +``` + +This command lists all Incident Relations for a given Incident. + +### Example 2: Get a Incident Relation +```powershell + Get-AzSentinelIncidentRelation -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -IncidentId "myIncidentId" -RelationName "myIncidentRelationId" +``` + +```output +Name : 076bda5c-7d94-b6d8-8ef4-b0b2a0830dac_df9493a7-4f2e-84da-1f41-4914e8c029ba +RelatedResourceName : df9493a7-4f2e-84da-1f41-4914e8c029ba +RelatedResourceKind : SecurityAlert +RelatedResourceType : Microsoft.SecurityInsights/entities +``` + +This command gets a Incident Relation. + +### Example 3: Get a Incident Relation by object Id +```powershell + $Incidentrelations = Get-AzSentinelIncidentRelation -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -IncidentId "myIncidentId" + $Incidentrelations[0] | Get-AzSentinelIncidentRelation +``` + +```output +Name : 076bda5c-7d94-b6d8-8ef4-b0b2a0830dac_df9493a7-4f2e-84da-1f41-4914e8c029ba +RelatedResourceName : df9493a7-4f2e-84da-1f41-4914e8c029ba +RelatedResourceKind : SecurityAlert +RelatedResourceType : Microsoft.SecurityInsights/entities +``` + +This command gets a Incident by object + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filters the results, based on a Boolean condition. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentId +Incident ID + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Orderby +Sorts the results. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RelationName +Relation Name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +Skiptoken is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Returns only the first n results. +Optional. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IRelation + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelMetadata.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelMetadata.md new file mode 100644 index 0000000000..7e82749736 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelMetadata.md @@ -0,0 +1,258 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelmetadata +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelMetadata.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelMetadata.md +--- + +# Get-AzSentinelMetadata + +## SYNOPSIS +Get a Metadata. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelMetadata -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-Filter <String>] [-Orderby <String>] [-Skip <Int32>] [-Top <Int32>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelMetadata -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelMetadata -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a Metadata. + +## EXAMPLES + +### Example 1: Get Solution metadata from the workspace +```powershell + Get-AzSentinelMetadata -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +Etag Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType +---- ---- ------------------- ------------------- ----------- + azuresentinel.azure-sentinel-solution-slackaudit 3/11/2022 11:20:19 PM user@domain.local User +``` + +This command lists all Solution metadata for a workspace. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filters the results, based on a Boolean condition. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Metadata name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: MetadataName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orderby +Sorts the results. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Used to skip n elements in the OData query (offset). +Returns a nextLink to the next page of results if there are any left. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Returns only the first n results. +Optional. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IMetadataModel + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelOnboardingState.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelOnboardingState.md new file mode 100644 index 0000000000..d2854b3301 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelOnboardingState.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelonboardingstate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelOnboardingState.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelOnboardingState.md +--- + +# Get-AzSentinelOnboardingState + +## SYNOPSIS +Get Sentinel onboarding state + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelOnboardingState -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelOnboardingState -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelOnboardingState -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get Sentinel onboarding state + +## EXAMPLES + +### Example 1: List all Onboarding States +```powershell + Get-AzSentinelOnboardingState -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +Id : /subscriptions/314b1a41-c53c-4092-8d4a-2810f6a44a0c/resourceGroups/myRG/providers/Microsoft.OperationalInsights/workspaces/cybersecurity/providers/Microsoft.SecurityInsights/onboardingStates/default +Name : default +``` + +This command lists all Onboarding States under a Microsoft Sentinel workspace. + +### Example 2: Get an Onboarding State +```powershell + Get-AzSentinelOnboardingState -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Name "default" +``` + +```output +Id : /subscriptions/314b1a41-c53c-4092-8d4a-2810f6a44a0c/resourceGroups/myRG/providers/Microsoft.OperationalInsights/workspaces/cybersecurity/providers/Microsoft.SecurityInsights/onboardingStates/default +Name : default +``` + +This command gets an Onboarding State. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Sentinel onboarding state name. +Supports - default + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SentinelOnboardingStateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ISentinelOnboardingState + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelSetting.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelSetting.md new file mode 100644 index 0000000000..ca58753af8 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelSetting.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelSetting.md +--- + +# Get-AzSentinelSetting + +## SYNOPSIS +Gets a setting. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelSetting -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelSetting -ResourceGroupName <String> -SettingsName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelSetting -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a setting. + +## EXAMPLES + +### Example 1: List all Settings +```powershell + Get-AzSentinelSetting -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +Kind : EntityAnalytics +Name : EntityAnalytics +IsEnabled : True + +Kind : EyesOn +Name : EyesOn +IsEnabled : True + +Kind : IPSyncer +Name : IPSyncer + +Kind : Anomalies +Name : Anomalies +IsEnabled : True + +Kind : Ueba +Name : Ueba +DataSource : {AuditLogs, AzureActivity, SecurityEvent, SigninLogs} +``` + +This command lists all Settings under a Microsoft Sentinel workspace. + +### Example 2: Get a Setting +```powershell + Get-AzSentinelSetting -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -SettingsName "Anomalies" +``` + +```output +Kind : Anomalies +Name : Anomalies +IsEnabled : True +``` + +This command gets a Setting. + +### Example 3: Get a Setting by object Id +```powershell + $Settings = Get-AzSentinelSetting -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" + $Settings[0] | Get-AzSentinelSetting +``` + +```output +Kind : Anomalies +Name : Anomalies +IsEnabled : True +``` + +This command gets a Setting by object + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SettingsName +The setting name. +Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ISettings + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelThreatIntelligenceIndicator.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelThreatIntelligenceIndicator.md new file mode 100644 index 0000000000..9f1dc6fadb --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelThreatIntelligenceIndicator.md @@ -0,0 +1,291 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelthreatintelligenceindicator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelThreatIntelligenceIndicator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelThreatIntelligenceIndicator.md +--- + +# Get-AzSentinelThreatIntelligenceIndicator + +## SYNOPSIS +View a threat intelligence indicator by name. + +## SYNTAX + +### List (Default) +``` +Get-AzSentinelThreatIntelligenceIndicator -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-Filter <String>] [-Orderby <String>] [-SkipToken <String>] [-Top <Int32>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSentinelThreatIntelligenceIndicator -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSentinelThreatIntelligenceIndicator -InputObject <ISecurityInsightsIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +View a threat intelligence indicator by name. + +## EXAMPLES + +### Example 1: List all Threat Intelligence Indicators +```powershell + Get-AzSentinelThreatIntelligenceIndicator -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +Kind : indicator +Name : 8ff8f736-8f9b-a180-49a2-9a395cf088ca + +Kind : indicator +Name : 8afa82a1-6c4a-dca2-595f-28239965882d +``` + +This command lists all Threat Intelligence Indicators under a Microsoft Sentinel workspace. + +### Example 2: Get a Threat Intelligence Indicator +```powershell + Get-AzSentinelThreatIntelligenceIndicator -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Name "514840ce-5582-f7a4-8562-7996e29dc07a" +``` + +```output +Kind : indicator +Name : 514840ce-5582-f7a4-8562-7996e29dc07a +``` + +This command gets a Threat Intelligence Indicator by name (Id) + +### Example 3: Get the Threat Intelligence Indicator top 3 +```powershell + $tiIndicators = Get-AzSentinelThreatIntelligenceIndicator -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Top 3 +``` + +```output +Kind : indicator +Name : 8ff8f736-8f9b-a180-49a2-9a395cf088ca + +Kind : indicator +Name : 8afa82a1-6c4a-dca2-595f-28239965882d + +Kind : indicator +Name : 38ac867b-85f9-be4c-afd5-b3cffdcf69f1 +``` + +This command gets a Threat Intelligence Indicator by object + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filters the results, based on a Boolean condition. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Threat intelligence indicator name field. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Orderby +Sorts the results. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +Skiptoken is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. +Optional. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +Returns only the first n results. +Optional. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IThreatIntelligenceInformation + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelThreatIntelligenceIndicatorMetric.md b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelThreatIntelligenceIndicatorMetric.md new file mode 100644 index 0000000000..b204ffcf95 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Get-AzSentinelThreatIntelligenceIndicatorMetric.md @@ -0,0 +1,119 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/get-azsentinelthreatintelligenceindicatormetric +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelThreatIntelligenceIndicatorMetric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Get-AzSentinelThreatIntelligenceIndicatorMetric.md +--- + +# Get-AzSentinelThreatIntelligenceIndicatorMetric + +## SYNOPSIS +Get threat intelligence indicators metrics (Indicators counts by Type, Threat Type, Source). + +## SYNTAX + +``` +Get-AzSentinelThreatIntelligenceIndicatorMetric -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get threat intelligence indicators metrics (Indicators counts by Type, Threat Type, Source). + +## EXAMPLES + +### Example 1: Get all metrics for Threat Intelligence Indicators +```powershell + Get-AzSentinelThreatIntelligenceIndicatorMetric -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" +``` + +```output +LastUpdatedTimeUtc : 2022-02-07T10:44:45.3919348Z +PatternTypeMetric : {network-traffic, url, ipv4-addr, file} +SourceMetric : {Microsoft Emerging Threat Feed, Bing Safety Phishing URL, Azure Sentinel, CyberCrime…} +ThreatTypeMetric : {botnet, maliciousurl, phishing, malicious-activity…} +``` + +This command gets Threat Intelligence Indicator metrics. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IThreatIntelligenceMetrics + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Invoke-AzSentinelThreatIntelligenceIndicatorQuery.md b/azps-10.1.0/Az.SecurityInsights/Invoke-AzSentinelThreatIntelligenceIndicatorQuery.md new file mode 100644 index 0000000000..75818e2808 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Invoke-AzSentinelThreatIntelligenceIndicatorQuery.md @@ -0,0 +1,358 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/invoke-azsentinelthreatintelligenceindicatorquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Invoke-AzSentinelThreatIntelligenceIndicatorQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Invoke-AzSentinelThreatIntelligenceIndicatorQuery.md +--- + +# Invoke-AzSentinelThreatIntelligenceIndicatorQuery + +## SYNOPSIS +Query threat intelligence indicators as per filtering criteria. + +## SYNTAX + +``` +Invoke-AzSentinelThreatIntelligenceIndicatorQuery -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-Id <String[]>] [-IncludeDisabled] [-Keyword <String[]>] [-MaxConfidence <Int32>] + [-MaxValidUntil <String>] [-MinConfidence <Int32>] [-MinValidUntil <String>] [-PageSize <Int32>] + [-PatternType <String[]>] [-SkipToken <String>] [-SortBy <IThreatIntelligenceSortingCriteria[]>] + [-Source <String[]>] [-ThreatType <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Query threat intelligence indicators as per filtering criteria. + +## EXAMPLES + +### Example 1: Query all Threat Intelligence Indicators +```powershell +Invoke-AzSentinelThreatIntelligenceIndicatorQuery -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" +``` + +```output +Etag Kind Name SystemDataCreatedAt SystemDataCreatedBy +---- ---- ---- ------------------- ------- +"b603878e-0000-0100-0000-62d1d0010000" indicator f4dd9aa3-081b-2f0b-a5d7-3805954e8a39 +``` + +This command queries TI indicators. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Ids of threat intelligence indicators + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDisabled +Parameter to include/exclude disabled indicators. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Keyword +Keywords for searching threat intelligence indicators + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxConfidence +Maximum confidence. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxValidUntil +End time for ValidUntil filter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinConfidence +Minimum confidence. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinValidUntil +Start time for ValidUntil filter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Page size + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PatternType +Pattern types + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +Skip token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SortBy +Columns to sort by and sorting order +To construct, see NOTES section for SORTBY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IThreatIntelligenceSortingCriteria[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Sources of threat intelligence indicators + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThreatType +Threat types of threat intelligence indicators + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IThreatIntelligenceInformation + +## 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. + + +`SORTBY <IThreatIntelligenceSortingCriteria[]>`: Columns to sort by and sorting order + - `[ItemKey <String>]`: Column name + - `[SortOrder <ThreatIntelligenceSortingCriteriaEnum?>]`: Sorting order (ascending/descending/unsorted). + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/New-AzSentinelAlertRule.md b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelAlertRule.md new file mode 100644 index 0000000000..17e4c6170d --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelAlertRule.md @@ -0,0 +1,776 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/new-azsentinelalertrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelAlertRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelAlertRule.md +--- + +# New-AzSentinelAlertRule + +## SYNOPSIS +Creates the alert rule. + +## SYNTAX + +### FusionMLTI (Default) +``` +New-AzSentinelAlertRule -ResourceGroupName <String> -WorkspaceName <String> -AlertRuleTemplate <String> + -Kind <AlertRuleKind> [-RuleId <String>] [-SubscriptionId <String>] [-Enabled] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### MicrosoftSecurityIncidentCreation +``` +New-AzSentinelAlertRule -ResourceGroupName <String> -WorkspaceName <String> -Kind <AlertRuleKind> + -ProductFilter <MicrosoftSecurityProductName> [-RuleId <String>] [-SubscriptionId <String>] + [-AlertRuleTemplateName <String>] [-Description <String>] [-DisplayNamesExcludeFilter <String>] + [-DisplayNamesFilter <String>] [-Enabled] [-SeveritiesFilter <AlertSeverity[]>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### NRT +``` +New-AzSentinelAlertRule -ResourceGroupName <String> -WorkspaceName <String> -DisplayName <String> + -Kind <AlertRuleKind> -Query <String> -Severity <AlertSeverity> [-RuleId <String>] [-SubscriptionId <String>] + [-AlertDescriptionFormat <String>] [-AlertDisplayNameFormat <String>] [-AlertRuleTemplateName <String>] + [-AlertSeverityColumnName <String>] [-AlertTacticsColumnName <String>] [-CreateIncident] + [-Description <String>] [-Enabled] [-EntityMapping <EntityMapping>] [-GroupByAlertDetail <AlertDetail>] + [-GroupByCustomDetail <String[]>] [-GroupByEntity <EntityMappingType>] [-GroupingConfigurationEnabled] + [-LookbackDuration <TimeSpan>] [-MatchingMethod <String>] [-ReOpenClosedIncident] + [-SuppressionDuration <TimeSpan>] [-SuppressionEnabled] [-Tactic <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Scheduled +``` +New-AzSentinelAlertRule -ResourceGroupName <String> -WorkspaceName <String> -DisplayName <String> + -Kind <AlertRuleKind> -Query <String> -QueryFrequency <TimeSpan> -QueryPeriod <TimeSpan> + -Severity <AlertSeverity> -TriggerOperator <TriggerOperator> -TriggerThreshold <Int32> [-RuleId <String>] + [-SubscriptionId <String>] [-AlertDescriptionFormat <String>] [-AlertDisplayNameFormat <String>] + [-AlertRuleTemplateName <String>] [-AlertSeverityColumnName <String>] [-AlertTacticsColumnName <String>] + [-CreateIncident] [-Description <String>] [-Enabled] [-EntityMapping <EntityMapping>] + [-EventGroupingSettingAggregationKind <EventGroupingAggregationKind>] [-GroupByAlertDetail <AlertDetail>] + [-GroupByCustomDetail <String[]>] [-GroupByEntity <EntityMappingType>] [-GroupingConfigurationEnabled] + [-LookbackDuration <TimeSpan>] [-MatchingMethod <String>] [-ReOpenClosedIncident] + [-SuppressionDuration <TimeSpan>] [-SuppressionEnabled] [-Tactic <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates the alert rule. + +## EXAMPLES + +### Example 1: Create the Fusion Alert rule +```powershell + $AlertRuleTemplateName = "f71aba3d-28fb-450b-b192-4e76a83015c8" + New-AzSentinelAlertRule -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -Kind Fusion -Enabled -AlertRuleTemplateName $AlertRuleTemplateName +``` + +This command creates an Alert Rule of the Fusion kind based on the template "Advanced Multistage Attack Detection" + +### Example 2: Create the ML Behavior Analytics Alert Rule +```powershell + $AlertRuleTemplateName = "fa118b98-de46-4e94-87f9-8e6d5060b60b" + New-AzSentinelAlertRule -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -Kind MLBehaviorAnalytics -Enabled -AlertRuleTemplateName $AlertRuleTemplateName +``` + +This command creates an Alert Rule of the MLBehaviorAnalytics kind based on the template "Anomalous SSH Login Detection" + +### Example 3: Create the Threat Intelligence Alert Rule +```powershell + $AlertRuleTemplateName = "0dd422ee-e6af-4204-b219-f59ac172e4c6" + New-AzSentinelAlertRule -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -Kind ThreatIntelligence -Enabled -AlertRuleTemplateName $AlertRuleTemplateName +``` + +This command creates an Alert Rule of the ThreatIntelligence kind based on the template "Microsoft Threat Intelligence Analytics" + +### Example 4: Create a Microsoft Security Incident Creation Alert Rule +```powershell + $AlertRuleTemplateName = "a2e0eb51-1f11-461a-999b-cd0ebe5c7a72" + New-AzSentinelAlertRule -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -Kind MicrosoftSecurityIncidentCreation -Enabled -AlertRuleTemplateName $AlertRuleTemplateName -ProductFilter "Azure Security Center for IoT" +``` + +This command creates an Alert Rule of the MicrosoftSecurityIncidentCreation kind based on the template for Create incidents based on Azure Security Center for IoT alerts. + +### Example 5: Create a Scheduled Alert Rule +```powershell +New-AzSentinelAlertRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Kind Scheduled -Enabled -DisplayName "Powershell Exection Alert (Several Times per Hour)" -Severity Low -Query "SecurityEvent | where EventId == 4688" -QueryFrequency (New-TimeSpan -Hours 1) -QueryPeriod (New-TimeSpan -Hours 1) -TriggerThreshold 10 +``` + +This command creates an Alert Rule of the Scheduled kind. +Please note that that query (parameter -Query) needs to be on a single line as as string. + +### Example 6: Create a Near Realtime Alert Rule +```powershell +New-AzSentinelAlertRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Kind NRT -Enabled -DisplayName "Break glass account accessed" -Severity High -Query "let Break_Glass_Account = _GetWatchlist('break_glass_account')\n|project UPN;\nSigninLogs\n| where UserPrincipalName in (Break_Glass_Account)" +``` + +This command creates an Alert Rule of the NRT kind. +Please note that that query (parameter -Query) needs to be on a single line as as string. + +## PARAMETERS + +### -AlertDescriptionFormat + + +```yaml +Type: System.String +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertDisplayNameFormat + + +```yaml +Type: System.String +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertRuleTemplate + + +```yaml +Type: System.String +Parameter Sets: FusionMLTI +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertRuleTemplateName + + +```yaml +Type: System.String +Parameter Sets: MicrosoftSecurityIncidentCreation, NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertSeverityColumnName + + +```yaml +Type: System.String +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertTacticsColumnName + + +```yaml +Type: System.String +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateIncident + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + + +```yaml +Type: System.String +Parameter Sets: MicrosoftSecurityIncidentCreation, NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName + + +```yaml +Type: System.String +Parameter Sets: NRT, Scheduled +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayNamesExcludeFilter + + +```yaml +Type: System.String +Parameter Sets: MicrosoftSecurityIncidentCreation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayNamesFilter + + +```yaml +Type: System.String +Parameter Sets: MicrosoftSecurityIncidentCreation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityMapping +'Account', 'Host', 'IP', 'Malware', 'File', 'Process', 'CloudApplication', 'DNS', 'AzureResource', 'FileHash', 'RegistryKey', 'RegistryValue', 'SecurityGroup', 'URL', 'Mailbox', 'MailCluster', 'MailMessage', 'SubmissionMail' +To construct, see NOTES section for ENTITYMAPPING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.EntityMapping +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventGroupingSettingAggregationKind + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.EventGroupingAggregationKind +Parameter Sets: Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByAlertDetail + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.AlertDetail +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByCustomDetail + + +```yaml +Type: System.String[] +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByEntity + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.EntityMappingType +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupingConfigurationEnabled + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the the data connection + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.AlertRuleKind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LookbackDuration + + +```yaml +Type: System.TimeSpan +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: New-TimeSpan -Hours 5 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchingMethod + + +```yaml +Type: System.String +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: "AllEntities" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProductFilter + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.MicrosoftSecurityProductName +Parameter Sets: MicrosoftSecurityIncidentCreation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query + + +```yaml +Type: System.String +Parameter Sets: NRT, Scheduled +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryFrequency + + +```yaml +Type: System.TimeSpan +Parameter Sets: Scheduled +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryPeriod + + +```yaml +Type: System.TimeSpan +Parameter Sets: Scheduled +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReOpenClosedIncident + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +[Alias('RuleId')] + The Id of the Rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (New-Guid).Guid +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SeveritiesFilter +High, Medium, Low, Informational + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.AlertSeverity[] +Parameter Sets: MicrosoftSecurityIncidentCreation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.AlertSeverity +Parameter Sets: NRT, Scheduled +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuppressionDuration + + +```yaml +Type: System.TimeSpan +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: New-TimeSpan -Hours 5 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuppressionEnabled + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tactic +[Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.AttackTactic] +InitialAccess, Execution, Persistence, PrivilegeEscalation, DefenseEvasion, CredentialAccess, Discovery, LateralMovement, Collection, Exfiltration, CommandAndControl, Impact, PreAttack + +```yaml +Type: System.String +Parameter Sets: NRT, Scheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerOperator + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.TriggerOperator +Parameter Sets: Scheduled +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerThreshold + + +```yaml +Type: System.Int32 +Parameter Sets: Scheduled +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.AlertRule + +## 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. + + +`ENTITYMAPPING <EntityMapping>`: 'Account', 'Host', 'IP', 'Malware', 'File', 'Process', 'CloudApplication', 'DNS', 'AzureResource', 'FileHash', 'RegistryKey', 'RegistryValue', 'SecurityGroup', 'URL', 'Mailbox', 'MailCluster', 'MailMessage', 'SubmissionMail' + - `[EntityType <EntityMappingType?>]`: The V3 type of the mapped entity + - `[FieldMapping <IFieldMapping[]>]`: array of field mappings for the given entity mapping + - `[ColumnName <String>]`: the column name to be mapped to the identifier + - `[Identifier <String>]`: the V3 identifier of the entity + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/New-AzSentinelAlertRuleAction.md b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelAlertRuleAction.md new file mode 100644 index 0000000000..7b23ac50fa --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelAlertRuleAction.md @@ -0,0 +1,206 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/new-azsentinelalertruleaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelAlertRuleAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelAlertRuleAction.md +--- + +# New-AzSentinelAlertRuleAction + +## SYNOPSIS +Creates or updates the action of alert rule. + +## SYNTAX + +``` +New-AzSentinelAlertRuleAction -ResourceGroupName <String> -RuleId <String> -WorkspaceName <String> + [-Id <String>] [-SubscriptionId <String>] [-LogicAppResourceId <String>] [-TriggerUri <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the action of alert rule. + +## EXAMPLES + +### Example 1: Add a Logic App Playbook as an action to an existing analytics rule +```powershell + $LogicAppResourceId = Get-AzLogicApp -ResourceGroupName "myLogicAppResourceGroupName" -Name "myLogicAppPlaybookName" +$LogicAppTriggerUri = Get-AzLogicAppTriggerCallbackUrl -ResourceGroupName "myLogicAppResourceGroupName" -Name $LogicAppResourceId.Name -TriggerName "When_a_response_to_an_Azure_Sentinel_alert_is_triggered" +New-AzSentinelAlertRuleAction -ResourceGroupName "mySentinelResourceGroupName" -workspaceName "myWorkspaceName" -RuleId "48bbf86d-540b-4a7b-9fee-2bd7d810dbed" -LogicAppResourceId ($LogicAppResourceId.Id) -TriggerUri ($LogicAppTriggerUri.Value) -Id ((New-Guid).Guid) +``` + +This command adds an existing Logic App Playbook to an existing analytics rule + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Action ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ActionId + +Required: False +Position: Named +Default value: (New-Guid).Guid +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogicAppResourceId +Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Alert rule ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerUri +Logic App Callback URL for this specific workflow. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IActionResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/New-AzSentinelAutomationRule.md b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelAutomationRule.md new file mode 100644 index 0000000000..fbffbd9d82 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelAutomationRule.md @@ -0,0 +1,328 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/new-azsentinelautomationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelAutomationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelAutomationRule.md +--- + +# New-AzSentinelAutomationRule + +## SYNOPSIS +Creates or updates the automation rule. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzSentinelAutomationRule -ResourceGroupName <String> -WorkspaceName <String> [-Id <String>] + [-SubscriptionId <String>] [-Action <IAutomationRuleAction[]>] [-DisplayName <String>] [-Order <Int32>] + [-TriggeringLogicCondition <IAutomationRuleCondition[]>] [-TriggeringLogicExpirationTimeUtc <DateTime>] + [-TriggeringLogicIsEnabled] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzSentinelAutomationRule -ResourceGroupName <String> -WorkspaceName <String> + -AutomationRule <IAutomationRule> [-Id <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the automation rule. + +## EXAMPLES + +### Example 1: Create an Automation Rule using Run Playbook +```powershell + $LogicAppResourceId = Get-AzLogicApp -ResourceGroupName "myResourceGroup" -Name "Reset-AADPassword" + $automationRuleAction = [Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.AutomationRuleRunPlaybookAction]::new() + $automationRuleAction.Order = 1 + $automationRuleAction.ActionType = "RunPlaybook" + $automationRuleAction.ActionConfigurationLogicAppResourceId = ($LogicAppResourceId.Id) + $automationRuleAction.ActionConfigurationTenantId = (Get-AzContext).Tenant.Id + New-AzSentinelAutomationRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id ((New-Guid).Guid) -Action $automationRuleAction -DisplayName "Run Playbook to reset AAD password" -Order 2 -TriggeringLogicIsEnabled +``` + +This command creates an Automation Rule that has an Action of Run Playbook. + +### Example 2: Creates an Automation Rule that has an Action of changing the severity +```powershell + $automationRuleAction = [Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.AutomationRuleModifyPropertiesAction]::new() + $automationRuleAction.Order = 1 + $automationRuleAction.ActionType = "ModifyProperties" + $automationRuleAction.ActionConfigurationSeverity = "Low" + New-AzSentinelAutomationRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id ((New-Guid).Guid) -Action $automationRuleAction -DisplayName "Change severity to Low" -Order 3 -TriggeringLogicIsEnabled +``` + +This command creates an Automation Rule that has an Action of changing the severity. + +## PARAMETERS + +### -Action +The actions to execute when the automation rule is triggered +To construct, see NOTES section for ACTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IAutomationRuleAction[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomationRule +Represents an automation rule. +To construct, see NOTES section for AUTOMATIONRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IAutomationRule +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name of the automation rule + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Automation rule ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AutomationRuleId + +Required: False +Position: Named +Default value: (New-Guid).Guid +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +The order of execution of the automation rule + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggeringLogicCondition +The conditions to evaluate to determine if the automation rule should be triggered on a given object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IAutomationRuleCondition[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggeringLogicExpirationTimeUtc +Determines when the automation rule should automatically expire and be disabled. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggeringLogicIsEnabled +Determines whether the automation rule is enabled or disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IAutomationRule + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IAutomationRule + +## 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. + + +`ACTION <IAutomationRuleAction[]>`: The actions to execute when the automation rule is triggered + - `ActionType <AutomationRuleActionType>`: The type of the automation rule action + - `Order <Int32>`: The order of execution of the automation rule action + +`AUTOMATIONRULE <IAutomationRule>`: Represents an automation rule. + - `[Etag <String>]`: Etag of the azure resource + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Action <IAutomationRuleAction[]>]`: The actions to execute when the automation rule is triggered + - `ActionType <AutomationRuleActionType>`: The type of the automation rule action + - `Order <Int32>`: The order of execution of the automation rule action + - `[CreatedByEmail <String>]`: The email of the client. + - `[CreatedByName <String>]`: The name of the client. + - `[CreatedByObjectId <String>]`: The object id of the client. + - `[CreatedByUserPrincipalName <String>]`: The user principal name of the client. + - `[DisplayName <String>]`: The display name of the automation rule + - `[LastModifiedByEmail <String>]`: The email of the client. + - `[LastModifiedByName <String>]`: The name of the client. + - `[LastModifiedByObjectId <String>]`: The object id of the client. + - `[LastModifiedByUserPrincipalName <String>]`: The user principal name of the client. + - `[Order <Int32?>]`: The order of execution of the automation rule + - `[TriggeringLogicCondition <IAutomationRuleCondition[]>]`: The conditions to evaluate to determine if the automation rule should be triggered on a given object + - `[TriggeringLogicExpirationTimeUtc <DateTime?>]`: Determines when the automation rule should automatically expire and be disabled. + - `[TriggeringLogicIsEnabled <Boolean?>]`: Determines whether the automation rule is enabled or disabled. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/New-AzSentinelBookmark.md b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelBookmark.md new file mode 100644 index 0000000000..7a36645e97 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelBookmark.md @@ -0,0 +1,407 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/new-azsentinelbookmark +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelBookmark.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelBookmark.md +--- + +# New-AzSentinelBookmark + +## SYNOPSIS +Creates or updates the bookmark. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzSentinelBookmark -ResourceGroupName <String> -WorkspaceName <String> [-Id <String>] + [-SubscriptionId <String>] [-DisplayName <String>] [-EventTime <DateTime>] [-IncidentInfoIncidentId <String>] + [-IncidentInfoRelationName <String>] [-IncidentInfoSeverity <IncidentSeverity>] [-IncidentInfoTitle <String>] + [-Label <String[]>] [-Note <String>] [-Query <String>] [-QueryEndTime <DateTime>] [-QueryResult <String>] + [-QueryStartTime <DateTime>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzSentinelBookmark -ResourceGroupName <String> -WorkspaceName <String> -Bookmark <IBookmark> + [-Id <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the bookmark. + +## EXAMPLES + +### Example 1: Create a Bookmark +```powershell + $queryStartTime = (Get-Date).AddDays(-1).ToUniversalTime() | Get-Date -Format "yyyy-MM-ddThh:00:00.000Z" + $queryEndTime = (Get-Date).ToUniversalTime() | Get-Date -Format "yyyy-MM-ddThh:00:00.000Z" + New-AzSentinelBookmark -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id ((New-Guid).Guid) -DisplayName "Incident Evidence" -Query "SecurityEvent | take 1" -QueryStartTime $queryStartTime -QueryEndTime $queryEndTime -EventTime $queryEndTime +``` + +```output +DisplayName : Incident Evidence +CreatedByName : John Contoso +CreatedByEmail : john@contoso.com +Name : 6a8d6ea6-04d5-49d7-8169-ffca8b0ced59 +Note : my notes +``` + +This command creates a Bookmark. + +## PARAMETERS + +### -Bookmark +Represents a bookmark in Azure Security Insights. +To construct, see NOTES section for BOOKMARK properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IBookmark +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name of the bookmark + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventTime +The bookmark event time + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Bookmark ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BookmarkId + +Required: False +Position: Named +Default value: (New-Guid).Guid +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentInfoIncidentId +Incident Id + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentInfoRelationName +Relation Name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentInfoSeverity +The severity of the incident + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.IncidentSeverity +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentInfoTitle +The title of the incident + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +List of labels relevant to this bookmark + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +The notes of the bookmark + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +The query of the bookmark. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryEndTime +The end time for the query + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryResult +The query result of the bookmark. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryStartTime +The start time for the query + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IBookmark + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IBookmark + +## 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. + + +`BOOKMARK <IBookmark>`: Represents a bookmark in Azure Security Insights. + - `[Etag <String>]`: Etag of the azure resource + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Created <DateTime?>]`: The time the bookmark was created + - `[CreatedByObjectId <String>]`: The object id of the user. + - `[DisplayName <String>]`: The display name of the bookmark + - `[EventTime <DateTime?>]`: The bookmark event time + - `[IncidentInfoIncidentId <String>]`: Incident Id + - `[IncidentInfoRelationName <String>]`: Relation Name + - `[IncidentInfoSeverity <IncidentSeverity?>]`: The severity of the incident + - `[IncidentInfoTitle <String>]`: The title of the incident + - `[Label <String[]>]`: List of labels relevant to this bookmark + - `[Note <String>]`: The notes of the bookmark + - `[Query <String>]`: The query of the bookmark. + - `[QueryEndTime <DateTime?>]`: The end time for the query + - `[QueryResult <String>]`: The query result of the bookmark. + - `[QueryStartTime <DateTime?>]`: The start time for the query + - `[Updated <DateTime?>]`: The last time the bookmark was updated + - `[UpdatedByObjectId <String>]`: The object id of the user. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/New-AzSentinelBookmarkRelation.md b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelBookmarkRelation.md new file mode 100644 index 0000000000..9d307a625c --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelBookmarkRelation.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/new-azsentinelbookmarkrelation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelBookmarkRelation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelBookmarkRelation.md +--- + +# New-AzSentinelBookmarkRelation + +## SYNOPSIS +Creates the bookmark relation. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzSentinelBookmarkRelation -BookmarkId <String> -ResourceGroupName <String> -WorkspaceName <String> + [-RelationName <String>] [-SubscriptionId <String>] [-RelatedResourceId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzSentinelBookmarkRelation -BookmarkId <String> -ResourceGroupName <String> -WorkspaceName <String> + -Relation <IRelation> [-RelationName <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates the bookmark relation. + +## EXAMPLES + +### Example 1: Create a Bookmark Relation +```powershell + $incident = Get-AzSentinelIncident -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id "myIncidentId" + $bookmarkRelation = New-AzSentinelBookmarkRelation -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -BookmarkId "myBookmarkId" -RelationName ((New-Guid).Guid) -RelatedResourceId ($incident.Id) +``` + +This command creates a Bookmark Relation connecting the Incident to the Bookmark. + +## PARAMETERS + +### -BookmarkId +Bookmark ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RelatedResourceId +The resource ID of the related resource + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Relation +Represents a relation between two resources +To construct, see NOTES section for RELATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IRelation +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RelationName +Relation Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (New-Guid).Guid +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IRelation + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IRelation + +## 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. + + +`RELATION <IRelation>`: Represents a relation between two resources + - `[Etag <String>]`: Etag of the azure resource + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[RelatedResourceId <String>]`: The resource ID of the related resource + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/New-AzSentinelDataConnector.md b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelDataConnector.md new file mode 100644 index 0000000000..ebed394133 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelDataConnector.md @@ -0,0 +1,964 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/new-azsentineldataconnector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelDataConnector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelDataConnector.md +--- + +# New-AzSentinelDataConnector + +## SYNOPSIS +Creates or updates the data connector. + +## SYNTAX + +### AADAATP (Default) +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -Kind <DataConnectorKind> + [-Id <String>] [-SubscriptionId <String>] [-Alerts <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### AmazonWebServicesCloudTrail +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -AWSRoleArn <String> + -Kind <DataConnectorKind> [-Id <String>] [-SubscriptionId <String>] [-Log <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### AmazonWebServicesS3 +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -AWSRoleArn <String> + -DetinationTable <String> -Kind <DataConnectorKind> -Log <String> -SQSURL <String[]> [-Id <String>] + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### AzureSecurityCenter +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -ASCSubscriptionId <String> + -Kind <DataConnectorKind> [-Id <String>] [-SubscriptionId <String>] [-Alerts <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Dynamics365 +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -Kind <DataConnectorKind> + [-Id <String>] [-SubscriptionId <String>] [-CommonDataServiceActivity <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### GenericUI +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> + -AvailabilityIsPreview <Boolean> -Kind <DataConnectorKind> + -UiConfigConnectivityCriterion <ConnectivityCriteria[]> -UiConfigDataType <LastDataReceivedDataType[]> + -UiConfigDescriptionMarkdown <String> -UiConfigGraphQueriesTableName <String> + -UiConfigGraphQuery <GraphQueries[]> -UiConfigInstructionStep <InstructionSteps[]> + -UiConfigPublisher <String> -UiConfigSampleQuery <SampleQueries[]> -UiConfigTitle <String> [-Id <String>] + [-SubscriptionId <String>] [-AvailabilityStatus <Int32>] [-PermissionCustom <PermissionsCustomsItem[]>] + [-PermissionResourceProvider <PermissionsResourceProviderItem[]>] [-UiConfigCustomImage <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### MicrosoftCloudAppSecurity +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -Kind <DataConnectorKind> + [-Id <String>] [-SubscriptionId <String>] [-Alerts <String>] [-DiscoveryLog <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### MicrosoftDefenderAdvancedThreatProtection +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -Kind <DataConnectorKind> + [-Id <String>] [-SubscriptionId <String>] [-Alerts <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### MicrosoftThreatIntelligence +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -Kind <DataConnectorKind> + [-Id <String>] [-SubscriptionId <String>] [-BingSafetyPhishingURL <String>] + [-BingSafetyPhishingUrlLookbackPeriod <String>] [-MicrosoftEmergingThreatFeed <String>] + [-MicrosoftEmergingThreatFeedLookbackPeriod <String>] [-TenantId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### MicrosoftThreatProtection +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -Kind <DataConnectorKind> + [-Id <String>] [-SubscriptionId <String>] [-Incident <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Office365 +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -Kind <DataConnectorKind> + [-Id <String>] [-SubscriptionId <String>] [-Exchange <String>] [-SharePoint <String>] [-Teams <String>] + [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### OfficeATP +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -Kind <DataConnectorKind> + [-Id <String>] [-SubscriptionId <String>] [-Alerts <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### OfficeIRM +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -Kind <DataConnectorKind> + [-Id <String>] [-SubscriptionId <String>] [-Alerts <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ThreatIntelligence +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -Kind <DataConnectorKind> + [-Id <String>] [-SubscriptionId <String>] [-Indicator <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ThreatIntelligenceTaxii +``` +New-AzSentinelDataConnector -ResourceGroupName <String> -WorkspaceName <String> -APIRootURL <String> + -CollectionId <String> -FriendlyName <String> -Kind <DataConnectorKind> -PollingFrequency <PollingFrequency> + -WorkspaceId <String> [-Id <String>] [-SubscriptionId <String>] [-Password <String>] + [-TaxiiLookbackPeriod <String>] [-TenantId <String>] [-UserName <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the data connector. + +## EXAMPLES + +### Example 1: Enable a data connector. +```powershell +New-AzSentinelDataConnector -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -Kind 'MicrosoftThreatIntelligence' -BingSafetyPhishingURL Enabled -BingSafetyPhishingUrlLookbackPeriod All -MicrosoftEmergingThreatFeed Enabled -MicrosoftEmergingThreatFeedLookbackPeriod All +``` + +This command enables the Threat Intelligence data connector + +## PARAMETERS + +### -Alerts + + +```yaml +Type: System.String +Parameter Sets: AADAATP, AzureSecurityCenter, MicrosoftCloudAppSecurity, MicrosoftDefenderAdvancedThreatProtection, OfficeATP, OfficeIRM +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -APIRootURL + + +```yaml +Type: System.String +Parameter Sets: ThreatIntelligenceTaxii +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ASCSubscriptionId +ASC Subscription Id. + +```yaml +Type: System.String +Parameter Sets: AzureSecurityCenter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityIsPreview +[Parameter(ParameterSetName = 'APIPolling', Mandatory)] + +```yaml +Type: System.Boolean +Parameter Sets: GenericUI +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityStatus +[Parameter(ParameterSetName = 'APIPolling')] + +```yaml +Type: System.Int32 +Parameter Sets: GenericUI +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AWSRoleArn + + +```yaml +Type: System.String +Parameter Sets: AmazonWebServicesCloudTrail, AmazonWebServicesS3 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BingSafetyPhishingURL + + +```yaml +Type: System.String +Parameter Sets: MicrosoftThreatIntelligence +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BingSafetyPhishingUrlLookbackPeriod + + +```yaml +Type: System.String +Parameter Sets: MicrosoftThreatIntelligence +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionId + + +```yaml +Type: System.String +Parameter Sets: ThreatIntelligenceTaxii +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommonDataServiceActivity + + +```yaml +Type: System.String +Parameter Sets: Dynamics365 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetinationTable + + +```yaml +Type: System.String +Parameter Sets: AmazonWebServicesS3 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiscoveryLog + + +```yaml +Type: System.String +Parameter Sets: MicrosoftCloudAppSecurity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exchange + + +```yaml +Type: System.String +Parameter Sets: Office365 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName + + +```yaml +Type: System.String +Parameter Sets: ThreatIntelligenceTaxii +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The Id of the Data Connector. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (New-Guid).Guid +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Incident + + +```yaml +Type: System.String +Parameter Sets: MicrosoftThreatProtection +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Indicator + + +```yaml +Type: System.String +Parameter Sets: ThreatIntelligence +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the the data connection + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.DataConnectorKind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Log + + +```yaml +Type: System.String +Parameter Sets: AmazonWebServicesCloudTrail, AmazonWebServicesS3 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftEmergingThreatFeed + + +```yaml +Type: System.String +Parameter Sets: MicrosoftThreatIntelligence +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftEmergingThreatFeedLookbackPeriod + + +```yaml +Type: System.String +Parameter Sets: MicrosoftThreatIntelligence +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password + + +```yaml +Type: System.String +Parameter Sets: ThreatIntelligenceTaxii +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionCustom +[Parameter(ParameterSetName = 'APIPolling')] +To construct, see NOTES section for PERMISSIONCUSTOM properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.PermissionsCustomsItem[] +Parameter Sets: GenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionResourceProvider +[Parameter(ParameterSetName = 'APIPolling')] +To construct, see NOTES section for PERMISSIONRESOURCEPROVIDER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.PermissionsResourceProviderItem[] +Parameter Sets: GenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PollingFrequency + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.PollingFrequency +Parameter Sets: ThreatIntelligenceTaxii +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePoint + + +```yaml +Type: System.String +Parameter Sets: Office365 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SQSURL + + +```yaml +Type: System.String[] +Parameter Sets: AmazonWebServicesS3 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TaxiiLookbackPeriod + + +```yaml +Type: System.String +Parameter Sets: ThreatIntelligenceTaxii +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Teams + + +```yaml +Type: System.String +Parameter Sets: Office365 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +The TenantId. + +```yaml +Type: System.String +Parameter Sets: AADAATP, Dynamics365, MicrosoftCloudAppSecurity, MicrosoftDefenderAdvancedThreatProtection, MicrosoftThreatIntelligence, MicrosoftThreatProtection, Office365, OfficeATP, OfficeIRM, ThreatIntelligence, ThreatIntelligenceTaxii +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Tenant.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigConnectivityCriterion +[Parameter(ParameterSetName = 'APIPolling', Mandatory)] +To construct, see NOTES section for UICONFIGCONNECTIVITYCRITERION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ConnectivityCriteria[] +Parameter Sets: GenericUI +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigCustomImage +[Parameter(ParameterSetName = 'APIPolling')] + +```yaml +Type: System.String +Parameter Sets: GenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigDataType +[Parameter(ParameterSetName = 'APIPolling', Mandatory)] +To construct, see NOTES section for UICONFIGDATATYPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.LastDataReceivedDataType[] +Parameter Sets: GenericUI +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigDescriptionMarkdown +[Parameter(ParameterSetName = 'APIPolling', Mandatory)] + +```yaml +Type: System.String +Parameter Sets: GenericUI +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigGraphQueriesTableName +[Parameter(ParameterSetName = 'APIPolling', Mandatory)] + +```yaml +Type: System.String +Parameter Sets: GenericUI +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigGraphQuery +[Parameter(ParameterSetName = 'APIPolling', Mandatory)] +To construct, see NOTES section for UICONFIGGRAPHQUERY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.GraphQueries[] +Parameter Sets: GenericUI +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigInstructionStep +[Parameter(ParameterSetName = 'APIPolling', Mandatory)] +To construct, see NOTES section for UICONFIGINSTRUCTIONSTEP properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.InstructionSteps[] +Parameter Sets: GenericUI +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigPublisher +[Parameter(ParameterSetName = 'APIPolling', Mandatory)] + +```yaml +Type: System.String +Parameter Sets: GenericUI +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigSampleQuery +[Parameter(ParameterSetName = 'APIPolling', Mandatory)] +To construct, see NOTES section for UICONFIGSAMPLEQUERY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.SampleQueries[] +Parameter Sets: GenericUI +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigTitle +[Parameter(ParameterSetName = 'APIPolling', Mandatory)] + +```yaml +Type: System.String +Parameter Sets: GenericUI +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserName + + +```yaml +Type: System.String +Parameter Sets: ThreatIntelligenceTaxii +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceId + + +```yaml +Type: System.String +Parameter Sets: ThreatIntelligenceTaxii +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.DataConnector + +## 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. + + +`PERMISSIONCUSTOM <PermissionsCustomsItem[]>`: [Parameter(ParameterSetName = 'APIPolling')] + - `[Description <String>]`: Customs permissions description + - `[Name <String>]`: Customs permissions name + +`PERMISSIONRESOURCEPROVIDER <PermissionsResourceProviderItem[]>`: [Parameter(ParameterSetName = 'APIPolling')] + - `[PermissionsDisplayText <String>]`: Permission description text + - `[Provider <ProviderName?>]`: Provider name + - `[ProviderDisplayName <String>]`: Permission provider display name + - `[RequiredPermissionAction <Boolean?>]`: action permission + - `[RequiredPermissionDelete <Boolean?>]`: delete permission + - `[RequiredPermissionRead <Boolean?>]`: read permission + - `[RequiredPermissionWrite <Boolean?>]`: write permission + - `[Scope <PermissionProviderScope?>]`: Permission provider scope + +`UICONFIGCONNECTIVITYCRITERION <ConnectivityCriteria[]>`: [Parameter(ParameterSetName = 'APIPolling', Mandatory)] + - `[Type <ConnectivityType?>]`: type of connectivity + - `[Value <String[]>]`: Queries for checking connectivity + +`UICONFIGDATATYPE <LastDataReceivedDataType[]>`: [Parameter(ParameterSetName = 'APIPolling', Mandatory)] + - `[LastDataReceivedQuery <String>]`: Query for indicate last data received + - `[Name <String>]`: Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder + +`UICONFIGGRAPHQUERY <GraphQueries[]>`: [Parameter(ParameterSetName = 'APIPolling', Mandatory)] + - `[BaseQuery <String>]`: The base query for the graph + - `[Legend <String>]`: The legend for the graph + - `[MetricName <String>]`: the metric that the query is checking + +`UICONFIGINSTRUCTIONSTEP <InstructionSteps[]>`: [Parameter(ParameterSetName = 'APIPolling', Mandatory)] + - `[Description <String>]`: Instruction step description + - `[Instruction <IConnectorInstructionModelBase[]>]`: Instruction step details + - `Type <SettingType>`: The kind of the setting + - `[Parameter <IAny>]`: The parameters for the setting + - `[Title <String>]`: Instruction step title + +`UICONFIGSAMPLEQUERY <SampleQueries[]>`: [Parameter(ParameterSetName = 'APIPolling', Mandatory)] + - `[Description <String>]`: The sample query description + - `[Query <String>]`: the sample query + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/New-AzSentinelEntityQuery.md b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelEntityQuery.md new file mode 100644 index 0000000000..8cd92e2e19 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelEntityQuery.md @@ -0,0 +1,354 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/new-azsentinelentityquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelEntityQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelEntityQuery.md +--- + +# New-AzSentinelEntityQuery + +## SYNOPSIS +Creates or updates the entity query. + +## SYNTAX + +``` +New-AzSentinelEntityQuery -ResourceGroupName <String> -WorkspaceName <String> -Content <String> + -Description <String> -InputEntityType <EntityType> -Kind <EntityQueryKind> -QueryDefinitionQuery <String> + -Title <String> [-Id <String>] [-SubscriptionId <String>] + [-EntitiesFilter <ActivityEntityQueriesPropertiesEntitiesFilter>] [-RequiredInputFieldsSet <String[]>] + [-TemplateName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the entity query. + +## EXAMPLES + +### Example 1: Create Entity Query +```powershell + $template = Get-AzSentinelEntityQueryTemplate -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "myEntityQueryTemplateId" + New-AzSentinelEntityQuery -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Kind Activity -Title ($template.title) -InputEntityType ($template.inputEntityType) -TemplateName ($template.Name) +``` + +```output +Title : The user has created an account +Name : 6d37a904-d199-43ff-892b-53653b784122 +Content : The user InitiatedByAccount has created the account TargetAccount Count time(s) +Description : This activity displays account creation events performed by the user +Enabled : True +Kind : Activity +CreatedTimeUtc : 12/22/2021 11:44:34 AM +LastModifiedTimeUtc : 12/22/2021 11:47:13 AM +``` + +This command creates an Entity Query by using a Template. + +### Example 2: Create Entity Query from cmdlet inputs +```powershell + New-AzSentinelEntityQuery -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id ((New-Guid).Guid) -Kind Activity -Title 'An account was deleted on this host' -InputEntityType 'Host' -Content "On 'SomeCompute' the account 'SomeAccount' was deleted by 'SomeUser'" -Description "Account deleted on host" -QueryDefinitionQuery 'let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has ''@'', tostring(split(Computer, ''@'')[0]),\nComputer has ''\\'', tostring(split(Computer, ''\\'')[1]),\nComputer has ''.'', tostring(split(Computer, ''.'')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has ''\\'', tostring(split(Computer, ''\\'')[0]), \nComputer has ''.'', tostring(split(Computer, ''.'')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has ''\\'', tostring(split(Computer, ''\\'')[0]), \nComputer has ''.'', strcat_array(array_slice(split(Computer,''.''),-2,-1),''.''), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions(''someHost'', ''SomeNTDomain'', ''SomeDNSDomain'', ''SomeID'', ''SomeOMSAgentID'')\n \n| where EventID == 4726' -RequiredInputFieldsSet @(@("Host_HostName","Host_NTDomain"),@("Host_HostName","Host_DnsDomain"),@("Host_AzureID"),@("Host_OMSAgentID")) -EntitiesFilter @{"Host_OsFamily" = @("Windows")} +``` + +This command creates an Entity Query. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Content + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntitiesFilter +To construct, see NOTES section for ENTITIESFILTER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ActivityEntityQueriesPropertiesEntitiesFilter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The Id of the Entity Query. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (New-Guid).Guid +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputEntityType + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.EntityType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the the Entity Query + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.EntityQueryKind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryDefinitionQuery + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredInputFieldsSet + + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateName + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +[Alias('DataConnectionName')] + The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.CustomEntityQuery + +## 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. + + +`ENTITIESFILTER <ActivityEntityQueriesPropertiesEntitiesFilter>`: + - `[(Any) <String[]>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/New-AzSentinelIncident.md b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelIncident.md new file mode 100644 index 0000000000..47d9e1f1b4 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelIncident.md @@ -0,0 +1,476 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/new-azsentinelincident +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelIncident.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelIncident.md +--- + +# New-AzSentinelIncident + +## SYNOPSIS +Creates or updates the incident. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzSentinelIncident -ResourceGroupName <String> -WorkspaceName <String> [-Id <String>] + [-SubscriptionId <String>] [-Classification <IncidentClassification>] [-ClassificationComment <String>] + [-ClassificationReason <IncidentClassificationReason>] [-Description <String>] + [-FirstActivityTimeUtc <DateTime>] [-Label <IIncidentLabel[]>] [-LastActivityTimeUtc <DateTime>] + [-OwnerAssignedTo <String>] [-OwnerEmail <String>] [-OwnerObjectId <String>] + [-OwnerUserPrincipalName <String>] [-ProviderIncidentId <String>] [-ProviderName <String>] + [-Severity <IncidentSeverity>] [-Status <IncidentStatus>] [-Title <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzSentinelIncident -ResourceGroupName <String> -WorkspaceName <String> -Incident <IIncident> + [-Id <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the incident. + +## EXAMPLES + +### Example 1: Create an Incident +```powershell + New-AzSentinelIncident -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id ((New-Guid).Guid) -Title "NewIncident" -Description "My Description" -Severity Low -Status New +``` + +```output +Title : NewIncident +Description : My Description +Severity : Low +Status : New +Number : 779 +CreatedTimeUtc : 2/3/2022 7:47:03 PM +Name : c831b5a7-5644-403f-9dc3-96d651e04c6d +Url : https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/274b1a41-c53c-4092-8d4a-7210f6a44a0c/resourceGroups/cyber-soc/providers/Microsoft.OperationalInsights/workspaces/myworkspace/providers/Microsoft.SecurityInsights/Incidents/c831b5a7-5644-403f-9dc3-96d651e04c6d +``` + +This command creates an Incident. + +## PARAMETERS + +### -Classification +The reason the incident was closed + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.IncidentClassification +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationComment +Describes the reason the incident was closed + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationReason +The classification reason the incident was closed with + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.IncidentClassificationReason +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the incident + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirstActivityTimeUtc +The time of the first activity in the incident + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Incident ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IncidentId + +Required: False +Position: Named +Default value: (New-Guid).Guid +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Incident +Represents an incident in Azure Security Insights. +To construct, see NOTES section for INCIDENT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IIncident +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Label +List of labels relevant to this incident +To construct, see NOTES section for LABEL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IIncidentLabel[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastActivityTimeUtc +The time of the last activity in the incident + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerAssignedTo +The name of the user the incident is assigned to. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerEmail +The email of the user the incident is assigned to. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerObjectId +The object id of the user the incident is assigned to. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerUserPrincipalName +The user principal name of the user the incident is assigned to. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderIncidentId +The incident ID assigned by the incident provider + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderName +The name of the source provider that generated the incident + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity +The severity of the incident + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.IncidentSeverity +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The status of the incident + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.IncidentStatus +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title +The title of the incident + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IIncident + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IIncident + +## 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. + + +`INCIDENT <IIncident>`: Represents an incident in Azure Security Insights. + - `[Etag <String>]`: Etag of the azure resource + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[Classification <IncidentClassification?>]`: The reason the incident was closed + - `[ClassificationComment <String>]`: Describes the reason the incident was closed + - `[ClassificationReason <IncidentClassificationReason?>]`: The classification reason the incident was closed with + - `[Description <String>]`: The description of the incident + - `[FirstActivityTimeUtc <DateTime?>]`: The time of the first activity in the incident + - `[Label <IIncidentLabel[]>]`: List of labels relevant to this incident + - `LabelName <String>`: The name of the label + - `[LastActivityTimeUtc <DateTime?>]`: The time of the last activity in the incident + - `[OwnerAssignedTo <String>]`: The name of the user the incident is assigned to. + - `[OwnerEmail <String>]`: The email of the user the incident is assigned to. + - `[OwnerObjectId <String>]`: The object id of the user the incident is assigned to. + - `[OwnerUserPrincipalName <String>]`: The user principal name of the user the incident is assigned to. + - `[ProviderIncidentId <String>]`: The incident ID assigned by the incident provider + - `[ProviderName <String>]`: The name of the source provider that generated the incident + - `[Severity <IncidentSeverity?>]`: The severity of the incident + - `[Status <IncidentStatus?>]`: The status of the incident + - `[Title <String>]`: The title of the incident + +`LABEL <IIncidentLabel[]>`: List of labels relevant to this incident + - `LabelName <String>`: The name of the label + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/New-AzSentinelIncidentComment.md b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelIncidentComment.md new file mode 100644 index 0000000000..7dbf746814 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelIncidentComment.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/new-azsentinelincidentcomment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelIncidentComment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelIncidentComment.md +--- + +# New-AzSentinelIncidentComment + +## SYNOPSIS +Creates or updates the incident comment. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzSentinelIncidentComment -IncidentId <String> -ResourceGroupName <String> -WorkspaceName <String> + [-Id <String>] [-SubscriptionId <String>] [-Message <String>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzSentinelIncidentComment -IncidentId <String> -ResourceGroupName <String> -WorkspaceName <String> + -IncidentComment <IIncidentComment> [-Id <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the incident comment. + +## EXAMPLES + +### Example 1: Create an Incident Comment +```powershell + New-AzSentinelIncidentComment -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -IncidentId "myIncidentId" -Message "IncidentCommentGoesHere" +``` + +This command creates an Incident Comment. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Incident comment ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IncidentCommentId + +Required: False +Position: Named +Default value: (New-Guid).Guid +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentComment +Represents an incident comment +To construct, see NOTES section for INCIDENTCOMMENT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IIncidentComment +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IncidentId +Incident ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Message +The comment message + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IIncidentComment + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IIncidentComment + +## 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. + + +`INCIDENTCOMMENT <IIncidentComment>`: Represents an incident comment + - `[Etag <String>]`: Etag of the azure resource + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[AuthorEmail <String>]`: The email of the client. + - `[AuthorName <String>]`: The name of the client. + - `[AuthorObjectId <String>]`: The object id of the client. + - `[AuthorUserPrincipalName <String>]`: The user principal name of the client. + - `[Message <String>]`: The comment message + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/New-AzSentinelIncidentRelation.md b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelIncidentRelation.md new file mode 100644 index 0000000000..8ed40ca9ee --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelIncidentRelation.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/new-azsentinelincidentrelation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelIncidentRelation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelIncidentRelation.md +--- + +# New-AzSentinelIncidentRelation + +## SYNOPSIS +Creates or updates the incident relation. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzSentinelIncidentRelation -IncidentId <String> -ResourceGroupName <String> -WorkspaceName <String> + [-RelationName <String>] [-SubscriptionId <String>] [-RelatedResourceId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzSentinelIncidentRelation -IncidentId <String> -ResourceGroupName <String> -WorkspaceName <String> + -Relation <IRelation> [-RelationName <String>] [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the incident relation. + +## EXAMPLES + +### Example 1: Create a Incident Relation +```powershell + $bookmark = Get-AzSentinelBookmark -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id "myBookmarkId" + New-AzSentinelIncidentRelation -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -IncidentId "myIncidentId" -RelationName ((New-Guid).Guid) -RelatedResourceId ($bookmark.Id) +``` + +```output +Name : 4b112bd9-a6b5-44f6-b89d-8bcbf021fbdf +RelatedResourceName : a636a51c-471a-468d-89ed-d7f4b2a7a569 +RelatedResourceKind : +RelatedResourceType : Microsoft.SecurityInsights/Bookmarks +``` + +This command creates a Incident Relation connecting the Bookmark to the Incident. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentId +Incident ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RelatedResourceId +The resource ID of the related resource + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Relation +Represents a relation between two resources +To construct, see NOTES section for RELATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IRelation +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RelationName +Relation Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (New-Guid).Guid +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IRelation + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IRelation + +## 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. + + +`RELATION <IRelation>`: Represents a relation between two resources + - `[Etag <String>]`: Etag of the azure resource + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[RelatedResourceId <String>]`: The resource ID of the related resource + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/New-AzSentinelIncidentTeam.md b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelIncidentTeam.md new file mode 100644 index 0000000000..681bbaf1f7 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelIncidentTeam.md @@ -0,0 +1,266 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/new-azsentinelincidentteam +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelIncidentTeam.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelIncidentTeam.md +--- + +# New-AzSentinelIncidentTeam + +## SYNOPSIS +Creates a Microsoft team to investigate the incident by sharing information and insights between participants. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzSentinelIncidentTeam -IncidentId <String> -ResourceGroupName <String> -WorkspaceName <String> + -TeamName <String> [-SubscriptionId <String>] [-GroupId <String[]>] [-MemberId <String[]>] + [-TeamDescription <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzSentinelIncidentTeam -IncidentId <String> -ResourceGroupName <String> -WorkspaceName <String> + -TeamProperty <ITeamProperties> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a Microsoft team to investigate the incident by sharing information and insights between participants. + +## EXAMPLES + +### Example 1: Create an Incident Teams Room +```powershell + $incident = Get-AzSentinelIncident -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id "myIncidentId" + New-AzSentinelIncidentTeam -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -IncidentId ($incident.Name) -TeamName ("Incident "+$incident.incidentNumber+": "+$incident.title) +``` + +```output +Description : +Name : Incident : NewIncident3 +PrimaryChannelUrl : https://teams.microsoft.com/l/team/19:vYoGjeGlZmTEDmu0gTbrk9T_eDS4pKIkEU7UuM1IyZk1%40thread.tacv2/conversations?groupId=3c637cc5-caf1-46c7-93ac-069c6 + 4b05395&tenantId=8f21ced5-2eff-4f8d-aff1-4dbb4cee8e3d +TeamCreationTimeUtc : 2/4/2022 3:02:03 PM +TeamId : 3c637cc5-caf1-46c7-93ac-069c64b05395 +``` + +This command creates a Teams group for the Incident. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +List of group IDs to add their members to the team + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentId +Incident ID + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberId +List of member IDs to add to the team + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamDescription +The description of the team + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamName +The name of the team + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamProperty +Describes team properties +To construct, see NOTES section for TEAMPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ITeamProperties +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ITeamProperties + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ITeamInformation + +## 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. + + +`TEAMPROPERTY <ITeamProperties>`: Describes team properties + - `TeamName <String>`: The name of the team + - `[GroupId <String[]>]`: List of group IDs to add their members to the team + - `[MemberId <String[]>]`: List of member IDs to add to the team + - `[TeamDescription <String>]`: The description of the team + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/New-AzSentinelOnboardingState.md b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelOnboardingState.md new file mode 100644 index 0000000000..4669e62b11 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/New-AzSentinelOnboardingState.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/new-azsentinelonboardingstate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelOnboardingState.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/New-AzSentinelOnboardingState.md +--- + +# New-AzSentinelOnboardingState + +## SYNOPSIS +Create Sentinel onboarding state + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzSentinelOnboardingState -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-CustomerManagedKey] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Create +``` +New-AzSentinelOnboardingState -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + -SentinelOnboardingStateParameter <ISentinelOnboardingState> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create Sentinel onboarding state + +## EXAMPLES + +### Example 1: Add Sentinel onboarding state +```powershell +New-AzSentinelOnboardingState -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -Name "default" +``` + +This command configures the onboarding state of Sentinel + +## PARAMETERS + +### -CustomerManagedKey +Flag that indicates the status of the CMK setting + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Sentinel onboarding state name. +Supports - default + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SentinelOnboardingStateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentinelOnboardingStateParameter +Sentinel onboarding state +To construct, see NOTES section for SENTINELONBOARDINGSTATEPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ISentinelOnboardingState +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ISentinelOnboardingState + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ISentinelOnboardingState + +## 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. + + +`SENTINELONBOARDINGSTATEPARAMETER <ISentinelOnboardingState>`: Sentinel onboarding state + - `[Etag <String>]`: Etag of the azure resource + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[CustomerManagedKey <Boolean?>]`: Flag that indicates the status of the CMK setting + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelAlertRule.md b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelAlertRule.md new file mode 100644 index 0000000000..19ea1268fe --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelAlertRule.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/remove-azsentinelalertrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelAlertRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelAlertRule.md +--- + +# Remove-AzSentinelAlertRule + +## SYNOPSIS +Delete the alert rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSentinelAlertRule -ResourceGroupName <String> -RuleId <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSentinelAlertRule -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the alert rule. + +## EXAMPLES + +### Example 1: Remove an alert rule +```powershell +Remove-AzSentinelAlertRule -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -RuleId 4a21e485-75ae-48b3-a7b9-e6a92bcfe434 +``` + +The command removes a Sentinel alert rule + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Alert rule ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelAlertRuleAction.md b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelAlertRuleAction.md new file mode 100644 index 0000000000..9f02ccdabd --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelAlertRuleAction.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/remove-azsentinelalertruleaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelAlertRuleAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelAlertRuleAction.md +--- + +# Remove-AzSentinelAlertRuleAction + +## SYNOPSIS +Delete the action of alert rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSentinelAlertRuleAction -Id <String> -ResourceGroupName <String> -RuleId <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSentinelAlertRuleAction -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the action of alert rule. + +## EXAMPLES + +### Example 1: Removes an alert rule action +```powershell +Remove-AzSentinelAlertRuleAction -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -RuleId "29d2523f-84ce-42d3-b5f1-9e63c85aaed1" -Id "1a33301b-fb83-416a-8d58-3873c7c2dc86" +``` + +This command removes an alert rule action. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Action ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ActionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Alert rule ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelAutomationRule.md b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelAutomationRule.md new file mode 100644 index 0000000000..934f2de818 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelAutomationRule.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/remove-azsentinelautomationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelAutomationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelAutomationRule.md +--- + +# Remove-AzSentinelAutomationRule + +## SYNOPSIS +Delete the automation rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSentinelAutomationRule -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSentinelAutomationRule -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the automation rule. + +## EXAMPLES + +### Example 1: Removes a Sentinel automation rule +```powershell +Remove-AzSentinelAutomationRule -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -Id 2f32af32-ad13-4fbb-9fbc-e19e0e7ff767 +``` + +This command removes a Sentinel automation rule + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Automation rule ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AutomationRuleId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelBookmark.md b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelBookmark.md new file mode 100644 index 0000000000..f531bd45b1 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelBookmark.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/remove-azsentinelbookmark +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelBookmark.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelBookmark.md +--- + +# Remove-AzSentinelBookmark + +## SYNOPSIS +Delete the bookmark. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSentinelBookmark -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSentinelBookmark -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the bookmark. + +## EXAMPLES + +### Example 1: Remove a Sentinel Bookmark +```powershell +Remove-AzSentinelBookmark -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id <bookMarkId> +``` + +This command removes a bookmark + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Bookmark ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: BookmarkId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelBookmarkRelation.md b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelBookmarkRelation.md new file mode 100644 index 0000000000..f05c0769e2 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelBookmarkRelation.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/remove-azsentinelbookmarkrelation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelBookmarkRelation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelBookmarkRelation.md +--- + +# Remove-AzSentinelBookmarkRelation + +## SYNOPSIS +Delete the bookmark relation. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSentinelBookmarkRelation -BookmarkId <String> -RelationName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSentinelBookmarkRelation -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the bookmark relation. + +## EXAMPLES + +### Example 1: Remove a bookmark relation +```powershell + Remove-AzSentinelBookmarkRelation -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -BookmarkId 83846045-d8dc-4d6b-abbe-7588219c474e -RelationName 7cc984fe-61a2-43c2-a1a4-3583c8a89da2 +``` + +This command removes a bookmarkrelation + +## PARAMETERS + +### -BookmarkId +Bookmark ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RelationName +Relation Name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelDataConnector.md b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelDataConnector.md new file mode 100644 index 0000000000..e18e7eb296 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelDataConnector.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/remove-azsentineldataconnector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelDataConnector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelDataConnector.md +--- + +# Remove-AzSentinelDataConnector + +## SYNOPSIS +Delete the data connector. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the data connector. + +## EXAMPLES + +### Example 1: Removes Sentinel Data Connector +```powershell +Remove-AzSentinelDataConnector -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id 661b961f-53d8-4bd1-be97-24e808fd04f5 +``` + +This command removes a data connector. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Connector ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DataConnectorId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelEntityQuery.md b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelEntityQuery.md new file mode 100644 index 0000000000..87f53732a9 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelEntityQuery.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/remove-azsentinelentityquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelEntityQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelEntityQuery.md +--- + +# Remove-AzSentinelEntityQuery + +## SYNOPSIS +Delete the entity query. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSentinelEntityQuery -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSentinelEntityQuery -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the entity query. + +## EXAMPLES + +### Example 1: Remove Entity Query +```powershell + Remove-AzSentinelEntityQuery -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "myEntityQueryTemplateId" +``` + +This command removes a specific entity query based on the entity query Id + +### Example 2: Remove an Entity Query based on the title +```powershell + $queryTemplateId = Get-AzSentinelEntityQueryTemplate -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" | Where-Object {$_.Title -eq "The user has created an account"} +Remove-AzSentinelEntityQuery -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id $queryTemplateId.Name +``` + +This command removes a specific entity query based on the title + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +entity query ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: EntityQueryId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelIncident.md b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelIncident.md new file mode 100644 index 0000000000..8340423400 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelIncident.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/remove-azsentinelincident +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelIncident.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelIncident.md +--- + +# Remove-AzSentinelIncident + +## SYNOPSIS +Delete the incident. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSentinelIncident -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSentinelIncident -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the incident. + +## EXAMPLES + +### Example 1: Removes an incident based on the incident Id +```powershell +Remove-AzSentinelIncident -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id <IncidentId> +``` + +This command removes an incident based on the incident id. + +### Example 2: Removes an incident based on the incident number +```powershell +$myIncident = Get-AzSentinelIncident -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id <IncidentId> | Where-Object {$_.Number -eq "780"} +``` + +The command removes an incident based on an incident number. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Incident ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: IncidentId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelIncidentComment.md b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelIncidentComment.md new file mode 100644 index 0000000000..632435c4ce --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelIncidentComment.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/remove-azsentinelincidentcomment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelIncidentComment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelIncidentComment.md +--- + +# Remove-AzSentinelIncidentComment + +## SYNOPSIS +Delete the incident comment. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSentinelIncidentComment -Id <String> -IncidentId <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSentinelIncidentComment -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the incident comment. + +## EXAMPLES + +### Example 1: Remove an incident comment +```powershell +Remove-AzSentinelIncidentComment -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -IncidentId 7cc984fe-61a2-43c2-a1a4-3583c8a89da2 -Id 7a4c27ea-d61a-496b-b5c3-246770c857c1 +``` + +This command removes an incident comment + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Incident comment ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: IncidentCommentId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentId +Incident ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelIncidentRelation.md b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelIncidentRelation.md new file mode 100644 index 0000000000..3489ed2f83 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelIncidentRelation.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/remove-azsentinelincidentrelation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelIncidentRelation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelIncidentRelation.md +--- + +# Remove-AzSentinelIncidentRelation + +## SYNOPSIS +Delete the incident relation. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSentinelIncidentRelation -IncidentId <String> -RelationName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSentinelIncidentRelation -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the incident relation. + +## EXAMPLES + +### Example 1: Removes the incident relation +```powershell +Remove-AzSentinelIncidentRelation -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -IncidentId "7cc984fe-61a2-43c2-a1a4-3583c8a89da2" -RelationName "7cc984fe-61a2-43c2-a1a4-3583c8a89db4" +``` + +This command removes the incident relation + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentId +Incident ID + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RelationName +Relation Name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelOnboardingState.md b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelOnboardingState.md new file mode 100644 index 0000000000..95bd49e2f0 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Remove-AzSentinelOnboardingState.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/remove-azsentinelonboardingstate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelOnboardingState.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Remove-AzSentinelOnboardingState.md +--- + +# Remove-AzSentinelOnboardingState + +## SYNOPSIS +Delete Sentinel onboarding state + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSentinelOnboardingState -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSentinelOnboardingState -InputObject <ISecurityInsightsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete Sentinel onboarding state + +## EXAMPLES + +### Example 1: Remove the Sentinel onboarding state +```powershell +Remove-AzSentinelOnboardingState -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -Name "default" +``` + +This commands removes the Sentinel onboarding state + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Sentinel onboarding state name. +Supports - default + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SentinelOnboardingStateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Test-AzSentinelDataConnectorCheckRequirement.md b/azps-10.1.0/Az.SecurityInsights/Test-AzSentinelDataConnectorCheckRequirement.md new file mode 100644 index 0000000000..8edd5a2ee8 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Test-AzSentinelDataConnectorCheckRequirement.md @@ -0,0 +1,230 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/test-azsentineldataconnectorcheckrequirement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Test-AzSentinelDataConnectorCheckRequirement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Test-AzSentinelDataConnectorCheckRequirement.md +--- + +# Test-AzSentinelDataConnectorCheckRequirement + +## SYNOPSIS +Get requirements state for a data connector type. + +## SYNTAX + +### AADTenant (Default) +``` +Test-AzSentinelDataConnectorCheckRequirement -ResourceGroupName <String> -WorkspaceName <String> + -Kind <DataConnectorKind> [-SubscriptionId <String>] [-TenantId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### AzureSecurityCenter +``` +Test-AzSentinelDataConnectorCheckRequirement -ResourceGroupName <String> -WorkspaceName <String> + -ASCSubscriptionId <String> -Kind <DataConnectorKind> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Get requirements state for a data connector type. + +## EXAMPLES + +### Example 1: Test data connector check requirement +```powershell +Test-AzSentinelDataConnectorCheckRequirement -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -Kind "APIPolling" +``` + +Test data connector check requirement + +## PARAMETERS + +### -ASCSubscriptionId +ASC Subscription Id. + +```yaml +Type: System.String +Parameter Sets: AzureSecurityCenter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +[Parameter(ParameterSetName = 'AmazonWebServicesCloudTrail', Mandatory)] +[Parameter(ParameterSetName = 'AmazonWebServicesS3', Mandatory)] +[Parameter(ParameterSetName = 'GenericUI', Mandatory)] + The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the the data connection + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.DataConnectorKind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +The TenantId. + +```yaml +Type: System.String +Parameter Sets: AADTenant +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Tenant.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +[Alias('DataConnectionName')] + The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.DataConnectorsCheckRequirements + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelAlertRule.md b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelAlertRule.md new file mode 100644 index 0000000000..bba5815677 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelAlertRule.md @@ -0,0 +1,864 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/Update-azsentinelalertrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelAlertRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelAlertRule.md +--- + +# Update-AzSentinelAlertRule + +## SYNOPSIS +Updates the alert rule. + +## SYNTAX + +### UpdateScheduled (Default) +``` +Update-AzSentinelAlertRule -ResourceGroupName <String> -RuleId <String> -WorkspaceName <String> -Scheduled + [-SubscriptionId <String>] [-AlertDescriptionFormat <String>] [-AlertDisplayNameFormat <String>] + [-AlertRuleTemplateName <String>] [-AlertSeverityColumnName <String>] [-AlertTacticsColumnName <String>] + [-CreateIncident] [-Description <String>] [-Disabled] [-DisplayName <String>] [-Enabled] + [-EntityMapping <EntityMapping>] [-EventGroupingSettingAggregationKind <EventGroupingAggregationKind>] + [-GroupByAlertDetail <AlertDetail>] [-GroupByCustomDetail <String[]>] [-GroupByEntity <EntityMappingType>] + [-GroupingConfigurationEnabled] [-LookbackDuration <TimeSpan>] [-MatchingMethod <String>] [-Query <String>] + [-QueryFrequency <TimeSpan>] [-QueryPeriod <TimeSpan>] [-ReOpenClosedIncident] [-Severity <AlertSeverity>] + [-SuppressionDuration <TimeSpan>] [-SuppressionEnabled] [-Tactic <AttackTactic>] + [-TriggerOperator <TriggerOperator>] [-TriggerThreshold <Int32>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateFusionMLTI +``` +Update-AzSentinelAlertRule -ResourceGroupName <String> -RuleId <String> -WorkspaceName <String> -FusionMLorTI + [-SubscriptionId <String>] [-AlertRuleTemplateName <String>] [-Disabled] [-Enabled] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateMicrosoftSecurityIncidentCreation +``` +Update-AzSentinelAlertRule -ResourceGroupName <String> -RuleId <String> -WorkspaceName <String> + -MicrosoftSecurityIncidentCreation [-SubscriptionId <String>] [-AlertRuleTemplateName <String>] + [-Description <String>] [-Disabled] [-DisplayNamesExcludeFilter <String>] [-DisplayNamesFilter <String>] + [-Enabled] [-ProductFilter <MicrosoftSecurityProductName>] [-SeveritiesFilter <AlertSeverity[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateNRT +``` +Update-AzSentinelAlertRule -ResourceGroupName <String> -RuleId <String> -WorkspaceName <String> -NRT + [-SubscriptionId <String>] [-AlertDescriptionFormat <String>] [-AlertDisplayNameFormat <String>] + [-AlertRuleTemplateName <String>] [-AlertSeverityColumnName <String>] [-AlertTacticsColumnName <String>] + [-CreateIncident] [-Description <String>] [-Disabled] [-DisplayName <String>] [-Enabled] + [-EntityMapping <EntityMapping>] [-GroupByAlertDetail <AlertDetail>] [-GroupByCustomDetail <String[]>] + [-GroupByEntity <EntityMappingType>] [-GroupingConfigurationEnabled] [-LookbackDuration <TimeSpan>] + [-MatchingMethod <String>] [-Query <String>] [-ReOpenClosedIncident] [-Severity <AlertSeverity>] + [-SuppressionDuration <TimeSpan>] [-SuppressionEnabled] [-Tactic <AttackTactic>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityFusionMLTI +``` +Update-AzSentinelAlertRule -InputObject <ISecurityInsightsIdentity> -FusionMLorTI + [-AlertRuleTemplateName <String>] [-Disabled] [-Enabled] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityMicrosoftSecurityIncidentCreation +``` +Update-AzSentinelAlertRule -InputObject <ISecurityInsightsIdentity> -MicrosoftSecurityIncidentCreation + [-AlertRuleTemplateName <String>] [-Description <String>] [-Disabled] [-DisplayNamesExcludeFilter <String>] + [-DisplayNamesFilter <String>] [-Enabled] [-ProductFilter <MicrosoftSecurityProductName>] + [-SeveritiesFilter <AlertSeverity[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityNRT +``` +Update-AzSentinelAlertRule -InputObject <ISecurityInsightsIdentity> -NRT [-AlertDescriptionFormat <String>] + [-AlertDisplayNameFormat <String>] [-AlertRuleTemplateName <String>] [-AlertSeverityColumnName <String>] + [-AlertTacticsColumnName <String>] [-CreateIncident] [-Description <String>] [-Disabled] + [-DisplayName <String>] [-Enabled] [-EntityMapping <EntityMapping>] [-GroupByAlertDetail <AlertDetail>] + [-GroupByCustomDetail <String[]>] [-GroupByEntity <EntityMappingType>] [-GroupingConfigurationEnabled] + [-LookbackDuration <TimeSpan>] [-MatchingMethod <String>] [-Query <String>] [-ReOpenClosedIncident] + [-Severity <AlertSeverity>] [-SuppressionDuration <TimeSpan>] [-SuppressionEnabled] [-Tactic <AttackTactic>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityUpdateScheduled +``` +Update-AzSentinelAlertRule -InputObject <ISecurityInsightsIdentity> -Scheduled + [-AlertDescriptionFormat <String>] [-AlertDisplayNameFormat <String>] [-AlertRuleTemplateName <String>] + [-AlertSeverityColumnName <String>] [-AlertTacticsColumnName <String>] [-CreateIncident] + [-Description <String>] [-Disabled] [-DisplayName <String>] [-Enabled] [-EntityMapping <EntityMapping>] + [-EventGroupingSettingAggregationKind <EventGroupingAggregationKind>] [-GroupByAlertDetail <AlertDetail>] + [-GroupByCustomDetail <String[]>] [-GroupByEntity <EntityMappingType>] [-GroupingConfigurationEnabled] + [-LookbackDuration <TimeSpan>] [-MatchingMethod <String>] [-Query <String>] [-QueryFrequency <TimeSpan>] + [-QueryPeriod <TimeSpan>] [-ReOpenClosedIncident] [-Severity <AlertSeverity>] + [-SuppressionDuration <TimeSpan>] [-SuppressionEnabled] [-Tactic <AttackTactic>] + [-TriggerOperator <TriggerOperator>] [-TriggerThreshold <Int32>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the alert rule. + +## EXAMPLES + +### Example 1: Update an scheduled alert rule +```powershell +Update-AzSentinelAlertRule -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -ruleId "4a21e485-75ae-48b3-a7b9-e6a92bcfe434" -Query "SecurityAlert | take 2" +``` + +This command updates a scheduled alert rule + +## PARAMETERS + +### -AlertDescriptionFormat + + +```yaml +Type: System.String +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertDisplayNameFormat + + +```yaml +Type: System.String +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertRuleTemplateName + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertSeverityColumnName + + +```yaml +Type: System.String +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlertTacticsColumnName + + +```yaml +Type: System.String +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateIncident + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + + +```yaml +Type: System.String +Parameter Sets: UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled, UpdateViaIdentityMicrosoftSecurityIncidentCreation, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName + + +```yaml +Type: System.String +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayNamesExcludeFilter + + +```yaml +Type: System.String +Parameter Sets: UpdateMicrosoftSecurityIncidentCreation, UpdateViaIdentityMicrosoftSecurityIncidentCreation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayNamesFilter + + +```yaml +Type: System.String +Parameter Sets: UpdateMicrosoftSecurityIncidentCreation, UpdateViaIdentityMicrosoftSecurityIncidentCreation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityMapping +'Account', 'Host', 'IP', 'Malware', 'File', 'Process', 'CloudApplication', 'DNS', 'AzureResource', 'FileHash', 'RegistryKey', 'RegistryValue', 'SecurityGroup', 'URL', 'Mailbox', 'MailCluster', 'MailMessage', 'SubmissionMail' +To construct, see NOTES section for ENTITYMAPPING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.EntityMapping +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventGroupingSettingAggregationKind + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.EventGroupingAggregationKind +Parameter Sets: UpdateScheduled, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FusionMLorTI + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateFusionMLTI, UpdateViaIdentityFusionMLTI +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByAlertDetail + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.AlertDetail +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByCustomDetail + + +```yaml +Type: System.String[] +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupByEntity + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.EntityMappingType +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupingConfigurationEnabled + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +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.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: UpdateViaIdentityFusionMLTI, UpdateViaIdentityMicrosoftSecurityIncidentCreation, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LookbackDuration + + +```yaml +Type: System.TimeSpan +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: New-TimeSpan -Hours 5 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchingMethod + + +```yaml +Type: System.String +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: "AllEntities" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftSecurityIncidentCreation + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateMicrosoftSecurityIncidentCreation, UpdateViaIdentityMicrosoftSecurityIncidentCreation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NRT + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateNRT, UpdateViaIdentityNRT +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProductFilter + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.MicrosoftSecurityProductName +Parameter Sets: UpdateMicrosoftSecurityIncidentCreation, UpdateViaIdentityMicrosoftSecurityIncidentCreation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query + + +```yaml +Type: System.String +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryFrequency + + +```yaml +Type: System.TimeSpan +Parameter Sets: UpdateScheduled, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryPeriod + + +```yaml +Type: System.TimeSpan +Parameter Sets: UpdateScheduled, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReOpenClosedIncident + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +[Alias('RuleId')] + The name of Operational Insights Resource Provider. + +```yaml +Type: System.String +Parameter Sets: UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scheduled + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateScheduled, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SeveritiesFilter +High, Medium, Low, Informational + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.AlertSeverity[] +Parameter Sets: UpdateMicrosoftSecurityIncidentCreation, UpdateViaIdentityMicrosoftSecurityIncidentCreation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.AlertSeverity +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuppressionDuration + + +```yaml +Type: System.TimeSpan +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: New-TimeSpan -Hours 5 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuppressionEnabled + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tactic + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.AttackTactic +Parameter Sets: UpdateNRT, UpdateScheduled, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerOperator + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.TriggerOperator +Parameter Sets: UpdateScheduled, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerThreshold + + +```yaml +Type: System.Int32 +Parameter Sets: UpdateScheduled, UpdateViaIdentityUpdateScheduled +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.AlertRule + +## 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. + + +`ENTITYMAPPING <EntityMapping>`: 'Account', 'Host', 'IP', 'Malware', 'File', 'Process', 'CloudApplication', 'DNS', 'AzureResource', 'FileHash', 'RegistryKey', 'RegistryValue', 'SecurityGroup', 'URL', 'Mailbox', 'MailCluster', 'MailMessage', 'SubmissionMail' + - `[EntityType <EntityMappingType?>]`: The V3 type of the mapped entity + - `[FieldMapping <IFieldMapping[]>]`: array of field mappings for the given entity mapping + - `[ColumnName <String>]`: the column name to be mapped to the identifier + - `[Identifier <String>]`: the V3 identifier of the entity + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelAlertRuleAction.md b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelAlertRuleAction.md new file mode 100644 index 0000000000..be0e1d8ebb --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelAlertRuleAction.md @@ -0,0 +1,260 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/update-azsentinelalertruleaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelAlertRuleAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelAlertRuleAction.md +--- + +# Update-AzSentinelAlertRuleAction + +## SYNOPSIS +Creates or updates the action of alert rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSentinelAlertRuleAction -Id <String> -ResourceGroupName <String> -RuleId <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-LogicAppResourceId <String>] [-TriggerUri <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSentinelAlertRuleAction -InputObject <ISecurityInsightsIdentity> [-LogicAppResourceId <String>] + [-TriggerUri <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the action of alert rule. + +## EXAMPLES + +### Example 1: Updates an alert rule action +```powershell +$LogicAppResourceId = Get-AzLogicApp -ResourceGroupName "myLogicAppResourceGroupName" -Name "myLogicAppPlaybookName" +$LogicAppTriggerUri = Get-AzLogicAppTriggerCallbackUrl -ResourceGroupName "myLogicAppResourceGroupName" -Name $LogicAppResourceId.Name -TriggerName "When_a_response_to_an_Azure_Sentinel_alert_is_triggered" +Update-AzSentinelAlertRuleAction -ResourceGroupName "mySentinelResourceGroupName" -workspaceName "myWorkspaceName" -RuleId "48bbf86d-540b-4a7b-9fee-2bd7d810dbed" -LogicAppResourceId ($LogicAppResourceId.Id) -TriggerUri ($LogicAppTriggerUri.Value) -Id ((New-Guid).Guid) +``` + +This command updates an alert rule action + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Action ID + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ActionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LogicAppResourceId +Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Alert rule ID + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerUri +Logic App Callback URL for this specific workflow. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IActionResponse + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelAutomationRule.md b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelAutomationRule.md new file mode 100644 index 0000000000..3a74cb37f7 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelAutomationRule.md @@ -0,0 +1,317 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/update-azsentinelautomationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelAutomationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelAutomationRule.md +--- + +# Update-AzSentinelAutomationRule + +## SYNOPSIS +Creates or updates the automation rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSentinelAutomationRule -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-Action <IAutomationRuleAction[]>] [-DisplayName <String>] [-Order <Int32>] + [-TriggeringLogicCondition <IAutomationRuleCondition[]>] [-TriggeringLogicExpirationTimeUtc <DateTime>] + [-TriggeringLogicIsEnabled] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSentinelAutomationRule -InputObject <ISecurityInsightsIdentity> [-Action <IAutomationRuleAction[]>] + [-DisplayName <String>] [-Order <Int32>] [-TriggeringLogicCondition <IAutomationRuleCondition[]>] + [-TriggeringLogicExpirationTimeUtc <DateTime>] [-TriggeringLogicIsEnabled] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the automation rule. + +## EXAMPLES + +### Example 1: Updates an automation rule +```powershell + $LogicAppResourceId = Get-AzLogicApp -ResourceGroupName "myResourceGroup" -Name "Reset-AADPassword" + $automationRuleAction = [Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.AutomationRuleRunPlaybookAction]::new() + $automationRuleAction.Order = 1 + $automationRuleAction.ActionType = "RunPlaybook" + $automationRuleAction.ActionConfigurationLogicAppResourceId = ($LogicAppResourceId.Id) + $automationRuleAction.ActionConfigurationTenantId = (Get-AzContext).Tenant.Id + Update-AzSentinelAutomationRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id ((New-Guid).Guid) -Action $automationRuleAction -DisplayName "Run Playbook to reset AAD password" -Order 2 -TriggeringLogicIsEnabled +``` + +This command updates an automation rule + +## PARAMETERS + +### -Action +The actions to execute when the automation rule is triggered +To construct, see NOTES section for ACTION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IAutomationRuleAction[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name of the automation rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Automation rule ID + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: AutomationRuleId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Order +The order of execution of the automation rule + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggeringLogicCondition +The conditions to evaluate to determine if the automation rule should be triggered on a given object + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IAutomationRuleCondition[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggeringLogicExpirationTimeUtc +Determines when the automation rule should automatically expire and be disabled. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggeringLogicIsEnabled +Determines whether the automation rule is enabled or disabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IAutomationRule + +## 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. + + +`ACTION <IAutomationRuleAction[]>`: The actions to execute when the automation rule is triggered + - `ActionType <AutomationRuleActionType>`: The type of the automation rule action + - `Order <Int32>`: The order of execution of the automation rule action + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelBookmark.md b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelBookmark.md new file mode 100644 index 0000000000..fd4f8ba61b --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelBookmark.md @@ -0,0 +1,400 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/update-azsentinelbookmark +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelBookmark.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelBookmark.md +--- + +# Update-AzSentinelBookmark + +## SYNOPSIS +Creates or updates the bookmark. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSentinelBookmark -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DisplayName <String>] [-EventTime <DateTime>] [-IncidentInfoIncidentId <String>] + [-IncidentInfoRelationName <String>] [-IncidentInfoSeverity <IncidentSeverity>] [-IncidentInfoTitle <String>] + [-Label <String[]>] [-Note <String>] [-Query <String>] [-QueryEndTime <DateTime>] [-QueryResult <String>] + [-QueryStartTime <DateTime>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSentinelBookmark -InputObject <ISecurityInsightsIdentity> [-DisplayName <String>] + [-EventTime <DateTime>] [-IncidentInfoIncidentId <String>] [-IncidentInfoRelationName <String>] + [-IncidentInfoSeverity <IncidentSeverity>] [-IncidentInfoTitle <String>] [-Label <String[]>] [-Note <String>] + [-Query <String>] [-QueryEndTime <DateTime>] [-QueryResult <String>] [-QueryStartTime <DateTime>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the bookmark. + +## EXAMPLES + +### Example 1: Update Sentinel Bookmark +```powershell + $queryStartTime = (Get-Date).AddDays(-1).ToUniversalTime() | Get-Date -Format "yyyy-MM-ddThh:00:00.000Z" + $queryEndTime = (Get-Date).ToUniversalTime() | Get-Date -Format "yyyy-MM-ddThh:00:00.000Z" + Update-AzSentinelBookmark -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id ((New-Guid).Guid) -DisplayName "Incident Evidence" -Query "SecurityEvent | take 1" -QueryStartTime $queryStartTime -QueryEndTime $queryEndTime -EventTime $queryEndTime +``` + +This command updates a bookmark + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name of the bookmark + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventTime +The bookmark event time + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Bookmark ID + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: BookmarkId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentInfoIncidentId +Incident Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentInfoRelationName +Relation Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentInfoSeverity +The severity of the incident + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.IncidentSeverity +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentInfoTitle +The title of the incident + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Label +List of labels relevant to this bookmark + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +The notes of the bookmark + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +The query of the bookmark. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryEndTime +The end time for the query + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryResult +The query result of the bookmark. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryStartTime +The start time for the query + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IBookmark + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelBookmarkRelation.md b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelBookmarkRelation.md new file mode 100644 index 0000000000..69974fba39 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelBookmarkRelation.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/update-azsentinelbookmarkrelation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelBookmarkRelation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelBookmarkRelation.md +--- + +# Update-AzSentinelBookmarkRelation + +## SYNOPSIS +Creates the bookmark relation. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSentinelBookmarkRelation -BookmarkId <String> -RelationName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-RelatedResourceId <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSentinelBookmarkRelation -InputObject <ISecurityInsightsIdentity> [-RelatedResourceId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates the bookmark relation. + +## EXAMPLES + +### Example 1: Update a Bookmark relation +```powershell +Update-AzSentinelBookmarkRelation -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -BookmarkId 6a8d6ea6-04d5-49d7-8169-ffca8b0ced59 -RelationName f185b6f8-1a0d-43eb-97de-67720839ac67 -RelatedResourceId f185b6f8-1a0d-43eb-97de-67720839ac67 +``` + +This command updates a bookmark relation + +## PARAMETERS + +### -BookmarkId +Bookmark ID + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RelatedResourceId +The resource ID of the related resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RelationName +Relation Name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IRelation + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelDataConnector.md b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelDataConnector.md new file mode 100644 index 0000000000..1e32adca65 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelDataConnector.md @@ -0,0 +1,1318 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/update-azsentineldataconnector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelDataConnector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelDataConnector.md +--- + +# Update-AzSentinelDataConnector + +## SYNOPSIS +Updates the data connector. + +## SYNTAX + +### UpdateAADAATP (Default) +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> -AzureADorAATP + [-SubscriptionId <String>] [-Alerts <String>] [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateAmazonWebServicesCloudTrail +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> -AWSCloudTrail + [-SubscriptionId <String>] [-AWSRoleArn <String>] [-Log <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateAmazonWebServicesS3 +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> -AWSS3 + [-SubscriptionId <String>] [-AWSRoleArn <String>] [-DetinationTable <String>] [-Log <String>] + [-SQSURL <String[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateAzureSecurityCenter +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + -AzureSecurityCenter [-SubscriptionId <String>] [-Alerts <String>] [-ASCSubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateDynamics365 +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> -Dynamics365 + [-SubscriptionId <String>] [-CommonDataServiceActivity <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateGenericUI +``` +Update-AzSentinelDataConnector [-AvailabilityIsPreview <Boolean>] [-AvailabilityStatus <Int32>] + [-PermissionCustom <PermissionsCustomsItem[]>] + [-PermissionResourceProvider <PermissionsResourceProviderItem[]>] + [-UiConfigConnectivityCriterion <ConnectivityCriteria[]>] [-UiConfigCustomImage <String>] + [-UiConfigDataType <LastDataReceivedDataType[]>] [-UiConfigDescriptionMarkdown <String>] + [-UiConfigGraphQueriesTableName <String>] [-UiConfigGraphQuery <GraphQueries[]>] + [-UiConfigInstructionStep <InstructionSteps[]>] [-UiConfigPublisher <String>] + [-UiConfigSampleQuery <SampleQueries[]>] [-UiConfigTitle <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateMicrosoftCloudAppSecurity +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + -CloudAppSecurity [-SubscriptionId <String>] [-Alerts <String>] [-DiscoveryLog <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateMicrosoftDefenderAdvancedThreatProtection +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> -DefenderATP + [-SubscriptionId <String>] [-Alerts <String>] [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateMicrosoftThreatIntelligence +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> -MicrosoftTI + [-SubscriptionId <String>] [-BingSafetyPhishingUrlLookbackPeriod <String>] [-BingSafetyPhishinURL <String>] + [-MicrosoftEmergingThreatFeed <String>] [-MicrosoftEmergingThreatFeedLookbackPeriod <String>] + [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateMicrosoftThreatProtection +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + -MicrosoftThreatProtection [-SubscriptionId <String>] [-Incident <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateOffice365 +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> -Office365 + [-SubscriptionId <String>] [-Exchange <String>] [-SharePoint <String>] [-Teams <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateOfficeATP +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> -OfficeATP + [-SubscriptionId <String>] [-Alerts <String>] [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateOfficeIRM +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> -OfficeIRM + [-SubscriptionId <String>] [-Alerts <String>] [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateThreatIntelligence +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + -ThreatIntelligence [-SubscriptionId <String>] [-Indicator <String>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateThreatIntelligenceTaxii +``` +Update-AzSentinelDataConnector -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + -APIRootURL <String> -ThreatIntelligenceTaxii [-SubscriptionId <String>] [-CollectionId <String>] + [-FriendlyName <String>] [-Password <String>] [-PollingFrequency <PollingFrequency>] + [-TaxiiLookbackPeriod <String>] [-TenantId <String>] [-UserName <String>] [-WorkspaceId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityAADAATP +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -AzureADorAATP [-Alerts <String>] + [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityAmazonWebServicesCloudTrail +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -AWSCloudTrail [-AWSRoleArn <String>] + [-Log <String>] [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityAmazonWebServicesS3 +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -AWSS3 [-AWSRoleArn <String>] + [-DetinationTable <String>] [-Log <String>] [-SQSURL <String[]>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityAzureSecurityCenter +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -AzureSecurityCenter + [-Alerts <String>] [-ASCSubscriptionId <String>] [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityDynamics365 +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -Dynamics365 + [-CommonDataServiceActivity <String>] [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityGenericUI +``` +Update-AzSentinelDataConnector [-AvailabilityIsPreview <Boolean>] [-AvailabilityStatus <Int32>] + [-PermissionCustom <PermissionsCustomsItem[]>] + [-PermissionResourceProvider <PermissionsResourceProviderItem[]>] + [-UiConfigConnectivityCriterion <ConnectivityCriteria[]>] [-UiConfigCustomImage <String>] + [-UiConfigDataType <LastDataReceivedDataType[]>] [-UiConfigDescriptionMarkdown <String>] + [-UiConfigGraphQueriesTableName <String>] [-UiConfigGraphQuery <GraphQueries[]>] + [-UiConfigInstructionStep <InstructionSteps[]>] [-UiConfigPublisher <String>] + [-UiConfigSampleQuery <SampleQueries[]>] [-UiConfigTitle <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityMicrosoftCloudAppSecurity +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -CloudAppSecurity [-Alerts <String>] + [-DiscoveryLog <String>] [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityMicrosoftDefenderAdvancedThreatProtection +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -DefenderATP [-Alerts <String>] + [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityMicrosoftThreatIntelligence +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -MicrosoftTI + [-BingSafetyPhishingUrlLookbackPeriod <String>] [-BingSafetyPhishinURL <String>] + [-MicrosoftEmergingThreatFeed <String>] [-MicrosoftEmergingThreatFeedLookbackPeriod <String>] + [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityMicrosoftThreatProtection +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -MicrosoftThreatProtection + [-Incident <String>] [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityOffice365 +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -Office365 [-Exchange <String>] + [-SharePoint <String>] [-Teams <String>] [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityOfficeATP +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -OfficeATP [-Alerts <String>] + [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityOfficeIRM +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -OfficeIRM [-Alerts <String>] + [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityThreatIntelligence +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -ThreatIntelligence + [-Indicator <String>] [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityThreatIntelligenceTaxii +``` +Update-AzSentinelDataConnector -InputObject <ISecurityInsightsIdentity> -ThreatIntelligenceTaxii + [-CollectionId <String>] [-FriendlyName <String>] [-Password <String>] [-PollingFrequency <PollingFrequency>] + [-TaxiiLookbackPeriod <String>] [-TenantId <String>] [-UserName <String>] [-WorkspaceId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the data connector. + +## EXAMPLES + +### Example 1: Update a Sentinel data connector +```powershell +Update-AzSentinelDataConnector -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id 3bd6c555-1412-4103-9b9d-2b0b40cda6b6 -SharePoint "Enabled" +``` + +This command updates a Sentinel data connector + +## PARAMETERS + +### -Alerts + + +```yaml +Type: System.String +Parameter Sets: UpdateAADAATP, UpdateAzureSecurityCenter, UpdateMicrosoftCloudAppSecurity, UpdateMicrosoftDefenderAdvancedThreatProtection, UpdateOfficeATP, UpdateOfficeIRM, UpdateViaIdentityAADAATP, UpdateViaIdentityAzureSecurityCenter, UpdateViaIdentityMicrosoftCloudAppSecurity, UpdateViaIdentityMicrosoftDefenderAdvancedThreatProtection, UpdateViaIdentityOfficeATP, UpdateViaIdentityOfficeIRM +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -APIRootURL + + +```yaml +Type: System.String +Parameter Sets: UpdateThreatIntelligenceTaxii +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ASCSubscriptionId +ASC Subscription Id. + +```yaml +Type: System.String +Parameter Sets: UpdateAzureSecurityCenter, UpdateViaIdentityAzureSecurityCenter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityIsPreview + + +```yaml +Type: System.Boolean +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityStatus + + +```yaml +Type: System.Int32 +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AWSCloudTrail + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateAmazonWebServicesCloudTrail, UpdateViaIdentityAmazonWebServicesCloudTrail +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AWSRoleArn + + +```yaml +Type: System.String +Parameter Sets: UpdateAmazonWebServicesCloudTrail, UpdateAmazonWebServicesS3, UpdateViaIdentityAmazonWebServicesCloudTrail, UpdateViaIdentityAmazonWebServicesS3 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AWSS3 + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateAmazonWebServicesS3, UpdateViaIdentityAmazonWebServicesS3 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureADorAATP + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateAADAATP, UpdateViaIdentityAADAATP +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureSecurityCenter + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateAzureSecurityCenter, UpdateViaIdentityAzureSecurityCenter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BingSafetyPhishingUrlLookbackPeriod + + +```yaml +Type: System.String +Parameter Sets: UpdateMicrosoftThreatIntelligence, UpdateViaIdentityMicrosoftThreatIntelligence +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BingSafetyPhishinURL + + +```yaml +Type: System.String +Parameter Sets: UpdateMicrosoftThreatIntelligence, UpdateViaIdentityMicrosoftThreatIntelligence +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudAppSecurity +[Parameter(ParameterSetName = 'UpdateGenericUI', Mandatory)] +[Parameter(ParameterSetName = 'UpdateViaIdentityGenericUI', Mandatory)] +[Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Category('Runtime')] +[System.Management.Automation.SwitchParameter] +${GenericUI}, + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateMicrosoftCloudAppSecurity, UpdateViaIdentityMicrosoftCloudAppSecurity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollectionId + + +```yaml +Type: System.String +Parameter Sets: UpdateThreatIntelligenceTaxii, UpdateViaIdentityThreatIntelligenceTaxii +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommonDataServiceActivity + + +```yaml +Type: System.String +Parameter Sets: UpdateDynamics365, UpdateViaIdentityDynamics365 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefenderATP + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateMicrosoftDefenderAdvancedThreatProtection, UpdateViaIdentityMicrosoftDefenderAdvancedThreatProtection +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetinationTable + + +```yaml +Type: System.String +Parameter Sets: UpdateAmazonWebServicesS3, UpdateViaIdentityAmazonWebServicesS3 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiscoveryLog + + +```yaml +Type: System.String +Parameter Sets: UpdateMicrosoftCloudAppSecurity, UpdateViaIdentityMicrosoftCloudAppSecurity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Dynamics365 + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateDynamics365, UpdateViaIdentityDynamics365 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Exchange + + +```yaml +Type: System.String +Parameter Sets: UpdateOffice365, UpdateViaIdentityOffice365 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FriendlyName + + +```yaml +Type: System.String +Parameter Sets: UpdateThreatIntelligenceTaxii, UpdateViaIdentityThreatIntelligenceTaxii +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +[Parameter(ParameterSetName = 'UpdateGenericUI', Mandatory)] + The Id of the Data Connector. + +```yaml +Type: System.String +Parameter Sets: UpdateAADAATP, UpdateAmazonWebServicesCloudTrail, UpdateAmazonWebServicesS3, UpdateAzureSecurityCenter, UpdateDynamics365, UpdateMicrosoftCloudAppSecurity, UpdateMicrosoftDefenderAdvancedThreatProtection, UpdateMicrosoftThreatIntelligence, UpdateMicrosoftThreatProtection, UpdateOffice365, UpdateOfficeATP, UpdateOfficeIRM, UpdateThreatIntelligence, UpdateThreatIntelligenceTaxii +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Incident + + +```yaml +Type: System.String +Parameter Sets: UpdateMicrosoftThreatProtection, UpdateViaIdentityMicrosoftThreatProtection +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Indicator + + +```yaml +Type: System.String +Parameter Sets: UpdateThreatIntelligence, UpdateViaIdentityThreatIntelligence +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +[Parameter(ParameterSetName = 'UpdateViaIdentityGenericUI', Mandatory, ValueFromPipeline)] + Identity Parameter + +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: UpdateViaIdentityAADAATP, UpdateViaIdentityAmazonWebServicesCloudTrail, UpdateViaIdentityAmazonWebServicesS3, UpdateViaIdentityAzureSecurityCenter, UpdateViaIdentityDynamics365, UpdateViaIdentityMicrosoftCloudAppSecurity, UpdateViaIdentityMicrosoftDefenderAdvancedThreatProtection, UpdateViaIdentityMicrosoftThreatIntelligence, UpdateViaIdentityMicrosoftThreatProtection, UpdateViaIdentityOffice365, UpdateViaIdentityOfficeATP, UpdateViaIdentityOfficeIRM, UpdateViaIdentityThreatIntelligence, UpdateViaIdentityThreatIntelligenceTaxii +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Log + + +```yaml +Type: System.String +Parameter Sets: UpdateAmazonWebServicesCloudTrail, UpdateAmazonWebServicesS3, UpdateViaIdentityAmazonWebServicesCloudTrail, UpdateViaIdentityAmazonWebServicesS3 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftEmergingThreatFeed + + +```yaml +Type: System.String +Parameter Sets: UpdateMicrosoftThreatIntelligence, UpdateViaIdentityMicrosoftThreatIntelligence +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftEmergingThreatFeedLookbackPeriod + + +```yaml +Type: System.String +Parameter Sets: UpdateMicrosoftThreatIntelligence, UpdateViaIdentityMicrosoftThreatIntelligence +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftThreatProtection + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateMicrosoftThreatProtection, UpdateViaIdentityMicrosoftThreatProtection +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MicrosoftTI + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateMicrosoftThreatIntelligence, UpdateViaIdentityMicrosoftThreatIntelligence +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Office365 + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateOffice365, UpdateViaIdentityOffice365 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfficeATP + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateOfficeATP, UpdateViaIdentityOfficeATP +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfficeIRM + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateOfficeIRM, UpdateViaIdentityOfficeIRM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password + + +```yaml +Type: System.String +Parameter Sets: UpdateThreatIntelligenceTaxii, UpdateViaIdentityThreatIntelligenceTaxii +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionCustom +To construct, see NOTES section for PERMISSIONCUSTOM properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.PermissionsCustomsItem[] +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionResourceProvider +To construct, see NOTES section for PERMISSIONRESOURCEPROVIDER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.PermissionsResourceProviderItem[] +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PollingFrequency + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.PollingFrequency +Parameter Sets: UpdateThreatIntelligenceTaxii, UpdateViaIdentityThreatIntelligenceTaxii +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +[Parameter(ParameterSetName = 'UpdateGenericUI', Mandatory)] + The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: UpdateAADAATP, UpdateAmazonWebServicesCloudTrail, UpdateAmazonWebServicesS3, UpdateAzureSecurityCenter, UpdateDynamics365, UpdateMicrosoftCloudAppSecurity, UpdateMicrosoftDefenderAdvancedThreatProtection, UpdateMicrosoftThreatIntelligence, UpdateMicrosoftThreatProtection, UpdateOffice365, UpdateOfficeATP, UpdateOfficeIRM, UpdateThreatIntelligence, UpdateThreatIntelligenceTaxii +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePoint + + +```yaml +Type: System.String +Parameter Sets: UpdateOffice365, UpdateViaIdentityOffice365 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SQSURL + + +```yaml +Type: System.String[] +Parameter Sets: UpdateAmazonWebServicesS3, UpdateViaIdentityAmazonWebServicesS3 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +[Parameter(ParameterSetName = 'UpdateGenericUI')] + Gets subscription credentials which uniquely identify Microsoft Azure subscription. + The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateAADAATP, UpdateAmazonWebServicesCloudTrail, UpdateAmazonWebServicesS3, UpdateAzureSecurityCenter, UpdateDynamics365, UpdateMicrosoftCloudAppSecurity, UpdateMicrosoftDefenderAdvancedThreatProtection, UpdateMicrosoftThreatIntelligence, UpdateMicrosoftThreatProtection, UpdateOffice365, UpdateOfficeATP, UpdateOfficeIRM, UpdateThreatIntelligence, UpdateThreatIntelligenceTaxii +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TaxiiLookbackPeriod + + +```yaml +Type: System.String +Parameter Sets: UpdateThreatIntelligenceTaxii, UpdateViaIdentityThreatIntelligenceTaxii +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Teams + + +```yaml +Type: System.String +Parameter Sets: UpdateOffice365, UpdateViaIdentityOffice365 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +[Parameter(ParameterSetName = 'UpdateViaIdentityGenericUI')] + The TenantId. + +```yaml +Type: System.String +Parameter Sets: UpdateAADAATP, UpdateDynamics365, UpdateMicrosoftCloudAppSecurity, UpdateMicrosoftDefenderAdvancedThreatProtection, UpdateMicrosoftThreatIntelligence, UpdateMicrosoftThreatProtection, UpdateOffice365, UpdateOfficeATP, UpdateOfficeIRM, UpdateThreatIntelligence, UpdateThreatIntelligenceTaxii, UpdateViaIdentityAADAATP, UpdateViaIdentityAmazonWebServicesCloudTrail, UpdateViaIdentityAmazonWebServicesS3, UpdateViaIdentityAzureSecurityCenter, UpdateViaIdentityDynamics365, UpdateViaIdentityMicrosoftCloudAppSecurity, UpdateViaIdentityMicrosoftDefenderAdvancedThreatProtection, UpdateViaIdentityMicrosoftThreatIntelligence, UpdateViaIdentityMicrosoftThreatProtection, UpdateViaIdentityOffice365, UpdateViaIdentityOfficeATP, UpdateViaIdentityOfficeIRM, UpdateViaIdentityThreatIntelligence, UpdateViaIdentityThreatIntelligenceTaxii +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Tenant.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThreatIntelligence + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateThreatIntelligence, UpdateViaIdentityThreatIntelligence +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThreatIntelligenceTaxii + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateThreatIntelligenceTaxii, UpdateViaIdentityThreatIntelligenceTaxii +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigConnectivityCriterion +To construct, see NOTES section for UICONFIGCONNECTIVITYCRITERION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ConnectivityCriteria[] +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigCustomImage + + +```yaml +Type: System.String +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigDataType +To construct, see NOTES section for UICONFIGDATATYPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.LastDataReceivedDataType[] +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigDescriptionMarkdown + + +```yaml +Type: System.String +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigGraphQueriesTableName + + +```yaml +Type: System.String +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigGraphQuery +To construct, see NOTES section for UICONFIGGRAPHQUERY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.GraphQueries[] +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigInstructionStep +To construct, see NOTES section for UICONFIGINSTRUCTIONSTEP properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.InstructionSteps[] +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigPublisher + + +```yaml +Type: System.String +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigSampleQuery +To construct, see NOTES section for UICONFIGSAMPLEQUERY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.SampleQueries[] +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UiConfigTitle + + +```yaml +Type: System.String +Parameter Sets: UpdateGenericUI, UpdateViaIdentityGenericUI +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserName + + +```yaml +Type: System.String +Parameter Sets: UpdateThreatIntelligenceTaxii, UpdateViaIdentityThreatIntelligenceTaxii +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceId + + +```yaml +Type: System.String +Parameter Sets: UpdateThreatIntelligenceTaxii, UpdateViaIdentityThreatIntelligenceTaxii +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +[Parameter(ParameterSetName = 'UpdateGenericUI', Mandatory)] + The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateAADAATP, UpdateAmazonWebServicesCloudTrail, UpdateAmazonWebServicesS3, UpdateAzureSecurityCenter, UpdateDynamics365, UpdateMicrosoftCloudAppSecurity, UpdateMicrosoftDefenderAdvancedThreatProtection, UpdateMicrosoftThreatIntelligence, UpdateMicrosoftThreatProtection, UpdateOffice365, UpdateOfficeATP, UpdateOfficeIRM, UpdateThreatIntelligence, UpdateThreatIntelligenceTaxii +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.DataConnector + +## 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 <ISecurityInsightsIdentity>`: [Parameter(ParameterSetName = 'UpdateViaIdentityGenericUI', Mandatory, ValueFromPipeline)] Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +`PERMISSIONCUSTOM <PermissionsCustomsItem[]>`: + - `[Description <String>]`: Customs permissions description + - `[Name <String>]`: Customs permissions name + +`PERMISSIONRESOURCEPROVIDER <PermissionsResourceProviderItem[]>`: + - `[PermissionsDisplayText <String>]`: Permission description text + - `[Provider <ProviderName?>]`: Provider name + - `[ProviderDisplayName <String>]`: Permission provider display name + - `[RequiredPermissionAction <Boolean?>]`: action permission + - `[RequiredPermissionDelete <Boolean?>]`: delete permission + - `[RequiredPermissionRead <Boolean?>]`: read permission + - `[RequiredPermissionWrite <Boolean?>]`: write permission + - `[Scope <PermissionProviderScope?>]`: Permission provider scope + +`UICONFIGCONNECTIVITYCRITERION <ConnectivityCriteria[]>`: + - `[Type <ConnectivityType?>]`: type of connectivity + - `[Value <String[]>]`: Queries for checking connectivity + +`UICONFIGDATATYPE <LastDataReceivedDataType[]>`: + - `[LastDataReceivedQuery <String>]`: Query for indicate last data received + - `[Name <String>]`: Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder + +`UICONFIGGRAPHQUERY <GraphQueries[]>`: + - `[BaseQuery <String>]`: The base query for the graph + - `[Legend <String>]`: The legend for the graph + - `[MetricName <String>]`: the metric that the query is checking + +`UICONFIGINSTRUCTIONSTEP <InstructionSteps[]>`: + - `[Description <String>]`: Instruction step description + - `[Instruction <IConnectorInstructionModelBase[]>]`: Instruction step details + - `Type <SettingType>`: The kind of the setting + - `[Parameter <IAny>]`: The parameters for the setting + - `[Title <String>]`: Instruction step title + +`UICONFIGSAMPLEQUERY <SampleQueries[]>`: + - `[Description <String>]`: The sample query description + - `[Query <String>]`: the sample query + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelEntityQuery.md b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelEntityQuery.md new file mode 100644 index 0000000000..4711215bc5 --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelEntityQuery.md @@ -0,0 +1,401 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/update-azsentinelentityquery +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelEntityQuery.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelEntityQuery.md +--- + +# Update-AzSentinelEntityQuery + +## SYNOPSIS +Updates the entity query. + +## SYNTAX + +### UpdateActivity (Default) +``` +Update-AzSentinelEntityQuery -EntityQueryId <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-Content <String>] [-Description <String>] [-Disabled] [-Enabled] + [-EntitiesFilter <ActivityEntityQueriesPropertiesEntitiesFilter>] [-InputEntityType <EntityType>] + [-QueryDefinitionQuery <String>] [-RequiredInputFieldsSet <String[]>] [-TemplateName <String>] + [-Title <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityActivity +``` +Update-AzSentinelEntityQuery -InputObject <ISecurityInsightsIdentity> [-Content <String>] + [-Description <String>] [-Disabled] [-Enabled] + [-EntitiesFilter <ActivityEntityQueriesPropertiesEntitiesFilter>] [-InputEntityType <EntityType>] + [-QueryDefinitionQuery <String>] [-RequiredInputFieldsSet <String[]>] [-TemplateName <String>] + [-Title <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the entity query. + +## EXAMPLES + +### Example 1: Update an Entity Query +```powershell +Update-AzSentinelEntityQuery -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -EntityQueryId "4a21e485-75ae-48b3-a7b9-e6a92bcfe434" -Title "myEntityQuery Title" +``` + +This command updates an entity query. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Content + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntitiesFilter +To construct, see NOTES section for ENTITIESFILTER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ActivityEntityQueriesPropertiesEntitiesFilter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityQueryId +The Id of the Entity Query. + +```yaml +Type: System.String +Parameter Sets: UpdateActivity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputEntityType + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.EntityType +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.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: UpdateViaIdentityActivity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryDefinitionQuery + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredInputFieldsSet + + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: UpdateActivity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateActivity +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateName + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +[Alias('DataConnectionName')] + The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateActivity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.CustomEntityQuery + +## 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. + + +`ENTITIESFILTER <ActivityEntityQueriesPropertiesEntitiesFilter>`: + - `[(Any) <String[]>]`: This indicates any property can be added to this object. + +`INPUTOBJECT <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelIncident.md b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelIncident.md new file mode 100644 index 0000000000..1d17e5727f --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelIncident.md @@ -0,0 +1,467 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/update-azsentinelincident +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelIncident.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelIncident.md +--- + +# Update-AzSentinelIncident + +## SYNOPSIS +Creates or updates the incident. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSentinelIncident -Id <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-Classification <IncidentClassification>] [-ClassificationComment <String>] + [-ClassificationReason <IncidentClassificationReason>] [-Description <String>] + [-FirstActivityTimeUtc <DateTime>] [-Label <IIncidentLabel[]>] [-LastActivityTimeUtc <DateTime>] + [-OwnerAssignedTo <String>] [-OwnerEmail <String>] [-OwnerObjectId <String>] + [-OwnerUserPrincipalName <String>] [-ProviderIncidentId <String>] [-ProviderName <String>] + [-Severity <IncidentSeverity>] [-Status <IncidentStatus>] [-Title <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSentinelIncident -InputObject <ISecurityInsightsIdentity> [-Classification <IncidentClassification>] + [-ClassificationComment <String>] [-ClassificationReason <IncidentClassificationReason>] + [-Description <String>] [-FirstActivityTimeUtc <DateTime>] [-Label <IIncidentLabel[]>] + [-LastActivityTimeUtc <DateTime>] [-OwnerAssignedTo <String>] [-OwnerEmail <String>] + [-OwnerObjectId <String>] [-OwnerUserPrincipalName <String>] [-ProviderIncidentId <String>] + [-ProviderName <String>] [-Severity <IncidentSeverity>] [-Status <IncidentStatus>] [-Title <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the incident. + +## EXAMPLES + +### Example 1: Update an Incident +```powershell +Update-AzSentinelIncident -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -Id "4a21e485-75ae-48b3-a7b9-e6a92bcfe434" -OwnerAssignedTo "user@mydomain.local" +``` + +This command updates an incident by assigning an owner. + +## PARAMETERS + +### -Classification +The reason the incident was closed + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.IncidentClassification +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationComment +Describes the reason the incident was closed + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationReason +The classification reason the incident was closed with + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.IncidentClassificationReason +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the incident + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirstActivityTimeUtc +The time of the first activity in the incident + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Incident ID + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: IncidentId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Label +List of labels relevant to this incident +To construct, see NOTES section for LABEL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IIncidentLabel[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastActivityTimeUtc +The time of the last activity in the incident + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerAssignedTo +The name of the user the incident is assigned to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerEmail +The email of the user the incident is assigned to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerObjectId +The object id of the user the incident is assigned to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerUserPrincipalName +The user principal name of the user the incident is assigned to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderIncidentId +The incident ID assigned by the incident provider + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderName +The name of the source provider that generated the incident + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity +The severity of the incident + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.IncidentSeverity +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The status of the incident + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.IncidentStatus +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title +The title of the incident + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IIncident + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +`LABEL <IIncidentLabel[]>`: List of labels relevant to this incident + - `LabelName <String>`: The name of the label + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelIncidentComment.md b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelIncidentComment.md new file mode 100644 index 0000000000..f793b421be --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelIncidentComment.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/update-azsentinelincidentcomment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelIncidentComment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelIncidentComment.md +--- + +# Update-AzSentinelIncidentComment + +## SYNOPSIS +Creates or updates the incident comment. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSentinelIncidentComment -Id <String> -IncidentId <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-Message <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSentinelIncidentComment -InputObject <ISecurityInsightsIdentity> [-Message <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the incident comment. + +## EXAMPLES + +### Example 1: Update incident comment +```powershell +Update-AzSentinelIncidentComment -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -IncidentId 7cc984fe-61a2-43c2-a1a4-3583c8a89da2 -Id 8bb5c1eb-a3a9-4575-9451-cd2834be0e0a -Message "my comment" +``` + +This command updates an incident comment + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Incident comment ID + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: IncidentCommentId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentId +Incident ID + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Message +The comment message + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IIncidentComment + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelIncidentRelation.md b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelIncidentRelation.md new file mode 100644 index 0000000000..92c15395fc --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelIncidentRelation.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/update-azsentinelincidentrelation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelIncidentRelation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelIncidentRelation.md +--- + +# Update-AzSentinelIncidentRelation + +## SYNOPSIS +Creates or updates the incident relation. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSentinelIncidentRelation -IncidentId <String> -RelationName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-RelatedResourceId <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSentinelIncidentRelation -InputObject <ISecurityInsightsIdentity> [-RelatedResourceId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates the incident relation. + +## EXAMPLES + +### Example 1: Update an incident relation +```powershell + $bookmark = Get-AzSentinelBookmark -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id "myBookmarkId" + Update-AzSentinelIncidentRelation -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -IncidentId "myIncidentId" -RelationName ((New-Guid).Guid) -RelatedResourceId ($bookmark.Id) +``` + +This command updates an incident relation + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncidentId +Incident ID + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RelatedResourceId +The resource ID of the related resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RelationName +Relation Name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IRelation + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelSetting.md b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelSetting.md new file mode 100644 index 0000000000..2ea783760b --- /dev/null +++ b/azps-10.1.0/Az.SecurityInsights/Update-AzSentinelSetting.md @@ -0,0 +1,286 @@ +--- +external help file: +Module Name: Az.SecurityInsights +online version: https://learn.microsoft.com/powershell/module/az.securityinsights/update-azsentinelsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SecurityInsights/help/Update-AzSentinelSetting.md +--- + +# Update-AzSentinelSetting + +## SYNOPSIS +Updates setting. + +## SYNTAX + +### UpdateExpandedAnomaliesEyesOnEntityAnalytics (Default) +``` +Update-AzSentinelSetting -ResourceGroupName <String> -WorkspaceName <String> -Enabled <Boolean> + -SettingsName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateExpandedUeba +``` +Update-AzSentinelSetting -ResourceGroupName <String> -WorkspaceName <String> -DataSource <UebaDataSources[]> + -SettingsName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpandedAnomaliesEyesOnEntityAnalytics +``` +Update-AzSentinelSetting -InputObject <ISecurityInsightsIdentity> -Enabled <Boolean> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpandedUeba +``` +Update-AzSentinelSetting -InputObject <ISecurityInsightsIdentity> -DataSource <UebaDataSources[]> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates setting. + +## EXAMPLES + +### Example 1: Update the Anomalies setting +```powershell + Update-AzSentinelSetting -ResourceGroupName "myResourceGroupName" -WorkspaceName "myWorkspaceName" -SettingsName "Anomalies" -Enabled $true +``` + +This command updates the Anomalies setting, other settings are: EyesOn, EntityAnalytics and Ueba + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataSource + + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Support.UebaDataSources[] +Parameter Sets: UpdateExpandedUeba, UpdateViaIdentityExpandedUeba +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Anomalies + +```yaml +Type: System.Boolean +Parameter Sets: UpdateExpandedAnomaliesEyesOnEntityAnalytics, UpdateViaIdentityExpandedAnomaliesEyesOnEntityAnalytics +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity +Parameter Sets: UpdateViaIdentityExpandedAnomaliesEyesOnEntityAnalytics, UpdateViaIdentityExpandedUeba +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedAnomaliesEyesOnEntityAnalytics, UpdateExpandedUeba +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SettingsName +The setting Name + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedAnomaliesEyesOnEntityAnalytics, UpdateExpandedUeba +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedAnomaliesEyesOnEntityAnalytics, UpdateExpandedUeba +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +[Alias('DataConnectionName')] + The name of the workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedAnomaliesEyesOnEntityAnalytics, UpdateExpandedUeba +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.Settings + +## 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 <ISecurityInsightsIdentity>`: Identity Parameter + - `[ActionId <String>]`: Action ID + - `[AlertRuleTemplateId <String>]`: Alert rule template ID + - `[AutomationRuleId <String>]`: Automation rule ID + - `[BookmarkId <String>]`: Bookmark ID + - `[ConsentId <String>]`: consent ID + - `[DataConnectorId <String>]`: Connector ID + - `[EntityId <String>]`: entity ID + - `[EntityQueryId <String>]`: entity query ID + - `[EntityQueryTemplateId <String>]`: entity query template ID + - `[Id <String>]`: Resource identity path + - `[IncidentCommentId <String>]`: Incident comment ID + - `[IncidentId <String>]`: Incident ID + - `[MetadataName <String>]`: The Metadata name. + - `[Name <String>]`: Threat intelligence indicator name field. + - `[RelationName <String>]`: Relation Name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[RuleId <String>]`: Alert rule ID + - `[SentinelOnboardingStateName <String>]`: The Sentinel onboarding state name. Supports - default + - `[SettingsName <String>]`: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba + - `[SourceControlId <String>]`: Source control Id + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SelfHelp/Az.SelfHelp.md b/azps-10.1.0/Az.SelfHelp/Az.SelfHelp.md new file mode 100644 index 0000000000..03e4100534 --- /dev/null +++ b/azps-10.1.0/Az.SelfHelp/Az.SelfHelp.md @@ -0,0 +1,28 @@ +--- +Module Name: Az.SelfHelp +Module Guid: 2705ffd2-39d8-491f-b0c6-14fca2dc3727 +Download Help Link: https://learn.microsoft.com/powershell/module/az.selfhelp +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SelfHelp/help/Az.SelfHelp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SelfHelp/help/Az.SelfHelp.md +--- + +# Az.SelfHelp Module +## Description +Microsoft Azure PowerShell: SelfHelp cmdlets + +## Az.SelfHelp Cmdlets +### [Get-AzSelfHelpDiagnostic](Get-AzSelfHelpDiagnostic.md) +Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic. + +### [Get-AzSelfHelpDiscoverySolution](Get-AzSelfHelpDiscoverySolution.md) +Solutions Discovery is the initial point of entry within Help API, which helps you identify the relevant solutions for your Azure issue.\<br/\>\<br/\> You can discover solutions using resourceUri OR resourceUri + problemClassificationId.\<br/\>\<br/\>We will do our best in returning relevant diagnostics for your Azure issue.\<br/\>\<br/\> Get the problemClassificationId(s) using this [reference](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP).\<br/\>\<br/\> \<b\>Note: \</b\> ‘requiredParameterSets’ from Solutions Discovery API response must be passed via ‘additionalParameters’ as an input to Diagnostics API. + +### [New-AzSelfHelpDiagnostic](New-AzSelfHelpDiagnostic.md) +Diagnostics tells you precisely the root cause of the issue and how to address it. +You can get diagnostics once you discover and identify the relevant solution for your Azure issue.\<br/\>\<br/\> You can create diagnostics using the ‘solutionId’ from Solution Discovery API response and ‘additionalParameters’ \<br/\>\<br/\> \<b\>Note: \</b\>‘requiredParameterSets’ from Solutions Discovery API response must be passed via ‘additionalParameters’ as an input to Diagnostics API + +### [Test-AzSelfHelpDiagnosticNameAvailability](Test-AzSelfHelpDiagnosticNameAvailability.md) +This API is used to check the uniqueness of a resource name used for a diagnostic check. + diff --git a/azps-10.1.0/Az.SelfHelp/Get-AzSelfHelpDiagnostic.md b/azps-10.1.0/Az.SelfHelp/Get-AzSelfHelpDiagnostic.md new file mode 100644 index 0000000000..7f76eb9df0 --- /dev/null +++ b/azps-10.1.0/Az.SelfHelp/Get-AzSelfHelpDiagnostic.md @@ -0,0 +1,136 @@ +--- +external help file: +Module Name: Az.SelfHelp +online version: https://learn.microsoft.com/powershell/module/az.selfhelp/get-azselfhelpdiagnostic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SelfHelp/help/Get-AzSelfHelpDiagnostic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SelfHelp/help/Get-AzSelfHelpDiagnostic.md +--- + +# Get-AzSelfHelpDiagnostic + +## SYNOPSIS +Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic. + +## SYNTAX + +### Get (Default) +``` +Get-AzSelfHelpDiagnostic -Scope <String> -SResourceName <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSelfHelpDiagnostic -InputObject <ISelfHelpIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic. + +## EXAMPLES + +### Example 1: Get diagnostic by resource id and diagnostic name +```powershell + Get-AzSelfHelpDiagnostic -Scope "subscriptions/6bded6d5-a6df-44e1-96d3-bf71f6f5f8ba/resourceGroups/test-rgName/providers/Microsoft.KeyVault/vaults/testKeyVault" -SResourceName ab-test-983 +``` + +```output +Name +---- +ab-test-983 +``` + +Get diagnostic by resource id and diagnostic name + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SelfHelp.Models.ISelfHelpIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Scope +This is an extension resource provider and only resource level extension is supported at the moment. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SResourceName +Unique resource name for insight resources + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DiagnosticsResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SelfHelp.Models.ISelfHelpIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SelfHelp.Models.Api20230601.IDiagnosticResource + +## 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 <ISelfHelpIdentity>`: Identity Parameter + - `[DiagnosticsResourceName <String>]`: Unique resource name for insight resources + - `[Id <String>]`: Resource identity path + - `[Scope <String>]`: This is an extension resource provider and only resource level extension is supported at the moment. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SelfHelp/Get-AzSelfHelpDiscoverySolution.md b/azps-10.1.0/Az.SelfHelp/Get-AzSelfHelpDiscoverySolution.md new file mode 100644 index 0000000000..5c07ec0780 --- /dev/null +++ b/azps-10.1.0/Az.SelfHelp/Get-AzSelfHelpDiscoverySolution.md @@ -0,0 +1,120 @@ +--- +external help file: +Module Name: Az.SelfHelp +online version: https://learn.microsoft.com/powershell/module/az.selfhelp/get-azselfhelpdiscoverysolution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SelfHelp/help/Get-AzSelfHelpDiscoverySolution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SelfHelp/help/Get-AzSelfHelpDiscoverySolution.md +--- + +# Get-AzSelfHelpDiscoverySolution + +## SYNOPSIS +Solutions Discovery is the initial point of entry within Help API, which helps you identify the relevant solutions for your Azure issue.\<br/\>\<br/\> You can discover solutions using resourceUri OR resourceUri + problemClassificationId.\<br/\>\<br/\>We will do our best in returning relevant diagnostics for your Azure issue.\<br/\>\<br/\> Get the problemClassificationId(s) using this [reference](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP).\<br/\>\<br/\> \<b\>Note: \</b\> ‘requiredParameterSets’ from Solutions Discovery API response must be passed via ‘additionalParameters’ as an input to Diagnostics API. + +## SYNTAX + +``` +Get-AzSelfHelpDiscoverySolution -Scope <String> [-Filter <String>] [-Skiptoken <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Solutions Discovery is the initial point of entry within Help API, which helps you identify the relevant solutions for your Azure issue.\<br/\>\<br/\> You can discover solutions using resourceUri OR resourceUri + problemClassificationId.\<br/\>\<br/\>We will do our best in returning relevant diagnostics for your Azure issue.\<br/\>\<br/\> Get the problemClassificationId(s) using this [reference](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP).\<br/\>\<br/\> \<b\>Note: \</b\> ‘requiredParameterSets’ from Solutions Discovery API response must be passed via ‘additionalParameters’ as an input to Diagnostics API. + +## EXAMPLES + +### Example 1: Get Solution Metadata by resource id +```powershell + Get-AzSelfHelpDiscoverySolution -Scope "subscriptions/6bded6d5-a6df-44e1-96d3-bf71f6f5f8ba/resourceGroups/test-rgName/providers/Microsoft.KeyVault/vaults/testKeyVault" +``` + +```output +Name +---- +KeyVaultUnauthorizedNetworkInsight +``` + +Get Solution Metadata by resource id + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Can be used to filter solutionIds by 'ProblemClassificationId'. +The filter supports only 'and' and 'eq' operators. +Example: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' and ProblemClassificationId eq '0a9673c2-7af6-4e19-90d3-4ee2461076d9'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +This is an extension resource provider and only resource level extension is supported at the moment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skiptoken +Skiptoken is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SelfHelp.Models.Api20230601.ISolutionMetadataResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SelfHelp/New-AzSelfHelpDiagnostic.md b/azps-10.1.0/Az.SelfHelp/New-AzSelfHelpDiagnostic.md new file mode 100644 index 0000000000..92434dd5ea --- /dev/null +++ b/azps-10.1.0/Az.SelfHelp/New-AzSelfHelpDiagnostic.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.SelfHelp +online version: https://learn.microsoft.com/powershell/module/az.selfhelp/new-azselfhelpdiagnostic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SelfHelp/help/New-AzSelfHelpDiagnostic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SelfHelp/help/New-AzSelfHelpDiagnostic.md +--- + +# New-AzSelfHelpDiagnostic + +## SYNOPSIS +Diagnostics tells you precisely the root cause of the issue and how to address it. +You can get diagnostics once you discover and identify the relevant solution for your Azure issue.\<br/\>\<br/\> You can create diagnostics using the ‘solutionId’ from Solution Discovery API response and ‘additionalParameters’ \<br/\>\<br/\> \<b\>Note: \</b\>‘requiredParameterSets’ from Solutions Discovery API response must be passed via ‘additionalParameters’ as an input to Diagnostics API + +## SYNTAX + +``` +New-AzSelfHelpDiagnostic -Scope <String> -SResourceName <String> [-GlobalParameter <Hashtable>] + [-Insight <IDiagnosticInvocation[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Diagnostics tells you precisely the root cause of the issue and how to address it. +You can get diagnostics once you discover and identify the relevant solution for your Azure issue.\<br/\>\<br/\> You can create diagnostics using the ‘solutionId’ from Solution Discovery API response and ‘additionalParameters’ \<br/\>\<br/\> \<b\>Note: \</b\>‘requiredParameterSets’ from Solutions Discovery API response must be passed via ‘additionalParameters’ as an input to Diagnostics API + +## EXAMPLES + +### Example 1: Create Diagnostic for a KeyVault resource. +```powershell +$insightsToInvoke = [ordered]@{ + "solutionId" = "Demo2InsightV2" + } +New-AzSelfHelpDiagnostic -Scope "/subscriptions/6bded6d5-a6af-43e1-96d3-bf71f6f5f8ba/resourceGroups/aravind-test-resources/providers/Microsoft.KeyVault/vaults/ab-tests-kv-an" -SResourceName ab-test-973 -Insight $insightsToInvoke +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +ab-test-973 aravind-test-reso… +``` + +Creates a diagnostic for a KeyVault resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalParameter +Global parameters that can be passed to all solutionIds. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Insight +SolutionIds that are needed to be invoked. +To construct, see NOTES section for INSIGHT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SelfHelp.Models.Api20230601.IDiagnosticInvocation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +This is an extension resource provider and only resource level extension is supported at the moment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SResourceName +Unique resource name for insight resources + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DiagnosticsResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SelfHelp.Models.Api20230601.IDiagnosticResource + +## 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. + + +`INSIGHT <IDiagnosticInvocation[]>`: SolutionIds that are needed to be invoked. + - `[AdditionalParameter <IDiagnosticInvocationAdditionalParameters>]`: Additional parameters required to invoke the solutionId. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[SolutionId <String>]`: Solution Id to invoke. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SelfHelp/Test-AzSelfHelpDiagnosticNameAvailability.md b/azps-10.1.0/Az.SelfHelp/Test-AzSelfHelpDiagnosticNameAvailability.md new file mode 100644 index 0000000000..31bc859a93 --- /dev/null +++ b/azps-10.1.0/Az.SelfHelp/Test-AzSelfHelpDiagnosticNameAvailability.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.SelfHelp +online version: https://learn.microsoft.com/powershell/module/az.selfhelp/test-azselfhelpdiagnosticnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SelfHelp/help/Test-AzSelfHelpDiagnosticNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SelfHelp/help/Test-AzSelfHelpDiagnosticNameAvailability.md +--- + +# Test-AzSelfHelpDiagnosticNameAvailability + +## SYNOPSIS +This API is used to check the uniqueness of a resource name used for a diagnostic check. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzSelfHelpDiagnosticNameAvailability -Scope <String> [-Name <String>] [-Type <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Check +``` +Test-AzSelfHelpDiagnosticNameAvailability -Scope <String> + -CheckNameAvailabilityRequest <ICheckNameAvailabilityRequest> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### CheckViaIdentity +``` +Test-AzSelfHelpDiagnosticNameAvailability -InputObject <ISelfHelpIdentity> + -CheckNameAvailabilityRequest <ICheckNameAvailabilityRequest> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### CheckViaIdentityExpanded +``` +Test-AzSelfHelpDiagnosticNameAvailability -InputObject <ISelfHelpIdentity> [-Name <String>] [-Type <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +This API is used to check the uniqueness of a resource name used for a diagnostic check. + +## EXAMPLES + +### Example 1: Example when the diagnostic resource name is available +```powershell +Test-AzSelfHelpDiagnosticNameAvailability -Name test-diagnostics-resource -Type microsoft.help/diagnostics -Scope "subscriptions/6bded6d5-a6af-43e1-96d3-bf71f6f5f8ba" +``` + +```output +Message NameAvailable Reason +------- ------------- ------ + True + +``` + +Example when the diagnostic resource name is available + +### Example 2: Example when the diagnostic resource name is available +```powershell +Test-AzSelfHelpDiagnosticNameAvailability -Name test-diagnostics-resource -Type microsoft.help/diagnostics -Scope "subscriptions/6bded6d5-a6af-43e1-96d3-bf71f6f5f8ba" +``` + +```output +Message NameAvailable Reason +------- ------------- ------ +Resource name is currently in use. False Resource name already exisits/unavailable +``` + +Example when the diagnostic resource name is not available + +## PARAMETERS + +### -CheckNameAvailabilityRequest +The check availability request body. +To construct, see NOTES section for CHECKNAMEAVAILABILITYREQUEST properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SelfHelp.Models.Api30.ICheckNameAvailabilityRequest +Parameter Sets: Check, CheckViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SelfHelp.Models.ISelfHelpIdentity +Parameter Sets: CheckViaIdentity, CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the resource for which availability needs to be checked. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +This is an extension resource provider and only resource level extension is supported at the moment. + +```yaml +Type: System.String +Parameter Sets: Check, CheckExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The resource type. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SelfHelp.Models.Api30.ICheckNameAvailabilityRequest + +### Microsoft.Azure.PowerShell.Cmdlets.SelfHelp.Models.ISelfHelpIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SelfHelp.Models.Api20230601.ICheckNameAvailabilityResponse + +## 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. + + +`CHECKNAMEAVAILABILITYREQUEST <ICheckNameAvailabilityRequest>`: The check availability request body. + - `[Name <String>]`: The name of the resource for which availability needs to be checked. + - `[Type <String>]`: The resource type. + +`INPUTOBJECT <ISelfHelpIdentity>`: Identity Parameter + - `[DiagnosticsResourceName <String>]`: Unique resource name for insight resources + - `[Id <String>]`: Resource identity path + - `[Scope <String>]`: This is an extension resource provider and only resource level extension is supported at the moment. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceBus/Approve-AzServiceBusPrivateEndpointConnection.md b/azps-10.1.0/Az.ServiceBus/Approve-AzServiceBusPrivateEndpointConnection.md new file mode 100644 index 0000000000..9394099342 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Approve-AzServiceBusPrivateEndpointConnection.md @@ -0,0 +1,246 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/approve-azservicebusprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Approve-AzServiceBusPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Approve-AzServiceBusPrivateEndpointConnection.md +--- + +# Approve-AzServiceBusPrivateEndpointConnection + +## SYNOPSIS +Approves a ServiceBus PrivateEndpointConnection + +## SYNTAX + +### SetExpanded (Default) +``` +Approve-AzServiceBusPrivateEndpointConnection -NamespaceName <String> -ResourceGroupName <String> + [-Name <String>] [-SubscriptionId <String>] [-Description <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Approve-AzServiceBusPrivateEndpointConnection -InputObject <IServiceBusIdentity> [-Description <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +## DESCRIPTION +Approves a ServiceBus PrivateEndpointConnection + +## EXAMPLES + +### Example 1: Approve a ServiceBus Namespace Private Endpoint Connection +```powershell +Approve-AzServiceBusPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name 00000000000 +``` + +```output +ConnectionState : Approved +Description : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/privateEndpointConnections/00000000000 +Location : Australia East +Name : 00000000000 +PrivateEndpointId : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/privateEndpointName +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +``` + +Approves private endpoint connection `00000000000` on ServiceBus namespace `myNamespace`. + +### Example 2: Approve a ServiceBus Namespace Private Endpoint Connection using InputObject +```powershell +$privateEndpoint = Get-AzServiceBusPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name 00000000000 +Approve-AzServiceBusPrivateEndpointConnection -InputObject $privateEndpoint +``` + +```output +ConnectionState : Approved +Description : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/privateEndpointC + onnections/00000000000 +Location : Australia East +Name : 00000000000 +PrivateEndpointId : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/privateEndpointName +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +``` + +Approves private endpoint connection `00000000000` on ServiceBus namespace `myNamespace` using InputObject parameter set. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +PrivateEndpoint information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Private Endpoint Connection + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: PrivateEndpointConnectionName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of ServiceBus namespace + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IPrivateEndpointConnection + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Az.ServiceBus.md b/azps-10.1.0/Az.ServiceBus/Az.ServiceBus.md new file mode 100644 index 0000000000..c6b3aa62e7 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Az.ServiceBus.md @@ -0,0 +1,165 @@ +--- +Module Name: Az.ServiceBus +Module Guid: cc69c625-e961-43f4-8b50-0061eba6e4b6 +Download Help Link: https://learn.microsoft.com/powershell/module/az.servicebus +Help Version: 4.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Az.ServiceBus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Az.ServiceBus.md +--- + +# Az.ServiceBus Module +## Description +This topic displays help topics for the Azure Service Bus cmdlets. + +## Az.ServiceBus Cmdlets +### [Approve-AzServiceBusPrivateEndpointConnection](Approve-AzServiceBusPrivateEndpointConnection.md) +Approves a ServiceBus PrivateEndpointConnection + +### [Complete-AzServiceBusMigration](Complete-AzServiceBusMigration.md) +This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. +CompleteMigration operation will fail when entity migration is in-progress. + +### [Deny-AzServiceBusPrivateEndpointConnection](Deny-AzServiceBusPrivateEndpointConnection.md) +Denies a ServiceBus PrivateEndpointConnection + +### [Get-AzServiceBusAuthorizationRule](Get-AzServiceBusAuthorizationRule.md) +Gets the Authorization Rule of a ServiceBus namespace, queue or topic. + +### [Get-AzServiceBusGeoDRConfiguration](Get-AzServiceBusGeoDRConfiguration.md) +Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace + +### [Get-AzServiceBusKey](Get-AzServiceBusKey.md) +Gets the SASKey of a ServiceBus namespace, queue or topic. + +### [Get-AzServiceBusMigration](Get-AzServiceBusMigration.md) +Retrieves Migration Config + +### [Get-AzServiceBusNamespace](Get-AzServiceBusNamespace.md) +Gets a description for the specified namespace. + +### [Get-AzServiceBusNetworkRuleSet](Get-AzServiceBusNetworkRuleSet.md) +Gets NetworkRuleSet for a Namespace. + +### [Get-AzServiceBusPrivateEndpointConnection](Get-AzServiceBusPrivateEndpointConnection.md) +Gets a description for the specified Private Endpoint Connection. + +### [Get-AzServiceBusPrivateLink](Get-AzServiceBusPrivateLink.md) +Gets lists of resources that supports Privatelinks. + +### [Get-AzServiceBusQueue](Get-AzServiceBusQueue.md) +Returns a description for the specified queue. + +### [Get-AzServiceBusRule](Get-AzServiceBusRule.md) +Retrieves the description for the specified rule. + +### [Get-AzServiceBusSubscription](Get-AzServiceBusSubscription.md) +Returns a subscription description for the specified topic. + +### [Get-AzServiceBusTopic](Get-AzServiceBusTopic.md) +Returns a description for the specified topic. + +### [New-AzServiceBusAuthorizationRule](New-AzServiceBusAuthorizationRule.md) +Creates a ServiceBus Namespace, Queue, Topic Authorization Rule + +### [New-AzServiceBusAuthorizationRuleSASToken](New-AzServiceBusAuthorizationRuleSASToken.md) +Generates a SAS token for Azure servicebus authorization rule of namespace/queue/topic. + +### [New-AzServiceBusGeoDRConfiguration](New-AzServiceBusGeoDRConfiguration.md) +Creates or updates a new Alias(Disaster Recovery configuration) + +### [New-AzServiceBusIPRuleConfig](New-AzServiceBusIPRuleConfig.md) +Constructs an INwRuleSetIPRules object that can be fed as input to Set-AzServiceBusNetworkRuleSet + +### [New-AzServiceBusKey](New-AzServiceBusKey.md) +Regenerates the SASKey of a ServiceBus namespace, queue or topic. + +### [New-AzServiceBusKeyVaultPropertiesObject](New-AzServiceBusKeyVaultPropertiesObject.md) +Create an in-memory object for KeyVaultProperties. + +### [New-AzServiceBusNamespace](New-AzServiceBusNamespace.md) +Creates a new ServiceBus namespace. + +### [New-AzServiceBusQueue](New-AzServiceBusQueue.md) +Creates or updates a Service Bus queue. +This operation is idempotent. + +### [New-AzServiceBusRule](New-AzServiceBusRule.md) +Creates a new rule and updates an existing rule + +### [New-AzServiceBusSubscription](New-AzServiceBusSubscription.md) +Creates a topic subscription. + +### [New-AzServiceBusTopic](New-AzServiceBusTopic.md) +Creates a topic in the specified namespace. + +### [New-AzServiceBusVirtualNetworkRuleConfig](New-AzServiceBusVirtualNetworkRuleConfig.md) +Constructs an INwRuleSetIPRules object that can be fed as input to Set-AzServiceBusNetworkRuleSet + +### [Remove-AzServiceBusAuthorizationRule](Remove-AzServiceBusAuthorizationRule.md) +Removes the Authorization Rule of a ServiceBus Namespace, Queue or Topic + +### [Remove-AzServiceBusGeoDRConfiguration](Remove-AzServiceBusGeoDRConfiguration.md) +Deletes an Alias(Disaster Recovery configuration) + +### [Remove-AzServiceBusMigration](Remove-AzServiceBusMigration.md) +Deletes a MigrationConfiguration + +### [Remove-AzServiceBusNamespace](Remove-AzServiceBusNamespace.md) +Deletes an existing namespace. +This operation also removes all associated resources under the namespace. + +### [Remove-AzServiceBusPrivateEndpointConnection](Remove-AzServiceBusPrivateEndpointConnection.md) +Deletes an existing Private Endpoint Connection. + +### [Remove-AzServiceBusQueue](Remove-AzServiceBusQueue.md) +Deletes a queue from the specified namespace in a resource group. + +### [Remove-AzServiceBusRule](Remove-AzServiceBusRule.md) +Deletes an existing rule. + +### [Remove-AzServiceBusSubscription](Remove-AzServiceBusSubscription.md) +Deletes a subscription from the specified topic. + +### [Remove-AzServiceBusTopic](Remove-AzServiceBusTopic.md) +Deletes a topic from the specified namespace and resource group. + +### [Set-AzServiceBusAuthorizationRule](Set-AzServiceBusAuthorizationRule.md) +Updates the authorization rule of a ServiceBus namespace, queue or topic. + +### [Set-AzServiceBusGeoDRConfigurationBreakPair](Set-AzServiceBusGeoDRConfigurationBreakPair.md) +This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces + +### [Set-AzServiceBusGeoDRConfigurationFailOver](Set-AzServiceBusGeoDRConfigurationFailOver.md) +Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace + +### [Set-AzServiceBusNamespace](Set-AzServiceBusNamespace.md) +Updates a ServiceBus namespace + +### [Set-AzServiceBusNetworkRuleSet](Set-AzServiceBusNetworkRuleSet.md) +Updates the NetworkRuleSet of a ServiceBus namespace + +### [Set-AzServiceBusQueue](Set-AzServiceBusQueue.md) +Updates a ServiceBus Queue + +### [Set-AzServiceBusRule](Set-AzServiceBusRule.md) +Updates a ServiceBus Rule + +### [Set-AzServiceBusSubscription](Set-AzServiceBusSubscription.md) +Updates a ServiceBus Subscription + +### [Set-AzServiceBusTopic](Set-AzServiceBusTopic.md) +Updates a ServiceBus Topic + +### [Start-AzServiceBusMigration](Start-AzServiceBusMigration.md) +Creates Migration configuration and starts migration of entities from Standard to Premium namespace + +### [Stop-AzServiceBusMigration](Stop-AzServiceBusMigration.md) +This operation reverts Migration + +### [Test-AzServiceBusName](Test-AzServiceBusName.md) +Checks availability of a namespace name or disaster recovery alias. + +### [Test-AzServiceBusNameAvailability](Test-AzServiceBusNameAvailability.md) +Checks the Availability of the given Queue or Topic name + diff --git a/azps-10.1.0/Az.ServiceBus/Complete-AzServiceBusMigration.md b/azps-10.1.0/Az.ServiceBus/Complete-AzServiceBusMigration.md new file mode 100644 index 0000000000..3f0c0cd6fa --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Complete-AzServiceBusMigration.md @@ -0,0 +1,204 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/complete-azservicebusmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Complete-AzServiceBusMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Complete-AzServiceBusMigration.md +--- + +# Complete-AzServiceBusMigration + +## SYNOPSIS +This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. +CompleteMigration operation will fail when entity migration is in-progress. + +## SYNTAX + +### Complete (Default) +``` +Complete-AzServiceBusMigration -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CompleteViaIdentity +``` +Complete-AzServiceBusMigration -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. +CompleteMigration operation will fail when entity migration is in-progress. + +## EXAMPLES + +### Example 1: Complete migration from standard to premium servicebus namespace +```powershell +Complete-AzServiceBusMigration -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +Completes migration to premium namespace. +Start-AzServiceBusMigration must be used to configure migration before completing it. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: CompleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: Complete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Complete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Complete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Deny-AzServiceBusPrivateEndpointConnection.md b/azps-10.1.0/Az.ServiceBus/Deny-AzServiceBusPrivateEndpointConnection.md new file mode 100644 index 0000000000..473bdb65da --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Deny-AzServiceBusPrivateEndpointConnection.md @@ -0,0 +1,246 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/deny-azservicebusprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Deny-AzServiceBusPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Deny-AzServiceBusPrivateEndpointConnection.md +--- + +# Deny-AzServiceBusPrivateEndpointConnection + +## SYNOPSIS +Denies a ServiceBus PrivateEndpointConnection + +## SYNTAX + +### SetExpanded (Default) +``` +Deny-AzServiceBusPrivateEndpointConnection -NamespaceName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String>] [-Description <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Deny-AzServiceBusPrivateEndpointConnection -InputObject <IServiceBusIdentity> [-Description <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +## DESCRIPTION +Denies a ServiceBus PrivateEndpointConnection + +## EXAMPLES + +### Example 1: Rejects a ServiceBus Namespace Private Endpoint Connection +```powershell +Deny-AzServiceBusPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name 00000000000 +``` + +```output +ConnectionState : Rejected +Description : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/privateEndpointConnections/00000000000 +Location : Australia East +Name : 00000000000 +PrivateEndpointId : /subscriptions/subscriptionId/resourceGroups/{resourceGroup}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +``` + +Rejects private endpoint connection `00000000000` on ServiceBus namespace `myNamespace`. + +### Example 2: Rejects a ServiceBus Namespace Private Endpoint Connection using InputObject +```powershell +$privateEndpoint = Get-AzServiceBusPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name 00000000000 +Deny-AzServiceBusPrivateEndpointConnection -InputObject $privateEndpoint +``` + +```output +ConnectionState : Rejected +Description : +Id : /subscriptions/subscriptionId/resourceGroups/{resourceGroup}/providers/Microsoft.ServiceBus/namespaces/{namespace}/privateEndpointC + onnections/00000000000 +Location : Australia East +Name : 00000000000 +PrivateEndpointId : /subscriptions/subscriptionId/resourceGroups/{resourceGroup}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +``` + +Rejects private endpoint connection `00000000000` on ServiceBus namespace `myNamespace` using InputObject parameter set. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +PrivateEndpoint information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Private Endpoint Connection + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: PrivateEndpointConnectionName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of ServiceBus namespace + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IPrivateEndpointConnection + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusAuthorizationRule.md b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusAuthorizationRule.md new file mode 100644 index 0000000000..144ea32baf --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusAuthorizationRule.md @@ -0,0 +1,264 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/get-azservicebusauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusAuthorizationRule.md +--- + +# Get-AzServiceBusAuthorizationRule + +## SYNOPSIS +Gets the Authorization Rule of a ServiceBus namespace, queue or topic. + +## SYNTAX + +### GetExpandedNamespace (Default) +``` +Get-AzServiceBusAuthorizationRule -NamespaceName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetExpandedQueue +``` +Get-AzServiceBusAuthorizationRule -NamespaceName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String[]>] -QueueName <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetExpandedTopic +``` +Get-AzServiceBusAuthorizationRule -NamespaceName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String[]>] -TopicName <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetExpandedAlias +``` +Get-AzServiceBusAuthorizationRule -NamespaceName <String> -ResourceGroupName <String> [-Name <String>] + [-SubscriptionId <String[]>] -AliasName <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentityExpanded +``` +Get-AzServiceBusAuthorizationRule -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the Authorization Rule of a ServiceBus namespace, queue or topic. + +## EXAMPLES + +### Example 1: Get a ServiceBus Namespace Authorization Rule +```powershell +Get-AzServiceBusAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAuthRule +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/authorizationRules + /myAuthRule +Location : Central US +Name : myAuthRule +ResourceGroupName : myResourceGroup +Rights : {Listen, Manage, Send} +``` + +Gets details of authorization rule `myAuthRule` of ServiceBus namespace `myNamespace`. + +### Example 2: Get a ServiceBus queue authorization rule +```powershell +Get-AzServiceBusAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -QueueName queue1 -Name myAuthRule +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/queues/queue1/authorizationRules + /myAuthRule +Location : Central US +Name : myAuthRule +ResourceGroupName : myResourceGroup +Rights : {Listen, Manage, Send} +``` + +Gets details of authorization rule `myAuthRule` of ServiceBus queue `queue1` from namespace `myNamespace`. + +### Example 3: List all authorization rules in a ServiceBus namespace +```powershell +Get-AzServiceBusAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +Lists all authorization rules in ServiceBus namespace `myNamespace`. + +## PARAMETERS + +### -AliasName +The name of the disaster recovery config + +```yaml +Type: System.String +Parameter Sets: GetExpandedAlias +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: GetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Authorization Rule + +```yaml +Type: System.String +Parameter Sets: GetExpandedNamespace, GetExpandedQueue, GetExpandedTopic, GetExpandedAlias +Aliases: AuthorizationRuleName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of ServiceBus namespace + +```yaml +Type: System.String +Parameter Sets: GetExpandedNamespace, GetExpandedQueue, GetExpandedTopic, GetExpandedAlias +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueueName +The name of the Service Bus queue. + +```yaml +Type: System.String +Parameter Sets: GetExpandedQueue +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: GetExpandedNamespace, GetExpandedQueue, GetExpandedTopic, GetExpandedAlias +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: GetExpandedNamespace, GetExpandedQueue, GetExpandedTopic, GetExpandedAlias +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The name of the Service Bus topic. + +```yaml +Type: System.String +Parameter Sets: GetExpandedTopic +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbAuthorizationRule + +## 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 <IServiceBusIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusGeoDRConfiguration.md b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusGeoDRConfiguration.md new file mode 100644 index 0000000000..e3a22bb8bb --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusGeoDRConfiguration.md @@ -0,0 +1,188 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/get-azservicebusgeodrconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusGeoDRConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusGeoDRConfiguration.md +--- + +# Get-AzServiceBusGeoDRConfiguration + +## SYNOPSIS +Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace + +## SYNTAX + +### List (Default) +``` +Get-AzServiceBusGeoDRConfiguration -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzServiceBusGeoDRConfiguration -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzServiceBusGeoDRConfiguration -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace + +## EXAMPLES + +### Example 1: Get the disaster recovery configuration details of a ServiceBus namespace +```powershell +Get-AzServiceBusGeoDRConfiguration -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAlias +``` + +```output +AlternateName : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/disasterRecoveryConfigs/myAlias +Location : +Name : myalias +PartnerNamespace : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/mySecondaryNamespace +PendingReplicationOperationsCount : 0 +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +Role : Primary +``` + +Gets disaster recovery configuration details of alias `myAlias` created for namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Disaster Recovery configuration name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IArmDisasterRecovery + +## 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 <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusKey.md b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusKey.md new file mode 100644 index 0000000000..c5d5a1ff1d --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusKey.md @@ -0,0 +1,266 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/get-azservicebuskey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusKey.md +--- + +# Get-AzServiceBusKey + +## SYNOPSIS +Gets the SASKey of a ServiceBus namespace, queue or topic. + +## SYNTAX + +### GetExpandedNamespace (Default) +``` +Get-AzServiceBusKey -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +### GetExpandedAlias +``` +Get-AzServiceBusKey -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] -AliasName <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [<CommonParameters>] +``` + +### GetExpandedTopic +``` +Get-AzServiceBusKey -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] -TopicName <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [<CommonParameters>] +``` + +### GetExpandedQueue +``` +Get-AzServiceBusKey -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] -QueueName <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the SASKey of a ServiceBus namespace, queue or topic. + +## EXAMPLES + +### Example 1: Get keys of a ServiceBus Namespace authorization rule +```powershell +Get-AzServiceBusKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name RootManageSharedAccessKey +``` + +```output +AliasPrimaryConnectionString : +AliasSecondaryConnectionString : +KeyName : RootManageSharedAccessKey +PrimaryConnectionString : 000000000000 +PrimaryKey : 000000000000 +SecondaryConnectionString : {ConnectionString} +SecondaryKey : {ConnectionString} +``` + +Gets keys of authorization rule `RootManageSharedAccessKey` of ServiceBus namespace `myNamespace`. + +### Example 2: Get keys of a Queue authorization rule +```powershell +Get-AzServiceBusKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -QueueName queue1 -Name RootManageSharedAccessKey +``` + +```output +AliasPrimaryConnectionString : +AliasSecondaryConnectionString : +KeyName : RootManageSharedAccessKey +PrimaryConnectionString : 000000000000 +PrimaryKey : 000000000000 +SecondaryConnectionString : {ConnectionString} +SecondaryKey : {ConnectionString} +``` + +Gets keys of authorization rule `RootManageSharedAccessKey` of ServiceBus queue `queue1` from namespace `myNamespace`. + +### Example 3: Get keys of a Topic authorization rule +```powershell +Get-AzServiceBusKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName topic1 -Name RootManageSharedAccessKey +``` + +```output +AliasPrimaryConnectionString : +AliasSecondaryConnectionString : +KeyName : RootManageSharedAccessKey +PrimaryConnectionString : 000000000000 +PrimaryKey : 000000000000 +SecondaryConnectionString : {ConnectionString} +SecondaryKey : {ConnectionString} +``` + +Gets keys of authorization rule `RootManageSharedAccessKey` of ServiceBus topic `topic1` from namespace `myNamespace`. + +## PARAMETERS + +### -AliasName +The name of the Service Disaster Recovery Config. + +```yaml +Type: System.String +Parameter Sets: GetExpandedAlias +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Authorization Rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AuthorizationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of ServiceBus namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueueName +The name of the ServiceBus queue. + +```yaml +Type: System.String +Parameter Sets: GetExpandedQueue +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The name of the ServiceBus topic. + +```yaml +Type: System.String +Parameter Sets: GetExpandedTopic +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IAccessKeys + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusMigration.md b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusMigration.md new file mode 100644 index 0000000000..a0ca1d306d --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusMigration.md @@ -0,0 +1,180 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/get-azservicebusmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusMigration.md +--- + +# Get-AzServiceBusMigration + +## SYNOPSIS +Retrieves Migration Config + +## SYNTAX + +### Get (Default) +``` +Get-AzServiceBusMigration -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzServiceBusMigration -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzServiceBusMigration -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves Migration Config + +## EXAMPLES + +### Example 1: Gets the migration configuration of a ServiceBus namespace +```powershell +Get-AzServiceBusMigration -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces + /myNamespace/migrationConfigurations/$default +Location : +MigrationState : Active +Name : myNamespace +PendingReplicationOperationsCount : +PostMigrationName : myPremiumNamespace +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetNamespace : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces + /myPremiumNamespace +``` + +Gets the details of migration configuration related to namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IMigrationConfigProperties + +## 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 <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusNamespace.md b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusNamespace.md new file mode 100644 index 0000000000..6362e73de7 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusNamespace.md @@ -0,0 +1,237 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/get-azservicebusnamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusNamespace.md +--- + +# Get-AzServiceBusNamespace + +## SYNOPSIS +Gets a description for the specified namespace. + +## SYNTAX + +### List (Default) +``` +Get-AzServiceBusNamespace [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzServiceBusNamespace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzServiceBusNamespace -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzServiceBusNamespace -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a description for the specified namespace. + +## EXAMPLES + +### Example 1: Gets a description for the specified namespace. +```powershell +$namespace = Get-AzServiceBusNamespace -ResourceGroupName myResourceGroup -Name myNamespace +``` + +```output +AlternateName : +CreatedAt : 11/22/2022 4:15:58 PM +DisableLocalAuth : False +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +IdentityType : UserAssigned +KeySource : Microsoft.KeyVault +KeyVaultProperty : {{ + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use + rAssignedIdentities/myFirstIdentity" + }, + "keyName": "key4", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }} +Location : East US +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : False +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Premium +SkuTier : Premium +Status : Active +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : { + } +TenantId : +Type : Microsoft.ServiceBus/Namespaces +UpdatedAt : 11/23/2022 7:14:58 AM +UserAssignedIdentity : { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity + /userAssignedIdentities/myThirdIdentity": { + }, + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity + /userAssignedIdentities/mySecondIdentity": { + }, + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity + /userAssignedIdentities/myFirstIdentity": { + } + } +ZoneRedundant : False +``` + +Get namespaces description from ResourceGroup. + +### Example 2: List all ServiceBus namespaces in a resource group. +```powershell +Get-AzServiceBusNamespace -ResourceGroupName myResourceGroup +``` + +Lists all ServiceBus namespaces under resource group `myResourceGroup`. + +### Example 3: List all ServiceBus namespaces in a subscription +```powershell +Get-AzServiceBusNamespace +``` + +Lists all ServiceBus namespaces in the current subscription context. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The namespace name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: NamespaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbNamespace + +## NOTES + +ALIASES + +Get-AzServiceBusNamespaceV2 + +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 <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusNetworkRuleSet.md b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusNetworkRuleSet.md new file mode 100644 index 0000000000..aaeaaa1776 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusNetworkRuleSet.md @@ -0,0 +1,172 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/get-azservicebusnetworkruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusNetworkRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusNetworkRuleSet.md +--- + +# Get-AzServiceBusNetworkRuleSet + +## SYNOPSIS +Gets NetworkRuleSet for a Namespace. + +## SYNTAX + +### Get (Default) +``` +Get-AzServiceBusNetworkRuleSet -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzServiceBusNetworkRuleSet -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzServiceBusNetworkRuleSet -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets NetworkRuleSet for a Namespace. + +## EXAMPLES + +### Example 1: Gets the network rule set of a ServiceBus namespace +```powershell +Get-AzServiceBusNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +```output +DefaultAction : Allow +IPRule : {} +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/networkRuleSets/default +Location : Central US +Name : default +PublicNetworkAccess : Enabled +ResourceGroupName : myResourceGroup +VirtualNetworkRule : +``` + +Gets the network rule set of ServiceBus namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.INetworkRuleSet + +## 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 <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusPrivateEndpointConnection.md b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusPrivateEndpointConnection.md new file mode 100644 index 0000000000..7b94081654 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusPrivateEndpointConnection.md @@ -0,0 +1,195 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/get-azservicebusprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusPrivateEndpointConnection.md +--- + +# Get-AzServiceBusPrivateEndpointConnection + +## SYNOPSIS +Gets a description for the specified Private Endpoint Connection. + +## SYNTAX + +### List (Default) +``` +Get-AzServiceBusPrivateEndpointConnection -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzServiceBusPrivateEndpointConnection -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzServiceBusPrivateEndpointConnection -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a description for the specified Private Endpoint Connection. + +## EXAMPLES + +### Example 1: Get a ServiceBus Namespace Private Endpoint Connection +```powershell +Get-AzServiceBusPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name 00000000000 +``` + +```output +ConnectionState : Approved +Description : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/privateEndpointC + onnections/00000000000 +Location : Australia East +Name : 00000000000 +PrivateEndpointId : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +``` + +Gets details of private endpoint connection `00000000000` created under ServiceBus namespace `myNamespace`. + +### Example 2: List all private endpoint connections on a ServiceBus namespace +```powershell +Get-AzServiceBusPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +Lists all private endpoint connections of ServiceBus namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The PrivateEndpointConnection name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PrivateEndpointConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IPrivateEndpointConnection + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusPrivateLink.md b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusPrivateLink.md new file mode 100644 index 0000000000..873fd46d71 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusPrivateLink.md @@ -0,0 +1,120 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/get-azservicebusprivatelink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusPrivateLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusPrivateLink.md +--- + +# Get-AzServiceBusPrivateLink + +## SYNOPSIS +Gets lists of resources that supports Privatelinks. + +## SYNTAX + +``` +Get-AzServiceBusPrivateLink -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets lists of resources that supports Privatelinks. + +## EXAMPLES + +### Example 1: Get private links associated with a ServiceBus namespace +```powershell +Get-AzServiceBusPrivateLink -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +```output +GroupId : namespace +Id : subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/privateLinkResources/namespace +Name : namespace +RequiredMember : {namespace} +RequiredZoneName : {privatelink.servicebus.windows.net} +Type : Microsoft.ServiceBus/namespaces/privateLinkResources +``` + +Gets private link resources available on ServiceBus namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IPrivateLinkResourcesListResult + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusQueue.md b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusQueue.md new file mode 100644 index 0000000000..1e9dba8ace --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusQueue.md @@ -0,0 +1,245 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/get-azservicebusqueue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusQueue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusQueue.md +--- + +# Get-AzServiceBusQueue + +## SYNOPSIS +Returns a description for the specified queue. + +## SYNTAX + +### List (Default) +``` +Get-AzServiceBusQueue -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Skip <Int32>] [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzServiceBusQueue -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzServiceBusQueue -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns a description for the specified queue. + +## EXAMPLES + +### Example 1: Get Details of a ServiceBus queue +```powershell +Get-AzServiceBusQueue -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myQueue +``` + +```output +AccessedAt : 1/1/0001 12:00:00 AM +AutoDeleteOnIdle : 10675199.02:48:05.4775807 +CountDetailActiveMessageCount : 0 +CountDetailDeadLetterMessageCount : 0 +CountDetailScheduledMessageCount : 0 +CountDetailTransferDeadLetterMessageCount : 0 +CountDetailTransferMessageCount : 0 +CreatedAt : 8/8/2022 10:15:08 AM +DeadLetteringOnMessageExpiration : False +DefaultMessageTimeToLive : 10675199.02:48:05.4775807 +DuplicateDetectionHistoryTimeWindow : 00:10:00 +EnableBatchedOperations : True +EnableExpress : False +EnablePartitioning : False +ForwardDeadLetteredMessagesTo : +ForwardTo : +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/queues/myQueue +Location : westus +LockDuration : 00:01:00 +MaxDeliveryCount : 10 +MaxMessageSizeInKilobytes : 1024 +MaxSizeInMegabytes : 1024 +MessageCount : 0 +Name : myQueue +RequiresDuplicateDetection : False +RequiresSession : False +ResourceGroupName : myResourceGroup +SizeInByte : 0 +Status : Disabled +``` + +Get the details of ServiceBus queue `myQueue` from namespace `myNamespace`. + +### Example 2: List all queues in a ServiceBus namespace +```powershell +Get-AzServiceBusQueue -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +Lists all queues in ServiceBus namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The queue name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: QueueName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +May be used to limit the number of results to the most recent N usageDetails. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skip is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbQueue + +## 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 <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusRule.md b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusRule.md new file mode 100644 index 0000000000..444d91eac1 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusRule.md @@ -0,0 +1,268 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/get-azservicebusrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusRule.md +--- + +# Get-AzServiceBusRule + +## SYNOPSIS +Retrieves the description for the specified rule. + +## SYNTAX + +### List (Default) +``` +Get-AzServiceBusRule -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + -SubscriptionName <String> -TopicName <String> [-Skip <Int32>] [-Top <Int32>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzServiceBusRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] -SubscriptionName <String> -TopicName <String> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzServiceBusRule -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the description for the specified rule. + +## EXAMPLES + +### Example 1: Get details of a ServiceBus Rule +```powershell +Get-AzServiceBusRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name '$Default' -TopicName myTopic -SubscriptionName mySubscription +``` + +```output +ActionCompatibilityLevel : +ActionRequiresPreprocessing : +ActionSqlExpression : +ContentType : +CorrelationFilterProperty : { + } +CorrelationFilterRequiresPreprocessing : +CorrelationId : +FilterType : SqlFilter +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic/subscriptions/mySubscription/rules/$Default +Label : +Location : westus +MessageId : +Name : $Default +ReplyTo : +ReplyToSessionId : +ResourceGroupName : myResourceGroup +SessionId : +SqlExpression : 1=1 +SqlFilterCompatibilityLevel : 20 +``` + +Gets the details of `$Default` rule from subscription `mySubscription` of topic `myTopic`. + +### Example 2: List all rules in a ServiceBus subscription +```powershell +Get-AzServiceBusRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -SubscriptionName mySubscription +``` + +Lists all rules in ServiceBus subscription `mySubscription`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The rule name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionName +The subscription name. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +May be used to limit the number of results to the most recent N usageDetails. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The topic name. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skip is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IRule + +## 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 <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusSubscription.md b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusSubscription.md new file mode 100644 index 0000000000..98ac7069e2 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusSubscription.md @@ -0,0 +1,261 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/get-azservicebussubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusSubscription.md +--- + +# Get-AzServiceBusSubscription + +## SYNOPSIS +Returns a subscription description for the specified topic. + +## SYNTAX + +### List (Default) +``` +Get-AzServiceBusSubscription -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + -TopicName <String> [-Skip <Int32>] [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzServiceBusSubscription -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] -TopicName <String> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzServiceBusSubscription -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns a subscription description for the specified topic. + +## EXAMPLES + +### Example 1: Get details of the ServiceBus subscription +```powershell +Get-AzServiceBusSubscription -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -Name 'sub$$D' +``` + +```output +AccessedAt : 1/1/0001 12:00:00 AM +AutoDeleteOnIdle : 1.00:03:04 +ClientId : +CountDetailActiveMessageCount : 0 +CountDetailDeadLetterMessageCount : 0 +CountDetailScheduledMessageCount : 0 +CountDetailTransferDeadLetterMessageCount : 0 +CountDetailTransferMessageCount : 0 +CreatedAt : 9/22/2022 6:17:32 AM +DeadLetteringOnFilterEvaluationException : False +DeadLetteringOnMessageExpiration : False +DefaultMessageTimeToLive : 14.00:00:00 +DuplicateDetectionHistoryTimeWindow : +EnableBatchedOperations : True +ForwardDeadLetteredMessagesTo : +ForwardTo : +Id : /subscriptions/326100e2-f69d-4268-8503-075374f62b6e/resourceGroups/damorg/providers/Microsoft.ServiceBus/namespaces/testlatestS + BMSI/topics/myTopic/subscriptions/sub$$D +IsClientAffine : True +IsDurable : True +IsShared : True +Location : westus +LockDuration : 00:00:30 +MaxDeliveryCount : 10 +MessageCount : 0 +Name : sub$$D +RequiresSession : False +ResourceGroupName : damorg +Status : Active +``` + +Get details of subcription `sub$$D` from ServiceBus topic `myTopic`. + +### Example 2: List all subscriptions in a topic +```powershell +Get-AzServiceBusSubscription -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic +``` + +List all subscriptions in ServiceBus topic `myTopic`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The subscription name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SubscriptionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +May be used to limit the number of results to the most recent N usageDetails. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The topic name. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skip is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbSubscription + +## 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 <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusTopic.md b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusTopic.md new file mode 100644 index 0000000000..06a231a00b --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Get-AzServiceBusTopic.md @@ -0,0 +1,235 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/get-azservicebustopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Get-AzServiceBusTopic.md +--- + +# Get-AzServiceBusTopic + +## SYNOPSIS +Returns a description for the specified topic. + +## SYNTAX + +### List (Default) +``` +Get-AzServiceBusTopic -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Skip <Int32>] [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzServiceBusTopic -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzServiceBusTopic -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns a description for the specified topic. + +## EXAMPLES + +### Example 1: Get the details of the ServiceBus topic +```powershell +Get-AzServiceBusTopic -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic +``` + +```output +AccessedAt : 9/21/2022 2:30:14 PM +AutoDeleteOnIdle : 3.00:00:00 +CreatedAt : 9/7/2022 10:05:52 AM +DefaultMessageTimeToLive : 10675197.00:00:00 +DuplicateDetectionHistoryTimeWindow : 00:10:00 +EnableBatchedOperations : True +EnableExpress : False +EnablePartitioning : False +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic +Location : westus +MaxMessageSizeInKilobytes : 1024 +MaxSizeInMegabytes : 1024 +Name : a +RequiresDuplicateDetection : False +ResourceGroupName : damorg +SizeInByte : 0 +Status : Active +SubscriptionCount : 2 +SupportOrdering : True +``` + +Get the details of ServiceBus topic `myTopic` from namespace `myNamespace`. + +### Example 2: List all topics in a ServiceBus namespace +```powershell +Get-AzServiceBusTopic -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +Lists all topics in ServiceBus namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The topic name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: TopicName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top +May be used to limit the number of results to the most recent N usageDetails. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skip is only used if a previous operation returned a partial result. +If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbTopic + +## 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 <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/New-AzServiceBusAuthorizationRule.md b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusAuthorizationRule.md new file mode 100644 index 0000000000..a317fcb24c --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusAuthorizationRule.md @@ -0,0 +1,270 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/new-azservicebusauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusAuthorizationRule.md +--- + +# New-AzServiceBusAuthorizationRule + +## SYNOPSIS +Creates a ServiceBus Namespace, Queue, Topic Authorization Rule + +## SYNTAX + +### NewExpandedNamespace (Default) +``` +New-AzServiceBusAuthorizationRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -Rights <AccessRights[]> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### NewExpandedQueue +``` +New-AzServiceBusAuthorizationRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -QueueName <String> -Rights <AccessRights[]> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewExpandedTopic +``` +New-AzServiceBusAuthorizationRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -TopicName <String> -Rights <AccessRights[]> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a ServiceBus Namespace, Queue, Topic Authorization Rule + +## EXAMPLES + +### Example 1: Create an authorization rule for a ServiceBus namespace +```powershell +New-AzServiceBusAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAuthRule -Rights @('Manage','Send','Listen') +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/authorizationRules/myAuthRule +Location : Central US +Name : myAuthRule +ResourceGroupName : myResourceGroup +Rights : {Listen, Manage, Send} +``` + +Creates a new authorization rule `myAuthRule` on namespace `myNamespace`. + +### Example 2: Create an authorization rule for a ServiceBus queue +```powershell +New-AzServiceBusAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -QueueName myQueue -Name myAuthRule -Rights @('Manage', 'Send', 'Listen') +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/queues/myQueue/authorizationRules/myAuthRule +Location : Central US +Name : myAuthRule +ResourceGroupName : myResourceGroup +Rights : {Listen, Manage, Send} +``` + +Creates a new authorization rule `myAuthRule` on ServiceBus queue `myQueue` from namespace `myNamespace`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Authorization Rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AuthorizationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of Service Bus namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueueName +The name of the Service Bus Queue. + +```yaml +Type: System.String +Parameter Sets: NewExpandedQueue +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rights +The rights associated with the rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.AccessRights[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The name of the Service Bus Topic. + +```yaml +Type: System.String +Parameter Sets: NewExpandedTopic +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbAuthorizationRule + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/New-AzServiceBusAuthorizationRuleSASToken.md b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusAuthorizationRuleSASToken.md new file mode 100644 index 0000000000..3af8e11092 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusAuthorizationRuleSASToken.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.dll-Help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/new-azservicebusauthorizationrulesastoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusAuthorizationRuleSASToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusAuthorizationRuleSASToken.md +--- + +# New-AzServiceBusAuthorizationRuleSASToken + +## SYNOPSIS +Generates a SAS token for Azure servicebus authorization rule of namespace/queue/topic. + +## SYNTAX + +``` +New-AzServiceBusAuthorizationRuleSASToken [-AuthorizationRuleId] <String> [-KeyType] <String> + [-ExpiryTime] <DateTime> [-StartTime <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzServiceBusAuthorizationRuleSASToken cmdlet generates a Shared Access Signature (SAS) token for an Azure Eventhub Namesapce or Azure Eventhub + +## EXAMPLES + +### Example 1 +```powershell +$StartTime = Get-Date +$EndTime = $StartTime.AddHours(2.0) +$SasToken = New-AzServiceBusAuthorizationRuleSASToken -AuthorizationRuleId $updatedAuthRule.Id -KeyType Primary -ExpiryTime $EndTime -StartTime $StartTime +``` + +Generate SAS token for the given authorization rule for Namespace with start and expiry time.. + +### Example 2 +```powershell +$StartTime = Get-Date +$EndTime = $StartTime.AddHours(2.0) +$SasToken = New-AzServiceBusAuthorizationRuleSASToken -AuthorizationRuleId $updatedAuthRule.Id -KeyType Primary -ExpiryTime $EndTime +``` + +Generate SAS token for the given authorization rule for Namespace with expiry time. + +## PARAMETERS + +### -AuthorizationRuleId +ARM ResourceId of the Authorization Rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Expiry Time + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyType +Key Type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +Start Time + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessSignatureAttributes + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/New-AzServiceBusGeoDRConfiguration.md b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusGeoDRConfiguration.md new file mode 100644 index 0000000000..0ae0cecd39 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusGeoDRConfiguration.md @@ -0,0 +1,201 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/new-azservicebusgeodrconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusGeoDRConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusGeoDRConfiguration.md +--- + +# New-AzServiceBusGeoDRConfiguration + +## SYNOPSIS +Creates or updates a new Alias(Disaster Recovery configuration) + +## SYNTAX + +``` +New-AzServiceBusGeoDRConfiguration -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AlternateName <String>] [-PartnerNamespace <String>] [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a new Alias(Disaster Recovery configuration) + +## EXAMPLES + +### Example 1: Create a disaster recovery Alias +```powershell +New-AzServiceBusGeoDRConfiguration -Name myAlias -ResourceGroupName myResourceGroup -NamespaceName myPrimaryNamespace -PartnerNamespace "/subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/mySecondaryNamespace" +``` + +```output +AlternateName : +Id : /subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myPrimaryNamespace/disasterRecoveryCon + figs/myAlias +Location : +Name : myAlias +PartnerNamespace : /subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/mySecondaryNamespace +PendingReplicationOperationsCount : +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +Role : Primary +``` + +Creates a Disaster Recovery configuration which sets `mySecondaryNamespace` as secondary to `myPrimaryNamespace`. + +## PARAMETERS + +### -AlternateName +Primary/Secondary eventhub namespace name, which is part of GEO DR pairing + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Disaster Recovery configuration name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerNamespace +ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IArmDisasterRecovery + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/New-AzServiceBusIPRuleConfig.md b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusIPRuleConfig.md new file mode 100644 index 0000000000..7d713bdab4 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusIPRuleConfig.md @@ -0,0 +1,84 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/new-azservicebusipruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusIPRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusIPRuleConfig.md +--- + +# New-AzServiceBusIPRuleConfig + +## SYNOPSIS +Constructs an INwRuleSetIPRules object that can be fed as input to Set-AzServiceBusNetworkRuleSet + +## SYNTAX + +``` +New-AzServiceBusIPRuleConfig -IPMask <String> [-Action <NetworkRuleIPAction>] [<CommonParameters>] +``` + +## DESCRIPTION +Constructs an INwRuleSetIPRules object that can be fed as input to Set-AzServiceBusNetworkRuleSet + +## EXAMPLES + +### Example 1: Constructs an INwRuleSetIPRules object +```powershell +New-AzServiceBusIPRuleConfig -IPMask 3.3.3.3 -Action Allow +``` + +```output +Action IPMask +------ ------ +Allow 1.1.1.1 +``` + +Please refer examples for Set-AzServiceBusNetworkRuleSet to know more. + +## PARAMETERS + +### -Action +The IP Filter Action + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.NetworkRuleIPAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPMask +IP Mask + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.INwRuleSetIPRules + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/New-AzServiceBusKey.md b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusKey.md new file mode 100644 index 0000000000..b2d396ecb3 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusKey.md @@ -0,0 +1,300 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/new-azservicebuskey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusKey.md +--- + +# New-AzServiceBusKey + +## SYNOPSIS +Regenerates the SASKey of a ServiceBus namespace, queue or topic. + +## SYNTAX + +### NewExpandedNamespace (Default) +``` +New-AzServiceBusKey -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -KeyType <KeyType> [-KeyValue <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewExpandedTopic +``` +New-AzServiceBusKey -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -TopicName <String> -KeyType <KeyType> [-KeyValue <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewExpandedQueue +``` +New-AzServiceBusKey -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -QueueName <String> -KeyType <KeyType> [-KeyValue <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerates the SASKey of a ServiceBus namespace, queue or topic. + +## EXAMPLES + +### Example 1: Regenerate Primary Key of a ServiceBus Namespace +```powershell +New-AzServiceBusKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name rootmanagesharedaccesskey -KeyType PrimaryKey +``` + +```output +KeyName : RootManageSharedAccessKey +PrimaryConnectionString : {primaryConnectionString} +PrimaryKey : {primaryKey} +SecondaryConnectionString : {secondaryConnectionString} +SecondaryKey : {secondaryKey} +``` + +Regenerate primary key of authorization rule `rootmanagesharedaccesskey` on ServiceBus Namespace `myNamespace`. + +### Example 2: Regenerate Secondary Key of a ServiceBus queue +```powershell +New-AzServiceBusKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -QueueName myQueue -Name rootmanagesharedaccesskey -KeyType SecondaryKey +``` + +```output +KeyName : RootManageSharedAccessKey +PrimaryConnectionString : {primaryConnectionString} +PrimaryKey : {primaryKey} +SecondaryConnectionString : {secondaryConnectionString} +SecondaryKey : {secondaryKey} +``` + +Regenerate secondary key of authorization rule `rootmanagesharedaccesskey` on ServiceBus queue `myQueue` from ServiceBus Namespace `myNamespace`. + +### Example 3: Regenerate Secondary Key of a ServiceBus topic +```powershell +New-AzServiceBusKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -Name rootmanagesharedaccesskey -KeyType SecondaryKey +``` + +```output +KeyName : RootManageSharedAccessKey +PrimaryConnectionString : {primaryConnectionString} +PrimaryKey : {primaryKey} +SecondaryConnectionString : {secondaryConnectionString} +SecondaryKey : {secondaryKey} +``` + +Regenerate secondary key of authorization rule `rootmanagesharedaccesskey` on ServiceBus topic `myTopic` from ServiceBus Namespace `myNamespace`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyType +The access key to regenerate. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.KeyType +Parameter Sets: (All) +Aliases: RegenerateKey + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyValue +Optional, if the key value provided, is set for KeyType or autogenerated Key value set for keyType + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Authorization Rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AuthorizationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of the ServiceBus namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueueName +The name of the ServiceBus queue. + +```yaml +Type: System.String +Parameter Sets: NewExpandedQueue +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The name of the ServiceBus topic. + +```yaml +Type: System.String +Parameter Sets: NewExpandedTopic +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IAccessKeys + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/New-AzServiceBusKeyVaultPropertiesObject.md b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusKeyVaultPropertiesObject.md new file mode 100644 index 0000000000..f89d6b8326 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusKeyVaultPropertiesObject.md @@ -0,0 +1,133 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/Az.ServiceBus/new-AzServiceBusKeyVaultPropertiesObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusKeyVaultPropertiesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusKeyVaultPropertiesObject.md +--- + +# New-AzServiceBusKeyVaultPropertiesObject + +## SYNOPSIS +Create an in-memory object for KeyVaultProperties. + +## SYNTAX + +``` +New-AzServiceBusKeyVaultPropertiesObject [-KeyName <String>] [-KeyVaultUri <String>] [-KeyVersion <String>] + [-UserAssignedIdentity <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for KeyVaultProperties. + +## EXAMPLES + +### Example 1: Construct an in-memory KeyVaultProperties object +```powershell +New-AzServiceBusKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://testkeyvault.vault.azure.net/ +``` + +```Output +KeyName KeyVaultUri KeyVersion UserAssignedIdentity +------- ----------- ---------- -------------------- +key4 https://testkeyvault.vault.azure.net/ +``` + +Creates an in-memory object of type `IKeyVaultProperties`. +An array of `IKeyVaultProperties` can be fed as +input to `KeyVaultProperty` parameter of New-AzServiceBusNamespaceV2 and Set-AzServiceBusNamespaceV2 to enable encryption. + +### Example 2: Construct an in-memory KeyVaultProperties object having UserassignedIdentity +```powershell +$ec1 = "/subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +New-AzServiceBusKeyVaultPropertiesObject -KeyName key4 -KeyVaultUri https://testkeyvault.vault.azure.net/ -UserAssignedIdentity $ec1 +``` + +```Output +KeyName KeyVaultUri KeyVersion UserAssignedIdentity +------- ----------- ---------- -------------------- +key4 https://testkeyvault.vault.azure.net/ /subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity +``` + +Creates an in-memory object of type `IKeyVaultProperties`. +An array of `IKeyVaultProperties` can be fed as +input to `KeyVaultProperty` parameter of New-AzServiceBusNamespaceV2 and Set-AzServiceBusNamespaceV2 to enable encryption. + +## PARAMETERS + +### -KeyName +Name of the Key from KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultUri +Uri of KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVersion +Version of KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +ARM ID of user Identity selected for encryption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.KeyVaultProperties + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/New-AzServiceBusNamespace.md b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusNamespace.md new file mode 100644 index 0000000000..d3e4e15875 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusNamespace.md @@ -0,0 +1,567 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/new-azservicebusnamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusNamespace.md +--- + +# New-AzServiceBusNamespace + +## SYNOPSIS +Creates a new ServiceBus namespace. + +## SYNTAX + +``` +New-AzServiceBusNamespace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + -Location <String> [-AlternateName <String>] [-DisableLocalAuth] [-KeyVaultProperty <IKeyVaultProperties[]>] + [-PremiumMessagingPartition <Int32>] [-RequireInfrastructureEncryption] + [-IdentityType <ManagedServiceIdentityType>] [-ZoneRedundant] [-UserAssignedIdentityId <String[]>] + [-MinimumTlsVersion <String>] [-PublicNetworkAccess <PublicNetworkAccess>] [-SkuName <SkuName>] + [-SkuCapacity <Int32>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new ServiceBus namespace. + +## EXAMPLES + +### Example 1: Create a new ServiceBus namespace with UserAssignedIdentity Encryption +```powershell +$id1 = "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$id2 = "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" +$keyVaultProperty1 = New-AzServiceBusKeyVaultPropertiesObject -KeyName key4 -KeyVaultUri https://testkeyvault.vault.azure.net/ -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$keyVaultProperty2 = New-AzServiceBusKeyVaultPropertiesObject -KeyName key5 -KeyVaultUri https://testkeyvault.vault.azure.net/ -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +New-AzServiceBusNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityID $id1,$id2 -KeyVaultProperty $keyVaultProperty1,$keyVaultProperty2 +``` + +```output +AlternateName : +CreatedAt : 11/21/2022 5:15:41 AM +DisableLocalAuth : False +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/provide + rs/Microsoft.ServiceBus/namespaces/myNamespace +IdentityType : UserAssigned +KeySource : Microsoft.KeyVault +KeyVaultProperty : {{ + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/reso + urceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity + " + }, + "keyName": "key4", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }, { + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000000/reso + urceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity + " + }, + "keyName": "key5", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }} +Location : North Europe +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : False +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Premium +SkuTier : Premium +Status : Active +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : { + } +TenantId : +Type : Microsoft.ServiceBus/Namespaces +UpdatedAt : 11/21/2022 5:23:01 AM +UserAssignedIdentity : { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/prov + iders/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + }, + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/prov + iders/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + } + } +ZoneRedundant : False +``` + +Creates a new Premium ServiceBus namespace with UserAssignedIdentity encryption. + +### Example 2: Create a new ServiceBus namespace with System Assigned Identity enabled. +```powershell +New-AzServiceBusNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType SystemAssigned +``` + +```output +AlternateName : +CreatedAt : 11/21/2022 5:33:10 AM +DisableLocalAuth : False +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/provide + rs/Microsoft.ServiceBus/namespaces/myNamespace +IdentityType : SystemAssigned +KeySource : +KeyVaultProperty : +Location : North Europe +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : 000000000000 +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Premium +SkuTier : Premium +Status : Active +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : { + } +TenantId : 000000000000000 +Type : Microsoft.ServiceBus/Namespaces +UpdatedAt : 11/21/2022 5:40:18 AM +UserAssignedIdentity : { + } +ZoneRedundant : False +``` + +Create an ServiceBus namespace with SystemAssigned identity. + +### Example 3: Create a new Standard ServiceBus namespace with DisableLocalAuth enabled +```powershell +New-AzServiceBusNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Standard -Location southcentralus -Tag @{k1='v1'; k2='v2'} -DisableLocalAuth +``` + +```output +AlternateName : +CreatedAt : 11/18/2022 6:06:22 AM +DisableLocalAuth : True +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +IdentityType : +KeySource : +KeyVaultProperty : +Location : South Central US +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.1 +Name : myNamespace +PrincipalId : +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : +SkuName : Standard +SkuTier : Standard +Status : Active +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : { + "k1": "v1", + "k2": "v2" + } +TenantId : +Type : Microsoft.ServiceBus/Namespaces +UpdatedAt : 11/18/2022 6:07:06 AM +UserAssignedIdentity : { + } +ZoneRedundant : False +``` + +Create a standard ServiceBus namespace `myNamespace` with DisableLocalAuth enabled. + +## PARAMETERS + +### -AlternateName +Alternate name for namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +This property disables SAS authentication for the Service Bus namespace. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultProperty +Properties of KeyVault +To construct, see NOTES section for KEYVAULTPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IKeyVaultProperties[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource Location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +The minimum TLS version for the cluster to support, e.g. +'1.2' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of ServiceBusNamespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PremiumMessagingPartition +The number of partitions of a Service Bus namespace. +This property is only applicable to Premium SKU namespaces. +The default value is 1 and possible values are 1, 2 and 4 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +This determines if traffic is allowed over public network. +By default it is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireInfrastructureEncryption +Enable Infrastructure Encryption (Double Encryption) + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the ResourceGroupName. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +The specified messaging units for the tier. +For Premium tier, capacity are 1,2 and 4. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name of this SKU. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.SkuName +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +Properties for User Assigned Identities + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbNamespace + +## NOTES + +ALIASES + +New-AzServiceBusNamespaceV2 + +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. + + +`KEYVAULTPROPERTY <IKeyVaultProperties[]>`: Properties of KeyVault + - `[KeyName <String>]`: Name of the Key from KeyVault + - `[KeyVaultUri <String>]`: Uri of KeyVault + - `[KeyVersion <String>]`: Version of KeyVault + - `[UserAssignedIdentity <String>]`: ARM ID of user Identity selected for encryption + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/New-AzServiceBusQueue.md b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusQueue.md new file mode 100644 index 0000000000..1f549318b0 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusQueue.md @@ -0,0 +1,446 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/new-azservicebusqueue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusQueue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusQueue.md +--- + +# New-AzServiceBusQueue + +## SYNOPSIS +Creates or updates a Service Bus queue. +This operation is idempotent. + +## SYNTAX + +``` +New-AzServiceBusQueue -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AutoDeleteOnIdle <TimeSpan>] [-DeadLetteringOnMessageExpiration] + [-DefaultMessageTimeToLive <TimeSpan>] [-DuplicateDetectionHistoryTimeWindow <TimeSpan>] + [-EnableBatchedOperations] [-EnableExpress] [-EnablePartitioning] [-ForwardDeadLetteredMessagesTo <String>] + [-ForwardTo <String>] [-LockDuration <TimeSpan>] [-MaxDeliveryCount <Int32>] + [-MaxMessageSizeInKilobytes <Int64>] [-MaxSizeInMegabytes <Int32>] [-RequiresDuplicateDetection] + [-RequiresSession] [-Status <EntityStatus>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a Service Bus queue. +This operation is idempotent. + +## EXAMPLES + +### Example 1: Create a new ServiceBus queue +```powershell +New-AzServiceBusQueue -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myQueue -AutoDeleteOnIdle (New-TimeSpan -Days 1 -Minutes 3 -Seconds 4) -DefaultMessageTimeToLive (New-TimeSpan -Days 5) -EnablePartitioning +``` + +```output +AccessedAt : 1/1/0001 12:00:00 AM +AutoDeleteOnIdle : 1.00:03:04 +CountDetailActiveMessageCount : 0 +CountDetailDeadLetterMessageCount : 0 +CountDetailScheduledMessageCount : 0 +CountDetailTransferDeadLetterMessageCount : 0 +CountDetailTransferMessageCount : 0 +CreatedAt : 9/22/2022 12:30:45 PM +DeadLetteringOnMessageExpiration : False +DefaultMessageTimeToLive : 5.00:00:00 +DuplicateDetectionHistoryTimeWindow : 00:10:00 +EnableBatchedOperations : True +EnableExpress : False +EnablePartitioning : True +ForwardDeadLetteredMessagesTo : +ForwardTo : +Id : /subscriptions/326100e2-f69d-4268-8503-075374f62b6e/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/queues/myQueue +Location : westus +LockDuration : 00:01:00 +MaxDeliveryCount : 10 +MaxMessageSizeInKilobytes : 1024 +MaxSizeInMegabytes : 1024 +MessageCount : 0 +Name : myQueue +RequiresDuplicateDetection : False +RequiresSession : False +ResourceGroupName : myResourceGroup +SizeInByte : 0 +Status : Active +``` + +Creates a ServiceBus queue `myQueue` in namespace `myNamespace`. + +## PARAMETERS + +### -AutoDeleteOnIdle +Idle interval after which the queue is automatically deleted. +The minimum duration is 5 minutes. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeadLetteringOnMessageExpiration +A value that indicates whether this queue has dead letter support when a message expires. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMessageTimeToLive +This is the duration after which the message expires, starting from when the message is sent to Service Bus. +This is the default value used when TimeToLive is not set on a message itself. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DuplicateDetectionHistoryTimeWindow +Defines the duration of the duplicate detection history. +The default value is 10 minutes. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBatchedOperations +Value that indicates whether server-side batched operations are enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExpress +A value that indicates whether Express Entities are enabled. +An express queue holds a message in memory temporarily before writing it to persistent storage. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePartitioning +A value that indicates whether the queue is to be partitioned across multiple message brokers. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardDeadLetteredMessagesTo +Queue/Topic name to forward the Dead Letter message + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardTo +Queue/Topic name to forward the messages + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LockDuration +Timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. +The maximum value for LockDuration is 5 minutes; the default value is 1 minute. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxDeliveryCount +The maximum delivery count. +A message is automatically deadlettered after this number of deliveries. +default value is 10. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxMessageSizeInKilobytes +Maximum size (in KB) of the message payload that can be accepted by the queue. +This property is only used in Premium today and default is 1024. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSizeInMegabytes +The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. +Default is 1024. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The queue name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: QueueName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiresDuplicateDetection +A value indicating if this queue requires duplicate detection. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiresSession +A value that indicates whether the queue supports the concept of sessions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Enumerates the possible values for the status of a messaging entity. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.EntityStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbQueue + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/New-AzServiceBusRule.md b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusRule.md new file mode 100644 index 0000000000..920ad3f88f --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusRule.md @@ -0,0 +1,477 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/new-azservicebusrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusRule.md +--- + +# New-AzServiceBusRule + +## SYNOPSIS +Creates a new rule and updates an existing rule + +## SYNTAX + +``` +New-AzServiceBusRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + -SubscriptionName <String> -TopicName <String> [-SubscriptionId <String>] [-ActionRequiresPreprocessing] + [-ActionSqlExpression <String>] [-ContentType <String>] [-CorrelationFilterProperty <Hashtable>] + [-CorrelationFilterRequiresPreprocessing] [-CorrelationId <String>] [-FilterType <FilterType>] + [-Label <String>] [-MessageId <String>] [-ReplyTo <String>] [-ReplyToSessionId <String>] [-SessionId <String>] + [-SqlExpression <String>] [-SqlFilterRequiresPreprocessing] [-To <String>] [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new rule and updates an existing rule + +## EXAMPLES + +### Example 1: Create a Correlation Filter +```powershell +New-AzServiceBusRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -SubscriptionName mySubscription -Name myCorrelationRule -FilterType CorrelationFilter -ContentType contenttype -CorrelationFilterProperty @{a='b';c='d'} -SessionId sessionid -CorrelationId correlationid -MessageId messageid -Label label -ReplyTo replyto -ReplyToSessionId replytosessionid +``` + +```output +ActionCompatibilityLevel : +ActionRequiresPreprocessing : +ActionSqlExpression : +ContentType : contenttype +CorrelationFilterProperty : { + "c": "d", + "a": "b" + } +CorrelationFilterRequiresPreprocessing : +CorrelationId : correlationid +FilterType : CorrelationFilter +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic/subscriptions/mySubscription/rules/myCorrelationRule +Label : label +Location : westus +MessageId : messageid +Name : myCorrelationRule +ReplyTo : replyto +ReplyToSessionId : replytosessionid +ResourceGroupName : myResourceGroup +SessionId : sessionid +SqlExpression : +SqlFilterCompatibilityLevel : +``` + +Create a correlation filter `myCorrelationRule` in ServiceBus subscription `mySubscription`. + +### Example 2: Create a Sql Filter +```powershell +New-AzServiceBusRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -SubscriptionName mySubscription -Name mySqlRule -FilterType SqlFilter -SqlExpression 3=2 -ActionSqlExpression "SET a=b" +``` + +```output +ActionCompatibilityLevel : 20 +ActionRequiresPreprocessing : +ActionSqlExpression : SET a=b +ContentType : +CorrelationFilterProperty : { + } +CorrelationFilterRequiresPreprocessing : +CorrelationId : +FilterType : SqlFilter +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic/subscriptions/mySubscription/rules/mySqlRule +Label : +Location : westus +MessageId : +Name : mySqlRule +ReplyTo : +ReplyToSessionId : +ResourceGroupName : myResourceGroup +SessionId : +SqlExpression : 3=2 +SqlFilterCompatibilityLevel : 20 +SqlFilterRequiresPreprocessing : +``` + +Create a sql filter `mySqlRule` in ServiceBus subscription `mySubscription`. + +## PARAMETERS + +### -ActionRequiresPreprocessing +Value that indicates whether the rule action requires preprocessing. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActionSqlExpression +SQL expression. +e.g. +MyProperty='ABC' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentType +Content type of the message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorrelationFilterProperty +dictionary object for custom filters + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorrelationFilterRequiresPreprocessing +Value that indicates whether the rule action requires preprocessing. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorrelationId +Identifier of the correlation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterType +Filter type that is evaluated against a BrokeredMessage. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.FilterType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +Application specific label. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId +Identifier of the message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The rule name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyTo +Address of the queue to reply to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyToSessionId +Session identifier to reply to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionId +Session identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlExpression +The SQL expression. +e.g. +MyProperty='ABC' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlFilterRequiresPreprocessing +Value that indicates whether the rule action requires preprocessing. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionName +The subscription name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -To +Address to send to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The topic name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IRule + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/New-AzServiceBusSubscription.md b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusSubscription.md new file mode 100644 index 0000000000..cb20e2cfc2 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusSubscription.md @@ -0,0 +1,453 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/new-azservicebussubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusSubscription.md +--- + +# New-AzServiceBusSubscription + +## SYNOPSIS +Creates a topic subscription. + +## SYNTAX + +``` +New-AzServiceBusSubscription -Name <String> -NamespaceName <String> -ResourceGroupName <String> + -TopicName <String> [-SubscriptionId <String>] [-AutoDeleteOnIdle <TimeSpan>] [-ClientId <String>] + [-DeadLetteringOnFilterEvaluationException] [-DeadLetteringOnMessageExpiration] + [-DefaultMessageTimeToLive <TimeSpan>] [-DuplicateDetectionHistoryTimeWindow <TimeSpan>] + [-EnableBatchedOperations] [-ForwardDeadLetteredMessagesTo <String>] [-ForwardTo <String>] [-IsClientAffine] + [-IsDurable] [-IsShared] [-LockDuration <TimeSpan>] [-MaxDeliveryCount <Int32>] [-RequiresSession] + [-Status <EntityStatus>] [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a topic subscription. + +## EXAMPLES + +### Example 1: Create a new ServiceBus subscription +```powershell +New-AzServiceBusSubscription -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -Name mySubscription -DefaultMessageTimeToLive (New-TimeSpan -Days 6) -EnableBatchedOperations +``` + +```output +AccessedAt : 1/1/0001 12:00:00 AM +AutoDeleteOnIdle : 10675199.02:48:05.4775807 +ClientId : +CountDetailActiveMessageCount : 0 +CountDetailDeadLetterMessageCount : 0 +CountDetailScheduledMessageCount : 0 +CountDetailTransferDeadLetterMessageCount : 0 +CountDetailTransferMessageCount : 0 +CreatedAt : 9/23/2022 2:37:46 PM +DeadLetteringOnFilterEvaluationException : True +DeadLetteringOnMessageExpiration : False +DefaultMessageTimeToLive : 6.00:00:00 +DuplicateDetectionHistoryTimeWindow : +EnableBatchedOperations : True +ForwardDeadLetteredMessagesTo : +ForwardTo : +Id : /subscriptions/326100e2-f69d-4268-8503-075374f62b6e/resourceGroups/damorg/providers/Microsoft.ServiceBus/namespaces/testlatests + bmsi/topics/a/subscriptions/testsub +IsClientAffine : False +IsDurable : +IsShared : +Location : westus +LockDuration : 00:01:00 +MaxDeliveryCount : 10 +MessageCount : 0 +Name : testsub +RequiresSession : False +ResourceGroupName : damorg +Status : Active +``` + +Creates a new ServiceBus subscription `mySubscription` under topic `myTopic`. + +## PARAMETERS + +### -AutoDeleteOnIdle +Idle interval after which the queue is automatically deleted. +The minimum duration is 5 minutes. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientId +Indicates the Client ID of the application that created the client-affine subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeadLetteringOnFilterEvaluationException +Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeadLetteringOnMessageExpiration +Value that indicates whether a subscription has dead letter support when a message expires. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMessageTimeToLive +This is the duration after which the message expires, starting from when the message is sent to Service Bus. +This is the default value used when TimeToLive is not set on a message itself. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DuplicateDetectionHistoryTimeWindow +Defines the duration of the duplicate detection history. +The default value is 10 minutes. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBatchedOperations +Value that indicates whether server-side batched operations are enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardDeadLetteredMessagesTo +Queue/Topic name to forward the Dead Letter message + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardTo +Queue/Topic name to forward the messages + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsClientAffine +Value that indicates whether the subscription has an affinity to the client id. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDurable +For client-affine subscriptions, this value indicates whether the subscription is durable or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsShared +For client-affine subscriptions, this value indicates whether the subscription is shared or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LockDuration +Timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. +The maximum value for LockDuration is 5 minutes; the default value is 1 minute. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxDeliveryCount +Number of maximum deliveries. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The subscription name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SubscriptionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiresSession +Value indicating if a subscription supports the concept of sessions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Enumerates the possible values for the status of a messaging entity. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.EntityStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The topic name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbSubscription + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/New-AzServiceBusTopic.md b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusTopic.md new file mode 100644 index 0000000000..dfb3a6e26a --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusTopic.md @@ -0,0 +1,359 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/new-azservicebustopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusTopic.md +--- + +# New-AzServiceBusTopic + +## SYNOPSIS +Creates a topic in the specified namespace. + +## SYNTAX + +``` +New-AzServiceBusTopic -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AutoDeleteOnIdle <TimeSpan>] [-DefaultMessageTimeToLive <TimeSpan>] + [-DuplicateDetectionHistoryTimeWindow <TimeSpan>] [-EnableBatchedOperations] [-EnableExpress] + [-EnablePartitioning] [-MaxMessageSizeInKilobytes <Int64>] [-MaxSizeInMegabytes <Int32>] + [-RequiresDuplicateDetection] [-Status <EntityStatus>] [-SupportOrdering] [-DefaultProfile <PSObject>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a topic in the specified namespace. + +## EXAMPLES + +### Example 1: Creates a new ServiceBus topic +```powershell +New-AzServiceBusTopic -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myTopic -DefaultMessageTimeToLive (New-TimeSpan -Days 18) -EnableBatchedOperations +``` + +```output +AccessedAt : 1/1/0001 12:00:00 AM +AutoDeleteOnIdle : 10675199.02:48:05.4775807 +CountDetailActiveMessageCount : 0 +CountDetailDeadLetterMessageCount : 0 +CountDetailScheduledMessageCount : 0 +CountDetailTransferDeadLetterMessageCount : 0 +CountDetailTransferMessageCount : 0 +CreatedAt : 1/1/0001 12:00:00 AM +DefaultMessageTimeToLive : 18.00:00:00 +DuplicateDetectionHistoryTimeWindow : 00:10:00 +EnableBatchedOperations : True +EnableExpress : False +EnablePartitioning : False +Id : /subscriptions/000000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic +Location : westus +MaxMessageSizeInKilobytes : 1024 +MaxSizeInMegabytes : 1024 +Name : myTopic +RequiresDuplicateDetection : False +ResourceGroupName : myResourceGroup +SizeInByte : 0 +Status : Active +SubscriptionCount : 0 +SupportOrdering : True +``` + +Creates a new ServiceBus topic `myTopic` within namespace `myNamespace`. + +## PARAMETERS + +### -AutoDeleteOnIdle +Idle interval after which the queue is automatically deleted. +The minimum duration is 5 minutes. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMessageTimeToLive +This is the duration after which the message expires, starting from when the message is sent to Service Bus. +This is the default value used when TimeToLive is not set on a message itself. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DuplicateDetectionHistoryTimeWindow +Defines the duration of the duplicate detection history. +The default value is 10 minutes. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBatchedOperations +Value that indicates whether server-side batched operations are enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExpress +Value that indicates whether Express Entities are enabled. +An express topic holds a message in memory temporarily before writing it to persistent storage. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePartitioning +Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxMessageSizeInKilobytes +Maximum size (in KB) of the message payload that can be accepted by the topic. +This property is only used in Premium today and default is 1024. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSizeInMegabytes +Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. +Default is 1024. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The topic name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TopicName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiresDuplicateDetection +Value indicating if this topic requires duplicate detection. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Enumerates the possible values for the status of a messaging entity. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.EntityStatus +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportOrdering +Value that indicates whether the topic supports ordering. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbTopic + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/New-AzServiceBusVirtualNetworkRuleConfig.md b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusVirtualNetworkRuleConfig.md new file mode 100644 index 0000000000..983b076c51 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/New-AzServiceBusVirtualNetworkRuleConfig.md @@ -0,0 +1,85 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/new-azservicebusvirtualnetworkruleconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusVirtualNetworkRuleConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/New-AzServiceBusVirtualNetworkRuleConfig.md +--- + +# New-AzServiceBusVirtualNetworkRuleConfig + +## SYNOPSIS +Constructs an INwRuleSetIPRules object that can be fed as input to Set-AzServiceBusNetworkRuleSet + +## SYNTAX + +``` +New-AzServiceBusVirtualNetworkRuleConfig -SubnetId <String> [-IgnoreMissingVnetServiceEndpoint] + [<CommonParameters>] +``` + +## DESCRIPTION +Constructs an INwRuleSetIPRules object that can be fed as input to Set-AzServiceBusNetworkRuleSet + +## EXAMPLES + +### Example 1: Constructs an INwRuleSetVirtualNetworkRules object +```powershell +New-AzServiceBusVirtualNetworkRuleConfig -SubnetId /subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default +``` + +```output +IgnoreMissingVnetServiceEndpoint SubnetId +-------------------------------- -------- + /subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default +``` + +Please refer examples for Set-AzServiceBusNetworkRuleSet to know more. + +## PARAMETERS + +### -IgnoreMissingVnetServiceEndpoint +Resource ID of Virtual Network Subnet + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Resource ID of Virtual Network Subnet + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.INwRuleSetVirtualNetworkRules + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusAuthorizationRule.md b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusAuthorizationRule.md new file mode 100644 index 0000000000..070dd3526a --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusAuthorizationRule.md @@ -0,0 +1,282 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/remove-azservicebusauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusAuthorizationRule.md +--- + +# Remove-AzServiceBusAuthorizationRule + +## SYNOPSIS +Removes the Authorization Rule of a ServiceBus Namespace, Queue or Topic + +## SYNTAX + +### RemoveExpandedNamespace (Default) +``` +Remove-AzServiceBusAuthorizationRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RemoveExpandedQueue +``` +Remove-AzServiceBusAuthorizationRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -QueueName <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### RemoveExpandedTopic +``` +Remove-AzServiceBusAuthorizationRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -TopicName <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### RemoveViaIdentityExpanded +``` +Remove-AzServiceBusAuthorizationRule -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removes the Authorization Rule of a ServiceBus Namespace, Queue or Topic + +## EXAMPLES + +### Example 1: Remove an authorization rule from a ServiceBus namespace +```powershell +Remove-AzServiceBusAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAuthRule +``` + +Deletes authorization rule `myAuthRule` from ServiceBus namespace `myNamespace`. + +### Example 2: Remove an authorization rule from a ServiceBus queue +```powershell +Remove-AzServiceBusAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -QueueName myQueue -Name myAuthRule +``` + +Deletes authorization rule `myAuthRule` from ServiceBus `myQueue` on namespace `myNamespace`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: RemoveViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Authorization Rule + +```yaml +Type: System.String +Parameter Sets: RemoveExpandedNamespace, RemoveExpandedQueue, RemoveExpandedTopic +Aliases: AuthorizationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of Service Bus namespace + +```yaml +Type: System.String +Parameter Sets: RemoveExpandedNamespace, RemoveExpandedQueue, RemoveExpandedTopic +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueueName +The name of the ServiceBus Queue entity. + +```yaml +Type: System.String +Parameter Sets: RemoveExpandedQueue +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: RemoveExpandedNamespace, RemoveExpandedQueue, RemoveExpandedTopic +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: RemoveExpandedNamespace, RemoveExpandedQueue, RemoveExpandedTopic +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The name of the ServiceBus Topic entity. + +```yaml +Type: System.String +Parameter Sets: RemoveExpandedTopic +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbAuthorizationRule + +## 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 <IServiceBusIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusGeoDRConfiguration.md b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusGeoDRConfiguration.md new file mode 100644 index 0000000000..54b6fa7a63 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusGeoDRConfiguration.md @@ -0,0 +1,216 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/remove-azservicebusgeodrconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusGeoDRConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusGeoDRConfiguration.md +--- + +# Remove-AzServiceBusGeoDRConfiguration + +## SYNOPSIS +Deletes an Alias(Disaster Recovery configuration) + +## SYNTAX + +### Delete (Default) +``` +Remove-AzServiceBusGeoDRConfiguration -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzServiceBusGeoDRConfiguration -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an Alias(Disaster Recovery configuration) + +## EXAMPLES + +### Example 1: Remove Disaster Recovery Config from a ServiceBus namespace +```powershell +Remove-AzServiceBusGeoDRConfiguration -Name myAlias -ResourceGroupName myResourceGroup -NamespaceName myPrimaryNamespace +``` + +Deletes alias `myAlias` from ServiceBus namespace `myPrimaryNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Disaster Recovery configuration name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusMigration.md b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusMigration.md new file mode 100644 index 0000000000..048e9546a4 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusMigration.md @@ -0,0 +1,201 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/remove-azservicebusmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusMigration.md +--- + +# Remove-AzServiceBusMigration + +## SYNOPSIS +Deletes a MigrationConfiguration + +## SYNTAX + +### Delete (Default) +``` +Remove-AzServiceBusMigration -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzServiceBusMigration -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a MigrationConfiguration + +## EXAMPLES + +### Example 1: Remove Standard to Premium migration configuration from a Standard namespace +```powershell +Remove-AzServiceBusMigration -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +Removes migration configuration of namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusNamespace.md b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusNamespace.md new file mode 100644 index 0000000000..138ad15659 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusNamespace.md @@ -0,0 +1,243 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/remove-azservicebusnamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusNamespace.md +--- + +# Remove-AzServiceBusNamespace + +## SYNOPSIS +Deletes an existing namespace. +This operation also removes all associated resources under the namespace. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzServiceBusNamespace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzServiceBusNamespace -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing namespace. +This operation also removes all associated resources under the namespace. + +## EXAMPLES + +### Example 1: Deletes an existing namespace. +```powershell +Remove-AzServiceBusNamespace -ResourceGroupName myResourceGroup -Name myNamespace +``` + +Deletes an ServiceBus namespace `myNamespace` under resource group `myResourceGroup`. + +### Example 2: Delete an ServiceBus namespace using InputObject parameter set +```powershell +$namespace = Get-AzServiceBusNamespace -ResourceGroupName myResourceGroup -Name myNamespace +Remove-AzServiceBusNamespace -InputObject $namespace +``` + +Deletes an ServiceBus namespace `myNamespace` under resource group `myResourceGroup` using InputObject parameter set. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: NamespaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +Remove-AzServiceBusNamespaceV2 + +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 <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusPrivateEndpointConnection.md b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusPrivateEndpointConnection.md new file mode 100644 index 0000000000..84feaaefd4 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusPrivateEndpointConnection.md @@ -0,0 +1,247 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/remove-azservicebusprivateendpointconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusPrivateEndpointConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusPrivateEndpointConnection.md +--- + +# Remove-AzServiceBusPrivateEndpointConnection + +## SYNOPSIS +Deletes an existing Private Endpoint Connection. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzServiceBusPrivateEndpointConnection -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzServiceBusPrivateEndpointConnection -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing Private Endpoint Connection. + +## EXAMPLES + +### Example 1: Remove a private endpoint connection from a ServiceBus namespace +```powershell +Remove-AzServiceBusPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name 00000000000 +``` + +Deletes private endpoint connection `00000000000` from a ServiceBus namespace `myNamespace`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The PrivateEndpointConnection name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: PrivateEndpointConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusQueue.md b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusQueue.md new file mode 100644 index 0000000000..cb43528d50 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusQueue.md @@ -0,0 +1,216 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/remove-azservicebusqueue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusQueue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusQueue.md +--- + +# Remove-AzServiceBusQueue + +## SYNOPSIS +Deletes a queue from the specified namespace in a resource group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzServiceBusQueue -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzServiceBusQueue -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a queue from the specified namespace in a resource group. + +## EXAMPLES + +### Example 1: Remove a queue from a ServiceBus namespace +```powershell +Remove-AzServiceBusQueue -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myQueue +``` + +Deletes a ServiceBus queue `myQueue` from ServiceBus namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The queue name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: QueueName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusRule.md b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusRule.md new file mode 100644 index 0000000000..48c7ec7b75 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusRule.md @@ -0,0 +1,247 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/remove-azservicebusrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusRule.md +--- + +# Remove-AzServiceBusRule + +## SYNOPSIS +Deletes an existing rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzServiceBusRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -SubscriptionName <String> -TopicName <String> [-DefaultProfile <PSObject>] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzServiceBusRule -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an existing rule. + +## EXAMPLES + +### Example 1: Remove a rule from a ServiceBus subscription +```powershell +Remove-AzServiceBusRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -SubscriptionName mySubscription -Name myRule +``` + +Deletes a ServiceBus rule `myRule` from ServiceBus subscription `mySubscription`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The rule name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: RuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionName +The subscription name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The topic name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusSubscription.md b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusSubscription.md new file mode 100644 index 0000000000..4a97cad25e --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusSubscription.md @@ -0,0 +1,232 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/remove-azservicebussubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusSubscription.md +--- + +# Remove-AzServiceBusSubscription + +## SYNOPSIS +Deletes a subscription from the specified topic. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzServiceBusSubscription -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -TopicName <String> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzServiceBusSubscription -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a subscription from the specified topic. + +## EXAMPLES + +### Example 1: Remove a subscription from a ServiceBus topic +```powershell +Remove-AzServiceBusSubscription -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -Name mySubscription +``` + +Deletes a ServiceBus subscription `mySubscription` from ServiceBus topic `myTopic`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The subscription name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SubscriptionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The topic name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusTopic.md b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusTopic.md new file mode 100644 index 0000000000..26d0090db2 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Remove-AzServiceBusTopic.md @@ -0,0 +1,216 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/remove-azservicebustopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Remove-AzServiceBusTopic.md +--- + +# Remove-AzServiceBusTopic + +## SYNOPSIS +Deletes a topic from the specified namespace and resource group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzServiceBusTopic -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzServiceBusTopic -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a topic from the specified namespace and resource group. + +## EXAMPLES + +### Example 1: Remove a topic from a ServiceBus namespace +```powershell +Remove-AzServiceBusTopic -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myTopic +``` + +Deletes a ServiceBus topic `myTopic` from ServiceBus namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The topic name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: TopicName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusAuthorizationRule.md b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusAuthorizationRule.md new file mode 100644 index 0000000000..aef73a6b59 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusAuthorizationRule.md @@ -0,0 +1,315 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/set-azservicebusauthorizationrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusAuthorizationRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusAuthorizationRule.md +--- + +# Set-AzServiceBusAuthorizationRule + +## SYNOPSIS +Updates the authorization rule of a ServiceBus namespace, queue or topic. + +## SYNTAX + +### SetExpandedNamespace (Default) +``` +Set-AzServiceBusAuthorizationRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -Rights <AccessRights[]> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetExpandedTopic +``` +Set-AzServiceBusAuthorizationRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -TopicName <String> -Rights <AccessRights[]> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetExpandedQueue +``` +Set-AzServiceBusAuthorizationRule -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -QueueName <String> -Rights <AccessRights[]> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzServiceBusAuthorizationRule -InputObject <IServiceBusIdentity> -Rights <AccessRights[]> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the authorization rule of a ServiceBus namespace, queue or topic. + +## EXAMPLES + +### Example 1: Update an authorization rule for a ServiceBus namespace +```powershell +Set-AzServiceBusAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAuthRule -Rights @('Manage','Send','Listen') +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/authorizationRules/myAuthRule +Location : Central US +Name : myAuthRule +ResourceGroupName : myResourceGroup +Rights : {Listen, Manage, Send} +``` + +Creates a new authorization rule `myAuthRule` on namespace `myNamespace`. + +### Example 2: Update an authorization rule for a ServiceBus queue +```powershell +Set-AzServiceBusAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -QueueName myQueue -Name myAuthRule -Rights @('Manage', 'Send', 'Listen') +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/queues/myQueue/authorizationRules/myAuthRule +Location : Central US +Name : myAuthRule +ResourceGroupName : myResourceGroup +Rights : {Listen, Manage, Send} +``` + +Creates a new authorization rule `myAuthRule` on ServiceBus queue `myQueue` from namespace `myNamespace` + +. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Authorization Rule + +```yaml +Type: System.String +Parameter Sets: SetExpandedNamespace, SetExpandedTopic, SetExpandedQueue +Aliases: AuthorizationRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of the ServiceBus namespace. + +```yaml +Type: System.String +Parameter Sets: SetExpandedNamespace, SetExpandedTopic, SetExpandedQueue +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueueName +The name of the ServiceBus queue. + +```yaml +Type: System.String +Parameter Sets: SetExpandedQueue +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpandedNamespace, SetExpandedTopic, SetExpandedQueue +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rights +The rights associated with the rule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.AccessRights[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SetExpandedNamespace, SetExpandedTopic, SetExpandedQueue +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The name of the ServiceBus topic. + +```yaml +Type: System.String +Parameter Sets: SetExpandedTopic +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbAuthorizationRule + +## 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 <IServiceBusIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusGeoDRConfigurationBreakPair.md b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusGeoDRConfigurationBreakPair.md new file mode 100644 index 0000000000..9f3dbab57b --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusGeoDRConfigurationBreakPair.md @@ -0,0 +1,231 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/set-azservicebusgeodrconfigurationbreakpair +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusGeoDRConfigurationBreakPair.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusGeoDRConfigurationBreakPair.md +--- + +# Set-AzServiceBusGeoDRConfigurationBreakPair + +## SYNOPSIS +This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces + +## SYNTAX + +### Break (Default) +``` +Set-AzServiceBusGeoDRConfigurationBreakPair -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BreakViaIdentity +``` +Set-AzServiceBusGeoDRConfigurationBreakPair -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces + +## EXAMPLES + +### Example 1: Break Pairing between Primary and Secondary namespace +```powershell +Set-AzServiceBusGeoDRConfigurationBreakPair -ResourceGroupName myResourceGroup -NamespaceName myPrimaryNamespace -Name myAlias +``` + +Break Pairing between primary namespace `myPrimaryNamespace` and it's secondary namespace. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: BreakViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the disaster recovery config or alias + +```yaml +Type: System.String +Parameter Sets: Break +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of ServiceBus namespace + +```yaml +Type: System.String +Parameter Sets: Break +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Break +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Break +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusGeoDRConfigurationFailOver.md b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusGeoDRConfigurationFailOver.md new file mode 100644 index 0000000000..685ffd2107 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusGeoDRConfigurationFailOver.md @@ -0,0 +1,231 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/set-azservicebusgeodrconfigurationfailover +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusGeoDRConfigurationFailOver.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusGeoDRConfigurationFailOver.md +--- + +# Set-AzServiceBusGeoDRConfigurationFailOver + +## SYNOPSIS +Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace + +## SYNTAX + +### Fail (Default) +``` +Set-AzServiceBusGeoDRConfigurationFailOver -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### FailViaIdentity +``` +Set-AzServiceBusGeoDRConfigurationFailOver -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace + +## EXAMPLES + +### Example 1: Fail Over to secondary namespace of an alias +```powershell +Set-AzServiceBusGeoDRConfigurationFailOver -ResourceGroupName myResourceGroup -NamespaceName mySecondaryNamespace -Name myAlias +``` + +Fails over to `mySecondaryNamespace` which is secondary namespace of alias `myAlias`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: FailViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the disaster recovery config or alias + +```yaml +Type: System.String +Parameter Sets: Fail +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of ServiceBus namespace + +```yaml +Type: System.String +Parameter Sets: Fail +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Fail +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Fail +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusNamespace.md b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusNamespace.md new file mode 100644 index 0000000000..e8965543da --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusNamespace.md @@ -0,0 +1,638 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/set-azservicebusnamespace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusNamespace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusNamespace.md +--- + +# Set-AzServiceBusNamespace + +## SYNOPSIS +Updates a ServiceBus namespace + +## SYNTAX + +### SetExpanded (Default) +``` +Set-AzServiceBusNamespace -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AlternateName <String>] [-DisableLocalAuth] [-KeyVaultProperty <IKeyVaultProperties[]>] + [-RequireInfrastructureEncryption] [-IdentityType <ManagedServiceIdentityType>] + [-UserAssignedIdentityId <String[]>] [-MinimumTlsVersion <String>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-SkuName <SkuName>] [-SkuCapacity <Int32>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzServiceBusNamespace [-InputObject <IServiceBusIdentity>] [-AlternateName <String>] [-DisableLocalAuth] + [-KeyVaultProperty <IKeyVaultProperties[]>] [-RequireInfrastructureEncryption] + [-IdentityType <ManagedServiceIdentityType>] [-UserAssignedIdentityId <String[]>] + [-MinimumTlsVersion <String>] [-PublicNetworkAccess <PublicNetworkAccess>] [-SkuName <SkuName>] + [-SkuCapacity <Int32>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates a ServiceBus namespace + +## EXAMPLES + +### Example 1: Add a KeyVaultProperty to an existing ServiceBus Namespace +```powershell +$serviceBusNamespace = Get-AzServiceBusNamespace -ResourceGroupName myResourceGroup -NamespaceName myNamespace +$newKeyVaultProperty = New-AzServiceBusKeyVaultPropertiesObject -KeyName key6 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$serviceBusNamespace.KeyVaultProperty += $newKeyVaultProperty +Set-AzServiceBusNamespace -InputObject $serviceBusNamespace -KeyVaultProperty $serviceBusNamespace.KeyVaultProperty +``` + +```output +AlternateName : +CreatedAt : 11/17/2022 5:51:52 AM +DisableLocalAuth : False +Id : /subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +IdentityType : +KeySource : +KeyVaultProperty : {{ + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use + rAssignedIdentities/myFirstIdentity" + }, + "keyName": "key4", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }, { + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use + rAssignedIdentities/myFirstIdentity" + }, + "keyName": "key5", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }, { + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use + rAssignedIdentities/myFirstIdentity" + }, + "keyName": "key6", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }} +Location : North Europe +MetricId : 000000000000:myNamespace +MinimumTlsVersion : 1.1 +Name : myNamespace +PrincipalId : +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 16 +SkuName : Premium +SkuTier : Premium +Status : Active +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : { + } +TenantId : +Type : Microsoft.ServiceBus/Namespaces +UpdatedAt : 11/21/2022 5:01:22 AM +UserAssignedIdentity : { + } +ZoneRedundant : False +``` + +Adds a new KeyVaultProperty to ServiceBus namespace `myNamespace`. + +### Example 2: Remove a KeyVaultProperty from an existing ServiceBus Namespace +```powershell +$serviceBusNamespace = Get-AzServiceBusNamespace -ResourceGroupName myResourceGroup -NamespaceName myNamespace +$serviceBusNamespace.KeyVaultProperty = $serviceBusNamespace.KeyVaultProperty[0,2] +Set-AzServiceBusNamespace -InputObject $serviceBusNamespace -KeyVaultProperty $serviceBusNamespace.KeyVaultProperty +``` + +```output +AlternateName : +CreatedAt : 11/21/2022 5:15:41 AM +DisableLocalAuth : False +Id : /subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +IdentityType : UserAssigned +KeySource : Microsoft.KeyVault +KeyVaultProperty : {{ + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key4", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }, { + "identity": { + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + userAssignedIdentities/myFirstIdentity" + }, + "keyName": "key6", + "keyVaultUri": "https://testkeyvault.vault.azure.net", + "keyVersion": "" + }} +Location : North Europe +MetricId : 000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : False +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Premium +SkuTier : Premium +Status : Active +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : { + } +TenantId : +Type : Microsoft.ServiceBus/Namespaces +UpdatedAt : 11/21/2022 8:52:02 AM +UserAssignedIdentity : { + "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + userAssignedIdentities/myFirstIdentity": { + }, + "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + userAssignedIdentities/mySecondIdentity": { + } + } +ZoneRedundant : False +``` + +Remove the second KeyVaultProperty from the list of KeyVaultProperties. + +### Example 3: Add UserAssigned Identity to Namespace with IdentityType SystemAssigned to test for SystemAssigned and UserAssigned +```powershell +$serviceBusNamespace = Get-AzServiceBusNamespace -ResourceGroupName myResourceGroup -NamespaceName myNamespace +$id1 = "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$id2 = "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" +Set-AzServiceBusNamespace -InputObject $serviceBusNamespace -IdentityType "SystemAssigned, UserAssigned" -UserAssignedIdentityId $id1, $id2 +``` + +```output +AlternateName : +CreatedAt : 11/17/2022 3:54:50 AM +DisableLocalAuth : False +Id : /subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +IdentityType : SystemAssigned, UserAssigned +KeySource : +KeyVaultProperty : +Location : North Europe +MetricId : 000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : 000000000000000 +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : +SkuName : Standard +SkuTier : Standard +Status : Active +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : { + } +TenantId : 0000000000000000 +Type : Microsoft.ServiceBus/Namespaces +UpdatedAt : 11/21/2022 9:15:53 AM +UserAssignedIdentity : { + "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + userAssignedIdentities/mySecondIdentity": { + }, + "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + userAssignedIdentities/myFirstIdentity": { + } + } +ZoneRedundant : False +``` + +Added UserAssigned Identity to Namespace with IdentityType SystemAssigned to test for SystemAssigned and UserAssigned. + +### Example 4: # Create a namespace with UserAssignedIdentity and use Set-Az cmdlet to set IdentityType to None. +```powershell +$id1 = "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$id2 = "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" +$serviceBusNamespace = New-AzServiceBusNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId $id1,$id2 +$serviceBusNamespace = Set-AzServiceBusNamespace -ResourceGroupName myResourceGroup -Name myNamespace -IdentityType None -UserAssignedIdentityId @() +``` + +```output +AlternateName : +CreatedAt : 11/17/2022 3:54:50 AM +DisableLocalAuth : False +Id : /subscriptions/000000000000/resourceGroups/myResourceGroup/providers/M + icrosoft.ServiceBus/namespaces/myNamespace +IdentityType : +KeySource : +KeyVaultProperty : +Location : North Europe +MetricId : 000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : +SkuName : Standard +SkuTier : Standard +Status : Active +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : { + } +TenantId : +Type : Microsoft.ServiceBus/Namespaces +UpdatedAt : 11/21/2022 9:42:32 AM +UserAssignedIdentity : { + } +ZoneRedundant : False +``` + +Created a namespace with UserAssignedIdentity and use Set-Az cmdlet to set IdentityType to None. + +## PARAMETERS + +### -AlternateName +Alternate name for namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +This property disables SAS authentication for the Service Bus namespace. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.ManagedServiceIdentityType +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.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultProperty +Properties of KeyVault +To construct, see NOTES section for KEYVAULTPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IKeyVaultProperties[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +The minimum TLS version for the cluster to support, e.g. +'1.2' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of ServiceBusNamespace + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +This determines if traffic is allowed over public network. +By default it is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireInfrastructureEncryption +Enable Infrastructure Encryption (Double Encryption) + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the ResourceGroupName. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +The specified messaging units for the tier. +For Premium tier, capacity are 1,2 and 4. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name of this SKU. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.SkuName +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. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +Properties for User Assigned Identities + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbNamespace + +## NOTES + +ALIASES + +Set-AzServiceBusNamespaceV2 + +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 <IServiceBusIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +`KEYVAULTPROPERTY <IKeyVaultProperties[]>`: Properties of KeyVault + - `[KeyName <String>]`: Name of the Key from KeyVault + - `[KeyVaultUri <String>]`: Uri of KeyVault + - `[KeyVersion <String>]`: Version of KeyVault + - `[UserAssignedIdentity <String>]`: ARM ID of user Identity selected for encryption + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusNetworkRuleSet.md b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusNetworkRuleSet.md new file mode 100644 index 0000000000..4575238a32 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusNetworkRuleSet.md @@ -0,0 +1,386 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/set-azservicebusnetworkruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusNetworkRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusNetworkRuleSet.md +--- + +# Set-AzServiceBusNetworkRuleSet + +## SYNOPSIS +Updates the NetworkRuleSet of a ServiceBus namespace + +## SYNTAX + +### SetExpanded (Default) +``` +Set-AzServiceBusNetworkRuleSet -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-PublicNetworkAccess <PublicNetworkAccess>] [-TrustedServiceAccessEnabled] [-DefaultAction <DefaultAction>] + [-IPRule <INwRuleSetIPRules[]>] [-VirtualNetworkRule <INwRuleSetVirtualNetworkRules[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzServiceBusNetworkRuleSet -InputObject <IServiceBusIdentity> [-PublicNetworkAccess <PublicNetworkAccess>] + [-TrustedServiceAccessEnabled] [-DefaultAction <DefaultAction>] [-IPRule <INwRuleSetIPRules[]>] + [-VirtualNetworkRule <INwRuleSetVirtualNetworkRules[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the NetworkRuleSet of a ServiceBus namespace + +## EXAMPLES + +### Example 1: Add IP Rules and Virtual Network Rules to a Network Rule Set +```powershell +$ipRule1 = New-AzServiceBusIPRuleConfig -IPMask 2.2.2.2 -Action Allow +$ipRule2 = New-AzServiceBusIPRuleConfig -IPMask 3.3.3.3 -Action Allow +$virtualNetworkRule1 = New-AzServiceBusVirtualNetworkRuleConfig -SubnetId /subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default +$networkRuleSet = Get-AzServiceBusNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace +$networkRuleSet.IPRule += $ipRule1 +$networkRuleSet.IPRule += $ipRule2 +$networkRuleSet.VirtualNetworkRule += $virtualNetworkRule1 +Set-AzServiceBusNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -IPRule $ipRule1,$ipRule2 -VirtualNetworkRule $virtualNetworkRule1,$virtualNetworkRule2,$virtualNetworkRule3 +``` + +```output +DefaultAction : Deny +IPRule : {{ + "ipMask": "1.1.1.1", + "action": "Allow" + }, { + "ipMask": "2.2.2.2", + "action": "Allow" + }, { + "ipMask": "3.3.3.3", + "action": "Allow" + }} +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/networkRuleSets/ + default +Location : Australia East +Name : default +PublicNetworkAccess : Enabled +ResourceGroupName : myResourceGroup +TrustedServiceAccessEnabled : +Type : Microsoft.ServiceBus/Namespaces/NetworkRuleSets +VirtualNetworkRule : {{ + "subnet": { + "id": "/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default" + }, + "ignoreMissingVnetServiceEndpoint": false + },{ + "subnet": { + "id": "/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/mySubnet" + }, + "ignoreMissingVnetServiceEndpoint": false + }} +``` + +Appends virtual network rules and IPRules to the existing rules. + +### Example 2: Enable Trusted Service Access on a namespace +```powershell +Set-AzServiceBusNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TrustedServiceAccessEnabled +``` + +```output +DefaultAction : Deny +IPRule : {{ + "ipMask": "1.1.1.1", + "action": "Allow" + }, { + "ipMask": "2.2.2.2", + "action": "Allow" + }, { + "ipMask": "3.3.3.3", + "action": "Allow" + }} +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/networkRuleSets/ + default +Location : Australia East +Name : default +PublicNetworkAccess : Enabled +ResourceGroupName : myResourceGroup +TrustedServiceAccessEnabled : True +Type : Microsoft.ServiceBus/Namespaces/NetworkRuleSets +VirtualNetworkRule : {{ + "subnet": { + "id": "/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default" + }, + "ignoreMissingVnetServiceEndpoint": false + },{ + "subnet": { + "id": "/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/mySubnet" + }, + "ignoreMissingVnetServiceEndpoint": false + }} +``` + +Enabled Trusted Service Access on the ServiceBus namespace `myNamespace`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAction +Default Action for Network Rule Set + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.DefaultAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IPRule +List of IpRules +To construct, see NOTES section for IPRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.INwRuleSetIPRules[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of ServiceBus namespace + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +This determines if traffic is allowed over public network. +By default it is enabled. +If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.PublicNetworkAccess +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustedServiceAccessEnabled +Value that indicates whether Trusted Service Access is Enabled or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRule +List of VirtualNetwork Rules +To construct, see NOTES section for VIRTUALNETWORKRULE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.INwRuleSetVirtualNetworkRules[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.INetworkRuleSet + +## 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 <IServiceBusIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +`IPRULE <INwRuleSetIPRules[]>`: List of IpRules + - `[Action <NetworkRuleIPAction?>]`: The IP Filter Action + - `[IPMask <String>]`: IP Mask + +`VIRTUALNETWORKRULE <INwRuleSetVirtualNetworkRules[]>`: List of VirtualNetwork Rules + - `[IgnoreMissingVnetServiceEndpoint <Boolean?>]`: Value that indicates whether to ignore missing VNet Service Endpoint + - `[SubnetId <String>]`: Resource ID of Virtual Network Subnet + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusQueue.md b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusQueue.md new file mode 100644 index 0000000000..548f762b71 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusQueue.md @@ -0,0 +1,519 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/set-azservicebusqueue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusQueue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusQueue.md +--- + +# Set-AzServiceBusQueue + +## SYNOPSIS +Updates a ServiceBus Queue + +## SYNTAX + +### SetExpanded (Default) +``` +Set-AzServiceBusQueue -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AutoDeleteOnIdle <TimeSpan>] [-DefaultMessageTimeToLive <TimeSpan>] + [-DuplicateDetectionHistoryTimeWindow <TimeSpan>] [-LockDuration <TimeSpan>] + [-DeadLetteringOnMessageExpiration] [-EnableBatchedOperations] [-EnableExpress] [-ForwardTo <String>] + [-ForwardDeadLetteredMessagesTo <String>] [-MaxDeliveryCount <Int32>] [-MaxSizeInMegabytes <Int32>] + [-MaxMessageSizeInKilobytes <Int64>] [-Status <EntityStatus>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzServiceBusQueue -InputObject <IServiceBusIdentity> [-AutoDeleteOnIdle <TimeSpan>] + [-DefaultMessageTimeToLive <TimeSpan>] [-DuplicateDetectionHistoryTimeWindow <TimeSpan>] + [-LockDuration <TimeSpan>] [-DeadLetteringOnMessageExpiration] [-EnableBatchedOperations] [-EnableExpress] + [-ForwardTo <String>] [-ForwardDeadLetteredMessagesTo <String>] [-MaxDeliveryCount <Int32>] + [-MaxSizeInMegabytes <Int32>] [-MaxMessageSizeInKilobytes <Int64>] [-Status <EntityStatus>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a ServiceBus Queue + +## EXAMPLES + +### Example 1: Update a ServiceBus queue +```powershell +Set-AzServiceBusQueue -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myQueue -AutoDeleteOnIdle (New-TimeSpan -Days 4 -Minutes 3 -Seconds 4) -DefaultMessageTimeToLive (New-TimeSpan -Days 9) +``` + +```output +AccessedAt : 1/1/0001 12:00:00 AM +AutoDeleteOnIdle : 4.00:03:04 +CountDetailActiveMessageCount : 0 +CountDetailDeadLetterMessageCount : 0 +CountDetailScheduledMessageCount : 0 +CountDetailTransferDeadLetterMessageCount : 0 +CountDetailTransferMessageCount : 0 +CreatedAt : 9/22/2022 12:30:45 PM +DeadLetteringOnMessageExpiration : False +DefaultMessageTimeToLive : 9.00:00:00 +DuplicateDetectionHistoryTimeWindow : 00:10:00 +EnableBatchedOperations : True +EnableExpress : False +EnablePartitioning : True +ForwardDeadLetteredMessagesTo : +ForwardTo : +Id : /subscriptions/326100e2-f69d-4268-8503-075374f62b6e/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/queues/myQueue +Location : westus +LockDuration : 00:01:00 +MaxDeliveryCount : 10 +MaxMessageSizeInKilobytes : 1024 +MaxSizeInMegabytes : 1024 +MessageCount : 0 +Name : myQueue +RequiresDuplicateDetection : False +RequiresSession : False +ResourceGroupName : myResourceGroup +SizeInByte : 0 +Status : Active +``` + +Updates Parameters `DefaultMessageTimeToLive`, `AutoDeleteOnIdle` on a ServiceBus queue `myQueue` in namespace `myNamespace`. + +### Example 2: Update a ServiceBus queue using InputObject parameter set +```powershell +$queue = Get-AzServiceBusQueue -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myQueue +Set-AzServiceBusQueue -InputObject $queue -AutoDeleteOnIdle (New-TimeSpan -Days 4 -Minutes 3 -Seconds 4) -DefaultMessageTimeToLive (New-TimeSpan -Days 9) +``` + +```output +AccessedAt : 1/1/0001 12:00:00 AM +AutoDeleteOnIdle : 4.00:03:04 +CountDetailActiveMessageCount : 0 +CountDetailDeadLetterMessageCount : 0 +CountDetailScheduledMessageCount : 0 +CountDetailTransferDeadLetterMessageCount : 0 +CountDetailTransferMessageCount : 0 +CreatedAt : 9/22/2022 12:30:45 PM +DeadLetteringOnMessageExpiration : False +DefaultMessageTimeToLive : 9.00:00:00 +DuplicateDetectionHistoryTimeWindow : 00:10:00 +EnableBatchedOperations : True +EnableExpress : False +EnablePartitioning : True +ForwardDeadLetteredMessagesTo : +ForwardTo : +Id : /subscriptions/326100e2-f69d-4268-8503-075374f62b6e/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/queues/myQueue +Location : westus +LockDuration : 00:01:00 +MaxDeliveryCount : 10 +MaxMessageSizeInKilobytes : 1024 +MaxSizeInMegabytes : 1024 +MessageCount : 0 +Name : myQueue +RequiresDuplicateDetection : False +RequiresSession : False +ResourceGroupName : myResourceGroup +SizeInByte : 0 +Status : Active +``` + +Updates Parameters `DefaultMessageTimeToLive`, `AutoDeleteOnIdle` on a ServiceBus queue `myQueue` in namespace `myNamespace` using +InputObject parameter set. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDeleteOnIdle +ISO 8061 timeSpan idle interval after which the queue is automatically deleted. +The minimum duration is 5 minutes. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeadLetteringOnMessageExpiration +A value that indicates whether this queue has dead letter support when a message expires. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMessageTimeToLive +ISO 8601 default message timespan to live value. +This is the duration after which the message expires, starting from when the message is sent to Service Bus. +This is the default value used when TimeToLive is not set on a message itself. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DuplicateDetectionHistoryTimeWindow +ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. +The default value is 10 minutes. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBatchedOperations +Value that indicates whether server-side batched operations are enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExpress +A value that indicates whether Express Entities are enabled. +An express queue holds a message in memory temporarily before writing it to persistent storage. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardDeadLetteredMessagesTo +A value that indicates whether the queue supports the concept of sessions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardTo +Queue/Topic name to forward the messages + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LockDuration +ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. +The maximum value for LockDuration is 5 minutes; the default value is 1 minute. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxDeliveryCount +The maximum delivery count. +A message is automatically deadlettered after this number of deliveries. +default value is 10. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxMessageSizeInKilobytes +Maximum size (in KB) of the message payload that can be accepted by the queue. +This property is only used in Premium today and default is 1024. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSizeInMegabytes +The maximum delivery count. +A message is automatically deadlettered after this number of deliveries. +default value is 10. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Queue. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: QueueName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of ServiceBus namespace + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Maximum size (in KB) of the message payload that can be accepted by the queue. +This property is only used in Premium today and default is 1024. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.EntityStatus +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. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbQueue + +## 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 <IServiceBusIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusRule.md b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusRule.md new file mode 100644 index 0000000000..609465c0f9 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusRule.md @@ -0,0 +1,555 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/set-azservicebusrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusRule.md +--- + +# Set-AzServiceBusRule + +## SYNOPSIS +Updates a ServiceBus Rule + +## SYNTAX + +### SetExpanded (Default) +``` +Set-AzServiceBusRule -Name <String> -TopicName <String> -SubscriptionName <String> -NamespaceName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-SqlExpression <String>] + [-SqlFilterRequiresPreprocessing] [-ContentType <String>] [-CorrelationId <String>] [-Label <String>] + [-MessageId <String>] [-CorrelationFilterProperty <Hashtable>] [-ReplyTo <String>] + [-ReplyToSessionId <String>] [-CorrelationFilterRequiresPreprocessing] [-SessionId <String>] [-To <String>] + [-FilterType <FilterType>] [-ActionRequiresPreprocessing] [-ActionSqlExpression <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzServiceBusRule -InputObject <IServiceBusIdentity> [-SqlExpression <String>] + [-SqlFilterRequiresPreprocessing] [-ContentType <String>] [-CorrelationId <String>] [-Label <String>] + [-MessageId <String>] [-CorrelationFilterProperty <Hashtable>] [-ReplyTo <String>] + [-ReplyToSessionId <String>] [-CorrelationFilterRequiresPreprocessing] [-SessionId <String>] [-To <String>] + [-FilterType <FilterType>] [-ActionRequiresPreprocessing] [-ActionSqlExpression <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a ServiceBus Rule + +## EXAMPLES + +### Example 1: Update a Correlation Filter +```powershell +Set-AzServiceBusRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -SubscriptionName mySubscription -Name myCorrelationRule -ContentType updatedContentType -ReplyToSessionId updatedReplyToSessionId +``` + +```output +ActionCompatibilityLevel : +ActionRequiresPreprocessing : +ActionSqlExpression : +ContentType : updatedContentType +CorrelationFilterProperty : { + "c": "d", + "a": "b" + } +CorrelationFilterRequiresPreprocessing : +CorrelationId : correlationid +FilterType : CorrelationFilter +Id : /subscriptions/000000000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic/subscriptions/mySubscription/rules/myCorrelationRule +Label : label +Location : westus +MessageId : messageid +Name : myCorrelationRule +ReplyTo : replyto +ReplyToSessionId : updatedReplyToSessionId +ResourceGroupName : myResourceGroup +SessionId : sessionid +SqlExpression : +SqlFilterCompatibilityLevel : +``` + +Update `ContentType` and `ReplyToSessionId` parameters of a correlation filter `myCorrelationRule` in ServiceBus subscription `mySubscription`. + +### Example 2: Update an Sql Filter using InputObject parameter set +```powershell +$rule = Get-AzServiceBusRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -SubscriptionName mySubscription -Name mySqlRule +Set-AzServiceBusRule -InputObject $rule -SqlExpression 5=3 +``` + +```output +ActionCompatibilityLevel : 20 +ActionRequiresPreprocessing : +ActionSqlExpression : SET a=b +ContentType : +CorrelationFilterProperty : { + } +CorrelationFilterRequiresPreprocessing : +CorrelationId : +FilterType : SqlFilter +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic/subscriptions/mySubscription/rules/mySqlRule +Label : +Location : westus +MessageId : +Name : mySqlRule +ReplyTo : +ReplyToSessionId : +ResourceGroupName : myResourceGroup +SessionId : +SqlExpression : 5=3 +SqlFilterCompatibilityLevel : 20 +SqlFilterRequiresPreprocessing : +``` + +Updating SqlExpression of SqlFilter `mySqlRule` using InputObject parameter set. + +## PARAMETERS + +### -ActionRequiresPreprocessing +Value that indicates whether the rule action requires preprocessing. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActionSqlExpression +SQL expression. +e.g. +MyProperty='ABC' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentType +Content type of the message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorrelationFilterProperty +dictionary object for custom filters + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorrelationFilterRequiresPreprocessing +Value that indicates whether the rule action requires preprocessing. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorrelationId +Identifier of the correlation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterType +Filter type that is evaluated against a BrokeredMessage. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.FilterType +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.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Label +Application specific label. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId +Identifier of the message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Rule. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: RuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of ServiceBus namespace + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyTo +Address of the queue to reply to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyToSessionId +Session identifier to reply to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionId +Session identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlExpression +SQL expression. +e.g. +MyProperty='ABC' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlFilterRequiresPreprocessing +Value that indicates whether the rule action requires preprocessing. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionName +The name of the SubscriptionName. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -To +Address to send to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The name of the Topic. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IRule + +## 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 <IServiceBusIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusSubscription.md b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusSubscription.md new file mode 100644 index 0000000000..c47934487e --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusSubscription.md @@ -0,0 +1,496 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/set-azservicebussubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusSubscription.md +--- + +# Set-AzServiceBusSubscription + +## SYNOPSIS +Updates a ServiceBus Subscription + +## SYNTAX + +### SetExpanded (Default) +``` +Set-AzServiceBusSubscription -Name <String> -TopicName <String> -NamespaceName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-AutoDeleteOnIdle <TimeSpan>] + [-DefaultMessageTimeToLive <TimeSpan>] [-DuplicateDetectionHistoryTimeWindow <TimeSpan>] + [-LockDuration <TimeSpan>] [-EnableBatchedOperations] [-Status <EntityStatus>] [-ForwardTo <String>] + [-ForwardDeadLetteredMessagesTo <String>] [-MaxDeliveryCount <Int32>] + [-DeadLetteringOnFilterEvaluationException] [-DeadLetteringOnMessageExpiration] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzServiceBusSubscription -InputObject <IServiceBusIdentity> [-AutoDeleteOnIdle <TimeSpan>] + [-DefaultMessageTimeToLive <TimeSpan>] [-DuplicateDetectionHistoryTimeWindow <TimeSpan>] + [-LockDuration <TimeSpan>] [-EnableBatchedOperations] [-Status <EntityStatus>] [-ForwardTo <String>] + [-ForwardDeadLetteredMessagesTo <String>] [-MaxDeliveryCount <Int32>] + [-DeadLetteringOnFilterEvaluationException] [-DeadLetteringOnMessageExpiration] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a ServiceBus Subscription + +## EXAMPLES + +### Example 1: Update a ServiceBus subscription +```powershell +Set-AzServiceBusSubscription -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -Name mySubscription -DefaultMessageTimeToLive (New-TimeSpan -Days 10) -EnableBatchedOperations +``` + +```output +AccessedAt : 1/1/0001 12:00:00 AM +AutoDeleteOnIdle : 10675199.02:48:05.4775807 +ClientId : +CountDetailActiveMessageCount : 0 +CountDetailDeadLetterMessageCount : 0 +CountDetailScheduledMessageCount : 0 +CountDetailTransferDeadLetterMessageCount : 0 +CountDetailTransferMessageCount : 0 +CreatedAt : 9/23/2022 2:37:46 PM +DeadLetteringOnFilterEvaluationException : True +DeadLetteringOnMessageExpiration : False +DefaultMessageTimeToLive : 10.00:00:00 +DuplicateDetectionHistoryTimeWindow : +EnableBatchedOperations : True +ForwardDeadLetteredMessagesTo : +ForwardTo : +Id : /subscriptions/000000000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic/subscriptions/mySubscription +IsClientAffine : False +IsDurable : +IsShared : +Location : westus +LockDuration : 00:01:00 +MaxDeliveryCount : 10 +MessageCount : 0 +Name : testsub +RequiresSession : False +ResourceGroupName : myResourceGroup +Status : Active +``` + +Updates `DefaultMessageTimeToLive` and `EnableBatchedOperations` ServiceBus subscription `mySubscription` under topic `myTopic`. + +### Example 1: Update a ServiceBus subscription using InputObject parameter set +```powershell +$subscription = Get-AzServiceBusSubscription -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -Name mySubscription +Set-AzServiceBusSubscription -InputObject $subscription -DefaultMessageTimeToLive (New-TimeSpan -Days 10) -EnableBatchedOperations +``` + +```output +AccessedAt : 1/1/0001 12:00:00 AM +AutoDeleteOnIdle : 10675199.02:48:05.4775807 +ClientId : +CountDetailActiveMessageCount : 0 +CountDetailDeadLetterMessageCount : 0 +CountDetailScheduledMessageCount : 0 +CountDetailTransferDeadLetterMessageCount : 0 +CountDetailTransferMessageCount : 0 +CreatedAt : 9/23/2022 2:37:46 PM +DeadLetteringOnFilterEvaluationException : True +DeadLetteringOnMessageExpiration : False +DefaultMessageTimeToLive : 10.00:00:00 +DuplicateDetectionHistoryTimeWindow : +EnableBatchedOperations : True +ForwardDeadLetteredMessagesTo : +ForwardTo : +Id : /subscriptions/000000000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic/subscriptions/mySubscription +IsClientAffine : False +IsDurable : +IsShared : +Location : westus +LockDuration : 00:01:00 +MaxDeliveryCount : 10 +MessageCount : 0 +Name : testsub +RequiresSession : False +ResourceGroupName : myResourceGroup +Status : Active +``` + +Updates `DefaultMessageTimeToLive` and `EnableBatchedOperations` ServiceBus subscription `mySubscription` under topic `myTopic` using InputObject parameter set. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDeleteOnIdle +ISO 8061 timeSpan idle interval after which the subscription is automatically deleted. +The minimum duration is 5 minutes. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeadLetteringOnFilterEvaluationException +Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeadLetteringOnMessageExpiration +Value that indicates whether a subscription has dead letter support when a message expires. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMessageTimeToLive +ISO 8601 default message timespan to live value. +This is the duration after which the message expires, starting from when the message is sent to Service Bus. +This is the default value used when TimeToLive is not set on a message itself. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DuplicateDetectionHistoryTimeWindow +ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. +The default value is 10 minutes. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBatchedOperations +Value that indicates whether server-side batched operations are enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardDeadLetteredMessagesTo +Queue/Topic name to forward the Dead Letter message + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardTo +Queue/Topic name to forward the messages + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LockDuration +ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. +The maximum value for LockDuration is 5 minutes; the default value is 1 minute. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxDeliveryCount +The maximum delivery count. +A message is automatically deadlettered after this number of deliveries. +default value is 10. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Subscription. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: SubscriptionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of ServiceBus namespace + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Enumerates the possible values for the status of a messaging entity. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.EntityStatus +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. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopicName +The name of the Topic. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbSubscription + +## 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 <IServiceBusIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusTopic.md b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusTopic.md new file mode 100644 index 0000000000..8aa392be0e --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Set-AzServiceBusTopic.md @@ -0,0 +1,442 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/set-azservicebustopic +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusTopic.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Set-AzServiceBusTopic.md +--- + +# Set-AzServiceBusTopic + +## SYNOPSIS +Updates a ServiceBus Topic + +## SYNTAX + +### SetExpanded (Default) +``` +Set-AzServiceBusTopic -Name <String> -NamespaceName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AutoDeleteOnIdle <TimeSpan>] [-DefaultMessageTimeToLive <TimeSpan>] + [-DuplicateDetectionHistoryTimeWindow <TimeSpan>] [-EnableBatchedOperations] [-EnableExpress] + [-SupportOrdering] [-MaxSizeInMegabytes <Int32>] [-MaxMessageSizeInKilobytes <Int64>] [-Status <EntityStatus>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Set-AzServiceBusTopic -InputObject <IServiceBusIdentity> [-AutoDeleteOnIdle <TimeSpan>] + [-DefaultMessageTimeToLive <TimeSpan>] [-DuplicateDetectionHistoryTimeWindow <TimeSpan>] + [-EnableBatchedOperations] [-EnableExpress] [-SupportOrdering] [-MaxSizeInMegabytes <Int32>] + [-MaxMessageSizeInKilobytes <Int64>] [-Status <EntityStatus>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a ServiceBus Topic + +## EXAMPLES + +### Example 1: Updates a ServiceBus topic +```powershell +Set-AzServiceBusTopic -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myTopic -DefaultMessageTimeToLive (New-TimeSpan -Days 20) -MaxMessageSizeInKilobytes 102400 +``` + +```output +AccessedAt : 1/1/0001 12:00:00 AM +AutoDeleteOnIdle : 10675199.02:48:05.4775807 +CountDetailActiveMessageCount : 0 +CountDetailDeadLetterMessageCount : 0 +CountDetailScheduledMessageCount : 0 +CountDetailTransferDeadLetterMessageCount : 0 +CountDetailTransferMessageCount : 0 +CreatedAt : 1/1/0001 12:00:00 AM +DefaultMessageTimeToLive : 20.00:00:00 +DuplicateDetectionHistoryTimeWindow : 00:10:00 +EnableBatchedOperations : True +EnableExpress : False +EnablePartitioning : False +Id : /subscriptions/000000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic +Location : westus +MaxMessageSizeInKilobytes : 102400 +MaxSizeInMegabytes : 1024 +Name : myTopic +RequiresDuplicateDetection : False +ResourceGroupName : myResourceGroup +SizeInByte : 0 +Status : Active +SubscriptionCount : 0 +SupportOrdering : True +``` + +Updates a ServiceBus topic `myTopic` within namespace `myNamespace`. + +### Example 2: Updates a ServiceBus topic using InputObject parameter set +```powershell +$topic = Get-AzServiceBusTopic -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myTopic +Set-AzServiceBusTopic -InputObject $topic -DefaultMessageTimeToLive (New-TimeSpan -Days 20) -MaxMessageSizeInKilobytes 102400 +``` + +```output +AccessedAt : 1/1/0001 12:00:00 AM +AutoDeleteOnIdle : 10675199.02:48:05.4775807 +CountDetailActiveMessageCount : 0 +CountDetailDeadLetterMessageCount : 0 +CountDetailScheduledMessageCount : 0 +CountDetailTransferDeadLetterMessageCount : 0 +CountDetailTransferMessageCount : 0 +CreatedAt : 1/1/0001 12:00:00 AM +DefaultMessageTimeToLive : 20.00:00:00 +DuplicateDetectionHistoryTimeWindow : 00:10:00 +EnableBatchedOperations : True +EnableExpress : False +EnablePartitioning : False +Id : /subscriptions/000000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/topics/myTopic +Location : westus +MaxMessageSizeInKilobytes : 102400 +MaxSizeInMegabytes : 1024 +Name : myTopic +RequiresDuplicateDetection : False +ResourceGroupName : myResourceGroup +SizeInByte : 0 +Status : Active +SubscriptionCount : 0 +SupportOrdering : True +``` + +Updates a ServiceBus topic `myTopic` within namespace `myNamespace` using InputObject parameter set. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDeleteOnIdle +ISO 8061 timeSpan idle interval after which the topic is automatically deleted. +The minimum duration is 5 minutes. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMessageTimeToLive +ISO 8601 default message timespan to live value. +This is the duration after which the message expires, starting from when the message is sent to Service Bus. +This is the default value used when TimeToLive is not set on a message itself. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DuplicateDetectionHistoryTimeWindow +ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. +The default value is 10 minutes. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBatchedOperations +Value that indicates whether server-side batched operations are enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExpress +A value that indicates whether Express Entities are enabled. +An express topic holds a message in memory temporarily before writing it to persistent storage. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity parameter. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaxMessageSizeInKilobytes +Maximum size (in KB) of the message payload that can be accepted by the topic. +This property is only used in Premium today and default is 1024. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSizeInMegabytes +The maximum delivery count. +A message is automatically deadlettered after this number of deliveries. +default value is 10. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Topic. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: TopicName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of ServiceBus namespace + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Maximum size (in KB) of the message payload that can be accepted by the topic. +This property is only used in Premium today and default is 1024. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.EntityStatus +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. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportOrdering +Value that indicates whether the topic supports ordering. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbTopic + +## 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 <IServiceBusIdentity>`: Identity parameter. + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Start-AzServiceBusMigration.md b/azps-10.1.0/Az.ServiceBus/Start-AzServiceBusMigration.md new file mode 100644 index 0000000000..dc7c3f9b9c --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Start-AzServiceBusMigration.md @@ -0,0 +1,223 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/start-azservicebusmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Start-AzServiceBusMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Start-AzServiceBusMigration.md +--- + +# Start-AzServiceBusMigration + +## SYNOPSIS +Creates Migration configuration and starts migration of entities from Standard to Premium namespace + +## SYNTAX + +``` +Start-AzServiceBusMigration -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-PostMigrationName <String>] [-TargetNamespace <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates Migration configuration and starts migration of entities from Standard to Premium namespace + +## EXAMPLES + +### Example 1: Start a Service Bus migration configuration +```powershell +Start-AzServiceBusMigration -ResourceGroupName myResourceGroup -NamespaceName myNamespace -PostMigrationName myStandardNamespace2 -TargetNamespace /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myPremiumNamespace +``` + +```output +Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces + /myNamespace/migrationConfigurations/$default +Location : +MigrationState : Active +Name : myNamespace +PendingReplicationOperationsCount : +PostMigrationName : myStandardNamespace2 +ProvisioningState : Succeeded +ResourceGroupName : myResourceGroup +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetNamespace : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces + /myPremiumNamespace +``` + +Starts a Service Bus migration configuration that links standard namespace `myNamespace` to premium `mySecondaryNamespace`. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostMigrationName +Name to access Standard Namespace after migration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNamespace +Existing premium Namespace ARM Id name which has no entities, will be used for migration + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.IMigrationConfigProperties + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Stop-AzServiceBusMigration.md b/azps-10.1.0/Az.ServiceBus/Stop-AzServiceBusMigration.md new file mode 100644 index 0000000000..b19c7746ef --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Stop-AzServiceBusMigration.md @@ -0,0 +1,201 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/stop-azservicebusmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Stop-AzServiceBusMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Stop-AzServiceBusMigration.md +--- + +# Stop-AzServiceBusMigration + +## SYNOPSIS +This operation reverts Migration + +## SYNTAX + +### Revert (Default) +``` +Stop-AzServiceBusMigration -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RevertViaIdentity +``` +Stop-AzServiceBusMigration -InputObject <IServiceBusIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This operation reverts Migration + +## EXAMPLES + +### Example 1: Aborts a ServiceBus migration +```powershell +Stop-AzServiceBusMigration -ResourceGroupName myResourceGroup -NamespaceName myNamespace +``` + +Aborts migration on standard namespace `myNamespace`. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity +Parameter Sets: RevertViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NamespaceName +The namespace name + +```yaml +Type: System.String +Parameter Sets: Revert +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the Resource group within the Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Revert +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription credentials that uniquely identify a Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Revert +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.IServiceBusIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceBusIdentity>`: Identity Parameter + - `[Alias <String>]`: The Disaster Recovery configuration name + - `[AuthorizationRuleName <String>]`: The authorization rule name. + - `[ConfigName <MigrationConfigurationName?>]`: The configuration name. Should always be "$default". + - `[Id <String>]`: Resource identity path + - `[NamespaceName <String>]`: The namespace name + - `[PrivateEndpointConnectionName <String>]`: The PrivateEndpointConnection name + - `[QueueName <String>]`: The queue name. + - `[ResourceGroupName <String>]`: Name of the Resource group within the Azure subscription. + - `[RuleName <String>]`: The rule name. + - `[SubscriptionId <String>]`: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[SubscriptionName <String>]`: The subscription name. + - `[TopicName <String>]`: The topic name. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Test-AzServiceBusName.md b/azps-10.1.0/Az.ServiceBus/Test-AzServiceBusName.md new file mode 100644 index 0000000000..7059617b65 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Test-AzServiceBusName.md @@ -0,0 +1,180 @@ +--- +external help file: Az.ServiceBus-help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/test-azservicebusname +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Test-AzServiceBusName.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Test-AzServiceBusName.md +--- + +# Test-AzServiceBusName + +## SYNOPSIS +Checks availability of a namespace name or disaster recovery alias. + +## SYNTAX + +### NamespaceAvailability (Default) +``` +Test-AzServiceBusName -NamespaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [<CommonParameters>] +``` + +### AliasAvailability +``` +Test-AzServiceBusName -NamespaceName <String> [-SubscriptionId <String>] -AliasName <String> + -ResourceGroupName <String> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [<CommonParameters>] +``` + +## DESCRIPTION +Checks availability of a namespace name or disaster recovery alias. + +## EXAMPLES + +### Example 1: Check the availability of a ServiceBus namespace name +```powershell +Test-AzServiceBusName -NamespaceName myNamespace +``` + +```output +Message NameAvailable Reason +------- ------------- ------ +The specified name is not available. For more information visit https://aka.ms/eventhubsarmexceptions. False NameInUse +``` + +Checks the availability of namespace name `myNamespace`. + +### Example 2: Check the availability of a ServiceBus Geo Disaster Recovery Alias +```powershell +Test-AzServiceBusName -NamespaceName myNamespace -ResourceGroupName myResourceGroup -AliasName myAlias +``` + +```output +Message NameAvailable Reason +------- ------------- ------ +The specified name is not available. For more information visit https://aka.ms/eventhubsarmexceptions. False NameInUse +``` + +Checks the availability of alias name `myAlias` on namespace `myNamepace`. + +## PARAMETERS + +### -AliasName +The name of Disaster Recovery Config alias. + +```yaml +Type: System.String +Parameter Sets: AliasAvailability +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NamespaceName +The name of ServiceBus namespace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource + +```yaml +Type: System.String +Parameter Sets: AliasAvailability +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ICheckNameAvailabilityResult + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceBus/Test-AzServiceBusNameAvailability.md b/azps-10.1.0/Az.ServiceBus/Test-AzServiceBusNameAvailability.md new file mode 100644 index 0000000000..dbf5b4f376 --- /dev/null +++ b/azps-10.1.0/Az.ServiceBus/Test-AzServiceBusNameAvailability.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.dll-Help.xml +Module Name: Az.ServiceBus +online version: https://learn.microsoft.com/powershell/module/az.servicebus/test-azservicebusnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Test-AzServiceBusNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceBus/ServiceBus/help/Test-AzServiceBusNameAvailability.md +--- + +# Test-AzServiceBusNameAvailability + +## SYNOPSIS +Checks the Availability of the given Queue or Topic name + +## SYNTAX + +### QueueCheckNameAvailabilitySet (Default) +``` +Test-AzServiceBusNameAvailability [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-Queue] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### TopicCheckNameAvailabilitySet +``` +Test-AzServiceBusNameAvailability [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-Topic] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzServiceBusNameAvailability** Cmdlet Check Availability of the provided Name of Queue or Topic + +## EXAMPLES + +### Example 1 +```powershell +Test-AzServiceBusNameAvailability -ResourceGroupName $resourceGroupName -Namespace $namespaceName -Name $nameQueue -Queue +``` + +```output +True +``` + +Returns True if the Provided $nameQueue name is Availabile or returns False if Provided $nameQueue name in not available + +### Example 2 +```powershell +Test-AzServiceBusNameAvailability -ResourceGroupName $resourceGroupName -Namespace $namespaceName -Name $nameTopic -Topic +``` + +```output +True +``` + +Returns True if the Provided $nameTopic name is Availabile or returns False if Provided $nameTopic name in not available + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Queue Name to check the Name Availability + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Namespace +Servicebus Namespace Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: NamespaceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Queue +To Check Name Availability for Queue Name + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: QueueCheckNameAvailabilitySet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Topic +To Check Name Availability for Topic Name + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: TopicCheckNameAvailabilitySet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricClientCertificate.md b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricClientCertificate.md new file mode 100644 index 0000000000..8604e9a6e6 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricClientCertificate.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/add-azservicefabricclientcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricClientCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricClientCertificate.md +--- + +# Add-AzServiceFabricClientCertificate + +## SYNOPSIS +Add common name or thumbprint to the cluster for client authentication purposes. + +## SYNTAX + +### SingleUpdateWithThumbprint +``` +Add-AzServiceFabricClientCertificate [-Admin] [-ResourceGroupName] <String> [-Name] <String> + -Thumbprint <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SingleUpdateWithCommonName +``` +Add-AzServiceFabricClientCertificate [-Admin] [-ResourceGroupName] <String> [-Name] <String> + -CommonName <String> -IssuerThumbprint <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### MultipleUpdatesWithCommonName +``` +Add-AzServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String> + -ClientCertificateCommonName <PSClientCertificateCommonName[]> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MultipleUpdatesWithThumbprint +``` +Add-AzServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String> + [-AdminClientThumbprint <String[]>] [-ReadonlyClientThumbprint <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use **Add-AzServiceFabricClientCertificate** to add a common name and issuer thumbprint or certificate thumbprint to the cluster, so the client can use it for authentication. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzServiceFabricClientCertificate -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -Thumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A -Admin +``` + +This command will add the certificate with thumbprint '5F3660C715EBBDA31DB1FFDCF508302348DE8E7A' to the cluster, so the client can use the certificate as admin to communicate with the cluster. + +### Example 2 +```powershell +Add-AzServiceFabricClientCertificate -ResourceGroupName 'Group2' -Name 'Contoso02SFCluster' -CommonName 'Contoso.com' -IssuerThumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A +``` + +This command will add a read only client certificate that's common name is 'Contoso.com' and issuer thumbprint is '5F3660C715EBBDA31DB1FFDCF508302348DE8E7A' to the cluster. + +## PARAMETERS + +### -Admin +Client authentication type + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SingleUpdateWithThumbprint, SingleUpdateWithCommonName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AdminClientThumbprint +Specify client certificate thumbprint which only has admin permission + +```yaml +Type: System.String[] +Parameter Sets: MultipleUpdatesWithThumbprint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ClientCertificateCommonName +Specify client common name , issuer thumbprint and authentication type + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSClientCertificateCommonName[] +Parameter Sets: MultipleUpdatesWithCommonName +Aliases: CertCommonName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CommonName +Specify client certificate common name + +```yaml +Type: System.String +Parameter Sets: SingleUpdateWithCommonName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IssuerThumbprint +Specify thumbprint of client certificate's issuer + +```yaml +Type: System.String +Parameter Sets: SingleUpdateWithCommonName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReadonlyClientThumbprint +Specify client certificate thumbprint which only has read only permission + +```yaml +Type: System.String[] +Parameter Sets: MultipleUpdatesWithThumbprint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Thumbprint +Specify client certificate thumbprint + +```yaml +Type: System.String +Parameter Sets: SingleUpdateWithThumbprint +Aliases: ClientCertificateThumbprint + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.SwitchParameter + +### System.String + +### System.String[] + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSClientCertificateCommonName[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster + +## NOTES + +## RELATED LINKS + +[Remove-AzServiceFabricClientCertificate](./Remove-AzServiceFabricClientCertificate.md) diff --git a/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricManagedClusterClientCertificate.md b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricManagedClusterClientCertificate.md new file mode 100644 index 0000000000..2ebc9aafa7 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricManagedClusterClientCertificate.md @@ -0,0 +1,260 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/add-azservicefabricmanagedclusterclientcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricManagedClusterClientCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricManagedClusterClientCertificate.md +--- + +# Add-AzServiceFabricManagedClusterClientCertificate + +## SYNOPSIS +Add certificate common name or thumbprint to the cluster. This will register the certificate agains the cluster for client authentication purposes. + +## SYNTAX + +### ClientCertByTpByObj (Default) +``` +Add-AzServiceFabricManagedClusterClientCertificate [-InputObject] <PSManagedCluster> [-Admin] + -Thumbprint <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ClientCertByTpByName +``` +Add-AzServiceFabricManagedClusterClientCertificate [-ResourceGroupName] <String> [-Name] <String> [-Admin] + -Thumbprint <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ClientCertByCnByName +``` +Add-AzServiceFabricManagedClusterClientCertificate [-ResourceGroupName] <String> [-Name] <String> [-Admin] + -CommonName <String> [-IssuerThumbprint <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClientCertByCnByObj +``` +Add-AzServiceFabricManagedClusterClientCertificate [-InputObject] <PSManagedCluster> [-Admin] + -CommonName <String> [-IssuerThumbprint <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Add certificate common name or thumbprint to the cluster. This will register the certificate agains the cluster for client authentication purposes. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +Add-AzServiceFabricManagedClusterClientCertificate -ResourceGroupName $rgName -ClusterName $clusterName -Thumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A -Admin +``` + +This command will add the certificate with thumbprint '5F3660C715EBBDA31DB1FFDCF508302348DE8E7A' to the cluster, so the client can use the certificate as admin to communicate with the cluster. + +### Example 2 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +Add-AzServiceFabricManagedClusterClientCertificate -ResourceGroupName $rgName -ClusterName $clusterName -CommonName 'Contoso.com' -IssuerThumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A, 5F3660C715EBBDA31DB1FFDCF508302348DE8E7B +``` + +This command will add a read only client certificate with common name 'Contoso.com' and 2 issuers. + +### Example 3 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$cluster = Get-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Name $clusterName +$cluster | Add-AzServiceFabricManagedClusterClientCertificate -CommonName 'Contoso.com' -IssuerThumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A, 5F3660C715EBBDA31DB1FFDCF508302348DE8E7B +``` + +This command will add a read only client certificate with common name 'Contoso.com' and 2 issuers, with piping. + +## PARAMETERS + +### -Admin +Use to specify if the client certificate has administrator level. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommonName +Client certificate common name. + +```yaml +Type: System.String +Parameter Sets: ClientCertByCnByName, ClientCertByCnByObj +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Managed cluster resource + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedCluster +Parameter Sets: ClientCertByTpByObj, ClientCertByCnByObj +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IssuerThumbprint +List of Issuer thumbprints for the client certificate. +Only use in combination with CommonName. + +```yaml +Type: System.String[] +Parameter Sets: ClientCertByCnByName, ClientCertByCnByObj +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ClientCertByTpByName, ClientCertByCnByName +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ClientCertByTpByName, ClientCertByCnByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Thumbprint +Client certificate thumbprint. + +```yaml +Type: System.String +Parameter Sets: ClientCertByTpByObj, ClientCertByTpByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricManagedClusterNetworkSecurityRule.md b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricManagedClusterNetworkSecurityRule.md new file mode 100644 index 0000000000..9743492055 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricManagedClusterNetworkSecurityRule.md @@ -0,0 +1,363 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/add-azservicefabricmanagedclusternetworksecurityrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricManagedClusterNetworkSecurityRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricManagedClusterNetworkSecurityRule.md +--- + +# Add-AzServiceFabricManagedClusterNetworkSecurityRule + +## SYNOPSIS +Add network security rule to cluster resource. + +## SYNTAX + +### ByObj (Default) +``` +Add-AzServiceFabricManagedClusterNetworkSecurityRule [-InputObject] <PSManagedCluster> + -Access <NetworkSecurityAccess> [-Description <String>] -DestinationAddressPrefix <String[]> + -DestinationPortRange <String[]> -Direction <NetworkSecurityDirection> -Name <String> -Priority <Int32> + -Protocol <NetworkSecurityProtocol> -SourceAddressPrefix <String[]> -SourcePortRange <String[]> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByName +``` +Add-AzServiceFabricManagedClusterNetworkSecurityRule [-ResourceGroupName] <String> [-ClusterName] <String> + -Access <NetworkSecurityAccess> [-Description <String>] -DestinationAddressPrefix <String[]> + -DestinationPortRange <String[]> -Direction <NetworkSecurityDirection> -Name <String> -Priority <Int32> + -Protocol <NetworkSecurityProtocol> -SourceAddressPrefix <String[]> -SourcePortRange <String[]> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Add network security rule to cluster resource. This will add network security rule with specified properties + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "sfmcps-test-rg" +$clusterName = "sfmcps-test-cluster" +$NSRName = "testSecRule1" +$sourcePortRanges = "1-1000" +$destinationPortRanges = "1-65535" +$destinationAddressPrefixes = "194.69.104.0/25", "194.69.119.64/26", "167.220.249.128/26", "255.255.255.255/32" +$sourceAddressPrefixes = "167.220.242.0/27", "167.220.0.0/23", "131.107.132.16/28", "167.220.81.128/26" + +$cluster = Add-AzServiceFabricManagedClusterNetworkSecurityRule -ResourceGroupName $resourceGroupName -ClusterName $clusterName ` + -Name $NSRName -Access Allow -Direction Outbound -Protocol tcp -Priority 1200 -SourcePortRange $sourcePortRange -DestinationPortRange $destinationPortRanges -DestinationAddressPrefix $destinationAddressPrefixes -SourceAddressPrefix $sourceAddressPrefixes -Verbose +``` + +This command will add network security rule with properties above. + +### Example 2 +```powershell +$resourceGroupName = "sfmcps-test-rg" +$clusterName = "sfmcps-test-cluster" +$NSRName = "testSecRule2" +$sourcePortRanges = "1-1000" +$destinationPortRanges = "1-65535" +$destinationAddressPrefixes = "194.69.104.0/25", "194.69.119.64/26", "167.220.249.128/26", "255.255.255.255/32" +$sourceAddressPrefixes = "167.220.242.0/27", "167.220.0.0/23", "131.107.132.16/28", "167.220.81.128/26" + +$cluster = Add-AzServiceFabricManagedClusterNetworkSecurityRule -ResourceGroupName $resourceGroupName -ClusterName $clusterName ` + -Name $NSRName -Access Deny -Direction Outbound -Protocol udp -Priority 1300 -SourcePortRange $sourcePortRange -DestinationPortRange $destinationPortRanges -DestinationAddressPrefix $destinationAddressPrefixes -SourceAddressPrefix $sourceAddressPrefixes -Verbose +``` + +Similar to Example1 with different properties. + +### Example 3 +```powershell +$resourceGroupName = "sfmcps-test-rg" +$clusterName = "sfmcps-test-cluster" +$NSRName = "testSecRule3" +$description = "test network security rule" +$sourcePortRanges = "1-1000" +$destinationPortRanges = "1-65535" +$destinationAddressPrefixes = "194.69.104.0/25", "194.69.119.64/26", "167.220.249.128/26", "255.255.255.255/32" +$sourceAddressPrefixes = "167.220.242.0/27", "167.220.0.0/23", "131.107.132.16/28", "167.220.81.128/26" + +$cluster = $clusterFromGet | Add-AzServiceFabricManagedClusterNetworkSecurityRule ` + -Name $NSRName -Access Allow -Description $description -Direction Outbound -Protocol tcp -Priority 1400 -SourcePortRange $sourcePortRanges -DestinationPortRange $destinationPortRanges -DestinationAddressPrefix $destinationAddressPrefixes -SourceAddressPrefix $sourceAddressPrefixes -Verbose +``` + +This command will add a network security rule using cluster object with piping. + +## PARAMETERS + +### -Access +Gets or sets the network traffic is allowed or denied. Possible values include: Allow, Deny + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.NetworkSecurityAccess +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background and return a Job to track progress + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Gets or sets network security rule description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationAddressPrefix +Gets or sets the destination address prefixes. CIDR or destination IP ranges + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPortRange +Gets or sets the destination port ranges + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Gets or sets network security rule direction. Possible values include: Inbound, Outbound + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.NetworkSecurityDirection +Parameter Sets: (All) +Aliases: +Accepted values: Inbound, Outbound + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Managed cluster resource + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedCluster +Parameter Sets: ByObj +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Network Security Rule name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: NetworkSecurityRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Gets or sets the priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Gets or sets network protocol this rule applies to. Possible values include: http, https, tcp, udp, icmp, ah, esp, any + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.NetworkSecurityProtocol +Parameter Sets: (All) +Aliases: +Accepted values: https, http, udp, tcp, esp, icmp, ah, any + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceAddressPrefix +Gets or sets the CIDR or source IP ranges + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourcePortRange +Run cmdlet in the background and return a Job to track progress + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricManagedNodeTypeVMExtension.md b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricManagedNodeTypeVMExtension.md new file mode 100644 index 0000000000..be2a912003 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricManagedNodeTypeVMExtension.md @@ -0,0 +1,349 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/add-azservicefabricmanagednodetypevmextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricManagedNodeTypeVMExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricManagedNodeTypeVMExtension.md +--- + +# Add-AzServiceFabricManagedNodeTypeVMExtension + +## SYNOPSIS +Add vm extension to the node type. + +## SYNTAX + +### ByObj (Default) +``` +Add-AzServiceFabricManagedNodeTypeVMExtension [-InputObject] <PSManagedNodeType> -Name <String> + [-ForceUpdateTag <String>] -Publisher <String> -Type <String> -TypeHandlerVersion <String> + [-AutoUpgradeMinorVersion] [-Setting <Object>] [-ProtectedSetting <Object>] + [-ProvisionAfterExtension <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByName +``` +Add-AzServiceFabricManagedNodeTypeVMExtension [-ResourceGroupName] <String> [-ClusterName] <String> + [-NodeTypeName] <String> -Name <String> [-ForceUpdateTag <String>] -Publisher <String> -Type <String> + -TypeHandlerVersion <String> [-AutoUpgradeMinorVersion] [-Setting <Object>] [-ProtectedSetting <Object>] + [-ProvisionAfterExtension <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Add vm extension to the node type. This will add the extension to the underliying Virtual Machine Scale Set resource. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +Add-AzServiceFabricManagedNodeTypeVMExtension -ResourceGroupName $rgName -ClusterName $clusterName -NodeTypeName $NodeTypeName -Name $ExtName -Publisher $Publisher -Type $ExtType -TypeHandlerVersion $ExtVer -AutoUpgradeMinorVersion -Verbose +``` + +This command adds an extension to the node type. + +### Example 2 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +$settings = @{ "secretsManagementSettings" = @{ "pollingIntervalInS" = "3600"; "certificateStoreName" = "MY"; "certificateStoreLocation" = "LocalMachine"; "observedCertificates" = @( "https:/testkv.vault.azure.net/secrets/TestSecret" ) } }; +$protectedSettings = @{"testProgectedSetting" = $protectedSetting }; +Add-AzServiceFabricManagedNodeTypeVMExtension -ResourceGroupName $rgName -ClusterName $clusterName -NodeTypeName $NodeTypeName -Name KeyVaultForWindows -Publisher Microsoft.Azure.KeyVault -Type KeyVaultForWindows -TypeHandlerVersion 1.0 -Setting $settings -ProtectedSetting $protectedSettings -AutoUpgradeMinorVersion -Verbose +``` + +This command adds an extension with settings and protected settings to the node type. + +### Example 3 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +$nodeType = Get-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName + +$nodeType | Add-AzServiceFabricManagedNodeTypeVMExtension $ExtName -Publisher $Publisher -Type $ExtType -TypeHandlerVersion $ExtVer -AutoUpgradeMinorVersion -Verbose +``` + +This command adds an extension to the node type, with piping. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoUpgradeMinorVersion +Indicates whether the extension should use a newer minor version if one is available at deployment time. +Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceUpdateTag +If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Node Type resource + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedNodeType +Parameter Sets: ByObj +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +extension name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeTypeName +Specify the name of the node type. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProtectedSetting +The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisionAfterExtension +Collection of extension names after which this extension needs to be provisioned. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Publisher +The name of the extension handler publisher. +This can use the Get-AzVMImagePublisher cmdlet to get the publisher. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Setting +Json formatted public settings for the extension. + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specifies the type of the extension; an example is "CustomScriptExtension". +You can use the Get-AzVMExtensionImageType cmdlet to get the extension type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TypeHandlerVersion +Specifies the version of the script handler. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedNodeType + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedNodeType + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricManagedNodeTypeVMSecret.md b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricManagedNodeTypeVMSecret.md new file mode 100644 index 0000000000..ad0fb335c3 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricManagedNodeTypeVMSecret.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/add-azservicefabricmanagednodetypevmsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricManagedNodeTypeVMSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricManagedNodeTypeVMSecret.md +--- + +# Add-AzServiceFabricManagedNodeTypeVMSecret + +## SYNOPSIS +Add certificate secret to the node type. + +## SYNTAX + +### ByObj (Default) +``` +Add-AzServiceFabricManagedNodeTypeVMSecret [-InputObject] <PSManagedNodeType> -SourceVaultId <String> + -CertificateUrl <String> -CertificateStore <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByName +``` +Add-AzServiceFabricManagedNodeTypeVMSecret [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name] <String> -SourceVaultId <String> -CertificateUrl <String> -CertificateStore <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Add certificate secret to the node type. The secret must be stored in an Azure Key Vault. For more information relating to Key Vault, see What is Azure Key Vault? (https://azure.microsoft.com/en-us/documentation/articles/key-vault-whatis/). For more information about the cmdlets, see Azure Key Vault Cmdlets (/powershell/module/az.keyvault/) in the Microsoft Developer Network library or the Set-AzKeyVaultSecret cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +Add-AzServiceFabricManagedNodeTypeVMSecret -ResourceGroupName $rgName -ClusterName $clusterName -NodeTypeName $NodeTypeName -SourceVaultId /subscriptions/XXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/testRG/providers/Microsoft.KeyVault/vaults/testkv -CertificateUrl https://testskv.vault.azure.net:443/secrets/TestCert/xxxxxxxxxxxxxxxxxxxxxxxx -CertificateStore My -Verbose +``` + +This commad adds a certificate secret from the keyvault and secret identifier specified. + +### Example 2 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +$nodeType = Get-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName + +$nodeType | Add-AzServiceFabricManagedNodeTypeVMSecret -SourceVaultId /subscriptions/XXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/testRG/providers/Microsoft.KeyVault/vaults/testkv -CertificateUrl https://testskv.vault.azure.net:443/secrets/TestCert/xxxxxxxxxxxxxxxxxxxxxxxx -CertificateStore My -Verbose +``` + +This commad adds a certificate secret from the keyvault and secret identifier specified, with piping. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateStore +Specifies the certificate store on the Virtual Machine to which the certificate should be added. +The specified certificate store is implicitly in the LocalMachine account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateUrl +This is the URL of a certificate that has been uploaded to Key Vault as a secret. +For adding a secret to the Key Vault, see \[Add a key or secret to the key vault\](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). +In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: \<br\>\<br\> {\<br\> "data":"\<Base64-encoded-certificate\>",\<br\> "dataType":"pfx",\<br\> "password":"\<pfx-file-password\>"\<br\>}/ + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Node Type resource + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedNodeType +Parameter Sets: ByObj +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the node type. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: NodeTypeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceVaultId +Key Vault resource id containing the certificates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedNodeType + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricNode.md b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricNode.md new file mode 100644 index 0000000000..9779637523 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricNode.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/add-azservicefabricnode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricNode.md +--- + +# Add-AzServiceFabricNode + +## SYNOPSIS +Add nodes to the specific node type in the cluster. + +## SYNTAX + +``` +Add-AzServiceFabricNode -NumberOfNodesToAdd <Int32> [-ResourceGroupName] <String> [-Name] <String> + -NodeType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use **Add-AzServiceFabricNode** to add nodes to the specific node type. You just need to specify the number of nodes you want to add to a node type. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzServiceFabricNode -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -NumberOfNodesToAdd 2 -NodeType 'nt1' +``` + +This command will add 2 nodes to the node type 'n1'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeType +Node type name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NumberOfNodesToAdd +The number of nodes to add + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Number + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster + +## NOTES + +## RELATED LINKS + +[Remove-AzServiceFabricNode](./Remove-AzServiceFabricNode.md) diff --git a/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricNodeType.md b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricNodeType.md new file mode 100644 index 0000000000..9a937d7793 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Add-AzServiceFabricNodeType.md @@ -0,0 +1,335 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/add-azservicefabricnodetype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricNodeType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Add-AzServiceFabricNodeType.md +--- + +# Add-AzServiceFabricNodeType + +## SYNOPSIS +Add a new node type to the existing cluster. + +## SYNTAX + +``` +Add-AzServiceFabricNodeType [-ResourceGroupName] <String> [-Name] <String> -Capacity <Int32> + -VmUserName <String> -VmPassword <SecureString> [-VmSku <String>] [-Tier <String>] + [-DurabilityLevel <DurabilityLevel>] [-IsPrimaryNodeType <Boolean>] [-VMImagePublisher <String>] + [-VMImageOffer <String>] [-VMImageSku <String>] [-VMImageVersion <String>] -NodeType <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Add a new node type to a existing cluster. + +## EXAMPLES + +### Example 1 +```powershell +$pwd = ConvertTo-SecureString -String 'Password$123456' -AsPlainText -Force +Add-AzServiceFabricNodeType -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -NodeType 'n2' -Capacity 5 -VmUserName 'adminName' -VmPassword $pwd +``` + +This command will add a new NodeType 'n2' with capacity of 5, and the vm admin name is 'adminName'. + +### Example 2 +New node type will be a primary node type and will copy the VM image reference of the first +discovered preexiting Node Type VMSS, substituting ImageSku with 18.04-LTS. +- Existing node type image reference: ImagePublisher: Canonical, ImageOffer: UbuntuServer, ImageSku: 16.04-LTS, ImageVersion: latest +- New node type image reference: ImagePublisher: Canonical, ImageOffer: UbuntuServer, ImageSku: 18.04-LTS, ImageVersion: latest + + +```powershell +$pwd = ConvertTo-SecureString -String 'Password$123456' -AsPlainText -Force +$resourceGroup = "Group2" +$clusterName = "Contoso01SFCluster" +$nodeTypeName = "n3" +Add-AzServiceFabricNodeType -ResourceGroupName $resourceGroup -Name $clusterName -NodeType $nodeTypeName -Capacity 5 -VmUserName 'adminName' -VmPassword $pwd -DurabilityLevel Silver -Verbose -VMImageSku 18.04-LTS -IsPrimaryNodeType $true +``` + +This command will add a new NodeType 'n3' with capacity of 5, the vm admin name is 'adminName', Durability level Silver (tenant and infrastructure jobs are safely brokered using the Infrastructure Service), and VMSS is created using VM image profile publisher-offer-sku-version with sku interchanged to '18.04-LTS'. + +## PARAMETERS + +### -Capacity +Capacity + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DurabilityLevel +Specify the durability level of the NodeType. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.DurabilityLevel +Parameter Sets: (All) +Aliases: +Accepted values: Bronze, Silver, Gold + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsPrimaryNodeType +Define whether the node type is a primary node type. Primary node type may have seed nodes and system services. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeType +The node type name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tier +Vm Sku Tier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMImageOffer +Specify the VM image reference Offer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMImagePublisher +Specify the VM image reference Publisher. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMImageSku +Specify the VM image reference Sku. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMImageVersion +Specify the VM image reference Version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VmPassword +The password for login to the Vm + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VmSku +The sku name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VmUserName +The user name for logging to Vm + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +### System.Security.SecureString + +### Microsoft.Azure.Commands.ServiceFabric.Models.DurabilityLevel + +### System.Nullable<System.Boolean> + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Az.ServiceFabric.md b/azps-10.1.0/Az.ServiceFabric/Az.ServiceFabric.md new file mode 100644 index 0000000000..fc20fd6ba9 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Az.ServiceFabric.md @@ -0,0 +1,192 @@ +--- +Module Name: Az.ServiceFabric +Module Guid: 60f3ba88-443f-46ff-88a3-318cfd11c1da +Download Help Link: https://learn.microsoft.com/powershell/module/az.servicefabric +Help Version: 0.3.4.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Az.ServiceFabric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Az.ServiceFabric.md +--- + +# Az.ServiceFabric Module +## Description +Azure Service Fabric Module that you can use to automate the end-2-end operations like creating a secure cluster, rolling over cluster certificates, adding or removed nodes from the cluster, etc. The complete list of all operations are listed below. + +## Az.ServiceFabric Cmdlets +### [Add-AzServiceFabricClientCertificate](Add-AzServiceFabricClientCertificate.md) +Add common name or thumbprint to the cluster for client authentication purposes. + +### [Add-AzServiceFabricManagedClusterClientCertificate](Add-AzServiceFabricManagedClusterClientCertificate.md) +Add certificate common name or thumbprint to the cluster. This will register the certificate agains the cluster for client authentication purposes. + +### [Add-AzServiceFabricManagedClusterNetworkSecurityRule](Add-AzServiceFabricManagedClusterNetworkSecurityRule.md) +Add network security rule to cluster resource. + +### [Add-AzServiceFabricManagedNodeTypeVMExtension](Add-AzServiceFabricManagedNodeTypeVMExtension.md) +Add vm extension to the node type. + +### [Add-AzServiceFabricManagedNodeTypeVMSecret](Add-AzServiceFabricManagedNodeTypeVMSecret.md) +Add certificate secret to the node type. + +### [Add-AzServiceFabricNode](Add-AzServiceFabricNode.md) +Add nodes to the specific node type in the cluster. + +### [Add-AzServiceFabricNodeType](Add-AzServiceFabricNodeType.md) +Add a new node type to the existing cluster. + +### [Get-AzServiceFabricApplication](Get-AzServiceFabricApplication.md) +Get Service Fabric application details. Only supports ARM deployed applications. + +### [Get-AzServiceFabricApplicationType](Get-AzServiceFabricApplicationType.md) +Get Service Fabric application type details. Only supports ARM deployed application types. + +### [Get-AzServiceFabricApplicationTypeVersion](Get-AzServiceFabricApplicationTypeVersion.md) +Get Service Fabric application type version details. Only supports ARM deployed application type versions. + +### [Get-AzServiceFabricCluster](Get-AzServiceFabricCluster.md) +Get the cluster resource details. + +### [Get-AzServiceFabricManagedCluster](Get-AzServiceFabricManagedCluster.md) +Get the managed cluster resource details. + +### [Get-AzServiceFabricManagedClusterApplication](Get-AzServiceFabricManagedClusterApplication.md) +Get Service Fabric managed application details. Only supports ARM deployed applications. + +### [Get-AzServiceFabricManagedClusterApplicationType](Get-AzServiceFabricManagedClusterApplicationType.md) +Get Service Fabric managed application type details. Only supports ARM deployed application types. + +### [Get-AzServiceFabricManagedClusterApplicationTypeVersion](Get-AzServiceFabricManagedClusterApplicationTypeVersion.md) +Get Service Fabric managed application type version details. Only supports ARM deployed application type versions. + +### [Get-AzServiceFabricManagedClusterService](Get-AzServiceFabricManagedClusterService.md) +Get Service Fabric managed service details under the specified application and cluster. Only supports ARM deployed services. + +### [Get-AzServiceFabricManagedNodeType](Get-AzServiceFabricManagedNodeType.md) +Get the managed node type resource details. + +### [Get-AzServiceFabricService](Get-AzServiceFabricService.md) +Get Service Fabric service details under the specified application and cluster. Only supports ARM deployed services. + +### [New-AzServiceFabricApplication](New-AzServiceFabricApplication.md) +Create new service fabric application under the specified resource group and cluster. + +### [New-AzServiceFabricApplicationType](New-AzServiceFabricApplicationType.md) +Create new service fabric application type under the specified resource group and cluster. + +### [New-AzServiceFabricApplicationTypeVersion](New-AzServiceFabricApplicationTypeVersion.md) +Create new application type version under the specified resource group and cluster. + +### [New-AzServiceFabricCluster](New-AzServiceFabricCluster.md) +This command uses certificates that you provide or system generated self-signed certificates to set up a new service fabric cluster. It can use a default template or a custom template that you provide. You have the option of specifying a folder to export the self-signed certificates to or fetching them later from the key vault. + +### [New-AzServiceFabricManagedCluster](New-AzServiceFabricManagedCluster.md) +Create new managed cluster. + +### [New-AzServiceFabricManagedClusterApplication](New-AzServiceFabricManagedClusterApplication.md) +Create new service fabric managed application under the specified resource group and cluster. + +### [New-AzServiceFabricManagedClusterApplicationType](New-AzServiceFabricManagedClusterApplicationType.md) +Create new service fabric managed application type under the specified resource group and cluster. + +### [New-AzServiceFabricManagedClusterApplicationTypeVersion](New-AzServiceFabricManagedClusterApplicationTypeVersion.md) +Create new managed application type version under the specified resource group and cluster. + +### [New-AzServiceFabricManagedClusterService](New-AzServiceFabricManagedClusterService.md) +Create new service fabric managed service under the specified application and cluster. + +### [New-AzServiceFabricManagedNodeType](New-AzServiceFabricManagedNodeType.md) +Create new node type resource. + +### [New-AzServiceFabricService](New-AzServiceFabricService.md) +Create new service fabric service under the specified application and cluster. + +### [Remove-AzServiceFabricApplication](Remove-AzServiceFabricApplication.md) +Remove an application from the cluster. This will remove all the services under the application. Only supports ARM deployed applications. + +### [Remove-AzServiceFabricApplicationType](Remove-AzServiceFabricApplicationType.md) +Remove Service fabric an application type from the cluster. This will remove all type versions under this resource. Only supports ARM deployed application types. + +### [Remove-AzServiceFabricApplicationTypeVersion](Remove-AzServiceFabricApplicationTypeVersion.md) +Remove Service fabric an application type version from the cluster. Only supports ARM deployed application type versions. + +### [Remove-AzServiceFabricClientCertificate](Remove-AzServiceFabricClientCertificate.md) +Remove a client certificate(s) or certificate subject(s) name(s) from being used for client authentication to the cluster. + +### [Remove-AzServiceFabricManagedCluster](Remove-AzServiceFabricManagedCluster.md) +Remove cluster resource. + +### [Remove-AzServiceFabricManagedClusterApplication](Remove-AzServiceFabricManagedClusterApplication.md) +Remove an managed application from the cluster. This will remove all the managed services under the application. Only supports ARM deployed applications. + +### [Remove-AzServiceFabricManagedClusterApplicationType](Remove-AzServiceFabricManagedClusterApplicationType.md) +Removes a managed application type from the cluster. This will remove all type versions under this resource. Only supports ARM deployed application types. + +### [Remove-AzServiceFabricManagedClusterApplicationTypeVersion](Remove-AzServiceFabricManagedClusterApplicationTypeVersion.md) +Removes a managed application type version from the cluster. Only supports ARM deployed application type versions. + +### [Remove-AzServiceFabricManagedClusterClientCertificate](Remove-AzServiceFabricManagedClusterClientCertificate.md) +Remvoe client certificate by thumbprint or common name. + +### [Remove-AzServiceFabricManagedClusterService](Remove-AzServiceFabricManagedClusterService.md) +Remove a managed service from the cluster. Only supports ARM deployed services. + +### [Remove-AzServiceFabricManagedNodeType](Remove-AzServiceFabricManagedNodeType.md) +Remove the node type or specific nodes within the node type. + +### [Remove-AzServiceFabricManagedNodeTypeVMExtension](Remove-AzServiceFabricManagedNodeTypeVMExtension.md) +Remove vm extension from the node type. + +### [Remove-AzServiceFabricNode](Remove-AzServiceFabricNode.md) +Remove nodes from the specific node type from a cluster. + +### [Remove-AzServiceFabricNodeType](Remove-AzServiceFabricNodeType.md) +Remove a complete node type from a cluster. + +### [Remove-AzServiceFabricService](Remove-AzServiceFabricService.md) +Remove a service from the cluster. Only supports ARM deployed services. + +### [Remove-AzServiceFabricSetting](Remove-AzServiceFabricSetting.md) +Remove one or multiple Service Fabric setting from the cluster. + +### [Restart-AzServiceFabricManagedNodeType](Restart-AzServiceFabricManagedNodeType.md) +Restart specific nodes from the node type. + +### [Set-AzServiceFabricManagedCluster](Set-AzServiceFabricManagedCluster.md) +Set cluster resource properties. + +### [Set-AzServiceFabricManagedClusterApplication](Set-AzServiceFabricManagedClusterApplication.md) +Update a service fabric managed application. This allows to update the application parameters and/or upgrade the application type version which will trigger an application upgrade or other configuration only updates. Only supports ARM deployed applications. + +### [Set-AzServiceFabricManagedClusterApplicationType](Set-AzServiceFabricManagedClusterApplicationType.md) +Update a service fabric managed application type. This allows you to update the tags. Only supports ARM deployed application types. + +### [Set-AzServiceFabricManagedClusterApplicationTypeVersion](Set-AzServiceFabricManagedClusterApplicationTypeVersion.md) +Update a service fabric managed application type version. This allows you to update the tags and package Url. Only supports ARM deployed application type versions. + +### [Set-AzServiceFabricManagedClusterService](Set-AzServiceFabricManagedClusterService.md) +Update a managed service from the cluster. Only supports ARM deployed services. + +### [Set-AzServiceFabricManagedNodeType](Set-AzServiceFabricManagedNodeType.md) +Sets node type resource properties or run reimage actions on specific ndes of the node type with -Reimage parameter. + +### [Set-AzServiceFabricSetting](Set-AzServiceFabricSetting.md) +Add or update one or multiple Service Fabric settings to the cluster. + +### [Set-AzServiceFabricUpgradeType](Set-AzServiceFabricUpgradeType.md) +Change the Service Fabric upgrade type of the cluster. + +### [Update-AzServiceFabricApplication](Update-AzServiceFabricApplication.md) +Update a service fabric application. This allows to update the application parameters and/or upgrade the application type version which will trigger an application upgrade. Only supports ARM deployed applications. + +### [Update-AzServiceFabricDurability](Update-AzServiceFabricDurability.md) +Update the durability tier or VmSku of a node type in the cluster. + +### [Update-AzServiceFabricNodeType](Update-AzServiceFabricNodeType.md) +Update a node type within the cluster. + +### [Update-AzServiceFabricReliability](Update-AzServiceFabricReliability.md) +Update the reliability tier of the primary node type in a cluster. + +### [Update-AzServiceFabricVmImage](Update-AzServiceFabricVmImage.md) +Update the cluster resource vmImage setting which maps the appropriate runtime package to be delivered based on the target operating system. + diff --git a/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricApplication.md b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricApplication.md new file mode 100644 index 0000000000..ebc54866d2 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricApplication.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/get-azservicefabricapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplication.md +--- + +# Get-AzServiceFabricApplication + +## SYNOPSIS +Get Service Fabric application details. Only supports ARM deployed applications. + +## SYNTAX + +### ByResourceGroupAndCluster (Default) +``` +Get-AzServiceFabricApplication [-ResourceGroupName] <String> [-ClusterName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByName +``` +Get-AzServiceFabricApplication [-ResourceGroupName] <String> [-ClusterName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzServiceFabricApplication -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet gets the application details in the specified resource group and cluster. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +Get-AzServiceFabricApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName +``` + +This example gets the application resource details for the application "testApp". + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +Get-AzServiceFabricApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName +``` + +This example gets a list of the applications under the cluster "testCluster". + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the application. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ApplicationName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the application. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSApplication + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricApplicationType.md b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricApplicationType.md new file mode 100644 index 0000000000..5153b6ae6c --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricApplicationType.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/get-azservicefabricapplicationtype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationType.md +--- + +# Get-AzServiceFabricApplicationType + +## SYNOPSIS +Get Service Fabric application type details. Only supports ARM deployed application types. + +## SYNTAX + +### ByResourceGroupAndCluster (Default) +``` +Get-AzServiceFabricApplicationType [-ResourceGroupName] <String> [-ClusterName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByName +``` +Get-AzServiceFabricApplicationType [-ResourceGroupName] <String> [-ClusterName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzServiceFabricApplicationType -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to get the application type details in the specified resource group and cluster. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +Get-AzServiceFabricApplicationType -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName +``` + +This example will get the application type details with the parameters specified, if it doesn't find the resource it will throw an exception. + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +Get-AzServiceFabricApplicationType -ResourceGroupName $resourceGroupName -ClusterName $clusterName +``` + +This example will get a list of the application types defined under the specified cluster. + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the application type + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ApplicationTypeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the application type. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSApplicationType + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricApplicationTypeVersion.md b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricApplicationTypeVersion.md new file mode 100644 index 0000000000..bf670773f3 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricApplicationTypeVersion.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/get-azservicefabricapplicationtypeversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationTypeVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricApplicationTypeVersion.md +--- + +# Get-AzServiceFabricApplicationTypeVersion + +## SYNOPSIS +Get Service Fabric application type version details. Only supports ARM deployed application type versions. + +## SYNTAX + +### ByResourceGroupAndCluster (Default) +``` +Get-AzServiceFabricApplicationTypeVersion [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVersion +``` +Get-AzServiceFabricApplicationTypeVersion [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name] <String> [-Version] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzServiceFabricApplicationTypeVersion -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to get the application type version details in the specified resource group and cluster. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$version = "v1" +Get-AzServiceFabricApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Version $version +``` + +This example gets the application type "testAppType" with version "v1", if it doesn't find the resource it will throw an exception. + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +Get-AzServiceFabricApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName +``` + +This example gets a list of the application type versions defined under the specified cluster and type. + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByVersion +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the application type. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByVersion +Aliases: ApplicationTypeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByVersion +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the application type version. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Specify the version of the application type. + +```yaml +Type: System.String +Parameter Sets: ByVersion +Aliases: ApplicationTypeVersion + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSApplicationTypeVersion + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricCluster.md b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricCluster.md new file mode 100644 index 0000000000..c1d54b7ce0 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricCluster.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/get-azservicefabriccluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricCluster.md +--- + +# Get-AzServiceFabricCluster + +## SYNOPSIS +Get the cluster resource details. + +## SYNTAX + +### BySubscription (Default) +``` +Get-AzServiceFabricCluster [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceGroup +``` +Get-AzServiceFabricCluster [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByName +``` +Get-AzServiceFabricCluster [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzServiceFabricCluster** will get the cluster resource details. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzServiceFabricCluster -ResourceGroupName 'Group1' -ClusterName 'Contoso01SFCluster' +``` + +This command will get the cluster resource details for cluster 'myCluster'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup, ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedCluster.md b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedCluster.md new file mode 100644 index 0000000000..84523470bd --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedCluster.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/get-azservicefabricmanagedcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedCluster.md +--- + +# Get-AzServiceFabricManagedCluster + +## SYNOPSIS +Get the managed cluster resource details. + +## SYNTAX + +### BySubscription (Default) +``` +Get-AzServiceFabricManagedCluster [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceGroup +``` +Get-AzServiceFabricManagedCluster [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ByName +``` +Get-AzServiceFabricManagedCluster [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the managed cluster resource details. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +Get-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Name $clusterName +``` + +Get cluster details. + +### Example 2 +```powershell +$rgName = "testRG" +Get-AzServiceFabricManagedCluster -ResourceGroupName $rgName +``` + +Get list of clusters under the specified resource group. + +### Example 3 +```powershell +Get-AzServiceFabricManagedCluster +``` + +Get list of clusters under the current subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup, ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedClusterApplication.md b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedClusterApplication.md new file mode 100644 index 0000000000..6fec9acde8 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedClusterApplication.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/get-azservicefabricmanagedclusterapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedClusterApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedClusterApplication.md +--- + +# Get-AzServiceFabricManagedClusterApplication + +## SYNOPSIS +Get Service Fabric managed application details. Only supports ARM deployed applications. + +## SYNTAX + +### ByResourceGroupAndCluster (Default) +``` +Get-AzServiceFabricManagedClusterApplication [-ResourceGroupName] <String> [-ClusterName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByName +``` +Get-AzServiceFabricManagedClusterApplication [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzServiceFabricManagedClusterApplication -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet gets the managed application details in the specified resource group and cluster. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +Get-AzServiceFabricManagedClusterApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName +``` + +This example gets the managed application resource details for the managed application "testApp". + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +Get-AzServiceFabricManagedClusterApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName +``` + +This example gets a list of the managed applications under the cluster "testCluster". + +### Example 3 +```powershell +$resourceId = "/subscriptions/13ad2c84-84fa-4798-ad71-e70c07af873f/resourcegroups/testRG/providers/Microsoft.ServiceFabric/managedClusters/testCluster/applications/testApp" +Get-AzServiceFabricManagedClusterApplication -ResourceId $resourceId +``` + +This example will get the managed application details with the ARM Resource ID specified, if it doesn't find the resource it will throw an exception. + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the managed application. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ApplicationName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the managed application. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplication + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedClusterApplicationType.md b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedClusterApplicationType.md new file mode 100644 index 0000000000..a3007c76e7 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedClusterApplicationType.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/get-azservicefabricmanagedclusterapplicationtype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedClusterApplicationType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedClusterApplicationType.md +--- + +# Get-AzServiceFabricManagedClusterApplicationType + +## SYNOPSIS +Get Service Fabric managed application type details. Only supports ARM deployed application types. + +## SYNTAX + +### ByResourceGroupAndCluster (Default) +``` +Get-AzServiceFabricManagedClusterApplicationType [-ResourceGroupName] <String> [-ClusterName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByName +``` +Get-AzServiceFabricManagedClusterApplicationType [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzServiceFabricManagedClusterApplicationType -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to get the managed application type details in the specified resource group and cluster. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +Get-AzServiceFabricManagedClusterApplicationType -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName +``` + +This example will get the managed application type details with the parameters specified, if it doesn't find the resource it will throw an exception. + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +Get-AzServiceFabricManagedClusterApplicationType -ResourceGroupName $resourceGroupName -ClusterName $clusterName +``` + +This example will get a list of the managed application types defined under the specified cluster. + +### Example 3 +```powershell +$resourceId = "/subscriptions/13ad2c84-84fa-4798-ad71-e70c07af873f/resourcegroups/testRG/providers/Microsoft.ServiceFabric/managedClusters/testCluster/applicationTypes/testAppType" +Get-AzServiceFabricManagedClusterApplicationType -ResourceId $resourceId +``` + +This example will get the managed application type details with the ARM Resource ID specified, if it doesn't find the resource it will throw an exception. + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the managed application type + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ApplicationTypeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the managed application type. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationType + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedClusterApplicationTypeVersion.md b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedClusterApplicationTypeVersion.md new file mode 100644 index 0000000000..932abdb6b5 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedClusterApplicationTypeVersion.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/get-azservicefabricmanagedclusterapplicationtypeversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedClusterApplicationTypeVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedClusterApplicationTypeVersion.md +--- + +# Get-AzServiceFabricManagedClusterApplicationTypeVersion + +## SYNOPSIS +Get Service Fabric managed application type version details. Only supports ARM deployed application type versions. + +## SYNTAX + +### ByResourceGroupAndCluster (Default) +``` +Get-AzServiceFabricManagedClusterApplicationTypeVersion [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByVersion +``` +Get-AzServiceFabricManagedClusterApplicationTypeVersion [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name] <String> [-Version] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to get the managed application type version details in the specified resource group and cluster. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$appTypeVersion = "v1" +Get-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Version $appTypeVersion +``` + +This example gets the managed application type "testAppType" with version "v1", if it doesn't find the resource it will throw an exception. + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +Get-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName +``` + +This example gets a list of the managed application type versions defined under the specified cluster and type. + +### Example 3 +```powershell +$resourceId = "/subscriptions/13ad2c84-84fa-4798-ad71-e70c07af873f/resourcegroups/testRG/providers/Microsoft.ServiceFabric/managedClusters/testCluster/applicationTypes/testAppType/versions/v1" +Get-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceId $resourceId +``` + +This example will get the managed application type version details with the ARM Resource ID specified, if it doesn't find the resource it will throw an exception. + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByVersion +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the managed application type. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByVersion +Aliases: ApplicationTypeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByVersion +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the managed application type version. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Specify the version of the managed application type. + +```yaml +Type: System.String +Parameter Sets: ByVersion +Aliases: ApplicationTypeVersion + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationTypeVersion + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedClusterService.md b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedClusterService.md new file mode 100644 index 0000000000..076d9ee558 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedClusterService.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/get-azservicefabricmanagedclusterservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedClusterService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedClusterService.md +--- + +# Get-AzServiceFabricManagedClusterService + +## SYNOPSIS +Get Service Fabric managed service details under the specified application and cluster. Only supports ARM deployed services. + +## SYNTAX + +### ByResourceGroupAndCluster (Default) +``` +Get-AzServiceFabricManagedClusterService [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByName +``` +Get-AzServiceFabricManagedClusterService [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzServiceFabricManagedClusterService -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will get the managed service details in the specified application and cluster. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$serviceName = "testService" +Get-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName +``` + +This example gets the managed service resource details for the managed service "testService". + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +Get-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName +``` + +This example gets a list of the managed services under the application "testApp". + +### Example 3 +```powershell +$resourceId = "/subscriptions/13ad2c84-84fa-4798-ad71-e70c07af873f/resourcegroups/testRG/providers/Microsoft.ServiceFabric/managedClusters/testCluster/applications/testApp/services/testService" +Get-AzServiceFabricManagedClusterService -ResourceId $resourceId +``` + +This example will get the managed service details with the ARM Resource ID specified, if it doesn't find the resource it will throw an exception. + +## PARAMETERS + +### -ApplicationName +Specify the name of the managed application. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the managed service. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ServiceName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the managed service. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedNodeType.md b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedNodeType.md new file mode 100644 index 0000000000..24955dae15 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricManagedNodeType.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/get-azservicefabricmanagednodetype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedNodeType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricManagedNodeType.md +--- + +# Get-AzServiceFabricManagedNodeType + +## SYNOPSIS +Get the managed node type resource details. + +## SYNTAX + +### ByName (Default) +``` +Get-AzServiceFabricManagedNodeType [-ResourceGroupName] <String> [-ClusterName] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceGroup +``` +Get-AzServiceFabricManagedNodeType [-ResourceGroupName] <String> [-ClusterName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the managed node type resource details. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +Get-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName +``` + +Get node type details. + +### Example 2 +```powershell +$rgName = "testRG" +Get-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName +``` + +Get list of node types under the specified cluster. + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the node type. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: NodeTypeName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedNodeType + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricService.md b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricService.md new file mode 100644 index 0000000000..0ef56fc570 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Get-AzServiceFabricService.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/get-azservicefabricservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Get-AzServiceFabricService.md +--- + +# Get-AzServiceFabricService + +## SYNOPSIS +Get Service Fabric service details under the specified application and cluster. Only supports ARM deployed services. + +## SYNTAX + +### ByResourceGroupAndCluster (Default) +``` +Get-AzServiceFabricService [-ResourceGroupName] <String> [-ClusterName] <String> [-ApplicationName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByName +``` +Get-AzServiceFabricService [-ResourceGroupName] <String> [-ClusterName] <String> [-ApplicationName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceId +``` +Get-AzServiceFabricService -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will get the service details in the specified application and cluster. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$serviceName = "testApp~testService" +Get-AzServiceFabricService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName +``` + +This example gets the service resource details for the service "testApp~testService". + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +Get-AzServiceFabricApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName +``` + +This example gets a list of the services under the application "testApp". + +## PARAMETERS + +### -ApplicationName +Specify the name of the application. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the service. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ServiceName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroupAndCluster, ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the service. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricApplication.md b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricApplication.md new file mode 100644 index 0000000000..7767e8fff2 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricApplication.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/new-azservicefabricapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricApplication.md +--- + +# New-AzServiceFabricApplication + +## SYNOPSIS +Create new service fabric application under the specified resource group and cluster. + +## SYNTAX + +### SkipAppTypeVersion (Default) +``` +New-AzServiceFabricApplication [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationTypeName] <String> [-ApplicationTypeVersion] <String> -Name <String> + [-ApplicationParameter <Hashtable>] [-MinimumNodeCount <Int64>] [-MaximumNodeCount <Int64>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateAppTypeVersion +``` +New-AzServiceFabricApplication [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationTypeName] <String> [-ApplicationTypeVersion] <String> -Name <String> + [-ApplicationParameter <Hashtable>] -PackageUrl <String> [-MinimumNodeCount <Int64>] + [-MaximumNodeCount <Int64>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet creates a new service fabric application under the specified resource group and cluster. The parameter -PackageUrl can be used to create the type version, If the type version already exits but its in 'Failed' state the cmdlet will ask if the user wants to recreate the type version. If it continues in 'Failed' state, the command will stop the process and throw an exception. + +## EXAMPLES + +### Example 1 +```powershell +New-AzServiceFabricApplication -ResourceGroupName "testRG" -ClusterName "testCluster" -ApplicationTypeName "TestAppType" -ApplicationTypeVersion "v1" -Name "testApp" -ApplicationParameter @{key0="value0";key1=$null;key2="value2"} +``` + +This example creates the application "testApp" under resource group "testRG" and cluster "testCluster". The application type "TestAppType" version "v1" should already exist in the cluster, and the application parameters should be defined in the application manifest otherwise the cmdlet will fail. + +### Example 2: Specify -PackageUrl to create the application type version before creating the application. +```powershell +New-AzServiceFabricApplication -ResourceGroupName "testRG" -ClusterName "testCluster" -ApplicationTypeName "TestAppType" -ApplicationTypeVersion "v1" -Name "testApp" -PackageUrl "https://sftestapp.blob.core.windows.net/sftestapp/testApp_1.0.sfpkg" -ApplicationParameter @{key0="value0";key1=$null;key2="value2"} +``` + +This example creates the application type "TestAppType" version "v1" using the package url provided. After this, it will continue the normal process to create the application. If the application type version already exits and the provisioning state its in 'Failed' it will prompt to decide if the user wants to recreate the type version. + +## PARAMETERS + +### -ApplicationParameter +Specify the application parameters as key/value pairs. +These parameters must exist in the application manifest. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationTypeName +Specify the name of the application type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationTypeVersion +Specify the application type version + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Continue without prompts + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumNodeCount +Specifies the maximum number of nodes on which to place an application + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumNodeCount +Specifies the minimum number of nodes where Service Fabric will reserve capacity for this application + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the application + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageUrl +Specify the url of the application package sfpkg file + +```yaml +Type: System.String +Parameter Sets: CreateAppTypeVersion +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSApplication + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricApplicationType.md b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricApplicationType.md new file mode 100644 index 0000000000..a8c3c82c7c --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricApplicationType.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/new-azservicefabricapplicationtype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricApplicationType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricApplicationType.md +--- + +# New-AzServiceFabricApplicationType + +## SYNOPSIS +Create new service fabric application type under the specified resource group and cluster. + +## SYNTAX + +``` +New-AzServiceFabricApplicationType [-ResourceGroupName] <String> [-ClusterName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The cmdlet creates a new service fabric application type under the specified resource group and cluster. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$appType = New-AzServiceFabricApplicationType -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Verbose +``` + +This example will create a new application type "testAppType" under the resource group and cluster specified. + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the application type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationTypeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSApplicationType + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricApplicationTypeVersion.md b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricApplicationTypeVersion.md new file mode 100644 index 0000000000..b7f25f843e --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricApplicationTypeVersion.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/new-azservicefabricapplicationtypeversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricApplicationTypeVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricApplicationTypeVersion.md +--- + +# New-AzServiceFabricApplicationTypeVersion + +## SYNOPSIS +Create new application type version under the specified resource group and cluster. + +## SYNTAX + +``` +New-AzServiceFabricApplicationTypeVersion [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name] <String> [-Version] <String> -PackageUrl <String> [-DefaultParameter <Hashtable>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet creates a new application type version using the package specified in -PackageUrl, this should be accessible through a REST endpoint for Azure Resource Manager to consume during deployment and contained The application packaged and zipped with the extension .sfpkg. This command will create the application type if it doesn't exist already. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$version = "v1" +$packageUrl = "https://sftestapp.blob.core.windows.net/sftestapp/testApp_1.0.sfpkg" +New-AzServiceFabricApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Version $version -PackageUrl $packageUrl -Verbose +``` + +This example will create an application type version "v1" under type "testAppType". The version in the application manifest contained in the package should have the same version as the one specified in -Version. + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultParameter +Specify the default values of the application parameters as key/value pairs. +These parameters must exist in the application manifest. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Continue without prompts + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the application type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationTypeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageUrl +Specify the url of the application package sfpkg file + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Specify the application type version + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationTypeVersion + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSApplicationTypeVersion + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricCluster.md b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricCluster.md new file mode 100644 index 0000000000..0a2d0f1b6c --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricCluster.md @@ -0,0 +1,559 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/new-azservicefabriccluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricCluster.md +--- + +# New-AzServiceFabricCluster + +## SYNOPSIS + +This command uses certificates that you provide or system generated self-signed certificates to set up a new service fabric cluster. It can use a default template or a custom template that you provide. You have the option of specifying a folder to export the self-signed certificates to or fetching them later from the key vault. + +## SYNTAX + +### ByDefaultArmTemplate (Default) +``` +New-AzServiceFabricCluster [-ResourceGroupName] <String> [-CertificateOutputFolder <String>] + [-CertificatePassword <SecureString>] [-KeyVaultResourceGroupName <String>] [-KeyVaultName <String>] + -Location <String> [-Name <String>] [-VmUserName <String>] [-ClusterSize <Int32>] + [-CertificateSubjectName <String>] -VmPassword <SecureString> [-OS <OperatingSystem>] [-VmSku <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByExistingKeyVault +``` +New-AzServiceFabricCluster [-ResourceGroupName] <String> -TemplateFile <String> -ParameterFile <String> + [-CertificateCommonName <String>] [-CertificateIssuerThumbprint <String>] [-VmPassword <SecureString>] + -SecretIdentifier <String> [-Thumbprint <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByNewPfxAndVaultName +``` +New-AzServiceFabricCluster [-ResourceGroupName] <String> -TemplateFile <String> -ParameterFile <String> + [-CertificateOutputFolder <String>] [-CertificatePassword <SecureString>] + [-KeyVaultResourceGroupName <String>] [-KeyVaultName <String>] [-CertificateSubjectName <String>] + [-VmPassword <SecureString>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByExistingPfxAndVaultName +``` +New-AzServiceFabricCluster [-ResourceGroupName] <String> -TemplateFile <String> -ParameterFile <String> + -CertificateFile <String> [-CertificatePassword <SecureString>] [-SecondaryCertificateFile <String>] + [-SecondaryCertificatePassword <SecureString>] [-KeyVaultResourceGroupName <String>] [-KeyVaultName <String>] + [-CertificateCommonName <String>] [-CertificateIssuerThumbprint <String>] [-VmPassword <SecureString>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +The **New-AzServiceFabricCluster** command uses certificates that you provide or system generated self-signed certificates to set up a new service fabric cluster. The template used can be a default template or a custom template that you provide. You have the option of specifying a folder to export the self-signed certificates or fetching them later from the key vault. +If you are specifying a custom template and parameter file, you don't need to provide the certificate information in the parameter file, the system will populate these parameters. +The four options are detailed below. Scroll down for explanations of each of the parameters. + +## EXAMPLES + +### Example 1: Specify only the cluster size, the cert subject name, and the OS to deploy a cluster + +```powershell +$password = "Password#1234" | ConvertTo-SecureString -AsPlainText -Force +$resourceGroupName = "quickstart-sf-group" +$azureRegion = "southcentralus" +$clusterDnsName = "{0}.{1}.cloudapp.azure.com" -f $resourceGroupName, $azureRegion +$localCertificateFolder = "c:\certs" + +Write-Output "Create cluster in '$azureRegion' with cert subject name '$clusterDnsName' and cert output path '$localCertificateFolder'" + +New-AzServiceFabricCluster -ResourceGroupName $resourceGroupName -Location $azureRegion -ClusterSize 5 -VmPassword $password -CertificateSubjectName $clusterDnsName -CertificateOutputFolder $localCertificateFolder -CertificatePassword $pass -OS WindowsServer2016Datacenter +``` + +This command specifies only the cluster size, the cert subject name, and the OS to deploy a cluster. + +### Example 2: Specify an existing Certificate resource in a key vault and a custom template to deploy a cluster + +```powershell +$resourceGroupName = "test20" +$templateParameterFile = "C:\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploytest.parameters.json" +$templateFile = "C:\azure-quickstart-templates\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploy.json" +$secretId = "https://test1.vault.azure.net:443/secrets/testcertificate4/56ec774dc61a462bbc645ffc9b4b225f" + +New-AzServiceFabricCluster -ResourceGroupName $resourceGroupName -TemplateFile $templateFile -ParameterFile $templateParameterFile -SecretIdentifier $secretId +``` + +This command specifies an existing Certificate resource in a key vault and a custom template to deploy a cluster. + +### Example 3: Create a new cluster using a custom template. Specify a different resource group name for the key vault and have the system upload a new certificate to it + +```powershell +$password = "Password#1234" | ConvertTo-SecureString -AsPlainText -Force +$resourceGroupName = "quickstart-sf-group" +$keyVaultResourceGroupName = " quickstart-kv-group" +$keyVaultName = "quickstart-kv" +$azureRegion = "southcentralus" +$clusterDnsName = "{0}.{1}.cloudapp.azure.com" -F $resourceGroupName, $azureRegion +$localCertificateFolder = "~\Documents" +$templateParameterFile = "C:\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploytest.parameters.json" +$templateFile = "C:\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploy.json" + +New-AzServiceFabricCluster -ResourceGroupName $resourceGroupName -TemplateFile $templateFile -ParameterFile $templateParameterFile -CertificateOutputFolder $localCertificateFolder -CertificatePassword $password -KeyVaultResourceGroupName $keyVaultResourceGroupName -KeyVaultName $keyVaultName -CertificateSubjectName $clusterDnsName +``` + +This command creates a new cluster using a custom template. Specify a different resource group name for the key vault and have the system upload a new certificate to it + +### Example 4: Bring your own Certificate and custom template and create a new cluster + +```powershell +$password = "Password#1234" | ConvertTo-SecureString -AsPlainText -Force +$resourceGroupName = "test20" +$keyVaultResourceGroupName = "test20kvrg" +$keyVaultName = "test20kv" +$localCertificateFile = "c:\Mycertificates\my2017Prodcert.pfx" +$templateParameterFile = "~\Documents\GitHub\azure-quickstart-templates-parms\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploytest.parameters.json" +$templateFile = "~\GitHub\azure-quickstart-templates\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploy.json" + +New-AzServiceFabricCluster -ResourceGroupName $resourceGroupName -TemplateFile $templateFile -ParameterFile $templateParameterFile -CertificateFile $localCertificateFile -CertificatePassword $password -KeyVaultResourceGroupName $keyVaultResourceGroupName -KeyVaultName $keyVaultName +``` + +This command will let you bring your own Certificate and custom template and create a new cluster. + +## PARAMETERS + +### -CertificateCommonName + +Certificate common name + +```yaml +Type: System.String +Parameter Sets: ByExistingKeyVault, ByExistingPfxAndVaultName +Aliases: CertCommonName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateFile + +The existing certificate file path for the primary cluster certificate + +```yaml +Type: System.String +Parameter Sets: ByExistingPfxAndVaultName +Aliases: Source + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertificateIssuerThumbprint + +Certificate issuer thumbprint, separated by commas if more than one + +```yaml +Type: System.String +Parameter Sets: ByExistingKeyVault, ByExistingPfxAndVaultName +Aliases: CertIssuerThumbprint + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateOutputFolder + +The folder of the new certificate file to be created + +```yaml +Type: System.String +Parameter Sets: ByDefaultArmTemplate, ByNewPfxAndVaultName +Aliases: Destination + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertificatePassword + +The password of the certificate file + +```yaml +Type: System.Security.SecureString +Parameter Sets: ByDefaultArmTemplate, ByNewPfxAndVaultName, ByExistingPfxAndVaultName +Aliases: CertPassword + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CertificateSubjectName + +The subject name of the certificate to be created + +```yaml +Type: System.String +Parameter Sets: ByDefaultArmTemplate, ByNewPfxAndVaultName +Aliases: Subject + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ClusterSize + +The number of nodes in the cluster. +Default are 5 nodes + +```yaml +Type: System.Int32 +Parameter Sets: ByDefaultArmTemplate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultName + +Azure key vault name, if not given it will be defaulted to the resource group name + +```yaml +Type: System.String +Parameter Sets: ByDefaultArmTemplate, ByNewPfxAndVaultName, ByExistingPfxAndVaultName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyVaultResourceGroupName + +Azure key vault resource group name, if not given it will be defaulted to resource group name + +```yaml +Type: System.String +Parameter Sets: ByDefaultArmTemplate, ByNewPfxAndVaultName, ByExistingPfxAndVaultName +Aliases: KeyVaultResouceGroupName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location + +The resource group location + +```yaml +Type: System.String +Parameter Sets: ByDefaultArmTemplate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name + +Specify the name of the cluster, if not given it will be same as resource group name + +```yaml +Type: System.String +Parameter Sets: ByDefaultArmTemplate +Aliases: ClusterName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OS + +The Operating System of the VMs that make up the cluster. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.OperatingSystem +Parameter Sets: ByDefaultArmTemplate +Aliases: VmImage +Accepted values: WindowsServer2012R2Datacenter, WindowsServer2016Datacenter, WindowsServer2016DatacenterwithContainers, UbuntuServer1604, UbuntuServer1804, UbuntuServer2004, WindowsServer2022 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParameterFile + +The path to the template parameter file. + +```yaml +Type: System.String +Parameter Sets: ByExistingKeyVault, ByNewPfxAndVaultName, ByExistingPfxAndVaultName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryCertificateFile + +The existing certificate file path for the secondary cluster certificate + +```yaml +Type: System.String +Parameter Sets: ByExistingPfxAndVaultName +Aliases: SecSource + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SecondaryCertificatePassword + +The password of the certificate file + +```yaml +Type: System.Security.SecureString +Parameter Sets: ByExistingPfxAndVaultName +Aliases: SecCertPassword + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SecretIdentifier + +The existing Azure key vault secret URL, for example 'https://mykv.vault.azure.net:443/secrets/mysecrets/55ec7c4dc61a462bbc645ffc9b4b225f' + +```yaml +Type: System.String +Parameter Sets: ByExistingKeyVault +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TemplateFile + +The path to the template file. + +```yaml +Type: System.String +Parameter Sets: ByExistingKeyVault, ByNewPfxAndVaultName, ByExistingPfxAndVaultName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Thumbprint +The thumbprint for the certificate correspoinding to the SecretIdentifier. Use this if the certificate is not managed as the key vault would only have the certificate stored as a secret and the cmdlet is unable to retreive the thumbprint. + +```yaml +Type: System.String +Parameter Sets: ByExistingKeyVault +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VmPassword + +The password of the Vm. + +```yaml +Type: System.Security.SecureString +Parameter Sets: ByDefaultArmTemplate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Security.SecureString +Parameter Sets: ByExistingKeyVault, ByNewPfxAndVaultName, ByExistingPfxAndVaultName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VmSku + +The Vm Sku + +```yaml +Type: System.String +Parameter Sets: ByDefaultArmTemplate +Aliases: Sku + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VmUserName + +The user name for logging to Vm + +```yaml +Type: System.String +Parameter Sets: ByDefaultArmTemplate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Security.SecureString + +### System.Int32 + +### Microsoft.Azure.Commands.ServiceFabric.Models.OperatingSystem + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSDeploymentResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedCluster.md b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedCluster.md new file mode 100644 index 0000000000..d74b0ce9b4 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedCluster.md @@ -0,0 +1,457 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/new-azservicefabricmanagedcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricManagedCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricManagedCluster.md +--- + +# New-AzServiceFabricManagedCluster + +## SYNOPSIS +Create new managed cluster. + +## SYNTAX + +### ClientCertByTp (Default) +``` +New-AzServiceFabricManagedCluster [-ResourceGroupName] <String> [-Name] <String> -Location <String> + [-UpgradeMode <ClusterUpgradeMode>] [-CodeVersion <String>] [-UpgradeCadence <PSClusterUpgradeCadence>] + [-ClientCertIsAdmin] -ClientCertThumbprint <String> -AdminPassword <SecureString> [-AdminUserName <String>] + [-HttpGatewayConnectionPort <Int32>] [-ClientConnectionPort <Int32>] [-DnsName <String>] + [-Sku <ManagedClusterSku>] [-UseTestExtension] [-ZonalResiliency] [-AsJob] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClientCertByCn +``` +New-AzServiceFabricManagedCluster [-ResourceGroupName] <String> [-Name] <String> -Location <String> + [-UpgradeMode <ClusterUpgradeMode>] [-CodeVersion <String>] [-UpgradeCadence <PSClusterUpgradeCadence>] + [-ClientCertIsAdmin] -ClientCertCommonName <String> [-ClientCertIssuerThumbprint <String[]>] + -AdminPassword <SecureString> [-AdminUserName <String>] [-HttpGatewayConnectionPort <Int32>] + [-ClientConnectionPort <Int32>] [-DnsName <String>] [-Sku <ManagedClusterSku>] [-UseTestExtension] + [-ZonalResiliency] [-AsJob] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will create a managed cluster resource without node types. To bootstrap the cluster A primary node type needs to be added use [New-AzServiceFabricManagedNodeType](./New-AzServiceFabricManagedNodeType.md). + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$password = ConvertTo-SecureString -AsPlainText -Force "testpass1234!@#$" +$tags = @{"test"="tag"} + +New-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Location centraluseuap -ClusterName $clusterName -AdminPassword $password -Tag $tags -Verbose +``` + +This command creates a cluster resource with default basic sku. + +### Example 2 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$password = ConvertTo-SecureString -AsPlainText -Force "testpass1234!@#$" +New-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Location centraluseuap -ClusterName $clusterName -ClientCertThumbprint XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -ClientCertIsAdmin -AdminPassword $password -Sku Standard -Verbose +``` + +This command creates a cluster resource in centraluseuap with an initial admin client certificate and standard sku. + +### Example 3 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$password = ConvertTo-SecureString -AsPlainText -Force "testpass1234!@#$" +New-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Location centraluseuap -ClusterName $clusterName -AdminPassword $password -Sku Standard -UpgradeMode Automatic -UpgradeCadence Wave1 -ZonalResiliency -Verbose +``` + +This command creates a cluster with upgrade cadence in wave1 and zonal resiliency enabled. + +### Example 4 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$password = ConvertTo-SecureString -AsPlainText -Force "testpass1234!@#$" +New-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Location centraluseuap -ClusterName $clusterName -AdminPassword $password -Sku Standard -UpgradeMode Manual -CodeVersion 7.2.477.9590 -Verbose +``` + +This command creates a cluster with manual upgrade mode and 7.2.477.9590 code version. + +## PARAMETERS + +### -AdminPassword +Admin password used for the virtual machines. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminUserName +Admin password used for the virtual machines. +Default: vmadmin. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: "vmadmin" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientCertCommonName +Client certificate common name. + +```yaml +Type: System.String +Parameter Sets: ClientCertByCn +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientCertIsAdmin +Use to specify if the client certificate has administrator level. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientCertIssuerThumbprint +List of Issuer thumbprints for the client certificate. +Only use in combination with ClientCertCommonName. + +```yaml +Type: System.String[] +Parameter Sets: ClientCertByCn +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientCertThumbprint +Client certificate thumbprint. + +```yaml +Type: System.String +Parameter Sets: ClientCertByTp +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientConnectionPort +Port used for client connections to the cluster. +Default: 19000. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 19000 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CodeVersion +Cluster service fabric code version. +Only use if upgrade mode is Manual. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterCodeVersion + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsName +Cluster's dns name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpGatewayConnectionPort +Port used for http connections to the cluster. +Default: 19080. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 19080 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Cluster's Sku, the options are Basic: it will have a minimum of 3 seed nodes and only allows 1 node type and Standard: it will have a minimum of 5 seed nodes and allows multiple node types. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.ManagedClusterSku +Parameter Sets: (All) +Aliases: +Accepted values: Basic, Standard + +Required: False +Position: Named +Default value: Basic +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specify the tags as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeCadence +Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSClusterUpgradeCadence +Parameter Sets: (All) +Aliases: ClusterUpgradeCadence +Accepted values: Wave0, Wave1, Wave2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeMode +Cluster service fabric code version upgrade mode. +Automatic or Manual. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.ClusterUpgradeMode +Parameter Sets: (All) +Aliases: ClusterUpgradeMode +Accepted values: Automatic, Manual + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseTestExtension +If Specify The cluster will be crated with service test vmss extension. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZonalResiliency +Indicates if the cluster has zone resiliency. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedCluster + +## NOTES + +## RELATED LINKS + +[New-AzServiceFabricManagedNodeType](./New-AzServiceFabricManagedNodeType.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedClusterApplication.md b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedClusterApplication.md new file mode 100644 index 0000000000..5953ff16b3 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedClusterApplication.md @@ -0,0 +1,279 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/new-azservicefabricmanagedclusterapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricManagedClusterApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricManagedClusterApplication.md +--- + +# New-AzServiceFabricManagedClusterApplication + +## SYNOPSIS +Create new service fabric managed application under the specified resource group and cluster. + +## SYNTAX + +### SkipAppTypeVersion (Default) +``` +New-AzServiceFabricManagedClusterApplication [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationTypeName] <String> [-ApplicationTypeVersion] <String> -Name <String> + [-ApplicationParameter <Hashtable>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateAppTypeVersion +``` +New-AzServiceFabricManagedClusterApplication [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationTypeName] <String> [-ApplicationTypeVersion] <String> -Name <String> + [-ApplicationParameter <Hashtable>] -PackageUrl <String> [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet creates a new service fabric managed application under the specified resource group and cluster. The parameter -PackageUrl can be used to create the type version, If the type version already exits but its in 'Failed' state the cmdlet will ask if the user wants to recreate the type version. If it continues in 'Failed' state, the command will stop the process and throw an exception. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$appTypeName = "testAppType" +$appTypeVersion = "v1" +$appParameters = @{key0="value0";key1=$null;key2="value2"} +New-AzServiceFabricManagedClusterApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationTypeName $appTypeName -ApplicationTypeVersion $appTypeVersion -Name $appName -ApplicationParameter $appParameters +``` + +This example creates the managed application "testApp" under resource group "testRG" and cluster "testCluster". The managed application type "TestAppType" version "v1" should already exist in the cluster, and the application parameters should be defined in the application manifest otherwise the cmdlet will fail. + +### Example 2: Specify -PackageUrl to create the application type version before creating the application. +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$appTypeName = "testAppType" +$appTypeVersion = "v1" +$appParameters = @{key0="value0";key1=$null;key2="value2"} +$packageUrlV1 = "https://sftestapp.blob.core.windows.net/sftestapp/testApp_1.0.sfpkg" +New-AzServiceFabricManagedClusterApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationTypeName $appTypeName -ApplicationTypeVersion $appTypeVersion -Name $appName -PackageUrl $packageUrlV1 -ApplicationParameter $appParameters +``` + +This example creates the managed application type "testAppType" version "v1" using the package url provided. After this, it will continue the normal process to create the application. If the managed application type version already exits and the provisioning state its in 'Failed' it will prompt to decide if the user wants to recreate the type version. + +## PARAMETERS + +### -ApplicationParameter +Specify the application parameters as key/value pairs. +These parameters must exist in the application manifest. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ApplicationTypeName +Specify the name of the managed application type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationTypeVersion +Specify the managed application type version + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Continue without prompts + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the managed application + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageUrl +Specify the url of the application package sfpkg file + +```yaml +Type: System.String +Parameter Sets: CreateAppTypeVersion +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specify the tags as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplication + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedClusterApplicationType.md b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedClusterApplicationType.md new file mode 100644 index 0000000000..63b50bb5fd --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedClusterApplicationType.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/new-azservicefabricmanagedclusterapplicationtype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricManagedClusterApplicationType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricManagedClusterApplicationType.md +--- + +# New-AzServiceFabricManagedClusterApplicationType + +## SYNOPSIS +Create new service fabric managed application type under the specified resource group and cluster. + +## SYNTAX + +``` +New-AzServiceFabricManagedClusterApplicationType [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name] <String> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The cmdlet creates a new service fabric managed application type under the specified resource group and cluster. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$appType = New-AzServiceFabricManagedClusterApplicationType -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Verbose +``` + +This example will create a new managed application type "testAppType" under the resource group and cluster specified. + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the application type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationTypeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specify the tags as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationType + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedClusterApplicationTypeVersion.md b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedClusterApplicationTypeVersion.md new file mode 100644 index 0000000000..b3edb42f41 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedClusterApplicationTypeVersion.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/new-azservicefabricmanagedclusterapplicationtypeversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricManagedClusterApplicationTypeVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricManagedClusterApplicationTypeVersion.md +--- + +# New-AzServiceFabricManagedClusterApplicationTypeVersion + +## SYNOPSIS +Create new managed application type version under the specified resource group and cluster. + +## SYNTAX + +``` +New-AzServiceFabricManagedClusterApplicationTypeVersion [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name] <String> [-Version] <String> -PackageUrl <String> [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet creates a new managed application type version using the package specified in -PackageUrl, this should be accessible through a REST endpoint for Azure Resource Manager to consume during deployment and the contained application packaged zipped with the extension .sfpkg. This command will create the application type if it doesn't exist already. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$version = "v1" +$packageUrl = "https://sftestapp.blob.core.windows.net/sftestapp/testApp_1.0.sfpkg" +New-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Version $version -PackageUrl $packageUrl -Verbose +``` + +This example will create an managed application type version "v1" under type "testAppType". The version in the application manifest contained in the package should have the same version as the one specified in -Version. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Continue without prompts + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the managed application type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationTypeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageUrl +Specify the url of the application package sfpkg file + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specify the tags as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Version +Specify the managed application type version + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ApplicationTypeVersion + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationTypeVersion + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedClusterService.md b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedClusterService.md new file mode 100644 index 0000000000..3506370428 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedClusterService.md @@ -0,0 +1,693 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/new-azservicefabricmanagedclusterservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricManagedClusterService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricManagedClusterService.md +--- + +# New-AzServiceFabricManagedClusterService + +## SYNOPSIS +Create new service fabric managed service under the specified application and cluster. + +## SYNTAX + +### Stateless-Singleton (Default) +``` +New-AzServiceFabricManagedClusterService [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationName] <String> [-Name] <String> -Type <String> [-Stateless] -InstanceCount <Int32> + [-MinInstanceCount <Int32>] [-MinInstancePercentage <Int32>] [-DefaultMoveCost <MoveCostEnum>] + [-PlacementConstraint <String>] [-Metric <PSServiceMetric[]>] [-Correlation <PSServiceCorrelation[]>] + [-ServicePackageActivationMode <ServicePackageActivationModeEnum>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-PartitionSchemeSingleton] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Stateless-UniformInt64Range +``` +New-AzServiceFabricManagedClusterService [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationName] <String> [-Name] <String> -Type <String> [-Stateless] -InstanceCount <Int32> + [-MinInstanceCount <Int32>] [-MinInstancePercentage <Int32>] [-DefaultMoveCost <MoveCostEnum>] + [-PlacementConstraint <String>] [-Metric <PSServiceMetric[]>] [-Correlation <PSServiceCorrelation[]>] + [-ServicePackageActivationMode <ServicePackageActivationModeEnum>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-PartitionSchemeUniformInt64] -PartitionCount <Int32> -LowKey <Int64> -HighKey <Int64> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Stateless-Named +``` +New-AzServiceFabricManagedClusterService [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationName] <String> [-Name] <String> -Type <String> [-Stateless] -InstanceCount <Int32> + [-MinInstanceCount <Int32>] [-MinInstancePercentage <Int32>] [-DefaultMoveCost <MoveCostEnum>] + [-PlacementConstraint <String>] [-Metric <PSServiceMetric[]>] [-Correlation <PSServiceCorrelation[]>] + [-ServicePackageActivationMode <ServicePackageActivationModeEnum>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-PartitionSchemeNamed] -PartitionName <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### Stateful-Singleton +``` +New-AzServiceFabricManagedClusterService [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationName] <String> [-Name] <String> -Type <String> [-Stateful] -TargetReplicaSetSize <Int32> + -MinReplicaSetSize <Int32> [-HasPersistedState] [-ReplicaRestartWaitDuration <TimeSpan>] + [-QuorumLossWaitDuration <TimeSpan>] [-StandByReplicaKeepDuration <TimeSpan>] + [-ServicePlacementTimeLimit <TimeSpan>] [-DefaultMoveCost <MoveCostEnum>] [-PlacementConstraint <String>] + [-Metric <PSServiceMetric[]>] [-Correlation <PSServiceCorrelation[]>] + [-ServicePackageActivationMode <ServicePackageActivationModeEnum>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-PartitionSchemeSingleton] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Stateful-UniformInt64Range +``` +New-AzServiceFabricManagedClusterService [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationName] <String> [-Name] <String> -Type <String> [-Stateful] -TargetReplicaSetSize <Int32> + -MinReplicaSetSize <Int32> [-HasPersistedState] [-ReplicaRestartWaitDuration <TimeSpan>] + [-QuorumLossWaitDuration <TimeSpan>] [-StandByReplicaKeepDuration <TimeSpan>] + [-ServicePlacementTimeLimit <TimeSpan>] [-DefaultMoveCost <MoveCostEnum>] [-PlacementConstraint <String>] + [-Metric <PSServiceMetric[]>] [-Correlation <PSServiceCorrelation[]>] + [-ServicePackageActivationMode <ServicePackageActivationModeEnum>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-PartitionSchemeUniformInt64] -PartitionCount <Int32> -LowKey <Int64> -HighKey <Int64> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Stateful-Named +``` +New-AzServiceFabricManagedClusterService [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationName] <String> [-Name] <String> -Type <String> [-Stateful] -TargetReplicaSetSize <Int32> + -MinReplicaSetSize <Int32> [-HasPersistedState] [-ReplicaRestartWaitDuration <TimeSpan>] + [-QuorumLossWaitDuration <TimeSpan>] [-StandByReplicaKeepDuration <TimeSpan>] + [-ServicePlacementTimeLimit <TimeSpan>] [-DefaultMoveCost <MoveCostEnum>] [-PlacementConstraint <String>] + [-Metric <PSServiceMetric[]>] [-Correlation <PSServiceCorrelation[]>] + [-ServicePackageActivationMode <ServicePackageActivationModeEnum>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-PartitionSchemeNamed] -PartitionName <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet allows to creating stateless or stateful managed services under the specified application. The service should exit in the application manifest and the type should be the same as the one in the manifest. The application name should be a prefix of the service name. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$serviceName = "testService1" +$serviceTypeName = "testStateless" +$statelessServiceMetric = New-Object -TypeName "Microsoft.Azure.Commands.ServiceFabric.Models.PSServiceMetric" -ArgumentList @("metric1", "Low", 4) +New-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName -Type $serviceTypeName -Stateless -InstanceCount -1 -PartitionSchemeSingleton -Metric @($statelessServiceMetric) -Verbose +``` + +This example will create a new stateless managed service "testService1" with instance count -1 (on all the nodes). + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$serviceName = "testService2" +$serviceTypeName = "testStatefulType" +$partitionCount = 5 +$partitionLowKey = 0 +$partitionHighKey = 25 +$statefulServiceMetric = New-Object -TypeName "Microsoft.Azure.Commands.ServiceFabric.Models.PSServiceMetric" -ArgumentList @("metric2", "Medium", 4, 2) +New-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName -Type $serviceTypeName -Stateful -TargetReplicaSetSize 5 -MinReplicaSetSize 3 -Metric @($statefulServiceMetric) -PartitionSchemeUniformInt64 -PartitionCount $partitionCount -LowKey $partitionLowKey -HighKey $partitionHighKey -Verbose +``` + +This example will create a new stateful managed service "testService2" with a target of 5 nodes. + +### Example 3 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$serviceName = "testService3" +$serviceName2 = "testService2" +$serviceTypeName = "testStateless" +$statefulService = Get-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName2 +$statefulServiceCorrelation = New-Object -TypeName "Microsoft.Azure.Commands.ServiceFabric.Models.PSServiceCorrelation" -ArgumentList @("AlignedAffinity", $statefulService.Id) +New-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName -Type $serviceTypeName -Stateless -InstanceCount 3 -PartitionSchemeSingleton -Correlation @($statefulServiceCorrelation) -Verbose +``` + +This example will create a new stateless managed service "testService3". + +## PARAMETERS + +### -ApplicationName +Specify the name of the managed application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Correlation +Specify the placement constraints of the managed service, as a string. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSServiceCorrelation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMoveCost +Specify the default cost for a move. +Higher costs make it less likely that the Cluster Resource Manager will move the replica when trying to balance the cluster + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.MoveCostEnum +Parameter Sets: (All) +Aliases: +Accepted values: Zero, Low, Medium, High + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Continue without prompts + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasPersistedState +Specify the target replica set size for the managed service + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighKey +Specify the upper bound of the partition key range. + +```yaml +Type: System.Int64 +Parameter Sets: Stateless-UniformInt64Range, Stateful-UniformInt64Range +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceCount +Specify the instance count for the managed service + +```yaml +Type: System.Int32 +Parameter Sets: Stateless-Singleton, Stateless-UniformInt64Range, Stateless-Named +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LowKey +Specify the lower bound of the partition key range. + +```yaml +Type: System.Int64 +Parameter Sets: Stateless-UniformInt64Range, Stateful-UniformInt64Range +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metric +Specify the placement constraints of the managed service, as a string. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSServiceMetric[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinInstanceCount +Specify the minimum instance count for the managed service + +```yaml +Type: System.Int32 +Parameter Sets: Stateless-Singleton, Stateless-UniformInt64Range, Stateless-Named +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinInstancePercentage +Specify the minimum instance percentage for the managed service + +```yaml +Type: System.Int32 +Parameter Sets: Stateless-Singleton, Stateless-UniformInt64Range, Stateless-Named +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinReplicaSetSize +Specify the min replica set size for the managed service + +```yaml +Type: System.Int32 +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the managed service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServiceName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionCount +Specify the number of partitions. + +```yaml +Type: System.Int32 +Parameter Sets: Stateless-UniformInt64Range, Stateful-UniformInt64Range +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionName +Indicates that the service uses the named partition scheme. Services using this model usually have data that can be bucketed, within a bounded set. Some common examples of data fields used as named partition keys would be regions, postal codes, customer groups, or other business boundaries. + +```yaml +Type: System.String[] +Parameter Sets: Stateless-Named, Stateful-Named +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionSchemeNamed +Indicates that the service uses the named partition scheme. +Services using this model usually have data that can be bucketed, within a bounded set. +Some common examples of data fields used as named partition keys would be regions, postal codes, customer groups, or other business boundaries. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateless-Named, Stateful-Named +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionSchemeSingleton +Indicates that the service uses the singleton partition scheme. +Singleton partitions are typically used when the service does not require any additional routing. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateless-Singleton, Stateful-Singleton +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionSchemeUniformInt64 +Indicates that the service uses the UniformInt64 partition scheme. +This means that each partition owns a range of int64 keys. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateless-UniformInt64Range, Stateful-UniformInt64Range +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlacementConstraint +Specify the placement constraints of the managed service, as a string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuorumLossWaitDuration +Specify the quorum loss wait duration for the managed service. +Duration represented in ISO 8601 format 'hh:mm:ss' + +```yaml +Type: System.TimeSpan +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaRestartWaitDuration +Specify the replica restart wait duration for the managed service. +Duration represented in ISO 8601 format 'hh:mm:ss' + +```yaml +Type: System.TimeSpan +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServicePackageActivationMode +Specify the default cost for a move. +Higher costs make it less likely that the Cluster Resource Manager will move the replica when trying to balance the cluster + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.ServicePackageActivationModeEnum +Parameter Sets: (All) +Aliases: +Accepted values: SharedProcess, ExclusiveProcess + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePlacementTimeLimit +Specify the service placement time limit for the managed service. +Duration represented in ISO 8601 format 'hh:mm:ss' + +```yaml +Type: System.TimeSpan +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StandByReplicaKeepDuration +Specify the stand by replica duration for the managed service. +Duration represented in ISO 8601 format 'hh:mm:ss' + +```yaml +Type: System.TimeSpan +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Stateful +Use for stateful service + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Stateless +Use for stateless service + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateless-Singleton, Stateless-UniformInt64Range, Stateless-Named +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specify the tags as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetReplicaSetSize +Specify the target replica set size for the managed service + +```yaml +Type: System.Int32 +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specify the service type name of the managed application, should exist in the application manifest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServiceType + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedNodeType.md b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedNodeType.md new file mode 100644 index 0000000000..77de35c8dd --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricManagedNodeType.md @@ -0,0 +1,477 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/new-azservicefabricmanagednodetype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricManagedNodeType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricManagedNodeType.md +--- + +# New-AzServiceFabricManagedNodeType + +## SYNOPSIS +Create new node type resource. + +## SYNTAX + +``` +New-AzServiceFabricManagedNodeType [-ResourceGroupName] <String> [-ClusterName] <String> [-Name] <String> + -InstanceCount <Int32> [-Primary] [-DiskSize <Int32>] [-DiskType <PSDiskType>] [-ApplicationStartPort <Int32>] + [-ApplicationEndPort <Int32>] [-EphemeralStartPort <Int32>] [-EphemeralEndPort <Int32>] [-VmSize <String>] + [-VmImagePublisher <String>] [-VmImageOffer <String>] [-VmImageSku <String>] [-VmImageVersion <String>] + [-Capacity <Hashtable>] [-PlacementProperty <Hashtable>] [-VmUserAssignedIdentity <String[]>] [-IsStateless] + [-MultiplePlacementGroup] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Create new node type resource for an specific cluster. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +New-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName -Primary -InstanceCount 3 +``` + +Create primary node type with 3 nodes. + +### Example 2 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +New-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName -InstanceCount 5 -Primary -PlacementProperty @{NodeColor="Green";SomeProperty="5";} -Capacity @{ClientConnections="65536";} -ApplicationStartPort 20575 -ApplicationEndPort 20605 -EphemeralStartPort 20606 -EphemeralEndPort 20861 +``` + +Create primary node type with 5 nodes and specifying placement properties, capacities, application and ephemeral ports. + +### Example 3 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt2" +New-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName -InstanceCount 10 -DiskType Premium_LRS -VmSize "Standard_DS2" -MultiplePlacementGroup +``` + +Create non primary node type with 10 nodes, premium disk type and multiple placement groups. + +### Example 4 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt2" +$identityId = "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testIdentity" +New-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName -InstanceCount 5 -VmUserAssignedIdentity $identityId -IsStateless +``` + +Create node type with user assigned identity and marked to host stateless workload. + +## PARAMETERS + +### -ApplicationEndPort +Application End port of a range of ports. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationStartPort +Application start port of a range of ports. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Capacity +Capacity tags applied to the nodes in the node type as key/value pairs, the cluster resource manager uses these tags to understand how much resource a node has. +Updating this will override the current values. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskSize +Disk size for each vm in the node type in GBs. +Default 100. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: DataDiskSize + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskType +Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://learn.microsoft.com/en-us/azure/virtual-machines/disks-types. Default StandardSSD_LRS + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSDiskType +Parameter Sets: (All) +Aliases: DataDiskType +Accepted values: Standard_LRS, StandardSSD_LRS, Premium_LRS + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EphemeralEndPort +Ephemeral end port of a range of ports. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EphemeralStartPort +Ephemeral start port of a range of ports. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceCount +The number of nodes in the node type. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsStateless +Indicates if the node type can only host Stateless workloads. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiplePlacementGroup +Indicates if scale set associated with the node type can be composed of multiple placement groups. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the node type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: NodeTypeName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PlacementProperty +Placement tags applied to nodes in the node type as key/value pairs, which can be used to indicate where certain services (workload) should run. +Updating this will override the current values. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Primary +Specify if the node type is primary. +On this node type will run system services. +Only one node type should be marked as primary. +Primary node type cannot be deleted or changed for existing clusters. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VmImageOffer +The offer type of the Azure Virtual Machines Marketplace image. +Default: WindowsServer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: "WindowsServer" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmImagePublisher +The publisher of the Azure Virtual Machines Marketplace image. +Default: MicrosoftWindowsServer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: "MicrosoftWindowsServer" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmImageSku +The SKU of the Azure Virtual Machines Marketplace image. +Default: 2019-Datacenter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: "2019-Datacenter" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmImageVersion +The version of the Azure Virtual Machines Marketplace image. +Default: latest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: "latest" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmSize +The size of virtual machines in the pool. +All virtual machines in a pool are the same size. +Default: Standard_D2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: "Standard_D2" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmUserAssignedIdentity +The list of user assigend identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Follow steps to create the identity and add the role assignment with Service Fabric Resource Provider beforehand here: https://learn.microsoft.com/en-us/azure/service-fabric/how-to-managed-identity-managed-cluster-virtual-machine-scale-sets + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedNodeType + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricService.md b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricService.md new file mode 100644 index 0000000000..cface7b8cd --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/New-AzServiceFabricService.md @@ -0,0 +1,418 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/new-azservicefabricservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/New-AzServiceFabricService.md +--- + +# New-AzServiceFabricService + +## SYNOPSIS +Create new service fabric service under the specified application and cluster. + +## SYNTAX + +### Stateless-Singleton (Default) +``` +New-AzServiceFabricService [-ResourceGroupName] <String> [-ClusterName] <String> [-ApplicationName] <String> + [-Name] <String> -Type <String> [-Stateless] -InstanceCount <Int32> [-DefaultMoveCost <MoveCostEnum>] + [-PartitionSchemeSingleton] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Stateless-UniformInt64Range +``` +New-AzServiceFabricService [-ResourceGroupName] <String> [-ClusterName] <String> [-ApplicationName] <String> + [-Name] <String> -Type <String> [-Stateless] -InstanceCount <Int32> [-DefaultMoveCost <MoveCostEnum>] + [-PartitionSchemeUniformInt64] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Stateless-Named +``` +New-AzServiceFabricService [-ResourceGroupName] <String> [-ClusterName] <String> [-ApplicationName] <String> + [-Name] <String> -Type <String> [-Stateless] -InstanceCount <Int32> [-DefaultMoveCost <MoveCostEnum>] + [-PartitionSchemeNamed] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Stateful-Singleton +``` +New-AzServiceFabricService [-ResourceGroupName] <String> [-ClusterName] <String> [-ApplicationName] <String> + [-Name] <String> -Type <String> [-Stateful] -TargetReplicaSetSize <Int32> -MinReplicaSetSize <Int32> + [-ReplicaRestartWaitDuration <TimeSpan>] [-QuorumLossWaitDuration <TimeSpan>] + [-StandByReplicaKeepDuration <TimeSpan>] [-DefaultMoveCost <MoveCostEnum>] [-PartitionSchemeSingleton] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Stateful-UniformInt64Range +``` +New-AzServiceFabricService [-ResourceGroupName] <String> [-ClusterName] <String> [-ApplicationName] <String> + [-Name] <String> -Type <String> [-Stateful] -TargetReplicaSetSize <Int32> -MinReplicaSetSize <Int32> + [-ReplicaRestartWaitDuration <TimeSpan>] [-QuorumLossWaitDuration <TimeSpan>] + [-StandByReplicaKeepDuration <TimeSpan>] [-DefaultMoveCost <MoveCostEnum>] [-PartitionSchemeUniformInt64] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Stateful-Named +``` +New-AzServiceFabricService [-ResourceGroupName] <String> [-ClusterName] <String> [-ApplicationName] <String> + [-Name] <String> -Type <String> [-Stateful] -TargetReplicaSetSize <Int32> -MinReplicaSetSize <Int32> + [-ReplicaRestartWaitDuration <TimeSpan>] [-QuorumLossWaitDuration <TimeSpan>] + [-StandByReplicaKeepDuration <TimeSpan>] [-DefaultMoveCost <MoveCostEnum>] [-PartitionSchemeNamed] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet allows to creating stateless or stateful services under the specified application. The service should exit in the application manifest and the type should be the same as the one in the manifest. The application name should be a prefix of the service name. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$serviceName = "testApp~testService1" +$serviceTypeName = "testStateless" +New-AzServiceFabricService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName -Type $serviceTypeName -Stateless -InstanceCount -1 -PartitionSchemeSingleton -Verbose +``` + +This example will create a new stateless service "testApp~testService1" with instance count -1 (on all the nodes). + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$serviceName = "testApp~testService2" +$serviceTypeName = "testStatefulType" +New-AzServiceFabricService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName -Type $serviceTypeName -Stateful -TargetReplicaSetSize 3 -MinReplicaSetSize 5 +``` + +This example will create a new stateful service "testApp~testService2" with a target of 5 nodes. + +## PARAMETERS + +### -ApplicationName +Specify the name of the application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultMoveCost +Specify the default cost for a move. +Higher costs make it less likely that the Cluster Resource Manager will move the replica when trying to balance the cluster + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.MoveCostEnum +Parameter Sets: (All) +Aliases: +Accepted values: Zero, Low, Medium, High + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceCount +Specify the instance count for the service + +```yaml +Type: System.Int32 +Parameter Sets: Stateless-Singleton, Stateless-UniformInt64Range, Stateless-Named +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinReplicaSetSize +Specify the min replica set size for the service + +```yaml +Type: System.Int32 +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServiceName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionSchemeNamed +Indicates that the service uses the named partition scheme. +Services using this model usually have data that can be bucketed, within a bounded set. +Some common examples of data fields used as named partition keys would be regions, postal codes, customer groups, or other business boundaries. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateless-Named, Stateful-Named +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionSchemeSingleton +Indicates that the service uses the singleton partition scheme. +Singleton partitions are typically used when the service does not require any additional routing. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateless-Singleton, Stateful-Singleton +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionSchemeUniformInt64 +Indicates that the service uses the UniformInt64 partition scheme. +This means that each partition owns a range of int64 keys. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateless-UniformInt64Range, Stateful-UniformInt64Range +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuorumLossWaitDuration +Specify the quorum loss wait duration for the service + +```yaml +Type: System.TimeSpan +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaRestartWaitDuration +Specify the replica restart wait duration for the service + +```yaml +Type: System.TimeSpan +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StandByReplicaKeepDuration +Specify the stand by replica duration for the service + +```yaml +Type: System.TimeSpan +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Stateful +Use for stateful service + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Stateless +Use for stateless service + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateless-Singleton, Stateless-UniformInt64Range, Stateless-Named +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetReplicaSetSize +Specify the target replica set size for the service + +```yaml +Type: System.Int32 +Parameter Sets: Stateful-Singleton, Stateful-UniformInt64Range, Stateful-Named +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specify the service type name of the application, should exist in the application manifest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServiceType + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricApplication.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricApplication.md new file mode 100644 index 0000000000..dda29d75e6 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricApplication.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplication.md +--- + +# Remove-AzServiceFabricApplication + +## SYNOPSIS +Remove an application from the cluster. This will remove all the services under the application. Only supports ARM deployed applications. + +## SYNTAX + +### ByResourceGroup (Default) +``` +Remove-AzServiceFabricApplication [-ResourceGroupName] <String> [-ClusterName] <String> [-Name] <String> + [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzServiceFabricApplication -ResourceId <String> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzServiceFabricApplication -InputObject <PSApplication> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet removes an application form the cluster. This will remove all the services, if any, under the application resource. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +Remove-AzServiceFabricApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName +``` + +This example removes the application "testApp" under the resource group "testRG" and cluster "testCluster". + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove without prompt. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The application resource. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSApplication +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the application. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ApplicationName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns $True if the command succeeds and $False if it fails. By default, this cmdlet does not return any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the application. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSApplication + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricApplicationType.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricApplicationType.md new file mode 100644 index 0000000000..aef4893a4c --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricApplicationType.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricapplicationtype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationType.md +--- + +# Remove-AzServiceFabricApplicationType + +## SYNOPSIS +Remove Service fabric an application type from the cluster. This will remove all type versions under this resource. Only supports ARM deployed application types. + +## SYNTAX + +### ByResourceGroup (Default) +``` +Remove-AzServiceFabricApplicationType [-ResourceGroupName] <String> [-ClusterName] <String> [-Name <String>] + [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzServiceFabricApplicationType -ResourceId <String> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzServiceFabricApplicationType -InputObject <PSApplicationType> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet removes an application type form the cluster and will remove all type version under this resource, but all applications under it should be removed before running this command. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +Remove-AzServiceFabricApplicationType -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Verbose +``` + +This example will remove the application type "testAppType" and all the version under it. If there are any applications created with this type, the command will throw an exception. + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove without prompt. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The application type resource. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSApplicationType +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the application type. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ApplicationTypeName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the application type. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSApplicationType + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricApplicationTypeVersion.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricApplicationTypeVersion.md new file mode 100644 index 0000000000..201f316132 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricApplicationTypeVersion.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricapplicationtypeversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationTypeVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricApplicationTypeVersion.md +--- + +# Remove-AzServiceFabricApplicationTypeVersion + +## SYNOPSIS +Remove Service fabric an application type version from the cluster. Only supports ARM deployed application type versions. + +## SYNTAX + +### ByResourceGroup (Default) +``` +Remove-AzServiceFabricApplicationTypeVersion [-ResourceGroupName] <String> [-ClusterName] <String> + -Name <String> -Version <String> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzServiceFabricApplicationTypeVersion -ResourceId <String> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzServiceFabricApplicationTypeVersion -InputObject <PSApplicationTypeVersion> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will remove Service fabric an application type version from the cluster. All applications under this resource must be removed before running this command. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$version = "v1" +Remove-AzServiceFabricApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Version $version -Force -PassThru -Verbose +``` + +This example will remove the version "v1" under the type "testAppType". It there are any applications under this resource the command will throw an exception. + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove without prompt. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The application type version resource. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSApplicationTypeVersion +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the application type. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ApplicationTypeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the application type version. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Specify the application type version. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ApplicationTypeVersion + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSApplicationTypeVersion + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricClientCertificate.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricClientCertificate.md new file mode 100644 index 0000000000..47d90e63fb --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricClientCertificate.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricclientcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricClientCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricClientCertificate.md +--- + +# Remove-AzServiceFabricClientCertificate + +## SYNOPSIS +Remove a client certificate(s) or certificate subject(s) name(s) from being used for client authentication to the cluster. + +## SYNTAX + +### SingleUpdateWithCommonName +``` +Remove-AzServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String> -CommonName <String> + -IssuerThumbprint <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SingleUpdateWithThumbprint +``` +Remove-AzServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String> -Thumbprint <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MultipleUpdatesWithCommonName +``` +Remove-AzServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String> + -ClientCertificateCommonName <PSClientCertificateCommonName[]> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MultipleUpdatesWithThumbprint +``` +Remove-AzServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String> + [-AdminClientThumbprint <String[]>] [-ReadonlyClientThumbprint <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use **Remove-AzServiceFabricClientCertificate** to remove a client certificate(s) or certificate subject(s) name(s) from being used for client authentication to the cluster. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzServiceFabricClientCertificate -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -Thumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A +``` + +This command will remove client certificate with thumbprint '5F3660C715EBBDA31DB1FFDCF508302348DE8E7A' from the cluster. + +## PARAMETERS + +### -AdminClientThumbprint +Specify client certificate thumbprint which only has admin permission + +```yaml +Type: System.String[] +Parameter Sets: MultipleUpdatesWithThumbprint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ClientCertificateCommonName +Specify client common name , issuer thumbprint and authentication type + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSClientCertificateCommonName[] +Parameter Sets: MultipleUpdatesWithCommonName +Aliases: CertCommonName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -CommonName +Specify client certificate common name + +```yaml +Type: System.String +Parameter Sets: SingleUpdateWithCommonName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IssuerThumbprint +Specify thumbprint of client certificate's issuer + +```yaml +Type: System.String +Parameter Sets: SingleUpdateWithCommonName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReadonlyClientThumbprint +Specify client certificate thumbprint which only has read only permission + +```yaml +Type: System.String[] +Parameter Sets: MultipleUpdatesWithThumbprint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Thumbprint +Specify client certificate thumbprint + +```yaml +Type: System.String +Parameter Sets: SingleUpdateWithThumbprint +Aliases: ClientCertificateThumbprint + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSClientCertificateCommonName[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster + +## NOTES + +## RELATED LINKS + +[Add-AzServiceFabricClientCertificate](./Add-AzServiceFabricClientCertificate.md) diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedCluster.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedCluster.md new file mode 100644 index 0000000000..540ef4c8a9 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedCluster.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricmanagedcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedCluster.md +--- + +# Remove-AzServiceFabricManagedCluster + +## SYNOPSIS +Remove cluster resource. + +## SYNTAX + +### ByObj (Default) +``` +Remove-AzServiceFabricManagedCluster [-InputObject] <PSManagedCluster> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByName +``` +Remove-AzServiceFabricManagedCluster [-ResourceGroupName] <String> [-Name] <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ById +``` +Remove-AzServiceFabricManagedCluster [-ResourceId] <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove cluster this will remove the node types under the cluster too. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +Remove-AzServiceFabricManagedCluster -ResourceGroupName sfmcalsantamps -ClusterName sfmcalsantamps +``` + +Remove cluster. + +### Example 2 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$cluster = Get-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Name $clusterName + +$cluster | Remove-AzServiceFabricManagedCluster +``` + +Remove cluster, with piping. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Managed Cluster resource + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedCluster +Parameter Sets: ByObj +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Managed Cluster resource id + +```yaml +Type: System.String +Parameter Sets: ById +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterApplication.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterApplication.md new file mode 100644 index 0000000000..38e48b9a1e --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterApplication.md @@ -0,0 +1,253 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricmanagedclusterapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedClusterApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedClusterApplication.md +--- + +# Remove-AzServiceFabricManagedClusterApplication + +## SYNOPSIS +Remove an managed application from the cluster. This will remove all the managed services under the application. Only supports ARM deployed applications. + +## SYNTAX + +### ByResourceGroup (Default) +``` +Remove-AzServiceFabricManagedClusterApplication [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name] <String> [-PassThru] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzServiceFabricManagedClusterApplication -ResourceId <String> [-PassThru] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzServiceFabricManagedClusterApplication -InputObject <PSManagedApplication> [-PassThru] [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet removes an managed application form the cluster. This will remove all the managed services, if any, under the application resource. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +Remove-AzServiceFabricManagedClusterApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName +``` + +This example removes the managed application "testApp" under the resource group "testRG" and cluster "testCluster". + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$app = Get-AzServiceFabricManagedClusterApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName +$app | Remove-AzServiceFabricManagedClusterApplication +``` + +This example removes the managed application "testApp" under the resource group "testRG" and cluster "testCluster". + +### Example 3 +```powershell +$resourceId = "/subscriptions/13ad2c84-84fa-4798-ad71-e70c07af873f/resourcegroups/testRG/providers/Microsoft.ServiceFabric/managedClusters/testCluster/applications/testApp/services/testService" +Remove-AzServiceFabricManagedClusterApplication -ResourceId $resourceId +``` + +This example removes the managed application "testApp" with the ARM Resource ID specified. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove without prompt. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed application resource. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplication +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the managed application. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ApplicationName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the managed application. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplication + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterApplicationType.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterApplicationType.md new file mode 100644 index 0000000000..bed4f063c0 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterApplicationType.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricmanagedclusterapplicationtype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedClusterApplicationType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedClusterApplicationType.md +--- + +# Remove-AzServiceFabricManagedClusterApplicationType + +## SYNOPSIS +Removes a managed application type from the cluster. This will remove all type versions under this resource. Only supports ARM deployed application types. + +## SYNTAX + +### ByResourceGroup (Default) +``` +Remove-AzServiceFabricManagedClusterApplicationType [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name <String>] [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzServiceFabricManagedClusterApplicationType -ResourceId <String> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzServiceFabricManagedClusterApplicationType -InputObject <PSManagedApplicationType> [-PassThru] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet removes an managed application type form the cluster and will remove all type versions under this resource, but all applications under it should be removed before running this command. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +Remove-AzServiceFabricManagedClusterApplicationType -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Verbose +``` + +This example will remove the managed application type "testAppType" and all the version under it. If there are any applications created with this type, the command will throw an exception. + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$appType = Get-AzServiceFabricManagedClusterApplicationType -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName +$appType | Remove-AzServiceFabricManagedClusterApplicationType -Verbose +``` + +This example will remove the managed application type "testAppType" and all the version under it. If there are any applications created with this type, the command will throw an exception. + +### Example 3 +```powershell +$resourceId = "/subscriptions/13ad2c84-84fa-4798-ad71-e70c07af873f/resourcegroups/testRG/providers/Microsoft.ServiceFabric/managedClusters/testCluster/applicationTypes/testAppType" +Remove-AzServiceFabricManagedClusterApplicationType -ResourceId $resourceId +``` + +This example will remove the managed application type details with the ARM Resource ID specified. + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove without prompt. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed application type resource. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationType +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the managed application type. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ApplicationTypeName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the managed application type. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationType + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterApplicationTypeVersion.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterApplicationTypeVersion.md new file mode 100644 index 0000000000..7481bde67e --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterApplicationTypeVersion.md @@ -0,0 +1,271 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricmanagedclusterapplicationtypeversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedClusterApplicationTypeVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedClusterApplicationTypeVersion.md +--- + +# Remove-AzServiceFabricManagedClusterApplicationTypeVersion + +## SYNOPSIS +Removes a managed application type version from the cluster. Only supports ARM deployed application type versions. + +## SYNTAX + +### ByResourceGroup (Default) +``` +Remove-AzServiceFabricManagedClusterApplicationTypeVersion [-ResourceGroupName] <String> + [-ClusterName] <String> -Name <String> -Version <String> [-PassThru] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceId <String> [-PassThru] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzServiceFabricManagedClusterApplicationTypeVersion -InputObject <PSManagedApplicationTypeVersion> + [-PassThru] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet will remove a managed application type version from the cluster. All applications under this resource must be removed before running this command. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$version = "v1" +Remove-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Version $version -Force -PassThru -Verbose +``` + +This example will remove the managed version "v1" under the type "testAppType". It there are any applications under this resource the command will throw an exception. + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$version = "v1" +$appTypeVersion = Get-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Version $appTypeVersion +$appTypeVersion | Remove-AzServiceFabricManagedClusterApplicationTypeVersion -Force -PassThru -Verbose +``` + +This example will remove the managed version "v1" under the type "testAppType". It there are any applications under this resource the command will throw an exception. + +### Example 3 +```powershell +$resourceId = "/subscriptions/13ad2c84-84fa-4798-ad71-e70c07af873f/resourcegroups/testRG/providers/Microsoft.ServiceFabric/managedClusters/testCluster/applicationTypes/testAppType/versions/v1" +Remove-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceId $resourceId +``` + +This example will remove the managed application type version details with the ARM Resource ID specified. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove without prompt. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed application type version resource. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationTypeVersion +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the managed application type. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ApplicationTypeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the managed application type version. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Specify the managed application type version. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ApplicationTypeVersion + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationTypeVersion + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterClientCertificate.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterClientCertificate.md new file mode 100644 index 0000000000..392dd61997 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterClientCertificate.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricmanagedclusterclientcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedClusterClientCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedClusterClientCertificate.md +--- + +# Remove-AzServiceFabricManagedClusterClientCertificate + +## SYNOPSIS +Remvoe client certificate by thumbprint or common name. + +## SYNTAX + +### ClientCertByTpByObj (Default) +``` +Remove-AzServiceFabricManagedClusterClientCertificate [-InputObject] <PSManagedCluster> -Thumbprint <String> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClientCertByCnTpName +``` +Remove-AzServiceFabricManagedClusterClientCertificate [-ResourceGroupName] <String> [-Name] <String> + -Thumbprint <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ClientCertByCnByName +``` +Remove-AzServiceFabricManagedClusterClientCertificate [-ResourceGroupName] <String> [-Name] <String> + -CommonName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ClientCertByCnByObj +``` +Remove-AzServiceFabricManagedClusterClientCertificate [-InputObject] <PSManagedCluster> -CommonName <String> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remvoe client certificate by thumbprint or common name. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +Remove-AzServiceFabricManagedClusterClientCertificate -ResourceGroupName $rgName -Name $clusterName -CommonName 'Contoso.com' +``` + +Remove client certificate by common name. + +### Example 2 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +Remove-AzServiceFabricManagedClusterClientCertificate -ResourceGroupName $rgName -Name $clusterName -Thumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A +``` + +Remove client certificate by thumbprint. + +### Example 3 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$cluster = Get-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Name $clusterName + +$cluster | Remove-AzServiceFabricManagedClusterClientCertificate -Thumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A +``` + +Remove client certificate by thumbprint, with piping. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommonName +Client certificate common name. + +```yaml +Type: System.String +Parameter Sets: ClientCertByCnByName, ClientCertByCnByObj +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Managed cluster resource + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedCluster +Parameter Sets: ClientCertByTpByObj, ClientCertByCnByObj +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ClientCertByCnTpName, ClientCertByCnByName +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ClientCertByCnTpName, ClientCertByCnByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Thumbprint +Client certificate thumbprint. + +```yaml +Type: System.String +Parameter Sets: ClientCertByTpByObj, ClientCertByCnTpName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterService.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterService.md new file mode 100644 index 0000000000..85014aef15 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedClusterService.md @@ -0,0 +1,270 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricmanagedclusterservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedClusterService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedClusterService.md +--- + +# Remove-AzServiceFabricManagedClusterService + +## SYNOPSIS +Remove a managed service from the cluster. Only supports ARM deployed services. + +## SYNTAX + +### ByResourceGroup (Default) +``` +Remove-AzServiceFabricManagedClusterService [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationName] <String> [-Name] <String> [-PassThru] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzServiceFabricManagedClusterService -ResourceId <String> [-PassThru] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzServiceFabricManagedClusterService -InputObject <PSManagedService> [-PassThru] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet removes a managed service form the cluster. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$serviceName = "testService1" +Remove-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName +``` + +This example will remove the managed service "testService1". + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$serviceName = "testService1" +$service = Get-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName +$service | Remove-AzServiceFabricManagedClusterService +``` + +This example will remove the managed service testService1". + +### Example 3 +```powershell +$resourceId = "/subscriptions/13ad2c84-84fa-4798-ad71-e70c07af873f/resourcegroups/testRG/providers/Microsoft.ServiceFabric/managedClusters/testCluster/applications/testApp/services/testService" +Remove-AzServiceFabricManagedClusterService -ResourceId $resourceId +``` + +This example will remove the managed service details with the ARM Resource ID specified. + +## PARAMETERS + +### -ApplicationName +Specify the name of the application. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove without prompt. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed service resource. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedService +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the service. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ServiceName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the service. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedService + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedNodeType.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedNodeType.md new file mode 100644 index 0000000000..2c0698b615 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedNodeType.md @@ -0,0 +1,301 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricmanagednodetype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedNodeType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedNodeType.md +--- + +# Remove-AzServiceFabricManagedNodeType + +## SYNOPSIS +Remove the node type or specific nodes within the node type. + +## SYNTAX + +### DeleteNodeTypeByObj (Default) +``` +Remove-AzServiceFabricManagedNodeType [-InputObject] <PSManagedNodeType> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteNodeTypeByName +``` +Remove-AzServiceFabricManagedNodeType [-ResourceGroupName] <String> [-ClusterName] <String> [-Name] <String> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteNodeByName +``` +Remove-AzServiceFabricManagedNodeType [-ResourceGroupName] <String> [-ClusterName] <String> [-Name] <String> + -NodeName <String[]> [-ForceRemoveNode] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteNodeByObj +``` +Remove-AzServiceFabricManagedNodeType [-InputObject] <PSManagedNodeType> -NodeName <String[]> + [-ForceRemoveNode] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteNodeTypeById +``` +Remove-AzServiceFabricManagedNodeType [-ResourceId] <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteNodeById +``` +Remove-AzServiceFabricManagedNodeType [-ResourceId] <String> -NodeName <String[]> [-ForceRemoveNode] + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove the node type or specific nodes within the node type. If the paremter -NodeName is used then only nodes specified will be removed. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt2" +Remove-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName +``` + +Remove node type. + +### Example 2 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt2" +$nodeType = Get-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName + +$nodeType | Remove-AzServiceFabricManagedNodeType +``` + +Remove node type, with piping. + +### Example 3 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +Remove-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName -NodeName nt1_0, nt1_3 +``` + +Remove 2 nodes from the node type. + +### Example 4 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +$nodeType = Get-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName + +$nodeType | Remove-AzServiceFabricManagedNodeType -NodeName nt1_0, nt1_3 +``` + +Remove 2 nodes from the node type, with piping. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: DeleteNodeTypeByName, DeleteNodeByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceRemoveNode +Using this flag will force the removal even if service fabric is unable to disable the nodes. +Use with caution as this might cause data loss if stateful workloads are running on the nodes, or might bring the cluster down if there are not enough seed nodes after the opearion. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DeleteNodeByName, DeleteNodeByObj, DeleteNodeById +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Node type resource + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedNodeType +Parameter Sets: DeleteNodeTypeByObj, DeleteNodeByObj +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the node type. + +```yaml +Type: System.String +Parameter Sets: DeleteNodeTypeByName, DeleteNodeByName +Aliases: NodeTypeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeName +List of node names for the operation. + +```yaml +Type: System.String[] +Parameter Sets: DeleteNodeByName, DeleteNodeByObj, DeleteNodeById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DeleteNodeTypeByName, DeleteNodeByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Node type resource id + +```yaml +Type: System.String +Parameter Sets: DeleteNodeTypeById, DeleteNodeById +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedNodeTypeVMExtension.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedNodeTypeVMExtension.md new file mode 100644 index 0000000000..a2086a3b0c --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricManagedNodeTypeVMExtension.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricmanagednodetypevmextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedNodeTypeVMExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricManagedNodeTypeVMExtension.md +--- + +# Remove-AzServiceFabricManagedNodeTypeVMExtension + +## SYNOPSIS +Remove vm extension from the node type. + +## SYNTAX + +### ByObj (Default) +``` +Remove-AzServiceFabricManagedNodeTypeVMExtension [-InputObject] <PSManagedNodeType> -Name <String> [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByName +``` +Remove-AzServiceFabricManagedNodeTypeVMExtension [-ResourceGroupName] <String> [-ClusterName] <String> + [-NodeTypeName] <String> -Name <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove vm extension from the node type by name. Use [Get-AzServiceFabricManagedNodeType](./Get-AzServiceFabricManagedNodeType.md) and look at the VmExtensions property to see the current extension on the node type. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +Remove-AzServiceFabricManagedNodeTypeVMExtension -ResourceGroupName $rgName -ClusterName $clusterName -NodeTypeName $NodeTypeName -Name MyExtensionName +``` + +Remove extension from node type by name. + +### Example 2 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +$nodeType = Get-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName + +$nodeType | Remove-AzServiceFabricManagedNodeTypeVMExtension -Name MyExtensionName +``` + +Remove extension from node type by name, with piping. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Node type resource + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedNodeType +Parameter Sets: ByObj +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +extension name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeTypeName +Specify the name of the node type. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedNodeType + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricNode.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricNode.md new file mode 100644 index 0000000000..f0a696efa3 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricNode.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricnode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricNode.md +--- + +# Remove-AzServiceFabricNode + +## SYNOPSIS +Remove nodes from the specific node type from a cluster. + +## SYNTAX + +``` +Remove-AzServiceFabricNode -NumberOfNodesToRemove <Int32> [-ResourceGroupName] <String> [-Name] <String> + -NodeType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use **Remove-AzServiceFabricNode** to remove nodes from a specific node type from a cluster. The removal proceeds only if it meets cluster health metrics. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzServiceFabricNode -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -NodeType 'nt1' -NumberOfNodesToRemove 2 +``` + +This command will remove 2 nodes from the NodeType 'nt1'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeType +Node type name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NumberOfNodesToRemove +The number of nodes to remove + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Number + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster + +## NOTES + +## RELATED LINKS + +[Add-AzServiceFabricNode](./Add-AzServiceFabricNode.md) diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricNodeType.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricNodeType.md new file mode 100644 index 0000000000..466dbb5d2c --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricNodeType.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricnodetype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricNodeType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricNodeType.md +--- + +# Remove-AzServiceFabricNodeType + +## SYNOPSIS +Remove a complete node type from a cluster. + +## SYNTAX + +``` +Remove-AzServiceFabricNodeType [-ResourceGroupName] <String> [-Name] <String> -NodeType <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use the **Remove-AzServiceFabricNodeType** to remove all nodes from a specific node type and the node type from a cluster. This command cannot be used to delete the primary node type. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzServiceFabricNodeType -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -NodeType 'nt1' +``` + +This command will remove NodeType 'nt1' from the cluster. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeType +The node type name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricService.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricService.md new file mode 100644 index 0000000000..fc5f71e435 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricService.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricService.md +--- + +# Remove-AzServiceFabricService + +## SYNOPSIS +Remove a service from the cluster. Only supports ARM deployed services. + +## SYNTAX + +### ByResourceGroup (Default) +``` +Remove-AzServiceFabricService [-ResourceGroupName] <String> [-ClusterName] <String> [-ApplicationName] <String> + [-Name] <String> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Remove-AzServiceFabricService -ResourceId <String> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Remove-AzServiceFabricService -InputObject <PSService> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet removes a service form the cluster. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$serviceName = "testApp~testService1" +Remove-AzServiceFabricService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName +``` + +This example will remove the service "testApp~testService1". + +## PARAMETERS + +### -ApplicationName +Specify the name of the application. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove without prompt. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The service resource. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSService +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the service. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ServiceName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns $True if the command succeeds and $False if it fails. By default, this cmdlet does not return any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the service. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSService + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricSetting.md b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricSetting.md new file mode 100644 index 0000000000..f3db79ac75 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Remove-AzServiceFabricSetting.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/remove-azservicefabricsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Remove-AzServiceFabricSetting.md +--- + +# Remove-AzServiceFabricSetting + +## SYNOPSIS +Remove one or multiple Service Fabric setting from the cluster. + +## SYNTAX + +### OneSetting +``` +Remove-AzServiceFabricSetting [-ResourceGroupName] <String> [-Name] <String> -Section <String> + -Parameter <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BatchSettings +``` +Remove-AzServiceFabricSetting [-ResourceGroupName] <String> [-Name] <String> + -SettingsSectionDescription <PSSettingsSectionDescription[]> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use **Remove-AzServiceFabricSetting** to remove Service Fabric settings from the cluster. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzServiceFabricSetting -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -Section 'EseStore' -Parameter 'MaxCursors' +``` + +This command will remove settings 'MaxCursors' under 'EseStore' section. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameter +Parameter name of the fabric setting + +```yaml +Type: System.String +Parameter Sets: OneSetting +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Section +Section name of the fabric setting + +```yaml +Type: System.String +Parameter Sets: OneSetting +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SettingsSectionDescription +An array of fabric settings + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSSettingsSectionDescription[] +Parameter Sets: BatchSettings +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSSettingsSectionDescription[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Restart-AzServiceFabricManagedNodeType.md b/azps-10.1.0/Az.ServiceFabric/Restart-AzServiceFabricManagedNodeType.md new file mode 100644 index 0000000000..18bb81fe15 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Restart-AzServiceFabricManagedNodeType.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/restart-azservicefabricmanagednodetype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Restart-AzServiceFabricManagedNodeType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Restart-AzServiceFabricManagedNodeType.md +--- + +# Restart-AzServiceFabricManagedNodeType + +## SYNOPSIS +Restart specific nodes from the node type. + +## SYNTAX + +``` +Restart-AzServiceFabricManagedNodeType [-ResourceGroupName] <String> [-ClusterName] <String> [-Name] <String> + -NodeName <String[]> [-ForceRestart] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Restart specific nodes from the node type. It will disabled the service fabric nodes before restarting the vms and enabled them back again once they come back. If this is done on primary node types it might take a while as it might not restart all the nodes at the same time. Use -ForceRestart force the operation even if service fabric is unable to disable the nodes but use with caution as this might cause data loss if stateful workloads are running on the node. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +Restart-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName -NodeName nt1_0, nt1_3 +``` + +Restart node 0 and 3 on the node type. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceRestart +Using this flag will force the node to restart even if service fabric is unable to disable the nodes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the node type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: NodeTypeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeName +List of node names for the operation. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns $True if the command succeeds and $False if it fails. By default, this cmdlet does not return any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedCluster.md b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedCluster.md new file mode 100644 index 0000000000..edd065b323 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedCluster.md @@ -0,0 +1,293 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/set-azservicefabricmanagedcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricManagedCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricManagedCluster.md +--- + +# Set-AzServiceFabricManagedCluster + +## SYNOPSIS +Set cluster resource properties. + +## SYNTAX + +### ByObj (Default) +``` +Set-AzServiceFabricManagedCluster [-InputObject] <PSManagedCluster> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WithParamsByName +``` +Set-AzServiceFabricManagedCluster [-ResourceGroupName] <String> [-Name] <String> + [-UpgradeMode <ClusterUpgradeMode>] [-CodeVersion <String>] [-HttpGatewayConnectionPort <Int32>] + [-ClientConnectionPort <Int32>] [-DnsName <String>] [-AsJob] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByNameById +``` +Set-AzServiceFabricManagedCluster [-ResourceId] <String> [-UpgradeMode <ClusterUpgradeMode>] + [-CodeVersion <String>] [-HttpGatewayConnectionPort <Int32>] [-ClientConnectionPort <Int32>] + [-DnsName <String>] [-AsJob] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Set cluster resource properties. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$tags = @{"test"="tag"} +Set-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Name $clusterName -DnsName testnewdns -ClientConnectionPort 50000 -Tag $tags -Verbose +``` + +Update dns name and client connection port for the cluster. + +### Example 2 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$cluster = Get-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Name $clusterName + +$cluster.DnsName = "testnewdns" +$cluster.ClientConnectionPort = 50000 +$cluster | Set-AzServiceFabricManagedCluster +``` + +Update dns name and client connection port for the cluster, with piping. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientConnectionPort +Port used for client connections to the cluster. Default: 19000. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: WithParamsByName, ByNameById +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CodeVersion +Cluster code version. Only use if upgrade mode is Manual. + +```yaml +Type: System.String +Parameter Sets: WithParamsByName, ByNameById +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsName +Cluster's dns name. + +```yaml +Type: System.String +Parameter Sets: WithParamsByName, ByNameById +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpGatewayConnectionPort +Port used for http connections to the cluster. Default: 19080. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: WithParamsByName, ByNameById +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Managed Cluster resource + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedCluster +Parameter Sets: ByObj +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: WithParamsByName +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: WithParamsByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Managed Cluster resource id + +```yaml +Type: System.String +Parameter Sets: ByNameById +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Tag +Specify the tags as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: WithParamsByName, ByNameById +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeMode +Cluster code version upgrade mode. Automatic or Manual. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.ServiceFabric.Models.ClusterUpgradeMode] +Parameter Sets: WithParamsByName, ByNameById +Aliases: +Accepted values: Automatic, Manual + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedClusterApplication.md b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedClusterApplication.md new file mode 100644 index 0000000000..9e72b94652 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedClusterApplication.md @@ -0,0 +1,590 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/set-azservicefabricmanagedclusterapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricManagedClusterApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricManagedClusterApplication.md +--- + +# Set-AzServiceFabricManagedClusterApplication + +## SYNOPSIS +Update a service fabric managed application. This allows to update the application parameters and/or upgrade the application type version which will trigger an application upgrade or other configuration only updates. Only supports ARM deployed applications. + +## SYNTAX + +### ByResourceGroup (Default) +``` +Set-AzServiceFabricManagedClusterApplication [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name] <String> [[-ApplicationTypeVersion] <String>] [-ApplicationParameter <Hashtable>] [-ForceRestart] + [-RecreateApplication] [-UpgradeReplicaSetCheckTimeoutSec <Int32>] [-InstanceCloseDelayDurationSec <Int32>] + [-UpgradeMode <ApplicationUpgradeMode>] [-FailureAction <FailureAction>] [-HealthCheckRetryTimeoutSec <Int32>] + [-HealthCheckWaitDurationSec <Int32>] [-HealthCheckStableDurationSec <Int32>] + [-UpgradeDomainTimeoutSec <Int32>] [-UpgradeTimeoutSec <Int32>] [-ConsiderWarningAsError] + [-DefaultServiceTypeMaxPercentUnhealthyPartitionsPerService <Int32>] + [-DefaultServiceTypeMaxPercentUnhealthyReplicasPerPartition <Int32>] + [-DefaultServiceTypeUnhealthyServicesMaxPercent <Int32>] [-UnhealthyDeployedApplicationsMaxPercent <Int32>] + [-ServiceTypeHealthPolicyMap <Hashtable>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzServiceFabricManagedClusterApplication [[-ApplicationTypeVersion] <String>] + [-ApplicationParameter <Hashtable>] [-ForceRestart] [-RecreateApplication] + [-UpgradeReplicaSetCheckTimeoutSec <Int32>] [-InstanceCloseDelayDurationSec <Int32>] + [-UpgradeMode <ApplicationUpgradeMode>] [-FailureAction <FailureAction>] [-HealthCheckRetryTimeoutSec <Int32>] + [-HealthCheckWaitDurationSec <Int32>] [-HealthCheckStableDurationSec <Int32>] + [-UpgradeDomainTimeoutSec <Int32>] [-UpgradeTimeoutSec <Int32>] [-ConsiderWarningAsError] + [-DefaultServiceTypeMaxPercentUnhealthyPartitionsPerService <Int32>] + [-DefaultServiceTypeMaxPercentUnhealthyReplicasPerPartition <Int32>] + [-DefaultServiceTypeUnhealthyServicesMaxPercent <Int32>] [-UnhealthyDeployedApplicationsMaxPercent <Int32>] + [-ServiceTypeHealthPolicyMap <Hashtable>] [-Tag <Hashtable>] -ResourceId <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Set-AzServiceFabricManagedClusterApplication [[-ApplicationTypeVersion] <String>] + [-ApplicationParameter <Hashtable>] [-ForceRestart] [-RecreateApplication] + [-UpgradeReplicaSetCheckTimeoutSec <Int32>] [-InstanceCloseDelayDurationSec <Int32>] + [-UpgradeMode <ApplicationUpgradeMode>] [-FailureAction <FailureAction>] [-HealthCheckRetryTimeoutSec <Int32>] + [-HealthCheckWaitDurationSec <Int32>] [-HealthCheckStableDurationSec <Int32>] + [-UpgradeDomainTimeoutSec <Int32>] [-UpgradeTimeoutSec <Int32>] [-ConsiderWarningAsError] + [-DefaultServiceTypeMaxPercentUnhealthyPartitionsPerService <Int32>] + [-DefaultServiceTypeMaxPercentUnhealthyReplicasPerPartition <Int32>] + [-DefaultServiceTypeUnhealthyServicesMaxPercent <Int32>] [-UnhealthyDeployedApplicationsMaxPercent <Int32>] + [-ServiceTypeHealthPolicyMap <Hashtable>] [-Tag <Hashtable>] -InputObject <PSManagedApplication> [-Force] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet can be used to update application parameters and upgrade the application type version along with other configuration only updates. Updating the parameter will only change the model in ARM side, only when a new type version is used, the command will trigger an application upgrade. The type version specified should already be created in the cluster using **New-AzServiceFabricManagedClusterApplicationTypeVersion**. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$version = "v2" +$packageUrl = "https://sftestapp.blob.core.windows.net/sftestapp/testAppType_v2.sfpkg" +New-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName -Version $version -PackageUrl $packageUrl -Verbose +Set-AzServiceFabricManagedClusterApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationTypeVersion $version -Name $appName -ApplicationParameter @{key0="value0";key1=$null;key2="value2"} -Tag @{tag0="updated"} +``` + +This example will start an managed application upgrade to update the type version to "v2" which was created with **New-AzServiceFabricManagedClusterApplicationTypeVersion**. The application parameters used should be defined in the application manifest. + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +Set-AzServiceFabricManagedClusterApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName -FailureAction Rollback -ForceRestart:$false -Verbose +``` + +This example will updates the FailureAction and sets ForceRestart to false. + +### Example 3 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$version = "v2" +$packageUrl = "https://sftestapp.blob.core.windows.net/sftestapp/testAppType_v2.sfpkg" +New-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName -Version $version -PackageUrl $packageUrl -Verbose +Set-AzServiceFabricManagedClusterApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationTypeVersion $version -Name $appName -ApplicationParameter @{key0="value0";key1=$null;key2="value2"} -HealthCheckStableDurationSec 0 -HealthCheckWaitDurationSec 0 -HealthCheckRetryTimeoutSec 0 -UpgradeDomainTimeoutSec 5000 -UpgradeTimeoutSec 7000 -FailureAction Rollback -UpgradeReplicaSetCheckTimeoutSec 300 -ForceRestart +``` + +This example will start an application upgrade to update the type version to "v2" and also sets some upgrade policy parameters that will take effect from the current upgrade. + +### Example 4 +```powershell +Set-AzServiceFabricManagedClusterApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName -ApplicationParameter @{key0="value0";key1=$null;key2="value2"} +``` + +This example updates the application parameters but these changes will only take effect until the next version upgrade to the application. + +## PARAMETERS + +### -ApplicationParameter +Specify the application parameters as key/value pairs. +These parameters must exist in the application manifest. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationTypeVersion +Specify the application type version + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConsiderWarningAsError +Indicates whether to treat a warning health event as an error event during health evaluation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultServiceTypeMaxPercentUnhealthyPartitionsPerService +Specifies the maximum percent of unhelthy partitions per service allowed by the health policy for the default service type to use for the monitored upgrade. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultServiceTypeMaxPercentUnhealthyReplicasPerPartition +Specifies the maximum percent of unhelthy replicas per service allowed by the health policy for the default service type to use for the monitored upgrade. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultServiceTypeUnhealthyServicesMaxPercent +Specifies the maximum percent of unhelthy services allowed by the health policy for the default service type to use for the monitored upgrade. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailureAction +Specifies the action to take if the monitored upgrade fails. +The acceptable values for this parameter are Rollback or Manual. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.FailureAction +Parameter Sets: (All) +Aliases: +Accepted values: Rollback, Manual + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Continue without prompts + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceRestart +Indicates that the service host restarts even if the upgrade is a configuration-only change. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthCheckRetryTimeoutSec +Specifies the duration, in seconds, after which Service Fabric retries the health check if the previous health check fails. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthCheckStableDurationSec +Specifies the duration, in seconds, that Service Fabric waits in order to verify that the application is stable before moving to the next upgrade domain or completing the upgrade. +This wait duration prevents undetected changes of health right after the health check is performed. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthCheckWaitDurationSec +Specifies the duration, in seconds, that Service Fabric waits before it performs the initial health check after it finishes the upgrade on the upgrade domain. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed application resource. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplication +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceCloseDelayDurationSec +Specifies the duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the application + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ApplicationName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecreateApplication +Determines whether the application should be recreated on update. +If value=true, the rest of the upgrade policy parameters are not allowed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the managed application. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceTypeHealthPolicyMap +Specifies the map of the health policy to use for different service types as a hash table in the following format: @ {"ServiceTypeName" : "MaxPercentUnhealthyPartitionsPerService,MaxPercentUnhealthyReplicasPerPartition,MaxPercentUnhealthyServices"}. +For example: @{ "ServiceTypeName01" = "5,10,5"; "ServiceTypeName02" = "5,5,5" } + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specify the tags as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UnhealthyDeployedApplicationsMaxPercent +Specifies the maximum percentage of the application instances deployed on the nodes in the cluster that have a health state of error before the application health state for the cluster is error. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeDomainTimeoutSec +Specifies the maximum time, in seconds, that Service Fabric takes to upgrade a single upgrade domain. +After this period, the upgrade fails. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeMode +The mode used to monitor health during a rolling upgrade. +The values are Monitored, and UnmonitoredAuto. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.ApplicationUpgradeMode +Parameter Sets: (All) +Aliases: +Accepted values: Monitored, UnmonitoredAuto + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeReplicaSetCheckTimeoutSec +Specifies the maximum time that Service Fabric waits for a service to reconfigure into a safe state, if not already in a safe state, before Service Fabric proceeds with the upgrade. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeTimeoutSec +Specifies the maximum time, in seconds, that Service Fabric takes for the entire upgrade. +After this period, the upgrade fails. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplication + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplication + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedClusterApplicationType.md b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedClusterApplicationType.md new file mode 100644 index 0000000000..fbbecc9c5a --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedClusterApplicationType.md @@ -0,0 +1,245 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/set-azservicefabricmanagedclusterapplicationtype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricManagedClusterApplicationType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricManagedClusterApplicationType.md +--- + +# Set-AzServiceFabricManagedClusterApplicationType + +## SYNOPSIS +Update a service fabric managed application type. This allows you to update the tags. Only supports ARM deployed application types. + +## SYNTAX + +### ByResourceGroup (Default) +``` +Set-AzServiceFabricManagedClusterApplicationType [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name <String>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObject +``` +Set-AzServiceFabricManagedClusterApplicationType [-Tag <Hashtable>] -InputObject <PSManagedApplicationType> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzServiceFabricManagedClusterApplicationType [-Tag <Hashtable>] -ResourceId <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet can be used to update application type tags. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$newTags = @{new="tags"} +Set-AzServiceFabricManagedClusterApplicationType -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Tag $newTags -Verbose +``` + +This example will update the managed application type "testAppType" tags. + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$newTags = @{new="tags"} +$appType = Get-AzServiceFabricManagedClusterApplicationType -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName +$appType | Set-AzServiceFabricManagedClusterApplicationType -Tag $newTags -Verbose +``` + +This example will update the managed application type "testAppType" tags. + +### Example 3 +```powershell +$newTags = @{new="tags"} +$resourceId = "/subscriptions/13ad2c84-84fa-4798-ad71-e70c07af873f/resourcegroups/testRG/providers/Microsoft.ServiceFabric/managedClusters/testCluster/applicationTypes/testAppType" +Set-AzServiceFabricManagedClusterApplicationType -ResourceId $resourceId -Tag $newTags +``` + +This example will update the managed application type details with the ARM Resource ID specified. + +## PARAMETERS + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Remove without prompt. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed application type resource. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationType +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the managed application type. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ApplicationTypeName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the managed application type. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specify the tags as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationType + +## OUTPUTS + +### System.Boolean + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationType + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedClusterApplicationTypeVersion.md b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedClusterApplicationTypeVersion.md new file mode 100644 index 0000000000..07c5b10696 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedClusterApplicationTypeVersion.md @@ -0,0 +1,294 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/set-azservicefabricmanagedclusterapplicationtypeversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricManagedClusterApplicationTypeVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricManagedClusterApplicationTypeVersion.md +--- + +# Set-AzServiceFabricManagedClusterApplicationTypeVersion + +## SYNOPSIS +Update a service fabric managed application type version. This allows you to update the tags and package Url. Only supports ARM deployed application type versions. + +## SYNTAX + +### ByResourceGroup (Default) +``` +Set-AzServiceFabricManagedClusterApplicationTypeVersion [-ResourceGroupName] <String> [-ClusterName] <String> + [-Name] <String> [-Version] <String> [-PackageUrl <String>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceId +``` +Set-AzServiceFabricManagedClusterApplicationTypeVersion [-PackageUrl <String>] [-Tag <Hashtable>] + -ResourceId <String> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByInputObject +``` +Set-AzServiceFabricManagedClusterApplicationTypeVersion [-PackageUrl <String>] [-Tag <Hashtable>] + -InputObject <PSManagedApplicationTypeVersion> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet can be used to update application type version tags. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$version = "v1" +$newTags = @{new="tags"} +$packageUrl = "https://sftestapp.blob.core.windows.net/sftestapp/testAppType_v1.sfpkg" +Set-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Version $version -Tag $newTags -PackageUrl $packageUrl -Verbose +``` + +This example will update the managed application type version "v1" tags and packageUrl. + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appTypeName = "testAppType" +$newTags = @{new="tags"} +$packageUrl = "https://sftestapp.blob.core.windows.net/sftestapp/testAppType_v1.sfpkg" +$appType = Get-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appTypeName -Version $version +$appType | Set-AzServiceFabricManagedClusterApplicationTypeVersion -Tag $newTags -PackageUrl $packageUrl -Verbose +``` + +This example will update the managed application type version "v1" tags and packageUrl. + +### Example 3 +```powershell +$newTags = @{new="tags"} +$packageUrl = "https://sftestapp.blob.core.windows.net/sftestapp/testAppType_v1.sfpkg" +$resourceId = "/subscriptions/13ad2c84-84fa-4798-ad71-e70c07af873f/resourcegroups/testRG/providers/Microsoft.ServiceFabric/managedClusters/testCluster/applicationTypes/testAppType/versions/v1" +Set-AzServiceFabricManagedClusterApplicationTypeVersion -ResourceId $resourceId -Tag $newTags -PackageUrl $packageUrl -Verbose +``` + +This example will update the managed application type details with the ARM Resource ID specified. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Continue without prompts + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed application type version resource. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationTypeVersion +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the managed application type + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ApplicationTypeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageUrl +Specify the url of the application package sfpkg file + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the managed application type version. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Specify the tags as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Specify the managed application type version + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ApplicationTypeVersion + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationTypeVersion + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedApplicationTypeVersion + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedClusterService.md b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedClusterService.md new file mode 100644 index 0000000000..29763751ff --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedClusterService.md @@ -0,0 +1,584 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/set-azservicefabricmanagedclusterservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricManagedClusterService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricManagedClusterService.md +--- + +# Set-AzServiceFabricManagedClusterService + +## SYNOPSIS +Update a managed service from the cluster. Only supports ARM deployed services. + +## SYNTAX + +### Stateless-ByResourceGroup (Default) +``` +Set-AzServiceFabricManagedClusterService [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationName] <String> [-Name] <String> [-Stateless] [-InstanceCount <Int32>] [-MinInstanceCount <Int32>] + [-MinInstancePercentage <Int32>] [-DefaultMoveCost <MoveCostEnum>] [-PlacementConstraint <String>] + [-Metric <PSServiceMetric[]>] [-Correlation <PSServiceCorrelation[]>] + [-ServicePackageActivationMode <ServicePackageActivationModeEnum>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Stateful-ByResourceGroup +``` +Set-AzServiceFabricManagedClusterService [-ResourceGroupName] <String> [-ClusterName] <String> + [-ApplicationName] <String> [-Name] <String> [-Stateful] [-TargetReplicaSetSize <Int32>] + [-MinReplicaSetSize <Int32>] [-HasPersistedState] [-ReplicaRestartWaitDuration <TimeSpan>] + [-QuorumLossWaitDuration <TimeSpan>] [-StandByReplicaKeepDuration <TimeSpan>] + [-ServicePlacementTimeLimit <TimeSpan>] [-DefaultMoveCost <MoveCostEnum>] [-PlacementConstraint <String>] + [-Metric <PSServiceMetric[]>] [-Correlation <PSServiceCorrelation[]>] + [-ServicePackageActivationMode <ServicePackageActivationModeEnum>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Stateless-ByResourceId +``` +Set-AzServiceFabricManagedClusterService -ResourceId <String> [-Stateless] [-InstanceCount <Int32>] + [-MinInstanceCount <Int32>] [-MinInstancePercentage <Int32>] [-DefaultMoveCost <MoveCostEnum>] + [-PlacementConstraint <String>] [-Metric <PSServiceMetric[]>] [-Correlation <PSServiceCorrelation[]>] + [-ServicePackageActivationMode <ServicePackageActivationModeEnum>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Stateful-ByResourceId +``` +Set-AzServiceFabricManagedClusterService -ResourceId <String> [-Stateful] [-TargetReplicaSetSize <Int32>] + [-MinReplicaSetSize <Int32>] [-HasPersistedState] [-ReplicaRestartWaitDuration <TimeSpan>] + [-QuorumLossWaitDuration <TimeSpan>] [-StandByReplicaKeepDuration <TimeSpan>] + [-ServicePlacementTimeLimit <TimeSpan>] [-DefaultMoveCost <MoveCostEnum>] [-PlacementConstraint <String>] + [-Metric <PSServiceMetric[]>] [-Correlation <PSServiceCorrelation[]>] + [-ServicePackageActivationMode <ServicePackageActivationModeEnum>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Stateless-ByInputObject +``` +Set-AzServiceFabricManagedClusterService -InputObject <PSManagedService> [-Stateless] [-InstanceCount <Int32>] + [-MinInstanceCount <Int32>] [-MinInstancePercentage <Int32>] [-DefaultMoveCost <MoveCostEnum>] + [-PlacementConstraint <String>] [-Metric <PSServiceMetric[]>] [-Correlation <PSServiceCorrelation[]>] + [-ServicePackageActivationMode <ServicePackageActivationModeEnum>] [-Tag <Hashtable>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Stateful-ByInputObject +``` +Set-AzServiceFabricManagedClusterService -InputObject <PSManagedService> [-Stateful] + [-TargetReplicaSetSize <Int32>] [-MinReplicaSetSize <Int32>] [-HasPersistedState] + [-ReplicaRestartWaitDuration <TimeSpan>] [-QuorumLossWaitDuration <TimeSpan>] + [-StandByReplicaKeepDuration <TimeSpan>] [-ServicePlacementTimeLimit <TimeSpan>] + [-DefaultMoveCost <MoveCostEnum>] [-PlacementConstraint <String>] [-Metric <PSServiceMetric[]>] + [-Correlation <PSServiceCorrelation[]>] [-ServicePackageActivationMode <ServicePackageActivationModeEnum>] + [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet updates a managed service form the cluster. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$serviceName = "testService1" +Set-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName -Stateful -TargetReplicaSetSize 3 -MinReplicaSetSize 5 -Verbose +``` + +This example will update the managed service "testService1". + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$serviceName = "testService1" +$minInstancePercentage = 20 +$minInstanceCount = 2 +$statelessServiceMetric = New-Object -TypeName "Microsoft.Azure.Commands.ServiceFabric.Models.PSServiceMetric" -ArgumentList @("metric1", "Low", 4) +$service = Get-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName +$service | Set-AzServiceFabricManagedClusterService -Stateless -Metric @($statelessServiceMetric) -MinInstanceCount $minInstanceCount -MinInstancePercentage $minInstancePercentage -Verbose +``` + +This example will remove the managed service testService1". + +### Example 3 +```powershell +$standByReplicaKeepDuration = "00:11:00" +$servicePlacementTimeLimit = "00:11:00" +$resourceId = "/subscriptions/13ad2c84-84fa-4798-ad71-e70c07af873f/resourcegroups/testRG/providers/Microsoft.ServiceFabric/managedClusters/testCluster/applications/testApp/services/testService" +Set-AzServiceFabricManagedClusterService -ResourceId $resourceId -StandByReplicaKeepDuration $standByReplicaKeepDuration -ServicePlacementTimeLimit $servicePlacementTimeLimit -Verbose +``` + +This example will remove the managed service details with the ARM Resource ID specified. + +## PARAMETERS + +### -ApplicationName +Specify the name of the managed application. + +```yaml +Type: System.String +Parameter Sets: Stateless-ByResourceGroup, Stateful-ByResourceGroup +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: Stateless-ByResourceGroup, Stateful-ByResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Correlation +Specify the placement constraints of the managed service, as a string. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSServiceCorrelation[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMoveCost +Specify the default cost for a move. +Higher costs make it less likely that the Cluster Resource Manager will move the replica when trying to balance the cluster + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.MoveCostEnum +Parameter Sets: (All) +Aliases: +Accepted values: Zero, Low, Medium, High + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Continue without prompts + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasPersistedState +Specify the target replica set size for the managed service + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateful-ByResourceGroup, Stateful-ByResourceId, Stateful-ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed service resource. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedService +Parameter Sets: Stateless-ByInputObject, Stateful-ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceCount +Specify the instance count for the managed service + +```yaml +Type: System.Int32 +Parameter Sets: Stateless-ByResourceGroup, Stateless-ByResourceId, Stateless-ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metric +Specify the placement constraints of the managed service, as a string. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSServiceMetric[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinInstanceCount +Specify the minimum instance count for the managed service + +```yaml +Type: System.Int32 +Parameter Sets: Stateless-ByResourceGroup, Stateless-ByResourceId, Stateless-ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinInstancePercentage +Specify the minimum instance percentage for the managed service + +```yaml +Type: System.Int32 +Parameter Sets: Stateless-ByResourceGroup, Stateless-ByResourceId, Stateless-ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinReplicaSetSize +Specify the min replica set size for the managed service + +```yaml +Type: System.Int32 +Parameter Sets: Stateful-ByResourceGroup, Stateful-ByResourceId, Stateful-ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the managed service. + +```yaml +Type: System.String +Parameter Sets: Stateless-ByResourceGroup, Stateful-ByResourceGroup +Aliases: ServiceName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlacementConstraint +Specify the placement constraints of the managed service, as a string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuorumLossWaitDuration +Specify the quorum loss wait duration for the managed service. +Duration represented in ISO 8601 format 'hh:mm:ss' + +```yaml +Type: System.TimeSpan +Parameter Sets: Stateful-ByResourceGroup, Stateful-ByResourceId, Stateful-ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaRestartWaitDuration +Specify the replica restart wait duration for the managed service. +Duration represented in ISO 8601 format 'hh:mm:ss' + +```yaml +Type: System.TimeSpan +Parameter Sets: Stateful-ByResourceGroup, Stateful-ByResourceId, Stateful-ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Stateless-ByResourceGroup, Stateful-ByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the managed service. + +```yaml +Type: System.String +Parameter Sets: Stateless-ByResourceId, Stateful-ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServicePackageActivationMode +Specify the default cost for a move. +Higher costs make it less likely that the Cluster Resource Manager will move the replica when trying to balance the cluster + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.ServicePackageActivationModeEnum +Parameter Sets: (All) +Aliases: +Accepted values: SharedProcess, ExclusiveProcess + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePlacementTimeLimit +Specify the service placement time limit for the managed service. +Duration represented in ISO 8601 format 'hh:mm:ss' + +```yaml +Type: System.TimeSpan +Parameter Sets: Stateful-ByResourceGroup, Stateful-ByResourceId, Stateful-ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StandByReplicaKeepDuration +Specify the stand by replica duration for the managed service. +Duration represented in ISO 8601 format 'hh:mm:ss' + +```yaml +Type: System.TimeSpan +Parameter Sets: Stateful-ByResourceGroup, Stateful-ByResourceId, Stateful-ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Stateful +Use for stateful service + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateful-ByResourceGroup, Stateful-ByResourceId, Stateful-ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Stateless +Use for stateless service + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Stateless-ByResourceGroup, Stateless-ByResourceId, Stateless-ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specify the tags as key/value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetReplicaSetSize +Specify the target replica set size for the managed service + +```yaml +Type: System.Int32 +Parameter Sets: Stateful-ByResourceGroup, Stateful-ByResourceId, Stateful-ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedService + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedNodeType.md b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedNodeType.md new file mode 100644 index 0000000000..7946910f33 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricManagedNodeType.md @@ -0,0 +1,423 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/set-azservicefabricmanagednodetype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricManagedNodeType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricManagedNodeType.md +--- + +# Set-AzServiceFabricManagedNodeType + +## SYNOPSIS +Sets node type resource properties or run reimage actions on specific ndes of the node type with -Reimage parameter. + +## SYNTAX + +### ByObj (Default) +``` +Set-AzServiceFabricManagedNodeType [-InputObject] <PSManagedNodeType> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WithParamsByName +``` +Set-AzServiceFabricManagedNodeType [-ResourceGroupName] <String> [-ClusterName] <String> [-Name] <String> + [-AsJob] [-InstanceCount <Int32>] [-ApplicationStartPort <Int32>] [-ApplicationEndPort <Int32>] + [-EphemeralStartPort <Int32>] [-EphemeralEndPort <Int32>] [-Capacity <Hashtable>] + [-PlacementProperty <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ReimageByName +``` +Set-AzServiceFabricManagedNodeType [-ResourceGroupName] <String> [-ClusterName] <String> [-Name] <String> + -NodeName <String[]> [-Reimage] [-ForceReimage] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WithParamsById +``` +Set-AzServiceFabricManagedNodeType [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ReimageById +``` +Set-AzServiceFabricManagedNodeType [-ResourceId] <String> -NodeName <String[]> [-Reimage] [-ForceReimage] + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ReimageByObj +``` +Set-AzServiceFabricManagedNodeType [-InputObject] <PSManagedNodeType> -NodeName <String[]> [-Reimage] + [-ForceReimage] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Sets node type resource properties or run reimage actions on specific ndes of the node type with -Reimage parameter. On reimgae operation the service fabric nodes will be disabled before reimaging the vms and enabled them back again once they come back. If this is done on primary node types it might take a while as it might not reimage all the nodes at the same time. Use -ForceReimage force the operation even if service fabric is unable to disable the nodes but use with caution as this might cause data loss if stateful workloads are running on the node. + +## EXAMPLES + +### Example 1 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +Set-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -name $NodeTypeName -InstanceCount 6 -Verbose +``` + +Update the instance count of the node type. + +### Example 2 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +Set-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -name $NodeTypeName -PlacementProperty @{NodeColor="Red";SomeProperty="6";} -Verbose +``` + +Update placement properites of the node type. This will overwrite older placement properites if any. + +### Example 3 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +Set-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName -Reimage -NodeName nt1_0, nt1_3 +``` + +Reimage node 0 and 3 on the node type. + +### Example 4 +```powershell +$rgName = "testRG" +$clusterName = "testCluster" +$NodeTypeName = "nt1" +$nodeType = Get-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -Name $NodeTypeName + +$nodeType.VmInstanceCount = 6 +$nodeType | Set-AzServiceFabricManagedNodeType +``` + +Update the instance count of the node type, with piping. + +## PARAMETERS + +### -ApplicationEndPort +Application End port of a range of ports. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: WithParamsByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationStartPort +Application start port of a range of ports. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: WithParamsByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Capacity +Capacity tags applied to the nodes in the node type as key/value pairs, the cluster resource manager uses these tags to understand how much resource a node has. Updating this will override the current values. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: WithParamsByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: WithParamsByName, ReimageByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EphemeralEndPort +Ephemeral end port of a range of ports. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: WithParamsByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EphemeralStartPort +Ephemeral start port of a range of ports. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: WithParamsByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceReimage +Using this flag will force the removal even if service fabric is unable to disable the nodes. +Use with caution as this might cause data loss if stateful workloads are running on the node. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ReimageByName, ReimageById, ReimageByObj +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Node type resource + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSManagedNodeType +Parameter Sets: ByObj, ReimageByObj +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceCount +The number of nodes in the node type. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: WithParamsByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the node type. + +```yaml +Type: System.String +Parameter Sets: WithParamsByName, ReimageByName +Aliases: NodeTypeName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeName +List of node names for the operation. + +```yaml +Type: System.String[] +Parameter Sets: ReimageByName, ReimageById, ReimageByObj +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ReimageByName, ReimageById, ReimageByObj +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlacementProperty +Placement tags applied to nodes in the node type as key/value pairs, which can be used to indicate where certain services (workload) should run. Updating this will override the current values. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: WithParamsByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reimage +Specify to reimage nodes on the node type. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ReimageByName, ReimageById, ReimageByObj +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: WithParamsByName, ReimageByName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Node type resource id + +```yaml +Type: System.String +Parameter Sets: WithParamsById, ReimageById +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricSetting.md b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricSetting.md new file mode 100644 index 0000000000..8dd324c23d --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricSetting.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/set-azservicefabricsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricSetting.md +--- + +# Set-AzServiceFabricSetting + +## SYNOPSIS +Add or update one or multiple Service Fabric settings to the cluster. + +## SYNTAX + +### OneSetting +``` +Set-AzServiceFabricSetting [-ResourceGroupName] <String> [-Name] <String> -Section <String> -Parameter <String> + -Value <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BatchSettings +``` +Set-AzServiceFabricSetting [-ResourceGroupName] <String> [-Name] <String> + -SettingsSectionDescription <PSSettingsSectionDescription[]> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use **Set-AzServiceFabricSetting** to add or update Service Fabric settings in a cluster. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzServiceFabricSetting -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -Section 'NamingService' -Parameter 'MaxFileOperationTimeout' -Value 5000 +``` + +This command will set 'MaxFileOperationTimeout' to value '5000' under the section 'NamingService'. + +### Example 2 +```powershell +$fabricSettings = @( + @{ + "name" = "NamingService"; + "parameters" = [System.Collections.Generic.List[Microsoft.Azure.Commands.ServiceFabric.Models.PSSettingsParameterDescription]]@( + @{ "Name" = "MaxFileOperationTimeout"; "Value" = "5000" }; + @{ "Name" = "MaxOperationTimeout"; "Value" = "1200" }) + }, + @{ + "name" = "Hosting"; + "parameters" = [System.Collections.Generic.List[Microsoft.Azure.Commands.ServiceFabric.Models.PSSettingsParameterDescription]]@( + @{ "Name" = "ActivationMaxFailureCount"; "Value" = "11" }) + }) + +Set-AzServiceFabricSetting -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -SettingsSectionDescription $fabricSettings -Verbose +``` + +This command will trigger an upgrade to set multiple fabric setting using SettingsSectionDescription parameter. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Parameter +Parameter name of the fabric setting + +```yaml +Type: System.String +Parameter Sets: OneSetting +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Section +Section name of the fabric setting + +```yaml +Type: System.String +Parameter Sets: OneSetting +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SettingsSectionDescription +An array of fabric settings + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSSettingsSectionDescription[] +Parameter Sets: BatchSettings +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Value +Parameter value of the fabric setting + +```yaml +Type: System.String +Parameter Sets: OneSetting +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSSettingsSectionDescription[] + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricUpgradeType.md b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricUpgradeType.md new file mode 100644 index 0000000000..31507989cf --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Set-AzServiceFabricUpgradeType.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/set-azservicefabricupgradetype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricUpgradeType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricUpgradeType.md +--- + +# Set-AzServiceFabricUpgradeType + +## SYNOPSIS +Change the Service Fabric upgrade type of the cluster. + +## SYNTAX + +### Automatic +``` +Set-AzServiceFabricUpgradeType [-ResourceGroupName] <String> [-Name] <String> -UpgradeMode <ClusterUpgradeMode> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Manual +``` +Set-AzServiceFabricUpgradeType [-ResourceGroupName] <String> [-Name] <String> -UpgradeMode <ClusterUpgradeMode> + -Version <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use **Set-AzServiceFabricUpgradeType** to set upgrade type to automatic or manual with specific Service Fabric code version. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzServiceFabricUpgradeType -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -UpgradeMode Automatic +``` + +This command will set the cluster upgrade mode to automatic. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UpgradeMode +ClusterUpgradeMode + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.ClusterUpgradeMode +Parameter Sets: (All) +Aliases: +Accepted values: Automatic, Manual + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Version +Cluster code version + +```yaml +Type: System.String +Parameter Sets: Manual +Aliases: ClusterCodeVersion + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.ClusterUpgradeMode + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricApplication.md b/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricApplication.md new file mode 100644 index 0000000000..bd646794d7 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricApplication.md @@ -0,0 +1,514 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/update-azservicefabricapplication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricApplication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricApplication.md +--- + +# Update-AzServiceFabricApplication + +## SYNOPSIS +Update a service fabric application. This allows to update the application parameters and/or upgrade the application type version which will trigger an application upgrade. Only supports ARM deployed applications. + +## SYNTAX + +### ByResourceGroup (Default) +``` +Update-AzServiceFabricApplication [-ResourceGroupName] <String> [-ClusterName] <String> [-Name] <String> + [[-ApplicationTypeVersion] <String>] [-ApplicationParameter <Hashtable>] [-MinimumNodeCount <Int64>] + [-MaximumNodeCount <Int64>] [-ForceRestart] [-UpgradeReplicaSetCheckTimeoutSec <Int32>] + [-FailureAction <FailureAction>] [-HealthCheckRetryTimeoutSec <Int32>] [-HealthCheckWaitDurationSec <Int32>] + [-HealthCheckStableDurationSec <Int32>] [-UpgradeDomainTimeoutSec <Int32>] [-UpgradeTimeoutSec <Int32>] + [-ConsiderWarningAsError] [-DefaultServiceTypeMaxPercentUnhealthyPartitionsPerService <Int32>] + [-DefaultServiceTypeMaxPercentUnhealthyReplicasPerPartition <Int32>] + [-DefaultServiceTypeUnhealthyServicesMaxPercent <Int32>] [-UnhealthyDeployedApplicationsMaxPercent <Int32>] + [-ServiceTypeHealthPolicyMap <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ByResourceId +``` +Update-AzServiceFabricApplication [[-ApplicationTypeVersion] <String>] [-ApplicationParameter <Hashtable>] + [-MinimumNodeCount <Int64>] [-MaximumNodeCount <Int64>] [-ForceRestart] + [-UpgradeReplicaSetCheckTimeoutSec <Int32>] [-FailureAction <FailureAction>] + [-HealthCheckRetryTimeoutSec <Int32>] [-HealthCheckWaitDurationSec <Int32>] + [-HealthCheckStableDurationSec <Int32>] [-UpgradeDomainTimeoutSec <Int32>] [-UpgradeTimeoutSec <Int32>] + [-ConsiderWarningAsError] [-DefaultServiceTypeMaxPercentUnhealthyPartitionsPerService <Int32>] + [-DefaultServiceTypeMaxPercentUnhealthyReplicasPerPartition <Int32>] + [-DefaultServiceTypeUnhealthyServicesMaxPercent <Int32>] [-UnhealthyDeployedApplicationsMaxPercent <Int32>] + [-ServiceTypeHealthPolicyMap <Hashtable>] [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByInputObject +``` +Update-AzServiceFabricApplication -InputObject <PSApplication> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet can be used to update application parameters and upgrade the application type version. Updating the parameter will only change the model in ARM side, only when a new type version is used, the command will trigger an application upgrade. The type version specified should already be created in the cluster using **New-AzServiceFabricApplicationTypeVersion**. + +## EXAMPLES + +### Example 1 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$version = "v2" +$packageUrl = "https://sftestapp.blob.core.windows.net/sftestapp/testAppType_v2.sfpkg" +New-AzServiceFabricApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName -Version $version -PackageUrl $packageUrl -Verbose +Update-AzServiceFabricApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationTypeVersion $version -Name $appName -ApplicationParameter @{key0="value0";key1=$null;key2="value2"} +``` + +This example will start an application upgrade to update the type version to "v2" which was created with **New-AzServiceFabricApplicationTypeVersion**. The application parameters used should be defined in the application manifest. + +### Example 2 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +Update-AzServiceFabricApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName -MinimumNodeCount 1 -MaximumNodeCount 4 -Verbose +``` + +This example will update the minimum and maximum number of nodes restriction for the application. + +### Example 3 +```powershell +$resourceGroupName = "testRG" +$clusterName = "testCluster" +$appName = "testApp" +$version = "v2" +$packageUrl = "https://sftestapp.blob.core.windows.net/sftestapp/testAppType_v2.sfpkg" +New-AzServiceFabricApplicationTypeVersion -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName -Version $version -PackageUrl $packageUrl -Verbose +Update-AzServiceFabricApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationTypeVersion $version -Name $appName -ApplicationParameter @{key0="value0";key1=$null;key2="value2"} -HealthCheckStableDurationSec 0 -HealthCheckWaitDurationSec 0 -HealthCheckRetryTimeoutSec 0 -UpgradeDomainTimeoutSec 5000 -UpgradeTimeoutSec 7000 -FailureAction Rollback -UpgradeReplicaSetCheckTimeoutSec 300 -ForceRestart +``` + +This example will start an application upgrade to update the type version to "v2" and also sets some upgrade policy parameters that will take effect from the current upgrade. + +### Example 4 +```powershell +Update-AzServiceFabricApplication -ResourceGroupName $resourceGroupName -ClusterName $clusterName -Name $appName -ApplicationParameter @{key0="value0";key1=$null;key2="value2"} +``` + +This example updates the application parameters but these changes will only take effect until the next version upgrade to the application. + +## PARAMETERS + +### -ApplicationParameter +Specify the application parameters as key/value pairs. +These parameters must exist in the application manifest. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationTypeVersion +Specify the application type version + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConsiderWarningAsError +Indicates whether to treat a warning health event as an error event during health evaluation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultServiceTypeMaxPercentUnhealthyPartitionsPerService +Specifies the maximum percent of unhelthy partitions per service allowed by the health policy for the default service type to use for the monitored upgrade. + +```yaml +Type: System.Int32 +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultServiceTypeMaxPercentUnhealthyReplicasPerPartition +Specifies the maximum percent of unhelthy replicas per service allowed by the health policy for the default service type to use for the monitored upgrade. + +```yaml +Type: System.Int32 +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultServiceTypeUnhealthyServicesMaxPercent +Specifies the maximum percent of unhelthy services allowed by the health policy for the default service type to use for the monitored upgrade. + +```yaml +Type: System.Int32 +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailureAction +Specifies the action to take if the monitored upgrade fails. +The acceptable values for this parameter are Rollback or Manual. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.FailureAction +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: +Accepted values: Rollback, Manual + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceRestart +Indicates that the service host restarts even if the upgrade is a configuration-only change. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthCheckRetryTimeoutSec +Specifies the duration, in seconds, after which Service Fabric retries the health check if the previous health check fails. + +```yaml +Type: System.Int32 +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthCheckStableDurationSec +Specifies the duration, in seconds, that Service Fabric waits in order to verify that the application is stable before moving to the next upgrade domain or completing the upgrade. +This wait duration prevents undetected changes of health right after the health check is performed. + +```yaml +Type: System.Int32 +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HealthCheckWaitDurationSec +Specifies the duration, in seconds, that Service Fabric waits before it performs the initial health check after it finishes the upgrade on the upgrade domain. + +```yaml +Type: System.Int32 +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The application resource. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSApplication +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaximumNodeCount +Specifies the maximum number of nodes on which to place an application + +```yaml +Type: System.Int64 +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumNodeCount +Specifies the minimum number of nodes where Service Fabric will reserve capacity for this application + +```yaml +Type: System.Int64 +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the application + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: ApplicationName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ByResourceGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Arm ResourceId of the application. + +```yaml +Type: System.String +Parameter Sets: ByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceTypeHealthPolicyMap +Specifies the map of the health policy to use for different service types as a hash table in the following format: @ {"ServiceTypeName" : "MaxPercentUnhealthyPartitionsPerService,MaxPercentUnhealthyReplicasPerPartition,MaxPercentUnhealthyServices"}. +For example: @{ "ServiceTypeName01" = "5,10,5"; "ServiceTypeName02" = "5,5,5" } + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnhealthyDeployedApplicationsMaxPercent +Specifies the maximum percentage of the application instances deployed on the nodes in the cluster that have a health state of error before the application health state for the cluster is error. + +```yaml +Type: System.Int32 +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeDomainTimeoutSec +Specifies the maximum time, in seconds, that Service Fabric takes to upgrade a single upgrade domain. +After this period, the upgrade fails. + +```yaml +Type: System.Int32 +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeReplicaSetCheckTimeoutSec +Specifies the maximum time that Service Fabric waits for a service to reconfigure into a safe state, if not already in a safe state, before Service Fabric proceeds with the upgrade. + +```yaml +Type: System.Int32 +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeTimeoutSec +Specifies the maximum time, in seconds, that Service Fabric takes for the entire upgrade. +After this period, the upgrade fails. + +```yaml +Type: System.Int32 +Parameter Sets: ByResourceGroup, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSApplication + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSApplication + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricDurability.md b/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricDurability.md new file mode 100644 index 0000000000..48a89a9033 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricDurability.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/update-azservicefabricdurability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricDurability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricDurability.md +--- + +# Update-AzServiceFabricDurability + +## SYNOPSIS + +Update the durability tier or VmSku of a node type in the cluster. + +## SYNTAX + +``` +Update-AzServiceFabricDurability [-ResourceGroupName] <String> [-Name] <String> -NodeType <String> + -DurabilityLevel <DurabilityLevel> [-Sku <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +Use **Update-AzServiceFabricDurability** to update durability or SKU of the cluster. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzServiceFabricDurability -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -DurabilityLevel Silver -NodeType nt1 +``` + +This command changes durability tier of the NodeType 'nt1' to silver. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DurabilityLevel +Specify durability level. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.DurabilityLevel +Parameter Sets: (All) +Aliases: Level +Accepted values: Bronze, Silver, Gold + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeType +Specify Service Fabric node type name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Sku +Specify the SKU of the node type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.DurabilityLevel + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricNodeType.md b/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricNodeType.md new file mode 100644 index 0000000000..748b74446b --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricNodeType.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/update-azservicefabricnodetype +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricNodeType.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricNodeType.md +--- + +# Update-AzServiceFabricNodeType + +## SYNOPSIS +Update a node type within the cluster. + +## SYNTAX + +``` +Update-AzServiceFabricNodeType [-ResourceGroupName] <String> [-Name] <String> [-IsPrimaryNodeType <Boolean>] + -NodeType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use the **Update-AzServiceFabricNodeType** to update node type related settings. When a node type to stop acting as a +primary node type using '-IsPrimaryNodeType $false', another primary node type must already be registered within the cluster. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzServiceFabricNodeType -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -NodeType 'nt1' -IsPrimaryNodeType $false +``` + +This command will update NodeType 'nt1' to stop acting as a primary node type. It may be done after adding another primary node type, in order to migrate seed nodes and system services. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsPrimaryNodeType +Define whether the node type is a primary node type. Primary node type may have seed nodes and system services. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeType +The node type name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable<System.Boolean> + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricReliability.md b/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricReliability.md new file mode 100644 index 0000000000..b5a635de31 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricReliability.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/update-azservicefabricreliability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricReliability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricReliability.md +--- + +# Update-AzServiceFabricReliability + +## SYNOPSIS +Update the reliability tier of the primary node type in a cluster. + +## SYNTAX + +``` +Update-AzServiceFabricReliability [-ResourceGroupName] <String> [-Name] <String> + -ReliabilityLevel <ReliabilityLevel> [-AutoAddNode] [-NodeType <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Use **Update-AzServiceFabricReliability** to update reliability of the primary node type in a cluster. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzServiceFabricReliability -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -ReliabilityLevel Silver +``` + +This command changes the reliability tier of the primary node type to silver. + +### Example 2 + +Update the reliability tier of the primary node type in a cluster. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Update-AzServiceFabricReliability -AutoAddNode -Name 'Contoso01SFCluster' -ReliabilityLevel None -ResourceGroupName 'Group1' +``` + +## PARAMETERS + +### -AutoAddNode +Add node count automatically when changing reliability + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: Auto + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specify the name of the cluster + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NodeType +Specify Service Fabric node type name. This setting is only required if there are multiple primary node types. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReliabilityLevel +Reliability tier + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.ReliabilityLevel +Parameter Sets: (All) +Aliases: Level +Accepted values: None, Bronze, Silver, Gold, Platinum + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.ReliabilityLevel + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricVmImage.md b/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricVmImage.md new file mode 100644 index 0000000000..526957bf18 --- /dev/null +++ b/azps-10.1.0/Az.ServiceFabric/Update-AzServiceFabricVmImage.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.ServiceFabric.dll-Help.xml +Module Name: Az.ServiceFabric +online version: https://learn.microsoft.com/powershell/module/az.servicefabric/update-azservicefabricvmimage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricVmImage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceFabric/ServiceFabric/help/Update-AzServiceFabricVmImage.md +--- + +# Update-AzServiceFabricVmImage + +## SYNOPSIS + +Update the cluster resource vmImage setting which maps the appropriate runtime package to be delivered based on the target operating system. + +## SYNTAX + +``` +Update-AzServiceFabricVmImage [-ResourceGroupName] <String> [-Name] <String> -VmImage <VmImageKind> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION + +Use **Update-AzServiceFabricVmImage** to update the vmImage setting of the cluster, responsible for runtime package delivery. + +Important Note: VmImage 'Linux' as well as 'Ubuntu' map to the delivery of the Ubuntu 16.04 package, +so if the intent is to run Ubuntu18+, use Ubuntu18_04. + +## EXAMPLES + +### Example 1 + +```powershell +Update-AzServiceFabricVmImage -ResourceGroupName 'Group1' -ClusterName 'Contoso01SFCluster' -VmImage Ubuntu18_04 +``` + +This command changes vmImage of the of the cluster 'Contoso01SFCluster' to 'Ubuntu18_04', +for the purpose of migrating future upgrades to use the Ubuntu 18 SF runtime deb package. + +## PARAMETERS + +### -DefaultProfile + +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name + +Specify the name of the cluster, if not given it will be same as resource group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName + +Specify the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VmImage +Specify common target vmImage to be used for the cluster. + +```yaml +Type: Microsoft.Azure.Commands.ServiceFabric.Models.VmImageKind +Parameter Sets: (All) +Aliases: +Accepted values: Windows, Linux, Ubuntu, Ubuntu18_04, Ubuntu20_04 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.ServiceFabric.Models.VmImageKind + +## OUTPUTS + +### Microsoft.Azure.Commands.ServiceFabric.Models.PSDeploymentResult + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.ServiceLinker/Az.ServiceLinker.md b/azps-10.1.0/Az.ServiceLinker/Az.ServiceLinker.md new file mode 100644 index 0000000000..32baadad0c --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Az.ServiceLinker.md @@ -0,0 +1,93 @@ +--- +Module Name: Az.ServiceLinker +Module Guid: 20a4a5d9-068c-43d8-b45a-7130dd33afe4 +Download Help Link: https://learn.microsoft.com/powershell/module/az.servicelinker +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Az.ServiceLinker.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Az.ServiceLinker.md +--- + +# Az.ServiceLinker Module +## Description +Microsoft Azure PowerShell: ServiceLinker cmdlets + +## Az.ServiceLinker Cmdlets +### [Get-AzServiceLinkerConfigurationForContainerApp](Get-AzServiceLinkerConfigurationForContainerApp.md) +list source configurations for a linker in container app. + +### [Get-AzServiceLinkerConfigurationForSpringCloud](Get-AzServiceLinkerConfigurationForSpringCloud.md) +list source configurations for a linker in spring cloud. + +### [Get-AzServiceLinkerConfigurationForWebApp](Get-AzServiceLinkerConfigurationForWebApp.md) +list source configurations for a linker in webapp. + +### [Get-AzServiceLinkerConfigurationName](Get-AzServiceLinkerConfigurationName.md) +Lists the configuration names generated by Service Connector for all target, client types, auth types. + +### [Get-AzServiceLinkerForContainerApp](Get-AzServiceLinkerForContainerApp.md) +Returns Linker resource for a given name in container app. + +### [Get-AzServiceLinkerForSpringCloud](Get-AzServiceLinkerForSpringCloud.md) +Returns Linker resource for a given name in spring cloud. + +### [Get-AzServiceLinkerForWebApp](Get-AzServiceLinkerForWebApp.md) +Returns Linker resource for a given name in webapp. + +### [New-AzServiceLinkerAzureResourceObject](New-AzServiceLinkerAzureResourceObject.md) +Create an in-memory object for AzureResource. + +### [New-AzServiceLinkerConfluentBootstrapServerObject](New-AzServiceLinkerConfluentBootstrapServerObject.md) +Create an in-memory object for ConfluentBootstrapServer. + +### [New-AzServiceLinkerConfluentSchemaRegistryObject](New-AzServiceLinkerConfluentSchemaRegistryObject.md) +Create an in-memory object for ConfluentSchemaRegistry. + +### [New-AzServiceLinkerForContainerApp](New-AzServiceLinkerForContainerApp.md) +Create or update linker resource in container app. + +### [New-AzServiceLinkerForSpringCloud](New-AzServiceLinkerForSpringCloud.md) +Create or update linker resource in spring cloud. + +### [New-AzServiceLinkerForWebApp](New-AzServiceLinkerForWebApp.md) +Create or update linker resource in webapp. + +### [New-AzServiceLinkerSecretAuthInfoObject](New-AzServiceLinkerSecretAuthInfoObject.md) +Create an in-memory object for SecretAuthInfo. + +### [New-AzServiceLinkerServicePrincipalSecretAuthInfoObject](New-AzServiceLinkerServicePrincipalSecretAuthInfoObject.md) +Create an in-memory object for ServicePrincipalSecretAuthInfo. + +### [New-AzServiceLinkerSystemAssignedIdentityAuthInfoObject](New-AzServiceLinkerSystemAssignedIdentityAuthInfoObject.md) +Create an in-memory object for SystemAssignedIdentityAuthInfo. + +### [New-AzServiceLinkerUserAssignedIdentityAuthInfoObject](New-AzServiceLinkerUserAssignedIdentityAuthInfoObject.md) +Create an in-memory object for UserAssignedIdentityAuthInfo. + +### [Remove-AzServiceLinkerForContainerApp](Remove-AzServiceLinkerForContainerApp.md) +Delete a link. + +### [Remove-AzServiceLinkerForSpringCloud](Remove-AzServiceLinkerForSpringCloud.md) +Delete a link in spring cloud. + +### [Remove-AzServiceLinkerForWebApp](Remove-AzServiceLinkerForWebApp.md) +Delete a link in webapp. + +### [Test-AzServiceLinkerForContainerApp](Test-AzServiceLinkerForContainerApp.md) +Validate a link. + +### [Test-AzServiceLinkerForSpringCloud](Test-AzServiceLinkerForSpringCloud.md) +Validate a link in spring cloud. + +### [Test-AzServiceLinkerForWebApp](Test-AzServiceLinkerForWebApp.md) +Validate a link in webapp. + +### [Update-AzServiceLinkerForContainerApp](Update-AzServiceLinkerForContainerApp.md) +Operation to update an existing link in container app. + +### [Update-AzServiceLinkerForSpringCloud](Update-AzServiceLinkerForSpringCloud.md) +Operation to update an existing link in spring cloud. + +### [Update-AzServiceLinkerForWebApp](Update-AzServiceLinkerForWebApp.md) +Operation to update an existing link in webapp. + diff --git a/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerConfigurationForContainerApp.md b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerConfigurationForContainerApp.md new file mode 100644 index 0000000000..7adb435a93 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerConfigurationForContainerApp.md @@ -0,0 +1,180 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/get-azservicelinkerconfigurationforcontainerapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerConfigurationForContainerApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerConfigurationForContainerApp.md +--- + +# Get-AzServiceLinkerConfigurationForContainerApp + +## SYNOPSIS +list source configurations for a linker in container app. + +## SYNTAX + +``` +Get-AzServiceLinkerConfigurationForContainerApp -LinkerName <String> -ContainerApp <String> + -ResourceGroupName <String> [-ResourceUri <String>] [-DefaultProfile <PSObject>] [-SubscriptionId <String>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +list source configurations for a linker in container app. + +## EXAMPLES + +### Example 1: Get container app's linker configuration list +```powershell +Get-AzServiceLinkerConfigurationForContainerApp -ContainerApp servicelinker-containerapp -ResourceGroupName servicelinker-test-group -LinkerName postgresql_linker | Format-List +``` + +```output +Name : AZURE_POSTGRESQL_POSTGRESQL_NOVNET_CONNECTIONSTRING +Value : Server=test.postgres.database.azure.com;Database=testdb;Port=543 + 2;Ssl Mode=Require;User Id=testuser@test;Password=password; + +``` + +Get Linker's configuration list + +## PARAMETERS + +### -ContainerApp +The Name of container app of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkerName +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ISourceConfiguration + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerConfigurationForSpringCloud.md b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerConfigurationForSpringCloud.md new file mode 100644 index 0000000000..5763f28a28 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerConfigurationForSpringCloud.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/get-azservicelinkerconfigurationforspringcloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerConfigurationForSpringCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerConfigurationForSpringCloud.md +--- + +# Get-AzServiceLinkerConfigurationForSpringCloud + +## SYNOPSIS +list source configurations for a linker in spring cloud. + +## SYNTAX + +``` +Get-AzServiceLinkerConfigurationForSpringCloud -LinkerName <String> -AppName <String> + -ResourceGroupName <String> -ServiceName <String> [-ResourceUri <String>] [-DefaultProfile <PSObject>] + [-DeploymentName <String>] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +list source configurations for a linker in spring cloud. + +## EXAMPLES + +### Example 1: Get spring cloud's linker configuration list +```powershell +Get-AzServiceLinkerConfigurationForSpringCloud -ServiceName servicelinker-springcloud -AppName appconfiguration -ResourceGroupName servicelinker-test-group -LinkerName postgresql_linker | Format-List +``` + +```output +Name : AZURE_POSTGRESQL_POSTGRESQL_NOVNET_CONNECTIONSTRING +Value : Server=test.postgres.database.azure.com;Database=testdb;Port=543 + 2;Ssl Mode=Require;User Id=testuser@test;Password=password; + +``` + +Get Linker's configuration list + +## PARAMETERS + +### -AppName +The app Name of spring cloud service to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The deployment Name of spring cloud app to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: "default" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkerName +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The Name of spring cloud service to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ISourceConfiguration + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerConfigurationForWebApp.md b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerConfigurationForWebApp.md new file mode 100644 index 0000000000..8828470bb9 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerConfigurationForWebApp.md @@ -0,0 +1,180 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/get-azservicelinkerconfigurationforwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerConfigurationForWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerConfigurationForWebApp.md +--- + +# Get-AzServiceLinkerConfigurationForWebApp + +## SYNOPSIS +list source configurations for a linker in webapp. + +## SYNTAX + +``` +Get-AzServiceLinkerConfigurationForWebApp -LinkerName <String> -ResourceGroupName <String> -WebApp <String> + [-ResourceUri <String>] [-DefaultProfile <PSObject>] [-SubscriptionId <String>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +list source configurations for a linker in webapp. + +## EXAMPLES + +### Example 1: Get webapp's linker configuration list +```powershell +Get-AzServiceLinkerConfigurationForWebApp -WebApp servicelinker-webapp -ResourceGroupName servicelinker-test-group -LinkerName postgresql_linker | Format-List +``` + +```output +Name : AZURE_POSTGRESQL_POSTGRESQL_NOVNET_CONNECTIONSTRING +Value : Server=test.postgres.database.azure.com;Database=testdb;Port=543 + 2;Ssl Mode=Require;User Id=testuser@test;Password=password; + +``` + +Get Linker's configuration list + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkerName +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +The Name of webapp of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ISourceConfiguration + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerConfigurationName.md b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerConfigurationName.md new file mode 100644 index 0000000000..e0b10293f7 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerConfigurationName.md @@ -0,0 +1,103 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/get-azservicelinkerconfigurationname +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerConfigurationName.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerConfigurationName.md +--- + +# Get-AzServiceLinkerConfigurationName + +## SYNOPSIS +Lists the configuration names generated by Service Connector for all target, client types, auth types. + +## SYNTAX + +``` +Get-AzServiceLinkerConfigurationName [-Filter <String>] [-SkipToken <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Lists the configuration names generated by Service Connector for all target, client types, auth types. + +## EXAMPLES + +### Example 1: Get expected configuration names of difference connection +```powershell +Get-AzServiceLinkerConfigurationName +``` + +```output +systemAssignedIdentity none {Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.Config… +userAssignedIdentity none {Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.Config… +servicePrincipalSecret none {Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.Config… +secret none {Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.Config… +accessKey none {Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.Config… +``` + +Get the expected configuration names of connection with each auth type and client type. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +OData filter options. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +OData skipToken option for pagination. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.IConfigurationNameItem + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerForContainerApp.md b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerForContainerApp.md new file mode 100644 index 0000000000..74dc95d491 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerForContainerApp.md @@ -0,0 +1,264 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/get-azservicelinkerforcontainerapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerForContainerApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerForContainerApp.md +--- + +# Get-AzServiceLinkerForContainerApp + +## SYNOPSIS +Returns Linker resource for a given name in container app. + +## SYNTAX + +### List (Default) +``` +Get-AzServiceLinkerForContainerApp -ContainerApp <String> -ResourceGroupName <String> [-ResourceUri <String>] + [-DefaultProfile <PSObject>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### Get +``` +Get-AzServiceLinkerForContainerApp -Name <String> -ContainerApp <String> -ResourceGroupName <String> + [-ResourceUri <String>] [-DefaultProfile <PSObject>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzServiceLinkerForContainerApp -InputObject <IServiceLinkerIdentity> [-DefaultProfile <PSObject>] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns Linker resource for a given name in container app. + +## EXAMPLES + +### Example 1: List all linkers in a container app +```powershell +Get-AzServiceLinkerForContainerApp -ContainerApp servicelinker-app -ResourceGroupName servicelinker-test-group +``` + +```output +Name +---- +appconfig_08b18 +postgresql_novnet +postgresql_203ca +eventhub_3ab5f +``` + +List all linkers in the container app + +### Example 2: Get linker by name +```powershell +Get-AzServiceLinkerForContainerApp -ContainerApp servicelinker-app -ResourceGroupName servicelinker-test-group -Name postgresql_connection | Format-List +``` + +```output +AuthInfo : Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Model + s.Api20221101Preview.SecretAuthInfo +ClientType : dotnet +Id : /subscriptions/00000000-0000-0000-0000-000000000000/re + sourceGroups/servicelinker-test-group/providers/ + Microsoft.App/containerApps/servicelinker-app/providers + /Microsoft.ServiceLinker/linkers/postgresql_connection +Name : postgresql_connection +ProvisioningState : Succeeded +Scope : +SecretStoreKeyVaultId : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetService : Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Model + s.Api20221101Preview.AzureResource +Type : microsoft.servicelinker/linkers +VNetSolutionType : serviceEndpoint + +``` + +Get linker by name + +### Example 3: Get linker via identity object +```powershell +$identity = @{ +ResourceUri = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/servicelinker-test-linux-group/providers/Microsoft.App/containerApps/servicelinker-app' +LinkerName = 'postgresql_connection'} + +$identity | Get-AzServiceLinkerForContainerApp | Format-List +``` + +```output +AuthInfo : Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Model + s.Api20221101Preview.SecretAuthInfo +ClientType : dotnet +Id : /subscriptions/00000000-0000-0000-0000-000000000000/re + sourceGroups/servicelinker-test-group/providers/ + Microsoft.App/containerApps/servicelinker-app/providers + /Microsoft.ServiceLinker/linkers/postgresql_connection +Name : postgresql_connection +ProvisioningState : Succeeded +Scope : +SecretStoreKeyVaultId : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetService : Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Model + s.Api20221101Preview.AzureResource +Type : microsoft.servicelinker/linkers +VNetSolutionType : serviceEndpoint + +``` + +Get linker by name + +## PARAMETERS + +### -ContainerApp +The Name of container app of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: LinkerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ILinkerResource + +## 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 <IServiceLinkerIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of resource. + - `[DryrunName <String>]`: The name of dryrun. + - `[Id <String>]`: Resource identity path + - `[LinkerName <String>]`: The name Linker resource. + - `[Location <String>]`: The name of Azure region. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceUri <String>]`: The fully qualified Azure Resource manager identifier of the resource to be connected. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerForSpringCloud.md b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerForSpringCloud.md new file mode 100644 index 0000000000..35fba045e2 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerForSpringCloud.md @@ -0,0 +1,296 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/get-azservicelinkerforspringcloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerForSpringCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerForSpringCloud.md +--- + +# Get-AzServiceLinkerForSpringCloud + +## SYNOPSIS +Returns Linker resource for a given name in spring cloud. + +## SYNTAX + +### List (Default) +``` +Get-AzServiceLinkerForSpringCloud -AppName <String> -ResourceGroupName <String> -ServiceName <String> + [-ResourceUri <String>] [-DefaultProfile <PSObject>] [-DeploymentName <String>] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzServiceLinkerForSpringCloud -Name <String> -AppName <String> -ResourceGroupName <String> + -ServiceName <String> [-ResourceUri <String>] [-DefaultProfile <PSObject>] [-DeploymentName <String>] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzServiceLinkerForSpringCloud -InputObject <IServiceLinkerIdentity> [-DefaultProfile <PSObject>] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns Linker resource for a given name in spring cloud. + +## EXAMPLES + +### Example 1: List all linkers in a spring cloud app's deployment +```powershell +Get-AzServiceLinkerForSpringCloud -ServiceName servicelinker-springcloud -AppName appconfiguration -ResourceGroupName servicelinker-test-group -DeploymentName "default" +``` + +```output +Name +---- +appconfig_08b18 +postgresql_novnet +postgresql_203ca +eventhub_3ab5f +``` + +List all linkers in a spring cloud app's deployment + +### Example 2: Get linker by name +```powershell +Get-AzServiceLinkerForSpringCloud -ServiceName servicelinker-springcloud -AppName appconfiguration -DeploymentName "default" -ResourceGroupName servicelinker-test-group -Name postgresql_connection | Format-List +``` + +```output +AuthInfo : Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Model + s.Api20221101Preview.SecretAuthInfo +ClientType : dotnet +Id : /subscriptions/00000000-0000-0000-0000-000000000000/re + sourceGroups/servicelinker-test-group/providers/ + Microsoft.AppPlatform/Spring/servicelinker-springcloud/apps/appconfiguration/deployments/default/providers + /Microsoft.ServiceLinker/linkers/postgresql_connection +Name : postgresql_connection +ProvisioningState : Succeeded +Scope : +SecretStoreKeyVaultId : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetService : Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Model + s.Api20221101Preview.AzureResource +Type : microsoft.servicelinker/linkers +VNetSolutionType : serviceEndpoint + +``` + +Get linker by name + +### Example 3: Get linker via identity object +```powershell +$identity = @{ +ResourceUri = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/servicelinker-test-linux-group/providers/Microsoft.AppPlatform/Spring/servicelinker-springcloud/apps/appconfiguration/deployments/default' +LinkerName = 'postgresql_connection'} + +$identity | Get-AzServiceLinkerForSpringCloud | Format-List +``` + +```output +AuthInfo : Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Model + s.Api20221101Preview.SecretAuthInfo +ClientType : dotnet +Id : /subscriptions/00000000-0000-0000-0000-000000000000/re + sourceGroups/servicelinker-test-group/providers/ + Microsoft.AppPlatform/Spring/servicelinker-springcloud/apps/appconfiguration/deployments/default/providers + /Microsoft.ServiceLinker/linkers/postgresql_connection +Name : postgresql_connection +ProvisioningState : Succeeded +Scope : +SecretStoreKeyVaultId : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetService : Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Model + s.Api20221101Preview.AzureResource +Type : microsoft.servicelinker/linkers +VNetSolutionType : serviceEndpoint + +``` + +Get linker by name + +## PARAMETERS + +### -AppName +The app Name of spring cloud service to be connected. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The deployment Name of spring cloud app to be connected. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: "default" +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.ServiceLinker.Models.IServiceLinkerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: LinkerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The Name of spring cloud service to be connected. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ILinkerResource + +## 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 <IServiceLinkerIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of resource. + - `[DryrunName <String>]`: The name of dryrun. + - `[Id <String>]`: Resource identity path + - `[LinkerName <String>]`: The name Linker resource. + - `[Location <String>]`: The name of Azure region. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceUri <String>]`: The fully qualified Azure Resource manager identifier of the resource to be connected. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerForWebApp.md b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerForWebApp.md new file mode 100644 index 0000000000..7763aea8e9 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Get-AzServiceLinkerForWebApp.md @@ -0,0 +1,264 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/get-azservicelinkerforwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerForWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Get-AzServiceLinkerForWebApp.md +--- + +# Get-AzServiceLinkerForWebApp + +## SYNOPSIS +Returns Linker resource for a given name in webapp. + +## SYNTAX + +### List (Default) +``` +Get-AzServiceLinkerForWebApp -ResourceGroupName <String> -WebApp <String> [-ResourceUri <String>] + [-DefaultProfile <PSObject>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### Get +``` +Get-AzServiceLinkerForWebApp -Name <String> -ResourceGroupName <String> -WebApp <String> + [-ResourceUri <String>] [-DefaultProfile <PSObject>] [-SubscriptionId <String>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzServiceLinkerForWebApp -InputObject <IServiceLinkerIdentity> [-DefaultProfile <PSObject>] + [-SubscriptionId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns Linker resource for a given name in webapp. + +## EXAMPLES + +### Example 1: List all linkers in a webapp +```powershell +Get-AzServiceLinkerForWebApp -WebApp servicelinker-webapp -ResourceGroupName servicelinker-test-group +``` + +```output +Name +---- +appconfig_08b18 +postgresql_novnet +postgresql_203ca +eventhub_3ab5f +``` + +List all linkers in the webapp + +### Example 2: Get linker by name +```powershell +Get-AzServiceLinkerForWebApp -WebApp servicelinker-webapp -ResourceGroupName servicelinker-test-group -Name postgresql_connection | Format-List +``` + +```output +AuthInfo : Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Model + s.Api20221101Preview.SecretAuthInfo +ClientType : dotnet +Id : /subscriptions/00000000-0000-0000-0000-000000000000/re + sourceGroups/servicelinker-test-group/providers/ + Microsoft.Web/sites/servicelinker-webapp/providers + /Microsoft.ServiceLinker/linkers/postgresql_connection +Name : postgresql_connection +ProvisioningState : Succeeded +Scope : +SecretStoreKeyVaultId : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetService : Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Model + s.Api20221101Preview.AzureResource +Type : microsoft.servicelinker/linkers +VNetSolutionType : serviceEndpoint + +``` + +Get linker by name + +### Example 3: Get linker via identity object +```powershell +$identity = @{ +ResourceUri = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/servicelinker-test-linux-group/providers/Microsoft.Web/sites/servicelinker-webapp' +LinkerName = 'postgresql_connection'} + +$identity | Get-AzServiceLinkerForWebApp | Format-List +``` + +```output +AuthInfo : Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Model + s.Api20221101Preview.SecretAuthInfo +ClientType : dotnet +Id : /subscriptions/00000000-0000-0000-0000-000000000000/re + sourceGroups/servicelinker-test-group/providers/ + Microsoft.Web/sites/servicelinker-webapp/providers + /Microsoft.ServiceLinker/linkers/postgresql_connection +Name : postgresql_connection +ProvisioningState : Succeeded +Scope : +SecretStoreKeyVaultId : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +TargetService : Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Model + s.Api20221101Preview.AzureResource +Type : microsoft.servicelinker/linkers +VNetSolutionType : serviceEndpoint + +``` + +Get linker by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: LinkerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +The Name of webapp of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ILinkerResource + +## 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 <IServiceLinkerIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of resource. + - `[DryrunName <String>]`: The name of dryrun. + - `[Id <String>]`: Resource identity path + - `[LinkerName <String>]`: The name Linker resource. + - `[Location <String>]`: The name of Azure region. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceUri <String>]`: The fully qualified Azure Resource manager identifier of the resource to be connected. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerAzureResourceObject.md b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerAzureResourceObject.md new file mode 100644 index 0000000000..c465c6ec60 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerAzureResourceObject.md @@ -0,0 +1,88 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.ServiceLinker/new-azservicelinkerazureresourceobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerAzureResourceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerAzureResourceObject.md +--- + +# New-AzServiceLinkerAzureResourceObject + +## SYNOPSIS +Create an in-memory object for AzureResource. + +## SYNTAX + +``` +New-AzServiceLinkerAzureResourceObject -Id <String> [-ConnectAsKubernetesCsiDriver <Boolean>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AzureResource. + +## EXAMPLES + +### Example 1: Create an target resource object for azure resource +```powershell +New-AzServiceLinkerAzureResourceObject -Id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/servicelinker-test-group/providers/Microsoft.KeyVault/vaults/servicelinker-test-kv -ConnectAsKubernetesCsiDriver 1 +``` + +```output +Id +-- +/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/servicelinker-test-… + +``` + +Create an AzureResourceObject as the param of `-TargetService` + +## PARAMETERS + +### -ConnectAsKubernetesCsiDriver +True if connect via Kubernetes CSI Driver. +Source must be AKS and target must be KeyVault. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The Id of azure resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.AzureResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerConfluentBootstrapServerObject.md b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerConfluentBootstrapServerObject.md new file mode 100644 index 0000000000..0bb11929a8 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerConfluentBootstrapServerObject.md @@ -0,0 +1,70 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.ServiceLinker/new-azservicelinkerconfluentbootstrapserverobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerConfluentBootstrapServerObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerConfluentBootstrapServerObject.md +--- + +# New-AzServiceLinkerConfluentBootstrapServerObject + +## SYNOPSIS +Create an in-memory object for ConfluentBootstrapServer. + +## SYNTAX + +``` +New-AzServiceLinkerConfluentBootstrapServerObject -Endpoint <String> [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ConfluentBootstrapServer. + +## EXAMPLES + +### Example 1: Create an target resource object for Kafka server on Confluent cloud +```powershell +New-AzServiceLinkerConfluentBootstrapServerObject -Endpoint "pkc-xxxx.eastus.azure.confluent.cloud:9092" +``` + +```output +Endpoint +-------- +pkc-xxxx.eastus.azure.confluent.cloud:9092 +``` + +Create an target resource object for Kafka server on Confluent cloud + +## PARAMETERS + +### -Endpoint +The endpoint of service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ConfluentBootstrapServer + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerConfluentSchemaRegistryObject.md b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerConfluentSchemaRegistryObject.md new file mode 100644 index 0000000000..c6ddb75bb2 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerConfluentSchemaRegistryObject.md @@ -0,0 +1,70 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.ServiceLinker/new-azservicelinkerconfluentschemaregistryobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerConfluentSchemaRegistryObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerConfluentSchemaRegistryObject.md +--- + +# New-AzServiceLinkerConfluentSchemaRegistryObject + +## SYNOPSIS +Create an in-memory object for ConfluentSchemaRegistry. + +## SYNTAX + +``` +New-AzServiceLinkerConfluentSchemaRegistryObject -Endpoint <String> [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ConfluentSchemaRegistry. + +## EXAMPLES + +### Example 1: Create an target resource object for schema registry on confluent cloud +```powershell +New-AzServiceLinkerConfluentSchemaRegistryObject -Endpoint "https://psrc-xxxx.westus2.azure.confluent.cloud" +``` + +```output +Endpoint +-------- +https://psrc-xxxx.westus2.azure.confluent.cloud +``` + +Create an target resource object for schema registry on confluent cloud + +## PARAMETERS + +### -Endpoint +The endpoint of service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ConfluentSchemaRegistry + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerForContainerApp.md b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerForContainerApp.md new file mode 100644 index 0000000000..dae229c57b --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerForContainerApp.md @@ -0,0 +1,454 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/new-azservicelinkerforcontainerapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerForContainerApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerForContainerApp.md +--- + +# New-AzServiceLinkerForContainerApp + +## SYNOPSIS +Create or update linker resource in container app. + +## SYNTAX + +``` +New-AzServiceLinkerForContainerApp -AuthInfo <IAuthInfoBase> -TargetService <ITargetServiceBase> + -ContainerApp <String> -ResourceGroupName <String> [-Name <String>] [-ResourceUri <String>] + [-ClientType <ClientType>] [-ConfigurationInfoAction <ActionType>] + [-ConfigurationInfoAdditionalConfiguration <Hashtable>] [-ConfigurationInfoCustomizedKey <Hashtable>] + [-FirewallRuleAzureService <AllowType>] [-FirewallRuleCallerClientIP <AllowType>] + [-FirewallRuleIPRange <String[]>] [-PublicNetworkSolutionAction <ActionType>] [-Scope <String>] + [-SecretStoreKeyVaultId <String>] [-SecretStoreKeyVaultSecretName <String>] + [-VNetSolutionType <VNetSolutionType>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update linker resource in container app. + +## EXAMPLES + +### Example 1: Create service linker between container app and postgresql +```powershell +$target=New-AzServiceLinkerAzureResourceObject -Id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/servicelinker-test-group/providers/Microsoft.DBforPostgreSQL/servers/servicelinker-postgresql/databases/test + +$authInfo=New-AzServiceLinkerSecretAuthInfoObject -Name testUser -SecretValue *** + +New-AzServiceLinkerForContainerApp -TargetService $target -AuthInfo $auth -ClientType dotnet -LinkerName testLinker -ContainerApp servicelinker-app -ResourceGroupName servicelinker-test-linux-group -Scope 'simple-hello-world-container' +``` + +```output +Name +---- +testLinker +``` + +Create service linker between Container AppName and postgresql + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthInfo +The authentication type. +To construct, see NOTES section for AUTHINFO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.IAuthInfoBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientType +The application client type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.ClientType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: "none" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationInfoAction +Optional, indicate whether to apply configurations on source application. +If enable, generate configurations and applied to the source application. +Default is enable. +If optOut, no configuration change will be made on source. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.ActionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationInfoAdditionalConfiguration +A dictionary of additional configurations to be added. +Service will auto generate a set of basic configurations and this property is to full fill more customized configurations + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationInfoCustomizedKey +Optional. +A dictionary of default key name and customized key name mapping. +If not specified, default key name will be used for generate configurations + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerApp +The Name of container app of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleAzureService +Allow Azure services to access the target service if true. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.AllowType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleCallerClientIP +Allow caller client IP to access the target service if true. +the property is used when connecting local application to target service. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.AllowType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleIPRange +This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LinkerName + +Required: False +Position: Named +Default value: "connect_"+(-join ((65..90) + (97..122) | Get-Random -Count 5 | % {[char]$_})) +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkSolutionAction +Optional. +Indicates public network solution. +If enable, enable public network access of target service with best try. +Default is enable. +If optOut, opt out public network access configuration. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.ActionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +[ResourceGroupCompleter] +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +connection scope in source service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretStoreKeyVaultId +The key vault id to store secret + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretStoreKeyVaultSecretName +The key vault secret name to store secret, only valid when storing one secret + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetService +The target service properties +To construct, see NOTES section for TARGETSERVICE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ITargetServiceBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VNetSolutionType +Type of VNet solution. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.VNetSolutionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ILinkerResource + +## 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. + + +`AUTHINFO <IAuthInfoBase>`: The authentication type. + - `AuthType <AuthType>`: The authentication type. + +`TARGETSERVICE <ITargetServiceBase>`: The target service properties + - `Type <TargetServiceType>`: The target service type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerForSpringCloud.md b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerForSpringCloud.md new file mode 100644 index 0000000000..998dda7cc5 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerForSpringCloud.md @@ -0,0 +1,486 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/new-azservicelinkerforspringcloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerForSpringCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerForSpringCloud.md +--- + +# New-AzServiceLinkerForSpringCloud + +## SYNOPSIS +Create or update linker resource in spring cloud. + +## SYNTAX + +``` +New-AzServiceLinkerForSpringCloud -AuthInfo <IAuthInfoBase> -TargetService <ITargetServiceBase> + -AppName <String> -ResourceGroupName <String> -ServiceName <String> [-Name <String>] [-ResourceUri <String>] + [-ClientType <ClientType>] [-ConfigurationInfoAction <ActionType>] + [-ConfigurationInfoAdditionalConfiguration <Hashtable>] [-ConfigurationInfoCustomizedKey <Hashtable>] + [-FirewallRuleAzureService <AllowType>] [-FirewallRuleCallerClientIP <AllowType>] + [-FirewallRuleIPRange <String[]>] [-PublicNetworkSolutionAction <ActionType>] [-Scope <String>] + [-SecretStoreKeyVaultId <String>] [-SecretStoreKeyVaultSecretName <String>] + [-VNetSolutionType <VNetSolutionType>] [-DefaultProfile <PSObject>] [-AsJob] [-DeploymentName <String>] + [-NoWait] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update linker resource in spring cloud. + +## EXAMPLES + +### Example 1: Create service linker between spring cloud app and postgresql +```powershell +$target=New-AzServiceLinkerAzureResourceObject -Id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/servicelinker-test-group/providers/Microsoft.DBforPostgreSQL/servers/servicelinker-postgresql/databases/test + +$authInfo=New-AzServiceLinkerSecretAuthInfoObject -Name testUser -SecretValue *** + +New-AzServiceLinkerForSpringCloud -TargetService $target -AuthInfo $auth -ClientType dotnet -LinkerName testLinker -ServiceName servicelinker-springcloud -AppName appconfiguration -DeploymentName "default" -ResourceGroupName servicelinker-test-group + + +``` + +```output +Name +---- +testLinker +``` + +Create service linker between spring cloud app and postgresql + +## PARAMETERS + +### -AppName +The app Name of spring cloud service to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthInfo +The authentication type. +To construct, see NOTES section for AUTHINFO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.IAuthInfoBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientType +The application client type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.ClientType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: "none" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationInfoAction +Optional, indicate whether to apply configurations on source application. +If enable, generate configurations and applied to the source application. +Default is enable. +If optOut, no configuration change will be made on source. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.ActionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationInfoAdditionalConfiguration +A dictionary of additional configurations to be added. +Service will auto generate a set of basic configurations and this property is to full fill more customized configurations + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationInfoCustomizedKey +Optional. +A dictionary of default key name and customized key name mapping. +If not specified, default key name will be used for generate configurations + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The deployment Name of spring cloud app to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: "default" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleAzureService +Allow Azure services to access the target service if true. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.AllowType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleCallerClientIP +Allow caller client IP to access the target service if true. +the property is used when connecting local application to target service. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.AllowType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleIPRange +This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LinkerName + +Required: False +Position: Named +Default value: "connect_"+(-join ((65..90) + (97..122) | Get-Random -Count 5 | % {[char]$_})) +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkSolutionAction +Optional. +Indicates public network solution. +If enable, enable public network access of target service with best try. +Default is enable. +If optOut, opt out public network access configuration. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.ActionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +[ResourceGroupCompleter] +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +connection scope in source service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretStoreKeyVaultId +The key vault id to store secret + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretStoreKeyVaultSecretName +The key vault secret name to store secret, only valid when storing one secret + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The Name of spring cloud service to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetService +The target service properties +To construct, see NOTES section for TARGETSERVICE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ITargetServiceBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VNetSolutionType +Type of VNet solution. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.VNetSolutionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ILinkerResource + +## 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. + + +`AUTHINFO <IAuthInfoBase>`: The authentication type. + - `AuthType <AuthType>`: The authentication type. + +`TARGETSERVICE <ITargetServiceBase>`: The target service properties + - `Type <TargetServiceType>`: The target service type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerForWebApp.md b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerForWebApp.md new file mode 100644 index 0000000000..4b97ad096f --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerForWebApp.md @@ -0,0 +1,455 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/new-azservicelinkerforwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerForWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerForWebApp.md +--- + +# New-AzServiceLinkerForWebApp + +## SYNOPSIS +Create or update linker resource in webapp. + +## SYNTAX + +``` +New-AzServiceLinkerForWebApp -AuthInfo <IAuthInfoBase> -TargetService <ITargetServiceBase> + -ResourceGroupName <String> -WebApp <String> [-Name <String>] [-ResourceUri <String>] + [-ClientType <ClientType>] [-ConfigurationInfoAction <ActionType>] + [-ConfigurationInfoAdditionalConfiguration <Hashtable>] [-ConfigurationInfoCustomizedKey <Hashtable>] + [-FirewallRuleAzureService <AllowType>] [-FirewallRuleCallerClientIP <AllowType>] + [-FirewallRuleIPRange <String[]>] [-PublicNetworkSolutionAction <ActionType>] [-Scope <String>] + [-SecretStoreKeyVaultId <String>] [-SecretStoreKeyVaultSecretName <String>] + [-VNetSolutionType <VNetSolutionType>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update linker resource in webapp. + +## EXAMPLES + +### Example 1: Create service linker between webapp and postgresql +```powershell +$target=New-AzServiceLinkerAzureResourceObject -Id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/servicelinker-test-group/providers/Microsoft.DBforPostgreSQL/servers/servicelinker-postgresql/databases/test + +$authInfo=New-AzServiceLinkerSecretAuthInfoObject -Name testUser -SecretValue *** + +New-AzServiceLinkerForWebApp -TargetService $target -AuthInfo $auth -ClientType dotnet -LinkerName testLinker -WebApp servicelinker-app -ResourceGroupName servicelinker-test-group +``` + +```output +Name +---- +testLinker +``` + +Create service linker between webapp and postgresql + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthInfo +The authentication type. +To construct, see NOTES section for AUTHINFO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.IAuthInfoBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientType +The application client type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.ClientType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: "none" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationInfoAction +Optional, indicate whether to apply configurations on source application. +If enable, generate configurations and applied to the source application. +Default is enable. +If optOut, no configuration change will be made on source. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.ActionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationInfoAdditionalConfiguration +A dictionary of additional configurations to be added. +Service will auto generate a set of basic configurations and this property is to full fill more customized configurations + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationInfoCustomizedKey +Optional. +A dictionary of default key name and customized key name mapping. +If not specified, default key name will be used for generate configurations + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleAzureService +Allow Azure services to access the target service if true. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.AllowType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleCallerClientIP +Allow caller client IP to access the target service if true. +the property is used when connecting local application to target service. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.AllowType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleIPRange +This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LinkerName + +Required: False +Position: Named +Default value: "connect_"+(-join ((65..90) + (97..122) | Get-Random -Count 5 | % {[char]$_})) +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkSolutionAction +Optional. +Indicates public network solution. +If enable, enable public network access of target service with best try. +Default is enable. +If optOut, opt out public network access configuration. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.ActionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +[ResourceGroupCompleter] +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +connection scope in source service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretStoreKeyVaultId +The key vault id to store secret + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretStoreKeyVaultSecretName +The key vault secret name to store secret, only valid when storing one secret + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetService +The target service properties +To construct, see NOTES section for TARGETSERVICE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ITargetServiceBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VNetSolutionType +Type of VNet solution. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.VNetSolutionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +[ResourceNameCompleter("Microsoft.Web/sites", nameof(ResourceGroupName))] +The Name of webapp of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ILinkerResource + +## 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. + + +`AUTHINFO <IAuthInfoBase>`: The authentication type. + - `AuthType <AuthType>`: The authentication type. + +`TARGETSERVICE <ITargetServiceBase>`: The target service properties + - `Type <TargetServiceType>`: The target service type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerSecretAuthInfoObject.md b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerSecretAuthInfoObject.md new file mode 100644 index 0000000000..5fa336c0a3 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerSecretAuthInfoObject.md @@ -0,0 +1,143 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.ServiceLinker/new-azservicelinkersecretauthinfoobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerSecretAuthInfoObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerSecretAuthInfoObject.md +--- + +# New-AzServiceLinkerSecretAuthInfoObject + +## SYNOPSIS +Create an in-memory object for SecretAuthInfo. + +## SYNTAX + +``` +New-AzServiceLinkerSecretAuthInfoObject [-Name <String>] [-SecretKeyVaultUri <String>] + [-SecretNameInKeyVault <String>] [-SecretValue <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SecretAuthInfo. + +## EXAMPLES + +### Example 1: Create Secret Auth info with raw value +```powershell +New-AzServiceLinkerSecretAuthInfoObject -Name user -SecretValue password +``` + +```output +AuthType Name +-------- ---- +secret user +``` + +Create Secret Auth info with raw value + +### Example 2: Create Secret Auth info with keyvault secret uri +```powershell +New-AzServiceLinkerSecretAuthInfoObject -Name user -SecretKeyVaultUri "https://servicelinker-kv-ref.vault.azure.net/secrets/test-secret/cc5d8095a54f4755b342f4e7884b5c84" +``` + +```output +AuthType Name +-------- ---- +secret user +``` + +Create Secret Auth info with keyvault secret uri + +### Example 3: Create Secret Auth info with keyvault secret reference(It's for AKS only and `-SecretStoreVaultId` must be set at the same time when creating linker) +```powershell +New-AzServiceLinkerSecretAuthInfoObject -Name user -SecretNameInKeyVault test-secret +``` + +```output +AuthType Name +-------- ---- +secret user +``` + +Create Secret Auth info with keyvault secret reference +It's for AKS only and `-SecretStoreVaultId` must be set at the same time when creating linker + +## PARAMETERS + +### -Name +Username or account name for secret auth. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretKeyVaultUri +The Key Vault Uri of secret. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretNameInKeyVault +The name of secret in keyvault refenced by -SecretStoreKeyVaultId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretValue +Raw value of secret. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.SecretAuthInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerServicePrincipalSecretAuthInfoObject.md b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerServicePrincipalSecretAuthInfoObject.md new file mode 100644 index 0000000000..ec0a2f1b63 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerServicePrincipalSecretAuthInfoObject.md @@ -0,0 +1,103 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.ServiceLinker/new-azservicelinkerserviceprincipalsecretauthinfoobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerServicePrincipalSecretAuthInfoObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerServicePrincipalSecretAuthInfoObject.md +--- + +# New-AzServiceLinkerServicePrincipalSecretAuthInfoObject + +## SYNOPSIS +Create an in-memory object for ServicePrincipalSecretAuthInfo. + +## SYNTAX + +``` +New-AzServiceLinkerServicePrincipalSecretAuthInfoObject -ClientId <String> -PrincipalId <String> + -Secret <String> [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ServicePrincipalSecretAuthInfo. + +## EXAMPLES + +### Example 1: Create AuthInfo of service principal secret type +```powershell +New-AzServiceLinkerServicePrincipalSecretAuthInfoObject -ClientId 00000000-0000-0000-0000-000000000000 -PrincipalId 00000000-0000-0000-0000-000000000000 -Secret secret +``` + +```output + +AuthType ClientId PrincipalId +-------- -------- ----------- +servicePrincipalSecret 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-00… + +``` + +Create AuthInfo of service principal secret type + +## PARAMETERS + +### -ClientId +ServicePrincipal application clientId for servicePrincipal auth. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalId +Principal Id for servicePrincipal auth. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Secret +Secret for servicePrincipal auth. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ServicePrincipalSecretAuthInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerSystemAssignedIdentityAuthInfoObject.md b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerSystemAssignedIdentityAuthInfoObject.md new file mode 100644 index 0000000000..36c5ac6bc2 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerSystemAssignedIdentityAuthInfoObject.md @@ -0,0 +1,55 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.ServiceLinker/new-azservicelinkersystemassignedidentityauthinfoobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerSystemAssignedIdentityAuthInfoObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerSystemAssignedIdentityAuthInfoObject.md +--- + +# New-AzServiceLinkerSystemAssignedIdentityAuthInfoObject + +## SYNOPSIS +Create an in-memory object for SystemAssignedIdentityAuthInfo. + +## SYNTAX + +``` +New-AzServiceLinkerSystemAssignedIdentityAuthInfoObject [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SystemAssignedIdentityAuthInfo. + +## EXAMPLES + +### Example 1: Create linker's auth info with system assigned identity +```powershell +New-AzServiceLinkerSystemAssignedIdentityAuthInfoObject +``` + +```output +AuthType +-------- +systemAssignedIdentity +``` + +Create linker's auth info with system assigned identity + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.SystemAssignedIdentityAuthInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerUserAssignedIdentityAuthInfoObject.md b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerUserAssignedIdentityAuthInfoObject.md new file mode 100644 index 0000000000..7366681454 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/New-AzServiceLinkerUserAssignedIdentityAuthInfoObject.md @@ -0,0 +1,86 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.ServiceLinker/new-azservicelinkeruserassignedidentityauthinfoobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerUserAssignedIdentityAuthInfoObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/New-AzServiceLinkerUserAssignedIdentityAuthInfoObject.md +--- + +# New-AzServiceLinkerUserAssignedIdentityAuthInfoObject + +## SYNOPSIS +Create an in-memory object for UserAssignedIdentityAuthInfo. + +## SYNTAX + +``` +New-AzServiceLinkerUserAssignedIdentityAuthInfoObject [-ClientId <String>] [-SubscriptionId <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for UserAssignedIdentityAuthInfo. + +## EXAMPLES + +### Example 1: create linker's auth info with user assigned identity type +```powershell +New-AzServiceLinkerUserAssignedIdentityAuthInfoObject -ClientId 00000000-0000-0000-0000-000000000000 -SubscriptionId 00000000-0000-0000-0000-000000000000 +``` + +```output +AuthType ClientId SubscriptionId +-------- -------- -------------- +userAssignedIdentity 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-0000… +``` + +create linker's auth info with user assigned identity type + +## PARAMETERS + +### -ClientId +Client Id for userAssignedIdentity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription id for userAssignedIdentity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.UserAssignedIdentityAuthInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Remove-AzServiceLinkerForContainerApp.md b/azps-10.1.0/Az.ServiceLinker/Remove-AzServiceLinkerForContainerApp.md new file mode 100644 index 0000000000..6393802da2 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Remove-AzServiceLinkerForContainerApp.md @@ -0,0 +1,258 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/remove-azservicelinkerforcontainerapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Remove-AzServiceLinkerForContainerApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Remove-AzServiceLinkerForContainerApp.md +--- + +# Remove-AzServiceLinkerForContainerApp + +## SYNOPSIS +Delete a link. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzServiceLinkerForContainerApp -Name <String> -ContainerApp <String> -ResourceGroupName <String> + [-ResourceUri <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzServiceLinkerForContainerApp -InputObject <IServiceLinkerIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a link in container app. + +## EXAMPLES + +### Example 1: Remove linker +```powershell +Remove-AzServiceLinkerForContainerApp -ContainerApp servicelinker-app -ResourceGroupName servicelinker-test-group -Name testLinker +``` + +Remove linker + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerApp +The Name of container app of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: LinkerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceLinkerIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of resource. + - `[DryrunName <String>]`: The name of dryrun. + - `[Id <String>]`: Resource identity path + - `[LinkerName <String>]`: The name Linker resource. + - `[Location <String>]`: The name of Azure region. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceUri <String>]`: The fully qualified Azure Resource manager identifier of the resource to be connected. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Remove-AzServiceLinkerForSpringcloud.md b/azps-10.1.0/Az.ServiceLinker/Remove-AzServiceLinkerForSpringcloud.md new file mode 100644 index 0000000000..498d33d0b5 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Remove-AzServiceLinkerForSpringcloud.md @@ -0,0 +1,289 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/remove-azservicelinkerforspringcloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Remove-AzServiceLinkerForSpringcloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Remove-AzServiceLinkerForSpringcloud.md +--- + +# Remove-AzServiceLinkerForSpringCloud + +## SYNOPSIS +Delete a link in spring cloud. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzServiceLinkerForSpringCloud -Name <String> -AppName <String> -ResourceGroupName <String> + -ServiceName <String> [-ResourceUri <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-DeploymentName <String>] [-NoWait] [-PassThru] [-SubscriptionId <String>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzServiceLinkerForSpringCloud -InputObject <IServiceLinkerIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a link in spring cloud. + +## EXAMPLES + +### Example 1: Remove linker +```powershell +Remove-AzServiceLinkerForSpringCloud -ServiceName servicelinker-springcloud -AppName appconfiguration -DeploymentName "default" -ResourceGroupName servicelinker-test-group -Name testLinker +``` + +Remove linker + +## PARAMETERS + +### -AppName +The app Name of spring cloud service to be connected. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The deployment Name of spring cloud app to be connected. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: "default" +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.ServiceLinker.Models.IServiceLinkerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: LinkerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The Name of spring cloud service to be connected. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceLinkerIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of resource. + - `[DryrunName <String>]`: The name of dryrun. + - `[Id <String>]`: Resource identity path + - `[LinkerName <String>]`: The name Linker resource. + - `[Location <String>]`: The name of Azure region. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceUri <String>]`: The fully qualified Azure Resource manager identifier of the resource to be connected. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Remove-AzServiceLinkerForWebApp.md b/azps-10.1.0/Az.ServiceLinker/Remove-AzServiceLinkerForWebApp.md new file mode 100644 index 0000000000..e13c603313 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Remove-AzServiceLinkerForWebApp.md @@ -0,0 +1,258 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/remove-azservicelinkerforwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Remove-AzServiceLinkerForWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Remove-AzServiceLinkerForWebApp.md +--- + +# Remove-AzServiceLinkerForWebApp + +## SYNOPSIS +Delete a link in webapp. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzServiceLinkerForWebApp -Name <String> -ResourceGroupName <String> -WebApp <String> + [-ResourceUri <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzServiceLinkerForWebApp -InputObject <IServiceLinkerIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a link in webapp. + +## EXAMPLES + +### Example 1: Remove linker +```powershell +Remove-AzServiceLinkerForWebApp -WebApp servicelinker-app -ResourceGroupName servicelinker-test-group -Name testLinker +``` + +Remove linker + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: LinkerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +The Name of webapp of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IServiceLinkerIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of resource. + - `[DryrunName <String>]`: The name of dryrun. + - `[Id <String>]`: Resource identity path + - `[LinkerName <String>]`: The name Linker resource. + - `[Location <String>]`: The name of Azure region. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceUri <String>]`: The fully qualified Azure Resource manager identifier of the resource to be connected. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Test-AzServiceLinkerForContainerApp.md b/azps-10.1.0/Az.ServiceLinker/Test-AzServiceLinkerForContainerApp.md new file mode 100644 index 0000000000..a66686e20e --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Test-AzServiceLinkerForContainerApp.md @@ -0,0 +1,261 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/test-azservicelinkerforcontainerapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Test-AzServiceLinkerForContainerApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Test-AzServiceLinkerForContainerApp.md +--- + +# Test-AzServiceLinkerForContainerApp + +## SYNOPSIS +Validate a link. + +## SYNTAX + +### Validate (Default) +``` +Test-AzServiceLinkerForContainerApp -Name <String> -ContainerApp <String> -ResourceGroupName <String> + [-ResourceUri <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-SubscriptionId <String>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### ValidateViaIdentity +``` +Test-AzServiceLinkerForContainerApp -InputObject <IServiceLinkerIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Validate a link in container app. + +## EXAMPLES + +### Example 1: Test Linker +```powershell +Test-AzServiceLinkerForContainerApp -ContainerApp servicelinker-app -ResourceGroupName servicelinker-test-group -Name postgresql_connection | Format-List +``` + +```output +AuthType : +IsConnectionAvailable : True +LinkerName : postgresql_connection +ReportEndTimeUtc : 5/6/2022 8:32:26 AM +ReportStartTimeUtc : 5/6/2022 8:32:24 AM +ResourceId : /subscriptions/d82d7763-8e12-4f39-a7b6-496a983ec2f4/resourceGroups/servicelinke + r-test-group/providers/Microsoft.App/containerApps/servicelinker-app/providers/Mi + crosoft.ServiceLinker/linkers/postgresql_connection +SourceId : +Status : Succeeded +TargetId : /subscriptions/937bc588-a144-4083-8612-5f9ffbbddb14/resourceGroups/servicelinke + r-test-group/providers/Microsoft.Storage/storageAccounts/servicelinkersto + rage/tableServices/default +ValidationDetail : {The target existence is validated, The target service firewall is validated, + The configured values is validated} +``` + +Test Linker + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerApp +The Name of container app of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity +Parameter Sets: ValidateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: LinkerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.IValidateResult + +## 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 <IServiceLinkerIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of resource. + - `[DryrunName <String>]`: The name of dryrun. + - `[Id <String>]`: Resource identity path + - `[LinkerName <String>]`: The name Linker resource. + - `[Location <String>]`: The name of Azure region. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceUri <String>]`: The fully qualified Azure Resource manager identifier of the resource to be connected. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Test-AzServiceLinkerForSpringCloud.md b/azps-10.1.0/Az.ServiceLinker/Test-AzServiceLinkerForSpringCloud.md new file mode 100644 index 0000000000..0a7596e430 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Test-AzServiceLinkerForSpringCloud.md @@ -0,0 +1,291 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/test-azservicelinkerforspringcloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Test-AzServiceLinkerForSpringCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Test-AzServiceLinkerForSpringCloud.md +--- + +# Test-AzServiceLinkerForSpringCloud + +## SYNOPSIS +Validate a link in spring cloud. + +## SYNTAX + +### Validate (Default) +``` +Test-AzServiceLinkerForSpringCloud -Name <String> -AppName <String> -ResourceGroupName <String> + -ServiceName <String> [-ResourceUri <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-DeploymentName <String>] [-NoWait] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ValidateViaIdentity +``` +Test-AzServiceLinkerForSpringCloud -InputObject <IServiceLinkerIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Validate a link in spring cloud. + +## EXAMPLES + +### Example 1: Test Linker +```powershell +Test-AzServiceLinkerForSpringCloud -ServiceName servicelinker-springcloud -AppName appconfiguration -DeploymentName "default" -ResourceGroupName servicelinker-test-group -Name postgresql_connection | Format-List +``` + +```output +AuthType : +IsConnectionAvailable : True +LinkerName : storagetable_404e8 +ReportEndTimeUtc : 5/6/2022 8:32:26 AM +ReportStartTimeUtc : 5/6/2022 8:32:24 AM +ResourceId : /subscriptions/d82d7763-8e12-4f39-a7b6-496a983ec2f4/resourceGroups/servicelinke + r-test-group/providers/Microsoft.AppPlatform/Spring/servicelinker-springcloud/apps/appconfiguration/deployments/default/providers/Mi + crosoft.ServiceLinker/linkers/storagetable_404e8 +SourceId : +Status : Succeeded +TargetId : /subscriptions/937bc588-a144-4083-8612-5f9ffbbddb14/resourceGroups/servicelinke + r-test-linux-group/providers/Microsoft.Storage/storageAccounts/servicelinkersto + rage/tableServices/default +ValidationDetail : {The target existence is validated, The target service firewall is validated, + The configured values is validated} +``` + +Test Linker + +## PARAMETERS + +### -AppName +The app Name of spring cloud service to be connected. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The deployment Name of spring cloud app to be connected. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: True +Position: Named +Default value: "default" +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.ServiceLinker.Models.IServiceLinkerIdentity +Parameter Sets: ValidateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: LinkerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The Name of spring cloud service to be connected. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.IValidateResult + +## 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 <IServiceLinkerIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of resource. + - `[DryrunName <String>]`: The name of dryrun. + - `[Id <String>]`: Resource identity path + - `[LinkerName <String>]`: The name Linker resource. + - `[Location <String>]`: The name of Azure region. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceUri <String>]`: The fully qualified Azure Resource manager identifier of the resource to be connected. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Test-AzServiceLinkerForWebApp.md b/azps-10.1.0/Az.ServiceLinker/Test-AzServiceLinkerForWebApp.md new file mode 100644 index 0000000000..e7881c1f10 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Test-AzServiceLinkerForWebApp.md @@ -0,0 +1,261 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/test-azservicelinkerforwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Test-AzServiceLinkerForWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Test-AzServiceLinkerForWebApp.md +--- + +# Test-AzServiceLinkerForWebApp + +## SYNOPSIS +Validate a link in webapp. + +## SYNTAX + +### Validate (Default) +``` +Test-AzServiceLinkerForWebApp -Name <String> -ResourceGroupName <String> -WebApp <String> + [-ResourceUri <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-SubscriptionId <String>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### ValidateViaIdentity +``` +Test-AzServiceLinkerForWebApp -InputObject <IServiceLinkerIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Validate a link in webapp. + +## EXAMPLES + +### Example 1: Test Linker +```powershell +Test-AzServiceLinkerForWebApp -WebApp servicelinker-webapp -ResourceGroupName servicelinker-test-group -Name postgresql_connection | Format-List +``` + +```output +AuthType : +IsConnectionAvailable : True +LinkerName : postgresql_connection +ReportEndTimeUtc : 5/6/2022 8:32:26 AM +ReportStartTimeUtc : 5/6/2022 8:32:24 AM +ResourceId : /subscriptions/d82d7763-8e12-4f39-a7b6-496a983ec2f4/resourceGroups/servicelinke + r-test-group/providers/Microsoft.Web/sites/servicelinker-webapp/providers/Mi + crosoft.ServiceLinker/linkers/postgresql_connection +SourceId : +Status : Succeeded +TargetId : /subscriptions/937bc588-a144-4083-8612-5f9ffbbddb14/resourceGroups/servicelinke + r-test-group/providers/Microsoft.Storage/storageAccounts/servicelinkersto + rage/tableServices/default +ValidationDetail : {The target existence is validated, The target service firewall is validated, + The configured values is validated} +``` + +Test Linker + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity +Parameter Sets: ValidateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: LinkerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +The Name of webapp of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Validate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.IValidateResult + +## 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 <IServiceLinkerIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of resource. + - `[DryrunName <String>]`: The name of dryrun. + - `[Id <String>]`: Resource identity path + - `[LinkerName <String>]`: The name Linker resource. + - `[Location <String>]`: The name of Azure region. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceUri <String>]`: The fully qualified Azure Resource manager identifier of the resource to be connected. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Update-AzServiceLinkerForContainerApp.md b/azps-10.1.0/Az.ServiceLinker/Update-AzServiceLinkerForContainerApp.md new file mode 100644 index 0000000000..a4cb672d1b --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Update-AzServiceLinkerForContainerApp.md @@ -0,0 +1,353 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/update-azservicelinkerforcontainerapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Update-AzServiceLinkerForContainerApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Update-AzServiceLinkerForContainerApp.md +--- + +# Update-AzServiceLinkerForContainerApp + +## SYNOPSIS +Operation to update an existing link in container app. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzServiceLinkerForContainerApp -Name <String> -AuthInfo <IAuthInfoBase> -ClientType <ClientType> + -Scope <String> -TargetService <ITargetServiceBase> -ContainerApp <String> -ResourceGroupName <String> + [-ResourceUri <String>] [-SecretStoreKeyVaultId <String>] [-VNetSolutionType <VNetSolutionType>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-SubscriptionId <String>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzServiceLinkerForContainerApp -InputObject <IServiceLinkerIdentity> -AuthInfo <IAuthInfoBase> + -ClientType <ClientType> -Scope <String> -TargetService <ITargetServiceBase> + [-SecretStoreKeyVaultId <String>] [-VNetSolutionType <VNetSolutionType>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to update an existing link in container app. + +## EXAMPLES + +### Example 1: Update linker +```powershell +$target=New-AzServiceLinkerAzureResourceObject -Id /subscriptions/937bc588-a144-4083-8612-5f9ffbbddb14/resourceGroups/servicelinker-test-linux-group/providers/Microsoft.DBforPostgreSQL/servers/servicelinker-postgresql/databases/test +$authInfo=New-AzServiceLinkerSecretAuthInfoObject -Name username -SecretValue password +Update-AzServiceLinkerForContainerApp -ResourceGroupName servicelinker-test-linux-group -ContainerApp servicelinker-app -TargetService $target -AuthInfo $authInfo -ClientType 'none' -Name postgres_connection -Scope 'simple-hello-world-container' +``` + +```output +Name +---- +postgres_connection +``` + +Update linker + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthInfo +The authentication type. +To construct, see NOTES section for AUTHINFO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.IAuthInfoBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientType +The application client type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.ClientType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerApp +The Name of container app of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: LinkerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +connection scope in source service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretStoreKeyVaultId +The key vault id to store secret + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetService +The target service properties +To construct, see NOTES section for TARGETSERVICE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ITargetServiceBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VNetSolutionType +Type of VNet solution. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.VNetSolutionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ILinkerResource + +## 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. + + +`AUTHINFO <IAuthInfoBase>`: The authentication type. + - `AuthType <AuthType>`: The authentication type. + +`INPUTOBJECT <IServiceLinkerIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of resource. + - `[DryrunName <String>]`: The name of dryrun. + - `[Id <String>]`: Resource identity path + - `[LinkerName <String>]`: The name Linker resource. + - `[Location <String>]`: The name of Azure region. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceUri <String>]`: The fully qualified Azure Resource manager identifier of the resource to be connected. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`TARGETSERVICE <ITargetServiceBase>`: The target service properties + - `Type <TargetServiceType>`: The target service type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Update-AzServiceLinkerForSpringCloud.md b/azps-10.1.0/Az.ServiceLinker/Update-AzServiceLinkerForSpringCloud.md new file mode 100644 index 0000000000..4ae600bacd --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Update-AzServiceLinkerForSpringCloud.md @@ -0,0 +1,383 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/update-azservicelinkerforspringcloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Update-AzServiceLinkerForSpringCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Update-AzServiceLinkerForSpringCloud.md +--- + +# Update-AzServiceLinkerForSpringCloud + +## SYNOPSIS +Operation to update an existing link in spring cloud. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzServiceLinkerForSpringCloud -Name <String> -AuthInfo <IAuthInfoBase> -ClientType <ClientType> + -TargetService <ITargetServiceBase> -AppName <String> -ResourceGroupName <String> -ServiceName <String> + [-ResourceUri <String>] [-Scope <String>] [-SecretStoreKeyVaultId <String>] + [-VNetSolutionType <VNetSolutionType>] [-DefaultProfile <PSObject>] [-AsJob] [-DeploymentName <String>] + [-NoWait] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzServiceLinkerForSpringCloud -InputObject <IServiceLinkerIdentity> -AuthInfo <IAuthInfoBase> + -ClientType <ClientType> -TargetService <ITargetServiceBase> [-Scope <String>] + [-SecretStoreKeyVaultId <String>] [-VNetSolutionType <VNetSolutionType>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to update an existing link in spring cloud. + +## EXAMPLES + +### Example 1: Update linker +```powershell +$target=New-AzServiceLinkerAzureResourceObject -Id /subscriptions/937bc588-a144-4083-8612-5f9ffbbddb14/resourceGroups/servicelinker-test-group/providers/Microsoft.DBforPostgreSQL/servers/servicelinker-postgresql/databases/test +$authInfo=New-AzServiceLinkerSecretAuthInfoObject -Name username -SecretValue password +Update-AzServiceLinkerForSpringCloud -ServiceName servicelinker-springcloud -AppName appconfiguration -DeploymentName "default" -ResourceGroupName servicelinker-test-group -TargetService $target -AuthInfo $authInfo -ClientType 'none' -Name postgres_connection +``` + +```output +Name +---- +postgres_connection +``` + +Update linker + +## PARAMETERS + +### -AppName +The app Name of spring cloud service to be connected. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthInfo +The authentication type. +To construct, see NOTES section for AUTHINFO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.IAuthInfoBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientType +The application client type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.ClientType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +The deployment Name of spring cloud app to be connected. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: "default" +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.ServiceLinker.Models.IServiceLinkerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: LinkerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +connection scope in source service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretStoreKeyVaultId +The key vault id to store secret + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The Name of spring cloud service to be connected. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetService +The target service properties +To construct, see NOTES section for TARGETSERVICE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ITargetServiceBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VNetSolutionType +Type of VNet solution. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.VNetSolutionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ILinkerResource + +## 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. + + +`AUTHINFO <IAuthInfoBase>`: The authentication type. + - `AuthType <AuthType>`: The authentication type. + +`INPUTOBJECT <IServiceLinkerIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of resource. + - `[DryrunName <String>]`: The name of dryrun. + - `[Id <String>]`: Resource identity path + - `[LinkerName <String>]`: The name Linker resource. + - `[Location <String>]`: The name of Azure region. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceUri <String>]`: The fully qualified Azure Resource manager identifier of the resource to be connected. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`TARGETSERVICE <ITargetServiceBase>`: The target service properties + - `Type <TargetServiceType>`: The target service type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.ServiceLinker/Update-AzServiceLinkerForWebApp.md b/azps-10.1.0/Az.ServiceLinker/Update-AzServiceLinkerForWebApp.md new file mode 100644 index 0000000000..ec51fd0eb3 --- /dev/null +++ b/azps-10.1.0/Az.ServiceLinker/Update-AzServiceLinkerForWebApp.md @@ -0,0 +1,353 @@ +--- +external help file: +Module Name: Az.ServiceLinker +online version: https://learn.microsoft.com/powershell/module/az.servicelinker/update-azservicelinkerforwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Update-AzServiceLinkerForWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/help/Update-AzServiceLinkerForWebApp.md +--- + +# Update-AzServiceLinkerForWebApp + +## SYNOPSIS +Operation to update an existing link in webapp. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzServiceLinkerForWebApp -Name <String> -AuthInfo <IAuthInfoBase> -ClientType <ClientType> + -TargetService <ITargetServiceBase> -ResourceGroupName <String> -WebApp <String> [-ResourceUri <String>] + [-Scope <String>] [-SecretStoreKeyVaultId <String>] [-VNetSolutionType <VNetSolutionType>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-SubscriptionId <String>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzServiceLinkerForWebApp -InputObject <IServiceLinkerIdentity> -AuthInfo <IAuthInfoBase> + -ClientType <ClientType> -TargetService <ITargetServiceBase> [-Scope <String>] + [-SecretStoreKeyVaultId <String>] [-VNetSolutionType <VNetSolutionType>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-SubscriptionId <String>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to update an existing link in webapp. + +## EXAMPLES + +### Example 1: Update linker +```powershell +$target=New-AzServiceLinkerAzureResourceObject -Id /subscriptions/937bc588-a144-4083-8612-5f9ffbbddb14/resourceGroups/servicelinker-test-linux-group/providers/Microsoft.DBforPostgreSQL/servers/servicelinker-postgresql/databases/test +$authInfo=New-AzServiceLinkerSecretAuthInfoObject -Name username -SecretValue password +Update-AzServiceLinkerForWebApp -ResourceGroupName servicelinker-test-linux-group -WebApp servicelinker-app -TargetService $target -AuthInfo $authInfo -ClientType 'none' -Name postgres_connection +``` + +```output +Name +---- +postgres_connection +``` + +Update linker + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthInfo +The authentication type. +To construct, see NOTES section for AUTHINFO properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.IAuthInfoBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientType +The application client type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.ClientType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name Linker resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: LinkerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +connection scope in source service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretStoreKeyVaultId +The key vault id to store secret + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetService +The target service properties +To construct, see NOTES section for TARGETSERVICE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ITargetServiceBase +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VNetSolutionType +Type of VNet solution. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Support.VNetSolutionType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +The Name of webapp of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.Api20221101Preview.ILinkerResource + +## 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. + + +`AUTHINFO <IAuthInfoBase>`: The authentication type. + - `AuthType <AuthType>`: The authentication type. + +`INPUTOBJECT <IServiceLinkerIdentity>`: Identity Parameter + - `[ConnectorName <String>]`: The name of resource. + - `[DryrunName <String>]`: The name of dryrun. + - `[Id <String>]`: Resource identity path + - `[LinkerName <String>]`: The name Linker resource. + - `[Location <String>]`: The name of Azure region. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ResourceUri <String>]`: The fully qualified Azure Resource manager identifier of the resource to be connected. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`TARGETSERVICE <ITargetServiceBase>`: The target service properties + - `Type <TargetServiceType>`: The target service type. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SignalR/Az.SignalR.md b/azps-10.1.0/Az.SignalR/Az.SignalR.md new file mode 100644 index 0000000000..9f1c3c18c6 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Az.SignalR.md @@ -0,0 +1,112 @@ +--- +Module Name: Az.SignalR +Module Guid: a97e0c3e-e389-46a6-b73d-2b9bd6909bdb +Download Help Link: {{Please enter FwLink manually}} +Help Version: 0.1.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Az.SignalR.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Az.SignalR.md +--- + +# Az.SignalR Module +## Description +Cmdlets to interact with the Azure SignalR service or Web PubSub service. + +## Az.SignalR Cmdlets +### [Get-AzSignalR](Get-AzSignalR.md) +Get a specific SignalR service or all the SignalR services in a resource group or a subscription. + +### [Get-AzSignalRKey](Get-AzSignalRKey.md) +Get the access keys of a SignalR service. + +### [Get-AzSignalRUsage](Get-AzSignalRUsage.md) +Get the usage quota of a subscription. + +### [Get-AzWebPubSub](Get-AzWebPubSub.md) +Get the resource and its properties. + +### [Get-AzWebPubSubCustomCertificate](Get-AzWebPubSubCustomCertificate.md) +Get a custom certificate. + +### [Get-AzWebPubSubCustomDomain](Get-AzWebPubSubCustomDomain.md) +Get a custom domain. + +### [Get-AzWebPubSubHub](Get-AzWebPubSubHub.md) +Get a hub setting. + +### [Get-AzWebPubSubKey](Get-AzWebPubSubKey.md) +Get the access keys of the resource. + +### [Get-AzWebPubSubSku](Get-AzWebPubSubSku.md) +List all available skus of the resource. + +### [Get-AzWebPubSubUsage](Get-AzWebPubSubUsage.md) +List resource usage quotas by location. + +### [New-AzSignalR](New-AzSignalR.md) +Create a SignalR service. + +### [New-AzSignalRKey](New-AzSignalRKey.md) +Regenerate an access key for a SignalR service. + +### [New-AzWebPubSub](New-AzWebPubSub.md) +Create or update a resource. + +### [New-AzWebPubSubCustomCertificate](New-AzWebPubSubCustomCertificate.md) +Create or update a custom certificate. + +### [New-AzWebPubSubCustomDomain](New-AzWebPubSubCustomDomain.md) +Create or update a custom domain. + +### [New-AzWebPubSubEventHubEndpointObject](New-AzWebPubSubEventHubEndpointObject.md) +Create an in-memory object for EventHubEndpoint. + +### [New-AzWebPubSubEventNameFilterObject](New-AzWebPubSubEventNameFilterObject.md) +Create an in-memory object for EventNameFilter. + +### [New-AzWebPubSubHub](New-AzWebPubSubHub.md) +Create or update a hub setting. + +### [New-AzWebPubSubKey](New-AzWebPubSubKey.md) +Regenerate the access key for the resource. +PrimaryKey and SecondaryKey cannot be regenerated at the same time. + +### [Remove-AzSignalR](Remove-AzSignalR.md) +Remove a SignalR service. + +### [Remove-AzWebPubSub](Remove-AzWebPubSub.md) +Operation to delete a resource. + +### [Remove-AzWebPubSubCustomCertificate](Remove-AzWebPubSubCustomCertificate.md) +Delete a custom certificate. + +### [Remove-AzWebPubSubCustomDomain](Remove-AzWebPubSubCustomDomain.md) +Delete a custom domain. + +### [Remove-AzWebPubSubHub](Remove-AzWebPubSubHub.md) +Delete a hub setting. + +### [Restart-AzSignalR](Restart-AzSignalR.md) +Restart a SignalR service. + +### [Restart-AzWebPubSub](Restart-AzWebPubSub.md) +Operation to restart a resource. + +### [Set-AzSignalRUpstream](Set-AzSignalRUpstream.md) +Set the upstream settings of a SignalR service. + +### [Test-AzSignalRName](Test-AzSignalRName.md) +Check the availability of a name. Alias: Test-AzSignal. + +### [Test-AzWebPubSubNameAvailability](Test-AzWebPubSubNameAvailability.md) +Checks that the resource name is valid and is not already in use. + +### [Update-AzSignalR](Update-AzSignalR.md) +Update a SignalR service. + +### [Update-AzSignalRNetworkAcl](Update-AzSignalRNetworkAcl.md) +Update the Network ACL of a SignalR service. + +### [Update-AzWebPubSub](Update-AzWebPubSub.md) +Operation to update an exiting resource. + diff --git a/azps-10.1.0/Az.SignalR/Get-AzSignalR.md b/azps-10.1.0/Az.SignalR/Get-AzSignalR.md new file mode 100644 index 0000000000..289313cb7b --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Get-AzSignalR.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.SignalR.dll-Help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/get-azsignalr +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzSignalR.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzSignalR.md +--- + +# Get-AzSignalR + +## SYNOPSIS +Get a specific SignalR service or all the SignalR services in a resource group or a subscription. + +## SYNTAX + +### ListSignalRServiceParameterSet (Default) +``` +Get-AzSignalR [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceGroupParameterSet +``` +Get-AzSignalR [-ResourceGroupName <String>] [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzSignalR -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a specific SignalR service or all the SignalR services in a resource group or a subscription. + +## EXAMPLES + +### Get all SignalR services in the subscription +```powershell +Get-AzSignalR +``` + +```output +HostName Location ServerPort PublicPort ProvisioningState Version +-------- -------- ---------- ---------- ----------------- ------- +mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0 +mysignalr2.service.signalr.net eastus 5002 5001 Succeeded 1.0 +mysignalr3.service.signalr.net eastus 5002 5001 Creating 1.0 +``` + +### Get all SignalR services in a resource group +```powershell +Get-AzSignalR -ResourceGroupName myResourceGroup +``` + +```output +HostName Location ServerPort PublicPort ProvisioningState Version +-------- -------- ---------- ---------- ----------------- ------- +mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0 +mysignalr2.service.signalr.net eastus 5002 5001 Succeeded 1.0 +``` + +### Get a specific SignalR service +```powershell +Get-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 +``` + +```output +HostName Location ServerPort PublicPort ProvisioningState Version +-------- -------- ---------- ---------- ----------------- ------- +mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0 +``` + +### Get a specific SignalR service from the default resource group +```powershell +Get-AzSignalR -Name mysignalr2 +``` + +```output +HostName Location ServerPort PublicPort ProvisioningState Version +-------- -------- ---------- ---------- ----------------- ------- +mysignalr2.service.signalr.net eastus 5002 5001 Succeeded 1.0 +``` + +The default resource group can be set by \`Set-AzDefault -ResourceGroupName myResourceGroup\`. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +SignalR service name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ListSignalRServiceParameterSet, ResourceGroupParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The SignalR service resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Get-AzSignalRKey.md b/azps-10.1.0/Az.SignalR/Get-AzSignalRKey.md new file mode 100644 index 0000000000..e55126e9fb --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Get-AzSignalRKey.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.SignalR.dll-Help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/get-azsignalrkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzSignalRKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzSignalRKey.md +--- + +# Get-AzSignalRKey + +## SYNOPSIS +Get the access keys of a SignalR service. + +## SYNTAX + +### ResourceGroupParameterSet (Default) +``` +Get-AzSignalRKey [-ResourceGroupName <String>] [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzSignalRKey -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Get-AzSignalRKey -InputObject <PSSignalRResource> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the access keys of a SignalR service. + +## EXAMPLES + +### Get access keys of a specific SignalR service +```powershell +Get-AzSignalRKey -ResourceGroupName myResourceGroup -Name mysignalr1 +``` + +```output +Name : mysignalr1 +PrimaryKey : vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmOQNt77PovDs= +PrimaryConnectionString : Endpoint=https://mysignalr1.service.signalr.net;AccessKey=vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmO + QNt77PovDs=; +SecondaryKey : 2+HkuxAA34xiZFFiDsVM0uDyzCsg6GKsdXSjN4C/YFQ= +SecondaryConnectionString : Endpoint=https://mysignalr1.service.signalr.net;AccessKey=2+HkuxAA34xiZFFiDsVM0uDyzCsg6GKsd + XSjN4C/YFQ=; +``` + +### Get access keys from a SignalR service object in pipe + +```powershell +Get-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 | Get-AzSignalRKey +``` + +```output +Name : mysignalr1 +PrimaryKey : vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmOQNt77PovDs= +PrimaryConnectionString : Endpoint=https://mysignalr1.service.signalr.net;AccessKey=vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmO + QNt77PovDs=; +SecondaryKey : 2+HkuxAA34xiZFFiDsVM0uDyzCsg6GKsdXSjN4C/YFQ= +SecondaryConnectionString : Endpoint=https://mysignalr1.service.signalr.net;AccessKey=2+HkuxAA34xiZFFiDsVM0uDyzCsg6GKsd + XSjN4C/YFQ=; +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The SignalR resource object. + +```yaml +Type: Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +SignalR service name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The SignalR service resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource + +## OUTPUTS + +### Microsoft.Azure.Commands.SignalR.Models.PSSignalRKeys + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Get-AzSignalRUsage.md b/azps-10.1.0/Az.SignalR/Get-AzSignalRUsage.md new file mode 100644 index 0000000000..eb4923df79 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Get-AzSignalRUsage.md @@ -0,0 +1,83 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.SignalR.dll-Help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/get-azsignalrusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzSignalRUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzSignalRUsage.md +--- + +# Get-AzSignalRUsage + +## SYNOPSIS +Get the usage quota of a subscription. + +## SYNTAX + +``` +Get-AzSignalRUsage [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the usage quota of a subscription. + +## EXAMPLES + +### Get the usage quota by inputting the location +```powershell +Get-AzSignalRUsage eastus +``` + +```output +Name CurrentValue Limit +---- ------------ ----- +FreeTierInstances 2 5 +SignalRTotalUnits 3 300 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The SignalR service location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.SignalR.Models.PSSignalRUsage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Get-AzWebPubSub.md b/azps-10.1.0/Az.SignalR/Get-AzWebPubSub.md new file mode 100644 index 0000000000..e2de0af590 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Get-AzWebPubSub.md @@ -0,0 +1,206 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/get-azwebpubsub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSub.md +--- + +# Get-AzWebPubSub + +## SYNOPSIS +Get the resource and its properties. + +## SYNTAX + +### List (Default) +``` +Get-AzWebPubSub [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWebPubSub -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzWebPubSub -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWebPubSub -InputObject <IWebPubSubIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the resource and its properties. + +## EXAMPLES + +### Example 1: List all Web PubSub resources in a subscription +```powershell +Get-AzWebPubSub -SubscriptionId ef72249e-9785-4799-a76b-7cdd80e1b1d0 +``` + +```output +Name Location SkuName +---- -------- ------- +demo1 eastus Standard_S1 +demo2 eastus Free_F1 +``` + +### Example 2: List all Web PubSub resources in a resource group +```powershell +Get-AzWebPubSub -ResourceGroupName psdemo +``` + +```output +Name Location SkuName +---- -------- ------- +psdemo-wps eastus Standard_S1 +``` + +### Example 3: Get a specific Web PubSub resource +```powershell +Get-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps +``` + +```output +Name Location SkuName +---- -------- ------- +psdemo-wps eastus Standard_S1 +``` + +### Example 4: Get a specific Web PubSub resource via identity object +```powershell +$identity = @{ ResourceGroupName = 'psdemo' +ResourceName = 'psdemo-wps' +SubscriptionId = $(Get-AzContext).Subscription.Id } + +$identity | Get-AzWebPubSub +``` + +```output +Name Location SkuName +---- -------- ------- +psdemo-wps eastus Standard_S1 +``` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IWebPubSubResource + +## 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 <IWebPubSubIdentity>`: Identity Parameter + - `[CertificateName <String>]`: Custom certificate name + - `[HubName <String>]`: The hub name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[Name <String>]`: Custom domain name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ResourceName <String>]`: The name of the resource. + - `[SharedPrivateLinkResourceName <String>]`: The name of the shared private link resource + - `[SubscriptionId <String>]`: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Get-AzWebPubSubCustomCertificate.md b/azps-10.1.0/Az.SignalR/Get-AzWebPubSubCustomCertificate.md new file mode 100644 index 0000000000..b6313b6ad8 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Get-AzWebPubSubCustomCertificate.md @@ -0,0 +1,204 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/get-azwebpubsubcustomcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSubCustomCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSubCustomCertificate.md +--- + +# Get-AzWebPubSubCustomCertificate + +## SYNOPSIS +Get a custom certificate. + +## SYNTAX + +### List (Default) +``` +Get-AzWebPubSubCustomCertificate -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWebPubSubCustomCertificate -Name <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWebPubSubCustomCertificate -InputObject <IWebPubSubIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a custom certificate. + +## EXAMPLES + +### Example 1: List all the custom certificates of a Azure Web PubSub resource +```powershell +Get-AzWebPubSubCustomCertificate -ResourceGroupName rg -ResourceName wps +``` + +```output +Name KeyVaultBaseUri KeyVaultSecretName KeyVaultSecretVersion ProvisioningState +---- --------------- ------------------ --------------------- ----------------- +mycustomcert https://kvcustomcertificatetest.vault.azure.net/ manual-test Succeeded +``` + +We can see this Web PubSub resource only contains one custom certificate. + +### Example 2: Get a custom certificate by its name +```powershell +Get-AzWebPubSubCustomCertificate -ResourceGroupName rg -ResourceName wps -Name mycustomcert +``` + +```output +Name KeyVaultBaseUri KeyVaultSecretName KeyVaultSecretVersion ProvisioningState +---- --------------- ------------------ --------------------- ----------------- +mycustomcert https://kvcustomcertificatetest.vault.azure.net/ manual-test Succeeded +``` + +### Example 3: Get a custom certificate by its identity +```powershell +$customCert = Get-AzWebPubSubCustomCertificate -ResourceGroupName rg -ResourceName wps -Name mycustomcert +$customCert | Get-AzWebPubSubCustomCertificate +``` + +```output +Name KeyVaultBaseUri KeyVaultSecretName KeyVaultSecretVersion ProvisioningState +---- --------------- ------------------ --------------------- ----------------- +mycustomcert https://kvcustomcertificatetest.vault.azure.net/ manual-test Succeeded +``` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Custom certificate name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.ICustomCertificate + +## 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 <IWebPubSubIdentity>`: Identity Parameter + - `[CertificateName <String>]`: Custom certificate name + - `[HubName <String>]`: The hub name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[Name <String>]`: Custom domain name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ResourceName <String>]`: The name of the resource. + - `[SharedPrivateLinkResourceName <String>]`: The name of the shared private link resource + - `[SubscriptionId <String>]`: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Get-AzWebPubSubCustomDomain.md b/azps-10.1.0/Az.SignalR/Get-AzWebPubSubCustomDomain.md new file mode 100644 index 0000000000..18443e3c4f --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Get-AzWebPubSubCustomDomain.md @@ -0,0 +1,203 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/get-azwebpubsubcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSubCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSubCustomDomain.md +--- + +# Get-AzWebPubSubCustomDomain + +## SYNOPSIS +Get a custom domain. + +## SYNTAX + +### List (Default) +``` +Get-AzWebPubSubCustomDomain -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWebPubSubCustomDomain -Name <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWebPubSubCustomDomain -InputObject <IWebPubSubIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a custom domain. + +## EXAMPLES + +### Example 1: List all the custom domains of a Azure Web PubSub resource +```powershell +Get-AzWebPubSubCustomDomain -ResourceGroupName rg -ResourceName wps +``` + +```output +Name DomainName ProvisioningState +---- ---------- ----------------- +mydomain wps.manual-test.dev.signalr.azure.com Succeeded +``` + +We can see this Web PubSub resource only contains one custom domain. + +### Example 2: Get a custom domain by its name +```powershell +Get-AzWebPubSubCustomDomain -ResourceGroupName rg -ResourceName wps -Name mydomain +``` + +```output +Name DomainName ProvisioningState +---- ---------- ----------------- +mydomain wps.manual-test.dev.signalr.azure.com Succeeded +``` + +### Example 2: Get a custom domain by its identity +```powershell +$customDomain = Get-AzWebPubSubCustomDomain -ResourceGroupName rg -ResourceName wps -Name mydomain +$customDomain | Get-AzWebPubSubCustomDomain +``` + +```output +Name DomainName ProvisioningState +---- ---------- ----------------- +mydomain wps.manual-test.dev.signalr.azure.com Succeeded +``` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Custom domain name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.ICustomDomain + +## 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 <IWebPubSubIdentity>`: Identity Parameter + - `[CertificateName <String>]`: Custom certificate name + - `[HubName <String>]`: The hub name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[Name <String>]`: Custom domain name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ResourceName <String>]`: The name of the resource. + - `[SharedPrivateLinkResourceName <String>]`: The name of the shared private link resource + - `[SubscriptionId <String>]`: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Get-AzWebPubSubHub.md b/azps-10.1.0/Az.SignalR/Get-AzWebPubSubHub.md new file mode 100644 index 0000000000..baa27719ca --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Get-AzWebPubSubHub.md @@ -0,0 +1,205 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/get-azwebpubsubhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSubHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSubHub.md +--- + +# Get-AzWebPubSubHub + +## SYNOPSIS +Get a hub setting. + +## SYNTAX + +### List (Default) +``` +Get-AzWebPubSubHub -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWebPubSubHub -Name <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWebPubSubHub -InputObject <IWebPubSubIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a hub setting. + +## EXAMPLES + +### Example 1: List hub settings of a Web PubSub resource. +```powershell +Get-AzWebPubSubHub -ResourceGroupName psdemo -ResourceName psdemo-wps +``` + +```output +Name AnonymousConnectPolicy +---- ---------------------- +testHub deny +testHub2 deny +``` + +### Example 2: Get a Web PubSub hub setting. +```powershell +Get-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps +``` + +```output +Name AnonymousConnectPolicy +---- ---------------------- +testHub deny +``` + +### Example 3: Get a Web PubSub hub setting via identity. +```powershell +$hubIdentity = @{ ResourceGroupName = 'psdemo' +ResourceName = 'psdemo-wps' +SubscriptionId = $(Get-AzContext).Subscription.Id +HubName = 'testHub' } +$hubIdentity | Get-AzWebPubSubHub +``` + +```output +Name AnonymousConnectPolicy +---- ---------------------- +testHub deny +``` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The hub name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: HubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IWebPubSubHub + +## 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 <IWebPubSubIdentity>`: Identity Parameter + - `[CertificateName <String>]`: Custom certificate name + - `[HubName <String>]`: The hub name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[Name <String>]`: Custom domain name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ResourceName <String>]`: The name of the resource. + - `[SharedPrivateLinkResourceName <String>]`: The name of the shared private link resource + - `[SubscriptionId <String>]`: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Get-AzWebPubSubKey.md b/azps-10.1.0/Az.SignalR/Get-AzWebPubSubKey.md new file mode 100644 index 0000000000..ad02c50831 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Get-AzWebPubSubKey.md @@ -0,0 +1,207 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/get-azwebpubsubkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSubKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSubKey.md +--- + +# Get-AzWebPubSubKey + +## SYNOPSIS +Get the access keys of the resource. + +## SYNTAX + +### List (Default) +``` +Get-AzWebPubSubKey -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ListViaIdentity +``` +Get-AzWebPubSubKey -InputObject <IWebPubSubIdentity> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the access keys of the resource. + +## EXAMPLES + +### Example 1: Get the access keys of a Web PubSub resource +```powershell +Get-AzWebPubSubKey -ResourceGroupName psdemo -ResourceName psdemo-wps | Format-List +``` + +```output +PrimaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0; +PrimaryKey : ******** +SecondaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0; +SecondaryKey : ******** +``` + +The example gets the access keys of the Web PubSub resource and then pipes the result to `Format-List` to see all the property values of the result. + +### Example 2: Get the access keys of a Web PubSub resource via identity +```powershell +$wps = Get-AzWebPubSub -ResourceGroupName psdemo -ResourceName psdemo-wps +$wps | Get-AzWebPubSubKey | Format-List +``` + +```output +PrimaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0; +PrimaryKey : ******** +SecondaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0; +SecondaryKey : ******** +``` + +The example gets the access keys of the Web PubSub resource and then pipes the result to `Format-List` to see all the property values of the result. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity +Parameter Sets: ListViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IWebPubSubKeys + +## 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 <IWebPubSubIdentity>`: Identity Parameter + - `[CertificateName <String>]`: Custom certificate name + - `[HubName <String>]`: The hub name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[Name <String>]`: Custom domain name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ResourceName <String>]`: The name of the resource. + - `[SharedPrivateLinkResourceName <String>]`: The name of the shared private link resource + - `[SubscriptionId <String>]`: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Get-AzWebPubSubSku.md b/azps-10.1.0/Az.SignalR/Get-AzWebPubSubSku.md new file mode 100644 index 0000000000..c261c31ba6 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Get-AzWebPubSubSku.md @@ -0,0 +1,139 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/get-azwebpubsubsku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSubSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSubSku.md +--- + +# Get-AzWebPubSubSku + +## SYNOPSIS +List all available skus of the resource. + +## SYNTAX + +``` +Get-AzWebPubSubSku -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +List all available skus of the resource. + +## EXAMPLES + +### Example 1: List all available SKUs of a Web PubSub resource +```powershell +Get-AzWebPubSubSku -ResourceGroupName psdemo -ResourceName psdemo-wps | Format-List +``` + +```output +CapacityAllowedValue : {0, 1} +CapacityDefault : 1 +CapacityMaximum : 1 +CapacityMinimum : 0 +CapacityScaleType : Manual +Family : +Name : Free_F1 +ResourceType : Microsoft.SignalRService/WebPubSub +Size : +SkuCapacity : +Tier : Free + +CapacityAllowedValue : {0, 1, 2, 5…} +CapacityDefault : 1 +CapacityMaximum : 100 +CapacityMinimum : 0 +CapacityScaleType : Automatic +Family : +Name : Standard_S1 +ResourceType : Microsoft.SignalRService/WebPubSub +Size : +SkuCapacity : +Tier : Standard +``` + +The example lists the SKUs of a Web PubSub resource and then pipes the result to `Format-List` to see all the property values of the result. +We can see from the result that there are two SKUs, one's Tier is "Free", and the other is "Standard". + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.ISkuList + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Get-AzWebPubSubUsage.md b/azps-10.1.0/Az.SignalR/Get-AzWebPubSubUsage.md new file mode 100644 index 0000000000..1720a9b8f9 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Get-AzWebPubSubUsage.md @@ -0,0 +1,112 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/get-azwebpubsubusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSubUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Get-AzWebPubSubUsage.md +--- + +# Get-AzWebPubSubUsage + +## SYNOPSIS +List resource usage quotas by location. + +## SYNTAX + +``` +Get-AzWebPubSubUsage -Location <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +List resource usage quotas by location. + +## EXAMPLES + +### Example 1: List Web PubSub usage in east US region. +```powershell +Get-AzWebPubSubUsage -Location eastus | Format-List +``` + +```output +CurrentValue : 4 +Id : /subscriptions/9caf2a1e-9c49-49b6-89a2-56bdec7e3f97/providers/Microsoft.SignalRService/locations/eastus/usages/FreeTierInstances +Limit : 5 +NameLocalizedValue : Free Tier SignalR Instances per subscription +NameValue : FreeTierInstances +Unit : Count + +CurrentValue : 225 +Id : /subscriptions/9caf2a1e-9c49-49b6-89a2-56bdec7e3f97/providers/Microsoft.SignalRService/locations/eastus/usages/SignalRTotalUnits +Limit : 1500 +NameLocalizedValue : SignalRTotalUnits +NameValue : SignalRTotalUnits +Unit : Count +``` + +The example pipes the result of `Get-AzWebPubSubUsage -Location eastus` to `Format-list` to view the values of all the properties of the result. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +the location like "eastus" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.ISignalRServiceUsage + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/New-AzSignalR.md b/azps-10.1.0/Az.SignalR/New-AzSignalR.md new file mode 100644 index 0000000000..5aa981fdf9 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/New-AzSignalR.md @@ -0,0 +1,251 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.SignalR.dll-Help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/new-azsignalr +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzSignalR.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzSignalR.md +--- + +# New-AzSignalR + +## SYNOPSIS +Create a SignalR service. + +## SYNTAX + +``` +New-AzSignalR [-ResourceGroupName <String>] [-Name] <String> [-Location <String>] [-Sku <String>] + [-UnitCount <Int32>] [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] + [-ServiceMode <String>] [-AllowedOrigin <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create a SignalR service. +The following values will be used for the parameters if not specified: +* `ResourceGroupName`: the default resource group set by `Set-AzDefault -ResourceGroupName`. +* `Location`: the location of the resource group +* `Sku`: `Standard_S1` + +## EXAMPLES + +### Create a SignalR service +```powershell +New-AzSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr1 -Location eastus -Sku Standard_S1 -UnitCount 5 +``` + +```output +HostName Location ExternalIp Sku UnitCount ProvisioningState Version +-------- -------- ---------- --- --------- ----------------- ------- +mysignalr1.service.signalr.net eastus 52.179.3.5 Standard_S1 5 Succeeded 1.0 +``` + +### Specify ServiceMode and AllowedOrigin +```powershell +New-AzSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr2 -Location eastus -ServiceMode Serverless -AllowedOrigin http://example1.com:12345, https://example2.cn +``` + +```output +HostName Location ExternalIp Sku UnitCount ProvisioningState Version +-------- -------- ---------- --- --------- ----------------- ------- +mysignalr1.service.signalr.net eastus 52.179.3.5 Standard_S1 1 Succeeded 1.0 +``` + +## PARAMETERS + +### -AllowedOrigin +The allowed origins for the SignalR service. To allow all, use "*" and remove all other origins from the list. Slashes are not allowed as part of domain or after TLD + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the cmdlet in background job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The SignalR service location. The resource group location will be used if not specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The SignalR service name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. The default one will be used if not specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceMode +The service mode for the SignalR service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SignalR service SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Standard_S1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags for the SignalR service. + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnitCount +The SignalR service unit count, from 1 to 10. Default to 1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/New-AzSignalRKey.md b/azps-10.1.0/Az.SignalR/New-AzSignalRKey.md new file mode 100644 index 0000000000..8a72598472 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/New-AzSignalRKey.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.SignalR.dll-Help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/new-azsignalrkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzSignalRKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzSignalRKey.md +--- + +# New-AzSignalRKey + +## SYNOPSIS +Regenerate an access key for a SignalR service. + +## SYNTAX + +### ResourceGroupParameterSet (Default) +``` +New-AzSignalRKey [-ResourceGroupName <String>] [-Name] <String> [-KeyType] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +New-AzSignalRKey -ResourceId <String> [-KeyType] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +New-AzSignalRKey -InputObject <PSSignalRResource> [-KeyType] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerate an access key for a SignalR service. + +## EXAMPLES + +### Regenerate the primary key +```powershell +New-AzSignalRKey -ResourceGroupName myResourceGroup -Name mysignalr1 -KeyType Primary -PassThru +``` + +```output +True +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The SignalR resource object. + +```yaml +Type: Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyType +The key type, either Primary or Secondary. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +SignalR service name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true if the regeneration was completed successfully. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The SignalR service resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/New-AzWebPubSub.md b/azps-10.1.0/Az.SignalR/New-AzWebPubSub.md new file mode 100644 index 0000000000..652e54534d --- /dev/null +++ b/azps-10.1.0/Az.SignalR/New-AzWebPubSub.md @@ -0,0 +1,496 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/new-azwebpubsub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSub.md +--- + +# New-AzWebPubSub + +## SYNOPSIS +Create or update a resource. + +## SYNTAX + +``` +New-AzWebPubSub -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] -Location <String> + -SkuName <String> [-DisableAadAuth] [-DisableLocalAuth] [-EnableTlsClientCert] + [-IdentityType <ManagedIdentityType>] [-LiveTraceCategory <ILiveTraceCategory[]>] [-LiveTraceEnabled <String>] + [-NetworkAcLDefaultAction <AclAction>] [-PrivateEndpointAcl <IPrivateEndpointAcl[]>] + [-PublicNetworkAccess <String>] [-PublicNetworkAllow <WebPubSubRequestType[]>] + [-PublicNetworkDeny <WebPubSubRequestType[]>] [-ResourceLogCategory <IResourceLogCategory[]>] + [-SkuCapacity <Int32>] [-SkuTier <WebPubSubSkuTier>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a resource. + +## EXAMPLES + +### Example 1: Create a Web PubSub resource with minimal required parameters. +```powershell +New-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps -Location eastus -SkuName Standard_S1 +``` + +```output +Name Location SkuName +---- -------- ------- +psdemo-wps eastus Standard_S1 +``` + +### Example 2: Create a Web PubSub resource with more parameters and show the result +```powershell +$wps = New-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps ` +-Location eastus -SkuName Standard_S1 -IdentityType SystemAssigned -LiveTraceEnabled true ` +-LiveTraceCategory @{ Name='ConnectivityLogs' ; Enabled = 'true' }, @{ Name='MessageLogs' ; Enabled = 'true' } +``` + +```output +Name Location SkuName +---- -------- ------- +psdemo-wps eastus Standard_S1 +``` + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAadAuth +DisableLocalAuthEnable or disable aad authWhen set as true, connection with AuthType=aad won't work. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +DisableLocalAuthEnable or disable local auth with AccessKeyWhen set as true, connection with AccessKey=xxx won't work. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTlsClientCert +Request client certificate during TLS handshake if enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Represent the identity type: systemAssigned, userAssigned, None + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Support.ManagedIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveTraceCategory +Gets or sets the list of category configurations. +To construct, see NOTES section for LIVETRACECATEGORY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.ILiveTraceCategory[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveTraceEnabled +Indicates whether or not enable live trace.When it's set to true, live trace client can connect to the service.Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories".Available values: true, false.Case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The GEO location of the resource. +e.g. +West US | East US | North Central US | South Central US. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkAcLDefaultAction +Default action when no other rule matches + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Support.AclAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateEndpointAcl +ACLs for requests from private endpoints +To construct, see NOTES section for PRIVATEENDPOINTACL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IPrivateEndpointAcl[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Enable or disable public network access. +Default to "Enabled".When it's Enabled, network ACLs still apply.When it's Disabled, public network access is always disabled no matter what you set in network ACLs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAllow +Allowed request types. +The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Support.WebPubSubRequestType[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkDeny +Denied request types. +The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Support.WebPubSubRequestType[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceLogCategory +Gets or sets the list of category configurations. +To construct, see NOTES section for RESOURCELOGCATEGORY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IResourceLogCategory[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Optional, integer. +The unit count of the resource. +1 by default.If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Required.Allowed values: Standard_S1, Free_F1 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +Optional tier of this particular SKU. +'Standard' or 'Free'. +`Basic` is deprecated, use `Standard` instead. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Support.WebPubSubSkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags of the service which is a list of key value pairs that describe the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +Get or set the user assigned identities + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IWebPubSubResource + +## 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. + + +`LIVETRACECATEGORY <ILiveTraceCategory[]>`: Gets or sets the list of category configurations. + - `[Enabled <String>]`: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. + - `[Name <String>]`: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. + +`PRIVATEENDPOINTACL <IPrivateEndpointAcl[]>`: ACLs for requests from private endpoints + - `Name <String>`: Name of the private endpoint connection + - `[Allow <WebPubSubRequestType[]>]`: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + - `[Deny <WebPubSubRequestType[]>]`: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + +`RESOURCELOGCATEGORY <IResourceLogCategory[]>`: Gets or sets the list of category configurations. + - `[Enabled <String>]`: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. + - `[Name <String>]`: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/New-AzWebPubSubCustomCertificate.md b/azps-10.1.0/Az.SignalR/New-AzWebPubSubCustomCertificate.md new file mode 100644 index 0000000000..77f7072584 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/New-AzWebPubSubCustomCertificate.md @@ -0,0 +1,239 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/new-azwebpubsubcustomcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSubCustomCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSubCustomCertificate.md +--- + +# New-AzWebPubSubCustomCertificate + +## SYNOPSIS +Create or update a custom certificate. + +## SYNTAX + +``` +New-AzWebPubSubCustomCertificate -Name <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String>] -KeyVaultBaseUri <String> -KeyVaultSecretName <String> + [-KeyVaultSecretVersion <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a custom certificate. + +## EXAMPLES + +### Example 1: Create or update a custom certificate +```powershell +New-AzWebPubSubCustomCertificate -Name mycustomcert -ResourceGroupName rg -ResourceName wps -KeyVaultBaseUri https://kvcustomcertificatetest.vault.azure.net/ -KeyVaultSecretName manual-test +``` + +```output +Name KeyVaultBaseUri KeyVaultSecretName KeyVaultSecretVersion ProvisioningState +---- --------------- ------------------ --------------------- ----------------- +mycustomcert https://kvcustomcertificatetest.vault.azure.net/ manual-test Succeeded +``` + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultBaseUri +Base uri of the KeyVault that stores certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultSecretName +Certificate secret name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultSecretVersion +Certificate secret version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Custom certificate name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.ICustomCertificate + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/New-AzWebPubSubCustomDomain.md b/azps-10.1.0/Az.SignalR/New-AzWebPubSubCustomDomain.md new file mode 100644 index 0000000000..06831d21b7 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/New-AzWebPubSubCustomDomain.md @@ -0,0 +1,238 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/new-azwebpubsubcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSubCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSubCustomDomain.md +--- + +# New-AzWebPubSubCustomDomain + +## SYNOPSIS +Create or update a custom domain. + +## SYNTAX + +``` +New-AzWebPubSubCustomDomain -Name <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String>] -DomainName <String> [-CustomCertificateId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a custom domain. + +## EXAMPLES + +### Example 1: Create or update a custom domain +```powershell +$cert = Get-AzWebPubSubCustomCertificate -Name mycustomcert -ResourceGroupName rg -ResourceName wps +New-AzWebPubSubCustomDomain -Name mydomain -ResourceGroupName rg -ResourceName wps -DomainName wps.manual-test.dev.signalr.azure.com -CustomCertificateId $cert.Id +``` + +```output +Name DomainName ProvisioningState +---- ---------- ----------------- +mydomain wps.manual-test.dev.signalr.azure.com Succeeded +``` + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomCertificateId +Resource ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +The custom domain name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Custom domain name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.ICustomDomain + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/New-AzWebPubSubEventHubEndpointObject.md b/azps-10.1.0/Az.SignalR/New-AzWebPubSubEventHubEndpointObject.md new file mode 100644 index 0000000000..6b0d8d19dc --- /dev/null +++ b/azps-10.1.0/Az.SignalR/New-AzWebPubSubEventHubEndpointObject.md @@ -0,0 +1,85 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/new-azwebpubsubeventhubendpointobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSubEventHubEndpointObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSubEventHubEndpointObject.md +--- + +# New-AzWebPubSubEventHubEndpointObject + +## SYNOPSIS +Create an in-memory object for EventHubEndpoint. + +## SYNTAX + +``` +New-AzWebPubSubEventHubEndpointObject -EventHubName <String> -FullyQualifiedNamespace <String> + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for EventHubEndpoint. + +## EXAMPLES + +### Example 1: Create an Event Hubs endpoint object +```powershell +$eventHub = New-AzWebPubSubEventHubEndpointObject -EventHubName hub1 -FullyQualifiedNamespace example.servicebus.windows.net +$eventHub +``` + +```output +EventHubName FullyQualifiedNamespace +------------ ----------------------- +hub1 example.servicebus.windows.net +``` + +## PARAMETERS + +### -EventHubName +The name of the Event Hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullyQualifiedNamespace +The fully qualified namespace name of the Event Hub resource. +For example, "example.servicebus.windows.net". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.EventHubEndpoint + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/New-AzWebPubSubEventNameFilterObject.md b/azps-10.1.0/Az.SignalR/New-AzWebPubSubEventNameFilterObject.md new file mode 100644 index 0000000000..6d72024596 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/New-AzWebPubSubEventNameFilterObject.md @@ -0,0 +1,93 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/new-azwebpubsubeventnamefilterobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSubEventNameFilterObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSubEventNameFilterObject.md +--- + +# New-AzWebPubSubEventNameFilterObject + +## SYNOPSIS +Create an in-memory object for EventNameFilter. + +## SYNTAX + +``` +New-AzWebPubSubEventNameFilterObject [-SystemEvent <String[]>] [-UserEventPattern <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for EventNameFilter. + +## EXAMPLES + +### Example 1: Create an event name filter object +```powershell +$filter = New-AzWebPubSubEventNameFilterObject -SystemEvent connected,disconnected -UserEventPattern * +$filter +``` + +```output +SystemEvent UserEventPattern +----------- ---------------- +{connected, disconnected} * +``` + +## PARAMETERS + +### -SystemEvent +Gets or sets a list of system events. +Supported events: "connected" and "disconnected". +Blocking event "connect" is not supported because it requires a response. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEventPattern +Gets or sets a matching pattern for event names. + There are 3 kinds of patterns supported: + 1. +"*", it matches any event name + 2. +Combine multiple events with ",", for example "event1,event2", it matches events "event1" and "event2" + 3. +A single event name, for example, "event1", it matches "event1". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.EventNameFilter + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/New-AzWebPubSubHub.md b/azps-10.1.0/Az.SignalR/New-AzWebPubSubHub.md new file mode 100644 index 0000000000..d8b4fdb371 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/New-AzWebPubSubHub.md @@ -0,0 +1,288 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/new-azwebpubsubhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSubHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSubHub.md +--- + +# New-AzWebPubSubHub + +## SYNOPSIS +Create or update a hub setting. + +## SYNTAX + +``` +New-AzWebPubSubHub -Name <String> -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String>] + [-AnonymousConnectPolicy <String>] [-EventHandler <IEventHandler[]>] [-EventListener <IEventListener[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a hub setting. + +## EXAMPLES + +### Example 1: Add two event handlers for a hub +```powershell +$eventHandler = @{UrlTemplate = 'http://example.com/api/{hub}/connect/{event}' ; AuthType = 'None' ; SystemEvent = 'connect' ; } , + @{ UrlTemplate = 'http://example.com/api/{hub}/userevent/{event}' ; AuthType = 'None' ; UserEventPattern = '*' } + +New-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps -EventHandler $eventHandler +``` + +```output +Name AnonymousConnectPolicy +---- ---------------------- +testHub deny +``` + +The example first creates a list of hash tables containing two event handler settings, one for system events and the other for user events. +Then it creates a hub with the event handlers. + +### Example 2: Add two event listeners for a hub +```powershell +$eventListeners = +@{ + Endpoint = $(New-AzWebPubSubEventHubEndpointObject -EventHubName connectivityHub -FullyQualifiedNamespace example.servicebus.windows.net); + Filter = $(New-AzWebPubSubEventNameFilterObject -SystemEvent connected, disconnected) +}, +@{ + Endpoint = $(New-AzWebPubSubEventHubEndpointObject -EventHubName messageHub -FullyQualifiedNamespace example.servicebus.windows.net); + Filter = $(New-AzWebPubSubEventNameFilterObject -UserEventPattern *) +} + +$hub = New-AzWebPubSubHub -Name hub2 -ResourceGroupName rg -ResourceName psdemo -EventListener $eventListeners +``` + +```output +Name AnonymousConnectPolicy +---- ---------------------- +hub2 deny +``` + +The example first creates a list of hash tables containing two event listener settings, one for system events and the other for user events. +Then it creates a hub with the event handlers. + +## PARAMETERS + +### -AnonymousConnectPolicy +The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". +Default to "deny". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHandler +Event handler of a hub. +To construct, see NOTES section for EVENTHANDLER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IEventHandler[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventListener +Event listener settings for forwarding your client events to listeners.Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.One event can be sent to multiple listeners, as long as it matches the filters in those listeners. +The order of the array elements doesn't matter.Maximum count of event listeners among all hubs is 10. +To construct, see NOTES section for EVENTLISTENER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IEventListener[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The hub name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IWebPubSubHub + +## 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. + + +`EVENTHANDLER <IEventHandler[]>`: Event handler of a hub. + - `UrlTemplate <String>`: Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. For example, UrlTemplate can be `http://example.com/api/{hub}/{event}`. The host part can't contains parameters. + - `[AuthType <UpstreamAuthType?>]`: Upstream auth type enum. + - `[ManagedIdentityResource <String>]`: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. + - `[SystemEvent <String[]>]`: Gets ot sets the list of system events. Valid values contain: 'connect', 'connected', 'disconnected'. + - `[UserEventPattern <String>]`: Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1" + +`EVENTLISTENER <IEventListener[]>`: Event listener settings for forwarding your client events to listeners.Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter.Maximum count of event listeners among all hubs is 10. + - `Endpoint <IEventListenerEndpoint>`: An endpoint specifying where Web PubSub should send events to. + - `Filter <IEventListenerFilter>`: A base class for event filter which determines whether an event should be sent to an event listener. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/New-AzWebPubSubKey.md b/azps-10.1.0/Az.SignalR/New-AzWebPubSubKey.md new file mode 100644 index 0000000000..832cd7095a --- /dev/null +++ b/azps-10.1.0/Az.SignalR/New-AzWebPubSubKey.md @@ -0,0 +1,266 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/new-azwebpubsubkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSubKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/New-AzWebPubSubKey.md +--- + +# New-AzWebPubSubKey + +## SYNOPSIS +Regenerate the access key for the resource. +PrimaryKey and SecondaryKey cannot be regenerated at the same time. + +## SYNTAX + +### RegenerateExpanded (Default) +``` +New-AzWebPubSubKey -ResourceGroupName <String> -ResourceName <String> [-SubscriptionId <String>] + -KeyType <KeyType> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RegenerateViaIdentityExpanded +``` +New-AzWebPubSubKey -InputObject <IWebPubSubIdentity> -KeyType <KeyType> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerate the access key for the resource. +PrimaryKey and SecondaryKey cannot be regenerated at the same time. + +## EXAMPLES + +### Example 1: Regenerate the primary access key of a Web PubSub resource +```powershell +New-AzWebPubSubKey -ResourceGroupName psdemo -ResourceName psdemo-wps -KeyType 'Primary' | Format-List +``` + +```output +PrimaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0; +PrimaryKey : ******** +SecondaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0; +SecondaryKey : ******** +``` + +### Example 2: Regenerate the primary access key of a Web PubSub resource via identity +```powershell +$wps = Get-AzWebPubSub -Name psdemo-wps -ResourceGroupName psdemo +$wps | New-AzWebPubSubKey -KeyType Primary | Format-List +``` + +```output +PrimaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0; +PrimaryKey : ******** +SecondaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0; +SecondaryKey : ******** +``` + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity +Parameter Sets: RegenerateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyType +The keyType to regenerate. +Must be either 'primary', 'secondary' or 'salt'(case-insensitive). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Support.KeyType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: RegenerateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IWebPubSubKeys + +## 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 <IWebPubSubIdentity>`: Identity Parameter + - `[CertificateName <String>]`: Custom certificate name + - `[HubName <String>]`: The hub name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[Name <String>]`: Custom domain name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ResourceName <String>]`: The name of the resource. + - `[SharedPrivateLinkResourceName <String>]`: The name of the shared private link resource + - `[SubscriptionId <String>]`: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Remove-AzSignalR.md b/azps-10.1.0/Az.SignalR/Remove-AzSignalR.md new file mode 100644 index 0000000000..c623831ace --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Remove-AzSignalR.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.SignalR.dll-Help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/remove-azsignalr +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Remove-AzSignalR.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Remove-AzSignalR.md +--- + +# Remove-AzSignalR + +## SYNOPSIS +Remove a SignalR service. + +## SYNTAX + +### ResourceGroupParameterSet (Default) +``` +Remove-AzSignalR [-ResourceGroupName <String>] [-Name] <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzSignalR -ResourceId <String> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzSignalR -InputObject <PSSignalRResource> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a SignalR service. + +## EXAMPLES + +### Remove a SignalR service +```powershell +Remove-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -PassThru +``` + +```output +True +``` + +### Remove all SignalR service from pipe +```powershell +Get-AzSignalR -ResourceGroupName myResourceGroup | Remove-AzSignalR +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The SignalR resource object. + +```yaml +Type: Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +SignalR service name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true if the removal was completed successfully. + +```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 +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The SignalR service resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Remove-AzWebPubSub.md b/azps-10.1.0/Az.SignalR/Remove-AzWebPubSub.md new file mode 100644 index 0000000000..aec203f415 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Remove-AzWebPubSub.md @@ -0,0 +1,237 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/remove-azwebpubsub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Remove-AzWebPubSub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Remove-AzWebPubSub.md +--- + +# Remove-AzWebPubSub + +## SYNOPSIS +Operation to delete a resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWebPubSub -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWebPubSub -InputObject <IWebPubSubIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to delete a resource. + +## EXAMPLES + +### Example 1: Remove a Web PubSub resource +```powershell +Remove-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps +``` + +### Example 2: Remove a Web PubSub resource via identity +```powershell +$identity = @{ResourceGroupName = 'psdemo' +ResourceName = 'psdemo-wps' +SubscriptionId = $(Get-AzContext).Subscription.Id } + +$identity | Remove-AzWebPubSub +``` + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebPubSubIdentity>`: Identity Parameter + - `[CertificateName <String>]`: Custom certificate name + - `[HubName <String>]`: The hub name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[Name <String>]`: Custom domain name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ResourceName <String>]`: The name of the resource. + - `[SharedPrivateLinkResourceName <String>]`: The name of the shared private link resource + - `[SubscriptionId <String>]`: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Remove-AzWebPubSubCustomCertificate.md b/azps-10.1.0/Az.SignalR/Remove-AzWebPubSubCustomCertificate.md new file mode 100644 index 0000000000..1dffb990ab --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Remove-AzWebPubSubCustomCertificate.md @@ -0,0 +1,219 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/remove-azwebpubsubcustomcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Remove-AzWebPubSubCustomCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Remove-AzWebPubSubCustomCertificate.md +--- + +# Remove-AzWebPubSubCustomCertificate + +## SYNOPSIS +Delete a custom certificate. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWebPubSubCustomCertificate -Name <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWebPubSubCustomCertificate -InputObject <IWebPubSubIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a custom certificate. + +## EXAMPLES + +### Example 1: Remove a custom certificate by its name +```powershell +Remove-AzWebPubSubCustomCertificate -Name mycustomcert -ResourceGroupName example-rg -ResourceName example-wps +``` + +### Example 2: Remove a custom certificate by its identity +```powershell +$customCert = Get-AzWebPubSubCustomCertificate -Name mycustomcert -ResourceGroupName example-rg -ResourceName example-wps +$customCert | Remove-AzWebPubSubCustomCertificate +``` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Custom certificate name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebPubSubIdentity>`: Identity Parameter + - `[CertificateName <String>]`: Custom certificate name + - `[HubName <String>]`: The hub name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[Name <String>]`: Custom domain name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ResourceName <String>]`: The name of the resource. + - `[SharedPrivateLinkResourceName <String>]`: The name of the shared private link resource + - `[SubscriptionId <String>]`: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Remove-AzWebPubSubCustomDomain.md b/azps-10.1.0/Az.SignalR/Remove-AzWebPubSubCustomDomain.md new file mode 100644 index 0000000000..5099c12835 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Remove-AzWebPubSubCustomDomain.md @@ -0,0 +1,250 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/remove-azwebpubsubcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Remove-AzWebPubSubCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Remove-AzWebPubSubCustomDomain.md +--- + +# Remove-AzWebPubSubCustomDomain + +## SYNOPSIS +Delete a custom domain. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWebPubSubCustomDomain -Name <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWebPubSubCustomDomain -InputObject <IWebPubSubIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a custom domain. + +## EXAMPLES + +### Example 1: Remove a custom domain by its name +```powershell +Remove-AzWebPubSubCustomDomain -Name mydomain -ResourceGroupName rg -ResourceName wps +``` + +### Example 2: Remove a custom domain by its identity +```powershell +$customDomain = Get-AzWebPubSubCustomDomain -Name mydomain -ResourceGroupName rg -ResourceName wps +$customDomain | Remove-AzWebPubSubCustomDomain +``` + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Custom domain name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebPubSubIdentity>`: Identity Parameter + - `[CertificateName <String>]`: Custom certificate name + - `[HubName <String>]`: The hub name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[Name <String>]`: Custom domain name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ResourceName <String>]`: The name of the resource. + - `[SharedPrivateLinkResourceName <String>]`: The name of the shared private link resource + - `[SubscriptionId <String>]`: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Remove-AzWebPubSubHub.md b/azps-10.1.0/Az.SignalR/Remove-AzWebPubSubHub.md new file mode 100644 index 0000000000..a272316b8d --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Remove-AzWebPubSubHub.md @@ -0,0 +1,256 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/remove-azwebpubsubhub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Remove-AzWebPubSubHub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Remove-AzWebPubSubHub.md +--- + +# Remove-AzWebPubSubHub + +## SYNOPSIS +Delete a hub setting. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWebPubSubHub -Name <String> -ResourceGroupName <String> -ResourceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWebPubSubHub -InputObject <IWebPubSubIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a hub setting. + +## EXAMPLES + +### Example 1: Remove a hub setting. +```powershell +Remove-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps +``` + +### Example 2: Remove a hub setting via identity. +```powershell +$hubIdentity = @{HubName = 'testHub' +ResourceGroupName='psdemo' +ResourceName = 'psdemo-wps' +SubscriptionId = $(Get-AzContext).Subscription.Id} +$hubIdentity | Remove-AzWebPubSubHub +``` + +The example first constructs a hash table standing for the hub identity. +Then it passes the identity through pipeline to the `Remove-AzWebPubSubHub` cmdlet. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The hub name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: HubName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebPubSubIdentity>`: Identity Parameter + - `[CertificateName <String>]`: Custom certificate name + - `[HubName <String>]`: The hub name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[Name <String>]`: Custom domain name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ResourceName <String>]`: The name of the resource. + - `[SharedPrivateLinkResourceName <String>]`: The name of the shared private link resource + - `[SubscriptionId <String>]`: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Restart-AzSignalR.md b/azps-10.1.0/Az.SignalR/Restart-AzSignalR.md new file mode 100644 index 0000000000..112301f4e5 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Restart-AzSignalR.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.SignalR.dll-Help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/restart-azsignalr +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Restart-AzSignalR.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Restart-AzSignalR.md +--- + +# Restart-AzSignalR + +## SYNOPSIS +Restart a SignalR service. + +## SYNTAX + +### ResourceGroupParameterSet (Default) +``` +Restart-AzSignalR [-ResourceGroupName <String>] [-Name] <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Restart-AzSignalR -ResourceId <String> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Restart-AzSignalR -InputObject <PSSignalRResource> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Restart a SignalR service. + +## EXAMPLES + +### Restart a specific SignalR service +```powershell +Restart-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -PassThru +``` + +```output +True +``` + +The default resource group can be set by \`Set-AzDefault -ResourceGroupName myResourceGroup\`. + +## PARAMETERS + +### -AsJob +Run the cmdlet in background job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The SignalR resource object. + +```yaml +Type: Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The SignalR service name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. +The default one will be used if not specified. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The SignalR service resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Restart-AzWebPubSub.md b/azps-10.1.0/Az.SignalR/Restart-AzWebPubSub.md new file mode 100644 index 0000000000..440442cfa2 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Restart-AzWebPubSub.md @@ -0,0 +1,237 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/restart-azwebpubsub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Restart-AzWebPubSub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Restart-AzWebPubSub.md +--- + +# Restart-AzWebPubSub + +## SYNOPSIS +Operation to restart a resource. + +## SYNTAX + +### Restart (Default) +``` +Restart-AzWebPubSub -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RestartViaIdentity +``` +Restart-AzWebPubSub -InputObject <IWebPubSubIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to restart a resource. + +## EXAMPLES + +### Example 1: Restart a Web PubSub resource +```powershell +Restart-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps +``` + +### Example 2: Restart a Web PubSub resource with identity +```powershell +$identity = @{ResourceGroupName = 'psdemo' +ResourceName = 'psdemo-wps' +SubscriptionId = $(Get-AzContext).Subscription.Id } + +$identity | Restart-AzWebPubSub +``` + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity +Parameter Sets: RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebPubSubIdentity>`: Identity Parameter + - `[CertificateName <String>]`: Custom certificate name + - `[HubName <String>]`: The hub name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[Name <String>]`: Custom domain name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ResourceName <String>]`: The name of the resource. + - `[SharedPrivateLinkResourceName <String>]`: The name of the shared private link resource + - `[SubscriptionId <String>]`: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Set-AzSignalRUpstream.md b/azps-10.1.0/Az.SignalR/Set-AzSignalRUpstream.md new file mode 100644 index 0000000000..c1b5581c27 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Set-AzSignalRUpstream.md @@ -0,0 +1,254 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.SignalR.dll-Help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/set-azsignalrupstream +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Set-AzSignalRUpstream.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Set-AzSignalRUpstream.md +--- + +# Set-AzSignalRUpstream + +## SYNOPSIS +Set the upstream settings of a SignalR service. + +## SYNTAX + +### ResourceGroupParameterSet (Default) +``` +Set-AzSignalRUpstream [-ResourceGroupName <String>] [-Name] <String> [-AsJob] + [-Template <PSUpstreamTemplate[]>] [-Clear] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Set-AzSignalRUpstream -ResourceId <String> [-AsJob] [-Template <PSUpstreamTemplate[]>] [-Clear] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Set-AzSignalRUpstream -InputObject <PSSignalRResource> [-AsJob] [-Template <PSUpstreamTemplate[]>] [-Clear] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Set the upstream settings of a SignalR service. + +## EXAMPLES + +### Set two ordered upstream templates +```powershell +Set-AzSignalRUpstream -name pssignalr -ResourceGroupName test_resource_group -Template @{UrlTemplate='http://host-connections1.com'; HubPattern='chat';EventPattern='broadcast' }, @{UrlTemplate='http://host-connections2.com'} +``` + +```output +Templates +--------- +{Microsoft.Azure.Commands.SignalR.Models.PSUpstreamTemplate, Microsoft.Azure.Commands.SignalR.Models.PSUpstreamTemplat… +``` + +The following JSON represents the actual templates set. + + ` +{ + "hubPattern": "chat", + "eventPattern": "broadcast", + "categoryPattern": "*", + "urlTemplate": "http://host-connections1.com" +}, +{ + "hubPattern": "*", + "eventPattern": "*", + "categoryPattern": "*", + "urlTemplate": "http://host-connections2.com" +} +` + +### Clear all the upstream settings +```powershell +Set-AzSignalRUpstream -name pssignalr -ResourceGroupName test_resource_group -Clear +``` + +```output +Templates +--------- +{} +``` + +## PARAMETERS + +### -AsJob +Run the cmdlet in background job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Clear +Clear all the upstream settings. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The SignalR resource object. + +```yaml +Type: Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The SignalR service name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. +The default one will be used if not specified. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The SignalR service resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Template +Template item(s) for upstream settings. +Required key: UrlTemplate. +Optional keys: HubPattern, EventPattern, CategoryPattern. +Example using splatting syntax to pass templates parameter: @{UrlTemplate='http://host-connections1.com', HubPattern= 'chat';EventPattern='broadcast' },@{UrlTemplate='http://host-connections2.com'} + +```yaml +Type: Microsoft.Azure.Commands.SignalR.Models.PSUpstreamTemplate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource + +## OUTPUTS + +### Microsoft.Azure.Commands.SignalR.Models.PSServerlessUpstreamSettings + +## NOTES + +## RELATED LINKS + +[How to use splatting to pass parameters to commands in PowerShell](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_splatting?view=powershell-7) diff --git a/azps-10.1.0/Az.SignalR/Test-AzSignalRName.md b/azps-10.1.0/Az.SignalR/Test-AzSignalRName.md new file mode 100644 index 0000000000..a898ea8661 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Test-AzSignalRName.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.SignalR.dll-Help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/test-azsignalrname +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Test-AzSignalRName.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Test-AzSignalRName.md +--- + +# Test-AzSignalRName + +## SYNOPSIS +Check the availability of a name. Alias: Test-AzSignal. + +## SYNTAX + +``` +Test-AzSignalRName [-Name] <String> [-Location] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Check the availability of a name. Alias: Test-AzSignal. + +## EXAMPLES + +### Check an existed name. +```powershell +Test-AzSignalRName -Name existedsignalr -Location eastus +``` + +```output +False +``` + +### Check an unexisted name. +```powershell +Test-AzSignalRName -Name unexistedsignalr -Location eastus +``` + +```output +True +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The SignalR service location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The SignalR service name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Test-AzWebPubSubNameAvailability.md b/azps-10.1.0/Az.SignalR/Test-AzWebPubSubNameAvailability.md new file mode 100644 index 0000000000..e3995ba50c --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Test-AzWebPubSubNameAvailability.md @@ -0,0 +1,147 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/test-azwebpubsubnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Test-AzWebPubSubNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Test-AzWebPubSubNameAvailability.md +--- + +# Test-AzWebPubSubNameAvailability + +## SYNOPSIS +Checks that the resource name is valid and is not already in use. + +## SYNTAX + +``` +Test-AzWebPubSubNameAvailability -Location <String> [-SubscriptionId <String>] -Name <String> + [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Checks that the resource name is valid and is not already in use. + +## EXAMPLES + +### Example 1: Check if the resource name "abc" is available in east US region. +```powershell +Test-AzWebPubSubNameAvailability -Location eastus -Name abc +``` + +```output +NameAvailable Reason Message +------------- ------ ------- +True +``` + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +the region + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The resource name to validate. +e.g."my-resource-name" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.INameAvailability + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Update-AzSignalR.md b/azps-10.1.0/Az.SignalR/Update-AzSignalR.md new file mode 100644 index 0000000000..9baf311bf2 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Update-AzSignalR.md @@ -0,0 +1,287 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.SignalR.dll-Help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/update-azsignalr +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Update-AzSignalR.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Update-AzSignalR.md +--- + +# Update-AzSignalR + +## SYNOPSIS +Update a SignalR service. + +## SYNTAX + +### ResourceGroupParameterSet (Default) +``` +Update-AzSignalR [-ResourceGroupName <String>] [-Name] <String> [-Sku <String>] [-UnitCount <Int32>] + [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] [-ServiceMode <String>] + [-AllowedOrigin <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Update-AzSignalR -ResourceId <String> [-Sku <String>] [-UnitCount <Int32>] + [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] [-ServiceMode <String>] + [-AllowedOrigin <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Update-AzSignalR -InputObject <PSSignalRResource> [-Sku <String>] [-UnitCount <Int32>] + [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] [-ServiceMode <String>] + [-AllowedOrigin <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Update a SignalR service. +The following values will be used for the parameters if not specified: +* `ResourceGroupName`: the default resource group set by `Set-AzDefault -ResourceGroupName`. +* `Sku`: `Standard_S1` + +## EXAMPLES + +### Update a specific SignalR service. +```powershell +Update-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -UnitCount 5 +``` + +```output +HostName Location ExternalIp Sku UnitCount ProvisioningState Version +-------- -------- ---------- --- --------- ----------------- ------- +mysignalr1.service.signalr.net eastus 52.179.3.5 Standard_S1 5 Succeeded 1.0 +``` + +### Specify ServiceMode and AllowedOrigin +```powershell +Update-AzSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr2 -ServiceMode Serverless -AllowedOrigin http://example1.com:12345, https://example2.cn +``` + +```output +HostName Location ExternalIp Sku UnitCount ProvisioningState Version +-------- -------- ---------- --- --------- ----------------- ------- +mysignalr1.service.signalr.net eastus 52.179.3.5 Standard_S1 1 Succeeded 1.0 +``` + +## PARAMETERS + +### -AllowedOrigin +The allowed origins for the SignalR service. To allow all, use "*" and remove all other origins from the list. Slashes are not allowed as part of domain or after TLD + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the cmdlet in background job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The SignalR resource object. + +```yaml +Type: Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The SignalR service name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. +The default one will be used if not specified. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The SignalR service resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceMode +The service mode for the SignalR service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The SignalR service SKU. +Default to "Standard_S1". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags for the SignalR service. + +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnitCount +The SignalR service unit count, value only from {1, 2, 5, 10, 20, 50, 100}. +Default to 1. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource + +## OUTPUTS + +### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Update-AzSignalRNetworkAcl.md b/azps-10.1.0/Az.SignalR/Update-AzSignalRNetworkAcl.md new file mode 100644 index 0000000000..46b9798d97 --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Update-AzSignalRNetworkAcl.md @@ -0,0 +1,297 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.SignalR.dll-Help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/update-azsignalrnetworkacl +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Update-AzSignalRNetworkAcl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Update-AzSignalRNetworkAcl.md +--- + +# Update-AzSignalRNetworkAcl + +## SYNOPSIS +Update the Network ACL of a SignalR service. + +## SYNTAX + +### ResourceGroupParameterSet (Default) +``` +Update-AzSignalRNetworkAcl [-ResourceGroupName <String>] [-Name] <String> [-AsJob] [-DefaultAction <String>] + [-PublicNetwork] [-PrivateEndpointName <String[]>] [-Allow <String[]>] [-Deny <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Update-AzSignalRNetworkAcl -ResourceId <String> [-AsJob] [-DefaultAction <String>] [-PublicNetwork] + [-PrivateEndpointName <String[]>] [-Allow <String[]>] [-Deny <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Update-AzSignalRNetworkAcl -InputObject <PSSignalRResource> [-AsJob] [-DefaultAction <String>] [-PublicNetwork] + [-PrivateEndpointName <String[]>] [-Allow <String[]>] [-Deny <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Update the Network ACL of a SignalR service, including the default action and the network Acls for public and private connection. + +## EXAMPLES + +### Allow RESTAPI,ClientConnection for public network and set default action to Deny +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +$networkAcl = Update-AzSignalRNetworkAcl -Name pssignalr -ResourceGroupName test_resource_group -DefaultAction Deny -PublicNetwork -Allow RESTAPI,ClientConnection + +$networkAcl + +DefaultAction PublicNetwork PrivateEndpoints +------------- ------------- ---------------- +Deny Microsoft.Azure.Commands.SignalR.Models.PSNetworkAcl {pssignalr.70197ffc-d138-49a5-a336-98b21a8d04d1} + +$networkAcl.PublicNetwork +Allow Deny +----- ---- +{ClientConnection, RESTAPI} {} +``` + +### Allow client connection and server connection for a private endpoint connection +```powershell +$networkAcl = Update-AzSignalRNetworkAcl -Name pssignalr -ResourceGroupName test_resource_group -PrivateEndpointName pssignalr.70197ffc-d138-49a5-a336-98b21a8d04d1 -Allow ClientConnection,ServerConnection + +$networkAcl.PrivateEndpoints[0] +``` + +```output +Name Allow Deny +---- ----- ---- +pssignalr.70197ffc-d138-49a5-a336-98b21a8d04d1 {ServerConnection, ClientConnection} {} +``` + +### Deny client connection for both public network and a private endpoint connection +```powershell +$networkAcl = Update-AzSignalRNetworkAcl -Name pssignalr -ResourceGroupName test_resource_group -PrivateEndpointName pssignalr.70197ffc-d138-49a5-a336-98b21a8d04d1 -PublicNetwork -Deny ClientConnection +``` + +## PARAMETERS + +### -Allow +Allowed network ACLs + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: ClientConnection, ServerConnection, RESTAPI, Trace + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the cmdlet in background job. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAction +Default Action of SignalR network ACLs, either allow or deny. It decides whether deny network ACLs or allow network ACLs take effect. For example, if the default action is allow, then only the deny ACLs matters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Deny +Denied network ACLs + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: ClientConnection, ServerConnection, RESTAPI, Trace + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The SignalR resource object. + +```yaml +Type: Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The SignalR service name. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateEndpointName +Name(s) of private endpoint(s) to be updated + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetwork +Update public network ACLs + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. +The default one will be used if not specified. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The SignalR service resource ID. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource + +## OUTPUTS + +### Microsoft.Azure.Commands.SignalR.Models.PSSignalRNetworkAcls + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SignalR/Update-AzWebPubSub.md b/azps-10.1.0/Az.SignalR/Update-AzWebPubSub.md new file mode 100644 index 0000000000..41e7d09dec --- /dev/null +++ b/azps-10.1.0/Az.SignalR/Update-AzWebPubSub.md @@ -0,0 +1,536 @@ +--- +external help file: Az.SignalR-help.xml +Module Name: Az.SignalR +online version: https://learn.microsoft.com/powershell/module/az.signalr/update-azwebpubsub +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Update-AzWebPubSub.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SignalR/SignalR/help/Update-AzWebPubSub.md +--- + +# Update-AzWebPubSub + +## SYNOPSIS +Operation to update an exiting resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWebPubSub -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-DisableAadAuth] + [-DisableLocalAuth] [-EnableTlsClientCert] [-IdentityType <ManagedIdentityType>] + [-LiveTraceCategory <ILiveTraceCategory[]>] [-LiveTraceEnabled <String>] + [-NetworkAcLDefaultAction <AclAction>] [-PrivateEndpointAcl <IPrivateEndpointAcl[]>] + [-PublicNetworkAccess <String>] [-PublicNetworkAllow <WebPubSubRequestType[]>] + [-PublicNetworkDeny <WebPubSubRequestType[]>] [-ResourceLogCategory <IResourceLogCategory[]>] + [-SkuCapacity <Int32>] [-SkuName <String>] [-SkuTier <WebPubSubSkuTier>] [-Tag <Hashtable>] + [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWebPubSub -InputObject <IWebPubSubIdentity> [-DisableAadAuth] [-DisableLocalAuth] + [-EnableTlsClientCert] [-IdentityType <ManagedIdentityType>] [-LiveTraceCategory <ILiveTraceCategory[]>] + [-LiveTraceEnabled <String>] [-NetworkAcLDefaultAction <AclAction>] + [-PrivateEndpointAcl <IPrivateEndpointAcl[]>] [-PublicNetworkAccess <String>] + [-PublicNetworkAllow <WebPubSubRequestType[]>] [-PublicNetworkDeny <WebPubSubRequestType[]>] + [-ResourceLogCategory <IResourceLogCategory[]>] [-SkuCapacity <Int32>] [-SkuName <String>] + [-SkuTier <WebPubSubSkuTier>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to update an exiting resource. + +## EXAMPLES + +### Example 1: Update a Web PubSub resource +```powershell +$wps = Update-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps ` +-IdentityType SystemAssigned -LiveTraceEnabled true ` +-LiveTraceCategory @{ Name='ConnectivityLogs' ; Enabled = 'true' }, @{ Name='MessageLogs' ; Enabled = 'true' } +``` + +```output +Name Location SkuName +---- -------- ------- +psdemo-wps eastus Standard_S1 +``` + +### Example 2: Update a Web PubSub resource via identity +```powershell +$identity = @{ ResourceGroupName = 'psdemo' +ResourceName = 'psdemo-wps' +SubscriptionId = $(Get-AzContext).Subscription.Id } +$identity | Update-AzWebPubSub -EnableTlsClientCert + +$wps | Format-List +``` + +```output +DisableAadAuth : False +DisableLocalAuth : False +EnableTlsClientCert : True +ExternalIP : 20.62.134.186 +HostName : psdemo-wps.webpubsub.azure.com +...... +Version : 1.0 +``` + +The example constructs a hash table representing the identity of a Web PubSub resource, and then it pipes the identity object to the `Update` cmdlet. +At last it pipes the result of `Update` cmdlet to `Format-List` to see all the property values. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAadAuth +DisableLocalAuthEnable or disable aad authWhen set as true, connection with AuthType=aad won't work. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLocalAuth +DisableLocalAuthEnable or disable local auth with AccessKeyWhen set as true, connection with AccessKey=xxx won't work. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTlsClientCert +Request client certificate during TLS handshake if enabled + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Represents the identity type: systemAssigned, userAssigned, None + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Support.ManagedIdentityType +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.WebPubSub.Models.IWebPubSubIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LiveTraceCategory +Gets or sets the list of category configurations. +To construct, see NOTES section for LIVETRACECATEGORY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.ILiveTraceCategory[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveTraceEnabled +Indicates whether or not enable live trace.When it's set to true, live trace client can connect to the service.Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories".Available values: true, false.Case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ResourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkAcLDefaultAction +Azure Networking ACL Action. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Support.AclAction +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateEndpointAcl +ACLs for requests from private endpoints +To construct, see NOTES section for PRIVATEENDPOINTACL properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IPrivateEndpointAcl[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Enable or disable public network access. +Default to "Enabled".When it's Enabled, network ACLs still apply.When it's Disabled, public network access is always disabled no matter what you set in network ACLs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAllow +Allowed request types. +The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Support.WebPubSubRequestType[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkDeny +Denied request types. +The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Support.WebPubSubRequestType[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceLogCategory +Gets or sets the list of category configurations. +To construct, see NOTES section for RESOURCELOGCATEGORY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IResourceLogCategory[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Optional, integer. +The unit count of the resource. +1 by default.If present, following values are allowed: Free: 1; Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Required.Allowed values: Standard_S1, Free_F1, Premium_P1 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +Optional tier of this particular SKU. +'Standard' or 'Free'. +`Basic` is deprecated, use `Standard` instead. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Support.WebPubSubSkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription Id which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags of the service which is a list of key value pairs that describe the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +Get or set the user assigned identities + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.IWebPubSubIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Models.Api20220801Preview.IWebPubSubResource + +## 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 <IWebPubSubIdentity>`: Identity Parameter + - `[CertificateName <String>]`: Custom certificate name + - `[HubName <String>]`: The hub name. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[Name <String>]`: Custom domain name. + - `[PrivateEndpointConnectionName <String>]`: The name of the private endpoint connection + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ResourceName <String>]`: The name of the resource. + - `[SharedPrivateLinkResourceName <String>]`: The name of the shared private link resource + - `[SubscriptionId <String>]`: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`LIVETRACECATEGORY <ILiveTraceCategory[]>`: Gets or sets the list of category configurations. + - `[Enabled <String>]`: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. + - `[Name <String>]`: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. + +`PRIVATEENDPOINTACL <IPrivateEndpointAcl[]>`: ACLs for requests from private endpoints + - `Name <String>`: Name of the private endpoint connection + - `[Allow <WebPubSubRequestType[]>]`: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + - `[Deny <WebPubSubRequestType[]>]`: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + +`RESOURCELOGCATEGORY <IResourceLogCategory[]>`: Gets or sets the list of category configurations. + - `[Enabled <String>]`: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. + - `[Name <String>]`: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SpringCloud/Az.SpringCloud.md b/azps-10.1.0/Az.SpringCloud/Az.SpringCloud.md new file mode 100644 index 0000000000..ea9b671d1e --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Az.SpringCloud.md @@ -0,0 +1,225 @@ +--- +Module Name: Az.SpringCloud +Module Guid: 697e18d3-95de-4211-86a1-ec7c4e163874 +Download Help Link: https://learn.microsoft.com/powershell/module/az.springcloud +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Az.SpringCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Az.SpringCloud.md +--- + +# Az.SpringCloud Module +## Description +Microsoft Azure PowerShell: SpringCloud cmdlets + +## Az.SpringCloud Cmdlets +### [Deploy-AzSpringCloudApp](Deploy-AzSpringCloudApp.md) +Deploy the build file to an existing deployment. + +### [Disable-AzSpringCloudTestEndpoint](Disable-AzSpringCloudTestEndpoint.md) +Disable test endpoint functionality for a Service. + +### [Enable-AzSpringCloudTestEndpoint](Enable-AzSpringCloudTestEndpoint.md) +Enable test endpoint functionality for a Service. + +### [Get-AzSpringCloud](Get-AzSpringCloud.md) +Get a Service and its properties. + +### [Get-AzSpringCloudApp](Get-AzSpringCloudApp.md) +Get an App and its properties. + +### [Get-AzSpringCloudAppBinding](Get-AzSpringCloudAppBinding.md) +Get a Binding and its properties. + +### [Get-AzSpringCloudAppCustomDomain](Get-AzSpringCloudAppCustomDomain.md) +Get the custom domain of one lifecycle application. + +### [Get-AzSpringCloudAppDeployment](Get-AzSpringCloudAppDeployment.md) +Get a Deployment and its properties. + +### [Get-AzSpringCloudAppDeploymentLogFileUrl](Get-AzSpringCloudAppDeploymentLogFileUrl.md) +Get deployment log file URL + +### [Get-AzSpringCloudBuildpackBinding](Get-AzSpringCloudBuildpackBinding.md) +Get a buildpack binding by name. + +### [Get-AzSpringCloudBuildService](Get-AzSpringCloudBuildService.md) +Get a build service resource. + +### [Get-AzSpringCloudBuildServiceAgentPool](Get-AzSpringCloudBuildServiceAgentPool.md) +Get build service agent pool. + +### [Get-AzSpringCloudBuildServiceBuilder](Get-AzSpringCloudBuildServiceBuilder.md) +Get a KPack builder. + +### [Get-AzSpringCloudBuildServiceSupportedBuildpack](Get-AzSpringCloudBuildServiceSupportedBuildpack.md) +Get the supported buildpack resource. + +### [Get-AzSpringCloudBuildServiceSupportedStack](Get-AzSpringCloudBuildServiceSupportedStack.md) +Get the supported stack resource. + +### [Get-AzSpringCloudCertificate](Get-AzSpringCloudCertificate.md) +Get the certificate resource. + +### [Get-AzSpringCloudConfigServer](Get-AzSpringCloudConfigServer.md) +Get the config server and its properties. + +### [Get-AzSpringCloudConfigurationService](Get-AzSpringCloudConfigurationService.md) +Get the Application Configuration Service and its properties. + +### [Get-AzSpringCloudMonitoringSetting](Get-AzSpringCloudMonitoringSetting.md) +Get the Monitoring Setting and its properties. + +### [Get-AzSpringCloudRegistry](Get-AzSpringCloudRegistry.md) +Get the Service Registry and its properties. + +### [Get-AzSpringCloudRuntimeVersion](Get-AzSpringCloudRuntimeVersion.md) +Lists all of the available runtime versions supported by Microsoft.AppPlatform provider. + +### [Get-AzSpringCloudSku](Get-AzSpringCloudSku.md) +Lists all of the available skus of the Microsoft.AppPlatform provider. + +### [Get-AzSpringCloudTestKey](Get-AzSpringCloudTestKey.md) +List test keys for a Service. + +### [New-AzSpringCloud](New-AzSpringCloud.md) +Create a new Service or update an exiting Service. + +### [New-AzSpringCloudApp](New-AzSpringCloudApp.md) +Create a new App or update an exiting App. + +### [New-AzSpringCloudAppBinding](New-AzSpringCloudAppBinding.md) +Create a new Binding or update an exiting Binding. + +### [New-AzSpringCloudAppCustomDomain](New-AzSpringCloudAppCustomDomain.md) +Create or update custom domain of one lifecycle application. + +### [New-AzSpringCloudAppDeployment](New-AzSpringCloudAppDeployment.md) +Create a new Deployment or update an exiting Deployment. + +### [New-AzSpringCloudAppDeploymentBuildResultObject](New-AzSpringCloudAppDeploymentBuildResultObject.md) +Create an in-memory object for BuildResultUserSourceInfo. + +### [New-AzSpringCloudAppDeploymentJarUploadedObject](New-AzSpringCloudAppDeploymentJarUploadedObject.md) +Create an in-memory object for JarUploadedUserSourceInfo. + +### [New-AzSpringCloudAppDeploymentNetCoreZipUploadedObject](New-AzSpringCloudAppDeploymentNetCoreZipUploadedObject.md) +Create an in-memory object for NetCoreZipUploadedUserSourceInfo. + +### [New-AzSpringCloudAppDeploymentSourceUploadedObject](New-AzSpringCloudAppDeploymentSourceUploadedObject.md) +Create an in-memory object for SourceUploadedUserSourceInfo. + +### [New-AzSpringCloudAppLoadedCertificateObject](New-AzSpringCloudAppLoadedCertificateObject.md) +Create an in-memory object for LoadedCertificate. + +### [New-AzSpringCloudBuildpackBinding](New-AzSpringCloudBuildpackBinding.md) +Create or update a buildpack binding. + +### [New-AzSpringCloudBuildpackObject](New-AzSpringCloudBuildpackObject.md) +Create an in-memory object for BuildpackProperties. + +### [New-AzSpringCloudBuildpacksGroupObject](New-AzSpringCloudBuildpacksGroupObject.md) +Create an in-memory object for BuildpacksGroupProperties. + +### [New-AzSpringCloudBuildServiceAgentPool](New-AzSpringCloudBuildServiceAgentPool.md) +Create or update build service agent pool. + +### [New-AzSpringCloudBuildServiceBuilder](New-AzSpringCloudBuildServiceBuilder.md) +Create or update a KPack builder. + +### [New-AzSpringCloudCertificate](New-AzSpringCloudCertificate.md) +Create or update certificate resource. + +### [New-AzSpringCloudConfigurationService](New-AzSpringCloudConfigurationService.md) +Create the default Application Configuration Service or update the existing Application Configuration Service. + +### [New-AzSpringCloudConfigurationServiceGitRepositoryObject](New-AzSpringCloudConfigurationServiceGitRepositoryObject.md) +Create an in-memory object for ConfigurationServiceGitRepository. + +### [New-AzSpringCloudContentCertificateObject](New-AzSpringCloudContentCertificateObject.md) +Create an in-memory object for ContentCertificateProperties. + +### [New-AzSpringCloudGitPatternRepositoryObject](New-AzSpringCloudGitPatternRepositoryObject.md) +Create an in-memory object for GitPatternRepository. + +### [New-AzSpringCloudKeyVaultCertificateObject](New-AzSpringCloudKeyVaultCertificateObject.md) +Create an in-memory object for KeyVaultCertificateProperties. + +### [New-AzSpringCloudTestKey](New-AzSpringCloudTestKey.md) +Regenerate a test key for a Service. + +### [Remove-AzSpringCloud](Remove-AzSpringCloud.md) +Operation to delete a Service. + +### [Remove-AzSpringCloudApp](Remove-AzSpringCloudApp.md) +Operation to delete an App. + +### [Remove-AzSpringCloudAppBinding](Remove-AzSpringCloudAppBinding.md) +Operation to delete a Binding. + +### [Remove-AzSpringCloudAppCustomDomain](Remove-AzSpringCloudAppCustomDomain.md) +Delete the custom domain of one lifecycle application. + +### [Remove-AzSpringCloudAppDeployment](Remove-AzSpringCloudAppDeployment.md) +Operation to delete a Deployment. + +### [Remove-AzSpringCloudBuildpackBinding](Remove-AzSpringCloudBuildpackBinding.md) +Operation to delete a Buildpack Binding + +### [Remove-AzSpringCloudBuildServiceBuilder](Remove-AzSpringCloudBuildServiceBuilder.md) +Delete a KPack builder. + +### [Remove-AzSpringCloudCertificate](Remove-AzSpringCloudCertificate.md) +Delete the certificate resource. + +### [Remove-AzSpringCloudConfigurationService](Remove-AzSpringCloudConfigurationService.md) +Disable the default Application Configuration Service. + +### [Restart-AzSpringCloudAppDeployment](Restart-AzSpringCloudAppDeployment.md) +Restart the deployment. + +### [Start-AzSpringCloudAppDeployment](Start-AzSpringCloudAppDeployment.md) +Start the deployment. + +### [Start-AzSpringCloudAppDeploymentJfr](Start-AzSpringCloudAppDeploymentJfr.md) +Start JFR + +### [Stop-AzSpringCloudAppDeployment](Stop-AzSpringCloudAppDeployment.md) +Stop the deployment. + +### [Test-AzSpringCloudAppCustomDomain](Test-AzSpringCloudAppCustomDomain.md) +Check the resource name is valid as well as not in use. + +### [Test-AzSpringCloudConfigServer](Test-AzSpringCloudConfigServer.md) +Check if the config server settings are valid. + +### [Test-AzSpringCloudConfigurationService](Test-AzSpringCloudConfigurationService.md) +Check if the Application Configuration Service settings are valid. + +### [Test-AzSpringCloudNameAvailability](Test-AzSpringCloudNameAvailability.md) +Checks that the resource name is valid and is not already in use. + +### [Update-AzSpringCloud](Update-AzSpringCloud.md) +Operation to update an exiting Service. + +### [Update-AzSpringCloudApp](Update-AzSpringCloudApp.md) +Operation to update an exiting App. + +### [Update-AzSpringCloudAppActiveDeployment](Update-AzSpringCloudAppActiveDeployment.md) +Set existing Deployment under the app as active + +### [Update-AzSpringCloudAppBinding](Update-AzSpringCloudAppBinding.md) +Operation to update an exiting Binding. + +### [Update-AzSpringCloudAppCustomDomain](Update-AzSpringCloudAppCustomDomain.md) +Update custom domain of one lifecycle application. + +### [Update-AzSpringCloudAppDeployment](Update-AzSpringCloudAppDeployment.md) +Operation to update an exiting Deployment. + +### [Update-AzSpringCloudConfigServer](Update-AzSpringCloudConfigServer.md) +Update the config server. + +### [Update-AzSpringCloudMonitoringSetting](Update-AzSpringCloudMonitoringSetting.md) +Update the Monitoring Setting. + diff --git a/azps-10.1.0/Az.SpringCloud/Deploy-AzSpringCloudApp.md b/azps-10.1.0/Az.SpringCloud/Deploy-AzSpringCloudApp.md new file mode 100644 index 0000000000..bade6d7cb0 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Deploy-AzSpringCloudApp.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.SpringCloud/deploy-azSpringCloudapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Deploy-AzSpringCloudApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Deploy-AzSpringCloudApp.md +--- + +# Deploy-AzSpringCloudApp + +## SYNOPSIS +Deploy the build file to an existing deployment. + +## SYNTAX + +### DeployAppForStandard (Default) +``` +Deploy-AzSpringCloudApp -FilePath <String> -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeployAppForEnterprise +``` +Deploy-AzSpringCloudApp -AgentPoolId <String> -BuilderId <String> -FilePath <String> -Name <String> + -ResourceGroupName <String> -ServiceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deploy the build file to an existing deployment. + +## EXAMPLES + +### Example 1: Deploy the build file to an standard spring app +```powershell +$jarObj = New-AzSpringCloudAppDeploymentJarUploadedObject -RuntimeVersion "Java_8" +New-AzSpringCloudAppDeployment -ResourceGroupName springcloud-rg-0zquav -ServiceName spring-va4fsz -AppName account -Name green -Source $jarObj +Get-AzSpringCloudApp -ResourceGroupName springcloud-rg-0zquav -ServiceName spring-va4fsz -Name account | Update-AzSpringCloudAppActiveDeployment -DeploymentName 'green' +Deploy-AzSpringCloudApp -ResourceGroupName springcloud-rg-0zquav -ServiceName spring-va4fsz -Name account -FilePath "C:\Users\v-diya\Downloads\hellospring\target\hellospring-0.0.1-SNAPSHOT.jar" +``` + +```output +[1/3] Requesting for upload URL +[2/3] Uploading package to blob +[3/3] Updating deployment in app demo (this operation can take a while to complete) + +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +green 6/24/2022 6:50:58 AM v-test@microsoft.com User 7/19/2022 7:06:08 AM v-test@microsoft.com User spring-rg-test +``` + +This command deploy the build file to an standard spring app. + +### Example 2: Deploy the build file to an enterprise spring app +```powershell +$source = New-AzSpringCloudAppDeploymentBuildResultObject +New-AzSpringCloudAppDeployment -ResourceGroupName springcloud-rg-0zquav -ServiceName spring-f7lz2n -AppName account -Name green -Source $source +Get-AzSpringCloudApp -ResourceGroupName springcloud-rg-0zquav -ServiceName spring-f7lz2n -Name account | Update-AzSpringCloudAppActiveDeployment -DeploymentName 'green' +$builder = Get-AzSpringCloudBuildServiceBuilder -ResourceGroupName springcloud-rg-0zquav -ServiceName spring-f7lz2n -Name default +$agentPool = Get-AzSpringCloudBuildServiceAgentPool -ResourceGroupName springcloud-rg-0zquav -ServiceName spring-f7lz2n +Deploy-AzSpringCloudApp -ResourceGroupName springcloud-rg-0zquav -ServiceName spring-f7lz2n -Name account -AgentPoolId $agentPool.Id -BuilderId $builder.Id -FilePath "C:\Users\v-diya\Downloads\hellospring\target\hellospring-0.0.1-SNAPSHOT.jar" +``` + +```output +[1/3] Requesting for upload URL +[2/3] Uploading package to blob +[3/3] Updating deployment in app demo (this operation can take a while to complete) + +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +green 6/24/2022 6:50:58 AM v-test@microsoft.com User 7/19/2022 7:06:08 AM v-test@microsoft.com User spring-rg-test +``` + +This command deploy the build file to an enterprise spring app. + +## PARAMETERS + +### -AgentPoolId +The resource id of agent pool. + +```yaml +Type: System.String +Parameter Sets: DeployAppForEnterprise +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BuilderId +The resource id of builder to build the source code. + +```yaml +Type: System.String +Parameter Sets: DeployAppForEnterprise +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +The path of the file need to be deploied. +The file supports Jar, NetcoreZip and Source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IAppResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Disable-AzSpringCloudTestEndpoint.md b/azps-10.1.0/Az.SpringCloud/Disable-AzSpringCloudTestEndpoint.md new file mode 100644 index 0000000000..17c1a8d803 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Disable-AzSpringCloudTestEndpoint.md @@ -0,0 +1,217 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/disable-azspringcloudtestendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Disable-AzSpringCloudTestEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Disable-AzSpringCloudTestEndpoint.md +--- + +# Disable-AzSpringCloudTestEndpoint + +## SYNOPSIS +Disable test endpoint functionality for a Service. + +## SYNTAX + +### Disable (Default) +``` +Disable-AzSpringCloudTestEndpoint -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DisableViaIdentity +``` +Disable-AzSpringCloudTestEndpoint -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Disable test endpoint functionality for a Service. + +## EXAMPLES + +### Example 1: Disable test endpoint functionality for a Service +```powershell +Disable-AzSpringCloudTestEndpoint -ResourceGroupName SpringCloud-gp-junxi -Name springcloud-service +``` + +Disable test endpoint functionality for a Service. + +### Example 2: Disable test endpoint functionality for a Service by pipeline +```powershell +Get-AzSpringCloud -ResourceGroupName lucas-rg-test -Name springapp-pwsh01 | Disable-AzSpringCloudTestEndpoint +``` + +Disable test endpoint functionality for a Service by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: DisableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Enable-AzSpringCloudTestEndpoint.md b/azps-10.1.0/Az.SpringCloud/Enable-AzSpringCloudTestEndpoint.md new file mode 100644 index 0000000000..78e1ad7c07 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Enable-AzSpringCloudTestEndpoint.md @@ -0,0 +1,214 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/enable-azspringcloudtestendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Enable-AzSpringCloudTestEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Enable-AzSpringCloudTestEndpoint.md +--- + +# Enable-AzSpringCloudTestEndpoint + +## SYNOPSIS +Enable test endpoint functionality for a Service. + +## SYNTAX + +### Enable (Default) +``` +Enable-AzSpringCloudTestEndpoint -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### EnableViaIdentity +``` +Enable-AzSpringCloudTestEndpoint -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Enable test endpoint functionality for a Service. + +## EXAMPLES + +### Example 1: Enable test endpoint functionality for a Service +```powershell +Enable-AzSpringCloudTestEndpoint -ResourceGroupName SpringCloud-gp-junxi -Name springcloud-service -debug +``` + +```output +Enabled PrimaryKey PrimaryTestEndpoint +------- ---------- ------------------- +True ******* https://primary:EZ0RH3NEDunYBmnAiK7LebCGpruoO… +``` + +Enable test endpoint functionality for a Service. + +### Example 2: Enable test endpoint functionality for a Service by pipeline +```powershell +Get-AzSpringCloud -ResourceGroupName lucas-rg-test -Name springapp-pwsh01 | Disable-AzSpringCloudTestEndpoint +``` + +```output +Enabled PrimaryKey PrimaryTestEndpoint +------- ---------- ------------------- +True **************************************************************** https://primary:EZ0RH3NEDunYBmnAiK7LebCGpruoO… +``` + +Enable test endpoint functionality for a Service by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: EnableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Enable +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ITestKeys + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloud.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloud.md new file mode 100644 index 0000000000..f8177b7707 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloud.md @@ -0,0 +1,219 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloud.md +--- + +# Get-AzSpringCloud + +## SYNOPSIS +Get a Service and its properties. + +## SYNTAX + +### List (Default) +``` +Get-AzSpringCloud [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSpringCloud -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloud -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzSpringCloud -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a Service and its properties. + +## EXAMPLES + +### Example 1: Get Spring Cloud Service by name +```powershell +Get-AzSpringCloud -ResourceGroupName springcloudrg -Name spring-portal02 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +eastus spring-portal02 7/21/2022 3:02:40 AM v-diya@microsoft.com User 7/21/2022 3:02:40 AM v-diya@microsoft.com User springcloudrg : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.Error +``` + +Get Spring Cloud Service by name. + +### Example 2: List all the spring cloud service under the resource group +```powershell +Get-AzSpringCloud -ResourceGroupName spring-cloud-rg +``` + +```output +Location Name Type +-------- ---- ---- +eastus spring-cloud-rg Microsoft.AppPlatform/Spring +``` + +List all the spring cloud service under the resource group. + +### Example 3: List all the spring cloud service under the subscription +```powershell +Get-AzSpringCloud +``` + +```output +Location Name Type +-------- ---- ---- +eastus spring-cloud-rg Microsoft.AppPlatform/Spring +``` + +List all the spring cloud service under the subscription. + +### Example 4: Get Spring Cloud Service by pipeline +```powershell +New-AzSpringCloud -ResourceGroupName springcloudrg -Name spring-pwsh01 -Location eastus | Get-AzSpringCloud +``` + +```output +Location Name Type +-------- ---- ---- +eastus spring-cloud-rg Microsoft.AppPlatform/Spring +``` + +Get Spring Cloud Service by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IServiceResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudApp.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudApp.md new file mode 100644 index 0000000000..b10b1af891 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudApp.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudApp.md +--- + +# Get-AzSpringCloudApp + +## SYNOPSIS +Get an App and its properties. + +## SYNTAX + +### List (Default) +``` +Get-AzSpringCloudApp -ResourceGroupName <String> -ServiceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSpringCloudApp -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-SyncStatus <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudApp -InputObject <ISpringCloudIdentity> [-SyncStatus <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get an App and its properties. + +## EXAMPLES + +### Example 1: Get all App under the spring service +```powershell +Get-AzSpringCloudApp -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ +plugin 2022/6/28 9:15:47 *********@microsoft.com User 2022/6/28 9:15:47 *********@microsoft.com +tools 2022/6/28 8:33:27 *********@microsoft.com User 2022/6/28 8:33:27 *********@microsoft.com +``` + +Get all App under the spring service. + +### Example 2: Get an App and its properties +```powershell +Get-AzSpringCloudApp -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -Name tools +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ +tools 2022/6/28 8:33:27 *********@microsoft.com User 2022/6/28 8:33:27 *********@microsoft.com +``` + +Get an App and its properties. + +### Example 3: Get an App and its properties by pipeline +```powershell +New-AzSpringCloudApp -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -Name tools | Get-AzSpringCloudApp +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ +tools 2022/6/28 8:33:27 *********@microsoft.com User 2022/6/28 8:33:27 *********@microsoft.com +``` + +Get an App and its properties by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AppName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncStatus +Indicates whether sync status + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IAppResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudAppBinding.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudAppBinding.md new file mode 100644 index 0000000000..c45ecc13ed --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudAppBinding.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudappbinding +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudAppBinding.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudAppBinding.md +--- + +# Get-AzSpringCloudAppBinding + +## SYNOPSIS +Get a Binding and its properties. + +## SYNTAX + +### List (Default) +``` +Get-AzSpringCloudAppBinding -AppName <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSpringCloudAppBinding -AppName <String> -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudAppBinding -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a Binding and its properties. + +## EXAMPLES + +### Example 1: Get all Binding under the spring app +```powershell + Get-AzSpringCloudAppBinding -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName gateway +``` + +```output +Name +---- +redis +``` + +Get all Binding under the spring app. + +### Example 2: Get a Binding and its properties +```powershell +Get-AzSpringCloudAppBinding -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName gateway -Name redis +``` + +```output +Name +---- +redis +``` + +Get a Binding and its properties. + +### Example 3: Get a Binding and its properties by pipeline +```powershell +New-AzSpringCloudAppBinding -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -name redis -Key myKey -ResourceId myResourceId -AppName tools -BindingParameter @{ "useSsl"= "true" } | Get-AzSpringCloudAppBinding +``` + +```output +Name +---- +redis +``` + +Get a Binding and its properties by pipeline. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Binding resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: BindingName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IBindingResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudAppCustomDomain.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudAppCustomDomain.md new file mode 100644 index 0000000000..082d77feea --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudAppCustomDomain.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudappcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudAppCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudAppCustomDomain.md +--- + +# Get-AzSpringCloudAppCustomDomain + +## SYNOPSIS +Get the custom domain of one lifecycle application. + +## SYNTAX + +### List (Default) +``` +Get-AzSpringCloudAppCustomDomain -AppName <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSpringCloudAppCustomDomain -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudAppCustomDomain -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the custom domain of one lifecycle application. + +## EXAMPLES + +### Example 1: Get the custom domain of all lifecycle applications +```powershell + Get-AzSpringCloudAppCustomDomain -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName gateway +``` + +```output +Name + +---- +springcloud-service.azuremicroservices.io +``` + +Get the custom domain of all lifecycle applications. + +### Example 2: Get the custom domain of one lifecycle application +```powershell +Get-AzSpringCloudAppCustomDomain -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName gateway -Name springcloud-service.azuremicroservices.io +``` + +```output +Name + +---- +springcloud-service.azuremicroservices.io +``` + +Get the custom domain of one lifecycle application. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the custom domain resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ICustomDomainResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudAppDeployment.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudAppDeployment.md new file mode 100644 index 0000000000..d156a6db6f --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudAppDeployment.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudappdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudAppDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudAppDeployment.md +--- + +# Get-AzSpringCloudAppDeployment + +## SYNOPSIS +Get a Deployment and its properties. + +## SYNTAX + +### List1 (Default) +``` +Get-AzSpringCloudAppDeployment -ResourceGroupName <String> -ServiceName <String> [-SubscriptionId <String[]>] + [-Version <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSpringCloudAppDeployment -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudAppDeployment -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzSpringCloudAppDeployment -AppName <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-Version <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a Deployment and its properties. + +## EXAMPLES + +### Example 1: Get Spring Cloud App Deploymeng by name +```powershell +Get-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -DeploymentName default +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +jardemo 7/25/2022 9:29:46 AM v-diya@microsoft.com User 7/25/2022 9:38:28 AM v-diya@microsoft.com User springcloudrg +``` + +Get Spring Cloud App Deploymeng by name. + +### Example 2: List all the deployment under a given spring cloud app +```powershell +Get-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +jardemo 7/25/2022 9:29:46 AM v-diya@microsoft.com User 7/25/2022 9:38:28 AM v-diya@microsoft.com User springcloudrg +``` + +List all the deployment under a given spring cloud app. + +### Example 3: List all the deployment under a given subscription +```powershell +Get-AzSpringCloudAppDeployment -ResourceGroupName 'springcloudrg' -ServiceName 'standardspring-demo' +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +jardemo 7/25/2022 9:29:46 AM v-diya@microsoft.com User 7/25/2022 9:38:28 AM v-diya@microsoft.com User springcloudrg +``` + +List all the deployment under a given subscription. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Deployment resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DeploymentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get, List, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version of the deployments to be listed + +```yaml +Type: System.String[] +Parameter Sets: List, List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IDeploymentResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudAppDeploymentLogFileUrl.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudAppDeploymentLogFileUrl.md new file mode 100644 index 0000000000..c0d32b9d5b --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudAppDeploymentLogFileUrl.md @@ -0,0 +1,256 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudappdeploymentlogfileurl +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudAppDeploymentLogFileUrl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudAppDeploymentLogFileUrl.md +--- + +# Get-AzSpringCloudAppDeploymentLogFileUrl + +## SYNOPSIS +Get deployment log file URL + +## SYNTAX + +### Get (Default) +``` +Get-AzSpringCloudAppDeploymentLogFileUrl -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudAppDeploymentLogFileUrl -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Get deployment log file URL + +## EXAMPLES + +### Example 1: Get deployment log file URL +```powershell +Get-AzSpringCloudAppDeploymentLogFileUrl -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 -AppName tools -Name default +``` + +```output +url :"https://xxxxxxxxxxxxxxxxxxxxxxxxxxx.blob.core.windows.net/8a34c541b97d45c591d5749e7ec77913/logs/?sv=2018-03-28&sr=b&sig=yAh3I%2B1P9pfSRknfOy%2BCheeomZNoKM9R1brvzj2OTtw%3D&se=2022-07-13T10%3A15%3A46Z&sp=r" +``` + +Get deployment log file URL. + +### Example 2: Get deployment log file URL by pipeline +```powershell +Get-AzSpringCloudAppDeployment -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 -AppName tools -Name default | Get-AzSpringCloudAppDeploymentLogFileUrl +``` + +```output +url :"https://xxxxxxxxxxxxxxxxxxxxxxxxxxx.blob.core.windows.net/8a34c541b97d45c591d5749e7ec77913/logs/?sv=2018-03-28&sr=b&sig=yAh3I%2B1P9pfSRknfOy%2BCheeomZNoKM9R1brvzj2OTtw%3D&se=2022-07-13T10%3A15%3A46Z&sp=r" +``` + +Get deployment log file URL by pipeline. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Deployment resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildService.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildService.md new file mode 100644 index 0000000000..56b3df8d92 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildService.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudbuildservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudBuildService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudBuildService.md +--- + +# Get-AzSpringCloudBuildService + +## SYNOPSIS +Get a build service resource. + +## SYNTAX + +### Get (Default) +``` +Get-AzSpringCloudBuildService -ResourceGroupName <String> -ServiceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudBuildService -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a build service resource. + +## EXAMPLES + +### Example 1: Get a build service resource of the enterprise spring cloud +```powershell +Get-AzSpringCloudBuildService -ResourceGroupName springcloudrg -ServiceName sspring-portal01 +``` + +```output +Name ResourceGroupName ProvisioningState KPackVersion ResourceRequestCpu ResourceRequestMemory +---- ----------------- ----------------- ------------ ------------------ --------------------- +default springcloudrg Succeeded 0.5.2 2 4Gi +``` + +Get a build service resource of the enterprise spring cloud. + +### Example 2: Get a build service resource of the enterprise spring cloud by id +```powershell +Get-AzSpringCloudBuildService -InputObject "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/springcloudrg/providers/Microsoft.AppPlatform/Spring/sspring-portal01/buildServices/default" +``` + +```output +Name ResourceGroupName ProvisioningState KPackVersion ResourceRequestCpu ResourceRequestMemory +---- ----------------- ----------------- ------------ ------------------ --------------------- +default springcloudrg Succeeded 0.5.2 2 4Gi +``` + +Get a build service resource of the enterprise spring cloud. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IBuildService + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildServiceAgentPool.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildServiceAgentPool.md new file mode 100644 index 0000000000..3385991a3b --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildServiceAgentPool.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudbuildserviceagentpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudBuildServiceAgentPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudBuildServiceAgentPool.md +--- + +# Get-AzSpringCloudBuildServiceAgentPool + +## SYNOPSIS +Get build service agent pool. + +## SYNTAX + +### Get (Default) +``` +Get-AzSpringCloudBuildServiceAgentPool -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudBuildServiceAgentPool -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get build service agent pool. + +## EXAMPLES + +### Example 1: Get a build service agent pool +```powershell +Get-AzSpringCloudBuildServiceAgentPool -ResourceGroupName springcloudrg -ServiceName sspring-portal01 +``` + +```output +Name ResourceGroupName ProvisioningState PoolSizeCpu PoolSizeMemory PoolSizeName +---- ----------------- ----------------- ----------- -------------- ------------ +default springcloudrg Succeeded 2 4Gi S1 +``` + +Get a build service agent pool. + +### Example 2: Get a build service agent pool by pipeline +```powershell +New-AzSpringCloudBuildServiceAgentPool -ResourceGroupName springcloudrg -ServiceName espring-pwsh01 -PoolSizeName "S1" | Get-AzSpringCloudBuildServiceAgentPool +``` + +```output +Name ResourceGroupName ProvisioningState PoolSizeCpu PoolSizeMemory PoolSizeName +---- ----------------- ----------------- ----------- -------------- ------------ +default springcloudrg Succeeded 2 4Gi S1 +``` + +Get a build service agent pool by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IBuildServiceAgentPoolResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildServiceBuilder.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildServiceBuilder.md new file mode 100644 index 0000000000..8ca65da7cc --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildServiceBuilder.md @@ -0,0 +1,217 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudbuildservicebuilder +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudBuildServiceBuilder.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudBuildServiceBuilder.md +--- + +# Get-AzSpringCloudBuildServiceBuilder + +## SYNOPSIS +Get a KPack builder. + +## SYNTAX + +### List (Default) +``` +Get-AzSpringCloudBuildServiceBuilder -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSpringCloudBuildServiceBuilder -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudBuildServiceBuilder -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a KPack builder. + +## EXAMPLES + +### Example 1: List all KPack builder +```powershell +Get-AzSpringCloudBuildServiceBuilder -ResourceGroupName springcloudrg -ServiceName sspring-portal01 +``` + +```output +Name ResourceGroupName ProvisioningState StackId StackVersion +---- ----------------- ----------------- ------- ------------ +default springcloudrg Succeeded io.buildpacks.stacks.bionic base +``` + +List all KPack builder. + +### Example 2: List all KPack builders under build service +```powershell +Get-AzSpringCloudBuildServiceBuilder -ResourceGroupName springcloudrg -ServiceName sspring-portal01 -Name default +``` + +```output +Name ResourceGroupName ProvisioningState StackId StackVersion +---- ----------------- ----------------- ------- ------------ +default springcloudrg Succeeded io.buildpacks.stacks.bionic base +``` + +List all KPack builders under build service. + +### Example 2: Get a KPack builder by pipeline +```powershell +New-AzSpringCloudBuildServiceBuilder -ResourceGroupName springcloudrg -ServiceName sspring-portal01 -Name builder03 -StackId 'io.buildpacks.stacks.bionic' -StackVersion 'base' | Get-AzSpringCloudBuildServiceBuilder +``` + +```output +Name ResourceGroupName ProvisioningState StackId StackVersion +---- ----------------- ----------------- ------- ------------ +builder01 springcloudrg Succeeded io.buildpacks.stacks.bionic base +``` + +Get a KPack builder by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the builder resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IBuilderResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildServiceSupportedBuildpack.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildServiceSupportedBuildpack.md new file mode 100644 index 0000000000..a5f8522931 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildServiceSupportedBuildpack.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudbuildservicesupportedbuildpack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudBuildServiceSupportedBuildpack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudBuildServiceSupportedBuildpack.md +--- + +# Get-AzSpringCloudBuildServiceSupportedBuildpack + +## SYNOPSIS +Get the supported buildpack resource. + +## SYNTAX + +### List (Default) +``` +Get-AzSpringCloudBuildServiceSupportedBuildpack -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSpringCloudBuildServiceSupportedBuildpack -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudBuildServiceSupportedBuildpack -InputObject <ISpringCloudIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the supported buildpack resource. + +## EXAMPLES + +### Example 1: Get all supported buildpack resource. +```powershell +Get-AzSpringCloudBuildServiceSupportedBuildpack -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 +``` + +```output +Name ResourceGroupName BuildpackId +---- ----------------- ----------- +tanzu-buildpacks-java-azure springcloudrg tanzu-buildpacks/java-azure +tanzu-buildpacks-dotnet-core springcloudrg tanzu-buildpacks/dotnet-core +tanzu-buildpacks-go springcloudrg tanzu-buildpacks/go +tanzu-buildpacks-nodejs springcloudrg tanzu-buildpacks/nodejs +tanzu-buildpacks-python springcloudrg tanzu-buildpacks/python +``` + +Get all supported buildpack resource. + +### Example 2: Get the supported buildpack resource by name +```powershell +Get-AzSpringCloudBuildServiceSupportedBuildpack -ResourceGroupName springcloudrg -ServiceName sspring-portal01 -Name tanzu-buildpacks-python +``` + +```output +Name ResourceGroupName BuildpackId +---- ----------------- ----------- +tanzu-buildpacks-python springcloudrg tanzu-buildpacks/python +``` + +Get the supported buildpack resource by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the buildpack resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ISupportedBuildpackResource + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ISupportedBuildpacksCollection + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildServiceSupportedStack.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildServiceSupportedStack.md new file mode 100644 index 0000000000..448d488434 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildServiceSupportedStack.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudbuildservicesupportedstack +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudBuildServiceSupportedStack.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudBuildServiceSupportedStack.md +--- + +# Get-AzSpringCloudBuildServiceSupportedStack + +## SYNOPSIS +Get the supported stack resource. + +## SYNTAX + +### List (Default) +``` +Get-AzSpringCloudBuildServiceSupportedStack -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSpringCloudBuildServiceSupportedStack -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudBuildServiceSupportedStack -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the supported stack resource. + +## EXAMPLES + +### Example 1: Get all supported stack resource +```powershell +Get-AzSpringCloudBuildServiceSupportedStack -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 +``` + +```output +Name ResourceGroupName StackId Version +---- ----------------- ------- ------- +io.buildpacks.stacks.bionic-base springcloudrg io.buildpacks.stacks.bionic base +io.buildpacks.stacks.bionic-full springcloudrg io.buildpacks.stacks.bionic full +``` + +Get all supported stack resource. + +### Example 2: Get the supported stack resource +```powershell +Get-AzSpringCloudBuildServiceSupportedStack -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 -Name io.buildpacks.stacks.bionic-full +``` + +```output +Name ResourceGroupName StackId Version +---- ----------------- ------- ------- +io.buildpacks.stacks.bionic-base springcloudrg io.buildpacks.stacks.bionic base +``` + +Get the supported stack resource. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the stack resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ISupportedStackResource + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ISupportedStacksCollection + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildpackBinding.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildpackBinding.md new file mode 100644 index 0000000000..560875ec37 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudBuildpackBinding.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudbuildpackbinding +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudBuildpackBinding.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudBuildpackBinding.md +--- + +# Get-AzSpringCloudBuildpackBinding + +## SYNOPSIS +Get a buildpack binding by name. + +## SYNTAX + +### List (Default) +``` +Get-AzSpringCloudBuildpackBinding -BuilderName <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSpringCloudBuildpackBinding -BuilderName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudBuildpackBinding -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a buildpack binding by name. + +## EXAMPLES + +### Example 1: List all buildpack binding +```powershell +Get-AzSpringCloudBuildpackBinding -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 -BuilderName default +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModi + fiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------ +default 2022/7/13 3:26:33 *********@microsoft.com User 2022/7/13 3:26:33 *********@microso… +``` + +List all buildpack binding. + +### Example 2: Get a buildpack binding by name +```powershell +Get-AzSpringCloudBuildpackBinding -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 -BuilderName default -Name default +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModi + fiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------ +default 2022/7/13 3:26:33 *********@microsoft.com User 2022/7/13 3:26:33 *********@microso… +``` + +Get a buildpack binding by name. + +### Example 2: Get a buildpack binding by pipeline +```powershell +New-AzSpringCloudBuildpackBinding -ResourceGroupName springcloudrg -ServiceName sspring-portal01 -BuilderName default -Name binging01 -BindingType 'AppDynamics' | Get-AzSpringCloudBuildpackBinding +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModi + fiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------ +binging01 2022/7/13 3:26:33 *********@microsoft.com User 2022/7/13 3:26:33 *********@microso… +``` + +Get a buildpack binding by pipeline. + +## PARAMETERS + +### -BuilderName +The name of the builder resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Buildpack Binding Name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: BuildpackBindingName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IBuildpackBindingResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudCertificate.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudCertificate.md new file mode 100644 index 0000000000..8712f528cb --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudCertificate.md @@ -0,0 +1,204 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudCertificate.md +--- + +# Get-AzSpringCloudCertificate + +## SYNOPSIS +Get the certificate resource. + +## SYNTAX + +### List (Default) +``` +Get-AzSpringCloudCertificate -ResourceGroupName <String> -ServiceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSpringCloudCertificate -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudCertificate -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the certificate resource. + +## EXAMPLES + +### Example 1: List all the certificate resource under a spring service +```powershell +Get-AzSpringCloudCertificate -ResourceGroupName lucas-rg-test -ServiceName springapp-pwsh01 +``` + +```output +Name ResourceGroupName +---- ----------------- +cert01 lucas-rg-test +``` + +List all the certificate resource under a spring service. + +### Example 2: Get a certificate resource by name +```powershell +Get-AzSpringCloudCertificate -ResourceGroupName lucas-rg-test -ServiceName springapp-pwsh01 -Name cert01 +``` + +```output +Name ResourceGroupName +---- ----------------- +cert01 lucas-rg-test +``` + +Get a certificate resource by name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the certificate resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ICertificateResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudConfigServer.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudConfigServer.md new file mode 100644 index 0000000000..3121af6c86 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudConfigServer.md @@ -0,0 +1,170 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudconfigserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudConfigServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudConfigServer.md +--- + +# Get-AzSpringCloudConfigServer + +## SYNOPSIS +Get the config server and its properties. + +## SYNTAX + +### Get (Default) +``` +Get-AzSpringCloudConfigServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudConfigServer -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the config server and its properties. + +## EXAMPLES + +### Example 1: Get all properties of the config server +```powershell +Get-AzSpringCloudConfigServer -ResourceGroupName "springcloud-rg-0zquav" -Name "spring-f7lz2n" +``` + +```output +Name ResourceGroupName ProvisioningState +---- ----------------- ----------------- +default springcloudrg Succeeded +``` + +Get all properties of the config server. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IConfigServerResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudConfigurationService.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudConfigurationService.md new file mode 100644 index 0000000000..ad6913ce5b --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudConfigurationService.md @@ -0,0 +1,185 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudconfigurationservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudConfigurationService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudConfigurationService.md +--- + +# Get-AzSpringCloudConfigurationService + +## SYNOPSIS +Get the Application Configuration Service and its properties. + +## SYNTAX + +### Get (Default) +``` +Get-AzSpringCloudConfigurationService -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudConfigurationService -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the Application Configuration Service and its properties. + +## EXAMPLES + +### Example 1: Get all Application Configuration Service and its properties +```powershell +Get-AzSpringCloudConfigurationService -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedB + y +---- ------------------- ------------------- ----------------------- ------------------------ ----------------------- +default 2022/7/13 3:26:33 v-junxisu@microsoft.com User 2022/7/13 7:46:06 v-junxisu@microsoft.com +``` + +Get all Application Configuration Service and its properties. + +### Example 2: Get the Application Configuration Service and its properties +```powershell +Get-AzSpringCloudConfigurationService -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedB + y +---- ------------------- ------------------- ----------------------- ------------------------ ----------------------- +default 2022/7/13 3:26:33 v-junxisu@microsoft.com User 2022/7/13 7:46:06 v-junxisu@microsoft.com +``` + +Get the Application Configuration Service and its properties. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IConfigurationServiceResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudMonitoringSetting.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudMonitoringSetting.md new file mode 100644 index 0000000000..c5f3bb6e1e --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudMonitoringSetting.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudmonitoringsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudMonitoringSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudMonitoringSetting.md +--- + +# Get-AzSpringCloudMonitoringSetting + +## SYNOPSIS +Get the Monitoring Setting and its properties. + +## SYNTAX + +### Get (Default) +``` +Get-AzSpringCloudMonitoringSetting -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudMonitoringSetting -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the Monitoring Setting and its properties. + +## EXAMPLES + +### Example 1: Get the Monitoring Setting and its properties +```powershell +Get-AzSpringCloudMonitoringSetting -ResourceGroupName SpringCloud-gp-junxi -Name springcloud-service +``` + +```output +Name ResourceGroupName ProvisioningState TraceEnabled +---- ----------------- ----------------- ------------ +default azurespringrg Succeeded True +``` + +Get the Monitoring Setting and its properties. + +### Example 2: Get the Monitoring Setting and its properties by pipeline +```powershell + Update-AzSpringCloudMonitoringSetting -AppInsightsInstrumentationKey "InstrumentationKey=xxxxxxxxxxxxxxxxxxx;IngestionEndpoint=https://xxxxxx.in.applicationinsights.azure.com/;LiveEndpoint=https://eastus.livediagnostics.monitor.azure.com/" | Get-AzSpringCloudMonitoringSetting +``` + +```output +Name ResourceGroupName ProvisioningState TraceEnabled +---- ----------------- ----------------- ------------ +default azurespringrg Succeeded True +``` + +Get the Monitoring Setting and its properties by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IMonitoringSettingResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudRegistry.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudRegistry.md new file mode 100644 index 0000000000..6690cba9af --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudRegistry.md @@ -0,0 +1,185 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudregistry +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudRegistry.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudRegistry.md +--- + +# Get-AzSpringCloudRegistry + +## SYNOPSIS +Get the Service Registry and its properties. + +## SYNTAX + +### Get (Default) +``` +Get-AzSpringCloudRegistry -ResourceGroupName <String> -ServiceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSpringCloudRegistry -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get the Service Registry and its properties. + +## EXAMPLES + +### Example 1: Get all Service Registry and its properties +```powershell +Get-AzSpringCloudRegistry -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedB + y +---- ------------------- ------------------- ----------------------- ------------------------ ----------------------- +default 2022/7/13 3:26:33 v-junxisu@microsoft.com User 2022/7/13 3:26:33 v-junxisu@microsoft.com +``` + +Get all Service Registry and its properties + +### Example 2: Get the Service Registry and its properties. +```powershell +Get-AzSpringCloudRegistry -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedB + y +---- ------------------- ------------------- ----------------------- ------------------------ ----------------------- +default 2022/7/13 3:26:33 v-junxisu@microsoft.com User 2022/7/13 3:26:33 v-junxisu@microsoft.com +``` + +Get the Service Registry and its properties. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IServiceRegistryResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudRuntimeVersion.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudRuntimeVersion.md new file mode 100644 index 0000000000..1d217e29c3 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudRuntimeVersion.md @@ -0,0 +1,64 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudruntimeversion +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudRuntimeVersion.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudRuntimeVersion.md +--- + +# Get-AzSpringCloudRuntimeVersion + +## SYNOPSIS +Lists all of the available runtime versions supported by Microsoft.AppPlatform provider. + +## SYNTAX + +``` +Get-AzSpringCloudRuntimeVersion [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all of the available runtime versions supported by Microsoft.AppPlatform provider. + +## EXAMPLES + +### Example 1: Lists all of the available runtime versions supported by Microsoft.AppPlatform provider +```powershell +Get-AzSpringCloudRuntimeVersion +``` + +Lists all of the available runtime versions supported by Microsoft.AppPlatform provider. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ISupportedRuntimeVersion + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudSku.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudSku.md new file mode 100644 index 0000000000..50e07c7299 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudSku.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudsku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudSku.md +--- + +# Get-AzSpringCloudSku + +## SYNOPSIS +Lists all of the available skus of the Microsoft.AppPlatform provider. + +## SYNTAX + +``` +Get-AzSpringCloudSku [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all of the available skus of the Microsoft.AppPlatform provider. + +## EXAMPLES + +### Example 1: Lists all of the available skus of the Microsoft.AppPlatform provider +```powershell +Get-AzSpringCloudSku +``` + +```output +Location Name ResourceType Tier +-------- ---- ------------ ---- +{australiaeast} B0 Spring Basic +{brazilsouth} B0 Spring Basic +{canadacentral} B0 Spring Basic +{centralindia} B0 Spring Basic +{centralus} B0 Spring Basic +{eastasia} B0 Spring Basic +{eastasia} B0 Spring Basic +{eastus} B0 Spring Basic +{eastus} B0 Spring Basic +{eastus2} B0 Spring Basic +{eastus2euap} B0 Spring Basic +{francecentral} B0 Spring Basic +{germanywestcentral} B0 Spring Basic +{japaneast} B0 Spring Basic +{koreacentral} B0 Spring Basic +{northcentralus} B0 Spring Basic +{northeurope} B0 Spring Basic +{southafricanorth} B0 Spring Basic +{southcentralus} B0 Spring Basic +{southeastasia} B0 Spring Basic +{switzerlandnorth} B0 Spring Basic +{switzerlandwest} B0 Spring Basic +{uaenorth} B0 Spring Basic +{uksouth} B0 Spring Basic +{westcentralus} B0 Spring Basic +{westeurope} B0 Spring Basic +{westus} B0 Spring Basic +{westus2} B0 Spring Basic +{westus3} B0 Spring Basic +{australiaeast} E0 Spring Enterprise +{brazilsouth} E0 Spring Enterprise +{canadacentral} E0 Spring Enterprise +{centralindia} E0 Spring Enterprise +{centralus} E0 Spring Enterprise +{eastasia} E0 Spring Enterprise +{eastus} E0 Spring Enterprise +{eastus2} E0 Spring Enterprise +{eastus2euap} E0 Spring Enterprise +{francecentral} E0 Spring Enterprise +{germanywestcentral} E0 Spring Enterprise +{koreacentral} E0 Spring Enterprise +{northcentralus} E0 Spring Enterprise +{northeurope} E0 Spring Enterprise +{southafricanorth} E0 Spring Enterprise +{southcentralus} E0 Spring Enterprise +{southeastasia} E0 Spring Enterprise +{switzerlandnorth} E0 Spring Enterprise +{switzerlandwest} E0 Spring Enterprise +{uaenorth} E0 Spring Enterprise +{uksouth} E0 Spring Enterprise +{westeurope} E0 Spring Enterprise +{westus} E0 Spring Enterprise +{westus2} E0 Spring Enterprise +{westus3} E0 Spring Enterprise +{australiaeast} S0 Spring Standard +{brazilsouth} S0 Spring Standard +{canadacentral} S0 Spring Standard +{centralindia} S0 Spring Standard +{centralus} S0 Spring Standard +{eastasia} S0 Spring Standard +{eastasia} S0 Spring Standard +{eastus} S0 Spring Standard +{eastus} S0 Spring Standard +{eastus2} S0 Spring Standard +{eastus2euap} S0 Spring Standard +{francecentral} S0 Spring Standard +{germanywestcentral} S0 Spring Standard +{japaneast} S0 Spring Standard +{koreacentral} S0 Spring Standard +{northcentralus} S0 Spring Standard +{northeurope} S0 Spring Standard +{southafricanorth} S0 Spring Standard +{southcentralus} S0 Spring Standard +{southeastasia} S0 Spring Standard +{switzerlandnorth} S0 Spring Standard +{switzerlandwest} S0 Spring Standard +{uaenorth} S0 Spring Standard +{uksouth} S0 Spring Standard +{westcentralus} S0 Spring Standard +{westeurope} S0 Spring Standard +{westus} S0 Spring Standard +{westus2} S0 Spring Standard +{westus3} S0 Spring Standard +{australiaeast} B0 Spring/apps/deployments Basic +{brazilsouth} B0 Spring/apps/deployments Basic +{canadacentral} B0 Spring/apps/deployments Basic +{centralindia} B0 Spring/apps/deployments Basic +{centralus} B0 Spring/apps/deployments Basic +{eastasia} B0 Spring/apps/deployments Basic +{eastasia} B0 Spring/apps/deployments Basic +{eastus} B0 Spring/apps/deployments Basic +{eastus} B0 Spring/apps/deployments Basic +{eastus2} B0 Spring/apps/deployments Basic +{eastus2euap} B0 Spring/apps/deployments Basic +{francecentral} B0 Spring/apps/deployments Basic +{germanywestcentral} B0 Spring/apps/deployments Basic +{japaneast} B0 Spring/apps/deployments Basic +{koreacentral} B0 Spring/apps/deployments Basic +{northcentralus} B0 Spring/apps/deployments Basic +{northeurope} B0 Spring/apps/deployments Basic +{southafricanorth} B0 Spring/apps/deployments Basic +{southcentralus} B0 Spring/apps/deployments Basic +{southeastasia} B0 Spring/apps/deployments Basic +{switzerlandnorth} B0 Spring/apps/deployments Basic +{switzerlandwest} B0 Spring/apps/deployments Basic +{uaenorth} B0 Spring/apps/deployments Basic +{uksouth} B0 Spring/apps/deployments Basic +{westcentralus} B0 Spring/apps/deployments Basic +{westeurope} B0 Spring/apps/deployments Basic +{westus} B0 Spring/apps/deployments Basic +{westus2} B0 Spring/apps/deployments Basic +{westus3} B0 Spring/apps/deployments Basic +{australiaeast} E0 Spring/apps/deployments Enterprise +{brazilsouth} E0 Spring/apps/deployments Enterprise +{canadacentral} E0 Spring/apps/deployments Enterprise +{centralindia} E0 Spring/apps/deployments Enterprise +{centralus} E0 Spring/apps/deployments Enterprise +{eastasia} E0 Spring/apps/deployments Enterprise +{eastus} E0 Spring/apps/deployments Enterprise +{eastus2} E0 Spring/apps/deployments Enterprise +{eastus2euap} E0 Spring/apps/deployments Enterprise +{francecentral} E0 Spring/apps/deployments Enterprise +{germanywestcentral} E0 Spring/apps/deployments Enterprise +{koreacentral} E0 Spring/apps/deployments Enterprise +{northcentralus} E0 Spring/apps/deployments Enterprise +{northeurope} E0 Spring/apps/deployments Enterprise +{southafricanorth} E0 Spring/apps/deployments Enterprise +{southcentralus} E0 Spring/apps/deployments Enterprise +{southeastasia} E0 Spring/apps/deployments Enterprise +{switzerlandnorth} E0 Spring/apps/deployments Enterprise +{switzerlandwest} E0 Spring/apps/deployments Enterprise +{uaenorth} E0 Spring/apps/deployments Enterprise +{uksouth} E0 Spring/apps/deployments Enterprise +{westeurope} E0 Spring/apps/deployments Enterprise +{westus} E0 Spring/apps/deployments Enterprise +{westus2} E0 Spring/apps/deployments Enterprise +{westus3} E0 Spring/apps/deployments Enterprise +{australiaeast} S0 Spring/apps/deployments Standard +{brazilsouth} S0 Spring/apps/deployments Standard +{canadacentral} S0 Spring/apps/deployments Standard +{centralindia} S0 Spring/apps/deployments Standard +{centralus} S0 Spring/apps/deployments Standard +{eastasia} S0 Spring/apps/deployments Standard +{eastasia} S0 Spring/apps/deployments Standard +{eastus} S0 Spring/apps/deployments Standard +{eastus} S0 Spring/apps/deployments Standard +{eastus2} S0 Spring/apps/deployments Standard +{eastus2euap} S0 Spring/apps/deployments Standard +{francecentral} S0 Spring/apps/deployments Standard +{germanywestcentral} S0 Spring/apps/deployments Standard +{japaneast} S0 Spring/apps/deployments Standard +{koreacentral} S0 Spring/apps/deployments Standard +{northcentralus} S0 Spring/apps/deployments Standard +{northeurope} S0 Spring/apps/deployments Standard +{southafricanorth} S0 Spring/apps/deployments Standard +{southcentralus} S0 Spring/apps/deployments Standard +{southeastasia} S0 Spring/apps/deployments Standard +{switzerlandnorth} S0 Spring/apps/deployments Standard +{switzerlandwest} S0 Spring/apps/deployments Standard +{uaenorth} S0 Spring/apps/deployments Standard +{uksouth} S0 Spring/apps/deployments Standard +{westcentralus} S0 Spring/apps/deployments Standard +{westeurope} S0 Spring/apps/deployments Standard +{westus} S0 Spring/apps/deployments Standard +{westus2} S0 Spring/apps/deployments Standard +{westus3} S0 Spring/apps/deployments Standard +``` + +Lists all of the available skus of the Microsoft.AppPlatform provider. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IResourceSku + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudTestKey.md b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudTestKey.md new file mode 100644 index 0000000000..39de73a8a4 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Get-AzSpringCloudTestKey.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/get-azspringcloudtestkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudTestKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Get-AzSpringCloudTestKey.md +--- + +# Get-AzSpringCloudTestKey + +## SYNOPSIS +List test keys for a Service. + +## SYNTAX + +``` +Get-AzSpringCloudTestKey -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List test keys for a Service. + +## EXAMPLES + +### Example 1: List test keys for a Service +```powershell +Get-AzSpringCloudTestKey -ResourceGroupName SpringCloud-gp-junxi -Name springcloud-service +``` + +```output +Enabled PrimaryKey PrimaryTestEndpoint +------- ---------- ------------------- +True **************************************************************** https://primary:***************** +``` + +List test keys for a Service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ITestKeys + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloud.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloud.md new file mode 100644 index 0000000000..9cc358e4f8 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloud.md @@ -0,0 +1,362 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/new-azspringcloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloud.md +--- + +# New-AzSpringCloud + +## SYNOPSIS +Create a new Service or update an exiting Service. + +## SYNTAX + +``` +New-AzSpringCloud -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-Location <String>] + [-NetworkProfileResourceGroup <String>] [-NetworkProfileServiceCidr <String>] + [-NetworkProfileServiceResourceGroup <String>] [-NetworkProfileServiceSubnetId <String>] + [-NetworkProfileSubnetId <String>] [-SkuCapacity <Int32>] [-SkuName <String>] [-SkuTier <String>] + [-Tag <Hashtable>] [-ZoneRedundant] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a new Service or update an exiting Service. + +## EXAMPLES + +### Example 1: Create or update a new standard spring cloud service +```powershell +New-AzSpringCloud -ResourceGroupName springcloudrg -Name spring-pwsh01 -Location eastus +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModified + At +-------- ---- ------------------- ------------------- ----------------------- ---------------------- +eastus springcloud-service 2022/6/28 7:59:45 ******@microsoft.com User 2022/6/28 7:59:45 +``` + +Create or update a new standard spring cloud service. + +### Example 2: Create or update a new enterprise spring cloud service +```powershell +New-AzSpringCloud -ResourceGroupName springcloudrg -Name espring-pwsh01 -Location eastus -SkuTier "Enterprise" -SkuName "E0" +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +eastus espring-pwsh01 7/22/2022 7:35:40 AM v-diya@microsoft.com User 7/22/2022 7:35:40 AM v-diya@microsoft.com User springcloudrg +``` + +Create or update a new enterprise spring cloud service . + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The GEO location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfileResourceGroup +Name of the resource group containing network resources for customer apps in Azure Spring Apps + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfileServiceCidr +Azure Spring Apps service reserved CIDR + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfileServiceResourceGroup +Name of the resource group containing network resources of Azure Spring Apps Service Runtime + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfileServiceSubnetId +Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfileSubnetId +Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Current capacity of the target resource + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +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 +``` + +### -SkuTier +Tier 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 +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags of the service which is a list of key value pairs that describe the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IServiceResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudApp.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudApp.md new file mode 100644 index 0000000000..0c6c6bb669 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudApp.md @@ -0,0 +1,419 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/new-azspringcloudapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudApp.md +--- + +# New-AzSpringCloudApp + +## SYNOPSIS +Create a new App or update an exiting App. + +## SYNTAX + +``` +New-AzSpringCloudApp -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-AddonConfig <Hashtable>] [-EnableEndToEndTl] [-Fqdn <String>] [-HttpsOnly] + [-IdentityPrincipalId <String>] [-IdentityTenantId <String>] [-IdentityType <ManagedIdentityType>] + [-LoadedCertificate <ILoadedCertificate[]>] [-Location <String>] [-PersistentDiskMountPath <String>] + [-PersistentDiskSizeInGb <Int32>] [-Public] [-TemporaryDiskMountPath <String>] + [-TemporaryDiskSizeInGb <Int32>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a new App or update an exiting App. + +## EXAMPLES + +### Example 1: Create a new App or update an exiting App +```powershell +New-AzSpringCloudApp -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -Name tools +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ +tools 2022/6/28 8:33:27 ******@microsoft.com User 2022/6/28 8:33:27 ******@microsoft.com +``` + +Create a new App or update an exiting App. + +## PARAMETERS + +### -AddonConfig +Collection of addons + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableEndToEndTl +Indicate if end to end TLS is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fqdn +Fully qualified dns Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsOnly +Indicate if only https is allowed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityPrincipalId +Principal Id of system-assigned managed identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityTenantId +Tenant Id of system-assigned managed identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of the managed identity + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Support.ManagedIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadedCertificate +Collection of loaded certificates +To construct, see NOTES section for LOADEDCERTIFICATE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ILoadedCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The GEO location of the application, always the same with its parent resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PersistentDiskMountPath +Mount path of the persistent disk + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PersistentDiskSizeInGb +Size of the persistent disk in GB + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Public +Indicates whether the App exposes public endpoint + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemporaryDiskMountPath +Mount path of the temporary disk + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemporaryDiskSizeInGb +Size of the temporary disk in GB + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IAppResource + +## 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. + + +`LOADEDCERTIFICATE <ILoadedCertificate[]>`: Collection of loaded certificates + - `ResourceId <String>`: Resource Id of loaded certificate + - `[LoadTrustStore <Boolean?>]`: Indicate whether the certificate will be loaded into default trust store, only work for Java runtime. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppBinding.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppBinding.md new file mode 100644 index 0000000000..869c122e99 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppBinding.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/new-azspringcloudappbinding +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppBinding.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppBinding.md +--- + +# New-AzSpringCloudAppBinding + +## SYNOPSIS +Create a new Binding or update an exiting Binding. + +## SYNTAX + +``` +New-AzSpringCloudAppBinding -AppName <String> -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-BindingParameter <Hashtable>] [-Key <String>] [-ResourceId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new Binding or update an exiting Binding. + +## EXAMPLES + +### Example 1: Create a new Binding or update an exiting Binding +```powershell +New-AzSpringCloudAppBinding -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -name redis -Key myKey -ResourceId myResourceId -AppName tools -BindingParameter @{ "useSsl"= "true" } +``` + +```output +ResourceName Name ResourceGroupName ResourceType +------------ ---- ----------------- ------------ +redisService redis SpringCloud-gp-junxi Microsoft.Cache +``` + +Create a new Binding or update an exiting Binding. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BindingParameter +Binding parameters of the Binding resource + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Key +The key of the bound resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Binding resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BindingName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource id of the bound resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IBindingResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppCustomDomain.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppCustomDomain.md new file mode 100644 index 0000000000..854efb0d27 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppCustomDomain.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/new-azspringcloudappcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppCustomDomain.md +--- + +# New-AzSpringCloudAppCustomDomain + +## SYNOPSIS +Create or update custom domain of one lifecycle application. + +## SYNTAX + +``` +New-AzSpringCloudAppCustomDomain -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-CertName <String>] [-Thumbprint <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update custom domain of one lifecycle application. + +## EXAMPLES + +### Example 1: Create or update custom domain of one lifecycle application +```powershell +New-AzSpringCloudAppCustomDomain -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName gateway -Name springcloud-service.azuremicroservices.io +``` + +```output +Name +---- +springcloud-service.azuremicroservices.io +``` + +Create or update custom domain of one lifecycle application. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertName +The bound certificate name of domain. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the custom domain resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Thumbprint +The thumbprint of bound certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ICustomDomainResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeployment.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeployment.md new file mode 100644 index 0000000000..b80b39c5a7 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeployment.md @@ -0,0 +1,380 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/new-azspringcloudappdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppDeployment.md +--- + +# New-AzSpringCloudAppDeployment + +## SYNOPSIS +Create a new Deployment or update an exiting Deployment. + +## SYNTAX + +``` +New-AzSpringCloudAppDeployment -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-Active] [-AddonConfig <Hashtable>] + [-EnvironmentVariable <Hashtable>] [-ResourceRequestCpu <String>] [-ResourceRequestMemory <String>] + [-SkuCapacity <Int32>] [-SkuName <String>] [-SkuTier <String>] [-Source <IUserSourceInfo>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a new Deployment or update an exiting Deployment. + +## EXAMPLES + +### Example 1: Example 1: Create a spring cloud deployment +```powershell +New-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rp -ServiceName spring-cloud-service -AppName gateway -Name default +``` + +```output +Active : False +AppName : gateway +CreatedTime : +DeploymentSettingCpu : 1 +DeploymentSettingEnvironmentVariable : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.DeploymentSettingsEnvironmentVariables +DeploymentSettingInstanceCount : 1 +DeploymentSettingJvmOption : +DeploymentSettingMemoryInGb : 1 +DeploymentSettingRuntimeVersion : Java_8 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/spring-cloud-rg/providers/Microsoft.AppPlatform/Spring/spring-cloud-service/apps/gateway/deployments/default +Instance : {gateway-default-7-6bd6f87954-nl2wl} +Name : default +ProvisioningState : Succeeded +SourceArtifactSelector : +SourceRelativePath : <default> +SourceType : Jar +SourceVersion : +Status : Running +Type : Microsoft.AppPlatform/Spring/apps/deployments +DeploymentSetting : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.DeploymentSettings +Property : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.DeploymentResourceProperties +Source : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.UserSourceInfo +``` + +Create a spring cloud deployment. + +## PARAMETERS + +### -Active +Indicates whether the Deployment is active + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddonConfig +Collection of addons + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentVariable +Collection of environment variables + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Deployment resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeploymentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceRequestCpu +Required CPU. +1 core can be represented by 1 or 1000m. +This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceRequestMemory +Required memory. +1 GB can be represented by 1Gi or 1024Mi. +This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Current capacity of the target resource + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +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 +``` + +### -SkuTier +Tier 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 +``` + +### -Source +Uploaded source information of the deployment. +To construct, see NOTES section for SOURCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IUserSourceInfo +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IDeploymentResource + +## 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. + + +`SOURCE <IUserSourceInfo>`: Uploaded source information of the deployment. + - `Type <String>`: Type of the source uploaded + - `[Version <String>]`: Version of the source + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeploymentBuildResultObject.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeploymentBuildResultObject.md new file mode 100644 index 0000000000..ed60fa0da1 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeploymentBuildResultObject.md @@ -0,0 +1,70 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.SpringCloud/new-AzSpringCloudAppDeploymentBuildResultObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppDeploymentBuildResultObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppDeploymentBuildResultObject.md +--- + +# New-AzSpringCloudAppDeploymentBuildResultObject + +## SYNOPSIS +Create an in-memory object for BuildResultUserSourceInfo. + +## SYNTAX + +``` +New-AzSpringCloudAppDeploymentBuildResultObject [-Version <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for BuildResultUserSourceInfo. + +## EXAMPLES + +### Example 1: Create an in-memory object for BuildResultUserSourceInfo +```powershell +New-AzSpringCloudAppDeploymentBuildResultObject +``` + +```output +Version BuildResultId +------- ------------- + <default> +``` + +Create an in-memory object for BuildResultUserSourceInfo. + +## PARAMETERS + +### -Version +Version of the source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.BuildResultUserSourceInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeploymentJarUploadedObject.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeploymentJarUploadedObject.md new file mode 100644 index 0000000000..1f0c607244 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeploymentJarUploadedObject.md @@ -0,0 +1,101 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.SpringCloud/new-AzSpringCloudAppDeploymentJarUploadedObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppDeploymentJarUploadedObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppDeploymentJarUploadedObject.md +--- + +# New-AzSpringCloudAppDeploymentJarUploadedObject + +## SYNOPSIS +Create an in-memory object for JarUploadedUserSourceInfo. + +## SYNTAX + +``` +New-AzSpringCloudAppDeploymentJarUploadedObject [-JvmOption <String>] [-RuntimeVersion <String>] + [-Version <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for JarUploadedUserSourceInfo. + +## EXAMPLES + +### Example 1: Create an in-memory object for JarUploadedUserSourceInfo +```powershell +New-AzSpringCloudAppDeploymentJarUploadedObject -RuntimeVersion "Java_8" +``` + +```output +RelativePath Version JvmOption RuntimeVersion +------------ ------- --------- -------------- +/resource/asd451212asdasd578454d Java_8 +``` + +Create an in-memory object for JarUploadedUserSourceInfo. + +## PARAMETERS + +### -JvmOption +JVM parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuntimeVersion +Runtime version of the Jar file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version of the source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.JarUploadedUserSourceInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeploymentNetCoreZipUploadedObject.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeploymentNetCoreZipUploadedObject.md new file mode 100644 index 0000000000..6ba028f3bf --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeploymentNetCoreZipUploadedObject.md @@ -0,0 +1,101 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.SpringCloud/new-AzSpringCloudAppDeploymentNetCoreZipUploadedObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppDeploymentNetCoreZipUploadedObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppDeploymentNetCoreZipUploadedObject.md +--- + +# New-AzSpringCloudAppDeploymentNetCoreZipUploadedObject + +## SYNOPSIS +Create an in-memory object for NetCoreZipUploadedUserSourceInfo. + +## SYNTAX + +``` +New-AzSpringCloudAppDeploymentNetCoreZipUploadedObject [-MainEntryPath <String>] [-RuntimeVersion <String>] + [-Version <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for NetCoreZipUploadedUserSourceInfo. + +## EXAMPLES + +### Example 1: Create an in-memory object for NetCoreZipUploadedUserSourceInfo +```powershell +New-AzSpringCloudAppDeploymentNetCoreZipUploadedObject +``` + +```output +RelativePath Version NetCoreMainEntryPath RuntimeVersion +------------ ------- -------------------- -------------- +<default> +``` + +Create an in-memory object for NetCoreZipUploadedUserSourceInfo. + +## PARAMETERS + +### -MainEntryPath +The path to the .NET executable relative to zip root. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuntimeVersion +Runtime version of the .Net file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version of the source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.NetCoreZipUploadedUserSourceInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeploymentSourceUploadedObject.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeploymentSourceUploadedObject.md new file mode 100644 index 0000000000..50881c8523 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppDeploymentSourceUploadedObject.md @@ -0,0 +1,103 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.SpringCloud/new-AzSpringCloudAppDeploymentSourceUploadedObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppDeploymentSourceUploadedObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppDeploymentSourceUploadedObject.md +--- + +# New-AzSpringCloudAppDeploymentSourceUploadedObject + +## SYNOPSIS +Create an in-memory object for SourceUploadedUserSourceInfo. + +## SYNTAX + +``` +New-AzSpringCloudAppDeploymentSourceUploadedObject [-ArtifactSelector <String>] [-RuntimeVersion <String>] + [-Version <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SourceUploadedUserSourceInfo. + +## EXAMPLES + +### Example 1: Create an in-memory object for SourceUploadedUserSourceInfo +```powershell +New-AzSpringCloudAppDeploymentSourceUploadedObject +``` + +```output +RelativePath Version ArtifactSelector RuntimeVersion +------------ ------- ---------------- -------------- +<default> +``` + +Create an in-memory object for SourceUploadedUserSourceInfo. + +## PARAMETERS + +### -ArtifactSelector +Selector for the artifact to be used for the deployment for multi-module projects. +This should be + the relative path to the target module/project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuntimeVersion +Runtime version of the source file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version of the source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.SourceUploadedUserSourceInfo + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppLoadedCertificateObject.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppLoadedCertificateObject.md new file mode 100644 index 0000000000..794313dbef --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudAppLoadedCertificateObject.md @@ -0,0 +1,86 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.SpringCloud/new-AzSpringCloudAppLoadedCertificateObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppLoadedCertificateObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudAppLoadedCertificateObject.md +--- + +# New-AzSpringCloudAppLoadedCertificateObject + +## SYNOPSIS +Create an in-memory object for LoadedCertificate. + +## SYNTAX + +``` +New-AzSpringCloudAppLoadedCertificateObject -ResourceId <String> [-LoadTrustStore <Boolean>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for LoadedCertificate. + +## EXAMPLES + +### Example 1: Create an in-memory object for LoadedCertificate. +```powershell +New-AzSpringCloudAppLoadedCertificateObject -ResourceId myResourceId +``` + +```output +LoadTrustStore ResourceId +-------------- ---------- + myResourceId +``` + +Create an in-memory object for LoadedCertificate. + +## PARAMETERS + +### -LoadTrustStore +Indicate whether the certificate will be loaded into default trust store, only work for Java runtime. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource Id of loaded certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.LoadedCertificate + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildServiceAgentPool.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildServiceAgentPool.md new file mode 100644 index 0000000000..3522fb5c68 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildServiceAgentPool.md @@ -0,0 +1,247 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/new-azspringcloudbuildserviceagentpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudBuildServiceAgentPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudBuildServiceAgentPool.md +--- + +# New-AzSpringCloudBuildServiceAgentPool + +## SYNOPSIS +Create or update build service agent pool. + +## SYNTAX + +### UpdateExpanded (Default) +``` +New-AzSpringCloudBuildServiceAgentPool -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-PoolSizeName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +New-AzSpringCloudBuildServiceAgentPool -InputObject <ISpringCloudIdentity> [-PoolSizeName <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update build service agent pool. + +## EXAMPLES + +### Example 1: Create or update build service agent pool +```powershell +New-AzSpringCloudBuildServiceAgentPool -ResourceGroupName springcloudrg -ServiceName espring-pwsh01 -PoolSizeName "S1" +``` + +```output +Name ResourceGroupName ProvisioningState StackId StackVersion +---- ----------------- ----------------- ------- ------------ +builderfull springcloudrg Succeeded io.buildpacks.stacks.bionic full +``` + +Create or update build service agent pool. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolSizeName +The name of build service agent pool size + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IBuildServiceAgentPoolResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildServiceBuilder.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildServiceBuilder.md new file mode 100644 index 0000000000..8d2fc8a944 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildServiceBuilder.md @@ -0,0 +1,252 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/new-azspringcloudbuildservicebuilder +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudBuildServiceBuilder.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudBuildServiceBuilder.md +--- + +# New-AzSpringCloudBuildServiceBuilder + +## SYNOPSIS +Create or update a KPack builder. + +## SYNTAX + +``` +New-AzSpringCloudBuildServiceBuilder -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-BuildpackGroup <IBuildpacksGroupProperties[]>] [-StackId <String>] + [-StackVersion <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a KPack builder. + +## EXAMPLES + +### Example 1: Create or update a KPack builder +```powershell +New-AzSpringCloudBuildServiceBuilder -ResourceGroupName springcloudrg -ServiceName sspring-portal01 -Name builder01 -StackId 'io.buildpacks.stacks.bionic' -StackVersion 'base' +``` + +```output +Name ResourceGroupName ProvisioningState StackId StackVersion +---- ----------------- ----------------- ------- ------------ +builder01 springcloudrg Succeeded io.buildpacks.stacks.bionic base +``` + +Create or update a KPack builder. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BuildpackGroup +Builder buildpack groups. +To construct, see NOTES section for BUILDPACKGROUP properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IBuildpacksGroupProperties[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the builder resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StackId +Id of the ClusterStack. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StackVersion +Version of the ClusterStack + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IBuilderResource + +## 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. + + +`BUILDPACKGROUP <IBuildpacksGroupProperties[]>`: Builder buildpack groups. + - `[Buildpack <IBuildpackProperties[]>]`: Buildpacks in the buildpack group + - `[Id <String>]`: Id of the buildpack + - `[Name <String>]`: Buildpack group name + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildpackBinding.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildpackBinding.md new file mode 100644 index 0000000000..8156317598 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildpackBinding.md @@ -0,0 +1,256 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/new-azspringcloudbuildpackbinding +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudBuildpackBinding.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudBuildpackBinding.md +--- + +# New-AzSpringCloudBuildpackBinding + +## SYNOPSIS +Create or update a buildpack binding. + +## SYNTAX + +``` +New-AzSpringCloudBuildpackBinding -BuilderName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-BindingType <BindingType>] [-LaunchProperty <Hashtable>] + [-LaunchSecret <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a buildpack binding. + +## EXAMPLES + +### Example 1: Create or update a buildpack binding +```powershell +New-AzSpringCloudBuildpackBinding -ResourceGroupName springcloudrg -ServiceName sspring-portal0 -BuilderName default -Name binging01 -BindingType 'AppDynamics' +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- +binging01 7/22/2022 2:24:28 AM v-diya@microsoft.com User 7/22/2022 2:24:28 AM v-diya@microsoft.com User springcloudrg +``` + +Create or update a buildpack binding. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BindingType +Buildpack Binding Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Support.BindingType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BuilderName +The name of the builder resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LaunchProperty +Non-sensitive properties for launchProperties + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LaunchSecret +Sensitive properties for launchProperties + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Buildpack Binding Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: BuildpackBindingName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IBuildpackBindingResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildpackObject.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildpackObject.md new file mode 100644 index 0000000000..03bf3b6ea6 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildpackObject.md @@ -0,0 +1,70 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.SpringCloud/new-AzSpringCloudBuildpackObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudBuildpackObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudBuildpackObject.md +--- + +# New-AzSpringCloudBuildpackObject + +## SYNOPSIS +Create an in-memory object for BuildpackProperties. + +## SYNTAX + +``` +New-AzSpringCloudBuildpackObject [-Id <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for BuildpackProperties. + +## EXAMPLES + +### Example 1: Create an in-memory object for BuildpackProperties +```powershell +New-AzSpringCloudBuildpackObject -Id "tanzu-buildpacks/dotnet-core" +``` + +```output +Id +-- +tanzu-buildpacks/dotnet-core +``` + +Create an in-memory object for BuildpackProperties + +## PARAMETERS + +### -Id +Id of the buildpack. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.BuildpackProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildpacksGroupObject.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildpacksGroupObject.md new file mode 100644 index 0000000000..0fd0d0fe76 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudBuildpacksGroupObject.md @@ -0,0 +1,99 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.SpringCloud/new-AzSpringCloudBuildpacksGroupObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudBuildpacksGroupObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudBuildpacksGroupObject.md +--- + +# New-AzSpringCloudBuildpacksGroupObject + +## SYNOPSIS +Create an in-memory object for BuildpacksGroupProperties. + +## SYNTAX + +``` +New-AzSpringCloudBuildpacksGroupObject [-Buildpack <IBuildpackProperties[]>] [-Name <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for BuildpacksGroupProperties. + +## EXAMPLES + +### Example 1: Create an in-memory object for BuildpacksGroupProperties +```powershell +$pack = @() +$pack += New-AzSpringCloudBuildpackObject -Id "tanzu-buildpacks/dotnet-core" +$pack += New-AzSpringCloudBuildpackObject -Id "tanzu-buildpacks/python" +$pack += New-AzSpringCloudBuildpackObject -Id "tanzu-buildpacks/java-azure" +New-AzSpringCloudBuildpacksGroupObject -Name 'packtest' -Buildpack $pack +``` + +```output +Name +---- +packtest +``` + +Create an in-memory object for BuildpacksGroupProperties. + +## PARAMETERS + +### -Buildpack +Buildpacks in the buildpack group. +To construct, see NOTES section for BUILDPACK properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IBuildpackProperties[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Buildpack group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.BuildpacksGroupProperties + +## 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. + + +`BUILDPACK <IBuildpackProperties[]>`: Buildpacks in the buildpack group. + - `[Id <String>]`: Id of the buildpack + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudCertificate.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudCertificate.md new file mode 100644 index 0000000000..125a070b1b --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudCertificate.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/new-azspringcloudcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudCertificate.md +--- + +# New-AzSpringCloudCertificate + +## SYNOPSIS +Create or update certificate resource. + +## SYNTAX + +``` +New-AzSpringCloudCertificate -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-Property <ICertificateProperties>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update certificate resource. + +## EXAMPLES + +### Example 1: Create or update certificate resource +```powershell +$cert = New-AzSpringCloudKeyVaultCertificateObject -Name "cert01" -VaultUri "https://xxxxxx.vault.azure.net" -Version "xxxxxxxxxxxxxxxxxxxxx" -ExcludePrivateKey $false +New-AzSpringCloudCertificate -ResourceGroupName spring-rg-test -ServiceName springapp-pwsh01 -Name cert01 -Property $cert +``` + +```output +Name ResourceGroupName +---- ----------------- +cert01 lucas-rg-test +``` + +Create or update certificate resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the certificate resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +Properties of the certificate resource payload. +To construct, see NOTES section for PROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ICertificateProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ICertificateResource + +## 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 <ICertificateProperties>`: Properties of the certificate resource payload. + - `Type <String>`: The type of the certificate source. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudConfigurationService.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudConfigurationService.md new file mode 100644 index 0000000000..217206c69b --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudConfigurationService.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/new-azspringcloudconfigurationservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudConfigurationService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudConfigurationService.md +--- + +# New-AzSpringCloudConfigurationService + +## SYNOPSIS +Create the default Application Configuration Service or update the existing Application Configuration Service. + +## SYNTAX + +``` +New-AzSpringCloudConfigurationService -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-GitRepository <IConfigurationServiceGitRepository[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create the default Application Configuration Service or update the existing Application Configuration Service. + +## EXAMPLES + +### Example 1: Create the default Application Configuration Service or update the existing Application Configuration Service +```powershell +New-AzSpringCloudConfigurationService -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModi + fiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------ +default 2022/7/13 3:26:33 *********@microsoft.com User 2022/7/13 7:46:06 *********@microso… +``` + +Create the default Application Configuration Service or update the existing Application Configuration Service. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepository +Repositories of Application Configuration Service git property. +To construct, see NOTES section for GITREPOSITORY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IConfigurationServiceGitRepository[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IConfigurationServiceResource + +## 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. + + +`GITREPOSITORY <IConfigurationServiceGitRepository[]>`: Repositories of Application Configuration Service git property. + - `Label <String>`: Label of the repository + - `Name <String>`: Name of the repository + - `Pattern <String[]>`: Collection of patterns of the repository + - `Uri <String>`: URI of the repository + - `[HostKey <String>]`: Public sshKey of git repository. + - `[HostKeyAlgorithm <String>]`: SshKey algorithm of git repository. + - `[Password <String>]`: Password of git repository basic auth. + - `[PrivateKey <String>]`: Private sshKey algorithm of git repository. + - `[SearchPath <String[]>]`: Searching path of the repository + - `[StrictHostKeyChecking <Boolean?>]`: Strict host key checking or not. + - `[Username <String>]`: Username of git repository basic auth. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudConfigurationServiceGitRepositoryObject.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudConfigurationServiceGitRepositoryObject.md new file mode 100644 index 0000000000..593b4a9b6d --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudConfigurationServiceGitRepositoryObject.md @@ -0,0 +1,222 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.SpringCloud/new-AzSpringCloudConfigurationServiceGitRepositoryObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudConfigurationServiceGitRepositoryObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudConfigurationServiceGitRepositoryObject.md +--- + +# New-AzSpringCloudConfigurationServiceGitRepositoryObject + +## SYNOPSIS +Create an in-memory object for ConfigurationServiceGitRepository. + +## SYNTAX + +``` +New-AzSpringCloudConfigurationServiceGitRepositoryObject -Label <String> -Name <String> -Pattern <String[]> + -Uri <String> [-HostKey <String>] [-HostKeyAlgorithm <String>] [-Password <String>] [-PrivateKey <String>] + [-SearchPath <String[]>] [-StrictHostKeyChecking <Boolean>] [-Username <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ConfigurationServiceGitRepository. + +## EXAMPLES + +### Example 1: Create an in-memory object for ConfigurationServiceGitRepository +```powershell +New-AzSpringCloudConfigurationServiceGitRepositoryObject -Name fake -Label master -Uri "https://github.com/fake-user/fake-repository" -Pattern "app/dev" -debug +``` + +```output +HostKey HostKeyAlgorithm Label Name Password Pattern PrivateKey SearchPath StrictHostKeyChecking Uri +------- ---------------- ----- ---- -------- ------- ---------- ---------- --------------------- --- + master fake {app/dev} https://github.com… +``` + +Create an in-memory object for ConfigurationServiceGitRepository. + +## PARAMETERS + +### -HostKey +Public sshKey of git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostKeyAlgorithm +SshKey algorithm of git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +Label of the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Password of git repository basic auth. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +Collection of patterns of the repository. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateKey +Private sshKey algorithm of git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchPath +Searching path of the repository. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StrictHostKeyChecking +Strict host key checking or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +URI of the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Username +Username of git repository basic auth. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ConfigurationServiceGitRepository + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudContentCertificateObject.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudContentCertificateObject.md new file mode 100644 index 0000000000..dd4364e306 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudContentCertificateObject.md @@ -0,0 +1,70 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.SpringCloud/new-AzSpringCloudContentCertificateObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudContentCertificateObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudContentCertificateObject.md +--- + +# New-AzSpringCloudContentCertificateObject + +## SYNOPSIS +Create an in-memory object for ContentCertificateProperties. + +## SYNTAX + +``` +New-AzSpringCloudContentCertificateObject [-Content <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ContentCertificateProperties. + +## EXAMPLES + +### Example 1: Create an in-memory object for ContentCertificateProperties +```powershell +New-AzSpringCloudContentCertificateObject -Content "ContentCertificate" +``` + +```output +ActivateDate DnsName ExpirationDate IssuedDate Issuer SubjectName Thumbprint Content +------------ ------- -------------- ---------- ------ ----------- ---------- ------- + ContentCertificate +``` + +Create an in-memory object for ContentCertificateProperties. + +## PARAMETERS + +### -Content +The content of uploaded certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ContentCertificateProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudGitPatternRepositoryObject.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudGitPatternRepositoryObject.md new file mode 100644 index 0000000000..3804aa24a5 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudGitPatternRepositoryObject.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.SpringCloud/new-AzSpringCloudGitPatternRepositoryObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudGitPatternRepositoryObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudGitPatternRepositoryObject.md +--- + +# New-AzSpringCloudGitPatternRepositoryObject + +## SYNOPSIS +Create an in-memory object for GitPatternRepository. + +## SYNTAX + +``` +New-AzSpringCloudGitPatternRepositoryObject -Name <String> -Uri <String> [-HostKey <String>] + [-HostKeyAlgorithm <String>] [-Label <String>] [-Password <String>] [-Pattern <String[]>] + [-PrivateKey <String>] [-SearchPath <String[]>] [-StrictHostKeyChecking <Boolean>] [-Username <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for GitPatternRepository. + +## EXAMPLES + +### Example 1: Create an in-memory object for GitPatternRepository +```powershell +New-AzSpringCloudGitPatternRepositoryObject -Name fake -Uri "https://github.com/fake-user/fake-repository" +``` + +```output +HostKey HostKeyAlgorithm Label Name Password Pattern PrivateKey SearchPath StrictHostKeyChecking Uri +------- ---------------- ----- ---- -------- ------- ---------- ---------- --------------------- --- + fake https://github.com/fa… +``` + +Create an in-memory object for GitPatternRepository. + +## PARAMETERS + +### -HostKey +Public sshKey of git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostKeyAlgorithm +SshKey algorithm of git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label +Label of the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Password of git repository basic auth. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +Collection of pattern of the repository. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateKey +Private sshKey algorithm of git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchPath +Searching path of the repository. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StrictHostKeyChecking +Strict host key checking or not. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +URI of the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Username +Username of git repository basic auth. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.GitPatternRepository + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudKeyVaultCertificateObject.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudKeyVaultCertificateObject.md new file mode 100644 index 0000000000..2fa7c8f1c4 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudKeyVaultCertificateObject.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.SpringCloud/new-AzSpringCloudKeyVaultCertificateObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudKeyVaultCertificateObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudKeyVaultCertificateObject.md +--- + +# New-AzSpringCloudKeyVaultCertificateObject + +## SYNOPSIS +Create an in-memory object for KeyVaultCertificateProperties. + +## SYNTAX + +``` +New-AzSpringCloudKeyVaultCertificateObject -Name <String> -VaultUri <String> [-ExcludePrivateKey <Boolean>] + [-Version <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for KeyVaultCertificateProperties. + +## EXAMPLES + +### Example 1: Create an in-memory object for KeyVaultCertificateProperties +```powershell +New-AzSpringCloudKeyVaultCertificateObject -VaultUri "keyvaluturi" -Name 'keycert' +``` + +```output +ActivateDate DnsName ExpirationDate IssuedDate Issuer SubjectName Thumbprint CertVersion ExcludePrivateKey KeyVaultCertName VaultUri +------------ ------- -------------- ---------- ------ ----------- ---------- ----------- ----------------- ---------------- -------- + keycert keyvaluturi +``` + +Create an in-memory object for KeyVaultCertificateProperties + +## PARAMETERS + +### -ExcludePrivateKey +Optional. +If set to true, it will not import private key from key vault. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The certificate name of key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VaultUri +The vault uri of user key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +The certificate version of key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.KeyVaultCertificateProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudTestKey.md b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudTestKey.md new file mode 100644 index 0000000000..5ff162baba --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/New-AzSpringCloudTestKey.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/new-azspringcloudtestkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudTestKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/New-AzSpringCloudTestKey.md +--- + +# New-AzSpringCloudTestKey + +## SYNOPSIS +Regenerate a test key for a Service. + +## SYNTAX + +``` +New-AzSpringCloudTestKey -Name <String> -ResourceGroupName <String> -KeyType <TestKeyType> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Regenerate a test key for a Service. + +## EXAMPLES + +### Example 1: Regenerate a test key for a Service +```powershell +New-AzSpringCloudTestKey -ResourceGroupName SpringCloud-gp-junxi -Name springcloud-service -KeyType Primary +``` + +```output +Enabled PrimaryKey PrimaryTestEndpoint +------- ---------- ------------------- +True **************************************************************** https://primary:***********************… +``` + +Regenerate a test key for a Service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyType +Type of the test key + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Support.TestKeyType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ITestKeys + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloud.md b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloud.md new file mode 100644 index 0000000000..45e452e27d --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloud.md @@ -0,0 +1,247 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/remove-azspringcloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloud.md +--- + +# Remove-AzSpringCloud + +## SYNOPSIS +Operation to delete a Service. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSpringCloud -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSpringCloud -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to delete a Service. + +## EXAMPLES + +### Example 1: Remove Spring Cloud Service by name +```powershell +Remove-AzSpringCloud -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service +``` + +Remove Spring Cloud Service by name. + +### Example 2: Remove Spring Cloud Service by pipeline +```powershell +Get-AzSpringCloud -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service | Remove-AzSpringCloud +``` + +Remove Spring Cloud Service by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudApp.md b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudApp.md new file mode 100644 index 0000000000..97a8bba9d2 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudApp.md @@ -0,0 +1,263 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/remove-azspringcloudapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudApp.md +--- + +# Remove-AzSpringCloudApp + +## SYNOPSIS +Operation to delete an App. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSpringCloudApp -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSpringCloudApp -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to delete an App. + +## EXAMPLES + +### Example 1: Remove Spring Cloud App by name +```powershell +Remove-AzSpringCloudApp -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway +``` + +Remove Spring Cloud App by name. + +### Example 2: Remove Spring Cloud App by pipeline +```powershell +Get-AzSpringCloudApp -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway | Remove-AzSpringCloudApp +``` + +Remove Spring Cloud App by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AppName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudAppBinding.md b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudAppBinding.md new file mode 100644 index 0000000000..718200dcdb --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudAppBinding.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/remove-azspringcloudappbinding +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudAppBinding.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudAppBinding.md +--- + +# Remove-AzSpringCloudAppBinding + +## SYNOPSIS +Operation to delete a Binding. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSpringCloudAppBinding -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSpringCloudAppBinding -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to delete a Binding. + +## EXAMPLES + +### Example 1: Operation to delete a Binding +```powershell +Remove-AzSpringCloudAppBinding -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName gateway -Name redis +``` + +Operation to delete a Binding. + +### Example 1: Operation to delete a Binding by pipeline +```powershell +Get-AzSpringCloudAppBinding -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName gateway -Name redis | Remove-AzSpringCloudAppBinding +``` + +Operation to delete a Binding by pipeline. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Binding resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: BindingName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudAppCustomDomain.md b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudAppCustomDomain.md new file mode 100644 index 0000000000..9efda3d066 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudAppCustomDomain.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/remove-azspringcloudappcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudAppCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudAppCustomDomain.md +--- + +# Remove-AzSpringCloudAppCustomDomain + +## SYNOPSIS +Delete the custom domain of one lifecycle application. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSpringCloudAppCustomDomain -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSpringCloudAppCustomDomain -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the custom domain of one lifecycle application. + +## EXAMPLES + +### Example 1: Delete the custom domain of one lifecycle application +```powershell +Remove-AzSpringCloudAppCustomDomain -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName gateway -Name springcloud-service.azuremicroservices.io +``` + +Delete the custom domain of one lifecycle application. + +### Example 2: Delete the custom domain of one lifecycle application by pipeline +```powershell +Get-AzSpringCloudAppCustomDomain -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName gateway -Name springcloud-service.azuremicroservices.io | Remove-AzSpringCloudAppCustomDomain +``` + +Delete the custom domain of one lifecycle application. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the custom domain resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudAppDeployment.md b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudAppDeployment.md new file mode 100644 index 0000000000..b3e4183871 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudAppDeployment.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/remove-azspringcloudappdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudAppDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudAppDeployment.md +--- + +# Remove-AzSpringCloudAppDeployment + +## SYNOPSIS +Operation to delete a Deployment. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSpringCloudAppDeployment -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSpringCloudAppDeployment -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to delete a Deployment. + +## EXAMPLES + +### Example 1: Remove Spring Cloud Deployment by name +```powershell +Remove-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -DeploymentName default +``` + +Remove Spring Cloud Deployment by name. + +### Example 2: Remove Spring Cloud Deployment by pipeline +```powershell +Get-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -DeploymentName default | Remove-AzSpringCloudAppDeployment +``` + +Remove Spring Cloud Deployment by pipeline. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Deployment resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DeploymentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudBuildServiceBuilder.md b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudBuildServiceBuilder.md new file mode 100644 index 0000000000..7385500ef9 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudBuildServiceBuilder.md @@ -0,0 +1,263 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/remove-azspringcloudbuildservicebuilder +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudBuildServiceBuilder.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudBuildServiceBuilder.md +--- + +# Remove-AzSpringCloudBuildServiceBuilder + +## SYNOPSIS +Delete a KPack builder. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSpringCloudBuildServiceBuilder -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSpringCloudBuildServiceBuilder -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a KPack builder. + +## EXAMPLES + +### Example 1: Delete a KPack builder +```powershell +Remove-AzSpringCloudBuildServiceBuilder -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 -Name mybuilder +``` + +Delete a KPack builder. + +### Example 2: Delete a KPack builder by pipeline +```powershell +Get-AzSpringCloudBuildServiceBuilder -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 -Name mybuilder | Remove-AzSpringCloudBuildServiceBuilder +``` + +Delete a KPack builder by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the builder resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudBuildpackBinding.md b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudBuildpackBinding.md new file mode 100644 index 0000000000..ce0f095a91 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudBuildpackBinding.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/remove-azspringcloudbuildpackbinding +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudBuildpackBinding.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudBuildpackBinding.md +--- + +# Remove-AzSpringCloudBuildpackBinding + +## SYNOPSIS +Operation to delete a Buildpack Binding + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSpringCloudBuildpackBinding -BuilderName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSpringCloudBuildpackBinding -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to delete a Buildpack Binding + +## EXAMPLES + +### Example 1: Operation to delete a Buildpack Binding +```powershell +Remove-AzSpringCloudBuildpackBinding -ResourceGroupName springcloudrg -ServiceName sspring-portal01 -BuilderName default -Name binging01 +``` + +Operation to delete a Buildpack Binding. + +### Example 2: Operation to delete a Buildpack Binding by pipeline +```powershell +Get-AzSpringCloudBuildpackBinding -ResourceGroupName springcloudrg -ServiceName sspring-portal01 -BuilderName default -Name binging01 | Remove-AzSpringCloudBuildpackBinding +``` + +Operation to delete a Buildpack Binding by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BuilderName +The name of the builder resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Buildpack Binding Name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: BuildpackBindingName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudCertificate.md b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudCertificate.md new file mode 100644 index 0000000000..b881a60243 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudCertificate.md @@ -0,0 +1,263 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/remove-azspringcloudcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudCertificate.md +--- + +# Remove-AzSpringCloudCertificate + +## SYNOPSIS +Delete the certificate resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSpringCloudCertificate -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSpringCloudCertificate -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete the certificate resource. + +## EXAMPLES + +### Example 1: Delete the certificate resource +```powershell +Remove-AzSpringCloudCertificate -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -Name mycertificate +``` + +Delete the certificate resource. + +### Example 2: Delete the certificate resource +```powershell +Get-AzSpringCloudCertificate -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -Name mycertificate | Remove-AzSpringCloudCertificate -InputObject $data +``` + +Delete the certificate resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the certificate resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudConfigurationService.md b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudConfigurationService.md new file mode 100644 index 0000000000..b7af7a0525 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Remove-AzSpringCloudConfigurationService.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/remove-azspringcloudconfigurationservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudConfigurationService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Remove-AzSpringCloudConfigurationService.md +--- + +# Remove-AzSpringCloudConfigurationService + +## SYNOPSIS +Disable the default Application Configuration Service. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSpringCloudConfigurationService -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSpringCloudConfigurationService -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Disable the default Application Configuration Service. + +## EXAMPLES + +### Example 1: Disable the default Application Configuration Service +```powershell +Remove-AzSpringCloudConfigurationService -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service +``` + +Disable the default Application Configuration Service. + +### Example 2: Disable the default Application Configuration Service by pipeline +```powershell +Get-AzSpringCloudConfigurationService -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service | Remove-AzSpringCloudConfigurationService +``` + +Disable the default Application Configuration Service by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Restart-AzSpringCloudAppDeployment.md b/azps-10.1.0/Az.SpringCloud/Restart-AzSpringCloudAppDeployment.md new file mode 100644 index 0000000000..e54738e07c --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Restart-AzSpringCloudAppDeployment.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/restart-azspringcloudappdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Restart-AzSpringCloudAppDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Restart-AzSpringCloudAppDeployment.md +--- + +# Restart-AzSpringCloudAppDeployment + +## SYNOPSIS +Restart the deployment. + +## SYNTAX + +### Restart (Default) +``` +Restart-AzSpringCloudAppDeployment -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RestartViaIdentity +``` +Restart-AzSpringCloudAppDeployment -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Restart the deployment. + +## EXAMPLES + +### Example 1: Restart Spring Cloud Service by name +```powershell +Restart-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -DeploymentName default +``` + +Restart Spring Cloud Service by name. + +### Example 2: Restart Spring Cloud Service by pipeline +```powershell +Get-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -DeploymentName default | Restart-AzSpringCloudAppDeployment +``` + +Restart Spring Cloud Service by pipeline. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Deployment resource. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: DeploymentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Restart +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Start-AzSpringCloudAppDeployment.md b/azps-10.1.0/Az.SpringCloud/Start-AzSpringCloudAppDeployment.md new file mode 100644 index 0000000000..fc219f4dcd --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Start-AzSpringCloudAppDeployment.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/start-azspringcloudappdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Start-AzSpringCloudAppDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Start-AzSpringCloudAppDeployment.md +--- + +# Start-AzSpringCloudAppDeployment + +## SYNOPSIS +Start the deployment. + +## SYNTAX + +### Start (Default) +``` +Start-AzSpringCloudAppDeployment -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzSpringCloudAppDeployment -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Start the deployment. + +## EXAMPLES + +### Example 1: Start Spring Cloud Service by name +```powershell +Start-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -DeploymentName default +``` + +Start Spring Cloud Service by name. + +### Example 2: Start Spring Cloud Service by pipeline +```powershell +Get-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -DeploymentName default | Start-AzSpringCloudAppDeployment +``` + +Start Spring Cloud Service by pipeline. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Deployment resource. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: DeploymentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Start-AzSpringCloudAppDeploymentJfr.md b/azps-10.1.0/Az.SpringCloud/Start-AzSpringCloudAppDeploymentJfr.md new file mode 100644 index 0000000000..753e9967e7 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Start-AzSpringCloudAppDeploymentJfr.md @@ -0,0 +1,326 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/start-azspringcloudappdeploymentjfr +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Start-AzSpringCloudAppDeploymentJfr.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Start-AzSpringCloudAppDeploymentJfr.md +--- + +# Start-AzSpringCloudAppDeploymentJfr + +## SYNOPSIS +Start JFR + +## SYNTAX + +### StartExpanded (Default) +``` +Start-AzSpringCloudAppDeploymentJfr -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-AppInstance <String>] [-Duration <String>] + [-FilePath <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### StartViaIdentityExpanded +``` +Start-AzSpringCloudAppDeploymentJfr -InputObject <ISpringCloudIdentity> [-AppInstance <String>] + [-Duration <String>] [-FilePath <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Start JFR + +## EXAMPLES + +### Example 1: Start Spring Cloud Service by name +```powershell +Start-AzSpringCloudAppDeploymentJfr -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -Name default +``` + +Start Spring Cloud Service by name. + +### Example 2: Start Spring Cloud Service by pipeline +```powershell +Get-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -Name default | Start-AzSpringCloudAppDeployment +``` + +Start Spring Cloud Service by pipeline. + +## PARAMETERS + +### -AppInstance +App instance name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: StartExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Duration +Duration of your JFR. +1 min can be represented by 1m or 60s. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +Your target file path in your own BYOS + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: StartViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Deployment resource. + +```yaml +Type: System.String +Parameter Sets: StartExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: StartExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: StartExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: StartExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Stop-AzSpringCloudAppDeployment.md b/azps-10.1.0/Az.SpringCloud/Stop-AzSpringCloudAppDeployment.md new file mode 100644 index 0000000000..3990b62d6d --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Stop-AzSpringCloudAppDeployment.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/stop-azspringcloudappdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Stop-AzSpringCloudAppDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Stop-AzSpringCloudAppDeployment.md +--- + +# Stop-AzSpringCloudAppDeployment + +## SYNOPSIS +Stop the deployment. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzSpringCloudAppDeployment -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzSpringCloudAppDeployment -InputObject <ISpringCloudIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Stop the deployment. + +## EXAMPLES + +### Example 1: Stop Spring Cloud Service by name +```powershell +Stop-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -DeploymentName default +``` + +Stop Spring Cloud Service by name. + +### Example 2: Stop Spring Cloud Service by pipeline +```powershell +Get-AzSpringCloudAppDeployment -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -DeploymentName default | Stop-AzSpringCloudAppDeployment +``` + +Stop Spring Cloud Service by pipeline. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Deployment resource. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: DeploymentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Test-AzSpringCloudAppCustomDomain.md b/azps-10.1.0/Az.SpringCloud/Test-AzSpringCloudAppCustomDomain.md new file mode 100644 index 0000000000..3ce43c2b45 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Test-AzSpringCloudAppCustomDomain.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/test-azspringcloudappcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Test-AzSpringCloudAppCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Test-AzSpringCloudAppCustomDomain.md +--- + +# Test-AzSpringCloudAppCustomDomain + +## SYNOPSIS +Check the resource name is valid as well as not in use. + +## SYNTAX + +### ValidateExpanded (Default) +``` +Test-AzSpringCloudAppCustomDomain -AppName <String> -ResourceGroupName <String> -ServiceName <String> + -Name <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### ValidateViaIdentityExpanded +``` +Test-AzSpringCloudAppCustomDomain -InputObject <ISpringCloudIdentity> -Name <String> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Check the resource name is valid as well as not in use. + +## EXAMPLES + +### Example 1: Check the resource name is valid as well as not in use +```powershell +Test-AzSpringCloudAppCustomDomain -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service-01 -Name springcloud-service-01.azuremicroservices.io -AppName tools +``` + +```output +IsValid Message +------- ------- +True +``` + +Check the resource name is valid as well as not in use. + +### Example 2: Check the resource name is valid as well as not in use by pipeline +```powershell +Get-AzSpringCloudAppCustomDomain -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service-01 -Name springcloud-service-01.azuremicroservices.io -AppName tools | Test-AzSpringCloudAppCustomDomain +``` + +```output +IsValid Message +------- ------- +True +``` + +Check the resource name is valid as well as not in use by pipeline. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: ValidateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name to be validated + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ICustomDomainValidateResult + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Test-AzSpringCloudConfigServer.md b/azps-10.1.0/Az.SpringCloud/Test-AzSpringCloudConfigServer.md new file mode 100644 index 0000000000..f0f5ef8a87 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Test-AzSpringCloudConfigServer.md @@ -0,0 +1,414 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/test-azspringcloudconfigserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Test-AzSpringCloudConfigServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Test-AzSpringCloudConfigServer.md +--- + +# Test-AzSpringCloudConfigServer + +## SYNOPSIS +Check if the config server settings are valid. + +## SYNTAX + +### ValidateExpanded (Default) +``` +Test-AzSpringCloudConfigServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-GitHostKey <String>] [-GitHostKeyAlgorithm <String>] [-GitLabel <String>] [-GitPassword <String>] + [-GitPrivateKey <String>] [-GitRepository <IGitPatternRepository[]>] [-GitSearchPath <String[]>] + [-GitStrictHostKeyChecking] [-GitUri <String>] [-GitUsername <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ValidateViaIdentityExpanded +``` +Test-AzSpringCloudConfigServer -InputObject <ISpringCloudIdentity> [-GitHostKey <String>] + [-GitHostKeyAlgorithm <String>] [-GitLabel <String>] [-GitPassword <String>] [-GitPrivateKey <String>] + [-GitRepository <IGitPatternRepository[]>] [-GitSearchPath <String[]>] [-GitStrictHostKeyChecking] + [-GitUri <String>] [-GitUsername <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Check if the config server settings are valid. + +## EXAMPLES + +### Example 1: Check if the config server settings are valid +```powershell + Test-AzSpringCloudConfigServer -ResourceGroupName SpringCloud-gp-junxi -Name springcloud-service +``` + +```output +IsValid +------- +True +``` + +Check if the config server settings are valid. + +### Example 2: Check if the config server settings are valid by pipeline +```powershell +Get-AzSpringCloudConfigServer -ResourceGroupName SpringCloud-gp-junxi -Name springcloud-service | Test-AzSpringCloudConfigServer +``` + +```output +IsValid +------- +True +``` + +Check if the config server settings are valid by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitHostKey +Public sshKey of git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitHostKeyAlgorithm +SshKey algorithm of git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitLabel +Label of the repository + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitPassword +Password of git repository basic auth. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitPrivateKey +Private sshKey algorithm of git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepository +Repositories of git. +To construct, see NOTES section for GITREPOSITORY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IGitPatternRepository[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitSearchPath +Searching path of the repository + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitStrictHostKeyChecking +Strict host key checking or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitUri +URI of the repository + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitUsername +Username of git repository basic auth. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: ValidateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IConfigServerSettingsValidateResult + +## 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. + + +`GITREPOSITORY <IGitPatternRepository[]>`: Repositories of git. + - `Name <String>`: Name of the repository + - `Uri <String>`: URI of the repository + - `[HostKey <String>]`: Public sshKey of git repository. + - `[HostKeyAlgorithm <String>]`: SshKey algorithm of git repository. + - `[Label <String>]`: Label of the repository + - `[Password <String>]`: Password of git repository basic auth. + - `[Pattern <String[]>]`: Collection of pattern of the repository + - `[PrivateKey <String>]`: Private sshKey algorithm of git repository. + - `[SearchPath <String[]>]`: Searching path of the repository + - `[StrictHostKeyChecking <Boolean?>]`: Strict host key checking or not. + - `[Username <String>]`: Username of git repository basic auth. + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Test-AzSpringCloudConfigurationService.md b/azps-10.1.0/Az.SpringCloud/Test-AzSpringCloudConfigurationService.md new file mode 100644 index 0000000000..67a49a15d1 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Test-AzSpringCloudConfigurationService.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/test-azspringcloudconfigurationservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Test-AzSpringCloudConfigurationService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Test-AzSpringCloudConfigurationService.md +--- + +# Test-AzSpringCloudConfigurationService + +## SYNOPSIS +Check if the Application Configuration Service settings are valid. + +## SYNTAX + +### ValidateExpanded (Default) +``` +Test-AzSpringCloudConfigurationService -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-GitRepository <IConfigurationServiceGitRepository[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### ValidateViaIdentityExpanded +``` +Test-AzSpringCloudConfigurationService -InputObject <ISpringCloudIdentity> + [-GitRepository <IConfigurationServiceGitRepository[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Check if the Application Configuration Service settings are valid. + +## EXAMPLES + +### Example 1: Check if the Application Configuration Service settings are valid +```powershell +Test-AzSpringCloudConfigurationService -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-01 +``` + +```output +IsValid +------- +True +``` + +Check if the Application Configuration Service settings are valid. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepository +Repositories of Application Configuration Service git property. +To construct, see NOTES section for GITREPOSITORY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IConfigurationServiceGitRepository[] +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.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: ValidateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IConfigurationServiceGitPropertyValidateResult + +## 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. + + +`GITREPOSITORY <IConfigurationServiceGitRepository[]>`: Repositories of Application Configuration Service git property. + - `Label <String>`: Label of the repository + - `Name <String>`: Name of the repository + - `Pattern <String[]>`: Collection of patterns of the repository + - `Uri <String>`: URI of the repository + - `[HostKey <String>]`: Public sshKey of git repository. + - `[HostKeyAlgorithm <String>]`: SshKey algorithm of git repository. + - `[Password <String>]`: Password of git repository basic auth. + - `[PrivateKey <String>]`: Private sshKey algorithm of git repository. + - `[SearchPath <String[]>]`: Searching path of the repository + - `[StrictHostKeyChecking <Boolean?>]`: Strict host key checking or not. + - `[Username <String>]`: Username of git repository basic auth. + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Test-AzSpringCloudNameAvailability.md b/azps-10.1.0/Az.SpringCloud/Test-AzSpringCloudNameAvailability.md new file mode 100644 index 0000000000..5e709d2bca --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Test-AzSpringCloudNameAvailability.md @@ -0,0 +1,163 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/test-azspringcloudnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Test-AzSpringCloudNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Test-AzSpringCloudNameAvailability.md +--- + +# Test-AzSpringCloudNameAvailability + +## SYNOPSIS +Checks that the resource name is valid and is not already in use. + +## SYNTAX + +``` +Test-AzSpringCloudNameAvailability -Location <String> -Name <String> -Type <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Checks that the resource name is valid and is not already in use. + +## EXAMPLES + +### Example 1: Checks that the resource name is valid and is not already in use +```powershell +Test-AzSpringCloudNameAvailability -Location EastUS -Name springcloud-service -Type "Microsoft.AppPlatform/Spring" -debug +``` + +```output +Message +------- +The resource name is invalid. It can contain only lowercase letters, numbers and hyphens. The first character must be … +``` + +Checks that the resource name is valid and is not already in use. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +the region + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name to be checked + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of the resource to check name availability + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.INameAvailability + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloud.md b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloud.md new file mode 100644 index 0000000000..22633b2bce --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloud.md @@ -0,0 +1,497 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/update-azspringcloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloud.md +--- + +# Update-AzSpringCloud + +## SYNOPSIS +Operation to update an exiting Service. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSpringCloud -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Location <String>] [-NetworkProfileResourceGroup <String>] [-NetworkProfileServiceCidr <String>] + [-NetworkProfileServiceResourceGroup <String>] [-NetworkProfileServiceSubnetId <String>] + [-NetworkProfileSubnetId <String>] [-SkuCapacity <Int32>] [-SkuName <String>] [-SkuTier <String>] + [-Tag <Hashtable>] [-ZoneRedundant] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSpringCloud -InputObject <ISpringCloudIdentity> [-Location <String>] + [-NetworkProfileResourceGroup <String>] [-NetworkProfileServiceCidr <String>] + [-NetworkProfileServiceResourceGroup <String>] [-NetworkProfileServiceSubnetId <String>] + [-NetworkProfileSubnetId <String>] [-SkuCapacity <Int32>] [-SkuName <String>] [-SkuTier <String>] + [-Tag <Hashtable>] [-ZoneRedundant] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Operation to update an exiting Service. + +## EXAMPLES + +### Example 1: Update Spring Cloud Service by name +```powershell +Update-AzSpringCloud -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service +``` + +```output +ConfigServerPropertiesErrorCode : +ConfigServerPropertiesErrorMessage : +ConfigServerPropertyState : Succeeded +GitPropertyHostKey : +GitPropertyHostKeyAlgorithm : +GitPropertyLabel : +GitPropertyPassword : +GitPropertyPrivateKey : +GitPropertyRepository : +GitPropertySearchPath : +GitPropertyStrictHostKeyChecking : +GitPropertyUri : +GitPropertyUsername : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/spring-cloud-rg/providers/Microsoft.AppPlatform/Spring/spring-cloud-service +Location : eastus +Name : spring-cloud-service +NetworkProfileAppNetworkResourceGroup : +NetworkProfileAppSubnetId : +NetworkProfileServiceCidr : +NetworkProfileServiceRuntimeNetworkResourceGroup : +NetworkProfileServiceRuntimeSubnetId : +ProvisioningState : Succeeded +ServiceId : e5e964885b4146b1a91e9bfc17971ee5 +SkuCapacity : +SkuName : S0 +SkuTier : Standard +Tag : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.TrackedResourceTags +TraceAppInsightInstrumentationKey : +TraceEnabled : False +TraceErrorCode : +TraceErrorMessage : +TraceState : Succeeded +Type : Microsoft.AppPlatform/Spring +Version : 2 +ConfigServerGitProperty : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.ConfigServerGitProperty +ConfigServerProperty : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.ConfigServerProperties +ConfigServerPropertyConfigServer : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.ConfigServerSettings +ConfigServerPropertyError : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.Error +NetworkProfile : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.NetworkProfile +Property : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.ClusterResourceProperties +Sku : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.Sku +Trace : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.TraceProperties +TraceError : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.Error +``` + +Update Spring Cloud Service by name. + +### Example 2: Update Spring Cloud Service by pipeline +```powershell +Get-AzSpringCloud -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service | Update-AzSpringCloud +``` + +```output +ConfigServerPropertiesErrorCode : +ConfigServerPropertiesErrorMessage : +ConfigServerPropertyState : Succeeded +GitPropertyHostKey : +GitPropertyHostKeyAlgorithm : +GitPropertyLabel : +GitPropertyPassword : +GitPropertyPrivateKey : +GitPropertyRepository : +GitPropertySearchPath : +GitPropertyStrictHostKeyChecking : +GitPropertyUri : +GitPropertyUsername : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/spring-cloud-rg/providers/Microsoft.AppPlatform/Spring/spring-cloud-service +Location : eastus +Name : spring-cloud-service +NetworkProfileAppNetworkResourceGroup : +NetworkProfileAppSubnetId : +NetworkProfileServiceCidr : +NetworkProfileServiceRuntimeNetworkResourceGroup : +NetworkProfileServiceRuntimeSubnetId : +ProvisioningState : Succeeded +ServiceId : e5e964885b4146b1a91e9bfc17971ee5 +SkuCapacity : +SkuName : S0 +SkuTier : Standard +Tag : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.TrackedResourceTags +TraceAppInsightInstrumentationKey : +TraceEnabled : False +TraceErrorCode : +TraceErrorMessage : +TraceState : Succeeded +Type : Microsoft.AppPlatform/Spring +Version : 2 +ConfigServerGitProperty : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.ConfigServerGitProperty +ConfigServerProperty : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.ConfigServerProperties +ConfigServerPropertyConfigServer : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.ConfigServerSettings +ConfigServerPropertyError : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.Error +NetworkProfile : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.NetworkProfile +Property : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.ClusterResourceProperties +Sku : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.Sku +Trace : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.TraceProperties +TraceError : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.Error +``` + +Update Spring Cloud Service by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The GEO location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfileResourceGroup +Name of the resource group containing network resources for customer apps in Azure Spring Apps + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfileServiceCidr +Azure Spring Apps service reserved CIDR + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfileServiceResourceGroup +Name of the resource group containing network resources of Azure Spring Apps Service Runtime + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfileServiceSubnetId +Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkProfileSubnetId +Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Current capacity of the target resource + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +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 +``` + +### -SkuTier +Tier 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 +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags of the service which is a list of key value pairs that describe the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IServiceResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudApp.md b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudApp.md new file mode 100644 index 0000000000..d4703456c7 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudApp.md @@ -0,0 +1,523 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/update-azspringcloudapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudApp.md +--- + +# Update-AzSpringCloudApp + +## SYNOPSIS +Operation to update an exiting App. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSpringCloudApp -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-AddonConfig <Hashtable>] [-EnableEndToEndTl] [-Fqdn <String>] [-HttpsOnly] + [-IdentityPrincipalId <String>] [-IdentityTenantId <String>] [-IdentityType <ManagedIdentityType>] + [-LoadedCertificate <ILoadedCertificate[]>] [-Location <String>] [-PersistentDiskMountPath <String>] + [-PersistentDiskSizeInGb <Int32>] [-Public] [-TemporaryDiskMountPath <String>] + [-TemporaryDiskSizeInGb <Int32>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSpringCloudApp -InputObject <ISpringCloudIdentity> [-AddonConfig <Hashtable>] [-EnableEndToEndTl] + [-Fqdn <String>] [-HttpsOnly] [-IdentityPrincipalId <String>] [-IdentityTenantId <String>] + [-IdentityType <ManagedIdentityType>] [-LoadedCertificate <ILoadedCertificate[]>] [-Location <String>] + [-PersistentDiskMountPath <String>] [-PersistentDiskSizeInGb <Int32>] [-Public] + [-TemporaryDiskMountPath <String>] [-TemporaryDiskSizeInGb <Int32>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to update an exiting App. + +## EXAMPLES + +### Example 1: Update Spring Cloud App by name +```powershell +Update-AzSpringCloudApp -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway -AddonConfig @{'test' = 'value1'} +``` + +```output +ActiveDeploymentName : default +CreatedTime : 2020-08-08 15:37:43 +Fqdn : spring-cloud-service.azuremicroservices.io +HttpsOnly : False +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/spring-cloud-rg/providers/Microsoft.AppPlatform/Spring/spring-cloud-service/apps/gateway +IdentityPrincipalId : +IdentityTenantId : +IdentityType : +Location : eastus +Name : gateway +PersistentDiskMountPath : /persistent +PersistentDiskSizeInGb : 0 +PersistentDiskUsedInGb : +ProvisioningState : Succeeded +Public : False +TemporaryDiskMountPath : /tmp +TemporaryDiskSizeInGb : 5 +Type : Microsoft.AppPlatform/Spring/apps +Url : +Identity : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.ManagedIdentityProperties +PersistentDisk : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.PersistentDisk +Property : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.AppResourceProperties +TemporaryDisk : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.TemporaryDisk +``` + +Update Spring Cloud App by name. + +### Example 2: Update Spring Cloud App by pipeline +```powershell +Get-AzSpringCloudApp -ResourceGroupName spring-cloud-rg -ServiceName spring-cloud-service -AppName gateway | Update-AzSpringCloudApp -AddonConfig @{'test' = 'value1'} +``` + +```output +ActiveDeploymentName : default +CreatedTime : 2020-08-08 15:37:43 +Fqdn : spring-cloud-service.azuremicroservices.io +HttpsOnly : False +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/spring-cloud-rg/providers/Microsoft.AppPlatform/Spring/spring-cloud-service/apps/gateway +IdentityPrincipalId : +IdentityTenantId : +IdentityType : +Location : eastus +Name : gateway +PersistentDiskMountPath : /persistent +PersistentDiskSizeInGb : 0 +PersistentDiskUsedInGb : +ProvisioningState : Succeeded +Public : False +TemporaryDiskMountPath : /tmp +TemporaryDiskSizeInGb : 5 +Type : Microsoft.AppPlatform/Spring/apps +Url : +Identity : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.ManagedIdentityProperties +PersistentDisk : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.PersistentDisk +Property : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.AppResourceProperties +TemporaryDisk : Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20190501Preview.TemporaryDisk +``` + +Update Spring Cloud App by pipeline. + +## PARAMETERS + +### -AddonConfig +Collection of addons + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableEndToEndTl +Indicate if end to end TLS is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fqdn +Fully qualified dns Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsOnly +Indicate if only https is allowed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityPrincipalId +Principal Id of system-assigned managed identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityTenantId +Tenant Id of system-assigned managed identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of the managed identity + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Support.ManagedIdentityType +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.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LoadedCertificate +Collection of loaded certificates +To construct, see NOTES section for LOADEDCERTIFICATE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ILoadedCertificate[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The GEO location of the application, always the same with its parent resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: AppName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PersistentDiskMountPath +Mount path of the persistent disk + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PersistentDiskSizeInGb +Size of the persistent disk in GB + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Public +Indicates whether the App exposes public endpoint + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemporaryDiskMountPath +Mount path of the temporary disk + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemporaryDiskSizeInGb +Size of the temporary disk in GB + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IAppResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`LOADEDCERTIFICATE <ILoadedCertificate[]>`: Collection of loaded certificates + - `ResourceId <String>`: Resource Id of loaded certificate + - `[LoadTrustStore <Boolean?>]`: Indicate whether the certificate will be loaded into default trust store, only work for Java runtime. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudAppActiveDeployment.md b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudAppActiveDeployment.md new file mode 100644 index 0000000000..7652635a3a --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudAppActiveDeployment.md @@ -0,0 +1,277 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/update-azspringcloudappactivedeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudAppActiveDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudAppActiveDeployment.md +--- + +# Update-AzSpringCloudAppActiveDeployment + +## SYNOPSIS +Set existing Deployment under the app as active + +## SYNTAX + +### SetExpanded (Default) +``` +Update-AzSpringCloudAppActiveDeployment -Name <String> -ResourceGroupName <String> -ServiceName <String> + [-SubscriptionId <String>] [-DeploymentName <String[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### SetViaIdentityExpanded +``` +Update-AzSpringCloudAppActiveDeployment -InputObject <ISpringCloudIdentity> [-DeploymentName <String[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Set existing Deployment under the app as active + +## EXAMPLES + +### Example 1: Set existing Deployment under the app as active +```powershell +Update-AzSpringCloudAppActiveDeployment -ResourceGroupName springcloudrg -ServiceName standardspring-demo -Name demo -DeploymentName 'green' +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModi + fiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------ +default 2022/7/1 3:41:45 *********@microsoft.com User 2022/7/1 3:49:11 **********@microso… +``` + +Set existing Deployment under the app as active. + +### Example 2: Set existing Deployment under the app as active by pipeline +```powershell +Get-AzSpringCloudApp -ResourceGroupName springcloudrg -ServiceName standardspring-demo -Name demo | Update-AzSpringCloudAppActiveDeployment -DeploymentName 'green' +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModi + fiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------ +default 2022/7/1 3:41:45 *********@microsoft.com User 2022/7/1 3:49:11 **********@microso… +``` + +Set existing Deployment under the app as active by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +Collection of Deployment name. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: SetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IAppResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudAppBinding.md b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudAppBinding.md new file mode 100644 index 0000000000..f2c9c54765 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudAppBinding.md @@ -0,0 +1,322 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/update-azspringcloudappbinding +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudAppBinding.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudAppBinding.md +--- + +# Update-AzSpringCloudAppBinding + +## SYNOPSIS +Operation to update an exiting Binding. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSpringCloudAppBinding -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-BindingParameter <Hashtable>] [-Key <String>] + [-ResourceId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSpringCloudAppBinding -InputObject <ISpringCloudIdentity> [-BindingParameter <Hashtable>] + [-Key <String>] [-ResourceId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Operation to update an exiting Binding. + +## EXAMPLES + +### Example 1: Operation to update an exiting Binding +```powershell +Update-AzSpringCloudAppBinding -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName gateway -Name redis -Key myKey -BindingParameter @{ "useSsl"= "true" } +``` + +```output +Name +---- +redis +``` + +Operation to update an exiting Binding. + +### Example 2: Operation to update an exiting Binding by pipeline +```powershell +Get-AzSpringCloudAppBinding -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName gateway -Name redis | Update-AzSpringCloudAppBinding -Key myKey -BindingParameter @{ "useSsl"= "true" } +``` + +```output +Name +---- +redis +``` + +Operation to update an exiting Binding by pipeline. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BindingParameter +Binding parameters of the Binding resource + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Key +The key of the bound resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Binding resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: BindingName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Azure resource id of the bound resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IBindingResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudAppCustomDomain.md b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudAppCustomDomain.md new file mode 100644 index 0000000000..c1972d875d --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudAppCustomDomain.md @@ -0,0 +1,308 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/update-azspringcloudappcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudAppCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudAppCustomDomain.md +--- + +# Update-AzSpringCloudAppCustomDomain + +## SYNOPSIS +Update custom domain of one lifecycle application. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSpringCloudAppCustomDomain -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-CertName <String>] [-Thumbprint <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSpringCloudAppCustomDomain -InputObject <ISpringCloudIdentity> [-CertName <String>] + [-Thumbprint <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Update custom domain of one lifecycle application. + +## EXAMPLES + +### Example 1: Update custom domain of one lifecycle application +```powershell +Update-AzSpringCloudAppCustomDomain -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName gateway -Name springcloud-service.azuremicroservices.io +``` + +```output +Name + +---- +springcloud-service.azuremicroservices.io +``` + +Update custom domain of one lifecycle application. + +### Example 2: Update custom domain of one lifecycle application by pipeline +```powershell +Get-AzSpringCloudAppCustomDomain -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName gateway -Name springcloud-service.azuremicroservices.io | Update-AzSpringCloudAppCustomDomain +``` + +```output +Name + +---- +springcloud-service.azuremicroservices.io +``` + +Update custom domain of one lifecycle application by pipeline. + +## PARAMETERS + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertName +The bound certificate name of domain. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the custom domain resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Thumbprint +The thumbprint of bound certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.ICustomDomainResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudAppDeployment.md b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudAppDeployment.md new file mode 100644 index 0000000000..2892abcf3f --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudAppDeployment.md @@ -0,0 +1,425 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/update-azspringcloudappdeployment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudAppDeployment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudAppDeployment.md +--- + +# Update-AzSpringCloudAppDeployment + +## SYNOPSIS +Operation to update an exiting Deployment. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSpringCloudAppDeployment -AppName <String> -Name <String> -ResourceGroupName <String> + -ServiceName <String> [-SubscriptionId <String>] [-Active] [-AddonConfig <Hashtable>] + [-EnvironmentVariable <Hashtable>] [-ResourceRequestCpu <String>] [-ResourceRequestMemory <String>] + [-SkuCapacity <Int32>] [-SkuName <String>] [-SkuTier <String>] [-Source <IUserSourceInfo>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSpringCloudAppDeployment -InputObject <ISpringCloudIdentity> [-Active] [-AddonConfig <Hashtable>] + [-EnvironmentVariable <Hashtable>] [-ResourceRequestCpu <String>] [-ResourceRequestMemory <String>] + [-SkuCapacity <Int32>] [-SkuName <String>] [-SkuTier <String>] [-Source <IUserSourceInfo>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Operation to update an exiting Deployment. + +## EXAMPLES + +### Example 1: Operation to update an exiting Deployment +```powershell +Update-AzSpringCloudAppDeployment -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName tools -Name default +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModi + fiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------ +default 2022/7/1 3:41:45 *********@microsoft.com User 2022/7/1 3:49:11 **********@microso… +``` + +Operation to update an exiting Deployment. + +### Example 2: Operation to update an exiting Deployment by pipeline +```powershell +Get-AzSpringCloudAppDeployment -ResourceGroupName SpringCloud-gp-junxi -ServiceName springcloud-service -AppName tools -Name default | Update-AzSpringCloudAppDeployment +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModi + fiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------ +default 2022/7/1 3:41:45 *********@microsoft.com User 2022/7/1 3:49:11 **********@microso… +``` + +Operation to update an exiting Deployment by pipeline. + +## PARAMETERS + +### -Active +Indicates whether the Deployment is active + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddonConfig +Collection of addons + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppName +The name of the App resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentVariable +Collection of environment variables + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Deployment resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: DeploymentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceRequestCpu +Required CPU. +1 core can be represented by 1 or 1000m. +This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceRequestMemory +Required memory. +1 GB can be represented by 1Gi or 1024Mi. +This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Current capacity of the target resource + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +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 +``` + +### -SkuTier +Tier 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 +``` + +### -Source +Uploaded source information of the deployment. +To construct, see NOTES section for SOURCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IUserSourceInfo +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IDeploymentResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +`SOURCE <IUserSourceInfo>`: Uploaded source information of the deployment. + - `Type <String>`: Type of the source uploaded + - `[Version <String>]`: Version of the source + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudConfigServer.md b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudConfigServer.md new file mode 100644 index 0000000000..6a044edfa5 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudConfigServer.md @@ -0,0 +1,446 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/update-azspringcloudconfigserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudConfigServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudConfigServer.md +--- + +# Update-AzSpringCloudConfigServer + +## SYNOPSIS +Update the config server. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSpringCloudConfigServer -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Code <String>] [-GitHostKey <String>] [-GitHostKeyAlgorithm <String>] [-GitLabel <String>] + [-GitPassword <String>] [-GitPrivateKey <String>] [-GitRepository <IGitPatternRepository[]>] + [-GitSearchPath <String[]>] [-GitStrictHostKeyChecking] [-GitUri <String>] [-GitUsername <String>] + [-Message <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSpringCloudConfigServer -InputObject <ISpringCloudIdentity> [-Code <String>] [-GitHostKey <String>] + [-GitHostKeyAlgorithm <String>] [-GitLabel <String>] [-GitPassword <String>] [-GitPrivateKey <String>] + [-GitRepository <IGitPatternRepository[]>] [-GitSearchPath <String[]>] [-GitStrictHostKeyChecking] + [-GitUri <String>] [-GitUsername <String>] [-Message <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update the config server. + +## EXAMPLES + +### Example 1: Update the config server +```powershell +Update-AzSpringCloudConfigServer -ResourceGroupName SpringCloud-gp-junxi -Name springcloud-service +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModi + fiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------ +default 2022/7/1 7:22:54 *********@microsoft.com User 2022/7/1 7:22:54 **********@microso… +``` + +Update the config server. + +### Example 2: Update the config server by pipeline +```powershell +Get-AzSpringCloudConfigServer -ResourceGroupName SpringCloud-gp-junxi -Name springcloud-service | Update-AzSpringCloudConfigServer +``` + +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModi + fiedBy +---- ------------------- ------------------- ----------------------- ------------------------ ------------------ +default 2022/7/1 7:22:54 *********@microsoft.com User 2022/7/1 7:22:54 **********@microso… +``` + +Update the config server by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Code +The code of error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitHostKey +Public sshKey of git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitHostKeyAlgorithm +SshKey algorithm of git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitLabel +Label of the repository + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitPassword +Password of git repository basic auth. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitPrivateKey +Private sshKey algorithm of git repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepository +Repositories of git. +To construct, see NOTES section for GITREPOSITORY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IGitPatternRepository[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitSearchPath +Searching path of the repository + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitStrictHostKeyChecking +Strict host key checking or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitUri +URI of the repository + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitUsername +Username of git repository basic auth. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Message +The message of error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IConfigServerResource + +## 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. + + +`GITREPOSITORY <IGitPatternRepository[]>`: Repositories of git. + - `Name <String>`: Name of the repository + - `Uri <String>`: URI of the repository + - `[HostKey <String>]`: Public sshKey of git repository. + - `[HostKeyAlgorithm <String>]`: SshKey algorithm of git repository. + - `[Label <String>]`: Label of the repository + - `[Password <String>]`: Password of git repository basic auth. + - `[Pattern <String[]>]`: Collection of pattern of the repository + - `[PrivateKey <String>]`: Private sshKey algorithm of git repository. + - `[SearchPath <String[]>]`: Searching path of the repository + - `[StrictHostKeyChecking <Boolean?>]`: Strict host key checking or not. + - `[Username <String>]`: Username of git repository basic auth. + +`INPUTOBJECT <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudMonitoringSetting.md b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudMonitoringSetting.md new file mode 100644 index 0000000000..841abbbf26 --- /dev/null +++ b/azps-10.1.0/Az.SpringCloud/Update-AzSpringCloudMonitoringSetting.md @@ -0,0 +1,324 @@ +--- +external help file: +Module Name: Az.SpringCloud +online version: https://learn.microsoft.com/powershell/module/az.springcloud/update-azspringcloudmonitoringsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudMonitoringSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SpringCloud/help/Update-AzSpringCloudMonitoringSetting.md +--- + +# Update-AzSpringCloudMonitoringSetting + +## SYNOPSIS +Update the Monitoring Setting. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSpringCloudMonitoringSetting -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AppInsightsInstrumentationKey <String>] [-AppInsightsSamplingRate <Double>] [-Code <String>] + [-Message <String>] [-TraceEnabled] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSpringCloudMonitoringSetting -InputObject <ISpringCloudIdentity> + [-AppInsightsInstrumentationKey <String>] [-AppInsightsSamplingRate <Double>] [-Code <String>] + [-Message <String>] [-TraceEnabled] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Update the Monitoring Setting. + +## EXAMPLES + +### Example 1: Update the Monitoring Setting +```powershell +Update-AzSpringCloudMonitoringSetting -ResourceGroupName SpringCloud-gp-junxi -Name springcloud-service -AppInsightsInstrumentationKey "InstrumentationKey=xxxxxxxxxxxxxxxxxxx;IngestionEndpoint=https://xxxxxx.in.applicationinsights.azure.com/;LiveEndpoint=https://eastus.livediagnostics.monitor.azure.com/" -TraceEnabled +``` + +```output +Name ResourceGroupName ProvisioningState TraceEnabled +---- ----------------- ----------------- ------------ +default azurespringrg Succeeded True +``` + +Update the Monitoring Setting. + +### Example 2: Update the Monitoring Setting by pipeline +```powershell +Get-AzSpringCloudMonitoringSetting -ResourceGroupName SpringCloud-gp-junxi -Name springcloud-service | Update-AzSpringCloudMonitoringSetting -AppInsightsInstrumentationKey "InstrumentationKey=xxxxxxxxxxxxxxxxxxx;IngestionEndpoint=https://xxxxxx.in.applicationinsights.azure.com/;LiveEndpoint=https://eastus.livediagnostics.monitor.azure.com/" -TraceEnabled +``` + +```output +Name ResourceGroupName ProvisioningState TraceEnabled +---- ----------------- ----------------- ------------ +default azurespringrg Succeeded True +``` + +Update the Monitoring Setting by pipeline. + +## PARAMETERS + +### -AppInsightsInstrumentationKey +Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppInsightsSamplingRate +Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0] + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Code +The code of error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Message +The message of error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Service resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription ID which uniquely identify the Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TraceEnabled +Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. +Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.ISpringCloudIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SpringCloud.Models.Api20220401.IMonitoringSettingResource + +## 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 <ISpringCloudIdentity>`: Identity Parameter + - `[AgentPoolName <String>]`: The name of the build service agent pool resource. + - `[AppName <String>]`: The name of the App resource. + - `[BindingName <String>]`: The name of the Binding resource. + - `[BuildName <String>]`: The name of the build resource. + - `[BuildResultName <String>]`: The name of the build result resource. + - `[BuildServiceName <String>]`: The name of the build service resource. + - `[BuilderName <String>]`: The name of the builder resource. + - `[BuildpackBindingName <String>]`: The name of the Buildpack Binding Name + - `[BuildpackName <String>]`: The name of the buildpack resource. + - `[CertificateName <String>]`: The name of the certificate resource. + - `[ConfigurationServiceName <String>]`: The name of Application Configuration Service. + - `[DeploymentName <String>]`: The name of the Deployment resource. + - `[DomainName <String>]`: The name of the custom domain resource. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: the region + - `[ResourceGroupName <String>]`: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[ServiceName <String>]`: The name of the Service resource. + - `[ServiceRegistryName <String>]`: The name of Service Registry. + - `[StackName <String>]`: The name of the stack resource. + - `[SubscriptionId <String>]`: Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Sql/Add-AzSqlDatabaseToFailoverGroup.md b/azps-10.1.0/Az.Sql/Add-AzSqlDatabaseToFailoverGroup.md new file mode 100644 index 0000000000..c39df2b1f2 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Add-AzSqlDatabaseToFailoverGroup.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/add-azsqldatabasetofailovergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlDatabaseToFailoverGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlDatabaseToFailoverGroup.md +--- + +# Add-AzSqlDatabaseToFailoverGroup + +## SYNOPSIS +Adds one or more databases to an Azure SQL Database Failover Group. + +## SYNTAX + +``` +Add-AzSqlDatabaseToFailoverGroup [-ServerName] <String> [-FailoverGroupName] <String> + -Database <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel]> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Adds one or more databases on a Azure SQL Database Failover Group's primary server to that Failover Group. The databases must not be secondary databases in existing replication relationships. The command will start geo-replication of any added databases to the Failover Group's secondary server. +To obtain database objects with which to populate the '-Database' parameter, use (for example) the Get-AzSqlDatabase cmdlet. +The Failover Group's primary server must be used to execute the command. + +## EXAMPLES + +### Example 1 +```powershell +$failoverGroup = Get-AzSqlDatabase -ResourceGroupName rg -ServerName primaryserver -DatabaseName db1 | Add-AzSqlDatabaseToFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg +``` + +This command adds one database to a Failover Group by piping it in. + +### Example 2 +```powershell +$primaryServer = Get-AzSqlServer -ResourceGroupName rg -ServerName primaryserver +$failoverGroup = $primaryServer | Add-AzSqlDatabaseToFailoverGroup -FailoverGroupName fg -Database ($primaryServer | Get-AzSqlDatabase) +``` + +This command adds all databases in a server to a Failover Group. + +### Example 3 +```powershell +$failoverGroup = Get-AzSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg +$databases = Get-AzSqlElasticPoolDatabase -ResourceGroupName rg -ServerName primaryserver -ElasticPoolName pool1 +$failoverGroup = $failoverGroup | Add-AzSqlDatabaseToFailoverGroup -Database $databases +``` + +This command adds all databases in an Elastic Pool to a Failover Group. + +## PARAMETERS + +### -Database +One or more Azure SQL Databases on the Failover Group's primary server to be added to the Failover Group. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverGroupName +The name of the Azure SQL Database Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the primary Azure SQL Database Server of the Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel, Microsoft.Azure.PowerShell.Cmdlets.Sql, Version=1.3.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlDatabaseFailoverGroup](./New-AzSqlDatabaseFailoverGroup.md) + +[Set-AzSqlDatabaseFailoverGroup](./Set-AzSqlDatabaseFailoverGroup.md) + +[Get-AzSqlDatabaseFailoverGroup](./Get-AzSqlDatabaseFailoverGroup.md) + +[Remove-AzSqlDatabaseFromFailoverGroup](./Remove-AzSqlDatabaseFromFailoverGroup.md) + +[Switch-AzSqlDatabaseFailoverGroup](./Switch-AzSqlDatabaseFailoverGroup.md) + +[Remove-AzSqlDatabaseFailoverGroup](./Remove-AzSqlDatabaseFailoverGroup.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Add-AzSqlElasticJobStep.md b/azps-10.1.0/Az.Sql/Add-AzSqlElasticJobStep.md new file mode 100644 index 0000000000..8e9cfd36f8 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Add-AzSqlElasticJobStep.md @@ -0,0 +1,513 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/add-azsqlelasticjobstep +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlElasticJobStep.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlElasticJobStep.md +--- + +# Add-AzSqlElasticJobStep + +## SYNOPSIS +Adds a job step to a job + +## SYNTAX + +### DefaultSet (Default) +``` +Add-AzSqlElasticJobStep [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> -TargetGroupName <String> -CredentialName <String> -CommandText <String> -Name <String> + [-StepId <Int32>] [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] + [-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WithOutputDb +``` +Add-AzSqlElasticJobStep [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> -TargetGroupName <String> -CredentialName <String> -CommandText <String> + -OutputDatabaseObject <AzureSqlDatabaseModel> -OutputCredentialName <String> -OutputTableName <String> + -Name <String> [-OutputSchemaName <String>] [-StepId <Int32>] [-TimeoutSeconds <Int32>] + [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] [-MaximumRetryIntervalSeconds <Int32>] + [-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### WithOutputDbId +``` +Add-AzSqlElasticJobStep [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> -TargetGroupName <String> -CredentialName <String> -CommandText <String> + -OutputDatabaseResourceId <String> -OutputCredentialName <String> -OutputTableName <String> -Name <String> + [-OutputSchemaName <String>] [-StepId <Int32>] [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] + [-InitialRetryIntervalSeconds <Int32>] [-MaximumRetryIntervalSeconds <Int32>] + [-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectSet +``` +Add-AzSqlElasticJobStep [-ParentObject] <AzureSqlElasticJobModel> -TargetGroupName <String> + -CredentialName <String> -CommandText <String> -Name <String> [-StepId <Int32>] [-TimeoutSeconds <Int32>] + [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] [-MaximumRetryIntervalSeconds <Int32>] + [-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### WithOutputDbUsingParentObject +``` +Add-AzSqlElasticJobStep [-ParentObject] <AzureSqlElasticJobModel> -TargetGroupName <String> + -CredentialName <String> -CommandText <String> -OutputDatabaseObject <AzureSqlDatabaseModel> + -OutputCredentialName <String> -OutputTableName <String> -Name <String> [-OutputSchemaName <String>] + [-StepId <Int32>] [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] + [-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WithOutputDbIdUsingParentObject +``` +Add-AzSqlElasticJobStep [-ParentObject] <AzureSqlElasticJobModel> -TargetGroupName <String> + -CredentialName <String> -CommandText <String> -OutputDatabaseResourceId <String> + -OutputCredentialName <String> -OutputTableName <String> -Name <String> [-OutputSchemaName <String>] + [-StepId <Int32>] [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] + [-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Add-AzSqlElasticJobStep [-ParentResourceId] <String> -TargetGroupName <String> -CredentialName <String> + -CommandText <String> -Name <String> [-StepId <Int32>] [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] + [-InitialRetryIntervalSeconds <Int32>] [-MaximumRetryIntervalSeconds <Int32>] + [-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### WithOutputDbUsingParentResourceId +``` +Add-AzSqlElasticJobStep [-ParentResourceId] <String> -TargetGroupName <String> -CredentialName <String> + -CommandText <String> -OutputDatabaseObject <AzureSqlDatabaseModel> -OutputCredentialName <String> + -OutputTableName <String> -Name <String> [-OutputSchemaName <String>] [-StepId <Int32>] + [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] + [-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WithOutputDbIdUsingParentResourceId +``` +Add-AzSqlElasticJobStep [-ParentResourceId] <String> -TargetGroupName <String> -CredentialName <String> + -CommandText <String> -OutputDatabaseResourceId <String> -OutputCredentialName <String> + -OutputTableName <String> -Name <String> [-OutputSchemaName <String>] [-StepId <Int32>] + [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] + [-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Add-AzSqlElasticJobStep cmdlet adds a job step to a job + +## EXAMPLES + +### Example 1: Adds a step to a job +```powershell +$job = Get-AzSqlElasticJob -ResourceGroupName rg -ServerName elasticjobserver -Name job1 +$job | Add-AzSqlElasticJobStep -Name step1 -TargetGroupName tg1 -CredentialName cred1 -CommandText "SELECT 1" +``` + +```output +JobName StepName StepId TargetGroupName CredentialName Output CommandText +------- -------- ------ --------------- -------------- ------ ----------- +job1 step1 1 tg1 cred1 SELECT 1 +``` + +Adds a job step to a job + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithOutputDb, WithOutputDbId +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandText +The command text + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialName +The credential name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialRetryIntervalSeconds +The initial retry interval seconds + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The job name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithOutputDb, WithOutputDbId +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumRetryIntervalSeconds +The maximum retry interval seconds + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The job step name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StepName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputCredentialName +The output credential name + +```yaml +Type: System.String +Parameter Sets: WithOutputDb, WithOutputDbId, WithOutputDbUsingParentObject, WithOutputDbIdUsingParentObject, WithOutputDbUsingParentResourceId, WithOutputDbIdUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputDatabaseObject +The output database object + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: WithOutputDb, WithOutputDbUsingParentObject, WithOutputDbUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputDatabaseResourceId +The output database resource id + +```yaml +Type: System.String +Parameter Sets: WithOutputDbId, WithOutputDbIdUsingParentObject, WithOutputDbIdUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputSchemaName +The output schema name + +```yaml +Type: System.String +Parameter Sets: WithOutputDb, WithOutputDbId, WithOutputDbUsingParentObject, WithOutputDbIdUsingParentObject, WithOutputDbUsingParentResourceId, WithOutputDbIdUsingParentResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputTableName +The output table name + +```yaml +Type: System.String +Parameter Sets: WithOutputDb, WithOutputDbId, WithOutputDbUsingParentObject, WithOutputDbIdUsingParentObject, WithOutputDbUsingParentResourceId, WithOutputDbIdUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The job object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel +Parameter Sets: ObjectSet, WithOutputDbUsingParentObject, WithOutputDbIdUsingParentObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The job resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet, WithOutputDbUsingParentResourceId, WithOutputDbIdUsingParentResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithOutputDb, WithOutputDbId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetryAttempts +The retry attempts + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetryIntervalBackoffMultiplier +The retry interval back off multiplier + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithOutputDb, WithOutputDbId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StepId +The step id + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetGroupName +The target group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithOutputDb, WithOutputDbId, ObjectSet, WithOutputDbUsingParentObject, WithOutputDbIdUsingParentObject, ResourceIdSet, WithOutputDbIdUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: WithOutputDbUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutSeconds +The time out seconds + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobStepModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Add-AzSqlElasticJobTarget.md b/azps-10.1.0/Az.Sql/Add-AzSqlElasticJobTarget.md new file mode 100644 index 0000000000..5b463328a6 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Add-AzSqlElasticJobTarget.md @@ -0,0 +1,387 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/add-azsqlelasticjobtarget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlElasticJobTarget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlElasticJobTarget.md +--- + +# Add-AzSqlElasticJobTarget + +## SYNOPSIS +Adds a target to a target group + +## SYNTAX + +### SqlDatabase (Default) +``` +Add-AzSqlElasticJobTarget [-Exclude] [-ResourceGroupName] <String> [-AgentServerName] <String> + [-AgentName] <String> [-TargetGroupName] <String> -ServerName <String> -DatabaseName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlServerOrElasticPool +``` +Add-AzSqlElasticJobTarget [-Exclude] [-ResourceGroupName] <String> [-AgentServerName] <String> + [-AgentName] <String> [-TargetGroupName] <String> -ServerName <String> [-ElasticPoolName <String>] + -RefreshCredentialName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SqlShardMap +``` +Add-AzSqlElasticJobTarget [-Exclude] [-ResourceGroupName] <String> [-AgentServerName] <String> + [-AgentName] <String> [-TargetGroupName] <String> -ServerName <String> -ShardMapName <String> + -DatabaseName <String> -RefreshCredentialName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SqlDatabaseUsingParentObject +``` +Add-AzSqlElasticJobTarget [-Exclude] [-ParentObject] <AzureSqlElasticJobTargetGroupModel> -ServerName <String> + -DatabaseName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlServerOrElasticPoolUsingParentObject +``` +Add-AzSqlElasticJobTarget [-Exclude] [-ParentObject] <AzureSqlElasticJobTargetGroupModel> -ServerName <String> + [-ElasticPoolName <String>] -RefreshCredentialName <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlShardMapUsingParentObject +``` +Add-AzSqlElasticJobTarget [-Exclude] [-ParentObject] <AzureSqlElasticJobTargetGroupModel> -ServerName <String> + -ShardMapName <String> -DatabaseName <String> -RefreshCredentialName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlDatabaseUsingParentResourceId +``` +Add-AzSqlElasticJobTarget [-Exclude] [-ParentResourceId] <String> -ServerName <String> -DatabaseName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlServerOrElasticPoolUsingParentResourceId +``` +Add-AzSqlElasticJobTarget [-Exclude] [-ParentResourceId] <String> -ServerName <String> + [-ElasticPoolName <String>] -RefreshCredentialName <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlShardMapUsingParentResourceId +``` +Add-AzSqlElasticJobTarget [-Exclude] [-ParentResourceId] <String> -ServerName <String> -ShardMapName <String> + -DatabaseName <String> -RefreshCredentialName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Add-AzSqlElasticJobTarget cmdlet adds a target resource to a target group + +## EXAMPLES + +### Example 1: Add a server target +```powershell +$tg = Get-AzSqlElasticJobTargetGroup -ResourceGroupName rg -ServerName elasticjobserver -Name tg1 +$tg | Add-AzSqlElasticJobTarget -ServerName s1 -RefreshCredentialName cred1 +``` + +```output +TargetGroupName TargetType TargetServerName TargetDatabaseName TargetElasticPoolName TargetShardMapName RefreshCredentialName MembershipType +--------------- ---------- ---------------- ------------------ --------------------- ------------------ --------------------- -------------- +tg1 SqlServer s1 cred1 Include +``` + +### Example 2: Add a database target +```powershell +$tg = Get-AzSqlElasticJobTargetGroup -ResourceGroupName rg -ServerName elasticjobserver -Name tg1 +$tg | Add-AzSqlElasticJobTarget -ServerName s1 -DatabaseName db2 +``` + +```output +TargetGroupName TargetType TargetServerName TargetDatabaseName TargetElasticPoolName TargetShardMapName RefreshCredentialName MembershipType +--------------- ---------- ---------------- ------------------ --------------------- ------------------ --------------------- -------------- +tg1 SqlDatabase s1 db2 Include +``` + +### Example 3: Add an elastic pool target +```powershell +$tg | Add-AzSqlElasticJobTarget -ServerName s1 -ElasticPoolName ep1 -RefreshCredentialName cred1 +``` + +```output +TargetGroupName TargetType TargetServerName TargetDatabaseName TargetElasticPoolName TargetShardMapName RefreshCredentialName MembershipType +--------------- ---------- ---------------- ------------------ --------------------- ------------------ --------------------- -------------- +tg1 SqlElasticPool s1 ep1 cred1 Include +``` + +### Example 4: Add a shard map target +```powershell +$tg = Get-AzSqlElasticJobTargetGroup -ResourceGroupName rg -ServerName elasticjobserver -Name tg1 +$tg | Add-AzSqlElasticJobTarget -ServerName s1 -ShardMapName sm1 -DatabaseName db1 -RefreshCredentialName cred1 +``` + +```output +TargetGroupName TargetType TargetServerName TargetDatabaseName TargetElasticPoolName TargetShardMapName RefreshCredentialName MembershipType +--------------- ---------- ---------------- ------------------ --------------------- ------------------ --------------------- -------------- +tg1 SqlShardMap s1 db1 sm1 cred1 Include +``` + +Adds a target (server, elastic pool, database, and shard map) to a target group + +## PARAMETERS + +### -AgentName +The agent name. + +```yaml +Type: System.String +Parameter Sets: SqlDatabase, SqlServerOrElasticPool, SqlShardMap +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentServerName +The server name. + +```yaml +Type: System.String +Parameter Sets: SqlDatabase, SqlServerOrElasticPool, SqlShardMap +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database Target Name + +```yaml +Type: System.String +Parameter Sets: SqlDatabase, SqlShardMap, SqlDatabaseUsingParentObject, SqlShardMapUsingParentObject, SqlDatabaseUsingParentResourceId, SqlShardMapUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Elastic Pool Target Name + +```yaml +Type: System.String +Parameter Sets: SqlServerOrElasticPool, SqlServerOrElasticPoolUsingParentObject, SqlServerOrElasticPoolUsingParentResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Exclude +Excludes a target. + +```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 +``` + +### -ParentObject +The target group object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobTargetGroupModel +Parameter Sets: SqlDatabaseUsingParentObject, SqlServerOrElasticPoolUsingParentObject, SqlShardMapUsingParentObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The target group resource id. + +```yaml +Type: System.String +Parameter Sets: SqlDatabaseUsingParentResourceId, SqlServerOrElasticPoolUsingParentResourceId, SqlShardMapUsingParentResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RefreshCredentialName +Refresh Credential Name + +```yaml +Type: System.String +Parameter Sets: SqlServerOrElasticPool, SqlShardMap, SqlServerOrElasticPoolUsingParentObject, SqlShardMapUsingParentObject, SqlServerOrElasticPoolUsingParentResourceId, SqlShardMapUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: SqlDatabase, SqlServerOrElasticPool, SqlShardMap +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +Server Target Name + +```yaml +Type: System.String +Parameter Sets: SqlDatabase, SqlShardMap, SqlDatabaseUsingParentObject, SqlServerOrElasticPoolUsingParentObject, SqlShardMapUsingParentObject, SqlDatabaseUsingParentResourceId, SqlServerOrElasticPoolUsingParentResourceId, SqlShardMapUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: SqlServerOrElasticPool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShardMapName +Shard Map Target Name + +```yaml +Type: System.String +Parameter Sets: SqlShardMap, SqlShardMapUsingParentObject, SqlShardMapUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetGroupName +The target group name. + +```yaml +Type: System.String +Parameter Sets: SqlDatabase, SqlServerOrElasticPool, SqlShardMap +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobTargetGroupModel + +## OUTPUTS + +### Microsoft.Azure.Management.Sql.Models.JobTarget + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Add-AzSqlInstanceKeyVaultKey.md b/azps-10.1.0/Az.Sql/Add-AzSqlInstanceKeyVaultKey.md new file mode 100644 index 0000000000..b288e791b6 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Add-AzSqlInstanceKeyVaultKey.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/Add-AzSqlInstanceKeyVaultKey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlInstanceKeyVaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlInstanceKeyVaultKey.md +--- + +# Add-AzSqlInstanceKeyVaultKey + +## SYNOPSIS +Adds a key vault key to the provided Managed Instance. + +## SYNTAX + +### AddAzureRmSqlManagedInstanceKeyVaultKeyDefaultParameterSet (Default) +``` +Add-AzSqlInstanceKeyVaultKey [-ResourceGroupName] <String> [-InstanceName] <String> [-KeyId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AddAzureRmSqlManagedInstanceKeyVaultKeyInputObjectParameterSet +``` +Add-AzSqlInstanceKeyVaultKey [-Instance] <AzureSqlManagedInstanceModel> [-KeyId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AddAzureRmSqlManagedInstanceKeyVaultKeyResourceIdParameterSet +``` +Add-AzSqlInstanceKeyVaultKey [-InstanceResourceId] <String> [-KeyId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Add-AzSqlInstanceKeyVaultKey cmdlet adds a key vault key to the provided Managed Instance. The managed instance must have 'get, wrapKey, unwrapKey' permissions to the vault, use the following script to grant permission to the managed instance. +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +Set-AzKeyVaultAccessPolicy -VaultName ContosoVault -ObjectId $managedInstance.Identity.PrincipalId -PermissionsToKeys get, wrapKey, unwrapKey + +## EXAMPLES + +### Example 1 +```powershell +Add-AzSqlInstanceKeyVaultKey -ResourceGroupName 'ContosoResourceGroup' -InstanceName 'ContosoManagedInstanceName' -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901 +CreationDate : 9/1/2018 12:11:49 AM +Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1 +Type : AzureKeyVault +``` + +This command adds the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' to the SQL managed instance named 'ContosoManagedInstanceName' in the resource group 'ContosoResourceGroup'. + +### Example 2: Using managed instance object +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +Add-AzSqlInstanceKeyVaultKey -Instance $managedInstance -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901 +CreationDate : 9/1/2018 12:11:49 AM +Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1 +Type : AzureKeyVault +``` + +This command adds the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' to the SQL managed instance named 'ContosoManagedInstanceName' in the resource group 'ContosoResourceGroup'. + +### Example 3: Using managed instance resource id +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +Add-AzSqlInstanceKeyVaultKey -InstanceResourceId $managedInstance.ResourceId -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901 +CreationDate : 9/1/2018 12:11:49 AM +Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1 +Type : AzureKeyVault +``` + +This command adds the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' to the SQL managed instance named 'ContosoManagedInstanceName' in the resource group 'ContosoResourceGroup'. + +### Example 4: Using piping +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +$managedInstance | Add-AzSqlInstanceKeyVaultKey -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901 +CreationDate : 9/1/2018 12:11:49 AM +Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1 +Type : AzureKeyVault +``` + +This command adds the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' to the SQL managed instance named 'ContosoManagedInstanceName' in the resource group 'ContosoResourceGroup'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +The instance input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: AddAzureRmSqlManagedInstanceKeyVaultKeyInputObjectParameterSet +Aliases: InputObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The instance name + +```yaml +Type: System.String +Parameter Sets: AddAzureRmSqlManagedInstanceKeyVaultKeyDefaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceResourceId +The instance resource id + +```yaml +Type: System.String +Parameter Sets: AddAzureRmSqlManagedInstanceKeyVaultKeyResourceIdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyId +AzureKeyVault key id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: AddAzureRmSqlManagedInstanceKeyVaultKeyDefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureRmSqlManagedInstanceKeyVaultKeyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate.md b/azps-10.1.0/Az.Sql/Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate.md new file mode 100644 index 0000000000..6266278f21 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate.md +--- + +# Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate + +## SYNOPSIS +Adds a Transparent Data Encryption Certificate for the given managed instance + +## SYNTAX + +``` +Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate [-PassThru] [-ResourceGroupName] <String> + [-ManagedInstanceName] <String> [-PrivateBlob] <SecureString> [-Password] <SecureString> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate adds a Transparent Data Encryption Certificate for the given managed instance + +## EXAMPLES + +### Example 1 +```powershell +$privateBlob = "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3Dasdsadasd" +$securePrivateBlob = $privateBlob | ConvertTo-SecureString -AsPlainText -Force +$password = "CertificatePassword" +$securePassword = $password | ConvertTo-SecureString -AsPlainText -Force +Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate -ResourceGroupName "YourResourceGroupName" -ManagedInstanceName "YourManagedInstanceName" -PrivateBlob $securePrivateBlob -Password $securePassword +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedInstanceName +The managed instance name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +On Successful execution, returns certificate object that was added. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The Password for Transparent Data Encryption Certificate + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateBlob +The Private blob for Transparent Data Encryption Certificate + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Add-AzSqlServerKeyVaultKey.md b/azps-10.1.0/Az.Sql/Add-AzSqlServerKeyVaultKey.md new file mode 100644 index 0000000000..69ed791b4d --- /dev/null +++ b/azps-10.1.0/Az.Sql/Add-AzSqlServerKeyVaultKey.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/add-azsqlserverkeyvaultkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlServerKeyVaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlServerKeyVaultKey.md +--- + +# Add-AzSqlServerKeyVaultKey + +## SYNOPSIS +Adds a Key Vault key to a SQL server. + +## SYNTAX + +``` +Add-AzSqlServerKeyVaultKey [-KeyId] <String> [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Add-AzSqlServerKeyVaultKey cmdlet adds a Key Vault key to the provided SQL server. +The server must have 'get, wrapKey, unwrapKey' permissions to the vault. + +## EXAMPLES + +### Example 1: Add Key Vault key +```powershell +Add-AzSqlServerKeyVaultKey -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ServerName : ContosoServer +ServerKeyName : contoso_contosokey_01234567890123456789012345678901 +Type : AzureKeyVault +Uri : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +Thumbprint : 1122334455667788990011223344556677889900 +CreationDate : 1/1/2017 12:00:00 AM +``` + +This command adds the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' to the SQL server named 'ContosoServer' in the resource group 'ContosoResourceGroup'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyId +The Azure Key Vault KeyId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerKeyVaultKey.Model.AzureSqlServerKeyVaultKeyModel + +## NOTES + +## RELATED LINKS + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Add-AzSqlServerTransparentDataEncryptionCertificate.md b/azps-10.1.0/Az.Sql/Add-AzSqlServerTransparentDataEncryptionCertificate.md new file mode 100644 index 0000000000..a159742be5 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Add-AzSqlServerTransparentDataEncryptionCertificate.md @@ -0,0 +1,245 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/Add-AzSqlServerTransparentDataEncryptionCertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlServerTransparentDataEncryptionCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Add-AzSqlServerTransparentDataEncryptionCertificate.md +--- + +# Add-AzSqlServerTransparentDataEncryptionCertificate + +## SYNOPSIS +Adds a Transparent Data Encryption Certificate for the given SQL Server instance + +## SYNTAX + +### AddAzureRmSqlServerTransparentDataEncryptionCertificateDefaultParameterSet (Default) +``` +Add-AzSqlServerTransparentDataEncryptionCertificate [-PassThru] [-ResourceGroupName] <String> + [-ServerName] <String> [-PrivateBlob] <SecureString> [-Password] <SecureString> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AddAzureRmSqlServerTransparentDataEncryptionCertificateInputObjectParameterSet +``` +Add-AzSqlServerTransparentDataEncryptionCertificate [-PassThru] [-SqlServer] <AzureSqlServerModel> + [-PrivateBlob] <SecureString> [-Password] <SecureString> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AddAzureRmSqlServerTransparentDataEncryptionCertificateResourceIdParameterSet +``` +Add-AzSqlServerTransparentDataEncryptionCertificate [-PassThru] [-SqlServerResourceId] <String> + [-PrivateBlob] <SecureString> [-Password] <SecureString> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate adds a Transparent Data Encryption Certificate for the given SQL Server instance + +## EXAMPLES + +### Example 1 +```powershell +$privateBlob = "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3Dasdsadasd" +$securePrivateBlob = $privateBlob | ConvertTo-SecureString -AsPlainText -Force +$password = "CertificatePassword" +$securePassword = $password | ConvertTo-SecureString -AsPlainText -Force +Add-AzSqlServerTransparentDataEncryptionCertificate -ResourceGroupName "YourResourceGroupName" -ServerName "YourServerName" -PrivateBlob $securePrivateBlob -Password $securePassword +``` + +Add TDE certificate to a sql server using resource group name and SQL Server name + +### Example 2 +```powershell +$privateBlob = "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3Dasdsadasd" +$securePrivateBlob = $privateBlob | ConvertTo-SecureString -AsPlainText -Force +$password = "CertificatePassword" +$securePassword = $password | ConvertTo-SecureString -AsPlainText -Force +$server = Get-AzSqlServer -ServerName "YourServerName" -ResourceGroupName "YourResourceGroupName" +Add-AzSqlServerTransparentDataEncryptionCertificate -SqlServerResourceId $server.ResourceId -PrivateBlob $securePrivateBlob -Password $securePassword +``` + +Add TDE certificate to the servers using server resourceId + +### Example 3 +```powershell +$privateBlob = "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3Dasdsadasd" +$securePrivateBlob = $privateBlob | ConvertTo-SecureString -AsPlainText -Force +$password = "CertificatePassword" +$securePassword = $password | ConvertTo-SecureString -AsPlainText -Force +Get-AzSqlServer | Add-AzSqlServerTransparentDataEncryptionCertificate -ResourceGroupName "YourResourceGroupName" -PrivateBlob $securePrivateBlob -Password $securePassword +``` + +Add TDE certificate to all sql servers in a resource group + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +On Successful execution, returns certificate object that was added. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The Password for Transparent Data Encryption Certificate + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateBlob +The Private blob for Transparent Data Encryption Certificate + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: AddAzureRmSqlServerTransparentDataEncryptionCertificateDefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The Server Name + +```yaml +Type: System.String +Parameter Sets: AddAzureRmSqlServerTransparentDataEncryptionCertificateDefaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlServer +The sql server input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: AddAzureRmSqlServerTransparentDataEncryptionCertificateInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SqlServerResourceId +The sql server resource id + +```yaml +Type: System.String +Parameter Sets: AddAzureRmSqlServerTransparentDataEncryptionCertificateResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Az.Sql.md b/azps-10.1.0/Az.Sql/Az.Sql.md new file mode 100644 index 0000000000..6fc2324c4d --- /dev/null +++ b/azps-10.1.0/Az.Sql/Az.Sql.md @@ -0,0 +1,907 @@ +--- +Module Name: Az.Sql +Module Guid: 150d9544-6348-4373-806f-10cd0b4de4cb +Download Help Link: https://learn.microsoft.com/powershell/module/az.sql +Help Version: 4.4.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Az.Sql.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Az.Sql.md +--- + +# Az.Sql Module +## Description +This topic displays help topics for the Azure SQL Database Cmdlets. + +## Az.Sql Cmdlets +### [Add-AzSqlDatabaseToFailoverGroup](Add-AzSqlDatabaseToFailoverGroup.md) +Adds one or more databases to an Azure SQL Database Failover Group. + +### [Add-AzSqlElasticJobStep](Add-AzSqlElasticJobStep.md) +Adds a job step to a job + +### [Add-AzSqlElasticJobTarget](Add-AzSqlElasticJobTarget.md) +Adds a target to a target group + +### [Add-AzSqlInstanceKeyVaultKey](Add-AzSqlInstanceKeyVaultKey.md) +Adds a key vault key to the provided Managed Instance. + +### [Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate](Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate.md) +Adds a Transparent Data Encryption Certificate for the given managed instance + +### [Add-AzSqlServerKeyVaultKey](Add-AzSqlServerKeyVaultKey.md) +Adds a Key Vault key to a SQL server. + +### [Add-AzSqlServerTransparentDataEncryptionCertificate](Add-AzSqlServerTransparentDataEncryptionCertificate.md) +Adds a Transparent Data Encryption Certificate for the given SQL Server instance + +### [Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline](Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md) +Clears the vulnerability assessment rule baseline. + +### [Clear-AzSqlDatabaseVulnerabilityAssessmentSetting](Clear-AzSqlDatabaseVulnerabilityAssessmentSetting.md) +Clears the vulnerability assessment settings of a database. + +### [Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline](Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md) +Clears the vulnerability assessment rule baseline. + +### [Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting](Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md) +Clears the vulnerability assessment settings of a managed database. + +### [Clear-AzSqlInstanceVulnerabilityAssessmentSetting](Clear-AzSqlInstanceVulnerabilityAssessmentSetting.md) +Clears the vulnerability assessment settings of a managed instance. + +### [Clear-AzSqlServerVulnerabilityAssessmentSetting](Clear-AzSqlServerVulnerabilityAssessmentSetting.md) +Clears the vulnerability assessment settings of a server. + +### [Complete-AzSqlInstanceDatabaseLogReplay](Complete-AzSqlInstanceDatabaseLogReplay.md) +Completes Log Replay service for the given database. + +### [Convert-AzSqlDatabaseVulnerabilityAssessmentScan](Convert-AzSqlDatabaseVulnerabilityAssessmentScan.md) +Converts a vulnerability assessment scan results to Excel format. + +### [Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan](Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan.md) +Converts a vulnerability assessment scan results to Excel format. + +### [Copy-AzSqlDatabaseLongTermRetentionBackup](Copy-AzSqlDatabaseLongTermRetentionBackup.md) +Copies a long term retention backup to a target database. + +### [Disable-AzSqlDatabaseLedgerDigestUpload](Disable-AzSqlDatabaseLedgerDigestUpload.md) +Disables uploading ledger digests to Azure Blob storage or to Azure Confidential Ledger. + +### [Disable-AzSqlDatabaseSensitivityRecommendation](Disable-AzSqlDatabaseSensitivityRecommendation.md) +Disables (dismisses) sensitivity recommendations on columns in the database. + +### [Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication](Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md) +Disables Azure AD only authentication for a specific SQL Managed Instance. + +### [Disable-AzSqlInstanceAdvancedDataSecurity](Disable-AzSqlInstanceAdvancedDataSecurity.md) +Disables Advanced Data Security on a managed instance. + +### [Disable-AzSqlInstanceDatabaseSensitivityRecommendation](Disable-AzSqlInstanceDatabaseSensitivityRecommendation.md) +Disables (dismisses) sensitivity recommendations on columns in the Azure SQL Managed Instance database. + +### [Disable-AzSqlInstanceDatabaseLedgerDigestUpload](Disable-AzSqlInstanceDatabaseLedgerDigestUpload.md) +Disables uploading ledger digests to Azure Blob storage or Azure Confidential Ledger in Azure SQL Managed Instance. + +### [Disable-AzSqlServerActiveDirectoryOnlyAuthentication](Disable-AzSqlServerActiveDirectoryOnlyAuthentication.md) +Disables Azure AD only authentication for a specific SQL Server. + +### [Disable-AzSqlServerAdvancedDataSecurity](Disable-AzSqlServerAdvancedDataSecurity.md) +Disables Advanced Data Security on a server. + +### [Enable-AzSqlDatabaseLedgerDigestUpload](Enable-AzSqlDatabaseLedgerDigestUpload.md) +Enables uploading ledger digests to an Azure Storage account or to Azure Confidential Ledger. + +### [Enable-AzSqlDatabaseSensitivityRecommendation](Enable-AzSqlDatabaseSensitivityRecommendation.md) +Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the database. + +### [Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication](Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md) +Enables Azure AD only authentication for a specific SQL Managed Instance. + +### [Enable-AzSqlInstanceAdvancedDataSecurity](Enable-AzSqlInstanceAdvancedDataSecurity.md) +Enables Advanced Data Security on a managed instance. + +### [Enable-AzSqlInstanceDatabaseSensitivityRecommendation](Enable-AzSqlInstanceDatabaseSensitivityRecommendation.md) +Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the Azure SQL Managed Instance database. + +### [Enable-AzSqlInstanceDatabaseLedgerDigestUpload](Enable-AzSqlInstanceDatabaseLedgerDigestUpload.md) +Enables uploading ledger digests to an Azure Storage account or Azure Confidential Ledger for a database in an Azure SQL Managed Instance. + +### [Enable-AzSqlServerActiveDirectoryOnlyAuthentication](Enable-AzSqlServerActiveDirectoryOnlyAuthentication.md) +Enables Azure AD only authentication for a specific SQL Server. + +### [Enable-AzSqlServerAdvancedDataSecurity](Enable-AzSqlServerAdvancedDataSecurity.md) +Enables Advanced Data Security on a server. + +### [Get-AzSqlCapability](Get-AzSqlCapability.md) +Gets SQL Database capabilities for the current subscription. + +### [Get-AzSqlDatabase](Get-AzSqlDatabase.md) +Gets one or more databases. + +### [Get-AzSqlDatabaseActivity](Get-AzSqlDatabaseActivity.md) +Gets the status of database operations. + +### [Get-AzSqlDatabaseAdvancedThreatProtectionSetting](Get-AzSqlDatabaseAdvancedThreatProtectionSetting.md) +Gets the Advanced Threat Protection settings for a database. + +### [Get-AzSqlDatabaseAdvisor](Get-AzSqlDatabaseAdvisor.md) +Gets one or more Advisors for an Azure SQL Database. + +### [Get-AzSqlDatabaseAudit](Get-AzSqlDatabaseAudit.md) +Gets the auditing settings of an Azure SQL database. + +### [Get-AzSqlDatabaseBackupLongTermRetentionPolicy](Get-AzSqlDatabaseBackupLongTermRetentionPolicy.md) +Gets a database long term retention policy. + +### [Get-AzSqlDatabaseBackupShortTermRetentionPolicy](Get-AzSqlDatabaseBackupShortTermRetentionPolicy.md) +Gets a backup short term retention policy. + +### [Get-AzSqlDatabaseDataMaskingPolicy](Get-AzSqlDatabaseDataMaskingPolicy.md) +Gets the data masking policy for a database. + +### [Get-AzSqlDatabaseDataMaskingRule](Get-AzSqlDatabaseDataMaskingRule.md) +Gets the data masking rules from a database. + +### [Get-AzSqlDatabaseExpanded](Get-AzSqlDatabaseExpanded.md) +Gets a database and its expanded property values. + +### [Get-AzSqlDatabaseFailoverGroup](Get-AzSqlDatabaseFailoverGroup.md) +Gets or lists Azure SQL Database Failover Groups. + +### [Get-AzSqlDatabaseGeoBackup](Get-AzSqlDatabaseGeoBackup.md) +Gets a geo-redundant backup of a database. + +### [Get-AzSqlDatabaseGeoBackupPolicy](Get-AzSqlDatabaseGeoBackupPolicy.md) +Gets a database geo backup policy. + +### [Get-AzSqlDatabaseImportExportStatus](Get-AzSqlDatabaseImportExportStatus.md) +Gets the details of an import or export of an Azure SQL Database. + +### [Get-AzSqlDatabaseIndexRecommendation](Get-AzSqlDatabaseIndexRecommendation.md) +Gets the recommended index operations for a server or database. + +### [Get-AzSqlDatabaseInstanceFailoverGroup](Get-AzSqlDatabaseInstanceFailoverGroup.md) +Gets or lists Instance Failover Groups. + +### [Get-AzSqlDatabaseLedgerDigestUpload](Get-AzSqlDatabaseLedgerDigestUpload.md) +Gets the ledger digest upload settings of an Azure SQL database. + +### [Get-AzSqlDatabaseLongTermRetentionBackup](Get-AzSqlDatabaseLongTermRetentionBackup.md) +Gets one or more long term retention backups. + +### [Get-AzSqlDatabaseRecommendedAction](Get-AzSqlDatabaseRecommendedAction.md) +Gets one or more recommended actions for an Azure SQL Database Advisor. + +### [Get-AzSqlDatabaseReplicationLink](Get-AzSqlDatabaseReplicationLink.md) +Gets the geo-replication links between an Azure SQL Database and a resource group or SQL Server. + +### [Get-AzSqlDatabaseRestorePoint](Get-AzSqlDatabaseRestorePoint.md) +Retrieves the distinct restore points from which a SQL Data Warehouse can be restored. + +### [Get-AzSqlDatabaseSensitivityClassification](Get-AzSqlDatabaseSensitivityClassification.md) +Gets the current information types and sensitivity labels of columns in the database. + +### [Get-AzSqlDatabaseSensitivityRecommendation](Get-AzSqlDatabaseSensitivityRecommendation.md) +Gets the recommended information types and sensitivity labels of columns in the database. + +### [Get-AzSqlDatabaseTransparentDataEncryption](Get-AzSqlDatabaseTransparentDataEncryption.md) +Gets the TDE state for a database. + +### [Get-AzSqlDatabaseUpgradeHint](Get-AzSqlDatabaseUpgradeHint.md) +Gets pricing tier hints for a database. + +### [Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline](Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md) +Gets the vulnerability assessment rule baseline. + +### [Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord](Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord.md) +Gets all vulnerability assessment scan record(s) associated with a given database. + +### [Get-AzSqlDatabaseVulnerabilityAssessmentSetting](Get-AzSqlDatabaseVulnerabilityAssessmentSetting.md) +Gets the vulnerability assessment settings of a database. + +### [Get-AzSqlDeletedDatabaseBackup](Get-AzSqlDeletedDatabaseBackup.md) +Gets a deleted database that you can restore. + +### [Get-AzSqlDeletedInstanceDatabaseBackup](Get-AzSqlDeletedInstanceDatabaseBackup.md) +Gets a deleted database that you can restore. + +### [Get-AzSqlElasticJob](Get-AzSqlElasticJob.md) +Gets one or more jobs + +### [Get-AzSqlElasticJobAgent](Get-AzSqlElasticJobAgent.md) +Gets a Azure SQL Elastic Job agent + +### [Get-AzSqlElasticJobCredential](Get-AzSqlElasticJobCredential.md) +Gets one or more credentials + +### [Get-AzSqlElasticJobExecution](Get-AzSqlElasticJobExecution.md) +Gets one or more job executions + +### [Get-AzSqlElasticJobStep](Get-AzSqlElasticJobStep.md) +Gets one or more job steps + +### [Get-AzSqlElasticJobStepExecution](Get-AzSqlElasticJobStepExecution.md) +Gets one or more job step executions + +### [Get-AzSqlElasticJobTargetExecution](Get-AzSqlElasticJobTargetExecution.md) +Gets one or more job target executions + +### [Get-AzSqlElasticJobTargetGroup](Get-AzSqlElasticJobTargetGroup.md) +Gets one or more job target groups + +### [Get-AzSqlElasticPool](Get-AzSqlElasticPool.md) +Gets elastic pools and their property values in an Azure SQL Database. + +### [Get-AzSqlElasticPoolActivity](Get-AzSqlElasticPoolActivity.md) +Gets the status of operations on an elastic pool. + +### [Get-AzSqlElasticPoolAdvisor](Get-AzSqlElasticPoolAdvisor.md) +Gets one or more Advisors for an Azure SQL Elastic Pool. + +### [Get-AzSqlElasticPoolDatabase](Get-AzSqlElasticPoolDatabase.md) +Gets elastic databases in an elastic pool and their property values. + +### [Get-AzSqlElasticPoolRecommendation](Get-AzSqlElasticPoolRecommendation.md) +Gets elastic pool recommendations. + +### [Get-AzSqlElasticPoolRecommendedAction](Get-AzSqlElasticPoolRecommendedAction.md) +Gets one or more recommended actions for an Azure SQL Elastic Pool Advisor. + +### [Get-AzSqlInstance](Get-AzSqlInstance.md) +Returns information about Azure SQL Managed Database Instance. + +### [Get-AzSqlInstanceActiveDirectoryAdministrator](Get-AzSqlInstanceActiveDirectoryAdministrator.md) +Gets information about an Azure AD administrator for SQL Managed Instance. + +### [Get-AzSqlInstanceActiveDirectoryOnlyAuthentication](Get-AzSqlInstanceActiveDirectoryOnlyAuthentication.md) +Gets Azure AD only authentication for a specific SQL Managed Instance. + +### [Get-AzSqlInstanceAdvancedDataSecurityPolicy](Get-AzSqlInstanceAdvancedDataSecurityPolicy.md) +Gets Advanced Data Security policy of a managed instance. + +### [Get-AzSqlInstanceAdvancedThreatProtectionSetting](Get-AzSqlInstanceAdvancedThreatProtectionSetting.md) +Gets the Advanced Threat Protection settings for a managed instance. + +### [Get-AzSqlInstanceDatabase](Get-AzSqlInstanceDatabase.md) +Returns information about Azure SQL Managed Instance database. + +### [Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting](Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting.md) +Gets the Advanced Threat Protection settings for a managed database. + +### [Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy](Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md) +Gets a managed database's long term retention policy + +### [Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy](Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy.md) +Gets a backup short term retention policy. + +### [Get-AzSqlInstanceDatabaseGeoBackup](Get-AzSqlInstanceDatabaseGeoBackup.md) +Returns information about Azure SQL Managed Instance database redundant backup. + +### [Get-AzSqlInstanceDatabaseLedgerDigestUpload](Get-AzSqlInstanceDatabaseLedgerDigestUpload.md) +Gets the ledger digest upload settings of a database in Azure SQL Managed Instance. + +### [Get-AzSqlInstanceDatabaseLogReplay](Get-AzSqlInstanceDatabaseLogReplay.md) +Gets the Log Replay service status. + +### [Get-AzSqlInstanceDatabaseLongTermRetentionBackup](Get-AzSqlInstanceDatabaseLongTermRetentionBackup.md) +Gets long term retention backup(s). + +### [Get-AzSqlInstanceDatabaseSensitivityClassification](Get-AzSqlInstanceDatabaseSensitivityClassification.md) +Gets the current information types and sensitivity labels of columns in the Azure SQL Managed Instance database. + +### [Get-AzSqlInstanceDatabaseSensitivityRecommendation](Get-AzSqlInstanceDatabaseSensitivityRecommendation.md) +Gets the recommended information types and sensitivity labels of columns in the Azure SQL Managed Instance database. + +### [Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline](Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md) +Gets the vulnerability assessment rule baseline. + +### [Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord](Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord.md) +Gets all vulnerability assessment scan record(s) associated with a given managed database. + +### [Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting](Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md) +Gets the vulnerability assessment settings of a managed database. + +### [Get-AzSqlInstanceDtc](Get-AzSqlInstanceDtc.md) +Gets an Azure SQL Managed Instance DTC. + +### [Get-AzSqlInstanceEndpointCertificate](Get-AzSqlInstanceEndpointCertificate.md) +Returns information about endpoint certificates. + +### [Get-AzSqlInstanceKeyVaultKey](Get-AzSqlInstanceKeyVaultKey.md) +Gets a SQL managed instance's Key Vault keys. + +### [Get-AzSqlInstanceLink](Get-AzSqlInstanceLink.md) +Returns information about link feature for Azure SQL Managed Instance. + +### [Get-AzSqlInstanceOperation](Get-AzSqlInstanceOperation.md) +Gets a SQL managed instance's operations. + +### [Get-AzSqlInstancePool](Get-AzSqlInstancePool.md) +Returns information about the Azure SQL Instance pool. + +### [Get-AzSqlInstancePoolUsage](Get-AzSqlInstancePoolUsage.md) +Returns information about an Azure SQL Instance pool's usage. + +### [Get-AzSqlInstanceServerTrustCertificate](Get-AzSqlInstanceServerTrustCertificate.md) +Returns information about server trust certificate. + +### [Get-AzSqlInstanceTransparentDataEncryptionProtector](Get-AzSqlInstanceTransparentDataEncryptionProtector.md) +Gets the Transparent Data Encryption (TDE) protector for a SQL managed instance. + +### [Get-AzSqlInstanceVulnerabilityAssessmentSetting](Get-AzSqlInstanceVulnerabilityAssessmentSetting.md) +Gets the vulnerability assessment settings of a managed instance. + +### [Get-AzSqlServer](Get-AzSqlServer.md) +Returns information about SQL Database servers. + +### [Get-AzSqlServerActiveDirectoryAdministrator](Get-AzSqlServerActiveDirectoryAdministrator.md) +Gets information about an Azure AD administrator for SQL Server. + +### [Get-AzSqlServerActiveDirectoryOnlyAuthentication](Get-AzSqlServerActiveDirectoryOnlyAuthentication.md) +Gets Azure AD only authentication for a specific SQL Server. + +### [Get-AzSqlServerAdvancedDataSecurityPolicy](Get-AzSqlServerAdvancedDataSecurityPolicy.md) +Gets Advanced Data Security policy of a server. + +### [Get-AzSqlServerAdvancedThreatProtectionSetting](Get-AzSqlServerAdvancedThreatProtectionSetting.md) +Gets the Advanced Threat Protection settings for a server. + +### [Get-AzSqlServerAdvisor](Get-AzSqlServerAdvisor.md) +Gets one or more Advisors for an Azure SQL Server. + +### [Get-AzSqlServerAudit](Get-AzSqlServerAudit.md) +Gets the auditing settings of an Azure SQL server. + +### [Get-AzSqlServerCommunicationLink](Get-AzSqlServerCommunicationLink.md) +Gets communication links for elastic database transactions between database servers. + +### [Get-AzSqlServerConfigurationOption](Get-AzSqlServerConfigurationOption.md) +Gets server configuration option of an Azure SQL Managed Instance. + +### [Get-AzSqlServerDisasterRecoveryConfiguration](Get-AzSqlServerDisasterRecoveryConfiguration.md) +Gets a database server system recovery configuration. + +### [Get-AzSqlServerDisasterRecoveryConfigurationActivity](Get-AzSqlServerDisasterRecoveryConfigurationActivity.md) +Gets activity for a database server system recovery configuration. + +### [Get-AzSqlServerDnsAlias](Get-AzSqlServerDnsAlias.md) +Gets or lists Azure SQL Server DNS Alias. + +### [Get-AzSqlServerFirewallRule](Get-AzSqlServerFirewallRule.md) +Gets firewall rules for a SQL Database server. + +### [Get-AzSqlServerIpv6FirewallRule](Get-AzSqlServerIpv6FirewallRule.md) +Gets IPv6 firewall rules for a SQL Database server. + +### [Get-AzSqlServerKeyVaultKey](Get-AzSqlServerKeyVaultKey.md) +Gets a SQL server's Key Vault keys. + +### [Get-AzSqlServerMSSupportAudit](Get-AzSqlServerMSSupportAudit.md) +Gets the Microsoft support operations auditing settings of an Azure SQL server. + +### [Get-AzSqlServerOutboundFirewallRule](Get-AzSqlServerOutboundFirewallRule.md) +Gets outbound firewall rules (Allowed FQDNs) for a SQL Database server. + +### [Get-AzSqlServerRecommendedAction](Get-AzSqlServerRecommendedAction.md) +Gets one or more recommended actions for an Azure SQL Server Advisor. + +### [Get-AzSqlServerServiceObjective](Get-AzSqlServerServiceObjective.md) +Gets service objectives for an Azure SQL Database server. + +### [Get-AzSqlServerTransparentDataEncryptionProtector](Get-AzSqlServerTransparentDataEncryptionProtector.md) +Gets the Transparent Data Encryption (TDE) protector + +### [Get-AzSqlServerTrustGroup](Get-AzSqlServerTrustGroup.md) +Gets information about Server Trust Group. + +### [Get-AzSqlServerUpgradeHint](Get-AzSqlServerUpgradeHint.md) +Gets pricing tier hints for upgrading an Azure SQL Database server. + +### [Get-AzSqlServerVirtualNetworkRule](Get-AzSqlServerVirtualNetworkRule.md) +Gets or lists Azure SQL Server Virtual Network Rule. + +### [Get-AzSqlServerVulnerabilityAssessmentSetting](Get-AzSqlServerVulnerabilityAssessmentSetting.md) +Gets the vulnerability assessment settings of a server. + +### [Get-AzSqlSyncAgent](Get-AzSqlSyncAgent.md) +Returns information about Azure SQL Sync Agents. + +### [Get-AzSqlSyncAgentLinkedDatabase](Get-AzSqlSyncAgentLinkedDatabase.md) +Returns information about SQL Server databases linked by a sync agent. + +### [Get-AzSqlSyncGroup](Get-AzSqlSyncGroup.md) +Returns information about Azure SQL Database Sync Groups. + +### [Get-AzSqlSyncGroupLog](Get-AzSqlSyncGroupLog.md) +Returns the logs of an Azure SQL Database Sync Group. + +### [Get-AzSqlSyncMember](Get-AzSqlSyncMember.md) +Returns information about Azure SQL Database Sync Members. + +### [Get-AzSqlSyncSchema](Get-AzSqlSyncSchema.md) +Returns information about the sync schema of a member database or a hub database. + +### [Get-AzSqlVirtualCluster](Get-AzSqlVirtualCluster.md) +Returns information about Azure SQL Virtual Cluster. + +### [Invoke-AzSqlDatabaseFailover](Invoke-AzSqlDatabaseFailover.md) +Failovers a database. + +### [Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation](Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation.md) +Revalidates Database Encryption Protector AKV key + +### [Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert](Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert.md) +Reverts Database Encryption Protector AKV key to Server level key + +### [Invoke-AzSqlElasticPoolFailover](Invoke-AzSqlElasticPoolFailover.md) +Failovers an elastic pool. + +### [Invoke-AzSqlInstanceFailover](Invoke-AzSqlInstanceFailover.md) +Failovers an Azure SQL Managed Instance. + +### [Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation](Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation.md) +Revalidates the Managed Instance Encryption Protector AKV key + +### [Invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation](Invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation.md) +Revalidates the Server Encryption Protector AKV key + +### [New-AzSqlDatabase](New-AzSqlDatabase.md) +Creates a database or an elastic database. + +### [New-AzSqlDatabaseCopy](New-AzSqlDatabaseCopy.md) +Creates a copy of a SQL Database that uses the snapshot at the current time. + +### [New-AzSqlDatabaseDataMaskingRule](New-AzSqlDatabaseDataMaskingRule.md) +Creates a data masking rule for a database. + +### [New-AzSqlDatabaseExport](New-AzSqlDatabaseExport.md) +Exports an Azure SQL Database as a .bacpac file to a storage account. + +### [New-AzSqlDatabaseFailoverGroup](New-AzSqlDatabaseFailoverGroup.md) +This command creates a new Azure SQL Database Failover Group. + +### [New-AzSqlDatabaseImport](New-AzSqlDatabaseImport.md) +Imports a .bacpac file and create a new database on the server. + +### [New-AzSqlDatabaseInstanceFailoverGroup](New-AzSqlDatabaseInstanceFailoverGroup.md) +This command creates a new Azure SQL Database Instance Failover Group. + +### [New-AzSqlDatabaseRestorePoint](New-AzSqlDatabaseRestorePoint.md) +Creates a new restore point from which a SQL Database can be restored. + +### [New-AzSqlDatabaseSecondary](New-AzSqlDatabaseSecondary.md) +Creates a secondary database for an existing database and starts data replication. + +### [New-AzSqlElasticJob](New-AzSqlElasticJob.md) +Creates a new job + +### [New-AzSqlElasticJobAgent](New-AzSqlElasticJobAgent.md) +Creates a new elastic job agent + +### [New-AzSqlElasticJobCredential](New-AzSqlElasticJobCredential.md) +Creates a new job credential + +### [New-AzSqlElasticJobTargetGroup](New-AzSqlElasticJobTargetGroup.md) +Creates a new target group + +### [New-AzSqlElasticPool](New-AzSqlElasticPool.md) +Creates an elastic database pool for a SQL Database. + +### [New-AzSqlInstance](New-AzSqlInstance.md) +Creates an Azure SQL Managed Instance. + +### [New-AzSqlInstanceDatabase](New-AzSqlInstanceDatabase.md) +Creates an Azure SQL Managed Instance database. + +### [New-AzSqlInstanceLink](New-AzSqlInstanceLink.md) +Creates a new instance link. + +### [New-AzSqlInstancePool](New-AzSqlInstancePool.md) +Creates an Azure SQL Instance pool. + +### [New-AzSqlInstanceServerTrustCertificate](New-AzSqlInstanceServerTrustCertificate.md) +Creates a new server trust certificate. + +### [New-AzSqlServer](New-AzSqlServer.md) +Creates a SQL Database server. + +### [New-AzSqlServerCommunicationLink](New-AzSqlServerCommunicationLink.md) +Creates a communication link for elastic database transactions between two SQL Database servers. + +### [New-AzSqlServerDisasterRecoveryConfiguration](New-AzSqlServerDisasterRecoveryConfiguration.md) +Creates a database server system recovery configuration. + +### [New-AzSqlServerDnsAlias](New-AzSqlServerDnsAlias.md) +This command creates a new Azure SQL Server DNS Alias. + +### [New-AzSqlServerFirewallRule](New-AzSqlServerFirewallRule.md) +Creates a firewall rule for a SQL Database server. + +### [New-AzSqlServerIpv6FirewallRule](New-AzSqlServerIpv6FirewallRule.md) +Creates an IPv6 firewall rule for a SQL Database server. + +### [New-AzSqlServerOutboundFirewallRule](New-AzSqlServerOutboundFirewallRule.md) +Adds the allowed FQDN to the list of outbound firewall rules and creates a new outbound firewall rule for Azure SQL Database server. + +### [New-AzSqlServerTrustGroup](New-AzSqlServerTrustGroup.md) +Creates or updates a Server Trust Group. + +### [New-AzSqlServerVirtualNetworkRule](New-AzSqlServerVirtualNetworkRule.md) +Creates an Azure SQL Server Virtual Network Rule. + +### [New-AzSqlSyncAgent](New-AzSqlSyncAgent.md) +Creates an Azure SQL Sync Agent. + +### [New-AzSqlSyncAgentKey](New-AzSqlSyncAgentKey.md) +Creates an Azure SQL Sync Agent Key. + +### [New-AzSqlSyncGroup](New-AzSqlSyncGroup.md) +Creates an Azure SQL Database Sync Group. + +### [New-AzSqlSyncMember](New-AzSqlSyncMember.md) +Creates an Azure SQL Database Sync Member. + +### [Remove-AzSqlDatabase](Remove-AzSqlDatabase.md) +Removes an Azure SQL database. + +### [Remove-AzSqlDatabaseAudit](Remove-AzSqlDatabaseAudit.md) +Removes the auditing settings of an Azure SQL database. + +### [Remove-AzSqlDatabaseDataMaskingRule](Remove-AzSqlDatabaseDataMaskingRule.md) +Removes a data masking rule from a database. + +### [Remove-AzSqlDatabaseFailoverGroup](Remove-AzSqlDatabaseFailoverGroup.md) +Removes an Azure SQL Database Failover Group. + +### [Remove-AzSqlDatabaseFromFailoverGroup](Remove-AzSqlDatabaseFromFailoverGroup.md) +Removes one or more databases from an Azure SQL Database Failover Group. + +### [Remove-AzSqlDatabaseInstanceFailoverGroup](Remove-AzSqlDatabaseInstanceFailoverGroup.md) +Removes an Instance Failover Group. + +### [Remove-AzSqlDatabaseLongTermRetentionBackup](Remove-AzSqlDatabaseLongTermRetentionBackup.md) +Deletes a long term retention backup. + +### [Remove-AzSqlDatabaseRestorePoint](Remove-AzSqlDatabaseRestorePoint.md) +Removes given restore point from a SQL Database. + +### [Remove-AzSqlDatabaseSecondary](Remove-AzSqlDatabaseSecondary.md) +Terminates data replication between a SQL Database and the specified secondary database. + +### [Remove-AzSqlDatabaseSensitivityClassification](Remove-AzSqlDatabaseSensitivityClassification.md) +Removes the information types and sensitivity labels of columns in the database. + +### [Remove-AzSqlElasticJob](Remove-AzSqlElasticJob.md) +Removes a job + +### [Remove-AzSqlElasticJobAgent](Remove-AzSqlElasticJobAgent.md) +Removes the elastic job agent + +### [Remove-AzSqlElasticJobCredential](Remove-AzSqlElasticJobCredential.md) +Removes the elastic job credential + +### [Remove-AzSqlElasticJobStep](Remove-AzSqlElasticJobStep.md) +Removes the job step + +### [Remove-AzSqlElasticJobTarget](Remove-AzSqlElasticJobTarget.md) +Removes the target from the target group + +### [Remove-AzSqlElasticJobTargetGroup](Remove-AzSqlElasticJobTargetGroup.md) +Removes the target group + +### [Remove-AzSqlElasticPool](Remove-AzSqlElasticPool.md) +Deletes an elastic database pool. + +### [Remove-AzSqlInstance](Remove-AzSqlInstance.md) +Removes an Azure SQL Managed Database Instance. + +### [Remove-AzSqlInstanceActiveDirectoryAdministrator](Remove-AzSqlInstanceActiveDirectoryAdministrator.md) +Removes an Azure AD administrator for SQL Managed Instance. + +### [Remove-AzSqlInstanceDatabase](Remove-AzSqlInstanceDatabase.md) +Removes an Azure SQL Managed Instance database. + +### [Remove-AzSqlInstanceDatabaseLongTermRetentionBackup](Remove-AzSqlInstanceDatabaseLongTermRetentionBackup.md) +Deletes a long term retention backup. + +### [Remove-AzSqlInstanceDatabaseSensitivityClassification](Remove-AzSqlInstanceDatabaseSensitivityClassification.md) +Removes the information types and sensitivity labels of columns in the Azure SQL Managed Instance database. + +### [Remove-AzSqlInstanceKeyVaultKey](Remove-AzSqlInstanceKeyVaultKey.md) +Removes a Key Vault key from a SQL managed instance + +### [Remove-AzSqlInstanceLink](Remove-AzSqlInstanceLink.md) +Removes an instance link. + +### [Remove-AzSqlInstancePool](Remove-AzSqlInstancePool.md) +Removes an Azure SQL Instance pool. + +### [Remove-AzSqlInstanceServerTrustCertificate](Remove-AzSqlInstanceServerTrustCertificate.md) +Removes a server trust certificate. + +### [Remove-AzSqlServer](Remove-AzSqlServer.md) +Removes an Azure SQL Database server. + +### [Remove-AzSqlServerActiveDirectoryAdministrator](Remove-AzSqlServerActiveDirectoryAdministrator.md) +Removes an Azure AD administrator for SQL Server. + +### [Remove-AzSqlServerAudit](Remove-AzSqlServerAudit.md) +Removes the auditing settings of an Azure SQL server. + +### [Remove-AzSqlServerCommunicationLink](Remove-AzSqlServerCommunicationLink.md) +Deletes a communication link for elastic database transactions between two servers. + +### [Remove-AzSqlServerDisasterRecoveryConfiguration](Remove-AzSqlServerDisasterRecoveryConfiguration.md) +Removes a SQL database server system recovery configuration. + +### [Remove-AzSqlServerDnsAlias](Remove-AzSqlServerDnsAlias.md) +Removes Azure SQL Server DNS Alias. + +### [Remove-AzSqlServerFirewallRule](Remove-AzSqlServerFirewallRule.md) +Deletes a firewall rule from a SQL Database server. + +### [Remove-AzSqlServerIpv6FirewallRule](Remove-AzSqlServerIpv6FirewallRule.md) +Deletes an IPv6 firewall rule from a SQL Database server. + +### [Remove-AzSqlServerKeyVaultKey](Remove-AzSqlServerKeyVaultKey.md) +Removes a Key Vault key from a SQL server. + +### [Remove-AzSqlServerMSSupportAudit](Remove-AzSqlServerMSSupportAudit.md) +Removes the Microsoft support operations auditing settings of an Azure SQL server. + +### [Remove-AzSqlServerOutboundFirewallRule](Remove-AzSqlServerOutboundFirewallRule.md) +Deletes an allowed FQDN from the list of outbound firewall rules (Allowed FQDNs) from a SQL Database server. + +### [Remove-AzSqlServerTrustGroup](Remove-AzSqlServerTrustGroup.md) +Deletes a Server Trust Group. + +### [Remove-AzSqlServerVirtualNetworkRule](Remove-AzSqlServerVirtualNetworkRule.md) +Deletes an Azure SQL Server Virtual Network Rule. + +### [Remove-AzSqlSyncAgent](Remove-AzSqlSyncAgent.md) +Removes an Azure SQL Sync Agent. + +### [Remove-AzSqlSyncGroup](Remove-AzSqlSyncGroup.md) +Removes an Azure SQL Database Sync Group. + +### [Remove-AzSqlSyncMember](Remove-AzSqlSyncMember.md) +Removes an Azure SQL Database Sync Member. + +### [Remove-AzSqlVirtualCluster](Remove-AzSqlVirtualCluster.md) +Removes an Azure SQL Virtual Cluster. + +### [Restore-AzSqlDatabase](Restore-AzSqlDatabase.md) +Restores a SQL database. + +### [Restore-AzSqlInstanceDatabase](Restore-AzSqlInstanceDatabase.md) +Restores an Azure SQL Managed Instance database. + +### [Resume-AzSqlDatabase](Resume-AzSqlDatabase.md) +Resumes a SQL Data Warehouse database. + +### [Set-AzSqlDatabase](Set-AzSqlDatabase.md) +Sets properties for a database, or moves an existing database into an elastic pool. + +### [Set-AzSqlDatabaseAdvisorAutoExecuteStatus](Set-AzSqlDatabaseAdvisorAutoExecuteStatus.md) +Modifies auto execute status of an Azure SQL Database Advisor. + +### [Set-AzSqlDatabaseAudit](Set-AzSqlDatabaseAudit.md) +Changes the auditing settings for an Azure SQL Database. + +### [Set-AzSqlDatabaseBackupLongTermRetentionPolicy](Set-AzSqlDatabaseBackupLongTermRetentionPolicy.md) +Sets a server long term retention policy. + +### [Set-AzSqlDatabaseBackupShortTermRetentionPolicy](Set-AzSqlDatabaseBackupShortTermRetentionPolicy.md) +Sets a backup short term retention policy. + +### [Set-AzSqlDatabaseDataMaskingPolicy](Set-AzSqlDatabaseDataMaskingPolicy.md) +Sets data masking for a database. + +### [Set-AzSqlDatabaseDataMaskingRule](Set-AzSqlDatabaseDataMaskingRule.md) +Sets the properties of a data masking rule for a database. + +### [Set-AzSqlDatabaseFailoverGroup](Set-AzSqlDatabaseFailoverGroup.md) +Modifies the configuration of an Azure SQL Database Failover Group. + +### [Set-AzSqlDatabaseGeoBackupPolicy](Set-AzSqlDatabaseGeoBackupPolicy.md) +Sets a database geo backup policy. + +### [Set-AzSqlDatabaseInstanceFailoverGroup](Set-AzSqlDatabaseInstanceFailoverGroup.md) +Modifies the configuration of an Instance Failover Group. + +### [Set-AzSqlDatabaseRecommendedActionState](Set-AzSqlDatabaseRecommendedActionState.md) +Updates the state of an Azure SQL Database recommended action. + +### [Set-AzSqlDatabaseSecondary](Set-AzSqlDatabaseSecondary.md) +Switches a secondary database to be primary in order to initiate failover. + +### [Set-AzSqlDatabaseSensitivityClassification](Set-AzSqlDatabaseSensitivityClassification.md) +Sets the information types and sensitivity labels of columns in the database. + +### [Set-AzSqlDatabaseTransparentDataEncryption](Set-AzSqlDatabaseTransparentDataEncryption.md) +Modifies TDE property for a database. + +### [Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline](Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md) +Sets the vulnerability assessment rule baseline. + +### [Set-AzSqlElasticJob](Set-AzSqlElasticJob.md) +Updates a job + +### [Set-AzSqlElasticJobAgent](Set-AzSqlElasticJobAgent.md) +Updates an elastic job agent + +### [Set-AzSqlElasticJobCredential](Set-AzSqlElasticJobCredential.md) +Updates a job credential + +### [Set-AzSqlElasticJobStep](Set-AzSqlElasticJobStep.md) +Updates a job step + +### [Set-AzSqlElasticPool](Set-AzSqlElasticPool.md) +Modifies properties of an elastic database pool in Azure SQL Database. + +### [Set-AzSqlElasticPoolAdvisorAutoExecuteStatus](Set-AzSqlElasticPoolAdvisorAutoExecuteStatus.md) +Updates auto execute status of an Azure SQL Elastic Pool Advisor. + +### [Set-AzSqlElasticPoolRecommendedActionState](Set-AzSqlElasticPoolRecommendedActionState.md) +Updates the state of an Azure SQL Elastic Pool recommended action. + +### [Set-AzSqlInstance](Set-AzSqlInstance.md) +Sets properties for an Azure SQL Managed Instance. + +### [Set-AzSqlInstanceActiveDirectoryAdministrator](Set-AzSqlInstanceActiveDirectoryAdministrator.md) +Provisions an Azure AD administrator for SQL Managed Instance. + +### [Set-AzSqlInstanceDatabase](Set-AzSqlInstanceDatabase.md) +Updated an Azure SQL Managed Instance database. + +### [Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy](Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md) +The **Set-AzSqlInstanceDatabaseLongTermRetentionBackup** cmdlet sets a managed database's long term retention policy. + +### [Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy](Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy.md) +Sets a backup short term retention policy. + +### [Set-AzSqlInstanceDatabaseSensitivityClassification](Set-AzSqlInstanceDatabaseSensitivityClassification.md) +Sets the information types and sensitivity labels of columns in the Azure SQL Managed Instance database. + +### [Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline](Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md) +Sets the vulnerability assessment rule baseline. + +### [Set-AzSqlInstanceDtc](Set-AzSqlInstanceDtc.md) +Sets properties for an Azure SQL Managed Instance DTC + +### [Set-AzSqlInstancePool](Set-AzSqlInstancePool.md) +Sets properties for an Azure SQL Instance pool. + +### [Set-AzSqlInstanceTransparentDataEncryptionProtector](Set-AzSqlInstanceTransparentDataEncryptionProtector.md) +Sets the Transparent Data Encryption (TDE) protector for a SQL managed instance. + +### [Set-AzSqlServer](Set-AzSqlServer.md) +Modifies properties of a SQL Database server. + +### [Set-AzSqlServerActiveDirectoryAdministrator](Set-AzSqlServerActiveDirectoryAdministrator.md) +Provisions an Azure AD administrator for SQL Server. + +### [Set-AzSqlServerAdvisorAutoExecuteStatus](Set-AzSqlServerAdvisorAutoExecuteStatus.md) +Updates the auto execute status of an Azure SQL Server Advisor. + +### [Set-AzSqlServerAudit](Set-AzSqlServerAudit.md) +Changes the auditing settings of an Azure SQL server. + +### [Set-AzSqlServerConfigurationOption](Set-AzSqlServerConfigurationOption.md) +Sets the value of a server configuration option on Azure SQL Managed Instance. + +### [Set-AzSqlServerDisasterRecoveryConfiguration](Set-AzSqlServerDisasterRecoveryConfiguration.md) +Modifies a database server recovery configuration. + +### [Set-AzSqlServerDnsAlias](Set-AzSqlServerDnsAlias.md) +Modifies the server to which Azure SQL Server DNS Alias is pointing + +### [Set-AzSqlServerFirewallRule](Set-AzSqlServerFirewallRule.md) +Modifies a firewall rule in Azure SQL Database server. + +### [Set-AzSqlServerIpv6FirewallRule](Set-AzSqlServerIpv6FirewallRule.md) +Modifies an IPv6 firewall rule in Azure SQL Database server. + +### [Set-AzSqlServerMSSupportAudit](Set-AzSqlServerMSSupportAudit.md) +Changes the Microsoft support operations auditing settings of an Azure SQL server. + +### [Set-AzSqlServerRecommendedActionState](Set-AzSqlServerRecommendedActionState.md) +Updates the state of an Azure SQL Server recommended action. + +### [Set-AzSqlServerTransparentDataEncryptionProtector](Set-AzSqlServerTransparentDataEncryptionProtector.md) +Sets the Transparent Data Encryption (TDE) protector for a SQL server. + +### [Set-AzSqlServerVirtualNetworkRule](Set-AzSqlServerVirtualNetworkRule.md) +Modifies the configuration of an Azure SQL Server Virtual Network Rule. + +### [Start-AzSqlDatabaseExecuteIndexRecommendation](Start-AzSqlDatabaseExecuteIndexRecommendation.md) +Starts the workflow that runs a recommended index operation. + +### [Start-AzSqlDatabaseVulnerabilityAssessmentScan](Start-AzSqlDatabaseVulnerabilityAssessmentScan.md) +Starts a vulnerability assessment scan. + +### [Start-AzSqlElasticJob](Start-AzSqlElasticJob.md) +Starts a job, returning a job execution id that can be polled to view it's status + +### [Start-AzSqlInstanceDatabaseLogReplay](Start-AzSqlInstanceDatabaseLogReplay.md) +Starts a Log Replay service with the given parameters. + +### [Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan](Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan.md) +Starts a vulnerability assessment scan. + +### [Start-AzSqlSyncGroupSync](Start-AzSqlSyncGroupSync.md) +Starts a sync group synchronization. + +### [Stop-AzSqlDatabaseActivity](Stop-AzSqlDatabaseActivity.md) +Cancels the asynchronous updates operation on the database. + +### [Stop-AzSqlDatabaseExecuteIndexRecommendation](Stop-AzSqlDatabaseExecuteIndexRecommendation.md) +Stops the workflow that runs a recommended index operation. + +### [Stop-AzSqlElasticJob](Stop-AzSqlElasticJob.md) +Stops a job given it's job execution id + +### [Stop-AzSqlElasticPoolActivity](Stop-AzSqlElasticPoolActivity.md) +Cancels the asynchronous update operation on an elastic pool. + +### [Stop-AzSqlInstanceDatabaseLogReplay](Stop-AzSqlInstanceDatabaseLogReplay.md) +Cancels the Log Replay service by dropping the database. + +### [Stop-AzSqlInstanceOperation](Stop-AzSqlInstanceOperation.md) +Stops a SQL managed instance's operations. + +### [Stop-AzSqlSyncGroupSync](Stop-AzSqlSyncGroupSync.md) +Stops a sync group synchronization. + +### [Suspend-AzSqlDatabase](Suspend-AzSqlDatabase.md) +Suspends a SQL Data Warehouse database. + +### [Switch-AzSqlDatabaseFailoverGroup](Switch-AzSqlDatabaseFailoverGroup.md) +Executes a failover of an Azure SQL Database Failover Group. + +### [Switch-AzSqlDatabaseInstanceFailoverGroup](Switch-AzSqlDatabaseInstanceFailoverGroup.md) +Executes a failover of an Instance Failover Group. + +### [Update-AzSqlDatabaseAdvancedThreatProtectionSetting](Update-AzSqlDatabaseAdvancedThreatProtectionSetting.md) +Sets the Advanced Threat Protection settings on a database. + +### [Update-AzSqlDatabaseLongTermRetentionBackup](Update-AzSqlDatabaseLongTermRetentionBackup.md) +Updates a long term retention backup. + +### [Update-AzSqlDatabaseVulnerabilityAssessmentSetting](Update-AzSqlDatabaseVulnerabilityAssessmentSetting.md) +Updates the vulnerability assessment settings of a database. + +### [Update-AzSqlInstanceAdvancedThreatProtectionSetting](Update-AzSqlInstanceAdvancedThreatProtectionSetting.md) +Sets the Advanced Threat Protection settings on a managed instance. + +### [Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting](Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting.md) +Sets the Advanced Threat Protection settings on a managed database. + +### [Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting](Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md) +Updates the vulnerability assessment settings of a managed database. + +### [Update-AzSqlInstanceLink](Update-AzSqlInstanceLink.md) +Updates the properties of an instance link. + +### [Update-AzSqlInstanceVulnerabilityAssessmentSetting](Update-AzSqlInstanceVulnerabilityAssessmentSetting.md) +Updates the vulnerability assessment settings of a managed instance. + +### [Update-AzSqlServerAdvancedThreatProtectionSetting](Update-AzSqlServerAdvancedThreatProtectionSetting.md) +Sets the Advanced Threat Protection settings on a server. + +### [Update-AzSqlServerVulnerabilityAssessmentSetting](Update-AzSqlServerVulnerabilityAssessmentSetting.md) +Updates the vulnerability assessment settings of a server. + +### [Update-AzSqlSyncGroup](Update-AzSqlSyncGroup.md) +Updates an Azure SQL Database Sync Group. + +### [Update-AzSqlSyncMember](Update-AzSqlSyncMember.md) +Updates an Azure SQL Database Sync Member. + +### [Update-AzSqlSyncSchema](Update-AzSqlSyncSchema.md) +Update the sync schema for a sync member database or a sync hub database. +It will get the latest database schema from the real database and then use it refresh the schema cached by Sync metadata database. +If "SyncMemberName" is specified, it will refresh the member database schema; if not, it will refresh the hub database schema. + + + diff --git a/azps-10.1.0/Az.Sql/Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md b/azps-10.1.0/Az.Sql/Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md new file mode 100644 index 0000000000..b16db683c8 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/clear-azsqldatabasevulnerabilityassessmentrulebaseline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md +--- + +# Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline + +## SYNOPSIS +Clears the vulnerability assessment rule baseline. + +## SYNTAX + +``` +Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline [-ServerName] <String> [-DatabaseName] <String> + [-InputObject <AzureSqlDatabaseModel>] -RuleId <String> [-RuleAppliesToMaster] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline** cmdlet removes the vulnerability assessment rule baseline. +Note that you need to run *Enable-AzSqlServerAdvancedDataSecurity* and *Update-AzSqlServerVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1: Clears the vulnerability assessment rule baseline +```powershell +Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + -RuleId "VA2108" +``` + +### Example 2: Clears the vulnerability assessment rule baseline from a database object +```powershell +Get-AzSqlDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + | Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline ` + -RuleId "VA2108" ` + -RuleAppliesToMaster +``` + +## PARAMETERS + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to clear Vulnerability Assessment rule baseline for + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleAppliesToMaster +Specifies that the baseline should apply to the master database. +This is required only when database level settings specify a storage account that is different from the one specified in the server level settings. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleId +The rule ID which identifies the rule to set the baseline results to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentRuleBaselineModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Clear-AzSqlDatabaseVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Sql/Clear-AzSqlDatabaseVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..6d1ab44ff7 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Clear-AzSqlDatabaseVulnerabilityAssessmentSetting.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/clear-azsqldatabasevulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Clear-AzSqlDatabaseVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Clear-AzSqlDatabaseVulnerabilityAssessmentSetting.md +--- + +# Clear-AzSqlDatabaseVulnerabilityAssessmentSetting + +## SYNOPSIS +Clears the vulnerability assessment settings of a database. + +## SYNTAX + +``` +Clear-AzSqlDatabaseVulnerabilityAssessmentSetting [-ServerName] <String> [-DatabaseName] <String> + [-InputObject <AzureSqlDatabaseModel>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Clear-AzSqlDatabaseVulnerabilityAssessmentSetting** cmdlet removes the vulnerability assessment settings of an Azure SQL Database. +Note that you need to run *Enable-AzSqlServerAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1: Clear the vulnerability assessment settings of an Azure SQL database +```powershell +Clear-AzSqlDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +### Example 2: Clear the vulnerability assessment settings from a database object +```powershell +Get-AzSqlDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + | Clear-AzSqlDatabaseVulnerabilityAssessmentSetting +``` + +## PARAMETERS + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to clear Vulnerability Assessment settings for + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md b/azps-10.1.0/Az.Sql/Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md new file mode 100644 index 0000000000..5ba33fdb0f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/clear-azsqlinstancedatabasevulnerabilityassessmentrulebaseline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md +--- + +# Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline + +## SYNOPSIS +Clears the vulnerability assessment rule baseline. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline [-InstanceName] <String> + [-DatabaseName] <String> -RuleId <String> [-RuleAppliesToMaster] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClearByParentResourceParameterSet +``` +Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline -InputObject <AzureSqlManagedDatabaseModel> + -RuleId <String> [-RuleAppliesToMaster] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline** cmdlet removes the vulnerability assessment rule baseline. +Note that you need to run *Enable-AzSqlInstanceAdvancedDataSecurity* and *Update-AzSqlInstanceVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1 - Clears the vulnerability assessment rule baseline +```powershell +Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -RuleId "VA2108" +``` + +### Example 2 - Clears the vulnerability assessment rule baseline from a managed database object +```powershell +Get-AzSqlInstanceDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -Name "Database01" ` + | Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline ` + -RuleId "VA2108" ` + -RuleAppliesToMaster +``` + +## PARAMETERS + +### -DatabaseName +SQL Managed Database name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed database object to clear Vulnerability Assessment rule baseline for + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: ClearByParentResourceParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleAppliesToMaster +Specifies whether the baseline results should apply on a server level rule identified by the RuleId + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleId +The rule ID which identifies the rule to set the baseline results to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ManagedDatabaseVulnerabilityAssessmentRuleBaselineModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Sql/Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..fd30f5344b --- /dev/null +++ b/azps-10.1.0/Az.Sql/Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/clear-azsqlinstancedatabasevulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md +--- + +# Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting + +## SYNOPSIS +Clears the vulnerability assessment settings of a managed database. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting [-InstanceName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ClearByParentResourceParameterSet +``` +Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting -InputObject <AzureSqlManagedDatabaseModel> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting** cmdlet removes the vulnerability assessment settings of an Azure SQL Managed Database. +Note that you need to run *Enable-AzSqlInstanceAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1 - Clear the vulnerability assessment settings of an Azure SQL managed database +```powershell +Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` +``` + +### Example 2 - Clear the vulnerability assessment settings from a managed database object +```powershell +Get-AzSqlInstanceDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -Name "Database01" ` + | Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting +``` + +## PARAMETERS + +### -DatabaseName +SQL Managed Database name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed database object to clear Vulnerability Assessment settings for + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: ClearByParentResourceParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ManagedDatabaseVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Clear-AzSqlInstanceVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Sql/Clear-AzSqlInstanceVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..3efa3ed1b4 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Clear-AzSqlInstanceVulnerabilityAssessmentSetting.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/clear-azsqlinstancevulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Clear-AzSqlInstanceVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Clear-AzSqlInstanceVulnerabilityAssessmentSetting.md +--- + +# Clear-AzSqlInstanceVulnerabilityAssessmentSetting + +## SYNOPSIS +Clears the vulnerability assessment settings of a managed instance. + +## SYNTAX + +### ClearByNameParameterSet (Default) +``` +Clear-AzSqlInstanceVulnerabilityAssessmentSetting [-ResourceGroupName] <String> [-InstanceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClearByParentResourceParameterSet +``` +Clear-AzSqlInstanceVulnerabilityAssessmentSetting [-InputObject] <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Clear-AzSqlInstanceVulnerabilityAssessmentSetting** cmdlet removes the vulnerability assessment settings of an Azure SQL Managed Instance. +Note that you need to run *Enable-AzSqlInstanceAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1 - Clear the vulnerability assessment settings of an Azure SQL managed instance +```powershell +Clear-AzSqlInstanceVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` +``` + +### Example 2 - Clear the vulnerability assessment settings from a managed instance object +```powershell +Get-AzSqlInstance ` + -ResourceGroupName "ResourceGroup01" ` + -Name "ManagedInstance01" ` + | Clear-AzSqlInstanceVulnerabilityAssessmentSetting +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed instance object to clear Vulnerability Assessment settings for + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: ClearByParentResourceParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ManagedInstanceVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Clear-AzSqlServerVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Sql/Clear-AzSqlServerVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..c88d613d25 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Clear-AzSqlServerVulnerabilityAssessmentSetting.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/clear-azsqlservervulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Clear-AzSqlServerVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Clear-AzSqlServerVulnerabilityAssessmentSetting.md +--- + +# Clear-AzSqlServerVulnerabilityAssessmentSetting + +## SYNOPSIS +Clears the vulnerability assessment settings of a server. + +## SYNTAX + +### ClearByNameParameterSet (Default) +``` +Clear-AzSqlServerVulnerabilityAssessmentSetting [-ResourceGroupName] <String> [-ServerName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClearByParentResourceParameterSet +``` +Clear-AzSqlServerVulnerabilityAssessmentSetting [-InputObject] <AzureSqlServerModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Clear-AzSqlServerVulnerabilityAssessmentSetting** cmdlet removes the vulnerability assessment settings of an Azure SQL Server. +Note that you need to run *Enable-AzSqlServerAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1: Clear the vulnerability assessment settings of an Azure SQL server +```powershell +Clear-AzSqlServerVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" +``` + +### Example 2: Clear the vulnerability assessment settings from a server object +```powershell +Get-AzSqlServer ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + | Clear-AzSqlServerVulnerabilityAssessmentSetting +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The server object to clear Vulnerability Assessment settings for + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: ClearByParentResourceParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ServerVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Complete-AzSqlInstanceDatabaseCopy.md b/azps-10.1.0/Az.Sql/Complete-AzSqlInstanceDatabaseCopy.md new file mode 100644 index 0000000000..4b8167bb10 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Complete-AzSqlInstanceDatabaseCopy.md @@ -0,0 +1,368 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/complete-azsqlinstancedatabasecopy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Complete-AzSqlInstanceDatabaseCopy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Complete-AzSqlInstanceDatabaseCopy.md +--- + +# Complete-AzSqlInstanceDatabaseCopy + +## SYNOPSIS +Complete online copy operation of a managed database. + +## SYNTAX + +### MoveCopyManagedDatabaseByNameParameterSet (Default) +``` +Complete-AzSqlInstanceDatabaseCopy -DatabaseName <String> -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CompleteManagedDatabaseCopyByCopyModelObject +``` +Complete-AzSqlInstanceDatabaseCopy -CopyModelObject <MoveCopyManagedDatabaseModel> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByOperationObjectParameterSet +``` +Complete-AzSqlInstanceDatabaseCopy [-DatabaseName <String>] [-InstanceName <String>] + [-ResourceGroupName <String>] -MoveCopyOperationObject <ManagedDatabaseMoveCopyOperation> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByInputObjectParameterSet +``` +Complete-AzSqlInstanceDatabaseCopy -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> + -DatabaseObject <AzureSqlManagedDatabaseModel> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByResourceIdParameterSet +``` +Complete-AzSqlInstanceDatabaseCopy -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> -ResourceId <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Complete-AzSqlInstanceDatabaseCopy** cmdlet complete copy operation of a database between two Azure SQL Managed Instances. Destination database will become online and ready for read/write workloads. + +## EXAMPLES + +### Example 1: Complete copy database to another Managed Instance in the same resource group +```powershell +Complete-AzSqlInstanceDatabaseCopy -ResourceGroupName RG1 -InstanceName MI1 -Name database1 -TargetInstanceName MI2 +``` + +This command completes copy operation of database1 on instance MI1 to instance MI2 + +### Example 2: Complete copy database to another Managed Instance in the different resource group +```powershell +Complete-AzSqlInstanceDatabaseCopy -ResourceGroupName RG1 -InstanceName MI1 -Name database1 -TargetResourceGroupName RG2 -TargetInstanceName MI2 +``` + +This command completes copy operation of database1 on instance MI1 in resource group RG1 to instance MI2 in resource group RG2 + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyModelObject +Object that is returned from start copy operation. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel +Parameter Sets: CompleteManagedDatabaseCopyByCopyModelObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DatabaseName +Name of the instance database. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +Managed database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of the source instance. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCopyOperationObject +Managed database move or copy operation object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: Operation + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Signal to receive output from a cmdlet which does not return anything + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the source resource group. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource id of managed database. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetInstanceName +Name of the target Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByInputObjectParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +Name of the target resource group. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByInputObjectParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Stop-AzSqlInstanceDatabaseCopy](./Stop-AzSqlInstanceDatabaseCopy.md) + +[Get-AzSqlInstanceDatabaseCopyOperation](./Get-AzSqlInstanceDatabaseCopyOperation.md) + +[Copy-AzSqlInstanceDatabase](./Copy-AzSqlInstanceDatabase.md) diff --git a/azps-10.1.0/Az.Sql/Complete-AzSqlInstanceDatabaseLogReplay.md b/azps-10.1.0/Az.Sql/Complete-AzSqlInstanceDatabaseLogReplay.md new file mode 100644 index 0000000000..955116cf7a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Complete-AzSqlInstanceDatabaseLogReplay.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/Complete-AzSqlInstanceDatabaseLogReplay +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Complete-AzSqlInstanceDatabaseLogReplay.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Complete-AzSqlInstanceDatabaseLogReplay.md +--- + +# Complete-AzSqlInstanceDatabaseLogReplay + +## SYNOPSIS +Completes Log Replay service for the given database. + +## SYNTAX + +### LogReplayInstanceDatabaseFromInputParameters (Default) +``` +Complete-AzSqlInstanceDatabaseLogReplay -LastBackupName <String> [-Name] <String> [-InstanceName] <String> + [-ResourceGroupName] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### LogReplayInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition +``` +Complete-AzSqlInstanceDatabaseLogReplay -LastBackupName <String> [-PassThru] + [-InputObject] <AzureSqlManagedDatabaseModel> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Complete-AzSqlInstanceDatabaseLogReplay** cmdlet completes the Log Replay service on the given database. + +## EXAMPLES + +### Example 1 +```powershell +Complete-AzSqlInstanceDatabaseLogReplay -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "ManagedDatabaseName" -LastBackupName "last_backup.bak" +``` + +This command will complete Log Replay service for the given database after last backup gets restored. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The instance database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: LogReplayInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition +Aliases: InstanceDatabase + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The name of the instance. + +```yaml +Type: System.String +Parameter Sets: LogReplayInstanceDatabaseFromInputParameters +Aliases: ManagedInstanceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LastBackupName +The name of the last backup file to restore. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the instance database. + +```yaml +Type: System.String +Parameter Sets: LogReplayInstanceDatabaseFromInputParameters +Aliases: InstanceDatabaseName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Defines Whether return the sync group. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: LogReplayInstanceDatabaseFromInputParameters +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Complete-AzSqlInstanceDatabaseMove.md b/azps-10.1.0/Az.Sql/Complete-AzSqlInstanceDatabaseMove.md new file mode 100644 index 0000000000..d65ac37729 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Complete-AzSqlInstanceDatabaseMove.md @@ -0,0 +1,383 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/complete-azsqlinstancedatabasemove +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Complete-AzSqlInstanceDatabaseMove.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Complete-AzSqlInstanceDatabaseMove.md +--- + +# Complete-AzSqlInstanceDatabaseMove + +## SYNOPSIS +Complete online move operation of a managed database. + +## SYNTAX + +### MoveCopyManagedDatabaseByNameParameterSet (Default) +``` +Complete-AzSqlInstanceDatabaseMove [-Force] -DatabaseName <String> -InstanceName <String> + -ResourceGroupName <String> [-TargetResourceGroupName <String>] -TargetInstanceName <String> [-AsJob] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CompleteManagedDatabaseMoveByMoveModelObject +``` +Complete-AzSqlInstanceDatabaseMove [-Force] -MoveModelObject <MoveCopyManagedDatabaseModel> [-AsJob] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByOperationObjectParameterSet +``` +Complete-AzSqlInstanceDatabaseMove [-Force] [-DatabaseName <String>] [-InstanceName <String>] + [-ResourceGroupName <String>] -MoveCopyOperationObject <ManagedDatabaseMoveCopyOperation> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByInputObjectParameterSet +``` +Complete-AzSqlInstanceDatabaseMove [-Force] -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> + -DatabaseObject <AzureSqlManagedDatabaseModel> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByResourceIdParameterSet +``` +Complete-AzSqlInstanceDatabaseMove [-Force] -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> -ResourceId <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Complete-AzSqlInstanceDatabaseMove** cmdlet complete move operation of a database between two Azure SQL Managed Instances. Destination database will become online and ready for read/write workloads and source database will be dropped. + +## EXAMPLES + +### Example 1: Complete move database to another Managed Instance in the same resource group +```powershell +Complete-AzSqlInstanceDatabaseMove -ResourceGroupName RG1 -InstanceName MI1 -Name database1 -TargetInstanceName MI2 +``` + +This command completes move operation of database1 on instance MI1 to instance MI2 + +### Example 2: Complete move database to another Managed Instance in the different resource group +```powershell +Complete-AzSqlInstanceDatabaseMove -ResourceGroupName RG1 -InstanceName MI1 -Name database1 -TargetResourceGroupName RG2 -TargetInstanceName MI2 +``` + +This command completes move operation of database1 on instance MI1 in resource group RG1 to instance MI2 in resource group RG2 + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Name of the instance database. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +Managed database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of the source instance. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCopyOperationObject +Managed database move or copy operation object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: Operation + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MoveModelObject +Object that is returned from start move operation. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel +Parameter Sets: CompleteManagedDatabaseMoveByMoveModelObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Signal to receive output from a cmdlet which does not return anything + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the source resource group. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource id of managed database. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetInstanceName +Name of the target Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByInputObjectParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +Name of the target resource group. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByInputObjectParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Stop-AzSqlInstanceDatabaseMove](./Stop-AzSqlInstanceDatabaseMove.md) + +[Get-AzSqlInstanceDatabaseMoveOperation](./Get-AzSqlInstanceDatabaseMoveOperation.md) + +[Move-AzSqlInstanceDatabase](./Move-AzSqlInstanceDatabase.md) diff --git a/azps-10.1.0/Az.Sql/Convert-AzSqlDatabaseVulnerabilityAssessmentScan.md b/azps-10.1.0/Az.Sql/Convert-AzSqlDatabaseVulnerabilityAssessmentScan.md new file mode 100644 index 0000000000..442b9b2c35 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Convert-AzSqlDatabaseVulnerabilityAssessmentScan.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/convert-azsqldatabasevulnerabilityassessmentscan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Convert-AzSqlDatabaseVulnerabilityAssessmentScan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Convert-AzSqlDatabaseVulnerabilityAssessmentScan.md +--- + +# Convert-AzSqlDatabaseVulnerabilityAssessmentScan + +## SYNOPSIS +Converts a vulnerability assessment scan results to Excel format. + +## SYNTAX + +``` +Convert-AzSqlDatabaseVulnerabilityAssessmentScan [-ServerName] <String> [-DatabaseName] <String> + [-InputObject <VulnerabilityAssessmentScanRecordModel>] [-ScanId <String>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Convert-AzSqlDatabaseVulnerabilityAssessmentScan** cmdlet converts a scan results, that resides in the customer storage, identified by the ScanId parameter to an Excel format placed in the storage defined by the Set-AzSqlServerVulnerabilityAssessmentSettings cmdlet. +Note that you need to run *Enable-AzSqlServerAdvancedDataSecurity* and *Update-AzSqlServerVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1: Converts vulnerability assessment scan results and saves them to local disk +<!-- Skip: Output cannot be splitted from code --> +```powershell +Update-AzSqlServerVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -StorageAccountName "mystorage" + +Start-AzSqlDatabaseVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + -ScanId "myScan" + +$convert_scan_results = Convert-AzSqlDatabaseVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + -ScanId "myScan" +ResourceGroupName : "ResourceGroup01" +ServerName : "Server01" +DatabaseName : "Database01" +ScanId : "myScan" +ExportedReportLocation : "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/Server01/Database01/scan_myScan.xlsx" + +$connection_string_to_storage_account = "DefaultEndpointsProtocol=https;AccountName=myaccount...." +$converted_scan_results_download_local_folder = "C:\Downloads\" +$storage_account_context = New-AzStorageContext -ConnectionString $connection_string_to_storage_account +$convert_scan_result_splitted = $convert_scan_results.ExportedReportLocation -split "/" +$container_name = $convert_scan_result_splitted[3] +Get-AzStorageBlobContent -Blob ($a -split $container_name + '/')[1] ` + -Container $container_name ` + -Destination $converted_scan_results_download_local_folder ` + -Context $storage_account_context +``` + +### Example 2: Converts a vulnerability assessment scan results from a scan record +```powershell +Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + -ScanId "myScan" ` + | Convert-AzSqlDatabaseVulnerabilityAssessmentScan +``` + +```output +ResourceGroupName : "ResourceGroup01" +ServerName : "Server01" +DatabaseName : "Database01" +ScanId : "myScan" +ExportedReportLocation : "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/Server01/Database01 + /scan_myScan.xlsx" +``` + +## PARAMETERS + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The scan record object to use in order to convert a Vulnerability Assessment scan + +```yaml +Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentScanRecordModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScanId +Specifies the scan ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentScanRecordModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentScanExportModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan.md b/azps-10.1.0/Az.Sql/Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan.md new file mode 100644 index 0000000000..4a91dd344b --- /dev/null +++ b/azps-10.1.0/Az.Sql/Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/convert-azsqlinstancedatabasevulnerabilityassessmentscan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan.md +--- + +# Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan + +## SYNOPSIS +Converts a vulnerability assessment scan results to Excel format. + +## SYNTAX + +### ConvertByNameParameterSet (Default) +``` +Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan [-InstanceName] <String> [-DatabaseName] <String> + [-ScanId <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ConvertByVulnerabilityAssessmentScanRecordModelParameterSet +``` +Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan + [-InputObject <VulnerabilityAssessmentScanRecordModel>] [-ScanId <String>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan** cmdlet converts a scan results, that resides in the customer storage, identified by the ScanId parameter to an Excel format placed in the storage defined by the Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings cmdlet. +Note that you need to run *Enable-AzSqlInstanceAdvancedDataSecurity* and *Update-AzSqlInstanceVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1 - Converts vulnerability assessment scan results and saves them to local disk +<!-- Skip: Output cannot be splitted from code --> +```powershell +Update-AzSqlInstanceVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -StorageAccountName "mystorage" + +Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -ScanId "myScan" + +$convert_scan_results = Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -ScanId "myScan" +ResourceGroupName : "ResourceGroup01" +InstanceName : "ManagedInstance01" +DatabaseName : "Database01" +ScanId : "myScan" +ExportedReportLocation : "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/ManagedInstance01/Database01/scan_myScan.xlsx" + +$connection_string_to_storage_account = "DefaultEndpointsProtocol=https;AccountName=myaccount...." +$converted_scan_results_download_local_folder = "C:\Downloads\" +$storage_account_context = New-AzStorageContext -ConnectionString $connection_string_to_storage_account +$convert_scan_result_splitted = $convert_scan_results.ExportedReportLocation -split "/" +$container_name = $convert_scan_result_splitted[3] +Get-AzStorageBlobContent -Blob ($a -split $container_name + '/')[1] ` + -Container $container_name ` + -Destination $converted_scan_results_download_local_folder ` + -Context $storage_account_context +``` + +### Example 2 - Converts a vulnerability assessment scan results from a scan record +```powershell +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -ScanId "myScan" ` + | Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan +``` + +```output +ResourceGroupName : "ResourceGroup01" +InstanceName : "ManagedInstance01" +DatabaseName : "Database01" +ScanId : "myScan" +ExportedReportLocation : "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/ManagedInstance01/Database01/scan_myScan.xlsx" +``` + +## PARAMETERS + +### -DatabaseName +SQL Managed Database name. + +```yaml +Type: System.String +Parameter Sets: ConvertByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The scan record object to use in order to convert a Vulnerability Assessment scan + +```yaml +Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentScanRecordModel +Parameter Sets: ConvertByVulnerabilityAssessmentScanRecordModelParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: ConvertByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScanId +Specifies the scan ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentScanRecordModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ManagedDatabaseVulnerabilityAssessmentScanExportModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Copy-AzSqlDatabaseLongTermRetentionBackup.md b/azps-10.1.0/Az.Sql/Copy-AzSqlDatabaseLongTermRetentionBackup.md new file mode 100644 index 0000000000..f2a76a632f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Copy-AzSqlDatabaseLongTermRetentionBackup.md @@ -0,0 +1,343 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/copy-azsqldatabaselongtermretentionbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Copy-AzSqlDatabaseLongTermRetentionBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Copy-AzSqlDatabaseLongTermRetentionBackup.md +--- + +# Copy-AzSqlDatabaseLongTermRetentionBackup + +## SYNOPSIS +Copies a long term retention backup to a target database. + +## SYNTAX + +### CopyBackupDefault (Default) +``` +Copy-AzSqlDatabaseLongTermRetentionBackup [-Location] <String> [-ServerName] <String> [-DatabaseName] <String> + [-BackupName] <String> [-ResourceGroupName <String>] -TargetDatabaseName <String> + [-TargetServerFullyQualifiedDomainName <String>] [-TargetServerName <String>] -TargetSubscriptionId <String> + -TargetResourceGroupName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CopyBackupByResourceId +``` +Copy-AzSqlDatabaseLongTermRetentionBackup [-ResourceId] <String> -TargetDatabaseName <String> + [-TargetServerFullyQualifiedDomainName <String>] [-TargetServerName <String>] -TargetSubscriptionId <String> + -TargetResourceGroupName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CopyBackupByInputObject +``` +Copy-AzSqlDatabaseLongTermRetentionBackup [-InputObject] <AzureSqlDatabaseLongTermRetentionBackupModel> + -TargetDatabaseName <String> [-TargetServerFullyQualifiedDomainName <String>] [-TargetServerName <String>] + -TargetSubscriptionId <String> -TargetResourceGroupName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Copies a long term retention backup to a target database. Target database may be in different cluster than backup source. + +## EXAMPLES + +### Example 1: Copy a long term retention backup to another server within the same environment. +```powershell +Copy-AzSqlDatabaseLongTermRetentionBackup -Location southeastasia -ServerName test-server -DatabaseName test-database -BackupName 'e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000' -ResourceGroupName testrg -TargetDatabaseName ltr1 -TargetServerName ayang-eas -TargetSubscriptionId '01c4ec88-e179-44f7-9eb0-e9719a5087ab' -TargetResourceGroupName testrg +``` + +```output +SourceResourceGroupName : test-rg +SourceLocation : southeastasia +SourceServerName : test-server +SourceDatabaseName : test-database +SourceBackupName : e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000 +SourceBackupResourceId : /subscriptions/01c4ec88-e179-44f7-9eb0-e9719a5087ab/resourceGroups/test-rg/providers/Microsoft.Sql/locations/SoutheastAsia/longTermRetentionServers/test-server/longTermRetentionDatabases/test-database/longTermRetentionBackups/e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000 +SourceBackupStorageRedundancy : Geo +TargetSubscriptionId : 01c4ec88-e179-44f7-9eb0-e9719a5087ab +TargetResourceGroupName : test-rg +TargetLocation : East Asia +TargetServerName : ayang-eas +TargetServerFullyQualifiedDomainName : +TargetServerResourceId : /subscriptions/01c4ec88-e179-44f7-9eb0-e9719a5087ab/resourceGroups/test-rg/providers/Microsoft.Sql/servers/ayang-eas +TargetDatabaseName : ltr1 +TargetBackupName : 70554a1f-ae6e-479e-99b1-50ea320654eb;132579992320000000 +TargetBackupResourceId : /subscriptions/01c4ec88-e179-44f7-9eb0-e9719a5087ab/resourceGroups/test-rg/providers/Microsoft.Sql/locations/East Asia/longTermRetentionServers/ayang-eas/longTermRetentionDatabases/ltr1/longTermRetentionBackups/70554a1f-ae6e-479e-99b1-50ea320654eb;132579992320000000 +``` + +This copies a long term retention backup from a source database in Southeast Asia to a target database in East Asia. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupName +The name of the backup. + +```yaml +Type: System.String +Parameter Sets: CopyBackupDefault +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Database the backup is from. + +```yaml +Type: System.String +Parameter Sets: CopyBackupDefault +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Database Long Term Retention Backup object to remove. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseLongTermRetentionBackupModel +Parameter Sets: CopyBackupByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the backups' source server. + +```yaml +Type: System.String +Parameter Sets: CopyBackupDefault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: CopyBackupDefault +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Resource ID of the Database Long Term Retention Backup to remove. + +```yaml +Type: System.String +Parameter Sets: CopyBackupByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the backup is under. + +```yaml +Type: System.String +Parameter Sets: CopyBackupDefault +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDatabaseName +The name of the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +The resource ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetServerFullyQualifiedDomainName +The fully qualified domain name of the target server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetServerName +The name of the target server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSubscriptionId +The resource ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseLongTermRetentionBackupModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseLongTermRetentionBackupModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseLongTermRetentionBackup](./Get-AzSqlDatabaseLongTermRetentionBackup.md) + +[Update-AzSqlDatabaseLongTermRetentionBackup](./Update-AzSqlDatabaseLongTermRetentionBackup.md) + +[Remove-AzSqlDatabaseLongTermRetentionBackup](./Remove-AzSqlDatabaseLongTermRetentionBackup.md) + +[Get-AzSqlDatabaseBackupLongTermRetentionPolicy](./Get-AzSqlDatabaseBackupLongTermRetentionPolicy.md) + +[Set-AzSqlDatabaseBackupLongTermRetentionPolicy](./Set-AzSqlDatabaseBackupLongTermRetentionPolicy.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Copy-AzSqlInstanceDatabase.md b/azps-10.1.0/Az.Sql/Copy-AzSqlInstanceDatabase.md new file mode 100644 index 0000000000..3548cca830 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Copy-AzSqlInstanceDatabase.md @@ -0,0 +1,347 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/copy-azsqlinstancedatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Copy-AzSqlInstanceDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Copy-AzSqlInstanceDatabase.md +--- + +# Copy-AzSqlInstanceDatabase + +## SYNOPSIS +Copy managed database to another managed instance. + +## SYNTAX + +### MoveCopyManagedDatabaseByNameParameterSet (Default) +``` +Copy-AzSqlInstanceDatabase -DatabaseName <String> -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByOperationObjectParameterSet +``` +Copy-AzSqlInstanceDatabase [-DatabaseName <String>] [-InstanceName <String>] [-ResourceGroupName <String>] + -MoveCopyOperationObject <ManagedDatabaseMoveCopyOperation> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByInputObjectParameterSet +``` +Copy-AzSqlInstanceDatabase -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> + -DatabaseObject <AzureSqlManagedDatabaseModel> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByResourceIdParameterSet +``` +Copy-AzSqlInstanceDatabase -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> -ResourceId <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Copy-AzSqlInstanceDatabase** cmdlet start online copy operation of a database across managed instances by using Always On availability group technology. [Learn more](https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/database-copy-move-how-to?view=azuresql) + +## EXAMPLES + +### Example 1: Copy database to another Managed Instance in the same resource group +```powershell +Copy-AzSqlInstanceDatabase -ResourceGroupName RG1 -InstanceName MI1 -Name database1 -TargetInstanceName MI2 +``` + +This command copies database1 from instance MI1 to MI2 + +### Example 2: Copy database to another Managed Instance in the different resource group +```powershell +Copy-AzSqlInstanceDatabase -ResourceGroupName RG1 -InstanceName MI1 -Name database1 -TargetResourceGroupName RG2 -TargetInstanceName MI2 +``` + +This command copies database1 from instance MI1 in resource group RG1 to MI2 in resource group RG2 + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Name of the instance database. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +Managed database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of the source instance. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCopyOperationObject +Managed database move or copy operation object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: Operation + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Signal to receive output from a cmdlet which does not return anything + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the source resource group. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource id of managed database. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetInstanceName +Name of the target Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByInputObjectParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +Name of the target resource group. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByInputObjectParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel + +## NOTES + +## RELATED LINKS + +[Complete-AzSqlInstanceDatabaseCopy](./Complete-AzSqlInstanceDatabaseCopy.md) + +[Stop-AzSqlInstanceDatabaseCopy](./Stop-AzSqlInstanceDatabaseCopy.md) + +[Get-AzSqlInstanceDatabaseCopyOperation](./Get-AzSqlInstanceDatabaseCopyOperation.md) + +[Move-AzSqlInstanceDatabase](./Move-AzSqlInstanceDatabase.md) diff --git a/azps-10.1.0/Az.Sql/Disable-AzSqlDatabaseLedgerDigestUpload.md b/azps-10.1.0/Az.Sql/Disable-AzSqlDatabaseLedgerDigestUpload.md new file mode 100644 index 0000000000..f9490dedf6 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Disable-AzSqlDatabaseLedgerDigestUpload.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/disable-azsqldatabaseledgerdigestupload +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlDatabaseLedgerDigestUpload.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlDatabaseLedgerDigestUpload.md +--- + +# Disable-AzSqlDatabaseLedgerDigestUpload + +## SYNOPSIS +Disables uploading ledger digests to Azure Blob storage or to Azure Confidential Ledger. + +## SYNTAX + +### DatabaseParameterSet (Default) +``` +Disable-AzSqlDatabaseLedgerDigestUpload [-ResourceGroupName] <String> [-ServerName] <String> + [-DatabaseName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Disable-AzSqlDatabaseLedgerDigestUpload -InputObject <AzureSqlDatabaseModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Disable-AzSqlDatabaseLedgerDigestUpload [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Disable-AzSqlDatabaseLedgerDigestUpload cmdlet disables uploading ledger digests to Azure Blob storage or Azure Confidental Ledger. To use the cmdlet, identify the database. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzSqlDatabaseLedgerDigestUpload -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +```output +ResourceGroupName ServerName DatabaseName State Endpoint +----------------- ---------- ------------ ----- -------- +ResourceGroup01 Server01 Database01 Disabled +``` + +## PARAMETERS + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to disable digest uploads for. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the database to disable digest uploads for. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.LedgerDigestUploads.Model.AzureSqlDatabaseLedgerDigestLocationModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Disable-AzSqlDatabaseSensitivityRecommendation.md b/azps-10.1.0/Az.Sql/Disable-AzSqlDatabaseSensitivityRecommendation.md new file mode 100644 index 0000000000..1423347cb0 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Disable-AzSqlDatabaseSensitivityRecommendation.md @@ -0,0 +1,270 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/disable-azsqldatabasesensitivityrecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlDatabaseSensitivityRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlDatabaseSensitivityRecommendation.md +--- + +# Disable-AzSqlDatabaseSensitivityRecommendation + +## SYNOPSIS +Disables (dismisses) sensitivity recommendations on columns in the database. + +## SYNTAX + +### InputObjectParameterSet (Default) +``` +Disable-AzSqlDatabaseSensitivityRecommendation -InputObject <SqlDatabaseSensitivityClassificationModel> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Disable-AzSqlDatabaseSensitivityRecommendation [-ResourceGroupName] <String> [-ServerName] <String> + [-DatabaseName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DatabaseObjectColumnParameterSet +``` +Disable-AzSqlDatabaseSensitivityRecommendation -DatabaseObject <AzureSqlDatabaseModel> -SchemaName <String> + -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Disable-AzSqlDatabaseSensitivityRecommendation cmdlet disables (dismisses) sensitivity recommendations on columns in the database. + +## EXAMPLES + +### Example 1: Disable sensitivity recommendations on a given column in an Azure SQL Database. +```powershell +Disable-AzSqlDatabaseSensitivityRecommendation -ResourceGroupName resourceGroup -ServerName server -DatabaseName database -SchemaName schema -TableName table -ColumnName column +``` + +### Example 2: Disable sensitivity recommendations on columns which have sensitivity recommendations in an Azure SQL database using Piping. +```powershell +Get-AzSqlDatabaseSensitivityRecommendation -ResourceGroupName resourceGroup -ServerName server -DatabaseName database | Disable-AzSqlDatabaseSensitivityRecommendation +``` + +### Example 3: Disable sensitivity recommendations on a given column in an Azure SQL database using Piping. +```powershell +Get-AzSqlDatabase -ResourceGroupName resourceGroup -ServerName server -DatabaseName database | Disable-AzSqlDatabaseSensitivityRecommendation -SchemaName schema -TableName table -ColumnName column +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL database. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +The SQL database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +An object representing a SQL Database Sensitivity Classification. + +```yaml +Type: Microsoft.Azure.Commands.Sql.DataClassification.Model.SqlDatabaseSensitivityClassificationModel +Parameter Sets: InputObjectParameterSet +Aliases: ClassificationObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Specifies whether to output the sensitivity classification model at end of cmdlet execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.DataClassification.Model.SqlDatabaseSensitivityClassificationModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Learn more about Azure SQL Database data discovery and classification](https://learn.microsoft.com/azure/sql-database/sql-database-data-discovery-and-classification) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md b/azps-10.1.0/Az.Sql/Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md new file mode 100644 index 0000000000..7dcb8ac9ec --- /dev/null +++ b/azps-10.1.0/Az.Sql/Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/disable-azsqlinstanceactivedirectoryonlyauthentication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md +--- + +# Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication + +## SYNOPSIS +Disables Azure AD only authentication for a specific SQL Managed Instance. + +## SYNTAX + +### UseResourceGroupAndInstanceNameParameterSet (Default) +``` +Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication [-ResourceGroupName] <String> [-InstanceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UseInputObjectParameterSet +``` +Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication -InputObject <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UserResourceIdParameterSet +``` +Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication** cmdlet disables Azure Active Directory (Azure AD) only authentication requirement for an AzureSQL Managed Instance in the current subscription. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" +``` + +```output +ResourceGroupName InstanceName AzureADOnlyAuthentication +----------------- ---------- ----------- -------- ----------- +ResourceGroup01 ManagedInstance01 True +``` + +This command disables Azure Active Directory (Azure AD) only authentication requirement for an AzureSQL Managed Instance named ManagedInstance01 that is associated with a resource group named ResourceGroup01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed instance object to use. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: UseInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The name of the Azure SQL Managed Instance the Azure Active Directory only authentication is in. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndInstanceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndInstanceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance to use + +```yaml +Type: System.String +Parameter Sets: UserResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.InstanceActiveDirectoryOnlyAuthentication.Model.AzureSqlInstanceActiveDirectoryOnlyAuthenticationModel + +## NOTES + +## RELATED LINKS + +[Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication](./Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md) + +[Get-AzSqlInstanceActiveDirectoryOnlyAuthentication](./Get-AzSqlInstanceActiveDirectoryOnlyAuthentication.md) + +[Set-AzSqlInstanceActiveDirectoryAdministrator](./Set-AzSqlInstanceActiveDirectoryAdministrator.md) + +[Get-AzSqlInstanceActiveDirectoryAdministrator](./Get-AzSqlInstanceActiveDirectoryAdministrator.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Disable-AzSqlInstanceAdvancedDataSecurity.md b/azps-10.1.0/Az.Sql/Disable-AzSqlInstanceAdvancedDataSecurity.md new file mode 100644 index 0000000000..e7ce62aa0d --- /dev/null +++ b/azps-10.1.0/Az.Sql/Disable-AzSqlInstanceAdvancedDataSecurity.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/disable-azsqlinstanceadvanceddatasecurity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlInstanceAdvancedDataSecurity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlInstanceAdvancedDataSecurity.md +--- + +# Disable-AzSqlInstanceAdvancedDataSecurity + +## SYNOPSIS +Disables Advanced Data Security on a managed instance. + +## SYNTAX + +``` +Disable-AzSqlInstanceAdvancedDataSecurity [-InputObject <AzureSqlManagedInstanceModel>] -InstanceName <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzSqlInstanceAdvancedDataSecurity** cmdlet disables Advanced Data Security on a managed instance. + +## EXAMPLES + +### Example 1 - Disable managed instance Advanced Data Security +```powershell +Disable-AzSqlInstanceAdvancedDataSecurity ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ManagedInstanceName : ManagedInstance01 +IsEnabled : False +``` + +### Example 2 - Disable server Advanced Data Security from managed instance resource +```powershell +Get-AzSqlInstance ` + -ResourceGroupName "ResourceGroup01" ` + -Name "ManagedInstance01" ` + | Disable-AzSqlInstanceAdvancedDataSecurity +``` + +```output +ResourceGroupName : ResourceGroup01 +ManagedInstanceName : ManagedInstance01 +IsEnabled : False +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed instance object to use with Advanced Data Security policy operation + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Database managed instance name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.AdvancedThreatProtection.Model.ManagedInstanceAdvancedDataSecurityPolicyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Disable-AzSqlInstanceDatabaseLedgerDigestUpload.md b/azps-10.1.0/Az.Sql/Disable-AzSqlInstanceDatabaseLedgerDigestUpload.md new file mode 100644 index 0000000000..e1e7942239 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Disable-AzSqlInstanceDatabaseLedgerDigestUpload.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/disable-azsqlinstancedatabaseledgerdigestupload +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlInstanceDatabaseLedgerDigestUpload.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlInstanceDatabaseLedgerDigestUpload.md +--- + +# Disable-AzSqlInstanceDatabaseLedgerDigestUpload + +## SYNOPSIS +Disables uploading ledger digests to Azure Blob storage or Azure Confidential Ledger in Azure SQL Managed Instance. + +## SYNTAX + +### DatabaseParameterSet (Default) +``` +Disable-AzSqlInstanceDatabaseLedgerDigestUpload [-ResourceGroupName] <String> [-ManagedInstance] <String> + [-DatabaseName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Disable-AzSqlInstanceDatabaseLedgerDigestUpload -InputObject <AzureSqlManagedDatabaseModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Disable-AzSqlInstanceDatabaseLedgerDigestUpload [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Disable-AzSqlInstanceDatabaseLedgerDigestUpload cmdlet disables uploading of ledger digests to Azure Blob storage or Azure Confidential Ledger in Azure SQL Managed Instance. To use the cmdlet, identify the database. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzSqlInstanceDatabaseLedgerDigestUpload -ResourceGroupName "ResourceGroup01" -InstanceName "Server01" -DatabaseName "Database01" +``` + +```output +ResourceGroupName InstanceName DatabaseName State Endpoint +----------------- ------------ ------------ ----- -------- +ResourceGroup01 Server01 Database01 Disabled +``` + +## PARAMETERS + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to disable digest uploads for. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the database to disable digest uploads for. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstanceName +Azure SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlManagedDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstanceLedgerDigestUploads.Model.AzureSqlInstanceDatabaseLedgerDigestUploadModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Disable-AzSqlInstanceDatabaseSensitivityRecommendation.md b/azps-10.1.0/Az.Sql/Disable-AzSqlInstanceDatabaseSensitivityRecommendation.md new file mode 100644 index 0000000000..c4317fac89 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Disable-AzSqlInstanceDatabaseSensitivityRecommendation.md @@ -0,0 +1,271 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/disable-azsqlinstancedatabasesensitivityrecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlInstanceDatabaseSensitivityRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlInstanceDatabaseSensitivityRecommendation.md +--- + +# Disable-AzSqlInstanceDatabaseSensitivityRecommendation + +## SYNOPSIS +Disables (dismisses) sensitivity recommendations on columns in the Azure SQL Managed Instance database. + +## SYNTAX + +### InputObjectParameterSet (Default) +``` +Disable-AzSqlInstanceDatabaseSensitivityRecommendation + -InputObject <ManagedDatabaseSensitivityClassificationModel> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Disable-AzSqlInstanceDatabaseSensitivityRecommendation [-ResourceGroupName] <String> [-InstanceName] <String> + [-DatabaseName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DatabaseObjectColumnParameterSet +``` +Disable-AzSqlInstanceDatabaseSensitivityRecommendation -DatabaseObject <AzureSqlManagedDatabaseModel> + -SchemaName <String> -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Disable-AzSqlInstanceDatabaseSensitivityRecommendation cmdlet disables (dismisses) sensitivity recommendations on columns in the Azure SQL Managed Instance database. + +## EXAMPLES + +### Example 1: Disable sensitivity recommendations on a given column in an Azure SQL Managed Instance database. +```powershell +Disable-AzSqlInstanceDatabaseSensitivityRecommendation -ResourceGroupName resourceGroup -InstanceName managedInstance -DatabaseName database -SchemaName schema -TableName table -ColumnName column +``` + +### Example 2: Disable sensitivity recommendations on columns which have sensitivity recommendations in an Azure SQL Managed Instance database with Piping. +```powershell +Get-AzSqlInstanceDatabaseSensitivityRecommendation -ResourceGroupName resourceGroup -InstanceName managedInstance -DatabaseName database | Disable-AzSqlInstanceDatabaseSensitivityRecommendation +``` + +### Example 3: Disable sensitivity recommendations on a given column in an Azure SQL Managed Instance database with Piping. +```powershell +Get-AzSqlInstanceDatabase -ResourceGroupName resourceGroup -InstanceName managedInstance -Name database | Disable-AzSqlInstanceDatabaseSensitivityRecommendation -SchemaName schema -TableName table -ColumnName column +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Managed Instance database. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +The Azure SQL Managed Instance database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +An object representing a SQL Managed Instance Database Sensitivity Classification. + +```yaml +Type: Microsoft.Azure.Commands.Sql.DataClassification.Model.ManagedDatabaseSensitivityClassificationModel +Parameter Sets: InputObjectParameterSet +Aliases: ClassificationObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +Azure SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Specifies whether to output the sensitivity classification model at end of cmdlet execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.DataClassification.Model.ManagedDatabaseSensitivityClassificationModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Learn more about Azure SQL Database data discovery and classification](https://learn.microsoft.com/azure/sql-database/sql-database-data-discovery-and-classification) diff --git a/azps-10.1.0/Az.Sql/Disable-AzSqlServerActiveDirectoryOnlyAuthentication.md b/azps-10.1.0/Az.Sql/Disable-AzSqlServerActiveDirectoryOnlyAuthentication.md new file mode 100644 index 0000000000..3b2dd84033 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Disable-AzSqlServerActiveDirectoryOnlyAuthentication.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/disable-azsqlserveractivedirectoryonlyauthentication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlServerActiveDirectoryOnlyAuthentication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlServerActiveDirectoryOnlyAuthentication.md +--- + +# Disable-AzSqlServerActiveDirectoryOnlyAuthentication + +## SYNOPSIS +Disables Azure AD only authentication for a specific SQL Server. + +## SYNTAX + +### UseResourceGroupAndServerNameParameterSet (Default) +``` +Disable-AzSqlServerActiveDirectoryOnlyAuthentication [-ResourceGroupName] <String> [-ServerName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UseInputObjectParameterSet +``` +Disable-AzSqlServerActiveDirectoryOnlyAuthentication -InputObject <AzureSqlServerModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UserResourceIdParameterSet +``` +Disable-AzSqlServerActiveDirectoryOnlyAuthentication [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzSqlServerActiveDirectoryOnlyAuthentication** cmdlet disables Azure Active Directory (Azure AD) only authentication requirement for an AzureSQL Server in the current subscription. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzSqlServerActiveDirectoryOnlyAuthentication -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +```output +ResourceGroupName ServerName AzureADOnlyAuthentication +----------------- ---------- ----------- -------- ----------- +ResourceGroup01 Server01 False +``` + +This command disables Azure Active Directory (Azure AD) only authentication requirement for an AzureSQL server named Server01 that is associated with a resource group named ResourceGroup01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The SQL server object to use. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: UseInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndServerNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance to use + +```yaml +Type: System.String +Parameter Sets: UserResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the Azure Active Directory only authentication is in. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndServerNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryOnlyAuthenticationModel + +## NOTES + +## RELATED LINKS + +[Enable-AzSqlServerActiveDirectoryOnlyAuthentication](./Enable-AzSqlServerActiveDirectoryOnlyAuthentication.md) + +[Get-AzSqlServerActiveDirectoryOnlyAuthentication](./Get-AzSqlServerActiveDirectoryOnlyAuthentication.md) + +[Set-AzSqlServerActiveDirectoryAdministrator](./Set-AzSqlServerActiveDirectoryAdministrator.md) + +[Get-AzSqlServerActiveDirectoryAdministrator](./Get-AzSqlServerActiveDirectoryAdministrator.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Disable-AzSqlServerAdvancedDataSecurity.md b/azps-10.1.0/Az.Sql/Disable-AzSqlServerAdvancedDataSecurity.md new file mode 100644 index 0000000000..3d481f1f5a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Disable-AzSqlServerAdvancedDataSecurity.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/disable-azsqlserveradvanceddatasecurity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlServerAdvancedDataSecurity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Disable-AzSqlServerAdvancedDataSecurity.md +--- + +# Disable-AzSqlServerAdvancedDataSecurity + +## SYNOPSIS +Disables Advanced Data Security on a server. + +## SYNTAX + +``` +Disable-AzSqlServerAdvancedDataSecurity [-InputObject <AzureSqlServerModel>] -ServerName <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzSqlServerAdvancedDataSecurity** cmdlet disables Advanced Data Security on a server. + +## EXAMPLES + +### Example 1: Disable server Advanced Data Security +```powershell +Disable-AzSqlServerAdvancedDataSecurity ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +IsEnabled : False +``` + +### Example 2: Disable server Advanced Data Security from server resource +```powershell +Get-AzSqlServer ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + | Disable-AzSqlServerAdvancedDataSecurity +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +IsEnabled : False +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The server object to use with Advanced Data Security policy operation + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.AdvancedThreatProtection.Model.ServerAdvancedDataSecurityPolicyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Enable-AzSqlDatabaseLedgerDigestUpload.md b/azps-10.1.0/Az.Sql/Enable-AzSqlDatabaseLedgerDigestUpload.md new file mode 100644 index 0000000000..3aafe0f4c2 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Enable-AzSqlDatabaseLedgerDigestUpload.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/enable-azsqldatabaseledgerdigestupload +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlDatabaseLedgerDigestUpload.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlDatabaseLedgerDigestUpload.md +--- + +# Enable-AzSqlDatabaseLedgerDigestUpload + +## SYNOPSIS +Enables uploading ledger digests to an Azure Storage account or to Azure Confidential Ledger. + +## SYNTAX + +### DatabaseParameterSet (Default) +``` +Enable-AzSqlDatabaseLedgerDigestUpload [-Endpoint] <String> [-ResourceGroupName] <String> + [-ServerName] <String> [-DatabaseName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Enable-AzSqlDatabaseLedgerDigestUpload [-Endpoint] <String> -InputObject <AzureSqlDatabaseModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Enable-AzSqlDatabaseLedgerDigestUpload [-Endpoint] <String> [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Enable-AzSqlDatabaseLedgerDigestUpload cmdlet enables uploading ledger digests to Azure Blob storage or Azure Confidential Ledger. To use the cmdlet, specify the endpoint of an Azure Blob storage account or a ledger in Azure Confidential Ledger, and identify the database. If uploading ledger digests is already enabled, the cmdlet resets the digest storage endpoint to a new value. + +## EXAMPLES + +### Example 1 +```powershell +Enable-AzSqlDatabaseLedgerDigestUpload -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -Endpoint "https://mystorage.blob.core.windows.net" +``` + +```output +ResourceGroupName ServerName DatabaseName State Endpoint +----------------- ---------- ------------ ----- -------- +ResourceGroup01 Server01 Database01 Enabled https://mystorage.blob.core.windows.net +``` + +## PARAMETERS + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The Azure Sql Database Ledger Digest Uploads endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to disable digest uploads for. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the database to disable digest uploads for. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.LedgerDigestUploads.Model.AzureSqlDatabaseLedgerDigestLocationModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Enable-AzSqlDatabaseSensitivityRecommendation.md b/azps-10.1.0/Az.Sql/Enable-AzSqlDatabaseSensitivityRecommendation.md new file mode 100644 index 0000000000..eb54c0fb35 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Enable-AzSqlDatabaseSensitivityRecommendation.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/enable-azsqldatabasesensitivityrecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlDatabaseSensitivityRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlDatabaseSensitivityRecommendation.md +--- + +# Enable-AzSqlDatabaseSensitivityRecommendation + +## SYNOPSIS +Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the database. + +## SYNTAX + +### InputObjectParameterSet (Default) +``` +Enable-AzSqlDatabaseSensitivityRecommendation -InputObject <SqlDatabaseSensitivityClassificationModel> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Enable-AzSqlDatabaseSensitivityRecommendation [-ResourceGroupName] <String> [-ServerName] <String> + [-DatabaseName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DatabaseObjectColumnParameterSet +``` +Enable-AzSqlDatabaseSensitivityRecommendation -DatabaseObject <AzureSqlDatabaseModel> -SchemaName <String> + -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Enable-AzSqlDatabaseSensitivityRecommendation cmdlet enables sensitivity recommendations on columns in the database. + +## EXAMPLES + +### Example 1: Enable sensitivity recommendations on a given column in an Azure SQL Database. +```powershell +Enable-AzSqlDatabaseSensitivityRecommendation -ResourceGroupName resourceGroup -ServerName server -DatabaseName database -SchemaName schema -TableName table -ColumnName column +``` + +### Example 2: Enable sensitivity recommendations on a given column Azure SQL database using Piping. +```powershell +Get-AzSqlDatabase -ResourceGroupName resourceGroup -ServerName server -DatabaseName database | Enable-AzSqlDatabaseSensitivityRecommendation -SchemaName schema -TableName table -ColumnName column +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL database. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +The SQL database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +An object representing a SQL Database Sensitivity Classification. + +```yaml +Type: Microsoft.Azure.Commands.Sql.DataClassification.Model.SqlDatabaseSensitivityClassificationModel +Parameter Sets: InputObjectParameterSet +Aliases: ClassificationObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Specifies whether to output the sensitivity classification model at end of cmdlet execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.DataClassification.Model.SqlDatabaseSensitivityClassificationModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Learn more about Azure SQL Database data discovery and classification](https://learn.microsoft.com/azure/sql-database/sql-database-data-discovery-and-classification) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md b/azps-10.1.0/Az.Sql/Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md new file mode 100644 index 0000000000..922ffccfa4 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/enable-azsqlinstanceactivedirectoryonlyauthentication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md +--- + +# Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication + +## SYNOPSIS +Enables Azure AD only authentication for a specific SQL Managed Instance. + +## SYNTAX + +### UseResourceGroupAndInstanceNameParameterSet (Default) +``` +Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication [-ResourceGroupName] <String> [-InstanceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UseInputObjectParameterSet +``` +Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication -InputObject <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UserResourceIdParameterSet +``` +Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication** cmdlet enables Azure Active Directory (Azure AD) only authentication requirement for an AzureSQL Managed Instance in the current subscription. + +## EXAMPLES + +### Example 1 +```powershell +Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" +``` + +```output +ResourceGroupName InstanceName AzureADOnlyAuthentication +----------------- ---------- ----------- -------- ----------- +ResourceGroup01 ManagedInstance01 True +``` + +This command enables Azure Active Directory (Azure AD) only authentication requirement for an AzureSQL Managed Instance named ManagedInstance01 that is associated with a resource group named ResourceGroup01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed instance object to use. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: UseInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The name of the Azure SQL Managed Instance the Azure Active Directory only authentication is in. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndInstanceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndInstanceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance to use + +```yaml +Type: System.String +Parameter Sets: UserResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.InstanceActiveDirectoryOnlyAuthentication.Model.AzureSqlInstanceActiveDirectoryOnlyAuthenticationModel + +## NOTES + +## RELATED LINKS + +[Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication](./Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md) + +[Get-AzSqlInstanceActiveDirectoryOnlyAuthentication](./Get-AzSqlInstanceActiveDirectoryOnlyAuthentication.md) + +[Set-AzSqlInstanceActiveDirectoryAdministrator](./Set-AzSqlInstanceActiveDirectoryAdministrator.md) + +[Get-AzSqlInstanceActiveDirectoryAdministrator](./Get-AzSqlInstanceActiveDirectoryAdministrator.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Enable-AzSqlInstanceAdvancedDataSecurity.md b/azps-10.1.0/Az.Sql/Enable-AzSqlInstanceAdvancedDataSecurity.md new file mode 100644 index 0000000000..c0c9e34241 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Enable-AzSqlInstanceAdvancedDataSecurity.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/enable-azsqlinstanceadvanceddatasecurity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlInstanceAdvancedDataSecurity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlInstanceAdvancedDataSecurity.md +--- + +# Enable-AzSqlInstanceAdvancedDataSecurity + +## SYNOPSIS +Enables Advanced Data Security on a managed instance. + +## SYNTAX + +``` +Enable-AzSqlInstanceAdvancedDataSecurity [-DoNotConfigureVulnerabilityAssessment] [-AsJob] + [-DeploymentName <String>] [-InputObject <AzureSqlManagedInstanceModel>] -InstanceName <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzSqlInstanceAdvancedDataSecurity** cmdlet enables Advanced Data Security on a managed instance. Advanced Data Security is a unified security package that includes Data Classification, Vulnerability Assessment and Advanced Threat Protection for your managed instance. (A new storage account will automatically be created for saving vulnerability assessments. If a storage account was previously created for this purpose, it will be used instead) + +## EXAMPLES + +### Example 1: Enable managed instance Advanced Data Security +```powershell +Enable-AzSqlInstanceAdvancedDataSecurity ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ManagedInstanceName : ManagedInstance01 +IsEnabled : True +``` + +### Example 2: Enable managed instance Advanced Data Security from server resource +```powershell +Get-AzSqlInstance ` + -ResourceGroupName "ResourceGroup01" ` + -Name "ManagedInstance01" ` + | Enable-AzSqlInstanceAdvancedDataSecurity +``` + +```output +ResourceGroupName : ResourceGroup01 +ManagedInstanceName : ManagedInstance01 +IsEnabled : True +``` + +### Example 3 + +Enables Advanced Data Security on a managed instance. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Enable-AzSqlInstanceAdvancedDataSecurity -DoNotConfigureVulnerabilityAssessment -InstanceName 'ContosoManagedInstanceName' -ResourceGroupName MyResourceGroup +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +Supply a custom name for Advanced Data Security deployment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DoNotConfigureVulnerabilityAssessment +Do not auto enable Vulnerability Assessment (This will not create a storage account) + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed instance object to use with Advanced Data Security policy operation + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Database managed instance name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.AdvancedThreatProtection.Model.ManagedInstanceAdvancedDataSecurityPolicyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Enable-AzSqlInstanceDatabaseLedgerDigestUpload.md b/azps-10.1.0/Az.Sql/Enable-AzSqlInstanceDatabaseLedgerDigestUpload.md new file mode 100644 index 0000000000..438dff937e --- /dev/null +++ b/azps-10.1.0/Az.Sql/Enable-AzSqlInstanceDatabaseLedgerDigestUpload.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/enable-azsqlinstancedatabaseledgerdigestupload +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlInstanceDatabaseLedgerDigestUpload.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlInstanceDatabaseLedgerDigestUpload.md +--- + +# Enable-AzSqlInstanceDatabaseLedgerDigestUpload + +## SYNOPSIS +Enables uploading ledger digests to an Azure Storage account or Azure Confidential Ledger for a database in an Azure SQL Managed Instance. + +## SYNTAX + +### DatabaseParameterSet (Default) +``` +Enable-AzSqlInstanceDatabaseLedgerDigestUpload [-Endpoint] <String> [-ResourceGroupName] <String> + [-ServerName] <String> [-DatabaseName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Enable-AzSqlInstanceDatabaseLedgerDigestUpload [-Endpoint] <String> -InputObject <AzureSqlManagedDatabaseModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Enable-AzSqlInstanceDatabaseLedgerDigestUpload [-Endpoint] <String> [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Enables uploading ledger digests to an Azure Storage account or Azure Confidential Ledger for a database in an Azure SQL Managed Instance. To use the cmdlet, specify the endpoint of an Azure Blob storage account or a ledger in Azure Confidential Ledger, and identify the database. If uploading ledger digests is already enabled, the cmdlet resets the digest storage endpoint to a new value. + +## EXAMPLES + +### Example 1 +```powershell +Enable-AzSqlInstanceDatabaseLedgerDigestUpload -ResourceGroupName "ResourceGroup01" -InstanceName "Server01" -DatabaseName "Database01" -Endpoint "https://mystorage.blob.core.windows.net" +``` + +```output +ResourceGroupName InstanceName DatabaseName State Endpoint +----------------- ------------ ------------ ----- -------- +ResourceGroup01 Server01 Database01 Enabled https://mystorage.blob.core.windows.net +``` + +## PARAMETERS + +### -InstanceName +SQL Instance name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The Azure Managed Instance Database Ledger Digest Uploads endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to enable digest uploads for. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the database to enable digest uploads for. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstanceName +Azure SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlManagedDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstanceLedgerDigestUploads.Model.AzureSqlInstanceDatabaseLedgerDigestUploadModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Enable-AzSqlInstanceDatabaseSensitivityRecommendation.md b/azps-10.1.0/Az.Sql/Enable-AzSqlInstanceDatabaseSensitivityRecommendation.md new file mode 100644 index 0000000000..b61663bd3b --- /dev/null +++ b/azps-10.1.0/Az.Sql/Enable-AzSqlInstanceDatabaseSensitivityRecommendation.md @@ -0,0 +1,266 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/enable-azsqlinstancedatabasesensitivityrecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlInstanceDatabaseSensitivityRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlInstanceDatabaseSensitivityRecommendation.md +--- + +# Enable-AzSqlInstanceDatabaseSensitivityRecommendation + +## SYNOPSIS +Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the Azure SQL Managed Instance database. + +## SYNTAX + +### InputObjectParameterSet (Default) +``` +Enable-AzSqlInstanceDatabaseSensitivityRecommendation + -InputObject <ManagedDatabaseSensitivityClassificationModel> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Enable-AzSqlInstanceDatabaseSensitivityRecommendation [-ResourceGroupName] <String> [-InstanceName] <String> + [-DatabaseName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DatabaseObjectColumnParameterSet +``` +Enable-AzSqlInstanceDatabaseSensitivityRecommendation -DatabaseObject <AzureSqlManagedDatabaseModel> + -SchemaName <String> -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Enable-AzSqlInstanceDatabaseSensitivityRecommendation cmdlet enables sensitivity recommendations on columns in the Azure SQL Managed Instance database. + +## EXAMPLES + +### Example 1: Enable sensitivity recommendations on a given column in an Azure SQL Managed Instance database. +```powershell +Enable-AzSqlInstanceDatabaseSensitivityRecommendation -ResourceGroupName resourceGroup -InstanceName managedInstance -DatabaseName database -SchemaName schema -TableName table -ColumnName column +``` + +### Example 2: Enable sensitivity recommendations on a given column in an Azure SQL Managed Instance database with Piping. +```powershell +Get-AzSqlInstanceDatabase -ResourceGroupName resourceGroup -InstanceName managedInstance -Name database | Remove-AzSqlInstanceDatabaseSensitivityClassification -SchemaName schema -TableName table -ColumnName column +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Managed Instance database. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +The Azure SQL Managed Instance database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +An object representing a SQL Managed Instance Database Sensitivity Classification. + +```yaml +Type: Microsoft.Azure.Commands.Sql.DataClassification.Model.ManagedDatabaseSensitivityClassificationModel +Parameter Sets: InputObjectParameterSet +Aliases: ClassificationObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +Azure SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Specifies whether to output the sensitivity classification model at end of cmdlet execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.DataClassification.Model.ManagedDatabaseSensitivityClassificationModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Learn more about Azure SQL Database data discovery and classification](https://learn.microsoft.com/azure/sql-database/sql-database-data-discovery-and-classification) diff --git a/azps-10.1.0/Az.Sql/Enable-AzSqlServerActiveDirectoryOnlyAuthentication.md b/azps-10.1.0/Az.Sql/Enable-AzSqlServerActiveDirectoryOnlyAuthentication.md new file mode 100644 index 0000000000..d693755915 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Enable-AzSqlServerActiveDirectoryOnlyAuthentication.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/enable-azsqlserveractivedirectoryonlyauthentication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlServerActiveDirectoryOnlyAuthentication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlServerActiveDirectoryOnlyAuthentication.md +--- + +# Enable-AzSqlServerActiveDirectoryOnlyAuthentication + +## SYNOPSIS +Enables Azure AD only authentication for a specific SQL Server. + +## SYNTAX + +### UseResourceGroupAndServerNameParameterSet (Default) +``` +Enable-AzSqlServerActiveDirectoryOnlyAuthentication [-ResourceGroupName] <String> [-ServerName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UseInputObjectParameterSet +``` +Enable-AzSqlServerActiveDirectoryOnlyAuthentication -InputObject <AzureSqlServerModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UserResourceIdParameterSet +``` +Enable-AzSqlServerActiveDirectoryOnlyAuthentication [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzSqlServerActiveDirectoryOnlyAuthentication** cmdlet enables Azure Active Directory (Azure AD) only authentication requirement for an AzureSQL Server in the current subscription. + +## EXAMPLES + +### Example 1 +```powershell +Enable-AzSqlServerActiveDirectoryOnlyAuthentication -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +```output +ResourceGroupName ServerName AzureADOnlyAuthentication +----------------- ---------- ----------- -------- ----------- +ResourceGroup01 Server01 True +``` + +This command enables Azure Active Directory (Azure AD) only authentication requirement for an AzureSQL server named Server01 that is associated with a resource group named ResourceGroup01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The SQL server object to use. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: UseInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndServerNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance to use + +```yaml +Type: System.String +Parameter Sets: UserResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the Azure Active Directory only authentication is in. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndServerNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryOnlyAuthenticationModel + +## NOTES + +## RELATED LINKS + +[Disable-AzSqlServerActiveDirectoryOnlyAuthentication](./Disable-AzSqlServerActiveDirectoryOnlyAuthentication.md) + +[Get-AzSqlServerActiveDirectoryOnlyAuthentication](./Get-AzSqlServerActiveDirectoryOnlyAuthentication.md) + +[Set-AzSqlServerActiveDirectoryAdministrator](./Set-AzSqlServerActiveDirectoryAdministrator.md) + +[Get-AzSqlServerActiveDirectoryAdministrator](./Get-AzSqlServerActiveDirectoryAdministrator.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Enable-AzSqlServerAdvancedDataSecurity.md b/azps-10.1.0/Az.Sql/Enable-AzSqlServerAdvancedDataSecurity.md new file mode 100644 index 0000000000..bef50fa02b --- /dev/null +++ b/azps-10.1.0/Az.Sql/Enable-AzSqlServerAdvancedDataSecurity.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/enable-azsqlserveradvanceddatasecurity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlServerAdvancedDataSecurity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Enable-AzSqlServerAdvancedDataSecurity.md +--- + +# Enable-AzSqlServerAdvancedDataSecurity + +## SYNOPSIS +Enables Advanced Data Security on a server. + +## SYNTAX + +``` +Enable-AzSqlServerAdvancedDataSecurity [-DoNotConfigureVulnerabilityAssessment] [-AsJob] + [-DeploymentName <String>] [-InputObject <AzureSqlServerModel>] -ServerName <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzSqlServerAdvancedDataSecurity** cmdlet enables Advanced Data Security on a server. Advanced Data Security is a unified security package that includes Data Classification, Vulnerability Assessment and Advanced Threat Protection for your server. (A new storage account will automatically be created for saving vulnerability assessments. If a storage account was previously created for this purpose, it will be used instead) + +## EXAMPLES + +### Example 1: Enable server Advanced Data Security +```powershell +Enable-AzSqlServerAdvancedDataSecurity ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +IsEnabled : True +``` + +### Example 2: Enable server Advanced Data Security from server resource +```powershell +Get-AzSqlServer ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + | Enable-AzSqlServerAdvancedDataSecurity +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +IsEnabled : True +``` + +### Example 3 + +Enables Advanced Data Security on a server. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Enable-AzSqlServerAdvancedDataSecurity -DoNotConfigureVulnerabilityAssessment -ResourceGroupName MyResourceGroup -ServerName s1 +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +Supply a custom name for Advanced Data Security deployment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DoNotConfigureVulnerabilityAssessment +Do not auto enable Vulnerability Assessment (This will not create a storage account) + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The server object to use with Advanced Data Security policy operation + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.AdvancedThreatProtection.Model.ServerAdvancedDataSecurityPolicyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlCapability.md b/azps-10.1.0/Az.Sql/Get-AzSqlCapability.md new file mode 100644 index 0000000000..8becf99c5a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlCapability.md @@ -0,0 +1,214 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 8C5D29AD-0B15-4CD4-8637-86ABD19F41C8 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlcapability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlCapability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlCapability.md +--- + +# Get-AzSqlCapability + +## SYNOPSIS +Gets SQL Database capabilities for the current subscription. + +## SYNTAX + +### FilterResults (Default) +``` +Get-AzSqlCapability [-LocationName] <String> [-ServerVersionName <String>] [-EditionName <String>] + [-ServiceObjectiveName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DefaultResults +``` +Get-AzSqlCapability [-LocationName] <String> [-Defaults] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlCapability** cmdlet gets the Azure SQL Database capabilities available on the current subscription for a region. +If you specify the *ServerVersionName*, *EditionName*, or *ServiceObjectiveName* parameters, this cmdlet returns the specified values and their predecessors. + +## EXAMPLES + +### Example 1: Get capabilities for the current subscription for a region +```powershell +Get-AzSqlCapability -LocationName "Central US" +``` + +```output +Location : Central US +Status : Available +SupportedServerVersions : {12.0, 2.0} +``` + +This command returns the capabilities for SQL Database instances on the current subscription for the Central US region. + +### Example 2: Get default capabilities for the current subscription for a region +```powershell +Get-AzSqlCapability -LocationName "Central US" -Defaults +``` + +```output +Location : Central US +Status : Available +ExpandedDetails : Version: 2.0 (Default) -> Edition: Standard (Default) -> Service Objective: S0 (Default) +``` + +This command returns the default capabilities for SQL Databases on the current subscription in the Central US region. + +### Example 3: Get details for a service objective +```powershell +Get-AzSqlCapability -LocationName "Central US" -ServiceObjectiveName "S1" +``` + +```output +Location : Central US +Status : Available +ExpandedDetails : Version: 12.0 (Available) -> Edition: Standard (Default) -> Service Objective: S1 (Available) + Version: 2.0 (Default) -> Edition: Standard (Default) -> Service Objective: S1 (Available) +``` + +This command gets default capabilities for SQL Databases for the specified service objective on the current subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Defaults +Indicates that this cmdlet gets only defaults. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultResults +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EditionName +Specifies the name of the database edition for which this cmdlet gets capabilities. + +```yaml +Type: System.String +Parameter Sets: FilterResults +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LocationName +Specifies the name of the Location for which this cmdlet gets capabilities. +For more information, see Azure Regionshttp://azure.microsoft.com/en-us/regions/ (http://azure.microsoft.com/en-us/regions/). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerVersionName +Specifies the name of the server version for which this cmdlet gets capabilities. + +```yaml +Type: System.String +Parameter Sets: FilterResults +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceObjectiveName +Specifies the name of the service objective for which this cmdlet gets capabilities. + +```yaml +Type: System.String +Parameter Sets: FilterResults +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Location_Capabilities.Model.LocationCapabilityModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabase.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabase.md new file mode 100644 index 0000000000..f1b5f73bc3 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabase.md @@ -0,0 +1,444 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 0C8AC52C-4E70-493C-A299-79CE32EC5EF1 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabase.md +--- + +# Get-AzSqlDatabase + +## SYNOPSIS +Gets one or more databases. + +## SYNTAX + +``` +Get-AzSqlDatabase [[-DatabaseName] <String>] [-ExpandKeyList] [-KeysFilter <String>] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabase** cmdlet gets one or more Azure SQL databases from an Azure SQL Database Server. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Get all databases on a server +```powershell +Get-AzSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : master +Location : Central US +DatabaseId : a2a7f2db-7526-4d86-a7b2-36276ee10dc6 +Edition : None +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 5368709120 +Status : Online +CreationDate : 7/3/2015 7:32:44 AM +CurrentServiceObjectiveId : c99ac918-dbea-463f-a475-16ec020fdc12 +CurrentServiceObjectiveName : System1 +RequestedServiceObjectiveId : c99ac918-dbea-463f-a475-16ec020fdc12 +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +Tags : +CurrentBackupStorageRedundancy : Geo +RequestedBackupStorageRedundancy : Geo + +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database01 +Location : Central US +DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 +Edition : Standard +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 268435456000 +Status : Online +CreationDate : 7/3/2015 7:33:37 AM +CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +CurrentServiceObjectiveName : S0 +RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +Tags : +CurrentBackupStorageRedundancy : Geo +RequestedBackupStorageRedundancy : Geo +``` + +This command gets all databases on the server named server01. + +### Example 2: Get a database by name on a server +```powershell +Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database02" +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database02 +Location : Central US +DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 +Edition : Standard +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 268435456000 +Status : Online +CreationDate : 7/3/2015 7:33:37 AM +CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +CurrentServiceObjectiveName : S0 +RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +Tags : +CurrentBackupStorageRedundancy : Geo +RequestedBackupStorageRedundancy : Geo +``` + +This command gets a database named Database02 from a server named Server01. + +### Example 3: Get all databases on a server using filtering +```powershell +Get-AzSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database*" +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database01 +Location : Central US +DatabaseId : a2a7f2db-7526-4d86-a7b2-36276ee10dc6 +Edition : None +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 5368709120 +Status : Online +CreationDate : 7/3/2015 7:32:44 AM +CurrentServiceObjectiveId : c99ac918-dbea-463f-a475-16ec020fdc12 +CurrentServiceObjectiveName : System1 +RequestedServiceObjectiveId : c99ac918-dbea-463f-a475-16ec020fdc12 +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +Tags : +CurrentBackupStorageRedundancy : Geo +RequestedBackupStorageRedundancy : Geo + +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database02 +Location : Central US +DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 +Edition : Standard +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 268435456000 +Status : Online +CreationDate : 7/3/2015 7:33:37 AM +CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +CurrentServiceObjectiveName : S0 +RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +Tags : +CurrentBackupStorageRedundancy : Geo +RequestedBackupStorageRedundancy : Geo +``` + +This command gets all databases on the server named server01 that start with "database". + +### Example 4: Get a database with TDE AKV keys on a server using expand keys parameter. +```powershell +Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database02" -ExpandKeyList +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database02 +Location : Central US +DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 +Edition : Standard +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 268435456000 +Status : Online +CreationDate : 7/3/2015 7:33:37 AM +CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +CurrentServiceObjectiveName : S0 +RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +Tags : +CurrentBackupStorageRedundancy : Geo +RequestedBackupStorageRedundancy : Geo +Identity : Microsoft.Azure.Management.Sql.Models.DatabaseIdentity +EncryptionProtector : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +Keys : {[https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901, Microsoft.Azure.Management.Sql.Models.DatabaseKey], + [https://contoso.vault.azure.net/keys/contosokey2/09876543210987654321098765432109, Microsoft.Azure.Management.Sql.Models.DatabaseKey]} +FederatedClientId : +``` + +This command gets all the TDE AKV keys configured on the database. + +### Example 5: Get a database with TDE AKV keys on a server using expand keys and filter by date +```powershell +Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database02" -ExpandKeyList -KeysFilter "1/13/2022" +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database02 +Location : Central US +DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 +Edition : Standard +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 268435456000 +Status : Online +CreationDate : 7/3/2015 7:33:37 AM +CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +CurrentServiceObjectiveName : S0 +RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +Tags : +CurrentBackupStorageRedundancy : Geo +RequestedBackupStorageRedundancy : Geo +Identity : Microsoft.Azure.Management.Sql.Models.DatabaseIdentity +EncryptionProtector : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +Keys : {[https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901, Microsoft.Azure.Management.Sql.Models.DatabaseKey], + [https://contoso.vault.azure.net/keys/contosokey2/09876543210987654321098765432109, Microsoft.Azure.Management.Sql.Models.DatabaseKey]} +FederatedClientId : +``` + +This command gets a database configured with TDE CMK keys + +### Example 6: Get a database with TDE AKV keys on a server using expand keys and filter as 'current' +```powershell +Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database02" -ExpandKeyList -KeysFilter "current" +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database02 +Location : Central US +DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 +Edition : Standard +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 268435456000 +Status : Online +CreationDate : 7/3/2015 7:33:37 AM +CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +CurrentServiceObjectiveName : S0 +RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +Tags : +CurrentBackupStorageRedundancy : Geo +RequestedBackupStorageRedundancy : Geo +Identity : Microsoft.Azure.Management.Sql.Models.DatabaseIdentity +EncryptionProtector : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +Keys : +FederatedClientId : +``` + +This command gets a database configured with TDE CMK keys with filter as 'current' + +### Example 7: Get a database configured with preferred enclave type as VBS + +```powershell +Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database02" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database02 +Location : Central US +DatabaseId : 34d9d561-42a7-484e-bf05-62ddef8000ab +Edition : GeneralPurpose +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 268435456000 +Status : Online +CreationDate : 8/26/2015 10:04:29 PM +CurrentServiceObjectiveName : GP_Gen5_2 +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +LicenseType : LicenseIncluded +Tags : +EnableLedger : False +PreferredEnclaveType : VBS +``` + +This command gets a database configured with VBS enclave + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database to retrieve. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandKeyList +Flag to be used to view all the AKV keys in a database. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeysFilter +Timestamp filter to Get AKV keys + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the database server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlDatabase](./New-AzSqlDatabase.md) + +[Remove-AzSqlDatabase](./Remove-AzSqlDatabase.md) + +[Resume-AzSqlDatabase](./Resume-AzSqlDatabase.md) + +[Set-AzSqlDatabase](./Set-AzSqlDatabase.md) + +[Suspend-AzSqlDatabase](./Suspend-AzSqlDatabase.md) + + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseActivity.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseActivity.md new file mode 100644 index 0000000000..398da29bbd --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseActivity.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: B5C909D7-6087-463A-83BF-99DD196B9862 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabaseactivity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseActivity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseActivity.md +--- + +# Get-AzSqlDatabaseActivity + +## SYNOPSIS +Gets the status of database operations. + +## SYNTAX + +``` +Get-AzSqlDatabaseActivity [-ServerName] <String> [-ElasticPoolName <String>] -DatabaseName <String> + [-OperationId <Guid>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseActivity** cmdlet gets the status of database operations in Azure SQL Database. + +## EXAMPLES + +### Example 1: Get status for all SQL Database instances +```powershell +Get-AzSqlDatabaseActivity -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" +``` + +This command returns the operation status of all SQL Database instances in an elastic pool named ElasticPool01. + +### Example 2: Get status for all SQL Database operations +```powershell +Get-AzSqlDatabaseActivity -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +This command returns the status of all SQL Database operations in a database. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database for which this cmdlet gets status. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies the name of the elastic database pool for which this cmdlet gets status. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OperationId +Specifies the ID of the operation that this cmdlet gets. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the Microsoft SQL Server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseActivityModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..065c92e6cf --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseAdvancedThreatProtectionSetting.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 017EF522-ABC5-40EE-B8DC-369D097F49D0 +online version: https://learn.microsoft.com/powershell/module/az.sql/Get-AzSqlDatabaseAdvancedThreatProtectionSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseAdvancedThreatProtectionSetting.md +--- + +# Get-AzSqlDatabaseAdvancedThreatProtectionSetting + +## SYNOPSIS +Gets the Advanced Threat Protection settings for a database. + +## SYNTAX + +``` +Get-AzSqlDatabaseAdvancedThreatProtectionSetting [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseAdvancedThreatProtectionSetting** cmdlet gets the Advanced Threat Protection settings of an Azure SQL database. +To use this cmdlet, specify the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database for which this cmdlet gets the settings. + +## EXAMPLES + +### Example 1: Get the Advanced Threat Protection settings for a database +```powershell +Get-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" +``` + +```output +DatabaseName : Database01 +ResourceGroupName : ResourceGroup11 +ServerName : Server01 +AdvancedThreatProtectionState : Enabled +``` + +This command gets the Advanced Threat Protection settings for a database named Database01. +The database is located on the server named Server01, which is assigned to the resource group ResourceGroup11. + +## PARAMETERS + +### -DatabaseName +Specifies the name of a database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseAdvancedThreatProtectionSettingsModel + +## NOTES + +## RELATED LINKS + +[Azure SQL Database cmdlets](/powershell/module/az.sql/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseAdvisor.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseAdvisor.md new file mode 100644 index 0000000000..a9cb7befdd --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseAdvisor.md @@ -0,0 +1,335 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 5AAB22C6-8E3C-4BDC-8A54-DA5A9906B762 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabaseadvisor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseAdvisor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseAdvisor.md +--- + +# Get-AzSqlDatabaseAdvisor + +## SYNOPSIS +Gets one or more Advisors for an Azure SQL Database. + +## SYNTAX + +``` +Get-AzSqlDatabaseAdvisor [-AdvisorName <String>] [-ExpandRecommendedActions] -ServerName <String> + -DatabaseName <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseAdvisor** cmdlet gets one or more Azure SQL Database Advisors for an Azure SQL Database. + +## EXAMPLES + +### Example 1: List all the advisors for the specified database +```powershell +Get-AzSqlDatabaseAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" +``` + +```output +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {} + +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DropIndex +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 7/31/2016 8:41:19 PM +RecommendationsStatus : Ok +RecommendedActions : {} + +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DbParameterization +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 7/31/2016 2:46:58 PM +RecommendationsStatus : NoDbParameterizationIssue +RecommendedActions : {} + +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : SchemaIssue +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 8/1/2016 3:01:41 PM +RecommendationsStatus : SchemaIsConsistent +RecommendedActions : {} +``` + +This command gets lists all the advisors for the database named WIRunner that belongs to the server named wi-runner-australia-east. + +### Example 2: Get a single advisor for the specified database +```powershell +Get-AzSqlDatabaseAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -AdvisorName "CreateIndex" +``` + +```output +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {} +``` + +This command gets the Advisor named CreateIndex for the database named WIRunner. + +### Example 3: List all the advisors with their recommended actions included in the response +```powershell +Get-AzSqlDatabaseAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -ExpandRecommendedActions +``` + +```output +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.437714]_6C7AE8CC9C87E7FD5893...} + +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DropIndex +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 7/31/2016 8:41:19 PM +RecommendationsStatus : Ok +RecommendedActions : {IR_[test_schema]_[test_table_0.0288891]_38724E1DCF2178318957, + IR_[test_schema]_[test_table_0.140264]_38724E1DCF2178318957, + IR_[test_schema]_[test_table_0.412191]_38724E1DCF2178318957, + IR_[test_schema]_[test_table_0.442075]_38724E1DCF2178318957...} + +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DbParameterization +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 7/31/2016 2:46:58 PM +RecommendationsStatus : NoDbParameterizationIssue +RecommendedActions : {} + +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : SchemaIssue +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 8/1/2016 3:04:26 PM +RecommendationsStatus : SchemaIsConsistent +RecommendedActions : {} +``` + +This command gets all the advisors for the database named 'WIRunner' with their recommended actions included in the response. +Since the command uses the *ExpandRecommendedActions* parameter, the cmdlet gets the recommended actions with the response. + +### Example 4: Get a single advisor with its recommended actions included in the response +```powershell +Get-AzSqlDatabaseAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -AdvisorName "CreateIndex" -ExpandRecommendedActions +``` + +```output +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.437714]_6C7AE8CC9C87E7FD5893...} +``` + +This command gets the Advisor named CreateIndex from the database named WIRunner with its recommended actions included in the response. +Since the command uses the *ExpandRecommendedActions* parameter, the cmdlet gets the recommended actions with the response. + +### Example 5: List all the advisors for the specified database using filtering +```powershell +Get-AzSqlDatabaseAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -AdvisorName d* +``` + +```output +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DropIndex +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 7/31/2016 8:41:19 PM +RecommendationsStatus : Ok +RecommendedActions : {} + +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DbParameterization +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 7/31/2016 2:46:58 PM +RecommendationsStatus : NoDbParameterizationIssue +RecommendedActions : {} +``` + +This command gets lists all the advisors for the database named WIRunner that belongs to the server named wi-runner-australia-east and start with the letter "d". + +## PARAMETERS + +### -AdvisorName +Specifies the name of the advisor that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DatabaseName +Specifies the name of the database for which this cmdlet requests the Advisor. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandRecommendedActions +Indicates that this cmdlet gets the recommended actions with the response. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the server that contains this database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that contains the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Advisor.Model.AzureSqlDatabaseAdvisorModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql, advisor + +## RELATED LINKS + +[Get-AzSqlServerAdvisor](./Get-AzSqlServerAdvisor.md) + +[Get-AzSqlElasticPoolAdvisor](./Get-AzSqlElasticPoolAdvisor.md) + +[Get-AzSqlDatabaseRecommendedAction](./Get-AzSqlDatabaseRecommendedAction.md) + +[Set-AzSqlDatabaseAdvisorAutoExecuteStatus](./Set-AzSqlDatabaseAdvisorAutoExecuteStatus.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseAudit.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseAudit.md new file mode 100644 index 0000000000..b12ce710df --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseAudit.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/Get-AzSqlDatabaseAudit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseAudit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseAudit.md +--- + +# Get-AzSqlDatabaseAudit + +## SYNOPSIS +Gets the auditing settings of an Azure SQL database. + +## SYNTAX + +### DatabaseParameterSet (Default) +``` +Get-AzSqlDatabaseAudit [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DatabaseObjectParameterSet +``` +Get-AzSqlDatabaseAudit -DatabaseObject <AzureSqlDatabaseModel> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseAudit** cmdlet gets the auditing settings of an Azure SQL database. +To use the cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. + +## EXAMPLES + +### Example 1: Get the auditing settings of an Azure SQL database +```powershell +Get-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +```output +ServerName : server01 +DatabaseName : database01 +AuditAction : {} +ResourceGroupName : resourcegroup01 +AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, + BATCH_COMPLETED_GROUP, ...} +PredicateExpression : statement <> 'select 1' +BlobStorageTargetState : Enabled +StorageAccountResourceId : /subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage +StorageKeyType : Primary +RetentionInDays : 0 +EventHubTargetState : Enabled +EventHubName : eventHubName +EventHubAuthorizationRuleResourceId : EventHubAuthorizationRuleResourceId +LogAnalyticsTargetState : Enabled +WorkspaceResourceId : "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +### Example 2: Get, through pipeline, the auditing settings of an Azure SQL database +```powershell +Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" | Get-AzSqlDatabaseAudit +``` + +```output +ServerName : server01 +DatabaseName : database01 +AuditAction : {} +ResourceGroupName : resourcegroup01 +AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, + BATCH_COMPLETED_GROUP, ...} +PredicateExpression : statement <> 'select 1' +BlobStorageTargetState : Enabled +StorageAccountResourceId : /subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage +StorageKeyType : Primary +RetentionInDays : 0 +EventHubTargetState : Enabled +EventHubName : eventHubName +EventHubAuthorizationRuleResourceId : EventHubAuthorizationRuleResourceId +LogAnalyticsTargetState : Enabled +WorkspaceResourceId : "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +### Example 3: Get the auditing settings of an Azure SQL database +```powershell +Get-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +```output +ServerName : server01 +DatabaseName : database01 +AuditAction : {} +ResourceGroupName : resourcegroup01 +AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, + BATCH_COMPLETED_GROUP, ...} +PredicateExpression : statement <> 'select 1' +BlobStorageTargetState : Enabled +StorageAccountResourceId : /subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage +StorageKeyType : Primary +RetentionInDays : 0 +EventHubTargetState : Enabled +EventHubName : eventHubName +EventHubAuthorizationRuleResourceId : EventHubAuthorizationRuleResourceId +LogAnalyticsTargetState : Disabled +WorkspaceResourceId : +``` + +## PARAMETERS + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseObject +The database object to manage its audit policy. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: DatabaseObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Auditing.Model.DatabaseAuditModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseBackupLongTermRetentionPolicy.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseBackupLongTermRetentionPolicy.md new file mode 100644 index 0000000000..03f1b59e11 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseBackupLongTermRetentionPolicy.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabasebackuplongtermretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseBackupLongTermRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseBackupLongTermRetentionPolicy.md +--- + +# Get-AzSqlDatabaseBackupLongTermRetentionPolicy + +## SYNOPSIS +Gets a database long term retention policy. + +## SYNTAX + +``` +Get-AzSqlDatabaseBackupLongTermRetentionPolicy [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseBackupLongTermRetentionPolicy** cmdlet gets the long term retention policy registered to this database. +The policy is an Azure Backup resource used to define backup storage policy. + +## EXAMPLES + +### Example 1: Get the current version of the long term retention policy +```powershell +Get-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database01 +WeeklyRetention : P2W +MonthlyRetention : PT0S +YearlyRetention : PT0S +WeekOfYear : 0 +State : +RecoveryServicesBackupPolicyResourceId : +Location : +``` + +This command gets the current version of the long term retention policy for database01 + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Database to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the database is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseBackupLongTermRetentionPolicyModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseLongTermRetentionBackup](./Get-AzSqlDatabaseLongTermRetentionBackup.md) + +[Update-AzSqlDatabaseLongTermRetentionBackup](./Update-AzSqlDatabaseLongTermRetentionBackup.md) + +[Copy-AzSqlDatabaseLongTermRetentionBackup](./Copy-AzSqlDatabaseLongTermRetentionBackup.md) + +[Remove-AzSqlDatabaseLongTermRetentionBackup](./Remove-AzSqlDatabaseLongTermRetentionBackup.md) + +[Set-AzSqlDatabaseBackupLongTermRetentionPolicy](./Set-AzSqlDatabaseBackupLongTermRetentionPolicy.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseBackupShortTermRetentionPolicy.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseBackupShortTermRetentionPolicy.md new file mode 100644 index 0000000000..e90fae60e4 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseBackupShortTermRetentionPolicy.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabasebackupshorttermretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseBackupShortTermRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseBackupShortTermRetentionPolicy.md +--- + +# Get-AzSqlDatabaseBackupShortTermRetentionPolicy + +## SYNOPSIS +Gets a backup short term retention policy. + +## SYNTAX + +### PolicyByResourceServerDatabaseSet (Default) +``` +Get-AzSqlDatabaseBackupShortTermRetentionPolicy [-ResourceGroupName] <String> [-ServerName] <String> + [-DatabaseName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicyByInputObjectSet +``` +Get-AzSqlDatabaseBackupShortTermRetentionPolicy -AzureSqlDatabaseObject <AzureSqlDatabaseModel> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicyByResourceIdSet +``` +Get-AzSqlDatabaseBackupShortTermRetentionPolicy -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseBackupShortTermRetentionPolicy** cmdlet gets the short term retention policy registered to this database. +The policy is the retention period in days and differential backup interval in hours, for point-in-time restore backups. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlDatabaseBackupShortTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 +``` + +```output +ResourceGroupName ServerName DatabaseName RetentionDays DiffBackupIntervalInHours +----------------- ---------- ------------ ------------- ------------------------- +resourcegroup01 server01 database01 7 24 +``` + +This command gets the short term retention policy for database01. + +### Example 2 +```powershell +Get-AzSqlDatabase -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 | Get-AzSqlDatabaseBackupShortTermRetentionPolicy +``` + +```output +ResourceGroupName ServerName DatabaseName RetentionDays DiffBackupIntervalInHours +----------------- ---------- ------------ ------------- ------------------------- +resourcegroup01 server01 database01 7 24 +``` + +This command gets the short term retention policy for database01 via piping in a database object. + +## PARAMETERS + +### -AzureSqlDatabaseObject +The database object to get the policy for. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: PolicyByInputObjectSet +Aliases: AzureSqlDatabase + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Database to use. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceServerDatabaseSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceServerDatabaseSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The short term retention policy resource Id. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceIdSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the database is in. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceServerDatabaseSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseBackupShortTermRetentionPolicyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseDataMaskingPolicy.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseDataMaskingPolicy.md new file mode 100644 index 0000000000..599f49392d --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseDataMaskingPolicy.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: FFC02A5D-A12F-494D-8542-76A5B89E32DC +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabasedatamaskingpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseDataMaskingPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseDataMaskingPolicy.md +--- + +# Get-AzSqlDatabaseDataMaskingPolicy + +## SYNOPSIS +Gets the data masking policy for a database. + +## SYNTAX + +``` +Get-AzSqlDatabaseDataMaskingPolicy [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseDataMaskingPolicy** cmdlet gets the data masking policy of an Azure SQL database. +To use this cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Get the data masking policy for an Azure SQL database +```powershell +Get-AzSqlDatabaseDataMaskingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +```output +DatabaseName : Database01 +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DataMaskingState : Enabled +PrivilegedUsers : +``` + +This command gets the data masking policy from database Database01 in resource group ResourceGroup01 on server Server01. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server where the database is located. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataMasking.Model.DatabaseDataMaskingPolicyModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseDataMaskingRule](./Get-AzSqlDatabaseDataMaskingRule.md) + +[New-AzSqlDatabaseDataMaskingRule](./New-AzSqlDatabaseDataMaskingRule.md) + +[Remove-AzSqlDatabaseDataMaskingRule](./Remove-AzSqlDatabaseDataMaskingRule.md) + +[Set-AzSqlDatabaseDataMaskingPolicy](./Set-AzSqlDatabaseDataMaskingPolicy.md) + +[Set-AzSqlDatabaseDataMaskingRule](./Set-AzSqlDatabaseDataMaskingRule.md) + + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseDataMaskingRule.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseDataMaskingRule.md new file mode 100644 index 0000000000..36914d0147 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseDataMaskingRule.md @@ -0,0 +1,248 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 848A6972-AB29-46FB-8E03-FF2ADB113A0E +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabasedatamaskingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseDataMaskingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseDataMaskingRule.md +--- + +# Get-AzSqlDatabaseDataMaskingRule + +## SYNOPSIS +Gets the data masking rules from a database. + +## SYNTAX + +``` +Get-AzSqlDatabaseDataMaskingRule [-SchemaName <String>] [-TableName <String>] [-ColumnName <String>] + [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseDataMaskingRule** cmdlet gets either a specific data masking rule or all of the data masking rules for an Azure SQL database. +To use the cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database, and the *RuleId* parameter to specify which rule this cmdlet returns. +If you do not provide *RuleId*, all the data masking rules for that Azure SQL database are returned. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Get all data masking rules from a database +```powershell +Get-AzSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +```output +DatabaseName : database01 +ResourceGroupName : resourcegroup01 +ServerName : server01 +SchemaName : dbo +TableName : table1 +ColumnName : column1 +MaskingFunction : Default +PrefixSize : +SuffixSize : +ReplacementString : +NumberFrom : +NumberTo : + +DatabaseName : database01 +ResourceGroupName : resourcegroup01 +ServerName : server01 +SchemaName : dbo +TableName : table2 +ColumnName : column2 +MaskingFunction : Default +PrefixSize : +SuffixSize : +ReplacementString : +NumberFrom : +NumberTo : +``` + +### Example 2: Get the data masking rule defined on schema "dbo", table "table1" and column "column1". +```powershell +Get-AzSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SchemaName "dbo" -TableName "table1" -ColumnName "column1" +``` + +```output +DatabaseName : database01 +ResourceGroupName : resourcegroup01 +ServerName : server01 +SchemaName : dbo +TableName : table1 +ColumnName : column1 +MaskingFunction : Default +PrefixSize : +SuffixSize : +ReplacementString : +NumberFrom : +NumberTo : +``` + +## PARAMETERS + +### -ColumnName +Specifies the name of the column targeted by the masking rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Specifies the name of a schema. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Specifies the name of an Azure SQL table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataMasking.Model.DatabaseDataMaskingRuleModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseDataMaskingPolicy](./Get-AzSqlDatabaseDataMaskingPolicy.md) + +[New-AzSqlDatabaseDataMaskingRule](./New-AzSqlDatabaseDataMaskingRule.md) + +[Remove-AzSqlDatabaseDataMaskingRule](./Remove-AzSqlDatabaseDataMaskingRule.md) + +[Set-AzSqlDatabaseDataMaskingPolicy](./Set-AzSqlDatabaseDataMaskingPolicy.md) + +[Set-AzSqlDatabaseDataMaskingRule](./Set-AzSqlDatabaseDataMaskingRule.md) + + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseExpanded.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseExpanded.md new file mode 100644 index 0000000000..9225bc4814 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseExpanded.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 952967EB-AEAD-4597-B837-6669CE73739E +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabaseexpanded +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseExpanded.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseExpanded.md +--- + +# Get-AzSqlDatabaseExpanded + +## SYNOPSIS +Gets a database and its expanded property values. + +## SYNTAX + +``` +Get-AzSqlDatabaseExpanded [-ServerName] <String> [[-DatabaseName] <String>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseExpanded** cmdlet gets a database and its expanded property values. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Get database object that has service tier advisor information +```powershell +Get-AzSqlDatabaseExpanded -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +This command returns the database that has expanded properties that contain the service tier advisor information. + +### Example 2: List database objects using filtering +```powershell +Get-AzSqlDatabaseExpanded -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database*" +``` + +This command returns expanded database object for all databases in Server01 that start with "Database". + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModelExpanded + +## NOTES + +## RELATED LINKS + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseFailoverGroup.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseFailoverGroup.md new file mode 100644 index 0000000000..8d61476235 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseFailoverGroup.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabasefailovergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseFailoverGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseFailoverGroup.md +--- + +# Get-AzSqlDatabaseFailoverGroup + +## SYNOPSIS +Gets or lists Azure SQL Database Failover Groups. + +## SYNTAX + +``` +Get-AzSqlDatabaseFailoverGroup [-ServerName] <String> [[-FailoverGroupName] <String>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a specific Azure SQL Database Failover Group or lists the Failover Groups on a server. +Either server in the Failover Group may be used to execute the command. The returned values will reflect the state of the specified server with respect to the Failover Group. + +## EXAMPLES + +### Example 1 +```powershell +$failoverGroups = Get-AzSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName server +``` + +Lists all Failover Groups on a server. + +### Example 2 +```powershell +$failoverGroup = Get-AzSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName server -FailoverGroupName fg +``` + +Get a specific Failover Group. + +### Example 3 +```powershell +$failoverGroup = Get-AzSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName server -FailoverGroupName fg* +``` + +Get all failover groups in a server that start with "fg". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverGroupName +The name of the Azure SQL Database Failover Group to retrieve. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Database Server from which to retrieve the Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlDatabaseFailoverGroup](./New-AzSqlDatabaseFailoverGroup.md) + +[Set-AzSqlDatabaseFailoverGroup](./Set-AzSqlDatabaseFailoverGroup.md) + +[Add-AzSqlDatabaseToFailoverGroup](./Add-AzSqlDatabaseToFailoverGroup.md) + +[Remove-AzSqlDatabaseFromFailoverGroup](./Remove-AzSqlDatabaseFromFailoverGroup.md) + +[Switch-AzSqlDatabaseFailoverGroup](./Switch-AzSqlDatabaseFailoverGroup.md) + +[Remove-AzSqlDatabaseFailoverGroup](./Remove-AzSqlDatabaseFailoverGroup.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseGeoBackup.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseGeoBackup.md new file mode 100644 index 0000000000..96f10716d1 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseGeoBackup.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 256AA6F4-D856-4713-A0AC-0DA1A145AA5C +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabasegeobackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseGeoBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseGeoBackup.md +--- + +# Get-AzSqlDatabaseGeoBackup + +## SYNOPSIS +Gets a geo-redundant backup of a database. + +## SYNTAX + +``` +Get-AzSqlDatabaseGeoBackup [-ExpandKeyList] [-KeysFilter <String>] [-ServerName] <String> + [[-DatabaseName] <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseGeoBackup** cmdlet gets a specified geo-redundant backup of a SQL database or all available geo-redundant backups on a specified server. +A geo-redundant backup is a restorable resource using data files from a separate geographic location. +You can use Geo-Restore to restore a geo-redundant backup in the event of a regional outage to recover your database to a new region. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Get all geo-redundant backups on a server +```powershell +Get-AzSqlDatabaseGeoBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" +``` + +This command gets all available geo-redundant backups on a specified server. + +### Example 2: Get a specified geo-redundant backup +```powershell +Get-AzSqlDatabaseGeoBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" -DatabaseName "ContosoDatabase" +``` + +This command gets the database geo-redundant backup named ContosoDatabase. + +### Example 3: Get all geo-redundant backups on a server using filtering +```powershell +Get-AzSqlDatabaseGeoBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" -DatabaseName "Contoso*" +``` + +This command gets all available geo-redundant backups on a specified server that start with "Contoso". + +### Example 4: Get a recoverable database with TDE AKV keys on a server using expand keys +```powershell +Get-AzSqlDatabaseGeoBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" -DatabaseName "Contoso" -ExpandKeyList +``` + +This command gets a recoverable database configured with CMK with expand keys on a specified server. This filter when used, shows all AKV keys on a database. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database to get. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandKeyList +Flag to be used to view all the AKV keys in a database. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeysFilter +Timestamp filter to Get AKV keys + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the SQL database server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the backup to restore. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseGeoBackupModel + +## NOTES + +## RELATED LINKS + +[Overview: Cloud business continuity and database disaster recovery with SQL Database](http://go.microsoft.com/fwlink/?LinkId=746881) + +[Recover an Azure SQL Database from an outage](http://go.microsoft.com/fwlink/?LinkId=746882) + +[Restore-AzSqlDatabase](./Restore-AzSqlDatabase.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseGeoBackupPolicy.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseGeoBackupPolicy.md new file mode 100644 index 0000000000..2b99071bf5 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseGeoBackupPolicy.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 4F28BA63-23FC-4E35-A7FB-726E6FE94D26 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabasegeobackuppolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseGeoBackupPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseGeoBackupPolicy.md +--- + +# Get-AzSqlDatabaseGeoBackupPolicy + +## SYNOPSIS +Gets a database geo backup policy. + +## SYNTAX + +``` +Get-AzSqlDatabaseGeoBackupPolicy [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseGeoBackupPolicy** cmdlet gets the geo backup policy registered to this database. +This is an Azure Backup resource that is used to define backup storage policy. + +## EXAMPLES + +### Example 1 + +Gets a database geo backup policy. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzSqlDatabaseGeoBackupPolicy -DatabaseName db1 -ResourceGroupName MyResourceGroup -ServerName s1 +``` + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database for which this cmdlet gets the geo backup policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the server that contains this database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseGeoBackupPolicyModel + +## NOTES + +## RELATED LINKS + +[Set-AzSqlDatabaseGeoBackupPolicy](./Set-AzSqlDatabaseGeoBackupPolicy.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseImportExportStatus.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseImportExportStatus.md new file mode 100644 index 0000000000..82c328364c --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseImportExportStatus.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 5D4F13F9-57E7-446B-AA28-8C44B149E1CB +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabaseimportexportstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseImportExportStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseImportExportStatus.md +--- + +# Get-AzSqlDatabaseImportExportStatus + +## SYNOPSIS +Gets the details of an import or export of an Azure SQL Database. + +## SYNTAX + +``` +Get-AzSqlDatabaseImportExportStatus [-OperationStatusLink] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseImportExportStatus** cmdlet gets details of a bacpac file import from a storage account to an Azure SQL Database or an export of an Azure SQL Database as a bacpac file to a storage account. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Get the import and export status of a SQL database +```powershell +Get-AzSqlDatabaseImportExportStatus -OperationStatusLink "https://management.contoso.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resource01/providers/Microsoft.Sql/servers/server01/databases/database01/importExportOperationResults/00000000-000-0000-0000-000000000000?api-version=2014-04-01" +``` + +```output +OperationStatusLink : +ErrorMessage : +LastModifiedTime : 4/15/2016 10:16:14 PM +QueuedTime : 4/15/2016 10:16:13 PM +StatusMessage : Running, Progress = 5.00 % +Status : InProgress +``` + +This command gets the status of an import or export request for a database at the specified URL. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationStatusLink +Specifies the status link that is returned from the New-AzSqlDatabaseExport or New-AzSqlDatabaseImport cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ImportExport.Model.AzureSqlDatabaseImportExportStatusModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + +## RELATED LINKS + +[New-AzSqlDatabaseExport](./New-AzSqlDatabaseExport.md) + +[New-AzSqlDatabaseImport](./New-AzSqlDatabaseImport.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseIndexRecommendation.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseIndexRecommendation.md new file mode 100644 index 0000000000..e66bab45ec --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseIndexRecommendation.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 10656EA5-EA5F-4394-951F-BC64BE3BF6F9 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabaseindexrecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseIndexRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseIndexRecommendation.md +--- + +# Get-AzSqlDatabaseIndexRecommendation + +## SYNOPSIS +Gets the recommended index operations for a server or database. + +## SYNTAX + +``` +Get-AzSqlDatabaseIndexRecommendation -ServerName <String> [-DatabaseName <String>] [-TableName <String>] + [-IndexRecommendationName <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseIndexRecommendation** cmdlet gets the recommended index operations for an Azure SQL Database server or database. + +## EXAMPLES + +### Example 1: Get index recommendations for all databases on server +```powershell +Get-AzSqlDatabaseIndexRecommendation -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +This command returns index recommendations for all databases on server server01. + +### Example 2: Get index recommendations for a specific database +```powershell +Get-AzSqlDatabaseIndexRecommendation -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +This command returns index recommendations for specific database. + +### Example 3: Get a single index recommendation by name +```powershell +Get-AzSqlDatabaseIndexRecommendation -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -IndexRecommendationName "INDEX_NAME" +``` + +This command returns single index recommendation by name. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database for which this cmdlet gets index recommendations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IndexRecommendationName +Specifies the name of the index recommendation that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the server is assigned for. +This cmdlet gets index recommendations for a database hosted by this server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the server that hosts the database for which this cmdlet gets index recommendations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Specifies the name of an Azure SQL table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Model.IndexRecommendation + +## NOTES + +## RELATED LINKS + +[Start-AzSqlDatabaseExecuteIndexRecommendation](./Start-AzSqlDatabaseExecuteIndexRecommendation.md) + +[Stop-AzSqlDatabaseExecuteIndexRecommendation](./Stop-AzSqlDatabaseExecuteIndexRecommendation.md) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseInstanceFailoverGroup.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseInstanceFailoverGroup.md new file mode 100644 index 0000000000..ad88631baa --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseInstanceFailoverGroup.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabaseinstancefailovergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseInstanceFailoverGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseInstanceFailoverGroup.md +--- + +# Get-AzSqlDatabaseInstanceFailoverGroup + +## SYNOPSIS +Gets or lists Instance Failover Groups. + +## SYNTAX + +``` +Get-AzSqlDatabaseInstanceFailoverGroup [[-Name] <String>] [-ResourceGroupName] <String> [-Location] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a specific Instance Failover Group or lists the Instance Failover Groups in a region under the user's subscription. + +Either region in the Instance Failover Group may be used to execute the command. The returned values will reflect the state of the Managed Instances in that region with respect to the Instance Failover Group. + +## EXAMPLES + +### Example 1 +```powershell +$failoverGroups = Get-AzSqlDatabaseInstanceFailoverGroup -ResourceGroupName rg -Location location +``` + +```output +{ + ResourceGroupName : rg + Location : East US + Name : fg + PartnerResourceGroupName : rg + PartnerRegion : West US + PrimaryManagedInstanceName : managedInstance1 + PartnerManagedInstanceName : managedInstance2 + ReplicationRole : Primary + ReplicationState : CATCH_UP + ReadWriteFailoverPolicy : Automatic + FailoverWithDataLossGracePeriodHours : 1 + ReadOnlyFailoverPolicy : Disabled + Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rg/providers/Microsoft.Sql/locations/eastus/instanceFailoverGroups/fg +} +``` + +Lists all Failover Groups in the region + +### Example 2 +```powershell +$failoverGroup = Get-AzSqlDatabaseInstanceFailoverGroup -ResourceGroupName rg -Location location -Name fg +``` + +```output +ResourceGroupName : rg +Location : East US +Name : fg +PartnerResourceGroupName : rg +PartnerRegion : West US +PrimaryManagedInstanceName : managedInstance1 +PartnerManagedInstanceName : managedInstance2 +ReplicationRole : Primary +ReplicationState : CATCH_UP +ReadWriteFailoverPolicy : Automatic +FailoverWithDataLossGracePeriodHours : 1 +ReadOnlyFailoverPolicy : Disabled +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rg/providers/Microsoft.Sql/locations/eastus/instanceFailoverGroups/fg +``` + +Get a specific Instance Failover Group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The name of the Local Region from which to retrieve the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Instance Failover Group to retrieve. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.InstanceFailoverGroup.Model.AzureSqlInstanceFailoverGroupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseLedgerDigestUpload.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseLedgerDigestUpload.md new file mode 100644 index 0000000000..1d7365aa4a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseLedgerDigestUpload.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabaseledgerdigestupload +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseLedgerDigestUpload.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseLedgerDigestUpload.md +--- + +# Get-AzSqlDatabaseLedgerDigestUpload + +## SYNOPSIS +Gets the ledger digest upload settings of an Azure SQL database. + +## SYNTAX + +### DatabaseParameterSet (Default) +``` +Get-AzSqlDatabaseLedgerDigestUpload [-ResourceGroupName] <String> [-ServerName] <String> + [-DatabaseName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Get-AzSqlDatabaseLedgerDigestUpload -InputObject <AzureSqlDatabaseModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzSqlDatabaseLedgerDigestUpload [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlDatabaseLedgerDigestUpload cmdlet gets the ledger digest upload settings of the specified Azure SQL database. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlDatabaseLedgerDigestUpload -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +```output +ResourceGroupName ServerName DatabaseName State Endpoint +----------------- ---------- ------------ ----- -------- +ResourceGroup01 Server01 Database01 Enabled https://mystorage.blob.core.windows.net +``` + +## PARAMETERS + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to disable digest uploads for. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the database to disable digest uploads for. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.LedgerDigestUploads.Model.AzureSqlDatabaseLedgerDigestUploadModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseLongTermRetentionBackup.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseLongTermRetentionBackup.md new file mode 100644 index 0000000000..0052384e7e --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseLongTermRetentionBackup.md @@ -0,0 +1,421 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabaselongtermretentionbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseLongTermRetentionBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseLongTermRetentionBackup.md +--- + +# Get-AzSqlDatabaseLongTermRetentionBackup + +## SYNOPSIS +Gets one or more long term retention backups. + +## SYNTAX + +### Location (Default) +``` +Get-AzSqlDatabaseLongTermRetentionBackup [-Location] <String> [-ResourceGroupName <String>] + [-OnlyLatestPerDatabase] [-DatabaseState <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ServerName +``` +Get-AzSqlDatabaseLongTermRetentionBackup [-Location] <String> [-ServerName] <String> [-DatabaseName <String>] + [-ResourceGroupName <String>] [-OnlyLatestPerDatabase] [-DatabaseState <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BackupName +``` +Get-AzSqlDatabaseLongTermRetentionBackup [-Location] <String> [-ServerName] <String> -DatabaseName <String> + [-BackupName] <String> [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### GetBackupByResourceId +``` +Get-AzSqlDatabaseLongTermRetentionBackup [-Location] <String> [-ResourceId] <String> [-BackupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GetBackupsByResourceId +``` +Get-AzSqlDatabaseLongTermRetentionBackup [-Location] <String> [-ResourceId] <String> [-OnlyLatestPerDatabase] + [-DatabaseState <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GetBackupByInputObject +``` +Get-AzSqlDatabaseLongTermRetentionBackup [-InputObject] <AzureSqlDatabaseModel> [-BackupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GetBackupsByInputObject +``` +Get-AzSqlDatabaseLongTermRetentionBackup [-InputObject] <AzureSqlDatabaseModel> [-OnlyLatestPerDatabase] + [-DatabaseState <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseLongTermRetentionBackup** cmdlet gets all long term retention backups for a location, server, or database or gets a specific long term retention backup. + +## EXAMPLES + +### Example 1: Get all backups for a location +```powershell +Get-AzSqlDatabaseLongTermRetentionBackup -Location northeurope +``` + +```output +BackupExpirationTime : 3/22/2018 5:50:55 AM +BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +BackupTime : 3/15/2018 5:50:55 AM +DatabaseName : database01 +DatabaseDeletionTime : +Location : northeurope +ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +ServerName : server01 +ServerCreateTime : 2/29/2018 12:12:19 AM +ResourceGroupName : +BackupStorageRedundancy : Geo + +BackupExpirationTime : 3/22/2018 11:43:18 PM +BackupName : 55970792-164c-4a4a-88e5-7158d092d503;131656309980000000 +BackupTime : 3/15/2018 11:43:18 PM +DatabaseName : database02 +DatabaseDeletionTime : 3/18/2018 4:36:00 PM +Location : northeurope +ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server02/longTermRetentionDatabases/database02/longTermRetentionBackups/55970792-164c-4a4a-88e5-7158d092d503;131656309980000000 +ServerName : server02 +ServerCreateTime : 2/28/2018 12:12:19 AM +ResourceGroupName : +BackupStorageRedundancy : Geo +``` + +This command gets all long term retention backups for all databases (which may be alive or deleted) in southeastasia, resource group will be set only if server is live. + +### Example 2: Get all backups for a location under a resource group +```powershell +Get-AzSqlDatabaseLongTermRetentionBackup -Location northeurope -ResourceGroupName resourceGroup01 +``` + +```output +BackupExpirationTime : 3/22/2018 5:50:55 AM +BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +BackupTime : 3/15/2018 5:50:55 AM +DatabaseName : database01 +DatabaseDeletionTime : +Location : northeurope +ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +ServerName : server01 +ServerCreateTime : 2/29/2018 12:12:19 AM +ResourceGroupName : resourceGroup01 +BackupStorageRedundancy : Geo +``` + +This command gets all long term retention backups for all databases (which may be alive or deleted) under a resource group in northeurope. + +### Example 3: Get a specific long term retention backup +```powershell +Get-AzSqlDatabaseLongTermRetentionBackup -Location northeurope -ServerName server01 -DatabaseName database01 -BackupName "601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000" +``` + +```output +BackupExpirationTime : 3/22/2018 5:50:55 AM +BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +BackupTime : 3/15/2018 5:50:55 AM +DatabaseName : database01 +DatabaseDeletionTime : +Location : northeurope +ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +ServerName : server01 +ServerCreateTime : 2/29/2018 12:12:19 AM +ResourceGroupName : +BackupStorageRedundancy : Geo +``` + +This command gets the backup with name 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 + +### Example 4: Get all long term retention backups for a database +```powershell +Get-AzSqlDatabase -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 | Get-AzSqlDatabaseLongTermRetentionBackup +``` + +```output +BackupExpirationTime : 3/22/2018 5:50:55 AM +BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +BackupTime : 3/15/2018 5:50:55 AM +DatabaseName : database01 +DatabaseDeletionTime : +Location : northeurope +ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +ServerName : server01 +ServerCreateTime : 2/29/2018 12:12:19 AM +ResourceGroupName : +BackupStorageRedundancy : Geo +``` + +This command gets all long term retention backups for database01 + +### Example 5: Get long term retention backups using filtering +```powershell +Get-AzSqlDatabaseLongTermRetentionBackup -Location northeurope -ServerName server01 -DatabaseName database01 -BackupName "601061b7*" +``` + +```output +BackupExpirationTime : 3/22/2018 11:43:18 PM +BackupName : 601061b7-164c-4a4a-88e5-7158d092d503;131656309980000000 +BackupTime : 3/15/2018 11:43:18 PM +DatabaseName : database02 +DatabaseDeletionTime : 3/18/2018 4:36:00 PM +Location : northeurope +ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database02/longTermRetentionBackups/601061b7-164c-4a4a-88e5-7158d092d503;131656309980000000 +ServerName : server01 +ServerCreateTime : 2/28/2018 12:12:19 AM +ResourceGroupName : +BackupStorageRedundancy : Geo + +BackupExpirationTime : 3/22/2018 5:50:55 AM +BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +BackupTime : 3/15/2018 5:50:55 AM +DatabaseName : database01 +DatabaseDeletionTime : +Location : northeurope +ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +ServerName : server01 +ServerCreateTime : 2/29/2018 12:12:19 AM +ResourceGroupName : +BackupStorageRedundancy : Geo +``` + +This command gets all backups with name that starts with "601061b7" + +## PARAMETERS + +### -BackupName +The name of the backup. + +```yaml +Type: System.String +Parameter Sets: BackupName, GetBackupByResourceId, GetBackupByInputObject +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DatabaseName +The name of the Azure SQL Database the backup is from. + +```yaml +Type: System.String +Parameter Sets: ServerName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: BackupName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseState +The state of the database whose backups you want to find, Alive, Deleted, or All. +Defaults to All + +```yaml +Type: System.String +Parameter Sets: Location, ServerName, GetBackupsByResourceId, GetBackupsByInputObject +Aliases: +Accepted values: All, Deleted, Live + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to get backups for. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: GetBackupByInputObject, GetBackupsByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the backups' source server. + +```yaml +Type: System.String +Parameter Sets: Location, ServerName, BackupName, GetBackupByResourceId, GetBackupsByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlyLatestPerDatabase +Whether or not to only get the latest backup per database. +Defaults to false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Location, ServerName, GetBackupsByResourceId, GetBackupsByInputObject +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Location, ServerName, BackupName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The database Resource ID to get backups for. + +```yaml +Type: System.String +Parameter Sets: GetBackupByResourceId, GetBackupsByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the backups are under. + +```yaml +Type: System.String +Parameter Sets: ServerName, BackupName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseLongTermRetentionBackupModel + +## NOTES + +## RELATED LINKS + +[Update-AzSqlDatabaseLongTermRetentionBackup](./Update-AzSqlDatabaseLongTermRetentionBackup.md) + +[Copy-AzSqlDatabaseLongTermRetentionBackup](./Copy-AzSqlDatabaseLongTermRetentionBackup.md) + +[Remove-AzSqlDatabaseLongTermRetentionBackup](./Remove-AzSqlDatabaseLongTermRetentionBackup.md) + +[Get-AzSqlDatabaseBackupLongTermRetentionPolicy](./Get-AzSqlDatabaseBackupLongTermRetentionPolicy.md) + +[Set-AzSqlDatabaseBackupLongTermRetentionPolicy](./Set-AzSqlDatabaseBackupLongTermRetentionPolicy.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseRecommendedAction.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseRecommendedAction.md new file mode 100644 index 0000000000..1a796db97a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseRecommendedAction.md @@ -0,0 +1,280 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: EF6C862B-A89C-48AB-A590-92CFA387305F +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabaserecommendedaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseRecommendedAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseRecommendedAction.md +--- + +# Get-AzSqlDatabaseRecommendedAction + +## SYNOPSIS +Gets one or more recommended actions for an Azure SQL Database Advisor. + +## SYNTAX + +``` +Get-AzSqlDatabaseRecommendedAction [-RecommendedActionName <String>] -ServerName <String> + -DatabaseName <String> -AdvisorName <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseRecommendedAction** cmdlet gets one or more recommended actions for an Azure SQL Database Advisor. + +## EXAMPLES + +### Example 1: List all the recommended actions for an Advisor +```powershell +Get-AzSqlDatabaseRecommendedAction -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -AdvisorName "CreateIndex" +``` + +```output +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, + NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} +RecommendationReason : +RevertActionDuration : +RevertActionInitiatedBy : +RevertActionInitiatedTime : +RevertActionStartTime : +Score : 2 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM + +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.236046_6C7AE8CC9C87E7FD5893], [indexType, NONCLUSTERED], + [schema, [test_schema]], [table, [test_table_0.236046]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {SpaceChange} +RecommendationReason : +RevertActionDuration : +RevertActionInitiatedBy : +RevertActionInitiatedTime : +RevertActionStartTime : +Score : 3 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.239359_6C7AE8CC9C87E7FD5893], [indexType, NONCLUSTERED], + [schema, [test_schema]], [table, [test_table_0.239359]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} +RecommendationReason : +RevertActionDuration : PT10S +RevertActionInitiatedBy : System +RevertActionInitiatedTime : 4/21/2016 3:24:47 PM +RevertActionStartTime : 4/21/2016 3:24:47 PM +Score : 3 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM +``` + +This command gets a list of all recommended actions of the Advisor named CreateIndex available for the database named wi-runner-australia-east. + +### Example 2: Get a single recommended action for an Advisor +```powershell +Get-AzSqlDatabaseRecommendedAction -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -AdvisorName "CreateIndex" -RecommendedActionName "IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893" +``` + +```output +DatabaseName : WIRunner +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, + NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} +RecommendationReason : +RevertActionDuration : +RevertActionInitiatedBy : +RevertActionInitiatedTime : +RevertActionStartTime : +Score : 2 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM +``` + +This command gets the recommended action named IR_\[test_schema\]_\[test_table_0.0361551\]_6C7AE8CC9C87E7FD5893 for the Advisor named CreateIndex. + +## PARAMETERS + +### -AdvisorName +Specifies the name of the Advisor for which this cmdlet requests recommended actions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database for which this cmdlet requests recommended actions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecommendedActionName +Specifies the name of the recommended action that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies name of the resource group of the server that contains this database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server the database is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.RecommendedAction.Model.AzureSqlDatabaseRecommendedActionModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql, advisor, recommendedaction + +## RELATED LINKS + +[Get-AzSqlDatabaseAdvisor](./Get-AzSqlDatabaseAdvisor.md) + +[Get-AzSqlServerRecommendedAction](./Get-AzSqlServerRecommendedAction.md) + +[Set-AzSqlDatabaseRecommendedActionState](./Set-AzSqlDatabaseRecommendedActionState.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseReplicationLink.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseReplicationLink.md new file mode 100644 index 0000000000..00fd65d706 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseReplicationLink.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 40054224-52FF-4AF6-A090-9F6D07A2BA99 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabasereplicationlink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseReplicationLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseReplicationLink.md +--- + +# Get-AzSqlDatabaseReplicationLink + +## SYNOPSIS +Gets the geo-replication links between an Azure SQL Database and a resource group or SQL Server. + +## SYNTAX + +``` +Get-AzSqlDatabaseReplicationLink [-DatabaseName] <String> -PartnerResourceGroupName <String> + [-PartnerServerName <String>] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseReplicationLink** cmdlet replaces the **Get-AzSqlDatabaseCopy** cmdlet. +It gets all geo-replication links between the specified Azure SQL Database and a resource group or AzureSQL Server. + +## EXAMPLES + +### Example 1 + +Gets the geo-replication links between an Azure SQL Database and a resource group or SQL Server. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzSqlDatabaseReplicationLink -DatabaseName db1 -PartnerResourceGroupName rg2 -ResourceGroupName MyResourceGroup -ServerName s1 +``` + +## PARAMETERS + +### -DatabaseName +Specifies the name of the SQL Database for which to retrieve links. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerResourceGroupName +Specifies the name of the resource group to which the partner is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerServerName +Specifies the name of the Azure SQL Server for the partner. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the Azure resource group for the database for which to retrieve links. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL Server for the database to retrieve links for. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Replication.Model.AzureReplicationLinkModel + +## NOTES + +## RELATED LINKS + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseRestorePoint.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseRestorePoint.md new file mode 100644 index 0000000000..0ee9e349d4 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseRestorePoint.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 67A9BB67-CF17-4CAA-99D9-002D0D23178B +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabaserestorepoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseRestorePoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseRestorePoint.md +--- + +# Get-AzSqlDatabaseRestorePoint + +## SYNOPSIS +Retrieves the distinct restore points from which a SQL Data Warehouse can be restored. + +## SYNTAX + +``` +Get-AzSqlDatabaseRestorePoint [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseRestorePoint** cmdlet retrieves the distinct restore points that an Azure SQL Data Warehouse can be restored from. +For an Azure SQL Database, the restore window is continuous. +This means that any point in time in the backup retention period of the database can be used as a restore point. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Get all restore points +```powershell +Get-AzSqlDatabaseRestorePoint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database01 +Location : Central US +RestorePointType : CONTINUOUS +RestorePointCreationDate : +EarliestRestoreDate : 8/12/2015 12:00:00 AM +RestorePointLabel : RestorePoint01 +``` + +This command returns all available restore points for the Azure SQL Database named Database01. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the SQL Database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the AzureSQL Server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseRestorePointModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseSensitivityClassification.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseSensitivityClassification.md new file mode 100644 index 0000000000..0e6ea1bdb3 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseSensitivityClassification.md @@ -0,0 +1,299 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabasesensitivityclassification +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseSensitivityClassification.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseSensitivityClassification.md +--- + +# Get-AzSqlDatabaseSensitivityClassification + +## SYNOPSIS +Gets the current information types and sensitivity labels of columns in the database. + +## SYNTAX + +### DatabaseObjectParameterSet (Default) +``` +Get-AzSqlDatabaseSensitivityClassification -DatabaseObject <AzureSqlDatabaseModel> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DatabaseParameterSet +``` +Get-AzSqlDatabaseSensitivityClassification [-ResourceGroupName] <String> [-ServerName] <String> + [-DatabaseName] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Get-AzSqlDatabaseSensitivityClassification [-ResourceGroupName] <String> [-ServerName] <String> + [-DatabaseName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DatabaseObjectColumnParameterSet +``` +Get-AzSqlDatabaseSensitivityClassification -DatabaseObject <AzureSqlDatabaseModel> -SchemaName <String> + -TableName <String> -ColumnName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlDatabaseSensitivityClassification cmdlet returns the current information types and sensitivity labels of columns in the Azure SQL database. + +## EXAMPLES + +### Example 1: Get current information types and sensitivity labels of an Azure SQL Database. +```powershell +Get-AzSqlDatabaseSensitivityClassification -ResourceGroupName resourceGroup -ServerName server -DatabaseName database +``` + +```output +ResourceGroupName : resourceGroup +ServerName : server +DatabaseName : database +SensitivityLabels : {{ + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailBody, + InformationType: Contact Info + }, { + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailSubject, + SensitivityLabel: Confidential, + Rank: Medium + }, { + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +### Example 2: Get current information types and sensitivity labels of an Azure SQL Database with Piping. +```powershell +Get-AzSqlDatabase -ResourceGroupName resourceGroup -ServerName server -DatabaseName database | Get-AzSqlDatabaseSensitivityClassification +``` + +```output +ResourceGroupName : resourceGroup +ServerName : server +DatabaseName : database +SensitivityLabels : {{ + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailBody, + InformationType: Contact Info + }, { + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailSubject, + SensitivityLabel: Confidential, + Rank: Medium + }, { + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +### Example 3: Get current information type and sensitivity label of a specific column of an Azure SQL Database. +```powershell +Get-AzSqlDatabaseSensitivityClassification -ResourceGroupName resourceGroup -ServerName server -DatabaseName database -SchemaName dbo -TableName EMailLog -ColumnName BounceEmailSubject +``` + +```output +ResourceGroupName : resourceGroup +ServerName : server +DatabaseName : database +SensitivityLabels : {{ + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +### Example 4: Get current information type and sensitivity label of a specific column of an Azure SQL Database using Piping. +```powershell +Get-AzSqlDatabase -ResourceGroupName resourceGroup -ServerName server -DatabaseName database | Get-AzSqlDatabaseSensitivityClassification -SchemaName dbo -TableName EMailLog -ColumnName BounceEmailSubject +``` + +```output +ResourceGroupName : resourceGroup +ServerName : server +DatabaseName : database +SensitivityLabels : {{ + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL database. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet, ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +The SQL database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: DatabaseObjectParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet, ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet, ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataClassification.Model.SqlDatabaseSensitivityClassificationModel + +## NOTES + +## RELATED LINKS + +[Learn more about Azure SQL Database data discovery and classification](https://learn.microsoft.com/azure/sql-database/sql-database-data-discovery-and-classification) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseSensitivityRecommendation.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseSensitivityRecommendation.md new file mode 100644 index 0000000000..6e53706ac2 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseSensitivityRecommendation.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/Get-AzSqlDatabaseSensitivityRecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseSensitivityRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseSensitivityRecommendation.md +--- + +# Get-AzSqlDatabaseSensitivityRecommendation + +## SYNOPSIS +Gets the recommended information types and sensitivity labels of columns in the database. + +## SYNTAX + +### DatabaseObjectParameterSet (Default) +``` +Get-AzSqlDatabaseSensitivityRecommendation -DatabaseObject <AzureSqlDatabaseModel> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DatabaseParameterSet +``` +Get-AzSqlDatabaseSensitivityRecommendation [-ResourceGroupName] <String> [-ServerName] <String> + [-DatabaseName] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlDatabaseSensitivityRecommendation cmdlet returns the recommended information types and sensitivity labels of columns in the database. + +## EXAMPLES + +### Example 1: Get recommended information types and sensitivity labels of an Azure SQL database. +```powershell +Get-AzSqlDatabaseSensitivityRecommendation -ResourceGroupName resourceGroup -ServerName server -DatabaseName database +``` + +```output +ResourceGroupName : resourceGroup +ServerName : server +DatabaseName : database +SensitivityLabels : {{ + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailBody, + InformationType: Contact Info + }, { + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailSubject, + SensitivityLabel: Confidential, + Rank: Medium + }, { + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +### Example 2: Get recommended information types and sensitivity labels of an Azure SQL database using Piping. +```powershell +Get-AzSqlDatabase -ResourceGroupName resourceGroup -ServerName server -DatabaseName database | Get-AzSqlDatabaseSensitivityRecommendation +``` + +```output +ResourceGroupName : resourceGroup +ServerName : server +DatabaseName : database +SensitivityLabels : {{ + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailBody, + InformationType: Contact Info + }, { + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailSubject, + SensitivityLabel: Confidential, + Rank: Medium + }, { + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL database. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +The SQL database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: DatabaseObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataClassification.Model.SqlDatabaseSensitivityClassificationModel + +## NOTES + +## RELATED LINKS + +[Learn more about Azure SQL Database data discovery and classification](https://learn.microsoft.com/azure/sql-database/sql-database-data-discovery-and-classification) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseTransparentDataEncryption.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseTransparentDataEncryption.md new file mode 100644 index 0000000000..cab028307a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseTransparentDataEncryption.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 2328631F-BC30-40E3-ADF7-B1D3B46A6E34 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabasetransparentdataencryption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseTransparentDataEncryption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseTransparentDataEncryption.md +--- + +# Get-AzSqlDatabaseTransparentDataEncryption + +## SYNOPSIS +Gets the TDE state for a database. + +## SYNTAX + +``` +Get-AzSqlDatabaseTransparentDataEncryption [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseTransparentDataEncryption** cmdlet gets the state of Transparent Data Encryption (TDE) for an Azure SQL database. +For more information, see Transparent Data Encryption with Azure SQL Databasehttps://msdn.microsoft.com/library/dn948096 (https://msdn.microsoft.com/library/dn948096) in the Microsoft Developer Network Library. +This cmdlet gets the current state of TDE, but both encryption and decryption can be long-running operations. +To see the encryption scan progress, run the Get-AzSqlDatabaseTransparentDataEncryptionActivity cmdlet. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Get TDE status for a database +```powershell +Get-AzSqlDatabaseTransparentDataEncryption -ServerName "server01" -ResourceGroupName "resourcegroup01" -DatabaseName "database01" +``` + +```output +ResourceGroupName ServerName DatabaseName State +----------------- ---------- ------------ ----- +resourcegroup01 server01 database01 Disabled +``` + +This command gets the status of TDE for the database named Database01 on the server named server01. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database for which this cmdlet gets TDE status. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the database for which this cmdlet gets TDE status. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseTransparentDataEncryptionActivity](./Get-AzSqlDatabaseTransparentDataEncryptionActivity.md) + +[Set-AzSqlDatabaseTransparentDataEncryption](./Set-AzSqlDatabaseTransparentDataEncryption.md) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseUpgradeHint.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseUpgradeHint.md new file mode 100644 index 0000000000..1b97a4bf12 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseUpgradeHint.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: D64FB139-04E2-47BC-86FB-EEEA23839F2F +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabaseupgradehint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseUpgradeHint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseUpgradeHint.md +--- + +# Get-AzSqlDatabaseUpgradeHint + +## SYNOPSIS +Gets pricing tier hints for a database. + +## SYNTAX + +``` +Get-AzSqlDatabaseUpgradeHint [-ServerName] <String> [-DatabaseName <String>] + [-ExcludeElasticPoolCandidates <Boolean>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseUpgradeHint** cmdlet gets pricing tier hints for upgrading an Azure SQL Database. +Databases that are still in Web and Business pricing tiers get the hint to upgrade to the new Basic, Standard, or Premium pricing tiers. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Get recommendations for all databases on a server +```powershell +Get-AzSqlDatabaseUpgradeHint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +This command returns upgrade hints for all databases on the server named Server01. + +### Example 2: Get recommendations for specific database +```powershell +Get-AzSqlDatabaseUpgradeHint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +This command returns upgrade hints for a specific database. + +### Example 3: Get recommendation for all databases that are not in an elastic database pool +```powershell +Get-AzSqlDatabaseUpgradeHint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ExcludeElasticPoolCandidates $True +``` + +This command returns upgrade hints for all databases that are not in an elastic database pool. + +### Example 4: Get recommendations for all databases on a server using filtering +```powershell +Get-AzSqlDatabaseUpgradeHint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database*" +``` + +This command returns upgrade hints for all databases on the server named Server01 that start with "Database". + +## PARAMETERS + +### -DatabaseName +Specifies the name of the SQL database for which this cmdlet gets an upgrade hint. +If you do not specify a database, this cmdlet gets hints for all databases on the logical server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeElasticPoolCandidates +Indicates whether databases in elastic database pools are excluded from the returned recommendations. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the database for which this cmdlet gets an upgrade hint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Management.Sql.LegacySdk.Models.RecommendedDatabaseProperties + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseExpanded](./Get-AzSqlDatabaseExpanded.md) + +[Get-AzSqlElasticPoolRecommendation](./Get-AzSqlElasticPoolRecommendation.md) + + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md new file mode 100644 index 0000000000..3952a5ba7e --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabasevulnerabilityassessmentrulebaseline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md +--- + +# Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline + +## SYNOPSIS +Gets the vulnerability assessment rule baseline. + +## SYNTAX + +``` +Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline [-ServerName] <String> [-DatabaseName] <String> + [-InputObject <AzureSqlDatabaseModel>] -RuleId <String> [-RuleAppliesToMaster] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline** cmdlet gets the vulnerability assessment rule baseline. +Note that you need to run *Enable-AzSqlServerAdvancedDataSecurity* and *Update-AzSqlServerVulnerabilityAssessmentSetting* cmdlets as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1: Get the vulnerability assessment rule baseline +```powershell +Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + -RuleId "VA2108" ` + -RuleAppliesToMaster +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +RuleId : VA2108 +RuleAppliesToMaster : True +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +### Example 2: Get the vulnerability assessment rule baseline from a database object +```powershell +Get-AzSqlDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + | Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline ` + -RuleId "VA2108" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +RuleId : VA2108 +RuleAppliesToMaster : False +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +## PARAMETERS + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to get Vulnerability Assessment rule baseline for + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleAppliesToMaster +Specifies that the baseline should apply to the master database. +This is required only when database level settings specify a storage account that is different from the one specified in the server level settings. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleId +The rule ID which identifies the rule to set the baseline results to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentRuleBaselineModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord.md new file mode 100644 index 0000000000..62470df346 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabasevulnerabilityassessmentscanrecord +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord.md +--- + +# Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord + +## SYNOPSIS +Gets all vulnerability assessment scan record(s) associated with a given database. + +## SYNTAX + +``` +Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord [-ServerName] <String> [-DatabaseName] <String> + [-InputObject <AzureSqlDatabaseModel>] [-ScanId <String>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord** cmdlet retrieves all vulnerability assessment scan record(s) associated with a given database. +Note that you need to run *Enable-AzSqlServerAdvancedDataSecurity* and *Update-AzSqlServerVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1: Gets a specific vulnerability assessment scan results identified by the scan ID +```powershell +Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + -ScanId "myScan" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +ScanId : myScan +TriggerType : OnDemand +State : Passed +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/Server01/Database01/scan_myScan/.json +NumberOfFailedSecurityChecks : 0 +``` + +### Example 2: Gets a specific vulnerability assessment scan results identified by the scan ID with database object +```powershell +Get-AzSqlDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + | Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord ` + -ScanId "myScan" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +ScanId : myScan +TriggerType : OnDemand +State : Passed +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/Server01/Database01/scan_myScan/.json +NumberOfFailedSecurityChecks : 0 +``` + +### Example 3: Gets all vulnerability assessment scan results on the specified database +```powershell +Get-AzSqlDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + | Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +ScanId : myScan +TriggerType : OnDemand +State : Passed +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/Server01/Database01/scan_myScan/.json +NumberOfFailedSecurityChecks : 0 + + +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +ScanId : myScan1 +TriggerType : OnDemand +State : Passed +StartTime : 6/12/2018 1:57:27 PM +EndTime : 6/12/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/Server01/Database01/scan_myScan/.json +NumberOfFailedSecurityChecks : 0 +``` + +## PARAMETERS + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to get Vulnerability Assessment scan record for + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScanId +Specifies the scan ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentScanRecordModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..224bcd29e3 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDatabaseVulnerabilityAssessmentSetting.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldatabasevulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseVulnerabilityAssessmentSetting.md +--- + +# Get-AzSqlDatabaseVulnerabilityAssessmentSetting + +## SYNOPSIS +Gets the vulnerability assessment settings of a database. + +## SYNTAX + +``` +Get-AzSqlDatabaseVulnerabilityAssessmentSetting [-ServerName] <String> [-DatabaseName] <String> + [-InputObject <AzureSqlDatabaseModel>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDatabaseVulnerabilityAssessmentSetting** cmdlet gets the vulnerability assessment settings of an Azure SQL Database. +Note that you need to run *Enable-AzSqlServerAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1: Get the vulnerability assessment settings of an Azure SQL database +```powershell +Get-AzSqlDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : None +EmailSubscriptionAdmins : False +NotificationEmail : {} +``` + +### Example 2: Get the vulnerability assessment settings of an Azure SQL database from an Azure SQL database object +```powershell +Get-AzSqlDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + | Get-AzSqlDatabaseVulnerabilityAssessmentSetting +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : None +EmailSubscriptionAdmins : False +NotificationEmail : {} +``` + +## PARAMETERS + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to get Vulnerability Assessment settings for + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDeletedDatabaseBackup.md b/azps-10.1.0/Az.Sql/Get-AzSqlDeletedDatabaseBackup.md new file mode 100644 index 0000000000..bfaab26aad --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDeletedDatabaseBackup.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 62B9754D-5EBF-4BEE-B07A-3E508C918F03 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldeleteddatabasebackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDeletedDatabaseBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDeletedDatabaseBackup.md +--- + +# Get-AzSqlDeletedDatabaseBackup + +## SYNOPSIS +Gets a deleted database that you can restore. + +## SYNTAX + +``` +Get-AzSqlDeletedDatabaseBackup [-ExpandKeyList] [-KeysFilter <String>] [-DatabaseId <String>] + [-ServerName] <String> [[-DatabaseName] <String>] [[-DeletionDate] <DateTime>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDeletedDatabaseBackup** cmdlet gets a specified deleted SQL database backup that you can restore, or all deleted backups that you can restore. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Get all deleted database backups on a server +```powershell +Get-AzSqlDeletedDatabaseBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" +``` + +This command gets all deleted database backups on a server. + +### Example 2: Get a specified deleted database backup +```powershell +Get-AzSqlDeletedDatabaseBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" -DatabaseName "ContosoDatabase" +``` + +This command gets the deleted database backup for ContosoDatabase. + +## PARAMETERS + +### -DatabaseId +Id of the database + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletionDate +Specifies the date, as a **DateTime** object, that the database was deleted. +To get a **DateTime** object, use the Get-Date cmdlet. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpandKeyList +Flag to be used to view all the AKV keys in a database. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeysFilter +Timestamp filter to get AKV keys + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the database server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDeletedDatabaseBackupModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabase](./Get-AzSqlDatabase.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlDeletedInstanceDatabaseBackup.md b/azps-10.1.0/Az.Sql/Get-AzSqlDeletedInstanceDatabaseBackup.md new file mode 100644 index 0000000000..5045ca80c4 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlDeletedInstanceDatabaseBackup.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqldeletedinstancedatabasebackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDeletedInstanceDatabaseBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDeletedInstanceDatabaseBackup.md +--- + +# Get-AzSqlDeletedInstanceDatabaseBackup + +## SYNOPSIS +Gets a deleted database that you can restore. + +## SYNTAX + +### DeletedDatabaseList (Default) +``` +Get-AzSqlDeletedInstanceDatabaseBackup [-ResourceGroupName] <String> [-InstanceName] <String> + [-DatabaseName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DeletedDatabaseByNameAndDeletedTime +``` +Get-AzSqlDeletedInstanceDatabaseBackup [-ResourceGroupName] <String> [-InstanceName] <String> + -DatabaseName <String> [-DeletionDate] <DateTime> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlDeletedInstanceDatabaseBackup** cmdlet gets a specified deleted SQL Instance database backup that you can restore, or all deleted backups that you can restore. +This cmdlet is also supported by the SQL Instance Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Get all deleted database backups on a server +```powershell +Get-AzSqlDeletedInstanceDatabaseBackup -ResourceGroupName "ContosoResourceGroup" -InstanceName "ContosoServer" +``` + +```output +DeletionDate : 2019-03-03 12:00:17 AM +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoServer +Name : DB1 +CreationDate : 2019-03-02 11:00:51 PM +EarliestRestorePoint : 2019-03-02 11:05:30 PM +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoResourceGroup/providers/Microsoft. + Sql/managedInstances/ContosoServer/restorableDroppedDatabases/DB1,13196044 + 8170400000 + +DeletionDate : 2019-03-02 11:00:16 PM +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoServer +Name : DB1 +CreationDate : 2019-03-02 10:00:51 PM +EarliestRestorePoint : 2019-03-02 10:05:29 PM +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoResourceGroup/providers/Microsoft. + Sql/managedInstances/ContosoServer/restorableDroppedDatabases/DB1,13196041 + 2168670000 + +DeletionDate : 2019-03-04 04:00:08 AM +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoServer +Name : DB3 +CreationDate : 2019-03-04 03:00:31 AM +EarliestRestorePoint : 2019-03-04 03:05:23 AM +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoResourceGroup/providers/Microsoft. + Sql/managedInstances/ContosoServer/restorableDroppedDatabases/DB3,13196145 + 6082100000 +``` + +This command gets all deleted database backups on a server. + +### Example 2: Get a specified deleted database backup +```powershell +Get-AzSqlDeletedInstanceDatabaseBackup -ResourceGroupName "ContosoResourceGroup" -InstanceName "ContosoServer" -DatabaseName "DB1" +``` + +```output +DeletionDate : 2019-03-03 12:00:17 AM +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoServer +Name : DB1 +CreationDate : 2019-03-02 11:00:51 PM +EarliestRestorePoint : 2019-03-02 11:05:30 PM +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoResourceGroup/providers/Microsoft. + Sql/managedInstances/ContosoServer/restorableDroppedDatabases/DB1,13196044 + 8170400000 + +DeletionDate : 2019-03-02 11:00:16 PM +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoServer +Name : DB1 +CreationDate : 2019-03-02 10:00:51 PM +EarliestRestorePoint : 2019-03-02 10:05:29 PM +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoResourceGroup/providers/Microsoft. + Sql/managedInstances/ContosoServer/restorableDroppedDatabases/DB1,13196041 + 2168670000 +``` + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Instance Database to retrieve backups for. + +```yaml +Type: System.String +Parameter Sets: DeletedDatabaseList +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: DeletedDatabaseByNameAndDeletedTime +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletionDate +The deletion date of the Azure SQL Instance Database to retrieve backups for, with millisecond precision (e.g. 2016-02-23T00:21:22.847Z) + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: DeletedDatabaseByNameAndDeletedTime +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +The name of the Azure SQL Managed Instance the database is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabaseBackup.Model.AzureSqlDeletedManagedDatabaseBackupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticJob.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJob.md new file mode 100644 index 0000000000..77dd396632 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJob.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlelasticjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJob.md +--- + +# Get-AzSqlElasticJob + +## SYNOPSIS +Gets one or more jobs + +## SYNTAX + +### DefaultSet (Default) +``` +Get-AzSqlElasticJob [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ObjectSet +``` +Get-AzSqlElasticJob [-ParentObject] <AzureSqlElasticJobAgentModel> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzSqlElasticJob [-ParentResourceId] <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlElasticJob cmdlet gets one or more jobs + +## EXAMPLES + +### Example 1: Gets a job +```powershell +$agent = Get-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent +$agent | Get-AzSqlElasticJob -Name job1 +``` + +```output +JobName Version Description StartTime EndTime ScheduleType Interval Enabled +------- ------- ----------- --------- ------- ------------ -------- ------- +job1 0 6/1/2018 9:46:29 PM 12/31/9999 11:59:59 AM Once False +``` + +Gets a job + +### Example 2 + +Gets one or more jobs. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzSqlElasticJob -AgentName agent -Name job1 -ResourceGroupName rg -ServerName elasticjobserver +``` + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The job name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: JobName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The agent input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The agent resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobAgent.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobAgent.md new file mode 100644 index 0000000000..5b55c727f7 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobAgent.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/get-Azsqlelasticjobagent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobAgent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobAgent.md +--- + +# Get-AzSqlElasticJobAgent + +## SYNOPSIS +Gets a Azure SQL Elastic Job agent + +## SYNTAX + +### DefaultSet (Default) +``` +Get-AzSqlElasticJobAgent [-ResourceGroupName] <String> [-ServerName] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ObjectSet +``` +Get-AzSqlElasticJobAgent [-ParentObject] <AzureSqlServerModel> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzSqlElasticJobAgent [-ParentResourceId] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlElasticJobAgent cmdlet gets one or more Elastic Job agents + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent +``` + +```output +ResourceGroupName ServerName DatabaseName AgentName State Tags +----------------- ---------- ------------ --------- ----- ---- +rg elasticjobserver jobdb agent Ready +``` + +Gets an Elastic Job agent + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The agent name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AgentName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The server input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The server resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobCredential.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobCredential.md new file mode 100644 index 0000000000..83cea00f93 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobCredential.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/get-Azsqlelasticjobcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobCredential.md +--- + +# Get-AzSqlElasticJobCredential + +## SYNOPSIS +Gets one or more credentials + +## SYNTAX + +### DefaultSet (Default) +``` +Get-AzSqlElasticJobCredential [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ObjectSet +``` +Get-AzSqlElasticJobCredential [-ParentObject] <AzureSqlElasticJobAgentModel> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzSqlElasticJobCredential [-ParentResourceId] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlElasticJobCredential cmdlet gets one or more job credentials + +## EXAMPLES + +### Example 1 +```powershell +$agent = Get-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent +$agent | Get-AzSqlElasticJobCredential -Name cred1 +``` + +```output +CredentialName UserName +-------------- -------- +cred1 user1 +``` + +Gets a job credential + +### Example 2 + +Gets one or more credentials. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Get-AzSqlElasticJobCredential -AgentName agent -ResourceGroupName rg -ServerName elasticjobserver +``` + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The job credential name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CredentialName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The agent object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The agent resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobCredentialModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobExecution.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobExecution.md new file mode 100644 index 0000000000..201fbaed17 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobExecution.md @@ -0,0 +1,336 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/get-Azsqlelasticjobexecution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobExecution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobExecution.md +--- + +# Get-AzSqlElasticJobExecution + +## SYNOPSIS +Gets one or more job executions + +## SYNTAX + +### DefaultSet (Default) +``` +Get-AzSqlElasticJobExecution [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName <String>] [-Count] <Int32> [-CreateTimeMin <DateTime>] [-CreateTimeMax <DateTime>] + [-EndTimeMin <DateTime>] [-EndTimeMax <DateTime>] [-Active] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### WithJobExecutionId +``` +Get-AzSqlElasticJobExecution [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + -JobName <String> -JobExecutionId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ObjectSet +``` +Get-AzSqlElasticJobExecution [-ParentObject] <AzureSqlElasticJobAgentModel> [-JobName <String>] + [-Count] <Int32> [-CreateTimeMin <DateTime>] [-CreateTimeMax <DateTime>] [-EndTimeMin <DateTime>] + [-EndTimeMax <DateTime>] [-Active] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### WithJobExecutionIdUsingParentObject +``` +Get-AzSqlElasticJobExecution [-ParentObject] <AzureSqlElasticJobAgentModel> -JobName <String> + -JobExecutionId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzSqlElasticJobExecution [-ParentResourceId] <String> [-JobName <String>] [-Count] <Int32> + [-CreateTimeMin <DateTime>] [-CreateTimeMax <DateTime>] [-EndTimeMin <DateTime>] [-EndTimeMax <DateTime>] + [-Active] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### WithJobExecutionIdUsingParentResourceId +``` +Get-AzSqlElasticJobExecution [-ParentResourceId] <String> -JobName <String> -JobExecutionId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlElasticJobExecution cmdlet gets one or more job executions + +## EXAMPLES + +### Example 1: Gets one or more job executions across all jobs +```powershell +$agent = Get-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent +$agent | Get-AzSqlElasticJobExecution -Count 3 +``` + +```output +JobName JobExecutionId Lifecycle StartTime EndTime +------- -------------- --------- --------- ------- +job1 dab0ebe8-fd52-42e9-bacf-e5f27577039b Canceled 6/1/2018 10:13:56 PM 6/1/2018 10:13:59 PM +job1 3bcfc912-20b2-411d-a2b7-6265d13fe272 Succeeded 6/1/2018 10:11:43 PM 6/1/2018 10:11:47 PM +job2 433f798e-f35c-41de-a23c-f2b43801d7b4 Succeeded 6/1/2018 10:11:36 PM 6/1/2018 10:11:41 PM +``` + +### Example 2: Gets one or more job executions for a job +```powershell +$agent = Get-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent +$agent | Get-AzSqlElasticJobExecution -Count 3 -JobName job2 +``` + +```output +JobName JobExecutionId Lifecycle StartTime EndTime +------- -------------- --------- --------- ------- +job2 433f798e-f35c-41de-a23c-f2b43801d7b4 Succeeded 6/1/2018 10:11:36 PM 6/1/2018 10:11:41 PM +``` + +Gets one or more job executions + +### Example 3 + +Gets one or more job executions. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Get-AzSqlElasticJobExecution -JobExecutionId 00000000-0000-0000-0000-000000000000 -JobName job1 +``` + +## PARAMETERS + +### -Active +Filter by create time min + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentName +The agent name. + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithJobExecutionId +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +Count returns the top number of executions. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateTimeMax +Filter by create time min + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateTimeMin +Filter by create time min + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTimeMax +Filter by create time min + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTimeMin +Filter by create time min + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobExecutionId +The job execution id. + +```yaml +Type: System.String +Parameter Sets: WithJobExecutionId, WithJobExecutionIdUsingParentObject, WithJobExecutionIdUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The job name. + +```yaml +Type: System.String +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: WithJobExecutionId, WithJobExecutionIdUsingParentObject, WithJobExecutionIdUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The job execution id. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel +Parameter Sets: ObjectSet, WithJobExecutionIdUsingParentObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The agent resource id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet, WithJobExecutionIdUsingParentResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithJobExecutionId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name. + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithJobExecutionId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobExecutionModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobStep.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobStep.md new file mode 100644 index 0000000000..31e4d05c1e --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobStep.md @@ -0,0 +1,259 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/get-Azsqlelasticjobstep +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobStep.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobStep.md +--- + +# Get-AzSqlElasticJobStep + +## SYNOPSIS +Gets one or more job steps + +## SYNTAX + +### DefaultSet (Default) +``` +Get-AzSqlElasticJobStep [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetVersion +``` +Get-AzSqlElasticJobStep [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> -Name <String> -Version <Int32> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ObjectSet +``` +Get-AzSqlElasticJobStep [-ParentObject] <AzureSqlElasticJobModel> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetVersionUsingJobObject +``` +Get-AzSqlElasticJobStep [-ParentObject] <AzureSqlElasticJobModel> -Name <String> -Version <Int32> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzSqlElasticJobStep [-ParentResourceId] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetVersionUsingParentResourceId +``` +Get-AzSqlElasticJobStep [-ParentResourceId] <String> -Name <String> -Version <Int32> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlElasticJobStep cmdlet gets one or more job steps from a job + +## EXAMPLES + +### Example 1: Gets a job step from a job +```powershell +$job = Get-AzSqlElasticJob -ResourceGroupName rg -ServerName elasticjobserver -AgentName agent -Name job1 +$job | Get-AzSqlElasticJobStep -Name step1 +``` + +```output +JobName StepName StepId TargetGroupName CredentialName Output ExecutionOptions CommandText +------- -------- ------ --------------- -------------- ------ ---------------- ----------- +job1 step1 1 tg1 cred1 (43200,10,1,120,2) SELECT 1 +``` + +Gets a job step from a job + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, GetVersion +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The job name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, GetVersion +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The job step name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: StepName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetVersion, GetVersionUsingJobObject, GetVersionUsingParentResourceId +Aliases: StepName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The job input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel +Parameter Sets: ObjectSet, GetVersionUsingJobObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The job resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet, GetVersionUsingParentResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, GetVersion +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, GetVersion +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +The job step name + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: GetVersion +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: GetVersionUsingJobObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: GetVersionUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobStepModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobStepExecution.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobStepExecution.md new file mode 100644 index 0000000000..73a276c565 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobStepExecution.md @@ -0,0 +1,314 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/get-Azsqlelasticjobstepexecution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobStepExecution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobStepExecution.md +--- + +# Get-AzSqlElasticJobStepExecution + +## SYNOPSIS +Gets one or more job step executions + +## SYNTAX + +### DefaultSet (Default) +``` +Get-AzSqlElasticJobStepExecution [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> -JobExecutionId <String> [-CreateTimeMin <DateTime>] [-CreateTimeMax <DateTime>] + [-EndTimeMin <DateTime>] [-EndTimeMax <DateTime>] [-Active] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### WithJobStepName +``` +Get-AzSqlElasticJobStepExecution [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> -JobExecutionId <String> -StepName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ObjectSet +``` +Get-AzSqlElasticJobStepExecution [-ParentObject] <AzureSqlElasticJobExecutionModel> [-CreateTimeMin <DateTime>] + [-CreateTimeMax <DateTime>] [-EndTimeMin <DateTime>] [-EndTimeMax <DateTime>] [-Active] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### WithJobStepNameUsingParentObject +``` +Get-AzSqlElasticJobStepExecution [-ParentObject] <AzureSqlElasticJobExecutionModel> -StepName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzSqlElasticJobStepExecution [-ParentResourceId] <String> [-CreateTimeMin <DateTime>] + [-CreateTimeMax <DateTime>] [-EndTimeMin <DateTime>] [-EndTimeMax <DateTime>] [-Active] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### WithJobStepNameUsingParentResourceId +``` +Get-AzSqlElasticJobStepExecution [-ParentResourceId] <String> -StepName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlElasticJobStepExecution cmdlet gets one or more job step executions from a job execution + +## EXAMPLES + +### Example 1 - Gets one or more job step executions from a job executions +```powershell +$je = Get-AzSqlElasticJobExecution -ResourceGroupName rg -ServerName elasticjobserver -AgentName agent -JobName job1 -JobExecutionId 3bcfc912-20b2-411d-a2b7-6265d13fe272 +$je | Get-AzSqlElasticJobStepExecution +``` + +```output +JobName JobVersion StepName StepId JobExecutionId Lifecycle StartTime EndTime +------- ---------- -------- ------ -------------- --------- --------- ------- +job1 1 step1 1 3bcfc912-20b2-411d-a2b7-6265d13fe272 Succeeded 6/1/2018 10:11:44 PM 6/1/2018 10:11:47 PM +``` + +### Example 2 - Gets one or more job step executions from a job execution, filtering by step name +```powershell +$je = Get-AzSqlElasticJobExecution -ResourceGroupName rg -ServerName elasticjobserver -AgentName agent -JobName job1 -JobExecutionId 3bcfc912-20b2-411d-a2b7-6265d13fe272 +$je | Get-AzSqlElasticJobStepExecution -StepName step1 +``` + +```output +JobName JobVersion StepName StepId JobExecutionId Lifecycle StartTime EndTime +------- ---------- -------- ------ -------------- --------- --------- ------- +job1 1 step1 1 3bcfc912-20b2-411d-a2b7-6265d13fe272 Succeeded 6/1/2018 10:11:44 PM 6/1/2018 10:11:47 PM +``` + +Gets one or more job step executions + +## PARAMETERS + +### -Active +Flag to filter by active executions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentName +The agent name. + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithJobStepName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateTimeMax +Filter by create time max + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateTimeMin +Filter by create time min + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTimeMax +Filter by end time max. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTimeMin +Filter by end time min. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobExecutionId +The job execution id. + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithJobStepName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The job name. + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithJobStepName +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The agent object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobExecutionModel +Parameter Sets: ObjectSet, WithJobStepNameUsingParentObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The job execution resource id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet, WithJobStepNameUsingParentResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithJobStepName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name. + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithJobStepName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StepName +The job step name. + +```yaml +Type: System.String +Parameter Sets: WithJobStepName, WithJobStepNameUsingParentObject, WithJobStepNameUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobExecutionModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobExecutionModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobTargetExecution.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobTargetExecution.md new file mode 100644 index 0000000000..55d0b2eaa1 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobTargetExecution.md @@ -0,0 +1,311 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/get-Azsqlelasticjobtargetexecution +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobTargetExecution.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobTargetExecution.md +--- + +# Get-AzSqlElasticJobTargetExecution + +## SYNOPSIS +Gets one or more job target executions + +## SYNTAX + +### DefaultSet (Default) +``` +Get-AzSqlElasticJobTargetExecution [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> -JobExecutionId <String> -Count <Int32> [-StepName <String>] [-CreateTimeMin <DateTime>] + [-CreateTimeMax <DateTime>] [-EndTimeMin <DateTime>] [-EndTimeMax <DateTime>] [-Active] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ObjectSet +``` +Get-AzSqlElasticJobTargetExecution [-ParentObject] <AzureSqlElasticJobExecutionModel> -Count <Int32> + [-StepName <String>] [-CreateTimeMin <DateTime>] [-CreateTimeMax <DateTime>] [-EndTimeMin <DateTime>] + [-EndTimeMax <DateTime>] [-Active] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzSqlElasticJobTargetExecution [-ParentResourceId] <String> -Count <Int32> [-StepName <String>] + [-CreateTimeMin <DateTime>] [-CreateTimeMax <DateTime>] [-EndTimeMin <DateTime>] [-EndTimeMax <DateTime>] + [-Active] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlElasticJobTargetExecution cmdlet gets one or more job target executions from a job execution + +## EXAMPLES + +### Example 1: Gets one or more job target executions from a job executions +```powershell +$je = Get-AzSqlElasticJobExecution -ResourceGroupName rg -ServerName elasticjobserver -AgentName agent -JobName job1 -JobExecutionId 3bcfc912-20b2-411d-a2b7-6265d13fe272 +$je | Get-AzSqlElasticJobTargetExecution -Count 2 +``` + +```output +JobName JobVersion StepName StepId JobExecutionId Lifecycle TargetServerName TargetDatabaseName StartTime EndTime +------- ---------- -------- ------ -------------- --------- ---------------- ------------------ --------- ------- +job1 1 step2 1 ea0a870b-dfe3-427e-9f95-d229d7815b65 Succeeded s1 db2 6/1/2018 10:11:47 PM 6/1/2018 10:11:50 PM +job1 1 step1 1 ea0a870b-dfe3-427e-9f95-d229d7815b65 Succeeded s1 db1 6/1/2018 10:11:44 PM 6/1/2018 10:11:47 PM +``` + +### Example 2: Gets one or more job target executions from a job executions - filtering by step name +```powershell +$je = Get-AzSqlElasticJobExecution -ResourceGroupName rg -ServerName elasticjobserver -AgentName agent -JobName job1 -JobExecutionId 3bcfc912-20b2-411d-a2b7-6265d13fe272 +$je | Get-AzSqlElasticJobTargetExecution -Count 2 -StepName step2 +``` + +```output +JobName JobVersion StepName StepId JobExecutionId Lifecycle TargetServerName TargetDatabaseName StartTime EndTime +------- ---------- -------- ------ -------------- --------- ---------------- ------------------ --------- ------- +job1 1 step2 1 ea0a870b-dfe3-427e-9f95-d229d7815b65 Succeeded s1 db2 6/1/2018 10:11:47 PM 6/1/2018 10:11:50 PM +``` + +Gets one or more job target executions + +## PARAMETERS + +### -Active +Flag to filter by active executions. + +```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 +``` + +### -AgentName +The agent name. + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +Count returns the top number of executions. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateTimeMax +Filter by create time max + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateTimeMin +Filter by create time min + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTimeMax +Filter by end time max. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTimeMin +Filter by end time min. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobExecutionId +The job execution id. + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The job name. + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The job execution object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobExecutionModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The job execution resource id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name. + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StepName +The job step name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobExecutionModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobExecutionModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobTargetGroup.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobTargetGroup.md new file mode 100644 index 0000000000..6136b85532 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticJobTargetGroup.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/get-Azsqlelasticjobtargetgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobTargetGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticJobTargetGroup.md +--- + +# Get-AzSqlElasticJobTargetGroup + +## SYNOPSIS +Gets one or more job target groups + +## SYNTAX + +### DefaultSet (Default) +``` +Get-AzSqlElasticJobTargetGroup [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ObjectSet +``` +Get-AzSqlElasticJobTargetGroup [-ParentObject] <AzureSqlElasticJobAgentModel> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzSqlElasticJobTargetGroup [-ParentResourceId] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlElasticJobTargetGroup cmdlet gets a target group and it's targets + +## EXAMPLES + +### Example 1 +```powershell +$agent = Get-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent +$agent | Get-AzSqlElasticJobTargetGroup -Name tg1 +``` + +```output +TargetGroupName Targets +--------------- ------- +tg1 (s1,db1) +``` + +Gets a target group and it's targets + +### Example 2 + +Gets one or more job target groups. (autogenerated) + +<!-- Aladdin Generated Example --> + +```powershell +Get-AzSqlElasticJobTargetGroup -AgentName agent -Name tg1 -ResourceGroupName rg -ServerName elasticjobserver +``` + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The target group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TargetGroupName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The agent object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The agent resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobTargetGroupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticPool.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticPool.md new file mode 100644 index 0000000000..e1eb3b61a5 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticPool.md @@ -0,0 +1,298 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 350E19F6-5B1C-4D3F-B4CD-7225CDC984C4 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlelasticpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticPool.md +--- + +# Get-AzSqlElasticPool + +## SYNOPSIS +Gets elastic pools and their property values in an Azure SQL Database. + +## SYNTAX + +``` +Get-AzSqlElasticPool [[-ElasticPoolName] <String>] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlElasticPool** cmdlet gets elastic pools and their property values. +Specify the name of an existing elastic pool to see the property values for only that pool. + +## EXAMPLES + +### Example 1: Get all elastic pools +```powershell +Get-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +```output +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 +ResourceGroupName : resourcegroup01 +ServerName : server01 +ElasticPoolName : elasticpool01 +Location : Central US +CreationDate : 8/26/2015 10:00:17 PM +State : Ready +Edition : Standard +Dtu : 400 +DatabaseDtuMax : 100 +DatabaseDtuMin : 10 +StorageMB : 409600 +Tags : + +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool02 +ResourceGroupName : resourcegroup01 +ServerName : server01 +ElasticPoolName : elasticpool02 +Location : Central US +CreationDate : 8/26/2015 11:00:17 PM +State : Ready +Edition : Standard +Dtu : 400 +DatabaseDtuMax : 100 +DatabaseDtuMin : 10 +StorageMB : 409600 +Tags : +``` + +This command gets all of the elastic pools on the server named Server01. + +### Example 2: Get a specific elastic pool +```powershell +Get-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool27" +``` + +```output +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 +ResourceGroupName : resourcegroup01 +ServerName : server01 +ElasticPoolName : elasticpool01 +Location : Central US +CreationDate : 8/26/2015 10:00:17 PM +State : Ready +Edition : Standard +Dtu : 400 +DatabaseDtuMax : 100 +DatabaseDtuMin : 10 +StorageMB : 409600 +Tags : +``` + +This command gets the elastic pool named ElasticPool0127 on the server named Server01. + +### Example 3: Get metrics for a Azure SQL Elastic Database Pool +```powershell +Get-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" | Get-AzMetric -TimeGrain 0:5:0 -MetricName storage_percent +``` + +```output +DimensionName : +DimensionValue : +Name : cpu_percent +EndTime : 8/27/2015 5:22:25 PM +MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} +Properties : {} +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 +StartTime : 8/27/2015 4:20:00 PM +TimeGrain : 00:05:00 +Unit : Percent + +DimensionName : +DimensionValue : +Name : physical_data_read_percent +EndTime : 8/27/2015 5:22:25 PM +MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} +Properties : {} +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 +StartTime : 8/27/2015 4:20:00 PM +TimeGrain : 00:05:00 +Unit : Percent + +DimensionName : +DimensionValue : +Name : log_write_percent +EndTime : 8/27/2015 5:22:25 PM +MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} +Properties : {} +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 +StartTime : 8/27/2015 4:20:00 PM +TimeGrain : 00:05:00 +Unit : Percent + +DimensionName : +DimensionValue : +Name : dtu_consumption_percent +EndTime : 8/27/2015 5:22:25 PM +MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} +Properties : {} +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 +StartTime : 8/27/2015 4:20:00 PM +TimeGrain : 00:05:00 +Unit : Percent + +DimensionName : +DimensionValue : +Name : storage_percent +EndTime : 8/27/2015 5:22:25 PM +MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} +Properties : {} +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 +StartTime : 8/27/2015 4:20:00 PM +TimeGrain : 00:05:00 +Unit : Percent +``` + +This command returns metrics for an Azure SQL elastic database pool named ElasticPool01. + +### Example 4: Get all elastic pools using filtering -ElasticPoolName "ElasticPool*" +```powershell +Get-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +```output +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 +ResourceGroupName : resourcegroup01 +ServerName : server01 +ElasticPoolName : elasticpool01 +Location : Central US +CreationDate : 8/26/2015 10:00:17 PM +State : Ready +Edition : Standard +Dtu : 400 +DatabaseDtuMax : 100 +DatabaseDtuMin : 10 +StorageMB : 409600 +Tags : + +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool02 +ResourceGroupName : resourcegroup01 +ServerName : server01 +ElasticPoolName : elasticpool02 +Location : Central US +CreationDate : 8/26/2015 11:00:17 PM +State : Ready +Edition : Standard +Dtu : 400 +DatabaseDtuMax : 100 +DatabaseDtuMin : 10 +StorageMB : 409600 +Tags : +``` + +This command gets all of the elastic pools on the server named Server01 that start with "ElasticPool". + +### Example 5: Get elastic pool with preferred enclave type as VBS + +```powershell +Get-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +```output +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 +ResourceGroupName : resourcegroup01 +ServerName : server01 +ElasticPoolName : elasticpool01 +Location : Central US +CreationDate : 8/26/2015 10:00:17 PM +State : Ready +Edition : Standard +Dtu : 400 +DatabaseDtuMax : 100 +DatabaseDtuMin : 10 +StorageMB : 409600 +PreferredEnclaveType : VBS +Tags : +``` + +This command gets an elastic pool configured with VBS enclave + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies the name of the elastic pool that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the elastic pool that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that contains the elastic pool that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlElasticPool](./New-AzSqlElasticPool.md) + +[Remove-AzSqlElasticPool](./Remove-AzSqlElasticPool.md) + +[Set-AzSqlElasticPool](./Set-AzSqlElasticPool.md) + + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolActivity.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolActivity.md new file mode 100644 index 0000000000..66c38b69e4 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolActivity.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 0DB0B08A-F948-4F6E-9CF0-2FB5DD5064D3 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlelasticpoolactivity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticPoolActivity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticPoolActivity.md +--- + +# Get-AzSqlElasticPoolActivity + +## SYNOPSIS +Gets the status of operations on an elastic pool. + +## SYNTAX + +``` +Get-AzSqlElasticPoolActivity [-ServerName] <String> [-ElasticPoolName] <String> [-OperationId <Guid>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlElasticPoolActivity** cmdlet gets the status of operations on an elastic pool for an Azure SQL Database. +You can see the status of both pool creation and configuration updates. + +## EXAMPLES + +### Example 1: Get the status of operations for an elastic pool +```powershell +Get-AzSqlElasticPoolActivity -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" +``` + +This command gets the status of the operations for the elastic pool named ElasticPool01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies the name of an elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OperationId +The ID of the operation to retrieve. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group to which the elastic pool is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of a server that contains an elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolActivityModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlElasticPool](./Get-AzSqlElasticPool.md) + +[Get-AzSqlElasticPoolDatabase](./Get-AzSqlElasticPoolDatabase.md) + +[New-AzSqlElasticPool](./New-AzSqlElasticPool.md) + +[Remove-AzSqlElasticPool](./Remove-AzSqlElasticPool.md) + +[Set-AzSqlElasticPool](./Set-AzSqlElasticPool.md) + + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolAdvisor.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolAdvisor.md new file mode 100644 index 0000000000..3a9fb07f9a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolAdvisor.md @@ -0,0 +1,333 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: BC8C0D59-662F-47D2-8619-9F69D78B171D +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlelasticpooladvisor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticPoolAdvisor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticPoolAdvisor.md +--- + +# Get-AzSqlElasticPoolAdvisor + +## SYNOPSIS +Gets one or more Advisors for an Azure SQL Elastic Pool. + +## SYNTAX + +``` +Get-AzSqlElasticPoolAdvisor [-AdvisorName <String>] [-ExpandRecommendedActions] -ServerName <String> + -ElasticPoolName <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlElasticPoolAdvisor** cmdlet gets one or more Azure SQL Elastic Pool Advisors for an Azure SQL Elastic Pool. + +## EXAMPLES + +### Example 1: List all the advisors for the specified elastic pool +```powershell +Get-AzSqlElasticPoolAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" +``` + +```output +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {} + +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DropIndex +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 7/31/2016 8:41:19 PM +RecommendationsStatus : Ok +RecommendedActions : {} + +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DbParameterization +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 7/31/2016 2:46:58 PM +RecommendationsStatus : NoDbParameterizationIssue +RecommendedActions : {} + +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : SchemaIssue +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 8/1/2016 3:01:41 PM +RecommendationsStatus : SchemaIsConsistent +RecommendedActions : {} +``` + +The command gets lists all the advisors for the elastic pool named WIRunnerPool. + +### Example 2: Get a single advisor for the specified elastic pool +```powershell +Get-AzSqlElasticPoolAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -AdvisorName "CreateIndex" +``` + +```output +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {} +``` + +This command gets the Advisor named CreateIndex for the elastic pool named WIRunnerPool. + +### Example 3: List all the advisors with their recommended actions included in the response +```powershell +Get-AzSqlElasticPoolAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -ExpandRecommendedActions +``` + +```output +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.437714]_6C7AE8CC9C87E7FD5893...} + +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DropIndex +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 7/31/2016 8:41:19 PM +RecommendationsStatus : Ok +RecommendedActions : {IR_[test_schema]_[test_table_0.0288891]_38724E1DCF2178318957, + IR_[test_schema]_[test_table_0.140264]_38724E1DCF2178318957, + IR_[test_schema]_[test_table_0.412191]_38724E1DCF2178318957, + IR_[test_schema]_[test_table_0.442075]_38724E1DCF2178318957...} + +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DbParameterization +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 7/31/2016 2:46:58 PM +RecommendationsStatus : NoDbParameterizationIssue +RecommendedActions : {} + +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : SchemaIssue +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 8/1/2016 3:04:26 PM +RecommendationsStatus : SchemaIsConsistent +RecommendedActions : {} +``` + +This command gets all the advisors for the elastic pool with their recommended actions included in the response. + +### Example 4: Get a single advisor with its recommended actions included in the response +```powershell +Get-AzSqlElasticPoolAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -AdvisorName "CreateIndex" -ExpandRecommendedActions +``` + +```output +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.437714]_6C7AE8CC9C87E7FD5893...} +``` + +This command gets advisor named CreateIndex from the server named wi-runner-australia-east with its recommended actions included in the response. + +### Example 5: List all the advisors for the specified elastic pool using filtering +```powershell +Get-AzSqlElasticPoolAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -AdvisorName d* +``` + +```output +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DropIndex +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 7/31/2016 8:41:19 PM +RecommendationsStatus : Ok +RecommendedActions : {} + +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DbParameterization +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 7/31/2016 2:46:58 PM +RecommendationsStatus : NoDbParameterizationIssue +RecommendedActions : {} +``` + +The command gets lists all the advisors for the elastic pool named WIRunnerPool that start with the letter "d". + +## PARAMETERS + +### -AdvisorName +Specifies the name of the Advisor that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies the name of the elastic pool for which this cmdlet requests the Advisor. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpandRecommendedActions +Indicates that the cmdlet includes the recommended actions of the Advisor in the response. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the server that contains this elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server the elastic pool is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Advisor.Model.AzureSqlElasticPoolAdvisorModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, elasticpool, mssql, advisor + +## RELATED LINKS + +[Get-AzSqlServerAdvisor](./Get-AzSqlServerAdvisor.md) + +[Get-AzSqlDatabaseAdvisor](./Get-AzSqlDatabaseAdvisor.md) + +[Get-AzSqlElasticPoolRecommendedAction](./Get-AzSqlElasticPoolRecommendedAction.md) + +[Set-AzSqlElasticPoolAdvisorAutoExecuteStatus](./Set-AzSqlElasticPoolAdvisorAutoExecuteStatus.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolDatabase.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolDatabase.md new file mode 100644 index 0000000000..e932d71a53 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolDatabase.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14620FBD-4B10-4366-94F7-891BC01B893F +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlelasticpooldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticPoolDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticPoolDatabase.md +--- + +# Get-AzSqlElasticPoolDatabase + +## SYNOPSIS +Gets elastic databases in an elastic pool and their property values. + +## SYNTAX + +``` +Get-AzSqlElasticPoolDatabase [-ElasticPoolName] <String> [-DatabaseName <String>] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlElasticPoolDatabase** cmdlet gets elastic databases in an elastic pool and their property values. +You can specify the name of an elastic database in Azure SQL Database to see the property values for only that database. + +## EXAMPLES + +### Example 1: Get all databases in an elastic pool +```powershell +Get-AzSqlElasticPoolDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" +``` + +This command gets all databases in an elastic pool named ElasticPool01. + +### Example 2: Get all databases in an elastic pool using filtering +```powershell +Get-AzSqlElasticPoolDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -DatabaseName "Database*" +``` + +This command gets all databases in an elastic pool named ElasticPool01 that start with "Database". + +## PARAMETERS + +### -DatabaseName +Specifies the name of the SQL Database that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies the name of an elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group to which the elastic pool is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of a server that contains an elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlElasticPool](./Get-AzSqlElasticPool.md) + +[Get-AzSqlElasticPoolActivity](./Get-AzSqlElasticPoolActivity.md) + +[New-AzSqlElasticPool](./New-AzSqlElasticPool.md) + +[Remove-AzSqlElasticPool](./Remove-AzSqlElasticPool.md) + +[Set-AzSqlElasticPool](./Set-AzSqlElasticPool.md) + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolRecommendation.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolRecommendation.md new file mode 100644 index 0000000000..36e7e82604 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolRecommendation.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: A1E19A66-CD70-467E-8C59-1F88453905A4 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlelasticpoolrecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticPoolRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticPoolRecommendation.md +--- + +# Get-AzSqlElasticPoolRecommendation + +## SYNOPSIS +Gets elastic pool recommendations. + +## SYNTAX + +``` +Get-AzSqlElasticPoolRecommendation [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlElasticPoolRecommendation** cmdlet gets elastic pool recommendations for a server. +These recommendations include the following values: +- DatabaseCollection. Collection of database names that belong to the pool. +- DatabaseDtuMin. Data Transmission Unit (DTU) guarantee for databases in the elastic pool. + -- DatabaseDtuMax. DTU cap for databases in the elastic pool. +- Dtu. DTU guarantee for the elastic pool. +- StorageMb. Storage in megabytes for the elastic pool. +- Edition. Edition for the elastic pool. The acceptable values for this parameter are: Basic, Standard, and Premium. +- IncludeAllDatabases. Indicates whether to all databases in the elastic pool are returned. +- Name. Name of the elastic pool. + +## EXAMPLES + +### Example 1: Get recommendations for a server +```powershell +Get-AzSqlElasticPoolRecommendation -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +This command gets the elastic pool recommendations for the server named Server01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server for which this cmdlet gets recommendations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Sql.LegacySdk.Models.UpgradeRecommendedElasticPoolProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolRecommendedAction.md b/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolRecommendedAction.md new file mode 100644 index 0000000000..de238316f1 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlElasticPoolRecommendedAction.md @@ -0,0 +1,283 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 3FC9E586-3962-437E-B89F-BB4EA1FBF403 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlelasticpoolrecommendedaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticPoolRecommendedAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlElasticPoolRecommendedAction.md +--- + +# Get-AzSqlElasticPoolRecommendedAction + +## SYNOPSIS +Gets one or more recommended actions for an Azure SQL Elastic Pool Advisor. + +## SYNTAX + +``` +Get-AzSqlElasticPoolRecommendedAction [-RecommendedActionName <String>] -ServerName <String> + -ElasticPoolName <String> -AdvisorName <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlElasticPoolRecommendedAction** cmdlet gets one or more recommended actions for an Azure SQL Elastic Pool Advisor. + +## EXAMPLES + +### Example 1: List all recommended actions for an Advisor +```powershell +Get-AzSqlElasticPoolRecommendedAction -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -AdvisorName "CreateIndex" +``` + +```output +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, + NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} +RecommendationReason : +RevertActionDuration : +RevertActionInitiatedBy : +RevertActionInitiatedTime : +RevertActionStartTime : +Score : 2 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM + +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.236046_6C7AE8CC9C87E7FD5893], [indexType, NONCLUSTERED], + [schema, [test_schema]], [table, [test_table_0.236046]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {SpaceChange} +RecommendationReason : +RevertActionDuration : +RevertActionInitiatedBy : +RevertActionInitiatedTime : +RevertActionStartTime : +Score : 3 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM + +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.239359_6C7AE8CC9C87E7FD5893], [indexType, NONCLUSTERED], + [schema, [test_schema]], [table, [test_table_0.239359]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} +RecommendationReason : +RevertActionDuration : PT10S +RevertActionInitiatedBy : System +RevertActionInitiatedTime : 4/21/2016 3:24:47 PM +RevertActionStartTime : 4/21/2016 3:24:47 PM +Score : 3 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM +``` + +This command gets a list of all recommended actions of the Advisor named CreateIndex available for the elastic pool named WIRunnerPool. + +### Example 2: Get a single recommended action for an Advisor +```powershell +Get-AzSqlElasticPoolRecommendedAction -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -AdvisorName "CreateIndex" -RecommendedActionName "IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893" +``` + +```output +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, + NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} +RecommendationReason : +RevertActionDuration : +RevertActionInitiatedBy : +RevertActionInitiatedTime : +RevertActionStartTime : +Score : 2 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM +``` + +This command gets the recommended action named IR_\[test_schema\]_\[test_table_0.0361551\]_6C7AE8CC9C87E7FD5893 from the Advisor named CreateIndex. + +## PARAMETERS + +### -AdvisorName +Specifies the name of the advisor for which this cmdlet requests recommended actions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies the name of the elastic pool for which this cmdlet requests recommended actions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecommendedActionName +Specifies the name of the recommended action that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the server that contains this elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server the elastic pool is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.RecommendedAction.Model.AzureSqlElasticPoolRecommendedActionModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, elasticpool, mssql, advisor, recommendedaction + +## RELATED LINKS + +[Get-AzSqlDatabaseRecommendedAction](./Get-AzSqlDatabaseRecommendedAction.md) + +[Get-AzSqlElasticPoolAdvisor](./Get-AzSqlElasticPoolAdvisor.md) + +[Get-AzSqlServerRecommendedAction](./Get-AzSqlServerRecommendedAction.md) + +[Set-AzSqlElasticPoolRecommendedActionState](./Set-AzSqlElasticPoolRecommendedActionState.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstance.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstance.md new file mode 100644 index 0000000000..da1d1a1a9a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstance.md @@ -0,0 +1,566 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstance.md +--- + +# Get-AzSqlInstance + +## SYNOPSIS +Returns information about Azure SQL Managed Database Instance. + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Get-AzSqlInstance [-Name <String>] [-ResourceGroupName <String>] [-ExpandActiveDirectoryAdministrator] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListByInstancePoolObjectParameterSet +``` +Get-AzSqlInstance [-InstancePool] <AzureSqlInstancePoolModel> [-ExpandActiveDirectoryAdministrator] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListByInstancePoolResourceIdentiferParameterSet +``` +Get-AzSqlInstance [-InstancePoolResourceId] <String> [-ExpandActiveDirectoryAdministrator] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByManagedInstanceResourceIdentifierParameterSet +``` +Get-AzSqlInstance [-ResourceId] <String> [-ExpandActiveDirectoryAdministrator] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListByInstancePoolParameterSet +``` +Get-AzSqlInstance [-InstancePoolName] <String> -ResourceGroupName <String> + [-ExpandActiveDirectoryAdministrator] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstance** cmdlet returns information about one or more Azure SQL Managed Instances. +Specify the name of an instance to see information for only that instance. + +## EXAMPLES + +### Example 1: Get all instances assigned to a resource group +```powershell +Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +ZoneRedundant : false + +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance2 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance2 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance2.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin2 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +DnsZone : ad35cna0mw +ZoneRedundant : false +``` + +This command gets information about all instances assigned to the resource group ResourceGroup01. + +### Example 2: Get information about an instance +```powershell +Get-AzSqlInstance -Name "managedInstance1" -ResourceGroupName "ResourceGroup01" +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +DnsZone : ad35cna0mw +ZoneRedundant : false +``` + +This command gets information about the instance named managedInstance1. + +### Example 3: Get all instances assigned to a resource group using filtering +```powershell +Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -Name "managedInstance*" +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +DnsZone : ad35cna0mw +ZoneRedundant : false + +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance2 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance2 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance2.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin2 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +DnsZone : ad35cna0mw +ZoneRedundant : false +``` + +This command gets information about all instances assigned to the resource group ResourceGroup01 that start with "managedInstance". + +### Example 4: Get all instances within an instance pool +```powershell +Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -InstancePoolName "instancePool0" +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +DnsZone : ad35cna0mw +InstancePoolName : instancePool0 +ZoneRedundant : false + +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance2 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance2 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance2.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin2 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +DnsZone : ad35cna0mw +InstancePoolName : instancePool0 +ZoneRedundant : false +``` + +This command gets information about all instances within the instance pool "instancePool0". + +### Example 5: Get all instances within an instance pool using instance pool object +```powershell +$instancePool = Get-AzSqlInstancePool -ResourceGroupName "ResourceGroup01" -Name "instancePool0" +Get-AzSqlInstance -InstancePool $instancePool +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +DnsZone : ad35cna0mw +InstancePoolName : instancePool0 +ZoneRedundant : false + +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance2 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance2 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance2.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin2 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +DnsZone : ad35cna0mw +InstancePoolName : instancePool0 +ZoneRedundant : false +``` + +This command gets information about all instances within the instance pool "instancePool0". + +### Example 6: Get all instances within an instance pool using instance pool resource identifier +```powershell +Get-AzSqlInstance -InstancePoolResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0" +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +DnsZone : ad35cna0mw +InstancePoolName : instancePool0 +ZoneRedundant : false + +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance2 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance2 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance2.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin2 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +DnsZone : ad35cna0mw +InstancePoolName : instancePool0 +ZoneRedundant : false +``` + +This command gets information about all instances within the instance pool "instancePool0". + +### Example 7: Get a managed instance using its resource identifier +```powershell +Get-AzSqlInstance -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1" +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +DnsZone : ad35cna0mw +InstancePoolName : +ZoneRedundant : false +``` + +This command gets information about the instance named managedInstance1. + +### Example 8: Get all instances assigned to a resource group with external administrator information +<!-- Skip: Output cannot be splitted from code --> +```powershell +$val = Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -ExpandActiveDirectoryAdministrator + +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +Administrators : Microsoft.Azure.Management.Sql.Models.ManagedInstanceExternalAdministrator +ZoneRedundant : false + +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance2 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance2 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance2.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin2 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +DnsZone : ad35cna0mw +Administrators : Microsoft.Azure.Management.Sql.Models.ManagedInstanceExternalAdministrator +ZoneRedundant : false + +$val.Administrators +AdministratorType : ActiveDirectory +PrincipalType : Group +Login : Dummy +Sid : df7667b8-f9fd-4029-a0e3-b43c75ce9538 +TenantId : f553829b-6d84-481b-86a9-42db57c1dc73 +AzureADOnlyAuthentication : True + +AdministratorType : ActiveDirectory +PrincipalType : Group +Login : Dummy2 +Sid : df7667b8-f9fd-4029-a0e3-b43c75ce9538 +TenantId : f553829b-6d84-481b-86a9-42db57c1dc73 +AzureADOnlyAuthentication : True +``` + +This command gets information about all instances assigned to the resource group ResourceGroup01. . + +### Example 9: Get information about an instance with external administrator information +<!-- Skip: Output cannot be splitted from code --> +```powershell +$val = Get-AzSqlInstance -Name "managedInstance1" -ResourceGroupName "ResourceGroup01" -ExpandActiveDirectoryAdministrator + +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : BasePrice +VCores : 8 +StorageSizeInGB : 512 +DnsZone : ad35cna0mw +Administrators : Microsoft.Azure.Management.Sql.Models.ManagedInstanceExternalAdministrator +ZoneRedundant : false + +$val.Administrators +AdministratorType : ActiveDirectory +PrincipalType : Group +Login : Dummy +Sid : df7667b8-f9fd-4029-a0e3-b43c75ce9538 +TenantId : f553829b-6d84-481b-86a9-42db57c1dc73 +AzureADOnlyAuthentication : True +``` + +This command gets information about the instance named managedInstance1. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandActiveDirectoryAdministrator +Expand Active Directory Administrator Information on the server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstancePool +The instance pool parent object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Instance_Pools.Model.AzureSqlInstancePoolModel +Parameter Sets: ListByInstancePoolObjectParameterSet +Aliases: ParentObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstancePoolName +The name of the instance pool. + +```yaml +Type: System.String +Parameter Sets: ListByInstancePoolParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -InstancePoolResourceId +The instance pool resource identifier. + +```yaml +Type: System.String +Parameter Sets: ListByInstancePoolResourceIdentiferParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +SQL instance name. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: InstanceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ListByInstancePoolParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The managed instance resource identifier. + +```yaml +Type: System.String +Parameter Sets: GetByManagedInstanceResourceIdentifierParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceActiveDirectoryAdministrator.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceActiveDirectoryAdministrator.md new file mode 100644 index 0000000000..8fe80c9f0f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceActiveDirectoryAdministrator.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstanceactivedirectoryadministrator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceActiveDirectoryAdministrator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceActiveDirectoryAdministrator.md +--- + +# Get-AzSqlInstanceActiveDirectoryAdministrator + +## SYNOPSIS +Gets information about an Azure AD administrator for SQL Managed Instance. + +## SYNTAX + +### UseResourceGroupAndInstanceNameParameterSet (Default) +``` +Get-AzSqlInstanceActiveDirectoryAdministrator [-ResourceGroupName] <String> [-InstanceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### UseInputObjectParameterSet +``` +Get-AzSqlInstanceActiveDirectoryAdministrator -InputObject <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### UserResourceIdParameterSet +``` +Get-AzSqlInstanceActiveDirectoryAdministrator [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceActiveDirectoryAdministrator** cmdlet gets information about an Azure Active Directory (Azure AD) administrator for an AzureSQL Managed Instance in the current subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlInstanceActiveDirectoryAdministrator -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" +``` + +```output +ResourceGroupName InstanceName DisplayName ObjectId +----------------- ----------------- ----------- -------- +ResourceGroup01 ManagedInstance01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b +``` + +This command gets information about an Azure AD administrator for a managed instance named ManagedInstance01 that is associated with a resource group named ResourceGroup01. + +### Example 2 +```powershell +Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -Name "ManagedInstance1" | Get-AzSqlInstanceActiveDirectoryAdministrator +``` + +```output +ResourceGroupName InstanceName DisplayName ObjectId +----------------- ----------------- ----------- -------- +ResourceGroup01 ManagedInstance01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b +``` + +This command gets information about an Azure AD administrator from a managed instance object. + +### Example 3 +```powershell +Get-AzSqlInstance -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance1" | Get-AzSqlInstanceActiveDirectoryAdministrator +``` + +```output +ResourceGroupName InstanceName DisplayName ObjectId +----------------- ----------------- ----------- -------- +ResourceGroup01 ManagedInstance01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b +``` + +This command gets information about an Azure AD administrator using managed instance resource identifier. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed instance object to use. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: UseInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndInstanceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndInstanceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance to use + +```yaml +Type: System.String +Parameter Sets: UserResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.InstanceActiveDirectoryAdministrator.Model.AzureSqlInstanceActiveDirectoryAdministratorModel + +## NOTES + +## RELATED LINKS + +[Set-AzSqlInstanceActiveDirectoryAdministrator](./Set-AzSqlInstanceActiveDirectoryAdministrator.md) + +[Remove-AzSqlInstanceActiveDirectoryAdministrator](./Remove-AzSqlInstanceActiveDirectoryAdministrator.md) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceActiveDirectoryOnlyAuthentication.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceActiveDirectoryOnlyAuthentication.md new file mode 100644 index 0000000000..5d93563213 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceActiveDirectoryOnlyAuthentication.md @@ -0,0 +1,177 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstanceactivedirectoryonlyauthentication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceActiveDirectoryOnlyAuthentication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceActiveDirectoryOnlyAuthentication.md +--- + +# Get-AzSqlInstanceActiveDirectoryOnlyAuthentication + +## SYNOPSIS +Gets Azure AD only authentication for a specific SQL Managed Instance. + +## SYNTAX + +### UseResourceGroupAndInstanceNameParameterSet (Default) +``` +Get-AzSqlInstanceActiveDirectoryOnlyAuthentication [-ResourceGroupName] <String> [-InstanceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UseInputObjectParameterSet +``` +Get-AzSqlInstanceActiveDirectoryOnlyAuthentication -InputObject <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UserResourceIdParameterSet +``` +Get-AzSqlInstanceActiveDirectoryOnlyAuthentication [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceActiveDirectoryOnlyAuthentication** cmdlet gets Azure Active Directory (Azure AD) only authentication requirement for an AzureSQL Managed Instance in the current subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlInstanceActiveDirectoryOnlyAuthentication -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" +``` + +This command gets Azure Active Directory (Azure AD) only authentication requirement for an AzureSQL Managed Instance named ManagedInstance01 that is associated with a resource group named ResourceGroup01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed instance object to use. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: UseInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The name of the Azure SQL Managed Instance the Azure Active Directory only authentication is in. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndInstanceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndInstanceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance to use + +```yaml +Type: System.String +Parameter Sets: UserResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.InstanceActiveDirectoryOnlyAuthentication.Model.AzureSqlInstanceActiveDirectoryOnlyAuthenticationModel + +## NOTES + +## RELATED LINKS + +[Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication](./Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md) + +[Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication](./Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication.md) + +[Set-AzSqlInstanceActiveDirectoryAdministrator](./Set-AzSqlInstanceActiveDirectoryAdministrator.md) + +[Get-AzSqlInstanceActiveDirectoryAdministrator](./Get-AzSqlInstanceActiveDirectoryAdministrator.md) + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceAdvancedDataSecurityPolicy.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceAdvancedDataSecurityPolicy.md new file mode 100644 index 0000000000..863a7631d7 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceAdvancedDataSecurityPolicy.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstanceadvanceddatasecuritypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceAdvancedDataSecurityPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceAdvancedDataSecurityPolicy.md +--- + +# Get-AzSqlInstanceAdvancedDataSecurityPolicy + +## SYNOPSIS +Gets Advanced Data Security policy of a managed instance. + +## SYNTAX + +``` +Get-AzSqlInstanceAdvancedDataSecurityPolicy [-InputObject <AzureSqlManagedInstanceModel>] + -InstanceName <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceAdvancedDataSecurityPolicy** cmdlet retrieves the Advanced Data Security policy of a managed instance. + +## EXAMPLES + +### Example 1: Gets managed instance Advanced Data Security +```powershell +Get-AzSqlInstanceAdvancedDataSecurityPolicy ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ManagedInstanceName : ManagedInstance01 +IsEnabled : True +``` + +### Example 2: Gets managed instance Advanced Data Security from managed instance resource +```powershell +Get-AzSqlInstance ` + -ResourceGroupName "ResourceGroup01" ` + -Name "ManagedInstance01" ` + | Get-AzSqlInstanceAdvancedDataSecurityPolicy +``` + +```output +ResourceGroupName : ResourceGroup01 +ManagedInstanceName : ManagedInstance01 +IsEnabled : True +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed instance object to use with Advanced Data Security policy operation + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Database managed instance name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.AdvancedThreatProtection.Model.ManagedInstanceAdvancedDataSecurityPolicyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..7febb85c35 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceAdvancedThreatProtectionSetting.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/Get-AzSqlInstanceAdvancedThreatProtectionSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceAdvancedThreatProtectionSetting.md +--- + +# Get-AzSqlInstanceAdvancedThreatProtectionSetting + +## SYNOPSIS +Gets the Advanced Threat Protection settings for a managed instance. + +## SYNTAX + +``` +Get-AzSqlInstanceAdvancedThreatProtectionSetting -InstanceName <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceAdvancedThreatProtectionSetting** cmdlet gets the Advanced Threat Protection settings of an Azure SQL managed instance. +To use this cmdlet, specify the *ResourceGroupName* and *InstanceName* parameters to identify the managed instance for which this cmdlet gets the settings. + +## EXAMPLES + +### Example 1: Get the Advanced Threat Protection settings for a managed instance +```powershell +Get-AzSqlInstanceAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -InstanceName "Instance01" +``` + +```output +ResourceGroupName : ResourceGroup11 +InstanceName : Instance01 +AdvancedThreatProtectionState : Enabled +``` + +This command gets the Advanced Threat Protection settings for a managed instance named Instance01. +The managed instance is assigned to the resource group ResourceGroup11. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.AdvancedThreatProtection.Model.ManagedInstanceAdvancedThreatProtectionSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabase.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabase.md new file mode 100644 index 0000000000..5c5d49405b --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabase.md @@ -0,0 +1,269 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancedatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabase.md +--- + +# Get-AzSqlInstanceDatabase + +## SYNOPSIS +Returns information about Azure SQL Managed Instance database. + +## SYNTAX + +### GetInstanceDatabaseFromInputParameters (Default) +``` +Get-AzSqlInstanceDatabase [[-Name] <String>] [-InstanceName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetInstanceDatabaseFromAzureResourceId +``` +Get-AzSqlInstanceDatabase [[-Name] <String>] [-InstanceResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetInstanceDatabaseFromInstanceObject +``` +Get-AzSqlInstanceDatabase [[-Name] <String>] [-InstanceObject] <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceDatabase** cmdlet gets one or more Azure SQL databases from an Azure SQL Managed Instance. + +## EXAMPLES + +### Example 1: Get all databases on a instance +```powershell +Get-AzSqlInstanceDatabase -InstanceName "managedInstance1" -ResourceGroupName "resourcegroup01" +``` + +```output +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/databases/managedDatabase1 +Name : managedDatabase1 +Tags : +Collation : SQL_Latin1_General_CP1_CI_AS +Status : Online +CreationDate : 4/27/2018 2:30:07 PM +EarliestRestorePoint : 4/27/2018 2:40:47 PM +RestorePointInTime : +DefaultSecondaryLocation : West US 2 +CatalogCollation : +CreateMode : +StorageContainerUri : +StorageContainerSasToken : +SourceDatabaseId : +FailoverGroupId : + +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/databases/managedDatabase2 +Name : managedDatabase2 +Tags : +Collation : SQL_Latin1_General_CP1_CI_AS +Status : Online +CreationDate : 4/23/2018 5:21:07 PM +EarliestRestorePoint : 4/23/2018 5:31:47 PM +RestorePointInTime : +DefaultSecondaryLocation : West US 2 +CatalogCollation : +CreateMode : +StorageContainerUri : +StorageContainerSasToken : +SourceDatabaseId : +FailoverGroupId : +``` + +This command gets all databases on the instance named managedInstance1. + +### Example 2: Get a database by name on a Managed instance +```powershell +Get-AzSqlInstanceDatabase -Name "managedDatabase1" -InstanceName "managedInstance1" -ResourceGroupName "ResourceGroup01" +``` + +```output +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/databases/managedDatabase1 +Name : managedDatabase1 +Tags : +Collation : SQL_Latin1_General_CP1_CI_AS +Status : Online +CreationDate : 4/27/2018 2:30:07 PM +EarliestRestorePoint : 4/27/2018 2:40:47 PM +RestorePointInTime : +DefaultSecondaryLocation : West US 2 +CatalogCollation : +CreateMode : +StorageContainerUri : +StorageContainerSasToken : +SourceDatabaseId : +FailoverGroupId : +``` + +This command gets a database named managedDatabase1 from a instance named managedInstance1. + +### Example 3: Get all databases on a instance using filtering +```powershell +Get-AzSqlInstanceDatabase -InstanceName "managedInstance1" -ResourceGroupName "resourcegroup01" -Name "managedDatabase*" +``` + +```output +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/databases/managedDatabase1 +Name : managedDatabase1 +Tags : +Collation : SQL_Latin1_General_CP1_CI_AS +Status : Online +CreationDate : 4/27/2018 2:30:07 PM +EarliestRestorePoint : 4/27/2018 2:40:47 PM +RestorePointInTime : +DefaultSecondaryLocation : West US 2 +CatalogCollation : +CreateMode : +StorageContainerUri : +StorageContainerSasToken : +SourceDatabaseId : +FailoverGroupId : + +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/databases/managedDatabase2 +Name : managedDatabase2 +Tags : +Collation : SQL_Latin1_General_CP1_CI_AS +Status : Online +CreationDate : 4/23/2018 5:21:07 PM +EarliestRestorePoint : 4/23/2018 5:31:47 PM +RestorePointInTime : +DefaultSecondaryLocation : West US 2 +CatalogCollation : +CreateMode : +StorageContainerUri : +StorageContainerSasToken : +SourceDatabaseId : +FailoverGroupId : +``` + +This command gets all databases on the instance named managedInstance1 that start with "managedDatabase". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +The instance name. + +```yaml +Type: System.String +Parameter Sets: GetInstanceDatabaseFromInputParameters +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +The instance object to use for getting instance database + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: GetInstanceDatabaseFromInstanceObject +Aliases: ParentObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceResourceId +The resource id of instance object to get + +```yaml +Type: System.String +Parameter Sets: GetInstanceDatabaseFromAzureResourceId +Aliases: ParentResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the Azure SQL Instance Database to retrieve. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: InstanceDatabaseName + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: GetInstanceDatabaseFromInputParameters +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..b5503d7ee2 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting.md +--- + +# Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting + +## SYNOPSIS +Gets the Advanced Threat Protection settings for a managed database. + +## SYNTAX + +``` +Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting -InstanceName <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting** cmdlet gets the Advanced Threat Protection settings of an Azure SQL managed database. +To use this cmdlet, specify the *ResourceGroupName*, *InstanceName* and *DatabaseName* parameters to identify the managed database for which this cmdlet gets the settings. + + +## EXAMPLES + +### Example 1: Get the Advanced Threat Protection settings for a managed database +```powershell +Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -InstanceName "Instance01" -DatabaseName "Database01" +``` + +```output +DatabaseName : Database01 +ResourceGroupName : ResourceGroup11 +InstanceName : Instance01 +AdvancedThreatProtectionState : Enabled +``` + +This command gets the Advanced Threat Protection settings for a managed database named Database01. +The managed database is assigned to the resource group ResourceGroup11. + +## PARAMETERS + +### -DatabaseName +SQL Managed Database name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.AdvancedThreatProtection.Model.ManagedDatabaseAdvancedThreatProtectionSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md new file mode 100644 index 0000000000..23f30b4c7e --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancedatabasebackuplongtermretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md +--- + +# Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy + +## SYNOPSIS +Gets a managed database's long term retention policy + +## SYNTAX + +``` +Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy [-InstanceName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy** cmdlet gets the long term retention policy registered to this managed database. +The policy is an Azure Backup resource used to define backup storage policy. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy -ResourceGroupName testResourceGroup -InstanceName testInstance -DatabaseName test +``` + +```output +ResourceGroupName : testResourceGroup +ManagedInstanceName : testInstance +DatabaseName : test +WeeklyRetention : P2W +MonthlyRetention : PT0S +YearlyRetention : PT0S +WeekOfYear : 0 +Location : +``` + +Gets the current version of the long term retention policy for the database + +## PARAMETERS + +### -DatabaseName +The name of the Azure Managed Database to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +The name of the Azure Managed Instance the database belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabaseBackup.Model.AzureSqlManagedDatabaseBackupLongTermRetentionPolicyModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlInstanceDatabaseLongTermRetentionBackup](./Get-AzSqlInstanceDatabaseLongTermRetentionBackup.md) + +[Remove-AzSqlInstanceDatabaseLongTermRetentionBackup](./Remove-AzSqlInstanceDatabaseLongTermRetentionBackup.md) + +[Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy](./Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy.md new file mode 100644 index 0000000000..64473358a9 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancedatabasebackupshorttermretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy.md +--- + +# Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy + +## SYNOPSIS +Gets a backup short term retention policy. + +## SYNTAX + +### PolicyByResourceInstanceDatabaseSet (Default) +``` +Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy [-ResourceGroupName] <String> [-InstanceName] <String> + [-DatabaseName] <String> [-DeletionDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### PolicyByInputObjectSet +``` +Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy -InputObject <AzureSqlManagedDatabaseBaseModel> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### PolicyByResourceIdSet +``` +Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy** cmdlet gets the short term retention policy registered to this database. +The policy is the retention period, in days, for point-in-time restore backups. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy -ResourceGroupName resourcegroup01 -InstanceName instance01 -DatabaseName database01 +``` + +```output +ResourceGroupName : resourcegroup01 +InstanceName : instance01 +DatabaseName : database01 +DeletionDate : +RetentionDays : 7 +``` + +This command gets the short term retention policy for database01. + +### Example 2 +```powershell +Get-AzSqlInstanceDatabase -ResourceGroupName resourcegroup01 -InstanceName instance01 -Name database01 | Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy +``` + +```output +ResourceGroupName : resourcegroup01 +InstanceName : instance01 +DatabaseName : database01 +DeletionDate : +RetentionDays : 7 +``` + +This command gets the short term retention policy for database01 via piping in a database object. + +### Example 3 +```powershell +Get-AzSqlDeletedInstanceDatabaseBackup -ResourceGroupName "ContosoResourceGroup" -InstanceName "ContosoServer" -DatabaseName "DB1" | Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy +``` + +```output +ResourceGroupName : resourcegroup01 +InstanceName : instance01 +DatabaseName : database01 +DeletionDate : 2019-03-03 12:00:17 AM +RetentionDays : 7 + +ResourceGroupName : resourcegroup01 +InstanceName : instance01 +DatabaseName : database01 +DeletionDate : 2019-03-02 11:00:16 PM +RetentionDays : 7 +``` + +This command gets the short term retention policy for all deleted databases named database01 via piping in a deleted database object. + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Instance Database to retrieve backups for. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceInstanceDatabaseSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletionDate +The deletion date of the Azure SQL Instance Database to retrieve backups for, with millisecond precision (e.g. +2016-02-23T00:21:22.847Z) + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: PolicyByResourceInstanceDatabaseSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The live or deleted database object to get/set the policy for. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseBaseModel +Parameter Sets: PolicyByInputObjectSet +Aliases: AzureSqlInstanceDatabase, AzureInstanceDatabaseObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The name of the Azure SQL Managed Instance the database is in. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceInstanceDatabaseSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceInstanceDatabaseSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The short term retention policy resource Id. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceIdSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseBaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabaseBackup.Model.AzureSqlManagedDatabaseBackupShortTermRetentionPolicyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseCopyOperation.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseCopyOperation.md new file mode 100644 index 0000000000..b279e72cb6 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseCopyOperation.md @@ -0,0 +1,421 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancedatabasecopyoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseCopyOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseCopyOperation.md +--- + +# Get-AzSqlInstanceDatabaseCopyOperation + +## SYNOPSIS +Get managed database copy operation details + +## SYNTAX + +### GetMoveCopyManagedDatabaseOperationsByNameParameterSet (Default) +``` +Get-AzSqlInstanceDatabaseCopyOperation [-DatabaseName <String>] [-TargetResourceGroupName <String>] + [-TargetInstanceName <String>] [-OnlyLatestPerDatabase] [-InstanceName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetMoveCopyManagedDatabaseOperationsByInputObjectParameterSet +``` +Get-AzSqlInstanceDatabaseCopyOperation [-DatabaseName <String>] [-TargetResourceGroupName <String>] + [-TargetInstanceName <String>] -DatabaseObject <AzureSqlManagedDatabaseModel> [-OnlyLatestPerDatabase] + [-InstanceName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetMoveCopyManagedDatabaseOperationsByMoveCopyObjectParameterSet +``` +Get-AzSqlInstanceDatabaseCopyOperation [-DatabaseName <String>] [-TargetResourceGroupName <String>] + [-TargetInstanceName <String>] -ModelObject <MoveCopyManagedDatabaseModel> [-OnlyLatestPerDatabase] + [-InstanceName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetMoveCopyManagedDatabaseOperationsByResourceIdParameterSet +``` +Get-AzSqlInstanceDatabaseCopyOperation [-TargetResourceGroupName <String>] [-TargetInstanceName <String>] + -ResourceId <String> [-OnlyLatestPerDatabase] [-InstanceName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceDatabaseCopyOperation** cmdlet get copy managed database operation details. + +## EXAMPLES + +### Example 1: Get all copy operation on single Azure SQL Managed Instance +```powershell +Get-AzSqlInstanceDatabaseCopyOperation -ResourceGroupName RG1 -InstanceName instance1 +``` + +```output +Name : 11111111-1111-1111-1111-111111111111 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/locations/westcentralus/managedDatabaseMoveOperationResults/11111111-1111-1111-1111-111111111111 +Operation : StartCrossManagedInstanceDatabaseMovement +OperationFriendlyName : Start Azure SQL Managed Instance database copy +StartTime : 5/30/2023 10:11:21 AM +State : Succeeded +OperationMode : Copy +SourceManagedInstanceName : instance1 +TargetManagedInstanceName : instance2 +SourceManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/managedInstances/instance1 +TargetManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microsoft.Sql/managedInstances/instance2 +SourceDatabaseName : db1 +TargetDatabaseName : db1 +IsCancellable : True +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : + +Name : 22222222-2222-2222-2222-222222222222 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/locations/westcentralus/managedDatabaseMoveOperationResults/22222222-2222-2222-2222-222222222222 +Operation : StartCrossManagedInstanceDatabaseMovement +OperationFriendlyName : Start Azure SQL Managed Instance database copy +StartTime : 5/30/2023 10:11:21 AM +State : Succeeded +OperationMode : Copy +SourceManagedInstanceName : instance1 +TargetManagedInstanceName : instance3 +SourceManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/managedInstances/instance1 +TargetManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microsoft.Sql/managedInstances/instance3 +SourceDatabaseName : db2 +TargetDatabaseName : db2 +IsCancellable : True +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : + +Name : 33333333-3333-3333-3333-333333333333 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/locations/westcentralus/managedDatabaseMoveOperationResults/33333333-3333-3333-3333-333333333333 +Operation : CancelCrossManagedInstanceDatabaseMovement +OperationFriendlyName : Cancel Azure SQL Managed Instance database copy +StartTime : 5/30/2023 11:11:21 AM +State : Succeeded +OperationMode : Copy +SourceManagedInstanceName : instance1 +TargetManagedInstanceName : instance3 +SourceManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/managedInstances/instance1 +TargetManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microsoft.Sql/managedInstances/instance3 +SourceDatabaseName : db2 +TargetDatabaseName : db2 +IsCancellable : False +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : +``` + +This command will return all copy operations for instance instance1 in resource group RG1. + +### Example 2: Get all copy operations on Azure SQL Managed Instance for one database + +```powershell +Get-AzSqlInstanceDatabaseCopyOperation -ResourceGroupName RG1 -InstanceName instance1 -DatabaseName db2 +``` + +```output +Name : 22222222-2222-2222-2222-222222222222 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/locations/westcentralus/managedDatabaseMoveOperationResults/22222222-2222-2222-2222-222222222222 +Operation : StartCrossManagedInstanceDatabaseMovement +OperationFriendlyName : Start Azure SQL Managed Instance database copy +StartTime : 5/30/2023 10:11:21 AM +State : Succeeded +OperationMode : Copy +SourceManagedInstanceName : instance1 +TargetManagedInstanceName : instance3 +SourceManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/managedInstances/instance1 +TargetManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microsoft.Sql/managedInstances/instance3 +SourceDatabaseName : db2 +TargetDatabaseName : db2 +IsCancellable : True +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : + + +Name : 33333333-3333-3333-3333-333333333333 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/locations/westcentralus/managedDatabaseMoveOperationResults/33333333-3333-3333-3333-333333333333 +Operation : CancelCrossManagedInstanceDatabaseMovement +OperationFriendlyName : Cancel Azure SQL Managed Instance database copy +StartTime : 5/30/2023 11:11:21 AM +State : Succeeded +OperationMode : Copy +SourceManagedInstanceName : instance1 +TargetManagedInstanceName : instance3 +SourceManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/managedInstances/instance1 +TargetManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microsoft.Sql/managedInstances/instance3 +SourceDatabaseName : db2 +TargetDatabaseName : db2 +IsCancellable : False +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : +``` + +This command will return all copy operations for database db2 on instance instance1 in resource group RG1. + +### Example 3: Get only latest copy operation on Azure SQL Managed Instance for one database + +```powershell +Get-AzSqlInstanceDatabaseCopyOperation -ResourceGroupName RG1 -InstanceName instance1 -DatabaseName db2 -OnlyLatestPerDatabase +``` + +```output +Name : 33333333-3333-3333-3333-333333333333 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/locations/westcentralus/managedDatabaseMoveOperationResults/33333333-3333-3333-3333-333333333333 +Operation : CancelCrossManagedInstanceDatabaseMovement +OperationFriendlyName : Cancel Azure SQL Managed Instance database copy +StartTime : 5/30/2023 11:11:21 AM +State : Succeeded +OperationMode : Copy +SourceManagedInstanceName : instance1 +TargetManagedInstanceName : instance3 +SourceManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/managedInstances/instance1 +TargetManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microsoft.Sql/managedInstances/instance3 +SourceDatabaseName : db2 +TargetDatabaseName : db2 +IsCancellable : False +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : +``` + +This command will return latest copy operation for database db2 on instance instance1 in resource group RG1. + +## PARAMETERS + +### -DatabaseName +Name of a database on Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByNameParameterSet +Aliases: Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByInputObjectParameterSet, GetMoveCopyManagedDatabaseOperationsByMoveCopyObjectParameterSet +Aliases: Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseObject +Managed database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +The name of the instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ModelObject +Object that is returned from start move or copy operation using -PassThru parameter. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByMoveCopyObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OnlyLatestPerDatabase +Return only latest opereation per managed database + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource id of managed database. + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetInstanceName +Name of the target Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByNameParameterSet, GetMoveCopyManagedDatabaseOperationsByInputObjectParameterSet, GetMoveCopyManagedDatabaseOperationsByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByMoveCopyObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +Name of the target resource group. + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByNameParameterSet, GetMoveCopyManagedDatabaseOperationsByInputObjectParameterSet, GetMoveCopyManagedDatabaseOperationsByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByMoveCopyObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation + +## NOTES + +## RELATED LINKS + +[Complete-AzSqlInstanceDatabaseCopy](./Complete-AzSqlInstanceDatabaseCopy.md) + +[Stop-AzSqlInstanceDatabaseCopy](./Stop-AzSqlInstanceDatabaseCopy.md) + +[Copy-AzSqlInstanceDatabase](./Copy-AzSqlInstanceDatabase.md) + +[Get-AzSqlInstanceDatabaseMoveOperation](./Get-AzSqlInstanceDatabaseMoveOperation.md) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseGeoBackup.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseGeoBackup.md new file mode 100644 index 0000000000..762147e001 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseGeoBackup.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancedatabasegeobackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseGeoBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseGeoBackup.md +--- + +# Get-AzSqlInstanceDatabaseGeoBackup + +## SYNOPSIS +Returns information about Azure SQL Managed Instance database redundant backup. + +## SYNTAX + +``` +Get-AzSqlInstanceDatabaseGeoBackup [[-Name] <String>] [-InstanceName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceDatabaseGeoBackup** cmdlet gets one or more Azure SQL databases redundant backups from an Azure SQL Database Managed Instance. + +## EXAMPLES + +### Example 1: Get all database redundant backups on a instance +```powershell +Get-AzSqlInstanceDatabaseGeoBackup -InstanceName "managedInstance1" -ResourceGroupName "resourcegroup01" +``` + +```output +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/recoverableDatabases/managedDatabase1 +Name : managedDatabase1 +LastAvailableBackupDate : 01/31/2019 20:44:57 +RecoverableDatabaseId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/recoverableDatabases/managedDatabase1 + +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/recoverableDatabases/managedDatabase2 +Name : managedDatabase2 +LastAvailableBackupDate : 01/31/2019 20:44:57 +RecoverableDatabaseId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/recoverableDatabases/managedDatabase2 +``` + +This command gets all database redundant backups on the instance named managedInstance1. + +### Example 2: Get a database redundant backup by name on a Managed instance +```powershell +Get-AzSqlInstanceDatabaseGeoBackup -Name "managedDatabase1" -InstanceName "managedInstance1" -ResourceGroupName "ResourceGroup01" +``` + +```output +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/recoverableDatabases/managedDatabase1 +Name : managedDatabase1 +LastAvailableBackupDate : 01/31/2019 20:44:57 +RecoverableDatabaseId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/recoverableDatabases/managedDatabase1 +``` + +This command gets a database redundant backup named managedDatabase1 from an instance named managedInstance1. + +### Example 3: Get all database redundant backups on a instance using filtering +```powershell +Get-AzSqlInstanceDatabaseGeoBackup -InstanceName "managedInstance1" -ResourceGroupName "resourcegroup01" -Name "managedDatabase*" +``` + +```output +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/recoverableDatabases/managedDatabase1 +Name : managedDatabase1 +LastAvailableBackupDate : 01/31/2019 20:44:57 +RecoverableDatabaseId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/recoverableDatabases/managedDatabase1 + +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/recoverableDatabases/managedDatabase2 +Name : managedDatabase2 +LastAvailableBackupDate : 01/31/2019 20:44:57 +RecoverableDatabaseId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/recoverableDatabases/managedDatabase2 +``` + +This command gets all database redundant backups on the instance named managedInstance1 that start with "managedDatabase". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +The name of the instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the instance database to retrieve. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: RecoverableInstanceDatabaseName + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlRecoverableManagedDatabaseModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseLedgerDigestUpload.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseLedgerDigestUpload.md new file mode 100644 index 0000000000..4d1f0bbf53 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseLedgerDigestUpload.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancedatabaseledgerdigestupload +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseLedgerDigestUpload.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseLedgerDigestUpload.md +--- + +# Get-AzSqlInstanceDatabaseLedgerDigestUpload + +## SYNOPSIS +Gets the ledger digest upload settings of a database in Azure SQL Managed Instance. + +## SYNTAX + +### DatabaseParameterSet (Default) +``` +Get-AzSqlInstanceDatabaseLedgerDigestUpload [-ResourceGroupName] <String> [-InstanceName] <String> + [-DatabaseName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Get-AzSqlInstanceDatabaseLedgerDigestUpload -InputObject <AzureSqlManagedDatabaseModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Get-AzSqlInstanceDatabaseLedgerDigestUpload [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlInstanceDatabaseLedgerDigestUpload cmdlet gets the ledger digest upload settings of the specified database in an Azure SQL Managed Instance + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlInstanceDatabaseLedgerDigestUpload -ResourceGroupName "ResourceGroup01" -InstanceName "Server01" -DatabaseName "Database01" +``` + +```output +ResourceGroupName InstanceName DatabaseName State Endpoint +----------------- ------------ ------------ ----- -------- +ResourceGroup01 Server01 Database01 Enabled https://mystorage.blob.core.windows.net +``` + +## PARAMETERS + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to retrieve digest uploads for. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlManagedDatabaseModel +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of the database to retrieve digest uploads for. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstanceName +Azure SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlManagedDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstanceLedgerDigestUploads.Model.AzureSqlInstanceDatabaseLedgerDigestUploadModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseLogReplay.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseLogReplay.md new file mode 100644 index 0000000000..09cfd39973 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseLogReplay.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/Get-AzSqlInstanceDatabaseLogReplay +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseLogReplay.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseLogReplay.md +--- + +# Get-AzSqlInstanceDatabaseLogReplay + +## SYNOPSIS +Gets the Log Replay service status. + +## SYNTAX + +``` +Get-AzSqlInstanceDatabaseLogReplay [[-Name] <String>] [-InstanceName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceDatabaseLogReplay** cmdlet gets the Log Replay service status on the given database. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlInstanceDatabaseLogReplay -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "ManagedDatabaseName" +``` + +This command will get log replay service status on the given database. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +The name of the instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ManagedInstanceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the instance database to retrieve. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: InstanceDatabaseName + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseRestoreDetailsResultModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseLongTermRetentionBackup.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseLongTermRetentionBackup.md new file mode 100644 index 0000000000..2ca16c617f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseLongTermRetentionBackup.md @@ -0,0 +1,299 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancedatabaselongtermretentionbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseLongTermRetentionBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseLongTermRetentionBackup.md +--- + +# Get-AzSqlInstanceDatabaseLongTermRetentionBackup + +## SYNOPSIS +Gets long term retention backup(s). + +## SYNTAX + +### Location (Default) +``` +Get-AzSqlInstanceDatabaseLongTermRetentionBackup [-Location] <String> [-ResourceGroupName <String>] + [-OnlyLatestPerDatabase] [-DatabaseState <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InstanceName +``` +Get-AzSqlInstanceDatabaseLongTermRetentionBackup [-Location] <String> [-InstanceName] <String> + [-ResourceGroupName <String>] [-OnlyLatestPerDatabase] [-DatabaseState <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DatabaseName +``` +Get-AzSqlInstanceDatabaseLongTermRetentionBackup [-Location] <String> [-InstanceName] <String> + [-DatabaseName] <String> [-ResourceGroupName <String>] [-OnlyLatestPerDatabase] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BackupName +``` +Get-AzSqlInstanceDatabaseLongTermRetentionBackup [-Location] <String> [-InstanceName] <String> + [-DatabaseName] <String> [-BackupName] <String> [-ResourceGroupName <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GetBackupByResourceId +``` +Get-AzSqlInstanceDatabaseLongTermRetentionBackup [-Location] <String> [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GetBackupByInputObject +``` +Get-AzSqlInstanceDatabaseLongTermRetentionBackup [-InputObject] <AzureSqlManagedDatabaseModel> + [-BackupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GetBackupsByInputObject +``` +Get-AzSqlInstanceDatabaseLongTermRetentionBackup [-InputObject] <AzureSqlManagedDatabaseModel> + [-OnlyLatestPerDatabase] [-DatabaseState <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceDatabaseLongTermRetentionBackup** cmdlet gets long term retention backup(s). + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlInstanceDatabaseLongTermRetentionBackup -Location southeastasia -ResourceGroupName testResourceGroup -InstanceName testInstance -DatabaseName test +``` + +```output +BackupExpirationTime : 3/10/2020 1:10:45 PM +BackupName : 15be823c-7e2c-49d8-819f-a3fdcad92215;132268250550000000 +BackupTime : 2/22/2020 6:04:15 AM +DatabaseName : test +DatabaseDeletionTime : 2/24/2020 2:56:44 PM +Location : southeastasia +ResourceId : /subscriptions/f46521f3-5bb0-4eea-a3c2-c2d5987df96b/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/southeastasia/longTermRetentionManaged + Instances/testInstance/longTermRetentionDatabases/test/longTermRetentionManagedInstanceBackups/15be823c-7e2c-49d8-819f-a3fdcad92215;132268250550000000 +ManagedInstanceName : testInstance +InstanceCreateTime : 10/17/2019 4:52:10 PM +ResourceGroupName : testResourceGroup +``` + +Gets all long term retention backups for a particular database. Resource Group is optional. + +## PARAMETERS + +### -BackupName +The name of the backup. + +```yaml +Type: System.String +Parameter Sets: BackupName, GetBackupByInputObject +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DatabaseName +The name of the Managed Database the backups are under. + +```yaml +Type: System.String +Parameter Sets: DatabaseName, BackupName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseState +The state of the database whose backups you want to find, Alive, Deleted, or All. +Defaults to All + +```yaml +Type: System.String +Parameter Sets: Location, InstanceName, GetBackupsByInputObject +Aliases: +Accepted values: All, Deleted, Live + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to get backups for. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: GetBackupByInputObject, GetBackupsByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The name of the Managed Instance the backups are under. + +```yaml +Type: System.String +Parameter Sets: InstanceName, DatabaseName, BackupName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the backups' source Managed Instance. + +```yaml +Type: System.String +Parameter Sets: Location, InstanceName, DatabaseName, BackupName, GetBackupByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlyLatestPerDatabase +Whether or not to only get the latest backup per database. +Defaults to false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Location, InstanceName, DatabaseName, GetBackupsByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Location, InstanceName, DatabaseName, BackupName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The database Resource ID to get backups for. + +```yaml +Type: System.String +Parameter Sets: GetBackupByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabaseBackup.Model.AzureSqlManagedDatabaseLongTermRetentionBackupModel + +## NOTES + +## RELATED LINKS + +[Remove-AzSqlInstanceDatabaseLongTermRetentionBackup](./Remove-AzSqlInstanceDatabaseLongTermRetentionBackup.md) + +[Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy](./Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md) + +[Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy](./Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseMoveOperation.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseMoveOperation.md new file mode 100644 index 0000000000..38d952432d --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseMoveOperation.md @@ -0,0 +1,421 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancedatabasemoveoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseMoveOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseMoveOperation.md +--- + +# Get-AzSqlInstanceDatabaseMoveOperation + +## SYNOPSIS +Get managed database move operation details + +## SYNTAX + +### GetMoveCopyManagedDatabaseOperationsByNameParameterSet (Default) +``` +Get-AzSqlInstanceDatabaseMoveOperation [-DatabaseName <String>] [-TargetResourceGroupName <String>] + [-TargetInstanceName <String>] [-OnlyLatestPerDatabase] [-InstanceName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetMoveCopyManagedDatabaseOperationsByInputObjectParameterSet +``` +Get-AzSqlInstanceDatabaseMoveOperation [-DatabaseName <String>] [-TargetResourceGroupName <String>] + [-TargetInstanceName <String>] -DatabaseObject <AzureSqlManagedDatabaseModel> [-OnlyLatestPerDatabase] + [-InstanceName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetMoveCopyManagedDatabaseOperationsByMoveCopyObjectParameterSet +``` +Get-AzSqlInstanceDatabaseMoveOperation [-DatabaseName <String>] [-TargetResourceGroupName <String>] + [-TargetInstanceName <String>] -ModelObject <MoveCopyManagedDatabaseModel> [-OnlyLatestPerDatabase] + [-InstanceName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetMoveCopyManagedDatabaseOperationsByResourceIdParameterSet +``` +Get-AzSqlInstanceDatabaseMoveOperation [-TargetResourceGroupName <String>] [-TargetInstanceName <String>] + -ResourceId <String> [-OnlyLatestPerDatabase] [-InstanceName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceDatabaseMoveOperation** cmdlet get move managed database operation details. + +## EXAMPLES + +### Example 1: Get all move operation on single Azure SQL Managed Instance +```powershell +Get-AzSqlInstanceDatabaseMoveOperation -ResourceGroupName RG1 -InstanceName instance1 +``` + +```output +Name : 11111111-1111-1111-1111-111111111111 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/locations/westcentralus/managedDatabaseMoveOperationResults/11111111-1111-1111-1111-111111111111 +Operation : StartCrossManagedInstanceDatabaseMovement +OperationFriendlyName : Start Azure SQL Managed Instance database move +StartTime : 5/30/2023 10:11:21 AM +State : Succeeded +OperationMode : Move +SourceManagedInstanceName : instance1 +TargetManagedInstanceName : instance2 +SourceManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/managedInstances/instance1 +TargetManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microsoft.Sql/managedInstances/instance2 +SourceDatabaseName : db1 +TargetDatabaseName : db1 +IsCancellable : True +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : + +Name : 22222222-2222-2222-2222-222222222222 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/locations/westcentralus/managedDatabaseMoveOperationResults/22222222-2222-2222-2222-222222222222 +Operation : StartCrossManagedInstanceDatabaseMovement +OperationFriendlyName : Start Azure SQL Managed Instance database move +StartTime : 5/30/2023 10:11:21 AM +State : Succeeded +OperationMode : Move +SourceManagedInstanceName : instance1 +TargetManagedInstanceName : instance3 +SourceManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/managedInstances/instance1 +TargetManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microsoft.Sql/managedInstances/instance3 +SourceDatabaseName : db2 +TargetDatabaseName : db2 +IsCancellable : True +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : + +Name : 33333333-3333-3333-3333-333333333333 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/locations/westcentralus/managedDatabaseMoveOperationResults/33333333-3333-3333-3333-333333333333 +Operation : CancelCrossManagedInstanceDatabaseMovement +OperationFriendlyName : Cancel Azure SQL Managed Instance database move +StartTime : 5/30/2023 11:11:21 AM +State : Succeeded +OperationMode : Move +SourceManagedInstanceName : instance1 +TargetManagedInstanceName : instance3 +SourceManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/managedInstances/instance1 +TargetManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microsoft.Sql/managedInstances/instance3 +SourceDatabaseName : db2 +TargetDatabaseName : db2 +IsCancellable : False +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : +``` + +This command will return all move operations for instance instance1 in resource group RG1. + +### Example 2: Get all move operations on Azure SQL Managed Instance for one database + +```powershell +Get-AzSqlInstanceDatabaseMoveOperation -ResourceGroupName RG1 -InstanceName instance1 -DatabaseName db2 +``` + +```output +Name : 22222222-2222-2222-2222-222222222222 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/locations/westcentralus/managedDatabaseMoveOperationResults/22222222-2222-2222-2222-222222222222 +Operation : StartCrossManagedInstanceDatabaseMovement +OperationFriendlyName : Start Azure SQL Managed Instance database move +StartTime : 5/30/2023 10:11:21 AM +State : Succeeded +OperationMode : Move +SourceManagedInstanceName : instance1 +TargetManagedInstanceName : instance3 +SourceManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/managedInstances/instance1 +TargetManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microsoft.Sql/managedInstances/instance3 +SourceDatabaseName : db2 +TargetDatabaseName : db2 +IsCancellable : True +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : + + +Name : 33333333-3333-3333-3333-333333333333 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/locations/westcentralus/managedDatabaseMoveOperationResults/33333333-3333-3333-3333-333333333333 +Operation : CancelCrossManagedInstanceDatabaseMovement +OperationFriendlyName : Cancel Azure SQL Managed Instance database move +StartTime : 5/30/2023 11:11:21 AM +State : Succeeded +OperationMode : Move +SourceManagedInstanceName : instance1 +TargetManagedInstanceName : instance3 +SourceManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/managedInstances/instance1 +TargetManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microsoft.Sql/managedInstances/instance3 +SourceDatabaseName : db2 +TargetDatabaseName : db2 +IsCancellable : False +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : +``` + +This command will return all move operations for database db2 on instance instance1 in resource group RG1. + +### Example 3: Get only latest move operation on Azure SQL Managed Instance for one database + +```powershell +Get-AzSqlInstanceDatabaseMoveOperation -ResourceGroupName RG1 -InstanceName instance1 -DatabaseName db2 -OnlyLatestPerDatabase +``` + +```output +Name : 33333333-3333-3333-3333-333333333333 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/locations/westcentralus/managedDatabaseMoveOperationResults/33333333-3333-3333-3333-333333333333 +Operation : CancelCrossManagedInstanceDatabaseMovement +OperationFriendlyName : Cancel Azure SQL Managed Instance database move +StartTime : 5/30/2023 11:11:21 AM +State : Succeeded +OperationMode : Move +SourceManagedInstanceName : instance1 +TargetManagedInstanceName : instance3 +SourceManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microso + ft.Sql/managedInstances/instance1 +TargetManagedInstanceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG1/providers/Microsoft.Sql/managedInstances/instance3 +SourceDatabaseName : db2 +TargetDatabaseName : db2 +IsCancellable : False +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : +``` + +This command will return latest move operation for database db2 on instance instance1 in resource group RG1. + +## PARAMETERS + +### -DatabaseName +Name of a database on Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByNameParameterSet +Aliases: Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByInputObjectParameterSet, GetMoveCopyManagedDatabaseOperationsByMoveCopyObjectParameterSet +Aliases: Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseObject +Managed database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +The name of the instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ModelObject +Object that is returned from start move or copy operation using -PassThru parameter. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByMoveCopyObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OnlyLatestPerDatabase +Return only latest opereation per managed database + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource id of managed database. + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetInstanceName +Name of the target Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByNameParameterSet, GetMoveCopyManagedDatabaseOperationsByInputObjectParameterSet, GetMoveCopyManagedDatabaseOperationsByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByMoveCopyObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +Name of the target resource group. + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByNameParameterSet, GetMoveCopyManagedDatabaseOperationsByInputObjectParameterSet, GetMoveCopyManagedDatabaseOperationsByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetMoveCopyManagedDatabaseOperationsByMoveCopyObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation + +## NOTES + +## RELATED LINKS + +[Complete-AzSqlInstanceDatabaseMove](./Complete-AzSqlInstanceDatabaseMove.md) + +[Stop-AzSqlInstanceDatabaseMove](./Stop-AzSqlInstanceDatabaseMove.md) + +[Move-AzSqlInstanceDatabase](./Move-AzSqlInstanceDatabase.md) + +[Get-AzSqlInstanceDatabaseCopyOperation](./Get-AzSqlInstanceDatabaseCopyOperation.md) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseSensitivityClassification.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseSensitivityClassification.md new file mode 100644 index 0000000000..5a68f0dcec --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseSensitivityClassification.md @@ -0,0 +1,300 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancedatabasesensitivityclassification +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseSensitivityClassification.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseSensitivityClassification.md +--- + +# Get-AzSqlInstanceDatabaseSensitivityClassification + +## SYNOPSIS +Gets the current information types and sensitivity labels of columns in the Azure SQL Managed Instance database. + +## SYNTAX + +### DatabaseObjectParameterSet (Default) +``` +Get-AzSqlInstanceDatabaseSensitivityClassification -DatabaseObject <AzureSqlManagedDatabaseModel> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DatabaseParameterSet +``` +Get-AzSqlInstanceDatabaseSensitivityClassification [-ResourceGroupName] <String> [-InstanceName] <String> + [-DatabaseName] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Get-AzSqlInstanceDatabaseSensitivityClassification [-ResourceGroupName] <String> [-InstanceName] <String> + [-DatabaseName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DatabaseObjectColumnParameterSet +``` +Get-AzSqlInstanceDatabaseSensitivityClassification -DatabaseObject <AzureSqlManagedDatabaseModel> + -SchemaName <String> -TableName <String> -ColumnName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlInstanceDatabaseSensitivityClassification cmdlet returns the current information types and sensitivity labels of columns in the Azure SQL Managed Instance database. + +## EXAMPLES + +### Example 1: Get current information types and sensitivity labels of an Azure SQL Managed Instance database. +```powershell +Get-AzSqlInstanceDatabaseSensitivityClassification -ResourceGroupName resourceGroup -InstanceName managedInstance -DatabaseName database +``` + +```output +ResourceGroupName : resourceGroup +InstanceName : managedInstance +DatabaseName : database +SensitivityLabels : {{ + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailBody, + InformationType: Contact Info + }, { + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailSubject, + SensitivityLabel: Confidential, + Rank: Medium + }, { + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +### Example 2: Get current information types and sensitivity labels of an Azure SQL Managed Instance database with Piping. +```powershell +Get-AzSqlInstanceDatabase -ResourceGroupName resourceGroup -InstanceName managedInstance -Name database | Get-AzSqlInstanceDatabaseSensitivityClassification +``` + +```output +ResourceGroupName : resourceGroup +InstanceName : managedInstance +DatabaseName : database +SensitivityLabels : {{ + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailBody, + InformationType: Contact Info + }, { + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailSubject, + SensitivityLabel: Confidential, + Rank: Medium + }, { + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +### Example 3: Get current information type and sensitivity label of a specific column of an Azure SQL Managed Instance database. +```powershell +Get-AzSqlInstanceDatabaseSensitivityClassification -ResourceGroupName resourceGroup -InstanceName managedInstance -DatabaseName database -SchemaName dbo -TableName EMailLog -ColumnName BounceEmailSubject +``` + +```output +ResourceGroupName : resourceGroup +InstanceName : managedInstance +DatabaseName : database +SensitivityLabels : {{ + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +### Example 4: Get current information type and sensitivity label of a specific column of an Azure SQL Managed Instance database using Piping. +```powershell +Get-AzSqlInstanceDatabase -ResourceGroupName resourceGroup -InstanceName managedInstance -Name database | Get-AzSqlInstanceDatabaseSensitivityClassification -SchemaName dbo -TableName EMailLog -ColumnName BounceEmailSubject +``` + +```output +ResourceGroupName : resourceGroup +InstanceName : managedInstance +DatabaseName : database +SensitivityLabels : {{ + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Managed Instance database. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet, ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +The Azure SQL Managed Instance database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: DatabaseObjectParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Azure SQL Managed Instance name. + + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet, ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet, ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataClassification.Model.ManagedDatabaseSensitivityClassificationModel + +## NOTES + +## RELATED LINKS + +[Learn more about Azure SQL Database data discovery and classification](https://learn.microsoft.com/azure/sql-database/sql-database-data-discovery-and-classification) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseSensitivityRecommendation.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseSensitivityRecommendation.md new file mode 100644 index 0000000000..4c6282ed16 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseSensitivityRecommendation.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/Get-AzSqlInstanceDatabaseSensitivityRecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseSensitivityRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseSensitivityRecommendation.md +--- + +# Get-AzSqlInstanceDatabaseSensitivityRecommendation + +## SYNOPSIS +Gets the recommended information types and sensitivity labels of columns in the Azure SQL Managed Instance database. + +## SYNTAX + +### DatabaseObjectParameterSet (Default) +``` +Get-AzSqlInstanceDatabaseSensitivityRecommendation -DatabaseObject <AzureSqlManagedDatabaseModel> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### DatabaseParameterSet +``` +Get-AzSqlInstanceDatabaseSensitivityRecommendation [-ResourceGroupName] <String> [-InstanceName] <String> + [-DatabaseName] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlInstanceDatabaseSensitivityRecommendation cmdlet returns the recommended information types and sensitivity labels of columns in the Azure SQL Managed Instance database. + +## EXAMPLES + +### Example 1: Get recommended information types and sensitivity labels of an Azure SQL Managed Instance database. +```powershell +Get-AzSqlInstanceDatabaseSensitivityRecommendation -ResourceGroupName resourceGroup -InstanceName managedInstance -DatabaseName database +``` + +```output +ResourceGroupName : resourceGroup +InstanceName : managedInstance +DatabaseName : database +SensitivityLabels : {{ + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailBody, + InformationType: Contact Info + }, { + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailSubject, + SensitivityLabel: Confidential, + Rank: Medium + }, { + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +### Example 2: Get recommended information types and sensitivity labels of an Azure SQL Managed Instance database using Piping. +```powershell +Get-AzSqlInstanceDatabase -ResourceGroupName resourceGroup -InstanceName managedInstance -Name database | Get-AzSqlInstanceDatabaseSensitivityRecommendation +``` + +```output +ResourceGroupName : resourceGroup +InstanceName : managedInstance +DatabaseName : database +SensitivityLabels : {{ + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailBody, + InformationType: Contact Info + }, { + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailSubject, + SensitivityLabel: Confidential, + Rank: Medium + }, { + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Managed Instance database. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +The Azure SQL Managed Instance database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: DatabaseObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Azure SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataClassification.Model.ManagedDatabaseSensitivityClassificationModel + +## NOTES + +## RELATED LINKS + +[Learn more about Azure SQL Database data discovery and classification](https://learn.microsoft.com/azure/sql-database/sql-database-data-discovery-and-classification) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md new file mode 100644 index 0000000000..5121f317e2 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancedatabasevulnerabilityassessmentrulebaseline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md +--- + +# Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline + +## SYNOPSIS +Gets the vulnerability assessment rule baseline. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline [-InstanceName] <String> [-DatabaseName] <String> + -RuleId <String> [-RuleAppliesToMaster] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentResourceParameterSet +``` +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline -InputObject <AzureSqlManagedDatabaseModel> + -RuleId <String> [-RuleAppliesToMaster] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline** cmdlet gets the vulnerability assessment rule baseline. +Note that you need to run *Enable-AzSqlInstanceAdvancedDataSecurity* and *Update-AzSqlInstanceVulnerabilityAssessmentSetting* cmdlets as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1: Get the vulnerability assessment rule baseline +```powershell +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -RuleId "VA2108" ` + -RuleAppliesToMaster +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +RuleId : VA2108 +RuleAppliesToMaster : True +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +### Example 2: Get the vulnerability assessment rule baseline from a managed database object +```powershell +Get-AzSqlInstanceDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -Name "Database01" ` + | Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline ` + -RuleId "VA2108" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +RuleId : VA2108 +RuleAppliesToMaster : False +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +## PARAMETERS + +### -DatabaseName +SQL Managed Database name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed database object to get Vulnerability Assessment rule baseline for + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: GetByParentResourceParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleAppliesToMaster +Specifies whether the baseline results should apply on a server level rule identified by the RuleId + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleId +The rule ID which identifies the rule to set the baseline results to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ManagedDatabaseVulnerabilityAssessmentRuleBaselineModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord.md new file mode 100644 index 0000000000..6f34f80cc2 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancedatabasevulnerabilityassessmentscanrecord +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord.md +--- + +# Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord + +## SYNOPSIS +Gets all vulnerability assessment scan record(s) associated with a given managed database. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord [-InstanceName] <String> [-DatabaseName] <String> + [-ScanId <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord -InputObject <AzureSqlManagedDatabaseModel> + [-ScanId <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord** cmdlet retrieves all vulnerability assessment scan record(s) associated with a given managed database. +Note that you need to run *Enable-AzSqlInstanceAdvancedDataSecurity* and *Update-AzSqlInstanceVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1 - Gets a specific vulnerability assessment scan results identified by the scan ID +```powershell +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -ScanId "myScan" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +ScanId : myScan +TriggerType : OnDemand +State : Passed +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/ManagedInstance01/Database01/scan_myScan/.json +NumberOfFailedSecurityChecks : 0 +``` + +### Example 2 - Gets a specific vulnerability assessment scan results identified by the scan ID with managed database object +```powershell +Get-AzSqlInstanceDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -Name "Database01" ` + | Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord ` + -ScanId "myScan" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +ScanId : myScan +TriggerType : OnDemand +State : Passed +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/ManagedInstance01/Database01/scan_myScan/.json +NumberOfFailedSecurityChecks : 0 +``` + +### Example 3 - Gets all vulnerability assessment scan results on the specified managed database +```powershell +Get-AzSqlInstanceDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -Name "Database01" ` + | Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +ScanId : myScan +TriggerType : OnDemand +State : Passed +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/ManagedInstance01/Database01/scan_myScan/.json +NumberOfFailedSecurityChecks : 0 + + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +ScanId : myScan1 +TriggerType : OnDemand +State : Passed +StartTime : 6/12/2018 1:57:27 PM +EndTime : 6/12/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/ManagedInstance01/Database01/scan_myScan/.json +NumberOfFailedSecurityChecks : 0 +``` + +## PARAMETERS + +### -DatabaseName +SQL Managed Database name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed database object to get Vulnerability Assessment scan record for + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScanId +Specifies the scan ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ManagedDatabaseVulnerabilityAssessmentScanRecordModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..03e976948b --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancedatabasevulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md +--- + +# Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting + +## SYNOPSIS +Gets the vulnerability assessment settings of a managed database. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting [-InstanceName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentResourceParameterSet +``` +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting -InputObject <AzureSqlManagedDatabaseModel> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting** cmdlet gets the vulnerability assessment settings of an Azure SQL Managed Database. +Note that you need to run *Enable-AzSqlInstanceAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1 - Get the vulnerability assessment settings of an Azure SQL managed database +```powershell +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : None +EmailSubscriptionAdmins : False +NotificationEmail : {} +``` + +### Example 2 - Get the vulnerability assessment settings of an Azure SQL managed database from an Azure SQL managed database object +```powershell +Get-AzSqlInstanceDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -Name "Database01" ` + | Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : None +EmailSubscriptionAdmins : False +NotificationEmail : {} +``` + +## PARAMETERS + +### -DatabaseName +SQL Managed Database name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed database object to get Vulnerability Assessment settings for + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: GetByParentResourceParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ManagedDatabaseVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDtc.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDtc.md new file mode 100644 index 0000000000..dfdf546c1f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceDtc.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancedtc +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDtc.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceDtc.md +--- + +# Get-AzSqlInstanceDtc + +## SYNOPSIS +Gets an Azure SQL Managed Instance DTC. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSqlInstanceDtc [-ResourceGroupName] <String> [-InstanceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSqlInstanceDtc [-InstanceObject] <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSqlInstanceDtc [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceDtc** cmdlet returns information about an Azure SQL Managed Instance DTC. + +## EXAMPLES + +### Example 1 Get the managed instance DTC +```powershell +Get-AzSqlInstanceDtc -ResourceGroupName ResourceGroup1 -InstanceName ManagedInstance1 +``` + +```output +ResourceGroupName : ResourceGroup1 +ManagedInstanceName : ManagedInstance1 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/current +DtcEnabled : True +DtcHostNameDnsSuffix : suffix1.net +DtcHostName : name1.suffix1.net +ExternalDnsSuffixSearchList : {suffix1.net} +SecuritySettings : Microsoft.Azure.Management.Sql.Models.ManagedInstanceDtcSecuritySettings +``` + +This command gets the managed instance DTC of the managed instance. + +### Example 2 Get the managed instance DTC of the previously fetched managed instance +```powershell +$managedInstance = Get-AzSqlInstance -ResourceGroupName ResourceGroup1 -InstanceName ManagedInstance1 +Get-AzSqlInstanceDtc -InstanceObject $managedInstance +``` + +```output +ResourceGroupName : ResourceGroup1 +ManagedInstanceName : ManagedInstance1 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/current +DtcEnabled : True +DtcHostNameDnsSuffix : suffix1.net +DtcHostName : name1.suffix1.net +ExternalDnsSuffixSearchList : {suffix1.net} +SecuritySettings : Microsoft.Azure.Management.Sql.Models.ManagedInstanceDtcSecuritySettings +``` + +This command gets the managed instance DTC by passing the managed instance object. + +### Example 3 Get the managed instance DTC with the specified resource ID +```powershell +Get-AzSqlInstanceDtc -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/current +``` + +```output +ResourceGroupName : ResourceGroup1 +ManagedInstanceName : ManagedInstance1 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/current +DtcEnabled : True +DtcHostNameDnsSuffix : suffix1.net +DtcHostName : name1.suffix1.net +ExternalDnsSuffixSearchList : {suffix1.net} +SecuritySettings : Microsoft.Azure.Management.Sql.Models.ManagedInstanceDtcSecuritySettings +``` + +This command gets the managed instance DTC by passing the resource ID of the DTC. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of the managed instance. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +Input object of the managed instance. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID of the managed instance DTC. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstanceDtc.Model.AzureSqlManagedInstanceDtcModel + +## NOTES + +## RELATED LINKS + +[Set-AzSqlInstanceDtc](./Set-AzSqlInstanceDtc.md) + +[SQL Managed Instance DTC Documentation](https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/distributed-transaction-coordinator-dtc?view=azuresql) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceEndpointCertificate.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceEndpointCertificate.md new file mode 100644 index 0000000000..69598f7c04 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceEndpointCertificate.md @@ -0,0 +1,328 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstanceendpointcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceEndpointCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceEndpointCertificate.md +--- + +# Get-AzSqlInstanceEndpointCertificate + +## SYNOPSIS +Returns information about endpoint certificates. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSqlInstanceEndpointCertificate [-ResourceGroupName] <String> [-InstanceName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSqlInstanceEndpointCertificate [[-Name] <String>] [-InstanceObject] <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInstanceResourceIdParameterSet +``` +Get-AzSqlInstanceEndpointCertificate [[-Name] <String>] [-InstanceResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSqlInstanceEndpointCertificate [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +**Get-AzSqlInstanceEndpointCertificate** cmdlet returns information about one or more instance of endpoint certificate on an Azure SQL Managed Instance. Specify the name of a certificate (or endpoint type) to see information for that certificate only. + +## EXAMPLES + +### Example 1: Get information about all endpoint certificates on Azure SQL Managed Instance +```powershell +Get-AzSqlInstanceEndpointCertificate -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/endpointCertificates/DATABASE_MIRRORING +Type : Microsoft.Sql/managedInstances/endpointCertificates +Name : DATABASE_MIRRORING +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/endpointCertificates/SERVICE_BROKER +Type : Microsoft.Sql/managedInstances/endpointCertificates +Name : SERVICE_BROKER +PublicKey : 0x5D014B47F6AF7D0469A853C84180445C146015D5098F09AC673A49281EDA9D3C560039BAFBD02617BF94DF30B505AA2CA891E3F80BD0056F39B21396F675EBAEA148A12C3EED8F7DE6753A2AAC722EEB1D3A71633A00909F720E74180CC9D7B51E84BEFDDC6A64C7015368FB041E59E836F3968739E7B84654FEDA396BD7E89C9AFCCF4086F8838A1FD5F833C1288EB619A14F68F15094D8BB4DD834F64333AF44A7C0CC5BF4406C408702993B14D04A20772EE23A0C7FED3D89B754EA66C23FDAE65AEAD53F55AE82ADEEDC8B730352D1A0933AD28745FCCA960FAD3AE12693175DA3A14CCF37B221AC35DEF986A9758EAB7DEFB334FF65BBAF8C5F4377F51224459B349CFDDC51A6D5DC9937477EF869CAE4B4165E8A4DC83B3E9D9B7A80E3C0C591DEE00A776E4C1915EDEF276D23BEEDEBF2E673F02857E909B0CEFD6C8D96C8B6E91E1753858974F24D37D0E85558D2A40C82E06B2BF6002CD57ABBEEF8C8C43EBEC5F2624E4E882E3094E62FC7624D2C52DD73DC0C618F1AB96D39316E2E16E301ABDE4FE267DE88425CBFCA9F3131D4FED6BDF7F296B5A7BAC4CB2F9E4A48F0C6BE822B611002A9785A60692F9B25A1EAA7F279FEF4BF5E2BDEA8BEC4E3417E9936E542A19F9D19880065B003537A514754F09ADFA9A08D067BF34D3BEBC56BF4D970526A20886CE25BEB1174496F2AB9BC884BEC3A885875FEF4DBA60F682F68354C40B3E7C3DF62666DA0D655B0BC9EB0A1E470EDF58538DD848ECB5700BD632175644D50C713BFC1ACDC94F6600331F7C14AE8A63C1396699662CF1D5BD668C1BCE1E9AA0A2B5DDDC62294841958A36C03E9D211AA4352FA2918962452F73831B843412725766728AE7BB18B863D1B267AAA5FAB9B735FE50E6B1DF43BD4FA33F5004AECBA0BFD9D704F22AE1F15FD7F7DDF839868F7A7FDDB03C167520CF1A61CA62D057CB89052695EBCA0248E2429457437044EDA2CF89AFF27C8BB4D779A177137D9C9FCA03B169004066A1D92B53A601ABC5EBF9603AEA1FE9798C001C3B058E0F8892AD592920955CBBE5403868B06F90D7011D9390793CA611883D774853559DA0CBBDE2C25FC5FED3197CFC1725137FFF221DC152F2C906972 +``` + +This command gets information about all endpoint certificates within the instance "ManagedInstance01". + +### Example 2: Get information about a certificate for specific endpoint type on Azure SQL Managed Instance +```powershell +Get-AzSqlInstanceEndpointCertificate -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -EndpointType "DATABASE_MIRRORING" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/endpointCertificates/DATABASE_MIRRORING +Type : Microsoft.Sql/managedInstances/endpointCertificates +Name : DATABASE_MIRRORING +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 +``` + +This command gets information about the "DATABASE_MIRRORING" endpoint certificate on instance "ManagedInstance01" and resource group "ResourceGroup01". + +### Example 3: Get all endpoint certificates on Azure SQL Managed Instance using Instance object +```powershell +$instance = Get-AzSqlInstance -Name "ManagedInstance01" -ResourceGroupName "ResourceGroup01" +Get-AzSqlInstanceEndpointCertificate -InstanceObject $instance +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/endpointCertificates/DATABASE_MIRRORING +Type : Microsoft.Sql/managedInstances/endpointCertificates +Name : DATABASE_MIRRORING +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/endpointCertificates/SERVICE_BROKER +Type : Microsoft.Sql/managedInstances/endpointCertificates +Name : SERVICE_BROKER +PublicKey : 0x5D014B47F6AF7D0469A853C84180445C146015D5098F09AC673A49281EDA9D3C560039BAFBD02617BF94DF30B505AA2CA891E3F80BD0056F39B21396F675EBAEA148A12C3EED8F7DE6753A2AAC722EEB1D3A71633A00909F720E74180CC9D7B51E84BEFDDC6A64C7015368FB041E59E836F3968739E7B84654FEDA396BD7E89C9AFCCF4086F8838A1FD5F833C1288EB619A14F68F15094D8BB4DD834F64333AF44A7C0CC5BF4406C408702993B14D04A20772EE23A0C7FED3D89B754EA66C23FDAE65AEAD53F55AE82ADEEDC8B730352D1A0933AD28745FCCA960FAD3AE12693175DA3A14CCF37B221AC35DEF986A9758EAB7DEFB334FF65BBAF8C5F4377F51224459B349CFDDC51A6D5DC9937477EF869CAE4B4165E8A4DC83B3E9D9B7A80E3C0C591DEE00A776E4C1915EDEF276D23BEEDEBF2E673F02857E909B0CEFD6C8D96C8B6E91E1753858974F24D37D0E85558D2A40C82E06B2BF6002CD57ABBEEF8C8C43EBEC5F2624E4E882E3094E62FC7624D2C52DD73DC0C618F1AB96D39316E2E16E301ABDE4FE267DE88425CBFCA9F3131D4FED6BDF7F296B5A7BAC4CB2F9E4A48F0C6BE822B611002A9785A60692F9B25A1EAA7F279FEF4BF5E2BDEA8BEC4E3417E9936E542A19F9D19880065B003537A514754F09ADFA9A08D067BF34D3BEBC56BF4D970526A20886CE25BEB1174496F2AB9BC884BEC3A885875FEF4DBA60F682F68354C40B3E7C3DF62666DA0D655B0BC9EB0A1E470EDF58538DD848ECB5700BD632175644D50C713BFC1ACDC94F6600331F7C14AE8A63C1396699662CF1D5BD668C1BCE1E9AA0A2B5DDDC62294841958A36C03E9D211AA4352FA2918962452F73831B843412725766728AE7BB18B863D1B267AAA5FAB9B735FE50E6B1DF43BD4FA33F5004AECBA0BFD9D704F22AE1F15FD7F7DDF839868F7A7FDDB03C167520CF1A61CA62D057CB89052695EBCA0248E2429457437044EDA2CF89AFF27C8BB4D779A177137D9C9FCA03B169004066A1D92B53A601ABC5EBF9603AEA1FE9798C001C3B058E0F8892AD592920955CBBE5403868B06F90D7011D9390793CA611883D774853559DA0CBBDE2C25FC5FED3197CFC1725137FFF221DC152F2C906972 +``` + +This command gets information about all endpoint certificates within the instance "ManagedInstance01". + +### Example 4: Get all endpoint certificates on Azure SQL Managed Instance using instance resource identifier + +```powershell +Get-AzSqlInstanceEndpointCertificate -InstanceResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/endpointCertificates/DATABASE_MIRRORING +Type : Microsoft.Sql/managedInstances/endpointCertificates +Name : DATABASE_MIRRORING +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/endpointCertificates/SERVICE_BROKER +Type : Microsoft.Sql/managedInstances/endpointCertificates +Name : SERVICE_BROKER +PublicKey : 0x5D014B47F6AF7D0469A853C84180445C146015D5098F09AC673A49281EDA9D3C560039BAFBD02617BF94DF30B505AA2CA891E3F80BD0056F39B21396F675EBAEA148A12C3EED8F7DE6753A2AAC722EEB1D3A71633A00909F720E74180CC9D7B51E84BEFDDC6A64C7015368FB041E59E836F3968739E7B84654FEDA396BD7E89C9AFCCF4086F8838A1FD5F833C1288EB619A14F68F15094D8BB4DD834F64333AF44A7C0CC5BF4406C408702993B14D04A20772EE23A0C7FED3D89B754EA66C23FDAE65AEAD53F55AE82ADEEDC8B730352D1A0933AD28745FCCA960FAD3AE12693175DA3A14CCF37B221AC35DEF986A9758EAB7DEFB334FF65BBAF8C5F4377F51224459B349CFDDC51A6D5DC9937477EF869CAE4B4165E8A4DC83B3E9D9B7A80E3C0C591DEE00A776E4C1915EDEF276D23BEEDEBF2E673F02857E909B0CEFD6C8D96C8B6E91E1753858974F24D37D0E85558D2A40C82E06B2BF6002CD57ABBEEF8C8C43EBEC5F2624E4E882E3094E62FC7624D2C52DD73DC0C618F1AB96D39316E2E16E301ABDE4FE267DE88425CBFCA9F3131D4FED6BDF7F296B5A7BAC4CB2F9E4A48F0C6BE822B611002A9785A60692F9B25A1EAA7F279FEF4BF5E2BDEA8BEC4E3417E9936E542A19F9D19880065B003537A514754F09ADFA9A08D067BF34D3BEBC56BF4D970526A20886CE25BEB1174496F2AB9BC884BEC3A885875FEF4DBA60F682F68354C40B3E7C3DF62666DA0D655B0BC9EB0A1E470EDF58538DD848ECB5700BD632175644D50C713BFC1ACDC94F6600331F7C14AE8A63C1396699662CF1D5BD668C1BCE1E9AA0A2B5DDDC62294841958A36C03E9D211AA4352FA2918962452F73831B843412725766728AE7BB18B863D1B267AAA5FAB9B735FE50E6B1DF43BD4FA33F5004AECBA0BFD9D704F22AE1F15FD7F7DDF839868F7A7FDDB03C167520CF1A61CA62D057CB89052695EBCA0248E2429457437044EDA2CF89AFF27C8BB4D779A177137D9C9FCA03B169004066A1D92B53A601ABC5EBF9603AEA1FE9798C001C3B058E0F8892AD592920955CBBE5403868B06F90D7011D9390793CA611883D774853559DA0CBBDE2C25FC5FED3197CFC1725137FFF221DC152F2C906972 +``` + +This command gets information about all endpoint certificates within the instance "ManagedInstance01". + +### Example 5: Get an endpoint certificate using its resource identifier + +```powershell +Get-AzSqlInstanceEndpointCertificate -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/endpointCertificates/DATABASE_MIRRORING" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/endpointCertificates/DATABASE_MIRRORING +Type : Microsoft.Sql/managedInstances/endpointCertificates +Name : DATABASE_MIRRORING +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 +``` + +This command gets information about the endpoint certificate named "DATABASE_MIRRORING". + +### Example 6: Get all endpoint certificates for a Managed Instance by piping an instance object + +```powershell +Get-AzSqlInstance -Name "ManagedInstance01" -ResourceGroupName "ResourceGroup01" | Get-AzSqlInstanceEndpointCertificate +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/endpointCertificates/DATABASE_MIRRORING +Type : Microsoft.Sql/managedInstances/endpointCertificates +Name : DATABASE_MIRRORING +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/endpointCertificates/SERVICE_BROKER +Type : Microsoft.Sql/managedInstances/endpointCertificates +Name : SERVICE_BROKER +PublicKey : 0x5D014B47F6AF7D0469A853C84180445C146015D5098F09AC673A49281EDA9D3C560039BAFBD02617BF94DF30B505AA2CA891E3F80BD0056F39B21396F675EBAEA148A12C3EED8F7DE6753A2AAC722EEB1D3A71633A00909F720E74180CC9D7B51E84BEFDDC6A64C7015368FB041E59E836F3968739E7B84654FEDA396BD7E89C9AFCCF4086F8838A1FD5F833C1288EB619A14F68F15094D8BB4DD834F64333AF44A7C0CC5BF4406C408702993B14D04A20772EE23A0C7FED3D89B754EA66C23FDAE65AEAD53F55AE82ADEEDC8B730352D1A0933AD28745FCCA960FAD3AE12693175DA3A14CCF37B221AC35DEF986A9758EAB7DEFB334FF65BBAF8C5F4377F51224459B349CFDDC51A6D5DC9937477EF869CAE4B4165E8A4DC83B3E9D9B7A80E3C0C591DEE00A776E4C1915EDEF276D23BEEDEBF2E673F02857E909B0CEFD6C8D96C8B6E91E1753858974F24D37D0E85558D2A40C82E06B2BF6002CD57ABBEEF8C8C43EBEC5F2624E4E882E3094E62FC7624D2C52DD73DC0C618F1AB96D39316E2E16E301ABDE4FE267DE88425CBFCA9F3131D4FED6BDF7F296B5A7BAC4CB2F9E4A48F0C6BE822B611002A9785A60692F9B25A1EAA7F279FEF4BF5E2BDEA8BEC4E3417E9936E542A19F9D19880065B003537A514754F09ADFA9A08D067BF34D3BEBC56BF4D970526A20886CE25BEB1174496F2AB9BC884BEC3A885875FEF4DBA60F682F68354C40B3E7C3DF62666DA0D655B0BC9EB0A1E470EDF58538DD848ECB5700BD632175644D50C713BFC1ACDC94F6600331F7C14AE8A63C1396699662CF1D5BD668C1BCE1E9AA0A2B5DDDC62294841958A36C03E9D211AA4352FA2918962452F73831B843412725766728AE7BB18B863D1B267AAA5FAB9B735FE50E6B1DF43BD4FA33F5004AECBA0BFD9D704F22AE1F15FD7F7DDF839868F7A7FDDB03C167520CF1A61CA62D057CB89052695EBCA0248E2429457437044EDA2CF89AFF27C8BB4D779A177137D9C9FCA03B169004066A1D92B53A601ABC5EBF9603AEA1FE9798C001C3B058E0F8892AD592920955CBBE5403868B06F90D7011D9390793CA611883D774853559DA0CBBDE2C25FC5FED3197CFC1725137FFF221DC152F2C906972 +``` + +This command gets information about all endpoint certificates within the instance "ManagedInstance01". + +### Example 7: Get a specific endpoint certificate for an instance by piping an instance object and specifying the certificate name +```powershell +Get-AzSqlInstance -Name "ManagedInstance01" -ResourceGroupName "ResourceGroup01" | Get-AzSqlInstanceEndpointCertificate -Name "SERVICE_BROKER" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/endpointCertificates/SERVICE_BROKER +Type : Microsoft.Sql/managedInstances/endpointCertificates +Name : SERVICE_BROKER +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 +``` + +This command gets information about the "SERVICE_BROKER" endpoint certificate on instance "ManagedInstance01" and resource group "ResourceGroup01". + +### Example 8: Get information about endpoint certificate using positional parameters +```powershell +Get-AzSqlInstanceEndpointCertificate "ResourceGroup01" "ManagedInstance01" "DATABASE_MIRRORING" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/endpointCertificates/DATABASE_MIRRORING +Type : Microsoft.Sql/managedInstances/endpointCertificates +Name : DATABASE_MIRRORING +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 +``` + +This command gets information about the endpoint certificate "DATABASE_MIRRORING" on instance "ManagedInstance01" and resource group "ResourceGroup01". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +Instance input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceResourceId +Managed instance resource ID. + +```yaml +Type: System.String +Parameter Sets: GetByInstanceResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the certificate (endpoint type). + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet, GetByInstanceResourceIdParameterSet +Aliases: EndpointType + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Certificate resource ID. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.EndpointCertificate.Model.AzureSqlInstanceEndpointCertificateModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceKeyVaultKey.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceKeyVaultKey.md new file mode 100644 index 0000000000..07bc7dbfc2 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceKeyVaultKey.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/Get-AzSqlInstanceKeyVaultKey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceKeyVaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceKeyVaultKey.md +--- + +# Get-AzSqlInstanceKeyVaultKey + +## SYNOPSIS +Gets a SQL managed instance's Key Vault keys. + +## SYNTAX + +### AddAzureRmSqlManagedInstanceKeyVaultKeyDefaultParameterSet (Default) +``` +Get-AzSqlInstanceKeyVaultKey [[-KeyId] <String>] [-ResourceGroupName] <String> [-InstanceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AddAzureRmSqlManagedInstanceKeyVaultKeyInputObjectParameterSet +``` +Get-AzSqlInstanceKeyVaultKey [[-KeyId] <String>] [-Instance] <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AddAzureRmSqlManagedInstanceKeyVaultKeyResourceIdParameterSet +``` +Get-AzSqlInstanceKeyVaultKey [[-KeyId] <String>] [-InstanceResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlInstanceKeyVaultKey cmdlet gets information about the Key Vault keys on a SQL managed instance. You can view all keys on a managed instance or view a specific key by providing the KeyId. + +## EXAMPLES + +### Example 1: Get all Key Vault keys +```powershell +Get-AzSqlInstanceKeyVaultKey -ResourceGroupName 'ContosoResourceGroup' -InstanceName 'ContosoManagedInstanceName' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901 +CreationDate : 9/1/2018 12:11:49 AM +Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1 +Type : AzureKeyVault +``` + +This command gets all the Key Vault keys on a SQL managed instance. + +### Example 2: Get a specific Key Vault key +```powershell +Get-AzSqlInstanceKeyVaultKey -ResourceGroupName 'ContosoResourceGroup' -InstanceName 'ContosoManagedInstanceName' -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901 +CreationDate : 9/1/2018 12:11:49 AM +Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1 +Type : AzureKeyVault +``` + +This command gets the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901'. + +### Example 3: Using instance object +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +Get-AzSqlInstanceKeyVaultKey -Instance $managedInstance -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901 +CreationDate : 9/1/2018 12:11:49 AM +Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1 +Type : AzureKeyVault +``` + +This command gets the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901'. + +### Example 4: Using instance resource id +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +Get-AzSqlInstanceKeyVaultKey -InstanceResourceId $managedInstance.ResourceId -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901 +CreationDate : 9/1/2018 12:11:49 AM +Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1 +Type : AzureKeyVault +``` + +This command gets the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901'. + +### Example 5: Using piping +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +$managedInstance | Get-AzSqlInstanceKeyVaultKey -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901 +CreationDate : 9/1/2018 12:11:49 AM +Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1 +Type : AzureKeyVault +``` + +This command gets the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +The instance input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: AddAzureRmSqlManagedInstanceKeyVaultKeyInputObjectParameterSet +Aliases: InputObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The instance name + +```yaml +Type: System.String +Parameter Sets: AddAzureRmSqlManagedInstanceKeyVaultKeyDefaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceResourceId +The instance resource id + +```yaml +Type: System.String +Parameter Sets: AddAzureRmSqlManagedInstanceKeyVaultKeyResourceIdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyId +AzureKeyVault key id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: AddAzureRmSqlManagedInstanceKeyVaultKeyDefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureRmSqlManagedInstanceKeyVaultKeyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceLink.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceLink.md new file mode 100644 index 0000000000..93338ed0bd --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceLink.md @@ -0,0 +1,438 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancelink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceLink.md +--- + +# Get-AzSqlInstanceLink + +## SYNOPSIS +Returns information about link feature for Azure SQL Managed Instance. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSqlInstanceLink [-ResourceGroupName] <String> [-InstanceName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSqlInstanceLink [[-Name] <String>] [-InstanceObject] <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInstanceResourceIdParameterSet +``` +Get-AzSqlInstanceLink [[-Name] <String>] [-InstanceResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSqlInstanceLink [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceLink** cmdlet returns information about one or more instance of Azure SQL Managed Instance links. Specify the name of a link to see information for that link only. + +## EXAMPLES + +### Example 1: Get information about an active link on Azure SQL Managed Instance +```powershell +Get-AzSqlInstanceLink -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "Link01" +``` + +```Output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command gets information about the instance link named "Link01" on instance "Instance01" and resource group "ResourceGroup01". + +### Example 2: Get information about all active links on Azure SQL Managed Instance +```powershell +Get-AzSqlInstanceLink -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" +``` + +```Output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link02 +Name : Link02 +TargetDatabase : Database02 +SourceEndpoint : TCP://SERVER02:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command gets information about all active instance links on instance "ManagedInstance01" and resource group "ResourceGroup01". + +### Example 3: Get all instance links on Azure SQL Managed Instance using Instance object +```powershell +$instance = Get-AzSqlInstance -Name "ManagedInstance01" -ResourceGroupName "ResourceGroup01" +Get-AzSqlInstanceLink -InstanceObject $instance +``` + +```Output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link02 +Name : Link02 +TargetDatabase : Database02 +SourceEndpoint : TCP://SERVER02:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command gets information on all active instance links on the instance "ManagedInstance01". + +### Example 4: Get all instance links on Azure SQL Managed Instance using resource identifier +```powershell +Get-AzSqlInstanceLink -InstanceResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01" +``` + +```Output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link02 +Name : Link02 +TargetDatabase : Database02 +SourceEndpoint : TCP://SERVER02:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command gets information about all instance links for the instance "ManagedInstance01". + +### Example 5: Get an instance link using its resource identifier +```powershell +Get-AzSqlInstanceLink -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01" +``` + +```Output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command gets information about the instance link named "Link01". + +### Example 6: Get all instance links for a Managed Instance by piping an instance object +```powershell +Get-AzSqlInstance -Name "ManagedInstance01" -ResourceGroupName "ResourceGroup01" | Get-AzSqlInstanceLink +``` + +```Output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link02 +Name : Link02 +TargetDatabase : Database02 +SourceEndpoint : TCP://SERVER02:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command gets information about all instance links within the instance "ManagedInstance01". + +### Example 7: Get a specific instance link for an instance by piping an instance object and specifying the link name +```powershell +Get-AzSqlInstance -Name "ManagedInstance01" -ResourceGroupName "ResourceGroup01" | Get-AzSqlInstanceLink -Name "Link01" +``` + +```Output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command gets information about the instance link named "Link01: within the instance "Instance01". + +### Example 8: Get information about instance link using positional parameters +```powershell +Get-AzSqlInstanceLink "ResourceGroup01" "ManagedInstance01" "Link01" +``` + +```Output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command gets information about the instance link named "Link01" on instance "Instance01" and resource group "ResourceGroup01". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +Instance input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceResourceId +Managed instance resource ID. + +```yaml +Type: System.String +Parameter Sets: GetByInstanceResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the instance link. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet, GetByInstanceResourceIdParameterSet +Aliases: LinkName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The instance link resource ID. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstanceHybridLink.Model.AzureSqlManagedInstanceLinkModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlInstanceLink](./New-AzSqlInstanceLink.md) + +[Update-AzSqlInstanceLink](./Update-AzSqlInstanceLink.md) + +[Remove-AzSqlInstanceLink](./Remove-AzSqlInstanceLink.md) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceOperation.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceOperation.md new file mode 100644 index 0000000000..8d4f7dcf00 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceOperation.md @@ -0,0 +1,234 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstanceoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceOperation.md +--- + +# Get-AzSqlInstanceOperation + +## SYNOPSIS +Gets a SQL managed instance's operations. + +## SYNTAX + +### DefaultParameterSet (Default) +``` +Get-AzSqlInstanceOperation [-Name <String>] -ManagedInstanceName <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByManagedInstanceOperationResourceIdentifierParameterSet +``` +Get-AzSqlInstanceOperation [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ListByManagedInstanceParameterSet +``` +Get-AzSqlInstanceOperation -ManagedInstanceName <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlInstanceOperation cmdlet gets information about the operations on a SQL managed instance. You can view all operations on a managed instance or view a specific operation by providing the operation name. + +## EXAMPLES + +### Example 1: Get all instance's operations +```powershell +Get-AzSqlInstanceOperation -ResourceGroupName ps3753 -ManagedInstanceName ps3698 +``` + +```output +Id : /subscriptions/a8c9a924-06c0-4bde-9788-e7b1370969e1/resourceGroups/ps3753/providers/Microsoft.Sql/managedInstances/ps3698/operations/5870c6d8-6703-4b27-8ae4-687b4ca7caea +ResourceGroupName : ps3753 +ManagedInstanceName : ps3698 +Name : 5870c6d8-6703-4b27-8ae4-687b4ca7caea +Operation : UpsertManagedServer +OperationFriendlyName : UPDATE MANAGED SERVER +PercentComplete : 100 +StartTime : 3/16/2020 8:11:13 AM +State : Succeeded +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : +EstimatedCompletionTime : +Description : +IsCancellable : False +OperationParameters : Microsoft.Azure.Management.Sql.Models.ManagedInstanceOperationParametersPair +OperationSteps : Microsoft.Azure.Management.Sql.Models.ManagedInstanceOperationSteps + +Id : /subscriptions/a8c9a924-06c0-4bde-9788-e7b1370969e1/resourceGroups/ps3753/providers/Microsoft.Sql/managedInstances/ps3698/operations/79f2c91b-0080-4c14-b9b4-d9991c6e82dd +ResourceGroupName : ps3753 +ManagedInstanceName : ps3698 +Name : 79f2c91b-0080-4c14-b9b4-d9991c6e82dd +Operation : UpsertManagedServer +OperationFriendlyName : UPDATE MANAGED SERVER +PercentComplete : 100 +StartTime : 3/16/2020 8:19:53 AM +State : Cancelled +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : +EstimatedCompletionTime : +Description : +IsCancellable : False +OperationParameters : Microsoft.Azure.Management.Sql.Models.ManagedInstanceOperationParametersPair +OperationSteps : Microsoft.Azure.Management.Sql.Models.ManagedInstanceOperationSteps +``` + +This command gets all operations a SQL managed instance. + +### Example 2: Get a specific operation +```powershell +Get-AzSqlInstanceOperation -ResourceGroupName ps3753 -ManagedInstanceName ps3698 -Name 5870c6d8-6703-4b27-8ae4-687b4ca7caea +``` + +```output +Id : /subscriptions/a8c9a924-06c0-4bde-9788-e7b1370969e1/resourceGroups/ps3753/providers/Microsoft.Sql/managedInstances/ps3698/operations/5870c6d8-6703-4b27-8ae4-687b4ca7caea +ResourceGroupName : ps3753 +ManagedInstanceName : ps3698 +Name : 5870c6d8-6703-4b27-8ae4-687b4ca7caea +Operation : UpsertManagedServer +OperationFriendlyName : UPDATE MANAGED SERVER +PercentComplete : 100 +StartTime : 3/16/2020 8:11:13 AM +State : Succeeded +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : +EstimatedCompletionTime : +Description : +IsCancellable : False +OperationParameters : Microsoft.Azure.Management.Sql.Models.ManagedInstanceOperationParametersPair +OperationSteps : Microsoft.Azure.Management.Sql.Models.ManagedInstanceOperationSteps +``` + +This command gets operation with name '5870c6d8-6703-4b27-8ae4-687b4ca7caea' on a SQL managed instance. + +### Example 3: Using operation resource id +```powershell +$managedInstanceOperation = Get-AzSqlInstanceOperation -ResourceGroupName ps3753 -ManagedInstanceName ps3698 -Name 5870c6d8-6703-4b27-8ae4-687b4ca7caea +Get-AzSqlInstanceOperation -ResourceId $managedInstanceOperation.Id +``` + +```output +Id : /subscriptions/a8c9a924-06c0-4bde-9788-e7b1370969e1/resourceGroups/ps3753/providers/Microsoft.Sql/managedInstances/ps3698/operations/5870c6d8-6703-4b27-8ae4-687b4ca7caea +ResourceGroupName : ps3753 +ManagedInstanceName : ps3698 +Name : 5870c6d8-6703-4b27-8ae4-687b4ca7caea +Operation : UpsertManagedServer +OperationFriendlyName : UPDATE MANAGED SERVER +PercentComplete : 100 +StartTime : 3/16/2020 8:11:13 AM +State : Succeeded +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : +EstimatedCompletionTime : +Description : +IsCancellable : False +OperationParameters : Microsoft.Azure.Management.Sql.Models.ManagedInstanceOperationParametersPair +OperationSteps : Microsoft.Azure.Management.Sql.Models.ManagedInstanceOperationSteps +``` + +This command gets operation with id '/subscriptions/a8c9a924-06c0-4bde-9788-e7b1370969e1/resourceGroups/ps3753/providers/Microsoft.Sql/managedInstances/ps3698/operations/5870c6d8-6703-4b27-8ae4-687b4ca7caea'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedInstanceName +The name of the instance. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet, ListByManagedInstanceParameterSet +Aliases: InstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Name +The name of the operation. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet +Aliases: OperationName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultParameterSet, ListByManagedInstanceParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The managed instance operation resource identifier. + +```yaml +Type: System.String +Parameter Sets: GetByManagedInstanceOperationResourceIdentifierParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstanceOperation.Model.AzureSqlManagedInstanceOperationModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstancePool.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstancePool.md new file mode 100644 index 0000000000..26bc5db501 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstancePool.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancepool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstancePool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstancePool.md +--- + +# Get-AzSqlInstancePool + +## SYNOPSIS +Returns information about the Azure SQL Instance pool. + +## SYNTAX + +### ListBySubOrResourceGroupParameterSet (Default) +``` +Get-AzSqlInstancePool [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### ListByInstancePoolDefaultsParameterSet +``` +Get-AzSqlInstancePool -ResourceGroupName <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetInstancePoolByInstancePoolResourceIdentifierParameterSet +``` +Get-AzSqlInstancePool [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstancePool** cmdlet returns information about one or more Azure SQL Instance pool. +Specify the name of an instance pool to see information for only that instance pool. + +## EXAMPLES + +### Example 1: Get all instance pools across a customer subscription +```powershell +Get-AzSqlInstancePool +``` + +```output +ResourceGroupName : resourcegroup01 +Type : Microsoft.Sql/instancePools +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0 +InstancePoolName : instancePool0 +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +VCores : 8 +ComputeGeneration : Gen5 +Edition : GeneralPurpose +Tags : +Sku : Microsoft.Azure.Management.Sql.Models.Sku +Location : canadacentral +LicenseType : LicenseIncluded + +ResourceGroupName : resourcegroup02 +Type : Microsoft.Sql/instancePools +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup02/providers/Microsoft.Sql/instancePools/ps-instancepool-1 +InstancePoolName : instancePool0 +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup02/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +VCores : 8 +ComputeGeneration : Gen5 +Edition : GeneralPurpose +Tags : +Sku : Microsoft.Azure.Management.Sql.Models.Sku +Location : canadacentral +LicenseType : LicenseIncluded +``` + +This command gets information about all instance pools within the customer subscription. + +### Example 2: Get all instance pools across a resource group +```powershell +Get-AzSqlInstancePool -ResourceGroupName resourcegroup01 +``` + +```output +ResourceGroupName : resourcegroup01 +Type : Microsoft.Sql/instancePools +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0 +InstancePoolName : instancePool0 +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +VCores : 8 +ComputeGeneration : Gen5 +Edition : GeneralPurpose +Tags : +Sku : Microsoft.Azure.Management.Sql.Models.Sku +Location : canadacentral +LicenseType : LicenseIncluded +``` + +This command gets information about all instance pools within the resource group resourcegroup01. + +### Example 3: Get information about an instance pool +```powershell +Get-AzSqlInstancePool -ResourceGroupName resourcegroup01 -Name instancePool0 +``` + +```output +ResourceGroupName : resourcegroup01 +Type : Microsoft.Sql/instancePools +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0 +InstancePoolName : instancePool0 +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +VCores : 8 +ComputeGeneration : Gen5 +Edition : GeneralPurpose +Tags : +Sku : Microsoft.Azure.Management.Sql.Models.Sku +Location : canadacentral +LicenseType : LicenseIncluded +``` + +This command gets information about the instance pool instancePool0. + +### Example 4: Get information about an instance pool using instance pool resource id +```powershell +Get-AzSqlInstancePool -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0" +``` + +```output +ResourceGroupName : resourcegroup01 +Type : Microsoft.Sql/instancePools +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0 +InstancePoolName : instancePool0 +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +VCores : 8 +ComputeGeneration : Gen5 +Edition : GeneralPurpose +Tags : +Sku : Microsoft.Azure.Management.Sql.Models.Sku +Location : canadacentral +LicenseType : LicenseIncluded +``` + +This command gets information about the instance pool with its resource identifier. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The instance pool name. + +```yaml +Type: System.String +Parameter Sets: ListByInstancePoolDefaultsParameterSet +Aliases: InstancePoolName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: ListBySubOrResourceGroupParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ListByInstancePoolDefaultsParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The instance pool resource identifier. + +```yaml +Type: System.String +Parameter Sets: GetInstancePoolByInstancePoolResourceIdentifierParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Instance_Pools.Model.AzureSqlInstancePoolModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstancePoolUsage.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstancePoolUsage.md new file mode 100644 index 0000000000..32f067f51d --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstancePoolUsage.md @@ -0,0 +1,304 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancepoolusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstancePoolUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstancePoolUsage.md +--- + +# Get-AzSqlInstancePoolUsage + +## SYNOPSIS +Returns information about an Azure SQL Instance pool's usage. + +## SYNTAX + +### InstancePoolUsageDefaultParameterSet (Default) +``` +Get-AzSqlInstancePoolUsage [-ResourceGroupName] <String> [-Name] <String> [-ExpandChildren] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InstancePoolUsageParentObjectParameterSet +``` +Get-AzSqlInstancePoolUsage [-InstancePool] <AzureSqlInstancePoolModel> [-ExpandChildren] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### InstancePoolUsageResourceIdParameterSet +``` +Get-AzSqlInstancePoolUsage [-ResourceId] <String> [-ExpandChildren] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstancePoolUsage** cmdlet returns information an Azure SQL Instance pool's usage. + +## EXAMPLES + +### Example 1 : Gets the usage of an Azure SQL Instance pool +```powershell +Get-AzSqlInstancePoolUsage -ResourceGroupName resourcegroup01 -Name instancepool0 +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/vcore_utilization +CurrentValue : 2 +Limit : 8 +RequestedLimit : +Unit : VCores +Name : VCore utilization +Type : Microsoft.Sql/instancePools/usages + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/storage_utilization +CurrentValue : 32 +Limit : 8192 +RequestedLimit : +Unit : Gigabytes +Name : Storage utilization +Type : Microsoft.Sql/instancePools/usages + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/database_utilization +CurrentValue : 0 +Limit : 100 +RequestedLimit : +Unit : Number Of Databases +Name : Database utilization +Type : Microsoft.Sql/instancePools/usages +``` + +Gets the usage for the Azure SQL Instance pool instancepool0. + +### Example 2: Gets the usage of an Azure SQL Instance pool using an instance pool object +```powershell +$instancePool = Get-AzSqlInstancePool -ResourceGroupName resourcegroup01 -Name instancepool0 +Get-AzSqlInstancePoolUsage -InstancePool $instancePool +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/vcore_utilization +CurrentValue : 2 +Limit : 8 +RequestedLimit : +Unit : VCores +Name : VCore utilization +Type : Microsoft.Sql/instancePools/usages + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/storage_utilization +CurrentValue : 32 +Limit : 8192 +RequestedLimit : +Unit : Gigabytes +Name : Storage utilization +Type : Microsoft.Sql/instancePools/usages + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/database_utilization +CurrentValue : 0 +Limit : 100 +RequestedLimit : +Unit : Number Of Databases +Name : Database utilization +Type : Microsoft.Sql/instancePools/usages +``` + +Gets the usage for the Azure SQL Instance pool instancepool0 using an instance pool object. + +### Example 3: Gets the usage of an Azure SQL Instance pool using an instance pool resource id +```powershell +Get-AzSqlInstancePoolUsage -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0" +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/vcore_utilization +CurrentValue : 2 +Limit : 8 +RequestedLimit : +Unit : VCores +Name : VCore utilization +Type : Microsoft.Sql/instancePools/usages + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/storage_utilization +CurrentValue : 32 +Limit : 8192 +RequestedLimit : +Unit : Gigabytes +Name : Storage utilization +Type : Microsoft.Sql/instancePools/usages + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/database_utilization +CurrentValue : 0 +Limit : 100 +RequestedLimit : +Unit : Number Of Databases +Name : Database utilization +Type : Microsoft.Sql/instancePools/usages +``` + +Gets the usage for the Azure SQL Instance pool instancepool0 using an instance pool resource identifier. + +### Example 3: Gets the usage of an Azure SQL Instance pool with a breakdown of the managed instance usages within the pool. +```powershell +Get-AzSqlInstancePoolUsage -ResourceGroupName resourcegroup01 -Name instancepool0 -ExpandChildren +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/vcore_utilization +CurrentValue : 2 +Limit : 8 +RequestedLimit : +Unit : VCores +Name : VCore utilization +Type : Microsoft.Sql/instancePools/usages + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/storage_utilization +CurrentValue : 32 +Limit : 8192 +RequestedLimit : +Unit : Gigabytes +Name : Storage utilization +Type : Microsoft.Sql/instancePools/usages + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/database_utilization +CurrentValue : 0 +Limit : 100 +RequestedLimit : +Unit : Number Of Databases +Name : Database utilization +Type : Microsoft.Sql/instancePools/usages + +Id : /subscriptions/2e7fe4bd-90c7-454e-8bb6-dc44649f27b2/resourceGroups/poolsPS/providers/Microsoft.Sql/instancePools/instancepool0/managedInstances/managedinstance0/usages/vcore_utilization +CurrentValue : +Limit : 2 +RequestedLimit : +Unit : VCores +Name : VCore utilization +Type : Microsoft.Sql/instancePools/managedInstances/usages + +Id : /subscriptions/2e7fe4bd-90c7-454e-8bb6-dc44649f27b2/resourceGroups/poolsPS/providers/Microsoft.Sql/instancePools/instancepool0/managedInstances/managedinstance0/usages/storage_utilization +CurrentValue : +Limit : 32 +RequestedLimit : +Unit : Gigabytes +Name : Storage utilization +Type : Microsoft.Sql/instancePools/managedInstances/usages + +Id : /subscriptions/2e7fe4bd-90c7-454e-8bb6-dc44649f27b2/resourceGroups/poolsPS/providers/Microsoft.Sql/instancePools/instancepool0/managedInstances/managedinstance0/usages/database_utilization +CurrentValue : 0 +Limit : 100 +RequestedLimit : +Unit : Number Of Databases +Name : Database utilization +Type : Microsoft.Sql/instancePools/managedInstances/usages +``` + +Gets the usage for the Azure SQL Instance pool instancepool0 along with the usages of the managed instances within instancepool0. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandChildren +Flag indicating whether to expand this instance pool's usage with its children's usage. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstancePool +The parent instance pool object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Instance_Pools.Model.AzureSqlInstancePoolModel +Parameter Sets: InstancePoolUsageParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The managed instance pool name. + +```yaml +Type: System.String +Parameter Sets: InstancePoolUsageDefaultParameterSet +Aliases: InstancePoolName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name. + +```yaml +Type: System.String +Parameter Sets: InstancePoolUsageDefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The parent resource id. + +```yaml +Type: System.String +Parameter Sets: InstancePoolUsageResourceIdParameterSet +Aliases: InstancePoolResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Instance_Pools.Model.AzureSqlInstancePoolModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Usages.Models.AzureSqlUsageModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceServerTrustCertificate.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceServerTrustCertificate.md new file mode 100644 index 0000000000..6a3f489dac --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceServerTrustCertificate.md @@ -0,0 +1,344 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstanceservertrustcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceServerTrustCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceServerTrustCertificate.md +--- + +# Get-AzSqlInstanceServerTrustCertificate + +## SYNOPSIS +Returns information about server trust certificate. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSqlInstanceServerTrustCertificate [-ResourceGroupName] <String> [-InstanceName] <String> + [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSqlInstanceServerTrustCertificate [[-Name] <String>] [-InstanceObject] <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInstanceResourceIdParameterSet +``` +Get-AzSqlInstanceServerTrustCertificate [[-Name] <String>] [-InstanceResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSqlInstanceServerTrustCertificate [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +**Get-AzSqlInstanceServerTrustCertificate** cmdlet returns information about one or more instance of server trust certificate on an Azure SQL Managed Instance. Specify the name of a certificate to see information for that certificate only. + +## EXAMPLES + +### Example 1: Get information about all server trust certificates on Azure SQL Managed Instance +```powershell +Get-AzSqlInstanceServerTrustCertificate -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate01 +Thumbprint : 0x7D989DF34BD0FD0D2F9F6B3B6A7096856F5AB004 +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate02 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate02 +Thumbprint : 0x628B41E23E513EAF9C03F8E2C8A881E0D33D385B +PublicKey : 0x5D014B47F6AF7D0469A853C84180445C146015D5098F09AC673A49281EDA9D3C560039BAFBD02617BF94DF30B505AA2CA891E3F80BD0056F39B21396F675EBAEA148A12C3EED8F7DE6753A2AAC722EEB1D3A71633A00909F720E74180CC9D7B51E84BEFDDC6A64C7015368FB041E59E836F3968739E7B84654FEDA396BD7E89C9AFCCF4086F8838A1FD5F833C1288EB619A14F68F15094D8BB4DD834F64333AF44A7C0CC5BF4406C408702993B14D04A20772EE23A0C7FED3D89B754EA66C23FDAE65AEAD53F55AE82ADEEDC8B730352D1A0933AD28745FCCA960FAD3AE12693175DA3A14CCF37B221AC35DEF986A9758EAB7DEFB334FF65BBAF8C5F4377F51224459B349CFDDC51A6D5DC9937477EF869CAE4B4165E8A4DC83B3E9D9B7A80E3C0C591DEE00A776E4C1915EDEF276D23BEEDEBF2E673F02857E909B0CEFD6C8D96C8B6E91E1753858974F24D37D0E85558D2A40C82E06B2BF6002CD57ABBEEF8C8C43EBEC5F2624E4E882E3094E62FC7624D2C52DD73DC0C618F1AB96D39316E2E16E301ABDE4FE267DE88425CBFCA9F3131D4FED6BDF7F296B5A7BAC4CB2F9E4A48F0C6BE822B611002A9785A60692F9B25A1EAA7F279FEF4BF5E2BDEA8BEC4E3417E9936E542A19F9D19880065B003537A514754F09ADFA9A08D067BF34D3BEBC56BF4D970526A20886CE25BEB1174496F2AB9BC884BEC3A885875FEF4DBA60F682F68354C40B3E7C3DF62666DA0D655B0BC9EB0A1E470EDF58538DD848ECB5700BD632175644D50C713BFC1ACDC94F6600331F7C14AE8A63C1396699662CF1D5BD668C1BCE1E9AA0A2B5DDDC62294841958A36C03E9D211AA4352FA2918962452F73831B843412725766728AE7BB18B863D1B267AAA5FAB9B735FE50E6B1DF43BD4FA33F5004AECBA0BFD9D704F22AE1F15FD7F7DDF839868F7A7FDDB03C167520CF1A61CA62D057CB89052695EBCA0248E2429457437044EDA2CF89AFF27C8BB4D779A177137D9C9FCA03B169004066A1D92B53A601ABC5EBF9603AEA1FE9798C001C3B058E0F8892AD592920955CBBE5403868B06F90D7011D9390793CA611883D774853559DA0CBBDE2C25FC5FED3197CFC1725137FFF221DC152F2C906972 +``` + +This command gets information about all server trust certificates within the instance "ManagedInstance01". + +### Example 2: Get information about a server trust certificate on Azure SQL Managed Instance +```powershell +Get-AzSqlInstanceServerTrustCertificate -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "Certificate01" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate01 +Thumbprint : 0x7D989DF34BD0FD0D2F9F6B3B6A7096856F5AB004 +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 +``` + +This command gets information about the server trust certificate "Certificate01" on instance "ManagedInstance01" and resource group "ResourceGroup01". + +### Example 3: Get all server trust certificates on Azure SQL Managed Instance using Instance object +```powershell +$instance = Get-AzSqlInstance -Name "ManagedInstance01" -ResourceGroupName "ResourceGroup01" +Get-AzSqlInstanceServerTrustCertificate -InstanceObject $instance +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate01 +Thumbprint : 0x7D989DF34BD0FD0D2F9F6B3B6A7096856F5AB004 +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate02 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate02 +Thumbprint : 0x628B41E23E513EAF9C03F8E2C8A881E0D33D385B +PublicKey : 0x5D014B47F6AF7D0469A853C84180445C146015D5098F09AC673A49281EDA9D3C560039BAFBD02617BF94DF30B505AA2CA891E3F80BD0056F39B21396F675EBAEA148A12C3EED8F7DE6753A2AAC722EEB1D3A71633A00909F720E74180CC9D7B51E84BEFDDC6A64C7015368FB041E59E836F3968739E7B84654FEDA396BD7E89C9AFCCF4086F8838A1FD5F833C1288EB619A14F68F15094D8BB4DD834F64333AF44A7C0CC5BF4406C408702993B14D04A20772EE23A0C7FED3D89B754EA66C23FDAE65AEAD53F55AE82ADEEDC8B730352D1A0933AD28745FCCA960FAD3AE12693175DA3A14CCF37B221AC35DEF986A9758EAB7DEFB334FF65BBAF8C5F4377F51224459B349CFDDC51A6D5DC9937477EF869CAE4B4165E8A4DC83B3E9D9B7A80E3C0C591DEE00A776E4C1915EDEF276D23BEEDEBF2E673F02857E909B0CEFD6C8D96C8B6E91E1753858974F24D37D0E85558D2A40C82E06B2BF6002CD57ABBEEF8C8C43EBEC5F2624E4E882E3094E62FC7624D2C52DD73DC0C618F1AB96D39316E2E16E301ABDE4FE267DE88425CBFCA9F3131D4FED6BDF7F296B5A7BAC4CB2F9E4A48F0C6BE822B611002A9785A60692F9B25A1EAA7F279FEF4BF5E2BDEA8BEC4E3417E9936E542A19F9D19880065B003537A514754F09ADFA9A08D067BF34D3BEBC56BF4D970526A20886CE25BEB1174496F2AB9BC884BEC3A885875FEF4DBA60F682F68354C40B3E7C3DF62666DA0D655B0BC9EB0A1E470EDF58538DD848ECB5700BD632175644D50C713BFC1ACDC94F6600331F7C14AE8A63C1396699662CF1D5BD668C1BCE1E9AA0A2B5DDDC62294841958A36C03E9D211AA4352FA2918962452F73831B843412725766728AE7BB18B863D1B267AAA5FAB9B735FE50E6B1DF43BD4FA33F5004AECBA0BFD9D704F22AE1F15FD7F7DDF839868F7A7FDDB03C167520CF1A61CA62D057CB89052695EBCA0248E2429457437044EDA2CF89AFF27C8BB4D779A177137D9C9FCA03B169004066A1D92B53A601ABC5EBF9603AEA1FE9798C001C3B058E0F8892AD592920955CBBE5403868B06F90D7011D9390793CA611883D774853559DA0CBBDE2C25FC5FED3197CFC1725137FFF221DC152F2C906972 +``` + +This command gets information about all server trust certificates within the instance "ManagedInstance01". + +### Example 4: Get all server trust certificates on Azure SQL Managed Instance using resource identifier + +```powershell +Get-AzSqlInstanceServerTrustCertificate -InstanceResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate01 +Thumbprint : 0x7D989DF34BD0FD0D2F9F6B3B6A7096856F5AB004 +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate02 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate02 +Thumbprint : 0x628B41E23E513EAF9C03F8E2C8A881E0D33D385B +PublicKey : 0x5D014B47F6AF7D0469A853C84180445C146015D5098F09AC673A49281EDA9D3C560039BAFBD02617BF94DF30B505AA2CA891E3F80BD0056F39B21396F675EBAEA148A12C3EED8F7DE6753A2AAC722EEB1D3A71633A00909F720E74180CC9D7B51E84BEFDDC6A64C7015368FB041E59E836F3968739E7B84654FEDA396BD7E89C9AFCCF4086F8838A1FD5F833C1288EB619A14F68F15094D8BB4DD834F64333AF44A7C0CC5BF4406C408702993B14D04A20772EE23A0C7FED3D89B754EA66C23FDAE65AEAD53F55AE82ADEEDC8B730352D1A0933AD28745FCCA960FAD3AE12693175DA3A14CCF37B221AC35DEF986A9758EAB7DEFB334FF65BBAF8C5F4377F51224459B349CFDDC51A6D5DC9937477EF869CAE4B4165E8A4DC83B3E9D9B7A80E3C0C591DEE00A776E4C1915EDEF276D23BEEDEBF2E673F02857E909B0CEFD6C8D96C8B6E91E1753858974F24D37D0E85558D2A40C82E06B2BF6002CD57ABBEEF8C8C43EBEC5F2624E4E882E3094E62FC7624D2C52DD73DC0C618F1AB96D39316E2E16E301ABDE4FE267DE88425CBFCA9F3131D4FED6BDF7F296B5A7BAC4CB2F9E4A48F0C6BE822B611002A9785A60692F9B25A1EAA7F279FEF4BF5E2BDEA8BEC4E3417E9936E542A19F9D19880065B003537A514754F09ADFA9A08D067BF34D3BEBC56BF4D970526A20886CE25BEB1174496F2AB9BC884BEC3A885875FEF4DBA60F682F68354C40B3E7C3DF62666DA0D655B0BC9EB0A1E470EDF58538DD848ECB5700BD632175644D50C713BFC1ACDC94F6600331F7C14AE8A63C1396699662CF1D5BD668C1BCE1E9AA0A2B5DDDC62294841958A36C03E9D211AA4352FA2918962452F73831B843412725766728AE7BB18B863D1B267AAA5FAB9B735FE50E6B1DF43BD4FA33F5004AECBA0BFD9D704F22AE1F15FD7F7DDF839868F7A7FDDB03C167520CF1A61CA62D057CB89052695EBCA0248E2429457437044EDA2CF89AFF27C8BB4D779A177137D9C9FCA03B169004066A1D92B53A601ABC5EBF9603AEA1FE9798C001C3B058E0F8892AD592920955CBBE5403868B06F90D7011D9390793CA611883D774853559DA0CBBDE2C25FC5FED3197CFC1725137FFF221DC152F2C906972 +``` + +This command gets information about all server trust certificates within the instance "ManagedInstance01". + +### Example 5: Get a server trust certificate using its resource identifier + +```powershell +Get-AzSqlInstanceServerTrustCertificate -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate01 +Thumbprint : 0x7D989DF34BD0FD0D2F9F6B3B6A7096856F5AB004 +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 +``` + +This command gets information about the server trust certificate named "Certificate01". + +### Example 6: Get all server trust certificates for a Managed Instance by piping an instance object + +```powershell +Get-AzSqlInstance -Name "ManagedInstance01" -ResourceGroupName "ResourceGroup01" | Get-AzSqlInstanceServerTrustCertificate +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate01 +Thumbprint : 0x7D989DF34BD0FD0D2F9F6B3B6A7096856F5AB004 +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate02 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate02 +Thumbprint : 0x628B41E23E513EAF9C03F8E2C8A881E0D33D385B +PublicKey : 0x5D014B47F6AF7D0469A853C84180445C146015D5098F09AC673A49281EDA9D3C560039BAFBD02617BF94DF30B505AA2CA891E3F80BD0056F39B21396F675EBAEA148A12C3EED8F7DE6753A2AAC722EEB1D3A71633A00909F720E74180CC9D7B51E84BEFDDC6A64C7015368FB041E59E836F3968739E7B84654FEDA396BD7E89C9AFCCF4086F8838A1FD5F833C1288EB619A14F68F15094D8BB4DD834F64333AF44A7C0CC5BF4406C408702993B14D04A20772EE23A0C7FED3D89B754EA66C23FDAE65AEAD53F55AE82ADEEDC8B730352D1A0933AD28745FCCA960FAD3AE12693175DA3A14CCF37B221AC35DEF986A9758EAB7DEFB334FF65BBAF8C5F4377F51224459B349CFDDC51A6D5DC9937477EF869CAE4B4165E8A4DC83B3E9D9B7A80E3C0C591DEE00A776E4C1915EDEF276D23BEEDEBF2E673F02857E909B0CEFD6C8D96C8B6E91E1753858974F24D37D0E85558D2A40C82E06B2BF6002CD57ABBEEF8C8C43EBEC5F2624E4E882E3094E62FC7624D2C52DD73DC0C618F1AB96D39316E2E16E301ABDE4FE267DE88425CBFCA9F3131D4FED6BDF7F296B5A7BAC4CB2F9E4A48F0C6BE822B611002A9785A60692F9B25A1EAA7F279FEF4BF5E2BDEA8BEC4E3417E9936E542A19F9D19880065B003537A514754F09ADFA9A08D067BF34D3BEBC56BF4D970526A20886CE25BEB1174496F2AB9BC884BEC3A885875FEF4DBA60F682F68354C40B3E7C3DF62666DA0D655B0BC9EB0A1E470EDF58538DD848ECB5700BD632175644D50C713BFC1ACDC94F6600331F7C14AE8A63C1396699662CF1D5BD668C1BCE1E9AA0A2B5DDDC62294841958A36C03E9D211AA4352FA2918962452F73831B843412725766728AE7BB18B863D1B267AAA5FAB9B735FE50E6B1DF43BD4FA33F5004AECBA0BFD9D704F22AE1F15FD7F7DDF839868F7A7FDDB03C167520CF1A61CA62D057CB89052695EBCA0248E2429457437044EDA2CF89AFF27C8BB4D779A177137D9C9FCA03B169004066A1D92B53A601ABC5EBF9603AEA1FE9798C001C3B058E0F8892AD592920955CBBE5403868B06F90D7011D9390793CA611883D774853559DA0CBBDE2C25FC5FED3197CFC1725137FFF221DC152F2C906972 +``` + +This command gets information about all server trust certificates within the instance "ManagedInstance01". + +### Example 7: Get a specific server trust certificate for an instance by piping an instance object and specifying the certificate name +```powershell +Get-AzSqlInstance -Name "ManagedInstance01" -ResourceGroupName "ResourceGroup01" | Get-AzSqlInstanceServerTrustCertificate -Name "Certificate01" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate01 +Thumbprint : 0x7D989DF34BD0FD0D2F9F6B3B6A7096856F5AB004 +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 +``` + +This command gets information about the server trust certificate named "Certificate01" on instance "ManagedInstance01" and resource group "ResourceGroup01". + +### Example 8: Get information about server trust certificate using positional parameters +```powershell +Get-AzSqlInstanceServerTrustCertificate "ResourceGroup01" "ManagedInstance01" "Certificate01" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate01 +Thumbprint : 0x7D989DF34BD0FD0D2F9F6B3B6A7096856F5AB004 +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 +``` + +This command gets information about the server trust certificate "Certificate01" on instance "ManagedInstance01" and resource group "ResourceGroup01". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +Instance input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceResourceId +Managed instance resource ID. + +```yaml +Type: System.String +Parameter Sets: GetByInstanceResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the certificate. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet, GetByInstanceResourceIdParameterSet +Aliases: CertificateName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Certificate resource ID. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerTrustCertificate.Model.AzureSqlInstanceServerTrustCertificateModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlInstanceServerTrustCertificate](./New-AzSqlInstanceServerTrustCertificate.md) + +[Remove-AzSqlInstanceServerTrustCertificate](./Remove-AzSqlInstanceServerTrustCertificate.md) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceTransparentDataEncryptionProtector.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceTransparentDataEncryptionProtector.md new file mode 100644 index 0000000000..0867b86a19 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceTransparentDataEncryptionProtector.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/Get-AzSqlInstanceTransparentDataEncryptionProtector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceTransparentDataEncryptionProtector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceTransparentDataEncryptionProtector.md +--- + +# Get-AzSqlInstanceTransparentDataEncryptionProtector + +## SYNOPSIS +Gets the Transparent Data Encryption (TDE) protector for a SQL managed instance. + +## SYNTAX + +### AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorDefaultParameterSet (Default) +``` +Get-AzSqlInstanceTransparentDataEncryptionProtector [-ResourceGroupName] <String> [-InstanceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorInputObjectParameterSet +``` +Get-AzSqlInstanceTransparentDataEncryptionProtector [-Instance] <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorResourceIdParameterSet +``` +Get-AzSqlInstanceTransparentDataEncryptionProtector [-InstanceResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlInstanceTransparentDataEncryptionProtector cmdlet gets the TDE protector for the specified SQL managed instance. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlInstanceTransparentDataEncryptionProtector -ResourceGroupName 'ContosoResourceGroup' -InstanceName 'ContosoManagedInstanceName' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +Type : AzureKeyVault +ManagedInstanceKeyVaultKeyName : contoso_contosokey_01234567890123456789012345678901 +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +``` + +This command gets the TDE protector for the managed instance named ContosoManagedInstanceName in resource group named ContosoResourceGroup. + +### Example 2: Using managed instance object +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +Get-AzSqlInstanceTransparentDataEncryptionProtector -Instance $managedInstance +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +Type : AzureKeyVault +ManagedInstanceKeyVaultKeyName : contoso_contosokey_01234567890123456789012345678901 +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +``` + +This command gets the TDE protector for the managed instance named ContosoManagedInstanceName in resource group named ContosoResourceGroup. + +### Example 3: Using managed instance resource id +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +Get-AzSqlInstanceTransparentDataEncryptionProtector -InstanceResourceId $managedInstance.ResourceId +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +Type : AzureKeyVault +ManagedInstanceKeyVaultKeyName : contoso_contosokey_01234567890123456789012345678901 +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +``` + +This command gets the TDE protector for the managed instance named ContosoManagedInstanceName in resource group named ContosoResourceGroup. + +### Example 4: Using piping +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +$managedInstance | Get-AzSqlInstanceTransparentDataEncryptionProtector +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +Type : AzureKeyVault +ManagedInstanceKeyVaultKeyName : contoso_contosokey_01234567890123456789012345678901 +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +``` + +This command gets the TDE protector for the managed instance named ContosoManagedInstanceName in resource group named ContosoResourceGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +The instance input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorInputObjectParameterSet +Aliases: InputObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The instance name + +```yaml +Type: System.String +Parameter Sets: AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorDefaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceResourceId +The instance resource id + +```yaml +Type: System.String +Parameter Sets: AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorResourceIdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorDefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureRmSqlManagedInstanceTransparentDataEncryptionProtectorModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlInstanceVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..ebc89eefb7 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlInstanceVulnerabilityAssessmentSetting.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlinstancevulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlInstanceVulnerabilityAssessmentSetting.md +--- + +# Get-AzSqlInstanceVulnerabilityAssessmentSetting + +## SYNOPSIS +Gets the vulnerability assessment settings of a managed instance. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSqlInstanceVulnerabilityAssessmentSetting [-ResourceGroupName] <String> [-InstanceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentResourceParameterSet +``` +Get-AzSqlInstanceVulnerabilityAssessmentSetting [-InputObject] <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlInstanceVulnerabilityAssessmentSetting** cmdlet gets the vulnerability assessment settings of an Azure SQL Managed Instance. +Note that you need to run *Enable-AzSqlInstanceAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1: Get the vulnerability assessment settings of an Azure SQL managed instance +```powershell +Get-AzSqlInstanceVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : None +EmailSubscriptionAdmins : False +NotificationEmail : {} +``` + +### Example 2: Get the vulnerability assessment settings of an Azure SQL managed instance from an Azure SQL managed instance object +```powershell +Get-AzSqlInstance ` + -ResourceGroupName "ResourceGroup01" ` + -Name "ManagedInstance01" ` + | Get-AzSqlInstanceVulnerabilityAssessmentSetting +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : None +EmailSubscriptionAdmins : False +NotificationEmail : {} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed instance object to get Vulnerability Assessment settings for + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: GetByParentResourceParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ManagedInstanceVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServer.md b/azps-10.1.0/Az.Sql/Get-AzSqlServer.md new file mode 100644 index 0000000000..9c59790d28 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServer.md @@ -0,0 +1,332 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: C39ACCAC-2BFF-48D0-95EA-D5B402D74D46 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServer.md +--- + +# Get-AzSqlServer + +## SYNOPSIS +Returns information about SQL Database servers. + +## SYNTAX + +``` +Get-AzSqlServer [[-ResourceGroupName] <String>] [[-ServerName] <String>] [-ExpandActiveDirectoryAdministrator] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServer** cmdlet returns information about one or more Azure SQL Database servers. +Specify the name of a server to see information for only that server. + +## EXAMPLES + +### Example 1: Get all instances of SQL Server assigned to a resource group +```powershell +Get-AzSqlServer -ResourceGroupName "ResourceGroup01" +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +Location : Central US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Identity : +FullyQualifiedDomainName : server01.database.windows.net + +ResourceGroupName : resourcegroup01 +ServerName : server02 +Location : West US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Identity : +FullyQualifiedDomainName : server02.database.windows.net +``` + +This command gets information about all the Azure SQL Database servers assigned to the resource group ResourceGroup01. + +### Example 2: Get information about an Azure SQL Database server +```powershell +Get-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +Location : Central US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Identity : +FullyQualifiedDomainName : server01.database.windows.net +``` + +This command gets information about the Azure SQL Database server named Server01. + +### Example 3: Get all instances of SQL Server in the subscription +```powershell +Get-AzResourceGroup | Get-AzSqlServer +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +Location : Central US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Identity : +FullyQualifiedDomainName : server01.database.windows.net + +ResourceGroupName : resourcegroup01 +ServerName : server02 +Location : West US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Identity : +FullyQualifiedDomainName : server02.database.windows.net + +ResourceGroupName : resourcegroup02 +ServerName : server03 +Location : East US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Identity : +FullyQualifiedDomainName : server03.database.windows.net +``` + +This command gets information about all the Azure SQL Database servers in the current subscription. + +### Example 4: Get all instances of SQL Server assigned to a resource group using filtering +```powershell +Get-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "server*" +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +Location : Central US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Identity : +FullyQualifiedDomainName : server01.database.windows.net + +ResourceGroupName : resourcegroup01 +ServerName : server02 +Location : West US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Identity : +FullyQualifiedDomainName : server02.database.windows.net +``` + +This command gets information about all the Azure SQL Database servers assigned to the resource group ResourceGroup01 that start with "server". + +### Example 5: Get all instances of SQL Server assigned to a resource group with external administrator information +<!-- Skip: Output cannot be splitted from code --> +```powershell +$val = Get-AzSqlServer -ResourceGroupName "ResourceGroup01" -ExpandActiveDirectoryAdministrator + +ResourceGroupName : resourcegroup01 +ServerName : server01 +Location : Central US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Identity : +FullyQualifiedDomainName : server01.database.windows.net +Administrators : Microsoft.Azure.Management.Sql.Models.ServerExternalAdministrator + +ResourceGroupName : resourcegroup01 +ServerName : server02 +Location : West US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Identity : +FullyQualifiedDomainName : server02.database.windows.net +Administrators : Microsoft.Azure.Management.Sql.Models.ServerExternalAdministrator + +$val.Administrators +AdministratorType : ActiveDirectory +PrincipalType : Group +Login : Dummy +Sid : df7667b8-f9fd-4029-a0e3-b43c75ce9538 +TenantId : f553829b-6d84-481b-86a9-42db57c1dc73 +AzureADOnlyAuthentication : True + +AdministratorType : ActiveDirectory +PrincipalType : Group +Login : Dummy2 +Sid : df7667b8-f9fd-4029-a0e3-b43c75ce9538 +TenantId : f553829b-6d84-481b-86a9-42db57c1dc73 +AzureADOnlyAuthentication : True +``` + +This command gets information about all the Azure SQL Database servers assigned to the resource group ResourceGroup01. + +### Example 6: Get information about an Azure SQL Database server with external administrator information +<!-- Skip: Output cannot be splitted from code --> +```powershell +$val = Get-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ExpandActiveDirectoryAdministrator +ResourceGroupName : resourcegroup01 +ServerName : server01 +Location : Central US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Identity : +FullyQualifiedDomainName : server01.database.windows.net +Administrators : Microsoft.Azure.Management.Sql.Models.ServerExternalAdministrator + +$val.Administrators +AdministratorType : ActiveDirectory +PrincipalType : Group +Login : Dummy +Sid : df7667b8-f9fd-4029-a0e3-b43c75ce9538 +TenantId : f553829b-6d84-481b-86a9-42db57c1dc73 +AzureADOnlyAuthentication : True +``` + +This command gets information about the Azure SQL Database server named Server01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandActiveDirectoryAdministrator +Expand Active Directory Administrator Information on the server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which servers are assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ServerName +Specifies the name of the server that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlServer](./New-AzSqlServer.md) + +[Remove-AzSqlServer](./Remove-AzSqlServer.md) + +[Set-AzSqlServer](./Set-AzSqlServer.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerActiveDirectoryAdministrator.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerActiveDirectoryAdministrator.md new file mode 100644 index 0000000000..cd306df2e9 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerActiveDirectoryAdministrator.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: FEDA14CF-632F-4D15-A22B-C73A1298094F +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserveractivedirectoryadministrator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerActiveDirectoryAdministrator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerActiveDirectoryAdministrator.md +--- + +# Get-AzSqlServerActiveDirectoryAdministrator + +## SYNOPSIS +Gets information about an Azure AD administrator for SQL Server. + +## SYNTAX + +``` +Get-AzSqlServerActiveDirectoryAdministrator [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerActiveDirectoryAdministrator** cmdlet gets information about an Azure Active Directory (Azure AD) administrator for an AzureSQL Server in the current subscription. + +## EXAMPLES + +### Example 1: Gets information about an administrator for a server +```powershell +Get-AzSqlServerActiveDirectoryAdministrator -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +```output +ResourceGroupName ServerName DisplayName ObjectId IsAzureADOnlyAuthentication +----------------- ---------- ----------- -------- ----------- +ResourceGroup01 Server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b true +``` + +This command gets information about an Azure AD administrator for a server named Server01 that is associated with a resource group named ResourceGroup01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the SQL Server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL Server for which this cmdlet gets information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel + +## NOTES + +## RELATED LINKS + +[Remove-AzSqlServerActiveDirectoryAdministrator](./Remove-AzSqlServerActiveDirectoryAdministrator.md) + +[Set-AzSqlServerActiveDirectoryAdministrator](./Set-AzSqlServerActiveDirectoryAdministrator.md) + +[Disable-AzSqlServerActiveDirectoryOnlyAuthentication](./Disable-AzSqlServerActiveDirectoryOnlyAuthentication.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerActiveDirectoryOnlyAuthentication.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerActiveDirectoryOnlyAuthentication.md new file mode 100644 index 0000000000..d80dc519b6 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerActiveDirectoryOnlyAuthentication.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserveractivedirectoryonlyauthentication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerActiveDirectoryOnlyAuthentication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerActiveDirectoryOnlyAuthentication.md +--- + +# Get-AzSqlServerActiveDirectoryOnlyAuthentication + +## SYNOPSIS +Gets Azure AD only authentication for a specific SQL Server. + +## SYNTAX + +### UseResourceGroupAndServerNameParameterSet (Default) +``` +Get-AzSqlServerActiveDirectoryOnlyAuthentication [-ResourceGroupName] <String> [-ServerName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UseInputObjectParameterSet +``` +Get-AzSqlServerActiveDirectoryOnlyAuthentication -InputObject <AzureSqlServerModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UserResourceIdParameterSet +``` +Get-AzSqlServerActiveDirectoryOnlyAuthentication [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerActiveDirectoryOnlyAuthentication** cmdlet gets Azure Active Directory (Azure AD) only authentication requirement for an AzureSQL Server in the current subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlServerActiveDirectoryOnlyAuthentication -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +```output +ResourceGroupName ServerName AzureADOnlyAuthentication +----------------- ---------- ----------- -------- ----------- +ResourceGroup01 Server01 True +``` + +This command gets Azure Active Directory (Azure AD) only authentication requirement for an AzureSQL server named Server01 that is associated with a resource group named ResourceGroup01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The SQL server object to use. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: UseInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndServerNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance to use + +```yaml +Type: System.String +Parameter Sets: UserResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the Azure Active Directory only authentication is in. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndServerNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryOnlyAuthenticationModel + +## NOTES + +## RELATED LINKS + +[Enable-AzSqlServerActiveDirectoryOnlyAuthentication](./Enable-AzSqlServerActiveDirectoryOnlyAuthentication.md) + +[Disable-AzSqlServerActiveDirectoryOnlyAuthentication](./Disable-AzSqlServerActiveDirectoryOnlyAuthentication.md) + +[Set-AzSqlServerActiveDirectoryAdministrator](./Set-AzSqlServerActiveDirectoryAdministrator.md) + +[Get-AzSqlServerActiveDirectoryAdministrator](./Get-AzSqlServerActiveDirectoryAdministrator.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerAdvancedDataSecurityPolicy.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerAdvancedDataSecurityPolicy.md new file mode 100644 index 0000000000..121406d965 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerAdvancedDataSecurityPolicy.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserveradvanceddatasecuritypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerAdvancedDataSecurityPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerAdvancedDataSecurityPolicy.md +--- + +# Get-AzSqlServerAdvancedDataSecurityPolicy + +## SYNOPSIS +Gets Advanced Data Security policy of a server. + +## SYNTAX + +``` +Get-AzSqlServerAdvancedDataSecurityPolicy [-InputObject <AzureSqlServerModel>] -ServerName <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerAdvancedDataSecurityPolicy** cmdlet retrieves the Advanced Data Security policy of a server. + +## EXAMPLES + +### Example 1: Gets server Advanced Data Security +```powershell +Get-AzSqlServerAdvancedDataSecurityPolicy ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +IsEnabled : True +``` + +### Example 2: Gets server Advanced Data Security from server resource +```powershell +Get-AzSqlServer ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + | Get-AzSqlServerAdvancedDataSecurityPolicy +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +IsEnabled : True +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The server object to use with Advanced Data Security policy operation + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.AdvancedThreatProtection.Model.ServerAdvancedDataSecurityPolicyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..229f576929 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerAdvancedThreatProtectionSetting.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: F26CB715-D66A-4672-AA47-F3B316957FC8 +online version: https://learn.microsoft.com/powershell/module/az.sql/Get-AzSqlServerAdvancedThreatProtectionSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerAdvancedThreatProtectionSetting.md +--- + +# Get-AzSqlServerAdvancedThreatProtectionSetting + +## SYNOPSIS +Gets the Advanced Threat Protection settings for a server. + +## SYNTAX + +``` +Get-AzSqlServerAdvancedThreatProtectionSetting -ServerName <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerAdvancedThreatProtectionSetting** cmdlet gets the Advanced Threat Protection settings of an Azure SQL server. +To use this cmdlet, specify the *ResourceGroupName* and *ServerName* parameters to identify the server for which this cmdlet gets the settings. + +## EXAMPLES + +### Example 1: Get the Advanced Threat Protection settings for a server +```powershell +Get-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" +``` + +```output +ResourceGroupName : ResourceGroup11 +ServerName : Server01 +AdvancedThreatProtectionState : Enabled +``` + +This command gets the Advanced Threat Protection settings for a server named Server01. +The server is assigned to the resource group ResourceGroup11. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.ServerAdvancedThreatProtectionSettingsModel + +## NOTES + +## RELATED LINKS + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerAdvisor.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerAdvisor.md new file mode 100644 index 0000000000..f89b499a7d --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerAdvisor.md @@ -0,0 +1,305 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: DAEF11C1-281B-4BED-9283-2296E0B57018 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserveradvisor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerAdvisor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerAdvisor.md +--- + +# Get-AzSqlServerAdvisor + +## SYNOPSIS +Gets one or more Advisors for an Azure SQL Server. + +## SYNTAX + +``` +Get-AzSqlServerAdvisor [-AdvisorName <String>] [-ExpandRecommendedActions] -ServerName <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerAdvisor** cmdlet gets one or more Azure SQL Server Advisors for an Azure SQL Server. + +## EXAMPLES + +### Example 1: List all the advisors for the server +```powershell +Get-AzSqlServerAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" +``` + +```output +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {} + +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DropIndex +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 7/31/2016 8:41:19 PM +RecommendationsStatus : Ok +RecommendedActions : {} +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DbParameterization +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 7/31/2016 2:46:58 PM +RecommendationsStatus : NoDbParameterizationIssue +RecommendedActions : {} + +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : SchemaIssue +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 8/1/2016 3:01:41 PM +RecommendationsStatus : SchemaIsConsistent +RecommendedActions : {} +``` + +This command gets a list of all the advisors for the server named wi-runner-australia-east that belongs to the resource group named WIRunnersProd. + +### Example 2: Get a single advisor for the server +```powershell +Get-AzSqlServerAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -AdvisorName "CreateIndex" +``` + +```output +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {} +``` + +This command gets the advisor named CreateIndex for the server named wi-runner-australia-east. + +### Example 3: List all the advisors with their recommended actions included in the response +```powershell +Get-AzSqlServerAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ExpandRecommendedActions +``` + +```output +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.437714]_6C7AE8CC9C87E7FD5893...} + +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DropIndex +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 7/31/2016 8:41:19 PM +RecommendationsStatus : Ok +RecommendedActions : {IR_[test_schema]_[test_table_0.0288891]_38724E1DCF2178318957, + IR_[test_schema]_[test_table_0.140264]_38724E1DCF2178318957, + IR_[test_schema]_[test_table_0.412191]_38724E1DCF2178318957, + IR_[test_schema]_[test_table_0.442075]_38724E1DCF2178318957...} + +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DbParameterization +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 7/31/2016 2:46:58 PM +RecommendationsStatus : NoDbParameterizationIssue +RecommendedActions : {} +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : SchemaIssue +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 8/1/2016 3:04:26 PM +RecommendationsStatus : SchemaIsConsistent +RecommendedActions : {} +``` + +This command gets all the advisors for the server named wi-runner-australia-east. +Since the command uses the *ExpandRecommendedActions* parameter, the cmdlet gets the advisors recommended actions included in the response. + +### Example 4: Get a single advisor with its recommended actions included in the response +```powershell +Get-AzSqlServerAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -AdvisorName "CreateIndex" -ExpandRecommendedActions +``` + +```output +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893, + IR_[test_schema]_[test_table_0.437714]_6C7AE8CC9C87E7FD5893...} +``` + +This command gets advisor named CreateIndex from the server named wi-runner-australia-east with its recommended actions included in the response. + +### Example 5: List all the advisors for the server using filtering +```powershell +Get-AzSqlServerAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -AdvisorName d* +``` + +```output +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DropIndex +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 7/31/2016 8:41:19 PM +RecommendationsStatus : Ok +RecommendedActions : {} + +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : DbParameterization +AdvisorStatus : PublicPreview +AutoExecuteStatus : Disabled +AutoExecuteStatusInheritedFrom : Default +LastChecked : 7/31/2016 2:46:58 PM +RecommendationsStatus : NoDbParameterizationIssue +RecommendedActions : {} +``` + +This command gets a list of all the advisors for the server named wi-runner-australia-east that belongs to the resource group named WIRunnersProd that start with the letter "d". + +## PARAMETERS + +### -AdvisorName +Specifies the name of the advisor that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpandRecommendedActions +Indicates that the cmdlet includes the recommended actions of the advisors that are included in the response. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies name of the resource group of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server for the advisor that this cmdlet requests. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Advisor.Model.AzureSqlServerAdvisorModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, server, mssql, advisor + +## RELATED LINKS + +[Get-AzSqlElasticPoolAdvisor](./Get-AzSqlElasticPoolAdvisor.md) + +[Get-AzSqlDatabaseAdvisor](./Get-AzSqlDatabaseAdvisor.md) + +[Get-AzSqlServerRecommendedAction](./Get-AzSqlServerRecommendedAction.md) + +[Set-AzSqlServerAdvisorAutoExecuteStatus](./Set-AzSqlServerAdvisorAutoExecuteStatus.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerAudit.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerAudit.md new file mode 100644 index 0000000000..36264217ba --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerAudit.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/Get-AzSqlServerAudit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerAudit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerAudit.md +--- + +# Get-AzSqlServerAudit + +## SYNOPSIS +Gets the auditing settings of an Azure SQL server. + +## SYNTAX + +### ServerParameterSet (Default) +``` +Get-AzSqlServerAudit [-ResourceGroupName] <String> [-ServerName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ServerObjectParameterSet +``` +Get-AzSqlServerAudit -ServerObject <AzureSqlServerModel> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerAudit** cmdlet gets the auditing settings of an Azure SQL server. +Specify the *ResourceGroupName* and *ServerName* parameters to identify the server. + +## EXAMPLES + +### Example 1: Get the auditing settings of an Azure SQL server +```powershell +Get-AzSqlServerAudit -ResourceGroupName "resourcegroup01" -ServerName "server01" +``` + +```output +ServerName : server01 +ResourceGroupName : resourcegroup01 +AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, + BATCH_COMPLETED_GROUP, ...} +PredicateExpression : statement <> 'select 1' +BlobStorageTargetState : Enabled +StorageAccountResourceId : /subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage +StorageKeyType : Primary +RetentionInDays : 0 +EventHubTargetState : Enabled +EventHubName : eventHubName +EventHubAuthorizationRuleResourceId : EventHubAuthorizationRuleResourceId +LogAnalyticsTargetState : Enabled +WorkspaceResourceId : "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +### Example 2: Get, through pipeline, the auditing settings of an Azure SQL server +```powershell +Get-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" | Get-AzSqlServerAudit +``` + +```output +ServerName : server01 +ResourceGroupName : resourcegroup01 +AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, + BATCH_COMPLETED_GROUP, ...} +PredicateExpression : statement <> 'select 1' +BlobStorageTargetState : Enabled +StorageAccountResourceId : /subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage +StorageKeyType : Primary +RetentionInDays : 0 +EventHubTargetState : Enabled +EventHubName : eventHubName +EventHubAuthorizationRuleResourceId : EventHubAuthorizationRuleResourceId +LogAnalyticsTargetState : Enabled +WorkspaceResourceId : "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +### Example 3: Get the auditing settings of an Azure SQL server +```powershell +Get-AzSqlServerAudit -ResourceGroupName "resourcegroup01" -ServerName "server01" +``` + +```output +ServerName : server01 +ResourceGroupName : resourcegroup01 +AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, + BATCH_COMPLETED_GROUP, ...} +PredicateExpression : statement <> 'select 1' +BlobStorageTargetState : Enabled +StorageAccountResourceId : /subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage +StorageKeyType : Primary +RetentionInDays : 0 +EventHubTargetState : Enabled +EventHubName : eventHubName +EventHubAuthorizationRuleResourceId : EventHubAuthorizationRuleResourceId +LogAnalyticsTargetState : Disabled +WorkspaceResourceId : +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ServerParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: ServerParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerObject +The server object to manage its audit policy. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: ServerObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Auditing.Model.ServerAuditModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerCommunicationLink.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerCommunicationLink.md new file mode 100644 index 0000000000..ca28b09236 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerCommunicationLink.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 2E7E20CD-6A2B-455E-9476-8E0827429162 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlservercommunicationlink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerCommunicationLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerCommunicationLink.md +--- + +# Get-AzSqlServerCommunicationLink + +## SYNOPSIS +Gets communication links for elastic database transactions between database servers. + +## SYNTAX + +``` +Get-AzSqlServerCommunicationLink [[-LinkName] <String>] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerCommunicationLink** cmdlet gets server-to-server communication links for elastic database transactions in Azure SQL Database. +Specify the name of a server communication link to see the properties for that link. + +## EXAMPLES + +### Example 1: Get all communication links for a server +```powershell +Get-AzSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17" +``` + +This command gets all server-to-server communication links for elastic database transactions for the server named ContosoServer17. + +### Example 2: Get a specific communication link for a server +```powershell +Get-AzSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17" -LinkName "Link01" +``` + +This command gets the server-to-server communication link named Link01. + +### Example 3: Get all communication links for a server using filtering +```powershell +Get-AzSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17" -LinkName "Link*" +``` + +This command gets all server-to-server communication links for elastic database transactions for the server named ContosoServer17 that start with "Link". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkName +Specifies the name of the server communication link that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server specified by the *ServerName* parameter belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of a server. +This server contains a communication link that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerCommunicationLink.Model.AzureSqlServerCommunicationLinkModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + +## RELATED LINKS + +[New-AzSqlServerCommunicationLink](./New-AzSqlServerCommunicationLink.md) + +[Remove-AzSqlServerCommunicationLink](./Remove-AzSqlServerCommunicationLink.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerConfigurationOption.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerConfigurationOption.md new file mode 100644 index 0000000000..a2aaae9d2f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerConfigurationOption.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserverconfigurationoption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerConfigurationOption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerConfigurationOption.md +--- + +# Get-AzSqlServerConfigurationOption + +## SYNOPSIS +Returns information about server configuration options for Azure SQL Managed Instance. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSqlServerConfigurationOption [-ResourceGroupName] <String> [-InstanceName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSqlServerConfigurationOption [[-Name] <String>] [-InstanceObject] <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInstanceResourceIdParameterSet +``` +Get-AzSqlServerConfigurationOption [[-Name] <String>] [-InstanceResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSqlServerConfigurationOption [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerConfigurationOption** cmdlet returns information about one or more server configuration option on Azure SQL Managed Instance. Specify the name of a server configuration option to see information for that option only. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlServerConfigurationOption -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "allowPolybaseExport" +``` + +```Output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/serverConfigurationOptions +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverConfigurationOptions/allowPolybaseExport +Name : allowPolybaseExport +Value : 0 +``` + +This command gets information about the server configuration option named "allowPolybaseExport" on instance "Instance01" and resource group "ResourceGroup01". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +Instance input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceResourceId +Managed instance resource ID. + +```yaml +Type: System.String +Parameter Sets: GetByInstanceResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the server configuration option. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet, GetByInstanceResourceIdParameterSet +Aliases: ConfigOptionName +Accepted values: allowPolybaseExport + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Server configuration option resource ID. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerConfigurationOptions.Model.ServerConfigurationOptionsModel + +## NOTES + +## RELATED LINKS + +[Set-ServerConfigurationOption](./Set-ServerConfigurationOption.md) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerDisasterRecoveryConfiguration.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerDisasterRecoveryConfiguration.md new file mode 100644 index 0000000000..d053fc4b84 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerDisasterRecoveryConfiguration.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: C7F3E754-394A-4F93-A621-A07AF281EE45 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserverdisasterrecoveryconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerDisasterRecoveryConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerDisasterRecoveryConfiguration.md +--- + +# Get-AzSqlServerDisasterRecoveryConfiguration + +## SYNOPSIS +Gets a database server system recovery configuration. + +## SYNTAX + +``` +Get-AzSqlServerDisasterRecoveryConfiguration [-VirtualEndpointName <String>] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerDisasterRecoveryConfiguration** cmdlet gets a SQL database server system recovery configuration. + +## EXAMPLES + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of SQL database server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualEndpointName +Specifies the name of the virtual end point. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerDisasterRecoveryConfiguration.Model.AzureSqlServerDisasterRecoveryConfigurationModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlServerDisasterRecoveryConfiguration](./New-AzSqlServerDisasterRecoveryConfiguration.md) + +[Remove-AzSqlServerDisasterRecoveryConfiguration](./Remove-AzSqlServerDisasterRecoveryConfiguration.md) + +[Set-AzSqlServerDisasterRecoveryConfiguration](./Set-AzSqlServerDisasterRecoveryConfiguration.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerDisasterRecoveryConfigurationActivity.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerDisasterRecoveryConfigurationActivity.md new file mode 100644 index 0000000000..dd973fe2fe --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerDisasterRecoveryConfigurationActivity.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 41D63CC1-5E9F-48D3-89DE-0F753C7475F2 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserverdisasterrecoveryconfigurationactivity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerDisasterRecoveryConfigurationActivity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerDisasterRecoveryConfigurationActivity.md +--- + +# Get-AzSqlServerDisasterRecoveryConfigurationActivity + +## SYNOPSIS +Gets activity for a database server system recovery configuration. + +## SYNTAX + +``` +Get-AzSqlServerDisasterRecoveryConfigurationActivity [-ServerName] <String> + -ServerDisasterRecoveryConfigurationName <String> [-OperationId <Guid>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerDisasterRecoveryConfigurationActivity** cmdlet gets activity for a SQL database server system recovery configuration. + +## EXAMPLES + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationId +Specifies the operation ID. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerDisasterRecoveryConfigurationName +Specifies the name of the server system recovery configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerDisasterRecoveryConfiguration.Model.AzureSqlServerDisasterRecoveryConfigurationActivityModel + +## NOTES + +## RELATED LINKS + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerDnsAlias.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerDnsAlias.md new file mode 100644 index 0000000000..55ac39321d --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerDnsAlias.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserverdnsalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerDnsAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerDnsAlias.md +--- + +# Get-AzSqlServerDnsAlias + +## SYNOPSIS +Gets or lists Azure SQL Server DNS Alias. + +## SYNTAX + +``` +Get-AzSqlServerDnsAlias [-Name <String>] -ServerName <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Get the specific Azure SQL Server DNS Alias or lists all Server DNS Aliases for the server + +## EXAMPLES + +### Example 1 +```powershell +$serverDNSAliases = Get-AzSqlServerDnsAlias -ServerName servername -ResourceGroupName rgname +``` + +```output +ResourceGroupName ServerName DnsAliasName +----------------- ---------- ------------------ +rgname servername dnsaliasname +rgname servername dnsaliasname2 +``` + +Lists all Server DNS Aliases for the specific server + +### Example 2 +```powershell +$serverDNSAliases = Get-AzSqlServerDnsAlias -DnsAliasName dnsaliasname -ServerName servername -ResourceGroupName rgname +``` + +```output +ResourceGroupName ServerName DnsAliasName +----------------- ---------- ------------------ +rgname servername dnsaliasname +``` + +Gets Server DNS Alias specified by server and alias name + +### Example 3 +```powershell +$serverDNSAliases = Get-AzSqlServerDnsAlias -ServerName servername -ResourceGroupName rgname -DnsAliasName "dnsaliasname*" +``` + +```output +ResourceGroupName ServerName DnsAliasName +----------------- ---------- ------------------ +rgname servername dnsaliasname +rgname servername dnsaliasname2 +``` + +Lists all Server DNS Aliases for the specific server that start with "dnsaliasname". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Azure Sql Server DNS Alias name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DnsAliasName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerDnsAlias.Model.AzureSqlServerDnsAliasModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerFirewallRule.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerFirewallRule.md new file mode 100644 index 0000000000..2b94631a5b --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerFirewallRule.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: AD8BA5CB-D5D4-4C6E-A65F-E7AE69E3B22C +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserverfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerFirewallRule.md +--- + +# Get-AzSqlServerFirewallRule + +## SYNOPSIS +Gets firewall rules for a SQL Database server. + +## SYNTAX + +``` +Get-AzSqlServerFirewallRule [[-FirewallRuleName] <String>] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerFirewallRule** cmdlet gets firewall rules for an Azure SQL Database server. +If you specify the name of a firewall rule, this cmdlet gets information about that specific firewall rule. + +## EXAMPLES + +### Example 1: Get all rules for a server +```powershell +Get-AzSqlServerFirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : server01 +StartIpAddress : 0.0.0.0 +EndIpAddress : 0.0.0.0 +FirewallRuleName : AllowAllWindowsAzureIps + +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +StartIpAddress : 1.2.3.4 +EndIpAddress : 4.3.2.1 +FirewallRuleName : Rule01 +``` + +This command gets all the firewall rules for the server named Server01. + +### Example 2: Get all rules for a server using filtering +```powershell +Get-AzSqlServerFirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -FirewallRuleName "Rule*" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : server01 +StartIpAddress : 0.0.0.0 +EndIpAddress : 0.0.0.0 +FirewallRuleName : Rule01 + +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +StartIpAddress : 1.2.3.4 +EndIpAddress : 4.3.2.1 +FirewallRuleName : Rule02 +``` + +This command gets all the firewall rules for the server named Server01 that start with "Rule". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleName +Specifies the name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the SQL Server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlServerFirewallRule](./New-AzSqlServerFirewallRule.md) + +[Remove-AzSqlServerFirewallRule](./Remove-AzSqlServerFirewallRule.md) + +[Set-AzSqlServerFirewallRule](./Set-AzSqlServerFirewallRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerIpv6FirewallRule.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerIpv6FirewallRule.md new file mode 100644 index 0000000000..618aa78a52 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerIpv6FirewallRule.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserveripv6firewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerIpv6FirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerIpv6FirewallRule.md +--- + +# Get-AzSqlServerIpv6FirewallRule + +## SYNOPSIS +Gets IPv6 firewall rules for a SQL Database server. + +## SYNTAX + +``` +Get-AzSqlServerIpv6FirewallRule [[-Ipv6FirewallRuleName] <String>] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerIpv6FirewallRule** cmdlet gets IPv6 firewall rules for an Azure SQL Database server. +If you specify the name of an IPv6 firewall rule, this cmdlet gets information about that specific IPv6 firewall rule. + +## EXAMPLES + +### Example 1: Get all IPv6 rules for a server +```powershell +Get-AzSqlServerIpv6FirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : server01 +StartIpv6Address : 0000:0000:0000:0000:0000:ffff:0000:0000 +EndIpv6Address : 0000:0000:0000:0000:0000:ffff:0000:0001 +Ipv6FirewallRuleName : Rule01 + +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +StartIpv6Address : 0000:0000:0000:0000:0000:ffff:0000:0002 +EndIpv6Address : 0000:0000:0000:0000:0000:ffff:0000:0003 +Ipv6FirewallRuleName : Rule02 +``` + +This command gets all the IPv6 firewall rules for the server named Server01. + +### Example 2: Get all IPv6 rules for a server using filtering +```powershell +Get-AzSqlServerIpv6FirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Ipv6FirewallRuleName "Rule*" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : server01 +StartIpv6Address : 0000:0000:0000:0000:0000:ffff:0000:0000 +EndIpv6Address : 0000:0000:0000:0000:0000:ffff:0000:0001 +Ipv6FirewallRuleName : Rule01 + +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +StartIpv6Address : 0000:0000:0000:0000:0000:ffff:0000:0002 +EndIpv6Address : 0000:0000:0000:0000:0000:ffff:0000:0003 +Ipv6FirewallRuleName : Rule02 +``` + +This command gets all the IPv6 firewall rules for the server named Server01 that start with "Rule". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ipv6FirewallRuleName +Specifies the name of the IPv6 firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the SQL Server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Ipv6FirewallRule.Model.AzureSqlServerIpv6FirewallRuleModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlServerIpv6FirewallRule](./New-AzSqlServerIpv6FirewallRule.md) + +[Remove-AzSqlServerIpv6FirewallRule](./Remove-AzSqlServerIpv6FirewallRule.md) + +[Set-AzSqlServerIpv6FirewallRule](./Set-AzSqlServerIpv6FirewallRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerKeyVaultKey.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerKeyVaultKey.md new file mode 100644 index 0000000000..c65a1b554f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerKeyVaultKey.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserverkeyvaultkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerKeyVaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerKeyVaultKey.md +--- + +# Get-AzSqlServerKeyVaultKey + +## SYNOPSIS +Gets a SQL server's Key Vault keys. + +## SYNTAX + +``` +Get-AzSqlServerKeyVaultKey [[-KeyId] <String>] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlServerKeyVaultKey cmdlet gets information about the Key Vault keys on a SQL server. +You can view all keys on a server or view a specific key by providing the KeyId. + +## EXAMPLES + +### Example 1: Get all Key Vault keys +```powershell +Get-AzSqlServerKeyVaultKey -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ServerName : ContosoServer +ServerKeyName : contoso_contosokey_01234567890123456789012345678901 +Type : AzureKeyVault +Uri : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +Thumbprint : 1122334455667788990011223344556677889900 +CreationDate : 1/1/2017 12:00:00 AM +ResourceGroupName : ContosoResourceGroup +ServerName : ContosoServer +ServerKeyName : contoso_contosokey2_01234567890123456789012345678901 +Type : AzureKeyVault +Uri : https://contoso.vault.azure.net/keys/contosokey2/09876543210987654321098765432109 +Thumbprint : 0099887766554433221100998877665544332211 +CreationDate : 1/1/2017 12:00:00 AM +``` + +This command gets all the Key Vault keys on a SQL server. + +### Example 2: Get a specific Key Vault key +```powershell +$MyServerKeyVaultKey = Get-AzSqlServerKeyVaultKey -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup' +``` + +This command gets the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901', and then stores it in the $MyServerKeyVaultKey variable. +You can inspect the properties of $MyServerKeyVaultKey to get details about the key vault. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyId +The Azure Key Vault KeyId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerKeyVaultKey.Model.AzureSqlServerKeyVaultKeyModel + +## NOTES + +## RELATED LINKS + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerMSSupportAudit.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerMSSupportAudit.md new file mode 100644 index 0000000000..b8e60983a7 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerMSSupportAudit.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/Get-AzSqlServerMSSupportAudit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerMSSupportAudit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerMSSupportAudit.md +--- + +# Get-AzSqlServerMSSupportAudit + +## SYNOPSIS +Gets the Microsoft support operations auditing settings of an Azure SQL server. + +## SYNTAX + +### ServerParameterSet (Default) +``` +Get-AzSqlServerMSSupportAudit [-ResourceGroupName] <String> [-ServerName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ServerObjectParameterSet +``` +Get-AzSqlServerMSSupportAudit -ServerObject <AzureSqlServerModel> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerMSSupportAudit** cmdlet gets the Microsoft support operations auditing settings of an Azure SQL server. +Specify the *ResourceGroupName* and *ServerName* parameters to identify the server. + +## EXAMPLES + +### Example 1: Get the Microsoft support operations auditing settings of an Azure SQL server +```powershell +Get-AzSqlServerMSSupportAudit -ResourceGroupName "resourcegroup01" -ServerName "server01" +``` + +```output +ServerName : server01 +ResourceGroupName : resourcegroup01 +BlobStorageTargetState : Enabled +StorageAccountResourceId : /subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage +EventHubTargetState : Enabled +EventHubName : eventHubName +EventHubAuthorizationRuleResourceId : EventHubAuthorizationRuleResourceId +LogAnalyticsTargetState : Enabled +WorkspaceResourceId : "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +### Example 2: Get, through pipeline, the Microsoft support operations auditing settings of an Azure SQL server +```powershell +Get-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" | Get-AzSqlServerMSSupportAudit +``` + +```output +ServerName : server01 +ResourceGroupName : resourcegroup01 +BlobStorageTargetState : Enabled +StorageAccountResourceId : /subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage +EventHubTargetState : Enabled +EventHubName : eventHubName +EventHubAuthorizationRuleResourceId : EventHubAuthorizationRuleResourceId +LogAnalyticsTargetState : Enabled +WorkspaceResourceId : "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +### Example 3: Get the Microsoft support operations auditing settings of an Azure SQL server +```powershell +Get-AzSqlServerMSSupportAudit -ResourceGroupName "resourcegroup01" -ServerName "server01" +``` + +```output +ServerName : server01 +ResourceGroupName : resourcegroup01 +BlobStorageTargetState : Enabled +StorageAccountResourceId : /subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage +EventHubTargetState : Enabled +EventHubName : eventHubName +EventHubAuthorizationRuleResourceId : EventHubAuthorizationRuleResourceId +LogAnalyticsTargetState : Disabled +WorkspaceResourceId : +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ServerParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: ServerParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerObject +The server object to manage its audit policy. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: ServerObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Auditing.Model.ServerDevOpsAuditModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerOutboundFirewallRule.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerOutboundFirewallRule.md new file mode 100644 index 0000000000..ff168746c7 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerOutboundFirewallRule.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserveroutboundfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerOutboundFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerOutboundFirewallRule.md +--- + +# Get-AzSqlServerOutboundFirewallRule + +## SYNOPSIS +Gets outbound firewall rules (Allowed FQDNs) for a SQL Database server. + +## SYNTAX + +``` +Get-AzSqlServerOutboundFirewallRule [[-AllowedFQDN] <String>] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerOutboundFirewallRule** cmdlet gets the list of Allowed FQDNs in the Outbound Firewall Rules for an Azure SQL Database server. +If you specify the name of an allowed FQDN, this cmdlet gets information about that specific allowed FQDN. + +## EXAMPLES + +### Example 1: Get outbound firewall rule(s) for a server +<!-- Skip: Output cannot be splitted from code --> +```powershell +Get-AzSqlServerOutboundFirewallRule -ServerName "Server01" -ResourceGroupName "ResourceGroup01" -AllowedFQDN "OutboundFirewallRule01" + +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +AllowedFQDN : OutboundFirewallRule01 + +Get-AzSqlServerOutboundFirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" + +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +AllowedFQDN : OutboundFirewallRule01 + +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +AllowedFQDN : OutboundFirewallRule02 + +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +AllowedFQDN : OutboundFirewallRule03 +``` + +This command gets all the allowed FQDNs from the list of Outbound Firewall Rules for the server named Server01 in the resource group named ResourceGroup01. + +## PARAMETERS + +### -AllowedFQDN +Specifies the allowed fully qualified domain name (FQDN) in the list of outbound firewall rules. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the SQL Server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.OutboundFirewallRules.Model.AzureSqlServerOutboundFirewallRulesModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlServerOutboundFirewallRule](./New-AzSqlServerOutboundFirewallRule.md) + +[Remove-AzSqlServerOutboundFirewallRule](./Remove-AzSqlServerOutboundFirewallRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerRecommendedAction.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerRecommendedAction.md new file mode 100644 index 0000000000..ced25b7988 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerRecommendedAction.md @@ -0,0 +1,263 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: BB513A53-48A0-4F8F-93F0-D3DFA2C3D523 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserverrecommendedaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerRecommendedAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerRecommendedAction.md +--- + +# Get-AzSqlServerRecommendedAction + +## SYNOPSIS +Gets one or more recommended actions for an Azure SQL Server Advisor. + +## SYNTAX + +``` +Get-AzSqlServerRecommendedAction [-RecommendedActionName <String>] -ServerName <String> -AdvisorName <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerRecommendedAction** cmdlet gets one or more recommended actions for an Azure SQL Server Advisor. + +## EXAMPLES + +### Example 1: Get a list of all recommended actions for a specific Advisor +```powershell +Get-AzSqlServerRecommendedAction -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -AdvisorName "CreateIndex" +``` + +```output +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, + NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} +RecommendationReason : +RevertActionDuration : +RevertActionInitiatedBy : +RevertActionInitiatedTime : +RevertActionStartTime : +Score : 2 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM + +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.236046_6C7AE8CC9C87E7FD5893], [indexType, NONCLUSTERED], + [schema, [test_schema]], [table, [test_table_0.236046]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {SpaceChange} +RecommendationReason : +RevertActionDuration : +RevertActionInitiatedBy : +RevertActionInitiatedTime : +RevertActionStartTime : +Score : 3 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM + +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.239359_6C7AE8CC9C87E7FD5893], [indexType, NONCLUSTERED], + [schema, [test_schema]], [table, [test_table_0.239359]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} +RecommendationReason : +RevertActionDuration : PT10S +RevertActionInitiatedBy : System +RevertActionInitiatedTime : 4/21/2016 3:24:47 PM +RevertActionStartTime : 4/21/2016 3:24:47 PM +Score : 3 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM +``` + +This command gets a list of all recommended actions of for the SQL Server Advisor named CreateIndex available for the server named wi-runner-australia-east. + +### Example 2: Get a single recommended action for an Advisor +```powershell +Get-AzSqlServerRecommendedAction -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -AdvisorName "CreateIndex" -RecommendedActionName IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 +``` + +```output +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, + NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} +RecommendationReason : +RevertActionDuration : +RevertActionInitiatedBy : +RevertActionInitiatedTime : +RevertActionStartTime : +Score : 2 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM +``` + +This command gets a recommended action named IR_\[test_schema\]_\[test_table_0.0361551\]_6C7AE8CC9C87E7FD5893 from the Advisor named CreateIndex. + +## PARAMETERS + +### -AdvisorName +Specifies the name of the advisor for which this cmdlet requests actions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecommendedActionName +Specifies the name of the recommended action that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the server that contains this server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server the Advisor belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.RecommendedAction.Model.AzureSqlServerRecommendedActionModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, server, mssql, advisor, recommendedaction + +## RELATED LINKS + +[Get-AzSqlServerAdvisor](./Get-AzSqlServerAdvisor.md) + +[Set-AzSqlServerRecommendedActionState](./Set-AzSqlServerRecommendedActionState.md) + +[Get-AzSqlElasticPoolRecommendedAction](./Get-AzSqlElasticPoolRecommendedAction.md) + +[Get-AzSqlDatabaseRecommendedAction](./Get-AzSqlDatabaseRecommendedAction.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerServiceObjective.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerServiceObjective.md new file mode 100644 index 0000000000..0a8bd7452f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerServiceObjective.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: AC2D64B9-5BCD-45D3-8650-538633F5BBBC +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserverserviceobjective +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerServiceObjective.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerServiceObjective.md +--- + +# Get-AzSqlServerServiceObjective + +## SYNOPSIS +Gets service objectives for an Azure SQL Database server. + +## SYNTAX + +### ByLocation (Default) +``` +Get-AzSqlServerServiceObjective [[-ServiceObjectiveName] <String>] -Location <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByServer +``` +Get-AzSqlServerServiceObjective [[-ServiceObjectiveName] <String>] [-ResourceGroupName] <String> + [-ServerName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerServiceObjective** cmdlet gets the available service objectives for an Azure SQL Database server. + +## EXAMPLES + +### Example 1: Get service objectives +```powershell +Get-AzSqlServerServiceObjective -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +```output +serviceObjectiveName SkuName Edition Family Capacity CapacityUnit Enabled +-------------------- ------- ------- ------ -------- ------------ ------- +System System System 0 DTU False +Free Free Free 5 DTU True +Basic Basic Basic 5 DTU True +S0 Standard Standard 10 DTU True +S1 Standard Standard 20 DTU True +P1 Premium Premium 125 DTU True +P2 Premium Premium 250 DTU True +DW100c DataWarehouse DataWarehouse 900 DTU False +GP_Gen4_1 GP_Gen4 GeneralPurpose Gen4 1 VCores True +GP_Gen5_2 GP_Gen5 GeneralPurpose Gen5 2 VCores True +BC_Gen4_1 BC_Gen4 BusinessCritical Gen4 1 VCores True +BC_Gen5_4 BC_Gen5 BusinessCritical Gen5 4 VCores True +``` + +This command gets the service objectives for the server named Server01. + +### Example 2: Get service objectives using filtering +```powershell +Get-AzSqlServerServiceObjective -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ServiceObjectiveName "P*" +``` + +```output +ServiceObjectiveName SkuName Edition Family Capacity CapacityUnit Enabled +-------------------- ------- ------- ------ -------- ------------ ------- +P1 Premium Premium 125 DTU True +P2 Premium Premium 250 DTU True +``` + +This command gets the service objectives for the server named Server01 that start with "System". + +### Example 3: Get service objectives for a location +```powershell +Get-AzSqlServerServiceObjective -Location "west us" +``` + +```output +serviceObjectiveName SkuName Edition Family Capacity CapacityUnit Enabled +-------------------- ------- ------- ------ -------- ------------ ------- +System System System 0 DTU False +Free Free Free 5 DTU True +Basic Basic Basic 5 DTU True +S0 Standard Standard 10 DTU True +S1 Standard Standard 20 DTU True +P1 Premium Premium 125 DTU True +P2 Premium Premium 250 DTU True +DW100c DataWarehouse DataWarehouse 900 DTU False +GP_Gen4_1 GP_Gen4 GeneralPurpose Gen4 1 VCores True +GP_Gen5_2 GP_Gen5 GeneralPurpose Gen5 2 VCores True +BC_Gen4_1 BC_Gen4 BusinessCritical Gen4 1 VCores True +BC_Gen5_4 BC_Gen5 BusinessCritical Gen5 4 VCores True +``` + +This command gets the service objectives for a specified Azure region. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The name of the Location for which to get the service objectives. + +```yaml +Type: System.String +Parameter Sets: ByLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet gets service objectives for a SQL Database server assigned to this resource. + +```yaml +Type: System.String +Parameter Sets: ByServer +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of a SQL Database SQL Database server. + +```yaml +Type: System.String +Parameter Sets: ByServer +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceObjectiveName +Specifies the name of a service objective for an Azure SQL Database server. +The acceptable values for this parameter are: Basic, S0, S1, S2, P1, P2, and P3. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServiceObjective.Model.AzureSqlServerServiceObjectiveModel + +## NOTES + +## RELATED LINKS + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerTransparentDataEncryptionProtector.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerTransparentDataEncryptionProtector.md new file mode 100644 index 0000000000..84863fe149 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerTransparentDataEncryptionProtector.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlservertransparentdataencryptionprotector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerTransparentDataEncryptionProtector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerTransparentDataEncryptionProtector.md +--- + +# Get-AzSqlServerTransparentDataEncryptionProtector + +## SYNOPSIS +Gets the Transparent Data Encryption (TDE) protector + +## SYNTAX + +``` +Get-AzSqlServerTransparentDataEncryptionProtector [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSqlServerTransparentDataEncryptionProtector cmdlet gets information about the TDE protector. + +## EXAMPLES + +### Example 1: Get the Transparent Data Encryption (TDE) protector +```powershell +Get-AzSqlServerTransparentDataEncryptionProtector -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup' +``` + +```output +ResourceGroupName ServerName Type ServerKeyVaultKeyName +----------------- ---------- ---- --------------------- +ContosoResourceGroup ContosoServer ServiceManaged ServiceManaged +``` + +This command gets the TDE protector for the server named ContosoServer in resource group named ContosoResourceGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlServerTransparentDataEncryptionProtectorModel + +## NOTES + +## RELATED LINKS + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerTrustGroup.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerTrustGroup.md new file mode 100644 index 0000000000..2cef9df96f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerTrustGroup.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlservertrustgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerTrustGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerTrustGroup.md +--- + +# Get-AzSqlServerTrustGroup + +## SYNOPSIS +Gets information about Server Trust Group. + +## SYNTAX + +### ListByLocationSet (Default) +``` +Get-AzSqlServerTrustGroup [-ResourceGroupName] <String> [-Location] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByName +``` +Get-AzSqlServerTrustGroup [-ResourceGroupName] <String> [-Location] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ListByInstanceSet +``` +Get-AzSqlServerTrustGroup [-ResourceGroupName] <String> [-InstanceName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Get-AzSqlServerTrustGroup [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerTrustGroup** cmdlet get information about Server Trust Group and its members for current subscription. Based on parameter set this cmdlet can retrieve specified Server Trust Group, all Server Trust Groups in a specified location or Server Trust Groups that have specified AzureSQL Managed Instance as a member. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlServerTrustGroup -ResourceGroupName "ResourceGroup01" -Location "West Europe" -Name "ServerTrustGroup01" +``` + +Gets information about Server Trust Group named ServerTrustGroup01 in resource group ResourceGroup01 in location West Europe. + +### Example 2 +```powershell +Get-AzSqlServerTrustGroup -ResourceGroupName "ResourceGroup01" -Location "West Europe" +``` + +Gets information about all Server Trust Groups in location West Europe in resource group ResourceGroup01. + +### Example 3 +```powershell +Get-AzSqlServerTrustGroup -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" +``` + +Gets information about all Server Trust Groups that have managed instance ManagedInstance01 as a member. + +### Example 4 +```powershell +Get-AzSqlServerTrustGroup -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/locations/WestEurope/serverTrustGroups/ServerTrustGroup01" +``` + +Gets information about Server Trust Group specified by its id. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +The name of the managed instance that is member of Server Trust Groups to retrieve. + +```yaml +Type: System.String +Parameter Sets: ListByInstanceSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the Server Trust Group to retrieve. + +```yaml +Type: System.String +Parameter Sets: ListByLocationSet, GetByName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Server Trust Group to retrieve. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ListByLocationSet, GetByName, ListByInstanceSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance to use + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerTrustGroup.Model.AzureSqlServerTrustGroupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerUpgradeHint.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerUpgradeHint.md new file mode 100644 index 0000000000..c2e7cf64be --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerUpgradeHint.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: BFEAE1F7-56E3-4EA9-B39A-ED09582C8A09 +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlserverupgradehint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerUpgradeHint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerUpgradeHint.md +--- + +# Get-AzSqlServerUpgradeHint + +## SYNOPSIS +Gets pricing tier hints for upgrading an Azure SQL Database server. + +## SYNTAX + +``` +Get-AzSqlServerUpgradeHint [-ServerName] <String> [-ExcludeElasticPools <Boolean>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerUpgradeHint** cmdlet gets pricing tier hints for upgrading an Azure SQL Database server. +Hints may contain the elastic database pool and stand-alone database hints. +Databases that are still in Web and Business pricing tiers get a hint to upgrade to the new Basic, Standard, or Premium pricing tiers, or to go into the elastic database pool. +This cmdlet returns hints for all databases hosted on the specified server. + +## EXAMPLES + +### Example 1: Get combined recommendations +```powershell +Get-AzSqlServerUpgradeHint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +```output +ElasticPools Databases +------------ --------- +{} {database01, database02} +``` + +This command gets combined recommendations for all the databases on a server named Server01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeElasticPools +Indicates whether databases that are included in elastic database pools should be returned. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server for which this cmdlet gets an upgrade hint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Boolean + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServiceTierAdvisor.Model.UpgradeServerHint + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseExpanded](./Get-AzSqlDatabaseExpanded.md) + +[Get-AzSqlElasticPoolRecommendation](./Get-AzSqlElasticPoolRecommendation.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerVirtualNetworkRule.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerVirtualNetworkRule.md new file mode 100644 index 0000000000..4304bc809f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerVirtualNetworkRule.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlservervirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerVirtualNetworkRule.md +--- + +# Get-AzSqlServerVirtualNetworkRule + +## SYNOPSIS +Gets or lists Azure SQL Server Virtual Network Rule. + +## SYNTAX + +``` +Get-AzSqlServerVirtualNetworkRule [-VirtualNetworkRuleName <String>] -ServerName <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This command gets a specific Azure SQL Server Virtual Network Rule or a list of Azure SQL Server Virtual Network Rules under a server. + +## EXAMPLES + +### Example 1 +```powershell +$virtualNetworkRule = Get-AzSqlServerVirtualNetworkRule -ResourceGroupName rg -ServerName serverName -VirtualNetworkRuleName virtualNetworkRuleName +``` + +Gets an single Azure SQL Server virtual network rule + +### Example 2 +```powershell +$virtualNetworkRules = Get-AzSqlServerVirtualNetworkRule -ResourceGroupName rg -ServerName serverName +``` + +Gets the list of Azure SQL Server virtual network rules under the specified server + +### Example 3 +```powershell +$virtualNetworkRules = Get-AzSqlServerVirtualNetworkRule -ResourceGroupName rg -ServerName serverName -VirtualNetworkRuleName virtualNetworkRule* +``` + +Gets the list of Azure SQL Server virtual network rules under the specified server that start with "virtualNetworkRule". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRuleName +The Azure Sql Server Virtual Network Rule name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VirtualNetworkRule.Model.AzureSqlServerVirtualNetworkRuleModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlServerVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Sql/Get-AzSqlServerVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..7f3bd694b3 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlServerVulnerabilityAssessmentSetting.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlservervulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlServerVulnerabilityAssessmentSetting.md +--- + +# Get-AzSqlServerVulnerabilityAssessmentSetting + +## SYNOPSIS +Gets the vulnerability assessment settings of a server. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSqlServerVulnerabilityAssessmentSetting [-ResourceGroupName] <String> [-ServerName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentResourceParameterSet +``` +Get-AzSqlServerVulnerabilityAssessmentSetting [-InputObject] <AzureSqlServerModel> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlServerVulnerabilityAssessmentSetting** cmdlet gets the vulnerability assessment settings of an Azure SQL Server. +Note that you need to run *Enable-AzSqlServerAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1: Get the vulnerability assessment settings of an Azure SQL server +```powershell +Get-AzSqlServerVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : None +EmailSubscriptionAdmins : False +NotificationEmail : {} +``` + +### Example 2: Get the vulnerability assessment settings of an Azure SQL server from an Azure SQL server object +```powershell +Get-AzSqlServer ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + | Get-AzSqlServerVulnerabilityAssessmentSetting +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : None +EmailSubscriptionAdmins : False +NotificationEmail : {} +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to get Vulnerability Assessment settings for + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: GetByParentResourceParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ServerVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlSyncAgent.md b/azps-10.1.0/Az.Sql/Get-AzSqlSyncAgent.md new file mode 100644 index 0000000000..7f27993fe1 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlSyncAgent.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlsyncagent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlSyncAgent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlSyncAgent.md +--- + +# Get-AzSqlSyncAgent + +## SYNOPSIS +Returns information about Azure SQL Sync Agents. + +## SYNTAX + +``` +Get-AzSqlSyncAgent [[-Name] <String>] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlSyncAgent** cmdlet returns information about one or more Azure SQL Sync Agents. +Specify the name of a sync agent to see information for only that sync agent. + +## EXAMPLES + +### Example 1: Get all instances of Azure SQL Sync Agent assigned to an Azure SQL Server +```powershell +Get-AzSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" | Format-List +``` + +```output +ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncAgentName : SyncAgent01 +SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} +LastAliveTime: : 6/1/2017 5:08:48 AM +Version : 4.3.6348.1 +IsUpToDate : False +ExpiryTime : +State : Online + +ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent02} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncAgentName : SyncAgent02 +SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} +LastAliveTime: : 6/1/2017 5:08:48 AM +Version : 4.3.6348.1 +IsUpToDate : False +ExpiryTime : +State : Online +``` + +This command gets information about all the Azure SQL Sync Agents assigned to an Azure SQL Server. + +### Example 2: Get information about an Azure SQL Sync Agent +```powershell +Get-AzSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Name "SyncAgent01" | Format-List +``` + +```output +ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncAgentName : SyncAgent01 +SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} +LastAliveTime: : 6/1/2017 5:08:48 AM +Version : 4.3.6348.1 +IsUpToDate : False +ExpiryTime : +State : Online +``` + +This command gets information about the Azure SQL Database Sync Agent with name "SyncAgent01" + +### Example 3: Get all instances of Azure SQL Sync Agent assigned to an Azure SQL Server using filtering +```powershell +Get-AzSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Name SyncAgent* | Format-List +``` + +```output +ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncAgentName : SyncAgent01 +SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} +LastAliveTime: : 6/1/2017 5:08:48 AM +Version : 4.3.6348.1 +IsUpToDate : False +ExpiryTime : +State : Online + +ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent02} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncAgentName : SyncAgent02 +SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} +LastAliveTime: : 6/1/2017 5:08:48 AM +Version : 4.3.6348.1 +IsUpToDate : False +ExpiryTime : +State : Online +``` + +This command gets information about all the Azure SQL Sync Agents assigned to an Azure SQL Server that start with "SyncAgent". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The sync agent name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SyncAgentName + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the sync agent is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncAgentModel + +## NOTES + +## RELATED LINKS + +[Remove-AzSqlSyncAgent](./Remove-AzSqlSyncAgent.md) + +[New-AzSqlSyncAgent](./New-AzSqlSyncAgent.md) + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlSyncAgentLinkedDatabase.md b/azps-10.1.0/Az.Sql/Get-AzSqlSyncAgentLinkedDatabase.md new file mode 100644 index 0000000000..871cdd197d --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlSyncAgentLinkedDatabase.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlsyncagentlinkeddatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlSyncAgentLinkedDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlSyncAgentLinkedDatabase.md +--- + +# Get-AzSqlSyncAgentLinkedDatabase + +## SYNOPSIS +Returns information about SQL Server databases linked by a sync agent. + +## SYNTAX + +``` +Get-AzSqlSyncAgentLinkedDatabase [-ServerName] <String> [-SyncAgentName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlSyncAgentLinkedDatabase** cmdlet returns information about SQL Server databases linked by a sync agent. + +## EXAMPLES + +### Example 1: Get the linked SQL Server databases for an Azure SQL sync agent. + +The following example returns the linked SQL Server databases linked by an Azure SQL sync agent. + +<!-- Aladdin Generated Example --> +```powershell +Get-AzSqlSyncAgentLinkedDatabase -ResourceGroupName MyResourceGroup -ServerName s1 -SyncAgentName 'SyncAgent01' +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the sync agent is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncAgentName +The sync agent name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncAgentLinkedDatabaseModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlSyncGroup.md b/azps-10.1.0/Az.Sql/Get-AzSqlSyncGroup.md new file mode 100644 index 0000000000..861fbe17fc --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlSyncGroup.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlsyncgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlSyncGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlSyncGroup.md +--- + +# Get-AzSqlSyncGroup + +## SYNOPSIS +Returns information about Azure SQL Database Sync Groups. + +## SYNTAX + +``` +Get-AzSqlSyncGroup [[-Name] <String>] [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlSyncGroup** cmdlet returns information about one or more Azure SQL Database Sync Groups. +Specify the name of a sync group to see information for only that sync group. + +## EXAMPLES + +### Example 1: Get all instances of Azure SQL Sync Group assigned to an Azure SQL Database +```powershell +Get-AzSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" | Format-List +``` + +```output +ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup01 +SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} +IntervalInSeconds : 100 +ConflictResolutionPolicy: : HubWin +HubDatabaseUserName : myAccount +HubDatabasePassword : +SyncState : NotReady +LastSyncTime : 1/1/0001 12:00:00 AM +Schema : + +ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup02} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup02 +SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} +IntervalInSeconds : 100 +ConflictResolutionPolicy: : HubWin +HubDatabaseUserName : myAccount +HubDatabasePassword : +SyncState : NotReady +LastSyncTime : 1/1/0001 12:00:00 AM +Schema : +``` + +This command gets information about all the Azure SQL Database Sync Groups assigned to an Azure SQL Database. + +### Example 2: Get information about an Azure SQL Database Sync Group +```powershell +Get-AzSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -Name "SyncGroup01" | Format-List +``` + +```output +ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup02} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup02 +SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} +IntervalInSeconds : 100 +ConflictResolutionPolicy: : HubWin +HubDatabaseUserName : myAccount +HubDatabasePassword : +SyncState : NotReady +LastSyncTime : 1/1/0001 12:00:00 AM +Schema : +``` + +This command gets information about the Azure SQL Database Sync Group with name "SyncGroup01" + +### Example 3: Get all instances of Azure SQL Sync Group assigned to an Azure SQL Database using filtering +```powershell +Get-AzSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -Name "SyncGroup*" | Format-List +``` + +```output +ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup01 +SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} +IntervalInSeconds : 100 +ConflictResolutionPolicy: : HubWin +HubDatabaseUserName : myAccount +HubDatabasePassword : +SyncState : NotReady +LastSyncTime : 1/1/0001 12:00:00 AM +Schema : + +ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup02} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup02 +SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} +IntervalInSeconds : 100 +ConflictResolutionPolicy: : HubWin +HubDatabaseUserName : myAccount +HubDatabasePassword : +SyncState : NotReady +LastSyncTime : 1/1/0001 12:00:00 AM +Schema : +``` + +This command gets information about all the Azure SQL Database Sync Groups assigned to an Azure SQL Database that start with "SyncGroup". + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The sync group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SyncGroupName + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlSyncGroup](./New-AzSqlSyncGroup.md) + +[Update-AzSqlSyncGroup](./Update-AzSqlSyncGroup.md) + +[Remove-AzSqlSyncGroup](./Remove-AzSqlSyncGroup.md) + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlSyncGroupLog.md b/azps-10.1.0/Az.Sql/Get-AzSqlSyncGroupLog.md new file mode 100644 index 0000000000..e0a129e8d4 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlSyncGroupLog.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlsyncgrouplog +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlSyncGroupLog.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlSyncGroupLog.md +--- + +# Get-AzSqlSyncGroupLog + +## SYNOPSIS +Returns the logs of an Azure SQL Database Sync Group. + +## SYNTAX + +``` +Get-AzSqlSyncGroupLog [-SyncGroupName] <String> -StartTime <DateTime> [-EndTime <DateTime>] + [-LogLevel <String>] [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlSyncGroupLog** cmdlet returns the logs of an Azure SQL Database Sync Group. + +## EXAMPLES + +### Example 1: Get the logs of an Azure SQL Sync Group +```powershell +Get-AzSqlSyncGroupLog -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -StartTime "9/16/2016 11:31:12" -EndTime "9/16/2016 12:31:00" -LogLevel "All" +``` + +```output +TimeStamp LogLevel Details Source +--------- -------- ------- ------ +6/13/2017 9:14:26 AM Success Schema information obtained successfully. fangltest2.database.windows.net/fangltest +6/13/2017 7:11:59 AM Success Schema information obtained successfully. fangltest2.database.windows.net/fangltest +``` + +This command gets the logs of an Azure SQL Sync Group. + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +The end time of the logs to query. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogLevel +The type of the logs to query. +Valid values are: 'Error', 'Warning', 'Success' and 'All'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Error, Warning, Success, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +The start time of the logs to query. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncGroupName +The sync group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupLogModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlSyncMember.md b/azps-10.1.0/Az.Sql/Get-AzSqlSyncMember.md new file mode 100644 index 0000000000..a19101437a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlSyncMember.md @@ -0,0 +1,247 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlsyncmember +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlSyncMember.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlSyncMember.md +--- + +# Get-AzSqlSyncMember + +## SYNOPSIS +Returns information about Azure SQL Database Sync Members. + +## SYNTAX + +``` +Get-AzSqlSyncMember [-Name <String>] [-SyncGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlSyncMember** cmdlet returns information about one or more Azure SQL Database Sync Members. +Specify the name of a sync member to see information for only that sync member. + +## EXAMPLES + +### Example 1: Get all instances of Azure SQL Sync Member assigned to a sync group +```powershell +Get-AzSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" | Format-List +``` + +```output +ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup01 +SyncMemberName : SyncMember01 +SyncDirection : OneWayMemberToHub +MemberDatabaseType: : AzureSqlDatabase +SyncAgentId : +SqlServerDatabaseId : +MemberServerName : memberServer01.full.dns.name +MemberDatabaseName : memberDatabase01 +MemberDatabaseUserName : myAccount +MemberDatabasePassword : +SyncState : Good + +ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember02} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup01 +SyncMemberName : SyncMember02 +SyncDirection : OneWayMemberToHub +MemberDatabaseType: : AzureSqlDatabase +SyncAgentId : +SqlServerDatabaseId : +MemberServerName : memberServer01.full.dns.name +MemberDatabaseName : memberDatabase01 +MemberDatabaseUserName : myAccount +MemberDatabasePassword : +SyncState : Good +``` + +This command gets information about all the Azure SQL Database Sync Member assigned to the sync group SyncGroup01. + +### Example 2: Get information about an Azure SQL Database Sync Member +```powershell +Get-AzSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -Name "SyncMember01" | Format-List +``` + +```output +ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup01 +SyncMemberName : SyncMember01 +SyncDirection : OneWayMemberToHub +MemberDatabaseType: : AzureSqlDatabase +SyncAgentId : +SqlServerDatabaseId : +MemberServerName : memberServer01.full.dns.name +MemberDatabaseName : memberDatabase01 +MemberDatabaseUserName : myAccount +MemberDatabasePassword : +SyncState : Good +``` + +This command gets information about the Azure SQL Database Sync Member with name "SyncMember01" + +### Example 3: Get all instances of Azure SQL Sync Member assigned to a sync group using filtering +```powershell +Get-AzSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -Name "SyncMember*" | Format-List +``` + +```output +ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup01 +SyncMemberName : SyncMember01 +SyncDirection : OneWayMemberToHub +MemberDatabaseType: : AzureSqlDatabase +SyncAgentId : +SqlServerDatabaseId : +MemberServerName : memberServer01.full.dns.name +MemberDatabaseName : memberDatabase01 +MemberDatabaseUserName : myAccount +MemberDatabasePassword : +SyncState : Good + +ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember02} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup01 +SyncMemberName : SyncMember02 +SyncDirection : OneWayMemberToHub +MemberDatabaseType: : AzureSqlDatabase +SyncAgentId : +SqlServerDatabaseId : +MemberServerName : memberServer01.full.dns.name +MemberDatabaseName : memberDatabase01 +MemberDatabaseUserName : myAccount +MemberDatabasePassword : +SyncState : Good +``` + +This command gets information about all the Azure SQL Database Sync Member assigned to the sync group SyncGroup01 that start with "SyncMember". + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The sync member name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SyncMemberName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncGroupName +The sync group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncMemberModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlSyncMember](./New-AzSqlSyncMember.md) + +[Update-AzSqlSyncMember](./Update-AzSqlSyncMember.md) + +[Remove-AzSqlSyncMember](./Remove-AzSqlSyncMember.md) + diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlSyncSchema.md b/azps-10.1.0/Az.Sql/Get-AzSqlSyncSchema.md new file mode 100644 index 0000000000..28f82d0fdf --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlSyncSchema.md @@ -0,0 +1,178 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlsyncschema +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlSyncSchema.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlSyncSchema.md +--- + +# Get-AzSqlSyncSchema + +## SYNOPSIS +Returns information about the sync schema of a member database or a hub database. + +## SYNTAX + +``` +Get-AzSqlSyncSchema [-SyncGroupName] <String> [-SyncMemberName <String>] [-ServerName] <String> + [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlSyncSchema** cmdlet returns information about the sync schema of a member database or a hub database. + +## EXAMPLES + +### Example 1: Get the sync schema for a hub database +```powershell +Get-AzSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" +``` + +```output +Tables LastUpdateTime +------ -------------- +{dbo.Table_1, dbo.Table_2} 6/13/2017 10:03:44 AM +``` + +This command gets the sync schema for the hub database in the sync group syncGroup01. + +### Example 2: Get the sync schema for a hub database, and expand Tables +```powershell +Get-AzSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" | Select-Object -ExpandProperty Tables +``` + +```output +Columns : {column1, column2} +ErrorId : Schema_TableHasNoPrimaryKey +HasError : True +Name : dbo.Table_1 +QuotedName : [dbo].[Table_1] + +Columns : {column2, column4} +ErrorId : Schema_TableHasNoPrimaryKey +HasError : True +Name : dbo.Table_2 +QuotedName : [dbo].[Table_2] +``` + +This command gets the sync schema for the hub database in the sync group syncGroup01 and expand Tables property. + +### Example 3: Get the sync schema for a member database +```powershell +Get-AzSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" -SyncMemberName "syncMember01" +``` + +```output +The schema payload is the same as Example 1. +``` + +This command gets the sync schema for the member database in the sync member syncMember01. + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncGroupName +The sync group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncMemberName +The sync member name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncFullSchemaModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Get-AzSqlVirtualCluster.md b/azps-10.1.0/Az.Sql/Get-AzSqlVirtualCluster.md new file mode 100644 index 0000000000..d6d20702d6 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Get-AzSqlVirtualCluster.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/get-azsqlvirtualcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlVirtualCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlVirtualCluster.md +--- + +# Get-AzSqlVirtualCluster + +## SYNOPSIS +Returns information about Azure SQL Virtual Cluster. + +## SYNTAX + +### GetVirtualClusterByResourceGroup (Default) +``` +Get-AzSqlVirtualCluster [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetVirtualClusterByNameAndResourceGroup +``` +Get-AzSqlVirtualCluster [-Name] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetVirtualClusterByResourceId +``` +Get-AzSqlVirtualCluster [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSqlVirtualCluster** cmdlet returns information about one or more Azure SQL Virtual Clusters. +Specify the name of a virtual cluster to see information for only that cluster. + +## EXAMPLES + +### Example 1: Get all virtual clusters assigned to a resource group +```powershell +Get-AzSqlVirtualCluster -ResourceGroupName ResourceGroup01 +``` + +```output +Location : eastus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/virtualClusters/VirtualCluster1 +ResourceGroupName : ResourceGroup01 +VirtualClusterName : VirtualCluster1 +Tags : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name1 + +Location : eastus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/virtualClusters/VirtualCluster2 +ResourceGroupName : ResourceGroup01 +VirtualClusterName : VirtualCluster2 +Tags : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name2 + +Location : eastus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/virtualClusters/VirtualCluster3 +ResourceGroupName : ResourceGroup01 +VirtualClusterName : VirtualCluster3 +Tags : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name3 +``` + +This command gets information about all Virtual Clusters assigned to the resource group ResourceGroup01. + +### Example 2: Get information about specific virtual cluster +```powershell +Get-AzSqlVirtualCluster -Name VirtualCluster1 -ResourceGroupName ResourceGroup01 +``` + +```output +Location : eastus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/virtualClusters/VirtualCluster1 +ResourceGroupName : ResourceGroup01 +VirtualClusterName : VirtualCluster1 +Tags : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name1 +``` + +This command gets information about the virtual cluster VirtualCluster1 in resource group ResourceGroup01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the virtual cluster. + +```yaml +Type: System.String +Parameter Sets: GetVirtualClusterByNameAndResourceGroup +Aliases: VirtualClusterName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: GetVirtualClusterByResourceGroup +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetVirtualClusterByNameAndResourceGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance object to get + +```yaml +Type: System.String +Parameter Sets: GetVirtualClusterByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VirtualCluster.Model.AzureSqlVirtualClusterModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Invoke-AzSqlDatabaseFailover.md b/azps-10.1.0/Az.Sql/Invoke-AzSqlDatabaseFailover.md new file mode 100644 index 0000000000..d5a3990db9 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Invoke-AzSqlDatabaseFailover.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/invoke-azsqldatabasefailover +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlDatabaseFailover.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlDatabaseFailover.md +--- + +# Invoke-AzSqlDatabaseFailover + +## SYNOPSIS +Failovers a database. + +## SYNTAX + +``` +Invoke-AzSqlDatabaseFailover [-DatabaseName] <String> [-ReadableSecondary] [-AsJob] [-PassThru] [-Force] + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Invoke-AzSqlDatabaseFailover cmdlet failovers an Azure SQL database. If the database is in an elastic pool, this command will failover the given database without affecting the other databases in the same elastic pool. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzSqlDatabaseFailover -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +This command will failover the primary replica of the database named "Database01" on the server named "Server01" + +### Example 2 +```powershell +Invoke-AzSqlDatabaseFailover -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -ReadableSecondary +``` + +This command will failover the readable secondary replica of the database named "Database01" on the server named "Server01" + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Database to failover. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +On Successful execution, returns true. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadableSecondary +Failover the readable secondary replica instead of the default primary replica + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Database Server the database is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabase](./Get-AzSqlDatabase.md) + +[Invoke-AzSqlElasticPoolFailover](./Invoke-AzSqlElasticPoolFailover.md) + +[New-AzSqlDatabase](./New-AzSqlDatabase.md) + +[Remove-AzSqlDatabase](./Remove-AzSqlDatabase.md) + +[Resume-AzSqlDatabase](./Resume-AzSqlDatabase.md) + +[Set-AzSqlDatabase](./Set-AzSqlDatabase.md) + +[Suspend-AzSqlDatabase](./Suspend-AzSqlDatabase.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation.md b/azps-10.1.0/Az.Sql/Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation.md new file mode 100644 index 0000000000..87c5bc8311 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation.md +--- + +# Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation + +## SYNOPSIS +Revalidates Database Encryption Protector AKV key + +## SYNTAX + +``` +Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation -DatabaseName <String> [-AsJob] + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation** cmdlet revalidates Database Encryption Protector AKV key + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation -DatabaseName "Database01" -ServerName "Server01" -ResourceGroupName "ResourceGroup01" +``` + +Revalidates AKV key for "Database01" on SQL server "Server01" + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Database to revalidate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Database Server the database is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert.md b/azps-10.1.0/Az.Sql/Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert.md new file mode 100644 index 0000000000..b4719eddf6 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert.md +--- + +# Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert + +## SYNOPSIS +Reverts Database Encryption Protector AKV key to Server level key + +## SYNTAX + +``` +Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert -DatabaseName <String> [-AsJob] + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert** cmdlet reverts Database Encryption Protector AKV key to Server level TDE key + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert -DatabaseName "Database01" -ServerName "Server01" -ResourceGroupName "ResourceGroup01" +``` + +Reverts the AKV key for "Database01" on SQL server "Server01" + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Database to revert. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Database Server the database is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Invoke-AzSqlElasticPoolFailover.md b/azps-10.1.0/Az.Sql/Invoke-AzSqlElasticPoolFailover.md new file mode 100644 index 0000000000..bd0b16b5be --- /dev/null +++ b/azps-10.1.0/Az.Sql/Invoke-AzSqlElasticPoolFailover.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/invoke-azsqlelasticpoolfailover +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlElasticPoolFailover.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlElasticPoolFailover.md +--- + +# Invoke-AzSqlElasticPoolFailover + +## SYNOPSIS +Failovers an elastic pool. + +## SYNTAX + +``` +Invoke-AzSqlElasticPoolFailover [-ElasticPoolName] <String> [-AsJob] [-PassThru] [-Force] + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Invoke-AzSqlElasticPoolFailover cmdlet failovers an elastic pool. Failover will occur on all databases in the elastic pool after running this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzSqlElasticPoolFailover -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" +``` + +This command will failover the elastic pool named "ElasticPool01" on the server named "Server01". This means failover will occur on all databases in the elastic pool named "ElasticPool01". + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +The name of the Azure SQL Elastic Pool to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +On Successful execution, returns true. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the Elastic Pool is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-AzSqlElasticPool](./Get-AzSqlElasticPool.md) + +[Get-AzSqlElasticPoolActivity](./Get-AzSqlElasticPoolActivity.md) + +[Get-AzSqlElasticPoolDatabase](./Get-AzSqlElasticPoolDatabase.md) + +[Invoke-AzSqlDatabaseFailover](./Invoke-AzSqlDatabaseFailover.md) + +[New-AzSqlElasticPool](./New-AzSqlElasticPool.md) + +[Remove-AzSqlElasticPool](./Remove-AzSqlElasticPool.md) + +[Set-AzSqlElasticPool](./Set-AzSqlElasticPool.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Invoke-AzSqlInstanceFailover.md b/azps-10.1.0/Az.Sql/Invoke-AzSqlInstanceFailover.md new file mode 100644 index 0000000000..f3025819fc --- /dev/null +++ b/azps-10.1.0/Az.Sql/Invoke-AzSqlInstanceFailover.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/invoke-AzSqlInstanceFailover +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlInstanceFailover.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlInstanceFailover.md +--- + +# Invoke-AzSqlInstanceFailover + +## SYNOPSIS +Failovers an Azure SQL Managed Instance. + +## SYNTAX + +``` +Invoke-AzSqlInstanceFailover [-Name] <String> [-AsJob] [-PassThru] [-Force] [-ReadableSecondary] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzSqlInstanceFailover** cmdlet failovers an Azure SQL Managed Instance. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzSqlInstanceFailover -ResourceGroupName "ResourceGroup01" -Name "ManagedInstance01" +``` + +This command will failover the primary replica of the instance named "ManagedInstance01". + +### Example 2 +```powershell +Invoke-AzSqlInstanceFailover -ResourceGroupName "ResourceGroup01" -Name "ManagedInstance01" -ReadableSecondary +``` + +This command will failover the readable secondary replica of the managed instance "ManagedInstance01". + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Azure SQL instance to fail over. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ManagedInstanceName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -PassThru +On Successful execution, returns true. By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadableSecondary +Failover the readable secondary replica instead of the default primary replica + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation.md b/azps-10.1.0/Az.Sql/Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation.md new file mode 100644 index 0000000000..31d7d9f68e --- /dev/null +++ b/azps-10.1.0/Az.Sql/Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation.md @@ -0,0 +1,188 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation.md +--- + +# Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation + +## SYNOPSIS +Revalidates the Managed Instance Encryption Protector AKV key + +## SYNTAX + +### AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorDefaultParameterSet (Default) +``` +Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation [-AsJob] + [-ResourceGroupName] <String> [-InstanceName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorInputObjectParameterSet +``` +Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation [-AsJob] + [-Instance] <AzureSqlManagedInstanceModel> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorResourceIdParameterSet +``` +Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation [-AsJob] + [-InstanceResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation** cmdlet revalidates the Encryption Protector AKV key on managed instance + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation -ResourceGroupName "ResourceGroup01" -InstanceName "Instance01" +``` + +Revalidates AKV key for SQL Managed Instance "Instance01" + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +The instance input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorInputObjectParameterSet +Aliases: InputObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The instance name + +```yaml +Type: System.String +Parameter Sets: AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorDefaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceResourceId +The instance resource id + +```yaml +Type: System.String +Parameter Sets: AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorResourceIdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorDefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureRmSqlManagedInstanceTransparentDataEncryptionProtectorModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Invoke-AzSqlServerExternalGovernanceStatusRefresh.md b/azps-10.1.0/Az.Sql/Invoke-AzSqlServerExternalGovernanceStatusRefresh.md new file mode 100644 index 0000000000..084c226dc6 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Invoke-AzSqlServerExternalGovernanceStatusRefresh.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/invoke-azsqlserverexternalgovernancestatusrefresh +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlServerExternalGovernanceStatusRefresh.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlServerExternalGovernanceStatusRefresh.md +--- + +# Invoke-AzSqlServerExternalGovernanceStatusRefresh + +## SYNOPSIS +Refreshes the value of external governance on the server. + +## SYNTAX + +``` +Invoke-AzSqlServerExternalGovernanceStatusRefresh [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Refreshes the value of external governance on the server. If successful, the value of data use management, set in Microsoft Purview, will be fetched, and propagated down to the server. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzSqlServerExternalGovernanceStatusRefresh -ServerName MyServer -ResourceGroupName MyResourceGroup +``` + +Successfully refreshed external governance status + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ExternalGovernance.Model.RefreshExternalGovernanceModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation.md b/azps-10.1.0/Az.Sql/Invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation.md new file mode 100644 index 0000000000..cea05a873c --- /dev/null +++ b/azps-10.1.0/Az.Sql/Invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation.md +--- + +# Invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation + +## SYNOPSIS +Revalidates the Server Encryption Protector AKV key + +## SYNTAX + +``` +Invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation [-AsJob] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation** cmdlet revalidates the Server Encryption Protector AKV key + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation -ServerName "Server01" -ResourceGroupName "ResourceGroup01" +``` + +Revalidates AKV key for SQL server "Server01" + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlServerTransparentDataEncryptionProtectorModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Move-AzSqlInstanceDatabase.md b/azps-10.1.0/Az.Sql/Move-AzSqlInstanceDatabase.md new file mode 100644 index 0000000000..bf97193ea8 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Move-AzSqlInstanceDatabase.md @@ -0,0 +1,347 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/move-azsqlinstancedatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Move-AzSqlInstanceDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Move-AzSqlInstanceDatabase.md +--- + +# Move-AzSqlInstanceDatabase + +## SYNOPSIS +Move managed database to another managed instance. + +## SYNTAX + +### MoveCopyManagedDatabaseByNameParameterSet (Default) +``` +Move-AzSqlInstanceDatabase -DatabaseName <String> -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByOperationObjectParameterSet +``` +Move-AzSqlInstanceDatabase [-DatabaseName <String>] [-InstanceName <String>] [-ResourceGroupName <String>] + -MoveCopyOperationObject <ManagedDatabaseMoveCopyOperation> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByInputObjectParameterSet +``` +Move-AzSqlInstanceDatabase -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> + -DatabaseObject <AzureSqlManagedDatabaseModel> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByResourceIdParameterSet +``` +Move-AzSqlInstanceDatabase -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> -ResourceId <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Move-AzSqlInstanceDatabase** cmdlet start online move operation of a database across managed instances by using Always On availability group technology. [Learn more](https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/database-copy-move-how-to?view=azuresql) + +## EXAMPLES + +### Example 1: Move database to another Managed Instance in the same resource group +```powershell +Move-AzSqlInstanceDatabase -ResourceGroupName RG1 -InstanceName MI1 -Name database1 -TargetInstanceName MI2 +``` + +This command moves database1 from instance MI1 to MI2 + +### Example 2: Move database to another Managed Instance in the different resource group +```powershell +Move-AzSqlInstanceDatabase -ResourceGroupName RG1 -InstanceName MI1 -Name database1 -TargetResourceGroupName RG2 -TargetInstanceName MI2 +``` + +This command moves database1 from instance MI1 in resource group RG1 to MI2 in resource group RG2 + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Name of the instance database. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +Managed database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of the source instance. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCopyOperationObject +Managed database move or copy operation object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: Operation + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Signal to receive output from a cmdlet which does not return anything + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the source resource group. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource id of managed database. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetInstanceName +Name of the target Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByInputObjectParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +Name of the target resource group. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByInputObjectParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel + +## NOTES + +## RELATED LINKS + +[Complete-AzSqlInstanceDatabaseMove](./Complete-AzSqlInstanceDatabaseMove.md) + +[Stop-AzSqlInstanceDatabaseMove](./Stop-AzSqlInstanceDatabaseMove.md) + +[Get-AzSqlInstanceDatabaseMoveOperation](./Get-AzSqlInstanceDatabaseMoveOperation.md) + +[Copy-AzSqlInstanceDatabase](./Copy-AzSqlInstanceDatabase.md) diff --git a/azps-10.1.0/Az.Sql/New-AzSqlDatabase.md b/azps-10.1.0/Az.Sql/New-AzSqlDatabase.md new file mode 100644 index 0000000000..f397e55563 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlDatabase.md @@ -0,0 +1,796 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: D2DB7821-A7D2-4017-8522-78793DDE040E +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabase.md +--- + +# New-AzSqlDatabase + +## SYNOPSIS +Creates a database or an elastic database. + +## SYNTAX + +### DtuBasedDatabase (Default) +``` +New-AzSqlDatabase -DatabaseName <String> [-CollationName <String>] [-CatalogCollation <String>] + [-MaxSizeBytes <Int64>] [-Edition <String>] [-RequestedServiceObjectiveName <String>] + [-ElasticPoolName <String>] [-ReadScale <DatabaseReadScale>] [-Tags <Hashtable>] [-SampleName <String>] + [-ZoneRedundant] [-AsJob] [-Force] [-LicenseType <String>] [-AutoPauseDelayInMinutes <Int32>] + [-MinimumCapacity <Double>] [-HighAvailabilityReplicaCount <Int32>] [-BackupStorageRedundancy <String>] + [-SecondaryType <String>] [-MaintenanceConfigurationId <String>] [-EnableLedger] + [-PreferredEnclaveType <String>] [-AssignIdentity] [-EncryptionProtector <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### VcoreBasedDatabase +``` +New-AzSqlDatabase -DatabaseName <String> [-CollationName <String>] [-CatalogCollation <String>] + [-MaxSizeBytes <Int64>] -Edition <String> [-ReadScale <DatabaseReadScale>] [-Tags <Hashtable>] + [-SampleName <String>] [-ZoneRedundant] [-AsJob] [-Force] -VCore <Int32> -ComputeGeneration <String> + [-LicenseType <String>] [-ComputeModel <String>] [-AutoPauseDelayInMinutes <Int32>] + [-MinimumCapacity <Double>] [-HighAvailabilityReplicaCount <Int32>] [-BackupStorageRedundancy <String>] + [-SecondaryType <String>] [-MaintenanceConfigurationId <String>] [-EnableLedger] + [-PreferredEnclaveType <String>] [-AssignIdentity] [-EncryptionProtector <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlDatabase** cmdlet creates an Azure SQL database. +You can also create an elastic database by setting the *ElasticPoolName* parameter to an existing elastic pool. + +## EXAMPLES + +### Example 1: Create a database on a specified server +```powershell +New-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +Location : Central US +DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 +Edition : Standard +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 268435456000 +Status : Online +CreationDate : 7/3/2015 7:33:37 AM +CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +CurrentServiceObjectiveName : S0 +RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +LicenseType : +Tags : +EnableLedger : False +``` + +This command creates a database named Database01 on server Server01. + +### Example 2: Create an elastic database on a specified server +```powershell +New-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database02" -ElasticPoolName "ElasticPool01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database02 +Location : Central US +DatabaseId : 7bd9d561-42a7-484e-bf05-62ddef8015ab +Edition : Standard +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 268435456000 +Status : Online +CreationDate : 8/26/2015 10:04:29 PM +CurrentServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 +CurrentServiceObjectiveName : ElasticPool +RequestedServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 +RequestedServiceObjectiveName : +ElasticPoolName : ElasticPool01 +EarliestRestoreDate : +LicenseType : +Tags : +EnableLedger : False +``` + +This command creates a database named Database02 in the elastic pool named ElasticPool01 on server Server01. + +### Example 3: Create an Vcore database on a specified server +```powershell +New-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database03" -Edition "GeneralPurpose" -Vcore 2 -ComputeGeneration "Gen4" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database03 +Location : Central US +DatabaseId : 34d9d561-42a7-484e-bf05-62ddef8000ab +Edition : GeneralPurpose +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 268435456000 +Status : Online +CreationDate : 8/26/2015 10:04:29 PM +CurrentServiceObjectiveName : GP_Gen4_2 +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +LicenseType : LicenseIncluded +Tags : +EnableLedger : False +``` + +This command creates a Vcore database named Database03 on server Server01. + +### Example 4: Create an Serverless database on the specified server +```powershell +New-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database04" -Edition "GeneralPurpose" -Vcore 2 -ComputeGeneration "Gen5" -ComputeModel Serverless +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database04 +Location : Central US +DatabaseId : ef5a9698-012c-4def-8d94-7f6bfb7b4f04 +Edition : GeneralPurpose +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 34359738368 +Status : Online +CreationDate : 4/12/2019 11:20:29 PM +CurrentServiceObjectiveName : GP_S_Gen5_2 +RequestedServiceObjectiveName : GP_S_Gen5_2 +ElasticPoolName : +EarliestRestoreDate : 4/12/2019 11:50:29 PM +Tags : +CreateMode : +ReadScale : Disabled +ZoneRedundant : False +Capacity : 2 +Family : Gen5 +SkuName : GP_S_Gen5 +LicenseType : LicenseIncluded +AutoPauseDelayInMinutes : 360 +EnableLedger : False +MinimumCapacity : 0.5 +``` + +This command creates a Serverless database named Database04 on server Server01. + +### Example 5: Create a database configured with preferred enclave type as VBS + +```powershell +New-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -Edition "GeneralPurpose" -Vcore 2 -ComputeGeneration "Gen5" -PreferredEnclaveType "VBS" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +Location : Central US +DatabaseId : 34d9d561-42a7-484e-bf05-62ddef8000ab +Edition : GeneralPurpose +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 268435456000 +Status : Online +CreationDate : 8/26/2015 10:04:29 PM +CurrentServiceObjectiveName : GP_Gen5_2 +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +LicenseType : LicenseIncluded +Tags : +EnableLedger : False +PreferredEnclaveType : VBS +``` + +This command creates a database configured with VBS enclave + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign an Azure Active Directory Identity for this database for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoPauseDelayInMinutes +The auto pause delay in minutes for database(serverless only), -1 to opt out + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupStorageRedundancy +The Backup storage redundancy used to store backups for the SQL Database. Options are: Local, Zone and Geo. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Local, Zone, Geo, GeoZone + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CatalogCollation +Specifies the name of the SQL database catalog collation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollationName +Specifies the name of the SQL database collation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeGeneration +The compute generation to assign. + +```yaml +Type: System.String +Parameter Sets: VcoreBasedDatabase +Aliases: Family + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeModel +The compute model for Azure Sql database. Serverless or Provisioned + +```yaml +Type: System.String +Parameter Sets: VcoreBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Edition +Specifies the edition to assign to the database. The acceptable values for this parameter are: +- None +- Basic +- Standard +- Premium +- DataWarehouse +- Free +- Stretch +- GeneralPurpose +- BusinessCritical + +```yaml +Type: System.String +Parameter Sets: DtuBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: VcoreBasedDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies the name of the elastic pool in which to put the database. + +```yaml +Type: System.String +Parameter Sets: DtuBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLedger +Creates a ledger database, in which the integrity of all data is protected by the ledger feature. All tables in the ledger database must be ledger tables. Note: the value of this property cannot be changed after the database has been created. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionProtector +The encryption protector key for SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedClientId +The federated client id for the SQL Database. It is used for cross tenant CMK scenario. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityReplicaCount +The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: ReadReplicaCount + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyList +The list of AKV keys for the SQL Database. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +The license type for the Azure Sql database. Possible values are: +- BasePrice - Azure Hybrid Benefit (AHB) discounted pricing for existing SQL Server license owners is applied. Database price will be discounted for existing SQL Server license owners. +- LicenseIncluded - Azure Hybrid Benefit (AHB) discount pricing for existing SQL Server license owners is not applied. Database price will include a new SQL Server license costs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceConfigurationId +The Maintenance configuration id for the SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSizeBytes +Specifies the maximum size of the database in bytes. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumCapacity +The Minimal capacity that database will always have allocated, if not paused. +For serverless Azure Sql databases only. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: MinVCore, MinCapacity + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredEnclaveType +The preferred enclave type for the Azure Sql database. Possible values are Default and VBS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadScale +If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.DatabaseReadScale +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, Enabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestedServiceObjectiveName +Specifies the name of the service objective to assign to the database. + +```yaml +Type: System.String +Parameter Sets: DtuBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SampleName +The name of the sample schema to apply when creating this database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AdventureWorksLT + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryType +The secondary type of the database if it is a secondary. Valid values are Geo and Named. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Named, Geo + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tags +Specifies a dictionary of Key-value pairs in the form of a hash table that this cmdlet associates +with the new database. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +The list of user assigned identity for the SQL Database. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VCore +The Vcore number for the Azure Sql database + +```yaml +Type: System.Int32 +Parameter Sets: VcoreBasedDatabase +Aliases: Capacity, MaxVCore, MaxCapacity + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +The zone redundancy to associate with the Azure Sql Database + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabase](./Get-AzSqlDatabase.md) + +[New-AzSqlElasticPool](./New-AzSqlElasticPool.md) + +[New-AzSqlServer](./New-AzSqlServer.md) + +[Remove-AzSqlDatabase](./Remove-AzSqlDatabase.md) + +[Resume-AzSqlDatabase](./Resume-AzSqlDatabase.md) + +[Set-AzSqlDatabase](./Set-AzSqlDatabase.md) + +[Suspend-AzSqlDatabase](./Suspend-AzSqlDatabase.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + diff --git a/azps-10.1.0/Az.Sql/New-AzSqlDatabaseCopy.md b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseCopy.md new file mode 100644 index 0000000000..b02f5822be --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseCopy.md @@ -0,0 +1,438 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: CED38886-2DC9-450E-91FF-8209602C76CD +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqldatabasecopy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseCopy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseCopy.md +--- + +# New-AzSqlDatabaseCopy + +## SYNOPSIS +Creates a copy of a SQL Database that uses the snapshot at the current time. + +## SYNTAX + +### DtuBasedDatabase (Default) +``` +New-AzSqlDatabaseCopy [-DatabaseName] <String> [-ServiceObjectiveName <String>] [-ElasticPoolName <String>] + [-Tags <Hashtable>] [-CopyResourceGroupName <String>] [-CopyServerName <String>] -CopyDatabaseName <String> + [-AsJob] [-LicenseType <String>] [-BackupStorageRedundancy <String>] [-ZoneRedundant] [-AssignIdentity] + [-EncryptionProtector <String>] [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### VcoreBasedDatabase +``` +New-AzSqlDatabaseCopy [-DatabaseName] <String> [-Tags <Hashtable>] [-CopyResourceGroupName <String>] + [-CopyServerName <String>] -CopyDatabaseName <String> [-AsJob] -ComputeGeneration <String> -VCore <Int32> + [-LicenseType <String>] [-BackupStorageRedundancy <String>] [-ZoneRedundant] [-AssignIdentity] + [-EncryptionProtector <String>] [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlDatabaseCopy** cmdlet creates a copy of an Azure SQL Database that uses the +snapshot of the data at the current time. Use this cmdlet instead of the Start-AzSqlDatabaseCopy +cmdlet to create a one-time database copy. This cmdlet returns the **Database** object of the copy. +Note: Use the New-AzSqlDatabaseSecondary cmdlet to configure geo-replication for a database. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1 + +Creates a copy of a SQL Database that uses the snapshot at the current time. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzSqlDatabaseCopy -CopyDatabaseName <String> -CopyResourceGroupName <String> -CopyServerName <String> -DatabaseName db1 -ResourceGroupName MyResourceGroup -ServerName s1 +``` + +### Example 2 + +Creates a copy of a SQL Database that uses the snapshot at the current time. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzSqlDatabaseCopy -CopyDatabaseName <String> -CopyResourceGroupName <String> -CopyServerName <String> -DatabaseName db1 -ResourceGroupName MyResourceGroup -ServerName s1 -ServiceObjectiveName 'S1' +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign an Azure Active Directory Identity for this database for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupStorageRedundancy +The Backup storage redundancy used to store backups for the SQL Database. Options are: Local, Zone and Geo. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Local, Zone, Geo, GeoZone + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeGeneration +The compute generation to assign to the new copy. + +```yaml +Type: System.String +Parameter Sets: VcoreBasedDatabase +Aliases: Family + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyDatabaseName +Specifies the name of the SQL Database copy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyResourceGroupName +Specifies the name of the Azure Resource Group in which to assign the copy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyServerName +Specifies the name of the SQL Server which hosts the copy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the SQL Database to copy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies the name of the elastic pool in which to assign the copy. + +```yaml +Type: System.String +Parameter Sets: DtuBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionProtector +The encryption protector key for SQL Database copy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedClientId +The federated client id for the SQL Database. It is used for cross tenant CMK scenario. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyList +The list of AKV keys for the SQL Database copy. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +The license type for the Azure Sql database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the Resource Group that contains the database to copy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL Server that contains the database to copy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceObjectiveName +Specifies the name of the service objective to assign to the copy. + +```yaml +Type: System.String +Parameter Sets: DtuBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +Specifies the Key-value pairs in the form of a hash table to associate with the Azure SQL Database copy. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +The list of user assigned identity for the SQL Database copy. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VCore +The Vcore numbers of the Azure Sql Database copy. + +```yaml +Type: System.Int32 +Parameter Sets: VcoreBasedDatabase +Aliases: Capacity + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +The zone redundancy to associate with the Azure Sql Database. This property is only settable for Hyperscale edition databases. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Replication.Model.AzureSqlDatabaseCopyModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlDatabaseSecondary](./New-AzSqlDatabaseSecondary.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/New-AzSqlDatabaseDataMaskingRule.md b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseDataMaskingRule.md new file mode 100644 index 0000000000..f9f629dba0 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseDataMaskingRule.md @@ -0,0 +1,337 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: A123CB7F-2F95-49EE-9F57-E264EB1F9093 +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqldatabasedatamaskingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseDataMaskingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseDataMaskingRule.md +--- + +# New-AzSqlDatabaseDataMaskingRule + +## SYNOPSIS +Creates a data masking rule for a database. + +## SYNTAX + +``` +New-AzSqlDatabaseDataMaskingRule -MaskingFunction <String> [-PrefixSize <UInt32>] [-ReplacementString <String>] + [-SuffixSize <UInt32>] [-NumberFrom <Double>] [-NumberTo <Double>] [-PassThru] -SchemaName <String> + -TableName <String> -ColumnName <String> [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlDatabaseDataMaskingRule** cmdlet creates a data masking rule for an Azure SQL database. +To use the cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the rule. +Provide the *TableName* and *ColumnName* to specify the target of the rule and the *MaskingFunction* parameter to define how the data is masked. +If *MaskingFunction* has a value of Number or Text, you can specify the *NumberFrom* and *NumberTo* parameters, for number masking, or the *PrefixSize*, *ReplacementString*, and *SuffixSize* for text masking. +If the command succeeds and the *PassThru* parameter is used, the cmdlet returns an object describing the data masking rule properties in addition to the rule identifiers. +Rule identifiers include, but are not limited to, *ResourceGroupName*, *ServerName*, *DatabaseName*, and *RuleID*. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Create a data masking rule for a number column in a database +```powershell +New-AzSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SchemaName "Schema01" -TableName "Table01" -ColumnName "Column01" -MaskingFunction "Number" -NumberFrom 5 -NumberTo 14 +``` + +This command creates a data masking rule for the column named Column01 in the table named Table01 in the schema named Schema01. +The database named Database01 contains all these items. +The rule is a number masking rule that uses a random number between 5 and 14 as the mask value. + +## PARAMETERS + +### -ColumnName +Specifies the name of the column targeted by the masking rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaskingFunction +Specifies the masking function that the rule uses. +The acceptable values for this parameter are: +- Default +- NoMasking +- Text +- Number +- SocialSecurityNumber +- CreditCardNumber +- Email +The default value is Default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: NoMasking, Default, Text, Number, SocialSecurityNumber, CreditCardNumber, Email + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NumberFrom +Specifies the lower bound number of the interval from which a random value is selected. +Specify this parameter only if you specify a value of Number for the *MaskingFunction* parameter. +The default value is 0. + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NumberTo +Specifies the upper bound number of the interval from which a random value is selected. +Specify this parameter only if you specify a value of Number for the *MaskingFunction* parameter. +The default value is 0. + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrefixSize +Specifies the number of characters at the start of the text that are not masked. +Specify this parameter only if you specify a value of Text for the *MaskingFunction* parameter. +The default value is 0. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReplacementString +Specifies the number of characters in the end of the text that are not masked. +Specify this parameter only if you specify a value of Text for the *MaskingFunction* parameter. +The default value is an empty string. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Specifies the name of a schema. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SuffixSize +Specifies the number of characters at the end of the text that are not masked. +Specify this parameter only if you specify a value of Text for the *MaskingFunction* parameter. +The default value is 0. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Specifies the name of the database table that contains the masked column. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.UInt32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[System.Double, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataMasking.Model.DatabaseDataMaskingRuleModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseDataMaskingRule](./Get-AzSqlDatabaseDataMaskingRule.md) + +[Remove-AzSqlDatabaseDataMaskingRule](./Remove-AzSqlDatabaseDataMaskingRule.md) + +[Set-AzSqlDatabaseDataMaskingRule](./Set-AzSqlDatabaseDataMaskingRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/New-AzSqlDatabaseExport.md b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseExport.md new file mode 100644 index 0000000000..1637fdcf46 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseExport.md @@ -0,0 +1,324 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 3D4822DD-736B-42DF-8D9A-1CB23FEF052E +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqldatabaseexport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseExport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseExport.md +--- + +# New-AzSqlDatabaseExport + +## SYNOPSIS +Exports an Azure SQL Database as a .bacpac file to a storage account. + +## SYNTAX + +``` +New-AzSqlDatabaseExport [-DatabaseName] <String> [-ServerName] <String> -StorageKeyType <StorageKeyType> + -StorageKey <String> -StorageUri <Uri> -AdministratorLogin <String> -AdministratorLoginPassword <SecureString> + [-AuthenticationType <AuthenticationType>] [-UseNetworkIsolation <Boolean>] + [-StorageAccountResourceIdForPrivateLink <String>] [-SqlServerResourceIdForPrivateLink <String>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlDatabaseExport** cmdlet exports an Azure SQL Database as a .bacpac file to a storage account. +The get export database status request may be sent to retrieve status information for this request. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +> [!IMPORTANT] +> In order to make use of this cmdlet the firewall on the Azure SQL Server will need to be configured to "Allow Azure services and resources to access this server". If this is not configured then GatewayTimeout errors will be experienced. + +## EXAMPLES + +### Example 1: Create an export request for a database +```powershell +New-AzSqlDatabaseExport -ResourceGroupName "RG01" -ServerName "Server01" -DatabaseName "Database01" -StorageKeyType "StorageAccessKey" -StorageKey "StorageKey01" -StorageUri "http://account01.blob.core.contoso.net/bacpacs/database01.bacpac" -AdministratorLogin "User" -AdministratorLoginPassword "secure password" +``` + +```output +ResourceGroupName : RG01 +ServerName : Server01 +DatabaseName : Database01 +StorageKeyType : StorageAccessKey +StorageKey : +StorageUri : http://account01.blob.core.contoso.net/bacpacs/database01.bacpac +AdministratorLogin : User +AdministratorLoginPassword : +AuthenticationType : None +OperationStatusLink : https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resource01/providers/Microsoft.Sql/servers/server01/databases/database01/importExportOperationResults/00000000-00 + 0-0000-0000-000000000000?api-version=2014-04-01 +Status : InProgress +ErrorMessage : +``` + +This command creates an export request for the specified database. + +## PARAMETERS + +### -AdministratorLogin +Specifies the name of the SQL administrator. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorLoginPassword +Specifies the password of the SQL administrator. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationType +Specifies the type of authentication used to access the server. +The default value is SQL if no authentication type is set. +The acceptable values for this parameter are: +- Sql. +SQL authentication. +Set the *AdministratorLogin* and *AdministratorLoginPassword* to the SQL administrator username and password. +- ADPassword. +Azure Active Directory authentication. +Set *AdministratorLogin* and *AdministratorLoginPassword* to the Azure AD administrator username and password. +This parameter is only available on SQL Database V12 servers. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ImportExport.Model.AuthenticationType +Parameter Sets: (All) +Aliases: +Accepted values: None, Sql, AdPassword + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for the SQL Database server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL Database server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlServerResourceIdForPrivateLink +The sql server resource id to create private link + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceIdForPrivateLink +The storage account resource id to create private link + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageKey +Specifies the access key for the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageKeyType +Specifies the type of access key for the storage account. +The acceptable values for this parameter are: +- StorageAccessKey. +This value uses a storage account key. +- SharedAccessKey. +This value uses a Shared Access Signature (SAS) key. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ImportExport.Model.StorageKeyType +Parameter Sets: (All) +Aliases: +Accepted values: StorageAccessKey, SharedAccessKey + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageUri +Specifies the blob link, as a URL, to the .bacpac file. + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseNetworkIsolation +If set, will create private link for storage account and/or SQL server + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ImportExport.Model.AzureSqlDatabaseImportExportBaseModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + +## RELATED LINKS + +[Get-AzSqlDatabaseImportExportStatus](./Get-AzSqlDatabaseImportExportStatus.md) + +[New-AzSqlDatabaseImport](./New-AzSqlDatabaseImport.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/New-AzSqlDatabaseFailoverGroup.md b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseFailoverGroup.md new file mode 100644 index 0000000000..262eda4232 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseFailoverGroup.md @@ -0,0 +1,254 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqldatabasefailovergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseFailoverGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseFailoverGroup.md +--- + +# New-AzSqlDatabaseFailoverGroup + +## SYNOPSIS +This command creates a new Azure SQL Database Failover Group. + +## SYNTAX + +``` +New-AzSqlDatabaseFailoverGroup [-ServerName] <String> -FailoverGroupName <String> + [-PartnerSubscriptionId <String>] [-PartnerResourceGroupName <String>] -PartnerServerName <String> + [-FailoverPolicy <FailoverPolicy>] [-GracePeriodWithDataLossHours <Int32>] + [-AllowReadOnlyFailoverToPrimary <AllowReadOnlyFailoverToPrimary>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Azure SQL Database Failover Group for the specified servers. +Two Azure SQL Database TDS endpoints are created at FailoverGroupName.SqlDatabaseDnsSuffix (for example, FailoverGroupName.database.windows.net) and FailoverGroupName.secondary.SqlDatabaseDnsSuffix. These endpoints may be used to connect to the primary and secondary servers in the Failover Group, respectively. If the primary server is affected by an outage, automatic failover of the endpoints and databases will be triggered as dictated by the Failover Group's failover policy and grace period. +Newly created Failover Groups do not contain any databases. To control the set of databases in a Failover Group, use the 'Add-AzSqlDatabaseToFailoverGroup' and 'Remove-AzSqlDatabaseFromFailoverGroup' cmdlets. +Only values greater than or equal to 1 hour are supported for the '-GracePeriodWithDataLossHours' parameter. + +[!NOTE] It's possible to deploy your auto-failover group across subscriptions by using the -PartnerSubscriptionId parameter in Azure Powershell starting with [Az.SQL 3.11.0](https://www.powershellgallery.com/packages/Az.Sql/3.11.0). + + +## EXAMPLES + +### Example 1 +```powershell +$failoverGroup = New-AzSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -PartnerServerName secondaryserver -FailoverGroupName fg -FailoverPolicy Automatic -GracePeriodWithDataLossHours 1 +``` + +This command creates a new Failover Group with failover policy 'Automatic' for two servers in the same resource group. + +### Example 2 +```powershell +$failoverGroup = New-AzSqlDatabaseFailoverGroup -ResourceGroupName rg1 -ServerName primaryserver -PartnerResourceGroupName rg2 -PartnerServerName secondaryserver1 -FailoverGroupName fg -FailoverPolicy Manual +``` + +This command creates a new Failover Group with failover policy 'Manual' for two servers in different resource groups. + +### Example 3 +```powershell +$sub2 = 'b3c40cd6-024f-428c-921b-cda6c6834c34' +$failoverGroup = New-AzSqlDatabaseFailoverGroup -ServerName primaryserver -FailoverGroupName fg -PartnerSubscriptionId $sub2 -PartnerResourceGroupName rg2 -PartnerServerName secondaryserver1 -FailoverPolicy Manual -ResourceGroupName rg1 +``` + +```output +FailoverGroupName : fg +Location : East US +ResourceGroupName : rg1 +ServerName : primaryserver +PartnerLocation : West US 2 +PartnerResourceGroupName : rg2 +PartnerServerName : secondaryserver1 +ReplicationRole : Primary +ReplicationState : CATCH_UP +ReadWriteFailoverPolicy : Manual +FailoverWithDataLossGracePeriodHours : +DatabaseNames : {} +``` + +This command creates a new Failover Group with failover policy 'Manual' for two servers in different subscriptions. + +## PARAMETERS + +### -AllowReadOnlyFailoverToPrimary +Whether an outage on the secondary server should trigger automatic failover of the read-only endpoint. + +```yaml +Type: Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AllowReadOnlyFailoverToPrimary +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverGroupName +The name of the Azure SQL Database Failover Group to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverPolicy +The failover policy of the Azure SQL Database Failover Group. + +```yaml +Type: Microsoft.Azure.Commands.Sql.FailoverGroup.Model.FailoverPolicy +Parameter Sets: (All) +Aliases: +Accepted values: Automatic, Manual + +Required: False +Position: Named +Default value: Automatic +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GracePeriodWithDataLossHours +Interval before automatic failover is initiated if an outage occurs on the primary server and failover cannot be completed without data loss. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerResourceGroupName +The name of the secondary resource group of the Azure SQL Database Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerServerName +The name of the secondary server of the Azure SQL Database Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerSubscriptionId +The name of the secondary subscription id of the Azure SQL Database Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the primary Azure SQL Database Server of the Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel + +## NOTES + +## RELATED LINKS + +[Set-AzSqlDatabaseFailoverGroup](./Set-AzSqlDatabaseFailoverGroup.md) + +[Get-AzSqlDatabaseFailoverGroup](./Get-AzSqlDatabaseFailoverGroup.md) + +[Add-AzSqlDatabaseToFailoverGroup](./Add-AzSqlDatabaseToFailoverGroup.md) + +[Remove-AzSqlDatabaseFromFailoverGroup](./Remove-AzSqlDatabaseFromFailoverGroup.md) + +[Switch-AzSqlDatabaseFailoverGroup](./Switch-AzSqlDatabaseFailoverGroup.md) + +[Remove-AzSqlDatabaseFailoverGroup](./Remove-AzSqlDatabaseFailoverGroup.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/New-AzSqlDatabaseImport.md b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseImport.md new file mode 100644 index 0000000000..0a08fb686d --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseImport.md @@ -0,0 +1,384 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: A1327BC6-F090-490E-8DC2-2CC48A21C2C0 +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqldatabaseimport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseImport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseImport.md +--- + +# New-AzSqlDatabaseImport + +## SYNOPSIS +Imports a .bacpac file and create a new database on the server. + +## SYNTAX + +``` +New-AzSqlDatabaseImport -DatabaseName <String> -Edition <DatabaseEdition> -ServiceObjectiveName <String> + -DatabaseMaxSizeBytes <Int64> [-ServerName] <String> -StorageKeyType <StorageKeyType> -StorageKey <String> + -StorageUri <Uri> -AdministratorLogin <String> -AdministratorLoginPassword <SecureString> + [-AuthenticationType <AuthenticationType>] [-UseNetworkIsolation <Boolean>] + [-StorageAccountResourceIdForPrivateLink <String>] [-SqlServerResourceIdForPrivateLink <String>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlDatabaseImport** cmdlet imports a bacpac file from an Azure storage account to a new Azure SQL Database. +The get import database status request may be sent to retrieve status information for this request. + +## EXAMPLES + +### Example 1: Create an import request for a bacpac file +```powershell +New-AzSqlDatabaseImport -ResourceGroupName "RG01" -ServerName "Server01" -DatabaseName "Database01" -StorageKeyType "StorageAccessKey" -StorageKey "StorageKey01" -StorageUri "http://account01.blob.core.contoso.net/bacpacs/database01.bacpac" -AdministratorLogin "User" -AdministratorLoginPassword $SecureString -Edition Standard -ServiceObjectiveName S0 -DatabaseMaxSizeBytes 5000000 +``` + +```output +ResourceGroupName : RG01 +ServerName : Server01 +DatabaseName : Database01 +StorageKeyType : StorageAccessKey +StorageKey : +StorageUri : http://account01.blob.core.contoso.net/bacpacs/database01.bacpac +AdministratorLogin : User +AdministratorLoginPassword : +AuthenticationType : None +OperationStatusLink : https://management.contoso.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resource01/providers/Microsoft.Sql/servers/server01/databases/database01/importExportOperationResults/00000000-00 + 0-0000-0000-000000000000?api-version=2014-04-01 +Status : InProgress +ErrorMessage : +``` + +This command creates an import request to import a .bacpac to a new database. + +### Example 2 + +Imports a .bacpac file and create a new database on the server. (autogenerated) + +<!-- Aladdin Generated Example --> + +```powershell +New-AzSqlDatabaseImport -AdministratorLogin 'User' -AdministratorLoginPassword <SecureString> -AuthenticationType None -DatabaseMaxSizeBytes 5000000 -DatabaseName 'Database01' -Edition None -ResourceGroupName 'RG01' -ServerName 'Server01' -ServiceObjectiveName S0 -StorageKey 'StorageKey01' -StorageKeyType StorageAccessKey -StorageUri 'https://account01.blob.core.contoso.net/bacpacs/database01.bacpac' +``` + +## PARAMETERS + +### -AdministratorLogin +Specifies the name of the SQL administrator. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorLoginPassword +Specifies the password of the SQL administrator. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthenticationType +Specifies the type of authentication used to access the server. +This parameter defaults to SQL if no authentication type is set. +The acceptable values for this parameter are: +- SQL. +SQL authentication. +Set the *AdministratorLogin* and *AdministratorLoginPassword* parameters to the SQL administrator username and password. +- ADPassword. +Azure Active Directory authentication. +Set *AdministratorLogin* and *AdministratorLoginPassword* to the Azure Active Directory administrator username and password. +This parameter is only available on SQL Database V12 servers. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ImportExport.Model.AuthenticationType +Parameter Sets: (All) +Aliases: +Accepted values: None, Sql, AdPassword + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseMaxSizeBytes +Specifies the maximum size for the newly imported database. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Edition +Specifies the edition of the new database to import to. +The acceptable values for this parameter are: +- Premium +- Basic +- Standard +- DataWarehouse +- Free + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.DatabaseEdition +Parameter Sets: (All) +Aliases: +Accepted values: None, Premium, Basic, Standard, DataWarehouse, Stretch, Free, PremiumRS, GeneralPurpose, BusinessCritical, Hyperscale + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group for the SQL Database server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL Database server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceObjectiveName +Specifies the name of the service objective to assign to the Azure SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlServerResourceIdForPrivateLink +The sql server resource id to create private link + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceIdForPrivateLink +The storage account resource id to create private link + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageKey +Specifies the access key for the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageKeyType +Specifies the type of access key for the storage account. +The acceptable values for this parameter are: +- StorageAccessKey. +Uses the storage account key. +- SharedAccessKey. +Uses the Shared Access Signature (SAS) key. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ImportExport.Model.StorageKeyType +Parameter Sets: (All) +Aliases: +Accepted values: StorageAccessKey, SharedAccessKey + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageUri +Specifies the blob URI of the .bacpac file. + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseNetworkIsolation +If set, will create private link for storage account and/or SQL server + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ImportExport.Model.AzureSqlDatabaseImportExportBaseModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + +## RELATED LINKS + +[Get-AzSqlDatabaseImportExportStatus](./Get-AzSqlDatabaseImportExportStatus.md) + +[New-AzSqlDatabaseExport](./New-AzSqlDatabaseExport.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + diff --git a/azps-10.1.0/Az.Sql/New-AzSqlDatabaseInstanceFailoverGroup.md b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseInstanceFailoverGroup.md new file mode 100644 index 0000000000..a8335b798e --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseInstanceFailoverGroup.md @@ -0,0 +1,332 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/new-Azsqldatabaseinstancefailovergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseInstanceFailoverGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseInstanceFailoverGroup.md +--- + +# New-AzSqlDatabaseInstanceFailoverGroup + +## SYNOPSIS +This command creates a new Azure SQL Database Instance Failover Group. + +## SYNTAX + +``` +New-AzSqlDatabaseInstanceFailoverGroup [-Name] <String> [-PartnerResourceGroupName <String>] + -PartnerRegion <String> -PrimaryManagedInstanceName <String> -PartnerManagedInstanceName <String> + [-PartnerSubscriptionId <String>] [-FailoverPolicy <String>] [-GracePeriodWithDataLossHours <Int32>] + [-AllowReadOnlyFailoverToPrimary <String>] [-SecondaryType <String>] [-ResourceGroupName] <String> + [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Azure SQL Database Instance Failover Group between the specified regions with the noted Managed Instance pair. + +Two Azure SQL Database TDS endpoints are created at Name.SqlDatabaseDnsSuffix (for example, Name.database.windows.net) and Name.secondary.SqlDatabaseDnsSuffix. These endpoints may be used to connect to the primary and secondary regions of the Failover Group, respectively. If the primary region is affected by an outage, automatic failover of the endpoints and databases will be triggered as dictated by the Instance Failover Group's failover policy and grace period. + +During preview of the Instance Failover Groups feature, only values greater than or equal to 1 hour are supported for the '-GracePeriodWithDataLossHours' parameter. + +## EXAMPLES + +### Example 1 +```powershell +$failoverGroup = New-AzSqlDatabaseInstanceFailoverGroup -Name fgName -Location location -ResourceGroupName rg -PrimaryManagedInstanceName $managedInstance.Name -PartnerRegion $partnerRegion -PartnerManagedInstanceName $partnerManagedInstance.Name -FailoverPolicy Automatic -GracePeriodWithDataLossHours 1 +``` + +```output +ResourceGroupName : rg +Location : East US +Name : fg +PartnerResourceGroupName : rg +PartnerRegion : West US +PrimaryManagedInstanceName : managedInstance1 +PartnerManagedInstanceName : managedInstance2 +ReplicationRole : Primary +ReplicationState : CATCH_UP +ReadWriteFailoverPolicy : Automatic +FailoverWithDataLossGracePeriodHours : 1 +ReadOnlyFailoverPolicy : Disabled +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rg/providers/Microsoft.Sql/locations/eastus/instanceFailoverGroups/fg +``` + +This command creates a new Instance Failover Group with failover policy 'Automatic' for the Managed Instance pair. + +### Example 2 +```powershell +$failoverGroup = New-AzSqlDatabaseInstanceFailoverGroup -Name fgName -Location location -ResourceGroupName rg -PrimaryManagedInstanceName $managedInstance.Name -PartnerRegion $partnerRegion -PartnerManagedInstanceName $partnerManagedInstance.Name -FailoverPolicy Manual +``` + +```output +ResourceGroupName : rg +Location : East US +Name : fg +PartnerResourceGroupName : rg +PartnerRegion : West US +PrimaryManagedInstanceName : managedInstance1 +PartnerManagedInstanceName : managedInstance2 +ReplicationRole : Primary +ReplicationState : CATCH_UP +ReadWriteFailoverPolicy : Manual +FailoverWithDataLossGracePeriodHours : +ReadOnlyFailoverPolicy : Disabled +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rg/providers/Microsoft.Sql/locations/eastus/instanceFailoverGroups/fg +``` + +This command creates a new Instance Failover Group with failover policy 'Manual' for the Managed Instance pair. + +### Example 3 + +This command creates a new Azure SQL Database Instance Failover Group. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzSqlDatabaseInstanceFailoverGroup -FailoverPolicy Automatic -GracePeriodWithDataLossHours 1 -Location location -Name fgName -PartnerManagedInstanceName $partnerManagedInstance.Name -PartnerRegion $partnerRegion -PartnerResourceGroupName rg2 -PrimaryManagedInstanceName $managedInstance.Name -ResourceGroupName rg +``` + +## PARAMETERS + +### -AllowReadOnlyFailoverToPrimary +Whether an outage on the secondary server should trigger automatic failover of the read-only endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverPolicy +The failover policy of the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GracePeriodWithDataLossHours +Interval before automatic failover is initiated if an outage occurs on the primary server and failover cannot be completed without data loss. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The name of the Local Region from which to retrieve the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Azure SQL Database Failover Group to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerManagedInstanceName +The name of the Managed Instance in the partner region to be added to the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerRegion +The name of the partner region of the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerResourceGroupName +The name of the secondary resource group of the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerSubscriptionId +The subscription id of the secondary Managed Instance of the Instance Failover Group. This parameter is only needed for cross-subscription setup + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryManagedInstanceName +The name of the Managed Instance in the local region to be added to the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryType +Intended usage of the secondary instance. Standby indicates that the secondary instance will be used as a passive replica for disaster recovery only. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.InstanceFailoverGroup.Model.AzureSqlInstanceFailoverGroupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/New-AzSqlDatabaseRestorePoint.md b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseRestorePoint.md new file mode 100644 index 0000000000..c5028ef547 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseRestorePoint.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 67A9BB67-CF17-4CAA-99D9-002D0D23178B +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqldatabaserestorepoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseRestorePoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseRestorePoint.md +--- + +# New-AzSqlDatabaseRestorePoint + +## SYNOPSIS +Creates a new restore point from which a SQL Database can be restored. + +## SYNTAX + +``` +New-AzSqlDatabaseRestorePoint -RestorePointLabel <String> [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlDatabaseRestorePoint** cmdlet creates a new restore point that an Azure SQL Data Warehouse can be restored from. +This cmdlet is currently supported for Azure SQL Data Warehouse. + +## EXAMPLES + +### Example 1: Create a restore point +```powershell +New-AzSqlDatabaseRestorePoint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -RestorePointLabel "RestorePoint01" +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database01 +Location : Central US +RestorePointType : DISCRETE +RestorePointCreationDate : 8/12/2015 12:00:00 AM +EarliestRestoreDate : +RestorePointLabel : RestorePoint01 +``` + +This command creates a restore point for Azure SQL Data Warehouse and returns the details of the restore point. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the SQL Database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestorePointLabel +Specifies the label of the restore point for easy identification. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the AzureSQL Server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseRestorePointModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/New-AzSqlDatabaseSecondary.md b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseSecondary.md new file mode 100644 index 0000000000..126cc8990d --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlDatabaseSecondary.md @@ -0,0 +1,482 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: BEE99039-35F7-4E9D-9308-090EAE68292D +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqldatabasesecondary +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseSecondary.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlDatabaseSecondary.md +--- + +# New-AzSqlDatabaseSecondary + +## SYNOPSIS +Creates a secondary database for an existing database and starts data replication. + +## SYNTAX + +### DtuBasedDatabase (Default) +``` +New-AzSqlDatabaseSecondary [-DatabaseName] <String> [-SecondaryServiceObjectiveName <String>] + [-SecondaryElasticPoolName <String>] [-Tags <Hashtable>] -PartnerResourceGroupName <String> + -PartnerServerName <String> [-PartnerDatabaseName <String>] [-AllowConnections <AllowConnections>] [-AsJob] + [-LicenseType <String>] [-BackupStorageRedundancy <String>] [-SecondaryType <String>] + [-HighAvailabilityReplicaCount <Int32>] [-ZoneRedundant] [-AssignIdentity] [-EncryptionProtector <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### VcoreBasedDatabase +``` +New-AzSqlDatabaseSecondary [-DatabaseName] <String> [-Tags <Hashtable>] -PartnerResourceGroupName <String> + -PartnerServerName <String> [-PartnerDatabaseName <String>] [-AllowConnections <AllowConnections>] [-AsJob] + -SecondaryComputeGeneration <String> -SecondaryVCore <Int32> [-LicenseType <String>] + [-BackupStorageRedundancy <String>] [-SecondaryType <String>] [-HighAvailabilityReplicaCount <Int32>] + [-ZoneRedundant] [-AssignIdentity] [-EncryptionProtector <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlDatabaseSecondary** cmdlet replaces the Start-AzSqlDatabaseCopy cmdlet when +used for setting up geo-replication for a database. It returns the geo-replication link object from +the primary to the secondary database. + +## EXAMPLES + +### Example 1: Establish Active Geo-Replication +```powershell +$database = Get-AzSqlDatabase -DatabaseName $databasename -ResourceGroupName $primaryresourcegroupname -ServerName $primaryservername +$database | New-AzSqlDatabaseSecondary -PartnerResourceGroupName $secondaryresourcegroupname -PartnerServerName $secondaryservername -AllowConnections "All" +``` + +### Example 2: Establish Active Geo-Replication and specify the partner database name to be different than the source database name +```powershell +$database = Get-AzSqlDatabase -DatabaseName $databasename -ResourceGroupName $primaryresourcegroupname -ServerName $primaryservername +$database | New-AzSqlDatabaseSecondary -PartnerResourceGroupName $secondaryresourcegroupname -PartnerServerName $secondaryservername -PartnerDatabaseName $secondarydatabasename -AllowConnections "All" +``` + +## PARAMETERS + +### -AllowConnections +Specifies the read intent of the secondary Azure SQL Database. +The acceptable values for this parameter are: +- No +- All + +```yaml +Type: Microsoft.Azure.Commands.Sql.Replication.Model.AllowConnections +Parameter Sets: (All) +Aliases: +Accepted values: No, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign an Azure Active Directory Identity for this database for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupStorageRedundancy +The Backup storage redundancy used to store backups for the SQL Database. Options are: Local, Zone and Geo. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Local, Zone, Geo, GeoZone + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database to act as primary. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionProtector +The encryption protector key for SQL Database copy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedClientId +The federated client id for the SQL Database. It is used for cross tenant CMK scenario. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityReplicaCount +The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyList +The list of AKV keys for the SQL Database copy. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +The license type for the Azure Sql database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerDatabaseName +The name of the secondary database to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerResourceGroupName +Specifies the name of the Azure Resource Group to which this cmdlet assigns the secondary database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerServerName +Specifies the name of the Azure SQL database server to act as secondary. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the Azure Resource Group to which this cmdlet assigns the primary database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryComputeGeneration +The compute generation of the Azure Sql Database secondary. + +```yaml +Type: System.String +Parameter Sets: VcoreBasedDatabase +Aliases: Family + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryElasticPoolName +Specifies the name of the elastic pool in which to put the secondary database. + +```yaml +Type: System.String +Parameter Sets: DtuBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryServiceObjectiveName +Specifies the name of the service objective to assign to the secondary database. + +```yaml +Type: System.String +Parameter Sets: DtuBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryType +The secondary type of the database if it is a secondary. Valid values are Geo and Named. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Named, Geo, Standby + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryVCore +The Vcore numbers of the Azure Sql Database secondary. + +```yaml +Type: System.Int32 +Parameter Sets: VcoreBasedDatabase +Aliases: Capacity + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL Server of the primary SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tags +Specifies the Key-value pairs in the form of a hash table to associate with the SQL Database replication link. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +The list of user assigned identity for the SQL Database copy. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +The zone redundancy to associate with the Azure Sql Database. This property is only settable for Hyperscale edition databases. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Replication.Model.AzureReplicationLinkModel + +## NOTES + +## RELATED LINKS + +[Remove-AzSqlDatabaseSecondary](./Remove-AzSqlDatabaseSecondary.md) + +[Set-AzSqlDatabaseSecondary](./Set-AzSqlDatabaseSecondary.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/New-AzSqlElasticJob.md b/azps-10.1.0/Az.Sql/New-AzSqlElasticJob.md new file mode 100644 index 0000000000..7c66b710fc --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlElasticJob.md @@ -0,0 +1,363 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlelasticjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlElasticJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlElasticJob.md +--- + +# New-AzSqlElasticJob + +## SYNOPSIS +Creates a new job + +## SYNTAX + +### DefaultSet (Default) +``` +New-AzSqlElasticJob [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> [-Name] <String> + [-Description <String>] [-Enable] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RunOnce +``` +New-AzSqlElasticJob [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> [-Name] <String> + [-RunOnce] [-StartTime <DateTime>] [-Description <String>] [-Enable] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Recurring +``` +New-AzSqlElasticJob [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> [-Name] <String> + -IntervalType <String> -IntervalCount <UInt32> [-StartTime <DateTime>] [-EndTime <DateTime>] + [-Description <String>] [-Enable] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectSet +``` +New-AzSqlElasticJob [-ParentObject] <AzureSqlElasticJobAgentModel> [-Name] <String> [-Description <String>] + [-Enable] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RunOnceUsingParentObject +``` +New-AzSqlElasticJob [-ParentObject] <AzureSqlElasticJobAgentModel> [-Name] <String> [-RunOnce] + [-StartTime <DateTime>] [-Description <String>] [-Enable] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### RecurringUsingParentObject +``` +New-AzSqlElasticJob [-ParentObject] <AzureSqlElasticJobAgentModel> [-Name] <String> -IntervalType <String> + -IntervalCount <UInt32> [-StartTime <DateTime>] [-EndTime <DateTime>] [-Description <String>] [-Enable] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +New-AzSqlElasticJob [-ParentResourceId] <String> [-Name] <String> [-Description <String>] [-Enable] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RunOnceUsingParentResourceId +``` +New-AzSqlElasticJob [-ParentResourceId] <String> [-Name] <String> [-RunOnce] [-StartTime <DateTime>] + [-Description <String>] [-Enable] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RecurringUsingParentResourceId +``` +New-AzSqlElasticJob [-ParentResourceId] <String> [-Name] <String> -IntervalType <String> + -IntervalCount <UInt32> [-StartTime <DateTime>] [-EndTime <DateTime>] [-Description <String>] [-Enable] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzSqlElasticJob cmdlet creates a new job + +## EXAMPLES + +### Example 1: Creates a new job +```powershell +$agent = Get-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent +$agent | New-AzSqlElasticJob -Name job1 +``` + +```output +JobName Version Description StartTime EndTime ScheduleType Interval Enabled +------- ------- ----------- --------- ------- ------------ -------- ------- +job1 0 6/1/2018 9:46:29 PM 12/31/9999 11:59:59 AM Once False +``` + +Creates a new job + +### Example 2 + +Creates a new job. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +New-AzSqlElasticJob -Name job1 -RunOnce +``` + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, RunOnce, Recurring +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The job description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +The flag to indicate customer wants this job to be enabled. + +```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 +``` + +### -EndTime +The job schedule end time + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: Recurring, RecurringUsingParentObject, RecurringUsingParentResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntervalCount +The recurring schedule interval count + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: Recurring, RecurringUsingParentObject, RecurringUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntervalType +The recurring schedule interval type - Can be Minute, Hour, Day, Week, Month + +```yaml +Type: System.String +Parameter Sets: Recurring, RecurringUsingParentObject, RecurringUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The job name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: JobName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The agent input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel +Parameter Sets: ObjectSet, RunOnceUsingParentObject, RecurringUsingParentObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The agent resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet, RunOnceUsingParentResourceId, RecurringUsingParentResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, RunOnce, Recurring +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunOnce +The flag to indicate job will be run once + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RunOnce, RunOnceUsingParentObject, RunOnceUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, RunOnce, Recurring +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +The job schedule start time + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: RunOnce, Recurring, RunOnceUsingParentObject, RecurringUsingParentObject, RunOnceUsingParentResourceId, RecurringUsingParentResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/New-AzSqlElasticJobAgent.md b/azps-10.1.0/Az.Sql/New-AzSqlElasticJobAgent.md new file mode 100644 index 0000000000..b9b31f8ef5 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlElasticJobAgent.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/new-Azsqlelasticjobagent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlElasticJobAgent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlElasticJobAgent.md +--- + +# New-AzSqlElasticJobAgent + +## SYNOPSIS +Creates a new elastic job agent + +## SYNTAX + +### DefaultSet (Default) +``` +New-AzSqlElasticJobAgent [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> + [-Name] <String> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectSet +``` +New-AzSqlElasticJobAgent [-DatabaseObject] <AzureSqlDatabaseModel> [-Name] <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +New-AzSqlElasticJobAgent [-DatabaseResourceId] <String> [-Name] <String> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzSqlElasticJobAgent cmdlet creates a new Elastic Job agent + +## EXAMPLES + +### Example 1 +```powershell +New-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -DatabaseName jobdb -Name agent +``` + +```output +ResourceGroupName ServerName DatabaseName AgentName State Tags +----------------- ---------- ------------ --------- ----- ---- +rg elasticjobserver jobdb agent Ready +``` + +Creates a new Elastic Job agent + +## PARAMETERS + +### -DatabaseName +The database name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseObject +The Agent Control Database Object + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DatabaseResourceId +The Agent Control Database Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Agent Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AgentName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The Agent Tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/New-AzSqlElasticJobCredential.md b/azps-10.1.0/Az.Sql/New-AzSqlElasticJobCredential.md new file mode 100644 index 0000000000..3414dc3904 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlElasticJobCredential.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/new-Azsqlelasticjobcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlElasticJobCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlElasticJobCredential.md +--- + +# New-AzSqlElasticJobCredential + +## SYNOPSIS +Creates a new job credential + +## SYNTAX + +### DefaultSet (Default) +``` +New-AzSqlElasticJobCredential [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-Name] <String> -Credential <PSCredential> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectSet +``` +New-AzSqlElasticJobCredential [-ParentObject] <AzureSqlElasticJobAgentModel> [-Name] <String> + -Credential <PSCredential> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ResourceIdSet +``` +New-AzSqlElasticJobCredential [-ParentResourceId] <String> [-Name] <String> -Credential <PSCredential> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzSqlElasticJobCredential cmdlet creates a new job credential + +## EXAMPLES + +### Example 1 +```powershell +$agent = Get-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent +$agent | New-AzSqlElasticJobCredential -Name cred1 -Credential (Get-Credential) +``` + +```output +CredentialName UserName +-------------- -------- +cred1 user1 +``` + +Creates a new job credential + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The credential + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The job credential name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CredentialName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The agent object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The agent resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.Management.Automation.PSCredential +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobCredentialModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/New-AzSqlElasticJobTargetGroup.md b/azps-10.1.0/Az.Sql/New-AzSqlElasticJobTargetGroup.md new file mode 100644 index 0000000000..4bd56dac57 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlElasticJobTargetGroup.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/new-Azsqlelasticjobtargetgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlElasticJobTargetGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlElasticJobTargetGroup.md +--- + +# New-AzSqlElasticJobTargetGroup + +## SYNOPSIS +Creates a new target group + +## SYNTAX + +### DefaultSet (Default) +``` +New-AzSqlElasticJobTargetGroup [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectSet +``` +New-AzSqlElasticJobTargetGroup [-ParentObject] <AzureSqlElasticJobAgentModel> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +New-AzSqlElasticJobTargetGroup [-ParentResourceId] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzSqlElasticJobTargetGroup cmdlet creates a new target group + +## EXAMPLES + +### Example 1 +```powershell +$agent = Get-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent +$agent | New-AzSqlElasticJobTargetGroup -Name tg1 +``` + +```output +TargetGroupName Targets +--------------- ------- +tg1 +``` + +Creates an empty target group + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The target group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TargetGroupName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The agent input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The agent resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobTargetGroupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/New-AzSqlElasticPool.md b/azps-10.1.0/Az.Sql/New-AzSqlElasticPool.md new file mode 100644 index 0000000000..3e2ca80104 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlElasticPool.md @@ -0,0 +1,542 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 009899E5-83BF-4A3F-877E-70C16D5CD1AC +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlelasticpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlElasticPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlElasticPool.md +--- + +# New-AzSqlElasticPool + +## SYNOPSIS +Creates an elastic database pool for a SQL Database. + +## SYNTAX + +### DtuBasedPool (Default) +``` +New-AzSqlElasticPool [-ElasticPoolName] <String> [-Edition <String>] [-Dtu <Int32>] [-StorageMB <Int32>] + [-DatabaseDtuMin <Int32>] [-DatabaseDtuMax <Int32>] [-Tags <Hashtable>] [-ZoneRedundant] + [-LicenseType <String>] [-MaintenanceConfigurationId <String>] [-HighAvailabilityReplicaCount <Int32>] + [-PreferredEnclaveType <String>] [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### VcoreBasedPool +``` +New-AzSqlElasticPool [-ElasticPoolName] <String> -Edition <String> [-StorageMB <Int32>] -VCore <Int32> + -ComputeGeneration <String> [-DatabaseVCoreMin <Double>] [-DatabaseVCoreMax <Double>] [-Tags <Hashtable>] + [-ZoneRedundant] [-LicenseType <String>] [-MaintenanceConfigurationId <String>] + [-HighAvailabilityReplicaCount <Int32>] [-PreferredEnclaveType <String>] [-AsJob] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlElasticPool** cmdlet creates an elastic database pool for an Azure SQL Database. +Several parameters (*-Dtu, -DatabaseDtuMin, and -DatabaseDtuMax*) require the value being set is from the list of valid values for that parameter. For example, -DatabaseDtuMax for a Standard 100 eDTU pool can only be set to 10, 20, 50, or 100. For details about which values are valid, see the table for your specific size pool in [elastic pools](https://learn.microsoft.com/azure/sql-database/sql-database-elastic-pool). + +## EXAMPLES + +### Example 1: Create a DTU elastic pool + +```powershell +New-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -Edition "Standard" -Dtu 400 -DatabaseDtuMin 10 -DatabaseDtuMax 100 +``` + +```output +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 +ResourceGroupName : resourcegroup01 +ServerName : server01 +ElasticPoolName : elasticpool01 +Location : Central US +CreationDate : 8/26/2015 10:00:17 PM +State : Ready +Edition : Standard +Dtu : 400 +DatabaseDtuMax : 100 +DatabaseDtuMin : 10 +StorageMB : 409600 +Tags : +``` + +This command creates an elastic pool in the Standard service tier named ElasticPool01. The server +named server01, assigned to an Azure resource group named ResourceGroup01, hosts the elastic pool +in. The command specifies DTU property values for the pool and the databases in the pool. + +### Example 2: Create a vCore elastic pool + +```powershell +New-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -Edition "GeneralPurpose" -vCore 2 -ComputeGeneration Gen5 +``` + +```output +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/servers/server01/elasticPools/ElasticPool01 +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +ElasticPoolName : ElasticPool01 +Location : Central US +CreationDate : 8/29/2019 2:16:40 AM +State : Ready +Edition : GeneralPurpose +SkuName : GP_Gen5 +Dtu : 2 +DatabaseDtuMax : 2 +DatabaseDtuMin : 0 +Capacity : 2 +DatabaseCapacityMin : 0 +DatabaseCapacityMax : 2 +Family : Gen5 +MaxSizeBytes : 34359738368 +StorageMB : 32768 +Tags : +``` + +This command creates an elastic pool in the GengeralPurpose service tier named ElasticPool01. The server +named server01, assigned to an Azure resource group named ResourceGroup01, hosts the elastic pool +in. The command specifies the vCore property values for the pool and the databases in the pool. + +### Example 3 + +Creates an elastic database pool for a SQL Database. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzSqlElasticPool -ComputeGeneration Gen5 -Edition 'GeneralPurpose' -ElasticPoolName 'ElasticPool01' -ResourceGroupName 'ResourceGroup01' -ServerName 'Server01' -StorageMB 2097152 -VCore 2 +``` + +### Example 4: Creates an elastic pool with preferred enclave type as VBS + +```powershell +New-AzSqlElasticPool -ComputeGeneration Gen5 -Edition 'GeneralPurpose' -ElasticPoolName 'ElasticPool01' -ResourceGroupName 'ResourceGroup01' -ServerName 'Server01' -VCore 2 -PreferredEnclaveType 'VBS' +``` + +```output +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/servers/server01/elasticPools/ElasticPool01 +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +ElasticPoolName : ElasticPool01 +Location : Central US +CreationDate : 8/29/2019 2:16:40 AM +State : Ready +Edition : GeneralPurpose +SkuName : GP_Gen5 +Dtu : 2 +DatabaseDtuMax : 2 +DatabaseDtuMin : 0 +Capacity : 2 +DatabaseCapacityMin : 0 +DatabaseCapacityMax : 2 +Family : Gen5 +MaxSizeBytes : 34359738368 +StorageMB : 32768 +PreferredEnclaveType: VBS +Tags : +``` + +This command creates an elastic pool configured with VBS enclave + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeGeneration +The compute generation to assign. + +```yaml +Type: System.String +Parameter Sets: VcoreBasedPool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseDtuMax +Specifies the maximum number of Database Throughput Units (DTUs) that any single database in the pool can consume. +The default values for the different editions are as follows: +- Basic. 5 DTUs +- Standard. 100 DTUs +- Premium. 125 DTUs +For details about which values are valid, see the table for your specific size pool in [elastic pools](https://learn.microsoft.com/azure/sql-database/sql-database-elastic-pool) + +```yaml +Type: System.Int32 +Parameter Sets: DtuBasedPool +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseDtuMin +Specifies the minimum number of DTUs that the elastic pool guarantees to all the databases in the pool. +The default value is zero (0). +For details about which values are valid, see the table for your specific size pool in [elastic pools](https://learn.microsoft.com/azure/sql-database/sql-database-elastic-pool). + +```yaml +Type: System.Int32 +Parameter Sets: DtuBasedPool +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseVCoreMax +The maximum VCore number any SqlAzure Database can consume in the pool. + +```yaml +Type: System.Double +Parameter Sets: VcoreBasedPool +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseVCoreMin +The minimum VCore number any SqlAzure Database can consume in the pool. + +```yaml +Type: System.Double +Parameter Sets: VcoreBasedPool +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Dtu +Specifies the total number of shared DTUs for the elastic pool. +The default values for the different editions are as follows: +- Basic. +100 DTUs +- Standard. +100 DTUs +- Premium. +125 DTUs +For details about which values are valid, see the table for your specific size pool in [elastic pools](https://learn.microsoft.com/azure/sql-database/sql-database-elastic-pool). + +```yaml +Type: System.Int32 +Parameter Sets: DtuBasedPool +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Edition +Specifies the edition of the Azure SQL Database used for the elastic pool. +The acceptable values for this parameter are: +- None +- Basic +- Standard +- Premium +- DataWarehouse +- Free +- Stretch +- GeneralPurpose +- BusinessCritical + +```yaml +Type: System.String +Parameter Sets: DtuBasedPool +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: VcoreBasedPool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies the name of the elastic pool that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityReplicaCount +The total number of high availability replicas associated with the elastic pool. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +The license type for the Azure Sql database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceConfigurationId +The Maintenance configuration id for the SQL Elastic Pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredEnclaveType +The preferred enclave type for the Azure SQL Elastic Pool. Possible values are Default and VBS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which this cmdlet assigns the elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageMB +Specifies the storage limit, in megabytes, for the elastic pool. If you do not specify this +parameter, this cmdlet calculates a value that depends on the value of the *Dtu* parameter. +See [eDTU and storage limits](/azure/sql-database/sql-database-elastic-pool#edtu-and-storage-limits-for-elastic-pools) for possible values. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +Specifies a dictionary of Key-value pairs in the form of a hash table that this cmdlet associates +with the elastic pool. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VCore +The total shared number of Vcores for the Sql Azure Elastic Pool. + +```yaml +Type: System.Int32 +Parameter Sets: VcoreBasedPool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +The zone redundancy to associate with the Azure Sql Elastic Pool + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlElasticPool](./Get-AzSqlElasticPool.md) + +[Get-AzSqlElasticPoolActivity](./Get-AzSqlElasticPoolActivity.md) + +[Get-AzSqlElasticPoolDatabase](./Get-AzSqlElasticPoolDatabase.md) + +[Remove-AzSqlElasticPool](./Remove-AzSqlElasticPool.md) + +[Set-AzSqlElasticPool](./Set-AzSqlElasticPool.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/New-AzSqlInstance.md b/azps-10.1.0/Az.Sql/New-AzSqlInstance.md new file mode 100644 index 0000000000..d6c0a84b6b --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlInstance.md @@ -0,0 +1,945 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlInstance.md +--- + +# New-AzSqlInstance + +## SYNOPSIS +Creates an Azure SQL Managed Instance. + +## SYNTAX + +### NewByEditionAndComputeGenerationParameterSet (Default) +``` +New-AzSqlInstance [-Name] <String> [-ResourceGroupName] <String> [-AdministratorCredential <PSCredential>] + -Location <String> -SubnetId <String> [-LicenseType <String>] [-StorageSizeInGB <Int32>] -VCore <Int32> + -Edition <String> -ComputeGeneration <String> [-Collation <String>] [-PublicDataEndpointEnabled] + [-ProxyOverride <String>] [-TimezoneId <String>] [-Tag <Hashtable>] [-AssignIdentity] + [-DnsZonePartner <String>] [-InstancePoolName <String>] [-MinimalTlsVersion <String>] + [-BackupStorageRedundancy <String>] [-MaintenanceConfigurationId <String>] + [-PrimaryUserAssignedIdentityId <String>] [-KeyId <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] [-IdentityType <String>] [-AsJob] + [-Force] [-EnableActiveDirectoryOnlyAuthentication] [-ExternalAdminName <String>] [-ExternalAdminSID <Guid>] + [-ZoneRedundant] [-ServicePrincipalType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### NewByInstancePoolParentObjectParameterSet +``` +New-AzSqlInstance [-InstancePool] <AzureSqlInstancePoolModel> [-Name] <String> + [-AdministratorCredential <PSCredential>] [-StorageSizeInGB <Int32>] -VCore <Int32> [-Collation <String>] + [-PublicDataEndpointEnabled] [-ProxyOverride <String>] [-TimezoneId <String>] [-Tag <Hashtable>] + [-AssignIdentity] [-DnsZonePartner <String>] [-MinimalTlsVersion <String>] [-BackupStorageRedundancy <String>] + [-MaintenanceConfigurationId <String>] [-PrimaryUserAssignedIdentityId <String>] [-KeyId <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] [-IdentityType <String>] [-AsJob] + [-Force] [-EnableActiveDirectoryOnlyAuthentication] [-ExternalAdminName <String>] [-ExternalAdminSID <Guid>] + [-ZoneRedundant] [-ServicePrincipalType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### NewByInstancePoolResourceIdParameterSet +``` +New-AzSqlInstance [-InstancePoolResourceId] <String> [-Name] <String> [-AdministratorCredential <PSCredential>] + [-StorageSizeInGB <Int32>] -VCore <Int32> [-Collation <String>] [-PublicDataEndpointEnabled] + [-ProxyOverride <String>] [-TimezoneId <String>] [-Tag <Hashtable>] [-AssignIdentity] + [-DnsZonePartner <String>] [-MinimalTlsVersion <String>] [-BackupStorageRedundancy <String>] + [-MaintenanceConfigurationId <String>] [-PrimaryUserAssignedIdentityId <String>] [-KeyId <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] [-IdentityType <String>] [-AsJob] + [-Force] [-EnableActiveDirectoryOnlyAuthentication] [-ExternalAdminName <String>] [-ExternalAdminSID <Guid>] + [-ZoneRedundant] [-ServicePrincipalType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### NewBySkuNameParameterSetParameter +``` +New-AzSqlInstance [-Name] <String> [-ResourceGroupName] <String> [-AdministratorCredential <PSCredential>] + -Location <String> -SubnetId <String> [-LicenseType <String>] [-StorageSizeInGB <Int32>] -VCore <Int32> + -SkuName <String> [-Collation <String>] [-PublicDataEndpointEnabled] [-ProxyOverride <String>] + [-TimezoneId <String>] [-Tag <Hashtable>] [-AssignIdentity] [-DnsZonePartner <String>] + [-InstancePoolName <String>] [-MinimalTlsVersion <String>] [-BackupStorageRedundancy <String>] + [-MaintenanceConfigurationId <String>] [-PrimaryUserAssignedIdentityId <String>] [-KeyId <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] [-IdentityType <String>] [-AsJob] + [-Force] [-EnableActiveDirectoryOnlyAuthentication] [-ExternalAdminName <String>] [-ExternalAdminSID <Guid>] + [-ZoneRedundant] [-ServicePrincipalType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlInstance** cmdlet creates an Azure SQL Managed instance. + +## EXAMPLES + +### Example 1: Create a new instance +```powershell +New-AzSqlInstance -Name managedInstance1 -ResourceGroupName ResourceGroup01 -Location westcentralus -AdministratorCredential (Get-Credential) -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 16 -SkuName GP_Gen4 -DnsZonePartner "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/partnerServerForDnsZone" +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 16 +StorageSizeInGB : 1024 +DnsZone : ad35cna0mw +InstancePoolName : +``` + +This command creates a new instance by using the SkuName parameter. + +### Example 2: Create a new instance +```powershell +New-AzSqlInstance -Name managedInstance2 -ResourceGroupName ResourceGroup01 -Location westcentralus -AdministratorCredential (Get-Credential) -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 16 -Edition "GeneralPurpose" -ComputeGeneration Gen4 +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance2 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 16 +StorageSizeInGB : 1024 +DnsZone : ad35cna0mw +InstancePoolName : +``` + +This command creates a new instance by using by using Edition and ComputeGeneration parameters. + +### Example 3: Create a new instance in an instance pool using an instance pool object +```powershell +$instancePool = Get-AzSqlInstancePool -ResourceGroupName resourcegroup01 -Name instancepool0 +$instancePool | New-AzSqlInstance -Name managedInstance2 -AdministratorCredential (Get-Credential) -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 2 +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance2 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 2 +StorageSizeInGB : 1024 +DnsZone : ad35cna0mw +InstancePoolName : instancepool0 +``` + +This command creates a new instance in an instance pool using an instance pool object. + +### Example 4: Create a new instance in an instance pool using an instance pool resource identifier +```powershell +New-AzSqlInstance -Name managedInstance2 -AdministratorCredential (Get-Credential) -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 2 -InstancePoolResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0" +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance2 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 2 +StorageSizeInGB : 1024 +DnsZone : ad35cna0mw +InstancePoolName : instancepool0 +``` + +This command creates a new instance in an instance pool using the instance pool's resource identifier. + +### Example 5: Create a new instance in an instance pool +```powershell +New-AzSqlInstance -Name managedInstance1 -ResourceGroupName resourceGroup01 -Location westcentralus -AdministratorCredential (Get-Credential) -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" -LicenseType LicenseIncluded -StorageSizeInGB 32 -VCore 2 -ComputeGeneration Gen5 -Edition GeneralPurpose -InstancePoolName instancePool0 +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 2 +StorageSizeInGB : 32 +DnsZone : ad35cna0mw +InstancePoolName : instancePool0 +``` + +This command creates a new instance in an instance pool with name instancePool0 + +### Example 6: Create a new instance with maintenance configuration +```powershell +New-AzSqlInstance -Name managedInstance1 -ResourceGroupName resourcegroup01 -Location "westus" -AdministratorCredential (Get-Credential) -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" -VCore 8 -ComputeGeneration Gen5 -Edition GeneralPurpose -MaintenanceConfigurationId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestUS_MI_2" +``` + +```output +Location : westus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 8 +StorageSizeInGB : 256 +Collation : SQL_Latin1_General_CP1_CI_AS +PublicDataEndpointEnabled : False +ProxyOverride : +TimezoneId : UTC +DnsZonePartner : +DnsZone : ad35cna0mw +InstancePoolName : +MinimalTlsVersion : +CurrentBackupStorageRedundancy : Geo +RequestedBackupStorageRedundancy : Geo +MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestUS_MI_2 +``` + +This command creates a new instance with maintenance configuration MI_2 + +### Example 7: Create a new instance with External(Azure Active Directory) Administrator, Azure Active Directory Only Authentication and no SqlAdministratorCredentials +<!-- Skip: Output cannot be splitted from code --> +```powershell +New-AzSqlInstance -Name managedInstance2 -ResourceGroupName ResourceGroup01 -ExternalAdminName DummyLogin -EnableActiveDirectoryOnlyAuthentication -Location westcentralus -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 16 -Edition "GeneralPurpose" -ComputeGeneration Gen4 + +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance2 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 16 +StorageSizeInGB : 1024 +DnsZone : ad35cna0mw +InstancePoolName : +Administrators : + +$val = Get-AzSqlInstance -Name managedInstance2 -ResourceGroupName ResourceGroup01 -ExpandActiveDirectoryAdministrator +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance2 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 16 +StorageSizeInGB : 1024 +DnsZone : ad35cna0mw +InstancePoolName : +Administrators : Microsoft.Azure.Management.Sql.Models.ManagedInstanceExternalAdministrator + +$val.Administrators +AdministratorType : ActiveDirectory +PrincipalType : Group +Login : DummyLogin +Sid : df7667b8-f9fd-4029-a0e3-b43c75ce9538 +TenantId : f553829b-6d84-481b-86a9-42db57c1dc73 +AzureADOnlyAuthentication : True +``` + +This command creates a new zone - redundant instance + +### Example 8: Create a new zone - redundant instance +```powershell +New-AzSqlInstance -Name managedInstance1 -ResourceGroupName ResourceGroup01 -Location westcentralus -AdministratorCredential (Get-Credential) -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 16 -SkuName GP_Gen4 -DnsZonePartner "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/partnerServerForDnsZone" -ZoneRedundant +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 16 +StorageSizeInGB : 1024 +DnsZone : ad35cna0mw +InstancePoolName : +ZoneRedundant : true +``` + +This command creates a new instance with external administrator properties and azure active directory only authentication enabled. + +### Example 9: Create a new instance with TDE CMK +```powershell +New-AzSqlInstance -Name managedInstance1 -ResourceGroupName ResourceGroup01 -Location westcentralus -AdministratorCredential (Get-Credential) -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 16 -SkuName GP_Gen4 -DnsZonePartner "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/partnerServerForDnsZone" -AssignIdentity -IdentityType "UserAssigned" -PrimaryUserAssignedIdentityId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity01" -UserAssignedIdentityId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity01" -KeyId "https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901" +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 16 +StorageSizeInGB : 1024 +DnsZone : ad35cna0mw +InstancePoolName : +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +PrimaryUserAssignedIdentityId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity01 +``` + +This command creates a new managed instance with TDE CMK enabled. + +## PARAMETERS + +### -AdministratorCredential +The SQL authentication credential of the instance. + +```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 +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign an Azure Active Directory Identity for this Managed instance for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupStorageRedundancy +The Backup storage redundancy used to store backups for the Sql Azure Managed Instance. Options are: Local, Zone and Geo + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Local, Zone, Geo, GeoZone + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Collation +The collation of the Azure SQL Managed Instance to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeGeneration +The compute generation for the instance. + +```yaml +Type: System.String +Parameter Sets: NewByEditionAndComputeGenerationParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsZonePartner +The resource id of the partner Managed Server to inherit DnsZone property from for Managed instance creation + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Edition +The edition for the instance. + +```yaml +Type: System.String +Parameter Sets: NewByEditionAndComputeGenerationParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableActiveDirectoryOnlyAuthentication +Enable Active Directory Only Authentication on the server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalAdminName +Specifies the display name of the user, group or application which is the Azure Active Directory administrator for the server. This display name must exist in the active directory associated with the current subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalAdminSID +Specifies the object ID of the user, group or application which is the Azure Active Directory administrator. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of identity to be assigned to the server. Possible values are SystemAsssigned, UserAssigned, 'SystemAssigned,UserAssigned' and None. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstancePool +The instance pool parent object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Instance_Pools.Model.AzureSqlInstancePoolModel +Parameter Sets: NewByInstancePoolParentObjectParameterSet +Aliases: ParentObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstancePoolName +The instance pool to place this instance in. + +```yaml +Type: System.String +Parameter Sets: NewByEditionAndComputeGenerationParameterSet, NewBySkuNameParameterSetParameter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstancePoolResourceId +The instance pool resource id. + +```yaml +Type: System.String +Parameter Sets: NewByInstancePoolResourceIdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyId +The Azure Key Vault URI that is used for encryption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +Determines which License Type to use. Possible values are: +- BasePrice - Azure Hybrid Benefit (AHB) discounted pricing for existing SQL Server license owners is applied. Managed Instance service price will be discounted for existing SQL Server license owners. +- LicenseIncluded - Azure Hybrid Benefit (AHB) discount pricing for existing SQL Server license owners is not applied. Managed Instance service price will include a new SQL Server license costs. + +```yaml +Type: System.String +Parameter Sets: NewByEditionAndComputeGenerationParameterSet, NewBySkuNameParameterSetParameter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location in which to create the instance + +```yaml +Type: System.String +Parameter Sets: NewByEditionAndComputeGenerationParameterSet, NewBySkuNameParameterSetParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceConfigurationId +The Maintenance configuration id for the Sql Azure Managed Instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimalTlsVersion +The minimal TLS version to enforce for Managed instance + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, 1.0, 1.1, 1.2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Instance name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: InstanceName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryUserAssignedIdentityId +The primary User Managed Identity(UMI) id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyOverride +The connection type used for connecting to the instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicDataEndpointEnabled +Whether or not the public data endpoint is enabled for the instance. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: NewByEditionAndComputeGenerationParameterSet, NewBySkuNameParameterSetParameter +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalType +Type of Service Principal to be used. Possible values are SystemAssigned and None. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, SystemAssigned + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The SKU name for the instance e.g. +'GP_Gen4', 'BC_Gen4'. + +```yaml +Type: System.String +Parameter Sets: NewBySkuNameParameterSetParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSizeInGB +Determines how much Storage size to associate with instance + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The Subnet Id to use for instance creation + +```yaml +Type: System.String +Parameter Sets: NewByEditionAndComputeGenerationParameterSet, NewBySkuNameParameterSetParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to associate with the instance + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimezoneId +The time zone id for the instance to set. A list of time zone ids is exposed through the sys.time_zone_info (Transact-SQL) view. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +The list of user assigned identities. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VCore +Determines how much VCore to associate with instance + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +Use zone redundant storage + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +## NOTES + +## RELATED LINKS + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/New-AzSqlInstanceDatabase.md b/azps-10.1.0/Az.Sql/New-AzSqlInstanceDatabase.md new file mode 100644 index 0000000000..227e41d951 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlInstanceDatabase.md @@ -0,0 +1,270 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlinstancedatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlInstanceDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlInstanceDatabase.md +--- + +# New-AzSqlInstanceDatabase + +## SYNOPSIS +Creates an Azure SQL Managed Instance database. + +## SYNTAX + +### CreateNewInstanceDatabaseFromInputParameters (Default) +``` +New-AzSqlInstanceDatabase [-Name] <String> [-InstanceName] <String> [-ResourceGroupName] <String> + [-Collation <String>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-EnableLedger] + [-Confirm] [<CommonParameters>] +``` + +### CreateNewInstanceDatabaseFromAzureSqlManagedInstanceModelInstanceDefinition +``` +New-AzSqlInstanceDatabase [-Name] <String> [-Collation <String>] [-Tag <Hashtable>] + [-InstanceObject] <AzureSqlManagedInstanceModel> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### CreateNewInstanceDatabaseFromAzureSqlInstanceResourceId +``` +New-AzSqlInstanceDatabase [-Name] <String> [-Collation <String>] [-Tag <Hashtable>] + [-InstanceResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlInstanceDatabase** cmdlet creates an Azure SQL Managed instance database. + +## EXAMPLES + +### Example 1: Create a database on a specified instance +```powershell +New-AzSqlInstanceDatabase -Name "Database01" -InstanceName "managedInstance1" -ResourceGroupName "ResourceGroup01" +``` + +```output +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/databases/Database01 +Name : Database01 +Tags : +Collation : SQL_Latin1_General_CP1_CI_AS +Status : Online +CreationDate : 4/27/2018 2:30:07 PM +EarliestRestorePoint : 4/27/2018 2:40:47 PM +RestorePointInTime : +DefaultSecondaryLocation : West US 2 +CatalogCollation : +CreateMode : +EnableLedger : False +StorageContainerUri : +StorageContainerSasToken : +SourceDatabaseId : +FailoverGroupId : +``` + +This command creates a instance database named Database01 on instance managedInstance1. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Collation +The collation of the Azure SQL Instance Database collation to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +The instance name. + +```yaml +Type: System.String +Parameter Sets: CreateNewInstanceDatabaseFromInputParameters +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +The instance object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: CreateNewInstanceDatabaseFromAzureSqlManagedInstanceModelInstanceDefinition +Aliases: ParentObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceResourceId +The instance resource id + +```yaml +Type: System.String +Parameter Sets: CreateNewInstanceDatabaseFromAzureSqlInstanceResourceId +Aliases: ParentResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the Azure SQL Instance Database to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: InstanceDatabaseName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: CreateNewInstanceDatabaseFromInputParameters +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to associate with the Azure Sql Instance Database + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLedger +Creates a ledger database, in which the integrity of all data is protected by the ledger feature. All tables in the ledger database must be ledger tables. Note: the value of this property cannot be changed after the database has been created. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/New-AzSqlInstanceLink.md b/azps-10.1.0/Az.Sql/New-AzSqlInstanceLink.md new file mode 100644 index 0000000000..3af4717864 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlInstanceLink.md @@ -0,0 +1,317 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlinstancelink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlInstanceLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlInstanceLink.md +--- + +# New-AzSqlInstanceLink + +## SYNOPSIS +Creates a new instance link. + +## SYNTAX + +### CreateByNameParameterSet (Default) +``` +New-AzSqlInstanceLink [-ResourceGroupName] <String> [-InstanceName] <String> [-Name] <String> + -PrimaryAvailabilityGroupName <String> -SecondaryAvailabilityGroupName <String> -TargetDatabase <String> + -SourceEndpoint <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CreateByParentObjectParameterSet +``` +New-AzSqlInstanceLink [-Name] <String> -PrimaryAvailabilityGroupName <String> + -SecondaryAvailabilityGroupName <String> -TargetDatabase <String> -SourceEndpoint <String> + [-InstanceObject] <AzureSqlManagedInstanceModel> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlInstanceLink** cmdlet creates an Azure SQL Managed Instance link by joining distributed availability group on SQL Server based on the parameters passed. + +## EXAMPLES + +### Example 1: Create a new instance link +```powershell +New-AzSqlInstanceLink -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "Link01" -PrimaryAvailabilityGroupName "Link01PrimaryAG" -SecondaryAvailabilityGroupName "Link01SecondaryAG" -TargetDatabase "Database01" -SourceEndpoint "TCP://SERVER01:5022" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : Link01PrimaryAG +SecondaryAvailabilityGroupName : Link01SecondaryAG +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command creates a new instance link with name "Link01". + +### Example 2: Create a new instance link using an instance object +```powershell +$instance = Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -Name "ManagedInstance01" +New-AzSqlInstanceLink -InstanceObject $instance -Name "Link01" -PrimaryAvailabilityGroupName "Link01PrimaryAG" -SecondaryAvailabilityGroupName "Link01SecondaryAG" -TargetDatabase "Database01" -SourceEndpoint "TCP://SERVER01:5022" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : Link01PrimaryAG +SecondaryAvailabilityGroupName : Link01SecondaryAG +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command creates a new instance link using a managed instance object as a parameter. + +### Example 3: Create a new instance link by piping an instance object +```powershell +$instance = Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -Name "ManagedInstance01" +$instance | New-AzSqlInstanceLink -Name "Link01" -PrimaryAvailabilityGroupName "Link01PrimaryAG" -SecondaryAvailabilityGroupName "Link01SecondaryAG" -TargetDatabase "Database01" -SourceEndpoint "TCP://SERVER01:5022" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : Link01PrimaryAG +SecondaryAvailabilityGroupName : Link01SecondaryAG +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command creates a new instance link by piping an instance object. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +Instance input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: CreateByParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the instance link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LinkName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryAvailabilityGroupName +Name of the primary availability group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecondaryAvailabilityGroupName +Name of the secondary availability group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceEndpoint +IP adress of the source endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDatabase +Name of the target database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstanceHybridLink.Model.AzureSqlManagedInstanceLinkModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlInstanceLink](./Get-AzSqlInstanceLink.md) + +[Update-AzSqlInstanceLink](./Update-AzSqlInstanceLink.md) + +[Remove-AzSqlInstanceLink](./Remove-AzSqlInstanceLink.md) diff --git a/azps-10.1.0/Az.Sql/New-AzSqlInstancePool.md b/azps-10.1.0/Az.Sql/New-AzSqlInstancePool.md new file mode 100644 index 0000000000..1c3f4b2dcf --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlInstancePool.md @@ -0,0 +1,261 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlinstancepool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlInstancePool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlInstancePool.md +--- + +# New-AzSqlInstancePool + +## SYNOPSIS +Creates an Azure SQL Instance pool. + +## SYNTAX + +``` +New-AzSqlInstancePool [-ResourceGroupName] <String> [-Name] <String> -Location <String> -SubnetId <String> + -VCore <Int32> -Edition <String> -ComputeGeneration <String> -LicenseType <String> [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlInstancePool** cmdlet creates an Azure SQL Instance pool. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSqlInstancePool -ResourceGroupName resourcegroup01 -Name instancepool0 -Location canadacentral -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" -VCore 8 -Edition GeneralPurpose -ComputeGeneration Gen5 -LicenseType LicenseIncluded +``` + +```output +ResourceGroupName : resourcegroup01 +Type : Microsoft.Sql/instancePools +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0 +InstancePoolName : instancePool0 +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +VCores : 8 +ComputeGeneration : Gen5 +Edition : GeneralPurpose +Tags : +Sku : Microsoft.Azure.Management.Sql.Models.Sku +Location : canadacentral +LicenseType : LicenseIncluded +``` + +This command creates a new Azure SQL Instance pool. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeGeneration +The compute generation for the instance pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Edition +The edition for the instance pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +Determines which License Type to use. +Possible values are BasePrice (with AHB discount) and LicenseIncluded (without AHB discount). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location to create the instance pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the instance pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: InstancePoolName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The subnet id to use for instance pool creation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to associate with the instance + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VCore +Determines how much VCore to associate with instance. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: VCores + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/New-AzSqlInstanceServerTrustCertificate.md b/azps-10.1.0/Az.Sql/New-AzSqlInstanceServerTrustCertificate.md new file mode 100644 index 0000000000..be4e460b99 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlInstanceServerTrustCertificate.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlinstanceservertrustcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlInstanceServerTrustCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlInstanceServerTrustCertificate.md +--- + +# New-AzSqlInstanceServerTrustCertificate + +## SYNOPSIS +Creates a new server trust certificate. + +## SYNTAX + +### CreateByNameParameterSet (Default) +``` +New-AzSqlInstanceServerTrustCertificate [-ResourceGroupName] <String> [-InstanceName] <String> [-Name] <String> + [-PublicKey] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByParentObjectParameterSet +``` +New-AzSqlInstanceServerTrustCertificate [-Name] <String> [-PublicKey] <String> + [-InstanceObject] <AzureSqlManagedInstanceModel> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +**New-AzSqlInstanceServerTrustCertificate** cmdlet creates a server trust certificate on an Azure SQL Managed Instance. + +## EXAMPLES + +### Example 1: Create a new server trust certificate +```powershell +$publicKey = "0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91" +New-AzSqlInstanceServerTrustCertificate -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "Certificate01" -PublicKey $publicKey +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate01 +Thumbprint : 0x7D989DF34BD0FD0D2F9F6B3B6A7096856F5AB004 +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 +``` + +This command creates a server trust certificate with given name and public key. + +### Example 2: Create a new server trust certificate on a managed instance using an instance object +```powershell +$publicKey = "0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91" +$instance = Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -Name "ManagedInstance01" +New-AzSqlInstanceServerTrustCertificate -InstanceObject $instance -Name "Certificate01" -PublicKey $publicKey +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate01 +Thumbprint : 0x7D989DF34BD0FD0D2F9F6B3B6A7096856F5AB004 +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 +``` + +This command creates a server trust certificate using a parent instance object. + +### Example 3: Create a new server trust certificate by piping an instance object +```powershell +$instance = Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -Name "ManagedInstance01" +$publicKey = "0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91" +$instance | New-AzSqlInstanceServerTrustCertificate -Name "Certificate01" -PublicKey $publicKey +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate01 +Thumbprint : 0x7D989DF34BD0FD0D2F9F6B3B6A7096856F5AB004 +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 +``` + +This command creates a server trust certificate by piping a parent instance object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +Instance input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: CreateByParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CertificateName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicKey +Value of certificate encoded public key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerTrustCertificate.Model.AzureSqlInstanceServerTrustCertificateModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlInstanceServerTrustCertificate](./Get-AzSqlInstanceServerTrustCertificate.md) + +[Remove-AzSqlInstanceServerTrustCertificate](./Remove-AzSqlInstanceServerTrustCertificate.md) diff --git a/azps-10.1.0/Az.Sql/New-AzSqlServer.md b/azps-10.1.0/Az.Sql/New-AzSqlServer.md new file mode 100644 index 0000000000..c3cfd3699c --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlServer.md @@ -0,0 +1,467 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 7039528F-42AE-45DB-BF81-FE5003F8AEE2 +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServer.md +--- + +# New-AzSqlServer + +## SYNOPSIS +Creates a SQL Database server. + +## SYNTAX + +``` +New-AzSqlServer -ServerName <String> [-SqlAdministratorCredentials <PSCredential>] -Location <String> + [-Tags <Hashtable>] [-ServerVersion <String>] [-AssignIdentity] [-PublicNetworkAccess <String>] + [-RestrictOutboundNetworkAccess <String>] [-MinimalTlsVersion <String>] + [-PrimaryUserAssignedIdentityId <String>] [-KeyId <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] [-IdentityType <String>] [-AsJob] + [-EnableActiveDirectoryOnlyAuthentication] [-ExternalAdminName <String>] [-ExternalAdminSID <Guid>] + [-FederatedClientId <Guid>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlServer** cmdlet creates an Azure SQL Database server. + +## EXAMPLES + +### Example 1: Create a new Azure SQL Database server +```powershell +New-AzSqlServer -ResourceGroupName "ResourceGroup01" -Location "Central US" -ServerName "server01" -ServerVersion "12.0" -SqlAdministratorCredentials (Get-Credential) +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +Location : Central US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +``` + +This command creates a version 12 Azure SQL Database server. + +### Example 2: Create a new Azure SQL Database server with External(Azure Active Directory) Administrator, Azure Active Directory Only Authentication and no SqlAdministratorCredentials +<!-- Skip: Output cannot be splitted from code --> +```powershell +New-AzSqlServer -ResourceGroupName "ResourceGroup01" -Location "Central US" -ServerName "server01" -ServerVersion "12.0" -ExternalAdminName DummyLogin -EnableActiveDirectoryOnlyAuthentication +ResourceGroupName : resourcegroup01 +ServerName : server01 +Location : Central US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Administrators : + +$val = Get-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "server01" -ExpandActiveDirectoryAdministrator +ResourceGroupName : resourcegroup01 +ServerName : server01 +Location : Central US +SqlAdministratorLogin : randomLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Administrators : Microsoft.Azure.Management.Sql.Models.ServerExternalAdministrator + +$val.Administrators +AdministratorType : ActiveDirectory +PrincipalType : Group +Login : DummyLogin +Sid : df7667b8-f9fd-4029-a0e3-b43c75ce9538 +TenantId : f553829b-6d84-481b-86a9-42db57c1dc73 +AzureADOnlyAuthentication : True +``` + +This command creates a version 12 Azure SQL Database server with external administrator properties and azure active directory only authentication enabled. + +### Example 3: Create a new Azure SQL Database server with TDE CMK +```powershell +New-AzSqlServer -ResourceGroupName "ResourceGroup01" -Location "East US" -ServerName "server01" -ServerVersion "12.0" -SqlAdministratorCredentials (Get-Credential) -AssignIdentity -IdentityType "UserAssigned" -PrimaryUserAssignedIdentityId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity01" -UserAssignedIdentityId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity01" -KeyId "https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901" +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +Location : East US +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +PrimaryUserAssignedIdentityId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity01 +``` + +This command creates a version 12 Azure SQL Database server with TDE CMK enabled. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign an Azure Active Directory Identity for this server for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableActiveDirectoryOnlyAuthentication +Enable Active Directory Only Authentication on the server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalAdminName +Specifies the display name of the user, group or application which is the Azure Active Directory administrator for the server. This display name must exist in the active directory associated with the current subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalAdminSID +Specifies the object ID of the user, group or application which is the Azure Active Directory administrator. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedClientId +Specifies the Federated client ID of the server when using Cross-Tenant CMK, Do not set this value if you do not intent to use Cross-Tenant CMK + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of identity to be assigned to the server. Possible values are SystemAsssigned, UserAssigned, 'SystemAssigned,UserAssigned' and None. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyId +The Azure Key Vault URI that is used for encryption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the data center where this cmdlet creates the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimalTlsVersion +The minimal TLS version to enforce for Sql Server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, 1.0, 1.1, 1.2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryUserAssignedIdentityId +The primary User Managed Identity(UMI) id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Takes a flag, enabled/disabled, to specify whether public network access to server is allowed or not. +When disabled, only connections made through Private Links can reach this server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which this cmdlet assigns the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestrictOutboundNetworkAccess +When enabled, only outbound connections allowed by the outbound firewall rules will succeed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the new server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerVersion +Specifies the version of the new server. The acceptable values for this parameter are: 2.0 and 12.0. +Specify 2.0 to create a version 11 server, or 12.0 to create a version 12 server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlAdministratorCredentials +Specifies the SQL Database server administrator credentials for the new server. To obtain a +**PSCredential** object, use the Get-Credential cmdlet. For more information, type `Get-Help +Get-Credential`. + +```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 +``` + +### -Tags +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +The list of user assigned identities. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServer](./Get-AzSqlServer.md) + +[Remove-AzSqlServer](./Remove-AzSqlServer.md) + +[Set-AzSqlServer](./Set-AzSqlServer.md) + +[New-AzSqlServerFirewallRule](./New-AzSqlServerFirewallRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/New-AzSqlServerCommunicationLink.md b/azps-10.1.0/Az.Sql/New-AzSqlServerCommunicationLink.md new file mode 100644 index 0000000000..328e9f47a7 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlServerCommunicationLink.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 52664E45-7EAB-41C9-BF78-304F10BFC51A +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlservercommunicationlink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerCommunicationLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerCommunicationLink.md +--- + +# New-AzSqlServerCommunicationLink + +## SYNOPSIS +Creates a communication link for elastic database transactions between two SQL Database servers. + +## SYNTAX + +``` +New-AzSqlServerCommunicationLink -LinkName <String> -PartnerServer <String> [-AsJob] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlServerCommunicationLink** cmdlet creates a communication link for elastic database transactions between two logical servers in Azure SQL Database. +Elastic database transactions can span databases in either of the paired servers. +You can create more than one link on a server. +Therefore, elastic database transactions can span across a larger number of servers. + +## EXAMPLES + +### Example 1: Create a communication link +```powershell +New-AzSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17" -LinkName "Link01" -PartnerServer "ContosoServer02" +``` + +This command creates a link named Link01 between ContosoServer17 and ContosoServer02. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkName +Specifies the name of the server communication link that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerServer +Specifies the name of the other server that takes part in this communication link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server specified by the *ServerName* parameter belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server on which this cmdlet sets up the communication link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerCommunicationLink.Model.AzureSqlServerCommunicationLinkModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + +## RELATED LINKS + +[Get-AzSqlServerCommunicationLink](./Get-AzSqlServerCommunicationLink.md) + +[Remove-AzSqlServerCommunicationLink](./Remove-AzSqlServerCommunicationLink.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/New-AzSqlServerDisasterRecoveryConfiguration.md b/azps-10.1.0/Az.Sql/New-AzSqlServerDisasterRecoveryConfiguration.md new file mode 100644 index 0000000000..64fa361619 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlServerDisasterRecoveryConfiguration.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 1D8E8599-113C-4852-8416-1F3359071047 +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlserverdisasterrecoveryconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerDisasterRecoveryConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerDisasterRecoveryConfiguration.md +--- + +# New-AzSqlServerDisasterRecoveryConfiguration + +## SYNOPSIS +Creates a database server system recovery configuration. + +## SYNTAX + +``` +New-AzSqlServerDisasterRecoveryConfiguration -VirtualEndpointName <String> -PartnerResourceGroupName <String> + -PartnerServerName <String> [-FailoverPolicy <String>] [-AsJob] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlServerDisasterRecoveryConfiguration** cmdlet creates a SQL database server system recovery configuration. + +## EXAMPLES + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverPolicy +Specifies the failover policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerResourceGroupName +Specifies the name of the partner resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerServerName +Specifies the name of the partner server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualEndpointName +Specifies the name of the virtual end point. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerDisasterRecoveryConfiguration.Model.AzureSqlServerDisasterRecoveryConfigurationModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServerDisasterRecoveryConfiguration](./Get-AzSqlServerDisasterRecoveryConfiguration.md) + +[Remove-AzSqlServerDisasterRecoveryConfiguration](./Remove-AzSqlServerDisasterRecoveryConfiguration.md) + +[Set-AzSqlServerDisasterRecoveryConfiguration](./Set-AzSqlServerDisasterRecoveryConfiguration.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/New-AzSqlServerDnsAlias.md b/azps-10.1.0/Az.Sql/New-AzSqlServerDnsAlias.md new file mode 100644 index 0000000000..8d6417cf90 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlServerDnsAlias.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlserverdnsalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerDnsAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerDnsAlias.md +--- + +# New-AzSqlServerDnsAlias + +## SYNOPSIS +This command creates a new Azure SQL Server DNS Alias. + +## SYNTAX + +``` +New-AzSqlServerDnsAlias -Name <String> [-AsJob] -ServerName <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates new Azure SQL Server DNS Alias that is pointing to specified server. + +## EXAMPLES + +### Example 1 +```powershell +$serverDNSAlias = New-AzSqlServerDnsAlias -ResourceGroupName rg -ServerName serverName -DnsAliasName aliasName +``` + +```output +ResourceGroupName ServerName DnsAliasName +----------------- ---------- ------------------ +rgname servername dnsaliasname +``` + +This command creates Azure SQL Server DNS Alias with the name aliasName that is pointing to server serverName + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Azure Sql Server Dns Alias name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DnsAliasName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerDnsAlias.Model.AzureSqlServerDnsAliasModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/New-AzSqlServerFirewallRule.md b/azps-10.1.0/Az.Sql/New-AzSqlServerFirewallRule.md new file mode 100644 index 0000000000..73092d273f --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlServerFirewallRule.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 51AF8EFB-F0C1-41E0-BBC5-E48FB1B8672C +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlserverfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerFirewallRule.md +--- + +# New-AzSqlServerFirewallRule + +## SYNOPSIS +Creates a firewall rule for a SQL Database server. + +## SYNTAX + +### UserSpecifiedRuleSet +``` +New-AzSqlServerFirewallRule -FirewallRuleName <String> -StartIpAddress <String> -EndIpAddress <String> + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AzureIpRuleSet +``` +New-AzSqlServerFirewallRule [-AllowAllAzureIPs] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlServerFirewallRule** cmdlet creates a firewall rule for the specified Azure SQL Database server. + +## EXAMPLES + +### Example 1: Create a firewall rule +```powershell +New-AzSqlServerFirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -FirewallRuleName "Rule01" -StartIpAddress "192.168.0.198" -EndIpAddress "192.168.0.199" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +StartIpAddress : 192.168.0.198 +EndIpAddress : 192.168.0.199 +FirewallRuleName : Rule01 +``` + +This command creates a firewall rule named Rule01 on the server named Server01. +The rule includes the specified start and end IP addresses. + +### Example 2: Create a firewall rule that allows all Azure IP addresses to access the server +```powershell +New-AzSqlServerFirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -AllowAllAzureIPs +``` + +This command creates a firewall rule on the server named Server01 that belongs to the resource group named ResourceGroup01. +Since the *AllowAllAzureIPs* parameter is used, the firewall rule allows all Azure IP addresses to access the server. + +## PARAMETERS + +### -AllowAllAzureIPs +Indicates that this firewall rule allows all Azure IP addresses to access the server. +You cannot use this parameter if you intend to use the *FirewallRuleName*, *StartIpAddress*, and *EndIpAddress* parameters. +If you want to allow Azure IPs to access the server, this parameter should be used in a separate cmdlet call that does not use the *FirewallRuleName*, *StartIpAddress*, and *EndIpAddress* parameters. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AzureIpRuleSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIpAddress +Specifies the end value of the IP address range for this rule. + +```yaml +Type: System.String +Parameter Sets: UserSpecifiedRuleSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleName +Specifies the name of the new firewall rule. + +```yaml +Type: System.String +Parameter Sets: UserSpecifiedRuleSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of a server. +Specify the server name, not the fully qualified DNS name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartIpAddress +Specifies the start value of the IP address range for the firewall rule. + +```yaml +Type: System.String +Parameter Sets: UserSpecifiedRuleSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServerFirewallRule](./Get-AzSqlServerFirewallRule.md) + +[Remove-AzSqlServerFirewallRule](./Remove-AzSqlServerFirewallRule.md) + +[Set-AzSqlServerFirewallRule](./Set-AzSqlServerFirewallRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/New-AzSqlServerIpv6FirewallRule.md b/azps-10.1.0/Az.Sql/New-AzSqlServerIpv6FirewallRule.md new file mode 100644 index 0000000000..36ee225702 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlServerIpv6FirewallRule.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlserveripv6firewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerIpv6FirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerIpv6FirewallRule.md +--- + +# New-AzSqlServerIpv6FirewallRule + +## SYNOPSIS +Creates an IPv6 firewall rule for a SQL Database server. + +## SYNTAX + +### UserSpecifiedRuleSet +``` +New-AzSqlServerIpv6FirewallRule -Ipv6FirewallRuleName <String> -StartIpv6Address <String> -EndIpv6Address <String> + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlServerIpv6FirewallRule** cmdlet creates an IPv6 firewall rule for the specified Azure SQL Database server. + +## EXAMPLES + +### Example 1: Create an IPv6 firewall rule +```powershell +New-AzSqlServerIpv6FirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Ipv6FirewallRuleName "Rule01" -StartIpv6Address "0000:0000:0000:0000:0000:ffff:c0a8:00c6" -EndIpv6Address "0000:0000:0000:0000:0000:ffff:c0a8:00c7" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +StartIpv6Address : 0000:0000:0000:0000:0000:ffff:c0a8:00c6 +EndIpv6Address : 0000:0000:0000:0000:0000:ffff:c0a8:00c7 +Ipv6FirewallRuleName : Rule01 +``` + +This command creates an IPv6 firewall rule named Rule01 on the server named Server01. +The rule includes the specified start and end IPv6 addresses. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIpv6Address +Specifies the end value of the IPv6 address range for this rule. + +```yaml +Type: System.String +Parameter Sets: UserSpecifiedRuleSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ipv6FirewallRuleName +Specifies the name of the new IPv6 firewall rule. + +```yaml +Type: System.String +Parameter Sets: UserSpecifiedRuleSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of a server. +Specify the server name, not the fully qualified DNS name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartIpv6Address +Specifies the start value of the IPv6 address range for the IPv6 firewall rule. + +```yaml +Type: System.String +Parameter Sets: UserSpecifiedRuleSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Ipv6FirewallRule.Model.AzureSqlServerIpv6FirewallRuleModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServerIpv6FirewallRule](./Get-AzSqlServerIpv6FirewallRule.md) + +[Remove-AzSqlServerIpv6FirewallRule](./Remove-AzSqlServerIpv6FirewallRule.md) + +[Set-AzSqlServerIpv6FirewallRule](./Set-AzSqlServerIpv6FirewallRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + diff --git a/azps-10.1.0/Az.Sql/New-AzSqlServerOutboundFirewallRule.md b/azps-10.1.0/Az.Sql/New-AzSqlServerOutboundFirewallRule.md new file mode 100644 index 0000000000..65fa439fa1 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlServerOutboundFirewallRule.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlserveroutboundfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerOutboundFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerOutboundFirewallRule.md +--- + +# New-AzSqlServerOutboundFirewallRule + +## SYNOPSIS +Adds the allowed FQDN to the list of outbound firewall rules and creates a new outbound firewall rule for Azure SQL Database server. + +## SYNTAX + +``` +New-AzSqlServerOutboundFirewallRule [-AllowedFQDN] <String> [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlServerOutboundFirewallRule** cmdlet adds the allowed FQDN to the list of outbound firewall rules and creates a new outbound firewall rule for Azure SQL Database server. + +## EXAMPLES + +### Example 1: Create a new outbound firewall rule +```powershell +New-AzSqlServerOutboundFirewallRule -ServerName "Server01" -ResourceGroupName "ResourceGroup01" -AllowedFQDN "OutboundFirewallRule01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +AllowedFQDN : OutboundFirewallRule01 +``` + +This command creates a new allowed FQDN named OutboundFirewallRule01 in the list of outbound firewall rules on the server named Server01. + +## PARAMETERS + +### -AllowedFQDN +Specifies the allowed fully qualified domain name (FQDN) in the list of outbound firewall rules. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: True +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of a server. +Specify the server name, not the fully qualified DNS name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.OutboundFirewallRules.Model.AzureSqlServerOutboundFirewallRulesModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServerOutboundFirewallRule](./Get-AzSqlServerOutboundFirewallRule.md) + +[Remove-AzSqlServerOutboundFirewallRule](./Remove-AzSqlServerOutboundFirewallRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/New-AzSqlServerTrustGroup.md b/azps-10.1.0/Az.Sql/New-AzSqlServerTrustGroup.md new file mode 100644 index 0000000000..af750922a9 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlServerTrustGroup.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlservertrustgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerTrustGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerTrustGroup.md +--- + +# New-AzSqlServerTrustGroup + +## SYNOPSIS +Creates or updates a Server Trust Group. + +## SYNTAX + +### GroupMemberObjectSet (Default) +``` +New-AzSqlServerTrustGroup [-ResourceGroupName] <String> [-Location] <String> [-Name] <String> + [-GroupMember] <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel]> + [-TrustScope <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GroupMemberResourceIdSet +``` +New-AzSqlServerTrustGroup [-ResourceGroupName] <String> [-Location] <String> [-Name] <String> + [-GroupMemberResourceId] <System.Collections.Generic.List`1[System.String]> + [-TrustScope <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a new Server Trust Group with specified location, members, trust scope, name and resource group. + +## EXAMPLES + +### Example 1 +```powershell +$managedInstanceList = @() +$mi = Get-AzSqlInstance -Name "ManagedInstance01" -ResourceGroupName "ResourceGroup01" +$managedInstanceList += $mi +$mi = Get-AzSqlInstance -Name "ManagedInstance02" -ResourceGroupName "ResourceGroup02" +$managedInstanceList += $mi +New-AzSqlServerTrustGroup -ResourceGroupName "ResourceGroup03" -Location "West Europe" -Name "ServerTrustGroup01" -GroupMember $managedInstanceList -TrustScope "GlobalTransactions" +``` + +Creates a new Server Trust Group in location West Europe with name ServerTrustGroup01. Its members are AzureSQL Managed Instances ManagedInstance01 and ManagedInstance02. Its trust scope is GlobalTransactions and its resource group is ResourceGroup03. + +### Example 2 +```powershell +$mi1 = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01" +$mi2 = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup02/providers/Microsoft.Sql/managedInstances/ManagedInstance02" +New-AzSqlServerTrustGroup -ResourceGroupName "ResourceGroup03" -Location "West Europe" -Name "ServerTrustGroup01" -GroupMemberResourceId $mi1,$mi2 -TrustScope "GlobalTransactions" +``` + +Creates a new Server Trust Group in location West Europe with name ServerTrustGroup01. Its members are AzureSQL Managed Instances ManagedInstance01 and ManagedInstance02, given by its Resource ids. Its trust scope is GlobalTransactions and its resource group is ResourceGroup03. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMember +Group members of the Server Trust Group to create. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel] +Parameter Sets: GroupMemberObjectSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMemberResourceId +Group members of the Server Trust Group to create. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: GroupMemberResourceIdSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the Server Trust Group to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Server Trust Group to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrustScope +The trust scope of the Server Trust Group to create. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerTrustGroup.Model.AzureSqlServerTrustGroupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/New-AzSqlServerVirtualNetworkRule.md b/azps-10.1.0/Az.Sql/New-AzSqlServerVirtualNetworkRule.md new file mode 100644 index 0000000000..962b4de916 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlServerVirtualNetworkRule.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlservervirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlServerVirtualNetworkRule.md +--- + +# New-AzSqlServerVirtualNetworkRule + +## SYNOPSIS +Creates an Azure SQL Server Virtual Network Rule. + +## SYNTAX + +``` +New-AzSqlServerVirtualNetworkRule -VirtualNetworkRuleName <String> -VirtualNetworkSubnetId <String> + [-IgnoreMissingVnetServiceEndpoint] [-AsJob] -ServerName <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an Azure SQL Server Virtual Network Rule. Virtual Network Rules are used to connect the Azure SQL Server to a specific Virtual Network in order to restrict the access on the Azure SQL Server to only be available within the Virtual Network. + +## EXAMPLES + +### Example 1 +```powershell +$virtualNetworkRule = New-AzSqlServerVirtualNetworkRule -ResourceGroupName rg -ServerName serverName -VirtualNetworkRuleName virtualNetworkRuleName -VirtualNetworkSubnetId virtualNetworkSubnetId +``` + +Creates an Azure SQL Server virtual network rule + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreMissingVnetServiceEndpoint +Create firewall rule before the virtual network has vnet service endpoint enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRuleName +Azure Sql Server Virtual Network Rule Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkSubnetId +The Virtual Network Subnet Id that specifies the Microsoft.Network details + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VirtualNetworkRule.Model.AzureSqlServerVirtualNetworkRuleModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/New-AzSqlSyncAgent.md b/azps-10.1.0/Az.Sql/New-AzSqlSyncAgent.md new file mode 100644 index 0000000000..ca146666ac --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlSyncAgent.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlsyncagent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlSyncAgent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlSyncAgent.md +--- + +# New-AzSqlSyncAgent + +## SYNOPSIS +Creates an Azure SQL Sync Agent. + +## SYNTAX + +### SyncDatabaseComponent (Default) +``` +New-AzSqlSyncAgent [-Name] <String> -SyncDatabaseName <String> [-SyncDatabaseServerName <String>] + [-SyncDatabaseResourceGroupName <String>] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SyncDatabaseResourceID +``` +New-AzSqlSyncAgent [-Name] <String> -SyncDatabaseResourceID <String> [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlSyncAgent** cmdlet creates an Azure SQL Sync Agent. + +## EXAMPLES + +### Example 1: Create a sync agent for an Azure SQL server. +```powershell +New-AzSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Name "SyncAgent01" -SyncDatabaseServerName "syncDatabaseServer01" ` +-SyncDatabaseName "syncDatabaseName01" -SyncDatabaseResourceGroupName "syncDatabaseResourceGroup01" | Format-List +``` + +```output +ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncAgentName : SyncAgent01 +SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} +LastAliveTime: : +Version : 4.2.0.0 +IsUpToDate : True +ExpiryTime : 12/31/9999 11:59:59 PM +State : NeverConnected +``` + +This command creates a sync agent for an Azure SQL server. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The sync agent name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SyncAgentName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the sync agent is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncDatabaseName +The database used to store sync related metadata. + +```yaml +Type: System.String +Parameter Sets: SyncDatabaseComponent +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncDatabaseResourceGroupName +The resource group the sync metadata database belongs to. + +```yaml +Type: System.String +Parameter Sets: SyncDatabaseComponent +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncDatabaseResourceID +The resource ID of the sync metadata database. + +```yaml +Type: System.String +Parameter Sets: SyncDatabaseResourceID +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncDatabaseServerName +The server on which the sync metadata database is hosted. + +```yaml +Type: System.String +Parameter Sets: SyncDatabaseComponent +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncAgentModel + +## NOTES + +## RELATED LINKS + +[Remove-AzSqlSyncAgent](./Remove-AzSqlSyncAgent.md) + +[Get-AzSqlSyncAgent](./Get-AzSqlSyncAgent.md) + diff --git a/azps-10.1.0/Az.Sql/New-AzSqlSyncAgentKey.md b/azps-10.1.0/Az.Sql/New-AzSqlSyncAgentKey.md new file mode 100644 index 0000000000..895462ca09 --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlSyncAgentKey.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlsyncagentkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlSyncAgentKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlSyncAgentKey.md +--- + +# New-AzSqlSyncAgentKey + +## SYNOPSIS +Creates an Azure SQL Sync Agent Key. + +## SYNTAX + +``` +New-AzSqlSyncAgentKey [-ServerName] <String> [-SyncAgentName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlSyncAgentKey** cmdlet creates an Azure SQL Sync Agent key. + +## EXAMPLES + +### Example 1: Create a sync agent key for an Azure SQL sync agent. +```powershell +New-AzSqlSyncAgentKey -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -SyncAgentName "SyncAgent01" +``` + +```output +SyncAgentKey : Key +``` + +This command creates a sync agent key for an Azure SQL Sync Agent. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the sync agent is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncAgentName +The sync agent name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncAgentKeyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/New-AzSqlSyncGroup.md b/azps-10.1.0/Az.Sql/New-AzSqlSyncGroup.md new file mode 100644 index 0000000000..e93902843e --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlSyncGroup.md @@ -0,0 +1,310 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlsyncgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlSyncGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlSyncGroup.md +--- + +# New-AzSqlSyncGroup + +## SYNOPSIS +Creates an Azure SQL Database Sync Group. + +## SYNTAX + +``` +New-AzSqlSyncGroup [-Name] <String> -SyncDatabaseName <String> -SyncDatabaseServerName <String> + -SyncDatabaseResourceGroupName <String> [-IntervalInSeconds <Int32>] [-DatabaseCredential <PSCredential>] + [-ConflictResolutionPolicy <String>] [-SchemaFile <String>] [-UsePrivateLinkConnection] [-ServerName] <String> + [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlSyncGroup** cmdlet creates an Azure SQL Database Sync Group. + +## EXAMPLES + +### Example 1: Create a sync group for an Azure SQL Database. +```powershell +$credential = Get-Credential +New-AzSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -Name "SyncGroup01" -ConflictResolutionPolicy "HubWin" ` +-DatabaseCredential $credential -IntervalInSeconds 100 -SyncDatabaseServerName "syncDatabaseServer01" -SyncDatabaseName "syncDatabaseName01" ` +-SyncDatabaseResourceGroupName "syncDatabaseResourceGroup01" -Schema ".\schema.json" | Format-List +``` + +```output +ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup01 +SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} +IntervalInSeconds : 100 +ConflictResolutionPolicy: : HubWin +HubDatabaseUserName : myAccount +HubDatabasePassword : +SyncState : NotReady +LastSyncTime : 1/1/0001 12:00:00 AM +Schema : +``` + +This command creates a sync group for an Azure SQL Database. "schema.json" is a file in the local disk. It contains the schema payload in json format. An example of the schema json is: +{"Tables": [{"Columns": [{"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column1"}, {"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column2"}], "QuotedName": "MayQuotedTable1"}, +{"Columns": [{"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column1"}, {"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column2"}], "QuotedName": "MayQuotedTable2"}], +"MasterSyncMemberName": null +} + +## PARAMETERS + +### -ConflictResolutionPolicy +The policy of resolving conflicts between hub and member database in the sync group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: HubWin, MemberWin + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseCredential +The SQL authentication credential of the hub database. + +```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 +``` + +### -DatabaseName +The name of the Azure SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntervalInSeconds +The frequency (in seconds) of doing data synchronization. +Default is -1, which means the auto synchronization is not enabled. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The sync group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SyncGroupName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaFile +The path of the schema file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncDatabaseName +The database used to store sync related metadata. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncDatabaseResourceGroupName +The resource group the sync metadata database belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncDatabaseServerName +The server on which the sync metadata database is hosted. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePrivateLinkConnection +Use a private link connection when connecting to the hub of this sync group. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel + +## NOTES + +## RELATED LINKS + +[Update-AzSqlSyncGroup](./Update-AzSqlSyncGroup.md) + +[Remove-AzSqlSyncGroup](./Remove-AzSqlSyncGroup.md) + +[Get-AzSqlSyncGroup](./Get-AzSqlSyncGroup.md) + diff --git a/azps-10.1.0/Az.Sql/New-AzSqlSyncMember.md b/azps-10.1.0/Az.Sql/New-AzSqlSyncMember.md new file mode 100644 index 0000000000..ced9a24b2c --- /dev/null +++ b/azps-10.1.0/Az.Sql/New-AzSqlSyncMember.md @@ -0,0 +1,429 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/new-azsqlsyncmember +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlSyncMember.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/New-AzSqlSyncMember.md +--- + +# New-AzSqlSyncMember + +## SYNOPSIS +Creates an Azure SQL Database Sync Member. + +## SYNTAX + +### AzureSqlDatabase (Default) +``` +New-AzSqlSyncMember -Name <String> -MemberDatabaseType <String> -MemberServerName <String> + -MemberDatabaseName <String> -MemberDatabaseCredential <PSCredential> [-SyncDirection <String>] + [-UsePrivateLinkConnection] [-SyncMemberAzureDatabaseResourceId <String>] [-SyncGroupName] <String> + [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### OnPremisesDatabaseSyncAgentComponent +``` +New-AzSqlSyncMember -Name <String> -MemberDatabaseType <String> -SyncAgentResourceGroupName <String> + -SyncAgentServerName <String> -SyncAgentName <String> -SqlServerDatabaseId <String> [-SyncDirection <String>] + [-UsePrivateLinkConnection] [-SyncMemberAzureDatabaseResourceId <String>] [-SyncGroupName] <String> + [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### OnPremisesDatabaseSyncAgentResourceID +``` +New-AzSqlSyncMember -Name <String> -MemberDatabaseType <String> -SqlServerDatabaseId <String> + -SyncAgentResourceID <String> [-SyncDirection <String>] [-UsePrivateLinkConnection] + [-SyncMemberAzureDatabaseResourceId <String>] [-SyncGroupName] <String> [-ServerName] <String> + [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSqlSyncMember** cmdlet creates an Azure SQL Database Sync Member. + +## EXAMPLES + +### Example 1: Create a sync member for an Azure SQL database. +```powershell +$credential = Get-Credential +New-AzSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -Name "SyncMember01" -SyncDirection "OneWayMemberToHub" ` +-MemberDatabaseType "AzureSqlDatabase" -MemberServerName "memberServer01.full.dns.name" -MemberDatabaseName "memberDatabase01" -MemberDatabaseCredential $credential | Format-List +``` + +```output +ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup01 +SyncMemberName : SyncMember01 +SyncDirection : OneWayMemberToHub +MemberDatabaseType: : AzureSqlDatabase +SyncAgentId : +SqlServerDatabaseId : +MemberServerName : memberServer01.full.dns.name +MemberDatabaseName : memberDatabase01 +MemberDatabaseUserName : myAccount +MemberDatabasePassword : +SyncState : UnProvisioned +``` + +This command creates a sync member for an Azure SQL database. + +### Example 2: Create a sync member for an on-premises SQL Server database +```powershell +$credential = Get-Credential +New-AzSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -Name "SyncMember01" -SyncDirection "OneWayMemberToHub" ` +-MemberDatabaseType "SqlServerDatabase" -SqlServerDatabaseId "dbId" -syncAgentResourceGroupName "syncAgentResourceGroupName" -syncAgentServerName "syncAgentServerName" ` +-syncAgentDatabaseName "syncAgentDatabaseName" -syncAgentName "agentName" | Format-List +``` + +```output +ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup01 +SyncMemberName : SyncMember01 +SyncDirection : OneWayMemberToHub +MemberDatabaseType: : AzureSqlDatabase +SyncAgentId : /subscriptions/{subscriptionId}/resourceGroups/{syncAgentResourceGroupName}/servers/{syncAgentServerName}/syncAgents/{syncAgentId} +SqlServerDatabaseId : dbId +MemberServerName : +MemberDatabaseName : +MemberDatabaseUserName : myAccount +MemberDatabasePassword : +SyncState : UnProvisioned +``` + +This command creates a sync member for an on-premises SQL database. + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberDatabaseCredential +The credential (username and password) of the Azure SQL Database. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: AzureSqlDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberDatabaseName +The Azure SQL Database name of the member database. + +```yaml +Type: System.String +Parameter Sets: AzureSqlDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberDatabaseType +The database type of the member database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: SqlServerDatabase, AzureSqlDatabase + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MemberServerName +The Azure SQL Server Name of the member database. + +```yaml +Type: System.String +Parameter Sets: AzureSqlDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The sync member name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SyncMemberName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlServerDatabaseId +The id of the SQL server database which is connected by the sync agent. + +```yaml +Type: System.String +Parameter Sets: OnPremisesDatabaseSyncAgentComponent, OnPremisesDatabaseSyncAgentResourceID +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncAgentName +The name of the sync agent. + +```yaml +Type: System.String +Parameter Sets: OnPremisesDatabaseSyncAgentComponent +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncAgentResourceGroupName +The name of the resource group where the sync agent is under. + +```yaml +Type: System.String +Parameter Sets: OnPremisesDatabaseSyncAgentComponent +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncAgentResourceID +The resource ID of the sync agent. + +```yaml +Type: System.String +Parameter Sets: OnPremisesDatabaseSyncAgentResourceID +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncAgentServerName +The name of the Azure SQL Server where the sync agent is under. + +```yaml +Type: System.String +Parameter Sets: OnPremisesDatabaseSyncAgentComponent +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncDirection +The sync direction of this sync member. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Bidirectional, OneWayMemberToHub, OneWayHubToMember + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncGroupName +The sync group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncMemberAzureDatabaseResourceId +The resource ID for the sync member database, used if UsePrivateLinkConnection is set to true. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePrivateLinkConnection +Use a private link connection when connecting to this sync member. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncMemberModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlSyncMember](./Get-AzSqlSyncMember.md) + +[Update-AzSqlSyncMember](./Update-AzSqlSyncMember.md) + +[Remove-AzSqlSyncMember](./Remove-AzSqlSyncMember.md) + diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlDatabase.md b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabase.md new file mode 100644 index 0000000000..6830079b4f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabase.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: B396388D-F91C-4BC9-A211-ABFF5DFC1693 +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabase.md +--- + +# Remove-AzSqlDatabase + +## SYNOPSIS +Removes an Azure SQL database. + +## SYNTAX + +``` +Remove-AzSqlDatabase [-DatabaseName] <String> [-Force] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlDatabase** cmdlet removes an Azure SQL database. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Remove a database from an Azure SQL server +```powershell +Remove-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +This command removes the database named Database01 from server Server01. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the Azure resource group to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabase](./Get-AzSqlDatabase.md) + +[New-AzSqlDatabase](./New-AzSqlDatabase.md) + +[Resume-AzSqlDatabase](./Resume-AzSqlDatabase.md) + +[Set-AzSqlDatabase](./Set-AzSqlDatabase.md) + +[Suspend-AzSqlDatabase](./Suspend-AzSqlDatabase.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseAudit.md b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseAudit.md new file mode 100644 index 0000000000..a257da98d7 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseAudit.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/Remove-AzSqlDatabaseAudit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseAudit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseAudit.md +--- + +# Remove-AzSqlDatabaseAudit + +## SYNOPSIS +Removes the auditing settings of an Azure SQL database. + +## SYNTAX + +### DatabaseParameterSet (Default) +``` +Remove-AzSqlDatabaseAudit [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DatabaseObjectParameterSet +``` +Remove-AzSqlDatabaseAudit -DatabaseObject <AzureSqlDatabaseModel> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlDatabaseAudit** cmdlet removes the auditing settings of an Azure SQL database. +To use the cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. + +## EXAMPLES + +### Example 1: Remove the auditing settings of an Azure SQL database +```powershell +Remove-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +### Example 2: Remove, through pipeline, the auditing settings of an Azure SQL database +```powershell +Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" | Remove-AzSqlDatabaseAudit +``` + +## PARAMETERS + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseObject +The database object to manage its audit policy. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: DatabaseObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseDataMaskingRule.md b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseDataMaskingRule.md new file mode 100644 index 0000000000..ad65820cf5 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseDataMaskingRule.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 4695AFEA-D244-4FCB-AF36-D8CDEBFB392C +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqldatabasedatamaskingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseDataMaskingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseDataMaskingRule.md +--- + +# Remove-AzSqlDatabaseDataMaskingRule + +## SYNOPSIS +Removes a data masking rule from a database. + +## SYNTAX + +``` +Remove-AzSqlDatabaseDataMaskingRule [-PassThru] [-Force] -SchemaName <String> -TableName <String> + -ColumnName <String> [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlDatabaseDataMaskingRule** cmdlet removes a specific data masking rule from an Azure SQL database. +You can remove a data masking rule by using the *ResourceGroupName*, *ServerName*, *DatabaseName*, and *RuleId* parameters to identify the rule that this cmdlet removes. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Remove a database data masking rule +```powershell +Remove-AzSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SchemaName "dbo" -TableName "table1" -ColumnName "column1" +``` + +This command removes rule name Rule01 defined for the database Database01. +The database is located on Server01 and assigned to resource group ResourceGroup01. + +## PARAMETERS + +### -ColumnName +Specifies the name of the column targeted by the masking rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Specifies the name of a schema. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Specifies the name of an Azure SQL table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataMasking.Model.DatabaseDataMaskingRuleModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseDataMaskingRule](./Get-AzSqlDatabaseDataMaskingRule.md) + +[New-AzSqlDatabaseDataMaskingRule](./New-AzSqlDatabaseDataMaskingRule.md) + +[Set-AzSqlDatabaseDataMaskingRule](./Set-AzSqlDatabaseDataMaskingRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseFailoverGroup.md b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseFailoverGroup.md new file mode 100644 index 0000000000..07b618aafb --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseFailoverGroup.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqldatabasefailovergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseFailoverGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseFailoverGroup.md +--- + +# Remove-AzSqlDatabaseFailoverGroup + +## SYNOPSIS +Removes an Azure SQL Database Failover Group. + +## SYNTAX + +``` +Remove-AzSqlDatabaseFailoverGroup [-ServerName] <String> [-FailoverGroupName] <String> [-Force] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This command removes the Failover Group with the specified name, leaving all databases and replication relationships intact. The listener endpoint will be unregistered from DNS. +The Failover Group's primary server should be used to execute the command. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg +``` + +Remove a Failover Group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverGroupName +The name of the Azure SQL Database Failover Group to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the primary Azure SQL Database Server of the Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlDatabaseFailoverGroup](./New-AzSqlDatabaseFailoverGroup.md) + +[Set-AzSqlDatabaseFailoverGroup](./Set-AzSqlDatabaseFailoverGroup.md) + +[Get-AzSqlDatabaseFailoverGroup](./Get-AzSqlDatabaseFailoverGroup.md) + +[Add-AzSqlDatabaseToFailoverGroup](./Add-AzSqlDatabaseToFailoverGroup.md) + +[Remove-AzSqlDatabaseFromFailoverGroup](./Remove-AzSqlDatabaseFromFailoverGroup.md) + +[Switch-AzSqlDatabaseFailoverGroup](./Switch-AzSqlDatabaseFailoverGroup.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseFromFailoverGroup.md b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseFromFailoverGroup.md new file mode 100644 index 0000000000..04d0d2e7d4 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseFromFailoverGroup.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqldatabasefromfailovergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseFromFailoverGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseFromFailoverGroup.md +--- + +# Remove-AzSqlDatabaseFromFailoverGroup + +## SYNOPSIS +Removes one or more databases from an Azure SQL Database Failover Group. + +## SYNTAX + +``` +Remove-AzSqlDatabaseFromFailoverGroup [-ServerName] <String> [-FailoverGroupName] <String> + -Database <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel]> + [-Force] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Removes one or more databases from the specified Azure SQL Database Failover Group. The databases and replication relationships are left intact, but they will no longer be accessible through the Failover Group endpoints. +To obtain database objects with which to populate the '-Database' parameter, use (for example) the Get-AzSqlDatabase cmdlet. +The Failover Group's primary server must be used to execute the command. + +## EXAMPLES + +### Example 1 +```powershell +$failoverGroup = Get-AzSqlDatabase -ResourceGroupName rg -ServerName primaryserver -DatabaseName db1 | Remove-AzSqlDatabaseFromFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg +``` + +This command removes one database from a Failover Group by piping it in. + +### Example 2 +```powershell +$primaryServer = Get-AzSqlServer -ResourceGroupName rg -ServerName primaryserver +$failoverGroup = $primaryServer | Remove-AzSqlDatabaseFromFailoverGroup -FailoverGroupName fg -Database ($primaryServer | Get-AzSqlDatabase) +``` + +This command removes all databases from a Failover Group. + +### Example 3 +```powershell +$failoverGroup = Get-AzSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg +$databases = Get-AzSqlElasticPoolDatabase -ResourceGroupName rg -ServerName primaryserver -ElasticPoolName pool1 +$failoverGroup = $failoverGroup | Remove-AzSqlDatabaseFromFailoverGroup -Database $databases +``` + +This command removes all databases in an Elastic Pool from a Failover Group. + +## PARAMETERS + +### -Database +One or more Azure SQL Databases on the Failover Group's primary server to be removed from the Failover Group. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverGroupName +The name of the Azure SQL Database Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the primary Azure SQL Database Server of the Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel, Microsoft.Azure.PowerShell.Cmdlets.Sql, Version=1.3.0.0, Culture=neutral, PublicKeyToken=null]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlDatabaseFailoverGroup](./New-AzSqlDatabaseFailoverGroup.md) + +[Set-AzSqlDatabaseFailoverGroup](./Set-AzSqlDatabaseFailoverGroup.md) + +[Get-AzSqlDatabaseFailoverGroup](./Get-AzSqlDatabaseFailoverGroup.md) + +[Add-AzSqlDatabaseToFailoverGroup](./Add-AzSqlDatabaseToFailoverGroup.md) + +[Switch-AzSqlDatabaseFailoverGroup](./Switch-AzSqlDatabaseFailoverGroup.md) + +[Remove-AzSqlDatabaseFailoverGroup](./Remove-AzSqlDatabaseFailoverGroup.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseInstanceFailoverGroup.md b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseInstanceFailoverGroup.md new file mode 100644 index 0000000000..1686dce848 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseInstanceFailoverGroup.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqldatabaseinstancefailovergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseInstanceFailoverGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseInstanceFailoverGroup.md +--- + +# Remove-AzSqlDatabaseInstanceFailoverGroup + +## SYNOPSIS +Removes an Instance Failover Group. + +## SYNTAX + +### RemoveIFGDefaultSet (Default) +``` +Remove-AzSqlDatabaseInstanceFailoverGroup [-ResourceGroupName] <String> [-Location] <String> [-Name] <String> + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveInstanceFailoverGroupByResourceId +``` +Remove-AzSqlDatabaseInstanceFailoverGroup [-Location] <String> [-ResourceId] <String> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveInstanceFailoverGroupByAzureSqlInstanceFailoverGroupModelSet +``` +Remove-AzSqlDatabaseInstanceFailoverGroup [-InputObject] <AzureSqlInstanceFailoverGroupModel> [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command removes the Instance Failover Group with the specified name, leaving all databases intact. The listener endpoint will be unregistered from DNS. + +The Instance Failover Group's primary region should be used to execute the command. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlDatabaseInstanceFailoverGroup -ResourceGroupName rg -Location location -Name fg | Remove-AzSqlDatabaseInstanceFailoverGroup +``` + +Remove a Instance Failover Group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Instance Failover Group object to remove + +```yaml +Type: Microsoft.Azure.Commands.Sql.InstanceFailoverGroup.Model.AzureSqlInstanceFailoverGroupModel +Parameter Sets: RemoveInstanceFailoverGroupByAzureSqlInstanceFailoverGroupModelSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The name of the Local Region from which to retrieve the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: RemoveIFGDefaultSet, RemoveInstanceFailoverGroupByResourceId +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Instance Failover Group to remove. + +```yaml +Type: System.String +Parameter Sets: RemoveIFGDefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Specifies whether to pass through cmdlet execution output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: RemoveIFGDefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Resource ID of the Instance Failover Group to remove. + +```yaml +Type: System.String +Parameter Sets: RemoveInstanceFailoverGroupByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.InstanceFailoverGroup.Model.AzureSqlInstanceFailoverGroupModel +System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.InstanceFailoverGroup.Model.AzureSqlInstanceFailoverGroupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseLongTermRetentionBackup.md b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseLongTermRetentionBackup.md new file mode 100644 index 0000000000..c163a1a937 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseLongTermRetentionBackup.md @@ -0,0 +1,316 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqldatabaselongtermretentionbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseLongTermRetentionBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseLongTermRetentionBackup.md +--- + +# Remove-AzSqlDatabaseLongTermRetentionBackup + +## SYNOPSIS +Deletes a long term retention backup. + +## SYNTAX + +### RemoveBackupDefault (Default) +``` +Remove-AzSqlDatabaseLongTermRetentionBackup [-Location] <String> [-ServerName] <String> + [-DatabaseName] <String> [-BackupName] <String> [-ResourceGroupName <String>] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveBackupByInputObject +``` +Remove-AzSqlDatabaseLongTermRetentionBackup [-InputObject] <AzureSqlDatabaseLongTermRetentionBackupModel> + [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveBackupByResourceId +``` +Remove-AzSqlDatabaseLongTermRetentionBackup [-ResourceId] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlDatabaseLongTermRetentionBackup** cmdlet deletes the backup specified. + +## EXAMPLES + +### Example 1: Delete a single backup with resource group +```powershell +Remove-AzSqlDatabaseLongTermRetentionBackup -Location northeurope -ServerName server01 -DatabaseName database01 -BackupName "601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000" -ResourceGroupName resourcegroup01 +``` + +```output +BackupExpirationTime : 3/22/2018 5:50:55 AM +BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +BackupTime : 3/15/2018 5:50:55 AM +DatabaseName : database01 +DatabaseDeletionTime : +Location : northeurope +ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +ServerName : server01 +ServerCreateTime : 2/29/2018 12:12:19 AM +``` + +Deletes the backup with name 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 + +### Example 2: Delete a single backup without resource group +```powershell +Remove-AzSqlDatabaseLongTermRetentionBackup -Location northeurope -ServerName server02 -DatabaseName database02 -BackupName "55970792-164c-4a4a-88e5-7158d092d503;131656309980000000" +``` + +```output +BackupExpirationTime : 3/22/2018 11:43:18 PM +BackupName : 55970792-164c-4a4a-88e5-7158d092d503;131656309980000000 +BackupTime : 3/15/2018 11:43:18 PM +DatabaseName : database02 +DatabaseDeletionTime : 3/18/2018 4:36:00 PM +Location : northeurope +ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server02/longTermRetentionDatabases/database02/longTermRetentionBackups/55970792-164c-4a4a-88e5-7158d092d503;131656309980000000 +ServerName : server02 +ServerCreateTime : 2/28/2018 12:12:19 AM +``` + +Deletes the backup with name 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 + +### Example 3: Delete all backups for a location +```powershell +Get-AzSqlDatabaseLongTermRetentionBackup -Location northeurope | Remove-AzSqlDatabaseLongTermRetentionBackup +``` + +```output +BackupExpirationTime : 3/22/2018 5:50:55 AM +BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +BackupTime : 3/15/2018 5:50:55 AM +DatabaseName : database01 +DatabaseDeletionTime : +Location : northeurope +ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/resourceGroups/resourcegroup01/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 +ServerName : server01 +ServerCreateTime : 2/29/2018 12:12:19 AM + +BackupExpirationTime : 3/22/2018 11:43:18 PM +BackupName : 55970792-164c-4a4a-88e5-7158d092d503;131656309980000000 +BackupTime : 3/15/2018 11:43:18 PM +DatabaseName : database02 +DatabaseDeletionTime : 3/18/2018 4:36:00 PM +Location : northeurope +ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server02/longTermRetentionDatabases/database02/longTermRetentionBackups/55970792-164c-4a4a-88e5-7158d092d503;131656309980000000 +ServerName : server02 +ServerCreateTime : 2/28/2018 12:12:19 AM +``` + +This command deletes all long term retention backups for the northeurope location. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupName +The name of the backup. + +```yaml +Type: System.String +Parameter Sets: RemoveBackupDefault +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Database the backup is from. + +```yaml +Type: System.String +Parameter Sets: RemoveBackupDefault +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```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 +``` + +### -InputObject +The Database Long Term Retention Backup object to remove. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseLongTermRetentionBackupModel +Parameter Sets: RemoveBackupByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the backups' source server. + +```yaml +Type: System.String +Parameter Sets: RemoveBackupDefault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: RemoveBackupDefault +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Resource ID of the Database Long Term Retention Backup to remove. + +```yaml +Type: System.String +Parameter Sets: RemoveBackupByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the backup is under. + +```yaml +Type: System.String +Parameter Sets: RemoveBackupDefault +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseLongTermRetentionBackupModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseLongTermRetentionBackup](./Get-AzSqlDatabaseLongTermRetentionBackup.md) + +[Update-AzSqlDatabaseLongTermRetentionBackup](./Update-AzSqlDatabaseLongTermRetentionBackup.md) + +[Copy-AzSqlDatabaseLongTermRetentionBackup](./Copy-AzSqlDatabaseLongTermRetentionBackup.md) + +[Get-AzSqlDatabaseBackupLongTermRetentionPolicy](./Get-AzSqlDatabaseBackupLongTermRetentionPolicy.md) + +[Set-AzSqlDatabaseBackupLongTermRetentionPolicy](./Set-AzSqlDatabaseBackupLongTermRetentionPolicy.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseRestorePoint.md b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseRestorePoint.md new file mode 100644 index 0000000000..dccddff6ff --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseRestorePoint.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 67A9BB67-EF14-4CAA-99D9-002D0D23178B +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqldatabaserestorepoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseRestorePoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseRestorePoint.md +--- + +# Remove-AzSqlDatabaseRestorePoint + +## SYNOPSIS +Removes given restore point from a SQL Database. + +## SYNTAX + +``` +Remove-AzSqlDatabaseRestorePoint -RestorePointCreationDate <DateTime> [-PassThru] [-ServerName] <String> + [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlDatabaseRestorePoint** cmdlet removes given restore point from Azure SQL Database. +This cmdlet is currently supported by the SQL Server Datawarehouse service on Azure SQL Database. + +## EXAMPLES + +### Example 1: Removes a restore point +```powershell +$RestorePointCreationDate = Get-Date "3/11/2017 1:50:00 AM" +Remove-AzSqlDatabaseRestorePoint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -RestorePointCreationDate $RestorePointCreationDate +``` + +This command removes a restore point for Azure SQL Database given creation date. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the SQL Database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestorePointCreationDate +Specifies the restore point creation date. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the AzureSQL Server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.DateTime + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseRestorePointModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseSecondary.md b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseSecondary.md new file mode 100644 index 0000000000..28794fbd60 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseSecondary.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 54E01B3B-FFA5-4E3C-BA5A-A281FF5C9F8B +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqldatabasesecondary +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseSecondary.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseSecondary.md +--- + +# Remove-AzSqlDatabaseSecondary + +## SYNOPSIS +Terminates data replication between a SQL Database and the specified secondary database. + +## SYNTAX + +``` +Remove-AzSqlDatabaseSecondary [-DatabaseName] <String> -PartnerResourceGroupName <String> + -PartnerServerName <String> [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlDatabaseSecondary** cmdlet forces termination of a geo-replication link. +This cmdlet replaces the Stop-AzSqlDatabaseCopy cmdlet. +There is no replication synchronization before termination. + +## EXAMPLES + +### Example 1 + +Terminates data replication between a SQL Database and the specified secondary database. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Remove-AzSqlDatabaseSecondary -DatabaseName db1 -PartnerResourceGroupName rg2 -PartnerServerName secondaryserver -ResourceGroupName myresourcegroup -ServerName s1 +``` + +## PARAMETERS + +### -DatabaseName +Specifies the name of the primary Azure SQL Database that has the replication link that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerResourceGroupName +Specifies the name of the partner resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PartnerServerName +Specifies the name of the partner SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that is associated with the replication link to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL Server that has the replication link to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Replication.Model.AzureReplicationLinkModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlDatabaseSecondary](./New-AzSqlDatabaseSecondary.md) + +[Set-AzSqlDatabaseSecondary](./Set-AzSqlDatabaseSecondary.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseSensitivityClassification.md b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseSensitivityClassification.md new file mode 100644 index 0000000000..23de4ffb65 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlDatabaseSensitivityClassification.md @@ -0,0 +1,270 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqldatabasesensitivityclassification +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseSensitivityClassification.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlDatabaseSensitivityClassification.md +--- + +# Remove-AzSqlDatabaseSensitivityClassification + +## SYNOPSIS +Removes the information types and sensitivity labels of columns in the database. + +## SYNTAX + +### ClassificationObjectParameterSet (Default) +``` +Remove-AzSqlDatabaseSensitivityClassification -ClassificationObject <SqlDatabaseSensitivityClassificationModel> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Remove-AzSqlDatabaseSensitivityClassification [-ResourceGroupName] <String> [-ServerName] <String> + [-DatabaseName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DatabaseObjectColumnParameterSet +``` +Remove-AzSqlDatabaseSensitivityClassification -DatabaseObject <AzureSqlDatabaseModel> -SchemaName <String> + -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzSqlDatabaseSensitivityClassification cmdlet removes the information types and sensitivity labels of columns in the database. + +## EXAMPLES + +### Example 1: Remove information type and sensitivity label of a column in an Azure SQL Database. +```powershell +Remove-AzSqlDatabaseSensitivityClassification -ResourceGroupName resourceGroup -ServerName server -DatabaseName database -SchemaName schema -TableName table -ColumnName column +``` + +### Example 2: Remove current information types and sensitivity labels of columns in an Azure SQL database using Piping. +```powershell +Get-AzSqlDatabaseSensitivityClassification -ResourceGroupName resourceGroup -ServerName server -DatabaseName database | Remove-AzSqlDatabaseSensitivityClassification +``` + +### Example 3: Remove information type and sensitivity label of a column in an Azure SQL database using Piping. +```powershell +Get-AzSqlDatabase -ResourceGroupName resourceGroup -ServerName server -DatabaseName database | Remove-AzSqlDatabaseSensitivityClassification -SchemaName schema -TableName table -ColumnName column +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationObject +An object representing a SQL Database Sensitivity Classification. + +```yaml +Type: Microsoft.Azure.Commands.Sql.DataClassification.Model.SqlDatabaseSensitivityClassificationModel +Parameter Sets: ClassificationObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL database. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +The SQL database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Specifies whether to output the sensitivity classification model at end of cmdlet execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.DataClassification.Model.SqlDatabaseSensitivityClassificationModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Learn more about Azure SQL Database data discovery and classification](https://learn.microsoft.com/azure/sql-database/sql-database-data-discovery-and-classification) diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJob.md b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJob.md new file mode 100644 index 0000000000..f4d59f3a85 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJob.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/remove-Azsqlelasticjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticJob.md +--- + +# Remove-AzSqlElasticJob + +## SYNOPSIS +Removes a job + +## SYNTAX + +### DefaultSet (Default) +``` +Remove-AzSqlElasticJob [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-Name] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectSet +``` +Remove-AzSqlElasticJob [-InputObject] <AzureSqlElasticJobModel> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzSqlElasticJob [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzSqlElasticJob cmdlet removes a job + +## EXAMPLES + +### Example 1: Removes a job +```powershell +$agent = Get-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent +$agent | Remove-AzSqlElasticJob -Name job1 +``` + +```output +JobName Version Description StartTime EndTime ScheduleType Interval Enabled +------- ------- ----------- --------- ------- ------------ -------- ------- +job1 0 6/1/2018 9:46:29 PM 12/31/9999 11:59:59 AM Once False +``` + +Removes a job + +### Example 2 + +Removes a job. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Remove-AzSqlElasticJob -AgentName agent -Name job1 -ResourceGroupName MyResourceGroup -ServerName s1 +``` + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```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 +``` + +### -InputObject +The job input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The job name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: JobName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The agent resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobAgent.md b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobAgent.md new file mode 100644 index 0000000000..c6f0b8d810 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobAgent.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/remove-Azsqlelasticjobagent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticJobAgent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticJobAgent.md +--- + +# Remove-AzSqlElasticJobAgent + +## SYNOPSIS +Removes the elastic job agent + +## SYNTAX + +### DefaultSet (Default) +``` +Remove-AzSqlElasticJobAgent [-ResourceGroupName] <String> [-ServerName] <String> [-Name] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectSet +``` +Remove-AzSqlElasticJobAgent [-InputObject] <AzureSqlElasticJobAgentModel> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzSqlElasticJobAgent [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzSqlElasticJobAgent cmdlet removes an Elastic Job agent + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent +``` + +```output +ResourceGroupName ServerName DatabaseName AgentName State Tags +----------------- ---------- ------------ --------- ----- ---- +rg elasticjobserver jobdb agent Ready {[Octopus, Agent]} +``` + +Removes an Elastic Job agent + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```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 +``` + +### -InputObject +The agent object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: AgentName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The agent resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobCredential.md b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobCredential.md new file mode 100644 index 0000000000..e86e337def --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobCredential.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/remove-Azsqlelasticjobcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticJobCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticJobCredential.md +--- + +# Remove-AzSqlElasticJobCredential + +## SYNOPSIS +Removes the elastic job credential + +## SYNTAX + +### DefaultSet (Default) +``` +Remove-AzSqlElasticJobCredential [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectSet +``` +Remove-AzSqlElasticJobCredential [-InputObject] <AzureSqlElasticJobCredentialModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzSqlElasticJobCredential [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzSqlElasticJobCredential cmdlet removes a job credential + +## EXAMPLES + +### Example 1 +```powershell +$agent = Get-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent +$agent | Remove-AzSqlElasticJobCredential -Name cred1 +``` + +```output +CredentialName UserName +-------------- -------- +cred1 user2 +``` + +Removes a job credential + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The job credential object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobCredentialModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The job credential name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: CredentialName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The job credential resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobCredentialModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobCredentialModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobStep.md b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobStep.md new file mode 100644 index 0000000000..aa0481bdb6 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobStep.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/remove-Azsqlelasticjobstep +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticJobStep.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticJobStep.md +--- + +# Remove-AzSqlElasticJobStep + +## SYNOPSIS +Removes the job step + +## SYNTAX + +### DefaultSet (Default) +``` +Remove-AzSqlElasticJobStep [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectSet +``` +Remove-AzSqlElasticJobStep [-InputObject] <AzureSqlElasticJobStepModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzSqlElasticJobStep [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzSqlElasticJobStep cmdlet removes a job step from a job + +## EXAMPLES + +### Example 1: Removes a job step from a job +```powershell +$jobStep = Get-AzSqlElasticJobStep -ResourceGroupName rg -ServerName elasticjobserver -AgentName agent -JobName job1 -Name step1 +$jobStep | Remove-AzSqlElasticJobStep +``` + +```output +JobName StepName StepId TargetGroupName CredentialName Output CommandText +------- -------- ------ --------------- -------------- ------ ----------- +job1 step1 1 tg1 cred1 SELECT 1 +``` + +Removes a job step from a job + +### Example 2 + +<!-- Aladdin Generated Example --> +```powershell +Remove-AzSqlElasticJobStep -AgentName agent -JobName job1 -Name step1 -ResourceGroupName MyResourceGroup -ServerName s1 +``` + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The job step input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobStepModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The job name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The job step name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: StepName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The job step resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobStepModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobStepModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobTarget.md b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobTarget.md new file mode 100644 index 0000000000..46d4871fc6 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobTarget.md @@ -0,0 +1,372 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/remove-Azsqlelasticjobtarget +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticJobTarget.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticJobTarget.md +--- + +# Remove-AzSqlElasticJobTarget + +## SYNOPSIS +Removes the target from the target group + +## SYNTAX + +### SqlDatabase (Default) +``` +Remove-AzSqlElasticJobTarget [-ResourceGroupName] <String> [-AgentServerName] <String> [-AgentName] <String> + [-TargetGroupName] <String> -ServerName <String> -DatabaseName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlServerOrElasticPool +``` +Remove-AzSqlElasticJobTarget [-ResourceGroupName] <String> [-AgentServerName] <String> [-AgentName] <String> + [-TargetGroupName] <String> -ServerName <String> [-ElasticPoolName <String>] -RefreshCredentialName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlShardMap +``` +Remove-AzSqlElasticJobTarget [-ResourceGroupName] <String> [-AgentServerName] <String> [-AgentName] <String> + [-TargetGroupName] <String> -ServerName <String> -ShardMapName <String> -DatabaseName <String> + -RefreshCredentialName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SqlDatabaseUsingParentObject +``` +Remove-AzSqlElasticJobTarget [-ParentObject] <AzureSqlElasticJobTargetGroupModel> -ServerName <String> + -DatabaseName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlServerOrElasticPoolUsingParentObject +``` +Remove-AzSqlElasticJobTarget [-ParentObject] <AzureSqlElasticJobTargetGroupModel> -ServerName <String> + [-ElasticPoolName <String>] -RefreshCredentialName <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlShardMapUsingParentObject +``` +Remove-AzSqlElasticJobTarget [-ParentObject] <AzureSqlElasticJobTargetGroupModel> -ServerName <String> + -ShardMapName <String> -DatabaseName <String> -RefreshCredentialName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlDatabaseUsingParentResourceId +``` +Remove-AzSqlElasticJobTarget [-ParentResourceId] <String> -ServerName <String> -DatabaseName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlServerOrElasticPoolUsingParentResourceId +``` +Remove-AzSqlElasticJobTarget [-ParentResourceId] <String> -ServerName <String> [-ElasticPoolName <String>] + -RefreshCredentialName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SqlShardMapUsingParentResourceId +``` +Remove-AzSqlElasticJobTarget [-ParentResourceId] <String> -ServerName <String> -ShardMapName <String> + -DatabaseName <String> -RefreshCredentialName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzSqlElasticJobTarget cmdlet removes a target resource to a target group + +## EXAMPLES + +### Example 1: Remove a server target +```powershell +$tg = Get-AzSqlElasticJobTargetGroup -ResourceGroupName rg -ServerName elasticjobserver -Name tg1 +$tg | Remove-AzSqlElasticJobTarget -ServerName s1 -RefreshCredentialName cred1 +``` + +```output +TargetGroupName TargetType TargetServerName TargetDatabaseName TargetElasticPoolName TargetShardMapName RefreshCredentialName MembershipType +--------------- ---------- ---------------- ------------------ --------------------- ------------------ --------------------- -------------- +tg1 SqlServer s1 cred1 Include +``` + +### Example 2: Remove a database target +```powershell +$tg = Get-AzSqlElasticJobTargetGroup -ResourceGroupName rg -ServerName elasticjobserver -Name tg1 +$tg | Remove-AzSqlElasticJobTarget -ServerName s1 -DatabaseName db2 +``` + +```output +TargetGroupName TargetType TargetServerName TargetDatabaseName TargetElasticPoolName TargetShardMapName RefreshCredentialName MembershipType +--------------- ---------- ---------------- ------------------ --------------------- ------------------ --------------------- -------------- +tg1 SqlDatabase s1 db2 Include +``` + +### Example 3: Remove an elastic pool target +```powershell +$tg = Get-AzSqlElasticJobTargetGroup -ResourceGroupName rg -ServerName elasticjobserver -Name tg1 +$tg | Remove-AzSqlElasticJobTarget -ServerName s1 -ElasticPoolName ep1 -RefreshCredentialName cred1 +``` + +```output +TargetGroupName TargetType TargetServerName TargetDatabaseName TargetElasticPoolName TargetShardMapName RefreshCredentialName MembershipType +--------------- ---------- ---------------- ------------------ --------------------- ------------------ --------------------- -------------- +tg1 SqlElasticPool s1 ep1 cred1 Include +``` + +### Example 4: Remove a shard map target +```powershell +$tg = Get-AzSqlElasticJobTargetGroup -ResourceGroupName rg -ServerName elasticjobserver -Name tg1 +$tg | Remove-AzSqlElasticJobTarget -ServerName s1 -ShardMapName sm1 -DatabaseName db1 -RefreshCredentialName cred1 +``` + +```output +TargetGroupName TargetType TargetServerName TargetDatabaseName TargetElasticPoolName TargetShardMapName RefreshCredentialName MembershipType +--------------- ---------- ---------------- ------------------ --------------------- ------------------ --------------------- -------------- +tg1 SqlShardMap s1 db1 sm1 cred1 Include +``` + +Removes a target (server, elastic pool, database, and shard map) from a target group + +## PARAMETERS + +### -AgentName +SQL Database Agent Name. + +```yaml +Type: System.String +Parameter Sets: SqlDatabase, SqlServerOrElasticPool, SqlShardMap +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentServerName +SQL Database Agent Server Name. + +```yaml +Type: System.String +Parameter Sets: SqlDatabase, SqlServerOrElasticPool, SqlShardMap +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Database Target Name + +```yaml +Type: System.String +Parameter Sets: SqlDatabase, SqlShardMap, SqlDatabaseUsingParentObject, SqlShardMapUsingParentObject, SqlDatabaseUsingParentResourceId, SqlShardMapUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Elastic Pool Target Name + +```yaml +Type: System.String +Parameter Sets: SqlServerOrElasticPool, SqlServerOrElasticPoolUsingParentObject, SqlServerOrElasticPoolUsingParentResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentObject +The target group object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobTargetGroupModel +Parameter Sets: SqlDatabaseUsingParentObject, SqlServerOrElasticPoolUsingParentObject, SqlShardMapUsingParentObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The target group resource id. + +```yaml +Type: System.String +Parameter Sets: SqlDatabaseUsingParentResourceId, SqlServerOrElasticPoolUsingParentResourceId, SqlShardMapUsingParentResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RefreshCredentialName +Refresh Credential Name + +```yaml +Type: System.String +Parameter Sets: SqlServerOrElasticPool, SqlShardMap, SqlServerOrElasticPoolUsingParentObject, SqlShardMapUsingParentObject, SqlServerOrElasticPoolUsingParentResourceId, SqlShardMapUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: SqlDatabase, SqlServerOrElasticPool, SqlShardMap +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +Server Target Name + +```yaml +Type: System.String +Parameter Sets: SqlDatabase, SqlShardMap, SqlDatabaseUsingParentObject, SqlServerOrElasticPoolUsingParentObject, SqlShardMapUsingParentObject, SqlDatabaseUsingParentResourceId, SqlServerOrElasticPoolUsingParentResourceId, SqlShardMapUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: SqlServerOrElasticPool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShardMapName +Shard Map Target Name + +```yaml +Type: System.String +Parameter Sets: SqlShardMap, SqlShardMapUsingParentObject, SqlShardMapUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetGroupName +SQL Database Agent Name. + +```yaml +Type: System.String +Parameter Sets: SqlDatabase, SqlServerOrElasticPool, SqlShardMap +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobTargetGroupModel + +## OUTPUTS + +### Microsoft.Azure.Management.Sql.Models.JobTarget + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobTargetGroup.md b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobTargetGroup.md new file mode 100644 index 0000000000..a1a57ef960 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticJobTargetGroup.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/remove-Azsqlelasticjobtargetgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticJobTargetGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticJobTargetGroup.md +--- + +# Remove-AzSqlElasticJobTargetGroup + +## SYNOPSIS +Removes the target group + +## SYNTAX + +### DefaultSet (Default) +``` +Remove-AzSqlElasticJobTargetGroup [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-Name] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectSet +``` +Remove-AzSqlElasticJobTargetGroup [-InputObject] <AzureSqlElasticJobTargetGroupModel> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Remove-AzSqlElasticJobTargetGroup [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzSqlElasticJobTargetGroup cmdlet removes a target group and it's targets + +## EXAMPLES + +### Example 1 +```powershell +$agent = Get-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent +$agent | Remove-AzSqlElasticJobTargetGroup -Name tg1 +``` + +```output +TargetGroupName Targets +--------------- ------- +tg1 (s1,db1) +``` + +Removes a target group and it's targets + +### Example 2 + +Removes the target group. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Remove-AzSqlElasticJobTargetGroup -AgentName agent -Name tg1 -ResourceGroupName MyResourceGroup -ServerName s1 +``` + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```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 +``` + +### -InputObject +The target group object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobTargetGroupModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The target group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: TargetGroupName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The target group resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobTargetGroupModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobTargetGroupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlElasticPool.md b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticPool.md new file mode 100644 index 0000000000..fc6907fe19 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlElasticPool.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 47E8E8C1-A63D-4243-A004-ABD5CA1A559E +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlelasticpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlElasticPool.md +--- + +# Remove-AzSqlElasticPool + +## SYNOPSIS +Deletes an elastic database pool. + +## SYNTAX + +``` +Remove-AzSqlElasticPool [-ElasticPoolName] <String> [-Force] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlElasticPool** cmdlet deletes an Azure SQL Database elastic pool. + +## EXAMPLES + +### Example 1: Delete an elastic pool +```powershell +Remove-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" +``` + +This command deletes an elastic pool named ElasticPool01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies the name of the elastic pool that this cmdlet deletes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the elastic pool is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlElasticPool](./Get-AzSqlElasticPool.md) + +[Get-AzSqlElasticPoolActivity](./Get-AzSqlElasticPoolActivity.md) + +[Get-AzSqlElasticPoolDatabase](./Get-AzSqlElasticPoolDatabase.md) + +[New-AzSqlElasticPool](./New-AzSqlElasticPool.md) + +[Set-AzSqlElasticPool](./Set-AzSqlElasticPool.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlInstance.md b/azps-10.1.0/Az.Sql/Remove-AzSqlInstance.md new file mode 100644 index 0000000000..165f9d6392 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlInstance.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstance.md +--- + +# Remove-AzSqlInstance + +## SYNOPSIS +Removes an Azure SQL Managed Database Instance. + +## SYNTAX + +### RemoveInstanceFromInputParameters (Default) +``` +Remove-AzSqlInstance [-Name] <String> [-ResourceGroupName] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveInstanceFromAzureSqlManagedInstanceModelInstanceDefinition +``` +Remove-AzSqlInstance [-InputObject] <AzureSqlManagedInstanceModel> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveInstanceFromAzureResourceId +``` +Remove-AzSqlInstance [-ResourceId] <String> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlInstance** cmdlet removes an Azure SQL Managed Instance. + +## EXAMPLES + +### Example 1: Remove instance +```powershell +Remove-AzSqlInstance -Name "managedInstance1" -ResourceGroupName "ResourceGroup01" +``` + +This command removes the instance named managedInstance1. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The AzureSqlManagedInstanceModel object to remove + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: RemoveInstanceFromAzureSqlManagedInstanceModelInstanceDefinition +Aliases: SqlInstance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +SQL instance name. + +```yaml +Type: System.String +Parameter Sets: RemoveInstanceFromInputParameters +Aliases: InstanceName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: RemoveInstanceFromInputParameters +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance object to remove + +```yaml +Type: System.String +Parameter Sets: RemoveInstanceFromAzureResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceActiveDirectoryAdministrator.md b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceActiveDirectoryAdministrator.md new file mode 100644 index 0000000000..bcd6d3ec48 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceActiveDirectoryAdministrator.md @@ -0,0 +1,244 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlinstanceactivedirectoryadministrator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceActiveDirectoryAdministrator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceActiveDirectoryAdministrator.md +--- + +# Remove-AzSqlInstanceActiveDirectoryAdministrator + +## SYNOPSIS +Removes an Azure AD administrator for SQL Managed Instance. + +## SYNTAX + +### UseResourceGroupAndInstanceNameParameterSet (Default) +``` +Remove-AzSqlInstanceActiveDirectoryAdministrator [-Force] [-PassThru] [-ResourceGroupName] <String> + [-InstanceName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UseInputObjectParameterSet +``` +Remove-AzSqlInstanceActiveDirectoryAdministrator [-Force] [-PassThru] + -InputObject <AzureSqlManagedInstanceModel> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UserResourceIdParameterSet +``` +Remove-AzSqlInstanceActiveDirectoryAdministrator [-Force] [-PassThru] [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlInstanceActiveDirectoryAdministrator** cmdlet removes an Azure Active Directory (Azure AD) administrator for AzureSQL Managed Instance in the current subscription. + +## EXAMPLES + +### Example 1: Remove an administrator +```powershell +Remove-AzSqlInstanceActiveDirectoryAdministrator -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstanceName01" -Confirm -PassThru +``` + +```output +Are you sure you want to remove the Azure Sql Instance Active Directory Administrator on managed instance 'ManagedInstanceName01'? +[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y + +ResourceGroupName InstanceName DisplayName ObjectId +----------------- --------------------- ----------- -------- +ResourceGroup01 ManagedInstanceName01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b +``` + +This command removes the Azure AD administrator for the managed instance named ManagedInstanceName01 associated with the resource group ResourceGroup01. + +### Example 2 +```powershell +Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -Name "ManagedInstance1" | Remove-AzSqlInstanceActiveDirectoryAdministrator -Confirm -PassThru +``` + +```output +Are you sure you want to remove the Azure Sql Instance Active Directory Administrator on managed instance 'ManagedInstanceName01'? +[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y + +ResourceGroupName InstanceName DisplayName ObjectId +----------------- --------------------- ----------- -------- +ResourceGroup01 ManagedInstanceName01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b +``` + +This command removes the Azure AD administrator from the managed instance object. + +### Example 3 +```powershell +Get-AzSqlInstance -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance1" | Remove-AzSqlInstanceActiveDirectoryAdministrator -Confirm -PassThru +``` + +```output +Are you sure you want to remove the Azure Sql Instance Active Directory Administrator on managed instance 'ManagedInstanceName01'? +[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y + +ResourceGroupName InstanceName DisplayName ObjectId +----------------- --------------------- ----------- -------- +ResourceGroup01 ManagedInstanceName01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b +``` + +This command removes the Azure AD administrator using managed instance resource identifier. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed instance object to use. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: UseInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndInstanceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Defines whether to return the removed AD administrator + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndInstanceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance to use + +```yaml +Type: System.String +Parameter Sets: UserResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.InstanceActiveDirectoryAdministrator.Model.AzureSqlInstanceActiveDirectoryAdministratorModel + +## NOTES + +## RELATED LINKS + +[Set-AzSqlInstanceActiveDirectoryAdministrator](./Set-AzSqlInstanceActiveDirectoryAdministrator.md) + +[Get-AzSqlInstanceActiveDirectoryAdministrator](./Get-AzSqlInstanceActiveDirectoryAdministrator.md) diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceDatabase.md b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceDatabase.md new file mode 100644 index 0000000000..d3bf1d719b --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceDatabase.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlinstancedatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceDatabase.md +--- + +# Remove-AzSqlInstanceDatabase + +## SYNOPSIS +Removes an Azure SQL Managed Instance database. + +## SYNTAX + +### RemoveInstanceDatabaseFromInputParameters (Default) +``` +Remove-AzSqlInstanceDatabase [-Name] <String> [-InstanceName] <String> [-ResourceGroupName] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition +``` +Remove-AzSqlInstanceDatabase [-InputObject] <AzureSqlManagedDatabaseModel> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveInstanceDatabaseFromAzureResourceId +``` +Remove-AzSqlInstanceDatabase [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlInstanceDatabase** cmdlet removes an Azure SQL Managed Instance database. + +## EXAMPLES + +### Example 1: Remove a database from an instance +```powershell +Remove-AzSqlInstanceDatabase -Name "Database01" -InstanceName "managedInstance1" -ResourceGroupName "ResourceGroup01" +``` + +This command removes the database named Database01 from instance managedInstance1. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Instance Database object to remove + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: RemoveInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition +Aliases: InstanceDatabase + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The instance name. + +```yaml +Type: System.String +Parameter Sets: RemoveInstanceDatabaseFromInputParameters +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Azure SQL Instance Database to remove. + +```yaml +Type: System.String +Parameter Sets: RemoveInstanceDatabaseFromInputParameters +Aliases: InstanceDatabaseName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: RemoveInstanceDatabaseFromInputParameters +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of Instance Database object to remove + +```yaml +Type: System.String +Parameter Sets: RemoveInstanceDatabaseFromAzureResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceDatabaseLongTermRetentionBackup.md b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceDatabaseLongTermRetentionBackup.md new file mode 100644 index 0000000000..84deab0448 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceDatabaseLongTermRetentionBackup.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlinstancedatabaselongtermretentionbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceDatabaseLongTermRetentionBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceDatabaseLongTermRetentionBackup.md +--- + +# Remove-AzSqlInstanceDatabaseLongTermRetentionBackup + +## SYNOPSIS +Deletes a long term retention backup. + +## SYNTAX + +### RemoveBackupDefault (Default) +``` +Remove-AzSqlInstanceDatabaseLongTermRetentionBackup [-Location] <String> [-InstanceName] <String> + [-DatabaseName] <String> [-BackupName] <String> [-ResourceGroupName <String>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveBackupByInputObject +``` +Remove-AzSqlInstanceDatabaseLongTermRetentionBackup + [-InputObject] <AzureSqlManagedDatabaseLongTermRetentionBackupModel> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveBackupByResourceId +``` +Remove-AzSqlInstanceDatabaseLongTermRetentionBackup [-ResourceId] <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlInstanceDatabaseLongTermRetentionBackup** cmdlet deletes the backup specified. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSqlInstanceDatabaseLongTermRetentionBackup -Location southeastasia -ResourceGroupName testResourceGroup -InstanceName testInstance -DatabaseName test -BackupName 15be823c-7e2c-49d8-819f-a3fdcad92215;132268250550000000 +``` + +Deletes the backup with name 15be823c-7e2c-49d8-819f-a3fdcad92215;132268250550000000 + +## PARAMETERS + +### -BackupName +The name of the backup. + +```yaml +Type: System.String +Parameter Sets: RemoveBackupDefault +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Managed Database the backup is from. + +```yaml +Type: System.String +Parameter Sets: RemoveBackupDefault +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Database Long Term Retention Backup object to remove. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabaseBackup.Model.AzureSqlManagedDatabaseLongTermRetentionBackupModel +Parameter Sets: RemoveBackupByInputObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The name of the Managed Instance the backup is under. + +```yaml +Type: System.String +Parameter Sets: RemoveBackupDefault +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the backups' source Managed Instance. + +```yaml +Type: System.String +Parameter Sets: RemoveBackupDefault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: RemoveBackupDefault +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Resource ID of the Database Long Term Retention Backup to remove. + +```yaml +Type: System.String +Parameter Sets: RemoveBackupByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabaseBackup.Model.AzureSqlManagedDatabaseLongTermRetentionBackupModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabaseBackup.Model.AzureSqlManagedDatabaseLongTermRetentionBackupModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlInstanceDatabaseLongTermRetentionBackup](./Get-AzSqlInstanceDatabaseLongTermRetentionBackup.md) + +[Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy](./Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md) + +[Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy](./Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceDatabaseSensitivityClassification.md b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceDatabaseSensitivityClassification.md new file mode 100644 index 0000000000..07a1ce17dc --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceDatabaseSensitivityClassification.md @@ -0,0 +1,271 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlinstancedatabasesensitivityclassification +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceDatabaseSensitivityClassification.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceDatabaseSensitivityClassification.md +--- + +# Remove-AzSqlInstanceDatabaseSensitivityClassification + +## SYNOPSIS +Removes the information types and sensitivity labels of columns in the Azure SQL Managed Instance database. + +## SYNTAX + +### ClassificationObjectParameterSet (Default) +``` +Remove-AzSqlInstanceDatabaseSensitivityClassification + -ClassificationObject <ManagedDatabaseSensitivityClassificationModel> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Remove-AzSqlInstanceDatabaseSensitivityClassification [-ResourceGroupName] <String> [-InstanceName] <String> + [-DatabaseName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DatabaseObjectColumnParameterSet +``` +Remove-AzSqlInstanceDatabaseSensitivityClassification -DatabaseObject <AzureSqlManagedDatabaseModel> + -SchemaName <String> -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzSqlInstanceDatabaseSensitivityClassification cmdlet removes the information types and sensitivity labels of columns in the Azure SQL Managed Instance database. + +## EXAMPLES + +### Example 1: Remove information type and sensitivity label of a column in an Azure SQL Managed Instance database. +```powershell +Remove-AzSqlInstanceDatabaseSensitivityClassification -ResourceGroupName resourceGroup -InstanceName managedInstance -DatabaseName database -SchemaName schema -TableName table -ColumnName column +``` + +### Example 2: Remove current information types and sensitivity labels of columns in an Azure SQL Managed Instance database with Piping. +```powershell +Get-AzSqlInstanceDatabaseSensitivityClassification -ResourceGroupName resourceGroup -InstanceName managedInstance -DatabaseName database | Remove-AzSqlInstanceDatabaseSensitivityClassification +``` + +### Example 3: Remove information type and sensitivity label of a column in an Azure SQL Managed Instance database with Piping. +```powershell +Get-AzSqlInstanceDatabase -ResourceGroupName resourceGroup -InstanceName managedInstance -Name database | Remove-AzSqlInstanceDatabaseSensitivityClassification -SchemaName schema -TableName table -ColumnName column +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationObject +An object representing a SQL Managed Instance Database Sensitivity Classification. + +```yaml +Type: Microsoft.Azure.Commands.Sql.DataClassification.Model.ManagedDatabaseSensitivityClassificationModel +Parameter Sets: ClassificationObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Managed Instance database. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +The Azure SQL Managed Instance database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Azure SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Specifies whether to output the sensitivity classification model at end of cmdlet execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.DataClassification.Model.ManagedDatabaseSensitivityClassificationModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Learn more about Azure SQL Database data discovery and classification](https://learn.microsoft.com/azure/sql-database/sql-database-data-discovery-and-classification) diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceKeyVaultKey.md b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceKeyVaultKey.md new file mode 100644 index 0000000000..6a7c7662b5 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceKeyVaultKey.md @@ -0,0 +1,248 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/Remove-AzSqlInstanceKeyVaultKey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceKeyVaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceKeyVaultKey.md +--- + +# Remove-AzSqlInstanceKeyVaultKey + +## SYNOPSIS +Removes a Key Vault key from a SQL managed instance + +## SYNTAX + +### AddAzureRmSqlManagedInstanceKeyVaultKeyDefaultParameterSet (Default) +``` +Remove-AzSqlInstanceKeyVaultKey [-ResourceGroupName] <String> [-InstanceName] <String> [-KeyId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AddAzureRmSqlManagedInstanceKeyVaultKeyInputObjectParameterSet +``` +Remove-AzSqlInstanceKeyVaultKey [-Instance] <AzureSqlManagedInstanceModel> [-KeyId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AddAzureRmSqlManagedInstanceKeyVaultKeyResourceIdParameterSet +``` +Remove-AzSqlInstanceKeyVaultKey [-InstanceResourceId] <String> [-KeyId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzSqlInstanceKeyVaultKey cmdlet removes the Key Vault key from the specified Managed Instance. Note that the SQL managed instance's permissions to the key's vault are not changed. To change permissions, use Set-AzKeyVaultAccessPolicy. Note that this cmdlet makes no changes to Key Vault. To remove a key from Key Vault, use Remove-AzureKeyVaultKey. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSqlInstanceKeyVaultKey -ResourceGroupName 'ContosoResourceGroup' -InstanceName 'ContosoManagedInstanceName' -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901 +CreationDate : 9/1/2018 12:11:49 AM +Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1 +Type : AzureKeyVault +``` + +This command removes the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' from the specified managed instance. + +### Example 2: Using managed instance object +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +Remove-AzSqlInstanceKeyVaultKey -Instance $managedInstance -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901 +CreationDate : 9/1/2018 12:11:49 AM +Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1 +Type : AzureKeyVault +``` + +This command removes the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' from the specified managed instance. + +### Example 3: Using managed instance resource id +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +Remove-AzSqlInstanceKeyVaultKey -InstanceResourceId $managedInstance.ResourceId -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901 +CreationDate : 9/1/2018 12:11:49 AM +Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1 +Type : AzureKeyVault +``` + +This command removes the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' from the specified managed instance. + +### Example 4: Using piping +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +$managedInstance | Remove-AzSqlInstanceKeyVaultKey -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901 +CreationDate : 9/1/2018 12:11:49 AM +Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1 +Type : AzureKeyVault +``` + +This command removes the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' from the specified managed instance. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +The instance input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: AddAzureRmSqlManagedInstanceKeyVaultKeyInputObjectParameterSet +Aliases: InputObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The instance name + +```yaml +Type: System.String +Parameter Sets: AddAzureRmSqlManagedInstanceKeyVaultKeyDefaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceResourceId +The instance resource id + +```yaml +Type: System.String +Parameter Sets: AddAzureRmSqlManagedInstanceKeyVaultKeyResourceIdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyId +AzureKeyVault key id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: AddAzureRmSqlManagedInstanceKeyVaultKeyDefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureRmSqlManagedInstanceKeyVaultKeyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceLink.md b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceLink.md new file mode 100644 index 0000000000..8d215e419c --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceLink.md @@ -0,0 +1,339 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlinstancelink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceLink.md +--- + +# Remove-AzSqlInstanceLink + +## SYNOPSIS +Removes an instance link. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzSqlInstanceLink [-ResourceGroupName] <String> [-InstanceName] <String> [-Name] <String> [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByParentObjectParameterSet +``` +Remove-AzSqlInstanceLink [-Name] <String> [-InstanceObject] <AzureSqlManagedInstanceModel> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzSqlInstanceLink [-InputObject] <AzureSqlManagedInstanceLinkModel> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzSqlInstanceLink [-ResourceId] <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +**Remove-AzSqlInstanceLink** cmdlet drops an instance link. This command may cause data loss if the link is dropped and replica's LSNs are not synchronized with the primary, thus user must explicitly confirm the command when prompted, or use -Force parameter. + +## EXAMPLES + +### Example 1: Remove instance link +```powershell +Remove-AzSqlInstanceLink -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "Link01" +``` + +```output +This operation may cause data loss if replica's last hardened LSN is not in sync with the primary. Are you sure you want to proceed? +[Y] Yes [N] No [?] Help (default is "Y"): Y +``` + +This command removes the instance link "Link01" from the managed instance "ManagedInstance01". + +### Example 2: Remove instance link with an explicit -Force flag +```powershell +Remove-AzSqlInstanceLink -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "Link01" -Force +``` + +This command forcefully removes the instance link "Link01" from the managed instance "ManagedInstance01", ignoring the data loss warning. + +### Example 3: Remove instance link by its resource identifier +```powershell +Remove-AzSqlInstanceLink -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01" +``` + +```output +This operation may cause data loss if replica's last hardened LSN is not in sync with the primary. Are you sure you want to proceed? +[Y] Yes [N] No [?] Help (default is "Y"): Y +``` + +This command removes the instance link with specified resource ID. + +### Example 4: Remove instance link by its PowerShell object +```powershell +$managedInstanceLink = Get-AzSqlInstanceLink -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "Link01" +Remove-AzSqlInstanceLink -InputObject $managedInstanceLink +``` + +```output +This operation may cause data loss if replica's last hardened LSN is not in sync with the primary. Are you sure you want to proceed? +[Y] Yes [N] No [?] Help (default is "Y"): Y +``` + +This command removes the instance link specified by instance link object. + +### Example 5: Remove instance link by its parent instance object +```powershell +$instance = Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -Name "ManagedInstance01" +Remove-AzSqlInstanceLink -InstanceObject $instance -Name "Link01" +``` + +```output +This operation may cause data loss if replica's last hardened LSN is not in sync with the primary. Are you sure you want to proceed? +[Y] Yes [N] No [?] Help (default is "Y"): Y +``` + +This command removes the instance link "Link01" from the managed instance specified by the instance object. + +### Example 6: Remove instance link using positional parameters +```powershell +Remove-AzSqlInstanceLink "ResourceGroup01" "ManagedInstance01" "Link01" +``` + +```output +This operation may cause data loss if replica's last hardened LSN is not in sync with the primary. Are you sure you want to proceed? +[Y] Yes [N] No [?] Help (default is "Y"): Y +``` + +This command removes the instance link "Link01" from the managed instance "ManagedInstance01" using positional parameters. + +### Example 7: Remove all instance links from its parent instance by piping link objects +```powershell +$instance = Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -Name "ManagedInstance01" +$instance | Get-AzSqlInstanceLink | Remove-AzSqlInstanceLink -Force +``` + +This command removes all instance links from the managed instance "ManagedInstance01". + +### Example 8: Remove instance link with an explicit -Force flag and output the deleted instance link object +```powershell +Remove-AzSqlInstanceLink -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "Link01" -Force -PassThru +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command removes an instance link from the managed instance "ManagedInstance01" and outputs the deleted instance link object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: AllowDataLoss + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Instance link input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstanceHybridLink.Model.AzureSqlManagedInstanceLinkModel +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +Name of Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +Instance input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: DeleteByParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the instance link. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet, DeleteByParentObjectParameterSet +Aliases: LinkName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Defines whether to return the removed instance link. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The instance link resource ID. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### Microsoft.Azure.Commands.Sql.ManagedInstanceHybridLink.Model.AzureSqlManagedInstanceLinkModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstanceHybridLink.Model.AzureSqlManagedInstanceLinkModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlInstanceLink](./Get-AzSqlInstanceLink.md) + +[New-AzSqlInstanceLink](./New-AzSqlInstanceLink.md) + +[Update-AzSqlInstanceLink](./Update-AzSqlInstanceLink.md) diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlInstancePool.md b/azps-10.1.0/Az.Sql/Remove-AzSqlInstancePool.md new file mode 100644 index 0000000000..5a84e349e1 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlInstancePool.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlinstancepool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstancePool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstancePool.md +--- + +# Remove-AzSqlInstancePool + +## SYNOPSIS +Removes an Azure SQL Instance pool. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzSqlInstancePool [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzSqlInstancePool [-InputObject] <AzureSqlInstancePoolModel> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzSqlInstancePool [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlInstancePool** cmdlet removes an Azure SQL Instance pool. + +## EXAMPLES + +### Example 1: Remove an instance pool +```powershell +Remove-AzSqlInstancePool -ResourceGroupName resourcegroup01 -Name instancePool0 +``` + +### Example 2: Remove an instance pool by its resource identifier +```powershell +Remove-AzSqlInstancePool -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0" +``` + +### Example 3: Remove an instance pool by an instance pool object +```powershell +Get-AzSqlInstancePool -ResourceGroupName resourcegroup01 -Name instancePool0 +Remove-AzSqlInstancePool -InputObject $instancePool +``` + +This command removes an instance pool named instancePool0. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The instance pool object to remove. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Instance_Pools.Model.AzureSqlInstancePoolModel +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the instance pool. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: InstancePoolName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The instance pool resource id to remove. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Instance_Pools.Model.AzureSqlInstancePoolModel + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceServerTrustCertificate.md b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceServerTrustCertificate.md new file mode 100644 index 0000000000..e34f297875 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlInstanceServerTrustCertificate.md @@ -0,0 +1,298 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlinstanceservertrustcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceServerTrustCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlInstanceServerTrustCertificate.md +--- + +# Remove-AzSqlInstanceServerTrustCertificate + +## SYNOPSIS +Removes a server trust certificate. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzSqlInstanceServerTrustCertificate [-ResourceGroupName] <String> [-InstanceName] <String> + [-Name] <String> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteByParentObjectParameterSet +``` +Remove-AzSqlInstanceServerTrustCertificate [-Name] <String> [-InstanceObject] <AzureSqlManagedInstanceModel> + [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzSqlInstanceServerTrustCertificate [-InputObject] <AzureSqlInstanceServerTrustCertificateModel> + [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzSqlInstanceServerTrustCertificate [-ResourceId] <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +**Remove-AzSqlInstanceServerTrustCertificate** cmdlet removes a server trust certificate from Azure SQL Managed Instanc + +## EXAMPLES + +### Example 1: Remove a server trust certificate +```powershell +Remove-AzSqlInstanceServerTrustCertificate -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "Certificate01" +``` + +This command removes the server trust certificate "Certificate01" from managed instance "ManagedInstance01" and resource group "ResourceGroup1" + +### Example 2: Remove a server trust certificate by its resource identifier +```powershell +Remove-AzSqlInstanceServerTrustCertificate -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01" +``` + +This command removes the server trust certificate with specified resource ID. + +### Example 3: Remove a server trust certificate by its PowerShell object +```powershell +$serverTrustCertificate = Get-AzSqlInstanceServerTrustCertificate -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "Certificate01" +Remove-AzSqlInstanceServerTrustCertificate -InputObject $serverTrustCertificate +``` + +This command removes the server trust certificate specified by certificate object. + +### Example 4: Remove a server trust certificate by its parent instance object +```powershell +$instance = Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -Name "ManagedInstance01" +Remove-AzSqlInstanceServerTrustCertificate -InstanceObject $instance -Name "Certificate01" +``` + +This command removes the server trust certificate "Certificate01" from the managed instance specified by the instance object. + +### Example 5: Remove a server trust certificate using positional parameters +```powershell +Remove-AzSqlInstanceServerTrustCertificate "ResourceGroup01" "ManagedInstance01" "Certificate01" +``` + +This command removes the server trust certificate "Certificate01" from the managed instance "ManagedInstance01" using positional parameters. + +### Example 6: Remove all server trust certificate from its parent instance +```powershell +$instance = Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -Name "ManagedInstance01" +$instance | Get-AzSqlInstanceServerTrustCertificate | Remove-AzSqlInstanceServerTrustCertificate +``` + +This command removes all server trust certificates from instance "ManagedInstance01". + +### Example 7: Remove a server trust certificate and outputs the deleted certificate object +```powershell +Remove-AzSqlInstanceServerTrustCertificate "ResourceGroup01" "ManagedInstance01" "Certificate01" -PassThru +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverTrustCertificates/Certificate01 +Type : Microsoft.Sql/managedInstances/serverTrustCertificates +Name : Certificate01 +Thumbprint : 0x7D989DF34BD0FD0D2F9F6B3B6A7096856F5AB004 +PublicKey : 0x1C8E3F85BCD8A2C1D082CE42D7A1E8112651A906B15F5F244134142C53B050FCBF2571965C522EBB86B4F1B790F3AD31E689950EE909B87C25A1BB51DA328BEEB1BB0FD44AB3CB774B8CC9F72B486476DEB8B1C95210B84C4A0F18310CD83F299CAF0D567EBCE2DD008581622D72499F8EC9A686BA526916E7F78DCA90BA0ADD8C2E5F601017D374E2FBD0818458BFC11C8268BC21383613323153163C0F33E09D03586A3BBFDA3628F0358FBADE41602BD05C4E47CDB67A9914F35B315B7844C2F2D1352034B56D6B155D38415B816247779E7A0EB3431765D9A48F4649E647CCD2EA8F38E8B5D415833BA8337BA00FED2F00D9066B9CAEF7BAA8C553F7B8787BCEF63AC98E05372981520BD5A598356590736B547F3B300F1D710EC3003D398AEB94589E196C42C5F6A1873D6138D9F666A2D6F24DAFB12FBD6B0124B2CFFAD51EF67032832900A9E113625BE4C4FB012923BB9886B52B733A5F8BFF04122A2474828F2EE5FC66154D9EBA92A21F0BFD6E8AAEE7DCC45BB3883A410E603C9D98A5BB913853D1B7543E694FF74F8CA9174BE152A96530803DD03C15BC258E77925877BCAF748CA85230ABBF90789F4856200166D110D369FB03B6593339CCE498CDA69016289056F4638E761B9904129DB36B6B4CD17D49567C27FF11059C0569ABF48C438CB6128F2B2F245BDB066B6BF1155BCA11E9D6B0BD8A1607F2F5BB42AF7498D1B8410AA1E5E3E23A3CA6FB933D3894C8D1A2162E735CFCB7BEDFB3318DAE32AE9E24900B9B0F472ABD563550C9E696836889123F0ED2E7A9A4B90C2C617C8ADCF088CE2A7EC8AB97A80C00F3296241C7B320118A1182E327919007930417004A301249EAACF139D611D9C30DAFDF8672F5347C488250F46D45E7D7E9BF3BE99ECD1C60A046FC80EB1DC473FD2E1A7672235F8A834338A4810E32CB24C9C24D09234995A3D038D70379B900E6C9217EF19062775B050CF7CA52D3D72E294E2315AA544247B436D46AD08D55957B9688C576E35760B527B7F7EB71E6209301C59B6643C921F2FB182D237E81DC6205BF6740C8EDC48C65DAB0546C1098C2DCBF0E3B31A47868A721942022E0B5DBFFFBBC4767699C7F0ABD6DEBE7D5FB91 +``` + +This command removes all instance links from the managed instance "ManagedInstance01" and outputs the deleted instance link object. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Certificate input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ServerTrustCertificate.Model.AzureSqlInstanceServerTrustCertificateModel +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +Name of Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +Instance input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: DeleteByParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the certificate. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet, DeleteByParentObjectParameterSet +Aliases: CertificateName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Defines whether to return the removed Server Trust Certificate + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Certificate resource ID. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### Microsoft.Azure.Commands.Sql.ServerTrustCertificate.Model.AzureSqlInstanceServerTrustCertificateModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerTrustCertificate.Model.AzureSqlInstanceServerTrustCertificateModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlInstanceServerTrustCertificate](./Get-AzSqlInstanceServerTrustCertificate.md) + +[New-AzSqlInstanceServerTrustCertificate](./New-AzSqlInstanceServerTrustCertificate.md) diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlServer.md b/azps-10.1.0/Az.Sql/Remove-AzSqlServer.md new file mode 100644 index 0000000000..adb8fc8499 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlServer.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 068D70EF-39D1-4199-BD74-0EC266DF7072 +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServer.md +--- + +# Remove-AzSqlServer + +## SYNOPSIS +Removes an Azure SQL Database server. + +## SYNTAX + +``` +Remove-AzSqlServer [-ServerName] <String> [-Force] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlServer** cmdlet removes an Azure SQL Database server. +The delete operation is asynchronous and may take some time, so verify the operation is finished before performing any additional operations that depend on the server being completely deleted. +For instance, you need to create a new server that uses the same name. + +## EXAMPLES + +### Example 1: Remove a server +```powershell +Remove-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +This command removes the Azure SQL Database server named Server01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServer](./Get-AzSqlServer.md) + +[New-AzSqlServer](./New-AzSqlServer.md) + +[Set-AzSqlServer](./Set-AzSqlServer.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlServerActiveDirectoryAdministrator.md b/azps-10.1.0/Az.Sql/Remove-AzSqlServerActiveDirectoryAdministrator.md new file mode 100644 index 0000000000..7be7c98d39 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlServerActiveDirectoryAdministrator.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: B2E6E66A-1A09-4DB0-8BB4-D2E5EC34C9EB +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlserveractivedirectoryadministrator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerActiveDirectoryAdministrator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerActiveDirectoryAdministrator.md +--- + +# Remove-AzSqlServerActiveDirectoryAdministrator + +## SYNOPSIS +Removes an Azure AD administrator for SQL Server. + +## SYNTAX + +``` +Remove-AzSqlServerActiveDirectoryAdministrator [-Force] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlServerActiveDirectoryAdministrator** cmdlet removes an Azure Active Directory (Azure AD) administrator for AzureSQL Server in the current subscription. + +## EXAMPLES + +### Example 1: Remove an administrator +```powershell +Remove-AzSqlServerActiveDirectoryAdministrator -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +```output +Confirm +Are you sure you want to remove the Azure Sql Server Active Directory Administrator on server 'Server01'? +[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y + +ResourceGroupName ServerName DisplayName ObjectId +----------------- ---------- ----------- -------- +ResourceGroup01 Server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b +``` + +This command removes the Azure AD administrator for the server named Server01 associated with the resource group ResourceGroup01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the SQL Server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL Server for which this cmdlet removes an administrator. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServerActiveDirectoryAdministrator](./Get-AzSqlServerActiveDirectoryAdministrator.md) + +[Set-AzSqlServerActiveDirectoryAdministrator](./Set-AzSqlServerActiveDirectoryAdministrator.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlServerAudit.md b/azps-10.1.0/Az.Sql/Remove-AzSqlServerAudit.md new file mode 100644 index 0000000000..d967cf823c --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlServerAudit.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/Remove-AzSqlServerAudit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerAudit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerAudit.md +--- + +# Remove-AzSqlServerAudit + +## SYNOPSIS +Removes the auditing settings of an Azure SQL server. + +## SYNTAX + +### ServerParameterSet (Default) +``` +Remove-AzSqlServerAudit [-ResourceGroupName] <String> [-ServerName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ServerObjectParameterSet +``` +Remove-AzSqlServerAudit -ServerObject <AzureSqlServerModel> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlServerAudit** cmdlet removes the auditing settings of an Azure SQL server. +Specify the *ResourceGroupName* and *ServerName* parameters to identify the server. + +## EXAMPLES + +### Example 1: Remove the auditing settings of an Azure SQL server +```powershell +Remove-AzSqlServerAudit -ResourceGroupName "resourcegroup01" -ServerName "server01" +``` + +### Example 2: Remove, through pipeline, the auditing settings of an Azure SQL server +```powershell +Get-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" | Remove-AzSqlServerAudit +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ServerParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: ServerParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerObject +The server object to manage its audit policy. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: ServerObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlServerCommunicationLink.md b/azps-10.1.0/Az.Sql/Remove-AzSqlServerCommunicationLink.md new file mode 100644 index 0000000000..671ae88b89 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlServerCommunicationLink.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 48D6288A-EBE1-44FD-B871-80A0681BBEA3 +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlservercommunicationlink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerCommunicationLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerCommunicationLink.md +--- + +# Remove-AzSqlServerCommunicationLink + +## SYNOPSIS +Deletes a communication link for elastic database transactions between two servers. + +## SYNTAX + +``` +Remove-AzSqlServerCommunicationLink [-LinkName] <String> [-Force] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlServerCommunicationLink** cmdlet deletes a server-to-server communication link for elastic database transactions in Azure SQL Database. + +## EXAMPLES + +### Example 1: Delete a communication link +```powershell +Remove-AzSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17" -LinkName "Link01" +``` + +This command deletes a server-to-server communication link named Link01 on ContosoServer17. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkName +Specifies the name of the server communication link that this cmdlet deletes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server specified by the *ServerName* parameter belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of a server. +This server contains the communication link that this cmdlet deletes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerCommunicationLink.Model.AzureSqlServerCommunicationLinkModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + +## RELATED LINKS + +[Get-AzSqlServerCommunicationLink](./Get-AzSqlServerCommunicationLink.md) + +[New-AzSqlServerCommunicationLink](./New-AzSqlServerCommunicationLink.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlServerDisasterRecoveryConfiguration.md b/azps-10.1.0/Az.Sql/Remove-AzSqlServerDisasterRecoveryConfiguration.md new file mode 100644 index 0000000000..a5607d288f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlServerDisasterRecoveryConfiguration.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 2A74E72B-BD6B-45D7-9C19-B2575C60C43F +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlserverdisasterrecoveryconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerDisasterRecoveryConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerDisasterRecoveryConfiguration.md +--- + +# Remove-AzSqlServerDisasterRecoveryConfiguration + +## SYNOPSIS +Removes a SQL database server system recovery configuration. + +## SYNTAX + +``` +Remove-AzSqlServerDisasterRecoveryConfiguration [-VirtualEndpointName] <String> [-Force] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlServerDisasterRecoveryConfiguration** cmdlet removes a SQL database server system recovery configuration. + +## EXAMPLES + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of a SQL database server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualEndpointName +Specifies the name of a virtual end point. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerDisasterRecoveryConfiguration.Model.AzureSqlServerDisasterRecoveryConfigurationModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServerDisasterRecoveryConfiguration](./Get-AzSqlServerDisasterRecoveryConfiguration.md) + +[New-AzSqlServerDisasterRecoveryConfiguration](./New-AzSqlServerDisasterRecoveryConfiguration.md) + +[Set-AzSqlServerDisasterRecoveryConfiguration](./Set-AzSqlServerDisasterRecoveryConfiguration.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlServerDnsAlias.md b/azps-10.1.0/Az.Sql/Remove-AzSqlServerDnsAlias.md new file mode 100644 index 0000000000..8679afba90 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlServerDnsAlias.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlserverdnsalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerDnsAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerDnsAlias.md +--- + +# Remove-AzSqlServerDnsAlias + +## SYNOPSIS +Removes Azure SQL Server DNS Alias. + +## SYNTAX + +### Remove a Server Dns Alias from cmdlet input parameters +``` +Remove-AzSqlServerDnsAlias -Name <String> -ServerName <String> [-ResourceGroupName] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Remove a Server Dns Alias from AzureSqlServerDnsAliasModel instance definition +``` +Remove-AzSqlServerDnsAlias -InputObject <AzureSqlServerDnsAliasModel> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Remove a Server Dns Alias from an Azure resource id +``` +Remove-AzSqlServerDnsAlias -ResourceId <String> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This commands remove Azure SQL Server DNS Alias from the server leaving server intact. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSqlServerDnsAlias -DnsAliasName aliasName -ServerName serverName -ResourceGroupName rg +``` + +Removes Azure SQL Server DNS Alias with the name aliasName from the server with the name serverName + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Server Dns Alias object to remove + +```yaml +Type: Microsoft.Azure.Commands.Sql.ServerDnsAlias.Model.AzureSqlServerDnsAliasModel +Parameter Sets: Remove a Server Dns Alias from AzureSqlServerDnsAliasModel instance definition +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Azure Sql Server Dns Alias name + +```yaml +Type: System.String +Parameter Sets: Remove a Server Dns Alias from cmdlet input parameters +Aliases: DnsAliasName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: Remove a Server Dns Alias from cmdlet input parameters +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of Server Dns Alias object to remove + +```yaml +Type: System.String +Parameter Sets: Remove a Server Dns Alias from an Azure resource id +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: System.String +Parameter Sets: Remove a Server Dns Alias from cmdlet input parameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ServerDnsAlias.Model.AzureSqlServerDnsAliasModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerDnsAlias.Model.AzureSqlServerDnsAliasModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlServerFirewallRule.md b/azps-10.1.0/Az.Sql/Remove-AzSqlServerFirewallRule.md new file mode 100644 index 0000000000..f6777e3658 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlServerFirewallRule.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 251A4546-AC23-4880-B197-773B1B814607 +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlserverfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerFirewallRule.md +--- + +# Remove-AzSqlServerFirewallRule + +## SYNOPSIS +Deletes a firewall rule from a SQL Database server. + +## SYNTAX + +``` +Remove-AzSqlServerFirewallRule [-FirewallRuleName] <String> [-Force] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlServerFirewallRule** cmdlet deletes a firewall rule from the specified Azure SQL Database server. + +## EXAMPLES + +### Example 1: Delete a rule +```powershell +Remove-AzSqlServerFirewallRule -FirewallRuleName "Rule01" -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +This command deletes a firewall rule named Rule01 on the server named Server01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleName +Specifies the name of the firewall rule that this cmdlet deletes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServerFirewallRule](./Get-AzSqlServerFirewallRule.md) + +[New-AzSqlServerFirewallRule](./New-AzSqlServerFirewallRule.md) + +[Set-AzSqlServerFirewallRule](./Set-AzSqlServerFirewallRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlServerIpv6FirewallRule.md b/azps-10.1.0/Az.Sql/Remove-AzSqlServerIpv6FirewallRule.md new file mode 100644 index 0000000000..54d482aeb0 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlServerIpv6FirewallRule.md @@ -0,0 +1,166 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlserveripv6firewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerIpv6FirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerIpv6FirewallRule.md +--- + +# Remove-AzSqlServerIpv6FirewallRule + +## SYNOPSIS +Deletes an IPv6 firewall rule from a SQL Database server. + +## SYNTAX + +``` +Remove-AzSqlServerIpv6FirewallRule [-Ipv6FirewallRuleName] <String> [-Force] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlServerIpv6FirewallRule** cmdlet deletes an IPv6 firewall rule from the specified Azure SQL Database server. + +## EXAMPLES + +### Example 1: Delete an IPv6 rule +```powershell +Remove-AzSqlServerIpv6FirewallRule -Ipv6FirewallRuleName "Rule01" -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +This command deletes an IPv6 firewall rule named Rule01 on the server named Server01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ipv6FirewallRuleName +Specifies the name of the IPv6 firewall rule that this cmdlet deletes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServerIpv6FirewallRule](./Get-AzSqlServerIpv6FirewallRule.md) + +[New-AzSqlServerIpv6FirewallRule](./New-AzSqlServerIpv6FirewallRule.md) + +[Set-AzSqlServerIpv6FirewallRule](./Set-AzSqlServerIpv6FirewallRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlServerKeyVaultKey.md b/azps-10.1.0/Az.Sql/Remove-AzSqlServerKeyVaultKey.md new file mode 100644 index 0000000000..177050b08e --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlServerKeyVaultKey.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlserverkeyvaultkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerKeyVaultKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerKeyVaultKey.md +--- + +# Remove-AzSqlServerKeyVaultKey + +## SYNOPSIS +Removes a Key Vault key from a SQL server. + +## SYNTAX + +``` +Remove-AzSqlServerKeyVaultKey [-KeyId] <String> [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzSqlServerKeyVaultKey cmdlet removes the Key Vault key from the specified SQL server. +Note that the SQL server's permissions to the key's vault are not changed. +To change permissions, use Set-AzKeyVaultAccessPolicy. +Note that this cmdlet makes no changes to Key Vault. +To remove a key from Key Vault, use Remove-AzKeyVaultKey. + +## EXAMPLES + +### Example 1: Remove a Key Vault key +```powershell +Remove-AzSqlServerKeyVaultKey -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ServerName : ContosoServer +ServerKeyName : contoso_contosokey_01234567890123456789012345678901 +Type : AzureKeyVault +Uri : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +Thumbprint : 1122334455667788990011223344556677889900 +CreationDate : 1/1/2017 12:00:00 AM +``` + +This command removes the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' from the specified server. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyId +The Azure Key Vault KeyId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerKeyVaultKey.Model.AzureSqlServerKeyVaultKeyModel + +## NOTES + +## RELATED LINKS + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlServerMSSupportAudit.md b/azps-10.1.0/Az.Sql/Remove-AzSqlServerMSSupportAudit.md new file mode 100644 index 0000000000..71fafd4eb7 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlServerMSSupportAudit.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/Remove-AzSqlServerMSSupportAudit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerMSSupportAudit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerMSSupportAudit.md +--- + +# Remove-AzSqlServerMSSupportAudit + +## SYNOPSIS +Removes the Microsoft support operations auditing settings of an Azure SQL server. + +## SYNTAX + +### ServerParameterSet (Default) +``` +Remove-AzSqlServerMSSupportAudit [-ResourceGroupName] <String> [-ServerName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ServerObjectParameterSet +``` +Remove-AzSqlServerMSSupportAudit -ServerObject <AzureSqlServerModel> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlServerMSSupportAudit** cmdlet removes the Microsoft support operations auditing settings of an Azure SQL server. +To use the cmdlet, use the *ResourceGroupName* and *ServerName* parameters to identify the server. + +## EXAMPLES + +### Example 1: Remove the Microsoft support operations auditing settings of an Azure SQL server +```powershell +Remove-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" +``` + +### Example 2: Remove, through pipeline, the Microsoft support auditing settings of an Azure SQL server +```powershell +Get-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" | Remove-AzSqlServerMSSupportAudit +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ServerParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: ServerParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerObject +The server object to manage its audit policy. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: ServerObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlServerOutboundFirewallRule.md b/azps-10.1.0/Az.Sql/Remove-AzSqlServerOutboundFirewallRule.md new file mode 100644 index 0000000000..6775d93bf1 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlServerOutboundFirewallRule.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlserveroutboundfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerOutboundFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerOutboundFirewallRule.md +--- + +# Remove-AzSqlServerOutboundFirewallRule + +## SYNOPSIS +Deletes an allowed FQDN from the list of outbound firewall rules (Allowed FQDNs) from a SQL Database server. + +## SYNTAX + +``` +Remove-AzSqlServerOutboundFirewallRule [-AllowedFQDN] <String> [-Force] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlServerOutboundFirewallRule** cmdlet deletes the specified allowed FQDN from the list of outbound firewall rules (Allowed FQDNs) from the specified Azure SQL Database server. + +## EXAMPLES + +### Example 1: Delete a outbound firewall rule +```powershell +Remove-AzSqlServerOutboundFirewallRule -ServerName "Server01" -ResourceGroupName "ResourceGroup01" -AllowedFQDN "OutboundFirewallRule01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +AllowedFQDN : OutboundFirewallRule01 +``` + +This command deletes an allowed FQDN named OutboundFirewallRule01 from the list of outbound firewall rules on the server named Server01. + +## PARAMETERS + +### -AllowedFQDN +Specifies the allowed fully qualified domain name (FQDN) in the list of outbound firewall rules. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.OutboundFirewallRules.Model.AzureSqlServerOutboundFirewallRulesModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServerOutboundFirewallRule](./Get-AzSqlServerOutboundFirewallRule.md) + +[New-AzSqlServerOutboundFirewallRule](./New-AzSqlServerOutboundFirewallRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlServerTrustGroup.md b/azps-10.1.0/Az.Sql/Remove-AzSqlServerTrustGroup.md new file mode 100644 index 0000000000..947bbb556b --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlServerTrustGroup.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlservertrustgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerTrustGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerTrustGroup.md +--- + +# Remove-AzSqlServerTrustGroup + +## SYNOPSIS +Deletes a Server Trust Group. + +## SYNTAX + +``` +Remove-AzSqlServerTrustGroup [-ResourceGroupName] <String> [-Location] <String> [-Name] <String> [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Server Trust Group with specified name, location and resource group. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSqlServerTrustGroup -ResourceGroupName "ResourceGroup01" -Location "West Europe" -Name "ServerTrustGroup01" +``` + +Deletes a Server Trust Group in location West Europe with name ServerTrustGroup01 in resource group ResourceGroup01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the Server Trust Group to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of Server Trust Group to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Defines whether to return the removed Server Trust Group + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerTrustGroup.Model.AzureSqlServerTrustGroupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlServerVirtualNetworkRule.md b/azps-10.1.0/Az.Sql/Remove-AzSqlServerVirtualNetworkRule.md new file mode 100644 index 0000000000..c1db5b43ec --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlServerVirtualNetworkRule.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlservervirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlServerVirtualNetworkRule.md +--- + +# Remove-AzSqlServerVirtualNetworkRule + +## SYNOPSIS +Deletes an Azure SQL Server Virtual Network Rule. + +## SYNTAX + +``` +Remove-AzSqlServerVirtualNetworkRule -VirtualNetworkRuleName <String> [-AsJob] -ServerName <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This command deletes an Azure SQL Server Virtual Network Rule. + +## EXAMPLES + +### Example 1 +```powershell +$virtualNetworkRule = Remove-AzSqlServerVirtualNetworkRule -ResourceGroupName rg -ServerName serverName -VirtualNetworkRuleName virtualNetworkRuleName +``` + +Deletes an existing Azure SQL Server virtual network rule + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRuleName +Azure Sql Server Virtual Network Rule name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VirtualNetworkRule.Model.AzureSqlServerVirtualNetworkRuleModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlSyncAgent.md b/azps-10.1.0/Az.Sql/Remove-AzSqlSyncAgent.md new file mode 100644 index 0000000000..f3fbc6b459 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlSyncAgent.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlsyncagent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlSyncAgent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlSyncAgent.md +--- + +# Remove-AzSqlSyncAgent + +## SYNOPSIS +Removes an Azure SQL Sync Agent. + +## SYNTAX + +``` +Remove-AzSqlSyncAgent [-Name] <String> [-Force] [-PassThru] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlSyncAgent** cmdlet removes an Azure SQL Sync Agent. + +## EXAMPLES + +### Example 1: Remove a sync agent +```powershell +Remove-AzSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Name "syncAgent01" +``` + +This command removes the Azure SQL Sync Agent named syncAgent01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The sync agent name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SyncAgentName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Defines Whether return the removed sync agent + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the sync agent is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncAgentModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlSyncAgent](./New-AzSqlSyncAgent.md) + +[Get-AzSqlSyncAgent](./Get-AzSqlSyncAgent.md) + diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlSyncGroup.md b/azps-10.1.0/Az.Sql/Remove-AzSqlSyncGroup.md new file mode 100644 index 0000000000..1c48c03bdf --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlSyncGroup.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlsyncgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlSyncGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlSyncGroup.md +--- + +# Remove-AzSqlSyncGroup + +## SYNOPSIS +Removes an Azure SQL Database Sync Group. + +## SYNTAX + +``` +Remove-AzSqlSyncGroup [-Name] <String> [-Force] [-PassThru] [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlSyncGroup** cmdlet removes an Azure SQL Database Sync Group. + +## EXAMPLES + +### Example 1: Remove a sync group +```powershell +Remove-AzSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -Name "syncGroup01" +``` + +This command removes the Azure SQL Database Sync Group named syncGroup01. + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The sync group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SyncGroupName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Defines Whether return the removed sync group + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlSyncGroup](./New-AzSqlSyncGroup.md) + +[Update-AzSqlSyncGroup](./Update-AzSqlSyncGroup.md) + +[Get-AzSqlSyncGroup](./Get-AzSqlSyncGroup.md) + diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlSyncMember.md b/azps-10.1.0/Az.Sql/Remove-AzSqlSyncMember.md new file mode 100644 index 0000000000..b62f4c91d1 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlSyncMember.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlsyncmember +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlSyncMember.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlSyncMember.md +--- + +# Remove-AzSqlSyncMember + +## SYNOPSIS +Removes an Azure SQL Database Sync Member. + +## SYNTAX + +``` +Remove-AzSqlSyncMember -Name <String> [-Force] [-PassThru] [-SyncGroupName] <String> [-ServerName] <String> + [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlSyncMember** cmdlet removes an Azure SQL Database Sync Member. + +## EXAMPLES + +### Example 1: Remove a sync member +```powershell +Remove-AzSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" -Name "syncMember01" +``` + +This command removes the Azure SQL Database Sync Member named syncMember01. + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The sync member name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SyncMemberName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Defines Whether return the removed sync member + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncGroupName +The sync group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncMemberModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlSyncMember](./New-AzSqlSyncMember.md) + +[Update-AzSqlSyncMember](./Update-AzSqlSyncMember.md) + +[Get-AzSqlSyncMember](./Get-AzSqlSyncMember.md) + diff --git a/azps-10.1.0/Az.Sql/Remove-AzSqlVirtualCluster.md b/azps-10.1.0/Az.Sql/Remove-AzSqlVirtualCluster.md new file mode 100644 index 0000000000..18786439b4 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Remove-AzSqlVirtualCluster.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/remove-azsqlvirtualcluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlVirtualCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Remove-AzSqlVirtualCluster.md +--- + +# Remove-AzSqlVirtualCluster + +## SYNOPSIS +Removes an Azure SQL Virtual Cluster. + +## SYNTAX + +### RemoveVirtualClusterFromInputParameters (Default) +``` +Remove-AzSqlVirtualCluster [-Name] <String> [-ResourceGroupName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveVirtualClusterFromAzureSqlVirtualClusterModelDefinition +``` +Remove-AzSqlVirtualCluster [-InputObject] <AzureSqlVirtualClusterModel> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveVirtualClusterFromAzureResourceId +``` +Remove-AzSqlVirtualCluster -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSqlVirtualCluster** cmdlet removes an Azure SQL Virtual Cluster. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSqlVirtualCluster -Name VirtualCluster1 -ResourceGroupName ResourceGroup01 +``` + +This command removes the virtual cluster named VirtualCluster1 assigned to the resource group ResourceGroup01. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The instance object to remove + +```yaml +Type: Microsoft.Azure.Commands.Sql.VirtualCluster.Model.AzureSqlVirtualClusterModel +Parameter Sets: RemoveVirtualClusterFromAzureSqlVirtualClusterModelDefinition +Aliases: VirtualCluster + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the virtual cluster. + +```yaml +Type: System.String +Parameter Sets: RemoveVirtualClusterFromInputParameters +Aliases: VirtualClusterName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: RemoveVirtualClusterFromInputParameters +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance object to remove + +```yaml +Type: System.String +Parameter Sets: RemoveVirtualClusterFromAzureResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.VirtualCluster.Model.AzureSqlVirtualClusterModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VirtualCluster.Model.AzureSqlVirtualClusterModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Restore-AzSqlDatabase.md b/azps-10.1.0/Az.Sql/Restore-AzSqlDatabase.md new file mode 100644 index 0000000000..10d10a199b --- /dev/null +++ b/azps-10.1.0/Az.Sql/Restore-AzSqlDatabase.md @@ -0,0 +1,673 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 72E0E558-74D7-4A50-A975-FA7D0C0B301E +online version: https://learn.microsoft.com/powershell/module/az.sql/restore-azsqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Restore-AzSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Restore-AzSqlDatabase.md +--- + +# Restore-AzSqlDatabase + +## SYNOPSIS +Restores a SQL database. + +## SYNTAX + +### FromPointInTimeBackup +``` +Restore-AzSqlDatabase [-FromPointInTimeBackup] -PointInTime <DateTime> -ResourceId <String> + -ServerName <String> -TargetDatabaseName <String> [-Edition <String>] [-ServiceObjectiveName <String>] + [-ElasticPoolName <String>] [-AsJob] [-LicenseType <String>] [-HAReplicaCount <Int32>] + [-BackupStorageRedundancy <String>] [-ZoneRedundant] [-Tag <Hashtable>] [-AssignIdentity] + [-EncryptionProtector <String>] [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### FromPointInTimeBackupWithVcore +``` +Restore-AzSqlDatabase [-FromPointInTimeBackup] -PointInTime <DateTime> -ResourceId <String> + -ServerName <String> -TargetDatabaseName <String> -Edition <String> [-AsJob] -ComputeGeneration <String> + -VCore <Int32> [-LicenseType <String>] [-HAReplicaCount <Int32>] [-BackupStorageRedundancy <String>] + [-ZoneRedundant] [-Tag <Hashtable>] [-AssignIdentity] [-EncryptionProtector <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### FromDeletedDatabaseBackup +``` +Restore-AzSqlDatabase [-FromDeletedDatabaseBackup] [-PointInTime <DateTime>] -DeletionDate <DateTime> + -ResourceId <String> -ServerName <String> -TargetDatabaseName <String> [-Edition <String>] + [-ServiceObjectiveName <String>] [-ElasticPoolName <String>] [-AsJob] [-LicenseType <String>] + [-HAReplicaCount <Int32>] [-BackupStorageRedundancy <String>] [-ZoneRedundant] [-Tag <Hashtable>] + [-AssignIdentity] [-EncryptionProtector <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### FromDeletedDatabaseBackupWithVcore +``` +Restore-AzSqlDatabase [-FromDeletedDatabaseBackup] [-PointInTime <DateTime>] -DeletionDate <DateTime> + -ResourceId <String> -ServerName <String> -TargetDatabaseName <String> -Edition <String> [-AsJob] + -ComputeGeneration <String> -VCore <Int32> [-LicenseType <String>] [-HAReplicaCount <Int32>] + [-BackupStorageRedundancy <String>] [-ZoneRedundant] [-Tag <Hashtable>] [-AssignIdentity] + [-EncryptionProtector <String>] [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### FromGeoBackup +``` +Restore-AzSqlDatabase [-FromGeoBackup] -ResourceId <String> -ServerName <String> -TargetDatabaseName <String> + [-Edition <String>] [-ServiceObjectiveName <String>] [-ElasticPoolName <String>] [-AsJob] + [-LicenseType <String>] [-HAReplicaCount <Int32>] [-BackupStorageRedundancy <String>] [-ZoneRedundant] + [-Tag <Hashtable>] [-AssignIdentity] [-EncryptionProtector <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### FromGeoBackupWithVcore +``` +Restore-AzSqlDatabase [-FromGeoBackup] -ResourceId <String> -ServerName <String> -TargetDatabaseName <String> + -Edition <String> [-AsJob] -ComputeGeneration <String> -VCore <Int32> [-LicenseType <String>] + [-HAReplicaCount <Int32>] [-BackupStorageRedundancy <String>] [-ZoneRedundant] [-Tag <Hashtable>] + [-AssignIdentity] [-EncryptionProtector <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### FromLongTermRetentionBackup +``` +Restore-AzSqlDatabase [-FromLongTermRetentionBackup] -ResourceId <String> -ServerName <String> + -TargetDatabaseName <String> [-Edition <String>] [-ServiceObjectiveName <String>] [-ElasticPoolName <String>] + [-AsJob] [-LicenseType <String>] [-HAReplicaCount <Int32>] [-BackupStorageRedundancy <String>] + [-ZoneRedundant] [-Tag <Hashtable>] [-AssignIdentity] [-EncryptionProtector <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### FromLongTermRetentionBackupWithVcore +``` +Restore-AzSqlDatabase [-FromLongTermRetentionBackup] -ResourceId <String> -ServerName <String> + -TargetDatabaseName <String> -Edition <String> [-AsJob] -ComputeGeneration <String> -VCore <Int32> + [-LicenseType <String>] [-HAReplicaCount <Int32>] [-BackupStorageRedundancy <String>] [-ZoneRedundant] + [-Tag <Hashtable>] [-AssignIdentity] [-EncryptionProtector <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzSqlDatabase** cmdlet restores a SQL database from a geo-redundant backup, a backup of a deleted database, a long term retention backup, or a point in time in a live database. +The restored database is created as a new database. +You can create an elastic SQL database by setting the *ElasticPoolName* parameter to an existing elastic pool. +You can also perform a cross subscription restore for a datawarehouse database. + +## EXAMPLES + +### Example 1: Restore a database from a point in time +```powershell +$Database = Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +Restore-AzSqlDatabase -FromPointInTimeBackup -PointInTime UTCDateTime -ResourceGroupName $Database.ResourceGroupName -ServerName $Database.ServerName -TargetDatabaseName "RestoredDatabase" -ResourceId $Database.ResourceID -Edition "Standard" -ServiceObjectiveName "S2" +``` + +The first command gets the SQL database named Database01, and then stores it in the $Database variable. +The second command restores the database in $Database from the specified point-in-time backup to the database named RestoredDatabase. + +### Example 2: Restore a database from a point in time to an elastic pool +```powershell +$Database = Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +Restore-AzSqlDatabase -FromPointInTimeBackup -PointInTime UTCDateTime -ResourceGroupName $Database.ResourceGroupName -ServerName $Database.ServerName -TargetDatabaseName "RestoredDatabase" -ResourceId $Database.ResourceID -ElasticPoolName "ElasticPool01" +``` + +The first command gets the SQL database named Database01, and then stores it in the $Database variable. +The second command restores the database in $Database from the specified point-in-time backup to the SQL database named RestoredDatabase in the elastic pool named elasticpool01. + +### Example 3: Restore a deleted database +```powershell +$DeletedDatabase = Get-AzSqlDeletedDatabaseBackup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +Restore-AzSqlDatabase -FromDeletedDatabaseBackup -DeletionDate $DeletedDatabase.DeletionDate -ResourceGroupName $DeletedDatabase.ResourceGroupName -ServerName $DeletedDatabase.ServerName -TargetDatabaseName "RestoredDatabase" -ResourceId $DeletedDatabase.ResourceID -Edition "Standard" -ServiceObjectiveName "S2" -PointInTime UTCDateTime +``` + +The first command gets the deleted database backup that you want to restore by using [Get-AzSqlDeletedDatabaseBackup](./Get-AzSqlDeletedDatabaseBackup.md). +The second command starts the restore from the deleted database backup by using the [Restore-AzSqlDatabase](./Restore-AzSqlDatabase.md) cmdlet. If the -PointInTime parameter is not specified, the database will be restored to the deletion time. + +### Example 4: Restore a deleted database into an elastic pool +```powershell +$DeletedDatabase = Get-AzSqlDeletedDatabaseBackup -ResourceGroupName $resourceGroupName -ServerName $sqlServerName -DatabaseName 'DatabaseToRestore' +Restore-AzSqlDatabase -FromDeletedDatabaseBackup -DeletionDate $DeletedDatabase.DeletionDate -ResourceGroupName $DeletedDatabase.ResourceGroupName -ServerName $DeletedDatabase.ServerName -TargetDatabaseName "RestoredDatabase" -ResourceId $DeletedDatabase.ResourceID -ElasticPoolName "elasticpool01" -PointInTime UTCDateTime +``` + +The first command gets the deleted database backup that you want to restore by using [Get-AzSqlDeletedDatabaseBackup](./Get-AzSqlDeletedDatabaseBackup.md). +The second command starts the restore from the deleted database backup by using [Restore-AzSqlDatabase](./Restore-AzSqlDatabase.md). If the -PointInTime parameter is not specified, the database will be restored to the deletion time. + +### Example 5: Geo-Restore a database +```powershell +$GeoBackup = Get-AzSqlDatabaseGeoBackup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +Restore-AzSqlDatabase -FromGeoBackup -ResourceGroupName "TargetResourceGroup" -ServerName "TargetServer" -TargetDatabaseName "RestoredDatabase" -ResourceId $GeoBackup.ResourceID -Edition "Standard" -ServiceObjectiveName "S2" +``` + +The first command gets the geo-redundant backup for the database named Database01, and then stores it in the $GeoBackup variable. +The second command restores the backup in $GeoBackup to the SQL database named RestoredDatabase. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign an Azure Active Directory Identity for this database for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupStorageRedundancy +The Backup storage redundancy used to store backups for the SQL Database. Options are: Local, Zone, Geo and GeoZone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Local, Zone, Geo, GeoZone + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeGeneration +The compute generation to assign to the restored database + +```yaml +Type: System.String +Parameter Sets: FromPointInTimeBackupWithVcore, FromDeletedDatabaseBackupWithVcore, FromGeoBackupWithVcore, FromLongTermRetentionBackupWithVcore +Aliases: Family + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletionDate +Specifies the deletion date as a **DateTime** object. +To get a **DateTime** object, use the Get-Date cmdlet. + +```yaml +Type: System.DateTime +Parameter Sets: FromDeletedDatabaseBackup, FromDeletedDatabaseBackupWithVcore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Edition +Specifies the edition of the SQL database. +The acceptable values for this parameter are: +- None +- Basic +- Standard +- Premium +- DataWarehouse +- Free +- Stretch +- GeneralPurpose +- BusinessCritical + +```yaml +Type: System.String +Parameter Sets: FromPointInTimeBackup, FromDeletedDatabaseBackup, FromGeoBackup, FromLongTermRetentionBackup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: FromPointInTimeBackupWithVcore, FromDeletedDatabaseBackupWithVcore, FromGeoBackupWithVcore, FromLongTermRetentionBackupWithVcore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies the name of the elastic pool in which to put the SQL database. + +```yaml +Type: System.String +Parameter Sets: FromPointInTimeBackup, FromDeletedDatabaseBackup, FromGeoBackup, FromLongTermRetentionBackup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -EncryptionProtector +The encryption protector key for SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedClientId +The federated client id for the SQL Database. It is used for cross tenant CMK scenario. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromDeletedDatabaseBackup +Indicates that this cmdlet restores a database from a backup of a deleted SQL database. +You can use the Get-AzSqlDeletedDatabaseBackup cmdlet to get the backup of a deleted SQL database. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FromDeletedDatabaseBackup, FromDeletedDatabaseBackupWithVcore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromGeoBackup +Indicates that this cmdlet restores a SQL database from a geo-redundant backup. +You can use the Get-AzSqlDatabaseGeoBackup cmdlet to get a geo-redundant backup. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FromGeoBackup, FromGeoBackupWithVcore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromLongTermRetentionBackup +Indicates that this cmdlet restores a SQL database from a long term retention backup. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FromLongTermRetentionBackup, FromLongTermRetentionBackupWithVcore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromPointInTimeBackup +Indicates that this cmdlet restores a SQL database from a point-in-time backup. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: FromPointInTimeBackup, FromPointInTimeBackupWithVcore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HAReplicaCount +The HA Replica Count used to store backups for the SQL Database. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyList +The list of AKV keys for the SQL Database. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +The license type for the Azure Sql database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PointInTime +Specifies the point in time, as a **DateTime** object, that you want to restore your SQL database to. +To get a **DateTime** object, use **Get-Date** cmdlet. +Use this parameter together with the *FromPointInTimeBackup* parameter. + +```yaml +Type: System.DateTime +Parameter Sets: FromPointInTimeBackup, FromPointInTimeBackupWithVcore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.DateTime +Parameter Sets: FromDeletedDatabaseBackup, FromDeletedDatabaseBackupWithVcore +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which this cmdlet assigns the SQL database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the ID of the resource to restore. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL database server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceObjectiveName +Specifies the name of the service objective. + +```yaml +Type: System.String +Parameter Sets: FromPointInTimeBackup, FromDeletedDatabaseBackup, FromGeoBackup, FromLongTermRetentionBackup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The tags to associate with the Azure Sql Database + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDatabaseName +Specifies the name of the database to restore to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +The list of user assigned identity for the SQL Database. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VCore +The Vcore numbers of the restored Azure Sql Database. + +```yaml +Type: System.Int32 +Parameter Sets: FromPointInTimeBackupWithVcore, FromDeletedDatabaseBackupWithVcore, FromGeoBackupWithVcore, FromLongTermRetentionBackupWithVcore +Aliases: Capacity + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +The zone redundancy to associate with the Azure Sql Database. This property is only settable for Hyperscale edition databases. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.DateTime + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## NOTES + +## RELATED LINKS + +[Recover an Azure SQL Database from an outage](http://go.microsoft.com/fwlink/?LinkId=746882) + +[Recover an Azure SQL Database from a user error](http://go.microsoft.com/fwlink/?LinkId=746944) + +[Get-AzSqlDatabase](./Get-AzSqlDatabase.md) + +[Get-AzSqlDatabaseGeoBackup](./Get-AzSqlDatabaseGeoBackup.md) + +[Get-AzSqlDeletedDatabaseBackup](./Get-AzSqlDeletedDatabaseBackup.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + diff --git a/azps-10.1.0/Az.Sql/Restore-AzSqlInstanceDatabase.md b/azps-10.1.0/Az.Sql/Restore-AzSqlInstanceDatabase.md new file mode 100644 index 0000000000..d45e2ba4e2 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Restore-AzSqlInstanceDatabase.md @@ -0,0 +1,593 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/restore-azsqlinstancedatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Restore-AzSqlInstanceDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Restore-AzSqlInstanceDatabase.md +--- + +# Restore-AzSqlInstanceDatabase + +## SYNOPSIS +Restores an Azure SQL Managed Instance database. + +## SYNTAX + +### PointInTimeSameInstanceRestoreInstanceDatabaseFromInputParameters (Default) +``` +Restore-AzSqlInstanceDatabase [-FromPointInTimeBackup] [-SubscriptionId <String>] [-ResourceGroupName] <String> + [-InstanceName] <String> [-Name] <String> -PointInTime <DateTime> -TargetInstanceDatabaseName <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition +``` +Restore-AzSqlInstanceDatabase [-FromPointInTimeBackup] [-InputObject] <AzureSqlManagedDatabaseBaseModel> + -PointInTime <DateTime> -TargetInstanceDatabaseName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureResourceId +``` +Restore-AzSqlInstanceDatabase [-FromPointInTimeBackup] [-ResourceId] <String> -PointInTime <DateTime> + -TargetInstanceDatabaseName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters +``` +Restore-AzSqlInstanceDatabase [-FromPointInTimeBackup] [-SubscriptionId <String>] [-ResourceGroupName] <String> + [-InstanceName] <String> [-Name] <String> -PointInTime <DateTime> -TargetInstanceDatabaseName <String> + -TargetInstanceName <String> -TargetResourceGroupName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition +``` +Restore-AzSqlInstanceDatabase [-FromPointInTimeBackup] [-InputObject] <AzureSqlManagedDatabaseBaseModel> + -PointInTime <DateTime> -TargetInstanceDatabaseName <String> -TargetInstanceName <String> + -TargetResourceGroupName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureResourceId +``` +Restore-AzSqlInstanceDatabase [-FromPointInTimeBackup] [-ResourceId] <String> -PointInTime <DateTime> + -TargetInstanceDatabaseName <String> -TargetInstanceName <String> -TargetResourceGroupName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PointInTimeDeletedDatabasesSameInstanceRestoreInstanceDatabaseFromInputParameters +``` +Restore-AzSqlInstanceDatabase [-FromPointInTimeBackup] [-SubscriptionId <String>] [-ResourceGroupName] <String> + [-InstanceName] <String> [-Name] <String> [-DeletionDate] <DateTime> -PointInTime <DateTime> + -TargetInstanceDatabaseName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### PointInTimeDeletedDatabasesCrossInstanceRestoreInstanceDatabaseFromInputParameters +``` +Restore-AzSqlInstanceDatabase [-FromPointInTimeBackup] [-SubscriptionId <String>] [-ResourceGroupName] <String> + [-InstanceName] <String> [-Name] <String> [-DeletionDate] <DateTime> -PointInTime <DateTime> + -TargetInstanceDatabaseName <String> -TargetInstanceName <String> -TargetResourceGroupName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PointInTimeCrossSubscriptionRestoreFromNameAndResourceGroup +``` +Restore-AzSqlInstanceDatabase [-FromPointInTimeBackup] -SubscriptionId <String> [-ResourceGroupName] <String> + [-InstanceName] <String> [-Name] <String> -PointInTime <DateTime> -TargetInstanceDatabaseName <String> + -TargetInstanceName <String> -TargetResourceGroupName <String> -TargetSubscriptionId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PointInTimeCrossSubscriptionRestoreFromInputObjectParameter +``` +Restore-AzSqlInstanceDatabase [-FromPointInTimeBackup] [-InputObject] <AzureSqlManagedDatabaseBaseModel> + -PointInTime <DateTime> -TargetInstanceDatabaseName <String> -TargetInstanceName <String> + -TargetResourceGroupName <String> -TargetSubscriptionId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PointInTimeCrossSubscriptionRestoreFromResourceIdParameter +``` +Restore-AzSqlInstanceDatabase [-FromPointInTimeBackup] [-ResourceId] <String> -PointInTime <DateTime> + -TargetInstanceDatabaseName <String> -TargetInstanceName <String> -TargetResourceGroupName <String> + -TargetSubscriptionId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### PointInTimeDeletedCrossSubscriptionRestoreFromNameAndResourceGroup +``` +Restore-AzSqlInstanceDatabase [-FromPointInTimeBackup] -SubscriptionId <String> [-ResourceGroupName] <String> + [-InstanceName] <String> [-Name] <String> [-DeletionDate] <DateTime> -PointInTime <DateTime> + -TargetInstanceDatabaseName <String> -TargetInstanceName <String> -TargetResourceGroupName <String> + -TargetSubscriptionId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### GeoRestoreFromGeoBackupSetNameFromGeoBackupObjectParameter +``` +Restore-AzSqlInstanceDatabase [-FromGeoBackup] [-GeoBackupObject] <AzureSqlRecoverableManagedDatabaseModel> + -TargetInstanceDatabaseName <String> -TargetInstanceName <String> -TargetResourceGroupName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GeoRestoreFromGeoBackupSetNameFromResourceIdParameter +``` +Restore-AzSqlInstanceDatabase [-FromGeoBackup] [-ResourceId] <String> -TargetInstanceDatabaseName <String> + -TargetInstanceName <String> -TargetResourceGroupName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### GeoRestoreFromGeoBackupSetNameFromNameAndResourceGroupParameter +``` +Restore-AzSqlInstanceDatabase [-FromGeoBackup] [-ResourceGroupName] <String> [-InstanceName] <String> + [-Name] <String> -TargetInstanceDatabaseName <String> -TargetInstanceName <String> + -TargetResourceGroupName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### LongTermRetentionBackupRestoreParameter +``` +Restore-AzSqlInstanceDatabase [-FromLongTermRetentionBackup] [-SubscriptionId <String>] [-ResourceId] <String> + -TargetInstanceDatabaseName <String> -TargetInstanceName <String> -TargetResourceGroupName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzSqlInstanceDatabase** cmdlet restores an instance database from a geo-redundant backup, a point in time in a live database, or a long term retention backup. +The restored database is created as a new instance database. + +## EXAMPLES + +### Example 1: Restore an instance database from a point in time +```powershell +Restore-AzSqlInstanceDatabase -Name "Database01" -InstanceName "managedInstance1" -ResourceGroupName "ResourceGroup01" -PointInTime UTCDateTime -TargetInstanceDatabaseName "Database01_restored" +``` + +The command restores the instance database Database01 from the specified point-in-time backup to the instance database named Database01_restored. + +### Example 2: Restore an instance database from a point in time to another instance on different resource group +```powershell +Restore-AzSqlInstanceDatabase -Name "Database01" -InstanceName "managedInstance1" -ResourceGroupName "ResourceGroup01" -PointInTime UTCDateTime -TargetInstanceDatabaseName "Database01_restored" -TargetInstanceName "managedInstance1" -TargetResourceGroupName "ResourceGroup02" +``` + +The command restores the instance database Database01 on instance managedInstance1 on resource group ResourceGroup01 from the specified point-in-time backup to the instance database named Database01_restored on instance managedInstance2 on resource group ResourceGroup02. + +### Example 3: Geo-Restore an instance database +```powershell +$GeoBackup = Get-AzSqlInstanceDatabaseGeoBackup -ResourceGroupName "ResourceGroup01" -InstanceName "managedInstance1" -Name "Database01" +$GeoBackup | Restore-AzSqlInstanceDatabase -FromGeoBackup -TargetInstanceDatabaseName "Database01_restored" -TargetInstanceName "managedInstance2" -TargetResourceGroupName "ResourceGroup02" +``` + +The first command gets the geo-redundant backup for the database named Database01, and then stores it in the $GeoBackup variable. +The second command restores the backup in $GeoBackup to the instance database named Database01_restored. + +### Example 4: Restore a deleted instance database from a point in time +```powershell +$deletedDatabase = Get-AzSqlDeletedInstanceDatabaseBackup -ResourceGroupName "ResourceGroup01" -InstanceName "managedInstance1" -DatabaseName "DB1" +Restore-AzSqlInstanceDatabase -FromPointInTimeBackup -Name $deletedDatabase.Name -InstanceName $deletedDatabase.ManagedInstanceName -ResourceGroupName $deletedDatabase.ResourceGroupName -DeletionDate $deletedDatabase.DeletionDate -PointInTime UTCDateTime -TargetInstanceDatabaseName "Database01_restored" +``` + +The first command gets the deleted instance databases named 'DB1' on Instance 'managedInstance1'. +The second command restores the the fetched database, from the specified point-in-time backup to the instance database named Database01_restored. + +### Example 5: Restore a deleted instance database from a point in time +```powershell +$deletedDatabase = Get-AzSqlDeletedInstanceDatabaseBackup -ResourceGroupName "ResourceGroup01" -InstanceName "managedInstance1" -DatabaseName "DB1" +Restore-AzSqlInstanceDatabase -FromPointInTimeBackup -InputObject $deletedDatabase[0] -PointInTime UTCDateTime -TargetInstanceDatabaseName "Database01_restored" +``` + +The first command gets the deleted instance databases named 'DB1' on Instance 'managedInstance1'. +The second command restores the the fetched database, from the specified point-in-time backup to the instance database named Database01_restored using input object. + +### Example 6: Restore a database from LTR backup. +```powershell +Restore-AzSqlInstanceDatabase -FromLongTermRetentionBackup -ResourceId "/subscriptions/f46521f3-5bb0-4eea-a3c2-c2d5987df96b/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/southeastasia/longTermRetentionManagedInstances/testInstance/longTermRetentionDatabases/test/longTermRetentionManagedInstanceBackups/15be823c-7e2c-49d8-819f-a3fdcad92215;132268250550000000" -TargetInstanceDatabaseName "restoreTarget" -TargetInstanceName "testInstance" -TargetResourceGroupName "testResourceGroup" +``` + +```output +Location : southeastasia +Tags : +Collation : SQL_Latin1_General_CP1_CI_AS +Status : Online +RestorePointInTime : +DefaultSecondaryLocation : northeurope +CatalogCollation : +CreateMode : +StorageContainerUri : +StorageContainerSasToken : +SourceDatabaseId : +FailoverGroupId : +RecoverableDatabaseId : +RestorableDroppedDatabaseId : +LongTermRetentionBackupResourceId : +ResourceGroupName : testResourceGroup +ManagedInstanceName : testInstance +Name : restoreTarget +CreationDate : 3/4/2020 8:12:56 AM +EarliestRestorePoint : 3/4/2020 8:14:29 AM +Id : /subscriptions/f46521f3-5bb0-4eea-a3c2-c2d5987df96b/resourceGroups/testResourceGroup/providers/Microsoft.Sql/managedInstances/testInstance/databases/restoreTarget +``` + +Restores LTR backup with the given resource ID (which can be found by running Get-AzSqlInstanceDatabaseLongTermRetentionBackup). + +### Example 7. Restore database from different subscription +```powershell +Restore-AzSqlInstanceDatabase -FromPointInTimeBackup ` + -SubscriptionId "sourceSubscriptionID" ` + -ResourceGroupName "sourceRGName" ` + -InstanceName "sourceManagedInstanceName" ` + -Name "sourceDatabaseName" ` + -PointInTime $pointInTime ` + -TargetInstanceDatabaseName "targetDatabaseName" ` + -TargetInstanceName "targetManagedInstnaceName" ` + -TargetResourceGroupName "targetResourceGroupName" ` + -TargetSubscriptionId "targetSubscriptionId" +``` +The command restores database backup from instance in one subscription to database `targetDatabaseName` on instance `targetManagedInstanceName` to different subscription `targetSubscriptionId`. + +### Example 8. Restore database from different subscription using source object and pipping +```powershell +Set-AzContext -SubscriptionId "sourceSubscriptionId" +$sourceDatabase = Get-AzSqlInstanceDatabase -Name "sourceDatabaseName" -InstanceName "sourceManagedInstanceName" -ResourceGroupName "sourceRGName" + +Set-AzContext -SubscriptionId "targetSubscriptionId" +$sourceDatabase | Restore-AzSqlInstanceDatabase -FromPointInTimeBackup ` + -PointInTime $pointInTime ` + -TargetInstanceDatabaseName "targetDatabaseName" ` + -TargetInstanceName "targetManagedInstnaceName" ` + -TargetResourceGroupName "targetResourceGroupName" ` + -TargetSubscriptionId "targetSubscriptionId" +``` +First command gets source managed database object and stores in variable sourceDatabase. +Second command executes restore from source to the given target database using point in time restore. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletionDate +The deletion date of deleted database. + +```yaml +Type: System.DateTime +Parameter Sets: PointInTimeDeletedDatabasesSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeDeletedDatabasesCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeDeletedCrossSubscriptionRestoreFromNameAndResourceGroup +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromGeoBackup +Restore from a geo backup. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GeoRestoreFromGeoBackupSetNameFromGeoBackupObjectParameter, GeoRestoreFromGeoBackupSetNameFromResourceIdParameter, GeoRestoreFromGeoBackupSetNameFromNameAndResourceGroupParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromLongTermRetentionBackup +Restore from a Long Term Retention backup. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: LongTermRetentionBackupRestoreParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromPointInTimeBackup +Restore from a point-in-time backup. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PointInTimeSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition, PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureResourceId, PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureResourceId, PointInTimeDeletedDatabasesSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeDeletedDatabasesCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossSubscriptionRestoreFromNameAndResourceGroup, PointInTimeCrossSubscriptionRestoreFromInputObjectParameter, PointInTimeCrossSubscriptionRestoreFromResourceIdParameter, PointInTimeDeletedCrossSubscriptionRestoreFromNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeoBackupObject +The recoverable instance database object to restore + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlRecoverableManagedDatabaseModel +Parameter Sets: GeoRestoreFromGeoBackupSetNameFromGeoBackupObjectParameter +Aliases: RecoverableInstanceDatabase + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +The Instance Database object to restore + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseBaseModel +Parameter Sets: PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition, PointInTimeCrossSubscriptionRestoreFromInputObjectParameter +Aliases: InstanceDatabase + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The instance name. + +```yaml +Type: System.String +Parameter Sets: PointInTimeSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeDeletedDatabasesSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeDeletedDatabasesCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossSubscriptionRestoreFromNameAndResourceGroup, PointInTimeDeletedCrossSubscriptionRestoreFromNameAndResourceGroup, GeoRestoreFromGeoBackupSetNameFromNameAndResourceGroupParameter +Aliases: SourceInstanceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The instance database name to restore. + +```yaml +Type: System.String +Parameter Sets: PointInTimeSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeDeletedDatabasesSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeDeletedDatabasesCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossSubscriptionRestoreFromNameAndResourceGroup, PointInTimeDeletedCrossSubscriptionRestoreFromNameAndResourceGroup, GeoRestoreFromGeoBackupSetNameFromNameAndResourceGroupParameter +Aliases: InstanceDatabaseName, SourceInstanceDatabaseName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PointInTime +The point in time to restore the database to. + +```yaml +Type: System.DateTime +Parameter Sets: PointInTimeSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition, PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureResourceId, PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureResourceId, PointInTimeDeletedDatabasesSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeDeletedDatabasesCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossSubscriptionRestoreFromNameAndResourceGroup, PointInTimeCrossSubscriptionRestoreFromInputObjectParameter, PointInTimeCrossSubscriptionRestoreFromResourceIdParameter, PointInTimeDeletedCrossSubscriptionRestoreFromNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PointInTimeSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeDeletedDatabasesSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeDeletedDatabasesCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossSubscriptionRestoreFromNameAndResourceGroup, PointInTimeDeletedCrossSubscriptionRestoreFromNameAndResourceGroup, GeoRestoreFromGeoBackupSetNameFromNameAndResourceGroupParameter +Aliases: SourceResourceGroupName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of Instance Database object to restore + +```yaml +Type: System.String +Parameter Sets: PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureResourceId, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureResourceId, PointInTimeCrossSubscriptionRestoreFromResourceIdParameter, LongTermRetentionBackupRestoreParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GeoRestoreFromGeoBackupSetNameFromResourceIdParameter +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubscriptionId +Source subscription id. + +```yaml +Type: System.String +Parameter Sets: PointInTimeSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeDeletedDatabasesSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeDeletedDatabasesCrossInstanceRestoreInstanceDatabaseFromInputParameters, LongTermRetentionBackupRestoreParameter +Aliases: SourceSubscriptionId + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: PointInTimeCrossSubscriptionRestoreFromNameAndResourceGroup, PointInTimeDeletedCrossSubscriptionRestoreFromNameAndResourceGroup +Aliases: SourceSubscriptionId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetInstanceDatabaseName +The name of the target instance database to restore to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetInstanceName +The name of the target instance to restore to. +If not specified, the target instance is the same as the source instance. + +```yaml +Type: System.String +Parameter Sets: PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureResourceId, PointInTimeDeletedDatabasesCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossSubscriptionRestoreFromNameAndResourceGroup, PointInTimeCrossSubscriptionRestoreFromInputObjectParameter, PointInTimeCrossSubscriptionRestoreFromResourceIdParameter, PointInTimeDeletedCrossSubscriptionRestoreFromNameAndResourceGroup, GeoRestoreFromGeoBackupSetNameFromGeoBackupObjectParameter, GeoRestoreFromGeoBackupSetNameFromResourceIdParameter, GeoRestoreFromGeoBackupSetNameFromNameAndResourceGroupParameter, LongTermRetentionBackupRestoreParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +The name of the target resource group to restore to. +If not specified, the target resource group is the same as the source resource group. + +```yaml +Type: System.String +Parameter Sets: PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureResourceId, PointInTimeDeletedDatabasesCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossSubscriptionRestoreFromNameAndResourceGroup, PointInTimeCrossSubscriptionRestoreFromInputObjectParameter, PointInTimeCrossSubscriptionRestoreFromResourceIdParameter, PointInTimeDeletedCrossSubscriptionRestoreFromNameAndResourceGroup, GeoRestoreFromGeoBackupSetNameFromGeoBackupObjectParameter, GeoRestoreFromGeoBackupSetNameFromResourceIdParameter, GeoRestoreFromGeoBackupSetNameFromNameAndResourceGroupParameter, LongTermRetentionBackupRestoreParameter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSubscriptionId +The name of the target subscription id to restore to. + +```yaml +Type: System.String +Parameter Sets: PointInTimeCrossSubscriptionRestoreFromNameAndResourceGroup, PointInTimeCrossSubscriptionRestoreFromInputObjectParameter, PointInTimeCrossSubscriptionRestoreFromResourceIdParameter, PointInTimeDeletedCrossSubscriptionRestoreFromNameAndResourceGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseBaseModel + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlRecoverableManagedDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Resume-AzSqlDatabase.md b/azps-10.1.0/Az.Sql/Resume-AzSqlDatabase.md new file mode 100644 index 0000000000..f78939144f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Resume-AzSqlDatabase.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 84CF049A-D293-4FEB-8608-179146EADE41 +online version: https://learn.microsoft.com/powershell/module/az.sql/resume-azsqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Resume-AzSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Resume-AzSqlDatabase.md +--- + +# Resume-AzSqlDatabase + +## SYNOPSIS +Resumes a SQL Data Warehouse database. + +## SYNTAX + +``` +Resume-AzSqlDatabase [-ServerName] <String> -DatabaseName <String> [-AsJob] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Resume-AzSqlDatabase** cmdlet resumes an Azure SQL Data Warehouse database. + +## EXAMPLES + +### Example 1: Resumes an Azure SQL Data Warehouse database +```powershell +Resume-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +This command resumes a suspended Azure SQL Data Warehouse database. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database that this cmdlet resumes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the database that this cmdlet resumes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## NOTES +* The **Resume-AzSqlDatabase** cmdlet works only on Azure SQL Data Warehouse databases. This operation is not supported on Azure SQL Database Basic, Standard and Premium editions. + +## RELATED LINKS + +[Get-AzSqlDatabase](./Get-AzSqlDatabase.md) + +[New-AzSqlDatabase](./New-AzSqlDatabase.md) + +[Remove-AzSqlDatabase](./Remove-AzSqlDatabase.md) + +[Set-AzSqlDatabase](./Set-AzSqlDatabase.md) + +[Suspend-AzSqlDatabase](./Suspend-AzSqlDatabase.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabase.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabase.md new file mode 100644 index 0000000000..2e7dbdc63e --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabase.md @@ -0,0 +1,746 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 2E4F5C27-C50F-4133-B193-BC477BCD6778 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabase.md +--- + +# Set-AzSqlDatabase + +## SYNOPSIS +Sets properties for a database, or moves an existing database into an elastic pool. + +## SYNTAX + +### Update (Default) +``` +Set-AzSqlDatabase [-DatabaseName] <String> [-MaxSizeBytes <Int64>] [-Edition <String>] + [-RequestedServiceObjectiveName <String>] [-ElasticPoolName <String>] [-ReadScale <DatabaseReadScale>] + [-Tags <Hashtable>] [-ZoneRedundant] [-AsJob] [-LicenseType <String>] [-ComputeModel <String>] + [-AutoPauseDelayInMinutes <Int32>] [-MinimumCapacity <Double>] [-HighAvailabilityReplicaCount <Int32>] + [-BackupStorageRedundancy <String>] [-SecondaryType <String>] [-MaintenanceConfigurationId <String>] + [-AssignIdentity] [-EncryptionProtector <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] + [-KeysToRemove <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-PreferredEnclaveType <String>] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### VcoreBasedDatabase +``` +Set-AzSqlDatabase [-DatabaseName] <String> [-MaxSizeBytes <Int64>] [-Edition <String>] + [-ReadScale <DatabaseReadScale>] [-Tags <Hashtable>] [-ZoneRedundant] [-AsJob] [-VCore <Int32>] + [-ComputeGeneration <String>] [-LicenseType <String>] [-ComputeModel <String>] + [-AutoPauseDelayInMinutes <Int32>] [-MinimumCapacity <Double>] [-HighAvailabilityReplicaCount <Int32>] + [-BackupStorageRedundancy <String>] [-SecondaryType <String>] [-MaintenanceConfigurationId <String>] + [-AssignIdentity] [-EncryptionProtector <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] + [-KeysToRemove <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-PreferredEnclaveType <String>] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Rename +``` +Set-AzSqlDatabase [-DatabaseName] <String> -NewName <String> [-AsJob] [-BackupStorageRedundancy <String>] + [-SecondaryType <String>] [-MaintenanceConfigurationId <String>] [-AssignIdentity] + [-EncryptionProtector <String>] [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-KeyList <System.Collections.Generic.List`1[System.String]>] + [-KeysToRemove <System.Collections.Generic.List`1[System.String]>] [-FederatedClientId <Guid>] + [-PreferredEnclaveType <String>] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlDatabase** cmdlet sets properties for a database in Azure SQL Database. This cmdlet can modify the service tier (*Edition*), performance level (*RequestedServiceObjectiveName*), and storage max size (*MaxSizeBytes*) for the database. In addition, you can specify the *ElasticPoolName* parameter to move a database into an elastic pool. If a database is already in an elastic pool, you can use the *RequestedServiceObjectiveName* parameter to move the database out of an elastic pool and into a performance level for single databases. + +## EXAMPLES + +### Example 1: Update a database to a Standard S0 database +```powershell +Set-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -Edition "Standard" -RequestedServiceObjectiveName "S0" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +Location : Central US +DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 +Edition : Standard +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 268435456000 +Status : Online +CreationDate : 7/3/2015 7:33:37 AM +CurrentServiceObjectiveId : 455330e1-00cd-488b-b5fa-177c226f28b7 +CurrentServiceObjectiveName : S0 +RequestedServiceObjectiveId : 455330e1-00cd-488b-b5fa-177c226f28b7 +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +Tags : +``` + +This command updates a database named Database01 to a Standard S0 database on a server named Server01. + +### Example 2: Add a database to an elastic pool +```powershell +Set-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +Location : Central US +DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 +Edition : Standard +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 268435456000 +Status : Online +CreationDate : 7/3/2015 7:33:37 AM +CurrentServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 +CurrentServiceObjectiveName : ElasticPool +RequestedServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 +RequestedServiceObjectiveName : +ElasticPoolName : elasticpool01 +EarliestRestoreDate : +Tags : +``` + +This command adds a database named Database01 to the elastic pool named ElasticPool01 hosted on the server named Server01. + +### Example 3: Modify the storage max size of a database +```powershell +Set-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -MaxSizeBytes 1099511627776 +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +Location : Central US +DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 +Edition : Standard +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 1099511627776 +Status : Online +CreationDate : 8/24/2017 9:00:37 AM +CurrentServiceObjectiveId : 789681b8-ca10-4eb0-bdf2-e0b050601b40 +CurrentServiceObjectiveName : S3 +RequestedServiceObjectiveId : 789681b8-ca10-4eb0-bdf2-e0b050601b40 +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +Tags : +``` + +This command updates a database named Database01 to set its max size to 1 TB. + +### Example 4: Update a existing General Purpose database to Hyperscale service tier +```powershell +Set-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -Edition "Hyperscale" -RequestedServiceObjectiveName "HS_Gen5_2" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +Location : Central US +DatabaseId : 56246136-839f-4171-80af-4c28142463b1 +Edition : Hyperscale +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : -1 +Status : Online +CreationDate : 12/6/2020 5:34:16 PM +CurrentServiceObjectiveId : 00000000-0000-0000-0000-000000000000 +CurrentServiceObjectiveName : HS_Gen5_2 +RequestedServiceObjectiveName : HS_Gen5_2 +RequestedServiceObjectiveId : +ElasticPoolName : +EarliestRestoreDate : 12/6/2020 5:34:16 PM +Tags : {} +ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/servers/Server01/databases/Database01 +CreateMode : +ReadScale : Enabled +ZoneRedundant : +Capacity : 2 +Family : Gen5 +SkuName : HS_Gen5 +LicenseType : LicenseIncluded +AutoPauseDelayInMinutes : +MinimumCapacity : +ReadReplicaCount : 1 +BackupStorageRedundancy : Geo +``` + +This command updates a database named Database01 from General Purpose to Hyperscale service tier. + +### Example 5: Update the preferred enclave type of a database to VBS + +```powershell +Set-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -PreferredEnclaveType "VBS" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +Location : Central US +DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 +Edition : Standard +CollationName : SQL_Latin1_General_CP1_CI_AS +CatalogCollation : +MaxSizeBytes : 1099511627776 +Status : Online +CreationDate : 8/24/2017 9:00:37 AM +CurrentServiceObjectiveId : 789681b8-ca10-4eb0-bdf2-e0b050601b40 +CurrentServiceObjectiveName : S3 +RequestedServiceObjectiveId : 789681b8-ca10-4eb0-bdf2-e0b050601b40 +PreferredEnclaveType : VBS +RequestedServiceObjectiveName : +ElasticPoolName : +EarliestRestoreDate : +Tags : +``` + +This command updates a database to configure VBS enclave on it + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign an Azure Active Directory Identity for this database for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoPauseDelayInMinutes +The auto pause delay in minutes for database (serverless only), -1 to opt out + +```yaml +Type: System.Int32 +Parameter Sets: Update, VcoreBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupStorageRedundancy +The Backup storage redundancy used to store backups for the SQL Database. Options are: Local, Zone, Geo and GeoZone. To know the options supported by each edition of the database, see [Get-AzSqlCapability](https://learn.microsoft.com/en-us/powershell/module/az.sql/get-azsqlcapability). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Local, Zone, Geo, GeoZone + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeGeneration +The compute generation to assign. + +```yaml +Type: System.String +Parameter Sets: VcoreBasedDatabase +Aliases: Family + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeModel +Computed model of Azure Sql database. Serverless or Provisioned + +```yaml +Type: System.String +Parameter Sets: Update, VcoreBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Edition +Specifies the edition for the database. +The acceptable values for this parameter are: +- None +- Basic +- Standard +- Premium +- DataWarehouse +- Free +- Stretch +- GeneralPurpose +- Hyperscale +- BusinessCritical + +```yaml +Type: System.String +Parameter Sets: Update, VcoreBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies name of the elastic pool in which to move the database. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionProtector +The encryption protector key for SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedClientId +The federated client id for the SQL Database. It is used for cross tenant CMK scenario. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityReplicaCount +The number of readonly secondary replicas associated with the database. For Hyperscale edition only. + +```yaml +Type: System.Int32 +Parameter Sets: Update, VcoreBasedDatabase +Aliases: ReadReplicaCount + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyList +The list of AKV keys for the SQL Database. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeysToRemove +The list of AKV keys to remove from the SQL Database. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +The license type for the Azure Sql database. Possible values are: +- BasePrice - Azure Hybrid Benefit (AHB) discounted pricing for existing SQL Server license owners is applied. Database price will be discounted for existing SQL Server license owners. +- LicenseIncluded - Azure Hybrid Benefit (AHB) discount pricing for existing SQL Server license owners is not applied. Database price will include a new SQL Server license costs. + +```yaml +Type: System.String +Parameter Sets: Update, VcoreBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceConfigurationId +The Maintenance configuration id for the SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSizeBytes +The maximum size of the Azure SQL Database in bytes. + +```yaml +Type: System.Int64 +Parameter Sets: Update, VcoreBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumCapacity +The Minimal capacity that database will always have allocated, if not paused. +For serverless Azure Sql databases only. + +```yaml +Type: System.Double +Parameter Sets: Update, VcoreBasedDatabase +Aliases: MinVCore, MinCapacity + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewName +The new name to rename the database to. + +```yaml +Type: System.String +Parameter Sets: Rename +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredEnclaveType +The preferred enclave type for the Azure Sql database. Possible values are Default and VBS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadScale +If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.DatabaseReadScale +Parameter Sets: Update, VcoreBasedDatabase +Aliases: +Accepted values: Disabled, Enabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestedServiceObjectiveName +Specifies the name of the service objective to assign to the database. For information about +service objectives, see [Azure SQL Database Service Tiers and Performance Levels](https://learn.microsoft.com/azure/sql-database/sql-database-dtu-resource-limits-single-databases) +in the Microsoft Developer Network Library. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryType +The secondary type of the database if it is a secondary. Valid values are Geo and Named. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Named, Geo + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tags +Key-value pairs in the form of a hash table. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: Update, VcoreBasedDatabase +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +The list of user assigned identity for the SQL Database. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VCore +The Vcore number for the Azure Sql database + +```yaml +Type: System.Int32 +Parameter Sets: VcoreBasedDatabase +Aliases: Capacity, MaxVCore, MaxCapacity + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +The zone redundancy to associate with the Azure Sql Database + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Update, VcoreBasedDatabase +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabase](./Get-AzSqlDatabase.md) + +[New-AzSqlDatabase](./New-AzSqlDatabase.md) + +[Remove-AzSqlDatabase](./Remove-AzSqlDatabase.md) + +[Resume-AzSqlDatabase](./Resume-AzSqlDatabase.md) + +[Suspend-AzSqlDatabase](./Suspend-AzSqlDatabase.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseAdvisorAutoExecuteStatus.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseAdvisorAutoExecuteStatus.md new file mode 100644 index 0000000000..c3f666df38 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseAdvisorAutoExecuteStatus.md @@ -0,0 +1,197 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 50E09DF7-F5B5-4668-9520-73D562E91800 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqldatabaseadvisorautoexecutestatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseAdvisorAutoExecuteStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseAdvisorAutoExecuteStatus.md +--- + +# Set-AzSqlDatabaseAdvisorAutoExecuteStatus + +## SYNOPSIS +Modifies auto execute status of an Azure SQL Database Advisor. + +## SYNTAX + +``` +Set-AzSqlDatabaseAdvisorAutoExecuteStatus -AdvisorName <String> -AutoExecuteStatus <AdvisorAutoExecuteStatus> + -ServerName <String> -DatabaseName <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlDatabaseAdvisorAutoExecuteStatus** cmdlet modifies the auto execute property for an Azure SQL Database Advisor. +Currently, this cmdlet supports the values Enabled, Disabled, and Default. + +## EXAMPLES + +### Example 1: Enable auto execute for an advisor +```powershell +Set-AzSqlDatabaseAdvisorAutoExecuteStatus -ResourceGroupName "ContosoRunnersProd" -ServerName "runner-australia-east" -DatabaseName "ContosoRunner" -AdvisorName "CreateIndex" -AutoExecuteStatus Enabled +``` + +```output +DatabaseName : ContosoRunner +ResourceGroupName : ContosoRunnersProd +ServerName : runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Enabled +AutoExecuteStatusInheritedFrom : Database +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {} +``` + +This command changes the auto execute status of an advisor named CreateIndex to Enabled. + +## PARAMETERS + +### -AdvisorName +Specifies the name of the advisor for which this cmdlet modifies the status. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutoExecuteStatus +Specifies the value for the status. +The acceptable values for this parameter are: +- Enabled +- Disabled +- Default + +```yaml +Type: Microsoft.Azure.Commands.Sql.Advisor.Cmdlet.AdvisorAutoExecuteStatus +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled, Default + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database for which this cmdlet modifies status. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the server that contains this database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server for the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Advisor.Cmdlet.AdvisorAutoExecuteStatus + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Advisor.Model.AzureSqlDatabaseAdvisorModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseAdvisor](./Get-AzSqlDatabaseAdvisor.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseAudit.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseAudit.md new file mode 100644 index 0000000000..6eccbc31e3 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseAudit.md @@ -0,0 +1,470 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: F7EF35E3-BC53-43D9-A71E-0B4316260A08 +online version: https://learn.microsoft.com/powershell/module/az.sql/Set-AzSqlDatabaseAudit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseAudit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseAudit.md +--- + +# Set-AzSqlDatabaseAudit + +## SYNOPSIS +Changes the auditing settings for an Azure SQL Database. + +## SYNTAX + +### DatabaseParameterSet (Default) +``` +Set-AzSqlDatabaseAudit [-AuditActionGroup <AuditActionGroups[]>] [-AuditAction <String[]>] + [-PredicateExpression <String>] [-BlobStorageTargetState <String>] [-StorageAccountResourceId <String>] + [-StorageKeyType <String>] [-RetentionInDays <UInt32>] [-EventHubTargetState <String>] + [-EventHubName <String>] [-EventHubAuthorizationRuleResourceId <String>] [-LogAnalyticsTargetState <String>] + [-WorkspaceResourceId <String>] [-PassThru] [-UseIdentity <String>] [-ResourceGroupName] <String> + [-ServerName] <String> [-DatabaseName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### DatabaseObjectParameterSet +``` +Set-AzSqlDatabaseAudit [-AuditActionGroup <AuditActionGroups[]>] [-AuditAction <String[]>] + [-PredicateExpression <String>] [-BlobStorageTargetState <String>] [-StorageAccountResourceId <String>] + [-StorageKeyType <String>] [-RetentionInDays <UInt32>] [-EventHubTargetState <String>] + [-EventHubName <String>] [-EventHubAuthorizationRuleResourceId <String>] [-LogAnalyticsTargetState <String>] + [-WorkspaceResourceId <String>] [-PassThru] [-UseIdentity <String>] -DatabaseObject <AzureSqlDatabaseModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlDatabaseAudit** cmdlet changes the auditing settings of an Azure SQL Database. +To use the cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. +When blob storage is a destination for audit logs, specify the *StorageAccountResourceId* parameter to determine the storage account for the audit logs and the *StorageKeyType* parameter to define the storage keys. You can also define retention for the audit logs by setting the value of the *RetentionInDays* parameter to define the period for the audit logs. + +## EXAMPLES + +### Example 1: Enable the blob storage auditing policy of an Azure SQL Database +```powershell +Set-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" +``` + +### Example 2: Disable the blob storage auditing policy of an Azure SQL Database +```powershell +Set-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -BlobStorageTargetState Disabled +``` + +### Example 3: Enable the blob storage auditing policy of an Azure SQL Database with filtering using a T-SQL predicate +```powershell +Set-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -PredicateExpression "schema_name <> 'sys''" -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" +``` + +### Example 4: Remove the filtering from the auditing policy of an Azure SQL Database +```powershell +Set-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -PredicateExpression "" +``` + +### Example 5: Enable the event hub auditing policy of an Azure SQL Database +```powershell +Set-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId" +``` + +### Example 6: Disable the event hub auditing policy of an Azure SQL Database +```powershell +Set-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -EventHubTargetState Disabled +``` + +### Example 7: Enable the log analytics auditing policy of an Azure SQL Database +```powershell +Set-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +### Example 8: Disable the log analytics auditing policy of an Azure SQL Database +```powershell +Set-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -LogAnalyticsTargetState Disabled +``` + +### Example 9: Disable, through pipeline, the log analytics auditing policy of an Azure SQL Database +```powershell +Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" | Set-AzSqlDatabaseAudit -LogAnalyticsTargetState Disabled +``` + +### Example 10: Disable sending audit records of an Azure SQL Database to blob storage, and enable sending them to log analytics. +```powershell +Set-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" -BlobStorageTargetState Disabled +``` + +### Example 11: Enable sending audit records of an Azure SQL Database to blob storage, event hub and log analytics. +```powershell +Set-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +## PARAMETERS + +### -AuditAction +The set of audit actions. +The supported actions to audit are: +SELECT +UPDATE +INSERT +DELETE +EXECUTE +RECEIVE +REFERENCES +The general form for defining an action to be audited is: +[action] ON [object] BY [principal] +Note that [object] in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::[dbname] and SCHEMA::[schemaname] are used, respectively. +For example: +SELECT on dbo.myTable by public +SELECT on DATABASE::myDatabase by public +SELECT on SCHEMA::mySchema by public +For more information, see https://learn.microsoft.com/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditActionGroup +The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: + +"BATCH_COMPLETED_GROUP", +"SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", +"FAILED_DATABASE_AUTHENTICATION_GROUP" +This above combination is also the set that is configured by default. These groups cover all SQL statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. +For more information, see https://learn.microsoft.com/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Auditing.Model.AuditActionGroups[] +Parameter Sets: (All) +Aliases: +Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP, LEDGER_OPERATION_GROUP, DBCC_GROUP, DATABASE_OWNERSHIP_CHANGE_GROUP, DATABASE_CHANGE_GROUP + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobStorageTargetState +Indicates whether blob storage is a destination for audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseObject +The database object to manage its audit policy. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: DatabaseObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubAuthorizationRuleResourceId +The resource Id for the event hub authorization rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the event hub. If none is specified when providing EventHubAuthorizationRuleResourceId, the default event hub will be selected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubTargetState +Indicates whether event hub is a destination for audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticsTargetState +Indicates whether log analytics is a destination for audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Specifies whether to output the auditing policy at end of cmdlet execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PredicateExpression +The T-SQL predicate (WHERE clause) used to filter audit logs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionInDays +The number of retention days for the audit logs. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: DatabaseParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The storage account resource id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageKeyType +Specifies which of the storage access keys to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseIdentity +Indicates whether to use managed identity or not. It is required when you want to use managed identity while target storage is not behind firewall. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Audit Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +### Microsoft.Azure.Commands.Sql.Auditing.Model.AuditActionGroups[] + +### System.String[] + +### System.Guid + +### System.Nullable`1[[System.UInt32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.Sql.Auditing.Model.DatabaseAuditModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseBackupLongTermRetentionPolicy.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseBackupLongTermRetentionPolicy.md new file mode 100644 index 0000000000..d4c284b4a2 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseBackupLongTermRetentionPolicy.md @@ -0,0 +1,387 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqldatabasebackuplongtermretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseBackupLongTermRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseBackupLongTermRetentionPolicy.md +--- + +# Set-AzSqlDatabaseBackupLongTermRetentionPolicy + +## SYNOPSIS +Sets a server long term retention policy. + +## SYNTAX + +### WeeklyRetentionRequired (Default) +``` +Set-AzSqlDatabaseBackupLongTermRetentionPolicy -WeeklyRetention <String> [-ServerName] <String> + [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### RemovePolicy +``` +Set-AzSqlDatabaseBackupLongTermRetentionPolicy [-RemovePolicy] [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### MonthlyRetentionRequired +``` +Set-AzSqlDatabaseBackupLongTermRetentionPolicy [-WeeklyRetention <String>] -MonthlyRetention <String> + [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### YearlyRetentionRequired +``` +Set-AzSqlDatabaseBackupLongTermRetentionPolicy [-WeeklyRetention <String>] [-MonthlyRetention <String>] + -YearlyRetention <String> -WeekOfYear <Int32> [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlDatabaseBackupLongTermRetentionPolicy** cmdlet sets the long term retention policy registered to this database. +The policy is an Azure Backup resource used to define backup storage policy. + +## EXAMPLES + +### Example 1: Set the weekly retention for the current version of long term retention policy +```powershell +Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention P2W +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database01 +WeeklyRetention : P2W +MonthlyRetention : PT0S +YearlyRetention : PT0S +WeekOfYear : 0 +Location : +``` + +This sets the long term retention policy of database01 to save every weekly full backup for 2 weeks + +### Example 2: Set the monthly retention for the current version of long term retention policy +```powershell +Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -MonthlyRetention P5Y +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database01 +WeeklyRetention : PT0S +MonthlyRetention : P5Y +YearlyRetention : PT0S +WeekOfYear : 0 +Location : +``` + +This sets the long term retention policy of database01 to save the first full backup of each month for 5 years + +### Example 3: Set the yearly retention for the current version of long term retention policy +```powershell +Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -YearlyRetention P10Y -WeekOfYear 26 +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database01 +WeeklyRetention : PT0S +MonthlyRetention : PT0S +YearlyRetention : P10Y +WeekOfYear : 26 +Location : +``` + +This sets the long term retention policy of database01 to save the full backup taken on the 26th week of the year for 10 years + +### Example 4: Set each retention for the current version of long term retention policy +```powershell +Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention 14 -MonthlyRetention P24W -YearlyRetention P10Y -WeekOfYear 26 +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database01 +WeeklyRetention : P14D +MonthlyRetention : P24W +YearlyRetention : P10Y +WeekOfYear : 26 +Location : +``` + +This sets the long term retention policy of database01 to save each full backup for 14 days, the first full backup of each month for 24 weeks, and the full backup taken on the 26th week of the year for 10 years + +### Example 5: Remove the long term retention policy +```powershell +Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -RemovePolicy +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database01 +WeeklyRetention : PT0S +MonthlyRetention : PT0S +YearlyRetention : PT0S +WeekOfYear : 0 +Location : +``` + +Removes the policy for database01 so it no longer saves any long term retention backups. +This will not affect backups that have already been taken + +### Example 6: Remove the long term retention policy +```powershell +Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention P0D +``` + +```output +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database01 +WeeklyRetention : PT0S +MonthlyRetention : PT0S +YearlyRetention : PT0S +WeekOfYear : 0 +Location : +``` + +This is another way of removing the policy for database01 so it no longer saves any long term retention backups. +This will not affect backups that have already been taken + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Database to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonthlyRetention +The Monthly Retention. +If just a number is passed instead of an ISO 8601 string, days will be assumed as the units. +There is a minimum of 7 days and a maximum of 10 years. + +```yaml +Type: System.String +Parameter Sets: MonthlyRetentionRequired +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: YearlyRetentionRequired +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RemovePolicy +If provided, the policy for the database will be removed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RemovePolicy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the database is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WeeklyRetention +The Weekly Retention. +If just a number is passed instead of an ISO 8601 string, days will be assumed as the units. +There is a minimum of 7 days and a maximum of 10 years. + +```yaml +Type: System.String +Parameter Sets: WeeklyRetentionRequired +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MonthlyRetentionRequired, YearlyRetentionRequired +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WeekOfYear +The Week of Year, 1 to 52, to save for the Yearly Retention. + +```yaml +Type: System.Int32 +Parameter Sets: YearlyRetentionRequired +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -YearlyRetention +The Yearly Retention. +If just a number is passed instead of an ISO 8601 string, days will be assumed as the units. +There is a minimum of 7 days and a maximum of 10 years. + +```yaml +Type: System.String +Parameter Sets: YearlyRetentionRequired +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseBackupLongTermRetentionPolicyModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseLongTermRetentionBackup](./Get-AzSqlDatabaseLongTermRetentionBackup.md) + +[Update-AzSqlDatabaseLongTermRetentionBackup](./Update-AzSqlDatabaseLongTermRetentionBackup.md) + +[Copy-AzSqlDatabaseLongTermRetentionBackup](./Copy-AzSqlDatabaseLongTermRetentionBackup.md) + +[Remove-AzSqlDatabaseLongTermRetentionBackup](./Remove-AzSqlDatabaseLongTermRetentionBackup.md) + +[Get-AzSqlDatabaseBackupLongTermRetentionPolicy](./Get-AzSqlDatabaseBackupLongTermRetentionPolicy.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseBackupShortTermRetentionPolicy.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseBackupShortTermRetentionPolicy.md new file mode 100644 index 0000000000..b2f27b9143 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseBackupShortTermRetentionPolicy.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqldatabasebackupshorttermretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseBackupShortTermRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseBackupShortTermRetentionPolicy.md +--- + +# Set-AzSqlDatabaseBackupShortTermRetentionPolicy + +## SYNOPSIS +Sets a backup short term retention policy. + +## SYNTAX + +### PolicyByResourceServerDatabaseSet (Default) +``` +Set-AzSqlDatabaseBackupShortTermRetentionPolicy [-RetentionDays <Int32>] [-DiffBackupIntervalInHours <Int32>] + [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PolicyByInputObjectSet +``` +Set-AzSqlDatabaseBackupShortTermRetentionPolicy [-RetentionDays <Int32>] [-DiffBackupIntervalInHours <Int32>] + -AzureSqlDatabaseObject <AzureSqlDatabaseModel> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### PolicyByResourceIdSet +``` +Set-AzSqlDatabaseBackupShortTermRetentionPolicy [-RetentionDays <Int32>] [-DiffBackupIntervalInHours <Int32>] + -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlDatabaseBackupShortTermRetentionPolicy** cmdlet sets the short term retention policy for this database. +The policy is the retention period, in days, for point-in-time restore backups and differential backup frequency, in hours. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSqlDatabaseBackupShortTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -RetentionDays 6 -DiffBackupIntervalInHours 24 +``` + +```output +ResourceGroupName ServerName DatabaseName RetentionDays DiffBackupIntervalInHours +----------------- ---------- ------------ ------------- ------------------------- +resourcegroup01 server01 database01 6 24 +``` + +This command sets the short term retention policy for database01 to 6 retention days and 24 differential backup interval hours. + +### Example 2 +```powershell +Get-AzSqlDatabase -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 | Set-AzSqlDatabaseBackupShortTermRetentionPolicy -RetentionDays 5 -DiffBackupIntervalInHours 12 +``` + +```output +ResourceGroupName ServerName DatabaseName RetentionDays DiffBackupIntervalInHours +----------------- ---------- ------------ ------------- ------------------------ +resourcegroup01 server01 database01 5 12 +``` + +This command sets the short term retention policy for database01 to 5 retention days and 12 differential backup interval hours via piping in a database object. + +### Example 3 +```powershell +Set-AzSqlDatabaseBackupShortTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -RetentionDays 7 +``` + +```output +ResourceGroupName ServerName DatabaseName RetentionDays DiffBackupIntervalInHours +----------------- ---------- ------------ ------------- ------------------------- +resourcegroup01 server01 database01 7 12 +``` + +This command sets the short term retention policy for database01 to 7 retention days only. DiffBackupIntervalInHours is unchanged. + +## PARAMETERS + +### -AzureSqlDatabaseObject +The database object to get the policy for. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: PolicyByInputObjectSet +Aliases: AzureSqlDatabase + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Database to use. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceServerDatabaseSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiffBackupIntervalInHours +Differential backup frequency in hours. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceServerDatabaseSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The short term retention policy resource Id. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceIdSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionDays +The backup retention setting, in days. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 7 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the database is in. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceServerDatabaseSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseBackupShortTermRetentionPolicyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseDataMaskingPolicy.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseDataMaskingPolicy.md new file mode 100644 index 0000000000..29faff67b0 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseDataMaskingPolicy.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 1B138185-E836-414F-93CD-7BAE7F474E73 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqldatabasedatamaskingpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseDataMaskingPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseDataMaskingPolicy.md +--- + +# Set-AzSqlDatabaseDataMaskingPolicy + +## SYNOPSIS +Sets data masking for a database. + +## SYNTAX + +``` +Set-AzSqlDatabaseDataMaskingPolicy [-PassThru] [-PrivilegedUsers <String>] [-DataMaskingState <String>] + [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlDatabaseDataMaskingPolicy** cmdlet sets the data masking policy for an Azure SQL database. +To use this cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. +You can set the *DataMaskingState* parameter to specify whether data masking operations are enabled or disabled. +If the cmdlet succeeds and the *PassThru* parameter is used, it returns an object describing the current data masking policy in addition to the database identifiers. +Database identifiers include, but are not limited to, **ResourceGroupName**, **ServerName**, and **DatabaseName**. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Set the data masking policy for a database +```powershell +Set-AzSqlDatabaseDataMaskingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -PrivilegedUsers "public" -DataMaskingState "Enabled" +``` + +This command sets the data masking policy for a database named database01 on the server named server01. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database where the policy is set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DataMaskingState +Specifies whether data masking operation is enabled or disabled. +The acceptable values for this parameter are: +- Enabled +- Disabled +The default value is Enabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivilegedUsers +Specifies a semicolon-separated list of privileged user IDs. +These users are allowed to view the masking data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server hosting the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataMasking.Model.DatabaseDataMaskingPolicyModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseDataMaskingPolicy](./Get-AzSqlDatabaseDataMaskingPolicy.md) + +[Get-AzSqlDatabaseDataMaskingRule](./Get-AzSqlDatabaseDataMaskingRule.md) + +[New-AzSqlDatabaseDataMaskingRule](./New-AzSqlDatabaseDataMaskingRule.md) + +[Remove-AzSqlDatabaseDataMaskingRule](./Remove-AzSqlDatabaseDataMaskingRule.md) + +[Set-AzSqlDatabaseDataMaskingRule](./Set-AzSqlDatabaseDataMaskingRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseDataMaskingRule.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseDataMaskingRule.md new file mode 100644 index 0000000000..c4c6b18f42 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseDataMaskingRule.md @@ -0,0 +1,348 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 48CF206C-AF63-4013-834E-8EC3646D180B +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqldatabasedatamaskingrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseDataMaskingRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseDataMaskingRule.md +--- + +# Set-AzSqlDatabaseDataMaskingRule + +## SYNOPSIS +Sets the properties of a data masking rule for a database. + +## SYNTAX + +``` +Set-AzSqlDatabaseDataMaskingRule [-MaskingFunction <String>] [-PrefixSize <UInt32>] + [-ReplacementString <String>] [-SuffixSize <UInt32>] [-NumberFrom <Double>] [-NumberTo <Double>] [-PassThru] + -SchemaName <String> -TableName <String> -ColumnName <String> [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlDatabaseDataMaskingRule** cmdlet sets a data masking rule for an Azure SQL database. +To use the cmdlet, provide the *ResourceGroupName*, *ServerName*, *DatabaseName*, and *RuleId* parameters to identify the rule. +You can provide any of the parameters of *SchemaName*, *TableName*, and *ColumnName* to retarget the rule. +Specify the *MaskingFunction* parameter to modify how the data is masked. +If you specify a value of Number or Text for *MaskingFunction*, you can specify the *NumberFrom* and *NumberTo* parameters for number masking or the *PrefixSize*, *ReplacementString*, and *SuffixSize* parameters for text masking. +If the command succeeds, and if you specify the *PassThru* parameter, the cmdlet returns an object that describes the data masking rule properties and the rule identifiers. +Rule identifiers include, but are not limited to, **ResourceGroupName**, **ServerName**, **DatabaseName**, and **RuleId**. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Change the range of a data masking rule in a database +```powershell +Set-AzSqlDatabaseDataMaskingRule -ResourceGroupName $params.rgname -ServerName $params.serverName -DatabaseName $params.databaseName -SchemaName "dbo" -TableName "table1" -ColumnName "column1" -MaskingFunction "Default" +``` + +This command modifies a data masking rule that has the ID Rule17. +That rule operates in the database named Database01 on server Server01. +This command changes the boundaries for the interval in which a random number is generated as the masked value. +The new range is between 23 and 42. + +### Example 2 + +Sets the properties of a data masking rule for a database. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Set-AzSqlDatabaseDataMaskingRule -ColumnName 'column1' -DatabaseName $params.databaseName -MaskingFunction NoMasking -NumberFrom 5 -NumberTo 14 -PrefixSize <UInt32> -ReplacementString <String> -ResourceGroupName $params.rgname -SchemaName 'dbo' -ServerName $params.serverName -SuffixSize <UInt32> -TableName 'table1' +``` + +## PARAMETERS + +### -ColumnName +Specifies the name of the column targeted by the masking rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaskingFunction +Specifies the masking function that the rule uses. +The acceptable values for this parameter are: +- Default +- NoMasking +- Text +- Number +- SocialSecurityNumber +- CreditCardNumber +- Email +The default value is Default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: NoMasking, Default, Text, Number, SocialSecurityNumber, CreditCardNumber, Email + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NumberFrom +Specifies the lower bound number of the interval from which a random value is selected. +Specify this parameter only if you specify a value of Number for the *MaskingFunction* parameter. +The default value is 0. + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NumberTo +Specifies the upper bound number of the interval from which a random value is selected. +Specify this parameter only if you specify a value of Number for the *MaskingFunction* parameter. +The default value is 0. + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrefixSize +Specifies the number of characters at the start of the text that are not masked. +Specify this parameter only if you specify a value of Text for the *MaskingFunction* parameter. +The default value is 0. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ReplacementString +Specifies the number of characters at the end of the text that are not masked. +Specify this parameter only if you specify a value of Text for the *MaskingFunction* parameter. +The default value is 0. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Specifies the name of a schema. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SuffixSize +Specifies the number of characters at the end of the text that are not masked. +Specify this parameter only if you specify a value of Text for the *MaskingFunction* parameter. +The default value is 0. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Specifies the name of the database table that contains the masked column. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.UInt32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.Nullable`1[[System.Double, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataMasking.Model.DatabaseDataMaskingRuleModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseDataMaskingRule](./Get-AzSqlDatabaseDataMaskingRule.md) + +[New-AzSqlDatabaseDataMaskingRule](./New-AzSqlDatabaseDataMaskingRule.md) + +[Remove-AzSqlDatabaseDataMaskingRule](./Remove-AzSqlDatabaseDataMaskingRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseFailoverGroup.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseFailoverGroup.md new file mode 100644 index 0000000000..66e51ea20d --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseFailoverGroup.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqldatabasefailovergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseFailoverGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseFailoverGroup.md +--- + +# Set-AzSqlDatabaseFailoverGroup + +## SYNOPSIS +Modifies the configuration of an Azure SQL Database Failover Group. + +## SYNTAX + +``` +Set-AzSqlDatabaseFailoverGroup [-ServerName] <String> [-FailoverGroupName] <String> + [-FailoverPolicy <FailoverPolicy>] [-GracePeriodWithDataLossHours <Int32>] + [-AllowReadOnlyFailoverToPrimary <AllowReadOnlyFailoverToPrimary>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This command modifies the configuration of an Azure SQL Database Failover Group. +The Failover Group's primary server should be used to execute the command. +To control the set of databases in the group, use 'Add-AzSqlDatabaseToFailoverGroup' and 'Remove-AzSqlDatabaseFromFailoverGroup' instead. +During preview of the Failover Groups feature, only values greater than or equal to 1 hour are supported for the '-GracePeriodWithDataLossHours' parameter. + +## EXAMPLES + +### Example 1 +```powershell +$failoverGroup = Set-AzSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg -FailoverPolicy Automatic -GracePeriodWithDataLossHours 1 +``` + +Sets a Failover Group's failover policy to 'Automatic.' + +### Example 2 +```powershell +$failoverGroup = Get-AzSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg | Set-AzSqlDatabaseFailoverGroup -FailoverPolicy Manual +``` + +Sets a Failover Group's failover policy to 'Manual' by piping in the Failover Group. + +## PARAMETERS + +### -AllowReadOnlyFailoverToPrimary +Whether outages on the secondary server should trigger automatic failover of the read-only endpoint. + +```yaml +Type: Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AllowReadOnlyFailoverToPrimary +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverGroupName +The name of the Azure SQL Database Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FailoverPolicy +The failover policy of the Azure SQL Database Failover Group. + +```yaml +Type: Microsoft.Azure.Commands.Sql.FailoverGroup.Model.FailoverPolicy +Parameter Sets: (All) +Aliases: +Accepted values: Automatic, Manual + +Required: False +Position: Named +Default value: Automatic +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GracePeriodWithDataLossHours +Interval before automatic failover is initiated if an outage occurs on the primary server. This indicates that Azure SQL Database will not initiate automatic failover before the grace period expires. Please note that failover operation with AllowDataLoss option might cause data loss due to the nature of asynchronous synchronization. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the primary Azure SQL Database Server of the Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlDatabaseFailoverGroup](./New-AzSqlDatabaseFailoverGroup.md) + +[Get-AzSqlDatabaseFailoverGroup](./Get-AzSqlDatabaseFailoverGroup.md) + +[Add-AzSqlDatabaseToFailoverGroup](./Add-AzSqlDatabaseToFailoverGroup.md) + +[Remove-AzSqlDatabaseFromFailoverGroup](./Remove-AzSqlDatabaseFromFailoverGroup.md) + +[Switch-AzSqlDatabaseFailoverGroup](./Switch-AzSqlDatabaseFailoverGroup.md) + +[Remove-AzSqlDatabaseFailoverGroup](./Remove-AzSqlDatabaseFailoverGroup.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseGeoBackupPolicy.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseGeoBackupPolicy.md new file mode 100644 index 0000000000..da76f3d72c --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseGeoBackupPolicy.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 5A2072B4-1533-46A2-9841-5509A44DE695 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqldatabasegeobackuppolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseGeoBackupPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseGeoBackupPolicy.md +--- + +# Set-AzSqlDatabaseGeoBackupPolicy + +## SYNOPSIS +Sets a database geo backup policy. + +## SYNTAX + +``` +Set-AzSqlDatabaseGeoBackupPolicy -State <GeoBackupPolicyState> [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlDatabaseGeoBackupPolicy** cmdlet sets the geo backup policy registered to a database. +This is an Azure Backup resource that is used to define backup storage policy. + +## EXAMPLES + +### Example 1 + +Sets a database geo backup policy. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzSqlDatabaseGeoBackupPolicy -DatabaseName db1 -ResourceGroupName myresourcegroup -ServerName s1 -State Disabled +``` + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database for which this cmdlet sets the geo backup policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the server that contains this database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the state of the geo backup policy. +The acceptable values for this parameter are: +- Enabled +- Disabled + +```yaml +Type: Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseGeoBackupPolicyModel+GeoBackupPolicyState +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, Enabled + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseGeoBackupPolicyModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseGeoBackupPolicy](./Get-AzSqlDatabaseGeoBackupPolicy.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseInstanceFailoverGroup.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseInstanceFailoverGroup.md new file mode 100644 index 0000000000..a9b3a8a19d --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseInstanceFailoverGroup.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/set-Azsqldatabaseinstancefailovergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseInstanceFailoverGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseInstanceFailoverGroup.md +--- + +# Set-AzSqlDatabaseInstanceFailoverGroup + +## SYNOPSIS +Modifies the configuration of an Instance Failover Group. + +## SYNTAX + +### SetInstanceFailoverGroupDefaultSet (Default) +``` +Set-AzSqlDatabaseInstanceFailoverGroup [-ResourceGroupName] <String> [-Location] <String> [-Name] <String> + [-FailoverPolicy <String>] [-GracePeriodWithDataLossHours <Int32>] [-AllowReadOnlyFailoverToPrimary <String>] + [-SecondaryType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetInstanceFailoverGroupByResourceIdSet +``` +Set-AzSqlDatabaseInstanceFailoverGroup [-Location] <String> [-ResourceId] <String> [-FailoverPolicy <String>] + [-GracePeriodWithDataLossHours <Int32>] [-AllowReadOnlyFailoverToPrimary <String>] [-SecondaryType <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetInstanceFailoverGroupByAzureSqlInstanceFailoverGroupModelSet +``` +Set-AzSqlDatabaseInstanceFailoverGroup [-InputObject] <AzureSqlInstanceFailoverGroupModel> + [-FailoverPolicy <String>] [-GracePeriodWithDataLossHours <Int32>] [-AllowReadOnlyFailoverToPrimary <String>] + [-SecondaryType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command modifies the configuration of an Instance Failover Group. + +The Instance Failover Group's primary region should be used to execute the command. + +During preview of the Instance Failover Groups feature, only values greater than or equal to 1 hour are supported for the '-GracePeriodWithDataLossHours' parameter. + +## EXAMPLES + +### Example 1 +```powershell +$failoverGroup = Get-AzSqlDatabaseInstanceFailoverGroup -ResourceGroupName rg -Location location -Name fg | Set-AzSqlDatabaseInstanceFailoverGroup -FailoverPolicy Manual +``` + +```output +ResourceGroupName : rg +Location : East US +Name : fg +PartnerResourceGroupName : rg +PartnerRegion : West US +PrimaryManagedInstanceName : managedInstance1 +PartnerManagedInstanceName : managedInstance2 +ReplicationRole : Primary +ReplicationState : CATCH_UP +ReadWriteFailoverPolicy : Manual +FailoverWithDataLossGracePeriodHours : +ReadOnlyFailoverPolicy : Disabled +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rg/providers/Microsoft.Sql/locations/eastus/instanceFailoverGroups/fg +``` + +Sets a Instance Failover Group's failover policy to 'Manual' by piping in the Failover Group. + +## PARAMETERS + +### -AllowReadOnlyFailoverToPrimary +Whether outages on the secondary server should trigger automatic failover of the read-only endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverPolicy +The failover policy of the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GracePeriodWithDataLossHours +Interval before automatic failover is initiated if an outage occurs on the primary server and failover cannot be completed without data loss. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Instance Failover Group object to set + +```yaml +Type: Microsoft.Azure.Commands.Sql.InstanceFailoverGroup.Model.AzureSqlInstanceFailoverGroupModel +Parameter Sets: SetInstanceFailoverGroupByAzureSqlInstanceFailoverGroupModelSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The name of the Local Region from which to retrieve the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: SetInstanceFailoverGroupDefaultSet, SetInstanceFailoverGroupByResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: SetInstanceFailoverGroupDefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SetInstanceFailoverGroupDefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Resource ID of the Instance Failover Group to set. + +```yaml +Type: System.String +Parameter Sets: SetInstanceFailoverGroupByResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SecondaryType +Intended usage of the secondary instance. Standby indicates that the secondary instance will be used as a passive replica for disaster recovery only. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.InstanceFailoverGroup.Model.AzureSqlInstanceFailoverGroupModel +System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.InstanceFailoverGroup.Model.AzureSqlInstanceFailoverGroupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseRecommendedActionState.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseRecommendedActionState.md new file mode 100644 index 0000000000..ed0b8d9a16 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseRecommendedActionState.md @@ -0,0 +1,254 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: BDBA3AA3-DCC6-4C83-84C8-EE6D93BFE1D3 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqldatabaserecommendedactionstate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseRecommendedActionState.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseRecommendedActionState.md +--- + +# Set-AzSqlDatabaseRecommendedActionState + +## SYNOPSIS +Updates the state of an Azure SQL Database recommended action. + +## SYNTAX + +``` +Set-AzSqlDatabaseRecommendedActionState -RecommendedActionName <String> -State <RecommendedActionState> + -ServerName <String> -DatabaseName <String> -AdvisorName <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlDatabaseRecommendedActionState** cmdlet updates the state of an Azure SQL Database Recommended Action. +This allows a recommended action to be applied, reverted or discarded based on the new state. + +## EXAMPLES + +### Example 1: Apply a recommended action state to pending +```powershell +Set-AzSqlDatabaseRecommendedActionState -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -AdvisorName "CreateIndex" -RecommendedActionName "IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893" -State Pending +``` + +```output +DatabaseName : WIRunner + +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, + NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} +RecommendationReason : +RevertActionDuration : +RevertActionInitiatedBy : +RevertActionInitiatedTime : +RevertActionStartTime : +Score : 2 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM +``` + +This command updates the state of the recommended action named IR_\[test_schema\]_\[test_table_0.0361551\]_6C7AE8CC9C87E7FD5893 that belongs to the database named WIRunner to Pending. + +## PARAMETERS + +### -AdvisorName +Specifies the name of the advisor for which this recommended action belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database for which this cmdlet sets the recommended action state. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecommendedActionName +Specifies the name of the recommended action for which state is being updated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the server that contains this database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server the database is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the new value to which this cmdlet updates the recommended action state. +The acceptable values for this parameter are: +- Active +- Pending +- PendingRevert +- RevertCancelled +- Ignored +- Resolved + +```yaml +Type: Microsoft.Azure.Commands.Sql.RecommendedAction.Cmdlet.RecommendedActionState +Parameter Sets: (All) +Aliases: +Accepted values: Active, Pending, PendingRevert, RevertCancelled, Ignored, Resolved + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.RecommendedAction.Cmdlet.RecommendedActionState + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.RecommendedAction.Model.AzureSqlDatabaseRecommendedActionModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql, advisor, recommendedaction + +## RELATED LINKS + +[Get-AzSqlServerAdvisor](./Get-AzSqlServerAdvisor.md) + +[Get-AzSqlElasticPoolAdvisor](./Get-AzSqlElasticPoolAdvisor.md) + +[Get-AzSqlServerRecommendedAction](./Get-AzSqlServerRecommendedAction.md) + +[Get-AzSqlElasticPoolRecommendedAction](./Get-AzSqlElasticPoolRecommendedAction.md) + +[Set-AzSqlElasticPoolRecommendedActionState](./Set-AzSqlElasticPoolRecommendedActionState.md) + +[Set-AzSqlElasticPoolAdvisorAutoExecuteStatus](./Set-AzSqlElasticPoolAdvisorAutoExecuteStatus.md) + +[Set-AzSqlElasticPoolRecommendedActionState](./Set-AzSqlElasticPoolRecommendedActionState.md) + +[Set-AzSqlServerRecommendedActionState](./Set-AzSqlServerRecommendedActionState.md) + +[Set-AzSqlElasticPoolAdvisorAutoExecuteStatus](./Set-AzSqlElasticPoolAdvisorAutoExecuteStatus.md) + +[Set-AzSqlServerAdvisorAutoExecuteStatus](./Set-AzSqlServerAdvisorAutoExecuteStatus.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseSecondary.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseSecondary.md new file mode 100644 index 0000000000..ace5b27e6a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseSecondary.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: F9703508-DD4D-4D25-A7CA-7E3432B5DCA9 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqldatabasesecondary +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseSecondary.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseSecondary.md +--- + +# Set-AzSqlDatabaseSecondary + +## SYNOPSIS +Switches a secondary database to be primary in order to initiate failover. + +## SYNTAX + +### NoOptionsSet (Default) +``` +Set-AzSqlDatabaseSecondary [-DatabaseName] <String> -PartnerResourceGroupName <String> [-AsJob] + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ByFailoverParams +``` +Set-AzSqlDatabaseSecondary [-DatabaseName] <String> -PartnerResourceGroupName <String> [-Failover] + [-AllowDataLoss] [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlDatabaseSecondary** cmdlet switches a secondary database to be primary in order to initiate failover. +This cmdlet is designed as a general configuration command, but is currently limited to initiating failover. +Specify the *AllowDataLoss* parameter to initiate a force failover during an outage. +You do not have to specify this parameter when you perform a planned operation, such as recovery drill. +In the latter case, the secondary database is synchronized with the primary before it is switched. + +## EXAMPLES + +### Example 1: Initiate a planned failover +```powershell +$database = Get-AzSqlDatabase -DatabaseName $databaseName -ResourceGroupName $secondaryResourceGroupName -ServerName $secondaryServerName +$database | Set-AzSqlDatabaseSecondary -PartnerResourceGroupName $primaryResourceGroupName -Failover +``` + +### Example 2: Initiate a forced failover (with potential data loss) +```powershell +$database = Get-AzSqlDatabase -DatabaseName $databaseName -ResourceGroupName $secondaryResourceGroupName -ServerName $secondaryServerName +$database | Set-AzSqlDatabaseSecondary -PartnerResourceGroupName $primaryResourceGroupName -Failover -AllowDataLoss +``` + +## PARAMETERS + +### -AllowDataLoss +Indicates that this failover operation permits data loss. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByFailoverParams +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the Azure SQL Database Secondary. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Failover +Indicates that this operation is a failover. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ByFailoverParams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerResourceGroupName +Specifies the name of the resource group to which the partner Azure SQL Database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the Azure SQL Database Secondary is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL Server that hosts the Azure SQL Database Secondary. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Replication.Model.AzureReplicationLinkModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlDatabaseSecondary](./New-AzSqlDatabaseSecondary.md) + +[Remove-AzSqlDatabaseSecondary](./Remove-AzSqlDatabaseSecondary.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseSensitivityClassification.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseSensitivityClassification.md new file mode 100644 index 0000000000..e65e0d734a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseSensitivityClassification.md @@ -0,0 +1,301 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqldatabasesensitivityclassification +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseSensitivityClassification.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseSensitivityClassification.md +--- + +# Set-AzSqlDatabaseSensitivityClassification + +## SYNOPSIS +Sets the information types and sensitivity labels of columns in the database. + +## SYNTAX + +### ClassificationObjectParameterSet (Default) +``` +Set-AzSqlDatabaseSensitivityClassification -ClassificationObject <SqlDatabaseSensitivityClassificationModel> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Set-AzSqlDatabaseSensitivityClassification [-SensitivityLabel <String>] [-InformationType <String>] + [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> -SchemaName <String> + -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DatabaseObjectColumnParameterSet +``` +Set-AzSqlDatabaseSensitivityClassification [-SensitivityLabel <String>] [-InformationType <String>] + -DatabaseObject <AzureSqlDatabaseModel> -SchemaName <String> -TableName <String> -ColumnName <String> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzSqlDatabaseSensitivityClassification cmdlet sets the information types and sensitivity labels of columns in the database. + +## EXAMPLES + +### Example 1: Set information type and sensitivity label of a column in an Azure SQL database. +```powershell +Set-AzSqlDatabaseSensitivityClassification -ResourceGroupName resourceGroup -ServerName server -DatabaseName database -SchemaName schema -TableName table -ColumnName column -InformationType informationType -SensitivityLabel label +``` + +### Example 2: Set recommended information types and sensitivity labels of columns in an Azure SQL database. +```powershell +Get-AzSqlDatabaseSensitivityRecommendation -ResourceGroupName resourceGroup -ServerName server -DatabaseName database | Set-AzSqlDatabaseSensitivityClassification +``` + +### Example 3: Set information type and sensitivity label of a column in an Azure SQL database, using piping. +```powershell +Get-AzSqlDatabase -ResourceGroupName resourceGroup -ServerName server -DatabaseName database | Set-AzSqlDatabaseSensitivityClassification -SchemaName schema -TableName table -ColumnName column -InformationType informationType -SensitivityLabel label +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationObject +An object representing a SQL Database Sensitivity Classification. + +```yaml +Type: Microsoft.Azure.Commands.Sql.DataClassification.Model.SqlDatabaseSensitivityClassificationModel +Parameter Sets: ClassificationObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL database. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +The SQL database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InformationType +A name that describes the information type of the data stored in the column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Specifies whether to output the sensitivity classification model at end of cmdlet execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SensitivityLabel +A name that describes the sensitivity of the data stored in the column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.DataClassification.Model.SqlDatabaseSensitivityClassificationModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Learn more about Azure SQL Database data discovery and classification](https://learn.microsoft.com/azure/sql-database/sql-database-data-discovery-and-classification) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseTransparentDataEncryption.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseTransparentDataEncryption.md new file mode 100644 index 0000000000..50d368a1a6 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseTransparentDataEncryption.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 01744DBD-1991-45EF-AA92-FD471F7E7551 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqldatabasetransparentdataencryption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseTransparentDataEncryption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseTransparentDataEncryption.md +--- + +# Set-AzSqlDatabaseTransparentDataEncryption + +## SYNOPSIS +Modifies TDE property for a database. + +## SYNTAX + +``` +Set-AzSqlDatabaseTransparentDataEncryption [-State] <TransparentDataEncryptionStateType> [-ServerName] <String> + [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlDatabaseTransparentDataEncryption** cmdlet modifies the Transparent Data Encryption (TDE) property of an Azure SQL database. +For more information, see Transparent Data Encryption with Azure SQL Databasehttps://msdn.microsoft.com/library/dn948096 (https://msdn.microsoft.com/library/dn948096) in the Microsoft Developer Network Library. +This cmdlet is also supported by the SQL Server Stretch Database service on Azure. + +## EXAMPLES + +### Example 1: Enable TDE for a database +```powershell +Set-AzSqlDatabaseTransparentDataEncryption -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -State Enabled +``` + +```output +ResourceGroupName ServerName DatabaseName State +----------------- ---------- ------------ ----- +ResourceGroup01 Server01 Database01 Enabled +``` + +This command enables TDE for the database named Database01 on the server named Server01. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the value of the TDE property. +The acceptable values for this parameter are: +- Enabled +- Disabled + +```yaml +Type: Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.TransparentDataEncryptionStateType +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.TransparentDataEncryptionStateType + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseTransparentDataEncryption](./Get-AzSqlDatabaseTransparentDataEncryption.md) + +[Get-AzSqlDatabaseTransparentDataEncryptionActivity](./Get-AzSqlDatabaseTransparentDataEncryptionActivity.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md new file mode 100644 index 0000000000..a61ad01df8 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md @@ -0,0 +1,307 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqldatabasevulnerabilityassessmentrulebaseline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md +--- + +# Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline + +## SYNOPSIS +Sets the vulnerability assessment rule baseline. + +## SYNTAX + +``` +Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline [-ServerName] <String> [-DatabaseName] <String> + [-InputObject <VulnerabilityAssessmentRuleBaselineModel>] -BaselineResult <String[][]> -RuleId <String> + [-RuleAppliesToMaster] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline** cmdlet sets the vulnerability assessment rule baseline. +As you review your assessment results, you can mark specific results as being an acceptable Baseline in your environment. The baseline is essentially a customization of how the results are reported. Results that match the baseline are considered as passing in subsequent scans. Once you have established your baseline security state, vulnerability assessment only reports on deviations from the baseline, and you can focus your attention on the relevant issues. +Note that you need to run *Enable-AzSqlServerAdvancedDataSecurity* and *Update-AzSqlServerVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1: Set a vulnerability assessment rule baseline +<!-- Skip: Output cannot be splitted from code --> +```powershell +Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ahmadtesting" ` + -ServerName "ahmadpilotserver" ` + -DatabaseName "AhmadPilotDb" ` + -BaselineResult @(,@('dbo', 'db_owner', 'SQL_USER', 'INSTANCE')) ` + -RuleID 'VA2108' + +Rule ID Rule Applies To Master Baseline Results +------- ---------------------- ---------------- +VA2108 False {dbo;db_owner;SQL_USER;INSTANCE} + +$arrayList = [System.Collections.ArrayList]::new() +$arrayList.Add(@('dbo', 'db_owner', 'SQL_USER', 'INSTANCE')) + +Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "demoresourcegroup" ` + -ServerName "demosqlser" ` + -DatabaseName "SQL_ERConnect" ` + -BaselineResult $arrayList ` + -RuleID 'VA2108' + + +Rule ID Rule Applies To Master Baseline Results +------- ---------------------- ---------------- +VA2108 False {dbo;db_owner;SQL_USER;INSTANCE} + +Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + -RuleId "VA2108" ` + -RuleAppliesToMaster ` + -BaselineResult @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') + +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +RuleId : VA2108 +RuleAppliesToMaster : True +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +BaselineResult value is a composition of several sub arrays that described the T-SQL results that will be added to the baseline. +Notice the special PS syntax for defining array of arrays with one result using an opening comma. +You may find the Scan results under the storage defined by the Set-AzSqlServerVulnerabilityAssessmentSettings cmdlet, under scans/{ServerName}/{DatabaseName}/scan_{ScanId}.json + +### Example 2: Set a vulnerability assessment rule baseline from a baseline object +```powershell +Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + -RuleId "VA2108" ` + -BaselineResult @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') + +Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + -RuleId "VA2108" ` + | Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ResourceGroup02" ` + -ServerName "Server02" ` + -DatabaseName "Database02" +``` + +```output +ResourceGroupName : ResourceGroup02 +ServerName : Server02 +DatabaseName : Database02 +RuleId : VA2108 +RuleAppliesToMaster : False +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +### Example 3: Set a vulnerability assessment rule baseline on all the databases under a server +```powershell +Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + | Where-Object {$_.DatabaseName -ne "master"} ` + | Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline ` + -RuleId "VA2108" ` + -BaselineResult @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +RuleId : VA2108 +RuleAppliesToMaster : False +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') + +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database02 +RuleId : VA2108 +RuleAppliesToMaster : False +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +## PARAMETERS + +### -BaselineResult +The results to set as baseline for the rule in all future scans + +```yaml +Type: System.String[][] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Vulnerability Assessment rule baseline object to set + +```yaml +Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentRuleBaselineModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleAppliesToMaster +Specifies that the baseline should apply to the master database. +This is required only when database level settings specify a storage account that is different from the one specified in the server level settings. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleId +The rule ID which identifies the rule to set the baseline results to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentRuleBaselineModel + +### System.String[][] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentRuleBaselineModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlElasticJob.md b/azps-10.1.0/Az.Sql/Set-AzSqlElasticJob.md new file mode 100644 index 0000000000..af85069d6b --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlElasticJob.md @@ -0,0 +1,360 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/set-Azsqlelasticjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticJob.md +--- + +# Set-AzSqlElasticJob + +## SYNOPSIS +Updates a job + +## SYNTAX + +### DefaultSet (Default) +``` +Set-AzSqlElasticJob [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> [-Name] <String> + [-StartTime <DateTime>] [-EndTime <DateTime>] [-Enable] [-Description <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RunOnce +``` +Set-AzSqlElasticJob [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> [-Name] <String> + [-RunOnce] [-StartTime <DateTime>] [-EndTime <DateTime>] [-Enable] [-Description <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Recurring +``` +Set-AzSqlElasticJob [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> [-Name] <String> + -IntervalType <String> -IntervalCount <UInt32> [-StartTime <DateTime>] [-EndTime <DateTime>] [-Enable] + [-Description <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectSet +``` +Set-AzSqlElasticJob [-InputObject] <AzureSqlElasticJobModel> [-StartTime <DateTime>] [-EndTime <DateTime>] + [-Enable] [-Description <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RunOnceUsingParentObject +``` +Set-AzSqlElasticJob [-InputObject] <AzureSqlElasticJobModel> [-RunOnce] [-StartTime <DateTime>] + [-EndTime <DateTime>] [-Enable] [-Description <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### RecurringUsingParentObject +``` +Set-AzSqlElasticJob [-InputObject] <AzureSqlElasticJobModel> -IntervalType <String> -IntervalCount <UInt32> + [-StartTime <DateTime>] [-EndTime <DateTime>] [-Enable] [-Description <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzSqlElasticJob [-ResourceId] <String> [-StartTime <DateTime>] [-EndTime <DateTime>] [-Enable] + [-Description <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RunOnceUsingParentResourceId +``` +Set-AzSqlElasticJob [-ResourceId] <String> [-RunOnce] [-StartTime <DateTime>] [-EndTime <DateTime>] [-Enable] + [-Description <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RecurringUsingParentResourceId +``` +Set-AzSqlElasticJob [-ResourceId] <String> -IntervalType <String> -IntervalCount <UInt32> + [-StartTime <DateTime>] [-EndTime <DateTime>] [-Enable] [-Description <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzSqlElasticJob cmdlet updates a job + +## EXAMPLES + +### Example 1: Updates a job to start an hour from now and repeat every 1 hour +```powershell +$job = Get-AzSqlElasticJob -ResourceGroupName rg -ServerName elasticjobserver -AgentName agent -Name job1 +$job | Set-AzSqlElasticJob -IntervalType Hour -IntervalCount 1 -StartTime (Get-Date).AddHours(1) -Enable +``` + +```output +JobName Version Description StartTime EndTime ScheduleType Interval Enabled +------- ------- ----------- --------- ------- ------------ -------- ------- +job1 0 6/1/2018 10:50:15 PM 12/31/9999 11:59:59 AM Recurring PT1H True +``` + +Updates a job + +### Example 2 + +<!-- Aladdin Generated Example --> +```powershell +Set-AzSqlElasticJob -AgentName agent -Enable -IntervalCount 1 -IntervalType Hour -Name step1 -ResourceGroupName MyResourceGroup -ServerName s1 -StartTime '9/16/2016 11:31:12' +``` + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, RunOnce, Recurring +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The job description + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +The flag to indicate customer wants this job to be enabled. + +```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 +``` + +### -EndTime +The job schedule end time + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The job input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel +Parameter Sets: ObjectSet, RunOnceUsingParentObject, RecurringUsingParentObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntervalCount +The recurring schedule interval count + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: Recurring, RecurringUsingParentObject, RecurringUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntervalType +The recurring schedule interval type - Can be Minute, Hour, Day, Week, Month + +```yaml +Type: System.String +Parameter Sets: Recurring, RecurringUsingParentObject, RecurringUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The job name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, RunOnce, Recurring +Aliases: JobName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, RunOnce, Recurring +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The job resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet, RunOnceUsingParentResourceId, RecurringUsingParentResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunOnce +The flag to indicate job will be run once + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RunOnce, RunOnceUsingParentObject, RunOnceUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, RunOnce, Recurring +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +The job schedule start time + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlElasticJobAgent.md b/azps-10.1.0/Az.Sql/Set-AzSqlElasticJobAgent.md new file mode 100644 index 0000000000..ec27b5d489 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlElasticJobAgent.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/set-Azsqlelasticjobagent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticJobAgent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticJobAgent.md +--- + +# Set-AzSqlElasticJobAgent + +## SYNOPSIS +Updates an elastic job agent + +## SYNTAX + +### DefaultSet (Default) +``` +Set-AzSqlElasticJobAgent [-ResourceGroupName] <String> [-ServerName] <String> [-Name] <String> + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectSet +``` +Set-AzSqlElasticJobAgent [-InputObject] <AzureSqlElasticJobAgentModel> [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzSqlElasticJobAgent [-ResourceId] <String> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzSqlElasticJobAgent cmdlet updates an Elastic Job agents + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent -Tag @{ Octopus = "Agent" } +``` + +```output +ResourceGroupName ServerName DatabaseName AgentName State Tags +----------------- ---------- ------------ --------- ----- ---- +rg elasticjobserver jobdb agent Ready {[Octopus, Agent]} +``` + +Updates an Elastic Job agent + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The agent input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: AgentName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The agent resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to associate with the Azure SQL Database Agent + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlElasticJobCredential.md b/azps-10.1.0/Az.Sql/Set-AzSqlElasticJobCredential.md new file mode 100644 index 0000000000..43d29e3793 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlElasticJobCredential.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/set-Azsqlelasticjobcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticJobCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticJobCredential.md +--- + +# Set-AzSqlElasticJobCredential + +## SYNOPSIS +Updates a job credential + +## SYNTAX + +### DefaultSet (Default) +``` +Set-AzSqlElasticJobCredential [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-Name] <String> -Credential <PSCredential> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectSet +``` +Set-AzSqlElasticJobCredential [-InputObject] <AzureSqlElasticJobCredentialModel> -Credential <PSCredential> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzSqlElasticJobCredential [-ResourceId] <String> -Credential <PSCredential> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzSqlElasticJobCredential cmdlet updates a job credential + +## EXAMPLES + +### Example 1 +```powershell +$cred = Get-AzSqlElasticJobCredential -ResourceGroupName rg -ServerName elasticjobserver -AgentName agent -Name cred1 +$cred | Set-AzSqlElasticJobCredential -Name cred1 -Credential (Get-Credential) +``` + +```output +CredentialName UserName +-------------- -------- +cred1 user2 +``` + +Updates a job credential + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +The credential + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The job credential object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobCredentialModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The job credential name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: CredentialName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The job credential resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.Management.Automation.PSCredential +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobCredentialModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobCredentialModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlElasticJobStep.md b/azps-10.1.0/Az.Sql/Set-AzSqlElasticJobStep.md new file mode 100644 index 0000000000..a10a5e0454 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlElasticJobStep.md @@ -0,0 +1,536 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/set-Azsqlelasticjobstep +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticJobStep.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticJobStep.md +--- + +# Set-AzSqlElasticJobStep + +## SYNOPSIS +Updates a job step + +## SYNTAX + +### DefaultSet (Default) +``` +Set-AzSqlElasticJobStep [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> -Name <String> [-OutputDatabaseObject <AzureSqlDatabaseModel>] + [-OutputCredentialName <String>] [-OutputTableName <String>] [-OutputSchemaName <String>] + [-TargetGroupName <String>] [-CredentialName <String>] [-CommandText <String>] [-StepId <Int32>] + [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] + [-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WithRemoveOutput +``` +Set-AzSqlElasticJobStep [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> -Name <String> [-RemoveOutput] [-TargetGroupName <String>] [-CredentialName <String>] + [-CommandText <String>] [-StepId <Int32>] [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] + [-InitialRetryIntervalSeconds <Int32>] [-MaximumRetryIntervalSeconds <Int32>] + [-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### WithAddOutput +``` +Set-AzSqlElasticJobStep [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> -Name <String> -OutputDatabaseResourceId <String> [-OutputCredentialName <String>] + [-OutputTableName <String>] [-OutputSchemaName <String>] [-TargetGroupName <String>] + [-CredentialName <String>] [-CommandText <String>] [-StepId <Int32>] [-TimeoutSeconds <Int32>] + [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] [-MaximumRetryIntervalSeconds <Int32>] + [-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectSet +``` +Set-AzSqlElasticJobStep [-InputObject] <AzureSqlElasticJobStepModel> + [-OutputDatabaseObject <AzureSqlDatabaseModel>] [-OutputCredentialName <String>] [-OutputTableName <String>] + [-OutputSchemaName <String>] [-TargetGroupName <String>] [-CredentialName <String>] [-CommandText <String>] + [-StepId <Int32>] [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] + [-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WithRemoveOutputUsingParentObject +``` +Set-AzSqlElasticJobStep [-InputObject] <AzureSqlElasticJobStepModel> [-RemoveOutput] + [-TargetGroupName <String>] [-CredentialName <String>] [-CommandText <String>] [-StepId <Int32>] + [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] + [-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WithAddOutputUsingParentObject +``` +Set-AzSqlElasticJobStep [-InputObject] <AzureSqlElasticJobStepModel> -OutputDatabaseResourceId <String> + [-OutputCredentialName <String>] [-OutputTableName <String>] [-OutputSchemaName <String>] + [-TargetGroupName <String>] [-CredentialName <String>] [-CommandText <String>] [-StepId <Int32>] + [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] + [-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Set-AzSqlElasticJobStep [-ResourceId] <String> [-OutputDatabaseObject <AzureSqlDatabaseModel>] + [-OutputCredentialName <String>] [-OutputTableName <String>] [-OutputSchemaName <String>] + [-TargetGroupName <String>] [-CredentialName <String>] [-CommandText <String>] [-StepId <Int32>] + [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] + [-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WithRemoveOutputUsingParentResourceId +``` +Set-AzSqlElasticJobStep [-ResourceId] <String> [-RemoveOutput] [-TargetGroupName <String>] + [-CredentialName <String>] [-CommandText <String>] [-StepId <Int32>] [-TimeoutSeconds <Int32>] + [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] [-MaximumRetryIntervalSeconds <Int32>] + [-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### WithAddOutputUsingParentResourceId +``` +Set-AzSqlElasticJobStep [-ResourceId] <String> -OutputDatabaseResourceId <String> + [-OutputCredentialName <String>] [-OutputTableName <String>] [-OutputSchemaName <String>] + [-TargetGroupName <String>] [-CredentialName <String>] [-CommandText <String>] [-StepId <Int32>] + [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] + [-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzSqlElasticJobStep cmdlet updates a job step + +## EXAMPLES + +### Example 1: Updates a job step's target group for a job +```powershell +$jobStep = Get-AzSqlElasticJobStep -ResourceGroupName rg -ServerName elasticjobserver -AgentName agent -JobName job1 -StepName step1 +$jobStep | Set-AzSqlElasticJobStep -TargetGroupName tg2 +``` + +```output +JobName StepName StepId TargetGroupName CredentialName Output ExecutionOptions CommandText +------- -------- ------ --------------- -------------- ------ ---------------- ----------- +job1 step1 1 tg2 cred1 (43200,10,1,120,2) SELECT 1 +``` + +### Example 2: Updates a job step's T-SQL script for a job +```powershell +$jobStep = Get-AzSqlElasticJobStep -ResourceGroupName rg -ServerName elasticjobserver -AgentName agent -JobName job1 -StepName step1 +$jobStep | Set-AzSqlElasticJobStep -CommandText "SELECT 2" +``` + +```output +JobName StepName StepId TargetGroupName CredentialName Output ExecutionOptions CommandText +------- -------- ------ --------------- -------------- ------ ---------------- ----------- +job1 step1 1 tg1 cred1 (43200,10,1,120,2) SELECT 2 +``` + +Updates a job step from a job + +### Example 3 + +<!-- Aladdin Generated Example --> +```powershell +Set-AzSqlElasticJobStep -AgentName agent -CommandText 'SELECT 2' -JobName job1 -Name step1 -ResourceGroupName MyResourceGroup -ServerName s1 +``` + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithRemoveOutput, WithAddOutput +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandText +The command text + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialName +The credential name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialRetryIntervalSeconds +The initial retry interval seconds + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The job step object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobStepModel +Parameter Sets: ObjectSet, WithRemoveOutputUsingParentObject, WithAddOutputUsingParentObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The job name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithRemoveOutput, WithAddOutput +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaximumRetryIntervalSeconds +The maximum retry interval seconds + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The step name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithRemoveOutput, WithAddOutput +Aliases: StepName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputCredentialName +The output credential name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithAddOutput, ObjectSet, WithAddOutputUsingParentObject, ResourceIdSet, WithAddOutputUsingParentResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputDatabaseObject +The output database object + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: DefaultSet, ObjectSet, ResourceIdSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputDatabaseResourceId +The output database resource id + +```yaml +Type: System.String +Parameter Sets: WithAddOutput, WithAddOutputUsingParentObject, WithAddOutputUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputSchemaName +The output schema name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithAddOutput, ObjectSet, WithAddOutputUsingParentObject, ResourceIdSet, WithAddOutputUsingParentResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputTableName +The output table name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithAddOutput, ObjectSet, WithAddOutputUsingParentObject, ResourceIdSet, WithAddOutputUsingParentResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveOutput +The flag to indicate whether to remove output + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WithRemoveOutput, WithRemoveOutputUsingParentObject, WithRemoveOutputUsingParentResourceId +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithRemoveOutput, WithAddOutput +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The job step resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet, WithRemoveOutputUsingParentResourceId, WithAddOutputUsingParentResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetryAttempts +The retry attemps + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetryIntervalBackoffMultiplier +The retry interval backoff multiplier + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet, WithRemoveOutput, WithAddOutput +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StepId +The step id text + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetGroupName +The target group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutSeconds +The timeout seconds + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobStepModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobStepModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlElasticPool.md b/azps-10.1.0/Az.Sql/Set-AzSqlElasticPool.md new file mode 100644 index 0000000000..e0758b8566 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlElasticPool.md @@ -0,0 +1,510 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 555D58AB-1361-4BB1-ACD0-905C3C6F4F7E +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlelasticpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticPool.md +--- + +# Set-AzSqlElasticPool + +## SYNOPSIS +Modifies properties of an elastic database pool in Azure SQL Database. + +## SYNTAX + +### DtuBasedPool (Default) +``` +Set-AzSqlElasticPool [-ElasticPoolName] <String> [-Edition <String>] [-Dtu <Int32>] [-StorageMB <Int32>] + [-DatabaseDtuMin <Int32>] [-DatabaseDtuMax <Int32>] [-Tags <Hashtable>] [-ZoneRedundant] + [-LicenseType <String>] [-MaintenanceConfigurationId <String>] [-HighAvailabilityReplicaCount <Int32>] + [-PreferredEnclaveType <String>] [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### VcoreBasedPool +``` +Set-AzSqlElasticPool [-ElasticPoolName] <String> [-Edition <String>] [-StorageMB <Int32>] [-VCore <Int32>] + [-ComputeGeneration <String>] [-DatabaseVCoreMin <Double>] [-DatabaseVCoreMax <Double>] [-Tags <Hashtable>] + [-ZoneRedundant] [-LicenseType <String>] [-MaintenanceConfigurationId <String>] + [-HighAvailabilityReplicaCount <Int32>] [-PreferredEnclaveType <String>] [-AsJob] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlElasticPool** cmdlet sets properties for an elastic pool in Azure SQL Database. This cmdlet can modify the eDTUs per pool (*Dtu*), storage max size per pool (*StorageMB*), maximum eDTUs per database (*DatabaseDtuMax*), and minimum eDTUs per database (*DatabaseDtuMin*). +Several parameters (*-Dtu, -DatabaseDtuMin, and -DatabaseDtuMax*) require the value being set is from the list of valid values for that parameter. For example, -DatabaseDtuMax for a Standard 100 eDTU pool can only be set to 10, 20, 50, or 100. For details about which values are valid, see the table for your specific size pool in [elastic pools](https://learn.microsoft.com/azure/sql-database/sql-database-elastic-pool). + +## EXAMPLES + +### Example 1: Modify properties for an elastic pool +```powershell +Set-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -Dtu 1000 -DatabaseDtuMax 100 -DatabaseDtuMin 20 +``` + +```output +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/Server01/elasticPools/ElasticPool01 +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +ElasticPoolName : ElasticPool01 +Location : Central US +CreationDate : 8/26/2015 10:00:17 PM +State : Ready +Edition : Standard +Dtu : 200 +DatabaseDtuMax : 100 +DatabaseDtuMin : 20 +StorageMB : 204800 +Tags : +``` + +This command modifies properties for an elastic pool named elasticpool01. The command sets the +number of DTUs for the elastic pool to 1000 and sets the minimum and maximum DTUs. + +### Example 2: Modify the storage max size of an elastic pool +```powershell +Set-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -StorageMB 2097152 +``` + +```output +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/Server01/elasticPools/ElasticPool01 +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +ElasticPoolName : ElasticPool01 +Location : Central US +CreationDate : 8/26/2015 10:00:17 PM +State : Ready +Edition : Premium +Dtu : 200 +DatabaseDtuMax : 100 +DatabaseDtuMin : 20 +StorageMB : 2097152 +Tags : +``` + +This command modifies properties for an elastic pool named elasticpool01. The command sets the max +storage for an elastic pool to 2 TB. + +### Example 3 + +Modifies properties of an elastic database pool in Azure SQL Database. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzSqlElasticPool -Dtu 1000 -Edition 'GeneralPurpose' -ElasticPoolName 'ElasticPool01' -ResourceGroupName 'ResourceGroup01' -ServerName 'Server01' +``` + +### Example 4: Modify the preferred enclave type of an elastic pool to VBS + +```powershell +Set-AzSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -PreferredEnclaveType "VBS" +``` + +```output +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/Server01/elasticPools/ElasticPool01 +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +ElasticPoolName : ElasticPool01 +Location : Central US +CreationDate : 8/26/2015 10:00:17 PM +State : Ready +Edition : Premium +Dtu : 200 +DatabaseDtuMax : 100 +DatabaseDtuMin : 20 +StorageMB : 2097152 +PreferredEnclaveType : VBS +Tags : +``` + +This command updates an elastic pool to configure VBS enclave on it + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeGeneration +The compute generation to assign. + +```yaml +Type: System.String +Parameter Sets: VcoreBasedPool +Aliases: Family + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseDtuMax +Specifies the maximum number of DTUs that any single database in the pool can consume. +For details about which values are valid, see the table for your specific size pool in [elastic pools](https://learn.microsoft.com/azure/sql-database/sql-database-elastic-pool). +The default +values for different editions are as follows: +- Basic. 5 DTUs +- Standard. 100 DTUs +- Premium. 125 DTUs + +```yaml +Type: System.Int32 +Parameter Sets: DtuBasedPool +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseDtuMin +Specifies the minimum number of DTUs that the elastic pool guarantees to all the databases in the pool. +For details about which values are valid, see the table for your specific size pool in [elastic pools](https://learn.microsoft.com/azure/sql-database/sql-database-elastic-pool). +The default value is zero (0). + +```yaml +Type: System.Int32 +Parameter Sets: DtuBasedPool +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseVCoreMax +The maximum VCore number any SqlAzure Database can consume in the pool. + +```yaml +Type: System.Double +Parameter Sets: VcoreBasedPool +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseVCoreMin +The minimum VCore number any SqlAzure Database can consume in the pool. + +```yaml +Type: System.Double +Parameter Sets: VcoreBasedPool +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Dtu +Specifies the total number of shared DTUs for the elastic pool. +For details about which values are valid, see the table for your specific size pool in [elastic pools](https://learn.microsoft.com/azure/sql-database/sql-database-elastic-pool). +The default values for different +editions are as follows: +- Basic. 100 DTUs +- Standard. 100 DTUs +- Premium. 125 DTUs + +```yaml +Type: System.Int32 +Parameter Sets: DtuBasedPool +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Edition +Specifies the edition of the Azure SQL Database for the elastic pool. You cannot change the +edition. The acceptable values for this parameter are: +- None +- Basic +- Standard +- Premium +- DataWarehouse +- Free +- Stretch +- GeneralPurpose +- BusinessCritical + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies the name of the elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -HighAvailabilityReplicaCount +The total number of high availability replicas associated with the elastic pool. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +The license type for the Azure Sql database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceConfigurationId +The Maintenance configuration id for the SQL Elastic Pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredEnclaveType +The preferred enclave type for the Azure SQL Elastic Pool. Possible values are Default and VBS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the elastic pool is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that hosts the elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageMB +Specifies the storage limit, in megabytes, for the elastic pool. For more information, see the +New-AzSqlElasticPool cmdlet. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +Specifies a dictionary of Key-value pairs that this cmdlet associates with the elastic pool in the +form of a hash table. For example: +`@{key0="value0";"key 1"=$null;key2="value2"}` + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VCore +The total shared number of Vcore for the Sql Azure Elastic Pool. + +```yaml +Type: System.Int32 +Parameter Sets: VcoreBasedPool +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +The zone redundancy to associate with the Azure Sql Elastic Pool + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlElasticPool](./Get-AzSqlElasticPool.md) + +[Get-AzSqlElasticPoolActivity](./Get-AzSqlElasticPoolActivity.md) + +[Get-AzSqlElasticPoolDatabase](./Get-AzSqlElasticPoolDatabase.md) + +[New-AzSqlElasticPool](./New-AzSqlElasticPool.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlElasticPoolAdvisorAutoExecuteStatus.md b/azps-10.1.0/Az.Sql/Set-AzSqlElasticPoolAdvisorAutoExecuteStatus.md new file mode 100644 index 0000000000..1bbad4f46f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlElasticPoolAdvisorAutoExecuteStatus.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: BAA0781E-DC02-4AAF-A039-9B71B67E6696 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlelasticpooladvisorautoexecutestatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticPoolAdvisorAutoExecuteStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticPoolAdvisorAutoExecuteStatus.md +--- + +# Set-AzSqlElasticPoolAdvisorAutoExecuteStatus + +## SYNOPSIS +Updates auto execute status of an Azure SQL Elastic Pool Advisor. + +## SYNTAX + +``` +Set-AzSqlElasticPoolAdvisorAutoExecuteStatus -AdvisorName <String> + -AutoExecuteStatus <AdvisorAutoExecuteStatus> -ServerName <String> -ElasticPoolName <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlElasticPoolAdvisorAutoExecuteStatus** cmdlet sets auto execute property for an Azure SQL Elastic Pool Advisor. + +## EXAMPLES + +### Example 1: Enable auto execute for an advisor +```powershell +Set-AzSqlElasticPoolAdvisorAutoExecuteStatus -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -AdvisorName "CreateIndex" -AutoExecuteStatus Enabled +``` + +```output +'Enabled'ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Enabled +AutoExecuteStatusInheritedFrom : ElasticPool +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {} +``` + +This command sets the auto execute status of an advisor named CreateIndex to enabled. + +## PARAMETERS + +### -AdvisorName +Specifies the name of the advisor for which this cmdlet updates the auto execute status. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutoExecuteStatus +Specifies a new value to which this cmdlet updates the auto execute status. +The acceptable values for this parameter are: +- Enabled +- Disabled +- Default + +```yaml +Type: Microsoft.Azure.Commands.Sql.Advisor.Cmdlet.AdvisorAutoExecuteStatus +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled, Default + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies the name of the elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the server that contains this elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server the elastic pool is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Advisor.Cmdlet.AdvisorAutoExecuteStatus + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Advisor.Model.AzureSqlElasticPoolAdvisorModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, elastic pool, mssql, advisor + +## RELATED LINKS + +[Get-AzSqlElasticPoolAdvisor](./Get-AzSqlElasticPoolAdvisor.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlElasticPoolRecommendedActionState.md b/azps-10.1.0/Az.Sql/Set-AzSqlElasticPoolRecommendedActionState.md new file mode 100644 index 0000000000..0c80af98de --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlElasticPoolRecommendedActionState.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: EFDFCE12-F39C-4F52-9962-4601F0C4FD47 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlelasticpoolrecommendedactionstate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticPoolRecommendedActionState.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlElasticPoolRecommendedActionState.md +--- + +# Set-AzSqlElasticPoolRecommendedActionState + +## SYNOPSIS +Updates the state of an Azure SQL Elastic Pool recommended action. + +## SYNTAX + +``` +Set-AzSqlElasticPoolRecommendedActionState -RecommendedActionName <String> -State <RecommendedActionState> + -ServerName <String> -ElasticPoolName <String> -AdvisorName <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlElasticPoolRecommendedActionState** cmdlet updates state of an Azure SQL Elastic Pool recommended action. +This cmdlet applies an recommended action, reverted, or discarded based on the new state. + +## EXAMPLES + +### Example 1: Update the state of a recommended action to Pending +```powershell +Set-AzSqlElasticPoolRecommendedActionState -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -AdvisorName "CreateIndex" -RecommendedActionName "IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893" -State Pending +``` + +```output +ElasticPoolName : WIRunnerPool +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, + NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} +RecommendationReason : +RevertActionDuration : +RevertActionInitiatedBy : +RevertActionInitiatedTime : +RevertActionStartTime : +Score : 2 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM +``` + +This command updates the state of elastic pool recommended action named IR_\[test_schema\]_\[test_table_0.0361551\]_6C7AE8CC9C87E7FD5893 to Pending. + +## PARAMETERS + +### -AdvisorName +Specifies the name of the advisor for which this recommended action belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +Specifies name of the elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecommendedActionName +Specifies the name of the recommended action for which this cmdlet updates the state. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the server that contains this elastic pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server the elastic pool is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the value to which this cmdlet updates the recommended action state. +The acceptable values for this parameter are: +- Active +- Pending +- PendingRevert +- RevertCancelled +- Ignored +- Resolved + +```yaml +Type: Microsoft.Azure.Commands.Sql.RecommendedAction.Cmdlet.RecommendedActionState +Parameter Sets: (All) +Aliases: +Accepted values: Active, Pending, PendingRevert, RevertCancelled, Ignored, Resolved + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.RecommendedAction.Cmdlet.RecommendedActionState + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.RecommendedAction.Model.AzureSqlElasticPoolRecommendedActionModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, elasticpool, mssql, advisor, recommendedaction + +## RELATED LINKS + +[Get-AzSqlElasticPoolRecommendedAction](./Get-AzSqlElasticPoolRecommendedAction.md) + +[Set-AzSqlDatabaseRecommendedActionState](./Set-AzSqlDatabaseRecommendedActionState.md) + +[Set-AzSqlServerRecommendedActionState](./Set-AzSqlServerRecommendedActionState.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlInstance.md b/azps-10.1.0/Az.Sql/Set-AzSqlInstance.md new file mode 100644 index 0000000000..8c14779169 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlInstance.md @@ -0,0 +1,786 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstance.md +--- + +# Set-AzSqlInstance + +## SYNOPSIS +Sets properties for an Azure SQL Managed Instance. + +## SYNTAX + +### SetInstanceFromInputParameters (Default) +``` +Set-AzSqlInstance [-Name] <String> [-ResourceGroupName] <String> [-AdministratorPassword <SecureString>] + [-Edition <String>] [-SubnetId <String>] [-LicenseType <String>] [-StorageSizeInGB <Int32>] [-VCore <Int32>] + [-PublicDataEndpointEnabled <Boolean>] [-ProxyOverride <String>] [-Tag <Hashtable>] [-AssignIdentity] + [-InstancePoolName <String>] [-MinimalTlsVersion <String>] [-PrimaryUserAssignedIdentityId <String>] + [-KeyId <String>] [-Force] [-ComputeGeneration <String>] [-MaintenanceConfigurationId <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] [-IdentityType <String>] + [-BackupStorageRedundancy <String>] [-AsJob] [-ZoneRedundant] [-ServicePrincipalType <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetInstanceFromAzureSqlManagedInstanceModelInstanceDefinition +``` +Set-AzSqlInstance [-InputObject] <AzureSqlManagedInstanceModel> [-AdministratorPassword <SecureString>] + [-Edition <String>] [-SubnetId <String>] [-LicenseType <String>] [-StorageSizeInGB <Int32>] [-VCore <Int32>] + [-PublicDataEndpointEnabled <Boolean>] [-ProxyOverride <String>] [-Tag <Hashtable>] [-AssignIdentity] + [-InstancePoolName <String>] [-MinimalTlsVersion <String>] [-PrimaryUserAssignedIdentityId <String>] + [-KeyId <String>] [-Force] [-ComputeGeneration <String>] [-MaintenanceConfigurationId <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] [-IdentityType <String>] + [-BackupStorageRedundancy <String>] [-AsJob] [-ZoneRedundant] [-ServicePrincipalType <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetInstanceFromAzureResourceId +``` +Set-AzSqlInstance [-ResourceId] <String> [-AdministratorPassword <SecureString>] [-Edition <String>] + [-SubnetId <String>] [-LicenseType <String>] [-StorageSizeInGB <Int32>] [-VCore <Int32>] + [-PublicDataEndpointEnabled <Boolean>] [-ProxyOverride <String>] [-Tag <Hashtable>] [-AssignIdentity] + [-InstancePoolName <String>] [-MinimalTlsVersion <String>] [-PrimaryUserAssignedIdentityId <String>] + [-KeyId <String>] [-Force] [-ComputeGeneration <String>] [-MaintenanceConfigurationId <String>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] [-IdentityType <String>] + [-BackupStorageRedundancy <String>] [-AsJob] [-ZoneRedundant] [-ServicePrincipalType <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlInstance** cmdlet modifies properties of an Azure SQL Managed instance. + +## EXAMPLES + +### Example 1: Set existing instance using new values for -AdministratorPassword, -LicenseType, -StorageSizeInGB, -VCore and -Edition +```powershell +$InstancePassword = "Newpassword1234" +$SecureString = ConvertTo-SecureString $InstancePassword -AsPlainText -Force +Set-AzSqlInstance -Name "managedinstance1" -ResourceGroupName "ResourceGroup01" -AdministratorPassword $SecureString -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 16 -Edition BusinessCritical +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 16 +StorageSizeInGB : 1024 +InstancePoolName : +``` + +### Example 2: Change existing instance hardware generation using new value for -ComputeGeneration +```powershell +Set-AzSqlInstance -Name "managedinstance1" -ResourceGroupName "ResourceGroup01" -ComputeGeneration Gen5 +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 16 +StorageSizeInGB : 1024 +InstancePoolName : +``` + +This command sets existing instance using new values for -AdministratorPassword, -LicenseType, -StorageSizeInGB and -VCore + +### Example 3: Set existing instance using new values for -AdministratorPassword, -LicenseType, -StorageSizeInGB and -VCore for an instance within an instance pool +```powershell +$InstancePassword = "Newpassword1234" +$SecureString = ConvertTo-SecureString $InstancePassword -AsPlainText -Force +Set-AzSqlInstance -Name "managedinstance1" -ResourceGroupName "ResourceGroup01" -AdministratorPassword $SecureString -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 2 -InstancePoolName instancePool0 +``` + +```output +Location : westcentralus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 2 +StorageSizeInGB : 1024 +InstancePoolName : instancePool0 +``` + +This command sets existing instance using new values for -AdministratorPassword, -LicenseType, -StorageSizeInGB and -VCore for an instance within an instance pool + +### Example 4: Update maintenance configuration for existing instance +```powershell +Set-AzSqlInstance -Name "managedInstance1" -ResourceGroupName "resourcegroup01" -MaintenanceConfigurationId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestUS_MI_2" +``` + +```output +Location : westus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 8 +StorageSizeInGB : 256 +Collation : SQL_Latin1_General_CP1_CI_AS +PublicDataEndpointEnabled : False +ProxyOverride : +TimezoneId : UTC +DnsZonePartner : +DnsZone : ad35cna0mw +InstancePoolName : +MinimalTlsVersion : +BackupStorageRedundancy : Geo +CurrentBackupStorageRedundancy : Geo +MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestUS_MI_2 +``` + +This command updates existing instance with maintenance configuration MI_2 + +### Example 5: Remove maintenance configuration from existing instance +```powershell +Set-AzSqlInstance -Name "managediInstance1" -ResourceGroupName "Resourcegroup01" -MaintenanceConfigurationId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default" +``` + +```output +Location : westus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +LicenseType : LicenseIncluded +VCores : 8 +StorageSizeInGB : 256 +Collation : SQL_Latin1_General_CP1_CI_AS +PublicDataEndpointEnabled : False +ProxyOverride : +TimezoneId : UTC +DnsZonePartner : +DnsZone : ad35cna0mw +InstancePoolName : +MinimalTlsVersion : +BackupStorageRedundancy : Geo +CurrentBackupStorageRedundancy : Geo +MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default +``` + +This command resets maintenance configuration to default for existing instance + +### Example 6: Move managed instance to another subnet +```powershell +Set-AzSqlInstance -Name "managediInstance1" -ResourceGroupName "Resourcegroup01" -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/target_subnet_name" +``` + +```output +Location : westus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/target_subnet_name +LicenseType : LicenseIncluded +VCores : 8 +StorageSizeInGB : 256 +Collation : SQL_Latin1_General_CP1_CI_AS +PublicDataEndpointEnabled : False +ProxyOverride : +TimezoneId : UTC +DnsZonePartner : +DnsZone : ad35cna0mw +InstancePoolName : +MinimalTlsVersion : +BackupStorageRedundancy : Geo +CurrentBackupStorageRedundancy : Geo +MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default +``` + +This command updates an existing instance to be zone - redundant + +### Example 7: Update an existing instance to be zone - redundant +```powershell +Set-AzSqlInstance -Name "managediInstance1" -ResourceGroupName "Resourcegroup01" -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/target_subnet_name" -ZoneRedundant +``` + +```output +Location : westus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/target_subnet_name +LicenseType : LicenseIncluded +VCores : 8 +StorageSizeInGB : 256 +Collation : SQL_Latin1_General_CP1_CI_AS +PublicDataEndpointEnabled : False +ProxyOverride : +TimezoneId : UTC +DnsZonePartner : +DnsZone : ad35cna0mw +InstancePoolName : +MinimalTlsVersion : +BackupStorageRedundancy : Geo +CurrentBackupStorageRedundancy : Geo +MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default +ZoneRedundant : true +``` + +This command moves managed instance to another subnet + +### Example 8: Update backup storage redundancy on existing instance +```powershell +Set-AzSqlInstance -Name "managediInstance1" -ResourceGroupName "Resourcegroup01" -BackupStorageRedundancy Local -Force +``` + +```output +Location : westus +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 +ResourceGroupName : resourcegroup01 +ManagedInstanceName : managedInstance1 +Tags : +Identity : +Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku +FullyQualifiedDomainName : managedInstance1.wusxxxxxxxxxxxxx.database.windows.net +AdministratorLogin : adminLogin1 +AdministratorPassword : +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/target_subnet_name +LicenseType : LicenseIncluded +VCores : 8 +StorageSizeInGB : 256 +Collation : SQL_Latin1_General_CP1_CI_AS +PublicDataEndpointEnabled : False +ProxyOverride : +TimezoneId : UTC +DnsZonePartner : +DnsZone : ad35cna0mw +InstancePoolName : +MinimalTlsVersion : +BackupStorageRedundancy : Geo +CurrentBackupStorageRedundancy : Geo +RequestedBackupStorageRedundancy : Local +MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default +ZoneRedundant : False +``` + +This command changes backups storage redundancy type for managed instance + +## PARAMETERS + +### -AdministratorPassword +The new SQL administrator password for the instance. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign an Azure Active Directory Identity for this instance for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupStorageRedundancy +The Backup storage redundancy used to store backups for the Sql Azure Managed Instance. Options are: Local, Zone and Geo + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Local, Zone, Geo, GeoZone + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputeGeneration +The compute generation for the instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Edition +The edition to assign to the instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of identity to be assigned to the server. Possible values are SystemAsssigned, UserAssigned, 'SystemAssigned,UserAssigned' and None. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The AzureSqlManagedInstanceModel object to remove + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: SetInstanceFromAzureSqlManagedInstanceModelInstanceDefinition +Aliases: SqlInstance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstancePoolName +The instance pool name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyId +The Azure Key Vault URI that is used for encryption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +Determines which License Type to use. Possible values are: +- BasePrice - Azure Hybrid Benefit (AHB) discounted pricing for existing SQL Server license owners is applied. Managed Instance service price will be discounted for existing SQL Server license owners. +- LicenseIncluded - Azure Hybrid Benefit (AHB) discount pricing for existing SQL Server license owners is not applied. Managed Instance service price will include a new SQL Server license costs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceConfigurationId +The Maintenance configuration id for the Sql Azure Managed Instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimalTlsVersion +The minimal TLS version to enforce for Managed instance + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, 1.0, 1.1, 1.2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Instance name. + +```yaml +Type: System.String +Parameter Sets: SetInstanceFromInputParameters +Aliases: InstanceName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryUserAssignedIdentityId +The primary User Managed Identity(UMI) id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyOverride +The connection type used for connecting to the instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicDataEndpointEnabled +Whether or not the public data endpoint is enabled for the instance. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SetInstanceFromInputParameters +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance to remove + +```yaml +Type: System.String +Parameter Sets: SetInstanceFromAzureResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServicePrincipalType +Type of Service Principal to be used. Possible values are SystemAssigned and None. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, SystemAssigned + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSizeInGB +Determines how much Storage size to associate with instance + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The Subnet Id to use for instance update. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +The tags to associate with the instance. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +The list of user assigned identities. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VCore +Determines how much VCore to associate with instance + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundant +Use zone redundant storage + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlInstanceActiveDirectoryAdministrator.md b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceActiveDirectoryAdministrator.md new file mode 100644 index 0000000000..a625a9496f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceActiveDirectoryAdministrator.md @@ -0,0 +1,249 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlinstanceactivedirectoryadministrator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceActiveDirectoryAdministrator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceActiveDirectoryAdministrator.md +--- + +# Set-AzSqlInstanceActiveDirectoryAdministrator + +## SYNOPSIS +Provisions an Azure AD administrator for SQL Managed Instance. + +## SYNTAX + +### UseResourceGroupAndInstanceNameParameterSet (Default) +``` +Set-AzSqlInstanceActiveDirectoryAdministrator [-DisplayName] <String> [-ObjectId] <Guid> + [-ResourceGroupName] <String> [-InstanceName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### UseInputObjectParameterSet +``` +Set-AzSqlInstanceActiveDirectoryAdministrator [-DisplayName] <String> [-ObjectId] <Guid> + -InputObject <AzureSqlManagedInstanceModel> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UserResourceIdParameterSet +``` +Set-AzSqlInstanceActiveDirectoryAdministrator [-DisplayName] <String> [-ObjectId] <Guid> [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlInstanceActiveDirectoryAdministrator** cmdlet provisions an Azure Active Directory (Azure AD) administrator for AzureSQL Managed Instance in the current subscription. +You can provision only one administrator at a time. +The following members of Azure AD can be provisioned as a SQL Managed Instance administrator: +- Native members of Azure AD +- Federated members of Azure AD +- Azure AD groups created as security groups +Imported members from other Azure ADs are not supported as administrators. +Microsoft accounts, such as those in the Outlook.com, Hotmail.com, or Live.com domains, are not supported as administrators. +Other guest accounts, such as those in the Gmail.com or Yahoo.com domains, are not supported as administrators. +We recommend that you provision a dedicated Azure AD group as an administrator. + +## EXAMPLES + +### Example 1: Provision an administrator group for a managed instance associated with resource group +```powershell +Set-AzSqlInstanceActiveDirectoryAdministrator -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -DisplayName "DBAs" -ObjectId "40b79501-b343-44ed-9ce7-da4c8cc7353b" +``` + +```output +ResourceGroupName InstanceName DisplayName ObjectId +----------------- ----------------- ----------- -------- +ResourceGroup01 ManagedInstance01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b +``` + +This command provisions an Azure AD administrator group named DBAs for the managed instance named ManagedInstance01. +This server is associated with resource group ResourceGroup01. + +### Example 2: Provision an administrator user using managed instance object +```powershell +Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" | Set-AzSqlInstanceActiveDirectoryAdministrator -DisplayName "David Chew" -ObjectId "11E95548-B179-4FE1-9AF4-ACA49D13ABB9" +``` + +```output +ResourceGroupName InstanceName DisplayName ObjectId +----------------- ----------------- ----------- -------- +Resourcegroup01 ManagedInstance01 David Chew 11E95548-B179-4FE1-9AF4-ACA49D13ABB9 +``` + +This command provisions an Azure AD user as an administrator from the managed instance object. + +### Example 3: Provision an administrator using managed instance resource identifier +```powershell +Get-AzSqlInstance -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01" | Set-AzSqlInstanceActiveDirectoryAdministrator -DisplayName "David Chew" -ObjectId "11E95548-B179-4FE1-9AF4-ACA49D13ABB9" +``` + +```output +ResourceGroupName InstanceName DisplayName ObjectId +----------------- ----------------- ----------- -------- +Resourcegroup01 ManagedInstance01 David Chew 11E95548-B179-4FE1-9AF4-ACA49D13ABB9 +``` + +This command provisions an Azure AD user as an administrator using managed instance resource identifier. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies the display name of the user or group for whom to grant permissions. +This display name must exist in the active directory associated with the current subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The managed instance object to use. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: UseInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndInstanceNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ObjectId +Specifies the object ID of the user or group in Azure Active Directory for which to grant permissions. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UseResourceGroupAndInstanceNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of instance to use + +```yaml +Type: System.String +Parameter Sets: UserResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.InstanceActiveDirectoryAdministrator.Model.AzureSqlInstanceActiveDirectoryAdministratorModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlInstanceActiveDirectoryAdministrator](./Get-AzSqlInstanceActiveDirectoryAdministrator.md) + +[Remove-AzSqlInstanceActiveDirectoryAdministrator](./Remove-AzSqlInstanceActiveDirectoryAdministrator.md) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabase.md b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabase.md new file mode 100644 index 0000000000..0044f5f474 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabase.md @@ -0,0 +1,279 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlinstancedatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceDatabase.md +--- + +# Set-AzSqlInstanceDatabase + +## SYNOPSIS +Updated an Azure SQL Managed Instance database. + +## SYNTAX + +### SetInstanceDatabaseFromInputParameters (Default) +``` +Set-AzSqlInstanceDatabase [-Name] <String> [-InstanceName] <String> [-ResourceGroupName] <String> + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetInstanceDatabaseFromAzureSqlManagedInstanceModel +``` +Set-AzSqlInstanceDatabase [[-Name] <String>] [-Tag <Hashtable>] + [-InstanceObject] <AzureSqlManagedInstanceModel> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetInstanceDatabaseFromAzureSqlManagedDatabaseModel +``` +Set-AzSqlInstanceDatabase [-Tag <Hashtable>] [-InputObject] <AzureSqlManagedDatabaseModel> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetInstanceDatabaseFromAzureResourceId +``` +Set-AzSqlInstanceDatabase [-Tag <Hashtable>] [-ResourceId] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +**Set-AzSqlInstanceDatabase** cmdlet updates properties on the given managed database. + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> +```powershell +PS C:\> Set-AzSqlInstanceDatabase -Name "name1" -InstanceName "instance1" -ResourceGroupName "rg1" -Tags @{tag1="value1"} + +Location : westcentralus +Tags : {[tag1, value1]} +Collation : SQL_Latin1_General_CP1_CI_AS +Status : Online +RestorePointInTime : +DefaultSecondaryLocation : westus2 +CatalogCollation : +CreateMode : +StorageContainerUri : +StorageContainerSasToken : +SourceDatabaseId : +FailoverGroupId : +RecoverableDatabaseId : +RestorableDroppedDatabaseId : +LongTermRetentionBackupResourceId : +AutoCompleteRestore : +LastBackupName : +ResourceGroupName : rg1 +ManagedInstanceName : instance1 +Name : name1 +CreationDate : 4/11/2022 5:26:30 PM +EarliestRestorePoint : 6/14/2022 5:07:14 PM +Id : /subscriptions/subscription_id/resourceGroups/rg1/providers/Microsoft.Sql/managedInstances/instance1/databases/name1 +``` + +This command sets tags to existing managed database. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: SetInstanceDatabaseFromAzureSqlManagedDatabaseModel +Aliases: DatabaseObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The name of the instance. + +```yaml +Type: System.String +Parameter Sets: SetInstanceDatabaseFromInputParameters +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the instance database to create. + +```yaml +Type: System.String +Parameter Sets: SetInstanceDatabaseFromInputParameters +Aliases: InstanceDatabaseName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: SetInstanceDatabaseFromAzureSqlManagedInstanceModel +Aliases: InstanceDatabaseName + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SetInstanceDatabaseFromInputParameters +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The instance database resource id + +```yaml +Type: System.String +Parameter Sets: SetInstanceDatabaseFromAzureResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The tags to associate with the instance database + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +The managed instance object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: SetInstanceDatabaseFromAzureSqlManagedInstanceModel +Aliases: ParentObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlInstanceDatabase](./New-AzSqlInstanceDatabase.md) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md new file mode 100644 index 0000000000..9d2cddba58 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md @@ -0,0 +1,317 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlinstancedatabasebackuplongtermretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md +--- + +# Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy + +## SYNOPSIS +The **Set-AzSqlInstanceDatabaseLongTermRetentionBackup** cmdlet sets a managed database's long term retention policy. + +## SYNTAX + +### WeeklyRetentionRequired (Default) +``` +Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy -WeeklyRetention <String> [-InstanceName] <String> + [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### RemovePolicy +``` +Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy [-RemovePolicy] [-InstanceName] <String> + [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### MonthlyRetentionRequired +``` +Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy [-WeeklyRetention <String>] -MonthlyRetention <String> + [-InstanceName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### YearlyRetentionRequired +``` +Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy [-WeeklyRetention <String>] [-MonthlyRetention <String>] + -YearlyRetention <String> -WeekOfYear <Int32> [-InstanceName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy** cmdlet sets the long term retention policy for this managed database. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy -ResourceGroupName testResourceGroup -InstanceName testInstance -DatabaseName test -WeeklyRetention "P1W" +``` + +```output +ResourceGroupName : testResourceGroup +ManagedInstanceName : testInstance +DatabaseName : test +WeeklyRetention : P1W +MonthlyRetention : PT0S +YearlyRetention : PT0S +WeekOfYear : 0 +Location : +``` + +Configures the database's long term retention weekly policy to one week. + +### Example 2 +```powershell +Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy -ResourceGroupName testResourceGroup -InstanceName testInstance -DatabaseName target1 -RemovePolicy +``` + +```output +ResourceGroupName : testResourceGroup +ManagedInstanceName : testInstance +DatabaseName : target1 +WeeklyRetention : PT0S +MonthlyRetention : PT0S +YearlyRetention : PT0S +WeekOfYear : 0 +Location : +``` + +This command removes the long term retention policy from the database. + +### Example 3 + +The Set-AzSqlInstanceDatabaseLongTermRetentionBackup cmdlet sets a managed database's long term retention policy. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy -DatabaseName target1 -InstanceName testInstance -MonthlyRetention P24W -ResourceGroupName testResourceGroup -WeekOfYear 26 -WeeklyRetention 'P1W' -YearlyRetention P10Y +``` + +## PARAMETERS + +### -DatabaseName +The name of the Azure Managed Database to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +The name of the Azure Managed Instance the database belongs to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MonthlyRetention +The Monthly Retention. +If just a number is passed instead of an ISO 8601 string, days will be assumed as the units. +There is a minimum of 7 days and a maximum of 10 years. + +```yaml +Type: System.String +Parameter Sets: MonthlyRetentionRequired +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: YearlyRetentionRequired +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RemovePolicy +If provided, the policy for the database will be cleared. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RemovePolicy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WeeklyRetention +The Weekly Retention. +If just a number is passed instead of an ISO 8601 string, days will be assumed as the units. +There is a minimum of 7 days and a maximum of 10 years. + +```yaml +Type: System.String +Parameter Sets: WeeklyRetentionRequired +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MonthlyRetentionRequired, YearlyRetentionRequired +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WeekOfYear +The Week of Year, 1 to 52, to save for the Yearly Retention. + +```yaml +Type: System.Int32 +Parameter Sets: YearlyRetentionRequired +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -YearlyRetention +The Yearly Retention. +If just a number is passed instead of an ISO 8601 string, days will be assumed as the units. +There is a minimum of 7 days and a maximum of 10 years. + +```yaml +Type: System.String +Parameter Sets: YearlyRetentionRequired +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Int32 + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabaseBackup.Model.AzureSqlManagedDatabaseBackupLongTermRetentionPolicyModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy](./Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md) + +[Get-AzSqlInstanceDatabaseLongTermRetentionBackup](./Get-AzSqlInstanceDatabaseLongTermRetentionBackup.md) + +[Remove-AzSqlInstanceDatabaseLongTermRetentionBackup](./Remove-AzSqlInstanceDatabaseLongTermRetentionBackup.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy.md b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy.md new file mode 100644 index 0000000000..61b3b64a3f --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy.md @@ -0,0 +1,261 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlinstancedatabasebackupshorttermretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy.md +--- + +# Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy + +## SYNOPSIS +Sets a backup short term retention policy. + +## SYNTAX + +### PolicyByResourceInstanceDatabaseSet (Default) +``` +Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy [-ResourceGroupName] <String> [-InstanceName] <String> + [-DatabaseName] <String> [-DeletionDate <DateTime>] [-RetentionDays] <Int32> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PolicyByInputObjectSet +``` +Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy [-InputObject] <AzureSqlManagedDatabaseBaseModel> + [-RetentionDays] <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PolicyByResourceIdSet +``` +Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy [-ResourceId] <String> [-RetentionDays] <Int32> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy** cmdlet sets the short term retention policy for this database. +The policy is the retention period, in days, for point-in-time restore backups. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy -ResourceGroupName resourcegroup01 -InstanceName server01 -DatabaseName database01 -RetentionDays 35 +``` + +```output +ResourceGroupName : resourcegroup01 +InstanceName : instance01 +DatabaseName : database01 +DeletionDate : +RetentionDays : 35 +``` + +This command sets the short term retention policy for database01 to 35 days. + +### Example 2 +```powershell +Get-AzSqlInstanceDatabase -ResourceGroupName resourcegroup01 -InstanceName server01 -Name database01 | Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy -RetentionDays 35 +``` + +```output +ResourceGroupName : resourcegroup01 +InstanceName : instance01 +DatabaseName : database01 +DeletionDate : +RetentionDays : 35 +``` + +This command sets the short term retention policy for database01 to 35 days via piping in a database object. + +### Example 3 +```powershell +Get-AzSqlDeletedInstanceDatabaseBackup -ResourceGroupName "ContosoResourceGroup" -InstanceName "ContosoServer" -DatabaseName "DB1" | Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy -RetentionDays 8 +``` + +```output +ResourceGroupName : resourcegroup01 +InstanceName : instance01 +DatabaseName : database01 +DeletionDate : 2019-03-03 12:00:17 AM +RetentionDays : 8 + +ResourceGroupName : resourcegroup01 +InstanceName : instance01 +DatabaseName : database01 +DeletionDate : 2019-03-02 11:00:16 PM +RetentionDays : 8 +``` + +This command sets the short term retention policy for all deleted databases named DB1 via piping in a deleted database object. Note you can only reduce retention period on deleted databases. + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Instance Database to retrieve backups for. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceInstanceDatabaseSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletionDate +The deletion date of the Azure SQL Instance Database to retrieve backups for, with millisecond precision (e.g. 2016-02-23T00:21:22.847Z) + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: PolicyByResourceInstanceDatabaseSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The live or deleted database object to get/set the policy for. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseBaseModel +Parameter Sets: PolicyByInputObjectSet +Aliases: AzureSqlInstanceDatabase, AzureInstanceDatabaseObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The name of the Azure SQL Managed Instance the database is in. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceInstanceDatabaseSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceInstanceDatabaseSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The short term retention policy resource Id. + +```yaml +Type: System.String +Parameter Sets: PolicyByResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionDays +Days of backup retention. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseBaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabaseBackup.Model.AzureSqlManagedDatabaseBackupShortTermRetentionPolicyModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabaseSensitivityClassification.md b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabaseSensitivityClassification.md new file mode 100644 index 0000000000..decc857e3c --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabaseSensitivityClassification.md @@ -0,0 +1,302 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlinstancedatabasesensitivityclassification +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceDatabaseSensitivityClassification.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceDatabaseSensitivityClassification.md +--- + +# Set-AzSqlInstanceDatabaseSensitivityClassification + +## SYNOPSIS +Sets the information types and sensitivity labels of columns in the Azure SQL Managed Instance database. + +## SYNTAX + +### ClassificationObjectParameterSet (Default) +``` +Set-AzSqlInstanceDatabaseSensitivityClassification + -ClassificationObject <ManagedDatabaseSensitivityClassificationModel> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Set-AzSqlInstanceDatabaseSensitivityClassification [-SensitivityLabel <String>] [-InformationType <String>] + [-ResourceGroupName] <String> [-InstanceName] <String> [-DatabaseName] <String> -SchemaName <String> + -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DatabaseObjectColumnParameterSet +``` +Set-AzSqlInstanceDatabaseSensitivityClassification [-SensitivityLabel <String>] [-InformationType <String>] + -DatabaseObject <AzureSqlManagedDatabaseModel> -SchemaName <String> -TableName <String> -ColumnName <String> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzSqlInstanceDatabaseSensitivityClassification cmdlet sets the information types and sensitivity labels of columns in the Azure SQL Managed Instance database. + +## EXAMPLES + +### Example 1: Set information type and sensitivity label of a column in an Azure SQL Managed Instance database. +```powershell +Set-AzSqlInstanceDatabaseSensitivityClassification -ResourceGroupName resourceGroup -InstanceName managedInstance -DatabaseName database -SchemaName schema -TableName table -ColumnName column -InformationType informationType -SensitivityLabel label +``` + +### Example 2: Set recommended information types and sensitivity labels of columns in an Azure SQL Managed Instance database. +```powershell +Get-AzSqlInstanceDatabaseSensitivityRecommendation -ResourceGroupName resourceGroup -InstanceName managedInstance -DatabaseName database | Set-AzSqlInstanceDatabaseSensitivityClassification +``` + +### Example 3: Set information type and sensitivity label of a column in an Azure SQL Managed Instance database, using piping. +```powershell +Get-AzSqlInstanceDatabase -ResourceGroupName resourceGroup -InstanceName managedInstance -Name database | Set-AzSqlInstanceDatabaseSensitivityClassification -SchemaName schema -TableName table -ColumnName column -InformationType informationType -SensitivityLabel label +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationObject +An object representing a SQL Managed Instance Database Sensitivity Classification. + +```yaml +Type: Microsoft.Azure.Commands.Sql.DataClassification.Model.ManagedDatabaseSensitivityClassificationModel +Parameter Sets: ClassificationObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Managed Instance database. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +The Azure SQL Managed Instance database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InformationType +A name that describes the information type of the data stored in the column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstanceName +Azure SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Specifies whether to output the sensitivity classification model at end of cmdlet execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SensitivityLabel +A name that describes the sensitivity of the data stored in the column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, DatabaseObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.DataClassification.Model.ManagedDatabaseSensitivityClassificationModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Learn more about Azure SQL Database data discovery and classification](https://learn.microsoft.com/azure/sql-database/sql-database-data-discovery-and-classification) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md new file mode 100644 index 0000000000..c012eb1c53 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md @@ -0,0 +1,289 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlinstancedatabasevulnerabilityassessmentrulebaseline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline.md +--- + +# Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline + +## SYNOPSIS +Sets the vulnerability assessment rule baseline. + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline [-InstanceName] <String> [-DatabaseName] <String> + -BaselineResult <String[][]> -RuleId <String> [-RuleAppliesToMaster] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline + [-InputObject <VulnerabilityAssessmentRuleBaselineModel>] -BaselineResult <String[][]> -RuleId <String> + [-RuleAppliesToMaster] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline** cmdlet sets the vulnerability assessment rule baseline. +As you review your assessment results, you can mark specific results as being an acceptable Baseline in your environment. The baseline is essentially a customization of how the results are reported. Results that match the baseline are considered as passing in subsequent scans. Once you have established your baseline security state, vulnerability assessment only reports on deviations from the baseline, and you can focus your attention on the relevant issues. +Note that you need to run *Enable-AzSqlInstanceAdvancedDataSecurity* and *Update-AzSqlInstanceVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1: Set a vulnerability assessment rule baseline +```powershell +Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -RuleId "VA2108" ` + -RuleAppliesToMaster ` + -BaselineResult @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +RuleId : VA2108 +RuleAppliesToMaster : True +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +BaselineResult value is a composition of several sub arrays that described the T-SQL results that will be added to the baseline. +You may find the Scan results under the storage defined by the Update-AzSqlInstanceVulnerabilityAssessmentSetting cmdlet, under scans/{ManagedInstanceName}/{ManagedDatabaseName}/scan_{ScanId}.json + +### Example 2: Set a vulnerability assessment rule baseline from a baseline object +```powershell +Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -RuleId "VA2108" ` + -BaselineResult @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') + +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -RuleId "VA2108" ` + | Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ResourceGroup02" ` + -InstanceName "ManagedInstance02" ` + -DatabaseName "Database02" +``` + +```output +ResourceGroupName : ResourceGroup02 +InstanceName : ManagedInstance02 +DatabaseName : Database02 +RuleId : VA2108 +RuleAppliesToMaster : False +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +### Example 3: Set a vulnerability assessment rule baseline on all the databases under a managed instance +```powershell +Get-AzSqlInstanceDatabase -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + | Where-Object {$_.Name -ne "master"} ` + | Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline ` + -RuleId "VA2108" ` + -BaselineResult @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +RuleId : VA2108 +RuleAppliesToMaster : False +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database02 +RuleId : VA2108 +RuleAppliesToMaster : False +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +## PARAMETERS + +### -BaselineResult +The results to set as baseline for the rule in all future scans + +```yaml +Type: System.String[][] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +SQL Managed Database name. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Vulnerability Assessment rule baseline object to set + +```yaml +Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentRuleBaselineModel +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleAppliesToMaster +Specifies whether the baseline results should apply on a server level rule identified by the RuleId + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleId +The rule ID which identifies the rule to set the baseline results to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentRuleBaselineModel + +### System.String[][] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ManagedDatabaseVulnerabilityAssessmentRuleBaselineModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDtc.md b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDtc.md new file mode 100644 index 0000000000..4b503e3580 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceDtc.md @@ -0,0 +1,459 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlinstancedtc +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceDtc.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceDtc.md +--- + +# Set-AzSqlInstanceDtc + +## SYNOPSIS +Sets properties for an Azure SQL Managed Instance DTC + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Set-AzSqlInstanceDtc [-ResourceGroupName] <String> [-InstanceName] <String> [[-DtcEnabled] <Boolean>] + [[-ExternalDnsSuffixSearchList] <System.Collections.Generic.List`1[System.String]>] + [-XaTransactionsEnabled <Boolean>] [-SnaLu6point2TransactionsEnabled <Boolean>] + [-XaTransactionsDefaultTimeout <Int32>] [-XaTransactionsMaximumTimeout <Int32>] + [-AllowInboundEnabled <Boolean>] [-AllowOutboundEnabled <Boolean>] [-Authentication <String>] [-AsJob] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByParentObjectParameterSet +``` +Set-AzSqlInstanceDtc [-InstanceObject] <AzureSqlManagedInstanceModel> [[-DtcEnabled] <Boolean>] + [[-ExternalDnsSuffixSearchList] <System.Collections.Generic.List`1[System.String]>] + [-XaTransactionsEnabled <Boolean>] [-SnaLu6point2TransactionsEnabled <Boolean>] + [-XaTransactionsDefaultTimeout <Int32>] [-XaTransactionsMaximumTimeout <Int32>] + [-AllowInboundEnabled <Boolean>] [-AllowOutboundEnabled <Boolean>] [-Authentication <String>] [-AsJob] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Set-AzSqlInstanceDtc [-InputObject] <AzureSqlManagedInstanceDtcModel> [[-DtcEnabled] <Boolean>] + [[-ExternalDnsSuffixSearchList] <System.Collections.Generic.List`1[System.String]>] + [-XaTransactionsEnabled <Boolean>] [-SnaLu6point2TransactionsEnabled <Boolean>] + [-XaTransactionsDefaultTimeout <Int32>] [-XaTransactionsMaximumTimeout <Int32>] + [-AllowInboundEnabled <Boolean>] [-AllowOutboundEnabled <Boolean>] [-Authentication <String>] [-AsJob] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Set-AzSqlInstanceDtc [-ResourceId] <String> [[-DtcEnabled] <Boolean>] + [[-ExternalDnsSuffixSearchList] <System.Collections.Generic.List`1[System.String]>] + [-XaTransactionsEnabled <Boolean>] [-SnaLu6point2TransactionsEnabled <Boolean>] + [-XaTransactionsDefaultTimeout <Int32>] [-XaTransactionsMaximumTimeout <Int32>] + [-AllowInboundEnabled <Boolean>] [-AllowOutboundEnabled <Boolean>] [-Authentication <String>] [-AsJob] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlInstanceDtc** cmdlet modifies properties of an Azure SQL Managed instance DTC. + +## EXAMPLES + +### Example 1 Enable DTC for a managed instance +```powershell +Set-AzSqlInstanceDtc -ResourceGroupName ResourceGroup1 -InstanceName ManagedInstance1 -DtcEnabled $true +``` + +```output +ResourceGroupName : ResourceGroup1 +ManagedInstanceName : ManagedInstance1 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/current +DtcEnabled : True +DtcHostNameDnsSuffix : suffix1.net +DtcHostName : name1.suffix1.net +ExternalDnsSuffixSearchList : {suffix1.net} +SecuritySettings : Microsoft.Azure.Management.Sql.Models.ManagedInstanceDtcSecuritySettings +``` + +This command enables managed instance DTC for the managed instance ManagedInstance1. + +### Example 2 Enable XA transactions for DTC +```powershell +$dtc = Set-AzSqlInstanceDtc -ResourceGroupName ResourceGroup1 -InstanceName ManagedInstance1 -XaTransactionsEnabled $true +Write-Output $dtc.SecuritySettings +``` + +```output +TransactionManagerCommunicationSettings : Microsoft.Azure.Management.Sql.Models.ManagedInstanceDtcTransactionManagerCommunicationSettings +XaTransactionsEnabled : True +SnaLu6point2TransactionsEnabled : True +XaTransactionsDefaultTimeout : 0 +XaTransactionsMaximumTimeout : 0 +``` + +This command enables XA transactions for managed instance DTC + +### Example 3 Enable DTC for a previously fetched managed instance +```powershell +$managedInstance = Get-AzSqlInstance -ResourceGroupName ResourceGroup1 -InstanceName ManagedInstance1 +Set-AzSqlInstanceDtc -InstanceObject $managedInstance +``` + +```output +ResourceGroupName : ResourceGroup1 +ManagedInstanceName : ManagedInstance1 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/current +DtcEnabled : True +DtcHostNameDnsSuffix : suffix1.net +DtcHostName : name1.suffix1.net +ExternalDnsSuffixSearchList : {suffix1.net} +SecuritySettings : Microsoft.Azure.Management.Sql.Models.ManagedInstanceDtcSecuritySettings +``` + +This command enables managed instance DTC by passing managed instance object. + +### Example 4 Enable XA transactions for a previously fetched DTC object +```powershell +$dtc = Get-AzSqlInstanceDtc -ResourceGroupName ResourceGroup1 -InstanceName ManagedInstance1 +$dtc = Set-AzSqlInstanceDtc -InputObject $dtc -DtcEnabled $true +Write-Output $dtc.SecuritySettings +``` + +```output +TransactionManagerCommunicationSettings : Microsoft.Azure.Management.Sql.Models.ManagedInstanceDtcTransactionManagerCommunicationSettings +XaTransactionsEnabled : True +SnaLu6point2TransactionsEnabled : True +XaTransactionsDefaultTimeout : 0 +XaTransactionsMaximumTimeout : 0 +``` + +This command enables XA transactions for DTC by passing DTC object. + +### Example 5 Enable DTC with a specific resource ID +```powershell +Set-AzSqlInstanceDtc -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/current -DtcEnabled $true +``` + +```output +ResourceGroupName : ResourceGroup1 +ManagedInstanceName : ManagedInstance1 +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Sql/managedInstances/ManagedInstance1/dtc/current +DtcEnabled : True +DtcHostNameDnsSuffix : suffix1.net +DtcHostName : name1.suffix1.net +ExternalDnsSuffixSearchList : {suffix1.net} +SecuritySettings : Microsoft.Azure.Management.Sql.Models.ManagedInstanceDtcSecuritySettings +``` + +This command enables managed instance DTC by passing the resource ID of the DTC. + +## PARAMETERS + +### -AllowInboundEnabled +Enable inbound traffic. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOutboundEnabled +Enable outbound traffic. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authentication +Authentication type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DtcEnabled +DTC enabled status. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalDnsSuffixSearchList +External DNS suffix search list. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Input object of the managed instance DTC. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstanceDtc.Model.AzureSqlManagedInstanceDtcModel +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +Name of the managed instance. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +Input object of the managed instance. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: SetByParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID of the managed instance DTC. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SnaLu6point2TransactionsEnabled +SNA LU 6.2 transactions enabled status. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XaTransactionsDefaultTimeout +XA transactions default timeout. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XaTransactionsEnabled +XA transactions enabled status. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XaTransactionsMaximumTimeout +XA transactions maximum timeout. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### Microsoft.Azure.Commands.Sql.ManagedInstanceDtc.Model.AzureSqlManagedInstanceDtcModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstanceDtc.Model.AzureSqlManagedInstanceDtcModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlInstanceDtc](./Get-AzSqlInstanceDtc.md) + +[SQL Managed Instance DTC Documentation](https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/distributed-transaction-coordinator-dtc?view=azuresql) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlInstancePool.md b/azps-10.1.0/Az.Sql/Set-AzSqlInstancePool.md new file mode 100644 index 0000000000..0f2868ea18 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlInstancePool.md @@ -0,0 +1,275 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlinstancepool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstancePool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstancePool.md +--- + +# Set-AzSqlInstancePool + +## SYNOPSIS +Sets properties for an Azure SQL Instance pool. + +## SYNTAX + +### DefaultSetInstancePoolParameterSet (Default) +``` +Set-AzSqlInstancePool [-ResourceGroupName] <String> [-Name] <String> [-LicenseType <String>] [-Tag <Hashtable>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectSetInstancePoolParameterSet +``` +Set-AzSqlInstancePool [-InputObject] <AzureSqlInstancePoolModel> [-LicenseType <String>] [-Tag <Hashtable>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSetInstancePoolParameterSet +``` +Set-AzSqlInstancePool [-ResourceId] <String> [-LicenseType <String>] [-Tag <Hashtable>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlInstancePool** cmdlet modifies properties of an Azure SQL Instance pool. + +## EXAMPLES + +### Example 1 : Set an instance pool license type +```powershell +Set-AzSqlInstancePool -ResourceGroupName resourcegroup01 -Name instancePool0 -LicenseType LicenseIncluded +``` + +```output +ResourceGroupName : resourcegroup01 +Type : Microsoft.Sql/instancePools +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0 +InstancePoolName : instancePool0 +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +VCores : 8 +ComputeGeneration : Gen5 +Edition : GeneralPurpose +Tags : +Sku : Microsoft.Azure.Management.Sql.Models.Sku +Location : canadacentral +LicenseType : LicenseIncluded +``` + +This command sets the license type and/or tags for an instance pool named instancePool0. + +### Example 2 : Set an instance pool license type using an instance pool object +```powershell +$instancePool = Get-AzSqlInstancePool -ResourceGroupName resourcegroup01 -Name instancePool0 +Set-AzSqlInstancePool -InputObject $instancePool -LicenseType LicenseIncluded +``` + +```output +ResourceGroupName : resourcegroup01 +Type : Microsoft.Sql/instancePools +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0 +InstancePoolName : instancePool0 +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +VCores : 8 +ComputeGeneration : Gen5 +Edition : GeneralPurpose +Tags : +Sku : Microsoft.Azure.Management.Sql.Models.Sku +Location : canadacentral +LicenseType : LicenseIncluded +``` + +This command sets the license type and/or tags for an instance pool using an instance pool object. + +### Example 3 : Set an instance pool license type using an instance pool resource id +```powershell +Set-AzSqlInstancePool -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0" -LicenseType LicenseIncluded +``` + +```output +ResourceGroupName : resourcegroup01 +Type : Microsoft.Sql/instancePools +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0 +InstancePoolName : instancePool0 +SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name +VCores : 8 +ComputeGeneration : Gen5 +Edition : GeneralPurpose +Tags : +Sku : Microsoft.Azure.Management.Sql.Models.Sku +Location : canadacentral +LicenseType : LicenseIncluded +``` + +This command sets the license type and/or tags for an instance pool named instancePool0. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The instance pool input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Instance_Pools.Model.AzureSqlInstancePoolModel +Parameter Sets: InputObjectSetInstancePoolParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LicenseType +Determines which License Type to use. +Possible values are BasePrice (with AHB discount) and LicenseIncluded (without AHB discount). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the instance pool. + +```yaml +Type: System.String +Parameter Sets: DefaultSetInstancePoolParameterSet +Aliases: InstancePoolName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: DefaultSetInstancePoolParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The instance pool resource identifier. + +```yaml +Type: System.String +Parameter Sets: ResourceIdSetInstancePoolParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +The tags to associate with the instance + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.Instance_Pools.Model.AzureSqlInstancePoolModel + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlInstanceTransparentDataEncryptionProtector.md b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceTransparentDataEncryptionProtector.md new file mode 100644 index 0000000000..384272f86e --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlInstanceTransparentDataEncryptionProtector.md @@ -0,0 +1,304 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/Set-AzSqlInstanceTransparentDataEncryptionProtector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceTransparentDataEncryptionProtector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlInstanceTransparentDataEncryptionProtector.md +--- + +# Set-AzSqlInstanceTransparentDataEncryptionProtector + +## SYNOPSIS +Sets the Transparent Data Encryption (TDE) protector for a SQL managed instance. + +## SYNTAX + +### AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorDefaultParameterSet (Default) +``` +Set-AzSqlInstanceTransparentDataEncryptionProtector [-Type] <EncryptionProtectorType> [[-KeyId] <String>] + [-AutoRotationEnabled <Boolean>] [-Force] [-ResourceGroupName] <String> [-InstanceName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorInputObjectParameterSet +``` +Set-AzSqlInstanceTransparentDataEncryptionProtector [-Type] <EncryptionProtectorType> [[-KeyId] <String>] + [-AutoRotationEnabled <Boolean>] [-Force] [-Instance] <AzureSqlManagedInstanceModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorResourceIdParameterSet +``` +Set-AzSqlInstanceTransparentDataEncryptionProtector [-Type] <EncryptionProtectorType> [[-KeyId] <String>] + [-AutoRotationEnabled <Boolean>] [-Force] [-InstanceResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzSqlInstanceTransparentDataEncryptionProtector cmdlet sets the TDE protector for a SQL managed instance. Changing the TDE protector type will rotate the protector. + +## EXAMPLES + +### Example 1: Set the Transparent Data Encryption (TDE) protector type to ServiceManaged +```powershell +Set-AzSqlInstanceTransparentDataEncryptionProtector -ResourceGroupName 'ContosoResourceGroup' -InstanceName 'ContosoManagedInstanceName' -Type ServiceManaged +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +Type : ServiceManaged +ManagedInstanceKeyVaultKeyName : ServiceManaged +KeyId : +``` + +This command updates a managed instance's TDE protector type to Service Managed. + +### Example 2: Set the Transparent Data Encryption protector type to Azure Key Vault +```powershell +Set-AzSqlInstanceTransparentDataEncryptionProtector -ResourceGroupName 'ContosoResourceGroup' -InstanceName 'ContosoManagedInstanceName' -Type AzureKeyVault -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +Type : AzureKeyVault +ManagedInstanceKeyVaultKeyName : contoso_contosokey_01234567890123456789012345678901 +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +``` + +This command updates the specified managed instance to use the Managed instance Key Vault Key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' as the TDE protector. + +### Example 3: Set the Transparent Data Encryption protector type to Azure Key Vault using managed instance object +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +Set-AzSqlInstanceTransparentDataEncryptionProtector -Instance $managedInstance -Type AzureKeyVault -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +Type : AzureKeyVault +ManagedInstanceKeyVaultKeyName : contoso_contosokey_01234567890123456789012345678901 +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +``` + +This command updates the specified managed instance to use the Managed instance Key Vault Key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' as the TDE protector. + +### Example 4: Set the Transparent Data Encryption protector type to Azure Key Vault using resource id +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +Set-AzSqlInstanceTransparentDataEncryptionProtector -InstanceResourceId $managedInstance.ResourceId -Type AzureKeyVault -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +Type : AzureKeyVault +ManagedInstanceKeyVaultKeyName : contoso_contosokey_01234567890123456789012345678901 +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +``` + +This command updates the specified managed instance to use the Managed instance Key Vault Key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' as the TDE protector. + +### Example 5: Set the Transparent Data Encryption protector type to Azure Key Vault using piping +```powershell +$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' +$managedInstance | Set-AzSqlInstanceTransparentDataEncryptionProtector -Type AzureKeyVault -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' +``` + +```output +ResourceGroupName : ContosoResourceGroup +ManagedInstanceName : ContosoManagedInstanceName +Type : AzureKeyVault +ManagedInstanceKeyVaultKeyName : contoso_contosokey_01234567890123456789012345678901 +KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 +``` + +This command updates the specified managed instance to use the Managed instance Key Vault Key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' as the TDE protector. + +## PARAMETERS + +### -AutoRotationEnabled +The key auto rotation opt-in status. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +The instance input object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorInputObjectParameterSet +Aliases: InputObject + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The instance name + +```yaml +Type: System.String +Parameter Sets: AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorDefaultParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceResourceId +The instance resource id + +```yaml +Type: System.String +Parameter Sets: AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorResourceIdParameterSet +Aliases: ResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeyId +The Azure Key Vault KeyId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The Resource Group Name + +```yaml +Type: System.String +Parameter Sets: AzureSqlRmManagedInstanceTransparentDataEncryptionProtectorDefaultParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The Azure Sql Database Transparent Data Encryption Protector type. + +```yaml +Type: Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.EncryptionProtectorType +Parameter Sets: (All) +Aliases: +Accepted values: AzureKeyVault, ServiceManaged + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureRmSqlManagedInstanceTransparentDataEncryptionProtectorModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlServer.md b/azps-10.1.0/Az.Sql/Set-AzSqlServer.md new file mode 100644 index 0000000000..f651291c5a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlServer.md @@ -0,0 +1,358 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: FAAF458C-1662-4130-9A16-0514B714D11D +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServer.md +--- + +# Set-AzSqlServer + +## SYNOPSIS +Modifies properties of a SQL Database server. + +## SYNTAX + +``` +Set-AzSqlServer [-ServerName] <String> [-SqlAdministratorPassword <SecureString>] [-Tags <Hashtable>] + [-ServerVersion <String>] [-AssignIdentity] [-PublicNetworkAccess <String>] + [-RestrictOutboundNetworkAccess <String>] [-MinimalTlsVersion <String>] + [-PrimaryUserAssignedIdentityId <String>] [-KeyId <String>] [-FederatedClientId <Guid>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] [-IdentityType <String>] [-Force] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlServer** cmdlet modifies properties of an Azure SQL Database server. + +## EXAMPLES + +### Example 1: Reset the administrator password +```powershell +$ServerPassword = "newpassword" +$SecureString = ConvertTo-SecureString $ServerPassword -AsPlainText -Force +Set-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -SqlAdministratorPassword $secureString +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +Location : Australia East +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : +Identity : +FullyQualifiedDomainName : server01.database.windows.net +``` + +This command resets the administrator password on the AzureSQL Server named server01. + +### Example 2 + +Modifies properties of a SQL Database server. (autogenerated) + +<!-- Aladdin Generated Example --> +```powershell +Set-AzSqlServer -AssignIdentity -ResourceGroupName 'ResourceGroup01' -ServerName 'Server01' +``` + +## PARAMETERS + +### -AssignIdentity +Generate and assign an Azure Active Directory Identity for this server for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedClientId +Specifies the Federated client ID of the server when using Cross-Tenant CMK, Do not set this value if you do not intent to use Cross-Tenant CMK + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of identity to be assigned to the server. Possible values are SystemAsssigned, UserAssigned, 'SystemAssigned,UserAssigned' and None. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyId +The Azure Key Vault URI that is used for encryption. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimalTlsVersion +The minimal TLS version to enforce for Sql Server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, 1.0, 1.1, 1.2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryUserAssignedIdentityId +The primary User Managed Identity(UMI) id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Takes a flag, enabled/disabled, to specify whether public network access to server is allowed or not. +When disabled, only connections made through Private Links can reach this server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestrictOutboundNetworkAccess +When enabled, only outbound connections allowed by the outbound firewall rules will succeed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerVersion +Specifies the version to which this cmdlet changes the server. The acceptable values for this +parameter are: 2.0 and 12.0. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlAdministratorPassword +Specifies a new password, as a **SecureString**, for the database server administrator. To obtain a +**SecureString**, use the Get-Credential cmdlet. For more information, type `Get-Help +ConvertTo-SecureString`. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +Specifies a dictionary of tags that this cmdlet associates with the server. Key-value pairs in the +form of a hash table set as tags on the server. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tag + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +The list of user assigned identities. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +## NOTES + +## RELATED LINKS + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlServerActiveDirectoryAdministrator.md b/azps-10.1.0/Az.Sql/Set-AzSqlServerActiveDirectoryAdministrator.md new file mode 100644 index 0000000000..14444aee55 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlServerActiveDirectoryAdministrator.md @@ -0,0 +1,214 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 60E0D10F-9B93-45A9-A1FF-5C943B8CA09C +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlserveractivedirectoryadministrator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerActiveDirectoryAdministrator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerActiveDirectoryAdministrator.md +--- + +# Set-AzSqlServerActiveDirectoryAdministrator + +## SYNOPSIS +Provisions an Azure AD administrator for SQL Server. + +## SYNTAX + +``` +Set-AzSqlServerActiveDirectoryAdministrator [-DisplayName] <String> [[-ObjectId] <Guid>] [-ServerName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlServerActiveDirectoryAdministrator** cmdlet provisions an Azure Active Directory (Azure AD) administrator for AzureSQL Server in the current subscription. +You can provision only one administrator at a time. +The following members of Azure AD can be provisioned as a SQL Server administrator: +- Native members of Azure AD +- Federated members of Azure AD +- Imported members from other Azure ADs who are native or federated members +- Azure AD groups created as security groups +Microsoft accounts, such as those in the Outlook.com, Hotmail.com, or Live.com domains, are not supported as administrators. +Other guest accounts, such as those in the Gmail.com or Yahoo.com domains, are not supported as administrators. +We recommend that you provision a dedicated Azure AD group as an administrator. + +## EXAMPLES + +### Example 1: Provision an administrator group for a server +```powershell +Set-AzSqlServerActiveDirectoryAdministrator -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DisplayName "DBAs" +``` + +```output +ResourceGroupName ServerName DisplayName ObjectId IsAzureADOnlyAuthentication +----------------- ---------- ----------- -------- --------------------------- +ResourceGroup01 Server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b False +``` + +This command provisions an Azure AD administrator group named DBAs for the server named Server01. +This server is associated with resource group ResourceGroup01. + +### Example 2: Provision an administrator user for a server +```powershell +Set-AzSqlServerActiveDirectoryAdministrator -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DisplayName "David Chew" +``` + +```output +ResourceGroupName ServerName DisplayName ObjectId IsAzureADOnlyAuthentication +----------------- ---------- ----------- -------- +resourcegroup01 server01 David Chew 11E95548-B179-4FE1-9AF4-ACA49D13ABB9 False +``` + +This command provisions an Azure AD user as an administrator for the server named Server01. + +### Example 3: Provision an administrator group by specifying its ID +```powershell +Set-AzSqlServerActiveDirectoryAdministrator -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DisplayName "DBAs" -ObjectId "40b79501-b343-44ed-9ce7-da4c8cc7353b" +``` + +```output +ResourceGroupName ServerName DisplayName ObjectId IsAzureADOnlyAuthentication +----------------- ---------- ----------- -------- +ResourceGroup01 Server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b False +``` + +This command provisions an Azure AD administrator group named DBAs for the server named Server01. +The command specifies an ID for the *ObjectId* parameter. +This makes sure that the command succeeds even if the display name of the group is not unique. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies the display name of the Azure AD administrator that this cmdlet provisions. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ObjectId +Specifies the unique ID of the Azure AD administrator that this cmdlet provisions. +If the display name is not unique, you must specify a value for this parameter. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the SQL Server for which this cmdlet provisions an administrator. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Guid + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServerActiveDirectoryAdministrator](./Get-AzSqlServerActiveDirectoryAdministrator.md) + +[Remove-AzSqlServerActiveDirectoryAdministrator](./Remove-AzSqlServerActiveDirectoryAdministrator.md) + +[Disable-AzSqlServerActiveDirectoryOnlyAuthentication](./Disable-AzSqlServerActiveDirectoryOnlyAuthentication.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlServerAdvisorAutoExecuteStatus.md b/azps-10.1.0/Az.Sql/Set-AzSqlServerAdvisorAutoExecuteStatus.md new file mode 100644 index 0000000000..73e19abb53 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlServerAdvisorAutoExecuteStatus.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 6006D3AC-48E1-44A0-8BD5-CE996B8957A2 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlserveradvisorautoexecutestatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerAdvisorAutoExecuteStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerAdvisorAutoExecuteStatus.md +--- + +# Set-AzSqlServerAdvisorAutoExecuteStatus + +## SYNOPSIS +Updates the auto execute status of an Azure SQL Server Advisor. + +## SYNTAX + +``` +Set-AzSqlServerAdvisorAutoExecuteStatus -AdvisorName <String> -AutoExecuteStatus <AdvisorAutoExecuteStatus> + -ServerName <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlServerAdvisorAutoExecuteStatus** cmdlet sets the auto execute property for an Azure SQL Server Advisor. + +## EXAMPLES + +### Example 1: Enable auto execute for an Advisor +```powershell +Set-AzSqlServerAdvisorAutoExecuteStatus -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -AdvisorName "CreateIndex" -AutoExecuteStatus Enabled +``` + +```output +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +AdvisorStatus : GA +AutoExecuteStatus : Enabled +AutoExecuteStatusInheritedFrom : Server +LastChecked : 8/1/2016 2:36:47 PM +RecommendationsStatus : Ok +RecommendedActions : {} +``` + +This command enables the auto execute status of an Advisor named CreateIndex. + +## PARAMETERS + +### -AdvisorName +Specifies the name of the advisor for which this cmdlet updates the auto execute status. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AutoExecuteStatus +Specifies the value to which this cmdlet updates the auto execute status. +The acceptable values for this parameter are: +- Enabled +- Disabled +- Default + +```yaml +Type: Microsoft.Azure.Commands.Sql.Advisor.Cmdlet.AdvisorAutoExecuteStatus +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled, Default + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Advisor.Cmdlet.AdvisorAutoExecuteStatus + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Advisor.Model.AzureSqlServerAdvisorModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, server, mssql, advisor + +## RELATED LINKS + +[Get-AzSqlServerAdvisor](./Get-AzSqlServerAdvisor.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlServerAudit.md b/azps-10.1.0/Az.Sql/Set-AzSqlServerAudit.md new file mode 100644 index 0000000000..50c2607c43 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlServerAudit.md @@ -0,0 +1,437 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/Set-AzSqlServerAudit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerAudit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerAudit.md +--- + +# Set-AzSqlServerAudit + +## SYNOPSIS +Changes the auditing settings of an Azure SQL server. + +## SYNTAX + +### ServerParameterSet (Default) +``` +Set-AzSqlServerAudit [-AuditActionGroup <AuditActionGroups[]>] [-PredicateExpression <String>] + [-StorageKeyType <String>] [-RetentionInDays <UInt32>] [-BlobStorageTargetState <String>] + [-StorageAccountResourceId <String>] [-EventHubTargetState <String>] [-EventHubName <String>] + [-EventHubAuthorizationRuleResourceId <String>] [-LogAnalyticsTargetState <String>] + [-WorkspaceResourceId <String>] [-PassThru] [-UseIdentity <String>] [-ResourceGroupName] <String> + [-ServerName] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ServerObjectParameterSet +``` +Set-AzSqlServerAudit [-AuditActionGroup <AuditActionGroups[]>] [-PredicateExpression <String>] + [-StorageKeyType <String>] [-RetentionInDays <UInt32>] [-BlobStorageTargetState <String>] + [-StorageAccountResourceId <String>] [-EventHubTargetState <String>] [-EventHubName <String>] + [-EventHubAuthorizationRuleResourceId <String>] [-LogAnalyticsTargetState <String>] + [-WorkspaceResourceId <String>] [-PassThru] [-UseIdentity <String>] -ServerObject <AzureSqlServerModel> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlServerAudit** cmdlet changes the auditing settings of an Azure SQL server. +To use the cmdlet, use the *ResourceGroupName* and *ServerName* parameters to identify the server. +When blob storage is a destination for audit logs, specify the *StorageAccountResourceId* parameter to determine the storage account for the audit logs and the *StorageKeyType* parameter to define the storage keys. You can also define retention for the audit logs by setting the value of the *RetentionInDays* parameter to define the period for the audit logs. + +## EXAMPLES + +### Example 1: Enable the blob storage auditing policy of an Azure SQL server +```powershell +Set-AzSqlServerAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" +``` + +### Example 2: Disable the blob storage auditing policy of an Azure SQL server +```powershell +Set-AzSqlServerAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -BlobStorageTargetState Disabled +``` + +### Example 3: Enable the blob storage auditing policy of an Azure SQL server with filtering using a T-SQL predicate +```powershell +Set-AzSqlServerAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -PredicateExpression "statement <> 'select 1'" +``` + +### Example 4: Remove the filtering setting from the auditing policy of an Azure SQL server +```powershell +Set-AzSqlServerAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -PredicateExpression "" +``` + +### Example 5: Enable the event hub auditing policy of an Azure SQL server +```powershell +Set-AzSqlServerAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId" +``` + +### Example 6: Disable the event hub auditing policy of an Azure SQL server +```powershell +Set-AzSqlServerAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -EventHubTargetState Disabled +``` + +### Example 7: Enable the log analytics auditing policy of an Azure SQL server +```powershell +Set-AzSqlServerAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +### Example 8: Disable the log analytics auditing policy of an Azure SQL server +```powershell +Set-AzSqlServerAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -LogAnalyticsTargetState Disabled +``` + +### Example 9: Disable, through pipeline, the log analytics auditing policy of an Azure SQL server +```powershell +Get-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" | Set-AzSqlServerAudit -LogAnalyticsTargetState Disabled +``` + +### Example 10: Disable sending audit records of an Azure SQL server to blob storage, and enable sending them to log analytics. +```powershell +Set-AzSqlServerAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" -BlobStorageTargetState Disabled +``` + +### Example 11: Enable sending audit records of an Azure SQL server to blob storage, event hub and log analytics. +```powershell +Set-AzSqlServerAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditActionGroup +The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: + +"BATCH_COMPLETED_GROUP", +"SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", +"FAILED_DATABASE_AUTHENTICATION_GROUP" +This above combination is also the set that is configured by default. These groups cover all SQL statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. +For more information, see https://learn.microsoft.com/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Auditing.Model.AuditActionGroups[] +Parameter Sets: (All) +Aliases: +Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP, LEDGER_OPERATION_GROUP, DBCC_GROUP, DATABASE_OWNERSHIP_CHANGE_GROUP, DATABASE_CHANGE_GROUP + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobStorageTargetState +Indicates whether blob storage is a destination for audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubAuthorizationRuleResourceId +The resource Id for the event hub authorization rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the event hub. If none is specified when providing EventHubAuthorizationRuleResourceId, the default event hub will be selected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubTargetState +Indicates whether event hub is a destination for audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticsTargetState +Indicates whether log analytics is a destination for audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Specifies whether to output the auditing policy at end of cmdlet execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PredicateExpression +The T-SQL predicate (WHERE clause) used to filter audit logs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ServerParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionInDays +The number of retention days for the audit logs. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: ServerParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerObject +The server object to manage its audit policy. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: ServerObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The storage account resource id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageKeyType +Specifies which of the storage access keys to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseIdentity +Indicates whether to use managed identity or not. It is required when you want to use managed identity while target storage is not behind firewall. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Audit Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +### Microsoft.Azure.Commands.Sql.Auditing.Model.AuditActionGroups[] + +### System.Guid + +### System.Nullable`1[[System.UInt32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.Sql.Auditing.Model.ServerAuditModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlServerConfigurationOption.md b/azps-10.1.0/Az.Sql/Set-AzSqlServerConfigurationOption.md new file mode 100644 index 0000000000..036ddf04c5 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlServerConfigurationOption.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlserverconfigurationoption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerConfigurationOption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerConfigurationOption.md +--- + +# Set-AzSqlServerConfigurationOption + +## SYNOPSIS +Sets the value for a server configuration option on Azure SQL Managed Instance. + +## SYNTAX + +### CreateByNameParameterSet (Default) +``` +Set-AzSqlServerConfigurationOption [-ResourceGroupName] <String> [-InstanceName] <String> [-Name] <String> + [-Value] <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByParentObjectParameterSet +``` +Set-AzSqlServerConfigurationOption [-Name] <String> [-Value] <Int32> + [-InstanceObject] <AzureSqlManagedInstanceModel> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlServerConfigurationOption** cmdlet sets the value of a server configuration option on Azure SQL Managed Instance. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSqlServerConfigurationOption -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "allowPolybaseExport" +``` + +```Output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/serverConfigurationOptions +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverConfigurationOptions/allowPolybaseExport +Name : allowPolybaseExport +Value : 1 +``` + +This command sets the value of a server configuration option named "allowPolybaseExport" on instance "Instance01" and resource group "ResourceGroup01". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +Instance input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: CreateByParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the server configuration option. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ConfigOptionName +Accepted values: allowPolybaseExport + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Value of the server configuration option. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: ConfigOptionValue +Accepted values: 0, 1 + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerConfigurationOptions.Model.ServerConfigurationOptionsModel + +## NOTES + +## RELATED LINKS + +[Get-ServerConfigurationOption](./Get-ServerConfigurationOption.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlServerDisasterRecoveryConfiguration.md b/azps-10.1.0/Az.Sql/Set-AzSqlServerDisasterRecoveryConfiguration.md new file mode 100644 index 0000000000..a060b07838 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlServerDisasterRecoveryConfiguration.md @@ -0,0 +1,188 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 44F8EFF4-8E3D-4657-9D17-2A3F49CEA515 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlserverdisasterrecoveryconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerDisasterRecoveryConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerDisasterRecoveryConfiguration.md +--- + +# Set-AzSqlServerDisasterRecoveryConfiguration + +## SYNOPSIS +Modifies a database server recovery configuration. + +## SYNTAX + +``` +Set-AzSqlServerDisasterRecoveryConfiguration -VirtualEndpointName <String> [-Failover] [-AllowDataLoss] + [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlServerDisasterRecoveryConfiguration** cmdlet modifies a SQL database server recovery configuration. + +## EXAMPLES + +## PARAMETERS + +### -AllowDataLoss +Indicates that the failover operation permits data loss. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```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 credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Failover +Indicates that this operation is a failover. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of a SQL database server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualEndpointName +Specifies the name of a virtual end point. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerDisasterRecoveryConfiguration.Model.AzureSqlServerDisasterRecoveryConfigurationModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServerDisasterRecoveryConfiguration](./Get-AzSqlServerDisasterRecoveryConfiguration.md) + +[New-AzSqlServerDisasterRecoveryConfiguration](./New-AzSqlServerDisasterRecoveryConfiguration.md) + +[Remove-AzSqlServerDisasterRecoveryConfiguration](./Remove-AzSqlServerDisasterRecoveryConfiguration.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlServerDnsAlias.md b/azps-10.1.0/Az.Sql/Set-AzSqlServerDnsAlias.md new file mode 100644 index 0000000000..a5ab4abc6e --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlServerDnsAlias.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlserverdnsalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerDnsAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerDnsAlias.md +--- + +# Set-AzSqlServerDnsAlias + +## SYNOPSIS +Modifies the server to which Azure SQL Server DNS Alias is pointing + +## SYNTAX + +``` +Set-AzSqlServerDnsAlias -Name <String> -TargetServerName <String> [-ResourceGroupName] <String> + -SourceServerName <String> -SourceServerResourceGroupName <String> -SourceServerSubscriptionId <Guid> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command is updating the server to which alias is pointing. +This command needs to be issued while logged into subscription where new server to which alias is going to point is located. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSqlServerDnsAlias -ResourceGroupName rg -DnsAliasName aliasName -TargetServerName newServer -SourceServerName oldServer -SourceServerResourceGroupName SourceServerRG -SourceServerSubscriptionId 0000-0000-0000-0000 +``` + +This command is updating alias which was previously pointing to oldServer to point to server newServer + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Azure Sql Server Dns Alias name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DnsAliasName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TargetResourceGroupName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceServerName +The name of Azure Sql Server to which alias is currently pointing. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceServerResourceGroupName +The name of resource group of the source server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceServerSubscriptionId +The subscription id of the source server + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetServerName +The name of Azure Sql Server to which alias should point. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ServerDnsAlias.Model.AzureSqlServerDnsAliasModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlServerFirewallRule.md b/azps-10.1.0/Az.Sql/Set-AzSqlServerFirewallRule.md new file mode 100644 index 0000000000..c02ffb154e --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlServerFirewallRule.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: B407CF77-792B-40F8-87AB-49FB3DCEE646 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlserverfirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerFirewallRule.md +--- + +# Set-AzSqlServerFirewallRule + +## SYNOPSIS +Modifies a firewall rule in Azure SQL Database server. + +## SYNTAX + +``` +Set-AzSqlServerFirewallRule [-FirewallRuleName] <String> -StartIpAddress <String> -EndIpAddress <String> + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlServerFirewallRule** cmdlet modifies a firewall rule in an Azure SQL Database server. + +## EXAMPLES + +### Example 1: Modify a firewall rule +```powershell +Set-AzSqlServerFirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -FirewallRuleName "Rule01" -StartIpAddress "192.168.0.197" -EndIpAddress "192.168.0.199" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +StartIpAddress : 192.168.0.199 +EndIpAddress : 192.168.0.200 +FirewallRuleName : Rule01 +``` + +This command modifies a firewall rule named Rule01 on the server named Server01. +The command modifies the start and end IP addresses. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIpAddress +Specifies the end value of the IP address range for this rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleName +Specifies the name of the firewall rule that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartIpAddress +Specifies the start value of the IP address range for the firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServerFirewallRule](./Get-AzSqlServerFirewallRule.md) + +[New-AzSqlServerFirewallRule](./New-AzSqlServerFirewallRule.md) + +[Remove-AzSqlServerFirewallRule](./Remove-AzSqlServerFirewallRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlServerIpv6FirewallRule.md b/azps-10.1.0/Az.Sql/Set-AzSqlServerIpv6FirewallRule.md new file mode 100644 index 0000000000..9574d50fda --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlServerIpv6FirewallRule.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlserveripv6firewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerIpv6FirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerIpv6FirewallRule.md +--- + +# Set-AzSqlServerIpv6FirewallRule + +## SYNOPSIS +Modifies an IPv6 firewall rule in Azure SQL Database server. + +## SYNTAX + +``` +Set-AzSqlServerIpv6FirewallRule [-Ipv6FirewallRuleName] <String> -StartIpv6Address <String> -EndIpv6Address <String> + [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlServerIpv6FirewallRule** cmdlet modifies an IPv6 firewall rule in an Azure SQL Database server. + +## EXAMPLES + +### Example 1: Modify an IPv6 firewall rule +```powershell +Set-AzSqlServerIpv6FirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Ipv6FirewallRuleName "Rule01" -StartIpv6Address "0000:0000:0000:0000:0000:ffff:c0a8:00c5" -EndIpv6Address "0000:0000:0000:0000:0000:ffff:c0a8:00c7" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +StartIpv6Address : 0000:0000:0000:0000:0000:ffff:c0a8:00c7 +EndIpv6Address : 0000:0000:0000:0000:0000:ffff:c0a8:00c8 +Ipv6FirewallRuleName : Rule01 +``` + +This command modifies an IPv6 firewall rule named Rule01 on the server named Server01. +The command modifies the start and end IPv6 addresses. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIpv6Address +Specifies the end value of the IPv6 address range for this rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ipv6FirewallRuleName +Specifies the name of the IPv6 firewall rule that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartIpv6Address +Specifies the start value of the IPv6 address range for the IPv6 firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Ipv6FirewallRule.Model.AzureSqlServerIpv6FirewallRuleModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlServerIpv6FirewallRule](./Get-AzSqlServerIpv6FirewallRule.md) + +[New-AzSqlServerIpv6FirewallRule](./New-AzSqlServerIpv6FirewallRule.md) + +[Remove-AzSqlServerIpv6FirewallRule](./Remove-AzSqlServerIpv6FirewallRule.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlServerMSSupportAudit.md b/azps-10.1.0/Az.Sql/Set-AzSqlServerMSSupportAudit.md new file mode 100644 index 0000000000..66628d6457 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlServerMSSupportAudit.md @@ -0,0 +1,354 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 +online version: https://learn.microsoft.com/powershell/module/az.sql/Set-AzSqlServerMSSupportAudit +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerMSSupportAudit.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerMSSupportAudit.md +--- + +# Set-AzSqlServerMSSupportAudit + +## SYNOPSIS +Changes the Microsoft support operations auditing settings of an Azure SQL server. + +## SYNTAX + +### ServerParameterSet (Default) +``` +Set-AzSqlServerMSSupportAudit [-BlobStorageTargetState <String>] [-StorageAccountResourceId <String>] + [-EventHubTargetState <String>] [-EventHubName <String>] [-EventHubAuthorizationRuleResourceId <String>] + [-LogAnalyticsTargetState <String>] [-WorkspaceResourceId <String>] [-PassThru] [-UseIdentity <String>] + [-ResourceGroupName] <String> [-ServerName] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ServerObjectParameterSet +``` +Set-AzSqlServerMSSupportAudit [-BlobStorageTargetState <String>] [-StorageAccountResourceId <String>] + [-EventHubTargetState <String>] [-EventHubName <String>] [-EventHubAuthorizationRuleResourceId <String>] + [-LogAnalyticsTargetState <String>] [-WorkspaceResourceId <String>] [-PassThru] [-UseIdentity <String>] + -ServerObject <AzureSqlServerModel> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlServerMSSupportAudit** cmdlet changes the Microsoft support operations auditing settings of an Azure SQL server. +To use the cmdlet, use the *ResourceGroupName* and *ServerName* parameters to identify the server. +When blob storage is a destination for audit logs, specify the *StorageAccountResourceId* parameter to determine the storage account for the audit logs. + +## EXAMPLES + +### Example 1: Enable the blob storage Microsoft support operations auditing policy of an Azure SQL server +```powershell +Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" +``` + +### Example 2: Disable the blob storage Microsoft support operations auditing policy of an Azure SQL server +```powershell +Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -BlobStorageTargetState Disabled +``` + +### Example 3: Enable the event hub Microsoft support operations auditing policy of an Azure SQL server +```powershell +Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId" +``` + +### Example 4: Disable the event hub Microsoft support operations auditing policy of an Azure SQL server +```powershell +Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -EventHubTargetState Disabled +``` + +### Example 5: Enable the log analytics Microsoft support operations auditing policy of an Azure SQL server +```powershell +Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +### Example 6: Disable the log analytics Microsoft support operations auditing policy of an Azure SQL server +```powershell +Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -LogAnalyticsTargetState Disabled +``` + +### Example 7: Disable, through pipeline, the log analytics Microsoft support operations auditing policy of an Azure SQL server +```powershell +Get-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" | Set-AzSqlServerMSSupportAudit -LogAnalyticsTargetState Disabled +``` + +### Example 8: Disable sending Microsoft support operations audit records of an Azure SQL server to blob storage, and enable sending them to log analytics. +```powershell +Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" -BlobStorageTargetState Disabled +``` + +### Example 9: Enable sending Microsoft support operations audit records of an Azure SQL server to blob storage, event hub and log analytics. +```powershell +Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobStorageTargetState +Indicates whether blob storage is a destination for Microsoft support operations audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubAuthorizationRuleResourceId +The resource Id for the event hub authorization rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the event hub. If none is specified when providing EventHubAuthorizationRuleResourceId, the default event hub will be selected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubTargetState +Indicates whether event hub is a destination for Microsoft support operations audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticsTargetState +Indicates whether log analytics is a destination for Microsoft support operations audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Specifies whether to output the Microsoft support operations auditing policy at end of cmdlet execution + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ServerParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +SQL server name. + +```yaml +Type: System.String +Parameter Sets: ServerParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerObject +The server object to manage its Microsoft support operations audit policy. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel +Parameter Sets: ServerObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The storage account resource id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseIdentity +Indicates whether to use managed identity or not. It is required when you want to use managed identity while target storage is not behind firewall. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Microsoft support operations Audit Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + +### System.Guid + +### System.Nullable`1[[System.UInt32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.Sql.Auditing.Model.ServerDevOpsAuditModel + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlServerRecommendedActionState.md b/azps-10.1.0/Az.Sql/Set-AzSqlServerRecommendedActionState.md new file mode 100644 index 0000000000..11b5780c18 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlServerRecommendedActionState.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 26EC220C-5123-4CEF-8CC6-5FFD08F33481 +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlserverrecommendedactionstate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerRecommendedActionState.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerRecommendedActionState.md +--- + +# Set-AzSqlServerRecommendedActionState + +## SYNOPSIS +Updates the state of an Azure SQL Server recommended action. + +## SYNTAX + +``` +Set-AzSqlServerRecommendedActionState -RecommendedActionName <String> -State <RecommendedActionState> + -ServerName <String> -AdvisorName <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSqlServerRecommendedActionState** cmdlet updates state of an Azure SQL Server recommended action. +This cmdlet applies, reverts, or discards the recommended action based on the new state. + +## EXAMPLES + +### Example1: Update the state of the specified recommended action to Pending +```powershell +Set-AzSqlServerRecommendedActionState -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -AdvisorName "CreateIndex" -RecommendedActionName "IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893" -State Pending +``` + +```output +ResourceGroupName : WIRunnersProd +ServerName : wi-runner-australia-east +AdvisorName : CreateIndex +RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 +Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, + NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} +ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo +EstimatedImpact : {ActionDuration, SpaceChange} +ExecuteActionDuration : PT1M +ExecuteActionInitiatedBy : User +ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM +ExecuteActionStartTime : 4/21/2016 3:24:47 PM +ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo +IsArchivedAction : False +IsExecutableAction : True +IsRevertableAction : True +LastRefresh : 4/21/2016 3:24:47 PM +LinkedObjects : {} +ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} +RecommendationReason : +RevertActionDuration : +RevertActionInitiatedBy : +RevertActionInitiatedTime : +RevertActionStartTime : +Score : 2 +State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo +TimeSeries : {} +ValidSince : 4/21/2016 3:24:47 PM +``` + +Updates state of server recommended action named "IR_\[test_schema\]_\[test_table_0.0361551\]_6C7AE8CC9C87E7FD5893" to "Pending" + +## PARAMETERS + +### -AdvisorName +Specifies the name of the advisor that contains the recommended action. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecommendedActionName +Specifies the name of the recommended action for which this cmdlet updates the state. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -State +Specifies the new value to which this cmdlet updates the recommended action state. +The acceptable values for this parameter are: +- Active +- Pending +- PendingRevert +- RevertCancelled +- Ignored +- Resolved + +```yaml +Type: Microsoft.Azure.Commands.Sql.RecommendedAction.Cmdlet.RecommendedActionState +Parameter Sets: (All) +Aliases: +Accepted values: Active, Pending, PendingRevert, RevertCancelled, Ignored, Resolved + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.RecommendedAction.Cmdlet.RecommendedActionState + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.RecommendedAction.Model.AzureSqlServerRecommendedActionModel + +## NOTES +* Keywords: azure, azurerm, arm, resource, management, manager, sql, server, mssql, advisor, recommendedaction + +## RELATED LINKS + +[Get-AzSqlServerAdvisor](./Get-AzSqlServerAdvisor.md) + +[Get-AzSqlServerRecommendedAction](./Get-AzSqlServerRecommendedAction.md) + +[Set-AzSqlDatabaseRecommendedActionState](./Set-AzSqlDatabaseRecommendedActionState.md) + +[Set-AzSqlElasticPoolRecommendedActionState](./Set-AzSqlElasticPoolRecommendedActionState.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlServerTransparentDataEncryptionProtector.md b/azps-10.1.0/Az.Sql/Set-AzSqlServerTransparentDataEncryptionProtector.md new file mode 100644 index 0000000000..3a69e94ed7 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlServerTransparentDataEncryptionProtector.md @@ -0,0 +1,236 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlservertransparentdataencryptionprotector +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerTransparentDataEncryptionProtector.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerTransparentDataEncryptionProtector.md +--- + +# Set-AzSqlServerTransparentDataEncryptionProtector + +## SYNOPSIS +Sets the Transparent Data Encryption (TDE) protector for a SQL server. + +## SYNTAX + +``` +Set-AzSqlServerTransparentDataEncryptionProtector [-Type] <EncryptionProtectorType> [[-KeyId] <String>] + [-AutoRotationEnabled <Boolean>] [-Force] [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzSqlServerTransparentDataEncryptionProtector cmdlet sets the TDE protector for a SQL server. +Changing the TDE protector type will rotate the protector. + +## EXAMPLES + +### Example 1: Set the Transparent Data Encryption (TDE) protector type to ServiceManaged +```powershell +Set-AzSqlServerTransparentDataEncryptionProtector -Type ServiceManaged -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup' +``` + +```output +ResourceGroupName ServerName Type ServerKeyVaultKeyName +----------------- ---------- ---- --------------------- +ContosoResourceGroup ContosoServer ServiceManaged ServiceManaged +``` + +This command updates a server's TDE protector type to Service Managed. + +### Example 2: Set the Transparent Data Encryption protector type to Azure Key Vault +```powershell +Set-AzSqlServerTransparentDataEncryptionProtector -Type AzureKeyVault -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup' +``` + +```output +ResourceGroupName ServerName Type ServerKeyVaultKeyName +----------------- ---------- ---- --------------------- +ContosoResourceGroup ContosoServer AzureKeyVault contoso_contosokey_01234567890123456789012345678901 +``` + +This command updates a server to use the Server Key Vault Key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' as the TDE protector. + +### Example 3 + +Sets the Transparent Data Encryption (TDE) protector for a SQL server. (autogenerated) + +<!-- Aladdin Generated Example --> + +```powershell +Set-AzSqlServerTransparentDataEncryptionProtector -AutoRotationEnabled $false -KeyId 'https://contoso.vault.azure.net/keys/contosokey/0000000000000000000000000000000000000' -ResourceGroupName 'ContosoResourceGroup' -ServerName 'ContosoServer' -Type AzureKeyVault +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoRotationEnabled +The key auto rotation opt-in status. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyId +The Azure Key Vault KeyId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Type +The Azure Sql Database TDE protector type. + +```yaml +Type: Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.EncryptionProtectorType +Parameter Sets: (All) +Aliases: +Accepted values: AzureKeyVault, ServiceManaged + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.EncryptionProtectorType + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlServerTransparentDataEncryptionProtectorModel + +## NOTES + +## RELATED LINKS + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Set-AzSqlServerVirtualNetworkRule.md b/azps-10.1.0/Az.Sql/Set-AzSqlServerVirtualNetworkRule.md new file mode 100644 index 0000000000..b44a3f13c2 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Set-AzSqlServerVirtualNetworkRule.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/set-azsqlservervirtualnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerVirtualNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Set-AzSqlServerVirtualNetworkRule.md +--- + +# Set-AzSqlServerVirtualNetworkRule + +## SYNOPSIS +Modifies the configuration of an Azure SQL Server Virtual Network Rule. + +## SYNTAX + +``` +Set-AzSqlServerVirtualNetworkRule -VirtualNetworkRuleName <String> -VirtualNetworkSubnetId <String> + [-IgnoreMissingVnetServiceEndpoint] [-AsJob] -ServerName <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command modifies the configuration of an Azure SQL Server Virtual Network Rule. +To control the set of virtual network rules in the server, use 'Add-AzSqlServerVirtualNetworkRule' and 'Remove-AzSqlServerVirtualNetworkRule' instead. + +## EXAMPLES + +### Example 1 +```powershell +$virtualNetworkRule = Set-AzSqlServerVirtualNetworkRule -ResourceGroupName rg -ServerName serverName -VirtualNetworkRuleName virtualNetworkRuleName -VirtualNetworkSubnetId virtualNetworkSubnetId +``` + +Modifies an existing virtual network rule with the new virtual network subnet id which contains information about the new virtual network + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreMissingVnetServiceEndpoint +Create firewall rule before the virtual network has vnet service endpoint enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The Azure Sql Server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRuleName +The name of the Azure Sql Server Virtual Network Rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkSubnetId +The Virtual Network Subnet Id for the rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VirtualNetworkRule.Model.AzureSqlServerVirtualNetworkRuleModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Start-AzSqlDatabaseExecuteIndexRecommendation.md b/azps-10.1.0/Az.Sql/Start-AzSqlDatabaseExecuteIndexRecommendation.md new file mode 100644 index 0000000000..0ae8f6d997 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Start-AzSqlDatabaseExecuteIndexRecommendation.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 0EA0B131-A3D0-43CA-8517-9E724A11B04F +online version: https://learn.microsoft.com/powershell/module/az.sql/start-azsqldatabaseexecuteindexrecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Start-AzSqlDatabaseExecuteIndexRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Start-AzSqlDatabaseExecuteIndexRecommendation.md +--- + +# Start-AzSqlDatabaseExecuteIndexRecommendation + +## SYNOPSIS +Starts the workflow that runs a recommended index operation. + +## SYNTAX + +``` +Start-AzSqlDatabaseExecuteIndexRecommendation -ServerName <String> -DatabaseName <String> + -IndexRecommendationName <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzSqlDatabaseExecuteIndexRecommendation** cmdlet starts the workflow that runs a recommended index operation for an Azure SQL Database. + +## EXAMPLES + +### Example 1: Run an index recommendation +```powershell +Start-AzSqlDatabaseExecuteIndexRecommendation -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -IndexRecommendationName "INDEX_NAME" +``` + +This command runs an index recommendation. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database for which this cmdlet starts the workflow. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IndexRecommendationName +Specifies the name of the index recommendation that this cmdlet runs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the server that hosts the database for which this cmdlet starts a workflow. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Model.IndexRecommendation + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseIndexRecommendation](./Get-AzSqlDatabaseIndexRecommendation.md) + +[Stop-AzSqlDatabaseExecuteIndexRecommendation](./Stop-AzSqlDatabaseExecuteIndexRecommendation.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Start-AzSqlDatabaseVulnerabilityAssessmentScan.md b/azps-10.1.0/Az.Sql/Start-AzSqlDatabaseVulnerabilityAssessmentScan.md new file mode 100644 index 0000000000..44d9fc659d --- /dev/null +++ b/azps-10.1.0/Az.Sql/Start-AzSqlDatabaseVulnerabilityAssessmentScan.md @@ -0,0 +1,321 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/start-azsqldatabasevulnerabilityassessmentscan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Start-AzSqlDatabaseVulnerabilityAssessmentScan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Start-AzSqlDatabaseVulnerabilityAssessmentScan.md +--- + +# Start-AzSqlDatabaseVulnerabilityAssessmentScan + +## SYNOPSIS +Starts a vulnerability assessment scan. + +## SYNTAX + +``` +Start-AzSqlDatabaseVulnerabilityAssessmentScan [-ServerName] <String> [-DatabaseName] <String> + [-InputObject <AzureSqlDatabaseModel>] [-AsJob] [-ScanId <String>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzSqlDatabaseVulnerabilityAssessmentScan** cmdlet triggers a scan with ScanId identifier. +Scan results will be saved under the storage defined by the Update-AzSqlServerVulnerabilityAssessmentSetting cmdlet, under scans/{ServerName}/{DatabaseName}/scan_{ScanId}.json +You can monitor the progress of the scan by using the *Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord* cmdlet with the scanId parameter and look at the State returned parameter. +Note that you need to run *Enable-AzSqlServerAdvancedDataSecurity* and *Update-AzSqlServerVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1: Starts a vulnerability assessment scan +```powershell +Start-AzSqlDatabaseVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + -ScanId "myScan" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +ScanId : myScan +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/Server01/Database01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +### Example 2: Starts a vulnerability assessment scan without a specific scan ID +```powershell +Start-AzSqlDatabaseVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/Server01/Database01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +This command generates a scan ID in the format of "yyyyMMdd_HHmmss" from the UTC date time. + +### Example 3: Starts a vulnerability assessment scan in the background +```powershell +$scanJob = Start-AzSqlDatabaseVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + -ScanId "myScan" ` + -AsJob +$scanJob | Wait-Job +$scanJob | Receive-Job +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +ScanId : myScan +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/Server01/Database01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +### Example 4: Starts a vulnerability assessment scan with a database object +```powershell +Get-AzSqlDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + | Start-AzSqlDatabaseVulnerabilityAssessmentScan +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/Server01/Database01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +### Example 5: Starts a vulnerability assessment scan on all the databases under a server +```powershell +Get-AzSqlDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + | Where-Object {$_.DatabaseName -ne "master"} ` + | Start-AzSqlDatabaseVulnerabilityAssessmentScan +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/Server01/Database01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 + + +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database02 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/Server01/Database01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The database object to get Vulnerability Assessment settings for + +```yaml +Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScanId +Specifies the scan ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentScanRecordModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Start-AzSqlElasticJob.md b/azps-10.1.0/Az.Sql/Start-AzSqlElasticJob.md new file mode 100644 index 0000000000..f2e9f54557 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Start-AzSqlElasticJob.md @@ -0,0 +1,236 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/start-Azsqlelasticjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Start-AzSqlElasticJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Start-AzSqlElasticJob.md +--- + +# Start-AzSqlElasticJob + +## SYNOPSIS +Starts a job, returning a job execution id that can be polled to view it's status + +## SYNTAX + +### DefaultSet (Default) +``` +Start-AzSqlElasticJob [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> [-Wait] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectSet +``` +Start-AzSqlElasticJob [-ParentObject] <AzureSqlElasticJobModel> [-Wait] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Start-AzSqlElasticJob [-ParentResourceId] <String> [-Wait] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Start-AzSqlElasticJob cmdlet starts a job returning a new job execution + +## EXAMPLES + +### Example 1 - Starts a job returning a new job execution +```powershell +$job = Get-AzSqlElasticJob -ResourceGroupName rg -ServerName elasticjobserver -AgentName agent -Name job1 +$job | Start-AzSqlElasticJob +``` + +```output +JobName JobExecutionId Lifecycle StartTime EndTime +------- -------------- --------- --------- ------- +job1 b93b3a90-987b-4565-b3d3-5fa1751fa9bc Created +``` + +Starts a job returning a new job execution + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The job name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The job object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The job resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +The wait flag to indicate to wait until the job's execution is done + +```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. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobExecutionModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Start-AzSqlInstanceDatabaseLogReplay.md b/azps-10.1.0/Az.Sql/Start-AzSqlInstanceDatabaseLogReplay.md new file mode 100644 index 0000000000..f4ce5ca2b3 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Start-AzSqlInstanceDatabaseLogReplay.md @@ -0,0 +1,316 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/Start-AzSqlInstanceDatabaseLogReplay +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Start-AzSqlInstanceDatabaseLogReplay.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Start-AzSqlInstanceDatabaseLogReplay.md +--- + +# Start-AzSqlInstanceDatabaseLogReplay + +## SYNOPSIS +Starts a Log Replay service with the given parameters. + +## SYNTAX + +### LogReplayInstanceDatabaseFromInputParameters (Default) +``` +Start-AzSqlInstanceDatabaseLogReplay -StorageContainerUri <String> -StorageContainerSasToken <String> + [-AutoCompleteRestore] [-LastBackupName <String>] [-Collation <String>] [-StorageContainerIdentity <String>] + [-AsJob] [-Name] <String> [-InstanceName] <String> [-ResourceGroupName] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### LogReplayInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition +``` +Start-AzSqlInstanceDatabaseLogReplay -StorageContainerUri <String> -StorageContainerSasToken <String> + [-AutoCompleteRestore] [-LastBackupName <String>] [-Collation <String>] [-StorageContainerIdentity <String>] + [-AsJob] [-PassThru] [-InputObject] <AzureSqlManagedDatabaseModel> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzSqlInstanceDatabaseLogReplay** cmdlet initiate start of the log replay service. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzSqlInstanceDatabaseLogReplay -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "ManagedDatabaseName" ` + -Collation "SQL_Latin1_General_CP1_CI_AS" -StorageContainerUri "https://test.blob.core.windows.net/testing" ` + -StorageContainerSasToken "sv=2019-02-02&ss=b&srt=sco&sp=rl&se=2023-12-02T00:09:14Z&st=2019-11-25T16:09:14Z&spr=https&sig=92kAe4QYmXaht%2Fgjocqwerqwer41s%3D" ` + -AutoCompleteRestore -LastBackupName "last_backup.bak" +``` + +This command will create new managed database and will start restoring backups from the given container until last_backup.bak is restored. + +### Example 2 +```powershell +Start-AzSqlInstanceDatabaseLogReplay -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "ManagedDatabaseName" ` + -Collation "SQL_Latin1_General_CP1_CI_AS" -StorageContainerUri "https://test.blob.core.windows.net/testing" ` + -StorageContainerSasToken "sv=2019-02-02&ss=b&srt=sco&sp=rl&se=2023-12-02T00:09:14Z&st=2019-11-25T16:09:14Z&spr=https&sig=92kAe4QYmXaht%2Fgjocqwerqwer41s%3D" +``` + +This command will create new managed database and will start restoring backups from the given container until Complete-AzSqlInstanceDatabaseLogReplay is called with the last backup wanted. + +### Example 3 +```powershell +Start-AzSqlInstanceDatabaseLogReplay -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "ManagedDatabaseName" ` + -StorageContainerIdentity ManagedIdentity -StorageContainerUri "https://test.blob.core.windows.net/testing" +``` + +Starts a Log Replay service with container identity specified as ManagedIdentity. In this case there is no need to specify StorageContainerSasToken parameter. + +### Example 4 +```powershell +Start-AzSqlInstanceDatabaseLogReplay -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "ManagedDatabaseName" ` + -StorageContainerIdentity SharedAccessSignature -StorageContainerUri "https://test.blob.core.windows.net/testing" ` + -StorageContainerSasToken "sv=2019-02-02&ss=b&srt=sco&sp=rl&se=2023-12-02T00:09:14Z&st=2019-11-25T16:09:14Z&spr=https&sig=92kAe4QYmXaht%2Fgjocqwerqwer41s%3D" +``` + +Starts a Log Replay service with container identity specified as SharedAccessSignature. StorageContainerSasToken parameter is required. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoCompleteRestore +The indicator whether or not to auto-complete restore upon completion. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Collation +The collation of the instance database to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The instance database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: LogReplayInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition +Aliases: InstanceDatabase + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The name of the instance. + +```yaml +Type: System.String +Parameter Sets: LogReplayInstanceDatabaseFromInputParameters +Aliases: ManagedInstanceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -LastBackupName +The name of the last backup file to restore. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the instance database. + +```yaml +Type: System.String +Parameter Sets: LogReplayInstanceDatabaseFromInputParameters +Aliases: InstanceDatabaseName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Defines Whether return the sync group. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: LogReplayInstanceDatabaseFromInputParameters +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageContainerIdentity +The identity type to use for storage container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerSasToken +The storage container Sas token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SasToken + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerUri +The storage container URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Storage + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan.md b/azps-10.1.0/Az.Sql/Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan.md new file mode 100644 index 0000000000..7830d287f0 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan.md @@ -0,0 +1,330 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/start-azsqlinstancedatabasevulnerabilityassessmentscan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan.md +--- + +# Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan + +## SYNOPSIS +Starts a vulnerability assessment scan. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan [-InstanceName] <String> [-DatabaseName] <String> + [-AsJob] [-ScanId <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### StartByParentResourceParameterSet +``` +Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan -InputObject <AzureSqlManagedDatabaseModel> [-AsJob] + [-ScanId <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan** cmdlet triggers a scan with ScanId identifier. +Scan results will be saved under the storage defined by the Update-AzSqlInstanceVulnerabilityAssessmentSetting cmdlet, under scans/{ManagedInstanceName}/{ManagedDatabaseName}/scan_{ScanId}.json +You can monitor the progress of the scan by using the *Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord* cmdlet with the scanId parameter and look at the State returned parameter. +Note that you need to run *Enable-AzSqlInstanceAdvancedDataSecurity* and *Update-AzSqlInstanceVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1: Starts a vulnerability assessment scan +```powershell +Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -ScanId "myScan" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +ScanId : myScan +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/ManagedInstance01/Database01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +### Example 2: Starts a vulnerability assessment scan without a specific scan ID +```powershell +Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/ManagedInstance01/Database01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +This command generates a scan ID in the format of "yyyyMMdd_HHmmss" from the UTC date time. + +### Example 3: Starts a vulnerability assessment scan in the background +```powershell +$scanJob = Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -ScanId "myScan" ` + -AsJob +$scanJob | Wait-Job +$scanJob | Receive-Job +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +ScanId : myScan +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/ManagedInstance01/Database01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +### Example 4: Starts a vulnerability assessment scan with a managed database object +```powershell +Get-AzSqlInstanceDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -Name "Database01" ` + | Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/ManagedInstance01/Database01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +### Example 5: Starts a vulnerability assessment scan on all the databases under a managed instance +```powershell +Get-AzSqlInstanceDatabase ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + | Where-Object {$_.Name -ne "master"} ` + | Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/ManagedInstance01/Database01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 + + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database02 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/ManagedInstance01/Database02/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +SQL Managed Database name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The managed database object to get Vulnerability Assessment settings for + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: StartByParentResourceParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScanId +Specifies the scan ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ManagedDatabaseVulnerabilityAssessmentScanRecordModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Start-AzSqlSyncGroupSync.md b/azps-10.1.0/Az.Sql/Start-AzSqlSyncGroupSync.md new file mode 100644 index 0000000000..b0b4a094db --- /dev/null +++ b/azps-10.1.0/Az.Sql/Start-AzSqlSyncGroupSync.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/start-azsqlsyncgroupsync +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Start-AzSqlSyncGroupSync.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Start-AzSqlSyncGroupSync.md +--- + +# Start-AzSqlSyncGroupSync + +## SYNOPSIS +Starts a sync group synchronization. + +## SYNTAX + +``` +Start-AzSqlSyncGroupSync [-SyncGroupName] <String> [-PassThru] [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzSqlSyncGroupSync** cmdlet starts a sync group synchronization. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzSqlSyncGroupSync -SyncGroupName mysg -ServerName mysrv -DatabaseName mydb -ResourceGroupName myrg +``` + +This command starts a round of synchronization for the sync group mysg. + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Defines Whether return the sync group + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncGroupName +The sync group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel + +## NOTES + +## RELATED LINKS + +[Stop-AzSqlSyncGroupSync](./Stop-AzSqlSyncGroupSync.md) + diff --git a/azps-10.1.0/Az.Sql/Stop-AzSqlDatabaseActivity.md b/azps-10.1.0/Az.Sql/Stop-AzSqlDatabaseActivity.md new file mode 100644 index 0000000000..397f4a0a0e --- /dev/null +++ b/azps-10.1.0/Az.Sql/Stop-AzSqlDatabaseActivity.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: B5C909D7-6087-463A-83BF-99DD196B9862 +online version: https://learn.microsoft.com/powershell/module/az.sql/stop-azsqldatabaseactivity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlDatabaseActivity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlDatabaseActivity.md +--- + +# Stop-AzSqlDatabaseActivity + +## SYNOPSIS +Cancels the asynchronous updates operation on the database. + +## SYNTAX + +``` +Stop-AzSqlDatabaseActivity [-ServerName] <String> [-ElasticPoolName <String>] -DatabaseName <String> + [-OperationId <Guid>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSqlDatabaseActivity** cmdlet cancels the asynchronous updates operation on the database. + +## EXAMPLES + +### Example 1: Cancel the asynchronous updates operation on the database +```powershell +Stop-AzSqlDatabaseActivity -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -OperationId af97005d-9243-4f8a-844e-402d1cc855f5 +``` + +```output +OperationId : af97005d-9243-4f8a-844e-402d1cc855f5 +ServerName : Server01 +DatabaseName : Database01 +State : CANCELLED +Operation : UpdateLogicalDatabase +ErrorCode : +ErrorMessage : +ErrorSeverity : +StartTime : 10/15/2017 02:49:42 PM +EndTime : 10/15/2017 02:49:43 PM +PercentComplete : +Properties : Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseActivityModel+DatabaseState +``` + +This command cancels the asynchronous updates operation on the database. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database for which this cmdlet gets status. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +The name of the Azure SQL Elastic Pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OperationId +Specifies the ID of the operation that this cmdlet gets. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the database is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the Microsoft SQL Server that hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseActivityModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Stop-AzSqlDatabaseExecuteIndexRecommendation.md b/azps-10.1.0/Az.Sql/Stop-AzSqlDatabaseExecuteIndexRecommendation.md new file mode 100644 index 0000000000..962da5c51a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Stop-AzSqlDatabaseExecuteIndexRecommendation.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 4D2E0956-FBFA-43CC-ABE3-A6CBB9409263 +online version: https://learn.microsoft.com/powershell/module/az.sql/stop-azsqldatabaseexecuteindexrecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlDatabaseExecuteIndexRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlDatabaseExecuteIndexRecommendation.md +--- + +# Stop-AzSqlDatabaseExecuteIndexRecommendation + +## SYNOPSIS +Stops the workflow that runs a recommended index operation. + +## SYNTAX + +``` +Stop-AzSqlDatabaseExecuteIndexRecommendation -ServerName <String> -DatabaseName <String> + -IndexRecommendationName <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSqlDatabaseExecuteIndexRecommendation** cmdlet stops the workflow that runs a recommended index operation. + +## EXAMPLES + +### Example 1: Stop running an index recommendation +```powershell +Stop-AzSqlDatabaseExecuteIndexRecommendation -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -IndexRecommendationName "INDEX_NAME" +``` + +This command stops running an index recommendation. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database for which this cmdlet stops the workflow. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IndexRecommendationName +Specifies the name of the index recommendation that this cmdlet stops. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the server that hosts the database for which this cmdlet stops a workflow. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Model.IndexRecommendation + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseIndexRecommendation](./Get-AzSqlDatabaseIndexRecommendation.md) + +[Start-AzSqlDatabaseExecuteIndexRecommendation](./Start-AzSqlDatabaseExecuteIndexRecommendation.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Stop-AzSqlElasticJob.md b/azps-10.1.0/Az.Sql/Stop-AzSqlElasticJob.md new file mode 100644 index 0000000000..092039c97a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Stop-AzSqlElasticJob.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/stop-Azsqlelasticjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlElasticJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlElasticJob.md +--- + +# Stop-AzSqlElasticJob + +## SYNOPSIS +Stops a job given it's job execution id + +## SYNTAX + +### DefaultSet (Default) +``` +Stop-AzSqlElasticJob [-ResourceGroupName] <String> [-ServerName] <String> [-AgentName] <String> + [-JobName] <String> -JobExecutionId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectSet +``` +Stop-AzSqlElasticJob [-ParentObject] <AzureSqlElasticJobExecutionModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdSet +``` +Stop-AzSqlElasticJob [-ParentResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Stop-AzSqlElasticJob cmdlet stops a job's with a running execution. +Returns the current status of the job execution + +## EXAMPLES + +### Example 1: Stops a job with a running job execution +```powershell +$je = Get-AzSqlElasticJobExecution -ResourceGroupName rg -ServerName elasticjobserver -AgentName agent -JobName job1 -JobExecutionId dab0ebe8-fd52-42e9-bacf-e5f27577039b +$je | Stop-AzSqlElasticJob +``` + +```output +JobName JobExecutionId Lifecycle StartTime EndTime +------- -------------- --------- --------- ------- +job1 dab0ebe8-fd52-42e9-bacf-e5f27577039b WaitingForChildJobExecutions 6/1/2018 10:13:56 PM +``` + +Stops a running job execution and returns it's current status + +### Example 2 + +<!-- Aladdin Generated Example --> +```powershell +Stop-AzSqlElasticJob -AgentName agent -JobExecutionId 00000000-0000-0000-0000-000000000000 -JobName job1 -ResourceGroupName MyResourceGroup -ServerName s1 +``` + +## PARAMETERS + +### -AgentName +The agent name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobExecutionId +The job execution id. + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The job name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +The Agent Control Database Object + +```yaml +Type: Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobExecutionModel +Parameter Sets: ObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +The job execution resource id + +```yaml +Type: System.String +Parameter Sets: ResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The server name + +```yaml +Type: System.String +Parameter Sets: DefaultSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobExecutionModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobExecutionModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Stop-AzSqlElasticPoolActivity.md b/azps-10.1.0/Az.Sql/Stop-AzSqlElasticPoolActivity.md new file mode 100644 index 0000000000..84090fe740 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Stop-AzSqlElasticPoolActivity.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/stop-azsqlelasticpoolactivity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlElasticPoolActivity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlElasticPoolActivity.md +--- + +# Stop-AzSqlElasticPoolActivity + +## SYNOPSIS +Cancels the asynchronous update operation on an elastic pool. + +## SYNTAX + +``` +Stop-AzSqlElasticPoolActivity [-PassThru] [-ServerName] <String> [-ElasticPoolName] <String> + [-OperationId <Guid>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSqlElasticPoolActivity** cmdlet cancels the asynchronous update operation on an elastic pool. + +## EXAMPLES + +### Example 1: Cancel the asynchronous update operation on an elastic pool +```powershell +Stop-AzSqlElasticPoolActivity -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -OperationId af97005d-9243-4f8a-844e-402d1cc855f5 +``` + +```output +OperationId : af97005d-9243-4f8a-844e-402d1cc855f5 +ServerName : Server01 +DatabaseName : ElasticPool01 +State : CANCELLED +Operation : UpdateLogicalElasticPool +ErrorCode : +ErrorMessage : +ErrorSeverity : +StartTime : 10/15/2017 02:49:42 PM +EndTime : 10/15/2017 02:49:43 PM +PercentComplete : +``` + +This command cancels the asynchronous updates operation on the elastic pool. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticPoolName +The name of the Azure SQL Elastic Pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OperationId +The ID of the operation to retrieve. + +```yaml +Type: System.Nullable`1[System.Guid] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the Elastic Pool is in. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolActivityModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Stop-AzSqlInstanceDatabaseCopy.md b/azps-10.1.0/Az.Sql/Stop-AzSqlInstanceDatabaseCopy.md new file mode 100644 index 0000000000..5edcb8127c --- /dev/null +++ b/azps-10.1.0/Az.Sql/Stop-AzSqlInstanceDatabaseCopy.md @@ -0,0 +1,368 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/stop-azsqlinstancedatabasecopy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlInstanceDatabaseCopy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlInstanceDatabaseCopy.md +--- + +# Stop-AzSqlInstanceDatabaseCopy + +## SYNOPSIS +Stop copy operation of a managed database. + +## SYNTAX + +### MoveCopyManagedDatabaseByNameParameterSet (Default) +``` +Stop-AzSqlInstanceDatabaseCopy -DatabaseName <String> -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CancelManagedDatabaseCopyByCopyModelObject +``` +Stop-AzSqlInstanceDatabaseCopy -CopyModelObject <MoveCopyManagedDatabaseModel> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByOperationObjectParameterSet +``` +Stop-AzSqlInstanceDatabaseCopy [-DatabaseName <String>] [-InstanceName <String>] [-ResourceGroupName <String>] + -MoveCopyOperationObject <ManagedDatabaseMoveCopyOperation> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByInputObjectParameterSet +``` +Stop-AzSqlInstanceDatabaseCopy -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> + -DatabaseObject <AzureSqlManagedDatabaseModel> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByResourceIdParameterSet +``` +Stop-AzSqlInstanceDatabaseCopy -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> -ResourceId <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSqlInstanceDatabaseCopy** cmdlet stops copy operation of a database between two Azure SQL Managed Instances. + +## EXAMPLES + +### Example 1: Complete copy database to another Managed Instance in the same resource group +```powershell +Stop-AzSqlInstanceDatabaseCopy -ResourceGroupName RG1 -InstanceName MI1 -Name database1 -TargetInstanceName MI2 +``` + +This command stops copy operation of database1 on instance MI1 to instance MI2 + +### Example 2: Complete copy database to another Managed Instance in the different resource group +```powershell +Stop-AzSqlInstanceDatabaseCopy -ResourceGroupName RG1 -InstanceName MI1 -Name database1 -TargetResourceGroupName RG2 -TargetInstanceName MI2 +``` + +This command stops copy operation of database1 on instance MI1 in resource group RG1 to instance MI2 in resource group RG2 + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyModelObject +Object that is returned from start copy operation. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel +Parameter Sets: CancelManagedDatabaseCopyByCopyModelObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DatabaseName +Name of the instance database. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +Managed database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of the source instance. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCopyOperationObject +Managed database move or copy operation object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: Operation + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Signal to receive output from a cmdlet which does not return anything + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the source resource group. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource id of managed database. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetInstanceName +Name of the target Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByInputObjectParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +Name of the target resource group. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByInputObjectParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Complete-AzSqlInstanceDatabaseCopy](./Complete-AzSqlInstanceDatabaseCopy.md) + +[Get-AzSqlInstanceDatabaseCopyOperation](./Get-AzSqlInstanceDatabaseCopyOperation.md) + +[Copy-AzSqlInstanceDatabase](./Copy-AzSqlInstanceDatabase.md) diff --git a/azps-10.1.0/Az.Sql/Stop-AzSqlInstanceDatabaseLogReplay.md b/azps-10.1.0/Az.Sql/Stop-AzSqlInstanceDatabaseLogReplay.md new file mode 100644 index 0000000000..c3f45dfaea --- /dev/null +++ b/azps-10.1.0/Az.Sql/Stop-AzSqlInstanceDatabaseLogReplay.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/Stop-AzSqlInstanceDatabaseLogReplay +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlInstanceDatabaseLogReplay.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlInstanceDatabaseLogReplay.md +--- + +# Stop-AzSqlInstanceDatabaseLogReplay + +## SYNOPSIS +Cancels the Log Replay service by dropping the database. + +## SYNTAX + +### LogReplayInstanceDatabaseFromInputParameters (Default) +``` +Stop-AzSqlInstanceDatabaseLogReplay [-Force] [-Name] <String> [-InstanceName] <String> + [-ResourceGroupName] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### LogReplayInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition +``` +Stop-AzSqlInstanceDatabaseLogReplay [-Force] [-PassThru] [-InputObject] <AzureSqlManagedDatabaseModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSqlInstanceDatabaseLogReplay** cmdlet drops the database and thus cancel Log Replay service. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzSqlInstanceDatabaseLogReplay -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "ManagedDatabaseName" +``` + +This command will cancel log replay service on the given database. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The instance database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: LogReplayInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition +Aliases: InstanceDatabase + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +The name of the instance. + +```yaml +Type: System.String +Parameter Sets: LogReplayInstanceDatabaseFromInputParameters +Aliases: ManagedInstanceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The name of the instance database. + +```yaml +Type: System.String +Parameter Sets: LogReplayInstanceDatabaseFromInputParameters +Aliases: InstanceDatabaseName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Defines Whether return the sync group. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: LogReplayInstanceDatabaseFromInputParameters +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Stop-AzSqlInstanceDatabaseMove.md b/azps-10.1.0/Az.Sql/Stop-AzSqlInstanceDatabaseMove.md new file mode 100644 index 0000000000..df0531f4a4 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Stop-AzSqlInstanceDatabaseMove.md @@ -0,0 +1,368 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/stop-azsqlinstancedatabasemove +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlInstanceDatabaseMove.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlInstanceDatabaseMove.md +--- + +# Stop-AzSqlInstanceDatabaseMove + +## SYNOPSIS +Stop move operation of a managed database. + +## SYNTAX + +### MoveCopyManagedDatabaseByNameParameterSet (Default) +``` +Stop-AzSqlInstanceDatabaseMove -DatabaseName <String> -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CancelManagedDatabaseMoveByMoveModelObject +``` +Stop-AzSqlInstanceDatabaseMove -MoveModelObject <MoveCopyManagedDatabaseModel> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByOperationObjectParameterSet +``` +Stop-AzSqlInstanceDatabaseMove [-DatabaseName <String>] [-InstanceName <String>] [-ResourceGroupName <String>] + -MoveCopyOperationObject <ManagedDatabaseMoveCopyOperation> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByInputObjectParameterSet +``` +Stop-AzSqlInstanceDatabaseMove -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> + -DatabaseObject <AzureSqlManagedDatabaseModel> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### MoveCopyManagedDatabaseByResourceIdParameterSet +``` +Stop-AzSqlInstanceDatabaseMove -InstanceName <String> -ResourceGroupName <String> + [-TargetResourceGroupName <String>] -TargetInstanceName <String> -ResourceId <String> [-AsJob] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSqlInstanceDatabaseMove** cmdlet stops move operation of a database between two Azure SQL Managed Instances. + +## EXAMPLES + +### Example 1: Complete move database to another Managed Instance in the same resource group +```powershell +Stop-AzSqlInstanceDatabaseMove -ResourceGroupName RG1 -InstanceName MI1 -Name database1 -TargetInstanceName MI2 +``` + +This command stops move operation of database1 on instance MI1 to instance MI2 + +### Example 2: Complete move database to another Managed Instance in the different resource group +```powershell +Stop-AzSqlInstanceDatabaseMove -ResourceGroupName RG1 -InstanceName MI1 -Name database1 -TargetResourceGroupName RG2 -TargetInstanceName MI2 +``` + +This command stops move operation of database1 on instance MI1 in resource group RG1 to instance MI2 in resource group RG2 + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Name of the instance database. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseObject +Managed database object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceName +Name of the source instance. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveCopyOperationObject +Managed database move or copy operation object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: Operation + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MoveModelObject +Object that is returned from start move operation. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel +Parameter Sets: CancelManagedDatabaseMoveByMoveModelObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Signal to receive output from a cmdlet which does not return anything + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the source resource group. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByOperationObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource id of managed database. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetInstanceName +Name of the target Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByInputObjectParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +Name of the target resource group. + +```yaml +Type: System.String +Parameter Sets: MoveCopyManagedDatabaseByNameParameterSet, MoveCopyManagedDatabaseByInputObjectParameterSet, MoveCopyManagedDatabaseByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.MoveCopyManagedDatabaseModel + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel + +### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.ManagedDatabaseMoveCopyOperation + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Complete-AzSqlInstanceDatabaseMove](./Complete-AzSqlInstanceDatabaseMove.md) + +[Get-AzSqlInstanceDatabaseMoveOperation](./Get-AzSqlInstanceDatabaseMoveOperation.md) + +[Move-AzSqlInstanceDatabase](./Move-AzSqlInstanceDatabase.md) diff --git a/azps-10.1.0/Az.Sql/Stop-AzSqlInstanceOperation.md b/azps-10.1.0/Az.Sql/Stop-AzSqlInstanceOperation.md new file mode 100644 index 0000000000..210517388c --- /dev/null +++ b/azps-10.1.0/Az.Sql/Stop-AzSqlInstanceOperation.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/stop-azsqlinstanceoperation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlInstanceOperation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlInstanceOperation.md +--- + +# Stop-AzSqlInstanceOperation + +## SYNOPSIS +Stops a SQL managed instance's operations. + +## SYNTAX + +### StopByNameAndManagedInstanceAndResourceGroupParameterSet (Default) +``` +Stop-AzSqlInstanceOperation [-Name] <String> [-ManagedInstanceName] <String> [-ResourceGroupName] <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByResourceIdParameterSet +``` +Stop-AzSqlInstanceOperation [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByInputObjectParameterSet +``` +Stop-AzSqlInstanceOperation [-InputObject] <AzureSqlManagedInstanceOperationModel> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Stop-AzSqlInstanceOperation cmdlet stops operation with provided operation name on a SQL managed instance. + +## EXAMPLES + +### Example 1: Get a specific operation +```powershell +Stop-AzSqlInstanceOperation -ResourceGroupName ps3753 -ManagedInstanceName ps3698 -Name d0f5bef5-e2b1-4ef8-bb42-2e54073874f9 +``` + +```output +Id : /subscriptions/a8c9a924-06c0-4bde-9788-e7b1370969e1/resourceGroups/ps3753/providers/Microsoft.Sql/managedInstances/ps3698/operations/d0f5bef5-e2b1-4ef8-bb42-2e54073874f9 +ResourceGroupName : ps3753 +ManagedInstanceName : ps3698 +Name : d0f5bef5-e2b1-4ef8-bb42-2e54073874f9 +Operation : UpsertManagedServer +OperationFriendlyName : UPDATE MANAGED SERVER +PercentComplete : 0 +StartTime : 3/16/2020 12:49:53 PM +State : InProgress +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : +EstimatedCompletionTime : +Description : +IsCancellable : True +``` + +This command stops operation with name 'd0f5bef5-e2b1-4ef8-bb42-2e54073874f9' on a SQL managed instance. + +### Example 2: Using operation resource id +```powershell +$managedInstanceOperation = Get-AzSqlInstanceOperation -ResourceGroupName ps3753 -ManagedInstanceName ps3698 -Name 4253bf58-34f1-4499-80c6-198d94c659f7 +Get-AzSqlInstanceOperation -ResourceId $managedInstanceOperation.Id +``` + +```output +Id : /subscriptions/a8c9a924-06c0-4bde-9788-e7b1370969e1/resourceGroups/ps3753/providers/Microsoft.Sql/managedInstances/ps3698/operations/4253bf58-34f1-4499-80c6-198d94c659f7 +ResourceGroupName : ps3753 +ManagedInstanceName : ps3698 +Name : 4253bf58-34f1-4499-80c6-198d94c659f7 +Operation : UpsertManagedServer +OperationFriendlyName : UPDATE MANAGED SERVER +PercentComplete : 0 +StartTime : 3/16/2020 12:47:32 PM +State : InProgress +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : +EstimatedCompletionTime : +Description : +IsCancellable : True +``` + +This command stops operation with resource id $managedInstanceOperation.Id. + +### Example 3: Using operation object +```powershell +$managedInstanceOperation = Get-AzSqlInstanceOperation -ResourceGroupName ps3753 -ManagedInstanceName ps3698 -Name b15a2b78-c42c-4e00-bf87-7ef4737552dc +Stop-AzSqlInstanceOperation -InputObject $managedInstanceOperation +``` + +```output +Id : /subscriptions/a8c9a924-06c0-4bde-9788-e7b1370969e1/resourceGroups/ps3753/providers/Microsoft.Sql/managedInstances/ps3698/operations/b15a2b78-c42c-4e00-bf87-7ef4737552dc +ResourceGroupName : ps3753 +ManagedInstanceName : ps3698 +Name : b15a2b78-c42c-4e00-bf87-7ef4737552dc +Operation : UpsertManagedServer +OperationFriendlyName : UPDATE MANAGED SERVER +PercentComplete : 0 +StartTime : 3/16/2020 12:44:57 PM +State : InProgress +ErrorCode : +ErrorDescription : +ErrorSeverity : +IsUserError : +EstimatedCompletionTime : +Description : +IsCancellable : True +``` + +This command stops operation with object $managedInstanceOperation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Skip confirmation message for performing the action + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The operation to cancel + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstanceOperation.Model.AzureSqlManagedInstanceOperationModel +Parameter Sets: StopByInputObjectParameterSet +Aliases: SqlInstanceOperation + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagedInstanceName +The name of the instance. + +```yaml +Type: System.String +Parameter Sets: StopByNameAndManagedInstanceAndResourceGroupParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the operation. + +```yaml +Type: System.String +Parameter Sets: StopByNameAndManagedInstanceAndResourceGroupParameterSet +Aliases: OperationName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: StopByNameAndManagedInstanceAndResourceGroupParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource id of operation object to stop + +```yaml +Type: System.String +Parameter Sets: StopByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedInstanceOperation.Model.AzureSqlManagedInstanceOperationModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstanceOperation.Model.AzureSqlManagedInstanceOperationModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Stop-AzSqlSyncGroupSync.md b/azps-10.1.0/Az.Sql/Stop-AzSqlSyncGroupSync.md new file mode 100644 index 0000000000..07dccdda2a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Stop-AzSqlSyncGroupSync.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/stop-azsqlsyncgroupsync +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlSyncGroupSync.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Stop-AzSqlSyncGroupSync.md +--- + +# Stop-AzSqlSyncGroupSync + +## SYNOPSIS +Stops a sync group synchronization. + +## SYNTAX + +``` +Stop-AzSqlSyncGroupSync [-SyncGroupName] <String> [-PassThru] [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSqlSyncGroupSync** cmdlet stops a sync group synchronization. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzSqlSyncGroupSync -SyncGroupName mysg -ServerName mysrv -DatabaseName mydb -ResourceGroupName myrg +``` + +This command stops the synchronization which is ongoing for the sync group mysg. + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Defines Whether return the sync group + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncGroupName +The sync group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel + +## NOTES + +## RELATED LINKS + +[Start-AzSqlSyncGroupSync](./Start-AzSqlSyncGroupSync.md) + diff --git a/azps-10.1.0/Az.Sql/Suspend-AzSqlDatabase.md b/azps-10.1.0/Az.Sql/Suspend-AzSqlDatabase.md new file mode 100644 index 0000000000..f8a3b8dec7 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Suspend-AzSqlDatabase.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 7302D785-9DD0-4CC0-93C9-9A6EA60591CF +online version: https://learn.microsoft.com/powershell/module/az.sql/suspend-azsqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Suspend-AzSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Suspend-AzSqlDatabase.md +--- + +# Suspend-AzSqlDatabase + +## SYNOPSIS +Suspends a SQL Data Warehouse database. + +## SYNTAX + +``` +Suspend-AzSqlDatabase [-ServerName] <String> -DatabaseName <String> [-AsJob] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Suspend-AzSqlDatabase** cmdlet suspends an Azure SQL Data Warehouse database. + +## EXAMPLES + +### Example 1: Suspends an Azure SQL Data Warehouse database +```powershell +Suspend-AzSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +``` + +This command suspends an active Azure SQL Data Warehouse database. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +Specifies the name of the database that this cmdlet suspends. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server which hosts the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + +## NOTES +* The **Suspend-AzSqlDatabase** cmdlet works only on Azure SQL Data Warehouse databases. This operation is not supported on Azure SQL Database Basic, Standard and Premium editions. + +## RELATED LINKS + +[Get-AzSqlDatabase](./Get-AzSqlDatabase.md) + +[New-AzSqlDatabase](./New-AzSqlDatabase.md) + +[Remove-AzSqlDatabase](./Remove-AzSqlDatabase.md) + +[Resume-AzSqlDatabase](./Resume-AzSqlDatabase.md) + +[Set-AzSqlDatabase](./Set-AzSqlDatabase.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) + + diff --git a/azps-10.1.0/Az.Sql/Switch-AzSqlDatabaseFailoverGroup.md b/azps-10.1.0/Az.Sql/Switch-AzSqlDatabaseFailoverGroup.md new file mode 100644 index 0000000000..44f338d786 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Switch-AzSqlDatabaseFailoverGroup.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/switch-azsqldatabasefailovergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Switch-AzSqlDatabaseFailoverGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Switch-AzSqlDatabaseFailoverGroup.md +--- + +# Switch-AzSqlDatabaseFailoverGroup + +## SYNOPSIS +Executes a failover of an Azure SQL Database Failover Group. + +## SYNTAX + +``` +Switch-AzSqlDatabaseFailoverGroup [-ServerName] <String> [[-FailoverGroupName] <String>] [-AllowDataLoss] + [-TryPlannedBeforeForcedFailover] [-AsJob] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command swaps the roles of the servers in a Failover Group and switches all secondary databases to the primary role. All new TDS sessions are automatically re-routed to the secondary server after the DNS client cache is refreshed. When the original primary server is back online, all formerly primary databases in it will switch to the secondary role. +The Failover Group's secondary server must be used to execute this command. +If the AllowDataLoss parameter is not specified, this command waits until both roles are switched. If the AllowDataLoss parameter is specified, the command only waits until the new primary assumes its role. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName secondaryserver -FailoverGroupName fg | Switch-AzSqlDatabaseFailoverGroup -AllowDataLoss +``` + +Issue a failover operation allowing data loss by piping in the Failover Group. + +### Example 2 +```powershell +Switch-AzSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName secondaryserver -FailoverGroupName fg +``` + +Issue a best effort failover operation that will either succeed without losing data or fail and roll back. + +## PARAMETERS + +### -AllowDataLoss +Complete the failover even if doing so may result in data loss. This will allow the failover to proceed even if a primary database is unavailable. + +```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 +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FailoverGroupName +The name of the Azure SQL Database Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the secondary Azure SQL Database Server of the Failover Group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TryPlannedBeforeForcedFailover +Performs planned failover as first step and if it fails for any reason than forced failover with potential data loss is initiated. This will allow the failover to proceed even if a primary database is unavailable. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlDatabaseFailoverGroup](./New-AzSqlDatabaseFailoverGroup.md) + +[Set-AzSqlDatabaseFailoverGroup](./Set-AzSqlDatabaseFailoverGroup.md) + +[Get-AzSqlDatabaseFailoverGroup](./Get-AzSqlDatabaseFailoverGroup.md) + +[Add-AzSqlDatabaseToFailoverGroup](./Add-AzSqlDatabaseToFailoverGroup.md) + +[Remove-AzSqlDatabaseFromFailoverGroup](./Remove-AzSqlDatabaseFromFailoverGroup.md) + +[Remove-AzSqlDatabaseFailoverGroup](./Remove-AzSqlDatabaseFailoverGroup.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Switch-AzSqlDatabaseInstanceFailoverGroup.md b/azps-10.1.0/Az.Sql/Switch-AzSqlDatabaseInstanceFailoverGroup.md new file mode 100644 index 0000000000..a2984e1f05 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Switch-AzSqlDatabaseInstanceFailoverGroup.md @@ -0,0 +1,239 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/Az.sql/switch-Azsqldatabaseinstancefailovergroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Switch-AzSqlDatabaseInstanceFailoverGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Switch-AzSqlDatabaseInstanceFailoverGroup.md +--- + +# Switch-AzSqlDatabaseInstanceFailoverGroup + +## SYNOPSIS +Executes a failover of an Instance Failover Group. + +## SYNTAX + +### SwitchInstanceFailoverGroupDefaultSet (Default) +``` +Switch-AzSqlDatabaseInstanceFailoverGroup [-ResourceGroupName] <String> [-Location] <String> [-Name] <String> + [-AllowDataLoss] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SwitchInstanceFailoverGroupByResourceIdSet +``` +Switch-AzSqlDatabaseInstanceFailoverGroup [-Location] <String> [-ResourceId] <String> [-AllowDataLoss] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SwitchInstanceFailoverGroupByInputObjectSet +``` +Switch-AzSqlDatabaseInstanceFailoverGroup [-InputObject] <AzureSqlInstanceFailoverGroupModel> [-AllowDataLoss] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command swaps the roles of the managed instances in a Instance Failover Group by failing over to the specified secondary region, making it the new primary region. All new TDS sessions connecting to the primary endpoint are automatically re-routed to the new primary region. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSqlDatabaseInstanceFailoverGroup -ResourceGroupName rg -Location location -Name fg | Switch-AzSqlDatabaseInstanceFailoverGroup -AllowDataLoss +``` + +```output +ResourceGroupName : rg +Location : East US +Name : fg +PartnerResourceGroupName : rg +PartnerRegion : West US +PrimaryManagedInstanceName : managedInstance1 +PartnerManagedInstanceName : managedInstance2 +ReplicationRole : Primary +ReplicationState : CATCH_UP +ReadWriteFailoverPolicy : Automatic +FailoverWithDataLossGracePeriodHours : 1 +ReadOnlyFailoverPolicy : Disabled +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rg/providers/Microsoft.Sql/locations/eastus/instanceFailoverGroups/fg +``` + +Issue a failover operation allowing data loss by piping in the Instance Failover Group. + +### Example 2 +```powershell +Get-AzSqlDatabaseInstanceFailoverGroup -ResourceGroupName rg -Location location -Name fg | Switch-AzSqlDatabaseInstanceFailoverGroup +``` + +```output +ResourceGroupName : rg +Location : East US +Name : fg +PartnerResourceGroupName : rg +PartnerRegion : West US +PrimaryManagedInstanceName : managedInstance1 +PartnerManagedInstanceName : managedInstance2 +ReplicationRole : Primary +ReplicationState : CATCH_UP +ReadWriteFailoverPolicy : Automatic +FailoverWithDataLossGracePeriodHours : 1 +ReadOnlyFailoverPolicy : Disabled +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rg/providers/Microsoft.Sql/locations/eastus/instanceFailoverGroups/fg +``` + +Issue a best effort failover operation that will either succeed without losing data or fail and roll back. + +## PARAMETERS + +### -AllowDataLoss +Complete the failover even if doing so may result in data loss. +This will allow the failover to proceed even if a primary database is unavailable. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Instance Failover Group object to switch + +```yaml +Type: Microsoft.Azure.Commands.Sql.InstanceFailoverGroup.Model.AzureSqlInstanceFailoverGroupModel +Parameter Sets: SwitchInstanceFailoverGroupByInputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The name of the Local Region of the secondary instance in the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: SwitchInstanceFailoverGroupDefaultSet, SwitchInstanceFailoverGroupByResourceIdSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: SwitchInstanceFailoverGroupDefaultSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group of the secondary instance in the Instance Failover Group. + +```yaml +Type: System.String +Parameter Sets: SwitchInstanceFailoverGroupDefaultSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Resource ID of the Instance Failover Group to switch. + +```yaml +Type: System.String +Parameter Sets: SwitchInstanceFailoverGroupByResourceIdSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Sql.InstanceFailoverGroup.Model.AzureSqlInstanceFailoverGroupModel +System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.InstanceFailoverGroup.Model.AzureSqlInstanceFailoverGroupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Update-AzSqlDatabaseAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Sql/Update-AzSqlDatabaseAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..1215f41db3 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Update-AzSqlDatabaseAdvancedThreatProtectionSetting.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 457FD595-D5E1-45C4-9DB8-C3C6C30A0E94 +online version: https://learn.microsoft.com/powershell/module/az.sql/Update-AzSqlDatabaseAdvancedThreatProtectionSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlDatabaseAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlDatabaseAdvancedThreatProtectionSetting.md +--- + +# Update-AzSqlDatabaseAdvancedThreatProtectionSetting + +## SYNOPSIS +Sets the Advanced Threat Protection settings on a database. + +## SYNTAX + +``` +Update-AzSqlDatabaseAdvancedThreatProtectionSetting -Enable <Boolean> [-PassThru] [-ServerName] <String> + [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSqlDatabaseAdvancedThreatProtectionSetting** cmdlet sets the Advanced Threat Protection settings on an Azure SQL database. +To use this cmdlet, specify the *ResourceGroupName*, *ServerName* and *DatabaseName* parameters to identify the database. + +## EXAMPLES + +### Example 1: Set the advanced threat protection settings for a database +```powershell +Update-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" +``` + +This command sets the advanced threat protection settings for a database named Database01 on the server named Server01. + +## PARAMETERS + +### -DatabaseName +Specifies the name of the database where the settings is set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Defines whether to enable or disable Advanced Threat Protection + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server is assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DetectionType[] + +### System.Nullable`1[[System.UInt32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionsettingsModel + +## NOTES + +## RELATED LINKS + +[Azure SQL Database cmdlets](/powershell/module/az.sql/) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Update-AzSqlDatabaseLongTermRetentionBackup.md b/azps-10.1.0/Az.Sql/Update-AzSqlDatabaseLongTermRetentionBackup.md new file mode 100644 index 0000000000..e08d3611b0 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Update-AzSqlDatabaseLongTermRetentionBackup.md @@ -0,0 +1,296 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/update-azsqldatabaselongtermretentionbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlDatabaseLongTermRetentionBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlDatabaseLongTermRetentionBackup.md +--- + +# Update-AzSqlDatabaseLongTermRetentionBackup + +## SYNOPSIS +Updates a long term retention backup. + +## SYNTAX + +### UpdateBackupDefault (Default) +``` +Update-AzSqlDatabaseLongTermRetentionBackup [-Location] <String> [-ServerName] <String> + [-DatabaseName] <String> [-BackupName] <String> [-ResourceGroupName <String>] + [-BackupStorageRedundancy <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateBackupByResourceId +``` +Update-AzSqlDatabaseLongTermRetentionBackup [-ResourceId] <String> [-BackupStorageRedundancy <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectSet +``` +Update-AzSqlDatabaseLongTermRetentionBackup [-BackupStorageRedundancy <String>] + [-InputObject] <AzureSqlDatabaseLongTermRetentionBackupModel> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the properties of a long term retention backup. + + +## EXAMPLES + +### Example 1: Update Backup Storage Redundancy of a long term retention backup. +```powershell +Update-AzSqlDatabaseLongTermRetentionBackup -Location southeastasia -ServerName ayang-stage-seas -DatabaseName ltr3 -BackupName 'e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000' -ResourceGroupName testrg -BackupStorageRedundancy Geo +``` + +```output +BackupExpirationTime : 3/19/2021 1:33:52 AM +BackupName : e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000 +BackupTime : 2/17/2021 1:33:52 AM +DatabaseName : ltr3 +DatabaseDeletionTime : 3/16/2021 6:28:11 AM +Location : southeastasia +ResourceId : /subscriptions/01c4ec88-e179-44f7-9eb0-e9719a5087ab/resourceGroups/testrg/providers/Microsoft.Sql/locations/southeastasia/longTermRetentionServers/ayang-stage-seas/longTermRetentionDatabases/ltr3/longTermRetentionBackups/e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000 +ServerName : ayang-stage-seas +ServerCreateTime : 4/22/2020 9:58:33 PM +ResourceGroupName : testrg +BackupStorageRedundancy : Geo +``` + +This command sets the Backup Storage Redundancy of the specified backup using location and Resource Group, Server, Database, and Backup names. + +### Example 2: Update Backup Storage Redundancy of a long term retention backup (using Resource Id). +```powershell +Update-AzSqlDatabaseLongTermRetentionBackup -ResourceId '/subscriptions/01c4ec88-e179-44f7-9eb0-e9719a5087ab/resourceGroups/testrg/providers/Microsoft.Sql/locations/southeastasia/longTermRetentionServers/ayang-stage-seas/longTermRetentionDatabases/ltr3/longTermRetentionBackups/e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000' -BackupStorageRedundancy Geo +``` + +```output +BackupExpirationTime : 3/19/2021 1:33:52 AM +BackupName : e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000 +BackupTime : 2/17/2021 1:33:52 AM +DatabaseName : ltr3 +DatabaseDeletionTime : 3/16/2021 6:28:11 AM +Location : southeastasia +ResourceId : /subscriptions/01c4ec88-e179-44f7-9eb0-e9719a5087ab/resourceGroups/testrg/providers/Microsoft.Sql/locations/southeastasia/longTermRetentionServers/ayang-stage-seas/longTermRetentionDatabases/ltr3/longTermRetentionBackups/e5c20f43-494c-4925-89d1-58e0f4569fb3;132579992320000000 +ServerName : ayang-stage-seas +ServerCreateTime : 4/22/2020 9:58:33 PM +ResourceGroupName : testrg +BackupStorageRedundancy : Geo +``` + +This command sets the Backup Storage Redundancy of the specified backup using a backup Resource Id. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupName +The name of the backup. + +```yaml +Type: System.String +Parameter Sets: UpdateBackupDefault +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BackupStorageRedundancy +The Backup storage redundancy used to store backups for the SQL Database. +Options are: Local, Zone and Geo. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Local, Zone, Geo + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the Azure SQL Database the backup is from. + +```yaml +Type: System.String +Parameter Sets: UpdateBackupDefault +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Database Long Term Retention Backup object to update. + +```yaml +Type: Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseLongTermRetentionBackupModel +Parameter Sets: UpdateByInputObjectSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the backup's source server. + +```yaml +Type: System.String +Parameter Sets: UpdateBackupDefault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateBackupDefault +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The Resource ID of the Database Long Term Retention Backup to remove. + +```yaml +Type: System.String +Parameter Sets: UpdateBackupByResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server the backup is under. + +```yaml +Type: System.String +Parameter Sets: UpdateBackupDefault +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseLongTermRetentionBackupModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlDatabaseLongTermRetentionBackup](./Get-AzSqlDatabaseLongTermRetentionBackup.md) + +[Copy-AzSqlDatabaseLongTermRetentionBackup](./Copy-AzSqlDatabaseLongTermRetentionBackup.md) + +[Remove-AzSqlDatabaseLongTermRetentionBackup](./Remove-AzSqlDatabaseLongTermRetentionBackup.md) + +[Get-AzSqlDatabaseBackupLongTermRetentionPolicy](./Get-AzSqlDatabaseBackupLongTermRetentionPolicy.md) + +[Set-AzSqlDatabaseBackupLongTermRetentionPolicy](./Set-AzSqlDatabaseBackupLongTermRetentionPolicy.md) + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) \ No newline at end of file diff --git a/azps-10.1.0/Az.Sql/Update-AzSqlDatabaseVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Sql/Update-AzSqlDatabaseVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..d0168d599a --- /dev/null +++ b/azps-10.1.0/Az.Sql/Update-AzSqlDatabaseVulnerabilityAssessmentSetting.md @@ -0,0 +1,386 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/Update-AzSqlDatabaseVulnerabilityAssessmentSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlDatabaseVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlDatabaseVulnerabilityAssessmentSetting.md +--- + +# Update-AzSqlDatabaseVulnerabilityAssessmentSetting + +## SYNOPSIS +Updates the vulnerability assessment settings of a database. + +## SYNTAX + +### UpdateSettingsWithStorageAccountNameParameterSet (Default) +``` +Update-AzSqlDatabaseVulnerabilityAssessmentSetting [-ServerName] <String> [-DatabaseName] <String> + [-StorageAccountName <String>] [-ScanResultsContainerName <String>] + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmins <Boolean>] [-NotificationEmail <String[]>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzSqlDatabaseVulnerabilityAssessmentSetting [-ServerName] <String> [-DatabaseName] <String> + -InputObject <VulnerabilityAssessmentSettingsModel> [-RecurringScansInterval <RecurringScansInterval>] + [-EmailAdmins <Boolean>] [-NotificationEmail <String[]>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateSettingsWithBlobStorageSasUri +``` +Update-AzSqlDatabaseVulnerabilityAssessmentSetting [-ServerName] <String> [-DatabaseName] <String> + -BlobStorageSasUri <Uri> [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmins <Boolean>] + [-NotificationEmail <String[]>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSqlDatabaseVulnerabilityAssessmentSetting** cmdlet updates the vulnerability assessment settings of an Azure SQL Database. +Note that you need to run *Enable-AzSqlServerAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1: Update Vulnerability Assessment settings with storage account name +```powershell +Update-AzSqlDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01"` + -ServerName "Server01"` + -DatabaseName "Database01" ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +### Example 2: Update Vulnerability Assessment settings with blob storage SAS URI +```powershell +Update-AzSqlDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01"` + -ServerName "Server01"` + -DatabaseName "Database01" ` + -BlobStorageSasUri "https://mystorage.blob.core.windows.net/vulnerability-assessment?st=XXXXXX" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +### Example 3: Update the Vulnerability Assessment settings from DatabaseVulnerabilityAssessmentSettingsModel instance definition +```powershell +Update-AzSqlDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01"` + -ServerName "Server01"` + -DatabaseName "Database01" ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") + +Get-AzSqlDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" ` + | Update-AzSqlDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup02" ` + -ServerName "Server02" ` + -DatabaseName "Database02" +``` + +```output +ResourceGroupName : ResourceGroup02 +ServerName : Server02 +DatabaseName : Database02 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +This command updated the Vulnerability Assessment settings on Database02 from the settings on Database01 + +### Example 4: Update the Vulnerability Assessment settings on all the databases under a server +```powershell +Get-AzSqlDatabase -ResourceGroupName "ResourceGroup01" ` + -ServerName $"Server01" ` + | Where-Object {$_.DatabaseName -ne "master"} ` + | Update-AzSqlDatabaseVulnerabilityAssessmentSetting ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} + +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database02 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +This command updates all Vulnerability Assessment settings on all the databases under Server01 + +## PARAMETERS + +### -BlobStorageSasUri +A SAS URI to a storage container that will hold the scan results. + +```yaml +Type: System.Uri +Parameter Sets: UpdateSettingsWithBlobStorageSasUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAdmins +A value indicating whether to email service and co-administrators on recurring scan completion. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The Vulnerability Assessment settings object to set + +```yaml +Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentSettingsModel +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NotificationEmail +A list of mail addresses to send on recurring scan completion. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecurringScansInterval +The recurring scans interval. + +```yaml +Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.RecurringScansInterval +Parameter Sets: (All) +Aliases: +Accepted values: None, Weekly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScanResultsContainerName +The name of the storage container that will hold the scan results. + +```yaml +Type: System.String +Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account that will hold the scan results. + +```yaml +Type: System.String +Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentSettingsModel + +### System.Uri + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.RecurringScansInterval + +### System.Boolean + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Update-AzSqlInstanceAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Sql/Update-AzSqlInstanceAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..b906cccecf --- /dev/null +++ b/azps-10.1.0/Az.Sql/Update-AzSqlInstanceAdvancedThreatProtectionSetting.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/Update-AzSqlInstanceAdvancedThreatProtectionSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlInstanceAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlInstanceAdvancedThreatProtectionSetting.md +--- + +# Update-AzSqlInstanceAdvancedThreatProtectionSetting + +## SYNOPSIS +Sets the Advanced Threat Protection settings on a managed instance. + +## SYNTAX + +``` +Update-AzSqlInstanceAdvancedThreatProtectionSetting -Enable <Boolean> [-PassThru] -InstanceName <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSqlInstanceAdvancedThreatProtectionSetting** cmdlet sets the Advanced Threat Protection settings on an Azure SQL managed instance. +To use this cmdlet, specify the *ResourceGroupName* and *InstanceName* parameters to identify the managed instance. + +## EXAMPLES + +### Example 1: Set the Advanced Threat Protection settings for a managed instance +```powershell +Update-AzSqlInstanceAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -InstanceName "Instance01" +``` + +This command sets the Advanced Threat Protection settings for a managed instance named Instance01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Defines whether to enable or disable Advanced Threat Protection + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.AdvancedThreatProtection.Model.ManagedInstanceAdvancedThreatProtectionSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Sql/Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..c25ec111ab --- /dev/null +++ b/azps-10.1.0/Az.Sql/Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting.md +--- + +# Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting + +## SYNOPSIS +Sets the Advanced Threat Protection settings on a managed database. + +## SYNTAX + +``` +Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting -Enable <Boolean> [-PassThru] + -InstanceName <String> [-DatabaseName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting** cmdlet sets the Advanced Threat Protection settings on an Azure SQL managed database. +To use this cmdlet, specify the *ResourceGroupName*, *InstanceName* and *DatabaseName* parameters to identify the managed database. + + +## EXAMPLES + +### Example 1: Set the Advanced Threat Protection settings for a managed database +```powershell +Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -InstanceName "Instance01" -DatabaseName "Database01" +``` + +This command sets the Advanced Threat Protection settings for a managed database named Database01. + +## PARAMETERS + +### -DatabaseName +SQL Managed Database name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Defines whether to enable or disable Advanced Threat Protection + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.AdvancedThreatProtection.Model.ManagedDatabaseAdvancedThreatProtectionSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Sql/Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..0d727bfaf0 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md @@ -0,0 +1,387 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/update-azsqlinstancedatabasevulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting.md +--- + +# Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting + +## SYNOPSIS +Updates the vulnerability assessment settings of a managed database. + +## SYNTAX + +### UpdateSettingsWithStorageAccountNameParameterSet (Default) +``` +Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting [-InstanceName] <String> [-DatabaseName] <String> + [-StorageAccountName <String>] [-ScanResultsContainerName <String>] + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmins <Boolean>] [-NotificationEmail <String[]>] + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting [-InstanceName] <String> [-DatabaseName] <String> + -InputObject <VulnerabilityAssessmentSettingsModel> [-RecurringScansInterval <RecurringScansInterval>] + [-EmailAdmins <Boolean>] [-NotificationEmail <String[]>] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateSettingsWithBlobStorageSasUri +``` +Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting [-InstanceName] <String> [-DatabaseName] <String> + -BlobStorageSasUri <Uri> [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmins <Boolean>] + [-NotificationEmail <String[]>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting** cmdlet updates the vulnerability assessment settings of an Azure SQL Managed Database. +Note that you need to run *Enable-AzSqlInstanceAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1: Update Vulnerability Assessment settings with storage account name +```powershell +Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +### Example 2: Update Vulnerability Assessment settings with blob storage SAS URI +```powershell +Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -BlobStorageSasUri "https://mystorage.blob.core.windows.net/vulnerability-assessment?st=XXXXXX" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +### Example 3: Update the Vulnerability Assessment settings from ManagedDatabaseVulnerabilityAssessmentSettingsModel instance definition +```powershell +Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") + +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" + | Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup02" ` + -InstanceName "ManagedInstance02" ` + -DatabaseName "Database02" +``` + +```output +ResourceGroupName : ResourceGroup02 +InstanceName : ManagedInstance02 +DatabaseName : Database02 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +This command updated the Vulnerability Assessment settings on Database02 from the settings on Database01 + +### Example 4: Update the Vulnerability Assessment settings on all the databases under a managed instance +```powershell +Get-AzSqlInstanceDatabase -ResourceGroupName "ResourceGroup01" ` + -InstanceName $"ManagedInstance01" ` + | Where-Object {$_.Name -ne "master"} ` + | Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} + +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +DatabaseName : Database02 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +This command updates all Vulnerability Assessment settings on all the databases under ManagedInstance01 + +## PARAMETERS + +### -BlobStorageSasUri +A SAS URI to a storage container that will hold the scan results. + +```yaml +Type: System.Uri +Parameter Sets: UpdateSettingsWithBlobStorageSasUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseName +SQL Managed Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAdmins +A value indicating whether to email service and co-administrators on recurring scan completion. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The Vulnerability Assessment settings object to set + +```yaml +Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentSettingsModel +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NotificationEmail +A list of mail addresses to send on recurring scan completion. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecurringScansInterval +The recurring scans interval. + +```yaml +Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.RecurringScansInterval +Parameter Sets: (All) +Aliases: +Accepted values: None, Weekly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScanResultsContainerName +The name of the storage container that will hold the scan results. + +```yaml +Type: System.String +Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account that will hold the scan results. + +```yaml +Type: System.String +Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentSettingsModel + +### System.Uri + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.RecurringScansInterval + +### System.Boolean + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ManagedDatabaseVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Update-AzSqlInstanceLink.md b/azps-10.1.0/Az.Sql/Update-AzSqlInstanceLink.md new file mode 100644 index 0000000000..a8486af5aa --- /dev/null +++ b/azps-10.1.0/Az.Sql/Update-AzSqlInstanceLink.md @@ -0,0 +1,391 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/update-azsqlinstancelink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlInstanceLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlInstanceLink.md +--- + +# Update-AzSqlInstanceLink + +## SYNOPSIS +Updates the properties of an instance link. + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Update-AzSqlInstanceLink [-ResourceGroupName] <String> [-InstanceName] <String> [-Name] <String> + [-ReplicationMode] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByParentObjectParameterSet +``` +Update-AzSqlInstanceLink [-Name] <String> [-ReplicationMode] <String> + [-InstanceObject] <AzureSqlManagedInstanceModel> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzSqlInstanceLink [[-ReplicationMode] <String>] [-InputObject] <AzureSqlManagedInstanceLinkModel> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByResourceIdParameterSet +``` +Update-AzSqlInstanceLink [-ReplicationMode] <String> [-ResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +**Update-AzSqlInstanceLink** cmdlet modifies properties of an instance link. + +## EXAMPLES + +### Example 1: Set replication mode of an instance link to Sync +```powershell +Update-AzSqlInstanceLink -ResourceGroupName "ResourceGroup1" -InstanceName "ManagedInstance01" -Name "Link01" -ReplicationMode "Sync" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Sync +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command sets the replication mode of an instance link to "Sync". + +### Example 2: Set replication mode of an instance link to Async +```powershell +Update-AzSqlInstanceLink -ResourceGroupName "ResourceGroup1" -InstanceName "ManagedInstance01" -Name "Link01" -ReplicationMode "Async" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command sets the replication mode of an instance link to "Aync". + +### Example 3: Set replication mode of an instance link by its resource identifier +```powershell +Update-AzSqlInstanceLink -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01" -ReplicationMode "Async" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command sets the replication mode of an instance link to "Sync" by its resource identifier. + +### Example 4: Set replication mode of instance link by its PowerShell object +```powershell +$managedInstanceLink = Get-AzSqlInstanceLink -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "Link01" +Update-AzSqlInstanceLink -InputObject $managedInstanceLink -ReplicationMode "Async" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command sets the replication mode of an instance link to "Async" using the input object. + +### Example 5: Set replication mode of instance link by mutating its object +```powershell +$managedInstanceLink = Get-AzSqlInstanceLink -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "Link01" +$managedInstanceLink.ReplicationMode = "Async" +Update-AzSqlInstanceLink -InputObject $managedInstanceLink +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command sets the instance link using input object. + +### Example 6: Set replication mode of an instance link by its parent instance object +```powershell +$instance = Get-AzSqlInstance -ResourceGroupName "ResourceGroup01" -Name "ManagedInstance01" +Update-AzSqlInstanceLink -InstanceObject $instance -Name "Link01" -ReplicationMode "Async" +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +Type : Microsoft.Sql/managedInstances/distributedAvailabilityGroups +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/distributedAvailabilityGroups/Link01 +Name : Link01 +TargetDatabase : Database01 +SourceEndpoint : TCP://SERVER01:5022 +PrimaryAvailabilityGroupName : +SecondaryAvailabilityGroupName : +ReplicationMode : Async +DistributedAvailabilityGroupId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SourceReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +TargetReplicaId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +LinkState : Copying +LastHardenedLsn : +``` + +This command sets the replication mode of a instance link to "Async" using parent instance object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Instance link input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstanceHybridLink.Model.AzureSqlManagedInstanceLinkModel +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +Name of Azure SQL Managed Instance. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceObject +Instance input object. + +```yaml +Type: Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel +Parameter Sets: UpdateByParentObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the instance link. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, UpdateByParentObjectParameterSet +Aliases: LinkName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationMode +Replication mode value. +Possible values include 'Sync' and 'Async'. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, UpdateByParentObjectParameterSet, UpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The instance link resource ID. + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel + +### Microsoft.Azure.Commands.Sql.ManagedInstanceHybridLink.Model.AzureSqlManagedInstanceLinkModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ManagedInstanceHybridLink.Model.AzureSqlManagedInstanceLinkModel + +## NOTES + +## RELATED LINKS + +[Get-AzSqlInstanceLink](./Get-AzSqlInstanceLink.md) + +[New-AzSqlInstanceLink](./New-AzSqlInstanceLink.md) + +[Remove-AzSqlInstanceLink](./Remove-AzSqlInstanceLink.md) diff --git a/azps-10.1.0/Az.Sql/Update-AzSqlInstanceVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Sql/Update-AzSqlInstanceVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..86be6e2f45 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Update-AzSqlInstanceVulnerabilityAssessmentSetting.md @@ -0,0 +1,327 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/update-azsqlinstancevulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlInstanceVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlInstanceVulnerabilityAssessmentSetting.md +--- + +# Update-AzSqlInstanceVulnerabilityAssessmentSetting + +## SYNOPSIS +Updates the vulnerability assessment settings of a managed instance. + +## SYNTAX + +### UpdateSettingsWithStorageAccountNameParameterSet (Default) +``` +Update-AzSqlInstanceVulnerabilityAssessmentSetting [-ResourceGroupName] <String> [-InstanceName] <String> + [-StorageAccountName <String>] [-ScanResultsContainerName <String>] + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmins <Boolean>] [-NotificationEmail <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateSettingsWithBlobStorageSasUri +``` +Update-AzSqlInstanceVulnerabilityAssessmentSetting [-ResourceGroupName] <String> [-InstanceName] <String> + -BlobStorageSasUri <Uri> [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmins <Boolean>] + [-NotificationEmail <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzSqlInstanceVulnerabilityAssessmentSetting -InputObject <VulnerabilityAssessmentSettingsModel> + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmins <Boolean>] [-NotificationEmail <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSqlInstanceVulnerabilityAssessmentSetting** cmdlet updates the vulnerability assessment settings of an Azure SQL Managed Instance. +Note that you need to run *Enable-AzSqlInstanceAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1: Update Vulnerability Assessment settings with storage account name +```powershell +Update-AzSqlInstanceVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +### Example 2: Update Vulnerability Assessment settings with blob storage SAS URI +```powershell +Update-AzSqlInstanceVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -BlobStorageSasUri "https://mystorage.blob.core.windows.net/vulnerability-assessment?st=XXXXXX" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +```output +ResourceGroupName : ResourceGroup01 +InstanceName : ManagedInstance01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +### Example 3: Update the Vulnerability Assessment settings from ManagedInstanceVulnerabilityAssessmentSettingsModel instance definition +```powershell +Update-AzSqlInstanceVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") + +Get-AzSqlInstanceVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + | Update-AzSqlInstanceVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup02" ` + -InstanceName "ManagedInstance02" +``` + +```output +ResourceGroupName : ResourceGroup02 +InstanceName : ManagedInstance02 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +This command updated the Vulnerability Assessment settings on ManagedInstance02 from the settings on ManagedInstance01 + +## PARAMETERS + +### -BlobStorageSasUri +A SAS URI to a storage container that will hold the scan results. + +```yaml +Type: System.Uri +Parameter Sets: UpdateSettingsWithBlobStorageSasUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAdmins +A value indicating whether to email service and co-administrators on recurring scan completion. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The Vulnerability Assessment settings object to set + +```yaml +Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentSettingsModel +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InstanceName +SQL Managed Instance name. + +```yaml +Type: System.String +Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet, UpdateSettingsWithBlobStorageSasUri +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEmail +A list of mail addresses to send on recurring scan completion. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecurringScansInterval +The recurring scans interval. + +```yaml +Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.RecurringScansInterval +Parameter Sets: (All) +Aliases: +Accepted values: None, Weekly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet, UpdateSettingsWithBlobStorageSasUri +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanResultsContainerName +The name of the storage container that will hold the scan results. + +```yaml +Type: System.String +Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account that will hold the scan results. + +```yaml +Type: System.String +Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentSettingsModel + +### System.Uri + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.RecurringScansInterval + +### System.Boolean + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.ManagedInstanceVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Update-AzSqlServerAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Sql/Update-AzSqlServerAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..c1dd2526bc --- /dev/null +++ b/azps-10.1.0/Az.Sql/Update-AzSqlServerAdvancedThreatProtectionSetting.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +ms.assetid: 2B82F5BA-ABC6-4B37-B641-353CFE814290 +online version: https://learn.microsoft.com/powershell/module/az.sql/Update-AzSqlServerAdvancedThreatProtectionSetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlServerAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlServerAdvancedThreatProtectionSetting.md +--- + +# Update-AzSqlServerAdvancedThreatProtectionSetting + +## SYNOPSIS +Sets the Advanced Threat Protection settings on a server. + +## SYNTAX + +``` +Update-AzSqlServerAdvancedThreatProtectionSetting -Enable <Boolean> [-PassThru] -ServerName <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSqlServerAdvancedThreatProtectionSetting** cmdlet sets the Advanced Threat Protection settings on an Azure SQL server. +To use this cmdlet, specify the *ResourceGroupName* and *ServerName* parameters to identify the server. + +## EXAMPLES + +### Example 1: Set the Advanced Threat Protection settings for a server +```powershell +Update-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" +``` + +This command sets the Advanced Threat Protection settings for a server named Server01. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Defines whether to enable or disable Advanced Threat Protection + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group to which the server belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +Specifies the name of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DetectionType[] + +### System.Nullable`1[[System.UInt32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.ServerThreatDetectionsettingsModel + +## NOTES + +## RELATED LINKS + +[SQL Database Documentation](https://learn.microsoft.com/azure/sql-database/) diff --git a/azps-10.1.0/Az.Sql/Update-AzSqlServerVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Sql/Update-AzSqlServerVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..b46ed2f517 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Update-AzSqlServerVulnerabilityAssessmentSetting.md @@ -0,0 +1,327 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/update-azsqlservervulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlServerVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlServerVulnerabilityAssessmentSetting.md +--- + +# Update-AzSqlServerVulnerabilityAssessmentSetting + +## SYNOPSIS +Updates the vulnerability assessment settings of a server. + +## SYNTAX + +### UpdateSettingsWithStorageAccountNameParameterSet (Default) +``` +Update-AzSqlServerVulnerabilityAssessmentSetting [-ResourceGroupName] <String> [-ServerName] <String> + [-StorageAccountName <String>] [-ScanResultsContainerName <String>] + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmins <Boolean>] [-NotificationEmail <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateSettingsWithBlobStorageSasUri +``` +Update-AzSqlServerVulnerabilityAssessmentSetting [-ResourceGroupName] <String> [-ServerName] <String> + -BlobStorageSasUri <Uri> [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmins <Boolean>] + [-NotificationEmail <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzSqlServerVulnerabilityAssessmentSetting -InputObject <VulnerabilityAssessmentSettingsModel> + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmins <Boolean>] [-NotificationEmail <String[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSqlServerVulnerabilityAssessmentSetting** cmdlet updates the vulnerability assessment settings of an Azure SQL Server. +Note that you need to run *Enable-AzSqlServerAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1: Update Vulnerability Assessment settings with storage account name +```powershell +Update-AzSqlServerVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01"` + -ServerName "Server01"` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +### Example 2: Update Vulnerability Assessment settings with blob storage SAS URI +```powershell +Update-AzSqlServerVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01"` + -ServerName "Server01"` + -BlobStorageSasUri "https://mystorage.blob.core.windows.net/vulnerability-assessment?st=XXXXXX" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +```output +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +### Example 3: Update the Vulnerability Assessment settings from ServerVulnerabilityAssessmentSettingsModel instance definition +```powershell +Update-AzSqlServerVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01"` + -ServerName "Server01"` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") + +Get-AzSqlServerVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + | Update-AzSqlServerVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup02" ` + -ServerName "Server02" +``` + +```output +ResourceGroupName : ResourceGroup02 +ServerName : Server02 +StorageAccountName : mystorage +ScanResultsContainerName : vulnerability-assessment +RecurringScansInterval : Weekly +EmailAdmins : True +NotificationEmail : {mail1@mail.com , mail2@mail.com} +``` + +This command updated the Vulnerability Assessment settings on Server02 from the settings on Server01 + +## PARAMETERS + +### -BlobStorageSasUri +A SAS URI to a storage container that will hold the scan results. + +```yaml +Type: System.Uri +Parameter Sets: UpdateSettingsWithBlobStorageSasUri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAdmins +A value indicating whether to email service and co-administrators on recurring scan completion. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The Vulnerability Assessment settings object to set + +```yaml +Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentSettingsModel +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NotificationEmail +A list of mail addresses to send on recurring scan completion. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecurringScansInterval +The recurring scans interval. + +```yaml +Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.RecurringScansInterval +Parameter Sets: (All) +Aliases: +Accepted values: None, Weekly + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet, UpdateSettingsWithBlobStorageSasUri +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanResultsContainerName +The name of the storage container that will hold the scan results. + +```yaml +Type: System.String +Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +SQL Database server name. + +```yaml +Type: System.String +Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet, UpdateSettingsWithBlobStorageSasUri +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account that will hold the scan results. + +```yaml +Type: System.String +Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.VulnerabilityAssessmentSettingsModel + +### System.Uri + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.RecurringScansInterval + +### System.Boolean + +### System.String[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Sql/Update-AzSqlSyncGroup.md b/azps-10.1.0/Az.Sql/Update-AzSqlSyncGroup.md new file mode 100644 index 0000000000..a9e0418067 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Update-AzSqlSyncGroup.md @@ -0,0 +1,247 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/update-azsqlsyncgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlSyncGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlSyncGroup.md +--- + +# Update-AzSqlSyncGroup + +## SYNOPSIS +Updates an Azure SQL Database Sync Group. + +## SYNTAX + +``` +Update-AzSqlSyncGroup [-Name] <String> [-IntervalInSeconds <Int32>] [-DatabaseCredential <PSCredential>] + [-SchemaFile <String>] [-UsePrivateLinkConnection <Boolean>] [-ServerName] <String> [-DatabaseName] <String> + [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSqlSyncGroup** cmdlet modifies properties of an Azure SQL Database Sync Group. + +## EXAMPLES + +### Example 1: Update a sync group for an Azure SQL Database. +```powershell +$credential = Get-Credential +Update-AzSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -Name "SyncGroup01" ` +-DatabaseCredential $credential -IntervalInSeconds 100 -Schema ".\schema.json" | Format-List +``` + +```output +ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup01 +SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} +IntervalInSeconds : 100 +ConflictResolutionPolicy: : HubWin +HubDatabaseUserName : myAccount +HubDatabasePassword : +SyncState : NotReady +LastSyncTime : 1/1/0001 12:00:00 AM +Schema : +``` + +This command updates a sync group for an Azure SQL Database. "schema.json" is a file in the local disk. It contains the schema payload in json format. An example of the schema json is: +{"Tables": [{"Columns": [{"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column1"}, {"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column2"}], "QuotedName": "MayQuotedTable1"}, +{"Columns": [{"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column1"}, {"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column2"}], "QuotedName": "MayQuotedTable2"}], +"MasterSyncMemberName": null +} + +## PARAMETERS + +### -DatabaseCredential +The SQL authentication credential of the hub database. + +```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 +``` + +### -DatabaseName +SQL Database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntervalInSeconds +The frequency (in seconds) of doing data synchronization. +Default is -1, which means the auto synchronization is not enabled. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The sync group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SyncGroupName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaFile +The path of the schema file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UsePrivateLinkConnection +Whether to use a private link connection when connecting to the hub of this sync group. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlSyncGroup](./New-AzSqlSyncGroup.md) + +[Remove-AzSqlSyncGroup](./Remove-AzSqlSyncGroup.md) + +[Get-AzSqlSyncGroup](./Get-AzSqlSyncGroup.md) + diff --git a/azps-10.1.0/Az.Sql/Update-AzSqlSyncMember.md b/azps-10.1.0/Az.Sql/Update-AzSqlSyncMember.md new file mode 100644 index 0000000000..34f255cca3 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Update-AzSqlSyncMember.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/update-azsqlsyncmember +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlSyncMember.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlSyncMember.md +--- + +# Update-AzSqlSyncMember + +## SYNOPSIS +Updates an Azure SQL Database Sync Member. + +## SYNTAX + +``` +Update-AzSqlSyncMember -Name <String> [-MemberDatabaseCredential <PSCredential>] + [-UsePrivateLinkConnection <Boolean>] [-SyncMemberAzureDatabaseResourceId <String>] [-SyncGroupName] <String> + [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSqlSyncGroup** cmdlet modifies properties of an Azure SQL Database Sync Member. + +## EXAMPLES + +### Example 1 +```powershell +$credential = Get-Credential +Update-AzSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -Name "SyncMember01" ` +-MemberDatabaseCredential $credential | Format-List +``` + +```output +ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01} +ResourceGroupName : ResourceGroup01 +ServerName : Server01 +DatabaseName : Database01 +SyncGroupName : SyncGroup01 +SyncMemberName : SyncMember01 +SyncDirection : OneWayMemberToHub +MemberDatabaseType: : AzureSqlDatabase +SyncAgentId : +SqlServerDatabaseId : +MemberServerName : memberServer01.full.dns.name +MemberDatabaseName : memberDatabase01 +MemberDatabaseUserName : myAccount-new +MemberDatabasePassword : +SyncState : Good +``` + +This command resets the administrator password for the member database. + +### Example 2 + +Updates an Azure SQL Database Sync Member. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Update-AzSqlSyncMember -DatabaseName 'Database01' -MemberDatabaseCredential <PSCredential> -Name 'SyncMember01' -ResourceGroupName 'ResourceGroup01' -ServerName 'Server01' -SyncGroupName 'SyncGroup01' -SyncMemberAzureDatabaseResourceId <String> +``` + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberDatabaseCredential +The credential (username and password) of the Azure SQL Database. + +```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 +``` + +### -Name +The sync member name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SyncMemberName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncGroupName +The sync group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncMemberAzureDatabaseResourceId +The resource ID for the sync member database, used if UsePrivateLinkConnection is set to true. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePrivateLinkConnection +Whether to use private link when connecting to this sync member. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncMemberModel + +## NOTES + +## RELATED LINKS + +[New-AzSqlSyncMember](./New-AzSqlSyncMember.md) + +[Get-AzSqlSyncMember](./Get-AzSqlSyncMember.md) + +[Remove-AzSqlSyncMember](./Remove-AzSqlSyncMember.md) + diff --git a/azps-10.1.0/Az.Sql/Update-AzSqlSyncSchema.md b/azps-10.1.0/Az.Sql/Update-AzSqlSyncSchema.md new file mode 100644 index 0000000000..2609bd0e58 --- /dev/null +++ b/azps-10.1.0/Az.Sql/Update-AzSqlSyncSchema.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml +Module Name: Az.Sql +online version: https://learn.microsoft.com/powershell/module/az.sql/update-azsqlsyncschema +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlSyncSchema.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Update-AzSqlSyncSchema.md +--- + +# Update-AzSqlSyncSchema + +## SYNOPSIS +Update the sync schema for a sync member database or a sync hub database. +It will get the latest database schema from the real database and then use it refresh the schema cached by Sync metadata database. +If "SyncMemberName" is specified, it will refresh the member database schema; if not, it will refresh the hub database schema. + +## SYNTAX + +``` +Update-AzSqlSyncSchema [-SyncGroupName] <String> [-SyncMemberName <String>] [-PassThru] [-ServerName] <String> + [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSqlSyncSchema** cmdlet updates the sync schema for a sync member database or a sync hub database. + +## EXAMPLES + +### Example 1: Update the sync schema for a hub database +```powershell +Update-AzSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" +``` + +This command updates the sync schema for the hub database in the sync group syncGroup01 + +### Example 2: Update the sync schema for a member database +```powershell +Update-AzSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" -SyncMemberName "syncMember01" +``` + +This command updates the sync schema for the member database in the sync member syncMember01 + +## PARAMETERS + +### -DatabaseName +The name of the Azure SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Defines Whether return the sync group this cmdlet works on + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerName +The name of the Azure SQL Server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncGroupName +The sync group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncMemberName +The sync member name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.SqlVirtualMachine/Az.SqlVirtualMachine.md b/azps-10.1.0/Az.SqlVirtualMachine/Az.SqlVirtualMachine.md new file mode 100644 index 0000000000..1e01b5914e --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/Az.SqlVirtualMachine.md @@ -0,0 +1,63 @@ +--- +Module Name: Az.SqlVirtualMachine +Module Guid: b0fb9454-c75f-4eb7-ab6a-aaae12f8bde3 +Download Help Link: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Az.SqlVirtualMachine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Az.SqlVirtualMachine.md +--- + +# Az.SqlVirtualMachine Module +## Description +Microsoft Azure PowerShell: SqlVirtualMachine cmdlets + +## Az.SqlVirtualMachine Cmdlets +### [Get-AzAvailabilityGroupListener](Get-AzAvailabilityGroupListener.md) +Gets an availability group listener. + +### [Get-AzSqlVM](Get-AzSqlVM.md) +Gets a SQL virtual machine. + +### [Get-AzSqlVMGroup](Get-AzSqlVMGroup.md) +Gets a SQL virtual machine group. + +### [Invoke-AzRedeploySqlVM](Invoke-AzRedeploySqlVM.md) +Uninstalls and reinstalls the SQL IaaS Extension. + +### [Invoke-AzSqlVMTroubleshoot](Invoke-AzSqlVMTroubleshoot.md) +Starts SQL virtual machine troubleshooting. + +### [New-AzAvailabilityGroupListener](New-AzAvailabilityGroupListener.md) +Creates or updates an availability group listener. + +### [New-AzSqlVirtualMachineAgReplicaObject](New-AzSqlVirtualMachineAgReplicaObject.md) +Create an in-memory object for AgReplica. + +### [New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject](New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject.md) +Create an in-memory object for MultiSubnetIPConfiguration. + +### [New-AzSqlVM](New-AzSqlVM.md) +Creates or updates a SQL virtual machine. + +### [New-AzSqlVMGroup](New-AzSqlVMGroup.md) +Creates or updates a SQL virtual machine group. + +### [Remove-AzAvailabilityGroupListener](Remove-AzAvailabilityGroupListener.md) +Deletes an availability group listener. + +### [Remove-AzSqlVM](Remove-AzSqlVM.md) +Deletes a SQL virtual machine. + +### [Remove-AzSqlVMGroup](Remove-AzSqlVMGroup.md) +Deletes a SQL virtual machine group. + +### [Start-AzSqlVMAssessment](Start-AzSqlVMAssessment.md) +Starts SQL best practices Assessment on SQL virtual machine. + +### [Update-AzSqlVM](Update-AzSqlVM.md) +Updates a SQL virtual machine. + +### [Update-AzSqlVMGroup](Update-AzSqlVMGroup.md) +Updates SQL virtual machine group. + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/Get-AzAvailabilityGroupListener.md b/azps-10.1.0/Az.SqlVirtualMachine/Get-AzAvailabilityGroupListener.md new file mode 100644 index 0000000000..42c87d47ee --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/Get-AzAvailabilityGroupListener.md @@ -0,0 +1,206 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/get-azavailabilitygrouplistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Get-AzAvailabilityGroupListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Get-AzAvailabilityGroupListener.md +--- + +# Get-AzAvailabilityGroupListener + +## SYNOPSIS +Gets an availability group listener. + +## SYNTAX + +### List (Default) +``` +Get-AzAvailabilityGroupListener -ResourceGroupName <String> -SqlVMGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzAvailabilityGroupListener -Name <String> -ResourceGroupName <String> -SqlVMGroupName <String> + [-SubscriptionId <String[]>] [-Expand <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzAvailabilityGroupListener -InputObject <ISqlVirtualMachineIdentity> [-Expand <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets an availability group listener. + +## EXAMPLES + +### Example 1: Get all Availability Group Listeners of a SQL Virtual Machine Group +```powershell +Get-AzAvailabilityGroupListener -ResourceGroupName 'ResourceGroup01' -SqlVMGroupName 'SqlVmGroup01' +``` + +```output +Name ResourceGroupName +---- ----------------- +AgListener01 ResourceGroup01 +AgListener02 ResourceGroup01 +``` + + + +### Example 2: Get one Availability Group Listener of a SQL Virtual Machine Group +```powershell +Get-AzAvailabilityGroupListener -ResourceGroupName 'ResourceGroup01' -SqlVMGroupName 'SqlVmGroup01' -Name 'AgListener01' +``` + +```output +Name ResourceGroupName +---- ----------------- +AgListener01 ResourceGroup01 +``` + + + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +The child resources to include in the response. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentity +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.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the availability group listener. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AvailabilityGroupListenerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVMGroupName +Name of the SQL virtual machine group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: GroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.IAvailabilityGroupListener + +## 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 <ISqlVirtualMachineIdentity>`: Identity Parameter + - `[AvailabilityGroupListenerName <String>]`: Name of the availability group listener. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlVirtualMachineGroupName <String>]`: Name of the SQL virtual machine group. + - `[SqlVirtualMachineName <String>]`: Name of the SQL virtual machine. + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/Get-AzSqlVM.md b/azps-10.1.0/Az.SqlVirtualMachine/Get-AzSqlVM.md new file mode 100644 index 0000000000..26b0104403 --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/Get-AzSqlVM.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/get-azsqlvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Get-AzSqlVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Get-AzSqlVM.md +--- + +# Get-AzSqlVM + +## SYNOPSIS +Gets a SQL virtual machine. + +## SYNTAX + +### List1 (Default) +``` +Get-AzSqlVM [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSqlVM -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Expand <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSqlVM -InputObject <ISqlVirtualMachineIdentity> [-Expand <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzSqlVM -GroupName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List2 +``` +Get-AzSqlVM -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a SQL virtual machine. + +## EXAMPLES + +### Example 1: List all SQL Virtual Machines in a Resource Group +```powershell +Get-AzSqlVM -ResourceGroupName 'ResourceGroup01' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus sqlvm1 ResourceGroup01 +eastus sqlvm2 ResourceGroup01 +eastus sqlvm3 ResourceGroup02 +``` + + + +### Example 2: Get a SQL Virtual Machine +```powershell +Get-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus sqlvm1 ResourceGroup01 +``` + + + +### Example 3: List all SQL Virtual Machines in a SQL Virtual Machine Group +```powershell +Get-AzSqlVM -ResourceGroupName 'ResourceGroup01' -GroupName 'sqlvmgroup01' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus sqlvm1 ResourceGroup01 +eastus sqlvm2 ResourceGroup01 +``` + + + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +The child resources to include in the response. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +Name of the SQL virtual machine group. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: SqlVirtualMachineGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SQL virtual machine. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SqlVirtualMachineName, SqlVMName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1, List2 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.ISqlVirtualMachine + +## 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 <ISqlVirtualMachineIdentity>`: Identity Parameter + - `[AvailabilityGroupListenerName <String>]`: Name of the availability group listener. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlVirtualMachineGroupName <String>]`: Name of the SQL virtual machine group. + - `[SqlVirtualMachineName <String>]`: Name of the SQL virtual machine. + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/Get-AzSqlVMGroup.md b/azps-10.1.0/Az.SqlVirtualMachine/Get-AzSqlVMGroup.md new file mode 100644 index 0000000000..c42a683ccf --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/Get-AzSqlVMGroup.md @@ -0,0 +1,195 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/get-azsqlvmgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Get-AzSqlVMGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Get-AzSqlVMGroup.md +--- + +# Get-AzSqlVMGroup + +## SYNOPSIS +Gets a SQL virtual machine group. + +## SYNTAX + +### List1 (Default) +``` +Get-AzSqlVMGroup [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSqlVMGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSqlVMGroup -InputObject <ISqlVirtualMachineIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzSqlVMGroup -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a SQL virtual machine group. + +## EXAMPLES + +### Example 1: List all SQL Virtual Machine Groups +```powershell +Get-AzSqlVMGroup +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus sqlvmgroup01 ResourceGroup01 +eastus sqlvmgroup02 ResourceGroup01 +eastus sqlvmgroup03 ResourceGroup02 +``` + + + +### Example 2: List all SQL Virtual Machine Groups in a Resource Group +```powershell +Get-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus sqlvmgroup01 ResourceGroup01 +eastus sqlvmgroup02 ResourceGroup01 +``` + + + +### Example 3: Get a SQL Virtual Machine Group +```powershell +Get-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01' -Name 'sqlvmgroup01' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus sqlvmgroup01 ResourceGroup01 +``` + + + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SQL virtual machine group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SqlVirtualMachineGroupName, SqlVMGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.ISqlVirtualMachineGroup + +## 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 <ISqlVirtualMachineIdentity>`: Identity Parameter + - `[AvailabilityGroupListenerName <String>]`: Name of the availability group listener. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlVirtualMachineGroupName <String>]`: Name of the SQL virtual machine group. + - `[SqlVirtualMachineName <String>]`: Name of the SQL virtual machine. + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/Invoke-AzRedeploySqlVM.md b/azps-10.1.0/Az.SqlVirtualMachine/Invoke-AzRedeploySqlVM.md new file mode 100644 index 0000000000..13bfe00731 --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/Invoke-AzRedeploySqlVM.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/invoke-azredeploysqlvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Invoke-AzRedeploySqlVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Invoke-AzRedeploySqlVM.md +--- + +# Invoke-AzRedeploySqlVM + +## SYNOPSIS +Uninstalls and reinstalls the SQL IaaS Extension. + +## SYNTAX + +### Redeploy (Default) +``` +Invoke-AzRedeploySqlVM -ResourceGroupName <String> -SqlVirtualMachineName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RedeployViaIdentity +``` +Invoke-AzRedeploySqlVM -InputObject <ISqlVirtualMachineIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Uninstalls and reinstalls the SQL IaaS Extension. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzRedeploySqlVM -ResourceGroupName 'ResourceGroup01' -SqlVirtualMachineName 'sqlvm1' +``` + + + +### Example 2 +```powershell +$sqlvm = Get-AzSqlVM -ResourceGroupName 'ResourceGroup01' -GroupName 'sqlvmgroup01' +$sqlvm | Invoke-AzRedeploySqlVM +``` + + + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity +Parameter Sets: RedeployViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Redeploy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVirtualMachineName +Name of the SQL virtual machine. + +```yaml +Type: System.String +Parameter Sets: Redeploy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Redeploy +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISqlVirtualMachineIdentity>`: Identity Parameter + - `[AvailabilityGroupListenerName <String>]`: Name of the availability group listener. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlVirtualMachineGroupName <String>]`: Name of the SQL virtual machine group. + - `[SqlVirtualMachineName <String>]`: Name of the SQL virtual machine. + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/Invoke-AzSqlVMTroubleshoot.md b/azps-10.1.0/Az.SqlVirtualMachine/Invoke-AzSqlVMTroubleshoot.md new file mode 100644 index 0000000000..4716dc4b35 --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/Invoke-AzSqlVMTroubleshoot.md @@ -0,0 +1,295 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/invoke-azsqlvmtroubleshoot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Invoke-AzSqlVMTroubleshoot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Invoke-AzSqlVMTroubleshoot.md +--- + +# Invoke-AzSqlVMTroubleshoot + +## SYNOPSIS +Starts SQL virtual machine troubleshooting. + +## SYNTAX + +### TroubleshootExpanded (Default) +``` +Invoke-AzSqlVMTroubleshoot -ResourceGroupName <String> -SqlVirtualMachineName <String> + [-SubscriptionId <String>] [-EndTimeUtc <DateTime>] [-StartTimeUtc <DateTime>] + [-TroubleshootingScenario <TroubleshootingScenario>] [-UnhealthyReplicaInfoAvailabilityGroupName <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### TroubleshootViaIdentityExpanded +``` +Invoke-AzSqlVMTroubleshoot -InputObject <ISqlVirtualMachineIdentity> [-EndTimeUtc <DateTime>] + [-StartTimeUtc <DateTime>] [-TroubleshootingScenario <TroubleshootingScenario>] + [-UnhealthyReplicaInfoAvailabilityGroupName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Starts SQL virtual machine troubleshooting. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzSqlVMTroubleshoot -ResourceGroupName 'ResourceGroup01' -SqlVirtualMachineName 'sqlvm1' -StartTimeUtc '2023-03-15T17:10:00Z' -EndTimeUtc '2023-03-16T08:30:10Z' -TroubleshootingScenario 'UnhealthyReplica' +``` + +```output +EndTimeUtc StartTimeUtc TroubleshootingScenario VirtualMachineResourceId +---------- ------------ ----------------------- ------------------------ + +``` + + + +### Example 2 +```powershell +$sqlvm = Get-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' +$sqlvm | Invoke-AzSqlVMTroubleshoot -StartTimeUtc '2023-03-15T17:10:00Z' -EndTimeUtc '2023-03-16T08:30:10Z' -TroubleshootingScenario 'UnhealthyReplica' +``` + +```output +EndTimeUtc StartTimeUtc TroubleshootingScenario VirtualMachineResourceId +---------- ------------ ----------------------- ------------------------ + +``` + + + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTimeUtc +End time in UTC timezone. + +```yaml +Type: System.DateTime +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.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity +Parameter Sets: TroubleshootViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: TroubleshootExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVirtualMachineName +Name of the SQL virtual machine. + +```yaml +Type: System.String +Parameter Sets: TroubleshootExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTimeUtc +Start time in UTC timezone. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: TroubleshootExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TroubleshootingScenario +SQL VM troubleshooting scenario. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.TroubleshootingScenario +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnhealthyReplicaInfoAvailabilityGroupName +The name of the availability group + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.ISqlVMTroubleshooting + +## 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 <ISqlVirtualMachineIdentity>`: Identity Parameter + - `[AvailabilityGroupListenerName <String>]`: Name of the availability group listener. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlVirtualMachineGroupName <String>]`: Name of the SQL virtual machine group. + - `[SqlVirtualMachineName <String>]`: Name of the SQL virtual machine. + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/New-AzAvailabilityGroupListener.md b/azps-10.1.0/Az.SqlVirtualMachine/New-AzAvailabilityGroupListener.md new file mode 100644 index 0000000000..d6115fb2a1 --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/New-AzAvailabilityGroupListener.md @@ -0,0 +1,398 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/new-azavailabilitygrouplistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/New-AzAvailabilityGroupListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/New-AzAvailabilityGroupListener.md +--- + +# New-AzAvailabilityGroupListener + +## SYNOPSIS +Creates or updates an availability group listener. + +## SYNTAX + +``` +New-AzAvailabilityGroupListener -Name <String> -ResourceGroupName <String> -SqlVMGroupName <String> + [-SubscriptionId <String>] [-AvailabilityGroupConfigurationReplica <IAgReplica[]>] + [-AvailabilityGroupName <String>] [-CreateDefaultAvailabilityGroupIfNotExist] [-IpAddress <String>] + [-LoadBalancerResourceId <String>] [-MultiSubnetIPConfiguration <IMultiSubnetIPConfiguration[]>] + [-Port <Int32>] [-ProbePort <Int32>] [-PublicIpAddressResourceId <String>] [-SqlVirtualMachineId <String[]>] + [-SubnetId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an availability group listener. + +## EXAMPLES + +### Example 1 +```powershell +New-AzAvailabilityGroupListener -ResourceGroupName 'ResourceGroup01' -SqlVMGroupName 'sqlvmgroup01' -Name 'AgListener01' -AvailabilityGroupName 'AG01' -IpAddress '192.168.16.7' -LoadBalancerResourceId $LoadBalancerResourceId -SubnetId $SubnetResourceId -ProbePort 9999 -SqlVirtualMachineId $sqlvmResourceId1,$sqlvmResourceId2 +``` + +```output +Name ResourceGroupName +---- ----------------- +AgListener01 ResourceGroup01 +``` + +Create a new Availability Group Listener "AgListener01" with Load Balancer Configuration for the Availability Group "AG01" in SQL Virtual Machine Group "sqlvmgroup01". + +### Example 2 +```powershell +$msconfig1 = New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject -PrivateIPAddressSubnetResourceId $SubnetResourceId1 -PrivateIPAddressIpaddress '192.168.16.9' -SqlVirtualMachineInstance $sqlvmResourceId1 +$msconfig2 = New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject -PrivateIPAddressSubnetResourceId $SubnetResourceId2 -PrivateIPAddressIpaddress '192.168.17.9' -SqlVirtualMachineInstance $sqlvmResourceId2 + +New-AzAvailabilityGroupListener -Name 'AgListener02' -ResourceGroupName 'ResourceGroup01' -SqlVMGroupName 'sqlvmgroup01' -AvailabilityGroupName 'AG02' -MultiSubnetIPConfiguration $msconfig1,$msconfig2 +``` + +```output +Name ResourceGroupName +---- ----------------- +AgListener02 ResourceGroup01 +``` + +Create a new Availability Group Listener "AgListener02" with Multi Subnets Configuration for the Availability Group "AG02" in SQL Virtual Machine Group "sqlvmgroup01". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityGroupConfigurationReplica +Replica configurations. +To construct, see NOTES section for AVAILABILITYGROUPCONFIGURATIONREPLICA properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.IAgReplica[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityGroupName +Name of the availability group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateDefaultAvailabilityGroupIfNotExist +Create a default availability group if it does not exist. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddress +Private IP address bound to the availability group listener. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerResourceId +Resource id of the load balancer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiSubnetIPConfiguration +List of multi subnet IP configurations for an AG listener. +To construct, see NOTES section for MULTISUBNETIPCONFIGURATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.IMultiSubnetIPConfiguration[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the availability group listener. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AvailabilityGroupListenerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Listener port. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1433 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbePort +Probe port. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIpAddressResourceId +Resource id of the public IP. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVirtualMachineId +List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVMGroupName +Name of the SQL virtual machine group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +Subnet used to include private IP. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.IAvailabilityGroupListener + +## 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. + + +`AVAILABILITYGROUPCONFIGURATIONREPLICA <IAgReplica[]>`: Replica configurations. + - `[Commit <Commit?>]`: Replica commit mode in availability group. + - `[Failover <Failover?>]`: Replica failover mode in availability group. + - `[ReadableSecondary <ReadableSecondary?>]`: Replica readable secondary mode in availability group. + - `[Role <Role?>]`: Replica Role in availability group. + - `[SqlVirtualMachineInstanceId <String>]`: Sql VirtualMachine Instance Id. + +`MULTISUBNETIPCONFIGURATION <IMultiSubnetIPConfiguration[]>`: List of multi subnet IP configurations for an AG listener. + - `SqlVirtualMachineInstance <String>`: SQL virtual machine instance resource id that are enrolled into the availability group listener. + - `[PrivateIPAddressIpaddress <String>]`: Private IP address bound to the availability group listener. + - `[PrivateIPAddressSubnetResourceId <String>]`: Subnet used to include private IP. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/New-AzSqlVM.md b/azps-10.1.0/Az.SqlVirtualMachine/New-AzSqlVM.md new file mode 100644 index 0000000000..a62d35f63c --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/New-AzSqlVM.md @@ -0,0 +1,1415 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/new-azsqlvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/New-AzSqlVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/New-AzSqlVM.md +--- + +# New-AzSqlVM + +## SYNOPSIS +Creates or updates a SQL virtual machine. + +## SYNTAX + +``` +New-AzSqlVM -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-AdditionalFeatureServerConfigurationIsRServicesEnabled] [-AssessmentSettingEnable] + [-AssessmentSettingRunImmediately] [-AutoBackupSettingBackupScheduleType <BackupScheduleType>] + [-AutoBackupSettingBackupSystemDb] [-AutoBackupSettingDaysOfWeek <AutoBackupDaysOfWeek[]>] + [-AutoBackupSettingEnable] [-AutoBackupSettingEnableEncryption] + [-AutoBackupSettingFullBackupFrequency <FullBackupFrequencyType>] + [-AutoBackupSettingFullBackupStartTime <Int32>] [-AutoBackupSettingFullBackupWindowHour <Int32>] + [-AutoBackupSettingLogBackupFrequency <Int32>] [-AutoBackupSettingPassword <SecureString>] + [-AutoBackupSettingRetentionPeriod <Int32>] [-AutoBackupSettingStorageAccessKey <String>] + [-AutoBackupSettingStorageAccountUrl <String>] [-AutoBackupSettingStorageContainerName <String>] + [-AutoPatchingSettingDayOfWeek <DayOfWeek>] [-AutoPatchingSettingEnable] + [-AutoPatchingSettingMaintenanceWindowDuration <Int32>] + [-AutoPatchingSettingMaintenanceWindowStartingHour <Int32>] [-AzureAdAuthenticationSettingClientId <String>] + [-EnableAutomaticUpgrade] [-IdentityType <IdentityType>] + [-KeyVaultCredentialSettingAzureKeyVaultUrl <String>] [-KeyVaultCredentialSettingCredentialName <String>] + [-KeyVaultCredentialSettingEnable] [-KeyVaultCredentialSettingServicePrincipalName <String>] + [-KeyVaultCredentialSettingServicePrincipalSecret <String>] [-LeastPrivilegeMode <LeastPrivilegeMode>] + [-LicenseType <SqlServerLicenseType>] [-Offer <String>] [-ScheduleDayOfWeek <AssessmentDayOfWeek>] + [-ScheduleEnable] [-ScheduleMonthlyOccurrence <Int32>] [-ScheduleStartTime <String>] + [-ScheduleWeeklyInterval <Int32>] [-Sku <SqlImageSku>] + [-SqlConnectivityUpdateSettingConnectivityType <ConnectivityType>] + [-SqlConnectivityUpdateSettingPort <Int32>] + [-SqlConnectivityUpdateSettingSqlAuthUpdatePassword <SecureString>] + [-SqlConnectivityUpdateSettingSqlAuthUpdateUserName <String>] [-SqlDataSettingDefaultFilePath <String>] + [-SqlDataSettingLun <Int32[]>] [-SqlInstanceSettingCollation <String>] [-SqlInstanceSettingIsIfiEnabled] + [-SqlInstanceSettingIsLpimEnabled] [-SqlInstanceSettingIsOptimizeForAdHocWorkloadsEnabled] + [-SqlInstanceSettingMaxDop <Int32>] [-SqlInstanceSettingMaxServerMemoryMb <Int32>] + [-SqlInstanceSettingMinServerMemoryMb <Int32>] [-SqlLogSettingDefaultFilePath <String>] + [-SqlLogSettingLun <Int32[]>] [-SqlManagementType <SqlManagementMode>] + [-SqlStorageUpdateSettingDiskConfigurationType <DiskConfigurationType>] + [-SqlStorageUpdateSettingDiskCount <Int32>] [-SqlStorageUpdateSettingStartingDeviceId <Int32>] + [-SqlTempDbSettingDataFileCount <Int32>] [-SqlTempDbSettingDataFileSize <Int32>] + [-SqlTempDbSettingDataGrowth <Int32>] [-SqlTempDbSettingDefaultFilePath <String>] + [-SqlTempDbSettingLogFileSize <Int32>] [-SqlTempDbSettingLogGrowth <Int32>] [-SqlTempDbSettingLun <Int32[]>] + [-SqlTempDbSettingPersistFolder] [-SqlTempDbSettingPersistFolderPath <String>] + [-SqlVirtualMachineGroupResourceId <String>] [-SqlWorkloadTypeUpdateSettingSqlWorkloadType <SqlWorkloadType>] + [-StorageConfigurationSettingDiskConfigurationType <DiskConfigurationType>] + [-StorageConfigurationSettingSqlSystemDbOnDataDisk] + [-StorageConfigurationSettingStorageWorkloadType <StorageWorkloadType>] [-Tag <Hashtable>] + [-VirtualMachineResourceId <String>] [-WsfcDomainCredentialsClusterBootstrapAccountPassword <SecureString>] + [-WsfcDomainCredentialsClusterOperatorAccountPassword <SecureString>] + [-WsfcDomainCredentialsSqlServiceAccountPassword <SecureString>] [-WsfcStaticIP <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a SQL virtual machine. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -Location 'eastus' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus sqlvm1 ResourceGroup01 +``` + + + +### Example 2 +```powershell +New-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -Location 'eastus' -Sku 'Developer' -LicenseType 'PAYG' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus sqlvm1 ResourceGroup01 +``` + + + +## PARAMETERS + +### -AdditionalFeatureServerConfigurationIsRServicesEnabled +Enable or disable R services (SQL 2016 onwards). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssessmentSettingEnable +Enable or disable SQL best practices Assessment feature on SQL virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssessmentSettingRunImmediately +Run SQL best practices Assessment immediately on SQL virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingBackupScheduleType +Backup schedule type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.BackupScheduleType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingBackupSystemDb +Include or exclude system databases from auto backup. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingDaysOfWeek +Days of the week for the backups when FullBackupFrequency is set to Weekly. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.AutoBackupDaysOfWeek[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingEnable +Enable or disable autobackup on SQL virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingEnableEncryption +Enable or disable encryption for backup on SQL virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingFullBackupFrequency +Frequency of full backups. +In both cases, full backups begin during the next scheduled time window. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.FullBackupFrequencyType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingFullBackupStartTime +Start time of a given day during which full backups can take place. +0-23 hours. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingFullBackupWindowHour +Duration of the time window of a given day during which full backups can take place. +1-23 hours. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingLogBackupFrequency +Frequency of log backups. +5-60 minutes. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingPassword +Password for encryption on backup. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingRetentionPeriod +Retention period of backup: 1-90 days. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingStorageAccessKey +Storage account key where backup will be taken to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingStorageAccountUrl +Storage account url where backup will be taken to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoBackupSettingStorageContainerName +Storage container name where backup will be taken to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoPatchingSettingDayOfWeek +Day of week to apply the patch on. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.DayOfWeek +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoPatchingSettingEnable +Enable or disable autopatching on SQL virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoPatchingSettingMaintenanceWindowDuration +Duration of patching. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoPatchingSettingMaintenanceWindowStartingHour +Hour of the day when patching is initiated. +Local VM time. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureAdAuthenticationSettingClientId +The client Id of the Managed Identity to query Microsoft Graph API. +An empty string must be used for the system assigned Managed Identity + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutomaticUpgrade +Enable automatic upgrade of Sql IaaS extension Agent. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. +Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.IdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultCredentialSettingAzureKeyVaultUrl +Azure Key Vault url. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultCredentialSettingCredentialName +Credential name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultCredentialSettingEnable +Enable or disable key vault credential setting. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultCredentialSettingServicePrincipalName +Service principal name to access key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultCredentialSettingServicePrincipalSecret +Service principal name secret to access key vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LeastPrivilegeMode +SQL IaaS Agent least privilege mode. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.LeastPrivilegeMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +SQL Server license type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.SqlServerLicenseType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the SQL virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SqlVirtualMachineName, SqlVMName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Offer +SQL image offer. +Examples include SQL2016-WS2016, SQL2017-WS2016. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleDayOfWeek +Day of the week to run assessment. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.AssessmentDayOfWeek +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleEnable +Enable or disable assessment schedule on SQL virtual machine. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleMonthlyOccurrence +Occurrence of the DayOfWeek day within a month to schedule assessment. +Takes values: 1,2,3,4 and -1. +Use -1 for last DayOfWeek day of the month + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleStartTime +Time of the day in HH:mm format. +Eg. +17:30 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleWeeklyInterval +Number of weeks to schedule between 2 assessment runs. +Takes value from 1-6 + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +SQL Server edition type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.SqlImageSku +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlConnectivityUpdateSettingConnectivityType +SQL Server connectivity option. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.ConnectivityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlConnectivityUpdateSettingPort +SQL Server port. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlConnectivityUpdateSettingSqlAuthUpdatePassword +SQL Server sysadmin login password. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlConnectivityUpdateSettingSqlAuthUpdateUserName +SQL Server sysadmin login to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlDataSettingDefaultFilePath +SQL Server default file path + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlDataSettingLun +Logical Unit Numbers for the disks. + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlInstanceSettingCollation +SQL Server Collation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlInstanceSettingIsIfiEnabled +SQL Server IFI. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlInstanceSettingIsLpimEnabled +SQL Server LPIM. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlInstanceSettingIsOptimizeForAdHocWorkloadsEnabled +SQL Server Optimize for Adhoc workloads. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlInstanceSettingMaxDop +SQL Server MAXDOP. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlInstanceSettingMaxServerMemoryMb +SQL Server maximum memory. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlInstanceSettingMinServerMemoryMb +SQL Server minimum memory. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlLogSettingDefaultFilePath +SQL Server default file path + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlLogSettingLun +Logical Unit Numbers for the disks. + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlManagementType +SQL Server Management type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.SqlManagementMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlStorageUpdateSettingDiskConfigurationType +Disk configuration to apply to SQL Server. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.DiskConfigurationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlStorageUpdateSettingDiskCount +Virtual machine disk count. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlStorageUpdateSettingStartingDeviceId +Device id of the first disk to be updated. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlTempDbSettingDataFileCount +SQL Server tempdb data file count + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlTempDbSettingDataFileSize +SQL Server tempdb data file size + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlTempDbSettingDataGrowth +SQL Server tempdb data file autoGrowth size + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlTempDbSettingDefaultFilePath +SQL Server default file path + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlTempDbSettingLogFileSize +SQL Server tempdb log file size + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlTempDbSettingLogGrowth +SQL Server tempdb log file autoGrowth size + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlTempDbSettingLun +Logical Unit Numbers for the disks. + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlTempDbSettingPersistFolder +SQL Server tempdb persist folder choice + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlTempDbSettingPersistFolderPath +SQL Server tempdb persist folder location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVirtualMachineGroupResourceId +ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlWorkloadTypeUpdateSettingSqlWorkloadType +SQL Server workload type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.SqlWorkloadType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageConfigurationSettingDiskConfigurationType +Disk configuration to apply to SQL Server. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.DiskConfigurationType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageConfigurationSettingSqlSystemDbOnDataDisk +SQL Server SystemDb Storage on DataPool if true. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageConfigurationSettingStorageWorkloadType +Storage workload type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.StorageWorkloadType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualMachineResourceId +ARM Resource id of underlying virtual machine created from SQL marketplace image. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WsfcDomainCredentialsClusterBootstrapAccountPassword +Cluster bootstrap account password. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WsfcDomainCredentialsClusterOperatorAccountPassword +Cluster operator account password. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WsfcDomainCredentialsSqlServiceAccountPassword +SQL service account password. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WsfcStaticIP +Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.ISqlVirtualMachine + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/New-AzSqlVMGroup.md b/azps-10.1.0/Az.SqlVirtualMachine/New-AzSqlVMGroup.md new file mode 100644 index 0000000000..d69274943e --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/New-AzSqlVMGroup.md @@ -0,0 +1,382 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/new-azsqlvmgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/New-AzSqlVMGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/New-AzSqlVMGroup.md +--- + +# New-AzSqlVMGroup + +## SYNOPSIS +Creates or updates a SQL virtual machine group. + +## SYNTAX + +``` +New-AzSqlVMGroup -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-ClusterBootstrapAccount <String>] [-ClusterOperatorAccount <String>] + [-ClusterSubnetType <ClusterSubnetType>] [-DomainFqdn <String>] [-FileShareWitnessPath <String>] + [-Offer <String>] [-OuPath <String>] [-Sku <SqlVMGroupImageSku>] [-SqlServiceAccount <String>] + [-StorageAccountPrimaryKey <SecureString>] [-StorageAccountUrl <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a SQL virtual machine group. + +## EXAMPLES + +### Example +```powershell +# $accessKey is a valid access key for the storage account +$storageAccountPrimaryKey = ConvertTo-SecureString -String $accessKey -AsPlainText -Force +New-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01' -Name 'sqlvmgroup01' -Location 'eastus' -Offer 'SQL2022-WS2022' -Sku 'Developer' -DomainFqdn 'yourdomain.com' -ClusterOperatorAccount 'operatoruser@yourdomain.com' -ClusterBootstrapAccount 'bootstrapuser@yourdomain.com' -StorageAccountUrl 'https://yourstorageaccount.blob.core.windows.net/' -StorageAccountPrimaryKey $storageAccountPrimaryKey -SqlServiceAccount 'sqladmin@yourdomain.com' -ClusterSubnetType 'SingleSubnet' +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus sqlvmgroup01 ResourceGroup01 +``` + +Creates a Azure SQL virtual machine group "sqlvmgroup01" in the resource group "ResourceGroup01". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterBootstrapAccount +Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterOperatorAccount +Account name used for operating cluster i.e. +will be part of administrators group on all the participating virtual machines in the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterSubnetType +Cluster subnet type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.ClusterSubnetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainFqdn +Fully qualified name of the domain. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileShareWitnessPath +Optional path for fileshare witness. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the SQL virtual machine group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SqlVirtualMachineGroupName, SqlVMGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Offer +SQL image offer. +Examples may include SQL2016-WS2016, SQL2017-WS2016. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OuPath +Organizational Unit path in which the nodes and cluster will be present. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +SQL image sku. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.SqlVMGroupImageSku +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlServiceAccount +Account name under which SQL service will run on all participating SQL virtual machines in the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountPrimaryKey +Primary key of the witness storage account. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountUrl +Fully qualified ARM resource id of the witness storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.ISqlVirtualMachineGroup + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/New-AzSqlVirtualMachineAgReplicaObject.md b/azps-10.1.0/Az.SqlVirtualMachine/New-AzSqlVirtualMachineAgReplicaObject.md new file mode 100644 index 0000000000..2de7e0ae14 --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/New-AzSqlVirtualMachineAgReplicaObject.md @@ -0,0 +1,134 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/Az.SqlVirtualMachine/new-AzSqlVirtualMachineAgReplicaObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/New-AzSqlVirtualMachineAgReplicaObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/New-AzSqlVirtualMachineAgReplicaObject.md +--- + +# New-AzSqlVirtualMachineAgReplicaObject + +## SYNOPSIS +Create an in-memory object for AgReplica. + +## SYNTAX + +``` +New-AzSqlVirtualMachineAgReplicaObject [-Commit <Commit>] [-Failover <Failover>] + [-ReadableSecondary <ReadableSecondary>] [-Role <Role>] [-SqlVirtualMachineInstanceId <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for AgReplica. + +## EXAMPLES + +### Example 1: Create an in-memory object for availability group replica configuration +```powershell +$AgReplica = New-AzSqlVirtualMachineAgReplicaObject -Commit 'SYNCHRONOUS_COMMIT' -Failover 'MANUAL' -ReadableSecondary 'NO' -Role 'PRIMARY' -SqlVirtualMachineInstanceId $sqlvmResourceId1 +$AgReplica +``` + +```output +Commit Failover ReadableSecondary Role SqlVirtualMachineInstanceId +------ -------- ----------------- ---- --------------------------- +SYNCHRONOUS_COMMIT MANUAL NO PRIMARY +``` + +*New-AzSqlVirtualMachineAgReplicaObject* creates an in-memory object of type *AgReplica*. +This object represents an availability group replica configuration and will be used for parameter *AvailabilityGroupConfigurationReplica* in cmdlet *New-AzAvailabilityGroupListener*. + +## PARAMETERS + +### -Commit +Replica commit mode in availability group. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.Commit +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Failover +Replica failover mode in availability group. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.Failover +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadableSecondary +Replica readable secondary mode in availability group. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.ReadableSecondary +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +Replica Role in availability group. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.Role +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVirtualMachineInstanceId +Sql VirtualMachine Instance Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.AgReplica + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject.md b/azps-10.1.0/Az.SqlVirtualMachine/New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject.md new file mode 100644 index 0000000000..47fdb8390b --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject.md @@ -0,0 +1,104 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/Az.SqlVirtualMachine/new-AzSqlVirtualMachineMultiSubnetIPConfigurationObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject.md +--- + +# New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject + +## SYNOPSIS +Create an in-memory object for MultiSubnetIPConfiguration. + +## SYNTAX + +``` +New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject -SqlVirtualMachineInstance <String> + [-PrivateIPAddressIpaddress <String>] [-PrivateIPAddressSubnetResourceId <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for MultiSubnetIPConfiguration. + +## EXAMPLES + +### Example 1: Create an in-memory object for multi subnet ip configuration +```powershell +$multiSubnetIpConfig = New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject -PrivateIPAddressSubnetResourceId $SubnetId -PrivateIPAddressIpaddress $IPAddress -SqlVirtualMachineInstance $SqlVMResourceId +$multiSubnetIpConfig | Format-List +``` + +```output +PrivateIPAddressIpaddress : 192.168.16.7 +PrivateIPAddressSubnetResourceId : +SqlVirtualMachineInstance : +``` + +*New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject* creates an in-memory object of type *MultiSubnetIPConfiguration*. +This object represents a multi subnet ip configuration for an availability group listener. +It will be used for parameter *MultiSubnetIPConfiguration* in cmdlet *New-AzAvailabilityGroupListener*. + +## PARAMETERS + +### -PrivateIPAddressIpaddress +Private IP address bound to the availability group listener. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateIPAddressSubnetResourceId +Subnet used to include private IP. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVirtualMachineInstance +SQL virtual machine instance resource id that are enrolled into the availability group listener. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.MultiSubnetIPConfiguration + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/Remove-AzAvailabilityGroupListener.md b/azps-10.1.0/Az.SqlVirtualMachine/Remove-AzAvailabilityGroupListener.md new file mode 100644 index 0000000000..d98ace5370 --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/Remove-AzAvailabilityGroupListener.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/remove-azavailabilitygrouplistener +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Remove-AzAvailabilityGroupListener.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Remove-AzAvailabilityGroupListener.md +--- + +# Remove-AzAvailabilityGroupListener + +## SYNOPSIS +Deletes an availability group listener. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAvailabilityGroupListener -Name <String> -ResourceGroupName <String> -SqlVMGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzAvailabilityGroupListener -InputObject <ISqlVirtualMachineIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an availability group listener. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzAvailabilityGroupListener -ResourceGroupName 'ResourceGroup01' -SqlVMGroupName 'SqlVmGroup01' -Name 'AgListener01' +``` + + + +### Example 2 +```powershell +$msListner = Get-AzAvailabilityGroupListener -ResourceGroupName 'ResourceGroup01' -SqlVMGroupName 'SqlVmGroup01' -Name 'AgListener01' +$msListner | Remove-AzAvailabilityGroupListener +``` + + + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the availability group listener. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AvailabilityGroupListenerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVMGroupName +Name of the SQL virtual machine group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: GroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISqlVirtualMachineIdentity>`: Identity Parameter + - `[AvailabilityGroupListenerName <String>]`: Name of the availability group listener. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlVirtualMachineGroupName <String>]`: Name of the SQL virtual machine group. + - `[SqlVirtualMachineName <String>]`: Name of the SQL virtual machine. + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/Remove-AzSqlVM.md b/azps-10.1.0/Az.SqlVirtualMachine/Remove-AzSqlVM.md new file mode 100644 index 0000000000..6cc443a2f4 --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/Remove-AzSqlVM.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/remove-azsqlvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Remove-AzSqlVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Remove-AzSqlVM.md +--- + +# Remove-AzSqlVM + +## SYNOPSIS +Deletes a SQL virtual machine. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSqlVM -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSqlVM -InputObject <ISqlVirtualMachineIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a SQL virtual machine. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' +``` + + + +### Example 2 +```powershell +$sqlVM = Get-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' +$sqlVM | Remove-AzSqlVM +``` + + + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SQL virtual machine. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SqlVirtualMachineName, SqlVMName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISqlVirtualMachineIdentity>`: Identity Parameter + - `[AvailabilityGroupListenerName <String>]`: Name of the availability group listener. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlVirtualMachineGroupName <String>]`: Name of the SQL virtual machine group. + - `[SqlVirtualMachineName <String>]`: Name of the SQL virtual machine. + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/Remove-AzSqlVMGroup.md b/azps-10.1.0/Az.SqlVirtualMachine/Remove-AzSqlVMGroup.md new file mode 100644 index 0000000000..057b1b178c --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/Remove-AzSqlVMGroup.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/remove-azsqlvmgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Remove-AzSqlVMGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Remove-AzSqlVMGroup.md +--- + +# Remove-AzSqlVMGroup + +## SYNOPSIS +Deletes a SQL virtual machine group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSqlVMGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSqlVMGroup -InputObject <ISqlVirtualMachineIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a SQL virtual machine group. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01' -Name 'sqlvmgroup01' +``` + + + +### Example 2 +```powershell +$group = Get-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01' -Name 'sqlvmgroup01' +$group | Remove-AzSqlVMGroup +``` + + + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SQL virtual machine group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SqlVirtualMachineGroupName, SqlVMGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISqlVirtualMachineIdentity>`: Identity Parameter + - `[AvailabilityGroupListenerName <String>]`: Name of the availability group listener. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlVirtualMachineGroupName <String>]`: Name of the SQL virtual machine group. + - `[SqlVirtualMachineName <String>]`: Name of the SQL virtual machine. + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/Start-AzSqlVMAssessment.md b/azps-10.1.0/Az.SqlVirtualMachine/Start-AzSqlVMAssessment.md new file mode 100644 index 0000000000..c680fbe83a --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/Start-AzSqlVMAssessment.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/start-azsqlvmassessment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Start-AzSqlVMAssessment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Start-AzSqlVMAssessment.md +--- + +# Start-AzSqlVMAssessment + +## SYNOPSIS +Starts SQL best practices Assessment on SQL virtual machine. + +## SYNTAX + +### Start (Default) +``` +Start-AzSqlVMAssessment -ResourceGroupName <String> -SqlVirtualMachineName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzSqlVMAssessment -InputObject <ISqlVirtualMachineIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Starts SQL best practices Assessment on SQL virtual machine. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzSqlVMAssessment -ResourceGroupName 'ResourceGroup01' -SqlVirtualMachineName 'sqlvm1' +``` + + + +### Example 2 +```powershell +$sqlvm = Get-AzSqlVM -ResourceGroupName 'ResourceGroup01' -GroupName 'sqlvmgroup01' +$sqlvm | Start-AzSqlVMAssessment +``` + + + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlVirtualMachineName +Name of the SQL virtual machine. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <ISqlVirtualMachineIdentity>`: Identity Parameter + - `[AvailabilityGroupListenerName <String>]`: Name of the availability group listener. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlVirtualMachineGroupName <String>]`: Name of the SQL virtual machine group. + - `[SqlVirtualMachineName <String>]`: Name of the SQL virtual machine. + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/Update-AzSqlVM.md b/azps-10.1.0/Az.SqlVirtualMachine/Update-AzSqlVM.md new file mode 100644 index 0000000000..fe98c6d0d5 --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/Update-AzSqlVM.md @@ -0,0 +1,309 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/update-azsqlvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Update-AzSqlVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Update-AzSqlVM.md +--- + +# Update-AzSqlVM + +## SYNOPSIS +Updates a SQL virtual machine. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSqlVM -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-LicenseType <SqlServerLicenseType>] [-Offer <String>] [-Sku <SqlImageSku>] + [-SqlManagementType <SqlManagementMode>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzSqlVM -InputObject <ISqlVirtualMachineIdentity> [-LicenseType <SqlServerLicenseType>] + [-Offer <String>] [-Sku <SqlImageSku>] [-SqlManagementType <SqlManagementMode>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a SQL virtual machine. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -SqlManagementType 'Full' -Sku 'Standard' -LicenseType 'AHUB' -Tag @{'newkey'='newvalue'} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus sqlvm1 ResourceGroup01 +``` + + + +### Example 2 +```powershell +$sqlVM = Get-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' +$sqlVM | Update-AzSqlVM -SqlManagementType 'Full' -Sku 'Standard' -LicenseType 'AHUB' -Tag @{'newkey'='newvalue'} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus sqlvm1 ResourceGroup01 +``` + + + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity +Parameter Sets: UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LicenseType +SQL Server license type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.SqlServerLicenseType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the SQL virtual machine. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: SqlVirtualMachineName, SqlVMName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Offer +SQL image offer. +Examples include SQL2016-WS2016, SQL2017-WS2016. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +SQL Server edition type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.SqlImageSku +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlManagementType +SQL Server Management type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.SqlManagementMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.ISqlVirtualMachine + +## 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 <ISqlVirtualMachineIdentity>`: Identity Parameter + - `[AvailabilityGroupListenerName <String>]`: Name of the availability group listener. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlVirtualMachineGroupName <String>]`: Name of the SQL virtual machine group. + - `[SqlVirtualMachineName <String>]`: Name of the SQL virtual machine. + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.SqlVirtualMachine/Update-AzSqlVMGroup.md b/azps-10.1.0/Az.SqlVirtualMachine/Update-AzSqlVMGroup.md new file mode 100644 index 0000000000..45f0f509fc --- /dev/null +++ b/azps-10.1.0/Az.SqlVirtualMachine/Update-AzSqlVMGroup.md @@ -0,0 +1,388 @@ +--- +external help file: +Module Name: Az.SqlVirtualMachine +online version: https://learn.microsoft.com/powershell/module/az.sqlvirtualmachine/update-azsqlvmgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Update-AzSqlVMGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/SqlVirtualMachine/help/Update-AzSqlVMGroup.md +--- + +# Update-AzSqlVMGroup + +## SYNOPSIS +Updates SQL virtual machine group. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSqlVMGroup -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-ClusterBootstrapAccount <String>] [-ClusterOperatorAccount <String>] + [-ClusterSubnetType <ClusterSubnetType>] [-DomainFqdn <String>] [-FileShareWitnessPath <String>] + [-OuPath <String>] [-SqlServiceAccount <String>] [-StorageAccountPrimaryKey <SecureString>] + [-StorageAccountUrl <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzSqlVMGroup -InputObject <ISqlVirtualMachineIdentity> [-ClusterBootstrapAccount <String>] + [-ClusterOperatorAccount <String>] [-ClusterSubnetType <ClusterSubnetType>] [-DomainFqdn <String>] + [-FileShareWitnessPath <String>] [-OuPath <String>] [-SqlServiceAccount <String>] + [-StorageAccountPrimaryKey <SecureString>] [-StorageAccountUrl <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates SQL virtual machine group. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01' -Name 'sqlvmgroup01' -ClusterBootstrapAccount 'newbootstrapuser@yourdomain.com' -ClusterOperatorAccount 'newoperatoruser@yourdomain.com' -Tag @{'newkey'='newvalue'} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus sqlvmgroup01 ResourceGroup01 +``` + + + +### Example 2 +```powershell +$group = Get-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01' -Name 'sqlvmgroup01' +$group | Update-AzSqlVMGroup -ClusterBootstrapAccount 'newbootstrapuser@yourdomain.com' -ClusterOperatorAccount 'newoperatoruser@yourdomain.com' -Tag @{'newkey'='newvalue'} +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus sqlvmgroup01 ResourceGroup01 +``` + + + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterBootstrapAccount +Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterOperatorAccount +Account name used for operating cluster i.e. +will be part of administrators group on all the participating virtual machines in the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterSubnetType +Cluster subnet type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.ClusterSubnetType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainFqdn +Fully qualified name of the domain. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileShareWitnessPath +Optional path for fileshare witness. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity +Parameter Sets: UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SQL virtual machine group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: SqlVirtualMachineGroupName, SqlVMGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OuPath +Organizational Unit path in which the nodes and cluster will be present. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group that contains the resource. +You can obtain this value from the Azure Resource Manager API or the portal. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlServiceAccount +Account name under which SQL service will run on all participating SQL virtual machines in the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountPrimaryKey +Primary key of the witness storage account. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountUrl +Fully qualified ARM resource id of the witness storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription ID that identifies an Azure subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.ISqlVirtualMachineIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.ISqlVirtualMachineGroup + +## 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 <ISqlVirtualMachineIdentity>`: Identity Parameter + - `[AvailabilityGroupListenerName <String>]`: Name of the availability group listener. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. + - `[SqlVirtualMachineGroupName <String>]`: Name of the SQL virtual machine group. + - `[SqlVirtualMachineName <String>]`: Name of the SQL virtual machine. + - `[SubscriptionId <String>]`: Subscription ID that identifies an Azure subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Ssh/Az.Ssh.md b/azps-10.1.0/Az.Ssh/Az.Ssh.md new file mode 100644 index 0000000000..beffae60c5 --- /dev/null +++ b/azps-10.1.0/Az.Ssh/Az.Ssh.md @@ -0,0 +1,23 @@ +--- +Module Name: Az.Ssh +Module Guid: 91832aaa-dc11-4583-8239-bce5fd531604 +Download Help Link: {{ Update Download Link }} +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Ssh/Ssh/help/Az.Ssh.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Ssh/Ssh/help/Az.Ssh.md +--- + +# Az.Ssh Module +## Description +This module allows you to create an interactive shell connection to Azure Resources, such as Azure VMs or Arc Servers, using SSH (Secure Shell). The connection can be established using AAD (Azure Active Directory) accounts, or local machine accounts. Note that this module requires that OpenSSH be installed and discoverable on the client machine. +Important note: When connecting to Azure Arc resources, this module requires the Az.Ssh.ArcProxy module to also be installed in the client machine. The cmdlets will attempt to install the module from the PowerShell Gallery, but the user also has the option to install it themselves. It is important that the user also has permission to execute the Proxy files in the Az.Ssh.ArcProxy module, or the connection will fail. You can find the Az.Ssh.ArcServer module in the PowerShell Gallery: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy. + +## Az.Ssh Cmdlets +### [Enter-AzVM](Enter-AzVM.md) +Starts an interactive SSH session to an Azure Resource (such as Azure VMs or Arc Servers). +Users can login using AAD accounts, or local user accounts via standard SSH authentication. Use AAD account login for the best security and convenience. + +### [Export-AzSshConfig](Export-AzSshConfig.md) +This cmdlet exports an SSH configuration file that can be used to connect to Azure Resources through client applications that support OpenSSH config and certificates. SSH config files can be created that use AAD issued certificates or local user credentials. + diff --git a/azps-10.1.0/Az.Ssh/Enter-AzVM.md b/azps-10.1.0/Az.Ssh/Enter-AzVM.md new file mode 100644 index 0000000000..aea354fa04 --- /dev/null +++ b/azps-10.1.0/Az.Ssh/Enter-AzVM.md @@ -0,0 +1,360 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Ssh.dll-Help.xml +Module Name: Az.Ssh +online version: https://learn.microsoft.com/powershell/module/az.ssh/enter-azvm +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Ssh/Ssh/help/Enter-AzVM.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Ssh/Ssh/help/Enter-AzVM.md +--- + +# Enter-AzVM + +## SYNOPSIS +Starts an interactive SSH session to an Azure Resource (such as Azure VMs or Arc Servers). +Users can login using AAD accounts, or local user accounts via standard SSH authentication. Use AAD account login for the best security and convenience. + +## SYNTAX + +### Interactive (Default) +``` +Enter-AzVM -ResourceGroupName <String> -Name <String> [-PublicKeyFile <String>] [-PrivateKeyFile <String>] + [-UsePrivateIp] [-LocalUser <String>] [-Port <String>] [-ResourceType <String>] [-CertificateFile <String>] + [-SshArgument <String[]>] [-Rdp] [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### IpAddress +``` +Enter-AzVM -Ip <String> [-PublicKeyFile <String>] [-PrivateKeyFile <String>] [-LocalUser <String>] + [-Port <String>] [-CertificateFile <String>] [-SshArgument <String[]>] [-Rdp] [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Enter-AzVM -ResourceId <String> [-PublicKeyFile <String>] [-PrivateKeyFile <String>] [-UsePrivateIp] + [-LocalUser <String>] [-Port <String>] [-CertificateFile <String>] [-SshArgument <String[]>] [-Rdp] + [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Start interactive SSH session to an Azure Resource (currently supports Azure VMs and Arc Servers). +Users can login using AAD issued certificates or using local user credentials. We recommend login using AAD issued certificates when possible. +Important note: When connecting to Azure Arc resources, this cmdlet requires the Az.Ssh.ArcProxy module to also be installed in the client machine. The cmdlet will attempt to install the module from the PowerShell Gallery, but the user also has the option to install it themselves. It is important that the user also has permission to execute the Proxy files in the Az.Ssh.ArcProxy module, or the connection will fail. You can find the Az.Ssh.ArcServer module in the PowerShell Gallery: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy. + +## EXAMPLES + +### Example 1: Connect to Azure Resource using AAD issued certificates +```powershell +Enter-AzVM -ResourceGroupName myRg -Name myMachine +``` + +When a -LocalUser is not supplied, the cmdlet will attempt to login using Azure AD. This is currently only supported for resources running Linux OS. + +### Example 2: Connect to Local User on Azure Resource using SSH certificates for authentication +```powershell +Enter-AzVM -ResourceGroupName myRg -Name myMachine -LocalUser azureuser -PrivateKeyFile ./id_rsa -CertificateFile ./cert +``` + +### Example 3: Connect to Local User on Azure Resource using SSH private key for authentication + +```powershell +Enter-AzVM -ResourceGroupName myRg -Name myMachine -LocalUser azureuser -PrivateKeyFile ./id_rsa +``` + +### Example 4: Connect to Local User on Azure Resource using interactive username and password authetication + +```powershell +Enter-AzVM -ResourceGroupName myRg -Name myMachine -LocalUser azureuser +``` + +### Example 5: Connect to the Public Ip of an Azure Virtual Machine using AAD issued certificates +```powershell +Enter-AzVM -Ip 1.2.3.4 +``` + +### Example 6: Provide the Resource Type of the target. +```powershell +Enter-AzVM -ResourceGroupName myRg -Name myMachine -ResourceType Microsoft.HybridCompute/machines +``` + +This parameter is useful when there is more than one supported resource with the same name in the Resource Group. + +### Example 7: Connect to Azure Resource using AAD certificate issued certificates and custom key files +```powershell +Enter-AzVM -ResourceGroupName myRg -Name myMachine -PrivateKeyFile ./id_rsa -PublicKeyFile ./id_rsa.pub +``` + +If custom key files are not provided, the cmdlet will generate the key pair. + +### Example 8: Start RDP connection over SSH connection. +```powershell +Enter-AzVM -ResourceGroupName myRg -Name myMachine -LocalUser username -Rdp +``` + +This parameter is useful for creating RDP session to an Arc resource via Arc Connectivity Platform. + +## PARAMETERS + +### -CertificateFile +SSH Certificate to be used to authenticate to local user account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +When connecting to Arc resources, do not prompt for confirmation before updating the allowed port for SSH connection in the Connection Endpoint to match the target port or to install Az.Ssh.ArcProxy module from the PowerShell Gallery, if needed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ip +IP Address of target Azure VM. + +```yaml +Type: System.String +Parameter Sets: IpAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalUser +Username for a local user in the target resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the target Azure Resource. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns true if connection is successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Port to connect to on the remote host. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateKeyFile +Path to private key file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicKeyFile +Path to public key file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rdp +Start a RDP connection over SSH connection. Only supported on Windows OS. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID of the target resource. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +Resource type of the target resource. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: +Accepted values: Microsoft.HybridCompute/machines, Microsoft.Compute/virtualMachines, Microsoft.ConnectedVMwarevSphere/virtualMachines, Microsoft.ScVmm/virtualMachines, Microsoft.AzureStackHCI/virtualMachines + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshArgument +Additional SSH arguments passed to OpenSSH. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePrivateIp +When connecting to an Azure VM, this flag specifies that it should connect to one of the private IPs of the VM. It requires connectivity to the private IP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Interactive, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.String[] + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[SSH Access to Arzure Arc-enabled servers](https://learn.microsoft.com/en-us/azure/azure-arc/servers/ssh-arc-overview?tabs=azure-cli) +[Troubleshoot SSH access to Azure Arc Enabled Servers](https://learn.microsoft.com/en-us/azure/azure-arc/servers/ssh-arc-troubleshoot) +[Login to a Linux VM by using Azure AD](https://learn.microsoft.com/en-us/azure/active-directory/devices/howto-vm-sign-in-azure-ad-linux) +[Install OpenSSH for Windows](https://learn.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse?tabs=gui) diff --git a/azps-10.1.0/Az.Ssh/Export-AzSshConfig.md b/azps-10.1.0/Az.Ssh/Export-AzSshConfig.md new file mode 100644 index 0000000000..c7204d7aee --- /dev/null +++ b/azps-10.1.0/Az.Ssh/Export-AzSshConfig.md @@ -0,0 +1,361 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Ssh.dll-Help.xml +Module Name: Az.Ssh +online version: https://learn.microsoft.com/powershell/module/az.ssh/export-azsshconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Ssh/Ssh/help/Export-AzSshConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Ssh/Ssh/help/Export-AzSshConfig.md +--- + +# Export-AzSshConfig + +## SYNOPSIS +This cmdlet exports an SSH configuration file that can be used to connect to Azure Resources through client applications that support OpenSSH config and certificates. SSH config files can be created that use AAD issued certificates or local user credentials. + +## SYNTAX + +### Interactive (Default) +``` +Export-AzSshConfig -ResourceGroupName <String> -Name <String> -ConfigFilePath <String> + [-PublicKeyFile <String>] [-PrivateKeyFile <String>] [-UsePrivateIp] [-LocalUser <String>] [-Port <String>] + [-ResourceType <String>] [-CertificateFile <String>] [-Overwrite] [-KeysDestinationFolder <String>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### IpAddress +``` +Export-AzSshConfig -Ip <String> -ConfigFilePath <String> [-PublicKeyFile <String>] [-PrivateKeyFile <String>] + [-LocalUser <String>] [-Port <String>] [-CertificateFile <String>] [-Overwrite] + [-KeysDestinationFolder <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ResourceId +``` +Export-AzSshConfig -ResourceId <String> -ConfigFilePath <String> [-PublicKeyFile <String>] + [-PrivateKeyFile <String>] [-UsePrivateIp] [-LocalUser <String>] [-Port <String>] [-CertificateFile <String>] + [-Overwrite] [-KeysDestinationFolder <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The exported SSH configuration file can be used to connect to Azure Resources by client applications that support OpenSSH config and certificates. Applications such as git and rsync can use configuration file by setting the command to 'ssh -F /path/to/config'. +For example: +rsync -e 'ssh -F /path/to/config'. +Users can create ssh config files that use AAD issued certificates or local user credentials. +Important note: When connecting to Azure Arc resources, this cmdlet requires the Az.Ssh.ArcProxy module to also be installed in the client machine. The cmdlet will attempt to install the module from the PowerShell Gallery, but the user also has the option to install it themselves. It is important that the user also has permission to execute the Proxy files in the Az.Ssh.ArcProxy module, or the connection will fail. You can find the Az.Ssh.ArcServer module in the PowerShell Gallery: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy. + +## EXAMPLES + +### Example 1: Export a SSH configuration file for connecting to a resource using AAD issued certificates for authentication. +```powershell +Export-AzSshConfig -ResourceGroupName myRg -Name myMachine -ConfigFilePath ./sshconfig.config +``` + +When a -LocalUser is not supplied, the cmdlet will attempt to create a certificate to login using Azure AD. This is currently only supported for resources running Linux OS. +When using Azure AD to login to resource, the Host name in the configuration entry will be "{resource group name}-{resource name}", or "{ip address}" for Azure VMs. + +### Example 2: Export a SSH configuration file for connecting to the Public Ip of an Azure Virtual Machine using AAD issued certificates. +```powershell +Export-AzSshConfig -Ip 1.2.3.4 -ConfigFilePath ./sshconfig.config +``` + +### Example 3: Export a SSH configuration file for connecting to Local User on Azure Resource using SSH certificates for authentication +```powershell +Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -CertificateFile ./cert -PrivateKeyFile ./id_rsa -ConfigFilePath ./sshconfig.config +``` + +When using local user credentials to login, the host name in the configuration entry will be "{resource group name}-{resource name}-{username}", or "{ip address}-{username}" for Azure VMs. + +### Example 4: Export a SSH configuration file for connecting to Local User on Azure Resource using SSH private key for authentication + +```powershell +Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -PrivateKeyFile ./id_rsa -ConfigFilePath ./sshconfig.config +``` + +### Example 5: Export a SSH configuration file for connecting to Local User on Azure Resource using interactive username and password for authentication + +```powershell +Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -ConfigFilePath ./sshconfig.config +``` + +### Example 6: Determine where generated keys and certificates for the certificate will the stored. +```powershell +Export-AzSshConfig -ResourceGroupName myRg -Name myVm -KeysDestinationFolder /home/user/mykeys -ConfigFilePath ./sshconfig.config +``` + +Generated keys and certificates are, by default, stored in "az_ssh_config" directory in the same directory as the config file. The -KeysDestinationFolder parameter allows user to decide where the keys will be stored. + +### Example 7: Create a generic config for use with any Azure VM. +```powershell +Export-AzSshConfig -Ip * -ConfigFilePath ./sshconfig.config +``` + +### Example 8: Provide the Resource Type of the target. +```powershell +Export-AzSshConfig -ResourceGroupName myRg -Name myVm -ResourceType Microsoft.Compute/virtualMachines -ConfigFilePath ./sshconfig.config +``` + +This parameter is useful when there is more than one supported resource with the same name in the Resource Group. + +## PARAMETERS + +### -CertificateFile +SSH Certificate to be used to authenticate to local user account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigFilePath +Path to write SSH configuration to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +When connecting to Arc resources, do not prompt for confirmation before updating the allowed port for SSH connection in the Connection Endpoint to match the target port or to install Az.Ssh.ArcProxy module from the PowerShell Gallery, if needed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ip +IP Address of target Azure VM. + +```yaml +Type: System.String +Parameter Sets: IpAddress +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeysDestinationFolder +Directory where generated keys and certificates will be stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalUser +Username for a local user in the target resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the target Azure Resource. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Overwrite +Overwrite the config file, instead of appending new entry to the end of the file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Port to connect to on the remote host. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateKeyFile +Path to private key file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicKeyFile +Path to public key file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Resource ID of the target resource. + +```yaml +Type: System.String +Parameter Sets: ResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceType +Resource type of the target resource. + +```yaml +Type: System.String +Parameter Sets: Interactive +Aliases: +Accepted values: Microsoft.HybridCompute/machines, Microsoft.Compute/virtualMachines, Microsoft.ConnectedVMwarevSphere/virtualMachines, Microsoft.ScVmm/virtualMachines, Microsoft.AzureStackHCI/virtualMachines + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsePrivateIp +When connecting to an Azure VM, this flag specifies that it should connect to one of the private IPs of the VM. It requires connectivity to the private IP. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Interactive, ResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Ssh.Models.PSSshConfigEntry + +## NOTES + +## RELATED LINKS + +[SSH Access to Arzure Arc-enabled servers](https://learn.microsoft.com/en-us/azure/azure-arc/servers/ssh-arc-overview?tabs=azure-cli) +[Troubleshoot SSH access to Azure Arc Enabled Servers](https://learn.microsoft.com/en-us/azure/azure-arc/servers/ssh-arc-troubleshoot) +[Login to a Linux VM by using Azure AD](https://learn.microsoft.com/en-us/azure/active-directory/devices/howto-vm-sign-in-azure-ad-linux) +[Install OpenSSH for Windows](https://learn.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse?tabs=gui) diff --git a/azps-10.1.0/Az.StackHCI/Add-AzStackHCIVMAttestation.md b/azps-10.1.0/Az.StackHCI/Add-AzStackHCIVMAttestation.md new file mode 100644 index 0000000000..573b2ab56a --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Add-AzStackHCIVMAttestation.md @@ -0,0 +1,188 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/add-azstackhcivmattestation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Add-AzStackHCIVMAttestation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Add-AzStackHCIVMAttestation.md +--- + +# Add-AzStackHCIVMAttestation + +## SYNOPSIS +Add-AzStackHCIVMAttestation configures guests for AzureStack HCI IMDS Attestation. + +## SYNTAX + +### VMName (Default) +``` +Add-AzStackHCIVMAttestation [-VMName] <String[]> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### AddAll +``` +Add-AzStackHCIVMAttestation -AddAll [-Force] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### VMObject +``` +Add-AzStackHCIVMAttestation [-VM] <Object[]> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Add-AzStackHCIVMAttestation configures guests for AzureStack HCI IMDS Attestation. + +## EXAMPLES + +### Example 1: +```powershell +Add-AzStackHCIVMAttestation -AddAll +``` + +```output +Name AttestationHost Status +---- --------------- ------ +183hcinode1 HCINODE2 Connected +bhat2 HCINODE2 Connected +ppnt3n1 HCINODE2 Connected +ppt3n0 HCINODE2 Connected +ppt5pn0 HCINODE2 Connected +ppt6pn0 HCINODE2 Connected +ppt7pn0 HCINODE2 Connected +``` + +Adding all guests on current node + +### Example 2: +```powershell +Invoke-Command -ScriptBlock {Add-AzStackHCIVMAttestation -VMName "bhat2", "ppt7pn0"} -ComputerName "HCINODE2" +``` + +```output +Name : bhat2 +AttestationHost : HCINODE2 +Status : Connected +PSComputerName : HCINODE2 +RunspaceId : 1ec3f1f5-832d-47d3-a5db-2a43ef3fdfdf + +Name : ppt7pn0 +AttestationHost : HCINODE2 +Status : Connected +PSComputerName : HCINODE2 +RunspaceId : 1ec3f1f5-832d-47d3-a5db-2a43ef3fdfdf +``` + +Invoking from the management node/WAC + +## PARAMETERS + +### -AddAll +Specifies a switch that will add all current guest VMs on host to IMDS Attestation on the current node. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AddAll +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +No confirmations. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +Specifies an array of VM objects from Get-VM. + +```yaml +Type: System.Object[] +Parameter Sets: VMObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMName +Specifies an array of guest VMs to enable. + +```yaml +Type: System.String[] +Parameter Sets: VMName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object[] + +### System.String[] + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Az.StackHCI.md b/azps-10.1.0/Az.StackHCI/Az.StackHCI.md new file mode 100644 index 0000000000..c2282faf56 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Az.StackHCI.md @@ -0,0 +1,88 @@ +--- +Module Name: Az.StackHCI +Module Guid: 7a80d748-b6f0-42d1-a08d-215c5a006769 +Download Help Link: https://learn.microsoft.com/powershell/module/az.stackhci +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Az.StackHCI.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Az.StackHCI.md +--- + +# Az.StackHCI Module +## Description +Microsoft Azure PowerShell: StackHci cmdlets + +## Az.StackHCI Cmdlets +### [Add-AzStackHCIVMAttestation](Add-AzStackHCIVMAttestation.md) +Add-AzStackHCIVMAttestation configures guests for AzureStack HCI IMDS Attestation. + +### [Disable-AzStackHCIAttestation](Disable-AzStackHCIAttestation.md) +Disable-AzStackHCIAttestation disables IMDS Attestation on the host + +### [Disable-AzStackHCIRemoteSupport](Disable-AzStackHCIRemoteSupport.md) +Disables Remote Support. + +### [Enable-AzStackHCIAttestation](Enable-AzStackHCIAttestation.md) +Enable-AzStackHCIAttestation configures the host and enables specified guests for IMDS attestation. + +### [Enable-AzStackHCIRemoteSupport](Enable-AzStackHCIRemoteSupport.md) +Enables Remote Support. + +### [Get-AzStackHciArcSetting](Get-AzStackHciArcSetting.md) +Get ArcSetting resource details of HCI Cluster. + +### [Get-AzStackHciCluster](Get-AzStackHciCluster.md) +Get HCI cluster. + +### [Get-AzStackHciExtension](Get-AzStackHciExtension.md) +Get particular Arc Extension of HCI Cluster. + +### [Get-AzStackHCIRemoteSupportAccess](Get-AzStackHCIRemoteSupportAccess.md) +Gets Remote Support Access. + +### [Get-AzStackHCIRemoteSupportSessionHistory](Get-AzStackHCIRemoteSupportSessionHistory.md) +Gets Remote Support Session History Details. + +### [Get-AzStackHCIVMAttestation](Get-AzStackHCIVMAttestation.md) +Get-AzStackHCIVMAttestation shows a list of guests added to IMDS Attestation on a node. + +### [Install-AzStackHCIRemoteSupport](Install-AzStackHCIRemoteSupport.md) +Installs Remote Support. + +### [New-AzStackHciArcSetting](New-AzStackHciArcSetting.md) +Create ArcSetting for HCI cluster. + +### [New-AzStackHciCluster](New-AzStackHciCluster.md) +Create an HCI cluster. + +### [New-AzStackHciExtension](New-AzStackHciExtension.md) +Create Extension for HCI cluster. + +### [Register-AzStackHCI](Register-AzStackHCI.md) +Register-AzStackHCI creates a Microsoft.AzureStackHCI cloud resource representing the on-premises cluster and registers the on-premises cluster with Azure. + +### [Remove-AzStackHciArcSetting](Remove-AzStackHciArcSetting.md) +Delete ArcSetting resource details of HCI Cluster. + +### [Remove-AzStackHciCluster](Remove-AzStackHciCluster.md) +Delete an HCI cluster. + +### [Remove-AzStackHciExtension](Remove-AzStackHciExtension.md) +Delete particular Arc Extension of HCI Cluster. + +### [Remove-AzStackHCIRemoteSupport](Remove-AzStackHCIRemoteSupport.md) +Removes Remote Support. + +### [Remove-AzStackHCIVMAttestation](Remove-AzStackHCIVMAttestation.md) +Remove-AzStackHCIVMAttestation removes guests from AzureStack HCI IMDS Attestation. + +### [Set-AzStackHCI](Set-AzStackHCI.md) +Set-AzStackHCI modifies resource properties of the Microsoft.AzureStackHCI cloud resource representing the on-premises cluster to enable or disable features. + +### [Unregister-AzStackHCI](Unregister-AzStackHCI.md) +Unregister-AzStackHCI deletes the Microsoft.AzureStackHCI cloud resource representing the on-premises cluster and unregisters the on-premises cluster with Azure. +The registered information available on the cluster is used to unregister the cluster if no parameters are passed. + +### [Update-AzStackHciCluster](Update-AzStackHciCluster.md) +Update an HCI cluster. + diff --git a/azps-10.1.0/Az.StackHCI/Disable-AzStackHCIAttestation.md b/azps-10.1.0/Az.StackHCI/Disable-AzStackHCIAttestation.md new file mode 100644 index 0000000000..ea426c21f2 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Disable-AzStackHCIAttestation.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/disable-azstackhciattestation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Disable-AzStackHCIAttestation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Disable-AzStackHCIAttestation.md +--- + +# Disable-AzStackHCIAttestation + +## SYNOPSIS +Disable-AzStackHCIAttestation disables IMDS Attestation on the host + +## SYNTAX + +``` +Disable-AzStackHCIAttestation [[-ComputerName] <String>] [-Credential <PSCredential>] [-Force] [-RemoveVM] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Disable-AzStackHCIAttestation disables IMDS Attestation on the host + +## EXAMPLES + +### Example 1: +```powershell +Disable-AzStackHCIAttestation -RemoveVM +``` + +```output +ComputerName Status Expiration +------------ ------ ---------- +HCINODE2 Inactive +``` + +Remove all guests from IMDS Attestation before disabling on cluster nodes. + +## PARAMETERS + +### -ComputerName +Specifies the AzureStack HCI host to perform the operation on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Specifies the credential for the ComputerName. +Default is the current user executing the Cmdlet. + +```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 +``` + +### -Force +No confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveVM +Specifies the guests on each node should be removed from IMDS Attestation before disabling on cluster. +Disable cannot continue before guests are removed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Disable-AzStackHCIRemoteSupport.md b/azps-10.1.0/Az.StackHCI/Disable-AzStackHCIRemoteSupport.md new file mode 100644 index 0000000000..036b8e5f0c --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Disable-AzStackHCIRemoteSupport.md @@ -0,0 +1,87 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/disable-azstackhciremotesupport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Disable-AzStackHCIRemoteSupport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Disable-AzStackHCIRemoteSupport.md +--- + +# Disable-AzStackHCIRemoteSupport + +## SYNOPSIS +Disables Remote Support. + +## SYNTAX + +``` +Disable-AzStackHCIRemoteSupport [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Disable Remote Support revokes all access levels previously granted. +Any existing support sessions will be terminated, and new sessions can no longer be established. + +## EXAMPLES + +### Example 1: +```powershell +Disable-AzStackHCIRemoteSupport +``` + +```output +Microsoft.AzureStack.Deployment.RemoteSupport is loaded already ... +Disabling Remote Support. +Remote Support successfully Disabled. +``` + +Disabling Remort support + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Enable-AzStackHCIAttestation.md b/azps-10.1.0/Az.StackHCI/Enable-AzStackHCIAttestation.md new file mode 100644 index 0000000000..c6178032ce --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Enable-AzStackHCIAttestation.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/enable-azstackhciattestation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Enable-AzStackHCIAttestation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Enable-AzStackHCIAttestation.md +--- + +# Enable-AzStackHCIAttestation + +## SYNOPSIS +Enable-AzStackHCIAttestation configures the host and enables specified guests for IMDS attestation. + +## SYNTAX + +``` +Enable-AzStackHCIAttestation [[-ComputerName] <String>] [-AddVM] [-Credential <PSCredential>] [-Force] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Enable-AzStackHCIAttestation configures the host and enables specified guests for IMDS attestation. + +## EXAMPLES + +### Example 1: +```powershell +Enable-AzStackHCIAttestation -AddVM +``` + +```output +ComputerName Status Expiration +------------ ------ ---------- +HCINODE2 Expired +``` + +Invoking on one of the cluster node. + +## PARAMETERS + +### -AddVM +After enabling each cluster node for Attestation, add all guests on each node. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Specifies the AzureStack HCI host to perform the operation on. +Note: this host should match the host of VMName. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Specifies the credential for the ComputerName. +Default is the current user executing the Cmdlet. + +```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 +``` + +### -Force +No confirmations. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Enable-AzStackHCIRemoteSupport.md b/azps-10.1.0/Az.StackHCI/Enable-AzStackHCIRemoteSupport.md new file mode 100644 index 0000000000..20bf035de4 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Enable-AzStackHCIRemoteSupport.md @@ -0,0 +1,184 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/enable-azstackhciremotesupport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Enable-AzStackHCIRemoteSupport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Enable-AzStackHCIRemoteSupport.md +--- + +# Enable-AzStackHCIRemoteSupport + +## SYNOPSIS +Enables Remote Support. + +## SYNTAX + +``` +Enable-AzStackHCIRemoteSupport [-AccessLevel] <String> [[-ExpireInMinutes] <Int32>] + [[-SasCredential] <String>] [-AgreeToRemoteSupportConsent] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Enables Remote Support allows authorized Microsoft Support users to remotely access the device for diagnostics or repair depending on the access level granted. + +## EXAMPLES + +### Example 1: +```powershell +Enable-AzStackHCIRemoteSupport -AccessLevel Diagnostics -ExpireInMinutes 1440 -SasCredential "Sample SAS" +``` + +```output +Proceed with enabling remote support? +[Y] Yes [N] No: Y + +Enabling Remote Support for 'Diagnostics' expiring in '1440' minutes. +Using provided SAS credential to make remote support connection. +Remote Support successfully Enabled. + + +State : Active +CreatedAt : 3/29/2022 10:29:19 AM +00:00 +UpdatedAt : 3/29/2022 10:29:19 AM +00:00 +TargetService : PowerShell +AccessLevel : Diagnostics +ExpiresAt : 3/30/2022 10:29:18 AM +00:00 +SasCredential : +``` + +Enable Remote Support on machine + +### Example 2: +```powershell +Enable-AzStackHCIRemoteSupport -AccessLevel DiagnosticsRepair -ExpireInMinutes 1440 -SasCredential "Sample SAS" -AgreeToRemoteSupportConsent +``` + +```output +Enabling Remote Support for 'Diagnostics' expiring in '1440' minutes. +Using provided SAS credential to make remote support connection. +Remote Support successfully Enabled. + + +State : Active +CreatedAt : 3/29/2022 10:29:19 AM +00:00 +UpdatedAt : 3/29/2022 10:29:53 AM +00:00 +TargetService : PowerShell +AccessLevel : Diagnostics +ExpiresAt : 3/30/2022 10:29:53 AM +00:00 +SasCredential : +``` + +Enable remort support by providing consent. +In this case, user is not prompted for consent + +## PARAMETERS + +### -AccessLevel +Controls the remote operations that can be performed. +This can be either Diagnostics or DiagnosticsAndRepair. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgreeToRemoteSupportConsent +Optional. +If set to true then records user consent as provided and proceeds without prompt. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpireInMinutes + + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SasCredential +Hybrid Connection SAS Credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Get-AzStackHCIRemoteSupportAccess.md b/azps-10.1.0/Az.StackHCI/Get-AzStackHCIRemoteSupportAccess.md new file mode 100644 index 0000000000..41ac8ea93e --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Get-AzStackHCIRemoteSupportAccess.md @@ -0,0 +1,120 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/get-azstackhciremotesupportaccess +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Get-AzStackHCIRemoteSupportAccess.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Get-AzStackHCIRemoteSupportAccess.md +--- + +# Get-AzStackHCIRemoteSupportAccess + +## SYNOPSIS +Gets Remote Support Access. + +## SYNTAX + +``` +Get-AzStackHCIRemoteSupportAccess [-Cluster] [-IncludeExpired] [<CommonParameters>] +``` + +## DESCRIPTION +Gets remote support access. + +## EXAMPLES + +### Example 1: +```powershell +Get-AzStackHCIRemoteSupportAccess -Cluster +``` + +```output +Microsoft.AzureStack.Deployment.RemoteSupport is loaded already ... +Getting RemoteSupport Access on this node +Retrieving Remote Support access. IncludeExpired is set to 'False' + + +State : Active +CreatedAt : 3/29/2022 10:30:55 AM +00:00 +UpdatedAt : 3/29/2022 10:30:55 AM +00:00 +TargetService : PowerShell +AccessLevel : Diagnostics +ExpiresAt : 3/30/2022 10:30:55 AM +00:00 +SasCredential : +``` + +Get remote access across a cluster + +### Example 2: +```powershell +Get-AzStackHCIRemoteSupportAccess -Cluster -IncludeExpired +``` + +```output +Microsoft.AzureStack.Deployment.RemoteSupport is loaded already ... +Getting RemoteSupport Access on this node +Retrieving Remote Support access. IncludeExpired is set to 'True' + + +State : Active +CreatedAt : 3/29/2022 10:30:55 AM +00:00 +UpdatedAt : 3/29/2022 10:30:55 AM +00:00 +TargetService : PowerShell +AccessLevel : Diagnostics +ExpiresAt : 3/30/2022 10:30:55 AM +00:00 +SasCredential : +``` + +Get remote access across a cluster with expired entries + +## PARAMETERS + +### -Cluster +Optional. +Defaults to false. +Indicates whether to show remote support sessions across cluster. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeExpired +Optional. +Defaults to false. +Indicates whether to include past expired entries. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Get-AzStackHCIRemoteSupportSessionHistory.md b/azps-10.1.0/Az.StackHCI/Get-AzStackHCIRemoteSupportSessionHistory.md new file mode 100644 index 0000000000..0c70514259 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Get-AzStackHCIRemoteSupportSessionHistory.md @@ -0,0 +1,108 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/get-azstackhciremotesupportsessionhistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Get-AzStackHCIRemoteSupportSessionHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Get-AzStackHCIRemoteSupportSessionHistory.md +--- + +# Get-AzStackHCIRemoteSupportSessionHistory + +## SYNOPSIS +Gets Remote Support Session History Details. + +## SYNTAX + +``` +Get-AzStackHCIRemoteSupportSessionHistory [[-SessionId] <String>] [[-FromDate] <DateTime>] + [-IncludeSessionTranscript] [<CommonParameters>] +``` + +## DESCRIPTION +Session history represents all remote accesses made by Microsoft Support for either Diagnostics or DiagnosticsRepair based on the Access Level granted. + +## EXAMPLES + +### Example 1: +```powershell +Get-AzStackHCIRemoteSupportSessionHistory +``` + +```output +Microsoft.AzureStack.Deployment.RemoteSupport is loaded already ... +Listing Session History for last '7' days. +No remote support session exists. +``` + +Gets Session Transcript for the particular session Id when access was made by Microsoft Support for either Diagnostics or DiagnosticsRepair based on the Access Level granted. + +## PARAMETERS + +### -FromDate +Optional. +Defaults to last 7 days. +Indicates date from where to start listing sessions from until now. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSessionTranscript +Optional. +Defaults to false. +Indicates whether to include complete session transcript. +Transcript provides details on all operations performed during the session. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionId +Optional. +Session Id to get details for a specific session. +If omitted then lists all sessions starting from date 'FromDate'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Get-AzStackHCIVMAttestation.md b/azps-10.1.0/Az.StackHCI/Get-AzStackHCIVMAttestation.md new file mode 100644 index 0000000000..03c09594c0 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Get-AzStackHCIVMAttestation.md @@ -0,0 +1,95 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/get-azstackhcivmattestation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Get-AzStackHCIVMAttestation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Get-AzStackHCIVMAttestation.md +--- + +# Get-AzStackHCIVMAttestation + +## SYNOPSIS +Get-AzStackHCIVMAttestation shows a list of guests added to IMDS Attestation on a node. + +## SYNTAX + +``` +Get-AzStackHCIVMAttestation [-Local] [<CommonParameters>] +``` + +## DESCRIPTION +Get-AzStackHCIVMAttestation shows a list of guests added to IMDS Attestation on a node. + +## EXAMPLES + +### Example 1: +```powershell +Get-AzStackHCIVMAttestation +``` + +```output +Name AttestationHost Status +---- --------------- ------ +183hcinode1 HCINODE2 Connected +bhat2 HCINODE2 Connected +ppnt3n1 HCINODE2 Connected +ppt3n0 HCINODE2 Connected +ppt5pn0 HCINODE2 Connected +ppt6pn0 HCINODE2 Connected +ppt7pn0 HCINODE2 Connected +``` + +Get all guests with IMDS Attestation on cluster. + +### Example 2: +```powershell +Get-AzStackHCIVMAttestation -Local +``` + +```output +Name AttestationHost Status +---- --------------- ------ +183hcinode1 HCINODE2 Connected +bhat2 HCINODE2 Connected +ppnt3n1 HCINODE2 Connected +ppt3n0 HCINODE2 Connected +ppt5pn0 HCINODE2 Connected +ppt6pn0 HCINODE2 Connected +ppt7pn0 HCINODE2 Connected +``` + +Gets guests with Attestation from the node executing the cmdlet. + +## PARAMETERS + +### -Local +Only retrieve guests with Attestation from the node executing the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Get-AzStackHciArcSetting.md b/azps-10.1.0/Az.StackHCI/Get-AzStackHciArcSetting.md new file mode 100644 index 0000000000..8b85059bf1 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Get-AzStackHciArcSetting.md @@ -0,0 +1,177 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/get-azstackhciarcsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Get-AzStackHciArcSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Get-AzStackHciArcSetting.md +--- + +# Get-AzStackHciArcSetting + +## SYNOPSIS +Get ArcSetting resource details of HCI Cluster. + +## SYNTAX + +### List (Default) +``` +Get-AzStackHciArcSetting -ClusterName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzStackHciArcSetting -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStackHciArcSetting -InputObject <IStackHciIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get ArcSetting resource details of HCI Cluster. + +## EXAMPLES + +### Example 1: +```powershell +Get-AzStackHciArcSetting -ResourceGroupName test-rg -ClusterName myCluster +``` + +```output +Name ResourceGroupName +---- ----------------- +default test-rg +``` + +Gets arcSettings in a cluster. +To see the details use : "Write-Host( $arcSettings | Format-List | Out-String)" + +## PARAMETERS + +### -ClusterName +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IStackHciIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the proxy resource holding details of HCI ArcSetting information. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ArcSettingName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IStackHciIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.Api20220501.IArcSetting + +## 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 <IStackHciIdentity>`: Identity Parameter + - `[ArcSettingName <String>]`: The name of the proxy resource holding details of HCI ArcSetting information. + - `[ClusterName <String>]`: The name of the cluster. + - `[ExtensionName <String>]`: The name of the machine extension. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Get-AzStackHciCluster.md b/azps-10.1.0/Az.StackHCI/Get-AzStackHciCluster.md new file mode 100644 index 0000000000..d1a0cca979 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Get-AzStackHciCluster.md @@ -0,0 +1,182 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/get-azstackhcicluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Get-AzStackHciCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Get-AzStackHciCluster.md +--- + +# Get-AzStackHciCluster + +## SYNOPSIS +Get HCI cluster. + +## SYNTAX + +### List (Default) +``` +Get-AzStackHciCluster [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzStackHciCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStackHciCluster -InputObject <IStackHciIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzStackHciCluster -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get HCI cluster. + +## EXAMPLES + +### Example 1: +```powershell +Get-AzStackHciCluster -ResourceGroupName test-rg +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus myCluster3 test-rg +eastus myCluster test-rg +westeurope myCluster2 test-rg +``` + +Gets all the clusters in a RG + +### Example 2: +```powershell +Get-AzStackHciCluster -ResourceGroupName test-rg -ClusterName myCluster +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus myCluster test-rg +``` + +Gets the details of a particular cluster. +To see the details use : "Write-Host( $cluster | Format-List | Out-String)" + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IStackHciIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IStackHciIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.Api20220501.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 <IStackHciIdentity>`: Identity Parameter + - `[ArcSettingName <String>]`: The name of the proxy resource holding details of HCI ArcSetting information. + - `[ClusterName <String>]`: The name of the cluster. + - `[ExtensionName <String>]`: The name of the machine extension. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Get-AzStackHciExtension.md b/azps-10.1.0/Az.StackHCI/Get-AzStackHciExtension.md new file mode 100644 index 0000000000..4fac0e2463 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Get-AzStackHciExtension.md @@ -0,0 +1,192 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/get-azstackhciextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Get-AzStackHciExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Get-AzStackHciExtension.md +--- + +# Get-AzStackHciExtension + +## SYNOPSIS +Get particular Arc Extension of HCI Cluster. + +## SYNTAX + +### List (Default) +``` +Get-AzStackHciExtension -ArcSettingName <String> -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzStackHciExtension -ArcSettingName <String> -ClusterName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStackHciExtension -InputObject <IStackHciIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get particular Arc Extension of HCI Cluster. + +## EXAMPLES + +### Example 1: +```powershell +Get-AzStackHciExtension -ResourceGroupName test-rg -ClusterName myCluster -ArcSettingName "default" +``` + +```output +Name ResourceGroupName +---- ----------------- +MicrosoftMonitoringAgent test-rg +``` + +Gets extensions in an arcSetting of a cluster. +To see the details use : "Write-Host( $extension | Format-List | Out-String)" + +## PARAMETERS + +### -ArcSettingName +The name of the proxy resource holding details of HCI ArcSetting information. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IStackHciIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the machine extension. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IStackHciIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.Api20220501.IExtension + +## 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 <IStackHciIdentity>`: Identity Parameter + - `[ArcSettingName <String>]`: The name of the proxy resource holding details of HCI ArcSetting information. + - `[ClusterName <String>]`: The name of the cluster. + - `[ExtensionName <String>]`: The name of the machine extension. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Install-AzStackHCIRemoteSupport.md b/azps-10.1.0/Az.StackHCI/Install-AzStackHCIRemoteSupport.md new file mode 100644 index 0000000000..d2e199c462 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Install-AzStackHCIRemoteSupport.md @@ -0,0 +1,99 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/install-azstackhciremotesupport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Install-AzStackHCIRemoteSupport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Install-AzStackHCIRemoteSupport.md +--- + +# Install-AzStackHCIRemoteSupport + +## SYNOPSIS +Installs Remote Support. + +## SYNTAX + +``` +Install-AzStackHCIRemoteSupport [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Install-AzStackHCIRemoteSupport installs Remote Support Deployment module. + +## EXAMPLES + +### Example 1: +```powershell +Install-AzStackHCIRemoteSupport +``` + +```output +Status Name DisplayName +------ ---- ----------- +Stopped RemoteSupportAgent Azure Stack Remote Support Agent + +Property : {} +PSPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\RemoteSupportAgent +PSParentPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft +PSChildName : RemoteSupportAgent +PSDrive : HKLM +PSProvider : Microsoft.PowerShell.Core\Registry +PSIsContainer : True +SubKeyCount : 0 +View : Default +Handle : Microsoft.Win32.SafeHandles.SafeRegistryHandle +ValueCount : 0 +Name : HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\RemoteSupportAgent +``` + +Installs Remort Support + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/New-AzStackHciArcSetting.md b/azps-10.1.0/Az.StackHCI/New-AzStackHciArcSetting.md new file mode 100644 index 0000000000..3d4bd369e7 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/New-AzStackHciArcSetting.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/new-azstackhciarcsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/New-AzStackHciArcSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/New-AzStackHciArcSetting.md +--- + +# New-AzStackHciArcSetting + +## SYNOPSIS +Create ArcSetting for HCI cluster. + +## SYNTAX + +``` +New-AzStackHciArcSetting -ClusterName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-ArcApplicationClientId <String>] [-ArcApplicationObjectId <String>] [-ArcApplicationTenantId <String>] + [-ArcInstanceResourceGroup <String>] [-ArcServicePrincipalObjectId <String>] [-ConnectivityProperty <IAny>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create ArcSetting for HCI cluster. + +## EXAMPLES + +### Example 1: +```powershell +New-AzStackHciArcSetting -ResourceGroupName "test-rg" -ClusterName "myCluster" +``` + +```output +Name ResourceGroupName +---- ----------------- +default test-rg +``` + +This command creates arcSetting for a HCI cluster. +The only arcSetting name allowed is "default" and that is provided by default. + +## PARAMETERS + +### -ArcApplicationClientId +App id of arc AAD identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArcApplicationObjectId +Object id of arc AAD identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArcApplicationTenantId +Tenant id of arc AAD identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArcInstanceResourceGroup +The resource group that hosts the Arc agents, ie. +Hybrid Compute Machine resources. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArcServicePrincipalObjectId +Object id of arc AAD service principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectivityProperty +contains connectivity related configuration for ARC resources + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IAny +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.Api20220501.IArcSetting + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/New-AzStackHciCluster.md b/azps-10.1.0/Az.StackHCI/New-AzStackHciCluster.md new file mode 100644 index 0000000000..455a264d19 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/New-AzStackHciCluster.md @@ -0,0 +1,302 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/new-azstackhcicluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/New-AzStackHciCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/New-AzStackHciCluster.md +--- + +# New-AzStackHciCluster + +## SYNOPSIS +Create an HCI cluster. + +## SYNTAX + +``` +New-AzStackHciCluster -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-AadApplicationObjectId <String>] [-AadClientId <String>] [-AadServicePrincipalObjectId <String>] + [-AadTenantId <String>] [-CloudManagementEndpoint <String>] + [-DesiredPropertyDiagnosticLevel <DiagnosticLevel>] + [-DesiredPropertyWindowsServerSubscription <WindowsServerSubscription>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create an HCI cluster. + +## EXAMPLES + +### Example 1: +```powershell +New-AzStackHciCluster -Name "myCluster" -ResourceGroupName "test-rg" -AadTenantId "c76bd4d1-bea3-45ea-be1b-4a745a675d07" -AadClientId "24a6e53d-04e5-44d2-b7cc-1b732a847dfc" -Location "eastus" +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus myCluster test-rg +``` + +This command creates a Stack HCI cluster + +### Example 2: +```powershell +New-AzStackHciCluster -Name "myCluster2" -ResourceGroupName "test-rg" -AadTenantId "c76bd4d1-bea3-45ea-be1b-4a745a675d07" -AadClientId "24a6e53d-04e5-44d2-b7cc-1b732a847dfc" -Location "westeurope" -DesiredPropertyDiagnosticLevel "Off" -DesiredPropertyWindowsServerSubscription "Enabled" +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +westeurope myCluster2 test-rg +``` + +This command creates a Stack HCI cluster with DiagnosticLevel = "Off" and WindowsServerSubscription = "Enabled". +By default, these values are set to "Basic" and "Disabled" respectively. + +## PARAMETERS + +### -AadApplicationObjectId +Object id of cluster AAD identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AadClientId +App id of cluster AAD identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AadServicePrincipalObjectId +Id of cluster identity service principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AadTenantId +Tenant id of cluster AAD identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudManagementEndpoint +Endpoint configured for management from the Azure portal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesiredPropertyDiagnosticLevel +Desired level of diagnostic data emitted by the cluster. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Support.DiagnosticLevel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesiredPropertyWindowsServerSubscription +Desired state of Windows Server Subscription. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Support.WindowsServerSubscription +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.Api20220501.ICluster + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/New-AzStackHciExtension.md b/azps-10.1.0/Az.StackHCI/New-AzStackHciExtension.md new file mode 100644 index 0000000000..d245818e32 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/New-AzStackHciExtension.md @@ -0,0 +1,333 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/new-azstackhciextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/New-AzStackHciExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/New-AzStackHciExtension.md +--- + +# New-AzStackHciExtension + +## SYNOPSIS +Create Extension for HCI cluster. + +## SYNTAX + +``` +New-AzStackHciExtension -ArcSettingName <String> -ClusterName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-ExtensionParameterAutoUpgradeMinorVersion] + [-ExtensionParameterForceUpdateTag <String>] [-ExtensionParameterProtectedSetting <Hashtable>] + [-ExtensionParameterPublisher <String>] [-ExtensionParameterSetting <Hashtable>] + [-ExtensionParameterType <String>] [-ExtensionParameterTypeHandlerVersion <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create Extension for HCI cluster. + +## EXAMPLES + +### Example 1: +```powershell +New-AzStackHciExtension -ArcSettingName "default" -ClusterName "myCluster" -Name "MicrosoftMonitoringAgent" -ResourceGroupName test-rg +``` + +```output +Name ResourceGroupName +---- ----------------- +MicrosoftMonitoringAgent test-rg +``` + +Creates a new arc extension. + +### Example 2: +```powershell +$Settings = @{ "commandToExecute" = "powershell.exe -c Get-Process" } +New-AzStackHciExtension -ArcSettingName "default" -ClusterName "myCluster" -Name "MicrosoftMonitoringAgent" -ResourceGroupName test-rg -ExtensionParameterPublisher "Microsoft.Compute" -ExtensionParameterType "MicrosoftMonitoringAgent" -ExtensionParameterProtectedSetting $Settings +``` + +```output +Name ResourceGroupName +---- ----------------- +MicrosoftMonitoringAgent test-rg +``` + +Creates new arc extension with the given parameters + +## PARAMETERS + +### -ArcSettingName +The name of the proxy resource holding details of HCI ArcSetting information. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionParameterAutoUpgradeMinorVersion +Indicates whether the extension should use a newer minor version if one is available at deployment time. +Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionParameterForceUpdateTag +How the extension handler should be forced to update even if the extension configuration has not changed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionParameterProtectedSetting +Protected settings (may contain secrets). + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionParameterPublisher +The name of the extension handler publisher. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionParameterSetting +Json formatted public settings for the extension. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionParameterType +Specifies the type of the extension; an example is "CustomScriptExtension". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtensionParameterTypeHandlerVersion +Specifies the version of the script handler. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the machine extension. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.Api20220501.IExtension + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Register-AzStackHCI.md b/azps-10.1.0/Az.StackHCI/Register-AzStackHCI.md new file mode 100644 index 0000000000..301521625e --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Register-AzStackHCI.md @@ -0,0 +1,407 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/register-azstackhci +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Register-AzStackHCI.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Register-AzStackHCI.md +--- + +# Register-AzStackHCI + +## SYNOPSIS +Register-AzStackHCI creates a Microsoft.AzureStackHCI cloud resource representing the on-premises cluster and registers the on-premises cluster with Azure. + +## SYNTAX + +``` +Register-AzStackHCI [-SubscriptionId] <String> [-Region] <String> [[-ResourceName] <String>] + [[-Tag] <Hashtable>] [[-TenantId] <String>] [[-ResourceGroupName] <String>] [[-ArmAccessToken] <String>] + [[-AccountId] <String>] [[-EnvironmentName] <String>] [[-ComputerName] <String>] + [[-CertificateThumbprint] <String>] [[-Credential] <PSCredential>] [[-ArcServerResourceGroupName] <String>] + [[-ArcSpnCredential] <PSCredential>] [-IsWAC] [-RepairRegistration] [-UseDeviceAuthentication] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Register-AzStackHCI creates a Microsoft.AzureStackHCI cloud resource representing the on-premises cluster and registers the on-premises cluster with Azure. + +## EXAMPLES + +### Example 1: +```powershell +Register-AzStackHCI -SubscriptionId "12a0f531-56cb-4340-9501-257726d741fd" -Region "eastus" +``` + +```output +Result: Success +ResourceId: /subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/DemoHCICluster1-rg/providers/Microsoft.AzureStackHCI/clusters/DemoHCICluster1 +PortalResourceURL: https://portal.azure.com/#@c31c0dbb-ce27-4c78-ad26-a5f717c14557/resource/subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/DemoHCICluster1-rg/providers/Microsoft.AzureStackHCI/clusters/DemoHCICluster1/overview +PortalAADAppPermissionsURL: https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationMenuBlade/CallAnAPI/appId/980be58d-578c-4cff-b4cd-43e9c3a77826/isMSAApp/ +``` + +Invoking on one of the cluster node. + +### Example 2: +```powershell +Register-AzStackHCI -SubscriptionId "12a0f531-56cb-4340-9501-257726d741fd" -ComputerName ClusterNode1 -Region "eastus" +``` + +```output +Result: Success +ResourceId: /subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/DemoHCICluster2-rg/providers/Microsoft.AzureStackHCI/clusters/DemoHCICluster2 +PortalResourceURL: https://portal.azure.com/#@c31c0dbb-ce27-4c78-ad26-a5f717c14557/resource/subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/DemoHCICluster2-rg/providers/Microsoft.AzureStackHCI/clusters/DemoHCICluster2/overview +PortalAADAppPermissionsURL: https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationMenuBlade/CallAnAPI/appId/950be58d-578c-4cff-b4cd-43e9c3a77866/isMSAApp/ +``` + +Invoking from the management node. + +### Example 3: +```powershell +Register-AzStackHCI -SubscriptionId "12a0f531-56cb-4340-9501-257726d741fd" -ArmAccessToken etyer..ere= -AccountId user1@corp1.com -Region westus -ResourceName DemoHCICluster3 -ResourceGroupName DemoHCIRG +``` + +```output +Result: PendingForAdminConsent +ResourceId: /subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/DemoHCIRG/providers/Microsoft.AzureStackHCI/clusters/DemoHCICluster3 +PortalResourceURL: https://portal.azure.com/#@c31c0dbb-ce27-4c78-ad26-a5f717c14557/resource/subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/DemoHCIRG/providers/Microsoft.AzureStackHCI/clusters/DemoHCICluster3/overview +PortalAADAppPermissionsURL: https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationMenuBlade/CallAnAPI/appId/980be58d-578c-4cff-b4cd-43e9c3a77866/isMSAApp/ +``` + +Invoking from WAC. + +### Example 4: +```powershell +Register-AzStackHCI -SubscriptionId "12a0f531-56cb-4340-9501-257726d741fd" -Region westus -ResourceName HciCluster1 -TenantId "c31c0dbb-ce27-4c78-ad26-a5f717c14557" -ResourceGroupName HciRG -ArcServerResourceGroupName HciRG -ArmAccessToken eerrer..ere= -AccountId user1@corp1.com -EnvironmentName AzureCloud -ComputerName node1hci -Credential Get-Credential +``` + +```output +Result: Success +ResourceId: /subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/HciRG/providers/Microsoft.AzureStackHCI/clusters/HciCluster1 +PortalResourceURL: https://portal.azure.com/#@c31c0dbb-ce27-4c78-ad26-a5f717c14557/resource/subscriptions/12a0f531-56cb-4340-9501-257726d741fd/resourceGroups/HciRG/providers/Microsoft.AzureStackHCI/clusters/HciCluster1/overview +PortalAADAppPermissionsURL: https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationMenuBlade/CallAnAPI/appId/990be58d-578c-4cff-b4cd-43e9c3a77866/isMSAApp/ +``` + +Invoking with all the parameters. + +## PARAMETERS + +### -AccountId +Specifies the Account Id. +Specifying this along with ArmAccessToken will avoid Azure interactive logon. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArcServerResourceGroupName +Specifies the Arc Resource Group name. +If not specified, cluster resource group name will be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArcSpnCredential +Specifies the credentials to be used for onboarding ARC agent. +If not specified, new set of credentials will be generated. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 13 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArmAccessToken +Specifies the ARM access token. +Specifying this along with AccountId will avoid Azure interactive logon. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateThumbprint +Specifies the thumbprint of the certificate available on all the nodes. +User is responsible for managing the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Specifies the cluster name or one of the cluster node in on-premise cluster that is being registered to Azure. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Specifies the credential for the ComputerName. +Default is the current user executing the Cmdlet. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +Specifies the Azure Environment. +Default is AzureCloud. +Valid values are AzureCloud, AzureChinaCloud, AzurePPE, AzureCanary, AzureUSGovernment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsWAC +Registrations through Windows Admin Center specifies this parameter to true. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Region +Specifies the Region to create the resource. +Region is a Mandatory parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepairRegistration +Repair the current Azure Stack HCI registration with the cloud. +This cmdlet deletes the local certificates on the clustered nodes and the remote certificates in the Azure AD application in the cloud and generates new replacement certificates for both. +The resource group, resource name, and other registration choices are preserved. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the Azure Resource Group name. +If not specified \<LocalClusterName\>-rg will be used as resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +Specifies the resource name of the resource created in Azure. +If not specified, on-premises cluster name is used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Specifies the Azure Subscription to create the resource. +SubscriptionId is a Mandatory parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specifies the resource tags for the resource in Azure in the form of key-value pairs in a hash table. +For example: @{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +Specifies the Azure TenantId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDeviceAuthentication +Use device code authentication instead of an interactive browser prompt. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### PSCustomObject. Returns following Properties in PSCustomObject +Result: Success or Failed or Cancelled. +ResourceId: Resource ID of the resource created in Azure. +PortalResourceURL: Azure Portal Resource URL. + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Remove-AzStackHCIRemoteSupport.md b/azps-10.1.0/Az.StackHCI/Remove-AzStackHCIRemoteSupport.md new file mode 100644 index 0000000000..b1497ac999 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Remove-AzStackHCIRemoteSupport.md @@ -0,0 +1,90 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/remove-azstackhciremotesupport +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Remove-AzStackHCIRemoteSupport.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Remove-AzStackHCIRemoteSupport.md +--- + +# Remove-AzStackHCIRemoteSupport + +## SYNOPSIS +Removes Remote Support. + +## SYNTAX + +``` +Remove-AzStackHCIRemoteSupport [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove-AzStackHCIRemoteSupport uninstalls Remote Support Deployment module. + +## EXAMPLES + +### Example 1: +```powershell +Remove-AzStackHCIRemoteSupport +``` + +```output +Microsoft.AzureStack.Deployment.RemoteSupport is loaded already ... +Removing remote support components. +Disabling Remote Support. +Remote Support successfully Disabled. +Uninstalling remote support agent. +[SC] DeleteService SUCCESS +Unregistering and removing JEA configs. +``` + +Removes Remote Support + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Remove-AzStackHCIVMAttestation.md b/azps-10.1.0/Az.StackHCI/Remove-AzStackHCIVMAttestation.md new file mode 100644 index 0000000000..c0d65dee5a --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Remove-AzStackHCIVMAttestation.md @@ -0,0 +1,167 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/remove-azstackhcivmattestation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Remove-AzStackHCIVMAttestation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Remove-AzStackHCIVMAttestation.md +--- + +# Remove-AzStackHCIVMAttestation + +## SYNOPSIS +Remove-AzStackHCIVMAttestation removes guests from AzureStack HCI IMDS Attestation. + +## SYNTAX + +### VMName (Default) +``` +Remove-AzStackHCIVMAttestation [-VMName] <String[]> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RemoveAll +``` +Remove-AzStackHCIVMAttestation -RemoveAll [-Force] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### VMObject +``` +Remove-AzStackHCIVMAttestation [-VM] <Object[]> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove-AzStackHCIVMAttestation removes guests from AzureStack HCI IMDS Attestation. + +## EXAMPLES + +### Example 1: +```powershell +Remove-AzStackHCIVMAttestation -RemoveAll +``` + +```output +Name AttestationHost Status +---- --------------- ------ +183hcinode1 HCINODE2 Disconnected +bhat2 HCINODE2 Disconnected +ppnt3n1 HCINODE2 Disconnected +ppt3n0 HCINODE2 Disconnected +ppt5pn0 HCINODE2 Disconnected +ppt6pn0 HCINODE2 Disconnected +ppt7pn0 HCINODE2 Disconnected +``` + +Removing all guests on current node + +## PARAMETERS + +### -Force +No confirmations. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAll +Specifies a switch that will remove all guest VMs from Attestation on the current node + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RemoveAll +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +Specifies an array of VM objects from Get-VM. + +```yaml +Type: System.Object[] +Parameter Sets: VMObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMName +Specifies an array of guest VMs to enable. + +```yaml +Type: System.String[] +Parameter Sets: VMName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object[] + +### System.String[] + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Remove-AzStackHciArcSetting.md b/azps-10.1.0/Az.StackHCI/Remove-AzStackHciArcSetting.md new file mode 100644 index 0000000000..5567dd6410 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Remove-AzStackHciArcSetting.md @@ -0,0 +1,242 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/remove-azstackhciarcsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Remove-AzStackHciArcSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Remove-AzStackHciArcSetting.md +--- + +# Remove-AzStackHciArcSetting + +## SYNOPSIS +Delete ArcSetting resource details of HCI Cluster. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStackHciArcSetting -ClusterName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStackHciArcSetting -InputObject <IStackHciIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete ArcSetting resource details of HCI Cluster. + +## EXAMPLES + +### Example 1: +```powershell +Remove-AzStackHciArcSetting -ResourceGroupName test-rg -ClusterName myCluster -Name default +``` + +Removes a particular arcSettings of a cluster. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IStackHciIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the proxy resource holding details of HCI ArcSetting information. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ArcSettingName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IStackHciIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IStackHciIdentity>`: Identity Parameter + - `[ArcSettingName <String>]`: The name of the proxy resource holding details of HCI ArcSetting information. + - `[ClusterName <String>]`: The name of the cluster. + - `[ExtensionName <String>]`: The name of the machine extension. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Remove-AzStackHciCluster.md b/azps-10.1.0/Az.StackHCI/Remove-AzStackHciCluster.md new file mode 100644 index 0000000000..e45ec8c8dd --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Remove-AzStackHciCluster.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/remove-azstackhcicluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Remove-AzStackHciCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Remove-AzStackHciCluster.md +--- + +# Remove-AzStackHciCluster + +## SYNOPSIS +Delete an HCI cluster. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStackHciCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStackHciCluster -InputObject <IStackHciIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete an HCI cluster. + +## EXAMPLES + +### Example 1: +```powershell +Remove-AzStackHciCluster -ResourceGroupName test-rg -Name myCluster2 +``` + +Removes a particular cluster. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IStackHciIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IStackHciIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IStackHciIdentity>`: Identity Parameter + - `[ArcSettingName <String>]`: The name of the proxy resource holding details of HCI ArcSetting information. + - `[ClusterName <String>]`: The name of the cluster. + - `[ExtensionName <String>]`: The name of the machine extension. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Remove-AzStackHciExtension.md b/azps-10.1.0/Az.StackHCI/Remove-AzStackHciExtension.md new file mode 100644 index 0000000000..30f3d2bc31 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Remove-AzStackHciExtension.md @@ -0,0 +1,264 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/remove-azstackhciextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Remove-AzStackHciExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Remove-AzStackHciExtension.md +--- + +# Remove-AzStackHciExtension + +## SYNOPSIS +Delete particular Arc Extension of HCI Cluster. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStackHciExtension -ArcSettingName <String> -ClusterName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStackHciExtension -InputObject <IStackHciIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete particular Arc Extension of HCI Cluster. + +## EXAMPLES + +### Example 1: +```powershell +Remove-AzStackHciExtension -ResourceGroupName test-rg -ClusterName myCluster -ArcSettingName "default" -Name MicrosoftMonitoringAgent +``` + +Removes a particular extension under arcSettings of a cluster. + +### Example 2: +```powershell +Get-AzStackHciExtension -ResourceGroupName test-rg -ClusterName myCluster -ArcSettingName "default" | Remove-AzStackHciExtension +``` + +Another way to remove all of the extensions under acrSettings of a cluster. + +## PARAMETERS + +### -ArcSettingName +The name of the proxy resource holding details of HCI ArcSetting information. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IStackHciIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the machine extension. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ExtensionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IStackHciIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IStackHciIdentity>`: Identity Parameter + - `[ArcSettingName <String>]`: The name of the proxy resource holding details of HCI ArcSetting information. + - `[ClusterName <String>]`: The name of the cluster. + - `[ExtensionName <String>]`: The name of the machine extension. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Set-AzStackHCI.md b/azps-10.1.0/Az.StackHCI/Set-AzStackHCI.md new file mode 100644 index 0000000000..3bb1f78295 --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Set-AzStackHCI.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/set-azstackhci +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Set-AzStackHCI.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Set-AzStackHCI.md +--- + +# Set-AzStackHCI + +## SYNOPSIS +Set-AzStackHCI modifies resource properties of the Microsoft.AzureStackHCI cloud resource representing the on-premises cluster to enable or disable features. + +## SYNTAX + +``` +Set-AzStackHCI [[-ComputerName] <String>] [-AccountId <String>] [-ArmAccessToken <String>] + [-Credential <PSCredential>] [-DiagnosticLevel <DiagnosticLevel>] [-EnableWSSubscription <Boolean>] + [-EnvironmentName <String>] [-Force] [-ResourceId <String>] [-TenantId <String>] [-UseDeviceAuthentication] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Set-AzStackHCI modifies resource properties of the Microsoft.AzureStackHCI cloud resource representing the on-premises cluster to enable or disable features. + +## EXAMPLES + +### Example 1: +```powershell +Set-AzStackHCI -EnableWSSubscription $true +``` + +```output +Result: Success +``` + +Invoking on one of the cluster node to enable Windows Server Subscription feature + +### Example 2: +```powershell +Set-AzStackHCI -ComputerName ClusterNode1 -DiagnosticLevel Basic +``` + +```output +Result: Success +``` + +Invoking from the management node to set the diagnostic level to Basic + +## PARAMETERS + +### -AccountId +Specifies the ARM access token. +Specifying this along with ArmAccessToken will avoid Azure interactive logon. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArmAccessToken +Specifies the ARM access token. +Specifying this along with AccountId will avoid Azure interactive logon. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Specifies one of the cluster node in on-premise cluster that is registered to Azure. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Specifies the credential for the ComputerName. +Default is the current user executing the Cmdlet. + +```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 +``` + +### -DiagnosticLevel +Specifies the diagnostic level for the cluster. + +```yaml +Type: DiagnosticLevel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableWSSubscription +Specifies if Windows Server Subscription should be enabled or disabled. +Enabling this feature starts billing through your Azure subscription for Windows Server guest licenses. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +Specifies the Azure Environment. +Default is AzureCloud. +Valid values are AzureCloud, AzureChinaCloud, AzurePPE, AzureCanary, AzureUSGovernment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Specifies the fully qualified resource ID, including the subscription, as in the following example: `/Subscriptions/`subscription ID`/providers/Microsoft.AzureStackHCI/clusters/MyCluster` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +Specifies the Azure TenantId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDeviceAuthentication +Use device code authentication instead of an interactive browser prompt. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Management.Automation.PSObject + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Unregister-AzStackHCI.md b/azps-10.1.0/Az.StackHCI/Unregister-AzStackHCI.md new file mode 100644 index 0000000000..85dbfde08e --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Unregister-AzStackHCI.md @@ -0,0 +1,325 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/unregister-azstackhci +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Unregister-AzStackHCI.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Unregister-AzStackHCI.md +--- + +# Unregister-AzStackHCI + +## SYNOPSIS +Unregister-AzStackHCI deletes the Microsoft.AzureStackHCI cloud resource representing the on-premises cluster and unregisters the on-premises cluster with Azure. +The registered information available on the cluster is used to unregister the cluster if no parameters are passed. + +## SYNTAX + +``` +Unregister-AzStackHCI [[-SubscriptionId] <String>] [[-ResourceName] <String>] [[-TenantId] <String>] + [[-ResourceGroupName] <String>] [[-ArmAccessToken] <String>] [[-AccountId] <String>] + [[-EnvironmentName] <String>] [[-Region] <String>] [[-ComputerName] <String>] [[-Credential] <PSCredential>] + [-DisableOnlyAzureArcServer] [-Force] [-UseDeviceAuthentication] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Unregister-AzStackHCI deletes the Microsoft.AzureStackHCI cloud resource representing the on-premises cluster and unregisters the on-premises cluster with Azure. +The registered information available on the cluster is used to unregister the cluster if no parameters are passed. + +## EXAMPLES + +### Example 1: +```powershell +Unregister-AzStackHCI +``` + +```output +Result: Success +``` + +Invoking on one of the cluster node + +### Example 2: +```powershell +Unregister-AzStackHCI -ComputerName ClusterNode1 +``` + +```output +Result: Success +``` + +Invoking from the management node + +### Example 3: +```powershell +Unregister-AzStackHCI -SubscriptionId "12a0f531-56cb-4340-9501-257726d741fd" -ArmAccessToken etyer..ere= -AccountId user1@corp1.com -ResourceName DemoHCICluster3 -ResourceGroupName DemoHCIRG -Confirm:$False +``` + +```output +Result: Success +``` + +Invoking from WAC + +### Example 4: +```powershell +Unregister-AzStackHCI -SubscriptionId "12a0f531-56cb-4340-9501-257726d741fd" -ResourceName HciCluster1 -TenantId "c31c0dbb-ce27-4c78-ad26-a5f717c14557" -ResourceGroupName HciClusterRG -ArmAccessToken eerrer..ere= -AccountId user1@corp1.com -EnvironmentName AzureCloud -ComputerName node1hci -Credential Get-Credential +``` + +```output +Result: Success +``` + +Invoking with all the parameters + +## PARAMETERS + +### -AccountId +Specifies the AccoundId. +Specifying this along with ArmAccessToken will avoid Azure interactive logon. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArmAccessToken +Specifies the ARM access token. +Specifying this along with AccountId will avoid Azure interactive logon. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Specifies one of the cluster node in on-premise cluster that is being registered to Azure. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Specifies the credential for the ComputerName. +Default is the current user executing the Cmdlet. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableOnlyAzureArcServer +Specifying this parameter to $true will only unregister the cluster nodes with Arc for servers and Azure Stack HCI registration will not be altered. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +Specifies the Azure Environment. +Default is AzureCloud. +Valid values are AzureCloud, AzureChinaCloud, AzurePPE, AzureCanary, AzureUSGovernment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies that unregistration should continue even if we could not delete the Arc extensions on the nodes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Region +Specifies the Region the resource is created in Azure. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the Azure Resource Group name. +If not specified \<LocalClusterName\>-rg will be used as resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +Specifies the resource name of the resource created in Azure. +If not specified, on-premises cluster name is used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Specifies the Azure Subscription to create the resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +Specifies the Azure TenantId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDeviceAuthentication +Use device code authentication instead of an interactive browser prompt. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### PSCustomObject. Returns following Properties in PSCustomObject +Result: Success or Failed or Cancelled. + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StackHCI/Update-AzStackHciCluster.md b/azps-10.1.0/Az.StackHCI/Update-AzStackHciCluster.md new file mode 100644 index 0000000000..55c8fe01aa --- /dev/null +++ b/azps-10.1.0/Az.StackHCI/Update-AzStackHciCluster.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: Az.StackHCI +online version: https://learn.microsoft.com/powershell/module/az.stackhci/update-azstackhcicluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Update-AzStackHciCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StackHCI/help/Update-AzStackHciCluster.md +--- + +# Update-AzStackHciCluster + +## SYNOPSIS +Update an HCI cluster. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStackHciCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AadTenantId <String>] [-CloudManagementEndpoint <String>] + [-DesiredPropertyDiagnosticLevel <DiagnosticLevel>] + [-DesiredPropertyWindowsServerSubscription <WindowsServerSubscription>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStackHciCluster -InputObject <IStackHciIdentity> [-AadTenantId <String>] + [-CloudManagementEndpoint <String>] [-DesiredPropertyDiagnosticLevel <DiagnosticLevel>] + [-DesiredPropertyWindowsServerSubscription <WindowsServerSubscription>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update an HCI cluster. + +## EXAMPLES + +### Example 1: +```powershell +Update-AzStackHciCluster -ResourceGroupName test-rg -Name myCluster3 -DesiredPropertyDiagnosticLevel Enhanced -DesiredPropertyWindowsServerSubscription Disabled +``` + +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus myCluster3 test-rg +``` + +Updating DiagnosticLevel and WindowsServerSubscription values for a cluster. + +## PARAMETERS + +### -AadTenantId +Tenant id of cluster AAD identity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudManagementEndpoint +Endpoint configured for management from the Azure portal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesiredPropertyDiagnosticLevel +Desired level of diagnostic data emitted by the cluster. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Support.DiagnosticLevel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesiredPropertyWindowsServerSubscription +Desired state of Windows Server Subscription. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Support.WindowsServerSubscription +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.StackHCI.Models.IStackHciIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IStackHciIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.Api20220501.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 <IStackHciIdentity>`: Identity Parameter + - `[ArcSettingName <String>]`: The name of the proxy resource holding details of HCI ArcSetting information. + - `[ClusterName <String>]`: The name of the cluster. + - `[ExtensionName <String>]`: The name of the machine extension. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Storage/Add-AzRmStorageContainerLegalHold.md b/azps-10.1.0/Az.Storage/Add-AzRmStorageContainerLegalHold.md new file mode 100644 index 0000000000..d5a8cb47eb --- /dev/null +++ b/azps-10.1.0/Az.Storage/Add-AzRmStorageContainerLegalHold.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/add-azrmstoragecontainerlegalhold +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Add-AzRmStorageContainerLegalHold.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Add-AzRmStorageContainerLegalHold.md +--- + +# Add-AzRmStorageContainerLegalHold + +## SYNOPSIS +Adds legal hold tags to a Storage blob container + +## SYNTAX + +### AccountName (Default) +``` +Add-AzRmStorageContainerLegalHold [-ResourceGroupName] <String> [-StorageAccountName] <String> -Name <String> + -Tag <String[]> [-AllowProtectedAppendWriteAll <Boolean>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Add-AzRmStorageContainerLegalHold -Name <String> -StorageAccount <PSStorageAccount> -Tag <String[]> + [-AllowProtectedAppendWriteAll <Boolean>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ContainerObject +``` +Add-AzRmStorageContainerLegalHold -Container <PSContainer> -Tag <String[]> + [-AllowProtectedAppendWriteAll <Boolean>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzRmStorageContainerLegalHold** cmdlet adds legal hold tags to a Storage blob container + +## EXAMPLES + +### Example 1: Add legal hold tags to a Storage blob container with Storage account name and container name +```powershell +Add-AzRmStorageContainerLegalHold -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Tag tag1,tag2 -AllowProtectedAppendWriteAll $true +``` + +This command adds legal hold tags to a Storage blob container with Storage account name and container name, and set AllowProtectedAppendWriteAll as true to allow append new blocks to append or block blob. + +### Example 2: Add legal hold tags to a Storage blob container with Storage account object and container name +```powershell +$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" +Add-AzRmStorageContainerLegalHold -StorageAccount $accountObject -ContainerName "myContainer" -Tag tag1 +``` + +This command adds legal hold tags to a Storage blob container with Storage account object and container name. + +### Example 3: Add legal hold tags to all Storage blob containers in a Storage account with pipeline +```powershell +Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" | Add-AzRmStorageContainerLegalHold -Tag tag1,tag2,tag3 +``` + +This command adds legal hold tags to all Storage blob containers in a Storage account with pipeline. + +## PARAMETERS + +### -AllowProtectedAppendWriteAll +When enabled, new blocks can be written to both 'Appened and Block Blobs' while maintaining immutability protection and compliance. +Only new blocks can be added and any existing blocks cannot be modified or deleted. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Storage container object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSContainer +Parameter Sets: ContainerObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container Name + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: N, ContainerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Container LegalHold Tags + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSLegalHold + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Add-AzStorageAccountManagementPolicyAction.md b/azps-10.1.0/Az.Storage/Add-AzStorageAccountManagementPolicyAction.md new file mode 100644 index 0000000000..fce7c90f2b --- /dev/null +++ b/azps-10.1.0/Az.Storage/Add-AzStorageAccountManagementPolicyAction.md @@ -0,0 +1,325 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/Az.storage/add-Azstorageaccountmanagementpolicyaction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Add-AzStorageAccountManagementPolicyAction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Add-AzStorageAccountManagementPolicyAction.md +--- + +# Add-AzStorageAccountManagementPolicyAction + +## SYNOPSIS +Adds an action to the input ManagementPolicy Action Group object, or creates a ManagementPolicy Action Group object with the action. The object can be used in New-AzStorageAccountManagementPolicyRule. + +## SYNTAX + +### BaseBlob (Default) +``` +Add-AzStorageAccountManagementPolicyAction -BaseBlobAction <String> -DaysAfterModificationGreaterThan <Int32> + [-DaysAfterLastTierChangeGreaterThan <Int32>] [-InputObject <PSManagementPolicyActionGroup>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### BaseBlobLastAccessTime +``` +Add-AzStorageAccountManagementPolicyAction -BaseBlobAction <String> -DaysAfterLastAccessTimeGreaterThan <Int32> + [-EnableAutoTierToHotFromCool] [-InputObject <PSManagementPolicyActionGroup>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### BaseBlobCreationTime +``` +Add-AzStorageAccountManagementPolicyAction -BaseBlobAction <String> -DaysAfterCreationGreaterThan <Int32> + [-InputObject <PSManagementPolicyActionGroup>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Snapshot +``` +Add-AzStorageAccountManagementPolicyAction -SnapshotAction <String> -DaysAfterCreationGreaterThan <Int32> + [-DaysAfterLastTierChangeGreaterThan <Int32>] [-InputObject <PSManagementPolicyActionGroup>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### BlobVersion +``` +Add-AzStorageAccountManagementPolicyAction -BlobVersionAction <String> -DaysAfterCreationGreaterThan <Int32> + [-DaysAfterLastTierChangeGreaterThan <Int32>] [-InputObject <PSManagementPolicyActionGroup>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzStorageAccountManagementPolicyAction** cmdlet adds an action to the input ManagementPolicy Action Group object, or creates a ManagementPolicy Action Group object with the action. + +## EXAMPLES + +### Example 1: Creates a ManagementPolicy Action Group object with 4 actions, then add it to a management policy rule and set to a Storage account +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\>$action = Add-AzStorageAccountManagementPolicyAction -BaseBlobAction Delete -DaysAfterCreationGreaterThan 100 +PS C:\>$action = Add-AzStorageAccountManagementPolicyAction -BaseBlobAction TierToArchive -daysAfterModificationGreaterThan 50 -DaysAfterLastTierChangeGreaterThan 40 -InputObject $action +PS C:\>$action = Add-AzStorageAccountManagementPolicyAction -BaseBlobAction TierToCool -DaysAfterLastAccessTimeGreaterThan 30 -EnableAutoTierToHotFromCool -InputObject $action +PS C:\>$action = Add-AzStorageAccountManagementPolicyAction -BaseBlobAction TierToHot -DaysAfterCreationGreaterThan 100 -InputObject $action +PS C:\>$action = Add-AzStorageAccountManagementPolicyAction -SnapshotAction Delete -daysAfterCreationGreaterThan 100 -InputObject $action +PS C:\>$action + +BaseBlob.TierToCool.DaysAfterModificationGreaterThan : +BaseBlob.TierToCool.DaysAfterLastAccessTimeGreaterThan : 30 +BaseBlob.TierToCool.DaysAfterCreationGreaterThan : +BaseBlob.EnableAutoTierToHotFromCool : True +BaseBlob.TierToArchive.DaysAfterModificationGreaterThan : 50 +BaseBlob.TierToArchive.DaysAfterLastAccessTimeGreaterThan : +BaseBlob.TierToArchive.DaysAfterCreationGreaterThan : +BaseBlob.TierToArchive.DaysAfterLastTierChangeGreaterThan : 40 +BaseBlob.Delete.DaysAfterModificationGreaterThan : +BaseBlob.Delete.DaysAfterLastAccessTimeGreaterThan : +BaseBlob.Delete.DaysAfterCreationGreaterThan : 100 +BaseBlob.TierToCold.DaysAfterModificationGreaterThan : +BaseBlob.TierToCold.DaysAfterLastAccessTimeGreaterThan : +BaseBlob.TierToCold.DaysAfterCreationGreaterThan : +BaseBlob.TierToHot.DaysAfterModificationGreaterThan : +BaseBlob.TierToHot.DaysAfterLastAccessTimeGreaterThan : +BaseBlob.TierToHot.DaysAfterCreationGreaterThan : 100 +Snapshot.TierToCool.DaysAfterCreationGreaterThan : +Snapshot.TierToArchive.DaysAfterCreationGreaterThan : +Snapshot.TierToArchive.DaysAfterLastTierChangeGreaterThan : +Snapshot.Delete.DaysAfterCreationGreaterThan : 100 +Snapshot.TierToCold.DaysAfterCreationGreaterThan : +Snapshot.TierToHot.DaysAfterCreationGreaterThan : +Version.TierToCool.DaysAfterCreationGreaterThan : +Version.TierToArchive.DaysAfterCreationGreaterThan : +Version.TierToArchive.DaysAfterLastTierChangeGreaterThan : +Version.Delete.DaysAfterCreationGreaterThan : +Version.TierToCold.DaysAfterCreationGreaterThan : +Version.TierToHot.DaysAfterCreationGreaterThan : + +PS C:\>$filter = New-AzStorageAccountManagementPolicyFilter +PS C:\>$rule = New-AzStorageAccountManagementPolicyRule -Name Test -Action $action -Filter $filter +PS C:\>$policy = Set-AzStorageAccountManagementPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -Rule $rule +``` + +The first command create a ManagementPolicy Action Group object, the following 3 commands add 3 actions to the object. Then add it to a management policy rule and set to a Storage account. + +### Example 2: Creates a ManagementPolicy Action Group object with 7 actions on snapshot and blob version, then add it to a management policy rule and set to a Storage account +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\> $action = Add-AzStorageAccountManagementPolicyAction -SnapshotAction Delete -daysAfterCreationGreaterThan 40 +PS C:\> $action = Add-AzStorageAccountManagementPolicyAction -InputObject $action -SnapshotAction TierToArchive -daysAfterCreationGreaterThan 50 +PS C:\> $action = Add-AzStorageAccountManagementPolicyAction -InputObject $action -SnapshotAction TierToCool -daysAfterCreationGreaterThan 60 +PS C:\> $action = Add-AzStorageAccountManagementPolicyAction -InputObject $action -BlobVersionAction Delete -daysAfterCreationGreaterThan 70 +PS C:\> $action = Add-AzStorageAccountManagementPolicyAction -InputObject $action -BlobVersionAction TierToArchive -daysAfterCreationGreaterThan 80 +PS C:\> $action = Add-AzStorageAccountManagementPolicyAction -InputObject $action -BlobVersionAction TierToCool -daysAfterCreationGreaterThan 90 +PS C:\> $action = Add-AzStorageAccountManagementPolicyAction -InputObject $action -BlobVersionAction TierToCold -daysAfterCreationGreaterThan 100 +PS C:\> $action + +BaseBlob.TierToCool.DaysAfterModificationGreaterThan : +BaseBlob.TierToCool.DaysAfterLastAccessTimeGreaterThan : +BaseBlob.TierToCool.DaysAfterCreationGreaterThan : +BaseBlob.EnableAutoTierToHotFromCool : +BaseBlob.TierToArchive.DaysAfterModificationGreaterThan : +BaseBlob.TierToArchive.DaysAfterLastAccessTimeGreaterThan : +BaseBlob.TierToArchive.DaysAfterCreationGreaterThan : +BaseBlob.TierToArchive.DaysAfterLastTierChangeGreaterThan : +BaseBlob.Delete.DaysAfterModificationGreaterThan : +BaseBlob.Delete.DaysAfterLastAccessTimeGreaterThan : +BaseBlob.Delete.DaysAfterCreationGreaterThan : +BaseBlob.TierToCold.DaysAfterModificationGreaterThan : +BaseBlob.TierToCold.DaysAfterLastAccessTimeGreaterThan : +BaseBlob.TierToCold.DaysAfterCreationGreaterThan : +BaseBlob.TierToHot.DaysAfterModificationGreaterThan : +BaseBlob.TierToHot.DaysAfterLastAccessTimeGreaterThan : +BaseBlob.TierToHot.DaysAfterCreationGreaterThan : +Snapshot.TierToCool.DaysAfterCreationGreaterThan : 60 +Snapshot.TierToArchive.DaysAfterCreationGreaterThan : 50 +Snapshot.TierToArchive.DaysAfterLastTierChangeGreaterThan : +Snapshot.Delete.DaysAfterCreationGreaterThan : 40 +Snapshot.TierToCold.DaysAfterCreationGreaterThan : +Snapshot.TierToHot.DaysAfterCreationGreaterThan : +Version.TierToCool.DaysAfterCreationGreaterThan : 90 +Version.TierToArchive.DaysAfterCreationGreaterThan : 80 +Version.TierToArchive.DaysAfterLastTierChangeGreaterThan : +Version.Delete.DaysAfterCreationGreaterThan : 70 +Version.TierToCold.DaysAfterCreationGreaterThan : 100 +Version.TierToHot.DaysAfterCreationGreaterThan : + +PS C:\>$filter = New-AzStorageAccountManagementPolicyFilter +PS C:\>$rule = New-AzStorageAccountManagementPolicyRule -Name Test -Action $action -Filter $filter +PS C:\>$policy = Set-AzStorageAccountManagementPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -Rule $rule +``` + +The first command create a ManagementPolicy Action Group object, the following 5 commands add 5 actions on snapshot and blob version to the object. Then add it to a management policy rule and set to a Storage account. + +## PARAMETERS + +### -BaseBlobAction +The management policy action for baseblob. + +```yaml +Type: System.String +Parameter Sets: BaseBlob, BaseBlobLastAccessTime, BaseBlobCreationTime +Aliases: +Accepted values: Delete, TierToArchive, TierToCool, TierToCold, TierToHot + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobVersionAction +The management policy action for blob version. + +```yaml +Type: System.String +Parameter Sets: BlobVersion +Aliases: +Accepted values: Delete, TierToArchive, TierToCool, TierToCold, TierToHot + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaysAfterCreationGreaterThan +Integer value indicating the age in days after creation. + +```yaml +Type: System.Int32 +Parameter Sets: BaseBlobCreationTime, Snapshot, BlobVersion +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaysAfterLastAccessTimeGreaterThan +Integer value indicating the age in days after last blob access. This property can only be used in conjuction with last access time tracking policy. + +```yaml +Type: System.Int32 +Parameter Sets: BaseBlobLastAccessTime +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaysAfterLastTierChangeGreaterThan +Integer value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions. It requires daysAfterModificationGreaterThan to be set for baseBlobs based actions, or daysAfterModificationGreaterThan to be set for snapshots and blob version based actions. + +```yaml +Type: System.Int32 +Parameter Sets: BaseBlob, Snapshot, BlobVersion +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DaysAfterModificationGreaterThan +Integer value indicating the age in days after last modification. + +```yaml +Type: System.Int32 +Parameter Sets: BaseBlob +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoTierToHotFromCool +Enables auto tiering of a blob from cool to hot on a blob access. It only works with TierToCool action and DaysAfterLastAccessTimeGreaterThan. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BaseBlobLastAccessTime +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +If input the ManagementPolicy Action object, will set the action to the input action object. +If not input, will create a new action object. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSManagementPolicyActionGroup +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SnapshotAction +The management policy action for snapshot. + +```yaml +Type: System.String +Parameter Sets: Snapshot +Aliases: +Accepted values: Delete, TierToArchive, TierToCool, TierToCold, TierToHot + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSManagementPolicyActionGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSManagementPolicyActionGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Add-AzStorageAccountNetworkRule.md b/azps-10.1.0/Az.Storage/Add-AzStorageAccountNetworkRule.md new file mode 100644 index 0000000000..714fb97ed6 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Add-AzStorageAccountNetworkRule.md @@ -0,0 +1,323 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/add-azstorageaccountnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Add-AzStorageAccountNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Add-AzStorageAccountNetworkRule.md +--- + +# Add-AzStorageAccountNetworkRule + +## SYNOPSIS + Add IpRules or VirtualNetworkRules to the NetworkRule property of a Storage account + +## SYNTAX + +### NetWorkRuleString (Default) +``` +Add-AzStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> + -VirtualNetworkResourceId <String[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### IpRuleObject +``` +Add-AzStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> -IPRule <PSIpRule[]> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NetworkRuleObject +``` +Add-AzStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> + -VirtualNetworkRule <PSVirtualNetworkRule[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceAccessRuleObject +``` +Add-AzStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> + -ResourceAccessRule <PSResourceAccessRule[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### IpRuleString +``` +Add-AzStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> -IPAddressOrRange <String[]> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceAccessRuleString +``` +Add-AzStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> -TenantId <String> + -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzStorageAccountNetworkRule** cmdlet adds IpRules or VirtualNetworkRules to the NetworkRule property of a Storage account + +## EXAMPLES + +### Example 1: Add several IpRules with IPAddressOrRange +```powershell +Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -IPAddressOrRange "10.0.0.0/7","28.2.0.0/16" +``` + +This command add several IpRules with IPAddressOrRange. + +### Example 2: Add a VirtualNetworkRule with VirtualNetworkResourceID +```powershell +$subnet = Get-AzVirtualNetwork -ResourceGroupName "myResourceGroup" -Name "myvirtualnetwork" | Get-AzVirtualNetworkSubnetConfig +Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -VirtualNetworkResourceId $subnet[0].Id +``` + +This command add a VirtualNetworkRule with VirtualNetworkResourceID. + +### Example 3: Add VirtualNetworkRules with VirtualNetworkRule Objects from another account +```powershell +$networkrule = Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount1" +Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount2" -VirtualNetworkRule $networkrule.VirtualNetworkRules +``` + +This command add VirtualNetworkRules with VirtualNetworkRule Objects from another account. + +### Example 4: Add several IpRule with IpRule objects, input with JSON +```powershell +Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -IPRule (@{IPAddressOrRange="10.0.0.0/7";Action="allow"},@{IPAddressOrRange="28.2.0.0/16";Action="allow"}) +``` + +This command add several IpRule with IpRule objects, input with JSON. + +### Example 5: Add a resource access rule +```powershell +Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -TenantId $tenantId -ResourceId $ResourceId +``` + +This command adds a resource access rule with TenantId and ResourceId. + +### Example 6: Add all resource access rules of one storage account to another storage account +```powershell +(Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount1").ResourceAccessRules | Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount2" +``` + +This command gets all resource access rules from one storage account, and adds them to another storage account. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressOrRange +The Array of IpAddressOrRange, add IpRules with the input IpAddressOrRange and default Action Allow to NetworkRule Property. + +```yaml +Type: System.String[] +Parameter Sets: IpRuleString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPRule +The Array of IpRule objects to add to the NetworkRule Property. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] +Parameter Sets: IpRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceAccessRule +Storage Account NetworkRule ResourceAccessRules. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSResourceAccessRule[] +Parameter Sets: ResourceAccessRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group contains the Storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Storage Account ResourceAccessRule ResourceId in string. + +```yaml +Type: System.String +Parameter Sets: ResourceAccessRuleString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantId +Storage Account ResourceAccessRule TenantId in string. + +```yaml +Type: System.String +Parameter Sets: ResourceAccessRuleString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkResourceId +The Array of VirtualNetworkResourceId, will add VirtualNetworkRule with input VirtualNetworkResourceId and default Action Allow to NetworkRule Property. + +```yaml +Type: System.String[] +Parameter Sets: NetWorkRuleString +Aliases: SubnetId, VirtualNetworkId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRule +The Array of VirtualNetworkRule objects to add to the NetworkRule Property. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] +Parameter Sets: NetworkRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] + +### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule + +### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Az.Storage.md b/azps-10.1.0/Az.Storage/Az.Storage.md new file mode 100644 index 0000000000..4213a7c998 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Az.Storage.md @@ -0,0 +1,513 @@ +--- +Module Name: Az.Storage +Module Guid: da67eaa7-4cb1-4bfa-a194-8bf3faae8ac5 +Download Help Link: https://learn.microsoft.com/powershell/module/az.storage +Help Version: 4.2.3.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Az.Storage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Az.Storage.md +--- + +# Az.Storage Module +## Description +This topic displays help topics for the Azure Storage Management Cmdlets. + +## Az.Storage Cmdlets +### [Add-AzRmStorageContainerLegalHold](Add-AzRmStorageContainerLegalHold.md) +Adds legal hold tags to a Storage blob container + +### [Add-AzStorageAccountManagementPolicyAction](Add-AzStorageAccountManagementPolicyAction.md) +Adds an action to the input ManagementPolicy Action Group object, or creates a ManagementPolicy Action Group object with the action. The object can be used in New-AzStorageAccountManagementPolicyRule. + +### [Add-AzStorageAccountNetworkRule](Add-AzStorageAccountNetworkRule.md) + Add IpRules or VirtualNetworkRules to the NetworkRule property of a Storage account + +### [Close-AzStorageFileHandle](Close-AzStorageFileHandle.md) +Closes file handles of a file share, a file directory or a file. + +### [Copy-AzStorageBlob](Copy-AzStorageBlob.md) +Copy a blob synchronously. + +### [Disable-AzStorageBlobDeleteRetentionPolicy](Disable-AzStorageBlobDeleteRetentionPolicy.md) +Disable delete retention policy for the Azure Storage Blob service. + +### [Disable-AzStorageBlobLastAccessTimeTracking](Disable-AzStorageBlobLastAccessTimeTracking.md) +Disable last access time tracking for the Azure Storage Blob service. + +### [Disable-AzStorageBlobRestorePolicy](Disable-AzStorageBlobRestorePolicy.md) +Disables Blob Restore Policy on a Storage account. + +### [Disable-AzStorageContainerDeleteRetentionPolicy](Disable-AzStorageContainerDeleteRetentionPolicy.md) +Disable delete retention policy for Azure Storage blob containers. + +### [Disable-AzStorageDeleteRetentionPolicy](Disable-AzStorageDeleteRetentionPolicy.md) +Disable delete retention policy for the Azure Storage Blob service. + +### [Disable-AzStorageStaticWebsite](Disable-AzStorageStaticWebsite.md) +Disable static website for the Azure Storage account. + +### [Enable-AzStorageBlobDeleteRetentionPolicy](Enable-AzStorageBlobDeleteRetentionPolicy.md) +Enable delete retention policy for the Azure Storage Blob service. + +### [Enable-AzStorageBlobLastAccessTimeTracking](Enable-AzStorageBlobLastAccessTimeTracking.md) +Enable last access time tracking for the Azure Storage Blob service. + +### [Enable-AzStorageBlobRestorePolicy](Enable-AzStorageBlobRestorePolicy.md) +Enables Blob Restore Policy on a Storage account. + +### [Enable-AzStorageContainerDeleteRetentionPolicy](Enable-AzStorageContainerDeleteRetentionPolicy.md) +Enable delete retention policy for Azure Storage blob containers. + +### [Enable-AzStorageDeleteRetentionPolicy](Enable-AzStorageDeleteRetentionPolicy.md) +Enable delete retention policy for the Azure Storage Blob service. + +### [Enable-AzStorageStaticWebsite](Enable-AzStorageStaticWebsite.md) +Enable static website for the Azure Storage account. + +### [Get-AzDataLakeGen2ChildItem](Get-AzDataLakeGen2ChildItem.md) +Lists sub directorys and files from a directory or filesystem root. + +### [Get-AzDataLakeGen2DeletedItem](Get-AzDataLakeGen2DeletedItem.md) +List all deleted files or directories from a directory or filesystem root. + +### [Get-AzDataLakeGen2Item](Get-AzDataLakeGen2Item.md) +Gets the details of a file or directory in a filesystem. + +### [Get-AzDataLakeGen2ItemContent](Get-AzDataLakeGen2ItemContent.md) +Download a file. + +### [Get-AzRmStorageContainer](Get-AzRmStorageContainer.md) +Gets or lists Storage blob containers + +### [Get-AzRmStorageContainerImmutabilityPolicy](Get-AzRmStorageContainerImmutabilityPolicy.md) +Gets ImmutabilityPolicy of a Storage blob containers + +### [Get-AzRmStorageShare](Get-AzRmStorageShare.md) +Gets or lists Storage file shares. + +### [Get-AzStorageAccount](Get-AzStorageAccount.md) +Gets a Storage account. + +### [Get-AzStorageAccountKey](Get-AzStorageAccountKey.md) +Gets the access keys for an Azure Storage account. + +### [Get-AzStorageLocalUser](Get-AzStorageLocalUser.md) +Gets a specified local user or lists all local users in a storage account. + +### [Get-AzStorageLocalUserKey](Get-AzStorageLocalUserKey.md) +Lists SSH authorized keys and shared key of a specified local user. + +### [Get-AzStorageAccountManagementPolicy](Get-AzStorageAccountManagementPolicy.md) +Gets the management policy of an Azure Storage account. + +### [Get-AzStorageAccountNameAvailability](Get-AzStorageAccountNameAvailability.md) +Checks the availability of a Storage account name. + +### [Get-AzStorageAccountNetworkRuleSet](Get-AzStorageAccountNetworkRuleSet.md) +Get the NetWorkRule property of a Storage account + +### [Get-AzStorageBlob](Get-AzStorageBlob.md) +Lists blobs in a container. + +### [Get-AzStorageBlobByTag](Get-AzStorageBlobByTag.md) +Lists blobs in a storage account across containers, with a blob tag filter sql expression. + +### [Get-AzStorageBlobContent](Get-AzStorageBlobContent.md) +Downloads a storage blob. + +### [Get-AzStorageBlobCopyState](Get-AzStorageBlobCopyState.md) +Gets the copy status of an Azure Storage blob. + +### [Get-AzStorageBlobInventoryPolicy](Get-AzStorageBlobInventoryPolicy.md) +Gets blob inventory policy from a Storage account. + +### [Get-AzStorageBlobQueryResult](Get-AzStorageBlobQueryResult.md) +Applies a simple Structured Query Language (SQL) statement on a blob's contents and save only the queried subset of the data to a local file. + +### [Get-AzStorageBlobServiceProperty](Get-AzStorageBlobServiceProperty.md) +Gets service properties for Azure Storage Blob services. + +### [Get-AzStorageBlobTag](Get-AzStorageBlobTag.md) +Get blob tags of a specific blob. + +### [Get-AzStorageContainer](Get-AzStorageContainer.md) +Lists the storage containers. + +### [Get-AzStorageContainerStoredAccessPolicy](Get-AzStorageContainerStoredAccessPolicy.md) +Gets the stored access policy or policies for an Azure storage container. + +### [Get-AzStorageCORSRule](Get-AzStorageCORSRule.md) +Gets CORS rules for a Storage service type. + +### [Get-AzStorageEncryptionScope](Get-AzStorageEncryptionScope.md) +Get or list encryption scopes from a Storage account. + +### [Get-AzStorageFile](Get-AzStorageFile.md) +Lists directories and files for a path. + +### [Get-AzStorageFileContent](Get-AzStorageFileContent.md) +Downloads the contents of a file. + +### [Get-AzStorageFileCopyState](Get-AzStorageFileCopyState.md) +Gets the state of a copy operation. + +### [Get-AzStorageFileHandle](Get-AzStorageFileHandle.md) +Lists file handles of a file share, a file directory or a file. + +### [Get-AzStorageFileServiceProperty](Get-AzStorageFileServiceProperty.md) +Gets service properties for Azure Storage File services. + +### [Get-AzStorageObjectReplicationPolicy](Get-AzStorageObjectReplicationPolicy.md) +Gets or lists object replication policy of a Storage account. + +### [Get-AzStorageQueue](Get-AzStorageQueue.md) +Lists storage queues. + +### [Get-AzStorageQueueStoredAccessPolicy](Get-AzStorageQueueStoredAccessPolicy.md) +Gets the stored access policy or policies for an Azure storage queue. + +### [Get-AzStorageServiceLoggingProperty](Get-AzStorageServiceLoggingProperty.md) +Gets logging properties for Azure Storage services. + +### [Get-AzStorageServiceMetricsProperty](Get-AzStorageServiceMetricsProperty.md) +Gets metrics properties for the Azure Storage service. + +### [Get-AzStorageServiceProperty](Get-AzStorageServiceProperty.md) +Gets properties for Azure Storage services. + +### [Get-AzStorageShare](Get-AzStorageShare.md) +Gets a list of file shares. + +### [Get-AzStorageShareStoredAccessPolicy](Get-AzStorageShareStoredAccessPolicy.md) +Gets stored access policies for a Storage share. + +### [Get-AzStorageTable](Get-AzStorageTable.md) +Lists the storage tables. + +### [Get-AzStorageTableStoredAccessPolicy](Get-AzStorageTableStoredAccessPolicy.md) +Gets the stored access policy or policies for an Azure storage table. + +### [Get-AzStorageUsage](Get-AzStorageUsage.md) +Gets the Storage resource usage of the current subscription. + +### [Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration](Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration.md) +Migrate an existing Storage blob containers to enable immutable Storage with versioning. + +### [Invoke-AzStorageAccountFailover](Invoke-AzStorageAccountFailover.md) +Invokes failover of a Storage account. + +### [Invoke-AzStorageAccountHierarchicalNamespaceUpgrade](Invoke-AzStorageAccountHierarchicalNamespaceUpgrade.md) +Validates if a storage account can be upgraded to enable HierarchicalNamespace, or upgrades a Storage account to enabled HierarchicalNamespace. + +### [Lock-AzRmStorageContainerImmutabilityPolicy](Lock-AzRmStorageContainerImmutabilityPolicy.md) +Locks ImmutabilityPolicy of a Storage blob containers + +### [Move-AzDataLakeGen2Item](Move-AzDataLakeGen2Item.md) +Move a file or directory to another a file or directory in same Storage account. + +### [New-AzDataLakeGen2Item](New-AzDataLakeGen2Item.md) +Create a file or directory in a filesystem. + +### [New-AzDataLakeGen2SasToken](New-AzDataLakeGen2SasToken.md) +Generates a SAS token for Azure DatalakeGen2 item. + +### [New-AzRmStorageContainer](New-AzRmStorageContainer.md) +Creates a Storage blob container + +### [New-AzRmStorageShare](New-AzRmStorageShare.md) +Creates a Storage file share. + +### [New-AzStorageAccount](New-AzStorageAccount.md) +Creates a Storage account. + +### [New-AzStorageAccountKey](New-AzStorageAccountKey.md) +Regenerates a storage key for an Azure Storage account. + +### [New-AzStorageAccountManagementPolicyBlobIndexMatchObject](New-AzStorageAccountManagementPolicyBlobIndexMatchObject.md) +Creates a ManagementPolicy BlobIndexMatch object, which can be used in New-AzStorageAccountManagementPolicyFilter. + +### [New-AzStorageLocalUserPermissionScope](New-AzStorageLocalUserPermissionScope.md) +Creates a permission scope object, which can be used in Set-AzStorageLocalUser. + +### [New-AzStorageLocalUserSshPassword](New-AzStorageLocalUserSshPassword.md) +Regenerate SSH password of a specified local user in a storage account. + +### [New-AzStorageLocalUserSshPublicKey](New-AzStorageLocalUserSshPublicKey.md) +Creates a SSH public key object, which can be used in Set-AzStorageLocalUser. + +### [New-AzStorageAccountManagementPolicyFilter](New-AzStorageAccountManagementPolicyFilter.md) +Creates a ManagementPolicy rule filter object, which can be used in New-AzStorageAccountManagementPolicyRule. + +### [New-AzStorageAccountManagementPolicyRule](New-AzStorageAccountManagementPolicyRule.md) +Creates a ManagementPolicy rule object, which can be used in Set-AzStorageAccountManagementPolicy. + +### [New-AzStorageAccountSASToken](New-AzStorageAccountSASToken.md) +Creates an account-level SAS token. + +### [New-AzStorageBlobInventoryPolicyRule](New-AzStorageBlobInventoryPolicyRule.md) +Creates a blob inventory policy rule object, which can be used in Set-AzStorageBlobInventoryPolicy. + +### [New-AzStorageBlobQueryConfig](New-AzStorageBlobQueryConfig.md) +Creates a blob query configuration object, which can be used in Get-AzStorageBlobQueryResult. + +### [New-AzStorageBlobRangeToRestore](New-AzStorageBlobRangeToRestore.md) +Creates a Blob Range object to restores a Storage account. + +### [New-AzStorageBlobSASToken](New-AzStorageBlobSASToken.md) +Generates a SAS token for an Azure storage blob. + +### [New-AzStorageContainer](New-AzStorageContainer.md) +Creates an Azure storage container. + +### [New-AzStorageContainerSASToken](New-AzStorageContainerSASToken.md) +Generates an SAS token for an Azure storage container. + +### [New-AzStorageContainerStoredAccessPolicy](New-AzStorageContainerStoredAccessPolicy.md) +Creates a stored access policy for an Azure storage container. + +### [New-AzStorageContext](New-AzStorageContext.md) +Creates an Azure Storage context. + +### [New-AzStorageDirectory](New-AzStorageDirectory.md) +Creates a directory. + +### [New-AzStorageEncryptionScope](New-AzStorageEncryptionScope.md) +Creates an encryption scope for a Storage account. + +### [New-AzStorageFileSASToken](New-AzStorageFileSASToken.md) +Generates a shared access signature token for a Storage file. + +### [New-AzStorageObjectReplicationPolicyRule](New-AzStorageObjectReplicationPolicyRule.md) +Creates an object replication policy rule. + +### [New-AzStorageQueue](New-AzStorageQueue.md) +Creates a storage queue. + +### [New-AzStorageQueueSASToken](New-AzStorageQueueSASToken.md) +Generates a shared access signature token for an Azure storage queue. + +### [New-AzStorageQueueStoredAccessPolicy](New-AzStorageQueueStoredAccessPolicy.md) +Creates a stored access policy for an Azure storage queue. + +### [New-AzStorageShare](New-AzStorageShare.md) +Creates a file share. + +### [New-AzStorageShareSASToken](New-AzStorageShareSASToken.md) +Generate Shared Access Signature token for Azure Storage share. + +### [New-AzStorageShareStoredAccessPolicy](New-AzStorageShareStoredAccessPolicy.md) +Creates a stored access policy on a Storage share. + +### [New-AzStorageTable](New-AzStorageTable.md) +Creates a storage table. + +### [New-AzStorageTableSASToken](New-AzStorageTableSASToken.md) +Generates an SAS token for an Azure Storage table. + +### [New-AzStorageTableStoredAccessPolicy](New-AzStorageTableStoredAccessPolicy.md) +Creates a stored access policy for an Azure storage table. + +### [Remove-AzDataLakeGen2AclRecursive](Remove-AzDataLakeGen2AclRecursive.md) +Remove ACL recursively on the specified path. + +### [Remove-AzDataLakeGen2Item](Remove-AzDataLakeGen2Item.md) +Remove a file or directory. + +### [Remove-AzRmStorageContainer](Remove-AzRmStorageContainer.md) +Removes a Storage blob container + +### [Remove-AzRmStorageContainerImmutabilityPolicy](Remove-AzRmStorageContainerImmutabilityPolicy.md) +Removes ImmutabilityPolicy of a Storage blob container with an unlocked policy + +### [Remove-AzRmStorageContainerLegalHold](Remove-AzRmStorageContainerLegalHold.md) +Removes legal hold tags from a Storage blob container + +### [Remove-AzRmStorageShare](Remove-AzRmStorageShare.md) +Removes a Storage file share. + +### [Remove-AzStorageAccount](Remove-AzStorageAccount.md) +Removes a Storage account from Azure. + +### [Remove-AzStorageLocalUser](Remove-AzStorageLocalUser.md) +Removes a specified local user in a storage account. + +### [Remove-AzStorageAccountManagementPolicy](Remove-AzStorageAccountManagementPolicy.md) +Removes the management policy of an Azure Storage account. + +### [Remove-AzStorageAccountNetworkRule](Remove-AzStorageAccountNetworkRule.md) +Remove IpRules or VirtualNetworkRules from the NetWorkRule property of a Storage account + +### [Remove-AzStorageBlob](Remove-AzStorageBlob.md) +Removes the specified storage blob. + +### [Remove-AzStorageBlobImmutabilityPolicy](Remove-AzStorageBlobImmutabilityPolicy.md) +Removes ImmutabilityPolicy of a Storage blob. + +### [Remove-AzStorageBlobInventoryPolicy](Remove-AzStorageBlobInventoryPolicy.md) +Removes blob inventory policy from a Storage account. + +### [Remove-AzStorageContainer](Remove-AzStorageContainer.md) +Removes the specified storage container. + +### [Remove-AzStorageContainerStoredAccessPolicy](Remove-AzStorageContainerStoredAccessPolicy.md) +Removes a stored access policy from an Azure storage container. + +### [Remove-AzStorageCORSRule](Remove-AzStorageCORSRule.md) +Removes CORS for a Storage service. + +### [Remove-AzStorageDirectory](Remove-AzStorageDirectory.md) +Deletes a directory. + +### [Remove-AzStorageFile](Remove-AzStorageFile.md) +Deletes a file. + +### [Remove-AzStorageObjectReplicationPolicy](Remove-AzStorageObjectReplicationPolicy.md) +Removes the specified object replication policy from a Storage account. + +### [Remove-AzStorageQueue](Remove-AzStorageQueue.md) +Removes a storage queue. + +### [Remove-AzStorageQueueStoredAccessPolicy](Remove-AzStorageQueueStoredAccessPolicy.md) +Removes a stored access policy from an Azure storage queue. + +### [Remove-AzStorageShare](Remove-AzStorageShare.md) +Deletes a file share. + +### [Remove-AzStorageShareStoredAccessPolicy](Remove-AzStorageShareStoredAccessPolicy.md) +Removes a stored access policy from a Storage share. + +### [Remove-AzStorageTable](Remove-AzStorageTable.md) +Removes a storage table. + +### [Remove-AzStorageTableStoredAccessPolicy](Remove-AzStorageTableStoredAccessPolicy.md) +Removes a stored access policy from an Azure storage table. + +### [Restore-AzDataLakeGen2DeletedItem](Restore-AzDataLakeGen2DeletedItem.md) +Restores a deleted file or directory in a filesystem. + +### [Restore-AzRmStorageShare](Restore-AzRmStorageShare.md) +Restores a deleted file share. + +### [Restore-AzStorageBlobRange](Restore-AzStorageBlobRange.md) +Restores a Storage account for specific blob ranges. + +### [Restore-AzStorageContainer](Restore-AzStorageContainer.md) +Restores a previously deleted Azure storage blob container. + +### [Revoke-AzStorageAccountUserDelegationKeys](Revoke-AzStorageAccountUserDelegationKeys.md) +Revoke all User Delegation keys of a Storage account. + +### [Set-AzCurrentStorageAccount](Set-AzCurrentStorageAccount.md) +Modifies the current Storage account of the specified subscription. + +### [Set-AzDataLakeGen2AclRecursive](Set-AzDataLakeGen2AclRecursive.md) +Set ACL recursively on the specified path. + +### [Set-AzDataLakeGen2ItemAclObject](Set-AzDataLakeGen2ItemAclObject.md) +Creates/Updates a DataLake gen2 item ACL object, which can be used in Update-AzDataLakeGen2Item cmdlet. + +### [Set-AzRmStorageContainerImmutabilityPolicy](Set-AzRmStorageContainerImmutabilityPolicy.md) +Creates or updates ImmutabilityPolicy of a Storage blob containers + +### [Set-AzStorageAccount](Set-AzStorageAccount.md) +Modifies a Storage account. + +### [Set-AzStorageLocalUser](Set-AzStorageLocalUser.md) +Creates or updates a specified local user in a storage account. + +### [Set-AzStorageAccountManagementPolicy](Set-AzStorageAccountManagementPolicy.md) +Creates or modifies the management policy of an Azure Storage account. + +### [Set-AzStorageBlobContent](Set-AzStorageBlobContent.md) +Uploads a local file to an Azure Storage blob. + +### [Set-AzStorageBlobImmutabilityPolicy](Set-AzStorageBlobImmutabilityPolicy.md) +Creates or updates ImmutabilityPolicy of a Storage blob. + +### [Set-AzStorageBlobInventoryPolicy](Set-AzStorageBlobInventoryPolicy.md) +Creates or updates blob inventory policy in a Storage account. + +### [Set-AzStorageBlobLegalHold](Set-AzStorageBlobLegalHold.md) +Enables or disables legal hold on a Storage blob. + +### [Set-AzStorageBlobTag](Set-AzStorageBlobTag.md) +Set blob tags of a specific blob. + +### [Set-AzStorageContainerAcl](Set-AzStorageContainerAcl.md) +Sets the public access permission to a storage container. + +### [Set-AzStorageContainerStoredAccessPolicy](Set-AzStorageContainerStoredAccessPolicy.md) +Sets a stored access policy for an Azure storage container. + +### [Set-AzStorageCORSRule](Set-AzStorageCORSRule.md) +Sets the CORS rules for a type of Storage service. + +### [Set-AzStorageFileContent](Set-AzStorageFileContent.md) +Uploads the contents of a file. + +### [Set-AzStorageObjectReplicationPolicy](Set-AzStorageObjectReplicationPolicy.md) +Creates or updates the specified object replication policy in a Storage account. + +### [Set-AzStorageQueueStoredAccessPolicy](Set-AzStorageQueueStoredAccessPolicy.md) +Sets a stored access policy for an Azure storage queue. + +### [Set-AzStorageServiceLoggingProperty](Set-AzStorageServiceLoggingProperty.md) +Modifies logging for Azure Storage services. + +### [Set-AzStorageServiceMetricsProperty](Set-AzStorageServiceMetricsProperty.md) +Modifies metrics properties for the Azure Storage service. + +### [Set-AzStorageShareQuota](Set-AzStorageShareQuota.md) +Sets the storage capacity for a share. + +### [Set-AzStorageShareStoredAccessPolicy](Set-AzStorageShareStoredAccessPolicy.md) +Updates a stored access policy on a Storage share. + +### [Set-AzStorageTableStoredAccessPolicy](Set-AzStorageTableStoredAccessPolicy.md) +Sets the stored access policy for an Azure storage table. + +### [Start-AzStorageBlobCopy](Start-AzStorageBlobCopy.md) +Starts to copy a blob. + +### [Start-AzStorageBlobIncrementalCopy](Start-AzStorageBlobIncrementalCopy.md) +Start an Incremental copy operation from a Page blob snapshot to the specified destination Page blob. + +### [Start-AzStorageFileCopy](Start-AzStorageFileCopy.md) +Starts to copy a source file. + +### [Stop-AzStorageAccountHierarchicalNamespaceUpgrade](Stop-AzStorageAccountHierarchicalNamespaceUpgrade.md) +Aborts an ongoing HierarchicalNamespace upgrade task on a storage account. + +### [Stop-AzStorageBlobCopy](Stop-AzStorageBlobCopy.md) +Stops a copy operation. + +### [Stop-AzStorageFileCopy](Stop-AzStorageFileCopy.md) +Stops a copy operation to the specified destination file. + +### [Update-AzDataLakeGen2AclRecursive](Update-AzDataLakeGen2AclRecursive.md) +Update ACL recursively on the specified path. + +### [Update-AzDataLakeGen2Item](Update-AzDataLakeGen2Item.md) +Update a file or directory on properties, metadata, permission, ACL, and owner. + +### [Update-AzRmStorageContainer](Update-AzRmStorageContainer.md) +Modifies a Storage blob container + +### [Update-AzRmStorageShare](Update-AzRmStorageShare.md) +Modifies a Storage file share. + +### [Update-AzStorageAccountNetworkRuleSet](Update-AzStorageAccountNetworkRuleSet.md) +Update the NetworkRule property of a Storage account + +### [Update-AzStorageBlobServiceProperty](Update-AzStorageBlobServiceProperty.md) +Modifies the service properties for the Azure Storage Blob service. + +### [Update-AzStorageEncryptionScope](Update-AzStorageEncryptionScope.md) +Modify an encryption scope for a Storage account. + +### [Update-AzStorageFileServiceProperty](Update-AzStorageFileServiceProperty.md) +Modifies the service properties for the Azure Storage File service. + +### [Update-AzStorageServiceProperty](Update-AzStorageServiceProperty.md) +Modifies the properties for the Azure Storage service. + diff --git a/azps-10.1.0/Az.Storage/Close-AzStorageFileHandle.md b/azps-10.1.0/Az.Storage/Close-AzStorageFileHandle.md new file mode 100644 index 0000000000..8e0c606a20 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Close-AzStorageFileHandle.md @@ -0,0 +1,378 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/close-azstoragefilehandle +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Close-AzStorageFileHandle.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Close-AzStorageFileHandle.md +--- + +# Close-AzStorageFileHandle + +## SYNOPSIS +Closes file handles of a file share, a file directory or a file. + +## SYNTAX + +### ShareNameCloseAll (Default) +``` +Close-AzStorageFileHandle [-ShareName] <String> [[-Path] <String>] [-Recursive] [-CloseAll] + [-Context <IStorageContext>] [-PassThru] [-AsJob] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ShareNameCloseSingle +``` +Close-AzStorageFileHandle [-ShareName] <String> -FileHandle <PSFileHandle> [-Context <IStorageContext>] + [-PassThru] [-AsJob] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ShareCloseAll +``` +Close-AzStorageFileHandle [-Share] <CloudFileShare> [[-Path] <String>] [-Recursive] [-CloseAll] [-PassThru] + [-AsJob] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ShareCloseSingle +``` +Close-AzStorageFileHandle [-Share] <CloudFileShare> -FileHandle <PSFileHandle> [-PassThru] [-AsJob] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DirectoryCloseAll +``` +Close-AzStorageFileHandle [-Directory] <CloudFileDirectory> [[-Path] <String>] [-Recursive] [-CloseAll] + [-PassThru] [-AsJob] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### FileCloseAll +``` +Close-AzStorageFileHandle [-File] <CloudFile> [-CloseAll] [-PassThru] [-AsJob] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Close-AzStorageFileHandle** cmdlet closes file handles of a file share, or file directory or a file. + +## EXAMPLES + +### Example 1: Close all file handles on a file +```powershell +Close-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2/test.txt' -CloseAll +``` + +This command closes all file handles on a file. + +### Example 2: Close all file handles which is opened 1 day ago on a file directory +```powershell +Get-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2' -Recursive | Where-Object {$_.OpenTime.DateTime.AddDays(1) -lt (Get-Date)} | Close-AzStorageFileHandle -ShareName "mysharename" +``` + +This command lists all file handles on a file directory recursively, filters out the handles which are opened 1 day ago, and then closes them. + +### Example 3: Close all file handles on a file directory recursively and show the closed file handle count +```powershell +Close-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2' -Recursive -CloseAll -PassThru +``` +```output +10 +``` + +This command closes all file handles on a file directory and shows the closed file handle count. + +### Example 4: Close all file handles on a file share +```powershell +Close-AzStorageFileHandle -ShareName "mysharename" -CloseAll -Recursive +``` + +This command closes all file handles on a specific file share recursively. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +The client side maximum execution time for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloseAll +Force close all File handles. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ShareNameCloseAll, ShareCloseAll, DirectoryCloseAll, FileCloseAll +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +The total amount of concurrent async tasks. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: ShareNameCloseAll, ShareNameCloseSingle +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Directory +CloudFileDirectory object indicated the base folder where the files/directories would be listed. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileDirectory +Parameter Sets: DirectoryCloseAll +Aliases: CloudFileDirectory + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -File +CloudFile object indicated the file to close handle. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFile +Parameter Sets: FileCloseAll +Aliases: CloudFile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -FileHandle +The File Handle to close. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSFileHandle +Parameter Sets: ShareNameCloseSingle, ShareCloseSingle +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Return the count of closed file handles. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Path to an existing file/directory. + +```yaml +Type: System.String +Parameter Sets: ShareNameCloseAll, ShareCloseAll, DirectoryCloseAll +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recursive +List handles Recursively. +Only works on File Directory. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ShareNameCloseAll, ShareCloseAll, DirectoryCloseAll +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +The server time out for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Share +CloudFileShare object indicated the share where the files/directories would be listed. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileShare +Parameter Sets: ShareCloseAll, ShareCloseSingle +Aliases: CloudFileShare + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareName +Name of the file share where the files/directories would be listed. + +```yaml +Type: System.String +Parameter Sets: ShareNameCloseAll, ShareNameCloseSingle +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Storage.File.CloudFileShare + +### Microsoft.Azure.Storage.File.CloudFileDirectory + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.Azure.Storage.File.CloseFileHandleResultSegment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Copy-AzStorageBlob.md b/azps-10.1.0/Az.Storage/Copy-AzStorageBlob.md new file mode 100644 index 0000000000..ac29eeadb2 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Copy-AzStorageBlob.md @@ -0,0 +1,401 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/copy-azstorageblob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Copy-AzStorageBlob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Copy-AzStorageBlob.md +--- + +# Copy-AzStorageBlob + +## SYNOPSIS +Copy a blob synchronously. + +## SYNTAX + +### ContainerName (Default) +``` +Copy-AzStorageBlob [-SrcBlob] <String> -SrcContainer <String> -DestContainer <String> [-DestBlob <String>] + [-DestBlobType <String>] [-StandardBlobTier <String>] [-RehydratePriority <RehydratePriority>] + [-EncryptionScope <String>] [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-Force] [-AsJob] + [-TagCondition <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobInstance +``` +Copy-AzStorageBlob [-BlobBaseClient <BlobBaseClient>] -DestContainer <String> [-DestBlob <String>] + [-DestBlobType <String>] [-StandardBlobTier <String>] [-RehydratePriority <RehydratePriority>] + [-EncryptionScope <String>] [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-Force] [-AsJob] + [-TagCondition <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UriPipeline +``` +Copy-AzStorageBlob -AbsoluteUri <String> -DestContainer <String> -DestBlob <String> [-DestBlobType <String>] + [-StandardBlobTier <String>] [-RehydratePriority <RehydratePriority>] [-EncryptionScope <String>] + [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-Force] [-AsJob] [-TagCondition <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Copy-AzStorageBlob** cmdlet copies a blob synchronously, currently only support block blob. + +## EXAMPLES + +### Example 1: Copy a named blob to another +```powershell +$destBlob = Copy-AzStorageBlob -SrcContainer "sourcecontainername" -SrcBlob "srcblobname" -DestContainer "destcontainername" -DestBlob "destblobname" +``` + +This command copies a blob from source container to the destination container with a new blob name. + +### Example 2: Copy blob from a blob object +```powershell +$srcBlob = Get-AzStorageBlob -Container $containerName -Blob $blobName -Context $ctx +$destBlob = $srcBlob | Copy-AzStorageBlob -DestContainer "destcontainername" -DestBlob "destblobname" +``` + +This command copies a blob from source blob object to the destination container with a new blob name. + +### Example 3: Copy blob from a blob Uri +```powershell +$srcBlobUri = New-AzStorageBlobSASToken -Container $srcContainerName -Blob $srcBlobName -Permission rt -ExpiryTime (Get-Date).AddDays(7) -FullUri +$destBlob = Copy-AzStorageBlob -AbsoluteUri $srcBlobUri -DestContainer "destcontainername" -DestBlob "destblobname" +``` + +The first command creates a blob Uri of the source blob, with sas token of permission "rt". The second command copies from source blob Uri to the destination blob. + +### Example 4: Update a block blob encryption scope +```powershell +$blob = Copy-AzStorageBlob -SrcContainer $containerName -SrcBlob $blobname -DestContainer $containername -EncryptionScope $newScopeName -Force +``` + +This command update a block blob encryption scope by copy it to itself with a new encryption scope. + +### Example 5: Copy a blob to a new append blob +```powershell +$srcBlob = Get-AzStorageBlob -Container $containerName -Blob $blobName -Context $ctx +$destBlob = Copy-AzStorageBlob -SrcContainer "sourcecontainername" -SrcBlob "srcblobname" -DestContainer "destcontainername" -DestBlob "destblobname" -DestBlobType "Append" -DestContext $destCtx +``` + +## PARAMETERS + +### -AbsoluteUri +Source blob uri + +```yaml +Type: System.String +Parameter Sets: UriPipeline +Aliases: SrcUri, SourceUri + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobBaseClient +BlobBaseClient Object + +```yaml +Type: Azure.Storage.Blobs.Specialized.BlobBaseClient +Parameter Sets: BlobInstance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Source Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: ContainerName, BlobInstance +Aliases: SrcContext, SourceContext + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: UriPipeline +Aliases: SrcContext, SourceContext + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestBlob +Destination blob name + +```yaml +Type: System.String +Parameter Sets: ContainerName, BlobInstance +Aliases: DestinationBlob + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: UriPipeline +Aliases: DestinationBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestBlobType +Destination blob type + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Block, Page, Append + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestContainer +Destination container name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DestinationContainer + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestContext +Destination Storage context object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: DestinationContext + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionScope +Encryption scope to be used when making requests to the dest blob. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force to overwrite the existing blob or file + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RehydratePriority +Block Blob RehydratePriority. +Indicates the priority with which to rehydrate an archived blob. +Valid values are High/Standard. + +```yaml +Type: Microsoft.Azure.Storage.Blob.RehydratePriority +Parameter Sets: (All) +Aliases: +Accepted values: Standard, High + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcBlob +Blob name + +```yaml +Type: System.String +Parameter Sets: ContainerName +Aliases: SourceBlob + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcContainer +Source Container name + +```yaml +Type: System.String +Parameter Sets: ContainerName +Aliases: SourceContainer + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StandardBlobTier +Block Blob Tier, valid values are Hot/Cool/Archive/Cold. +See detail in https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagCondition +Optional Tag expression statement to check match condition. The blob request will fail when the blob tags does not match the given expression.See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Azure.Storage.Blobs.Specialized.BlobBaseClient + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Disable-AzStorageBlobDeleteRetentionPolicy.md b/azps-10.1.0/Az.Storage/Disable-AzStorageBlobDeleteRetentionPolicy.md new file mode 100644 index 0000000000..0e754a74d4 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Disable-AzStorageBlobDeleteRetentionPolicy.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/disable-azstorageblobdeleteretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Disable-AzStorageBlobDeleteRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Disable-AzStorageBlobDeleteRetentionPolicy.md +--- + +# Disable-AzStorageBlobDeleteRetentionPolicy + +## SYNOPSIS +Disable delete retention policy for the Azure Storage Blob service. + +## SYNTAX + +### AccountName (Default) +``` +Disable-AzStorageBlobDeleteRetentionPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Disable-AzStorageBlobDeleteRetentionPolicy -StorageAccount <PSStorageAccount> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobServicePropertiesResourceId +``` +Disable-AzStorageBlobDeleteRetentionPolicy [-ResourceId] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzStorageBlobDeleteRetentionPolicy** cmdlet disables delete retention policy for the Azure Storage Blob service. + +## EXAMPLES + +### Example 1: Disable delete retention policy for the Blob services +```powershell +Disable-AzStorageBlobDeleteRetentionPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -PassThru +``` +```output +Enabled Days +------- ---- + False +``` + +This command disables delete retention policy for the Blob service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Display ServiceProperties + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a Storage account Resource Id, or a Blob service properties Resource Id. + +```yaml +Type: System.String +Parameter Sets: BlobServicePropertiesResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSDeleteRetentionPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Disable-AzStorageBlobLastAccessTimeTracking.md b/azps-10.1.0/Az.Storage/Disable-AzStorageBlobLastAccessTimeTracking.md new file mode 100644 index 0000000000..fe63d6de13 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Disable-AzStorageBlobLastAccessTimeTracking.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/disable-azstoragebloblastaccesstimetracking +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Disable-AzStorageBlobLastAccessTimeTracking.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Disable-AzStorageBlobLastAccessTimeTracking.md +--- + +# Disable-AzStorageBlobLastAccessTimeTracking + +## SYNOPSIS +Disable last access time tracking for the Azure Storage Blob service. + +## SYNTAX + +### AccountName (Default) +``` +Disable-AzStorageBlobLastAccessTimeTracking [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Disable-AzStorageBlobLastAccessTimeTracking -StorageAccount <PSStorageAccount> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzStorageBlobDeleteRetentionPolicy** cmdlet disables delete retention policy for the Azure Storage Blob service. + +## EXAMPLES + +### Example 1: Disable last access time tracking for the Blob service +```powershell +Disable-AzStorageBlobLastAccessTimeTracking -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" +``` + +This command disables last access time tracking for the Blob service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Display ServiceProperties + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSRestorePolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Disable-AzStorageBlobRestorePolicy.md b/azps-10.1.0/Az.Storage/Disable-AzStorageBlobRestorePolicy.md new file mode 100644 index 0000000000..bfcc6ba78b --- /dev/null +++ b/azps-10.1.0/Az.Storage/Disable-AzStorageBlobRestorePolicy.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/disable-azstorageblobrestorepolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Disable-AzStorageBlobRestorePolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Disable-AzStorageBlobRestorePolicy.md +--- + +# Disable-AzStorageBlobRestorePolicy + +## SYNOPSIS +Disables Blob Restore Policy on a Storage account. + +## SYNTAX + +### AccountName (Default) +``` +Disable-AzStorageBlobRestorePolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Disable-AzStorageBlobRestorePolicy -StorageAccount <PSStorageAccount> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobServicePropertiesResourceId +``` +Disable-AzStorageBlobRestorePolicy [-ResourceId] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzStorageBlobRestorePolicy** cmdlet disables Blob Restore Policy for the Azure Storage Blob service. + +## EXAMPLES + +### Example 1: Disables Blob Restore Policy for the Azure Storage Blob service on a Storage account +```powershell +Disable-AzStorageBlobRestorePolicy -ResourceGroupName "myresourcegoup" -StorageAccountName "mystorageaccount" +``` + +This command Disables Blob Restore Policy for the Azure Storage Blob service on a Storage account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Display ServiceProperties + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a Storage account Resource Id, or a Blob service properties Resource Id. + +```yaml +Type: System.String +Parameter Sets: BlobServicePropertiesResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSRestorePolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Disable-AzStorageContainerDeleteRetentionPolicy.md b/azps-10.1.0/Az.Storage/Disable-AzStorageContainerDeleteRetentionPolicy.md new file mode 100644 index 0000000000..22bdaf6dc2 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Disable-AzStorageContainerDeleteRetentionPolicy.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/disable-azstoragecontainerdeleteretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Disable-AzStorageContainerDeleteRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Disable-AzStorageContainerDeleteRetentionPolicy.md +--- + +# Disable-AzStorageContainerDeleteRetentionPolicy + +## SYNOPSIS +Disable delete retention policy for Azure Storage blob containers. + +## SYNTAX + +### AccountName (Default) +``` +Disable-AzStorageContainerDeleteRetentionPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Disable-AzStorageContainerDeleteRetentionPolicy -StorageAccount <PSStorageAccount> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobServicePropertiesResourceId +``` +Disable-AzStorageContainerDeleteRetentionPolicy [-ResourceId] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzStorageContainerDeleteRetentionPolicy** cmdlet disables delete retention policy for Azure Storage blob containers. + +## EXAMPLES + +### Example 1: Disable delete retention policy for blob containers +```powershell +Disable-AzStorageContainerDeleteRetentionPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -PassThru +``` + +```output +Enabled Days +------- ---- + False +``` + +This command disables delete retention policy for blob containers. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Display ServiceProperties + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a Storage account Resource Id, or a Blob service properties Resource Id. + +```yaml +Type: System.String +Parameter Sets: BlobServicePropertiesResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSDeleteRetentionPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Disable-AzStorageDeleteRetentionPolicy.md b/azps-10.1.0/Az.Storage/Disable-AzStorageDeleteRetentionPolicy.md new file mode 100644 index 0000000000..d40920d8b8 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Disable-AzStorageDeleteRetentionPolicy.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/disable-azstoragedeleteretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Disable-AzStorageDeleteRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Disable-AzStorageDeleteRetentionPolicy.md +--- + +# Disable-AzStorageDeleteRetentionPolicy + +## SYNOPSIS +Disable delete retention policy for the Azure Storage Blob service. + +## SYNTAX + +``` +Disable-AzStorageDeleteRetentionPolicy [-PassThru] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzStorageDeleteRetentionPolicy** cmdlet disables delete retention policy for the Azure Storage Blob service. + +## EXAMPLES + +### Example 1: Disable delete retention policy for the Blob service +```powershell +Disable-AzStorageDeleteRetentionPolicy +``` + +This command disables delete retention policy for the Blob service. + +## PARAMETERS + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Display DeleteRetentionPolicyProperties + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSDeleteRetentionPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Disable-AzStorageStaticWebsite.md b/azps-10.1.0/Az.Storage/Disable-AzStorageStaticWebsite.md new file mode 100644 index 0000000000..2d8cff0147 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Disable-AzStorageStaticWebsite.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/disable-azstoragestaticwebsite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Disable-AzStorageStaticWebsite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Disable-AzStorageStaticWebsite.md +--- + +# Disable-AzStorageStaticWebsite + +## SYNOPSIS +Disable static website for the Azure Storage account. + +## SYNTAX + +``` +Disable-AzStorageStaticWebsite [-PassThru] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzStorageStaticWebsite** cmdlet disables static website for the Azure Storage account. + +## EXAMPLES + +### Example 1: Disable static website for a Azure Storage account +```powershell +Disable-AzStorageStaticWebsite +``` + +This command disables static website for a Azure Storage account. + +## PARAMETERS + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSStaticWebsiteProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Enable-AzStorageBlobDeleteRetentionPolicy.md b/azps-10.1.0/Az.Storage/Enable-AzStorageBlobDeleteRetentionPolicy.md new file mode 100644 index 0000000000..99616a5017 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Enable-AzStorageBlobDeleteRetentionPolicy.md @@ -0,0 +1,222 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/enable-azstorageblobdeleteretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Enable-AzStorageBlobDeleteRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Enable-AzStorageBlobDeleteRetentionPolicy.md +--- + +# Enable-AzStorageBlobDeleteRetentionPolicy + +## SYNOPSIS +Enable delete retention policy for the Azure Storage Blob service. + +## SYNTAX + +### AccountName (Default) +``` +Enable-AzStorageBlobDeleteRetentionPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -RetentionDays <Int32> [-PassThru] [-AllowPermanentDelete] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Enable-AzStorageBlobDeleteRetentionPolicy -StorageAccount <PSStorageAccount> -RetentionDays <Int32> [-PassThru] + [-AllowPermanentDelete] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobServicePropertiesResourceId +``` +Enable-AzStorageBlobDeleteRetentionPolicy [-ResourceId] <String> -RetentionDays <Int32> [-PassThru] + [-AllowPermanentDelete] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzStorageBlobDeleteRetentionPolicy** cmdlet enables delete retention policy for the Azure Storage Blob service. + +## EXAMPLES + +### Example 1: Enable delete retention policy for the Blob service +```powershell +Enable-AzStorageBlobDeleteRetentionPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -AllowPermanentDelete -PassThru -RetentionDays 4 +``` + +```output +Enabled Days AllowPermanentDelete +------- ---- -------------------- + True 4 True +``` + +This command enables delete retention policy for the Blob service, and set deleted blob retention days to 4. + +## PARAMETERS + +### -AllowPermanentDelete +Allow deletion of the soft deleted blob versions and snapshots. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Display ServiceProperties + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a Storage account Resource Id, or a Blob service properties Resource Id. + +```yaml +Type: System.String +Parameter Sets: BlobServicePropertiesResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionDays +Sets the number of retention days for the DeleteRetentionPolicy. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Days + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSBlobServiceProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Enable-AzStorageBlobLastAccessTimeTracking.md b/azps-10.1.0/Az.Storage/Enable-AzStorageBlobLastAccessTimeTracking.md new file mode 100644 index 0000000000..59f348858a --- /dev/null +++ b/azps-10.1.0/Az.Storage/Enable-AzStorageBlobLastAccessTimeTracking.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/enable-azstoragebloblastaccesstimetracking +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Enable-AzStorageBlobLastAccessTimeTracking.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Enable-AzStorageBlobLastAccessTimeTracking.md +--- + +# Enable-AzStorageBlobLastAccessTimeTracking + +## SYNOPSIS +Enable last access time tracking for the Azure Storage Blob service. + +## SYNTAX + +### AccountName (Default) +``` +Enable-AzStorageBlobLastAccessTimeTracking [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Enable-AzStorageBlobLastAccessTimeTracking -StorageAccount <PSStorageAccount> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzStorageBlobLastAccessTimeTracking** cmdlet enables last access time tracking for the Azure Storage Blob service. + +## EXAMPLES + +### Example 1: Enable last access time tracking for the Blob service +```powershell +Enable-AzStorageBlobLastAccessTimeTracking -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -PassThru +``` +```output +Enable Name TrackingGranularityInDays BlobType +------ ---- ------------------------- -------- + True AccessTimeTracking 1 {blockBlob} +``` + +This command enables last access time tracking for the Blob service, and show the last access time tracking policy properties. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Display ServiceProperties + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSRestorePolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Enable-AzStorageBlobRestorePolicy.md b/azps-10.1.0/Az.Storage/Enable-AzStorageBlobRestorePolicy.md new file mode 100644 index 0000000000..08d998191d --- /dev/null +++ b/azps-10.1.0/Az.Storage/Enable-AzStorageBlobRestorePolicy.md @@ -0,0 +1,233 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/enable-azstorageblobrestorepolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Enable-AzStorageBlobRestorePolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Enable-AzStorageBlobRestorePolicy.md +--- + +# Enable-AzStorageBlobRestorePolicy + +## SYNOPSIS +Enables Blob Restore Policy on a Storage account. + +## SYNTAX + +### AccountName (Default) +``` +Enable-AzStorageBlobRestorePolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -RestoreDays <Int32> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountObject +``` +Enable-AzStorageBlobRestorePolicy -StorageAccount <PSStorageAccount> -RestoreDays <Int32> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobServicePropertiesResourceId +``` +Enable-AzStorageBlobRestorePolicy [-ResourceId] <String> -RestoreDays <Int32> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzStorageBlobRestorePolicy** cmdlet enables Blob Restore Policy for the Azure Storage Blob service. + +## EXAMPLES + +### Example 1: Enables Blob Restore Policy for the Azure Storage Blob service on a Storage account +<!-- Skip: Output cannot be splitted from code --> +```powershell +PS C:\> Enable-AzStorageBlobDeleteRetentionPolicy -ResourceGroupName "myresourcegoup" -StorageAccountName "mystorageaccount" -RetentionDays 5 + +PS C:\> Update-AzStorageBlobServiceProperty -ResourceGroupName "myresourcegoup" -StorageAccountName "mystorageaccount" -EnableChangeFeed $true + +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegoup +DefaultServiceVersion : +DeleteRetentionPolicy.Enabled : True +DeleteRetentionPolicy.Days : 5 +RestorePolicy.Enabled : False +RestorePolicy.Days : +RestorePolicy.MinRestoreTime : +ChangeFeed : True +IsVersioningEnabled : True + +PS C:\> Enable-AzStorageBlobRestorePolicy -ResourceGroupName "myresourcegoup" -StorageAccountName "mystorageaccount" -RestoreDays 4 + +PS C:\> Get-AzStorageBlobServiceProperty -ResourceGroupName "myresourcegoup" -StorageAccountName "mystorageaccount" + +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegoup +DefaultServiceVersion : +DeleteRetentionPolicy.Enabled : True +DeleteRetentionPolicy.Days : 5 +RestorePolicy.Enabled : True +RestorePolicy.Days : 4 +RestorePolicy.MinRestoreTime : 8/28/2020 6:00:59 AM +ChangeFeed : True +IsVersioningEnabled : True +``` + +This command first enable Blob softdelete and changefeed, then enables Blob Restore Policy, finally check the setting in Blob service properties. +The Blob service RestorePolicy.Days must be smaller than DeleteRetentionPolicy.Days. +Blob softdelete and ChangeFeed must be enabled before enable blob Restore Policy. +If softdelete and Changefeed are just enabled, might need wait for some time for server to handle the setting, before enable Blob restore policy. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Display ServiceProperties + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a Storage account Resource Id, or a Blob service properties Resource Id. + +```yaml +Type: System.String +Parameter Sets: BlobServicePropertiesResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestoreDays +Sets the number of days for the blob can be restored.. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Days + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSRestorePolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Enable-AzStorageContainerDeleteRetentionPolicy.md b/azps-10.1.0/Az.Storage/Enable-AzStorageContainerDeleteRetentionPolicy.md new file mode 100644 index 0000000000..8a35988874 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Enable-AzStorageContainerDeleteRetentionPolicy.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/enable-azstoragecontainerdeleteretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Enable-AzStorageContainerDeleteRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Enable-AzStorageContainerDeleteRetentionPolicy.md +--- + +# Enable-AzStorageContainerDeleteRetentionPolicy + +## SYNOPSIS +Enable delete retention policy for Azure Storage blob containers. + +## SYNTAX + +### AccountName (Default) +``` +Enable-AzStorageContainerDeleteRetentionPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -RetentionDays <Int32> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountObject +``` +Enable-AzStorageContainerDeleteRetentionPolicy -StorageAccount <PSStorageAccount> -RetentionDays <Int32> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobServicePropertiesResourceId +``` +Enable-AzStorageContainerDeleteRetentionPolicy [-ResourceId] <String> -RetentionDays <Int32> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzStorageContainerDeleteRetentionPolicy** cmdlet enables delete retention policy for Azure Storage blob containers. + +## EXAMPLES + +### Example 1: Enable delete retention policy for Blob containers +```powershell +Enable-AzStorageContainerDeleteRetentionPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -PassThru -RetentionDays 3 +``` +```output +Enabled Days +------- ---- + True 3 +``` + +This command enables delete retention policy for Blob containers, and set deleted blob retention days to 3. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Display ServiceProperties + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a Storage account Resource Id, or a Blob service properties Resource Id. + +```yaml +Type: System.String +Parameter Sets: BlobServicePropertiesResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionDays +Sets the number of retention days for the DeleteRetentionPolicy. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Days + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSBlobServiceProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Enable-AzStorageDeleteRetentionPolicy.md b/azps-10.1.0/Az.Storage/Enable-AzStorageDeleteRetentionPolicy.md new file mode 100644 index 0000000000..46631062eb --- /dev/null +++ b/azps-10.1.0/Az.Storage/Enable-AzStorageDeleteRetentionPolicy.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/enable-azstoragedeleteretentionpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Enable-AzStorageDeleteRetentionPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Enable-AzStorageDeleteRetentionPolicy.md +--- + +# Enable-AzStorageDeleteRetentionPolicy + +## SYNOPSIS +Enable delete retention policy for the Azure Storage Blob service. + +## SYNTAX + +``` +Enable-AzStorageDeleteRetentionPolicy [-RetentionDays] <Int32> [-PassThru] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzStorageDeleteRetentionPolicy** cmdlet enables delete retention policy for the Azure Storage Blob service. + +## EXAMPLES + +### Example 1: Enable delete retention policy for the Blob service +```powershell +Enable-AzStorageDeleteRetentionPolicy -RetentionDays 3 +``` + +This command enables delete retention policy for the Blob service, and set deleted blob retention days to 3. + +## PARAMETERS + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Display DeleteRetentionPolicyProperties + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDays +Sets the number of retention days for the DeleteRetentionPolicy. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Days + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSDeleteRetentionPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Enable-AzStorageStaticWebsite.md b/azps-10.1.0/Az.Storage/Enable-AzStorageStaticWebsite.md new file mode 100644 index 0000000000..02364e51c7 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Enable-AzStorageStaticWebsite.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/enable-azstoragestaticwebsite +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Enable-AzStorageStaticWebsite.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Enable-AzStorageStaticWebsite.md +--- + +# Enable-AzStorageStaticWebsite + +## SYNOPSIS +Enable static website for the Azure Storage account. + +## SYNTAX + +``` +Enable-AzStorageStaticWebsite [[-IndexDocument] <String>] [[-ErrorDocument404Path] <String>] [-PassThru] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzStorageStaticWebsite** cmdlet enables static website for the Azure Storage account. + +## EXAMPLES + +### Example 1: Enable static website for the Azure Storage account +```powershell +Enable-AzStorageStaticWebsite -IndexDocument $indexdoc -ErrorDocument404Path $errordoc +``` + +This command enables static website for the Azure Storage account. + +## PARAMETERS + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ErrorDocument404Path +The path to the error document that should be shown when a 404 is issued (meaning, when a browser requests a page that does not exist.) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IndexDocument +The name of the index document in each directory. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Display Static Website setting in ServiceProperties. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSStaticWebsiteProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzDataLakeGen2ChildItem.md b/azps-10.1.0/Az.Storage/Get-AzDataLakeGen2ChildItem.md new file mode 100644 index 0000000000..f0cef0de64 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzDataLakeGen2ChildItem.md @@ -0,0 +1,256 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azdatalakegen2childitem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzDataLakeGen2ChildItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzDataLakeGen2ChildItem.md +--- + +# Get-AzDataLakeGen2ChildItem + +## SYNOPSIS +Lists sub directories and files from a directory or filesystem root. + +## SYNTAX + +``` +Get-AzDataLakeGen2ChildItem [-FileSystem] <String> [[-Path] <String>] [-FetchProperty] [-Recurse] + [-MaxCount <Int32>] [-ContinuationToken <String>] [-AsJob] [-OutputUserPrincipalName] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeGen2ChildItem** cmdlet lists sub directorys and files in a directory or Filesystem in an Azure storage account. +This cmdlet only works if Hierarchical Namespace is enabled for the Storage account. This kind of account can be created by run "New-AzStorageAccount" cmdlet with "-EnableHierarchicalNamespace $true". + +## EXAMPLES + +### Example 1: List the direct sub items from a Filesystem +```powershell +Get-AzDataLakeGen2ChildItem -FileSystem "filesystem1" +``` + +```output + FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir1 True 2020-03-13 13:07:34Z rwxr-x--- $superuser $superuser +dir2 True 2020-03-23 09:28:36Z rwxr-x--- $superuser $superuser +``` + +This command lists the direct sub items from a Filesystem + +### Example 2: List recursively from a directory, and fetch Properties/ACL +```powershell +Get-AzDataLakeGen2ChildItem -FileSystem "filesystem1" -Path "dir1/" -Recurse -FetchProperty +``` + +```output + FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir1/dir3 True 2020-03-23 09:34:31Z rwx---rwx $superuser $superuser +dir1/file1 False 1024 2020-03-23 09:29:18Z rwx---rwx $superuser $superuser +dir1/testfile_1K_0 False 1024 2020-03-23 09:29:21Z rw-r----- $superuser $superuser +``` + +This command lists the direct sub items from a Filesystem + +### Example 3: List items recursively from a Filesystem in multiple batches +```powershell +$MaxReturn = 1000 +$FileSystemName = "filesystem1" +$Total = 0 +$Token = $Null +do + { + $items = Get-AzDataLakeGen2ChildItem -FileSystem $FileSystemName -Recurse -MaxCount $MaxReturn -ContinuationToken $Token + $Total += $items.Count + if($items.Length -le 0) { Break;} + $Token = $items[$items.Count -1].ContinuationToken; + } + While ($null -ne $Token) +Echo "Total $Total items in Filesystem $FileSystemName" +``` + +This example uses the *MaxCount* and *ContinuationToken* parameters to list items recursively from a Filesystem in multiple batches. +A small *MaxCount* can limit the items acount returned from single requst, may help on operation times out error, and limit the memory usage of Powershell. +The first four commands assign values to variables to use in the example. +The fifth command specifies a **Do-While** statement that uses the **Get-AzDataLakeGen2ChildItem** cmdlet to list items. +The statement includes the continuation token stored in the $Token variable. +$Token changes value as the loop runs. +The final command uses the **Echo** command to display the total. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ContinuationToken +Continuation Token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FetchProperty +Fetch the datalake item properties and ACL. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: FetchPermission + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +FileSystem name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaxCount +The max count of the blobs that can return. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputUserPrincipalName +If speicify this parameter, the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object IDs to User Principal Names. If not speicify this parameter, the values will be returned as Azure Active Directory Object IDs. Note that group and application Object IDs are not translated because they do not have unique friendly names. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: UserPrincipalName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path in the specified Filesystem that should be retrieved. +Should be a directory, in the format 'directory1/directory2/'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Recurse +Indicates if will recursively get the Child Item. +The default is false. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzDataLakeGen2DeletedItem.md b/azps-10.1.0/Az.Storage/Get-AzDataLakeGen2DeletedItem.md new file mode 100644 index 0000000000..509abef368 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzDataLakeGen2DeletedItem.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azdatalakegen2deleteditem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzDataLakeGen2DeletedItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzDataLakeGen2DeletedItem.md +--- + +# Get-AzDataLakeGen2DeletedItem + +## SYNOPSIS +List all deleted files or directories from a directory or filesystem root. + +## SYNTAX + +``` +Get-AzDataLakeGen2DeletedItem [-FileSystem] <String> [[-Path] <String>] [-MaxCount <Int32>] + [-ContinuationToken <String>] [-AsJob] [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeGen2DeletedItem** cmdlet lists all deleted files or directories from a directory or filesystem in an Azure storage account. +This cmdlet only works if Hierarchical Namespace is enabled for the Storage account. This kind of account can be created by run "New-AzStorageAccount" cmdlet with "-EnableHierarchicalNamespace $true". + +## EXAMPLES + +### Example 1: List all deleted files or directories from a Filesystem +```powershell +Get-AzDataLakeGen2DeletedItem -FileSystem "filesystem1" +``` + +```output +FileSystem Name: filesystem1 + +Path DeletionId DeletedOn RemainingRetentionDays +---- ---------- --------- ---------------------- +dir0/dir1/file1 132658816156507617 2021-05-19 07:06:55Z 3 +dir0/dir2 132658834541610122 2021-05-19 07:37:34Z 3 +dir0/dir2/file3 132658834534174806 2021-05-19 07:37:33Z 3 +``` + +This command lists all deleted files or directories from a Filesystem. + +### Example 2: List all deleted files or directories from a directory +```powershell +Get-AzDataLakeGen2DeletedItem -FileSystem "filesystem1" -Path dir0/dir2 +``` +```output +FileSystem Name: filesystem1 + +Path DeletionId DeletedOn RemainingRetentionDays +---- ---------- --------- ---------------------- +dir0/dir2 132658834541610122 2021-05-19 07:37:34Z 3 +dir0/dir2/file3 132658834534174806 2021-05-19 07:37:33Z 3 +``` + +This command lists all deleted files or directories from a directory. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ContinuationToken +Continuation Token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +FileSystem name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaxCount +The max count of the blobs that can return. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path in the specified FileSystem that should be retrieved. +Can be a directory In the format 'directory1/directory2/', Skip set this parameter to list items from root directory of the Filesystem. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2DeletedItem + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzDataLakeGen2Item.md b/azps-10.1.0/Az.Storage/Get-AzDataLakeGen2Item.md new file mode 100644 index 0000000000..df3517b97e --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzDataLakeGen2Item.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azdatalakegen2item +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzDataLakeGen2Item.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzDataLakeGen2Item.md +--- + +# Get-AzDataLakeGen2Item + +## SYNOPSIS +Gets the details of a file or directory in a filesystem. + +## SYNTAX + +``` +Get-AzDataLakeGen2Item [-FileSystem] <String> [-Path <String>] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeGen2Item** cmdlet gets the details of a file or directory in a Filesystem in an Azure storage account. +This cmdlet only works if Hierarchical Namespace is enabled for the Storage account. This kind of account can be created by run "New-AzStorageAccount" cmdlet with "-EnableHierarchicalNamespace $true". + +## EXAMPLES + +### Example 1: Get a directory from a Filesystem, and show the details +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $dir1 = Get-AzDataLakeGen2Item -FileSystem "filesystem1" -Path "dir1/" +PS C:\> $dir1 + + FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir1 True 2020-03-23 09:15:56Z rwx---rwx $superuser $superuser + +PS C:\WINDOWS\system32> $dir1.ACL + +DefaultScope AccessControlType EntityId Permissions +------------ ----------------- -------- ----------- +False User rwx +False Group --- +False Other rwx + +PS C:\WINDOWS\system32> $dir1.Permissions + +Owner : Execute, Write, Read +Group : None +Other : Execute, Write, Read +StickyBit : False +ExtendedAcls : False + +PS C:\WINDOWS\system32> $dir1.Properties.Metadata + +Key Value +--- ----- +hdi_isfolder true +tag1 value1 +tag2 value2 + +PS C:\WINDOWS\system32> $dir1.Properties + +LastModified : 3/23/2020 9:15:56 AM +00:00 +CreatedOn : 3/23/2020 9:15:56 AM +00:00 +Metadata : {[hdi_isfolder, true], [tag1, value1], [tag2, value2]} +CopyCompletedOn : 1/1/0001 12:00:00 AM +00:00 +CopyStatusDescription : +CopyId : +CopyProgress : +CopySource : +CopyStatus : Pending +IsIncrementalCopy : False +LeaseDuration : Infinite +LeaseState : Available +LeaseStatus : Unlocked +ContentLength : 0 +ContentType : application/octet-stream +ETag : "0x8D7CF0ACBA35FA8" +ContentHash : +ContentEncoding : UDF12 +ContentDisposition : +ContentLanguage : +CacheControl : READ +AcceptRanges : bytes +IsServerEncrypted : True +EncryptionKeySha256 : +AccessTier : Cool +ArchiveStatus : +AccessTierChangedOn : 1/1/0001 12:00:00 AM +00:00 +``` + +This command gets a directory from a Filesystem, and show the details. + +### Example 2: Get a file from a Filesystem +```powershell +Get-AzDataLakeGen2Item -FileSystem "filesystem1" -Path "dir1/file1" +``` +```output + FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir1/file1 False 1024 2020-03-23 09:20:37Z rwx---rwx $superuser $superuser +``` + +This command gets the details of a file from a Filesystem. + +## PARAMETERS + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +FileSystem name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Path +The path in the specified Filesystem that should be retrieved. +Can be a file or directory In the format 'directory/file.txt' or 'directory1/directory2/'. +Not specify this parameter to get the root directory of the Filesystem. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzDataLakeGen2ItemContent.md b/azps-10.1.0/Az.Storage/Get-AzDataLakeGen2ItemContent.md new file mode 100644 index 0000000000..c376514f6c --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzDataLakeGen2ItemContent.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azdatalakegen2itemcontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzDataLakeGen2ItemContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzDataLakeGen2ItemContent.md +--- + +# Get-AzDataLakeGen2ItemContent + +## SYNOPSIS +Download a file. + +## SYNTAX + +### ReceiveManual (Default) +``` +Get-AzDataLakeGen2ItemContent [-FileSystem] <String> [-Path] <String> [-Destination <String>] [-CheckMd5] + [-Force] [-AsJob] [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] + [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ItemPipeline +``` +Get-AzDataLakeGen2ItemContent -InputObject <AzureDataLakeGen2Item> [-Destination <String>] [-CheckMd5] [-Force] + [-AsJob] [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] + [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDataLakeGen2ItemContent** cmdlet download a file in a Filesystem in an Azure storage account. +This cmdlet only works if Hierarchical Namespace is enabled for the Storage account. This kind of account can be created by run "New-AzStorageAccount" cmdlet with "-EnableHierarchicalNamespace $true". + +## EXAMPLES + +### Example 1: Download a file without prompt +```powershell +Get-AzDataLakeGen2ItemContent -FileSystem "filesystem1" -Path "dir1/file1" -Destination $localDestFile -Force +``` +```output + FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir1/file1 False 1024 2020-03-23 09:29:18Z rwx---rwx $superuser $superuser +``` + +This command downloads a file to a local file without prompt. + +### Example 2: Get a file, then pipeline to download the file to a local file +```powershell +Get-AzDataLakeGen2Item -FileSystem "filesystem1" -Path "dir1/file1" | Get-AzDataLakeGen2ItemContent -Destination $localDestFile +``` +```output + FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir1/file1 False 1024 2020-03-23 09:29:18Z rwx---rwx $superuser $superuser +``` + +This command first gets a file, then pipeline to download the file to a local file. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CheckMd5 +check the md5sum + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +The total amount of concurrent async tasks. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +Destination local file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +FileSystem name + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Force +Force to overwrite the existing blob or file + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure Datalake Gen2 Item Object to download. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item +Parameter Sets: ItemPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Path +The path in the specified Filesystem that should be removed. +Can be a file or directory In the format 'directory/file.txt' or 'directory1/directory2/' + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzRmStorageContainer.md b/azps-10.1.0/Az.Storage/Get-AzRmStorageContainer.md new file mode 100644 index 0000000000..5affaac507 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzRmStorageContainer.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azrmstoragecontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzRmStorageContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzRmStorageContainer.md +--- + +# Get-AzRmStorageContainer + +## SYNOPSIS +Gets or lists Storage blob containers + +## SYNTAX + +### AccountName (Default) +``` +Get-AzRmStorageContainer [-ResourceGroupName] <String> [-StorageAccountName] <String> [-Name <String>] + [-IncludeDeleted] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountObject +``` +Get-AzRmStorageContainer -StorageAccount <PSStorageAccount> [-Name <String>] [-IncludeDeleted] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRmStorageContainer** cmdlet gets or lists Storage blob containers + +## EXAMPLES + +### Example 1: Get a Storage blob container with Storage account name and container name +```powershell +Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" +``` + +This command gets a Storage blob container with Storage account name and container name. + +### Example 2: List all Storage blob containers of a Storage account +```powershell +Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" +``` + +This command lists all Storage blob containers of a Storage account with Storage account name. + +### Example 3: Get a Storage blob container with Storage account object and container name. +```powershell +$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" +Get-AzRmStorageContainer -StorageAccount $accountObject -ContainerName "myContainer" +``` + +This command gets a Storage blob container with Storage account object and container name. + +### Example 4: List Storage blob container of a Storage account, include deleted containers. +```powershell +Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -IncludeDeleted +``` +```output + ResourceGroupName: myResourceGroup, StorageAccountName: myStorageAccount + +Name PublicAccess LastModified HasLegalHold HasImmutabilityPolicy Deleted VersionId +---- ------------ ------------ ------------ --------------------- ------- --------- +testcon None 2020-08-28 10:18:13Z False False False 01D685BC91A88F22 +testcon2 None 2020-09-04 12:52:37Z False False True 01D67D248986B6DA +``` + +This example lists all containers of a storage account, include deleted containers. +Deleted containers will only exist after enabled Container softdelete with Enable-AzStorageBlobDeleteRetentionPolicy. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDeleted +Include deleted containers, by default list containers won't include deleted containers + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, ContainerName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzRmStorageContainerImmutabilityPolicy.md b/azps-10.1.0/Az.Storage/Get-AzRmStorageContainerImmutabilityPolicy.md new file mode 100644 index 0000000000..3fbf329a16 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzRmStorageContainerImmutabilityPolicy.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azrmstoragecontainerimmutabilitypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzRmStorageContainerImmutabilityPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzRmStorageContainerImmutabilityPolicy.md +--- + +# Get-AzRmStorageContainerImmutabilityPolicy + +## SYNOPSIS +Gets ImmutabilityPolicy of a Storage blob containers + +## SYNTAX + +### AccountName (Default) +``` +Get-AzRmStorageContainerImmutabilityPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -ContainerName <String> [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountObject +``` +Get-AzRmStorageContainerImmutabilityPolicy -ContainerName <String> -StorageAccount <PSStorageAccount> + [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ContainerObject +``` +Get-AzRmStorageContainerImmutabilityPolicy -Container <PSContainer> [-Etag <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRmStorageContainerImmutabilityPolicy** cmdlet gets ImmutabilityPolicy of a Storage blob containers + +## EXAMPLES + +### Example 1: Get ImmutabilityPolicy of a Storage blob container with Storage account name and container name +```powershell +Get-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" +``` + +This command gets ImmutabilityPolicy of a Storage blob container with Storage account name and container name. + +### Example 2: Get ImmutabilityPolicy of a Storage blob container with Storage account object and container name +```powershell +$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" +Get-AzRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" +``` + +This command gets ImmutabilityPolicy of a Storage blob containers with Storage account object and container name. + +### Example 3: Get ImmutabilityPolicy of a Storage blob container with Storage container object +```powershell +$containerObject = Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -Name "myContainer" +Get-AzRmStorageContainerImmutabilityPolicy -Container $containerObject +``` + +This command gets ImmutabilityPolicy of a Storage blob container with Storage container object. + +## PARAMETERS + +### -Container +Storage container object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSContainer +Parameter Sets: ContainerObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ContainerName +Container Name + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: N + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Immutability policy etag. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: IfMatch + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzRmStorageShare.md b/azps-10.1.0/Az.Storage/Get-AzRmStorageShare.md new file mode 100644 index 0000000000..e34cf0c76d --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzRmStorageShare.md @@ -0,0 +1,322 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azrmstorageshare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzRmStorageShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzRmStorageShare.md +--- + +# Get-AzRmStorageShare + +## SYNOPSIS +Gets or lists Storage file shares. + +## SYNTAX + +### AccountNameSingle (Default) +``` +Get-AzRmStorageShare [-ResourceGroupName] <String> [-StorageAccountName] <String> [-Name <String>] + [-SnapshotTime <DateTime>] [-GetShareUsage] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountName +``` +Get-AzRmStorageShare [-ResourceGroupName] <String> [-StorageAccountName] <String> [-IncludeDeleted] + [-IncludeSnapshot] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountObjectSingle +``` +Get-AzRmStorageShare -StorageAccount <PSStorageAccount> -Name <String> [-SnapshotTime <DateTime>] + [-GetShareUsage] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountObject +``` +Get-AzRmStorageShare -StorageAccount <PSStorageAccount> [-IncludeDeleted] [-IncludeSnapshot] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ShareResourceId +``` +Get-AzRmStorageShare [-ResourceId] <String> [-GetShareUsage] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzRmStorageShare** cmdlet gets or lists Storage file shares. + +## EXAMPLES + +### Example 1: Get a Storage file share with Storage account name and share name +```powershell +Get-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" +``` +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes +---- -------- ---------------- ---------- ------- ------- --------------- +myshare 5120 +``` + +This command gets a Storage file share with Storage account name and share name. + +### Example 2: List all Storage file shares of a Storage account +```powershell +Get-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" +``` +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes +---- -------- ---------------- ---------- ------- ------- --------------- +share1 5120 TransactionOptimized +share2 5120 TransactionOptimized +``` + +This command lists all Storage file shares of a Storage account with Storage account name. + +### Example 3: Get a Storage blob container with Storage account object and container name. +```powershell +Get-AzStorageAccount -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" | Get-AzRmStorageShare -Name "myshare" +``` + +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes +---- -------- ---------------- ---------- ------- ------- --------------- +myshare 5120 +``` + +This command gets a Storage blob container with Storage account object and container name. + +### Example 4: Get a Storage file share with the share usage in bytes +```powershell +Get-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -GetShareUsage +``` + +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes +---- -------- ---------------- ---------- ------- ------- --------------- +myshare 5120 2097152 +``` + +This command gets a Storage file share with Storage account name and share name, and include the share usage in bytes. + +### Example 5: List all Storage file shares of a Storage account, include the deleted shares, include the share snapshots +```powershell +Get-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -IncludeDeleted -IncludeSnapshot +``` + +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes snapshotTime +---- -------- ---------------- ---------- ------- ------- --------------- ------------ +testshare1 5120 TransactionOptimized 2021-05-10T08:04:08Z +testshare1 5120 TransactionOptimized +share1 100 TransactionOptimized True 01D61FD1FC5498B6 +``` + +This command lists all Storage file shares include the deleted shares and share snapshots. + +### Example 6: Get a single share snapshot +```powershell +Get-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "testshare1" -SnapshotTime "2021-05-10T08:04:08Z" +``` + +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes snapshotTime +---- -------- ---------------- ---------- ------- ------- --------------- ------------ +testshare1 5120 TransactionOptimized 2021-05-10T08:04:08Z +``` + +This command gets a single file share snapshot with share name and snapshot time. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GetShareUsage +Specify this parameter to get the Share Usage in Bytes. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AccountNameSingle, AccountObjectSingle, ShareResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDeleted +Include deleted shares, by default list shares won't include deleted shares + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AccountName, AccountObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSnapshot +Include share snapshots, by default list shares won't include share snapshots. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AccountName, AccountObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Share Name + +```yaml +Type: System.String +Parameter Sets: AccountNameSingle +Aliases: N, ShareName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: AccountObjectSingle +Aliases: N, ShareName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountNameSingle, AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a File Share Resource Id. + +```yaml +Type: System.String +Parameter Sets: ShareResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SnapshotTime +Share SnapshotTime + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: AccountNameSingle, AccountObjectSingle +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObjectSingle, AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountNameSingle, AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSShare + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageAccount.md b/azps-10.1.0/Az.Storage/Get-AzStorageAccount.md new file mode 100644 index 0000000000..ce3daf00e6 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageAccount.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +ms.assetid: E53D5040-C1E8-4DC1-8371-F41C00B666E3 +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageAccount.md +--- + +# Get-AzStorageAccount + +## SYNOPSIS +Gets a Storage account. + +## SYNTAX + +### ResourceGroupParameterSet +``` +Get-AzStorageAccount [[-ResourceGroupName] <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### AccountNameParameterSet +``` +Get-AzStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-IncludeGeoReplicationStats] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### BlobRestoreStatusParameterSet +``` +Get-AzStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-IncludeBlobRestoreStatus] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageAccount** cmdlet gets a specified Storage account or all of the Storage accounts in a resource group or the subscription. + +## EXAMPLES + +### Example 1: Get a specified Storage account +```powershell +Get-AzStorageAccount -ResourceGroupName "RG01" -Name "mystorageaccount" +``` + +This command gets the specified Storage account. + +### Example 2: Get all Storage accounts in a resource group +```powershell +Get-AzStorageAccount -ResourceGroupName "RG01" +``` + +This command gets all of the Storage accounts in a resource group. + +### Example 3: Get all Storage accounts in the subscription +```powershell +Get-AzStorageAccount +``` + +This command gets all of the Storage accounts in the subscription. + +### Example 4: Get a Storage accounts with its blob restore status +```powershell +$account = Get-AzStorageAccount -ResourceGroupName "myresourcegoup" -Name "mystorageaccount" -IncludeBlobRestoreStatus + +$account.BlobRestoreStatus +``` +```output +Status RestoreId FailureReason Parameters.TimeToRestore Parameters.BlobRanges +------ --------- ------------- ------------------------ --------------------- +InProgress a70cd4a1-f223-4c86-959f-cc13eb4795a8 2020-02-10T13:45:04.7155962Z [container1/blob1 -> container2/blob2] +``` + +This command gets a Storage accounts with its blob restore status, and show the blob restore status. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeBlobRestoreStatus +Get the BlobRestoreStatus of the Storage account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BlobRestoreStatusParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeGeoReplicationStats +Get the GeoReplicationStats of the Storage account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AccountNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage account to get. + +```yaml +Type: System.String +Parameter Sets: AccountNameParameterSet, BlobRestoreStatusParameterSet +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Storage account to get. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: AccountNameParameterSet, BlobRestoreStatusParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## NOTES + +## RELATED LINKS + +[New-AzStorageAccount](./New-AzStorageAccount.md) + +[Remove-AzStorageAccount](./Remove-AzStorageAccount.md) + +[Set-AzStorageAccount](./Set-AzStorageAccount.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageAccountKey.md b/azps-10.1.0/Az.Storage/Get-AzStorageAccountKey.md new file mode 100644 index 0000000000..462ad007a5 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageAccountKey.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +ms.assetid: A57A9EFA-47AC-44D8-BFA7-CDE0E2A612B3 +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageAccountKey.md +--- + +# Get-AzStorageAccountKey + +## SYNOPSIS +Gets the access keys for an Azure Storage account. + +## SYNTAX + +``` +Get-AzStorageAccountKey [-ResourceGroupName] <String> [-Name] <String> [-ListKerbKey] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageAccountKey** cmdlet gets the access keys for an Azure Storage account. + +## EXAMPLES + +### Example 1: Get the access keys for a Storage account +```powershell +Get-AzStorageAccountKey -ResourceGroupName "RG01" -Name "mystorageaccount" +``` + +This command gets the keys for the specified Azure Storage account. + +### Example 2: Get a specific access key for a Storage account +<!-- Skip: Output cannot be splitted from code --> +``` +This command gets a specific key for a Storage account. +PS C:\>(Get-AzStorageAccountKey -ResourceGroupName "RG01" -Name "mystorageaccount")| Where-Object {$_.KeyName -eq "key1"} + +KeyName Value Permissions CreationTime +------- ----- ----------- ------------ +key1 <KeyValue> Full + +This command gets a specific key value for a Storage account. +PS C:\>(Get-AzStorageAccountKey -ResourceGroupName "RG01" -Name "mystorageaccount")[0].Value + +<KeyValue> +``` + +### Example 3: Lists the access keys for a Storage account, include the Kerberos keys (if active directory enabled) +```powershell +Get-AzStorageAccountKey -ResourceGroupName "RG01" -Name "mystorageaccount" -ListKerbKey +``` + +This command gets the keys for the specified Azure Storage account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListKerbKey +Lists the Kerberos keys (if active directory enabled) for the specified storage account. +Kerberos key is generated per storage account for Azure Files identity based authentication either with Azure Active Directory Domain Service (Azure AD DS) or Active Directory Domain Service (AD DS). +It is used as the password of the identity registered in the domain service that represents the storage account. +Kerberos key does not provide access permission to perform any control or data plane read or write operations against the storage account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage account for which this cmdlet gets keys. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Storage.Models.StorageAccountKey + +## NOTES + +## RELATED LINKS + +[New-AzStorageAccountKey](./New-AzStorageAccountKey.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageAccountManagementPolicy.md b/azps-10.1.0/Az.Storage/Get-AzStorageAccountManagementPolicy.md new file mode 100644 index 0000000000..ccb0406acd --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageAccountManagementPolicy.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/Az.storage/get-Azstorageaccountmanagementpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageAccountManagementPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageAccountManagementPolicy.md +--- + +# Get-AzStorageAccountManagementPolicy + +## SYNOPSIS +Gets the management policy of an Azure Storage account. + +## SYNTAX + +### AccountName (Default) +``` +Get-AzStorageAccountManagementPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountResourceId +``` +Get-AzStorageAccountManagementPolicy [-StorageAccountResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountObject +``` +Get-AzStorageAccountManagementPolicy -StorageAccount <PSStorageAccount> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageAccountManagementPolicy** cmdlet gets the management policy of an Azure Storage account. + +## EXAMPLES + +### Example 1: Get the management policy of a Storage account. +```powershell +Get-AzStorageAccountManagementPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" +``` +```output +ResourceGroupName : myresourcegroup +StorageAccountName : mystorageaccount +Id : /subscriptions/{subscription-id}/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount/managementPolicies/default +Type : Microsoft.Storage/storageAccounts/managementPolicies +LastModifiedTime : 3/12/2019 7:04:05 AM +Rules : [ + { + "Enabled": true, + "Name": "Test", + "Definition": { + "Actions": { + "BaseBlob": { + "TierToCool": { + "DaysAfterModificationGreaterThan": 30 + }, + "TierToArchive": { + "DaysAfterModificationGreaterThan": 50 + }, + "Delete": { + "DaysAfterModificationGreaterThan": 100 + } + }, + "Snapshot": { + "Delete": { + "DaysAfterCreationGreaterThan": 100 + } + } + }, + "Filters": { + "PrefixMatch": [ + "prefix1", + "prefix2" + ], + "BlobTypes": [ + "blockBlob" + ] + } + } + }, + { + "Enabled": true, + "Name": "Test2", + "Definition": { + "Actions": { + "BaseBlob": { + "TierToCool": null, + "TierToArchive": null, + "Delete": { + "DaysAfterModificationGreaterThan": 100 + } + }, + "Snapshot": null + }, + "Filters": { + "PrefixMatch": null, + "BlobTypes": [ + "blockBlob" + ] + } + } + } + ] +``` + +This command gets the management policy of a Storage account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Storage Account Resource Id. + +```yaml +Type: System.String +Parameter Sets: AccountResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Storage.Models.StorageAccountKey + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageAccountNameAvailability.md b/azps-10.1.0/Az.Storage/Get-AzStorageAccountNameAvailability.md new file mode 100644 index 0000000000..9032d90978 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageAccountNameAvailability.md @@ -0,0 +1,84 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +ms.assetid: F6EA099A-D588-49AE-9D2C-865BC32685BA +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageaccountnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageAccountNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageAccountNameAvailability.md +--- + +# Get-AzStorageAccountNameAvailability + +## SYNOPSIS +Checks the availability of a Storage account name. + +## SYNTAX + +``` +Get-AzStorageAccountNameAvailability [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageAccountNameAvailability** cmdlet checks whether the name of an Azure Storage account is valid and available to use. + +## EXAMPLES + +### Example 1: Check availability of a Storage account name +```powershell +Get-AzStorageAccountNameAvailability -Name 'contosostorage03' +``` + +This command checks the availability of the name ContosoStorage03. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage account that this cmdlet checks. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Storage.Models.CheckNameAvailabilityResult + +## NOTES + +## RELATED LINKS + +[Azure Storage Manager Cmdlets](./Az.Storage.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageAccountNetworkRuleSet.md b/azps-10.1.0/Az.Storage/Get-AzStorageAccountNetworkRuleSet.md new file mode 100644 index 0000000000..b6f8fb3625 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageAccountNetworkRuleSet.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageaccountnetworkruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageAccountNetworkRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageAccountNetworkRuleSet.md +--- + +# Get-AzStorageAccountNetworkRuleSet + +## SYNOPSIS +Get the NetWorkRule property of a Storage account + +## SYNTAX + +``` +Get-AzStorageAccountNetworkRuleSet [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageAccountNetworkRuleSet** cmdlet gets the NetworkRule property of a Storage account + +## EXAMPLES + +### Example 1: Get NetworkRule property of a specified Storage account +```powershell +Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "rg1" -Name "mystorageaccount" +``` + +This command gets NetworkRule property of a specified Storage account + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group contains the Storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSNetworkRuleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageBlob.md b/azps-10.1.0/Az.Storage/Get-AzStorageBlob.md new file mode 100644 index 0000000000..96114328ad --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageBlob.md @@ -0,0 +1,491 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: E54BFD3A-CD54-4E6B-9574-92B8D3E88FF3 +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageblob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlob.md +--- + +# Get-AzStorageBlob + +## SYNOPSIS +Lists blobs in a container. + +## SYNTAX + +### BlobName (Default) +``` +Get-AzStorageBlob [[-Blob] <String>] [-Container] <String> [-IncludeDeleted] [-IncludeTag] [-MaxCount <Int32>] + [-ContinuationToken <BlobContinuationToken>] [-TagCondition <String>] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +### SingleBlobSnapshotTime +``` +Get-AzStorageBlob [-Blob] <String> [-Container] <String> [-IncludeDeleted] [-IncludeTag] + -SnapshotTime <DateTimeOffset> [-MaxCount <Int32>] [-ContinuationToken <BlobContinuationToken>] + [-TagCondition <String>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [<CommonParameters>] +``` + +### SingleBlobVersionID +``` +Get-AzStorageBlob [-Blob] <String> [-Container] <String> [-IncludeDeleted] [-IncludeTag] -VersionId <String> + [-MaxCount <Int32>] [-ContinuationToken <BlobContinuationToken>] [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +### BlobPrefix +``` +Get-AzStorageBlob [-Prefix <String>] [-Container] <String> [-IncludeDeleted] [-IncludeVersion] [-IncludeTag] + [-MaxCount <Int32>] [-ContinuationToken <BlobContinuationToken>] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageBlob** cmdlet lists blobs in the specified container in an Azure storage account. + +## EXAMPLES + +### Example 1: Get a blob by blob name +```powershell +Get-AzStorageBlob -Container "ContainerName" -Blob blob* +``` + +This command uses a blob name and wildcard to get a blob. + +### Example 2: Get blobs in a container by using the pipeline +```powershell +Get-AzStorageContainer -Name container* | Get-AzStorageBlob -IncludeDeleted +``` +```output + Container Uri: https://storageaccountname.blob.core.windows.net/container1 + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted +---- -------- ------ ----------- ------------ ---------- ------------ --------- +test1 BlockBlob 403116 application/octet-stream 2017-11-08 07:53:19Z 2017-11-08 08:19:32Z True +test1 BlockBlob 403116 application/octet-stream 2017-11-08 09:00:29Z True +test2 BlockBlob 403116 application/octet-stream 2017-11-08 07:53:00Z False +``` + +This command uses the pipeline to get all blobs (include blobs in Deleted status) in a container. + +### Example 3: Get blobs by name prefix +```powershell +Get-AzStorageBlob -Container "ContainerName" -Prefix "blob" +``` + +This command uses a name prefix to get blobs. + +### Example 4: List blobs in multiple batches +```powershell +$MaxReturn = 10000 +$ContainerName = "abc" +$Total = 0 +$Token = $Null +do + { + $Blobs = Get-AzStorageBlob -Container $ContainerName -MaxCount $MaxReturn -ContinuationToken $Token + $Total += $Blobs.Count + if($Blobs.Length -le 0) { Break;} + $Token = $Blobs[$blobs.Count -1].ContinuationToken; + } + While ($null -ne $Token) +Echo "Total $Total blobs in container $ContainerName" +``` + +This example uses the *MaxCount* and *ContinuationToken* parameters to list Azure Storage blobs in multiple batches. +The first four commands assign values to variables to use in the example. +The fifth command specifies a **Do-While** statement that uses the **Get-AzStorageBlob** cmdlet to get blobs. +The statement includes the continuation token stored in the $Token variable. +$Token changes value as the loop runs. +For more information, type `Get-Help About_Do`. +The final command uses the **Echo** command to display the total. + +### Example 5: Get all blobs in a container include blob version +```powershell +Get-AzStorageBlob -Container "containername" -IncludeVersion +``` +```output + AccountName: storageaccountname, ContainerName: containername + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +blob1 BlockBlob 2097152 application/octet-stream 2020-07-06 06:56:06Z Hot False 2020-07-06T06:56:06.2432658Z +blob1 BlockBlob 2097152 application/octet-stream 2020-07-06 06:56:06Z Hot 2020-07-06T06:56:06.8588431Z False +blob1 BlockBlob 2097152 application/octet-stream 2020-07-06 06:56:06Z Hot False 2020-07-06T06:56:06.8598431Z * +blob2 BlockBlob 2097152 application/octet-stream 2020-07-03 16:19:16Z Hot False 2020-07-03T16:19:16.2883167Z +blob2 BlockBlob 2097152 application/octet-stream 2020-07-03 16:19:35Z Hot False 2020-07-03T16:19:35.2381110Z * +``` + +This command gets all blobs in a container include blob version. + +### Example 6: Get a single blob version +```powershell +Get-AzStorageBlob -Container "containername" -Blob blob2 -VersionId "2020-07-03T16:19:16.2883167Z" +``` +```output + AccountName: storageaccountname, ContainerName: containername + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +blob2 BlockBlob 2097152 application/octet-stream 2020-07-03 16:19:16Z Hot False 2020-07-03T16:19:16.2883167Z +``` + +This command gets a single blobs verion with VersionId. + +### Example 7: Get a single blob snapshot +```powershell +Get-AzStorageBlob -Container "containername" -Blob blob1 -SnapshotTime "2020-07-06T06:56:06.8588431Z" +``` +```output + AccountName: storageaccountname, ContainerName: containername + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +blob1 BlockBlob 2097152 application/octet-stream 2020-07-06 06:56:06Z Hot 2020-07-06T06:56:06.8588431Z False +``` + +This command gets a single blobs snapshot with SnapshotTime. + +### Example 8: Get blob include blob tags +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\> $blobs = Get-AzStorageBlob -Container "containername" -IncludeTag + +PS C:\> $blobs + + AccountName: storageaccountname, ContainerName: containername + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +testblob BlockBlob 2097152 application/octet-stream 2020-07-23 09:35:02Z Hot False 2020-07-23T09:35:02.8527357Z * +testblob2 BlockBlob 2097152 application/octet-stream 2020-07-23 09:35:04Z Hot False 2020-07-23T09:35:04.0856187Z * + + +PS C:\> $blobs[0].Tags +Name Value +---- ----- +tag1 value1 +tag2 value2 +``` + +This command lists blobs from a container with blob tags, and show the tags of the first blob. + +### Example 9: Get a single blob with blob tag condition +```powershell +Get-AzStorageBlob -Container "containername" -Blob testblob -TagCondition """tag1""='value1'" +``` +```output + AccountName: storageaccountname, ContainerName: containername + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +testblob BlockBlob 2097152 application/octet-stream 2020-07-23 09:35:02Z Hot False 2020-07-23T09:35:02.8527357Z * +``` + +This command gets a single blob with blob tag condition. +The cmdlet will only success when the blob contains a tag with name "tag1" and value "value1", else the cmdlet will fail with error code 412. + +## PARAMETERS + +### -Blob +Specifies a name or name pattern, which can be used for a wildcard search. +If no blob name is specified, the cmdlet lists all the blobs in the specified container. +If a value is specified for this parameter, the cmdlet lists all blobs with names that match this parameter. This parameter supports wildcards anywhere in the string. + +```yaml +Type: System.String +Parameter Sets: BlobName +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +```yaml +Type: System.String +Parameter Sets: SingleBlobSnapshotTime, SingleBlobVersionID +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Specifies the name of the container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies the Azure storage account from which you want to get a list of blobs. +You can use the New-AzStorageContext cmdlet to create a storage context. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ContinuationToken +Specifies a continuation token for the blob list. +Use this parameter and the *MaxCount* parameter to list blobs in multiple batches. + +```yaml +Type: Microsoft.Azure.Storage.Blob.BlobContinuationToken +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDeleted +Include Deleted Blob, by default get blob won't include deleted blob. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeTag +Include blob tags, by default get blob won't include blob tags. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeVersion +Blob versions will be listed only if this parameter is present, by default get blob won't include blob versions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BlobPrefix +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of objects that this cmdlet returns. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Prefix +Specifies a prefix for the blob names that you want to get. +This parameter does not support using regular expressions or wildcard characters to search. +This means that if the container has only blobs named "My", "MyBlob1", and "MyBlob2" and you specify "-Prefix My*", the cmdlet returns no blobs. +However, if you specify "-Prefix My", the cmdlet returns "My", "MyBlob1", and "MyBlob2". + +```yaml +Type: System.String +Parameter Sets: BlobPrefix +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the service side time-out interval, in seconds, for a request. +If the specified interval elapses before the service processes the request, the storage service returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnapshotTime +Blob SnapshotTime + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: SingleBlobSnapshotTime +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagCondition +Optional Tag expression statement to check match condition. +The blob request will fail when the blob tags does not match the given expression. +See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations. + +```yaml +Type: System.String +Parameter Sets: BlobName, SingleBlobSnapshotTime, SingleBlobVersionID +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VersionId +Blob VersionId + +```yaml +Type: System.String +Parameter Sets: SingleBlobVersionID +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob + +## NOTES + +## RELATED LINKS + +[Get-AzStorageBlobContent](./Get-AzStorageBlobContent.md) + +[Remove-AzStorageBlob](./Remove-AzStorageBlob.md) + +[Set-AzStorageBlobContent](./Set-AzStorageBlobContent.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageBlobByTag.md b/azps-10.1.0/Az.Storage/Get-AzStorageBlobByTag.md new file mode 100644 index 0000000000..6002e216c2 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageBlobByTag.md @@ -0,0 +1,256 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageblobbytag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobByTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobByTag.md +--- + +# Get-AzStorageBlobByTag + +## SYNOPSIS +Lists blobs in a storage account across containers, with a blob tag filter sql expression. + +## SYNTAX + +``` +Get-AzStorageBlobByTag -TagFilterSqlExpression <String> [-MaxCount <Int32>] + [-ContinuationToken <BlobContinuationToken>] [-GetBlobProperty] [-Container <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageBlobByTag** cmdlet lists blobs in a storage account across containers, with a blob tag filter sql expression. + +## EXAMPLES + +### Example 1: List all blobs match a specific blob tag, across containers. +```powershell +Get-AzStorageBlobByTag -TagFilterSqlExpression """tag1""='value1'" -Context $ctx +``` +```output + AccountName: storageaccountname, ContainerName: containername1 + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +testblob False +testblob2 False + + AccountName: storageaccountname, ContainerName: containername2 + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +testblob3 False +testblob4 False +``` + +This command lists all blobs in a storage account, which contains a tag with name "tag1" and value "value1". + +### Example 2: List blobs in a specific container and match a specific blob tag +```powershell +Get-AzStorageBlobByTag -Container 'containername' -TagFilterSqlExpression """tag1""='value1'" -Context $ctx +``` +```output + AccountName: storageaccountname, ContainerName: containername + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +test1 False +test2 False +``` + +This command lists blobs in a container and match a specific blob tag. + +### Example 3: List all blobs match a specific blob tag, across containers, and get the blob properties. +```powershell +Get-AzStorageBlobByTag -TagFilterSqlExpression """tag1""='value1'" -GetBlobProperty +``` +```output + AccountName: storageaccountname, ContainerName: containername1 + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +testblob BlockBlob 2097152 application/octet-stream 2020-07-23 09:35:02Z Hot False 2020-07-23T09:35:02.8527357Z * +testblob2 BlockBlob 1048012 application/octet-stream 2020-07-23 09:35:05Z Hot False 2020-07-23T09:35:05.2504530Z * + + AccountName: storageaccountname, ContainerName: containername2 + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +testblob3 BlockBlob 100 application/octet-stream 2020-07-01 09:55:14Z Hot False 2020-07-01T09:55:14.6507341Z * +testblob4 BlockBlob 2024 application/octet-stream 2020-07-01 09:42:11Z Hot False 2020-07-01T09:42:11.4283807Z * +``` + +This command lists all blobs in a storage account, which contains a tag with name "tag1" and value "value1"， and get the blob properties. +Please note, to get blob properties with parameter -GetBlobProperty, each blob will need an addtional request, so the cmdlet runs show when there are many blobs. + +## PARAMETERS + +### -ClientTimeoutPerRequest +The client side maximum execution time for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +The total amount of concurrent async tasks. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Container name, specify this parameter to only return all blobs whose tags match a search expression in the container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ContinuationToken +Continuation Token. + +```yaml +Type: Microsoft.Azure.Storage.Blob.BlobContinuationToken +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GetBlobProperty +As the blobs get by tag don't contain blob proeprties, specify tis parameter to get blob properties with an additional request on each blob. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCount +The max count of the blobs that can return. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +The server time out for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagFilterSqlExpression +Filters the result set to only include blobs whose tags match the specified expression. +See details in https://learn.microsoft.com/en-us/rest/api/storageservices/find-blobs-by-tags#remarks. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageBlobContent.md b/azps-10.1.0/Az.Storage/Get-AzStorageBlobContent.md new file mode 100644 index 0000000000..c0cf5394ef --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageBlobContent.md @@ -0,0 +1,404 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: C091D654-E113-4AE0-A6C8-24630D1294A4 +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageblobcontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobContent.md +--- + +# Get-AzStorageBlobContent + +## SYNOPSIS +Downloads a storage blob. + +## SYNTAX + +### ReceiveManual (Default) +``` +Get-AzStorageBlobContent [-Blob] <String> [-Container] <String> [-Destination <String>] [-CheckMd5] [-Force] + [-AsJob] [-TagCondition <String>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobPipeline +``` +Get-AzStorageBlobContent -CloudBlob <CloudBlob> [-BlobBaseClient <BlobBaseClient>] [-Destination <String>] + [-CheckMd5] [-Force] [-AsJob] [-TagCondition <String>] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ContainerPipeline +``` +Get-AzStorageBlobContent -CloudBlobContainer <CloudBlobContainer> [-Blob] <String> [-Destination <String>] + [-CheckMd5] [-Force] [-AsJob] [-TagCondition <String>] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UriPipeline +``` +Get-AzStorageBlobContent [-Destination <String>] -AbsoluteUri <String> [-Force] [-AsJob] + [-TagCondition <String>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageBlobContent** cmdlet downloads the specified storage blob. +If the blob name is not valid for the local computer, this cmdlet automatically resolves it if it is possible. + +## EXAMPLES + +### Example 1: Download blob content by name +```powershell +Get-AzStorageBlobContent -Container "ContainerName" -Blob "Blob" -Destination "C:\test\" +``` + +This command downloads a blob by name. + +### Example 2: Download blob content using the pipeline +```powershell +Get-AzStorageBlob -Container containername -Blob blobname | Get-AzStorageBlobContent +``` + +This command uses the pipeline to find and download blob content. + +### Example 3: Download blob content using the pipeline and a wildcard character +```powershell +Get-AzStorageContainer container* | Get-AzStorageBlobContent -Blob "cbox.exe" -Destination "C:\test" +``` + +This example uses the asterisk wildcard character and the pipeline to find and download blob content. + +### Example 4: Get a blob object and save it in a variable, then download blob content with the blob object +```powershell +$blob = Get-AzStorageBlob -Container containername -Blob blobname +Get-AzStorageBlobContent -CloudBlob $blob.ICloudBlob -Destination "C:\test" +``` + +This example first get a blob object and save it in a variable, then download blob content with the blob object. + +### Example 5: Download a blob content with blob Uri +```powershell +Get-AzStorageBlobContent -Uri $blobUri -Destination "C:\test" -Force +``` + +This example will download a blob content with Uri, the Uri can be a Uri with Sas token. +If the blob is on a managed disk account, and server requires a bearer token besides Sas Uri to download, the cmdlet will try to generate a bearer token with server returned audience and the login AAD user credentail, then download blob with both Sas Uri and bearer token. + +## PARAMETERS + +### -AbsoluteUri +Blob uri to download from. + +```yaml +Type: System.String +Parameter Sets: UriPipeline +Aliases: Uri, BlobUri + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Blob +Specifies the name of the blob to be downloaded. + +```yaml +Type: System.String +Parameter Sets: ReceiveManual, ContainerPipeline +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobBaseClient +BlobBaseClient Object + +```yaml +Type: Azure.Storage.Blobs.Specialized.BlobBaseClient +Parameter Sets: BlobPipeline +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CheckMd5 +Specifies whether to check the Md5 sum for the downloaded file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ReceiveManual, BlobPipeline, ContainerPipeline +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudBlob +Specifies a cloud blob. +To obtain a **CloudBlob** object, use the Get-AzStorageBlob cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlob +Parameter Sets: BlobPipeline +Aliases: ICloudBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CloudBlobContainer +Specifies a **CloudBlobContainer** object from the Azure storage client library. +You can create it or use the Get-AzStorageContainer cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlobContainer +Parameter Sets: ContainerPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Specifies the name of container that has the blob you want to download. + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies the Azure storage account from which you want to download blob content. +You can use the New-AzStorageContext cmdlet to create a storage context. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +Specifies the location to store the downloaded file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Path + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrites an existing file without confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the service side time-out interval, in seconds, for a request. +If the specified interval elapses before the service processes the request, the storage service returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagCondition +Optional Tag expression statement to check match condition. +The blob request will fail when the blob tags does not match the given expression. +See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Storage.Blob.CloudBlob + +### Microsoft.Azure.Storage.Blob.CloudBlobContainer + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob + +## NOTES +* If the blob name is invalid for local computer, this cmdlet autoresolves it, if it is possible. + +## RELATED LINKS + +[Set-AzStorageBlobContent](./Set-AzStorageBlobContent.md) + +[Get-AzStorageBlob](./Get-AzStorageBlob.md) + +[Remove-AzStorageBlob](./Remove-AzStorageBlob.md) diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageBlobCopyState.md b/azps-10.1.0/Az.Storage/Get-AzStorageBlobCopyState.md new file mode 100644 index 0000000000..2b1c14e800 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageBlobCopyState.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: CBD157D2-37C5-491F-A806-6B39F1D0415A +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageblobcopystate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobCopyState.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobCopyState.md +--- + +# Get-AzStorageBlobCopyState + +## SYNOPSIS +Gets the copy status of an Azure Storage blob. + +## SYNTAX + +### NamePipeline (Default) +``` +Get-AzStorageBlobCopyState [-Blob] <String> [-Container] <String> [-WaitForComplete] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +### BlobPipeline +``` +Get-AzStorageBlobCopyState -CloudBlob <CloudBlob> [-WaitForComplete] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +### ContainerPipeline +``` +Get-AzStorageBlobCopyState -CloudBlobContainer <CloudBlobContainer> [-Blob] <String> [-WaitForComplete] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageBlobCopyState** cmdlet gets the copy status of an Azure Storage blob. +It should run on the copy destination blob. + +## EXAMPLES + +### Example 1: Get the copy status of a blob +```powershell +Get-AzStorageBlobCopyState -Blob "ContosoPlanning2015" -Container "ContosoUploads" +``` + +This command gets the copy status of the blob named ContosoPlanning2015 in the container ContosoUploads. + +### Example 2: Get the copy status for of a blob by using the pipeline +```powershell +Get-AzStorageBlob -Blob "ContosoPlanning2015" -Container "ContosoUploads" | Get-AzStorageBlobCopyState +``` + +This command gets the blob named ContosoPlanning2015 in the container named ContosoUploads by using the **Get-AzStorageBlob** cmdlet, and then passes the result to the current cmdlet by using the pipeline operator. +The **Get-AzStorageBlobCopyState** cmdlet gets the copy status for that blob. + +### Example 3: Get the copy status for a blob in a container by using the pipeline +```powershell +Get-AzStorageContainer -Name "ContosoUploads" | Get-AzStorageBlobCopyState -Blob "ContosoPlanning2015" +``` + +This command gets the container named by using the **Get-AzStorageBlob** cmdlet, and then passes the result to the current cmdlet. +The **Get-AzStorageContainer** cmdlet gets the copy status for the blob named ContosoPlanning2015 in that container. + +### Example 4: Start Copy and pipeline to get the copy status +```powershell +$destBlob = Start-AzStorageBlobCopy -SrcContainer "contosouploads" -SrcBlob "ContosoPlanning2015" -DestContainer "contosouploads2" -DestBlob "ContosoPlanning2015_copy" + +$destBlob | Get-AzStorageBlobCopyState +``` + +The first command starts copy blob "ContosoPlanning2015" to "ContosoPlanning2015_copy", and output the destiantion blob object. +The second command pipeline the destiantion blob object to Get-AzStorageBlobCopyState, to get blob copy state. + +## PARAMETERS + +### -Blob +Specifies the name of a blob. +This cmdlet gets the state of the blob copy operation for the Azure Storage blob that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: NamePipeline, ContainerPipeline +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudBlob +Specifies a **CloudBlob** object from Azure Storage Client library. +To obtain a **CloudBlob** object, use the Get-AzStorageBlob cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlob +Parameter Sets: BlobPipeline +Aliases: ICloudBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CloudBlobContainer +Specifies a **CloudBlobContainer** object from the Azure Storage Client library. +This cmdlet gets the copy status of a blob in the container that this parameter specifies. +To obtain a **CloudBlobContainer** object, use the Get-AzStorageContainer cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlobContainer +Parameter Sets: ContainerPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Specifies the name of a container. +This cmdlet gets the copy status for a blob in the container that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: NamePipeline +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the service side time-out interval, in seconds, for a request. +If the specified interval elapses before the service processes the request, the storage service returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitForComplete +Indicates that this cmdlet waits for the copy to finish. +If you do not specify this parameter, this cmdlet returns a result immediately. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Storage.Blob.CloudBlob + +### Microsoft.Azure.Storage.Blob.CloudBlobContainer + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.Azure.Storage.Blob.CopyState + +## NOTES + +## RELATED LINKS + +[Start-AzStorageBlobCopy](./Start-AzStorageBlobCopy.md) + +[Stop-AzStorageBlobCopy](./Stop-AzStorageBlobCopy.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageBlobInventoryPolicy.md b/azps-10.1.0/Az.Storage/Get-AzStorageBlobInventoryPolicy.md new file mode 100644 index 0000000000..3888871b65 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageBlobInventoryPolicy.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageblobinventorypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobInventoryPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobInventoryPolicy.md +--- + +# Get-AzStorageBlobInventoryPolicy + +## SYNOPSIS +Gets blob inventory policy from a Storage account. + +## SYNTAX + +### AccountName (Default) +``` +Get-AzStorageBlobInventoryPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountResourceId +``` +Get-AzStorageBlobInventoryPolicy [-StorageAccountResourceId] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountObject +``` +Get-AzStorageBlobInventoryPolicy -StorageAccount <PSStorageAccount> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageBlobInventoryPolicy** cmdlet gets blob inventory policy from a Storage account. + +## EXAMPLES + +### Example 1: Get blob inventory policy from a Storage account +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $policy = Get-AzStorageBlobInventoryPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" + +PS C:\> $policy + +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegroup +Name : DefaultInventoryPolicy +Id : /subscriptions/{subscription-Id}/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount/inventoryPolicies/default +Type : Microsoft.Storage/storageAccounts/inventoryPolicies +LastModifiedTime : 11/4/2020 9:18:30 AM +Enabled : True +Rules : {Test1, Test2} + +PS C:\> $policy.Rules + +Name Enabled Destination ObjectType Format Schedule IncludeSnapshots IncludeBlobVersions BlobTypes PrefixMatch SchemaFields +---- ------- ----------- ---------- ------ -------- ---------------- ------------------- --------- ----------- ------------ +Test1 False containername Container Csv Daily {aaa, bbb} {Name, Metadata, PublicAccess, Last-Modified...} +Test2 True containername Blob Parquet Weekly True True {blockBlob, appendBlob} {ccc, ddd} {Name, Creation-Time, Last-Modified, Content-Length...} +``` + +This command gets blob inventory policy from a Storage account, and show its proeprties. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Storage Account Resource Id. + +```yaml +Type: System.String +Parameter Sets: AccountResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSBlobInventoryPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageBlobQueryResult.md b/azps-10.1.0/Az.Storage/Get-AzStorageBlobQueryResult.md new file mode 100644 index 0000000000..4c12d5ab47 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageBlobQueryResult.md @@ -0,0 +1,411 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/Az.storage/get-azstorageblobqueryresult +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobQueryResult.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobQueryResult.md +--- + +# Get-AzStorageBlobQueryResult + +## SYNOPSIS +Applies a simple Structured Query Language (SQL) statement on a blob's contents and save only the queried subset of the data to a local file. + +## SYNTAX + +### NamePipeline (Default) +``` +Get-AzStorageBlobQueryResult [-Blob] <String> [-Container] <String> [-SnapshotTime <DateTimeOffset>] + [-VersionId <String>] -QueryString <String> -ResultFile <String> + [-InputTextConfiguration <PSBlobQueryTextConfiguration>] + [-OutputTextConfiguration <PSBlobQueryTextConfiguration>] [-PassThru] [-Force] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BlobPipeline +``` +Get-AzStorageBlobQueryResult -BlobBaseClient <BlobBaseClient> -QueryString <String> -ResultFile <String> + [-InputTextConfiguration <PSBlobQueryTextConfiguration>] + [-OutputTextConfiguration <PSBlobQueryTextConfiguration>] [-PassThru] [-Force] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ContainerPipeline +``` +Get-AzStorageBlobQueryResult -BlobContainerClient <BlobContainerClient> [-Blob] <String> + [-SnapshotTime <DateTimeOffset>] [-VersionId <String>] -QueryString <String> -ResultFile <String> + [-InputTextConfiguration <PSBlobQueryTextConfiguration>] + [-OutputTextConfiguration <PSBlobQueryTextConfiguration>] [-PassThru] [-Force] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageBlobQueryResult** cmdlet applies a simple Structured Query Language (SQL) statement on a blob's contents and save the queried subset of the data to a local file. + +## EXAMPLES + +### Example 1: Query a blob +```powershell +$inputconfig = New-AzStorageBlobQueryConfig -AsCsv -HasHeader + +$outputconfig = New-AzStorageBlobQueryConfig -AsJson + +$queryString = "SELECT * FROM BlobStorage WHERE Name = 'a'" + +$result = Get-AzStorageBlobQueryResult -Container $containerName -Blob $blobName -QueryString $queryString -ResultFile "c:\resultfile.json" -InputTextConfiguration $inputconfig -OutputTextConfiguration $outputconfig -Context $ctx + +$result +``` + +```output +BytesScanned FailureCount BlobQueryError +------------ ------------ -------------- + 449 0 +``` + +This command querys a blob succsssfully with input config as csv, and output config as json, and save the output to local file "c:\resultfile.json". + +### Example 2: Query a blob snapshot +<!-- Skip: Output cannot be splitted from code --> +```powershell +PS C:\> $blob = Get-AzStorageBlob -Container $containerName -Blob $blobName -SnapshotTime "2020-07-29T11:08:21.1097874Z" -Context $ctx + +PS C:\> $inputconfig = New-AzStorageBlobQueryConfig -AsCsv -ColumnSeparator "," -QuotationCharacter """" -EscapeCharacter "\" -RecordSeparator "`n" -HasHeader + +PS C:\> $outputconfig = New-AzStorageBlobQueryConfig -AsJson -RecordSeparator "`n" + +PS C:\> $queryString = "SELECT * FROM BlobStorage WHERE _1 LIKE '1%%'" + +PS C:\> $result = $blob | Get-AzStorageBlobQueryResult -QueryString $queryString -ResultFile $localFilePath -InputTextConfiguration $inputconfig -OutputTextConfiguration $outputconfig + +PS C:\> $result + +BytesScanned FailureCount BlobQueryError +------------ ------------ -------------- + 187064971 1 {ParseError} + + + +PS C:\> $result.BlobQueryError + +Name Description IsFatal Position +---- ----------- ------- -------- +ParseError Unexpected token '1' at [byte: 3077737]. Expecting token ','. True 7270632 +``` + +This command first gets a blob object for blob snapshot, then queries the blob snapshot and show the result include query error. + +## PARAMETERS + +### -Blob +Blob name + +```yaml +Type: System.String +Parameter Sets: NamePipeline, ContainerPipeline +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobBaseClient +BlobBaseClient Object + +```yaml +Type: Azure.Storage.Blobs.Specialized.BlobBaseClient +Parameter Sets: BlobPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BlobContainerClient +BlobContainerClient Object + +```yaml +Type: Azure.Storage.Blobs.BlobContainerClient +Parameter Sets: ContainerPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +The client side maximum execution time for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +The total amount of concurrent async tasks. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Container name + +```yaml +Type: System.String +Parameter Sets: NamePipeline +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force to overwrite the existing file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputTextConfiguration +The configuration used to handled the query input text. Create configuration object the with New-AzStorageBlobQueryConfig. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.PSBlobQueryTextConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputTextConfiguration +The configuration used to handled the query output text. Create configuration object the with New-AzStorageBlobQueryConfig. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.PSBlobQueryTextConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified blob is successfully queried. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueryString +Query string, see more details in: https://learn.microsoft.com/azure/storage/blobs/query-acceleration-sql-reference + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultFile +Local file path to save the query result. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +The server time out for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnapshotTime +Blob SnapshotTime + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: NamePipeline, ContainerPipeline +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VersionId +Blob VersionId + +```yaml +Type: System.String +Parameter Sets: NamePipeline, ContainerPipeline +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Azure.Storage.Blobs.Specialized.BlobBaseClient + +### Azure.Storage.Blobs.BlobContainerClient + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageBlobServiceProperty.md b/azps-10.1.0/Az.Storage/Get-AzStorageBlobServiceProperty.md new file mode 100644 index 0000000000..033feb2079 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageBlobServiceProperty.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageblobserviceproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobServiceProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobServiceProperty.md +--- + +# Get-AzStorageBlobServiceProperty + +## SYNOPSIS +Gets service properties for Azure Storage Blob services. + +## SYNTAX + +### AccountName (Default) +``` +Get-AzStorageBlobServiceProperty [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountObject +``` +Get-AzStorageBlobServiceProperty -StorageAccount <PSStorageAccount> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### BlobServicePropertiesResourceId +``` +Get-AzStorageBlobServiceProperty [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageBlobServiceProperty** cmdlet gets the service properties for Azure Storage Blob services. + +## EXAMPLES + +### Example 1: Get Azure Storage Blob services property of a specified Storage Account +```powershell +Get-AzStorageBlobServiceProperty -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" +``` +```output +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegroup +DefaultServiceVersion : +DeleteRetentionPolicy.Enabled : False +DeleteRetentionPolicy.Days : +RestorePolicy.Enabled : +RestorePolicy.Days : +ChangeFeed : True +IsVersioningEnabled : True +``` + +This command gets the Blob services property of a specified Storage Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Blob Service Properties Resource Id. + +```yaml +Type: System.String +Parameter Sets: BlobServicePropertiesResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSBlobServiceProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageBlobTag.md b/azps-10.1.0/Az.Storage/Get-AzStorageBlobTag.md new file mode 100644 index 0000000000..dc101a5417 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageBlobTag.md @@ -0,0 +1,276 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageblobtag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageBlobTag.md +--- + +# Get-AzStorageBlobTag + +## SYNOPSIS +Get blob tags of a specific blob. + +## SYNTAX + +### NamePipeline (Default) +``` +Get-AzStorageBlobTag [-Blob] <String> [-Container] <String> [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BlobPipeline +``` +Get-AzStorageBlobTag -BlobBaseClient <BlobBaseClient> [-TagCondition <String>] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ContainerPipeline +``` +Get-AzStorageBlobTag -CloudBlobContainer <CloudBlobContainer> [-Blob] <String> [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageBlobTag** gets blob tags of a specific blob. + +## EXAMPLES + +### Example 1: Get blob tags on a specific blob +```powershell +Get-AzStorageBlobTag -Container "containername" -Blob testblob +``` +```output +Name Value +---- ----- +tag1 value1 +tag2 value2 +``` + +This command gets blob tags on a specific blob. + +### Example 2: Get blob tags on a specific blob with tag condition +```powershell +Get-AzStorageBlobTag -Container "containername" -Blob testblob -TagCondition """tag1""='value1'" +``` +```output +Name Value +---- ----- +tag1 value1 +tag2 value2 +``` + +This command gets blob tags on a specific blob with tag condition. +The cmdlet will only success when the blob contains a tag with name "tag1" and value "value1", else the cmdlet will fail with error code 412. + +## PARAMETERS + +### -Blob +Blob name + +```yaml +Type: System.String +Parameter Sets: NamePipeline, ContainerPipeline +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobBaseClient +BlobBaseClient Object + +```yaml +Type: Azure.Storage.Blobs.Specialized.BlobBaseClient +Parameter Sets: BlobPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +The client side maximum execution time for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudBlobContainer +CloudBlobContainer Object + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlobContainer +Parameter Sets: ContainerPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +The total amount of concurrent async tasks. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Container name + +```yaml +Type: System.String +Parameter Sets: NamePipeline +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +The server time out for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagCondition +Optional Tag expression statement to check match condition. +The blob request will fail when the blob tags does not match the given expression. +See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Azure.Storage.Blobs.Specialized.BlobBaseClient + +### Microsoft.Azure.Storage.Blob.CloudBlobContainer + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Collections.Hashtable + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageCORSRule.md b/azps-10.1.0/Az.Storage/Get-AzStorageCORSRule.md new file mode 100644 index 0000000000..cd5fae097a --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageCORSRule.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 5FA8A3F3-F52C-40BC-94C2-4CDA00C6F32F +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragecorsrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageCORSRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageCORSRule.md +--- + +# Get-AzStorageCORSRule + +## SYNOPSIS +Gets CORS rules for a Storage service type. + +## SYNTAX + +``` +Get-AzStorageCORSRule [-ServiceType] <StorageServiceType> [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageCORSRule** cmdlet gets Cross-Origin Resource Sharing (CORS) rules for an Azure Storage service type. + +## EXAMPLES + +### Example 1: Get CORS rules of blob service +```powershell +Get-AzStorageCORSRule -ServiceType Blob +``` + +This command gets the CORS rules for the Blob service type. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure Storage context. +To obtain a context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceType +Specifies the Azure Storage service type for which this cmdlet gets CORS rules. +The acceptable values for this parameter are: +- Blob +- Table +- Queue +- File + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType +Parameter Sets: (All) +Aliases: +Accepted values: Blob, Table, Queue, File + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSCorsRule + +## NOTES + +## RELATED LINKS + +[Remove-AzStorageCORSRule](./Remove-AzStorageCORSRule.md) + +[Set-AzStorageCORSRule](./Set-AzStorageCORSRule.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageContainer.md b/azps-10.1.0/Az.Storage/Get-AzStorageContainer.md new file mode 100644 index 0000000000..b64f1b0c4c --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageContainer.md @@ -0,0 +1,275 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 90C3DF13-0010-49B6-A8CD-C6AC34BC3EFA +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragecontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageContainer.md +--- + +# Get-AzStorageContainer + +## SYNOPSIS +Lists the storage containers. + +## SYNTAX + +### ContainerName (Default) +``` +Get-AzStorageContainer [[-Name] <String>] [-MaxCount <Int32>] [-ContinuationToken <BlobContinuationToken>] + [-IncludeDeleted] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [<CommonParameters>] +``` + +### ContainerPrefix +``` +Get-AzStorageContainer -Prefix <String> [-MaxCount <Int32>] [-ContinuationToken <BlobContinuationToken>] + [-IncludeDeleted] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageContainer** cmdlet lists the storage containers associated with the storage account in Azure. + +## EXAMPLES + +### Example 1: Get Azure Storage container by name +```powershell +Get-AzStorageContainer -Name container* +``` + +This example uses a wildcard character to return a list of all containers with a name that starts with container. + +### Example 2: Get Azure Storage container by container name prefix +```powershell +Get-AzStorageContainer -Prefix "container" +``` + +This example uses the *Prefix* parameter to return a list of all containers with a name that starts with container. + +### Example 3: List Azure Storage container, include deleted containers +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $containers = Get-AzStorageContainer -IncludeDeleted -Context $ctx + +PS C:\> $containers + + Storage Account Name: storageaccountname + +Name PublicAccess LastModified IsDeleted VersionId +---- ------------ ------------ --------- --------- +testcon Off 8/28/2020 10:18:13 AM +00:00 +testcon2 9/4/2020 12:52:37 PM +00:00 True 01D67D248986B6DA + +PS C:\> $c[1].BlobContainerProperties + +LastModified : 9/4/2020 12:52:37 PM +00:00 +LeaseStatus : Unlocked +LeaseState : Expired +LeaseDuration : +PublicAccess : +HasImmutabilityPolicy : False +HasLegalHold : False +DefaultEncryptionScope : $account-encryption-key +PreventEncryptionScopeOverride : False +DeletedOn : 9/8/2020 4:29:59 AM +00:00 +RemainingRetentionDays : 299 +ETag : "0x8D850D167059285" +Metadata : {} +``` + +This example lists all containers of a storage account, include deleted containers. +Then show the deleted container properties, include : DeletedOn, RemainingRetentionDays. +Deleted containers will only exist after enabled Container softdelete with Enable-AzStorageBlobDeleteRetentionPolicy. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies the storage context. +To create it, you can use the New-AzStorageContext cmdlet. +The container permissions won't be retrieved when you use a storage context created from SAS Token, because query container permissions requires Storage account key permission. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ContinuationToken +Specifies a continuation token for the blob list. + +```yaml +Type: Microsoft.Azure.Storage.Blob.BlobContinuationToken +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDeleted +Include deleted containers, by default list containers won't include deleted containers + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of objects that this cmdlet returns. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the container name. +If container name is empty, the cmdlet lists all the containers. +Otherwise, it lists all containers that match the specified name or the regular name pattern. + +```yaml +Type: System.String +Parameter Sets: ContainerName +Aliases: N, Container + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Prefix +Specifies a prefix used in the name of the container or containers you want to get. +You can use this to find all containers that start with the same string, such as "my" or "test". + +```yaml +Type: System.String +Parameter Sets: ContainerPrefix +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the service side time-out interval, in seconds, for a request. +If the specified interval elapses before the service processes the request, the storage service returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageContainer + +## NOTES + +## RELATED LINKS + +[New-AzStorageContainer](./New-AzStorageContainer.md) + +[Remove-AzStorageContainer](./Remove-AzStorageContainer.md) + +[Set-AzStorageContainerAcl](./Set-AzStorageContainerAcl.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageContainerStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/Get-AzStorageContainerStoredAccessPolicy.md new file mode 100644 index 0000000000..6e7c51a1aa --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageContainerStoredAccessPolicy.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 10D5B7E0-242B-4DC0-A527-8F6388E72E0A +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragecontainerstoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageContainerStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageContainerStoredAccessPolicy.md +--- + +# Get-AzStorageContainerStoredAccessPolicy + +## SYNOPSIS +Gets the stored access policy or policies for an Azure storage container. + +## SYNTAX + +``` +Get-AzStorageContainerStoredAccessPolicy [-Container] <String> [[-Policy] <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageContainerStoredAccessPolicy** cmdlet lists the stored access policy or policies for an Azure storage container. + +## EXAMPLES + +### Example 1: Get a stored access policy in a storage container +```powershell +Get-AzStorageContainerStoredAccessPolicy -Container "Container07" -Policy "Policy22" +``` + +This command gets the access policy named Policy22 in the storage container named Container07. + +### Example 2: Get all the stored access policies in a storage container +```powershell +Get-AzStorageContainerStoredAccessPolicy -Container "Container07" +``` + +This command gets all access policies in the storage container named Container07. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Specifies the name of your Azure storage container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Context +Specifies the Azure storage context. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the Azure stored access policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the service side time-out interval, in seconds, for a request. +If the specified interval elapses before the service processes the request, the storage service returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.Azure.Storage.Blob.SharedAccessBlobPolicy + +## NOTES + +## RELATED LINKS + +[New-AzStorageContainerStoredAccessPolicy](./New-AzStorageContainerStoredAccessPolicy.md) + +[Remove-AzStorageContainerStoredAccessPolicy](./Remove-AzStorageContainerStoredAccessPolicy.md) + +[Set-AzStorageContainerStoredAccessPolicy](./Set-AzStorageContainerStoredAccessPolicy.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageEncryptionScope.md b/azps-10.1.0/Az.Storage/Get-AzStorageEncryptionScope.md new file mode 100644 index 0000000000..9e2065dd5e --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageEncryptionScope.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageencryptionscope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageEncryptionScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageEncryptionScope.md +--- + +# Get-AzStorageEncryptionScope + +## SYNOPSIS +Get or list encryption scopes from a Storage account. + +## SYNTAX + +### AccountName (Default) +``` +Get-AzStorageEncryptionScope [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-EncryptionScopeName <String>] [-MaxPageSize <Int32>] [-Filter <String>] [-Include <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountObject +``` +Get-AzStorageEncryptionScope -StorageAccount <PSStorageAccount> [-EncryptionScopeName <String>] + [-MaxPageSize <Int32>] [-Filter <String>] [-Include <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageEncryptionScope** cmdlet gets or lists encryption scopes from a Storage account. + +## EXAMPLES + +### Example 1: Get a single encryption scope +```powershell +Get-AzStorageEncryptionScope -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -EncryptionScopeName $scopename +``` +```output + + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name State Source KeyVaultKeyUri +---- ----- ------ -------------- +testscope Disabled Microsoft.Keyvault https://keyvalutname.vault.azure.net:443/keys/keyname +``` + +This command gets a single encryption scope. + +### Example 2: List all encryption scopes of a Storage account +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> Get-AzStorageEncryptionScope -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" + + + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name State Source KeyVaultKeyUri +---- ----- ------ -------------- +testscope Disabled Microsoft.Keyvault https://keyvalutname.vault.azure.net:443/keys/keyname +scope2 Enabled Microsoft.Storage +``` + +This command lists all encryption scopes of a Storage account. + +### Example 3: List all enabled encryption scopes of a Storage account with a max page size of 10 for each request +```powershell +Get-AzStorageEncryptionScope -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -MaxPageSize 10 -Include Enabled +``` + +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name State Source KeyVaultKeyUri +---- ----- ------ -------------- +scope1 Enabled Microsoft.Keyvault https://keyvalutname.vault.azure.net:443/keys/keyname +scope2 Enabled Microsoft.Storage +``` +This command lists all enabled encryption scopes of a Storage account, with a max page size of 10 encryption scopes included in each list response. +If there are more than 10 encryption scopes to be listed, the command will still list all the encryption scopes, but with multiple requests sent and responses received. + +### Example 4: List all disabled encryption scopes with names starting with "test" of a Storage account +```powershell +Get-AzStorageEncryptionScope -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -Include Disabled -Filter "startswith(name, test)" +``` + +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name State Source KeyVaultKeyUri +---- ----- ------ -------------- +testscope1 Disabled Microsoft.Keyvault https://keyvalutname.vault.azure.net:443/keys/keyname +testscope2 Disabled Microsoft.Storage +``` +This command lists all disabled encryption scopes with names starting with "test" of a Storage account. +The parameter "Filter" specifies the prefix of the encryption scopes listed, and it should be in format of "startswith(name, {prefixValue})". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionScopeName +Azure Storage EncryptionScope name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter of encryption scope name. When specified, only encryption scope names starting with the filter will be listed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Include +The filter of encryption scope name. When specified, only encryption scope names starting with the filter will be listed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: All, Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPageSize +The maximum number of encryption scopes that will be included in the list response + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSEncryptionScope + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageFile.md b/azps-10.1.0/Az.Storage/Get-AzStorageFile.md new file mode 100644 index 0000000000..ebbdc160ac --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageFile.md @@ -0,0 +1,262 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 38207027-FD76-45EE-8817-88599735C0B0 +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragefile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageFile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageFile.md +--- + +# Get-AzStorageFile + +## SYNOPSIS +Lists directories and files for a path. + +## SYNTAX + +### ShareName (Default) +``` +Get-AzStorageFile [-ShareName] <String> [[-Path] <String>] [-ExcludeExtendedInfo] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +### Share +``` +Get-AzStorageFile [-Share] <CloudFileShare> [[-Path] <String>] [-ExcludeExtendedInfo] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +### Directory +``` +Get-AzStorageFile [-Directory] <CloudFileDirectory> [[-Path] <String>] [-ExcludeExtendedInfo] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageFile** cmdlet lists directories and files for the share or directory that you specify. +Specify the *Path* parameter to get an instance of a directory or file in the specified path. +This cmdlet returns **AzureStorageFile** and **AzureStorageDirectory** objects. +You can use the **IsDirectory** property to distinguish between folders and files. + +## EXAMPLES + +### Example 1: List directories in a share +```powershell +Get-AzStorageFile -ShareName "ContosoShare06" | Where-Object {$_.GetType().Name -eq "AzureStorageFileDirectory"} +``` + +This command lists only the directories in the share ContosoShare06. +It first retrieves both files and directories, passes them to the **where** operator by using the pipeline operator, then discards any objects whose type is not "AzureStorageFileDirectory". + +### Example 2: List a File Directory +```powershell +Get-AzStorageFile -ShareName "ContosoShare06" -Path "ContosoWorkingFolder" | Get-AzStorageFile +``` + +This command lists the files and folders in the directory ContosoWorkingFolder under the share ContosoShare06. +It first gets the directory instance, and then pipelines it to the **Get-AzStorageFile** cmdlet to list the directory. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client side time-out interval, in seconds, for one service request. +If the previous call fails within the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help mitigate network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure Storage context. +To obtain a Storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Directory +Specifies a folder as a **CloudFileDirectory** object. +This cmdlet gets the folder that this parameter specifies. +To obtain a directory, use the New-AzStorageDirectory cmdlet. +You can also use the **Get-AzStorageFile** cmdlet to obtain a directory. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileDirectory +Parameter Sets: Directory +Aliases: CloudFileDirectory + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ExcludeExtendedInfo +Not include extended file info like timestamps, ETag, attributes, permissionKey in list file and Directory. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the path of a folder. +If you omit the *Path* parameter, **Get-AzStorageFile** lists the directories and files in the specified file share or directory. +If you include the *Path* parameter, **Get-AzStorageFile** returns an instance of a directory or file in the specified path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the service-side timeout interval, in seconds, for a request. +If the specified interval elapses before the service processes the request, the Storage service returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Share +Specifies a **CloudFileShare** object. +This cmdlet gets a file or directory from the file share that this parameter specifies. +To obtain a **CloudFileShare** object, use the Get-AzStorageShare cmdlet. +This object contains the Storage context. +If you specify this parameter, do not specify the *Context* parameter. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileShare +Parameter Sets: Share +Aliases: CloudFileShare + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareName +Specifies the name of the file share. +This cmdlet gets a file or directory from the file share that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Storage.File.CloudFileShare + +### Microsoft.Azure.Storage.File.CloudFileDirectory + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFile + +## NOTES + +## RELATED LINKS + +[Get-AzStorageFileContent](./Get-AzStorageFileContent.md) + +[New-AzStorageDirectory](./New-AzStorageDirectory.md) + +[Remove-AzStorageDirectory](./Remove-AzStorageDirectory.md) + +[Remove-AzStorageFile](./Remove-AzStorageFile.md) + +[Set-AzStorageFileContent](./Set-AzStorageFileContent.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageFileContent.md b/azps-10.1.0/Az.Storage/Get-AzStorageFileContent.md new file mode 100644 index 0000000000..7de501b0ce --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageFileContent.md @@ -0,0 +1,395 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 6420CBE1-BF9D-493D-BCA8-E8C6688FAF3B +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragefilecontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageFileContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageFileContent.md +--- + +# Get-AzStorageFileContent + +## SYNOPSIS +Downloads the contents of a file. + +## SYNTAX + +### ShareName (Default) +``` +Get-AzStorageFileContent [-ShareName] <String> [-Path] <String> [[-Destination] <String>] [-CheckMd5] + [-PassThru] [-Force] [-AsJob] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [-PreserveSMBAttribute] [<CommonParameters>] +``` + +### Share +``` +Get-AzStorageFileContent [-Share] <CloudFileShare> [-Path] <String> [[-Destination] <String>] [-CheckMd5] + [-PassThru] [-Force] [-AsJob] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [-PreserveSMBAttribute] [<CommonParameters>] +``` + +### Directory +``` +Get-AzStorageFileContent [-Directory] <CloudFileDirectory> [-Path] <String> [[-Destination] <String>] + [-CheckMd5] [-PassThru] [-Force] [-AsJob] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [-PreserveSMBAttribute] [<CommonParameters>] +``` + +### File +``` +Get-AzStorageFileContent [-File] <CloudFile> [[-Destination] <String>] [-CheckMd5] [-PassThru] [-Force] + [-AsJob] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [-PreserveSMBAttribute] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageFileContent** cmdlet downloads the contents of a file, and then saves it to a destination that you specify. +This cmdlet does not return the contents of the file. + +## EXAMPLES + +### Example 1: Download a file from a folder +```powershell +Get-AzStorageFileContent -ShareName "ContosoShare06" -Path "ContosoWorkingFolder/CurrentDataFile" +``` + +This command downloads a file that is named CurrentDataFile in the folder ContosoWorkingFolder from the file share ContosoShare06 to current folder. + +### Example 2: Downloads the files under sample file share +```powershell +Get-AzStorageFile -ShareName sample | Where-Object {$_.GetType().Name -eq "CloudFile"} | Get-AzStorageFileContent +``` + +This example downloads the files under sample file share + +### Example 3: Download an Azure file to a local file, and perserve the Azure File SMB properties (File Attributtes, File Creation Time, File Last Write Time) in the local file. +```powershell +Get-AzStorageFileContent -ShareName sample -Path "dir1/file1" -Destination $localFilePath -PreserveSMBAttribute +``` + +This example downloads an Azure file to a local file, and perserves the Azure File SMB properties (File Attributtes, File Creation Time, File Last Write Time) in the local file. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CheckMd5 +Specifies whether to check the Md5 sum for the downloaded file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. If the previous call fails in the specified interval, this cmdlet retries the request. If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. The specified value is an absolute count and is not multiplied by the core count. This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure Storage context. To obtain a context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: ShareName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +Specifies the destination path. +This cmdlet downloads the file contents to the location that this parameter specifies. +If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. +If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. +If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. +If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Directory +Specifies a folder as a **CloudFileDirectory** object. +This cmdlet gets content for a file in the folder that this parameter specifies. +To obtain a directory, use the New-AzStorageDirectory cmdlet. +You can also use the Get-AzStorageFile cmdlet to obtain a directory. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileDirectory +Parameter Sets: Directory +Aliases: CloudFileDirectory + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -File +Specifies a file as a **CloudFile** object. +This cmdlet gets the file that this parameter specifies. +To obtain a **CloudFile** object, use the Get-AzStorageFile cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFile +Parameter Sets: File +Aliases: CloudFile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Force +If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. +If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. +If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. +If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns the **AzureStorageFile** object that it downloads. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the path of a file. +This cmdlet gets the contents the file that this parameter specifies. +If the file does not exist, this cmdlet returns an error. + +```yaml +Type: System.String +Parameter Sets: ShareName, Share, Directory +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreserveSMBAttribute +Keep the source File SMB properties (File Attributtes, File Creation Time, File Last Write Time) in destination File. This parameter is only available on Windows. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the service side time-out interval, in seconds, for a request. If the specified interval elapses before the service processes the request, the storage service returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Share +Specifies a **CloudFileShare** object. +This cmdlet downloads the contents of the file in the share this parameter specifies. +To obtain a **CloudFileShare** object, use the Get-AzStorageShare cmdlet. +This object contains the storage context. +If you specify this parameter, do not specify the *Context* parameter. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileShare +Parameter Sets: Share +Aliases: CloudFileShare + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareName +Specifies the name of the file share. +This cmdlet downloads the contents of the file in the share this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Storage.File.CloudFileShare + +### Microsoft.Azure.Storage.File.CloudFileDirectory + +### Microsoft.Azure.Storage.File.CloudFile + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFile + +## NOTES + +## RELATED LINKS + +[Get-AzStorageFile](./Get-AzStorageFile.md) + +[Set-AzStorageFileContent](./Set-AzStorageFileContent.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageFileCopyState.md b/azps-10.1.0/Az.Storage/Get-AzStorageFileCopyState.md new file mode 100644 index 0000000000..96586ad83a --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageFileCopyState.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: C1648DC3-8CFD-4487-A080-D9BE25DAD258 +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragefilecopystate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageFileCopyState.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageFileCopyState.md +--- + +# Get-AzStorageFileCopyState + +## SYNOPSIS +Gets the state of a copy operation. + +## SYNTAX + +### ShareName +``` +Get-AzStorageFileCopyState [-ShareName] <String> [-FilePath] <String> [-WaitForComplete] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +### File +``` +Get-AzStorageFileCopyState [-File] <CloudFile> [-WaitForComplete] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageFileCopyState** cmdlet gets the state of an Azure Storage file copy operation. +It should run on the copy destination file. + +## EXAMPLES + +### Example 1: Get the copy state by file name +```powershell +Get-AzStorageFileCopyState -ShareName "ContosoShare" -FilePath "ContosoFile" +``` + +This command gets the state of the copy operation for a file that has the specified name. + +### Example 2: Start Copy and pipeline to get the copy status +```powershell +$destfile = Start-AzStorageFileCopy -SrcShareName "contososhare" -SrcFilePath "contosofile" -DestShareName "contososhare2" -destfilepath "contosofile_copy" + +$destfile | Get-AzStorageFileCopyState +``` + +The first command starts copy file "contosofile" to "contosofile_copy", and output the destiantion file object. +The second command pipeline the destiantion file object to Get-AzStorageFileCopyState, to get file copy state. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure Storage context. +To obtain a context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +Specifies a **CloudFile** object. +You can create a cloud file or obtain one by using the Get-AzStorageFile cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFile +Parameter Sets: File +Aliases: CloudFile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -FilePath +Specifies the path of the file relative to an Azure Storage share. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +Specifies the name of a share. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitForComplete +Indicates that this cmdlet waits for the copy to finish. +If you do not specify this parameter, this cmdlet returns a result immediately. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Storage.File.CloudFile + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.Azure.Storage.File.CopyState + +## NOTES + +## RELATED LINKS + +[Get-AzStorageFile](./Get-AzStorageFile.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[Start-AzStorageFileCopy](./Start-AzStorageFileCopy.md) + +[Stop-AzStorageFileCopy](./Stop-AzStorageFileCopy.md) diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageFileHandle.md b/azps-10.1.0/Az.Storage/Get-AzStorageFileHandle.md new file mode 100644 index 0000000000..523d5f6307 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageFileHandle.md @@ -0,0 +1,330 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragefilehandle +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageFileHandle.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageFileHandle.md +--- + +# Get-AzStorageFileHandle + +## SYNOPSIS +Lists file handles of a file share, a file directory or a file. + +## SYNTAX + +### ShareName (Default) +``` +Get-AzStorageFileHandle [-ShareName] <String> [[-Path] <String>] [-Recursive] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-IncludeTotalCount] + [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] +``` + +### Share +``` +Get-AzStorageFileHandle [-Share] <CloudFileShare> [[-Path] <String>] [-Recursive] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-IncludeTotalCount] + [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] +``` + +### Directory +``` +Get-AzStorageFileHandle [-Directory] <CloudFileDirectory> [[-Path] <String>] [-Recursive] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-IncludeTotalCount] + [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] +``` + +### File +``` +Get-AzStorageFileHandle [-File] <CloudFile> [-Recursive] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageFileHandle** cmdlet lists file handles of a file share, or file directory or a file. + +## EXAMPLES + +### Example 1: List all file handles on a file share recursively, and sort by ClientIp and OpenTime +```powershell +Get-AzStorageFileHandle -ShareName "mysharename" -Recursive | Sort-Object ClientIP,OpenTime +``` +```output +HandleId Path ClientIp ClientPort OpenTime LastReconnectTime FileId ParentId SessionId +-------- ---- -------- ---------- -------- ----------------- ------ -------- --------- +28506980357 104.46.105.229 49805 2019-07-29 08:37:36Z 0 0 9297571480349046273 +28506980537 dir1 104.46.105.229 49805 2019-07-30 09:28:48Z 10376363910205800448 0 9297571480349046273 +28506980538 dir1 104.46.105.229 49805 2019-07-30 09:28:48Z 10376363910205800448 0 9297571480349046273 +28582543365 104.46.119.170 51675 2019-07-30 09:29:32Z 0 0 9477733061320772929 +28582543375 dir1 104.46.119.170 51675 2019-07-30 09:29:38Z 10376363910205800448 0 9477733061320772929 +28582543376 dir1 104.46.119.170 51675 2019-07-30 09:29:38Z 10376363910205800448 0 9477733061320772929 +``` + +This command lists file handles on a file share, and sort the output by ClientIp, then by OpenTime. + +### Example 2: List first 2 file handles on a file directory recursively +```powershell +Get-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2' -Recursive -First 2 +``` +```output +HandleId Path ClientIp ClientPort OpenTime LastReconnectTime FileId ParentId SessionId +-------- ---- -------- ---------- -------- ----------------- ------ -------- --------- +24057151779 dir1/dir2 104.46.105.229 50861 2019-06-18 07:39:23Z 16140971433240035328 11529285414812647424 9549812641162070049 +24057151780 dir1/dir2 104.46.105.229 50861 2019-06-18 07:39:23Z 16140971433240035328 11529285414812647424 9549812641162070049 +``` + +This command lists first 2 file handles on a file directory recursively . + +### Example 3: List the 3rd to the 6th file handles on a file +```powershell +Get-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2/test.txt' -skip 2 -First 4 +``` +```output +HandleId Path ClientIp ClientPort OpenTime LastReconnectTime FileId ParentId SessionId +-------- ---- -------- ---------- -------- ----------------- ------ -------- --------- +24055513248 dir1/dir2/test.txt 104.46.105.229 49817 2019-06-18 08:21:59Z 9223407221226864640 16140971433240035328 9338416139169958321 +24055513249 dir1/dir2/test.txt 104.46.105.229 49817 2019-06-18 08:21:59Z 9223407221226864640 16140971433240035328 9338416139169958321 +24055513252 dir1/dir2/test.txt 104.46.105.229 49964 2019-06-18 08:22:54Z 9223407221226864640 16140971433240035328 9338416138431762125 +24055513253 dir1/dir2/test.txt 104.46.105.229 49964 2019-06-18 08:22:54Z 9223407221226864640 16140971433240035328 9338416138431762125 +``` + +This command lists the 3rd to the 6th file handles on a file. + +## PARAMETERS + +### -ClientTimeoutPerRequest +The client side maximum execution time for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +The total amount of concurrent async tasks. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: ShareName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Directory +CloudFileDirectory object indicated the base folder where the files/directories would be listed. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileDirectory +Parameter Sets: Directory +Aliases: CloudFileDirectory + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -File +CloudFile object indicated the file to list File Handles. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFile +Parameter Sets: File +Aliases: CloudFile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Path +Path to an existing file/directory. + +```yaml +Type: System.String +Parameter Sets: ShareName, Share, Directory +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recursive +List handles Recursively. +Only works on File Directory. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +The server time out for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Share +CloudFileShare object indicated the share where the files/directories would be listed. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileShare +Parameter Sets: Share +Aliases: CloudFileShare + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareName +Name of the file share where the files/directories would be listed. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeTotalCount +Reports the number of objects in the data set (an integer) followed by the objects. If the cmdlet cannot determine the total count, it returns 'Unknown total count'. +Currently, this parameter does nothing. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Ignores the first 'n' objects and then gets the remaining objects. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Gets only the first 'n' objects. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Storage.File.CloudFileShare + +### Microsoft.Azure.Storage.File.CloudFileDirectory + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.Azure.Storage.File.FileHandleResultSegment + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageFileServiceProperty.md b/azps-10.1.0/Az.Storage/Get-AzStorageFileServiceProperty.md new file mode 100644 index 0000000000..83205420f1 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageFileServiceProperty.md @@ -0,0 +1,150 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragefileserviceproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageFileServiceProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageFileServiceProperty.md +--- + +# Get-AzStorageFileServiceProperty + +## SYNOPSIS +Gets service properties for Azure Storage File services. + +## SYNTAX + +### AccountName (Default) +``` +Get-AzStorageFileServiceProperty [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountObject +``` +Get-AzStorageFileServiceProperty -StorageAccount <PSStorageAccount> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### FileServicePropertiesResourceId +``` +Get-AzStorageFileServiceProperty [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageFileServiceProperty** cmdlet gets the service properties for Azure Storage File services. + +## EXAMPLES + +### Example 1: Get Azure Storage File services property of a specified Storage Account +```powershell +Get-AzStorageFileServiceProperty -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" +``` +```output +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegroup +ShareDeleteRetentionPolicy.Enabled : True +ShareDeleteRetentionPolicy.Days : 3 +ProtocolSettings.Smb.Multichannel.Enabled : False +ProtocolSettings.Smb.Versions : {SMB2.1, SMB3.0, SMB3.1.1} +ProtocolSettings.Smb.AuthenticationMethods : {Kerberos, NTLMv2} +ProtocolSettings.Smb.KerberosTicketEncryption : {RC4-HMAC, AES-256} +ProtocolSettings.Smb.ChannelEncryption : {AES-128-CCM, AES-128-GCM, AES-256-GCM} +``` + +This command gets the File services property of a specified Storage Account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a Storage account Resource Id, or a File service properties Resource Id. + +```yaml +Type: System.String +Parameter Sets: FileServicePropertiesResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSFileServiceProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageLocalUser.md b/azps-10.1.0/Az.Storage/Get-AzStorageLocalUser.md new file mode 100644 index 0000000000..16c9087c12 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageLocalUser.md @@ -0,0 +1,167 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragelocaluser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageLocalUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageLocalUser.md +--- + +# Get-AzStorageLocalUser + +## SYNOPSIS +Gets a specified local user or lists all local users in a storage account. + +## SYNTAX + +### AccountName (Default) +``` +Get-AzStorageLocalUser [-ResourceGroupName] <String> [-StorageAccountName] <String> [-UserName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountObject +``` +Get-AzStorageLocalUser -StorageAccount <PSStorageAccount> [-UserName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageLocalUser** cmdlet gets a specified local user or lists all local users in a storage account. + +## EXAMPLES + +### Example 1: Get a specified local user +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\> $localUser = Get-AzStorageLocalUser -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -UserName testuser1 + +PS C:\> $localUser + + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name Sid HomeDirectory HasSharedKey HasSshKey HasSshPassword PermissionScopes +---- --- ------------- ------------ --------- -------------- ---------------- +testuser1 S-1-2-0-0000000000-000000000-0000000000-0000 / True True True [container1,...] + +PS C:\> $localUser.PermissionScopes + +Permissions Service ResourceName +----------- ------- ------------ +rw blob container1 +rw file share2 +``` + +This command gets a specified local user, and show the properties of it. + +### Example 2: List all local users in a storage account +```powershell +Get-AzStorageLocalUser -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" +``` + +```output +ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name Sid HomeDirectory HasSharedKey HasSshKey HasSshPassword PermissionScopes SshAuthorizedKeys +---- --- ------------- ------------ --------- -------------- ---------------- ----------------- +testuser1 S-1-2-0-0000000000-000000000-0000000000-0000 / True True True [container1,...] +testuser2 S-1-2-0-0000000000-000000000-0000000000-0002 /dir True True False +``` + +This command lists all local users in a storage account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserName +The name of local user. +The username must contain lowercase letters and numbers only. +It must be unique only within the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSLocalUser + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageLocalUserKey.md b/azps-10.1.0/Az.Storage/Get-AzStorageLocalUserKey.md new file mode 100644 index 0000000000..c69aab8830 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageLocalUserKey.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragelocaluserkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageLocalUserKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageLocalUserKey.md +--- + +# Get-AzStorageLocalUserKey + +## SYNOPSIS +Lists SSH authorized keys and shared key of a specified local user. + +## SYNTAX + +### AccountName (Default) +``` +Get-AzStorageLocalUserKey [-ResourceGroupName] <String> [-StorageAccountName] <String> -UserName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Get-AzStorageLocalUserKey -StorageAccount <PSStorageAccount> -UserName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UserObject +``` +Get-AzStorageLocalUserKey [-InputObject] <PSLocalUser> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageLocalUserKey** cmdlet lists SSH authorized keys and shared key of a specified local user in a storage account. + +## EXAMPLES + +### Example 1: List SSH authorized keys and shared key of a specified local user. +```powershell +Get-AzStorageLocalUserKey -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -UserName testuser1 +``` + +```output +SshAuthorizedKeys SharedKey +----------------- --------- +{ssh-rsa keykeykeykeykew=, ssh-rsa keykeykeykeykew=} <hidden> +``` + +This command lists SSH authorized keys and shared key of a specified local user. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Local User Object to get Keys. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSLocalUser +Parameter Sets: UserObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserName +The name of local user. +The username must contain lowercase letters and numbers only. +It must be unique only within the storage account. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSLocalUserKeys + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageObjectReplicationPolicy.md b/azps-10.1.0/Az.Storage/Get-AzStorageObjectReplicationPolicy.md new file mode 100644 index 0000000000..0a7270992a --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageObjectReplicationPolicy.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageobjectreplicationpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageObjectReplicationPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageObjectReplicationPolicy.md +--- + +# Get-AzStorageObjectReplicationPolicy + +## SYNOPSIS +Gets or lists object replication policy of a Storage account. + +## SYNTAX + +### AccountName (Default) +``` +Get-AzStorageObjectReplicationPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-PolicyId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### AccountObject +``` +Get-AzStorageObjectReplicationPolicy -StorageAccount <PSStorageAccount> [-PolicyId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageObjectReplicationPolicy** cmdlet gets or lists object replication policy of a Storage account. + +## EXAMPLES + +### Example 1: Get an object replication policy with specific policy Id and show its rules. +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $policy = Get-AzStorageObjectReplicationPolicy -ResourceGroupName "myresourcegroup" -AccountName "mydestaccount" -PolicyId 56bfa11c-81ef-4f8d-b307-5e5386e16fba + +PS C:\> $policy + +ResourceGroupName StorageAccountName PolicyId EnabledTime SourceAccount DestinationAccount Rules +----------------- ------------------ -------- ----------- ------------- ------------------ ----- +myresourcegroup mydestaccount 56bfa11c-81ef-4f8d-b307-5e5386e16fba mysourceaccount mydestaccount [5fa8b1d6-4985-4abd-a0b3-ec4d07295a43,...] + +PS C:\> $policy.Rules + +RuleId SourceContainer DestinationContainer Filters.PrefixMatch Filters.MinCreationTime +------ --------------- -------------------- ------------------- ----------------------- +d3d39a01-8d92-40e5-849f-e56209ae5cf5 src1 dest1 {} +2407de9a-3301-4656-858f-359d185565e0 src dest {a, abc, dd} 2019-01-01T16:00:00Z +``` + +This command gets an object replication policy with specific policy Id and show its rules. + +### Example 2:List object replication policy from a Storage account +```powershell +$policies = Get-AzStorageObjectReplicationPolicy -ResourceGroupName "myresourcegroup" -AccountName "mydestaccount" + +$policies +``` +```output +ResourceGroupName StorageAccountName PolicyId EnabledTime SourceAccount DestinationAccount Rules +----------------- ------------------ -------- ----------- ------------- ------------------ ----- +myresourcegroup mydestaccount 56bfa11c-81ef-4f8d-b307-5e5386e16fba mysrcaccount1 mydestaccount [5fa8b1d6-4985-4abd-a0b3-ec4d07295a43,...] +myresourcegroup mydestaccount 68434c7a-20d0-4282-b75c-43b5a243435e mysrcaccount2 mydestaccount [d3d39a01-8d92-40e5-849f-e56209ae5cf5,...] +``` + +This command lists object replication policy from a Storage account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +Object Replication Policy Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSObjectReplicationPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageQueue.md b/azps-10.1.0/Az.Storage/Get-AzStorageQueue.md new file mode 100644 index 0000000000..c25426e65a --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageQueue.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: C2EBCCF0-56CE-4D49-A138-74E52FC3A9AC +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragequeue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageQueue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageQueue.md +--- + +# Get-AzStorageQueue + +## SYNOPSIS +Lists storage queues. + +## SYNTAX + +### QueueName (Default) +``` +Get-AzStorageQueue [[-Name] <String>] [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### QueuePrefix +``` +Get-AzStorageQueue -Prefix <String> [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageQueue** cmdlet lists storage queues associated with an Azure Storage account. + +## EXAMPLES + +### Example 1: List all Azure Storage queues +```powershell +Get-AzStorageQueue +``` + +This command gets a list of all storage queues for the current Storage account. + +### Example 2: List Azure Storage queues using a wildcard character +```powershell +Get-AzStorageQueue -Name queue* +``` + +This command uses a wildcard character to get a list of storage queues whose name starts with queue. + +### Example 3: List Azure Storage queues using queue name prefix +```powershell +Get-AzStorageQueue -Prefix "queue" +``` + +This example uses the *Prefix* parameter to get a list of storage queues whose name starts with queue. + +## PARAMETERS + +### -Context +Specifies the Azure storage context. +You can create it by using the **New-AzStorageContext** cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name. +If no name is specified, the cmdlet gets a list of all the queues. +If a full or partial name is specified, the cmdlet gets all queues that match the name pattern. + +```yaml +Type: System.String +Parameter Sets: QueueName +Aliases: N, Queue + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Prefix +Specifies a prefix used in the name of the queues you want to get. + +```yaml +Type: System.String +Parameter Sets: QueuePrefix +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageQueue + +## NOTES + +## RELATED LINKS + +[New-AzStorageQueue](./New-AzStorageQueue.md) + +[Remove-AzStorageQueue](./Remove-AzStorageQueue.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageQueueStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/Get-AzStorageQueueStoredAccessPolicy.md new file mode 100644 index 0000000000..0d6310277c --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageQueueStoredAccessPolicy.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: F1EC601C-3ADD-402A-A5F7-84A95D312187 +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragequeuestoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageQueueStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageQueueStoredAccessPolicy.md +--- + +# Get-AzStorageQueueStoredAccessPolicy + +## SYNOPSIS +Gets the stored access policy or policies for an Azure storage queue. + +## SYNTAX + +``` +Get-AzStorageQueueStoredAccessPolicy [-Queue] <String> [[-Policy] <String>] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageQueueStoredAccessPolicy** cmdlet lists the stored access policy or policies for an Azure storage queue. + +## EXAMPLES + +### Example 1: Get a stored access policy in the queue +```powershell +Get-AzStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy12" +``` + +This command gets the access policy named Policy12 in the storage queue named MyQueue. + +### Example 2: Get all stored access policies in the queue +```powershell +Get-AzStorageQueueStoredAccessPolicy -Queue "MyQueue" +``` + +This command gets all stored access policies in the queue named MyQueue. + +## PARAMETERS + +### -Context +Specifies the Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies a stored access policy, which includes the permissions for this Shared Access Signature (SAS) token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Queue +Specifies the Azure storage queue name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.Azure.Storage.Queue.SharedAccessQueuePolicy + +## NOTES + +## RELATED LINKS + +[New-AzStorageQueueStoredAccessPolicy](./New-AzStorageQueueStoredAccessPolicy.md) + +[Remove-AzStorageQueueStoredAccessPolicy](./Remove-AzStorageQueueStoredAccessPolicy.md) + +[Set-AzStorageQueueStoredAccessPolicy](./Set-AzStorageQueueStoredAccessPolicy.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageServiceLoggingProperty.md b/azps-10.1.0/Az.Storage/Get-AzStorageServiceLoggingProperty.md new file mode 100644 index 0000000000..e62869cd9b --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageServiceLoggingProperty.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 494291A1-D854-4E97-B5EE-27BB5653D97C +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageserviceloggingproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageServiceLoggingProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageServiceLoggingProperty.md +--- + +# Get-AzStorageServiceLoggingProperty + +## SYNOPSIS +Gets logging properties for Azure Storage services. + +## SYNTAX + +``` +Get-AzStorageServiceLoggingProperty [-ServiceType] <StorageServiceType> [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageServiceLoggingProperty** cmdlet gets logging properties for Azure Storage services. + +## EXAMPLES + +### Example 1: Get logging properties for the Blob service +```powershell +Get-AzStorageServiceLoggingProperty -ServiceType Blob +``` + +This command gets logging properties for blob storage. + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceType +Specifies the storage service type. +This cmdlet gets the logging properties for the service type that this parameter specifies. +The acceptable values for this parameter are: +- Blob +- Table +- Queue +- File +The value of File is not currently supported. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType +Parameter Sets: (All) +Aliases: +Accepted values: Blob, Table, Queue, File + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.Azure.Storage.Shared.Protocol.LoggingProperties + +## NOTES + +## RELATED LINKS + +[New-AzStorageContext](./New-AzStorageContext.md) + +[Set-AzStorageServiceLoggingProperty](./Set-AzStorageServiceLoggingProperty.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageServiceMetricsProperty.md b/azps-10.1.0/Az.Storage/Get-AzStorageServiceMetricsProperty.md new file mode 100644 index 0000000000..8300d98f1d --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageServiceMetricsProperty.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 3B5B828A-6B3E-49BD-8BA9-916F8B69B8E9 +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageservicemetricsproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageServiceMetricsProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageServiceMetricsProperty.md +--- + +# Get-AzStorageServiceMetricsProperty + +## SYNOPSIS +Gets metrics properties for the Azure Storage service. + +## SYNTAX + +``` +Get-AzStorageServiceMetricsProperty [-ServiceType] <StorageServiceType> [-MetricsType] <ServiceMetricsType> + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageServiceMetricsProperty** cmdlet gets metrics properties for the Azure Storage service. + +## EXAMPLES + +### Example 1: Get metrics properties for the Blob service +```powershell +Get-AzStorageServiceMetricsProperty -ServiceType Blob -MetricsType Hour +``` + +This command gets metrics properties for blob storage for the Hour metrics type. + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricsType +Specifies a metrics type. +This cmdlet gets the Azure Storage service metrics properties for the metrics type that this parameter specifies. +The acceptable values for this parameter are: Hour and Minute. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Common.ServiceMetricsType +Parameter Sets: (All) +Aliases: +Accepted values: Hour, Minute + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceType +Specifies the storage service type. +This cmdlet gets the metrics properties for the type that this parameter specifies. +The acceptable values for this parameter are: +- Blob +- Table +- Queue +- File +The value of File is not currently supported. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType +Parameter Sets: (All) +Aliases: +Accepted values: Blob, Table, Queue, File + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.Azure.Storage.Shared.Protocol.MetricsProperties + +## NOTES + +## RELATED LINKS + +[New-AzStorageContext](./New-AzStorageContext.md) + +[Set-AzStorageServiceMetricsProperty](./Set-AzStorageServiceMetricsProperty.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageServiceProperty.md b/azps-10.1.0/Az.Storage/Get-AzStorageServiceProperty.md new file mode 100644 index 0000000000..c5aa556b7e --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageServiceProperty.md @@ -0,0 +1,117 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageserviceproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageServiceProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageServiceProperty.md +--- + +# Get-AzStorageServiceProperty + +## SYNOPSIS +Gets properties for Azure Storage services. + +## SYNTAX + +``` +Get-AzStorageServiceProperty [-ServiceType] <StorageServiceType> [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageServiceProperty** cmdlet gets the properties for Azure Storage services. + +## EXAMPLES + +### Example 1: Get Azure Storage services property of the Blob service +```powershell +Get-AzStorageServiceProperty -ServiceType Blob +``` +```output +Logging.Version : 1.0 +Logging.LoggingOperations : None +Logging.RetentionDays : +HourMetrics.Version : 1.0 +HourMetrics.MetricsLevel : ServiceAndApi +HourMetrics.RetentionDays : 7 +MinuteMetrics.Version : 1.0 +MinuteMetrics.MetricsLevel : None +MinuteMetrics.RetentionDays : +DeleteRetentionPolicy.Enabled : True +DeleteRetentionPolicy.RetentionDays : 70 +Cors : +DefaultServiceVersion : 2017-07-29 +``` + +This command gets DefaultServiceVersion property of the Blob service. + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceType +Specifies the storage service type. +This cmdlet gets the logging properties for the service type that this parameter specifies. +The acceptable values for this parameter are: +- Blob +- Table +- Queue +- File + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType +Parameter Sets: (All) +Aliases: +Accepted values: Blob, Table, Queue, File + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSSeriviceProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageShare.md b/azps-10.1.0/Az.Storage/Get-AzStorageShare.md new file mode 100644 index 0000000000..03b716ad63 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageShare.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: FD3A0013-4365-4E65-891C-5C50A9D5658C +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageshare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageShare.md +--- + +# Get-AzStorageShare + +## SYNOPSIS +Gets a list of file shares. + +## SYNTAX + +### MatchingPrefix (Default) +``` +Get-AzStorageShare [[-Prefix] <String>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [<CommonParameters>] +``` + +### Specific +``` +Get-AzStorageShare [-Name] <String> [[-SnapshotTime] <DateTimeOffset>] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageShare** cmdlet gets a list of file shares for a storage account. + +## EXAMPLES + +### Example 1: Get a file share +```powershell +Get-AzStorageShare -Name "ContosoShare06" +``` + +This command gets the file share named ContosoShare06. + +### Example 2: Get all file shares that begin with a string +```powershell +Get-AzStorageShare -Prefix "Contoso" +``` + +This command gets all file shares that have names that begin with Contoso. + +### Example 3: Get all file shares in a specified context +```powershell +$Context = New-AzStorageContext -Local +Get-AzStorageShare -Context $Context +``` + +The first command uses the **New-AzStorageContext** cmdlet to create a context by using the *Local* parameter, and then stores that context object in the $Context variable. +The second command gets the file shares for the context object stored in $Context. + +### Example 4: Get a file share snapshot with specific share name and SnapshotTime +```powershell +Get-AzStorageShare -Name "ContosoShare06" -SnapshotTime "6/16/2017 9:48:41 AM +00:00" +``` + +This command gets a file share snapshot with specific share name and SnapshotTime. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure Storage context. +To obtain a context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the file share. +This cmdlet gets the file share that this parameter specifies, or nothing if you specify the name of a file share that does not exist. + +```yaml +Type: System.String +Parameter Sets: Specific +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Prefix +Specifies the prefix for file shares. +This cmdlet gets file shares that match the prefix that this parameter specifies, or no file shares if no file shares match the specified prefix. + +```yaml +Type: System.String +Parameter Sets: MatchingPrefix +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnapshotTime +SnapshotTime of the file share snapshot to be received. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: Specific +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFileShare + +## NOTES + +## RELATED LINKS + +[New-AzStorageShare](./New-AzStorageShare.md) + +[Remove-AzStorageShare](./Remove-AzStorageShare.md) diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageShareStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/Get-AzStorageShareStoredAccessPolicy.md new file mode 100644 index 0000000000..396d3e22d4 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageShareStoredAccessPolicy.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 73BB521B-20F2-4F2B-AA88-2B128F36A9EF +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragesharestoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageShareStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageShareStoredAccessPolicy.md +--- + +# Get-AzStorageShareStoredAccessPolicy + +## SYNOPSIS +Gets stored access policies for a Storage share. + +## SYNTAX + +``` +Get-AzStorageShareStoredAccessPolicy [-ShareName] <String> [[-Policy] <String>] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageShareStoredAccessPolicy** cmdlet gets stored access policies for an Azure Storage share. +To get a particular policy, specify it by name. + +## EXAMPLES + +### Example 1: Get a stored access policy in a share +```powershell +Get-AzStorageShareStoredAccessPolicy -ShareName "ContosoShare" -Policy "GeneralPolicy" +``` + +This command gets a stored access policy named GeneralPolicy in ContosoShare. + +### Example 2: Get all the stored access policies in share +```powershell +Get-AzStorageShareStoredAccessPolicy -ShareName "ContosoShare" +``` + +This command gets all stored access policies in ContosoShare. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure Storage context. +To obtain a context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the name of the stored access policy that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +Specifies the Storage share name for which this cmdlet gets policies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.Azure.Storage.File.SharedAccessFilePolicy + +## NOTES + +## RELATED LINKS + +[New-AzStorageContext](./New-AzStorageContext.md) + +[New-AzStorageShareStoredAccessPolicy](./New-AzStorageShareStoredAccessPolicy.md) + +[Remove-AzStorageShareStoredAccessPolicy](./Remove-AzStorageShareStoredAccessPolicy.md) + +[Set-AzStorageShareStoredAccessPolicy](./Set-AzStorageShareStoredAccessPolicy.md) diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageTable.md b/azps-10.1.0/Az.Storage/Get-AzStorageTable.md new file mode 100644 index 0000000000..3b05fe403f --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageTable.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 4631D36F-926A-4279-AA4D-5F694C18081E +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageTable.md +--- + +# Get-AzStorageTable + +## SYNOPSIS +Lists the storage tables. + +## SYNTAX + +### TableName (Default) +``` +Get-AzStorageTable [[-Name] <String>] [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### TablePrefix +``` +Get-AzStorageTable -Prefix <String> [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageTable** cmdlet lists the storage tables associated with the storage account in Azure. + +## EXAMPLES + +### Example 1: List all Azure Storage tables +```powershell +Get-AzStorageTable +``` + +This command gets all storage tables for a Storage account. + +### Example 2: List Azure Storage tables using a wildcard character +```powershell +Get-AzStorageTable -Name table* +``` + +This command uses a wildcard character to get storage tables whose name starts with table. + +### Example 3: List Azure Storage tables using table name prefix +```powershell +Get-AzStorageTable -Prefix "table" +``` + +This command uses the *Prefix* parameter to get storage tables whose name starts with table. + +## PARAMETERS + +### -Context +Specifies the storage context. +To create it, you can use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the table name. +If the table name is empty, the cmdlet lists all the tables. +Otherwise, it lists all tables that match the specified name or the regular name pattern. + +```yaml +Type: System.String +Parameter Sets: TableName +Aliases: N, Table + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Prefix +Specifies a prefix used in the name of the table or tables you want to get. +You can use this to find all tables that start with the same string, such as table. + +```yaml +Type: System.String +Parameter Sets: TablePrefix +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable + +## NOTES + +## RELATED LINKS + +[New-AzStorageTable](./New-AzStorageTable.md) + +[Remove-AzStorageTable](./Remove-AzStorageTable.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageTableStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/Get-AzStorageTableStoredAccessPolicy.md new file mode 100644 index 0000000000..7c7f0f9fbf --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageTableStoredAccessPolicy.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: BF5526C1-11B9-47A8-A5A6-CB275B470A9E +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragetablestoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageTableStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageTableStoredAccessPolicy.md +--- + +# Get-AzStorageTableStoredAccessPolicy + +## SYNOPSIS +Gets the stored access policy or policies for an Azure storage table. + +## SYNTAX + +``` +Get-AzStorageTableStoredAccessPolicy [-Table] <String> [[-Policy] <String>] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageTableStoredAccessPolicy** cmdlet lists the stored access policy or policies for an Azure storage table. + +## EXAMPLES + +### Example 1: Get a stored access policy in a storage table +```powershell +Get-AzStorageTableStoredAccessPolicy -Table "Table02" -Policy "Policy50" +``` + +This command gets the access policy named Policy50 in the storage table named Table02. + +### Example 2: Get all stored access policies in a storage table +```powershell +Get-AzStorageTableStoredAccessPolicy -Table "Table02" +``` + +This command gets all access policies in the table named Table02. + +## PARAMETERS + +### -Context +Specifies the Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies a stored access policy, which includes the permissions for this Shared Access Signature (SAS) token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Table +Specifies the Azure storage table name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Storage.Table.SharedAccessTablePolicy + +## NOTES + +## RELATED LINKS + +[New-AzStorageTableStoredAccessPolicy](./New-AzStorageTableStoredAccessPolicy.md) + +[Remove-AzStorageTableStoredAccessPolicy](./Remove-AzStorageTableStoredAccessPolicy.md) + +[Set-AzStorageTableStoredAccessPolicy](./Set-AzStorageTableStoredAccessPolicy.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + + diff --git a/azps-10.1.0/Az.Storage/Get-AzStorageUsage.md b/azps-10.1.0/Az.Storage/Get-AzStorageUsage.md new file mode 100644 index 0000000000..b8e172190f --- /dev/null +++ b/azps-10.1.0/Az.Storage/Get-AzStorageUsage.md @@ -0,0 +1,91 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 11AAA319-DDBB-4156-9BE7-4DE8B80A904C +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstorageusage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageUsage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Get-AzStorageUsage.md +--- + +# Get-AzStorageUsage + +## SYNOPSIS +Gets the Storage resource usage of the current subscription. + +## SYNTAX + +``` +Get-AzStorageUsage -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageUsage** cmdlet gets the resource usage for Azure Storage for the current subscription. + +## EXAMPLES + +### Example 1: Get the storage resources usage of specified location +```powershell +Get-AzStorageUsage -Location 'West US' +``` +```output +LocalizedName : Storage Accounts +Name : StorageAccounts +Unit : Count +CurrentValue : 18 +Limit : 250 +``` + +This command gets the Storage resources usage of specified location under the current subscription. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Indicate to get Storage resources usage on the specified location. +If not specified, will get Storage resources usage on all locations under the subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSUsage + +## NOTES + +## RELATED LINKS + +[Azure Storage Manager Cmdlets](./Az.Storage.md) + + diff --git a/azps-10.1.0/Az.Storage/Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration.md b/azps-10.1.0/Az.Storage/Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration.md new file mode 100644 index 0000000000..0e9fbc1024 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/invoke-azrmstoragecontainerimmutablestoragewithversioningmigration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration.md +--- + +# Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration + +## SYNOPSIS +Migrate an existing Storage blob containers to enable immutable Storage with versioning. + +## SYNTAX + +### AccountName (Default) +``` +Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration [-ResourceGroupName] <String> + [-StorageAccountName] <String> -Name <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration -Name <String> + -StorageAccount <PSStorageAccount> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ContainerObject +``` +Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration -InputObject <PSContainer> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration** cmdlet migrates an existing Storage blob containers to enable immutable Storage with versioning. +The cmdlet only works when the Storage account has already enabled blob versioning, and the containers already has ImmutabilityPolicy. + +## EXAMPLES + +### Example 1: Migrates an existing Storage blob containers to enable immutable Storage with versioning. +```powershell +$t = Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -Name testcontainer -asjob + +$t | Wait-Job +``` + +This command migrates an existing Storage blob containers to enable immutable Storage with versioning. +The command only works when the Storage account has already enabled blob versioning, and the containers already has ImmutabilityPolicy. +Since the command ussually will run for a long time, you can run it asynchronously with '-Asjob'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Storage container object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSContainer +Parameter Sets: ContainerObject +Aliases: Container + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Container Name + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: N, ContainerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Invoke-AzStorageAccountFailover.md b/azps-10.1.0/Az.Storage/Invoke-AzStorageAccountFailover.md new file mode 100644 index 0000000000..0a015181d4 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Invoke-AzStorageAccountFailover.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/Az.storage/invoke-Azstorageaccountfailover +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Invoke-AzStorageAccountFailover.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Invoke-AzStorageAccountFailover.md +--- + +# Invoke-AzStorageAccountFailover + +## SYNOPSIS +Invokes failover of a Storage account. + +## SYNTAX + +### AccountName (Default) +``` +Invoke-AzStorageAccountFailover [-ResourceGroupName] <String> [-Name] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Invoke-AzStorageAccountFailover -InputObject <PSStorageAccount> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Invokes failover of a Storage account. Failover request can be triggered for a storage account in case of availability issues. +The failover occurs from the storage account's primary cluster to secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover. +Please understand the following impact to your storage account before you initiate the failover: +1.1. Please check the Last Sync Time using GET Blob Service Stats (https://learn.microsoft.com/rest/api/storageservices/get-blob-service-stats), GET Table Service Stats (https://learn.microsoft.com/rest/api/storageservices/get-table-service-stats) and GET Queue Service Stats (https://learn.microsoft.com/rest/api/storageservices/get-queue-service-stats) for your account. This is the data you may lose if you initiate the failover. +2.After the failover, your storage account type will be converted to locally redundant storage(LRS). You can convert your account to use geo-redundant storage(GRS). +3.Once you re-enable GRS for your storage account, Microsoft will replicate data to your new secondary region. Replication time is dependent on the amount of data to replicate. Please note that there are bandwidth charges for the bootstrap. https://azure.microsoft.com/en-us/pricing/details/bandwidth/ + +## EXAMPLES + +### Example 1: Invoke failover of a Storage account +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\>$account = Get-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -IncludeGeoReplicationStats +PS C:\>$account.GeoReplicationStats + +Status LastSyncTime +------ ------------ +Live 11/13/2018 2:44:22 AM + +PS C:\>$job = Invoke-AzStorageAccountFailover -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Force -AsJob +PS C:\>$job | Wait-Job +``` + +This command check the last sync time of a Storage account then invokes failover of it, the secondary cluster will become primary after failover. Since failover takes a long time, suggest to run it in the backend with -Asjob parameter, and then wait for the job complete. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force to Failover the Account + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Invoke-AzStorageAccountHierarchicalNamespaceUpgrade.md b/azps-10.1.0/Az.Storage/Invoke-AzStorageAccountHierarchicalNamespaceUpgrade.md new file mode 100644 index 0000000000..acbb4680d9 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Invoke-AzStorageAccountHierarchicalNamespaceUpgrade.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/invoke-azstorageaccounthierarchicalnamespaceupgrade +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Invoke-AzStorageAccountHierarchicalNamespaceUpgrade.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Invoke-AzStorageAccountHierarchicalNamespaceUpgrade.md +--- + +# Invoke-AzStorageAccountHierarchicalNamespaceUpgrade + +## SYNOPSIS +Validates if a storage account can be upgraded to enable HierarchicalNamespace, or upgrades a Storage account to enabled HierarchicalNamespace. + +## SYNTAX + +### AccountName (Default) +``` +Invoke-AzStorageAccountHierarchicalNamespaceUpgrade [-ResourceGroupName] <String> [-Name] <String> + -RequestType <String> [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountObject +``` +Invoke-AzStorageAccountHierarchicalNamespaceUpgrade -InputObject <PSStorageAccount> -RequestType <String> + [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzStorageAccountHierarchicalNamespaceUpgrade** cmdlet can validate if a storage account can be upgraded to enable HierarchicalNamespace, or upgrades a Storage account to enabled HierarchicalNamespace. + +## EXAMPLES + +### Example 1: Validate a stroage account can be upgrade to enable HierarchicalNamespace, then upgrade it to enabled HierarchicalNamespace +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> Invoke-AzStorageAccountHierarchicalNamespaceUpgrade -ResourceGroupName $rgname -Name $accountName -RequestType Validation +True + +PS C:\> $task = Invoke-AzStorageAccountHierarchicalNamespaceUpgrade -ResourceGroupName $rgname -Name $accountName -RequestType Upgrade -Force -AsJob + +PS C:\> $task | Wait-Job +``` + +The first command validates if a stroage account can be upgrade to enable HierarchicalNamespace. +The second command upgrade the storage account to enable HierarchicalNamespace. Since the upgrade will take time, use '-Asjob' to run it in backend, and return a task. Then wait for the task finish. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force to Failover the Account + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestType +The HierarchicalNamespaceUpgrade requestType to run: +- Validation: Validate if the account can be upgrade to enable HierarchicalNamespace. +- Upgrade: Upgrade the storage account to enable HierarchicalNamespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Validation, Upgrade + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Lock-AzRmStorageContainerImmutabilityPolicy.md b/azps-10.1.0/Az.Storage/Lock-AzRmStorageContainerImmutabilityPolicy.md new file mode 100644 index 0000000000..48116a78ad --- /dev/null +++ b/azps-10.1.0/Az.Storage/Lock-AzRmStorageContainerImmutabilityPolicy.md @@ -0,0 +1,267 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/lock-azrmstoragecontainerimmutabilitypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Lock-AzRmStorageContainerImmutabilityPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Lock-AzRmStorageContainerImmutabilityPolicy.md +--- + +# Lock-AzRmStorageContainerImmutabilityPolicy + +## SYNOPSIS +Locks ImmutabilityPolicy of a Storage blob containers + +## SYNTAX + +### AccountName (Default) +``` +Lock-AzRmStorageContainerImmutabilityPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -ContainerName <String> -Etag <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Lock-AzRmStorageContainerImmutabilityPolicy -ContainerName <String> -StorageAccount <PSStorageAccount> + -Etag <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ContainerObject +``` +Lock-AzRmStorageContainerImmutabilityPolicy -Container <PSContainer> -Etag <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ImmutabilityPolicyObject +``` +Lock-AzRmStorageContainerImmutabilityPolicy [-InputObject] <PSImmutabilityPolicy> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Lock-AzRmStorageContainerImmutabilityPolicy** cmdlet locks ImmutabilityPolicy of a Storage blob containers. + +## EXAMPLES + +### Example 1: Lock ImmutabilityPolicy of a Storage blob container with Storage account name and container name +```powershell +$policy = Get-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" +Lock-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Etag $policy.Etag +``` + +This command Locks ImmutabilityPolicy of a Storage blob container with Storage account name and container name. + +### Example 2: Lock ImmutabilityPolicy of a Storage blob container, with Storage account object +```powershell +$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" +$policy = Get-AzRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" +Lock-AzRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" -Etag $policy.Etag -Force +``` + +This command locks ImmutabilityPolicy of a Storage blob container, with Storage account object. + +### Example 3: Lock ImmutabilityPolicyof a Storage blob container, with container object +```powershell +$containerObject = Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -Name "myContainer" +$policy = Get-AzRmStorageContainerImmutabilityPolicy -Container $containerObject +Lock-AzRmStorageContainerImmutabilityPolicy -Container $containerObject -Etag $policy.Etag -Force +``` + +This command locks ImmutabilityPolicy of a Storage blob container with Storage container object. + +### Example 4: Lock ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object +```powershell +Get-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" | Lock-AzRmStorageContainerImmutabilityPolicy -Force +``` + +This command locks ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object. + +## PARAMETERS + +### -Container +Storage container object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSContainer +Parameter Sets: ContainerObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ContainerName +Container Name + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: N + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Immutability policy etag. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject, ContainerObject +Aliases: IfMatch + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force to remove the ImmutabilityPolicy. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +ImmutabilityPolicy Object to Remove + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy +Parameter Sets: ImmutabilityPolicyObject +Aliases: ImmutabilityPolicy + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer + +### Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Move-AzDataLakeGen2Item.md b/azps-10.1.0/Az.Storage/Move-AzDataLakeGen2Item.md new file mode 100644 index 0000000000..4ed94851fa --- /dev/null +++ b/azps-10.1.0/Az.Storage/Move-AzDataLakeGen2Item.md @@ -0,0 +1,258 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/move-azdatalakegen2item +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Move-AzDataLakeGen2Item.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Move-AzDataLakeGen2Item.md +--- + +# Move-AzDataLakeGen2Item + +## SYNOPSIS +Move a file or directory to another a file or directory in same Storage account. + +## SYNTAX + +### ReceiveManual (Default) +``` +Move-AzDataLakeGen2Item [-FileSystem] <String> [-Path] <String> -DestFileSystem <String> -DestPath <String> + [-Force] [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ItemPipeline +``` +Move-AzDataLakeGen2Item -InputObject <AzureDataLakeGen2Item> -DestFileSystem <String> -DestPath <String> + [-Force] [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Move-AzDataLakeGen2Item** cmdlet moves a a file or directory to another a file or directory in same Storage account. +This cmdlet only works if Hierarchical Namespace is enabled for the Storage account. This kind of account can be created by run "New-AzStorageAccount" cmdlet with "-EnableHierarchicalNamespace $true". + +## EXAMPLES + +### Example 1: Move a fold in same Filesystem +```powershell +Move-AzDataLakeGen2Item -FileSystem "filesystem1" -Path "dir1/" -DestFileSystem "filesystem1" -DestPath "dir3/" +``` + +```output + FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir3 True 2020-03-13 13:07:34Z rwxrw-rw- $superuser $superuser +``` + +This command move directory 'dir1' to directory 'dir3' in the same Filesystem. + +### Example 2: Move a file by pipeline, to another Filesystem in the same Storage account without prompt +```powershell +Get-AzDataLakeGen2Item -FileSystem "filesystem1" -Path "dir1/file1" | Move-AzDataLakeGen2Item -DestFileSystem "filesystem2" -DestPath "dir2/file2" -Force +``` + +```output + FileSystem Name: filesystem2 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir2/file2 False 1024 2020-03-23 09:57:33Z rwxrw-rw- $superuser $superuser +``` + +This command move file 'dir1/file1' in 'filesystem1' to file 'dir2/file2' in 'filesystem2' in the same Storage account without prompt. + +### Example 3: Move an item with Sas token +```powershell +$sas = New-AzStorageContainerSASToken -Name $filesystemName -Permission rdw -Context $ctx + +$sasctx = New-AzStorageContext -StorageAccountName $ctx.StorageAccountName -SasToken $sas + +Move-AzDataLakeGen2Item -FileSystem $filesystemName -Path $itempath1 -DestFileSystem $filesystemName -DestPath "$($itempath2)$($sas)" -Context $sasctx +``` + +```output + FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir2/file1 False 1024 2021-03-23 09:57:33Z rwxrw-rw- $superuser $superuser +``` + +This first command creates a Sas token with rdw permission, the second command creates a Storage context from the Sas token, the 3rd command moves an item with the Sas token. +This example use same Sastoken with rdw permission on both source and destication, if use 2 SAS token for source and destication, source need permission rd, destication need permission w. + +## PARAMETERS + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestFileSystem +Dest FileSystem name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestPath +Dest Blob path + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +FileSystem name + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Force +Force to over write the destination. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure Datalake Gen2 Item Object to move from. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item +Parameter Sets: ItemPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Path +The path in the specified Filesystem that should be move from. +Can be a file or directory In the format 'directory/file.txt' or 'directory1/directory2/' + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzDataLakeGen2Item.md b/azps-10.1.0/Az.Storage/New-AzDataLakeGen2Item.md new file mode 100644 index 0000000000..a00956aa74 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzDataLakeGen2Item.md @@ -0,0 +1,321 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azdatalakegen2item +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzDataLakeGen2Item.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzDataLakeGen2Item.md +--- + +# New-AzDataLakeGen2Item + +## SYNOPSIS +Create a file or directory in a filesystem. + +## SYNTAX + +### File (Default) +``` +New-AzDataLakeGen2Item [-FileSystem] <String> [-Path] <String> -Source <String> [-Umask <String>] + [-Permission <String>] [-Property <Hashtable>] [-Metadata <Hashtable>] [-Force] [-AsJob] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Directory +``` +New-AzDataLakeGen2Item [-FileSystem] <String> [-Path] <String> [-Directory] [-Umask <String>] + [-Permission <String>] [-Property <Hashtable>] [-Metadata <Hashtable>] [-Force] [-AsJob] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataLakeGen2Item** cmdlet creates a file or directory in a Filesystem in an Azure storage account. +This cmdlet only works if Hierarchical Namespace is enabled for the Storage account. This kind of account can be created by run "New-AzStorageAccount" cmdlet with "-EnableHierarchicalNamespace $true". + +## EXAMPLES + +### Example 1: Create a directory with specified permission, Umask, properties, and metadata +```powershell +New-AzDataLakeGen2Item -FileSystem "testfilesystem" -Path "dir1/dir2/" -Directory -Permission rwxrwxrwT -Umask ---rw---- -Property @{"CacheControl" = "READ"; "ContentDisposition" = "True"} -Metadata @{"tag1" = "value1"; "tag2" = "value2" } +``` + +```output +FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir1/dir2 True 2020-03-23 09:15:56Z rwx---rwT $superuser $superuser +``` + +This command creates a directory with specified Permission, Umask, properties, and metadata + +### Example 2: Create(upload) a data lake file from a local source file, and the cmdlet runs in background +```powershell +$task = New-AzDataLakeGen2Item -FileSystem "testfilesystem" -Path "dir1/dir2/file1" -Source "c:\sourcefile.txt" -Force -asjob +$task | Wait-Job +$task.Output +``` + +```output +FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir1/dir2/file1 False 14400000 2020-03-23 09:19:13Z rw-r----- $superuser $superuser +``` + +This command creates(upload) a data lake file from a local source file, and the cmdlet runs in background. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +The total amount of concurrent async tasks. The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Directory +Indicates that this new item is a directory and not a file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Directory +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +FileSystem name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Force +If passed then new item is created without any prompt + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies metadata for the created directory or file. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path in the specified Filesystem that should be create. +Can be a file or directory In the format 'directory/file.txt' or 'directory1/directory2/' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Permission +Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. Symbolic (rwxrw-rw-) is supported. +The sticky bit is also supported and its represented either by the letter t or T in the final character-place depending on whether the execution bit for the others category is set or unset respectively, +absence of t or T indicates sticky bit not set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +Specifies properties for the created directory or file. +The supported properties for file are: CacheControl, ContentDisposition, ContentEncoding, ContentLanguage, ContentMD5, ContentType. +The supported properties for directory are: CacheControl, ContentDisposition, ContentEncoding, ContentLanguage. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Specify the local source file path which will be upload to a Datalake Gen2 file. + +```yaml +Type: System.String +Parameter Sets: File +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Umask +When creating New Item and the parent directory does not have a default ACL, the umask restricts the permissions of the file or directory to be created. +The resulting permission is given by p & ^u, where p is the permission and u is the umask. +Symbolic (rwxrw-rw-) is supported. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzDataLakeGen2SasToken.md b/azps-10.1.0/Az.Storage/New-AzDataLakeGen2SasToken.md new file mode 100644 index 0000000000..79b33360b0 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzDataLakeGen2SasToken.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azdatalakegen2sastoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzDataLakeGen2SasToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzDataLakeGen2SasToken.md +--- + +# New-AzDataLakeGen2SasToken + +## SYNOPSIS +Generates a SAS token for Azure DatalakeGen2 item. + +## SYNTAX + +### ReceiveManual (Default) +``` +New-AzDataLakeGen2SasToken [-FileSystem] <String> [-Path <String>] [-Permission <String>] + [-Protocol <SasProtocol>] [-IPAddressOrRange <String>] [-StartTime <DateTimeOffset>] + [-ExpiryTime <DateTimeOffset>] [-EncryptionScope <String>] [-FullUri] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ItemPipeline +``` +New-AzDataLakeGen2SasToken -InputObject <AzureDataLakeGen2Item> [-Permission <String>] + [-Protocol <SasProtocol>] [-IPAddressOrRange <String>] [-StartTime <DateTimeOffset>] + [-ExpiryTime <DateTimeOffset>] [-EncryptionScope <String>] [-FullUri] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzDataLakeGen2SasToken** cmdlet generates a Shared Access Signature (SAS) token for an Azure DatalakeGen2 item. + +## EXAMPLES + +### Example 1: Generate a SAS token with full permission +```powershell +New-AzDataLakeGen2SasToken -FileSystem "filesystem1" -Path "dir1/dir2" -Permission racwdlmeop +``` + +This example generates a DatalakeGen2 SAS token with full permission. + +### Example 2: Generate a SAS token with specific StartTime, ExpireTime, Protocal, IPAddressOrRange, Encryption Scope, by pipeline a datalakegen2 item +```powershell +Get-AzDataLakeGen2Item -FileSystem test -Path "testdir/dir2" | New-AzDataLakeGen2SasToken -Permission rw -Protocol Https -IPAddressOrRange 10.0.0.0-12.10.0.0 -StartTime (Get-Date) -ExpiryTime (Get-Date).AddDays(6) -EncryptionScope scopename +``` + +This example generates a DatalakeGen2 SAS token by pipeline a datalake gen2 item, and with specific StartTime, ExpireTime, Protocal, IPAddressOrRange, Encryption Scope. + +## PARAMETERS + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionScope +Encryption scope to use when sending requests authorized with this SAS URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Expiry Time + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +FileSystem name + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -FullUri +Display full uri with sas token + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure Datalake Gen2 Item Object to remove. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item +Parameter Sets: ItemPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IPAddressOrRange +IP, or IP range ACL (access control list) that the request would be accepted by Azure Storage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path in the specified FileSystem that should be retrieved. +Can be a file or directory In the format 'directory/file.txt' or 'directory1/directory2/'. +Skip set this parameter to get the root directory of the Filesystem. + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Permission +Permissions for a blob. +Permissions can be any not-empty subset of "racwdlmeop". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Protocol can be used in the request with this SAS token. + +```yaml +Type: System.Nullable`1[Azure.Storage.Sas.SasProtocol] +Parameter Sets: (All) +Aliases: +Accepted values: None, HttpsAndHttp, Https + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Start Time + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzRmStorageContainer.md b/azps-10.1.0/Az.Storage/New-AzRmStorageContainer.md new file mode 100644 index 0000000000..3aa481c76c --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzRmStorageContainer.md @@ -0,0 +1,336 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azrmstoragecontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzRmStorageContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzRmStorageContainer.md +--- + +# New-AzRmStorageContainer + +## SYNOPSIS +Creates a Storage blob container + +## SYNTAX + +### AccountName (Default) +``` +New-AzRmStorageContainer [-ResourceGroupName] <String> [-StorageAccountName] <String> -Name <String> + [-PublicAccess <PSPublicAccess>] [-Metadata <Hashtable>] [-EnableImmutableStorageWithVersioning] + [-RootSquash <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountNameEncryptionScope +``` +New-AzRmStorageContainer [-ResourceGroupName] <String> [-StorageAccountName] <String> -Name <String> + -DefaultEncryptionScope <String> -PreventEncryptionScopeOverride <Boolean> [-PublicAccess <PSPublicAccess>] + [-Metadata <Hashtable>] [-EnableImmutableStorageWithVersioning] [-RootSquash <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +New-AzRmStorageContainer -StorageAccount <PSStorageAccount> -Name <String> [-PublicAccess <PSPublicAccess>] + [-Metadata <Hashtable>] [-EnableImmutableStorageWithVersioning] [-RootSquash <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObjectEncryptionScope +``` +New-AzRmStorageContainer -StorageAccount <PSStorageAccount> -Name <String> -DefaultEncryptionScope <String> + -PreventEncryptionScopeOverride <Boolean> [-PublicAccess <PSPublicAccess>] [-Metadata <Hashtable>] + [-EnableImmutableStorageWithVersioning] [-RootSquash <String>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRmStorageContainer** cmdlet creates a Storage blob container + +## EXAMPLES + +### Example 1: Create a Storage blob container with Storage account name and container name, with metadata +```powershell +New-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Metadata @{tag0="value0";tag1="value1";tag2="value2"} +``` + +This command creates a Storage blob container with Storage account name and container name, with metadata. + +### Example 2: Create a Storage blob container with Storage account object and container name, with public access as Blob +```powershell +$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" +New-AzRmStorageContainer -StorageAccount $accountObject -ContainerName "myContainer" -PublicAccess Blob +``` + +This command creates a Storage blob container with Storage account object and container name, with public access as Blob. + +### Example 3: Create a storage container with EncryptionScope setting +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $c = New-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -Name testcontainer -DefaultEncryptionScope "testscope" -PreventEncryptionScopeOverride $true + +PS C:\> $c + + ResourceGroupName: myResourceGroup, StorageAccountName: mystorageaccount + +Name PublicAccess LastModified HasLegalHold HasImmutabilityPolicy +---- ------------ ------------ ------------ --------------------- +testcontainer False False + +PS C:\> $c.DefaultEncryptionScope +testscope + +PS C:\> $c.DenyEncryptionScopeOverride +True +``` + +This command creates a storage container with a defalt encryptionScope, and blocks override of encryption scope from the container default. +Then show the related container properties. + +### Example 4: Create an Azure storage container with RootSquash +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $container = New-AzRmStorageContainer -ResourceGroupName "myersourcegroup" -AccountName "mystorageaccount" -Name "mycontainer" -RootSquash AllSquash + +PS C:\> $container.EnableNfsV3AllSquash +True + +PS C:\> $container.EnableNfsV3RootSquash +False +``` + +This command creates a storage container, with RootSquash property set as AllSquash. RootSquash only works on a storage account that enabled NfsV3. + +### Example 5: Create a storage container and enable immutable Storage with versioning +```powershell +$c = New-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -Name testcontainer -EnableImmutableStorageWithVersioning + +$c +``` +```output + + ResourceGroupName: myResourceGroup, StorageAccountName: mystorageaccount + +Name PublicAccess LastModified HasLegalHold HasImmutabilityPolicy Deleted VersionId ImmutableStorageWithVersioning +---- ------------ ------------ ------------ --------------------- ------- --------- ------------------------------ +testcontainer None 2021-07-19 08:26:19Z False False False True +``` + +This command creates a storage container and enable immutable Storage with versioning. +The command only works when the Storage account has already enabled blob versioning. + +## PARAMETERS + +### -DefaultEncryptionScope +Default the container to use specified encryption scope for all writes. + +```yaml +Type: System.String +Parameter Sets: AccountNameEncryptionScope, AccountObjectEncryptionScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableImmutableStorageWithVersioning +Enable immutable Storage with versioning at the container level. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Container Metadata + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, ContainerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PreventEncryptionScopeOverride +Block override of encryption scope from the container default. + +```yaml +Type: System.Boolean +Parameter Sets: AccountNameEncryptionScope, AccountObjectEncryptionScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicAccess +Container PublicAccess + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSPublicAccess +Parameter Sets: (All) +Aliases: +Accepted values: Container, Blob, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountNameEncryptionScope +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RootSquash +Sets reduction of the access rights for the remote superuser. Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: NoRootSquash, RootSquash, AllSquash + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject, AccountObjectEncryptionScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountNameEncryptionScope +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzRmStorageShare.md b/azps-10.1.0/Az.Storage/New-AzRmStorageShare.md new file mode 100644 index 0000000000..75927fffff --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzRmStorageShare.md @@ -0,0 +1,327 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azrmstorageshare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzRmStorageShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzRmStorageShare.md +--- + +# New-AzRmStorageShare + +## SYNOPSIS +Creates a Storage file share. + +## SYNTAX + +### AccountName (Default) +``` +New-AzRmStorageShare [-ResourceGroupName] <String> [-StorageAccountName] <String> -Name <String> + [-QuotaGiB <Int32>] [-Metadata <Hashtable>] [-AccessTier <String>] [-Snapshot] [-EnabledProtocol <String>] + [-RootSquash <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +New-AzRmStorageShare -StorageAccount <PSStorageAccount> -Name <String> [-QuotaGiB <Int32>] + [-Metadata <Hashtable>] [-AccessTier <String>] [-Snapshot] [-EnabledProtocol <String>] [-RootSquash <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRmStorageShare** cmdlet creates a Storage file share. + +## EXAMPLES + +### Example 1: Create a Storage file share with Storage account name and share name, with metadata and share quota as 100 GiB. +```powershell +New-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -QuotaGiB 100 -Metadata @{"tag1" = "value1"; "tag2" = "value2" } +``` +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocol AccessTier Deleted Version ShareUsageBytes +---- -------- --------------- ---------- ------- ------- --------------- +myshare +``` + +This command creates a Storage file share with metadata and share quota as 100 GiB. + +### Example 2: Create a Storage file share with Storage account object +```powershell +Get-AzStorageAccount -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" | New-AzRmStorageShare -Name "myshare" +``` +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocol AccessTier Deleted Version ShareUsageBytes +---- -------- --------------- ---------- ------- ------- --------------- +myshare +``` + +This command creates a Storage file share with Storage account object and share name. + +### Example 3: Create a Storage file share with accesstier as Hot +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\>$share = New-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -AccessTier Hot + + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes +---- -------- ---------------- ---------- ------- ------- --------------- +myshare Hot +``` + +This command creates a Storage file share with accesstier as Hot. + +### Example 4: Create a Storage file share snapshot of an existing share +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\>$shareSnapshot = New-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -Snapshot + + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes snapshotTime +---- -------- ---------------- ---------- ------- ------- --------------- ------------ +myshare 2021-05-10T08:04:08 +``` + +This command creates a Storage file share snapshot of an existing base file share. + +### Example 5: Create a Storage file share with EnabledProtocol proeprty as NFS, and RootSquash property as NoRootSquash +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\>$share = New-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -EnabledProtocol NFS -RootSquash NoRootSquash + +PS C:\> $share + + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes +---- -------- ---------------- ---------- ------- ------- --------------- +myshare NFS + +PS C:\> $share.RootSquash +NoRootSquash +``` + +This command creates a Storage file share with EnabledProtocol proeprty as NFS, and RootSquash proeprty as NoRootSquash. + +## PARAMETERS + +### -AccessTier +Access tier for specific share. StorageV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TransactionOptimized, Premium, Hot, Cool + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnabledProtocol +Sets protocols for file shares. It cannot be changed after file share creation. Possible values include: 'SMB', 'NFS' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: NFS, SMB + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Share Metadata + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Azure File share name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, ShareName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuotaGiB +Share Quota in Gibibyte. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Quota + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RootSquash +Sets reduction of the access rights for the remote superuser. Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: NoRootSquash, RootSquash, AllSquash + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Snapshot +Create a snapshot of existing share with same name. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSShare + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzStorageAccount.md b/azps-10.1.0/Az.Storage/New-AzStorageAccount.md new file mode 100644 index 0000000000..3d3c3aa2db --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageAccount.md @@ -0,0 +1,1305 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +ms.assetid: A3DA1205-B8FB-4B4C-9C40-AD303D038EDF +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageAccount.md +--- + +# New-AzStorageAccount + +## SYNOPSIS +Creates a Storage account. + +## SYNTAX + +### AzureActiveDirectoryDomainServicesForFile (Default) +``` +New-AzStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-SkuName] <String> [-Location] <String> + [-Kind <String>] [-AccessTier <String>] [-CustomDomainName <String>] [-UseSubDomain <Boolean>] + [-Tag <Hashtable>] [-EnableHttpsTrafficOnly <Boolean>] [-AssignIdentity] [-UserAssignedIdentityId <String>] + [-IdentityType <String>] [-KeyVaultUserAssignedIdentityId <String>] [-KeyVaultFederatedClientId <String>] + [-KeyName <String>] [-KeyVersion <String>] [-KeyVaultUri <String>] [-NetworkRuleSet <PSNetworkRuleSet>] + [-EnableSftp <Boolean>] [-EnableLocalUser <Boolean>] [-EnableHierarchicalNamespace <Boolean>] + [-EnableAzureActiveDirectoryDomainServicesForFile <Boolean>] [-EnableLargeFileShare] + [-PublishMicrosoftEndpoint <Boolean>] [-PublishInternetEndpoint <Boolean>] [-AsJob] + [-EncryptionKeyTypeForTable <String>] [-EncryptionKeyTypeForQueue <String>] [-RequireInfrastructureEncryption] + [-SasExpirationPeriod <TimeSpan>] [-KeyExpirationPeriodInDay <Int32>] [-AllowBlobPublicAccess <Boolean>] + [-MinimumTlsVersion <String>] [-AllowSharedKeyAccess <Boolean>] [-EnableNfsV3 <Boolean>] + [-AllowCrossTenantReplication <Boolean>] [-DefaultSharePermission <String>] [-EdgeZone <String>] + [-PublicNetworkAccess <String>] [-EnableAccountLevelImmutability] [-ImmutabilityPeriod <Int32>] + [-ImmutabilityPolicyState <String>] [-AllowedCopyScope <String>] [-DnsEndpointType <String>] + [-DefaultProfile <IAzureContextContainer>] [-RoutingChoice <String>] [<CommonParameters>] +``` + +### AzureActiveDirectoryKerberosForFile +``` +New-AzStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-SkuName] <String> [-Location] <String> + [-Kind <String>] [-AccessTier <String>] [-CustomDomainName <String>] [-UseSubDomain <Boolean>] + [-Tag <Hashtable>] [-EnableHttpsTrafficOnly <Boolean>] [-AssignIdentity] [-UserAssignedIdentityId <String>] + [-IdentityType <String>] [-KeyVaultUserAssignedIdentityId <String>] [-KeyVaultFederatedClientId <String>] + [-KeyName <String>] [-KeyVersion <String>] [-KeyVaultUri <String>] [-NetworkRuleSet <PSNetworkRuleSet>] + [-EnableSftp <Boolean>] [-EnableLocalUser <Boolean>] [-EnableHierarchicalNamespace <Boolean>] + [-EnableLargeFileShare] [-PublishMicrosoftEndpoint <Boolean>] [-PublishInternetEndpoint <Boolean>] + -EnableAzureActiveDirectoryKerberosForFile <Boolean> [-ActiveDirectoryDomainName <String>] + [-ActiveDirectoryDomainGuid <String>] [-AsJob] [-EncryptionKeyTypeForTable <String>] + [-EncryptionKeyTypeForQueue <String>] [-RequireInfrastructureEncryption] [-SasExpirationPeriod <TimeSpan>] + [-KeyExpirationPeriodInDay <Int32>] [-AllowBlobPublicAccess <Boolean>] [-MinimumTlsVersion <String>] + [-AllowSharedKeyAccess <Boolean>] [-EnableNfsV3 <Boolean>] [-AllowCrossTenantReplication <Boolean>] + [-DefaultSharePermission <String>] [-EdgeZone <String>] [-PublicNetworkAccess <String>] + [-EnableAccountLevelImmutability] [-ImmutabilityPeriod <Int32>] [-ImmutabilityPolicyState <String>] + [-AllowedCopyScope <String>] [-DnsEndpointType <String>] [-DefaultProfile <IAzureContextContainer>] + [-RoutingChoice <String>] [<CommonParameters>] +``` + +### ActiveDirectoryDomainServicesForFile +``` +New-AzStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-SkuName] <String> [-Location] <String> + [-Kind <String>] [-AccessTier <String>] [-CustomDomainName <String>] [-UseSubDomain <Boolean>] + [-Tag <Hashtable>] [-EnableHttpsTrafficOnly <Boolean>] [-AssignIdentity] [-UserAssignedIdentityId <String>] + [-IdentityType <String>] [-KeyVaultUserAssignedIdentityId <String>] [-KeyVaultFederatedClientId <String>] + [-KeyName <String>] [-KeyVersion <String>] [-KeyVaultUri <String>] [-NetworkRuleSet <PSNetworkRuleSet>] + [-EnableSftp <Boolean>] [-EnableLocalUser <Boolean>] [-EnableHierarchicalNamespace <Boolean>] + [-EnableLargeFileShare] [-PublishMicrosoftEndpoint <Boolean>] [-PublishInternetEndpoint <Boolean>] + [-EnableActiveDirectoryDomainServicesForFile <Boolean>] [-ActiveDirectoryDomainName <String>] + [-ActiveDirectoryNetBiosDomainName <String>] [-ActiveDirectoryForestName <String>] + [-ActiveDirectoryDomainGuid <String>] [-ActiveDirectoryDomainSid <String>] + [-ActiveDirectoryAzureStorageSid <String>] [-ActiveDirectorySamAccountName <String>] + [-ActiveDirectoryAccountType <String>] [-AsJob] [-EncryptionKeyTypeForTable <String>] + [-EncryptionKeyTypeForQueue <String>] [-RequireInfrastructureEncryption] [-SasExpirationPeriod <TimeSpan>] + [-KeyExpirationPeriodInDay <Int32>] [-AllowBlobPublicAccess <Boolean>] [-MinimumTlsVersion <String>] + [-AllowSharedKeyAccess <Boolean>] [-EnableNfsV3 <Boolean>] [-AllowCrossTenantReplication <Boolean>] + [-DefaultSharePermission <String>] [-EdgeZone <String>] [-PublicNetworkAccess <String>] + [-EnableAccountLevelImmutability] [-ImmutabilityPeriod <Int32>] [-ImmutabilityPolicyState <String>] + [-AllowedCopyScope <String>] [-DnsEndpointType <String>] [-DefaultProfile <IAzureContextContainer>] + [-RoutingChoice <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageAccount** cmdlet creates an Azure Storage account. + +## EXAMPLES + +### Example 1: Create a Storage account +```powershell +New-AzStorageAccount -ResourceGroupName MyResourceGroup -Name mystorageaccount -Location westus -SkuName Standard_GRS +``` + +This command creates a Storage account for the resource group name MyResourceGroup. + +### Example 2: Create a Blob Storage account with BlobStorage Kind and hot AccessTier +```powershell +New-AzStorageAccount -ResourceGroupName MyResourceGroup -Name mystorageaccount -Location westus -SkuName Standard_GRS -Kind BlobStorage -AccessTier Hot +``` + +This command creates a Blob Storage account that with BlobStorage Kind and hot AccessTier + +### Example 3: Create a Storage account with Kind StorageV2, and Generate and Assign an Identity for Azure KeyVault. +```powershell +New-AzStorageAccount -ResourceGroupName MyResourceGroup -Name mystorageaccount -Location westus -SkuName Standard_GRS -Kind StorageV2 -AssignIdentity +``` + +This command creates a Storage account with Kind StorageV2. It also generates and assigns an identity that can be used to manage account keys through Azure KeyVault. + +### Example 4: Create a Storage account with NetworkRuleSet from JSON +```powershell +New-AzStorageAccount -ResourceGroupName MyResourceGroup -Name mystorageaccount -Location westus -Type Standard_LRS -NetworkRuleSet (@{bypass="Logging,Metrics"; + ipRules=(@{IPAddressOrRange="20.11.0.0/16";Action="allow"}, + @{IPAddressOrRange="10.0.0.0/7";Action="allow"}); + virtualNetworkRules=(@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"}, + @{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2";Action="allow"}); + defaultAction="Deny"}) +``` + +This command creates a Storage account that has NetworkRuleSet property from JSON + +### Example 5: Create a Storage account with Hierarchical Namespace enabled, Sftp enabled, and localuser enabled. +```powershell +New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -Location "US West" -SkuName "Standard_GRS" -Kind StorageV2 -EnableHierarchicalNamespace $true -EnableSftp $true -EnableLocalUser $true +``` + +This command creates a Storage account with Hierarchical Namespace enabled, Sftp enabled, and localuser enabled. + +### Example 6: Create a Storage account with Azure Files AAD DS Authentication, and enable large file share. +```powershell +New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -EnableAzureActiveDirectoryDomainServicesForFile $true -EnableLargeFileShare +``` + +This command creates a Storage account with Azure Files AAD DS Authentication, and enable large file share. + +### Example 7: Create a Storage account with enable Files Active Directory Domain Service Authentication and DefaultSharePermission. +```powershell +New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -EnableActiveDirectoryDomainServicesForFile $true ` + -ActiveDirectoryDomainName "mydomain.com" ` + -ActiveDirectoryNetBiosDomainName "mydomain.com" ` + -ActiveDirectoryForestName "mydomain.com" ` + -ActiveDirectoryDomainGuid "12345678-1234-1234-1234-123456789012" ` + -ActiveDirectoryDomainSid "S-1-5-21-1234567890-1234567890-1234567890" ` + -ActiveDirectoryAzureStorageSid "S-1-5-21-1234567890-1234567890-1234567890-1234" ` + -ActiveDirectorySamAccountName "samaccountname" ` + -ActiveDirectoryAccountType User ` + -DefaultSharePermission StorageFileDataSmbShareElevatedContributor +``` + +This command creates a Storage account withenable Files Active Directory Domain Service Authentication and DefaultSharePermission. + +### Example 8: Create a Storage account with Queue and Table Service use account-scoped encryption key, and Require Infrastructure Encryption. +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +PS C:\>New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -EncryptionKeyTypeForTable Account -EncryptionKeyTypeForQueue Account -RequireInfrastructureEncryption + +PS C:\>$account = Get-AzStorageAccount -ResourceGroupName $rgname -Name $accountName + +PS C:\>$account.Encryption.Services.Queue + +Enabled LastEnabledTime KeyType +------- --------------- ------- + True 1/9/2020 6:09:11 AM Account + +PS C:\>$account.Encryption.Services.Table + +Enabled LastEnabledTime KeyType +------- --------------- ------- + True 1/9/2020 6:09:11 AM Account + +PS C:\> $account.Encryption.RequireInfrastructureEncryption +True +``` + +This command creates a Storage account with Queue and Table Service use account-scoped encryption key and Require Infrastructure Encryption, so Queue and Table will use same encryption key with Blob and File service, and the service will apply a secondary layer of encryption with platform managed keys for data at rest. +Then get the Storage account properties, and view the encryption keytype of Queue and Table Service, and RequireInfrastructureEncryption value. + +### Example 9: Create account MinimumTlsVersion and AllowBlobPublicAccess, and disable SharedKey Access +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\> $account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -MinimumTlsVersion TLS1_1 -AllowBlobPublicAccess $false -AllowSharedKeyAccess $false + +PS C:\> $account.MinimumTlsVersion +TLS1_1 + +PS C:\> $account.AllowBlobPublicAccess +False + +PS C:\> $a.AllowSharedKeyAccess +False +``` + +The command create account with MinimumTlsVersion, AllowBlobPublicAccess, and disable SharedKey access to the account, and then show the the 3 properties of the created account + +### Example 10: Create a Storage account with RoutingPreference setting +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +PS C:\>$account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -PublishMicrosoftEndpoint $true -PublishInternetEndpoint $true -RoutingChoice MicrosoftRouting + +PS C:\>$account.RoutingPreference + +RoutingChoice PublishMicrosoftEndpoints PublishInternetEndpoints +------------- ------------------------- ------------------------ +MicrosoftRouting True True + +PS C:\>$account.PrimaryEndpoints + +Blob : https://mystorageaccount.blob.core.windows.net/ +Queue : https://mystorageaccount.queue.core.windows.net/ +Table : https://mystorageaccount.table.core.windows.net/ +File : https://mystorageaccount.file.core.windows.net/ +Web : https://mystorageaccount.z2.web.core.windows.net/ +Dfs : https://mystorageaccount.dfs.core.windows.net/ +MicrosoftEndpoints : {"Blob":"https://mystorageaccount-microsoftrouting.blob.core.windows.net/","Queue":"https://mystorageaccount-microsoftrouting.queue.core.windows.net/","Table":"https://mystorageaccount-microsoftrouting.table.core.windows.net/","File":"ht + tps://mystorageaccount-microsoftrouting.file.core.windows.net/","Web":"https://mystorageaccount-microsoftrouting.z2.web.core.windows.net/","Dfs":"https://mystorageaccount-microsoftrouting.dfs.core.windows.net/"} +InternetEndpoints : {"Blob":"https://mystorageaccount-internetrouting.blob.core.windows.net/","File":"https://mystorageaccount-internetrouting.file.core.windows.net/","Web":"https://mystorageaccount-internetrouting.z2.web.core.windows.net/","Dfs":"https://w + eirp3-internetrouting.dfs.core.windows.net/"} +``` + +This command creates a Storage account with RoutingPreference setting: PublishMicrosoftEndpoint and PublishInternetEndpoint as true, and RoutingChoice as MicrosoftRouting. + +### Example 11: Create a Storage account with EdgeZone and AllowCrossTenantReplication +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +PS C:\>$account = New-AzStorageAccount -ResourceGroupName "myresourcegroup" -Name "mystorageaccount" -SkuName Premium_LRS -Location westus -EdgeZone "microsoftlosangeles1" -AllowCrossTenantReplication $false + +PS C:\>$account.ExtendedLocation + +Name Type +---- ---- +microsoftlosangeles1 EdgeZone + +PS C:\> $account.AllowCrossTenantReplication +False +``` + +This command creates a Storage account with EdgeZone as "microsoftlosangeles1" and AllowCrossTenantReplication as false, then show the created account related properties. + +### Example 12: Create a Storage account with KeyExpirationPeriod and SasExpirationPeriod +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +PS C:\> $account = New-AzStorageAccount -ResourceGroupName "myresourcegroup" -Name "mystorageaccount" -SkuName Premium_LRS -Location eastus -KeyExpirationPeriodInDay 5 -SasExpirationPeriod "1.12:05:06" + +PS C:\> $account.KeyPolicy.KeyExpirationPeriodInDays +5 + +PS C:\> $account.SasPolicy.SasExpirationPeriod +1.12:05:06 +``` + +This command creates a Storage account with KeyExpirationPeriod and SasExpirationPeriod, then show the created account related properties. + +### Example 12: Create a Storage account with Keyvault encryption (access Keyvault with user assigned identity) +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +# Create KeyVault (no need if using exist keyvault) +PS C:\> $keyVault = New-AzKeyVault -VaultName $keyvaultName -ResourceGroupName $resourceGroupName -Location eastus2euap -EnablePurgeProtection +PS C:\> $key = Add-AzKeyVaultKey -VaultName $keyvaultName -Name $keyname -Destination 'Software' + +# create user assigned identity and grant access to keyvault (no need if using exist user assigned identity) +PS C:\> $userId = New-AzUserAssignedIdentity -ResourceGroupName $resourceGroupName -Name $userIdName +PS C:\> Set-AzKeyVaultAccessPolicy -VaultName $keyvaultName -ResourceGroupName $resourceGroupName -ObjectId $userId.PrincipalId -PermissionsToKeys get,wrapkey,unwrapkey -BypassObjectIdValidation +PS C:\> $useridentityId= $userId.Id + +# create Storage account with Keyvault encryption (access Keyvault with user assigned identity), then show properties +PS C:\> $account = New-AzStorageAccount -ResourceGroupName $resourceGroupName -Name $storageAccountName -Kind StorageV2 -SkuName Standard_LRS -Location eastus2euap ` + -IdentityType SystemAssignedUserAssigned -UserAssignedIdentityId $useridentityId ` + -KeyVaultUri $keyVault.VaultUri -KeyName $keyname -KeyVaultUserAssignedIdentityId $useridentityId + +PS C:\> $account.Encryption.EncryptionIdentity + +EncryptionUserAssignedIdentity +------------------------------ +/subscriptions/{subscription-id}/resourceGroups/myresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuserid + +PS C:\> $account.Encryption.KeyVaultProperties + +KeyName : wrappingKey +KeyVersion : +KeyVaultUri : https://mykeyvault.vault.azure.net:443 +CurrentVersionedKeyIdentifier : https://mykeyvault.vault.azure.net/keys/wrappingKey/8e74036e0d534e58b3bd84b319e31d8f +LastKeyRotationTimestamp : 4/12/2021 8:17:57 AM +``` + +This command first create a keyvault and a user assigned identity, then create a storage account with keyvault encryption (the storage access access keyvault with the user assigned identity). + +### Example 13: Create account with EnableNfsV3 +```powershell +$account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -SkuName Standard_LRS -Location centraluseuap -Kind StorageV2 -EnableNfsV3 $true -EnableHierarchicalNamespace $true -EnableHttpsTrafficOnly $false -NetworkRuleSet (@{bypass="Logging,Metrics"; + virtualNetworkRules=(@{VirtualNetworkResourceId="$vnet1";Action="allow"}); + defaultAction="deny"}) +$account.EnableNfsV3 +``` + +```output +True +``` + +The command create account with EnableNfsV3 as true, and then show the EnableNfsV3 property of the created account + +### Example 14: Create account with disable PublicNetworkAccess + +```powershell +$account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -SkuName Standard_LRS -Location centraluseuap -Kind StorageV2 -PublicNetworkAccess Disabled + +$account.PublicNetworkAccess +``` + +```output +Disabled +``` + +The command creates account with disable PublicNetworkAccess of the account. + +### Example 15: Create account with account level mmutability policy +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\> $account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -SkuName Standard_LRS -Location centraluseuap -Kind StorageV2 -EnableAccountLevelImmutability -ImmutabilityPeriod 1 -ImmutabilityPolicyState Unlocked + +PS C:\> $account.ImmutableStorageWithVersioning.Enabled +True + +PS C:\> $account.ImmutableStorageWithVersioning.ImmutabilityPolicy + +ImmutabilityPeriodSinceCreationInDays State +------------------------------------- ----- + 1 Unlocked +``` + +The command creates an account and enable account level immutability with versioning by '-EnableAccountLevelImmutability', then all the containers under this account will have object-level immutability enabled by default. +The account is also created with a default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. + +### Example 16: Create a Storage account with enable Azure Files Active Directory Domain Service Kerberos Authentication. +```powershell +New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -EnableAzureActiveDirectoryKerberosForFile $true ` + -ActiveDirectoryDomainName "mydomain.com" ` + -ActiveDirectoryDomainGuid "12345678-1234-1234-1234-123456789012" +``` + +This command creates a Storage account with enable Azure Files Active Directory Domain Service Kerberos Authentication. + +### Example 17: Create a Storage account with Keyvault from another tenant (access Keyvault with FederatedClientId) +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +# create Storage account with Keyvault encryption (access Keyvault with FederatedClientId), then show properties +PS C:\> $account = New-AzStorageAccount -ResourceGroupName $resourceGroupName -Name $storageAccountName -Kind StorageV2 -SkuName Standard_LRS -Location eastus2euap ` + -IdentityType SystemAssignedUserAssigned -UserAssignedIdentityId $useridentityId ` + -KeyVaultUri $keyVault.VaultUri -KeyName $keyname -KeyVaultUserAssignedIdentityId $useridentityId -KeyVaultFederatedClientId $federatedClientId + +PS C:\> $account.Encryption.EncryptionIdentity + +EncryptionUserAssignedIdentity EncryptionFederatedIdentityClientId +------------------------------ ----------------------------------- +/subscriptions/{subscription-id}/resourceGroups/myresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuserid ********-****-****-****-************ + +PS C:\> $account.Encryption.KeyVaultProperties + +KeyName : wrappingKey +KeyVersion : +KeyVaultUri : https://mykeyvault.vault.azure.net:443 +CurrentVersionedKeyIdentifier : https://mykeyvault.vault.azure.net/keys/wrappingKey/8e74036e0d534e58b3bd84b319e31d8f +LastKeyRotationTimestamp : 3/3/2022 2:07:34 AM +``` + +This command creates a storage account with Keyvault from another tenant (access Keyvault with FederatedClientId). + +### Example 18: Create account with DnsEndpointType as AzureDnsZone +```powershell +New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -SkuName Standard_LRS -Location centraluseuap -Kind StorageV2 -DnsEndpointType AzureDnsZone +``` + +The command creates a storage account with DnsEndpointType as AzureDnsZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. + +## PARAMETERS + +### -AccessTier +Specifies the access tier of the Storage account that this cmdlet creates. +The acceptable values for this parameter are: Hot and Cool. +If you specify a value of BlobStorage for the *Kind* parameter, you must specify a value for the +*AccessTier* parameter. If you specify a value of Storage for this *Kind* parameter, do not specify +the *AccessTier* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Hot, Cool + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryAccountType +Specifies the Active Directory account type for Azure Storage. Possible values include: 'User', 'Computer'. + +```yaml +Type: System.String +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryAzureStorageSid +Specifies the security identifier (SID) for Azure Storage. This parameter must be set when -EnableActiveDirectoryDomainServicesForFile is set to true. + +```yaml +Type: System.String +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryDomainGuid +Specifies the domain GUID. This parameter must be set when -EnableActiveDirectoryDomainServicesForFile is set to true. + +```yaml +Type: System.String +Parameter Sets: AzureActiveDirectoryKerberosForFile, ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryDomainName +Specifies the primary domain that the AD DNS server is authoritative for. This parameter must be set when -EnableActiveDirectoryDomainServicesForFile is set to true. + +```yaml +Type: System.String +Parameter Sets: AzureActiveDirectoryKerberosForFile, ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryDomainSid +Specifies the security identifier (SID). This parameter must be set when -EnableActiveDirectoryDomainServicesForFile is set to true. + +```yaml +Type: System.String +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryForestName +Specifies the Active Directory forest to get. This parameter must be set when -EnableActiveDirectoryDomainServicesForFile is set to true. + +```yaml +Type: System.String +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryNetBiosDomainName +Specifies the NetBIOS domain name. This parameter must be set when -EnableActiveDirectoryDomainServicesForFile is set to true. + +```yaml +Type: System.String +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectorySamAccountName +Specifies the Active Directory SAMAccountName for Azure Storage. + +```yaml +Type: System.String +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBlobPublicAccess +Allow public access to all blobs or containers in the storage account. The default interpretation is true for this property. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCrossTenantReplication +Gets or sets allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedCopyScope +Set restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. Possible values include: 'PrivateLink', 'AAD' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSharedKeyAccess +Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign a new Storage account Identity for this Storage account for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDomainName +Specifies the name of the custom domain of the Storage account. +The default value is Storage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSharePermission +Default share permission for users using Kerberos authentication if RBAC role is not assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, StorageFileDataSmbShareContributor, StorageFileDataSmbShareReader, StorageFileDataSmbShareElevatedContributor + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsEndpointType +Specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. Possible values include: 'Standard', 'AzureDnsZone'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EdgeZone +Set the extended location name for EdgeZone. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAccountLevelImmutability +Enables account-level immutability, then all the containers under this account will have object-level immutability enabled by default. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableActiveDirectoryDomainServicesForFile +Enable Azure Files Active Directory Domain Service Authentication for the storage account. + +```yaml +Type: System.Boolean +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAzureActiveDirectoryDomainServicesForFile +Enable Azure Files Azure Active Directory Domain Service Authentication for the storage account. + +```yaml +Type: System.Boolean +Parameter Sets: AzureActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAzureActiveDirectoryKerberosForFile +Enable Azure Files Active Directory Domain Service Kerberos Authentication for the storage account. + +```yaml +Type: System.Boolean +Parameter Sets: AzureActiveDirectoryKerberosForFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableHierarchicalNamespace +Indicates whether or not the Storage account enables Hierarchical Namespace. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableHttpsTrafficOnly +Indicates whether or not the Storage account only enables HTTPS traffic. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLargeFileShare +Indicates whether or not the storage account can support large file shares with more than 5 TiB capacity. +Once the account is enabled, the feature cannot be disabled. +Currently only supported for LRS and ZRS replication types, hence account conversions to geo-redundant accounts would not be possible. +Learn more in https://go.microsoft.com/fwlink/?linkid=2086047 + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLocalUser +Enable local users feature for the Storage account. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNfsV3 +Enable NFS 3.0 protocol support if sets to true + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSftp +Enable Secure File Transfer Protocol for the Storage account. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyTypeForQueue +Set the Encryption KeyType for Queue. The default value is Service. +-Account: Queue will be encrypted with account-scoped encryption key. +-Service: Queue will always be encrypted with Service-Managed keys. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Service, Account + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyTypeForTable +Set the Encryption KeyType for Table. The default value is Service. +- Account: Table will be encrypted with account-scoped encryption key. +- Service: Table will always be encrypted with Service-Managed keys. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Service, Account + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Set the new Storage Account Identity type, the idenetity is for use with key management services like Azure KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutabilityPeriod +The immutability period for the blobs in the container since the policy creation in days. +This property can only be only be specified with '-EnableAccountLevelImmutability'. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutabilityPolicyState +The mode of the policy. Possible values include: 'Unlocked', 'Disabled. +Disabled state disablesthe policy. +Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property. +A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. +This property can only be specified with '-EnableAccountLevelImmutability'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyExpirationPeriodInDay +The Key expiration period of this account, it is accurate to days. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +Storage Account encryption keySource KeyVault KeyName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultFederatedClientId +Set ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultUri +Storage Account encryption keySource KeyVault KeyVaultUri + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultUserAssignedIdentityId +Set resource id for user assigned Identity used to access Azure KeyVault of Storage Account Encryption, the id must in UserAssignIdentityId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVersion +Storage Account encryption keySource KeyVault KeyVersion + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Specifies the kind of Storage account that this cmdlet creates. +The acceptable values for this parameter are: +- Storage. General purpose Storage account that supports storage of Blobs, Tables, Queues, Files and Disks. +- StorageV2. General Purpose Version 2 (GPv2) Storage account that supports Blobs, Tables, Queues, Files, and Disks, with advanced features like data tiering. +- BlobStorage. Blob Storage account which supports storage of Blobs only. +- BlockBlobStorage. Block Blob Storage account which supports storage of Block Blobs only. +- FileStorage. File Storage account which supports storage of Files only. +The default value is StorageV2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Storage, StorageV2, BlobStorage, BlockBlobStorage, FileStorage + +Required: False +Position: Named +Default value: StorageV2 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the location of the Storage account to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +The minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TLS1_0, TLS1_1, TLS1_2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage account to create. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkRuleSet +NetworkRuleSet is used to define a set of configuration rules for firewalls and virtual networks, as well as to set values for network properties such as services allowed to bypass the rules and how to handle requests that don't match any of the defined rules. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSNetworkRuleSet +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Allow or disallow public network access to Storage Account.Possible values include: 'Enabled', 'Disabled'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishInternetEndpoint +Indicates whether internet routing storage endpoints are to be published + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishMicrosoftEndpoint +Indicates whether microsoft routing storage endpoints are to be published + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireInfrastructureEncryption +The service will apply a secondary layer of encryption with platform managed keys for data at rest. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group in which to add the Storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoutingChoice +Routing Choice defines the kind of network routing opted by the user. Possible values include: 'MicrosoftRouting', 'InternetRouting' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: MicrosoftRouting, InternetRouting + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SasExpirationPeriod +The SAS expiration period of this account, it is a timespan and accurate to seconds. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Specifies the SKU name of the Storage account that this cmdlet creates. +The acceptable values for this parameter are: +- Standard_LRS. Locally-redundant storage. +- Standard_ZRS. Zone-redundant storage. +- Standard_GRS. Geo-redundant storage. +- Standard_RAGRS. Read access geo-redundant storage. +- Premium_LRS. Premium locally-redundant storage. +- Premium_ZRS. Premium zone-redundant storage. +- Standard_GZRS - Geo-redundant zone-redundant storage. +- Standard_RAGZRS - Read access geo-redundant zone-redundant storage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountType, AccountType, Type +Accepted values: Standard_LRS, Standard_ZRS, Standard_GRS, Standard_RAGRS, Premium_LRS, Premium_ZRS, Standard_GZRS, Standard_RAGZRS + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table set as tags on the server. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +Set resource ids for the the new Storage Account user assigned Identity, the identity will be used with key management services like Azure KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseSubDomain +Indicates whether to enable indirect CName validation. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## NOTES + +## RELATED LINKS + +[Get-AzStorageAccount](./Get-AzStorageAccount.md) + +[Remove-AzStorageAccount](./Remove-AzStorageAccount.md) + +[Set-AzStorageAccount](./Set-AzStorageAccount.md) diff --git a/azps-10.1.0/Az.Storage/New-AzStorageAccountKey.md b/azps-10.1.0/Az.Storage/New-AzStorageAccountKey.md new file mode 100644 index 0000000000..a12eef7b91 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageAccountKey.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +ms.assetid: FDD2CE98-6C7E-4B95-BA5B-B03B6AC6EAEF +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstorageaccountkey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageAccountKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageAccountKey.md +--- + +# New-AzStorageAccountKey + +## SYNOPSIS +Regenerates a storage key for an Azure Storage account. + +## SYNTAX + +``` +New-AzStorageAccountKey [-ResourceGroupName] <String> [-Name] <String> [-KeyName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageAccountKey** cmdlet regenerates a storage key for an Azure Storage account. + +## EXAMPLES + +### Example 1: Regenerate a storage key +```powershell +New-AzStorageAccountKey -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -KeyName "key1" +``` + +This command regenerates a storage key for the specified Storage account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +Specifies which key to regenerate. +The acceptable values for this parameter are: +- key1 +- key2 +- kerb1 +- kerb2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: key1, key2, kerb1, kerb2 + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage account for which to regenerate a storage key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.Storage.Models.StorageAccountListKeysResult + +## NOTES + +## RELATED LINKS + +[Get-AzStorageAccountKey](./Get-AzStorageAccountKey.md) diff --git a/azps-10.1.0/Az.Storage/New-AzStorageAccountManagementPolicyBlobIndexMatchObject.md b/azps-10.1.0/Az.Storage/New-AzStorageAccountManagementPolicyBlobIndexMatchObject.md new file mode 100644 index 0000000000..19362e8d02 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageAccountManagementPolicyBlobIndexMatchObject.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/Az.storage/new-Azstorageaccountmanagementpolicyblobindexmatchobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageAccountManagementPolicyBlobIndexMatchObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageAccountManagementPolicyBlobIndexMatchObject.md +--- + +# New-AzStorageAccountManagementPolicyBlobIndexMatchObject + +## SYNOPSIS +Creates a ManagementPolicy BlobIndexMatch object, which can be used in New-AzStorageAccountManagementPolicyFilter. + +## SYNTAX + +``` +New-AzStorageAccountManagementPolicyBlobIndexMatchObject [-Name <String>] [-Value <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageAccountManagementPolicyBlobIndexMatchObject** cmdlet creates a ManagementPolicy BlobIndexMatch object, which can be used in New-AzStorageAccountManagementPolicyFilter. + +## EXAMPLES + +### Example 1: Creates 2 ManagementPolicy BlobIndexMatch object3, then add them to a management policy rule filter +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $blobindexmatch1 = New-AzStorageAccountManagementPolicyBlobIndexMatchObject -Name "tag1" -Value "value1" +PS C:\> $blobindexmatch1 + +Name Op Value +---- -- ----- +tag1 == value1 + +PS C:\> $blobindexmatch2 = New-AzStorageAccountManagementPolicyBlobIndexMatchObject -Name "tag2" -Value "value2" + +PS C:\> New-AzStorageAccountManagementPolicyFilter -PrefixMatch prefix1,prefix2 -BlobType blockBlob ` + -BlobIndexMatch $blobindexmatch1,$blobindexmatch2 + +PrefixMatch BlobTypes BlobIndexMatch +----------- --------- -------------- +{prefix1, prefix2} {blockBlob} {tag1, tag2} +``` + +This command creates 2 ManagementPolicy BlobIndexMatch objects, then add themto a management policy rule filter. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets this is the filter tag name, it can have 1 - 128 characters + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Gets or sets this is the filter tag value field used for tag based filtering, it can have 0 - 256 characters. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSTagFilter + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzStorageAccountManagementPolicyFilter.md b/azps-10.1.0/Az.Storage/New-AzStorageAccountManagementPolicyFilter.md new file mode 100644 index 0000000000..0ef792a39d --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageAccountManagementPolicyFilter.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/Az.storage/new-Azstorageaccountmanagementpolicyfilter +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageAccountManagementPolicyFilter.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageAccountManagementPolicyFilter.md +--- + +# New-AzStorageAccountManagementPolicyFilter + +## SYNOPSIS +Creates a ManagementPolicy rule filter object, which can be used in New-AzStorageAccountManagementPolicyRule. + +## SYNTAX + +``` +New-AzStorageAccountManagementPolicyFilter [-PrefixMatch <String[]>] [-BlobType <String[]>] + [-BlobIndexMatch <PSTagFilter[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageAccountManagementPolicyFilter** cmdlet creates a ManagementPolicy rule filter object, which can be used in New-AzStorageAccountManagementPolicyRule. + +## EXAMPLES + +### Example 1: Creates a ManagementPolicy rule filter object, then add it to a management policy rule and set to a Storage account +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\>$blobindexmatch1 = New-AzStorageAccountManagementPolicyBlobIndexMatchObject -Name "tag1" -Value "value1" +PS C:\>$blobindexmatch2 = New-AzStorageAccountManagementPolicyBlobIndexMatchObject -Name "tag2" -Value "value2" +PS C:\>$filter = New-AzStorageAccountManagementPolicyFilter -PrefixMatch blobprefix1,blobprefix2 -BlobType appendBlob,blockBlob -BlobIndexMatch $blobindexmatch1,$blobindexmatch2 +PS C:\>$filter + +PrefixMatch BlobTypes BlobIndexMatch +----------- --------- -------------- +{blobprefix1, blobprefix2} {appendBlob, blockBlob} {tag1, tag2} + +PS C:\>$action = Add-AzStorageAccountManagementPolicyAction -BaseBlobAction Delete -daysAfterModificationGreaterThan 100 +PS C:\>$rule = New-AzStorageAccountManagementPolicyRule -Name Test -Action $action -Filter $filter +PS C:\>$policy = Set-AzStorageAccountManagementPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -Rule $rule +``` + +This command create a ManagementPolicy rule filter object. Then add it to a management policy rule and set to a Storage account. + +## PARAMETERS + +### -BlobIndexMatch +An array of blob index tag based filters, there can be at most 10 tag filters. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSTagFilter[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobType +An array of strings for blobtypes to be match. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: blockBlob, appendBlob + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrefixMatch +An array of strings for prefixes to be match. +A prefix string must start with a container name. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSManagementPolicyRuleFilter + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzStorageAccountManagementPolicyRule.md b/azps-10.1.0/Az.Storage/New-AzStorageAccountManagementPolicyRule.md new file mode 100644 index 0000000000..aa9cd33dfa --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageAccountManagementPolicyRule.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/Az.storage/new-Azstorageaccountmanagementpolicyrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageAccountManagementPolicyRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageAccountManagementPolicyRule.md +--- + +# New-AzStorageAccountManagementPolicyRule + +## SYNOPSIS +Creates a ManagementPolicy rule object, which can be used in Set-AzStorageAccountManagementPolicy. + +## SYNTAX + +``` +New-AzStorageAccountManagementPolicyRule [-Name] <String> [-Disabled] -Action <PSManagementPolicyActionGroup> + [-Filter <PSManagementPolicyRuleFilter>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageAccountManagementPolicyRule** cmdlet creates a ManagementPolicy rule object, which can be used in Set-AzStorageAccountManagementPolicy. + +## EXAMPLES + +### Example 1: Creates a ManagementPolicy rule object, then set to a Storage Account +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\>$action = Add-AzStorageAccountManagementPolicyAction -BaseBlobAction Delete -daysAfterModificationGreaterThan 100 +PS C:\>$action = Add-AzStorageAccountManagementPolicyAction -BaseBlobAction TierToArchive -daysAfterModificationGreaterThan 50 -InputObject $action +PS C:\>$action = Add-AzStorageAccountManagementPolicyAction -BaseBlobAction TierToCool -daysAfterModificationGreaterThan 30 -InputObject $action +PS C:\>$action = Add-AzStorageAccountManagementPolicyAction -SnapshotAction Delete -daysAfterCreationGreaterThan 100 -InputObject $action + +PS C:\>$filter = New-AzStorageAccountManagementPolicyFilter -PrefixMatch blobprefix1,blobprefix2 + +PS C:\>$rule = New-AzStorageAccountManagementPolicyRule -Name rule1 -Action $action -Filter $filter +PS C:\>$rule + +Enabled : True +Name : rule1 +Definition : { + "Actions": { + "BaseBlob": { + "TierToCool": { + "DaysAfterModificationGreaterThan": 30 + }, + "TierToArchive": { + "DaysAfterModificationGreaterThan": 50 + }, + "Delete": { + "DaysAfterModificationGreaterThan": 100 + } + }, + "Snapshot": { + "Delete": { + "DaysAfterCreationGreaterThan": 100 + } + } + }, + "Filters": { + "PrefixMatch": [ + "blobprefix1", + "blobprefix2" + ], + "BlobTypes": [ + "blockBlob" + ] + } + } + +PS C:\>$policy = Set-AzStorageAccountManagementPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -Rule $rule +``` + +This command create a ManagementPolicy rule object, with a ManagementPolicy action group object contains 4 actions, a ManagementPolicy rule filter object, then set the rule to a Storage Account. + +## PARAMETERS + +### -Action +An object that defines the action set. +Get the Object with cmdlet Add-AzureStorageAccountManagementPolicyAction + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSManagementPolicyActionGroup +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +The rule is disabled if set it. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +An object that defines the filter set. +Get the Object with cmdlet New-AzureStorageAccountManagementPolicyFilter + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSManagementPolicyRuleFilter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +A rule name can contain any combination of alpha numeric characters. +Rule name is case-sensitive. +It must be unique within a policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSManagementPolicyRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzStorageAccountSASToken.md b/azps-10.1.0/Az.Storage/New-AzStorageAccountSASToken.md new file mode 100644 index 0000000000..bb8779a7d6 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageAccountSASToken.md @@ -0,0 +1,256 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: BCCBB05B-A5D7-4796-BE55-6BE5E18E07FC +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstorageaccountsastoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageAccountSASToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageAccountSASToken.md +--- + +# New-AzStorageAccountSASToken + +## SYNOPSIS +Creates an account-level SAS token. + +## SYNTAX + +``` +New-AzStorageAccountSASToken -Service <SharedAccessAccountServices> + -ResourceType <SharedAccessAccountResourceTypes> [-Permission <String>] [-Protocol <SharedAccessProtocol>] + [-IPAddressOrRange <String>] [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-EncryptionScope <String>] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageAccountSASToken** cmdlet creates an account-level shared access signature (SAS) token for an Azure Storage account. +You can use the SAS token to delegate permissions for multiple services, or to delegate permissions for services not available with an object-level SAS token. +An account SAS is secured using the storage account key. To create an account SAS, a client application must possess the account key. + +## EXAMPLES + +### Example 1: Create an account-level SAS token with full permission +```powershell +New-AzStorageAccountSASToken -Service Blob,File,Table,Queue -ResourceType Service,Container,Object -Permission "racwdlup" +``` + +This command creates an account-level SAS token with full permission. + +### Example 2: Create an account-level SAS token for a range of IP addresses and EncryptionScope +```powershell +New-AzStorageAccountSASToken -Service Blob,File,Table,Queue -ResourceType Service,Container,Object -Permission "racwdlup" -Protocol HttpsOnly -IPAddressOrRange 168.1.5.60-168.1.5.70 -EncryptionScope scopename +``` + +This command creates an account-level SAS token for HTTPS-only requests from the specified range of IP addresses, with a specific EncryptionScope. + +### Example 3: Create an account-level SAS token valid for 24 hours +```powershell +New-AzStorageAccountSASToken -Service Blob -ResourceType Service,Container,Object -Permission "rl" -ExpiryTime (Get-Date).AddDays(1) +``` + +This command creates an read-only account-level SAS token that is valid for 24 hours. + +## PARAMETERS + +### -Context +Specifies the Azure storage context. +You can use the New-AzStorageContext cmdlet to get an **AzureStorageContext** object. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionScope +Encryption scope to use when sending requests authorized with this SAS URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the time at which the shared access signature becomes invalid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressOrRange +Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. +The range is inclusive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +Specifies the permissions for Storage account. +Permissions are valid only if they match the specified resource type. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). +For more information about acceptable permission values, see Constructing an Account SAS http://go.microsoft.com/fwlink/?LinkId=799514 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol permitted for a request made with the account SAS. +The acceptable values for this parameter are: +- HttpsOnly +- HttpsOrHttp +The default value is HttpsOrHttp. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Storage.SharedAccessProtocol] +Parameter Sets: (All) +Aliases: +Accepted values: HttpsOnly, HttpsOrHttp + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +Specifies the resource types that are available with the SAS token. +The acceptable values for this parameter are: +- None +- Service +- Container +- Object + +```yaml +Type: Microsoft.Azure.Storage.SharedAccessAccountResourceTypes +Parameter Sets: (All) +Aliases: +Accepted values: None, Service, Container, Object + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Service +Specifies the service. +The acceptable values for this parameter are: +- None +- Blob +- File +- Queue +- Table + +```yaml +Type: Microsoft.Azure.Storage.SharedAccessAccountServices +Parameter Sets: (All) +Aliases: +Accepted values: None, Blob, File, Queue, Table + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies the time, as a **DateTime** object, at which the SAS becomes valid. +To get a **DateTime** object, use the Get-Date cmdlet. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[New-AzStorageBlobSASToken](./New-AzStorageBlobSASToken.md) + +[New-AzStorageContainerSASToken](./New-AzStorageContainerSASToken.md) + +[New-AzStorageFileSASToken](./New-AzStorageFileSASToken.md) + +[New-AzStorageQueueSASToken](./New-AzStorageQueueSASToken.md) + +[New-AzStorageShareSASToken](./New-AzStorageShareSASToken.md) + +[New-AzStorageTableSASToken](./New-AzStorageTableSASToken.md) + + diff --git a/azps-10.1.0/Az.Storage/New-AzStorageBlobInventoryPolicyRule.md b/azps-10.1.0/Az.Storage/New-AzStorageBlobInventoryPolicyRule.md new file mode 100644 index 0000000000..38f57d62d7 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageBlobInventoryPolicyRule.md @@ -0,0 +1,309 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstorageblobinventorypolicyrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageBlobInventoryPolicyRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageBlobInventoryPolicyRule.md +--- + +# New-AzStorageBlobInventoryPolicyRule + +## SYNOPSIS +Creates a blob inventory policy rule object, which can be used in Set-AzStorageBlobInventoryPolicy. + +## SYNTAX + +### BlobRuleParameterSet (Default) +``` +New-AzStorageBlobInventoryPolicyRule [-Name] <String> [-Disabled] -Destination <String> -Format <String> + -Schedule <String> -BlobSchemaField <String[]> -BlobType <String[]> [-PrefixMatch <String[]>] + [-ExcludePrefix <String[]>] [-IncludeSnapshot] [-IncludeBlobVersion] [-IncludeDeleted] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ContainerRuleParameterSet +``` +New-AzStorageBlobInventoryPolicyRule [-Name] <String> [-Disabled] -Destination <String> -Format <String> + -Schedule <String> -ContainerSchemaField <String[]> [-PrefixMatch <String[]>] [-ExcludePrefix <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageBlobInventoryPolicyRule** cmdlet creates a blob inventory policy rule object, which can be used in Set-AzStorageBlobInventoryPolicy. + +## EXAMPLES + +### Example 1: Create blob inventory policy rule objects, then sets blob inventory policy with the rule objects. +<!-- Skip: Output cannot be splitted from code --> + +``` +PS C:\> $rule1 = New-AzStorageBlobInventoryPolicyRule -Name Test1 -Destination $containerName -Disabled -Format Csv -Schedule Daily -ContainerSchemaField Name,Metadata,PublicAccess,Last-mOdified,LeaseStatus,LeaseState,LeaseDuration,HasImmutabilityPolicy,HasLegalHold -PrefixMatch con1,con2 + +PS C:\> $rule2 = New-AzStorageBlobInventoryPolicyRule -Name Test2 -Destination $containerName -Format Parquet -Schedule Weekly -IncludeBlobVersion -IncludeSnapshot -BlobType blockBlob,appendBlob -PrefixMatch aaa,bbb ` + -BlobSchemaField name,Creation-Time,Last-Modified,Content-Length,Content-MD5,BlobType,AccessTier,AccessTierChangeTime,Expiry-Time,hdi_isfolder,Owner,Group,Permissions,Acl,Metadata +PS C:\> $rule3 = New-AzStorageBlobInventoryPolicyRule -Name Test3 -Destination $containerName -Format Parquet -Schedule Weekly -IncludeBlobVersion -IncludeSnapshot -IncludeDeleted -BlobType blockBlob,appendBlob -PrefixMatch aaa,bbb ` + -ExcludePrefix ccc,ddd -BlobSchemaField name,Last-Modified,BlobType,AccessTier,AccessTierChangeTime,Content-Type,Content-CRC64,CopyId,x-ms-blob-sequence-number,TagCount + +PS C:\> $policy = Set-AzStorageBlobInventoryPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -Disabled -Rule $rule1,$rule2 + +PS C:\> $policy + +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegroup +Name : DefaultInventoryPolicy +Id : /subscriptions/{subscription-Id}/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount/inventoryPolicies/default +Type : Microsoft.Storage/storageAccounts/inventoryPolicies +LastModifiedTime : 5/12/2021 8:53:38 AM +Enabled : False +Rules : {Test1, Test2, Test3} + +PS C:\> $policy.Rules + +Name Enabled Destination ObjectType Format Schedule IncludeSnapshots IncludeBlobVersions IncludeDeleted BlobTypes PrefixMatch ExcludePrefix SchemaFields +---- ------- ----------- ---------- ------ -------- ---------------- ------------------- -------------- --------- ----------- ------------- ------------ +Test1 False containername Container Csv Daily {con1, con2} {Name, Metadata, PublicAccess, Last-Modified...} +Test2 True containername Blob Parquet Weekly True True {blockBlob, appendBlob} {aaa, bbb} {Name, Creation-Time, Last-Modified, Content-Length...} +Test3 True containername Blob Parquet Weekly True True True {blockBlob, appendBlob} {aaa, bbb} {ccc, ddd} {Name, Content-Type, Content-CRC64, Last-Modified...} +``` + +This first 3 commands create 3 BlobInventoryPolicy rule objects: rule "Test1" for contaienr inventory; rule "Test2" for blob inventory; rule "Test3" for blob inventory with more schema fields, excludePrefix specified, and IncludeDeleted enabled. +The following command sets blob inventory policy to a Storage account with the 3 rule objects, then show the updated policy and rules properties. + +## PARAMETERS + +### -BlobSchemaField +Specifies the fields and properties of the Blob object to be included in the inventory. Valid values include: Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Metadata, LastAccessTime, AccessTierInferred, Tags. +'Name' is a required schemafield. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl' are valid only for HierarchicalNamespace enabled accounts.'Tags' field is only valid for non HierarchicalNamespace accounts. +If specify '-IncludeSnapshot', will include 'Snapshot' in the inventory. If specify '-IncludeBlobVersion', will include 'VersionId, 'IsCurrentVersion' in the inventory. + +```yaml +Type: System.String[] +Parameter Sets: BlobRuleParameterSet +Aliases: +Accepted values: Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Metadata, LastAccessTime, AccessTierInferred, Tags, Etag, Content-Type, Content-Encoding, Content-Language, Content-CRC64, Cache-Control, Content-Disposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, x-ms-blob-sequence-number, EncryptionScope, IncrementalCopy, DeletionId, DeletedTime, TagCount + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobType +Sets the blob types for the blob inventory policy rule. +Valid values include blockBlob, appendBlob, pageBlob. +Hns accounts does not support pageBlobs. + +```yaml +Type: System.String[] +Parameter Sets: BlobRuleParameterSet +Aliases: +Accepted values: blockBlob, pageBlob, appendBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerSchemaField +Specifies the fields and properties of the container object to be included in the inventory. Valid values include: Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold. 'Name' is a required schemafield. + +```yaml +Type: System.String[] +Parameter Sets: ContainerRuleParameterSet +Aliases: +Accepted values: Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +The container name where blob inventory files are stored. Must be pre-created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +The rule is disabled if set it. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludePrefix +Sets an array of strings with maximum 10 blob prefixes to be excluded from the inventory. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +Specifies the format for the inventory files. Possible values include: 'Csv', 'Parquet' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Csv, Parquet + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeBlobVersion +The rule is disabled if set it. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BlobRuleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDeleted +Includes deleted blob in blob inventory. When include delete blob, for ContainerSchemaFields, must include 'Deleted, Version, DeletedTime and RemainingRetentionDays'. For BlobSchemaFields, on HNS enabled storage accounts, must include 'DeletionId, Deleted, DeletedTime and RemainingRetentionDays', and on Hns disabled accounts must include 'Deleted and RemainingRetentionDays', else they must be excluded. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BlobRuleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSnapshot +The rule is disabled if set it. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BlobRuleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +A rule name can contain any combination of alpha numeric characters. +Rule name is case-sensitive. +It must be unique within a policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrefixMatch +Sets an array of strings for blob prefixes to be matched.. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Schedule +This field is used to schedule an inventory formation. Possible values include: 'Daily', 'Weekly' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Daily, Weekly + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSBlobInventoryPolicyRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzStorageBlobQueryConfig.md b/azps-10.1.0/Az.Storage/New-AzStorageBlobQueryConfig.md new file mode 100644 index 0000000000..3ebeb9a46b --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageBlobQueryConfig.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/Az.storage/new-azstorageblobqueryconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageBlobQueryConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageBlobQueryConfig.md +--- + +# New-AzStorageBlobQueryConfig + +## SYNOPSIS +Creates a blob query configuration object, which can be used in Get-AzStorageBlobQueryResult. + +## SYNTAX + +### Csv (Default) +``` +New-AzStorageBlobQueryConfig [-AsCsv] [-RecordSeparator <String>] [-ColumnSeparator <String>] + [-QuotationCharacter <Char>] [-EscapeCharacter <Char>] [-HasHeader] [-AsJob] [<CommonParameters>] +``` + +### Json +``` +New-AzStorageBlobQueryConfig [-AsJson] [-RecordSeparator <String>] [-AsJob] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageBlobQueryConfig** cmdlet creates a blob query configuration object, which can be used in Get-AzStorageBlobQueryResult. + +## EXAMPLES + +### Example 1: Create blob query configures , and query a blob +```powershell +$inputconfig = New-AzStorageBlobQueryConfig -AsCsv -ColumnSeparator "," -QuotationCharacter """" -EscapeCharacter "\" -RecordSeparator "`n" -HasHeader + +$outputconfig = New-AzStorageBlobQueryConfig -AsJson -RecordSeparator "`n" + +$queryString = "SELECT * FROM BlobStorage WHERE Name = 'a'" + +$result = Get-AzStorageBlobQueryResult -Container $containerName -Blob $blobName -QueryString $queryString -ResultFile "c:\resultfile.json" -InputTextConfiguration $inputconfig -OutputTextConfiguration $outputconfig -Context $ctx + +$result +``` +```output +BytesScanned FailureCount BlobQueryError +------------ ------------ -------------- + 449 0 +``` + +This command first create input configuration object as csv, and output configuration object as json, then use the 2 configurations to query blob. + +## PARAMETERS + +### -AsCsv +Indicate to create a Blob Query Configuration for CSV. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Csv +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJson +Indicate to create a Blob Query Configuration for Json. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Json +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ColumnSeparator +Optional. +The string used to separate columns. + +```yaml +Type: System.String +Parameter Sets: Csv +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EscapeCharacter +Optional. +The char used as an escape character. + +```yaml +Type: System.Nullable`1[System.Char] +Parameter Sets: Csv +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasHeader +Optional. +Indicate it represent the data has headers. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Csv +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuotationCharacter +Optional. +The char used to quote a specific field. + +```yaml +Type: System.Char +Parameter Sets: Csv +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordSeparator +Optional. +The string used to separate records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.PSBlobQueryTextConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzStorageBlobRangeToRestore.md b/azps-10.1.0/Az.Storage/New-AzStorageBlobRangeToRestore.md new file mode 100644 index 0000000000..4cfb748493 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageBlobRangeToRestore.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstorageblobrangetorestore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageBlobRangeToRestore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageBlobRangeToRestore.md +--- + +# New-AzStorageBlobRangeToRestore + +## SYNOPSIS +Creates a Blob Range object to restores a Storage account. + +## SYNTAX + +``` +New-AzStorageBlobRangeToRestore [-StartRange <String>] [-EndRange <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageBlobRangeToRestore** cmdlet creates a Blob range object, which can be used in Restore-AzStorageBlobRange. + +## EXAMPLES + +### Example 1: Creates a blob range to restore +```powershell +$range = New-AzStorageBlobRangeToRestore -StartRange container1/blob1 -EndRange container2/blob2 +``` + +This command creates a blob range to restore, which starts at container1/blob1 (include), and ends at container2/blob2 (exclude). + +### Example 2: Creates a blob range which will restore from first blob in alphabetical order, to a specific blob (exclude) +```powershell +$range = New-AzStorageBlobRangeToRestore -StartRange "" -EndRange container2/blob2 +``` + +This command creates a blob range which will restore from first blob of alphabetical order, to a specific blob container2/blob2 (exclude) + +### Example 3: Creates a blob range which will restore from a specific blob (include), to the last blob in alphabetical order +```powershell +$range = New-AzStorageBlobRangeToRestore -StartRange container1/blob1 -EndRange "" +``` + +This command creates a blob range which will restore from a specific blob container1/blob1 (include), to the last blob in alphabetical order. + +### Example 4: Creates a blob range which will restore all blobs +```powershell +$range = New-AzStorageBlobRangeToRestore -StartRange "" -EndRange "" +``` + +This command creates a blob range which will restore all blobs. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndRange +Specify the blob restore End range. +End range will be excluded in restore blobs. +Set it as empty strng to restore to the end. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartRange +Specify the blob restore start range. +Start range will be included in restore blobs. +Set it as empty string to restore from begining. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSBlobRestoreRange + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzStorageBlobSASToken.md b/azps-10.1.0/Az.Storage/New-AzStorageBlobSASToken.md new file mode 100644 index 0000000000..9c2592e5ce --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageBlobSASToken.md @@ -0,0 +1,352 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 585371E3-D4CE-452E-B0B0-92B3ABD127E7 +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstorageblobsastoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageBlobSASToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageBlobSASToken.md +--- + +# New-AzStorageBlobSASToken + +## SYNOPSIS +Generates a SAS token for an Azure storage blob. + +## SYNTAX + +### BlobNameWithPermission (Default) +``` +New-AzStorageBlobSASToken [-Container] <String> [-Blob] <String> [-Permission <String>] + [-Protocol <SharedAccessProtocol>] [-IPAddressOrRange <String>] [-StartTime <DateTime>] + [-ExpiryTime <DateTime>] [-FullUri] [-EncryptionScope <String>] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobPipelineWithPolicy +``` +New-AzStorageBlobSASToken -CloudBlob <CloudBlob> [-BlobBaseClient <BlobBaseClient>] -Policy <String> + [-Protocol <SharedAccessProtocol>] [-IPAddressOrRange <String>] [-StartTime <DateTime>] + [-ExpiryTime <DateTime>] [-FullUri] [-EncryptionScope <String>] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobPipelineWithPermission +``` +New-AzStorageBlobSASToken -CloudBlob <CloudBlob> [-BlobBaseClient <BlobBaseClient>] [-Permission <String>] + [-Protocol <SharedAccessProtocol>] [-IPAddressOrRange <String>] [-StartTime <DateTime>] + [-ExpiryTime <DateTime>] [-FullUri] [-EncryptionScope <String>] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobNameWithPolicy +``` +New-AzStorageBlobSASToken [-Container] <String> [-Blob] <String> -Policy <String> + [-Protocol <SharedAccessProtocol>] [-IPAddressOrRange <String>] [-StartTime <DateTime>] + [-ExpiryTime <DateTime>] [-FullUri] [-EncryptionScope <String>] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageBlobSASToken** cmdlet generates a Shared Access Signature (SAS) token for an Azure storage blob. + +## EXAMPLES + +### Example 1: Generate a blob SAS token with full blob permission +```powershell +New-AzStorageBlobSASToken -Container "ContainerName" -Blob "BlobName" -Permission rwd +``` + +This example generates a blob SAS token with full blob permission. + +### Example 2: Generate a blob SAS token with life time +```powershell +$StartTime = Get-Date +$EndTime = $startTime.AddHours(2.0) +New-AzStorageBlobSASToken -Container "ContainerName" -Blob "BlobName" -Permission rwd -StartTime $StartTime -ExpiryTime $EndTime +``` + +This example generates a blob SAS token with life time. + +### Example 3: Generate a User Identity SAS token with storage context based on OAuth authentication +```powershell +$ctx = New-AzStorageContext -StorageAccountName $accountName -UseConnectedAccount +$StartTime = Get-Date +$EndTime = $startTime.AddDays(6) +New-AzStorageBlobSASToken -Container "ContainerName" -Blob "BlobName" -Permission rwd -StartTime $StartTime -ExpiryTime $EndTime -Context $ctx +``` + +This example generates a User Identity blob SAS token with storage context based on OAuth authentication + +## PARAMETERS + +### -Blob +Specifies the storage blob name. + +```yaml +Type: System.String +Parameter Sets: BlobNameWithPermission, BlobNameWithPolicy +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobBaseClient +BlobBaseClient Object + +```yaml +Type: Azure.Storage.Blobs.Specialized.BlobBaseClient +Parameter Sets: BlobPipelineWithPolicy, BlobPipelineWithPermission +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CloudBlob +Specifies the **CloudBlob** object. +To obtain a **CloudBlob** object, use the [Get-AzStorageBlob](./Get-AzStorageBlob.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlob +Parameter Sets: BlobPipelineWithPolicy, BlobPipelineWithPermission +Aliases: ICloudBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Container +Specifies the storage container name. + +```yaml +Type: System.String +Parameter Sets: BlobNameWithPermission, BlobNameWithPolicy +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies the storage context. +When the storage context is based on OAuth authentication, will generates a User Identity blob SAS token. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionScope +Encryption scope to use when sending requests authorized with this SAS URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies when the shared access signature expires. +When the storage context is based on OAuth authentication, the expire time must be in 7 days from current time, and must not be earlier than current time. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullUri +Indicates that this cmdlet return the full blob URI and the shared access signature token. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressOrRange +Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. +The range is inclusive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +Specifies the permissions for a storage blob. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). + +```yaml +Type: System.String +Parameter Sets: BlobNameWithPermission, BlobPipelineWithPermission +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies an Azure Stored Access Policy. + +```yaml +Type: System.String +Parameter Sets: BlobPipelineWithPolicy, BlobNameWithPolicy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol permitted for a request. +The acceptable values for this parameter are: +* HttpsOnly +* HttpsOrHttp +The default value is HttpsOrHttp. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Storage.SharedAccessProtocol] +Parameter Sets: (All) +Aliases: +Accepted values: HttpsOnly, HttpsOrHttp + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies the time at which the shared access signature becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Storage.Blob.CloudBlob + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzStorageBlob](./Get-AzStorageBlob.md) + +[New-AzStorageContainerSASToken](./New-AzStorageContainerSASToken.md) diff --git a/azps-10.1.0/Az.Storage/New-AzStorageContainer.md b/azps-10.1.0/Az.Storage/New-AzStorageContainer.md new file mode 100644 index 0000000000..df29607fd3 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageContainer.md @@ -0,0 +1,247 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 2B12BC19-EF8F-43F5-AF04-C570FEEA1AE6 +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragecontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageContainer.md +--- + +# New-AzStorageContainer + +## SYNOPSIS +Creates an Azure storage container. + +## SYNTAX + +### ContainerName (Default) +``` +New-AzStorageContainer [-Name] <String> [[-Permission] <BlobContainerPublicAccessType>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +### EncryptionScope +``` +New-AzStorageContainer [-Name] <String> [[-Permission] <BlobContainerPublicAccessType>] + -DefaultEncryptionScope <String> -PreventEncryptionScopeOverride <Boolean> [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageContainer** cmdlet creates an Azure storage container. + +## EXAMPLES + +### Example 1: Create an Azure storage container +```powershell +New-AzStorageContainer -Name "ContainerName" -Permission Off +``` + +This command creates a storage container. + +### Example 2: Create multiple Azure storage containers +```powershell +"container1 container2 container3".split() | New-AzStorageContainer -Permission Container +``` + +This example creates multiple storage containers. +It uses the **Split** method of the .NET **String** class and then passes the names on the pipeline. + +### Example 3: Create an Azure storage container with Encryption Scope +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $container = New-AzStorageContainer -Name "mycontainer" -DefaultEncryptionScope "myencryptscope" -PreventEncryptionScopeOverride $true + +PS C:\> $container.BlobContainerProperties.DefaultEncryptionScope +myencryptscope + +PS C:\> $container.BlobContainerProperties.PreventEncryptionScopeOverride +True +``` + +This command creates a storage container, with default Encryption Scope as myencryptscope, and prevert blob upload with different Encryption Scope to this container. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies a context for the new container. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultEncryptionScope +Default the container to use specified encryption scope for all writes. + +```yaml +Type: System.String +Parameter Sets: EncryptionScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the new container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Container + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Permission +Specifies the level of public access to this container. +By default, the container and any blobs in it can be accessed only by the owner of the storage account. +To grant anonymous users read permissions to a container and its blobs, you can set the container permissions to enable public access. +Anonymous users can read blobs in a publicly available container without authenticating the request. +The acceptable values for this parameter are: +- Container. +Provides full read access to a container and its blobs. +Clients can enumerate blobs in the container through anonymous request, but cannot enumerate containers in the storage account. +- Blob. +Provides read access to blob data throughout a container through anonymous request, but does not provide access to container data. +Clients cannot enumerate blobs in the container by using anonymous request. +- Off. +Which restricts access to only the storage account owner. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Storage.Blob.BlobContainerPublicAccessType] +Parameter Sets: (All) +Aliases: PublicAccess +Accepted values: Off, Container, Blob, Unknown + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreventEncryptionScopeOverride +Block override of encryption scope from the container default. + +```yaml +Type: System.Boolean +Parameter Sets: EncryptionScope +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the service side time-out interval, in seconds, for a request. +If the specified interval elapses before the service processes the request, the storage service returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageContainer + +## NOTES + +## RELATED LINKS + +[Get-AzStorageContainer](./Get-AzStorageContainer.md) + +[Remove-AzStorageContainer](./Remove-AzStorageContainer.md) + +[Set-AzStorageContainerAcl](./Set-AzStorageContainerAcl.md) + + diff --git a/azps-10.1.0/Az.Storage/New-AzStorageContainerSASToken.md b/azps-10.1.0/Az.Storage/New-AzStorageContainerSASToken.md new file mode 100644 index 0000000000..cf57767f3c --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageContainerSASToken.md @@ -0,0 +1,296 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 6FF04E82-4921-4F7B-83D0-6997316BC5FD +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragecontainersastoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageContainerSASToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageContainerSASToken.md +--- + +# New-AzStorageContainerSASToken + +## SYNOPSIS +Generates an SAS token for an Azure storage container. + +## SYNTAX + +### SasPolicy +``` +New-AzStorageContainerSASToken [-Name] <String> -Policy <String> [-Protocol <SharedAccessProtocol>] + [-IPAddressOrRange <String>] [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-FullUri] + [-EncryptionScope <String>] [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SasPermission +``` +New-AzStorageContainerSASToken [-Name] <String> [-Permission <String>] [-Protocol <SharedAccessProtocol>] + [-IPAddressOrRange <String>] [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-FullUri] + [-EncryptionScope <String>] [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageContainerSASToken** cmdlet generates a Shared Access Signature (SAS) token for an Azure storage container. + +## EXAMPLES + +### Example 1: Generate a container SAS token with full container permission +```powershell +New-AzStorageContainerSASToken -Name "Test" -Permission rwdl +``` + +This example generates a container SAS token with full container permission. + +### Example 2: Generate multiple container SAS token by pipeline +```powershell +Get-AzStorageContainer -Container test* | New-AzStorageContainerSASToken -Permission rwdl +``` + +This example generates multiple container SAS tokens by using the pipeline. + +### Example 3: Generate container SAS token with shared access policy +```powershell +New-AzStorageContainerSASToken -Name "Test" -Policy "PolicyName" +``` + +This example generates a container SAS token with shared access policy. + +### Example 3: Generate a User Identity container SAS token with storage context based on OAuth authentication +```powershell +$ctx = New-AzStorageContext -StorageAccountName $accountName -UseConnectedAccount +$StartTime = Get-Date +$EndTime = $startTime.AddDays(6) +New-AzStorageContainerSASToken -Name "ContainerName" -Permission rwd -StartTime $StartTime -ExpiryTime $EndTime -context $ctx +``` + +This example generates a User Identity container SAS token with storage context based on OAuth authentication + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +You can create it by using the New-AzStorageContext cmdlet. +When the storage context is based on OAuth authentication, will generates a User Identity container SAS token. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionScope +Encryption scope to use when sending requests authorized with this SAS URI. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the time at which the shared access signature becomes invalid. +If the user sets the start time but not the expiry time, the expiry time is set to the start time plus one hour. +If neither the start time nor the expiry time is specified, the expiry time is set to the current time plus one hour. +When the storage context is based on OAuth authentication, the expire time must be in 7 days from current time, and must not be earlier than current time. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullUri +Indicates that this cmdlet return the full blob URI and the shared access signature token. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressOrRange +Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. +The range is inclusive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies an Azure storage container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Container + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Permission +Specifies permissions for a storage container. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). The permissions that are supported for container resource type are described [here](https://learn.microsoft.com/rest/api/storageservices/create-service-sas#permissions-for-a-directory-container-or-blob). + +```yaml +Type: System.String +Parameter Sets: SasPermission +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies an Azure Stored Access Policy. + +```yaml +Type: System.String +Parameter Sets: SasPolicy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol permitted for a request. +The acceptable values for this parameter are: +* HttpsOnly +* HttpsOrHttp +The default value is HttpsOrHttp. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Storage.SharedAccessProtocol] +Parameter Sets: (All) +Aliases: +Accepted values: HttpsOnly, HttpsOrHttp + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies the time at which the shared access signature becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[New-AzStorageBlobSASToken](./New-AzStorageBlobSASToken.md) diff --git a/azps-10.1.0/Az.Storage/New-AzStorageContainerStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/New-AzStorageContainerStoredAccessPolicy.md new file mode 100644 index 0000000000..084c7419ac --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageContainerStoredAccessPolicy.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: C324F28A-7215-4F10-A012-92B4F6544BC0 +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragecontainerstoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageContainerStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageContainerStoredAccessPolicy.md +--- + +# New-AzStorageContainerStoredAccessPolicy + +## SYNOPSIS +Creates a stored access policy for an Azure storage container. + +## SYNTAX + +``` +New-AzStorageContainerStoredAccessPolicy [-Container] <String> [-Policy] <String> [-Permission <String>] + [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageContainerStoredAccessPolicy** cmdlet creates a stored access policy for an Azure storage container. + +## EXAMPLES + +### Example 1: Create a stored access policy in a storage container +```powershell +New-AzStorageContainerStoredAccessPolicy -Container "MyContainer" -Policy "Policy01" +``` + +This command creates an access policy named Policy01 in the storage container named MyContainer. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Specifies the Azure storage container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the time at which the stored access policy becomes invalid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +Specifies permissions in the stored access policy to access the container. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies a stored access policy, which includes the permissions for this SAS token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies the time at which the stored access policy becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzStorageContainerStoredAccessPolicy](./Get-AzStorageContainerStoredAccessPolicy.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[Remove-AzStorageContainerStoredAccessPolicy](./Remove-AzStorageContainerStoredAccessPolicy.md) + +[Set-AzStorageContainerStoredAccessPolicy](./Set-AzStorageContainerStoredAccessPolicy.md) + + diff --git a/azps-10.1.0/Az.Storage/New-AzStorageContext.md b/azps-10.1.0/Az.Storage/New-AzStorageContext.md new file mode 100644 index 0000000000..bb81301efd --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageContext.md @@ -0,0 +1,483 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 383402B2-6B7C-41AB-AFF9-36C86156B0A9 +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragecontext +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageContext.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageContext.md +--- + +# New-AzStorageContext + +## SYNOPSIS +Creates an Azure Storage context. + +## SYNTAX + +### OAuthAccount (Default) +``` +New-AzStorageContext [-StorageAccountName] <String> [-UseConnectedAccount] [-Protocol <String>] + [-Endpoint <String>] [<CommonParameters>] +``` + +### AccountNameAndKey +``` +New-AzStorageContext [-StorageAccountName] <String> [-StorageAccountKey] <String> [-Protocol <String>] + [-Endpoint <String>] [<CommonParameters>] +``` + +### AccountNameAndKeyEnvironment +``` +New-AzStorageContext [-StorageAccountName] <String> [-StorageAccountKey] <String> [-Protocol <String>] + -Environment <String> [<CommonParameters>] +``` + +### AnonymousAccount +``` +New-AzStorageContext [-StorageAccountName] <String> [-Anonymous] [-Protocol <String>] [-Endpoint <String>] + [<CommonParameters>] +``` + +### AnonymousAccountEnvironment +``` +New-AzStorageContext [-StorageAccountName] <String> [-Anonymous] [-Protocol <String>] -Environment <String> + [<CommonParameters>] +``` + +### SasToken +``` +New-AzStorageContext [-StorageAccountName] <String> -SasToken <String> [-Protocol <String>] + [-Endpoint <String>] [<CommonParameters>] +``` + +### SasTokenWithAzureEnvironment +``` +New-AzStorageContext [-StorageAccountName] <String> -SasToken <String> -Environment <String> + [<CommonParameters>] +``` + +### OAuthAccountEnvironment +``` +New-AzStorageContext [-StorageAccountName] <String> [-UseConnectedAccount] [-Protocol <String>] + -Environment <String> [<CommonParameters>] +``` + +### AccountNameAndKeyServiceEndpoint +``` +New-AzStorageContext [-StorageAccountName] <String> [-StorageAccountKey] <String> -BlobEndpoint <String> + [-FileEndpoint <String>] [-QueueEndpoint <String>] [-TableEndpoint <String>] [<CommonParameters>] +``` + +### SasTokenServiceEndpoint +``` +New-AzStorageContext -SasToken <String> [-BlobEndpoint <String>] [-FileEndpoint <String>] + [-QueueEndpoint <String>] [-TableEndpoint <String>] [<CommonParameters>] +``` + +### ConnectionString +``` +New-AzStorageContext -ConnectionString <String> [<CommonParameters>] +``` + +### LocalDevelopment +``` +New-AzStorageContext [-Local] [<CommonParameters>] +``` + +### AnonymousAccountServiceEndpoint +``` +New-AzStorageContext [-Anonymous] [-BlobEndpoint <String>] [-FileEndpoint <String>] [-QueueEndpoint <String>] + [-TableEndpoint <String>] [<CommonParameters>] +``` + +### OAuthAccountServiceEndpoint +``` +New-AzStorageContext [-UseConnectedAccount] [-BlobEndpoint <String>] [-FileEndpoint <String>] + [-QueueEndpoint <String>] [-TableEndpoint <String>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageContext** cmdlet creates an Azure Storage context. +The default Authentication of a Storage Context is OAuth (Azure AD), if only input Storage account name. +See details of authentication of the Storage Service in https://learn.microsoft.com/rest/api/storageservices/authorization-for-the-azure-storage-services. + +## EXAMPLES + +### Example 1: Create a context by specifying a storage account name and key +```powershell +New-AzStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" +``` + +This command creates a context for the account named ContosoGeneral that uses the specified key. + +### Example 2: Create a context by specifying a connection string +```powershell +New-AzStorageContext -ConnectionString "DefaultEndpointsProtocol=https;AccountName=ContosoGeneral;AccountKey=< Storage Key for ContosoGeneral ends with == >;" +``` + +This command creates a context based on the specified connection string for the account ContosoGeneral. + +### Example 3: Create a context for an anonymous storage account +```powershell +New-AzStorageContext -StorageAccountName "ContosoGeneral" -Anonymous -Protocol "http" +``` + +This command creates a context for anonymous use for the account named ContosoGeneral. +The command specifies HTTP as a connection protocol. + +### Example 4: Create a context by using the local development storage account +```powershell +New-AzStorageContext -Local +``` + +This command creates a context by using the local development storage account. +The command specifies the *Local* parameter. + +### Example 5: Get the container for the local developer storage account +```powershell +New-AzStorageContext -Local | Get-AzStorageContainer +``` + +This command creates a context by using the local development storage account, and then passes the new context to the **Get-AzStorageContainer** cmdlet by using the pipeline operator. +The command gets the Azure Storage container for the local developer storage account. + +### Example 6: Get multiple containers +```powershell +$Context01 = New-AzStorageContext -Local +$Context02 = New-AzStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" +($Context01, $Context02) | Get-AzStorageContainer +``` + +The first command creates a context by using the local development storage account, and then stores that context in the $Context01 variable. +The second command creates a context for the account named ContosoGeneral that uses the specified key, and then stores that context in the $Context02 variable. +The final command gets the containers for the contexts stored in $Context01 and $Context02 by using **Get-AzStorageContainer**. + +### Example 7: Create a context with an endpoint +```powershell +New-AzStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -Endpoint "contosoaccount.core.windows.net" +``` + +This command creates an Azure Storage context that has the specified storage endpoint. +The command creates the context for the account named ContosoGeneral that uses the specified key. + +### Example 8: Create a context with a specified environment +```powershell +New-AzStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -Environment "AzureChinaCloud" +``` + +This command creates an Azure storage context that has the specified Azure environment. +The command creates the context for the account named ContosoGeneral that uses the specified key. + +### Example 9: Create a context by using an SAS token +```powershell +$SasToken = New-AzStorageContainerSASToken -Name "ContosoMain" -Permission "rad" +$Context = New-AzStorageContext -StorageAccountName "ContosoGeneral" -SasToken $SasToken +$Context | Get-AzStorageBlob -Container "ContosoMain" +``` + +The first command generates an SAS token by using the **New-AzStorageContainerSASToken** cmdlet for the container named ContosoMain, and then stores that token in the $SasToken variable. +That token is for read, add, update, and delete permissions. +The second command creates a context for the account named ContosoGeneral that uses the SAS token stored in $SasToken, and then stores that context in the $Context variable. +The final command lists all the blobs associated with the container named ContosoMain by using the context stored in $Context. + +### Example 10: Create a context by using the OAuth Authentication +```powershell +Connect-AzAccount +$Context = New-AzStorageContext -StorageAccountName "myaccountname" -UseConnectedAccount +``` + +This command creates a context by using the OAuth (Azure AD) Authentication. + +### Example 11: Create a context by specifying a storage account name, storage account key and custom blob endpoint +```powershell +New-AzStorageContext -StorageAccountName "myaccountname" -StorageAccountKey "< Storage Key for myaccountname ends with == >" -BlobEndpoint "https://myaccountname.blob.core.windows.net/" +``` + +This command creates a context for the account named myaccountname with a key for the account, and specified blob endpoint. + +### Example 12: Create a context for an anonymous storage account with specified blob endpoint +```powershell +New-AzStorageContext -Anonymous -BlobEndpoint "https://myaccountname.blob.core.windows.net/" +``` + +This command creates a context for anonymous use for the account named myaccountname, with specified blob enpoint. + +### Example 13: Create a context by using an SAS token with specified endpoints +```powershell +$SasToken = New-AzStorageContainerSASToken -Name "MyContainer" -Permission "rad" +New-AzStorageContext -SasToken $SasToken -BlobEndpoint "https://myaccountname.blob.core.windows.net/" -TableEndpoint "https://myaccountname.table.core.windows.net/" -FileEndpoint "https://myaccountname.file.core.windows.net/" -QueueEndpoint "https://myaccountname.queue.core.windows.net/" +``` + +The first command generates an SAS token by using the New-AzStorageContainerSASToken cmdlet for the container named MyContainer, and then stores that token in the $SasToken variable. +The second command creates a context that uses the SAS token and a specified blob endpoint, table endpoint, file endpoint, and queue endpoint. + +### Example 14: Create a context by using the OAuth Authentication with a specified blob endpoint +```powershell +New-AzStorageContext -UseConnectedAccount -BlobEndpoint "https://myaccountname.blob.core.windows.net/" +``` + +This command creates a context by using the OAuth authentication with a specified blob endpoint. + +## PARAMETERS + +### -Anonymous +Indicates that this cmdlet creates an Azure Storage context for anonymous logon. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AnonymousAccount, AnonymousAccountEnvironment, AnonymousAccountServiceEndpoint +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobEndpoint +Azure storage blob service endpoint + +```yaml +Type: System.String +Parameter Sets: AccountNameAndKeyServiceEndpoint +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: SasTokenServiceEndpoint, AnonymousAccountServiceEndpoint, OAuthAccountServiceEndpoint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionString +Specifies a connection string for the Azure Storage context. + +```yaml +Type: System.String +Parameter Sets: ConnectionString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +Specifies the endpoint for the Azure Storage context. + +```yaml +Type: System.String +Parameter Sets: OAuthAccount, AccountNameAndKey, AnonymousAccount, SasToken +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Environment +Specifies the Azure environment. +The acceptable values for this parameter are: AzureCloud and AzureChinaCloud. +For more information, type `Get-Help Get-AzEnvironment`. + +```yaml +Type: System.String +Parameter Sets: AccountNameAndKeyEnvironment, AnonymousAccountEnvironment +Aliases: Name, EnvironmentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: SasTokenWithAzureEnvironment, OAuthAccountEnvironment +Aliases: Name, EnvironmentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FileEndpoint +Azure storage file service endpoint + +```yaml +Type: System.String +Parameter Sets: AccountNameAndKeyServiceEndpoint, SasTokenServiceEndpoint, AnonymousAccountServiceEndpoint, OAuthAccountServiceEndpoint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Local +Indicates that this cmdlet creates a context by using the local development storage account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: LocalDevelopment +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Transfer Protocol (https/http). + +```yaml +Type: System.String +Parameter Sets: OAuthAccount, AccountNameAndKey, AccountNameAndKeyEnvironment, AnonymousAccount, AnonymousAccountEnvironment, SasToken, OAuthAccountEnvironment +Aliases: +Accepted values: Http, Https + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueueEndpoint +Azure storage queue service endpoint + +```yaml +Type: System.String +Parameter Sets: AccountNameAndKeyServiceEndpoint, SasTokenServiceEndpoint, AnonymousAccountServiceEndpoint, OAuthAccountServiceEndpoint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SasToken +Specifies a Shared Access Signature (SAS) token for the context. + +```yaml +Type: System.String +Parameter Sets: SasToken, SasTokenWithAzureEnvironment, SasTokenServiceEndpoint +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountKey +Specifies an Azure Storage account key. +This cmdlet creates a context for the key that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: AccountNameAndKey, AccountNameAndKeyEnvironment, AccountNameAndKeyServiceEndpoint +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +Specifies an Azure Storage account name. +This cmdlet creates a context for the account that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: OAuthAccount, AccountNameAndKey, AccountNameAndKeyEnvironment, AnonymousAccount, AnonymousAccountEnvironment, SasToken, SasTokenWithAzureEnvironment, OAuthAccountEnvironment, AccountNameAndKeyServiceEndpoint +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableEndpoint +Azure storage table service endpoint + +```yaml +Type: System.String +Parameter Sets: AccountNameAndKeyServiceEndpoint, SasTokenServiceEndpoint, AnonymousAccountServiceEndpoint, OAuthAccountServiceEndpoint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseConnectedAccount +Indicates that this cmdlet creates an Azure Storage context with OAuth (Azure AD) Authentication. +The cmdlet will use OAuth Authentication by default, when other authentication not specified. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: OAuthAccount, OAuthAccountEnvironment, OAuthAccountServiceEndpoint +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Storage.AzureStorageContext + +## NOTES + +## RELATED LINKS + +[Get-AzStorageBlob](./Get-AzStorageBlob.md) + +[New-AzStorageContainerSASToken](./New-AzStorageContainerSASToken.md) + + diff --git a/azps-10.1.0/Az.Storage/New-AzStorageDirectory.md b/azps-10.1.0/Az.Storage/New-AzStorageDirectory.md new file mode 100644 index 0000000000..fe4188141c --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageDirectory.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 65962F9A-CC79-4B8B-9208-A993708FD36F +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragedirectory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageDirectory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageDirectory.md +--- + +# New-AzStorageDirectory + +## SYNOPSIS +Creates a directory. + +## SYNTAX + +### ShareName (Default) +``` +New-AzStorageDirectory [-ShareName] <String> [-Path] <String> [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +### Share +``` +New-AzStorageDirectory [-Share] <CloudFileShare> [-Path] <String> [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +### Directory +``` +New-AzStorageDirectory [-Directory] <CloudFileDirectory> [-Path] <String> [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageDirectory** cmdlet creates a directory. +This cmdlet returns a **CloudFileDirectory** object. + +## EXAMPLES + +### Example 1: Create a folder in a file share +```powershell +New-AzStorageDirectory -ShareName "ContosoShare06" -Path "ContosoWorkingFolder" +``` + +This command creates a folder named ContosoWorkingFolder in the file share named ContosoShare06. + +### Example 2: Create a folder in a file share specified in a file share object +```powershell +Get-AzStorageShare -Name "ContosoShare06" | New-AzStorageDirectory -Path "ContosoWorkingFolder" +``` + +This command uses the **Get-AzStorageShare** cmdlet to get the file share named ContosoShare06, and then passes it to the current cmdlet by using the pipeline operator. +The current cmdlet creates the folder named ContosoWorkingFolder in ContosoShare06. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Directory +Specifies a folder as a **CloudFileDirectory** object. +This cmdlet creates the folder in the location that this parameter specifies. +To obtain a directory, use the New-AzStorageDirectory cmdlet. +You can also use the Get-AzStorageFile cmdlet to obtain a directory. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileDirectory +Parameter Sets: Directory +Aliases: CloudFileDirectory + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Path +Specifies the path of a folder. +This cmdlet creates a folder for the path that this cmdlet specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Share +Specifies a **CloudFileShare** object. +This cmdlet creates a folder in the file share that this parameter specifies. +To obtain a **CloudFileShare** object, use the Get-AzStorageShare cmdlet. +This object contains the storage context. +If you specify this parameter, do not specify the *Context* parameter. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileShare +Parameter Sets: Share +Aliases: CloudFileShare + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareName +Specifies the name of the file share. +This cmdlet creates a folder in the file share that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Storage.File.CloudFileShare + +### Microsoft.Azure.Storage.File.CloudFileDirectory + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFileDirectory + +## NOTES + +## RELATED LINKS + +[Get-AzStorageFile](./Get-AzStorageFile.md) + +[Get-AzStorageShare](./Get-AzStorageShare.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[New-AzStorageDirectory](./New-AzStorageDirectory.md) + +[Remove-AzStorageDirectory](./Remove-AzStorageDirectory.md) diff --git a/azps-10.1.0/Az.Storage/New-AzStorageEncryptionScope.md b/azps-10.1.0/Az.Storage/New-AzStorageEncryptionScope.md new file mode 100644 index 0000000000..7f585639d3 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageEncryptionScope.md @@ -0,0 +1,262 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstorageencryptionscope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageEncryptionScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageEncryptionScope.md +--- + +# New-AzStorageEncryptionScope + +## SYNOPSIS +Creates an encryption scope for a Storage account. + +## SYNTAX + +### AccountName (Default) +``` +New-AzStorageEncryptionScope [-ResourceGroupName] <String> [-StorageAccountName] <String> + -EncryptionScopeName <String> [-StorageEncryption] [-RequireInfrastructureEncryption] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountNameKeyVault +``` +New-AzStorageEncryptionScope [-ResourceGroupName] <String> [-StorageAccountName] <String> + -EncryptionScopeName <String> [-KeyvaultEncryption] -KeyUri <String> [-RequireInfrastructureEncryption] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +New-AzStorageEncryptionScope -StorageAccount <PSStorageAccount> -EncryptionScopeName <String> + [-StorageEncryption] [-RequireInfrastructureEncryption] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AccountObjectKeyVault +``` +New-AzStorageEncryptionScope -StorageAccount <PSStorageAccount> -EncryptionScopeName <String> + [-KeyvaultEncryption] -KeyUri <String> [-RequireInfrastructureEncryption] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageEncryptionScope** cmdlet creates an encryption scope for a Storage account. + +## EXAMPLES + +### Example 1: Create an encryption scope with Storage Encryption +```powershell +New-AzStorageEncryptionScope -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -EncryptionScopeName testscope -StorageEncryption +``` +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name State Source KeyVaultKeyUri RequireInfrastructureEncryption +---- ----- ------ -------------- ------------------------------- +testscope Enabled Microsoft.Storage +``` + +This command creates an encryption scope with Storage Encryption. + +### Example 2: Create an encryption scope with Keyvault Encryption, and RequireInfrastructureEncryption +```powershell +New-AzStorageEncryptionScope -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" ` + -EncryptionScopeName testscope -KeyvaultEncryption -KeyUri "https://keyvalutname.vault.azure.net:443/keys/keyname/34a0ba563b4243d9a0ef2b1d3c0c7d57" ` + -RequireInfrastructureEncryption +``` +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name State Source KeyVaultKeyUri RequireInfrastructureEncryption +---- ----- ------ -------------- ------------------------------- +testscope Enabled Microsoft.Keyvault https://keyvalutname.vault.azure.net:443/keys/keyname/34a0ba563b4243d9a0ef2b1d3c0c7d57 True +``` + +This command creates an encryption scope with Keyvault Encryption and RequireInfrastructureEncryption. +The Storage account Identity need have get,wrapkey,unwrapkey permissions to the keyvault key. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionScopeName +Azure Storage EncryptionScope name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyUri +The key Uri + +```yaml +Type: System.String +Parameter Sets: AccountNameKeyVault, AccountObjectKeyVault +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyvaultEncryption +Create encryption scope with keySource as Microsoft.Keyvault + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AccountNameKeyVault, AccountObjectKeyVault +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireInfrastructureEncryption +The encryption scope will apply a secondary layer of encryption with platform managed keys for data at rest. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountNameKeyVault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject, AccountObjectKeyVault +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountNameKeyVault +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageEncryption +Create encryption scope with keySource as Microsoft.Storage. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AccountName, AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSEncryptionScope + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzStorageFileSASToken.md b/azps-10.1.0/Az.Storage/New-AzStorageFileSASToken.md new file mode 100644 index 0000000000..3749455497 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageFileSASToken.md @@ -0,0 +1,287 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: BB139312-A536-4B61-A005-6CAF02BE1637 +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragefilesastoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageFileSASToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageFileSASToken.md +--- + +# New-AzStorageFileSASToken + +## SYNOPSIS +Generates a shared access signature token for a Storage file. + +## SYNTAX + +### NameSasPermission +``` +New-AzStorageFileSASToken [-ShareName] <String> [-Path] <String> [-Permission <String>] + [-Protocol <SharedAccessProtocol>] [-IPAddressOrRange <String>] [-StartTime <DateTime>] + [-ExpiryTime <DateTime>] [-FullUri] [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### NameSasPolicy +``` +New-AzStorageFileSASToken [-ShareName] <String> [-Path] <String> -Policy <String> + [-Protocol <SharedAccessProtocol>] [-IPAddressOrRange <String>] [-StartTime <DateTime>] + [-ExpiryTime <DateTime>] [-FullUri] [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### FileSasPermission +``` +New-AzStorageFileSASToken -File <CloudFile> [-Permission <String>] [-Protocol <SharedAccessProtocol>] + [-IPAddressOrRange <String>] [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-FullUri] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### FileSasPolicy +``` +New-AzStorageFileSASToken -File <CloudFile> -Policy <String> [-Protocol <SharedAccessProtocol>] + [-IPAddressOrRange <String>] [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-FullUri] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageFileSASToken** cmdlet generates a shared access signature token for an Azure Storage file. + +## EXAMPLES + +### Example 1: Generate a shared access signature token that has full file permissions +```powershell +New-AzStorageFileSASToken -ShareName "ContosoShare" -Path "FilePath" -Permission "rwd" +``` + +This command generates a shared access signature token that has full permissions for the file that is named FilePath. + +### Example 2: Generate a shared access signature token that has a time limit +```powershell +$StartTime = Get-Date +$EndTime = $StartTime.AddHours(2.0) +New-AzStorageFileSASToken -ShareName "ContosoShare" -Path "FilePath" -Permission "rwd" -StartTime $StartTime -ExpiryTime $EndTime +``` + +The first command creates a **DateTime** object by using the Get-Date cmdlet. +The command stores the current time in the $StartTime variable. +The second command adds two hours to the object in $StartTime, and then stores the result in the $EndTime variable. +This object is a time two hours in the future. +The third command generates a shared access signature token that has the specified permissions. +This token becomes valid at the current time. +The token remains valid until time stored in $EndTime. + +## PARAMETERS + +### -Context +Specifies an Azure Storage context. +To obtain a context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: NameSasPermission, NameSasPolicy +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the time at which the shared access signature becomes invalid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +Specifies a **CloudFile** object. +You can create a cloud file or obtain one by using the Get-AzStorageFile cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFile +Parameter Sets: FileSasPermission, FileSasPolicy +Aliases: CloudFile + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -FullUri +Indicates that this cmdlet return the full blob URI and the shared access signature token. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressOrRange +Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. +The range is inclusive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the path of the file relative to a Storage share. + +```yaml +Type: System.String +Parameter Sets: NameSasPermission, NameSasPolicy +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Permission +Specifies the permissions for a Storage file. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). + +```yaml +Type: System.String +Parameter Sets: NameSasPermission, FileSasPermission +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the stored access policy for a file. + +```yaml +Type: System.String +Parameter Sets: NameSasPolicy, FileSasPolicy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol permitted for a request. +The acceptable values for this parameter are: +* HttpsOnly +* HttpsOrHttp +The default value is HttpsOrHttp. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Storage.SharedAccessProtocol] +Parameter Sets: (All) +Aliases: +Accepted values: HttpsOnly, HttpsOrHttp + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +Specifies the name of the Storage share. + +```yaml +Type: System.String +Parameter Sets: NameSasPermission, NameSasPolicy +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StartTime +Specifies the time at which the shared access signature becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Storage.File.CloudFile + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[New-AzStorageContext](./New-AzStorageContext.md) + +[New-AzStorageShareSASToken](./New-AzStorageShareSASToken.md) diff --git a/azps-10.1.0/Az.Storage/New-AzStorageLocalUserPermissionScope.md b/azps-10.1.0/Az.Storage/New-AzStorageLocalUserPermissionScope.md new file mode 100644 index 0000000000..c0349918e5 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageLocalUserPermissionScope.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragelocaluserpermissionscope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageLocalUserPermissionScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageLocalUserPermissionScope.md +--- + +# New-AzStorageLocalUserPermissionScope + +## SYNOPSIS +Creates a permission scope object, which can be used in Set-AzStorageLocalUser. + +## SYNTAX + +``` +New-AzStorageLocalUserPermissionScope -Permission <String> -Service <String> -ResourceName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageLocalUserPermissionScope** cmdlet creates a permission scope object, which can be used in Set-AzStorageLocalUser. + +## EXAMPLES + +### Example 1: Create permission scope objects, then create or update local user with the permission scope objects. +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\> $permissionScope1 = New-AzStorageLocalUserPermissionScope -Permission rw -Service blob -ResourceName container1 + +PS C:\> $permissionScope2 = New-AzStorageLocalUserPermissionScope -Permission rwd -Service file -ResourceName share2 + +PS C:\> $localuser = Set-AzStorageLocalUser -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -UserName testuser1 -HomeDirectory "/" -PermissionScope $permissionScope1,$permissionScope2 + +PS C:\> $localuser + + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name Sid HomeDirectory HasSharedKey HasSshKey HasSshPassword PermissionScopes SshAuthorizedKeys +---- --- ------------- ------------ --------- -------------- ---------------- ----------------- +testuser1 S-1-2-0-0000000000-000000000-0000000000-0000 / [container1,...] + +PS C:\> $localuser.PermissionScopes + +Permissions Service ResourceName +----------- ------- ------------ +rw blob container1 +rwd file share2 +``` + +This first 2 commands create 2 permission scope objects. +The following commands create or update a local user with the permission scope objects, then show the updated local user properties. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +Specify the permissions for the local user. Possible values include: Read(r), Write (w), Delete (d), List (l), and Create (c). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +Specify the name of resource, normally the container name or the file share name, used by the local user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Service +Specify the service used by the local user, e.g. +blob, file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSPermissionScope + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzStorageLocalUserSshPassword.md b/azps-10.1.0/Az.Storage/New-AzStorageLocalUserSshPassword.md new file mode 100644 index 0000000000..03e4f485a6 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageLocalUserSshPassword.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragelocalusersshpassword +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageLocalUserSshPassword.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageLocalUserSshPassword.md +--- + +# New-AzStorageLocalUserSshPassword + +## SYNOPSIS +Regenerate SSH password of a specified local user in a storage account. + +## SYNTAX + +### AccountName (Default) +``` +New-AzStorageLocalUserSshPassword [-ResourceGroupName] <String> [-StorageAccountName] <String> + -UserName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +New-AzStorageLocalUserSshPassword -StorageAccount <PSStorageAccount> -UserName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UserObject +``` +New-AzStorageLocalUserSshPassword [-InputObject] <PSLocalUser> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageLocalUserSshPassword** cmdlet regenerates SSH password of a specified local user in a storage account. + +## EXAMPLES + +### Example 1: Regenerate SSH password of a specified local user +```powershell +New-AzStorageLocalUserSshPassword -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -UserName testuser1 +``` + +```output +SshPassword +----------- +<hidden> +``` + +This command regenerates SSH password of a specified local user. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Local User Object to Regenerate Password Keys. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSLocalUser +Parameter Sets: UserObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserName +The name of local user. +The username must contain lowercase letters and numbers only. +It must be unique only within the storage account. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSLocalUserKeys + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzStorageLocalUserSshPublicKey.md b/azps-10.1.0/Az.Storage/New-AzStorageLocalUserSshPublicKey.md new file mode 100644 index 0000000000..f43087720b --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageLocalUserSshPublicKey.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragelocalusersshpublickey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageLocalUserSshPublicKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageLocalUserSshPublicKey.md +--- + +# New-AzStorageLocalUserSshPublicKey + +## SYNOPSIS +Creates a SSH public key object, which can be used in Set-AzStorageLocalUser. + +## SYNTAX + +``` +New-AzStorageLocalUserSshPublicKey -Key <String> [-Description <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageLocalUserSshPublicKey** cmdlet creates a SSH public key object, which can be used in Set-AzStorageLocalUser. + +## EXAMPLES + +### Example 1: Create SSH public key objects, then create or update local user with the SSH public key objects. +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\> $sshkey1 = New-AzStorageLocalUserSshPublicKey -Key "ssh-rsa keykeykeykeykey=" -Description "sshpulickey name1" + +PS C:\> $sshkey2 = New-AzStorageLocalUserSshPublicKey -Key "ssh-rsa keykeykeykeykew=" -Description "sshpulickey name2" + +PS C:\> $localuser = Set-AzStorageLocalUser -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -UserName testuser1 -HomeDirectory "/" -SshAuthorizedKey $sshkey1,$sshkey2 + +PS C:\> $localuser + + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name Sid HomeDirectory HasSharedKey HasSshKey HasSshPassword PermissionScopes SshAuthorizedKeys +---- --- ------------- ------------ --------- -------------- ---------------- ----------------- +testuser1 S-1-2-0-0000000000-000000000-0000000000-0000 / [ssh-rsa keykeykeykeykey=,...] + +PS C:\> $localuser.SshAuthorizedKeys + +Description Key +----------- --- +sshpulickey name1 ssh-rsa keykeykeykeykey= +sshpulickey name2 ssh-rsa keykeykeykeykew= +``` + +This first 2 commands create 2 SSH public key objects. +The following commands create or update a local user with the SSH public key objects, then show the updated local user properties. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the key. +It is used to store the function/usage of the key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Key +Specify ssh public key, the key data is base64 encoded. +The format should be: '\<keyType\> \<keyData\>', e.g. +ssh-rsa AAAABBBB + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSSshPublicKey + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzStorageObjectReplicationPolicyRule.md b/azps-10.1.0/Az.Storage/New-AzStorageObjectReplicationPolicyRule.md new file mode 100644 index 0000000000..7aa6f7b940 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageObjectReplicationPolicyRule.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/New-azstorageobjectreplicationpolicyrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageObjectReplicationPolicyRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageObjectReplicationPolicyRule.md +--- + +# New-AzStorageObjectReplicationPolicyRule + +## SYNOPSIS +Creates an object replication policy rule. + +## SYNTAX + +``` +New-AzStorageObjectReplicationPolicyRule -SourceContainer <String> -DestinationContainer <String> + [-PrefixMatch <String[]>] [-MinCreationTime <DateTime>] [-RuleId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzStorageObjectReplicationPolicy** cmdlet creates an object replication policy rule, which will be used in Set-AzStorageObjectReplicationPolicy cmdlet. + +## EXAMPLES + +### Example 1: Create an object replication policy rule with only source and destination account, and show its properties +```powershell +$rule1 = New-AzStorageObjectReplicationPolicyRule -SourceContainer src1 -DestinationContainer dest1 + +$rule1 +``` + +```output +RuleId SourceContainer DestinationContainer Filters.PrefixMatch Filters.MinCreationTime +------ --------------- -------------------- ------------------- ----------------------- + src1 dest1 {} +``` + +This command creates an object replication policy rule with only source and destination account, and show its properties. + +### Example 2: Create an object replication policy rule with all properties, and show its properties +```powershell +$rule2 = New-AzStorageObjectReplicationPolicyRule -SourceContainer src -DestinationContainer dest -MinCreationTime 2019-01-01T16:00:00Z -PrefixMatch a,abc,dd + +$rule2 +``` + +```output +RuleId SourceContainer DestinationContainer Filters.PrefixMatch Filters.MinCreationTime +------ --------------- -------------------- ------------------- ----------------------- + src dest {a, abc, dd} 2019-01-01T16:00:00Z +``` + +This command an object replication policy rule with all properties, and show its properties. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationContainer +The Destination Container name to replicate to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinCreationTime +Blobs created after the time will be replicated to the destination.. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrefixMatch +Filters the results to replicate only blobs whose names begin with the specified prefix. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleId +Object Replication Rule Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceContainer +The Source Container name to replicate from. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSObjectReplicationPolicyRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzStorageQueue.md b/azps-10.1.0/Az.Storage/New-AzStorageQueue.md new file mode 100644 index 0000000000..7a21b3655d --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageQueue.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: E9500392-6BE1-46EC-9AF5-9234281025E6 +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragequeue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageQueue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageQueue.md +--- + +# New-AzStorageQueue + +## SYNOPSIS +Creates a storage queue. + +## SYNTAX + +``` +New-AzStorageQueue [-Name] <String> [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageQueue** cmdlet creates a storage queue in Azure. + +## EXAMPLES + +### Example 1: Create an Azure storage queue +```powershell +New-AzStorageQueue -Name "queueabc" +``` + +This example creates a storage queue named queueabc. + +### Example 2: Create multiple azure storage queues +```powershell +"queue1 queue2 queue3".split() | New-AzStorageQueue +``` + +This example creates multiple storage queues. +It uses the Split method of the .NET String class and then passes the names on the pipeline. + +## PARAMETERS + +### -Context +Specifies the Azure storage context. +You can create it by using the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the queue. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Queue + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageQueue + +## NOTES + +## RELATED LINKS + +[Get-AzStorageQueue](./Get-AzStorageQueue.md) + +[Remove-AzStorageQueue](./Remove-AzStorageQueue.md) + + diff --git a/azps-10.1.0/Az.Storage/New-AzStorageQueueSASToken.md b/azps-10.1.0/Az.Storage/New-AzStorageQueueSASToken.md new file mode 100644 index 0000000000..124f08e7ec --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageQueueSASToken.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 42C669B6-B621-454C-B897-262E1C8E76E3 +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragequeuesastoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageQueueSASToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageQueueSASToken.md +--- + +# New-AzStorageQueueSASToken + +## SYNOPSIS +Generates a shared access signature token for an Azure storage queue. + +## SYNTAX + +### SasPolicy +``` +New-AzStorageQueueSASToken [-Name] <String> -Policy <String> [-Protocol <SharedAccessProtocol>] + [-IPAddressOrRange <String>] [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-FullUri] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SasPermission +``` +New-AzStorageQueueSASToken [-Name] <String> [-Permission <String>] [-Protocol <SharedAccessProtocol>] + [-IPAddressOrRange <String>] [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-FullUri] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageQueueSASToken** cmdlet generates shared access signature token for an Azure storage queue. + +## EXAMPLES + +### Example 1: Generate a queue SAS token with full permission +```powershell +New-AzStorageQueueSASToken -Name "Test" -Permission raup +``` + +This example generates a queue SAS token with full permission. + +## PARAMETERS + +### -Context +Specifies the Azure storage context. +You can create it by New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies when the shared access signature is no longer valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullUri +Indicates that this cmdlet return the full blob URI and the shared access signature token. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressOrRange +Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. +The range is inclusive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies an Azure storage queue name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Queue + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Permission +Specifies permissions for a storage queue. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). + +```yaml +Type: System.String +Parameter Sets: SasPermission +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies an Azure stored access policy. + +```yaml +Type: System.String +Parameter Sets: SasPolicy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol permitted for a request. +The acceptable values for this parameter are: +* HttpsOnly +* HttpsOrHttp +The default value is HttpsOrHttp. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Storage.SharedAccessProtocol] +Parameter Sets: (All) +Aliases: +Accepted values: HttpsOnly, HttpsOrHttp + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies when the shared access signature becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/New-AzStorageQueueStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/New-AzStorageQueueStoredAccessPolicy.md new file mode 100644 index 0000000000..9902effae8 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageQueueStoredAccessPolicy.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 351145AC-7C1E-4EB7-A17D-B8B7D8ED8DAB +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragequeuestoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageQueueStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageQueueStoredAccessPolicy.md +--- + +# New-AzStorageQueueStoredAccessPolicy + +## SYNOPSIS +Creates a stored access policy for an Azure storage queue. + +## SYNTAX + +``` +New-AzStorageQueueStoredAccessPolicy [-Queue] <String> [-Policy] <String> [-Permission <String>] + [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageQueueStoredAccessPolicy** cmdlet creates a stored access policy for an Azure storage queue. + +## EXAMPLES + +### Example 1: Create a stored access policy in a storage queue +```powershell +New-AzStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy01" +``` + +This command creates an access policy named Policy01 in the storage queue named MyQueue. + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the time at which the stored access policy becomes invalid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +Specifies permissions in the stored access policy to access the storage queue. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies a name for the stored access policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Queue +Specifies the Azure storage queue name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StartTime +Specifies the time at which the stored access policy becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzStorageQueueStoredAccessPolicy](./Get-AzStorageQueueStoredAccessPolicy.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[Remove-AzStorageQueueStoredAccessPolicy](./Remove-AzStorageQueueStoredAccessPolicy.md) + +[Set-AzStorageQueueStoredAccessPolicy](./Set-AzStorageQueueStoredAccessPolicy.md) + + diff --git a/azps-10.1.0/Az.Storage/New-AzStorageShare.md b/azps-10.1.0/Az.Storage/New-AzStorageShare.md new file mode 100644 index 0000000000..c899fd48fe --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageShare.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: FCDCEF0B-6E2C-480E-9841-EF4E64D61D54 +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstorageshare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageShare.md +--- + +# New-AzStorageShare + +## SYNOPSIS +Creates a file share. + +## SYNTAX + +``` +New-AzStorageShare [-Name] <String> [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageShare** cmdlet creates a file share. + +## EXAMPLES + +### Example 1: Create a file share +```powershell +New-AzStorageShare -Name "ContosoShare06" +``` + +This command creates a file share named ContosoShare06. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of a file share. +This cmdlet creates a file share that has the name that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFileShare + +## NOTES + +## RELATED LINKS + +[Get-AzStorageShare](./Get-AzStorageShare.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[Remove-AzStorageShare](./Remove-AzStorageShare.md) diff --git a/azps-10.1.0/Az.Storage/New-AzStorageShareSASToken.md b/azps-10.1.0/Az.Storage/New-AzStorageShareSASToken.md new file mode 100644 index 0000000000..7820ee6cd5 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageShareSASToken.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: BDF42420-3616-4A64-9562-1A896F828728 +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragesharesastoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageShareSASToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageShareSASToken.md +--- + +# New-AzStorageShareSASToken + +## SYNOPSIS +Generate Shared Access Signature token for Azure Storage share. + +## SYNTAX + +### SasPolicy +``` +New-AzStorageShareSASToken [-ShareName] <String> -Policy <String> [-Protocol <SharedAccessProtocol>] + [-IPAddressOrRange <String>] [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-FullUri] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SasPermission +``` +New-AzStorageShareSASToken [-ShareName] <String> [-Permission <String>] [-Protocol <SharedAccessProtocol>] + [-IPAddressOrRange <String>] [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-FullUri] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageShareSASToken** cmdlet generates a shared access signature token for an Azure Storage share. + +## EXAMPLES + +### Example 1: Generate a shared access signature token for a share +```powershell +New-AzStorageShareSASToken -ShareName "ContosoShare" -Permission "rwdl" +``` + +This command creates a shared access signature token for the share named ContosoShare. + +### Example 2: Generate multiple shared access signature token by using the pipeline +```powershell +Get-AzStorageShare -Prefix "test" | New-AzStorageShareSASToken -Permission "rwdl" +``` + +This command gets all the Storage shares that match the prefix test. +The command passes them to the current cmdlet by using the pipeline operator. +The current cmdlet creates a shared access token for each Storage share that has the specified permissions. + +### Example 3: Generate a shared access signature token that uses a shared access policy +```powershell +New-AzStorageShareSASToken -ShareName "ContosoShare" -Policy "ContosoPolicy03" +``` + +This command creates a shared access signature token for the Storage share named ContosoShare that has the policy named ContosoPolicy03. + +## PARAMETERS + +### -Context +Specifies an Azure Storage context. +To obtain a context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the time at which the shared access signature becomes invalid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullUri +Indicates that this cmdlet return the full blob URI and the shared access signature token. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressOrRange +Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. +The range is inclusive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +Specifies the permissions in the token to access the share and files under the share. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). + +```yaml +Type: System.String +Parameter Sets: SasPermission +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the stored access policy for a share. + +```yaml +Type: System.String +Parameter Sets: SasPolicy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol permitted for a request. +The acceptable values for this parameter are: +* HttpsOnly +* HttpsOrHttp +The default value is HttpsOrHttp. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Storage.SharedAccessProtocol] +Parameter Sets: (All) +Aliases: +Accepted values: HttpsOnly, HttpsOrHttp + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +Specifies the name of the Storage share. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StartTime +Specifies the time at which the shared access signature becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES +* Keywords: common, azure, services, data, storage, blob, queue, table + +## RELATED LINKS + +[Get-AzStorageShare](./Get-AzStorageShare.md) + +[New-AzStorageFileSASToken](./New-AzStorageFileSASToken.md) diff --git a/azps-10.1.0/Az.Storage/New-AzStorageShareStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/New-AzStorageShareStoredAccessPolicy.md new file mode 100644 index 0000000000..aabd28cf83 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageShareStoredAccessPolicy.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 37E76360-B683-407C-9AEF-7138374562D8 +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragesharestoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageShareStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageShareStoredAccessPolicy.md +--- + +# New-AzStorageShareStoredAccessPolicy + +## SYNOPSIS +Creates a stored access policy on a Storage share. + +## SYNTAX + +``` +New-AzStorageShareStoredAccessPolicy [-ShareName] <String> [-Policy] <String> [-Permission <String>] + [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageShareStoredAccessPolicy** cmdlet creates a stored access policy on an Azure Storage share. + +## EXAMPLES + +### Example 1: Create a stored access policy in a share +```powershell +New-AzStorageShareStoredAccessPolicy -ShareName "ContosoShare" -Policy "GeneralPolicy" -Permission "rwdl" +``` + +This command creates a stored access policy that has full permission in a share. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the time at which the stored access policy becomes invalid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +Specifies permissions in the stored access policy to access the Storage share or files under it. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies a name for the stored access policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +Specifies the name of the Storage share. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StartTime +Specifies the time at which the stored access policy becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzStorageShareStoredAccessPolicy](./Get-AzStorageShareStoredAccessPolicy.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[Remove-AzStorageShareStoredAccessPolicy](./Remove-AzStorageShareStoredAccessPolicy.md) + +[Set-AzStorageShareStoredAccessPolicy](./Set-AzStorageShareStoredAccessPolicy.md) diff --git a/azps-10.1.0/Az.Storage/New-AzStorageTable.md b/azps-10.1.0/Az.Storage/New-AzStorageTable.md new file mode 100644 index 0000000000..964495447a --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageTable.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 3B4F32F3-51ED-4851-B38F-172658186C96 +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageTable.md +--- + +# New-AzStorageTable + +## SYNOPSIS +Creates a storage table. + +## SYNTAX + +``` +New-AzStorageTable [-Name] <String> [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageTable** cmdlet creates a storage table associated with the storage account in Azure. + +## EXAMPLES + +### Example 1: Create an azure storage table +```powershell +New-AzStorageTable -Name "tableabc" +``` + +This command creates a storage table with a name of tableabc. + +### Example 2: Create multiple azure storage tables +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\>"table1 table2 table3".split() | New-AzStorageTable +``` + +This command creates multiple tables. +It uses the **Split** method of the .NET **String** class and then passes the names on the pipeline. + +## PARAMETERS + +### -Context +Specifies the storage context. +To create it, you can use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the new table. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Table + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable + +## NOTES + +## RELATED LINKS + +[Get-AzStorageTable](./Get-AzStorageTable.md) + +[Remove-AzStorageTable](./Remove-AzStorageTable.md) + + diff --git a/azps-10.1.0/Az.Storage/New-AzStorageTableSASToken.md b/azps-10.1.0/Az.Storage/New-AzStorageTableSASToken.md new file mode 100644 index 0000000000..4c3b47e382 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageTableSASToken.md @@ -0,0 +1,301 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 3CFA6E31-E243-4B22-AE8F-1942DD324639 +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragetablesastoken +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageTableSASToken.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageTableSASToken.md +--- + +# New-AzStorageTableSASToken + +## SYNOPSIS +Generates an SAS token for an Azure Storage table. + +## SYNTAX + +### SasPolicy +``` +New-AzStorageTableSASToken [-Name] <String> -Policy <String> [-Protocol <SharedAccessProtocol>] + [-IPAddressOrRange <String>] [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-FullUri] + [-StartPartitionKey <String>] [-StartRowKey <String>] [-EndPartitionKey <String>] [-EndRowKey <String>] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SasPermission +``` +New-AzStorageTableSASToken [-Name] <String> [-Permission <String>] [-Protocol <SharedAccessProtocol>] + [-IPAddressOrRange <String>] [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-FullUri] + [-StartPartitionKey <String>] [-StartRowKey <String>] [-EndPartitionKey <String>] [-EndRowKey <String>] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageTableSASToken** cmdlet generates a Shared Access Signature (SAS) token for an Azure Storage table. + +## EXAMPLES + +### Example 1: Generate an SAS token that has full permissions for a table +```powershell +New-AzStorageTableSASToken -Name "ContosoResources" -Permission "raud" +``` + +This command generates an SAS token with full permissions for the table named ContosoResources. +That token is for read, add, update, and delete permissions. + +### Example 2: Generate an SAS token for a range of partitions +```powershell +New-AzStorageTableSASToken -Name "ContosoResources" -Permission "raud" -StartPartitionKey "a" -EndPartitionKey "b" +``` + +This command generates and SAS token with full permissions for the table named ContosoResources. +The command limits the token to the range that the *StartPartitionKey* and *EndPartitionKey* parameters specify. + +### Example 3: Generate an SAS token that has a stored access policy for a table +```powershell +New-AzStorageTableSASToken -Name "ContosoResources" -Policy "ClientPolicy01" +``` + +This command generates an SAS token for the table named ContosoResources. +The command specifies the stored access policy named ClientPolicy01. + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndPartitionKey +Specifies the partition key of the end of the range for the token that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: endpk + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndRowKey +Specifies the row key for the end of the range for the token that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: endrk + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies when the SAS token expires. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullUri +Indicates that this cmdlet returns the full queue URI with the SAS token. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressOrRange +Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. +The range is inclusive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of an Azure Storage table. +This cmdlet creates an SAS token for the table that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Table + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Permission +Specifies permissions for an Azure Storage table. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). + +```yaml +Type: System.String +Parameter Sets: SasPermission +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies a stored access policy, which includes the permissions for this SAS token. + +```yaml +Type: System.String +Parameter Sets: SasPolicy +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies the protocol permitted for a request. +The acceptable values for this parameter are: +* HttpsOnly +* HttpsOrHttp +The default value is HttpsOrHttp. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Cosmos.Table.SharedAccessProtocol] +Parameter Sets: (All) +Aliases: +Accepted values: HttpsOnly, HttpsOrHttp + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartPartitionKey +Specifies the partition key of the start of the range for the token that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: startpk + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartRowKey +Specifies the row key for the start of the range for the token that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: startrk + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies when the SAS token becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[New-AzStorageContext](./New-AzStorageContext.md) diff --git a/azps-10.1.0/Az.Storage/New-AzStorageTableStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/New-AzStorageTableStoredAccessPolicy.md new file mode 100644 index 0000000000..be40c102a7 --- /dev/null +++ b/azps-10.1.0/Az.Storage/New-AzStorageTableStoredAccessPolicy.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: CF3B6E3B-3FC1-4871-AFE0-366B17A9E4F8 +online version: https://learn.microsoft.com/powershell/module/az.storage/new-azstoragetablestoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageTableStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/New-AzStorageTableStoredAccessPolicy.md +--- + +# New-AzStorageTableStoredAccessPolicy + +## SYNOPSIS +Creates a stored access policy for an Azure storage table. + +## SYNTAX + +``` +New-AzStorageTableStoredAccessPolicy [-Table] <String> [-Policy] <String> [-Permission <String>] + [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzStorageTableStoredAccessPolicy** cmdlet creates a stored access policy for an Azure storage table. + +## EXAMPLES + +### Example 1: Create a stored access policy in a table +```powershell +New-AzStorageTableStoredAccessPolicy -Table "MyTable" -Policy "Policy02" +``` + +This command creates an access policy named Policy02 in the storage table named MyTable. + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the time at which the stored access policy becomes invalid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +Specifies permissions in the stored access policy to access the storage table. +It is important to note that this is a string, like `raud` (for Read, Add, Update and Delete). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies a name for the stored access policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies the time at which the stored access policy becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Table +Specifies the Azure storage table name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzStorageTableStoredAccessPolicy](./Get-AzStorageTableStoredAccessPolicy.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[Remove-AzStorageTableStoredAccessPolicy](./Remove-AzStorageTableStoredAccessPolicy.md) + +[Set-AzStorageTableStoredAccessPolicy](./Set-AzStorageTableStoredAccessPolicy.md) + + diff --git a/azps-10.1.0/Az.Storage/Remove-AzDataLakeGen2AclRecursive.md b/azps-10.1.0/Az.Storage/Remove-AzDataLakeGen2AclRecursive.md new file mode 100644 index 0000000000..f439b9aa97 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzDataLakeGen2AclRecursive.md @@ -0,0 +1,349 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azdatalakegen2aclrecursive +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzDataLakeGen2AclRecursive.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzDataLakeGen2AclRecursive.md +--- + +# Remove-AzDataLakeGen2AclRecursive + +## SYNOPSIS +Remove ACL recursively on the specified path. + +## SYNTAX + +``` +Remove-AzDataLakeGen2AclRecursive [-FileSystem] <String> [[-Path] <String>] [-ContinuationToken <String>] + -Acl <PSPathAccessControlEntry[]> [-ContinueOnFailure] [-BatchSize <Int32>] [-MaxBatchCount <Int32>] [-AsJob] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeGen2AclRecursive** cmdlet removes ACL recursively on the specified path. +The ACL entries in original ACL, which has same AccessControlType, DefaultScope and EntityId with input ACL entries (even with different permission) wil lbe removed. + +## EXAMPLES + +### Example 1: Remove ACL recursively on a root directiry of filesystem +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\>$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType user -EntityId $id -Permission r-x -DefaultScope +PS C:\>$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType user -EntityId $id -Permission r-x -InputObject $acl +PS C:\> Remove-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Acl $acl -Context $ctx +WARNING: To find the ACL Entry to remove, will only compare AccessControlType, DefaultScope and EntityId, will omit Permission. + +FailedEntries : +TotalDirectoriesSuccessfulCount : 7 +TotalFilesSuccessfulCount : 5 +TotalFailureCount : 0 +ContinuationToken : +``` + +This command first creates an ACL object with 2 acl entries, then removes ACL recursively on a root directory of a file system. + +### Example 2: Remove ACL recursively on a directory +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $result = Remove-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path "dir1" -Acl $acl -Context $ctx +WARNING: To find the ACL Entry to remove, will only compare AccessControlType, DefaultScope and EntityId, will omit Permission. + +PS C:\> $result + +FailedEntries : {dir1/dir2/file4} +TotalDirectoriesSuccessfulCount : 500 +TotalFilesSuccessfulCount : 2500 +TotalFailureCount : 1 +ContinuationToken : VBaHi5TfyO2ai1wYTRhIL2FjbGNibjA2c3RmATAxRDVEN0UzRENFQzZCRTAvYWRsc3Rlc3QyATAxRDY2M0ZCQTZBN0JGQTkvZGlyMC9kaXIxL2ZpbGUzFgAAAA== + +PS C:\> $result.FailedEntries + +Name IsDirectory ErrorMessage +---- ----------- ------------ +dir0/dir2/file4 False This request is not authorized to perform this operation using this permission. + +# user need fix the failed item , then can resume with ContinuationToken + +PS C:\> $result = Remove-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path "dir1" -Acl $acl -ContinuationToken $result.ContinuationToken -Context $ctx +WARNING: To find the ACL Entry to remove, will only compare AccessControlType, DefaultScope and EntityId, will omit Permission. + +PS C:\> $result + +FailedEntries : +TotalDirectoriesSuccessfulCount : 100 +TotalFilesSuccessfulCount : 1000 +TotalFailureCount : 0 +ContinuationToken : +``` + +This command first removes ACL recursively on a directory and failed, then resume with ContinuationToken after user fix the failed file. + +### Example 3: Remove ACL recursively chunk by chunk +<!-- Skip: Output cannot be splitted from code --> +``` +$token = $null +$TotalDirectoriesSuccess = 0 +$TotalFilesSuccess = 0 +$totalFailure = 0 +$FailedEntries = New-Object System.Collections.Generic.List[System.Object] +do +{ + $result = Remove-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path "dir1" -Acl $acl -BatchSize 1000 -MaxBatchCount 50 -ContinuationToken $token -Context $ctx + + # echo $result + $TotalFilesSuccess += $result.TotalFilesSuccessfulCount + $TotalDirectoriesSuccess += $result.TotalDirectoriesSuccessfulCount + $totalFailure += $result.TotalFailureCount + $FailedEntries += $result.FailedEntries + $token = $result.ContinuationToken +}while (($token -ne $null) -and ($result.TotalFailureCount -eq 0)) +echo "" +echo "[Result Summary]" +echo "TotalDirectoriesSuccessfulCount: `t$($TotalDirectoriesSuccess)" +echo "TotalFilesSuccessfulCount: `t`t`t$($TotalFilesSuccess)" +echo "TotalFailureCount: `t`t`t`t`t$($totalFailure)" +echo "ContinuationToken: `t`t`t`t`t$($token)" +echo "FailedEntries:"$($FailedEntries | ft) +``` + +This script will remove ACL rescursively on directory chunk by chunk, with chunk size as BatchSize * MaxBatchCount. Chunk size is 50000 in this script. + +### Example 4: Remove ACL recursively on a directory and ContinueOnFailure, then resume from failures one by one +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $result = Remove-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path "dir1" -Acl $acl -ContinueOnFailure -Context $ctx + +PS C:\> $result + +FailedEntries : {dir0/dir1/file1, dir0/dir2/file4} +TotalDirectoriesSuccessfulCount : 100 +TotalFilesSuccessfulCount : 500 +TotalFailureCount : 2 +ContinuationToken : VBaHi5TfyO2ai1wYTRhIL2FjbGNibjA2c3RmATAxRDVEN0UzRENFQzZCRTAvYWRsc3Rlc3QyATAxRDY2M0ZCQTZBN0JGQTkvZGlyMC9kaXIxL2ZpbGUzFgAAAA== + +PS C:\> $result.FailedEntries + +Name IsDirectory ErrorMessage +---- ----------- ------------ +dir0/dir1/file1 False This request is not authorized to perform this operation using this permission. +dir0/dir2/file4 False This request is not authorized to perform this operation using this permission. + +# user need fix the failed item , then can resume with ContinuationToken + +PS C:\> foreach ($path in $result.FailedEntries.Name) + { + # user code to fix failed entry in $path + + #set ACL again + Remove-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path $path -Acl $acl -Context $ctx + } +``` + +This command first removes ACL recursively to a directory with ContinueOnFailure, and some items failed, then resume the failed items one by one. + +## PARAMETERS + +### -Acl +The POSIX access control list to set recursively for the file or directory. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSPathAccessControlEntry[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +If data set size exceeds batch size then operation will be split into multiple requests so that progress can be tracked. +Batch size should be between 1 and 2000. +Default is 2000. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ContinuationToken +Continuation Token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinueOnFailure +Set this parameter to ignore failures and continue proceeing with the operation on other sub-entities of the directory. Default the operation will terminate quickly on encountering failures. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +FileSystem name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaxBatchCount +Maximum number of batches that single change Access Control operation can execute. If data set size exceeds MaxBatchCount multiply BatchSize, continuation token will be return. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path in the specified FileSystem that to change Acl recursively. +Can be a file or directory. +In the format 'directory/file.txt' or 'directory1/directory2/'. +Skip set this parameter to change Acl recursively from root directory of the Filesystem. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Remove-AzDataLakeGen2Item.md b/azps-10.1.0/Az.Storage/Remove-AzDataLakeGen2Item.md new file mode 100644 index 0000000000..79cd5f611c --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzDataLakeGen2Item.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azdatalakegen2item +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzDataLakeGen2Item.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzDataLakeGen2Item.md +--- + +# Remove-AzDataLakeGen2Item + +## SYNOPSIS +Remove a file or directory. + +## SYNTAX + +### ReceiveManual (Default) +``` +Remove-AzDataLakeGen2Item [-FileSystem] <String> [-Path] <String> [-Force] [-AsJob] [-PassThru] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ItemPipeline +``` +Remove-AzDataLakeGen2Item -InputObject <AzureDataLakeGen2Item> [-Force] [-AsJob] [-PassThru] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzDataLakeGen2Item** cmdlet removes a file or directory from a Storage account. +This cmdlet only works if Hierarchical Namespace is enabled for the Storage account. This kind of account can be created by run "New-AzStorageAccount" cmdlet with "-EnableHierarchicalNamespace $true". + +## EXAMPLES + +### Example 1: Removes a directory +```powershell +Remove-AzDataLakeGen2Item -FileSystem "filesystem1" -Path "dir1/" +``` + +This command removes a directory from a Filesystem. + +### Example 2: Removes a file without prompt +```powershell +Remove-AzDataLakeGen2Item -FileSystem "filesystem1" -Path "dir1/file1" -Force +``` + +This command removes a directory from a Filesystem, without prompt. + +### Example 3: Remove all items in a Filesystem with pipeline +```powershell +Get-AzDataLakeGen2ChildItem -FileSystem "filesystem1" | Remove-AzDataLakeGen2Item -Force +``` + +This command removes all items in a Filesystem with pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +FileSystem name + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Force +Force to remove the Filesystem and all content in it + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure Datalake Gen2 Item Object to remove. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item +Parameter Sets: ItemPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Return whether the specified Filesystem is successfully removed + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path in the specified Filesystem that should be removed. +Can be a file or directory In the format 'directory/file.txt' or 'directory1/directory2/' + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Remove-AzRmStorageContainer.md b/azps-10.1.0/Az.Storage/Remove-AzRmStorageContainer.md new file mode 100644 index 0000000000..314a75018d --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzRmStorageContainer.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azrmstoragecontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzRmStorageContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzRmStorageContainer.md +--- + +# Remove-AzRmStorageContainer + +## SYNOPSIS +Removes a Storage blob container + +## SYNTAX + +### AccountName (Default) +``` +Remove-AzRmStorageContainer [-ResourceGroupName] <String> [-StorageAccountName] <String> -Name <String> + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Remove-AzRmStorageContainer -Name <String> -StorageAccount <PSStorageAccount> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ContainerObject +``` +Remove-AzRmStorageContainer -InputObject <PSContainer> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRmStorageContainer** cmdlet removes a Storage blob container + +## EXAMPLES + +### Example 1: Remove a Storage blob container with Storage account name and container name +```powershell +Remove-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" +``` + +This command removes a Storage blob container with Storage account name and container name. + +### Example 2: Remove a Storage blob container with Storage account object and container name +```powershell +$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" +Remove-AzRmStorageContainer -StorageAccount $accountObject -ContainerName "myContainer" +``` + +This command removes a Storage blob container with Storage account object and container name. + +### Example 3: Remove all Storage blob containers in a Storage account with pipeline +```powershell +Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" | Remove-AzRmStorageContainer -Force +``` + +This command removes all Storage blob containers in a Storage account with pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force to remove the container and all content in it + +```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 +``` + +### -InputObject +Storage container object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSContainer +Parameter Sets: ContainerObject +Aliases: Container + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +Container Name + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: N, ContainerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Remove-AzRmStorageContainerImmutabilityPolicy.md b/azps-10.1.0/Az.Storage/Remove-AzRmStorageContainerImmutabilityPolicy.md new file mode 100644 index 0000000000..34628bc6b2 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzRmStorageContainerImmutabilityPolicy.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azrmstoragecontainerimmutabilitypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzRmStorageContainerImmutabilityPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzRmStorageContainerImmutabilityPolicy.md +--- + +# Remove-AzRmStorageContainerImmutabilityPolicy + +## SYNOPSIS +Removes ImmutabilityPolicy of a Storage blob container with an unlocked policy + +## SYNTAX + +### AccountName (Default) +``` +Remove-AzRmStorageContainerImmutabilityPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -ContainerName <String> -Etag <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountObject +``` +Remove-AzRmStorageContainerImmutabilityPolicy -ContainerName <String> -StorageAccount <PSStorageAccount> + -Etag <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ContainerObject +``` +Remove-AzRmStorageContainerImmutabilityPolicy -Container <PSContainer> -Etag <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ImmutabilityPolicyObject +``` +Remove-AzRmStorageContainerImmutabilityPolicy [-InputObject] <PSImmutabilityPolicy> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRmStorageContainerImmutabilityPolicy** cmdlet removes ImmutabilityPolicy of a Storage blob container with an unlocked policy. + +## EXAMPLES + +### Example 1: Remove unlocked ImmutabilityPolicy of a Storage blob container with Storage account name and container name +```powershell +$policy = Get-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" +Remove-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Etag $policy.Etag +``` + +This command removes unlocked ImmutabilityPolicy of a Storage blob container with Storage account name and container name. + +### Example 2: Remove unlocked ImmutabilityPolicy of a Storage blob container, with Storage account object +```powershell +$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" +$policy = Get-AzRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" +Remove-AzRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" -Etag $policy.Etag +``` + +This command removes unlocked ImmutabilityPolicy of a Storage blob container, with Storage account object. + +### Example 3: Remove unlocked ImmutabilityPolicy of a Storage blob container, with container object +```powershell +$containerObject = Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -Name "myContainer" +$policy = Get-AzRmStorageContainerImmutabilityPolicy -Container $containerObject +Remove-AzRmStorageContainerImmutabilityPolicy -Container $containerObject -Etag $policy.Etag +``` + +This command removes unlocked ImmutabilityPolicy of a Storage blob container with Storage container object. + +### Example 4: Remove unlocked ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object +```powershell +Get-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" | Remove-AzRmStorageContainerImmutabilityPolicy +``` + +This command removes unlocked ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object. + +## PARAMETERS + +### -Container +Storage container object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSContainer +Parameter Sets: ContainerObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ContainerName +Container Name + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: N + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Immutability policy etag. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject, ContainerObject +Aliases: IfMatch + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Unlocked ImmutabilityPolicy Object to Remove + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy +Parameter Sets: ImmutabilityPolicyObject +Aliases: ImmutabilityPolicy + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer + +### Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Remove-AzRmStorageContainerLegalHold.md b/azps-10.1.0/Az.Storage/Remove-AzRmStorageContainerLegalHold.md new file mode 100644 index 0000000000..61fecf9924 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzRmStorageContainerLegalHold.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azrmstoragecontainerlegalhold +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzRmStorageContainerLegalHold.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzRmStorageContainerLegalHold.md +--- + +# Remove-AzRmStorageContainerLegalHold + +## SYNOPSIS +Removes legal hold tags from a Storage blob container + +## SYNTAX + +### AccountName (Default) +``` +Remove-AzRmStorageContainerLegalHold [-ResourceGroupName] <String> [-StorageAccountName] <String> + -Name <String> -Tag <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountObject +``` +Remove-AzRmStorageContainerLegalHold -Name <String> -StorageAccount <PSStorageAccount> -Tag <String[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ContainerObject +``` +Remove-AzRmStorageContainerLegalHold -Container <PSContainer> -Tag <String[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzRmStorageContainerLegalHold** cmdlet removes legal hold tags from a Storage blob container + +## EXAMPLES + +### Example 1: Remove legal hold tags from a Storage blob container with Storage account name and container name +```powershell +Remove-AzRmStorageContainerLegalHold -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Tag tag1 +``` + +This command removes legal hold tags from a Storage blob container with Storage account name and container name. + +### Example 2: Remove legal hold tags from a Storage blob container with Storage account object and container name +```powershell +$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" +Remove-AzRmStorageContainerLegalHold -StorageAccount $accountObject -ContainerName "myContainer" -Tag tag1,tag2 +``` + +This command removes legal hold tags from a Storage blob container with Storage account object and container name. + +### Example 3: Remove legal hold tags from all Storage blob containers in a Storage account with pipeline +```powershell +Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" | Remove-AzRmStorageContainerLegalHold -Tag tag1 +``` + +This command removes legal hold tags from all Storage blob containers in a Storage account with pipeline. + +## PARAMETERS + +### -Container +Storage container object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSContainer +Parameter Sets: ContainerObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container Name + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: N, ContainerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Container LegalHold Tags + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSLegalHold + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Remove-AzRmStorageShare.md b/azps-10.1.0/Az.Storage/Remove-AzRmStorageShare.md new file mode 100644 index 0000000000..2373c05838 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzRmStorageShare.md @@ -0,0 +1,325 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azrmstorageshare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzRmStorageShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzRmStorageShare.md +--- + +# Remove-AzRmStorageShare + +## SYNOPSIS +Removes a Storage file share. + +## SYNTAX + +### AccountName (Default) +``` +Remove-AzRmStorageShare [-ResourceGroupName] <String> [-StorageAccountName] <String> -Name <String> [-Force] + [-Include <String>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountNameSnapshot +``` +Remove-AzRmStorageShare [-ResourceGroupName] <String> [-StorageAccountName] <String> -Name <String> + -SnapshotTime <DateTime> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountObject +``` +Remove-AzRmStorageShare -Name <String> -StorageAccount <PSStorageAccount> [-Force] [-Include <String>] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObjectSnapshot +``` +Remove-AzRmStorageShare -Name <String> -StorageAccount <PSStorageAccount> -SnapshotTime <DateTime> [-Force] + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ShareResourceId +``` +Remove-AzRmStorageShare [-ResourceId] <String> [-Force] [-Include <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ShareObject +``` +Remove-AzRmStorageShare -InputObject <PSShare> [-Force] [-Include <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRmStorageShare** cmdlet removes a Storage file share. + +## EXAMPLES + +### Example 1: Remove a Storage file share with Storage account name and share name +```powershell +Remove-AzRmStorageShare -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount" -Name "myshare" +``` + +This command removes a Storage file share with Storage account name and share name. + +### Example 2: Remove a Storage file share with Storage account object and share name +```powershell +$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount" +Remove-AzRmStorageShare -StorageAccount $accountObject -Name "myshare" +``` + +This command removes a Storage file share with Storage account object and share name. + +### Example 3: Remove all Storage file shares in a Storage account with pipeline +```powershell +Get-AzRmStorageShare -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount" | Remove-AzRmStorageShare -Force +``` + +This command removes all Storage file shares in a Storage account with pipeline. + +### Example 4: Remove a single Storage file share snapshot +```powershell +Remove-AzRmStorageShare -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount" -Name "myshare" -SnapshotTime "2021-05-10T08:04:08Z" +``` + +This command removes a single Storage file share snapshot with the specific share name and snapshot time + +### Example 5: Remove a Storage file share and it's snapshots +```powershell +Remove-AzRmStorageShare -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount" -Name "myshare" -Include Snapshots +``` + +This command removes a Storage file share and it's snapshots +By default, the cmdlet will fail if the file share has snapshots without "-include" parameter. + +### Example 6: Remove a Storage file share and all it's snapshots (include leased snapshots) +```powershell +Remove-AzRmStorageShare -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount" -Name "myshare" -Include Leased-Snapshots +``` + +This command removes a Storage file share and all it's snapshots, include leased and not leased snapshots. +By default, the cmdlet will fail if the file share has snapshots without "-include" parameter. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force to remove the Share and all content in it + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Include +Valid values are: snapshots, leased-snapshots, none. The default value is none. +For 'none', the file share is deleted if it has no share snapshots.If the file share contains any snapshots(leased or unleased), the deletion fails. +For 'snapshots', the file share is deleted including all of its file share snapshots. If the file share contains leased snapshots, the deletion fails. +For 'leased-snapshots', the file share is deleted included all of its file share snapshots (leased / unleased). + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject, ShareResourceId, ShareObject +Aliases: +Accepted values: None, Snapshots, Leased-Snapshots + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Storage Share object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSShare +Parameter Sets: ShareObject +Aliases: Share + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Share Name + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountNameSnapshot, AccountObject, AccountObjectSnapshot +Aliases: N, ShareName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountNameSnapshot +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a File Share Resource Id. + +```yaml +Type: System.String +Parameter Sets: ShareResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SnapshotTime +Share SnapshotTime + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: AccountNameSnapshot, AccountObjectSnapshot +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject, AccountObjectSnapshot +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountNameSnapshot +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSShare + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageAccount.md b/azps-10.1.0/Az.Storage/Remove-AzStorageAccount.md new file mode 100644 index 0000000000..4d94d78436 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageAccount.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 006B4341-274C-4929-86EE-2E107BA9E485 +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageAccount.md +--- + +# Remove-AzStorageAccount + +## SYNOPSIS +Removes a Storage account from Azure. + +## SYNTAX + +``` +Remove-AzStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageAccount** cmdlet removes a Storage account from Azure. + +## EXAMPLES + +### Example 1: Remove a Storage account +```powershell +Remove-AzStorageAccount -ResourceGroupName "RG01" -Name "mystorageaccount" +``` + +This command removes the specified Storage account. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage account to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that contains the Storage account to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzStorageAccount](./Get-AzStorageAccount.md) + +[New-AzStorageAccount](./New-AzStorageAccount.md) + +[Set-AzStorageAccount](./Set-AzStorageAccount.md) + + diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageAccountManagementPolicy.md b/azps-10.1.0/Az.Storage/Remove-AzStorageAccountManagementPolicy.md new file mode 100644 index 0000000000..28fde282fa --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageAccountManagementPolicy.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/Az.storage/remove-Azstorageaccountmanagementpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageAccountManagementPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageAccountManagementPolicy.md +--- + +# Remove-AzStorageAccountManagementPolicy + +## SYNOPSIS +Removes the management policy of an Azure Storage account. + +## SYNTAX + +### AccountName (Default) +``` +Remove-AzStorageAccountManagementPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Remove-AzStorageAccountManagementPolicy -StorageAccount <PSStorageAccount> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountResourceId +``` +Remove-AzStorageAccountManagementPolicy [-StorageAccountResourceId] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PolicyObject +``` +Remove-AzStorageAccountManagementPolicy [-InputObject] <PSManagementPolicy> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageAccountManagementPolicy** cmdlet removes the management policy of an Azure Storage account. + +## EXAMPLES + +### Example 1: Remove the management policy of a Storage account. +```powershell +Remove-AzStorageAccountManagementPolicy -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" +``` + +This command removes the management policy of a Storage account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Management Object to Remove + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSManagementPolicy +Parameter Sets: PolicyObject +Aliases: ManagementPolicy + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Storage Account Resource Id. + +```yaml +Type: System.String +Parameter Sets: AccountResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageAccountNetworkRule.md b/azps-10.1.0/Az.Storage/Remove-AzStorageAccountNetworkRule.md new file mode 100644 index 0000000000..ba8c284457 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageAccountNetworkRule.md @@ -0,0 +1,321 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstorageaccountnetworkrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageAccountNetworkRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageAccountNetworkRule.md +--- + +# Remove-AzStorageAccountNetworkRule + +## SYNOPSIS +Remove IpRules or VirtualNetworkRules from the NetWorkRule property of a Storage account + +## SYNTAX + +### NetWorkRuleString (Default) +``` +Remove-AzStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> + -VirtualNetworkResourceId <String[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### IpRuleObject +``` +Remove-AzStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> -IPRule <PSIpRule[]> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NetworkRuleObject +``` +Remove-AzStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> + -VirtualNetworkRule <PSVirtualNetworkRule[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ResourceAccessRuleObject +``` +Remove-AzStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> + -ResourceAccessRule <PSResourceAccessRule[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### IpRuleString +``` +Remove-AzStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> -IPAddressOrRange <String[]> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceAccessRuleString +``` +Remove-AzStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> -TenantId <String> + -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageAccountNetworkRule** cmdlet removes IpRules or VirtualNetworkRules from the NetWorkRule property of a Storage account + +## EXAMPLES + +### Example 1: Remove several IpRules with IPAddressOrRange +```powershell +Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -IPAddressOrRange "10.0.0.0/7,28.1.0.0/16" +``` + +This command remove several IpRules with IPAddressOrRange. + +### Example 2: Remove a VirtualNetworkRule with VirtualNetworkRule Object input with JSON +```powershell +Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -VirtualNetworkRule (@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"}) +``` + +This command remove a VirtualNetworkRule with VirtualNetworkRule Object input with JSON. + +### Example 3: Remove first IpRule with pipeline +```powershell +(Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount").IpRules[0] | Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "myStorageAccount" +``` + +This command remove first IpRule with pipeline. + +### Example 4: Remove several VirtualNetworkRules with VirtualNetworkResourceID +```powershell +Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -VirtualNetworkResourceId "/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1","/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2" +``` + +This command remove several VirtualNetworkRules with VirtualNetworkResourceID. + +### Example 5: Remove a resource access rule with TenantId and ResourceId. +```powershell +Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -TenantId $tenantId -ResourceId $ResourceId +``` + +This command removes a resource access rule with TenantId and ResourceId. + +### Example 6: Remove the first 3 resource access rules from a storage account +```powershell +(Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount").ResourceAccessRules | Select-Object -First 3 | Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" +``` + +This command removes the first 3 resource access rules from a storage account. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAddressOrRange +The Array of IpAddressOrRange, will remove IpRule with same IpAddressOrRange from the NetWorkRule Property. + +```yaml +Type: System.String[] +Parameter Sets: IpRuleString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPRule +The Array of IpRule objects to remove from the NetWorkRule Property. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] +Parameter Sets: IpRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceAccessRule +Storage Account NetworkRule ResourceAccessRules. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSResourceAccessRule[] +Parameter Sets: ResourceAccessRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group contains the Storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +Storage Account ResourceAccessRule ResourceId in string. + +```yaml +Type: System.String +Parameter Sets: ResourceAccessRuleString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantId +Storage Account ResourceAccessRule TenantId in string. + +```yaml +Type: System.String +Parameter Sets: ResourceAccessRuleString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkResourceId +The Array of VirtualNetworkResourceId, will remove VirtualNetworkRule with same VirtualNetworkResourceId from the NetWorkRule Property. + +```yaml +Type: System.String[] +Parameter Sets: NetWorkRuleString +Aliases: SubnetId, VirtualNetworkId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkRule +The Array of VirtualNetworkRule objects to remove from the NetWorkRule Property. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] +Parameter Sets: NetworkRuleObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] + +### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule + +### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageBlob.md b/azps-10.1.0/Az.Storage/Remove-AzStorageBlob.md new file mode 100644 index 0000000000..75f5d599a9 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageBlob.md @@ -0,0 +1,395 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 03EC0D20-C737-4B2B-B8D9-71D06A938FAD +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstorageblob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageBlob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageBlob.md +--- + +# Remove-AzStorageBlob + +## SYNOPSIS +Removes the specified storage blob. + +## SYNTAX + +### NamePipeline (Default) +``` +Remove-AzStorageBlob [-Blob] <String> [-Container] <String> [-DeleteSnapshot] [-SnapshotTime <DateTimeOffset>] + [-VersionId <String>] [-Force] [-PassThru] [-TagCondition <String>] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BlobPipeline +``` +Remove-AzStorageBlob -CloudBlob <CloudBlob> [-BlobBaseClient <BlobBaseClient>] [-DeleteSnapshot] [-Force] + [-PassThru] [-TagCondition <String>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ContainerPipeline +``` +Remove-AzStorageBlob -CloudBlobContainer <CloudBlobContainer> [-Blob] <String> [-DeleteSnapshot] + [-SnapshotTime <DateTimeOffset>] [-VersionId <String>] [-Force] [-PassThru] [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageBlob** cmdlet removes the specified blob from a storage account in Azure. + +## EXAMPLES + +### Example 1: Remove a storage blob by name +```powershell +Remove-AzStorageBlob -Container "ContainerName" -Blob "BlobName" +``` + +This command removes a blob identified by its name. + +### Example 2: Remove a storage blob using the pipeline +```powershell +Get-AzStorageBlob -Container "ContainerName" -Blob "BlobName" | Remove-AzStorageBlob +``` + +This command uses the pipeline. + +### Example 3: Remove storage blobs using the pipeline +```powershell +Get-AzStorageContainer -Container container* | Remove-AzStorageBlob -Blob "BlobName" +``` + +This command uses the asterisk (*) wildcard character and the pipeline to retrieve the blob or blobs and then removes them. + +### Example 4: Remove a single blob version +```powershell +Remove-AzStorageBlob -Container "containername" -Blob blob2 -VersionId "2020-07-03T16:19:16.2883167Z" +``` + +This command removes a single blobs verion with VersionId. + +### Example 5: Remove a single blob snapshot +```powershell +Remove-AzStorageBlob -Container "containername" -Blob blob1 -SnapshotTime "2020-07-06T06:56:06.8588431Z" +``` + +This command removes a single blobs snapshot with SnapshotTime. + +## PARAMETERS + +### -Blob +Specifies the name of the blob you want to remove. + +```yaml +Type: System.String +Parameter Sets: NamePipeline, ContainerPipeline +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobBaseClient +BlobBaseClient Object + +```yaml +Type: Azure.Storage.Blobs.Specialized.BlobBaseClient +Parameter Sets: BlobPipeline +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudBlob +Specifies a cloud blob. +To obtain a **CloudBlob** object, use the Get-AzStorageBlob cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlob +Parameter Sets: BlobPipeline +Aliases: ICloudBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CloudBlobContainer +Specifies a **CloudBlobContainer** object from the Azure Storage Client library. +You can use the Get-AzStorageContainer cmdlet to get it. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlobContainer +Parameter Sets: ContainerPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Specifies the name of the container. + +```yaml +Type: System.String +Parameter Sets: NamePipeline +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies the Azure storage context. +You can use the New-AzStorageContext cmdlet to create it. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteSnapshot +Specifies that all snapshots be deleted, but not the base blob. +If this parameter is not specified, the base blob and its snapshots are deleted together. +The user is prompted to confirm the delete operation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet removes the blob and its snapshot without confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the Azure profile for the cmdlet to read. +If not specified, the cmdlet reads from the default profile. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SnapshotTime +Blob SnapshotTime + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: NamePipeline, ContainerPipeline +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagCondition +Optional Tag expression statement to check match condition. +The blob request will fail when the blob tags does not match the given expression. +See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VersionId +Blob VersionId + +```yaml +Type: System.String +Parameter Sets: NamePipeline, ContainerPipeline +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Storage.Blob.CloudBlob + +### Microsoft.Azure.Storage.Blob.CloudBlobContainer + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzStorageBlob](./Get-AzStorageBlob.md) + +[Get-AzStorageBlobContent](./Get-AzStorageBlobContent.md) + +[Set-AzStorageBlobContent](./Set-AzStorageBlobContent.md) diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageBlobImmutabilityPolicy.md b/azps-10.1.0/Az.Storage/Remove-AzStorageBlobImmutabilityPolicy.md new file mode 100644 index 0000000000..2cc715b2db --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageBlobImmutabilityPolicy.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstorageblobimmutabilitypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageBlobImmutabilityPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageBlobImmutabilityPolicy.md +--- + +# Remove-AzStorageBlobImmutabilityPolicy + +## SYNOPSIS +Removes ImmutabilityPolicy of a Storage blob. + +## SYNTAX + +### NamePipeline (Default) +``` +Remove-AzStorageBlobImmutabilityPolicy [-Blob] <String> [-Container] <String> [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BlobPipeline +``` +Remove-AzStorageBlobImmutabilityPolicy -BlobBaseClient <BlobBaseClient> [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageBlobImmutabilityPolicy** cmdlet removes immutability policy of a Storage blob. + +## EXAMPLES + +### Example 1: Removes immutability policy of a Storage blob. +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $blob = Remove-AzStorageBlobImmutabilityPolicy -Container $containerName -Blob $blobname + +PS C:\> $blob + + AccountName: mystorageaccount, ContainerName: mycontainer + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +testblob BlockBlob 10485760 application/octet-stream 2021-07-19 08:56:00Z Hot False 2021-07-19T08:56:01.8120788Z * + +PS C:\> $blob.BlobProperties.ImmutabilityPolicy + +ExpiresOn PolicyMode +--------- ---------- +``` + +This command removes ImmutabilityPolicy of a Storage blob, then show the result. + +## PARAMETERS + +### -Blob +Blob name + +```yaml +Type: System.String +Parameter Sets: NamePipeline +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobBaseClient +BlobBaseClient Object + +```yaml +Type: Azure.Storage.Blobs.Specialized.BlobBaseClient +Parameter Sets: BlobPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +The client side maximum execution time for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +The total amount of concurrent async tasks. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Container name + +```yaml +Type: System.String +Parameter Sets: NamePipeline +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +The server time out for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagCondition +Optional Tag expression statement to check match condition. The blob request will fail when the blob tags does not match the given expression.See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Azure.Storage.Blobs.Specialized.BlobBaseClient + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageBlobInventoryPolicy.md b/azps-10.1.0/Az.Storage/Remove-AzStorageBlobInventoryPolicy.md new file mode 100644 index 0000000000..ad9ebaace4 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageBlobInventoryPolicy.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstorageblobinventorypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageBlobInventoryPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageBlobInventoryPolicy.md +--- + +# Remove-AzStorageBlobInventoryPolicy + +## SYNOPSIS +Removes blob inventory policy from a Storage account. + +## SYNTAX + +### AccountName (Default) +``` +Remove-AzStorageBlobInventoryPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Remove-AzStorageBlobInventoryPolicy -StorageAccount <PSStorageAccount> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountResourceId +``` +Remove-AzStorageBlobInventoryPolicy [-StorageAccountResourceId] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PolicyObject +``` +Remove-AzStorageBlobInventoryPolicy [-InputObject] <PSBlobInventoryPolicy> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageBlobInventoryPolicy** cmdlet removes blob inventory policy from a Storage account. + +## EXAMPLES + +### Example 1: Remove blob inventory policy from a Storage account +```powershell +Remove-AzStorageBlobInventoryPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" +``` + +This command removes blob inventory policy from a Storage account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Management Object to Remove + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSBlobInventoryPolicy +Parameter Sets: PolicyObject +Aliases: BlobInventoryPolicy + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Storage Account Resource Id. + +```yaml +Type: System.String +Parameter Sets: AccountResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSManagementPolicy + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageCORSRule.md b/azps-10.1.0/Az.Storage/Remove-AzStorageCORSRule.md new file mode 100644 index 0000000000..5241dcfab8 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageCORSRule.md @@ -0,0 +1,162 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 26E06BA3-C550-40A5-B8E3-FEC8E9BF3867 +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstoragecorsrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageCORSRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageCORSRule.md +--- + +# Remove-AzStorageCORSRule + +## SYNOPSIS +Removes CORS for a Storage service. + +## SYNTAX + +``` +Remove-AzStorageCORSRule [-ServiceType] <StorageServiceType> [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageCORSRule** cmdlet removes Cross-Origin Resource Sharing (CORS) for an Azure Storage service. +This cmdlet deletes all CORS rules in a Storage service type. +The types of storage services for this cmdlet are Blob, Table, Queue, and File. + +## EXAMPLES + +### Example 1: Remove CORS rules for the blob service +```powershell +Remove-AzStorageCORSRule -ServiceType Blob +``` + +This command removes CORS rules for the Blob service type. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies the Azure storage context. +To obtain the storage context, the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceType +Specifies the Azure Storage service type for which this cmdlet removes rules. +The acceptable values for this parameter are: +- Blob +- Table +- Queue +- File + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType +Parameter Sets: (All) +Aliases: +Accepted values: Blob, Table, Queue, File + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzStorageCORSRule](./Get-AzStorageCORSRule.md) + +[Set-AzStorageCORSRule](./Set-AzStorageCORSRule.md) + + diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageContainer.md b/azps-10.1.0/Az.Storage/Remove-AzStorageContainer.md new file mode 100644 index 0000000000..97a042bb4c --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageContainer.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 6A46DA60-2ACF-4842-B5B3-58944264854A +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstoragecontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageContainer.md +--- + +# Remove-AzStorageContainer + +## SYNOPSIS +Removes the specified storage container. + +## SYNTAX + +``` +Remove-AzStorageContainer [-Name] <String> [-Force] [-PassThru] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageContainer** cmdlet removes the specified storage container in Azure. + +## EXAMPLES + +### Example 1: Remove a container +```powershell +Remove-AzStorageContainer -Name "MyTestContainer" +``` + +This example removes a container named MyTestContainer. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies a context for the container you want to remove. +You can use the New-AzStorageContext cmdlet to create it. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the container to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Container + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the service side time-out interval, in seconds, for a request. +If the specified interval elapses before the service processes the request, the storage service returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzStorageContainer](./Get-AzStorageContainer.md) + +[New-AzStorageContainer](./New-AzStorageContainer.md) diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageContainerStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/Remove-AzStorageContainerStoredAccessPolicy.md new file mode 100644 index 0000000000..e7491a9cbf --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageContainerStoredAccessPolicy.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 3E79EE05-7E52-4C54-B985-441BC2599925 +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstoragecontainerstoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageContainerStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageContainerStoredAccessPolicy.md +--- + +# Remove-AzStorageContainerStoredAccessPolicy + +## SYNOPSIS +Removes a stored access policy from an Azure storage container. + +## SYNTAX + +``` +Remove-AzStorageContainerStoredAccessPolicy [-Container] <String> [-Policy] <String> [-PassThru] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageContainerStoredAccessPolicy** cmdlet removes a stored access policy from an Azure storage container. + +## EXAMPLES + +### Example 1: Remove a stored access policy from a storage container +```powershell +Remove-AzStorageContainerStoredAccessPolicy -Container "MyContainer" -Policy "Policy03" +``` + +This command removes an access policy named Policy03 from the stored container named MyContainer. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Specifies the Azure storage container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the name of the stored access policy that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzStorageContainerStoredAccessPolicy](./Get-AzStorageContainerStoredAccessPolicy.md) + +[New-AzStorageContainerStoredAccessPolicy](./New-AzStorageContainerStoredAccessPolicy.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[Set-AzStorageContainerStoredAccessPolicy](./Set-AzStorageContainerStoredAccessPolicy.md) diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageDirectory.md b/azps-10.1.0/Az.Storage/Remove-AzStorageDirectory.md new file mode 100644 index 0000000000..4d0f95e8f3 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageDirectory.md @@ -0,0 +1,293 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 53988D79-1F8B-4138-9F92-2912D418C121 +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstoragedirectory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageDirectory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageDirectory.md +--- + +# Remove-AzStorageDirectory + +## SYNOPSIS +Deletes a directory. + +## SYNTAX + +### ShareName (Default) +``` +Remove-AzStorageDirectory [-ShareName] <String> [-Path] <String> [-PassThru] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Share +``` +Remove-AzStorageDirectory [-Share] <CloudFileShare> [-Path] <String> [-PassThru] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Directory +``` +Remove-AzStorageDirectory [-Directory] <CloudFileDirectory> [[-Path] <String>] [-PassThru] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageDirectory** cmdlet deletes a directory. + +## EXAMPLES + +### Example 1: Delete a folder +```powershell +Remove-AzStorageDirectory -ShareName "ContosoShare06" -Path "ContosoWorkingFolder" +``` + +This command deletes the folder named ContosoWorkingFolder from the file share named ContosoShare06. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Directory +Specifies a folder as a **CloudFileDirectory** object. +This cmdlet removes the folder that this parameter specifies. +To obtain a directory, use the New-AzStorageDirectory cmdlet. +You can also use the **Get-AzStorageFile** cmdlet to obtain a directory. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileDirectory +Parameter Sets: Directory +Aliases: CloudFileDirectory + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that, if this cmdlet succeeds, it returns a value of $True. +If you specify this parameter, and if the cmdlet is unsuccessful because of an inappropriate value for the _Path_ parameter, the cmdlet returns an error. +If you do not specify this parameter, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the path of a folder. +If the folder that this parameter specifies is empty, this cmdlet deletes that folder. +If the folder is not empty, this cmdlet makes no change, and returns an error. + +```yaml +Type: System.String +Parameter Sets: ShareName, Share +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: Directory +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Share +Specifies a **CloudFileShare** object. +This cmdlet removes a folder under the file share that this parameter specifies. +To obtain a **CloudFileShare** object, use the Get-AzStorageShare cmdlet. +This object contains the storage context. +If you specify this parameter, do not specify the *Context* parameter. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileShare +Parameter Sets: Share +Aliases: CloudFileShare + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareName +Specifies the name of the file share. +This cmdlet removes a folder under the file share that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Storage.File.CloudFileShare + +### Microsoft.Azure.Storage.File.CloudFileDirectory + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFileDirectory + +## NOTES + +## RELATED LINKS + +[Get-AzStorageShare](./Get-AzStorageShare.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[New-AzStorageDirectory](./New-AzStorageDirectory.md) diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageFile.md b/azps-10.1.0/Az.Storage/Remove-AzStorageFile.md new file mode 100644 index 0000000000..638fdfe49d --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageFile.md @@ -0,0 +1,308 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 811671E9-592E-4E58-8174-34D665206A65 +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstoragefile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageFile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageFile.md +--- + +# Remove-AzStorageFile + +## SYNOPSIS +Deletes a file. + +## SYNTAX + +### ShareName (Default) +``` +Remove-AzStorageFile [-ShareName] <String> [-Path] <String> [-PassThru] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Share +``` +Remove-AzStorageFile [-Share] <CloudFileShare> [-Path] <String> [-PassThru] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Directory +``` +Remove-AzStorageFile [-Directory] <CloudFileDirectory> [-Path] <String> [-PassThru] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### File +``` +Remove-AzStorageFile [-File] <CloudFile> [-PassThru] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageFile** cmdlet deletes a file. + +## EXAMPLES + +### Example 1: Delete a file from a file share +```powershell +Remove-AzStorageFile -ShareName "ContosoShare06" -Path "ContosoFile22" +``` + +This command deletes the file that is named ContosoFile22 from the file share named ContosoShare06. + +### Example 2: Get a file from a file share by using a file share object +```powershell +Get-AzStorageShare -Name "ContosoShare06" | Remove-AzStorageFile -Path "ContosoFile22" +``` + +This command uses the **Get-AzStorageShare** cmdlet to get the file share named ContosoShare06, and then passes that object to the current cmdlet by using the pipeline operator. +The current command deletes the file that is named ContosoFile22 from ContosoShare06. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: ShareName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Directory +Specifies a folder as a **CloudFileDirectory** object. +This cmdlet removes a file in the folder that this parameter specifies. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileDirectory +Parameter Sets: Directory +Aliases: CloudFileDirectory + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -File +Specifies a file as a **CloudFile** object. +This cmdlet removes the file that this parameter specifies. +To obtain a **CloudFile** object, use the Get-AzStorageFile cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFile +Parameter Sets: File +Aliases: CloudFile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the path of a file. +This cmdlet deletes the file that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ShareName, Share, Directory +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Share +Specifies a **CloudFileShare** object. +This cmdlet removes the file in the share this parameter specifies. +To obtain a **CloudFileShare** object, use the Get-AzStorageShare cmdlet. +This object contains the storage context. +If you specify this parameter, do not specify the *Context* parameter. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileShare +Parameter Sets: Share +Aliases: CloudFileShare + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareName +Specifies the name of the file share. +This cmdlet removes the file in the share this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Storage.File.CloudFileShare + +### Microsoft.Azure.Storage.File.CloudFileDirectory + +### Microsoft.Azure.Storage.File.CloudFile + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFile + +## NOTES + +## RELATED LINKS + +[Get-AzStorageFile](./Get-AzStorageFile.md) + +[Get-AzStorageShare](./Get-AzStorageShare.md) + +[New-AzStorageContext](./New-AzStorageContext.md) diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageLocalUser.md b/azps-10.1.0/Az.Storage/Remove-AzStorageLocalUser.md new file mode 100644 index 0000000000..8f36cc5f93 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageLocalUser.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstoragelocaluser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageLocalUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageLocalUser.md +--- + +# Remove-AzStorageLocalUser + +## SYNOPSIS +Removes a specified local user in a storage account. + +## SYNTAX + +### AccountName (Default) +``` +Remove-AzStorageLocalUser [-ResourceGroupName] <String> [-StorageAccountName] <String> -UserName <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Remove-AzStorageLocalUser -StorageAccount <PSStorageAccount> -UserName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UserObject +``` +Remove-AzStorageLocalUser [-InputObject] <PSLocalUser> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageLocalUser** cmdlet removes a specified local user from a storage account. + +## EXAMPLES + +### Example 1: Remove a specified local user +```powershell +Remove-AzStorageLocalUser -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -UserName testuser1 +``` + +This command removes a specified local user. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Local User Object to Remove + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSLocalUser +Parameter Sets: UserObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +{{ Fill PassThru Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserName +The name of local user. +The username must contain lowercase letters and numbers only. +It must be unique only within the storage account. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageObjectReplicationPolicy.md b/azps-10.1.0/Az.Storage/Remove-AzStorageObjectReplicationPolicy.md new file mode 100644 index 0000000000..6ec2a3b817 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageObjectReplicationPolicy.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstorageobjectreplicationpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageObjectReplicationPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageObjectReplicationPolicy.md +--- + +# Remove-AzStorageObjectReplicationPolicy + +## SYNOPSIS +Removes the specified object replication policy from a Storage account. + +## SYNTAX + +### AccountName (Default) +``` +Remove-AzStorageObjectReplicationPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -PolicyId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountObject +``` +Remove-AzStorageObjectReplicationPolicy -StorageAccount <PSStorageAccount> -PolicyId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### PolicyObject +``` +Remove-AzStorageObjectReplicationPolicy -InputObject <PSObjectReplicationPolicy> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageObjectReplicationPolicy** cmdlet removes the specified object replication policy from a Storage account. + +## EXAMPLES + +### Example 1: Remove an object replication policy with specific policyId from a storage account. +```powershell +Remove-AzStorageObjectReplicationPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -PolicyId $policyId +``` + +This command removes an object replication policy with specific policyId from a storage account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Object Replication Policy object to Delete. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSObjectReplicationPolicy +Parameter Sets: PolicyObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +Object Replication Policy Id. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSObjectReplicationPolicy + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageQueue.md b/azps-10.1.0/Az.Storage/Remove-AzStorageQueue.md new file mode 100644 index 0000000000..d020377002 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageQueue.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 22975A89-CAFF-4F18-8DCE-B695413FBAC7 +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstoragequeue +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageQueue.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageQueue.md +--- + +# Remove-AzStorageQueue + +## SYNOPSIS +Removes a storage queue. + +## SYNTAX + +``` +Remove-AzStorageQueue [-Name] <String> [-Force] [-PassThru] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageQueue** cmdlet removes a storage queue. + +## EXAMPLES + +### Example 1: Remove a storage queue by name +```powershell +Remove-AzStorageQueue "ContosoQueue01" +``` + +This command removes a queue named ContosoQueue01. + +### Example 2: Remove multiple storage queues +```powershell +Get-AzStorageQueue "Contoso*" | Remove-AzStorageQueue +``` + +This command removes all queues with names that start with Contoso. + +## PARAMETERS + +### -Context +Specifies the Azure storage context. +To obtain the storage context, the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the queue to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Queue + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzStorageQueue](./Get-AzStorageQueue.md) + +[New-AzStorageQueue](./New-AzStorageQueue.md) diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageQueueStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/Remove-AzStorageQueueStoredAccessPolicy.md new file mode 100644 index 0000000000..8e0c47965f --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageQueueStoredAccessPolicy.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 80DE5D60-93F8-4509-AA9C-F54E4AB70013 +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstoragequeuestoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageQueueStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageQueueStoredAccessPolicy.md +--- + +# Remove-AzStorageQueueStoredAccessPolicy + +## SYNOPSIS +Removes a stored access policy from an Azure storage queue. + +## SYNTAX + +``` +Remove-AzStorageQueueStoredAccessPolicy [-Queue] <String> [-Policy] <String> [-PassThru] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageQueueStoredAccessPolicy** cmdlet removes a stored access policy from an Azure storage queue. + +## EXAMPLES + +### Example 1: Remove a stored access policy from a storage queue +```powershell +Remove-AzStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy04" +``` + +This command removes an access policy named Policy04 from the storage queue named MyQueue. + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the name of the stored access policy that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Queue +Specifies the Azure storage queue name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzStorageQueueStoredAccessPolicy](./Get-AzStorageQueueStoredAccessPolicy.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[New-AzStorageQueueStoredAccessPolicy](./New-AzStorageQueueStoredAccessPolicy.md) + +[Set-AzStorageQueueStoredAccessPolicy](./Set-AzStorageQueueStoredAccessPolicy.md) diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageShare.md b/azps-10.1.0/Az.Storage/Remove-AzStorageShare.md new file mode 100644 index 0000000000..8759af4b57 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageShare.md @@ -0,0 +1,272 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: FF3AD436-CA33-4A52-8580-D2345D80A231 +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstorageshare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageShare.md +--- + +# Remove-AzStorageShare + +## SYNOPSIS +Deletes a file share. + +## SYNTAX + +### ShareName (Default) +``` +Remove-AzStorageShare [-Name] <String> [-IncludeAllSnapshot] [-Force] [-PassThru] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Share +``` +Remove-AzStorageShare [-Share] <CloudFileShare> [-IncludeAllSnapshot] [-Force] [-PassThru] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageShare** cmdlet deletes a file share. + +## EXAMPLES + +### Example 1: Remove a file share +```powershell +Remove-AzStorageShare -Name "ContosoShare06" +``` + +This command removes the file share named ContosoShare06. + +### Example 2: Remove a file share and all its snapshots +```powershell +Remove-AzStorageShare -Name "ContosoShare06" -IncludeAllSnapshot +``` + +This command removes the file share named ContosoShare06 and all its snapshots. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force to remove the share with all of its snapshots, and all content. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAllSnapshot +Remove File Share with all of its snapshots + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the file share. +This cmdlet deletes the file share that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Share +Specifies a **CloudFileShare** object. +This cmdlet removes the object that this parameter specifies. +To obtain a **CloudFileShare** object, use the Get-AzStorageShare cmdlet. +This object contains the storage context. +If you specify this parameter, do not specify the *Context* parameter. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileShare +Parameter Sets: Share +Aliases: CloudFileShare + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Storage.File.CloudFileShare + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFileShare + +## NOTES + +## RELATED LINKS + +[Get-AzStorageShare](./Get-AzStorageShare.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[New-AzStorageShare](./New-AzStorageShare.md) diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageShareStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/Remove-AzStorageShareStoredAccessPolicy.md new file mode 100644 index 0000000000..308c4ccdf9 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageShareStoredAccessPolicy.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: E2CCDA8F-2D45-4F25-B297-337B7AB021E0 +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstoragesharestoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageShareStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageShareStoredAccessPolicy.md +--- + +# Remove-AzStorageShareStoredAccessPolicy + +## SYNOPSIS +Removes a stored access policy from a Storage share. + +## SYNTAX + +``` +Remove-AzStorageShareStoredAccessPolicy [-ShareName] <String> [-Policy] <String> [-PassThru] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageShareStoredAccessPolicy** cmdlet removes a stored access policy from an Azure Storage share. + +## EXAMPLES + +### Example 1: Remove a stored access policy from an Azure Storage share +```powershell +Remove-AzStorageShareStoredAccessPolicy -ShareName "ContosoShare" -Policy "GeneralPolicy" +``` + +This command removes a stored access policy named GeneralPolicy from ContosoShare. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the name of the stored access policy that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +Specifies the Storage share name for which this cmdlet removes a policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzStorageShareStoredAccessPolicy](./Get-AzStorageShareStoredAccessPolicy.md) + +[New-AzStorageShareStoredAccessPolicy](./New-AzStorageShareStoredAccessPolicy.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[Set-AzStorageShareStoredAccessPolicy](./Set-AzStorageShareStoredAccessPolicy.md) diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageTable.md b/azps-10.1.0/Az.Storage/Remove-AzStorageTable.md new file mode 100644 index 0000000000..cbac5f02f9 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageTable.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 1B29AB8C-95DD-4C4F-86E2-2F81E8020CEA +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstoragetable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageTable.md +--- + +# Remove-AzStorageTable + +## SYNOPSIS +Removes a storage table. + +## SYNTAX + +``` +Remove-AzStorageTable [-Name] <String> [-Force] [-PassThru] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageTable** cmdlet removes one or more storage tables from a storage account in Azure. + +## EXAMPLES + +### Example 1: Remove a table +```powershell +Remove-AzStorageTable -Name "TableABC" +``` + +This command removes a table. + +### Example 2: Remove several tables +```powershell +Get-AzStorageTable table* | Remove-AzStorageTable +``` + +This example uses a wildcard character with the *Name* parameter to get all tables that match the pattern table and then passes the result on the pipeline to remove the tables. + +## PARAMETERS + +### -Context +Specifies the Azure storage context. +You can create it by using the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the table to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Table + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzStorageTable](./Get-AzStorageTable.md) diff --git a/azps-10.1.0/Az.Storage/Remove-AzStorageTableStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/Remove-AzStorageTableStoredAccessPolicy.md new file mode 100644 index 0000000000..2a6b8c1b7d --- /dev/null +++ b/azps-10.1.0/Az.Storage/Remove-AzStorageTableStoredAccessPolicy.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 30CC0D80-505A-4988-B4EC-3B7BC5B76F5D +online version: https://learn.microsoft.com/powershell/module/az.storage/remove-azstoragetablestoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageTableStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Remove-AzStorageTableStoredAccessPolicy.md +--- + +# Remove-AzStorageTableStoredAccessPolicy + +## SYNOPSIS +Removes a stored access policy from an Azure storage table. + +## SYNTAX + +``` +Remove-AzStorageTableStoredAccessPolicy [-Table] <String> [-Policy] <String> [-PassThru] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzStorageTableStoredAccessPolicy** cmdlet removes a stored access policy from an Azure storage table. + +## EXAMPLES + +### Example 1: Remove a stored access policy from a storage table +```powershell +Remove-AzStorageTableStoredAccessPolicy -Table "MyTable" -Policy "Policy05" +``` + +This command removes policy named Policy05 from storage table named MyTable. + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the name of the stored access policy that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Table +Specifies the Azure table name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzStorageTableStoredAccessPolicy](./Get-AzStorageTableStoredAccessPolicy.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[New-AzStorageTableStoredAccessPolicy](./New-AzStorageTableStoredAccessPolicy.md) + +[Set-AzStorageTableStoredAccessPolicy](./Set-AzStorageTableStoredAccessPolicy.md) diff --git a/azps-10.1.0/Az.Storage/Rename-AzStorageDirectory.md b/azps-10.1.0/Az.Storage/Rename-AzStorageDirectory.md new file mode 100644 index 0000000000..4cb99ac823 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Rename-AzStorageDirectory.md @@ -0,0 +1,261 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/rename-azstoragedirectory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Rename-AzStorageDirectory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Rename-AzStorageDirectory.md +--- + +# Rename-AzStorageDirectory + +## SYNOPSIS +Renames a directory. + +## SYNTAX + +### ShareName +``` +Rename-AzStorageDirectory [-ShareName] <String> [-SourcePath] <String> [[-DestinationPath] <String>] + [-Permission <String>] [-Force] [-AsJob] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-IgnoreReadonly] [<CommonParameters>] +``` + +### ShareObject +``` +Rename-AzStorageDirectory [-ShareClient] <ShareClient> [-SourcePath] <String> [[-DestinationPath] <String>] + [-Permission <String>] [-Force] [-AsJob] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-IgnoreReadonly] [<CommonParameters>] +``` + +### DirecotryObject +``` +Rename-AzStorageDirectory [-ShareDirectoryClient] <ShareDirectoryClient> [[-DestinationPath] <String>] + [-Permission <String>] [-Force] [-AsJob] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-IgnoreReadonly] [<CommonParameters>] +``` + +## DESCRIPTION +The **Rename-AzStorageDirectory** cmdlet renames a directory from a file share. + +## EXAMPLES + +### Example 1 : Rename a directory +```powershell +Rename-AzStorageDirectory -ShareName myshare -SourcePath testdir1 -DestinationPath testdir2 +``` + +```output + Directory: https://myaccount.file.core.windows.net/myshare + +Type Length Name +---- ------ ---- +Directory 1 testdir2 +``` + +This command renames a directory from testdir1 to testdir2. + +### Example 2 : Rename a directory using pipeline +```powershell +Get-AzStorageFile -ShareName myshare -Path testdir1 | Rename-AzStorageDirectory -DestinationPath testdir2 +``` + +```output + Directory: https://myaccount.file.core.windows.net/myshare + +Type Length Name +---- ------ ---- +Directory 1 testdir2 +``` + +This command gets a directory from a file share first, and then rename the directory from testdir1 to testdir2 using pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPath +The destination path to rename the directory to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force to overwrite the existing file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreReadonly +Optional. +Specifies whether the ReadOnly attribute on a preexisting destination file should be respected. +If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +If specified the permission (security descriptor) shall be set for the directory/file. +Default value: Inherit. +If SDDL is specified as input, it must have owner, group and dacl. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareClient +ShareClienr indicated the share where the directory would be listed. + +```yaml +Type: Azure.Storage.Files.Shares.ShareClient +Parameter Sets: ShareObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareDirectoryClient +Source directory instance + +```yaml +Type: Azure.Storage.Files.Shares.ShareDirectoryClient +Parameter Sets: DirecotryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareName +Name of the file share where the directory would be listed. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourcePath +Path to an existing directory. + +```yaml +Type: System.String +Parameter Sets: ShareName, ShareObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Azure.Storage.Files.Shares.ShareClient + +### Azure.Storage.Files.Shares.ShareDirectoryClient + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFileDirectory + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Rename-AzStorageFile.md b/azps-10.1.0/Az.Storage/Rename-AzStorageFile.md new file mode 100644 index 0000000000..232a6c5915 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Rename-AzStorageFile.md @@ -0,0 +1,301 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/rename-azstoragefile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Rename-AzStorageFile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Rename-AzStorageFile.md +--- + +# Rename-AzStorageFile + +## SYNOPSIS +Renames a file. + +## SYNTAX + +### ShareName +``` +Rename-AzStorageFile [-ShareName] <String> [-SourcePath] <String> [[-DestinationPath] <String>] + [-ContentType <String>] [-Permission <String>] [-Force] [-AsJob] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-IgnoreReadonly] [<CommonParameters>] +``` + +### FileObject +``` +Rename-AzStorageFile [-ShareFileClient] <ShareFileClient> [[-DestinationPath] <String>] [-ContentType <String>] + [-Permission <String>] [-Force] [-AsJob] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-IgnoreReadonly] [<CommonParameters>] +``` + +### ShareObject +``` +Rename-AzStorageFile [-ShareClient] <ShareClient> [-SourcePath] <String> [[-DestinationPath] <String>] + [-ContentType <String>] [-Permission <String>] [-Force] [-AsJob] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-IgnoreReadonly] [<CommonParameters>] +``` + +### DirecotryObject +``` +Rename-AzStorageFile [-ShareDirectoryClient] <ShareDirectoryClient> [-SourcePath] <String> + [[-DestinationPath] <String>] [-ContentType <String>] [-Permission <String>] [-Force] [-AsJob] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-IgnoreReadonly] [<CommonParameters>] +``` + +## DESCRIPTION +The **Rename-AzStorageFile** cmdlet renames a directory from a file share. + +## EXAMPLES + +### Example 1 : Rename a file from a file share +```powershell +Rename-AzStorageFile -SourcePath testfile1 -DestinationPath testfile2 -ShareName myshare +``` + +```output +Directory: https://myaccount.file.core.windows.net/myshare + +Type Length Name +---- ------ ---- +File 512 testfile2 +``` + +This command renames a file from testfile1 to testfile2 under file share myshare. + +### Example 2 : Rename a file from a file share using pipeline +```powershell +Get-AzStorageFile -ShareName myshare -Path testfile1 | Rename-AzStorageFile -DestinationPath testfile2 +``` + +```output +Directory: https://myaccount.file.core.windows.net/myshare + +Type Length Name +---- ------ ---- +File 512 testfile2 +``` + +This command gets a file client object first, and the rename the file from testfile1 to testfile2 using pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentType +Sets the MIME content type of the file. +The default type is 'application/octet-stream'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationPath +The destination path to rename the file to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force to overwrite the existing file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreReadonly +Optional. +Specifies whether the ReadOnly attribute on a preexisting destination file should be respected. +If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +If specified the permission (security descriptor) shall be set for the directory/file. +Default value: Inherit. +If SDDL is specified as input, it must have owner, group and dacl. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareClient +ShareClient indicated the share where the file would be listed. + +```yaml +Type: Azure.Storage.Files.Shares.ShareClient +Parameter Sets: ShareObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareDirectoryClient +ShareDirectoryClient indicated the share where the file would be listed. + +```yaml +Type: Azure.Storage.Files.Shares.ShareDirectoryClient +Parameter Sets: DirecotryObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareFileClient +Source file instance + +```yaml +Type: Azure.Storage.Files.Shares.ShareFileClient +Parameter Sets: FileObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareName +Name of the file share where the file would be listed. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourcePath +Path to an existing file. + +```yaml +Type: System.String +Parameter Sets: ShareName, ShareObject, DirecotryObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Azure.Storage.Files.Shares.ShareFileClient + +### Azure.Storage.Files.Shares.ShareClient + +### Azure.Storage.Files.Shares.ShareDirectoryClient + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFile + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Restore-AzDataLakeGen2DeletedItem.md b/azps-10.1.0/Az.Storage/Restore-AzDataLakeGen2DeletedItem.md new file mode 100644 index 0000000000..16ed683ff4 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Restore-AzDataLakeGen2DeletedItem.md @@ -0,0 +1,236 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/restore-azdatalakegen2deleteditem +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Restore-AzDataLakeGen2DeletedItem.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Restore-AzDataLakeGen2DeletedItem.md +--- + +# Restore-AzDataLakeGen2DeletedItem + +## SYNOPSIS +Restores a deleted file or directory in a filesystem. + +## SYNTAX + +### ReceiveManual (Default) +``` +Restore-AzDataLakeGen2DeletedItem [-FileSystem] <String> [-Path] <String> [-DeletionId] <String> [-AsJob] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ItemPipeline +``` +Restore-AzDataLakeGen2DeletedItem -InputObject <AzureDataLakeGen2DeletedItem> [-AsJob] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzDataLakeGen2DeletedItem** cmdlet restores a deleted file or directory in a filesystem in an Azure storage account. +This cmdlet only works if Hierarchical Namespace is enabled for the Storage account. This kind of account can be created by run "New-AzStorageAccount" cmdlet with "-EnableHierarchicalNamespace $true". + +## EXAMPLES + +### Example 1: List all deleted files or directories from a Filesystem, and restore them by pipeline +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $items = Get-AzDataLakeGen2DeletedItem -FileSystem "filesystem1" +PS C:\> $items + + FileSystem Name: filesystem1 + +Path DeletionId DeletedOn RemainingRetentionDays +---- ---------- --------- ---------------------- +dir0/dir1/file1 132658816156507617 2021-05-19 07:06:55Z 3 +dir0/dir2 132658834541610122 2021-05-19 07:37:34Z 3 +dir0/dir2/file3 132658834534174806 2021-05-19 07:37:33Z 3 + +PS C:\> $items | Restore-AzDataLakeGen2DeletedItem + + FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir0/dir1/file1 False 1024 2021-05-19 07:06:39Z rw-r----- $superuser $superuser +dir0/dir2 True 2021-05-19 07:06:37Z rwxr-x--- $superuser $superuser +dir0/dir2/file3 False 1024 2021-05-19 07:06:42Z rw-r----- $superuser $superuser +``` + +This command lists all deleted files or directories from a Filesystem, the restore all of them by pipeline. + +### Example 2: Restore an single file with path and DeletionId +```powershell +Restore-AzDataLakeGen2DeletedItem -FileSystem "filesystem1" -Path dir0/dir1/file1 -DeletionId 132658838415219780 +``` + +```output +FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir0/dir1/file1 False 1024 2021-05-19 07:06:39Z rw-r----- $superuser $superuser +``` + +This command restores an single file with path and DeletionId. The DeletionId can be get with 'Get-AzDataLakeGen2DeletedItem' cmdlet. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletionId +The deletion ID associated with the soft deleted path. +You can get soft deleted paths and their assocaited deletion IDs with cmdlet 'Get-AzDataLakeGen2DeletedItem'. + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -FileSystem +FileSystem name + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Azure Datalake Gen2 Deleted Item Object to restore. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2DeletedItem +Parameter Sets: ItemPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Path +The deleted item path in the specified FileSystem that should be restore. +In the format 'directory/file.txt' or 'directory1/directory2/' + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2DeletedItem + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Restore-AzRmStorageShare.md b/azps-10.1.0/Az.Storage/Restore-AzRmStorageShare.md new file mode 100644 index 0000000000..e425810521 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Restore-AzRmStorageShare.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/restore-azrmstorageshare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Restore-AzRmStorageShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Restore-AzRmStorageShare.md +--- + +# Restore-AzRmStorageShare + +## SYNOPSIS +Restores a deleted file share. + +## SYNTAX + +### AccountName (Default) +``` +Restore-AzRmStorageShare [-ResourceGroupName] <String> [-StorageAccountName] <String> -Name <String> + -DeletedShareVersion <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountObject +``` +Restore-AzRmStorageShare -StorageAccount <PSStorageAccount> -Name <String> -DeletedShareVersion <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ShareObject +``` +Restore-AzRmStorageShare -InputObject <PSShare> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzRmStorageShare** cmdlet restores a deleted file share within a valid retention days if share soft delete is enabled. + +## EXAMPLES + +### Example 1: Remove and restore a share +<!-- Skip: Output cannot be splitted from code --> +```powershell +PS C:\> Remove-AzRmStorageShare -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -Name $shareName -Force + +PS C:\> Get-AzRmStorageShare -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -IncludeDeleted + + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocol AccessTier Deleted Version ShareUsageBytes +---- -------- --------------- ---------- ------- ------- --------------- +test 100 TransactionOptimized +share1 100 TransactionOptimized True 01D61FD1FC5498B6 + +PS C:\> Restore-AzRmStorageShare -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -Name $shareName -DeletedShareVersion 01D61FD1FC5498B6 + + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocol AccessTier Deleted Version ShareUsageBytes +---- -------- --------------- ---------- ------- ------- --------------- +share1 100 +``` + +This command first delete a file share, and then list shares and see the deleted share version, finally restore it back to a normal share. +Need enabled share soft delete with Update-AzStorageFileServiceProperty, before delete the share. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedShareVersion +Deleted Share Version, which will be restored from. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Deleted Share object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSShare +Parameter Sets: ShareObject +Aliases: Share + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Deleted Share Name, which will be restored. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: N, ShareName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSShare + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSShare + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Restore-AzStorageBlobRange.md b/azps-10.1.0/Az.Storage/Restore-AzStorageBlobRange.md new file mode 100644 index 0000000000..ed6a9612dc --- /dev/null +++ b/azps-10.1.0/Az.Storage/Restore-AzStorageBlobRange.md @@ -0,0 +1,281 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/restore-azstorageblobrange +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Restore-AzStorageBlobRange.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Restore-AzStorageBlobRange.md +--- + +# Restore-AzStorageBlobRange + +## SYNOPSIS +Restores a Storage account for specific blob ranges. + +## SYNTAX + +### AccountName (Default) +``` +Restore-AzStorageBlobRange [-ResourceGroupName] <String> [-StorageAccountName] <String> + -TimeToRestore <DateTime> [-BlobRestoreRange <PSBlobRestoreRange[]>] [-WaitForComplete] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountResourceId +``` +Restore-AzStorageBlobRange [-ResourceId] <String> -TimeToRestore <DateTime> + [-BlobRestoreRange <PSBlobRestoreRange[]>] [-WaitForComplete] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Restore-AzStorageBlobRange -StorageAccount <PSStorageAccount> -TimeToRestore <DateTime> + [-BlobRestoreRange <PSBlobRestoreRange[]>] [-WaitForComplete] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzStorageBlobRange** cmdlet restores blobs in a Storage account for specific blob ranges. +The start range is included, and the end range is excluded in blob restore. + +## EXAMPLES + +### Example 1: Start restores blobs in a Storage account with specific blob ranges +<!-- Skip: Output cannot be splitted from code --> +```powershell +PS C:\> $range1 = New-AzStorageBlobRangeToRestore -StartRange container1/blob1 -EndRange container2/blob2 +PS C:\> $range2 = New-AzStorageBlobRangeToRestore -StartRange container3/blob3 -EndRange container4/blob4 +PS C:\> Restore-AzStorageBlobRange -ResourceGroupName "myresourcegoup" -StorageAccountName "mystorageaccount" -TimeToRestore (Get-Date).AddDays(-1) -BlobRestoreRange $range1,$range2 + +Status RestoreId FailureReason Parameters.TimeToRestore Parameters.BlobRanges +------ --------- ------------- ------------------------ --------------------- +InProgress 6ca55a8b-fca0-461a-8e4c-13927a9707e6 2020-02-10T13:58:44.6841810Z ["container1/blob1" -> "container2/blob2",...] + +PS C:\> (Get-AzStorageAccount -ResourceGroupName $rgname -StorageAccountName $accountName -IncludeBlobRestoreStatus).BlobRestoreStatus + +Status RestoreId FailureReason Parameters.TimeToRestore Parameters.BlobRanges +------ --------- ------------- ------------------------ --------------------- +Complete 6ca55a8b-fca0-461a-8e4c-13927a9707e6 2020-02-10T13:58:44.6841810Z ["container1/blob1" -> "container2/blob2",...] +``` + +This command first creates 2 blob ranges, then start restores blobs in a Storage account with the 2 blob ranges from 1 day ago. User can use Get-AzStorageAccount to trace the restore status later. + +### Example 2: Restores all blobs in a Storage account in the backend +```powershell +$job = Restore-AzStorageBlobRange -ResourceGroupName "myresourcegoup" -StorageAccountName "mystorageaccount" -TimeToRestore (Get-Date).AddMinutes(-30) -WaitForComplete -asjob + +$job | Wait-Job + +$job.Output +``` + +```output +Status RestoreId FailureReason Parameters.TimeToRestore Parameters.BlobRanges +------ --------- ------------- ------------------------ --------------------- +Complete 0387953a-bbe6-4602-818d-e661581ee44b 2020-08-28T07:11:33.9843100Z ["" -> ""] +``` + +This command restores all blobs in a Storage account from 30 minutes ago, and wait for the restore complete. Since restore blobs might take a long time, run it in the backend with -Asjob parameter, and then wait for the job complete and show the result. + +### Example 3: Restores blobs by input blob ranges directly, and wait for complete +```powershell +Restore-AzStorageBlobRange -ResourceGroupName "myresourcegoup" -StorageAccountName "mystorageaccount" -WaitForComplete ` + -TimeToRestore (Get-Date).AddSeconds(-1) ` + -BlobRestoreRange @{StartRange="aaa/abc";EndRange="bbb/abc"},@{StartRange="bbb/acc";EndRange=""} +``` + +```output +WARNING: Restore blob rang with Id 'd66d1d02-6e48-47ef-b516-0155dd8319c6' started. Restore blob ranges time to complete is dependent on the size of the restore. + +Status RestoreId FailureReason Parameters.TimeToRestore Parameters.BlobRanges +------ --------- ------------- ------------------------ --------------------- +Complete d66d1d02-6e48-47ef-b516-0155dd8319c6 2020-02-10T14:17:46.8189116Z ["aaa/abc" -> "bbb/abc",...] +``` + +This command restores blobs in a Storage account from 1 day ago, by input 2 blob ranges directly to the Restore-AzStorageBlobRange cmdlet. This command will wait for the restore complete. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobRestoreRange +The blob range to Restore. +If not specify this parameter, will restore all blobs. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSBlobRestoreRange[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Storage Account Resource Id. + +```yaml +Type: System.String +Parameter Sets: AccountResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeToRestore +The Time to Restore Blob. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitForComplete +Wait for Restore task complete + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSBlobRestoreStatus + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Restore-AzStorageContainer.md b/azps-10.1.0/Az.Storage/Restore-AzStorageContainer.md new file mode 100644 index 0000000000..c40bd236c8 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Restore-AzStorageContainer.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/restore-azstoragecontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Restore-AzStorageContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Restore-AzStorageContainer.md +--- + +# Restore-AzStorageContainer + +## SYNOPSIS +Restores a previously deleted Azure storage blob container. + +## SYNTAX + +``` +Restore-AzStorageContainer [-Name] <String> [-VersionId] <String> [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzStorageContainer** cmdlet restores a previously deleted Azure storage blob container. +This cmdlet only works after enabled Container softdelete with Enable-AzStorageBlobDeleteRetentionPolicy. + +## EXAMPLES + +### Example 1: List containers include deleted containers, and restore all deleted containers with pipeline +```powershell +Get-AzStorageContainer -IncludeDeleted -Context $ctx | Where-Object { $_.IsDeleted } | Restore-AzStorageContainer +``` + +```output + Storage Account Name: storageaccountname + +Name PublicAccess LastModified IsDeleted VersionId +---- ------------ ------------ --------- --------- +container1 Off +container2 Off +``` + +This command lists all containers include deleted containers, filter out all the deleted containers, then restore all deleted container to the same container name with pipeline. + +### Example 2: Restore a single deleted container +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> Get-AzStorageContainer -IncludeDeleted -Context $ctx | Where-Object { $_.IsDeleted } + + Storage Account Name: storageaccountname + +Name PublicAccess LastModified IsDeleted VersionId +---- ------------ ------------ --------- --------- +container1 8/28/2020 10:18:13 AM +00:00 True 01D685BC91A88F22 +container2 9/4/2020 12:52:37 PM +00:00 True 01D67D248986B6DA + +PS C:\> Restore-AzStorageContainer -Name container1 -VersionId 01D685BC91A88F22 -Context $ctx + + Storage Account Name: storageaccountname + +Name PublicAccess LastModified IsDeleted VersionId +---- ------------ ------------ --------- --------- +container1 Off +``` + +This first command lists all containers and filter out deleted containers. +The secondary command restores a deleted container by manually input the parameters. + +## PARAMETERS + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the previously deleted container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Container, DeletedContainerName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -VersionId +The version of the previously deleted container. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DeletedContainerVersion, + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Revoke-AzStorageAccountUserDelegationKeys.md b/azps-10.1.0/Az.Storage/Revoke-AzStorageAccountUserDelegationKeys.md new file mode 100644 index 0000000000..51c542c2c5 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Revoke-AzStorageAccountUserDelegationKeys.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/revoke-azstorageaccountuserdelegationkeys +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Revoke-AzStorageAccountUserDelegationKeys.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Revoke-AzStorageAccountUserDelegationKeys.md +--- + +# Revoke-AzStorageAccountUserDelegationKeys + +## SYNOPSIS +Revoke all User Delegation keys of a Storage account. + +## SYNTAX + +### AccountName (Default) +``` +Revoke-AzStorageAccountUserDelegationKeys [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Revoke-AzStorageAccountUserDelegationKeys -InputObject <PSStorageAccount> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountResourceId +``` +Revoke-AzStorageAccountUserDelegationKeys [-ResourceId] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Revoke-AzStorageAccountUserDelegationKeys** cmdlet revokes all User Delegation keys of a Storage account, so all Identity SAS token of the Storage account will also be revoked. + +## EXAMPLES + +### Example 1: Revoke all User Delegation keys of a Storage account +```powershell +Revoke-AzStorageAccountUserDelegationKeys -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" +``` + +This example revokes all User Delegation keys of a Storage account, so all Identity SAS token generated from the User Delegation keys will also be revoked. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +A storage account object, returned by Get_AzStorageAccount, New-AzStorageAccount. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: StorageAccount + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Normally this cmdlet returns no output on successful completion, this parameter forces the cmdlet to return a value ($true) on successful completion. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group name containing the storage account resource. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Storage Account Resource Id. + +```yaml +Type: System.String +Parameter Sets: AccountResourceId +Aliases: StorageAccountResourceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account resource. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Set-AzCurrentStorageAccount.md b/azps-10.1.0/Az.Storage/Set-AzCurrentStorageAccount.md new file mode 100644 index 0000000000..f331de3756 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzCurrentStorageAccount.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 15973FE8-16C1-4B71-A3A8-6D6F67A96FDF +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azcurrentstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzCurrentStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzCurrentStorageAccount.md +--- + +# Set-AzCurrentStorageAccount + +## SYNOPSIS +Modifies the current Storage account of the specified subscription. + +## SYNTAX + +### UsingResourceGroupAndNameParameterSet (Default) +``` +Set-AzCurrentStorageAccount -ResourceGroupName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### UsingStorageContext +``` +Set-AzCurrentStorageAccount -Context <IStorageContext> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzCurrentStorageAccount** cmdlet modifies the current Azure Storage account of the specified Azure subscription in Azure PowerShell. +The current Storage account is used as the default when you access Storage without specifying a Storage account name. + +## EXAMPLES + +### Example 1: Set the current Storage account +```powershell +Set-AzCurrentStorageAccount -ResourceGroupName "RG01" -Name "mystorageaccount" +``` + +This command sets the default Storage account for the specified subscription. + +## PARAMETERS + +### -Context +Specifies an **AzureStorageContext** object for the current Storage account. +To obtain a storage context object, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: UsingStorageContext +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage account that this cmdlet modifies. + +```yaml +Type: System.String +Parameter Sets: UsingResourceGroupAndNameParameterSet +Aliases: StorageAccountName, AccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group that contains the Storage account to modify. + +```yaml +Type: System.String +Parameter Sets: UsingResourceGroupAndNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +### System.String + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Set-AzStorageAccount](./Set-AzStorageAccount.md) + + diff --git a/azps-10.1.0/Az.Storage/Set-AzDataLakeGen2AclRecursive.md b/azps-10.1.0/Az.Storage/Set-AzDataLakeGen2AclRecursive.md new file mode 100644 index 0000000000..caa9083b31 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzDataLakeGen2AclRecursive.md @@ -0,0 +1,348 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azdatalakegen2aclrecursive +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzDataLakeGen2AclRecursive.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzDataLakeGen2AclRecursive.md +--- + +# Set-AzDataLakeGen2AclRecursive + +## SYNOPSIS +Set ACL recursively on the specified path. + +## SYNTAX + +``` +Set-AzDataLakeGen2AclRecursive [-FileSystem] <String> [[-Path] <String>] [-ContinuationToken <String>] + -Acl <PSPathAccessControlEntry[]> [-ContinueOnFailure] [-BatchSize <Int32>] [-MaxBatchCount <Int32>] [-AsJob] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeGen2AclRecursive** cmdlet sets ACL recursively on the specified path. +The input ACL will replace original ACL completely. + +## EXAMPLES + +### Example 1: Set ACL recursively on a directory +```powershell +$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType user -Permission rwx +$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType group -Permission rw- -InputObject $acl +$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType other -Permission "rw-" -InputObject $acl +Set-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path "dir1" -Acl $acl -Context $ctx +``` + +```output +FailedEntries : +TotalDirectoriesSuccessfulCount : 7 +TotalFilesSuccessfulCount : 5 +TotalFailureCount : 0 +ContinuationToken : +``` + +This command first creates an ACL object with 3 acl entries, then sets ACL recursively on a directory. + +### Example 2: Set ACL recursively on a root directory of filesystem +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $result = Set-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Acl $acl -Context $ctx + +PS C:\> $result + +FailedEntries : {dir1/dir2/file4} +TotalDirectoriesSuccessfulCount : 500 +TotalFilesSuccessfulCount : 2500 +TotalFailureCount : 1 +ContinuationToken : VBaHi5TfyO2ai1wYTRhIL2FjbGNibjA2c3RmATAxRDVEN0UzRENFQzZCRTAvYWRsc3Rlc3QyATAxRDY2M0ZCQTZBN0JGQTkvZGlyMC9kaXIxL2ZpbGUzFgAAAA== + +PS C:\> $result.FailedEntries + +Name IsDirectory ErrorMessage +---- ----------- ------------ +dir0/dir2/file4 False This request is not authorized to perform this operation using this permission. + +# user need fix the failed item , then can resume with ContinuationToken + +PS C:\> $result = Set-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Acl $acl -ContinuationToken $result.ContinuationToken -Context $ctx + +PS C:\> $result + +FailedEntries : +TotalDirectoriesSuccessfulCount : 100 +TotalFilesSuccessfulCount : 1000 +TotalFailureCount : 0 +ContinuationToken : +``` + +This command first sets ACL recursively to a root directory and failed, then resume with ContinuationToken after user fix the failed file. + +### Example 3: Set ACL recursively chunk by chunk +<!-- Skip: Output cannot be splitted from code --> +```powershell +$token = $null +$TotalDirectoriesSuccess = 0 +$TotalFilesSuccess = 0 +$totalFailure = 0 +$FailedEntries = New-Object System.Collections.Generic.List[System.Object] +do +{ + $result = Set-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path "dir1" -Acl $acl -BatchSize 100 -MaxBatchCount 2 -ContinuationToken $token -Context $ctx + + # echo $result + $TotalFilesSuccess += $result.TotalFilesSuccessfulCount + $TotalDirectoriesSuccess += $result.TotalDirectoriesSuccessfulCount + $totalFailure += $result.TotalFailureCount + $FailedEntries += $result.FailedEntries + $token = $result.ContinuationToken +}while (($token -ne $null) -and ($result.TotalFailureCount -eq 0)) +echo "" +echo "[Result Summary]" +echo "TotalDirectoriesSuccessfulCount: `t$($TotalDirectoriesSuccess)" +echo "TotalFilesSuccessfulCount: `t`t`t$($TotalFilesSuccess)" +echo "TotalFailureCount: `t`t`t`t`t$($totalFailure)" +echo "ContinuationToken: `t`t`t`t`t$($token)" +echo "FailedEntries:"$($FailedEntries | ft) +``` + +This script sets ACL rescursively on directory chunk by chunk, with chunk size as BatchSize * MaxBatchCount. Chunk size is 200 in this script. + +### Example 4: Set ACL recursively on a directory and ContinueOnFailure, then resume from failures one by one +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $result = Set-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path "dir1" -Acl $acl -ContinueOnFailure -Context $ctx + +PS C:\> $result + +FailedEntries : {dir0/dir1/file1, dir0/dir2/file4} +TotalDirectoriesSuccessfulCount : 100 +TotalFilesSuccessfulCount : 500 +TotalFailureCount : 2 +ContinuationToken : VBaHi5TfyO2ai1wYTRhIL2FjbGNibjA2c3RmATAxRDVEN0UzRENFQzZCRTAvYWRsc3Rlc3QyATAxRDY2M0ZCQTZBN0JGQTkvZGlyMC9kaXIxL2ZpbGUzFgAAAA== + +PS C:\> $result.FailedEntries + +Name IsDirectory ErrorMessage +---- ----------- ------------ +dir0/dir1/file1 False This request is not authorized to perform this operation using this permission. +dir0/dir2/file4 False This request is not authorized to perform this operation using this permission. + +# user need fix the failed item , then can resume with ContinuationToken + +PS C:\> foreach ($path in $result.FailedEntries.Name) + { + # user code to fix failed entry in $path + + #set ACL again + Set-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path $path -Acl $acl -Context $ctx + } +``` + +This command first sets ACL recursively to a directory with ContinueOnFailure, and some items failed, then resume the failed items one by one. + +## PARAMETERS + +### -Acl +The POSIX access control list to set recursively for the file or directory. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSPathAccessControlEntry[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +If data set size exceeds batch size then operation will be split into multiple requests so that progress can be tracked. +Batch size should be between 1 and 2000. +Default is 2000. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ContinuationToken +Continuation Token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinueOnFailure +Set this parameter to ignore failures and continue proceeing with the operation on other sub-entities of the directory. Default the operation will terminate quickly on encountering failures. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +FileSystem name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaxBatchCount +Maximum number of batches that single change Access Control operation can execute. If data set size exceeds MaxBatchCount multiply BatchSize, continuation token will be return. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path in the specified FileSystem that to change Acl recursively. +Can be a file or directory. +In the format 'directory/file.txt' or 'directory1/directory2/'. +Skip set this parameter to change Acl recursively from root directory of the Filesystem. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Set-AzDataLakeGen2ItemAclObject.md b/azps-10.1.0/Az.Storage/Set-AzDataLakeGen2ItemAclObject.md new file mode 100644 index 0000000000..203ca3ef56 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzDataLakeGen2ItemAclObject.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azdatalakegen2itemaclobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzDataLakeGen2ItemAclObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzDataLakeGen2ItemAclObject.md +--- + +# Set-AzDataLakeGen2ItemAclObject + +## SYNOPSIS +Creates/Updates a DataLake gen2 item ACL object, which can be used in Update-AzDataLakeGen2Item cmdlet. + +## SYNTAX + +``` +Set-AzDataLakeGen2ItemAclObject [-EntityId <String>] [-DefaultScope] -Permission <String> + [-InputObject <PSPathAccessControlEntry[]>] -AccessControlType <AccessControlType> [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzDataLakeGen2ItemAclObject** cmdlet creates/updates a DataLake gen2 item ACL object, which can be used in Update-AzDataLakeGen2Item cmdlet. +If the new ACL entry with same AccessControlType/EntityId/DefaultScope not exist in the input ACL, will create a new ACL entry, else update permission of existing ACL entry. + +## EXAMPLES + +### Example 1: Create an ACL object with 3 ACL entry, and update ACL on a directory +```powershell +$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType user -Permission rwx -DefaultScope +$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType group -Permission rw- -InputObject $acl +$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType other -Permission "rw-" -InputObject $acl +Update-AzDataLakeGen2Item -FileSystem "filesystem1" -Path "dir1/dir3" -ACL $acl +``` + +```output +FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir1/dir3 True 2020-03-23 09:34:31Z rwxrw-rw-+ $superuser $superuser +``` + +This command creates an ACL object with 3 ACL entries (use -InputObject parameter to add acl entry to existing acl object), and updates ACL on a directory. + +### Example 2: Create an ACL object with 4 ACL entries, and update permission of an existing ACL entry +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\>$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType user -Permission rwx -DefaultScope +PS C:\>$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType group -Permission rw- -InputObject $acl +PS C:\>$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType other -Permission "rwt" -InputObject $acl +PS C:\>$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType user -EntityId $id -Permission rwx -InputObject $acl +PS C:\>$acl + +DefaultScope AccessControlType EntityId Permissions +------------ ----------------- -------- ----------- +True User rwx +False Group rw- +False Other rwt +False User ********-****-****-****-************ rwx + +PS C:\>$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType user -EntityId $id -Permission r-x -InputObject $acl +PS C:\>$acl + +DefaultScope AccessControlType EntityId Permissions +------------ ----------------- -------- ----------- +True User rwx +False Group rw- +False Other rw- +False User ********-****-****-****-************ r-x +``` + +This command first creates an ACL object with 4 ACL entries, then run the cmdlet again with different permission but same AccessControlType/EntityId/DefaultScope of an existing ACL entry. +Then the permission of the ACL entry is updated, but no new ACL entry is added. + +## PARAMETERS + +### -AccessControlType +There are four types: "user" grants rights to the owner or a named user, "group" grants rights to the owning group or a named group, "mask" restricts rights granted to named users and the members of groups, and "other" grants rights to all users not found in any of the other entries. + +```yaml +Type: Azure.Storage.Files.DataLake.Models.AccessControlType +Parameter Sets: (All) +Aliases: +Accepted values: User, Group, Mask, Other + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultScope +Set this parameter to indicate the ACE belongs to the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityId +The user or group identifier. +It is omitted for entries of AccessControlType "mask" and "other". +The user or group identifier is also omitted for the owner and owning group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +If input the PSPathAccessControlEntry\[\] object, will add the new ACL as a new element of the input PSPathAccessControlEntry\[\] object. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSPathAccessControlEntry[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +The permission field is a 3-character sequence where the first character is 'r' to grant read access, the second character is 'w' to grant write access, and the third character is 'x' to grant execute permission. +If access is not granted, the '-' character is used to denote that the permission is denied. +The sticky bit is also supported and its represented either by the letter t or T in the final character-place depending on whether the execution bit for the others category is set or unset respectively, +absence of t or T indicates sticky bit not set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSPathAccessControlEntry + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Set-AzRmStorageContainerImmutabilityPolicy.md b/azps-10.1.0/Az.Storage/Set-AzRmStorageContainerImmutabilityPolicy.md new file mode 100644 index 0000000000..5a56584dcb --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzRmStorageContainerImmutabilityPolicy.md @@ -0,0 +1,372 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azrmstoragecontainerimmutabilitypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzRmStorageContainerImmutabilityPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzRmStorageContainerImmutabilityPolicy.md +--- + +# Set-AzRmStorageContainerImmutabilityPolicy + +## SYNOPSIS +Creates or updates ImmutabilityPolicy of a Storage blob containers + +## SYNTAX + +### AccountName (Default) +``` +Set-AzRmStorageContainerImmutabilityPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -ContainerName <String> [-ImmutabilityPeriod <Int32>] [-AllowProtectedAppendWriteAll <Boolean>] + [-AllowProtectedAppendWrite <Boolean>] [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ExtendAccountName +``` +Set-AzRmStorageContainerImmutabilityPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -ContainerName <String> -ImmutabilityPeriod <Int32> -Etag <String> [-ExtendPolicy] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Set-AzRmStorageContainerImmutabilityPolicy -ContainerName <String> -StorageAccount <PSStorageAccount> + [-ImmutabilityPeriod <Int32>] [-AllowProtectedAppendWriteAll <Boolean>] [-AllowProtectedAppendWrite <Boolean>] + [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ExtendAccountObject +``` +Set-AzRmStorageContainerImmutabilityPolicy -ContainerName <String> -StorageAccount <PSStorageAccount> + -ImmutabilityPeriod <Int32> -Etag <String> [-ExtendPolicy] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ContainerObject +``` +Set-AzRmStorageContainerImmutabilityPolicy -Container <PSContainer> [-ImmutabilityPeriod <Int32>] + [-AllowProtectedAppendWriteAll <Boolean>] [-AllowProtectedAppendWrite <Boolean>] [-Etag <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ExtendContainerObject +``` +Set-AzRmStorageContainerImmutabilityPolicy -Container <PSContainer> -ImmutabilityPeriod <Int32> -Etag <String> + [-ExtendPolicy] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ImmutabilityPolicyObject +``` +Set-AzRmStorageContainerImmutabilityPolicy [-InputObject] <PSImmutabilityPolicy> [-ImmutabilityPeriod <Int32>] + [-AllowProtectedAppendWriteAll <Boolean>] [-AllowProtectedAppendWrite <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ExtendImmutabilityPolicyObject +``` +Set-AzRmStorageContainerImmutabilityPolicy [-InputObject] <PSImmutabilityPolicy> -ImmutabilityPeriod <Int32> + [-ExtendPolicy] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzRmStorageContainerImmutabilityPolicy** cmdlet creates or updates ImmutabilityPolicy of a Storage blob containers + +## EXAMPLES + +### Example 1: Create or update ImmutabilityPolicy of a Storage blob container with Storage account name and container name +```powershell +Set-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -ImmutabilityPeriod 10 +``` + +This command creates or updates ImmutabilityPolicy of a Storage blob container with Storage account name and container name. + +### Example 2: Extend ImmutabilityPolicy of a Storage blob container, with Storage account object +```powershell +$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" +$policy = Get-AzRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" +Set-AzRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" -ImmutabilityPeriod 20 -Etag $policy.Etag -ExtendPolicy +``` + +This command extend ImmutabilityPolicy of a Storage blob container, with Storage account object. Extend ImmutabilityPolicy can only run after ImmutabilityPolicy is locked. + +### Example 3: Update ImmutabilityPolicy of a Storage blob container +```powershell +$containerObject = Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -Name "myContainer" +$policy = Set-AzRmStorageContainerImmutabilityPolicy -Container $containerObject -ImmutabilityPeriod 12 +$policy = Set-AzRmStorageContainerImmutabilityPolicy -Container $containerObject -ImmutabilityPeriod 9 -Etag $policy.Etag +$policy = Set-AzRmStorageContainerImmutabilityPolicy -Container $containerObject -AllowProtectedAppendWrite $true +$policy = Set-AzRmStorageContainerImmutabilityPolicy -Container $containerObject -AllowProtectedAppendWrite $false -AllowProtectedAppendWriteAll $true +``` + +This command updates ImmutabilityPolicy of a Storage blob container with Storage container object 3 times: +First to ImmutabilityPeriod 12 days without etag, then to ImmutabilityPeriod 9 days with etag, then enabled AllowProtectedAppendWrite, finally enabled AllowProtectedAppendWriteAll. + +### Example 4: Extend ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object +```powershell +Get-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" | Set-AzRmStorageContainerImmutabilityPolicy -ImmutabilityPeriod 15 -ExtendPolicy +``` + +This command extend ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object. Extend ImmutabilityPolicy can only run after ImmutabilityPolicy is locked. + +## PARAMETERS + +### -AllowProtectedAppendWrite +This property can only be changed for unlocked time-based retention policies. +With this property enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. +'-AllowProtectedAppendWrites' and '-AllowProtectedAppendWritesAll' are mutually exclusive. + +```yaml +Type: System.Boolean +Parameter Sets: AccountName, AccountObject, ContainerObject, ImmutabilityPolicyObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowProtectedAppendWriteAll +This property can only be changed for unlocked policies. +When enabled, new blocks can be written to both 'Appened and Block Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. +This property cannot be changed with ExtendImmutabilityPolicy API. '-AllowProtectedAppendWrites' and '-AllowProtectedAppendWritesAll' are mutually exclusive. + +```yaml +Type: System.Boolean +Parameter Sets: AccountName, AccountObject, ContainerObject, ImmutabilityPolicyObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Storage container object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSContainer +Parameter Sets: ContainerObject, ExtendContainerObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ContainerName +Container Name + +```yaml +Type: System.String +Parameter Sets: AccountName, ExtendAccountName, AccountObject, ExtendAccountObject +Aliases: N + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Immutability policy etag. If -ExtendPolicy is not specified, Etag is optional; else Etag is required. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject, ContainerObject +Aliases: IfMatch + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ExtendAccountName, ExtendAccountObject, ExtendContainerObject +Aliases: IfMatch + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendPolicy +Indicate ExtendPolicy to Extend an existing ImmutabilityPolicy. After ImmutabilityPolicy is locked, it can only be extend. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ExtendAccountName, ExtendAccountObject, ExtendContainerObject, ExtendImmutabilityPolicyObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutabilityPeriod +Immutability period since creation in days. + +```yaml +Type: System.Int32 +Parameter Sets: AccountName, AccountObject, ContainerObject, ImmutabilityPolicyObject +Aliases: ImmutabilityPeriodSinceCreationInDays + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Int32 +Parameter Sets: ExtendAccountName, ExtendAccountObject, ExtendContainerObject, ExtendImmutabilityPolicyObject +Aliases: ImmutabilityPeriodSinceCreationInDays + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Container Name + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy +Parameter Sets: ImmutabilityPolicyObject, ExtendImmutabilityPolicyObject +Aliases: ImmutabilityPolicy + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName, ExtendAccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject, ExtendAccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName, ExtendAccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer + +### Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageAccount.md b/azps-10.1.0/Az.Storage/Set-AzStorageAccount.md new file mode 100644 index 0000000000..665c7aedf9 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageAccount.md @@ -0,0 +1,1302 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 4D7EEDD7-89D4-4B1E-A9A1-B301E759CE72 +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstorageaccount +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageAccount.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageAccount.md +--- + +# Set-AzStorageAccount + +## SYNOPSIS +Modifies a Storage account. + +## SYNTAX + +### StorageEncryption (Default) +``` +Set-AzStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-Force] [-SkuName <String>] + [-AccessTier <String>] [-CustomDomainName <String>] [-UseSubDomain <Boolean>] [-Tag <Hashtable>] + [-EnableHttpsTrafficOnly <Boolean>] [-StorageEncryption] [-AssignIdentity] [-UserAssignedIdentityId <String>] + [-KeyVaultUserAssignedIdentityId <String>] [-KeyVaultFederatedClientId <String>] [-IdentityType <String>] + [-NetworkRuleSet <PSNetworkRuleSet>] [-UpgradeToStorageV2] + [-EnableAzureActiveDirectoryDomainServicesForFile <Boolean>] [-EnableLargeFileShare] + [-PublishMicrosoftEndpoint <Boolean>] [-PublishInternetEndpoint <Boolean>] [-AllowBlobPublicAccess <Boolean>] + [-MinimumTlsVersion <String>] [-AllowSharedKeyAccess <Boolean>] [-SasExpirationPeriod <TimeSpan>] + [-KeyExpirationPeriodInDay <Int32>] [-AllowCrossTenantReplication <Boolean>] + [-DefaultSharePermission <String>] [-PublicNetworkAccess <String>] [-ImmutabilityPeriod <Int32>] + [-ImmutabilityPolicyState <String>] [-EnableSftp <Boolean>] [-EnableLocalUser <Boolean>] + [-AllowedCopyScope <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-RoutingChoice <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### KeyvaultEncryption +``` +Set-AzStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-Force] [-SkuName <String>] + [-AccessTier <String>] [-CustomDomainName <String>] [-UseSubDomain <Boolean>] [-Tag <Hashtable>] + [-EnableHttpsTrafficOnly <Boolean>] [-KeyvaultEncryption] -KeyName <String> [-KeyVersion <String>] + -KeyVaultUri <String> [-AssignIdentity] [-UserAssignedIdentityId <String>] + [-KeyVaultUserAssignedIdentityId <String>] [-KeyVaultFederatedClientId <String>] [-IdentityType <String>] + [-NetworkRuleSet <PSNetworkRuleSet>] [-UpgradeToStorageV2] + [-EnableAzureActiveDirectoryDomainServicesForFile <Boolean>] [-EnableLargeFileShare] + [-PublishMicrosoftEndpoint <Boolean>] [-PublishInternetEndpoint <Boolean>] [-AllowBlobPublicAccess <Boolean>] + [-MinimumTlsVersion <String>] [-AllowSharedKeyAccess <Boolean>] [-SasExpirationPeriod <TimeSpan>] + [-KeyExpirationPeriodInDay <Int32>] [-AllowCrossTenantReplication <Boolean>] + [-DefaultSharePermission <String>] [-PublicNetworkAccess <String>] [-ImmutabilityPeriod <Int32>] + [-ImmutabilityPolicyState <String>] [-EnableSftp <Boolean>] [-EnableLocalUser <Boolean>] + [-AllowedCopyScope <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-RoutingChoice <String>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AzureActiveDirectoryKerberosForFile +``` +Set-AzStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-Force] [-SkuName <String>] + [-AccessTier <String>] [-CustomDomainName <String>] [-UseSubDomain <Boolean>] [-Tag <Hashtable>] + [-EnableHttpsTrafficOnly <Boolean>] [-AssignIdentity] [-UserAssignedIdentityId <String>] + [-KeyVaultUserAssignedIdentityId <String>] [-KeyVaultFederatedClientId <String>] [-IdentityType <String>] + [-NetworkRuleSet <PSNetworkRuleSet>] [-UpgradeToStorageV2] [-EnableLargeFileShare] + [-PublishMicrosoftEndpoint <Boolean>] [-PublishInternetEndpoint <Boolean>] + [-EnableAzureActiveDirectoryKerberosForFile <Boolean>] [-ActiveDirectoryDomainName <String>] + [-ActiveDirectoryDomainGuid <String>] [-AllowBlobPublicAccess <Boolean>] [-MinimumTlsVersion <String>] + [-AllowSharedKeyAccess <Boolean>] [-SasExpirationPeriod <TimeSpan>] [-KeyExpirationPeriodInDay <Int32>] + [-AllowCrossTenantReplication <Boolean>] [-DefaultSharePermission <String>] [-PublicNetworkAccess <String>] + [-ImmutabilityPeriod <Int32>] [-ImmutabilityPolicyState <String>] [-EnableSftp <Boolean>] + [-EnableLocalUser <Boolean>] [-AllowedCopyScope <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-RoutingChoice <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ActiveDirectoryDomainServicesForFile +``` +Set-AzStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-Force] [-SkuName <String>] + [-AccessTier <String>] [-CustomDomainName <String>] [-UseSubDomain <Boolean>] [-Tag <Hashtable>] + [-EnableHttpsTrafficOnly <Boolean>] [-AssignIdentity] [-UserAssignedIdentityId <String>] + [-KeyVaultUserAssignedIdentityId <String>] [-KeyVaultFederatedClientId <String>] [-IdentityType <String>] + [-NetworkRuleSet <PSNetworkRuleSet>] [-UpgradeToStorageV2] [-EnableLargeFileShare] + [-PublishMicrosoftEndpoint <Boolean>] [-PublishInternetEndpoint <Boolean>] + -EnableActiveDirectoryDomainServicesForFile <Boolean> [-ActiveDirectoryDomainName <String>] + [-ActiveDirectoryNetBiosDomainName <String>] [-ActiveDirectoryForestName <String>] + [-ActiveDirectoryDomainGuid <String>] [-ActiveDirectoryDomainSid <String>] + [-ActiveDirectoryAzureStorageSid <String>] [-ActiveDirectorySamAccountName <String>] + [-ActiveDirectoryAccountType <String>] [-AllowBlobPublicAccess <Boolean>] [-MinimumTlsVersion <String>] + [-AllowSharedKeyAccess <Boolean>] [-SasExpirationPeriod <TimeSpan>] [-KeyExpirationPeriodInDay <Int32>] + [-AllowCrossTenantReplication <Boolean>] [-DefaultSharePermission <String>] [-PublicNetworkAccess <String>] + [-ImmutabilityPeriod <Int32>] [-ImmutabilityPolicyState <String>] [-EnableSftp <Boolean>] + [-EnableLocalUser <Boolean>] [-AllowedCopyScope <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-RoutingChoice <String>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageAccount** cmdlet modifies an Azure Storage account. +You can use this cmdlet to modify the account type, update a customer domain, or set tags on a Storage account. + +## EXAMPLES + +### Example 1: Set the Storage account type +```powershell +Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -SkuName "Standard_RAGRS" +``` + +This command sets the Storage account type to Standard_RAGRS. + +### Example 2: Set a custom domain for a Storage account +```powershell +Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -CustomDomainName "www.contoso.com" -UseSubDomain $true +``` + +This command sets a custom domain for a Storage account. + +### Example 3: Set the access tier value +```powershell +Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -AccessTier Cool +``` + +The command sets the Access Tier value to be cool. + +### Example 4: Set the custom domain and tags +```powershell +Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -CustomDomainName "www.domainname.com" -UseSubDomain $true -Tag @{tag0="value0";tag1="value1";tag2="value2"} +``` + +The command sets the custom domain and tags for a Storage account. + +### Example 5: Set Encryption KeySource to Keyvault +```powershell +Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -AssignIdentity +$account = Get-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" + +$keyVault = New-AzKeyVault -VaultName "MyKeyVault" -ResourceGroupName "MyResourceGroup" -Location "EastUS2" +$key = Add-AzKeyVaultKey -VaultName "MyKeyVault" -Name "MyKey" -Destination 'Software' +Set-AzKeyVaultAccessPolicy -VaultName "MyKeyVault" -ObjectId $account.Identity.PrincipalId -PermissionsToKeys wrapkey,unwrapkey,get + +# In case to enable key auto rotation, don't set KeyVersion +Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -KeyvaultEncryption -KeyName $key.Name -KeyVersion $key.Version -KeyVaultUri $keyVault.VaultUri + +# In case to enable key auto rotation after set keyvault proeprites with KeyVersion, can update account by set KeyVersion to empty +Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -KeyvaultEncryption -KeyName $key.Name -KeyVersion "" -KeyVaultUri $keyVault.VaultUri +``` + +This command set Encryption KeySource with a new created Keyvault. +If want to enable key auto rotation, don't set keyversion when set Keyvault properties for the first time, or clean up it by set keyvault properties again with keyversion as empty. + +### Example 6: Set Encryption KeySource to "Microsoft.Storage" +```powershell +Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -StorageEncryption +``` + +This command set Encryption KeySource to "Microsoft.Storage" + +### Example 7: Set NetworkRuleSet property of a Storage account with JSON +```powershell +Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -NetworkRuleSet (@{bypass="Logging,Metrics"; + ipRules=(@{IPAddressOrRange="20.11.0.0/16";Action="allow"}, + @{IPAddressOrRange="10.0.0.0/7";Action="allow"}); + virtualNetworkRules=(@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"}, + @{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2";Action="allow"}); + defaultAction="allow"}) +``` + +This command sets NetworkRuleSet property of a Storage account with JSON + +### Example 8: Get NetworkRuleSet property from a Storage account, and set it to another Storage account +```powershell +$networkRuleSet = (Get-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount").NetworkRuleSet +Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount2" -NetworkRuleSet $networkRuleSet +``` + +This first command gets NetworkRuleSet property from a Storage account, and the second command sets it to another Storage account + +### Example 9: Upgrade a Storage account with Kind "Storage" or "BlobStorage" to "StorageV2" kind Storage account +```powershell +Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -UpgradeToStorageV2 +``` + +The command upgrade a Storage account with Kind "Storage" or "BlobStorage" to "StorageV2" kind Storage account. + +### Example 10: Update a Storage account by enable Azure Files AAD DS Authentication and set DefaultSharePermission. +```powershell +$account = Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -EnableAzureActiveDirectoryDomainServicesForFile $true -DefaultSharePermission StorageFileDataSmbShareContributor + +$account.AzureFilesIdentityBasedAuth +``` + +```output +DirectoryServiceOptions ActiveDirectoryProperties DefaultSharePermission +----------------------- ------------------------- ---------------------- +AADDS Microsoft.Azure.Commands.Management.Storage.Models.PSActiveDirectoryProperties StorageFileDataSmbShareContributor +``` + +The command update a Storage account by enable Azure Files AAD DS Authentication. + +### Example 11: Update a Storage account by enable Files Active Directory Domain Service Authentication, and then show the File Identity Based authentication setting +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\> $account = Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -EnableActiveDirectoryDomainServicesForFile $true ` + -ActiveDirectoryDomainName "mydomain.com" ` + -ActiveDirectoryNetBiosDomainName "mydomain.com" ` + -ActiveDirectoryForestName "mydomain.com" ` + -ActiveDirectoryDomainGuid "12345678-1234-1234-1234-123456789012" ` + -ActiveDirectoryDomainSid "S-1-5-21-1234567890-1234567890-1234567890" ` + -ActiveDirectoryAzureStorageSid "S-1-5-21-1234567890-1234567890-1234567890-1234" ` + -ActiveDirectorySamAccountName "samaccountname" ` + -ActiveDirectoryAccountType Computer + +PS C:\> $account.AzureFilesIdentityBasedAuth.DirectoryServiceOptions +AD + +PS C:\> $account.AzureFilesIdentityBasedAuth.ActiveDirectoryProperties + +DomainName : mydomain.com +NetBiosDomainName : mydomain.com +ForestName : mydomain.com +DomainGuid : 12345678-1234-1234-1234-123456789012 +DomainSid : S-1-5-21-1234567890-1234567890-1234567890 +AzureStorageSid : S-1-5-21-1234567890-1234567890-1234567890-1234 +SamAccountName : samaccountname +AccountType : Computer +``` + +The command updates a Storage account by enable Azure Files Active Directory Domain Service Authentication, and then shows the File Identity Based authentication setting + +### Example 12: Set MinimumTlsVersion, AllowBlobPublicAccess and AllowSharedKeyAccess +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\> $account = Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -MinimumTlsVersion TLS1_1 -AllowBlobPublicAccess $false -AllowSharedKeyAccess $true + +PS C:\> $account.MinimumTlsVersion +TLS1_1 + +PS C:\> $account.AllowBlobPublicAccess +False + +PS C:\> $a.AllowSharedKeyAccess +True +``` + +The command sets MinimumTlsVersion, AllowBlobPublicAccess and AllowSharedKeyAccess, and then show the the 3 properties of the account + +### Example 13: Update a Storage account with RoutingPreference setting +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +PS C:\>$account = Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -PublishMicrosoftEndpoint $false -PublishInternetEndpoint $true -RoutingChoice InternetRouting + +PS C:\>$account.RoutingPreference + +RoutingChoice PublishMicrosoftEndpoints PublishInternetEndpoints +------------- ------------------------- ------------------------ +InternetRouting False True + +PS C:\>$account.PrimaryEndpoints + +Blob : https://mystorageaccount.blob.core.windows.net/ +Queue : https://mystorageaccount.queue.core.windows.net/ +Table : https://mystorageaccount.table.core.windows.net/ +File : https://mystorageaccount.file.core.windows.net/ +Web : https://mystorageaccount.z2.web.core.windows.net/ +Dfs : https://mystorageaccount.dfs.core.windows.net/ +MicrosoftEndpoints : +InternetEndpoints : {"Blob":"https://mystorageaccount-internetrouting.blob.core.windows.net/","File":"https://mystorageaccount-internetrouting.file.core.windows.net/","Web":"https://mystorageaccount-internetrouting.z2.web.core.windows.net/","Dfs":"https://w + eirp3-internetrouting.dfs.core.windows.net/"} +``` + +This command updates a Storage account with RoutingPreference setting: PublishMicrosoftEndpoint as false, PublishInternetEndpoint as true, and RoutingChoice as MicrosoftRouting. + +### Example 14: Update a Storage account with KeyExpirationPeriod and SasExpirationPeriod +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +PS C:\> $account = Set-AzStorageAccount -ResourceGroupName "myresourcegroup" -Name "mystorageaccount" -KeyExpirationPeriodInDay 5 -SasExpirationPeriod "1.12:05:06" -EnableHttpsTrafficOnly $true + +PS C:\> $account.KeyPolicy.KeyExpirationPeriodInDays +5 + +PS C:\> $account.SasPolicy.SasExpirationPeriod +1.12:05:06 +``` + +This command updates a Storage account with KeyExpirationPeriod and SasExpirationPeriod, then show the updated account related properties. + +### Example 15: Update a Storage account to Keyvault encryption, and access Keyvault with user assigned identity +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +# Create KeyVault (no need if using exist keyvault) +PS C:\> $keyVault = New-AzKeyVault -VaultName $keyvaultName -ResourceGroupName $resourceGroupName -Location eastus2euap -EnablePurgeProtection +PS C:\> $key = Add-AzKeyVaultKey -VaultName $keyvaultName -Name $keyname -Destination 'Software' + +# create user assigned identity and grant access to keyvault (no need if using exist user assigned identity) +PS C:\> $userId = New-AzUserAssignedIdentity -ResourceGroupName $resourceGroupName -Name $userIdName +PS C:\> Set-AzKeyVaultAccessPolicy -VaultName $keyvaultName -ResourceGroupName $resourceGroupName -ObjectId $userId.PrincipalId -PermissionsToKeys get,wrapkey,unwrapkey -BypassObjectIdValidation +PS C:\> $useridentityId= $userId.Id + +# Update Storage account with Keyvault encryption and access Keyvault with user assigned identity, then show properties +PS C:\> $account = Set-AzStorageAccount -ResourceGroupName $resourceGroupName -Name $storageAccountName ` + -IdentityType UserAssigned -UserAssignedIdentityId $useridentityId ` + -KeyVaultUri $keyVault.VaultUri -KeyName $keyname -KeyVaultUserAssignedIdentityId $useridentityId + +PS C:\> $account.Encryption.EncryptionIdentity.EncryptionUserAssignedIdentity +/subscriptions/{subscription-id}/resourceGroups/myresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuserid + +PS C:\> $account.Encryption.KeyVaultProperties + +KeyName : wrappingKey +KeyVersion : +KeyVaultUri : https://mykeyvault.vault.azure.net:443 +CurrentVersionedKeyIdentifier : https://mykeyvault.vault.azure.net/keys/wrappingKey/8e74036e0d534e58b3bd84b319e31d8f +LastKeyRotationTimestamp : 4/12/2021 8:17:57 AM +``` + +This command first creates a keyvault and a user assigned identity, then updates a storage account with keyvault encryption, the storage access access keyvault with the user assigned identity. + +### Example 16: Update a Keyvault encrypted Storage account, from access Keyvault with user assigned identity, to access Keyvault with system assigned identity +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +# Assign System identity to the account, and give the system assigned identity acces to the keyvault +PS C:\> $account = Set-AzStorageAccount -ResourceGroupName $resourceGroupName -Name $storageAccountName -IdentityType SystemAssignedUserAssigned +PS C:\> Set-AzKeyVaultAccessPolicy -VaultName $keyvaultName -ResourceGroupName $resourceGroupName -ObjectId $account.Identity.PrincipalId -PermissionsToKeys get,wrapkey,unwrapkey -BypassObjectIdValidation + +# Update account from access Keyvault with user assigned identity to access Keyvault with system assigned identity +$account = Set-AzStorageAccount -ResourceGroupName $resourceGroupName -Name $storageAccountName -IdentityType SystemAssignedUserAssigned -KeyName $keyname -KeyVaultUri $keyvaultUri -KeyVaultUserAssignedIdentityId "" + +# EncryptionUserAssignedIdentity is empty, so the account access keyvault with system assigned identity +PS C:\> $account.Encryption.EncryptionIdentity + +EncryptionUserAssignedIdentity +------------------------------ + +PS C:\> $account.Encryption.KeyVaultProperties + +KeyName : wrappingKey +KeyVersion : +KeyVaultUri : https://mykeyvault.vault.azure.net:443 +CurrentVersionedKeyIdentifier : https://mykeyvault.vault.azure.net/keys/wrappingKey/8e74036e0d534e58b3bd84b319e31d8f +LastKeyRotationTimestamp : 4/12/2021 8:17:57 AM +``` + +This command first assigns System identity to the account, and give the system assigned identity access to the keyvault; then updates the Storage account to access Keyvault with system assigned identity. + +### Example 17: Update both Keyvault and the user assigned identity to access keyvault +```powershell +# Update to another user assigned identity +$account = Set-AzStorageAccount -ResourceGroupName $resourceGroupName -Name $storageAccountName -IdentityType SystemAssignedUserAssigned -UserAssignedIdentityId $useridentity2 -KeyVaultUserAssignedIdentityId $useridentity2 + +# Update to encrypt with another keyvault +$account = Set-AzStorageAccount -ResourceGroupName $resourceGroupName -Name $storageAccountName -KeyVaultUri $keyvaultUri2 -KeyName $keyname2 -KeyVersion $keyversion2 +``` + +This command first update the user assigned identity to access keyvault, then update the keyvault for encryption. +To update both both Keyvault and the user assigned identity, we need update with the above 2 steps. + +### Example 18: Update a Storage account with AllowCrossTenantReplication +```powershell +$account = Set-AzStorageAccount -ResourceGroupName "myresourcegroup" -Name "mystorageaccount" -AllowCrossTenantReplication $false -EnableHttpsTrafficOnly $true + +$account.AllowCrossTenantReplication +``` + +```output +False +``` + +This command updates a Storage account by set AllowCrossTenantReplication to false, then show the updated account related properties. + +### Example 18: Update a Storage account by enable PublicNetworkAccess +```powershell +$account = Set-AzStorageAccount -ResourceGroupName "myresourcegroup" -Name "mystorageaccount" -PublicNetworkAccess Enabled + +$account.PublicNetworkAccess +``` + +```output +Enabled +``` + +This command updates a Storage account by set PublicNetworkAccess as enabled. + +### Example 19: Update account level immutability policy +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\> $account = Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -ImmutabilityPeriod 2 -ImmutabilityPolicyState Unlocked + +PS C:\> $account.ImmutableStorageWithVersioning.Enabled +True + +PS C:\> $account.ImmutableStorageWithVersioning.ImmutabilityPolicy + +ImmutabilityPeriodSinceCreationInDays State +------------------------------------- ----- + 2 Unlocked +``` + +The command updates account-level immutability policy properties on an existing storage account, and show the result. +The storage account must be created with enable account level immutability with versioning. +The account-level immutability policy will be inherited and applied to objects that do not possess an explicit immutability policy at the object level. + +### Example 20: Update a Storage account by enable Sftp and localuser +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +PS C:\> $account = Set-AzStorageAccount -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -EnableSftp $true -EnableLocalUser $true + +PS C:\> $account.EnableSftp +True + +PS C:\> $account.EnableLocalUser +True +``` + +This command updates a Storage account by enable Sftp and localuser. +To run the command succssfully, the Storage account should already enable Hierarchical Namespace. + +### Example 21: Update a Storage account with Keyvault from another tenant (access Keyvault with FederatedClientId) +<!-- Skip: Output cannot be splitted from code --> + + +```powershell +# create Storage account with Keyvault encryption (access Keyvault with FederatedClientId), then show properties +PS C:\> $account = Set-AzStorageAccount -ResourceGroupName $resourceGroupName -Name $storageAccountName ` + -KeyVaultUri $keyVault.VaultUri -KeyName $keyname -KeyVaultUserAssignedIdentityId $useridentityId -KeyVaultFederatedClientId $federatedClientId + +PS C:\> $account.Encryption.EncryptionIdentity + +EncryptionUserAssignedIdentity EncryptionFederatedIdentityClientId +------------------------------ ----------------------------------- +/subscriptions/{subscription-id}/resourceGroups/myresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuserid ********-****-****-****-************ + +PS C:\> $account.Encryption.KeyVaultProperties + +KeyName : wrappingKey +KeyVersion : +KeyVaultUri : https://mykeyvault.vault.azure.net:443 +CurrentVersionedKeyIdentifier : https://mykeyvault.vault.azure.net/keys/wrappingKey/8e74036e0d534e58b3bd84b319e31d8f +LastKeyRotationTimestamp : 3/3/2022 2:07:34 AM +``` + +This command updates a storage account with Keyvault from another tenant (access Keyvault with FederatedClientId). + +## PARAMETERS + +### -AccessTier +Specifies the access tier of the Storage account that this cmdlet modifies. +The acceptable values for this parameter are: Hot and Cool. +If you change the access tier, it may result in additional charges. For more information, see +[Azure Blob Storage: Hot and cool storage tiers](http://go.microsoft.com/fwlink/?LinkId=786482). +If the Storage account has Kind as StorageV2 or BlobStorage, you can specify the *AccessTier* parameter. +If the Storage account has Kind as Storage, do not specify the *AccessTier* parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Hot, Cool + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryAccountType +Specifies the Active Directory account type for Azure Storage. Possible values include: 'User', 'Computer'. + +```yaml +Type: System.String +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryAzureStorageSid +Specifies the security identifier (SID) for Azure Storage. This parameter must be set when -EnableActiveDirectoryDomainServicesForFile is set to true. + +```yaml +Type: System.String +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryDomainGuid +Specifies the domain GUID. This parameter must be set when -EnableActiveDirectoryDomainServicesForFile is set to true. + +```yaml +Type: System.String +Parameter Sets: AzureActiveDirectoryKerberosForFile, ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryDomainName +Specifies the primary domain that the AD DNS server is authoritative for. This parameter must be set when -EnableActiveDirectoryDomainServicesForFile is set to true. + +```yaml +Type: System.String +Parameter Sets: AzureActiveDirectoryKerberosForFile, ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryDomainSid +Specifies the security identifier (SID). This parameter must be set when -EnableActiveDirectoryDomainServicesForFile is set to true. + +```yaml +Type: System.String +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryForestName +Specifies the Active Directory forest to get. This parameter must be set when -EnableActiveDirectoryDomainServicesForFile is set to true. + +```yaml +Type: System.String +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectoryNetBiosDomainName +Specifies the NetBIOS domain name. This parameter must be set when -EnableActiveDirectoryDomainServicesForFile is set to true. + +```yaml +Type: System.String +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ActiveDirectorySamAccountName +Specifies the Active Directory SAMAccountName for Azure Storage. + +```yaml +Type: System.String +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBlobPublicAccess +Allow or disallow public access to all blobs or containers in the storage account. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCrossTenantReplication +Gets or sets allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedCopyScope +Set restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. Possible values include: 'PrivateLink', 'AAD' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSharedKeyAccess +Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Generate and assign a new Storage account Identity for this Storage account for use with key management services like Azure KeyVault. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDomainName +Specifies the name of the custom domain. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSharePermission +Default share permission for users using Kerberos authentication if RBAC role is not assigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: None, StorageFileDataSmbShareContributor, StorageFileDataSmbShareReader, StorageFileDataSmbShareElevatedContributor + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableActiveDirectoryDomainServicesForFile +Enable Azure Files Active Directory Domain Service Authentication for the storage account. + +```yaml +Type: System.Boolean +Parameter Sets: ActiveDirectoryDomainServicesForFile +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAzureActiveDirectoryDomainServicesForFile +Enable Azure Files Active Directory Domain Service Authentication for the storage account. + +```yaml +Type: System.Boolean +Parameter Sets: StorageEncryption, KeyvaultEncryption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAzureActiveDirectoryKerberosForFile +Enable Azure Files Active Directory Domain Service Kerberos Authentication for the storage account. + +```yaml +Type: System.Boolean +Parameter Sets: AzureActiveDirectoryKerberosForFile +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableHttpsTrafficOnly +Indicates whether or not the Storage account only enables HTTPS traffic. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLargeFileShare +Indicates whether or not the storage account can support large file shares with more than 5 TiB capacity. +Once the account is enabled, the feature cannot be disabled. +Currently only supported for LRS and ZRS replication types, hence account conversions to geo-redundant accounts would not be possible. +Learn more in https://go.microsoft.com/fwlink/?linkid=2086047 + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLocalUser +Enable local users feature for the Storage account. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSftp +Enable Secure File Transfer Protocol for the Storage account. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the change to be written to the Storage account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Set the new Storage Account Identity type, the idenetity is for use with key management services like Azure KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutabilityPeriod +The immutability period for the blobs in the container since the policy creation in days. +This property can only be changed when account is created with '-EnableAccountLevelImmutability'. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmutabilityPolicyState +The mode of the policy. Possible values include: 'Unlocked', 'Locked', 'Disabled. +Disabled state disablesthe policy. +Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property. +Locked state only allows the increase of the immutability retention time. +A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. +This property can only be changed when account is created with '-EnableAccountLevelImmutability'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyExpirationPeriodInDay +The Key expiration period of this account, it is accurate to days. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +If using -KeyvaultEncryption to enable encryption with Key Vault, specify the Keyname property with this option. + +```yaml +Type: System.String +Parameter Sets: KeyvaultEncryption +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyvaultEncryption +Indicates whether or not to use Microsoft KeyVault for the encryption keys when using Storage Service Encryption. +If KeyName, KeyVersion, and KeyVaultUri are all set, KeySource will be set to Microsoft.Keyvault whether this parameter is set or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: KeyvaultEncryption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultFederatedClientId +Set ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultUri +When using Key Vault Encryption by specifying the -KeyvaultEncryption parameter, use this option to specify the URI to the Key Vault. + +```yaml +Type: System.String +Parameter Sets: KeyvaultEncryption +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultUserAssignedIdentityId +Set resource id for user assigned Identity used to access Azure KeyVault of Storage Account Encryption, the id must in the storage account's UserAssignIdentityId. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVersion +When using Key Vault Encryption by specifying the -KeyvaultEncryption parameter, use this option to specify the URI to the Key Version. + +```yaml +Type: System.String +Parameter Sets: KeyvaultEncryption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinimumTlsVersion +The minimum TLS version to be permitted on requests to storage. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TLS1_0, TLS1_1, TLS1_2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage account to modify. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetworkRuleSet +NetworkRuleSet is used to define a set of configuration rules for firewalls and virtual networks, as well as to set values for network properties such as services allowed to bypass the rules and how to handle requests that don't match any of the defined rules. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSNetworkRuleSet +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Allow or disallow public network access to Storage Account.Possible values include: 'Enabled', 'Disabled'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishInternetEndpoint +Indicates whether internet routing storage endpoints are to be published + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishMicrosoftEndpoint +Indicates whether microsoft routing storage endpoints are to be published + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group in which to modify the Storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RoutingChoice +Routing Choice defines the kind of network routing opted by the user. Possible values include: 'MicrosoftRouting', 'InternetRouting' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: MicrosoftRouting, InternetRouting + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SasExpirationPeriod +The SAS expiration period of this account, it is a timespan and accurate to seconds. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Specifies the SKU name of the Storage account. +The acceptable values for this parameter are: +- Standard_LRS - Locally-redundant storage. +- Standard_ZRS - Zone-redundant storage. +- Standard_GRS - Geo-redundant storage. +- Standard_RAGRS - Read access geo-redundant storage. +- Premium_LRS - Premium locally-redundant storage. +- Standard_GZRS - Geo-redundant zone-redundant storage. +- Standard_RAGZRS - Read access geo-redundant zone-redundant storage. +You cannot change Standard_ZRS and Premium_LRS types to other account types. +You cannot change other account types to Standard_ZRS or Premium_LRS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountType, AccountType, Type +Accepted values: Standard_LRS, Standard_ZRS, Standard_GRS, Standard_RAGRS, Premium_LRS, Standard_GZRS, Standard_RAGZRS + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageEncryption +Indicates whether or not to set the Storage account encryption to use Microsoft-managed keys. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: StorageEncryption +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table set as tags on the server. For example: +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UpgradeToStorageV2 +Upgrade Storage account Kind from Storage or BlobStorage to StorageV2. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +Set resource ids for the the new Storage Account user assignedd Identity, the identity will be used with key management services like Azure KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseSubDomain +Indicates whether to enable indirect CName validation. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## NOTES + +## RELATED LINKS + +[Get-AzStorageAccount](./Get-AzStorageAccount.md) + +[New-AzStorageAccount](./New-AzStorageAccount.md) + +[Remove-AzStorageAccount](./Remove-AzStorageAccount.md) diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageAccountManagementPolicy.md b/azps-10.1.0/Az.Storage/Set-AzStorageAccountManagementPolicy.md new file mode 100644 index 0000000000..d7674221c7 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageAccountManagementPolicy.md @@ -0,0 +1,512 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/Az.storage/set-Azstorageaccountmanagementpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageAccountManagementPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageAccountManagementPolicy.md +--- + +# Set-AzStorageAccountManagementPolicy + +## SYNOPSIS +Creates or modifies the management policy of an Azure Storage account. + +## SYNTAX + +### AccountNamePolicyRule (Default) +``` +Set-AzStorageAccountManagementPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -Rule <PSManagementPolicyRule[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountNamePolicyObject +``` +Set-AzStorageAccountManagementPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -Policy <PSManagementPolicy> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountObjectPolicyRule +``` +Set-AzStorageAccountManagementPolicy -StorageAccount <PSStorageAccount> -Rule <PSManagementPolicyRule[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObjectPolicyObject +``` +Set-AzStorageAccountManagementPolicy -StorageAccount <PSStorageAccount> -Policy <PSManagementPolicy> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountResourceIdPolicyRule +``` +Set-AzStorageAccountManagementPolicy [-StorageAccountResourceId] <String> -Rule <PSManagementPolicyRule[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountResourceIdPolicyObject +``` +Set-AzStorageAccountManagementPolicy [-StorageAccountResourceId] <String> -Policy <PSManagementPolicy> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageAccountManagementPolicy** cmdlet creates or modifies the management policy of an Azure Storage account. + +## EXAMPLES + +### Example 1: Create or update the management policy of a Storage account with ManagementPolicy rule objects. +```powershell +$action1 = Add-AzStorageAccountManagementPolicyAction -BaseBlobAction Delete -DaysAfterCreationGreaterThan 100 +$action1 = Add-AzStorageAccountManagementPolicyAction -InputObject $action1 -BaseBlobAction TierToArchive -daysAfterModificationGreaterThan 50 -DaysAfterLastTierChangeGreaterThan 30 +$action1 = Add-AzStorageAccountManagementPolicyAction -InputObject $action1 -BaseBlobAction TierToCool -DaysAfterLastAccessTimeGreaterThan 30 -EnableAutoTierToHotFromCool +$action1 = Add-AzStorageAccountManagementPolicyAction -InputObject $action1 -SnapshotAction Delete -daysAfterCreationGreaterThan 100 +$action1 = Add-AzStorageAccountManagementPolicyAction -InputObject $action1 -BlobVersionAction TierToArchive -daysAfterCreationGreaterThan 100 -DaysAfterLastTierChangeGreaterThan 14 +$filter1 = New-AzStorageAccountManagementPolicyFilter -PrefixMatch ab,cd +$rule1 = New-AzStorageAccountManagementPolicyRule -Name Test -Action $action1 -Filter $filter1 + +$action2 = Add-AzStorageAccountManagementPolicyAction -BaseBlobAction Delete -daysAfterCreationGreaterThan 100 +$blobindexmatch1 = New-AzStorageAccountManagementPolicyBlobIndexMatchObject -Name "tag1" -Value "value1" +$blobindexmatch2 = New-AzStorageAccountManagementPolicyBlobIndexMatchObject -Name "tag2" -Value "value2" +$filter2 = New-AzStorageAccountManagementPolicyFilter -BlobType appendBlob,blockBlob -BlobIndexMatch $blobindexmatch1,$blobindexmatch2 +$rule2 = New-AzStorageAccountManagementPolicyRule -Name Test2 -Action $action2 -Filter $filter2 + +Set-AzStorageAccountManagementPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -Rule $rule1,$rule2 +``` + +```output +ResourceGroupName : myresourcegroup +StorageAccountName : mystorageaccount +Id : /subscriptions/{subscription-id}/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount/managementPolicies/default +Type : Microsoft.Storage/storageAccounts/managementPolicies +LastModifiedTime : 7/12/2022 8:32:09 AM +Rules : [ + { + "Enabled": true, + "Name": "Test", + "Definition": { + "Actions": { + "BaseBlob": { + "TierToCool": { + "DaysAfterModificationGreaterThan": null, + "DaysAfterLastAccessTimeGreaterThan": 30, + "DaysAfterCreationGreaterThan": null, + "DaysAfterLastTierChangeGreaterThan": null + }, + "TierToArchive": { + "DaysAfterModificationGreaterThan": 50, + "DaysAfterLastAccessTimeGreaterThan": null, + "DaysAfterCreationGreaterThan": null, + "DaysAfterLastTierChangeGreaterThan": 30 + }, + "Delete": { + "DaysAfterModificationGreaterThan": null, + "DaysAfterLastAccessTimeGreaterThan": null, + "DaysAfterCreationGreaterThan": 100, + "DaysAfterLastTierChangeGreaterThan": null + }, + "EnableAutoTierToHotFromCool": true + }, + "Snapshot": { + "Delete": { + "DaysAfterCreationGreaterThan": 100, + "DaysAfterLastTierChangeGreaterThan": null + }, + "TierToCool": null, + "TierToArchive": null + }, + "Version": { + "Delete": null, + "TierToCool": null, + "TierToArchive": { + "DaysAfterCreationGreaterThan": 100, + "DaysAfterLastTierChangeGreaterThan": 14 + } + } + }, + "Filters": { + "PrefixMatch": [ + "ab", + "cd" + ], + "BlobTypes": [ + "blockBlob" + ], + "BlobIndexMatch": null + } + } + }, + { + "Enabled": true, + "Name": "Test2", + "Definition": { + "Actions": { + "BaseBlob": { + "TierToCool": null, + "TierToArchive": null, + "Delete": { + "DaysAfterModificationGreaterThan": null, + "DaysAfterLastAccessTimeGreaterThan": null, + "DaysAfterCreationGreaterThan": 100, + "DaysAfterLastTierChangeGreaterThan": null + }, + "EnableAutoTierToHotFromCool": null + }, + "Snapshot": null, + "Version": null + }, + "Filters": { + "PrefixMatch": null, + "BlobTypes": [ + "appendBlob", + "blockBlob" + ], + "BlobIndexMatch": [ + { + "Name": "tag1", + "Op": "==", + "Value": "value1" + }, + { + "Name": "tag2", + "Op": "==", + "Value": "value2" + } + ] + } + } + } + ] +``` + +This command first create 2 ManagementPolicy rule objects, then creates or updates the management policy of a Storage account with the 2 ManagementPolicy rule objects. + +### Example 2: Create or update the management policy of a Storage account with a Json format policy. +```powershell +Set-AzStorageAccountManagementPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -Policy (@{ + Rules=(@{ + Enabled=$true; + Name="Test"; + Definition=(@{ + Actions=(@{ + BaseBlob=(@{ + TierToCool=@{DaysAfterLastAccessTimeGreaterThan=30}; + TierToArchive=@{DaysAfterModificationGreaterThan=50;DaysAfterLastTierChangeGreaterThan=30}; + Delete=@{DaysAfterCreationGreaterThan=100}; + EnableAutoTierToHotFromCool="true"; + }); + Snapshot=(@{ + Delete=@{DaysAfterCreationGreaterThan=100} + TierToArchive=@{DaysAfterCreationGreaterThan=50}; + TierToCool=@{DaysAfterCreationGreaterThan=60}; + }); + Version=(@{ + Delete=@{DaysAfterCreationGreaterThan=100}; + TierToArchive=@{DaysAfterCreationGreaterThan=50;DaysAfterLastTierChangeGreaterThan=20}; + TierToCool=@{DaysAfterCreationGreaterThan=60}; + }); + }); + Filters=(@{ + BlobTypes=@("blockBlob"); + PrefixMatch=@("prefix1","prefix2"); + }) + }) + }, + @{ + Enabled=$false; + Name="Test2"; + Definition=(@{ + Actions=(@{ + BaseBlob=(@{ + Delete=@{DaysAfterCreationGreaterThan=100}; + }); + }); + Filters=(@{ + BlobTypes=@("blockBlob","appendBlob"); + BlobIndexMatch=(@{Name="tag1";Op="==";Value ="value1"},@{Name="tag2";Op="==";Value="value2"}) + }) + }) + }) +}) +``` + +```output +ResourceGroupName : myresourcegroup +StorageAccountName : mystorageaccount +Id : /subscriptions/{subscription-id}/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount/managementPolicies/default +Type : Microsoft.Storage/storageAccounts/managementPolicies +LastModifiedTime : 7/12/2022 8:34:05 AM +Rules : [ + { + "Enabled": true, + "Name": "Test", + "Definition": { + "Actions": { + "BaseBlob": { + "TierToCool": { + "DaysAfterModificationGreaterThan": null, + "DaysAfterLastAccessTimeGreaterThan": 30, + "DaysAfterCreationGreaterThan": null, + "DaysAfterLastTierChangeGreaterThan": null + }, + "TierToArchive": { + "DaysAfterModificationGreaterThan": 50, + "DaysAfterLastAccessTimeGreaterThan": null, + "DaysAfterCreationGreaterThan": null, + "DaysAfterLastTierChangeGreaterThan": 30 + }, + "Delete": { + "DaysAfterModificationGreaterThan": null, + "DaysAfterLastAccessTimeGreaterThan": null, + "DaysAfterCreationGreaterThan": 100, + "DaysAfterLastTierChangeGreaterThan": null + }, + "EnableAutoTierToHotFromCool": true + }, + "Snapshot": { + "Delete": { + "DaysAfterCreationGreaterThan": 100, + "DaysAfterLastTierChangeGreaterThan": null + }, + "TierToCool": { + "DaysAfterCreationGreaterThan": 60, + "DaysAfterLastTierChangeGreaterThan": null + }, + "TierToArchive": { + "DaysAfterCreationGreaterThan": 50, + "DaysAfterLastTierChangeGreaterThan": null + } + }, + "Version": { + "Delete": { + "DaysAfterCreationGreaterThan": 100, + "DaysAfterLastTierChangeGreaterThan": null + }, + "TierToCool": { + "DaysAfterCreationGreaterThan": 60, + "DaysAfterLastTierChangeGreaterThan": null + }, + "TierToArchive": { + "DaysAfterCreationGreaterThan": 50, + "DaysAfterLastTierChangeGreaterThan": 20 + } + } + }, + "Filters": { + "PrefixMatch": [ + "prefix1", + "prefix2" + ], + "BlobTypes": [ + "blockBlob" + ], + "BlobIndexMatch": null + } + } + }, + { + "Enabled": false, + "Name": "Test2", + "Definition": { + "Actions": { + "BaseBlob": { + "TierToCool": null, + "TierToArchive": null, + "Delete": { + "DaysAfterModificationGreaterThan": null, + "DaysAfterLastAccessTimeGreaterThan": null, + "DaysAfterCreationGreaterThan": 100, + "DaysAfterLastTierChangeGreaterThan": null + }, + "EnableAutoTierToHotFromCool": null + }, + "Snapshot": null, + "Version": null + }, + "Filters": { + "PrefixMatch": null, + "BlobTypes": [ + "blockBlob", + "appendBlob" + ], + "BlobIndexMatch": [ + { + "Name": "tag1", + "Op": "==", + "Value": "value1" + }, + { + "Name": "tag2", + "Op": "==", + "Value": "value2" + } + ] + } + } + } + ] +``` + +This command creates or updates the management policy of a Storage account with a json format policy. + +### Example 3: Get the management policy from a Storage account, then set it to another Storage account. +```powershell +$outputPolicy = Get-AzStorageAccountManagementPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" | Set-AzStorageAccountManagementPolicy -ResourceGroupName "myresourcegroup2" -AccountName "mystorageaccount2" +``` + +This command first gets the management policy from a Storage account, then set it to another Storage account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Management Policy Object to Set + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSManagementPolicy +Parameter Sets: AccountNamePolicyObject, AccountObjectPolicyObject, AccountResourceIdPolicyObject +Aliases: ManagementPolicy + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountNamePolicyRule, AccountNamePolicyObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +The Management Policy rules. Get the object with New-AzStorageAccountManagementPolicyRule cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSManagementPolicyRule[] +Parameter Sets: AccountNamePolicyRule, AccountObjectPolicyRule, AccountResourceIdPolicyRule +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObjectPolicyRule, AccountObjectPolicyObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountNamePolicyRule, AccountNamePolicyObject +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Storage Account Resource Id. + +```yaml +Type: System.String +Parameter Sets: AccountResourceIdPolicyRule, AccountResourceIdPolicyObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSManagementPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageBlobContent.md b/azps-10.1.0/Az.Storage/Set-AzStorageBlobContent.md new file mode 100644 index 0000000000..b41878571b --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageBlobContent.md @@ -0,0 +1,523 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: F20A5FD3-6EC3-4EFE-988C-75F8583961A4 +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstorageblobcontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageBlobContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageBlobContent.md +--- + +# Set-AzStorageBlobContent + +## SYNOPSIS +Uploads a local file to an Azure Storage blob. + +## SYNTAX + +### SendManual (Default) +``` +Set-AzStorageBlobContent [-File] <String> [-Container] <String> [-Blob <String>] [-BlobType <String>] + [-Properties <Hashtable>] [-Metadata <Hashtable>] [-Tag <Hashtable>] + [-PremiumPageBlobTier <PremiumPageBlobTier>] [-StandardBlobTier <String>] [-EncryptionScope <String>] [-Force] + [-AsJob] [-TagCondition <String>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ContainerPipeline +``` +Set-AzStorageBlobContent [-File] <String> [-Blob <String>] -CloudBlobContainer <CloudBlobContainer> + [-BlobType <String>] [-Properties <Hashtable>] [-Metadata <Hashtable>] [-Tag <Hashtable>] + [-PremiumPageBlobTier <PremiumPageBlobTier>] [-StandardBlobTier <String>] [-EncryptionScope <String>] [-Force] + [-AsJob] [-TagCondition <String>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobPipeline +``` +Set-AzStorageBlobContent [-File] <String> -CloudBlob <CloudBlob> [-BlobType <String>] [-Properties <Hashtable>] + [-Metadata <Hashtable>] [-Tag <Hashtable>] [-PremiumPageBlobTier <PremiumPageBlobTier>] + [-StandardBlobTier <String>] [-EncryptionScope <String>] [-Force] [-AsJob] [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageBlobContent** cmdlet uploads a local file to an Azure Storage blob. + +## EXAMPLES + +### Example 1: Upload a named file +```powershell +Set-AzStorageBlobContent -Container "ContosoUpload" -File ".\PlanningData" -Blob "Planning2015" +``` + +This command uploads the file that is named PlanningData to a blob named Planning2015. + +### Example 2: Upload all files under the current folder +```powershell +Get-ChildItem -File -Recurse | Set-AzStorageBlobContent -Container "ContosoUploads" +``` + +This command uses the core Windows PowerShell cmdlet Get-ChildItem to get all the files in the current folder and in subfolders, and then passes them to the current cmdlet by using the pipeline operator. +The **Set-AzStorageBlobContent** cmdlet uploads the files to the container named ContosoUploads. + +### Example 3: Overwrite an existing blob +```powershell +Get-AzStorageBlob -Container "ContosoUploads" -Blob "Planning2015" | Set-AzStorageBlobContent -File "ContosoPlanning" +``` + +This command gets the blob named Planning2015 in the ContosoUploads container by using the Get-AzStorageBlob cmdlet, and then passes that blob to the current cmdlet. +The command uploads the file that is named ContosoPlanning as Planning2015. +This command does not specify the *Force* parameter. +The command prompts you for confirmation. +If you confirm the command, the cmdlet overwrites the existing blob. + +### Example 4: Upload a file to a container by using the pipeline +```powershell +Get-AzStorageContainer -Container "ContosoUpload*" | Set-AzStorageBlobContent -File "ContosoPlanning" -Blob "Planning2015" +``` + +This command gets the container that starts with the string ContosoUpload by using the **Get-AzStorageContainer** cmdlet, and then passes that blob to the current cmdlet. +The command uploads the file that is named ContosoPlanning as Planning2015. + +### Example 5: Upload a file to page blob with metadata and PremiumPageBlobTier as P10 +```powershell +$Metadata = @{"key" = "value"; "name" = "test"} +Set-AzStorageBlobContent -File "ContosoPlanning" -Container "ContosoUploads" -Metadata $Metadata -BlobType Page -PremiumPageBlobTier P10 +``` + +The first command creates a hash table that contains metadata for a blob, and stores that hash table in the $Metadata variable. +The second command uploads the file that is named ContosoPlanning to the container named ContosoUploads. +The blob includes the metadata stored in $Metadata, and has PremiumPageBlobTier as P10. + +### Example 6: Upload a file to blob with specified blob properties, and set StandardBlobTier as Cool +```powershell +$filepath = "c:\temp\index.html" +Set-AzStorageBlobContent -File $filepath -Container "contosouploads" -Properties @{"ContentType" = [System.Web.MimeMapping]::GetMimeMapping($filepath); "ContentMD5" = "i727sP7HigloQDsqadNLHw=="} -StandardBlobTier Cool +``` + +```output +AccountName: storageaccountname, ContainerName: contosouploads + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +index.html BlockBlob 403116 text/html 2020-09-22 08:06:53Z Cool False +``` + +This command uploads the file c:\temp\index.html to the container named contosouploads with specified blob properties, and set StandardBlobTier as Cool. +This command gets ContentType value set to blob properties by [System.Web.MimeMapping]::GetMimeMapping() API. + +### Example 7: Upload a file to a blob with Encryption Scope +```powershell +$blob = Set-AzStorageBlobContent -File "mylocalfile" -Container "mycontainer" -Blob "myblob" -EncryptionScope "myencryptscope" + +$blob.BlobProperties.EncryptionScope +``` + +```output +myencryptscope +``` + +This command uploads a file to a blob with Encryption Scope. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Blob +Specifies the name of a blob. +This cmdlet uploads a file to the Azure Storage blob that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: SendManual, ContainerPipeline +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobType +Specifies the type for the blob that this cmdlet uploads. +The acceptable values for this parameter are: +- Block +- Page +- Append + +The default value is Block. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Block, Page, Append + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudBlob +Specifies a **CloudBlob** object. +To obtain a **CloudBlob** object, use the Get-AzStorageBlob cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlob +Parameter Sets: BlobPipeline +Aliases: ICloudBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CloudBlobContainer +Specifies a **CloudBlobContainer** object from the Azure Storage Client library. +This cmdlet uploads content to a blob in the container that this parameter specifies. +To obtain a **CloudBlobContainer** object, use the Get-AzStorageContainer cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlobContainer +Parameter Sets: ContainerPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Specifies the name of a container. +This cmdlet uploads a file to a blob in the container that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: SendManual +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. +To use a storage context created from a SAS Token without read permission, need add -Force parameter to skip check blob existence. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionScope +Encryption scope to be used when making requests to the blob. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +Specifies a local file path for a file to upload as blob content. + +```yaml +Type: System.String +Parameter Sets: SendManual +Aliases: FullName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: ContainerPipeline, BlobPipeline +Aliases: FullName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet overwrites an existing blob without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Metadata +Specifies metadata for the uploaded blob. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PremiumPageBlobTier +Page Blob Tier + +```yaml +Type: Microsoft.Azure.Storage.Blob.PremiumPageBlobTier +Parameter Sets: (All) +Aliases: +Accepted values: Unknown, P4, P6, P10, P20, P30, P40, P50, P60, P70, P80 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Properties +Specifies properties for the uploaded blob. +The supported properties are: CacheControl, ContentDisposition, ContentEncoding, ContentLanguage, ContentMD5, ContentType. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the service side time-out interval, in seconds, for a request. +If the specified interval elapses before the service processes the request, the storage service returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StandardBlobTier +Block Blob Tier, valid values are Hot/Cool/Archive/Cold. +See detail in https://learn.microsoft.com/azure/storage/blobs/storage-blob-storage-tiers + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Blob Tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagCondition +Optional Tag expression statement to check match condition. +The blob request will fail when the blob tags does not match the given expression. +See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Storage.Blob.CloudBlobContainer + +### Microsoft.Azure.Storage.Blob.CloudBlob + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob + +## NOTES + +## RELATED LINKS + +[Get-AzStorageBlobContent](./Get-AzStorageBlobContent.md) + +[Get-AzStorageBlob](./Get-AzStorageBlob.md) + +[Remove-AzStorageBlob](./Remove-AzStorageBlob.md) diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageBlobImmutabilityPolicy.md b/azps-10.1.0/Az.Storage/Set-AzStorageBlobImmutabilityPolicy.md new file mode 100644 index 0000000000..9be84e5675 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageBlobImmutabilityPolicy.md @@ -0,0 +1,279 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstorageblobimmutabilitypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageBlobImmutabilityPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageBlobImmutabilityPolicy.md +--- + +# Set-AzStorageBlobImmutabilityPolicy + +## SYNOPSIS +Creates or updates ImmutabilityPolicy of a Storage blob. + +## SYNTAX + +### NamePipeline (Default) +``` +Set-AzStorageBlobImmutabilityPolicy [-Blob] <String> [-Container] <String> -ExpiresOn <DateTimeOffset> + [-PolicyMode <String>] [-TagCondition <String>] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BlobPipeline +``` +Set-AzStorageBlobImmutabilityPolicy -BlobBaseClient <BlobBaseClient> -ExpiresOn <DateTimeOffset> + [-PolicyMode <String>] [-TagCondition <String>] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageBlobImmutabilityPolicy** cmdlet creates or updates ImmutabilityPolicy of a Storage blob. +The cmdlet only works when the blob container has already enabled immutable Storage with versioning. + +## EXAMPLES + +### Example 1: Create or update immutability policy of a Storage blob. +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $blob = Set-AzStorageBlobImmutabilityPolicy -Container $containerName -Blob $blobname -ExpiresOn (Get-Date).AddDays(100) -PolicyMode Unlocked + +PS C:\> $blob + + AccountName: mystorageaccount, ContainerName: mycontainer + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +testblob BlockBlob 10485760 application/octet-stream 2021-07-19 08:56:00Z Hot False 2021-07-19T08:56:01.8120788Z * + +PS C:\> $blob.BlobProperties.ImmutabilityPolicy + +ExpiresOn PolicyMode +--------- ---------- +10/27/2021 8:56:32 AM +00:00 Unlocked +``` + +This command creates or updates ImmutabilityPolicy of a Storage blob, then show the blob and its ImmutabilityPolicy. +The command only works when the blob container has already enabled immutable Storage with versioning. + +## PARAMETERS + +### -Blob +Blob name + +```yaml +Type: System.String +Parameter Sets: NamePipeline +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobBaseClient +BlobBaseClient Object + +```yaml +Type: Azure.Storage.Blobs.Specialized.BlobBaseClient +Parameter Sets: BlobPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +The client side maximum execution time for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +The total amount of concurrent async tasks. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Container name + +```yaml +Type: System.String +Parameter Sets: NamePipeline +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiresOn +Blob ImmutabilityPolicy ExpiresOn + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyMode +Blob ImmutabilityPolicy PolicyMode + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Unlocked, Locked, Mutable + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +The server time out for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagCondition +Optional Tag expression statement to check match condition. The blob request will fail when the blob tags does not match the given expression.See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Azure.Storage.Blobs.Specialized.BlobBaseClient + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageBlobInventoryPolicy.md b/azps-10.1.0/Az.Storage/Set-AzStorageBlobInventoryPolicy.md new file mode 100644 index 0000000000..67399180d5 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageBlobInventoryPolicy.md @@ -0,0 +1,362 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstorageblobinventorypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageBlobInventoryPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageBlobInventoryPolicy.md +--- + +# Set-AzStorageBlobInventoryPolicy + +## SYNOPSIS +Creates or updates blob inventory policy in a Storage account. + +## SYNTAX + +### AccountNamePolicyRule (Default) +``` +Set-AzStorageBlobInventoryPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -Rule <PSBlobInventoryPolicyRule[]> [-Disabled] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### AccountNamePolicyObject +``` +Set-AzStorageBlobInventoryPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -Policy <PSBlobInventoryPolicy> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountObjectPolicyRule +``` +Set-AzStorageBlobInventoryPolicy -StorageAccount <PSStorageAccount> -Rule <PSBlobInventoryPolicyRule[]> + [-Disabled] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObjectPolicyObject +``` +Set-AzStorageBlobInventoryPolicy -StorageAccount <PSStorageAccount> -Policy <PSBlobInventoryPolicy> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountResourceIdPolicyRule +``` +Set-AzStorageBlobInventoryPolicy [-StorageAccountResourceId] <String> -Rule <PSBlobInventoryPolicyRule[]> + [-Disabled] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountResourceIdPolicyObject +``` +Set-AzStorageBlobInventoryPolicy [-StorageAccountResourceId] <String> -Policy <PSBlobInventoryPolicy> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageBlobInventoryPolicy** cmdlet creates or updates blob inventory policy in a Storage account. + +## EXAMPLES + +### Example 1: Create or update the blob inventory policy with BlobInventoryPolicy rule objects. +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $rule1 = New-AzStorageBlobInventoryPolicyRule -Name Test1 -Destination $containerName -Disabled -Format Csv -Schedule Daily -ContainerSchemaField Name,Metadata,PublicAccess,Last-mOdified,LeaseStatus,LeaseState,LeaseDuration,HasImmutabilityPolicy,HasLegalHold -PrefixMatch con1,con2 + +PS C:\> $rule2 = New-AzStorageBlobInventoryPolicyRule -Name Test2 -Destination $containerName -Format Parquet -Schedule Weekly -IncludeBlobVersion -IncludeSnapshot -BlobType blockBlob,appendBlob -PrefixMatch aaa,bbb ` + -BlobSchemaField name,Creation-Time,Last-Modified,Content-Length,Content-MD5,BlobType,AccessTier,AccessTierChangeTime,Expiry-Time,hdi_isfolder,Owner,Group,Permissions,Acl,Metadata + +PS C:\> $rule3 = New-AzStorageBlobInventoryPolicyRule -Name Test3 -Destination $containerName -Format Parquet -Schedule Weekly -IncludeBlobVersion -IncludeSnapshot -IncludeDeleted -BlobType blockBlob,appendBlob -PrefixMatch aaa,bbb ` + -ExcludePrefix ccc,ddd -BlobSchemaField name,Last-Modified,BlobType,AccessTier,AccessTierChangeTime,Content-Type,Content-CRC64,CopyId,x-ms-blob-sequence-number,TagCount + +PS C:\> $policy = Set-AzStorageBlobInventoryPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -Disabled -Rule $rule1,$rule2,$rule3 + +PS C:\> $policy + +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegroup +Name : DefaultInventoryPolicy +Id : /subscriptions/{subscription-Id}/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount/inventoryPolicies/default +Type : Microsoft.Storage/storageAccounts/inventoryPolicies +LastModifiedTime : 5/12/2021 8:53:38 AM +Enabled : False +Rules : {Test1, Test2, Test3} + +PS C:\> $policy.Rules + +Name Enabled Destination ObjectType Format Schedule IncludeSnapshots IncludeBlobVersions IncludeDeleted BlobTypes PrefixMatch ExcludePrefix SchemaFields +---- ------- ----------- ---------- ------ -------- ---------------- ------------------- -------------- --------- ----------- ------------- ------------ +Test1 False containername Container Csv Daily {con1, con2} {Name, Metadata, PublicAccess, Last-Modified...} +Test2 True containername Blob Parquet Weekly True True {blockBlob, appendBlob} {aaa, bbb} {Name, Creation-Time, Last-Modified, Content-Length...} +Test3 True containername Blob Parquet Weekly True True True {blockBlob, appendBlob} {aaa, bbb} {ccc, ddd} {Name, Content-Type, Content-CRC64, Last-Modified...} +``` + +This first 2 commands create 3 BlobInventoryPolicy rule objects: rule "Test1" for contaienr inventory; rule "Test2" and "Test3" for blob inventory. +The following command sets blob inventory policy to a Storage account with the 2 rule objects, then show the updated policy and rules properties. + +### Example 2: Create or update the blob inventory policy of a Storage account with a Json format policy. +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $policy = Set-AzStorageBlobInventoryPolicy -ResourceGroupName $resourceGroupName -StorageAccountName $accountName -Policy (@{ + Enabled=$true; + Rules=(@{ + Enabled=$true; + Name="Test1"; + Destination=$containerName; + Definition=(@{ + ObjectType="Blob"; + Format="Csv"; + Schedule="Weekly"; + SchemaFields=@("name","Content-Length","BlobType","Snapshot","VersionId","IsCurrentVersion"); + Filters=(@{ + BlobTypes=@("blockBlob","appendBlob"); + PrefixMatch=@("prefix1","prefix2"); + IncludeSnapshots=$true; + IncludeBlobVersions=$true; + }) + }) + }, + @{ + Enabled=$false; + Name="Test2"; + Destination=$containerName; + Definition=(@{ + ObjectType="Container"; + Format="Parquet"; + Schedule="Daily"; + SchemaFields=@("name","Metadata","PublicAccess","DefaultEncryptionScope","DenyEncryptionScopeOverride"); + Filters=(@{ + PrefixMatch=@("conpre1","conpre2"); + }) + }) + }, + @{ + Enabled=$false; + Name="Test3"; + Destination=$containerName; + Definition=(@{ + ObjectType="Blob"; + Format="Csv"; + Schedule="Weekly"; + SchemaFields=@("name","Deleted","RemainingRetentionDays","Content-Type","Content-Language","Cache-Control","Content-Disposition"); + Filters=(@{ + BlobTypes=@("blockBlob","appendBlob"); + PrefixMatch=@("conpre1","conpre2"); + ExcludePrefix=@("expre1","expre2"); + IncludeDeleted=$true + }) + }) + }) + }) + + +PS C:\> $policy + +StorageAccountName : weiadlscanary1 +ResourceGroupName : weitry +Name : DefaultInventoryPolicy +Id : /subscriptions/{subscription-Id}/resourceGroups/weitry/providers/Microsoft.Storage/storageAccounts/weiadlscanary1/inventoryPolicies/default +Type : Microsoft.Storage/storageAccounts/inventoryPolicies +LastModifiedTime : 5/12/2021 9:02:21 AM +Enabled : True +Rules : {Test1, Test2, Test3} + +PS C:\> $policy.Rules + +Name Enabled Destination ObjectType Format Schedule IncludeSnapshots IncludeBlobVersions IncludeDeleted BlobTypes PrefixMatch ExcludePrefix SchemaFields +---- ------- ----------- ---------- ------ -------- ---------------- ------------------- -------------- --------- ----------- ------------- ------------ +Test1 True containername Blob Csv Weekly True True {blockBlob, appendBlob} {prefix1, prefix2} {Name, Content-Length, BlobType, Snapshot...} +Test2 False containername Container Parquet Daily {conpre1, conpre2} {Name, Metadata, PublicAccess} +Test3 False containername Blob Csv Weekly True {blockBlob, appendBlob} {conpre1, conpre2} {expre1, expre2} {Name, Content-Type, Content-Cache, Content-Language...} {name, Metadata, PublicAccess} +``` + +This command creates or updates the blob inventory policy of a Storage account with a json format policy. + +### Example 3: Get the blob inventory policy from a Storage account, then set it to another Storage account. +```powershell +$policy = Get-AzStorageBlobInventoryPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" | Set-AzStorageBlobInventoryPolicy -ResourceGroupName "myresourcegroup2" -AccountName "mystorageaccount2" +``` + +This command first gets the blob inventory policy from a Storage account, then set it to another Storage account. +The proeprties： Destination, Enabled, and Rules of the policy will be set to the destination account. + +### Example 4: Get the blob inventory policy rules from a Storage account, then set it to another Storage account. +```powershell +$policy = ,((Get-AzStorageBlobInventoryPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount").Rules) | Set-AzStorageBlobInventoryPolicy -ResourceGroupName "myresourcegroup2" -AccountName "mystorageaccount2" -Disabled +``` + +This command first gets the blob inventory policy from a Storage account, then set it's rules to another Storage account. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +The Blob Inventory Policy is enabled by default, specify this parameter to disable it. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AccountNamePolicyRule, AccountObjectPolicyRule, AccountResourceIdPolicyRule +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Blob Inventory Policy Object to Set + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSBlobInventoryPolicy +Parameter Sets: AccountNamePolicyObject, AccountObjectPolicyObject, AccountResourceIdPolicyObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountNamePolicyRule, AccountNamePolicyObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +The Blob Inventory Policy rules. +Get the object with New-AzStorageBlobInventoryPolicyRule cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSBlobInventoryPolicyRule[] +Parameter Sets: AccountNamePolicyRule, AccountObjectPolicyRule, AccountResourceIdPolicyRule +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObjectPolicyRule, AccountObjectPolicyObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountNamePolicyRule, AccountNamePolicyObject +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Storage Account Resource Id. + +```yaml +Type: System.String +Parameter Sets: AccountResourceIdPolicyRule, AccountResourceIdPolicyObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSBlobInventoryPolicyRule[] + +### Microsoft.Azure.Commands.Management.Storage.Models.PSBlobInventoryPolicySchema + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSManagementPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageBlobLegalHold.md b/azps-10.1.0/Az.Storage/Set-AzStorageBlobLegalHold.md new file mode 100644 index 0000000000..0f625254c3 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageBlobLegalHold.md @@ -0,0 +1,309 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstoragebloblegalhold +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageBlobLegalHold.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageBlobLegalHold.md +--- + +# Set-AzStorageBlobLegalHold + +## SYNOPSIS +Enables or disables legal hold on a Storage blob. + +## SYNTAX + +### NamePipelineEnable (Default) +``` +Set-AzStorageBlobLegalHold [-Blob] <String> [-Container] <String> [-EnableLegalHold] [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BlobPipelineEnable +``` +Set-AzStorageBlobLegalHold -BlobBaseClient <BlobBaseClient> [-EnableLegalHold] [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BlobPipelineDisable +``` +Set-AzStorageBlobLegalHold -BlobBaseClient <BlobBaseClient> [-DisableLegalHold] [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### NamePipelineDisable +``` +Set-AzStorageBlobLegalHold [-Blob] <String> [-Container] <String> [-DisableLegalHold] [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageBlobLegalHold** cmdlet enables or disables legal hold on a Storage blob. +The cmdlet only works when the blob container has already enabled immutable Storage with versioning. + +## EXAMPLES + +### Example 1: Enable legal hold on a Storage blob. +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $blob = Set-AzStorageBlobLegalHold -Container $containerName -Blob $blobname -EnableLegalHold + +PS C:\> $blob + + AccountName: mystorageaccount, ContainerName: mycontainer + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +testblob BlockBlob 10485760 application/octet-stream 2021-07-19 08:56:00Z Hot False 2021-07-19T08:56:01.8120788Z * + +PS C:\> $blob.BlobProperties.HasLegalHold +True +``` + +This command enables legal hold on a Storage blob, then show the result. +The command only works when the blob container has already enabled immutable Storage with versioning. + +### Example 2: Disable legal hold on a Storage blob with pipeline. +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $blob = Get-AzStorageBlob -Container $containerName -Blob $blobname | Set-AzStorageBlobLegalHold -DisableLegalHold + +PS C:\> $blob + + AccountName: mystorageaccount, ContainerName: mycontainer + +Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted VersionId +---- -------- ------ ----------- ------------ ---------- ------------ --------- --------- +testblob BlockBlob 10485760 application/octet-stream 2021-07-19 08:56:00Z Hot False 2021-07-19T08:56:01.8120788Z * + +PS C:\> $blob.BlobProperties.HasLegalHold +False +``` + +This command disables legal hold on a Storage blob with pipeline, then show the result. +The command only works when the blob container has already enabled immutable Storage with versioning. + +## PARAMETERS + +### -Blob +Blob name + +```yaml +Type: System.String +Parameter Sets: NamePipelineEnable, NamePipelineDisable +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobBaseClient +BlobBaseClient Object + +```yaml +Type: Azure.Storage.Blobs.Specialized.BlobBaseClient +Parameter Sets: BlobPipelineEnable, BlobPipelineDisable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +The client side maximum execution time for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +The total amount of concurrent async tasks. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Container name + +```yaml +Type: System.String +Parameter Sets: NamePipelineEnable, NamePipelineDisable +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableLegalHold +Disable LegalHold on the Blob. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: BlobPipelineDisable, NamePipelineDisable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableLegalHold +Enable LegalHold on the Blob. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NamePipelineEnable, BlobPipelineEnable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +The server time out for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagCondition +Optional Tag expression statement to check match condition. The blob request will fail when the blob tags does not match the given expression.See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Azure.Storage.Blobs.Specialized.BlobBaseClient + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageBlobTag.md b/azps-10.1.0/Az.Storage/Set-AzStorageBlobTag.md new file mode 100644 index 0000000000..bcd973c19e --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageBlobTag.md @@ -0,0 +1,293 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstorageblobtag +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageBlobTag.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageBlobTag.md +--- + +# Set-AzStorageBlobTag + +## SYNOPSIS +Set blob tags of a specific blob. + +## SYNTAX + +### NamePipeline (Default) +``` +Set-AzStorageBlobTag [-Blob] <String> [-Container] <String> -Tag <Hashtable> [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BlobPipeline +``` +Set-AzStorageBlobTag -BlobBaseClient <BlobBaseClient> -Tag <Hashtable> [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ContainerPipeline +``` +Set-AzStorageBlobTag -CloudBlobContainer <CloudBlobContainer> [-Blob] <String> -Tag <Hashtable> + [-TagCondition <String>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageBlobTag** sets blob tags of a specific blob. + +## EXAMPLES + +### Example 1: Set blob tags on a specific blob +```powershell +Set-AzStorageBlobTag -Container "containername" -Blob testblob -Tag @{"tag1" = "value1"; "tag2" = "value2" } +``` + +```output +Name Value +---- ----- +tag2 value2 +tag1 value1 +``` + +This command sets blob tags on a specific blob. + +### Example 2: Set blob tags on a specific blob with tag condition +```powershell +Set-AzStorageBlobTag -Container "containername" -Blob testblob -Tag @{"tag1" = "value1"; "tag2" = "value2" } -TagCondition """tag1""='value1'" +``` + +```output +Name Value +---- ----- +tag2 value2 +tag1 value1 +``` + +This command sets blob tags on a specific blob with tag condition. +The cmdlet will only success when the blob contains a tag with name "tag1" and value "value1", else the cmdlet will fail with error code 412. + +## PARAMETERS + +### -Blob +Blob name + +```yaml +Type: System.String +Parameter Sets: NamePipeline, ContainerPipeline +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobBaseClient +BlobBaseClient Object + +```yaml +Type: Azure.Storage.Blobs.Specialized.BlobBaseClient +Parameter Sets: BlobPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +The client side maximum execution time for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudBlobContainer +CloudBlobContainer Object + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlobContainer +Parameter Sets: ContainerPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +The total amount of concurrent async tasks. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Container name + +```yaml +Type: System.String +Parameter Sets: NamePipeline +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +The server time out for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Blob tags which will set to the blob. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagCondition +Optional Tag expression statement to check match condition. +The blob request will fail when the blob tags does not match the given expression. +See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Azure.Storage.Blobs.Specialized.BlobBaseClient + +### Microsoft.Azure.Storage.Blob.CloudBlobContainer + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageCORSRule.md b/azps-10.1.0/Az.Storage/Set-AzStorageCORSRule.md new file mode 100644 index 0000000000..f09941ca7e --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageCORSRule.md @@ -0,0 +1,225 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 288B7B56-B934-45AF-BF56-4EB0DD827522 +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstoragecorsrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageCORSRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageCORSRule.md +--- + +# Set-AzStorageCORSRule + +## SYNOPSIS +Sets the CORS rules for a type of Storage service. + +## SYNTAX + +``` +Set-AzStorageCORSRule [-ServiceType] <StorageServiceType> -CorsRules <PSCorsRule[]> [-PassThru] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageCORSRule** cmdlet sets the Cross-Origin Resource Sharing (CORS) rules for a type of Azure Storage service. +The types of storage services for this cmdlet are Blob, Table, Queue, and File. +This cmdlet overwrites the existing rules. +To see the current rules, use the Get-AzStorageCORSRule cmdlet. + +## EXAMPLES + +### Example 1: Assign CORS rules to the blob service +```powershell +$CorsRules = (@{ + AllowedHeaders=@("x-ms-blob-content-type","x-ms-blob-content-disposition"); + AllowedOrigins=@("*"); + MaxAgeInSeconds=30; + AllowedMethods=@("Get","Connect")}, + @{ + AllowedOrigins=@("http://www.fabrikam.com","http://www.contoso.com"); + ExposedHeaders=@("x-ms-meta-data*","x-ms-meta-customheader"); + AllowedHeaders=@("x-ms-meta-target*","x-ms-meta-customheader"); + MaxAgeInSeconds=30; + AllowedMethods=@("Put")}) + +Set-AzStorageCORSRule -ServiceType Blob -CorsRules $CorsRules +``` + +The first command assigns an array of rules to the $CorsRules variable. +This command uses standard extends over several lines in this code block. +The second command assigns the rules in $CorsRules to the Blob service type. + +### Example 2: Change properties of a CORS rule for blob service +```powershell +$CorsRules = Get-AzStorageCORSRule -ServiceType Blob +$CorsRules[0].AllowedHeaders = @("x-ms-blob-content-type", "x-ms-blob-content-disposition") +$CorsRules[0].AllowedMethods = @("Get", "Connect", "Merge") +Set-AzStorageCORSRule -ServiceType Blob -CorsRules $CorsRules +``` + +The first command gets the current CORS rules for the Blob type by using the **Get-AzStorageCORSRule** cmdlet. +The command stores the rules in the $CorsRules array variable. +The second and third commands modify the first rule in $CorsRules. +The final command assigns the rules in $CorsRules to the Blob service type. +The revised rules overwrite the current CORS rules. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure Storage context. +To obtain a context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -CorsRules +Specifies an array of CORS rules. +You can retrieve the existing rules using the Get-AzStorageCORSRule cmdlet. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSCorsRule[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns a Boolean that reflects the success of the operation. +By default, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceType +Specifies the Azure Storage service type for which this cmdlet assigns rules. +The acceptable values for this parameter are: +- Blob +- Table +- Queue +- File + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType +Parameter Sets: (All) +Aliases: +Accepted values: Blob, Table, Queue, File + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSCorsRule + +## NOTES + +## RELATED LINKS + +[Get-AzStorageCORSRule](./Get-AzStorageCORSRule.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[Remove-AzStorageCORSRule](./Remove-AzStorageCORSRule.md) + + diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageContainerAcl.md b/azps-10.1.0/Az.Storage/Set-AzStorageContainerAcl.md new file mode 100644 index 0000000000..7dc985e028 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageContainerAcl.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: BDEEF1EA-A785-4E17-9887-C2000BDFCF57 +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstoragecontaineracl +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageContainerAcl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageContainerAcl.md +--- + +# Set-AzStorageContainerAcl + +## SYNOPSIS +Sets the public access permission to a storage container. + +## SYNTAX + +``` +Set-AzStorageContainerAcl [-Name] <String> [-Permission] <BlobContainerPublicAccessType> [-PassThru] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageContainerAcl** cmdlet sets the public access permission to the specified storage container in Azure. + +## EXAMPLES + +### Example 1: Set azure storage container ACL by name +```powershell +Set-AzStorageContainerAcl -Container "Container01" -Permission Off -PassThru +``` + +This command creates a container that has no public access. + +### Example 2: Set azure storage container ACL by using the pipeline +```powershell +Get-AzStorageContainer container* | Set-AzStorageContainerAcl -Permission Blob -PassThru +``` + +This command gets all storage containers whose name starts with container and then passes the result on the pipeline to set the permission for them all to Blob access. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies the Azure storage context. +You can create it by using the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Container + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +Specifies the level of public access to this container. +By default, the container and any blobs in it can be accessed only by the owner of the storage account. +To grant anonymous users read permissions to a container and its blobs, you can set the container permissions to enable public access. +Anonymous users can read blobs in a publicly available container without authenticating the request. +The acceptable values for this parameter are: +--Container. +Provides full read access to a container and its blobs. +Clients can enumerate blobs in the container through anonymous request, but cannot enumerate containers in the storage account. +--Blob. +Provides read access to blob data in a container through anonymous request, but does not provide access to container data. +Clients cannot enumerate blobs in the container by using anonymous request. +--Off. +Restricts access to only the storage account owner. + +```yaml +Type: Microsoft.Azure.Storage.Blob.BlobContainerPublicAccessType +Parameter Sets: (All) +Aliases: PublicAccess +Accepted values: Off, Container, Blob, Unknown + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the service side time-out interval, in seconds, for a request. +If the specified interval elapses before the service processes the request, the storage service returns an error. +Server side time out for each request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageContainer + +## NOTES + +## RELATED LINKS + +[Get-AzStorageContainer](./Get-AzStorageContainer.md) + +[New-AzStorageContainer](./New-AzStorageContainer.md) + +[Remove-AzStorageContainer](./Remove-AzStorageContainer.md) + + diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageContainerStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/Set-AzStorageContainerStoredAccessPolicy.md new file mode 100644 index 0000000000..a21d3e640d --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageContainerStoredAccessPolicy.md @@ -0,0 +1,283 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 730ECC60-72DE-46DA-A177-D5749F540710 +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstoragecontainerstoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageContainerStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageContainerStoredAccessPolicy.md +--- + +# Set-AzStorageContainerStoredAccessPolicy + +## SYNOPSIS +Sets a stored access policy for an Azure storage container. + +## SYNTAX + +``` +Set-AzStorageContainerStoredAccessPolicy [-Container] <String> [-Policy] <String> [-Permission <String>] + [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-NoStartTime] [-NoExpiryTime] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageContainerStoredAccessPolicy** cmdlet sets a stored access policy for an Azure storage container. + +## EXAMPLES + +### Example 1: Set a stored access policy in a storage container with full permission +```powershell +Set-AzStorageContainerStoredAccessPolicy -Container "MyContainer" -Policy "Policy06" -Permission rwdl +``` + +This command sets an access policy named Policy06 for storage container named MyContainer. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Specifies the Azure storage container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the time at which the stored access policy becomes invalid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoExpiryTime +Indicates that the access policy has no expiration date. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoStartTime +Sets the start time to be $Null. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +Specifies permissions in the stored access policy to access the storage container. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the name for the stored access policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies the time at which the stored access policy becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzStorageContainerStoredAccessPolicy](./Get-AzStorageContainerStoredAccessPolicy.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[New-AzStorageContainerStoredAccessPolicy](./New-AzStorageContainerStoredAccessPolicy.md) + +[Remove-AzStorageContainerStoredAccessPolicy](./Remove-AzStorageContainerStoredAccessPolicy.md) diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageFileContent.md b/azps-10.1.0/Az.Storage/Set-AzStorageFileContent.md new file mode 100644 index 0000000000..8d69d5500b --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageFileContent.md @@ -0,0 +1,370 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: FA98E64B-D589-4653-9ACC-86573FAF4550 +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstoragefilecontent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageFileContent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageFileContent.md +--- + +# Set-AzStorageFileContent + +## SYNOPSIS +Uploads the contents of a file. + +## SYNTAX + +### ShareName (Default) +``` +Set-AzStorageFileContent [-ShareName] <String> [-Source] <String> [[-Path] <String>] [-PassThru] [-Force] + [-AsJob] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [-PreserveSMBAttribute] [<CommonParameters>] +``` + +### Share +``` +Set-AzStorageFileContent [-Share] <CloudFileShare> [-Source] <String> [[-Path] <String>] [-PassThru] [-Force] + [-AsJob] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [-PreserveSMBAttribute] [<CommonParameters>] +``` + +### Directory +``` +Set-AzStorageFileContent [-Directory] <CloudFileDirectory> [-Source] <String> [[-Path] <String>] [-PassThru] + [-Force] [-AsJob] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [-PreserveSMBAttribute] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageFileContent** cmdlet uploads the contents of a file to a file on a specified share. + +## EXAMPLES + +### Example 1: Upload a file in the current folder +```powershell +Set-AzStorageFileContent -ShareName "ContosoShare06" -Source "DataFile37" -Path "ContosoWorkingFolder/CurrentDataFile" +``` + +This command uploads a file that is named DataFile37 in the current folder as a file that is named CurrentDataFile in the folder named ContosoWorkingFolder. + +### Example 2: Upload all the files in the current folder +```powershell +$CurrentFolder = (Get-Item .).FullName +$Container = Get-AzStorageShare -Name "ContosoShare06" +Get-ChildItem -Recurse | Where-Object { $_.GetType().Name -eq "FileInfo"} | ForEach-Object { + $path=$_.FullName.Substring($Currentfolder.Length+1).Replace("\","/") + Set-AzStorageFileContent -Share $Container -Source $_.FullName -Path $path -Force +} +``` + +This example uses several common Windows PowerShell cmdlets and the current cmdlet to upload all files from the current folder to the root folder of container ContosoShare06. +The first command gets the name of the current folder and stores it in the $CurrentFolder variable. +The second command uses the **Get-AzStorageShare** cmdlet to get the file share named ContosoShare06, and then stores it in the $Container variable. +The final command gets the contents of the current folder and passes each one to the Where-Object cmdlet by using the pipeline operator. +That cmdlet filters out objects that are not files, and then passes the files to the ForEach-Object cmdlet. +That cmdlet runs a script block for each file that creates the appropriate path for it and then uses the current cmdlet to upload the file. +The result has the same name and same relative position with regard to the other files that this example uploads. +For more information about script blocks, type `Get-Help about_Script_Blocks`. + +### Example 3: Upload a local file to an Azure file, and perserve the local File SMB properties (File Attributtes, File Creation Time, File Last Write Time) in the Azure file. +```powershell +Set-AzStorageFileContent -Source $localFilePath -ShareName sample -Path "dir1/file1" -PreserveSMBAttribute +``` + +This example uploads a local file to an Azure file, and perserves the local File SMB properties (File Attributtes, File Creation Time, File Last Write Time) in the Azure file. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: ShareName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Directory +Specifies a folder as a **CloudFileDirectory** object. +This cmdlet uploads the file to the folder that this parameter specifies. +To obtain a directory, use the New-AzStorageDirectory cmdlet. +You can also use the Get-AzStorageFile cmdlet to obtain a directory. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileDirectory +Parameter Sets: Directory +Aliases: CloudFileDirectory + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet overwrites an existing Azure storage file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns the **AzureStorageFile** object that it creates or uploads. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies the path of a file or folder. +This cmdlet uploads contents to the file that this parameter specifies, or to a file in the folder that this parameter specifies. +If you specify a folder, this cmdlet creates a file that has the same name as the source file. +If you specify a path of a file that does not exist, this cmdlet creates that file and saves the contents to that file. +If you specify a file that already exists, and you specify the _Force_ parameter, this cmdlet overwrites the contents of the file. +If you specify a file that already exists and you do not specify _Force_, this cmdlet makes no change, and returns an error. +If you specify a path of a folder that does not exist, this cmdlet makes no change, and returns an error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreserveSMBAttribute +Keep the source File SMB properties (File Attributtes, File Creation Time, File Last Write Time) in destination File. This parameter is only available on Windows. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Share +Specifies a **CloudFileShare** object. +This cmdlet uploads to a file in the file share this parameter specifies. +To obtain a **CloudFileShare** object, use the Get-AzStorageShare cmdlet. +This object contains the storage context. +If you specify this parameter, do not specify the *Context* parameter. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileShare +Parameter Sets: Share +Aliases: CloudFileShare + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareName +Specifies the name of the file share. +This cmdlet uploads to a file in the file share this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Specifies the source file that this cmdlet uploads. +If you specify a file that does not exist, this cmdlet returns an error. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FullName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Storage.File.CloudFileShare + +### Microsoft.Azure.Storage.File.CloudFileDirectory + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFile + +## NOTES + +## RELATED LINKS + +[Remove-AzStorageDirectory](./Remove-AzStorageDirectory.md) + +[New-AzStorageDirectory](./New-AzStorageDirectory.md) + +[Get-AzStorageFileContent](./Get-AzStorageFileContent.md) diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageLocalUser.md b/azps-10.1.0/Az.Storage/Set-AzStorageLocalUser.md new file mode 100644 index 0000000000..3e637b88d7 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageLocalUser.md @@ -0,0 +1,324 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstoragelocaluser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageLocalUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageLocalUser.md +--- + +# Set-AzStorageLocalUser + +## SYNOPSIS +Creates or updates a specified local user in a storage account. + +## SYNTAX + +### AccountName (Default) +``` +Set-AzStorageLocalUser [-ResourceGroupName] <String> [-StorageAccountName] <String> -UserName <String> + [-HomeDirectory <String>] [-SshAuthorizedKey <PSSshPublicKey[]>] [-PermissionScope <PSPermissionScope[]>] + [-HasSharedKey <Boolean>] [-HasSshKey <Boolean>] [-HasSshPassword <Boolean>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Set-AzStorageLocalUser -StorageAccount <PSStorageAccount> -UserName <String> [-HomeDirectory <String>] + [-SshAuthorizedKey <PSSshPublicKey[]>] [-PermissionScope <PSPermissionScope[]>] [-HasSharedKey <Boolean>] + [-HasSshKey <Boolean>] [-HasSshPassword <Boolean>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageLocalUser** cmdlet creates or updates a specified local user in a storage account. +To run this cmdlet, the storage account must has already set EnableLocalUser as true. + +## EXAMPLES + +### Example 1: Create or update a local user +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\> $sshkey1 = New-AzStorageLocalUserSshPublicKey -Key "ssh-rsa keykeykeykeykey=" -Description "sshpulickey name1" + +PS C:\> $permissionScope1 = New-AzStorageLocalUserPermissionScope -Permission rw -Service blob -ResourceName container1 + +PS C:\> $localuser = Set-AzStorageLocalUser -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -UserName testuser1 -HomeDirectory "/" -SshAuthorizedKey $sshkey1 -PermissionScope $permissionScope1 -HasSharedKey $true -HasSshKey $true -HasSshPassword $true + +PS C:\> $localuser + + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name Sid HomeDirectory HasSharedKey HasSshKey HasSshPassword PermissionScopes +---- --- ------------- ------------ --------- -------------- ---------------- +testuser1 S-1-2-0-0000000000-000000000-0000000000-0000 / True True True [container1] + +PS C:\> $localuser.SshAuthorizedKeys + +Description Key +----------- --- +sshpulickey name1 ssh-rsa keykeykeykeykey= + +PS C:\> $localuser.PermissionScopes + +Permissions Service ResourceName +----------- ------- ------------ +rw blob container1 +``` + +The first 2 commands create 2 local objects that will be used in create or update local user. +The third command creates or updates the local user. +The following commands show the local user properties. + +### Example 2: Create or update a local user by input permission scope and ssh key with json +```powershell +Set-AzStorageLocalUser -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -UserName testuser1 -HomeDirectory "/" -HasSharedKey $true -HasSshKey $true -HasSshPassword $true ` + -SshAuthorizedKey (@{ + Description="sshpulickey name1"; + Key="ssh-rsa keykeykeykeykey="; + }, + @{ + Description="sshpulickey name2"; + Key="ssh-rsa keykeykeykeykew="; + }) ` + -PermissionScope (@{ + Permissions="rw"; + Service="blob"; + ResourceName="container1"; + }, + @{ + Permissions="rwd"; + Service="share"; + ResourceName="share1"; + }) +``` + +```output +ResourceGroupName: weitry, StorageAccountName: weisftp3 + +Name Sid HomeDirectory HasSharedKey HasSshKey HasSshPassword PermissionScopes +---- --- ------------- ------------ --------- -------------- ---------------- +testuser1 S-1-2-0-0000000000-000000000-0000000000-0000 / True True True [container1,...] +``` + +This command creates or updates a local user by input permission scope and ssh key with json. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasSharedKey +Whether shared key exists. +Set it to false to remove existing shared key. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasSshKey +Whether SSH key exists. +Set it to false to remove existing SSH key. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasSshPassword +Whether SSH password exists. +Set it to false to remove existing SSH password. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HomeDirectory +Local user home directory + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionScope +The permission scopes of the local user. Get the object with New-AzStorageLocalUserPermissionScope cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSPermissionScope[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshAuthorizedKey +Local user ssh authorized keys for SFTP. Get the object with New-AzStorageLocalUserSshPublicKey cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSSshPublicKey[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserName +The name of local user. +The username must contain lowercase letters and numbers only. +It must be unique only within the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSLocalUser + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageObjectReplicationPolicy.md b/azps-10.1.0/Az.Storage/Set-AzStorageObjectReplicationPolicy.md new file mode 100644 index 0000000000..8be07d7416 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageObjectReplicationPolicy.md @@ -0,0 +1,257 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstorageobjectreplicationpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageObjectReplicationPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageObjectReplicationPolicy.md +--- + +# Set-AzStorageObjectReplicationPolicy + +## SYNOPSIS +Creates or updates the specified object replication policy in a Storage account. + +## SYNTAX + +### AccountName (Default) +``` +Set-AzStorageObjectReplicationPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-PolicyId <String>] -SourceAccount <String> [-DestinationAccount <String>] + -Rule <PSObjectReplicationPolicyRule[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### PolicyObject +``` +Set-AzStorageObjectReplicationPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> + -InputObject <PSObjectReplicationPolicy> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountObject +``` +Set-AzStorageObjectReplicationPolicy -StorageAccount <PSStorageAccount> [-PolicyId <String>] + -SourceAccount <String> [-DestinationAccount <String>] -Rule <PSObjectReplicationPolicyRule[]> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageObjectReplicationPolicy** cmdlet creates or updates the specified object replication policy in a Storage account. + +## EXAMPLES + +### Example 1: Set object replication policy to both destination and source account. +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $rule1 = New-AzStorageObjectReplicationPolicyRule -SourceContainer src1 -DestinationContainer dest1 + +PS C:\> $rule2 = New-AzStorageObjectReplicationPolicyRule -SourceContainer src -DestinationContainer dest -MinCreationTime 2019-01-01T16:00:00Z -PrefixMatch a,abc,dd + +PS C:\> $srcAccount = Get-AzStorageAccount -ResourceGroupName "myresourcegroup" -AccountName "mysourceaccount" + +PS C:\> Set-AzStorageObjectReplicationPolicy -ResourceGroupName "myresourcegroup" -AccountName "mydestaccount" -PolicyId default -SourceAccount $srcAccount.Id -Rule $rule1,$rule2 + +ResourceGroupName StorageAccountName PolicyId EnabledTime SourceAccount DestinationAccount Rules +----------------- ------------------ -------- ----------- ------------- ------------------ ----- +myresourcegroup mydestaccount 56bfa11c-81ef-4f8d-b307-5e5386e16fba mysourceaccount mydestaccount [5fa8b1d6-4985-4abd-a0b3-ec4d07295a43,...] + +PS C:\> $destPolicy = Get-AzStorageObjectReplicationPolicy -ResourceGroupName "myresourcegroup" -AccountName "mydestaccount" + +PS C:\> Set-AzStorageObjectReplicationPolicy -ResourceGroupName "myresourcegroup" -AccountName "mysourceaccount" -InputObject $destPolicy + +ResourceGroupName StorageAccountName PolicyId EnabledTime SourceAccount DestinationAccount Rules +----------------- ------------------ -------- ----------- ------------- ------------------ ----- +myresourcegroup mysourceaccount 56bfa11c-81ef-4f8d-b307-5e5386e16fba mysourceaccount mydestaccount [5fa8b1d6-4985-4abd-a0b3-ec4d07295a43,...] +``` + +This command sets object replication policy to both destination and source account. +First create 2 object replication policy rules, and set policy to destination account with the 2 rules and source account resource Id. Then get the object replication policy from destination account and set to source account. +Please note, when storage account has AllowCrossTenantReplication as false, SourceAccount and DestinationAccount should be account resource Id. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationAccount +Object Replication Policy DestinationAccount, if SourceAccount is account name it should be account name, else should be account resource id. Default value will be the input StorageAccountName, or the resouceID of the account. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Object Replication Policy Object to Set to the specified Account. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSObjectReplicationPolicy +Parameter Sets: PolicyObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PolicyId +Object Replication Policy Id. +It should be a GUID or 'default'. +If not input the PolicyId, will use 'default', which means to create a new policy and the Id of the new policy will be returned in the created policy. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName, PolicyObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rule +Object Replication Policy Rules. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSObjectReplicationPolicyRule[] +Parameter Sets: AccountName, AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceAccount +Object Replication Policy SourceAccount. It should be resource id if allowCrossTenantReplication is false.. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName, PolicyObject +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSObjectReplicationPolicy + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSObjectReplicationPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageQueueStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/Set-AzStorageQueueStoredAccessPolicy.md new file mode 100644 index 0000000000..0ef6a4238e --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageQueueStoredAccessPolicy.md @@ -0,0 +1,226 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 4FB7E017-7D37-4EDB-BEC1-36629058B87C +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstoragequeuestoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageQueueStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageQueueStoredAccessPolicy.md +--- + +# Set-AzStorageQueueStoredAccessPolicy + +## SYNOPSIS +Sets a stored access policy for an Azure storage queue. + +## SYNTAX + +``` +Set-AzStorageQueueStoredAccessPolicy [-Queue] <String> [-Policy] <String> [-Permission <String>] + [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-NoStartTime] [-NoExpiryTime] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageQueueStoredAccessPolicy** cmdlet sets a stored access policy for an Azure storage queue. + +## EXAMPLES + +### Example 1: Set a stored access policy in the queue with full permission +```powershell +Set-AzStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy07" -Permission arup +``` + +This command sets an access policy named Policy07 for storage queue named MyQueue. + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the time at which the stored access policy becomes invalid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoExpiryTime +Indicates that the access policy has no expiration date. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoStartTime +Indicates that this cmdlet sets the start time to be $Null. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +Specifies permissions in the stored access policy to access the storage queue. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the name for the stored access policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Queue +Specifies the Azure storage queue name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StartTime +Specifies the time at which the stored access policy becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzStorageQueueStoredAccessPolicy](./Get-AzStorageQueueStoredAccessPolicy.md) + +[New-AzStorageQueueStoredAccessPolicy](./New-AzStorageQueueStoredAccessPolicy.md) + +[Remove-AzStorageQueueStoredAccessPolicy](./Remove-AzStorageQueueStoredAccessPolicy.md) diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageServiceLoggingProperty.md b/azps-10.1.0/Az.Storage/Set-AzStorageServiceLoggingProperty.md new file mode 100644 index 0000000000..7106756743 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageServiceLoggingProperty.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 5422429E-C609-4C1F-A021-E2A085B5F74E +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstorageserviceloggingproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageServiceLoggingProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageServiceLoggingProperty.md +--- + +# Set-AzStorageServiceLoggingProperty + +## SYNOPSIS +Modifies logging for Azure Storage services. + +## SYNTAX + +``` +Set-AzStorageServiceLoggingProperty [-ServiceType] <StorageServiceType> [-Version <Double>] + [-RetentionDays <Int32>] [-LoggingOperations <LoggingOperations[]>] [-PassThru] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageServiceLoggingProperty** cmdlet modifies logging for Azure Storage services. + +## EXAMPLES + +### Example 1: Modify logging properties for the Blob service +```powershell +Set-AzStorageServiceLoggingProperty -ServiceType Blob -LoggingOperations Read,Write -PassThru -RetentionDays 10 -Version 1.0 +``` + +This command modifies version 1.0 logging for blob storage to include read and write operations. +Azure Storage service logging retains entries for 10 days. +Because this command specifies the *PassThru* parameter, the command displays the modified logging properties. + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoggingOperations +Specifies an array of Azure Storage service operations. +Azure Storage services logs the operations that this parameter specifies. +The acceptable values for this parameter are: +- None +- Read +- Write +- Delete +- All + +```yaml +Type: Microsoft.Azure.Storage.Shared.Protocol.LoggingOperations[] +Parameter Sets: (All) +Aliases: +Accepted values: None, Read, Write, Delete, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlet returns the updated logging properties. +If you do not specify this parameter, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDays +Specifies the number of days that the Azure Storage service retains logged information. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceType +Specifies the storage service type. +This cmdlet modifies the logging properties for the service type that this parameter specifies. +The acceptable values for this parameter are: +- Blob +- Table +- Queue +- File +The value of File is not currently supported. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType +Parameter Sets: (All) +Aliases: +Accepted values: Blob, Table, Queue, File + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Specifies the version of the Azure Storage service logging. +The default value is 1.0. + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.Azure.Storage.Shared.Protocol.LoggingProperties + +## NOTES + +## RELATED LINKS + +[Get-AzStorageServiceLoggingProperty](./Get-AzStorageServiceLoggingProperty.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + + diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageServiceMetricsProperty.md b/azps-10.1.0/Az.Storage/Set-AzStorageServiceMetricsProperty.md new file mode 100644 index 0000000000..5ef8fe849d --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageServiceMetricsProperty.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 5878FAD4-A4BB-4DBF-A1F2-221FD34F0308 +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstorageservicemetricsproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageServiceMetricsProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageServiceMetricsProperty.md +--- + +# Set-AzStorageServiceMetricsProperty + +## SYNOPSIS +Modifies metrics properties for the Azure Storage service. + +## SYNTAX + +``` +Set-AzStorageServiceMetricsProperty [-ServiceType] <StorageServiceType> [-MetricsType] <ServiceMetricsType> + [-Version <Double>] [-RetentionDays <Int32>] [-MetricsLevel <MetricsLevel>] [-PassThru] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageServiceMetricsProperty** cmdlet modifies metrics properties for the Azure Storage service. + +## EXAMPLES + +### Example 1: Modify metrics properties for the Blob service +```powershell +Set-AzStorageServiceMetricsProperty -ServiceType Blob -MetricsType Hour -MetricsLevel Service -PassThru -RetentionDays 10 -Version 1.0 +``` + +This command modifies version 1.0 metrics for blob storage to a level of Service. +Azure Storage service metrics retains entries for 10 days. +Because this command specifies the *PassThru* parameter, the command displays the modified metrics properties. + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricsLevel +Specifies the metrics level that Azure Storage uses for the service. +The acceptable values for this parameter are: +- None +- Service +- ServiceAndApi + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Storage.Shared.Protocol.MetricsLevel] +Parameter Sets: (All) +Aliases: +Accepted values: None, Service, ServiceAndApi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetricsType +Specifies a metrics type. +This cmdlet sets the Azure Storage service metrics type to the value that this parameter specifies. +The acceptable values for this parameter are: Hour and Minute. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Common.ServiceMetricsType +Parameter Sets: (All) +Aliases: +Accepted values: Hour, Minute + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Indicates that this cmdlets returns the updated metrics properties. +If you do not specify this parameter, this cmdlet does not return a value. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDays +Specifies the number of days that the Azure Storage service retains metrics information. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceType +Specifies the storage service type. +This cmdlet modifies the metrics properties for the service type that this parameter specifies. +The acceptable values for this parameter are: +- Blob +- Table +- Queue +- File +The value of File is not currently supported. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType +Parameter Sets: (All) +Aliases: +Accepted values: Blob, Table, Queue, File + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Specifies the version of the Azure Storage metrics. +The default value is 1.0. + +```yaml +Type: System.Nullable`1[System.Double] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.Azure.Storage.Shared.Protocol.MetricsProperties + +## NOTES + +## RELATED LINKS + +[Get-AzStorageServiceMetricsProperty](./Get-AzStorageServiceMetricsProperty.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + + diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageShareQuota.md b/azps-10.1.0/Az.Storage/Set-AzStorageShareQuota.md new file mode 100644 index 0000000000..47cfac12b5 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageShareQuota.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 176294FA-BB08-4A63-AD45-1E6C6D67A5D8 +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstoragesharequota +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageShareQuota.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageShareQuota.md +--- + +# Set-AzStorageShareQuota + +## SYNOPSIS +Sets the storage capacity for a share. + +## SYNTAX + +### ShareName (Default) +``` +Set-AzStorageShareQuota [-ShareName] <String> [-Quota] <Int32> [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +### Share +``` +Set-AzStorageShareQuota [-Share] <CloudFileShare> [-Quota] <Int32> [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageShareQuota** cmdlet sets the storage capacity for a specified share. + +## EXAMPLES + +### Example 1: Set the storage capacity of a share +```powershell +Set-AzStorageShareQuota -ShareName "ContosoShare01" -Quota 1024 +``` + +This command sets the storage capacity for a share named ContosoShare01 to 1024 GB. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quota +Specifies the quota value in gigabytes (GB). +See the quota limitation in https://learn.microsoft.com/azure/azure-subscription-service-limits#azure-files-limits. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: QuotaGiB + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Share +Specifies a **CloudFileShare** object to represent the share for which this cmdlets sets a quota. +To obtain a **CloudFileShare** object, use the Get-AzStorageShare cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileShare +Parameter Sets: Share +Aliases: CloudFileShare + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShareName +Specifies the name of the file share for which to set a quota. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Storage.File.CloudFileShare + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFileShare + +## NOTES + +## RELATED LINKS + +[Get-AzStorageFileContent](./Get-AzStorageFileContent.md) + +[Get-AzStorageShare](./Get-AzStorageShare.md) + +[New-AzStorageContext](./New-AzStorageContext.md) diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageShareStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/Set-AzStorageShareStoredAccessPolicy.md new file mode 100644 index 0000000000..fbfef29201 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageShareStoredAccessPolicy.md @@ -0,0 +1,281 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: C21CC2FA-017E-492E-96E7-B37829917FAF +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstoragesharestoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageShareStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageShareStoredAccessPolicy.md +--- + +# Set-AzStorageShareStoredAccessPolicy + +## SYNOPSIS +Updates a stored access policy on a Storage share. + +## SYNTAX + +``` +Set-AzStorageShareStoredAccessPolicy [-ShareName] <String> [-Policy] <String> [-Permission <String>] + [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-NoStartTime] [-NoExpiryTime] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageShareStoredAccessPolicy** cmdlet updates stored access policy on an Azure Storage share. + +## EXAMPLES + +### Example 1: Update a stored access policy in Storage share +```powershell +Set-AzStorageShareStoredAccessPolicy -ShareName "ContosoShare" -Policy "GeneralPolicy" -Permission "rwdl" +``` + +This command updates a stored access policy that has full permission in a share. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the time at which the stored access policy becomes invalid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoExpiryTime +Indicates that this cmdlet clears the **ExpiryTime** property in the stored access policy. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoStartTime +Indicates that this cmdlet clears the **StartTime** property in the stored access policy. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +Specifies permissions in the stored access policy to access the share or files under it. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies a name for the stored access policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +Specifies the name of the Storage share. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StartTime +Specifies the time at which the stored access policy becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzStorageShareStoredAccessPolicy](./Get-AzStorageShareStoredAccessPolicy.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[New-AzStorageShareStoredAccessPolicy](./New-AzStorageShareStoredAccessPolicy.md) + +[Remove-AzStorageShareStoredAccessPolicy](./Remove-AzStorageShareStoredAccessPolicy.md) diff --git a/azps-10.1.0/Az.Storage/Set-AzStorageTableStoredAccessPolicy.md b/azps-10.1.0/Az.Storage/Set-AzStorageTableStoredAccessPolicy.md new file mode 100644 index 0000000000..32a2ab9f0e --- /dev/null +++ b/azps-10.1.0/Az.Storage/Set-AzStorageTableStoredAccessPolicy.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: FF2BFE34-4A12-49F9-9BE5-4084A36BC272 +online version: https://learn.microsoft.com/powershell/module/az.storage/set-azstoragetablestoredaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageTableStoredAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Set-AzStorageTableStoredAccessPolicy.md +--- + +# Set-AzStorageTableStoredAccessPolicy + +## SYNOPSIS +Sets the stored access policy for an Azure storage table. + +## SYNTAX + +``` +Set-AzStorageTableStoredAccessPolicy [-Table] <String> [-Policy] <String> [-Permission <String>] + [-StartTime <DateTime>] [-ExpiryTime <DateTime>] [-NoStartTime] [-NoExpiryTime] [-Context <IStorageContext>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzStorageTableStoredAccessPolicy** cmdlet set the stored access policy for an Azure storage table. + +## EXAMPLES + +### Example 1: Set a stored access policy in table with full permission +```powershell +Set-AzStorageTableStoredAccessPolicy -Table "MyTable" -Policy "Policy08" -Permission raud +``` + +This command sets an access policy named Policy08 for storage table named MyTable. + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Specifies the time at which the stored access policy expires. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoExpiryTime +Indicates that the access policy has no expiration date. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoStartTime +Indicates that the start time is set to $Null. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Permission +Specifies permissions in the stored access policy to access the storage table. +It is important to note that this is a string, like `rwd` (for Read, Write and Delete). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +Specifies the name for the stored access policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Specifies the time at which the stored access policy becomes valid. + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Table +Specifies the Azure storage table name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: N, Name + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzStorageTableStoredAccessPolicy](./Get-AzStorageTableStoredAccessPolicy.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[New-AzStorageTableStoredAccessPolicy](./New-AzStorageTableStoredAccessPolicy.md) + +[Remove-AzStorageTableStoredAccessPolicy](./Remove-AzStorageTableStoredAccessPolicy.md) diff --git a/azps-10.1.0/Az.Storage/Start-AzStorageBlobCopy.md b/azps-10.1.0/Az.Storage/Start-AzStorageBlobCopy.md new file mode 100644 index 0000000000..9d42c2c6a4 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Start-AzStorageBlobCopy.md @@ -0,0 +1,715 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 54585346-04E2-4FB4-B5FD-833A85C46ACB +online version: https://learn.microsoft.com/powershell/module/az.storage/start-azstorageblobcopy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Start-AzStorageBlobCopy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Start-AzStorageBlobCopy.md +--- + +# Start-AzStorageBlobCopy + +## SYNOPSIS +Starts to copy a blob. + +## SYNTAX + +### ContainerName (Default) +``` +Start-AzStorageBlobCopy [-SrcBlob] <String> -SrcContainer <String> -DestContainer <String> [-DestBlob <String>] + [-PremiumPageBlobTier <PremiumPageBlobTier>] [-StandardBlobTier <String>] + [-RehydratePriority <RehydratePriority>] [-Tag <Hashtable>] [-Context <IStorageContext>] + [-DestContext <IStorageContext>] [-DestTagCondition <String>] [-TagCondition <String>] [-Force] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BlobInstance +``` +Start-AzStorageBlobCopy -CloudBlob <CloudBlob> [-BlobBaseClient <BlobBaseClient>] -DestContainer <String> + [-DestBlob <String>] [-PremiumPageBlobTier <PremiumPageBlobTier>] [-StandardBlobTier <String>] + [-RehydratePriority <RehydratePriority>] [-Tag <Hashtable>] [-Context <IStorageContext>] + [-DestContext <IStorageContext>] [-DestTagCondition <String>] [-TagCondition <String>] [-Force] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BlobInstanceToBlobInstance +``` +Start-AzStorageBlobCopy -CloudBlob <CloudBlob> [-BlobBaseClient <BlobBaseClient>] -DestCloudBlob <CloudBlob> + [-PremiumPageBlobTier <PremiumPageBlobTier>] [-StandardBlobTier <String>] + [-RehydratePriority <RehydratePriority>] [-Tag <Hashtable>] [-Context <IStorageContext>] + [-DestContext <IStorageContext>] [-DestTagCondition <String>] [-TagCondition <String>] [-Force] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ContainerInstance +``` +Start-AzStorageBlobCopy -CloudBlobContainer <CloudBlobContainer> [-SrcBlob] <String> -DestContainer <String> + [-DestBlob <String>] [-PremiumPageBlobTier <PremiumPageBlobTier>] [-StandardBlobTier <String>] + [-RehydratePriority <RehydratePriority>] [-Tag <Hashtable>] [-Context <IStorageContext>] + [-DestContext <IStorageContext>] [-DestTagCondition <String>] [-TagCondition <String>] [-Force] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ShareName +``` +Start-AzStorageBlobCopy -SrcShareName <String> -SrcFilePath <String> -DestContainer <String> + [-DestBlob <String>] [-StandardBlobTier <String>] [-RehydratePriority <RehydratePriority>] [-Tag <Hashtable>] + [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-DestTagCondition <String>] [-Force] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ShareInstance +``` +Start-AzStorageBlobCopy -SrcShare <CloudFileShare> -SrcFilePath <String> -DestContainer <String> + [-DestBlob <String>] [-StandardBlobTier <String>] [-RehydratePriority <RehydratePriority>] [-Tag <Hashtable>] + [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-DestTagCondition <String>] [-Force] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DirInstance +``` +Start-AzStorageBlobCopy -SrcDir <CloudFileDirectory> -SrcFilePath <String> -DestContainer <String> + [-DestBlob <String>] [-StandardBlobTier <String>] [-RehydratePriority <RehydratePriority>] [-Tag <Hashtable>] + [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-DestTagCondition <String>] [-Force] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### FileInstance +``` +Start-AzStorageBlobCopy -SrcFile <CloudFile> -DestContainer <String> [-DestBlob <String>] + [-StandardBlobTier <String>] [-RehydratePriority <RehydratePriority>] [-Tag <Hashtable>] + [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-DestTagCondition <String>] [-Force] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### FileInstanceToBlobInstance +``` +Start-AzStorageBlobCopy -SrcFile <CloudFile> -DestCloudBlob <CloudBlob> [-StandardBlobTier <String>] + [-RehydratePriority <RehydratePriority>] [-Tag <Hashtable>] [-Context <IStorageContext>] + [-DestContext <IStorageContext>] [-DestTagCondition <String>] [-Force] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UriPipeline +``` +Start-AzStorageBlobCopy -AbsoluteUri <String> -DestContainer <String> -DestBlob <String> + [-StandardBlobTier <String>] [-RehydratePriority <RehydratePriority>] [-Tag <Hashtable>] + [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-DestTagCondition <String>] + [-TagCondition <String>] [-Force] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzStorageBlobCopy** cmdlet starts to copy a blob. + +## EXAMPLES + +### Example 1: Copy a named blob +```powershell +Start-AzStorageBlobCopy -SrcBlob "ContosoPlanning2015" -DestContainer "ContosoArchives" -SrcContainer "ContosoUploads" +``` + +This command starts the copy operation of the blob named ContosoPlanning2015 from the container named ContosoUploads to the container named ContosoArchives. + +### Example 2: Get a container to specify blobs to copy +```powershell +Get-AzStorageContainer -Name "ContosoUploads" | Start-AzStorageBlobCopy -SrcBlob "ContosoPlanning2015" -DestContainer "ContosoArchives" +``` + +This command gets the container named ContosoUploads, by using the **Get-AzStorageContainer** cmdlet, and then passes the container to the current cmdlet by using the pipeline operator. +That cmdlet starts the copy operation of the blob named ContosoPlanning2015. +The previous cmdlet provides the source container. +The *DestContainer* parameter specifies ContosoArchives as the destination container. + +### Example 3: Get all blobs in a container and copy them +```powershell +Get-AzStorageBlob -Container "ContosoUploads" | Start-AzStorageBlobCopy -DestContainer "ContosoArchives" +``` + +This command gets the blobs in the container named ContosoUploads, by using the **Get-AzStorageBlob** cmdlet, and then passes the results to the current cmdlet by using the pipeline operator. +That cmdlet starts the copy operation of the blobs to the container named ContosoArchives. + +### Example 4: Copy a blob specified as an object +```powershell +$SrcBlob = Get-AzStorageBlob -Container "ContosoUploads" -Blob "ContosoPlanning2015" +$DestBlob = Get-AzStorageBlob -Container "ContosoArchives" -Blob "ContosoPlanning2015Archived" +Start-AzStorageBlobCopy -ICloudBlob $SrcBlob.ICloudBlob -DestICloudBlob $DestBlob.ICloudBlob +``` + +The first command gets the blob named ContosoPlanning2015 in the container named ContosoUploads. +The command stores that object in the $SrcBlob variable. +The second command gets the blob named ContosoPlanning2015Archived in the container named ContosoArchives. +The command stores that object in the $DestBlob variable. +The last command starts the copy operation from the source container to the destination container. +The command uses standard dot notation to specify the **ICloudBlob** objects for the $SrcBlob and $DestBlob blobs. + +### Example 5: Copy a blob from a URI +```powershell +$Context = New-AzStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" +Start-AzStorageBlobCopy -AbsoluteUri "http://www.contosointernal.com/planning" -DestContainer "ContosoArchive" -DestBlob "ContosoPlanning2015" -DestContext $Context +``` + +This command creates a context for the account named ContosoGeneral that uses the specified key, and then stores that key in the $Context variable. +The second command copies the file from the specified URI to the blob named ContosoPlanning in the container named ContosoArchive. +The command starts the copy operation to the destination context stored in $Context. +There are no source storage context, so the source Uri must have access to the source object. E.g: if the source is a none public Azure blob, the Uri should contain SAS token which has read access to the blob. + +### Example 6: Copy a block blob to destination container with a new blob name, and set destination blob StandardBlobTier as Hot, RehydratePriority as High +```powershell +Start-AzStorageBlobCopy -SrcContainer "ContosoUploads" -SrcBlob "BlockBlobName" -DestContainer "ContosoArchives" -DestBlob "NewBlockBlobName" -StandardBlobTier Hot -RehydratePriority High +``` + +This command starts the copy operation of a block blob to destination container with a new blob name, and set destination blob StandardBlobTier as Hot, RehydratePriority as High + +## PARAMETERS + +### -AbsoluteUri +Specifies the absolute URI of a file to copy to an Azure Storage blob. + +```yaml +Type: System.String +Parameter Sets: UriPipeline +Aliases: SrcUri, SourceUri + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BlobBaseClient +BlobBaseClient Object + +```yaml +Type: Azure.Storage.Blobs.Specialized.BlobBaseClient +Parameter Sets: BlobInstance, BlobInstanceToBlobInstance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudBlob +Specifies a **CloudBlob** object from Azure Storage Client library. +To obtain a **CloudBlob** object, use the Get-AzStorageBlob cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlob +Parameter Sets: BlobInstance, BlobInstanceToBlobInstance +Aliases: SrcICloudBlob, SrcCloudBlob, ICloudBlob, SourceICloudBlob, SourceCloudBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -CloudBlobContainer +Specifies a **CloudBlobContainer** object from the Azure Storage Client library. +This cmdlet copies a blob from the container that this parameter specifies. +To obtain a **CloudBlobContainer** object, use the Get-AzStorageContainer cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlobContainer +Parameter Sets: ContainerInstance +Aliases: SourceCloudBlobContainer + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: ContainerName, BlobInstance, BlobInstanceToBlobInstance, ContainerInstance, ShareName, ShareInstance, DirInstance, FileInstance, FileInstanceToBlobInstance +Aliases: SrcContext, SourceContext + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: UriPipeline +Aliases: SrcContext, SourceContext + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestBlob +Specifies the name of the destination blob. + +```yaml +Type: System.String +Parameter Sets: ContainerName, ContainerInstance, ShareName, ShareInstance, DirInstance, FileInstance +Aliases: DestinationBlob + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: BlobInstance +Aliases: DestinationBlob + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: UriPipeline +Aliases: DestinationBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestCloudBlob +Specifies a destination **CloudBlob** object + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlob +Parameter Sets: BlobInstanceToBlobInstance, FileInstanceToBlobInstance +Aliases: DestICloudBlob, DestinationCloudBlob, DestinationICloudBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestContainer +Specifies the name of the destination container. + +```yaml +Type: System.String +Parameter Sets: ContainerName, ContainerInstance, ShareName, ShareInstance, DirInstance, FileInstance, UriPipeline +Aliases: DestinationContainer + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: BlobInstance +Aliases: DestinationContainer + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestContext +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: DestinationContext + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DestTagCondition +Optional Tag expression statement to check match condition on the destination Blob. +The blob request will fail when the destination blob tags does not match the given expression. +See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Indicates that this cmdlet overwrites the destination blob without prompting you for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PremiumPageBlobTier +Premium Page Blob Tier + +```yaml +Type: Microsoft.Azure.Storage.Blob.PremiumPageBlobTier +Parameter Sets: ContainerName, BlobInstance, BlobInstanceToBlobInstance, ContainerInstance +Aliases: +Accepted values: Unknown, P4, P6, P10, P20, P30, P40, P50, P60, P70, P80 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RehydratePriority +Block Blob RehydratePriority. Indicates the priority with which to rehydrate an archived blob. Valid values are High/Standard. + +```yaml +Type: Microsoft.Azure.Storage.Blob.RehydratePriority +Parameter Sets: (All) +Aliases: +Accepted values: Standard, High + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the service side time-out interval, in seconds, for a request. +If the specified interval elapses before the service processes the request, the storage service returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcBlob +Specifies the name of the source blob. + +```yaml +Type: System.String +Parameter Sets: ContainerName, ContainerInstance +Aliases: SourceBlob + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcContainer +Specifies the name of the source container. + +```yaml +Type: System.String +Parameter Sets: ContainerName +Aliases: SourceContainer + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcDir +Specifies a **CloudFileDirectory** object from Azure Storage Client library. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileDirectory +Parameter Sets: DirInstance +Aliases: SourceDir + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcFile +Specifies a **CloudFile** object from Azure Storage Client library. +You can create it or use Get-AzStorageFile cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFile +Parameter Sets: FileInstance, FileInstanceToBlobInstance +Aliases: SourceFile + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SrcFilePath +Specifies the source file relative path of source directory or source share. + +```yaml +Type: System.String +Parameter Sets: ShareName, ShareInstance, DirInstance +Aliases: SourceFilePath + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcShare +Specifies a **CloudFileShare** object from Azure Storage Client library. +You can create it or use Get-AzStorageShare cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileShare +Parameter Sets: ShareInstance +Aliases: SourceShare + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcShareName +Specifies the source share name. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: SourceShareName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StandardBlobTier +Block Blob Tier, valid values are Hot/Cool/Archive/Cold. +See detail in https://learn.microsoft.com/azure/storage/blobs/storage-blob-storage-tiers + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Blob Tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagCondition +Optional Tag expression statement to check match condition on the source blob. +The blob request will fail when the source blob tags does not match the given expression. +See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations. + +```yaml +Type: System.String +Parameter Sets: ContainerName, BlobInstance, BlobInstanceToBlobInstance, ContainerInstance, UriPipeline +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Storage.Blob.CloudBlob + +### Microsoft.Azure.Storage.Blob.CloudBlobContainer + +### Microsoft.Azure.Storage.File.CloudFile + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob + +## NOTES + +## RELATED LINKS + +[Get-AzStorageBlobCopyState](./Get-AzStorageBlobCopyState.md) + +[Stop-AzStorageBlobCopy](./Stop-AzStorageBlobCopy.md) diff --git a/azps-10.1.0/Az.Storage/Start-AzStorageBlobIncrementalCopy.md b/azps-10.1.0/Az.Storage/Start-AzStorageBlobIncrementalCopy.md new file mode 100644 index 0000000000..2cda140790 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Start-AzStorageBlobIncrementalCopy.md @@ -0,0 +1,396 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/start-azstorageblobincrementalcopy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Start-AzStorageBlobIncrementalCopy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Start-AzStorageBlobIncrementalCopy.md +--- + +# Start-AzStorageBlobIncrementalCopy + +## SYNOPSIS +Start an Incremental copy operation from a Page blob snapshot to the specified destination Page blob. + +## SYNTAX + +### ContainerInstance (Default) +``` +Start-AzStorageBlobIncrementalCopy -CloudBlobContainer <CloudBlobContainer> -SrcBlob <String> + -SrcBlobSnapshotTime <DateTimeOffset> -DestContainer <String> [-DestBlob <String>] + [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobInstance +``` +Start-AzStorageBlobIncrementalCopy -CloudBlob <CloudPageBlob> -DestContainer <String> [-DestBlob <String>] + [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobInstanceToBlobInstance +``` +Start-AzStorageBlobIncrementalCopy -CloudBlob <CloudPageBlob> -DestCloudBlob <CloudPageBlob> + [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ContainerName +``` +Start-AzStorageBlobIncrementalCopy -SrcBlob <String> -SrcContainer <String> + -SrcBlobSnapshotTime <DateTimeOffset> -DestContainer <String> [-DestBlob <String>] + [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UriPipeline +``` +Start-AzStorageBlobIncrementalCopy -AbsoluteUri <String> -DestContainer <String> -DestBlob <String> + [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Start an Incremental copy operation from a Page blob snapshot to the specified destination Page blob. +See more details of the feature in https://learn.microsoft.com/rest/api/storageservices/fileservices/incremental-copy-blob. + +## EXAMPLES + +### Example 1: Start Incremental Copy Operation by blob name and snapshot time +```powershell +Start-AzStorageBlobIncrementalCopy -SrcContainer container1 -SrcBlob blob1 -SrcBlobSnapshotTime "04/07/2017 09:55:36.1190229 AM +00:00" -DestContainer container2 -DestBlob blob2 +``` + +This command start Incremental Copy Operation by blob name and snapshot time + +### Example 2: Start Incremental copy operation using source uri +```powershell +Start-AzStorageBlobIncrementalCopy -AbsoluteUri "http://www.somesite.com/somefile?snapshot=2017-04-07T10:05:40.2126635Z" -DestContainer container -DestBlob blob -DestContext $context +``` + +This command start Incremental Copy Operation using source uri + +### Example 3: Start Incremental copy operation using container pipeline from GetAzureStorageContainer +```powershell +Get-AzStorageContainer -Container container1 | Start-AzStorageBlobIncrementalCopy -SrcBlob blob -SrcBlobSnapshotTime "04/07/2017 09:55:36.1190229 AM +00:00" -DestContainer container2 +``` + +This command start Incremental Copy Operation using container pipeline from GetAzureStorageContainer + +### Example 4: start Incremental copy operation from CloudPageBlob object to destination blob with blob name +```powershell +$srcBlobSnapshot = Get-AzStorageBlob -Container container1 -prefix blob1| Where-Object ({$_.ICloudBlob.IsSnapshot})[0] +Start-AzStorageBlobIncrementalCopy -CloudBlob $srcBlobSnapshot.ICloudBlob -DestContainer container2 -DestBlob blob2 +``` + +This command start Incremental Copy Operation from CloudPageBlob object to destination blob with blob name + +## PARAMETERS + +### -AbsoluteUri +Absolute Uri to the source. Be noted that the credential should be provided in the Uri, if the source requires any. + +```yaml +Type: System.String +Parameter Sets: UriPipeline +Aliases: SrcUri, SourceUri + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +The client side maximum execution time for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudBlob +CloudBlob object from Azure Storage Client library. You can create it or use Get-AzStorageBlob cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudPageBlob +Parameter Sets: BlobInstance, BlobInstanceToBlobInstance +Aliases: SrcICloudBlob, SrcCloudBlob, ICloudBlob, SourceICloudBlob, SourceCloudBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -CloudBlobContainer +CloudBlobContainer object from Azure Storage Client library. You can create it or use Get-AzStorageContainer cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlobContainer +Parameter Sets: ContainerInstance +Aliases: SourceCloudBlobContainer + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +The total amount of concurrent async tasks. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Source Azure Storage Context. You can create it by New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: ContainerInstance, BlobInstance, BlobInstanceToBlobInstance, ContainerName +Aliases: SrcContext, SourceContext + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: UriPipeline +Aliases: SrcContext, SourceContext + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestBlob +Destination blob name + +```yaml +Type: System.String +Parameter Sets: ContainerInstance, BlobInstance, ContainerName +Aliases: DestinationBlob + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: UriPipeline +Aliases: DestinationBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestCloudBlob +Destination CloudBlob object + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudPageBlob +Parameter Sets: BlobInstanceToBlobInstance +Aliases: DestICloudBlob, DestinationCloudBlob, DestinationICloudBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestContainer +Destination container name + +```yaml +Type: System.String +Parameter Sets: ContainerInstance, BlobInstance, ContainerName, UriPipeline +Aliases: DestinationContainer + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestContext +Destination Azure Storage Context. You can create it by New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: DestinationContext + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +The server time out for each request in seconds. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcBlob +Source page blob name. + +```yaml +Type: System.String +Parameter Sets: ContainerInstance, ContainerName +Aliases: SourceBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcBlobSnapshotTime +Source page blob snapshot time. + +```yaml +Type: System.Nullable`1[System.DateTimeOffset] +Parameter Sets: ContainerInstance, ContainerName +Aliases: SourceBlobSnapshotTime + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcContainer +Source Container name + +```yaml +Type: System.String +Parameter Sets: ContainerName +Aliases: SourceContainer + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Storage.Blob.CloudPageBlob + +### Microsoft.Azure.Storage.Blob.CloudBlobContainer + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Start-AzStorageFileCopy.md b/azps-10.1.0/Az.Storage/Start-AzStorageFileCopy.md new file mode 100644 index 0000000000..502d2d9bda --- /dev/null +++ b/azps-10.1.0/Az.Storage/Start-AzStorageFileCopy.md @@ -0,0 +1,480 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: A96A1A67-6C9C-499F-9935-B90F7ACEB50E +online version: https://learn.microsoft.com/powershell/module/az.storage/start-azstoragefilecopy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Start-AzStorageFileCopy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Start-AzStorageFileCopy.md +--- + +# Start-AzStorageFileCopy + +## SYNOPSIS +Starts to copy a source file. + +## SYNTAX + +### ContainerName +``` +Start-AzStorageFileCopy -SrcBlobName <String> -SrcContainerName <String> -DestShareName <String> + -DestFilePath <String> [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-Force] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ContainerInstance +``` +Start-AzStorageFileCopy -SrcBlobName <String> -SrcContainer <CloudBlobContainer> -DestShareName <String> + -DestFilePath <String> [-DestContext <IStorageContext>] [-Force] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobInstanceFilePath +``` +Start-AzStorageFileCopy -SrcBlob <CloudBlob> -DestShareName <String> -DestFilePath <String> + [-DestContext <IStorageContext>] [-Force] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobInstanceFileInstance +``` +Start-AzStorageFileCopy -SrcBlob <CloudBlob> -DestFile <CloudFile> [-Force] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ShareName +``` +Start-AzStorageFileCopy -SrcFilePath <String> -SrcShareName <String> -DestShareName <String> + -DestFilePath <String> [-Context <IStorageContext>] [-DestContext <IStorageContext>] [-Force] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ShareInstance +``` +Start-AzStorageFileCopy -SrcFilePath <String> -SrcShare <CloudFileShare> -DestShareName <String> + -DestFilePath <String> [-DestContext <IStorageContext>] [-Force] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FileInstanceToFilePath +``` +Start-AzStorageFileCopy -SrcFile <CloudFile> -DestShareName <String> -DestFilePath <String> + [-DestContext <IStorageContext>] [-Force] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FileInstanceToFileInstance +``` +Start-AzStorageFileCopy -SrcFile <CloudFile> -DestFile <CloudFile> [-Force] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UriToFilePath +``` +Start-AzStorageFileCopy -AbsoluteUri <String> -DestShareName <String> -DestFilePath <String> + [-DestContext <IStorageContext>] [-Force] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UriToFileInstance +``` +Start-AzStorageFileCopy -AbsoluteUri <String> -DestFile <CloudFile> [-Force] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzStorageFileCopy** cmdlet starts to copy a source file to a destination file. +This cmdlet will trigger asynchronous blob copy, the copy process is handled by server. If this is a cross account blob copy, there is no SLA for the blob copy. + +## EXAMPLES + +### Example 1: Start copy operation from file to file by using share name and file name +```powershell +Start-AzStorageFileCopy -SrcShareName "ContosoShare01" -SrcFilePath "FilePath01" -DestShareName "ContosoShare02" -DestFilePath "FilePath02" +``` + +This command starts a copy operation from file to file. +The command specifies share name and file name + +### Example 2: Start copy operation from blob to file by using container name and blob name +```powershell +Start-AzStorageFileCopy -SrcContainerName "ContosoContainer01" -SrcBlobName "ContosoBlob01" -DestShareName "ContosoShare" -DestFilePath "FilePath02" +``` + +This command starts a copy operation from blob to file. +The command specifies container name and blob name + +## PARAMETERS + +### -AbsoluteUri +Specifies the URI of the source file. +If the source location requires a credential, you must provide one. + +```yaml +Type: System.String +Parameter Sets: UriToFilePath, UriToFileInstance +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure Storage context. +To obtain a context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: ContainerName, ShareName +Aliases: SrcContext + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestContext +Specifies the Azure Storage context of the destination. +To obtain a context, use **New-AzStorageContext**. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: ContainerName, ContainerInstance, BlobInstanceFilePath, ShareName, ShareInstance, FileInstanceToFilePath, UriToFilePath +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestFile +Specifies a **CloudFile** object. +You can create a cloud file or obtain one by using the Get-AzStorageFile cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFile +Parameter Sets: BlobInstanceFileInstance, FileInstanceToFileInstance, UriToFileInstance +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestFilePath +Specifies the path of the destination file relative to the destination share. + +```yaml +Type: System.String +Parameter Sets: ContainerName, ContainerInstance, BlobInstanceFilePath, ShareName, ShareInstance, FileInstanceToFilePath, UriToFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestShareName +Specifies the name of the destination share. + +```yaml +Type: System.String +Parameter Sets: ContainerName, ContainerInstance, BlobInstanceFilePath, ShareName, ShareInstance, FileInstanceToFilePath, UriToFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcBlob +Specifies a **CloudBlob** object. +You can create a cloud blob or obtain one by using the Get-AzStorageBlob cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlob +Parameter Sets: BlobInstanceFilePath, BlobInstanceFileInstance +Aliases: ICloudBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SrcBlobName +Specifies the name of the source blob. + +```yaml +Type: System.String +Parameter Sets: ContainerName, ContainerInstance +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcContainer +Specifies a cloud blob container object. +You can create cloud blob container object or use the Get-AzStorageContainer cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlobContainer +Parameter Sets: ContainerInstance +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcContainerName +Specifies the name of the source container. + +```yaml +Type: System.String +Parameter Sets: ContainerName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcFile +Specifies a **CloudFile** object. +You can create a cloud file or obtain one by using **Get-AzStorageFile**. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFile +Parameter Sets: FileInstanceToFilePath, FileInstanceToFileInstance +Aliases: CloudFile + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -SrcFilePath +Specifies the path of the source file relative to the source directory or source share. + +```yaml +Type: System.String +Parameter Sets: ShareName, ShareInstance +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcShare +Specifies a cloud file share object. +You can create a cloud file share or obtain one by using the Get-AzStorageShare cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFileShare +Parameter Sets: ShareInstance +Aliases: CloudFileShare + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SrcShareName +Specifies the name of the source share. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Storage.Blob.CloudBlob + +### Microsoft.Azure.Storage.File.CloudFile + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageFile + +## NOTES + +## RELATED LINKS + +[Get-AzStorageBlob](./Get-AzStorageBlob.md) + +[Get-AzStorageContainer](./Get-AzStorageContainer.md) + +[Get-AzStorageFile](./Get-AzStorageFile.md) + +[Get-AzStorageShare](./Get-AzStorageShare.md) + +[Get-AzStorageFileCopyState](./Get-AzStorageFileCopyState.md) + +[Stop-AzStorageFileCopy](./Stop-AzStorageFileCopy.md) diff --git a/azps-10.1.0/Az.Storage/Stop-AzStorageAccountHierarchicalNamespaceUpgrade.md b/azps-10.1.0/Az.Storage/Stop-AzStorageAccountHierarchicalNamespaceUpgrade.md new file mode 100644 index 0000000000..93a6578145 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Stop-AzStorageAccountHierarchicalNamespaceUpgrade.md @@ -0,0 +1,197 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/stop-azstorageaccounthierarchicalnamespaceupgrade +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Stop-AzStorageAccountHierarchicalNamespaceUpgrade.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Stop-AzStorageAccountHierarchicalNamespaceUpgrade.md +--- + +# Stop-AzStorageAccountHierarchicalNamespaceUpgrade + +## SYNOPSIS +Aborts an ongoing HierarchicalNamespace upgrade task on a storage account. + +## SYNTAX + +### AccountName (Default) +``` +Stop-AzStorageAccountHierarchicalNamespaceUpgrade [-ResourceGroupName] <String> [-Name] <String> [-Force] + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Stop-AzStorageAccountHierarchicalNamespaceUpgrade -InputObject <PSStorageAccount> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzStorageAccountHierarchicalNamespaceUpgrade** cmdlet can aborts an ongoing upgrade to enable HierarchicalNamespace task on a storage account. + +## EXAMPLES + +### Example 1: Abort HierarchicalNamespace upgrade task on a stroage account +```powershell +Stop-AzStorageAccountHierarchicalNamespaceUpgrade -ResourceGroupName $rgname -Name $accountName -Force -PassThru +``` + +```output +True +``` + +This command aborts an ongoing HierarchicalNamespace upgrade task on a storage account. +The task can be invoke with cmdlet 'Invoke-AzStorageAccountHierarchicalNamespaceUpgrade' with '-RequestType Upgrade'. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force to Failover the Account + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Display the storage account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Stop-AzStorageBlobCopy.md b/azps-10.1.0/Az.Storage/Stop-AzStorageBlobCopy.md new file mode 100644 index 0000000000..ba7a846c8c --- /dev/null +++ b/azps-10.1.0/Az.Storage/Stop-AzStorageBlobCopy.md @@ -0,0 +1,318 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: C274DFBD-6C93-4043-AF93-DAF7BEA1F11F +online version: https://learn.microsoft.com/powershell/module/az.storage/stop-azstorageblobcopy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Stop-AzStorageBlobCopy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Stop-AzStorageBlobCopy.md +--- + +# Stop-AzStorageBlobCopy + +## SYNOPSIS +Stops a copy operation. + +## SYNTAX + +### NamePipeline (Default) +``` +Stop-AzStorageBlobCopy [-Blob] <String> [-Container] <String> [-Force] [-CopyId <String>] + [-TagCondition <String>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### BlobPipeline +``` +Stop-AzStorageBlobCopy -CloudBlob <CloudBlob> [-Force] [-CopyId <String>] [-TagCondition <String>] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ContainerPipeline +``` +Stop-AzStorageBlobCopy -CloudBlobContainer <CloudBlobContainer> [-Blob] <String> [-Force] [-CopyId <String>] + [-TagCondition <String>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] + [-ClientTimeoutPerRequest <Int32>] [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzStorageBlobCopy** cmdlet stops a copy operation to the specified destination blob. + +## EXAMPLES + +### Example 1: Stop copy operation by name +```powershell +Stop-AzStorageBlobCopy -Container "ContainerName" -Blob "BlobName" -CopyId "CopyID" +``` + +This command stops the copy operation by name. + +### Example 2: Stop copy operation by using the pipeline +```powershell +Get-AzStorageContainer container* | Stop-AzStorageBlobCopy -Blob "BlobName" +``` + +This command stops the copy operation by passing the container on the pipeline from **Get-AzStorageContainer**. + +### Example 3: Stop copy operation by using the pipeline and Get-AzStorageBlob +```powershell +Get-AzStorageBlob -Container "ContainerName" | Stop-AzStorageBlobCopy -Force +``` + +This example stops the copy operation by passing the container on the pipeline from the Get-AzStorageBlob cmdlet. + +## PARAMETERS + +### -Blob +Specifies the name of the blob. + +```yaml +Type: System.String +Parameter Sets: NamePipeline, ContainerPipeline +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudBlob +Specifies a **CloudBlob** object from Azure Storage Client library. +To obtain a **CloudBlob** object, use the Get-AzStorageBlob cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlob +Parameter Sets: BlobPipeline +Aliases: ICloudBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -CloudBlobContainer +Specifies a **CloudBlobContainer** object from the Azure Storage Client library. +You can create the object or use the Get-AzStorageContainer cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.Blob.CloudBlobContainer +Parameter Sets: ContainerPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Container +Specifies the name of the container. + +```yaml +Type: System.String +Parameter Sets: NamePipeline +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies the Azure storage context. +You can create the context by using the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -CopyId +Specifies the copy ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Stops the current copy task on the specified blob without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the service side time-out interval, in seconds, for a request. +If the specified interval elapses before the service processes the request, the storage service returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagCondition +Optional Tag expression statement to check match condition. +The blob request will fail when the blob tags does not match the given expression. +See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Storage.Blob.CloudBlob + +### Microsoft.Azure.Storage.Blob.CloudBlobContainer + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob + +## NOTES + +## RELATED LINKS + +[Get-AzStorageBlob](./Get-AzStorageBlob.md) + +[Get-AzStorageContainer](./Get-AzStorageContainer.md) + +[Start-AzStorageBlobCopy](./Start-AzStorageBlobCopy.md) + +[Get-AzStorageBlobCopyState](./Get-AzStorageBlobCopyState.md) diff --git a/azps-10.1.0/Az.Storage/Stop-AzStorageFileCopy.md b/azps-10.1.0/Az.Storage/Stop-AzStorageFileCopy.md new file mode 100644 index 0000000000..d28b41278b --- /dev/null +++ b/azps-10.1.0/Az.Storage/Stop-AzStorageFileCopy.md @@ -0,0 +1,260 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +ms.assetid: 3AC3F8DE-E25D-41AE-9083-5C459A4C8CD0 +online version: https://learn.microsoft.com/powershell/module/az.storage/stop-azstoragefilecopy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Stop-AzStorageFileCopy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Stop-AzStorageFileCopy.md +--- + +# Stop-AzStorageFileCopy + +## SYNOPSIS +Stops a copy operation to the specified destination file. + +## SYNTAX + +### ShareName +``` +Stop-AzStorageFileCopy [-ShareName] <String> [-FilePath] <String> [-CopyId <String>] [-Force] + [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### File +``` +Stop-AzStorageFileCopy [-File] <CloudFile> [-CopyId <String>] [-Force] [-Context <IStorageContext>] + [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] + [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzStorageFileCopy** cmdlet stops copying a file to a destination file. + +## EXAMPLES + +### Example 1: Stop a copy operation +```powershell +Stop-AzStorageFileCopy -ShareName "ContosoShare" -FilePath "FilePath" -CopyId "CopyId" +``` + +This command stops copying a file that has the specified name. + +## PARAMETERS + +### -ClientTimeoutPerRequest +Specifies the client-side time-out interval, in seconds, for one service request. +If the previous call fails in the specified interval, this cmdlet retries the request. +If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ClientTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +Specifies the maximum concurrent network calls. +You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. +The specified value is an absolute count and is not multiplied by the core count. +This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the [New-AzStorageContext](./New-AzStorageContext.md) cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -CopyId +Specifies the ID of the copy operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +Specifies a **CloudFile** object. +You can create a cloud file or obtain one by using the Get-AzStorageFile cmdlet. + +```yaml +Type: Microsoft.Azure.Storage.File.CloudFile +Parameter Sets: File +Aliases: CloudFile + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -FilePath +Specifies the path of a file. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerTimeoutPerRequest +Specifies the length of the time-out period for the server part of a request. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ServerTimeoutPerRequestInSeconds + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +Specifies the name of a share. + +```yaml +Type: System.String +Parameter Sets: ShareName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Storage.File.CloudFile + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzStorageFile](./Get-AzStorageFile.md) + +[Get-AzStorageFileCopyState](./Get-AzStorageFileCopyState.md) + +[New-AzStorageContext](./New-AzStorageContext.md) + +[Start-AzStorageFileCopy](./Start-AzStorageFileCopy.md) diff --git a/azps-10.1.0/Az.Storage/Update-AzDataLakeGen2AclRecursive.md b/azps-10.1.0/Az.Storage/Update-AzDataLakeGen2AclRecursive.md new file mode 100644 index 0000000000..2a11540feb --- /dev/null +++ b/azps-10.1.0/Az.Storage/Update-AzDataLakeGen2AclRecursive.md @@ -0,0 +1,357 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/update-azdatalakegen2aclrecursive +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzDataLakeGen2AclRecursive.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzDataLakeGen2AclRecursive.md +--- + +# Update-AzDataLakeGen2AclRecursive + +## SYNOPSIS +Update ACL recursively on the specified path. + +## SYNTAX + +``` +Update-AzDataLakeGen2AclRecursive [-FileSystem] <String> [[-Path] <String>] [-ContinuationToken <String>] + -Acl <PSPathAccessControlEntry[]> [-ContinueOnFailure] [-BatchSize <Int32>] [-MaxBatchCount <Int32>] [-AsJob] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzDataLakeGen2AclRecursive** cmdlet updates ACL recursively on the specified path. +The input ACL will merge the the original ACL: If ACL entry with same AccessControlType/EntityId/DefaultScope exist, update permission; else add a new ACL entry. + +## EXAMPLES + +### Example 1: Update ACL recursively on a root directiry of filesystem +```powershell +$acl = New-AzDataLakeGen2ItemAclObject -AccessControlType user -Permission rwx +$acl = New-AzDataLakeGen2ItemAclObject -AccessControlType group -Permission rw- -InputObject $acl +$acl = New-AzDataLakeGen2ItemAclObject -AccessControlType other -Permission "rw-" -InputObject $acl +Update-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Acl $acl -Context $ctx +``` + +```output +FailedEntries : +TotalDirectoriesSuccessfulCount : 7 +TotalFilesSuccessfulCount : 5 +TotalFailureCount : 0 +ContinuationToken : +``` + +This command first creates an ACL object with 3 acl entries, then updates ACL recursively on a root directory of a file system. + +### Example 2: Update ACL recursively on a directory, and resume from failure with ContinuationToken +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $result = Update-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path "dir1" -Acl $acl -Context $ctx + +PS C:\> $result + +FailedEntries : {dir1/dir2/file4} +TotalDirectoriesSuccessfulCount : 500 +TotalFilesSuccessfulCount : 2500 +TotalFailureCount : 1 +ContinuationToken : VBaHi5TfyO2ai1wYTRhIL2FjbGNibjA2c3RmATAxRDVEN0UzRENFQzZCRTAvYWRsc3Rlc3QyATAxRDY2M0ZCQTZBN0JGQTkvZGlyMC9kaXIxL2ZpbGUzFgAAAA== + +PS C:\> $result.FailedEntries + +Name IsDirectory ErrorMessage +---- ----------- ------------ +dir0/dir2/file4 False This request is not authorized to perform this operation using this permission. + +# user need fix the failed item , then can resume with ContinuationToken + +PS C:\> $result = Update-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path "dir1" -Acl $acl -ContinuationToken $result.ContinuationToken -Context $ctx + +PS C:\> $result + +FailedEntries : +TotalDirectoriesSuccessfulCount : 100 +TotalFilesSuccessfulCount : 1000 +TotalFailureCount : 0 +ContinuationToken : +``` + +This command first updateds ACL recursively to a directory and failed, then resume with ContinuationToken after user fix the failed file. + +### Example 3: Update ACL recursively chunk by chunk +<!-- Skip: Output cannot be splitted from code --> +```powershell +$ContinueOnFailure = $true # Set it to $false if want to terminate the operation quickly on encountering failures +$token = $null +$TotalDirectoriesSuccess = 0 +$TotalFilesSuccess = 0 +$totalFailure = 0 +$FailedEntries = New-Object System.Collections.Generic.List[System.Object] +do +{ + + if ($ContinueOnFailure) + { + $result = Update-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path "dir1" -Acl $acl -BatchSize 100 -MaxBatchCount 50 -ContinuationToken $token -Context $ctx -ContinueOnFailure + } + else + { + $result = Update-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path "dir1" -Acl $acl -BatchSize 100 -MaxBatchCount 50 -ContinuationToken $token -Context $ctx + } + + # echo $result + $TotalFilesSuccess += $result.TotalFilesSuccessfulCount + $TotalDirectoriesSuccess += $result.TotalDirectoriesSuccessfulCount + $totalFailure += $result.TotalFailureCount + $FailedEntries += $result.FailedEntries + $token = $result.ContinuationToken +}while (($null -ne $token) -and (($ContinueOnFailure) -or ($result.TotalFailureCount -eq 0))) +echo "" +echo "[Result Summary]" +echo "TotalDirectoriesSuccessfulCount: `t$($TotalDirectoriesSuccess)" +echo "TotalFilesSuccessfulCount: `t`t`t$($TotalFilesSuccess)" +echo "TotalFailureCount: `t`t`t`t`t$($totalFailure)" +echo "ContinuationToken: `t`t`t`t`t$($token)" +echo "FailedEntries:"$($FailedEntries | ft) +``` + +This script will update ACL rescursively on directory chunk by chunk, with chunk size as BatchSize * MaxBatchCount. Chunk size is 5000 in this script. + +### Example 4: Update ACL recursively on a directory and ContinueOnFailure, then resume from failures one by one +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $result = Update-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path "dir1" -Acl $acl -ContinueOnFailure -Context $ctx + +PS C:\> $result + +FailedEntries : {dir0/dir1/file1, dir0/dir2/file4} +TotalDirectoriesSuccessfulCount : 100 +TotalFilesSuccessfulCount : 500 +TotalFailureCount : 2 +ContinuationToken : VBaHi5TfyO2ai1wYTRhIL2FjbGNibjA2c3RmATAxRDVEN0UzRENFQzZCRTAvYWRsc3Rlc3QyATAxRDY2M0ZCQTZBN0JGQTkvZGlyMC9kaXIxL2ZpbGUzFgAAAA== + +PS C:\> $result.FailedEntries + +Name IsDirectory ErrorMessage +---- ----------- ------------ +dir0/dir1/file1 False This request is not authorized to perform this operation using this permission. +dir0/dir2/file4 False This request is not authorized to perform this operation using this permission. + +# user need fix the failed item , then can resume with ContinuationToken + +PS C:\> foreach ($path in $result.FailedEntries.Name) + { + # user code to fix failed entry in $path + + #set ACL again + Set-AzDataLakeGen2AclRecursive -FileSystem "filesystem1" -Path $path -Acl $acl -Context $ctx + } +``` + +This command first updateds ACL recursively to a directory with ContinueOnFailure, and some items failed, then resume the failed items one by one. + +## PARAMETERS + +### -Acl +The POSIX access control list to set recursively for the file or directory. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSPathAccessControlEntry[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +If data set size exceeds batch size then operation will be split into multiple requests so that progress can be tracked. +Batch size should be between 1 and 2000. +Default is 2000. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ContinuationToken +Continuation Token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinueOnFailure +Set this parameter to ignore failures and continue proceeing with the operation on other sub-entities of the directory. Default the operation will terminate quickly on encountering failures. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +FileSystem name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaxBatchCount +Maximum number of batches that single change Access Control operation can execute. If data set size exceeds MaxBatchCount multiply BatchSize, continuation token will be return. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path in the specified FileSystem that to change Acl recursively. +Can be a file or directory. +In the format 'directory/file.txt' or 'directory1/directory2/'. +Skip set this parameter to change Acl recursively from root directory of the Filesystem. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Update-AzDataLakeGen2Item.md b/azps-10.1.0/Az.Storage/Update-AzDataLakeGen2Item.md new file mode 100644 index 0000000000..4c32691414 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Update-AzDataLakeGen2Item.md @@ -0,0 +1,382 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/update-azdatalakegen2item +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzDataLakeGen2Item.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzDataLakeGen2Item.md +--- + +# Update-AzDataLakeGen2Item + +## SYNOPSIS +Update a file or directory on properties, metadata, permission, ACL, and owner. + +## SYNTAX + +### ReceiveManual (Default) +``` +Update-AzDataLakeGen2Item [-FileSystem] <String> [-Path <String>] [-Permission <String>] [-Owner <String>] + [-Group <String>] [-Property <Hashtable>] [-Metadata <Hashtable>] [-Acl <PSPathAccessControlEntry[]>] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ItemPipeline +``` +Update-AzDataLakeGen2Item -InputObject <AzureDataLakeGen2Item> [-Permission <String>] [-Owner <String>] + [-Group <String>] [-Property <Hashtable>] [-Metadata <Hashtable>] [-Acl <PSPathAccessControlEntry[]>] + [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzDataLakeGen2Item** cmdlet updates a file or directory on properties, metadata, permission, ACL, and owner. +This cmdlet only works if Hierarchical Namespace is enabled for the Storage account. This kind of account can be created by run "New-AzStorageAccount" cmdlet with "-EnableHierarchicalNamespace $true". + +## EXAMPLES + +### Example 1: Create an ACL object with 3 ACL entry, and update ACL to all items in a Filesystem recursively +```powershell +$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType user -Permission rwx +$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType group -Permission rw- -InputObject $acl +$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType other -Permission "rwt" -InputObject $acl +Get-AzDataLakeGen2ChildItem -FileSystem "filesystem1" -Recurse | Update-AzDataLakeGen2Item -ACL $acl +``` + +```output +FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir1 True 2020-03-13 13:07:34Z rwxrw-rwt $superuser $superuser +dir1/file1 False 1024 2020-03-23 09:29:18Z rwxrw-rwt $superuser $superuser +dir2 True 2020-03-23 09:28:36Z rwxrw-rwt $superuser $superuser +``` + +This command first creates an ACL object with 3 acl entry (use -InputObject parameter to add acl entry to existing acl object), then get all items in a filesystem and update acl on the items. + +### Example 2: Update all properties on a file, and show them +<!-- Skip: Output cannot be splitted from code --> + + +``` +PS C:\> $file = Update-AzDataLakeGen2Item -FileSystem "filesystem1" -Path "dir1/file1" ` + -Acl $acl ` + -Property @{"ContentType" = "image/jpeg"; "ContentMD5" = "i727sP7HigloQDsqadNLHw=="; "ContentEncoding" = "UDF8"; "CacheControl" = "READ"; "ContentDisposition" = "True"; "ContentLanguage" = "EN-US"} ` + -Metadata @{"tag1" = "value1"; "tag2" = "value2" } ` + -Permission rw-rw-rwx ` + -Owner '$superuser' ` + -Group '$superuser' + +PS C:\> $file + + FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir1/file1 False 1024 2020-03-23 09:57:33Z rwxrw-rw- $superuser $superuser + +PS C:\> $file.ACL + +DefaultScope AccessControlType EntityId Permissions +------------ ----------------- -------- ----------- +False User rwx +False Group rw- +False Other rw- + +PS C:\> $file.Permissions + +Owner : Execute, Write, Read +Group : Write, Read +Other : Write, Read +StickyBit : False +ExtendedAcls : False + +PS C:\> $file.Properties.Metadata + +Key Value +--- ----- +tag2 value2 +tag1 value1 + +PS C:\> $file.Properties + + +LastModified : 3/23/2020 9:57:33 AM +00:00 +CreatedOn : 3/23/2020 9:29:18 AM +00:00 +Metadata : {[tag2, value2], [tag1, value1]} +CopyCompletedOn : 1/1/0001 12:00:00 AM +00:00 +CopyStatusDescription : +CopyId : +CopyProgress : +CopySource : +CopyStatus : Pending +IsIncrementalCopy : False +LeaseDuration : Infinite +LeaseState : Available +LeaseStatus : Unlocked +ContentLength : 1024 +ContentType : image/jpeg +ETag : "0x8D7CF109B9878CC" +ContentHash : {139, 189, 187, 176...} +ContentEncoding : UDF8 +ContentDisposition : True +ContentLanguage : EN-US +CacheControl : READ +AcceptRanges : bytes +IsServerEncrypted : True +EncryptionKeySha256 : +AccessTier : Cool +ArchiveStatus : +AccessTierChangedOn : 1/1/0001 12:00:00 AM +00:00 +``` + +This command updates all properties on a file (ACL, permission,owner, group, metadata, property can be updated with any conbination), and show them in Powershell console. + +### Example 3: Add an ACL entry to a directory +```powershell +## Get the origin ACL +$acl = (Get-AzDataLakeGen2Item -FileSystem "filesystem1" -Path 'dir1/dir3/').ACL + +# Update permission of a new ACL entry (if ACL entry with same AccessControlType/EntityId/DefaultScope not exist, will add a new ACL entry, else update permission of existing ACL entry) +$acl = Set-AzDataLakeGen2ItemAclObject -AccessControlType user -EntityId $id -Permission rw- -InputObject $acl + +# set the new acl to the directory +Update-AzDataLakeGen2Item -FileSystem "filesystem1" -Path 'dir1/dir3/' -ACL $acl +``` + +```output +FileSystem Name: filesystem1 + +Path IsDirectory Length LastModified Permissions Owner Group +---- ----------- ------ ------------ ----------- ----- ----- +dir1/dir3 True 2020-03-23 09:34:31Z rwxrw-rw-+ $superuser $superuser +``` + +This command gets ACL from a directory, updates/adds an ACL entry, and sets back to the directory. +If ACL entry with same AccessControlType/EntityId/DefaultScope not exist, will add a new ACL entry, else update permission of existing ACL entry. + +## PARAMETERS + +### -Acl +Sets POSIX access control rights on files and directories. +Create this object with New-AzDataLakeGen2ItemAclObject. + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSPathAccessControlEntry[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Context +Azure Storage Context Object + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSystem +FileSystem name + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Group +Sets the owning group of the blob. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Azure Datalake Gen2 Item Object to update + +```yaml +Type: Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item +Parameter Sets: ItemPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Metadata +Specifies metadata for the directory or file. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Owner +Sets the owner of the blob. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The path in the specified Filesystem that should be updated. +Can be a file or directory In the format 'directory/file.txt' or 'directory1/directory2/'. +Not specify this parameter will update the root directory of the Filesystem. + +```yaml +Type: System.String +Parameter Sets: ReceiveManual +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Permission +Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. Symbolic (rwxrw-rw-) is supported. +The sticky bit is also supported and its represented either by the letter t or T in the final character-place depending on whether the execution bit for the others category is set or unset respectively, +absence of t or T indicates sticky bit not set.Invalid in conjunction with ACL. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +Specifies properties for the directory or file. +The supported properties for file are: CacheControl, ContentDisposition, ContentEncoding, ContentLanguage, ContentMD5, ContentType. +The supported properties for directory are: CacheControl, ContentDisposition, ContentEncoding, ContentLanguage. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureDataLakeGen2Item + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Update-AzRmStorageContainer.md b/azps-10.1.0/Az.Storage/Update-AzRmStorageContainer.md new file mode 100644 index 0000000000..46a0847291 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Update-AzRmStorageContainer.md @@ -0,0 +1,264 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/update-azrmstoragecontainer +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzRmStorageContainer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzRmStorageContainer.md +--- + +# Update-AzRmStorageContainer + +## SYNOPSIS +Modifies a Storage blob container + +## SYNTAX + +### AccountName (Default) +``` +Update-AzRmStorageContainer [-ResourceGroupName] <String> [-StorageAccountName] <String> -Name <String> + [-PublicAccess <PSPublicAccess>] [-Metadata <Hashtable>] [-RootSquash <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Update-AzRmStorageContainer -Name <String> -StorageAccount <PSStorageAccount> [-PublicAccess <PSPublicAccess>] + [-Metadata <Hashtable>] [-RootSquash <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ContainerObject +``` +Update-AzRmStorageContainer -InputObject <PSContainer> [-PublicAccess <PSPublicAccess>] [-Metadata <Hashtable>] + [-RootSquash <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzRmStorageContainer** cmdlet modifies a Storage blob container + +## EXAMPLES + +### Example 1: Modifies a Storage blob container's metadata and public access with Storage account name and container name +```powershell +Update-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -PublicAccess Container -Metadata @{tag0="value0";tag1="value1"} +``` + +This command modifies a Storage blob container's metadata and public access with Storage account name and container name. + +### Example 2: Disable public access on a Storage blob container with Storage account object and container name +```powershell +$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" +Update-AzRmStorageContainer -StorageAccount $accountObject -ContainerName "myContainer" -PublicAccess None +``` + +This command disables public access on a Storage blob container with Storage account object and container name. + +### Example 3: Set public access as Blob for all Storage blob containers in a Storage account with pipeline +```powershell +Get-AzRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" | Update-AzRmStorageContainer -PublicAccess Blob +``` + +This command set public access as Blob for all Storage blob containers in a Storage account with pipeline. + +### Example 4: Update an Azure storage container with RootSquash +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\> $container = Update-AzRmStorageContainer -ResourceGroupName "myersourcegroup" -AccountName "mystorageaccount" -Name "mycontainer" -RootSquash NoRootSquash + +PS C:\> $container.EnableNfsV3AllSquash +False + +PS C:\> $container.EnableNfsV3RootSquash +False +``` + +This command updates a storage container, with RootSquash property set as NoRootSquash. RootSquash only works on a storage account that enabled NfsV3. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Storage container object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSContainer +Parameter Sets: ContainerObject +Aliases: Container + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Metadata +Container Metadata + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Container Name + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: N, ContainerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PublicAccess +Container PublicAccess + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSPublicAccess +Parameter Sets: (All) +Aliases: +Accepted values: Container, Blob, None + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RootSquash +Sets reduction of the access rights for the remote superuser. Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: NoRootSquash, RootSquash, AllSquash + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Update-AzRmStorageShare.md b/azps-10.1.0/Az.Storage/Update-AzRmStorageShare.md new file mode 100644 index 0000000000..6169a40a0d --- /dev/null +++ b/azps-10.1.0/Az.Storage/Update-AzRmStorageShare.md @@ -0,0 +1,348 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/update-azrmstorageshare +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzRmStorageShare.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzRmStorageShare.md +--- + +# Update-AzRmStorageShare + +## SYNOPSIS +Modifies a Storage file share. + +## SYNTAX + +### AccountName (Default) +``` +Update-AzRmStorageShare [-ResourceGroupName] <String> [-StorageAccountName] <String> -Name <String> + [-QuotaGiB <Int32>] [-Metadata <Hashtable>] [-AccessTier <String>] [-RootSquash <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Update-AzRmStorageShare -Name <String> -StorageAccount <PSStorageAccount> [-QuotaGiB <Int32>] + [-Metadata <Hashtable>] [-AccessTier <String>] [-RootSquash <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ShareResourceId +``` +Update-AzRmStorageShare [-ResourceId] <String> [-QuotaGiB <Int32>] [-Metadata <Hashtable>] + [-AccessTier <String>] [-RootSquash <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ShareObject +``` +Update-AzRmStorageShare -InputObject <PSShare> [-QuotaGiB <Int32>] [-Metadata <Hashtable>] + [-AccessTier <String>] [-RootSquash <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzRmStorageShare** cmdlet modifies a Storage file share. + +## EXAMPLES + +### Example 1: Modifies a Storage file share's metadata and share quota with Storage account name and share name +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\>$share = Update-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -QuotaGiB 200 -Metadata @{tag0="value0";tag1="value1"} + +PS C:\>$share + + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes +---- -------- ---------------- ---------- ------- ------- --------------- +myshare 200 + +PS C:\>$share.Metadata + +Key Value +--- ----- +tag0 value0 +tag1 value1 +``` + +This command modifies a Storage file share's metadata and share quota with Storage account name and share name, and show the modify result with the returned file share object. + +### Example 2: Modifies metadata on a Storage file share with Storage account object and share name +```powershell +$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount" +$share = Update-AzRmStorageShare -StorageAccount $accountObject -Name "myshare" -Metadata @{tag0="value0";tag1="value1"} +``` + +This command modifies metadata on a Storage file share with Storage account object and share name. + +### Example 3: Modifies share quota for all Storage file shares in a Storage account with pipeline +```powershell +Get-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" | Update-AzRmStorageShare -QuotaGiB 5000 +``` + +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes +---- -------- ---------------- ---------- ------- ------- --------------- +share1 5000 +share2 5000 +``` + +This command modifies share quota as 5000 GiB for all Storage file shares in a Storage account with pipeline. + +### Example 4: Modify a Storage file share with accesstier as Cool +```powershell +$share = Update-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -AccessTier Cool +``` + +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes +---- -------- ---------------- ---------- ------- ------- --------------- +myshare Cool +``` + +This command modifies a Storage file share with accesstier as Cool. + +### Example 5: Modifies rootsquash for a file shares in a Storage account +<!-- Skip: Output cannot be splitted from code --> +``` +PS C:\>$share = Update-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -RootSquash NoRootSquash + +PS C:\>$share + + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes +---- -------- ---------------- ---------- ------- ------- --------------- +myshare + +PS C:\> $share.RootSquash +NoRootSquash +``` + +This command modifies share RootSquash property to NoRootSquash. RootSquash property is only avaialbe on share with EnabledProtocol as NFS. + +## PARAMETERS + +### -AccessTier +Access tier for specific share. StorageV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: TransactionOptimized, Premium, Hot, Cool + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Storage Share object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSShare +Parameter Sets: ShareObject +Aliases: Share + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Metadata +Share Metadata + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Share Name + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountObject +Aliases: N, ShareName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuotaGiB +Share Quota in Gibibyte. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Quota + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a File Share Resource Id. + +```yaml +Type: System.String +Parameter Sets: ShareResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RootSquash +Sets reduction of the access rights for the remote superuser. Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash' + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: NoRootSquash, RootSquash, AllSquash + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### Microsoft.Azure.Commands.Management.Storage.Models.PSShare + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSShare + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Update-AzStorageAccountNetworkRuleSet.md b/azps-10.1.0/Az.Storage/Update-AzStorageAccountNetworkRuleSet.md new file mode 100644 index 0000000000..a4450c11a4 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Update-AzStorageAccountNetworkRuleSet.md @@ -0,0 +1,246 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/update-azstorageaccountnetworkruleset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzStorageAccountNetworkRuleSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzStorageAccountNetworkRuleSet.md +--- + +# Update-AzStorageAccountNetworkRuleSet + +## SYNOPSIS +Update the NetworkRule property of a Storage account + +## SYNTAX + +``` +Update-AzStorageAccountNetworkRuleSet [-ResourceGroupName] <String> [-Name] <String> + [-Bypass <PSNetWorkRuleBypassEnum>] [-DefaultAction <PSNetWorkRuleDefaultActionEnum>] [-IPRule <PSIpRule[]>] + [-VirtualNetworkRule <PSVirtualNetworkRule[]>] [-ResourceAccessRule <PSResourceAccessRule[]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzStorageAccountNetworkRuleSet** cmdlet updates the NetworkRule property of a Storage account + +## EXAMPLES + +### Example 1: Update all properties of NetworkRule, input Rules with JSON +```powershell +Update-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -Bypass Logging,Metrics -DefaultAction Allow -IpRule (@{IPAddressOrRange="10.0.0.0/7";Action="allow"},@{IPAddressOrRange="28.2.0.0/16";Action="allow"}) ` +-VirtualNetworkRule (@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"}, +@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2";Action="allow"}) -ResourceAccessRule (@{ResourceId=$ResourceId1;TenantId=$tenantId1},@{ResourceId=$ResourceId2;TenantId=$tenantId1}) +``` + +This command update all properties of NetworkRule, input Rules with JSON. + +### Example 2: Update Bypass property of NetworkRule +```powershell +Update-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -Bypass AzureServices,Metrics +``` + +This command update Bypass property of NetworkRule (other properties won't change). + +### Example 3: Clean up rules of NetworkRule of a Storage account +```powershell +Update-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -IpRule @() -VirtualNetworkRule @() -ResourceAccessRule @() +``` + +This command clean up rules of NetworkRule of a Storage account (other properties not change). + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Bypass +The Bypass value to update to the NetworkRule property of a Storage account. +The allowed value are none or any combination of: +• Logging +• Metrics +• Azureservices + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSNetWorkRuleBypassEnum +Parameter Sets: (All) +Aliases: +Accepted values: None, Logging, Metrics, AzureServices + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultAction +The DefaultAction value to update to the NetworkRule property of a Storage account. +The allowed Options: +• Allow +• Deny + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSNetWorkRuleDefaultActionEnum +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPRule +The Array of IpRule objects to update to the NetworkRule Property of a Storage account. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountName, AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceAccessRule +Storage Account NetworkRule ResourceAccessRules. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSResourceAccessRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group contains the Storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VirtualNetworkRule +The Array of VirtualNetworkRule objects to update to the NetworkRule Property of a Storage account. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] + +### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSNetworkRuleSet + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Update-AzStorageBlobServiceProperty.md b/azps-10.1.0/Az.Storage/Update-AzStorageBlobServiceProperty.md new file mode 100644 index 0000000000..11425095e0 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Update-AzStorageBlobServiceProperty.md @@ -0,0 +1,351 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/update-azstorageblobserviceproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzStorageBlobServiceProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzStorageBlobServiceProperty.md +--- + +# Update-AzStorageBlobServiceProperty + +## SYNOPSIS +Modifies the service properties for the Azure Storage Blob service. + +## SYNTAX + +### AccountName (Default) +``` +Update-AzStorageBlobServiceProperty [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-DefaultServiceVersion <String>] [-EnableChangeFeed <Boolean>] [-ChangeFeedRetentionInDays <Int32>] + [-IsVersioningEnabled <Boolean>] [-CorsRule <PSCorsRule[]>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Update-AzStorageBlobServiceProperty -StorageAccount <PSStorageAccount> [-DefaultServiceVersion <String>] + [-EnableChangeFeed <Boolean>] [-ChangeFeedRetentionInDays <Int32>] [-IsVersioningEnabled <Boolean>] + [-CorsRule <PSCorsRule[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### BlobServicePropertiesResourceId +``` +Update-AzStorageBlobServiceProperty [-ResourceId] <String> [-DefaultServiceVersion <String>] + [-EnableChangeFeed <Boolean>] [-ChangeFeedRetentionInDays <Int32>] [-IsVersioningEnabled <Boolean>] + [-CorsRule <PSCorsRule[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzStorageBlobServiceProperty** cmdlet modifies the service properties for the Azure Storage Blob service. + +## EXAMPLES + +### Example 1: Set Blob service DefaultServiceVersion to 2018-03-28 +```powershell +Update-AzStorageBlobServiceProperty -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -DefaultServiceVersion 2018-03-28 +``` + +```output +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegroup +DefaultServiceVersion : 2018-03-28 +DeleteRetentionPolicy.Enabled : False +DeleteRetentionPolicy.Days : +RestorePolicy.Enabled : +RestorePolicy.Days : +ChangeFeed.Enabled : +ChangeFeed.RetentionInDays : +IsVersioningEnabled : +``` + +This command sets the DefaultServiceVersion of Blob Service to 2018-03-28. + +### Example 2: Enable Changefeed on Blob service of a Storage account with ChangeFeedRetentionInDays as 5 days +```powershell +Update-AzStorageBlobServiceProperty -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -EnableChangeFeed $true -ChangeFeedRetentionInDays 5 +``` + +```output +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegroup +DefaultServiceVersion : +DeleteRetentionPolicy.Enabled : False +DeleteRetentionPolicy.Days : +RestorePolicy.Enabled : +RestorePolicy.Days : +ChangeFeed.Enabled : True +ChangeFeed.RetentionInDays : 5 +IsVersioningEnabled : +``` + +This command enables Changefeed on Blob service of a Storage account with ChangeFeedRetentionInDays as 5 days. +Change feed support in Azure Blob Storage works by listening to a GPv2 or Blob storage account for any blob level creation, modification, or deletion events. +It then outputs an ordered log of events for the blobs stored in the $blobchangefeed container within the storage account. +The serialized changes are persisted as an Apache Avro file and can be processed asynchronously and incrementally. +If not specify ChangeFeedRetentionInDays, will get null value in service properties, indicates an infinite retention of the change feed. + +### Example 3: Enable Versioning on Blob service of a Storage account +```powershell +Update-AzStorageBlobServiceProperty -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -IsVersioningEnabled $true +``` + +```output +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegroup +DefaultServiceVersion : +DeleteRetentionPolicy.Enabled : False +DeleteRetentionPolicy.Days : +RestorePolicy.Enabled : +RestorePolicy.Days : +ChangeFeed : +ChangeFeed.RetentionInDays : +IsVersioningEnabled : True +``` + +This command enables Versioning on Blob service of a Storage account + +### Example 4: Update CORS rules +```powershell +$CorsRules = (@{ + AllowedHeaders=@("x-ms-blob-content-type","x-ms-blob-content-disposition"); + ExposedHeaders=@(); + AllowedOrigins=@("*"); + AllowedMethods=@("TRACE","CONNECT")}, + @{ + AllowedOrigins=@("http://www.fabrikam.com","http://www.contoso.com"); + ExposedHeaders=@("x-ms-meta-data*","x-ms-meta-customheader"); + AllowedHeaders=@("x-ms-meta-target*","x-ms-meta-customheader"); + MaxAgeInSeconds=30; + AllowedMethods=@("PUT")}) + +$property = Update-AzStorageBlobServiceProperty -ResourceGroupName myresourcegroup -StorageAccountName mystorageaccount -CorsRule $CorsRules +$property.Cors.CorsRulesProperty +``` + +```output +AllowedOrigins : {*} +AllowedMethods : {TRACE, CONNECT} +MaxAgeInSeconds : 0 +ExposedHeaders : {} +AllowedHeaders : {x-ms-blob-content-type, x-ms-blob-content-disposition} + +AllowedOrigins : {http://www.fabrikam.com, http://www.contoso.com} +AllowedMethods : {PUT} +MaxAgeInSeconds : 30 +ExposedHeaders : {x-ms-meta-customheader, x-ms-meta-data*} +AllowedHeaders : {x-ms-meta-customheader, x-ms-meta-target*} +``` + +The first command assigns an array of rules to the $CorsRules variable. This command uses standard extends over several lines in this code block. +The second command sets the rules in $CorsRules to the Blob service of a Storage account. + +### Example 5: Clean up CORS rules +```powershell +Update-AzStorageBlobServiceProperty -ResourceGroupName myresourcegroup -StorageAccountName mystorageaccount -CorsRule @() +``` +This command cleans up the CORS rules of a Storage account by inputting @() to parameter CorsRule + + +## PARAMETERS + +### -ChangeFeedRetentionInDays +Indicates the duration of changeFeed retention in days. Minimum value is 1 day and maximum value is 146000 days (400 years). +Never specify it when enabled changeFeed will get null value in service properties, indicates an infinite retention of the change feed. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorsRule +Specifies CORS rules for the Blob service. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSCorsRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultServiceVersion +Default Service Version to Set + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableChangeFeed +Enable Change Feed logging for the storage account by set to $true, disable Change Feed logging by set to $false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsVersioningEnabled +Gets or sets versioning is enabled if set to true. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a Storage account Resource Id, or a Blob service properties Resource Id. + +```yaml +Type: System.String +Parameter Sets: BlobServicePropertiesResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSBlobServiceProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Update-AzStorageEncryptionScope.md b/azps-10.1.0/Az.Storage/Update-AzStorageEncryptionScope.md new file mode 100644 index 0000000000..0cc799ef07 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Update-AzStorageEncryptionScope.md @@ -0,0 +1,320 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/update-azstorageencryptionscope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzStorageEncryptionScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzStorageEncryptionScope.md +--- + +# Update-AzStorageEncryptionScope + +## SYNOPSIS +Modify an encryption scope for a Storage account. + +## SYNTAX + +### AccountName (Default) +``` +Update-AzStorageEncryptionScope [-ResourceGroupName] <String> [-StorageAccountName] <String> + -EncryptionScopeName <String> [-StorageEncryption] [-State <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountNameKeyVault +``` +Update-AzStorageEncryptionScope [-ResourceGroupName] <String> [-StorageAccountName] <String> + -EncryptionScopeName <String> [-KeyvaultEncryption] -KeyUri <String> [-State <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Update-AzStorageEncryptionScope -StorageAccount <PSStorageAccount> -EncryptionScopeName <String> + [-StorageEncryption] [-State <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### AccountObjectKeyVault +``` +Update-AzStorageEncryptionScope -StorageAccount <PSStorageAccount> -EncryptionScopeName <String> + [-KeyvaultEncryption] -KeyUri <String> [-State <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### EncryptionScopeObject +``` +Update-AzStorageEncryptionScope -InputObject <PSEncryptionScope> [-StorageEncryption] [-State <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EncryptionScopeObjectKeyVault +``` +Update-AzStorageEncryptionScope -InputObject <PSEncryptionScope> [-KeyvaultEncryption] -KeyUri <String> + [-State <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzStorageEncryptionScope** cmdlet modifies an encryption scope for a Storage account. + +## EXAMPLES + +### Example 1: Disable an encryption scope +```powershell +Update-AzStorageEncryptionScope -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -EncryptionScopeName testscope -State Disabled +``` + +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name State Source KeyVaultKeyUri RequireInfrastructureEncryption +---- ----- ------ -------------- ------------------------------- +testscope Disabled Microsoft.Storage +``` + +This command disables an encryption scope. + +### Example 2: Enable an encryption scope +```powershell +Update-AzStorageEncryptionScope -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -EncryptionScopeName testscope -State Enabled +``` + +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name State Source KeyVaultKeyUri RequireInfrastructureEncryption +---- ----- ------ -------------- ------------------------------- +testscope Enabled Microsoft.Storage +``` + +This command enables an encryption scope. + +### Example 3: Update an encryption scope to use Storage Encryption +```powershell +Update-AzStorageEncryptionScope -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -EncryptionScopeName testscope -StorageEncryption +``` + +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name State Source KeyVaultKeyUri RequireInfrastructureEncryption +---- ----- ------ -------------- ------------------------------- +testscope Enabled Microsoft.Storage +``` + +This command updates an encryption scope to use Storage Encryption. + +### Example 4: Update an encryption scope to use Keyvault Encryption +```powershell +Update-AzStorageEncryptionScope -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -EncryptionScopeName testscope -KeyvaultEncryption -KeyUri "https://keyvalutname.vault.azure.net:443/keys/keyname/34a0ba563b4243d9a0ef2b1d3c0c7d57" +``` + +```output + ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount + +Name State Source KeyVaultKeyUri RequireInfrastructureEncryption +---- ----- ------ -------------- ------------------------------- +testscope Enabled Microsoft.Keyvault https://keyvalutname.vault.azure.net:443/keys/keyname/34a0ba563b4243d9a0ef2b1d3c0c7d57 +``` + +This command updtaes an encryption scope to use Keyvault Encryption. +The Storage account Identity need have get,wrapkey,unwrapkey permissions to the keyvault key. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionScopeName +Azure Storage EncryptionScope name + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountNameKeyVault, AccountObject, AccountObjectKeyVault +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +EncryptionScope object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSEncryptionScope +Parameter Sets: EncryptionScopeObject, EncryptionScopeObjectKeyVault +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyUri +The key Uri + +```yaml +Type: System.String +Parameter Sets: AccountNameKeyVault, AccountObjectKeyVault, EncryptionScopeObjectKeyVault +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyvaultEncryption +Create encryption scope with keySource as Microsoft.Keyvault + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AccountNameKeyVault, AccountObjectKeyVault, EncryptionScopeObjectKeyVault +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountNameKeyVault +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Update encryption scope State, Possible values include: 'Enabled', 'Disabled'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject, AccountObjectKeyVault +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName, AccountNameKeyVault +Aliases: AccountName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageEncryption +Create encryption scope with keySource as Microsoft.Storage. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AccountName, AccountObject, EncryptionScopeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSEncryptionScope + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Update-AzStorageFileServiceProperty.md b/azps-10.1.0/Az.Storage/Update-AzStorageFileServiceProperty.md new file mode 100644 index 0000000000..aafca81b19 --- /dev/null +++ b/azps-10.1.0/Az.Storage/Update-AzStorageFileServiceProperty.md @@ -0,0 +1,422 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.Management.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/update-azstoragefileserviceproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzStorageFileServiceProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzStorageFileServiceProperty.md +--- + +# Update-AzStorageFileServiceProperty + +## SYNOPSIS +Modifies the service properties for the Azure Storage File service. + +## SYNTAX + +### AccountName (Default) +``` +Update-AzStorageFileServiceProperty [-ResourceGroupName] <String> [-StorageAccountName] <String> + [-EnableShareDeleteRetentionPolicy <Boolean>] [-ShareRetentionDays <Int32>] [-EnableSmbMultichannel <Boolean>] + [-SmbProtocolVersion <String[]>] [-SmbAuthenticationMethod <String[]>] [-SmbChannelEncryption <String[]>] + [-SmbKerberosTicketEncryption <String[]>] [-CorsRule <PSCorsRule[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AccountObject +``` +Update-AzStorageFileServiceProperty -StorageAccount <PSStorageAccount> + [-EnableShareDeleteRetentionPolicy <Boolean>] [-ShareRetentionDays <Int32>] [-EnableSmbMultichannel <Boolean>] + [-SmbProtocolVersion <String[]>] [-SmbAuthenticationMethod <String[]>] [-SmbChannelEncryption <String[]>] + [-SmbKerberosTicketEncryption <String[]>] [-CorsRule <PSCorsRule[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FileServicePropertiesResourceId +``` +Update-AzStorageFileServiceProperty [-ResourceId] <String> [-EnableShareDeleteRetentionPolicy <Boolean>] + [-ShareRetentionDays <Int32>] [-EnableSmbMultichannel <Boolean>] [-SmbProtocolVersion <String[]>] + [-SmbAuthenticationMethod <String[]>] [-SmbChannelEncryption <String[]>] + [-SmbKerberosTicketEncryption <String[]>] [-CorsRule <PSCorsRule[]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzStorageFileServiceProperty** cmdlet modifies the service properties for the Azure Storage File service. + +## EXAMPLES + +### Example 1: Enable File share softdelete +```powershell +Update-AzStorageFileServiceProperty -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -EnableShareDeleteRetentionPolicy $true -ShareRetentionDays 5 +``` + +```output +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegroup +ShareDeleteRetentionPolicy.Enabled : True +ShareDeleteRetentionPolicy.Days : 5 +ProtocolSettings.Smb.Multichannel.Enabled : False +ProtocolSettings.Smb.Versions : +ProtocolSettings.Smb.AuthenticationMethods : +ProtocolSettings.Smb.KerberosTicketEncryption : +ProtocolSettings.Smb.ChannelEncryption : +``` + +This command enables File share softdelete delete with retention days as 5 + +### Example 2: Enable Smb Multichannel +```powershell +Update-AzStorageFileServiceProperty -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -EnableSmbMultichannel $true +``` + +```output +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegroup +ShareDeleteRetentionPolicy.Enabled : True +ShareDeleteRetentionPolicy.Days : 5 +ProtocolSettings.Smb.Multichannel.Enabled : True +ProtocolSettings.Smb.Versions : +ProtocolSettings.Smb.AuthenticationMethods : +ProtocolSettings.Smb.KerberosTicketEncryption : +ProtocolSettings.Smb.ChannelEncryption : +``` + +This command enables Smb Multichannel, only supported on Premium FileStorage account. + +### Example 3: Updates secure smb settings +```powershell +Update-AzStorageFileServiceProperty -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" ` + -SMBProtocolVersion SMB2.1,SMB3.0,SMB3.1.1 ` + -SMBAuthenticationMethod Kerberos,NTLMv2 ` + -SMBKerberosTicketEncryption RC4-HMAC,AES-256 ` + -SMBChannelEncryption AES-128-CCM,AES-128-GCM,AES-256-GCM +``` + +```output +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegroup +ShareDeleteRetentionPolicy.Enabled : True +ShareDeleteRetentionPolicy.Days : 5 +ProtocolSettings.Smb.Multichannel.Enabled : True +ProtocolSettings.Smb.Versions : {SMB2.1, SMB3.0, SMB3.1.1} +ProtocolSettings.Smb.AuthenticationMethods : {Kerberos, NTLMv2} +ProtocolSettings.Smb.KerberosTicketEncryption : {RC4-HMAC, AES-256} +ProtocolSettings.Smb.ChannelEncryption : {AES-128-CCM, AES-128-GCM, AES-256-GCM} +``` + +This command updates secure smb settings. + +### Example 4: Clear secure smb settings +```powershell +Update-AzStorageFileServiceProperty -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" ` + -SMBProtocolVersion @() ` + -SMBAuthenticationMethod @() ` + -SMBKerberosTicketEncryption @() ` + -SMBChannelEncryption @() +``` + +```output +StorageAccountName : mystorageaccount +ResourceGroupName : myresourcegroup +ShareDeleteRetentionPolicy.Enabled : True +ShareDeleteRetentionPolicy.Days : 5 +ProtocolSettings.Smb.Multichannel.Enabled : True +ProtocolSettings.Smb.Versions : +ProtocolSettings.Smb.AuthenticationMethods : +ProtocolSettings.Smb.KerberosTicketEncryption : +ProtocolSettings.Smb.ChannelEncryption : +``` + +This command clears secure smb settings. + +### Example 5: Update CORS rules +```powershell +$CorsRules = (@{ + AllowedHeaders=@("x-ms-blob-content-type","x-ms-blob-content-disposition"); + ExposedHeaders=@(); + AllowedOrigins=@("*"); + AllowedMethods=@("TRACE","CONNECT")}, + @{ + AllowedOrigins=@("http://www.fabrikam.com","http://www.contoso.com"); + ExposedHeaders=@("x-ms-meta-data*","x-ms-meta-customheader"); + AllowedHeaders=@("x-ms-meta-target*","x-ms-meta-customheader"); + MaxAgeInSeconds=30; + AllowedMethods=@("PUT")}) + +$property = Update-AzStorageFileServiceProperty -ResourceGroupName myresourcegroup -StorageAccountName mystorageaccount -CorsRule $CorsRules +$property.Cors.CorsRulesProperty +``` + +```output +AllowedOrigins : {*} +AllowedMethods : {TRACE, CONNECT} +MaxAgeInSeconds : 0 +ExposedHeaders : {} +AllowedHeaders : {x-ms-blob-content-type, x-ms-blob-content-disposition} + +AllowedOrigins : {http://www.fabrikam.com, http://www.contoso.com} +AllowedMethods : {PUT} +MaxAgeInSeconds : 30 +ExposedHeaders : {x-ms-meta-customheader, x-ms-meta-data*} +AllowedHeaders : {x-ms-meta-customheader, x-ms-meta-target*} +``` + +The first command assigns an array of rules to the $CorsRules variable. This command uses standard extends over several lines in this code block. +The second command sets the rules in $CorsRules to the File service of a Storage account. + +### Example 6: Clean up CORS rules +```powershell +Update-AzStorageFileServiceProperty -ResourceGroupName myresourcegroup -StorageAccountName mystorageaccount -CorsRule @() +``` +This command cleans up the CORS rules of a Storage account by inputting @() to parameter CorsRule. + +## PARAMETERS + +### -CorsRule +Specifies CORS rules for the File service. + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSCorsRule[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableShareDeleteRetentionPolicy +Enable share Delete Retention Policy for the storage account by set to $true, disable share Delete Retention Policy by set to $false. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSmbMultichannel +Enable Multichannel by set to $true, disable Multichannel by set to $false. Applies to Premium FileStorage only. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a Storage account Resource Id, or a File service properties Resource Id. + +```yaml +Type: System.String +Parameter Sets: FileServicePropertiesResourceId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ShareRetentionDays +Sets the number of retention days for the share DeleteRetentionPolicy. +The value should only be set when enable share Delete Retention Policy. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Days, RetentionDays + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmbAuthenticationMethod +Gets or sets SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: Kerberos, NTLMv2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmbChannelEncryption +Gets or sets SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: AES-128-CCM, AES-128-GCM, AES-256-GCM + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmbKerberosTicketEncryption +Gets or sets kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: AES-256, RC4-HMAC + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmbProtocolVersion +Gets or sets SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: +Accepted values: SMB2.1, SMB3.0, SMB3.1.1 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccount +Storage account object + +```yaml +Type: Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount +Parameter Sets: AccountObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountName +Storage Account Name. + +```yaml +Type: System.String +Parameter Sets: AccountName +Aliases: AccountName, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Management.Storage.Models.PSFileServiceProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Storage/Update-AzStorageServiceProperty.md b/azps-10.1.0/Az.Storage/Update-AzStorageServiceProperty.md new file mode 100644 index 0000000000..62df7ffc6a --- /dev/null +++ b/azps-10.1.0/Az.Storage/Update-AzStorageServiceProperty.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Storage.dll-Help.xml +Module Name: Az.Storage +online version: https://learn.microsoft.com/powershell/module/az.storage/update-azstorageserviceproperty +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzStorageServiceProperty.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Storage/Storage.Management/help/Update-AzStorageServiceProperty.md +--- + +# Update-AzStorageServiceProperty + +## SYNOPSIS +Modifies the properties for the Azure Storage service. + +## SYNTAX + +``` +Update-AzStorageServiceProperty [-ServiceType] <StorageServiceType> [-DefaultServiceVersion <String>] + [-PassThru] [-Context <IStorageContext>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzStorageServiceProperty** cmdlet modifies the properties for the Azure Storage service. + +## EXAMPLES + +### Example 1: Set Blob Service DefaultServiceVersion to 2017-04-17 +```powershell +Update-AzStorageServiceProperty -ServiceType Blob -DefaultServiceVersion 2017-04-17 +``` + +This command Set the DefaultServiceVersion of Blob Service to 2017-04-17 + +## PARAMETERS + +### -Context +Specifies an Azure storage context. +To obtain a storage context, use the New-AzStorageContext cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultServiceVersion +DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions. +See more details in https://learn.microsoft.com/rest/api/storageservices/versioning-for-the-azure-storage-services + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Display ServiceProperties + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceType +Specifies the storage service type. +This cmdlet gets the logging properties for the service type that this parameter specifies. +The acceptable values for this parameter are: +- Blob +- Table +- Queue +- File + +```yaml +Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType +Parameter Sets: (All) +Aliases: +Accepted values: Blob, Table, Queue, File + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext + +## OUTPUTS + +### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSSeriviceProperties + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageMover/Az.StorageMover.md b/azps-10.1.0/Az.StorageMover/Az.StorageMover.md new file mode 100644 index 0000000000..c23ef33fe3 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Az.StorageMover.md @@ -0,0 +1,92 @@ +--- +Module Name: Az.StorageMover +Module Guid: d6053d97-1a9b-4fc6-9bd2-09c5b23b34db +Download Help Link: https://learn.microsoft.com/powershell/module/az.storagemover +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Az.StorageMover.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Az.StorageMover.md +--- + +# Az.StorageMover Module +## Description +Microsoft Azure PowerShell: StorageMover cmdlets + +## Az.StorageMover Cmdlets +### [Get-AzStorageMover](Get-AzStorageMover.md) +Gets a Storage Mover resource. + +### [Get-AzStorageMoverAgent](Get-AzStorageMoverAgent.md) +Gets an Agent resource. + +### [Get-AzStorageMoverEndpoint](Get-AzStorageMoverEndpoint.md) +Gets an Endpoint resource. + +### [Get-AzStorageMoverJobDefinition](Get-AzStorageMoverJobDefinition.md) +Gets a Job Definition resource. + +### [Get-AzStorageMoverJobRun](Get-AzStorageMoverJobRun.md) +Gets a Job Run resource. + +### [Get-AzStorageMoverProject](Get-AzStorageMoverProject.md) +Gets a Project resource. + +### [New-AzStorageMover](New-AzStorageMover.md) +Creates or updates a top-level Storage Mover resource. + +### [New-AzStorageMoverAzStorageContainerEndpoint](New-AzStorageMoverAzStorageContainerEndpoint.md) +Creates an AzStorageContainer endpoint resource, which represents a data transfer source or destination. + +### [New-AzStorageMoverJobDefinition](New-AzStorageMoverJobDefinition.md) +Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer. + +### [New-AzStorageMoverNfsEndpoint](New-AzStorageMoverNfsEndpoint.md) +Creates a Nfs endpoint resource, which represents a data transfer source or destination. + +### [New-AzStorageMoverProject](New-AzStorageMoverProject.md) +Creates or updates a Project resource, which is a logical grouping of related jobs. + +### [Remove-AzStorageMover](Remove-AzStorageMover.md) +Deletes a Storage Mover resource. + +### [Remove-AzStorageMoverEndpoint](Remove-AzStorageMoverEndpoint.md) +Deletes an Endpoint resource. + +### [Remove-AzStorageMoverJobDefinition](Remove-AzStorageMoverJobDefinition.md) +Deletes a Job Definition resource. + +### [Remove-AzStorageMoverProject](Remove-AzStorageMoverProject.md) +Deletes a Project resource. + +### [Start-AzStorageMoverJobDefinition](Start-AzStorageMoverJobDefinition.md) +Requests an Agent to start a new instance of this Job Definition, generating a new Job Run resource. + +### [Stop-AzStorageMoverJobDefinition](Stop-AzStorageMoverJobDefinition.md) +Requests the Agent of any active instance of this Job Definition to stop. + +### [Unregister-AzStorageMoverAgent](Unregister-AzStorageMoverAgent.md) +Deletes an agent resource. + +### [Update-AzStorageMover](Update-AzStorageMover.md) +Updates properties for a Storage Mover resource. +Properties not specified in the request body will be unchanged. + +### [Update-AzStorageMoverAgent](Update-AzStorageMoverAgent.md) +Creates or updates an Agent resource. + +### [Update-AzStorageMoverAzStorageContainerEndpoint](Update-AzStorageMoverAzStorageContainerEndpoint.md) +Updates properties for an AzStorageContainer endpoint resource. +Properties not specified in the request body will be unchanged. + +### [Update-AzStorageMoverJobDefinition](Update-AzStorageMoverJobDefinition.md) +Updates properties for a Job Definition resource. +Properties not specified in the request body will be unchanged. + +### [Update-AzStorageMoverNfsEndpoint](Update-AzStorageMoverNfsEndpoint.md) +Updates properties for a Nfs endpoint resource. +Properties not specified in the request body will be unchanged. + +### [Update-AzStorageMoverProject](Update-AzStorageMoverProject.md) +Updates properties for a Project resource. +Properties not specified in the request body will be unchanged. + diff --git a/azps-10.1.0/Az.StorageMover/Get-AzStorageMover.md b/azps-10.1.0/Az.StorageMover/Get-AzStorageMover.md new file mode 100644 index 0000000000..d13768969a --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Get-AzStorageMover.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemover +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Get-AzStorageMover.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Get-AzStorageMover.md +--- + +# Get-AzStorageMover + +## SYNOPSIS +Gets a Storage Mover resource. + +## SYNTAX + +### List (Default) +``` +Get-AzStorageMover [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzStorageMover -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStorageMover -InputObject <IStorageMoverIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzStorageMover -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Storage Mover resource. + +## EXAMPLES + +### Example 1: Get all Storage movers in a subcription +```powershell + Get-AzStorageMover +``` + +```output +Description : StorageMover description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover1 +Location : eastus +Name : myStorageMover1 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:35:00 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:35:00 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Tag : { + "tag2": "value2", + "tag1": "value1" + } +Type : microsoft.storagemover/storagemovers + +Description : StorageMover description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup2/providers/Microsoft.StorageMover/storageMovers/myStorageMover2 +Location : eastus +Name : myStorageMover2 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:35:00 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:35:00 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Tag : { + "tag2": "value2", + "tag1": "value1" + } +Type : microsoft.storagemover/storagemovers +``` + +This command gets all the Storage movers in a subscription. + +### Example 2: Get all Storage movers in a resource group +```powershell +Get-AzStorageMover -ResourceGroupName myResourceGroup +``` + +```output +Description : StorageMover description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover1 +Location : eastus +Name : myStorageMover1 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:35:00 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:35:00 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Tag : { + "tag2": "value2", + "tag1": "value1" + } +Type : microsoft.storagemover/storagemovers +``` + +This command gets all the Storage movers in a resource group. + +### Example 2: Get a specific Storage mover +```powershell +Get-AzStorageMover -ResourceGroupName myResourceGroup -Name myStorageMover1 +``` + +```output +Description : StorageMover description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover1 +Location : eastus +Name : myStorageMover1 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:35:00 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:35:00 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Tag : { + "tag2": "value2", + "tag1": "value1" + } +Type : microsoft.storagemover/storagemovers +``` + +This command gets a specific Storage mover. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: StorageMoverName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IStorageMover + +## 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 <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverAgent.md b/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverAgent.md new file mode 100644 index 0000000000..1c18009c6e --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverAgent.md @@ -0,0 +1,230 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoveragent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Get-AzStorageMoverAgent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Get-AzStorageMoverAgent.md +--- + +# Get-AzStorageMoverAgent + +## SYNOPSIS +Gets an Agent resource. + +## SYNTAX + +### List (Default) +``` +Get-AzStorageMoverAgent -ResourceGroupName <String> -StorageMoverName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzStorageMoverAgent -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStorageMoverAgent -InputObject <IStorageMoverIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets an Agent resource. + +## EXAMPLES + +### Example 1: Get all agents in a Storage mover +```powershell +Get-AzStorageMoverAgent -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover +``` + +```output +AgentStatus : Registering +ArcResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myAgent +ArcVMUuid : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +Description : +ErrorDetailCode : +ErrorDetailMessage : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/microsoft.storagemover/storagemovers/myStorageMover/agents/myAgent +LastStatusUpdate : +LocalIPAddress : +MemoryInMb : +Name : myAgent +NumberOfCores : +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 7:15:19 AM +SystemDataCreatedBy : myAccount@xxx.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/2/2022 7:15:19 AM +SystemDataLastModifiedBy : myAccount@xxx.com +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/agents +UptimeInSeconds : +Version : +``` + +This command gets all the agents under a Storage mover + +### Example 2: Get a specific agent +```powershell +Get-AzStorageMoverAgent -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myAgent +``` + +```output +AgentStatus : Registering +ArcResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myAgent +ArcVMUuid : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +Description : +ErrorDetailCode : +ErrorDetailMessage : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/microsoft.storagemover/storagemovers/myStorageMover/agents/myAgent +LastStatusUpdate : +LocalIPAddress : +MemoryInMb : +Name : myAgent +NumberOfCores : +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 7:15:19 AM +SystemDataCreatedBy : myAccount@xxx.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/2/2022 7:15:19 AM +SystemDataLastModifiedBy : myAccount@xxx.com +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/agents +UptimeInSeconds : +Version : +``` + +This command gets a specific agent. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Agent resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AgentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IAgent + +## 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 <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverEndpoint.md b/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverEndpoint.md new file mode 100644 index 0000000000..0408ae9c8e --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverEndpoint.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoverendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Get-AzStorageMoverEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Get-AzStorageMoverEndpoint.md +--- + +# Get-AzStorageMoverEndpoint + +## SYNOPSIS +Gets an Endpoint resource. + +## SYNTAX + +### List (Default) +``` +Get-AzStorageMoverEndpoint -ResourceGroupName <String> -StorageMoverName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzStorageMoverEndpoint -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStorageMoverEndpoint -InputObject <IStorageMoverIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets an Endpoint resource. + +## EXAMPLES + +### Example 1: Get all endpoints in a Storage mover +```powershell +Get-AzStorageMoverEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint1 +Name : myEndpoint1 +Property : { + "endpointType": "AzureStorageBlobContainer", + "provisioningState": "Succeeded", + "storageAccountResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myStorageMover/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "blobContainerName": "myBlobContainer" + } +SystemDataCreatedAt : 7/18/2022 7:28:29 AM +SystemDataCreatedBy : xxxxxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:29 AM +SystemDataLastModifiedBy : xxxxxxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint2 +Name : myEndpoint2 +Property : { + "endpointType": "NfsMount", + "provisioningState": "Succeeded", + "host": "x.x.x.x", + "export": "/" + } +SystemDataCreatedAt : 7/18/2022 7:28:30 AM +SystemDataCreatedBy : xxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:30 AM +SystemDataLastModifiedBy : xxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command gets all the endpoints under a Storage mover. + +### Example 2: Get a specific endpoint +```powershell +Get-AzStorageMoverEndpoint -ResourceGroupName myResourceGroupName -StorageMoverName myStorageMoverName -Name myEndpoint +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint +Name : myEndpoint +Property : { + "endpointType": "NfsMount", + "provisioningState": "Succeeded", + "host": "x.x.x.x", + "export": "/" + } +SystemDataCreatedAt : 7/18/2022 7:28:30 AM +SystemDataCreatedBy : xxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:30 AM +SystemDataLastModifiedBy : xxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command gets a specific endpoint under a Storage mover. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Endpoint resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IEndpoint + +## 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 <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverJobDefinition.md b/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverJobDefinition.md new file mode 100644 index 0000000000..a1040a6457 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverJobDefinition.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoverjobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Get-AzStorageMoverJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Get-AzStorageMoverJobDefinition.md +--- + +# Get-AzStorageMoverJobDefinition + +## SYNOPSIS +Gets a Job Definition resource. + +## SYNTAX + +### List (Default) +``` +Get-AzStorageMoverJobDefinition -ProjectName <String> -ResourceGroupName <String> -StorageMoverName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzStorageMoverJobDefinition -Name <String> -ProjectName <String> -ResourceGroupName <String> + -StorageMoverName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStorageMoverJobDefinition -InputObject <IStorageMoverIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Job Definition resource. + +## EXAMPLES + +### Example 1: Get all job definitions under a Storage mover +```powershell +Get-AzStorageMoverJobDefinition -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover +``` + +```output +AgentName : myAgent +AgentResourceId : +CopyMode : Additive +Description : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob1 +LatestJobRunName : 12345678-1234-1234-1234-111111111111 +LatestJobRunResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob1/jobRuns/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +LatestJobRunStatus : Queued +Name : myJob1 +ProvisioningState : Succeeded +SourceName : nfsEndpoint1 +SourceResourceId : +SourceSubpath : +SystemDataCreatedAt : 7/28/2022 5:47:29 AM +SystemDataCreatedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 3:09:15 AM +SystemDataLastModifiedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataLastModifiedByType : Application +TargetName : containerEndpoint1 +TargetResourceId : +TargetSubpath : +Type : microsoft.storagemover/storagemovers/projects/jobdefinitions +``` + +This command gets all the job definitions under a specific Storage mover. + +### Example 2: Get a specific job definition +```powershell +Get-AzStorageMoverJobDefinition -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myJob1 +``` + +```output +AgentName : myAgent +AgentResourceId : +CopyMode : Additive +Description : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob1 +LatestJobRunName : 12345678-1234-1234-1234-111111111111 +LatestJobRunResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob1/jobRuns/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +LatestJobRunStatus : Queued +Name : myJob1 +ProvisioningState : Succeeded +SourceName : nfsEndpoint1 +SourceResourceId : +SourceSubpath : +SystemDataCreatedAt : 7/28/2022 5:47:29 AM +SystemDataCreatedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 3:09:15 AM +SystemDataLastModifiedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataLastModifiedByType : Application +TargetName : containerEndpoint1 +TargetResourceId : +TargetSubpath : +Type : microsoft.storagemover/storagemovers/projects/jobdefinitions +``` + +This command gets a specific job definition. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: JobDefinitionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IJobDefinition + +## 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 <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverJobRun.md b/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverJobRun.md new file mode 100644 index 0000000000..793578bf16 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverJobRun.md @@ -0,0 +1,304 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoverjobrun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Get-AzStorageMoverJobRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Get-AzStorageMoverJobRun.md +--- + +# Get-AzStorageMoverJobRun + +## SYNOPSIS +Gets a Job Run resource. + +## SYNTAX + +### List (Default) +``` +Get-AzStorageMoverJobRun -JobDefinitionName <String> -ProjectName <String> -ResourceGroupName <String> + -StorageMoverName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzStorageMoverJobRun -JobDefinitionName <String> -Name <String> -ProjectName <String> + -ResourceGroupName <String> -StorageMoverName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStorageMoverJobRun -InputObject <IStorageMoverIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Job Run resource. + +## EXAMPLES + +### Example 1: Get all job runs with a job definition +```powershell +Get-AzStorageMoverJobRun -JobDefinitionName myJobDefinition -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -ProjectName myProject +``` + +```output +AgentName : myAgent +AgentResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/agents/myAgent +BytesExcluded : 0 +BytesFailed : 0 +BytesNoTransferNeeded : 0 +BytesScanned : 0 +BytesTransferred : 0 +BytesUnsupported : 0 +ErrorCode : +ErrorMessage : +ExecutionEndTime : +ExecutionStartTime : 2/24/2023 12:27:58 AM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob/ + jobRuns/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +ItemsExcluded : 0 +ItemsFailed : 0 +ItemsNoTransferNeeded : 0 +ItemsScanned : 0 +ItemsTransferred : 0 +ItemsUnsupported : 0 +JobDefinitionProperty : { + } +LastStatusUpdate : 2/24/2023 12:27:39 AM +Name : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +ProvisioningState : Succeeded +ScanStatus : NotStarted +SourceName : sourceendpoint +SourceProperty : { + } +SourceResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/sourceendpoint +Status : Started +SystemDataCreatedAt : 2/24/2023 12:27:39 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 2/24/2023 12:36:01 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Target : +TargetName : targetendpoint +TargetProperty : { + } +TargetResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/targetendpoint +Type : microsoft.storagemover/storagemovers/projects/jobdefinitions/jobruns +``` + +This command gets all the job runs under a specific job definition + +### Example 2: Get a specific job run +```powershell +Get-AzStorageMoverJobRun -Name myJobRun -JobDefinitionName myJobDefinition -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -ProjectName myProject +``` + +```output +AgentName : myAgent +AgentResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/agents/myAgent +BytesExcluded : 0 +BytesFailed : 0 +BytesNoTransferNeeded : 0 +BytesScanned : 0 +BytesTransferred : 0 +BytesUnsupported : 0 +ErrorCode : +ErrorMessage : +ExecutionEndTime : +ExecutionStartTime : 2/24/2023 12:27:58 AM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob/ + jobRuns/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +ItemsExcluded : 0 +ItemsFailed : 0 +ItemsNoTransferNeeded : 0 +ItemsScanned : 0 +ItemsTransferred : 0 +ItemsUnsupported : 0 +JobDefinitionProperty : { + } +LastStatusUpdate : 2/24/2023 12:27:39 AM +Name : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +ProvisioningState : Succeeded +ScanStatus : NotStarted +SourceName : sourceendpoint +SourceProperty : { + } +SourceResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/sourceendpoint +Status : Started +SystemDataCreatedAt : 2/24/2023 12:27:39 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 2/24/2023 12:36:01 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Target : +TargetName : targetendpoint +TargetProperty : { + } +TargetResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/targetendpoint +Type : microsoft.storagemover/storagemovers/projects/jobdefinitions/jobruns +``` + +This command gets a specific job run. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobDefinitionName +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Job Run resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: JobRunName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IJobRun + +## 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 <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverProject.md b/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverProject.md new file mode 100644 index 0000000000..35fbee4059 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Get-AzStorageMoverProject.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoverproject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Get-AzStorageMoverProject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Get-AzStorageMoverProject.md +--- + +# Get-AzStorageMoverProject + +## SYNOPSIS +Gets a Project resource. + +## SYNTAX + +### List (Default) +``` +Get-AzStorageMoverProject -ResourceGroupName <String> -StorageMoverName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzStorageMoverProject -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStorageMoverProject -InputObject <IStorageMoverIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Project resource. + +## EXAMPLES + +### Example 1: Get all projects under a Storage mover +```powershell +$projectList = Get-AzStorageMoverProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover +``` + +```output +Description : My first project +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject1 +Name : myProject1 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:23:49 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:23:49 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/projects + +Description : My second project +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject2 +Name : myProject2 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:35:48 AM +SystemDataCreatedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:35:48 AM +SystemDataLastModifiedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/projects +``` + +This command gets all the projects under a Storage mover. + +### Example 2: Get a specific project +```powershell +$projectList = Get-AzStorageMoverProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myProject1 +``` + +```output +Description : My first project +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject1 +Name : myProject1 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:23:49 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:23:49 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/projects +``` + +This command gets a specific project under a Storage mover. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ProjectName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IProject + +## 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 <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/New-AzStorageMover.md b/azps-10.1.0/Az.StorageMover/New-AzStorageMover.md new file mode 100644 index 0000000000..2de9c7500b --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/New-AzStorageMover.md @@ -0,0 +1,249 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemover +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/New-AzStorageMover.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/New-AzStorageMover.md +--- + +# New-AzStorageMover + +## SYNOPSIS +Creates or updates a top-level Storage Mover resource. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStorageMover -Name <String> -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] + [-Description <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Create +``` +New-AzStorageMover -Name <String> -ResourceGroupName <String> -StorageMover <IStorageMover> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a top-level Storage Mover resource. + +## EXAMPLES + +### Example 1: Create a Storage mover +```powershell +New-AzStorageMover -ResourceGroupName myResourceGroup -Name myStorageMover -Location eastus -Description "Description" +``` + +```output +Description : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storage + Movers/myStorageMover +Location : eastus +Name : myStorageMover +ProvisioningState : Succeeded +SystemDataCreatedAt : 7/26/2022 5:49:02 AM +SystemDataCreatedBy : xxxxxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/26/2022 5:49:02 AM +SystemDataLastModifiedBy : xxxxxxxxxx +SystemDataLastModifiedByType : User +Tag : { + } +Type : microsoft.storagemover/storagemovers +``` + +This command creates a Storage mover for a resource group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Storage Mover. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageMoverName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMover +The Storage Mover resource, which is a container for a group of Agents, Projects, and Endpoints. +To construct, see NOTES section for STORAGEMOVER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IStorageMover +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IStorageMover + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IStorageMover + +## 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. + + +`STORAGEMOVER <IStorageMover>`: The Storage Mover resource, which is a container for a group of Agents, Projects, and Endpoints. + - `Location <String>`: The geo-location where the resource lives + - `[Tag <ITrackedResourceTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + - `[Description <String>]`: A description for the Storage Mover. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/New-AzStorageMoverAzStorageContainerEndpoint.md b/azps-10.1.0/Az.StorageMover/New-AzStorageMoverAzStorageContainerEndpoint.md new file mode 100644 index 0000000000..72ee50df91 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/New-AzStorageMoverAzStorageContainerEndpoint.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazstoragecontainerendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/New-AzStorageMoverAzStorageContainerEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/New-AzStorageMoverAzStorageContainerEndpoint.md +--- + +# New-AzStorageMoverAzStorageContainerEndpoint + +## SYNOPSIS +Creates an AzStorageContainer endpoint resource, which represents a data transfer source or destination. + +## SYNTAX + +``` +New-AzStorageMoverAzStorageContainerEndpoint -Name <String> -ResourceGroupName <String> + -StorageMoverName <String> -BlobContainerName <String> -StorageAccountResourceId <String> + [-SubscriptionId <String>] [-Description <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates an AzStorageContainer endpoint resource, which represents a data transfer source or destination. + +## EXAMPLES + +### Example 1: Create a AzStorageContainer endpoint +```powershell +New-AzStorageMoverAzStorageContainerEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -BlobContainerName myContainer -StorageMoverName myStorageMover -StorageAccountResourceId myAccountResourceId +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint +Name : myEndpoint +Property : { + "endpointType": "AzureStorageBlobContainer", + "provisioningState": "Succeeded", + "storageAccountResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myStorageMover/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "blobContainerName": "myContainer" + } +SystemDataCreatedAt : 7/18/2022 7:28:29 AM +SystemDataCreatedBy : xxxxxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:29 AM +SystemDataLastModifiedBy : xxxxxxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command creates a AzStorageContainer endpoint for a Storage mover. + +## PARAMETERS + +### -BlobContainerName +The name of the Storage blob container that is the target destination. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the endpoint resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The Azure Resource ID of the storage account that is the target destination. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IEndpoint + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IEndpoint + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/New-AzStorageMoverJobDefinition.md b/azps-10.1.0/Az.StorageMover/New-AzStorageMoverJobDefinition.md new file mode 100644 index 0000000000..5628cf1fb2 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/New-AzStorageMoverJobDefinition.md @@ -0,0 +1,353 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverjobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/New-AzStorageMoverJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/New-AzStorageMoverJobDefinition.md +--- + +# New-AzStorageMoverJobDefinition + +## SYNOPSIS +Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStorageMoverJobDefinition -Name <String> -ProjectName <String> -ResourceGroupName <String> + -StorageMoverName <String> -CopyMode <CopyMode> -SourceName <String> -TargetName <String> + [-SubscriptionId <String>] [-AgentName <String>] [-Description <String>] [-SourceSubpath <String>] + [-TargetSubpath <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Create +``` +New-AzStorageMoverJobDefinition -Name <String> -ProjectName <String> -ResourceGroupName <String> + -StorageMoverName <String> -JobDefinition <IJobDefinition> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer. + +## EXAMPLES + +### Example 1: Create a job definition +```powershell +New-AzStorageMoverJobDefinition -Name myJob -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -AgentName myAgent -SourceName myNfsEndpoint -TargetName myContainerEndpoint -CopyMode "Additive" -Description "job definition" +``` + +```output +AgentName : myAgent +AgentResourceId : +CopyMode : Additive +Description : job definition +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageM + overs/myStorageMover/projects/myProject/jobDefinitions/myJob +LatestJobRunName : +LatestJobRunResourceId : +LatestJobRunStatus : +Name : myJob +ProvisioningState : Succeeded +SourceName : myNfsEndpoint +SourceResourceId : +SourceSubpath : +SystemDataCreatedAt : 7/26/2022 6:14:43 AM +SystemDataCreatedBy : xxxxxxxxxxxxxxxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/26/2022 6:14:43 AM +SystemDataLastModifiedBy : xxxxxxxxxxxxxxxxxxxx +SystemDataLastModifiedByType : User +TargetName : myContainerEndpoint +TargetResourceId : +TargetSubpath : +Type : microsoft.storagemover/storagemovers/projects/jobdefinitions +``` + +This command creates a job definition. + +## PARAMETERS + +### -AgentName +Name of the Agent to assign for new Job Runs of this Job Definition. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyMode +Strategy to use for copy. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Support.CopyMode +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Job Definition. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobDefinition +The Job Definition resource. +To construct, see NOTES section for JOBDEFINITION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IJobDefinition +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: JobDefinitionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceName +The name of the source Endpoint. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSubpath +The subpath to use when reading from the source Endpoint. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetName +The name of the target Endpoint. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSubpath +The subpath to use when writing to the target Endpoint. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IJobDefinition + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IJobDefinition + +## 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. + + +`JOBDEFINITION <IJobDefinition>`: The Job Definition resource. + - `CopyMode <CopyMode>`: Strategy to use for copy. + - `SourceName <String>`: The name of the source Endpoint. + - `TargetName <String>`: The name of the target Endpoint. + - `[AgentName <String>]`: Name of the Agent to assign for new Job Runs of this Job Definition. + - `[Description <String>]`: A description for the Job Definition. + - `[SourceSubpath <String>]`: The subpath to use when reading from the source Endpoint. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + - `[TargetSubpath <String>]`: The subpath to use when writing to the target Endpoint. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/New-AzStorageMoverNfsEndpoint.md b/azps-10.1.0/Az.StorageMover/New-AzStorageMoverNfsEndpoint.md new file mode 100644 index 0000000000..b582e241a8 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/New-AzStorageMoverNfsEndpoint.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemovernfsendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/New-AzStorageMoverNfsEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/New-AzStorageMoverNfsEndpoint.md +--- + +# New-AzStorageMoverNfsEndpoint + +## SYNOPSIS +Creates a Nfs endpoint resource, which represents a data transfer source or destination. + +## SYNTAX + +``` +New-AzStorageMoverNfsEndpoint -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + -Export <String> -Host <String> [-SubscriptionId <String>] [-Description <String>] [-NfsVersion <NfsVersion>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a Nfs endpoint resource, which represents a data transfer source or destination. + +## EXAMPLES + +### Example 1: Create a NFS endpoint +```powershell + New-AzStorageMoverNfsEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Host "10.0.0.1" -Export "/" -NfsVersion NFSv3 -Description "Description" +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint +Name : myEndpoint +Property : { + "endpointType": "NfsMount", + "provisioningState": "Succeeded", + "host": "10.0.0.1", + "export": "/" + } +SystemDataCreatedAt : 7/18/2022 7:28:30 AM +SystemDataCreatedBy : xxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:30 AM +SystemDataLastModifiedBy : xxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command creates a NFS endpoint for a Storage mover. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Export +The directory being exported from the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Host +The host name or IP address of the server exporting the file system. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the endpoint resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NfsVersion +The NFS protocol version. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Support.NfsVersion +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IEndpoint + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IEndpoint + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/New-AzStorageMoverProject.md b/azps-10.1.0/Az.StorageMover/New-AzStorageMoverProject.md new file mode 100644 index 0000000000..9c40b34fe8 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/New-AzStorageMoverProject.md @@ -0,0 +1,229 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverproject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/New-AzStorageMoverProject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/New-AzStorageMoverProject.md +--- + +# New-AzStorageMoverProject + +## SYNOPSIS +Creates or updates a Project resource, which is a logical grouping of related jobs. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStorageMoverProject -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + [-SubscriptionId <String>] [-Description <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Create +``` +New-AzStorageMoverProject -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + -Project <IProject> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a Project resource, which is a logical grouping of related jobs. + +## EXAMPLES + +### Example 1: Create a project +```powershell +New-AzStorageMoverProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myProject -Description "description" +``` + +```output +Description : description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storage + Movers/myStorageMover/projects/myProject +Name : myProject +ProvisioningState : Succeeded +SystemDataCreatedAt : 7/26/2022 5:50:53 AM +SystemDataCreatedBy : xxxxxxxxxxxxxxxxxxxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/26/2022 5:50:53 AM +SystemDataLastModifiedBy : xxxxxxxxxxxxxxxxxxxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/projects +``` + +This command creates a project for a Storage mover. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Project. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ProjectName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Project +The Project resource. +To construct, see NOTES section for PROJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IProject +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IProject + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IProject + +## 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. + + +`PROJECT <IProject>`: The Project resource. + - `[Description <String>]`: A description for the Project. + - `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC). + - `[SystemDataCreatedBy <String>]`: The identity that created the resource. + - `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource. + - `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC) + - `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource. + - `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Remove-AzStorageMover.md b/azps-10.1.0/Az.StorageMover/Remove-AzStorageMover.md new file mode 100644 index 0000000000..61e03bbe18 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Remove-AzStorageMover.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/remove-azstoragemover +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Remove-AzStorageMover.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Remove-AzStorageMover.md +--- + +# Remove-AzStorageMover + +## SYNOPSIS +Deletes a Storage Mover resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStorageMover -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-Force] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStorageMover -InputObject <IStorageMoverIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-Force] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Storage Mover resource. + +## EXAMPLES + +### Example 1: Remove a Storage mover +```powershell +Remove-AzStorageMover -ResourceGroupName myResourceGroup -Name myStorageMover +``` + +This command removes a Storage mover. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: StorageMoverName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Remove-AzStorageMoverEndpoint.md b/azps-10.1.0/Az.StorageMover/Remove-AzStorageMoverEndpoint.md new file mode 100644 index 0000000000..a1b2865893 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Remove-AzStorageMoverEndpoint.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/remove-azstoragemoverendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Remove-AzStorageMoverEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Remove-AzStorageMoverEndpoint.md +--- + +# Remove-AzStorageMoverEndpoint + +## SYNOPSIS +Deletes an Endpoint resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStorageMoverEndpoint -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStorageMoverEndpoint -InputObject <IStorageMoverIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an Endpoint resource. + +## EXAMPLES + +### Example 1: Remove an endpoint +```powershell +Remove-AzStorageMoverEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myEndpoint +``` + +This command removes an endpoint from a Storage mover. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Endpoint resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Remove-AzStorageMoverJobDefinition.md b/azps-10.1.0/Az.StorageMover/Remove-AzStorageMoverJobDefinition.md new file mode 100644 index 0000000000..2851ff170a --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Remove-AzStorageMoverJobDefinition.md @@ -0,0 +1,260 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/remove-azstoragemoverjobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Remove-AzStorageMoverJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Remove-AzStorageMoverJobDefinition.md +--- + +# Remove-AzStorageMoverJobDefinition + +## SYNOPSIS +Deletes a Job Definition resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStorageMoverJobDefinition -Name <String> -ProjectName <String> -ResourceGroupName <String> + -StorageMoverName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStorageMoverJobDefinition -InputObject <IStorageMoverIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Job Definition resource. + +## EXAMPLES + +### Example 1: Remove a job definition +```powershell +Remove-AzStorageMoverJobDefinition -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -ProjectName myProject -Name myJobDefinition +``` + +This command removes a job definition. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: JobDefinitionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Remove-AzStorageMoverProject.md b/azps-10.1.0/Az.StorageMover/Remove-AzStorageMoverProject.md new file mode 100644 index 0000000000..6ae42f0aea --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Remove-AzStorageMoverProject.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/remove-azstoragemoverproject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Remove-AzStorageMoverProject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Remove-AzStorageMoverProject.md +--- + +# Remove-AzStorageMoverProject + +## SYNOPSIS +Deletes a Project resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStorageMoverProject -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStorageMoverProject -InputObject <IStorageMoverIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Project resource. + +## EXAMPLES + +### Example 1: Remove a project +```powershell +Remove-AzStorageMoverProject -ResourceGroupName myResourceGroupName -StorageMoverName myStorageMover -Name myProject +``` + +This command removes a project. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ProjectName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Start-AzStorageMoverJobDefinition.md b/azps-10.1.0/Az.StorageMover/Start-AzStorageMoverJobDefinition.md new file mode 100644 index 0000000000..868570b90b --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Start-AzStorageMoverJobDefinition.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/start-azstoragemoverjobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Start-AzStorageMoverJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Start-AzStorageMoverJobDefinition.md +--- + +# Start-AzStorageMoverJobDefinition + +## SYNOPSIS +Requests an Agent to start a new instance of this Job Definition, generating a new Job Run resource. + +## SYNTAX + +### Start (Default) +``` +Start-AzStorageMoverJobDefinition -JobDefinitionName <String> -ProjectName <String> + -ResourceGroupName <String> -StorageMoverName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzStorageMoverJobDefinition -InputObject <IStorageMoverIdentity> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Requests an Agent to start a new instance of this Job Definition, generating a new Job Run resource. + +## EXAMPLES + +### Example 1: Start a job definition +```powershell +New-AzStorageMoverProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myProject -Description "description" + +New-AzStorageMoverAzStorageContainerEndpoint -Name myContainerEndpoint -ResourceGroupName myResourceGroup -BlobContainerName myContainer -StorageMoverName myStorageMover -StorageAccountResourceId myAccountResourceId +New-AzStorageMoverNfsEndpoint -Name myNfsEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Host "x.x.x.x" -Export "/" -NfsVersion NFSv3 -Description "Description" + +New-AzStorageMoverJobDefinition -Name myJob -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -AgentName myAgent -SourceName myNfsEndpoint -TargetName myContainerEndpoint -CopyMode Additive +Start-AzStorageMoverJobDefinition -JobDefinitionName myJobDefinition -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover +``` + +```output +/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroupName/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJobDefinition/jobRuns/yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +``` + +This command starts a job definition. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobDefinitionName +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Stop-AzStorageMoverJobDefinition.md b/azps-10.1.0/Az.StorageMover/Stop-AzStorageMoverJobDefinition.md new file mode 100644 index 0000000000..eb77d46439 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Stop-AzStorageMoverJobDefinition.md @@ -0,0 +1,219 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/stop-azstoragemoverjobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Stop-AzStorageMoverJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Stop-AzStorageMoverJobDefinition.md +--- + +# Stop-AzStorageMoverJobDefinition + +## SYNOPSIS +Requests the Agent of any active instance of this Job Definition to stop. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzStorageMoverJobDefinition -JobDefinitionName <String> -ProjectName <String> -ResourceGroupName <String> + -StorageMoverName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzStorageMoverJobDefinition -InputObject <IStorageMoverIdentity> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Requests the Agent of any active instance of this Job Definition to stop. + +## EXAMPLES + +### Example 1: Stop a job definition +```powershell +Stop-AzStorageMoverJobDefinition -JobDefinitionName myJobDefinition -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover +``` + +```output +/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJobDefinition/jobRuns/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +``` + +This command stops a job definition. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobDefinitionName +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Unregister-AzStorageMoverAgent.md b/azps-10.1.0/Az.StorageMover/Unregister-AzStorageMoverAgent.md new file mode 100644 index 0000000000..af44c51f92 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Unregister-AzStorageMoverAgent.md @@ -0,0 +1,259 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/unregister-azstoragemoveragent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Unregister-AzStorageMoverAgent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Unregister-AzStorageMoverAgent.md +--- + +# Unregister-AzStorageMoverAgent + +## SYNOPSIS +Deletes an agent resource. + +## SYNTAX + +### Delete (Default) +``` +Unregister-AzStorageMoverAgent -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-Force] [-NoWait] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Unregister-AzStorageMoverAgent -InputObject <IStorageMoverIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-Force] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an agent resource. + +## EXAMPLES + +### Example 1: Unregister an agent +```powershell +Unregister-AzStorageMoverAgent -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myAgent +``` + +This command unresgisters an agent under a Storage mover. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the agent resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AgentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Update-AzStorageMover.md b/azps-10.1.0/Az.StorageMover/Update-AzStorageMover.md new file mode 100644 index 0000000000..84ad0f473c --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Update-AzStorageMover.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemover +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Update-AzStorageMover.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Update-AzStorageMover.md +--- + +# Update-AzStorageMover + +## SYNOPSIS +Updates properties for a Storage Mover resource. +Properties not specified in the request body will be unchanged. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMover -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Description <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Update +``` +Update-AzStorageMover -Name <String> -ResourceGroupName <String> -StorageMover <IStorageMoverUpdateParameters> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzStorageMover -InputObject <IStorageMoverIdentity> -StorageMover <IStorageMoverUpdateParameters> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMover -InputObject <IStorageMoverIdentity> [-Description <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates properties for a Storage Mover resource. +Properties not specified in the request body will be unchanged. + +## EXAMPLES + +### Example 1: Update a Storage mover +```powershell +Update-AzStorageMover -ResourceGroupName myResourceGroup -Name myStorageMover -Description "Update description" +``` + +```output +Description : Update description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover +Location : eastus +Name : myStorageMover +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 3:32:45 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/3/2022 3:10:31 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Tag : { + } +Type : microsoft.storagemover/storagemovers +``` + +This command updates the description of a Storage mover. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Storage Mover. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: StorageMoverName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMover +The Storage Mover resource. +To construct, see NOTES section for STORAGEMOVER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IStorageMoverUpdateParameters +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IStorageMoverUpdateParameters + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IStorageMover + +## 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 <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`STORAGEMOVER <IStorageMoverUpdateParameters>`: The Storage Mover resource. + - `[Description <String>]`: A description for the Storage Mover. + - `[Tag <IStorageMoverUpdateParametersTags>]`: Resource tags. + - `[(Any) <String>]`: This indicates any property can be added to this object. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverAgent.md b/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverAgent.md new file mode 100644 index 0000000000..e9632eb3da --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverAgent.md @@ -0,0 +1,274 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoveragent +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Update-AzStorageMoverAgent.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Update-AzStorageMoverAgent.md +--- + +# Update-AzStorageMoverAgent + +## SYNOPSIS +Creates or updates an Agent resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMoverAgent -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + [-SubscriptionId <String>] [-Description <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Update +``` +Update-AzStorageMoverAgent -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + -Agent <IAgentUpdateParameters> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzStorageMoverAgent -InputObject <IStorageMoverIdentity> -Agent <IAgentUpdateParameters> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMoverAgent -InputObject <IStorageMoverIdentity> [-Description <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an Agent resource. + +## EXAMPLES + +### Example 1: Update an agent. +```powershell +Update-AzStorageMoverAgent -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myAgent -Description "Update description" +``` + +```output +AgentStatus : Registering +ArcResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myAgent +ArcVMUuid : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +Description : Update description +ErrorDetailCode : +ErrorDetailMessage : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/microsoft.storagemover/storagemovers/myStorageMover/agents/myAgent +LastStatusUpdate : +LocalIPAddress : +MemoryInMb : +Name : myAgent +NumberOfCores : +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 7:15:19 AM +SystemDataCreatedBy : myAccount@xxx.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/2/2022 7:15:19 AM +SystemDataLastModifiedBy : myAccount@xxx.com +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/agents +UptimeInSeconds : +Version : +``` + +This command updates the description of a Storage mover agent. + +## PARAMETERS + +### -Agent +The Agent resource. +To construct, see NOTES section for AGENT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IAgentUpdateParameters +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Agent. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Agent resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: AgentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IAgentUpdateParameters + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IAgent + +## 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. + + +`AGENT <IAgentUpdateParameters>`: The Agent resource. + - `[Description <String>]`: A description for the Agent. + +`INPUTOBJECT <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverAzStorageContainerEndpoint.md b/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverAzStorageContainerEndpoint.md new file mode 100644 index 0000000000..a654c30a43 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverAzStorageContainerEndpoint.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazstoragecontainerendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Update-AzStorageMoverAzStorageContainerEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Update-AzStorageMoverAzStorageContainerEndpoint.md +--- + +# Update-AzStorageMoverAzStorageContainerEndpoint + +## SYNOPSIS +Updates properties for an AzStorageContainer endpoint resource. +Properties not specified in the request body will be unchanged. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMoverAzStorageContainerEndpoint -Name <String> -ResourceGroupName <String> + -StorageMoverName <String> [-SubscriptionId <String>] [-Description <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMoverAzStorageContainerEndpoint -InputObject <IStorageMoverIdentity> [-Description <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates properties for an AzStorageContainer endpoint resource. +Properties not specified in the request body will be unchanged. + +## EXAMPLES + +### Example 1: Update an AzStorageContainer endpoint +```powershell +Update-AzStorageMoverAzStorageContainerEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Description "Update Description" +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint1 +Name : containerEndpointo3q8xlbr +Property : { + "endpointType": "AzureStorageBlobContainer", + "description": "Update Description", + "provisioningState": "Succeeded", + "storageAccountResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myStorageMover/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "blobContainerName": "myContainer" + } +SystemDataCreatedAt : 7/18/2022 7:28:29 AM +SystemDataCreatedBy : xxxxxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:29 AM +SystemDataLastModifiedBy : xxxxxxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command updates the description of an AzStorageContainerEndpoint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the endpoint resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IEndpoint + +## 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 <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverJobDefinition.md b/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverJobDefinition.md new file mode 100644 index 0000000000..d8d065b687 --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverJobDefinition.md @@ -0,0 +1,326 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverjobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Update-AzStorageMoverJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Update-AzStorageMoverJobDefinition.md +--- + +# Update-AzStorageMoverJobDefinition + +## SYNOPSIS +Updates properties for a Job Definition resource. +Properties not specified in the request body will be unchanged. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMoverJobDefinition -Name <String> -ProjectName <String> -ResourceGroupName <String> + -StorageMoverName <String> [-SubscriptionId <String>] [-AgentName <String>] [-CopyMode <CopyMode>] + [-Description <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Update +``` +Update-AzStorageMoverJobDefinition -Name <String> -ProjectName <String> -ResourceGroupName <String> + -StorageMoverName <String> -JobDefinition <IJobDefinitionUpdateParameters> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzStorageMoverJobDefinition -InputObject <IStorageMoverIdentity> + -JobDefinition <IJobDefinitionUpdateParameters> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMoverJobDefinition -InputObject <IStorageMoverIdentity> [-AgentName <String>] + [-CopyMode <CopyMode>] [-Description <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates properties for a Job Definition resource. +Properties not specified in the request body will be unchanged. + +## EXAMPLES + +### Example 1: Update a job definition +```powershell +Update-AzStorageMoverJobDefinition -Name myJob -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Description "Update Description" +``` + +```output +AgentName : myAgent +AgentResourceId : +CopyMode : Additive +Description : Update description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob +LatestJobRunName : 12345678-1234-1234-1234-111111111111 +LatestJobRunResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob/jobRuns/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +LatestJobRunStatus : Queued +Name : myJob +ProvisioningState : Succeeded +SourceName : nfsEndpoint1 +SourceResourceId : +SourceSubpath : +SystemDataCreatedAt : 7/28/2022 5:47:29 AM +SystemDataCreatedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 3:09:15 AM +SystemDataLastModifiedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataLastModifiedByType : Application +TargetName : containerEndpoint1 +TargetResourceId : +TargetSubpath : +Type : microsoft.storagemover/storagemovers/projects/jobdefinitions +``` + +This command updates the description of a job definition. + +## PARAMETERS + +### -AgentName +Name of the Agent to assign for new Job Runs of this Job Definition. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyMode +Strategy to use for copy. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Support.CopyMode +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Job Definition. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobDefinition +The Job Definition resource. +To construct, see NOTES section for JOBDEFINITION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IJobDefinitionUpdateParameters +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: JobDefinitionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IJobDefinitionUpdateParameters + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IJobDefinition + +## 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 <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`JOBDEFINITION <IJobDefinitionUpdateParameters>`: The Job Definition resource. + - `[AgentName <String>]`: Name of the Agent to assign for new Job Runs of this Job Definition. + - `[CopyMode <CopyMode?>]`: Strategy to use for copy. + - `[Description <String>]`: A description for the Job Definition. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverNfsEndpoint.md b/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverNfsEndpoint.md new file mode 100644 index 0000000000..c3fa3b3d7f --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverNfsEndpoint.md @@ -0,0 +1,235 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemovernfsendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Update-AzStorageMoverNfsEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Update-AzStorageMoverNfsEndpoint.md +--- + +# Update-AzStorageMoverNfsEndpoint + +## SYNOPSIS +Updates properties for a Nfs endpoint resource. +Properties not specified in the request body will be unchanged. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMoverNfsEndpoint -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + [-SubscriptionId <String>] [-Description <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMoverNfsEndpoint -InputObject <IStorageMoverIdentity> [-Description <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates properties for a Nfs endpoint resource. +Properties not specified in the request body will be unchanged. + +## EXAMPLES + +### Example 1: Update a NFS endpoint +```powershell +Update-AzStorageMoverNfsEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Description "Update Description" +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint +Name : myEndpoint +Property : { + "endpointType": "NfsMount", + "description": "Update Description" + "provisioningState": "Succeeded", + "host": "10.0.0.1", + "export": "/" + } +SystemDataCreatedAt : 7/18/2022 7:28:30 AM +SystemDataCreatedBy : xxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:30 AM +SystemDataLastModifiedBy : xxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command updates the description of a NFS endpoint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the endpoint resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IEndpoint + +## 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 <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverProject.md b/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverProject.md new file mode 100644 index 0000000000..47fd8f1aff --- /dev/null +++ b/azps-10.1.0/Az.StorageMover/Update-AzStorageMoverProject.md @@ -0,0 +1,265 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverproject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Update-AzStorageMoverProject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageMover/help/Update-AzStorageMoverProject.md +--- + +# Update-AzStorageMoverProject + +## SYNOPSIS +Updates properties for a Project resource. +Properties not specified in the request body will be unchanged. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMoverProject -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + [-SubscriptionId <String>] [-Description <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### Update +``` +Update-AzStorageMoverProject -Name <String> -ResourceGroupName <String> -StorageMoverName <String> + -Project <IProjectUpdateParameters> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzStorageMoverProject -InputObject <IStorageMoverIdentity> -Project <IProjectUpdateParameters> + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMoverProject -InputObject <IStorageMoverIdentity> [-Description <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates properties for a Project resource. +Properties not specified in the request body will be unchanged. + +## EXAMPLES + +### Example 1: Update a project +```powershell +Update-AzStorageMoverProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myProject -Description "Update Description" +``` + +```output +Description : Update description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject +Name : myProject +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:23:49 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:23:49 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/projects +``` + +This command updates the description of a project. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Project. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: ProjectName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Project +The Project resource. +To construct, see NOTES section for PROJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IProjectUpdateParameters +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IProjectUpdateParameters + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20230301.IProject + +## 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 <IStorageMoverIdentity>`: Identity Parameter + - `[AgentName <String>]`: The name of the Agent resource. + - `[EndpointName <String>]`: The name of the Endpoint resource. + - `[Id <String>]`: Resource identity path + - `[JobDefinitionName <String>]`: The name of the Job Definition resource. + - `[JobRunName <String>]`: The name of the Job Run resource. + - `[ProjectName <String>]`: The name of the Project resource. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[StorageMoverName <String>]`: The name of the Storage Mover resource. + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`PROJECT <IProjectUpdateParameters>`: The Project resource. + - `[Description <String>]`: A description for the Project. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StorageSync/Az.StorageSync.md b/azps-10.1.0/Az.StorageSync/Az.StorageSync.md new file mode 100644 index 0000000000..1d971b563b --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Az.StorageSync.md @@ -0,0 +1,83 @@ +--- +Module Name: Az.StorageSync +Module Guid: 001b4bbc-9d7d-43b2-9e95-7a70325e9509 +Download Help Link: https://learn.microsoft.com/powershell/module/az.storagesync +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Az.StorageSync.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Az.StorageSync.md +--- + +# Az.StorageSync Module +## Description +The cmdlets in the Storage Sync module enable you to manage operations pertaining to Azure File Sync in PowerShell. + +## Az.StorageSync Cmdlets +### [Get-AzStorageSyncCloudEndpoint](Get-AzStorageSyncCloudEndpoint.md) +This command lists all cloud endpoints within a given sync group. + +### [Get-AzStorageSyncGroup](Get-AzStorageSyncGroup.md) +This command lists all sync groups within a given storage sync service. + +### [Get-AzStorageSyncServer](Get-AzStorageSyncServer.md) +This command lists all servers registered to a given storage sync service. + +### [Get-AzStorageSyncServerEndpoint](Get-AzStorageSyncServerEndpoint.md) +This command lists all server endpoints within a given sync group. + +### [Get-AzStorageSyncService](Get-AzStorageSyncService.md) +This command lists all storage sync services within a given scope of subscription/resource group. + +### [Invoke-AzStorageSyncChangeDetection](Invoke-AzStorageSyncChangeDetection.md) +This command can be used to manually initiate the detection of namespaces changes. It can be targeted to the entire share, subfolder or set of files. A maximum of 10,000 items can be detected. If the scope of changes is known to you, limit the execution of this command to parts of the namespace, so change detection can finish quickly and within the 10,000 item limit. + +> [!Note] +> The Invoke-AzStorageSyncChangeDetection cmdlet will not detect the following changes in the Azure file share: +> - Files that are deleted. +> - Files that are moved out of the share. +> - Files that are deleted and created with the same name. +> +> These changes will be detected when the [change detection job](https://learn.microsoft.com/azure/storage/files/storage-sync-files-troubleshoot?tabs=portal1%2Cazure-portal#afs-change-detection) runs. + +### [Invoke-AzStorageSyncCompatibilityCheck](Invoke-AzStorageSyncCompatibilityCheck.md) +Checks for potential compatibility issues between your system and Azure File Sync. + +### [New-AzStorageSyncCloudEndpoint](New-AzStorageSyncCloudEndpoint.md) +This command creates an Azure File Sync cloud endpoint in a sync group. + +### [New-AzStorageSyncGroup](New-AzStorageSyncGroup.md) +This command creates a new sync group within a specified storage sync service. + +### [New-AzStorageSyncServerEndpoint](New-AzStorageSyncServerEndpoint.md) +This command creates a new server endpoint on a registered server. This enables the specified path on the server to start syncing the files with other endpoints in the sync group. + +### [New-AzStorageSyncService](New-AzStorageSyncService.md) +This command creates a new storage sync service in a resource group. + +### [Register-AzStorageSyncServer](Register-AzStorageSyncServer.md) +This command registers a server to a storage sync service which creates a trust relationship. PowerShell or the Azure portal can then be used to configure sync on this server. + +### [Remove-AzStorageSyncCloudEndpoint](Remove-AzStorageSyncCloudEndpoint.md) +This command will delete the specified cloud endpoint from a sync group. Without at least one cloud endpoint, no other server endpoints in this sync group can sync. + +### [Remove-AzStorageSyncGroup](Remove-AzStorageSyncGroup.md) +This command will delete the specified sync group. + +### [Remove-AzStorageSyncServerEndpoint](Remove-AzStorageSyncServerEndpoint.md) +This command will delete the specified server endpoint. Sync to this location will stop immediately. + +### [Remove-AzStorageSyncService](Remove-AzStorageSyncService.md) +This command will delete the specified storage sync service. + +### [Reset-AzStorageSyncServerCertificate](Reset-AzStorageSyncServerCertificate.md) +Use for troubleshooting only. This command will roll the storage sync server certificate used to describe the server identity to the storage sync service. + +### [Set-AzStorageSyncServerEndpoint](Set-AzStorageSyncServerEndpoint.md) +This command allows for changes on the adjustable parameters of a server endpoint. + +### [Set-AzStorageSyncService](Set-AzStorageSyncService.md) +This command sets storage sync service in a resource group. + +### [Unregister-AzStorageSyncServer](Unregister-AzStorageSyncServer.md) +Warning: Unregistering a server will result in cascading deletes of all server endpoints on this server. This command will unregister a server from it's storage sync service. + diff --git a/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncCloudEndpoint.md b/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncCloudEndpoint.md new file mode 100644 index 0000000000..be8ef053e6 --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncCloudEndpoint.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/get-Azstoragesynccloudendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Get-AzStorageSyncCloudEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Get-AzStorageSyncCloudEndpoint.md +--- + +# Get-AzStorageSyncCloudEndpoint + +## SYNOPSIS +This command lists all cloud endpoints within a given sync group. + +## SYNTAX + +### StringParameterSet (Default) +``` +Get-AzStorageSyncCloudEndpoint [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> + [-SyncGroupName] <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ObjectParameterSet +``` +Get-AzStorageSyncCloudEndpoint [-ParentObject] <PSSyncGroup> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ParentStringParameterSet +``` +Get-AzStorageSyncCloudEndpoint [-ParentResourceId] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This command lists all cloud endpoints within a given sync group. It can be used to also list the attributes of each cloud endpoint. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzStorageSyncCloudEndpoint -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName" +``` + +This command gets all cloud endpoints contained within the specified sync group. Specify -CloudEndpointName to return a specific one. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the CloudEndpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CloudEndpointName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentObject +StorageSyncService Object, normally passed through the parameter. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSSyncGroup +Parameter Sets: ObjectParameterSet +Aliases: SyncGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +StorageSyncService Object, normally passed through the parameter. + +```yaml +Type: System.String +Parameter Sets: ParentStringParameterSet +Aliases: SyncGroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncGroupName +Name of the SyncGroup. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.StorageSync.Models.PSSyncGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSCloudEndpoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncGroup.md b/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncGroup.md new file mode 100644 index 0000000000..5b5f34604b --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncGroup.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/get-Azstoragesyncgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Get-AzStorageSyncGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Get-AzStorageSyncGroup.md +--- + +# Get-AzStorageSyncGroup + +## SYNOPSIS +This command lists all sync groups within a given storage sync service. + +## SYNTAX + +### StringParameterSet (Default) +``` +Get-AzStorageSyncGroup [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ObjectParameterSet +``` +Get-AzStorageSyncGroup [-ParentObject] <PSStorageSyncService> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ParentStringParameterSet +``` +Get-AzStorageSyncGroup [-ParentResourceId] <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +This command lists all sync groups within a given storage sync service. It can be used to also list the attributes of each sync group. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzStorageSyncGroup -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" +``` + +This command gets all sync groups contained within the specified storage sync service. Specify -Name to return a specific one. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the SyncGroup. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SyncGroupName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentObject +StorageSyncService Object, normally passed through the parameter. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService +Parameter Sets: ObjectParameterSet +Aliases: StorageSyncService + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +StorageSyncService Object, normally passed through the parameter. + +```yaml +Type: System.String +Parameter Sets: ParentStringParameterSet +Aliases: StorageSyncServiceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService + +## OUTPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSSyncGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncServer.md b/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncServer.md new file mode 100644 index 0000000000..4391412fff --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncServer.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/get-Azstoragesyncserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Get-AzStorageSyncServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Get-AzStorageSyncServer.md +--- + +# Get-AzStorageSyncServer + +## SYNOPSIS +This command lists all servers registered to a given storage sync service. + +## SYNTAX + +### StringParameterSet (Default) +``` +Get-AzStorageSyncServer [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> [-ServerId <Guid>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ObjectParameterSet +``` +Get-AzStorageSyncServer [-ParentObject] <PSStorageSyncService> [-ServerId <Guid>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ParentStringParameterSet +``` +Get-AzStorageSyncServer [-ParentResourceId] <String> [-ServerId <Guid>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This command lists all servers registered to a given storage sync service. It can be used to also list the attributes of each registered server. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzStorageSyncServer -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" +``` + +This command gets all servers registered to a specific storage sync service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +StorageSyncService Object, normally passed through the parameter. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService +Parameter Sets: ObjectParameterSet +Aliases: StorageSyncService + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +StorageSyncService Object, normally passed through the parameter. + +```yaml +Type: System.String +Parameter Sets: ParentStringParameterSet +Aliases: StorageSyncServiceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerId +Name of the RegisteredServer. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: RegisteredServerName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService + +### System.Guid + +## OUTPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSRegisteredServer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncServerEndpoint.md b/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncServerEndpoint.md new file mode 100644 index 0000000000..e5cabc4ed1 --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncServerEndpoint.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/get-Azstoragesyncserverendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Get-AzStorageSyncServerEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Get-AzStorageSyncServerEndpoint.md +--- + +# Get-AzStorageSyncServerEndpoint + +## SYNOPSIS +This command lists all server endpoints within a given sync group. + +## SYNTAX + +### StringParameterSet (Default) +``` +Get-AzStorageSyncServerEndpoint [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> + [-SyncGroupName] <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ObjectParameterSet +``` +Get-AzStorageSyncServerEndpoint [-ParentObject] <PSSyncGroup> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ParentStringParameterSet +``` +Get-AzStorageSyncServerEndpoint [-ParentResourceId] <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This command lists all server endpoints within a given sync group. It can be used to also list the attributes of each server endpoint. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzStorageSyncServerEndpoint -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName" +``` + +This command gets all server endpoints contained within the specified sync group. Specify -ServerEndpointName to return a specific one. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the server endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServerEndpointName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentObject +StorageSyncService Object, normally passed through the parameter. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSSyncGroup +Parameter Sets: ObjectParameterSet +Aliases: SyncGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +StorageSyncService Object, normally passed through the parameter. + +```yaml +Type: System.String +Parameter Sets: ParentStringParameterSet +Aliases: SyncGroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SyncGroupName +Name of the SyncGroup. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSSyncGroup + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSServerEndpoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncService.md b/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncService.md new file mode 100644 index 0000000000..29a17dd4a3 --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Get-AzStorageSyncService.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/get-Azstoragesyncservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Get-AzStorageSyncService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Get-AzStorageSyncService.md +--- + +# Get-AzStorageSyncService + +## SYNOPSIS +This command lists all storage sync services within a given scope of subscription/resource group. + +## SYNTAX + +### ParentStringParameterSet (Default) +``` +Get-AzStorageSyncService [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### StringParameterSet +``` +Get-AzStorageSyncService [-ResourceGroupName] <String> [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This command lists all storage sync services within a given scope of subscription/resource group. It can be used to also list the attributes of each storage sync service. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzStorageSyncService -ResourceGroupName "myResourceGroup" +``` + +This command lists all storage sync service resources within a given resource group. It can be used to also list the attributes of each storage sync service. Specify -StorageSyncServiceName to return a specific one. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the storage sync service. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: StorageSyncServiceName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: ParentStringParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Invoke-AzStorageSyncChangeDetection.md b/azps-10.1.0/Az.StorageSync/Invoke-AzStorageSyncChangeDetection.md new file mode 100644 index 0000000000..8c79b23b7a --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Invoke-AzStorageSyncChangeDetection.md @@ -0,0 +1,344 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/az.storagesync/invoke-azstoragesyncchangedetection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Invoke-AzStorageSyncChangeDetection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Invoke-AzStorageSyncChangeDetection.md +--- + +# Invoke-AzStorageSyncChangeDetection + +## SYNOPSIS +This command can be used to manually initiate the detection of namespace changes. It can be targeted to the entire share, subfolder or set of files. When running the command with the -DirectoryPath or -Path parameters, a maximum of 10,000 items can be detected. If the scope of changes is known to you, limit the execution of this command to parts of the namespace, so change detection can finish quickly and within the 10,000 item limit. Alternatively, you can avoid the item limit by running the cmdlet without these parameters, invoking share-level change detection. + +> [!Note] +> If run with -DirectoryPath or -Path parameters, the command will not detect the following changes in the Azure file share: +> - Files that are deleted. +> - Files that are moved out of the share. +> - Files that are deleted and created with the same name. +> +> If share-level change detection is invoked, all of these changes will be detected. These changes will also be detected when the scheduled [change detection job](https://learn.microsoft.com/azure/storage/files/storage-sync-files-troubleshoot?tabs=portal1%2Cazure-portal#afs-change-detection) runs. + +## SYNTAX + +### FullShareStringParameterSet (Default) +``` +Invoke-AzStorageSyncChangeDetection [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> + [-SyncGroupName] <String> -Name <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StringAndDirectoryParameterSet +``` +Invoke-AzStorageSyncChangeDetection [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> + [-SyncGroupName] <String> -Name <String> -DirectoryPath <String> [-Recursive] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StringAndPathParameterSet +``` +Invoke-AzStorageSyncChangeDetection [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> + [-SyncGroupName] <String> -Name <String> -Path <String[]> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdAndDirectoryParameterSet +``` +Invoke-AzStorageSyncChangeDetection [-ResourceId] <String> -DirectoryPath <String> [-Recursive] [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdAndPathParameterSet +``` +Invoke-AzStorageSyncChangeDetection [-ResourceId] <String> -Path <String[]> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FullShareResourceIdParameterSet +``` +Invoke-AzStorageSyncChangeDetection [-ResourceId] <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectAndDirectoryParameterSet +``` +Invoke-AzStorageSyncChangeDetection [-InputObject] <PSCloudEndpoint> -DirectoryPath <String> [-Recursive] + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectAndPathParameterSet +``` +Invoke-AzStorageSyncChangeDetection [-InputObject] <PSCloudEndpoint> -Path <String[]> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FullShareObjectParameterSet +``` +Invoke-AzStorageSyncChangeDetection [-InputObject] <PSCloudEndpoint> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Periodically, Azure File Sync checks the namespace inside a syncing Azure file share for changes that came into the file share by other means than sync. The goal is to identify these changes and ultimately sync them to connected servers. This command can be used to manually initiate the detection of namespaces changes. It can be targeted to the entire share, subfolder or set of files. If the scope of changes is known to you, limit the execution of this command to parts of the namespace, so individual item change detection can finish quickly and within the 10,000 items limit. Otherwise, run the command without the -DirectoryPath or -Path parameters to invoke full share-level change detection. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzStorageSyncChangeDetection -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName" -CloudEndpointName "b38fc242-8100-4807-89d0-399cef5863bf" -Path "Data","Reporting\Templates" +``` + +In this example, change detection is run in the "Data" and "Reporting\Templates" directories of a syncing Azure file share. All paths are relative to the root of the Azure file share namespace. + +### Example 2 +```powershell +Invoke-AzStorageSyncChangeDetection -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName" -CloudEndpointName "b38fc242-8100-4807-89d0-399cef5863bf" -Path "Data\results.xslx","Reporting\Templates\generated.pptx" +``` + +In this example, change detection is run for a set of files that are known to the command caller to have changed. The goal is to have Azure file sync detect and sync these changes as well. + +### Example 3 +```powershell +Invoke-AzStorageSyncChangeDetection -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName" -CloudEndpointName "b38fc242-8100-4807-89d0-399cef5863bf" -DirectoryPath "Examples" -Recursive +``` + +In this example, change detection is run for the "Examples" directory and will recursively detect changes in subdirectories. +Keep in mind the cmdlet will fail if the path contains more than 10,000 items. If the path contains more than 10,000 items, run the command on sub-parts of the namespace. + +### Example 4 +```powershell +Invoke-AzStorageSyncChangeDetection -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName" -CloudEndpointName "b38fc242-8100-4807-89d0-399cef5863bf" +``` + +In this example, neither -DirectoryPath nor -Path has been passed to the command. This will invoke change detection on the entire file share. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectoryPath +Directory where change detection will be performed. + +```yaml +Type: System.String +Parameter Sets: StringAndDirectoryParameterSet, ResourceIdAndDirectoryParameterSet, ObjectAndDirectoryParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CloudEndpoint Object, normally passed through the parameter. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSCloudEndpoint +Parameter Sets: ObjectAndDirectoryParameterSet, ObjectAndPathParameterSet, FullShareObjectParameterSet +Aliases: CloudEndpoint + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the CloudEndpoint. The name is a GUID, not the friendly name that's displayed in the portal. To get the CloudEndpointName, use the Get-AzStorageSyncCloudEndpoint cmdlet. + +```yaml +Type: System.String +Parameter Sets: FullShareStringParameterSet, StringAndDirectoryParameterSet, StringAndPathParameterSet +Aliases: CloudEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +In normal execution, this cmdlet returns no value on success. If you provide the PassThru parameter, then the cmdlet will write a value to the pipeline after successful execution. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Path where change detection will be performed. + +```yaml +Type: System.String[] +Parameter Sets: StringAndPathParameterSet, ResourceIdAndPathParameterSet, ObjectAndPathParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recursive +Indication whether directory change detection is recursive. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: StringAndDirectoryParameterSet, ResourceIdAndDirectoryParameterSet, ObjectAndDirectoryParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: FullShareStringParameterSet, StringAndDirectoryParameterSet, StringAndPathParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +CloudEndpoint Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdAndDirectoryParameterSet, ResourceIdAndPathParameterSet, FullShareResourceIdParameterSet +Aliases: CloudEndpointId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: FullShareStringParameterSet, StringAndDirectoryParameterSet, StringAndPathParameterSet +Aliases: ParentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncGroupName +Name of the SyncGroup. + +```yaml +Type: System.String +Parameter Sets: FullShareStringParameterSet, StringAndDirectoryParameterSet, StringAndPathParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.StorageSync.Models.PSServerEndpoint + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Invoke-AzStorageSyncCompatibilityCheck.md b/azps-10.1.0/Az.StorageSync/Invoke-AzStorageSyncCompatibilityCheck.md new file mode 100644 index 0000000000..b48da76f03 --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Invoke-AzStorageSyncCompatibilityCheck.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/az.storagesync/invoke-azstoragesynccompatibilitycheck +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Invoke-AzStorageSyncCompatibilityCheck.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Invoke-AzStorageSyncCompatibilityCheck.md +--- + +# Invoke-AzStorageSyncCompatibilityCheck + +## SYNOPSIS +Checks for potential compatibility issues between your system and Azure File Sync. + +## SYNTAX + +### PathBased (Default) +``` +Invoke-AzStorageSyncCompatibilityCheck [-Path] <String> [-Credential <PSCredential>] [-SkipSystemChecks] + [-SkipNamespaceChecks] [<CommonParameters>] +``` + +### ComputerNameBased +``` +Invoke-AzStorageSyncCompatibilityCheck [-Credential <PSCredential>] [-ComputerName] <String> + [-SkipSystemChecks] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzStorageSyncCompatibilityCheck** cmdlet checks for potential compatibility issues between your system and Azure File Sync. Given a local or remote path, it performs a set of validations on the system and file namespace, and then returns any compatibility issues it finds. +System checks: +- OS compatibility +File namespace checks: +- Unsupported characters +- Maximum file size +- Maximum path length +- Maximum file length +- Maximum dataset size +- Maximum directory depth + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzStorageSyncCompatibilityCheck C:\DATA +``` + +This command checks the compatibility of the system and also of files and folders in C:\DATA. + +### Example 2 +```powershell +Invoke-AzStorageSyncCompatibilityCheck C:\DATA -SkipSystemChecks +``` + +This command checks the compatibility of files and folders in C:\DATA, but does not perform a system compatibility check. + +### Example 3 +```powershell +$validation = Invoke-AzStorageSyncCompatibilityCheck C:\DATA +$validation.Results | Select-Object -Property Type, Path, Level, Description, Result | Export-Csv -Path C:\results.csv -Encoding utf8 +``` + +This command checks the compatibility of the system and also of files and folders in C:\DATA, and then exports the results as a CSV file to C:\results. + +## PARAMETERS + +### -ComputerName +The computer you are performing this check on. + +```yaml +Type: System.String +Parameter Sets: ComputerNameBased +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Your credentials for the share you are validating. + +```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 +``` + +### -Path +The UNC path of the share you are validating. + +```yaml +Type: System.String +Parameter Sets: PathBased +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipNamespaceChecks +Set this flag to skip file namespace validations and only perform system validations. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: PathBased +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipSystemChecks +Set this flag to skip system validations and only perform file namespace validations. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.StorageSync.Evaluation.Models.PSValidationResult + +## NOTES +* Keywords: azure, Az, arm, resource, management, storagesync, filesync + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/New-AzStorageSyncCloudEndpoint.md b/azps-10.1.0/Az.StorageSync/New-AzStorageSyncCloudEndpoint.md new file mode 100644 index 0000000000..3b528ef340 --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/New-AzStorageSyncCloudEndpoint.md @@ -0,0 +1,263 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/new-Azstoragesynccloudendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/New-AzStorageSyncCloudEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/New-AzStorageSyncCloudEndpoint.md +--- + +# New-AzStorageSyncCloudEndpoint + +## SYNOPSIS +This command creates an Azure File Sync cloud endpoint in a sync group. + +## SYNTAX + +### StringParameterSet (Default) +``` +New-AzStorageSyncCloudEndpoint [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> + [-SyncGroupName] <String> -Name <String> -StorageAccountResourceId <String> -AzureFileShareName <String> + [-StorageAccountTenantId <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ObjectParameterSet +``` +New-AzStorageSyncCloudEndpoint [-ParentObject] <PSSyncGroup> -Name <String> -StorageAccountResourceId <String> + -AzureFileShareName <String> [-StorageAccountTenantId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentStringParameterSet +``` +New-AzStorageSyncCloudEndpoint [-ParentResourceId] <String> -Name <String> -StorageAccountResourceId <String> + -AzureFileShareName <String> [-StorageAccountTenantId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command creates an Azure File Sync cloud endpoint. A cloud endpoint is a reference to an existing Azure file share. It represents the file share and defines it participation in syncing all the files part of the sync group the cloud endpoint has been created in. + +## EXAMPLES + +### Example 1 +```powershell +New-AzStorageSyncCloudEndpoint -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName" -Name "myCloudEndpointName" -StorageAccountResourceId $storageAccountResourceId -AzureFileShareName "myAzureFileShareName" -StorageAccountTenantId "myStorageAccountTenantId" +``` + +A cloud endpoint is an integral member of a sync group, this is an example of creating one inside of an existing sync group called "mySyncGroupName". + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureFileShareName +Storage Account Share Name (Azure file share name) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageAccountShareName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the cloud endpoint. When created through the Azure portal, Name is set to the name of the Azure file share it references. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CloudEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +SyncGroup Object, normally passed through the parameter. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSSyncGroup +Parameter Sets: ObjectParameterSet +Aliases: SyncGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +SyncGroup Parent Resource Id + +```yaml +Type: System.String +Parameter Sets: ParentStringParameterSet +Aliases: SyncGroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +Storage Account Resource Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountTenantId +Storage Account Tenant Id (Company Directory Id) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncGroupName +Name of the SyncGroup. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSSyncGroup + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSCloudEndpoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/New-AzStorageSyncGroup.md b/azps-10.1.0/Az.StorageSync/New-AzStorageSyncGroup.md new file mode 100644 index 0000000000..50c41269a0 --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/New-AzStorageSyncGroup.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/new-Azstoragesyncgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/New-AzStorageSyncGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/New-AzStorageSyncGroup.md +--- + +# New-AzStorageSyncGroup + +## SYNOPSIS +This command creates a new sync group within a specified storage sync service. + +## SYNTAX + +### StringParameterSet (Default) +``` +New-AzStorageSyncGroup [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameterSet +``` +New-AzStorageSyncGroup [-ParentObject] <PSStorageSyncService> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentStringParameterSet +``` +New-AzStorageSyncGroup [-ParentResourceId] <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command creates a new sync group within a specified storage sync service. A sync group is used to describe a topology of locations, referred to as endpoints, that will sync any files stored within any one of the endpoints. A sync group contains cloud endpoints, which reference Azure file shares, and it also contains server endpoints which reference a specific local path on a registered server. + +## EXAMPLES + +### Example 1 +```powershell +New-AzStorageSyncGroup -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -Name "mySyncGroupName" +``` + +This command creates a new sync group within a specified storage sync service. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the SyncGroup. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SyncGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ParentObject +StorageSyncService Object, normally passed through the parameter. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService +Parameter Sets: ObjectParameterSet +Aliases: StorageSyncService + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +StorageSyncService Parent Resource Id + +```yaml +Type: System.String +Parameter Sets: ParentStringParameterSet +Aliases: StorageSyncServiceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService + +## OUTPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSSyncGroup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/New-AzStorageSyncServerEndpoint.md b/azps-10.1.0/Az.StorageSync/New-AzStorageSyncServerEndpoint.md new file mode 100644 index 0000000000..17084e7894 --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/New-AzStorageSyncServerEndpoint.md @@ -0,0 +1,345 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/new-Azstoragesyncserverendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/New-AzStorageSyncServerEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/New-AzStorageSyncServerEndpoint.md +--- + +# New-AzStorageSyncServerEndpoint + +## SYNOPSIS +This command creates a new server endpoint on a registered server. This enables the specified path on the server to start syncing the files with other endpoints in the sync group. + +## SYNTAX + +### StringParameterSet (Default) +``` +New-AzStorageSyncServerEndpoint [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> + [-SyncGroupName] <String> -Name <String> -ServerResourceId <String> -ServerLocalPath <String> [-CloudTiering] + [-VolumeFreeSpacePercent <Int32>] [-TierFilesOlderThanDays <Int32>] [-InitialDownloadPolicy <String>] + [-LocalCacheMode <String>] [-InitialUploadPolicy <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameterSet +``` +New-AzStorageSyncServerEndpoint [-ParentObject] <PSSyncGroup> -Name <String> -ServerResourceId <String> + -ServerLocalPath <String> [-CloudTiering] [-VolumeFreeSpacePercent <Int32>] [-TierFilesOlderThanDays <Int32>] + [-InitialDownloadPolicy <String>] [-LocalCacheMode <String>] [-InitialUploadPolicy <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentStringParameterSet +``` +New-AzStorageSyncServerEndpoint [-ParentResourceId] <String> -Name <String> -ServerResourceId <String> + -ServerLocalPath <String> [-CloudTiering] [-VolumeFreeSpacePercent <Int32>] [-TierFilesOlderThanDays <Int32>] + [-InitialDownloadPolicy <String>] [-LocalCacheMode <String>] [-InitialUploadPolicy <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command creates a new server endpoint on a registered server. This enables the specified path on the server to start syncing the files with other endpoints in the sync group. If there are already files on other endpoints in the sync group and this newly added location also contains files, a reconciliation process will attempt to determine if files are in fact the same ones in the same folders as on other endpoints. The namespaces will merge and reconciliation helps to prevent conflict files. If there are files on other server endpoints it is often better to start with an empty location on this server, so that the files from the cloud come down to the server in an automatic process called fast disaster recovery. Namespace metadata will be synced down first, then the data stream of each file is downloaded. If a file is requested by a user or application out of download order, that file will be recalled with priority to satisfy the access request. You can optionally use cloud tiering on this server endpoint to determine if this endpoint is supposed to become a cache of the complete set of files from the cloud. If cloud tiering is used, then the file content download will stop at the point defined by the cloud tiering policies you can set. + +## EXAMPLES + +### Example 1 +```powershell +$RegisteredServer = Get-AzStorageSyncServer -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" +New-AzStorageSyncServerEndpoint -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName" -Name "myServerEndpointName" -ServerResourceId $RegisteredServer.ResourceId -ServerLocalPath "myServerLocalPath" -CloudTiering -TierFilesOlderThanDays "myTierFilesOlderThanDays" +``` + +This command creates a new server endpoint on a registered server and inserts it into a sync group. THis way it is part of a topology of other endpoints and file metadata and content will immediately start to sync between all locations referenced as endpoints in the sync group. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudTiering +Cloud Tiering Parameter + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialDownloadPolicy +Initial download policy Parameter + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AvoidTieredFiles, NamespaceOnly, NamespaceThenModifiedFiles + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InitialUploadPolicy +Initial upload policy Parameter + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Merge, ServerAuthoritative + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalCacheMode +Local cache mode Parameter + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: DownloadNewAndModifiedFiles, UpdateLocallyCachedFiles + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the ServerEndpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServerEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +SyncGroup Object, normally passed through the parameter. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSSyncGroup +Parameter Sets: ObjectParameterSet +Aliases: SyncGroup + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +SyncGroup Parent Resource Id + +```yaml +Type: System.String +Parameter Sets: ParentStringParameterSet +Aliases: SyncGroupId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerLocalPath +Server Local Path Parameter + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerResourceId +RegisteredServer Resource Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncGroupName +Name of the SyncGroup. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TierFilesOlderThanDays +Tier Files Older Than Days Parameter + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeFreeSpacePercent +Volume Free Space Percent Parameter + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSSyncGroup + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSServerEndpoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/New-AzStorageSyncService.md b/azps-10.1.0/Az.StorageSync/New-AzStorageSyncService.md new file mode 100644 index 0000000000..8f67561462 --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/New-AzStorageSyncService.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/new-Azstoragesyncservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/New-AzStorageSyncService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/New-AzStorageSyncService.md +--- + +# New-AzStorageSyncService + +## SYNOPSIS +This command creates a new storage sync service in a resource group. + +## SYNTAX + +``` +New-AzStorageSyncService [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + [[-IncomingTrafficPolicy] <String>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +A storage sync service is the top level resource for Azure File Sync. This command creates a new storage sync service in a resource group. We recommend to create as few storage sync services as absolutely necessary to differentiate distinct groups of servers in your organization. A storage sync service contains sync groups and also works as a target to register your servers to. A server can only be registered to a single storage sync service. If servers ever need to participate in syncing the same set of files, register them to the same storage sync service. + +## EXAMPLES + +### Example 1 +```powershell +New-AzStorageSyncService -ResourceGroupName "myResourceGroup" -Location "myLocation" -StorageSyncServiceName "myStorageSyncServiceName" -IncomingTrafficPolicy "AllowAllTraffic" +``` + +This command will create a storage sync service. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncomingTrafficPolicy +Storage Sync Service IncomingTrafficPolicy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AllowVirtualNetworksOnly, AllowAllTraffic + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location +Storage Sync Service location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the storage sync service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageSyncServiceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Storage Sync Service Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Register-AzStorageSyncServer.md b/azps-10.1.0/Az.StorageSync/Register-AzStorageSyncServer.md new file mode 100644 index 0000000000..ad8acdf506 --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Register-AzStorageSyncServer.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/register-Azstoragesyncserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Register-AzStorageSyncServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Register-AzStorageSyncServer.md +--- + +# Register-AzStorageSyncServer + +## SYNOPSIS +This command registers a server to a storage sync service which creates a trust relationship. PowerShell or the Azure portal can then be used to configure sync on this server. + +## SYNTAX + +### StringParameterSet (Default) +``` +Register-AzStorageSyncServer [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameterSet +``` +Register-AzStorageSyncServer [-ParentObject] <PSStorageSyncService> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentStringParameterSet +``` +Register-AzStorageSyncServer [-ParentResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command registers a server to a storage sync service, the top-level resource for Azure File Sync. A trust relationship between server and storage sync service is created that ensures secure data transfer and management channels. PowerShell or the Azure portal can then be used to configure what syncs on this server. A server can only be registered to a single storage sync service. If servers ever need to participate in syncing the same set of files, register them to the same storage sync service. +The command must be run locally on the server that is to be registered - either executed directly or via a remote PowerShell session. A remote computer object cannot be accepted. + +## EXAMPLES + +### Example 1 +```powershell +Register-AzStorageSyncServer -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" +``` + +This command will register the local server this command is run on. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +StorageSyncService Object, normally passed through the parameter. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService +Parameter Sets: ObjectParameterSet +Aliases: StorageSyncService + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +StorageSyncService Parent Resource Id + +```yaml +Type: System.String +Parameter Sets: ParentStringParameterSet +Aliases: StorageSyncServiceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService + +## OUTPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSRegisteredServer + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Remove-AzStorageSyncCloudEndpoint.md b/azps-10.1.0/Az.StorageSync/Remove-AzStorageSyncCloudEndpoint.md new file mode 100644 index 0000000000..9e006ec1a5 --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Remove-AzStorageSyncCloudEndpoint.md @@ -0,0 +1,244 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/remove-Azstoragesynccloudendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Remove-AzStorageSyncCloudEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Remove-AzStorageSyncCloudEndpoint.md +--- + +# Remove-AzStorageSyncCloudEndpoint + +## SYNOPSIS +This command will delete the specified cloud endpoint from a sync group. Without at least one cloud endpoint, no other server endpoints in this sync group can sync. + +## SYNTAX + +### StringParameterSet (Default) +``` +Remove-AzStorageSyncCloudEndpoint [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> + [-SyncGroupName] <String> [-Name] <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzStorageSyncCloudEndpoint [-InputObject] <PSCloudEndpoint> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzStorageSyncCloudEndpoint [-ResourceId] <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command will delete the specified cloud endpoint from a sync group. The Azure file share the cloud endpoint references remains untouched by this process. This command is only intended for decommissioning. Removing a cloud endpoint is a destructive operation. Server endpoints cannot sync without at least one cloud endpoint present. This operation should not be performed to solve sync issues. If this Azure file share is added again to the same sync group, as a cloud endpoint, it can lead to conflict files and other unintended consequences. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzStorageSyncCloudEndpoint -Force -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName" -Name "myCloudEndpointName" +``` + +This command will remove the cloud endpoint. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Supply -Force to skip confirmation of this command. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +CloudEndpoint Input Object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSCloudEndpoint +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the CloudEndpoint. To verify the cloud endpoint name, use the Get-AzStorageSyncCloudEndpoint cmdlet, and check the Name property of the returned object. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +In normal execution, this cmdlet returns no value on success. If you provide the PassThru parameter, then the cmdlet will write a value to the pipeline after successful execution. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +CloudEndpoint Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncGroupName +Name of the SyncGroup. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSCloudEndpoint + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Remove-AzStorageSyncGroup.md b/azps-10.1.0/Az.StorageSync/Remove-AzStorageSyncGroup.md new file mode 100644 index 0000000000..3528fd1a8b --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Remove-AzStorageSyncGroup.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/az.storagesync/remove-azstoragesyncgroup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Remove-AzStorageSyncGroup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Remove-AzStorageSyncGroup.md +--- + +# Remove-AzStorageSyncGroup + +## SYNOPSIS +This command will delete the specified sync group. + +## SYNTAX + +### StringParameterSet (Default) +``` +Remove-AzStorageSyncGroup [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> [-Name] <String> + [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzStorageSyncGroup [-InputObject] <PSSyncGroup> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzStorageSyncGroup [-ResourceId] <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command will delete the specified sync group. A sync group can only be removed when all of the contained endpoints are deleted first. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzStorageSyncGroup -Force -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -Name "mySyncGroupName" +``` + +This command will remove the sync group. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Supply -Force to skip confirmation of this command. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +SyncGroup Input Object + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSSyncGroup +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SyncGroup. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: SyncGroupName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +In normal execution, this cmdlet returns no value on success. If you provide the PassThru parameter, then the cmdlet will write a value to the pipeline after successful execution. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +SyncGroup Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSSyncGroup + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Remove-AzStorageSyncServerEndpoint.md b/azps-10.1.0/Az.StorageSync/Remove-AzStorageSyncServerEndpoint.md new file mode 100644 index 0000000000..1b25923e05 --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Remove-AzStorageSyncServerEndpoint.md @@ -0,0 +1,244 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/az.storagesync/remove-azstoragesyncserverendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Remove-AzStorageSyncServerEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Remove-AzStorageSyncServerEndpoint.md +--- + +# Remove-AzStorageSyncServerEndpoint + +## SYNOPSIS +This command will delete the specified server endpoint. Sync to this location will stop immediately. + +## SYNTAX + +### StringParameterSet (Default) +``` +Remove-AzStorageSyncServerEndpoint [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> + [-SyncGroupName] <String> [-Name] <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzStorageSyncServerEndpoint [-InputObject] <PSServerEndpoint> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzStorageSyncServerEndpoint [-ResourceId] <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Removing a server endpoint is a destructive operation. This server location will stop syncing. This operation should not be performed to solve sync issues. If this server location (incl. it's files) is added again to the same sync group as a server endpoint, it can lead to conflict files and other unintended consequences. This command is intended for decommissioning only. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzStorageSyncServerEndpoint -Force -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName" -Name "myServerEndpointName" +``` + +This command will remove the server endpoint. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Supply -Force to skip confirmation of this command. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +ServerEndpoint Input Object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSServerEndpoint +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the ServerEndpoint. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +In normal execution, this cmdlet returns no value on success. If you provide the PassThru parameter, then the cmdlet will write a value to the pipeline after successful execution. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ServerEndpoint Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncGroupName +Name of the SyncGroup. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSServerEndpoint + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Remove-AzStorageSyncService.md b/azps-10.1.0/Az.StorageSync/Remove-AzStorageSyncService.md new file mode 100644 index 0000000000..0676f954cb --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Remove-AzStorageSyncService.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/remove-Azstoragesyncservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Remove-AzStorageSyncService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Remove-AzStorageSyncService.md +--- + +# Remove-AzStorageSyncService + +## SYNOPSIS +This command will delete the specified storage sync service. + +## SYNTAX + +### StringParameterSet (Default) +``` +Remove-AzStorageSyncService [-ResourceGroupName] <String> [-Name] <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzStorageSyncService [-InputObject] <PSStorageSyncService> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Remove-AzStorageSyncService [-ResourceId] <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command will delete the specified storage sync service. A storage sync service can only be removed when all of the contained sync groups and registered servers are deleted first. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzStorageSyncService -Force -ResourceGroupName "myResourceGroup" -Name "myStorageSyncServiceName" +``` + +This command will remove the storage sync service. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Supply -Force to skip confirmation of this command. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +StorageSyncService Input Object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: StorageSyncServiceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +In normal execution, this cmdlet returns no value on success. If you provide the PassThru parameter, then the cmdlet will write a value to the pipeline after successful execution. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +StorageSyncService Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Reset-AzStorageSyncServerCertificate.md b/azps-10.1.0/Az.StorageSync/Reset-AzStorageSyncServerCertificate.md new file mode 100644 index 0000000000..0c9766359e --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Reset-AzStorageSyncServerCertificate.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/reset-Azstoragesyncservercertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Reset-AzStorageSyncServerCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Reset-AzStorageSyncServerCertificate.md +--- + +# Reset-AzStorageSyncServerCertificate + +## SYNOPSIS +Use for troubleshooting only. This command will roll the storage sync server certificate used to describe the server identity to the storage sync service. + +## SYNTAX + +### StringParameterSet (Default) +``` +Reset-AzStorageSyncServerCertificate [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameterSet +``` +Reset-AzStorageSyncServerCertificate [-ParentObject] <PSStorageSyncService> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ParentStringParameterSet +``` +Reset-AzStorageSyncServerCertificate [-ParentResourceId] <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command will roll storage sync server certificate used to describe the server identity to the storage sync service. This is meant for to be used in troubleshooting scenarios. When calling this command, the server certificate is replaced, updating the storage sync service this server is registered with as well, by submitting the public part of the key. Since a new certificate is generated, the expiration time of this cert is also updated. This command can also be used to update an expired certificate. This can happen if a server is offline for an extended period of time. + +## EXAMPLES + +### Example 1 +```powershell +Reset-AzStorageSyncServerCertificate -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" +``` + +This command will roll the local server certificate and inform the corresponding storage sync service of the server's new identity, in a secure way. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentObject +StorageSyncService Object, normally passed through the parameter. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService +Parameter Sets: ObjectParameterSet +Aliases: StorageSyncService + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ParentResourceId +StorageSyncService Parent Resource Id + +```yaml +Type: System.String +Parameter Sets: ParentStringParameterSet +Aliases: StorageSyncServiceId + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +In normal execution, this cmdlet returns no value on success. If you provide the PassThru parameter, then the cmdlet will write a value to the pipeline after successful execution. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Set-AzStorageSyncServerEndpoint.md b/azps-10.1.0/Az.StorageSync/Set-AzStorageSyncServerEndpoint.md new file mode 100644 index 0000000000..e75e89a39c --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Set-AzStorageSyncServerEndpoint.md @@ -0,0 +1,295 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/set-Azstoragesyncserverendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Set-AzStorageSyncServerEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Set-AzStorageSyncServerEndpoint.md +--- + +# Set-AzStorageSyncServerEndpoint + +## SYNOPSIS +This command allows for changes on the adjustable parameters of a server endpoint. + +## SYNTAX + +### StringParameterSet (Default) +``` +Set-AzStorageSyncServerEndpoint [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> + [-SyncGroupName] <String> [-Name] <String> [-CloudTiering] [-VolumeFreeSpacePercent <Int32>] + [-OfflineDataTransfer] [-TierFilesOlderThanDays <Int32>] [-LocalCacheMode <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Set-AzStorageSyncServerEndpoint [-ResourceId] <String> [-CloudTiering] [-VolumeFreeSpacePercent <Int32>] + [-OfflineDataTransfer] [-TierFilesOlderThanDays <Int32>] [-LocalCacheMode <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ObjectParameterSet +``` +Set-AzStorageSyncServerEndpoint [-InputObject] <PSServerEndpoint> [-CloudTiering] + [-VolumeFreeSpacePercent <Int32>] [-OfflineDataTransfer] [-TierFilesOlderThanDays <Int32>] + [-LocalCacheMode <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This command allows for changes on the adjustable parameters of a server endpoint. For instance cloud tiering and cloud tiering policies can be changed at any time. Several aspects of a server endpoint, such as the local path, cannot be changed after the server endpoint had been created. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzStorageSyncServerEndpoint -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName" -Name "myServerEndpointName" -TierFilesOlderThanDays 30 +``` + +This example performs two actions, it sets a new cloud tiering policy on the specified server endpoint, which directs the server to tier all files that have not been accessed in the past 30 days and it also disables the offline data transfer mode, which was initially enabled on this server endpoint during it's creation. Offline data transfer is used as part of interoperability with bulk migration services, such as Azure Data Box. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudTiering +Cloud Tiering Parameter + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SyncGroup Object, normally passed through the parameter. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSServerEndpoint +Parameter Sets: ObjectParameterSet +Aliases: ServerEndpoint + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LocalCacheMode +Local cache mode Parameter + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: DownloadNewAndModifiedFiles, UpdateLocallyCachedFiles + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the ServerEndpoint. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ServerEndpointName + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfflineDataTransfer +Cloud Seeded Data Parameter. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +ServerEndpoint Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncGroupName +Name of the SyncGroup. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TierFilesOlderThanDays +Tier Files Older Than Days Parameter + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeFreeSpacePercent +Volume Free Space Percent Parameter + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.StorageSync.Models.PSServerEndpoint + +## OUTPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSServerEndpoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Set-AzStorageSyncService.md b/azps-10.1.0/Az.StorageSync/Set-AzStorageSyncService.md new file mode 100644 index 0000000000..05802a2df5 --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Set-AzStorageSyncService.md @@ -0,0 +1,214 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/set-Azstoragesyncservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Set-AzStorageSyncService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Set-AzStorageSyncService.md +--- + +# Set-AzStorageSyncService + +## SYNOPSIS +This command sets storage sync service in a resource group. + +## SYNTAX + +### StringParameterSet (Default) +``` +Set-AzStorageSyncService [-ResourceGroupName] <String> [-Name] <String> [[-IncomingTrafficPolicy] <String>] + [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Set-AzStorageSyncService [-InputObject] <PSStorageSyncService> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Set-AzStorageSyncService [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +A storage sync service is the top level resource for Azure File Sync. This command sets storage sync service in a resource group. We recommend to create as few storage sync services as absolutely necessary to differentiate distinct groups of servers in your organization. A storage sync service contains sync groups and also works as a target to register your servers to. A server can only be registered to a single storage sync service. If servers ever need to participate in syncing the same set of files, register them to the same storage sync service. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzStorageSyncService -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -IncomingTrafficPolicy "AllowAllTraffic" +``` + +This command will set a storage sync service. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncomingTrafficPolicy +Storage Sync Service IncomingTrafficPolicy + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: +Accepted values: AllowVirtualNetworksOnly, AllowAllTraffic + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +StorageSyncService Input Object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the storage sync service. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: StorageSyncServiceName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +StorageSyncService Resource Id. + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Storage Sync Service Tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: StringParameterSet +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSStorageSyncService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StorageSync/Unregister-AzStorageSyncServer.md b/azps-10.1.0/Az.StorageSync/Unregister-AzStorageSyncServer.md new file mode 100644 index 0000000000..493f7d7654 --- /dev/null +++ b/azps-10.1.0/Az.StorageSync/Unregister-AzStorageSyncServer.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.StorageSync.dll-Help.xml +Module Name: Az.StorageSync +online version: https://learn.microsoft.com/powershell/module/Az.storagesync/unregister-Azstoragesyncserver +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Unregister-AzStorageSyncServer.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StorageSync/StorageSync/help/Unregister-AzStorageSyncServer.md +--- + +# Unregister-AzStorageSyncServer + +## SYNOPSIS +Warning: Unregistering a server will result in cascading deletes of all server endpoints on this server. This command will unregister a server from it's storage sync service. + +## SYNTAX + +### StringParameterSet (Default) +``` +Unregister-AzStorageSyncServer [-ResourceGroupName] <String> [-StorageSyncServiceName] <String> + [-ServerId] <Guid> [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Unregister-AzStorageSyncServer [-InputObject] <PSRegisteredServer> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResourceIdParameterSet +``` +Unregister-AzStorageSyncServer [-ResourceId] <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command will unregister a server from the storage sync service. Warning: Unregistering a server will result in cascading deletes of all server endpoints on this server. It should only be called when you are certain that no path on this server is to be synced anymore. + +## EXAMPLES + +### Example 1 +```powershell +$RegisteredServer = Get-AzStorageSyncServer -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" +Unregister-AzStorageSyncServer -Force -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -ServerId $RegisteredServer.ServerId +``` + +This command will unregister the server, causing cascading deletes of all server endpoints on this server. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Supply -Force to skip confirmation of this command. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +RegisteredServer Input Object, normally passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.StorageSync.Models.PSRegisteredServer +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +In normal execution, this cmdlet returns no value on success. If you provide the PassThru parameter, then the cmdlet will write a value to the pipeline after successful execution. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +RegisteredServer Resource Id + +```yaml +Type: System.String +Parameter Sets: ResourceIdParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServerId +Name of the RegisteredServer. + +```yaml +Type: System.Guid +Parameter Sets: StringParameterSet +Aliases: RegisteredServerName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSyncServiceName +Name of the StorageSyncService. + +```yaml +Type: System.String +Parameter Sets: StringParameterSet +Aliases: ParentName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.StorageSync.Models.PSRegisteredServer + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.StreamAnalytics/Az.StreamAnalytics.md b/azps-10.1.0/Az.StreamAnalytics/Az.StreamAnalytics.md new file mode 100644 index 0000000000..c964981f81 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Az.StreamAnalytics.md @@ -0,0 +1,121 @@ +--- +Module Name: Az.StreamAnalytics +Module Guid: f3678192-db41-439b-99e7-6fda95f6c601 +Download Help Link: https://learn.microsoft.com/powershell/module/az.streamanalytics +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Az.StreamAnalytics.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Az.StreamAnalytics.md +--- + +# Az.StreamAnalytics Module +## Description +Microsoft Azure PowerShell: StreamAnalytics cmdlets + +## Az.StreamAnalytics Cmdlets +### [Get-AzStreamAnalyticsCluster](Get-AzStreamAnalyticsCluster.md) +Gets information about the specified cluster. + +### [Get-AzStreamAnalyticsClusterStreamingJob](Get-AzStreamAnalyticsClusterStreamingJob.md) +Lists all of the streaming jobs in the given cluster. + +### [Get-AzStreamAnalyticsDefaultFunctionDefinition](Get-AzStreamAnalyticsDefaultFunctionDefinition.md) +Retrieves the default definition of a function based on the parameters specified. + +### [Get-AzStreamAnalyticsFunction](Get-AzStreamAnalyticsFunction.md) +Gets details about the specified function. + +### [Get-AzStreamAnalyticsInput](Get-AzStreamAnalyticsInput.md) +Gets details about the specified input. + +### [Get-AzStreamAnalyticsJob](Get-AzStreamAnalyticsJob.md) +Gets details about the specified streaming job. + +### [Get-AzStreamAnalyticsOutput](Get-AzStreamAnalyticsOutput.md) +Gets details about the specified output. + +### [Get-AzStreamAnalyticsQuota](Get-AzStreamAnalyticsQuota.md) +Retrieves the subscription's current quota information in a particular region. + +### [Get-AzStreamAnalyticsTransformation](Get-AzStreamAnalyticsTransformation.md) +Gets details about the specified transformation. + +### [New-AzStreamAnalyticsCluster](New-AzStreamAnalyticsCluster.md) +Creates a Stream Analytics Cluster or replaces an already existing cluster. + +### [New-AzStreamAnalyticsFunction](New-AzStreamAnalyticsFunction.md) +Creates a function or replaces an already existing function under an existing streaming job. + +### [New-AzStreamAnalyticsInput](New-AzStreamAnalyticsInput.md) +Creates an input or replaces an already existing input under an existing streaming job. + +### [New-AzStreamAnalyticsJob](New-AzStreamAnalyticsJob.md) +Creates a streaming job or replaces an already existing streaming job. + +### [New-AzStreamAnalyticsOutput](New-AzStreamAnalyticsOutput.md) +Creates an output or replaces an already existing output under an existing streaming job. + +### [New-AzStreamAnalyticsTransformation](New-AzStreamAnalyticsTransformation.md) +Creates a transformation or replaces an already existing transformation under an existing streaming job. + +### [Remove-AzStreamAnalyticsCluster](Remove-AzStreamAnalyticsCluster.md) +Deletes the specified cluster. + +### [Remove-AzStreamAnalyticsFunction](Remove-AzStreamAnalyticsFunction.md) +Deletes a function from the streaming job. + +### [Remove-AzStreamAnalyticsInput](Remove-AzStreamAnalyticsInput.md) +Deletes an input from the streaming job. + +### [Remove-AzStreamAnalyticsJob](Remove-AzStreamAnalyticsJob.md) +Deletes a streaming job. + +### [Remove-AzStreamAnalyticsOutput](Remove-AzStreamAnalyticsOutput.md) +Deletes an output from the streaming job. + +### [Start-AzStreamAnalyticsJob](Start-AzStreamAnalyticsJob.md) +Starts a streaming job. +Once a job is started it will start processing input events and produce output. + +### [Stop-AzStreamAnalyticsJob](Stop-AzStreamAnalyticsJob.md) +Stops a running streaming job. +This will cause a running streaming job to stop processing input events and producing output. + +### [Test-AzStreamAnalyticsFunction](Test-AzStreamAnalyticsFunction.md) +Tests if the information provided for a function is valid. +This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct. + +### [Test-AzStreamAnalyticsInput](Test-AzStreamAnalyticsInput.md) +Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service. + +### [Test-AzStreamAnalyticsOutput](Test-AzStreamAnalyticsOutput.md) +Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service. + +### [Update-AzStreamAnalyticsCluster](Update-AzStreamAnalyticsCluster.md) +Updates an existing cluster. +This can be used to partially update (ie. +update one or two properties) a cluster without affecting the rest of the cluster definition. + +### [Update-AzStreamAnalyticsFunction](Update-AzStreamAnalyticsFunction.md) +Updates an existing function under an existing streaming job. +This can be used to partially update (ie. +update one or two properties) a function without affecting the rest the job or function definition. + +### [Update-AzStreamAnalyticsInput](Update-AzStreamAnalyticsInput.md) +Updates an existing input under an existing streaming job. +This can be used to partially update (ie. +update one or two properties) an input without affecting the rest the job or input definition. + +### [Update-AzStreamAnalyticsJob](Update-AzStreamAnalyticsJob.md) +Creates a streaming job or replaces an already existing streaming job. + +### [Update-AzStreamAnalyticsOutput](Update-AzStreamAnalyticsOutput.md) +Updates an existing output under an existing streaming job. +This can be used to partially update (ie. +update one or two properties) an output without affecting the rest the job or output definition. + +### [Update-AzStreamAnalyticsTransformation](Update-AzStreamAnalyticsTransformation.md) +Updates an existing transformation under an existing streaming job. +This can be used to partially update (ie. +update one or two properties) a transformation without affecting the rest the job or transformation definition. + diff --git a/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsCluster.md b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsCluster.md new file mode 100644 index 0000000000..e6f382d6eb --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsCluster.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/get-azstreamanalyticscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsCluster.md +--- + +# Get-AzStreamAnalyticsCluster + +## SYNOPSIS +Gets information about the specified cluster. + +## SYNTAX + +### List (Default) +``` +Get-AzStreamAnalyticsCluster [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzStreamAnalyticsCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStreamAnalyticsCluster -InputObject <IStreamAnalyticsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzStreamAnalyticsCluster -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets information about the specified cluster. + +## EXAMPLES + +### Example 1: Get all the stream analytics clusters under a subscription +```powershell +Get-AzStreamAnalyticsCluster +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +West Central US sac-m-test01 Microsoft.StreamAnalytics/clusters 77ba5ccb-3005-40b6-b9ac-3ae9d7fb21c9 +``` + +This command gets all the stream analytics clusters under a subscription. + +### Example 2: Get all the stream analytics clusters under a resource group +```powershell +Get-AzStreamAnalyticsCluster -ResourceGroupName pwshaz-rg-test +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +West Central US sac-m-test01 Microsoft.StreamAnalytics/clusters c2bcffd8-b35d-430b-9759-13af9c18ed72 +``` + +This command gets all the stream analytics clusters under a resource group. + +### Example 3: Get a stream analytics cluster by name +```powershell +Get-AzStreamAnalyticsCluster -ResourceGroupName pwshaz-rg-test -Name sac-m-test01 +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +West Central US sac-m-test01 Microsoft.StreamAnalytics/clusters c2bcffd8-b35d-430b-9759-13af9c18ed72 +``` + +This command gets a stream analytics cluster by name. + +### Example 4: Get a stream analytics cluster by pipeline +```powershell +Get-AzStreamAnalyticsCluster -ResourceGroupName pwshaz-rg-test -Name sac-m-test01 | Get-AzStreamAnalyticsCluster +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +West Central US sac-m-test01 Microsoft.StreamAnalytics/clusters c2bcffd8-b35d-430b-9759-13af9c18ed72 +``` + +This command gets a stream analytics cluster by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20200301Preview.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 `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsClusterStreamingJob.md b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsClusterStreamingJob.md new file mode 100644 index 0000000000..d7ca1ddac7 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsClusterStreamingJob.md @@ -0,0 +1,147 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/get-azstreamanalyticsclusterstreamingjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsClusterStreamingJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsClusterStreamingJob.md +--- + +# Get-AzStreamAnalyticsClusterStreamingJob + +## SYNOPSIS +Lists all of the streaming jobs in the given cluster. + +## SYNTAX + +``` +Get-AzStreamAnalyticsClusterStreamingJob -ClusterName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Lists all of the streaming jobs in the given cluster. + +## EXAMPLES + +### Example 1: Get all jobs under the stream analytics cluster +```powershell +Get-AzStreamAnalyticsClusterStreamingJob -ResourceGroupName pwshaz-rg-test -ClusterName sac-m-test01 +``` +```output +JobState StreamingUnit +-------- ------------- +Created 3 +``` + +This command gets all jobs under the stream analytics cluster + +## PARAMETERS + +### -ClusterName +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20200301Preview.IClusterJob + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsDefaultFunctionDefinition.md b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsDefaultFunctionDefinition.md new file mode 100644 index 0000000000..add732bcc9 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsDefaultFunctionDefinition.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/get-azstreamanalyticsdefaultfunctiondefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsDefaultFunctionDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsDefaultFunctionDefinition.md +--- + +# Get-AzStreamAnalyticsDefaultFunctionDefinition + +## SYNOPSIS +Retrieves the default definition of a function based on the parameters specified. + +## SYNTAX + +``` +Get-AzStreamAnalyticsDefaultFunctionDefinition -BindingType <String> -Endpoint <String> -JobName <String> + -Name <String> -ResourceGroupName <String> -UdfType <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the default definition of a function based on the parameters specified. + +## EXAMPLES + +### Example 1: Get the default definition of a Stream Analytics function +```powershell +Get-AzStreamAnalyticsDefaultFunctionDefinition -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name mlsfunction-01 -BindingType Microsoft.MachineLearningServices -Endpoint "http://875da830-4d5f-44f1-b221-718a5f26a21d.eastus.azurecontainer.io/score"-UdfType Scalar +``` +```output +Name Type ETag +---- ---- ---- +mlsfunction-01 +``` + +This command gets the default definition of the function. + +## PARAMETERS + +### -BindingType +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the function. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UdfType +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IFunctionRetrieveDefaultDefinitionParameters + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IFunction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsFunction.md b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsFunction.md new file mode 100644 index 0000000000..4621ba3055 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsFunction.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/get-azstreamanalyticsfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsFunction.md +--- + +# Get-AzStreamAnalyticsFunction + +## SYNOPSIS +Gets details about the specified function. + +## SYNTAX + +### List (Default) +``` +Get-AzStreamAnalyticsFunction -JobName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Select <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzStreamAnalyticsFunction -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStreamAnalyticsFunction -InputObject <IStreamAnalyticsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets details about the specified function. + +## EXAMPLES + +### Example 1: Get all Stream Analytics functions +```powershell +Get-AzStreamAnalyticsFunction -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh +``` +```output +Name Type ETag +---- ---- ---- +function-01 Microsoft.StreamAnalytics/streamingjobs/functions +``` + +This command gets the functions defined on the job. + +### Example 2: Get a specific Stream Analytics function +```powershell +Get-AzStreamAnalyticsFunction -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name function-01 +``` +```output +Name Type ETag +---- ---- ---- +function-01 Microsoft.StreamAnalytics/streamingjobs/functions e35beaf1-8c6c-4b26-bafe-733835510f49 +``` + +This command gets information about the function defined on the job. + +### Example 3: Get a specific Stream Analytics function by pipeline +```powershell +New-AzStreamAnalyticsFunction -ResourceGroupName azure-rg-test -JobName sajob-01-portal -Name function-05 -File .\test\template-json\Function_JavascriptUdf.json | Get-AzStreamAnalyticsFunction +``` +```output +Name Type ETag +---- ---- ---- +function-05 Microsoft.StreamAnalytics/streamingjobs/functions e35beaf1-8c6c-4b26-bafe-733835510f49 +``` + +This command gets information about the function defined on the job. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the function. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: FunctionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +The $select OData query parameter. +This is a comma-separated list of structural properties to include in the response, or "*" to include all properties. +By default, all properties are returned except diagnostics. +Currently only accepts '*' as a valid value. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IFunction + +## 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 `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsInput.md b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsInput.md new file mode 100644 index 0000000000..ad5246d734 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsInput.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/get-azstreamanalyticsinput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsInput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsInput.md +--- + +# Get-AzStreamAnalyticsInput + +## SYNOPSIS +Gets details about the specified input. + +## SYNTAX + +### List (Default) +``` +Get-AzStreamAnalyticsInput -JobName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Select <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzStreamAnalyticsInput -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStreamAnalyticsInput -InputObject <IStreamAnalyticsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets details about the specified input. + +## EXAMPLES + +### Example 1: Get information about the inputs defined on a job +```powershell +Get-AzStreamAnalyticsInput -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh +``` +```output +Name Type ETag +---- ---- ---- +input-01 Microsoft.StreamAnalytics/streamingjobs/inputs +``` + +This command returns information about all the inputs defined on the job StreamingJob. + +### Example 2: Get information about a specific input defined on a job +```powershell +Get-AzStreamAnalyticsInput -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name input-01 +``` +```output +Name Type ETag +---- ---- ---- +input-01 Microsoft.StreamAnalytics/streamingjobs/inputs c3e34ed5-4f82-482e-a4a4-25520ca89098 +``` + +This command returns information about the input named EntryStream defined on the job StreamingJob. + +### Example 3: Get information about a specific input defined on a job by pipeline +```powershell +New-AzStreamAnalyticsInput -ResourceGroupName azure-rg-test -JobName sajob-01-portal -Name input-05 -File .\test\template-json\IotHub.json | Get-AzStreamAnalyticsInput +``` +```output +Name Type ETag +---- ---- ---- +input-05 Microsoft.StreamAnalytics/streamingjobs/inputs abb81160-d9e1-4729-9b3a-5af04bd880c6 +``` + +This command returns information about the input named EntryStream defined on the job StreamingJob. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the input. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: InputName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +The $select OData query parameter. +This is a comma-separated list of structural properties to include in the response, or "*" to include all properties. +By default, all properties are returned except diagnostics. +Currently only accepts '*' as a valid value. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IInput + +## 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 `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsJob.md b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsJob.md new file mode 100644 index 0000000000..a05be09341 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsJob.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/get-azstreamanalyticsjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsJob.md +--- + +# Get-AzStreamAnalyticsJob + +## SYNOPSIS +Gets details about the specified streaming job. + +## SYNTAX + +### List1 (Default) +``` +Get-AzStreamAnalyticsJob [-SubscriptionId <String[]>] [-Expand <String>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzStreamAnalyticsJob -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Expand <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStreamAnalyticsJob -InputObject <IStreamAnalyticsIdentity> [-Expand <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzStreamAnalyticsJob -ResourceGroupName <String> [-SubscriptionId <String[]>] [-Expand <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets details about the specified streaming job. + +## EXAMPLES + +### Example 1: Get information about all jobs in a subscription +```powershell +Get-AzStreamAnalyticsJob +``` +```output +Location Name Type ETag +-------- ---- ---- ---- +West Central US sajob-02-pwsh Microsoft.StreamAnalytics/streamingjobs +West Central US sajob-01-pwsh Microsoft.StreamAnalytics/streamingjobs +``` + +This command returns information about all the Stream Analytics jobs in the Azure subscription. + +### Example 2: Get information about all jobs in a resource group +```powershell +Get-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test +``` +```output +Location Name Type ETag +-------- ---- ---- ---- +West Central US sajob-02-pwsh Microsoft.StreamAnalytics/streamingjobs +West Central US sajob-01-pwsh Microsoft.StreamAnalytics/streamingjobs +``` + +This command returns information about all the Stream Analytics jobs in the resource group. + +### Example 3: Get information about a specific job in a resource group +```powershell +Get-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-02-pwsh +``` +```output +Location Name Type ETag +-------- ---- ---- ---- +West Central US sajob-02-pwsh Microsoft.StreamAnalytics/streamingjobs ac26a506-a4cb-4a7d-9ec8-c3149b8589bd +``` + +This command returns information about the Stream Analytics job StreamingJob in the resource group. + +### Example 4: Get information about a specific job in a resource group by pipeline +```powershell +New-AzStreamAnalyticsJob -ResourceGroupName lucas-rg-test -Name sajob-02-pwsh -Location westcentralus -SkuName Standard | Get-AzStreamAnalyticsJob +``` +```output +Location Name Type ETag +-------- ---- ---- ---- +West Central US sajob-02-pwsh Microsoft.StreamAnalytics/streamingjobs ac26a506-a4cb-4a7d-9ec8-c3149b8589bd +``` + +This command returns information about the Stream Analytics job StreamingJob in the resource group. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +The $expand OData query parameter. +This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. +The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IStreamingJob + +## 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 `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsOutput.md b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsOutput.md new file mode 100644 index 0000000000..8acb9efe45 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsOutput.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/get-azstreamanalyticsoutput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsOutput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsOutput.md +--- + +# Get-AzStreamAnalyticsOutput + +## SYNOPSIS +Gets details about the specified output. + +## SYNTAX + +### List (Default) +``` +Get-AzStreamAnalyticsOutput -JobName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Select <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzStreamAnalyticsOutput -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStreamAnalyticsOutput -InputObject <IStreamAnalyticsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets details about the specified output. + +## EXAMPLES + +### Example 1: Get information about job outputs +```powershell +Get-AzStreamAnalyticsOutput -ResourceGroupName azure-rg-test -JobName sajob-02-pwsh +``` +```output +Name Type ETag +---- ---- ---- +output-01 Microsoft.StreamAnalytics/streamingjobs/outputs +``` + +This command returns information about the outputs defined on the job. + +### Example 2: Get information about a specific job output +```powershell +Get-AzStreamAnalyticsOutput -ResourceGroupName azure-rg-test -JobName sajob-02-pwsh -Name output-01 +``` +```output +Name Type ETag +---- ---- ---- +output-01 Microsoft.StreamAnalytics/streamingjobs/outputs 3819fb65-07f5-4dc3-83e1-d3149596f8d0 +``` + +This command returns information about the output defined on the job. + +### Example 3: Get information about a specific job output by pipeline +```powershell +New-AzStreamAnalyticsOutput -ResourceGroupName azure-rg-test -JobName sajob-01-portal -Name output-05 -File .\test\template-json\StroageAccount.json | Get-AzStreamAnalyticsOutput +``` +```output +Name Type ETag +---- ---- ---- +output-05 Microsoft.StreamAnalytics/streamingjobs/outputs 3a11e210-2a7f-4856-8d5a-25d4ecabee06 +``` + +This command returns information about the output defined on the job. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the output. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: OutputName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Select +The $select OData query parameter. +This is a comma-separated list of structural properties to include in the response, or "*" to include all properties. +By default, all properties are returned except diagnostics. +Currently only accepts '*' as a valid value. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IOutput + +## 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 `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsQuota.md b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsQuota.md new file mode 100644 index 0000000000..9fd85509b3 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsQuota.md @@ -0,0 +1,102 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/get-azstreamanalyticsquota +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsQuota.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsQuota.md +--- + +# Get-AzStreamAnalyticsQuota + +## SYNOPSIS +Retrieves the subscription's current quota information in a particular region. + +## SYNTAX + +``` +Get-AzStreamAnalyticsQuota -Location <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Retrieves the subscription's current quota information in a particular region. + +## EXAMPLES + +### Example 1: Get information about the Streaming Unit quota for a region +```powershell +Get-AzStreamAnalyticsQuota -Location 'WestCentralUS' +``` +```output +Name Type +---- ---- +StreamingUnits Microsoft.StreamAnalytics/quotas +StreamingClusters Microsoft.StreamAnalytics/quotas +``` + +This command returns information about Streaming Unit quota and usage in the WestCentralUS region. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The region in which to retrieve the subscription's quota information. +You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.ISubscriptionQuota + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsTransformation.md b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsTransformation.md new file mode 100644 index 0000000000..5cd5567bef --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Get-AzStreamAnalyticsTransformation.md @@ -0,0 +1,185 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/get-azstreamanalyticstransformation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsTransformation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Get-AzStreamAnalyticsTransformation.md +--- + +# Get-AzStreamAnalyticsTransformation + +## SYNOPSIS +Gets details about the specified transformation. + +## SYNTAX + +### Get (Default) +``` +Get-AzStreamAnalyticsTransformation -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStreamAnalyticsTransformation -InputObject <IStreamAnalyticsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets details about the specified transformation. + +## EXAMPLES + +### Example 1: Get information about a Stream Analytics transformation +```powershell +Get-AzStreamAnalyticsTransformation -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name tranf-01 +``` +```output +Name Type ETag +---- ---- ---- +tranf-01 Microsoft.StreamAnalytics/streamingjobs/transformations ec0c7238-6bb2-4dad-b2cf-04c6a9285f4d +``` + +This command returns information about the transformation on the job. + +### Example 2: Get information about a Stream Analytics transformation by pipeline +```powershell + New-AzStreamAnalyticsTransformation -ResourceGroupName azure-rg-test -JobName sajob-01-portal -Name tranf-01 -StreamingUnit 6 -Query "Select Id, Name from input-01" | Get-AzStreamAnalyticsTransformation +``` +```output +Name Type ETag +---- ---- ---- +tranf-01 Microsoft.StreamAnalytics/streamingjobs/transformations ec0c7238-6bb2-4dad-b2cf-04c6a9285f4d +``` + +This command returns information about the transformation on the job. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the transformation. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: TransformationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.ITransformation + +## 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 `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsCluster.md b/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsCluster.md new file mode 100644 index 0000000000..5865970fac --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsCluster.md @@ -0,0 +1,275 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/new-azstreamanalyticscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/New-AzStreamAnalyticsCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/New-AzStreamAnalyticsCluster.md +--- + +# New-AzStreamAnalyticsCluster + +## SYNOPSIS +Creates a Stream Analytics Cluster or replaces an already existing cluster. + +## SYNTAX + +``` +New-AzStreamAnalyticsCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IfMatch <String>] [-IfNoneMatch <String>] [-Location <String>] [-SkuCapacity <Int32>] + [-SkuName <ClusterSkuName>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a Stream Analytics Cluster or replaces an already existing cluster. + +## EXAMPLES + +### Example 1: Create a new stream analytics cluster +```powershell +New-AzStreamAnalyticsCluster -ResourceGroupName pwshaz-rg-test -Name sac-ps-test01 -Location "West Central US" -SkuName "Default" -SkuCapacity 36 +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +West Central US sac-ps-test01 Microsoft.StreamAnalytics/clusters +``` + +This command creates a new stream analytics cluster. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the resource. +Omit this value to always overwrite the current record set. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new resource to be created, but to prevent updating an existing record set. +Other values will result in a 412 Pre-condition Failed response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Denotes the number of streaming units the cluster can support. +Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. +Required on PUT (CreateOrUpdate) requests. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Specifies the SKU name of the cluster. +Required on PUT (CreateOrUpdate) requests. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Support.ClusterSkuName +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20200301Preview.ICluster + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsFunction.md b/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsFunction.md new file mode 100644 index 0000000000..68d208d28d --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsFunction.md @@ -0,0 +1,294 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/new-azstreamanalyticsfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/New-AzStreamAnalyticsFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/New-AzStreamAnalyticsFunction.md +--- + +# New-AzStreamAnalyticsFunction + +## SYNOPSIS +Creates a function or replaces an already existing function under an existing streaming job. + +## SYNTAX + +``` +New-AzStreamAnalyticsFunction -File <String> -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-IfNoneMatch <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a function or replaces an already existing function under an existing streaming job. + +## EXAMPLES + +### Example 1: Create a Stream Analytics function +```powershell +New-AzStreamAnalyticsFunction -ResourceGroupName azure-rg-test -JobName sajob-02-pwsh -Name function-01 -File .\test\template-json\Function_JavascriptUdf.json +``` +```output +Name Type ETag +---- ---- ---- +function-01 Microsoft.StreamAnalytics/streamingjobs/functions 7bbd6ccd-c7a4-4910-b2ae-a3eae19d9b18 + +``` + +This command creates a function from the file Function_JavascriptUdf.json. + +(below is an example for "Function_JavascriptUdf.json") +{ + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "any" + }, + { + "dataType": "any" + } + ], + "output": { + "dataType": "any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "// Sample UDF which returns sum of two values.\nfunction main(arg3, arg4) {\n return arg1 + arg2;\n}" + } + } + } + } +} + +### Example 2: Create a Stream Analytics function +```powershell +New-AzStreamAnalyticsFunction -ResourceGroupName azure-rg-test -JobName sajob-02-pwsh -Name function-01 -File .\test\template-json\MachineLearningServices.json +``` +```output +Name Type ETag +---- ---- ---- +function-01 Microsoft.StreamAnalytics/streamingjobs/functions 7bbd6ccd-c7a4-4910-b2ae-a3eae19d9b18 +``` + +This command creates a function from the file MachineLearningServices.json. + +(below is an example for "MachineLearningServices.json") +{ + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "record" + } + ], + "output": { + "dataType": "bigint" + }, + "binding": { + "type": "Microsoft.MachineLearningServices", + "properties": { + "endpoint": "http://xxxxxxxxxxxxxxxxxxx.eastus.azurecontainer.io/score", + "inputs": [ + { + "name": "data", + "dataType": "object", + "mapTo": 0 + } + ], + "outputs": [ + { + "name": "output", + "dataType": "int64", + "mapTo": 0 + } + ], + "batchSize": 10000, + "numberOfParallelRequests": 1 + } + } + } + } +} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the function. +Omit this value to always overwrite the current function. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new function to be created, but to prevent updating an existing function. +Other values will result in a 412 Pre-condition Failed response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the function. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FunctionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IFunction + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IFunction + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsInput.md b/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsInput.md new file mode 100644 index 0000000000..883b4d5a5c --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsInput.md @@ -0,0 +1,281 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/new-azstreamanalyticsinput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/New-AzStreamAnalyticsInput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/New-AzStreamAnalyticsInput.md +--- + +# New-AzStreamAnalyticsInput + +## SYNOPSIS +Creates an input or replaces an already existing input under an existing streaming job. + +## SYNTAX + +``` +New-AzStreamAnalyticsInput -File <String> -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-IfNoneMatch <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an input or replaces an already existing input under an existing streaming job. + +## EXAMPLES + +### Example 1: Create a job input with a definition from a file +```powershell +New-AzStreamAnalyticsInput -ResourceGroupName azure-rg-test -JobName sajob-02-pwsh -Name input-01 -File .\test\template-json\EventHub.json +``` +```output +Name Type ETag +---- ---- ---- +input-01 Microsoft.StreamAnalytics/streamingjobs/inputs 6c9f5122-44b9-45bf-81c9-5349a9dd8851 +``` + +This command creates an input from the file EventHub.json. + +(below is an example for "EventHub.json") +{ + "properties": { + "type": "Stream", + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "compression": { + "type": "None" + }, + "datasource": { + "type": "Microsoft.EventHub/EventHub", + "properties": { + "serviceBusNamespace": "xxxxxxxxxxxxxx", + "sharedAccessPolicyName": "xxxxxxxxxxxxxxxx", + "sharedAccessPolicyKey": "xxxxxxxxxxxxxxxxxxxxxx", + "authenticationMode": "ConnectionString", + "eventHubName": "xxxxxxxxxxxxxxxx", + "consumerGroupName": "xxxxxxxxxxxxxxxx" + } + } + } +} + +### Example 2: Create a job input with a definition from a file +```powershell +New-AzStreamAnalyticsInput -ResourceGroupName azure-rg-test -JobName sajob-02-pwsh -Name input-01 -File .\test\template-json\IotHub.json +``` +```output +Name Type ETag +---- ---- ---- +input-01 Microsoft.StreamAnalytics/streamingjobs/inputs 6c9f5122-44b9-45bf-81c9-5349a9dd8851 +``` + +This command creates an input from the file IotHub.json. + +(below is an example for "IotHub.json") +{ + "properties": { + "type": "Stream", + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "compression": { + "type": "None" + }, + "partitionKey": "", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "xxxxxxxxxxx", + "sharedAccessPolicyName": "xxxxxxxxxxxxxx", + "sharedAccessPolicyKey": "xxxxxxxxxxxxxxxxx", + "consumerGroupName": "$Default", + "endpoint": "messages/events" + } + } + } +} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the input. +Omit this value to always overwrite the current input. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new input to be created, but to prevent updating an existing input. +Other values will result in a 412 Pre-condition Failed response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the input. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: InputName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IInput + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IInput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsJob.md b/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsJob.md new file mode 100644 index 0000000000..759906589f --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsJob.md @@ -0,0 +1,373 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/new-azstreamanalyticsjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/New-AzStreamAnalyticsJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/New-AzStreamAnalyticsJob.md +--- + +# New-AzStreamAnalyticsJob + +## SYNOPSIS +Creates a streaming job or replaces an already existing streaming job. + +## SYNTAX + +``` +New-AzStreamAnalyticsJob -Name <String> -ResourceGroupName <String> -Location <String> + -SkuName <StreamingJobSkuName> [-SubscriptionId <String>] [-IfMatch <String>] [-IfNoneMatch <String>] + [-ClusterId <String>] [-CompatibilityLevel <CompatibilityLevel>] [-DataLocale <String>] + [-EventsLateArrivalMaxDelayInSecond <Int32>] [-EventsOutOfOrderMaxDelayInSecond <Int32>] + [-EventsOutOfOrderPolicy <EventsOutOfOrderPolicy>] [-OutputErrorPolicy <OutputErrorPolicy>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a streaming job or replaces an already existing streaming job. + +## EXAMPLES + +### Example 1: Create a stream analytics job +```powershell +New-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-02-pwsh -Location westcentralus -SkuName Standard +``` +```output +Location Name Type ETag +-------- ---- ---- ---- +West Central US sajob-02-pwsh Microsoft.StreamAnalytics/streamingjobs a687c464-82ce-45cc-b88a-1f72ba2b1dc2 +``` + +This command creates a stream analytics job. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterId +The resource id of cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompatibilityLevel +Controls certain runtime behaviors of the streaming job. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Support.CompatibilityLevel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataLocale +The data locale of the stream analytics job. +Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. +Defaults to 'en-US' if none specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventsLateArrivalMaxDelayInSecond +The maximum tolerable delay in seconds where events arriving late could be included. +Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely. +If the property is absent, it is interpreted to have a value of -1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventsOutOfOrderMaxDelayInSecond +The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventsOutOfOrderPolicy +Indicates the policy to apply to events that arrive out of order in the input event stream. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Support.EventsOutOfOrderPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the streaming job. +Omit this value to always overwrite the current record set. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new streaming job to be created, but to prevent updating an existing record set. +Other values will result in a 412 Pre-condition Failed response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputErrorPolicy +Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Support.OutputErrorPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. +Required on PUT (CreateOrReplace) requests. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Support.StreamingJobSkuName +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IStreamingJob + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IStreamingJob + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsOutput.md b/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsOutput.md new file mode 100644 index 0000000000..e6bf27968e --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsOutput.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/new-azstreamanalyticsoutput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/New-AzStreamAnalyticsOutput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/New-AzStreamAnalyticsOutput.md +--- + +# New-AzStreamAnalyticsOutput + +## SYNOPSIS +Creates an output or replaces an already existing output under an existing streaming job. + +## SYNTAX + +``` +New-AzStreamAnalyticsOutput -File <String> -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-IfNoneMatch <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates an output or replaces an already existing output under an existing streaming job. + +## EXAMPLES + +### Example 1: Create an output to a stream analytics job +```powershell +New-AzStreamAnalyticsOutput -ResourceGroupName azure-rg-test -JobName sajob-02-pwsh -Name output-01 -File .\test\template-json\StroageAccount.json +``` +```output +Name Type ETag +---- ---- ---- +output-01 Microsoft.StreamAnalytics/streamingjobs/outputs 3819fb65-07f5-4dc3-83e1-d3149596f8d0 +``` + +This command creates a new output in the stream analytics job. + +(below is an example for "StroageAccount.json") +{ + "properties": { + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + }, + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "xxxxxxxxxxxxxxx", + "accountKey": "xxxxxxxxxxxxxxxx" + } + ], + "container": "xxxxxxxxxxxxxxxxxxxx", + "pathPattern": "cluster1/{client_id}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH", + "authenticationMode": "ConnectionString" + } + } + } +} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the output. +Omit this value to always overwrite the current output. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new output to be created, but to prevent updating an existing output. +Other values will result in a 412 Pre-condition Failed response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the output. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: OutputName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IOutput + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IOutput + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsTransformation.md b/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsTransformation.md new file mode 100644 index 0000000000..a62140c6d4 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/New-AzStreamAnalyticsTransformation.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/new-azstreamanalyticstransformation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/New-AzStreamAnalyticsTransformation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/New-AzStreamAnalyticsTransformation.md +--- + +# New-AzStreamAnalyticsTransformation + +## SYNOPSIS +Creates a transformation or replaces an already existing transformation under an existing streaming job. + +## SYNTAX + +``` +New-AzStreamAnalyticsTransformation -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-IfNoneMatch <String>] [-Query <String>] + [-StreamingUnit <Int32>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a transformation or replaces an already existing transformation under an existing streaming job. + +## EXAMPLES + +### Example 1: Create or replace a transformation in a stream analytics job +```powershell +New-AzStreamAnalyticsTransformation -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name tranf-01 -StreamingUnit 6 -Query "Select Id, Name from input-01" +``` +```output +Name Type ETag +---- ---- ---- +tranf-01 Microsoft.StreamAnalytics/streamingjobs/transformations ec0c7238-6bb2-4dad-b2cf-04c6a9285f4d +``` + +This command creates a transformation in the stream analytics job called. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the transformation. +Omit this value to always overwrite the current transformation. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new transformation to be created, but to prevent updating an existing transformation. +Other values will result in a 412 Pre-condition Failed response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the transformation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TransformationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Specifies the query that will be run in the streaming job. +You can learn more about the Stream Analytics Query Language (SAQL) here: https://msdn.microsoft.com/library/azure/dn834998 . +Required on PUT (CreateOrReplace) requests. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingUnit +Specifies the number of streaming units that the streaming job uses. + +```yaml +Type: System.Int32 +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.ITransformation + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsCluster.md b/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsCluster.md new file mode 100644 index 0000000000..875abe2b13 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsCluster.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/remove-azstreamanalyticscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Remove-AzStreamAnalyticsCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Remove-AzStreamAnalyticsCluster.md +--- + +# Remove-AzStreamAnalyticsCluster + +## SYNOPSIS +Deletes the specified cluster. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStreamAnalyticsCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStreamAnalyticsCluster -InputObject <IStreamAnalyticsIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the specified cluster. + +## EXAMPLES + +### Example 1: Remove a stream analytics by name +```powershell +Remove-AzStreamAnalyticsCluster -ResourceGroupName pwshaz-rg-test -Name sac-m-test02 + +``` + +This command removes a stream analytics by name. +**Please stop all jobs of the stream analytics cluster brefore invoke Remove-AzStreamAnalyticsCluster.** + +### Example 2: Remove a stream analytics by pipeline +```powershell +Get-AzStreamAnalyticsCluster -ResourceGroupName pwshaz-rg-test -Name sac-m-test01 | Remove-AzStreamAnalyticsCluster + +``` + +This command removes a stream analytics by pipeline. +**Please stop all jobs of the stream analytics cluster brefore invoke Remove-AzStreamAnalyticsCluster.** + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsFunction.md b/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsFunction.md new file mode 100644 index 0000000000..3e987cc0e0 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsFunction.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/remove-azstreamanalyticsfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Remove-AzStreamAnalyticsFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Remove-AzStreamAnalyticsFunction.md +--- + +# Remove-AzStreamAnalyticsFunction + +## SYNOPSIS +Deletes a function from the streaming job. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStreamAnalyticsFunction -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStreamAnalyticsFunction -InputObject <IStreamAnalyticsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a function from the streaming job. + +## EXAMPLES + +### Example 1: Remove a Stream Analytics function +```powershell +Remove-AzStreamAnalyticsFunction -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name function-01 + +``` + +This command removes the function from the job. + +### Example 2: Remove a Stream Analytics function by pipeline +```powershell +Get-AzStreamAnalyticsFunction -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name function-02 | Remove-AzStreamAnalyticsFunction + +``` + +This command removes the function from the job by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the function. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: FunctionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsInput.md b/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsInput.md new file mode 100644 index 0000000000..9aa4b5bacb --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsInput.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/remove-azstreamanalyticsinput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Remove-AzStreamAnalyticsInput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Remove-AzStreamAnalyticsInput.md +--- + +# Remove-AzStreamAnalyticsInput + +## SYNOPSIS +Deletes an input from the streaming job. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStreamAnalyticsInput -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStreamAnalyticsInput -InputObject <IStreamAnalyticsIdentity> [-DefaultProfile <PSObject>] [-PassThru] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an input from the streaming job. + +## EXAMPLES + +### Example 1: Remove a Stream Analytics input +```powershell +Remove-AzStreamAnalyticsInput -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name input-01 + +``` + +This command removes the input from the job. + +### Example 2: Remove a Stream Analytics input by pipeline +```powershell +Get-AzStreamAnalyticsInput -ResourceGroupName azure-rg-test -JobName sajob-02-pwsh -Name input-01 | Remove-AzStreamAnalyticsInput + +``` + +This command removes the input from the job by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the input. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: InputName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsJob.md b/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsJob.md new file mode 100644 index 0000000000..0c1a7be420 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsJob.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/remove-azstreamanalyticsjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Remove-AzStreamAnalyticsJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Remove-AzStreamAnalyticsJob.md +--- + +# Remove-AzStreamAnalyticsJob + +## SYNOPSIS +Deletes a streaming job. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStreamAnalyticsJob -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStreamAnalyticsJob -InputObject <IStreamAnalyticsIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a streaming job. + +## EXAMPLES + +### Example 1: Remove a stream analytics job +```powershell +Remove-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-01-pwsh + +``` + +This command removes the stream analytics job. + +### Example 2: Remove a stream analytics job by pipeline +```powershell +Get-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-02-pwsh | Remove-AzStreamAnalyticsJob + +``` + +This command removes the stream analytics job by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsOutput.md b/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsOutput.md new file mode 100644 index 0000000000..cb160b9cad --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Remove-AzStreamAnalyticsOutput.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/remove-azstreamanalyticsoutput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Remove-AzStreamAnalyticsOutput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Remove-AzStreamAnalyticsOutput.md +--- + +# Remove-AzStreamAnalyticsOutput + +## SYNOPSIS +Deletes an output from the streaming job. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStreamAnalyticsOutput -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStreamAnalyticsOutput -InputObject <IStreamAnalyticsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes an output from the streaming job. + +## EXAMPLES + +### Example 1: Remove a Stream Analytics output +```powershell +Remove-AzStreamAnalyticsOutput -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name output-01 + +``` + +This command removes the output from the job. + +### Example 2: Remove a Stream Analytics output by pipeline +```powershell +Get-AzStreamAnalyticsOutput -ResourceGroupName azure-rg-test -JobName sajob-02-pwsh -Name output-01 | Remove-AzStreamAnalyticsOutput + +``` + +This command removes the output from the job by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the output. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: OutputName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Start-AzStreamAnalyticsJob.md b/azps-10.1.0/Az.StreamAnalytics/Start-AzStreamAnalyticsJob.md new file mode 100644 index 0000000000..42d275e1c2 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Start-AzStreamAnalyticsJob.md @@ -0,0 +1,273 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/start-azstreamanalyticsjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Start-AzStreamAnalyticsJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Start-AzStreamAnalyticsJob.md +--- + +# Start-AzStreamAnalyticsJob + +## SYNOPSIS +Starts a streaming job. +Once a job is started it will start processing input events and produce output. + +## SYNTAX + +### StartExpanded (Default) +``` +Start-AzStreamAnalyticsJob -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-OutputStartMode <OutputStartMode>] [-OutputStartTime <DateTime>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentityExpanded +``` +Start-AzStreamAnalyticsJob -InputObject <IStreamAnalyticsIdentity> [-OutputStartMode <OutputStartMode>] + [-OutputStartTime <DateTime>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Starts a streaming job. +Once a job is started it will start processing input events and produce output. + +## EXAMPLES + +### Example 1: Start a Stream Analytics job +```powershell +Start-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-01-portal + +``` + +This command starts the job StreamingJob. + +### Example 2: Start a Stream Analytics job by pipeline +```powershell +Get-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-01-portal | Start-AzStreamAnalyticsJob + +``` + +This command starts the job StreamingJob by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: StartViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: StartExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputStartMode +Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Support.OutputStartMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputStartTime +Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. +This property must have a value if outputStartMode is set to CustomTime. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: StartExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: StartExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Stop-AzStreamAnalyticsJob.md b/azps-10.1.0/Az.StreamAnalytics/Stop-AzStreamAnalyticsJob.md new file mode 100644 index 0000000000..4e4586b2d6 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Stop-AzStreamAnalyticsJob.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/stop-azstreamanalyticsjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Stop-AzStreamAnalyticsJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Stop-AzStreamAnalyticsJob.md +--- + +# Stop-AzStreamAnalyticsJob + +## SYNOPSIS +Stops a running streaming job. +This will cause a running streaming job to stop processing input events and producing output. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzStreamAnalyticsJob -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzStreamAnalyticsJob -InputObject <IStreamAnalyticsIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Stops a running streaming job. +This will cause a running streaming job to stop processing input events and producing output. + +## EXAMPLES + +### Example 1: Stop a Stream Analytics job +```powershell +Stop-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-01-portal + +``` + +This command stops the job StreamingJob. + +### Example 2: Stop a Stream Analytics job by pipeline +```powershell +Get-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-01-portal | Stop-AzStreamAnalyticsJob + +``` + +This command stops the job StreamingJob by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Test-AzStreamAnalyticsFunction.md b/azps-10.1.0/Az.StreamAnalytics/Test-AzStreamAnalyticsFunction.md new file mode 100644 index 0000000000..18a46729a5 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Test-AzStreamAnalyticsFunction.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/test-azstreamanalyticsfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Test-AzStreamAnalyticsFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Test-AzStreamAnalyticsFunction.md +--- + +# Test-AzStreamAnalyticsFunction + +## SYNOPSIS +Tests if the information provided for a function is valid. +This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct. + +## SYNTAX + +``` +Test-AzStreamAnalyticsFunction -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Tests if the information provided for a function is valid. +This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct. + +## EXAMPLES + +### Example 1: Test a Stream Analytics function +```powershell +Test-AzStreamAnalyticsFunction -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name mlsfunction-01 +``` +```output +Status +------ +TestSucceeded +``` + +This command tests the connection status of the function in streaming job. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the function. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FunctionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IFunction + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IResourceTestStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Test-AzStreamAnalyticsInput.md b/azps-10.1.0/Az.StreamAnalytics/Test-AzStreamAnalyticsInput.md new file mode 100644 index 0000000000..94d4af99db --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Test-AzStreamAnalyticsInput.md @@ -0,0 +1,181 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/test-azstreamanalyticsinput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Test-AzStreamAnalyticsInput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Test-AzStreamAnalyticsInput.md +--- + +# Test-AzStreamAnalyticsInput + +## SYNOPSIS +Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service. + +## SYNTAX + +``` +Test-AzStreamAnalyticsInput -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service. + +## EXAMPLES + +### Example 1: Test the connection status of an input +```powershell +Test-AzStreamAnalyticsInput -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name input-01 +``` +```output +Status +------ +TestSucceeded +``` + +This command tests the connection status of the input in streaming job. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the input. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: InputName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IInput + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IResourceTestStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Test-AzStreamAnalyticsOutput.md b/azps-10.1.0/Az.StreamAnalytics/Test-AzStreamAnalyticsOutput.md new file mode 100644 index 0000000000..e478eebb6a --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Test-AzStreamAnalyticsOutput.md @@ -0,0 +1,181 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/test-azstreamanalyticsoutput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Test-AzStreamAnalyticsOutput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Test-AzStreamAnalyticsOutput.md +--- + +# Test-AzStreamAnalyticsOutput + +## SYNOPSIS +Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service. + +## SYNTAX + +``` +Test-AzStreamAnalyticsOutput -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service. + +## EXAMPLES + +### Example 1: Test the connection status of an output +```powershell +Test-AzStreamAnalyticsOutput -ResourceGroupName lucas-rg-test -JobName sajob-01-pwsh -Name output-01 +``` +```output +Status +------ +TestSucceeded +``` + +This command tests the connection status of the output in streaming job. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the output. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: OutputName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IOutput + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IResourceTestStatus + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsCluster.md b/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsCluster.md new file mode 100644 index 0000000000..5d8e40d0d8 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsCluster.md @@ -0,0 +1,318 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/update-azstreamanalyticscluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Update-AzStreamAnalyticsCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Update-AzStreamAnalyticsCluster.md +--- + +# Update-AzStreamAnalyticsCluster + +## SYNOPSIS +Updates an existing cluster. +This can be used to partially update (ie. +update one or two properties) a cluster without affecting the rest of the cluster definition. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStreamAnalyticsCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IfMatch <String>] [-Location <String>] [-SkuCapacity <Int32>] [-SkuName <ClusterSkuName>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStreamAnalyticsCluster -InputObject <IStreamAnalyticsIdentity> [-IfMatch <String>] + [-Location <String>] [-SkuCapacity <Int32>] [-SkuName <ClusterSkuName>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing cluster. +This can be used to partially update (ie. +update one or two properties) a cluster without affecting the rest of the cluster definition. + +## EXAMPLES + +### Example 1: Update a stream analytics cluster by name +```powershell +Update-AzStreamAnalyticsCluster -ResourceGroupName pwshaz-rg-test -Name sac-m-test01 -Tag @{'key4'=4} +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +West Central US sac-m-test01 Microsoft.StreamAnalytics/clusters +``` + +This command updates a stream analytics cluster by name. + +### Example 2: Update a stream analytics cluster by pipeline +```powershell +$sac = Get-AzStreamAnalyticsCluster -ResourceGroupName pwshaz-rg-test -Name sac-m-test01 +Update-AzStreamAnalyticsCluster -InputObject $sac -Tag @{'key2'=2;'key3'=3} +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +West Central US sac-m-test01 Microsoft.StreamAnalytics/clusters +``` + +This command updates a stream analytics cluster by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the resource. +Omit this value to always overwrite the current record set. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the cluster. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Denotes the number of streaming units the cluster can support. +Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. +Required on PUT (CreateOrUpdate) requests. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Specifies the SKU name of the cluster. +Required on PUT (CreateOrUpdate) requests. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Support.ClusterSkuName +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20200301Preview.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 `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsFunction.md b/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsFunction.md new file mode 100644 index 0000000000..4933ae7870 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsFunction.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/update-azstreamanalyticsfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Update-AzStreamAnalyticsFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Update-AzStreamAnalyticsFunction.md +--- + +# Update-AzStreamAnalyticsFunction + +## SYNOPSIS +Updates an existing function under an existing streaming job. +This can be used to partially update (ie. +update one or two properties) a function without affecting the rest the job or function definition. + +## SYNTAX + +### Update (Default) +``` +Update-AzStreamAnalyticsFunction -File <String> -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzStreamAnalyticsFunction -File <String> -InputObject <IStreamAnalyticsIdentity> [-IfMatch <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing function under an existing streaming job. +This can be used to partially update (ie. +update one or two properties) a function without affecting the rest the job or function definition. + +## EXAMPLES + +### Example 1: Update a Stream Analytics function +```powershell +Update-AzStreamAnalyticsFunction -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name function-01 -File .\test\template-json\Function_JavascriptUdf.json +``` +```output +Name Type ETag +---- ---- ---- +function-01 Microsoft.StreamAnalytics/streamingjobs/functions 3206c07f-ed77-4e24-b101-7aa2ac1f3cef +``` + +This command updates a function from the file Function_JavascriptUdf.json. + +### Example 2: Update a Stream Analytics function by pipeline +```powershell +Get-AzStreamAnalyticsFunction -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name function-01 | Update-AzStreamAnalyticsFunction -File .\test\template-json\MachineLearningServices.json +``` +```output +Name Type ETag +---- ---- ---- +function-01 Microsoft.StreamAnalytics/streamingjobs/functions 3206c07f-ed77-4e24-b101-7aa2ac1f3cef +``` + +This command updates a function from the file MachineLearningServices.json by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the function. +Omit this value to always overwrite the current function. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the function. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: FunctionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IFunction + +## 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 `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsInput.md b/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsInput.md new file mode 100644 index 0000000000..fd39ad1dcb --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsInput.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/update-azstreamanalyticsinput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Update-AzStreamAnalyticsInput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Update-AzStreamAnalyticsInput.md +--- + +# Update-AzStreamAnalyticsInput + +## SYNOPSIS +Updates an existing input under an existing streaming job. +This can be used to partially update (ie. +update one or two properties) an input without affecting the rest the job or input definition. + +## SYNTAX + +### Update (Default) +``` +Update-AzStreamAnalyticsInput -File <String> -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzStreamAnalyticsInput -File <String> -InputObject <IStreamAnalyticsIdentity> [-IfMatch <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing input under an existing streaming job. +This can be used to partially update (ie. +update one or two properties) an input without affecting the rest the job or input definition. + +## EXAMPLES + +### Example 1: Update a job input with a definition from a file +```powershell +Update-AzStreamAnalyticsInput -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name input-01 -File .\test\template-json\EventHub.json +``` +```output +Name Type ETag +---- ---- ---- +input-01 Microsoft.StreamAnalytics/streamingjobs/inputs 72d568f9-f4be-455b-bab8-c31e811a0469 +``` + +This command updates an input from the file EventHub.json. + +### Example 2: Update a job input with a definition from a file by pipeline +```powershell +Get-AzStreamAnalyticsInput -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name input-01 | Update-AzStreamAnalyticsInput -File .\test\template-json\IotHub.json +``` +```output +Name Type ETag +---- ---- ---- +input-01 Microsoft.StreamAnalytics/streamingjobs/inputs 29787d67-5274-4f31-a190-30182ebcecda +``` + +This command updates an input from the file IotHub.json by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the input. +Omit this value to always overwrite the current input. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the input. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: InputName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IInput + +## 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 `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsJob.md b/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsJob.md new file mode 100644 index 0000000000..217b5820d1 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsJob.md @@ -0,0 +1,379 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/update-azstreamanalyticsjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Update-AzStreamAnalyticsJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Update-AzStreamAnalyticsJob.md +--- + +# Update-AzStreamAnalyticsJob + +## SYNOPSIS +Creates a streaming job or replaces an already existing streaming job. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStreamAnalyticsJob -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IfMatch <String>] [-IfNoneMatch <String>] [-ClusterId <String>] [-DataLocale <String>] + [-EventsLateArrivalMaxDelayInSecond <Int32>] [-EventsOutOfOrderMaxDelayInSecond <Int32>] + [-EventsOutOfOrderPolicy <EventsOutOfOrderPolicy>] [-OutputErrorPolicy <OutputErrorPolicy>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStreamAnalyticsJob -InputObject <IStreamAnalyticsIdentity> [-IfMatch <String>] + [-IfNoneMatch <String>] [-ClusterId <String>] [-DataLocale <String>] + [-EventsLateArrivalMaxDelayInSecond <Int32>] [-EventsOutOfOrderMaxDelayInSecond <Int32>] + [-EventsOutOfOrderPolicy <EventsOutOfOrderPolicy>] [-OutputErrorPolicy <OutputErrorPolicy>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a streaming job or replaces an already existing streaming job. + +## EXAMPLES + +### Example 1: Update a stream analytics job +```powershell +Update-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-01-pwsh -EventsLateArrivalMaxDelayInSecond 13 -EventsOutOfOrderMaxDelayInSecond 21 +``` +```output +Location Name Type ETag +-------- ---- ---- ---- +West Central US sajob-01-pwsh Microsoft.StreamAnalytics/streamingjobs a5eb4626-ab6c-45bb-be0d-86593ad92021 +``` + +This command updates a stream analytics job. + +### Example 2: Update a stream analytics job by pipeline +```powershell +Get-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-01-pwsh | Update-AzStreamAnalyticsJob -EventsLateArrivalMaxDelayInSecond 13 -EventsOutOfOrderMaxDelayInSecond 21 +``` +```output +Location Name Type ETag +-------- ---- ---- ---- +West Central US sajob-01-pwsh Microsoft.StreamAnalytics/streamingjobs c1aa3d2a-1784-4586-926f-df5bfd084e31 +``` + +This command updates a stream analytics job by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterId +The resource id of cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataLocale +The data locale of the stream analytics job. +Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. +Defaults to 'en-US' if none specified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventsLateArrivalMaxDelayInSecond +The maximum tolerable delay in seconds where events arriving late could be included. +Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely. +If the property is absent, it is interpreted to have a value of -1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventsOutOfOrderMaxDelayInSecond +The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventsOutOfOrderPolicy +Indicates the policy to apply to events that arrive out of order in the input event stream. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Support.EventsOutOfOrderPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the streaming job. +Omit this value to always overwrite the current record set. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new streaming job to be created, but to prevent updating an existing record set. +Other values will result in a 412 Pre-condition Failed response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputErrorPolicy +Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size). + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Support.OutputErrorPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IStreamingJob + +## 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 `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsOutput.md b/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsOutput.md new file mode 100644 index 0000000000..20c41b9491 --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsOutput.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/update-azstreamanalyticsoutput +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Update-AzStreamAnalyticsOutput.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Update-AzStreamAnalyticsOutput.md +--- + +# Update-AzStreamAnalyticsOutput + +## SYNOPSIS +Updates an existing output under an existing streaming job. +This can be used to partially update (ie. +update one or two properties) an output without affecting the rest the job or output definition. + +## SYNTAX + +### Update (Default) +``` +Update-AzStreamAnalyticsOutput -File <String> -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentity +``` +Update-AzStreamAnalyticsOutput -File <String> -InputObject <IStreamAnalyticsIdentity> [-IfMatch <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing output under an existing streaming job. +This can be used to partially update (ie. +update one or two properties) an output without affecting the rest the job or output definition. + +## EXAMPLES + +### Example 1: Update an output to a stream analytics job +```powershell +Update-AzStreamAnalyticsOutput -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name output-01 -File .\test\template-json\StroageAccount.json +``` +```output +Name Type ETag +---- ---- ---- +output-01 Microsoft.StreamAnalytics/streamingjobs/outputs d5a980c2-07cc-4dc7-8dd3-21d27ec1212d +``` + +This command updates a new output in the stream analytics job. + +### Example 2: Update an output to a stream analytics job by pipeline +```powershell +Get-AzStreamAnalyticsOutput -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name output-01| Update-AzStreamAnalyticsOutput -File .\test\template-json\StroageAccount.json +``` +```output +Name Type ETag +---- ---- ---- +output-01 Microsoft.StreamAnalytics/streamingjobs/outputs 6bbe2f2d-519a-4cd9-9fdb-5311ea2617bc +``` + +This command updates a new output in the stream analytics job by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -File +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the output. +Omit this value to always overwrite the current output. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the output. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: OutputName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +### System.String + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IOutput + +## 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 `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsTransformation.md b/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsTransformation.md new file mode 100644 index 0000000000..f9dca5611f --- /dev/null +++ b/azps-10.1.0/Az.StreamAnalytics/Update-AzStreamAnalyticsTransformation.md @@ -0,0 +1,271 @@ +--- +external help file: +Module Name: Az.StreamAnalytics +online version: https://learn.microsoft.com/powershell/module/az.streamanalytics/update-azstreamanalyticstransformation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Update-AzStreamAnalyticsTransformation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/StreamAnalytics/help/Update-AzStreamAnalyticsTransformation.md +--- + +# Update-AzStreamAnalyticsTransformation + +## SYNOPSIS +Updates an existing transformation under an existing streaming job. +This can be used to partially update (ie. +update one or two properties) a transformation without affecting the rest the job or transformation definition. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStreamAnalyticsTransformation -JobName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-Query <String>] [-StreamingUnit <Int32>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStreamAnalyticsTransformation -InputObject <IStreamAnalyticsIdentity> [-IfMatch <String>] + [-Query <String>] [-StreamingUnit <Int32>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates an existing transformation under an existing streaming job. +This can be used to partially update (ie. +update one or two properties) a transformation without affecting the rest the job or transformation definition. + +## EXAMPLES + +### Example 1: Update a transformation in a stream analytics job +```powershell +Update-AzStreamAnalyticsTransformation -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name tranf-01 -StreamingUnit 1 +``` +```output +Name Type ETag +---- ---- ---- +tranf-01 Microsoft.StreamAnalytics/streamingjobs/transformations 6d100b9a-91c1-4b27-ae62-68c55635154f +``` + +This command updates a transformation in a stream analytics job. + +### Example 2: Update a transformation in a stream analytics job by pipeline +```powershell +Get-AzStreamAnalyticsTransformation -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name tranf-01 | Update-AzStreamAnalyticsTransformation -StreamingUnit 1 +``` +```output +Name Type ETag +---- ---- ---- +tranf-01 Microsoft.StreamAnalytics/streamingjobs/transformations 3d6570c5-6e0f-4ec6-b242-ba9e161c3e01 +``` + +This command updates a transformation in a stream analytics job by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the transformation. +Omit this value to always overwrite the current transformation. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The name of the streaming job. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the transformation. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: TransformationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +Specifies the query that will be run in the streaming job. +You can learn more about the Stream Analytics Query Language (SAQL) here: https://msdn.microsoft.com/library/azure/dn834998 . +Required on PUT (CreateOrReplace) requests. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingUnit +Specifies the number of streaming units that the streaming job uses. + +```yaml +Type: System.Int32 +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.IStreamAnalyticsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.ITransformation + +## 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 `<IStreamAnalyticsIdentity>`: Identity Parameter + - `[ClusterName <String>]`: The name of the cluster. + - `[FunctionName <String>]`: The name of the function. + - `[Id <String>]`: Resource identity path + - `[InputName <String>]`: The name of the input. + - `[JobName <String>]`: The name of the streaming job. + - `[Location <String>]`: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/ + - `[OutputName <String>]`: The name of the output. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TransformationName <String>]`: The name of the transformation. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Subscription/Az.Subscription.md b/azps-10.1.0/Az.Subscription/Az.Subscription.md new file mode 100644 index 0000000000..7e08a949af --- /dev/null +++ b/azps-10.1.0/Az.Subscription/Az.Subscription.md @@ -0,0 +1,27 @@ +--- +Module Name: Az.Subscription +Module Guid: 8074e741-0979-4b4e-8f9b-7243f213d98a +Download Help Link: https://learn.microsoft.com/powershell/module/az.subscription +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Subscription/Subscription/help/Az.Subscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Subscription/Subscription/help/Az.Subscription.md +--- + +# Az.Subscription Module +## Description +The topics in this section document the Azure PowerShell cmdlets for Azure Subscription in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.Subscription namespace. + +## Az.Subscription Cmdlets +### [Get-AzSubscriptionAlias](Get-AzSubscriptionAlias.md) +Gets subscription alias details + +### [New-AzSubscriptionAlias](New-AzSubscriptionAlias.md) +Creates new alias and subscription + +### [Remove-AzSubscriptionAlias](Remove-AzSubscriptionAlias.md) +Deletes the subscription alias + +### [Update-AzSubscription](Update-AzSubscription.md) +Updates an Azure Subscription + diff --git a/azps-10.1.0/Az.Subscription/Get-AzSubscriptionAlias.md b/azps-10.1.0/Az.Subscription/Get-AzSubscriptionAlias.md new file mode 100644 index 0000000000..ee2c0449b2 --- /dev/null +++ b/azps-10.1.0/Az.Subscription/Get-AzSubscriptionAlias.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Subscription.dll-Help.xml +Module Name: Az.Subscription +online version: https://learn.microsoft.com/powershell/module/az.subscription/get-azsubscriptionalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Subscription/Subscription/help/Get-AzSubscriptionAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Subscription/Subscription/help/Get-AzSubscriptionAlias.md +--- + +# Get-AzSubscriptionAlias + +## SYNOPSIS +Gets subscription alias details + +## SYNTAX + +``` +Get-AzSubscriptionAlias [-AliasName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSubscriptionAlias** cmdlet gets subscription alias details. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSubscriptionAlias -AliasName "ExistingAliasName" +``` + +Gets subscription alias details + +## PARAMETERS + +### -AliasName +Alias for the subscription + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Subscription.Models.PSAzureSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Subscription/New-AzSubscriptionAlias.md b/azps-10.1.0/Az.Subscription/New-AzSubscriptionAlias.md new file mode 100644 index 0000000000..26a251b142 --- /dev/null +++ b/azps-10.1.0/Az.Subscription/New-AzSubscriptionAlias.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Subscription.dll-Help.xml +Module Name: Az.Subscription +online version: https://learn.microsoft.com/powershell/module/az.subscription/new-azsubscriptionalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Subscription/Subscription/help/New-AzSubscriptionAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Subscription/Subscription/help/New-AzSubscriptionAlias.md +--- + +# New-AzSubscriptionAlias + +## SYNOPSIS +Creates new alias and subscription + +## SYNTAX + +``` +New-AzSubscriptionAlias -AliasName <String> [-BillingScope <String>] [-Workload <String>] + [-SubscriptionName <String>] [-ResellerId <String>] [-SubscriptionId <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSubscriptionAlias** cmdlet creates new alias and subscription + +## EXAMPLES + +### Example 1 +```powershell +New-AzSubscriptionAlias -AliasName "NewAlias1" -SubscriptionName "Subscription1" -BillingScope $BillingScope -Workload Production +``` + +Creates new alias and EA subscription + +### Example 2 +```powershell +New-AzSubscriptionAlias -AliasName "NewAlias2" -SubscriptionName "Subscription2" -BillingScope $BillingScope -Workload DevTest +``` + +Creates new alias and Dev/Test EA subscription + + +## PARAMETERS + +### -AliasName +Alias for the subscription + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingScope +Billing Scope + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResellerId +Reseller Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Existing Subscription Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionName +Name of the subscription + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workload +Type of Workload. Accepted values: DevTest, Production. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Subscription.Models.PSAzureSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Subscription/Remove-AzSubscriptionAlias.md b/azps-10.1.0/Az.Subscription/Remove-AzSubscriptionAlias.md new file mode 100644 index 0000000000..53199e6244 --- /dev/null +++ b/azps-10.1.0/Az.Subscription/Remove-AzSubscriptionAlias.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Subscription.dll-Help.xml +Module Name: Az.Subscription +online version: https://learn.microsoft.com/powershell/module/az.subscription/remove-azsubscriptionalias +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Subscription/Subscription/help/Remove-AzSubscriptionAlias.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Subscription/Subscription/help/Remove-AzSubscriptionAlias.md +--- + +# Remove-AzSubscriptionAlias + +## SYNOPSIS +Deletes the subscription alias + +## SYNTAX + +``` +Remove-AzSubscriptionAlias -AliasName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSubscriptionAlias** cmdlet removes the subscription alias + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSubscriptionAlias -AliasName "ExistingAliasName" +``` + +Deletes the subscription alias + +## PARAMETERS + +### -AliasName +Alias for the subscription + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Subscription.Models.PSAzureSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Subscription/Update-AzSubscription.md b/azps-10.1.0/Az.Subscription/Update-AzSubscription.md new file mode 100644 index 0000000000..6bd738ce03 --- /dev/null +++ b/azps-10.1.0/Az.Subscription/Update-AzSubscription.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Subscription.dll-Help.xml +Module Name: Az.Subscription +online version: https://learn.microsoft.com/powershell/module/az.subscription/update-azsubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Subscription/Subscription/help/Update-AzSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Subscription/Subscription/help/Update-AzSubscription.md +--- + +# Update-AzSubscription + +## SYNOPSIS +Updates an Azure Subscription + +## SYNTAX + +``` +Update-AzSubscription -SubscriptionId <String> -Action <String> [-Name <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSubscription** cmdlet updates an Azure subscription + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSubscription -SubscriptionId "86869d42-1782-4337-98b0-c905fb937d46" -Action "Cancel" +``` +```output +Name : My Subscription +Id : 86869d42-1782-4337-98b0-c905fb937d46 +TenantId : a5dcb057-fd83-4384-9d49-5198004d33a5 +State : Cancelled +``` + +Cancels the subscription + +### Example 2 +```powershell +Update-AzSubscription -SubscriptionId "86869d42-1782-4337-98b0-c905fb937d46" -Action "Enable" +``` +```output +Name : My Subscription +Id : 86869d42-1782-4337-98b0-c905fb937d46 +TenantId : a5dcb057-fd83-4384-9d49-5198004d33a5 +State : Enabled +``` + +Enables the subscription + +### Example 3 +```powershell +Update-AzSubscription -SubscriptionId "86869d42-1782-4337-98b0-c905fb937d46" -Action "Rename" -Name "Updated Subscription Name" +``` +```output +Name : Updated Subscription Name +Id : 86869d42-1782-4337-98b0-c905fb937d46 +TenantId : a5dcb057-fd83-4384-9d49-5198004d33a5 +State : Enabled +``` + +Renames the subscription + +## PARAMETERS + +### -Action +Action to perform on subscription + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the subscription + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Subscription Id to update + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Subscription.Models.PSAzureSubscription + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Support/Az.Support.md b/azps-10.1.0/Az.Support/Az.Support.md new file mode 100644 index 0000000000..df8fb7a4f5 --- /dev/null +++ b/azps-10.1.0/Az.Support/Az.Support.md @@ -0,0 +1,41 @@ +--- +Module Name: Az.Support +Module Guid: 22d73af7-38c2-4bf6-b56f-4dc9db05d97a +Download Help Link: https://learn.microsoft.com/powershell/module/az.support +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/Az.Support.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/Az.Support.md +--- + +# Az.Support Module +## Description +The topics in this section document the Azure PowerShell cmdlets for creating and managing Azure support tickets in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.Support namespace + +## Az.Support Cmdlets +### [Get-AzSupportService](Get-AzSupportService.md) +Gets the current list of Azure services for which support is available. Each Azure service has its own set of categories called problem classification. Get the current list of problem classification for a service using Get-AzSupportProblemClassification. You can use the service and problem classification GUID to create a new support ticket using New-AzSupportTicket. + +### [Get-AzSupportProblemClassification](Get-AzSupportProblemClassification.md) +Gets the current list of problem classification for an Azure service. You can use the service and problem classification GUID to create a new support ticket using New-AzSupportTicket. + +### [New-AzSupportContactProfileObject](New-AzSupportContactProfileObject.md) +Helper cmdlet to create a support contact profile object. You can use this object for New-AzSupportTicket cmdlet. + +### [New-AzSupportTicket](New-AzSupportTicket.md) +Creates a new Azure support ticket. This operation is modeled on the behavior of the Azure [New support request page](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview). + +### [Get-AzSupportTicket](Get-AzSupportTicket.md) +Gets the list of support tickets. You can get full support ticket details by ticket name or filter the support tickets by *Status* or *CreatedDate*. + +### [Update-AzSupportTicket](Update-AzSupportTicket.md) +Update a support ticket's severity, status or customer contact details. + +### [Get-AzSupportTicketCommunication](Get-AzSupportTicketCommunication.md) +Gets communications for a support ticket. You can also filter support ticket communications by *CreatedDate* or *CommunicationType*. + +### [New-AzSupportTicketCommunication](New-AzSupportTicketCommunication.md) +Adds a new customer communication to an Azure support ticket. + + + diff --git a/azps-10.1.0/Az.Support/Get-AzSupportProblemClassification.md b/azps-10.1.0/Az.Support/Get-AzSupportProblemClassification.md new file mode 100644 index 0000000000..1fb82f3884 --- /dev/null +++ b/azps-10.1.0/Az.Support/Get-AzSupportProblemClassification.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Support.dll-Help.xml +Module Name: Az.Support +online version: https://learn.microsoft.com/powershell/module/az.support/get-azsupportproblemclassification +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/Get-AzSupportProblemClassification.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/Get-AzSupportProblemClassification.md +--- + +# Get-AzSupportProblemClassification + +## SYNOPSIS +Get problem classifications for the service specified. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSupportProblemClassification -ServiceId <String> [-Id <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSupportProblemClassification [-Id <String>] -ServiceObject <PSSupportService> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the current list of problem classification for an Azure service. You can use the service and problem classification GUID to create a new support ticket using New-AzSupportTicket. + +Always use the service and problem classification GUIDs obtained programmatically. This practice ensures that you have the most recent set of service and problem classification GUIDs for support ticket creation. + +## EXAMPLES + +### Example 1: Get all problem classificaitons for a service using service id parameter. +```powershell +Get-AzSupportProblemClassification -ServiceId "{vm_running_windows_service_guid}" +``` +```output +Name DisplayName +---- ----------- +4d78b174-3203-a3ac-9e08-41fb35de6354 Compute-VM (cores-vCPUs) subscription limit increases +923d6b56-d573-f943-b65d-d69ba79ea21a Cannot connect to my VM / My configuration change impacted connectivity +9e9faedb-7764-448b-244a-14eca26f5362 Cannot connect to my VM / Troubleshoot my network security group (NSG) +a0456e7c-3e84-2bd5-63e9-2fc8ba7cff73 Cannot connect to my VM / Troubleshoot my VM firewall +e5c307e3-50ff-5dc9-c8ae-7d35051f88c9 Cannot connect to my VM / I have an issue with my public IP +f325e249-4f10-e5bd-28f6-a466704826da Cannot connect to my VM / I need to reset my password +f44a2b74-6a5c-a93f-a259-81e756e8cc27 Cannot connect to my VM / I need guidance with serial console access +92c2396d-b703-973f-1bca-2eea9425b21a Cannot connect to my VM / Failure to connect using RDP or SSH port +d36eec9e-cab1-8d62-1ce5-3245a02e3bcf Cannot connect to my VM / My problem is not listed above +83e6afa6-4ecd-e1c6-ef63-de73e96d0842 Cannot start or stop my VM / My VM will not start after a configuration change +240605e1-1510-255d-b490-cb95f582b1dc Cannot start or stop my VM / I received a disk related error +f47d6b99-6f4b-d21a-feee-1800ad391e10 Cannot start or stop my VM / I received an allocation failure +``` + +### Example 2: Get all problem classificaitons for a service using parent service object +```powershell +Get-AzSupportService -Id "{vm_running_windows_service_guid}" | Get-AzSupportProblemClassification +``` +```output +Name DisplayName +---- ----------- +4d78b174-3203-a3ac-9e08-41fb35de6354 Compute-VM (cores-vCPUs) subscription limit increases +923d6b56-d573-f943-b65d-d69ba79ea21a Cannot connect to my VM / My configuration change impacted connectivity +9e9faedb-7764-448b-244a-14eca26f5362 Cannot connect to my VM / Troubleshoot my network security group (NSG) +a0456e7c-3e84-2bd5-63e9-2fc8ba7cff73 Cannot connect to my VM / Troubleshoot my VM firewall +e5c307e3-50ff-5dc9-c8ae-7d35051f88c9 Cannot connect to my VM / I have an issue with my public IP +f325e249-4f10-e5bd-28f6-a466704826da Cannot connect to my VM / I need to reset my password +f44a2b74-6a5c-a93f-a259-81e756e8cc27 Cannot connect to my VM / I need guidance with serial console access +92c2396d-b703-973f-1bca-2eea9425b21a Cannot connect to my VM / Failure to connect using RDP or SSH port +d36eec9e-cab1-8d62-1ce5-3245a02e3bcf Cannot connect to my VM / My problem is not listed above +83e6afa6-4ecd-e1c6-ef63-de73e96d0842 Cannot start or stop my VM / My VM will not start after a configuration change +240605e1-1510-255d-b490-cb95f582b1dc Cannot start or stop my VM / I received a disk related error +f47d6b99-6f4b-d21a-feee-1800ad391e10 Cannot start or stop my VM / I received an allocation failure +``` + +### Example 3: Get details of a single problem classificaiton by id by piping service object +```powershell +Get-AzSupportService -Id "{vm_running_windows_service_guid}" | Get-AzSupportProblemClassification -Id 923d6b56-d573-f943-b65d-d69ba79ea21a +``` +```output +Name DisplayName +---- ----------- +923d6b56-d573-f943-b65d-d69ba79ea21a Cannot connect to my VM / My configuration change impacted connectivity +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Problem classification id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceId +Service id for which all problem classifications are retrieved. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: ServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceObject +Service object for which problem classifications are retrieved. + +```yaml +Type: Microsoft.Azure.Commands.Support.Models.PSSupportService +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Support.Models.PSSupportService + +## OUTPUTS + +### Microsoft.Azure.Commands.Support.Models.PSSupportProblemClassification + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Support/Get-AzSupportService.md b/azps-10.1.0/Az.Support/Get-AzSupportService.md new file mode 100644 index 0000000000..6e42ae59af --- /dev/null +++ b/azps-10.1.0/Az.Support/Get-AzSupportService.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Support.dll-Help.xml +Module Name: Az.Support +online version: https://learn.microsoft.com/powershell/module/az.support/get-azsupportservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/Get-AzSupportService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/Get-AzSupportService.md +--- + +# Get-AzSupportService + +## SYNOPSIS +Get services for which support is available. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzSupportService [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzSupportService -Id <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the current list of Azure services for which support is available. Each service may contain one or more Azure resource manager (ARM) resource type information. Resource types (example: 'microsoft.compute/virtualmachines') can be useful to map the right product and ARM resource when creating a technical support ticket. Each Azure service has its own set of categories called problem classification. Get the current list of problem classification for a service using Get-AzSupportProblemClassification. You can use the service and problem classification GUID to create a new support ticket using New-AzSupportTicket. + +Always use the service and problem classification GUIDs obtained programmatically. This practice ensures that you have the most recent set of service and problem classification GUIDs for support ticket creation. + +## EXAMPLES + +### Example 1: Get all services available for support +```powershell +Get-AzSupportService +``` +```output +Name DisplayName +---- ----------- +484e2236-bc6d-b1bb-76d2-7d09278cf9ea Activity Logs +809e8afe-489e-08b0-95f2-08f835a383e8 Advanced Threat Protection - Azure +6859f4e8-4a1d-13e4-f276-6d055007e83d Advanced Threat Protection - Microsoft Defender +94332e54-73b0-b8e3-306e-db3ad13d950b Advanced Threat Protection - O365 +26d8424b-0a41-4443-cbc6-0309ea8708d0 Advisor +8f1ddc5f-0c5e-50c7-9810-e01a8d1da925 AKS Engine on Azure Stack +c1840ac9-309f-f235-c0ae-4782f283b698 Alerts and Action Groups +e8fe7c6f-d883-c57f-6576-cf801ca30653 Analysis Services +07651e65-958a-0877-36f3-61bbba85d783 API for FHIR +b4d0e877-0166-0474-9a76-b5be30ba40e4 API Management Service +e14f616b-42c5-4515-3d7c-67935eece51a App Configuration +445c0905-55e2-4f42-d853-ec9e17a5180e App Service Certificates +b7d2f8b7-7d20-cf2f-ddd5-5543ada54bd2 App Service Domains +101732bb-31af-ee61-7c16-d4ad77c86a50 Application Gateway +``` + +### Example 2: Get details of a single service by id available for support +```powershell +Get-AzSupportService -Id "484e2236-bc6d-b1bb-76d2-7d09278cf9ea" +``` +```output +Name DisplayName +---- ----------- +484e2236-bc6d-b1bb-76d2-7d09278cf9ea Activity Logs +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Service id. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Support.Models.PSSupportService + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Support/Get-AzSupportTicket.md b/azps-10.1.0/Az.Support/Get-AzSupportTicket.md new file mode 100644 index 0000000000..d8f4a05fd7 --- /dev/null +++ b/azps-10.1.0/Az.Support/Get-AzSupportTicket.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Support.dll-Help.xml +Module Name: Az.Support +online version: https://learn.microsoft.com/powershell/module/az.support/get-azsupportticket +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/Get-AzSupportTicket.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/Get-AzSupportTicket.md +--- + +# Get-AzSupportTicket + +## SYNOPSIS +Get support tickets. + +## SYNTAX + +### ListParameterSet (Default) +``` +Get-AzSupportTicket [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] + [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzSupportTicket -Name <String> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] + [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the list of support tickets. It will retrieve all the support tickets if you do not specify any parameters. You can also filter the support tickets by Status or CreatedDate using the Filter parameter. Here are some examples of filter values that you can specify. + +| Scenario | Filter | +|------------------------------------------------------------------|--------------------------------------------------| +| Get tickets that are in open state | "Status eq 'Open'" | +| Get tickets that are in closed state | "Status eq 'Closed'" | +| Get tickets that were created on or after 20th Dec, 2019 | "CreatedDate ge 2019-12-20" | +| Get tickets that were created after 20th Dec, 2019 | "CreatedDate gt 2019-12-20" | +| Gets tickets created after 20th Dec, 2019 that are in open state | "CreatedDate gt 2019-12-20 and Status eq 'Open'" | + + +This cmdlet supports paging via First and Skip parameters. + +You can also retrieve a single support ticket by specifying the ticket name. + +## EXAMPLES + +### Example 1: Get first 2 tickets +```powershell +Get-AzSupportTicket -First 2 +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 test title1 150010521000317 Minimal Virtual Machine running Linux Closed 2/5/2020 1:33:53 AM +test2 test title2 150010521000318 Minimal Billing Closed 2/5/2020 1:33:53 AM +``` + +### Example 2: Get first 2 tickets after skipping the first 2 +```powershell +Get-AzSupportTicket -Skip 2 -First 2 +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test3 test title3 150010521000314 Minimal Virtual Machine running Linux Closed 2/5/2020 1:33:53 AM +test4 test title4 150010521000315 Minimal Billing Closed 2/5/2020 1:33:53 AM +``` + +### Example 3: Get a support ticket by name +```powershell +Get-AzSupportTicket -Name "test1" +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 test title1 150010521000317 Minimal Virtual Machine running Linux Closed 2/5/2020 1:33:53 AM +``` + +### Example 4: Get first 2 support tickets filtered by status +```powershell +Get-AzSupportTicket -Filter "Status eq 'Closed'" -First 2 +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 test title1 150010521000317 Minimal Virtual Machine running Linux Closed 2/5/2020 1:33:53 AM +test2 test title2 150010521000318 Minimal Billing Closed 2/5/2020 1:33:53 AM +``` + +### Example 5: Get all support tickets that are in Open state and created after Dec 20th, 2019 +```powershell +Get-AzSupportTicket -Filter "Status eq 'Open' and CreatedDate gt 2019-12-20" +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test6 test title6 150010521000311 Minimal Virtual Machine running Linux Open 2/5/2020 1:33:53 AM +test7 test title7 150010521000312 Minimal Billing Open 2/5/2020 1:33:53 AM +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter to be applied to the results of this cmdlet. + +```yaml +Type: System.String +Parameter Sets: ListParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of support ticket that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeTotalCount +Reports the total number of objects in the data set (an integer) followed by the selected objects. +If the cmdlet cannot determine the total count, it displays "Unknown total count." The integer has an Accuracy property that indicates the reliability of the total count value. +The value of Accuracy ranges from 0.0 to 1.0 where 0.0 means that the cmdlet could not count the objects, 1.0 means that the count is exact, and a value between 0.0 and 1.0 indicates an increasingly reliable estimate. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Ignores the specified number of objects and then gets the remaining objects. +Enter the number of objects to skip. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Gets only the specified number of objects. +Enter the number of objects to get. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Support.Models.PSSupportTicket + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Support/Get-AzSupportTicketCommunication.md b/azps-10.1.0/Az.Support/Get-AzSupportTicketCommunication.md new file mode 100644 index 0000000000..ae8f7c4827 --- /dev/null +++ b/azps-10.1.0/Az.Support/Get-AzSupportTicketCommunication.md @@ -0,0 +1,278 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Support.dll-Help.xml +Module Name: Az.Support +online version: https://learn.microsoft.com/powershell/module/az.support/get-azsupportticketcommunication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/Get-AzSupportTicketCommunication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/Get-AzSupportTicketCommunication.md +--- + +# Get-AzSupportTicketCommunication + +## SYNOPSIS +Get support ticket communications. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSupportTicketCommunication -SupportTicketName <String> [-Name <String>] [-Filter <String>] + [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] + [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSupportTicketCommunication [-Name <String>] -SupportTicketObject <PSSupportTicket> [-Filter <String>] + [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets communications for a support ticket. It will retrieve all the communications for a ticket if you do not specify any other parameters. You can also filter the communications by CreatedDate or CommunicationType using the Filter parameter. Here are some examples of filter values that you can specify. + + +| Scenario | Filter | +|-----------------------------------------------------------------|------------------------------------------------------------| +| Get Web communications | "CommunicationType eq 'Web'" | +| Get Phone communications | "CommunicationType eq 'Phone'" | +| Get communications that were created on or after 20th Dec, 2019 | "CreatedDate ge 2019-12-20" | +| Get communications that were created after 20th Dec, 2019 | "CreatedDate gt 2019-12-20" | +| Gets Web communications created after 20th Dec, 2019 | "CreatedDate gt 2019-12-20 and CommunicationType eq 'Web'" | + + +This cmdlet supports paging via First and Skip parameters. + +You can also retrieve a single support ticket communication by specifying the communication name. + +## EXAMPLES + +### Example 1: Retrieve all communications for a support ticket +```powershell +Get-AzSupportTicketCommunication -SupportTicketName "test1" +``` +```output +Name Sender Subject CreatedDate +---- ------ ------- ----------- +testmessage3 user@contoso.com test message3 2/4/2020 9:38:14 PM +testmessage2 user@contoso.com test message2 2/4/2020 9:36:36 PM +testmessage1 user@contoso.com test message 2/4/2020 9:35:42 PM +``` + +### Example 2: Retrieve a single communication by it's name for a support ticket +```powershell +Get-AzSupportTicketCommunication -SupportTicketName "test1" -Name "testmessage1" +``` +```output +Name Sender Subject CreatedDate +---- ------ ------- ----------- +testmessage1 user@contoso.com test message 2/4/2020 9:38:14 PM +``` + +### Example 3: Retrieve first 2 communications for a support ticket +```powershell +Get-AzSupportTicketCommunication -SupportTicketName "test1" -First 2 +``` +```output +Name Sender Subject CreatedDate +---- ------ ------- ----------- +testmessage3 user@contoso.com test message3 2/4/2020 9:38:14 PM +testmessage2 user@contoso.com test message2 2/4/2020 9:36:36 PM +``` + +### Example 4: Retrieve next 2 communications after skipping first 2 communications for a support ticket +```powershell +Get-AzSupportTicketCommunication -SupportTicketName "test1" -Skip 2 -First 2 +``` +```output +Name Sender Subject CreatedDate +---- ------ ------- ----------- +testmessage4 user@contoso.com test message4 2/4/2020 9:38:14 PM +testmessage5 user@contoso.com test message5 2/4/2020 9:36:36 PM +``` + +### Example 5: Retrieve all Web communications for a support ticket +```powershell +Get-AzSupportTicketCommunication -SupportTicketName "test1" -Filter "CommunicationType eq 'Web'" +``` +```output +Name Sender Subject CreatedDate +---- ------ ------- ----------- +testmessage3 user@contoso.com test message3 2/4/2020 9:38:14 PM +testmessage2 user@contoso.com test message2 2/4/2020 9:36:36 PM +``` + +### Example 6: Retrieve all communications created on or after Dec 20th, 2019 for a support ticket +```powershell +Get-AzSupportTicketCommunication -SupportTicketName "test1" -Filter "CreatedDate ge 2019-12-20" +``` +```output +Name Sender Subject CreatedDate +---- ------ ------- ----------- +testmessage3 user@contoso.com test message3 2/4/2020 9:38:14 PM +testmessage2 user@contoso.com test message2 2/4/2020 9:36:36 PM +``` + +### Example 7: Retrieve all Web communications created on or after Dec 20th, 2019 for a support ticket +```powershell +Get-AzSupportTicketCommunication -SupportTicketName "test1" -Filter "CommunicationType eq 'Web' and CreatedDate ge 2019-12-20" +``` +```output +Name Sender Subject CreatedDate +---- ------ ------- ----------- +testmessage3 user@contoso.com test message3 2/4/2020 9:38:14 PM +testmessage2 user@contoso.com test message2 2/4/2020 9:36:36 PM +``` + +### Example 8: Retrieve all communications for a support ticket by piping support ticket object +```powershell +Get-AzSupportTicket -Name "test1" | Get-AzSupportTicketCommunication +``` +```output +Name Sender Subject CreatedDate +---- ------ ------- ----------- +testmessage3 user@contoso.com test message3 2/4/2020 9:38:14 PM +testmessage2 user@contoso.com test message2 2/4/2020 9:36:36 PM +testmessage1 user@contoso.com test message 2/4/2020 9:35:42 PM +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Filter to be applied to the results of this cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Communication name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportTicketName +Support ticket name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportTicketObject +Support ticket object. + +```yaml +Type: Microsoft.Azure.Commands.Support.Models.PSSupportTicket +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IncludeTotalCount +Reports the total number of objects in the data set (an integer) followed by the selected objects. +If the cmdlet cannot determine the total count, it displays "Unknown total count." The integer has an Accuracy property that indicates the reliability of the total count value. +The value of Accuracy ranges from 0.0 to 1.0 where 0.0 means that the cmdlet could not count the objects, 1.0 means that the count is exact, and a value between 0.0 and 1.0 indicates an increasingly reliable estimate. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Ignores the specified number of objects and then gets the remaining objects. +Enter the number of objects to skip. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Gets only the specified number of objects. +Enter the number of objects to get. + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Support.Models.PSSupportTicket + +## OUTPUTS + +### Microsoft.Azure.Commands.Support.Models.PSSupportTicketCommunication + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Support/New-AzSupportContactProfileObject.md b/azps-10.1.0/Az.Support/New-AzSupportContactProfileObject.md new file mode 100644 index 0000000000..41f4c7be41 --- /dev/null +++ b/azps-10.1.0/Az.Support/New-AzSupportContactProfileObject.md @@ -0,0 +1,248 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Support.dll-Help.xml +Module Name: Az.Support +online version: https://learn.microsoft.com/powershell/module/az.support/new-azsupportcontactprofileobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/New-AzSupportContactProfileObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/New-AzSupportContactProfileObject.md +--- + +# New-AzSupportContactProfileObject + +## SYNOPSIS +Creates a support contact profile object. + +## SYNTAX + +``` +New-AzSupportContactProfileObject -FirstName <String> -LastName <String> + -PreferredContactMethod <ContactMethod> -PrimaryEmailAddress <String> [-AdditionalEmailAddress <String[]>] + [-PhoneNumber <String>] -PreferredTimeZone <String> -Country <String> -PreferredSupportLanguage <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This is a helper cmdlet that you can use to create a support contact profile object when creating or updating a support ticket. You must specify the following parameters which are mandatory for creating a support ticket: + + • FirstName + • LastName + • PrimaryEmailAddress + • PreferredContactMethod + • Country + • PreferredSupportLanguage + • PreferredTimeZone + +## EXAMPLES + +### Example 1: Create a contact object +```powershell +New-AzSupportContactProfileObject -FirstName "First" -LastName "Last" -PreferredContactMethod "Email" -PrimaryEmailAddress "user@contoso.com" -PreferredTimeZone "Pacific Standard Time" -PreferredSupportLanguage "en-US" -Country "USA" +``` +```output +FirstName LastName PreferredContactMethod PrimaryEmailAddress PhoneNumber PreferredTimeZone Country PreferredSupportLanguage +--------- -------- ---------------------- ------------------- ----------- ----------------- ------- ------------------------ +First Last Email user@contoso.com Pacific Standard Time USA en-US +``` + +## PARAMETERS + +### -AdditionalEmailAddress +Email addresses listed here will be copied on any correspondence about the support ticket. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Country +Customer country. +This must be a valid ISO Alpha-3 country code (ISO 3166). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirstName +Customer first name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastName +Customer last name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumber +Customer phone number. +This is required if preferred contact method is phone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredContactMethod +Preferred contact method. + +```yaml +Type: Microsoft.Azure.Commands.Support.Models.ContactMethod +Parameter Sets: (All) +Aliases: +Accepted values: Email, Phone + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredSupportLanguage +Customer preferred support language. +This must be a valid language-contry code for one of the supported languages listed here https://azure.microsoft.com/support/faq/. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredTimeZone +Customer preferred time zone. +This must be a valid System.TimeZoneInfo.Id value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryEmailAddress +Customer primary email address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Support.Models.PSContactProfile + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Support/New-AzSupportTicket.md b/azps-10.1.0/Az.Support/New-AzSupportTicket.md new file mode 100644 index 0000000000..0dbf90e88d --- /dev/null +++ b/azps-10.1.0/Az.Support/New-AzSupportTicket.md @@ -0,0 +1,690 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Support.dll-Help.xml +Module Name: Az.Support +online version: https://learn.microsoft.com/powershell/module/az.support/new-azsupportticket +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/New-AzSupportTicket.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/New-AzSupportTicket.md +--- + +# New-AzSupportTicket + +## SYNOPSIS +Creates a support ticket. + +## SYNTAX + +### CreateSupportTicketWithContactDetailParameterSet (Default) +``` +New-AzSupportTicket -Name <String> -Title <String> -Description <String> -ProblemClassificationId <String> + -Severity <Severity> -CustomerFirstName <String> -CustomerLastName <String> + -PreferredContactMethod <ContactMethod> -CustomerPrimaryEmailAddress <String> + [-AdditionalEmailAddress <String[]>] [-CustomerPhoneNumber <String>] -CustomerPreferredTimeZone <String> + -CustomerCountry <String> -CustomerPreferredSupportLanguage <String> [-ProblemStartTime <DateTime>] + [-CSPHomeTenantId <String>] [-Require24X7Response] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateSupportTicketWithContactObjectParameterSet +``` +New-AzSupportTicket -Name <String> -Title <String> -Description <String> -ProblemClassificationId <String> + -Severity <Severity> -CustomerContactDetail <PSContactProfile> [-ProblemStartTime <DateTime>] + [-CSPHomeTenantId <String>] [-Require24X7Response] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateTechnicalSupportTicketWithContactObjectParameterSet +``` +New-AzSupportTicket -Name <String> -Title <String> -Description <String> -ProblemClassificationId <String> + -Severity <Severity> -CustomerContactDetail <PSContactProfile> [-ProblemStartTime <DateTime>] + -TechnicalTicketResourceId <String> [-CSPHomeTenantId <String>] [-Require24X7Response] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateQuotaSupportTicketWithContactObjectParameterSet +``` +New-AzSupportTicket -Name <String> -Title <String> -Description <String> -ProblemClassificationId <String> + -Severity <Severity> -CustomerContactDetail <PSContactProfile> [-ProblemStartTime <DateTime>] + -QuotaTicketDetail <PSQuotaTicketDetail> [-CSPHomeTenantId <String>] [-Require24X7Response] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateTechnicalSupportTicketWithContactDetailParameterSet +``` +New-AzSupportTicket -Name <String> -Title <String> -Description <String> -ProblemClassificationId <String> + -Severity <Severity> -CustomerFirstName <String> -CustomerLastName <String> + -PreferredContactMethod <ContactMethod> -CustomerPrimaryEmailAddress <String> + [-AdditionalEmailAddress <String[]>] [-CustomerPhoneNumber <String>] -CustomerPreferredTimeZone <String> + -CustomerCountry <String> -CustomerPreferredSupportLanguage <String> [-ProblemStartTime <DateTime>] + -TechnicalTicketResourceId <String> [-CSPHomeTenantId <String>] [-Require24X7Response] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateQuotaSupportTicketWithContactDetailParameterSet +``` +New-AzSupportTicket -Name <String> -Title <String> -Description <String> -ProblemClassificationId <String> + -Severity <Severity> -CustomerFirstName <String> -CustomerLastName <String> + -PreferredContactMethod <ContactMethod> -CustomerPrimaryEmailAddress <String> + [-AdditionalEmailAddress <String[]>] [-CustomerPhoneNumber <String>] -CustomerPreferredTimeZone <String> + -CustomerCountry <String> -CustomerPreferredSupportLanguage <String> [-ProblemStartTime <DateTime>] + -QuotaTicketDetail <PSQuotaTicketDetail> [-CSPHomeTenantId <String>] [-Require24X7Response] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This cmdlet can be used to create a support ticket for Billing, Subscription Management, Quota or Technical issues. Use Get-AzSupportService and Get-AzSupportProblemClassification cmdlets to identify the Azure service and it's corresponding problem classifications respectively for which you want to request support. You must specify the following parameters: + + • Title + • Description + • Severity level + • ProblemClassificationId + • CustomerContactDetail (or individual customer contact parameters) + +You can use New-AzSupportContactProfileObject helper cmdlet to create CustomerContactDetail object. + +Cloud Solution Providers can create a support ticket for their customer's subscriptions by logging into their customer's tenant and specifying their home tenant id using *CSPHomeTenantId* parameter. + +__For technical tickets:__ + +To specify the resource name, specify the ARM resource ID of the resource by using *TechnicalTicketResourceId* parameter. See an example below. + +__For quota tickets:__ + +To request for quota increase for **Compute VM Cores**, **Batch**, **SQL Database** and **SQL Data Warehouse**, provide additional details under *QuotaTicketDetail* object. QuotaTicketDetail object consists of 3 properties as described below. For detailed documentation, please [click here.](https://aka.ms/supportrpquotarequestpayload) + + • QuotaChangeRequestSubType + + This is required for certain quota types when there is a sub type that you are requesting quota increase for. Example: Batch, SQL Database and SQL Data Warehouse have a sub type. + + • QuotaChangeRequestVersion + + This is required and indicates the version of the quota change request payload. + + • QuotaChangeRequests + + This is required and is a list of PSQuotaChangeRequest objects. PSQuotaChangeRequest object has 2 required properties. + + ○ Region + + This is the Azure location or region for which you are requesting quota increase. This is the Location property of Get-AzLocation cmdlet. + + ○ Payload + + This is where you specify the new limits for the selected quota type. + + +For detailed documentation on how to construct Payload for various quota types, please [click here](https://aka.ms/supportrpquotarequestpayload) + +## EXAMPLES + +### Example 1: Create a Billing or Subscription Management support ticket. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Billing or Subscription Management problem classification for which you want to request support +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{billing_service_guid}/problemClassifications/{problemClassification_guid}" -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Billing Open 2/5/2020 1:33:53 AM +``` + +### Example 2: Create a technical support ticket for Virtual Machine for Windows resource. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Virtual Machine for Windows problem classification for which you want to request support +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{vm_windows_service_guid}/problemClassifications/{problemClassification_guid}" -TechnicalTicketResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testVM" -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Virtual Machine running Windows Open 2/5/2020 1:33:53 AM +``` + +### Example 3: Create a quota support ticket to increase quota for Virtual Machine Cores for a specific VM family. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Quota Compute VM Cores problem classification. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{quota_service_guid}/problemClassifications/{cores_problemClassification_guid}" -QuotaTicketDetail @{QuotaChangeRequestVersion = "1.0" ; QuotaChangeRequests = (@{Region = "westus"; Payload = "{`"VMFamily`":`"Dv2 Series`",`"NewLimit`":350}"}, @{Region = "eastus"; Payload = "{`"VMFamily`":`"Dv2 Series`",`"NewLimit`":516}"})} -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Service and subscription limits (quotas) Open 2/5/2020 1:33:53 AM +``` + +### Example 4: Create a quota support ticket to increase quota for Low-priority cores for a Batch account. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Quota Batch problem classification. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{quota_service_guid}/problemClassifications/{batch_problemClassification_guid}" -QuotaTicketDetail @{QuotaChangeRequestVersion = "1.0" ; QuotaChangeRequestSubType = "Account" ; QuotaChangeRequests = (@{Region = "westus"; Payload = "{`"AccountName`":`"test`",`"NewLimit`":200,`"Type`":`"LowPriority`"}"})} -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Service and subscription limits (quotas) Open 2/5/2020 1:33:53 AM +``` + +### Example 5: Create a quota support ticket to increase VM cores quota for a specific VM Family for a Batch account. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Quota Batch problem classification. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{quota_service_guid}/problemClassifications/{batch_problemClassification_guid}" -QuotaTicketDetail @{QuotaChangeRequestVersion = "1.0" ; QuotaChangeRequestSubType = "Account" ; QuotaChangeRequests = (@{Region = "westus"; Payload = "{`"AccountName`":`"test`",`"VMFamily`":`"standardA0_A7Family`",`"NewLimit`":200,`"Type`":`"Dedicated`"}"})} -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Service and subscription limits (quotas) Open 2/5/2020 1:33:53 AM +``` + +### Example 6: Create a quota support ticket to increase Pools quota for a Batch account. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Quota Batch problem classification. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{quota_service_guid}/problemClassifications/{batch_problemClassification_guid}" -QuotaTicketDetail @{QuotaChangeRequestVersion = "1.0" ; QuotaChangeRequestSubType = "Account" ; QuotaChangeRequests = (@{Region = "westus"; Payload = "{`"AccountName`":`"test`",`"NewLimit`":120,`"Type`":`"Pools`"}"})} -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Service and subscription limits (quotas) Open 2/5/2020 1:33:53 AM +``` + +### Example 7: Create a quota support ticket to increase active Jobs and job schedules quota for a Batch account. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Quota Batch problem classification. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{quota_service_guid}/problemClassifications/{batch_problemClassification_guid}" -QuotaTicketDetail @{QuotaChangeRequestVersion = "1.0" ; QuotaChangeRequestSubType = "Account" ; QuotaChangeRequests = (@{Region = "westus"; Payload = "{`"AccountName`":`"test`",`"NewLimit`":120,`"Type`":`"Jobs`"}"})} -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Service and subscription limits (quotas) Open 2/5/2020 1:33:53 AM +``` + +### Example 8: Create a quota support ticket to increase number of Batch accounts for a subscription. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Quota Batch problem classification. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{quota_service_guid}/problemClassifications/{batch_problemClassification_guid}" -QuotaTicketDetail @{QuotaChangeRequestVersion = "1.0" ; QuotaChangeRequestSubType = "Subscription" ; QuotaChangeRequests = (@{Region = "westus"; Payload = "{`"NewLimit`":120,`"Type`":`"Account`"}"})} -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Service and subscription limits (quotas) Open 2/5/2020 1:33:53 AM +``` + +### Example 9: Create a quota support ticket to increase quota for DTUs for SQL Database. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Quota SQL Database problem classification. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{quota_service_guid}/problemClassifications/{sql_database_problemClassification_guid}" -QuotaTicketDetail @{QuotaChangeRequestVersion = "1.0" ; QuotaChangeRequestSubType = "DTUs" ; QuotaChangeRequests = (@{Region = "westus"; Payload = "{`"ServerName`":`"testserver`",`"NewLimit`":54000}"})} -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Service and subscription limits (quotas) Open 2/5/2020 1:33:53 AM +``` + +### Example 10: Create a quota support ticket to increase quota for Servers for SQL Database. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Quota SQL Database problem classification. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{quota_service_guid}/problemClassifications/{sql_database_problemClassification_guid}" -QuotaTicketDetail @{QuotaChangeRequestVersion = "1.0" ; QuotaChangeRequestSubType = "Servers" ; QuotaChangeRequests = (@{Region = "westus"; Payload = "{`"NewLimit`":200}"})} -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Service and subscription limits (quotas) Open 2/5/2020 1:33:53 AM +``` + +### Example 11: Create a quota support ticket to increase quota for DTUs for SQL Data Warehouse. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Quota SQL Date Warehouse problem classification. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{quota_service_guid}/problemClassifications/{sql_datawarehouse_problemClassification_guid}" -QuotaTicketDetail @{QuotaChangeRequestVersion = "1.0" ; QuotaChangeRequestSubType = "DTUs" ; QuotaChangeRequests = (@{Region = "westus"; Payload = "{`"ServerName`":`"testserver`",`"NewLimit`":54000}"})} -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Service and subscription limits (quotas) Open 2/5/2020 1:33:53 AM +``` + +### Example 12: Create a quota support ticket to increase quota for Servers for SQL Data Warehouse. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Quota SQL Data Warehouse problem classification. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{quota_service_guid}/problemClassifications/{sql_datawarehouse_problemClassification_guid}" -QuotaTicketDetail @{QuotaChangeRequestVersion = "1.0" ; QuotaChangeRequestSubType = "Servers" ; QuotaChangeRequests = (@{Region = "westus"; Payload = "{`"NewLimit`":200}"})} -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Service and subscription limits (quotas) Open 2/5/2020 1:33:53 AM +``` + +### Example 13: Create a quota support ticket to increase quota for Low-priority cores for Machine Learning service. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Quota Machine Learning service problem classification. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{quota_service_guid}/problemClassifications/{machine_learning_service_problemClassification_guid}" -QuotaTicketDetail @{QuotaChangeRequestVersion = "1.0" ; QuotaChangeRequestSubType = "BatchAml" ; QuotaChangeRequests = (@{Region = "westus"; Payload = "{`"NewLimit`":200,`"Type`":`"LowPriority`" }"})} -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Service and subscription limits (quotas) Open 2/5/2020 1:33:53 AM +``` + +### Example 14: Create a quota support ticket to increase VM cores quota for a specific VM Family for Machine Learning service. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Quota Machine Learning service problem classification. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{quota_service_guid}/problemClassifications/{machine_learning_service_problemClassification_guid}" -QuotaTicketDetail @{QuotaChangeRequestVersion = "1.0" ; QuotaChangeRequestSubType = "BatchAml" ; QuotaChangeRequests = (@{Region = "westus"; Payload = "{`"VMFamily`":`"standardDFamily`",`"NewLimit`":200,`"Type`":`"Dedicated`" }"})} -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Service and subscription limits (quotas) Open 2/5/2020 1:33:53 AM +``` + +### Example 15: Create a quota support ticket to increase quota for Azure SQL Managed Instance. Use Get-AzSupportService and Get-AzSupportProblemClassification to retrieve correct GUIDs for Quota SQL Managed Instance service problem classification. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{quota_service_guid}/problemClassifications/{sql_managed_instance_problemClassification_guid}" -QuotaTicketDetail @{QuotaChangeRequestVersion = "1.0" ; QuotaChangeRequestSubType = "SQLMI" ; QuotaChangeRequests = (@{Region = "westus"; Payload = "{`"NewLimit`":200,`"Type`":`"vCore`" }"}, @{Region = "westus"; Payload = "{`"NewLimit`":200,`"Type`":`"Subnet`" }"})} -CustomerContactDetail @{FirstName = "first" ; LastName = "last" ; PreferredTimeZone = "pacific standard time" ; PreferredSupportLanguage = "en-us" ; Country = "USA" ; PreferredContactMethod = "Email" ; PrimaryEmailAddress = "user@contoso.com"} +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Service and subscription limits (quotas) Open 2/5/2020 1:33:53 AM +``` + +### Example 16: Create a support ticket by specifying individual customer contact parameters instead of CustomerContactDetail object. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{billing_service_guid}/problemClassifications/{problemClassification_guid}" -CustomerFirstName "first" -CustomerLastName "last" -CustomerPreferredTimeZone "pacific standard time" -CustomerPreferredSupportLanguage "en-us" -CustomerCountry "USA" -PreferredContactMethod "Email" -CustomerPrimaryEmailAddress "user@contoso.com" +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Billing Open 2/5/2020 1:33:53 AM +``` + +### Example 17: Create a support ticket with request for 24 x 7 response from Azure. +```powershell +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "critical" -ProblemClassificationId "/providers/Microsoft.Support/services/{billing_service_guid}/problemClassifications/{problemClassification_guid}" -CustomerFirstName "first" -CustomerLastName "last" -CustomerPreferredTimeZone "pacific standard time" -CustomerPreferredSupportLanguage "en-us" -CustomerCountry "USA" -PreferredContactMethod "Email" -CustomerPrimaryEmailAddress "user@contoso.com" -Require24X7Response +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Critical Billing Open 2/5/2020 1:33:53 AM +``` + +### Example 18: Create a support ticket on behalf of your customer if you are a Cloud Solution Provider (CSP). CSP should first login into their tenant, and then login into customer's tenant as shown in the example below. They must then use -CSPHomeTenantId parameter to specify their home tenant id at the time of creating a support ticket. +```powershell + +Connect-AzAccount + +Connect-AzAccount -TenantId "customer_tenant_id" + +New-AzSupportTicket -Name "test1" -Title "Test" -Description "Test" -Severity "minimal" -ProblemClassificationId "/providers/Microsoft.Support/services/{billing_service_guid}/problemClassifications/{problemClassification_guid}" -CustomerFirstName "first" -CustomerLastName "last" -CustomerPreferredTimeZone "pacific standard time" -CustomerPreferredSupportLanguage "en-us" -CustomerCountry "USA" -PreferredContactMethod "Email" -CustomerPrimaryEmailAddress "user@contoso.com" -CSPHomeTenantId "csp_home_tenant_id" +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 Test 150010521000317 Minimal Billing Open 2/5/2020 1:33:53 AM +``` + +## PARAMETERS + +### -AdditionalEmailAddress +Additional email addresses. +Email addresses listed here will be copied on any correspondence about the support ticket. + +```yaml +Type: System.String[] +Parameter Sets: CreateSupportTicketWithContactDetailParameterSet, CreateTechnicalSupportTicketWithContactDetailParameterSet, CreateQuotaSupportTicketWithContactDetailParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CSPHomeTenantId +This is the home tenant id of the Cloud Solution Provider user trying to create a support ticket for their customer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerContactDetail +Customer contact details associated with SupportTicket resource. + +```yaml +Type: Microsoft.Azure.Commands.Support.Models.PSContactProfile +Parameter Sets: CreateSupportTicketWithContactObjectParameterSet, CreateTechnicalSupportTicketWithContactObjectParameterSet, CreateQuotaSupportTicketWithContactObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerCountry +Customer country. +This must be a valid ISO Alpha-3 country code (ISO 3166). + +```yaml +Type: System.String +Parameter Sets: CreateSupportTicketWithContactDetailParameterSet, CreateTechnicalSupportTicketWithContactDetailParameterSet, CreateQuotaSupportTicketWithContactDetailParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerFirstName +Customer first name. + +```yaml +Type: System.String +Parameter Sets: CreateSupportTicketWithContactDetailParameterSet, CreateTechnicalSupportTicketWithContactDetailParameterSet, CreateQuotaSupportTicketWithContactDetailParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerLastName +Customer last name. + +```yaml +Type: System.String +Parameter Sets: CreateSupportTicketWithContactDetailParameterSet, CreateTechnicalSupportTicketWithContactDetailParameterSet, CreateQuotaSupportTicketWithContactDetailParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerPhoneNumber +Customer phone number. +This is required if preferred contact method is phone. + +```yaml +Type: System.String +Parameter Sets: CreateSupportTicketWithContactDetailParameterSet, CreateTechnicalSupportTicketWithContactDetailParameterSet, CreateQuotaSupportTicketWithContactDetailParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerPreferredSupportLanguage +Peferred language of the custom. +This must be a valid language-contry code for one of the supported languages listed here https://azure.microsoft.com/en-us/support/faq/. + +```yaml +Type: System.String +Parameter Sets: CreateSupportTicketWithContactDetailParameterSet, CreateTechnicalSupportTicketWithContactDetailParameterSet, CreateQuotaSupportTicketWithContactDetailParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerPreferredTimeZone +Customer preferred time zone. +This must be a valid System.TimeZoneInfo.Id value. + +```yaml +Type: System.String +Parameter Sets: CreateSupportTicketWithContactDetailParameterSet, CreateTechnicalSupportTicketWithContactDetailParameterSet, CreateQuotaSupportTicketWithContactDetailParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerPrimaryEmailAddress +Customer primary email address. + +```yaml +Type: System.String +Parameter Sets: CreateSupportTicketWithContactDetailParameterSet, CreateTechnicalSupportTicketWithContactDetailParameterSet, CreateQuotaSupportTicketWithContactDetailParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Detailed description of the question or issue. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of support ticket that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredContactMethod +Preferred contact method. + +```yaml +Type: Microsoft.Azure.Commands.Support.Models.ContactMethod +Parameter Sets: CreateSupportTicketWithContactDetailParameterSet, CreateTechnicalSupportTicketWithContactDetailParameterSet, CreateQuotaSupportTicketWithContactDetailParameterSet +Aliases: +Accepted values: Email, Phone + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProblemClassificationId +Each Azure service has its own set of issue category called problem classification that corresponds to the type of problem you're experiencing. +This parameter is the ARM resource id of ProblemClassification resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProblemStartTime +Date and time when the problem started. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuotaTicketDetail +Additional details for a Quota support ticket. + +```yaml +Type: Microsoft.Azure.Commands.Support.Models.PSQuotaTicketDetail +Parameter Sets: CreateQuotaSupportTicketWithContactObjectParameterSet, CreateQuotaSupportTicketWithContactDetailParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Require24X7Response +Indicates if this support ticket requires a 24x7 response from Azure. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity +Severity of the support ticket. +This indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Support.Models.Severity +Parameter Sets: (All) +Aliases: +Accepted values: Minimal, Moderate, Critical, HighestCriticalImpact + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TechnicalTicketResourceId +This is the resource id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. + +```yaml +Type: System.String +Parameter Sets: CreateTechnicalSupportTicketWithContactObjectParameterSet, CreateTechnicalSupportTicketWithContactDetailParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title +Title of support ticket. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Support.Models.PSSupportTicket + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Support/New-AzSupportTicketCommunication.md b/azps-10.1.0/Az.Support/New-AzSupportTicketCommunication.md new file mode 100644 index 0000000000..ce35895b6d --- /dev/null +++ b/azps-10.1.0/Az.Support/New-AzSupportTicketCommunication.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Support.dll-Help.xml +Module Name: Az.Support +online version: https://learn.microsoft.com/powershell/module/az.support/new-azsupportticketcommunication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/New-AzSupportTicketCommunication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/New-AzSupportTicketCommunication.md +--- + +# New-AzSupportTicketCommunication + +## SYNOPSIS +Creates a new support ticket communication. + +## SYNTAX + +### CreateByNameParameterSet (Default) +``` +New-AzSupportTicketCommunication -SupportTicketName <String> -Name <String> -Subject <String> -Body <String> + [-Sender <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CreateByParentObjectParameterSet +``` +New-AzSupportTicketCommunication -SupportTicketObject <PSSupportTicket> -Name <String> -Subject <String> + -Body <String> [-Sender <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Adds a new customer communication to an Azure support ticket. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSupportTicketCommunication -Name "testmessage" -SupportTicketName "testticket" -Subject "test subject" -Body "test body" -Sender "user@contoso.com" +``` +```output +Name Sender Subject CreatedDate +---- ------ ------- ----------- +testmessage user@contoso.com test subject 2/4/2020 9:38:14 PM +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body +Body of the communication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the communication resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sender +Email address of the sender. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subject +Subject of the communication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportTicketName +Support ticket name. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupportTicketObject +Support ticket object. + +```yaml +Type: Microsoft.Azure.Commands.Support.Models.PSSupportTicket +Parameter Sets: CreateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Support.Models.PSSupportTicket + +## OUTPUTS + +### Microsoft.Azure.Commands.Support.Models.PSSupportTicketCommunication + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Support/Update-AzSupportTicket.md b/azps-10.1.0/Az.Support/Update-AzSupportTicket.md new file mode 100644 index 0000000000..2396424c28 --- /dev/null +++ b/azps-10.1.0/Az.Support/Update-AzSupportTicket.md @@ -0,0 +1,395 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Support.dll-Help.xml +Module Name: Az.Support +online version: https://learn.microsoft.com/powershell/module/az.support/update-azsupportticket +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/Update-AzSupportTicket.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Support/Support/help/Update-AzSupportTicket.md +--- + +# Update-AzSupportTicket + +## SYNOPSIS +Updates support ticket. + +## SYNTAX + +### UpdateByNameWithContactDetailParameterSet (Default) +``` +Update-AzSupportTicket -Name <String> [-Severity <Severity>] [-Status <Status>] [-CustomerFirstName <String>] + [-CustomerLastName <String>] [-PreferredContactMethod <ContactMethod>] [-CustomerPrimaryEmailAddress <String>] + [-AdditionalEmailAddress <String[]>] [-CustomerPhoneNumber <String>] [-CustomerPreferredTimeZone <String>] + [-CustomerCountry <String>] [-CustomerPreferredSupportLanguage <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByNameWithContactObjectParameterSet +``` +Update-AzSupportTicket -Name <String> [-Severity <Severity>] [-Status <Status>] -CustomerContactDetail <PSContactProfile> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectWithContactDetailParameterSet +``` +Update-AzSupportTicket -InputObject <PSSupportTicket> [-Severity <Severity>] [-Status <Status>] [-CustomerFirstName <String>] + [-CustomerLastName <String>] [-PreferredContactMethod <ContactMethod>] [-CustomerPrimaryEmailAddress <String>] + [-AdditionalEmailAddress <String[]>] [-CustomerPhoneNumber <String>] [-CustomerPreferredTimeZone <String>] + [-CustomerCountry <String>] [-CustomerPreferredSupportLanguage <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectWithContactObjectParameterSet +``` +Update-AzSupportTicket -InputObject <PSSupportTicket> [-Severity <Severity>] [-Status <Status>] + -CustomerContactDetail <PSContactProfile> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Use this cmdlet to update a support ticket's severity level, status or customer contact details. Note that updating a support ticket's severity level or status is not allowed when the ticket is assigned to a support engineer. If you wish to update the severity level or status after ticket assignment, contact the support engineer by sending a communication on the ticket. + +## EXAMPLES + +### Example 1: Update severity of support ticket. +```powershell +Update-AzSupportTicket -Name "test1" -Severity "moderate" +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 test title1 150010521000317 Moderate Virtual Machine running Linux Open 2/5/2020 1:33:53 AM +``` + +### Example 2: Update status of support ticket. +```powershell +Update-AzSupportTicket -Name "test1" -Status "Closed" +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 test title1 150010521000317 Moderate Virtual Machine running Linux Closed 2/5/2020 1:33:53 AM +``` + +### Example 3: Update contact details of support ticket by specify contact object. +```powershell +$contactDetail = New-Object Microsoft.Azure.Commands.Support.Models.PSContactProfile +$contactDetail.FirstName = "first name updated" +$contactDetail.LastName = "last name updated" +Update-AzSupportTicket -Name "test1" -CustomerContactDetail $contactDetail +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 test title1 150010521000317 Moderate Virtual Machine running Linux Open 2/5/2020 1:33:53 AM +``` + +### Example 4: Update severity of support ticket by piping support ticket object. +```powershell +Get-AzSupportTicket -Name "test1" | Update-AzSupportTicket -Severity "moderate" +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 test title1 150010521000317 Moderate Virtual Machine running Linux Open 2/5/2020 1:33:53 AM +``` + +### Example 5: Update contact details of support ticket by specifying individual contact parameters. +```powershell +Update-AzSupportTicket -Name "test1" -CustomerFirstName "first name updated" -CustomerLastName "last name updated" -AdditionalEmailAddress @("user2@contoso.com") +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 test title1 150010521000317 Moderate Virtual Machine running Linux Open 2/5/2020 1:33:53 AM +``` + +### Example 6: Update status of support ticket by piping support ticket object. +```powershell +Get-AzSupportTicket -Name "test1" | Update-AzSupportTicket -Status "Closed" +``` +```output +Name Title SupportTicketId Severity ServiceDisplayName Status CreatedDate +---- ----- --------------- -------- ------------------ ------ ----------- +test1 test title1 150010521000317 Moderate Virtual Machine running Linux Closed 2/5/2020 1:33:53 AM +``` + +## PARAMETERS + +### -AdditionalEmailAddress +Additional email addresses. +Email addresses listed here will be copied on any correspondence about the support ticket. + +```yaml +Type: System.String[] +Parameter Sets: UpdateByNameWithContactDetailParameterSet, UpdateByInputObjectWithContactDetailParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerContactDetail +Update Contact details on SupportTicket. + +```yaml +Type: Microsoft.Azure.Commands.Support.Models.PSContactProfile +Parameter Sets: UpdateByNameWithContactObjectParameterSet, UpdateByInputObjectWithContactObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerCountry +Customer country. +This must be a valid ISO Alpha-3 country code (ISO 3166). + +```yaml +Type: System.String +Parameter Sets: UpdateByNameWithContactDetailParameterSet, UpdateByInputObjectWithContactDetailParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerFirstName +Customer first name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameWithContactDetailParameterSet, UpdateByInputObjectWithContactDetailParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerLastName +Customer last name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameWithContactDetailParameterSet, UpdateByInputObjectWithContactDetailParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerPhoneNumber +Customer phone number. +This is required if preferred contact method is phone. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameWithContactDetailParameterSet, UpdateByInputObjectWithContactDetailParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerPreferredSupportLanguage +Customer preferred support language. +This must be a valid language-contry code for one of the supported languages listed here https://azure.microsoft.com/support/faq/. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameWithContactDetailParameterSet, UpdateByInputObjectWithContactDetailParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerPreferredTimeZone +Customer preferred time zone. +This must be a valid System.TimeZoneInfo.Id value. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameWithContactDetailParameterSet, UpdateByInputObjectWithContactDetailParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomerPrimaryEmailAddress +Customer primary email address. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameWithContactDetailParameterSet, UpdateByInputObjectWithContactDetailParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SupportTicket resource object that this cmdlet updates. + +```yaml +Type: Microsoft.Azure.Commands.Support.Models.PSSupportTicket +Parameter Sets: UpdateByInputObjectWithContactDetailParameterSet, UpdateByInputObjectWithContactObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of SupportTicket resource that this cmdlet updates. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameWithContactDetailParameterSet, UpdateByNameWithContactObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredContactMethod +Preferred contact method. + +```yaml +Type: Microsoft.Azure.Commands.Support.Models.ContactMethod +Parameter Sets: UpdateByNameWithContactDetailParameterSet, UpdateByInputObjectWithContactDetailParameterSet +Aliases: +Accepted values: Email, Phone + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Severity +Update Severity of SupportTicket. + +```yaml +Type: Microsoft.Azure.Commands.Support.Models.Severity +Parameter Sets: (All) +Aliases: +Accepted values: Minimal, Moderate, Critical, HighestCriticalImpact + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Update Status of SupportTicket. + +```yaml +Type: Microsoft.Azure.Commands.Support.Models.Status +Parameter Sets: (All) +Aliases: +Accepted values: Open, Closed + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Support.Models.PSSupportTicket + +## OUTPUTS + +### Microsoft.Azure.Commands.Support.Models.PSSupportTicket + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Add-AzSynapseDataFlowDebugSessionPackage.md b/azps-10.1.0/Az.Synapse/Add-AzSynapseDataFlowDebugSessionPackage.md new file mode 100644 index 0000000000..5668a725ab --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Add-AzSynapseDataFlowDebugSessionPackage.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/add-azsynapsedataflowdebugsessionpackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Add-AzSynapseDataFlowDebugSessionPackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Add-AzSynapseDataFlowDebugSessionPackage.md +--- + +# Add-AzSynapseDataFlowDebugSessionPackage + +## SYNOPSIS +Add data flow resource and its dependencies into specific data flow debug session. + +## SYNTAX + +### AddByName (Default) +``` +Add-AzSynapseDataFlowDebugSessionPackage -WorkspaceName <String> -PackageFile <String> [-SessionId <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AddByObject +``` +Add-AzSynapseDataFlowDebugSessionPackage -WorkspaceObject <PSSynapseWorkspace> -PackageFile <String> + [-SessionId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command attaches data flow resource and its dependencies to the specific debug session. The PowerShell command sequence for data flow debug workflow should be: + +Start-AzSynapseDataFlowDebugSession +Add-AzSynapseDataFlowDebugSessionPackage +Invoke-AzSynapseDataFlowDebugSessionCommand (repeat this step for different commands/targets, or repeat step 2-3 in order to change the package file) +Stop-AzSynapseDataFlowDebugSession + +## EXAMPLES + +### Example 1 +```powershell +Add-AzSynapseDataFlowDebugSessionPackage -WorkspaceName ContosoWorkspace -PackageFile "D:\dataflowps\addpackage.json" -SessionId 3afb278e-ac5f-469f-a0b6-2f04c3ab59bc +``` + +Add data flow package into debug session "3afb278e-ac5f-469f-a0b6-2f04c3ab59bc" under Synapse workspace "ContosoWorkspace". Pakcage file contains data flow debug resource, list of dataset debug resource, list of linked service debug resource, debug setting and session ID. [-SessionId] parameter is optional, if it is specified, it will replace the existing sessionId property in the package file. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Add-AzSynapseDataFlowDebugSessionPackage -PackageFile "D:\dataflowps\addpackage.json" -SessionId 3afb278e-ac5f-469f-a0b6-2f04c3ab59bc +``` + +Add data flow package into debug session "3afb278e-ac5f-469f-a0b6-2f04c3ab59bc" under Synapse workspace "ContosoWorkspace" through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionId +Identifier for Synapse data flow debug session. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: AddByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: AddByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSAddDataFlowToDebugSessionResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Add-AzSynapseKustoPoolLanguageExtension.md b/azps-10.1.0/Az.Synapse/Add-AzSynapseKustoPoolLanguageExtension.md new file mode 100644 index 0000000000..73416730f1 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Add-AzSynapseKustoPoolLanguageExtension.md @@ -0,0 +1,264 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/add-azsynapsekustopoollanguageextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Add-AzSynapseKustoPoolLanguageExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Add-AzSynapseKustoPoolLanguageExtension.md +--- + +# Add-AzSynapseKustoPoolLanguageExtension + +## SYNOPSIS +Add a list of language extensions that can run within KQL queries. + +## SYNTAX + +### AddExpanded (Default) +``` +Add-AzSynapseKustoPoolLanguageExtension -KustoPoolName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-Value <ILanguageExtension[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### AddViaIdentityExpanded +``` +Add-AzSynapseKustoPoolLanguageExtension -InputObject <ISynapseIdentity> [-Value <ILanguageExtension[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Add a list of language extensions that can run within KQL queries. + +## EXAMPLES + +### Example 1: Add a list of language extensions +```powershell +Add-AzSynapseKustoPoolLanguageExtension -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -Value (@{Name="R"}, @{Name="PYTHON"}) +``` + +The above command adds a list of language extensions that can run within KQL queries + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: AddViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The list of language extensions. +To construct, see NOTES section for VALUE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.ILanguageExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +VALUE <ILanguageExtension[]>: The list of language extensions. + - `[Name <LanguageExtensionName?>]`: The language extension name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Add-AzSynapseTriggerSubscription.md b/azps-10.1.0/Az.Synapse/Add-AzSynapseTriggerSubscription.md new file mode 100644 index 0000000000..47125143ec --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Add-AzSynapseTriggerSubscription.md @@ -0,0 +1,200 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/add-azsynapsetriggersubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Add-AzSynapseTriggerSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Add-AzSynapseTriggerSubscription.md +--- + +# Add-AzSynapseTriggerSubscription + +## SYNOPSIS +Subscribe the event trigger to external service events. + +## SYNTAX + +### AddByName (Default) +``` +Add-AzSynapseTriggerSubscription -WorkspaceName <String> -Name <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AddByObject +``` +Add-AzSynapseTriggerSubscription -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### AddByInputObject +``` +Add-AzSynapseTriggerSubscription -InputObject <PSTriggerResource> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzSynapseTriggerSubscription** cmdlet subscribes the event trigger to the specified external service events from the trigger defintion. + +## EXAMPLES + +### Example 1 +```powershell +Add-AzSynapseTriggerSubscription -WorkspaceName ContosoWorkspace -Name ContosoTrigger +``` + +This command will subscribe trigger called ContosoTrigger to the specified events from the trigger defintion. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Add-AzSynapseTriggerSubscription -Name ContosoTrigger +``` + +This command will subscribe trigger called ContosoTrigger to the specified events from the trigger defintion through pipeline. + +### Example 3 +```powershell +$trigger = Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger +$trigger | Add-AzSynapseTriggerSubscription +``` + +This command will subscribe trigger called ContosoTrigger to the specified events from the trigger defintion through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The trigger object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource +Parameter Sets: AddByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: AddByName, AddByObject +Aliases: TriggerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: AddByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: AddByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Az.Synapse.md b/azps-10.1.0/Az.Synapse/Az.Synapse.md new file mode 100644 index 0000000000..3493d73b75 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Az.Synapse.md @@ -0,0 +1,629 @@ +--- +Module Name: Az.Synapse +Module Guid: 89eceb4f-9916-4ec5-8499-d5cca97a9cae +Download Help Link: https://learn.microsoft.com/powershell/module/az.synapse +Help Version: 0.0.1.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Az.Synapse.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Az.Synapse.md +--- + +# Az.Synapse Module +## Description +The topics in this section document the Azure PowerShell cmdlets for Azure Synapse Analytics. + +## Az.Synapse Cmdlets +### [Add-AzSynapseDataFlowDebugSessionPackage](Add-AzSynapseDataFlowDebugSessionPackage.md) +Add data flow resource and its dependencies into specific data flow debug session. + +### [Add-AzSynapseTriggerSubscription](Add-AzSynapseTriggerSubscription.md) +Subscribe the event trigger to external service events. + +### [Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline](Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md) +Clears the vulnerability assessment rule baseline. + +### [Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan](Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan.md) +Converts a vulnerability assessment scan results to Excel format. + +### [Disable-AzSynapseActiveDirectoryOnlyAuthentication](Disable-AzSynapseActiveDirectoryOnlyAuthentication.md) +Disables Azure Active Directory (Azure AD) only authentication for a specific Synapse workspace. + +### [Disable-AzSynapseSqlAdvancedDataSecurity](Disable-AzSynapseSqlAdvancedDataSecurity.md) +Disables Advanced Data Security on a workspace. + +### [Disable-AzSynapseSqlPoolSensitivityRecommendation](Disable-AzSynapseSqlPoolSensitivityRecommendation.md) +Disables (dismisses) sensitivity recommendations on columns in the SQL pool. + +### [Enable-AzSynapseActiveDirectoryOnlyAuthentication](Enable-AzSynapseActiveDirectoryOnlyAuthentication.md) +Enables Azure Active Directory (Azure AD) only authentication for a specific Synapse workspace. + +### [Enable-AzSynapseSqlAdvancedDataSecurity](Enable-AzSynapseSqlAdvancedDataSecurity.md) +Enables Advanced Data Security on a workspace. + +### [Enable-AzSynapseSqlPoolSensitivityRecommendation](Enable-AzSynapseSqlPoolSensitivityRecommendation.md) +Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the SQL pool. + +### [Enable-AzSynapseWorkspace](Enable-AzSynapseWorkspace.md) +When creating an Azure Synapse Analytics workspace, you can choose to encrypt all data at rest in the workspace `with a customer-managed key which will provide double encryption to the workspace.You may need to set up the encryption environment firstly, such as to create a key vault with purge protection enable and specify Access Polices to the key vault. Then use this cmdlet to activate the new Azure Synapse Analytics workspace which double encryption is enabled using a customer-managed key. + +### [Export-AzSynapseNotebook](Export-AzSynapseNotebook.md) +Exports notbooks. + +### [Export-AzSynapseSqlScript](Export-AzSynapseSqlScript.md) +Exports a sql script from a Synapse workspace. + +### [Export-AzSynapseSparkConfiguration](Export-AzSynapseSparkConfiguration.md) +Exports a Synapse spark configuration to an output folder. + +### [Get-AzSynapseActiveDirectoryOnlyAuthentication](Get-AzSynapseActiveDirectoryOnlyAuthentication.md) +Gets Azure Active Directory (Azure AD) only authentication for a specific Synapse workspace. + +### [Get-AzSynapseActivityRun](Get-AzSynapseActivityRun.md) +Gets information about activity runs for a pipeline run. + +### [Get-AzSynapseDataFlow](Get-AzSynapseDataFlow.md) +Gets information about data flows in workspace. + +### [Get-AzSynapseDataFlowDebugSession](Get-AzSynapseDataFlowDebugSession.md) +Get all active data flow debug sessions in specified Synapse workspace. + +### [Get-AzSynapseDataset](Get-AzSynapseDataset.md) +Gets information about datasets in workspace. + +### [Get-AzSynapseDroppedSqlPool](Get-AzSynapseDroppedSqlPool.md) +Gets a dropped Sql pool backup of a Synapse Sql Pool. + +### [Get-AzSynapseFirewallRule](Get-AzSynapseFirewallRule.md) +Gets a Synapse Analytics Firewall Rule. + +### [Get-AzSynapseIntegrationRuntime](Get-AzSynapseIntegrationRuntime.md) +Gets information about integration runtime resources. + +### [Get-AzSynapseIntegrationRuntimeKey](Get-AzSynapseIntegrationRuntimeKey.md) +Gets keys for a self-hosted integration runtime. + +### [Get-AzSynapseIntegrationRuntimeMetric](Get-AzSynapseIntegrationRuntimeMetric.md) +Gets metric data for an integration runtime. + +### [Get-AzSynapseIntegrationRuntimeNode](Get-AzSynapseIntegrationRuntimeNode.md) +Gets an integration runtime node information. + +### [Get-AzSynapseLinkConnectionLinkTable](Get-AzSynapseLinkConnectionLinkTable.md) +Gets information about link tables under a link connection. + +### [Get-AzSynapseLinkConnectionLinkTableStatus](Get-AzSynapseLinkConnectionLinkTableStatus.md) +Gets status of link tables under a link connection. + +### [Get-AzSynapseLinkConnection](Get-AzSynapseLinkConnection.md) +Gets information about link connections in workspace. + +### [Get-AzSynapseLinkConnectionDetailedStatus](Get-AzSynapseLinkConnectionDetailedStatus.md) +Gets detail status about a link connection in workspace. + +### [Get-AzSynapseLinkedService](Get-AzSynapseLinkedService.md) +Gets information about linked services in workspace. + +### [Get-AzSynapseManagedIdentitySqlControlSetting](Get-AzSynapseManagedIdentitySqlControlSetting.md) +Gets Managed Identity Sql Control Settings. + +### [Get-AzSynapseManagedPrivateEndpoint](Get-AzSynapseManagedPrivateEndpoint.md) +Gets information about mananged private endpoints in a workspace + +### [Get-AzSynapseNotebook](Get-AzSynapseNotebook.md) +Gets information about notebooks in a workspace. + +### [Get-AzSynapsePipeline](Get-AzSynapsePipeline.md) +Gets information about pipelines in workspace. + +### [Get-AzSynapsePipelineRun](Get-AzSynapsePipelineRun.md) +Gets information about pipeline runs. + +### [Get-AzSynapseRoleAssignment](Get-AzSynapseRoleAssignment.md) +Gets a Synapse Analytics role assignment. + +### [Get-AzSynapseRoleDefinition](Get-AzSynapseRoleDefinition.md) +Gets a Synapse Analytics role definition. + +### [Get-AzSynapseRoleScope](Get-AzSynapseRoleScope.md) +Gets a Synapse Analytics role scope. + +### [Get-AzSynapseSparkConfiguration](Get-AzSynapseSparkConfiguration.md) +Gets information about spark configurations in a workspace. + +### [Get-AzSynapseSparkJob](Get-AzSynapseSparkJob.md) +Gets a Synapse Analytics Spark job. + +### [Get-AzSynapseSparkJobDefinition](Get-AzSynapseSparkJobDefinition.md) +Gets a Spark job definition in workspace. + +### [Get-AzSynapseSparkPool](Get-AzSynapseSparkPool.md) +Gets a Apache Spark pool in Azure Synapse Analytics. + +### [Get-AzSynapseSparkSession](Get-AzSynapseSparkSession.md) +Gets a Synapse Analytics Spark session. + +### [Get-AzSynapseSparkStatement](Get-AzSynapseSparkStatement.md) +Gets a Synapse Analytics Spark statement. + +### [Get-AzSynapseSqlActiveDirectoryAdministrator](Get-AzSynapseSqlActiveDirectoryAdministrator.md) +Gets information about an Azure AD administrator for Synapse Analytics Workspace. + +### [Get-AzSynapseSqlAdvancedDataSecurityPolicy](Get-AzSynapseSqlAdvancedDataSecurityPolicy.md) +Gets Advanced Data Security policy of a workspace. + +### [Get-AzSynapseSqlAdvancedThreatProtectionSetting](Get-AzSynapseSqlAdvancedThreatProtectionSetting.md) +Gets the advanced threat protection settings for a workspace. + +### [Get-AzSynapseSqlAuditSetting](Get-AzSynapseSqlAuditSetting.md) +Gets the auditing settings of an Azure Synapse Analytics Workspace. + +### [Get-AzSynapseSqlDatabase](Get-AzSynapseSqlDatabase.md) +This feature is in a limited preview, initially accessible only to certain subscriptions. Gets a Synapse Analytics SQL database. + +### [Get-AzSynapseSqlPool](Get-AzSynapseSqlPool.md) +Gets a Synapse Analytics SQL pool. + +### [Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting](Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md) +Gets the advanced threat protection settings for a SQL pool. + +### [Get-AzSynapseSqlPoolAuditSetting](Get-AzSynapseSqlPoolAuditSetting.md) +Gets the auditing settings of an Azure Synapse Analytics SQL pool. + +### [Get-AzSynapseSqlPoolGeoBackup](Get-AzSynapseSqlPoolGeoBackup.md) +Gets a geo-redundant backup of a Sql Pool. + +### [Get-AzSynapseSqlPoolRestorePoint](Get-AzSynapseSqlPoolRestorePoint.md) +Retrieves the distinct restore points from which a Synapse Analytics SQL pool can be restored. + +### [Get-AzSynapseSqlPoolSensitivityClassification](Get-AzSynapseSqlPoolSensitivityClassification.md) +Gets the current information types and sensitivity labels of columns in the SQL pool. + +### [Get-AzSynapseSqlPoolSensitivityRecommendation](Get-AzSynapseSqlPoolSensitivityRecommendation.md) +Gets the recommended information types and sensitivity labels of columns in the SQL pool. + +### [Get-AzSynapseSqlPoolTransparentDataEncryption](Get-AzSynapseSqlPoolTransparentDataEncryption.md) +Gets the TDE state for a SQL pool. + +### [Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline](Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md) +Gets the vulnerability assessment rule baseline. + +### [Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord](Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord.md) +Gets all vulnerability assessment scan record(s) associated with a given sql pool. + +### [Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting](Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md) +Gets the vulnerability assessment settings of a SQL pool. + +### [Get-AzSynapseSqlScript](Get-AzSynapseSqlScript.md) +Gets information about sql scripts in a Synapse workspace. + +### [Get-AzSynapseSqlVulnerabilityAssessmentSetting](Get-AzSynapseSqlVulnerabilityAssessmentSetting.md) +Gets the vulnerability assessment settings of a workspace. + +### [Get-AzSynapseTrigger](Get-AzSynapseTrigger.md) +Gets information about triggers in a workspace. + +### [Get-AzSynapseTriggerRun](Get-AzSynapseTriggerRun.md) +Returns information about trigger runs. + +### [Get-AzSynapseTriggerSubscriptionStatus](Get-AzSynapseTriggerSubscriptionStatus.md) +Get the status of the subscription for the event trigger to the specified external service events. + +### [Get-AzSynapseWorkspace](Get-AzSynapseWorkspace.md) +Gets a Synapse Analytics workspace. + +### [Get-AzSynapseWorkspaceKey](Get-AzSynapseWorkspaceKey.md) +Gets a workspace key. + +### [Get-AzSynapseWorkspacePackage](Get-AzSynapseWorkspacePackage.md) +Gets a workspace package. + +### [Invoke-AzSynapseDataFlowDebugSessionCommand](Invoke-AzSynapseDataFlowDebugSessionCommand.md) +Invoke debug action in data flow debug session. + +### [Invoke-AzSynapseIntegrationRuntimeUpgrade](Invoke-AzSynapseIntegrationRuntimeUpgrade.md) +Upgrades self-hosted integration runtime. + +### [Invoke-AzSynapsePipeline](Invoke-AzSynapsePipeline.md) +Invokes a pipeline to start a run for it. + +### [Invoke-AzSynapseSparkStatement](Invoke-AzSynapseSparkStatement.md) +Invokes a Synapse Analytics Spark statement. + +### [Invoke-AzSynapseTriggerRun](Invoke-AzSynapseTriggerRun.md) +Invokes another instance of a trigger run. + +### [New-AzSynapseFirewallRule](New-AzSynapseFirewallRule.md) +Creates a Synapse Analytics Firewall Rule. + +### [New-AzSynapseGitRepositoryConfig](New-AzSynapseGitRepositoryConfig.md) +Creates Git repository configuration. + +### [New-AzSynapseIntegrationRuntimeKey](New-AzSynapseIntegrationRuntimeKey.md) +Regenerate self-hosted integration runtime key. + +### [New-AzSynapseLinkedServiceEncryptedCredential](New-AzSynapseLinkedServiceEncryptedCredential.md) +Encrypt credential in linked service with specified integration runtime. + +### [New-AzSynapseManagedPrivateEndpoint](New-AzSynapseManagedPrivateEndpoint.md) +Creates or updates a managed private endpoint in a workspace. + +### [New-AzSynapseManagedVirtualNetworkConfig](New-AzSynapseManagedVirtualNetworkConfig.md) +Creates managed virtual network configuration. + +### [New-AzSynapseRoleAssignment](New-AzSynapseRoleAssignment.md) +Creates a Synapse Analytics role assignment. + +### [New-AzSynapseSparkConfiguration](New-AzSynapseSparkConfiguration.md) +Creates or updates a spark configuration in a workspace. + +### [New-AzSynapseSparkPool](New-AzSynapseSparkPool.md) +Creates a Synapse Analytics Spark pool. + +### [New-AzSynapseSqlDatabase](New-AzSynapseSqlDatabase.md) +This feature is in a limited preview, initially accessible only to certain subscriptions. Creates a Synapse Analytics SQL database. + +### [New-AzSynapseSqlPool](New-AzSynapseSqlPool.md) +Creates a Synapse Analytics SQL pool. + +### [New-AzSynapseSqlPoolRestorePoint](New-AzSynapseSqlPoolRestorePoint.md) +Creates a new restore point in an Azure Synapse Analytics SQL pool. + +### [New-AzSynapseWorkspace](New-AzSynapseWorkspace.md) +Creates a Synapse Analytics workspace. + +### [New-AzSynapseWorkspaceKey](New-AzSynapseWorkspaceKey.md) +Creates a workspace key. + +### [New-AzSynapseWorkspacePackage](New-AzSynapseWorkspacePackage.md) +Uploads a local workspace package file to an Azure Synapse workspace. + +### [Remove-AzSynapseDataFlow](Remove-AzSynapseDataFlow.md) +Removes a data flow from workspace. + +### [Remove-AzSynapseDataset](Remove-AzSynapseDataset.md) +Removes a dataset from workspace. + +### [Remove-AzSynapseFirewallRule](Remove-AzSynapseFirewallRule.md) +Deletes a Synapse Analytics Firewall Rule. + +### [Remove-AzSynapseIntegrationRuntime](Remove-AzSynapseIntegrationRuntime.md) +Removes an integration runtime. + +### [Remove-AzSynapseIntegrationRuntimeNode](Remove-AzSynapseIntegrationRuntimeNode.md) +Remove a node with the given name on an integration runtime. + +### [Remove-AzSynapseLinkedService](Remove-AzSynapseLinkedService.md) +Removes a linked service from workspace. + +### [Remove-AzSynapseManagedPrivateEndpoint](Remove-AzSynapseManagedPrivateEndpoint.md) +Removes a managed private endpoint from a workspace. + +### [Remove-AzSynapseNotebook](Remove-AzSynapseNotebook.md) +Removes a notebook from a workspace. + +### [Remove-AzSynapsePipeline](Remove-AzSynapsePipeline.md) +Removes a pipeline from workspace. + +### [Remove-AzSynapseRoleAssignment](Remove-AzSynapseRoleAssignment.md) +Deletes a Synapse Analytics role assignment. + +### [Remove-AzSynapseSparkConfiguration](Remove-AzSynapseSparkConfiguration.md) +Removes a spark configuration from a workspace. + +### [Remove-AzSynapseSparkJobDefinition](Remove-AzSynapseSparkJobDefinition.md) +Removes a Spark job definition from workspace. + +### [Remove-AzSynapseSparkPool](Remove-AzSynapseSparkPool.md) +Deletes a Apache Spark pool in Azure Synapse Analytics. + +### [Remove-AzSynapseSqlActiveDirectoryAdministrator](Remove-AzSynapseSqlActiveDirectoryAdministrator.md) +Removes an Azure AD administrator for Synapse Analytics Workspace. + +### [Remove-AzSynapseSqlDatabase](Remove-AzSynapseSqlDatabase.md) +This feature is in a limited preview, initially accessible only to certain subscriptions. Deletes a Synapse Analytics SQL database. + +### [Remove-AzSynapseSqlPool](Remove-AzSynapseSqlPool.md) +Deletes a Synapse Analytics SQL pool. + +### [Remove-AzSynapseSqlPoolRestorePoint](Remove-AzSynapseSqlPoolRestorePoint.md) +Deletes a Synapse Analytics SQL pool restore point. + +### [Remove-AzSynapseSqlPoolSensitivityClassification](Remove-AzSynapseSqlPoolSensitivityClassification.md) +Removes the information types and sensitivity labels of columns in the SQL pool. + +### [Remove-AzSynapseSqlScript](Remove-AzSynapseSqlScript.md) +Removes a sql script from a Synapse workspace. + +### [Remove-AzSynapseTrigger](Remove-AzSynapseTrigger.md) +Removes a trigger from a workspace. + +### [Remove-AzSynapseTriggerSubscription](Remove-AzSynapseTriggerSubscription.md) +Unsubscribe the event trigger to external service events. + +### [Remove-AzSynapseWorkspace](Remove-AzSynapseWorkspace.md) +Deletes a Synapse Analytics workspace. + +### [Remove-AzSynapseWorkspaceKey](Remove-AzSynapseWorkspaceKey.md) +Deletes a workspace key. + +### [Remove-AzSynapseWorkspacePackage](Remove-AzSynapseWorkspacePackage.md) +Deletes a workspace package. + +### [Reset-AzSynapseSparkSessionTimeout](Reset-AzSynapseSparkSessionTimeout.md) +Resets timeout of a Synapse Analytics Spark session. + +### [Reset-AzSynapseSqlAdvancedThreatProtectionSetting](Reset-AzSynapseSqlAdvancedThreatProtectionSetting.md) +Removes the advanced threat protection settings from a workspace. + +### [Reset-AzSynapseSqlAuditSetting](Reset-AzSynapseSqlAuditSetting.md) +Removes the auditing settings of an Azure Synapse Analytics Workspace. + +### [Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting](Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md) +Removes the advanced threat protection settings from a SQL pool. + +### [Reset-AzSynapseSqlPoolAuditSetting](Reset-AzSynapseSqlPoolAuditSetting.md) +Removes the auditing settings of an Azure Synapse Analytics SQL pool. + +### [Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting](Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md) +Clears the vulnerability assessment settings of a SQL pool. + +### [Reset-AzSynapseSqlVulnerabilityAssessmentSetting](Reset-AzSynapseSqlVulnerabilityAssessmentSetting.md) +Clears the vulnerability assessment settings of a workspace. + +### [Restore-AzSynapseSqlPool](Restore-AzSynapseSqlPool.md) +Restores a Synapse Analytics SQL pool. + +### [Resume-AzSynapseSqlPool](Resume-AzSynapseSqlPool.md) +Resumes a Synapse Analytics SQL pool. + +### [Set-AzSynapseDataFlow](Set-AzSynapseDataFlow.md) +Creates or updates a data flow in workspace. + +### [Set-AzSynapseDataset](Set-AzSynapseDataset.md) +Creates or updates a dataset in workspace. + +### [Set-AzSynapseIntegrationRuntime](Set-AzSynapseIntegrationRuntime.md) +Updates an integration runtime. + +### [Set-AzSynapseLinkConnectionLinkTable](Set-AzSynapseLinkConnectionLinkTable.md) +Edits link tables under a link connection. + +### [Set-AzSynapseLinkConnection](Set-AzSynapseLinkConnection.md) +Creates or updates a link connection in workspace. + +### [Set-AzSynapseLinkedService](Set-AzSynapseLinkedService.md) +Links a data store or a cloud service to workspace. + +### [Set-AzSynapseManagedIdentitySqlControlSetting](Set-AzSynapseManagedIdentitySqlControlSetting.md) +Updates managed identity SQL control settings to workspace. + +### [Set-AzSynapseNotebook](Set-AzSynapseNotebook.md) +Creates or updates a notebook in a workspace. + +### [Set-AzSynapsePipeline](Set-AzSynapsePipeline.md) +Creates a pipeline in workspace. + +### [Set-AzSynapseSparkJobDefinition](Set-AzSynapseSparkJobDefinition.md) +Creates a Spark job definition in workspace. + +### [Set-AzSynapseSqlActiveDirectoryAdministrator](Set-AzSynapseSqlActiveDirectoryAdministrator.md) +Provisions an Azure AD administrator for Synapse Analytics SQL pool. + +### [Set-AzSynapseSqlAuditSetting](Set-AzSynapseSqlAuditSetting.md) +Changes the auditing settings of an Azure Synapse Analytics Workspace. + +### [Set-AzSynapseSqlPoolAuditSetting](Set-AzSynapseSqlPoolAuditSetting.md) +Changes the auditing settings for an Azure Synapse Analytics SQL pool. + +### [Set-AzSynapseSqlPoolSensitivityClassification](Set-AzSynapseSqlPoolSensitivityClassification.md) +Sets the information types and sensitivity labels of columns in the SQL pool. + +### [Set-AzSynapseSqlPoolTransparentDataEncryption](Set-AzSynapseSqlPoolTransparentDataEncryption.md) +Modifies TDE property for a SQL pool. + +### [Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline](Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md) +Sets the vulnerability assessment rule baseline. + +### [Set-AzSynapseSqlScript](Set-AzSynapseSqlScript.md) +Creates or updates a SQL script in a workspace. + +### [Set-AzSynapseTrigger](Set-AzSynapseTrigger.md) +Creates a trigger in a workspace. + +### [Start-AzSynapseDataFlowDebugSession](Start-AzSynapseDataFlowDebugSession.md) +Starts a Synapse Analytics data flow debug session in Synapse Workspace. + +### [Start-AzSynapseIntegrationRuntime](Start-AzSynapseIntegrationRuntime.md) +Starts a managed dedicated integration runtime. + +### [Start-AzSynapseSparkSession](Start-AzSynapseSparkSession.md) +Starts a Synapse Analytics Spark session. + +### [Start-AzSynapseSqlPoolVulnerabilityAssessmentScan](Start-AzSynapseSqlPoolVulnerabilityAssessmentScan.md) +Starts a vulnerability assessment scan. + +### [Start-AzSynapseTrigger](Start-AzSynapseTrigger.md) +Starts a trigger in a workspace. + +### [Stop-AzSynapseDataFlowDebugSession](Stop-AzSynapseDataFlowDebugSession.md) +Stops a data flow debug session in a workspace. + +### [Stop-AzSynapseIntegrationRuntime](Stop-AzSynapseIntegrationRuntime.md) +Stops a managed dedicated integration runtime. + +### [Stop-AzSynapsePipelineRun](Stop-AzSynapsePipelineRun.md) +Stops a pipeline run in a workspace. + +### [Stop-AzSynapseSparkJob](Stop-AzSynapseSparkJob.md) +Cancels a Synapse Analytics Spark job. + +### [Stop-AzSynapseSparkSession](Stop-AzSynapseSparkSession.md) +Stops a Synapse Analytics Spark session. + +### [Stop-AzSynapseSparkStatement](Stop-AzSynapseSparkStatement.md) +Cancels a Synapse Analytics Spark statement. + +### [Stop-AzSynapseTrigger](Stop-AzSynapseTrigger.md) +Stops a trigger in a workspace. + +### [Stop-AzSynapseTriggerRun](Stop-AzSynapseTriggerRun.md) +Stops a trigger run in a synapse workspace. + +### [Submit-AzSynapseSparkJob](Submit-AzSynapseSparkJob.md) +Submits a Synapse Analytics Spark job. + +### [Suspend-AzSynapseSqlPool](Suspend-AzSynapseSqlPool.md) +Suspends a Synapse Analytics SQL pool. + +### [Sync-AzSynapseIntegrationRuntimeCredential](Sync-AzSynapseIntegrationRuntimeCredential.md) +Synchronizes credentials among integration runtime nodes. + +### [Test-AzSynapseSparkPool](Test-AzSynapseSparkPool.md) +Checks for the existence of a Synapse Analytics Spark pool. + +### [Test-AzSynapseSqlDatabase](Test-AzSynapseSqlDatabase.md) +This feature is in a limited preview, initially accessible only to certain subscriptions. Checks for the existence of a Synapse Analytics SQL database. + +### [Test-AzSynapseSqlPool](Test-AzSynapseSqlPool.md) +Checks for the existence of a Synapse Analytics SQL pool. + +### [Test-AzSynapseWorkspace](Test-AzSynapseWorkspace.md) +Checks for the existence of a Synapse Analytics workspace. + +### [Update-AzSynapseFirewallRule](Update-AzSynapseFirewallRule.md) +Updates a Synapse Analytics Firewall Rule. + +### [Update-AzSynapseIntegrationRuntime](Update-AzSynapseIntegrationRuntime.md) +Updates an integration runtime. + +### [Update-AzSynapseIntegrationRuntimeNode](Update-AzSynapseIntegrationRuntimeNode.md) +Updates self-hosted integration runtime node. + +### [Update-AzSynapseLinkConnectionLandingZoneCredential](Update-AzSynapseLinkConnectionLandingZoneCredential.md) +Updates the landing zone credential of a link connection. + +### [Update-AzSynapseManagedVirtualNetworkConfig](Update-AzSynapseManagedVirtualNetworkConfig.md) +Updates managed virtual network configuration to workspace. + +### [Update-AzSynapseSparkPool](Update-AzSynapseSparkPool.md) +Updates a Apache Spark pool in Azure Synapse Analytics. + +### [Update-AzSynapseSqlAdvancedThreatProtectionSetting](Update-AzSynapseSqlAdvancedThreatProtectionSetting.md) +Updates an advanced threat protection settings on a workspace. + +### [Update-AzSynapseSqlDatabase](Update-AzSynapseSqlDatabase.md) +This feature is in a limited preview, initially accessible only to certain subscriptions. Updates a Synapse Analytics SQL database. + +### [Update-AzSynapseSqlPool](Update-AzSynapseSqlPool.md) +Updates a Synapse Analytics SQL pool. + +### [Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting](Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md) +Sets a advanced threat protection settings on a SQL pool. + +### [Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting](Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md) +Updates the vulnerability assessment settings of a SQL pool. + +### [Update-AzSynapseSqlVulnerabilityAssessmentSetting](Update-AzSynapseSqlVulnerabilityAssessmentSetting.md) +Updates the vulnerability assessment settings of a workspace. + +### [Update-AzSynapseWorkspace](Update-AzSynapseWorkspace.md) +Updates a Synapse Analytics workspace. + +### [Wait-AzSynapseSparkJob](Wait-AzSynapseSparkJob.md) +Waits for a Synapse Analytics Spark job to complete. + +### [Add-AzSynapseKustoPoolLanguageExtension](Add-AzSynapseKustoPoolLanguageExtension.md) +Add a list of language extensions that can run within KQL queries. + +### [Get-AzSynapseKustoPool](Get-AzSynapseKustoPool.md) +Gets a Kusto pool. + +### [Get-AzSynapseKustoPoolAttachedDatabaseConfiguration](Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md) +Returns an attached database configuration. + +### [Get-AzSynapseKustoPoolDatabase](Get-AzSynapseKustoPoolDatabase.md) +Returns a database. + +### [Get-AzSynapseKustoPoolDatabasePrincipalAssignment](Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md) +Gets a Kusto pool database principalAssignment. + +### [Get-AzSynapseKustoPoolDataConnection](Get-AzSynapseKustoPoolDataConnection.md) +Returns a data connection. + +### [Get-AzSynapseKustoPoolFollowerDatabase](Get-AzSynapseKustoPoolFollowerDatabase.md) +Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool. + +### [Get-AzSynapseKustoPoolLanguageExtension](Get-AzSynapseKustoPoolLanguageExtension.md) +Returns a list of language extensions that can run within KQL queries. + +### [Get-AzSynapseKustoPoolPrincipalAssignment](Get-AzSynapseKustoPoolPrincipalAssignment.md) +Gets a Kusto pool principalAssignment. + +### [Get-AzSynapseKustoPoolSku](Get-AzSynapseKustoPoolSku.md) +Lists eligible SKUs for Kusto Pool resource. + +### [Invoke-AzSynapseDetachKustoPoolFollowerDatabase](Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md) +Detaches all followers of a database owned by this Kusto Pool. + +### [New-AzSynapseKustoPool](New-AzSynapseKustoPool.md) +Create or update a Kusto pool. + +### [New-AzSynapseKustoPoolAttachedDatabaseConfiguration](New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md) +Creates or updates an attached database configuration. + +### [New-AzSynapseKustoPoolDatabase](New-AzSynapseKustoPoolDatabase.md) +Creates or updates a database. + +### [New-AzSynapseKustoPoolDatabasePrincipalAssignment](New-AzSynapseKustoPoolDatabasePrincipalAssignment.md) +Creates a Kusto pool database principalAssignment. + +### [New-AzSynapseKustoPoolDataConnection](New-AzSynapseKustoPoolDataConnection.md) +Creates or updates a data connection. + +### [New-AzSynapseKustoPoolPrincipalAssignment](New-AzSynapseKustoPoolPrincipalAssignment.md) +Create a Kusto pool principalAssignment. + +### [Remove-AzSynapseKustoPool](Remove-AzSynapseKustoPool.md) +Deletes a Kusto pool. + +### [Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration](Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md) +Deletes the attached database configuration with the given name. + +### [Remove-AzSynapseKustoPoolDatabase](Remove-AzSynapseKustoPoolDatabase.md) +Deletes the database with the given name. + +### [Remove-AzSynapseKustoPoolDatabasePrincipalAssignment](Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md) +Deletes a Kusto pool principalAssignment. + +### [Remove-AzSynapseKustoPoolDataConnection](Remove-AzSynapseKustoPoolDataConnection.md) +Deletes the data connection with the given name. + +### [Remove-AzSynapseKustoPoolLanguageExtension](Remove-AzSynapseKustoPoolLanguageExtension.md) +Remove a list of language extensions that can run within KQL queries. + +### [Remove-AzSynapseKustoPoolPrincipalAssignment](Remove-AzSynapseKustoPoolPrincipalAssignment.md) +Deletes a Kusto pool principalAssignment. + +### [Remove-AzSynapseLinkConnection](Remove-AzSynapseLinkConnection.md) +Deletes a link connection from workspace. + +### [Start-AzSynapseKustoPool](Start-AzSynapseKustoPool.md) +Starts a Kusto pool. + +### [Start-AzSynapseLinkConnection](Start-AzSynapseLinkConnection.md) +Starts a link connection. + +### [Stop-AzSynapseKustoPool](Stop-AzSynapseKustoPool.md) +Stops a Kusto pool. + +### [Stop-AzSynapseLinkConnection](Stop-AzSynapseLinkConnection.md) +Stops a link connection. + +### [Update-AzSynapseKustoPool](Update-AzSynapseKustoPool.md) +Update a Kusto Kusto Pool. + +### [Update-AzSynapseKustoPoolDatabase](Update-AzSynapseKustoPoolDatabase.md) +Updates a database. + +### [Update-AzSynapseKustoPoolDataConnection](Update-AzSynapseKustoPoolDataConnection.md) +Updates a data connection. \ No newline at end of file diff --git a/azps-10.1.0/Az.Synapse/Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md b/azps-10.1.0/Az.Synapse/Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md new file mode 100644 index 0000000000..c67c9087ba --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/clear-azsynapsesqlpoolvulnerabilityassessmentrulebaseline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md +--- + +# Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline + +## SYNOPSIS +Clears the vulnerability assessment rule baseline. + +## SYNTAX + +``` +Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline [-WorkspaceName] <String> [-Name] <String> + [-InputObject <PSSynapseSqlPool>] -RuleId <String> [-RuleAppliesToMaster] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline** cmdlet removes the vulnerability assessment rule baseline. +Note that you need to run *Enable-AzSynapseSqlAdvancedDataSecurity* and *Update-AzSynapseSqlVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1: Clears the vulnerability assessment rule baseline +```powershell +Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ContosoResourceGroup" ` + -WorkspaceName "ContosoWorkspace" ` + -SqlPoolName "ContosoSqlPool" ` + -RuleId "VA2108" +``` + +### Example 2: Clears the vulnerability assessment rule baseline from a SQL pool object +```powershell +Get-AzSynapseSqlPool ` + -ResourceGroupName "ContosoResourceGroup" ` + -WorkspaceName "ContosoWorkspace" ` + -Name "ContosoSqlPool" ` + | Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline ` + -RuleId "VA2108" ` + -RuleAppliesToMaster +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SqlPoolName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleAppliesToMaster +Specifies whether the baseline results should apply on a workspace level rule identified by the RuleId + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleId +The rule ID which identifies the rule to set the baseline results to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.VulnerabilityAssessment.SqlPoolVulnerabilityAssessmentRuleBaselineModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan.md b/azps-10.1.0/Az.Synapse/Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan.md new file mode 100644 index 0000000000..2ea292cd7d --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/convert-azsynapsesqlpoolvulnerabilityassessmentscan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan.md +--- + +# Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan + +## SYNOPSIS +Converts a vulnerability assessment scan results to Excel format. + +## SYNTAX + +### ConvertByInputObjectParameterSet (Default) +``` +Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan [-InputObject <PSVulnerabilityAssessmentScanRecordModel>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ConvertByNameParameterSet +``` +Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> -ScanId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan** cmdlet converts a scan results, that resides in the customer storage, identified by the ScanId parameter to an Excel format placed in the storage +Note that you need to run *Enable-AzSynapseSqlAdvancedThreatProtection* and *Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1: Converts vulnerability assessment scan results and saves them to local disk +```powershell +Start-AzSynapseSqlPoolVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -WorkspaceName "WorkspaceName01" ` + -Name "Name01" ` + -ScanId "myScan" + +$convert_scan_results = Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -WorkspaceName "WorkspaceName01" ` + -Name "Name01" ` + -ScanId "myScan" +``` + +```output +ResourceGroupName : "ResourceGroup01" +WorkspaceName : "WorkspaceName01" +Name : "Name01" +ScanId : "myScan" +ExportedReportLocation : "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/WorkspaceName01/Name01/scan_myScan.xlsx" +``` + +### Example 2: Converts a vulnerability assessment scan results from a scan record +```powershell +Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord ` + -ResourceGroupName "ResourceGroup01" ` + -WorkspaceName "WorkspaceName01" ` + -Name "Name01" ` + -ScanId "myScan" ` + | Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan +``` + +```output +ResourceGroupName : "ResourceGroup01" +WorkspaceName : "WorkspaceName01" +Name : "Name01" +ScanId : "myScan" +ExportedReportLocation : "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/WorkspaceName01/Name01 + /scan_myScan.xlsx" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The scan record object to use in order to convert a Vulnerability Assessment scan. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.VulnerabilityAssessment.Model.PSVulnerabilityAssessmentScanRecordModel +Parameter Sets: ConvertByInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: ConvertByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: ConvertByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScanId +Specifies the scan ID. + +```yaml +Type: System.String +Parameter Sets: ConvertByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ConvertByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Synapse.Models.PSVulnerabilityAssessmentScanRecordModel + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSVulnerabilityAssessmentScanExportModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Disable-AzSynapseActiveDirectoryOnlyAuthentication.md b/azps-10.1.0/Az.Synapse/Disable-AzSynapseActiveDirectoryOnlyAuthentication.md new file mode 100644 index 0000000000..7d5b51ceac --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Disable-AzSynapseActiveDirectoryOnlyAuthentication.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/disable-azsynapseactivedirectoryonlyauthentication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Disable-AzSynapseActiveDirectoryOnlyAuthentication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Disable-AzSynapseActiveDirectoryOnlyAuthentication.md +--- + +# Disable-AzSynapseActiveDirectoryOnlyAuthentication + +## SYNOPSIS +Disables Azure Active Directory (Azure AD) only authentication for a specific Synapse workspace. + +## SYNTAX + +### DisableByNameParameterSet (Default) +``` +Disable-AzSynapseActiveDirectoryOnlyAuthentication [-ResourceGroupName <String>] -WorkspaceName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DisableByParentObjectParameterSet +``` +Disable-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DisableByResourceIdParameterSet +``` +Disable-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzSynapseActiveDirectoryOnlyAuthentication** cmdlet disables Azure Active Directory (Azure AD) only authentication for a specific Synapse workspace. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceName ContosoWorkspace +``` +```output +WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate +------------- --------------------------------- ----- ------------ +ContosoWorkspace False Consistent 3/23/2022 8:27:47 AM +``` +This command disables Azure AD only authentication for workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -WorkspaceName ContosoWorkspace +$ws | Disable-AzSynapseActiveDirectoryOnlyAuthentication +``` +```output +WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate +------------- --------------------------------- ----- ------------ +ContosoWorkspace False Consistent 3/23/2022 8:27:47 AM +``` +This command disables Azure AD only authentication for workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +Disable-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace +``` +```outout +WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate +------------- --------------------------------- ----- ------------ +ContosoWorkspace False Consistent 3/23/2022 8:27:47 AM +``` +This command disables Azure AD only authentication for workspace ContosoWorkspace by ResourceId. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: DisableByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: DisableByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: DisableByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: DisableByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSAzureADOnlyAuthentication + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Disable-AzSynapseSqlAdvancedDataSecurity.md b/azps-10.1.0/Az.Synapse/Disable-AzSynapseSqlAdvancedDataSecurity.md new file mode 100644 index 0000000000..71f4d6ac2f --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Disable-AzSynapseSqlAdvancedDataSecurity.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/disable-azsynapsesqladvanceddatasecurity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Disable-AzSynapseSqlAdvancedDataSecurity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Disable-AzSynapseSqlAdvancedDataSecurity.md +--- + +# Disable-AzSynapseSqlAdvancedDataSecurity + +## SYNOPSIS +Disables Advanced Data Security on a workspace. + +## SYNTAX + +### DisableByNameParameterSet (Default) +``` +Disable-AzSynapseSqlAdvancedDataSecurity [-ResourceGroupName <String>] -WorkspaceName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DisableByInputObjectParameterSet +``` +Disable-AzSynapseSqlAdvancedDataSecurity -InputObject <PSSynapseWorkspace> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DisableByResourceIdParameterSet +``` +Disable-AzSynapseSqlAdvancedDataSecurity -ResourceId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzSynapseSqlAdvancedDataSecurity** cmdlet disables Advanced Data Security on a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Disable-AzSynapseSqlAdvancedDataSecurity -WorkspaceName ContosoWorkspace +``` + +This command disables Advanced Data Security on the workspace named ContosoWorkspace. + +### Example 1 +```powershell +Get-AzSynapseWorkspace -Name ContosoWorkspace | Disable-AzSynapseSqlAdvancedDataSecurity +``` + +This command disables Advanced Data Security on the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: DisableByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: DisableByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: DisableByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: DisableByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.WorkspaceAdvancedDataSecurityPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Disable-AzSynapseSqlPoolSensitivityRecommendation.md b/azps-10.1.0/Az.Synapse/Disable-AzSynapseSqlPoolSensitivityRecommendation.md new file mode 100644 index 0000000000..39fc36cf9f --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Disable-AzSynapseSqlPoolSensitivityRecommendation.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/disable-azsynapsesqlpoolsensitivityrecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Disable-AzSynapseSqlPoolSensitivityRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Disable-AzSynapseSqlPoolSensitivityRecommendation.md +--- + +# Disable-AzSynapseSqlPoolSensitivityRecommendation + +## SYNOPSIS +Disables (dismisses) sensitivity recommendations on columns in the SQL pool. + +## SYNTAX + +### InputObjectParameterSet (Default) +``` +Disable-AzSynapseSqlPoolSensitivityRecommendation -InputObject <SqlPoolSensitivityClassificationModel> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Disable-AzSynapseSqlPoolSensitivityRecommendation [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-SqlPoolName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlPoolObjectColumnParameterSet +``` +Disable-AzSynapseSqlPoolSensitivityRecommendation -SqlPoolObject <PSSynapseSqlPool> -SchemaName <String> + -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Disable-AzSynapseSqlPoolSensitivityRecommendation cmdlet disables (dismisses) sensitivity recommendations on columns in the SQL pool. + +## EXAMPLES + +### Example 1: Disable sensitivity recommendations on a given column in an Azure Synapse SQL pool. +```powershell +Disable-AzSynapseSqlPoolSensitivityRecommendation -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool -SchemaName schema -TableName table -ColumnName column +``` + +### Example 2: Disable sensitivity recommendations on columns which have sensitivity recommendations in an Azure Synapse SQL pool using Piping. +```powershell +Get-AzSynapseSqlPoolSensitivityRecommendation -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool | Disable-AzSynapseSqlPoolSensitivityRecommendation +``` + +### Example 3: Disable sensitivity recommendations on a given column in an Azure Synapse SQL pool using Piping. +```powershell +Get-AzSynapseSqlPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSqlPool | Disable-AzSynapseSqlPoolSensitivityRecommendation -SchemaName schema -TableName table -ColumnName column +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +An object representing a SQL Pool Sensitivity Classification. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.DataClassification.SqlPoolSensitivityClassificationModel +Parameter Sets: InputObjectParameterSet +Aliases: ClassificationObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolName +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.DataClassification.SqlPoolSensitivityClassificationModel + +### System.String + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Enable-AzSynapseActiveDirectoryOnlyAuthentication.md b/azps-10.1.0/Az.Synapse/Enable-AzSynapseActiveDirectoryOnlyAuthentication.md new file mode 100644 index 0000000000..56e59c4bf9 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Enable-AzSynapseActiveDirectoryOnlyAuthentication.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/enable-azsynapseactivedirectoryonlyauthentication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Enable-AzSynapseActiveDirectoryOnlyAuthentication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Enable-AzSynapseActiveDirectoryOnlyAuthentication.md +--- + +# Enable-AzSynapseActiveDirectoryOnlyAuthentication + +## SYNOPSIS +Enables Azure Active Directory (Azure AD) only authentication for a specific Synapse workspace. + +## SYNTAX + +### EnableByNameParameterSet (Default) +``` +Enable-AzSynapseActiveDirectoryOnlyAuthentication [-ResourceGroupName <String>] -WorkspaceName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EnableByParentObjectParameterSet +``` +Enable-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EnableByResourceIdParameterSet +``` +Enable-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzSynapseActiveDirectoryOnlyAuthentication** cmdlet enables Azure Active Directory (Azure AD) only authentication for a specific Synapse workspace. + +## EXAMPLES + +### Example 1 +```powershell +Enable-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceName ContosoWorkspace +``` +```output +WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate +------------- --------------------------------- ----- ------------ +ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM +``` +This command enables Azure AD only authentication for workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -WorkspaceName ContosoWorkspace +$ws | Enable-AzSynapseActiveDirectoryOnlyAuthentication +``` +```output +WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate +------------- --------------------------------- ----- ------------ +ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM +``` +This command enables Azure AD only authentication for workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +Enable-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace +``` +```output +WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate +------------- --------------------------------- ----- ------------ +ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM +``` +This command enables Azure AD only authentication for workspace ContosoWorkspace by ResourceId. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: EnableByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: EnableByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: EnableByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: EnableByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSAzureADOnlyAuthentication + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Enable-AzSynapseSqlAdvancedDataSecurity.md b/azps-10.1.0/Az.Synapse/Enable-AzSynapseSqlAdvancedDataSecurity.md new file mode 100644 index 0000000000..7f05fb0cf6 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Enable-AzSynapseSqlAdvancedDataSecurity.md @@ -0,0 +1,230 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/enable-azsynapsesqladvanceddatasecurity +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Enable-AzSynapseSqlAdvancedDataSecurity.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Enable-AzSynapseSqlAdvancedDataSecurity.md +--- + +# Enable-AzSynapseSqlAdvancedDataSecurity + +## SYNOPSIS +Enables Advanced Data Security on a workspace. + +## SYNTAX + +### EnableByNameParameterSet (Default) +``` +Enable-AzSynapseSqlAdvancedDataSecurity [-ResourceGroupName <String>] -WorkspaceName <String> + [-DoNotConfigureVulnerabilityAssessment] [-DeploymentName <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EnableByInputObjectParameterSet +``` +Enable-AzSynapseSqlAdvancedDataSecurity -InputObject <PSSynapseWorkspace> + [-DoNotConfigureVulnerabilityAssessment] [-DeploymentName <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EnableByResourceIdParameterSet +``` +Enable-AzSynapseSqlAdvancedDataSecurity -ResourceId <String> [-DoNotConfigureVulnerabilityAssessment] + [-DeploymentName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzSynapseSqlAdvancedDataSecurity** cmdlet enables Advanced Data Security on a workspace. Advanced Data Security is a unified security package that includes Data Classification, Vulnerability Assessment and Advanced Threat Protection for your workspace. (A new storage account will automatically be created for saving vulnerability assessments. If a storage account was previously created for this purpose, it will be used instead) + +## EXAMPLES + +### Example 1 +```powershell +Enable-AzSynapseSqlAdvancedDataSecurity -WorkspaceName ContosoWorkspace +``` + +This command enables workspace Advanced Data Security. + +### Example 2 +```powershell +Get-AzSynapseWorkspace -Name ContosoWorkspace | Enable-AzSynapseSqlAdvancedDataSecurity +``` + +This command enables workspace Advanced Data Security through pipeline. + +### Example 3 +```powershell +Enable-AzSynapseSqlAdvancedDataSecurity -WorkspaceName ContosoWorkspace -DoNotConfigureVulnerabilityAssessment +``` + +This command enables workspace Advanced Data Security through pipeline and does not auto enable Vulnerability Assessment. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentName +Supply a custom name for Advanced Data Security deployment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DoNotConfigureVulnerabilityAssessment +Do not auto enable Vulnerability Assessment (This will not create a storage account). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: EnableByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: EnableByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: EnableByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: EnableByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.WorkspaceAdvancedDataSecurityPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Enable-AzSynapseSqlPoolSensitivityRecommendation.md b/azps-10.1.0/Az.Synapse/Enable-AzSynapseSqlPoolSensitivityRecommendation.md new file mode 100644 index 0000000000..b3e1d2e95d --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Enable-AzSynapseSqlPoolSensitivityRecommendation.md @@ -0,0 +1,268 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/enable-azsynapsesqlpoolsensitivityrecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Enable-AzSynapseSqlPoolSensitivityRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Enable-AzSynapseSqlPoolSensitivityRecommendation.md +--- + +# Enable-AzSynapseSqlPoolSensitivityRecommendation + +## SYNOPSIS +Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the SQL pool. + +## SYNTAX + +### InputObjectParameterSet (Default) +``` +Enable-AzSynapseSqlPoolSensitivityRecommendation -InputObject <SqlPoolSensitivityClassificationModel> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Enable-AzSynapseSqlPoolSensitivityRecommendation [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-SqlPoolName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlPoolObjectColumnParameterSet +``` +Enable-AzSynapseSqlPoolSensitivityRecommendation -SqlPoolObject <PSSynapseSqlPool> -SchemaName <String> + -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Enable-AzSynapseSqlPoolSensitivityRecommendation cmdlet enables sensitivity recommendations on columns in the SQL pool. + +## EXAMPLES + +### Example 1: Enable sensitivity recommendations on a given column in an Azure Synapse SQL pool. +```powershell +Enable-AzSynapseSqlPoolSensitivityRecommendation -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool -SchemaName schema -TableName table -ColumnName column +``` + +### Example 2: Enable sensitivity recommendations on a given column Azure Synapse SQL pool using Piping. +```powershell +Get-AzSynapseSqlPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSqlPool | Enable-AzSynapseSqlPoolSensitivityRecommendation -SchemaName schema -TableName table -ColumnName column +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +An object representing a SQL Pool Sensitivity Classification. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.DataClassification.SqlPoolSensitivityClassificationModel +Parameter Sets: InputObjectParameterSet +Aliases: ClassificationObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolName +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.DataClassification.SqlPoolSensitivityClassificationModel + +### System.String + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Enable-AzSynapseWorkspace.md b/azps-10.1.0/Az.Synapse/Enable-AzSynapseWorkspace.md new file mode 100644 index 0000000000..ddcecbc42d --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Enable-AzSynapseWorkspace.md @@ -0,0 +1,253 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/enable-azsynapseworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Enable-AzSynapseWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Enable-AzSynapseWorkspace.md +--- + +# Enable-AzSynapseWorkspace + +## SYNOPSIS +When creating an Azure Synapse Analytics workspace, you can choose to encrypt all data at rest in the workspace `with a customer-managed key which will provide double encryption to the workspace.You may need to set up the encryption environment firstly, such as to create a key vault with purge protection enable and specify Access Polices to the key vault. Then use this cmdlet to activate the new Azure Synapse Analytics workspace which double encryption is enabled using a customer-managed key. + +## SYNTAX + +### EnableByNameParameterSet (Default) +``` +Enable-AzSynapseWorkspace [-ResourceGroupName <String>] -WorkspaceName <String> [-Name <String>] + [-EncryptionKeyIdentifier <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### EnableByParentObjectParameterSet +``` +Enable-AzSynapseWorkspace [-Name <String>] -WorkspaceObject <PSSynapseWorkspace> + [-EncryptionKeyIdentifier <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### EnableByInputObjectParameterSet +``` +Enable-AzSynapseWorkspace -InputObject <PSWorkspaceKey> [-EncryptionKeyIdentifier <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### EnableByResourceIdParameterSet +``` +Enable-AzSynapseWorkspace -ResourceId <String> [-EncryptionKeyIdentifier <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Enable-AzSynapseWorkspace cmdlet activates a new Azure Synapse Analytics workspace which double encryption is enabled using a customer-managed key. + +## EXAMPLES + +### Example 1 +```powershell +Enable-AzSynapseWorkspace -WorkspaceName ContosoWorkspace +``` + +This command activates a new Azure Synapse Analytics workspace named ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Enable-AzSynapseWorkspace +``` + +This command activates a new Azure Synapse Analytics workspace named ContosoWorkspace through pipeline. + +### Example 3 +```powershell +Enable-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/keys/default +``` + +This command activates a new Azure Synapse Analytics workspace through pipeline with the specified resource ID. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyIdentifier +Key identifier should be in the format of: https://{keyvaultname}.vault.azure.net/keys/{keyname}. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Workspace key input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.WorkspaceKey.PSWorkspaceKey +Parameter Sets: EnableByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The workspace encryption key name. + +```yaml +Type: System.String +Parameter Sets: EnableByNameParameterSet, EnableByParentObjectParameterSet +Aliases: KeyName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: EnableByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: EnableByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: EnableByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: EnableByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.WorkspaceKey.PSWorkspaceKey + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.WorkspaceKey.PSWorkspaceKey + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Export-AzSynapseKqlScript.md b/azps-10.1.0/Az.Synapse/Export-AzSynapseKqlScript.md new file mode 100644 index 0000000000..3413a5534d --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Export-AzSynapseKqlScript.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/export-azsynapsekqlscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Export-AzSynapseKqlScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Export-AzSynapseKqlScript.md +--- + +# Export-AzSynapseKqlScript + +## SYNOPSIS +Exports KQL script. + +## SYNTAX + +### ExportByName (Default) +``` +Export-AzSynapseKqlScript -WorkspaceName <String> [-Name <String>] -OutputFolder <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ExportByObject +``` +Export-AzSynapseKqlScript -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] -OutputFolder <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ExportByInputObject +``` +Export-AzSynapseKqlScript -InputObject <PSKqlScriptResource> -OutputFolder <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Export-AzSynapseKqlScript** cmdlet exports an Azure Synapse KQL script to a kusto query (.kql) file. +The name of the KQL script becomes the name of the exported file. If you specify the name of a KQL script, the cmdlet exports that KQL script. If you do not specify a name, the cmdlet export all KQL scripts in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Export-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -OutputFolder "C:\KqlScirpt" +``` + +Exports all KQL scripts in the workspace ContosoWorkspace to the folder "C:\KqlScirpt". + +### Example 2 +```powershell +Export-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -Name ContosoKqlScript -OutputFolder "C:\KqlScript" +``` + +Exports a single KQL script called ContosoKqlScript in the workspace ContosoWorkspace to the folder "C:\KqlScript". + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Export-AzSynapseKqlScript -Name ContosoKqlScript -OutputFolder "C:\KqlScript" +``` + +Exports a single KQL script called ContosoKqlScript in the workspace ContosoWorkspace to the folder "C:\KqlScript" through pipeline. + +### Example 4 +```powershell +$KqlScript = Get-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -Name ContosoKqlScript +$KqlScript | Export-AzSynapseKqlScript -OutputFolder "C:\KqlScript" +``` + +Exports a single KQL script called ContosoKqlScript in the workspace ContosoWorkspace to the folder "C:\KqlScript" through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KQL script object. + +```yaml +Type: PSKqlScriptResource +Parameter Sets: ExportByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +KQL script name. + +```yaml +Type: String +Parameter Sets: ExportByName, ExportByObject +Aliases: KqlScriptName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFolder +The folder where the KQL script should be placed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: String +Parameter Sets: ExportByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: PSSynapseWorkspace +Parameter Sets: ExportByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSKqlScriptResource + +## OUTPUTS + +### System.IO.FileInfo + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Export-AzSynapseNotebook.md b/azps-10.1.0/Az.Synapse/Export-AzSynapseNotebook.md new file mode 100644 index 0000000000..3fca08ba0c --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Export-AzSynapseNotebook.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/export-azsynapsenotebook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Export-AzSynapseNotebook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Export-AzSynapseNotebook.md +--- + +# Export-AzSynapseNotebook + +## SYNOPSIS +Exports notbooks. + +## SYNTAX + +### ExportByName (Default) +``` +Export-AzSynapseNotebook -WorkspaceName <String> [-Name <String>] -OutputFolder <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ExportByObject +``` +Export-AzSynapseNotebook -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] -OutputFolder <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ExportByInputObject +``` +Export-AzSynapseNotebook -InputObject <PSNotebookResource> -OutputFolder <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Export-AzSynapseNotebook** cmdlet exports an Azure Synapse notebook to a notebook (.ipynb) file. +The name of the notebook becomes the name of the exported file. If you specify the name of a notebook, the cmdlet exports that notebook. If you do not specify a name, the cmdlet export all notebooks in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Export-AzSynapseNotebook -WorkspaceName ContosoWorkspace -OutputFolder "C:\Notebook" +``` + +Exports all notebooks in the workspace ContosoWorkspace to the folder "C:\Notebook". + +### Example 2 +```powershell +Export-AzSynapseNotebook -WorkspaceName ContosoWorkspace -Name ContosoNotebook -OutputFolder "C:\Notebook" +``` + +Exports a single notebook called ContosoNotebook in the workspace ContosoWorkspace to the folder "C:\Notebook". + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Export-AzSynapseNotebook -Name ContosoNotebook -OutputFolder "C:\Notebook" +``` + +Exports a single notebook called ContosoNotebook in the workspace ContosoWorkspace to the folder "C:\Notebook" through pipeline. + +### Example 4 +```powershell +$notebook = Get-AzSynapseNotebook -WorkspaceName ContosoWorkspace -Name ContosoNotebook +$notebook | Export-AzSynapseNotebook -OutputFolder "C:\Notebook" +``` + +Exports a single notebook called ContosoNotebook in the workspace ContosoWorkspace to the folder "C:\Notebook" through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The notebook object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSNotebookResource +Parameter Sets: ExportByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The notebook name. + +```yaml +Type: System.String +Parameter Sets: ExportByName, ExportByObject +Aliases: NotebookName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFolder +The folder where the notebook should be placed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ExportByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: ExportByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSNotebookResource + +## OUTPUTS + +### System.IO.FileInfo + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Export-AzSynapseSparkConfiguration.md b/azps-10.1.0/Az.Synapse/Export-AzSynapseSparkConfiguration.md new file mode 100644 index 0000000000..c9c9be9fc9 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Export-AzSynapseSparkConfiguration.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/export-azsynapsesparkconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Export-AzSynapseSparkConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Export-AzSynapseSparkConfiguration.md +--- + +# Export-AzSynapseSparkConfiguration + +## SYNOPSIS +Exports a Synapse spark configuration to an output folder. + +## SYNTAX + +### ExportByName (Default) +``` +Export-AzSynapseSparkConfiguration -WorkspaceName <String> [-Name <String>] -OutputFolder <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ExportByObject +``` +Export-AzSynapseSparkConfiguration -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + -OutputFolder <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ExportByInputObject +``` +Export-AzSynapseSparkConfiguration -InputObject <PSSparkConfigurationResource> -OutputFolder <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Export-AzSynapseSparkConfiguration** cmdlet exports a Synapse spark configuration to a configuration(.json) file. +The name of the spark configuration becomes the name of the exported file. If you specify the name of a spark configuration, the cmdlet exports that spark configuration. If you do not specify a name, the cmdlet export all spark configurations in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Export-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -OutputFolder "C:\SparkConfiguration" +``` + +Exports all spark configurations in the workspace ContosoWorkspace to the folder "C:\SparkConfiguration". + +### Example 2 +```powershell +Export-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -Name ContoSparkConfiguration -OutputFolder "C:\SparkConfiguration" +``` + +Exports a single spark configuration named ContoSparkConfiguration in the workspace ContosoWorkspace to the folder "C:\SparkConfiguration". + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Export-AzSynapseSparkConfiguration -Name ContoSparkConfiguration -OutputFolder "C:\SparkConfiguration" +``` + +Exports a single spark configuration named ContoSparkConfiguration in the workspace ContosoWorkspace to the folder "C:\SparkConfiguration" through pipeline. + +### Example 4 +```powershell +$sparkConfiguration = Get-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -Name ContoSparkConfiguration +$sparkConfiguration | Export-AzSynapseSparkConfiguration -OutputFolder "C:\SparkConfiguration" +``` + +Exports a single spark configuration called ContoSparkConfiguration in the workspace ContosoWorkspace to the folder "C:\SparkConfiguration" through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Spark configuration object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSparkConfigurationResource +Parameter Sets: ExportByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Spark Configuration name. + +```yaml +Type: System.String +Parameter Sets: ExportByName, ExportByObject +Aliases: SparkConfigurationName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFolder +The folder where the spark configuration should be placed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ExportByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: ExportByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSparkConfigurationResource + +## OUTPUTS + +### System.IO.FileInfo + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Export-AzSynapseSqlScript.md b/azps-10.1.0/Az.Synapse/Export-AzSynapseSqlScript.md new file mode 100644 index 0000000000..091d31fdff --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Export-AzSynapseSqlScript.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/export-azsynapsesqlscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Export-AzSynapseSqlScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Export-AzSynapseSqlScript.md +--- + +# Export-AzSynapseSqlScript + +## SYNOPSIS +Exports a sql script from a Synapse workspace. + +## SYNTAX + +### ExportByName (Default) +``` +Export-AzSynapseSqlScript -WorkspaceName <String> -OutputFolder <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ExportByObject +``` +Export-AzSynapseSqlScript -WorkspaceObject <PSSynapseWorkspace> -OutputFolder <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ExportByInputObject +``` +Export-AzSynapseSqlScript -InputObject <PSSqlScriptResource> -OutputFolder <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Export-AzSynapseSqlScript** cmdlet exports an Azure Synapse sql script to a SQL Server query(.sql) file. If you specify the name of a sql script, the cmdlet exports the specified sql script. If you do not specify a name, the cmdlet export all sql scripts in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Export-AzSynapseSqlScript -WorkspaceName ContosoWorkspace -OutputFolder "C:\sqlscript" +``` + +Exports all sql scripts in the workspace ContosoWorkspace to the folder "C:\sqlscript". + +### Example 2 +```powershell +Export-AzSynapseSqlScript -WorkspaceName ContosoWorkspace -OutputFolder "C:\sqlscript" -Name "ContosoSqlScript" +``` + +Exports a single sql script named ContosoSqlScript in the workspace ContosoWorkspace to the folder "C:\sqlscript". + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Export-AzSynapseSqlScript -Name ContosoSqlScript -OutputFolder "C:\sqlscript" +``` + +Exports a single sql script called ContosoSqlScript in the workspace ContosoWorkspace to the folder "C:\sqlscript" through pipeline. + +### Example 4 +```powershell +$sqlscript = Get-AzSynapseSqlScript -WorkspaceName ContosoWorkspace -Name ContosoSqlScript +$sqlscript | Export-AzSynapseSqlScript -OutputFolder "C:\sqlscript" +``` + +Exports a single sql script called ContosoSqlScript in the workspace ContosoWorkspace to the folder "C:\sqlscript" through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The sql script object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSqlScriptResource +Parameter Sets: ExportByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The sql script name. + +```yaml +Type: System.String +Parameter Sets: ExportByName, ExportByObject +Aliases: SqlScriptName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFolder +The folder where the sql scripts should be placed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ExportByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: ExportByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSqlScriptResource + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzSynapseSqlScript](./Get-AzSynapseSqlScript.md) + +[Remove-AzSynapseSqlScript](./Remove-AzSynapseSqlScript.md) + +[Set-AzSynapseSqlScript](./Set-AzSynapseSqlScript.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseActiveDirectoryOnlyAuthentication.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseActiveDirectoryOnlyAuthentication.md new file mode 100644 index 0000000000..ba6cd5b6ff --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseActiveDirectoryOnlyAuthentication.md @@ -0,0 +1,164 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapseactivedirectoryonlyauthentication +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseActiveDirectoryOnlyAuthentication.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseActiveDirectoryOnlyAuthentication.md +--- + +# Get-AzSynapseActiveDirectoryOnlyAuthentication + +## SYNOPSIS +Gets Azure Active Directory (Azure AD) only authentication for a specific Synapse workspace. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseActiveDirectoryOnlyAuthentication [-ResourceGroupName <String>] -WorkspaceName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseActiveDirectoryOnlyAuthentication** cmdlet gets Azure Active Directory (Azure AD) only authentication for a specific Synapse workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceName ContosoWorkspace +``` +```output +WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate +------------- --------------------------------- ----- ------------ +ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM +``` +This command gets Azure AD only authentication status for Synapse workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseActiveDirectoryOnlyAuthentication +``` +```output +WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate +------------- --------------------------------- ----- ------------ +ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM +``` +This command gets Azure AD only authentication status for Synapse workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +Get-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace +``` +```output +WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate +------------- --------------------------------- ----- ------------ +ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM +``` +This command gets Azure AD only authentication for workspace ContosoWorkspace by ResourceId. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSAzureADOnlyAuthentication + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseActivityRun.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseActivityRun.md new file mode 100644 index 0000000000..fa2e9f0258 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseActivityRun.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapseactivityrun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseActivityRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseActivityRun.md +--- + +# Get-AzSynapseActivityRun + +## SYNOPSIS +Gets information about activity runs for a pipeline run. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseActivityRun -WorkspaceName <String> -PipelineName <String> -PipelineRunId <String> + -RunStartedAfter <DateTimeOffset> -RunStartedBefore <DateTimeOffset> [-ActivityName <String>] + [-Status <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseActivityRun -WorkspaceObject <PSSynapseWorkspace> -PipelineName <String> -PipelineRunId <String> + -RunStartedAfter <DateTimeOffset> -RunStartedBefore <DateTimeOffset> [-ActivityName <String>] + [-Status <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseActivityRun** cmdlet gets information about runs in workspace for the specified pipeline run that happened in the given timeframe. Additionally, you can specify filters for activity name and the status of the run. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseActivityRun -WorkspaceName ContosoWorkspace -PipelineName ContosoPipeline -PipelineRunId "f288712d-fb08-4cb8-96ef-82d3b9b30621" -RunStartedAfter [DateTimeOffset]"2018-09-01T21:00" -RunStartedBefore [DateTimeOffset]"2018-09-30T21:00" +``` + +This command gets details about all activity runs in the pipeline called ContosoPipeline run with ID "f288712d-fb08-4cb8-96ef-82d3b9b30621" that happened between "2018-09-01T21:00" and "2018-09-30T21:00". + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseActivityRun -PipelineName ContosoPipeline -PipelineRunId "f288712d-fb08-4cb8-96ef-82d3b9b30621" -RunStartedAfter [DateTimeOffset]"2018-09-01T21:00" -RunStartedBefore [DateTimeOffset]"2018-09-30T21:00" +``` + +This command gets details about all activity runs in the pipeline called ContosoPipeline run with ID "f288712d-fb08-4cb8-96ef-82d3b9b30621" that happened between "2018-09-01T21:00" and "2018-09-30T21:00" through pipeline. + +## PARAMETERS + +### -ActivityName +The name of the activity. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineName +The pipeline name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineRunId +The pipeline run identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunStartedAfter +The time at or after which the run event was updated in 'ISO 8601' format. + +```yaml +Type: System.DateTimeOffset +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunStartedBefore +The time at or before which the run event was updated in 'ISO 8601' format. + +```yaml +Type: System.DateTimeOffset +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The status of the pipeline run. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSActivityRunsQueryResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseDataFlow.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseDataFlow.md new file mode 100644 index 0000000000..5adc1cb121 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseDataFlow.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsedataflow +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseDataFlow.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseDataFlow.md +--- + +# Get-AzSynapseDataFlow + +## SYNOPSIS +Gets information about data flows in workspace. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseDataFlow -WorkspaceName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseDataFlow -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseDataFlow** cmdlet gets information about data flows in workspace. +If you specify the name of a data flow, this cmdlet gets information about that data flow. +If you do not specify a name, this cmdlet gets information about all the data flows in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseDataFlow -WorkspaceName ContosoWorkspace +``` + +This command gets information about all data flows in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseDataFlow -WorkspaceName ContosoWorkspace -Name ContosoDataFlow +``` + +This command gets information about the data flow named ContosoDataFlow in the workspace named ContosoWorkspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The data flow name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DataFlowName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSDataFlowResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseDataFlowDebugSession.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseDataFlowDebugSession.md new file mode 100644 index 0000000000..93891f0515 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseDataFlowDebugSession.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsedataflowdebugsession +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseDataFlowDebugSession.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseDataFlowDebugSession.md +--- + +# Get-AzSynapseDataFlowDebugSession + +## SYNOPSIS +Get all active data flow debug sessions in specified Synapse workspace. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseDataFlowDebugSession -WorkspaceName <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseDataFlowDebugSession -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +List all active data flow debug sessions in specified Synapse workspace with details. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseDataFlowDebugSession -WorkspaceName ContosoWorkspace +``` + +Get all active data flow debug sessions in Synapse workspace "ContosoWorkspace". + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseDataFlowDebugSession +``` + +Get all active data flow debug sessions in Synapse workspace "ContosoWorkspace" through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSDataFlowDebugSessionResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseDataset.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseDataset.md new file mode 100644 index 0000000000..346eb305d5 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseDataset.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsedataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseDataset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseDataset.md +--- + +# Get-AzSynapseDataset + +## SYNOPSIS +Gets information about datasets in workspace. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseDataset -WorkspaceName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseDataset -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseDataset** cmdlet gets information about datasets in workspace. +If you specify the name of a dataset, this cmdlet gets information about that dataset. +If you do not specify a name, this cmdlet gets information about all the datasets in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseDataset -WorkspaceName ContosoWorkspace +``` + +This command gets information about all datasets in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseDataset -WorkspaceName ContosoWorkspace -Name ContosoDataset +``` + +This command gets information about the dataset named ContosoDataset in the workspace named ContosoWorkspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The dataset name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DatasetName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSDatasetResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseDroppedSqlPool.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseDroppedSqlPool.md new file mode 100644 index 0000000000..a54fbb500f --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseDroppedSqlPool.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsedroppedsqlpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseDroppedSqlPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseDroppedSqlPool.md +--- + +# Get-AzSynapseDroppedSqlPool + +## SYNOPSIS +Gets a dropped Sql pool backup of a Synapse Sql Pool. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseDroppedSqlPool -ResourceGroupName <String> -WorkspaceName <String> [-Name <String>] + [-DeletionDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseDroppedSqlPool [-DeletionDate <DateTime>] [-ResourceId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseDroppedSqlPool** cmdlet gets a specified deleted SQL pool backup that you can restore, or all deleted backups that you can restore in a workspace. + +## EXAMPLES + +### Example 1: Get a specified dropped sqlpools from a sql pool +```powershell +Get-AzSynapseDroppedSqlPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name "ContosoSqlPool" +``` + +The cmdlet retrieves dropped sqlpools for a sql pool. + +### Example 2: Get all dropped sqlpool on a workspace +```powershell +Get-AzSynapseDroppedSqlPool -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" +``` + +This command gets all available dropped sqlpool on a specified workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletionDate +The deletion date of the Azure Synaspe SQL Database to retrieve backups for, with millisecond precision (e.g. 2016-02-23T00:21:22.847Z) + +```yaml +Type: System.Nullable`1[System.DateTime] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +The Synapse Sql pool. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a Dropped Sql Pool Resource Id. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseResourceGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSDroppedSqlPoolBackupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseFirewallRule.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseFirewallRule.md new file mode 100644 index 0000000000..41e22083cb --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseFirewallRule.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsefirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseFirewallRule.md +--- + +# Get-AzSynapseFirewallRule + +## SYNOPSIS +Gets a Synapse Analytics Firewall Rule. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseFirewallRule [-ResourceGroupName <String>] -WorkspaceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseFirewallRule -WorkSpaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseFirewallRule** cmdlet gets a Azure Synapse Analytics Firewall Rule. +If you do not specify a rule name, this cmdlet gets all rules. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseFirewallRule -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace +``` + +This command gets all firewall rules under a workspace. + +### Example 2 +```powershell +Get-AzSynapseFirewallRule -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoFirewallRule +``` + +This command gets the firewall rule under workspace ContosoWorkspace with name ContosoFirewallRule. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseFirewallRule +``` + +This command gets all firewall rules under a workspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The firerwall rule name for the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FirewallRuleName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkSpaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseIpFirewallRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseIntegrationRuntime.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseIntegrationRuntime.md new file mode 100644 index 0000000000..ea03eef864 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseIntegrationRuntime.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapseintegrationruntime +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseIntegrationRuntime.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseIntegrationRuntime.md +--- + +# Get-AzSynapseIntegrationRuntime + +## SYNOPSIS +Gets information about integration runtime resources. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseIntegrationRuntime [-ResourceGroupName <String>] -WorkspaceName <String> [-Name <String>] + [-Status] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseIntegrationRuntime [-Name <String>] -WorkspaceObject <PSSynapseWorkspace> [-Status] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseIntegrationRuntime -ResourceId <String> [-Status] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzSynapseIntegrationRuntime -InputObject <PSIntegrationRuntime> [-Status] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseIntegrationRuntime** cmdlet gets information about integration runtimes in a workspace. +If you specify the name of an integration runtime, this cmdlet gets information about that integration runtime. +If you do not specify a name, this cmdlet gets information about all of the integration runtimes in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace +``` + +List all integration runtimes in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -Name 'test-selfhost-ir' +``` + +This command displays information about the integration runtime named 'test-selfhost-ir' in the workspace named ContosoWorkspace. + +### Example 3 +```powershell +Get-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -Name 'test-selfhost-ir' -Status +``` + +This command displays detail status about the integration runtime named 'test-selfhost-ir' in the workspace named ContosoWorkspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: IntegrationRuntimeName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The integration runtime detail status. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseIntegrationRuntimeKey.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseIntegrationRuntimeKey.md new file mode 100644 index 0000000000..16cb5c9584 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseIntegrationRuntimeKey.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapseintegrationruntimekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseIntegrationRuntimeKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseIntegrationRuntimeKey.md +--- + +# Get-AzSynapseIntegrationRuntimeKey + +## SYNOPSIS +Gets keys for a self-hosted integration runtime. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseIntegrationRuntimeKey [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseIntegrationRuntimeKey -Name <String> -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseIntegrationRuntimeKey -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzSynapseIntegrationRuntimeKey -InputObject <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseIntegrationRuntimeKey** cmdlet gets keys for an integration runtime. The keys are used to register an integration runtime node. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseIntegrationRuntimeKey -WorkspaceName ContosoWorkspace -Name 'test-selfhost-ir' +``` + +The cmdlet retrieves keys for an integration runtime named 'test-selfhost-ir'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: IntegrationRuntimeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntimeKeys + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseIntegrationRuntimeMetric.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseIntegrationRuntimeMetric.md new file mode 100644 index 0000000000..8d3836fe8a --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseIntegrationRuntimeMetric.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapseintegrationruntimemetric +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseIntegrationRuntimeMetric.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseIntegrationRuntimeMetric.md +--- + +# Get-AzSynapseIntegrationRuntimeMetric + +## SYNOPSIS +Gets metric data for an integration runtime. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseIntegrationRuntimeMetric [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseIntegrationRuntimeMetric -Name <String> -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseIntegrationRuntimeMetric -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzSynapseIntegrationRuntimeMetric -InputObject <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseIntegrationRuntimeMetric** cmdlet gets metric data about integration runtime in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseIntegrationRuntimeMetric -WorkspaceName ContosoWorkspace -Name 'test-selfhost-ir' +``` + +This command displays metric data about the integration runtime named 'test-selfhost-ir' in the workspace named ContosoWorkspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: IntegrationRuntimeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntimeMetrics + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseIntegrationRuntimeNode.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseIntegrationRuntimeNode.md new file mode 100644 index 0000000000..be4a0bd332 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseIntegrationRuntimeNode.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapseintegrationruntimenode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseIntegrationRuntimeNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseIntegrationRuntimeNode.md +--- + +# Get-AzSynapseIntegrationRuntimeNode + +## SYNOPSIS +Gets an integration runtime node information. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseIntegrationRuntimeNode [-ResourceGroupName <String>] -WorkspaceName <String> + -IntegrationRuntimeName <String> -Name <String> [-IpAddress] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseIntegrationRuntimeNode -IntegrationRuntimeName <String> -WorkspaceObject <PSSynapseWorkspace> + -Name <String> [-IpAddress] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseIntegrationRuntimeNode -ResourceId <String> -Name <String> [-IpAddress] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzSynapseIntegrationRuntimeNode -InputObject <PSIntegrationRuntime> -Name <String> [-IpAddress] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseIntegrationRuntimeNode** cmdlet gets the detail information of an integration runtime node. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseIntegrationRuntimeNode -WorkspaceName ContosoWorkspace -IntegrationRuntimeName 'test-selfhost-ir' -Name 'Node_1' +``` + +The cmdlet gets information of node named 'Node_1' in self-hosted integration runtime 'test-selfhost-ir' in workspace ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseIntegrationRuntimeNode -WorkspaceName ContosoWorkspace -IntegrationRuntimeName 'test-selfhost-ir' -Name 'Node_1' -IpAddress +``` + +The cmdlet gets information of node named 'Node_1' in self-hosted integration runtime 'test-selfhost-ir' in workspace 'test-df-eu2', including the IP address. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntegrationRuntimeName +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddress +The IP Address of integration runtime node. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration runtime node name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSManagedIntegrationRuntimeNode + +### Microsoft.Azure.Commands.Synapse.Models.PSSelfHostedIntegrationRuntimeNode + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseKqlScript.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseKqlScript.md new file mode 100644 index 0000000000..7968f81b26 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseKqlScript.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsekqlscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKqlScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKqlScript.md +--- + +# Get-AzSynapseKqlScript + +## SYNOPSIS +Gets information about KQL scripts in a workspace. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseKqlScript -WorkspaceName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseKqlScript -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseKqlScript** cmdlet gets information about KQL scripts in a workspace. If you specify the name of a KQL script, the cmdlet gets information about that KQL script. If you do not specify a name, the cmdlet gets information about all KQL scripts in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseKqlScript -WorkspaceName ContosoWorkspace +``` + +Gets a list of all KQL scripts in the workspace ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -Name ContosoKqlScript +``` + +Gets a single KQL script called ContosoKqlScript in the workspace ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseKqlScript -Name ContosoKqlScript +``` + +Gets a single KQL script called ContosoKqlScript in the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +KQL script name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: KqlScriptName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSKqlScriptResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPool.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPool.md new file mode 100644 index 0000000000..1c0730eafa --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPool.md @@ -0,0 +1,193 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPool.md +--- + +# Get-AzSynapseKustoPool + +## SYNOPSIS +Gets a Kusto pool. + +## SYNTAX + +### List (Default) +``` +Get-AzSynapseKustoPool -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSynapseKustoPool -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSynapseKustoPool -InputObject <ISynapseIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Kusto pool. + +## EXAMPLES + +### Example 1: List all Kusto pools in a workspace +```powershell +Get-AzSynapseKustoPool -ResourceGroupName testrg -WorkspaceName testws +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +East US 2 testws/testnewkustopool Microsoft.Synapse/workspaces/kustoPools +East US 2 testws/testnewkustopool1 Microsoft.Synapse/workspaces/kustoPools +``` + +The above command lists all Kusto pools in the resource group "testrg". + +### Example 2: Get a specific Kusto pool by name +```powershell +Get-AzSynapseKustoPool -ResourceGroupName testrg -WorkspaceName testws -Name testnewkustopool +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +East US 2 testws/testnewkustopool Microsoft.Synapse/workspaces/kustoPools +``` + +The above command returns the Kusto pool named "testnewkustopool" in the resource group "testrg". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: KustoPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IKustoPool + +## 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 `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md new file mode 100644 index 0000000000..9bd94e92ee --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md @@ -0,0 +1,209 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopoolattacheddatabaseconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md +--- + +# Get-AzSynapseKustoPoolAttachedDatabaseConfiguration + +## SYNOPSIS +Returns an attached database configuration. + +## SYNTAX + +### List (Default) +``` +Get-AzSynapseKustoPoolAttachedDatabaseConfiguration -KustoPoolName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSynapseKustoPoolAttachedDatabaseConfiguration -AttachedDatabaseConfigurationName <String> + -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSynapseKustoPoolAttachedDatabaseConfiguration -InputObject <ISynapseIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Returns an attached database configuration. + +## EXAMPLES + +### Example 1: List all the AttachedDatabaseConfigurations in a kusto pool +```powershell +Get-AzSynapseKustoPoolAttachedDatabaseConfiguration -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testfollowerkustopool +``` + +```output +Name Type Location +---- ---- -------- +testws/testfollowerkustopool/followerconfiguration Microsoft.Synapse/workspaces/kustoPools/AttachedDatabaseConfigurations East US 2 +``` + +The above command lists all the AttachedDatabaseConfigurations in the kusto pool "testfollowerkustopool". + +### Example 2: Get a specific AttachedDatabaseConfiguration in a kusto pool +```powershell +Get-AzSynapseKustoPoolAttachedDatabaseConfiguration -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testfollowerkustopool -Name followerconfiguration +``` + +```output +Name Type Location +---- ---- -------- +testws/testfollowerkustopool/followerconfiguration Microsoft.Synapse/workspaces/kustoPools/AttachedDatabaseConfigurations East US 2 +``` + +The above command returns the AttachedDatabaseConfigurations named "followerconfiguration" in the cluster "testfollowerkustopool". + +## PARAMETERS + +### -AttachedDatabaseConfigurationName +The name of the attached database configuration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IAttachedDatabaseConfiguration + +## 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 `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolDataConnection.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolDataConnection.md new file mode 100644 index 0000000000..4d2101e43b --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolDataConnection.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopooldataconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDataConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDataConnection.md +--- + +# Get-AzSynapseKustoPoolDataConnection + +## SYNOPSIS +Returns a data connection. + +## SYNTAX + +### List (Default) +``` +Get-AzSynapseKustoPoolDataConnection -DatabaseName <String> -KustoPoolName <String> + -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzSynapseKustoPoolDataConnection -DatabaseName <String> -DataConnectionName <String> + -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSynapseKustoPoolDataConnection -InputObject <ISynapseIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns a data connection. + +## EXAMPLES + +### Example 1: List all data connections in a specific database +```powershell +Get-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase +``` + +```output +Kind Location Name +---- -------- ---- +EventHub East US 2 testws/testkustopool/mykustodatabase/eventhubdc +``` + +The above command returns all Kusto connections in the workspace "testws" found in the resource group "testrg". + +### Example 2: Get a specific data connection by name +```powershell +Get-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase -DataConnectionName mykustodataconnection +``` + +```output +Kind Location Name +---- -------- ---- +EventHub East US 2 testws/testkustopool/mykustodatabase/mykustodataconnection +``` + +The above command returns the data connection named "mykustodataconnection" in database "mykustodatabase" in workspace "testws" found in the resource group "testrg". + +## PARAMETERS + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataConnectionName +The name of the data connection. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDataConnection + +## 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 `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolDatabase.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolDatabase.md new file mode 100644 index 0000000000..786b6eb14c --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolDatabase.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopooldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDatabase.md +--- + +# Get-AzSynapseKustoPoolDatabase + +## SYNOPSIS +Returns a database. + +## SYNTAX + +### List (Default) +``` +Get-AzSynapseKustoPoolDatabase -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSynapseKustoPoolDatabase -DatabaseName <String> -KustoPoolName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSynapseKustoPoolDatabase -InputObject <ISynapseIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns a database. + +## EXAMPLES + +### Example 1: List all Kusto databases in a workspace by name +```powershell +Get-AzSynapseKustoPoolDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool +``` + +```output +Kind Location Name +---- -------- ---- +ReadWrite East US 2 testws/testnewkustopool/mykustodatabase +``` + +The above command returns all Kusto databases in Kusto Pool "testkustopool" in the workspace "testws" found in the resource group "testrg". + +### Example 2: Get a specific Kusto database by name +```powershell +Get-AzSynapseKustoPoolDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase +``` + +```output +Kind Location Name +---- -------- ---- +ReadWrite East US 2 testws/testnewkustopool/mykustodatabase +``` + +The above command returns the Kusto database named "mykustodatabase" in Kusto Pool "testkustopool" in the WorkspaceName "testws" found in the resource group "testrg". + +## PARAMETERS + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDatabase + +## 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 `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md new file mode 100644 index 0000000000..3213f0bae2 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopooldatabaseprincipalassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md +--- + +# Get-AzSynapseKustoPoolDatabasePrincipalAssignment + +## SYNOPSIS +Gets a Kusto pool database principalAssignment. + +## SYNTAX + +### List (Default) +``` +Get-AzSynapseKustoPoolDatabasePrincipalAssignment -DatabaseName <String> -KustoPoolName <String> + -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzSynapseKustoPoolDatabasePrincipalAssignment -DatabaseName <String> -KustoPoolName <String> + -PrincipalAssignmentName <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSynapseKustoPoolDatabasePrincipalAssignment -InputObject <ISynapseIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Kusto pool database principalAssignment. + +## EXAMPLES + +### Example 1: List all PrincipalAssignments in a kusto database by name +```powershell +Get-AzSynapseKustoPoolDatabasePrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase +``` + +```output +Name Type +---- ---- +testws/testkustopool/mykustodatabase/kustoprincipal1 Microsoft.Synapse/workspaces/kustoPools/Databases/PrincipalAssignments +testws/testkustopool/mykustodatabase/kustoprincipal2 Microsoft.Synapse/workspaces/kustoPools/Databases/PrincipalAssignments +``` + +The above command returns all PrincipalAssignments in the kusto database "mykustodatabase" in the WorkspaceName "testws" found in resource group "testrg". + +### Example 2: Get a specific PrincipalAssignment in a kusto database by name +```powershell +Get-AzSynapseKustoPoolDatabasePrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase -PrincipalAssignmentName kustoprincipal1 +``` + +```output +Name Type +---- ---- +testws/testkustopool/mykustodatabase/kustoprincipal1 Microsoft.Synapse/workspaces/kustoPools/Databases/PrincipalAssignments +``` + +The above command returns a PrincipalAssignment named "kustoprincipal1" in the kusto database "mykustodatabase" in the WorkspaceName "testws" found in resource group "testrg". + +## PARAMETERS + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDatabasePrincipalAssignment + +## 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 `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolFollowerDatabase.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolFollowerDatabase.md new file mode 100644 index 0000000000..38c2126d39 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolFollowerDatabase.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopoolfollowerdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolFollowerDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolFollowerDatabase.md +--- + +# Get-AzSynapseKustoPoolFollowerDatabase + +## SYNOPSIS +Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool. + +## SYNTAX + +``` +Get-AzSynapseKustoPoolFollowerDatabase -KustoPoolName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool. + +## EXAMPLES + +### Example 1: List all followed databases +```powershell +Get-AzSynapseKustoPoolFollowerDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool +``` + +```output +AttachedDatabaseConfigurationName DatabaseName KustoPoolResourceId +--------------------------------- ------------ ------------------- +conf1 testdatabase /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Synapse/workspaces/testws/kustoPools/followerpool +``` + +The above command returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IFollowerDatabaseDefinition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolLanguageExtension.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolLanguageExtension.md new file mode 100644 index 0000000000..d166f49e3e --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolLanguageExtension.md @@ -0,0 +1,164 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopoollanguageextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolLanguageExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolLanguageExtension.md +--- + +# Get-AzSynapseKustoPoolLanguageExtension + +## SYNOPSIS +Returns a list of language extensions that can run within KQL queries. + +## SYNTAX + +``` +Get-AzSynapseKustoPoolLanguageExtension -KustoPoolName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Returns a list of language extensions that can run within KQL queries. + +## EXAMPLES + +### Example 1: List all language extensions set for a workspace +```powershell +Get-AzSynapseKustoPoolLanguageExtension -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testpool +``` + +```output +Name +---- +PYTHON +``` + +The above command returns a list of language extensions that can run within KQL queries. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.ILanguageExtension + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolPrincipalAssignment.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolPrincipalAssignment.md new file mode 100644 index 0000000000..379f342a87 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolPrincipalAssignment.md @@ -0,0 +1,209 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopoolprincipalassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolPrincipalAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolPrincipalAssignment.md +--- + +# Get-AzSynapseKustoPoolPrincipalAssignment + +## SYNOPSIS +Gets a Kusto pool principalAssignment. + +## SYNTAX + +### List (Default) +``` +Get-AzSynapseKustoPoolPrincipalAssignment -KustoPoolName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzSynapseKustoPoolPrincipalAssignment -KustoPoolName <String> -PrincipalAssignmentName <String> + -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzSynapseKustoPoolPrincipalAssignment -InputObject <ISynapseIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Kusto pool principalAssignment. + +## EXAMPLES + +### Example 1: List all Kusto principalAssignments +```powershell +Get-AzSynapseKustoPoolPrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool +``` + +```output +Name Type +---- ---- +testws/testkustopool/kustoprincipal1 Microsoft.Synapse/workspaces/kustoPools/PrincipalAssignments +``` + +The above command lists all principalAssignments in the workspace "testws". + +### Example 2: Gets a Kusto principalAssignment by name +```powershell +Get-AzSynapseKustoPoolPrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -PrincipalAssignmentName kustoprincipal1 +``` + +```output +Name Type +---- ---- +testws/testkustopool/kustoprincipal1 Microsoft.Synapse/workspaces/kustoPools/PrincipalAssignments +``` + +The above command returns the Kusto principalAssignment named "kustoprincipal1" in the workspace "testws". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IClusterPrincipalAssignment + +## 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 `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolSku.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolSku.md new file mode 100644 index 0000000000..aa9ec8f992 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseKustoPoolSku.md @@ -0,0 +1,163 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopoolsku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolSku.md +--- + +# Get-AzSynapseKustoPoolSku + +## SYNOPSIS +Lists eligible SKUs for Kusto Pool resource. + +## SYNTAX + +### List (Default) +``` +Get-AzSynapseKustoPoolSku [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzSynapseKustoPoolSku -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Lists eligible SKUs for Kusto Pool resource. + +## EXAMPLES + +### Example 1: Lists eligible SKUs +```powershell +Get-AzSynapseKustoPoolSku +``` + +```output +Location Name ResourceType Size +-------- ---- ------------ ---- +{australiacentral} Compute optimized workspaces/kustoPools Extra small +{australiacentral2} Compute optimized workspaces/kustoPools Extra small +{australiaeast} Compute optimized workspaces/kustoPools Extra small +{australiasoutheast} Compute optimized workspaces/kustoPools Extra small +{brazilsouth} Compute optimized workspaces/kustoPools Extra small +... +``` + +The above command lists eligible SKUs. + +### Example 2: Lists eligible SKUs for specific kusto pool +```powershell +Get-AzSynapseKustoPoolSku -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testnewkustopool +``` + +```output +ResourceType +------------ +Microsoft.Synapse/workspaces/kustoPools +Microsoft.Synapse/workspaces/kustoPools +Microsoft.Synapse/workspaces/kustoPools +Microsoft.Synapse/workspaces/kustoPools +Microsoft.Synapse/workspaces/kustoPools +Microsoft.Synapse/workspaces/kustoPools +``` + +The above command lists eligible SKUs for specific kusto pool. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IAzureResourceSku + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.ISkuDescription + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkConnection.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkConnection.md new file mode 100644 index 0000000000..102992d746 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkConnection.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapselinkconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseLinkConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseLinkConnection.md +--- + +# Get-AzSynapseLinkConnection + +## SYNOPSIS +Gets information about link connections in workspace. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseLinkConnection -WorkspaceName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseLinkConnection -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseLinkConnection** cmdlet gets information about link connections in a workspace. If you specify the name of a link connection, the cmdlet gets information about that link connection. If you do not specify a name, the cmdlet gets information about all link connections in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace +``` + +Gets a list of all link connections in the workspace ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +``` + +Gets a single link connection named ContosoLinkConnection in the workspace ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseLinkConnection +``` + +This command gets all link connections under a workspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Synapse link connection name for Azure Sql Database. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: LinkConnectionName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkConnectionResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkConnectionDetailedStatus.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkConnectionDetailedStatus.md new file mode 100644 index 0000000000..5bf548ecaa --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkConnectionDetailedStatus.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapselinkconnectiondetailedstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionDetailedStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionDetailedStatus.md +--- + +# Get-AzSynapseLinkConnectionDetailedStatus + +## SYNOPSIS +Gets detail status about a link connection in workspace. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceObject <PSSynapseWorkspace> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseLinkConnectionDetailedStatus** cmdlet gets detail status about a link connection in workspace. After starting/stopping a link connection, you can use this cmdlet to get the status of the link connection. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +``` + +Gets detail status about link connection ContosoLinkConnection in the workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseLinkConnectionDetailedStatus -Name ContosoLinkConnection +``` + +This command gets detail status about link connection ContosoLinkConnection under a workspace through pipeline. + +### Example 3 +```powershell +Start-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +``` + +Starts a link connection named ContosoLinkConnection in workspace ContosoWorkspace, it will cost some time to start, then you can call **Get-AzSynapseLinkConnectionDetailedStatus** to monitor its status. + +### Example 4 +```powershell +Stop-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +``` + +Stops a link connection named ContosoLinkConnection in workspace ContosoWorkspace, it will cost some time from running to stop, then you can call **Get-AzSynapseLinkConnectionDetailedStatus** to monitor its status. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Synapse link connection name for Azure Sql Database. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: LinkConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkConnectionDetailedStatus + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkConnectionLinkTable.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkConnectionLinkTable.md new file mode 100644 index 0000000000..64829f6fc9 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkConnectionLinkTable.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapselinkconnectionlinktable +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTable.md +--- + +# Get-AzSynapseLinkConnectionLinkTable + +## SYNOPSIS +Gets information about link tables under a link connection. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseLinkConnectionLinkTable -WorkspaceName <String> -LinkConnectionName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseLinkConnectionLinkTable -WorkspaceObject <PSSynapseWorkspace> -LinkConnectionName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObject +``` +Get-AzSynapseLinkConnectionLinkTable -InputObject <PSLinkConnectionResource> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseLinkConnectionLinkTable** cmdlet gets information about link tables under a link connection. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseLinkConnectionLinkTable -WorkspaceName ContosoWorkspace -LinkConnectionName ContosoLinkConnection +``` + +This command gets information about link tables under link connection ContosoLinkConnection in workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseLinkConnectionLinkTable -LinkConnectionName ContosoLinkConnection +``` + +This command gets information about link tables under link connection ContosoLinkConnection in workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$lc = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +$lc | Get-AzSynapseLinkConnectionLinkTable +``` + +This command gets information about link tables under a link connection through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The information about the link connection. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSLinkConnectionResource +Parameter Sets: GetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkConnectionName +Name of link connection. + +```yaml +Type: System.String +Parameter Sets: GetByName, GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkConnectionResource + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkTableResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkConnectionLinkTableStatus.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkConnectionLinkTableStatus.md new file mode 100644 index 0000000000..2a6b1107a7 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkConnectionLinkTableStatus.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapselinkconnectionlinktablestatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTableStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTableStatus.md +--- + +# Get-AzSynapseLinkConnectionLinkTableStatus + +## SYNOPSIS +Gets status of link tables under a link connection. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseLinkConnectionLinkTableStatus -WorkspaceName <String> -LinkConnectionName <String> + -MaxSegmentCount <Int32> [-ContinuationToken <Object>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseLinkConnectionLinkTableStatus -WorkspaceObject <PSSynapseWorkspace> -LinkConnectionName <String> + -MaxSegmentCount <Int32> [-ContinuationToken <Object>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByInputObject +``` +Get-AzSynapseLinkConnectionLinkTableStatus -MaxSegmentCount <Int32> -InputObject <PSLinkConnectionResource> + [-ContinuationToken <Object>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseLinkConnectionLinkTablesStatus** cmdlet gets status of link tables under a link connection. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseLinkConnectionLinkTableStatus -WorkspaceName ContosoWorkspace -LinkConnectionName ContosoLinkConnection -MaxSegmentCount 50 +``` + +This command gets status of link tables with max segment count 50 under link connection ContosoLinkConnection in workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseLinkConnectionLinkTableStatus -LinkConnectionName ContosoLinkConnection -MaxSegmentCount 50 +``` + +This command gets status of link tables with max segment count 50 under link connection ContosoLinkConnection in workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$lc = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +$lc | Get-AzSynapseLinkConnectionLinkTableStatus -MaxSegmentCount 50 +``` + +This command gets status of link tables with max segment count 50 under a link connection through pipeline. + +## PARAMETERS + +### -ContinuationToken +Continuation token to query table status. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The information about the link connection. + +```yaml +Type: PSLinkConnectionResource +Parameter Sets: GetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkConnectionName +Name of link connection. + +```yaml +Type: String +Parameter Sets: GetByName, GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxSegmentCount +Max segment count to query table status. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkConnectionResource + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkConnectionQueryTableStatus + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkedService.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkedService.md new file mode 100644 index 0000000000..2d76c2519c --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseLinkedService.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapselinkedservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseLinkedService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseLinkedService.md +--- + +# Get-AzSynapseLinkedService + +## SYNOPSIS +Gets information about linked services in workspace. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseLinkedService -WorkspaceName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseLinkedService -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseLinkedService** cmdlet gets information about linked services in workspace. +If you specify the name of a linked service, this cmdlet gets information about that linked service. +If you do not specify a name, this cmdlet gets information about all the linked services in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseLinkedService -WorkspaceName ContosoWorkspace +``` + +This command gets information about all linked services in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseLinkedService -WorkspaceName ContosoWorkspace -Name ContosoLinkedService +``` + +This command gets information about the linked service named ContosoLinkedService in the workspace named ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseLinkedService -Name ContosoLinkedService +``` + +This command gets information about the linked service named ContosoLinkedService in the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The linked service name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LinkedServiceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkedServiceResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseManagedIdentitySqlControlSetting.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseManagedIdentitySqlControlSetting.md new file mode 100644 index 0000000000..580b903902 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseManagedIdentitySqlControlSetting.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsemanagedidentitysqlcontrolsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseManagedIdentitySqlControlSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseManagedIdentitySqlControlSetting.md +--- + +# Get-AzSynapseManagedIdentitySqlControlSetting + +## SYNOPSIS +Gets Managed Identity Sql Control Settings. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Get-AzSynapseManagedIdentitySqlControlSetting [-ResourceGroupName <String>] -WorkspaceName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Get-AzSynapseManagedIdentitySqlControlSetting -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Get-AzSynapseManagedIdentitySqlControlSetting -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseManagedIdentitySqlControlSetting** cmdlet gets gets the managed identity SQL control settings of an Azure Synapse Analytics workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseManagedIdentitySqlControlSetting -WorkspaceName ContosoWorkspace +``` + +This command gets the managed identity SQL control setting for a workspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseManagedIdentitySqlControlSetting +``` + +This command gets the managed identity SQL control setting for a workspace through pipeline. + +### Example 3 +```powershell +Get-AzSynapseManagedIdentitySqlControlSetting -ResourceId '/subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd3/resourcegroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace' +``` + +This command gets the managed identity SQL control setting for a workspace through workspace resource ID. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSManagedIdentitySqlControlSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseManagedPrivateEndpoint.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseManagedPrivateEndpoint.md new file mode 100644 index 0000000000..15d8fa29f9 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseManagedPrivateEndpoint.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsemanagedprivateendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseManagedPrivateEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseManagedPrivateEndpoint.md +--- + +# Get-AzSynapseManagedPrivateEndpoint + +## SYNOPSIS +Gets information about mananged private endpoints in a workspace + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseManagedPrivateEndpoint -WorkspaceName <String> [-Name <String>] [-VirtualNetworkName <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseManagedPrivateEndpoint -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-VirtualNetworkName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseManagedPrivateEndpoint** cmdlet gets information about mananged private endpoints in a workspace. If you specify the name of a mananged private endpoint, the cmdlet gets information about that mananged private endpoint. If you do not specify a name, the cmdlet gets information about all mananged private endpoints in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseManagedPrivateEndpoint -WorkspaceName ContosoWorkspace -Name ContosoManagedPrivateEndpoint +``` + +Gets a single mananged private endpoint called ContosoManagedPrivateEndpoint in the workspace ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseManagedPrivateEndpoint -WorkspaceName ContosoWorkspace +``` + +Gets a list of all mananged private endpoints in the workspace ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseManagedPrivateEndpoint -Name ContosoManagedPrivateEndpoint +``` + +Gets a single mananged private endpoint called ContosoManagedPrivateEndpoint in the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Synapse Managed Private Endpoint Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ManagedPrivateEndpointName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkName +Managed Virtual Network Name is default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VNetName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSManagedPrivateEndpointResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseNotebook.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseNotebook.md new file mode 100644 index 0000000000..bc48bef8ae --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseNotebook.md @@ -0,0 +1,138 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsenotebook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseNotebook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseNotebook.md +--- + +# Get-AzSynapseNotebook + +## SYNOPSIS +Gets information about notebooks in a workspace. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseNotebook -WorkspaceName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseNotebook -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseNotebook** cmdlet gets information about notebooks in a workspace. If you specify the name of a notebook, the cmdlet gets information about that notebook. If you do not specify a name, the cmdlet gets information about all notebooks in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseNotebook -WorkspaceName ContosoWorkspace | Format-Table +``` + +```output +WorkspaceName Properties Name +------------- ---------- -- +ContosoWorkspace Microsoft.Azure.Commands.Synapse.Models.PSNotebook ContosoNotebook1 +ContosoWorkspace Microsoft.Azure.Commands.Synapse.Models.PSNotebook ContosoNotebook2 +``` + +Gets a list of all notebooks in the workspace ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseNotebook -WorkspaceName ContosoWorkspace -Name ContosoNotebook +``` + +Gets a single notebook called ContosoNotebook in the workspace ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseNotebook -Name ContosoNotebook +``` + +Gets a single notebook called ContosoNotebook in the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The notebook name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: NotebookName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSNotebookResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapsePipeline.md b/azps-10.1.0/Az.Synapse/Get-AzSynapsePipeline.md new file mode 100644 index 0000000000..0d0c2cedef --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapsePipeline.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsepipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapsePipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapsePipeline.md +--- + +# Get-AzSynapsePipeline + +## SYNOPSIS +Gets information about pipelines in workspace. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapsePipeline -WorkspaceName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapsePipeline -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapsePipeline** cmdlet gets information about pipelines in workspace. If you specify the name of a pipeline, this cmdlet gets information about that pipeline. If you do not specify a name, this cmdlet gets information about all the pipelines in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapsePipeline -WorkspaceName ContosoWorkspace +``` + +This command gets information about all pipelines in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapsePipeline -WorkspaceName ContosoWorkspace -Name ContosoPipeline +``` + +This command gets information about the pipeline named ContosoPipeline in the workspace named ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapsePipeline -Name ContosoPipeline +``` + +This command gets information about the pipeline named ContosoPipeline in the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The pipeline name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PipelineName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSPipelineResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapsePipelineRun.md b/azps-10.1.0/Az.Synapse/Get-AzSynapsePipelineRun.md new file mode 100644 index 0000000000..a015eee87f --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapsePipelineRun.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsepipelinerun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapsePipelineRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapsePipelineRun.md +--- + +# Get-AzSynapsePipelineRun + +## SYNOPSIS +Gets information about pipeline runs. + +## SYNTAX + +### GetByNameAndId (Default) +``` +Get-AzSynapsePipelineRun -WorkspaceName <String> -PipelineRunId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByNameAndTime +``` +Get-AzSynapsePipelineRun -WorkspaceName <String> -RunStartedAfter <DateTimeOffset> + -RunStartedBefore <DateTimeOffset> [-PipelineName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByObjectAndId +``` +Get-AzSynapsePipelineRun -WorkspaceObject <PSSynapseWorkspace> -PipelineRunId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByObjectAndTime +``` +Get-AzSynapsePipelineRun -WorkspaceObject <PSSynapseWorkspace> -RunStartedAfter <DateTimeOffset> + -RunStartedBefore <DateTimeOffset> [-PipelineName <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapsePipelineRun** command returns information about runs for the specified pipeline. If PipelineRunId is specified, it shows details for the run with that ID. If the PipelineRunId is not specified, then it shows information about all runs for the pipelines that happened between the values of RunStartedAfter and RunStartedBefore. + +## EXAMPLES + +### Example 1: Get pipeline run by ID +```powershell +Get-AzSynapsePipelineRun -WorkspaceName ContosoWorkspace -PipelineRunId "61eb095a-fe23-4591-8a97-fade6c65ca72" +``` + +This command gets details about the pipeline run with ID "61eb095a-fe23-4591-8a97-fade6c65ca72". + +### Example 2: Get pipelines runs between the dates +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapsePipelineRun -RunStartedAfter "4/2/2007 7:23:57 PM" -RunStartedBefore "4/2/2027 7:23:57 PM" +``` + +This command gets details about the runs of all pipelines in the workspace ContosoWorkspace that started between "4/2/2007 7:23:57 PM" and "4/2/2027 7:23:57 PM" + +### Example 3: Get a single pipeline runs between the dates +```powershell +Get-AzSynapsePipelineRun -WorkspaceName ContosoWorkspace -PipelineName ContosoPipeline -RunStartedAfter "4/2/2007 7:23:57 PM" -RunStartedBefore "4/2/2027 7:23:57 PM" +``` + +This command gets details about the runs of ContosoPipeline pipeline in the workspace ContosoWorkspace that started between "4/2/2007 7:23:57 PM" and "4/2/2027 7:23:57 PM" + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineName +The pipeline name. + +```yaml +Type: System.String +Parameter Sets: GetByNameAndTime, GetByObjectAndTime +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineRunId +The pipeline run identifier. + +```yaml +Type: System.String +Parameter Sets: GetByNameAndId, GetByObjectAndId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunStartedAfter +The time at or after which the run event was updated in 'ISO 8601' format. + +```yaml +Type: System.DateTimeOffset +Parameter Sets: GetByNameAndTime, GetByObjectAndTime +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunStartedBefore +The time at or before which the run event was updated in 'ISO 8601' format. + +```yaml +Type: System.DateTimeOffset +Parameter Sets: GetByNameAndTime, GetByObjectAndTime +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameAndId, GetByNameAndTime +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObjectAndId, GetByObjectAndTime +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSPipelineRun + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseRoleAssignment.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseRoleAssignment.md new file mode 100644 index 0000000000..b77c1e385d --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseRoleAssignment.md @@ -0,0 +1,347 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapseroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseRoleAssignment.md +--- + +# Get-AzSynapseRoleAssignment + +## SYNOPSIS +Gets a Synapse Analytics role assignment. + +## SYNTAX + +### GetByWorkspaceNameAndNameParameterSet (Default) +``` +Get-AzSynapseRoleAssignment -WorkspaceName <String> [-RoleDefinitionName <String>] [-SignInName <String>] + [-ItemType <WorkspaceItemType>] [-Item <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByWorkspaceNameAndIdParameterSet +``` +Get-AzSynapseRoleAssignment -WorkspaceName <String> [-RoleDefinitionName <String>] [-ObjectId <String>] + [-ItemType <WorkspaceItemType>] [-Item <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet +``` +Get-AzSynapseRoleAssignment -WorkspaceName <String> -RoleDefinitionId <String> [-ObjectId <String>] + [-ItemType <WorkspaceItemType>] [-Item <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByWorkspaceNameAndAssignmentIdParameterSet +``` +Get-AzSynapseRoleAssignment -WorkspaceName <String> -RoleAssignmentId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByWorkspaceNameAndServicePrincipalNameParameterSet +``` +Get-AzSynapseRoleAssignment -WorkspaceName <String> [-RoleDefinitionName <String>] + [-ServicePrincipalName <String>] [-ItemType <WorkspaceItemType>] [-Item <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByWorkspaceObjectAndNameParameterSet +``` +Get-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> [-RoleDefinitionName <String>] + -SignInName <String> [-ItemType <WorkspaceItemType>] [-Item <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByWorkspaceObjectAndIdParameterSet +``` +Get-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> [-RoleDefinitionName <String>] + [-ObjectId <String>] [-ItemType <WorkspaceItemType>] [-Item <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet +``` +Get-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> -RoleDefinitionId <String> + [-ObjectId <String>] [-ItemType <WorkspaceItemType>] [-Item <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByWorkspaceObjectAndAssignmentIdParameterSet +``` +Get-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> -RoleAssignmentId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByWorkspaceObjectAndServicePrincipalNameParameterSet +``` +Get-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> [-RoleDefinitionName <String>] + -ServicePrincipalName <String> [-ItemType <WorkspaceItemType>] [-Item <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseRoleAssignment** cmdlet gets a Azure Synapse Analytics Role Assignment. +If you do not specify a role definition or a user principal name, this cmdlet gets all role assignment. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +* GET /users/{id} +* GET /servicePrincipals/{id} + +>[!Note] +> To retrieve a role assignment for a service principal, pass the object ID of the principal in the ObjectId parameter. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace +``` + +This command gets all role assignments under a workspace. + +### Example 2 +```powershell +Get-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole +``` + +This command gets all role assignments under workspace ContosoWorkspace with role name ContosoRole. + +### Example 3 +```powershell +Get-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName +``` + +This command gets a role assignment under workspace ContosoWorkspace with role name ContosoRole and user principal name ContosoName. + +### Example 4 +```powershell +Get-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType +``` + +This command gets role assignments under workspace ContosoWorkspace with role name ContosoRole, user principal name ContosoName and under itemtype ContosoItemtype. + +### Example 5 +```powershell +Get-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType -Item ContosoItem +``` + +This command gets a role assignment under workspace ContosoWorkspace with role name ContosoRole, user principal name ContosoName, ContosoItemType and ContosoItem. + +### Example 6 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseRoleAssignment +``` + +This command gets all role assignments under a workspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Item +The item of Azure Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceNameAndNameParameterSet, GetByWorkspaceNameAndIdParameterSet, GetByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet, GetByWorkspaceNameAndServicePrincipalNameParameterSet, GetByWorkspaceObjectAndNameParameterSet, GetByWorkspaceObjectAndIdParameterSet, GetByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet, GetByWorkspaceObjectAndServicePrincipalNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemType +The itemtype of Azure Synapse workspace. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+WorkspaceItemType +Parameter Sets: GetByWorkspaceNameAndNameParameterSet, GetByWorkspaceNameAndIdParameterSet, GetByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet, GetByWorkspaceNameAndServicePrincipalNameParameterSet, GetByWorkspaceObjectAndNameParameterSet, GetByWorkspaceObjectAndIdParameterSet, GetByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet, GetByWorkspaceObjectAndServicePrincipalNameParameterSet +Aliases: +Accepted values: ApacheSparkPool, IntegrationRuntime, LinkedService, Credential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The Azure AD ObjectId of the User, Group or Service Principal. + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceNameAndIdParameterSet, GetByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet, GetByWorkspaceObjectAndIdParameterSet, GetByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet +Aliases: Id, PrincipalId + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleAssignmentId +The ID of the role assignment. + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceNameAndAssignmentIdParameterSet, GetByWorkspaceObjectAndAssignmentIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +Id of the Role that is assigned to the principal. + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet, GetByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionName +Name of the Role that is assigned to the principal. + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceNameAndNameParameterSet, GetByWorkspaceNameAndIdParameterSet, GetByWorkspaceNameAndServicePrincipalNameParameterSet, GetByWorkspaceObjectAndNameParameterSet, GetByWorkspaceObjectAndIdParameterSet, GetByWorkspaceObjectAndServicePrincipalNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalName +The ServicePrincipalName of the service principal. + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceNameAndServicePrincipalNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceObjectAndServicePrincipalNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignInName +The email address or the user principal name of the user. + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceNameAndNameParameterSet +Aliases: Email, UserPrincipalName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceObjectAndNameParameterSet +Aliases: Email, UserPrincipalName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceNameAndNameParameterSet, GetByWorkspaceNameAndIdParameterSet, GetByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet, GetByWorkspaceNameAndAssignmentIdParameterSet, GetByWorkspaceNameAndServicePrincipalNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByWorkspaceObjectAndNameParameterSet, GetByWorkspaceObjectAndIdParameterSet, GetByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet, GetByWorkspaceObjectAndAssignmentIdParameterSet, GetByWorkspaceObjectAndServicePrincipalNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSRoleAssignmentDetails + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseRoleDefinition.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseRoleDefinition.md new file mode 100644 index 0000000000..6095851673 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseRoleDefinition.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapseroledefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseRoleDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseRoleDefinition.md +--- + +# Get-AzSynapseRoleDefinition + +## SYNOPSIS +Gets a Synapse Analytics role definition. + +## SYNTAX + +### GetByWorkspaceNameAndIdParameterSet (Default) +``` +Get-AzSynapseRoleDefinition -WorkspaceName <String> [-Id <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByWorkspaceNameAndNameParameterSet +``` +Get-AzSynapseRoleDefinition -WorkspaceName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByWorkspaceObjectAndIdParameterSet +``` +Get-AzSynapseRoleDefinition -WorkspaceObject <PSSynapseWorkspace> -Id <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByWorkspaceObjectAndNameParameterSet +``` +Get-AzSynapseRoleDefinition -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseRoleDefinition** cmdlet gets an Azure Synapse Analytics Role Definition. +If you do not specify a role name or a role Id, this cmdlet gets all role definitions. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseRoleDefinition -WorkspaceName ContosoWorkspace +``` + +This command gets all role definitions under a workspace. + +### Example 2 +```powershell +Get-AzSynapseRoleDefinition -WorkspaceName ContosoWorkspace -Name ContosoRole +``` + +This command gets the role definition under workspace ContosoWorkspace with name ContosoRole. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseRoleDefinition +``` + +This command gets all role definitions under a workspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Id of the Role that is assigned to the principal. + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceNameAndIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceObjectAndIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Role that is assigned to the principal. + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceNameAndNameParameterSet, GetByWorkspaceObjectAndNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceNameAndIdParameterSet, GetByWorkspaceNameAndNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByWorkspaceObjectAndIdParameterSet, GetByWorkspaceObjectAndNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseRole + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseRoleScope.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseRoleScope.md new file mode 100644 index 0000000000..18cd6279c0 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseRoleScope.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapserolescope +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseRoleScope.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseRoleScope.md +--- + +# Get-AzSynapseRoleScope + +## SYNOPSIS +Gets a Synapse Analytics role scope. + +## SYNTAX + +### GetByWorkspaceNameParameterSet (Default) +``` +Get-AzSynapseRoleScope -WorkspaceName <String> [-ResourceId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByWorkspaceObjectParameterSet +``` +Get-AzSynapseRoleScope -WorkspaceObject <PSSynapseWorkspace> [-ResourceId <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseRoleScope** cmdlet gets a Azure Synapse Analytics Role Scope. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseRoleScope -WorkspaceName ContosoWorkspace +``` + +This command gets all role scopes under a workspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseRoleScope +``` + +This command gets all role scopes under a workspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByWorkspaceNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByWorkspaceObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseRole + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkConfiguration.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkConfiguration.md new file mode 100644 index 0000000000..b1920f4d0f --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkConfiguration.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesparkconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSparkConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSparkConfiguration.md +--- + +# Get-AzSynapseSparkConfiguration + +## SYNOPSIS +Gets information about spark configurations in a workspace. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseSparkConfiguration -WorkspaceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseSparkConfiguration -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSparkConfiguration** cmdlet gets information about spark configurations in a workspace. If you specify the name of a spark configuration, the cmdlet gets information about that spark configuration. If you do not specify a name, the cmdlet gets information about all spark configurations in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace +``` + +Gets a list of all spark configurations in the workspace ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -Name ContosoSparkConfiguration +``` + +Gets a single spark configuration called ContosoSparkConfiguration in the workspace ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseSparkConfiguration -Name ContosoSparkConfiguration +``` + +Gets a single spark configuration called ContosoSparkConfiguration in the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Spark Configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SparkConfigurationName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSparkConfigurationResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkJob.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkJob.md new file mode 100644 index 0000000000..2618c9dbbd --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkJob.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesparkjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSparkJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSparkJob.md +--- + +# Get-AzSynapseSparkJob + +## SYNOPSIS +Gets a Synapse Analytics Spark job. + +## SYNTAX + +### GetSparkJobsByIdParameterSet (Default) +``` +Get-AzSynapseSparkJob -WorkspaceName <String> -SparkPoolName <String> [-LivyId <Int32>] [-Name <String>] + [-ApplicationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetSparkJobsByIdFromParentObjectParameterSet +``` +Get-AzSynapseSparkJob -SparkPoolObject <PSSynapseSparkPool> [-LivyId <Int32>] [-Name <String>] + [-ApplicationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSparkJob** cmdlet gets an Azure Synapse Analytics Spark job. +If you do not specify a job, this cmdlet gets all jobs. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool +``` + +This command gets all jobs under a Spark pool. + +### Example 2 +```powershell +Get-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 119 +``` + +This command gets the job with the specified ID. + +### Example 3 +```powershell +Get-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -ApplicationId application_1585023543211_0004 +``` + +This command gets the job with the specified application ID. + +### Example 4 +```powershell +$pool = Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool +$pool | Get-AzSynapseSparkJob +``` + +This command gets all jobs under a Spark pool through pipeline. + +## PARAMETERS + +### -ApplicationId +The Application identifier of the session. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivyId +Identifier of Spark job. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Id + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Spark job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolName +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: GetSparkJobsByIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolObject +Spark pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool +Parameter Sets: GetSparkJobsByIdFromParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetSparkJobsByIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkJobDefinition.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkJobDefinition.md new file mode 100644 index 0000000000..e9c94ddc2c --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkJobDefinition.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesparkjobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSparkJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSparkJobDefinition.md +--- + +# Get-AzSynapseSparkJobDefinition + +## SYNOPSIS +Gets a Spark job definition in workspace. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseSparkJobDefinition -WorkspaceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseSparkJobDefinition -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSparkJobDefinition** cmdlet gets information about Spark job definitions in workspace. If you specify the name of a Spark job definition, this cmdlet gets information about that Spark job definition. If you do not specify a name, this cmdlet gets information about all the Spark job definitions in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSparkJobDefinition -WorkspaceName ContosoWorkspace +``` + +This command gets information about all Spark job definitions in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseSparkJobDefinition -WorkspaceName ContosoWorkspace -Name ContosoJobDefinition +``` + +This command gets information about the Spark job definition named ContosoSparkJobDefinition in the workspace named ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseSparkJobDefinition -Name ContosoSparkJobDefinition +``` + +This command gets information about the Spark job definition named ContosoSparkJobDefinition in the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Spark job definition name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SparkJobDefinitionName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSparkJobDefinitionResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkPool.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkPool.md new file mode 100644 index 0000000000..83519f6d95 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkPool.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesparkpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSparkPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSparkPool.md +--- + +# Get-AzSynapseSparkPool + +## SYNOPSIS +Gets a Apache Spark pool in Azure Synapse Analytics. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseSparkPool [-ResourceGroupName <String>] -WorkspaceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseSparkPool [-Name <String>] -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseSparkPool -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSparkPool** cmdlet gets information about an Apache Spark pool in Azure Synapse Analytics. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace +``` + +This command gets all Spark pools under a workspace. + +### Example 2 +```powershell +Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool +``` + +This command gets the Spark pool under workspace ContosoWorkspace with name ContosoSparkPool. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseSparkPool +``` + +This command gets all Spark pools under a workspace through pipeline. + +### Example 4 +```powershell +Get-AzSynapseSparkPool -ResourceId "/subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/bigDataPools/ContosoSparkPool" +``` + +This command gets the Spark pool with the specified resource ID. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: SparkPoolName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkSession.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkSession.md new file mode 100644 index 0000000000..bb9e5fcdd5 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkSession.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesparksession +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSparkSession.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSparkSession.md +--- + +# Get-AzSynapseSparkSession + +## SYNOPSIS +Gets a Synapse Analytics Spark session. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseSparkSession -WorkspaceName <String> -SparkPoolName <String> [-LivyId <Int32>] [-Name <String>] + [-ApplicationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseSparkSession -SparkPoolObject <PSSynapseSparkPool> [-LivyId <Int32>] [-Name <String>] + [-ApplicationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSparkSession** cmdlet gets information about an Azure Synapse Analytics Spark session. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool +``` + +This command gets all the Spark sessions under the specified Spark pool. + +### Example 2 +```powershell +Get-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 1 +``` + +This command gets the Spark session with the specified livy ID. + +### Example 3 +```powershell +$pool = Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool +$pool | Get-AzSynapseSparkSession +``` + +This command gets all the Spark sessions under the specified Spark pool through pipeline. + +## PARAMETERS + +### -ApplicationId +The Application identifier of the session. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivyId +Identifier of Spark session. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Id + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolName +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolObject +Spark pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkSession + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkStatement.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkStatement.md new file mode 100644 index 0000000000..00d08e5797 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSparkStatement.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesparkstatement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSparkStatement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSparkStatement.md +--- + +# Get-AzSynapseSparkStatement + +## SYNOPSIS +Gets a Synapse Analytics Spark statement. + +## SYNTAX + +### GetSparkStatementsByIdParameterSet (Default) +``` +Get-AzSynapseSparkStatement -WorkspaceName <String> -SparkPoolName <String> [-LivyId <Int32>] + -SessionId <Int32> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetSparkStatementsByParentObjectParameterSet +``` +Get-AzSynapseSparkStatement -SessionObject <PSSynapseSparkSession> [-LivyId <Int32>] [-SessionId <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSparkStatement** cmdlet gets information about an Azure Synapse Analytics Spark statement. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSparkStatement -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -SessionId 120 +``` + +This command gets all the Spark statements under a Spark session. + +### Example 2 +```powershell +Get-AzSynapseSparkStatement -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -SessionId 120 -LivyId 0 +``` + +This command gets the Spark statement with the specified livy ID. + +### Example 3 +```powershell +$session = Get-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 107 +$session | Get-AzSynapseSparkStatement +``` + +This command gets all the Spark statements under a Spark session through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivyId +Identifier of Spark statement. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Id + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionId +Identifier of Spark session. + +```yaml +Type: System.Int32 +Parameter Sets: GetSparkStatementsByIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Int32 +Parameter Sets: GetSparkStatementsByParentObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionObject +Spark pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkSession +Parameter Sets: GetSparkStatementsByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SparkPoolName +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: GetSparkStatementsByIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetSparkStatementsByIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkSession + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkStatement + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlActiveDirectoryAdministrator.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlActiveDirectoryAdministrator.md new file mode 100644 index 0000000000..e24fc819d1 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlActiveDirectoryAdministrator.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlactivedirectoryadministrator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlActiveDirectoryAdministrator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlActiveDirectoryAdministrator.md +--- + +# Get-AzSynapseSqlActiveDirectoryAdministrator + +## SYNOPSIS +Gets information about an Azure AD administrator for Synapse Analytics Workspace. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseSqlActiveDirectoryAdministrator [-ResourceGroupName <String>] -WorkspaceName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzSynapseSqlActiveDirectoryAdministrator -InputObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseSqlActiveDirectoryAdministrator -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlActiveDirectoryAdministrator** cmdlet gets information about an Azure Active Directory (Azure AD) administrator for an Azure Synapse Analytics Workspace in the current subscription. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSqlActiveDirectoryAdministrator -WorkspaceName ContosoWorkspace +``` + +This command gets information about an Azure AD administrator for a workspace named ContosoWorkspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSWorkspaceAadAdminInfo + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlAdvancedDataSecurityPolicy.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlAdvancedDataSecurityPolicy.md new file mode 100644 index 0000000000..85093c6def --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlAdvancedDataSecurityPolicy.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqladvanceddatasecuritypolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlAdvancedDataSecurityPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlAdvancedDataSecurityPolicy.md +--- + +# Get-AzSynapseSqlAdvancedDataSecurityPolicy + +## SYNOPSIS +Gets Advanced Data Security policy of a workspace. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseSqlAdvancedDataSecurityPolicy [-ResourceGroupName <String>] -WorkspaceName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzSynapseSqlAdvancedDataSecurityPolicy -InputObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseSqlAdvancedDataSecurityPolicy -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlAdvancedDataSecurityPolicy** cmdlet retrieves the Advanced Data Security policy of a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSqlAdvancedDataSecurityPolicy -WorkspaceName ContosoWorkspace +``` + +This command gets Advanced Data Security on the workspace named ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseWorkspace -Name ContosoWorkspace | Get-AzSynapseSqlAdvancedDataSecurityPolicy +``` + +This command gets Advanced Data Security on the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.WorkspaceAdvancedDataSecurityPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..d6a2f4b2e7 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlAdvancedThreatProtectionSetting.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqladvancedthreatprotectionsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlAdvancedThreatProtectionSetting.md +--- + +# Get-AzSynapseSqlAdvancedThreatProtectionSetting + +## SYNOPSIS +Gets the advanced threat protection settings for a workspace. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseSqlAdvancedThreatProtectionSetting [-ResourceGroupName <String>] -WorkspaceName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzSynapseSqlAdvancedThreatProtectionSetting -InputObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseSqlAdvancedThreatProtectionSetting -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlAdvancedThreatProtectionSetting** cmdlet gets the advanced threat protection settings of an Azure Synapse Analytics Workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSqlAdvancedThreatProtectionSetting -WorkspaceName ContosoWorkspace +``` + +This command gets the advanced threat protection settings for a workspace named ContosoWorkspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSServerSecurityAlertPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlAuditSetting.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlAuditSetting.md new file mode 100644 index 0000000000..45ea14b256 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlAuditSetting.md @@ -0,0 +1,159 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlauditsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlAuditSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlAuditSetting.md +--- + +# Get-AzSynapseSqlAuditSetting + +## SYNOPSIS +Gets the auditing settings of an Azure Synapse Analytics Workspace. + +## SYNTAX + +### WorkspaceParameterSet (Default) +``` +Get-AzSynapseSqlAuditSetting [[-ResourceGroupName] <String>] [-WorkspaceName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### WorkspaceObjectParameterSet +``` +Get-AzSynapseSqlAuditSetting -WorkspaceObject <PSSynapseWorkspace> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### WorkspaceResourceIdParameterSetName +``` +Get-AzSynapseSqlAuditSetting -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlAuditSetting** cmdlet gets the auditing settings of an Azure Synapse Analytics Workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace +``` + +Gets the auditing settings of a workspace named ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseWorkspace -Name ContosoWorkspace | Get-AzSynapseSqlAuditSetting +``` + +Gets the auditing settings of a workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: WorkspaceParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: WorkspaceResourceIdParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: WorkspaceParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: WorkspaceObjectParameterSet +Aliases: InputObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.WorkspaceAuditModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlDatabase.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlDatabase.md new file mode 100644 index 0000000000..32c5d5f3d8 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlDatabase.md @@ -0,0 +1,174 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlDatabase.md +--- + +# Get-AzSynapseSqlDatabase + +## SYNOPSIS +This feature is in a limited preview, initially accessible only to certain subscriptions. Gets a Synapse Analytics SQL database. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseSqlDatabase [-ResourceGroupName <String>] -WorkspaceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseSqlDatabase [-Name <String>] -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseSqlDatabase -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +[This feature is in a limited preview, initially accessible only to certain subscriptions.] +The **Get-AzSynapseSqlDatabase** cmdlet gets information about an Azure Synapse Analytics SQL database. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSqlDatabase -WorkspaceName ContosoWorkspace +``` + +This command gets all SQL databases under a workspace. + +### Example 2 +```powershell +Get-AzSynapseSqlDatabase -WorkspaceName ContosoWorkspace -Name ContosoSqlDatabase +``` + +This command gets the SQL database under workspace ContosoWorkspace with name ContosoSqlDatabase. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseSqlDatabase +``` + +This command gets all the SQL databases under a workspace through pipeline. + +### Example 4 +```powershell +Get-AzSynapseSqlDatabase -ResourceId "/subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/sqlDatabases/ContosoSqlDatabase" +``` + +This command gets the SQL database with the specified resource ID. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL Database. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Database. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlDatabase + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPool.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPool.md new file mode 100644 index 0000000000..846493ba3d --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPool.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPool.md +--- + +# Get-AzSynapseSqlPool + +## SYNOPSIS +Gets a Synapse Analytics SQL pool. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseSqlPool [-ResourceGroupName <String>] -WorkspaceName <String> [-Name <String>] [-Version <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseSqlPool [-Name <String>] [-Version <Int32>] -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseSqlPool [-Version <Int32>] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlPool** cmdlet gets information about an Azure Synapse Analytics SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace +``` + +This command gets all SQL pools under a workspace. + +### Example 2 +```powershell +Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +``` + +This command gets the SQL pool under workspace ContosoWorkspace with name ContosoSqlPool. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseSqlPool +``` + +This command gets all the SQL pools under a workspace through pipeline. + +### Example 4 +```powershell +Get-AzSynapseSqlPool -ResourceId "/subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/sqlPools/ContosoSqlPool" +``` + +This command gets the SQL pool with the specified resource ID. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: SqlPoolName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +[This feature is in a limited preview, initially accessible only to certain subscriptions.] +Version of Synapse SQL pool. For example, 2 or 3. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..2ed626f9ff --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlpooladvancedthreatprotectionsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md +--- + +# Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting + +## SYNOPSIS +Gets the advanced threat protection settings for a SQL pool. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting -Name <String> -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting -InputObject <PSSynapseSqlPool> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting** cmdlet gets the advanced threat protection settings of an Azure Synapse Analytics SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +``` + +This command gets the advanced threat protection settings for a SQL pool named ContosoSqlPool under the workspace named ContosoWorkspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSqlPoolSecurityAlertPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolAuditSetting.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolAuditSetting.md new file mode 100644 index 0000000000..dea31277a2 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolAuditSetting.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlpoolauditsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolAuditSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolAuditSetting.md +--- + +# Get-AzSynapseSqlPoolAuditSetting + +## SYNOPSIS +Gets the auditing settings of an Azure Synapse Analytics SQL pool. + +## SYNTAX + +### SqlPoolParameterSet (Default) +``` +Get-AzSynapseSqlPoolAuditSetting [[-ResourceGroupName] <String>] [-WorkspaceName] <String> + -SqlPoolName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SqlPoolParentObjectParameterSet +``` +Get-AzSynapseSqlPoolAuditSetting -WorkspaceObject <PSSynapseWorkspace> -SqlPoolName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SqlPoolObjectParameterSet +``` +Get-AzSynapseSqlPoolAuditSetting -SqlPoolObject <PSSynapseSqlPool> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### SqlPoolResourceIdParameterSet +``` +Get-AzSynapseSqlPoolAuditSetting -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlPoolAuditSetting** cmdlet gets the auditing settings of an Azure Synapse Analytics SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSqlPoolAuditSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +``` + +This command gets the auditing settings of a SQL pool called ContosoSqlPool in the workspace ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool | Get-AzSynapseSqlPoolAuditSetting +``` + +This command gets the auditing settings of a SQL pool called ContosoSqlPool in the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: SqlPoolResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlPoolName +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet, SqlPoolParentObjectParameterSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlPoolObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: SqlPoolObjectParameterSet +Aliases: InputObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SqlPoolParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.SqlPoolAuditModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolGeoBackup.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolGeoBackup.md new file mode 100644 index 0000000000..f0af953893 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolGeoBackup.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlpoolgeobackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolGeoBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolGeoBackup.md +--- + +# Get-AzSynapseSqlPoolGeoBackup + +## SYNOPSIS +Gets a geo-redundant backup of a Sql Pool. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseSqlPoolGeoBackup -ResourceGroupName <String> -WorkspaceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseSqlPoolGeoBackup [-ResourceId <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlPoolGeoBackup** cmdlet gets a specified geo-redundant backup of a SQL Pool or all available geo-redundant backups on a specified workspace. +A geo-redundant backup is a restorable resource using data files from a separate geographic location. +You can use Geo-Restore to restore a geo-redundant backup in the event of a regional outage to recover your Sql Pool to a new region. + +## EXAMPLES + +### Example 1: Get a specified geo-redundant backup +```powershell +Get-AzSynapseSqlPoolGeoBackup -ResourceGroupName ContosoResourceGroup -WorkspaceName "ContosoWorkspace" -Name "ContosoSqlPool" +``` + +The cmdlet retrieves Geo Backup for a sql pool. + +### Example 2: Get all geo-redundant backups on a workspace +```powershell +Get-AzSynapseSqlPoolGeoBackup -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" +``` + +This command gets all available geo-redundant backups on a specified workspace. + +### Example 3: Get all geo-redundant backups on a workspace using filtering +```powershell +Get-AzSynapseSqlPoolGeoBackup -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -Name "Contoso*" +``` + +This command gets all available geo-redundant backups on a specified workspace that start with "Contoso". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Synapse Sql pool. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Input a Sql Pool Geo Backup Resource Id. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseResourceGroup + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSBackupModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolRestorePoint.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolRestorePoint.md new file mode 100644 index 0000000000..30883b584c --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolRestorePoint.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlpoolrestorepoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolRestorePoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolRestorePoint.md +--- + +# Get-AzSynapseSqlPoolRestorePoint + +## SYNOPSIS +Retrieves the distinct restore points from which a Synapse Analytics SQL pool can be restored. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseSqlPoolRestorePoint [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseSqlPoolRestorePoint -Name <String> -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzSynapseSqlPoolRestorePoint -InputObject <PSSynapseSqlPool> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseSqlPoolRestorePoint -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlPoolRestorePoint** cmdlet retrieves the distinct restore points that an Azure Synapse Analytics SQL pool can be restored from. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSqlPoolRestorePoint -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +``` + +This command returns all available restore points for the Azure Synapse Analytics SQL pool named ContosoSqlPool. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Management.Synapse.Models.RestorePoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolSensitivityClassification.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolSensitivityClassification.md new file mode 100644 index 0000000000..40671c91c2 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolSensitivityClassification.md @@ -0,0 +1,298 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlpoolsensitivityclassification +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolSensitivityClassification.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolSensitivityClassification.md +--- + +# Get-AzSynapseSqlPoolSensitivityClassification + +## SYNOPSIS +Gets the current information types and sensitivity labels of columns in the SQL pool. + +## SYNTAX + +### SqlPoolObjectParameterSet (Default) +``` +Get-AzSynapseSqlPoolSensitivityClassification -SqlPoolObject <PSSynapseSqlPool> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SqlPoolParameterSet +``` +Get-AzSynapseSqlPoolSensitivityClassification [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-SqlPoolName] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Get-AzSynapseSqlPoolSensitivityClassification [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-SqlPoolName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SqlPoolObjectColumnParameterSet +``` +Get-AzSynapseSqlPoolSensitivityClassification -SqlPoolObject <PSSynapseSqlPool> -SchemaName <String> + -TableName <String> -ColumnName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSynapseSqlPoolSensitivityClassification cmdlet returns the current information types and sensitivity labels of columns in the Azure Synapse SQL pool. + +## EXAMPLES + +### Example 1: Get current information types and sensitivity labels of an Azure Synapse SQL pool. +```powershell +Get-AzSynapseSqlPoolSensitivityClassification -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool +``` + +```output +ResourceGroupName : ContosoResourceGroup +WorkspaceName : ContosoWorkspace +SqlPoolName : ContosoSqlPool +SensitivityLabels : {{ + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailBody, + InformationType: Contact Info + }, { + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailSubject, + SensitivityLabel: Confidential, + Rank: Medium + }, { + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +### Example 2: Get current information types and sensitivity labels of an Azure Synapse SQL pool with Piping. +```powershell +Get-AzSynapseSqlPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool | Get-AzSynapseSqlPoolSensitivityClassification +``` + +```output +ResourceGroupName : ContosoResourceGroup +WorkspaceName : ContosoWorkspace +SqlPoolName : ContosoSqlPool +SensitivityLabels : {{ + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailBody, + InformationType: Contact Info + }, { + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailSubject, + SensitivityLabel: Confidential, + Rank: Medium + }, { + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +### Example 3: Get current information type and sensitivity label of a specific column of an Azure Synapse SQL pool. +```powershell +Get-AzSynapseSqlPoolSensitivityClassification -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool -SchemaName dbo -TableName EMailLog -ColumnName BounceEmailSubject +``` + +```output +ResourceGroupName : ContosoResourceGroup +WorkspaceName : ContosoWorkspace +SqlPoolName : ContosoSqlPool +SensitivityLabels : {{ + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +### Example 4: Get current information type and sensitivity label of a specific column of an Azure Synapse SQL pool using Piping. +```powershell +Get-AzSynapseSqlPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSqlPool | Get-AzSynapseSqlPoolSensitivityClassification -SchemaName dbo -TableName EMailLog -ColumnName BounceEmailSubject +``` + +```output +ResourceGroupName : ContosoResourceGroup +WorkspaceName : ContosoWorkspace +SqlPoolName : ContosoSqlPool +SensitivityLabels : {{ + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet, ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolName +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet, ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: SqlPoolObjectParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet, ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.DataClassification.SqlPoolSensitivityClassificationModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolSensitivityRecommendation.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolSensitivityRecommendation.md new file mode 100644 index 0000000000..ce01dfdf23 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolSensitivityRecommendation.md @@ -0,0 +1,201 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlpoolsensitivityrecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolSensitivityRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolSensitivityRecommendation.md +--- + +# Get-AzSynapseSqlPoolSensitivityRecommendation + +## SYNOPSIS +Gets the recommended information types and sensitivity labels of columns in the SQL pool. + +## SYNTAX + +### SqlPoolObjectParameterSet (Default) +``` +Get-AzSynapseSqlPoolSensitivityRecommendation -SqlPoolObject <PSSynapseSqlPool> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### SqlPoolParameterSet +``` +Get-AzSynapseSqlPoolSensitivityRecommendation [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-SqlPoolName] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The Get-AzSynapseSqlPoolSensitivityRecommendation cmdlet returns the recommended information types and sensitivity labels of columns in the SQL pool. + +## EXAMPLES + +### Example 1: Get recommended information types and sensitivity labels of an Azure Synapse SQL pool. +```powershell +Get-AzSynapseSqlPoolSensitivityRecommendation -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool +``` + +```output +ResourceGroupName : ContosoResourceGroup +WorkspaceName : ContosoWorkspace +SqlPoolName : ContosoSqlPool +SensitivityLabels : {{ + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailBody, + InformationType: Contact Info + }, { + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailSubject, + SensitivityLabel: Confidential, + Rank: Medium + }, { + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +### Example 2: Get recommended information types and sensitivity labels of an Azure Synapse SQL pool using Piping. +```powershell +Get-AzSynapseSqlPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSqlPool | Get-AzSynapseSqlPoolSensitivityRecommendation +``` + +```output +ResourceGroupName : ContosoResourceGroup +WorkspaceName : ContosoWorkspace +SqlPoolName : ContosoSqlPool +SensitivityLabels : {{ + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailBody, + InformationType: Contact Info + }, { + SchemaName: dbo, + TableName: Report, + ColumnName: ReportEmailSubject, + SensitivityLabel: Confidential, + Rank: Medium + }, { + SchemaName: dbo, + TableName: EMailLog, + ColumnName: BounceEmailSubject, + SensitivityLabel: Confidential, + InformationType: Contact Info, + Rank: Medium + }} +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolName +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: SqlPoolObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.DataClassification.SqlPoolSensitivityClassificationModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolTransparentDataEncryption.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolTransparentDataEncryption.md new file mode 100644 index 0000000000..5c40da21b1 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolTransparentDataEncryption.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlpooltransparentdataencryption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolTransparentDataEncryption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolTransparentDataEncryption.md +--- + +# Get-AzSynapseSqlPoolTransparentDataEncryption + +## SYNOPSIS +Gets the TDE state for a SQL pool. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseSqlPoolTransparentDataEncryption [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseSqlPoolTransparentDataEncryption -Name <String> -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzSynapseSqlPoolTransparentDataEncryption -InputObject <PSSynapseSqlPool> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseSqlPoolTransparentDataEncryption -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlPoolTransparentDataEncryption** cmdlet gets the state of Transparent Data Encryption (TDE) for an Azure Synapse Analytics SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSqlPoolTransparentDataEncryption -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +``` + +This command gets the status of TDE for the SQL pool named ContosoSqlPool under the workspace named ContosoWorkspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSTransparentDataEncryption + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md new file mode 100644 index 0000000000..91a3273e8d --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlpoolvulnerabilityassessmentrulebaseline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md +--- + +# Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline + +## SYNOPSIS +Gets the vulnerability assessment rule baseline. + +## SYNTAX + +``` +Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline [-WorkspaceName] <String> [-Name] <String> + [-InputObject <PSSynapseSqlPool>] -RuleId <String> [-RuleAppliesToMaster] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline** cmdlet gets the vulnerability assessment rule baseline. +Note that you need to run *Enable-AzSynapseSqlAdvancedDataSecurity* and *Update-AzSynapseSqlVulnerabilityAssessmentSetting* cmdlets as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1: Get the vulnerability assessment rule baseline +```powershell +Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ContosoResourceGroup" ` + -WorkspaceName "ContosoWorkspace" ` + -SqlPoolName "ContosoSqlPool" ` + -RuleId "VA2108" ` + -RuleAppliesToMaster +``` + +```output +ResourceGroupName : ContosoResourceGroup +WorkspaceName : ContosoWorkspace +SqlPoolName : ContosoSqlPool +RuleId : VA2108 +RuleAppliesToMaster : True +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +### Example 2: Get the vulnerability assessment rule baseline from a SQL pool object +```powershell +Get-AzSynapseSqlPool ` + -ResourceGroupName "ContosoResourceGroup" ` + -WorkspaceName "ContosoWorkspace" ` + -Name "ContosoSqlPool" ` + | Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline ` + -RuleId "VA2108" +``` + +```output +ResourceGroupName : ContosoResourceGroup +WorkspaceName : ContosoWorkspace +SqlPoolName : ContosoSqlPool +RuleId : VA2108 +RuleAppliesToMaster : False +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SqlPoolName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleAppliesToMaster +Specifies whether the baseline results should apply on a workspace level rule identified by the RuleId + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleId +The rule ID which identifies the rule to set the baseline results to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.VulnerabilityAssessment.SqlPoolVulnerabilityAssessmentRuleBaselineModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord.md new file mode 100644 index 0000000000..4885b00b34 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord.md @@ -0,0 +1,229 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlpoolvulnerabilityassessmentscanrecord +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord.md +--- + +# Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord + +## SYNOPSIS +Gets all vulnerability assessment scan record(s) associated with a given sql pool. + +## SYNTAX + +### GetBySqlPoolObjectParameterSet (Default) +``` +Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord [-ScanId <String>] [-SqlPoolObject <PSSynapseSqlPool>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByNameParameterSet +``` +Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> [-ScanId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord** cmdlet retrieves all vulnerability assessment scan record(s) associated with a given managed sql pool. +Note that you need to run *Enable-AzSynapseSqlAdvancedThreatProtection* and *Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1 - Gets a specific vulnerability assessment scan results identified by the scan ID +```powershell +Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord ` + -ResourceGroupName "ResourceGroup01" ` + -WorkspaceName "WorkspaceName01" ` + -Name "Name01" ` + -ScanId "myScan" +``` + +```output +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : myScan +TriggerType : OnDemand +State : Passed +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/WorkspaceName01/Name01/scan_myScan/.json +NumberOfFailedSecurityChecks : 9 +``` + +### Example 2 - Gets a specific vulnerability assessment scan results identified by the scan ID with sql pool object +```powershell +Get-AzSynapseSqlPool ` + -ResourceGroupName "ResourceGroup01" ` + -WorkspaceName "WorkspaceName01" ` + -Name "Name01" ` + | Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord ` + -ScanId "myScan" +``` + +```output +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : myScan +TriggerType : OnDemand +State : Passed +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/WorkspaceName01/Name01/scan_myScan/.json +NumberOfFailedSecurityChecks : 9 +``` + +### Example 3 - Gets all vulnerability assessment scan results on the specified sql pool +```powershell +Get-AzSynapseSqlPool ` + -ResourceGroupName "ResourceGroup01" ` + -WorkspaceName "WorkspaceName01" ` + -Name "Name01" ` + | Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord +``` + +```output +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : myScan +TriggerType : OnDemand +State : Passed +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/WorkspaceName01/Name01/scan_myScan/.json +NumberOfFailedSecurityChecks : 9 + + +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : myScan1 +TriggerType : OnDemand +State : Passed +StartTime : 6/12/2018 1:57:27 PM +EndTime : 6/12/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/WorkspaceName01/Name01/scan_myScan/.json +NumberOfFailedSecurityChecks : 9 +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScanId +Specifies the scan ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolObject +The sql pool object to get Vulnerability Assessment scan record for + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: GetBySqlPoolObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.VulnerabilityAssessment.PSVulnerabilityAssessmentScanRecordModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..38839f70c2 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlpoolvulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md +--- + +# Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting + +## SYNOPSIS +Gets the vulnerability assessment settings of a SQL pool. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting -Name <String> -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting -InputObject <PSSynapseSqlPool> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting -ResourceId <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting** cmdlet gets the vulnerability assessment settings of an Azure Synapse Analytics SQL pool. +Note that you need to run *Enable-AzSynapseSqlAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +``` + +This command gets the vulnerability assessment settings of a SQL pool named ContosoSqlPool. + +### Example 2 +```powershell +Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool | Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting +``` + +This command gets the vulnerability assessment settings of a SQL pool named ContosoSqlPool through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: SqlPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.SqlPoolVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlScript.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlScript.md new file mode 100644 index 0000000000..96996b7c8a --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlScript.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlScript.md +--- + +# Get-AzSynapseSqlScript + +## SYNOPSIS +Gets information about sql scripts in a Synapse workspace. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseSqlScript -WorkspaceName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseSqlScript -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlScript** cmdlet gets information about sql scripts in a workspace. If you specify the name of a sql script, the cmdlet gets information about that sql script. If you do not specify a name, the cmdlet gets information about all sql scripts in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSqlScript -workspaceName ContosoWorkspace +``` + +Gets a list of all sql scripts in the workspace ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseSqlScript -workspaceName ContosoWorkspace -Name "ContosoSqlScript" +``` + +Gets a single sql script called ContosoSqlScript in the workspace ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseSqlScript -Name ContosoSqlScript +``` + +Gets a single sql script called ContosoSqlScript in the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The sql script name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SqlScriptName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSqlScriptResource + +## NOTES + +## RELATED LINKS + +[Export-AzSynapseSqlScript](./Export-AzSynapseSqlScript.md) + +[Remove-AzSynapseSqlScript](./Remove-AzSynapseSqlScript.md) + +[Set-AzSynapseSqlScript](./Set-AzSynapseSqlScript.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..bcbf66e2d4 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseSqlVulnerabilityAssessmentSetting.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsesqlvulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseSqlVulnerabilityAssessmentSetting.md +--- + +# Get-AzSynapseSqlVulnerabilityAssessmentSetting + +## SYNOPSIS +Gets the vulnerability assessment settings of a workspace. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseSqlVulnerabilityAssessmentSetting [-ResourceGroupName <String>] -WorkspaceName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObjectParameterSet +``` +Get-AzSynapseSqlVulnerabilityAssessmentSetting -InputObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseSqlVulnerabilityAssessmentSetting -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlVulnerabilityAssessmentSetting** cmdlet gets the vulnerability assessment settings of an Azure Synapse Analytics workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseSqlVulnerabilityAssessmentSetting -WorkspaceName ContosoWorkspace +``` + +This command gets the vulnerability assessment settings of a workspace called ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseWorkspace -Name ContosoWorkspace | Get-AzSynapseSqlVulnerabilityAssessmentSetting +``` + +This command gets the vulnerability assessment settings of a workspace called ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.VulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseTrigger.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseTrigger.md new file mode 100644 index 0000000000..fde2f272ff --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseTrigger.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsetrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseTrigger.md +--- + +# Get-AzSynapseTrigger + +## SYNOPSIS +Gets information about triggers in a workspace. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseTrigger -WorkspaceName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseTrigger -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseTrigger** cmdlet gets information about triggers in a workspace. If you specify the name of a trigger, the cmdlet gets information about that trigger. If you do not specify a name, the cmdlet gets information about all triggers in the workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace +``` + +Gets a list of all triggers that have been created in the workspace ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger +``` + +Gets a single trigger called ContosoTrigger in the workspace ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseTrigger -Name ContosoTrigger +``` + +Gets a single trigger called ContosoTrigger in the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TriggerName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseTriggerRun.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseTriggerRun.md new file mode 100644 index 0000000000..13bbb3bc49 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseTriggerRun.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsetriggerrun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseTriggerRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseTriggerRun.md +--- + +# Get-AzSynapseTriggerRun + +## SYNOPSIS +Returns information about trigger runs. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseTriggerRun -WorkspaceName <String> -Name <String> -RunStartedAfter <DateTimeOffset> + -RunStartedBefore <DateTimeOffset> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseTriggerRun -WorkspaceObject <PSSynapseWorkspace> -Name <String> -RunStartedAfter <DateTimeOffset> + -RunStartedBefore <DateTimeOffset> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseTriggerRun** command returns detailed information about trigger runs for the specified trigger in the given timeframe. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseTriggerRun -WorkspaceName ContosoWorkspace -Name ContosoTrigger -RunStartedAfter "2018-09-01T21:00" -RunStartedBefore "2019-09-01T21:00" +``` + +This command shows information about runs for ContosoTrigger in the workspace ContosoWorkspace that started between "2018-09-01T21:00" and "2019-09-01T21:00". + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseTriggerRun -Name ContosoTrigger -RunStartedAfter "2018-09-01T21:00" -RunStartedBefore "2019-09-01T21:00" +``` + +This command shows information about runs for ContosoTrigger in the workspace ContosoWorkspace that started between "2018-09-01T21:00" and "2019-09-01T21:00" through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TriggerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunStartedAfter +The time at or after which the run event was updated in 'ISO 8601' format. + +```yaml +Type: System.DateTimeOffset +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunStartedBefore +The time at or before which the run event was updated in 'ISO 8601' format. + +```yaml +Type: System.DateTimeOffset +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSTriggerRun + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseTriggerSubscriptionStatus.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseTriggerSubscriptionStatus.md new file mode 100644 index 0000000000..9006e19c76 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseTriggerSubscriptionStatus.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapsetriggersubscriptionstatus +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseTriggerSubscriptionStatus.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseTriggerSubscriptionStatus.md +--- + +# Get-AzSynapseTriggerSubscriptionStatus + +## SYNOPSIS +Get the status of the subscription for the event trigger to the specified external service events. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseTriggerSubscriptionStatus -WorkspaceName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseTriggerSubscriptionStatus -WorkspaceObject <PSSynapseWorkspace> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByInputObject +``` +Get-AzSynapseTriggerSubscriptionStatus -InputObject <PSTriggerResource> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseTriggerSubscriptionStatus** cmdlet gets the status of the subscription for the event trigger to the specified external service events. The trigger can't be started until the returned status is "Enabled". + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseTriggerSubscriptionStatus -WorkspaceName ContosoWorkspace -Name ContosoTrigger +``` + +This command will get the status of the subscribtion for trigger called ContosoTrigger to the external service events. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseTriggerSubscriptionStatus -Name ContosoTrigger +``` + +This command will get the status of the subscribtion for trigger called ContosoTrigger to the external service events through pipeline. + +### Example 3 +```powershell +$trigger = Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger +$trigger | Get-AzSynapseTriggerSubscriptionStatus +``` + +This command will get the status of the subscribtion for trigger called ContosoTrigger to the external service events through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The trigger object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource +Parameter Sets: GetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: GetByName, GetByObject +Aliases: TriggerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSTriggerSubscriptionOperationStatus + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseWorkspace.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseWorkspace.md new file mode 100644 index 0000000000..341274d7c2 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseWorkspace.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapseworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseWorkspace.md +--- + +# Get-AzSynapseWorkspace + +## SYNOPSIS +Gets a Synapse Analytics workspace. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseWorkspace [-ResourceGroupName <String>] [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseWorkspace -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseWorkspace** cmdlet gets information about an Azure Synapse Analytics workspace. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseWorkspace +``` + +This command gets all the Azure Synapse Analytics workspaces under the current subscription. + +### Example 2 +```powershell +Get-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup +``` + +This command gets all the Azure Synapse Analytics workspaces under the current subscription within the Resource Group ContosoResourceGroup. + +### Example 3 +```powershell +Get-AzSynapseWorkspace -Name ContosoWorkspace +``` + +This command gets the Azure Synapse Analytics workspace with the specified name. + +### Example 4 +```powershell +Get-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace +``` + +This command gets the Azure Synapse Analytics workspace with the specified resource ID. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: WorkspaceName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseWorkspaceKey.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseWorkspaceKey.md new file mode 100644 index 0000000000..865466803b --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseWorkspaceKey.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +module name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapseworkspacekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseWorkspaceKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseWorkspaceKey.md +--- + +# Get-AzSynapseWorkspaceKey + +## SYNOPSIS +Gets a workspace key. + +## SYNTAX + +### GetByNameParameterSet (Default) +``` +Get-AzSynapseWorkspaceKey [-ResourceGroupName <String>] -WorkspaceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByParentObjectParameterSet +``` +Get-AzSynapseWorkspaceKey [-Name <String>] -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByResourceIdParameterSet +``` +Get-AzSynapseWorkspaceKey -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseWorkspaceKey** cmdlet gets a workspace key. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace +``` + +This command gets information about all workspace keys in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace -Name ContosoWorkspaceKey +``` + +This command gets information about the workspace key named ContosoWorkspaceKey in the workspace named ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseWorkspaceKey -Name ContosoWorkspaceKey +``` + +This command gets information about the workspace key named ContosoWorkspaceKey in the workspace named ContosoWorkspace through pipeline. + +### Example 4 +```powershell +Get-AzSynapseSqlPool -ResourceId "/subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/keys/ContosoWorkspaceKey" +``` + +This command gets the workspace key with the specified resource ID. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The workspace encryption key name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet +Aliases: KeyName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: GetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.WorkspaceKey.PSWorkspaceKey + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Get-AzSynapseWorkspacePackage.md b/azps-10.1.0/Az.Synapse/Get-AzSynapseWorkspacePackage.md new file mode 100644 index 0000000000..d7744488b4 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Get-AzSynapseWorkspacePackage.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/get-azsynapseworkspacepackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseWorkspacePackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Get-AzSynapseWorkspacePackage.md +--- + +# Get-AzSynapseWorkspacePackage + +## SYNOPSIS +Gets a workspace package. + +## SYNTAX + +### GetByName (Default) +``` +Get-AzSynapseWorkspacePackage -WorkspaceName <String> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### GetByObject +``` +Get-AzSynapseWorkspacePackage -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseWorkspacePackage** cmdlet gets a workspace package. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace +``` + +This command gets information about all workspace packages in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace -Name ContosoWorkspacePackage +``` + +This command gets information about the workspace package named ContosoWorkspacePackage in the workspace named ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Get-AzSynapseWorkspacePackage -Name ContosoWorkspacePackage +``` + +This command gets information about the workspace package named ContosoWorkspacePackage in the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The workspace package name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PackageName, Package + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: GetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Invoke-AzSynapseDataFlowDebugSessionCommand.md b/azps-10.1.0/Az.Synapse/Invoke-AzSynapseDataFlowDebugSessionCommand.md new file mode 100644 index 0000000000..570194b908 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Invoke-AzSynapseDataFlowDebugSessionCommand.md @@ -0,0 +1,271 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/invoke-azsynapsedataflowdebugsessioncommand +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Invoke-AzSynapseDataFlowDebugSessionCommand.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Invoke-AzSynapseDataFlowDebugSessionCommand.md +--- + +# Invoke-AzSynapseDataFlowDebugSessionCommand + +## SYNOPSIS +Invoke debug action in data flow debug session. + +## SYNTAX + +### InvokeByName (Default) +``` +Invoke-AzSynapseDataFlowDebugSessionCommand -WorkspaceName <String> -SessionId <String> -Command <String> + -StreamName <String> [-RowLimit <Int32>] [-Expression <String>] + [-Column <System.Collections.Generic.List`1[System.String]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeByObject +``` +Invoke-AzSynapseDataFlowDebugSessionCommand -WorkspaceObject <PSSynapseWorkspace> -SessionId <String> + -Command <String> -StreamName <String> [-RowLimit <Int32>] [-Expression <String>] + [-Column <System.Collections.Generic.List`1[System.String]>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This command executes data preview/stats preview/expression preview for different streams of data flow in debug session. The PowerShell command sequence for data flow debug workflow should be: + +Start-AzSynapseDataFlowDebugSession +Add-AzSynapseDataFlowDebugSessionPackage +Invoke-AzSynapseDataFlowDebugSessionCommand (repeat this step for different commands/targets, or repeat step 2-3 in order to change the package file) +Stop-AzSynapseDataFlowDebugSession + +## EXAMPLES + +### Example 1 +<!-- Skip: Output cannot be splitted from code --> +```powershell +$result = Invoke-AzSynapseDataFlowDebugSessionCommand -WorkspaceName ContosoWorkspace -Command executePreviewQuery -SessionId 3afb278e-ac5f-469f-a0b6-2f04c3ab59bc -StreamName source1 -RowLimit 100 -AsJob +$result | Format-Table -wrap + +Id Name PSJobTypeName State HasMoreData Location Command +-- ---- ------------- ----- ----------- -------- ------- +1 Long Running Operation AzureLongRunningJob`1 Completed True localhost Invoke-AzSynapseDataFlowDebugSessionCommand + for 'Invoke-AzSynapseD + ataFlowDebugSessionCommand' + +$output = ConvertFrom-Json($result.Output.Data) +$output.output + + { + "schema": "output(ResourceAgencyNum as string, PublicName as string)" , + "data": [["4445679354", "Syrian Refugee Information", 1], ["44456793", "Syrian Refugee Information", 1]] + } +``` + +This example invokes data preview command for debug session "3afb278e-ac5f-469f-a0b6-2f04c3ab59bc" in Synapse workspace "ContosoWorkspace" and then convert the JSON output into readable string. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Invoke-AzSynapseDataFlowDebugSessionCommand -Command executePreviewQuery -SessionId 3afb278e-ac5f-469f-a0b6-2f04c3ab59bc -StreamName source1 -RowLimit 100 +``` + +This example invokes data preview command for debug session "3afb278e-ac5f-469f-a0b6-2f04c3ab59bc" in Synapse workspace "ContosoWorkspace" through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Column +The column list for data flow statistics preview. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Command +The data flow debug command. +Optionals are executePreviewQuery, executeStatisticsQuery and executeExpressionQuery. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expression +The expression for data flow expression preview. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RowLimit +The row limit for data flow data preview. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionId +Identifier for Synapse data flow debug session. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamName +The stream name of data flow for debugging. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: InvokeByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: InvokeByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSDataFlowDebugCommandResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md b/azps-10.1.0/Az.Synapse/Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md new file mode 100644 index 0000000000..fac8b5a251 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/invoke-azsynapsedetachkustopoolfollowerdatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md +--- + +# Invoke-AzSynapseDetachKustoPoolFollowerDatabase + +## SYNOPSIS +Detaches all followers of a database owned by this Kusto Pool. + +## SYNTAX + +### DetachExpanded (Default) +``` +Invoke-AzSynapseDetachKustoPoolFollowerDatabase -KustoPoolName <String> -ResourceGroupName <String> + -WorkspaceName <String> -AttachedDatabaseConfigurationName <String> -KustoPoolResourceId <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DetachViaIdentityExpanded +``` +Invoke-AzSynapseDetachKustoPoolFollowerDatabase -InputObject <ISynapseIdentity> + -AttachedDatabaseConfigurationName <String> -KustoPoolResourceId <String> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Detaches all followers of a database owned by this Kusto Pool. + +## EXAMPLES + +### Example 1: Detach a follower database +```powershell +Invoke-AzSynapseDetachKustoPoolFollowerDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -AttachedDatabaseConfigurationName "myfollowerconfiguration" -KustoPoolResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Synapse/workspaces/testws/kustoPools/testfollowerkustopool" + +``` + +The above command detaches the follower database defined in AttachedDatabaseConfiguration "myfollowerconfiguration" from Kusto Pool "testfollowerkustopool". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachedDatabaseConfigurationName +Resource name of the attached database configuration in the follower cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: DetachViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: DetachExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolResourceId +Resource id of the cluster that follows a database owned by this cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: DetachExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: DetachExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: DetachExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Invoke-AzSynapseIntegrationRuntimeUpgrade.md b/azps-10.1.0/Az.Synapse/Invoke-AzSynapseIntegrationRuntimeUpgrade.md new file mode 100644 index 0000000000..48f488edca --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Invoke-AzSynapseIntegrationRuntimeUpgrade.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/invoke-azsynapseintegrationruntimeupgrade +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Invoke-AzSynapseIntegrationRuntimeUpgrade.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Invoke-AzSynapseIntegrationRuntimeUpgrade.md +--- + +# Invoke-AzSynapseIntegrationRuntimeUpgrade + +## SYNOPSIS +Upgrades self-hosted integration runtime. + +## SYNTAX + +### InvokeByNameParameterSet (Default) +``` +Invoke-AzSynapseIntegrationRuntimeUpgrade [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeByParentObjectParameterSet +``` +Invoke-AzSynapseIntegrationRuntimeUpgrade -Name <String> -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeByResourceIdParameterSet +``` +Invoke-AzSynapseIntegrationRuntimeUpgrade -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeByInputObjectParameterSet +``` +Invoke-AzSynapseIntegrationRuntimeUpgrade -InputObject <PSIntegrationRuntime> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzSynapseIntegrationRuntimeUpgrade** cmdlet upgrades self-hosted integration runtime if the new version is available. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzSynapseIntegrationRuntimeUpgrade -WorkspaceName ContosoWorkspace -Name 'test-selfhost-ir' +``` + +The cmdlet upgrades self-hosted integration runtime named 'test-selfhost-ir' in workspace ContosoWorkspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: InvokeByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: InvokeByNameParameterSet, InvokeByParentObjectParameterSet +Aliases: IntegrationRuntimeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: InvokeByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: InvokeByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: InvokeByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: InvokeByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Invoke-AzSynapsePipeline.md b/azps-10.1.0/Az.Synapse/Invoke-AzSynapsePipeline.md new file mode 100644 index 0000000000..1e9f7fcd0c --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Invoke-AzSynapsePipeline.md @@ -0,0 +1,282 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/invoke-azsynapsepipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Invoke-AzSynapsePipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Invoke-AzSynapsePipeline.md +--- + +# Invoke-AzSynapsePipeline + +## SYNOPSIS +Invokes a pipeline to start a run for it. + +## SYNTAX + +### NewByName (Default) +``` +Invoke-AzSynapsePipeline -WorkspaceName <String> -PipelineName <String> [-Parameter <Hashtable>] + [-ParameterFile <String>] [-ReferencePipelineRunId <String>] [-IsRecovery] [-StartActivityName <String>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewByInputObject +``` +Invoke-AzSynapsePipeline -InputObject <PSPipelineResource> [-Parameter <Hashtable>] [-ParameterFile <String>] + [-ReferencePipelineRunId <String>] [-IsRecovery] [-StartActivityName <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewByObject +``` +Invoke-AzSynapsePipeline -WorkspaceObject <PSSynapseWorkspace> -PipelineName <String> [-Parameter <Hashtable>] + [-ParameterFile <String>] [-ReferencePipelineRunId <String>] [-IsRecovery] [-StartActivityName <String>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzSynapsePipeline** command starts a run on the specified pipeline and returns a ID for that run. This GUID can be passed to **Get-AzSynapsePipelineRun** or **Get-AzSynapseActivityRun** to obtain further details about this run. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzSynapsePipeline -WorkspaceName ContosoWorkspace -PipelineName ContosoPipeline +``` + +This command starts a run for pipeline called ContosoPipeline in the workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Invoke-AzSynapsePipeline -PipelineName ContosoPipeline +``` + +This command starts a run for pipeline called ContosoPipeline in the workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$pipeline = Get-AzSynapsePipeline -WorkspaceName ContosoWorkspace -Name ContosoPipeline +$pipeline | Invoke-AzSynapsePipeline +``` + +This command starts a run for pipeline called ContosoPipeline in the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The information about the pipeline run. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSPipelineResource +Parameter Sets: NewByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsRecovery +Recovery mode flag. +If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Parameters for pipeline run. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParameterFile +The name of the file with parameters for pipeline run. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineName +The pipeline name. + +```yaml +Type: System.String +Parameter Sets: NewByName, NewByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReferencePipelineRunId +The pipeline run ID for rerun. +If run ID is specified, the parameters of the specified run will be used to create a new run. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartActivityName +In recovery mode, the rerun will start from this activity. +If not specified, all activities will run. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: NewByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: NewByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSPipelineResource + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSCreateRunResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Invoke-AzSynapseSparkStatement.md b/azps-10.1.0/Az.Synapse/Invoke-AzSynapseSparkStatement.md new file mode 100644 index 0000000000..50d04b8f6f --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Invoke-AzSynapseSparkStatement.md @@ -0,0 +1,298 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/invoke-azsynapsesparkstatement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Invoke-AzSynapseSparkStatement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Invoke-AzSynapseSparkStatement.md +--- + +# Invoke-AzSynapseSparkStatement + +## SYNOPSIS +Invokes a Synapse Analytics Spark statement. + +## SYNTAX + +### RunSparkStatementByCodePathParameterSet (Default) +``` +Invoke-AzSynapseSparkStatement -WorkspaceName <String> -SparkPoolName <String> -Language <String> + -SessionId <Int32> -FilePath <String> [-Response] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RunSparkStatementByCodeParameterSet +``` +Invoke-AzSynapseSparkStatement -WorkspaceName <String> -SparkPoolName <String> -Language <String> + -SessionId <Int32> -Code <String> [-Response] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### RunSparkStatementByCodeAndInputObjectParameterSet +``` +Invoke-AzSynapseSparkStatement -Language <String> -SessionObject <PSSynapseSparkSession> [-SessionId <Int32>] + -Code <String> [-Response] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RunSparkStatementByCodePathAndInputObjectParameterSet +``` +Invoke-AzSynapseSparkStatement -Language <String> -SessionObject <PSSynapseSparkSession> [-SessionId <Int32>] + -FilePath <String> [-Response] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Invoke-AzSynapseSparkStatement** cmdlet invokes a Synapse Analytics Spark statement. + +## EXAMPLES + +### Example 1 +```powershell +$session = Start-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -Name ContosoSessionName -ExecutorCount 3 -ExecutorSize Small +$session.Language = 'Spark' +$session | Invoke-AzSynapseSparkStatement -Code 'print("Hello world\n")' +``` + +These commands start a Spark session then invoke an inline Spark statement through pipeline. + +### Example 2 +```powershell +Invoke-AzSynapseSparkStatement -SessionId 324 -Language 'Spark' -Code 'print("Hello world\n")' +``` + +These commands start a Spark session then invoke an inline Spark statement. + +### Example 3 +```powershell +$session = Start-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -Name ContosoSessionName -ExecutorCount 3 -ExecutorSize Small +$session.Language = 'Spark' +$session | Invoke-AzSynapseSparkStatement -FilePath 'C:\path\to\code.sc' +``` + +These commands start a Spark session then invoke Spark statements in a file. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Code +The execution code. + +```yaml +Type: System.String +Parameter Sets: RunSparkStatementByCodeParameterSet, RunSparkStatementByCodeAndInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +Specifies a local file path that contains the execution code. + +```yaml +Type: System.String +Parameter Sets: RunSparkStatementByCodePathParameterSet, RunSparkStatementByCodePathAndInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Language +Language of the execution code. + +```yaml +Type: System.String +Parameter Sets: RunSparkStatementByCodePathParameterSet, RunSparkStatementByCodeParameterSet +Aliases: +Accepted values: Spark, Scala, PySpark, Python, SparkDotNet, CSharp, SQL + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: RunSparkStatementByCodeAndInputObjectParameterSet, RunSparkStatementByCodePathAndInputObjectParameterSet +Aliases: +Accepted values: Spark, Scala, PySpark, Python, SparkDotNet, CSharp, SQL + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Response +Indicates full response should be return. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionId +Identifier of Spark session. + +```yaml +Type: System.Int32 +Parameter Sets: RunSparkStatementByCodePathParameterSet, RunSparkStatementByCodeParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Int32 +Parameter Sets: RunSparkStatementByCodeAndInputObjectParameterSet, RunSparkStatementByCodePathAndInputObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionObject +Spark session input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkSession +Parameter Sets: RunSparkStatementByCodeAndInputObjectParameterSet, RunSparkStatementByCodePathAndInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SparkPoolName +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: RunSparkStatementByCodePathParameterSet, RunSparkStatementByCodeParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RunSparkStatementByCodePathParameterSet, RunSparkStatementByCodeParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkSession + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseExtendedSparkStatement + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Invoke-AzSynapseTriggerRun.md b/azps-10.1.0/Az.Synapse/Invoke-AzSynapseTriggerRun.md new file mode 100644 index 0000000000..62cb27015f --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Invoke-AzSynapseTriggerRun.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/invoke-azsynapsetriggerrun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Invoke-AzSynapseTriggerRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Invoke-AzSynapseTriggerRun.md +--- + +# Invoke-AzSynapseTriggerRun + +## SYNOPSIS +Invokes another instance of a trigger run. + +## SYNTAX + +### InvokeByName (Default) +``` +Invoke-AzSynapseTriggerRun -WorkspaceName <String> -Name <String> -TriggerRunId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokByInputObject +``` +Invoke-AzSynapseTriggerRun -InputObject <PSTriggerRun> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InvokeByWorkspaceObject +``` +Invoke-AzSynapseTriggerRun -WorkspaceObject <PSSynapseWorkspace> -Name <String> -TriggerRunId <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Invoke-AzSynapseTriggerRun command starts another instance of a trigger run with a new trigger run id. + +## EXAMPLES + +### Example 1 +```powershell +Invoke-AzSynapseTriggerRun -WorkspaceName ContosoWorkspace -Name ContosoTrigger -TriggerRunId 000111222333abc +``` + +Starts another instance of a trigger run with a new trigger run id, keeping the same windowStartTime and windowEndTime as the original trigger run. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Invoke-AzSynapseTriggerRun -Name ContosoTrigger -TriggerRunId 000111222333abc +``` + +Starts another instance of a trigger run with a new trigger run id in the Synapse workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$triggerun = Get-AzSynapseTriggerRun -WorkspaceName ContosoWorkspace -Name ContosoTrigger -RunStartedAfter "2018-09-01T21:00" -RunStartedBefore "2019-09-01T21:00" +$triggerun | Invoke-AzSynapseTriggerRun +``` + +Starts another instance of a trigger run with a new trigger run id in the Synapse workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The information about the trigger run. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSTriggerRun +Parameter Sets: InvokByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: InvokeByName, InvokeByWorkspaceObject +Aliases: TriggerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerRunId +The Run ID of the trigger. + +```yaml +Type: System.String +Parameter Sets: InvokeByName, InvokeByWorkspaceObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: InvokeByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: InvokeByWorkspaceObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSTriggerRun + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseFirewallRule.md b/azps-10.1.0/Az.Synapse/New-AzSynapseFirewallRule.md new file mode 100644 index 0000000000..00f218d075 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseFirewallRule.md @@ -0,0 +1,281 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsefirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseFirewallRule.md +--- + +# New-AzSynapseFirewallRule + +## SYNOPSIS +Creates a Synapse Analytics Firewall Rule. + +## SYNTAX + +### CreateByNameParameterSet (Default) +``` +New-AzSynapseFirewallRule [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + -StartIpAddress <String> -EndIpAddress <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### CreateByNameAllowAllAzureIpParameterSet +``` +New-AzSynapseFirewallRule [-ResourceGroupName <String>] -WorkspaceName <String> [-AllowAllAzureIp] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByNameAllowAllIpParameterSet +``` +New-AzSynapseFirewallRule [-ResourceGroupName <String>] -WorkspaceName <String> [-AllowAllIp] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByParentObjectParameterSet +``` +New-AzSynapseFirewallRule -WorkspaceObject <PSSynapseWorkspace> -Name <String> -StartIpAddress <String> + -EndIpAddress <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CreateByParentObjectAllowAllAzureIpParameterSet +``` +New-AzSynapseFirewallRule -WorkspaceObject <PSSynapseWorkspace> [-AllowAllAzureIp] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByParentObjectAllowAllIpParameterSet +``` +New-AzSynapseFirewallRule -WorkspaceObject <PSSynapseWorkspace> [-AllowAllIp] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSynapseFirewallRule** cmdlet creates an Azure Synapse Analytics Firewall Rule. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSynapseFirewallRule -WorkspaceName ContosoWorkspace -Name ContosoFirewallRule -StartIpAddress "0.0.0.0" -EndIpAddress "255.255.255.255" +``` + +This command creates firewall rule named ContosoFirewallRule under workspace ContosoWorkspace with name ContosoFirewallRule. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | New-AzSynapseFirewallRule -Name ContosoFirewallRule -StartIpAddress "0.0.0.0" -EndIpAddress "255.255.255.255" +``` + +This command creates firewall rule named ContosoFirewallRule under a workspace through pipeline. + +### Example 3 +```powershell +New-AzSynapseFirewallRule -WorkspaceName ContosoWorkspace -AllowAllAzureIP +``` + +This command creates firewall rule that allow all azure ips under a workspace. + +## PARAMETERS + +### -AllowAllAzureIp +Creates a special firewall rule that permits all Azure IPs to have access. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateByNameAllowAllAzureIpParameterSet, CreateByParentObjectAllowAllAzureIpParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAllIp +Creates a special firewall rule that allows connections from all IP addresses. The Start IP is 0.0.0.0. The End IP is 255.255.255.255. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateByNameAllowAllIpParameterSet, CreateByParentObjectAllowAllIpParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIpAddress +The end IP address of the firewall rule. +Must be IPv4 format. +Must be greater than or equal to startIpAddress. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet, CreateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The firerwall rule name for the workspace. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet, CreateByParentObjectParameterSet +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet, CreateByNameAllowAllAzureIpParameterSet, CreateByNameAllowAllIpParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIpAddress +The start IP address of the firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet, CreateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet, CreateByNameAllowAllAzureIpParameterSet, CreateByNameAllowAllIpParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: CreateByParentObjectParameterSet, CreateByParentObjectAllowAllAzureIpParameterSet, CreateByParentObjectAllowAllIpParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseIpFirewallRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseGitRepositoryConfig.md b/azps-10.1.0/Az.Synapse/New-AzSynapseGitRepositoryConfig.md new file mode 100644 index 0000000000..120ecd8db0 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseGitRepositoryConfig.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsegitrepositoryconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseGitRepositoryConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseGitRepositoryConfig.md +--- + +# New-AzSynapseGitRepositoryConfig + +## SYNOPSIS +Creates Git repository configuration. + +## SYNTAX + +``` +New-AzSynapseGitRepositoryConfig -RepositoryType <String> [-HostName <String>] -AccountName <String> + [-ProjectName <String>] -RepositoryName <String> -CollaborationBranch <String> [-RootFolder <String>] + [-TenantId <Guid>] [-LastCommitId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This **New-AzSynapseGitRepositoryConfig** cmdlets creates a Git repository configuration which can be used in creating or updating a workspace. + +## EXAMPLES + +### Example 1 +```powershell +$config = New-AzSynapseGitRepositoryConfig -RepositoryType GitHub -AccountName ContosoAccount -RepositoryName ContosoRepo -CollaborationBranch main +$password = ConvertTo-SecureString "Password123!" -AsPlainText -Force +$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password) +New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -AsJob -GitRepository $config +``` + +The first command creates a Git repository configuration. Then the rest methods uses the configuration to creates a new Synapse workspace. + +## PARAMETERS + +### -AccountName +GitHub or DevOps account name used for the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CollaborationBranch +Select the branch name where you will collaborate with others and from which you will publish. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +GitHub Enterprise host name. +For example: `https://github.mydomain.com` + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastCommitId +The last published commit Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The project name you are connecting, only specify it when you choose DevOps. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryName +The name of the repository you are connecting. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryType +Select the repository type that you want to use to store your artifacts for this Synapse Analytics workspace, the type include DevOps and GitHub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: GitHub, AzureDevOpsGit + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RootFolder +Displays the name of the folder to the location of your Azure Data Factory JSON resources are imported. +The default value is / + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +Select the tenant Id to use when signing in into the Azure DevOps Git repository. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSWorkspaceRepositoryConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseIntegrationRuntimeKey.md b/azps-10.1.0/Az.Synapse/New-AzSynapseIntegrationRuntimeKey.md new file mode 100644 index 0000000000..b36dad3839 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseIntegrationRuntimeKey.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapseintegrationruntimekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseIntegrationRuntimeKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseIntegrationRuntimeKey.md +--- + +# New-AzSynapseIntegrationRuntimeKey + +## SYNOPSIS +Regenerate self-hosted integration runtime key. + +## SYNTAX + +### NewByNameParameterSet (Default) +``` +New-AzSynapseIntegrationRuntimeKey [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + -KeyName <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### NewByParentObjectParameterSet +``` +New-AzSynapseIntegrationRuntimeKey -Name <String> -WorkspaceObject <PSSynapseWorkspace> -KeyName <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewByResourceIdParameterSet +``` +New-AzSynapseIntegrationRuntimeKey -ResourceId <String> -KeyName <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewByInputObjectParameterSet +``` +New-AzSynapseIntegrationRuntimeKey -InputObject <PSIntegrationRuntime> -KeyName <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The cmdlet **New-AzSynapseIntegrationRuntimeKey** regenerates the integration runtime key with the key name specified by 'KeyName' parameter. The previous key will is invalid. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSynapseIntegrationRuntimeKey -WorkspaceName ContosoWorkspace -Name 'test-selfhost-ir' -KeyName authKey2 +``` + +The cmdlet regenerates key 'authKey2' for integration runtime named 'test-selfhost-ir'. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: NewByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +The authentication key name of the self-hosted integration runtime. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AuthKey1, AuthKey2 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: NewByNameParameterSet, NewByParentObjectParameterSet +Aliases: IntegrationRuntimeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: NewByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: NewByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: NewByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: NewByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntimeKeys + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseKqlScript.md b/azps-10.1.0/Az.Synapse/New-AzSynapseKqlScript.md new file mode 100644 index 0000000000..76efbc0382 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseKqlScript.md @@ -0,0 +1,236 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsekqlscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKqlScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKqlScript.md +--- + +# New-AzSynapseKqlScript + +## SYNOPSIS +Creates or updates a KQL script in a workspace. + +## SYNTAX + +### SetByName (Default) +``` +New-AzSynapseKqlScript -WorkspaceName <String> [-Name <String>] -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByNameAndKustoPoolDatabase +``` +New-AzSynapseKqlScript -WorkspaceName <String> [-Name <String>] -KustoPoolName <String> + -KustoPoolDatabaseName <String> -DefinitionFile <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByObject +``` +New-AzSynapseKqlScript -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByObjectAndKustoPoolDatabase +``` +New-AzSynapseKqlScript -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] -KustoPoolName <String> + -KustoPoolDatabaseName <String> -DefinitionFile <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSynapseKqlScript** cmdlet creates or updates a KQL script in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -DefinitionFile "C:\samples\KqlScript.kql" +``` + +This command creates or updates a KQL script from Kusto query file KqlScript.kql in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | New-AzSynapseKqlScript -DefinitionFile "C:\samples\KqlScript.kql" +``` + +This command creates or updates a KQL script from Kusto query file KqlScript.kql in the workspace named ContosoWorkspace through pipeline. + +### Example 3 +```powershell +New-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -DefinitionFile "C:\samples\KqlScript.kql" -KustoPoolName ContosoKustoPool -KustoPoolDatabaseName ContosoKustoPoolDatabase +``` + +This command creates or updates a KqlScript from Kusto query file KqlScript.kql which attaches to ContosoKustoPoolDatabase in the workspace named ContosoWorkspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The KQL file path. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolDatabaseName +Name of Synapse Kusto database. + +```yaml +Type: String +Parameter Sets: SetByNameAndKustoPoolDatabase, SetByObjectAndKustoPoolDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +Name of Synapse Kusto pool. + +```yaml +Type: String +Parameter Sets: SetByNameAndKustoPoolDatabase, SetByObjectAndKustoPoolDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +KQL script name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: KqlScriptName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: String +Parameter Sets: SetByName, SetByNameAndKustoPoolDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: PSSynapseWorkspace +Parameter Sets: SetByObject, SetByObjectAndKustoPoolDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSKqlScriptResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPool.md b/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPool.md new file mode 100644 index 0000000000..255e1feee1 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPool.md @@ -0,0 +1,394 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsekustopool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKustoPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKustoPool.md +--- + +# New-AzSynapseKustoPool + +## SYNOPSIS +Create or update a Kusto pool. + +## SYNTAX + +``` +New-AzSynapseKustoPool -Name <String> -ResourceGroupName <String> -WorkspaceName <String> -Location <String> + -SkuName <SkuName> -SkuSize <SkuSize> [-SubscriptionId <String>] [-IfMatch <String>] [-IfNoneMatch <String>] + [-EnablePurge] [-EnableStreamingIngest] [-OptimizedAutoscaleIsEnabled] [-OptimizedAutoscaleMaximum <Int32>] + [-OptimizedAutoscaleMinimum <Int32>] [-OptimizedAutoscaleVersion <Int32>] [-SkuCapacity <Int32>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a Kusto pool. + +## EXAMPLES + +### Example 1: Create a new Kusto pool +```powershell +New-AzSynapseKustoPool -ResourceGroupName testrg -WorkspaceName testws -Name testnewkustopool -Location 'East US' -SkuName "Storage optimized" -SkuSize Medium +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +East US 2 testws/testnewkustopool Microsoft.Synapse/workspaces/kustoPools +``` + +The above command creates a new Kusto pool named "testnewkustopool" in the workspace "testws". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePurge +A boolean value that indicates if the purge operations are enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableStreamingIngest +A boolean value that indicates if the streaming ingest is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the Kusto Pool. +Omit this value to always overwrite the current Kusto Pool. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfNoneMatch +Set to '*' to allow a new Kusto Pool to be created, but to prevent updating an existing Kusto Pool. +Other values will result in a 412 Pre-condition Failed response. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: KustoPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleIsEnabled +A boolean value that indicate if the optimized autoscale feature is enabled or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleMaximum +Maximum allowed instances count. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleMinimum +Minimum allowed instances count. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleVersion +The version of the template defined, for instance 1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +The number of instances of the cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +SKU name. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +SKU size. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.SkuSize +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IKustoPool + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md b/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md new file mode 100644 index 0000000000..dc0bd463ff --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md @@ -0,0 +1,367 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsekustopoolattacheddatabaseconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md +--- + +# New-AzSynapseKustoPoolAttachedDatabaseConfiguration + +## SYNOPSIS +Creates or updates an attached database configuration. + +## SYNTAX + +``` +New-AzSynapseKustoPoolAttachedDatabaseConfiguration -AttachedDatabaseConfigurationName <String> + -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String>] + [-DatabaseName <String>] [-DefaultPrincipalsModificationKind <DefaultPrincipalsModificationKind>] + [-KustoPoolResourceId <String>] [-Location <String>] + [-TableLevelSharingPropertyExternalTablesToExclude <String[]>] + [-TableLevelSharingPropertyExternalTablesToInclude <String[]>] + [-TableLevelSharingPropertyMaterializedViewsToExclude <String[]>] + [-TableLevelSharingPropertyMaterializedViewsToInclude <String[]>] + [-TableLevelSharingPropertyTablesToExclude <String[]>] [-TableLevelSharingPropertyTablesToInclude <String[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates an attached database configuration. + +## EXAMPLES + +### Example 1: Create a new AttachedDatabaseConfiguration +```powershell +New-AzSynapseKustoPoolAttachedDatabaseConfiguration -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testfollowerkustopool -Name followerconfiguration -KustoPoolResourceId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Synapse/workspaces/testws/kustoPools/testkustopool -DatabaseName testdatabase -DefaultPrincipalsModificationKind Union -Location eastus2 +``` + +```output +Name Type Location +---- ---- -------- +testws/testfollowerkustopool/followerconfiguration Microsoft.Synapse/workspaces/kustoPools/AttachedDatabaseConfigurations East US 2 +``` + +The above command creates a ReadOnly database "testdatabase" in cluster "testfollowerkustopool". +It follows the database "testdatabase" from cluster "testkustopool" + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachedDatabaseConfigurationName +The name of the attached database configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database which you would like to attach, use * if you want to follow all current and future databases. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultPrincipalsModificationKind +The default principals modification kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.DefaultPrincipalsModificationKind +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolResourceId +The resource id of the kusto pool where the databases you would like to attach reside. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyExternalTablesToExclude +List of external tables exclude from the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyExternalTablesToInclude +List of external tables to include in the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyMaterializedViewsToExclude +List of materialized views exclude from the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyMaterializedViewsToInclude +List of materialized views to include in the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyTablesToExclude +List of tables to exclude from the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyTablesToInclude +List of tables to include in the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IAttachedDatabaseConfiguration + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolDataConnection.md b/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolDataConnection.md new file mode 100644 index 0000000000..cfaf768eea --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolDataConnection.md @@ -0,0 +1,509 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsekustopooldataconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDataConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDataConnection.md +--- + +# New-AzSynapseKustoPoolDataConnection + +## SYNOPSIS +Creates or updates a data connection. + +## SYNTAX + +### CreateExpandedEventHub (Default) +``` +New-AzSynapseKustoPoolDataConnection -DatabaseName <String> -DataConnectionName <String> + -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> -ConsumerGroup <String> + -EventHubResourceId <String> -Kind <DataConnectionKind> -Location <String> [-SubscriptionId <String>] + [-Compression <Compression>] [-DataFormat <EventGridDataFormat>] [-EventSystemProperty <String[]>] + [-MappingRuleName <String>] [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### CreateExpandedEventGrid +``` +New-AzSynapseKustoPoolDataConnection -DatabaseName <String> -DataConnectionName <String> + -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> -ConsumerGroup <String> + -EventHubResourceId <String> -Kind <DataConnectionKind> -Location <String> -StorageAccountResourceId <String> + [-SubscriptionId <String>] [-DataFormat <EventGridDataFormat>] [-MappingRuleName <String>] + [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### CreateExpandedIotHub +``` +New-AzSynapseKustoPoolDataConnection -DatabaseName <String> -DataConnectionName <String> + -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> -ConsumerGroup <String> + -IotHubResourceId <String> -Kind <DataConnectionKind> -Location <String> -SharedAccessPolicyName <String> + [-SubscriptionId <String>] [-DataFormat <EventGridDataFormat>] [-EventSystemProperty <String[]>] + [-MappingRuleName <String>] [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateExpandedEventGrid +``` +New-AzSynapseKustoPoolDataConnection -DatabaseName <String> -DataConnectionName <String> + -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> -ConsumerGroup <String> + -Kind <DataConnectionKind> -Location <String> [-SubscriptionId <String>] + [-BlobStorageEventType <BlobStorageEventType>] [-DataFormat <EventGridDataFormat>] [-IgnoreFirstRecord] + [-MappingRuleName <String>] [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpandedEventGrid +``` +New-AzSynapseKustoPoolDataConnection -DatabaseName <String> -DataConnectionName <String> + -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> -ConsumerGroup <String> + -Kind <DataConnectionKind> -Location <String> [-SubscriptionId <String>] + [-BlobStorageEventType <BlobStorageEventType>] [-DataFormat <EventGridDataFormat>] [-IgnoreFirstRecord] + [-MappingRuleName <String>] [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a data connection. + +## EXAMPLES + +### Example 1: Create a new EventHub data connection +```powershell +New-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventhubdc -Location eastus2 -Kind EventHub -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -DataFormat "JSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "EventsMapping" +``` + +```output +Kind Location Name +---- -------- ---- +EventHub East US 2 testws/testkustopool/testdatabase/eventhubdc +``` + +The above command creates a new EventHub data connection named "eventhubdc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 2: Create a new EventGrid data connection +```powershell +New-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventgriddc -Location eastus2 -Kind EventGrid -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/teststorage" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" +``` + +```output +Kind Location Name +---- -------- ---- +EventGrid East US 2 testws/testkustopool/testdatabase/eventgriddc +``` + +The above command creates a new EventGrid data connection named "eventgriddc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 3: Create a new IotHub data connection +```powershell +New-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name iothubdc -Location eastus2 -Kind IotHub -IotHubResourceId "/subscriptions/051ddeca-1ed6-4d8b-ba6f-1ff561e5f3b3/resourceGroups/ywtest/providers/Microsoft.Devices/IotHubs/ywtestiothub" -SharedAccessPolicyName registryRead -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" +``` + +```output +Kind Location Name +---- -------- ---- +IotHub East US 2 testws/testkustopool/testdatabase/iothubdc +``` + +The above command creates a new IotHub data connection named "iothubdc" for the database "testdatabase" in the kusto pool "testkustopool". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobStorageEventType +The name of blob storage event type to process. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.BlobStorageEventType +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compression +The event hub messages compression type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.Compression +Parameter Sets: CreateExpandedEventHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsumerGroup +The event/iot hub consumer group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataConnectionName +The name of the data connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFormat +The data format of the message. +Optionally the data format can be added to each message. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.EventGridDataFormat +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubResourceId +The resource ID of the event hub to be used to create a data connection / event grid is configured to send events. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedEventGrid, CreateExpandedEventHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSystemProperty +System properties of the event/iot hub. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpandedEventHub, CreateExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreFirstRecord +If set to true, indicates that ingestion should ignore the first record of every file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHubResourceId +The resource ID of the Iot hub to be used to create a data connection. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the endpoint for the data connection + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.DataConnectionKind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MappingRuleName +The mapping rule to be used to ingest the data. +Optionally the mapping information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedAccessPolicyName +The name of the share access policy. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The resource ID of the storage account where the data resides. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedEventGrid +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableName +The table where the data should be ingested. +Optionally the table information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDataConnection + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDataConnection + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolDatabase.md b/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolDatabase.md new file mode 100644 index 0000000000..daa9985f0d --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolDatabase.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsekustopooldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDatabase.md +--- + +# New-AzSynapseKustoPoolDatabase + +## SYNOPSIS +Creates or updates a database. + +## SYNTAX + +``` +New-AzSynapseKustoPoolDatabase -DatabaseName <String> -KustoPoolName <String> -ResourceGroupName <String> + -WorkspaceName <String> -Kind <Kind> [-SubscriptionId <String>] [-HotCachePeriod <TimeSpan>] + [-Location <String>] [-SoftDeletePeriod <TimeSpan>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates or updates a database. + +## EXAMPLES + +### Example 1: Creates or updates a new kusto database in a workspace +```powershell +New-AzSynapseKustoPoolDatabase -ResourceGroupName "testrg" -WorkspaceName "testws" -KustoPoolName "testkustopool" -DatabaseName "mykustodatabase" -Kind "ReadWrite" -Location "East US 2" +``` + +```output +Kind Location Name +---- -------- ---- +ReadWrite East US 2 testws/testkustopool/mykustodatabase +``` + +Creates or updates a kusto database "mykustodatabase" in Kusto Pool "testkustopool" in the workspace "testws" found in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HotCachePeriod +The time the data should be kept in cache for fast queries in TimeSpan. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the database + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletePeriod +The time the data should be kept before it stops being accessible to queries in TimeSpan. + +```yaml +Type: System.TimeSpan +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDatabase + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolDatabasePrincipalAssignment.md b/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolDatabasePrincipalAssignment.md new file mode 100644 index 0000000000..265711e396 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolDatabasePrincipalAssignment.md @@ -0,0 +1,287 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsekustopooldatabaseprincipalassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDatabasePrincipalAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDatabasePrincipalAssignment.md +--- + +# New-AzSynapseKustoPoolDatabasePrincipalAssignment + +## SYNOPSIS +Creates a Kusto pool database principalAssignment. + +## SYNTAX + +``` +New-AzSynapseKustoPoolDatabasePrincipalAssignment -DatabaseName <String> -KustoPoolName <String> + -PrincipalAssignmentName <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-PrincipalId <String>] [-PrincipalType <PrincipalType>] + [-Role <DatabasePrincipalRole>] [-TenantId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a Kusto pool database principalAssignment. + +## EXAMPLES + +### Example 1: Create a Kusto pool database principalAssignment +```powershell +New-AzSynapseKustoPoolDatabasePrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -PrincipalAssignmentName kustoprincipal -PrincipalId 00000000-0000-0000-0000-000000000000 -PrincipalType App -Role Viewer +``` + +```output +Name Type +---- ---- +testws/testkustopool/testdatabase/kustoprincipal Microsoft.Synapse/workspaces/kustoPools/Databases/PrincipalAssignments +``` + +The above command creates a Kusto pool database principalAssignment + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalId +The principal ID assigned to the database principal. +It can be a user email, application ID, or security group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalType +Principal type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.PrincipalType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +Database principal role. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.DatabasePrincipalRole +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +The tenant id of the principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDatabasePrincipalAssignment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolPrincipalAssignment.md b/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolPrincipalAssignment.md new file mode 100644 index 0000000000..fbd0dc5e03 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseKustoPoolPrincipalAssignment.md @@ -0,0 +1,271 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsekustopoolprincipalassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKustoPoolPrincipalAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseKustoPoolPrincipalAssignment.md +--- + +# New-AzSynapseKustoPoolPrincipalAssignment + +## SYNOPSIS +Create a Kusto pool principalAssignment. + +## SYNTAX + +``` +New-AzSynapseKustoPoolPrincipalAssignment -KustoPoolName <String> -PrincipalAssignmentName <String> + -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String>] [-PrincipalId <String>] + [-PrincipalType <PrincipalType>] [-Role <ClusterPrincipalRole>] [-TenantId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a Kusto pool principalAssignment. + +## EXAMPLES + +### Example 1: Create a Kusto pool principalAssignment +```powershell +New-AzSynapseKustoPoolPrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testnewkustopool -PrincipalAssignmentName kustoprincipal -PrincipalId "00000000-0000-0000-0000-000000000000" -PrincipalType App -Role AllDatabasesAdmin +``` + +```output +Name Type +---- ---- +testws/testnewkustopool/kustoprincipal Microsoft.Synapse/workspaces/kustoPools/PrincipalAssignments +``` + +The above command creates a Kusto pool principalAssignment + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalId +The principal ID assigned to the cluster principal. +It can be a user email, application ID, or security group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalType +Principal type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.PrincipalType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +Cluster principal role. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.ClusterPrincipalRole +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +The tenant id of the principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IClusterPrincipalAssignment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseLinkedServiceEncryptedCredential.md b/azps-10.1.0/Az.Synapse/New-AzSynapseLinkedServiceEncryptedCredential.md new file mode 100644 index 0000000000..6cdbe49057 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseLinkedServiceEncryptedCredential.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapselinkedserviceencryptedcredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseLinkedServiceEncryptedCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseLinkedServiceEncryptedCredential.md +--- + +# New-AzSynapseLinkedServiceEncryptedCredential + +## SYNOPSIS +Encrypt credential in linked service with specified integration runtime. + +## SYNTAX + +### CreateByName (Default) +``` +New-AzSynapseLinkedServiceEncryptedCredential [-ResourceGroupName <String>] -WorkspaceName <String> + -IntegrationRuntimeName <String> -DefinitionFile <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByObject +``` +New-AzSynapseLinkedServiceEncryptedCredential -WorkspaceObject <PSSynapseWorkspace> + -IntegrationRuntimeName <String> -DefinitionFile <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The New-AzSynapseLinkedServiceEncryptedCredential cmdlet encrypt credential in linked service with specified integration runtime. + +Please ensure the following prerequisites are met: +* **Remote access** option is enabled on the self-hosted integration runtime. +* Powershell 7.0 or higher is used to execute the cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSynapseLinkedServiceEncryptedCredential -WorkspaceName ContosoWorkspace -ResourceGroupName ContosoRG -IntegrationRuntimeName "IR-LSEncryptedCredential" -DefinitionFile "D:\sqlLinkService.json" > "D:\SynapseEncryptedSQLServerLinkedService.json" +``` + +This command encrypts credential in file D:\SynapseEncryptedSQLServerLinkedService.json with the integration runtime named IR-LSEncryptedCredential. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | New-AzSynapseLinkedServiceEncryptedCredential -IntegrationRuntimeName "IR-LSEncryptedCredential" -DefinitionFile "D:\sqlLinkService.json" > "D:\SynapseEncryptedSQLServerLinkedService.json" +``` + +This command encrypts credential in file D:\SynapseEncryptedSQLServerLinkedService.json with the integration runtime named IR-LSEncryptedCredential through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntegrationRuntimeName +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: CreateByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: CreateByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: CreateByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseManagedPrivateEndpoint.md b/azps-10.1.0/Az.Synapse/New-AzSynapseManagedPrivateEndpoint.md new file mode 100644 index 0000000000..6b11a1468a --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseManagedPrivateEndpoint.md @@ -0,0 +1,212 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsemanagedprivateendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseManagedPrivateEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseManagedPrivateEndpoint.md +--- + +# New-AzSynapseManagedPrivateEndpoint + +## SYNOPSIS +Creates or updates a managed private endpoint in a workspace. + +## SYNTAX + +### SetByName (Default) +``` +New-AzSynapseManagedPrivateEndpoint -WorkspaceName <String> -Name <String> [-VirtualNetworkName <String>] + -DefinitionFile <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByObject +``` +New-AzSynapseManagedPrivateEndpoint -WorkspaceObject <PSSynapseWorkspace> -Name <String> + [-VirtualNetworkName <String>] -DefinitionFile <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSynapseManagedPrivateEndpoint** cmdlet creates or updates a managed private endpoint in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +<# +endpoint.json +{ + "name": "ContosoManagedPrivateEndpoint", + "properties": { + "privateLinkResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/contosoResourceGroup/providers/Microsoft.Storage/storageAccounts/contosoStorageAccount", + "groupId": "file" + } +} +#> +New-AzSynapseManagedPrivateEndpoint -WorkspaceName ContosoWorkspace -Name ContosoManagedPrivateEndpoint -DefinitionFile "C:\\endpoint.json" +``` + +This command creates or updates a managed private endpoint from json file in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | New-AzSynapseManagedPrivateEndpoint -Name ContosoManagedPrivateEndpoint -DefinitionFile "C:\\endpoint.json" +``` + +This command creates or updates a managed private endpoint from json file in the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Synapse Managed Private Endpoint Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ManagedPrivateEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkName +Managed Virtual Network Name is default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VNetName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSManagedPrivateEndpointResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseManagedVirtualNetworkConfig.md b/azps-10.1.0/Az.Synapse/New-AzSynapseManagedVirtualNetworkConfig.md new file mode 100644 index 0000000000..4e5197bb70 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseManagedVirtualNetworkConfig.md @@ -0,0 +1,97 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsemanagedvirtualnetworkconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseManagedVirtualNetworkConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseManagedVirtualNetworkConfig.md +--- + +# New-AzSynapseManagedVirtualNetworkConfig + +## SYNOPSIS +Creates managed virtual network configuration. + +## SYNTAX + +``` +New-AzSynapseManagedVirtualNetworkConfig [-PreventDataExfiltration] [-AllowedAadTenantIdsForLinking <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +This **New-AzSynapseManagedVirtualNetworkConfig** cmdlets creates a managed virtual network configuration. + +## EXAMPLES + +### Example 1 +```powershell +$config = New-AzSynapseManagedVirtualNetworkConfig -PreventDataExfiltration -AllowedAadTenantIdsForLinking ContosoTenantId +$password = ConvertTo-SecureString "Password123!" -AsPlainText -Force +$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password) +New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -ManagedVirtualNetwork $config +``` + +The first command creates a managed virtual network configuration. Then the rest methods uses the configuration to creates a new Synapse workspace. + +## PARAMETERS + +### -AllowedAadTenantIdsForLinking +The allowed AAD tenant IDs for linking. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreventDataExfiltration +Indicates whether to prevent data exfiltration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSManagedVirtualNetworkSettings + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseRoleAssignment.md b/azps-10.1.0/Az.Synapse/New-AzSynapseRoleAssignment.md new file mode 100644 index 0000000000..c305e0f902 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseRoleAssignment.md @@ -0,0 +1,337 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapseroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseRoleAssignment.md +--- + +# New-AzSynapseRoleAssignment + +## SYNOPSIS +Creates a Synapse Analytics role assignment. + + +## SYNTAX + +### NewByWorkspaceNameAndNameParameterSet (Default) +``` +New-AzSynapseRoleAssignment -WorkspaceName <String> -RoleDefinitionName <String> -SignInName <String> + [-ItemType <WorkspaceItemType>] [-Item <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### NewByWorkspaceNameAndIdParameterSet +``` +New-AzSynapseRoleAssignment -WorkspaceName <String> -RoleDefinitionName <String> -ObjectId <String> + [-ItemType <WorkspaceItemType>] [-Item <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### NewByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet +``` +New-AzSynapseRoleAssignment -WorkspaceName <String> -RoleDefinitionId <String> -ObjectId <String> + [-ItemType <WorkspaceItemType>] [-Item <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### NewByWorkspaceNameAndServicePrincipalNameParameterSet +``` +New-AzSynapseRoleAssignment -WorkspaceName <String> -RoleDefinitionName <String> -ServicePrincipalName <String> + [-ItemType <WorkspaceItemType>] [-Item <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### NewByWorkspaceObjectAndNameParameterSet +``` +New-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> -RoleDefinitionName <String> + -SignInName <String> [-ItemType <WorkspaceItemType>] [-Item <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewByWorkspaceObjectAndIdParameterSet +``` +New-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> -RoleDefinitionName <String> + -ObjectId <String> [-ItemType <WorkspaceItemType>] [-Item <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### NewByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet +``` +New-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> -RoleDefinitionId <String> -ObjectId <String> + [-ItemType <WorkspaceItemType>] [-Item <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### NewByWorkspaceObjectAndServicePrincipalNameParameterSet +``` +New-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> -RoleDefinitionName <String> + -ServicePrincipalName <String> [-ItemType <WorkspaceItemType>] [-Item <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSynapseRoleAssignment** cmdlet creates an Azure Synapse Analytics role assignment. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +* GET /users/{id} +* GET /servicePrincipals/{id} + +>[!Note] +> To create a role assignment for a service principal, pass the object ID of the principal in the ObjectId parameter. +> When you are a user with permission to manage Azure RBAC role assignment on the workspace but not a Synapse Administrator, please create Synapse Administrator role by **-RoleDefinitionId** and **-ObjectId** directly but not by **-RoleDefinitionName**, for Synapse Administrator, RoleDefinitionId is "6e4bf58a-b8e1-4cc3-bbf9-d73143322b78", please take below Example 5 as reference. The reason for this is , when you try to add a "Synapse Administrator" role, the cmdlet needs to get the role ID from the role name which requires workspace read permission, which the current user does not have. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName +``` + +This command assigns ContosoRole to the user whose principal name is ContosoName. + +### Example 2 +```powershell +New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType -Item ContosoItem +``` + +This command assigns ContosoRole to the user whose principal name is ContosoName and item type is ContosoItemType, item is ContosoItem. + +### Example 3 +```powershell +New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType -Item ContosoItem +``` + +This command assigns ContosoRole to the user whose principal name is ContosoName and item type is ContosoItemType, item is ContosoItem. + +### Example 4 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | New-AzSynapseRoleAssignment -RoleDefinitionName ContosoRole -SignInName ContosoName +``` + +This command assigns ContosoRole to the user whose principal name is ContosoName through pipeline. + +### Example 5 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | New-AzSynapseRoleAssignment -RoleDefinitionId "6e4bf58a-b8e1-4cc3-bbf9-d73143322b78" -ObjectId ContosoObjectId +``` + +This command assigns Synapse Administrator role to the user whose object Id is ContosoObjectId through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Item +The workspace item. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemType +The workspace item type. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+WorkspaceItemType +Parameter Sets: (All) +Aliases: +Accepted values: ApacheSparkPool, IntegrationRuntime, LinkedService, Credential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The Azure AD ObjectId of the User, Group or Service Principal. + +```yaml +Type: System.String +Parameter Sets: NewByWorkspaceNameAndIdParameterSet, NewByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet, NewByWorkspaceObjectAndIdParameterSet, NewByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet +Aliases: Id, PrincipalId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +Id of the Role that is assigned to the principal. + +```yaml +Type: System.String +Parameter Sets: NewByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet, NewByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionName +Name of the Role that is assigned to the principal. + +```yaml +Type: System.String +Parameter Sets: NewByWorkspaceNameAndNameParameterSet, NewByWorkspaceNameAndIdParameterSet, NewByWorkspaceNameAndServicePrincipalNameParameterSet, NewByWorkspaceObjectAndNameParameterSet, NewByWorkspaceObjectAndIdParameterSet, NewByWorkspaceObjectAndServicePrincipalNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalName +The ServicePrincipalName of the service principal. + +```yaml +Type: System.String +Parameter Sets: NewByWorkspaceNameAndServicePrincipalNameParameterSet, NewByWorkspaceObjectAndServicePrincipalNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignInName +The email address or the user principal name of the user. + +```yaml +Type: System.String +Parameter Sets: NewByWorkspaceNameAndNameParameterSet, NewByWorkspaceObjectAndNameParameterSet +Aliases: Email, UserPrincipalName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: NewByWorkspaceNameAndNameParameterSet, NewByWorkspaceNameAndIdParameterSet, NewByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet, NewByWorkspaceNameAndServicePrincipalNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: NewByWorkspaceObjectAndNameParameterSet, NewByWorkspaceObjectAndIdParameterSet, NewByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet, NewByWorkspaceObjectAndServicePrincipalNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSRoleAssignmentDetails + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseSparkConfiguration.md b/azps-10.1.0/Az.Synapse/New-AzSynapseSparkConfiguration.md new file mode 100644 index 0000000000..f9f2adfc2c --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseSparkConfiguration.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsesparkconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseSparkConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseSparkConfiguration.md +--- + +# New-AzSynapseSparkConfiguration + +## SYNOPSIS +Creates or updates a spark configuration in a workspace. + +## SYNTAX + +### CreateByName (Default) +``` +New-AzSynapseSparkConfiguration -WorkspaceName <String> [-Name <String>] -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByObject +``` +New-AzSynapseSparkConfiguration -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] -DefinitionFile <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSynapseSparkConfiguration** cmdlet creates or updates a spark configuration in a workspace. +If you specify the name of a spark configuration, the new spark configuration will be named as the specified one, if you don't specify the name, the new spark configuration will be the same name as the definition file. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\sparkconfiguration.json" +``` + +This command creates or updates a spark configuration from file sparkconfiguration.json in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +New-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -Name ContosoSparkConfiguration -DefinitionFile "C:\\samples\\sparkconfiguration.json" +``` + +This command creates or updates a spark configuration named ContosoSparkConfiguration from file sparkconfiguration.json in the workspace named ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | New-AzSynapseSparkConfiguration -DefinitionFile "C:\\samples\\sparkconfiguration.json" +``` + +This command creates or updates a spark configuration from file sparkconfiguration.json in the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Spark Configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SparkConfigurationName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: CreateByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: CreateByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSparkConfigurationResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseSparkPool.md b/azps-10.1.0/Az.Synapse/New-AzSynapseSparkPool.md new file mode 100644 index 0000000000..6e82d81e5e --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseSparkPool.md @@ -0,0 +1,449 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsesparkpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseSparkPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseSparkPool.md +--- + +# New-AzSynapseSparkPool + +## SYNOPSIS +Creates a Synapse Analytics Spark pool. + +## SYNTAX + +### CreateByNameAndEnableAutoScaleParameterSet (Default) +``` +New-AzSynapseSparkPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-Tag <Hashtable>] + [-EnableIsolatedCompute] -NodeSize <String> -AutoScaleMinNodeCount <Int32> -AutoScaleMaxNodeCount <Int32> + [-EnableAutoPause] [-AutoPauseDelayInMinute <Int32>] [-EnableDynamicExecutorAllocation] + [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>] -SparkVersion <String> + [-SparkConfiguration <PSSparkConfigurationResource>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByNameAndDisableAutoScaleParameterSet +``` +New-AzSynapseSparkPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-Tag <Hashtable>] + -NodeCount <Int32> [-EnableIsolatedCompute] -NodeSize <String> [-EnableAutoPause] + [-AutoPauseDelayInMinute <Int32>] [-EnableDynamicExecutorAllocation] [-MinExecutorCount <Int32>] + [-MaxExecutorCount <Int32>] -SparkVersion <String> [-SparkConfiguration <PSSparkConfigurationResource>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByParentObjectAndEnableAutoScaleParameterSet +``` +New-AzSynapseSparkPool -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-Tag <Hashtable>] + [-EnableIsolatedCompute] -NodeSize <String> -AutoScaleMinNodeCount <Int32> -AutoScaleMaxNodeCount <Int32> + [-EnableAutoPause] [-AutoPauseDelayInMinute <Int32>] [-EnableDynamicExecutorAllocation] + [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>] -SparkVersion <String> + [-SparkConfiguration <PSSparkConfigurationResource>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByParentObjectAndDisableAutoScaleParameterSet +``` +New-AzSynapseSparkPool -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-Tag <Hashtable>] + -NodeCount <Int32> [-EnableIsolatedCompute] -NodeSize <String> [-EnableAutoPause] + [-AutoPauseDelayInMinute <Int32>] [-EnableDynamicExecutorAllocation] [-MinExecutorCount <Int32>] + [-MaxExecutorCount <Int32>] -SparkVersion <String> [-SparkConfiguration <PSSparkConfigurationResource>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSynapseSparkPool** cmdlet creates an Azure Synapse Analytics Spark pool. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -NodeCount 3 -SparkVersion 2.4 -NodeSize Small +``` + +This command creates an Azure Synapse Analytics Spark pool. + +### Example 2 +```powershell +New-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -AutoScaleMinNodeCount 3 -AutoScaleMaxNodeCount 10 -SparkVersion 2.4 -NodeSize Small +``` + +This command creates an Azure Synapse Analytics Spark pool with auto-scale enabled. + +### Example 3 +```powershell +New-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -EnableDynamicExecutorAllocation -MinExecutorCount 1 -MaxExecutorCount 4 -NodeCount 10 -SparkVersion 2.4 -NodeSize Small +``` + +This command creates an Azure Synapse Analytics Spark pool with dynamic executor allocation enabled and specify min executor count and max executor count. + +### Example 4 +```powershell +$config = Get-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -Name ContosoSparkConfig1 +New-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -NodeCount 3 -SparkVersion 2.4 -NodeSize Small -SparkConfiguration $config +``` + +This command creates an Azure Synapse Analytics Spark pool and specify a Spark configuration for Spark pool. + +### Example 5 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | New-AzSynapseSparkPool -Name ContosoSparkPool -NodeCount 3 -SparkVersion 2.4 -NodeSize Small +``` + +This command creates an Azure Synapse Analytics Spark pool through pipeline. + +### Example 6 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | New-AzSynapseSparkPool -Name ContosoSparkPool -AutoScaleMinNodeCount 3 -AutoScaleMaxNodeCount 10 -SparkVersion 2.4 -NodeSize Small +``` + +This command creates an Azure Synapse Analytics Spark pool with auto-scale enabled through pipeline. + +### Example 7 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | New-AzSynapseSparkPool -Name ContosoSparkPool -EnableIsolatedCompute -NodeSize XXXLarge -NodeCount 3 -SparkVersion 2.4 +``` + +This command creates an Azure Synapse Analytics Spark pool with isolated compute enabled through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoPauseDelayInMinute +Number of minutes idle. This parameter can be specified when Auto-pause is enabled. The default value will be [15] if it is not specified manually. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoScaleMaxNodeCount +Maximum number of nodes to be allocated in the specified Spark pool. +This parameter must be specified when Auto-scale is enabled. + +```yaml +Type: System.Int32 +Parameter Sets: CreateByNameAndEnableAutoScaleParameterSet, CreateByParentObjectAndEnableAutoScaleParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoScaleMinNodeCount +Minimum number of nodes to be allocated in the specified Spark pool. +This parameter must be specified when Auto-scale is enabled. + +```yaml +Type: System.Int32 +Parameter Sets: CreateByNameAndEnableAutoScaleParameterSet, CreateByParentObjectAndEnableAutoScaleParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoPause +Indicates whether Auto-pause should be enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDynamicExecutorAllocation +Indicates whether dynamic executor allocation should be enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableIsolatedCompute +The Isolate Compute option is only available with the XXXLarge (80 vCPU / 504 GB) node size. Enabling this option offers isolation for Apache Spark compute for untrusted services. Isolated compute costs the same as the non-isolated VM of the same size. If you expect to enable Isolated Compute for spark pool, ensure that your Synapse workspace is created in an isolated compute supported region, please refer to this document for more details: https://learn.microsoft.com/en-us/azure/synapse-analytics/spark/apache-spark-pool-configurations#isolated-compute. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxExecutorCount +Maximum number of executors to be allocated in the specified Spark pool. This parameter can be specified when DynamicExecutorAllocation is enabled. The value should lie between 1 (inclusive) and maximumNodeCount (exclusive). If it is not specified manually, the default value will be 2. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinExecutorCount +Minimum number of executors to be allocated in the specified Spark pool. This parameter can be specified when DynamicExecutorAllocation is enabled. The value should lie between 1 (inclusive) and maxExecutors (exclusive). If it is not specified manually, the default value will be 1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SparkPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeCount +Number of nodes to be allocated in the specified Spark pool. + +```yaml +Type: System.Int32 +Parameter Sets: CreateByNameAndDisableAutoScaleParameterSet, CreateByParentObjectAndDisableAutoScaleParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeSize +Number of core and memory to be used for nodes allocated in the specified Spark pool. +This parameter must be specified when Auto-scale is disabled + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Small, Medium, Large, XLarge, XXLarge, XXXLarge + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: CreateByNameAndEnableAutoScaleParameterSet, CreateByNameAndDisableAutoScaleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkConfiguration +Apache Spark configuration. When a job is submitted to the pool, the properties specified in the selected configuration will be referenced. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSparkConfigurationResource +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkVersion +Apache Spark version. +Allowed values: 2.4 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A string,string dictionary of tags associated with the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: CreateByNameAndEnableAutoScaleParameterSet, CreateByNameAndDisableAutoScaleParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: CreateByParentObjectAndEnableAutoScaleParameterSet, CreateByParentObjectAndDisableAutoScaleParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseSqlDatabase.md b/azps-10.1.0/Az.Synapse/New-AzSynapseSqlDatabase.md new file mode 100644 index 0000000000..4bce575eb3 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseSqlDatabase.md @@ -0,0 +1,210 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsesqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseSqlDatabase.md +--- + +# New-AzSynapseSqlDatabase + +## SYNOPSIS +This feature is in a limited preview, initially accessible only to certain subscriptions. Creates a Synapse Analytics SQL database. + +## SYNTAX + +### CreateByNameParameterSet (Default) +``` +New-AzSynapseSqlDatabase [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + [-Tag <Hashtable>] [-Collation <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### CreateByParentObjectParameterSet +``` +New-AzSynapseSqlDatabase -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-Tag <Hashtable>] + [-Collation <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzSynapseSqlDatabase** cmdlet gets information about an Azure Synapse Analytics SQL database. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSynapseSqlDatabase -WorkspaceName ContosoWorkspace -Name ContosoSqlDatabase +``` + +This command creates an Azure Synapse Analytics SQL database. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Collation +Collation defines the rules that sort and compare data, and cannot be changed after SQL pool creation. +The default collation is SQL_Latin1_General_CP1_CI_AS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A string,string dictionary of tags associated with the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: CreateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlDatabase + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseSqlPool.md b/azps-10.1.0/Az.Synapse/New-AzSynapseSqlPool.md new file mode 100644 index 0000000000..a0f7e167da --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseSqlPool.md @@ -0,0 +1,263 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsesqlpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseSqlPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseSqlPool.md +--- + +# New-AzSynapseSqlPool + +## SYNOPSIS +Creates a Synapse Analytics SQL pool. + +## SYNTAX + +### CreateByNameParameterSet (Default) +``` +New-AzSynapseSqlPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-Version <Int32>] + [-Tag <Hashtable>] -PerformanceLevel <String> [-Collation <String>] [-StorageAccountType <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByParentObjectParameterSet +``` +New-AzSynapseSqlPool -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-Version <Int32>] [-Tag <Hashtable>] + -PerformanceLevel <String> [-Collation <String>] [-StorageAccountType <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSynapseSqlPool** cmdlet creates an Azure Synapse Analytics SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -PerformanceLevel DW200c +``` + +This command creates an Azure Synapse Analytics SQL pool. + +### Example 2 +```powershell +New-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -PerformanceLevel DW200c -StorageAccountType LRS +``` + +This command creates an Azure Synapse Analytics SQL pool with specified storage account type. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Collation +Collation defines the rules that sort and compare data, and cannot be changed after SQL pool creation. +The default collation is SQL_Latin1_General_CP1_CI_AS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SqlPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PerformanceLevel +The SQL Service tier and performance level to assign to the SQL pool. +For example, DW2000c. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountType +The storage account type used to store backups for the sql pool. Possible values include: 'GRS', 'LRS'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A string,string dictionary of tags associated with the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version of Synapse SQL pool. For example, 2 or 3. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: CreateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseSqlPoolRestorePoint.md b/azps-10.1.0/Az.Synapse/New-AzSynapseSqlPoolRestorePoint.md new file mode 100644 index 0000000000..5462fd036b --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseSqlPoolRestorePoint.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapsesqlpoolrestorepoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseSqlPoolRestorePoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseSqlPoolRestorePoint.md +--- + +# New-AzSynapseSqlPoolRestorePoint + +## SYNOPSIS +Creates a new restore point in an Azure Synapse Analytics SQL pool. + +## SYNTAX + +### CreateByNameParameterSet (Default) +``` +New-AzSynapseSqlPoolRestorePoint [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + -RestorePointLabel <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CreateByParentObjectParameterSet +``` +New-AzSynapseSqlPoolRestorePoint -Name <String> -WorkspaceObject <PSSynapseWorkspace> + -RestorePointLabel <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CreateByInputObjectParameterSet +``` +New-AzSynapseSqlPoolRestorePoint -InputObject <PSSynapseSqlPool> -RestorePointLabel <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByResourceIdParameterSet +``` +New-AzSynapseSqlPoolRestorePoint -ResourceId <String> -RestorePointLabel <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSynapseSqlPoolRestorePoint** cmdlet creates a new restore point that an Azure Synapse Analytics SQL pool can be restored from. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSynapseSqlPoolRestorePoint -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -RestorePointLabel ContosoRestorePoint +``` + +This command creates a restore point for SQL pool called ContosoSqlPool in the workspace ContosoWorkspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: CreateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet, CreateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: CreateByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestorePointLabel +The label we associate a restore point with, may not be unique. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: CreateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSRestorePoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseWorkspace.md b/azps-10.1.0/Az.Synapse/New-AzSynapseWorkspace.md new file mode 100644 index 0000000000..fd86fcead0 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseWorkspace.md @@ -0,0 +1,432 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapseworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseWorkspace.md +--- + +# New-AzSynapseWorkspace + +## SYNOPSIS +Creates a Synapse Analytics workspace. + +## SYNTAX + +``` +New-AzSynapseWorkspace -ResourceGroupName <String> -Name <String> -Location <String> [-Tag <Hashtable>] + -DefaultDataLakeStorageAccountName <String> -DefaultDataLakeStorageFilesystem <String> + -SqlAdministratorLoginCredential <PSCredential> [-ManagedVirtualNetwork <PSManagedVirtualNetworkSettings>] + [-EncryptionKeyName <String>] [-EncryptionKeyIdentifier <String>] [-UserAssignedIdentityInEncryption <String>] + [-UseSystemAssignedIdentityInEncryption <Object>] [-AsJob] [-ManagedResourceGroupName <String>] + [-GitRepository <PSWorkspaceRepositoryConfiguration>] [-EnablePublicNetworkAccess <Boolean>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSynapseWorkspace** cmdlet creates an Azure Synapse Analytics workspace. + +## EXAMPLES + +### Example 1 +```powershell +$password = ConvertTo-SecureString "Password123!" -AsPlainText -Force +$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password) +New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds +``` + +This command creates a Synapse Analytics workspace named ContosoWorkspace that uses the ContosoAdlGenStorage Data Store, in the resource group named ContosoResourceGroup. + +### Example 2 +```powershell +$config = New-AzSynapseManagedVirtualNetworkConfig -PreventDataExfiltration -AllowedAadTenantIdsForLinking ContosoTenantId +$password = ConvertTo-SecureString "Password123!" -AsPlainText -Force +$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password) +New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -ManagedVirtualNetwork $config +``` + +The first command creates a managed virtual network configuration. Then the rest methods uses the configuration to creates a new Synapse workspace. + +### Example 3 +```powershell +$config = New-AzSynapseManagedVirtualNetworkConfig -PreventDataExfiltration -AllowedAadTenantIdsForLinking ContosoTenantId +$password = ConvertTo-SecureString "Password123!" -AsPlainText -Force +$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password) +New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -ManagedVirtualNetwork $config -EnablePublicNetworkAccess $True +``` + +The first command creates a managed virtual network configuration. Then the rest methods uses the configuration to creates a new Synapse workspace with enabled managed virtual network and enabled public network access. + +### Example 4 +```powershell +$password = ConvertTo-SecureString "Password123!" -AsPlainText -Force +$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password) +$config = New-AzSynapseGitRepositoryConfig -RepositoryType GitHub -AccountName ContosoAccount -RepositoryName ContosoRepo -CollaborationBranch main +New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -GitRepository $config +``` + +This command creates a Synapse Analytics workspace named ContosoWorkspace that uses the ContosoAdlGenStorage Data Store, in the resource group named ContosoResourceGroup. And the workspace is connected to a Git Repository called ContosoRepo. + +### Example 5 +```powershell +$password = ConvertTo-SecureString "Password123!" -AsPlainText -Force +$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password) +$uamis = Get-AzUserAssignedIdentity -ResourceGroupName ContosoResourceGroup +$uamilist = New-Object System.Collections.Generic.List[string] +foreach($uami in $uamis){ + $uamilist.Add($uami.Id) +} +New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -UserAssignedIdentityId $uamilist +``` + +This command creates a Synapse Analytics workspace named ContosoWorkspace that uses the ContosoAdlGenStorage Data Store, in the resource group named ContosoResourceGroup, and add user assigned managed identities that get from ResourceGroup ContosoResourceGroup to workspace. + +### Example 6 +```powershell +New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -EncryptionKeyIdentifier $identifier -UseSystemAssignedIdentityInEncryption $true +$ws = Get-AzSynapseWorkspace -name ContosoWorkspace +$ws.Encryption.CustomerManagedKeyDetails.Key +``` + +```output +Name KeyVaultUrl +---- ----------- +default https://contosoKeyValut.vault.azure.net/keys/testkey +``` + +```powershell +$ws = Get-AzSynapseWorkspace -name ContosoWorkspace +$ws.Encryption.CustomerManagedKeyDetails.KekIdentity +``` + +```output +UserAssignedIdentity UseSystemAssignedIdentity +-------------------- ------------------------- + True +``` + +This command creates a Synapse Analytics workspace named ContosoWorkspace that uses the ContosoAdlGenStorage Data Store, in the resource group named ContosoResourceGroup, and enable double encryption with customer-managed key with specified key identifier and set Managed Identity as System Assigned. After creation, we can call `Get-AzSynapseWorkspace` to get Encryption properties of workspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultDataLakeStorageAccountName +The default ADLS Gen2 storage account name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultDataLakeStorageFilesystem +The default ADLS Gen2 file system. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePublicNetworkAccess +Enable or Disable public network access to workspace. Possible values include: 'Enabled', 'Disabled' + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyIdentifier +Key identifier should be in the format of: https://{keyvaultname}.vault.azure.net/keys/{keyname}. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyName +The workspace encryption key name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepository +Git Repository Settings. Connect workspace to the repository for source control and collaboration for work on your workspace pipelines + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSWorkspaceRepositoryConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Azure region where the resource should be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagedResourceGroupName +A container that holds ancillary resources. Created by default while the name can be specified. Note that this field must not be the same with ResourceGroupName + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ManagedVirtualNetwork +Name of a Synapse-managed virtual network dedicated for the Azure Synapse workspace. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSManagedVirtualNetworkSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlAdministratorLoginCredential +SQL administrator credentials. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +A string,string dictionary of tags associated with the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +User assigned managed identity Id for workspace. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityInEncryption +User assigned identity resource Id used in Workspace Encryption + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseSystemAssignedIdentityInEncryption +specifying whether to use system assigned identity in Workspace Encryption or not + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Collections.Hashtable + +### System.Management.Automation.PSCredential + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseWorkspaceKey.md b/azps-10.1.0/Az.Synapse/New-AzSynapseWorkspaceKey.md new file mode 100644 index 0000000000..4e8610c191 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseWorkspaceKey.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapseworkspacekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseWorkspaceKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseWorkspaceKey.md +--- + +# New-AzSynapseWorkspaceKey + +## SYNOPSIS +Creates a workspace key. + +## SYNTAX + +### CreateByNameParameterSet (Default) +``` +New-AzSynapseWorkspaceKey [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + -EncryptionKeyIdentifier <String> [-Activate] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### CreateByParentObjectParameterSet +``` +New-AzSynapseWorkspaceKey -WorkspaceObject <PSSynapseWorkspace> -Name <String> + -EncryptionKeyIdentifier <String> [-Activate] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +This **New-AzSynapseWorkspaceKey** cmdlet creates a workspace key. + +## EXAMPLES + +### Example 1 +```powershell +New-AzSynapseWorkspaceKey -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoWorkspaceKey -EncryptionKeyIdentifier https://<key-vault-url>/keys/<key-name> +``` + +This command creates a workspace key named ContosoWorkspaceKey under workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | New-AzSynapseWorkspaceKey -Name ContosoWorkspaceKey -EncryptionKeyIdentifier https://<key-vault-url>/keys/<key-name> +``` + +This command creates a workspace key named ContosoWorkspaceKey under workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -Activate +Indicates whether to activate the workspace after a customer managed key is provided. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyIdentifier +Key identifier should be in the format of: https://{keyvaultname}.vault.azure.net/keys/{keyname}. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the workspace key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: KeyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: CreateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.WorkspaceKey.PSWorkspaceKey + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/New-AzSynapseWorkspacePackage.md b/azps-10.1.0/Az.Synapse/New-AzSynapseWorkspacePackage.md new file mode 100644 index 0000000000..2191d10cb0 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/New-AzSynapseWorkspacePackage.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/new-azsynapseworkspacepackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseWorkspacePackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/New-AzSynapseWorkspacePackage.md +--- + +# New-AzSynapseWorkspacePackage + +## SYNOPSIS +Uploads a local workspace package file to an Azure Synapse workspace. + +## SYNTAX + +### CreateByNameParameterSet (Default) +``` +New-AzSynapseWorkspacePackage -WorkspaceName <String> -Package <String> [-ConcurrentTaskCount <Int32>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByObjectParameterSet +``` +New-AzSynapseWorkspacePackage -WorkspaceObject <PSSynapseWorkspace> -Package <String> + [-ConcurrentTaskCount <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzSynapseWorkspacePackage** uploads a local workspace package file to an Azure Synapse workspace. + +## EXAMPLES + +### Example 1: Upload a named workspace package +```powershell +New-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace -Package ".\ContosoPackage.whl" +``` + +This command uploads the workspace package whose location is ".\ContosoPackage.whl" to an Azure Synapse workspace named ContosoWorkspace. The workspace pacakge can be either wheel or jar files. + +### Example 2: Upload all workspace packages under the current folder +```powershell +Get-ChildItem -File | New-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace +``` + +This command uses the core Windows PowerShell cmdlet Get-ChildItem to get all the workspace packages in the current folder and in subfolders, and then passes them to the current cmdlet by using the pipeline operator. The New-AzSynapseWorkspacePackage cmdlet uploads the workspace package files to the Azure Synapse workspace named ContosoWorkspace. + +### Example 3: Upload a named workspace package and add it to Apache Spark pool +```powershell +$package = New-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace -Package ".\ContosoPackage.whl" +Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -PackageAction Add -Package $package +``` + +This first command uploads the workspace package whose location is ".\ContosoPackage.whl" to an Azure Synapse workspace named ContosoWorkspace. The workspace pacakge can be either wheel or jar files. Then the second command addes the package to a given Apache Spark pool named ContotoSparkPool. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentTaskCount +The total amount of concurrent async tasks. +The default value is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Package +Specifies a local file path for a file to upload as workspace package. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FullName + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: CreateByObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseDataFlow.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseDataFlow.md new file mode 100644 index 0000000000..e67a88961c --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseDataFlow.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsedataflow +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseDataFlow.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseDataFlow.md +--- + +# Remove-AzSynapseDataFlow + +## SYNOPSIS +Removes a data flow from workspace. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapseDataFlow -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapseDataFlow -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapseDataFlow -InputObject <PSDataFlowResource> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseDataFlow** cmdlet removes a data flow from workspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseDataFlow -WorkspaceName ContosoWorkspace -Name ContosoDataFlow +``` + +This command removes the data flow named ContosoDataFlow from the workspace named ContosoWorkspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The data flow object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSDataFlowResource +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The data flow name. + +```yaml +Type: System.String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: DataFlowName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSDataFlowResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseDataset.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseDataset.md new file mode 100644 index 0000000000..2bd4eaa309 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseDataset.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsedataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseDataset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseDataset.md +--- + +# Remove-AzSynapseDataset + +## SYNOPSIS +Removes a dataset from workspace. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapseDataset -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapseDataset -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapseDataset -InputObject <PSDatasetResource> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseDataset** cmdlet removes a dataset from workspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseDataset -WorkspaceName ContosoWorkspace -Name ContosoDataset +``` + +This command removes the dataset named ContosoDataset from the workspace named ContosoWorkspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The dataset object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSDatasetResource +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The dataset name. + +```yaml +Type: System.String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: DatasetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSDatasetResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseFirewallRule.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseFirewallRule.md new file mode 100644 index 0000000000..27ecda522a --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseFirewallRule.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsefirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseFirewallRule.md +--- + +# Remove-AzSynapseFirewallRule + +## SYNOPSIS +Deletes a Synapse Analytics Firewall Rule. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzSynapseFirewallRule [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-PassThru] + [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByParentObjectParameterSet +``` +Remove-AzSynapseFirewallRule -Name <String> -WorkspaceObject <PSSynapseWorkspace> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseFirewallRule** cmdlet permanently deletes an Azure Synapse Analytics Firewall Rule. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseFirewallRule -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoFirewallRule +``` + +This command deletes firewall rule named ContosoFirewallRule under workspace ContosoWorkspace with name ContosoFirewallRule. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseFirewallRule -Name ContosoFirewallRule +``` + +This command deletes firewall rule named ContosoFirewallRule under a workspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The firerwall rule name for the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: DeleteByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseIntegrationRuntime.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseIntegrationRuntime.md new file mode 100644 index 0000000000..c31dd26a0f --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseIntegrationRuntime.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapseintegrationruntime +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseIntegrationRuntime.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseIntegrationRuntime.md +--- + +# Remove-AzSynapseIntegrationRuntime + +## SYNOPSIS +Removes an integration runtime. + +## SYNTAX + +### RemoveByNameParameterSet (Default) +``` +Remove-AzSynapseIntegrationRuntime [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByParentObjectParameterSet +``` +Remove-AzSynapseIntegrationRuntime -Name <String> -WorkspaceObject <PSSynapseWorkspace> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByResourceIdParameterSet +``` +Remove-AzSynapseIntegrationRuntime -ResourceId <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObjectParameterSet +``` +Remove-AzSynapseIntegrationRuntime -InputObject <PSIntegrationRuntime> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseIntegrationRuntime** cmdlet removes a integration runtime. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -Name 'test-reserved-ir' -Confirm +``` + +This command removes the integration runtime named 'test-reserved-ir' from the workspace named ContosoWorkspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: RemoveByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet, RemoveByParentObjectParameterSet +Aliases: IntegrationRuntimeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseIntegrationRuntimeNode.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseIntegrationRuntimeNode.md new file mode 100644 index 0000000000..5ce2cc4494 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseIntegrationRuntimeNode.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapseintegrationruntimenode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseIntegrationRuntimeNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseIntegrationRuntimeNode.md +--- + +# Remove-AzSynapseIntegrationRuntimeNode + +## SYNOPSIS +Remove a node with the given name on an integration runtime. + +## SYNTAX + +### RemoveByNameParameterSet (Default) +``` +Remove-AzSynapseIntegrationRuntimeNode [-ResourceGroupName <String>] -WorkspaceName <String> + -IntegrationRuntimeName <String> -NodeName <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByParentObjectParameterSet +``` +Remove-AzSynapseIntegrationRuntimeNode -IntegrationRuntimeName <String> -WorkspaceObject <PSSynapseWorkspace> + -NodeName <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RemoveByResourceIdParameterSet +``` +Remove-AzSynapseIntegrationRuntimeNode -ResourceId <String> -NodeName <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObjectParameterSet +``` +Remove-AzSynapseIntegrationRuntimeNode -InputObject <PSIntegrationRuntime> -NodeName <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseIntegrationRuntimeNode** cmdlet removes a node in an integration runtime. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseIntegrationRuntimeNode -WorkspaceName ContosoWorkspace -IntegrationRuntimeName 'test-selfhost-ir' -NodeName 'Node_1' +``` + +Remove a node with the given name on an integration runtime. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: RemoveByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntegrationRuntimeName +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet, RemoveByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeName +The integration runtime node name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseKqlScript.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKqlScript.md new file mode 100644 index 0000000000..8c01dca117 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKqlScript.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsekqlscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKqlScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKqlScript.md +--- + +# Remove-AzSynapseKqlScript + +## SYNOPSIS +Removes a KQL script from a workspace. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapseKqlScript -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapseKqlScript -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapseKqlScript -InputObject <PSKqlScriptResource> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseKqlScript** cmdlet removes a KQL script from a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -Name ContosoKqlScript +``` + +Removes a KQL script called ContosoKqlScript from the workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseKqlScript -Name ContosoKqlScript +``` + +Removes a KQL script called ContosoKqlScript from the workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$kqlScript = Get-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -Name ContosoKqlScript +$kqlScript | Remove-AzSynapseKqlScript +``` + +Removes a KQL script called ContosoKqlScript from the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +KQL script object. + +```yaml +Type: PSKqlScriptResource +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +KQL script name. + +```yaml +Type: String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: KqlScriptName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSKqlScriptResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPool.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPool.md new file mode 100644 index 0000000000..45a06f98da --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPool.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsekustopool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPool.md +--- + +# Remove-AzSynapseKustoPool + +## SYNOPSIS +Deletes a Kusto pool. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSynapseKustoPool -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSynapseKustoPool -InputObject <ISynapseIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Kusto pool. + +## EXAMPLES + +### Example 1: Delete an existing Kusto pool by name +```powershell +Remove-AzSynapseKustoPool -ResourceGroupName testrg -WorkspaceName testws -Name testnewkustopool +``` + +The above command deletes the Kusto pool named "testnewkustopool" in the workspace "testws". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: KustoPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md new file mode 100644 index 0000000000..4720bd54e9 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md @@ -0,0 +1,260 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsekustopoolattacheddatabaseconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md +--- + +# Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration + +## SYNOPSIS +Deletes the attached database configuration with the given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration -AttachedDatabaseConfigurationName <String> + -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration -InputObject <ISynapseIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the attached database configuration with the given name. + +## EXAMPLES + +### Example 1: Delete an existing AttachedDatabaseConfiguration by name +```powershell +Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration -ResourceGroupName "testrg" -WorkspaceName "testws" -KustoPoolName "testkustopool" -AttachedDatabaseConfigurationName "myfollowerconfiguration" +``` + +The above command deletes the attached database configuration with the given name "myfollowerconfiguration" from workspace "testws". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachedDatabaseConfigurationName +The name of the attached database configuration. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolDataConnection.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolDataConnection.md new file mode 100644 index 0000000000..597aa3454e --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolDataConnection.md @@ -0,0 +1,275 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsekustopooldataconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDataConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDataConnection.md +--- + +# Remove-AzSynapseKustoPoolDataConnection + +## SYNOPSIS +Deletes the data connection with the given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSynapseKustoPoolDataConnection -DatabaseName <String> -DataConnectionName <String> + -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSynapseKustoPoolDataConnection -InputObject <ISynapseIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the data connection with the given name. + +## EXAMPLES + +### Example 1: Delete an existing data connection by name +```powershell +Remove-AzSynapseKustoPoolDataConnection -ResourceGroupName "testrg" -WorkspaceName "testws" -KustoPoolName "testkustopool" -DatabaseName "mykustodatabase" -DataConnectionName "mykustodataconnection" +``` + +The above command deletes the data connection named "mykustodataconnection" in kusto database "mykustodatabase" of the existing workspace "testws" found in the resource group "testrg" + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataConnectionName +The name of the data connection. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolDatabase.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolDatabase.md new file mode 100644 index 0000000000..57b128da37 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolDatabase.md @@ -0,0 +1,260 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsekustopooldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDatabase.md +--- + +# Remove-AzSynapseKustoPoolDatabase + +## SYNOPSIS +Deletes the database with the given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSynapseKustoPoolDatabase -DatabaseName <String> -KustoPoolName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSynapseKustoPoolDatabase -InputObject <ISynapseIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the database with the given name. + +## EXAMPLES + +### Example 1: Delete an existing Kusto database by name +```powershell +Remove-AzSynapseKustoPoolDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -Name mykustodatabase +``` + +The above command deletes the Kusto database named "mykustodatabase" in the workspace "testws" found in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md new file mode 100644 index 0000000000..f275c98540 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md @@ -0,0 +1,276 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsekustopooldatabaseprincipalassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md +--- + +# Remove-AzSynapseKustoPoolDatabasePrincipalAssignment + +## SYNOPSIS +Deletes a Kusto pool principalAssignment. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSynapseKustoPoolDatabasePrincipalAssignment -DatabaseName <String> -KustoPoolName <String> + -PrincipalAssignmentName <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSynapseKustoPoolDatabasePrincipalAssignment -InputObject <ISynapseIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Kusto pool principalAssignment. + +## EXAMPLES + +### Example 1: Delete an existing Kusto database PrincipalAssignment by name +```powershell +Remove-AzSynapseKustoPoolDatabasePrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -DatabaseName mykustodatabase -PrincipalAssignmentName kustoprincipal1 +``` + +The above command deletes the PrincipalAssignment named "kustoprincipal1" in the Kusto database "mykustodatabase" in workspace "testws" found in resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolLanguageExtension.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolLanguageExtension.md new file mode 100644 index 0000000000..84d265df0d --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolLanguageExtension.md @@ -0,0 +1,264 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsekustopoollanguageextension +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolLanguageExtension.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolLanguageExtension.md +--- + +# Remove-AzSynapseKustoPoolLanguageExtension + +## SYNOPSIS +Remove a list of language extensions that can run within KQL queries. + +## SYNTAX + +### RemoveExpanded (Default) +``` +Remove-AzSynapseKustoPoolLanguageExtension -KustoPoolName <String> -ResourceGroupName <String> + -WorkspaceName <String> [-SubscriptionId <String>] [-Value <ILanguageExtension[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### RemoveViaIdentityExpanded +``` +Remove-AzSynapseKustoPoolLanguageExtension -InputObject <ISynapseIdentity> [-Value <ILanguageExtension[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Remove a list of language extensions that can run within KQL queries. + +## EXAMPLES + +### Example 1: Remove a list of language extensions from kusto pool +```powershell +Remove-AzSynapseKustoPoolLanguageExtension -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -Value (@{Name="R"}) +``` + +The above command removes a list of language extensions that can run within KQL queries. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: RemoveViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The list of language extensions. +To construct, see NOTES section for VALUE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.ILanguageExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +VALUE <ILanguageExtension[]>: The list of language extensions. + - `[Name <LanguageExtensionName?>]`: The language extension name. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolPrincipalAssignment.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolPrincipalAssignment.md new file mode 100644 index 0000000000..4719ebe769 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseKustoPoolPrincipalAssignment.md @@ -0,0 +1,260 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsekustopoolprincipalassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolPrincipalAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolPrincipalAssignment.md +--- + +# Remove-AzSynapseKustoPoolPrincipalAssignment + +## SYNOPSIS +Deletes a Kusto pool principalAssignment. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSynapseKustoPoolPrincipalAssignment -KustoPoolName <String> -PrincipalAssignmentName <String> + -ResourceGroupName <String> -WorkspaceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzSynapseKustoPoolPrincipalAssignment -InputObject <ISynapseIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Kusto pool principalAssignment. + +## EXAMPLES + +### Example 1: Delete an existing Kusto pool PrincipalAssignment by name +```powershell +Remove-AzSynapseKustoPoolPrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -PrincipalAssignmentName kustoprincipal1 +``` + +The above command deletes a Kusto pool principalAssignment "kustoprincipal1" in the workspace "testws". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseLinkConnection.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseLinkConnection.md new file mode 100644 index 0000000000..add9a812d0 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseLinkConnection.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapselinkconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseLinkConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseLinkConnection.md +--- + +# Remove-AzSynapseLinkConnection + +## SYNOPSIS +Deletes a link connection from workspace. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapseLinkConnection -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapseLinkConnection -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapseLinkConnection -InputObject <PSLinkConnectionResource> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseLinkConnection** cmdlet removes a link connection from workspace. Only link connections in initial or stpped status can be removed. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +``` + +This command removes the link connection named ContosoLinkConnection from the workspace named ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseLinkConnection -Name ContosoLinkConnection +``` + +This command removes the link connection named ContosoLinkConnection from the workspace named ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$linkConnection = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +$linkConnection | Remove-AzSynapseLinkConnection +``` + +This command removes the link connection named ContosoLinkConnection from the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Synapse link connection object for Azure Sql Database. + +```yaml +Type: PSLinkConnectionResource +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Synapse link connection name for Azure Sql Database. + +```yaml +Type: String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: LinkConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkConnectionResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseLinkedService.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseLinkedService.md new file mode 100644 index 0000000000..8345b7b9dc --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseLinkedService.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapselinkedservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseLinkedService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseLinkedService.md +--- + +# Remove-AzSynapseLinkedService + +## SYNOPSIS +Removes a linked service from workspace. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapseLinkedService -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapseLinkedService -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapseLinkedService -InputObject <PSLinkedServiceResource> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseLinkedService** cmdlet removes a linked service from workspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseLinkedService -WorkspaceName ContosoWorkspace -Name ContosoLinkedService +``` + +This command removes the linked service named ContosoLinkedService from the workspace named ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseLinkedService -Name ContosoLinkedService +``` + +This command removes the linked service named ContosoLinkedService from the workspace named ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$linkedService = Get-AzSynapseLinkedService -WorkspaceName ContosoWorkspace -Name ContosoLinkedService +$linkedService | Remove-AzSynapseLinkedService +``` + +This command removes the linked service named ContosoLinkedService from the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The linked service object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSLinkedServiceResource +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The linked service name. + +```yaml +Type: System.String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: LinkedServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkedServiceResource + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkedServiceResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseManagedPrivateEndpoint.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseManagedPrivateEndpoint.md new file mode 100644 index 0000000000..c85d2dbac2 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseManagedPrivateEndpoint.md @@ -0,0 +1,250 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsemanagedprivateendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseManagedPrivateEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseManagedPrivateEndpoint.md +--- + +# Remove-AzSynapseManagedPrivateEndpoint + +## SYNOPSIS +Removes a managed private endpoint from a workspace. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapseManagedPrivateEndpoint -WorkspaceName <String> -Name <String> [-VirtualNetworkName <String>] + [-PassThru] [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapseManagedPrivateEndpoint -WorkspaceObject <PSSynapseWorkspace> -Name <String> + [-VirtualNetworkName <String>] [-PassThru] [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapseManagedPrivateEndpoint -InputObject <PSManagedPrivateEndpointResource> + [-VirtualNetworkName <String>] [-PassThru] [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseManagedPrivateEndpoint** cmdlet removes a managed private endpoint from a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseManagedPrivateEndpoint -WorkspaceName ContosoWorkspace -Name ContosoManagedPrivateEndpoint +``` + +Remove a managed private endpoint called ContosoManagedPrivateEndpoint from the workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseManagedPrivateEndpoint -Name ContosoManagedPrivateEndpoint +``` + +Remove a managed private endpoint called ContosoManagedPrivateEndpoint from the workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$privateendpint = Get-AzSynapseManagedPrivateEndpoint -WorkspaceName ContosoWorkspace -Name ContosoManagedPrivateEndpoint +$privateendpint | Remove-AzSynapseManagedPrivateEndpoint +``` + +Remove a managed private endpoint called ContosoManagedPrivateEndpoint from the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Synapse Managed Private Endpoint Object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSManagedPrivateEndpointResource +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Synapse Managed Private Endpoint Name. + +```yaml +Type: System.String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: ManagedPrivateEndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkName +Managed Virtual Network Name is default. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VNetName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSManagedPrivateEndpointResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseNotebook.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseNotebook.md new file mode 100644 index 0000000000..b8e8592696 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseNotebook.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsenotebook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseNotebook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseNotebook.md +--- + +# Remove-AzSynapseNotebook + +## SYNOPSIS +Removes a notebook from a workspace. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapseNotebook -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapseNotebook -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapseNotebook -InputObject <PSNotebookResource> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseNotebook** cmdlet removes a notebook from a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseNotebook -WorkspaceName ContosoWorkspace -Name ContosoNotebook +``` + +Remove a notebook called ContosoNotebook from the workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseNotebook -Name ContosoNotebook +``` + +Remove a notebook called ContosoNotebook from the workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$notebook = Get-AzSynapseNotebook -WorkspaceName ContosoWorkspace -Name ContosoNotebook +$notebook | Remove-AzSynapseNotebook +``` + +Remove a notebook called ContosoNotebook from the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The notebook object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSNotebookResource +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The notebook name. + +```yaml +Type: System.String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: NotebookName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSNotebookResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapsePipeline.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapsePipeline.md new file mode 100644 index 0000000000..e04a7bee3d --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapsePipeline.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsepipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapsePipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapsePipeline.md +--- + +# Remove-AzSynapsePipeline + +## SYNOPSIS +Removes a pipeline from workspace. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapsePipeline -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapsePipeline -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapsePipeline -InputObject <PSPipelineResource> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapsePipeline** cmdlet removes a pipeline from workspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapsePipeline -WorkspaceName ContosoWorkspace -Name ContosoPipeline +``` + +This cmdlet removes the pipeline named ContosoPipeline from the workspace named ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapsePipeline -Name ContosoPipeline +``` + +This cmdlet removes the pipeline named ContosoPipeline from the workspace named ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$pipeline = Get-AzSynapsePipeline -WorkspaceName ContosoWorkspace -Name ContosoPipeline +$pipeline | Remove-AzSynapsePipeline +``` + +This cmdlet removes the pipeline named ContosoPipeline from the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The pipeline object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSPipelineResource +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The pipeline name. + +```yaml +Type: System.String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: PipelineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSPipelineResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseRoleAssignment.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseRoleAssignment.md new file mode 100644 index 0000000000..0cd2f53dda --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseRoleAssignment.md @@ -0,0 +1,370 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapseroleassignment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseRoleAssignment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseRoleAssignment.md +--- + +# Remove-AzSynapseRoleAssignment + +## SYNOPSIS +Deletes a Synapse Analytics role assignment. + +## SYNTAX + +### RemoveByWorkspaceNameAndNameParameterSet (Default) +``` +Remove-AzSynapseRoleAssignment -WorkspaceName <String> -RoleDefinitionName <String> -SignInName <String> + [-ItemType <WorkspaceItemType>] [-Item <String>] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByWorkspaceNameAndIdParameterSet +``` +Remove-AzSynapseRoleAssignment -WorkspaceName <String> -RoleAssignmentId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByWorkspaceNameAndObjectIdParameterSet +``` +Remove-AzSynapseRoleAssignment -WorkspaceName <String> -RoleDefinitionName <String> -ObjectId <String> + [-ItemType <WorkspaceItemType>] [-Item <String>] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByWorkspaceNameAndRoleDefinitionIdParameterSet +``` +Remove-AzSynapseRoleAssignment -WorkspaceName <String> -RoleDefinitionId <String> -ObjectId <String> + [-ItemType <WorkspaceItemType>] [-Item <String>] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByWorkspaceNameAndServicePrincipalNameParameterSet +``` +Remove-AzSynapseRoleAssignment -WorkspaceName <String> -RoleDefinitionName <String> + -ServicePrincipalName <String> [-ItemType <WorkspaceItemType>] [-Item <String>] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByWorkspaceObjectAndIdParameterSet +``` +Remove-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> -RoleAssignmentId <String> [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByWorkspaceObjectAndNameParameterSet +``` +Remove-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> -RoleDefinitionName <String> + -SignInName <String> [-ItemType <WorkspaceItemType>] [-Item <String>] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByWorkspaceObjectAndObjectIdParameterSet +``` +Remove-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> -RoleDefinitionName <String> + -ObjectId <String> [-ItemType <WorkspaceItemType>] [-Item <String>] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByWorkspaceObjectAndRoleDefinitionIdParameterSet +``` +Remove-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> -RoleDefinitionId <String> + -ObjectId <String> [-ItemType <WorkspaceItemType>] [-Item <String>] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByWorkspaceObjectAndServicePrincipalNameParameterSet +``` +Remove-AzSynapseRoleAssignment -WorkspaceObject <PSSynapseWorkspace> -RoleDefinitionName <String> + -ServicePrincipalName <String> [-ItemType <WorkspaceItemType>] [-Item <String>] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseRoleAssignment** cmdlet permanently deletes an Azure Synapse Analytics role assignment. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +* GET /users/{id} +* GET /servicePrincipals/{id} + +>[!Note] +> To removing a role assignment for a service principal, pass the object ID of the principal in the ObjectId parameter. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleAssignmentId ContosoRoleAssignmentId +``` + +This command deletes an Azure Synapse Analytics role assignment with a role assignment Id. + +### Example 2 +```powershell +Remove-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName +``` + +This command deletes an Azure Synapse Analytics role assignment at workspace level with a role name and a user principal name. + +### Example 3 +```powershell +Remove-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType -Item ContosoItem +``` + +This command deletes an Azure Synapse Analytics role assignment with a role name, a user principal name, a item type and a item. + +### Example 4 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseRoleAssignment -RoleAssignmentId ContosoRoleAssignmentId +``` + +This command deletes an Azure Synapse Analytics role assignment with a role assignment Id through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Item +The item of Azure Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByWorkspaceNameAndNameParameterSet, RemoveByWorkspaceNameAndObjectIdParameterSet, RemoveByWorkspaceNameAndRoleDefinitionIdParameterSet, RemoveByWorkspaceNameAndServicePrincipalNameParameterSet, RemoveByWorkspaceObjectAndNameParameterSet, RemoveByWorkspaceObjectAndObjectIdParameterSet, RemoveByWorkspaceObjectAndRoleDefinitionIdParameterSet, RemoveByWorkspaceObjectAndServicePrincipalNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ItemType +The itemtype of Azure Synapse workspace. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+WorkspaceItemType +Parameter Sets: RemoveByWorkspaceNameAndNameParameterSet, RemoveByWorkspaceNameAndObjectIdParameterSet, RemoveByWorkspaceNameAndRoleDefinitionIdParameterSet, RemoveByWorkspaceNameAndServicePrincipalNameParameterSet, RemoveByWorkspaceObjectAndNameParameterSet, RemoveByWorkspaceObjectAndObjectIdParameterSet, RemoveByWorkspaceObjectAndRoleDefinitionIdParameterSet, RemoveByWorkspaceObjectAndServicePrincipalNameParameterSet +Aliases: +Accepted values: ApacheSparkPool, IntegrationRuntime, LinkedService, Credential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The Azure AD ObjectId of the User, Group or Service Principal. + +```yaml +Type: System.String +Parameter Sets: RemoveByWorkspaceNameAndObjectIdParameterSet, RemoveByWorkspaceNameAndRoleDefinitionIdParameterSet, RemoveByWorkspaceObjectAndObjectIdParameterSet, RemoveByWorkspaceObjectAndRoleDefinitionIdParameterSet +Aliases: Id, PrincipalId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleAssignmentId +The ID of the role assignment. + +```yaml +Type: System.String +Parameter Sets: RemoveByWorkspaceNameAndIdParameterSet, RemoveByWorkspaceObjectAndIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionId +Id of the Role that is assigned to the principal. + +```yaml +Type: System.String +Parameter Sets: RemoveByWorkspaceNameAndRoleDefinitionIdParameterSet, RemoveByWorkspaceObjectAndRoleDefinitionIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleDefinitionName +Name of the Role that is assigned to the principal. + +```yaml +Type: System.String +Parameter Sets: RemoveByWorkspaceNameAndNameParameterSet, RemoveByWorkspaceNameAndObjectIdParameterSet, RemoveByWorkspaceNameAndServicePrincipalNameParameterSet, RemoveByWorkspaceObjectAndNameParameterSet, RemoveByWorkspaceObjectAndObjectIdParameterSet, RemoveByWorkspaceObjectAndServicePrincipalNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicePrincipalName +The ServicePrincipalName of the service principal. + +```yaml +Type: System.String +Parameter Sets: RemoveByWorkspaceNameAndServicePrincipalNameParameterSet, RemoveByWorkspaceObjectAndServicePrincipalNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignInName +The email address or the user principal name of the user. + +```yaml +Type: System.String +Parameter Sets: RemoveByWorkspaceNameAndNameParameterSet, RemoveByWorkspaceObjectAndNameParameterSet +Aliases: Email, UserPrincipalName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByWorkspaceNameAndNameParameterSet, RemoveByWorkspaceNameAndIdParameterSet, RemoveByWorkspaceNameAndObjectIdParameterSet, RemoveByWorkspaceNameAndRoleDefinitionIdParameterSet, RemoveByWorkspaceNameAndServicePrincipalNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByWorkspaceObjectAndIdParameterSet, RemoveByWorkspaceObjectAndNameParameterSet, RemoveByWorkspaceObjectAndObjectIdParameterSet, RemoveByWorkspaceObjectAndRoleDefinitionIdParameterSet, RemoveByWorkspaceObjectAndServicePrincipalNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseSparkConfiguration.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSparkConfiguration.md new file mode 100644 index 0000000000..4ba088aca2 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSparkConfiguration.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsesparkconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSparkConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSparkConfiguration.md +--- + +# Remove-AzSynapseSparkConfiguration + +## SYNOPSIS +Removes a spark configuration from a workspace. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapseSparkConfiguration -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapseSparkConfiguration -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapseSparkConfiguration -InputObject <PSSparkConfigurationResource> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseSparkConfiguration** cmdlet removes a spark configuration from a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -Name ContosoSparkConfiguration +``` + +Remove a spark configuration called ContosoSparkConfiguration from the workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseSparkConfiguration -Name ContosoSparkConfiguration +``` + +Remove a spark configuration called ContosoSparkConfiguration from the workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$sparkConfiguration = Get-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -Name ContosoSparkConfiguration +$sparkConfiguration | Remove-AzSynapseSparkConfiguration +``` + +Remove a spark configuration called ContosoSparkConfiguration from the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Spark configuration object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSparkConfigurationResource +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Spark Configuration name. + +```yaml +Type: System.String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: SparkConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSparkConfigurationResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseSparkJobDefinition.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSparkJobDefinition.md new file mode 100644 index 0000000000..57dfe3d4bf --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSparkJobDefinition.md @@ -0,0 +1,232 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsesparkjobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSparkJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSparkJobDefinition.md +--- + +# Remove-AzSynapseSparkJobDefinition + +## SYNOPSIS +Removes a Spark job definition from workspace. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapseSparkJobDefinition -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapseSparkJobDefinition -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapseSparkJobDefinition -InputObject <PSSparkJobDefinitionResource> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseSparkJobDefinition** cmdlet removes a Spark job definition from workspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseSparkJobDefinition -WorkspaceName ContosoWorkspace -Name ContosoSparkJobDefinition +``` + +This cmdlet removes the Spark job definition named ContosoSparkJobDefinition from the workspace named ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseSparkJobDefinition -Name ContosoSparkJobDefinition +``` + +This cmdlet removes the Spark job definition named ContosoSparkJobDefinition from the workspace named ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$sparkJobDefinition = Get-AzSynapseSparkJobDefinition -WorkspaceName ContosoWorkspace -Name ContosoSparkJobDefinition +$sparkJobDefinition | Remove-AzSynapseSparkJobDefinition +``` + +This cmdlet removes the Spark job definition named ContosoSparkJobDefinition from the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Spark job definition object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSparkJobDefinitionResource +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Spark job definition name. + +```yaml +Type: System.String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: SparkJobDefinitionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSparkJobDefinitionResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseSparkPool.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSparkPool.md new file mode 100644 index 0000000000..cbc5a00d71 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSparkPool.md @@ -0,0 +1,274 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsesparkpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSparkPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSparkPool.md +--- + +# Remove-AzSynapseSparkPool + +## SYNOPSIS +Deletes a Apache Spark pool in Azure Synapse Analytics. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzSynapseSparkPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-PassThru] + [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByParentObjectParameterSet +``` +Remove-AzSynapseSparkPool -Name <String> -WorkspaceObject <PSSynapseWorkspace> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzSynapseSparkPool -InputObject <PSSynapseSparkPool> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzSynapseSparkPool -ResourceId <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseSparkPool** cmdlet permanently deletes an Apache Spark pool in Azure Synapse Analytics. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool +``` + +This command deletes an Apache Spark pool in Azure Synapse Analytics. + +### Example 2 +```powershell +$pool = Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool +$pool | Remove-AzSynapseSparkPool +``` + +This command deletes an Apache Spark pool in Azure Synapse Analytics through pipeline. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseSparkPool -Name ContosoSparkPool +``` + +This command deletes an Apache Spark pool in Azure Synapse Analytics through pipeline. + +### Example 4 +```powershell +Remove-AzSynapseSparkPool -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/bigDataPools/ContosoSparkPool +``` + +This command deletes an Apache Spark pool in Azure Synapse Analytics with a resource ID. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Spark pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet, DeleteByParentObjectParameterSet +Aliases: SparkPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: DeleteByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlActiveDirectoryAdministrator.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlActiveDirectoryAdministrator.md new file mode 100644 index 0000000000..721832eaea --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlActiveDirectoryAdministrator.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsesqlactivedirectoryadministrator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSqlActiveDirectoryAdministrator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSqlActiveDirectoryAdministrator.md +--- + +# Remove-AzSynapseSqlActiveDirectoryAdministrator + +## SYNOPSIS +Removes an Azure AD administrator for Synapse Analytics Workspace. + +## SYNTAX + +### RemoveByNameParameterSet (Default) +``` +Remove-AzSynapseSqlActiveDirectoryAdministrator [-ResourceGroupName <String>] -WorkspaceName <String> + [-PassThru] [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RemoveByInputObjectParameterSet +``` +Remove-AzSynapseSqlActiveDirectoryAdministrator -InputObject <PSSynapseWorkspace> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByResourceIdParameterSet +``` +Remove-AzSynapseSqlActiveDirectoryAdministrator -ResourceId <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseSqlActiveDirectoryAdministrator** cmdlet removes an Azure Active Directory (Azure AD) administrator for Azure Synapse Analytics Workspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseSqlActiveDirectoryAdministrator -WorkspaceName ContosoWorkspace +``` + +This command removes the Azure AD administrator for the workspace named ContosoWorkspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlDatabase.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlDatabase.md new file mode 100644 index 0000000000..5539b62850 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlDatabase.md @@ -0,0 +1,277 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsesqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSqlDatabase.md +--- + +# Remove-AzSynapseSqlDatabase + +## SYNOPSIS +This feature is in a limited preview, initially accessible only to certain subscriptions. Deletes a Synapse Analytics SQL database. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzSynapseSqlDatabase [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-PassThru] + [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByParentObjectParameterSet +``` +Remove-AzSynapseSqlDatabase -Name <String> -WorkspaceObject <PSSynapseWorkspace> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzSynapseSqlDatabase -InputObject <PSSynapseSqlDatabase> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzSynapseSqlDatabase -ResourceId <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseSqlPool** cmdlet permanently deletes an Azure Synapse Analytics SQL database. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseSqlDatabase -WorkspaceName ContosoWorkspace -Name ContosoSqlDatabase +``` + +This command deletes an Azure Synapse Analytics SQL database. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseSqlDatabase -Name ContosoSqlDatabase +``` + +This command deletes an Azure Synapse Analytics SQL database through pipeline. + +### Example 3 +```powershell +$database = Get-AzSynapseSqlDatabase -WorkspaceName ContosoWorkspace -Name ContosoSqlDatabase +$database | Remove-AzSynapseSqlDatabase +``` + +This command deletes an Azure Synapse Analytics SQL database through pipeline. + +### Example 4 +```powershell +Remove-AzSynapseSqlDatabase -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/sqlDatabases/ContosoSqlDatabase +``` + +This command deletes an Azure Synapse Analytics SQL database with the specified resource ID. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL Database input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlDatabase +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL Database. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet, DeleteByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Database. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: DeleteByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlDatabase + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlPool.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlPool.md new file mode 100644 index 0000000000..9cc2446899 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlPool.md @@ -0,0 +1,292 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsesqlpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSqlPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSqlPool.md +--- + +# Remove-AzSynapseSqlPool + +## SYNOPSIS +Deletes a Synapse Analytics SQL pool. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzSynapseSqlPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-Version <Int32>] + [-PassThru] [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteByParentObjectParameterSet +``` +Remove-AzSynapseSqlPool -Name <String> [-Version <Int32>] -WorkspaceObject <PSSynapseWorkspace> [-PassThru] + [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzSynapseSqlPool [-Version <Int32>] -InputObject <PSSynapseSqlPool> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzSynapseSqlPool [-Version <Int32>] -ResourceId <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseSqlPool** cmdlet permanently deletes an Azure Synapse Analytics SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +``` + +This command deletes an Azure Synapse Analytics SQL pool. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseSqlPool -Name ContosoSqlPool +``` + +This command deletes an Azure Synapse Analytics SQL pool through pipeline. + +### Example 3 +```powershell +$pool = Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +$pool | Remove-AzSynapseSqlPool +``` + +This command deletes an Azure Synapse Analytics SQL pool through pipeline. + +### Example 4 +```powershell +Remove-AzSynapseSqlPool -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/sqlPools/ContosoSqlPool +``` + +This command deletes an Azure Synapse Analytics SQL pool with the specified resource ID. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet, DeleteByParentObjectParameterSet +Aliases: SqlPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version +Version of Synapse SQL pool. For example, 2 or 3. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: DeleteByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlPoolRestorePoint.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlPoolRestorePoint.md new file mode 100644 index 0000000000..2f3db3728e --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlPoolRestorePoint.md @@ -0,0 +1,295 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsesqlpoolrestorepoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSqlPoolRestorePoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSqlPoolRestorePoint.md +--- + +# Remove-AzSynapseSqlPoolRestorePoint + +## SYNOPSIS +Deletes a Synapse Analytics SQL pool restore point. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzSynapseSqlPoolRestorePoint [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + -RestorePointCreationDate <DateTime> [-PassThru] [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByParentObjectParameterSet +``` +Remove-AzSynapseSqlPoolRestorePoint -RestorePointCreationDate <DateTime> -SqlPoolObject <PSSynapseSqlPool> + [-PassThru] [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzSynapseSqlPoolRestorePoint -InputObject <PSRestorePoint> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzSynapseSqlPoolRestorePoint -ResourceId <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseSqlPoolRestorePoint** cmdlet permanently deletes an Azure Synapse Analytics SQL pool restore point. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseSqlPoolRestorePoint -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool -RestorePointCreationDate ContosoSqlPoolRestorePointCreationDate +``` + +This command deletes an Azure Synapse Analytics SQL pool restore point. + +### Example 2 +```powershell +$pool = Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +$pool | Remove-AzSynapseSqlPoolRestorePoint -RestorePointCreationDate ContosoSqlPoolRestorePointCreationDate +``` + +This command deletes an Azure Synapse Analytics SQL pool restore point through pipeline. + +### Example 3 +```powershell +$points = Get-AzSynapseSqlPoolRestorePoint -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +$points[$index] | Remove-AzSynapseSqlPoolRestorePoint +``` + +This command deletes an Azure Synapse Analytics SQL pool restore point through pipeline. + +### Example 4 +```powershell +Remove-AzSynapseSqlPoolRestorePoint -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/sqlPools/ContosoSqlPool/SqlPoolRestorePoints/RestorePointCreationDate +``` + +This command deletes an Azure Synapse Analytics SQL pool restore point with the specified resource ID. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool restore point creation time input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSRestorePoint +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: SqlPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RestorePointCreationDate +Name of Synapse SQL Restore Point Creation Date . + +```yaml +Type: System.DateTime +Parameter Sets: DeleteByNameParameterSet, DeleteByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlPoolObject +Sql Pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: DeleteByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +### Microsoft.Azure.Commands.Synapse.Models.PSRestorePoint + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlPoolSensitivityClassification.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlPoolSensitivityClassification.md new file mode 100644 index 0000000000..f60b70b965 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlPoolSensitivityClassification.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsesqlpoolsensitivityclassification +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSqlPoolSensitivityClassification.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSqlPoolSensitivityClassification.md +--- + +# Remove-AzSynapseSqlPoolSensitivityClassification + +## SYNOPSIS +Removes the information types and sensitivity labels of columns in the SQL pool. + +## SYNTAX + +### ClassificationObjectParameterSet (Default) +``` +Remove-AzSynapseSqlPoolSensitivityClassification -ClassificationObject <SqlPoolSensitivityClassificationModel> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Remove-AzSynapseSqlPoolSensitivityClassification [-ResourceGroupName] <String> [-WorkspaceName] <String> + [-SqlPoolName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlPoolObjectColumnParameterSet +``` +Remove-AzSynapseSqlPoolSensitivityClassification -SqlPoolObject <PSSynapseSqlPool> -SchemaName <String> + -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Remove-AzSynapseSqlPoolSensitivityClassification cmdlet removes the information types and sensitivity labels of columns in the SQL pool. + +## EXAMPLES + +### Example 1: Remove information type and sensitivity label of a column in an Azure Synapse SQL pool. +```powershell +Remove-AzSynapseSqlPoolSensitivityClassification -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool -SchemaName schema -TableName table -ColumnName column +``` + +### Example 2: Remove current information types and sensitivity labels of columns in an Azure Synapse SQL pool using Piping. +```powershell +Get-AzSynapseSqlPoolSensitivityClassification -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool | Remove-AzSynapseSqlPoolSensitivityClassification +``` + +### Example 3: Remove information type and sensitivity label of a column in an Azure Synapse SQL pool using Piping. +```powershell +Get-AzSynapseSqlPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSqlPool | Remove-AzSynapseSqlPoolSensitivityClassification -SchemaName schema -TableName table -ColumnName column +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationObject +An object representing a SQL Pool Sensitivity Classification. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.DataClassification.SqlPoolSensitivityClassificationModel +Parameter Sets: ClassificationObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolName +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.DataClassification.SqlPoolSensitivityClassificationModel + +### System.String + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlScript.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlScript.md new file mode 100644 index 0000000000..a189b07304 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseSqlScript.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsesqlscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSqlScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseSqlScript.md +--- + +# Remove-AzSynapseSqlScript + +## SYNOPSIS +Removes a sql script from a Synapse workspace. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapseSqlScript -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapseSqlScript -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapseSqlScript -InputObject <PSSqlScriptResource> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseSqlScript** cmdlet removes a sql script from a Synapse workspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseSqlScript -WorkspaceName ContosoWorkspace -Name ContosoSqlScript +``` + +Remove a sql script called ContosoSqlScript from the workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseSqlScript -Name ContosoSqlScript +``` + +Remove a sql script called ContosoSqlScript from the workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$sqlscript = Get-AzSynapseSqlScript -WorkspaceName ContosoWorkspace -Name ContosoSqlScript +$sqlscript | Remove-AzSynapseSqlScript +``` + +Remove a sql script called ContosoSqlScript from the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The sql script object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSqlScriptResource +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The sql script name. + +```yaml +Type: System.String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: SqlScriptName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSqlScriptResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Export-AzSynapseSqlScript](./Export-AzSynapseSqlScript.md) + +[Get-AzSynapseSqlScript](./Get-AzSynapseSqlScript.md) + +[Set-AzSynapseSqlScript](./Set-AzSynapseSqlScript.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseTrigger.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseTrigger.md new file mode 100644 index 0000000000..6e559d80eb --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseTrigger.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsetrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseTrigger.md +--- + +# Remove-AzSynapseTrigger + +## SYNOPSIS +Removes a trigger from a workspace. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapseTrigger -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapseTrigger -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapseTrigger -InputObject <PSTriggerResource> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseTrigger** cmdlet removes a trigger from a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger +``` + +Remove a trigger called ContosoTrigger from the workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseTrigger -Name ContosoTrigger +``` + +Remove a trigger called ContosoTrigger from the workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$trigger = Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger +$trigger | Remove-AzSynapseTrigger +``` + +Remove a trigger called ContosoTrigger from the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The trigger object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: TriggerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseTriggerSubscription.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseTriggerSubscription.md new file mode 100644 index 0000000000..9b8b4c7484 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseTriggerSubscription.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapsetriggersubscription +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseTriggerSubscription.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseTriggerSubscription.md +--- + +# Remove-AzSynapseTriggerSubscription + +## SYNOPSIS +Unsubscribe the event trigger to external service events. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapseTriggerSubscription -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapseTriggerSubscription -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapseTriggerSubscription -InputObject <PSTriggerResource> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseTriggerSubscription** cmdlet unsubscribes the event trigger to the specified external service events from the trigger defintion. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseTriggerSubscription -WorkspaceName ContosoWorkspace -Name ContosoTrigger +``` + +This command will unsubscribe trigger called ContosoTrigger to the specified events from the trigger defintion. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseTriggerSubscription -Name ContosoTrigger +``` + +This command will unsubscribe trigger called ContosoTrigger to the specified events from the trigger defintion through pipeline. + +### Example 3 +```powershell +$trigger = Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger +$trigger | Remove-AzSynapseTriggerSubscription +``` + +This command will unsubscribe trigger called ContosoTrigger to the specified events from the trigger defintion through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The trigger object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: TriggerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseWorkspace.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseWorkspace.md new file mode 100644 index 0000000000..85cfddc191 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseWorkspace.md @@ -0,0 +1,228 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapseworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseWorkspace.md +--- + +# Remove-AzSynapseWorkspace + +## SYNOPSIS +Deletes a Synapse Analytics workspace. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzSynapseWorkspace [-ResourceGroupName <String>] -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzSynapseWorkspace -InputObject <PSSynapseWorkspace> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzSynapseWorkspace -ResourceId <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseWorkspace** cmdlet permanently deletes an Azure Synapse Analytics workspace. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseWorkspace -Name ContosoWorkspace +``` + +This command deletes an Azure Synapse Analytics workspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseWorkspace +``` + +This command deletes an Azure Synapse Analytics workspace through pipeline. + +### Example 3 +```powershell +Remove-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace +``` + +This command deletes an Azure Synapse Analytics workspace through pipeline with the specified resource ID. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseWorkspaceKey.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseWorkspaceKey.md new file mode 100644 index 0000000000..25e1621297 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseWorkspaceKey.md @@ -0,0 +1,269 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapseworkspacekey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseWorkspaceKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseWorkspaceKey.md +--- + +# Remove-AzSynapseWorkspaceKey + +## SYNOPSIS +Deletes a workspace key. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Remove-AzSynapseWorkspaceKey [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-PassThru] + [-AsJob] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByParentObjectParameterSet +``` +Remove-AzSynapseWorkspaceKey -Name <String> -WorkspaceObject <PSSynapseWorkspace> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Remove-AzSynapseWorkspaceKey -InputObject <PSWorkspaceKey> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByResourceIdParameterSet +``` +Remove-AzSynapseWorkspaceKey -ResourceId <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseWorkspaceKey** removes a workspace key + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace -Name ContosoKeyName +``` + +This command deletes a workspace key under an Azure Synapse Analytics workspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseWorkspaceKey -Name ContosoKeyName +``` + +This command deletes a workspace key under an Azure Synapse Analytics workspace through pipeline. + +### Example 3 +```powershell +Remove-AzSynapseWorkspaceKey -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/keys/ContosoKeyName +``` + +This command deletes an Azure Synapse Analytics workspace key through pipeline with the specified resource ID. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Workspace key input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.WorkspaceKey.PSWorkspaceKey +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The workspace encryption key name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet, DeleteByParentObjectParameterSet +Aliases: KeyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: DeleteByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: DeleteByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.WorkspaceKey.PSWorkspaceKey + +### System.String + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Remove-AzSynapseWorkspacePackage.md b/azps-10.1.0/Az.Synapse/Remove-AzSynapseWorkspacePackage.md new file mode 100644 index 0000000000..a03271c2f6 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Remove-AzSynapseWorkspacePackage.md @@ -0,0 +1,224 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/remove-azsynapseworkspacepackage +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseWorkspacePackage.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Remove-AzSynapseWorkspacePackage.md +--- + +# Remove-AzSynapseWorkspacePackage + +## SYNOPSIS +Deletes a workspace package. + +## SYNTAX + +### RemoveByName (Default) +``` +Remove-AzSynapseWorkspacePackage -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Remove-AzSynapseWorkspacePackage -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Remove-AzSynapseWorkspacePackage -InputObject <PSSynapseWorkspacePackage> [-PassThru] [-AsJob] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseWorkspacePackage** removes a workspace package + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace -Name ContosoPackageName +``` + +This command deletes a workspace package under an Azure Synapse Analytics workspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Remove-AzSynapseWorkspacePackage -Name ContosoPackageName +``` + +This command deletes a workspace package under an Azure Synapse Analytics workspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The workspace package object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The workspace package name. + +```yaml +Type: System.String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: PackageName, Package + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Reset-AzSynapseSparkSessionTimeout.md b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSparkSessionTimeout.md new file mode 100644 index 0000000000..ba15c45c0c --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSparkSessionTimeout.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/reset-azsynapsesparksessiontimeout +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSparkSessionTimeout.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSparkSessionTimeout.md +--- + +# Reset-AzSynapseSparkSessionTimeout + +## SYNOPSIS +Resets timeout of a Synapse Analytics Spark session. + +## SYNTAX + +### ResetByNameParameterSet (Default) +``` +Reset-AzSynapseSparkSessionTimeout -WorkspaceName <String> -SparkPoolName <String> -LivyId <Int32> [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResetByParentObjectParameterSet +``` +Reset-AzSynapseSparkSessionTimeout -LivyId <Int32> -SparkPoolObject <PSSynapseSparkPool> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResetByInputObjectParameterSet +``` +Reset-AzSynapseSparkSessionTimeout -InputObject <PSSynapseSparkSession> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzSynapseSparkSessionTimeout** cmdlet resets timeout of a Synapse Analytics Spark session. + +## EXAMPLES + +### Example 1 +```powershell +Reset-AzSynapseSparkSessionTimeout -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 125 +``` + +This command resets timeout of the Synapse Analytics Spark session with the specified livy ID. + +### Example 2 +```powershell +$pool = Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool +$pool | Reset-AzSynapseSparkSessionTimeout -LivyId 125 +``` + +This command resets timeout of the Synapse Analytics Spark session with the specified livy ID through pipeline. + +### Example 3 +```powershell +$session = Get-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 125 +$session | Reset-AzSynapseSparkSessionTimeout +``` + +This command resets timeout of the Synapse Analytics Spark session with the specified livy ID through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Spark session input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkSession +Parameter Sets: ResetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LivyId +Identifier of Spark session. + +```yaml +Type: System.Int32 +Parameter Sets: ResetByNameParameterSet, ResetByParentObjectParameterSet +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolName +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: ResetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolObject +Spark pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool +Parameter Sets: ResetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ResetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkSession + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..130aab0a92 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlAdvancedThreatProtectionSetting.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/reset-azsynapsesqladvancedthreatprotectionsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSqlAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSqlAdvancedThreatProtectionSetting.md +--- + +# Reset-AzSynapseSqlAdvancedThreatProtectionSetting + +## SYNOPSIS +Removes the advanced threat protection settings from a workspace. + +## SYNTAX + +### ClearByNameParameterSet (Default) +``` +Reset-AzSynapseSqlAdvancedThreatProtectionSetting [-ResourceGroupName <String>] -WorkspaceName <String> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClearByInputObjectParameterSet +``` +Reset-AzSynapseSqlAdvancedThreatProtectionSetting -InputObject <PSSynapseWorkspace> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClearByResourceIdParameterSet +``` +Reset-AzSynapseSqlAdvancedThreatProtectionSetting -ResourceId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Reset-AzSynapseSqlAdvancedThreatProtectionSetting** cmdlet removes the advanced threat protection settings from an Azure Synapse Analytics Workspace. + +## EXAMPLES + +### Example 1 +```powershell +Reset-AzSynapseSqlAdvancedThreatProtectionSetting -WorkspaceName ContosoWorkspace +``` + +This command removes the advanced threat protection settings from a workspace named ContosoWorkspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: ClearByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ClearByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlAuditSetting.md b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlAuditSetting.md new file mode 100644 index 0000000000..f7141475a0 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlAuditSetting.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/reset-azsynapsesqlauditsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSqlAuditSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSqlAuditSetting.md +--- + +# Reset-AzSynapseSqlAuditSetting + +## SYNOPSIS +Removes the auditing settings of an Azure Synapse Analytics Workspace. + +## SYNTAX + +### WorkspaceParameterSet (Default) +``` +Reset-AzSynapseSqlAuditSetting [[-ResourceGroupName] <String>] [-WorkspaceName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WorkspaceObjectParameterSet +``` +Reset-AzSynapseSqlAuditSetting -WorkspaceObject <PSSynapseWorkspace> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WorkspaceResourceIdParameterSetName +``` +Reset-AzSynapseSqlAuditSetting -ResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Reset-AzSynapseSqlAuditSetting** cmdlet removes the auditing settings of an Azure Synapse Analytics Workspace. + +## EXAMPLES + +### Example 1 +```powershell +Reset-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace +``` + +This command removes the auditing settings of an Azure Synapse Analytics Workspace named ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseWorkspace -Name ContosoWorkspace | Reset-AzSynapseSqlAuditSetting +``` + +This command removes the auditing settings of an Azure Synapse Analytics Workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: WorkspaceParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: WorkspaceResourceIdParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: WorkspaceParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: WorkspaceObjectParameterSet +Aliases: InputObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..62e1aef942 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/reset-azsynapsesqlpooladvancedthreatprotectionsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md +--- + +# Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting + +## SYNOPSIS +Removes the advanced threat protection settings from a SQL pool. + +## SYNTAX + +### ClearByNameParameterSet (Default) +``` +Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ClearByParentObjectParameterSet +``` +Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting -Name <String> -WorkspaceObject <PSSynapseWorkspace> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClearByInputObjectParameterSet +``` +Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting -InputObject <PSSynapseSqlPool> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClearByResourceIdParameterSet +``` +Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting -ResourceId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting** cmdlet removes the advanced threat protection settings from an Azure Synapse Analytics SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +``` + +This command removes the advanced threat protection settings from a SQL pool named ContosoSqlPool under the workspace named ContosoWorkspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: ClearByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet, ClearByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: ClearByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: ClearByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlPoolAuditSetting.md b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlPoolAuditSetting.md new file mode 100644 index 0000000000..047f295741 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlPoolAuditSetting.md @@ -0,0 +1,213 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/reset-azsynapsesqlpoolauditsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSqlPoolAuditSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSqlPoolAuditSetting.md +--- + +# Reset-AzSynapseSqlPoolAuditSetting + +## SYNOPSIS +Removes the auditing settings of an Azure Synapse Analytics SQL pool. + +## SYNTAX + +### SqlPoolParameterSet (Default) +``` +Reset-AzSynapseSqlPoolAuditSetting [[-ResourceGroupName] <String>] [-WorkspaceName] <String> + -SqlPoolName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlPoolParentObjectParameterSet +``` +Reset-AzSynapseSqlPoolAuditSetting -WorkspaceObject <PSSynapseWorkspace> -SqlPoolName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlPoolObjectParameterSet +``` +Reset-AzSynapseSqlPoolAuditSetting -SqlPoolObject <PSSynapseSqlPool> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlPoolResourceIdParameterSet +``` +Reset-AzSynapseSqlPoolAuditSetting -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Reset-AzSynapseSqlPoolAuditSetting** cmdlet removes the auditing settings of an Azure Synapse Analytics SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +Reset-AzSynapseSqlPoolAuditSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +``` + +This command removes the auditing settings of a SQL pool called ContosoSqlPool in the workspace ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool | Reset-AzSynapseSqlPoolAuditSetting +``` + +This command removes the auditing settings of a SQL pool called ContosoSqlPool in the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: SqlPoolResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlPoolName +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet, SqlPoolParentObjectParameterSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlPoolObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: SqlPoolObjectParameterSet +Aliases: InputObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SqlPoolParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..17a875038b --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md @@ -0,0 +1,246 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/reset-azsynapsesqlpoolvulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md +--- + +# Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting + +## SYNOPSIS +Clears the vulnerability assessment settings of a SQL pool. + +## SYNTAX + +### ClearByNameParameterSet (Default) +``` +Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### ClearByParentObjectParameterSet +``` +Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting -Name <String> -WorkspaceObject <PSSynapseWorkspace> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClearByInputObjectParameterSet +``` +Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting -InputObject <PSSynapseSqlPool> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClearByResourceIdParameterSet +``` +Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting -ResourceId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting** cmdlet removes the vulnerability assessment settings of an Azure Synapse Analytics SQL pool. +Note that you need to run *Enable-AzSynapseSqlAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +``` + +This command clears the vulnerability assessment settings of a SQL pool named ContosoSqlPool. + +### Example 2 +```powershell +Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool | Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting +``` + +This command clears the vulnerability assessment settings of a SQL pool named ContosoSqlPool through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: ClearByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet, ClearByParentObjectParameterSet +Aliases: SqlPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: ClearByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: ClearByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..556befcc13 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Reset-AzSynapseSqlVulnerabilityAssessmentSetting.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/reset-azsynapsesqlvulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSqlVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Reset-AzSynapseSqlVulnerabilityAssessmentSetting.md +--- + +# Reset-AzSynapseSqlVulnerabilityAssessmentSetting + +## SYNOPSIS +Clears the vulnerability assessment settings of a workspace. + +## SYNTAX + +### ClearByNameParameterSet (Default) +``` +Reset-AzSynapseSqlVulnerabilityAssessmentSetting [-ResourceGroupName <String>] -WorkspaceName <String> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClearByInputObjectParameterSet +``` +Reset-AzSynapseSqlVulnerabilityAssessmentSetting -InputObject <PSSynapseWorkspace> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ClearByResourceIdParameterSet +``` +Reset-AzSynapseSqlVulnerabilityAssessmentSetting -ResourceId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Reset-AzSynapseSqlVulnerabilityAssessmentSetting** cmdlet removes the vulnerability assessment settings of an Azure Synapse Analytics Workspace. +Before updates the settings, you need to enable the Azure defender for SQL. + +## EXAMPLES + +### Example 1 +```powershell +Reset-AzSynapseSqlVulnerabilityAssessmentSetting -WorkspaceName ContosoWorkspace +``` + +Clears the vulnerability assessment settings of an Azure Synapse Analytics Workspace named ContosoWorkspace. + +### Example 2 +```powershell +Get-AzSynapseWorkspace -Name ContosoWorkspace | Reset-AzSynapseSqlVulnerabilityAssessmentSetting +``` + +Clears the vulnerability assessment settings of an Azure Synapse Analytics Workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: ClearByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ClearByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ClearByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Restore-AzSynapseSqlPool.md b/azps-10.1.0/Az.Synapse/Restore-AzSynapseSqlPool.md new file mode 100644 index 0000000000..4bee53b240 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Restore-AzSynapseSqlPool.md @@ -0,0 +1,402 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/restore-azsynapsesqlpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Restore-AzSynapseSqlPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Restore-AzSynapseSqlPool.md +--- + +# Restore-AzSynapseSqlPool + +## SYNOPSIS +Restores a Synapse Analytics SQL pool. + +## SYNTAX + +### RestoreFromBackupIdByNameParameterSet (Default) +``` +Restore-AzSynapseSqlPool [-FromBackup] [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + -ResourceId <String> [-Tag <Hashtable>] [-StorageAccountType <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RestoreFromBackupIdByParentObjectParameterSet +``` +Restore-AzSynapseSqlPool [-FromBackup] -WorkspaceObject <PSSynapseWorkspace> -Name <String> + -ResourceId <String> [-Tag <Hashtable>] [-StorageAccountType <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RestoreFromRestorePointIdByNameParameterSet +``` +Restore-AzSynapseSqlPool [-FromRestorePoint] [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> -PerformanceLevel <String> -ResourceId <String> -RestorePoint <DateTime> [-Tag <Hashtable>] + [-StorageAccountType <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RestoreFromRestorePointIdByParentObjectParameterSet +``` +Restore-AzSynapseSqlPool [-FromRestorePoint] -WorkspaceObject <PSSynapseWorkspace> -Name <String> + -PerformanceLevel <String> -ResourceId <String> -RestorePoint <DateTime> [-Tag <Hashtable>] + [-StorageAccountType <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### RestoreFromDroppedSqlPoolByNameParameterSet +``` +Restore-AzSynapseSqlPool [-FromDroppedSqlPool] [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> -ResourceId <String> -DeletionDate <DateTime> [-Tag <Hashtable>] [-StorageAccountType <String>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RestoreFromDroppedSqlPoolByParentObjectParameterSet +``` +Restore-AzSynapseSqlPool [-FromDroppedSqlPool] -WorkspaceObject <PSSynapseWorkspace> -Name <String> + -ResourceId <String> -DeletionDate <DateTime> [-Tag <Hashtable>] [-StorageAccountType <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzSynapseSqlPool** cmdlet restores an Azure Synapse Analytics SQL pool from a geo-redundant backup, a backup of a deleted SQL pool or a restore point of any SQL pool. +The restored SQL pool is created as a new SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +# Transform Synapse SQL pool resource ID to SQL database ID because +# currently the command only accepts the SQL databse ID. For example: /subscriptions/<SubscriptionId>/resourceGroups/<ResourceGroupName>/providers/Microsoft.Sql/servers/<WorkspaceName>/databases/<DatabaseName> +$pool = Get-AzSynapseSqlPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +$databaseId = $pool.Id -replace "Microsoft.Synapse", "Microsoft.Sql" ` + -replace "workspaces", "servers" ` + -replace "sqlPools", "databases" + +# Get the latest restore point +$restorePoint = $pool | Get-AzSynapseSqlPoolRestorePoint | Select-Object -Last 1 + +# Restore to same workspace with source SQL pool +$restoredPool = Restore-AzSynapseSqlPool -FromRestorePoint -RestorePoint $restorePoint.RestorePointCreationDate -TargetSqlPoolName ContosoRestoredSqlPool -ResourceGroupName $pool.ResourceGroupName -WorkspaceName $pool.WorkspaceName -ResourceId $databaseId -PerformanceLevel DW200c +``` + +This command creates an Azure Synapse Analytics SQL pool by leveraging a restore point from any existing SQL pool to recover or copy from a previous state. + +### Example 2 +```powershell +# Transform Synapse SQL pool resource ID to SQL database ID because +# currently the command only accepts the SQL databse ID. For example: /subscriptions/<SubscriptionId>/resourceGroups/<ResourceGroupName>/providers/Microsoft.Sql/servers/<WorkspaceName>/recoverabledatabases/<DatabaseName> +$pool = Get-AzSynapseSqlPoolGeoBackup -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +$databaseId = $pool.Id -replace "Microsoft.Synapse", "Microsoft.Sql" ` + -replace "workspaces", "servers" + +# Restore to same workspace with source SQL pool +$restoredPool = Restore-AzSynapseSqlPool -FromBackup -TargetSqlPoolName ContosoRestoredSqlPool -ResourceGroupName $pool.ResourceGroupName -WorkspaceName $pool.WorkspaceName -ResourceId $databaseId +``` + +This command creates an Azure Synapse Analytics SQL pool which restores from the SQL pool backup. + +### Example 3 +```powershell +# Transform Synapse dropped SQL pool resource ID to SQL pool resource ID +$pool = Get-AzSynapseDroppedSqlPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +$poolId = $pool.Id.Split(",")[0] +$poolId = $poolId -replace "restorableDroppedSqlPools", "sqlPools" + +# Restore to same workspace with source SQL pool +$restoredPool = Restore-AzSynapseSqlPool -FromDroppedSqlPool -DeletionDate $pool.DeletionDate -TargetSqlPoolName ContosoRestoredSqlPool -ResourceGroupName $pool.ResourceGroupName -WorkspaceName $pool.WorkspaceName -ResourceId $poolId +``` + +This command creates an Azure Synapse Analytics SQL pool which restores from the deleted SQL pool backup. + +### Example 4 +```powershell +# Transform Synapse SQL pool resource ID to SQL database ID because +# currently the command only accepts the SQL databse ID. For example: /subscriptions/<SubscriptionId>/resourceGroups/<ResourceGroupName>/providers/Microsoft.Sql/servers/<WorkspaceName>/databases/<DatabaseName> +$pool = Get-AzSynapseSqlPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +$databaseId = $pool.Id -replace "Microsoft.Synapse", "Microsoft.Sql" ` + -replace "workspaces", "servers" ` + -replace "sqlPools", "databases" + +# Get the latest restore point +$restorePoint = $pool | Get-AzSynapseSqlPoolRestorePoint | Select-Object -Last 1 + +# Restore to same workspace with source SQL pool +$restoredPool = Restore-AzSynapseSqlPool -FromRestorePoint -RestorePoint $restorePoint.RestorePointCreationDate -TargetSqlPoolName ContosoRestoredSqlPool -ResourceGroupName $pool.ResourceGroupName -WorkspaceName $pool.WorkspaceName -ResourceId $databaseId -PerformanceLevel DW200c -Tag @{"tagName" = "tagValue"} -StorageAccountType LRS +``` + +This command creates an Azure Synapse Analytics SQL pool with specified tags and storage account type by leveraging a restore point from any existing SQL pool to recover or copy from a previous state. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletionDate +The deletion date of the Azure Synaspe SQL Database to retrieve backups for, with millisecond precision (e.g. 2016-02-23T00:21:22.847Z) + +```yaml +Type: System.DateTime +Parameter Sets: RestoreFromDroppedSqlPoolByNameParameterSet, RestoreFromDroppedSqlPoolByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromBackup +Indicates to restore from the most recent backup of any SQL pool in this subscription. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RestoreFromBackupIdByNameParameterSet, RestoreFromBackupIdByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromDroppedSqlPool +Indicates to leverage a restore point from any SQL pool in this subscription to recover or copy from a previous state. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RestoreFromDroppedSqlPoolByNameParameterSet, RestoreFromDroppedSqlPoolByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromRestorePoint +Indicates to leverage a restore point from any SQL pool in this subscription to recover or copy from a previous state. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RestoreFromRestorePointIdByNameParameterSet, RestoreFromRestorePointIdByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TargetSqlPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PerformanceLevel +The SQL Service tier and performance level to assign to the SQL pool. +For example, DW2000c. + +```yaml +Type: System.String +Parameter Sets: RestoreFromRestorePointIdByNameParameterSet, RestoreFromRestorePointIdByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: RestoreFromBackupIdByNameParameterSet, RestoreFromRestorePointIdByNameParameterSet, RestoreFromDroppedSqlPoolByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource ID of the database to restore. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestorePoint +Snapshot time to restore. + +```yaml +Type: System.DateTime +Parameter Sets: RestoreFromRestorePointIdByNameParameterSet, RestoreFromRestorePointIdByParentObjectParameterSet +Aliases: PointInTime + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountType +The storage account type used to store backups for the sql pool. Possible values include: 'GRS', 'LRS'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A string,string dictionary of tags associated with the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RestoreFromBackupIdByNameParameterSet, RestoreFromRestorePointIdByNameParameterSet, RestoreFromDroppedSqlPoolByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RestoreFromBackupIdByParentObjectParameterSet, RestoreFromRestorePointIdByParentObjectParameterSet, RestoreFromDroppedSqlPoolByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Resume-AzSynapseSqlPool.md b/azps-10.1.0/Az.Synapse/Resume-AzSynapseSqlPool.md new file mode 100644 index 0000000000..e0d6163611 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Resume-AzSynapseSqlPool.md @@ -0,0 +1,237 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/resume-azsynapsesqlpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Resume-AzSynapseSqlPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Resume-AzSynapseSqlPool.md +--- + +# Resume-AzSynapseSqlPool + +## SYNOPSIS +Resumes a Synapse Analytics SQL pool. + +## SYNTAX + +### ResumeByNameParameterSet (Default) +``` +Resume-AzSynapseSqlPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResumeByParentObjectParameterSet +``` +Resume-AzSynapseSqlPool -Name <String> -WorkspaceObject <PSSynapseWorkspace> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResumeByInputObjectParameterSet +``` +Resume-AzSynapseSqlPool -InputObject <PSSynapseSqlPool> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResumeByResourceIdParameterSet +``` +Resume-AzSynapseSqlPool -ResourceId <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Resume-AzSynapseSqlPool** cmdlet resumes an Azure Synapse Analytics SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +Resume-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +``` + +This command resumes a suspended Azure Synapse Analytics SQL pool. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: ResumeByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: ResumeByNameParameterSet, ResumeByParentObjectParameterSet +Aliases: SqlPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ResumeByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: ResumeByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ResumeByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: ResumeByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseDataFlow.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseDataFlow.md new file mode 100644 index 0000000000..7bc7813147 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseDataFlow.md @@ -0,0 +1,178 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsedataflow +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseDataFlow.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseDataFlow.md +--- + +# Set-AzSynapseDataFlow + +## SYNOPSIS +Creates or updates a data flow in workspace. + +## SYNTAX + +### SetByName (Default) +``` +Set-AzSynapseDataFlow -WorkspaceName <String> -Name <String> -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByObject +``` +Set-AzSynapseDataFlow -WorkspaceObject <PSSynapseWorkspace> -Name <String> -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseDataFlow** cmdlet creates a data flow or updates an existing data flow in workspace. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapseDataFlow -WorkspaceName ContosoWorkspace -Name ContosoDataFlow -DefinitionFile "C:\\samples\\DataFlow.json" +``` + +This command creates a data flow named ContosoDataFlow in the workspace named ContosoWorkspace. +The command bases the data flow on information in the DataFlow.json file. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The data flow name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DataFlowName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSDataFlowResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseDataset.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseDataset.md new file mode 100644 index 0000000000..ce04efaad1 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseDataset.md @@ -0,0 +1,178 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsedataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseDataset.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseDataset.md +--- + +# Set-AzSynapseDataset + +## SYNOPSIS +Creates or updates a dataset in workspace. + +## SYNTAX + +### SetByName (Default) +``` +Set-AzSynapseDataset -WorkspaceName <String> -Name <String> -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByObject +``` +Set-AzSynapseDataset -WorkspaceObject <PSSynapseWorkspace> -Name <String> -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseDataset** cmdlet creates a dataset or updates an existing dataset in workspace. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapseDataset -WorkspaceName ContosoWorkspace -Name ContosoDataset -DefinitionFile "C:\\samples\\Dataset.json" +``` + +This command creates a dataset named ContosoDataset in the workspace named ContosoWorkspace. +The command bases the dataset on information in the Dataset.json file. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The dataset name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DatasetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSDatasetResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseIntegrationRuntime.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseIntegrationRuntime.md new file mode 100644 index 0000000000..0435d4cf90 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseIntegrationRuntime.md @@ -0,0 +1,651 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapseintegrationruntime +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseIntegrationRuntime.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseIntegrationRuntime.md +--- + +# Set-AzSynapseIntegrationRuntime + +## SYNOPSIS +Updates an integration runtime. + +## SYNTAX + +### SetByIntegrationRuntimeName (Default) +``` +Set-AzSynapseIntegrationRuntime [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + [-Type <String>] [-Description <String>] [-Location <String>] [-NodeSize <String>] [-NodeCount <Int32>] + [-CatalogServerEndpoint <String>] [-CatalogAdminCredential <PSCredential>] [-CatalogPricingTier <String>] + [-VNetId <String>] [-Subnet <String>] [-PublicIP <String[]>] [-DataFlowComputeType <String>] + [-DataFlowCoreCount <Int32>] [-DataFlowTimeToLive <Int32>] [-SetupScriptContainerSasUri <String>] + [-Edition <String>] [-ExpressCustomSetup <ArrayList>] [-DataProxyIntegrationRuntimeName <String>] + [-DataProxyStagingLinkedServiceName <String>] [-DataProxyStagingPath <String>] + [-MaxParallelExecutionsPerNode <Int32>] [-LicenseType <String>] [-AuthKey <SecureString>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLinkedIntegrationRuntimeName +``` +Set-AzSynapseIntegrationRuntime [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + [-Type <String>] [-Description <String>] -SharedIntegrationRuntimeResourceId <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByParentObject +``` +Set-AzSynapseIntegrationRuntime -Name <String> -WorkspaceObject <PSSynapseWorkspace> [-Type <String>] + [-Description <String>] [-Location <String>] [-NodeSize <String>] [-NodeCount <Int32>] + [-CatalogServerEndpoint <String>] [-CatalogAdminCredential <PSCredential>] [-CatalogPricingTier <String>] + [-VNetId <String>] [-Subnet <String>] [-PublicIP <String[]>] [-DataFlowComputeType <String>] + [-DataFlowCoreCount <Int32>] [-DataFlowTimeToLive <Int32>] [-SetupScriptContainerSasUri <String>] + [-Edition <String>] [-ExpressCustomSetup <ArrayList>] [-DataProxyIntegrationRuntimeName <String>] + [-DataProxyStagingLinkedServiceName <String>] [-DataProxyStagingPath <String>] + [-MaxParallelExecutionsPerNode <Int32>] [-LicenseType <String>] [-AuthKey <SecureString>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLinkedIntegrationRuntimeParentObject +``` +Set-AzSynapseIntegrationRuntime -Name <String> -WorkspaceObject <PSSynapseWorkspace> [-Type <String>] + [-Description <String>] -SharedIntegrationRuntimeResourceId <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceId +``` +Set-AzSynapseIntegrationRuntime -ResourceId <String> [-Type <String>] [-Description <String>] + [-Location <String>] [-NodeSize <String>] [-NodeCount <Int32>] [-CatalogServerEndpoint <String>] + [-CatalogAdminCredential <PSCredential>] [-CatalogPricingTier <String>] [-VNetId <String>] [-Subnet <String>] + [-PublicIP <String[]>] [-DataFlowComputeType <String>] [-DataFlowCoreCount <Int32>] + [-DataFlowTimeToLive <Int32>] [-SetupScriptContainerSasUri <String>] [-Edition <String>] + [-ExpressCustomSetup <ArrayList>] [-DataProxyIntegrationRuntimeName <String>] + [-DataProxyStagingLinkedServiceName <String>] [-DataProxyStagingPath <String>] + [-MaxParallelExecutionsPerNode <Int32>] [-LicenseType <String>] [-AuthKey <SecureString>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLinkedIntegrationRuntimeResourceId +``` +Set-AzSynapseIntegrationRuntime -ResourceId <String> [-Type <String>] [-Description <String>] + -SharedIntegrationRuntimeResourceId <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetByIntegrationRuntimeObject +``` +Set-AzSynapseIntegrationRuntime -InputObject <PSIntegrationRuntime> [-Type <String>] [-Description <String>] + [-Location <String>] [-NodeSize <String>] [-NodeCount <Int32>] [-CatalogServerEndpoint <String>] + [-CatalogAdminCredential <PSCredential>] [-CatalogPricingTier <String>] [-VNetId <String>] [-Subnet <String>] + [-PublicIP <String[]>] [-DataFlowComputeType <String>] [-DataFlowCoreCount <Int32>] + [-DataFlowTimeToLive <Int32>] [-SetupScriptContainerSasUri <String>] [-Edition <String>] + [-ExpressCustomSetup <ArrayList>] [-DataProxyIntegrationRuntimeName <String>] + [-DataProxyStagingLinkedServiceName <String>] [-DataProxyStagingPath <String>] + [-MaxParallelExecutionsPerNode <Int32>] [-LicenseType <String>] [-AuthKey <SecureString>] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByLinkedIntegrationRuntimeObject +``` +Set-AzSynapseIntegrationRuntime -InputObject <PSIntegrationRuntime> [-Type <String>] [-Description <String>] + -SharedIntegrationRuntimeResourceId <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseIntegrationRuntime** cmdlet updates an integration runtime with specific parameters. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -Name 'test-selfhost-ir' -Description 'New description' +``` + +The cmdlet updates the description of integration runtime named 'test-selfhost-ir'. + +### Example 2 +```powershell +Set-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -Name 'test-selfhost-ir' ` + -SharedIntegrationRuntimeResourceId '/subscriptions/b3ee3a7f-7614-4644-ad07-afa832620b4b/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir' -Type "SelfHosted" +``` + +The cmdlet adds the workspace to use the shared integration runtime. When using `-SharedIntegrationRuntimeResourceId` parameter the `-Type` must also be included. Note that the workspace need to be granted permission to use the integration runtime before running cmdlet. + +## PARAMETERS + +### -AuthKey +The authentication key of the self-hosted integration runtime. + +```yaml +Type: System.Security.SecureString +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CatalogAdminCredential +The catalog database administrator credential of the integration runtime. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CatalogPricingTier +The catalog database pricing tier of the integration runtime. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CatalogServerEndpoint +The catalog database server endpoint of the integration runtime. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFlowComputeType +Compute type of the data flow cluster which will execute data flow job. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFlowCoreCount +Core count of the data flow cluster which will execute data flow job. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFlowTimeToLive +Time to live (in minutes) setting of the data flow cluster which will execute data flow job. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataProxyIntegrationRuntimeName +The Self-Hosted Integration Runtime name which is used as a proxy. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataProxyStagingLinkedServiceName +The Azure Blob Storage Linked Service name that references the staging data store to be used when moving data between Self-Hosted and Azure-SSIS Integration Runtime. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataProxyStagingPath +The path in staging data store to be used when moving data between Self-Hosted and Azure-SSIS Integration Runtimes, a default container will be used if unspecified. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The integration runtime description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Edition +The edition for SSIS integration runtime which could be Standard or Enterprise, default is Standard if it is not specified. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: +Accepted values: Standard, Enterprise + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressCustomSetup +The express custom setup for SSIS integration runtime which could be used to setup configurations and 3rd party components without custom setup script. + +```yaml +Type: System.Collections.ArrayList +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: SetByIntegrationRuntimeObject, SetByLinkedIntegrationRuntimeObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LicenseType +The license type that you want to select for the SSIS IR. +There are two types: LicenseIncluded or BasePrice. +If you are qualified for the Azure Hybrid Use Benefit (AHUB) pricing, please select BasePrice. +If not, please select LicenseIncluded. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: +Accepted values: LicenseIncluded, BasePrice + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The integration runtime description. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxParallelExecutionsPerNode +Maximum parallel execution count per node for a managed dedicated integration runtime. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByLinkedIntegrationRuntimeName, SetByParentObject, SetByLinkedIntegrationRuntimeParentObject +Aliases: IntegrationRuntimeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeCount +Target nodes count of the integration runtime. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeSize +The integration runtime node size. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicIP +The static public IP addresses which the integration runtime will use. + +```yaml +Type: System.String[] +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: PublicIPs + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByLinkedIntegrationRuntimeName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: SetByResourceId, SetByLinkedIntegrationRuntimeResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetupScriptContainerSasUri +The SAS URI of the Azure blob container that contains the custom setup script. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedIntegrationRuntimeResourceId +The resource id of the shared self-hosted integration runtime. + +```yaml +Type: System.String +Parameter Sets: SetByLinkedIntegrationRuntimeName, SetByLinkedIntegrationRuntimeParentObject, SetByLinkedIntegrationRuntimeResourceId, SetByLinkedIntegrationRuntimeObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +The name of the subnet in the VNet. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: SubnetName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The integration runtime type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Managed, SelfHosted + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VNetId +The ID of the VNet which the integration runtime will join. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByParentObject, SetByResourceId, SetByIntegrationRuntimeObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByIntegrationRuntimeName, SetByLinkedIntegrationRuntimeName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByParentObject, SetByLinkedIntegrationRuntimeParentObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseLinkConnection.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseLinkConnection.md new file mode 100644 index 0000000000..dce3bd8f82 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseLinkConnection.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapselinkconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseLinkConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseLinkConnection.md +--- + +# Set-AzSynapseLinkConnection + +## SYNOPSIS +Creates or updates a link connection in workspace. + +## SYNTAX + +### SetByName (Default) +``` +Set-AzSynapseLinkConnection -WorkspaceName <String> -Name <String> -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByObject +``` +Set-AzSynapseLinkConnection -WorkspaceObject <PSSynapseWorkspace> -Name <String> -DefinitionFile <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseLinkConnection** cmdlet creates or updates a link connections in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +<# +linkconnection.json +{ + "name":"sampleLinkConnection", // please change to your link connection name + "properties":{ + "sourceDatabase":{ + "typeProperties":{ // please change to your source database resourceId and principalId + "resourceId":"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/sampleResourceGroup/providers/Microsoft.Sql/servers/sampleServer", + "principalId":"xxxxxxxxxx" + }, + "linkedService":{ + "referenceName":"sampleLinkServiceReference", // please change to your source database link service name + "type":"LinkedServiceReference" + } + }, + "targetDatabase":{ + "linkedService":{ + "referenceName":"sampleLinkServiceReference", // please change to your target database link service name + "type":"LinkedServiceReference", + "parameters":{ + "DBName":"v2" + } + } + }, + "compute":{ + "coreCount":16, + "computeType":"General" + } + } +} +#> +Set-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -DefinitionFile "C:\samples\linkconnection.json" +``` + +This command creates or updates a link connection from definition file linkconnection.json in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Set-AzSynapseLinkConnection -DefinitionFile "C:\samples\linkconnection.json" +``` + +This command creates or updates a link connection from definition file linkconnection.json in the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Synapse link connection name for Azure Sql Database. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: LinkConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: PSSynapseWorkspace +Parameter Sets: SetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkConnectionResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseLinkConnectionLinkTable.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseLinkConnectionLinkTable.md new file mode 100644 index 0000000000..fe5d2d7ee8 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseLinkConnectionLinkTable.md @@ -0,0 +1,247 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapselinkconnectionlinktables +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseLinkConnectionLinkTable.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseLinkConnectionLinkTable.md +--- + +# Set-AzSynapseLinkConnectionLinkTable + +## SYNOPSIS +Edits link tables under a link connection. + +## SYNTAX + +### SetByName (Default) +``` +Set-AzSynapseLinkConnectionLinkTable -WorkspaceName <String> -EditTablesRequestFile <String> + -LinkConnectionName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByObject +``` +Set-AzSynapseLinkConnectionLinkTable -WorkspaceObject <PSSynapseWorkspace> -EditTablesRequestFile <String> + -LinkConnectionName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByInputObject +``` +Set-AzSynapseLinkConnectionLinkTable -EditTablesRequestFile <String> -InputObject <PSLinkConnectionResource> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseLinkConnectionLinkTables** cmdlet edits link tables under a link connection. + +## EXAMPLES + +### Example 1 +```powershell +<# +edittables.json +{ + "linkTables": [ + { + "id": "00000000000000000000000000000000", // please change to your link table Id: a uuid + "source": { + "tableName": "sampleSourceTable", // please change to your source table name + "schemaName": "sampleSourceSchema" // please change to your source database schema name + }, + "target": { + "tableName": "sampleTargetTable", // please change to your target table name + "schemaName": "sampleTargetSchema", // please change to your target database schema name + "distributionOptions": { + "type": "Round_RoBin", // please choose a type from Hash, Round_RoBin, Replicate + "distributionColumn": "sampleColumn" // please change to the column name + } + }, + "operationType": "add" // please choose a value from add, update, remove + } + ] +} +#> +Set-AzSynapseLinkConnectionLinkTable -WorkspaceName ContosoWorkspace -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\samples\edittables.json" +``` + +This command edits link tables under link connection ContosoLinkConnection in workspace ContosoWorkspace. +The command bases the link tables on information in the edittables.json file. +This file includes information about edited link table. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Set-AzSynapseLinkConnectionLinkTable -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\samples\edittables.json" +``` + +This command edits link tables under link connection ContosoLinkConnection in workspace ContosoWorkspace through pipeline. +The command bases the link tables on information in the edittables.json file. +This file includes information about edited link table. + +### Example 3 +```powershell +$lc = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +$lc | Set-AzSynapseLinkConnectionLinkTable -EditTablesRequestFile "C:\samples\edittables.json" +``` + +This command edits link tables under a link connection through pipeline. +The command bases the link tables on information in the edittables.json file. +This file includes information about edited link table. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EditTablesRequestFile +Specifies a local file path for a file to edit link tables + +```yaml +Type: String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The information about the link connection. + +```yaml +Type: PSLinkConnectionResource +Parameter Sets: SetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkConnectionName +Name of link connection. + +```yaml +Type: String +Parameter Sets: SetByName, SetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: PSSynapseWorkspace +Parameter Sets: SetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkConnectionResource + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseLinkedService.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseLinkedService.md new file mode 100644 index 0000000000..51c95e18c3 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseLinkedService.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapselinkedservice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseLinkedService.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseLinkedService.md +--- + +# Set-AzSynapseLinkedService + +## SYNOPSIS +Links a data store or a cloud service to workspace. + +## SYNTAX + +### SetByName (Default) +``` +Set-AzSynapseLinkedService -WorkspaceName <String> -Name <String> -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByObject +``` +Set-AzSynapseLinkedService -WorkspaceObject <PSSynapseWorkspace> -Name <String> -DefinitionFile <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseLinkedService** cmdlet links a data store or a cloud service to workspace. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapseLinkedService -WorkspaceName ContosoWorkspace -Name ContosoLinkedService -DefinitionFile "C:\\samples\\LinkedService.json" +``` + +This command creates a linked service named ContosoLinkedService in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Set-AzSynapseLinkedService -Name ContosoLinkedService -DefinitionFile "C:\\samples\\LinkedService.json" +``` + +This command creates a linked service named ContosoLinkedService in the workspace named ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The linked service name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: LinkedServiceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkedServiceResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseManagedIdentitySqlControlSetting.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseManagedIdentitySqlControlSetting.md new file mode 100644 index 0000000000..3d0414faa1 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseManagedIdentitySqlControlSetting.md @@ -0,0 +1,206 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsemanagedidentitysqlcontrolsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseManagedIdentitySqlControlSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseManagedIdentitySqlControlSetting.md +--- + +# Set-AzSynapseManagedIdentitySqlControlSetting + +## SYNOPSIS +Updates managed identity SQL control settings to workspace. + +## SYNTAX + +### ByNameParameterSet (Default) +``` +Set-AzSynapseManagedIdentitySqlControlSetting [-ResourceGroupName <String>] -WorkspaceName <String> + -Enabled <Boolean> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByParentObjectParameterSet +``` +Set-AzSynapseManagedIdentitySqlControlSetting -WorkspaceObject <PSSynapseWorkspace> -Enabled <Boolean> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ByResourceIdParameterSet +``` +Set-AzSynapseManagedIdentitySqlControlSetting -ResourceId <String> -Enabled <Boolean> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseManagedIdentitySqlControlSetting** updates managed identity SQL control settings to workspace. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapseManagedIdentitySqlControlSetting -WorkspaceName ContosoWorkspace -Enabled $true +``` + +This command enables managed identity SQL control settings to workspace for workspace ContosoWorkspace. + +### Example 2 +```powershell +Set-AzSynapseManagedIdentitySqlControlSetting -WorkspaceName ContosoWorkspace -Enabled $false +``` + +This command disables managed identity SQL control settings to workspace for workspace ContosoWorkspace. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Set-AzSynapseManagedIdentitySqlControlSetting -Enabled $true +``` + +This command enables managed identity SQL control settings to workspace for workspace ContosoWorkspace through pipeline. + +### Example 4 +```powershell +Set-AzSynapseManagedIdentitySqlControlSetting -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd3/resourcegroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace -Enabled $true +``` + +This command enables managed identity SQL control settings to workspace for workspace ContosoWorkspace through the workspace's resource ID. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Indicates whether to enable managed identity SQL control setting. +Specify $True to enable managed identity SQL control setting, or $False to disable managed identity SQL control setting. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: ByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSManagedIdentitySqlControlSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseNotebook.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseNotebook.md new file mode 100644 index 0000000000..28d43eef98 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseNotebook.md @@ -0,0 +1,288 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsenotebook +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseNotebook.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseNotebook.md +--- + +# Set-AzSynapseNotebook + +## SYNOPSIS +Creates or updates a notebook in a workspace. + +## SYNTAX + +### SetByName (Default) +``` +Set-AzSynapseNotebook -WorkspaceName <String> [-Name <String>] [-FolderPath <String>] -DefinitionFile <String> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByNameAndSparkPool +``` +Set-AzSynapseNotebook -WorkspaceName <String> [-Name <String>] [-FolderPath <String>] -SparkPoolName <String> + [-ExecutorSize <String>] -ExecutorCount <Int32> -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByObject +``` +Set-AzSynapseNotebook -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] [-FolderPath <String>] + -DefinitionFile <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByObjectAndSparkPool +``` +Set-AzSynapseNotebook -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] [-FolderPath <String>] + -SparkPoolName <String> [-ExecutorSize <String>] -ExecutorCount <Int32> -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseNotebook** cmdlet creates or updates a notebook in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapseNotebook -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\notebook.ipynb" +``` + +```output +WorkspaceName : ContosoWorkspace + Properties : Microsoft.Azure.Commands.Synapse.Models.PSNotebook + Name : notebook +``` + +This command creates or updates a notebook from notebook file notebook.ipynb in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +Set-AzSynapseNotebook -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\notebook.ipynb" -FolderPath ContosoFolder +``` + +This command creates or updates a notebook from notebook file notebook.ipynb and specify a folder path ContosoFolder where the notebook will be placed in the workspace named ContosoWorkspace. + +### Example 3 +```powershell +Set-AzSynapseNotebook -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\notebook.ipynb" -FolderPath ContosoFolder/SubFolder +``` + +This command creates or updates a notebook from notebook file notebook.ipynb and specify a multi-level folder path ContosoFolder/SubFolder where the notebook will be placed in the workspace named ContosoWorkspace. + +### Example 4 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Set-AzSynapseNotebook -DefinitionFile "C:\\samples\\notebook.ipynb" +``` + +This command creates or updates a notebook from notebook file notebook.ipynb in the workspace named ContosoWorkspace through pipeline. + +### Example 5 +```powershell +Set-AzSynapseNotebook -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\notebook.ipynb" -SparkPoolName ContosoSparkPool -ExecutorCount 2 +``` + +This command creates or updates a notebook from notebook file notebook.ipynb which attaches to ContosoSparkPool and uses 2 executors in the workspace named ContosoWorkspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExecutorCount +Number of executors to be allocated in the specified Spark pool for the job. + +```yaml +Type: System.Int32 +Parameter Sets: SetByNameAndSparkPool, SetByObjectAndSparkPool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExecutorSize +Number of core and memory to be used for executors allocated in the specified Spark pool for the job. + +```yaml +Type: System.String +Parameter Sets: SetByNameAndSparkPool, SetByObjectAndSparkPool +Aliases: +Accepted values: Small, Medium, Large, XLarge, XXLarge, XXXLarge + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FolderPath +The folder that this notebook is in. If specify a multi-level path such as [rootFolder/subFolder], the notebook will appear at the bottom level. If not specified, this notebook will appear at the root level. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The notebook name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: NotebookName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolName +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: SetByNameAndSparkPool, SetByObjectAndSparkPool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByNameAndSparkPool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByObject, SetByObjectAndSparkPool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSNotebookResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapsePipeline.md b/azps-10.1.0/Az.Synapse/Set-AzSynapsePipeline.md new file mode 100644 index 0000000000..a170dc524f --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapsePipeline.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsepipeline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapsePipeline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapsePipeline.md +--- + +# Set-AzSynapsePipeline + +## SYNOPSIS +Creates a pipeline in workspace. + +## SYNTAX + +### SetByName (Default) +``` +Set-AzSynapsePipeline -WorkspaceName <String> -Name <String> -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByObject +``` +Set-AzSynapsePipeline -WorkspaceObject <PSSynapseWorkspace> -Name <String> -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapsePipeline** cmdlet creates a pipeline in workspace. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapsePipeline -WorkspaceName ContosoWorkspace -Name ContosoPipeline -DefinitionFile "C:\pipeline.json" +``` + +This command creates a pipeline named ContosoPipeline in the workspace named ContosoWorkspace. +The command bases the pipeline on information in the pipeline.json file. +This file includes information about activities. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Set-AzSynapsePipeline -Name ContosoPipeline -DefinitionFile "C:\pipeline.json" +``` + +This command creates a pipeline named ContosoPipeline in the workspace named ContosoWorkspace through pipeline. +The command bases the pipeline on information in the pipeline.json file. +This file includes information about activities. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The pipeline name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PipelineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSPipelineResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseSparkJobDefinition.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseSparkJobDefinition.md new file mode 100644 index 0000000000..2e536ac219 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseSparkJobDefinition.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsesparkjobdefinition +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSparkJobDefinition.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSparkJobDefinition.md +--- + +# Set-AzSynapseSparkJobDefinition + +## SYNOPSIS +Creates a Spark job definition in workspace. + +## SYNTAX + +### SetByName (Default) +``` +Set-AzSynapseSparkJobDefinition -WorkspaceName <String> -Name <String> -DefinitionFile <String> + [-FolderPath <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByObject +``` +Set-AzSynapseSparkJobDefinition -WorkspaceObject <PSSynapseWorkspace> -Name <String> -DefinitionFile <String> + [-FolderPath <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseSparkJobDefinition** cmdlet creates a Spark job definition in workspace. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapseSparkJobDefinition -WorkspaceName ContosoWorkspace -Name ContosoSparkJobDefinition -DefinitionFile "C:\sparkJobDefinition.json" +``` + +This command creates a Spark job definition named ContosoSparkJobDefinition in the workspace named ContosoWorkspace. +The command bases the Spark job definition on information in the sparkJobDefinition.json file. + +### Example 2 +```powershell +Set-AzSynapseSparkJobDefinition -WorkspaceName ContosoWorkspace -Name ContosoSparkJobDefinition -DefinitionFile "C:\sparkJobDefinition.json" -FolderPath ContosoFolder +``` + +This command creates a Spark job definition named ContosoSparkJobDefinition and specify a folder path ContosoFolder where the spark job definition will be placed in the workspace named ContosoWorkspace. +The command bases the Spark job definition on information in the sparkJobDefinition.json file. + +### Example 3 +```powershell +Set-AzSynapseSparkJobDefinition -WorkspaceName ContosoWorkspace -Name ContosoSparkJobDefinition -DefinitionFile "C:\sparkJobDefinition.json" -FolderPath ContosoFolder/SubFolder +``` + +This command creates a Spark job definition named ContosoSparkJobDefinition and specify a multi-level folder path ContosoFolder/SubFolder where the spark job definition will be placed in the workspace named ContosoWorkspace. +The command bases the Spark job definition on information in the sparkJobDefinition.json file. + +### Example 4 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Set-AzSynapseSparkJobDefinition -Name ContosoSparkJobDefinition -DefinitionFile "C:\sparkJobDefinition.json" +``` + +This command creates a Spark job definition named ContosoSparkJobDefinition in the workspace named ContosoWorkspace through pipeline. +The command bases the Spark job definition on information in the sparkJobDefinition.json file. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FolderPath +The folder that this Spark job definition is in. If specify a multi-level path such as [rootFolder/subFolder], the Spark job definition will appear at the bottom level. If not specified, this Spark job definition will appear at the root level. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Spark job definition name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SparkJobDefinitionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSparkJobDefinitionResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlActiveDirectoryAdministrator.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlActiveDirectoryAdministrator.md new file mode 100644 index 0000000000..914faabdc0 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlActiveDirectoryAdministrator.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsesqlactivedirectoryadministrator +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlActiveDirectoryAdministrator.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlActiveDirectoryAdministrator.md +--- + +# Set-AzSynapseSqlActiveDirectoryAdministrator + +## SYNOPSIS +Provisions an Azure AD administrator for Synapse Analytics SQL pool. + +## SYNTAX + +### SetByNameAndDisplayNameParameterSet (Default) +``` +Set-AzSynapseSqlActiveDirectoryAdministrator [-ResourceGroupName <String>] -WorkspaceName <String> + -DisplayName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByNameAndObjectIdParameterSet +``` +Set-AzSynapseSqlActiveDirectoryAdministrator [-ResourceGroupName <String>] -WorkspaceName <String> + -ObjectId <Guid> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObjectAndDisplayNameParameterSet +``` +Set-AzSynapseSqlActiveDirectoryAdministrator -InputObject <PSSynapseWorkspace> -DisplayName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByInputObjectAndObjectIdParameterSet +``` +Set-AzSynapseSqlActiveDirectoryAdministrator -InputObject <PSSynapseWorkspace> -ObjectId <Guid> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdAndDisplayNameParameterSet +``` +Set-AzSynapseSqlActiveDirectoryAdministrator -ResourceId <String> -DisplayName <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdAndObjectIdParameterSet +``` +Set-AzSynapseSqlActiveDirectoryAdministrator -ResourceId <String> -ObjectId <Guid> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseSqlActiveDirectoryAdministrator** cmdlet provisions an Azure Active Directory (Azure AD) administrator for Azure Synapse Analytics Workspace in the current subscription. +You can provision only one administrator at a time. +The following members of Azure AD can be provisioned as a Synapse Analytics Workspace administrator: +- Native members of Azure AD +- Federated members of Azure AD +- Imported members from other Azure ADs who are native or federated members +- Azure AD groups created as security groups +Microsoft accounts, such as those in the Outlook.com, Hotmail.com, or Live.com domains, are not supported as administrators. +Other guest accounts, such as those in the Gmail.com or Yahoo.com domains, are not supported as administrators. +We recommend that you provision a dedicated Azure AD group as an administrator. + +The cmdlet may call below Microsoft Graph API according to input parameters: + +* GET /users/{id} +* GET /servicePrincipals/{id} +* GET /groups/{id} + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapseSqlActiveDirectoryAdministrator -WorkspaceName ContosoWorkspace -DisplayName "DBAs" +``` + +This command provisions an Azure AD administrator group named DBAs for the workspace named ContosoWorkspace. + +### Example 2 +```powershell +Set-AzSynapseSqlActiveDirectoryAdministrator -WorkspaceName ContosoWorkspace -ObjectId "40b79501-b343-44ed-9ce7-da4c8cc7353b" +``` + +This command provisions an Azure AD administrator by objectId for the workspace named ContosoWorkspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies the display name of the user or group for whom to grant permissions. +This display name must exist in the active directory associated with the current subscription. + +```yaml +Type: System.String +Parameter Sets: SetByNameAndDisplayNameParameterSet, SetByInputObjectAndDisplayNameParameterSet, SetByResourceIdAndDisplayNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByInputObjectAndDisplayNameParameterSet, SetByInputObjectAndObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ObjectId +Specifies the object ID of the user or group in Azure Active Directory for which to grant permissions. + +```yaml +Type: System.Guid +Parameter Sets: SetByNameAndObjectIdParameterSet, SetByInputObjectAndObjectIdParameterSet, SetByResourceIdAndObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: SetByNameAndDisplayNameParameterSet, SetByNameAndObjectIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdAndDisplayNameParameterSet, SetByResourceIdAndObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByNameAndDisplayNameParameterSet, SetByNameAndObjectIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSWorkspaceAadAdminInfo + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlAuditSetting.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlAuditSetting.md new file mode 100644 index 0000000000..a10c4cc4d5 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlAuditSetting.md @@ -0,0 +1,465 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsesqlauditsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlAuditSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlAuditSetting.md +--- + +# Set-AzSynapseSqlAuditSetting + +## SYNOPSIS +Changes the auditing settings of an Azure Synapse Analytics Workspace. + +## SYNTAX + +### WorkspaceParameterSet (Default) +``` +Set-AzSynapseSqlAuditSetting [-AuditActionGroup <AuditActionGroups[]>] [-PredicateExpression <String>] + [-StorageKeyType <String>] [-RetentionInDays <UInt32>] [-BlobStorageTargetState <String>] + [-StorageAccountResourceId <String>] [-EventHubTargetState <String>] [-EventHubName <String>] + [-EventHubAuthorizationRuleResourceId <String>] [-LogAnalyticsTargetState <String>] + [-WorkspaceResourceId <String>] [-PassThru] [[-ResourceGroupName] <String>] [-WorkspaceName] <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WorkspaceObjectParameterSet +``` +Set-AzSynapseSqlAuditSetting [-AuditActionGroup <AuditActionGroups[]>] [-PredicateExpression <String>] + [-StorageKeyType <String>] [-RetentionInDays <UInt32>] [-BlobStorageTargetState <String>] + [-StorageAccountResourceId <String>] [-EventHubTargetState <String>] [-EventHubName <String>] + [-EventHubAuthorizationRuleResourceId <String>] [-LogAnalyticsTargetState <String>] + [-WorkspaceResourceId <String>] [-PassThru] -WorkspaceObject <PSSynapseWorkspace> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WorkspaceResourceIdParameterSetName +``` +Set-AzSynapseSqlAuditSetting [-AuditActionGroup <AuditActionGroups[]>] [-PredicateExpression <String>] + [-StorageKeyType <String>] [-RetentionInDays <UInt32>] [-BlobStorageTargetState <String>] + [-StorageAccountResourceId <String>] [-EventHubTargetState <String>] [-EventHubName <String>] + [-EventHubAuthorizationRuleResourceId <String>] [-LogAnalyticsTargetState <String>] + [-WorkspaceResourceId <String>] [-PassThru] -ResourceId <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseSqlAuditSetting** cmdlet changes the auditing settings of an Azure Synapse Analytics Workspace. +When blob storage is a destination for audit logs, specify the *StorageAccountResourceId* parameter to determine the storage account for the audit logs and the *StorageKeyType* parameter to define the storage keys. You can also define retention for the audit logs by setting the value of the *RetentionInDays* parameter to define the period for the audit logs. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -StorageKeyType Primary +``` + +Enable the blob storage auditing policy of an Azure Synapse Analytics Workspace named ContosoWorkspace. + +### Example 2 +```powershell +Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -BlobStorageTargetState Disabled +``` + +Disable the blob storage auditing policy of an Azure Synapse Analytics Workspace named ContosoWorkspace. + +### Example 3 +```powershell +Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -StorageKeyType Primary -PredicateExpression "statement <> 'select 1'" +``` + +Enable the blob storage auditing policy of an Azure Synapse Analytics Workspace named ContosoWorkspace with advanced filtering using a T-SQL predicate. + +### Example 4 +```powershell +Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -PredicateExpression "" +``` + +Remove the advanced filtering setting from the auditing policy of an Azure Synapse Analytics Workspace named ContosoWorkspace. + +### Example 5 +```powershell +Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId" +``` + +Enable the event hub auditing policy of an Azure Synapse Analytics Workspace named ContosoWorkspace. + +### Example 6 +```powershell +Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -EventHubTargetState Disabled +``` + +Disable the event hub auditing policy of an Azure Synapse Analytics Workspace named ContosoWorkspace. + +### Example 7 +```powershell +Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/myworkspace" +``` + +Enable the log analytics auditing policy of an Azure Synapse Analytics Workspace named ContosoWorkspace. + +### Example 8 +```powershell +Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -LogAnalyticsTargetState Disabled +``` + +Disable the log analytics auditing policy of an Azure Synapse Analytics Workspace named ContosoWorkspace. + +### Example 9 +```powershell +Get-AzSynapseWorkspace -Name ContosoWorkspace | Set-AzSynapseSqlAuditSetting -BlobStorageTargetState Disabled +``` + +Disable the blob storage auditing policy of an Azure Synapse Analytics Workspace named ContosoWorkspace through pipeline. + +### Example 10 +```powershell +Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/myworkspace" -BlobStorageTargetState Disabled +``` + + Disable sending audit records of an Azure Synapse Analytics Workspace to blob storage, and enable sending them to log analytics. + +### Example 11 +```powershell +Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +Enable sending audit records of an Azure Synapse Analytics Workspace to blob storage, event hub and log analytics. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditActionGroup +The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: + + + +"BATCH_COMPLETED_GROUP", + +"SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + +"FAILED_DATABASE_AUTHENTICATION_GROUP" + +This above combination is also the set that is configured by default. +These groups cover all SQL statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. + +For more information, see https://learn.microsoft.com/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.Auditing.AuditActionGroups[] +Parameter Sets: (All) +Aliases: +Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobStorageTargetState +Indicates whether blob storage is a destination for audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubAuthorizationRuleResourceId +The resource Id for the event hub authorization rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the event hub. If none is specified when providing EventHubAuthorizationRuleResourceId, the default event hub will be selected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubTargetState +Indicates whether event hub is a destination for audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticsTargetState +Indicates whether log analytics is a destination for audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PredicateExpression +The T-SQL predicate (WHERE clause) used to filter audit logs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: WorkspaceParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: WorkspaceResourceIdParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionInDays +The number of retention days for the audit logs. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The storage account resource id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageKeyType +Specifies which of the storage access keys to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: WorkspaceParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: WorkspaceObjectParameterSet +Aliases: InputObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Audit Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.WorkspaceAuditModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlPoolAuditSetting.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlPoolAuditSetting.md new file mode 100644 index 0000000000..2940a97d83 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlPoolAuditSetting.md @@ -0,0 +1,540 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsesqlpoolauditsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlPoolAuditSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlPoolAuditSetting.md +--- + +# Set-AzSynapseSqlPoolAuditSetting + +## SYNOPSIS +Changes the auditing settings for an Azure Synapse Analytics SQL pool. + +## SYNTAX + +### SqlPoolParameterSet (Default) +``` +Set-AzSynapseSqlPoolAuditSetting [-AuditActionGroup <AuditActionGroups[]>] [-AuditAction <String[]>] + [-PredicateExpression <String>] [-BlobStorageTargetState <String>] [-StorageAccountResourceId <String>] + [-StorageKeyType <String>] [-RetentionInDays <UInt32>] [-EventHubTargetState <String>] + [-EventHubName <String>] [-EventHubAuthorizationRuleResourceId <String>] [-LogAnalyticsTargetState <String>] + [-WorkspaceResourceId <String>] [-PassThru] [[-ResourceGroupName] <String>] [-WorkspaceName] <String> + -SqlPoolName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlPoolParentObjectParameterSet +``` +Set-AzSynapseSqlPoolAuditSetting [-AuditActionGroup <AuditActionGroups[]>] [-AuditAction <String[]>] + [-PredicateExpression <String>] [-BlobStorageTargetState <String>] [-StorageAccountResourceId <String>] + [-StorageKeyType <String>] [-RetentionInDays <UInt32>] [-EventHubTargetState <String>] + [-EventHubName <String>] [-EventHubAuthorizationRuleResourceId <String>] [-LogAnalyticsTargetState <String>] + [-WorkspaceResourceId <String>] [-PassThru] -WorkspaceObject <PSSynapseWorkspace> -SqlPoolName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlPoolObjectParameterSet +``` +Set-AzSynapseSqlPoolAuditSetting [-AuditActionGroup <AuditActionGroups[]>] [-AuditAction <String[]>] + [-PredicateExpression <String>] [-BlobStorageTargetState <String>] [-StorageAccountResourceId <String>] + [-StorageKeyType <String>] [-RetentionInDays <UInt32>] [-EventHubTargetState <String>] + [-EventHubName <String>] [-EventHubAuthorizationRuleResourceId <String>] [-LogAnalyticsTargetState <String>] + [-WorkspaceResourceId <String>] [-PassThru] -SqlPoolObject <PSSynapseSqlPool> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlPoolResourceIdParameterSet +``` +Set-AzSynapseSqlPoolAuditSetting [-AuditActionGroup <AuditActionGroups[]>] [-AuditAction <String[]>] + [-PredicateExpression <String>] [-BlobStorageTargetState <String>] [-StorageAccountResourceId <String>] + [-StorageKeyType <String>] [-RetentionInDays <UInt32>] [-EventHubTargetState <String>] + [-EventHubName <String>] [-EventHubAuthorizationRuleResourceId <String>] [-LogAnalyticsTargetState <String>] + [-WorkspaceResourceId <String>] [-PassThru] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseSqlPoolAuditSetting** cmdlet changes the auditing settings of an Azure Synapse Analytics SQL pool. +When blob storage is a destination for audit logs, specify the *StorageAccountResourceId* parameter to determine the storage account for the audit logs and the *StorageKeyType* parameter to define the storage keys. You can also define retention for the audit logs by setting the value of the *RetentionInDays* parameter to define the period for the audit logs. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapseSqlPoolAuditSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -StorageKeyType Primary +``` + +Enable the blob storage auditing policy of an Azure Synapse Analytics SQL pool named ContosoSqlPool. + +### Example 2 +```powershell +Set-AzSynapseSqlPoolAuditSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -BlobStorageTargetState Disabled +``` + +Disable the blob storage auditing policy of an Azure Synapse Analytics SQL pool named ContosoSqlPool. + +### Example 3 +```powershell +Set-AzSynapseSqlPoolAuditSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -StorageKeyType Primary -PredicateExpression "statement <> 'select 1'" +``` + +Enable the blob storage auditing policy of an Azure Synapse Analytics SQL pool named ContosoSqlPool with advanced filtering using a T-SQL predicate. + +### Example 4 +```powershell +Set-AzSynapseSqlPoolAuditSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -PredicateExpression "" +``` + +Remove the advanced filtering setting from the auditing policy of an Azure Synapse Analytics SQL pool named ContosoSqlPool. + +### Example 5 +```powershell +Set-AzSynapseSqlPoolAuditSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId" +``` + +Enable the event hub auditing policy of an Azure Synapse Analytics SQL pool named ContosoSqlPool. + +### Example 6 +```powershell +Set-AzSynapseSqlPoolAuditSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -EventHubTargetState Disabled +``` + +Disable the event hub auditing policy of an Azure Synapse Analytics SQL pool named ContosoSqlPool. + +### Example 7 +```powershell +Set-AzSynapseSqlPoolAuditSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/myworkspace" +``` + +Enable the log analytics auditing policy of an Azure Synapse Analytics SQL pool named ContosoSqlPool. + +### Example 8 +```powershell +Set-AzSynapseSqlPoolAuditSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -LogAnalyticsTargetState Disabled +``` + +Disable the log analytics auditing policy of an Azure Synapse Analytics SQL pool named ContosoSqlPool. + +### Example 9 +```powershell +Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool | Set-AzSynapseSqlPoolAuditSetting -BlobStorageTargetState Disabled +``` + +Disable the blob storage auditing policy of an Azure Synapse Analytics SQL pool named ContosoSqlPool through pipeline. + +### Example 10 +```powershell +Set-AzSynapseSqlPoolAuditSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/myworkspace" -BlobStorageTargetState Disabled +``` + + Disable sending audit records of an Azure Synapse Analytics SQL Pool to blob storage, and enable sending them to log analytics. + +### Example 11 +```powershell +Set-AzSynapseSqlPoolAuditSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +Enable sending audit records of an Azure Synapse Analytics SQL Pool to blob storage, event hub and log analytics. + +## PARAMETERS + +### -AuditAction +The set of audit actions. + +The supported actions to audit are: + +SELECT + +UPDATE + +INSERT + +DELETE + +EXECUTE + +RECEIVE + +REFERENCES + +The general form for defining an action to be audited is: + +\[action\] ON \[object\] BY \[principal\] + +Note that \[object\] in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. +For the latter cases, the forms DATABASE::\[dbname\] and SCHEMA::\[schemaname\] are used, respectively. + +For example: + +SELECT on dbo.myTable by public + +SELECT on DATABASE::myDatabase by public + +SELECT on SCHEMA::mySchema by public + +For more information, see https://learn.microsoft.com/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditActionGroup +The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: + + + +"BATCH_COMPLETED_GROUP", + +"SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + +"FAILED_DATABASE_AUTHENTICATION_GROUP" + +This above combination is also the set that is configured by default. +These groups cover all SQL statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. + +For more information, see https://learn.microsoft.com/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.Auditing.AuditActionGroups[] +Parameter Sets: (All) +Aliases: +Accepted values: BATCH_COMPLETED_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobStorageTargetState +Indicates whether blob storage is a destination for audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubAuthorizationRuleResourceId +The resource Id for the event hub authorization rule + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the event hub. If none is specified when providing EventHubAuthorizationRuleResourceId, the default event hub will be selected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubTargetState +Indicates whether event hub is a destination for audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticsTargetState +Indicates whether log analytics is a destination for audit records. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PredicateExpression +The T-SQL predicate (WHERE clause) used to filter audit logs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: SqlPoolResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionInDays +The number of retention days for the audit logs. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlPoolName +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet, SqlPoolParentObjectParameterSet +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlPoolObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: SqlPoolObjectParameterSet +Aliases: InputObject + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The storage account resource id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageKeyType +Specifies which of the storage access keys to use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Primary, Secondary + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SqlPoolParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SqlPoolParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceResourceId +The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Audit Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.SqlPoolAuditModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlPoolSensitivityClassification.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlPoolSensitivityClassification.md new file mode 100644 index 0000000000..1903d37d21 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlPoolSensitivityClassification.md @@ -0,0 +1,304 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsesqlpoolsensitivityclassification +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlPoolSensitivityClassification.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlPoolSensitivityClassification.md +--- + +# Set-AzSynapseSqlPoolSensitivityClassification + +## SYNOPSIS +Sets the information types and sensitivity labels of columns in the SQL pool. + +## SYNTAX + +### ClassificationObjectParameterSet (Default) +``` +Set-AzSynapseSqlPoolSensitivityClassification -ClassificationObject <SqlPoolSensitivityClassificationModel> + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ColumnParameterSet +``` +Set-AzSynapseSqlPoolSensitivityClassification [-SensitivityLabel <String>] [-InformationType <String>] + [-ResourceGroupName] <String> [-WorkspaceName] <String> [-SqlPoolName] <String> -SchemaName <String> + -TableName <String> -ColumnName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SqlPoolObjectColumnParameterSet +``` +Set-AzSynapseSqlPoolSensitivityClassification [-SensitivityLabel <String>] [-InformationType <String>] + -SqlPoolObject <PSSynapseSqlPool> -SchemaName <String> -TableName <String> -ColumnName <String> [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Set-AzSynapseSqlPoolSensitivityClassification cmdlet sets the information types and sensitivity labels of columns in the SQL pool. + +## EXAMPLES + +### Example 1: Set information type and sensitivity label of a column in an Azure Synapse SQL pool. +```powershell +Set-AzSynapseSqlPoolSensitivityClassification -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool -SchemaName schema -TableName table -ColumnName column -InformationType informationType -SensitivityLabel label +``` + +### Example 2: Set recommended information types and sensitivity labels of columns in an Azure Synapse SQL pool. +```powershell +Get-AzSynapseSqlPoolSensitivityRecommendation -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool | Set-AzSynapseSqlPoolSensitivityClassification +``` + +### Example 3: Set information type and sensitivity label of a column in an Azure Synapse SQL pool, using piping. +```powershell +Get-AzSynapseSqlPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSqlPool | Set-AzSynapseSqlPoolSensitivityClassification -SchemaName schema -TableName table -ColumnName column -InformationType informationType -SensitivityLabel label +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClassificationObject +An object representing a SQL Pool Sensitivity Classification. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.DataClassification.SqlPoolSensitivityClassificationModel +Parameter Sets: ClassificationObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ColumnName +Name of column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InformationType +A name that describes the information type of the data stored in the column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SchemaName +Name of schema. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SensitivityLabel +A name that describes the sensitivity of the data stored in the column. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolName +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TableName +Name of table. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet, SqlPoolObjectColumnParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: ColumnParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Synapse.Models.DataClassification.SqlPoolSensitivityClassificationModel + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlPoolTransparentDataEncryption.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlPoolTransparentDataEncryption.md new file mode 100644 index 0000000000..bc5e5156c5 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlPoolTransparentDataEncryption.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsesqlpooltransparentdataencryption +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlPoolTransparentDataEncryption.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlPoolTransparentDataEncryption.md +--- + +# Set-AzSynapseSqlPoolTransparentDataEncryption + +## SYNOPSIS +Modifies TDE property for a SQL pool. + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Set-AzSynapseSqlPoolTransparentDataEncryption [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> -State <TransparentDataEncryptionStateType> [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByParentObjectParameterSet +``` +Set-AzSynapseSqlPoolTransparentDataEncryption -Name <String> -WorkspaceObject <PSSynapseWorkspace> + -State <TransparentDataEncryptionStateType> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Set-AzSynapseSqlPoolTransparentDataEncryption -InputObject <PSSynapseSqlPool> + -State <TransparentDataEncryptionStateType> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Set-AzSynapseSqlPoolTransparentDataEncryption -ResourceId <String> -State <TransparentDataEncryptionStateType> + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseSqlPoolTransparentDataEncryption** cmdlet modifies the Transparent Data Encryption (TDE) property of an Azure Synapse Analytics SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapseSqlPoolTransparentDataEncryption -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -State Enabled +``` + +This command enables TDE for the SQL pool named ContosoSqlPool under the workspace named ContosoWorkspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet, SetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The Azure Synapse Analytics Sql Pool Transparent Data Encryption state. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.TransparentDataEncryptionStateType +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSTransparentDataEncryption + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md new file mode 100644 index 0000000000..267a230b9a --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md @@ -0,0 +1,296 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsesqlpoolvulnerabilityassessmentrulebaseline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline.md +--- + +# Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline + +## SYNOPSIS +Sets the vulnerability assessment rule baseline. + +## SYNTAX + +``` +Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline [-WorkspaceName] <String> [-Name] <String> + [-InputObject <VulnerabilityAssessmentRuleBaselineModel>] -BaselineResult <String[][]> [-AsJob] + -RuleId <String> [-RuleAppliesToMaster] [-ResourceGroupName] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline** cmdlet sets the vulnerability assessment rule baseline. +As you review your assessment results, you can mark specific results as being an acceptable Baseline in your environment. The baseline is essentially a customization of how the results are reported. Results that match the baseline are considered as passing in subsequent scans. Once you have established your baseline security state, vulnerability assessment only reports on deviations from the baseline, and you can focus your attention on the relevant issues. +Note that you need to run *Enable-AzSynapseSqlAdvancedDataSecurity* and *Update-AzSynapseSqlVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1: Set a vulnerability assessment rule baseline +```powershell +Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ContosoResourceGroup" ` + -WorkspaceName "ContosoWorkspace" ` + -SqlPoolName "ContosoSqlPool" ` + -RuleId "VA2108" ` + -RuleAppliesToMaster ` + -BaselineResult @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +```output +ResourceGroupName : ContosoResourceGroup +WorkspaceName : ContosoWorkspace +SqlPoolName : ContosoSqlPool +RuleId : VA2108 +RuleAppliesToMaster : True +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +BaselineResult value is a composition of several sub arrays that described the T-SQL results that will be added to the baseline. +You may find the Scan results under the storage defined by the Update-AzSynapseSqlVulnerabilityAssessmentSetting cmdlet, under scans/{WorkspaceName}/{SqlPoolName}/scan_{ScanId}.json + +### Example 2: Set a vulnerability assessment rule baseline from a baseline object +```powershell +Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ContosoResourceGroup" ` + -WorkspaceName "ContosoWorkspace" ` + -SqlPoolName "ContosoSqlPool" ` + -RuleId "VA2108" ` + -BaselineResult @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') + +Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ContosoResourceGroup" ` + -WorkspaceName "ContosoWorkspace" ` + -SqlPoolName "ContosoSqlPool" ` + -RuleId "VA2108" ` + | Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline ` + -ResourceGroupName "ResourceGroup02" ` + -WorkspaceName "Server02" ` + -SqlPoolName "ContosoSqlPool02" +``` + +```output +ResourceGroupName : ResourceGroup02 +WorkspaceName : Server02 +SqlPoolName : ContosoSqlPool02 +RuleId : VA2108 +RuleAppliesToMaster : False +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +### Example 3: Set a vulnerability assessment rule baseline on all the SQL pools under a workspace +```powershell +Get-AzSynapseSqlPool -ResourceGroupName "ContosoResourceGroup" ` + -WorkspaceName "ContosoWorkspace" ` + | Where-Object {$_.Name -ne "master"} ` + | Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline ` + -RuleId "VA2108" ` + -BaselineResult @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +```output +ResourceGroupName : ContosoResourceGroup +WorkspaceName : ContosoWorkspace +SqlPoolName : ContosoSqlPool +RuleId : VA2108 +RuleAppliesToMaster : False +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') + +ResourceGroupName : ContosoResourceGroup +WorkspaceName : ContosoWorkspace +SqlPoolName : ContosoSqlPool02 +RuleId : VA2108 +RuleAppliesToMaster : False +BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BaselineResult +The results to set as baseline for the rule in all future scans + +```yaml +Type: System.String[][] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Vulnerability Assessment rule baseline object to set + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.VulnerabilityAssessment.VulnerabilityAssessmentRuleBaselineModel +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SqlPoolName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleAppliesToMaster +Specifies whether the baseline results should apply on a workspace level rule identified by the RuleId + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RuleId +The rule ID which identifies the rule to set the baseline results to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.Synapse.Models.VulnerabilityAssessment.VulnerabilityAssessmentRuleBaselineModel + +### System.String[][] + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.VulnerabilityAssessment.SqlPoolVulnerabilityAssessmentRuleBaselineModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlScript.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlScript.md new file mode 100644 index 0000000000..4cdb30baab --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseSqlScript.md @@ -0,0 +1,292 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsesqlscript +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlScript.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseSqlScript.md +--- + +# Set-AzSynapseSqlScript + +## SYNOPSIS +Creates or updates a SQL script in a workspace. + +## SYNTAX + +### SetByName (Default) +``` +Set-AzSynapseSqlScript -WorkspaceName <String> [-Name <String>] -DefinitionFile <String> [-ResultLimit <Int32>] + [-FolderPath <String>] [-Description <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetByNameAndSqlPool +``` +Set-AzSynapseSqlScript -WorkspaceName <String> -SqlPoolName <String> -SqlDatabaseName <String> [-Name <String>] + -DefinitionFile <String> [-ResultLimit <Int32>] [-FolderPath <String>] [-Description <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByObject +``` +Set-AzSynapseSqlScript -WorkspaceObject <PSSynapseWorkspace> [-Name <String>] -DefinitionFile <String> + [-ResultLimit <Int32>] [-FolderPath <String>] [-Description <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByObjectAndSqlPool +``` +Set-AzSynapseSqlScript -WorkspaceObject <PSSynapseWorkspace> -SqlPoolName <String> -SqlDatabaseName <String> + [-Name <String>] -DefinitionFile <String> [-ResultLimit <Int32>] [-FolderPath <String>] + [-Description <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseSqlScript** cmdlet creates or updates a SQL script in a workspace. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapseSqlScript -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\sqlscript.sql" +``` + +This command creates or updates a SQL script from SQL script file sqlscript.sql in the workspace named ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Set-AzSynapseSqlScript -DefinitionFile "C:\\samples\\sqlscript.sql" +``` + +This command creates or updates a SQL script from SQL script file sqlscript.sql in the workspace named ContosoWorkspace. + +### Example 3 +```powershell +Set-AzSynapseSqlScript -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\sqlscript.sql" -SqlPoolName Contososqlpool -SqlDatabaseName Contosodatabase +``` + +This command creates or updates a SQL script from SQL script file sqlscript.sql which connects to ContosoSqlPool and uses the database named Contosodatabase in the workspace named ContosoWorkspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The SQL file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the SQL script. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FolderPath +The folder that this SQL script is in. +If specify a multi-level path such as \[rootFolder/subFolder\], the SqlScript will appear at the bottom level. +If not specified, this SQL script will appear at the root level. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FolderName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The sql script name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SqlScriptName + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultLimit +Limit of results, '-1' for no limit. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlDatabaseName +Which database the sql script is going to use. + +```yaml +Type: System.String +Parameter Sets: SetByNameAndSqlPool, SetByObjectAndSqlPool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlPoolName +Which sql pool the sql script is going to connect to. + +```yaml +Type: System.String +Parameter Sets: SetByNameAndSqlPool, SetByObjectAndSqlPool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByName, SetByNameAndSqlPool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByObject, SetByObjectAndSqlPool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSqlScriptResource + +## NOTES + +## RELATED LINKS + +[Export-AzSynapseSqlScript](./Export-AzSynapseSqlScript.md) + +[Get-AzSynapseSqlScript](./Get-AzSynapseSqlScript.md) + +[Remove-AzSynapseSqlScript](./Remove-AzSynapseSqlScript.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Synapse/Set-AzSynapseTrigger.md b/azps-10.1.0/Az.Synapse/Set-AzSynapseTrigger.md new file mode 100644 index 0000000000..8cd29af2f4 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Set-AzSynapseTrigger.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/set-azsynapsetrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Set-AzSynapseTrigger.md +--- + +# Set-AzSynapseTrigger + +## SYNOPSIS +Creates a trigger in a workspace. + +## SYNTAX + +### SetByName (Default) +``` +Set-AzSynapseTrigger -WorkspaceName <String> -Name <String> -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SetByObject +``` +Set-AzSynapseTrigger -WorkspaceObject <PSSynapseWorkspace> -Name <String> -DefinitionFile <String> [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzSynapseTrigger** cmdlet creates a trigger in a workspace. Triggers are created in the 'Stopped' state, meaning that they don't immediately begin invoking pipelines that they reference. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger -DefinitionFile ".\scheduledTrigger.json" +``` + +Create a new trigger called ContosoTrigger in the workspace ContosoWorkspace. The trigger is created in the 'Stopped' state, meaning that it doesn't immediately start. A trigger can be started using the `Start-AzDataFactoryV2Trigger` cmdlet. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Set-AzSynapseTrigger -Name ContosoTrigger -DefinitionFile ".\scheduledTrigger.json" +``` + +Create a new trigger called ContosoTrigger in the workspace ContosoWorkspace through pipeline. The trigger is created in the 'Stopped' state, meaning that it doesn't immediately start. A trigger can be started using the `Start-AzDataFactoryV2Trigger` cmdlet. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefinitionFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TriggerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Start-AzSynapseDataFlowDebugSession.md b/azps-10.1.0/Az.Synapse/Start-AzSynapseDataFlowDebugSession.md new file mode 100644 index 0000000000..fa4e03d8e7 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Start-AzSynapseDataFlowDebugSession.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/start-azsynapsedataflowdebugsession +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseDataFlowDebugSession.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseDataFlowDebugSession.md +--- + +# Start-AzSynapseDataFlowDebugSession + +## SYNOPSIS +Starts a Synapse Analytics data flow debug session in Synapse Workspace. + +## SYNTAX + +### StartByName (Default) +``` +Start-AzSynapseDataFlowDebugSession -WorkspaceName <String> [-IntegrationRuntimeFile <String>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StartByObject +``` +Start-AzSynapseDataFlowDebugSession -WorkspaceObject <PSSynapseWorkspace> [-IntegrationRuntimeFile <String>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +This long running command starts a data flow debug session for the upcoming debug commands. This command can attach with an integration runtime definition to configure the size/type of debug session cluster. +The PowerShell command sequence for data flow debug workflow should be: +1. Start-AzSynapseDataFlowDebugSession +2. Add-AzSynapseDataFlowDebugSessionPackage +3. Invoke-AzSynapseDataFlowDebugSessionCommand (repeat this step for different commands/targets, or repeat step 2-3 in order to change the package file) +4. Stop-AzSynapseDataFlowDebugSession + +## EXAMPLES + +### Example 1 +```powershell +Start-AzSynapseDataFlowDebugSession -WorkspaceName ContosoWorkspace +``` + +This command starts an Azure Synapse Analytics data flow debug session. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Workspacename ContosoWorkspace -ResourceGroupName GroupName +$result = $ws | Start-AzSynapseDataFlowDebugSession +$result +``` + +```output +SessionId +--------- +b75f917c-1a5e-432e-a1b9-ec6aabb1f546 +``` + +This command starts an Azure Synapse Analytics data flow debug session through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IntegrationRuntimeFile +The JSON file path. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: File + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: StartByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: StartByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSCreateDataFlowDebugSessionResponse + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Start-AzSynapseIntegrationRuntime.md b/azps-10.1.0/Az.Synapse/Start-AzSynapseIntegrationRuntime.md new file mode 100644 index 0000000000..d715f3a4e9 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Start-AzSynapseIntegrationRuntime.md @@ -0,0 +1,244 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/start-azsynapseintegrationruntime +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseIntegrationRuntime.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseIntegrationRuntime.md +--- + +# Start-AzSynapseIntegrationRuntime + +## SYNOPSIS +Starts a managed dedicated integration runtime. + +## SYNTAX + +### StartByNameParameterSet (Default) +``` +Start-AzSynapseIntegrationRuntime [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StartByParentObjectParameterSet +``` +Start-AzSynapseIntegrationRuntime -Name <String> -WorkspaceObject <PSSynapseWorkspace> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StartByResourceIdParameterSet +``` +Start-AzSynapseIntegrationRuntime -ResourceId <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StartByInputObjectParameterSet +``` +Start-AzSynapseIntegrationRuntime -InputObject <PSIntegrationRuntime> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Start-AzSynapseIntegrationRuntime cmdlet starts a managed dedicated integration runtime. The resource is provisioned and after the operation the state is 'Started'. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -Name 'test-dedicated-ir' +``` + +This cmdlet starts a managed dedicated integration runtime named 'test-dedicated-ir' in workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Start-AzSynapseIntegrationRuntime -Name 'test-dedicated-ir' +``` + +This cmdlet starts a managed dedicated integration runtime named 'test-dedicated-ir' in workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +Start-AzSynapseIntegrationRuntime -ResourceId '/subscriptions/0000abcd-1a1b-12ab-1234-0000abcd00aa/resourceGroups/Contosorg/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/integrationruntimes/test-dedicated-ir' +``` + +This cmdlet starts a managed dedicated integration runtime using ResourceId in workspace ContosoWorkspace. + +### Example 4 +```powershell +$ir = Get-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -Name test-dedicated-ir -ResourceGroupName Contosorg +$ir | Start-AzSynapseIntegrationRuntime +``` + +This cmdlet starts a managed dedicated integration runtime named 'test-dedicated-ir' in workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: StartByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: StartByNameParameterSet, StartByParentObjectParameterSet +Aliases: IntegrationRuntimeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: StartByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: StartByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: StartByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: StartByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSManagedIntegrationRuntimeStatus + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Start-AzSynapseKustoPool.md b/azps-10.1.0/Az.Synapse/Start-AzSynapseKustoPool.md new file mode 100644 index 0000000000..3adb4060b7 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Start-AzSynapseKustoPool.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/start-azsynapsekustopool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseKustoPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseKustoPool.md +--- + +# Start-AzSynapseKustoPool + +## SYNOPSIS +Starts a Kusto pool. + +## SYNTAX + +### Start (Default) +``` +Start-AzSynapseKustoPool -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzSynapseKustoPool -InputObject <ISynapseIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Starts a Kusto pool. + +## EXAMPLES + +### Example 1: Start a Kusto pool +```powershell +Start-AzSynapseKustoPool -ResourceGroupName testrg -WorkspaceName testws -Name testnewkustopool +``` + +The above command starts a Kusto pool. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: KustoPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Start-AzSynapseLinkConnection.md b/azps-10.1.0/Az.Synapse/Start-AzSynapseLinkConnection.md new file mode 100644 index 0000000000..bd8180ab05 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Start-AzSynapseLinkConnection.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/start-azsynapselinkconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseLinkConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseLinkConnection.md +--- + +# Start-AzSynapseLinkConnection + +## SYNOPSIS +Starts a link connection. + +## SYNTAX + +### StartByName (Default) +``` +Start-AzSynapseLinkConnection -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StartByObject +``` +Start-AzSynapseLinkConnection -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StartByInputObject +``` +Start-AzSynapseLinkConnection -InputObject <PSLinkConnectionResource> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzSynapseLinkConnection** cmdlet starts a link connection in workspace. It will cost some time from starting to running, after calling this cmdlet you can check the detail status by calling **Get-AzSynapseLinkConnectionDetailedStatus**. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +``` + +This command starts a link connection named ContosoLinkConnection in workspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Workspacename ContosoWorkspace +$ws | Start-AzSynapseLinkConnection -Name ContosoLinkConnection +``` + +This command starts a link connection named ContosoLinkConnection in workspace through pipeline. + +### Example 3 +```powershell +$linkConnection = Get-AzSynapseLinkConnection -Workspacename ContosoWorkspace -Name ContosoLinkConnection +$linkConnection | Start-AzSynapseLinkConnection +``` + +This command starts a link connection named ContosoLinkConnection in workspace through pipeline. + +### Example 4 +```powershell +Start-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +``` + +```output +WorkspaceName : ContosoWorkspace +Id : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Name : ContosoLinkConnection +IsApplyingChanges : +IsPartiallyFailed : False +StartTime : 2022-03-10T07:57:37.8730044Z +StopTime : +Status : Starting +ContinuousRunId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Error : +``` + +The **Start-AzSynapseLinkConnection** command starts a link connection named ContosoLinkConnection in workspace, then you can call **Get-AzSynapseLinkConnectionDetailedStatus** to get status of the link connection. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Synapse link connection object for Azure Sql Database. + +```yaml +Type: PSLinkConnectionResource +Parameter Sets: StartByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Synapse link connection name for Azure Sql Database. + +```yaml +Type: String +Parameter Sets: StartByName, StartByObject +Aliases: LinkConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: String +Parameter Sets: StartByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: PSSynapseWorkspace +Parameter Sets: StartByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkConnectionResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Start-AzSynapseSparkSession.md b/azps-10.1.0/Az.Synapse/Start-AzSynapseSparkSession.md new file mode 100644 index 0000000000..8f8e55c1b9 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Start-AzSynapseSparkSession.md @@ -0,0 +1,263 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/start-azsynapsesparksession +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseSparkSession.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseSparkSession.md +--- + +# Start-AzSynapseSparkSession + +## SYNOPSIS +Starts a Synapse Analytics Spark session. + +## SYNTAX + +### CreateByNameParameterSet (Default) +``` +Start-AzSynapseSparkSession -WorkspaceName <String> -SparkPoolName <String> [-Language <String>] -Name <String> + [-ReferenceFile <String[]>] -ExecutorCount <Int32> -ExecutorSize <String> [-Configuration <Hashtable>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateByParentObjectParameterSet +``` +Start-AzSynapseSparkSession -SparkPoolObject <PSSynapseSparkPool> [-Language <String>] -Name <String> + [-ReferenceFile <String[]>] -ExecutorCount <Int32> -ExecutorSize <String> [-Configuration <Hashtable>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzSynapseSparkSession** cmdlet starts a Synapse Analytics Spark session. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -Name ContosoSessionName -ExecutorCount 3 -ExecutorSize Small +``` + +This command starts an Azure Synapse Analytics Spark session. + +### Example 2 +```powershell +$pool = Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool +$pool | Start-AzSynapseSparkSession -Name ContosoSessionName -ExecutorCount 3 -ExecutorSize Small +``` + +This command starts an Azure Synapse Analytics Spark session through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Configuration +Spark configuration properties. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExecutorCount +Number of executors to be allocated in the specified Spark pool for the job. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExecutorSize +Number of core and memory to be used for executors allocated in the specified Spark pool for the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Small, Medium, Large, XLarge, XXLarge, XXXLarge + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Language +Language of the execution code. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Spark, Scala, PySpark, Python, SparkDotNet, CSharp, SQL + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Spark session. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReferenceFile +Additional files used for reference in the main definition file. Comma-separated storage URI list. e.g. "abfss://filesystem@account.dfs.core.windows.net/file1.txt,abfss://filesystem@account.dfs.core.windows.net/result/" + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolName +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolObject +Spark pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool +Parameter Sets: CreateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: CreateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkSession + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Start-AzSynapseSqlPoolVulnerabilityAssessmentScan.md b/azps-10.1.0/Az.Synapse/Start-AzSynapseSqlPoolVulnerabilityAssessmentScan.md new file mode 100644 index 0000000000..6622b21b2e --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Start-AzSynapseSqlPoolVulnerabilityAssessmentScan.md @@ -0,0 +1,329 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/start-azsynapsesqlpoolvulnerabilityassessmentscan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseSqlPoolVulnerabilityAssessmentScan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseSqlPoolVulnerabilityAssessmentScan.md +--- + +# Start-AzSynapseSqlPoolVulnerabilityAssessmentScan + +## SYNOPSIS +Starts a vulnerability assessment scan. + +## SYNTAX + +### StartSqlPoolObjectParameterSet (Default) +``` +Start-AzSynapseSqlPoolVulnerabilityAssessmentScan [-SqlPoolObject <PSSynapseSqlPool>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StartSqlPoolNameParameterSet +``` +Start-AzSynapseSqlPoolVulnerabilityAssessmentScan [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> [-ScanId <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzSynapseSqlPoolVulnerabilityAssessmentScan** cmdlet triggers a scan with ScanId identifier. +Scan results will be saved under the storage defined by the Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting cmdlet, under scans/{WorkspaceName}/{Name}/scan_{ScanId}.json +You can monitor the progress of the scan by using the *Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord* cmdlet with the scanId parameter and look at the State returned parameter. +Note that you need to run *Enable-AzSynapseSqlAdvancedThreatProtection* and *Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting* cmdlet as a prerequisite for using this cmdlets. + +## EXAMPLES + +### Example 1: Starts a vulnerability assessment scan +```powershell +Start-AzSynapseSqlPoolVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -WorkspaceName "WorkspaceName01" ` + -Name "Name01" ` + -ScanId "myScan" +``` + +```output +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : myScan +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Error : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/WorkspaceName01/Name01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +### Example 2: Starts a vulnerability assessment scan without a specific scan ID +```powershell +Start-AzSynapseSqlPoolVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -WorkspaceName "WorkspaceName01" ` + -Name "Name01" +``` + +```output +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/WorkspaceName01/Name01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +This command generates a scan ID in the format of "yyyyMMdd_HHmmss" from the UTC date time. + +### Example 3: Starts a vulnerability assessment scan in the background +```powershell +$scanJob = Start-AzSynapseSqlPoolVulnerabilityAssessmentScan ` + -ResourceGroupName "ResourceGroup01" ` + -WorkspaceName "WorkspaceName01" ` + -Name "Name01" ` + -ScanId "myScan" ` + -AsJob +$scanJob | Wait-Job +$scanJob | Receive-Job +``` + +```output +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : myScan +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/WorkspaceName01/Name01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +### Example 4: Starts a vulnerability assessment scan with a managed sql pool object +```powershell +Get-AzSynapseSqlPool ` + -ResourceGroupName "ResourceGroup01" ` + -WorkspaceName "WorkspaceName01" ` + -Name "Name01" ` + | Start-AzSynapseSqlPoolVulnerabilityAssessmentScan +``` + +```output +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/WorkspaceName01/Name01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +### Example 5: Starts a vulnerability assessment scan on all the databases under a managed instance +```powershell +Get-AzSynapseSqlPool ` + -ResourceGroupName "ResourceGroup01" ` + -WorkspaceName "WorkspaceName01" ` + | Where-Object {$_.Name -ne "master"} ` + | Start-AzSynapseSqlPoolVulnerabilityAssessmentScan +``` + +```output +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/WorkspaceName01/Name01/scan_myScan.json +NumberOfFailedSecurityChecks : 9 + + +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name02 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment + scans/WorkspaceName01/Name02/scan_myScan.json +NumberOfFailedSecurityChecks : 9 +``` + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: StartSqlPoolNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: StartSqlPoolNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScanId +Specifies the scan ID. + +```yaml +Type: System.String +Parameter Sets: StartSqlPoolNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SqlPoolObject +The sql pool object to get Vulnerability Assessment scan record for + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: StartSqlPoolObjectParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: StartSqlPoolNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool.PSVulnerabilityAssessmentScanRecordModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Start-AzSynapseTrigger.md b/azps-10.1.0/Az.Synapse/Start-AzSynapseTrigger.md new file mode 100644 index 0000000000..331de9f481 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Start-AzSynapseTrigger.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/start-azsynapsetrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Start-AzSynapseTrigger.md +--- + +# Start-AzSynapseTrigger + +## SYNOPSIS +Starts a trigger in a workspace. + +## SYNTAX + +### StartByName (Default) +``` +Start-AzSynapseTrigger -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StartByObject +``` +Start-AzSynapseTrigger -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StartByInputObject +``` +Start-AzSynapseTrigger -InputObject <PSTriggerResource> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzSynapseTrigger** cmdlet starts a trigger in a workspace. If the trigger is in the 'Stopped' state, the cmdlet starts the trigger and it eventually invokes pipelines based on its definition. If the trigger is already in the 'Started' state, this cmdlet has no effect. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger +``` + +Starts a trigger called ContosoTrigger in the workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Start-AzSynapseTrigger -Name ContosoTrigger +``` + +Starts a trigger called ContosoTrigger in the workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$trigger = Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger +$trigger | Start-AzSynapseTrigger +``` + +Starts a trigger called ContosoTrigger in the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The trigger object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource +Parameter Sets: StartByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: StartByName, StartByObject +Aliases: TriggerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: StartByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: StartByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Stop-AzSynapseDataFlowDebugSession.md b/azps-10.1.0/Az.Synapse/Stop-AzSynapseDataFlowDebugSession.md new file mode 100644 index 0000000000..27712b9805 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Stop-AzSynapseDataFlowDebugSession.md @@ -0,0 +1,197 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/stop-azsynapsedataflowdebugsession +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseDataFlowDebugSession.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseDataFlowDebugSession.md +--- + +# Stop-AzSynapseDataFlowDebugSession + +## SYNOPSIS +Stops a data flow debug session in a workspace. + +## SYNTAX + +### StopByName (Default) +``` +Stop-AzSynapseDataFlowDebugSession -WorkspaceName <String> -SessionId <String> [-PassThru] [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StoptByObject +``` +Stop-AzSynapseDataFlowDebugSession -WorkspaceObject <PSSynapseWorkspace> -SessionId <String> [-PassThru] + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSynapseDataFlowDebugSession** cmdlet stops a data flow debug session in a workspace specified with the SessionId. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzSynapseDataFlowDebugSession -workspacename ContosoWorkspace -sessionid c744f68d-a101-4115-9cd5-8b11314fe4b8 +``` + +```output +Confirm +Are you sure you want to stop data flow debug session 'c744f68d-a101-4115-9cd5-8b11314fe4b8' in workspace 'ContosoWorkspace'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +``` + +This command stops the data flow debug session "c744f68d-a101-4115-9cd5-8b11314fe4b8" in the workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace -ResourceGroupName ContosoGroup +$ws | Stop-AzSynapseDataFlowDebugSession -sessionid c744f68d-a101-4115-9cd5-8b11314fe4b8 +``` + +```output +Confirm +Are you sure you want to stop data flow debug session 'c744f68d-a101-4115-9cd5-8b11314fe4b8' in workspace 'ContosoWorkspace'? +[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y +``` + +This command stops the data flow debug session "c744f68d-a101-4115-9cd5-8b11314fe4b8" through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionId +Identifier of Spark session. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: StopByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: StoptByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Stop-AzSynapseIntegrationRuntime.md b/azps-10.1.0/Az.Synapse/Stop-AzSynapseIntegrationRuntime.md new file mode 100644 index 0000000000..e678cb8287 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Stop-AzSynapseIntegrationRuntime.md @@ -0,0 +1,244 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/stop-azsynapseintegrationruntime +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseIntegrationRuntime.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseIntegrationRuntime.md +--- + +# Stop-AzSynapseIntegrationRuntime + +## SYNOPSIS +Stops a managed dedicated integration runtime. + +## SYNTAX + +### StopByNameParameterSet (Default) +``` +Stop-AzSynapseIntegrationRuntime [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByParentObjectParameterSet +``` +Stop-AzSynapseIntegrationRuntime -Name <String> -WorkspaceObject <PSSynapseWorkspace> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByResourceIdParameterSet +``` +Stop-AzSynapseIntegrationRuntime -ResourceId <String> [-Force] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByInputObjectParameterSet +``` +Stop-AzSynapseIntegrationRuntime -InputObject <PSIntegrationRuntime> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Stop-AzSynapseIntegrationRuntime cmdlet stops a managed dedicated integration runtime in 'Started' state, which was started by the Start-AzSynapseIntegrationRuntime cmdlet. The resources are released and the state transfers to 'Stopped'. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -Name 'test-dedicated-ir' +``` + +This cmdlet stops a managed dedicated integration runtime named 'test-dedicated-ir' in workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Stop-AzSynapseIntegrationRuntime -Name 'test-dedicated-ir' +``` + +This cmdlet stops a managed dedicated integration runtime named 'test-dedicated-ir' in workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +Stop-AzSynapseIntegrationRuntime -ResourceId '/subscriptions/0000abcd-1a1b-12ab-1234-0000abcd00aa/resourceGroups/Contosorg/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/integrationruntimes/test-dedicated-ir' +``` + +This cmdlet stops a managed dedicated integration runtime using ResourceId in workspace ContosoWorkspace. + +### Example 4 +```powershell +$ir = Get-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -Name test-dedicated-ir -ResourceGroupName Contosorg +$ir | Stop-AzSynapseIntegrationRuntime +``` + +This cmdlet stops a managed dedicated integration runtime named 'test-dedicated-ir' in workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: StopByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: StopByNameParameterSet, StopByParentObjectParameterSet +Aliases: IntegrationRuntimeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: StopByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: StopByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: StopByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: StopByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Stop-AzSynapseKustoPool.md b/azps-10.1.0/Az.Synapse/Stop-AzSynapseKustoPool.md new file mode 100644 index 0000000000..9210c0ed6c --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Stop-AzSynapseKustoPool.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/stop-azsynapsekustopool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseKustoPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseKustoPool.md +--- + +# Stop-AzSynapseKustoPool + +## SYNOPSIS +Stops a Kusto pool. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzSynapseKustoPool -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzSynapseKustoPool -InputObject <ISynapseIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Stops a Kusto pool. + +## EXAMPLES + +### Example 1: Stop a Kusto pool +```powershell +Stop-AzSynapseKustoPool -ResourceGroupName testrg -WorkspaceName testws -Name testnewkustopool +``` + +The above command stops a Kusto pool. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: KustoPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Stop-AzSynapseLinkConnection.md b/azps-10.1.0/Az.Synapse/Stop-AzSynapseLinkConnection.md new file mode 100644 index 0000000000..21c6df6fde --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Stop-AzSynapseLinkConnection.md @@ -0,0 +1,237 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/stop-azsynapselinkconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseLinkConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseLinkConnection.md +--- + +# Stop-AzSynapseLinkConnection + +## SYNOPSIS +Stops a link connection. + +## SYNTAX + +### StopByName (Default) +``` +Stop-AzSynapseLinkConnection -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByObject +``` +Stop-AzSynapseLinkConnection -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByInputObject +``` +Stop-AzSynapseLinkConnection -InputObject <PSLinkConnectionResource> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSynapseLinkConnection** cmdlet stops a link connection in workspace. It will cost some time from running to stopped, after calling this cmdlet you can check the detail status by calling **Get-AzSynapseLinkConnectionDetailedStatus**. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +``` + +This command stops a link connection named ContosoLinkConnection in workspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Workspacename ContosoWorkspace +$ws | Stop-AzSynapseLinkConnection -Name ContosoLinkConnection +``` + +This command stops a link connection named ContosoLinkConnection in workspace through pipeline. + +### Example 3 +```powershell +$linkConnection = Get-AzSynapseLinkConnection -Workspacename ContosoWorkspace -Name ContosoLinkConnection +$linkConnection | Stop-AzSynapseLinkConnection +``` + +This command stops a link connection named ContosoLinkConnection in workspace through pipeline. + +### Example 4 +```powershell +Stop-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +``` +```output +WorkspaceName : ContosoWorkspace +Id : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Name : ContosoLinkConnection +IsApplyingChanges : +IsPartiallyFailed : False +StartTime : 2022-03-10T06:59:34.5820499Z +StopTime : 2022-03-10T07:21:42.4895248Z +Status : Stopping +ContinuousRunId : +Error : +``` + +This command stops a link connection named ContosoLinkConnection in workspace, then you can call **Get-AzSynapseLinkConnectionDetailedStatus** to get status of the link connection. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Synapse link connection object for Azure Sql Database. + +```yaml +Type: PSLinkConnectionResource +Parameter Sets: StopByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The Synapse link connection name for Azure Sql Database. + +```yaml +Type: String +Parameter Sets: StopByName, StopByObject +Aliases: LinkConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: String +Parameter Sets: StopByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: PSSynapseWorkspace +Parameter Sets: StopByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkConnectionResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Stop-AzSynapsePipelineRun.md b/azps-10.1.0/Az.Synapse/Stop-AzSynapsePipelineRun.md new file mode 100644 index 0000000000..6285793f70 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Stop-AzSynapsePipelineRun.md @@ -0,0 +1,217 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/stop-azsynapsepipelinerun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapsePipelineRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapsePipelineRun.md +--- + +# Stop-AzSynapsePipelineRun + +## SYNOPSIS +Stops a pipeline run in a workspace. + +## SYNTAX + +### RemoveByName (Default) +``` +Stop-AzSynapsePipelineRun -WorkspaceName <String> -PipelineRunId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByObject +``` +Stop-AzSynapsePipelineRun -WorkspaceObject <PSSynapseWorkspace> -PipelineRunId <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RemoveByInputObject +``` +Stop-AzSynapsePipelineRun -InputObject <PSPipelineRun> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSynapsePipelineRun** cmdlet stops a pipeline run in a workspace specified with the pipeline run ID. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzSynapsePipelineRun -WorkspaceName ContosoWorkspace -PipelineRunId b9730a13-aa12-4926-a8b3-8e3a974ab0bd +``` + +This command stops the pipeline run with id b9730a13-aa12-4926-a8b3-8e3a974ab0bd in the workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Stop-AzSynapsePipelineRun -PipelineRunId b9730a13-aa12-4926-a8b3-8e3a974ab0bd +``` + +This command stops the pipeline run with id b9730a13-aa12-4926-a8b3-8e3a974ab0bd in the workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$pipelineRun = Get-AzSynapsePipelineRun -WorkspaceName ContosoWorkspace -PipelineRunId b9730a13-aa12-4926-a8b3-8e3a974ab0bd +$pipelineRun | Stop-AzSynapsePipelineRun +``` + +This command stops the pipeline run with id b9730a13-aa12-4926-a8b3-8e3a974ab0bd in the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The information about the pipeline run. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSPipelineRun +Parameter Sets: RemoveByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineRunId +The pipeline run identifier. + +```yaml +Type: System.String +Parameter Sets: RemoveByName, RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RemoveByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: RemoveByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSPipelineRun + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Stop-AzSynapseSparkJob.md b/azps-10.1.0/Az.Synapse/Stop-AzSynapseSparkJob.md new file mode 100644 index 0000000000..21ed8a4267 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Stop-AzSynapseSparkJob.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/stop-azsynapsesparkjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseSparkJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseSparkJob.md +--- + +# Stop-AzSynapseSparkJob + +## SYNOPSIS +Cancels a Synapse Analytics Spark job. + +## SYNTAX + +### StopSparkJobByIdParameterSet (Default) +``` +Stop-AzSynapseSparkJob -WorkspaceName <String> -SparkPoolName <String> -LivyId <Int32> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopSparkJobByIdFromParentObjectParameterSet +``` +Stop-AzSynapseSparkJob -SparkPoolObject <PSSynapseSparkPool> -LivyId <Int32> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopSparkJobByIdFromInputObjectParameterSet +``` +Stop-AzSynapseSparkJob -SparkJobObject <PSSynapseSparkJob> [-LivyId <Int32>] [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSynapseSparkJob** cmdlet cancels a Synapse Analytics Spark job. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 130 +``` + +This command cancels a Synapse Analytics Spark job. + +### Example 2 +```powershell +$pool = Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool +$pool | Stop-AzSynapseSparkJob -LivyId 130 +``` + +This command cancels a Synapse Analytics Spark job through pipeline. + +### Example 3 +```powershell +$job = Get-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 130 +$job | Stop-AzSynapseSparkJob +``` + +This command cancels a Synapse Analytics Spark job through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivyId +Identifier of Spark job. + +```yaml +Type: System.Int32 +Parameter Sets: StopSparkJobByIdParameterSet, StopSparkJobByIdFromParentObjectParameterSet +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Int32 +Parameter Sets: StopSparkJobByIdFromInputObjectParameterSet +Aliases: Id + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkJobObject +Spark job input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkJob +Parameter Sets: StopSparkJobByIdFromInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SparkPoolName +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: StopSparkJobByIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolObject +Spark pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool +Parameter Sets: StopSparkJobByIdFromParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: StopSparkJobByIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkJob + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Stop-AzSynapseSparkSession.md b/azps-10.1.0/Az.Synapse/Stop-AzSynapseSparkSession.md new file mode 100644 index 0000000000..e084abd3e3 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Stop-AzSynapseSparkSession.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/stop-azsynapsesparksession +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseSparkSession.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseSparkSession.md +--- + +# Stop-AzSynapseSparkSession + +## SYNOPSIS +Stops a Synapse Analytics Spark session. + +## SYNTAX + +### DeleteByNameParameterSet (Default) +``` +Stop-AzSynapseSparkSession -WorkspaceName <String> -SparkPoolName <String> -LivyId <Int32> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByParentObjectParameterSet +``` +Stop-AzSynapseSparkSession -LivyId <Int32> -SparkPoolObject <PSSynapseSparkPool> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteByInputObjectParameterSet +``` +Stop-AzSynapseSparkSession -InputObject <PSSynapseSparkSession> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSynapseSparkSession** cmdlet stops a Synapse Analytics Spark session. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 324 +``` + +This command stops a Synapse Analytics Spark session. + +### Example 2 +```powershell +$pool = Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool +$pool | Stop-AzSynapseSparkSession -LivyId 324 +``` + +This command stops a Synapse Analytics Spark session through pipeline. + +### Example 3 +```powershell +$session = Get-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 324 +$session | Stop-AzSynapseSparkSession +``` + +This command stops a Synapse Analytics Spark session through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Spark session input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkSession +Parameter Sets: DeleteByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LivyId +Identifier of Spark session. + +```yaml +Type: System.Int32 +Parameter Sets: DeleteByNameParameterSet, DeleteByParentObjectParameterSet +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolName +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolObject +Spark pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool +Parameter Sets: DeleteByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: DeleteByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkSession + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Stop-AzSynapseSparkStatement.md b/azps-10.1.0/Az.Synapse/Stop-AzSynapseSparkStatement.md new file mode 100644 index 0000000000..24d2cdf7b3 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Stop-AzSynapseSparkStatement.md @@ -0,0 +1,215 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/stop-azsynapsesparkstatement +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseSparkStatement.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseSparkStatement.md +--- + +# Stop-AzSynapseSparkStatement + +## SYNOPSIS +Cancels a Synapse Analytics Spark statement. + +## SYNTAX + +### StopSparkStatementByIdParameterSet (Default) +``` +Stop-AzSynapseSparkStatement -WorkspaceName <String> -SparkPoolName <String> -LivyId <Int32> -SessionId <Int32> + [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopSparkStatementByIdFromParentObjectParameterSet +``` +Stop-AzSynapseSparkStatement -SessionObject <PSSynapseSparkSession> -LivyId <Int32> [-Force] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSynapseSparkStatement** cmdlet cancels a Synapse Analytics Spark statement. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzSynapseSparkStatement -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -SessionId 130 -LivyId 1 +``` + +This command cancels the Spark statement with the specified livy ID. + +### Example 2 +```powershell +$session = Get-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 130 +$session | Stop-AzSynapseSparkStatement -LivyId 3 +``` + +This command cancels the Spark statement with the specified livy ID through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivyId +Identifier of Spark statement. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionId +Identifier of Spark session. + +```yaml +Type: System.Int32 +Parameter Sets: StopSparkStatementByIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SessionObject +Spark session input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkSession +Parameter Sets: StopSparkStatementByIdFromParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SparkPoolName +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: StopSparkStatementByIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: StopSparkStatementByIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkSession + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Stop-AzSynapseTrigger.md b/azps-10.1.0/Az.Synapse/Stop-AzSynapseTrigger.md new file mode 100644 index 0000000000..0764ae0c4f --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Stop-AzSynapseTrigger.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/stop-azsynapsetrigger +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseTrigger.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseTrigger.md +--- + +# Stop-AzSynapseTrigger + +## SYNOPSIS +Stops a trigger in a workspace. + +## SYNTAX + +### StopByName (Default) +``` +Stop-AzSynapseTrigger -WorkspaceName <String> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByObject +``` +Stop-AzSynapseTrigger -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByInputObject +``` +Stop-AzSynapseTrigger -InputObject <PSTriggerResource> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzSynapseTrigger** cmdlet stops a trigger in a workspace. If the trigger is in the 'Started' state, the cmdlet stops the trigger and no longer invokes pipelines. If the trigger is already in the 'Stopped' state, this cmdlet has no effect. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger +``` + +Stops a trigger called ContosoTrigger in the workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Stop-AzSynapseTrigger -Name ContosoTrigger +``` + +Stops a trigger called ContosoTrigger in the workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$trigger = Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger +$trigger | Stop-AzSynapseTrigger +``` + +Stop a trigger called ContosoTrigger in the workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The trigger object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource +Parameter Sets: StopByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: StopByName, StopByObject +Aliases: TriggerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: StopByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: StopByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSTriggerResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Stop-AzSynapseTriggerRun.md b/azps-10.1.0/Az.Synapse/Stop-AzSynapseTriggerRun.md new file mode 100644 index 0000000000..48d91a4832 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Stop-AzSynapseTriggerRun.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/stop-azsynapsetriggerrun +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseTriggerRun.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Stop-AzSynapseTriggerRun.md +--- + +# Stop-AzSynapseTriggerRun + +## SYNOPSIS +Stops a trigger run in a synapse workspace. + +## SYNTAX + +### StopByName (Default) +``` +Stop-AzSynapseTriggerRun -WorkspaceName <String> -Name <String> -TriggerRunId <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByInputObject +``` +Stop-AzSynapseTriggerRun -InputObject <PSTriggerRun> [-PassThru] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByWorkspaceObject +``` +Stop-AzSynapseTriggerRun -WorkspaceObject <PSSynapseWorkspace> -Name <String> -TriggerRunId <String> + [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The Stop-AzSynapseTriggerRun cmdlet stops a trigger run in a synapse workspace specified with the trigger name and trigger run ID. Currently only supported for TumblingWindowTriggers in WaitingOnDependency State. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzSynapseTriggerRun -WorkspaceName ContosoWorkspace -Name ContosoTrigger -TriggerRunId 000111222333abc +``` + +This command stops the trigger run with id '000111222333abc' in the Synapse workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Stop-AzSynapseTriggerRun -Name ContosoTrigger -TriggerRunId 000111222333abc +``` + +Stops the trigger run with id '000111222333abc' in the Synapse workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$triggerun = Get-AzSynapseTriggerRun -WorkspaceName ContosoWorkspace -Name ContosoTrigger -RunStartedAfter "2018-09-01T21:00" -RunStartedBefore "2019-09-01T21:00" +$triggerun | Stop-AzSynapseTriggerRun +``` + +Stops the trigger run in the Synapse workspace ContosoWorkspace through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The information about the trigger run. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSTriggerRun +Parameter Sets: StopByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The trigger name. + +```yaml +Type: System.String +Parameter Sets: StopByName, StopByWorkspaceObject +Aliases: TriggerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerRunId +The Run ID of the trigger. + +```yaml +Type: System.String +Parameter Sets: StopByName, StopByWorkspaceObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: StopByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: StopByWorkspaceObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSTriggerRun + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Submit-AzSynapseSparkJob.md b/azps-10.1.0/Az.Synapse/Submit-AzSynapseSparkJob.md new file mode 100644 index 0000000000..fa2c785aae --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Submit-AzSynapseSparkJob.md @@ -0,0 +1,306 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/submit-azsynapsesparkjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Submit-AzSynapseSparkJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Submit-AzSynapseSparkJob.md +--- + +# Submit-AzSynapseSparkJob + +## SYNOPSIS +Submits a Synapse Analytics Spark job. + +## SYNTAX + +### RunSparkJobParameterSetName (Default) +``` +Submit-AzSynapseSparkJob -WorkspaceName <String> -SparkPoolName <String> -Language <String> -Name <String> + -MainDefinitionFile <String> [-MainClassName <String>] [-CommandLineArgument <String[]>] + [-ReferenceFile <String[]>] -ExecutorCount <Int32> -ExecutorSize <String> [-Configuration <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RunSparkJobByParentObjectParameterSet +``` +Submit-AzSynapseSparkJob -SparkPoolObject <PSSynapseSparkPool> -Language <String> -Name <String> + -MainDefinitionFile <String> [-MainClassName <String>] [-CommandLineArgument <String[]>] + [-ReferenceFile <String[]>] -ExecutorCount <Int32> -ExecutorSize <String> [-Configuration <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Submit-AzSynapseSparkJob** cmdlet submits a Synapse Analytics Spark job. + +## EXAMPLES + +### Example 1 +```powershell +Submit-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -Language Spark -Name WordCount_Java -MainDefinitionFile abfss://ContosoFileSystem@ContosoGen2Storage.dfs.core.windows.net/samples/java/wordcount/wordcount.jar -MainClassName WordCount -CommandLineArgument abfss://ContosoFileSystem@ContosoGen2Storage.dfs.core.windows.net/samples/java/wordcount/shakespeare.txt,abfss://ContosoFileSystem@ContosoGen2Storage.dfs.core.windows.net/samples/java/wordcount/result/ -ExecutorCount 2 -ExecutorSize Small +``` + +This command submits a Synapse Analytics Spark job. + +### Example 2 +```powershell +Submit-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -Language SparkDotNet -Name WordCount_Dotnet -MainDefinitionFile abfss://ContosoFileSystem@ContosoGen2Storage.dfs.core.windows.net/samples/dotnet/wordcount/wordcount.zip -MainExecutableFile WordCount -CommandLineArgument abfss://ContosoFileSystem@ContosoGen2Storage.dfs.core.windows.net/samples/dotnet/wordcount/shakespeare.txt,abfss://ContosoFileSystem@ContosoGen2Storage.dfs.core.windows.net/samples/dotnet/wordcount/result -ExecutorCount 2 -ExecutorSize Small +``` + +This command submits a Synapse Analytics Spark .NET job. + +### Example 3 +```powershell +Submit-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -Language PySpark -Name WordCount_Python -MainDefinitionFile abfss://ContosoFileSystem@ContosoGen2Storage.blob.core.windows.net/samples/python/wordcount/wordcount.py -CommandLineArgument abfss://ContosoFileSystem@ContosoGen2Storage.blob.core.windows.net/samples/python/wordcount/shakespeare.txt,abfss://ContosoFileSystem@ContosoGen2Storage.blob.core.windows.net/samples/python/wordcount/result/ -ExecutorCount 2 -ExecutorSize Small +``` + +This command submits a Synapse Analytics PySpark job. + +## PARAMETERS + +### -CommandLineArgument +Optional arguments to the job. e.g. "--iteration 10000 --timeout 20s" + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Configuration +Spark configuration properties. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExecutorCount +Number of executors to be allocated in the specified Spark pool for the job. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExecutorSize +Number of core and memory to be used for executors allocated in the specified Spark pool for the job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Small, Medium, Large, XLarge, XXLarge, XXXLarge + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Language +Language of the job to submit. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Spark, Scala, PySpark, Python, SparkDotNet, CSharp + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MainClassName +The fully-qualified identifier or the main class that is in the main definition file. +Required for Spark and .NET Spark job. +e.g. +"org.apache.spark.examples.SparkPi" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MainExecutableFile + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MainDefinitionFile +The main file used for the job. +e.g. +"abfss://filesystem@account.dfs.core.windows.net/mySpark.jar" + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Spark job. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReferenceFile +Additional files used for reference in the main definition file. Comma-separated storage URI list. e.g. "abfss://filesystem@account.dfs.core.windows.net/file1.txt,abfss://filesystem@account.dfs.core.windows.net/result/" + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolName +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: RunSparkJobParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolObject +Spark pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool +Parameter Sets: RunSparkJobByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: RunSparkJobParameterSetName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkJob + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Suspend-AzSynapseSqlPool.md b/azps-10.1.0/Az.Synapse/Suspend-AzSynapseSqlPool.md new file mode 100644 index 0000000000..c1353ca0fd --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Suspend-AzSynapseSqlPool.md @@ -0,0 +1,237 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/suspend-azsynapsesqlpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Suspend-AzSynapseSqlPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Suspend-AzSynapseSqlPool.md +--- + +# Suspend-AzSynapseSqlPool + +## SYNOPSIS +Suspends a Synapse Analytics SQL pool. + +## SYNTAX + +### SuspendByNameParameterSet (Default) +``` +Suspend-AzSynapseSqlPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SuspendByParentObjectParameterSet +``` +Suspend-AzSynapseSqlPool -Name <String> -WorkspaceObject <PSSynapseWorkspace> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SuspendByInputObjectParameterSet +``` +Suspend-AzSynapseSqlPool -InputObject <PSSynapseSqlPool> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SuspendByResourceIdParameterSet +``` +Suspend-AzSynapseSqlPool -ResourceId <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Suspend-AzSynapseSqlPool** cmdlet suspends an Azure Synapse Analytics SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +Suspend-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +``` + +This command suspends an active Azure Synapse Analytics SQL pool. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: SuspendByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: SuspendByNameParameterSet, SuspendByParentObjectParameterSet +Aliases: SqlPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: SuspendByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: SuspendByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SuspendByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SuspendByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Sync-AzSynapseIntegrationRuntimeCredential.md b/azps-10.1.0/Az.Synapse/Sync-AzSynapseIntegrationRuntimeCredential.md new file mode 100644 index 0000000000..7d01686fe0 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Sync-AzSynapseIntegrationRuntimeCredential.md @@ -0,0 +1,223 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/sync-azsynapseintegrationruntimecredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Sync-AzSynapseIntegrationRuntimeCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Sync-AzSynapseIntegrationRuntimeCredential.md +--- + +# Sync-AzSynapseIntegrationRuntimeCredential + +## SYNOPSIS +Synchronizes credentials among integration runtime nodes. + +## SYNTAX + +### StopByNameParameterSet (Default) +``` +Sync-AzSynapseIntegrationRuntimeCredential [-ResourceGroupName <String>] -WorkspaceName <String> + -IntegrationRuntimeName <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### StopByParentObjectParameterSet +``` +Sync-AzSynapseIntegrationRuntimeCredential -IntegrationRuntimeName <String> + -WorkspaceObject <PSSynapseWorkspace> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### StopByResourceIdParameterSet +``` +Sync-AzSynapseIntegrationRuntimeCredential -ResourceId <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopByInputObjectParameterSet +``` +Sync-AzSynapseIntegrationRuntimeCredential -InputObject <PSIntegrationRuntime> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Sync-AzSynapseIntegrationRuntimeCredential** cmdlet synchronizes on-premises credentials among integration runtime nodes, which forces the credentials to be identical in all nodes. + +## EXAMPLES + +### Example 1 +```powershell +Sync-AzSynapseIntegrationRuntimeCredential -WorkspaceName ContosoWorkspace -IntegrationRuntimeName 'test-selfhost-ir' +``` + +Synchronizes credentials among integration runtime nodes. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Don't ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: StopByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntegrationRuntimeName +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: StopByNameParameterSet, StopByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: StopByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: StopByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: StopByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: StopByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Test-AzSynapseSparkPool.md b/azps-10.1.0/Az.Synapse/Test-AzSynapseSparkPool.md new file mode 100644 index 0000000000..9baf89726b --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Test-AzSynapseSparkPool.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/test-azsynapsesparkpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Test-AzSynapseSparkPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Test-AzSynapseSparkPool.md +--- + +# Test-AzSynapseSparkPool + +## SYNOPSIS +Checks for the existence of a Synapse Analytics Spark pool. + +## SYNTAX + +### TestByNameParameterSet (Default) +``` +Test-AzSynapseSparkPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### TestByParentObjectParameterSet +``` +Test-AzSynapseSparkPool -Name <String> -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzSynapseSparkPool** cmdlet checks for the existence of a Synapse Analytics Spark pool. + +## EXAMPLES + +### Example 1 +```powershell +Test-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool +``` + +This command checks the existence of the specified Spark pool. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: TestByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: TestByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: TestByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Test-AzSynapseSqlDatabase.md b/azps-10.1.0/Az.Synapse/Test-AzSynapseSqlDatabase.md new file mode 100644 index 0000000000..7c858c2e57 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Test-AzSynapseSqlDatabase.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/test-azsynapsesqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Test-AzSynapseSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Test-AzSynapseSqlDatabase.md +--- + +# Test-AzSynapseSqlDatabase + +## SYNOPSIS +This feature is in a limited preview, initially accessible only to certain subscriptions. Checks for the existence of a Synapse Analytics SQL database. + +## SYNTAX + +### TestByNameParameterSet (Default) +``` +Test-AzSynapseSqlDatabase [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### TestByParentObjectParameterSet +``` +Test-AzSynapseSqlDatabase -Name <String> -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzSynapseSqlDatabase** cmdlet checks for the existence of a Synapse Analytics SQL database. + +## EXAMPLES + +### Example 1 +```powershell +Test-AzSynapseSqlDatabase -WorkspaceName ContosoWorkspace -Name ContosoSqlDatabase +``` + +This command checks the existence of the specified SQL database. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: TestByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: TestByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: TestByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Test-AzSynapseSqlPool.md b/azps-10.1.0/Az.Synapse/Test-AzSynapseSqlPool.md new file mode 100644 index 0000000000..5306ab9201 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Test-AzSynapseSqlPool.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/test-azsynapsesqlpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Test-AzSynapseSqlPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Test-AzSynapseSqlPool.md +--- + +# Test-AzSynapseSqlPool + +## SYNOPSIS +Checks for the existence of a Synapse Analytics SQL pool. + +## SYNTAX + +### TestByNameParameterSet (Default) +``` +Test-AzSynapseSqlPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-Version <Int32>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### TestByParentObjectParameterSet +``` +Test-AzSynapseSqlPool -Name <String> [-Version <Int32>] -WorkspaceObject <PSSynapseWorkspace> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzSynapseSqlPool** cmdlet checks for the existence of a Synapse Analytics SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +Test-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +``` + +This command checks the existence of the specified SQL pool. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SqlPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: TestByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version of Synapse SQL pool. For example, 2 or 3. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: TestByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: TestByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Test-AzSynapseWorkspace.md b/azps-10.1.0/Az.Synapse/Test-AzSynapseWorkspace.md new file mode 100644 index 0000000000..c65eaa88f1 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Test-AzSynapseWorkspace.md @@ -0,0 +1,93 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/test-azsynapseworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Test-AzSynapseWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Test-AzSynapseWorkspace.md +--- + +# Test-AzSynapseWorkspace + +## SYNOPSIS +Checks for the existence of a Synapse Analytics workspace. + +## SYNTAX + +``` +Test-AzSynapseWorkspace [-Name] <String> [[-ResourceGroupName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Test-AzSynapseWorkspace** cmdlet checks for the existence of a Synapse Analytics workspace. + +## EXAMPLES + +### Example 1 +```powershell +Test-AzSynapseWorkspace -Name ContosoWorkspace +``` + +This command checks for the existence of a Synapse Analytics workspace. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseFirewallRule.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseFirewallRule.md new file mode 100644 index 0000000000..3de0de401c --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseFirewallRule.md @@ -0,0 +1,220 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapsefirewallrule +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseFirewallRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseFirewallRule.md +--- + +# Update-AzSynapseFirewallRule + +## SYNOPSIS +Updates a Synapse Analytics Firewall Rule. + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Update-AzSynapseFirewallRule [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + [-StartIpAddress <String>] [-EndIpAddress <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByParentObjectParameterSet +``` +Update-AzSynapseFirewallRule -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-StartIpAddress <String>] + [-EndIpAddress <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSynapseFirewallRule** cmdlet modifys an Azure Synapse Analytics Firewall Rule. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSynapseFirewallRule -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoFirewallRule -StartIpAddress "0.0.0.0" -EndIpAddress "255.255.255.255" +``` + +This command updates firewall rule named ContosoFirewallRule under workspace ContosoWorkspace with name ContosoFirewallRule. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Update-AzSynapseFirewallRule -Name ContosoFirewallRule -StartIpAddress "0.0.0.0" -EndIpAddress "255.255.255.255" +``` + +This command updates firewall rule named ContosoFirewallRule under a workspace through pipeline. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIpAddress +The end IP address of the firewall rule. +Must be IPv4 format. +Must be greater than or equal to startIpAddress. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The firerwall rule name for the workspace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FirewallRuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIpAddress +The start IP address of the firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: UpdateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseIpFirewallRule + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseIntegrationRuntime.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseIntegrationRuntime.md new file mode 100644 index 0000000000..0af5d03910 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseIntegrationRuntime.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapseintegrationruntime +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseIntegrationRuntime.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseIntegrationRuntime.md +--- + +# Update-AzSynapseIntegrationRuntime + +## SYNOPSIS +Updates an integration runtime. + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Update-AzSynapseIntegrationRuntime [-ResourceGroupName <String>] -WorkspaceName <String> + -IntegrationRuntimeName <String> [-AutoUpdate <String>] [-AutoUpdateDelayOffset <TimeSpan>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByParentObjectParameterSet +``` +Update-AzSynapseIntegrationRuntime -IntegrationRuntimeName <String> -WorkspaceObject <PSSynapseWorkspace> + [-AutoUpdate <String>] [-AutoUpdateDelayOffset <TimeSpan>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByResourceIdParameterSet +``` +Update-AzSynapseIntegrationRuntime -ResourceId <String> [-AutoUpdate <String>] + [-AutoUpdateDelayOffset <TimeSpan>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzSynapseIntegrationRuntime -InputObject <PSIntegrationRuntime> [-AutoUpdate <String>] + [-AutoUpdateDelayOffset <TimeSpan>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSynapseIntegrationRuntime** cmdlet updates integration runtime properties. Currently the cmdlet only supports updating 'AutoUpdate' and 'AutoUpdateDelayOffset' for self-hosted integration runtime. + +## EXAMPLES + +### Example 1 +```powershell +$ts = New-TimeSpan -Hours 3 +Update-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -IntegrationRuntimeName 'test-selfhost-ir' -AutoUpdate Off -AutoUpdateDelayOffset $ts +``` + +The cmdlet updates self-hosted integration runtime named 'test-selfhost-ir'. + +## PARAMETERS + +### -AutoUpdate +Enable or disable the self-hosted integration runtime auto-update. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: On, Off + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoUpdateDelayOffset +The time of the day for the self-hosted integration runtime auto-update. + +```yaml +Type: System.Nullable`1[System.TimeSpan] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntegrationRuntimeName +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, UpdateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: UpdateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSelfHostedIntegrationRuntimeStatus + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseIntegrationRuntimeNode.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseIntegrationRuntimeNode.md new file mode 100644 index 0000000000..c558d82ed5 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseIntegrationRuntimeNode.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapseintegrationruntimenode +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseIntegrationRuntimeNode.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseIntegrationRuntimeNode.md +--- + +# Update-AzSynapseIntegrationRuntimeNode + +## SYNOPSIS +Updates self-hosted integration runtime node. + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Update-AzSynapseIntegrationRuntimeNode [-ResourceGroupName <String>] -WorkspaceName <String> + -IntegrationRuntimeName <String> -Name <String> -ConcurrentJobsLimit <Int32> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByParentObjectParameterSet +``` +Update-AzSynapseIntegrationRuntimeNode -IntegrationRuntimeName <String> -WorkspaceObject <PSSynapseWorkspace> + -Name <String> -ConcurrentJobsLimit <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByResourceIdParameterSet +``` +Update-AzSynapseIntegrationRuntimeNode -ResourceId <String> -Name <String> -ConcurrentJobsLimit <Int32> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzSynapseIntegrationRuntimeNode -InputObject <PSIntegrationRuntime> -Name <String> + -ConcurrentJobsLimit <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSynapseIntegrationRuntimeNode** cmdlet updates properties of self-hosted integration runtime node in a workspace. Currently only supports updating 'ConcurrentJobsLimit'. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSynapseIntegrationRuntimeNode -WorkspaceName ContosoWorkspace -IntegrationRuntimeName 'test-selfhost-ir' -Name 'Node_1' -ConcurrentJobsLimit 3 +``` + +The cmdlet updates 'ConcurrentJobsLimit' to 3 for node 'Node_1' in self-hosted integration runtime 'test-selfhost-ir'. + +## PARAMETERS + +### -ConcurrentJobsLimit +The number of concurrent jobs permitted to run on the integration runtime node. +Values between 1 and maxConcurrentJobs are allowed. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The integration runtime object. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IntegrationRuntimeName +The integration runtime name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, UpdateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration runtime node name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse integration runtime. + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: UpdateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSIntegrationRuntime + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSelfHostedIntegrationRuntimeStatus + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseKustoPool.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseKustoPool.md new file mode 100644 index 0000000000..ac4311fb48 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseKustoPool.md @@ -0,0 +1,424 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapsekustopool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseKustoPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseKustoPool.md +--- + +# Update-AzSynapseKustoPool + +## SYNOPSIS +Update a Kusto Kusto Pool. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSynapseKustoPool -Name <String> -ResourceGroupName <String> -WorkspaceName <String> + [-SubscriptionId <String>] [-IfMatch <String>] [-EnablePurge] [-EnableStreamingIngest] + [-OptimizedAutoscaleIsEnabled] [-OptimizedAutoscaleMaximum <Int32>] [-OptimizedAutoscaleMinimum <Int32>] + [-OptimizedAutoscaleVersion <Int32>] [-SkuCapacity <Int32>] [-SkuName <SkuName>] [-SkuSize <SkuSize>] + [-Tag <Hashtable>] [-WorkspaceUid <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSynapseKustoPool -InputObject <ISynapseIdentity> [-IfMatch <String>] [-EnablePurge] + [-EnableStreamingIngest] [-OptimizedAutoscaleIsEnabled] [-OptimizedAutoscaleMaximum <Int32>] + [-OptimizedAutoscaleMinimum <Int32>] [-OptimizedAutoscaleVersion <Int32>] [-SkuCapacity <Int32>] + [-SkuName <SkuName>] [-SkuSize <SkuSize>] [-Tag <Hashtable>] [-WorkspaceUid <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a Kusto Kusto Pool. + +## EXAMPLES + +### Example 1: Update an existing cluster by name +```powershell +Update-AzSynapseKustoPool -ResourceGroupName testrg -WorkspaceName testws -Name testnewkustopool -SkuName "Storage optimized" -SkuSize Medium +``` + +```output +Location Name Type Etag +-------- ---- ---- ---- +East US 2 testws/testnewkustopool Microsoft.Synapse/workspaces/kustoPools +``` + +The above command updates the sku of the Kusto pool "testnewkustopool" found in the workspace "testws". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePurge +A boolean value that indicates if the purge operations are enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableStreamingIngest +A boolean value that indicates if the streaming ingest is enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The ETag of the Kusto Pool. +Omit this value to always overwrite the current Kusto Pool. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: KustoPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleIsEnabled +A boolean value that indicate if the optimized autoscale feature is enabled or not. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleMaximum +Maximum allowed instances count. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleMinimum +Minimum allowed instances count. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimizedAutoscaleVersion +The version of the template defined, for instance 1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +The number of instances of the cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +SKU name. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuSize +SKU size. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.SkuSize +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceUid +The workspace unique identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IKustoPool + +## 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 `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseKustoPoolDataConnection.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseKustoPoolDataConnection.md new file mode 100644 index 0000000000..979e2a4da9 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseKustoPoolDataConnection.md @@ -0,0 +1,591 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapsekustopooldataconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseKustoPoolDataConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseKustoPoolDataConnection.md +--- + +# Update-AzSynapseKustoPoolDataConnection + +## SYNOPSIS +Updates a data connection. + +## SYNTAX + +### UpdateExpandedEventHub (Default) +``` +Update-AzSynapseKustoPoolDataConnection -DatabaseName <String> -DataConnectionName <String> + -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> -ConsumerGroup <String> + -EventHubResourceId <String> -Kind <DataConnectionKind> -Location <String> [-SubscriptionId <String>] + [-Compression <Compression>] [-DataFormat <EventGridDataFormat>] [-EventSystemProperty <String[]>] + [-MappingRuleName <String>] [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateExpandedEventGrid +``` +Update-AzSynapseKustoPoolDataConnection -DatabaseName <String> -DataConnectionName <String> + -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> -ConsumerGroup <String> + -EventHubResourceId <String> -Kind <DataConnectionKind> -Location <String> -StorageAccountResourceId <String> + [-SubscriptionId <String>] [-BlobStorageEventType <BlobStorageEventType>] [-DataFormat <EventGridDataFormat>] + [-IgnoreFirstRecord] [-MappingRuleName <String>] [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateExpandedIotHub +``` +Update-AzSynapseKustoPoolDataConnection -DatabaseName <String> -DataConnectionName <String> + -KustoPoolName <String> -ResourceGroupName <String> -WorkspaceName <String> -ConsumerGroup <String> + -IotHubResourceId <String> -Kind <DataConnectionKind> -Location <String> -SharedAccessPolicyName <String> + [-SubscriptionId <String>] [-DataFormat <EventGridDataFormat>] [-EventSystemProperty <String[]>] + [-MappingRuleName <String>] [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpandedEventGrid +``` +Update-AzSynapseKustoPoolDataConnection -InputObject <ISynapseIdentity> -ConsumerGroup <String> + -EventHubResourceId <String> -Kind <DataConnectionKind> -Location <String> -StorageAccountResourceId <String> + [-BlobStorageEventType <BlobStorageEventType>] [-DataFormat <EventGridDataFormat>] [-IgnoreFirstRecord] + [-MappingRuleName <String>] [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpandedEventHub +``` +Update-AzSynapseKustoPoolDataConnection -InputObject <ISynapseIdentity> -ConsumerGroup <String> + -EventHubResourceId <String> -Kind <DataConnectionKind> -Location <String> [-Compression <Compression>] + [-DataFormat <EventGridDataFormat>] [-EventSystemProperty <String[]>] [-MappingRuleName <String>] + [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpandedIotHub +``` +Update-AzSynapseKustoPoolDataConnection -InputObject <ISynapseIdentity> -ConsumerGroup <String> + -IotHubResourceId <String> -Kind <DataConnectionKind> -Location <String> -SharedAccessPolicyName <String> + [-DataFormat <EventGridDataFormat>] [-EventSystemProperty <String[]>] [-MappingRuleName <String>] + [-TableName <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates a data connection. + +## EXAMPLES + +### Example 1: Update an existing EventHub data connection +```powershell +Update-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventhubdc -Location eastus2 -Kind EventHub -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -DataFormat "JSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "EventsMapping" +``` + +```output +Kind Location Name +---- -------- ---- +EventHub East US 2 testws/testkustopool/testdatabase/eventhubdc +``` + +The above command updates the existing EventHub data connection named "eventhubdc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 2: Update an existing EventGrid data connection +```powershell +Update-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventgriddc -Location eastus2 -Kind EventGrid -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/teststorage" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" +``` + +```output +Kind Location Name +---- -------- ---- +EventGrid East US 2 testws/testkustopool/testdatabase/eventgriddc +``` + +The above command updates the existing EventGrid data connection named "eventgriddc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 3: Update an existing IotHub data connection +```powershell +Update-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name iothubdc -Location eastus2 -Kind IotHub -IotHubResourceId "/subscriptions/051ddeca-1ed6-4d8b-ba6f-1ff561e5f3b3/resourceGroups/ywtest/providers/Microsoft.Devices/IotHubs/ywtestiothub" -SharedAccessPolicyName registryRead -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" +``` + +```output +Kind Location Name +---- -------- ---- +IotHub East US 2 testws/testkustopool/testdatabase/iothubdc +``` + +The above command updates the existing IotHub data connection named "iothubdc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 4: Update an existing EventHub data connection via identity +```powershell +$dataConnection = Get-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventhubdc +Update-AzSynapseKustoPoolDataConnection -InputObject $dataConnection -Location eastus2 -Kind EventHub -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -DataFormat "JSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "EventsMapping" +``` + +```output +Kind Location Name +---- -------- ---- +EventHub East US 2 testws/testkustopool/testdatabase/eventhubdc +``` + +The above command updates the existing EventHub data connection named "eventhubdc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 5: Update an existing EventGrid data connection via identity +```powershell +$dataConnection = Get-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventgriddc +Update-AzSynapseKustoPoolDataConnection -InputObject $dataConnection -Location eastus2 -Kind EventGrid -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/teststorage" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" +``` + +```output +Kind Location Name +---- -------- ---- +EventGrid East US 2 testws/testkustopool/testdatabase/eventgriddc +``` + +The above command updates the existing EventGrid data connection named "eventgriddc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 6: Update an existing IotHub data connection via identity +```powershell +$dataConnection = Get-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name iothubdc +Update-AzSynapseKustoPoolDataConnection -InputObject $dataConnection -Location eastus2 -Kind IotHub -IotHubResourceId "/subscriptions/051ddeca-1ed6-4d8b-ba6f-1ff561e5f3b3/resourceGroups/ywtest/providers/Microsoft.Devices/IotHubs/ywtestiothub" -SharedAccessPolicyName registryRead -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" +``` + +```output +Kind Location Name +---- -------- ---- +IotHub East US 2 testws/testkustopool/testdatabase/iothubdc +``` + +The above command updates the existing IotHub data connection named "iothubdc" for the database "testdatabase" in the kusto pool "testkustopool". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobStorageEventType +The name of blob storage event type to process. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.BlobStorageEventType +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compression +The event hub messages compression type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.Compression +Parameter Sets: UpdateExpandedEventHub, UpdateViaIdentityExpandedEventHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsumerGroup +The event/iot hub consumer group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataConnectionName +The name of the data connection. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFormat +The data format of the message. +Optionally the data format can be added to each message. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.EventGridDataFormat +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubResourceId +The resource ID of the event hub to be used to create a data connection / event grid is configured to send events. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSystemProperty +System properties of the event/iot hub. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreFirstRecord +If set to true, indicates that ingestion should ignore the first record of every file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +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.Synapse.Models.ISynapseIdentity +Parameter Sets: UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubResourceId +The resource ID of the Iot hub to be used to create a data connection. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedIotHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the endpoint for the data connection + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.DataConnectionKind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MappingRuleName +The mapping rule to be used to ingest the data. +Optionally the mapping information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedAccessPolicyName +The name of the share access policy. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedIotHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The resource ID of the storage account where the data resides. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableName +The table where the data should be ingested. +Optionally the table information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDataConnection + +## 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 `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseKustoPoolDatabase.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseKustoPoolDatabase.md new file mode 100644 index 0000000000..4dcc98b7d5 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseKustoPoolDatabase.md @@ -0,0 +1,331 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapsekustopooldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseKustoPoolDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseKustoPoolDatabase.md +--- + +# Update-AzSynapseKustoPoolDatabase + +## SYNOPSIS +Updates a database. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSynapseKustoPoolDatabase -DatabaseName <String> -KustoPoolName <String> -ResourceGroupName <String> + -WorkspaceName <String> -Kind <Kind> [-SubscriptionId <String>] [-HotCachePeriod <TimeSpan>] + [-Location <String>] [-SoftDeletePeriod <TimeSpan>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSynapseKustoPoolDatabase -InputObject <ISynapseIdentity> -Kind <Kind> [-HotCachePeriod <TimeSpan>] + [-Location <String>] [-SoftDeletePeriod <TimeSpan>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a database. + +## EXAMPLES + +### Example 1: Update an existing database by name +```powershell +$2ds = New-TimeSpan -Days 2 +$4ds = New-TimeSpan -Days 4 +Update-AzSynapseKustoPoolDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase -Kind ReadWrite -SoftDeletePeriod $4ds -HotCachePeriod $2ds -Location 'East US' +``` + +```output +Kind Location Name +---- -------- ---- +ReadWrite East US testws/testkustopool/mykustodatabase +``` + +The above command updates the soft deletion period and hot cache period of the Kusto database "mykustodatabase" in the workspace "testws" found in the resource group "testrg". + +### Example 2: Update an existing database via identity +```powershell +$database = Get-AzSynapseKustoPoolDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase +$2ds = New-TimeSpan -Days 2 +$4ds = New-TimeSpan -Days 4 +Update-AzSynapseKustoPoolDatabase -InputObject $database -Kind ReadWrite -SoftDeletePeriod $4ds -HotCachePeriod $2ds -Location 'East US' +``` + +```output +Kind Location Name +---- -------- ---- +ReadWrite East US testws/testkustopool/mykustodatabase +``` + +The above command updates the soft deletion period and hot cache period of the Kusto database "mykustodatabase" in the workspace "testws" found in the resource group "testrg" via database identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HotCachePeriod +The time the data should be kept in cache for fast queries in TimeSpan. + +```yaml +Type: System.TimeSpan +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.Synapse.Models.ISynapseIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Kind of the database + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletePeriod +The time the data should be kept before it stops being accessible to queries in TimeSpan. + +```yaml +Type: System.TimeSpan +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDatabase + +## 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 `<ISynapseIdentity>`: Identity Parameter + - `[AttachedDatabaseConfigurationName <String>]`: The name of the attached database configuration. + - `[DataConnectionName <String>]`: The name of the data connection. + - `[DatabaseName <String>]`: The name of the database in the Kusto pool. + - `[Id <String>]`: Resource identity path + - `[KustoPoolName <String>]`: The name of the Kusto pool. + - `[Location <String>]`: The name of Azure region. + - `[PrincipalAssignmentName <String>]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[WorkspaceName <String>]`: The name of the workspace + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseLinkConnectionLandingZoneCredential.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseLinkConnectionLandingZoneCredential.md new file mode 100644 index 0000000000..1f1001dc24 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseLinkConnectionLandingZoneCredential.md @@ -0,0 +1,202 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapselinkconnectionlandingzonecredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseLinkConnectionLandingZoneCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseLinkConnectionLandingZoneCredential.md +--- + +# Update-AzSynapseLinkConnectionLandingZoneCredential + +## SYNOPSIS +Updates the landing zone credential of a link connection. + +## SYNTAX + +### UpdateByName (Default) +``` +Update-AzSynapseLinkConnectionLandingZoneCredential -WorkspaceName <String> -LinkConnectionName <String> + -SasToken <SecureString> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByObject +``` +Update-AzSynapseLinkConnectionLandingZoneCredential -WorkspaceObject <PSSynapseWorkspace> + -LinkConnectionName <String> -SasToken <SecureString> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObject +``` +Update-AzSynapseLinkConnectionLandingZoneCredential -InputObject <PSLinkConnectionResource> + -SasToken <SecureString> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSynapseLinkConnectionLandingZoneCredential** cmdlet updates the landing zone credential of a link connection. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSynapseLinkConnectionLandingZoneCredential -WorkspaceName ContosoWorkspace -LinkConnectionName ContosoLinkConnection -SasToken "SampleSasToken" +``` + +This command updates the landing zone credential with sas token "exampleSasToken" of link connection ContosoLinkConnection in workspace ContosoWorkspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Update-AzSynapseLinkConnectionLandingZoneCredential -LinkConnectionName ContosoLinkConnection -SasToken "SampleSasToken" +``` + +This command updates the landing zone credential with sas token "exampleSasToken" of link connection ContosoLinkConnection in workspace ContosoWorkspace through pipeline. + +### Example 3 +```powershell +$lc = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +$lc | Update-AzSynapseLinkConnectionLandingZoneCredential -SasToken "SampleSasToken" +``` + +This command updates the landing zone credential with sas token "exampleSasToken" of a link connection through pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The information about the link connection. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSLinkConnectionResource +Parameter Sets: UpdateByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LinkConnectionName +Name of link connection. + +```yaml +Type: System.String +Parameter Sets: UpdateByName, UpdateByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SasToken +Landing zone's sas token. + +```yaml +Type: Azure.Analytics.Synapse.Artifacts.Models.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: UpdateByObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSLinkConnectionResource + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseManagedVirtualNetworkConfig.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseManagedVirtualNetworkConfig.md new file mode 100644 index 0000000000..d9726c2a26 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseManagedVirtualNetworkConfig.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapsemanagedvirtualnetworkconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseManagedVirtualNetworkConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseManagedVirtualNetworkConfig.md +--- + +# Update-AzSynapseManagedVirtualNetworkConfig + +## SYNOPSIS +Updates managed virtual network configuration to workspace. + +## SYNTAX + +``` +Update-AzSynapseManagedVirtualNetworkConfig -WorkspaceObject <PSSynapseWorkspace> + [-PreventDataExfiltration <Boolean>] [-AllowedAadTenantIdsForLinking <String[]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSynapseManagedVirtualNetworkConfig** cmdlet updates managed virtual network configuration to workspace. + +## EXAMPLES + +### Example 1 +```powershell +$ws = Get-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace +$ws = $ws | Update-AzSynapseManagedVirtualNetworkConfig -AllowedAadTenantIdsForLinking a96040c4-18dd-4dde-8181-f70daca04919 +$ws | Update-AzSynapseWorkspace +``` + +The first command retrieves a workspace object. The second command updates the allowed AAD tenant IDs. The third command updates the workspace. + +## PARAMETERS + +### -AllowedAadTenantIdsForLinking +The allowed AAD tenant IDs for linking. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreventDataExfiltration +Indicates whether to prevent data exfiltration. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseSparkPool.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseSparkPool.md new file mode 100644 index 0000000000..851827ed97 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseSparkPool.md @@ -0,0 +1,660 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapsesparkpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSparkPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSparkPool.md +--- + +# Update-AzSynapseSparkPool + +## SYNOPSIS +Updates a Apache Spark pool in Azure Synapse Analytics. + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Update-AzSynapseSparkPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + [-Tag <Hashtable>] [-EnableAutoScale <Boolean>] [-AutoScaleMinNodeCount <Int32>] + [-AutoScaleMaxNodeCount <Int32>] [-EnableAutoPause <Boolean>] [-AutoPauseDelayInMinute <Int32>] + [-NodeCount <Int32>] [-EnableIsolatedCompute <Boolean>] [-NodeSize <String>] + [-EnableDynamicExecutorAllocation <Boolean>] [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>] + [-SparkVersion <String>] [-LibraryRequirementsFilePath <String>] + [-SparkConfiguration <PSSparkConfigurationResource>] [-PackageAction <PackageActionType>] + [-Package <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>] + [-ForceApplySetting] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByParentObjectParameterSet +``` +Update-AzSynapseSparkPool -Name <String> -WorkspaceObject <PSSynapseWorkspace> [-Tag <Hashtable>] + [-EnableAutoScale <Boolean>] [-AutoScaleMinNodeCount <Int32>] [-AutoScaleMaxNodeCount <Int32>] + [-EnableAutoPause <Boolean>] [-AutoPauseDelayInMinute <Int32>] [-NodeCount <Int32>] + [-EnableIsolatedCompute <Boolean>] [-NodeSize <String>] [-EnableDynamicExecutorAllocation <Boolean>] + [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>] [-SparkVersion <String>] + [-LibraryRequirementsFilePath <String>] [-SparkConfiguration <PSSparkConfigurationResource>] + [-PackageAction <PackageActionType>] + [-Package <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>] + [-ForceApplySetting] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Update-AzSynapseSparkPool -InputObject <PSSynapseSparkPool> [-Tag <Hashtable>] [-EnableAutoScale <Boolean>] + [-AutoScaleMinNodeCount <Int32>] [-AutoScaleMaxNodeCount <Int32>] [-EnableAutoPause <Boolean>] + [-AutoPauseDelayInMinute <Int32>] [-NodeCount <Int32>] [-EnableIsolatedCompute <Boolean>] [-NodeSize <String>] + [-EnableDynamicExecutorAllocation <Boolean>] [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>] + [-SparkVersion <String>] [-LibraryRequirementsFilePath <String>] + [-SparkConfiguration <PSSparkConfigurationResource>] [-PackageAction <PackageActionType>] + [-Package <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>] + [-ForceApplySetting] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Update-AzSynapseSparkPool -ResourceId <String> [-Tag <Hashtable>] [-EnableAutoScale <Boolean>] + [-AutoScaleMinNodeCount <Int32>] [-AutoScaleMaxNodeCount <Int32>] [-EnableAutoPause <Boolean>] + [-AutoPauseDelayInMinute <Int32>] [-NodeCount <Int32>] [-EnableIsolatedCompute <Boolean>] [-NodeSize <String>] + [-EnableDynamicExecutorAllocation <Boolean>] [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>] + [-SparkVersion <String>] [-LibraryRequirementsFilePath <String>] + [-SparkConfiguration <PSSparkConfigurationResource>] [-PackageAction <PackageActionType>] + [-Package <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>] + [-ForceApplySetting] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSynapseSparkPool** cmdlet updates an Apache Spark pool in Azure Synapse Analytics. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -Tag @{"key" = "value"} -NodeCount 5 -NodeSize Medium +``` + +This command updates an Apache Spark pool in Azure Synapse Analytics. + +### Example 2 +```powershell +$pool = Get-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool +$pool | Update-AzSynapseSparkPool -Tag @{"key" = "value1"} +``` + +This command updates an Apache Spark pool in Azure Synapse Analytics through pipeline. + +### Example 3 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Update-AzSynapseSparkPool -Name ContosoSparkPool -Tag @{"key" = "value2"} +``` + +This command updates an Apache Spark pool in Azure Synapse Analytics through pipeline. + +### Example 4 +```powershell +Update-AzSynapseSparkPool -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/bigDataPools/ContosoSparkPool -Tag @{"key" = "value3"} +``` + +This command updates an Apache Spark pool in Azure Synapse Analytics with resource ID. + +### Example 5 +```powershell +Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -EnableAutoScale $true -AutoScaleMinNodeCount 3 -AutoScaleMaxNodeCount 7 +``` + +This command enables auto-scale for an Apache Spark pool in Azure Synapse Analytics. + +### Example 6 +```powershell +Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -EnableAutoScale $false +``` + +This command disables auto-scale for an Apache Spark pool in Azure Synapse Analytics. + +### Example 7 +```powershell +Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -EnableAutoPause $true -AutoPauseDelayInMinute 15 +``` + +This command enables auto-pause for an Apache Spark pool in Azure Synapse Analytics. + +### Example 8 +```powershell +Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -EnableAutoPause $false +``` + +This command disables auto-pause for an Apache Spark pool in Azure Synapse Analytics. + +### Example 9 +```powershell +Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -EnableDynamicExecutorAllocation $true -MinExecutorCount 1 -MaxExecutorCount 5 +``` + +This command enables dynamic executor allocation and specify min executor count and max executor count for an Apache Spark pool in Azure Synapse Analytics. + +### Example 10 +```powershell +Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -EnableDynamicExecutorAllocation $false +``` + +This command disables dynamic executor allocation for an Apache Spark pool in Azure Synapse Analytics. + +### Example 11 +```powershell +$packages = Get-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace +Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -PackageAction Add -Package $packages +``` + +The first command retrieves workspace packages. The second command links these workspace packages to an Apache Spark pool in Azure Synapse Analytics. + +### Example 12 +```powershell +$package = Get-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace -Name ContosoPackage +Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -PackageAction Remove -Package $package +``` + +The first command retrieves workspace packages named ContosoPackage. The second command removes the workspace package from an Apache Spark pool in Azure Synapse Analytics. + +### Example 13 +```powershell +$pool = Get-AzSynapseSparkPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSparkPool +$pool | Update-AzSynapseSparkPool -PackageAction Remove -Package $pool.WorkspacePackages +``` + +The first command retrieves an Apache Spark pool in Azure Synapse Analytics. The second command removes all workspace packages that are linked to that Apache Spark pool. + +### Example 14 +```powershell +$workspace_packages = Get-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace + +$pool = Get-AzSynapseSparkPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSparkPool +$library_names = $pool.WorkspacePackages | Where-Object {$_.name -notlike "new_package-*"} | ForEach-Object {$_.name} +$library_names += "new_package-2.0-py3-none-any.whl" + +$new_pool_packages = @($workspace_packages | Where-Object {$_.name -in $library_names}) +Update-AzSynapseSparkPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -PackageAction Set -Package $new_pool_packages +``` + +The first command retrieves the packages available in the workspace. The second command group retrieves the spark pool to get the packages currently linked to this pool and removes all versions of the package starting with `new_package-` from the retrieved list. The new version of the package is then added to this list. In the third group of commands the package list, containing only package names, is tranformed into a list of workspace packages by filtering the list of available workspace_packages accordingly and is then linked to the spark pool. + +### Example 15 +```powershell +$config = Get-AzSynapseSparkConfiguration -WorkspaceName ContosoWorkspace -Name ContosoSparkConfig1 +Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -Tag @{"key" = "value"} -NodeCount 5 -NodeSize Medium -SparkConfiguration $configs +``` + +This command updates an Apache Spark pool in Azure Synapse Analytics and specify a Spark configuration for the Spark pool. + +### Example 16 +```powershell +Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -NodeSize small -ForceApplySetting +``` + +This command updates an Apache Spark pool in Azure Synapse Analytics, set NodeSize to small for the spark pool and force stop any running jobs in the Spark pool to apply this new setting. + +### Example 17 +```powershell +$pool = Get-AzSynapseSparkPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSparkPool +$pool | Update-AzSynapseSparkPool -PackageAction Remove -Package $pool.WorkspacePackages -ForceApplySetting +``` + +The first command retrieves an Apache Spark pool in Azure Synapse Analytics. The second command removes all workspace packages that are linked to that Apache Spark pool and force stop any running jobs in the Spark pool to apply this new setting. + +### Example 18 +```powershell +Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -EnableIsolatedCompute $true -NodeSize XXXLarge +``` + +This command enables isolated compute and specify node size to XXXLarge(80 vCPU / 504 GB) for an Apache Spark pool in Azure Synapse Analytics. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoPauseDelayInMinute +Number of minutes idle. This parameter can be specified when Auto-pause is enabled. The default value will be [15] if it is not specified manually. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoScaleMaxNodeCount +Maximum number of nodes to be allocated in the specified Spark pool. +This parameter must be specified when Auto-scale is enabled. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoScaleMinNodeCount +Minimum number of nodes to be allocated in the specified Spark pool. +This parameter must be specified when Auto-scale is enabled. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoPause +Indicates whether Auto-pause should be enabled. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAutoScale +Indicates whether Auto-scale should be enabled + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDynamicExecutorAllocation +Indicates whether dynamic executor allocation should be enabled. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableIsolatedCompute +The Isolate Compute option is only available with the XXXLarge (80 vCPU / 504 GB) node size. Enabling this option offers isolation for Apache Spark compute for untrusted services. Isolated compute costs the same as the non-isolated VM of the same size. If you expect to enable Isolated Compute for spark pool, ensure that your Synapse workspace is created in an isolated compute supported region, please refer to this document for more details: https://learn.microsoft.com/en-us/azure/synapse-analytics/spark/apache-spark-pool-configurations#isolated-compute. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceApplySetting +Whether to stop any running jobs in the Big Data pool. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Spark pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LibraryRequirementsFilePath +Environment configuration file ("PIP freeze" output). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxExecutorCount +Maximum number of executors to be allocated in the specified Spark pool. This parameter can be specified when DynamicExecutorAllocation is enabled. The value should lie between 1 (inclusive) and maximumNodeCount (exclusive). If it is not specified manually, the default value will be 2. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinExecutorCount +Minimum number of executors to be allocated in the specified Spark pool. This parameter can be specified when DynamicExecutorAllocation is enabled. The value should lie between 1 (inclusive) and maxExecutors (exclusive). If it is not specified manually, the default value will be 1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet, SetByParentObjectParameterSet +Aliases: SparkPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeCount +Number of nodes to be allocated in the specified Spark pool. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeSize +Number of core and memory to be used for nodes allocated in the specified Spark pool. +This parameter must be specified when Auto-scale is disabled + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Small, Medium, Large, XLarge, XXLarge, XXXLarge + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Package +The workspace packages. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage] +Parameter Sets: (All) +Aliases: WorkspacePackage + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PackageAction +Package action must be specified when you add or remove a workspace package from a Apache Spark pool. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+PackageActionType +Parameter Sets: (All) +Aliases: +Accepted values: Add, Remove, Set + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkConfiguration +Apache Spark configuration. When a job is submitted to the pool, the properties specified in the selected configuration will be referenced. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSparkConfigurationResource +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkVersion +Apache Spark version. +Allowed values: 2.3,2.4,3.1,3.2 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A string,string dictionary of tags associated with the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..cdc393acd8 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlAdvancedThreatProtectionSetting.md @@ -0,0 +1,264 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapsesqladvancedthreatprotectionsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSqlAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSqlAdvancedThreatProtectionSetting.md +--- + +# Update-AzSynapseSqlAdvancedThreatProtectionSetting + +## SYNOPSIS +Updates an advanced threat protection settings on a workspace. + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Update-AzSynapseSqlAdvancedThreatProtectionSetting [-ResourceGroupName <String>] -WorkspaceName <String> + [-NotificationRecipientsEmail <String>] [-EmailAdmin <Boolean>] [-ExcludedDetectionType <String[]>] + [-StorageAccountName <String>] [-RetentionInDays <UInt32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzSynapseSqlAdvancedThreatProtectionSetting -InputObject <PSSynapseWorkspace> + [-NotificationRecipientsEmail <String>] [-EmailAdmin <Boolean>] [-ExcludedDetectionType <String[]>] + [-StorageAccountName <String>] [-RetentionInDays <UInt32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByResourceIdParameterSet +``` +Update-AzSynapseSqlAdvancedThreatProtectionSetting -ResourceId <String> [-NotificationRecipientsEmail <String>] + [-EmailAdmin <Boolean>] [-ExcludedDetectionType <String[]>] [-StorageAccountName <String>] + [-RetentionInDays <UInt32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSynapseSqlAdvancedThreatProtectionSetting** cmdlet updates an advanced threat protection settings on an Azure Synapse Analytics Workspace. In order to enable advanced threat protection on a workspace an auditing settings must be enabled on that workspace. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSynapseSqlAdvancedThreatProtectionSetting -WorkspaceName ContosoWorkspace -NotificationRecipientsEmail "admin01@contoso.com;secadmin@contoso.com" -EmailAdmin $False -ExcludedDetectionType "Sql_Injection_Vulnerability","SQL_Injection" -StorageAccountName "mystorageAccount" +``` + +This command updates the advanced threat protection settings for a workspace named ContosoWorkspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAdmin +Defines whether to email administrators. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: EmailAdmins + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedDetectionType +Detection types to exclude. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NotificationRecipientsEmail +A semicolon separated list of email addresses to send the alerts to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: NotificationRecipientsEmails + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionInDays +The number of retention days for the audit logs. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSServerSecurityAlertPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlDatabase.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlDatabase.md new file mode 100644 index 0000000000..93ddb313ea --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlDatabase.md @@ -0,0 +1,253 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapsesqldatabase +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSqlDatabase.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSqlDatabase.md +--- + +# Update-AzSynapseSqlDatabase + +## SYNOPSIS +This feature is in a limited preview, initially accessible only to certain subscriptions. Updates a Synapse Analytics SQL database. + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Update-AzSynapseSqlDatabase [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> + [-Tag <Hashtable>] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByParentObjectParameterSet +``` +Update-AzSynapseSqlDatabase -Name <String> -WorkspaceObject <PSSynapseWorkspace> [-Tag <Hashtable>] [-PassThru] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzSynapseSqlDatabase -InputObject <PSSynapseSqlDatabase> [-Tag <Hashtable>] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByResourceIdParameterSet +``` +Update-AzSynapseSqlDatabase -ResourceId <String> [-Tag <Hashtable>] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSynapseSqlDatabase** cmdlet updates an Azure Synapse Analytics SQL database. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSynapseSqlDatabase -WorkspaceName ContosoWorkspace -Name ContosoSqlDatabase -Tag @{'key'='value'} +``` + +This command updates an Azure Synapse Analytics SQL database. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL Database input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlDatabase +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL Database. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, UpdateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. +If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Database. + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A string,string dictionary of tags associated with the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: UpdateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlDatabase + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlDatabase + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlPool.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlPool.md new file mode 100644 index 0000000000..ec3a483f58 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlPool.md @@ -0,0 +1,308 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapsesqlpool +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSqlPool.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSqlPool.md +--- + +# Update-AzSynapseSqlPool + +## SYNOPSIS +Updates a Synapse Analytics SQL pool. + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Update-AzSynapseSqlPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-Version <Int32>] + [-Tag <Hashtable>] [-PerformanceLevel <String>] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByParentObjectParameterSet +``` +Update-AzSynapseSqlPool -Name <String> [-Version <Int32>] -WorkspaceObject <PSSynapseWorkspace> + [-Tag <Hashtable>] [-PerformanceLevel <String>] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzSynapseSqlPool [-Version <Int32>] -InputObject <PSSynapseSqlPool> [-Tag <Hashtable>] + [-PerformanceLevel <String>] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### UpdateByResourceIdParameterSet +``` +Update-AzSynapseSqlPool [-Version <Int32>] -ResourceId <String> [-Tag <Hashtable>] [-PerformanceLevel <String>] + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSynapseSqlPool** cmdlet updates an Azure Synapse Analytics SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -Tag @{'key'='value'} -PerformanceLevel DW300c +``` + +This command updates an Azure Synapse Analytics SQL pool. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Update-AzSynapseSqlPool -Name ContosoSqlPool -Tag @{'key'='value1'} +``` + +This command updates an Azure Synapse Analytics SQL pool through pipeline. + +### Example 3 +```powershell +$pool = Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool +$pool | Update-AzSynapseSqlPool -Tag @{'key'='value2'} +``` + +This command updates an Azure Synapse Analytics SQL pool through pipeline. + +### Example 4 +```powershell +Update-AzSynapseSqlPool -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd3/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/sqlPools/ContosoSqlPool -Tag @{'key'='value3'} +``` + +This command updates an Azure Synapse Analytics SQL pool with resource ID. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, UpdateByParentObjectParameterSet +Aliases: SqlPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PerformanceLevel +The SQL Service tier and performance level to assign to the SQL pool. +For example, DW2000c. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A string,string dictionary of tags associated with the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Version of Synapse SQL pool. For example, 2 or 3. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: UpdateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md new file mode 100644 index 0000000000..6b7c719eb3 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md @@ -0,0 +1,305 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapsesqlpooladvancedthreatprotectionsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting.md +--- + +# Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting + +## SYNOPSIS +Sets a advanced threat protection settings on a SQL pool. + +## SYNTAX + +### UpdateByNameParameterSet (Default) +``` +Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> [-NotificationRecipientsEmail <String>] [-EmailAdmin <Boolean>] + [-ExcludedDetectionType <String[]>] [-StorageAccountName <String>] [-RetentionInDays <UInt32>] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByParentObjectParameterSet +``` +Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting -Name <String> -WorkspaceObject <PSSynapseWorkspace> + [-NotificationRecipientsEmail <String>] [-EmailAdmin <Boolean>] [-ExcludedDetectionType <String[]>] + [-StorageAccountName <String>] [-RetentionInDays <UInt32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByInputObjectParameterSet +``` +Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting -InputObject <PSSynapseSqlPool> + [-NotificationRecipientsEmail <String>] [-EmailAdmin <Boolean>] [-ExcludedDetectionType <String[]>] + [-StorageAccountName <String>] [-RetentionInDays <UInt32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByResourceIdParameterSet +``` +Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting -ResourceId <String> + [-NotificationRecipientsEmail <String>] [-EmailAdmin <Boolean>] [-ExcludedDetectionType <String[]>] + [-StorageAccountName <String>] [-RetentionInDays <UInt32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting** cmdlet sets a advanced threat protection settings on an Azure Synapse Analytics SQL pool. +In order to enable advanced threat protection on a SQL pool an auditing settings must be enabled on that SQL pool. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability", "SQL_Injection" -StorageAccountName "mystorageAccount" +``` + +This command sets the advanced threat protection settings for a SQL pool named ContosoSqlPool under the workspace named ContosoWorkspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAdmin +Defines whether to email administrators. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: EmailAdmins + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedDetectionType +Detection types to exclude. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: UpdateByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet, UpdateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationRecipientsEmail +A semicolon separated list of email addresses to send the alerts to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: NotificationRecipientsEmails + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: UpdateByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionInDays +The number of retention days for the audit logs. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateByNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: UpdateByParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSqlPoolSecurityAlertPolicy + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..d23f5ed4d5 --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md @@ -0,0 +1,363 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapsesqlpoolvulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md +--- + +# Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting + +## SYNOPSIS +Updates the vulnerability assessment settings of a SQL pool. + +## SYNTAX + +### UpdateByStorageAccountNameAndNameParameterSet (Default) +``` +Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> [-StorageAccountName <String>] [-ScanResultsContainerName <String>] + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmin <Boolean>] [-NotificationEmail <String[]>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByBlobStorageSasUriAndNameParameterSet +``` +Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting [-ResourceGroupName <String>] -WorkspaceName <String> + -Name <String> -BlobStorageSasUri <Uri> [-RecurringScansInterval <RecurringScansInterval>] + [-EmailAdmin <Boolean>] [-NotificationEmail <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByStorageAccountNameAndParentObjectParameterSet +``` +Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting -Name <String> -WorkspaceObject <PSSynapseWorkspace> + [-StorageAccountName <String>] [-ScanResultsContainerName <String>] + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmin <Boolean>] [-NotificationEmail <String[]>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByBlobStorageSasUriAndParentObjectParameterSet +``` +Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting -Name <String> -WorkspaceObject <PSSynapseWorkspace> + -BlobStorageSasUri <Uri> [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmin <Boolean>] + [-NotificationEmail <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByStorageAccountNameAndInputObjectParameterSet +``` +Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting -InputObject <PSSynapseSqlPool> + [-StorageAccountName <String>] [-ScanResultsContainerName <String>] + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmin <Boolean>] [-NotificationEmail <String[]>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByBlobStorageSasUriAndInputObjectParameterSet +``` +Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting -InputObject <PSSynapseSqlPool> -BlobStorageSasUri <Uri> + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmin <Boolean>] [-NotificationEmail <String[]>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByStorageAccountNameAndResourceIdParameterSet +``` +Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting -ResourceId <String> [-StorageAccountName <String>] + [-ScanResultsContainerName <String>] [-RecurringScansInterval <RecurringScansInterval>] + [-EmailAdmin <Boolean>] [-NotificationEmail <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByBlobStorageSasUriAndResourceIdParameterSet +``` +Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting -ResourceId <String> -BlobStorageSasUri <Uri> + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmin <Boolean>] [-NotificationEmail <String[]>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting** cmdlet updates the vulnerability assessment settings of an Azure Synapse Analytics SQL pool. +Note that you need to run *Enable-AzSynapseSqlAdvancedDataSecurity* cmdlet as a prerequisite for using this cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" -RecurringScansInterval Weekly -EmailAdmin $true ` + -NotificationEmail @("mail1@mail.com","mail2@mail.com") +``` + +This command updates Vulnerability Assessment settings with storage account name. + +### Example 2 +```powershell +Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool ` + -BlobStorageSasUri "https://mystorage.blob.core.windows.net/vulnerability-assessment?st=XXXXXX" ` + -RecurringScansInterval Weekly -EmailAdmin $true ` + -NotificationEmail @("mail1@mail.com","mail2@mail.com") +``` + +This command updates Vulnerability Assessment settings with blob storage SAS URI. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobStorageSasUri +A SAS URI to a storage container that will hold the scan results. + +```yaml +Type: System.Uri +Parameter Sets: UpdateByBlobStorageSasUriAndNameParameterSet, UpdateByBlobStorageSasUriAndParentObjectParameterSet, UpdateByBlobStorageSasUriAndInputObjectParameterSet, UpdateByBlobStorageSasUriAndResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAdmin +A value indicating whether to email service and co-administrators on recurring scan completion. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: EmailAdmins + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +SQL pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool +Parameter Sets: UpdateByStorageAccountNameAndInputObjectParameterSet, UpdateByBlobStorageSasUriAndInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Synapse SQL pool. + +```yaml +Type: System.String +Parameter Sets: UpdateByStorageAccountNameAndNameParameterSet, UpdateByBlobStorageSasUriAndNameParameterSet, UpdateByStorageAccountNameAndParentObjectParameterSet, UpdateByBlobStorageSasUriAndParentObjectParameterSet +Aliases: SqlPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationEmail +A list of mail addresses to send on recurring scan completion. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurringScansInterval +The recurring scans interval. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.RecurringScansInterval +Parameter Sets: (All) +Aliases: +Accepted values: None, Weekly + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateByStorageAccountNameAndNameParameterSet, UpdateByBlobStorageSasUriAndNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse SQL Pool. + +```yaml +Type: System.String +Parameter Sets: UpdateByStorageAccountNameAndResourceIdParameterSet, UpdateByBlobStorageSasUriAndResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanResultsContainerName +The name of the storage container that will hold the scan results. + +```yaml +Type: System.String +Parameter Sets: UpdateByStorageAccountNameAndNameParameterSet, UpdateByStorageAccountNameAndParentObjectParameterSet, UpdateByStorageAccountNameAndInputObjectParameterSet, UpdateByStorageAccountNameAndResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account that will hold the scan results. + +```yaml +Type: System.String +Parameter Sets: UpdateByStorageAccountNameAndNameParameterSet, UpdateByStorageAccountNameAndParentObjectParameterSet, UpdateByStorageAccountNameAndInputObjectParameterSet, UpdateByStorageAccountNameAndResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateByStorageAccountNameAndNameParameterSet, UpdateByBlobStorageSasUriAndNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: UpdateByStorageAccountNameAndParentObjectParameterSet, UpdateByBlobStorageSasUriAndParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.SqlPoolVulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlVulnerabilityAssessmentSetting.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlVulnerabilityAssessmentSetting.md new file mode 100644 index 0000000000..afc953612d --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseSqlVulnerabilityAssessmentSetting.md @@ -0,0 +1,324 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapsesqlvulnerabilityassessmentsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSqlVulnerabilityAssessmentSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseSqlVulnerabilityAssessmentSetting.md +--- + +# Update-AzSynapseSqlVulnerabilityAssessmentSetting + +## SYNOPSIS +Updates the vulnerability assessment settings of a workspace. + +## SYNTAX + +### UpdateByStorageAccountNameAndNameParameterSet (Default) +``` +Update-AzSynapseSqlVulnerabilityAssessmentSetting [-ResourceGroupName <String>] -WorkspaceName <String> + [-StorageAccountName <String>] [-ScanResultsContainerName <String>] + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmin <Boolean>] [-NotificationEmail <String[]>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByBlobStorageSasUriAndNameParameterSet +``` +Update-AzSynapseSqlVulnerabilityAssessmentSetting [-ResourceGroupName <String>] -WorkspaceName <String> + -BlobStorageSasUri <Uri> [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmin <Boolean>] + [-NotificationEmail <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### UpdateByStorageAccountNameAndInputObjectParameterSet +``` +Update-AzSynapseSqlVulnerabilityAssessmentSetting -InputObject <PSSynapseWorkspace> + [-StorageAccountName <String>] [-ScanResultsContainerName <String>] + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmin <Boolean>] [-NotificationEmail <String[]>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByBlobStorageSasUriAndInputObjectParameterSet +``` +Update-AzSynapseSqlVulnerabilityAssessmentSetting -InputObject <PSSynapseWorkspace> -BlobStorageSasUri <Uri> + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmin <Boolean>] [-NotificationEmail <String[]>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByStorageAccountNameAndResourceIdParameterSet +``` +Update-AzSynapseSqlVulnerabilityAssessmentSetting -ResourceId <String> [-StorageAccountName <String>] + [-ScanResultsContainerName <String>] [-RecurringScansInterval <RecurringScansInterval>] + [-EmailAdmin <Boolean>] [-NotificationEmail <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateByBlobStorageSasUriAndResourceIdParameterSet +``` +Update-AzSynapseSqlVulnerabilityAssessmentSetting -ResourceId <String> -BlobStorageSasUri <Uri> + [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmin <Boolean>] [-NotificationEmail <String[]>] + [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSynapseSqlVulnerabilityAssessmentSetting** cmdlet updates the vulnerability assessment settings of an Azure Synapse Analytics workspace. +Before updates the settings, you need to enable the Azure defender for SQL. + +> [!IMPORTANT] +> If the virtual networks and the firewall enabled for the storage account, "-BlobStorageSasUri" parameter is required to update the vulnerability assessment settings. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSynapseSqlVulnerabilityAssessmentSetting ` + -WorkspaceName "ContosoWorkspace"` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +This command updates Vulnerability Assessment settings with storage account name. + +### Example 2 +```powershell +Update-AzSynapseSqlVulnerabilityAssessmentSetting ` + -WorkspaceName "ContosoWorkspace"` + -BlobStorageSasUri "https://mystorage.blob.core.windows.net/vulnerability-assessment?st=XXXXXX" ` + -RecurringScansInterval Weekly ` + -EmailAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +This command updates Vulnerability Assessment settings with blob storage SAS URI. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobStorageSasUri +A SAS URI to a storage container that will hold the scan results. + +```yaml +Type: System.Uri +Parameter Sets: UpdateByBlobStorageSasUriAndNameParameterSet, UpdateByBlobStorageSasUriAndInputObjectParameterSet, UpdateByBlobStorageSasUriAndResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAdmin +A value indicating whether to email service and co-administrators on recurring scan completion. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: EmailAdmins + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: UpdateByStorageAccountNameAndInputObjectParameterSet, UpdateByBlobStorageSasUriAndInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NotificationEmail +A list of mail addresses to send on recurring scan completion. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecurringScansInterval +The recurring scans interval. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.RecurringScansInterval +Parameter Sets: (All) +Aliases: +Accepted values: None, Weekly + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: UpdateByStorageAccountNameAndNameParameterSet, UpdateByBlobStorageSasUriAndNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateByStorageAccountNameAndResourceIdParameterSet, UpdateByBlobStorageSasUriAndResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScanResultsContainerName +The name of the storage container that will hold the scan results. + +```yaml +Type: System.String +Parameter Sets: UpdateByStorageAccountNameAndNameParameterSet, UpdateByStorageAccountNameAndInputObjectParameterSet, UpdateByStorageAccountNameAndResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account that will hold the scan results. + +```yaml +Type: System.String +Parameter Sets: UpdateByStorageAccountNameAndNameParameterSet, UpdateByStorageAccountNameAndInputObjectParameterSet, UpdateByStorageAccountNameAndResourceIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: UpdateByStorageAccountNameAndNameParameterSet, UpdateByBlobStorageSasUriAndNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.VulnerabilityAssessmentSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Update-AzSynapseWorkspace.md b/azps-10.1.0/Az.Synapse/Update-AzSynapseWorkspace.md new file mode 100644 index 0000000000..66e2ea3b3d --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Update-AzSynapseWorkspace.md @@ -0,0 +1,476 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/update-azsynapseworkspace +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseWorkspace.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Update-AzSynapseWorkspace.md +--- + +# Update-AzSynapseWorkspace + +## SYNOPSIS +Updates a Synapse Analytics workspace. + +## SYNTAX + +### SetByNameParameterSet (Default) +``` +Update-AzSynapseWorkspace [-ResourceGroupName <String>] -Name <String> [-Tag <Hashtable>] + [-SqlAdministratorLoginPassword <SecureString>] [-ManagedVirtualNetwork <PSManagedVirtualNetworkSettings>] + [-EncryptionKeyName <String>] [-UserAssignedIdentityInEncryption <String>] + [-UseSystemAssignedIdentityInEncryption <Object>] [-GitRepository <PSWorkspaceRepositoryConfiguration>] + [-UserAssignedIdentityAction <UserAssignedManagedIdentityActionType>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-EnablePublicNetworkAccess <Boolean>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetByInputObjectParameterSet +``` +Update-AzSynapseWorkspace -InputObject <PSSynapseWorkspace> [-Tag <Hashtable>] + [-SqlAdministratorLoginPassword <SecureString>] [-ManagedVirtualNetwork <PSManagedVirtualNetworkSettings>] + [-EncryptionKeyName <String>] [-UserAssignedIdentityInEncryption <String>] + [-UseSystemAssignedIdentityInEncryption <Object>] [-GitRepository <PSWorkspaceRepositoryConfiguration>] + [-UserAssignedIdentityAction <UserAssignedManagedIdentityActionType>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-EnablePublicNetworkAccess <Boolean>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### SetByResourceIdParameterSet +``` +Update-AzSynapseWorkspace -ResourceId <String> [-Tag <Hashtable>] + [-SqlAdministratorLoginPassword <SecureString>] [-ManagedVirtualNetwork <PSManagedVirtualNetworkSettings>] + [-EncryptionKeyName <String>] [-UserAssignedIdentityInEncryption <String>] + [-UseSystemAssignedIdentityInEncryption <Object>] [-GitRepository <PSWorkspaceRepositoryConfiguration>] + [-UserAssignedIdentityAction <UserAssignedManagedIdentityActionType>] + [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>] + [-EnablePublicNetworkAccess <Boolean>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzSynapseWorkspace** cmdlet updates an Azure Synapse Analytics workspace. + +## EXAMPLES + +### Example 1 +```powershell +Update-AzSynapseWorkspace -Name ContosoWorkspace -Tag @{'key'='value'} +``` + +This commands updates tags for the specififed Azure Synapse Analytics workspace. + +### Example 2 +```powershell +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Update-AzSynapseWorkspace -Tag @{'key'='value1'} +``` + +This commands updates tags for the specififed Azure Synapse Analytics workspace through pipeline. + +### Example 3 +```powershell +Update-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace -Tag @{'key'='value2'} +``` + +This commands updates tags for the specififed Azure Synapse Analytics workspace through pipeline with resource ID. + +### Example 4 +```powershell +$config = New-AzSynapseGitRepositoryConfig -RepositoryType GitHub -AccountName ContosoAccount -RepositoryName ContosoRepo -CollaborationBranch main +Update-AzSynapseWorkspace -Name ContosoWorkspace -GitRepository $config +``` + +This commands updates Git repository which workspace is conneceted to for the specififed Azure Synapse Analytics workspace. + +### Example 5 +```powershell +Update-AzSynapseWorkspace -Name ContosoWorkspace -EnablePublicNetworkAccess $True +``` + +This commands updates the specififed Azure Synapse Analytics workspace to enable public network access. + +### Example 6 +```powershell +$uamis = Get-AzUserAssignedIdentity -ResourceGroupName ContosoResourceGroup +$uamilist = New-Object System.Collections.Generic.List[string] +foreach($uami in $uamis){ + $uamilist.Add($uami.Id) +} + +Update-AzSynapseWorkspace -Name ContosoWorkspace -UserAssignedIdentityAction Add -UserAssignedIdentityId $uamilist +``` + +This commands updates workspace to add user assigned managed identites in $uamilist. + +### Example 7 +```powershell +$uamis = Get-AzUserAssignedIdentity -ResourceGroupName ContosoResourceGroup +$uamilist = New-Object System.Collections.Generic.List[string] +foreach($uami in $uamis){ + $uamilist.Add($uami.Id) +} + +Update-AzSynapseWorkspace -Name ContosoWorkspace -UserAssignedIdentityAction Remove -UserAssignedIdentityId $uamilist[0] +``` + +This commands removes user assigned managed identites $uamilist[0] from workspace. + +### Example 8 +```powershell +$uamis = Get-AzUserAssignedIdentity -ResourceGroupName ContosoResourceGroup +$uamilist = New-Object System.Collections.Generic.List[string] +foreach($uami in $uamis){ + $uamilist.Add($uami.Id) +} + +Update-AzSynapseWorkspace -Name ContosoWorkspace -UserAssignedIdentityAction Set -UserAssignedIdentityId $uamilist +``` + +This commands updates workspace with user assigned managed identites $uamilist that will cover current identities. + +### Example 9 +```powershell + +##Add a temp key to the workspace +New-AzSynapseWorkspaceKey -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name TempKey -EncryptionKeyIdentifier https://contosoKeyVault.vault.azure.net/keys/TempKey + +##Update the workspace and set the temp key as the TDE protector +Update-AzSynapseWorkspace -WorkspaceName ContosoWorkspace -EncryptionKeyName TempKey -UseSystemAssignedIdentityInEncryption $true + +##Note, we need to create a new key version for the original encrytion key of the Azure key vault before moving to next steps. + +##Update the workspace and set the encryption key back after we created a new key version. +Update-AzSynapseWorkspace -WorkspaceName ContosoWorkspace -EncryptionKeyName default -UseSystemAssignedIdentityInEncryption $true + +##Remove the temp key +Remove-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace -Name TempKey + +``` + +This commands demonstrate how to rotate the encryption key of a Synapse workspace, and it is using System Assigned Managed Identity to access the Azure Key Vault. + +### Example 10 +```powershell +$uamis = Get-AzUserAssignedIdentity -ResourceGroupName ContosoResourceGroup +$identityId = $uamis[0].Id +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws | Update-AzSynapseWorkspace -UseSystemAssignedIdentityInEncryption $false -UserAssignedIdentityInEncryption $identityId +$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace +$ws.Encryption.CustomerManagedKeyDetails.Key +``` + +```output +Name KeyVaultUrl +---- ----------- +default https://contosoKeyValut.vault.azure.net/keys/testkey +``` + +```powershell +$ws = Get-AzSynapseWorkspace -name ContosoWorkspace +$ws.Encryption.CustomerManagedKeyDetails.KekIdentity +``` + +```output +UserAssignedIdentity UseSystemAssignedIdentity +-------------------- ------------------------- +/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/ContosoResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uaminame False +``` + +This commands updates workspace Encryption Managed Identity as User Assigned and specify an user assigned identity Id to access your customer-managed key stored in key vault. After updating, we can call `Get-AzSynapseWorkspace` to get Encryption properties of workspace. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePublicNetworkAccess +Enable or Disable public network access to workspace. Possible values include: 'Enabled', 'Disabled' + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionKeyName +The workspace encryption key name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepository +Git Repository Settings. Connect workspace to the repository for source control and collaboration for work on your workspace pipelines + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSWorkspaceRepositoryConfiguration +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +workspace input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace +Parameter Sets: SetByInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagedVirtualNetwork +Managed Virtual Network Settings. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSManagedVirtualNetworkSettings +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: WorkspaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource group name. + +```yaml +Type: System.String +Parameter Sets: SetByNameParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +Resource identifier of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: SetByResourceIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlAdministratorLoginPassword +The new SQL administrator password for the workspace. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +A string,string dictionary of tags associated with the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityAction +Action must be specified when you add/remove/set user assigned managed identities for workspace. +The supported actions are: +Add +Remove +Set +Add means to add user assigned managed identities for workspace, Remove means to remove user assigned managed identities from workspace, Set can be used when you want to add and remove user assigned managed identities at the same time. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType +Parameter Sets: (All) +Aliases: +Accepted values: Add, Remove, Set + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityId +User assigned managed identity Id for workspace. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentityInEncryption +User assigned identity resource Id used in Workspace Encryption + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseSystemAssignedIdentityInEncryption +specifying whether to use system assigned identity in Workspace Encryption or not + +```yaml +Type: System.Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## OUTPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Synapse/Wait-AzSynapseSparkJob.md b/azps-10.1.0/Az.Synapse/Wait-AzSynapseSparkJob.md new file mode 100644 index 0000000000..9e159bb1fb --- /dev/null +++ b/azps-10.1.0/Az.Synapse/Wait-AzSynapseSparkJob.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml +Module Name: Az.Synapse +online version: https://learn.microsoft.com/powershell/module/az.synapse/wait-azsynapsesparkjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Wait-AzSynapseSparkJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Synapse/Synapse/help/Wait-AzSynapseSparkJob.md +--- + +# Wait-AzSynapseSparkJob + +## SYNOPSIS +Waits for a Synapse Analytics Spark job to complete. + +## SYNTAX + +### WaitSparkJobByIdParameterSet (Default) +``` +Wait-AzSynapseSparkJob -WorkspaceName <String> -SparkPoolName <String> -LivyId <Int32> + [-WaitIntervalInSeconds <Int32>] [-TimeoutInSeconds <Int32>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### WaitSparkJobByIdFromParentObjectParameterSet +``` +Wait-AzSynapseSparkJob -SparkPoolObject <PSSynapseSparkPool> -LivyId <Int32> [-WaitIntervalInSeconds <Int32>] + [-TimeoutInSeconds <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### WaitSparkJobByIdFromInputObjectParameterSet +``` +Wait-AzSynapseSparkJob -SparkJobObject <PSSynapseSparkJob> [-LivyId <Int32>] [-WaitIntervalInSeconds <Int32>] + [-TimeoutInSeconds <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Wait-AzSynapseSparkJob** cmdlet waits for an Azure Synapse Analytics job to complete. + +## EXAMPLES + +### Example 1 +```powershell +Wait-AzSynapseSparkJob -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -LivyId 324 +``` + +This command waits for the job with the specified ID to complete. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LivyId +Identifier of Spark job. + +```yaml +Type: System.Int32 +Parameter Sets: WaitSparkJobByIdParameterSet, WaitSparkJobByIdFromParentObjectParameterSet +Aliases: Id + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.Int32 +Parameter Sets: WaitSparkJobByIdFromInputObjectParameterSet +Aliases: Id + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkJobObject +Spark job input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkJob +Parameter Sets: WaitSparkJobByIdFromInputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SparkPoolName +Name of Synapse Spark pool. + +```yaml +Type: System.String +Parameter Sets: WaitSparkJobByIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SparkPoolObject +Spark pool input object, usually passed through the pipeline. + +```yaml +Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool +Parameter Sets: WaitSparkJobByIdFromParentObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TimeoutInSeconds +The maximum amount of time to wait before erroring out. +Default value is to never timeout. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitIntervalInSeconds +The polling interval between checks for the job status, in seconds. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +Name of Synapse workspace. + +```yaml +Type: System.String +Parameter Sets: WaitSparkJobByIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkPool + +### Microsoft.Azure.Commands.Synapse.Models.PSSynapseSparkJob + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.TimeSeriesInsights/Az.TimeSeriesInsights.md b/azps-10.1.0/Az.TimeSeriesInsights/Az.TimeSeriesInsights.md new file mode 100644 index 0000000000..3dc774a6bd --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/Az.TimeSeriesInsights.md @@ -0,0 +1,63 @@ +--- +Module Name: Az.TimeSeriesInsights +Module Guid: c3da39a4-7b6f-4973-be69-542c2174633a +Download Help Link: https://learn.microsoft.com/powershell/module/az.timeseriesinsights +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Az.TimeSeriesInsights.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Az.TimeSeriesInsights.md +--- + +# Az.TimeSeriesInsights Module +## Description +Microsoft Azure PowerShell: TimeSeriesInsights cmdlets + +## Az.TimeSeriesInsights Cmdlets +### [Get-AzTimeSeriesInsightsAccessPolicy](Get-AzTimeSeriesInsightsAccessPolicy.md) +Gets the access policy with the specified name in the specified environment. + +### [Get-AzTimeSeriesInsightsEnvironment](Get-AzTimeSeriesInsightsEnvironment.md) +Gets the environment with the specified name in the specified subscription and resource group. + +### [Get-AzTimeSeriesInsightsEventSource](Get-AzTimeSeriesInsightsEventSource.md) +Gets the event source with the specified name in the specified environment. + +### [Get-AzTimeSeriesInsightsReferenceDataSet](Get-AzTimeSeriesInsightsReferenceDataSet.md) +Gets the reference data set with the specified name in the specified environment. + +### [New-AzTimeSeriesInsightsAccessPolicy](New-AzTimeSeriesInsightsAccessPolicy.md) +Create or update an access policy in the specified environment. + +### [New-AzTimeSeriesInsightsEnvironment](New-AzTimeSeriesInsightsEnvironment.md) +Create an environment in the specified subscription and resource group. + +### [New-AzTimeSeriesInsightsEventSource](New-AzTimeSeriesInsightsEventSource.md) +Create an event source under the specified environment. + +### [New-AzTimeSeriesInsightsReferenceDataSet](New-AzTimeSeriesInsightsReferenceDataSet.md) +Create or update a reference data set in the specified environment. + +### [Remove-AzTimeSeriesInsightsAccessPolicy](Remove-AzTimeSeriesInsightsAccessPolicy.md) +Deletes the access policy with the specified name in the specified subscription, resource group, and environment + +### [Remove-AzTimeSeriesInsightsEnvironment](Remove-AzTimeSeriesInsightsEnvironment.md) +Deletes the environment with the specified name in the specified subscription and resource group. + +### [Remove-AzTimeSeriesInsightsEventSource](Remove-AzTimeSeriesInsightsEventSource.md) +Deletes the event source with the specified name in the specified subscription, resource group, and environment + +### [Remove-AzTimeSeriesInsightsReferenceDataSet](Remove-AzTimeSeriesInsightsReferenceDataSet.md) +Deletes the reference data set with the specified name in the specified subscription, resource group, and environment + +### [Update-AzTimeSeriesInsightsAccessPolicy](Update-AzTimeSeriesInsightsAccessPolicy.md) +Updates the access policy with the specified name in the specified subscription, resource group, and environment. + +### [Update-AzTimeSeriesInsightsEnvironment](Update-AzTimeSeriesInsightsEnvironment.md) +Updates the environment with the specified name in the specified subscription and resource group. + +### [Update-AzTimeSeriesInsightsEventSource](Update-AzTimeSeriesInsightsEventSource.md) +Updates the event source with the specified name in the specified subscription, resource group, and environment. + +### [Update-AzTimeSeriesInsightsReferenceDataSet](Update-AzTimeSeriesInsightsReferenceDataSet.md) +Updates the reference data set with the specified name in the specified subscription, resource group, and environment. + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/Get-AzTimeSeriesInsightsAccessPolicy.md b/azps-10.1.0/Az.TimeSeriesInsights/Get-AzTimeSeriesInsightsAccessPolicy.md new file mode 100644 index 0000000000..9db253a0e3 --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/Get-AzTimeSeriesInsightsAccessPolicy.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/get-aztimeseriesinsightsaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Get-AzTimeSeriesInsightsAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Get-AzTimeSeriesInsightsAccessPolicy.md +--- + +# Get-AzTimeSeriesInsightsAccessPolicy + +## SYNOPSIS +Gets the access policy with the specified name in the specified environment. + +## SYNTAX + +### List (Default) +``` +Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzTimeSeriesInsightsAccessPolicy -InputObject <ITimeSeriesInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the access policy with the specified name in the specified environment. + +## EXAMPLES + +### Example 1: List all access policies under a specified environment +```powershell +Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName testgroup +``` +```output +Name Type +---- ---- +policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies +policy002 Microsoft.TimeSeriesInsights/Environments/AccessPolicies +``` + +This command lists all access policies under a specified environment. + +### Example 2: Get a specified access policy by name +```powershell +Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name policy001 +``` +```output +Name Type +---- ---- +policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies +``` + +This command gets a specified access policy. + +### Example 3: Get a specified access policy by object +```powershell +$ap = Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsi-envv8u56x -ResourceGroupName tsi-test-i01k5l -Name tsi-apilgj5y +Get-AzTimeSeriesInsightsAccessPolicy -InputObject $ap +``` +```output +Name Type +---- ---- +policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies +``` + +This command gets a specified access policy. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Time Series Insights access policy associated with the specified environment. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AccessPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IAccessPolicyResource + +## 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 `<ITimeSeriesInsightsIdentity>`: Identity Parameter + - `[AccessPolicyName <String>]`: Name of the access policy. + - `[EnvironmentName <String>]`: Name of the environment + - `[EventSourceName <String>]`: The name of the Time Series Insights event source associated with the specified environment. + - `[Id <String>]`: Resource identity path + - `[ReferenceDataSetName <String>]`: Name of the reference data set. + - `[ResourceGroupName <String>]`: Name of an Azure Resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/Get-AzTimeSeriesInsightsEnvironment.md b/azps-10.1.0/Az.TimeSeriesInsights/Get-AzTimeSeriesInsightsEnvironment.md new file mode 100644 index 0000000000..07b2cdc84c --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/Get-AzTimeSeriesInsightsEnvironment.md @@ -0,0 +1,281 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/get-aztimeseriesinsightsenvironment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Get-AzTimeSeriesInsightsEnvironment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Get-AzTimeSeriesInsightsEnvironment.md +--- + +# Get-AzTimeSeriesInsightsEnvironment + +## SYNOPSIS +Gets the environment with the specified name in the specified subscription and resource group. + +## SYNTAX + +### List1 (Default) +``` +Get-AzTimeSeriesInsightsEnvironment [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzTimeSeriesInsightsEnvironment -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-Expand <String>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzTimeSeriesInsightsEnvironment -InputObject <ITimeSeriesInsightsIdentity> [-Expand <String>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the environment with the specified name in the specified subscription and resource group. + +## EXAMPLES + +### Example 1: Get a time series insights environment +```powershell +Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 +``` +```output +DataAccessFqdn : b6d113a4-0865-405f-b09e-ad4355b5d046.env.timeseries.azure.com +DataAccessId : b6d113a4-0865-405f-b09e-ad4355b5d046 +DataRetentionTime : 1.01:25:00 +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup/providers/Microsoft.TimeSeriesInsights/environments/tsitest + 001 +IngressState : +Kind : Gen1 +Location : eastus +Name : tsitest001 +PartitionKeyProperty : +PropertyUsageState : +Sku : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.Sku +SkuCapacity : 2 +SkuName : S1 +StateDetailCode : +StateDetailCurrentCount : +StateDetailMaxCount : +StateDetailMessage : +StorageLimitExceededBehavior : PurgeOldData +Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags +Type : Microsoft.TimeSeriesInsights/Environments +``` + +This command gets a time series insights environment. + +### Example 2: List all time series insights environments +```powershell +Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup +``` +```output +DataAccessFqdn : 3de1d1e1-4f9b-4bc6-aad3-a835597dcd86.env.timeseries.azure.com +DataAccessId : 3de1d1e1-4f9b-4bc6-aad3-a835597dcd86 +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/testgroup/providers/Microsoft.TimeSeriesInsights/environments/ + tsill +IngressState : +Kind : Gen2 +Location : EastUs +Name : tsill +PropertyUsageState : +Sku : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.Sku +SkuCapacity : 1 +SkuName : L1 +StateDetailCode : +StateDetailCurrentCount : +StateDetailMaxCount : +StateDetailMessage : +StorageConfigurationAccountName : cdolauli +Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags +TimeSeriesIdProperty : {ccc} +Type : Microsoft.TimeSeriesInsights/Environments +WarmStoreConfigurationDataRetention : 00:00:00 + +DataAccessFqdn : b6d113a4-0865-405f-b09e-ad4355b5d046.env.timeseries.azure.com +DataAccessId : b6d113a4-0865-405f-b09e-ad4355b5d046 +DataRetentionTime : 1.01:25:00 +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup/providers/Microsoft.TimeSeriesInsights/environments/tsitest + 001 +IngressState : +Kind : Gen1 +Location : eastus +Name : tsitest001 +PartitionKeyProperty : +PropertyUsageState : +Sku : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.Sku +SkuCapacity : 2 +SkuName : S1 +StateDetailCode : +StateDetailCurrentCount : +StateDetailMaxCount : +StateDetailMessage : +StorageLimitExceededBehavior : PurgeOldData +Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags +Type : Microsoft.TimeSeriesInsights/Environments +``` + +This command lists all time series insights environments in a resource group. + +### Example 3: Get a time series insights environment by object +```powershell +$env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName tsi-test-i01k5l -Name tsi-envv8u56x +Get-AzTimeSeriesInsightsEnvironment -InputObject $env +``` +```output +DataAccessFqdn : d76a61f2-8a30-41a5-9587-f241eb9b48d9.env.timeseries.azure.com +DataAccessId : d76a61f2-8a30-41a5-9587-f241eb9b48d9 +DataRetentionTime : 1.01:25:00 +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/tsi-test-i01k5l/providers/Microsoft.TimeSeriesInsights/environments/tsi-envv8u56x +IngressState : +Kind : Gen1 +Location : eastus2 +Name : tsi-envv8u56x +PartitionKeyProperty : +PropertyUsageState : +Sku : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.Sku +SkuCapacity : 1 +SkuName : S1 +StateDetailCode : +StateDetailCurrentCount : +StateDetailMaxCount : +StateDetailMessage : +StorageLimitExceededBehavior : PurgeOldData +Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags +Type : Microsoft.TimeSeriesInsights/Environments +``` + +This command gets a time series insights environments. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expand +Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentity +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.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: EnvironmentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IEnvironmentResource + +## 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 `<ITimeSeriesInsightsIdentity>`: Identity Parameter + - `[AccessPolicyName <String>]`: Name of the access policy. + - `[EnvironmentName <String>]`: Name of the environment + - `[EventSourceName <String>]`: The name of the Time Series Insights event source associated with the specified environment. + - `[Id <String>]`: Resource identity path + - `[ReferenceDataSetName <String>]`: Name of the reference data set. + - `[ResourceGroupName <String>]`: Name of an Azure Resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/Get-AzTimeSeriesInsightsEventSource.md b/azps-10.1.0/Az.TimeSeriesInsights/Get-AzTimeSeriesInsightsEventSource.md new file mode 100644 index 0000000000..90e420b9a5 --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/Get-AzTimeSeriesInsightsEventSource.md @@ -0,0 +1,242 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/get-aztimeseriesinsightseventsource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Get-AzTimeSeriesInsightsEventSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Get-AzTimeSeriesInsightsEventSource.md +--- + +# Get-AzTimeSeriesInsightsEventSource + +## SYNOPSIS +Gets the event source with the specified name in the specified environment. + +## SYNTAX + +### List (Default) +``` +Get-AzTimeSeriesInsightsEventSource -EnvironmentName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzTimeSeriesInsightsEventSource -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzTimeSeriesInsightsEventSource -InputObject <ITimeSeriesInsightsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the event source with the specified name in the specified environment. + +## EXAMPLES + +### Example 1: List all event sources under the specified environment +```powershell +Get-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -EnvironmentName tsitest001 +``` +```output +ConsumerGroupName : testgroup2 +EventHubName : hubname001 +EventSourceResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup2/providers/Microsoft.EventHub/namespaces/spacename001/eventhubs/hu + bname001 +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup/providers/Microsoft.TimeSeriesInsights/environments/tsitest001/eve + ntsources/estest001 +KeyName : RootManageSharedAccessKey +Kind : Microsoft.EventHub +Location : eastus +Name : estest001 +ServiceBusNamespace : spacename001 +Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags +TimestampPropertyName : +Type : Microsoft.TimeSeriesInsights/Environments/EventSources + +ConsumerGroupName : testgroup2 +EventSourceResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup2/providers/Microsoft.Devices/IotHubs/iotname001 +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup/providers/Microsoft.TimeSeriesInsights/environments/tsitest001/eve + ntsources/iots001 +IotHubName : iotname001 +KeyName : RootManageSharedAccessKey +Kind : Microsoft.IoTHub +Location : eastus +Name : iots001 +Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags +TimestampPropertyName : +Type : Microsoft.TimeSeriesInsights/Environments/EventSources +``` + +This command lists all event sources under the specified environments. + +### Example 2: Get a specified event source by name +```powershell +Get-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -EnvironmentName tsitest001 -Name iots001 +``` +```output +ConsumerGroupName : testgroup2 +EventSourceResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup2/providers/Microsoft.Devices/IotHubs/iotname001 +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup/providers/Microsoft.TimeSeriesInsights/environments/tsitest001/eve + ntsources/iots001 +IotHubName : iotname001 +KeyName : RootManageSharedAccessKey +Kind : Microsoft.IoTHub +Location : eastus +Name : iots001 +Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags +TimestampPropertyName : +Type : Microsoft.TimeSeriesInsights/Environments/EventSources +``` + +This command gets a specific event source. + +### Example 3: Get a specified event source by object +```powershell +$es = Get-AzTimeSeriesInsightsEventSource -ResourceGroupName tsi-test-i01k5l -EnvironmentName tsi-envv8u56x -Name tsi-esrfyi9h +Get-AzTimeSeriesInsightsEventSource -InputObject $es +``` +```output +ConsumerGroupName : tsi-test-i01k5l +EventHubName : eventhubname-d2rvmp +EventSourceResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/tsi-test-i01k5l/providers/Microsoft.EventHub/namespaces/eventhubspace-0t3khp/eventhubs/eventhubname-d2rvmp +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/tsi-test-i01k5l/providers/Microsoft.TimeSeriesInsights/environments/tsi-envv8u56x/eventsources/tsi-esrfyi9h +KeyName : RootManageSharedAccessKey +Kind : Microsoft.EventHub +Location : eastus2 +Name : tsi-esrfyi9h +ServiceBusNamespace : eventhubspace-0t3khp +Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags +TimestampPropertyName : +Type : Microsoft.TimeSeriesInsights/Environments/EventSources +``` + +This command gets a specific event source. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Time Series Insights event source associated with the specified environment. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: EventSourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IEventSourceResource + +## 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 `<ITimeSeriesInsightsIdentity>`: Identity Parameter + - `[AccessPolicyName <String>]`: Name of the access policy. + - `[EnvironmentName <String>]`: Name of the environment + - `[EventSourceName <String>]`: The name of the Time Series Insights event source associated with the specified environment. + - `[Id <String>]`: Resource identity path + - `[ReferenceDataSetName <String>]`: Name of the reference data set. + - `[ResourceGroupName <String>]`: Name of an Azure Resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/Get-AzTimeSeriesInsightsReferenceDataSet.md b/azps-10.1.0/Az.TimeSeriesInsights/Get-AzTimeSeriesInsightsReferenceDataSet.md new file mode 100644 index 0000000000..d7da22ebb1 --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/Get-AzTimeSeriesInsightsReferenceDataSet.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/get-aztimeseriesinsightsreferencedataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Get-AzTimeSeriesInsightsReferenceDataSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Get-AzTimeSeriesInsightsReferenceDataSet.md +--- + +# Get-AzTimeSeriesInsightsReferenceDataSet + +## SYNOPSIS +Gets the reference data set with the specified name in the specified environment. + +## SYNTAX + +### List (Default) +``` +Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzTimeSeriesInsightsReferenceDataSet -InputObject <ITimeSeriesInsightsIdentity> + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets the reference data set with the specified name in the specified environment. + +## EXAMPLES + +### Example 1: List all reference data sets under the specified environment +```powershell +Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -ResourceGroupName testgroup +``` +```output +Location Name Type +-------- ---- ---- +eastus dstest001 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets +eastus dstest002 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets +``` + +This command lists all reference data sets under the specified environment. + +### Example 2: Get a specified reference data set by name +```powershell +Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -ResourceGroupName testgroup -ReferenceDataSetName dstest001 +``` +```output +Location Name Type +-------- ---- ---- +eastus dstest001 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets +``` + +This command gets a specified reference data set. + +### Example 3: Get a specified reference data set by object +```powershell +$ds = Get-AzTimeSeriesInsightsReferenceDataSet -ResourceGroupName tsi-test-i01k5l -EnvironmentName tsi-envv8u56x -Name tsirdsqwufij +Get-AzTimeSeriesInsightsReferenceDataSet -InputObject $ds +``` +```output +Location Name Type +-------- ---- ---- +eastus2 tsirdsqwufij Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets +``` + +This command gets a specified reference data set. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Time Series Insights reference data set associated with the specified environment. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ReferenceDataSetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IReferenceDataSetResource + +## 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 `<ITimeSeriesInsightsIdentity>`: Identity Parameter + - `[AccessPolicyName <String>]`: Name of the access policy. + - `[EnvironmentName <String>]`: Name of the environment + - `[EventSourceName <String>]`: The name of the Time Series Insights event source associated with the specified environment. + - `[Id <String>]`: Resource identity path + - `[ReferenceDataSetName <String>]`: Name of the reference data set. + - `[ResourceGroupName <String>]`: Name of an Azure Resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/New-AzTimeSeriesInsightsAccessPolicy.md b/azps-10.1.0/Az.TimeSeriesInsights/New-AzTimeSeriesInsightsAccessPolicy.md new file mode 100644 index 0000000000..2f47cbc308 --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/New-AzTimeSeriesInsightsAccessPolicy.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/new-aztimeseriesinsightsaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/New-AzTimeSeriesInsightsAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/New-AzTimeSeriesInsightsAccessPolicy.md +--- + +# New-AzTimeSeriesInsightsAccessPolicy + +## SYNOPSIS +Create or update an access policy in the specified environment. + +## SYNTAX + +``` +New-AzTimeSeriesInsightsAccessPolicy -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Description <String>] [-PrincipalObjectId <String>] [-Role <AccessPolicyRole[]>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update an access policy in the specified environment. + +## EXAMPLES + +### Example 1: Create an access policy for a specified environment +```powershell +New-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName testgroup -PrincipalObjectId ce74a389-b5e8-4f16-89c7-787031ddd903 -Role Contributor -Name policy001 +``` +```output +Name Type +---- ---- +policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies +``` + +This command creates an access policy for a specified environment. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +An description of the access policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the access policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AccessPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalObjectId +The objectId of the principal in Azure Active Directory. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The list of roles the principal is assigned on the environment. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Support.AccessPolicyRole[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IAccessPolicyResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/New-AzTimeSeriesInsightsEnvironment.md b/azps-10.1.0/Az.TimeSeriesInsights/New-AzTimeSeriesInsightsEnvironment.md new file mode 100644 index 0000000000..76c68ce44d --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/New-AzTimeSeriesInsightsEnvironment.md @@ -0,0 +1,399 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/new-aztimeseriesinsightsenvironment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/New-AzTimeSeriesInsightsEnvironment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/New-AzTimeSeriesInsightsEnvironment.md +--- + +# New-AzTimeSeriesInsightsEnvironment + +## SYNOPSIS +Create an environment in the specified subscription and resource group. + +## SYNTAX + +### Gen1 (Default) +``` +New-AzTimeSeriesInsightsEnvironment -Name <String> -ResourceGroupName <String> -Capacity <Int32> + -DataRetentionTime <TimeSpan> -Kind <Kind> -Location <String> -Sku <SkuName> [-SubscriptionId <String>] + [-PartitionKeyProperty <ITimeSeriesIdProperty[]>] [-StorageLimitExceededBehavior <String>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### Gen2 +``` +New-AzTimeSeriesInsightsEnvironment -Name <String> -ResourceGroupName <String> -Kind <Kind> -Location <String> + -Sku <SkuName> -StorageAccountKey <SecureString> -StorageAccountName <String> + -TimeSeriesIdProperty <ITimeSeriesIdProperty[]> [-SubscriptionId <String>] [-Tag <Hashtable>] + [-WarmStoreDataRetentionTime <TimeSpan>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an environment in the specified subscription and resource group. + +## EXAMPLES + +### Example 1: Create a Gen1 time series insights environment +```powershell +$TimeSpan = New-TimeSpan -Days 1 -Hours 1 -Minutes 25 +New-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 -Kind Gen1 -Location eastus -Sku S1 -DataRetentionTime $TimeSpan -Capacity 2 +``` +```output +Kind Location Name SkuCapacity SkuName Type +---- -------- ---- ----------- ------- ---- +Gen1 eastus tsitest001 2 S1 Microsoft.TimeSeriesInsights/Environments +``` + +This command creates a Gen1 time series insights environment. + +### Example 2: Create a Gen2 time series insights environment +```powershell +$ks = Get-AzStorageAccountKey -ResourceGroupName "testgroup" -Name "staccount001" +$k = $ks[0].Value | ConvertTo-SecureString -AsPlainText -Force +New-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest002 -Kind Gen2 -Location eastus -Sku L1 -StorageAccountName staccount001 -StorageAccountKey $k -TimeSeriesIdProperty @{name='cdc';type='string'} +``` +```output +Kind Location Name SkuCapacity SkuName Type +---- -------- ---- ----------- ------- ---- +Gen2 eastus tsitest002 1 L1 Microsoft.TimeSeriesInsights/Environments +``` + +This command creates a Gen2 time series insights environment. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Capacity +The capacity of the sku. +For Gen1 environments, this value can be changed to support scale out of environments after they have been created. + +```yaml +Type: System.Int32 +Parameter Sets: Gen1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataRetentionTime +The data retention time. + +```yaml +Type: System.TimeSpan +Parameter Sets: Gen1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +The kind of the environment. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the environment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: EnvironmentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionKeyProperty +The list of event properties which will be used to partition data in the environment. +To construct, see NOTES section for PARTITIONKEYPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.ITimeSeriesIdProperty[] +Parameter Sets: Gen1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of this SKU. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Support.SkuName +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountKey +The value of the management key that grants the Time Series Insights service write access to the storage account. + +```yaml +Type: System.Security.SecureString +Parameter Sets: Gen2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountName +The name of the storage account that will hold the environment's long term data. + +```yaml +Type: System.String +Parameter Sets: Gen2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageLimitExceededBehavior +The behavior the Time Series Insights service should take when the environment's capacity has been exceeded + +```yaml +Type: System.String +Parameter Sets: Gen1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs of additional properties for the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeSeriesIdProperty +The list of event properties which will be used to define the environment's time series id. +To construct, see NOTES section for TIMESERIESIDPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.ITimeSeriesIdProperty[] +Parameter Sets: Gen2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WarmStoreDataRetentionTime +ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store. + +```yaml +Type: System.TimeSpan +Parameter Sets: Gen2 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IEnvironmentResource + +## 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. + + +PARTITIONKEYPROPERTY <ITimeSeriesIdProperty[]>: The list of event properties which will be used to partition data in the environment. + - `[Name <String>]`: The name of the property. + - `[Type <PropertyType?>]`: The type of the property. + +TIMESERIESIDPROPERTY <ITimeSeriesIdProperty[]>: The list of event properties which will be used to define the environment's time series id. + - `[Name <String>]`: The name of the property. + - `[Type <PropertyType?>]`: The type of the property. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/New-AzTimeSeriesInsightsEventSource.md b/azps-10.1.0/Az.TimeSeriesInsights/New-AzTimeSeriesInsightsEventSource.md new file mode 100644 index 0000000000..be8c8824bd --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/New-AzTimeSeriesInsightsEventSource.md @@ -0,0 +1,357 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/new-aztimeseriesinsightseventsource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/New-AzTimeSeriesInsightsEventSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/New-AzTimeSeriesInsightsEventSource.md +--- + +# New-AzTimeSeriesInsightsEventSource + +## SYNOPSIS +Create an event source under the specified environment. + +## SYNTAX + +### eventhub (Default) +``` +New-AzTimeSeriesInsightsEventSource -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + -ConsumerGroupName <String> -EventHubName <String> -EventSourceResourceId <String> -KeyName <String> + -Kind <Kind> -Location <String> -ServiceBusNameSpace <String> -SharedAccessKey <SecureString> + [-SubscriptionId <String>] [-Tag <Hashtable>] [-TimeStampPropertyName <String>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### iothub +``` +New-AzTimeSeriesInsightsEventSource -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + -ConsumerGroupName <String> -EventSourceResourceId <String> -IoTHubName <String> -KeyName <String> + -Kind <Kind> -Location <String> -SharedAccessKey <SecureString> [-SubscriptionId <String>] [-Tag <Hashtable>] + [-TimeStampPropertyName <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create an event source under the specified environment. + +## EXAMPLES + +### Example 1: Create an eventhub event source under the specified environment +```powershell +New-AzEventHubNamespace -Name spacename002 -ResourceGroupName testgroup -Location eastus +$ev = New-AzEventHub -ResourceGroupName testgroup -NamespaceName spacename002 -Name hubname001 -MessageRetentionInDays 3 -PartitionCount 2 +$ks = Get-AzEventHubKey -ResourceGroupName testgroup -NamespaceName spacename002 -AuthorizationRuleName RootManageSharedAccessKey +$k = $ks.PrimaryKey | ConvertTo-SecureString -AsPlainText -Force +New-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -Name estest001 -EnvironmentName tsitest001 -Kind Microsoft.EventHub -ConsumerGroupName testgroup -Location eastus -KeyName RootManageSharedAccessKey -ServiceBusNameSpace spacename002 -EventHubName hubname001 -EventSourceResourceId $ev.id -SharedAccessKey $k +``` +```output +Kind Location Name Type +---- -------- ---- ---- +Microsoft.EventHub eastus estest001 Microsoft.TimeSeriesInsights/Environments/EventSources +``` + +This command creates an eventhub event source under the specified environment. + +### Example 2: Create an iothub event source under the specified environment +```powershell +$ev = New-AzIotHub -ResourceGroupName testgroup -Location eastus -Name iotname001 -SkuName S1 -Units 100 +$ks = Get-AzIotHubKey -ResourceGroupName testgroup -Name iotname001 +$k = $ks[0].PrimaryKey | ConvertTo-SecureString -AsPlainText -Force +New-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -Name iots001 -EnvironmentName tsitest001 -Kind Microsoft.IoTHub -ConsumerGroupName testgroup -Location eastus -KeyName RootManageSharedAccessKey -IoTHubName iotname001 -EventSourceResourceId $ev.id -SharedAccessKey $k +``` +```output +Location Name Type Kind +-------- ---- ---- ---- +eastus iots001 Microsoft.TimeSeriesInsights/Environments/EventSources Microsoft.IoTHub +``` + +This command creates an iothub event source under the specified environment. + +## PARAMETERS + +### -ConsumerGroupName +The name of the event/iot hub's consumer group that holds the partitions from which events will be read. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubName +The name of the event hub. + +```yaml +Type: System.String +Parameter Sets: eventhub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSourceResourceId +The resource id of the event source in Azure Resource Manager. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IoTHubName +The name of the iot hub. + +```yaml +Type: System.String +Parameter Sets: iothub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +The name of the SAS key that grants the Time Series Insights service access to the event/iot hub. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +The kind of the event source. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the event source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: EventSourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceBusNameSpace +The name of the service bus that contains the event hub. + +```yaml +Type: System.String +Parameter Sets: eventhub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedAccessKey +The value of the shared access key that grants the Time Series Insights service read access to the event/iot hub. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs of additional properties for the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeStampPropertyName +The event property that will be used as the event source's timestamp. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IEventSourceResource + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/New-AzTimeSeriesInsightsReferenceDataSet.md b/azps-10.1.0/Az.TimeSeriesInsights/New-AzTimeSeriesInsightsReferenceDataSet.md new file mode 100644 index 0000000000..c29c07fb18 --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/New-AzTimeSeriesInsightsReferenceDataSet.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/new-aztimeseriesinsightsreferencedataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/New-AzTimeSeriesInsightsReferenceDataSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/New-AzTimeSeriesInsightsReferenceDataSet.md +--- + +# New-AzTimeSeriesInsightsReferenceDataSet + +## SYNOPSIS +Create or update a reference data set in the specified environment. + +## SYNTAX + +``` +New-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + -KeyProperty <IReferenceDataSetKeyProperty[]> -Location <String> [-SubscriptionId <String>] + [-DataStringComparisonBehavior <DataStringComparisonBehavior>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a reference data set in the specified environment. + +## EXAMPLES + +### Example 1: Create a reference data set for a specified environment +```powershell +$mykeyproperties = @{ "name" = "device01"; "type" = "Double"} +New-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup -Location eastus -DataStringComparisonBehavior Ordinal -KeyProperty $mykeyproperties +``` +```output +Location Name Type +-------- ---- ---- +eastus dstest001 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets +``` + +This command creates a reference data set for a specific environment. + +## PARAMETERS + +### -DataStringComparisonBehavior +The reference data set key comparison behavior can be set using this property. +By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. +When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Support.DataStringComparisonBehavior +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyProperty +The list of key properties for the reference data set. +To construct, see NOTES section for KEYPROPERTY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IReferenceDataSetKeyProperty[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the reference data set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ReferenceDataSetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs of additional properties for the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IReferenceDataSetResource + +## 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. + + +KEYPROPERTY <IReferenceDataSetKeyProperty[]>: The list of key properties for the reference data set. + - `[Name <String>]`: The name of the key property. + - `[Type <ReferenceDataKeyPropertyType?>]`: The type of the key property. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/Remove-AzTimeSeriesInsightsAccessPolicy.md b/azps-10.1.0/Az.TimeSeriesInsights/Remove-AzTimeSeriesInsightsAccessPolicy.md new file mode 100644 index 0000000000..6368de74a7 --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/Remove-AzTimeSeriesInsightsAccessPolicy.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/remove-aztimeseriesinsightsaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Remove-AzTimeSeriesInsightsAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Remove-AzTimeSeriesInsightsAccessPolicy.md +--- + +# Remove-AzTimeSeriesInsightsAccessPolicy + +## SYNOPSIS +Deletes the access policy with the specified name in the specified subscription, resource group, and environment + +## SYNTAX + +### Delete (Default) +``` +Remove-AzTimeSeriesInsightsAccessPolicy -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzTimeSeriesInsightsAccessPolicy -InputObject <ITimeSeriesInsightsIdentity> + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the access policy with the specified name in the specified subscription, resource group, and environment + +## EXAMPLES + +### Example 1: Remove a specified access policy by name +```powershell +Remove-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup + +``` + +This command removes a specified access policy. + +### Example 2: Remove a specified access policy by object +```powershell +$policy = Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup +Remove-AzTimeSeriesInsightsAccessPolicy -InputObject $policy + +``` + +This command removes a specified access policy. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Time Series Insights access policy associated with the specified environment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AccessPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ITimeSeriesInsightsIdentity>`: Identity Parameter + - `[AccessPolicyName <String>]`: Name of the access policy. + - `[EnvironmentName <String>]`: Name of the environment + - `[EventSourceName <String>]`: The name of the Time Series Insights event source associated with the specified environment. + - `[Id <String>]`: Resource identity path + - `[ReferenceDataSetName <String>]`: Name of the reference data set. + - `[ResourceGroupName <String>]`: Name of an Azure Resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/Remove-AzTimeSeriesInsightsEnvironment.md b/azps-10.1.0/Az.TimeSeriesInsights/Remove-AzTimeSeriesInsightsEnvironment.md new file mode 100644 index 0000000000..a58fe80134 --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/Remove-AzTimeSeriesInsightsEnvironment.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/remove-aztimeseriesinsightsenvironment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Remove-AzTimeSeriesInsightsEnvironment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Remove-AzTimeSeriesInsightsEnvironment.md +--- + +# Remove-AzTimeSeriesInsightsEnvironment + +## SYNOPSIS +Deletes the environment with the specified name in the specified subscription and resource group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzTimeSeriesInsightsEnvironment -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzTimeSeriesInsightsEnvironment -InputObject <ITimeSeriesInsightsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the environment with the specified name in the specified subscription and resource group. + +## EXAMPLES + +### Example 1: Remove a time series insights environment by name +```powershell +Remove-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsill + +``` + +This command removes a time series insights environment. + +### Example 2: Remove a time series insights environment by object +```powershell +$env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsill +Remove-AzTimeSeriesInsightsEnvironment -InputObject $env + +``` + +This command removes a time series insights environment. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: EnvironmentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ITimeSeriesInsightsIdentity>`: Identity Parameter + - `[AccessPolicyName <String>]`: Name of the access policy. + - `[EnvironmentName <String>]`: Name of the environment + - `[EventSourceName <String>]`: The name of the Time Series Insights event source associated with the specified environment. + - `[Id <String>]`: Resource identity path + - `[ReferenceDataSetName <String>]`: Name of the reference data set. + - `[ResourceGroupName <String>]`: Name of an Azure Resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/Remove-AzTimeSeriesInsightsEventSource.md b/azps-10.1.0/Az.TimeSeriesInsights/Remove-AzTimeSeriesInsightsEventSource.md new file mode 100644 index 0000000000..e9ceabe327 --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/Remove-AzTimeSeriesInsightsEventSource.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/remove-aztimeseriesinsightseventsource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Remove-AzTimeSeriesInsightsEventSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Remove-AzTimeSeriesInsightsEventSource.md +--- + +# Remove-AzTimeSeriesInsightsEventSource + +## SYNOPSIS +Deletes the event source with the specified name in the specified subscription, resource group, and environment + +## SYNTAX + +### Delete (Default) +``` +Remove-AzTimeSeriesInsightsEventSource -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzTimeSeriesInsightsEventSource -InputObject <ITimeSeriesInsightsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the event source with the specified name in the specified subscription, resource group, and environment + +## EXAMPLES + +### Example 1: Remove a specified event source by name +```powershell +Remove-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -Name iots001 -ResourceGroupName testgroup + +``` + +This removes a specific event source. + +### Example 2: Remove a specified event source by object +```powershell +$es = Get-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name iots001 +Remove-AzTimeSeriesInsightsEventSource -InputObject $es + +``` + +This removes a specific event source. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Time Series Insights event source associated with the specified environment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: EventSourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ITimeSeriesInsightsIdentity>`: Identity Parameter + - `[AccessPolicyName <String>]`: Name of the access policy. + - `[EnvironmentName <String>]`: Name of the environment + - `[EventSourceName <String>]`: The name of the Time Series Insights event source associated with the specified environment. + - `[Id <String>]`: Resource identity path + - `[ReferenceDataSetName <String>]`: Name of the reference data set. + - `[ResourceGroupName <String>]`: Name of an Azure Resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/Remove-AzTimeSeriesInsightsReferenceDataSet.md b/azps-10.1.0/Az.TimeSeriesInsights/Remove-AzTimeSeriesInsightsReferenceDataSet.md new file mode 100644 index 0000000000..cc3053a68a --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/Remove-AzTimeSeriesInsightsReferenceDataSet.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/remove-aztimeseriesinsightsreferencedataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Remove-AzTimeSeriesInsightsReferenceDataSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Remove-AzTimeSeriesInsightsReferenceDataSet.md +--- + +# Remove-AzTimeSeriesInsightsReferenceDataSet + +## SYNOPSIS +Deletes the reference data set with the specified name in the specified subscription, resource group, and environment + +## SYNTAX + +### Delete (Default) +``` +Remove-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzTimeSeriesInsightsReferenceDataSet -InputObject <ITimeSeriesInsightsIdentity> + [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes the reference data set with the specified name in the specified subscription, resource group, and environment + +## EXAMPLES + +### Example 1: Remove a specified reference data set by name +```powershell +Remove-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup + +``` + +This command removes a specified reference data set. + +### Example 2: Remove a specified reference data set by object +```powershell +$ds = Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup +Remove-AzTimeSeriesInsightsReferenceDataSet -InputObject $ds + +``` + +This command removes a specified reference data set. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Time Series Insights reference data set associated with the specified environment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ReferenceDataSetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT `<ITimeSeriesInsightsIdentity>`: Identity Parameter + - `[AccessPolicyName <String>]`: Name of the access policy. + - `[EnvironmentName <String>]`: Name of the environment + - `[EventSourceName <String>]`: The name of the Time Series Insights event source associated with the specified environment. + - `[Id <String>]`: Resource identity path + - `[ReferenceDataSetName <String>]`: Name of the reference data set. + - `[ResourceGroupName <String>]`: Name of an Azure Resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/Update-AzTimeSeriesInsightsAccessPolicy.md b/azps-10.1.0/Az.TimeSeriesInsights/Update-AzTimeSeriesInsightsAccessPolicy.md new file mode 100644 index 0000000000..141763ba92 --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/Update-AzTimeSeriesInsightsAccessPolicy.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/update-aztimeseriesinsightsaccesspolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Update-AzTimeSeriesInsightsAccessPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Update-AzTimeSeriesInsightsAccessPolicy.md +--- + +# Update-AzTimeSeriesInsightsAccessPolicy + +## SYNOPSIS +Updates the access policy with the specified name in the specified subscription, resource group, and environment. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzTimeSeriesInsightsAccessPolicy -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Description <String>] [-Role <AccessPolicyRole[]>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzTimeSeriesInsightsAccessPolicy -InputObject <ITimeSeriesInsightsIdentity> [-Description <String>] + [-Role <AccessPolicyRole[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the access policy with the specified name in the specified subscription, resource group, and environment. + +## EXAMPLES + +### Example 1: Update a specified access policy by name +```powershell +Update-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup -Role Contributor,Reader +``` +```output +Name Type +---- ---- +policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies +``` + +This command updates a specified access policy. + +### Example 2: Update a specified access policy by object +```powershell +$policy = Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name policy001 +Update-AzTimeSeriesInsightsAccessPolicy -InputObject $policy -Role Contributor +``` +```output +Name Type +---- ---- +policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies +``` + +This command updates a specified access policy. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +An description of the access policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Time Series Insights access policy associated with the specified environment. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: AccessPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The list of roles the principal is assigned on the environment. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Support.AccessPolicyRole[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IAccessPolicyResource + +## 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 `<ITimeSeriesInsightsIdentity>`: Identity Parameter + - `[AccessPolicyName <String>]`: Name of the access policy. + - `[EnvironmentName <String>]`: Name of the environment + - `[EventSourceName <String>]`: The name of the Time Series Insights event source associated with the specified environment. + - `[Id <String>]`: Resource identity path + - `[ReferenceDataSetName <String>]`: Name of the reference data set. + - `[ResourceGroupName <String>]`: Name of an Azure Resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/Update-AzTimeSeriesInsightsEnvironment.md b/azps-10.1.0/Az.TimeSeriesInsights/Update-AzTimeSeriesInsightsEnvironment.md new file mode 100644 index 0000000000..a9d64c04ae --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/Update-AzTimeSeriesInsightsEnvironment.md @@ -0,0 +1,279 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/update-aztimeseriesinsightsenvironment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Update-AzTimeSeriesInsightsEnvironment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Update-AzTimeSeriesInsightsEnvironment.md +--- + +# Update-AzTimeSeriesInsightsEnvironment + +## SYNOPSIS +Updates the environment with the specified name in the specified subscription and resource group. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzTimeSeriesInsightsEnvironment -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzTimeSeriesInsightsEnvironment -InputObject <ITimeSeriesInsightsIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the environment with the specified name in the specified subscription and resource group. + +## EXAMPLES + +### Example 1: Update a Gen1 time series insights environment +```powershell +Update-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 -Tag @{'key1'='val1'} +``` +```output +DataAccessFqdn : b6d113a4-0865-405f-b09e-ad4355b5d046.env.timeseries.azure.com +DataAccessId : b6d113a4-0865-405f-b09e-ad4355b5d046 +DataRetentionTime : 1.01:25:00 +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup/providers/Microsoft.TimeSeriesInsights/environments/tsitest + 001 +IngressState : +Kind : Gen1 +Location : eastus +Name : tsitest001 +PartitionKeyProperty : +PropertyUsageState : +Sku : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.Sku +SkuCapacity : 5 +SkuName : S1 +StateDetailCode : +StateDetailCurrentCount : +StateDetailMaxCount : +StateDetailMessage : +StorageLimitExceededBehavior : PurgeOldData +Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags +Type : Microsoft.TimeSeriesInsights/Environments +``` + +This command updates a Gen1 time series insights environment. + +### Example 2: Update a Gen1 time series insights environment +```powershell +$env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 +Update-AzTimeSeriesInsightsEnvironment -InputObject $env -Tag @{'key2'='val2'} +``` +```output +DataAccessFqdn : b6d113a4-0865-405f-b09e-ad4355b5d046.env.timeseries.azure.com +DataAccessId : b6d113a4-0865-405f-b09e-ad4355b5d046 +DataRetentionTime : 1.01:25:00 +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup/providers/Microsoft.TimeSeriesInsights/environments/tsitest + 001 +IngressState : +Kind : Gen1 +Location : eastus +Name : tsitest001 +PartitionKeyProperty : +PropertyUsageState : +Sku : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.Sku +SkuCapacity : 5 +SkuName : S1 +StateDetailCode : +StateDetailCurrentCount : +StateDetailMaxCount : +StateDetailMessage : +StorageLimitExceededBehavior : PurgeOldData +Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags +Type : Microsoft.TimeSeriesInsights/Environments +``` + +This command updates a Gen1 time series insights environment. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: EnvironmentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs of additional properties for the environment. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IEnvironmentResource + +## 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 `<ITimeSeriesInsightsIdentity>`: Identity Parameter + - `[AccessPolicyName <String>]`: Name of the access policy. + - `[EnvironmentName <String>]`: Name of the environment + - `[EventSourceName <String>]`: The name of the Time Series Insights event source associated with the specified environment. + - `[Id <String>]`: Resource identity path + - `[ReferenceDataSetName <String>]`: Name of the reference data set. + - `[ResourceGroupName <String>]`: Name of an Azure Resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/Update-AzTimeSeriesInsightsEventSource.md b/azps-10.1.0/Az.TimeSeriesInsights/Update-AzTimeSeriesInsightsEventSource.md new file mode 100644 index 0000000000..7785c27293 --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/Update-AzTimeSeriesInsightsEventSource.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/update-aztimeseriesinsightseventsource +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Update-AzTimeSeriesInsightsEventSource.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Update-AzTimeSeriesInsightsEventSource.md +--- + +# Update-AzTimeSeriesInsightsEventSource + +## SYNOPSIS +Updates the event source with the specified name in the specified subscription, resource group, and environment. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzTimeSeriesInsightsEventSource -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzTimeSeriesInsightsEventSource -InputObject <ITimeSeriesInsightsIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the event source with the specified name in the specified subscription, resource group, and environment. + +## EXAMPLES + +### Example 1: Update a specified event source by name +```powershell +Update-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -Name iots001 -ResourceGroupName testgroup -Tag @{"tgk"="001"} +``` +```output +ConsumerGroupName : testgroup2 +EventSourceResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup2/providers/Microsoft.Devices/IotHubs/iotname001 +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup/providers/Microsoft.TimeSeriesInsights/environments/tsitest001/eventsources/iots001 +IotHubName : iotname001 +KeyName : RootManageSharedAccessKey +Kind : Microsoft.IoTHub +Location : eastus +Name : iots001 +Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags +TimestampPropertyName : +Type : Microsoft.TimeSeriesInsights/Environments/EventSources +``` + +This command updates a specific event source. + +### Example 2: Update a specified event source by object +```powershell +$es = Get-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name iots001 +Update-AzTimeSeriesInsightsEventSource -InputObject $es -Tag @{"tgb"="002"} +``` +```output +ConsumerGroupName : testgroup2 +EventSourceResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup2/providers/Microsoft.Devices/IotHubs/iotname001 +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup/providers/Microsoft.TimeSeriesInsights/environments/tsitest001/eventsources/iots001 +IotHubName : iotname001 +KeyName : RootManageSharedAccessKey +Kind : Microsoft.IoTHub +Location : eastus +Name : iots001 +Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags +TimestampPropertyName : +Type : Microsoft.TimeSeriesInsights/Environments/EventSources +``` + +This command updates a specific event source. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Time Series Insights event source associated with the specified environment. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: EventSourceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs of additional properties for the event source. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IEventSourceResource + +## 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 `<ITimeSeriesInsightsIdentity>`: Identity Parameter + - `[AccessPolicyName <String>]`: Name of the access policy. + - `[EnvironmentName <String>]`: Name of the environment + - `[EventSourceName <String>]`: The name of the Time Series Insights event source associated with the specified environment. + - `[Id <String>]`: Resource identity path + - `[ReferenceDataSetName <String>]`: Name of the reference data set. + - `[ResourceGroupName <String>]`: Name of an Azure Resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TimeSeriesInsights/Update-AzTimeSeriesInsightsReferenceDataSet.md b/azps-10.1.0/Az.TimeSeriesInsights/Update-AzTimeSeriesInsightsReferenceDataSet.md new file mode 100644 index 0000000000..af0ec8e63d --- /dev/null +++ b/azps-10.1.0/Az.TimeSeriesInsights/Update-AzTimeSeriesInsightsReferenceDataSet.md @@ -0,0 +1,229 @@ +--- +external help file: +Module Name: Az.TimeSeriesInsights +online version: https://learn.microsoft.com/powershell/module/az.timeseriesinsights/update-aztimeseriesinsightsreferencedataset +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Update-AzTimeSeriesInsightsReferenceDataSet.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TimeSeriesInsights/help/Update-AzTimeSeriesInsightsReferenceDataSet.md +--- + +# Update-AzTimeSeriesInsightsReferenceDataSet + +## SYNOPSIS +Updates the reference data set with the specified name in the specified subscription, resource group, and environment. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzTimeSeriesInsightsReferenceDataSet -InputObject <ITimeSeriesInsightsIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the reference data set with the specified name in the specified subscription, resource group, and environment. + +## EXAMPLES + +### Example 1: Update a specified reference data set by name +```powershell +Update-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup -Tag @{"tstg"="lb001"} +``` +```output +Location Name Type +-------- ---- ---- +eastus dstest001 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets +``` + +This command updates a specified reference data set. + +### Example 2: Update a specified reference data set by object +```powershell +$ds = Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -ResourceGroupName testgroup -ReferenceDataSetName dstest001 +Update-AzTimeSeriesInsightsReferenceDataSet -InputObject $ds -Tag @{"tstg"="lb001"} +``` +```output +Location Name Type +-------- ---- ---- +eastus dstest001 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets +``` + +This command updates a specified reference data set. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The name of the Time Series Insights environment associated with the specified resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Time Series Insights reference data set associated with the specified environment. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ReferenceDataSetName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs of additional properties for the reference data set. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.ITimeSeriesInsightsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IReferenceDataSetResource + +## 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 `<ITimeSeriesInsightsIdentity>`: Identity Parameter + - `[AccessPolicyName <String>]`: Name of the access policy. + - `[EnvironmentName <String>]`: Name of the environment + - `[EventSourceName <String>]`: The name of the Time Series Insights event source associated with the specified environment. + - `[Id <String>]`: Resource identity path + - `[ReferenceDataSetName <String>]`: Name of the reference data set. + - `[ResourceGroupName <String>]`: Name of an Azure Resource group. + - `[SubscriptionId <String>]`: Azure Subscription ID. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerCustomHeaderToEndpoint.md b/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerCustomHeaderToEndpoint.md new file mode 100644 index 0000000000..345e3fad58 --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerCustomHeaderToEndpoint.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D33E +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/add-aztrafficmanagercustomheadertoendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Add-AzTrafficManagerCustomHeaderToEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Add-AzTrafficManagerCustomHeaderToEndpoint.md +--- + +# Add-AzTrafficManagerCustomHeaderToEndpoint + +## SYNOPSIS +Adds custom header information to a local Traffic Manager endpoint object. + +## SYNTAX + +``` +Add-AzTrafficManagerCustomHeaderToEndpoint -Name <String> -Value <String> + -TrafficManagerEndpoint <TrafficManagerEndpoint> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzTrafficManagerCustomHeaderToEndpoint** cmdlet adds custom header information to a local Azure Traffic Manager endpoint object. +You can get an endpoint by using the New-AzTrafficManagerEndpoint or Get-AzTrafficManagerEndpoint cmdlets. + +This cmdlet operates on the local endpoint object. +Commit your changes to the endpoint for Traffic Manager by using the Set-AzTrafficManagerEndpoint cmdlet. + +## EXAMPLES + +### Example 1: Add custom header information to an endpoint +```powershell +$TrafficManagerEndpoint = New-AzTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints -Priority 1 -TargetResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-CentralUS/providers/Microsoft.Web/sites/contoso-web-app" -Weight 10 +Add-AzTrafficManagerCustomHeaderToEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint -Name "host" -Value "www.contoso.com" +Set-AzTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint +``` + +The first command creates an Azure Traffic Manager endpoint by using the **New-AzTrafficManagerEndpoint** cmdlet. +The command stores the local endpoint in the $TrafficManagerEndpoint variable. +The second command adds custom header information to the endpoint stored in $TrafficManagerEndpoint. +The final command updates the endpoint in Traffic Manager to match the local value in $TrafficManagerEndpoint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the custom header information to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerEndpoint +Specifies a local **TrafficManagerEndpoint** object. +This cmdlet modifies this local object. +To obtain a **TrafficManagerEndpoint** object, use the Get-AzTrafficManagerEndpoint or New-AzTrafficManagerEndpoint cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Value +Specifies the value of the custom header information to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## NOTES + +## RELATED LINKS + +[Remove-AzTrafficManagerCustomHeaderFromEndpoint](./Remove-AzTrafficManagerCustomHeaderFromEndpoint.md) + +[New-AzTrafficManagerEndpoint](./New-AzTrafficManagerEndpoint.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerEndpoint.md) + +[Set-AzTrafficManagerEndpoint](./Set-AzTrafficManagerEndpoint.md) diff --git a/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerCustomHeaderToProfile.md b/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerCustomHeaderToProfile.md new file mode 100644 index 0000000000..ec846a1870 --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerCustomHeaderToProfile.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D33F +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/add-aztrafficmanagercustomheadertoprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Add-AzTrafficManagerCustomHeaderToProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Add-AzTrafficManagerCustomHeaderToProfile.md +--- + +# Add-AzTrafficManagerCustomHeaderToProfile + +## SYNOPSIS +Adds custom header information to a local Traffic Manager profile object. + +## SYNTAX + +``` +Add-AzTrafficManagerCustomHeaderToProfile -Name <String> -Value <String> + -TrafficManagerProfile <TrafficManagerProfile> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzTrafficManagerCustomHeaderToProfile** cmdlet adds custom header information to a local Azure Traffic Manager profile object. +You can get a profile by using the New-AzTrafficManagerProfile or Get-AzTrafficManagerProfile cmdlets. + +This cmdlet operates on the local profile object. +Commit your changes to the profile for Traffic Manager by using the Set-AzTrafficManagerProfile cmdlet. + +## EXAMPLES + +### Example 1: Add custom header information to a profile +```powershell +$TrafficManagerProfile = Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" +Add-AzTrafficManagerCustomHeaderToProfile -TrafficManagerProfile $TrafficManagerProfile -Name "host" -Value "www.contoso.com" +Set-AzTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile +``` + +The first command gets an Azure Traffic Manager profile by using the **Get-AzTrafficManagerProfile** cmdlet. +The command stores the local profile in the $TrafficManagerProfile variable. +The second command adds custom header information to the profile stored in $TrafficManagerProfile. +The final command updates the profile in Traffic Manager to match the local value in $TrafficManagerProfile. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the custom header information to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerProfile +Specifies a local **TrafficManagerProfile** object. +This cmdlet modifies this local object. +To obtain a **TrafficManagerProfile** object, use the Get-AzTrafficManagerProfile cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Value +Specifies the value of the custom header information to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## NOTES + +## RELATED LINKS + +[Remove-AzTrafficManagerCustomHeaderFromProfile](./Remove-AzTrafficManagerCustomHeaderFromProfile.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) diff --git a/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerEndpointConfig.md b/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerEndpointConfig.md new file mode 100644 index 0000000000..ad74d9442c --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerEndpointConfig.md @@ -0,0 +1,373 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D33D +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/add-aztrafficmanagerendpointconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Add-AzTrafficManagerEndpointConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Add-AzTrafficManagerEndpointConfig.md +--- + +# Add-AzTrafficManagerEndpointConfig + +## SYNOPSIS +Adds an endpoint to a local Traffic Manager profile object. + +## SYNTAX + +``` +Add-AzTrafficManagerEndpointConfig -EndpointName <String> -TrafficManagerProfile <TrafficManagerProfile> + -Type <String> [-TargetResourceId <String>] [-Target <String>] -EndpointStatus <String> [-Weight <UInt32>] + [-Priority <UInt32>] [-EndpointLocation <String>] [-AlwaysServe <String>] [-MinChildEndpoints <UInt32>] + [-MinChildEndpointsIPv4 <UInt32>] [-MinChildEndpointsIPv6 <UInt32>] + [-GeoMapping <System.Collections.Generic.List`1[System.String]>] + [-SubnetMapping <System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerIpAddressRange]>] + [-CustomHeader <System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerCustomHeader]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzTrafficManagerEndpointConfig** cmdlet adds an endpoint to a local Azure Traffic Manager profile object. +You can get a profile by using the New-AzTrafficManagerProfile or Get-AzTrafficManagerProfile cmdlets. + +This cmdlet operates on the local profile object. +Commit your changes to the profile for Traffic Manager by using the Set-AzTrafficManagerProfile cmdlet. +To create an endpoint and commit the change in a single operation, use the New-AzTrafficManagerEndpoint cmdlet. + +## EXAMPLES + +### Example 1: Add an endpoint to a profile +```powershell +$TrafficManagerProfile = Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" +Add-AzTrafficManagerEndpointConfig -EndpointName "contoso" -EndpointStatus Enabled -Target "www.contoso.com" -TrafficManagerProfile $TrafficManagerProfile -Type ExternalEndpoints -EndpointLocation "North Europe" -Priority 1 -Weight 10 +Set-AzTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile +``` + +The first command gets an Azure Traffic Manager profile by using the **Get-AzTrafficManagerProfile** cmdlet. +The command stores the local profile in the $TrafficManagerProfile variable. + +The second command adds an endpoint named contoso to the profile stored in $TrafficManagerProfile. +The command includes configuration data for the endpoint. +This command changes only the local object. + +The final command updates the Traffic Manager profile in Azure to match the local value in $TrafficManagerProfile. + +## PARAMETERS + +### -AlwaysServe +If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomHeader +List of custom header name and value pairs for probe requests. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerCustomHeader] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointLocation +Specifies the location of the endpoint to use in the Performance traffic-routing method. +This parameter is only applicable to endpoints of the ExternalEndpoints or the NestedEndpoints type. +You must specify this parameter when the Performance traffic-routing method is used. + +Specify an Azure region name. +For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/ (http://azure.microsoft.com/regions/). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Specifies the name of the Traffic Manager endpoint that this cmdlet adds. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointStatus +Specifies the status of the endpoint. +Valid values are: + +- Enabled +- Disabled + +If the status is Enabled, the endpoint is probed for endpoint health and is included in the traffic-routing method. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeoMapping +The list of regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager documentation for a [full list of accepted values](https://learn.microsoft.com/azure/traffic-manager/traffic-manager-geographic-regions). + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinChildEndpoints +The minimum number of endpoints that must be available in the child profile in order for the Nested Endpoint in the parent profile to be considered available. +Only applicable to endpoint of type 'NestedEndpoints'. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinChildEndpointsIPv4 +The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the Nested Endpoint in the parent profile to be considered available. +Only applicable to endpoint of type 'NestedEndpoints'. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinChildEndpointsIPv6 +The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the Nested Endpoint in the parent profile to be considered available. +Only applicable to endpoint of type 'NestedEndpoints'. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Specifies the priority that Traffic Manager assigns to the endpoint. +This parameter is used only if the Traffic Manager profile is configured with the for Priority traffic-routing method. +Valid values are integers from 1 through 1000. +Lower values represent higher priority. + +If you specify a priority, you must specify priorities on all endpoints in the profile, and no two endpoints can share the same priority value. +If you do not specify priorities, Traffic Manager assigns default priority values to the endpoints, starting with one (1), in the order the profile lists the endpoints. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetMapping +The list of address ranges or subnets mapped to this endpoint when using the 'Subnet' traffic routing method. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerIpAddressRange] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Target +Specifies the fully qualified DNS name of the endpoint. +Traffic Manager returns this value in DNS responses when it directs traffic to this endpoint. +Specify this parameter only for the ExternalEndpoints endpoint type. +For other endpoint types, specify the *TargetResourceId* parameter instead. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceId +Specifies resource ID of the target. +Specify this parameter only for the AzureEndpoints and NestedEndpoints endpoint types. +For the ExternalEndpoints endpoint type, specify the *Target* parameter instead. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerProfile +Specifies a local **TrafficManagerProfile** object. +This cmdlet modifies this local object. +To obtain a **TrafficManagerProfile** object, use the Get-AzTrafficManagerProfile cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Type +Specifies the type of endpoint that this cmdlet adds to the Azure Traffic Manager profile. +Valid values are: + +- AzureEndpoints +- ExternalEndpoints +- NestedEndpoints + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzureEndpoints, ExternalEndpoints, NestedEndpoints + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Weight +Specifies the weight that Traffic Manager assigns to the endpoint. +Valid values are integers from 1 through 1000. +The default value is one (1). +This parameter is used only if the Traffic Manager profile is configured with the Weighted traffic-routing method. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## NOTES + +## RELATED LINKS + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[New-AzTrafficManagerEndpoint](./New-AzTrafficManagerEndpoint.md) + +[Remove-AzTrafficManagerEndpointConfig](./Remove-AzTrafficManagerEndpointConfig.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) + + diff --git a/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerExpectedStatusCodeRange.md b/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerExpectedStatusCodeRange.md new file mode 100644 index 0000000000..492d87a55c --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerExpectedStatusCodeRange.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D340 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/add-aztrafficmanagerexpectedstatuscoderange +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Add-AzTrafficManagerExpectedStatusCodeRange.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Add-AzTrafficManagerExpectedStatusCodeRange.md +--- + +# Add-AzTrafficManagerExpectedStatusCodeRange + +## SYNOPSIS +Adds an expected status code range to a local Traffic Manager profile object. + +## SYNTAX + +``` +Add-AzTrafficManagerExpectedStatusCodeRange -Min <Int32> -Max <Int32> + -TrafficManagerProfile <TrafficManagerProfile> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzTrafficManagerExpectedStatusCodeRange** cmdlet adds a range of expected status codes to a local Azure Traffic Manager profile object. +You can get a profile by using the New-AzTrafficManagerProfile or Get-AzTrafficManagerProfile cmdlets. + +This cmdlet operates on the local profile object. +Commit your changes to the profile for Traffic Manager by using the Set-AzTrafficManagerProfile cmdlet. + +## EXAMPLES + +### Example 1: Add an expected status code range to a profile +```powershell +$TrafficManagerProfile = Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" +Add-AzTrafficManagerExpectedStatusCodeRange -TrafficManagerProfile $TrafficManagerProfile -Min 200 -Max 499 +Set-AzTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile +``` + +The first command gets an Azure Traffic Manager profile by using the **Get-AzTrafficManagerProfile** cmdlet. +The command stores the local profile in the $TrafficManagerProfile variable. +The second command adds an expected status code range to the profile stored in $TrafficManagerProfile. +The final command updates the profile in Traffic Manager to match the local value in $TrafficManagerProfile. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Max +Specifies the highest value in the status code range to be added. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Min +Specifies the lowest value in the status code range to be added. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerProfile +Specifies a local **TrafficManagerProfile** object. +This cmdlet modifies this local object. +To obtain a **TrafficManagerProfile** object, use the Get-AzTrafficManagerProfile cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## NOTES + +## RELATED LINKS + +[Remove-AzTrafficManagerExpectedStatusCodeRange](./Remove-AzTrafficManagerExpectedStatusCodeRange.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) diff --git a/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerIpAddressRange.md b/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerIpAddressRange.md new file mode 100644 index 0000000000..7324254058 --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Add-AzTrafficManagerIpAddressRange.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D341 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/add-aztrafficmanagerIpAddressRange +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Add-AzTrafficManagerIpAddressRange.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Add-AzTrafficManagerIpAddressRange.md +--- + +# Add-AzTrafficManagerIpAddressRange + +## SYNOPSIS +Adds an address range or subnet to a local Traffic Manager endpoint object. + +## SYNTAX + +``` +Add-AzTrafficManagerIpAddressRange -First <String> [-Last <String>] [-Scope <Int32>] + -TrafficManagerEndpoint <TrafficManagerEndpoint> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzTrafficManagerIpAddressRange** cmdlet adds an IP address range to a local Azure Traffic Manager endpoint object. +You can get an endpoint by using the New-AzTrafficManagerEndpoint or Get-AzTrafficManagerEndpoint cmdlets. + +This cmdlet operates on the local endpoint object. +Commit your changes to the endpoint for Traffic Manager by using the Set-AzTrafficManagerEndpoint cmdlet. + +## EXAMPLES + +### Example 1: Add IP address ranges to an endpoint +```powershell +$TrafficManagerEndpoint = New-AzTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints -Priority 1 -TargetResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-CentralUS/providers/Microsoft.Web/sites/contoso-web-app" -Weight 10 +Add-AzTrafficManagerIpAddressRange -TrafficManagerEndpoint $TrafficManagerEndpoint -First "1.2.3.4" -Last "5.6.7.8" +Add-AzTrafficManagerIpAddressRange -TrafficManagerEndpoint $TrafficManagerEndpoint -First "9.10.11.0" -Scope 24 +Add-AzTrafficManagerIpAddressRange -TrafficManagerEndpoint $TrafficManagerEndpoint -First "12.13.14.0" -Last "12.13.14.31" -Scope 27 +Add-AzTrafficManagerIpAddressRange -TrafficManagerEndpoint $TrafficManagerEndpoint -First "15.16.17.18" +Set-AzTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint +``` + +The first command creates an Azure Traffic Manager endpoint by using the **New-AzTrafficManagerEndpoint** cmdlet. +The command stores the local endpoint in the $TrafficManagerEndpoint variable. +The second command adds the IP address range 1.2.3.4 to 5.6.7.8 to the endpoint stored in $TrafficManagerEndpoint. +The third command adds the IP address range 9.10.11.0 to 9.10.11.255 to the endpoint stored in $TrafficManagerEndpoint. +The fourth command verifies that the scope matches the size of the range, then adds the IP address range 12.13.14.0 to 12.13.14.31 to the endpoint stored in $TrafficManagerEndpoint. +The fifth command adds the IP address range 15.16.17.18 to 15.16.17.18 to the endpoint stored in $TrafficManagerEndpoint. +The final command updates the endpoint in Traffic Manager to match the local value in $TrafficManagerEndpoint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Last +Specifies the last IP address in the range to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +Specifies the scope of the IP address range to be added. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerEndpoint +Specifies a local **TrafficManagerEndpoint** object. +This cmdlet modifies this local object. +To obtain a **TrafficManagerEndpoint** object, use the Get-AzTrafficManagerEndpoint or New-AzTrafficManagerEndpoint cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Specifies the first IP address in the range to be added. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## NOTES + +## RELATED LINKS + +[Remove-AzTrafficManagerIpAddressRange](./Remove-AzTrafficManagerIpAddressRange.md) + +[New-AzTrafficManagerEndpoint](./New-AzTrafficManagerEndpoint.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerEndpoint.md) + +[Set-AzTrafficManagerEndpoint](./Set-AzTrafficManagerEndpoint.md) diff --git a/azps-10.1.0/Az.TrafficManager/Az.TrafficManager.md b/azps-10.1.0/Az.TrafficManager/Az.TrafficManager.md new file mode 100644 index 0000000000..86f1608d16 --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Az.TrafficManager.md @@ -0,0 +1,81 @@ +--- +Module Name: Az.TrafficManager +Module Guid: D48CF693-4125-4D2D-8790-1514F44CE325 +Download Help Link: http://go.microsoft.com/fwlink/?LinkId=280237 +Help Version: 4.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Az.TrafficManager.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Az.TrafficManager.md +--- + +# Az.TrafficManager Module +## Description +This topic lists the help topics for the Azure Traffic Manager cmdlets. The cmdlets use Azure Resource Manager. + +## Az.TrafficManager Cmdlets +### [Add-AzTrafficManagerCustomHeaderToEndpoint](Add-AzTrafficManagerCustomHeaderToEndpoint.md) +Adds custom header information to a local Traffic Manager endpoint object. + +### [Add-AzTrafficManagerCustomHeaderToProfile](Add-AzTrafficManagerCustomHeaderToProfile.md) +Adds custom header information to a local Traffic Manager profile object. + +### [Add-AzTrafficManagerEndpointConfig](Add-AzTrafficManagerEndpointConfig.md) +Adds an endpoint to a local Traffic Manager profile object. + +### [Add-AzTrafficManagerExpectedStatusCodeRange](Add-AzTrafficManagerExpectedStatusCodeRange.md) +Adds an expected status code range to a local Traffic Manager profile object. + +### [Add-AzTrafficManagerIpAddressRange](Add-AzTrafficManagerIpAddressRange.md) +Adds an address range or subnet to a local Traffic Manager endpoint object. + +### [Disable-AzTrafficManagerEndpoint](Disable-AzTrafficManagerEndpoint.md) +Disables an endpoint in a Traffic Manager profile. + +### [Disable-AzTrafficManagerProfile](Disable-AzTrafficManagerProfile.md) +Disables a Traffic Manager profile. + +### [Enable-AzTrafficManagerEndpoint](Enable-AzTrafficManagerEndpoint.md) +Enables an endpoint in a Traffic Manager profile. + +### [Enable-AzTrafficManagerProfile](Enable-AzTrafficManagerProfile.md) +Enables a Traffic Manager profile. + +### [Get-AzTrafficManagerEndpoint](Get-AzTrafficManagerEndpoint.md) +Gets an endpoint for a Traffic Manager profile. + +### [Get-AzTrafficManagerProfile](Get-AzTrafficManagerProfile.md) +Gets a Traffic Manager profile. + +### [New-AzTrafficManagerEndpoint](New-AzTrafficManagerEndpoint.md) +Creates an endpoint in a Traffic Manager profile. + +### [New-AzTrafficManagerProfile](New-AzTrafficManagerProfile.md) +Creates a Traffic Manager profile. + +### [Remove-AzTrafficManagerCustomHeaderFromEndpoint](Remove-AzTrafficManagerCustomHeaderFromEndpoint.md) +Removes custom header information from a local Traffic Manager endpoint object. + +### [Remove-AzTrafficManagerCustomHeaderFromProfile](Remove-AzTrafficManagerCustomHeaderFromProfile.md) +Removes custom header information from a local Traffic Manager profile object. + +### [Remove-AzTrafficManagerEndpoint](Remove-AzTrafficManagerEndpoint.md) +Removes an endpoint from Traffic Manager. + +### [Remove-AzTrafficManagerEndpointConfig](Remove-AzTrafficManagerEndpointConfig.md) +Removes an endpoint from a local Traffic Manager profile object. + +### [Remove-AzTrafficManagerExpectedStatusCodeRange](Remove-AzTrafficManagerExpectedStatusCodeRange.md) +Removes an expected status code range from a local Traffic Manager profile object. + +### [Remove-AzTrafficManagerIpAddressRange](Remove-AzTrafficManagerIpAddressRange.md) +Removes an address range or subnet from a local Traffic Manager endpoint object. + +### [Remove-AzTrafficManagerProfile](Remove-AzTrafficManagerProfile.md) +Deletes a Traffic Manager profile. + +### [Set-AzTrafficManagerEndpoint](Set-AzTrafficManagerEndpoint.md) +Updates a Traffic Manager endpoint. + +### [Set-AzTrafficManagerProfile](Set-AzTrafficManagerProfile.md) +Updates a Traffic Manager profile. + diff --git a/azps-10.1.0/Az.TrafficManager/Disable-AzTrafficManagerEndpoint.md b/azps-10.1.0/Az.TrafficManager/Disable-AzTrafficManagerEndpoint.md new file mode 100644 index 0000000000..8bbc8bd25c --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Disable-AzTrafficManagerEndpoint.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 8CC749F1-B961-4F8F-BAD4-2C0F4385D1C2 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/disable-aztrafficmanagerendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Disable-AzTrafficManagerEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Disable-AzTrafficManagerEndpoint.md +--- + +# Disable-AzTrafficManagerEndpoint + +## SYNOPSIS +Disables an endpoint in a Traffic Manager profile. + +## SYNTAX + +### Fields +``` +Disable-AzTrafficManagerEndpoint -Name <String> -Type <String> -ProfileName <String> + -ResourceGroupName <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### Object +``` +Disable-AzTrafficManagerEndpoint -TrafficManagerEndpoint <TrafficManagerEndpoint> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzTrafficManagerEndpoint** cmdlet disables an endpoint in an Azure Traffic Manager profile. + +You can use the pipeline operator to pass a **TrafficManagerEndpoint** object to this cmdlet, or you can pass a **TrafficManagerEndpoint** object using the *TrafficManagerEndpoint* parameter. + +Alternatively, you can specify the endpoint name and type by using the *Name* and *Type* parameters, together with the *ProfileName* and *ResourceGroupName* parameters. + +## EXAMPLES + +### Example 1: Disable an endpoint by name +```powershell +Disable-AzTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName ResourceGroup11 -Type ExternalEndpoints +``` + +This command disables the external endpoint named contoso in the profile named ContosoProfile in resource group ResourceGroup11. +The command prompts you for confirmation. + +### Example 2: Disable an endpoint by using the pipeline +```powershell +Get-AzTrafficManagerEndpoint -Name "contoso" -Type ExternalEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Disable-AzTrafficManagerEndpoint -Force +``` + +This command gets the external endpoint named Contoso from the profile named ContosoProfile in ResourceGroup11. +The command then passes that endpoint to the **Disable-AzTrafficManagerEndpoint** cmdlet by using the pipeline operator. +That cmdlet disables that endpoint. +The command specifies the *Force* parameter. +Therefore, it does not prompt you for confirmation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Traffic Manager endpoint that this cmdlet disables. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Specifies the name of a Traffic Manager profile in which this cmdlet disables an endpoint. +To obtain a profile, use the Get-AzTrafficManagerProfile cmdlet. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet disables a Traffic Manager endpoint in the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerEndpoint +Specifies the Traffic Manager endpoint that this cmdlet disables. +To obtain a **TrafficManagerEndpoint** object, use the Get-AzTrafficManagerEndpoint cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Type +Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. +Valid values are: + +- AzureEndpoints +- ExternalEndpoints +- NestedEndpoints + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: +Accepted values: AzureEndpoints, ExternalEndpoints, NestedEndpoints + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Enable-AzTrafficManagerEndpoint](./Enable-AzTrafficManagerEndpoint.md) + +[Get-AzTrafficManagerEndpoint](./Get-AzTrafficManagerEndpoint.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[New-AzTrafficManagerEndpoint](./New-AzTrafficManagerEndpoint.md) + +[New-AzTrafficManagerProfile](./New-AzTrafficManagerProfile.md) + +[Remove-AzTrafficManagerEndpoint](./Remove-AzTrafficManagerEndpoint.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) + + diff --git a/azps-10.1.0/Az.TrafficManager/Disable-AzTrafficManagerProfile.md b/azps-10.1.0/Az.TrafficManager/Disable-AzTrafficManagerProfile.md new file mode 100644 index 0000000000..fe450d2a7b --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Disable-AzTrafficManagerProfile.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: B6E043FF-F4DD-44B7-BEAA-6B17C8F21D58 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/disable-aztrafficmanagerprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Disable-AzTrafficManagerProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Disable-AzTrafficManagerProfile.md +--- + +# Disable-AzTrafficManagerProfile + +## SYNOPSIS +Disables a Traffic Manager profile. + +## SYNTAX + +### Fields +``` +Disable-AzTrafficManagerProfile -Name <String> -ResourceGroupName <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Object +``` +Disable-AzTrafficManagerProfile -TrafficManagerProfile <TrafficManagerProfile> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Disable-AzTrafficManagerProfile** cmdlet disables an Azure Traffic Manager profile. +You can specify the profile object by using the pipeline or as a parameter value. +Alternatively, you can specify the profile by using the *Name* and *ResourceGroupName* parameters. + +## EXAMPLES + +### Example 1: Disable a profile specified by name +```powershell +Disable-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" +``` + +This command disables the profile named ContosoProfile in ResourceGroup11. +The command prompts you for confirmation. + +### Example 2: Disable a profile by using the pipeline +```powershell +Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Disable-AzTrafficManagerProfile -Force +``` + +This command gets the profile named ContosoProfile in ResourceGroup11. +The command then passes that profile to the **Disable-AzTrafficManagerProfile** cmdlet by using the pipeline operator. +That cmdlet disables that profile. +The command specifies the *Force* parameter. +Therefore, it does not prompt you for confirmation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Traffic Manager profile that this cmdlet disables. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet disables a Traffic Manager profile in the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerProfile +Specifies a **TrafficManagerProfile** object to disable. +To obtain a **TrafficManagerProfile** object, use the Get-AzTrafficManagerProfile cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Enable-AzTrafficManagerProfile](./Enable-AzTrafficManagerProfile.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[New-AzTrafficManagerProfile](./New-AzTrafficManagerProfile.md) + +[Remove-AzTrafficManagerProfile](./Remove-AzTrafficManagerProfile.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) + + diff --git a/azps-10.1.0/Az.TrafficManager/Enable-AzTrafficManagerEndpoint.md b/azps-10.1.0/Az.TrafficManager/Enable-AzTrafficManagerEndpoint.md new file mode 100644 index 0000000000..77ddb5512a --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Enable-AzTrafficManagerEndpoint.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 32263236-C207-4FE0-AB8A-018118FC7729 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/enable-aztrafficmanagerendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Enable-AzTrafficManagerEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Enable-AzTrafficManagerEndpoint.md +--- + +# Enable-AzTrafficManagerEndpoint + +## SYNOPSIS +Enables an endpoint in a Traffic Manager profile. + +## SYNTAX + +### Fields +``` +Enable-AzTrafficManagerEndpoint -Name <String> -Type <String> -ProfileName <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Object +``` +Enable-AzTrafficManagerEndpoint -TrafficManagerEndpoint <TrafficManagerEndpoint> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzTrafficManagerEndpoint** cmdlet enables an endpoint in an Azure Traffic Manager profile. + +You can use the pipeline operator to pass a **TrafficManagerEndpoint** object to this cmdlet, or you can specify a **TrafficManagerEndpoint** object by using the *TrafficManagerEndpoint* parameter. + +Alternatively, you can specify the endpoint name and type by using the *Name* and *Type* parameters, together with the *ProfileName* and *ResourceGroupName* parameters. + +## EXAMPLES + +### Example 1: Enable an endpoint from a profile +```powershell +Enable-AzTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName ResourceGroup11 -Type ExternalEndpoints +``` + +This command enables the external endpoint named contoso in the profile named ContosoProfile in resource group ResourceGroup11. + +### Example 2: Enable an endpoint by using the pipeline +```powershell +Get-AzTrafficManagerEndpoint -Name "contoso" -Type ExternalEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Enable-AzTrafficManagerEndpoint +``` + +This command gets the external endpoint named Contoso from the profile named ContosoProfile in ResourceGroup11. +The command then passes that endpoint to the **Enable-AzTrafficManagerEndpoint** cmdlet by using the pipeline operator. +That cmdlet enables that endpoint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Traffic Manager endpoint that this cmdlet enables. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Specifies the name of a Traffic Manager profile in which this cmdlet enables an endpoint. +To obtain a profile, use the Get-AzTrafficManagerProfile cmdlet. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet enables a Traffic Manager endpoint in the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerEndpoint +Specifies the Traffic Manager endpoint that this cmdlet enables. +To obtain a **TrafficManagerEndpoint** object, use the Get-AzTrafficManagerEndpoint cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Type +Specifies the type of endpoint that this cmdlet disables in the Traffic Manager profile. +Valid values are: + +- AzureEndpoints +- ExternalEndpoints +- NestedEndpoints + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: +Accepted values: AzureEndpoints, ExternalEndpoints, NestedEndpoints + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Disable-AzTrafficManagerEndpoint](./Disable-AzTrafficManagerEndpoint.md) + +[Get-AzTrafficManagerEndpoint](./Get-AzTrafficManagerEndpoint.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[New-AzTrafficManagerEndpoint](./New-AzTrafficManagerEndpoint.md) + +[New-AzTrafficManagerProfile](./New-AzTrafficManagerProfile.md) + +[Remove-AzTrafficManagerEndpoint](./Remove-AzTrafficManagerEndpoint.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) + + diff --git a/azps-10.1.0/Az.TrafficManager/Enable-AzTrafficManagerProfile.md b/azps-10.1.0/Az.TrafficManager/Enable-AzTrafficManagerProfile.md new file mode 100644 index 0000000000..25e43a13a6 --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Enable-AzTrafficManagerProfile.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 2CE84C3A-EFC0-47FA-ACE5-687380D90A7D +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/enable-aztrafficmanagerprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Enable-AzTrafficManagerProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Enable-AzTrafficManagerProfile.md +--- + +# Enable-AzTrafficManagerProfile + +## SYNOPSIS +Enables a Traffic Manager profile. + +## SYNTAX + +### Fields +``` +Enable-AzTrafficManagerProfile -Name <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Object +``` +Enable-AzTrafficManagerProfile -TrafficManagerProfile <TrafficManagerProfile> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Enable-AzTrafficManagerProfile** cmdlet enables an Azure Traffic Manager profile. +You can specify the profile object by using the pipeline or as a parameter value. +Alternatively, you can specify the profile by using the *Name* and *ResourceGroupName* parameters. + +## EXAMPLES + +### Example 1: Enable a profile specified by name +```powershell +Enable-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" +``` + +This command enables the profile named ContosoProfile in ResourceGroup11. + +### Example 2: Enable a profile by using the pipeline +```powershell +Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Enable-AzTrafficManagerProfile +``` + +This command gets the profile named ContosoProfile in ResourceGroup11. +The command then passes that profile to the **Enable-AzTrafficManagerProfile** cmdlet by using the pipeline operator. +That cmdlet enables that profile. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Traffic Manager profile that this cmdlet enables. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet enables a Traffic Manager profile in the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerProfile +Specifies a **TrafficManagerProfile** object to enable. +To obtain a **TrafficManagerProfile** object, use the Get-AzTrafficManagerProfile cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Disable-AzTrafficManagerProfile](./Disable-AzTrafficManagerProfile.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[New-AzTrafficManagerProfile](./New-AzTrafficManagerProfile.md) + +[Remove-AzTrafficManagerProfile](./Remove-AzTrafficManagerProfile.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) + + diff --git a/azps-10.1.0/Az.TrafficManager/Get-AzTrafficManagerEndpoint.md b/azps-10.1.0/Az.TrafficManager/Get-AzTrafficManagerEndpoint.md new file mode 100644 index 0000000000..6989371b96 --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Get-AzTrafficManagerEndpoint.md @@ -0,0 +1,171 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 4556C345-55D0-431C-B980-219D5ED14E5F +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/get-aztrafficmanagerendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Get-AzTrafficManagerEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Get-AzTrafficManagerEndpoint.md +--- + +# Get-AzTrafficManagerEndpoint + +## SYNOPSIS +Gets an endpoint for a Traffic Manager profile. + +## SYNTAX + +### Fields +``` +Get-AzTrafficManagerEndpoint -Name <String> -Type <String> -ProfileName <String> -ResourceGroupName <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### Object +``` +Get-AzTrafficManagerEndpoint -TrafficManagerEndpoint <TrafficManagerEndpoint> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzTrafficManagerEndpoint** cmdlet gets an endpoint for an Azure Traffic Manager profile. + +You can modify this object locally, and then apply changes to the profile by using the Set-AzTrafficManagerEndpoint cmdlet. +Specify the endpoint by using the *Name* and *Type* parameters. +You can specify the Traffic Manager profile either by using the *ProfileName* and *ResourceGroupName* parameter, or by specifying a **TrafficManagerProfile** object. +Alternatively, you can pass that value by using the pipeline. + +## EXAMPLES + +### Example 1: Get an endpoint +```powershell +$TrafficManagerEndpoint = Get-AzTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints +``` + +This command gets the Azure endpoint named contoso from the profile named ContosoProfile in the resource group named ResourceGroup11, and then stores that object in the $TrafficManagerEndpoint variable. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Traffic Manager endpoint that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Specifies the name of the Traffic Manager endpoint that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet gets a Traffic Manager endpoint in the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerEndpoint +Specifies the Traffic Manager endpoint that this cmdlet gets. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Type +Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. +Valid values are: + +- AzureEndpoints +- ExternalEndpoints +- NestedEndpoints + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: +Accepted values: AzureEndpoints, ExternalEndpoints, NestedEndpoints + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## NOTES + +## RELATED LINKS + +[Disable-AzTrafficManagerEndpoint](./Disable-AzTrafficManagerEndpoint.md) + +[Enable-AzTrafficManagerEndpoint](./Enable-AzTrafficManagerEndpoint.md) + +[New-AzTrafficManagerEndpoint](./New-AzTrafficManagerEndpoint.md) + +[Remove-AzTrafficManagerEndpoint](./Remove-AzTrafficManagerEndpoint.md) + +[Set-AzTrafficManagerEndpoint](./Set-AzTrafficManagerEndpoint.md) + + diff --git a/azps-10.1.0/Az.TrafficManager/Get-AzTrafficManagerProfile.md b/azps-10.1.0/Az.TrafficManager/Get-AzTrafficManagerProfile.md new file mode 100644 index 0000000000..2cbc082638 --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Get-AzTrafficManagerProfile.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 5032D487-3849-4C80-BD14-5B735FC39285 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/get-aztrafficmanagerprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Get-AzTrafficManagerProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Get-AzTrafficManagerProfile.md +--- + +# Get-AzTrafficManagerProfile + +## SYNOPSIS +Gets a Traffic Manager profile. + +## SYNTAX + +### ResourceGroupParameterSet +``` +Get-AzTrafficManagerProfile [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### AccountNameParameterSet +``` +Get-AzTrafficManagerProfile [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzTrafficManagerProfile** cmdlet gets an Azure Traffic Manager profile, and returns an object that represents that profile. +Specify a profile by its name and resource group name. + +You can modify this object locally, and then apply changes to the profile by using the Set-AzTrafficManagerProfile cmdlet. + +## EXAMPLES + +### Example 1: Get a profile +```powershell +Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" +``` + +This command gets the profile named ContosoProfile in ResourceGroup11. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Traffic Manager profile that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: AccountNameParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group that contains the Traffic Manager profile that this cmdlet gets. + +```yaml +Type: System.String +Parameter Sets: ResourceGroupParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: AccountNameParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## NOTES + +## RELATED LINKS + +[Disable-AzTrafficManagerProfile](./Disable-AzTrafficManagerProfile.md) + +[Enable-AzTrafficManagerProfile](./Enable-AzTrafficManagerProfile.md) + +[New-AzTrafficManagerProfile](./New-AzTrafficManagerProfile.md) + +[Remove-AzTrafficManagerProfile](./Remove-AzTrafficManagerProfile.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) + + diff --git a/azps-10.1.0/Az.TrafficManager/New-AzTrafficManagerEndpoint.md b/azps-10.1.0/Az.TrafficManager/New-AzTrafficManagerEndpoint.md new file mode 100644 index 0000000000..f4861ddaa4 --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/New-AzTrafficManagerEndpoint.md @@ -0,0 +1,392 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: A7A908A1-7326-4725-A3F9-4D05E40C5F73 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/new-aztrafficmanagerendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/New-AzTrafficManagerEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/New-AzTrafficManagerEndpoint.md +--- + +# New-AzTrafficManagerEndpoint + +## SYNOPSIS +Creates an endpoint in a Traffic Manager profile. + +## SYNTAX + +``` +New-AzTrafficManagerEndpoint -Name <String> -ProfileName <String> -ResourceGroupName <String> -Type <String> + [-TargetResourceId <String>] [-Target <String>] -EndpointStatus <String> [-Weight <UInt32>] + [-Priority <UInt32>] [-EndpointLocation <String>] [-AlwaysServe <String>] [-MinChildEndpoints <UInt32>] + [-MinChildEndpointsIPv4 <UInt32>] [-MinChildEndpointsIPv6 <UInt32>] + [-GeoMapping <System.Collections.Generic.List`1[System.String]>] + [-SubnetMapping <System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerIpAddressRange]>] + [-CustomHeader <System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerCustomHeader]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzTrafficManagerEndpoint** cmdlet creates an endpoint in an Azure Traffic Manager profile. + +This cmdlet commits each new endpoint to the Traffic Manager service. +To add multiple endpoints to a local Traffic Manager profile object and commit changes in a single operation, use the Add-AzTrafficManagerEndpointConfig cmdlet. + +## EXAMPLES + +### Example 1: Create an external endpoint for a profile +```powershell +New-AzTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type ExternalEndpoints -EndpointLocation "North Europe" -Priority 1 -Target "www.contoso.com" -Weight 10 +``` + +This command creates an external endpoint named contoso in the profile named ContosoProfile in the resource group named ResourceGroup11. + +### Example 2: Create an Azure endpoint for a profile +```powershell +New-AzTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints -Priority 1 -TargetResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-CentralUS/providers/Microsoft.Web/sites/contoso-web-app" -Weight 10 +``` + +This command creates an Azure endpoint named contoso in the profile named ContosoProfile in resource group ResourceGroup11. +The Azure endpoint points to the Azure Web App whose Azure Resource Manager ID is given by the URI path in *TargetResourceId*. +The command does not specify the *EndpointLocation* parameter because the Web App resource supplies the location. + +## PARAMETERS + +### -AlwaysServe +If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomHeader +List of custom header name and value pairs for probe requests. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerCustomHeader] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointLocation +Specifies the location of the endpoint to use in the Performance traffic-routing method. +This parameter is only applicable to endpoints of the ExternalEndpoints or NestedEndpoints type. +You must specify this parameter when the Performance traffic-routing method is used. + +Specify an Azure region name. +For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/ (http://azure.microsoft.com/regions/). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointStatus +Specifies the status of the endpoint. +Valid values are: + +- Enabled +- Disabled + +If the status is Enabled, the endpoint is probed for endpoint health and is included in the traffic-routing method. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GeoMapping +The list of regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager documentation for a full list of accepted values. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinChildEndpoints +Specify an Azure region name. +For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/ (http://azure.microsoft.com/regions/). + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinChildEndpointsIPv4 +The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the Nested Endpoint in the parent profile to be considered available. +Only applicable to endpoint of type 'NestedEndpoints'. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinChildEndpointsIPv6 +The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the Nested Endpoint in the parent profile to be considered available. +Only applicable to endpoint of type 'NestedEndpoints'. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Traffic Manager endpoint that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Specifies the priority that Traffic Manager assigns to the endpoint. +This parameter is used only if the Traffic Manager profile is configured with the for Priority traffic-routing method. +Valid values are integers from 1 through 1000. +Lower values represent higher priority. + +If you specify a priority, you must specify priorities on all endpoints in the profile, and no two endpoints can share the same priority value. +If you do not specify priorities, Traffic Manager assigns default priority values to the endpoints, starting with one (1), in the order the profile lists the endpoints. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Specifies the name of a Traffic Manager profile to which this cmdlet adds an endpoint. +To obtain a profile, use the New-AzTrafficManagerProfile or Get-AzTrafficManagerProfile cmdlets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet creates a Traffic Manager endpoint in the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetMapping +The list of address ranges or subnets mapped to this endpoint when using the 'Subnet' traffic routing method. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerIpAddressRange] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Target +Specifies the fully qualified DNS name of the endpoint. +Traffic Manager returns this value in DNS responses when it directs traffic to this endpoint. +Specify this parameter only for the ExternalEndpoints endpoint type. +For other endpoint types, specify the *TargetResourceId* parameter instead. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceId +Specifies resource ID of the target. +Specify this parameter only for the AzureEndpoints and NestedEndpoints endpoint types. +For the ExternalEndpoints endpoint type, specify the *Target* parameter instead. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. +Valid values are: + +- AzureEndpoints +- ExternalEndpoints +- NestedEndpoints + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: AzureEndpoints, ExternalEndpoints, NestedEndpoints + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Weight +Specifies the weight that Traffic Manager assigns to the endpoint. +Valid values are integers from 1 through 1000. +The default value is one (1). +This parameter is used only if the Traffic Manager profile is configured with the Weighted traffic-routing method. + +```yaml +Type: System.Nullable`1[System.UInt32] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## NOTES + +## RELATED LINKS + +[Disable-AzTrafficManagerEndpoint](./Disable-AzTrafficManagerEndpoint.md) + +[Enable-AzTrafficManagerEndpoint](./Enable-AzTrafficManagerEndpoint.md) + +[Get-AzTrafficManagerEndpoint](./Get-AzTrafficManagerEndpoint.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[New-AzTrafficManagerProfile](./New-AzTrafficManagerProfile.md) + +[Remove-AzTrafficManagerEndpoint](./Remove-AzTrafficManagerEndpoint.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) + + diff --git a/azps-10.1.0/Az.TrafficManager/New-AzTrafficManagerProfile.md b/azps-10.1.0/Az.TrafficManager/New-AzTrafficManagerProfile.md new file mode 100644 index 0000000000..5dd6fc995b --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/New-AzTrafficManagerProfile.md @@ -0,0 +1,355 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: DE31891A-0EF7-44D7-B955-A3279D27CC21 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/new-aztrafficmanagerprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/New-AzTrafficManagerProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/New-AzTrafficManagerProfile.md +--- + +# New-AzTrafficManagerProfile + +## SYNOPSIS +Creates a Traffic Manager profile. + +## SYNTAX + +``` +New-AzTrafficManagerProfile -Name <String> -ResourceGroupName <String> [-ProfileStatus <String>] + -RelativeDnsName <String> -Ttl <UInt32> -TrafficRoutingMethod <String> -MonitorProtocol <String> + -MonitorPort <UInt32> [-MonitorPath <String>] [-MonitorIntervalInSeconds <Int32>] + [-MonitorTimeoutInSeconds <Int32>] [-MonitorToleratedNumberOfFailures <Int32>] [-MaxReturn <Int64>] + [-Tag <Hashtable>] + [-CustomHeader <System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerCustomHeader]>] + [-ExpectedStatusCodeRange <System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerExpectedStatusCodeRange]>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzTrafficManagerProfile** cmdlet creates an Azure Traffic Manager profile. +Specify the *Name* parameter and required settings. +This cmdlet returns a local object that represents the new profile. + +This cmdlet does not configure Traffic Manager endpoints. +You can update the local profile object by using the Add-AzTrafficManagerEndpointConfig cmdlet. +Then upload changes to Traffic Manager by using the Set-AzTrafficManagerProfile cmdlet. +Alternatively, you can add endpoints by using the New-AzTrafficManagerEndpoint cmdlet. + +## EXAMPLES + +### Example 1: Create a profile +```powershell +New-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -ProfileStatus Enabled -TrafficRoutingMethod Performance -RelativeDnsName "contosoapp" -TTL 30 -MonitorProtocol HTTP -MonitorPort 80 -MonitorPath "/default.aspx" +``` + +This command creates an Azure Traffic Manager profile named ContosoProfile in resource group ResourceGroup11. +The DNS FQDN is contosoapp.trafficmanager.net. + +## PARAMETERS + +### -CustomHeader +List of custom header name and value pairs for probe requests. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerCustomHeader] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpectedStatusCodeRange +List of expected HTTP status code ranges for probe requests. + +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerExpectedStatusCodeRange] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxReturn +The maximum number of answers returned for profiles with a MultiValue routing method. + +```yaml +Type: System.Nullable`1[System.Int64] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorIntervalInSeconds +The interval (in seconds) at which Traffic Manager will check the health of each endpoint in this profile. The default is 30. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: IntervalInSecondsForMonitor + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorPath +Specifies the path that is used to monitor endpoint health. +Specify a value relative to the endpoint domain name. +This value must begin with a slash (/). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PathForMonitor + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorPort +Specifies the TCP port that is used to monitor endpoint health. +Valid values are integers from 1 through 65535. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: PortForMonitor + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorProtocol +Specifies the protocol to use to monitor endpoint health. +Valid values are: + +- HTTP +- HTTPS + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ProtocolForMonitor +Accepted values: HTTP, HTTPS, TCP + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorTimeoutInSeconds +The time (in seconds) that Traffic Manager allows endpoints in this profile to respond to the health check. The default is 10. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: TimeoutInSecondsForMonitor + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorToleratedNumberOfFailures +The number of consecutive failed health checks that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next consecutive failed health check. The default is 3. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: (All) +Aliases: ToleratedNumberOfFailuresForMonitor + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies a name for the Traffic Manager profile that this cmdlet creates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileStatus +Specifies the status of the profile. +Valid values are: Enabled and Disabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RelativeDnsName +Specifies the relative DNS name that this Traffic Manager profile provides. +Traffic Manager combines this value and the DNS domain name that Azure Traffic Manager uses to form the fully qualified domain name (FQDN) of the profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet creates a Traffic Manager profile in the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Key-value pairs in the form of a hash table set as tags on the server. For example: + +@{key0="value0";key1=$null;key2="value2"} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: Tags + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficRoutingMethod +Specifies the traffic routing method. +This method determines which endpoint Traffic Manager returns in response to incoming DNS queries. +Valid values are: + +- Performance +- Weighted +- Priority +- Geographic + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Performance, Weighted, Priority, Geographic, Subnet, MultiValue + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ttl +Specifies the DNS Time to Live (TTL) value. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## NOTES + +## RELATED LINKS + +[Add-AzTrafficManagerEndpointConfig](./Add-AzTrafficManagerEndpointConfig.md) + +[Disable-AzTrafficManagerProfile](./Disable-AzTrafficManagerProfile.md) + +[Enable-AzTrafficManagerProfile](./Enable-AzTrafficManagerProfile.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[Remove-AzTrafficManagerProfile](./Remove-AzTrafficManagerProfile.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) + + diff --git a/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerCustomHeaderFromEndpoint.md b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerCustomHeaderFromEndpoint.md new file mode 100644 index 0000000000..8cbfa8a22b --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerCustomHeaderFromEndpoint.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D342 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/remove-aztrafficmanagercustomheaderfromendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerCustomHeaderFromEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerCustomHeaderFromEndpoint.md +--- + +# Remove-AzTrafficManagerCustomHeaderFromEndpoint + +## SYNOPSIS +Removes custom header information from a local Traffic Manager endpoint object. + +## SYNTAX + +``` +Remove-AzTrafficManagerCustomHeaderFromEndpoint -Name <String> -TrafficManagerEndpoint <TrafficManagerEndpoint> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzTrafficManagerCustomHeaderFromEndpoint** cmdlet removes custom header information from a local Azure Traffic Manager endpoint object. +You can get an endpoint by using the New-AzTrafficManagerEndpoint or Get-AzTrafficManagerEndpoint cmdlets. + +This cmdlet operates on the local endpoint object. +Commit your changes to the endpoint for Traffic Manager by using the Set-AzTrafficManagerEndpoint cmdlet. + +## EXAMPLES + +### Example 1: Remove custom subnet information from an endpoint +```powershell +$TrafficManagerEndpoint = Get-AzTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints +Remove-AzTrafficManagerCustomHeaderFromEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint -Name "host" +Set-AzTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint +``` + +The first command gets the Azure endpoint named contoso from the profile named ContosoProfile in the resource group named ResourceGroup11, and then stores that object in the $TrafficManagerEndpoint variable. +The second command removes custom header information from the endpoint stored in $TrafficManagerEndpoint. +The final command updates the endpoint in Traffic Manager to match the local value in $TrafficManagerEndpoint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the custom header information to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerEndpoint +Specifies a local **TrafficManagerEndpoint** object. +This cmdlet modifies this local object. +To obtain a **TrafficManagerEndpoint** object, use the Get-AzTrafficManagerEndpoint or New-AzTrafficManagerEndpoint cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## NOTES + +## RELATED LINKS + +[Add-AzTrafficManagerCustomHeaderToEndpoint](./Add-AzTrafficManagerCustomHeaderToEndpoint.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerEndpoint.md) + +[New-AzTrafficManagerEndpoint](./New-AzTrafficManagerEndpoint.md) + +[Set-AzTrafficManagerEndpoint](./Set-AzTrafficManagerEndpoint.md) diff --git a/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerCustomHeaderFromProfile.md b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerCustomHeaderFromProfile.md new file mode 100644 index 0000000000..8bf6e7a653 --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerCustomHeaderFromProfile.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D343 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/remove-aztrafficmanagercustomheaderfromprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerCustomHeaderFromProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerCustomHeaderFromProfile.md +--- + +# Remove-AzTrafficManagerCustomHeaderFromProfile + +## SYNOPSIS +Removes custom header information from a local Traffic Manager profile object. + +## SYNTAX + +``` +Remove-AzTrafficManagerCustomHeaderFromProfile -Name <String> -TrafficManagerProfile <TrafficManagerProfile> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzTrafficManagerCustomHeaderFromProfile** cmdlet removes custom header information from a local Azure Traffic Manager profile object. +You can get a profile by using the New-AzTrafficManagerProfile or Get-AzTrafficManagerProfile cmdlets. + +This cmdlet operates on the local profile object. +Commit your changes to the profile for Traffic Manager by using the Set-AzTrafficManagerProfile cmdlet. + +## EXAMPLES + +### Example 1: Remove custom header information from a profile +```powershell +$TrafficManagerProfile = Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" +Remove-AzTrafficManagerCustomHeaderFromProfile -TrafficManagerProfile $TrafficManagerProfile -Name "host" +Set-AzTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile +``` + +The first command gets an Azure Traffic Manager profile by using the **Get-AzTrafficManagerProfile** cmdlet. +The second command removes custom header information from the profile stored in $TrafficManagerProfile. +The final command updates the profile in Traffic Manager to match the local value in $TrafficManagerProfile. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the custom header information to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerProfile +Specifies a local **TrafficManagerProfile** object. +This cmdlet modifies this local object. +To obtain a **TrafficManagerProfile** object, use the Get-AzTrafficManagerProfile cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## NOTES + +## RELATED LINKS + +[Add-AzTrafficManagerCustomHeaderToProfile](./Add-AzTrafficManagerCustomHeaderToProfile.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) diff --git a/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerEndpoint.md b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerEndpoint.md new file mode 100644 index 0000000000..0b32ea1b8c --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerEndpoint.md @@ -0,0 +1,221 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 2129C457-592B-484C-A148-828BFD5895D4 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/remove-aztrafficmanagerendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerEndpoint.md +--- + +# Remove-AzTrafficManagerEndpoint + +## SYNOPSIS +Removes an endpoint from Traffic Manager. + +## SYNTAX + +### Fields +``` +Remove-AzTrafficManagerEndpoint -Name <String> -Type <String> -ProfileName <String> -ResourceGroupName <String> + [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Object +``` +Remove-AzTrafficManagerEndpoint -TrafficManagerEndpoint <TrafficManagerEndpoint> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzTrafficManagerEndpoint** cmdlet removes an endpoint from Azure Traffic Manager. + +This cmdlet commits each change to the Traffic Manager service. +To remove multiple endpoints from a local Traffic Manager profile object and commit changes in a single operation, use the Remove-AzTrafficManagerEndpointConfig cmdlet. + +You can use the pipeline operator to pass a **TrafficManagerEndpoint** object to this cmdlet, or you can specify a **TrafficManagerEndpoint** object by using the *TrafficManagerEndpoint* parameter. + +Alternatively, you can specify the endpoint name and type by using the *Name* and *Type* parameters, together with the *ProfileName* and *ResourceGroupName* parameters. + +## EXAMPLES + +### Example 1: Remove an endpoint from a profile +```powershell +Remove-AzTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints +``` + +This command removes the Azure endpoint named contoso from the profile named ContosoProfile in the resource group named ResourceGroup11. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Traffic Manager endpoint that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileName +Specifies the name of a Traffic Manager profile from which this cmdlet removes an endpoint. +To obtain a profile, use the Get-AzTrafficManagerProfile cmdlet. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet removes a Traffic Manager endpoint from a Traffic Manager profile in the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerEndpoint +Specifies the Traffic Manager endpoint that this cmdlet removes. +To obtain a **TrafficManagerEndpoint** object, use the Get-AzTrafficManagerEndpoint cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Type +Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. +Valid values are: + +- AzureEndpoints +- ExternalEndpoints +- NestedEndpoints + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: +Accepted values: AzureEndpoints, ExternalEndpoints, NestedEndpoints + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-AzTrafficManagerEndpoint](./Get-AzTrafficManagerEndpoint.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[New-AzTrafficManagerEndpoint](./New-AzTrafficManagerEndpoint.md) + +[Remove-AzTrafficManagerEndpointConfig](./Remove-AzTrafficManagerEndpointConfig.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) + + diff --git a/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerEndpointConfig.md b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerEndpointConfig.md new file mode 100644 index 0000000000..bfe92a7346 --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerEndpointConfig.md @@ -0,0 +1,120 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 8E12A392-A100-4814-9003-B2999150DCE1 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/remove-aztrafficmanagerendpointconfig +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerEndpointConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerEndpointConfig.md +--- + +# Remove-AzTrafficManagerEndpointConfig + +## SYNOPSIS +Removes an endpoint from a local Traffic Manager profile object. + +## SYNTAX + +``` +Remove-AzTrafficManagerEndpointConfig -EndpointName <String> -TrafficManagerProfile <TrafficManagerProfile> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzTrafficManagerEndpointConfig** cmdlet removes an endpoint from a local Azure Traffic Manager profile object. +You can get a profile by using the Get-AzTrafficManagerProfile cmdlet. + +This cmdlet operates on the local profile object. +Commit your changes to the profile for Traffic Manager by using the Set-AzTrafficManagerProfile cmdlet. +To remove an endpoint and commit changes in a single operation, use the Remove-AzTrafficManagerEndpoint cmdlet. + +## EXAMPLES + +### Example 1: Remove an endpoint +```powershell +$TrafficManagerProfile = Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" +Remove-AzTrafficManagerEndpointConfig -EndpointName "contoso" -TrafficManagerProfile $TrafficManagerProfile +Set-AzTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile +``` + +The first command gets an Azure Traffic Manager profile by using the **Get-AzTrafficManagerProfile** cmdlet. +The command stores the local profile in the $TrafficManagerProfile variable. + +The second command removes an Azure endpoint named contoso from the profile stored in $TrafficManagerProfile. +This command changes only the local object. + +The final command updates the Traffic Manager profile named ContosoProfile to match the local value in $TrafficManagerProfile. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +Specifies the name of the Traffic Manager endpoint that this cmdlet removes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerProfile +Specifies a local **TrafficManagerProfile** object. +This cmdlet modifies this local object. +To obtain a **TrafficManagerProfile** object, use the Get-AzTrafficManagerProfile cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## NOTES + +## RELATED LINKS + +[Add-AzTrafficManagerEndpointConfig](./Add-AzTrafficManagerEndpointConfig.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[Remove-AzTrafficManagerEndpoint](./Remove-AzTrafficManagerEndpoint.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) + + diff --git a/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerExpectedStatusCodeRange.md b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerExpectedStatusCodeRange.md new file mode 100644 index 0000000000..d4f650be1c --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerExpectedStatusCodeRange.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D344 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/remove-aztrafficmanagerexpectedstatuscoderange +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerExpectedStatusCodeRange.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerExpectedStatusCodeRange.md +--- + +# Remove-AzTrafficManagerExpectedStatusCodeRange + +## SYNOPSIS +Removes an expected status code range from a local Traffic Manager profile object. + +## SYNTAX + +``` +Remove-AzTrafficManagerExpectedStatusCodeRange -Min <Int32> -TrafficManagerProfile <TrafficManagerProfile> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzTrafficManagerExpectedStatusCodeRange** cmdlet removes a range of expected status codes from a local Azure Traffic Manager profile object. +You can get a profile by using the New-AzTrafficManagerProfile or Get-AzTrafficManagerProfile cmdlets. + +This cmdlet operates on the local profile object. +Commit your changes to the profile for Traffic Manager by using the Set-AzTrafficManagerProfile cmdlet. + +## EXAMPLES + +### Example 1: Remove an expected status code range from a profile +```powershell +$TrafficManagerProfile = Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" +Remove-AzTrafficManagerExpectedStatusCodeRange -TrafficManagerProfile $TrafficManagerProfile -Min 200 +Set-AzTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile +``` + +The first command gets an Azure Traffic Manager profile by using the **Get-AzTrafficManagerProfile** cmdlet. +The second command removes an expected status code range from the profile stored in $TrafficManagerProfile. +The final command updates the profile in Traffic Manager to match the local value in $TrafficManagerProfile. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Min +Specifies the lowest value in the status code range to be removed. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerProfile +Specifies a local **TrafficManagerProfile** object. +This cmdlet modifies this local object. +To obtain a **TrafficManagerProfile** object, use the Get-AzTrafficManagerProfile cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## NOTES + +## RELATED LINKS + +[Add-AzTrafficManagerExpectedStatusCodeRange](./Add-AzTrafficManagerExpectedStatusCodeRange.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) diff --git a/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerIpAddressRange.md b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerIpAddressRange.md new file mode 100644 index 0000000000..1a6f6a8d64 --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerIpAddressRange.md @@ -0,0 +1,143 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D345 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/remove-aztrafficmanagerIpAddressRange +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerIpAddressRange.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerIpAddressRange.md +--- + +# Remove-AzTrafficManagerIpAddressRange + +## SYNOPSIS +Removes an address range or subnet from a local Traffic Manager endpoint object. + +## SYNTAX + +``` +Remove-AzTrafficManagerIpAddressRange -First <String> -TrafficManagerEndpoint <TrafficManagerEndpoint> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzTrafficManagerIpAddressRange** cmdlet removes an IP address range from a local Azure Traffic Manager endpoint object. +You can get an endpoint by using the New-AzTrafficManagerEndpoint or Get-AzTrafficManagerEndpoint cmdlets. + +This cmdlet operates on the local endpoint object. +Commit your changes to the endpoint for Traffic Manager by using the Set-AzTrafficManagerEndpoint cmdlet. + +## EXAMPLES + +### Example 1: Remove IP address ranges from an endpoint +```powershell +$TrafficManagerEndpoint = Get-AzTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints +Remove-AzTrafficManagerIpAddressRange -TrafficManagerEndpoint $TrafficManagerEndpoint -First "1.2.3.4" +Set-AzTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint +``` + +The first command gets the Azure endpoint named contoso from the profile named ContosoProfile in the resource group named ResourceGroup11, and then stores that object in the $TrafficManagerEndpoint variable. +The second command removes an IP address range from the endpoint stored in $TrafficManagerEndpoint. +The final command updates the endpoint in Traffic Manager to match the local value in $TrafficManagerEndpoint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerEndpoint +Specifies a local **TrafficManagerEndpoint** object. +This cmdlet modifies this local object. +To obtain a **TrafficManagerEndpoint** object, use the Get-AzTrafficManagerEndpoint or New-AzTrafficManagerEndpoint cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +Specifies the first IP address in the range to be removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## NOTES + +## RELATED LINKS + +[Add-AzTrafficManagerIpAddressRange](./Add-AzTrafficManagerIpAddressRange.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerEndpoint.md) + +[New-AzTrafficManagerEndpoint](./New-AzTrafficManagerEndpoint.md) + +[Set-AzTrafficManagerEndpoint](./Set-AzTrafficManagerEndpoint.md) diff --git a/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerProfile.md b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerProfile.md new file mode 100644 index 0000000000..58166bc0ce --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Remove-AzTrafficManagerProfile.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 5A4D685F-B904-4C85-8B68-C9936B0627FA +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/remove-aztrafficmanagerprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Remove-AzTrafficManagerProfile.md +--- + +# Remove-AzTrafficManagerProfile + +## SYNOPSIS +Deletes a Traffic Manager profile. + +## SYNTAX + +### Fields +``` +Remove-AzTrafficManagerProfile -Name <String> -ResourceGroupName <String> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### Object +``` +Remove-AzTrafficManagerProfile -TrafficManagerProfile <TrafficManagerProfile> [-Force] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzTrafficManagerProfile** cmdlet deletes an Azure Traffic Manager profile. +Specify the profile to delete by using the *Name* and *ResourceGroupName* parameters. +Alternatively, you can specify a **TrafficManagerProfile** object using the *TrafficManagerProfile* parameter, or you can use the pipeline. + +## EXAMPLES + +### Example 1: Delete a profile specified by name +```powershell +Remove-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" +``` + +This command deletes the profile named ContosoProfile in ResourceGroup11. +The command prompts you for confirmation. + +### Example 2: Delete a profile by using the pipeline +```powershell +Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Remove-AzTrafficManagerProfile -Force +``` + +This command gets the profile named ContosoProfile in ResourceGroup11. +The command then passes that profile to the **Remove-AzTrafficManagerProfile** cmdlet by using the pipeline operator. +That cmdlet deletes that profile. +The command specifies the *Force* parameter. +Therefore, it does not prompt you for confirmation. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Traffic Manager profile that this cmdlet deletes. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of a resource group. +This cmdlet deletes a Traffic Manager profile in the group that this parameter specifies. + +```yaml +Type: System.String +Parameter Sets: Fields +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerProfile +Specifies a **TrafficManagerProfile** object to delete. +To obtain a **TrafficManagerProfile** object, use the Get-AzTrafficManagerProfile cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile +Parameter Sets: Object +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Disable-AzTrafficManagerProfile](./Disable-AzTrafficManagerProfile.md) + +[Enable-AzTrafficManagerProfile](./Enable-AzTrafficManagerProfile.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[New-AzTrafficManagerProfile](./New-AzTrafficManagerProfile.md) + +[Set-AzTrafficManagerProfile](./Set-AzTrafficManagerProfile.md) + + diff --git a/azps-10.1.0/Az.TrafficManager/Set-AzTrafficManagerEndpoint.md b/azps-10.1.0/Az.TrafficManager/Set-AzTrafficManagerEndpoint.md new file mode 100644 index 0000000000..029af3608c --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Set-AzTrafficManagerEndpoint.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 5287D4DB-2709-4A3C-97D5-DB494CEEFD18 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/set-aztrafficmanagerendpoint +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Set-AzTrafficManagerEndpoint.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Set-AzTrafficManagerEndpoint.md +--- + +# Set-AzTrafficManagerEndpoint + +## SYNOPSIS +Updates a Traffic Manager endpoint. + +## SYNTAX + +``` +Set-AzTrafficManagerEndpoint -TrafficManagerEndpoint <TrafficManagerEndpoint> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzTrafficManagerEndpoint** cmdlet updates an endpoint in Azure Traffic Manager. +This cmdlet updates the settings from a local endpoint object. +You can specify the endpoint object either by using the *TrafficManagerEndpoint* parameter or by using the pipeline. + +You can obtain a local object that represents an endpoint by using the Get-AzTrafficManagerEndpoint cmdlet. +Modify the object locally and then use **Set-AzTrafficManagerEndpoint** to commit your changes. + +## EXAMPLES + +### Example 1: Update an endpoint +```powershell +$TrafficManagerEndpoint = Get-AzTrafficManagerEndpoint -Name "endpoint1" -Type AzureEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" +$TrafficManagerEndpoint.Weight = 20 +Set-AzTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint +``` + +The first command gets an Azure Traffic Manager endpoint by using the **Get-AzTrafficManagerEndpoint** cmdlet. +The command stores the endpoint locally in the $TrafficManagerEndpoint variable. + +The second command changes that endpoint locally. +This command changes the endpoint weight to 20. + +The third command updates the endpoint in Traffic Manager to match the local value in $TrafficManagerEndpoint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerEndpoint +Specifies a local **TrafficManagerEndpoint** object. +This cmdlet updates Traffic Manager to match this local object. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.TrafficManager/Set-AzTrafficManagerProfile.md b/azps-10.1.0/Az.TrafficManager/Set-AzTrafficManagerProfile.md new file mode 100644 index 0000000000..460880c4e6 --- /dev/null +++ b/azps-10.1.0/Az.TrafficManager/Set-AzTrafficManagerProfile.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml +Module Name: Az.TrafficManager +ms.assetid: 975DD42E-61B6-437B-884D-C15A8DB7A667 +online version: https://learn.microsoft.com/powershell/module/az.trafficmanager/set-aztrafficmanagerprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Set-AzTrafficManagerProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/TrafficManager/TrafficManager/help/Set-AzTrafficManagerProfile.md +--- + +# Set-AzTrafficManagerProfile + +## SYNOPSIS +Updates a Traffic Manager profile. + +## SYNTAX + +``` +Set-AzTrafficManagerProfile -TrafficManagerProfile <TrafficManagerProfile> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzTrafficManagerProfile** cmdlet updates an Azure Traffic Manager profile. +This cmdlet updates the settings of the profile from a local profile object. +You can specify the profile object either by using the *TrafficManagerProfile* parameter or by using the pipeline. + +You can obtain a local object that represents a profile by using the Get-AzTrafficManagerProfile cmdlet. +Modify the object locally and then use **Set-AzTrafficManagerProfile** to commit your changes. + +## EXAMPLES + +### Example 1: Update a profile +```powershell +$TrafficManagerProfile = Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" +$TrafficManagerProfile.ProfileStatus = "Disabled" +Set-AzTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile +``` + +The first command gets an Azure Traffic Manager profile by using the Get-AzTrafficManagerProfile cmdlet. +The command stores the profile locally in the $TrafficManagerProfile variable. + +The second command changes that profile locally. +This command disables the profile. + +The third command updates the Traffic Manager profile named ContosoProfile to match the local value in $TrafficManagerProfile. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerProfile +Specifies a local **TrafficManagerProfile** object. +This cmdlet updates Traffic Manager to match this local object. + +```yaml +Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## OUTPUTS + +### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile + +## NOTES + +## RELATED LINKS + +[Add-AzTrafficManagerEndpointConfig](./Add-AzTrafficManagerEndpointConfig.md) + +[Get-AzTrafficManagerProfile](./Get-AzTrafficManagerProfile.md) + +[New-AzTrafficManagerProfile](./New-AzTrafficManagerProfile.md) + +[Remove-AzTrafficManagerEndpointConfig](./Remove-AzTrafficManagerEndpointConfig.md) + +[Remove-AzTrafficManagerProfile](./Remove-AzTrafficManagerProfile.md) + + diff --git a/azps-10.1.0/Az.VMware/Az.VMware.md b/azps-10.1.0/Az.VMware/Az.VMware.md new file mode 100644 index 0000000000..68acb63a32 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Az.VMware.md @@ -0,0 +1,135 @@ +--- +Module Name: Az.VMware +Module Guid: 78d2fac8-ec90-47ad-b8aa-a27106b158f5 +Download Help Link: https://learn.microsoft.com/powershell/module/az.vmware +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Az.VMware.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Az.VMware.md +--- + +# Az.VMware Module +## Description +Microsoft Azure PowerShell: Azure VMware Solution cmdlets + +## Az.VMware Cmdlets +### [Get-AzVMwareAddon](Get-AzVMwareAddon.md) +Get an addon by name in a private cloud + +### [Get-AzVMwareAuthorization](Get-AzVMwareAuthorization.md) +Get an ExpressRoute Circuit Authorization by name in a private cloud + +### [Get-AzVMwareCloudLink](Get-AzVMwareCloudLink.md) +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-AzVMwareDatastore](Get-AzVMwareDatastore.md) +Get a datastore in a private cloud cluster + +### [Get-AzVMwareGlobalReachConnection](Get-AzVMwareGlobalReachConnection.md) +Get a global reach connection by name in a private cloud + +### [Get-AzVMwarePlacementPolicy](Get-AzVMwarePlacementPolicy.md) +Get a placement policy by name in a private cloud cluster + +### [Get-AzVMwarePrivateCloud](Get-AzVMwarePrivateCloud.md) +Get a private cloud + +### [Get-AzVMwarePrivateCloudAdminCredential](Get-AzVMwarePrivateCloudAdminCredential.md) +List the admin credentials for the private cloud + +### [Get-AzVMwareVirtualMachine](Get-AzVMwareVirtualMachine.md) +Get a virtual machine by id in a private cloud cluster + +### [New-AzVMwareAddon](New-AzVMwareAddon.md) +Create or update a addon in a private cloud + +### [New-AzVMwareAddonSrmPropertiesObject](New-AzVMwareAddonSrmPropertiesObject.md) +Create a in-memory object for AddonSrmProperties + +### [New-AzVMwareAddonVrPropertiesObject](New-AzVMwareAddonVrPropertiesObject.md) +Create a in-memory object for AddonVrProperties + +### [New-AzVMwareAuthorization](New-AzVMwareAuthorization.md) +Create or update an ExpressRoute Circuit Authorization in a private cloud + +### [New-AzVMwareCloudLink](New-AzVMwareCloudLink.md) +Create or update a cloud link in a private cloud + +### [New-AzVMwareCluster](New-AzVMwareCluster.md) +Create or update a cluster in a private cloud + +### [New-AzVMwareDatastore](New-AzVMwareDatastore.md) +Create or update a datastore in a private cloud cluster + +### [New-AzVMwareGlobalReachConnection](New-AzVMwareGlobalReachConnection.md) +Create or update a global reach connection in a private cloud + +### [New-AzVMwarePlacementPolicy](New-AzVMwarePlacementPolicy.md) +Create or update a placement policy in a private cloud cluster + +### [New-AzVMwarePrivateCloud](New-AzVMwarePrivateCloud.md) +Create or update a private cloud + +### [New-AzVMwarePrivateCloudNsxtPassword](New-AzVMwarePrivateCloudNsxtPassword.md) +Rotate the NSX-T Manager password + +### [New-AzVMwarePrivateCloudVcenterPassword](New-AzVMwarePrivateCloudVcenterPassword.md) +Rotate the vCenter password + +### [New-AzVMwarePSCredentialExecutionParameterObject](New-AzVMwarePSCredentialExecutionParameterObject.md) +Create a in-memory object for PSCredentialExecutionParameter + +### [New-AzVMwareScriptSecureStringExecutionParameterObject](New-AzVMwareScriptSecureStringExecutionParameterObject.md) +Create a in-memory object for ScriptSecureStringExecutionParameter + +### [New-AzVMwareScriptStringExecutionParameterObject](New-AzVMwareScriptStringExecutionParameterObject.md) +Create a in-memory object for ScriptStringExecutionParameter + +### [New-AzVMwareVmHostPlacementPolicyPropertiesObject](New-AzVMwareVmHostPlacementPolicyPropertiesObject.md) +Create an in-memory object for VmHostPlacementPolicyProperties. + +### [New-AzVMwareVMPlacementPolicyPropertiesObject](New-AzVMwareVMPlacementPolicyPropertiesObject.md) +Create an in-memory object for VMPlacementPolicyProperties. + +### [Remove-AzVMwareAddon](Remove-AzVMwareAddon.md) +Delete a addon in a private cloud + +### [Remove-AzVMwareAuthorization](Remove-AzVMwareAuthorization.md) +Delete an ExpressRoute Circuit Authorization in a private cloud + +### [Remove-AzVMwareCloudLink](Remove-AzVMwareCloudLink.md) +Delete a cloud link in a private cloud + +### [Remove-AzVMwareCluster](Remove-AzVMwareCluster.md) +Delete a cluster in a private cloud + +### [Remove-AzVMwareDatastore](Remove-AzVMwareDatastore.md) +Delete a datastore in a private cloud cluster + +### [Remove-AzVMwareGlobalReachConnection](Remove-AzVMwareGlobalReachConnection.md) +Delete a global reach connection in a private cloud + +### [Remove-AzVMwarePlacementPolicy](Remove-AzVMwarePlacementPolicy.md) +Delete a placement policy in a private cloud cluster + +### [Remove-AzVMwarePrivateCloud](Remove-AzVMwarePrivateCloud.md) +Delete a private cloud + +### [Test-AzVMwareLocationQuotaAvailability](Test-AzVMwareLocationQuotaAvailability.md) +Return quota for subscription by region + +### [Test-AzVMwareLocationTrialAvailability](Test-AzVMwareLocationTrialAvailability.md) +Return trial status for subscription by region + +### [Update-AzVMwareCluster](Update-AzVMwareCluster.md) +Update a cluster 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 + diff --git a/azps-10.1.0/Az.VMware/Get-AzVMwareAddon.md b/azps-10.1.0/Az.VMware/Get-AzVMwareAddon.md new file mode 100644 index 0000000000..d497982250 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Get-AzVMwareAddon.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/get-azvmwareaddon +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareAddon.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareAddon.md +--- + +# Get-AzVMwareAddon + +## SYNOPSIS +Get an addon by name in a private cloud + +## SYNTAX + +### List (Default) +``` +Get-AzVMwareAddon -PrivateCloudName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzVMwareAddon -AddonType <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzVMwareAddon -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get an addon by name in a private cloud + +## EXAMPLES + +### Example 1: List addon under resource group +```powershell +Get-AzVMwareAddon -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +srm Microsoft.AVS/privateClouds/addons azps_test_group +vr Microsoft.AVS/privateClouds/addons azps_test_group +``` + +List addon under resource group + +### Example 2: Get an addon by name in a private cloud +```powershell +Get-AzVMwareAddon -AddonType vr -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +vr Microsoft.AVS/privateClouds/addons azps_test_group +``` + +Get an addon by name in a private cloud + +## PARAMETERS + +### -AddonType +Name of the addon for the private cloud + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AddonName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Get-AzVMwareAuthorization.md b/azps-10.1.0/Az.VMware/Get-AzVMwareAuthorization.md new file mode 100644 index 0000000000..af204cd318 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Get-AzVMwareAuthorization.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/get-azvmwareauthorization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareAuthorization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareAuthorization.md +--- + +# Get-AzVMwareAuthorization + +## SYNOPSIS +Get an ExpressRoute Circuit Authorization by name in a private cloud + +## SYNTAX + +### List (Default) +``` +Get-AzVMwareAuthorization -PrivateCloudName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzVMwareAuthorization -Name <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzVMwareAuthorization -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get an ExpressRoute Circuit Authorization by name in a private cloud + +## EXAMPLES + +### Example 1: List authorization under resource group +```powershell +Get-AzVMwareAuthorization -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_authorization Microsoft.AVS/privateClouds/authorizations azps_test_group +``` + +List authorization under resource group + +### Example 2: Get authorization by name in a private cloud +```powershell +Get-AzVMwareAuthorization -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -Name azps_test_authorization +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_authorization Microsoft.AVS/privateClouds/authorizations azps_test_group +``` + +Get authorization by name in a private cloud + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the ExpressRoute Circuit Authorization in the private cloud + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AuthorizationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Get-AzVMwareCloudLink.md b/azps-10.1.0/Az.VMware/Get-AzVMwareCloudLink.md new file mode 100644 index 0000000000..4dc1f0b80e --- /dev/null +++ b/azps-10.1.0/Az.VMware/Get-AzVMwareCloudLink.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/get-azvmwarecloudlink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareCloudLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareCloudLink.md +--- + +# Get-AzVMwareCloudLink + +## SYNOPSIS +Get an cloud link by name in a private cloud + +## SYNTAX + +### List (Default) +``` +Get-AzVMwareCloudLink -PrivateCloudName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzVMwareCloudLink -Name <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzVMwareCloudLink -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get an cloud link by name in a private cloud + +## EXAMPLES + +### Example 1: List cloud link under resource group +```powershell +Get-AzVMwareCloudLink -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_cloudlink Microsoft.AVS/privateClouds/cloudLinks azps_test_group +``` + +List cloud link under resource group + +### Example 2: Get cloud link by name in a private cloud +```powershell +Get-AzVMwareCloudLink -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -Name azps_test_cloudlink +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_cloudlink Microsoft.AVS/privateClouds/cloudLinks azps_test_group +``` + +Get cloud link by name in a private cloud + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the cloud link resource + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CloudLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Get-AzVMwareCluster.md b/azps-10.1.0/Az.VMware/Get-AzVMwareCluster.md new file mode 100644 index 0000000000..d1d903dc78 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Get-AzVMwareCluster.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/get-azvmwarecluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareCluster.md +--- + +# Get-AzVMwareCluster + +## SYNOPSIS +Get a cluster by name in a private cloud + +## SYNTAX + +### List (Default) +``` +Get-AzVMwareCluster -PrivateCloudName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzVMwareCluster -Name <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzVMwareCluster -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a cluster by name in a private cloud + +## EXAMPLES + +### Example 1: List clusters under resource group +```powershell +Get-AzVMwareCluster -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_cluster Microsoft.AVS/privateClouds/clusters azps_test_group +``` + +List clusters under resource group + +### Example 2: Get cluster by name in a private cloud +```powershell +Get-AzVMwareCluster -Name azps_test_cluster -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_cluster Microsoft.AVS/privateClouds/clusters azps_test_group +``` + +Get cluster by name in a private cloud + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the cluster in the private cloud + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Get-AzVMwareDatastore.md b/azps-10.1.0/Az.VMware/Get-AzVMwareDatastore.md new file mode 100644 index 0000000000..0d8ddbbe00 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Get-AzVMwareDatastore.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/get-azvmwaredatastore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareDatastore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareDatastore.md +--- + +# Get-AzVMwareDatastore + +## SYNOPSIS +Get a datastore in a private cloud cluster + +## SYNTAX + +### List (Default) +``` +Get-AzVMwareDatastore -ClusterName <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzVMwareDatastore -ClusterName <String> -Name <String> -PrivateCloudName <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzVMwareDatastore -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a datastore in a private cloud cluster + +## EXAMPLES + +### Example 1: List datastores in a private cloud cluster. +```powershell +Get-AzVMwareDatastore -ClusterName azps_test_cluster -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group +``` + +```output +Name Status ProvisioningState ResourceGroupName +---- ------ ----------------- ----------------- +azps_test_datastore Accessible Succeeded azps_test_group +azps_test_datastore1 Accessible Succeeded azps_test_group +``` + +List datastores in a private cloud cluster. + +### Example 2: Get a datastore in a data store name. +```powershell +Get-AzVMwareDatastore -ClusterName azps_test_cluster -Name azps_test_datastore -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group +``` + +```output +Name Status ProvisioningState ResourceGroupName +---- ------ ----------------- ----------------- +azps_test_datastore Accessible Succeeded azps_test_group +``` + +Get a datastore in a data store name. + +## PARAMETERS + +### -ClusterName +Name of the cluster in the private cloud + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the datastore in the private cloud cluster + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: DatastoreName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Get-AzVMwareGlobalReachConnection.md b/azps-10.1.0/Az.VMware/Get-AzVMwareGlobalReachConnection.md new file mode 100644 index 0000000000..ca1b077f3f --- /dev/null +++ b/azps-10.1.0/Az.VMware/Get-AzVMwareGlobalReachConnection.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/get-azvmwareglobalreachconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareGlobalReachConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareGlobalReachConnection.md +--- + +# Get-AzVMwareGlobalReachConnection + +## SYNOPSIS +Get a global reach connection by name in a private cloud + +## SYNTAX + +### List (Default) +``` +Get-AzVMwareGlobalReachConnection -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzVMwareGlobalReachConnection -Name <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzVMwareGlobalReachConnection -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a global reach connection by name in a private cloud + +## EXAMPLES + +### Example 1: List global reach connection in a private cloud +```powershell +Get-AzVMwareGlobalReachConnection -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_grc Microsoft.AVS/privateClouds/globalReachConnections azps_test_group +``` + +List global reach connection in a private cloud + +### Example 2: Get a global reach connection by name in a private cloud +```powershell +Get-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 +``` + +Get a global reach connection by name in a private cloud + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the global reach connection in the private cloud + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: GlobalReachConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Get-AzVMwarePlacementPolicy.md b/azps-10.1.0/Az.VMware/Get-AzVMwarePlacementPolicy.md new file mode 100644 index 0000000000..79acf26db3 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Get-AzVMwarePlacementPolicy.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/get-azvmwareplacementpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwarePlacementPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwarePlacementPolicy.md +--- + +# Get-AzVMwarePlacementPolicy + +## SYNOPSIS +Get a placement policy by name in a private cloud cluster + +## SYNTAX + +### List (Default) +``` +Get-AzVMwarePlacementPolicy -ClusterName <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzVMwarePlacementPolicy -ClusterName <String> -Name <String> -PrivateCloudName <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzVMwarePlacementPolicy -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a placement policy by name in a private cloud cluster + +## EXAMPLES + +### Example 1: List placement policy by private cloud cluster +```powershell +Get-AzVMwarePlacementPolicy -ClusterName cluster1 -PrivateCloudName cloud1 -ResourceGroupName group1 +``` + +```output +Name ResourceGroupName +---- ----------------- +policy1 group1 +policy2 group1 +``` + +List placement policy by private cloud cluster + +### Example 2: Get a placement policy by name in a private cloud cluster +```powershell +Get-AzVMwarePlacementPolicy -ClusterName cluster1 -Name policy1 -PrivateCloudName cloud1 -ResourceGroupName group1 +``` + +```output +Name ResourceGroupName +---- ----------------- +policy1 group1 +``` + +Get a placement policy by name in a private cloud cluster + +## PARAMETERS + +### -ClusterName +Name of the cluster in the private cloud + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PlacementPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Get-AzVMwarePrivateCloud.md b/azps-10.1.0/Az.VMware/Get-AzVMwarePrivateCloud.md new file mode 100644 index 0000000000..230a8073c0 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Get-AzVMwarePrivateCloud.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/get-azvmwareprivatecloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwarePrivateCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwarePrivateCloud.md +--- + +# Get-AzVMwarePrivateCloud + +## SYNOPSIS +Get a private cloud + +## SYNTAX + +### List1 (Default) +``` +Get-AzVMwarePrivateCloud [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzVMwarePrivateCloud -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzVMwarePrivateCloud -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List +``` +Get-AzVMwarePrivateCloud -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a private cloud + +## EXAMPLES + +### Example 1: List private cloud under subscription +```powershell +Get-AzVMwarePrivateCloud +``` + +```output +Location Name Type +-------- ---- ---- +australiaeast azps_test_cloud Microsoft.AVS/privateClouds +``` + +List private cloud under subscription + +### Example 2: List private cloud under resource group +```powershell +Get-AzVMwarePrivateCloud -ResourceGroupName azps_test_group +``` + +```output +Location Name Type ResourceGroupName +-------- ---- ---- ----------------- +australiaeast azps_test_cloud Microsoft.AVS/privateClouds azps_test_group +``` + +List private cloud under resource group + +### Example 3: Get a private cloud by name +```powershell +Get-AzVMwarePrivateCloud -ResourceGroupName azps_test_group -Name azps_test_cloud +``` + +```output +Location Name Type ResourceGroupName +-------- ---- ---- ----------------- +australiaeast azps_test_cloud Microsoft.AVS/privateClouds azps_test_group +``` + +Get a private cloud by name + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: PrivateCloudName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Get-AzVMwarePrivateCloudAdminCredential.md b/azps-10.1.0/Az.VMware/Get-AzVMwarePrivateCloudAdminCredential.md new file mode 100644 index 0000000000..5297f932b1 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Get-AzVMwarePrivateCloudAdminCredential.md @@ -0,0 +1,148 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/get-azvmwareprivatecloudadmincredential +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwarePrivateCloudAdminCredential.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwarePrivateCloudAdminCredential.md +--- + +# Get-AzVMwarePrivateCloudAdminCredential + +## SYNOPSIS +List the admin credentials for the private cloud + +## SYNTAX + +``` +Get-AzVMwarePrivateCloudAdminCredential -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +List the admin credentials for the private cloud + +## EXAMPLES + +### Example 1: Get the admin credentials for the private cloud +```powershell +Get-AzVMwarePrivateCloudAdminCredential -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group +``` + +```output +NsxtUsername VcenterUsername +------------ --------------- +admin cloudadmin@vsphere.local +``` + +Get the admin credentials for the private cloud + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IAdminCredentials + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Get-AzVMwareVirtualMachine.md b/azps-10.1.0/Az.VMware/Get-AzVMwareVirtualMachine.md new file mode 100644 index 0000000000..ba2bf76d23 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Get-AzVMwareVirtualMachine.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/get-azvmwarevirtualmachine +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareVirtualMachine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Get-AzVMwareVirtualMachine.md +--- + +# Get-AzVMwareVirtualMachine + +## SYNOPSIS +Get a virtual machine by id in a private cloud cluster + +## SYNTAX + +### List (Default) +``` +Get-AzVMwareVirtualMachine -ClusterName <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzVMwareVirtualMachine -ClusterName <String> -Id <String> -PrivateCloudName <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzVMwareVirtualMachine -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a virtual machine by id in a private cloud cluster + +## EXAMPLES + +### Example 1: List virtual machine in a private cloud cluster +```powershell +Get-AzVMwareVirtualMachine -ClusterName cluster1 -PrivateCloudName cloud1 -ResourceGroupName group1 +``` + +```output +Name ResourceGroupName +---- ----------------- +vm-209 group1 +vm-128 group1 +``` + +List virtual machine in a private cloud cluster + +### Example 2: Get a virtual machine by id in a private cloud cluster +```powershell +Get-AzVMwareVirtualMachine -Id vm-209 -ClusterName cluster1 -PrivateCloudName cloud1 -ResourceGroupName group1 +``` + +```output +Name ResourceGroupName +---- ----------------- +vm-209 group1 +``` + +Get a virtual machine by id in a private cloud cluster + +## PARAMETERS + +### -ClusterName +Name of the cluster in the private cloud + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Virtual Machine identifier + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: VirtualMachineId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwareAddon.md b/azps-10.1.0/Az.VMware/New-AzVMwareAddon.md new file mode 100644 index 0000000000..63b0f16e22 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwareAddon.md @@ -0,0 +1,204 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/new-azvmwareaddon +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareAddon.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareAddon.md +--- + +# New-AzVMwareAddon + +## SYNOPSIS +Create or update a addon in a private cloud + +## SYNTAX + +``` +New-AzVMwareAddon -PrivateCloudName <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Property <IAddonProperties>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a addon in a private cloud + +## EXAMPLES + +### Example 1: Create an addon in a private cloud +```powershell +$data = New-AzVMwareAddonVrPropertiesObject -VrsCount 2 +New-AzVMwareAddon -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -Property $data +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +vr Microsoft.AVS/privateClouds/addons azps_test_group +``` + +Create an addon in a private cloud + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +The name of the private cloud. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IAddonProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IAddonProperties>`: The properties of an addon resource + - `AddonType <AddonType>`: The type of private cloud addon + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwareAddonSrmPropertiesObject.md b/azps-10.1.0/Az.VMware/New-AzVMwareAddonSrmPropertiesObject.md new file mode 100644 index 0000000000..6793870b33 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwareAddonSrmPropertiesObject.md @@ -0,0 +1,70 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.VMware/new-AzVMwareAddonSrmPropertiesObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareAddonSrmPropertiesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareAddonSrmPropertiesObject.md +--- + +# New-AzVMwareAddonSrmPropertiesObject + +## SYNOPSIS +Create a in-memory object for AddonSrmProperties + +## SYNTAX + +``` +New-AzVMwareAddonSrmPropertiesObject -LicenseKey <String> [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for AddonSrmProperties + +## EXAMPLES + +### Example 1: Create a local SRM object for the Addon Property parameter +```powershell +New-AzVMwareAddonSrmPropertiesObject -LicenseKey "YourLicenseKeyValue" +``` + +```output +AddonType ProvisioningState LicenseKey +--------- ----------------- ---------- +SRM YourLicenseKeyValue +``` + +Create a local SRM object for the Addon Property parameter + +## PARAMETERS + +### -LicenseKey +The Site Recovery Manager (SRM) license. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.AddonSrmProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwareAddonVrPropertiesObject.md b/azps-10.1.0/Az.VMware/New-AzVMwareAddonVrPropertiesObject.md new file mode 100644 index 0000000000..194ea9aa37 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwareAddonVrPropertiesObject.md @@ -0,0 +1,70 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.VMware/new-AzVMwareAddonVrPropertiesObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareAddonVrPropertiesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareAddonVrPropertiesObject.md +--- + +# New-AzVMwareAddonVrPropertiesObject + +## SYNOPSIS +Create a in-memory object for AddonVrProperties + +## SYNTAX + +``` +New-AzVMwareAddonVrPropertiesObject -VrsCount <Int32> [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for AddonVrProperties + +## EXAMPLES + +### Example 1: Create a local VR object for the Addon Property parameter +```powershell +New-AzVMwareAddonVrPropertiesObject -VrsCount 2 +``` + +```output +AddonType ProvisioningState VrsCount +--------- ----------------- -------- +VR 2 +``` + +Create a local VR object for the Addon Property parameter + +## PARAMETERS + +### -VrsCount +The vSphere Replication Server (VRS) count. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.AddonVrProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwareAuthorization.md b/azps-10.1.0/Az.VMware/New-AzVMwareAuthorization.md new file mode 100644 index 0000000000..d5c992c153 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwareAuthorization.md @@ -0,0 +1,194 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/new-azvmwareauthorization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareAuthorization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareAuthorization.md +--- + +# New-AzVMwareAuthorization + +## SYNOPSIS +Create or update an ExpressRoute Circuit Authorization in a private cloud + +## SYNTAX + +``` +New-AzVMwareAuthorization -Name <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update an ExpressRoute Circuit Authorization in a private cloud + +## EXAMPLES + +### Example 1: Create an Circuit Authorization in a private cloud +```powershell +New-AzVMwareAuthorization -Name azps_test_authorization -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_authorization Microsoft.AVS/privateClouds/authorizations azps_test_group +``` + +Create an Circuit Authorization in a private cloud + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the ExpressRoute Circuit Authorization in the private cloud + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AuthorizationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +The name of the private cloud. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IExpressRouteAuthorization + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwareCloudLink.md b/azps-10.1.0/Az.VMware/New-AzVMwareCloudLink.md new file mode 100644 index 0000000000..94f4be33d6 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwareCloudLink.md @@ -0,0 +1,209 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/new-azvmwarecloudlink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareCloudLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareCloudLink.md +--- + +# New-AzVMwareCloudLink + +## SYNOPSIS +Create or update a cloud link in a private cloud + +## SYNTAX + +``` +New-AzVMwareCloudLink -Name <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-LinkedCloud <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a cloud link in a private cloud + +## EXAMPLES + +### Example 1: Create a cloud link in a private cloud +```powershell +New-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 +``` + +Create a cloud link in a private cloud + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinkedCloud +Identifier of the other private cloud participating in the link. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the cloud link resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: CloudLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +The name of the private cloud. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.ICloudLink + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwareCluster.md b/azps-10.1.0/Az.VMware/New-AzVMwareCluster.md new file mode 100644 index 0000000000..5a88ed12e5 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwareCluster.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/new-azvmwarecluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareCluster.md +--- + +# New-AzVMwareCluster + +## SYNOPSIS +Create or update a cluster in a private cloud + +## SYNTAX + +``` +New-AzVMwareCluster -Name <String> -PrivateCloudName <String> -ResourceGroupName <String> -SkuName <String> + [-SubscriptionId <String>] [-ClusterSize <Int32>] [-PropertiesHost <String[]>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a cluster in a private cloud + +## EXAMPLES + +### Example 1: Create a cluster +```powershell +New-AzVMwareCluster -Name azps_test_cluster -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -ClusterSize 3 -SkuName av36 +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_cluster Microsoft.AVS/privateClouds/clusters azps_test_group +``` + +Create a cluster + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterSize +The cluster size + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the cluster in the private cloud + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +The name of the private cloud. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertiesHost +The hosts + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.ICluster + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwareDatastore.md b/azps-10.1.0/Az.VMware/New-AzVMwareDatastore.md new file mode 100644 index 0000000000..aa5e08c532 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwareDatastore.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/new-azvmwaredatastore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareDatastore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareDatastore.md +--- + +# New-AzVMwareDatastore + +## SYNOPSIS +Create or update a datastore in a private cloud cluster + +## SYNTAX + +``` +New-AzVMwareDatastore -ClusterName <String> -Name <String> -PrivateCloudName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DiskPoolVolumeLunName <String>] + [-DiskPoolVolumeMountOption <MountOptionEnum>] [-DiskPoolVolumeTargetId <String>] [-NetAppVolumeId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a datastore in a private cloud cluster + +## EXAMPLES + +### Example 1: Create or update a datastore in a private cloud cluster. +```powershell +New-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 +``` + +Create or update a datastore in a private cloud cluster. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Name of the cluster in the private cloud + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskPoolVolumeLunName +Name of the LUN to be used for datastore + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskPoolVolumeMountOption +Mode that describes whether the LUN has to be mounted as a datastore or attached as a LUN + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Support.MountOptionEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskPoolVolumeTargetId +Azure resource ID of the iSCSI target + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the datastore in the private cloud cluster + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DatastoreName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetAppVolumeId +Azure resource ID of the NetApp volume + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IDatastore + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwareGlobalReachConnection.md b/azps-10.1.0/Az.VMware/New-AzVMwareGlobalReachConnection.md new file mode 100644 index 0000000000..ed13fd4520 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwareGlobalReachConnection.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/new-azvmwareglobalreachconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareGlobalReachConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareGlobalReachConnection.md +--- + +# New-AzVMwareGlobalReachConnection + +## SYNOPSIS +Create or update a global reach connection in a private cloud + +## SYNTAX + +``` +New-AzVMwareGlobalReachConnection -Name <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AuthorizationKey <String>] [-ExpressRouteId <String>] + [-PeerExpressRouteResourceId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a global reach connection in a private cloud + +## EXAMPLES + +### Example 1: Create a global reach connection in a private cloud +```powershell +New-AzVMwareGlobalReachConnection -Name azps_test_grc -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -AuthorizationKey "df530ffb-5a57-4437-a3eb-08e4c73ce011" -PeerExpressRouteResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tnt16-cust-mp01-mock01/providers/Microsoft.Network/expressRouteCircuits/tnt16-cust-mp01-mock01-er" +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_grc Microsoft.AVS/privateClouds/globalReachConnections azps_test_group +``` + +Create a global reach connection in a private cloud + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizationKey +Authorization key from the peer express route used for the global reach connection + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpressRouteId +The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the global reach connection in the private cloud + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: GlobalReachConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PeerExpressRouteResourceId +Identifier of the ExpressRoute Circuit to peer with in the global reach connection + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +The name of the private cloud. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IGlobalReachConnection + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwarePSCredentialExecutionParameterObject.md b/azps-10.1.0/Az.VMware/New-AzVMwarePSCredentialExecutionParameterObject.md new file mode 100644 index 0000000000..61a7241487 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwarePSCredentialExecutionParameterObject.md @@ -0,0 +1,101 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.VMware/new-AzVMwarePSCredentialExecutionParameterObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwarePSCredentialExecutionParameterObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwarePSCredentialExecutionParameterObject.md +--- + +# New-AzVMwarePSCredentialExecutionParameterObject + +## SYNOPSIS +Create a in-memory object for PSCredentialExecutionParameter + +## SYNTAX + +``` +New-AzVMwarePSCredentialExecutionParameterObject -Name <String> [-Password <String>] [-Username <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for PSCredentialExecutionParameter + +## EXAMPLES + +### Example 1: Create a local PS Credential Execution object +```powershell +New-AzVMwarePSCredentialExecutionParameterObject -Name azps_test_credentialvalue -Password "passwordValue" -Username "usernameValue" +``` + +```output +Name Type Password Username +---- ---- -------- -------- +azps_test_credentialvalue Credential passwordValue usernameValue +``` + +Create a local PS Credential Execution object + +## PARAMETERS + +### -Name +The parameter name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +password for login. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Username +username for login. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.PsCredentialExecutionParameter + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwarePlacementPolicy.md b/azps-10.1.0/Az.VMware/New-AzVMwarePlacementPolicy.md new file mode 100644 index 0000000000..795158f0bc --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwarePlacementPolicy.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/new-azvmwareplacementpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwarePlacementPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwarePlacementPolicy.md +--- + +# New-AzVMwarePlacementPolicy + +## SYNOPSIS +Create or update a placement policy in a private cloud cluster + +## SYNTAX + +``` +New-AzVMwarePlacementPolicy -ClusterName <String> -Name <String> -PrivateCloudName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-Property <IPlacementPolicyProperties>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a placement policy in a private cloud cluster + +## EXAMPLES + +### Example 1: Create or update a placement policy in a private cloud cluster +```powershell +$abc = New-AzVMwareVMPlacementPolicyPropertiesObject -AffinityType 'Affinity' -Type 'VmVm' -VMMember @{"test"="test"} +New-AzVMwarePlacementPolicy -ClusterName cluster1 -Name policy1 -PrivateCloudName cloud1 -ResourceGroupName group1 -Property $abc +``` + +```output +Name ResourceGroupName +---- ----------------- +policy1 group1 +``` + +Create or update a placement policy in a private cloud cluster + +### Example 2: Create or update a placement policy in a private cloud cluster +```powershell +$abc = New-AzVMwareVmHostPlacementPolicyPropertiesObject -AffinityType 'AntiAffinity' -HostMember @{"test"="test"} -Type 'VmHost' -VMMember @{"test"="test"} +New-AzVMwarePlacementPolicy -ClusterName cluster1 -Name policy1 -PrivateCloudName cloud1 -ResourceGroupName group1 -Property $abc +``` + +```output +Name ResourceGroupName +---- ----------------- +policy1 group1 +``` + +Create or update a placement policy in a private cloud cluster + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Name of the cluster in the private cloud + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PlacementPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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.Api20211201.IPlacementPolicyProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IPlacementPolicyProperties>`: placement policy properties + - `Type <PlacementPolicyType>`: placement policy type + - `[DisplayName <String>]`: Display name of the placement policy + - `[State <PlacementPolicyState?>]`: Whether the placement policy is enabled or disabled + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwarePrivateCloud.md b/azps-10.1.0/Az.VMware/New-AzVMwarePrivateCloud.md new file mode 100644 index 0000000000..68823b7f29 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwarePrivateCloud.md @@ -0,0 +1,316 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/new-azvmwareprivatecloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwarePrivateCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwarePrivateCloud.md +--- + +# New-AzVMwarePrivateCloud + +## SYNOPSIS +Create or update a private cloud + +## SYNTAX + +``` +New-AzVMwarePrivateCloud -Name <String> -ResourceGroupName <String> -Location <String> + -ManagementClusterSize <Int32> -NetworkBlock <String> -Sku <String> [-SubscriptionId <String>] [-AcceptEULA] + [-Internet <InternetEnum>] [-NsxtPassword <String>] [-Tag <Hashtable>] [-VcenterPassword <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update a private cloud + +## EXAMPLES + +### Example 1: Create a private cloud +```powershell +New-AzVMwarePrivateCloud -Name azps_test_cloud -ResourceGroupName azps_test_group -NetworkBlock 192.168.48.0/22 -Sku av36 -ManagementClusterSize 3 -Location australiaeast +``` + +```output +Location Name Type ResourceGroupName +-------- ---- ---- ----------------- +australiaeast azps_test_cloud Microsoft.AVS/privateClouds azps_test_group +``` + +Create a private cloud + +## PARAMETERS + +### -AcceptEULA +Accept EULA of AVS, legal term will pop up without this parameter provided + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Internet +Connectivity to internet is enabled or disabled + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Support.InternetEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementClusterSize +The cluster size + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: PrivateCloudName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkBlock +The block of addresses should be unique across VNet in your subscription as well as on-premise. +Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sku +The name of the SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IPrivateCloud + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwarePrivateCloudNsxtPassword.md b/azps-10.1.0/Az.VMware/New-AzVMwarePrivateCloudNsxtPassword.md new file mode 100644 index 0000000000..78dffed398 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwarePrivateCloudNsxtPassword.md @@ -0,0 +1,249 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/new-azvmwareprivatecloudnsxtpassword +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwarePrivateCloudNsxtPassword.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwarePrivateCloudNsxtPassword.md +--- + +# New-AzVMwarePrivateCloudNsxtPassword + +## SYNOPSIS +Rotate the NSX-T Manager password + +## SYNTAX + +### Rotate (Default) +``` +New-AzVMwarePrivateCloudNsxtPassword -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### RotateViaIdentity +``` +New-AzVMwarePrivateCloudNsxtPassword -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Rotate the NSX-T Manager password + +## EXAMPLES + +### Example 1: Rotate the NSX-T Manager password +```powershell +New-AzVMwarePrivateCloudNsxtPassword -ResourceGroupName azps_test_group -PrivateCloudName azps_test_cloud -PassThru +``` + +```output +True +``` + +Rotate the NSX-T Manager password + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: RotateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Rotate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Rotate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Rotate +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwarePrivateCloudVcenterPassword.md b/azps-10.1.0/Az.VMware/New-AzVMwarePrivateCloudVcenterPassword.md new file mode 100644 index 0000000000..88fc78ad87 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwarePrivateCloudVcenterPassword.md @@ -0,0 +1,249 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/new-azvmwareprivatecloudvcenterpassword +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwarePrivateCloudVcenterPassword.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwarePrivateCloudVcenterPassword.md +--- + +# New-AzVMwarePrivateCloudVcenterPassword + +## SYNOPSIS +Rotate the vCenter password + +## SYNTAX + +### Rotate (Default) +``` +New-AzVMwarePrivateCloudVcenterPassword -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### RotateViaIdentity +``` +New-AzVMwarePrivateCloudVcenterPassword -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Rotate the vCenter password + +## EXAMPLES + +### Example 1: Rotate the vCenter password +```powershell +New-AzVMwarePrivateCloudVcenterPassword -ResourceGroupName azps_test_group -PrivateCloudName azps_test_cloud -PassThru +``` + +```output +True +``` + +Rotate the vCenter password + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: RotateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Rotate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Rotate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Rotate +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwareScriptSecureStringExecutionParameterObject.md b/azps-10.1.0/Az.VMware/New-AzVMwareScriptSecureStringExecutionParameterObject.md new file mode 100644 index 0000000000..1d083834ca --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwareScriptSecureStringExecutionParameterObject.md @@ -0,0 +1,86 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.VMware/new-AzVMwareScriptSecureStringExecutionParameterObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareScriptSecureStringExecutionParameterObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareScriptSecureStringExecutionParameterObject.md +--- + +# New-AzVMwareScriptSecureStringExecutionParameterObject + +## SYNOPSIS +Create a in-memory object for ScriptSecureStringExecutionParameter + +## SYNTAX + +``` +New-AzVMwareScriptSecureStringExecutionParameterObject -Name <String> [-SecureValue <String>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for ScriptSecureStringExecutionParameter + +## EXAMPLES + +### Example 1: Create a local Script Secure String Execution object +```powershell +New-AzVMwareScriptSecureStringExecutionParameterObject -Name azps_test_securevalue -SecureValue "passwordValue" +``` + +```output +Name Type SecureValue +---- ---- ----------- +azps_test_securevalue SecureValue passwordValue +``` + +Create a local Script Secure String Execution object + +## PARAMETERS + +### -Name +The parameter name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.ScriptSecureStringExecutionParameter + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwareScriptStringExecutionParameterObject.md b/azps-10.1.0/Az.VMware/New-AzVMwareScriptStringExecutionParameterObject.md new file mode 100644 index 0000000000..84ddd90999 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwareScriptStringExecutionParameterObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.VMware/new-AzVMwareScriptStringExecutionParameterObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareScriptStringExecutionParameterObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareScriptStringExecutionParameterObject.md +--- + +# New-AzVMwareScriptStringExecutionParameterObject + +## SYNOPSIS +Create a in-memory object for ScriptStringExecutionParameter + +## SYNTAX + +``` +New-AzVMwareScriptStringExecutionParameterObject -Name <String> [-Value <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create a in-memory object for ScriptStringExecutionParameter + +## EXAMPLES + +### Example 1: Create a local Script String Execution object +```powershell +New-AzVMwareScriptStringExecutionParameterObject -Name azps_test_stringvalue -Value "stringValue" +``` + +```output +Name Type Value +---- ---- ----- +azps_test_stringvalue Value stringValue +``` + +Create a local Script String Execution object + +## PARAMETERS + +### -Name +The parameter name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The value for the passed parameter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.ScriptStringExecutionParameter + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwareVMPlacementPolicyPropertiesObject.md b/azps-10.1.0/Az.VMware/New-AzVMwareVMPlacementPolicyPropertiesObject.md new file mode 100644 index 0000000000..7e55b5183d --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwareVMPlacementPolicyPropertiesObject.md @@ -0,0 +1,131 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.VMware/new-AzVMwareVMPlacementPolicyPropertiesObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareVMPlacementPolicyPropertiesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareVMPlacementPolicyPropertiesObject.md +--- + +# New-AzVMwareVMPlacementPolicyPropertiesObject + +## SYNOPSIS +Create an in-memory object for VMPlacementPolicyProperties. + +## SYNTAX + +``` +New-AzVMwareVMPlacementPolicyPropertiesObject -AffinityType <AffinityType> -Type <PlacementPolicyType> + -VMMember <String[]> [-DisplayName <String>] [-State <PlacementPolicyState>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for VMPlacementPolicyProperties. + +## EXAMPLES + +### Example 1: Create an in-memory object for VMPlacementPolicyProperties. +```powershell +New-AzVMwareVMPlacementPolicyPropertiesObject -AffinityType 'Affinity' -Type 'VmVm' -VMMember @{"abc"="123"} +``` + +```output +DisplayName ProvisioningState State AffinityType VMMember +----------- ----------------- ----- ------------ -------- + Affinity {System.Collections.Hashtable} +``` + +Create an in-memory object for VMPlacementPolicyProperties. + +## PARAMETERS + +### -AffinityType +placement policy affinity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Support.AffinityType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display name of the placement policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Whether the placement policy is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Support.PlacementPolicyState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +placement policy type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Support.PlacementPolicyType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMMember +Virtual machine members list. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.VMPlacementPolicyProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/New-AzVMwareVmHostPlacementPolicyPropertiesObject.md b/azps-10.1.0/Az.VMware/New-AzVMwareVmHostPlacementPolicyPropertiesObject.md new file mode 100644 index 0000000000..1e43b925f8 --- /dev/null +++ b/azps-10.1.0/Az.VMware/New-AzVMwareVmHostPlacementPolicyPropertiesObject.md @@ -0,0 +1,147 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.VMware/new-AzVMwareVmHostPlacementPolicyPropertiesObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareVmHostPlacementPolicyPropertiesObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/New-AzVMwareVmHostPlacementPolicyPropertiesObject.md +--- + +# New-AzVMwareVmHostPlacementPolicyPropertiesObject + +## SYNOPSIS +Create an in-memory object for VmHostPlacementPolicyProperties. + +## SYNTAX + +``` +New-AzVMwareVmHostPlacementPolicyPropertiesObject -AffinityType <AffinityType> -HostMember <String[]> + -Type <PlacementPolicyType> -VMMember <String[]> [-DisplayName <String>] [-State <PlacementPolicyState>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for VmHostPlacementPolicyProperties. + +## EXAMPLES + +### Example 1: Create an in-memory object for VmHostPlacementPolicyProperties. +```powershell +New-AzVMwareVmHostPlacementPolicyPropertiesObject -AffinityType 'AntiAffinity' -HostMember @{"abc"="123"} -Type 'VmHost' -VMMember @{"abc"="123"} +``` + +```output +DisplayName ProvisioningState State AffinityType HostMember VMMember +----------- ----------------- ----- ------------ ---------- -------- + AntiAffinity {System.Collections.Hashtable} {System.Collections.Hashtable} +``` + +Create an in-memory object for VmHostPlacementPolicyProperties. + +## PARAMETERS + +### -AffinityType +placement policy affinity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Support.AffinityType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Display name of the placement policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostMember +Host members list. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Whether the placement policy is enabled or disabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Support.PlacementPolicyState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +placement policy type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Support.PlacementPolicyType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMMember +Virtual machine members list. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.VMHostPlacementPolicyProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Remove-AzVMwareAddon.md b/azps-10.1.0/Az.VMware/Remove-AzVMwareAddon.md new file mode 100644 index 0000000000..376a1ca86a --- /dev/null +++ b/azps-10.1.0/Az.VMware/Remove-AzVMwareAddon.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/remove-azvmwareaddon +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwareAddon.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwareAddon.md +--- + +# Remove-AzVMwareAddon + +## SYNOPSIS +Delete a addon in a private cloud + +## SYNTAX + +### Delete (Default) +``` +Remove-AzVMwareAddon -AddonType <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzVMwareAddon -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a addon in a private cloud + +## EXAMPLES + +### Example 1: Delete an addon in a private cloud +```powershell +Remove-AzVMwareAddon -AddonType vr -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group + +``` + +Delete an addon in a private cloud + +### Example 2: Delete an addon in a private cloud +```powershell +Get-AzVMwareAddon -AddonType vr -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group | Remove-AzVMwareAddon + +``` + +Delete an addon in a private cloud + +## PARAMETERS + +### -AddonType +Name of the addon for the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AddonName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Remove-AzVMwareAuthorization.md b/azps-10.1.0/Az.VMware/Remove-AzVMwareAuthorization.md new file mode 100644 index 0000000000..7eccf86f1a --- /dev/null +++ b/azps-10.1.0/Az.VMware/Remove-AzVMwareAuthorization.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/remove-azvmwareauthorization +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwareAuthorization.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwareAuthorization.md +--- + +# Remove-AzVMwareAuthorization + +## SYNOPSIS +Delete an ExpressRoute Circuit Authorization in a private cloud + +## SYNTAX + +### Delete (Default) +``` +Remove-AzVMwareAuthorization -Name <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzVMwareAuthorization -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete an ExpressRoute Circuit Authorization in a private cloud + +## EXAMPLES + +### Example 1: Delete authorization in private cloud +```powershell +Remove-AzVMwareAuthorization -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -Name azps_test_authorization + +``` + +Delete authorization in private cloud + +### Example 2: Delete authorization in private cloud +```powershell +Get-AzVMwareAuthorization -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -Name azps_test_authorization | Remove-AzVMwareAuthorization + +``` + +Delete authorization in private cloud + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the ExpressRoute Circuit Authorization in the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AuthorizationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Remove-AzVMwareCloudLink.md b/azps-10.1.0/Az.VMware/Remove-AzVMwareCloudLink.md new file mode 100644 index 0000000000..040168ccde --- /dev/null +++ b/azps-10.1.0/Az.VMware/Remove-AzVMwareCloudLink.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/remove-azvmwarecloudlink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwareCloudLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwareCloudLink.md +--- + +# Remove-AzVMwareCloudLink + +## SYNOPSIS +Delete a cloud link in a private cloud + +## SYNTAX + +### Delete (Default) +``` +Remove-AzVMwareCloudLink -Name <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzVMwareCloudLink -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a cloud link in a private cloud + +## EXAMPLES + +### Example 1: Delete a cloud link +```powershell +Remove-AzVMwareCloudLink -Name azps_test_cloudlink -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group + +``` + +Delete a cloud link + +### Example 2: Delete a cloud link +```powershell +Get-AzVMwareCloudLink -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -Name azps_test_cloudlink | Remove-AzVMwareCloudLink + +``` + +Delete a cloud link + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the cloud link resource + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CloudLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Remove-AzVMwareCluster.md b/azps-10.1.0/Az.VMware/Remove-AzVMwareCluster.md new file mode 100644 index 0000000000..328fe17abb --- /dev/null +++ b/azps-10.1.0/Az.VMware/Remove-AzVMwareCluster.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/remove-azvmwarecluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwareCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwareCluster.md +--- + +# Remove-AzVMwareCluster + +## SYNOPSIS +Delete a cluster in a private cloud + +## SYNTAX + +### Delete (Default) +``` +Remove-AzVMwareCluster -Name <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzVMwareCluster -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a cluster in a private cloud + +## EXAMPLES + +### Example 1: Delete cluster in private cloud +```powershell +Remove-AzVMwareCluster -Name azps_test_cluster -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group + +``` + +Delete cluster in private cloud + +### Example 2: Delete cluster in private cloud +```powershell +Get-AzVMwareCluster -Name azps_test_cluster -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group | Remove-AzVMwareCluster + +``` + +Delete cluster in private cloud + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the cluster in the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Remove-AzVMwareDatastore.md b/azps-10.1.0/Az.VMware/Remove-AzVMwareDatastore.md new file mode 100644 index 0000000000..9dd357b649 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Remove-AzVMwareDatastore.md @@ -0,0 +1,282 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/remove-azvmwaredatastore +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwareDatastore.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwareDatastore.md +--- + +# Remove-AzVMwareDatastore + +## SYNOPSIS +Delete a datastore in a private cloud cluster + +## SYNTAX + +### Delete (Default) +``` +Remove-AzVMwareDatastore -ClusterName <String> -Name <String> -PrivateCloudName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzVMwareDatastore -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a datastore in a private cloud cluster + +## EXAMPLES + +### Example 1: Delete a datastore in a private cloud cluster. +```powershell +Remove-AzVMwareDatastore -ClusterName azps_test_cluster -Name azps_test_datastore -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group +``` + +Delete a datastore in a private cloud cluster. + +### Example 2: Delete a datastore in a private cloud cluster. +```powershell +Get-AzVMwareDatastore -ClusterName azps_test_cluster -Name azps_test_datastore -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group | Remove-AzVMwareDatastore +``` + +Delete a datastore in a private cloud cluster. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Name of the cluster in the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the datastore in the private cloud cluster + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: DatastoreName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Remove-AzVMwareGlobalReachConnection.md b/azps-10.1.0/Az.VMware/Remove-AzVMwareGlobalReachConnection.md new file mode 100644 index 0000000000..bc41836509 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Remove-AzVMwareGlobalReachConnection.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/remove-azvmwareglobalreachconnection +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwareGlobalReachConnection.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwareGlobalReachConnection.md +--- + +# Remove-AzVMwareGlobalReachConnection + +## SYNOPSIS +Delete a global reach connection in a private cloud + +## SYNTAX + +### Delete (Default) +``` +Remove-AzVMwareGlobalReachConnection -Name <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzVMwareGlobalReachConnection -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a global reach connection in a private cloud + +## EXAMPLES + +### Example 1: Delete a global reach connection in a private cloud +```powershell +Remove-AzVMwareGlobalReachConnection -Name azps_test_grc -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group + +``` + +Delete a global reach connection in a private cloud + +### Example 2: Delete a global reach connection in a private cloud +```powershell +Get-AzVMwareGlobalReachConnection -Name azps_test_grc -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group | Remove-AzVMwareGlobalReachConnection + +``` + +Delete a global reach connection in a private cloud + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the global reach connection in the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: GlobalReachConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Remove-AzVMwarePlacementPolicy.md b/azps-10.1.0/Az.VMware/Remove-AzVMwarePlacementPolicy.md new file mode 100644 index 0000000000..879b20589e --- /dev/null +++ b/azps-10.1.0/Az.VMware/Remove-AzVMwarePlacementPolicy.md @@ -0,0 +1,284 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/remove-azvmwareplacementpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwarePlacementPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwarePlacementPolicy.md +--- + +# Remove-AzVMwarePlacementPolicy + +## SYNOPSIS +Delete a placement policy in a private cloud cluster + +## SYNTAX + +### Delete (Default) +``` +Remove-AzVMwarePlacementPolicy -ClusterName <String> -Name <String> -PrivateCloudName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzVMwarePlacementPolicy -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a placement policy in a private cloud cluster + +## EXAMPLES + +### Example 1: Delete a placement policy in a private cloud cluster +```powershell +Remove-AzVMwarePlacementPolicy -ClusterName cluster1 -Name policy1 -PrivateCloudName cloud1 -ResourceGroupName group1 + +``` + +Delete a placement policy in a private cloud cluster + +### Example 2: Delete a placement policy in a private cloud cluster +```powershell +Get-AzVMwarePlacementPolicy -ClusterName cluster1 -Name policy1 -PrivateCloudName cloud1 -ResourceGroupName group1 | Remove-AzVMwarePlacementPolicy + +``` + +Delete a placement policy in a private cloud cluster + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Name of the cluster in the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: PlacementPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Remove-AzVMwarePrivateCloud.md b/azps-10.1.0/Az.VMware/Remove-AzVMwarePrivateCloud.md new file mode 100644 index 0000000000..59b35e2723 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Remove-AzVMwarePrivateCloud.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/remove-azvmwareprivatecloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwarePrivateCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Remove-AzVMwarePrivateCloud.md +--- + +# Remove-AzVMwarePrivateCloud + +## SYNOPSIS +Delete a private cloud + +## SYNTAX + +### Delete (Default) +``` +Remove-AzVMwarePrivateCloud -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzVMwarePrivateCloud -InputObject <IVMwareIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a private cloud + +## EXAMPLES + +### Example 1: Delete private cloud +```powershell +Remove-AzVMwarePrivateCloud -ResourceGroupName azps_test_group -Name azps_test_cloud + +``` + +Delete private cloud + +### Example 2: Delete private cloud +```powershell +Get-AzVMwarePrivateCloud -ResourceGroupName azps_test_group -Name azps_test_cloud | Remove-AzVMwarePrivateCloud + +``` + +Delete private cloud + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: PrivateCloudName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Test-AzVMwareLocationQuotaAvailability.md b/azps-10.1.0/Az.VMware/Test-AzVMwareLocationQuotaAvailability.md new file mode 100644 index 0000000000..dd122e67d5 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Test-AzVMwareLocationQuotaAvailability.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/test-azvmwarelocationquotaavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Test-AzVMwareLocationQuotaAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Test-AzVMwareLocationQuotaAvailability.md +--- + +# Test-AzVMwareLocationQuotaAvailability + +## SYNOPSIS +Return quota for subscription by region + +## SYNTAX + +``` +Test-AzVMwareLocationQuotaAvailability -Location <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Return quota for subscription by region + +## EXAMPLES + +### Example 1: Check quota availability +```powershell +Test-AzVMwareLocationQuotaAvailability -Location centralus +``` + +```output +Enabled +------- +Enabled +``` + +Check quota availability + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Azure region + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IQuota + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Test-AzVMwareLocationTrialAvailability.md b/azps-10.1.0/Az.VMware/Test-AzVMwareLocationTrialAvailability.md new file mode 100644 index 0000000000..c89833f646 --- /dev/null +++ b/azps-10.1.0/Az.VMware/Test-AzVMwareLocationTrialAvailability.md @@ -0,0 +1,132 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/test-azvmwarelocationtrialavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Test-AzVMwareLocationTrialAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Test-AzVMwareLocationTrialAvailability.md +--- + +# Test-AzVMwareLocationTrialAvailability + +## SYNOPSIS +Return trial status for subscription by region + +## SYNTAX + +``` +Test-AzVMwareLocationTrialAvailability -Location <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Return trial status for subscription by region + +## EXAMPLES + +### Example 1: Check trial availability +```powershell +Test-AzVMwareLocationTrialAvailability -Location westcentralus +``` + +```output +AvailableHost Status +------------- ------ +0 TrialDisabled +``` + +Check trial availability + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Azure region + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.ITrial + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Update-AzVMwareCluster.md b/azps-10.1.0/Az.VMware/Update-AzVMwareCluster.md new file mode 100644 index 0000000000..dc0f79e60a --- /dev/null +++ b/azps-10.1.0/Az.VMware/Update-AzVMwareCluster.md @@ -0,0 +1,294 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/update-azvmwarecluster +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Update-AzVMwareCluster.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Update-AzVMwareCluster.md +--- + +# Update-AzVMwareCluster + +## SYNOPSIS +Update a cluster in a private cloud + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzVMwareCluster -Name <String> -PrivateCloudName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-ClusterSize <Int32>] [-PropertiesHost <String[]>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzVMwareCluster -InputObject <IVMwareIdentity> [-ClusterSize <Int32>] [-PropertiesHost <String[]>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a cluster in a private cloud + +## EXAMPLES + +### Example 1: Update cluster size by name +```powershell +Update-AzVMwareCluster -Name azps_test_cluster -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -ClusterSize 4 +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_cluster Microsoft.AVS/privateClouds/clusters azps_test_group +``` + +Update cluster size by name + +### Example 2: Update cluster size +```powershell +Get-AzVMwareCluster -Name azps_test_cluster -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group | Update-AzVMwareCluster -ClusterSize 4 +``` + +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_cluster Microsoft.AVS/privateClouds/clusters azps_test_group +``` + +Update cluster size + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterSize +The cluster size + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the cluster in the private cloud + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ClusterName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertiesHost +The hosts + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Update-AzVMwarePlacementPolicy.md b/azps-10.1.0/Az.VMware/Update-AzVMwarePlacementPolicy.md new file mode 100644 index 0000000000..95efcac28b --- /dev/null +++ b/azps-10.1.0/Az.VMware/Update-AzVMwarePlacementPolicy.md @@ -0,0 +1,326 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/update-azvmwareplacementpolicy +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Update-AzVMwarePlacementPolicy.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Update-AzVMwarePlacementPolicy.md +--- + +# Update-AzVMwarePlacementPolicy + +## SYNOPSIS +Update a placement policy in a private cloud cluster + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzVMwarePlacementPolicy -ClusterName <String> -Name <String> -PrivateCloudName <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-HostMember <String[]>] + [-State <PlacementPolicyState>] [-VMMember <String[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzVMwarePlacementPolicy -InputObject <IVMwareIdentity> [-HostMember <String[]>] + [-State <PlacementPolicyState>] [-VMMember <String[]>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a placement policy in a private cloud cluster + +## EXAMPLES + +### Example 1: Update a placement policy in a private cloud cluster +```powershell +Update-AzVMwarePlacementPolicy -ClusterName cluster1 -Name policy1 -PrivateCloudName cloud1 -ResourceGroupName group1 -State 'Enabled' +``` + +```output +Name ResourceGroupName +---- ----------------- +policy1 group1 +``` + +Update a placement policy in a private cloud cluster + +### Example 2: Update a placement policy in a private cloud cluster +```powershell +Get-AzVMwarePlacementPolicy -ClusterName cluster1 -Name policy1 -PrivateCloudName cloud1 -ResourceGroupName group1 | Update-AzVMwarePlacementPolicy -State 'Enabled' +``` + +```output +Name ResourceGroupName +---- ----------------- +policy1 group1 +``` + +Update a placement policy in a private cloud cluster + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterName +Name of the cluster in the private cloud + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostMember +Host members list + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: PlacementPolicyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCloudName +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +Whether the placement policy is enabled or disabled + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Support.PlacementPolicyState +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMMember +Virtual machine members list + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VMware/Update-AzVMwarePrivateCloud.md b/azps-10.1.0/Az.VMware/Update-AzVMwarePrivateCloud.md new file mode 100644 index 0000000000..b02aece04e --- /dev/null +++ b/azps-10.1.0/Az.VMware/Update-AzVMwarePrivateCloud.md @@ -0,0 +1,468 @@ +--- +external help file: +Module Name: Az.VMware +online version: https://learn.microsoft.com/powershell/module/az.vmware/update-azvmwareprivatecloud +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Update-AzVMwarePrivateCloud.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VMware/help/Update-AzVMwarePrivateCloud.md +--- + +# Update-AzVMwarePrivateCloud + +## SYNOPSIS +Update a private cloud + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzVMwarePrivateCloud -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AvailabilitySecondaryZone <Int32>] [-AvailabilityStrategy <AvailabilityStrategy>] + [-AvailabilityZone <Int32>] [-EncryptionStatus <EncryptionState>] [-IdentitySource <IIdentitySource[]>] + [-IdentityType <ResourceIdentityType>] [-Internet <InternetEnum>] [-KeyVaultPropertyKeyName <String>] + [-KeyVaultPropertyKeyVaultUrl <String>] [-KeyVaultPropertyKeyVersion <String>] + [-ManagementClusterHost <String[]>] [-ManagementClusterSize <Int32>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzVMwarePrivateCloud -InputObject <IVMwareIdentity> [-AvailabilitySecondaryZone <Int32>] + [-AvailabilityStrategy <AvailabilityStrategy>] [-AvailabilityZone <Int32>] + [-EncryptionStatus <EncryptionState>] [-IdentitySource <IIdentitySource[]>] + [-IdentityType <ResourceIdentityType>] [-Internet <InternetEnum>] [-KeyVaultPropertyKeyName <String>] + [-KeyVaultPropertyKeyVaultUrl <String>] [-KeyVaultPropertyKeyVersion <String>] + [-ManagementClusterHost <String[]>] [-ManagementClusterSize <Int32>] [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a private cloud + +## EXAMPLES + +### Example 1: Update size of private cloud by name +```powershell +Update-AzVMwarePrivateCloud -Name azps_test_cloud -ResourceGroupName azps_test_group -ManagementClusterSize 4 +``` + +```output +Location Name Type ResourceGroupName +-------- ---- ---- ----------------- +australiaeast azps_test_cloud Microsoft.AVS/privateClouds azps_test_group +``` + +Update size of private cloud by name + +### Example 2: Update size of private cloud +```powershell +Get-AzVMwarePrivateCloud -ResourceGroupName azps_test_group -Name azps_test_cloud | Update-AzVMwarePrivateCloud -ManagementClusterSize 4 +``` + +```output +Location Name Type ResourceGroupName +-------- ---- ---- ----------------- +australiaeast azps_test_cloud Microsoft.AVS/privateClouds azps_test_group +``` + +Update size of private cloud + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilitySecondaryZone +The secondary availability zone for the private cloud + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityStrategy +The availability strategy for the private cloud + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Support.AvailabilityStrategy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityZone +The primary availability zone for the private cloud + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EncryptionStatus +Status of customer managed encryption key + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Support.EncryptionState +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IIdentitySource[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Support.ResourceIdentityType +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.VMware.Models.IVMwareIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Internet +Connectivity to internet is enabled or disabled + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Support.InternetEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyName +The name of the key. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyVaultUrl +The URL of the vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyVersion +The version of the key. + +```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 + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagementClusterSize +The cluster size + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the private cloud + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: PrivateCloudName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.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 <IIdentitySource[]>`: vCenter Single Sign On Identity Sources + - `[Alias <String>]`: The domain's NetBIOS name + - `[BaseGroupDn <String>]`: The base distinguished name for groups + - `[BaseUserDn <String>]`: The base distinguished name for users + - `[Domain <String>]`: The domain's dns name + - `[Name <String>]`: The name of the identity source + - `[Password <String>]`: The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. + - `[PrimaryServer <String>]`: Primary server URL + - `[SecondaryServer <String>]`: Secondary server URL + - `[Ssl <SslEnum?>]`: Protect LDAP communication using SSL certificate (LDAPS) + - `[Username <String>]`: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group + +`INPUTOBJECT <IVMwareIdentity>`: Identity Parameter + - `[AddonName <String>]`: Name of the addon for the private cloud + - `[AuthorizationName <String>]`: Name of the ExpressRoute Circuit Authorization in the private cloud + - `[CloudLinkName <String>]`: Name of the cloud link resource + - `[ClusterName <String>]`: Name of the cluster in the private cloud + - `[DatastoreName <String>]`: Name of the datastore in the private cloud cluster + - `[DhcpId <String>]`: NSX DHCP identifier. Generally the same as the DHCP display name + - `[DnsServiceId <String>]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name + - `[DnsZoneId <String>]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name + - `[GatewayId <String>]`: NSX Gateway identifier. Generally the same as the Gateway's display name + - `[GlobalReachConnectionName <String>]`: Name of the global reach connection in the private cloud + - `[HcxEnterpriseSiteName <String>]`: Name of the HCX Enterprise Site in the private cloud + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: Azure region + - `[PlacementPolicyName <String>]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy + - `[PortMirroringId <String>]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name + - `[PrivateCloudName <String>]`: Name of the private cloud + - `[PublicIPId <String>]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[ScriptCmdletName <String>]`: Name of the script cmdlet resource in the script package in the private cloud + - `[ScriptExecutionName <String>]`: Name of the user-invoked script execution resource + - `[ScriptPackageName <String>]`: Name of the script package in the private cloud + - `[SegmentId <String>]`: NSX Segment identifier. Generally the same as the Segment's display name + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[VMGroupId <String>]`: NSX VM Group identifier. Generally the same as the VM Group's display name + - `[VirtualMachineId <String>]`: Virtual Machine identifier + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VoiceServices/Az.VoiceServices.md b/azps-10.1.0/Az.VoiceServices/Az.VoiceServices.md new file mode 100644 index 0000000000..c723899f5b --- /dev/null +++ b/azps-10.1.0/Az.VoiceServices/Az.VoiceServices.md @@ -0,0 +1,45 @@ +--- +Module Name: Az.VoiceServices +Module Guid: 2104c31d-8a79-4ea7-9485-2fe25d5c97be +Download Help Link: https://learn.microsoft.com/powershell/module/az.voiceservices +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Az.VoiceServices.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Az.VoiceServices.md +--- + +# Az.VoiceServices Module +## Description +Microsoft Azure PowerShell: VoiceServices cmdlets + +## Az.VoiceServices Cmdlets +### [Get-AzVoiceServicesCommunicationsGateway](Get-AzVoiceServicesCommunicationsGateway.md) +Get a CommunicationsGateway + +### [Get-AzVoiceServicesCommunicationsTestLine](Get-AzVoiceServicesCommunicationsTestLine.md) +Get a TestLine + +### [New-AzVoiceServicesCommunicationsGateway](New-AzVoiceServicesCommunicationsGateway.md) +Create a CommunicationsGateway + +### [New-AzVoiceServicesCommunicationsGatewayServiceRegionObject](New-AzVoiceServicesCommunicationsGatewayServiceRegionObject.md) +Create an in-memory object for ServiceRegionProperties. + +### [New-AzVoiceServicesCommunicationsTestLine](New-AzVoiceServicesCommunicationsTestLine.md) +Create a TestLine + +### [Remove-AzVoiceServicesCommunicationsGateway](Remove-AzVoiceServicesCommunicationsGateway.md) +Delete a CommunicationsGateway + +### [Remove-AzVoiceServicesCommunicationsTestLine](Remove-AzVoiceServicesCommunicationsTestLine.md) +Delete a TestLine + +### [Test-AzVoiceServicesNameAvailability](Test-AzVoiceServicesNameAvailability.md) +Check whether the resource name is available in the given region. + +### [Update-AzVoiceServicesCommunicationsGateway](Update-AzVoiceServicesCommunicationsGateway.md) +Update a CommunicationsGateway + +### [Update-AzVoiceServicesCommunicationsTestLine](Update-AzVoiceServicesCommunicationsTestLine.md) +Update a TestLine + diff --git a/azps-10.1.0/Az.VoiceServices/Get-AzVoiceServicesCommunicationsGateway.md b/azps-10.1.0/Az.VoiceServices/Get-AzVoiceServicesCommunicationsGateway.md new file mode 100644 index 0000000000..31912e730e --- /dev/null +++ b/azps-10.1.0/Az.VoiceServices/Get-AzVoiceServicesCommunicationsGateway.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.VoiceServices +online version: https://learn.microsoft.com/powershell/module/az.voiceservices/get-azvoiceservicescommunicationsgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Get-AzVoiceServicesCommunicationsGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Get-AzVoiceServicesCommunicationsGateway.md +--- + +# Get-AzVoiceServicesCommunicationsGateway + +## SYNOPSIS +Get a CommunicationsGateway + +## SYNTAX + +### List (Default) +``` +Get-AzVoiceServicesCommunicationsGateway [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzVoiceServicesCommunicationsGateway -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzVoiceServicesCommunicationsGateway -InputObject <IVoiceServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List1 +``` +Get-AzVoiceServicesCommunicationsGateway -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get a CommunicationsGateway + +## EXAMPLES + +### Example 1: List all gateways under a subscription +```powershell +Get-AzVoiceServicesCommunicationsGateway +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus vsc-gateway-pwsh01 12/7/2022 7:09:45 AM v-diya@microsoft.com User 12/7/2022 7:09:45 AM v-diya@microsoft.com User vtest-communication-rg +westcentralus vsc-gateway-pwsh02 12/7/2022 7:09:45 AM v-diya@microsoft.com User 12/7/2022 7:09:45 AM v-diya@microsoft.com User vtest-communication-rg +``` + +List all gateways under a subscription. + +### Example 2: List all gateways under a resource group +```powershell +Get-AzVoiceServicesCommunicationsGateway -ResourceGroupName vtest-communication-rg +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus vsc-gateway-pwsh01 12/7/2022 7:09:45 AM v-diya@microsoft.com User 12/7/2022 7:09:45 AM v-diya@microsoft.com User vtest-communication-rg +westcentralus vsc-gateway-pwsh02 12/7/2022 7:09:45 AM v-diya@microsoft.com User 12/7/2022 7:09:45 AM v-diya@microsoft.com User vtest-communication-rg +``` + +List all gateways under a resource group. + +### Example 3: Get a gateway +```powershell +Get-AzVoiceServicesCommunicationsGateway -ResourceGroupName vtest-communication-rg -Name vsc-gateway-pwsh01 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus vsc-gateway-pwsh01 12/7/2022 7:09:45 AM v-diya@microsoft.com User 12/7/2022 7:09:45 AM v-diya@microsoft.com User vtest-communication-rg +``` + +Get a gateway. + +### Example 4: Get a gateway by pipeline +```powershell +$region = @() +$region += New-AzVoiceServicesCommunicationsGatewayServiceRegionObject -Name useast -PrimaryRegionOperatorAddress '198.51.100.1' +$region += New-AzVoiceServicesCommunicationsGatewayServiceRegionObject -Name useast2 -PrimaryRegionOperatorAddress '198.51.100.2' + +New-AzVoiceServicesCommunicationsGateway -ResourceGroupName 'vtest-communication-rg' -Name vsc-gateway-pwsh01 -Location 'westcentralus' -Codec 'PCMA' -E911Type 'Standard' -Platform 'OperatorConnect' -ServiceLocation $region | Get-AzVoiceServicesCommunicationsGateway +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus vsc-gateway-pwsh01 12/7/2022 7:09:45 AM v-diya@microsoft.com User 12/7/2022 7:09:45 AM v-diya@microsoft.com User vtest-communication-rg +``` + +Get a gateway by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.IVoiceServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Unique identifier for this deployment + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CommunicationsGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.IVoiceServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.Api20230131.ICommunicationsGateway + +## 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 <IVoiceServicesIdentity>`: Identity Parameter + - `[CommunicationsGatewayName <String>]`: Unique identifier for this deployment + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TestLineName <String>]`: Unique identifier for this test line + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VoiceServices/Get-AzVoiceServicesCommunicationsTestLine.md b/azps-10.1.0/Az.VoiceServices/Get-AzVoiceServicesCommunicationsTestLine.md new file mode 100644 index 0000000000..f5e55dd81a --- /dev/null +++ b/azps-10.1.0/Az.VoiceServices/Get-AzVoiceServicesCommunicationsTestLine.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.VoiceServices +online version: https://learn.microsoft.com/powershell/module/az.voiceservices/get-azvoiceservicescommunicationstestline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Get-AzVoiceServicesCommunicationsTestLine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Get-AzVoiceServicesCommunicationsTestLine.md +--- + +# Get-AzVoiceServicesCommunicationsTestLine + +## SYNOPSIS +Get a TestLine + +## SYNTAX + +### List (Default) +``` +Get-AzVoiceServicesCommunicationsTestLine -CommunicationsGatewayName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzVoiceServicesCommunicationsTestLine -CommunicationsGatewayName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzVoiceServicesCommunicationsTestLine -InputObject <IVoiceServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get a TestLine + +## EXAMPLES + +### Example 1: List all testline under the communications gateway +```powershell +Get-AzVoiceServicesCommunicationsTestLine -ResourceGroupName vtest-communication-rg -CommunicationsGatewayName vsc-gateway-pwsh01 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus testline-01 12/7/2022 7:56:47 AM v-diya@microsoft.com User 12/7/2022 7:56:47 AM v-diya@microsoft.com User vtest-communication-rg +``` + +List all testline under the communications gateway. + +### Example 2: Get a testline +```powershell +Get-AzVoiceServicesCommunicationsTestLine -ResourceGroupName vtest-communication-rg -CommunicationsGatewayName vsc-gateway-pwsh01 -Name testline-01 +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus testline-01 12/7/2022 7:56:47 AM v-diya@microsoft.com User 12/7/2022 7:56:47 AM v-diya@microsoft.com User vtest-communication-rg +``` + +Get a testline. + +### Example 3: Get a testline by pipeline +```powershell +New-AzVoiceServicesCommunicationsTestLine -ResourceGroupName vtest-communication-rg -CommunicationsGatewayName vsc-gateway-pwsh01 -Name testline-01 -Location westcentralus -Purpose 'Automated' -PhoneNumber "+1-555-1234" | Get-AzVoiceServicesCommunicationsTestLine +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus testline-01 12/7/2022 7:56:47 AM v-diya@microsoft.com User 12/7/2022 7:56:47 AM v-diya@microsoft.com User vtest-communication-rg +``` + +Get a testline by pipeline. + +## PARAMETERS + +### -CommunicationsGatewayName +Unique identifier for this deployment + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.IVoiceServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Unique identifier for this test line + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: TestLineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.IVoiceServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.Api20230131.ITestLine + +## 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 <IVoiceServicesIdentity>`: Identity Parameter + - `[CommunicationsGatewayName <String>]`: Unique identifier for this deployment + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TestLineName <String>]`: Unique identifier for this test line + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VoiceServices/New-AzVoiceServicesCommunicationsGateway.md b/azps-10.1.0/Az.VoiceServices/New-AzVoiceServicesCommunicationsGateway.md new file mode 100644 index 0000000000..6237eb1452 --- /dev/null +++ b/azps-10.1.0/Az.VoiceServices/New-AzVoiceServicesCommunicationsGateway.md @@ -0,0 +1,364 @@ +--- +external help file: +Module Name: Az.VoiceServices +online version: https://learn.microsoft.com/powershell/module/az.voiceservices/new-azvoiceservicescommunicationsgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/New-AzVoiceServicesCommunicationsGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/New-AzVoiceServicesCommunicationsGateway.md +--- + +# New-AzVoiceServicesCommunicationsGateway + +## SYNOPSIS +Create a CommunicationsGateway + +## SYNTAX + +``` +New-AzVoiceServicesCommunicationsGateway -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-ApiBridge <Hashtable>] [-Codec <TeamsCodecs[]>] + [-DomainNameLabelScope <AutoGeneratedDomainNameLabelScope>] [-E911Type <E911Type>] + [-EmergencyDialString <String[]>] [-OnPremMcpEnabled] [-Platform <CommunicationsPlatform[]>] + [-ServiceLocation <IServiceRegionProperties[]>] [-Tag <Hashtable>] [-TeamsVoicemailPilotNumber <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a CommunicationsGateway + +## EXAMPLES + +### Example 1: Create a communications gateway +```powershell +$region = @() +$region += New-AzVoiceServicesCommunicationsGatewayServiceRegionObject -Name useast -PrimaryRegionOperatorAddress '198.51.100.1' +$region += New-AzVoiceServicesCommunicationsGatewayServiceRegionObject -Name useast2 -PrimaryRegionOperatorAddress '198.51.100.2' + +New-AzVoiceServicesCommunicationsGateway -ResourceGroupName 'vtest-communication-rg' -Name vsc-gateway-pwsh01 -Location 'westcentralus' -Codec 'PCMA' -E911Type 'Standard' -Platform 'OperatorConnect' -ServiceLocation $region +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus vsc-gateway-pwsh01 12/7/2022 7:09:45 AM v-diya@microsoft.com User 12/7/2022 7:09:45 AM v-diya@microsoft.com User vtest-communication-rg +``` + +Create a communications gateway. + +## PARAMETERS + +### -ApiBridge +Details of API bridge functionality, if required + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Codec +Voice codecs to support + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Support.TeamsCodecs[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainNameLabelScope +The scope at which the auto-generated domain name can be re-used + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Support.AutoGeneratedDomainNameLabelScope +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -E911Type +How to handle 911 calls + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Support.E911Type +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmergencyDialString +A list of dial strings used for emergency calling. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Unique identifier for this deployment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnPremMcpEnabled +Whether an on-premises Mobile Control Point is in use. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Platform +What platforms to support + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Support.CommunicationsPlatform[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceLocation +The regions in which to deploy the resources needed for Teams Calling +To construct, see NOTES section for SERVICELOCATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.Api20230131.IServiceRegionProperties[] +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsVoicemailPilotNumber +This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.Api20230131.ICommunicationsGateway + +## 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. + + +`SERVICELOCATION <IServiceRegionProperties[]>`: The regions in which to deploy the resources needed for Teams Calling + - `Name <String>`: The name of the region in which the resources needed for Teams Calling will be deployed. + - `PrimaryRegionPropertyOperatorAddress <String[]>`: IP address to use to contact the operator network from this region + - `[PrimaryRegionPropertyAllowedMediaSourceAddressPrefix <String[]>]`: The allowed source IP address or CIDR ranges for media + - `[PrimaryRegionPropertyAllowedSignalingSourceAddressPrefix <String[]>]`: The allowed source IP address or CIDR ranges for signaling + - `[PrimaryRegionPropertyEsrpAddress <String[]>]`: IP address to use to contact the ESRP from this region + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VoiceServices/New-AzVoiceServicesCommunicationsGatewayServiceRegionObject.md b/azps-10.1.0/Az.VoiceServices/New-AzVoiceServicesCommunicationsGatewayServiceRegionObject.md new file mode 100644 index 0000000000..c619379932 --- /dev/null +++ b/azps-10.1.0/Az.VoiceServices/New-AzVoiceServicesCommunicationsGatewayServiceRegionObject.md @@ -0,0 +1,105 @@ +--- +external help file: +Module Name: Az.VoiceServices +online version: https://learn.microsoft.com/powershell/module/az.VoiceServices/new-AzVoiceServicesCommunicationsGatewayServiceRegionObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/New-AzVoiceServicesCommunicationsGatewayServiceRegionObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/New-AzVoiceServicesCommunicationsGatewayServiceRegionObject.md +--- + +# New-AzVoiceServicesCommunicationsGatewayServiceRegionObject + +## SYNOPSIS +Create an in-memory object for ServiceRegionProperties. + +## SYNTAX + +``` +New-AzVoiceServicesCommunicationsGatewayServiceRegionObject -Name <String> + -PrimaryRegionOperatorAddress <String[]> [-PrimaryRegionEsrpAddress <String[]>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for ServiceRegionProperties. + +## EXAMPLES + +### Example 1: Create an in-memory object for ServiceRegionProperties +```powershell +$region = @() +$region += New-AzVoiceServicesCommunicationsGatewayServiceRegionObject -Name useast -PrimaryRegionOperatorAddress '198.51.100.1' +$region += New-AzVoiceServicesCommunicationsGatewayServiceRegionObject -Name useast2 -PrimaryRegionOperatorAddress '198.51.100.2' + +New-AzVoiceServicesCommunicationsGateway -ResourceGroupName 'vtest-communication-rg' -Name vsc-gateway-pwsh01 -Location 'westcentralus' -Codec 'PCMA' -E911Type 'Standard' -Platform 'OperatorConnect' -ServiceLocation $region +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus vsc-gateway-pwsh01 12/7/2022 7:09:45 AM v-diya@microsoft.com User 12/7/2022 7:09:45 AM v-diya@microsoft.com User vtest-communication-rg +``` + +Create an in-memory object for ServiceRegionProperties and assign to ServiceLocation parameter of the New-AzVoiceServicesCommunicationsGateway. + +## PARAMETERS + +### -Name +The name of the region in which the resources needed for Teams Calling will be deployed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryRegionEsrpAddress +IP address to use to contact the ESRP from this region. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrimaryRegionOperatorAddress +IP address to use to contact the operator network from this region. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.Api20230131.ServiceRegionProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VoiceServices/New-AzVoiceServicesCommunicationsTestLine.md b/azps-10.1.0/Az.VoiceServices/New-AzVoiceServicesCommunicationsTestLine.md new file mode 100644 index 0000000000..3c6c898193 --- /dev/null +++ b/azps-10.1.0/Az.VoiceServices/New-AzVoiceServicesCommunicationsTestLine.md @@ -0,0 +1,256 @@ +--- +external help file: +Module Name: Az.VoiceServices +online version: https://learn.microsoft.com/powershell/module/az.voiceservices/new-azvoiceservicescommunicationstestline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/New-AzVoiceServicesCommunicationsTestLine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/New-AzVoiceServicesCommunicationsTestLine.md +--- + +# New-AzVoiceServicesCommunicationsTestLine + +## SYNOPSIS +Create a TestLine + +## SYNTAX + +``` +New-AzVoiceServicesCommunicationsTestLine -CommunicationsGatewayName <String> -Name <String> + -ResourceGroupName <String> -Location <String> [-SubscriptionId <String>] [-PhoneNumber <String>] + [-Purpose <TestLinePurpose>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create a TestLine + +## EXAMPLES + +### Example 1: Create a test line for the communications gateway +```powershell +New-AzVoiceServicesCommunicationsTestLine -ResourceGroupName vtest-communication-rg -CommunicationsGatewayName vsc-gateway-pwsh01 -Name testline-01 -Location westcentralus -Purpose 'Automated' -PhoneNumber "+1-555-1234" +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus testline-01 12/7/2022 7:56:47 AM v-diya@microsoft.com User 12/7/2022 7:56:47 AM v-diya@microsoft.com User vtest-communication-rg +``` + +Create a test line for the communications gateway. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommunicationsGatewayName +Unique identifier for this deployment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Unique identifier for this test line + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: TestLineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumber +The phone number + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Purpose +Purpose of this test line, e.g. +automated or manual testing + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Support.TestLinePurpose +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.Api20230131.ITestLine + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VoiceServices/Remove-AzVoiceServicesCommunicationsGateway.md b/azps-10.1.0/Az.VoiceServices/Remove-AzVoiceServicesCommunicationsGateway.md new file mode 100644 index 0000000000..01d2042a41 --- /dev/null +++ b/azps-10.1.0/Az.VoiceServices/Remove-AzVoiceServicesCommunicationsGateway.md @@ -0,0 +1,233 @@ +--- +external help file: +Module Name: Az.VoiceServices +online version: https://learn.microsoft.com/powershell/module/az.voiceservices/remove-azvoiceservicescommunicationsgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Remove-AzVoiceServicesCommunicationsGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Remove-AzVoiceServicesCommunicationsGateway.md +--- + +# Remove-AzVoiceServicesCommunicationsGateway + +## SYNOPSIS +Delete a CommunicationsGateway + +## SYNTAX + +### Delete (Default) +``` +Remove-AzVoiceServicesCommunicationsGateway -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzVoiceServicesCommunicationsGateway -InputObject <IVoiceServicesIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a CommunicationsGateway + +## EXAMPLES + +### Example 1: Delete a gateway +```powershell +Remove-AzVoiceServicesCommunicationsGateway -ResourceGroupName vtest-communication-rg -Name vsc-gateway-pwsh01 +``` + +Delete a gateway. + +### Example 2: Delete a gateway by pipeline +```powershell +Get-AzVoiceServicesCommunicationsGateway -ResourceGroupName vtest-communication-rg -Name vsc-gateway-pwsh01 | Remove-AzVoiceServicesCommunicationsGateway +``` + +Delete a gateway by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.IVoiceServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Unique identifier for this deployment + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CommunicationsGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.IVoiceServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IVoiceServicesIdentity>`: Identity Parameter + - `[CommunicationsGatewayName <String>]`: Unique identifier for this deployment + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TestLineName <String>]`: Unique identifier for this test line + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VoiceServices/Remove-AzVoiceServicesCommunicationsTestLine.md b/azps-10.1.0/Az.VoiceServices/Remove-AzVoiceServicesCommunicationsTestLine.md new file mode 100644 index 0000000000..74ecc0a466 --- /dev/null +++ b/azps-10.1.0/Az.VoiceServices/Remove-AzVoiceServicesCommunicationsTestLine.md @@ -0,0 +1,248 @@ +--- +external help file: +Module Name: Az.VoiceServices +online version: https://learn.microsoft.com/powershell/module/az.voiceservices/remove-azvoiceservicescommunicationstestline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Remove-AzVoiceServicesCommunicationsTestLine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Remove-AzVoiceServicesCommunicationsTestLine.md +--- + +# Remove-AzVoiceServicesCommunicationsTestLine + +## SYNOPSIS +Delete a TestLine + +## SYNTAX + +### Delete (Default) +``` +Remove-AzVoiceServicesCommunicationsTestLine -CommunicationsGatewayName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzVoiceServicesCommunicationsTestLine -InputObject <IVoiceServicesIdentity> + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a TestLine + +## EXAMPLES + +### Example 1: Delete a test line +```powershell +Remove-AzVoiceServicesCommunicationsTestLine -ResourceGroupName vtest-communication-rg -CommunicationsGatewayName vsc-gateway-pwsh01 -Name testline-01 +``` + +Delete a test line. + +### Example 2: Delete a test line by pipeline +```powershell +Get-AzVoiceServicesCommunicationsTestLine -ResourceGroupName vtest-communication-rg -CommunicationsGatewayName vsc-gateway-pwsh01 -Name testline-01 | Remove-AzVoiceServicesCommunicationsTestLine +``` + +Delete a test line by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommunicationsGatewayName +Unique identifier for this deployment + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.IVoiceServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Unique identifier for this test line + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: TestLineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.IVoiceServicesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IVoiceServicesIdentity>`: Identity Parameter + - `[CommunicationsGatewayName <String>]`: Unique identifier for this deployment + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TestLineName <String>]`: Unique identifier for this test line + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VoiceServices/Test-AzVoiceServicesNameAvailability.md b/azps-10.1.0/Az.VoiceServices/Test-AzVoiceServicesNameAvailability.md new file mode 100644 index 0000000000..c6bc1c7531 --- /dev/null +++ b/azps-10.1.0/Az.VoiceServices/Test-AzVoiceServicesNameAvailability.md @@ -0,0 +1,162 @@ +--- +external help file: +Module Name: Az.VoiceServices +online version: https://learn.microsoft.com/powershell/module/az.voiceservices/test-azvoiceservicesnameavailability +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Test-AzVoiceServicesNameAvailability.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Test-AzVoiceServicesNameAvailability.md +--- + +# Test-AzVoiceServicesNameAvailability + +## SYNOPSIS +Check whether the resource name is available in the given region. + +## SYNTAX + +``` +Test-AzVoiceServicesNameAvailability -Location <String> [-SubscriptionId <String>] [-Name <String>] + [-Type <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Check whether the resource name is available in the given region. + +## EXAMPLES + +### Example 1: Checks whether the resource name is available in the given region +```powershell +Test-AzVoiceServicesNameAvailability -Location eastus -Name 'VoiceServicesTestName' -Type "Microsoft.VoiceServices/CommunicationsGateways" +``` + +```output +Message NameAvailable Reason +------- ------------- ------ + True +``` + +This command checks whether the resource name is available in the given region. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location in which uniqueness will be verified. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the resource for which availability needs to be checked. + +```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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The resource type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.Api20230131.ICheckNameAvailabilityResponse + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VoiceServices/Update-AzVoiceServicesCommunicationsGateway.md b/azps-10.1.0/Az.VoiceServices/Update-AzVoiceServicesCommunicationsGateway.md new file mode 100644 index 0000000000..243ba11d89 --- /dev/null +++ b/azps-10.1.0/Az.VoiceServices/Update-AzVoiceServicesCommunicationsGateway.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.VoiceServices +online version: https://learn.microsoft.com/powershell/module/az.voiceservices/update-azvoiceservicescommunicationsgateway +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Update-AzVoiceServicesCommunicationsGateway.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Update-AzVoiceServicesCommunicationsGateway.md +--- + +# Update-AzVoiceServicesCommunicationsGateway + +## SYNOPSIS +Update a CommunicationsGateway + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzVoiceServicesCommunicationsGateway -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzVoiceServicesCommunicationsGateway -InputObject <IVoiceServicesIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a CommunicationsGateway + +## EXAMPLES + +### Example 1: Update a gateway +```powershell +Update-AzVoiceServicesCommunicationsGateway -ResourceGroupName vtest-communication-rg -Name vsc-gateway-pwsh01 -Tag @{'key1'='value1'} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus vsc-gateway-pwsh01 12/7/2022 7:09:45 AM v-diya@microsoft.com User 12/7/2022 7:09:45 AM v-diya@microsoft.com User vtest-communication-rg +``` + +Update a gateway. + +### Example 2: Update a gateway by pipeline +```powershell +Get-AzVoiceServicesCommunicationsGateway -ResourceGroupName vtest-communication-rg -Name vsc-gateway-pwsh01 | Update-AzVoiceServicesCommunicationsGateway -Tag @{'key1'='value1'} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus vsc-gateway-pwsh01 12/7/2022 7:09:45 AM v-diya@microsoft.com User 12/7/2022 7:09:45 AM v-diya@microsoft.com User vtest-communication-rg +``` + +Update a gateway by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.IVoiceServicesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Unique identifier for this deployment + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: CommunicationsGatewayName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.IVoiceServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.Api20230131.ICommunicationsGateway + +## 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 <IVoiceServicesIdentity>`: Identity Parameter + - `[CommunicationsGatewayName <String>]`: Unique identifier for this deployment + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TestLineName <String>]`: Unique identifier for this test line + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.VoiceServices/Update-AzVoiceServicesCommunicationsTestLine.md b/azps-10.1.0/Az.VoiceServices/Update-AzVoiceServicesCommunicationsTestLine.md new file mode 100644 index 0000000000..e00b130298 --- /dev/null +++ b/azps-10.1.0/Az.VoiceServices/Update-AzVoiceServicesCommunicationsTestLine.md @@ -0,0 +1,230 @@ +--- +external help file: +Module Name: Az.VoiceServices +online version: https://learn.microsoft.com/powershell/module/az.voiceservices/update-azvoiceservicescommunicationstestline +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Update-AzVoiceServicesCommunicationsTestLine.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/VoiceServices/help/Update-AzVoiceServicesCommunicationsTestLine.md +--- + +# Update-AzVoiceServicesCommunicationsTestLine + +## SYNOPSIS +Update a TestLine + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzVoiceServicesCommunicationsTestLine -CommunicationsGatewayName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzVoiceServicesCommunicationsTestLine -InputObject <IVoiceServicesIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Update a TestLine + +## EXAMPLES + +### Example 1: Update a testline +```powershell +Update-AzVoiceServicesCommunicationsTestLine -ResourceGroupName vtest-communication-rg -CommunicationsGatewayName vsc-gateway-pwsh01 -Name testline-01 -Tag @{'key1'='value1'} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus testline-01 12/7/2022 7:56:47 AM v-diya@microsoft.com User 12/7/2022 8:47:44 AM v-diya@microsoft.com User vtest-communication-rg +``` + +Update a testline. + +### Example 2: Update a testline by pipeline +```powershell +Get-AzVoiceServicesCommunicationsTestLine -ResourceGroupName vtest-communication-rg -CommunicationsGatewayName vsc-gateway-pwsh01 -Name testline-01 | Update-AzVoiceServicesCommunicationsTestLine -Tag @{'key1'='value1'} +``` + +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName RetryAfter +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ----------------- ---------- +westcentralus testline-01 12/7/2022 7:56:47 AM v-diya@microsoft.com User 12/7/2022 8:47:44 AM v-diya@microsoft.com User vtest-communication-rg +``` + +Update a testline by pipeline. + +## PARAMETERS + +### -CommunicationsGatewayName +Unique identifier for this deployment + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.IVoiceServicesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Unique identifier for this test line + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: TestLineName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.IVoiceServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.VoiceServices.Models.Api20230131.ITestLine + +## 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 <IVoiceServicesIdentity>`: Identity Parameter + - `[CommunicationsGatewayName <String>]`: Unique identifier for this deployment + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The location in which uniqueness will be verified. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId <String>]`: The ID of the target subscription. + - `[TestLineName <String>]`: Unique identifier for this test line + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Websites/Add-AzWebAppAccessRestrictionRule.md b/azps-10.1.0/Az.Websites/Add-AzWebAppAccessRestrictionRule.md new file mode 100644 index 0000000000..5f3160b4b7 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Add-AzWebAppAccessRestrictionRule.md @@ -0,0 +1,402 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Add-AzWebAppAccessRestrictionRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Add-AzWebAppAccessRestrictionRule.md +--- + +# Add-AzWebAppAccessRestrictionRule + +## SYNOPSIS +Adds an Access Restiction rule to an Azure Web App. + +## SYNTAX + +### IpAddressParameterSet (Default) +``` +Add-AzWebAppAccessRestrictionRule [-ResourceGroupName] <String> [-WebAppName] <String> [-Name <String>] + [-Description <String>] -Priority <UInt32> [-Action <String>] [-SlotName <String>] [-TargetScmSite] + -IpAddress <String> [-PassThru] [-HttpHeader <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ServiceTagParameterSet +``` +Add-AzWebAppAccessRestrictionRule [-ResourceGroupName] <String> [-WebAppName] <String> [-Name <String>] + [-Description <String>] -Priority <UInt32> [-Action <String>] [-SlotName <String>] [-TargetScmSite] + [-PassThru] -ServiceTag <String> [-HttpHeader <Hashtable>] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SubnetNameParameterSet +``` +Add-AzWebAppAccessRestrictionRule [-ResourceGroupName] <String> [-WebAppName] <String> [-Name <String>] + [-Description <String>] -Priority <UInt32> [-Action <String>] [-SlotName <String>] [-TargetScmSite] + -SubnetName <String> -VirtualNetworkName <String> [-IgnoreMissingServiceEndpoint] [-PassThru] + [-HttpHeader <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SubnetIdParameterSet +``` +Add-AzWebAppAccessRestrictionRule [-ResourceGroupName] <String> [-WebAppName] <String> [-Name <String>] + [-Description <String>] -Priority <UInt32> [-Action <String>] [-SlotName <String>] [-TargetScmSite] + -SubnetId <String> [-IgnoreMissingServiceEndpoint] [-PassThru] [-HttpHeader <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzWebAppAccessRestrictionRule** cmdlet adds an Access Restriction rule to an Azure Web App. + +## EXAMPLES + +### Example 1: Add IpAddress Access Restriction rule to a Web App +```powershell +Add-AzWebAppAccessRestrictionRule -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoSite" ` +-Name IpRule -Priority 200 -Action Allow -IpAddress 10.10.0.0/8 +``` + +This command adds an access restriction rule with priority 200 and ip range to a Web App named ContosoSite that belongs to the resource group Default-Web-WestUS. + +### Example 2: Add Subnet Service Endpoint Access Restriction rule to a Web App +```powershell +Add-AzWebAppAccessRestrictionRule -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoSite" ` +-Name SubnetRule -Priority 300 -Action Allow -SubnetName appgw-subnet -VirtualNetworkName corp-vnet +``` + +This command adds an access restriction rule with priority 300 and with subnet appgw-subnet in corp-vnet to a Web App named ContosoSite that belongs to the resource group Default-Web-WestUS. + +### Example 3: Add ServiceTag Access Restriction rule to a Web App +```powershell +Add-AzWebAppAccessRestrictionRule -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoSite" ` +-Name ServiceTagRule -Priority 200 -Action Allow -ServiceTag AzureFrontDoor.Backend +``` + +This command adds an access restriction rule with priority 200 and a Service Tag representing the ip scope of Azure Front Door to a Web App named ContosoSite that belongs to the resource group Default-Web-WestUS. + +### Example 4: Add multi-address Access Restriction rule to a Web App +```powershell +Add-AzWebAppAccessRestrictionRule -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoSite" ` +-Name MultipleIpRule -Priority 200 -Action Allow -IpAddress "10.10.0.0/8,192.168.0.0/16" +``` + +This command adds an access restriction rule with priority 200 and two ip ranges to a Web App named ContosoSite that belongs to the resource group Default-Web-WestUS. + +### Example 5: Add Access Restriction rule with http header to a Web App +```powershell +Add-AzWebAppAccessRestrictionRule -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoSite" ` +-Name MultipleIpRule -Priority 400 -Action Allow -ServiceTag AzureFrontDoor.Backend ` +-HttpHeader @{'x-forwarded-host' = 'www.contoso.com', 'app.contoso.com'; 'x-azure-fdid' = '355deb06-47c4-4ba4-9641-c7d7a98b913e'} +``` + +This command adds an access restriction rule with priority 400 for Service Tag AzureFrontDoor.Backend and further restricts access only to http headers of certain values +to a Web App named ContosoSite that belongs to the resource group Default-Web-WestUS. + +## PARAMETERS + +### -Action +Allow or Deny rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: False +Position: Named +Default value: Allow +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Access Restriction description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpHeader +Http header restrictions. Example: -HttpHeader @{'x-azure-fdid' = '7acacb02-47ea-4cd4-b568-5e880e72582e'; 'x-forwarded-host' = 'www.contoso.com', 'app.contoso.com'} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreMissingServiceEndpoint +Specify if Service Endpoint registration at Subnet should be validated. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SubnetNameParameterSet, SubnetIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddress +Ip Address v4 or v6 CIDR range. E.g.: 192.168.0.0/24 + +```yaml +Type: System.String +Parameter Sets: IpAddressParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Rule Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the access restriction config object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +Access Restriction priority. E.g.: 500. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceTag +Name of Service Tag + +```yaml +Type: System.String +Parameter Sets: ServiceTagParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +Deployment Slot name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +ResourceId of Subnet. + +```yaml +Type: System.String +Parameter Sets: SubnetIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetName +Name of Subnet. + +```yaml +Type: System.String +Parameter Sets: SubnetNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetScmSite +Rule is aimed for Main site or Scm site. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkName +Name of Virtual Network. + +```yaml +Type: System.String +Parameter Sets: SubnetNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebAppName +The name of the web app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSAccessRestrictionConfig + +## NOTES + +## RELATED LINKS + +[Update-AzWebAppAccessRestrictionConfig](./Update-AzWebAppAccessRestrictionConfig.md) + +[Get-AzWebAppAccessRestrictionConfig](./Get-AzWebAppAccessRestrictionConfig.md) + +[Remove-AzWebAppAccessRestrictionRule](./Remove-AzWebAppAccessRestrictionRule.md) diff --git a/azps-10.1.0/Az.Websites/Add-AzWebAppTrafficRouting.md b/azps-10.1.0/Az.Websites/Add-AzWebAppTrafficRouting.md new file mode 100644 index 0000000000..5e000915ee --- /dev/null +++ b/azps-10.1.0/Az.Websites/Add-AzWebAppTrafficRouting.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Add-AzWebAppTrafficRouting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Add-AzWebAppTrafficRouting.md +--- + +# Add-AzWebAppTrafficRouting + +## SYNOPSIS +Add a routing Rule to the Slot. + +## SYNTAX + +``` +Add-AzWebAppTrafficRouting -ResourceGroupName <String> -WebAppName <String> -RoutingRule <Hashtable> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Add-AzWebAppTrafficRouting** cmdlet adds a Routing rule to an Azure Web App Slot. + +## EXAMPLES + +### Example 1: Add a routing rule to transfer 15% of production traffice to Stg slot +```powershell +Add-AzWebAppTrafficRouting -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoSite" -RoutingRule @{ActionHostName='XXXX.azurewebsites.net';ReroutePercentage=15;Name='Stg'} +``` + +This command adds a routing rule to transfer 15% of production traffice to Stg slot + +### Example 2: Add a routing rule to transfer the production traffice to Stg slot ranges from 50% to 90% in incremental manner. +```powershell +Add-AzWebAppTrafficRouting -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoSite" -RoutingRule @{ActionHostName='XXXX.azurewebsites.net';ReroutePercentage=50;ChangeIntervalInMinutes=1;MinReroutePercentage=50;MaxReroutePercentage=90;Name='Stg';ChangeStep=10} +``` + +This command adds a routing rule to transfer the production traffice to Stg slot ranges from 50% to 90% in incremental manner. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingRule +Web App RoutingRule. +Example: -RoutingRule @{ActionHostName=$slot.DefaultHostName ; ReroutePercentage=$ReroutePercentage ; Name=$slotName} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebAppName +WebApp Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.WebSites.Models.RampUpRule + +## NOTES + +## RELATED LINKS + +[Update-AzWebAppTrafficRouting](./Update-AzWebAppTrafficRouting.md) + +[Get-AzWebAppTrafficRouting](./Get-AzWebAppTrafficRouting.md) + +[Remove-AzWebAppTrafficRouting](./Remove-AzWebAppTrafficRouting.md) diff --git a/azps-10.1.0/Az.Websites/Az.Websites.md b/azps-10.1.0/Az.Websites/Az.Websites.md new file mode 100644 index 0000000000..7f9528ca7c --- /dev/null +++ b/azps-10.1.0/Az.Websites/Az.Websites.md @@ -0,0 +1,342 @@ +--- +Module Name: Az.Websites +Module Guid: cc69c625-e961-43f4-8b50-0061eba6e4b6 +Download Help Link: https://learn.microsoft.com/powershell/module/az.websites +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Az.Websites.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Az.Websites.md +--- + +# Az.Websites Module +## Description +ARM (Azure Resource Manager) Web App and App Service Plan commands. + +## Az.Websites Cmdlets +### [Add-AzWebAppAccessRestrictionRule](Add-AzWebAppAccessRestrictionRule.md) +Adds an Access Restiction rule to an Azure Web App. + +### [Add-AzWebAppTrafficRouting](Add-AzWebAppTrafficRouting.md) +Add a routing Rule to the Slot. + +### [Edit-AzWebAppBackupConfiguration](Edit-AzWebAppBackupConfiguration.md) +Edits the current configuration backup for an Azure Web App + +### [Get-AzAppServiceEnvironment](Get-AzAppServiceEnvironment.md) +Gets App Service Environment. If only Resource Group is specified, it will return a list of ASE in the Resource Group. + +### [Get-AzAppServicePlan](Get-AzAppServicePlan.md) +Gets an Azure App Service plan in the specified resource group. + +### [Get-AzDeletedWebApp](Get-AzDeletedWebApp.md) +Gets deleted web apps in the subscription. + +### [Get-AzStaticWebApp](Get-AzStaticWebApp.md) +Description for Gets the details of a static site. + +### [Get-AzStaticWebAppBuild](Get-AzStaticWebAppBuild.md) +Description for Gets the details of a static site build. + +### [Get-AzStaticWebAppBuildAppSetting](Get-AzStaticWebAppBuildAppSetting.md) +Description for Gets the application settings of a static site build. + +### [Get-AzStaticWebAppBuildFunction](Get-AzStaticWebAppBuildFunction.md) +Description for Gets the functions of a particular static site build. + +### [Get-AzStaticWebAppBuildFunctionAppSetting](Get-AzStaticWebAppBuildFunctionAppSetting.md) +Description for Gets the application settings of a static site build. + +### [Get-AzStaticWebAppConfiguredRole](Get-AzStaticWebAppConfiguredRole.md) +Description for Lists the roles configured for the static site. + +### [Get-AzStaticWebAppCustomDomain](Get-AzStaticWebAppCustomDomain.md) +Description for Gets an existing custom domain for a particular static site. + +### [Get-AzStaticWebAppFunction](Get-AzStaticWebAppFunction.md) +Description for Gets the functions of a static site. + +### [Get-AzStaticWebAppFunctionAppSetting](Get-AzStaticWebAppFunctionAppSetting.md) +Description for Gets the application settings of a static site. + +### [Get-AzStaticWebAppSecret](Get-AzStaticWebAppSecret.md) +Description for Lists the secrets for an existing static site. + +### [Get-AzStaticWebAppSetting](Get-AzStaticWebAppSetting.md) +Description for Gets the application settings of a static site. + +### [Get-AzStaticWebAppUser](Get-AzStaticWebAppUser.md) +Description for Gets the list of users of a static site. + +### [Get-AzStaticWebAppUserProvidedFunctionApp](Get-AzStaticWebAppUserProvidedFunctionApp.md) +Description for Gets the details of the user provided function app registered with a static site build + +### [Get-AzWebApp](Get-AzWebApp.md) +Gets Azure Web Apps in the specified resource group. + +### [Get-AzWebAppAccessRestrictionConfig](Get-AzWebAppAccessRestrictionConfig.md) +Gets Access Restriction configuration for an Azure Web App. + +### [Get-AzWebAppBackup](Get-AzWebAppBackup.md) + + +### [Get-AzWebAppBackupConfiguration](Get-AzWebAppBackupConfiguration.md) + + +### [Get-AzWebAppBackupList](Get-AzWebAppBackupList.md) + + +### [Get-AzWebAppCertificate](Get-AzWebAppCertificate.md) +Gets an Azure Web App certificate. + +### [Get-AzWebAppContainerContinuousDeploymentUrl](Get-AzWebAppContainerContinuousDeploymentUrl.md) +Get-AzWebAppContainerContinuousDeploymentUrl will return container continuous deployment url + +### [Get-AzWebAppContinuousWebJob](Get-AzWebAppContinuousWebJob.md) +Get or list continuous web for an app. + +### [Get-AzWebAppPublishingProfile](Get-AzWebAppPublishingProfile.md) +Gets an Azure Web App publishing profile. + +### [Get-AzWebAppSlot](Get-AzWebAppSlot.md) +Gets an Azure Web App slot. + +### [Get-AzWebAppSlotConfigName](Get-AzWebAppSlotConfigName.md) +Get the list of Web App Slot Config names + +### [Get-AzWebAppSlotContinuousWebJob](Get-AzWebAppSlotContinuousWebJob.md) +Get or list continuous web for a deployment slot. + +### [Get-AzWebAppSlotPublishingProfile](Get-AzWebAppSlotPublishingProfile.md) +Gets an Azure Web App slot publishing profile. + +### [Get-AzWebAppSlotTriggeredWebJob](Get-AzWebAppSlotTriggeredWebJob.md) +Get or list triggered web for a deployment slot. + +### [Get-AzWebAppSlotTriggeredWebJobHistory](Get-AzWebAppSlotTriggeredWebJobHistory.md) +Get or list triggered web job's history for a deployment slot. + +### [Get-AzWebAppSlotWebJob](Get-AzWebAppSlotWebJob.md) +List webjobs for a deployment slot. + +### [Get-AzWebAppSnapshot](Get-AzWebAppSnapshot.md) +Gets the snapshots available for a web app. + +### [Get-AzWebAppSSLBinding](Get-AzWebAppSSLBinding.md) +Gets an Azure Web App certificate SSL binding. + +### [Get-AzWebAppTrafficRouting](Get-AzWebAppTrafficRouting.md) +Get a routing Rule for the given Slot name. + +### [Get-AzWebAppTriggeredWebJob](Get-AzWebAppTriggeredWebJob.md) +Get or list triggered web for an app. + +### [Get-AzWebAppTriggeredWebJobHistory](Get-AzWebAppTriggeredWebJobHistory.md) +Get or list triggered web job's history for an app. + +### [Get-AzWebAppWebJob](Get-AzWebAppWebJob.md) +List webjobs for an app. + +### [Import-AzWebAppKeyVaultCertificate](Import-AzWebAppKeyVaultCertificate.md) +Import an SSL certificate to a web app from Key Vault. + +### [New-AzAppServiceEnvironment](New-AzAppServiceEnvironment.md) +Creates an App Service Environment including the recommended Route Table and Network Security Group + +### [New-AzAppServiceEnvironmentInboundServices](New-AzAppServiceEnvironmentInboundServices.md) +Creates inbound services for App Service Environment. For ASEv2 ILB, this will create an Azure Private DNS Zone and records to map to the internal IP. For ASEv3 it will in addition ensure subnet has Network Policy disabled and will create a private endpoint. + +### [New-AzAppServicePlan](New-AzAppServicePlan.md) +Creates an Azure App Service plan in a given Geo location. + +### [New-AzStaticWebApp](New-AzStaticWebApp.md) +Description for Creates a new static site in an existing resource group, or updates an existing static site. + +### [New-AzStaticWebAppBuildAppSetting](New-AzStaticWebAppBuildAppSetting.md) +Description for Creates or updates the app settings of a static site build. + +### [New-AzStaticWebAppBuildFunctionAppSetting](New-AzStaticWebAppBuildFunctionAppSetting.md) +Description for Creates or updates the function app settings of a static site build. + +### [New-AzStaticWebAppCustomDomain](New-AzStaticWebAppCustomDomain.md) +Description for Creates a new static site custom domain in an existing resource group and static site. + +### [New-AzStaticWebAppFunctionAppSetting](New-AzStaticWebAppFunctionAppSetting.md) +Description for Creates or updates the function app settings of a static site. + +### [New-AzStaticWebAppSetting](New-AzStaticWebAppSetting.md) +Description for Creates or updates the app settings of a static site. + +### [New-AzStaticWebAppUserRoleInvitationLink](New-AzStaticWebAppUserRoleInvitationLink.md) +Description for Creates an invitation link for a user with the role + +### [New-AzWebApp](New-AzWebApp.md) +Creates an Azure Web App. + +### [New-AzWebAppAzureStoragePath](New-AzWebAppAzureStoragePath.md) +Creates an object that represents an Azure Storage path to be mounted in a Web App. It is meant to be used as a parameter (-AzureStoragePath) to Set-AzWebApp and Set-AzWebAppSlot + +### [New-AzWebAppBackup](New-AzWebAppBackup.md) +Creates an Azure Web App Backup. + +### [New-AzWebAppCertificate](New-AzWebAppCertificate.md) +Creates an App service managed certificate for an Azure Web App. + +### [New-AzWebAppDatabaseBackupSetting](New-AzWebAppDatabaseBackupSetting.md) +Creates a new Azure Web App Backup setting. + +### [New-AzWebAppSlot](New-AzWebAppSlot.md) +Creates an Azure Web App slot. + +### [New-AzWebAppSSLBinding](New-AzWebAppSSLBinding.md) +Creates an SSL certificate binding for an Azure Web App. + +### [Publish-AzWebApp](Publish-AzWebApp.md) +Deploys an Azure Web App from a ZIP, JAR, or WAR file using zipdeploy. + +### [Register-AzStaticWebAppUserProvidedFunctionApp](Register-AzStaticWebAppUserProvidedFunctionApp.md) +Description for Register a user provided function app with a static site build + +### [Remove-AzAppServiceEnvironment](Remove-AzAppServiceEnvironment.md) +Remove App Service Environment. + +### [Remove-AzAppServicePlan](Remove-AzAppServicePlan.md) +Removes an Azure App Service plan. + +### [Remove-AzStaticWebApp](Remove-AzStaticWebApp.md) +Description for Deletes a static site. + +### [Remove-AzStaticWebAppAttachedRepository](Remove-AzStaticWebAppAttachedRepository.md) +Description for Detaches a static site. + +### [Remove-AzStaticWebAppBuild](Remove-AzStaticWebAppBuild.md) +Description for Deletes a static site build. + +### [Remove-AzStaticWebAppCustomDomain](Remove-AzStaticWebAppCustomDomain.md) +Description for Deletes a custom domain. + +### [Remove-AzStaticWebAppUser](Remove-AzStaticWebAppUser.md) +Description for Deletes the user entry from the static site. + +### [Remove-AzWebApp](Remove-AzWebApp.md) +Removes an Azure Web App. + +### [Remove-AzWebAppAccessRestrictionRule](Remove-AzWebAppAccessRestrictionRule.md) +Removes an Access Restriction rule from an Azure Web App. + +### [Remove-AzWebAppBackup](Remove-AzWebAppBackup.md) + + +### [Remove-AzWebAppCertificate](Remove-AzWebAppCertificate.md) +Removes an App service managed certificate for an Azure Web App. + +### [Remove-AzWebAppContinuousWebJob](Remove-AzWebAppContinuousWebJob.md) +Delete a continuous web job for an app. + +### [Remove-AzWebAppSlot](Remove-AzWebAppSlot.md) + + +### [Remove-AzWebAppSlotContinuousWebJob](Remove-AzWebAppSlotContinuousWebJob.md) +Delete a continuous web job for a deployment slot. + +### [Remove-AzWebAppSlotTriggeredWebJob](Remove-AzWebAppSlotTriggeredWebJob.md) +Delete a triggered web job for a deployment slot. + +### [Remove-AzWebAppSSLBinding](Remove-AzWebAppSSLBinding.md) +Removes an SSL binding from an uploaded certificate. + +### [Remove-AzWebAppTrafficRouting](Remove-AzWebAppTrafficRouting.md) +Remove a routing Rule from the Slot. + +### [Remove-AzWebAppTriggeredWebJob](Remove-AzWebAppTriggeredWebJob.md) +Delete a triggered web job for an app. + +### [Reset-AzStaticWebAppApiKey](Reset-AzStaticWebAppApiKey.md) +Description for Resets the api key for an existing static site. + +### [Reset-AzWebAppPublishingProfile](Reset-AzWebAppPublishingProfile.md) +Resets the publishing profile for the specified Web App. + +### [Reset-AzWebAppSlotPublishingProfile](Reset-AzWebAppSlotPublishingProfile.md) + + +### [Restart-AzWebApp](Restart-AzWebApp.md) +Restarts an Azure Web App. + +### [Restart-AzWebAppSlot](Restart-AzWebAppSlot.md) +Restarts an Azure Web App Slot. + +### [Restore-AzDeletedWebApp](Restore-AzDeletedWebApp.md) +Restores a deleted web app to a new or existing web app. + +### [Restore-AzWebAppBackup](Restore-AzWebAppBackup.md) +Restores an Azure Web App Backup. + +### [Restore-AzWebAppSnapshot](Restore-AzWebAppSnapshot.md) +Restores a web app snapshot. + +### [Set-AzAppServicePlan](Set-AzAppServicePlan.md) +Sets an Azure App Service plan. + +### [Set-AzWebApp](Set-AzWebApp.md) +Modifies an Azure Web App. + +### [Set-AzWebAppSlot](Set-AzWebAppSlot.md) +Modifies an Azure Web App slot. + +### [Set-AzWebAppSlotConfigName](Set-AzWebAppSlotConfigName.md) +Set Web App Slot Config names + +### [Start-AzWebApp](Start-AzWebApp.md) +Starts an Azure Web App. + +### [Start-AzWebAppContinuousWebJob](Start-AzWebAppContinuousWebJob.md) +Start a continuous web job for an app. + +### [Start-AzWebAppSlot](Start-AzWebAppSlot.md) +Starts an Azure Web App slot. + +### [Start-AzWebAppSlotContinuousWebJob](Start-AzWebAppSlotContinuousWebJob.md) +Start a continuous web job for a deployment slot. + +### [Start-AzWebAppSlotTriggeredWebJob](Start-AzWebAppSlotTriggeredWebJob.md) +Run a triggered web job for a deployment slot. + +### [Start-AzWebAppTriggeredWebJob](Start-AzWebAppTriggeredWebJob.md) +Run a triggered web job for an app. + +### [Stop-AzWebApp](Stop-AzWebApp.md) +Stops an Azure Web App. + +### [Stop-AzWebAppContinuousWebJob](Stop-AzWebAppContinuousWebJob.md) +Stop a continuous web job for an app. + +### [Stop-AzWebAppSlot](Stop-AzWebAppSlot.md) +Stops an Azure Web App slot. + +### [Stop-AzWebAppSlotContinuousWebJob](Stop-AzWebAppSlotContinuousWebJob.md) +Stop a continuous web job for a deployment slot. + +### [Switch-AzWebAppSlot](Switch-AzWebAppSlot.md) +Swap two slots within a Web App + +### [Test-AzStaticWebAppCustomDomain](Test-AzStaticWebAppCustomDomain.md) +Description for Validates a particular custom domain can be added to a static site. + +### [Unregister-AzStaticWebAppBuildUserProvidedFunctionApp](Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md) +Description for Detach the user provided function app from the static site build + +### [Unregister-AzStaticWebAppUserProvidedFunctionApp](Unregister-AzStaticWebAppUserProvidedFunctionApp.md) +Description for Detach the user provided function app from the static site + +### [Update-AzStaticWebApp](Update-AzStaticWebApp.md) +Description for Creates a new static site in an existing resource group, or updates an existing static site. + +### [Update-AzStaticWebAppUser](Update-AzStaticWebAppUser.md) +Description for Updates a user entry with the listed roles + +### [Update-AzWebAppAccessRestrictionConfig](Update-AzWebAppAccessRestrictionConfig.md) +Updates the inheritance of Main site Access Restiction config to SCM Site for an Azure Web App. + +### [Update-AzWebAppTrafficRouting](Update-AzWebAppTrafficRouting.md) +Update a routing Rule to the Slot. + diff --git a/azps-10.1.0/Az.Websites/Edit-AzWebAppBackupConfiguration.md b/azps-10.1.0/Az.Websites/Edit-AzWebAppBackupConfiguration.md new file mode 100644 index 0000000000..c6d0559d1e --- /dev/null +++ b/azps-10.1.0/Az.Websites/Edit-AzWebAppBackupConfiguration.md @@ -0,0 +1,274 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +ms.assetid: BFC38930-DBB4-4EBB-8E29-73B901FAF486 +online version: https://learn.microsoft.com/powershell/module/az.websites/edit-azwebappbackupconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Edit-AzWebAppBackupConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Edit-AzWebAppBackupConfiguration.md +--- + +# Edit-AzWebAppBackupConfiguration + +## SYNOPSIS +Edits the current configuration backup for an Azure Web App + +## SYNTAX + +### FromResourceName +``` +Edit-AzWebAppBackupConfiguration [-FrequencyInterval] <Int32> [-FrequencyUnit] <String> + [-RetentionPeriodInDays] <Int32> [[-StartTime] <DateTime>] [-KeepAtLeastOneBackup] [-Enabled] + [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] [-DefaultProfile <IAzureContextContainer>] + [-StorageAccountUrl] <String> [[-Databases] <DatabaseBackupSetting[]>] [<CommonParameters>] +``` + +### FromWebApp +``` +Edit-AzWebAppBackupConfiguration [-FrequencyInterval] <Int32> [-FrequencyUnit] <String> + [-RetentionPeriodInDays] <Int32> [[-StartTime] <DateTime>] [-KeepAtLeastOneBackup] [-Enabled] + [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [-StorageAccountUrl] <String> + [[-Databases] <DatabaseBackupSetting[]>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Edit-AzWebAppBackupConfiguration** cmdlet edits the current configuration backup for an Azure Web App. + +## EXAMPLES + +### Example 1 + +The Edit-AzWebAppBackupConfiguration cmdlet edits the current configuration backup for an Azure Web App. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Edit-AzWebAppBackupConfiguration -FrequencyInterval <Int32> -FrequencyUnit <String> -KeepAtLeastOneBackup -Name IpRule -ResourceGroupName MyResourceGroup -RetentionPeriodInDays <Int32> -StartTime 2016-11-30T22:00:00Z -StorageAccountUrl 'https://storageaccount.file.core.windows.net' +``` + +## PARAMETERS + +### -Databases +Databases of type DatabaseBackupSetting[] + +```yaml +Type: Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Keep At Least One Backup Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrequencyInterval +Frequency Interval + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FrequencyUnit +Frequency Unit + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -KeepAtLeastOneBackup +Keep At Least One Backup Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RetentionPeriodInDays +Retention Period In Days + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Slot +WebApp Slot Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartTime +StartTime in UTC + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountUrl +Storage Account Url + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: FromWebApp +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 + +### System.String + +### System.DateTime + +### System.Management.Automation.SwitchParameter + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +### Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting[] + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackupConfiguration + +## NOTES + +## RELATED LINKS + +[Get-AzWebAppBackupConfiguration](./Get-AzWebAppBackupConfiguration.md) + + diff --git a/azps-10.1.0/Az.Websites/Get-AzAppServiceEnvironment.md b/azps-10.1.0/Az.Websites/Get-AzAppServiceEnvironment.md new file mode 100644 index 0000000000..56976fbf6b --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzAppServiceEnvironment.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azappserviceenvironment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzAppServiceEnvironment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzAppServiceEnvironment.md +--- + +# Get-AzAppServiceEnvironment + +## SYNOPSIS +Gets App Service Environment. If only Resource Group is specified, it will return a list of ASE in the Resource Group. + +## SYNTAX + +``` +Get-AzAppServiceEnvironment [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzAppServiceEnvironment** cmdlet return ASE(s) matching the query. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzAppServiceEnvironment -ResourceGroupName MyResourceGroup -Name MyAseName +``` + +Returns a specific App Service Environment named `<MyAseName>` in `<MyResourceGroup>` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the app service environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServiceEnvironment + +## NOTES + +## RELATED LINKS + +[New-AzAppServiceEnvironment](./New-AzAppServiceEnvironment.md) + +[New-AzAppServiceEnvironmentInboundServices](./New-AzAppServiceEnvironmentInboundServices.md) + +[Remove-AzAppServiceEnvironment](./Remove-AzAppServiceEnvironment.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Websites/Get-AzAppServicePlan.md b/azps-10.1.0/Az.Websites/Get-AzAppServicePlan.md new file mode 100644 index 0000000000..be8e32351f --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzAppServicePlan.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 89ED4231-7616-47D0-BDAA-D849C245DC79 +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azappserviceplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzAppServicePlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzAppServicePlan.md +--- + +# Get-AzAppServicePlan + +## SYNOPSIS +Gets an Azure App Service plan in the specified resource group. + +## SYNTAX + +### S1 +``` +Get-AzAppServicePlan [[-ResourceGroupName] <String>] [[-Name] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Get-AzAppServicePlan [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzAppServicePlan** cmdlet gets an Azure App Service plan in the specified resource group. + +## EXAMPLES + +### Example 1: Get an App Service plan from a resource group +```powershell +Get-AzAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" +``` + +This command gets the App Service plan named ContosoASP that belongs to the resource group named Default-Web-WestUS. + +### Example 2: Get all App Service plans in a location +```powershell +Get-AzAppServicePlan -Location "West US" +``` + +This command gets all App Service plans located in the "West US" region. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location + +```yaml +Type: System.String +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +App Service Plan Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan + +## NOTES + +## RELATED LINKS + +[New-AzAppServicePlan](./New-AzAppServicePlan.md) + +[Remove-AzAppServicePlan](./Remove-AzAppServicePlan.md) + +[Set-AzAppServicePlan](./Set-AzAppServicePlan.md) + + diff --git a/azps-10.1.0/Az.Websites/Get-AzDeletedWebApp.md b/azps-10.1.0/Az.Websites/Get-AzDeletedWebApp.md new file mode 100644 index 0000000000..5a5a28a718 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzDeletedWebApp.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azdeletedwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzDeletedWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzDeletedWebApp.md +--- + +# Get-AzDeletedWebApp + +## SYNOPSIS +Gets deleted web apps in the subscription. + +## SYNTAX + +``` +Get-AzDeletedWebApp [[-ResourceGroupName] <String>] [[-Name] <String>] [[-Slot] <String>] [-Location <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzDeletedWebApp** cmdlet returns all deleted web apps in the subscription. Deleted apps can optionally be filtered by resource group, name, and slot. There can be more than one deleted app with the same name and resource group. Check the DeletionTime to distinguish deleted apps that share the same name. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzDeletedWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" +``` + +This command gets the deleted apps named ContosoSite belonging to the resource group Default-Web-WestUS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The location of the deleted app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the web app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +The name of the web app slot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.PSAzureDeletedWebApp + +## NOTES + +## RELATED LINKS + +[Restore-AzDeletedWebApp](./Restore-AzDeletedWebApp.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Websites/Get-AzStaticWebApp.md b/azps-10.1.0/Az.Websites/Get-AzStaticWebApp.md new file mode 100644 index 0000000000..1d2264ab5c --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzStaticWebApp.md @@ -0,0 +1,312 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebApp.md +--- + +# Get-AzStaticWebApp + +## SYNOPSIS +Description for Gets the details of a static site. + +## SYNTAX + +### List (Default) +``` +Get-AzStaticWebApp [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get +``` +Get-AzStaticWebApp -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### List1 +``` +Get-AzStaticWebApp -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStaticWebApp -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Gets the details of a static site. + +## EXAMPLES + +### Example 1: List all static web applications under a subscription +```powershell +Get-AzStaticWebApp +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb-portal04 Microsoft.Web/staticSites + East US 2 staticweb-portal02 Microsoft.Web/staticSites +``` + +This commands list all static web applications under a subscription. + +### Example 2: List all static web applications under a resource group +```powershell +Get-AzStaticWebApp -ResourceGroupName azure-rg-test +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb-portal04 Microsoft.Web/staticSites + East US 2 staticweb-portal02 Microsoft.Web/staticSites +``` + +This commands list all static web applications under a resource group. + +### Example 3: Get a satic web application by name +```powershell +Get-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb-portal04 +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb-portal04 Microsoft.Web/staticSites +``` + +This commands gets a satic web application by name. + +### Example 4: Get a satic web application by pipline +```powershell +New-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb-pwsh01 -Location eastus2 -RepositoryUrl 'https://github.com/username/RepoName' -RepositoryToken 'repoToken123' -Branch 'master' -AppLocation 'Client' -ApiLocation 'Api' -OutputLocation 'wwwroot' -SkuName 'free' | Get-AzStaticWebApp +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb-portal04 Microsoft.Web/staticSites +``` + +This commands gets a satic web application by pipline. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: List, Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzStaticWebAppBuild.md b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppBuild.md new file mode 100644 index 0000000000..9a88342ba0 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppBuild.md @@ -0,0 +1,307 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappbuild +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppBuild.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppBuild.md +--- + +# Get-AzStaticWebAppBuild + +## SYNOPSIS +Description for Gets the details of a static site build. + +## SYNTAX + +### List (Default) +``` +Get-AzStaticWebAppBuild -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get +``` +Get-AzStaticWebAppBuild -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStaticWebAppBuild -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Gets the details of a static site build. + +## EXAMPLES + +### Example 1: List all builds under a static web app +```powershell +Get-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal04 +``` + +```output +Kind Name Type +---- ---- ---- + default Microsoft.Web/staticSites/builds +``` + +This command list all builds under a static web app. +Automaticall create a new build in static web app When creating a new pull request for branch. + +### Example 2: Get the details of a static site build +```powershell +Get-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal04 -EnvironmentName 'default' +``` + +```output +Kind Name Type +---- ---- ---- + default Microsoft.Web/staticSites/builds +``` + +This command gets the details of a static site build. + +### Example 3: Get the details of a static site build pipeline +```powershell +Get-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal04 | Get-AzStaticWebAppBuild +``` + +```output +Kind Name Type +---- ---- ---- + default Microsoft.Web/staticSites/builds +``` + +This command gets the details of a static site build by pipeline. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: Get +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.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteBuildArmResource + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzStaticWebAppBuildAppSetting.md b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppBuildAppSetting.md new file mode 100644 index 0000000000..b2cfd7b942 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppBuildAppSetting.md @@ -0,0 +1,256 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappbuildappsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppBuildAppSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppBuildAppSetting.md +--- + +# Get-AzStaticWebAppBuildAppSetting + +## SYNOPSIS +Description for Gets the application settings of a static site build. + +## SYNTAX + +``` +Get-AzStaticWebAppBuildAppSetting -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Gets the application settings of a static site build. + +## EXAMPLES + +### Example 1: Get the application settings of a static web build +```powershell +Get-AzStaticWebAppBuildAppSetting -ResourceGroupName azure-rg-test -Name staticweb-portal04 -EnvironmentName 'default' +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/builds/config +``` + +This command gets the application settings of a static web build. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +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.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzStaticWebAppBuildFunction.md b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppBuildFunction.md new file mode 100644 index 0000000000..7e6549716d --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppBuildFunction.md @@ -0,0 +1,225 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappbuildfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppBuildFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppBuildFunction.md +--- + +# Get-AzStaticWebAppBuildFunction + +## SYNOPSIS +Description for Gets the functions of a particular static site build. + +## SYNTAX + +``` +Get-AzStaticWebAppBuildFunction -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Gets the functions of a particular static site build. + +## EXAMPLES + +### Example 1: List all functions of a particular static site build +```powershell +Get-AzStaticWebAppBuildFunction -ResourceGroupName lucas-rg-test -Name staticweb-portal04 -EnvironmentName 'default' +``` + +```output +Kind Name Type +---- ---- ---- + WeatherForecast Microsoft.Web/staticSites/builds/functions +``` + +This command lists all functions of a particular static site build. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +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.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteFunctionOverviewArmResource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzStaticWebAppBuildFunctionAppSetting.md b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppBuildFunctionAppSetting.md new file mode 100644 index 0000000000..a0cbfe8704 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppBuildFunctionAppSetting.md @@ -0,0 +1,256 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappbuildfunctionappsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppBuildFunctionAppSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppBuildFunctionAppSetting.md +--- + +# Get-AzStaticWebAppBuildFunctionAppSetting + +## SYNOPSIS +Description for Gets the application settings of a static site build. + +## SYNTAX + +``` +Get-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Gets the application settings of a static site build. + +## EXAMPLES + +### Example 1: List all application settings of a static site build +```powershell +Get-AzStaticWebAppBuildFunctionAppSetting -ResourceGroupName azure-rg-test -Name staticweb-portal04 -EnvironmentName 'default' +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/builds/config/functionappsettings +``` + +This command lists all application settings of a static site build. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +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.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzStaticWebAppConfiguredRole.md b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppConfiguredRole.md new file mode 100644 index 0000000000..f09c463d37 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppConfiguredRole.md @@ -0,0 +1,241 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappconfiguredrole +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppConfiguredRole.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppConfiguredRole.md +--- + +# Get-AzStaticWebAppConfiguredRole + +## SYNOPSIS +Description for Lists the roles configured for the static site. + +## SYNTAX + +``` +Get-AzStaticWebAppConfiguredRole -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Lists the roles configured for the static site. + +## EXAMPLES + +### Example 1: Lists the roles configured for the static site +```powershell +Get-AzStaticWebAppConfiguredRole -ResourceGroupName azure-rg-test -Name staticweb-portal04 +``` + +```output +Kind Name Type Property +---- ---- ---- -------- + configuredRoles Microsoft.Web/staticSites/configuredRoles {anonymous, authenticated} +``` + +This command lists the roles configured for the static site. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringList + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzStaticWebAppCustomDomain.md b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppCustomDomain.md new file mode 100644 index 0000000000..f952f156d2 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppCustomDomain.md @@ -0,0 +1,306 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppCustomDomain.md +--- + +# Get-AzStaticWebAppCustomDomain + +## SYNOPSIS +Description for Gets an existing custom domain for a particular static site. + +## SYNTAX + +### List (Default) +``` +Get-AzStaticWebAppCustomDomain -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get +``` +Get-AzStaticWebAppCustomDomain -DomainName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStaticWebAppCustomDomain -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Gets an existing custom domain for a particular static site. + +## EXAMPLES + +### Example 1: List all existing custom domains for a particular static site +```powershell +Get-AzStaticWebAppCustomDomain -ResourceGroupName azure-rg-test -Name staticweb00 +``` + +```output +Kind Name Type +---- ---- ---- + www01.azpstest.net Microsoft.Web/staticSites/customDomains +``` + +This command lists all existing custom domains for a particular static site. + +### Example 2: Get an existing custom domain for a particular static site +```powershell +Get-AzStaticWebAppCustomDomain -ResourceGroupName azure-rg-test -Name staticweb00 -DomainName 'www02.azpstest.net' +``` + +```output +Kind Name Type +---- ---- ---- + www02.azpstest.net Microsoft.Web/staticSites/customDomains +``` + +This command gets an existing custom domain for a particular static site. + +### Example 3: Get an existing custom domain for a particular static site by pipeline +```powershell +New-AzStaticWebAppCustomDomain -ResourceGroupName azure-rg-test -Name staticweb00 -DomainName 'www02.azpstest.net' | Get-AzStaticWebAppCustomDomain +``` + +```output +Kind Name Type +---- ---- ---- + www02.azpstest.net Microsoft.Web/staticSites/customDomains +``` + +This command gets an existing custom domain for a particular static site by pipeline. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +The custom domain name. + +```yaml +Type: System.String +Parameter Sets: Get +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.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site resource to search in. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteCustomDomainOverviewArmResource + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzStaticWebAppFunction.md b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppFunction.md new file mode 100644 index 0000000000..4170f86fa6 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppFunction.md @@ -0,0 +1,204 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappfunction +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppFunction.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppFunction.md +--- + +# Get-AzStaticWebAppFunction + +## SYNOPSIS +Description for Gets the functions of a static site. + +## SYNTAX + +``` +Get-AzStaticWebAppFunction -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Gets the functions of a static site. + +## EXAMPLES + +### Example 1: Get the functions of a static site +```powershell +Get-AzStaticWebAppFunction -ResourceGroupName azure-rg-test -Name staticweb-portal04 +``` + +This command get the functions of a static site. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteFunctionOverviewArmResource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzStaticWebAppFunctionAppSetting.md b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppFunctionAppSetting.md new file mode 100644 index 0000000000..e71c2d9c4a --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppFunctionAppSetting.md @@ -0,0 +1,241 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappfunctionappsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppFunctionAppSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppFunctionAppSetting.md +--- + +# Get-AzStaticWebAppFunctionAppSetting + +## SYNOPSIS +Description for Gets the application settings of a static site. + +## SYNTAX + +``` +Get-AzStaticWebAppFunctionAppSetting -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Gets the application settings of a static site. + +## EXAMPLES + +### Example 1: Get the application settings of a static site +```powershell +Get-AzStaticWebAppFunctionAppSetting -ResourceGroupName azure-rg-test -Name staticweb-portal04 +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/config/functionappsettings +``` + +This command gets the application settings of a static site. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzStaticWebAppSecret.md b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppSecret.md new file mode 100644 index 0000000000..443ef22817 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppSecret.md @@ -0,0 +1,241 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappsecret +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppSecret.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppSecret.md +--- + +# Get-AzStaticWebAppSecret + +## SYNOPSIS +Description for Lists the secrets for an existing static site. + +## SYNTAX + +``` +Get-AzStaticWebAppSecret -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Lists the secrets for an existing static site. + +## EXAMPLES + +### Example 1: List the secrets for an existing static site +```powershell +Get-AzStaticWebAppSecret -ResourceGroupName resourceGroup -Name staticweb-portal04 +``` + +```output +Kind Name Type +---- ---- ---- + secrets Microsoft.Web/staticSites/secrets +``` + +This command lists the secrets for an existing static site. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzStaticWebAppSetting.md b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppSetting.md new file mode 100644 index 0000000000..999c894cea --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppSetting.md @@ -0,0 +1,241 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppSetting.md +--- + +# Get-AzStaticWebAppSetting + +## SYNOPSIS +Description for Gets the application settings of a static site. + +## SYNTAX + +``` +Get-AzStaticWebAppSetting -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Gets the application settings of a static site. + +## EXAMPLES + +### Example 1: Get the application settings of a static site +```powershell +Get-AzStaticWebAppSetting -ResourceGroupName resourceGroup -Name staticweb00 +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/config +``` + +This command gets the application settings of a static site. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzStaticWebAppUser.md b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppUser.md new file mode 100644 index 0000000000..3e1c67feab --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppUser.md @@ -0,0 +1,256 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppUser.md +--- + +# Get-AzStaticWebAppUser + +## SYNOPSIS +Description for Gets the list of users of a static site. + +## SYNTAX + +``` +Get-AzStaticWebAppUser -AuthProvider <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Gets the list of users of a static site. + +## EXAMPLES + +### Example 1: Get the list of users of a static site +```powershell +Get-AzStaticWebAppUser -ResourceGroupName azure-rg-test -Name staticweb-portal04 -Authprovider all +``` + +```output +Kind Name Type +---- ---- ---- + c387198f0a7f44748184c9da92cbe241 Microsoft.Web/staticSites/users +``` + +This command gets the list of users of a static site. + +## PARAMETERS + +### -AuthProvider +The auth provider for the users. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserArmResource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzStaticWebAppUserProvidedFunctionApp.md b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppUserProvidedFunctionApp.md new file mode 100644 index 0000000000..9f3a0bc476 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzStaticWebAppUserProvidedFunctionApp.md @@ -0,0 +1,363 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azstaticwebappuserprovidedfunctionapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppUserProvidedFunctionApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzStaticWebAppUserProvidedFunctionApp.md +--- + +# Get-AzStaticWebAppUserProvidedFunctionApp + +## SYNOPSIS +Description for Gets the details of the user provided function app registered with a static site build + +## SYNTAX + +### List1 (Default) +``` +Get-AzStaticWebAppUserProvidedFunctionApp -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### List +``` +Get-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get +``` +Get-AzStaticWebAppUserProvidedFunctionApp -EnvironmentName <String> -FunctionAppName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### List2 +``` +Get-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzStaticWebAppUserProvidedFunctionApp -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Gets the details of the user provided function app registered with a static site build + +## EXAMPLES + +### Example 1: List the details of the user provided function apps registered with a static site +```powershell +Get-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName resourceGroup -Name staticweb00 +``` + +```output +Kind Name Type +---- ---- ---- + functionApp-5enjko Microsoft.Web/staticSites/userProvidedFunctionApps +``` + +This command lists the details of the user provided function apps registered with a static site + +### Example 2: List the details of the user provided function apps registered with a static site build +```powershell +Get-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName resourceGroup -Name staticweb00 -EnvironmentName 'default' +``` + +```output +Kind Name Type +---- ---- ---- + functionApp-5enjko Microsoft.Web/staticSites/builds/userProvidedFunctionApps +``` + +This command lists the details of the user provided function apps registered with a static site build. + +### Example 3: List the details of the user provided function apps registered +```powershell +Get-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName resourceGroup -Name staticweb00 -FunctionAppName $env.functionAppName01 +``` + +```output +Kind Name Type +---- ---- ---- + functionApp-5enjko Microsoft.Web/staticSites/builds/userProvidedFunctionApps +``` + +This command lists the details of the user provided function apps registered. + +### Example 4: Get the details of the user provided function app registered with a static site build +```powershell +Get-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName resourceGroup -Name staticweb00 -EnvironmentName 'default' -FunctionAppName $env.functionAppName01 +``` + +```output +Kind Name Type +---- ---- ---- + functionApp-5enjko Microsoft.Web/staticSites/builds/userProvidedFunctionApps +``` + +This command gets the details of the user provided function app registered with a static site build. + +### Example 5: Get the details of the user provided function apps registered with a static site build by pipeline +```powershell +Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName lucas-rg-test -Name staticweb-pwsh02 -FunctionAppName functionapp-portal02 -FunctionAppResourceId '/subscriptions/xxxxxx-xx-xxx-xxxx-xxxxx/resourcegroups/xxx-xx-xxxx/providers/Microsoft.Web/sites/functionapp-portal02' -FunctionAppRegion 'Central US' -EnvironmentName 5 | Get-AzStaticWebAppUserProvidedFunctionApp +``` + +```output +Kind Name Type +---- ---- ---- + functionApp-5enjko Microsoft.Web/staticSites/builds/userProvidedFunctionApps +``` + +This command gets the details of the user provided function app registered with a static site build by pipeline. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunctionAppName +Name of the function app registered with the static site build. + +```yaml +Type: System.String +Parameter Sets: Get, List2 +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.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: List1, List, Get, List2 +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: List1, List, Get, List2 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: List1, List, Get, List2 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserProvidedFunctionAppArmResource + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebApp.md b/azps-10.1.0/Az.Websites/Get-AzWebApp.md new file mode 100644 index 0000000000..926c0e8391 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebApp.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: A87ED954-9C09-4329-A005-ABFF36C45E6E +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebApp.md +--- + +# Get-AzWebApp + +## SYNOPSIS +Gets Azure Web Apps in the specified resource group. + +## SYNTAX + +### S1 +``` +Get-AzWebApp [[-ResourceGroupName] <String>] [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### S2 +``` +Get-AzWebApp [-AppServicePlan] <PSAppServicePlan> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### S3 +``` +Get-AzWebApp [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzWebApp** cmdlet gets information about an Azure Web App. + +## EXAMPLES + +### Example 1: Get a Web App from a resource group +```powershell +Get-AzWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" +``` + +This command gets the Web App named ContosoSite that belongs to the resource group Default-Web-WestUS. + +## PARAMETERS + +### -AppServicePlan +App Service Plan object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location + +```yaml +Type: System.String +Parameter Sets: S3 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES + +## RELATED LINKS + +[New-AzWebApp](./New-AzWebApp.md) + +[Remove-AzWebApp](./Remove-AzWebApp.md) + +[Restart-AzWebApp](./Restart-AzWebApp.md) + +[Start-AzWebApp](./Start-AzWebApp.md) + +[Stop-AzWebApp](./Stop-AzWebApp.md) + + diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppAccessRestrictionConfig.md b/azps-10.1.0/Az.Websites/Get-AzWebAppAccessRestrictionConfig.md new file mode 100644 index 0000000000..352e7ab9ae --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppAccessRestrictionConfig.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppAccessRestrictionConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppAccessRestrictionConfig.md +--- + +# Get-AzWebAppAccessRestrictionConfig + +## SYNOPSIS +Gets Access Restriction configuration for an Azure Web App. + +## SYNTAX + +``` +Get-AzWebAppAccessRestrictionConfig [-ResourceGroupName] <String> [-Name] <String> [[-SlotName] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzWebAppAccessRestrictionConfig** cmdlet gets Access Restriction config about an Azure Web App. + +## EXAMPLES + +### Example 1: Get a Web App Access Restriction Config from a resource group +```powershell +Get-AzWebAppAccessRestrictionConfig -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" +``` + +This command gets the access restriction config of a Web App named ContosoSite that belongs to the resource group Default-Web-WestUS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SlotName +Deployment Slot name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSAccessRestrictionConfig + +## NOTES + +## RELATED LINKS + +[Update-AzWebAppAccessRestrictionConfig](./Update-AzWebAppAccessRestrictionConfig.md) + +[Add-AzWebAppAccessRestrictionRule](./Add-AzWebAppAccessRestrictionRule.md) + +[Remove-AzWebAppAccessRestrictionRule](./Remove-AzWebAppAccessRestrictionRule.md) diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppBackup.md b/azps-10.1.0/Az.Websites/Get-AzWebAppBackup.md new file mode 100644 index 0000000000..0abb824d47 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppBackup.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: EAAF615B-6139-438B-A2FD-6966E72B3AA9 +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppBackup.md +--- + +# Get-AzWebAppBackup + +## SYNOPSIS + +## SYNTAX + +### FromResourceName +``` +Get-AzWebAppBackup [-BackupId] <String> [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### FromWebApp +``` +Get-AzWebAppBackup [-BackupId] <String> [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzWebAppBackup** cmdlet gets the specified backup of an Azure Web App. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzWebAppBackup -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" -BackupId "12345" +``` + +This command gets the backup with ID "12345" from the Web App named WebAppStandard that belongs to the resource group Default-Web-WestUS. + +## PARAMETERS + +### -BackupId +Backup Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Webapp Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Slot +Slot Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WebApp +Piped WebApp + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: FromWebApp +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppBackupConfiguration.md b/azps-10.1.0/Az.Websites/Get-AzWebAppBackupConfiguration.md new file mode 100644 index 0000000000..d9824bf607 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppBackupConfiguration.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 8337BEA9-4927-4718-83B9-F3F567BE0FBD +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappbackupconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppBackupConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppBackupConfiguration.md +--- + +# Get-AzWebAppBackupConfiguration + +## SYNOPSIS + +## SYNTAX + +### FromResourceName +``` +Get-AzWebAppBackupConfiguration [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### FromWebApp +``` +Get-AzWebAppBackupConfiguration [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzWebAppBackupConfiguration** cmdlet gets the backup configuration of an Azure Web App. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzWebAppBackupConfiguration -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" +``` + +This command gets the backup configuration from the Web App named WebAppStandard that belongs to the resource group Default-Web-WestUS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Slot +Slot Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WebApp +WebApp Name + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: FromWebApp +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackupConfiguration + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppBackupList.md b/azps-10.1.0/Az.Websites/Get-AzWebAppBackupList.md new file mode 100644 index 0000000000..fd3e0c5758 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppBackupList.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: BBC85035-DCF7-44FA-A747-A1563A55B820 +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappbackuplist +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppBackupList.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppBackupList.md +--- + +# Get-AzWebAppBackupList + +## SYNOPSIS + +## SYNTAX + +### FromResourceName +``` +Get-AzWebAppBackupList [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### FromWebApp +``` +Get-AzWebAppBackupList [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzWebAppBackupList** cmdlet gets a list of backups for an Azure Web App. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzWebAppBackupList -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" +``` + +This command returns a backup list pertaining to WebApp WebAppStandard associated with the resource group ContosoResourceGroup. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Slot +Slot name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WebApp +Piped WebApp + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: FromWebApp +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppCertificate.md b/azps-10.1.0/Az.Websites/Get-AzWebAppCertificate.md new file mode 100644 index 0000000000..6e562d2cf9 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppCertificate.md @@ -0,0 +1,107 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 2D83D38F-3A5C-40DB-BE8B-D52E5CAFCF6E +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappcertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppCertificate.md +--- + +# Get-AzWebAppCertificate + +## SYNOPSIS +Gets an Azure Web App certificate. + +## SYNTAX + +``` +Get-AzWebAppCertificate [[-ResourceGroupName] <String>] [[-Thumbprint] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzWebAppCertificate** cmdlet gets information about Azure Web App certificates associated with a specified resource group. +If you know the certificate thumbprint you can also use this cmdlet to get information about a specified certificate. + +## EXAMPLES + +### Example 1: Get Web App certificates in a resource group +```powershell +Get-AzWebAppCertificate -ResourceGroupName "ContosoResourceGroup" +``` + +This command returns information about the uploaded Web App certificates associated with the resource group ContosoResourceGroup. + +### Example 2: Get a specified web app certificate +```powershell +Get-AzWebAppCertificate -ResourceGroupName "ContosoResourceGroup" -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" +``` + +This command gets the ContosoResourceGroup Web App certificate with the thumbprint E3A38EBA60CAA1C162785A2E1C44A15AD450199C3. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the certificate is assigned to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Thumbprint +Specifies the unique identifier for the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.WebApp.PSCertificate + +## NOTES + +## RELATED LINKS + +[Get-AzWebAppSSLBinding](./Get-AzWebAppSSLBinding.md) + + diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppContainerContinuousDeploymentUrl.md b/azps-10.1.0/Az.Websites/Get-AzWebAppContainerContinuousDeploymentUrl.md new file mode 100644 index 0000000000..760d7c4f81 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppContainerContinuousDeploymentUrl.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappcontainercontinuousdeploymenturl +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppContainerContinuousDeploymentUrl.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppContainerContinuousDeploymentUrl.md +--- + +# Get-AzWebAppContainerContinuousDeploymentUrl + +## SYNOPSIS +Get-AzWebAppContainerContinuousDeploymentUrl will return container continuous deployment url + +## SYNTAX + +### S1 (Default) +``` +Get-AzWebAppContainerContinuousDeploymentUrl [[-SlotName] <String>] [-ResourceGroupName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Get-AzWebAppContainerContinuousDeploymentUrl [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +Get-AzWebAppContainerContinuousDeploymentUrl will return container continuous deployment url + +## EXAMPLES + +### Example 1 +```powershell +Get-AzWebAppContainerContinuousDeploymentUrl -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" +``` + +This command will return container continuous deployment url. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the web app. + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +The name of the web app slot. + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WebApp +The web app object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppContinuousWebJob.md b/azps-10.1.0/Az.Websites/Get-AzWebAppContinuousWebJob.md new file mode 100644 index 0000000000..0de2956902 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppContinuousWebJob.md @@ -0,0 +1,324 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappcontinuouswebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppContinuousWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppContinuousWebJob.md +--- + +# Get-AzWebAppContinuousWebJob + +## SYNOPSIS +Get or list continuous web for an app. + +## SYNTAX + +### List (Default) +``` +Get-AzWebAppContinuousWebJob -AppName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get +``` +Get-AzWebAppContinuousWebJob -AppName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWebAppContinuousWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list continuous web for an app. + +## EXAMPLES + +### Example 1: List continuous webs for an app +```powershell +Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/continuousjob-01 webjob-rg-test +appService-test01/continuousjob-02 webjob-rg-test +``` + +This command lists continuous webs for an app. + +### Example 2: Get continuous web for an app +```powershell +Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/continuousjob-01 webjob-rg-test +``` + +This command gets continuous web for an app. + +### Example 3: Get continuous web for an app by pipeline +```powershell +$webjob = Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 +Start-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 +$webjob.Id | Get-AzWebAppContinuousWebJob +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/continuousjob-01 webjob-rg-test +``` + +This command gets continuous web for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Get, GetViaIdentity +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 + +```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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IContinuousWebJob + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppPublishingProfile.md b/azps-10.1.0/Az.Websites/Get-AzWebAppPublishingProfile.md new file mode 100644 index 0000000000..54cf4c1a0b --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppPublishingProfile.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 38433470-CAFD-4B8F-980C-63D4B264B39F +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebapppublishingprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppPublishingProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppPublishingProfile.md +--- + +# Get-AzWebAppPublishingProfile + +## SYNOPSIS +Gets an Azure Web App publishing profile. + +## SYNTAX + +### S1 +``` +Get-AzWebAppPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] [-IncludeDisasterRecoveryEndpoints] + [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Get-AzWebAppPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] [-IncludeDisasterRecoveryEndpoints] + [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzWebAppPublishingProfile** cmdlet gets an Azure Web App publishing profile. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzWebAppPublishingProfile -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Format "Ftp" -OutputFile "C:\Users\contoso\outputfile.publishsettings" +``` + +This command gets the publishing profile in Ftp format for Web App ContosoWebApp associated with the resource group Default-Web-WestUS + and stores it in the specified output file. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +Format + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: WebDeploy, FileZilla3, Ftp + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDisasterRecoveryEndpoints +Include the disaster recovery endpoints if true + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OutputFile +Output File + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Get-AzAppServicePlan](./Get-AzAppServicePlan.md) + +[Get-AzWebApp](./Get-AzWebApp.md) + + diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppSSLBinding.md b/azps-10.1.0/Az.Websites/Get-AzWebAppSSLBinding.md new file mode 100644 index 0000000000..c8489c5a07 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppSSLBinding.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: EE3D2BA0-32E7-4A37-BCAF-F0E8FAAC43CE +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappsslbinding +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSSLBinding.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSSLBinding.md +--- + +# Get-AzWebAppSSLBinding + +## SYNOPSIS +Gets an Azure Web App certificate SSL binding. + +## SYNTAX + +### S1 +``` +Get-AzWebAppSSLBinding [[-Name] <String>] [-ResourceGroupName] <String> [-WebAppName] <String> + [[-Slot] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Get-AzWebAppSSLBinding [[-Name] <String>] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzWebAppSSLBinding** cmdlet gets a Secure Sockets Layer (SSL) binding for an Azure Web App. +SSL bindings are used to associate a Web App with an uploaded certificate. +Web Apps can be bound to multiple certificates. + +## EXAMPLES + +### Example 1: Get SSL bindings for a Web App +```powershell +Get-AzWebAppSSLBinding -ResourceGroupName "ContosoResourceGroup" -WebAppName "ContosoWebApp" +``` + +This command retrieves the SSL bindings for the Web App ContosoWebApp, which is associated with the resource group ContosoResourceGroup. + +### Example 2: Use an object reference to get SSL bindings for a Web App +```powershell +$WebApp = Get-AzWebApp -Name "ContosoWebApp" +Get-AzWebAppSSLBinding -WebApp $WebApp +``` + +The commands in this example also get the SSL bindings for the Web App ContosoWebApp; in this case, however, an object reference is used instead of the Web App name and the name of the associated resource group. +This object reference is created by the first command in the example, which uses **Get-AzWebApp** to create an object reference to the Web App named ContosoWebApp. +That object reference is stored in a variable named $WebApp. +This variable, and the **Get-AzWebAppSSLBinding** cmdlet, are then used by the second command to get the SSL bindings. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the SSL binding. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the certificate is assigned to. +You cannot use the *ResourceGroupName* parameter and the *WebApp* parameter in the same command. + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +Specifies a Web App deployment slot. +To get a deployment slot, use the Get-AzWebAppSlot cmdlet. + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +Specifies a Web App. +To get a Web App, use the Get-AzWebApp cmdlet. + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WebAppName +Specifies the name of the Web App that this cmdlet gets SSL bindings from. +You cannot use the *WebAppName* parameter and the *WebApp* parameter in the same command. + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Management.WebSites.Models.HostNameSslState + +## NOTES + +## RELATED LINKS + +[New-AzWebAppSSLBinding](./New-AzWebAppSSLBinding.md) + +[Remove-AzWebAppSSLBinding](./Remove-AzWebAppSSLBinding.md) + +[Get-AzWebApp](./Get-AzWebApp.md) + + diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppSlot.md b/azps-10.1.0/Az.Websites/Get-AzWebAppSlot.md new file mode 100644 index 0000000000..58b14bf0fc --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppSlot.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 100A5980-31E2-41F9-84D4-2F5F0CB78B8A +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlot.md +--- + +# Get-AzWebAppSlot + +## SYNOPSIS +Gets an Azure Web App slot. + +## SYNTAX + +### S1 +``` +Get-AzWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Get-AzWebAppSlot [[-Slot] <String>] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzWebAppSlot** cmdlet gets information about an Azure Web App Slot. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" -Slot "Slot001" +``` + +This command gets the slot named Slot001 from the Web App named WebAppStandard that belongs to the +resource group Default-Web-WestUS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +WebApp Slot Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES + +## RELATED LINKS + +[New-AzWebAppSlot](./New-AzWebAppSlot.md) + +[Remove-AzWebAppSlot](./Remove-AzWebAppSlot.md) + +[Restart-AzWebAppSlot](./Restart-AzWebAppSlot.md) + +[Set-AzWebAppSlot](./Set-AzWebAppSlot.md) + +[Start-AzWebAppSlot](./Start-AzWebAppSlot.md) + +[Stop-AzWebAppSlot](./Stop-AzWebAppSlot.md) + +[Get-AzWebApp](./Get-AzWebApp.md) diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppSlotConfigName.md b/azps-10.1.0/Az.Websites/Get-AzWebAppSlotConfigName.md new file mode 100644 index 0000000000..f167c9f2f6 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppSlotConfigName.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: EF2D377C-C000-4BCA-8EB9-58C805FA5C31 +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslotconfigname +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlotConfigName.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlotConfigName.md +--- + +# Get-AzWebAppSlotConfigName + +## SYNOPSIS +Get the list of Web App Slot Config names + +## SYNTAX + +### S1 +``` +Get-AzWebAppSlotConfigName [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Get-AzWebAppSlotConfigName [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzWebAppSlotConfigName** cmdlet retrieves the list of App Setting and Connection String names that are currently marked as slot settings + +## EXAMPLES + +### Example 1 +```powershell +Get-AzWebAppSlotConfigName -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" +``` + +This command gets App Settings and Connection strings pertaining to the Web App named ContosoSite associated with the resource group Default-Web-WestUS + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Management.WebSites.Models.SlotConfigNamesResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppSlotContinuousWebJob.md b/azps-10.1.0/Az.Websites/Get-AzWebAppSlotContinuousWebJob.md new file mode 100644 index 0000000000..8cb7238655 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppSlotContinuousWebJob.md @@ -0,0 +1,340 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslotcontinuouswebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlotContinuousWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlotContinuousWebJob.md +--- + +# Get-AzWebAppSlotContinuousWebJob + +## SYNOPSIS +Get or list continuous web for a deployment slot. + +## SYNTAX + +### List (Default) +``` +Get-AzWebAppSlotContinuousWebJob -AppName <String> -ResourceGroupName <String> -SlotName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get +``` +Get-AzWebAppSlotContinuousWebJob -AppName <String> -Name <String> -ResourceGroupName <String> + -SlotName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWebAppSlotContinuousWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list continuous web for a deployment slot. + +## EXAMPLES + +### Example 1: List continuous webs for a deployment slot +```powershell +Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slotcontinuousjob-03 webjob-rg-test +appService-test01/slot01/slotcontinuousjob-04 webjob-rg-test +``` + +This command lists continuous webs for a deployment slot. + +### Example 2: Get continuous web for a deployment slot +```powershell +Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-03 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slotcontinuousjob-03 webjob-rg-test +``` + +This command gets continuous web for a deployment slot. + +### Example 3: Get continuous web for a deployment slot by pipeline +```powershell +$webjob = Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-03 +Start-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-03 +$webjob.Id | Get-AzWebAppSlotContinuousWebJob +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slotcontinuousjob-03 webjob-rg-test +``` + +This command gets continuous web for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Get, GetViaIdentity +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 + +```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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API deletes a deployment for the production slot. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IContinuousWebJob + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppSlotPublishingProfile.md b/azps-10.1.0/Az.Websites/Get-AzWebAppSlotPublishingProfile.md new file mode 100644 index 0000000000..e87b6a5a06 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppSlotPublishingProfile.md @@ -0,0 +1,189 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: B2FDB54F-0318-4037-BC1D-6113E77DDE7E +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslotpublishingprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlotPublishingProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlotPublishingProfile.md +--- + +# Get-AzWebAppSlotPublishingProfile + +## SYNOPSIS +Gets an Azure Web App slot publishing profile. + +## SYNTAX + +### S1 +``` +Get-AzWebAppSlotPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] + [-IncludeDisasterRecoveryEndpoints] [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Get-AzWebAppSlotPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] + [-IncludeDisasterRecoveryEndpoints] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzWebAppSlotPublishingProfile** cmdlet gets the Web App publishing profile for the specified slot. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzWebAppSlotPublishingProfile -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "slot001" -Format "Ftp" -OutputFile "C:\Users\contoso\outputfile" +``` + +This command gets the publishing profile in Ftp format for slot Slot001 pertaining to the Web App ContosoWebApp associated with the resource group Default-Web-WestUS + and stores it in the specified output file. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +Format + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: WebDeploy, FileZilla3, Ftp + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDisasterRecoveryEndpoints +Include the disaster recovery endpoints if true + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OutputFile +Output File + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +WebApp Slot Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + +[Reset-AzWebAppSlotPublishingProfile](./Reset-AzWebAppSlotPublishingProfile.md) + +[Get-AzWebAppSlot](./Get-AzWebAppSlot.md) + +[Get-AzWebApp](./Get-AzWebApp.md) diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppSlotTriggeredWebJob.md b/azps-10.1.0/Az.Websites/Get-AzWebAppSlotTriggeredWebJob.md new file mode 100644 index 0000000000..ab62adbd7d --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppSlotTriggeredWebJob.md @@ -0,0 +1,340 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslottriggeredwebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlotTriggeredWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlotTriggeredWebJob.md +--- + +# Get-AzWebAppSlotTriggeredWebJob + +## SYNOPSIS +Get or list triggered web for a deployment slot. + +## SYNTAX + +### List (Default) +``` +Get-AzWebAppSlotTriggeredWebJob -AppName <String> -ResourceGroupName <String> -SlotName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get +``` +Get-AzWebAppSlotTriggeredWebJob -AppName <String> -Name <String> -ResourceGroupName <String> -SlotName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWebAppSlotTriggeredWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list triggered web for a deployment slot. + +## EXAMPLES + +### Example 1: List triggered webs for a deployment slot +```powershell +Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slottriggeredjob-03 webjob-rg-test +appService-test01/slot01/slottriggeredjob-04 webjob-rg-test +``` + +This command lists triggered webs for a deployment slot. + +### Example 2: Get triggered web for a deployment slot +```powershell +Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slottriggeredjob-03 webjob-rg-test +``` + +This command gets triggered web for a deployment slot. + +### Example 3: Get triggered web for a deployment slot by pipeline +```powershell +$webjob = Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 +Start-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 +$webjob.Id | Get-AzWebAppSlotTriggeredWebJob +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slottriggeredjob-03 webjob-rg-test +``` + +This command gets triggered web for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Get, GetViaIdentity +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 + +```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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API uses the production slot. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredWebJob + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppSlotTriggeredWebJobHistory.md b/azps-10.1.0/Az.Websites/Get-AzWebAppSlotTriggeredWebJobHistory.md new file mode 100644 index 0000000000..2b4f890eb8 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppSlotTriggeredWebJobHistory.md @@ -0,0 +1,353 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslottriggeredwebjobhistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlotTriggeredWebJobHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlotTriggeredWebJobHistory.md +--- + +# Get-AzWebAppSlotTriggeredWebJobHistory + +## SYNOPSIS +Get or list triggered web job's history for a deployment slot. + +## SYNTAX + +### List (Default) +``` +Get-AzWebAppSlotTriggeredWebJobHistory -AppName <String> -Name <String> -ResourceGroupName <String> + -SlotName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get +``` +Get-AzWebAppSlotTriggeredWebJobHistory -AppName <String> -Id <String> -Name <String> + -ResourceGroupName <String> -SlotName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] + [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWebAppSlotTriggeredWebJobHistory -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list triggered web job's history for a deployment slot. + +## EXAMPLES + +### Example 1: List triggered web job's history for a deployment slot +```powershell +Get-AzWebAppSlotTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 +``` + +```output +Kind Name ResourceGroupName +---- ---- ----------------- + appService-test01/slot01/slottriggeredjob-03/202201040202032401 webjob-rg-test +``` + +This command list triggered web job's history for a deployment slot. + +### Example 2: Get triggered web job's history for a deployment slot +```powershell +Get-AzWebAppSlotTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 -Id 202201040202032401 +``` + +```output +Kind Name ResourceGroupName +---- ---- ----------------- + appService-test01/slot01/slottriggeredjob-03/202201040202032401 webjob-rg-test +``` + +This command get triggered web job's history for a deployment slot. + +### Example 3: Get triggered web job's history for a deployment slot by pipeline +```powershell +$jobs = Get-AzWebAppSlotTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 +$jobs[0].Id | Get-AzWebAppSlotTriggeredWebJobHistory +``` + +```output +Kind Name ResourceGroupName +---- ---- ----------------- + appService-test01/slot01/slottriggeredjob-03/202201040202032401 webjob-rg-test +``` + +This command get triggered web job's history for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +History ID. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API uses the production slot. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredJobHistory + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppSlotWebJob.md b/azps-10.1.0/Az.Websites/Get-AzWebAppSlotWebJob.md new file mode 100644 index 0000000000..0991aedf2f --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppSlotWebJob.md @@ -0,0 +1,229 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappslotwebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlotWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSlotWebJob.md +--- + +# Get-AzWebAppSlotWebJob + +## SYNOPSIS +List webjobs for a deployment slot. + +## SYNTAX + +``` +Get-AzWebAppSlotWebJob -AppName <String> -ResourceGroupName <String> -SlotName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +List webjobs for a deployment slot. + +## EXAMPLES + +### Example 1: List webjobs for a deployment slot +```powershell +Get-AzWebAppSlotWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/slot01/slottriggeredjob-03 webjob-rg-test +appService-test01/slot01/slottriggeredjob-04 webjob-rg-test +appService-test01/slot01/slotcontinuousjob-03 webjob-rg-test +appService-test01/slot01/slotcontinuousjob-04 webjob-rg-test +``` + +This command lists webjobs for a deployment slot. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +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 + +```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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API returns deployments for the production slot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IWebJob + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppSnapshot.md b/azps-10.1.0/Az.Websites/Get-AzWebAppSnapshot.md new file mode 100644 index 0000000000..19efed4d53 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppSnapshot.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappsnapshot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSnapshot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppSnapshot.md +--- + +# Get-AzWebAppSnapshot + +## SYNOPSIS +Gets the snapshots available for a web app. + +## SYNTAX + +### FromResourceName +``` +Get-AzWebAppSnapshot [-UseDisasterRecovery] [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### FromWebApp +``` +Get-AzWebAppSnapshot [-UseDisasterRecovery] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzWebAppSnapshot** cmdlet returns all snapshots for a web app. Snapshots are automatic backups of a web app's files and settings. A snapshot can be restored with the **Restore-AzWebAppSnapshot** cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Get-AzWebAppSnapshot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoApp" -Slot "Staging" +``` + +Get the snapshots for a web app named "ContosoApp" with a slot named "Staging" in the "Default-Web-WestUS" resource group + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the web app. + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Slot +The name of the web app slot. + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UseDisasterRecovery +Read the snapshots from a secondary scale unit. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +The web app object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: FromWebApp +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Cmdlets.BackupRestore.AzureWebAppSnapshot + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppTrafficRouting.md b/azps-10.1.0/Az.Websites/Get-AzWebAppTrafficRouting.md new file mode 100644 index 0000000000..121d05d713 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppTrafficRouting.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppTrafficRouting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppTrafficRouting.md +--- + +# Get-AzWebAppTrafficRouting + +## SYNOPSIS +Get a routing Rule for the given Slot name. + +## SYNTAX + +``` +Get-AzWebAppTrafficRouting -ResourceGroupName <String> -WebAppName <String> -RuleName <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Get-AzWebAppTrafficRouting** cmdlet Gets a routing rule configuration from an Azure Web App Slot. + +## EXAMPLES + +### Example 1: Gets the specific routing rule from webapp slot +```powershell +Get-AzWebAppTrafficRouting -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoSite" -RuleName 'Stg' +``` + +This command gets a routing rule for a given webapp slot. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleName +Rule Name + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebAppName +WebApp Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.WebSites.Models.RampUpRule + +## NOTES + +## RELATED LINKS + +[Update-AzWebAppTrafficRouting](./Update-AzWebAppTrafficRouting.md) + +[Add-AzWebAppTrafficRouting](./Add-AzWebAppTrafficRouting.md) + +[Remove-AzWebAppTrafficRouting](./Remove-AzWebAppTrafficRouting.md) diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppTriggeredWebJob.md b/azps-10.1.0/Az.Websites/Get-AzWebAppTriggeredWebJob.md new file mode 100644 index 0000000000..9a6e390b2d --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppTriggeredWebJob.md @@ -0,0 +1,324 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebapptriggeredwebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppTriggeredWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppTriggeredWebJob.md +--- + +# Get-AzWebAppTriggeredWebJob + +## SYNOPSIS +Get or list triggered web for an app. + +## SYNTAX + +### List (Default) +``` +Get-AzWebAppTriggeredWebJob -AppName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get +``` +Get-AzWebAppTriggeredWebJob -AppName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWebAppTriggeredWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list triggered web for an app. + +## EXAMPLES + +### Example 1: List triggered webs for an app +```powershell +Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/triggeredjob-01 webjob-rg-test +appService-test01/triggeredjob-02 webjob-rg-test +``` + +This command lists triggered webs for an app. + +### Example 2: Get triggered web for an app +```powershell +Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/triggeredjob-01 webjob-rg-test +``` + +This command gets triggered web for an app. + +### Example 3: Get triggered web for an app by pipeline +```powershell +$webjob = Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 +Start-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 +$webjob.Id | Get-AzWebAppTriggeredWebJob +``` + +```output +Name Kind WebJobType ResourceGroupName +---- ---- ---------- ----------------- +appService-test01/triggeredjob-01 webjob-rg-test +``` + +This command gets triggered web for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: Get, GetViaIdentity +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 + +```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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredWebJob + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppTriggeredWebJobHistory.md b/azps-10.1.0/Az.Websites/Get-AzWebAppTriggeredWebJobHistory.md new file mode 100644 index 0000000000..ccec47249f --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppTriggeredWebJobHistory.md @@ -0,0 +1,338 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebapptriggeredwebjobhistory +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppTriggeredWebJobHistory.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppTriggeredWebJobHistory.md +--- + +# Get-AzWebAppTriggeredWebJobHistory + +## SYNOPSIS +Get or list triggered web job's history for an app. + +## SYNTAX + +### List (Default) +``` +Get-AzWebAppTriggeredWebJobHistory -AppName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### Get +``` +Get-AzWebAppTriggeredWebJobHistory -AppName <String> -Id <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWebAppTriggeredWebJobHistory -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +Get or list triggered web job's history for an app. + +## EXAMPLES + +### Example 1: List triggered web job's history for an app +```powershell +Get-AzWebAppTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 +``` + +```output +Kind Name ResourceGroupName +---- ---- ----------------- + appService-test01/triggeredjob-01/202201040249386155 webjob-rg-test + appService-test01/triggeredjob-01/202201040236300466 webjob-rg-test +``` + +This command lists triggered web job's history for an app. + +### Example 2: Get triggered web job's history for an app +```powershell +Get-AzWebAppTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 -Id 202201040236300466 +``` + +```output +Kind Name ResourceGroupName +---- ---- ----------------- + appService-test01/triggeredjob-01/202201040236300466 webjob-rg-test +``` + +This command get triggered web job's history for an app. + +### Example 3: Get triggered web job's history for an app by pipeline +```powershell +$logs = Get-AzWebAppTriggeredWebJobHistory -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 +$logs[0].Id | Get-AzWebAppTriggeredWebJobHistory +``` + +```output +Kind Name ResourceGroupName +---- ---- ----------------- + appService-test01/triggeredjob-01/202201040236300466 webjob-rg-test +``` + +This command get triggered web job's history for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +History ID. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ITriggeredJobHistory + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Get-AzWebAppWebJob.md b/azps-10.1.0/Az.Websites/Get-AzWebAppWebJob.md new file mode 100644 index 0000000000..fc8d5457dc --- /dev/null +++ b/azps-10.1.0/Az.Websites/Get-AzWebAppWebJob.md @@ -0,0 +1,213 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/get-azwebappwebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Get-AzWebAppWebJob.md +--- + +# Get-AzWebAppWebJob + +## SYNOPSIS +List webjobs for an app. + +## SYNTAX + +``` +Get-AzWebAppWebJob -AppName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [<CommonParameters>] +``` + +## DESCRIPTION +List webjobs for an app. + +## EXAMPLES + +### Example 1: List webjobs for an app +```powershell +Get-AzWebAppWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 +``` + +```output +Name Kind WebJobType +---- ---- ---------- +appService-test01/triggeredjob-01 +appService-test01/triggeredjob-02 +appService-test01/continuousjob-01 +appService-test01/continuousjob-02 +``` + +This command lists webjobs for an app. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +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 + +```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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.IWebJob + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Import-AzWebAppKeyVaultCertificate.md b/azps-10.1.0/Az.Websites/Import-AzWebAppKeyVaultCertificate.md new file mode 100644 index 0000000000..9cbb3d9a1a --- /dev/null +++ b/azps-10.1.0/Az.Websites/Import-AzWebAppKeyVaultCertificate.md @@ -0,0 +1,181 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/import-AzWebAppKeyVaultCertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Import-AzWebAppKeyVaultCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Import-AzWebAppKeyVaultCertificate.md +--- + +# Import-AzWebAppKeyVaultCertificate + +## SYNOPSIS +Import an SSL certificate to a web app from Key Vault. + +## SYNTAX + +``` +Import-AzWebAppKeyVaultCertificate [-KeyVaultName] <String> [-CertName] <String> [-ResourceGroupName] <String> + [-WebAppName] <String> [-Slot <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Import-AzWebAppKeyVaultCertificate** cmdlet imports an SSL certificate to a web app from Key Vault. + +## EXAMPLES + +### Example 1 +```powershell +Import-AzWebAppKeyVaultCertificate -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoWebApp" ` +-KeyVaultName "ContosoKeyVault" -CertName "ContosoCertname" +``` + +This command imports an SSL certificate to a web app from Key Vault. + +### Example 2 +```powershell +Import-AzWebAppKeyVaultCertificate -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoWebApp" ` +-KeyVaultName '/subscriptions/[sub id]/resourceGroups/[rg]/providers/Microsoft.KeyVault/vaults/[vault name]' ` +-CertName "ContosoCertname" +``` + +This command Import an SSL certificate to a web app from Key Vault using resource id (typically if Key Vault is in another subscription). + +## PARAMETERS + +### -CertName +KeyVaultCertName of the certificate created in keyvault + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultName +The name of the keyvault or Id of the KeyVault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the webapp resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +The name of the webapp slot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebAppName +The name of the webapp. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.WebApp.PSCertificate + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/New-AzAppServiceEnvironment.md b/azps-10.1.0/Az.Websites/New-AzAppServiceEnvironment.md new file mode 100644 index 0000000000..bd65bcb4b9 --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzAppServiceEnvironment.md @@ -0,0 +1,314 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azappserviceenvironment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzAppServiceEnvironment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzAppServiceEnvironment.md +--- + +# New-AzAppServiceEnvironment + +## SYNOPSIS +Creates an App Service Environment including the recommended Route Table and Network Security Group + +## SYNTAX + +### ASEv2SubnetNameParameterSet (Default) +``` +New-AzAppServiceEnvironment [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + [[-Kind] <String>] -VirtualNetworkName <String> -SubnetName <String> -LoadBalancerMode <String> + [-SkipRouteTable] [-SkipNetworkSecurityGroup] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ASEv3SubnetNameParameterSet +``` +New-AzAppServiceEnvironment [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + [[-Kind] <String>] -VirtualNetworkName <String> -SubnetName <String> [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ASEv2SubnetIdParameterSet +``` +New-AzAppServiceEnvironment [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + [[-Kind] <String>] -SubnetId <String> -LoadBalancerMode <String> [-SkipRouteTable] [-SkipNetworkSecurityGroup] + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ASEv3SubnetIdParameterSet +``` +New-AzAppServiceEnvironment [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> + [[-Kind] <String>] -SubnetId <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzAppServiceEnvironment** cmdlet creates an App Service Environment. + +## EXAMPLES + +### Example 1 +```powershell +New-AzAppServiceEnvironment -ResourceGroupName MyResourceGroup -Name MyAseV2 -Location WestEurope -VirtualNetworkName MyVirtualNetwork -SubnetName AseSubnet -LoadBalancerMode Internal +``` + +Create App Service Environment named MyAseV2 including recommended Route Table and Network Security Group + +### Example 2 +```powershell +New-AzAppServiceEnvironment -ResourceGroupName MyResourceGroup -Name MyAseV2 -Location WestEurope -VirtualNetworkName MyVirtualNetwork -SubnetName AseSubnet -LoadBalancerMode Internal -SkipRouteTable -SkipNetworkSecurityGroup +``` + +Create App Service Environment named MyAseV2 without recommended Route Table and Network Security Group. +These should be create before or right after provisioning the App Service Environment to ensure a functional instance. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +The version of the app service environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: ASEv2, ASEv3 + +Required: False +Position: 3 +Default value: ASEv2 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoadBalancerMode +Load balancer mode of the app service environment. + +```yaml +Type: System.String +Parameter Sets: ASEv2SubnetNameParameterSet, ASEv2SubnetIdParameterSet +Aliases: +Accepted values: Internal, External + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The Location of the app service environment eg: West Europe. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the app service environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the app service environment object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipNetworkSecurityGroup +Do not create the recommended network security group as part of the app service environment. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ASEv2SubnetNameParameterSet, ASEv2SubnetIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipRouteTable +Do not create the recommended route table as part of the app service environment. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ASEv2SubnetNameParameterSet, ASEv2SubnetIdParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The subnet id. + +```yaml +Type: System.String +Parameter Sets: ASEv2SubnetIdParameterSet, ASEv3SubnetIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetName +The subnet name. Used in combination with -VirtualNetworkName and must be in same resource group as ASE. If not, use -SubnetId + +```yaml +Type: System.String +Parameter Sets: ASEv2SubnetNameParameterSet, ASEv3SubnetNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkName +The vNet name. Used in combination with -SubnetName and must be in same resource group as ASE. If not, use -SubnetId + +```yaml +Type: System.String +Parameter Sets: ASEv2SubnetNameParameterSet, ASEv3SubnetNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS + +[Get-AzAppServiceEnvironment](./Get-AzAppServiceEnvironment.md) + +[New-AzAppServiceEnvironmentInboundServices](./New-AzAppServiceEnvironmentInboundServices.md) + +[Remove-AzAppServiceEnvironment](./Remove-AzAppServiceEnvironment.md) diff --git a/azps-10.1.0/Az.Websites/New-AzAppServiceEnvironmentInboundServices.md b/azps-10.1.0/Az.Websites/New-AzAppServiceEnvironmentInboundServices.md new file mode 100644 index 0000000000..d0bad97fec --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzAppServiceEnvironmentInboundServices.md @@ -0,0 +1,227 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azappserviceenvironmentinboundservices +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzAppServiceEnvironmentInboundServices.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzAppServiceEnvironmentInboundServices.md +--- + +# New-AzAppServiceEnvironmentInboundServices + +## SYNOPSIS +Creates inbound services for App Service Environment. For ASEv2 ILB, this will create an Azure Private DNS Zone and records to map to the internal IP. For ASEv3 it will in addition ensure subnet has Network Policy disabled and will create a private endpoint. + +## SYNTAX + +### SubnetNameParameterSet (Default) +``` +New-AzAppServiceEnvironmentInboundServices [-ResourceGroupName] <String> [-Name] <String> + -VirtualNetworkName <String> -SubnetName <String> [-SkipDns] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### SubnetIdParameterSet +``` +New-AzAppServiceEnvironmentInboundServices [-ResourceGroupName] <String> [-Name] <String> -SubnetId <String> + [-SkipDns] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzAppServiceEnvironmentInboundServices** cmdlet create inbound services for an App Service Environment. + +## EXAMPLES + +### Example 1: Create Private DNS Zone and records for ASEv2 +```powershell +New-AzAppServiceEnvironmentInboundServices -ResourceGroupName AseResourceGroup -Name AseV2Name -VirtualNetworkName MyVirtualNetwork -SubnetName InboundSubnet +``` + +Create Private DNS Zone and records for ASEv2 + +### Example 2: Create private endpoint, Private DNS Zone and records for ASEv3 +```powershell +New-AzAppServiceEnvironmentInboundServices -ResourceGroupName AseResourceGroup -Name AseV2Name -VirtualNetworkName MyVirtualNetwork -SubnetName InboundSubnet +``` + +Create private endpoint, Private DNS Zone and records for ASEv3 + +### Example 3: Create private endpoint for ASEv3 +```powershell +New-AzAppServiceEnvironmentInboundServices -ResourceGroupName AseResourceGroup -Name AseV2Name -VirtualNetworkName MyVirtualNetwork -SubnetName InboundSubnet -SkipDns +``` + +Create private endpoint for ASEv3 + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the app service environment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return status. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipDns +Do not create Azure Private DNS Zone and records. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +The subnet id. + +```yaml +Type: System.String +Parameter Sets: SubnetIdParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetName +The subnet name. Used in combination with -VirtualNetworkName and must be in same resource group as ASE. If not, use -SubnetId + +```yaml +Type: System.String +Parameter Sets: SubnetNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkName +The vNet name. Used in combination with -SubnetName and must be in same resource group as ASE. If not, use -SubnetId + +```yaml +Type: System.String +Parameter Sets: SubnetNameParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS + +[New-AzAppServiceEnvironment](./New-AzAppServiceEnvironment.md) + +[Get-AzAppServiceEnvironment](./Get-AzAppServiceEnvironment.md) + +[Remove-AzAppServiceEnvironment](./Remove-AzAppServiceEnvironment.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Websites/New-AzAppServicePlan.md b/azps-10.1.0/Az.Websites/New-AzAppServicePlan.md new file mode 100644 index 0000000000..8664dc7c9e --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzAppServicePlan.md @@ -0,0 +1,311 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 8F36244D-A4D7-40BB-AC4C-E9AD445549F8 +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azappserviceplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzAppServicePlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzAppServicePlan.md +--- + +# New-AzAppServicePlan + +## SYNOPSIS +Creates an Azure App Service plan in a given Geo location. + +## SYNTAX + +### S1 +``` +New-AzAppServicePlan [-Location] <String> [[-Tier] <String>] [[-NumberofWorkers] <Int32>] + [[-WorkerSize] <String>] [[-AseName] <String>] [[-AseResourceGroupName] <String>] [[-AseResourceId] <String>] + [-PerSiteScaling <Boolean>] [-HyperV] [-AsJob] [-Tag <Hashtable>] [-Linux] [-ResourceGroupName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +New-AzAppServicePlan [-Location] <String> [[-Tier] <String>] [[-NumberofWorkers] <Int32>] + [[-WorkerSize] <String>] [[-AseName] <String>] [[-AseResourceGroupName] <String>] [[-AseResourceId] <String>] + [-PerSiteScaling <Boolean>] [-AsJob] [-AppServicePlan] <PSAppServicePlan> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzAppServicePlan** cmdlet creates an Azure App Service plan in a given Geo location with the specified Tier, worker size, and number of workers. + +## EXAMPLES + +### Example 1: Create an App Service plan +```powershell +New-AzAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -Location "West US" -Tier "Basic" -NumberofWorkers 2 -WorkerSize "Small" +``` + +This command creates an App Service plan named ContosoASP in the resource group named Default-Web-WestUS in Geo location West US. +The command specifies a Basic Tier and allocates two small workers. + +## PARAMETERS + +### -AppServicePlan +App Service Plan Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AseName +App Service Environment Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AseResourceGroupName +App Service Environment Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AseResourceId +Resource id of App Service Environment + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HyperV +Specify this, App Service Plan will run Windows Containers + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Linux +Specify this, App Service Plan will run Linux Containers + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +App Service Plan Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberofWorkers +Number Of Workers + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PerSiteScaling +Whether or not to enable Per Site Scaling + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags are name/value pairs that enable you to categorize resources + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tier +Tier + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: Free +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkerSize +Size of web worker + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Small, Medium, Large, ExtraLarge + +Required: False +Position: 5 +Default value: Small +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan + +## NOTES + +## RELATED LINKS + +[Get-AzAppServicePlan](./Get-AzAppServicePlan.md) + +[Remove-AzAppServicePlan](./Remove-AzAppServicePlan.md) + +[Set-AzAppServicePlan](./Set-AzAppServicePlan.md) + + diff --git a/azps-10.1.0/Az.Websites/New-AzStaticWebApp.md b/azps-10.1.0/Az.Websites/New-AzStaticWebApp.md new file mode 100644 index 0000000000..8f652df37f --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzStaticWebApp.md @@ -0,0 +1,671 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebApp.md +--- + +# New-AzStaticWebApp + +## SYNOPSIS +Description for Creates a new static site in an existing resource group, or updates an existing static site. + +## SYNTAX + +``` +New-AzStaticWebApp -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] -Location <String> + [-AllowConfigFileUpdate] [-ApiBuildCommand <String>] [-ApiLocation <String>] [-AppArtifactLocation <String>] + [-AppBuildCommand <String>] [-AppLocation <String>] [-Branch <String>] [-Capacity <Int32>] + [-GithubActionSecretNameOverride <String>] [-IdentityType <ManagedServiceIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-Kind <String>] [-OutputLocation <String>] + [-RepositoryToken <String>] [-RepositoryUrl <String>] [-SkipGithubActionWorkflowGeneration] + [-SkuName <String>] [-StagingEnvironmentPolicy <StagingEnvironmentPolicy>] [-Tag <Hashtable>] + [-ForkRepositoryDescription <String>] [-ForkRepositoryIsPrivate] [-ForkRepositoryOwner <String>] + [-ForkRepositoryName <String>] [-TemplateRepositoryUrl <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] + [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Description for Creates a new static site in an existing resource group, or updates an existing static site. + +## EXAMPLES + +### Example 1: Create a new static site in an existing resource group, or updates an existing static site +```powershell +New-AzStaticWebApp -ResourceGroupName 'azure-rg-test' -Name 'staticweb-45asde' -Location 'Central US' -RepositoryUrl 'https://github.com/LucasYao93/blazor-starter' -RepositoryToken 'githubAccessToken' -Branch 'branch02' -AppLocation 'Client' -ApiLocation 'Api' -OutputLocation 'wwwroot' -SkuName 'Standard' +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb-45asde Microsoft.Web/staticSites +``` + +This command creates a new static site in an existing resource group, or updates an existing static site. + +### Example 2: Create a new static site in an existing resource group through specified template repository +```powershell +New-AzStaticWebApp -ResourceGroupName 'azure-rg-test' -Name staticweb-pwsh01 -Location "Central US" -RepositoryToken 'xxxxxxxxxxxxxxxxx' -TemplateRepositoryUrl 'https://github.com/staticwebdev/blazor-starter' -ForkRepositoryDescription "Test template repository function of the azure static web." -ForkRepositoryName "test-blazor-starter" -ForkRepositoryOwner 'LucasYao93' -Branch 'main' -AppLocation 'Client' -ApiLocation 'Api' -OutputLocation 'wwwroot' -SkuName 'Standard' +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb-pwsh01 Microsoft.Web/staticSites +``` + +This command creates a new static site in an existing resource group, or updates an existing static site through specified template repository. + +## PARAMETERS + +### -AllowConfigFileUpdate +\<code\>false\</code\> if config file is locked for this static web app; otherwise, \<code\>true\</code\>. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiBuildCommand +A custom command to run during deployment of the Azure Functions API application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiLocation +The path to the api code within the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppArtifactLocation +Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppBuildCommand +A custom command to run during deployment of the static content application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppLocation +The path to the app code within the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Branch +The target branch in the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Capacity +Current number of instances assigned to the resource. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryDescription +Description of the newly generated repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryIsPrivate +Whether or not the newly generated repository is a private repository. +Defaults to false (i.e. +public). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryName +Name of the newly generated repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryOwner +Owner of the newly generated repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GithubActionSecretNameOverride +Github Action secret name override. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +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.Websites.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.Websites.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. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +The list of user assigned identities associated with the resource. +The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource Location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site to create or update. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputLocation +The output path of the app after building. + +```yaml +Type: System.String +Parameter Sets: (All) +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 + +```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 +``` + +### -RepositoryToken +A user's github repository token. +This is used to setup the Github Actions workflow file and API secrets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryUrl +URL for the repository of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipGithubActionWorkflowGeneration +Skip Github Action workflow generation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name of the resource SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StagingEnvironmentPolicy +State indicating whether staging environments are allowed or not allowed for a static web app. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateRepositoryUrl +URL of the template repository. +The newly generated repository will be based on this one. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/New-AzStaticWebAppBuildAppSetting.md b/azps-10.1.0/Az.Websites/New-AzStaticWebAppBuildAppSetting.md new file mode 100644 index 0000000000..9c25c8b7db --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzStaticWebAppBuildAppSetting.md @@ -0,0 +1,347 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappbuildappsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebAppBuildAppSetting.md +--- + +# New-AzStaticWebAppBuildAppSetting + +## SYNOPSIS +Description for Creates or updates the app settings of a static site build. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStaticWebAppBuildAppSetting -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AppSetting <Hashtable>] [-Kind <String>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppBuildAppSetting -InputObject <IWebsitesIdentity> [-AppSetting <Hashtable>] [-Kind <String>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Creates or updates the app settings of a static site build. + +## EXAMPLES + +### Example 1: Create or updates the app settings of a static site build +```powershell +New-AzStaticWebAppBuildAppSetting -ResourceGroupName azure-rg-test -Name staticweb-pwsh01 -EnvironmentName 'default' -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/builds/config +``` + +This command creates or updates the app settings of a static site build. + +### Example 2: Create or updates the app settings of a static site build by pipeline +```powershell +Get-AzStaticWebAppBuildAppSetting -ResourceGroupName resourceGroup -Name taticweb00 -EnvironmentName 'default' | New-AzStaticWebAppBuildAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/builds/config +``` + +This command creates or updates the app settings of a static site by pipeline build. + +## PARAMETERS + +### -AppSetting +Settings. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +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.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/New-AzStaticWebAppBuildFunctionAppSetting.md b/azps-10.1.0/Az.Websites/New-AzStaticWebAppBuildFunctionAppSetting.md new file mode 100644 index 0000000000..bd1f0872e1 --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzStaticWebAppBuildFunctionAppSetting.md @@ -0,0 +1,347 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappbuildfunctionappsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebAppBuildFunctionAppSetting.md +--- + +# New-AzStaticWebAppBuildFunctionAppSetting + +## SYNOPSIS +Description for Creates or updates the function app settings of a static site build. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStaticWebAppBuildFunctionAppSetting -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-AppSetting <Hashtable>] [-Kind <String>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppBuildFunctionAppSetting -InputObject <IWebsitesIdentity> [-AppSetting <Hashtable>] + [-Kind <String>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Creates or updates the function app settings of a static site build. + +## EXAMPLES + +### Example 1: Create or updates the app settings of a static site build +```powershell +New-AzStaticWebAppBuildFunctionAppSetting -ResourceGroupName azure-rg-test -Name staticweb-pwsh01 -EnvironmentName 'default' -AppSetting @{'functionapp01' = 'value01'; 'functionapp02' = 'value02' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/builds/config +``` + +This command creates or updates the app settings of a static site build. + +### Example 2: Create or updates the app settings of a static site build by pipeline +```powershell +Get-AzStaticWebAppBuildFunctionAppSetting -ResourceGroupName resourceGroup -Name staticweb01 -EnvironmentName 'default' | New-AzStaticWebAppBuildFunctionAppSetting -AppSetting @{'buildsetting1' = 'someval'; 'buildsetting2' = 'someval2' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/builds/config +``` + +This command creates or updates the app settings of a static site build by pipeline. + +## PARAMETERS + +### -AppSetting +Settings. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +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.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/New-AzStaticWebAppCustomDomain.md b/azps-10.1.0/Az.Websites/New-AzStaticWebAppCustomDomain.md new file mode 100644 index 0000000000..f8acb20687 --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzStaticWebAppCustomDomain.md @@ -0,0 +1,318 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebAppCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebAppCustomDomain.md +--- + +# New-AzStaticWebAppCustomDomain + +## SYNOPSIS +Description for Creates a new static site custom domain in an existing resource group and static site. + +## SYNTAX + +``` +New-AzStaticWebAppCustomDomain -DomainName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Kind <String>] [-ValidationMethod <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] + [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Description for Creates a new static site custom domain in an existing resource group and static site. + +## EXAMPLES + +### Example 1: Create a new static site custom domain in an existing resource group and static site +```powershell +New-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName 'www01.azpstest.net' +``` + +```output +Kind Name Type +---- ---- ---- + www01.azpstest.net Microsoft.Web/staticSites/customDomains +``` + +This command creates a new static site custom domain in an existing resource group and static site. +First, Need to [configure dns provider](https://learn.microsoft.com/en-us/azure/static-web-apps/custom-domain#configure-dns-provider) for static site. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +The custom domain to create. + +```yaml +Type: System.String +Parameter Sets: (All) +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.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationMethod +Validation method for adding a custom domain + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteCustomDomainOverviewArmResource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/New-AzStaticWebAppFunctionAppSetting.md b/azps-10.1.0/Az.Websites/New-AzStaticWebAppFunctionAppSetting.md new file mode 100644 index 0000000000..80af604bd3 --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzStaticWebAppFunctionAppSetting.md @@ -0,0 +1,332 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappfunctionappsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebAppFunctionAppSetting.md +--- + +# New-AzStaticWebAppFunctionAppSetting + +## SYNOPSIS +Description for Creates or updates the function app settings of a static site. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStaticWebAppFunctionAppSetting -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AppSetting <Hashtable>] [-Kind <String>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppFunctionAppSetting -InputObject <IWebsitesIdentity> [-AppSetting <Hashtable>] + [-Kind <String>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Creates or updates the function app settings of a static site. + +## EXAMPLES + +### Example 1: Create or updates the function app settings of a static site +```powershell +New-AzStaticWebAppFunctionAppSetting -ResourceGroupName azure-rg-test -Name staticweb-pwsh01 -AppSetting @{'function01' = 'value01'; 'function02' = 'value02' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/config +``` + +This command creates or updates the function app settings of a static site. + +### Example 2: Create or updates the function app settings of a static site by pipeline +```powershell +Get-AzStaticWebAppFunctionAppSetting -ResourceGroupName resourceGroup -Name staticweb01 | New-AzStaticWebAppFunctionAppSetting -AppSetting @{'function01' = 'value01'; 'function02' = 'value02' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/config +``` + +This command creates or updates the function app settings of a static site by pipeline. + +## PARAMETERS + +### -AppSetting +Settings. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/New-AzStaticWebAppSetting.md b/azps-10.1.0/Az.Websites/New-AzStaticWebAppSetting.md new file mode 100644 index 0000000000..5aeba0785f --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzStaticWebAppSetting.md @@ -0,0 +1,332 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebAppSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebAppSetting.md +--- + +# New-AzStaticWebAppSetting + +## SYNOPSIS +Description for Creates or updates the app settings of a static site. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStaticWebAppSetting -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AppSetting <Hashtable>] [-Kind <String>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppSetting -InputObject <IWebsitesIdentity> [-AppSetting <Hashtable>] [-Kind <String>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Creates or updates the app settings of a static site. + +## EXAMPLES + +### Example 1: Create or updates the app settings of a static site +```powershell +New-AzStaticWebAppSetting -ResourceGroupName resourceGroup -Name staticweb01 -AppSetting @{'function01' = 'value01'; 'function02' = 'value02' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/config +``` + +This command creates or updates the app settings of a static site. + +### Example 2: Create or updates the app settings of a static site by pipeline. +```powershell +Get-AzStaticWebAppSetting -ResourceGroupName resourceGroup -Name staticweb01 | New-AzStaticWebAppSetting -AppSetting @{'function01' = 'value01'; 'function02' = 'value02' } +``` + +```output +Kind Name Type +---- ---- ---- + appsettings Microsoft.Web/staticSites/config +``` + +This command creates or updates the app settings of a static site by pipeline. + +## PARAMETERS + +### -AppSetting +Settings. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStringDictionary + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/New-AzStaticWebAppUserRoleInvitationLink.md b/azps-10.1.0/Az.Websites/New-AzStaticWebAppUserRoleInvitationLink.md new file mode 100644 index 0000000000..29d1ff7812 --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzStaticWebAppUserRoleInvitationLink.md @@ -0,0 +1,389 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azstaticwebappuserroleinvitationlink +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebAppUserRoleInvitationLink.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzStaticWebAppUserRoleInvitationLink.md +--- + +# New-AzStaticWebAppUserRoleInvitationLink + +## SYNOPSIS +Description for Creates an invitation link for a user with the role + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStaticWebAppUserRoleInvitationLink -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Domain <String>] [-Kind <String>] [-NumHoursToExpiration <Int32>] [-Provider <String>] [-Role <String>] + [-UserDetail <String>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### CreateViaIdentityExpanded +``` +New-AzStaticWebAppUserRoleInvitationLink -InputObject <IWebsitesIdentity> [-Domain <String>] [-Kind <String>] + [-NumHoursToExpiration <Int32>] [-Provider <String>] [-Role <String>] [-UserDetail <String>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Creates an invitation link for a user with the role + +## EXAMPLES + +### Example 1: Create an invitation link for a user with the role +```powershell +New-AzStaticWebAppUserRoleInvitationLink -ResourceGroupName azure-rg-test -Name staticweb-pwsh02 -Domain 'xxxxxxxxx.azurestaticapps.net' -Provider 'github' -UserDetail 'UserName' -Role 'reader' -NumHoursToExpiration 1 +``` + +```output +Kind Name Type +---- ---- ---- + 078284a9-ce47-4aa5-b54c-2e55a67dd53c Microsoft.Web/staticSites/invitations +``` + +This command creates an invitation link for a user with the role. + +### Example 2: Create an invitation link for a user with the role by pipeline +```powershell +$web = Get-AzStaticWebApp -ResourceGroupName resourceGroup -Name staticweb00 +New-AzStaticWebAppUserRoleInvitationLink -InputObject $web -Domain 'Hostname' -Provider 'github' -UserDetail 'UserName' -Role 'admin,contributor' -NumHoursToExpiration 1 +``` + +This command creates an invitation link for a user with the role by pipeline. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The domain name for the static site custom domain. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +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.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumHoursToExpiration +The number of hours the sas token stays valid + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Provider +The identity provider for the static site user. + +```yaml +Type: System.String +Parameter Sets: (All) +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 + +```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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The roles for the static site user, in free-form string format + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserDetail +The user id for the static site user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserInvitationResponseResource + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/New-AzWebApp.md b/azps-10.1.0/Az.Websites/New-AzWebApp.md new file mode 100644 index 0000000000..ca3a0c99e9 --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzWebApp.md @@ -0,0 +1,468 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: D6D4E733-31AE-4ABE-8C78-583EC48C56B8 +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebApp.md +--- + +# New-AzWebApp + +## SYNOPSIS +Creates an Azure Web App. + +## SYNTAX + +### SimpleParameterSet (Default) +``` +New-AzWebApp [[-ResourceGroupName] <String>] [-Name] <String> [[-Location] <String>] + [[-AppServicePlan] <String>] [-ContainerImageName <String>] [-EnableContainerContinuousDeployment] [-AsJob] + [-GitRepositoryPath <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### PrivateRegistry +``` +New-AzWebApp [-ResourceGroupName] <String> [-Name] <String> [[-Location] <String>] [[-AppServicePlan] <String>] + -ContainerImageName <String> -ContainerRegistryUrl <String> -ContainerRegistryUser <String> + -ContainerRegistryPassword <SecureString> [-EnableContainerContinuousDeployment] [-AsJob] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### WebAppParameterSet +``` +New-AzWebApp [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> [[-AppServicePlan] <String>] + [[-SourceWebApp] <PSSite>] [[-TrafficManagerProfile] <String>] [-EnableContainerContinuousDeployment] + [-IgnoreSourceControl] [-IgnoreCustomHostNames] [[-AppSettingsOverrides] <Hashtable>] [[-AseName] <String>] + [[-AseResourceGroupName] <String>] [-IncludeSourceWebAppSlots] [-AsJob] [-Tag <Hashtable>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzWebApp** cmdlet creates an Azure Web App in a given a resource group that uses the specified App Service plan and data center. + +## EXAMPLES + +### Example 1: Create a Web App +```powershell +New-AzWebApp -ResourceGroupName Default-Web-WestUS -Name "ContosoSite" -Location "West US" -AppServicePlan "ContosoServicePlan" +``` + +This command creates an Azure Web App named ContosoSite in the existing resource group named Default-Web-WestUS in data center West US. +The command uses an existing App Service plan named ContosoServicePlan. + +## PARAMETERS + +### -AppServicePlan +App Service Plan Name or App Service Plan Id. If a WebApp and App Service Plan are in different Resource Groups, use the ID instead of the name. +The App Service Plan Id can be retrieved using: +$asp = Get-AzAppServicePlan -ResourceGroup myRG -Name MyWebapp +$asp.id returns the App Service Plan Id. + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppSettingsOverrides +App Settings Overrides HashTable. It works only with SourceWebApp parameter. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: WebAppParameterSet +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AseName +App Service Environment Name + +```yaml +Type: System.String +Parameter Sets: WebAppParameterSet +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AseResourceGroupName +App Service Environment Resource Group Name + +```yaml +Type: System.String +Parameter Sets: WebAppParameterSet +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerImageName +Container Image Name and optional tag, for example (image:tag) + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: PrivateRegistry +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryPassword +Private Container Registry Password + +```yaml +Type: System.Security.SecureString +Parameter Sets: PrivateRegistry +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryUrl +Private Container Registry Server Url + +```yaml +Type: System.String +Parameter Sets: PrivateRegistry +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryUser +Private Container Registry Username + +```yaml +Type: System.String +Parameter Sets: PrivateRegistry +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableContainerContinuousDeployment +Enables/Disables container continuous deployment webhook + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GitRepositoryPath +Path to the GitHub repository containing the web application to deploy. + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreCustomHostNames +Ignore Custom Host Names Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WebAppParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreSourceControl +Ignore Source Control Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WebAppParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSourceWebAppSlots +Include Source WebApp Slots Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: WebAppParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Location + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet, PrivateRegistry +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: WebAppParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WebAppName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: SimpleParameterSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: PrivateRegistry, WebAppParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceWebApp +Source WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: WebAppParameterSet +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Tag +Tags are name/value pairs that enable you to categorize resources + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrafficManagerProfile +Resource Id of existing traffic manager profile + +```yaml +Type: System.String +Parameter Sets: WebAppParameterSet +Aliases: TrafficManagerProfileName, TrafficManagerProfileId + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES + +## RELATED LINKS + +[Get-AzWebApp](./Get-AzWebApp.md) + +[Remove-AzWebApp](./Remove-AzWebApp.md) + +[Restart-AzWebApp](./Restart-AzWebApp.md) + +[Start-AzWebApp](./Start-AzWebApp.md) + +[Stop-AzWebApp](./Stop-AzWebApp.md) + + diff --git a/azps-10.1.0/Az.Websites/New-AzWebAppAzureStoragePath.md b/azps-10.1.0/Az.Websites/New-AzWebAppAzureStoragePath.md new file mode 100644 index 0000000000..cc880f94b5 --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzWebAppAzureStoragePath.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azwebappazurestoragepath +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebAppAzureStoragePath.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebAppAzureStoragePath.md +--- + +# New-AzWebAppAzureStoragePath + +## SYNOPSIS +Creates an object that represents an Azure Storage path to be mounted in a Web App. It is meant to be used as a parameter (-AzureStoragePath) to Set-AzWebApp and Set-AzWebAppSlot + +## SYNTAX + +``` +New-AzWebAppAzureStoragePath -Name <String> -Type <AzureStorageType> -AccountName <String> -ShareName <String> + -AccessKey <String> -MountPath <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates an object that represent an Azure Storage path to be mounted inside a Web App. + +## EXAMPLES + +### Example 1 +```powershell +$storagePath1 = New-AzWebAppAzureStoragePath -Name "RemoteStorageAccount1" -AccountName "myaccount" -Type AzureFiles -ShareName "someShareName" -AccessKey "some access key" ` +-MountPath "\mounts\myFolderInsideTheContainerWebApp" + +$storagePath2 = New-AzWebAppAzureStoragePath -Name "RemoteStorageAccount2" -AccountName "myaccount2" -Type AzureFiles -ShareName "someShareName2" -AccessKey "some access key 2" ` +-MountPath "\mounts\myFolderInsideTheContainerWebApp2" + +Set-AzWebApp -ResourceGroupName myresourcegroup -Name myapp -AzureStoragePath $storagepath1, $storagePath2 +``` + +## PARAMETERS + +### -AccessKey +Access key to the Azure Storage account + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccountName +Azure Storage account name. e.g.: myfilestorageaccount + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MountPath +Path in the container where the share specified by ShareName will be exposed. MountPath must be sub-directory of "\mounts". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The identifier of the Azure Storage property. +Must be unique within the Web App or Slot + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +Name of the share to mount to the container + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of Azure Storage account. +Windows Containers only supports Azure Files + +```yaml +Type: Microsoft.Azure.Management.WebSites.Models.AzureStorageType +Parameter Sets: (All) +Aliases: +Accepted values: AzureFiles, AzureBlob + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.WebAppAzureStoragePath + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/New-AzWebAppBackup.md b/azps-10.1.0/Az.Websites/New-AzWebAppBackup.md new file mode 100644 index 0000000000..7709dd2ef9 --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzWebAppBackup.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +ms.assetid: D3FE0440-C663-4379-8F5F-2E66EF024E5D +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azwebappbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebAppBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebAppBackup.md +--- + +# New-AzWebAppBackup + +## SYNOPSIS +Creates an Azure Web App Backup. + +## SYNTAX + +### FromResourceName +``` +New-AzWebAppBackup [[-BackupName] <String>] [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] + [-DefaultProfile <IAzureContextContainer>] [-StorageAccountUrl] <String> + [-Databases <DatabaseBackupSetting[]>] [<CommonParameters>] +``` + +### FromWebApp +``` +New-AzWebAppBackup [[-BackupName] <String>] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [-StorageAccountUrl] <String> [-Databases <DatabaseBackupSetting[]>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzWebAppBackup** cmdlet creates an Azure Web App Backup. + +## EXAMPLES + +### Example 1 +```powershell +New-AzWebAppBackup -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -StorageAccountUrl "https://storageaccount.file.core.windows.net" +``` + +Creates a backup of the specified app ContosoWebApp that is within resource group Default-Web-WestUS in https://storageaccount.file.core.windows.net + +### Example 2 + +The New-AzWebAppBackup cmdlet creates an Azure Web App Backup. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzWebAppBackup -BackupName <String> -Name 'ContosoWebApp' -ResourceGroupName 'Default-Web-WestUS' -StorageAccountUrl 'https://storageaccount.file.core.windows.net' +``` + +## PARAMETERS + +### -BackupName +Backup Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Databases +Databases of type DatabaseBackupSetting[] + +```yaml +Type: Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Slot +WebApp Slot Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountUrl +Storage Account Url + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: FromWebApp +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +### Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting[] + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackup + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/New-AzWebAppCertificate.md b/azps-10.1.0/Az.Websites/New-AzWebAppCertificate.md new file mode 100644 index 0000000000..c7f0627ba8 --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzWebAppCertificate.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/new-AzWebAppCertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebAppCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebAppCertificate.md +--- + +# New-AzWebAppCertificate + +## SYNOPSIS +Creates an App service managed certificate for an Azure Web App. + +## SYNTAX + +``` +New-AzWebAppCertificate [-ResourceGroupName] <String> [-WebAppName] <String> [-Name <String>] + [[-Slot] <String>] [-HostName] <String> [-AddBinding] [-SslState <SslState>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzWebAppCertificate** cmdlet creates an Azure App Service Managed Certificate + +## EXAMPLES + +### Example 1 +```powershell +New-AzWebAppCertificate -ResourceGroupName Default-Web-WestUS -WebAppName "ContosoSite" -Name "ContosoCert" -HostName "www.ContosoSite.net" +``` + +This command create an App Service Managed Certificate for the given WebApp + +### Example 2 +```powershell +New-AzWebAppCertificate -ResourceGroupName Default-Web-WestUS -WebAppName "ContosoSite" -Name "ContosoCert" -HostName "www.ContosoSite.net" -Slot "test" -AddBinding +``` + +This command create an App Service Managed Certificate and binds to the given WebApp Slot. + +### Example 3 +```powershell +New-AzWebAppCertificate -ResourceGroupName Default-Web-WestUS -WebAppName "ContosoSite" -Name "ContosoCert" -HostName "www.ContosoSite.net" -AddBinding +``` + +This command create an App Service Managed Certificate and binds to the given WebApp. + +## PARAMETERS + +### -AddBinding +To add the created certificate to WebApp/slot. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostName +Custom hostname associated with web app/slot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +The name of the web app slot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslState +Ssl state option. +Use either 'SniEnabled' or 'IpBasedEnabled'. +Default option is 'SniEnabled'. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.WebSites.Models.SslState] +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, SniEnabled, IpBasedEnabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebAppName +The name of the web app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.WebApp.PSCertificate + +## NOTES + +## RELATED LINKS + +[Remove-AzWebAppCertificate](./Remove-AzWebAppCertificate.md) diff --git a/azps-10.1.0/Az.Websites/New-AzWebAppDatabaseBackupSetting.md b/azps-10.1.0/Az.Websites/New-AzWebAppDatabaseBackupSetting.md new file mode 100644 index 0000000000..90cc0a7b5c --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzWebAppDatabaseBackupSetting.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +ms.assetid: 22ACB910-0C41-4649-8D22-537E38CB4570 +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azwebappdatabasebackupsetting +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebAppDatabaseBackupSetting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebAppDatabaseBackupSetting.md +--- + +# New-AzWebAppDatabaseBackupSetting + +## SYNOPSIS +Creates a new Azure Web App Backup setting. + +## SYNTAX + +``` +New-AzWebAppDatabaseBackupSetting [-Name] <String> [-DatabaseType] <String> [-ConnectionString] <String> + [[-ConnectionStringName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzWebAppDatabaseBackupSetting** cmdlet creates a new Azure Web App Backup setting. + +## EXAMPLES + +### Example 1 +```powershell +New-AzWebAppDatabaseBackupSetting -Name "ContosoWebApp" -ConnectionString "MyConnectionString" -DatabaseType "SqlAzure" +``` + +Creates a database backup setting (connection string) of type SqlAzure for the specified app ContosoWebApp that is within resource group Default-Web-WestUS. + +### Example 2 + +The New-AzWebAppDatabaseBackupSetting cmdlet creates a new Azure Web App Backup setting. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzWebAppDatabaseBackupSetting -ConnectionString 'MyConnectionString' -ConnectionStringName <String> -DatabaseType 'SqlAzure' -Name 'ContosoWebApp' +``` + +## PARAMETERS + +### -ConnectionString +Connection String + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConnectionStringName +Connection String Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DatabaseType +Database Type ( e.g. "SqlAzure" or "MySql" ) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/New-AzWebAppSSLBinding.md b/azps-10.1.0/Az.Websites/New-AzWebAppSSLBinding.md new file mode 100644 index 0000000000..da8b1e09e8 --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzWebAppSSLBinding.md @@ -0,0 +1,307 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +ms.assetid: 910239BE-9E48-4DC5-85EA-CC6D466FE62F +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azwebappsslbinding +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebAppSSLBinding.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebAppSSLBinding.md +--- + +# New-AzWebAppSSLBinding + +## SYNOPSIS +Creates an SSL certificate binding for an Azure Web App. + +## SYNTAX + +### S1 +``` +New-AzWebAppSSLBinding [-ResourceGroupName] <String> [-WebAppName] <String> [[-Slot] <String>] [-Name] <String> + [[-SslState] <SslState>] [-CertificateFilePath] <String> [-CertificatePassword] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### S2 +``` +New-AzWebAppSSLBinding [-ResourceGroupName] <String> [-WebAppName] <String> [[-Slot] <String>] [-Name] <String> + [[-SslState] <SslState>] [-Thumbprint] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### S3 +``` +New-AzWebAppSSLBinding [-WebApp] <PSSite> [-Name] <String> [[-SslState] <SslState>] + [-CertificateFilePath] <String> [-CertificatePassword] <String> [-DefaultProfile <IAzureContextContainer>] + [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### S4 +``` +New-AzWebAppSSLBinding [-WebApp] <PSSite> [-Name] <String> [[-SslState] <SslState>] [-Thumbprint] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzWebAppSSLBinding** cmdlet creates a Secure Socket Layer (SSL) certificate binding for an Azure Web App. +The cmdlet creates an SSL binding in two ways: +- You can bind a Web App to an existing certificate. +- You can upload a new certificate and then bind the Web App to this new certificate. +Regardless of which approach you use, the certificate and the Web App must be associated with the same Azure resource group. +If you have a Web App in Resource Group A and you want to bind that Web App to a certificate in Resource Group B, the only way to do that is to upload a copy of the certificate to Resource Group A. +If you upload a new certificate, keep in mind the following requirements for an Azure SSL certificate: +- The certificate must contain a private key. +- The certificate must use the Personal Information Exchange (PFX) format. +- The certificate's subject name must match the domain used to access the Web App. +- The certificate must use a minimum of 2048-bit encryption. + +## EXAMPLES + +### Example 1: Bind a certificate to a Web App +```powershell +New-AzWebAppSSLBinding -ResourceGroupName "ContosoResourceGroup" -WebAppName "ContosoWebApp" -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" -Name "www.contoso.com" +``` + +This command binds an existing Azure certificate (a certificate with the Thumbprint E3A38EBA60CAA1C162785A2E1C44A15AD450199C3) to the web app named ContosoWebApp. + +### Example 2 + +Creates an SSL certificate binding for an Azure Web App. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzWebAppSSLBinding -Name 'www.contoso.com' -ResourceGroupName 'ContosoResourceGroup' -SslState Disabled -Thumbprint 'E3A38EBA60CAA1C162785A2E1C44A15AD450199C3' -WebAppName 'ContosoWebApp' +``` + +powershell + +### Example 3 + +Creates an SSL certificate binding for an Azure Web App. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +New-AzWebAppSSLBinding -CertificateFilePath <String> -CertificatePassword <String> -Name 'www.contoso.com' -ResourceGroupName 'ContosoResourceGroup' -SslState Disabled -WebAppName 'ContosoWebApp' +``` + +## PARAMETERS + +### -CertificateFilePath +Specifies the file path for the certificate to be uploaded. +The *CertificateFilePath* parameter is only required if the certificate has not yet been uploaded to Azure. + +```yaml +Type: System.String +Parameter Sets: S1, S3 +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificatePassword +Specifies the decryption password for the certificate. + +```yaml +Type: System.String +Parameter Sets: S1, S3 +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Web App. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the certificate is assigned to. +You cannot use the *ResourceGroupName* parameter and the *WebApp* parameter in the same command. + +```yaml +Type: System.String +Parameter Sets: S1, S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +Specifies the name of the Web App deployment slot. +You can use the Get-AzWebAppSlot cmdlet to get a slot. +Deployment slots provide a way for you to stage and validate web apps without those apps being accessible over the Internet. +Typically you will deploy your changes to a staging site, validate those changes, and then deploy to the production (Internet-accessible) site. + +```yaml +Type: System.String +Parameter Sets: S1, S2 +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslState +Specifies whether the certificate is enabled. +Set the *SSLState* parameter to 1 to enable the certificate, or set *SSLState* to 0 to disable the certificate. + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Management.WebSites.Models.SslState] +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, SniEnabled, IpBasedEnabled + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Thumbprint +Specifies the unique identifier for the certificate. + +```yaml +Type: System.String +Parameter Sets: S2, S4 +Aliases: + +Required: True +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +Specifies a Web App. +To get a Web App, use the Get-AzWebApp cmdlet. +You cannot use the *WebApp* parameter in the same command as the *ResourceGroupName* parameter and/or the *WebAppName*. + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S3, S4 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WebAppName +Specifies the name of the Web App for which the new SSL binding is being created. +You cannot use the *WebAppName* parameter and the *WebApp* parameter in the same command. + +```yaml +Type: System.String +Parameter Sets: S1, S2 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Management.WebSites.Models.HostNameSslState + +## NOTES + +## RELATED LINKS + +[Get-AzWebAppSSLBinding](./Get-AzWebAppSSLBinding.md) + +[Remove-AzWebAppSSLBinding](./Remove-AzWebAppSSLBinding.md) + +[Get-AzWebAppSlot](./Get-AzWebAppSlot.md) + +[Get-AzWebApp](./Get-AzWebApp.md) + + diff --git a/azps-10.1.0/Az.Websites/New-AzWebAppSlot.md b/azps-10.1.0/Az.Websites/New-AzWebAppSlot.md new file mode 100644 index 0000000000..0a39e7b07a --- /dev/null +++ b/azps-10.1.0/Az.Websites/New-AzWebAppSlot.md @@ -0,0 +1,361 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +ms.assetid: D23BBF34-80C0-48B1-8E1C-6F345DEC61AD +online version: https://learn.microsoft.com/powershell/module/az.websites/new-azwebappslot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebAppSlot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/New-AzWebAppSlot.md +--- + +# New-AzWebAppSlot + +## SYNOPSIS +Creates an Azure Web App slot. + +## SYNTAX + +``` +New-AzWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] [[-AppServicePlan] <String>] + [[-SourceWebApp] <PSSite>] [-IgnoreSourceControl] [-IgnoreCustomHostNames] + [[-AppSettingsOverrides] <Hashtable>] [[-AseName] <String>] [[-AseResourceGroupName] <String>] + [-ContainerImageName <String>] [-ContainerRegistryUrl <String>] [-ContainerRegistryUser <String>] + [-ContainerRegistryPassword <SecureString>] [-EnableContainerContinuousDeployment] [-CopyIdentity] [-AsJob] + [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **New-AzWebAppSlot** cmdlet creates an Azure Web App Slot in a given a resource group that uses the specified App Service plan and data center. + +## EXAMPLES + +### Example 1 +```powershell +New-AzWebAppSlot -ResourceGroupName Default-Web-WestUS -Name "ContosoSite" -AppServicePlan "ContosoServicePlan" -Slot "Slot001" +``` + +This command creates a Slot named Slot001 under an existing Web App names ContosoSite in the existing resource group named Default-Web-WestUS in data center West US. +The command uses an existing App Service plan named ContosoServicePlan. + +## PARAMETERS + +### -AppServicePlan +App Service Plan Name or App Service Plan Id. If the Slot and App Service Plan are in different Resource Groups, use the ID instead of the name. +The App Service Plan Id can be retrieved using: +$asp = Get-AzAppServicePlan -ResourceGroup myRG -Name MyWebapp +$asp.id returns the App Service Plan Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppSettingsOverrides +App Settings Overrides Hashtable. It works only with SourceWebApp parameter. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AseName +App Service Environment Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AseResourceGroupName +App Service Environment Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerImageName +Container Image Name and optional tag, for example (image:tag) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryPassword +Private Container Registry Password + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryUrl +Private Container Registry Server Url + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryUser +Private Container Registry Username + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyIdentity +Copies the managed identity from the parent or source WebApp. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableContainerContinuousDeployment +Enables/Disables container continuous deployment webhook + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreCustomHostNames +Ignore Custom HostNames Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreSourceControl +Ignore Source Control Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Webapp Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +Webapp Slot Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceWebApp +Source WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Tag +Tags are name/value pairs that enable you to categorize resources + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES + +## RELATED LINKS + +[Get-AzWebAppSlot](./Get-AzWebAppSlot.md) + +[Remove-AzWebAppSlot](./Remove-AzWebAppSlot.md) + +[Restart-AzWebAppSlot](./Restart-AzWebAppSlot.md) + +[Set-AzWebAppSlot](./Set-AzWebAppSlot.md) + +[Start-AzWebAppSlot](./Start-AzWebAppSlot.md) + +[Stop-AzWebAppSlot](./Stop-AzWebAppSlot.md) + +[Get-AzAppServicePlan](./Get-AzAppServicePlan.md) + +[Get-AzWebApp](./Get-AzWebApp.md) diff --git a/azps-10.1.0/Az.Websites/Publish-AzWebApp.md b/azps-10.1.0/Az.Websites/Publish-AzWebApp.md new file mode 100644 index 0000000000..eb77e794eb --- /dev/null +++ b/azps-10.1.0/Az.Websites/Publish-AzWebApp.md @@ -0,0 +1,369 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/publish-azwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Publish-AzWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Publish-AzWebApp.md +--- + +# Publish-AzWebApp + +## SYNOPSIS +Deploys an Azure Web App from a ZIP, JAR, or WAR file using zipdeploy. + +## SYNTAX + +### FromWebApp (Default) +``` +Publish-AzWebApp -ArchivePath <String> [-Type <String>] [-Clean <Boolean>] [-Async <Boolean>] + [-Restart <Boolean>] [-TargetPath <String>] [-IgnoreStack <Boolean>] [-Reset <Boolean>] [-Force] [-AsJob] + [-Timeout <Double>] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### FromResourceName +``` +Publish-AzWebApp -ArchivePath <String> [-Type <String>] [-Clean <Boolean>] [-Async <Boolean>] + [-Restart <Boolean>] [-TargetPath <String>] [-IgnoreStack <Boolean>] [-Reset <Boolean>] [-Force] [-AsJob] + [-Timeout <Double>] [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Publish-AzWebApp** cmdlet uploads content to an existing Azure Web App. The content should be packaged in a ZIP file if using stacks such as .NET, Python, or Node, or a WAR or JAR file if using Java. The content should be pre-built and ready-to-run without any additional build steps during deployment. This cmdlet uses the Kudu zipdeploy and wardeploy features to deploy content. Refer to the Kudu wiki for details about how zipdeploy and wardeploy work, and how to properly package a web app for deployment. https://aka.ms/kuduzipdeploy and https://aka.ms/kuduwardeploy contain helpful details about zipdeploy and wardeploy. + +## EXAMPLES + +### Example 1 +```powershell +Publish-AzWebApp -ResourceGroupName Default-Web-WestUS -Name MyApp -ArchivePath C:\project\app.zip +``` + +Uploads the contents of app.zip to the web app named MyApp belonging to the resource group Default-Web-WestUS. + +### Example 2 +```powershell +Publish-AzWebApp -ResourceGroupName ContosoRG -Name ContosoApp -Slot Staging -ArchivePath C:\project\javaproject.war +``` + +Uploads the contents of javaproject.war to the Staging slot of the web app named ContosoApp belonging to the resource group ContosoRG. + +### Example 3 +```powershell +$app = Get-AzWebApp -ResourceGroupName ContosoRG -Name ContosoApp +Publish-AzWebApp -WebApp $app -ArchivePath C:\project\app.zip -AsJob +``` + +Uploads the contents of app.zip to the web app named ContosoApp belonging to the resource group ContosoRG. The cmdlet will be run in a background job. + +### Example 4 +```powershell +$app = Get-AzWebApp -ResourceGroupName ContosoRG -Name ContosoApp +$app | Publish-AzWebApp -ArchivePath C:\project\java_app.jar +``` + +### Example 5 +```powershell +$app = Get-AzWebApp -ResourceGroupName ContosoRG -Name ContosoApp +Publish-AzWebApp -WebApp $app -ArchivePath C:\project\app.zip -Force +``` + +Uploads the contents of java_app.jar to the web app named ContosoApp belonging to the resource group ContosoRG. If -Force is not specified it will prompt for the confirmation before the contents will be deployed. + +### Example 6 +```powershell +$app = Get-AzWebApp -ResourceGroupName ContosoRG -Name ContosoApp +Publish-AzWebApp -WebApp $app -ArchivePath C:\project\app.zip -Timeout 300000 -Force +``` + +Uploads the contents of java_app.jar to the web app named ContosoApp belonging to the resource group ContosoRG. User can Sets the timespan in Milliseconds to wait before the request times out. If -Force is not specified it will prompt for the confirmation before the contents will be deployed. + +## PARAMETERS + +### -ArchivePath +The path of the archive file. ZIP, WAR, and JAR are supported. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Async +The artifact is deployed asynchronously. (The command will exit once the artifact is pushed to the web app.) + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Clean +Cleans the target directory prior to deploying the file(s). + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forcefully Remove Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreStack +Disables any language-specific defaults + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the web app. + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Reset +Reset Java web apps to default parking page + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Restart +The web app will be restarted following the deployment. Set this to false if you are deploying multiple artifacts and do not want to restart the site on the earlier deployments. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +The name of the web app slot. + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetPath +Absolute path that the artifact should be deployed to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +Sets the timespan in Milliseconds to wait before the request times out. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Used to override the type of artifact being deployed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +The web app object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: FromWebApp +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Register-AzStaticWebAppUserProvidedFunctionApp.md b/azps-10.1.0/Az.Websites/Register-AzStaticWebAppUserProvidedFunctionApp.md new file mode 100644 index 0000000000..4c2c536829 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Register-AzStaticWebAppUserProvidedFunctionApp.md @@ -0,0 +1,389 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/register-azstaticwebappuserprovidedfunctionapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Register-AzStaticWebAppUserProvidedFunctionApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Register-AzStaticWebAppUserProvidedFunctionApp.md +--- + +# Register-AzStaticWebAppUserProvidedFunctionApp + +## SYNOPSIS +Description for Register a user provided function app with a static site build + +## SYNTAX + +### RegisterExpanded1 (Default) +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-Forced] [-FunctionAppRegion <String>] + [-FunctionAppResourceId <String>] [-Kind <String>] [-DefaultProfile <PSObject>] [-AsJob] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RegisterExpanded +``` +Register-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName <String> -Name <String> + -ResourceGroupName <String> -EnvironmentName <String> [-SubscriptionId <String>] [-Forced] + [-FunctionAppRegion <String>] [-FunctionAppResourceId <String>] [-Kind <String>] [-DefaultProfile <PSObject>] + [-AsJob] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] + [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Description for Register a user provided function app with a static site build + +## EXAMPLES + +### Example 1: Register a user provided function app with a static site +```powershell +Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName azure-rg-test -Name staticweb-pwsh02 -FunctionAppName funcapp-portal01-test -FunctionAppResourceId '/subscriptions/xxxxxxxxxxxxx/resourcegroups/azure-rg-test/providers/Microsoft.Web/sites/funcapp-portal01-test' -FunctionAppRegion 'Central US' +``` + +```output +Kind Name Type +---- ---- ---- + funcapp-portal01-test Microsoft.Web/staticSites/userProvidedFunctionApps +``` + +This command registers a user provided function app with a static site. +The -FunctionAppRegion is region of the function app. + +### Example 2: Register a user provided function app with a static site build +```powershell +Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName azure-rg-test -Name staticweb-pwsh02 -FunctionAppName functionapp-portal02 -FunctionAppResourceId '/subscriptions/xxxxxxxxx/resourcegroups/azure-rg-test/providers/Microsoft.Web/sites/functionapp-portal02' -FunctionAppRegion 'Central US' -EnvironmentName 5 +``` + +```output +Kind Name Type +---- ---- ---- + functionapp-portal02 Microsoft.Web/staticSites/builds/userProvidedFunctionApps +``` + +This command registers a user provided function app with a static site build. +The -FunctionAppRegion is region of the function app. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: RegisterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Forced +Specify \<code\>true\</code\> to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. +The default is \<code\>false\</code\>. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunctionAppName +Name of the function app to register with the static site build. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunctionAppRegion +The region of the function app registered with the static site + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunctionAppResourceId +The resource id of the function app registered with the static site + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +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.Websites.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.Websites.Runtime.SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserProvidedFunctionAppArmResource + +## NOTES + +ALIASES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Remove-AzAppServiceEnvironment.md b/azps-10.1.0/Az.Websites/Remove-AzAppServiceEnvironment.md new file mode 100644 index 0000000000..802384d408 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzAppServiceEnvironment.md @@ -0,0 +1,197 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azappserviceenvironment +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzAppServiceEnvironment.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzAppServiceEnvironment.md +--- + +# Remove-AzAppServiceEnvironment + +## SYNOPSIS +Remove App Service Environment. + +## SYNTAX + +### InputValuesParameterSet (Default) +``` +Remove-AzAppServiceEnvironment [-ResourceGroupName] <String> [-Name] <String> [-Force] [-PassThru] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Remove-AzAppServiceEnvironment [-Force] [-PassThru] [-AsJob] -InputObject <PSAppServiceEnvironment> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzAppServiceEnvironment** cmdlet removes an App Service Environment. Any App Service Plan must be deleted prior to deleting the ASE. + +## EXAMPLES + +### Example 1 : Delete an App Service Environment +```powershell +Remove-AzAppServiceEnvironment -ResourceGroupName MyResourceGroup -Name MyAseName +``` + +Delete an App Service Environment + +## PARAMETERS + +### -AsJob +Run cmdlet in the background and return a Job to track progress. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not ask for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The app service environment object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServiceEnvironment +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the app service environment. + +```yaml +Type: System.String +Parameter Sets: InputValuesParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return status. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: InputValuesParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS + +[New-AzAppServiceEnvironment](./New-AzAppServiceEnvironment.md) + +[Get-AzAppServiceEnvironment](./Get-AzAppServiceEnvironment.md) + +[New-AzAppServiceEnvironmentInboundServices](./New-AzAppServiceEnvironmentInboundServices.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Websites/Remove-AzAppServicePlan.md b/azps-10.1.0/Az.Websites/Remove-AzAppServicePlan.md new file mode 100644 index 0000000000..e65f84fa54 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzAppServicePlan.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 78AAF476-2E9E-4E60-9940-9A9AC6F9506A +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azappserviceplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzAppServicePlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzAppServicePlan.md +--- + +# Remove-AzAppServicePlan + +## SYNOPSIS +Removes an Azure App Service plan. + +## SYNTAX + +### S1 +``` +Remove-AzAppServicePlan [-Force] [-AsJob] [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### S2 +``` +Remove-AzAppServicePlan [-Force] [-AsJob] [-AppServicePlan] <PSAppServicePlan> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzAppServicePlan** cmdlet removes an Azure App Service plan. + +## EXAMPLES + +### Example 1: Remove an App Service plan +```powershell +Remove-AzAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" +``` + +This command removes the Azure App Service plan named ContosoASP that belongs to the resource group named Default-Web-WestUS. + +## PARAMETERS + +### -AppServicePlan +App Service Plan Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forcefully Remove Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +App Service Plan Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan + +## OUTPUTS + +### Microsoft.Azure.AzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzAppServicePlan](./Get-AzAppServicePlan.md) + +[New-AzAppServicePlan](./New-AzAppServicePlan.md) + +[Set-AzAppServicePlan](./Set-AzAppServicePlan.md) + + diff --git a/azps-10.1.0/Az.Websites/Remove-AzStaticWebApp.md b/azps-10.1.0/Az.Websites/Remove-AzStaticWebApp.md new file mode 100644 index 0000000000..67895bff13 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzStaticWebApp.md @@ -0,0 +1,335 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzStaticWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzStaticWebApp.md +--- + +# Remove-AzStaticWebApp + +## SYNOPSIS +Description for Deletes a static site. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStaticWebApp -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStaticWebApp -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] [-PassThru] + [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Description for Deletes a static site. + +## EXAMPLES + +### Example 1: Delete a static site +```powershell +Remove-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb01 +``` + +This command deletes a static site. + +### Example 2: Delete a static site by pipeline +```powershell +Get-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb02 | Remove-AzStaticWebApp +``` + +This command deletes a static site by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site to delete. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Remove-AzStaticWebAppAttachedRepository.md b/azps-10.1.0/Az.Websites/Remove-AzStaticWebAppAttachedRepository.md new file mode 100644 index 0000000000..ed284875f8 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzStaticWebAppAttachedRepository.md @@ -0,0 +1,328 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebappattachedrepository +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzStaticWebAppAttachedRepository.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzStaticWebAppAttachedRepository.md +--- + +# Remove-AzStaticWebAppAttachedRepository + +## SYNOPSIS +Description for Detaches a static site. + +## SYNTAX + +### Detach (Default) +``` +Remove-AzStaticWebAppAttachedRepository -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DetachViaIdentity +``` +Remove-AzStaticWebAppAttachedRepository -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] + [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Detaches a static site. + +## EXAMPLES + +### Example 1: Remove repository of static site +```powershell +Remove-AzStaticWebAppAttachedRepository -ResourceGroupName azure-rg-test -Name staticweb-portal01 +``` + +This command removes repository of static site. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: DetachViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site to detach. + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Remove-AzStaticWebAppBuild.md b/azps-10.1.0/Az.Websites/Remove-AzStaticWebAppBuild.md new file mode 100644 index 0000000000..2d879c3df6 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzStaticWebAppBuild.md @@ -0,0 +1,351 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebappbuild +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzStaticWebAppBuild.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzStaticWebAppBuild.md +--- + +# Remove-AzStaticWebAppBuild + +## SYNOPSIS +Description for Deletes a static site build. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStaticWebAppBuild -EnvironmentName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] [-PassThru] + [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStaticWebAppBuild -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] [-PassThru] + [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Description for Deletes a static site build. + +## EXAMPLES + +### Example 1: Delete a static site build +```powershell +Remove-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal01 -EnvironmentName '2' +``` + +This command deletes a static site build. + +### Example 2: Delete a static site build by pipeline +```powershell +Get-AzStaticWebAppBuild -ResourceGroupName azure-rg-test -Name staticweb-portal01 -EnvironmentName '3' | Remove-AzStaticWebAppBuild +``` + +This command deletes a static site build by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +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.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Remove-AzStaticWebAppCustomDomain.md b/azps-10.1.0/Az.Websites/Remove-AzStaticWebAppCustomDomain.md new file mode 100644 index 0000000000..4b15e7fa40 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzStaticWebAppCustomDomain.md @@ -0,0 +1,351 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebappcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzStaticWebAppCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzStaticWebAppCustomDomain.md +--- + +# Remove-AzStaticWebAppCustomDomain + +## SYNOPSIS +Description for Deletes a custom domain. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStaticWebAppCustomDomain -DomainName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] [-PassThru] + [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStaticWebAppCustomDomain -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] + [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Deletes a custom domain. + +## EXAMPLES + +### Example 1: Delete a custom domain +```powershell +Remove-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName domainName +``` + +This command deletes a custom domain. + +### Example 2: Delete a custom domain by pipeline +```powershell +Get-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName domainName | Remove-AzStaticWebAppCustomDomain +``` + +This command deletes a custom domain by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +The custom domain to delete. + +```yaml +Type: System.String +Parameter Sets: Delete +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.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Remove-AzStaticWebAppUser.md b/azps-10.1.0/Az.Websites/Remove-AzStaticWebAppUser.md new file mode 100644 index 0000000000..6dcfda2414 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzStaticWebAppUser.md @@ -0,0 +1,335 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azstaticwebappuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzStaticWebAppUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzStaticWebAppUser.md +--- + +# Remove-AzStaticWebAppUser + +## SYNOPSIS +Description for Deletes the user entry from the static site. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStaticWebAppUser -AuthProvider <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -UserId <String> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzStaticWebAppUser -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Deletes the user entry from the static site. + +## EXAMPLES + +### Example 1: Delete a user entry from the static site +```powershell +Remove-AzStaticWebAppUser -ResourceGroupName resourceGroup -Name staticweb01 -Authprovider 'all' -UserId 'xxxxxxxx' +``` + +This command deletes the user entry from the static site. + +### Example 2: Delete all users from the static site +```powershell +$userList = Get-AzStaticWebAppUser -ResourceGroupName resourceGroup -Name staticweb01 -Authprovider all +Remove-AzStaticWebAppUser -InputObject $userList +``` + +This command deletes all users from the static site. + +## PARAMETERS + +### -AuthProvider +The auth provider for this user. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the staticsite. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +The user id of the user. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Remove-AzWebApp.md b/azps-10.1.0/Az.Websites/Remove-AzWebApp.md new file mode 100644 index 0000000000..e790939995 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzWebApp.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 9057185C-6F22-4C4A-8480-BE542B5D6BAF +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebApp.md +--- + +# Remove-AzWebApp + +## SYNOPSIS +Removes an Azure Web App. + +## SYNTAX + +### S1 +``` +Remove-AzWebApp [-DeleteAppServicePlan] [-Force] [-AsJob] [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### S2 +``` +Remove-AzWebApp [-DeleteAppServicePlan] [-Force] [-AsJob] [-WebApp] <PSSite> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzWebApp** cmdlet removes an Azure Web App provided the resource group and Web App name. +This cmdlet, by default, also removes all slots and metrics. + +## EXAMPLES + +### Example 1: Remove a Web App +```powershell +Remove-AzWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" +``` + +This command removes the Azure Web App named ContosoSite that belongs to the resource group named Default-Web-WestUS. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteAppServicePlan +If this is the last app in the App Service plan. Delete this App Service plan to prevent unexpected charges. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forcefully Remove Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run.Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzWebApp](./Get-AzWebApp.md) + +[New-AzWebApp](./New-AzWebApp.md) + +[Restart-AzWebApp](./Restart-AzWebApp.md) + +[Start-AzWebApp](./Start-AzWebApp.md) + +[Stop-AzWebApp](./Stop-AzWebApp.md) + + diff --git a/azps-10.1.0/Az.Websites/Remove-AzWebAppAccessRestrictionRule.md b/azps-10.1.0/Az.Websites/Remove-AzWebAppAccessRestrictionRule.md new file mode 100644 index 0000000000..d9fc233c38 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzWebAppAccessRestrictionRule.md @@ -0,0 +1,289 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppAccessRestrictionRule.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppAccessRestrictionRule.md +--- + +# Remove-AzWebAppAccessRestrictionRule + +## SYNOPSIS +Removes an Access Restriction rule from an Azure Web App. + +## SYNTAX + +``` +Remove-AzWebAppAccessRestrictionRule [-ResourceGroupName] <String> [-WebAppName] <String> [-Name <String>] + [-Action <String>] [-SlotName <String>] [-TargetScmSite] [-IpAddress <String>] [-SubnetName <String>] + [-VirtualNetworkName <String>] [-SubnetId <String>] [-ServiceTag <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzWebAppAccessRestrictionRule** cmdlet removes an Access Restriction rule from an Azure Web App + +## EXAMPLES + +### Example 1: Remove a Web App Access Restriction Rule +```powershell +Remove-AzWebAppAccessRestrictionRule -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoSite" -Name IpRule +``` + +This command removes the IpRule access restriction rule from Azure Web App named ContosoSite that belongs to the resource group named Default-Web-WestUS. + +### Example 2: Remove a Service Tag Web App Access Restriction Rule +```powershell +Remove-AzWebAppAccessRestrictionRule -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoSite" -ServiceTag AzureFrontDoor.Backend +``` + +This command removes the access restriction rule with ServiceTag equals AzureFrontDoor.Backend from Azure Web App named ContosoSite that belongs to the resource group named Default-Web-WestUS. + +## PARAMETERS + +### -Action +Allow or Deny rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Allow, Deny + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpAddress +Ip Address v4 or v6 CIDR range. E.g.: 192.168.0.0/24 + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Access Restriction Rule Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the access restriction config object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ServiceTag +Name of Service Tag + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +Deployment Slot Name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetId +ResourceId of Subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubnetName +Name of Subnet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetScmSite +Rule is aimed for Main site or Scm site. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VirtualNetworkName +Name of Virtual Network (must be in same resource group as Web App). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebAppName +The name of the web app. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSAccessRestrictionConfig + +## NOTES + +## RELATED LINKS + +[Get-AzWebAppAccessRestrictionConfig](./Get-AzWebAppAccessRestrictionConfig.md) + +[Update-AzWebAppAccessRestrictionConfig](./Update-AzWebAppAccessRestrictionConfig.md) + +[Add-AzWebAppAccessRestrictionRule](./Add-AzWebAppAccessRestrictionRule.md) diff --git a/azps-10.1.0/Az.Websites/Remove-AzWebAppBackup.md b/azps-10.1.0/Az.Websites/Remove-AzWebAppBackup.md new file mode 100644 index 0000000000..415c662f4a --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzWebAppBackup.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 65A78654-A490-4B60-8C16-B0CC597EE995 +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebappbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppBackup.md +--- + +# Remove-AzWebAppBackup + +## SYNOPSIS + +## SYNTAX + +### FromResourceName +``` +Remove-AzWebAppBackup [-BackupId] <String> [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### FromWebApp +``` +Remove-AzWebAppBackup [-BackupId] <String> [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzWebAppBackup** cmdlet removes the specified backup of an Azure Web App. + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzWebAppBackup -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" -BackupId "12345" +``` + +This command removes the backup with backup with ID of "12345" from the Web App named WebAppStandard that belongs to the resource group Default-Web-WestUS. + +## PARAMETERS + +### -BackupId +Backup Id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Slot +WebApp Slot Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: FromWebApp +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Management.WebSites.Models.BackupItem + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Remove-AzWebAppCertificate.md b/azps-10.1.0/Az.Websites/Remove-AzWebAppCertificate.md new file mode 100644 index 0000000000..1264fe18b4 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzWebAppCertificate.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-AzWebAppCertificate +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppCertificate.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppCertificate.md +--- + +# Remove-AzWebAppCertificate + +## SYNOPSIS +Removes an App service managed certificate for an Azure Web App. + +## SYNTAX + +``` +Remove-AzWebAppCertificate [-ResourceGroupName] <String> [-ThumbPrint] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzWebAppCertificate** cmdlet Removes an Azure App Service Managed Certificate + +## EXAMPLES + +### Example 1 +```powershell +Remove-AzWebAppCertificate -ResourceGroupName Default-Web-WestUS -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" +``` + +This command removes App Service Managed certificate for the given web app. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThumbPrint +Thumbprint of the certificate that already exists in web space. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[New-AzWebAppCertificate](./New-AzWebAppCertificate.md) diff --git a/azps-10.1.0/Az.Websites/Remove-AzWebAppContinuousWebJob.md b/azps-10.1.0/Az.Websites/Remove-AzWebAppContinuousWebJob.md new file mode 100644 index 0000000000..866bd6a611 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzWebAppContinuousWebJob.md @@ -0,0 +1,319 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebappcontinuouswebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppContinuousWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppContinuousWebJob.md +--- + +# Remove-AzWebAppContinuousWebJob + +## SYNOPSIS +Delete a continuous web job for an app. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWebAppContinuousWebJob -AppName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWebAppContinuousWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a continuous web job for an app. + +## EXAMPLES + +### Example 1: Delete a continuous web job for an app +```powershell +Remove-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 +``` + +This command deletes a continuous web job for an app. + +### Example 2: Delete a continuous web job for an app by pipeline +```powershell +Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-02 | Remove-AzWebAppContinuousWebJob +``` + +This command deletes a continuous web job for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Remove-AzWebAppSSLBinding.md b/azps-10.1.0/Az.Websites/Remove-AzWebAppSSLBinding.md new file mode 100644 index 0000000000..3e9fc9bdf8 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzWebAppSSLBinding.md @@ -0,0 +1,251 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 3AB3D398-E5DB-4214-BA27-6E3B7D +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebappsslbinding +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppSSLBinding.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppSSLBinding.md +--- + +# Remove-AzWebAppSSLBinding + +## SYNOPSIS +Removes an SSL binding from an uploaded certificate. + +## SYNTAX + +### S1 +``` +Remove-AzWebAppSSLBinding [-Name] <String> [[-DeleteCertificate] <Boolean>] [-Force] + [-ResourceGroupName] <String> [-WebAppName] <String> [[-Slot] <String>] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### S2 +``` +Remove-AzWebAppSSLBinding [-Name] <String> [[-DeleteCertificate] <Boolean>] [-Force] [-WebApp] <PSSite> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzWebAppSSLBinding** cmdlet removes a Secure Sockets Layer (SSL) binding from an Azure Web App. +SSL bindings are used to associate a Web App with a certificate. + +## EXAMPLES + +### Example 1: Remove an SSL binding for a web app +```powershell +Remove-AzWebAppSSLBinding -ResourceGroupName "ContosoResourceGroup" -WebAppName "ContosoWebApp" -Name "www.contoso.com" +``` + +This command removes the SSL binding for the web app ContosoWebApp. +Since the *DeleteCertificate* parameter is not included, the certificate will be deleted if it no longer has any SSL bindings. + +### Example 2: Remove an SSL binding without removing the certificate +```powershell +Remove-AzWebAppSSLBinding -ResourceGroupName "ContosoResourceGroup" -WebAppName "ContosoWebApp" -Name "www.contoso.com" -DeleteCertificate $False +``` + +Similar to Example 1, this command also removes the SSL binding for the Web App ContosoWebApp. +In this case, however, the *DeleteCertificate* parameter is included, and the parameter value is set to $False. +That means that the certificate will not be deleted regardless of whether it has any SSL bindings or not. + +### Example 3: Use an object reference to remove an SSL binding +```powershell +$WebApp = Get-AzWebApp -Name "ContosoWebApp" +Remove-AzWebAppSSLBinding -WebApp $WebApp -Name "www.contoso.com" +``` + +This example uses an object reference to the Web App website to remove the SSL binding for a Web App. +The first command uses the Get-AzWebApp cmdlet to create an object reference to the Web App named ContosoWebApp. +That object reference is stored in a variable named $WebApp. +The second command uses the object reference and the **Remove-AzWebAppSSLBinding** cmdlet to remove the SSL binding. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteCertificate +Specifies the action to take place if the SSL binding being removed is the only binding used by the certificate. +If *DeleteCertificate* is set to $False, the certificate will not be deleted when the binding is deleted. +If *DeleteCertificate* is set to $True or is not included in the command, the certificate will be deleted along with the SSL binding. +The certificate will only be deleted if the SSL binding being removed is the only binding used by the certificate. +If the certificate has more than one binding, the certificate will not be removed regardless of the value of the *DeleteCertificate* parameter. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the Web App. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the name of the resource group that the certificate is assigned to. +You cannot use the *ResourceGroupName* parameter and the *WebApp* parameter in the same command. + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +Specifies the Web App deployment slot. +To get a deployment slot, use the Get-AzWebAppSlot cmdlet. + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +Specifies a Web App. +To get a Web App, use the Get-AzWebApp cmdlet. +You cannot use the *WebApp* parameter in the same command as the *ResourceGroupName* parameter and/or the *WebAppName*. + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WebAppName +Specifies the name of the Web App. +You cannot use the *WebAppName* parameter and the *WebApp* parameter in the same command. + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run.Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: 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). + +## INPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS + +[Get-AzWebAppSSLBinding](./Get-AzWebAppSSLBinding.md) + +[New-AzWebAppSSLBinding](./New-AzWebAppSSLBinding.md) + +[Get-AzWebAppSlot](./Get-AzWebAppSlot.md) + +[Get-AzWebApp](./Get-AzWebApp.md) + + diff --git a/azps-10.1.0/Az.Websites/Remove-AzWebAppSlot.md b/azps-10.1.0/Az.Websites/Remove-AzWebAppSlot.md new file mode 100644 index 0000000000..c4dda97d56 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzWebAppSlot.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebappslot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppSlot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppSlot.md +--- + +# Remove-AzWebAppSlot + +## SYNOPSIS + +## SYNTAX + +### S1 +``` +Remove-AzWebAppSlot [-Force] [-AsJob] [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### S2 +``` +Remove-AzWebAppSlot [-Force] [-AsJob] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzWebAppSlot** cmdlet removes an Azure Web App Slot provided the resource group and Web App name. +This cmdlet, by default, also removes all slots and metrics. + +## EXAMPLES + +### Example 1: Remove a Web App Slot +```powershell +Remove-AzWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" -Slot "Slot001" +``` + +This command removes the Slot named Slot001 associated with Web App ContosoSite that belongs to the resource group named Default-Web-WestUS. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forcefully Remove Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +WebApp Slot Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.AzureOperationResponse + +## NOTES + +## RELATED LINKS + +[Get-AzWebAppSlot](./Get-AzWebAppSlot.md) + +[New-AzWebAppSlot](./New-AzWebAppSlot.md) + +[Restart-AzWebAppSlot](./Restart-AzWebAppSlot.md) + +[Set-AzWebAppSlot](./Set-AzWebAppSlot.md) + +[Start-AzWebAppSlot](./Start-AzWebAppSlot.md) + +[Stop-AzWebAppSlot](./Stop-AzWebAppSlot.md) + +[Get-AzWebApp](./Get-AzWebApp.md) diff --git a/azps-10.1.0/Az.Websites/Remove-AzWebAppSlotContinuousWebJob.md b/azps-10.1.0/Az.Websites/Remove-AzWebAppSlotContinuousWebJob.md new file mode 100644 index 0000000000..af48774313 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzWebAppSlotContinuousWebJob.md @@ -0,0 +1,335 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebappslotcontinuouswebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppSlotContinuousWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppSlotContinuousWebJob.md +--- + +# Remove-AzWebAppSlotContinuousWebJob + +## SYNOPSIS +Delete a continuous web job for a deployment slot. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWebAppSlotContinuousWebJob -AppName <String> -Name <String> -ResourceGroupName <String> + -SlotName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWebAppSlotContinuousWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a continuous web job for a deployment slot. + +## EXAMPLES + +### Example 1: Delete a continuous web job for a deployment slot +```powershell +Remove-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-03 +``` + +This command deletes a continuous web job for a deployment slot. + +### Example 2: Delete a continuous web job for a deployment slot by pipeline +```powershell +Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-04 | Remove-AzWebAppSlotContinuousWebJob +``` + +This command deletes a continuous web job for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API deletes a deployment for the production slot. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Remove-AzWebAppSlotTriggeredWebJob.md b/azps-10.1.0/Az.Websites/Remove-AzWebAppSlotTriggeredWebJob.md new file mode 100644 index 0000000000..126a47e2da --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzWebAppSlotTriggeredWebJob.md @@ -0,0 +1,335 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebappslottriggeredwebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppSlotTriggeredWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppSlotTriggeredWebJob.md +--- + +# Remove-AzWebAppSlotTriggeredWebJob + +## SYNOPSIS +Delete a triggered web job for a deployment slot. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWebAppSlotTriggeredWebJob -AppName <String> -Name <String> -ResourceGroupName <String> + -SlotName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWebAppSlotTriggeredWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a triggered web job for a deployment slot. + +## EXAMPLES + +### Example 1: Delete a triggered web job for a deployment slot +```powershell +Remove-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 +``` + +This command deletes a triggered web job for a deployment slot. + +### Example 2: Delete a triggered web job for a deployment slot by pipeline +```powershell +Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-04 | Remove-AzWebAppSlotTriggeredWebJob +``` + +This command deletes a triggered web job for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API deletes web job for the production slot. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Remove-AzWebAppTrafficRouting.md b/azps-10.1.0/Az.Websites/Remove-AzWebAppTrafficRouting.md new file mode 100644 index 0000000000..3947a8464a --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzWebAppTrafficRouting.md @@ -0,0 +1,160 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppTrafficRouting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppTrafficRouting.md +--- + +# Remove-AzWebAppTrafficRouting + +## SYNOPSIS +Remove a routing Rule from the Slot. + +## SYNTAX + +``` +Remove-AzWebAppTrafficRouting -ResourceGroupName <String> -WebAppName <String> -RuleName <String> [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Remove-AzWebAppTrafficRouting** cmdlet removes a routing rule from an Azure Web App Slot. + +## EXAMPLES + +### Example 1: Removes the specific routing rule from webapp slot +```powershell +Remove-AzWebAppTrafficRouting -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoSite" -RuleName 'Stg' +``` + +This command removes a routing rule for a given webapp slot. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the access restriction config object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleName +Rule Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebAppName +WebApp Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.WebSites.Models.RampUpRule + +## NOTES + +## RELATED LINKS + +[Add-AzWebAppTrafficRouting](./Add-AzWebAppTrafficRouting.md) + +[Get-AzWebAppTrafficRouting](./Get-AzWebAppTrafficRouting.md) + +[Update-AzWebAppTrafficRouting](./Update-AzWebAppTrafficRouting.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Websites/Remove-AzWebAppTriggeredWebJob.md b/azps-10.1.0/Az.Websites/Remove-AzWebAppTriggeredWebJob.md new file mode 100644 index 0000000000..874b00dd56 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Remove-AzWebAppTriggeredWebJob.md @@ -0,0 +1,319 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/remove-azwebapptriggeredwebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppTriggeredWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Remove-AzWebAppTriggeredWebJob.md +--- + +# Remove-AzWebAppTriggeredWebJob + +## SYNOPSIS +Delete a triggered web job for an app. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWebAppTriggeredWebJob -AppName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWebAppTriggeredWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a triggered web job for an app. + +## EXAMPLES + +### Example 1: Delete a triggered web job for an app +```powershell +Remove-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 +``` + +This command deletes a triggered web job for an app. + +### Example 2: Delete a triggered web job for an app by pipeline +```powershell +Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-02 | Remove-AzWebAppTriggeredWebJob +``` + +This command deletes a triggered web job for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Reset-AzStaticWebAppApiKey.md b/azps-10.1.0/Az.Websites/Reset-AzStaticWebAppApiKey.md new file mode 100644 index 0000000000..63c4346baf --- /dev/null +++ b/azps-10.1.0/Az.Websites/Reset-AzStaticWebAppApiKey.md @@ -0,0 +1,350 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/reset-azstaticwebappapikey +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Reset-AzStaticWebAppApiKey.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Reset-AzStaticWebAppApiKey.md +--- + +# Reset-AzStaticWebAppApiKey + +## SYNOPSIS +Description for Resets the api key for an existing static site. + +## SYNTAX + +### ResetExpanded (Default) +``` +Reset-AzStaticWebAppApiKey -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-Kind <String>] [-RepositoryToken <String>] [-ShouldUpdateRepository] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### ResetViaIdentityExpanded +``` +Reset-AzStaticWebAppApiKey -InputObject <IWebsitesIdentity> [-Kind <String>] [-RepositoryToken <String>] + [-ShouldUpdateRepository] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Resets the api key for an existing static site. + +## EXAMPLES + +### Example 1: Reset the api key for an existing static site. +```powershell +Reset-AzStaticWebAppApiKey -ResourceGroupName azure-rg-test -Name staticweb-portal01 +``` + +This command resets the api key for an existing static site. + +### Example 2: Reset the api key for an existing static site by pipeline +```powershell +Get-AzStaticWebApp -ResourceGroupName azure-rg-test -Name staticweb-portal01 | Reset-AzStaticWebAppApiKey +``` + +This command resets the api key for an existing static site by pipeline. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: ResetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: ResetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -RepositoryToken +The token which proves admin privileges to the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: ResetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShouldUpdateRepository +Determines whether the repository should be updated with the new properties. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: ResetExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Reset-AzWebAppPublishingProfile.md b/azps-10.1.0/Az.Websites/Reset-AzWebAppPublishingProfile.md new file mode 100644 index 0000000000..bdfafb6098 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Reset-AzWebAppPublishingProfile.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +ms.assetid: 84C861B2-DCB3-47F0-8589-BB3172C6E1EC +online version: https://learn.microsoft.com/powershell/module/az.websites/reset-azwebapppublishingprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Reset-AzWebAppPublishingProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Reset-AzWebAppPublishingProfile.md +--- + +# Reset-AzWebAppPublishingProfile + +## SYNOPSIS +Resets the publishing profile for the specified Web App. + +## SYNTAX + +### S1 +``` +Reset-AzWebAppPublishingProfile [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Reset-AzWebAppPublishingProfile [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Reset-AzWebAppPublishingProfile** cmdlet resets the publishing profile for the specified Web App. + +## EXAMPLES + +### Example 1 + +The following example resets the publishing profile for the Web App IpRule associated with the resource group MyResourceGroup. + +<!-- Aladdin Generated Example --> + + +```powershell +Reset-AzWebAppPublishingProfile -Name IpRule -ResourceGroupName MyResourceGroup +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Reset-AzWebAppSlotPublishingProfile.md b/azps-10.1.0/Az.Websites/Reset-AzWebAppSlotPublishingProfile.md new file mode 100644 index 0000000000..409d8d2545 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Reset-AzWebAppSlotPublishingProfile.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 3CD449A1-084E-4950-80EF-06B5ECDFB70F +online version: https://learn.microsoft.com/powershell/module/az.websites/reset-azwebappslotpublishingprofile +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Reset-AzWebAppSlotPublishingProfile.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Reset-AzWebAppSlotPublishingProfile.md +--- + +# Reset-AzWebAppSlotPublishingProfile + +## SYNOPSIS + +## SYNTAX + +### S1 +``` +Reset-AzWebAppSlotPublishingProfile [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Reset-AzWebAppSlotPublishingProfile [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Reset-AzWebAppSlotPublishingProfile** cmdlet resets the publishing profile for the specified Web App Slot. + +## EXAMPLES + +### Example 1 +```powershell +Reset-AzWebAppSlotPublishingProfile -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "slot001" +``` + +This command resets the publishing profile for the Slot named slot001 for the Web App ContosoWebApp associated with the resource group Default-Web-WestUS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +WebApp Slot Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Restart-AzWebApp.md b/azps-10.1.0/Az.Websites/Restart-AzWebApp.md new file mode 100644 index 0000000000..8b0113df88 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Restart-AzWebApp.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +ms.assetid: 297071E5-FC06-4493-BCC2-37D4929E4025 +online version: https://learn.microsoft.com/powershell/module/az.websites/restart-azwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Restart-AzWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Restart-AzWebApp.md +--- + +# Restart-AzWebApp + +## SYNOPSIS +Restarts an Azure Web App. + +## SYNTAX + +### S1 +``` +Restart-AzWebApp [-SoftRestart] [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Restart-AzWebApp [-SoftRestart] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Restart-AzWebApp** cmdlet stops and then starts an Azure Web App. +If the Web App is in a stopped state, use the Start-AzWebApp cmdlet. + +## EXAMPLES + +### Example 1: Restart a Web App +```powershell +Restart-AzWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" +``` + +This command stops the Azure Web App named ContosoSite that belongs to the resource group named Default-Web-WestUS and then restarts it. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftRestart +Specify true to apply the configuration settings and restarts the app only if necessary. +By default, the API always restarts and reprovisions the app. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES + +## RELATED LINKS + +[Get-AzWebApp](./Get-AzWebApp.md) + +[New-AzWebApp](./New-AzWebApp.md) + +[Remove-AzWebApp](./Remove-AzWebApp.md) + +[Start-AzWebApp](./Start-AzWebApp.md) + +[Stop-AzWebApp](./Stop-AzWebApp.md) + + diff --git a/azps-10.1.0/Az.Websites/Restart-AzWebAppSlot.md b/azps-10.1.0/Az.Websites/Restart-AzWebAppSlot.md new file mode 100644 index 0000000000..a2cea2babc --- /dev/null +++ b/azps-10.1.0/Az.Websites/Restart-AzWebAppSlot.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +ms.assetid: 645E74D2-640D-494F-9798-4375FE6A0AF2 +online version: https://learn.microsoft.com/powershell/module/az.websites/restart-azwebappslot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Restart-AzWebAppSlot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Restart-AzWebAppSlot.md +--- + +# Restart-AzWebAppSlot + +## SYNOPSIS +Restarts an Azure Web App Slot. + +## SYNTAX + +### S1 +``` +Restart-AzWebAppSlot [-SoftRestart] [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Restart-AzWebAppSlot [-SoftRestart] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Restart-AzWebAppSlot** cmdlet stops and then starts an Azure Web App Slot. +If the Web App Slot is in a stopped state, use the Start-AzWebAppSlot cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Restart-AzWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" +``` + +This command restarts the slot Slot001 for the web app ContosoWebApp associated with the resource group Default-Web-WestUS + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +WebApp Slot Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftRestart +Specify true to apply the configuration settings and restarts the app only if necessary. +By default, the API always restarts and reprovisions the app. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES + +## RELATED LINKS + +[Get-AzWebAppSlot](./Get-AzWebAppSlot.md) + +[New-AzWebAppSlot](./New-AzWebAppSlot.md) + +[Remove-AzWebAppSlot](./Remove-AzWebAppSlot.md) + +[Set-AzWebAppSlot](./Set-AzWebAppSlot.md) + +[Start-AzWebAppSlot](./Start-AzWebAppSlot.md) + +[Stop-AzWebAppSlot](./Stop-AzWebAppSlot.md) + +[Get-AzWebApp](./Get-AzWebApp.md) diff --git a/azps-10.1.0/Az.Websites/Restore-AzDeletedWebApp.md b/azps-10.1.0/Az.Websites/Restore-AzDeletedWebApp.md new file mode 100644 index 0000000000..ba2ea310d6 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Restore-AzDeletedWebApp.md @@ -0,0 +1,339 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/restore-azdeletedwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Restore-AzDeletedWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Restore-AzDeletedWebApp.md +--- + +# Restore-AzDeletedWebApp + +## SYNOPSIS +Restores a deleted web app to a new or existing web app. + +## SYNTAX + +### FromDeletedResourceName (Default) +``` +Restore-AzDeletedWebApp [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] [-Location <String>] + [-DeletedId <String>] [-TargetResourceGroupName <String>] [-TargetName <String>] [-TargetSlot <String>] + [-TargetAppServicePlanName <String>] [-RestoreContentOnly] [-UseDisasterRecovery] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FromDeletedApp +``` +Restore-AzDeletedWebApp [-TargetResourceGroupName <String>] [-TargetName <String>] [-TargetSlot <String>] + [-TargetAppServicePlanName <String>] [-RestoreContentOnly] [-UseDisasterRecovery] [-Force] [-AsJob] + [-DefaultProfile <IAzureContextContainer>] [-InputObject] <PSAzureDeletedWebApp> [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzDeletedWebApp** cmdlet restores a deleted web app. The web app specified by TargetResourceGroupName, TargetName, and TargetSlot will be overwritten with the contents and settings of the deleted web app. If the target parameters are not specified, they will automatically be filled with the deleted web app's resource group, name, and slot. If the target web app does not exist, it will automatically be created in the app service plan specified by TargetAppServicePlanName. The RestoreContentOnly switch parameter can be used to restore only the deleted app's files without the app settings. + +## EXAMPLES + +### Example 1 +```powershell +Restore-AzDeletedWebApp -ResourceGroupName Default-Web-WestUS -Name ContosoApp -TargetAppServicePlanName ContosoPlan +``` + +Restores a deleted app named ContosoApp belonging to the resource group Default-Web-WestUS. A new app with the same name and resource group will be created in the App Service Plan named ContosoPlan, and the deleted app's files and settings will be restored to it. + +### Example 2 +```powershell +Restore-AzDeletedWebApp -ResourceGroupName Default-Web-WestUS -Name ContosoApp -Slot Staging -TargetResourceGroupName Default-Web-EastUS -TargetName ContosoRestore -RestoreContentOnly +``` + +Restores the Staging slot of a deleted app named ContosoApp belonging to the resource group Default-Web-WestUS. The web app named ContosoRestore belonging to the resource group Default-Web-EastUS will be overwritten. The deleted web app settings will not be restored. + +### Example 3 +```powershell +Restore-AzDeletedWebApp -ResourceGroupName Default-Web-WestUS -Name ContosoApp -DeletedId /subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/locations/location/deletedSites/1234 -TargetAppServicePlanName ContosoPlan +``` + +In case there are 2 deleted apps with same name(ContosoApp), then we get details of both the sites and restore the app named ContosoRestore with the app of our choice by calling restore with Id. + +### Example 4 +```powershell +$deletedSite = Get-AzDeletedWebApp -ResourceGroupName Default-Web-WestUS -Name ContosoApp +Restore-AzDeletedWebApp -TargetResourceGroupName Default-Web-EastUS -TargetName ContosoRestore -TargetAppServicePlanName ContosoPlan -InputObject $deletedSite[0] +``` + +In case there are 2 deleted apps with same name(ContosoApp), then we get details of both the sites and restore the app named ContosoRestore with the app of our choice by calling restore with InputObject(Deletedsite) details + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedId +The Id of the deleted Azure Web App. + +```yaml +Type: System.String +Parameter Sets: FromDeletedResourceName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do the restore without prompting for confirmation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The deleted Azure Web App. + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.PSAzureDeletedWebApp +Parameter Sets: FromDeletedApp +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location of the deleted Azure Web App. + +```yaml +Type: System.String +Parameter Sets: FromDeletedResourceName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the deleted Azure Web App. + +```yaml +Type: System.String +Parameter Sets: FromDeletedResourceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The resource group of the deleted Azure Web App. + +```yaml +Type: System.String +Parameter Sets: FromDeletedResourceName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreContentOnly +Restore the web app's files, but do not restore the settings. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +The deleted Azure Web App slot. + +```yaml +Type: System.String +Parameter Sets: FromDeletedResourceName +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetAppServicePlanName +The App Service Plan for the new Azure Web App. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetName +The name of the new Azure Web App. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupName +The resource group containing the new Azure Web App. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSlot +The name of the new Azure Web App slot. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDisasterRecovery +Use to recover a deleted app from a scale unit that is offline. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.PSAzureDeletedWebApp + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES + +## RELATED LINKS + +[Get-AzDeletedWebApp](./Get-AzDeletedWebApp.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.Websites/Restore-AzWebAppBackup.md b/azps-10.1.0/Az.Websites/Restore-AzWebAppBackup.md new file mode 100644 index 0000000000..06eae91e80 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Restore-AzWebAppBackup.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +ms.assetid: DC400E32-CAB9-4354-99B2-ABA4AA776030 +online version: https://learn.microsoft.com/powershell/module/az.websites/restore-azwebappbackup +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Restore-AzWebAppBackup.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Restore-AzWebAppBackup.md +--- + +# Restore-AzWebAppBackup + +## SYNOPSIS +Restores an Azure Web App Backup. + +## SYNTAX + +### FromResourceName +``` +Restore-AzWebAppBackup [-AppServicePlan <String>] [-Databases <DatabaseBackupSetting[]>] + [-IgnoreConflictingHostNames] [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] + [-DefaultProfile <IAzureContextContainer>] [-StorageAccountUrl] <String> [-BlobName] <String> [-Overwrite] + [<CommonParameters>] +``` + +### FromWebApp +``` +Restore-AzWebAppBackup [-AppServicePlan <String>] [-Databases <DatabaseBackupSetting[]>] + [-IgnoreConflictingHostNames] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] + [-StorageAccountUrl] <String> [-BlobName] <String> [-Overwrite] [<CommonParameters>] +``` + +## DESCRIPTION +The **Restore-AzWebAppBackup** cmdlet restores an Azure Web App Backup. + +## EXAMPLES + +### Example 1 +```powershell +Restore-AzWebAppBackup -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -StorageAccountUrl "https://storageaccount.file.core.windows.net" -BlobName "myBlob" +``` + +Restores a backup of the specified app ContosoWebApp that is within resource group Default-Web-WestUS in blob "myBlob" located at https://storageaccount.file.core.windows.net + +### Example 2 + +The Restore-AzWebAppBackup cmdlet restores an Azure Web App Backup. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Restore-AzWebAppBackup -BlobName 'myBlob' -Name 'ContosoWebApp' -Overwrite -ResourceGroupName 'Default-Web-WestUS' -StorageAccountUrl 'https://storageaccount.file.core.windows.net' +``` + +## PARAMETERS + +### -AppServicePlan +The name of the App Service Plan for the restored app. If left empty, the app's current App Service Plan is used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -BlobName +Blob Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Databases +Databases of type DatabaseBackupSetting[] + +```yaml +Type: Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreConflictingHostNames +Ignore Conflicting HostNames Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Overwrite +Overwrite Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Slot +WebApp Slot Name + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StorageAccountUrl +Storage Account Url + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: FromWebApp +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting[] + +### System.Management.Automation.SwitchParameter + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Restore-AzWebAppSnapshot.md b/azps-10.1.0/Az.Websites/Restore-AzWebAppSnapshot.md new file mode 100644 index 0000000000..3e9e82a6df --- /dev/null +++ b/azps-10.1.0/Az.Websites/Restore-AzWebAppSnapshot.md @@ -0,0 +1,246 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/restore-azwebappsnapshot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Restore-AzWebAppSnapshot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Restore-AzWebAppSnapshot.md +--- + +# Restore-AzWebAppSnapshot + +## SYNOPSIS +Restores a web app snapshot. + +## SYNTAX + +### FromResourceName +``` +Restore-AzWebAppSnapshot [-RecoverConfiguration] [-UseDisasterRecovery] [-Force] [-AsJob] + [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] [-DefaultProfile <IAzureContextContainer>] + [-InputObject] <AzureWebAppSnapshot> [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### FromWebApp +``` +Restore-AzWebAppSnapshot [-RecoverConfiguration] [-UseDisasterRecovery] [-Force] [-AsJob] [-WebApp] <PSSite> + [-DefaultProfile <IAzureContextContainer>] [-InputObject] <AzureWebAppSnapshot> [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Restores a web app snapshot to the web app. Restoring a snapshot overwrites all files in a web app with the files contained in the snapshot. To restore settings as well, use the RecoverConfiguration switch parameter. A snapshot from one web app can be restored to any other web app in the same subscription. + +## EXAMPLES + +### Example 1 +```powershell +$snapshot = (Get-AzWebAppSnapshot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoApp" -Slot "Staging")[0] +Restore-AzWebAppSnapshot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoApp" -Slot "Restore" -InputObject $snapshot -RecoverConfiguration +``` + +Gets the latest snapshot of a web app named "ContosoApp" with a slot named "Staging" in the "Default-Web-WestUS" resource group. Restores the snapshot to the web app's "Restore" slot. + +## PARAMETERS + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Allows the original web app to be overwritten without displaying a warning. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The Azure Web App snapshot. + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Cmdlets.BackupRestore.AzureWebAppSnapshot +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the web app. + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecoverConfiguration +Recover the web app's configuration in addition to files. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Slot +The name of the web app slot. + +```yaml +Type: System.String +Parameter Sets: FromResourceName +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UseDisasterRecovery +Use to recover a snapshot from a scale unit that is offline. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +The web app object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: FromWebApp +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.SwitchParameter + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +### Microsoft.Azure.Commands.WebApps.Cmdlets.BackupRestore.AzureWebAppSnapshot + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Set-AzAppServicePlan.md b/azps-10.1.0/Az.Websites/Set-AzAppServicePlan.md new file mode 100644 index 0000000000..2b5fdcfd6d --- /dev/null +++ b/azps-10.1.0/Az.Websites/Set-AzAppServicePlan.md @@ -0,0 +1,249 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +ms.assetid: 32D45795-FBCD-4157-BF45-41BD1F61782E +online version: https://learn.microsoft.com/powershell/module/az.websites/set-azappserviceplan +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Set-AzAppServicePlan.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Set-AzAppServicePlan.md +--- + +# Set-AzAppServicePlan + +## SYNOPSIS +Sets an Azure App Service plan. + +## SYNTAX + +### S1 +``` +Set-AzAppServicePlan [[-AdminSiteName] <String>] [[-Tier] <String>] [[-NumberofWorkers] <Int32>] + [[-WorkerSize] <String>] [-PerSiteScaling <Boolean>] [-AsJob] [-Tag <Hashtable>] [-ResourceGroupName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Set-AzAppServicePlan [-AsJob] [-AppServicePlan] <PSAppServicePlan> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzAppServicePlan** cmdlet sets an Azure App Service plan. + +## EXAMPLES + +### Example 1: Modify an App Service plan +```powershell +Set-AzAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -PerSiteScaling $true +``` + +This command sets the PerSiteScaling option to true on the App Service plan named ContosoASP + that belongs to the resource group named Default-Web-WestUS. + +### Example 2 + +Sets an Azure App Service plan. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzAppServicePlan -Name 'ContosoASP' -ResourceGroupName 'Default-Web-WestUS' -Tier Free -WorkerSize Small +``` + +## PARAMETERS + +### -AdminSiteName +Admin Site Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppServicePlan +App Service Plan Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +App Service Plan Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberofWorkers +Number Of Workers + +```yaml +Type: System.Int32 +Parameter Sets: S1 +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PerSiteScaling +Per Site Scaling Boolean + +```yaml +Type: System.Boolean +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Tags are name/value pairs that enable you to categorize resources + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tier +Tier + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkerSize +Worker Size + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan + +## NOTES + +## RELATED LINKS + +[Get-AzWebApp](./Get-AzWebApp.md) + +[New-AzWebApp](./New-AzWebApp.md) + +[Remove-AzWebApp](./Remove-AzWebApp.md) + +[Restart-AzWebApp](./Restart-AzWebApp.md) + +[Start-AzWebApp](./Start-AzWebApp.md) + +[Stop-AzWebApp](./Stop-AzWebApp.md) + + diff --git a/azps-10.1.0/Az.Websites/Set-AzWebApp.md b/azps-10.1.0/Az.Websites/Set-AzWebApp.md new file mode 100644 index 0000000000..8386f00311 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Set-AzWebApp.md @@ -0,0 +1,613 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +ms.assetid: 4166119F-D26A-45A1-B040-D7B2459833D6 +online version: https://learn.microsoft.com/powershell/module/az.websites/set-azwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Set-AzWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Set-AzWebApp.md +--- + +# Set-AzWebApp + +## SYNOPSIS +Modifies an Azure Web App. + +## SYNTAX + +### S1 +``` +Set-AzWebApp [[-AppServicePlan] <String>] [[-DefaultDocuments] <String[]>] [[-NetFrameworkVersion] <String>] + [[-PhpVersion] <String>] [[-RequestTracingEnabled] <Boolean>] [[-HttpLoggingEnabled] <Boolean>] + [[-DetailedErrorLoggingEnabled] <Boolean>] [[-AppSettings] <Hashtable>] [[-ConnectionStrings] <Hashtable>] + [[-HandlerMappings] <System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping]>] + [[-ManagedPipelineMode] <String>] [[-WebSocketsEnabled] <Boolean>] [[-Use32BitWorkerProcess] <Boolean>] + [[-AutoSwapSlotName] <String>] [-ContainerImageName <String>] [-ContainerRegistryUrl <String>] + [-ContainerRegistryUser <String>] [-ContainerRegistryPassword <SecureString>] + [-EnableContainerContinuousDeployment <Boolean>] [-HostNames <String[]>] [-NumberOfWorkers <Int32>] [-AsJob] + [-AssignIdentity <Boolean>] [-HttpsOnly <Boolean>] [-AzureStoragePath <WebAppAzureStoragePath[]>] + [-AlwaysOn <Boolean>] [-MinTlsVersion <String>] [-FtpsState <String>] [-ResourceGroupName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Set-AzWebApp [[-Use32BitWorkerProcess] <Boolean>] [[-AutoSwapSlotName] <String>] [-NumberOfWorkers <Int32>] + [-AsJob] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzWebApp** cmdlet sets an Azure Web App. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -AppServicePlan "ContosoPlan" +``` + +This command changes the appservice plan associated with the Web App ContosoWebApp associated with the resource group Default-Web-WestUS. Use the link to learn more about changing the appservice plan and constraints associated with it. +https://learn.microsoft.com/azure/app-service/app-service-plan-manage#move-an-app-to-another-app-service-plan + +### Example 2 +```powershell +Set-AzWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -HttpLoggingEnabled $true +``` + +This command sets HttpLoggingEnabled to true for Web App ContosoWebApp associated with the resource group Default-Web-WestUS + +### Example 3 + +Modifies an Azure Web App. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzWebApp -AppSettings <Hashtable> -Name 'ContosoWebApp' -ResourceGroupName 'Default-Web-WestUS' +``` + +### Example 4 + +The following example creates a connection string named myConnectionString for Web App +ContosoWebApp. This replaces all existing connection strings for Web App ContosoWebApp. + +```powershell +$hashtable = @{myConnectionString = @{Type='MySql';Value='MySql Connection string'}} +Set-AzWebApp -Name 'ContosoWebApp' -ResourceGroupName 'Default-Web-WestUS' -ConnectionStrings $hashtable +``` + +### Example 5 + +Enable application insights for Web App + + +```powershell +$key=(Get-AzApplicationInsights -ResourceId $ai).InstrumentationKey +$setting=@{"ApplicationInsightsAgent_EXTENSION_VERSION"="~3"; "APPINSIGHTS_INSTRUMENTATIONKEY"=$key} +Set-AzWebApp -AppSettings $setting -Name 'ContosoWebApp' -ResourceGroupName 'Default-Web-WestUS' +``` + +## PARAMETERS + +### -AlwaysOn +Ensure web app gets loaded all the time, rather unloaded after been idle. + +```yaml +Type: System.Boolean +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppServicePlan +App Service Plan Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppSettings +App Settings HashTable. Existing App Settings will be replaced, removing any settings that are not provided. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: S1 +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Enable/disable MSI on an existing azure webapp or functionapp + +```yaml +Type: System.Boolean +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoSwapSlotName +Destination slot name for auto swap + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 15 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureStoragePath +Azure Storage to mount inside a Web App for Container. Use New-AzWebAppAzureStoragePath to create it + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.WebAppAzureStoragePath[] +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionStrings +Connection Strings HashTable + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: S1 +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerImageName +Container Image Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryPassword +Private Container Registry Password + +```yaml +Type: System.Security.SecureString +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryUrl +Private Container Registry Server Url + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryUser +Private Container Registry Username + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultDocuments +Default Documents String Array + +```yaml +Type: System.String[] +Parameter Sets: S1 +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetailedErrorLoggingEnabled +Detailed Error Logging Enabled Boolean + +```yaml +Type: System.Boolean +Parameter Sets: S1 +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableContainerContinuousDeployment +Enables/Disables container continuous deployment webhook + +```yaml +Type: System.Boolean +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FtpsState +Set the Ftps state value for an app. Allowed Values [AllAllowed | Disabled | FtpsOnly]. + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: +Accepted values: AllAllowed, Disabled, FtpsOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HandlerMappings +Handler Mappings IList + +```yaml +Type: System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping] +Parameter Sets: S1 +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostNames +WebApp HostNames String Array + +```yaml +Type: System.String[] +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpLoggingEnabled +HttpLoggingEnabled Boolean + +```yaml +Type: System.Boolean +Parameter Sets: S1 +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsOnly +Enable/disable redirecting all traffic to HTTPS on an existing azure webapp or functionapp + +```yaml +Type: System.Boolean +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedPipelineMode +Managed Pipeline Mode Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: +Accepted values: Classic, Integrated + +Required: False +Position: 12 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinTlsVersion +The minimum version of TLS required for SSL requests. Allowed Values [1.0 | 1.1 | 1.2]. + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: +Accepted values: 1.0, 1.1, 1.2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetFrameworkVersion +Net Framework Version + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfWorkers +The number of workers to be allocated + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PhpVersion +Php Version + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestTracingEnabled +Request Tracing Enabled + +```yaml +Type: System.Boolean +Parameter Sets: S1 +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Use32BitWorkerProcess +Use 32-bit Worker Process Boolean + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 14 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WebSocketsEnabled +WebSocketsEnabled Boolean + +```yaml +Type: System.Boolean +Parameter Sets: S1 +Aliases: + +Required: False +Position: 13 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES +Below provided cmdlet will help you to update Azure Web App to **DOTNETCORE** +$PropertiesObject = @{ + "CURRENT_STACK" = "dotnetcore" +} +New-AzResource -PropertyObject $PropertiesObject -ResourceGroupName "Default-Web-WestUS" -ResourceType Microsoft.Web/sites/config -ResourceName "ContosoWebApp/metadata" -ApiVersion 2018-02-01 -Force +Replace the values of `Default-Web-WestUS` with your resource group name of the webapp and `ContosoWebApp` with the webapp name. + +## RELATED LINKS + +[Get-AzWebApp](./Get-AzWebApp.md) + +[New-AzWebApp](./New-AzWebApp.md) + +[Remove-AzWebApp](./Remove-AzWebApp.md) + +[Restart-AzWebApp](./Restart-AzWebApp.md) + +[Start-AzWebApp](./Start-AzWebApp.md) + +[Stop-AzWebApp](./Stop-AzWebApp.md) + +[New-AzResource](/powershell/module/az.resources/new-azresource) diff --git a/azps-10.1.0/Az.Websites/Set-AzWebAppSlot.md b/azps-10.1.0/Az.Websites/Set-AzWebAppSlot.md new file mode 100644 index 0000000000..04bb139ad0 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Set-AzWebAppSlot.md @@ -0,0 +1,608 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +ms.assetid: FA868206-D8B0-4868-A1D1-D3F96BF3ADCC +online version: https://learn.microsoft.com/powershell/module/az.websites/set-azwebappslot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Set-AzWebAppSlot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Set-AzWebAppSlot.md +--- + +# Set-AzWebAppSlot + +## SYNOPSIS +Modifies an Azure Web App slot. + +## SYNTAX + +### S1 +``` +Set-AzWebAppSlot [[-AppServicePlan] <String>] [[-DefaultDocuments] <String[]>] + [[-NetFrameworkVersion] <String>] [[-PhpVersion] <String>] [[-RequestTracingEnabled] <Boolean>] + [[-HttpLoggingEnabled] <Boolean>] [[-DetailedErrorLoggingEnabled] <Boolean>] [[-AppSettings] <Hashtable>] + [[-ConnectionStrings] <Hashtable>] + [[-HandlerMappings] <System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping]>] + [[-ManagedPipelineMode] <String>] [[-WebSocketsEnabled] <Boolean>] [[-Use32BitWorkerProcess] <Boolean>] + [-AutoSwapSlotName <String>] [-NumberOfWorkers <Int32>] [-ContainerImageName <String>] + [-ContainerRegistryUrl <String>] [-ContainerRegistryUser <String>] [-ContainerRegistryPassword <SecureString>] + [-EnableContainerContinuousDeployment <Boolean>] [-AsJob] [-AssignIdentity <Boolean>] [-HttpsOnly <Boolean>] + [-AzureStoragePath <WebAppAzureStoragePath[]>] [-AlwaysOn <Boolean>] [-MinTlsVersion <String>] + [-FtpsState <String>] [-HostNames <String[]>] [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Set-AzWebAppSlot [[-AppServicePlan] <String>] [[-DefaultDocuments] <String[]>] + [[-NetFrameworkVersion] <String>] [[-PhpVersion] <String>] [[-RequestTracingEnabled] <Boolean>] + [[-HttpLoggingEnabled] <Boolean>] [[-DetailedErrorLoggingEnabled] <Boolean>] [[-AppSettings] <Hashtable>] + [[-ConnectionStrings] <Hashtable>] + [[-HandlerMappings] <System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping]>] + [[-ManagedPipelineMode] <String>] [[-WebSocketsEnabled] <Boolean>] [[-Use32BitWorkerProcess] <Boolean>] + [-AutoSwapSlotName <String>] [-NumberOfWorkers <Int32>] [-AsJob] [-WebApp] <PSSite> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzWebApp** cmdlet sets an Azure Web App Slot. + +## EXAMPLES + +### Example 1 +```powershell +Set-AzWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" -AppServicePlan "ContosoPlan" +``` + +This command changes the appservice plan associated with the Slot001, on the Webapp ContosoWebApp associated with the resource group Default-Web-WestUS. Use the link to learn more about changing the appservice plan and constraints associated with it. +https://learn.microsoft.com/azure/app-service/app-service-plan-manage#move-an-app-to-another-app-service-plan + +### Example 2 +```powershell +Set-AzWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" -HttpLoggingEnabled $true +``` + +This command sets HttpLoggingEnabled to true for Slot Slot001 pertaining to Web App ContosoWebApp associated with the resource group Default-Web-WestUS + +### Example 3 + +Modifies an Azure Web App slot. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzWebAppSlot -AppSettings <Hashtable> -Name 'ContosoWebApp' -ResourceGroupName 'Default-Web-WestUS' -Slot 'Slot001' +``` + +## PARAMETERS + +### -AlwaysOn +Ensure web app gets loaded all the time, rather unloaded after been idle. + +```yaml +Type: System.Boolean +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppServicePlan +App Service Plan Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppSettings +App Settings HashTable. Existing App Settings will be replaced, removing any settings that are not provided. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run cmdlet in the background + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignIdentity +Enable/disable MSI on an existing slot [PREVIEW] + +```yaml +Type: System.Boolean +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoSwapSlotName +Destination slot name for auto swap + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureStoragePath +Azure Storage to mount inside a Web App for Container. Use New-AzWebAppAzureStoragePath to create it + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.WebAppAzureStoragePath[] +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionStrings +Connection Strings HashTable. Example: `$connStrings = @{ConnectionStringName = @{ Type = "MySql"; Value = "TestValue"}}` + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerImageName +Container Image Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryPassword +Private Container Registry Password + +```yaml +Type: System.Security.SecureString +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryUrl +Private Container Registry Server Url + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerRegistryUser +Private Container Registry Username + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultDocuments +Default Documents String Array + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetailedErrorLoggingEnabled +Detailed Error Logging Enabled Boolean + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableContainerContinuousDeployment +Enables/Disables container continuous deployment webhook + +```yaml +Type: System.Boolean +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FtpsState +Set the Ftps state value for an app. Allowed Values [AllAllowed | Disabled | FtpsOnly]. + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: +Accepted values: AllAllowed, Disabled, FtpsOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HandlerMappings +Handler Mappings IList + +```yaml +Type: System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostNames +Custom hostnames associated with web app slot + +```yaml +Type: System.String[] +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpLoggingEnabled +HttpLoggingEnabled Boolean + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpsOnly +Enable/disable redirecting all traffic to HTTPS on an existing slot + +```yaml +Type: System.Boolean +Parameter Sets: S1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedPipelineMode +Managed Pipeline Mode Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Classic, Integrated + +Required: False +Position: 13 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinTlsVersion +The minimum version of TLS required for SSL requests. Allowed Values [1.0 | 1.1 | 1.2]. + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: +Accepted values: 1.0, 1.1, 1.2 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NetFrameworkVersion +Net Framework Version + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfWorkers +The number of workers to be allocated + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PhpVersion +Php Version + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestTracingEnabled +Request Tracing Enabled Boolean + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +WebApp Slot Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Use32BitWorkerProcess +Use 32-bit Worker Process Boolean + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 15 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WebSocketsEnabled +Web Sockets Enabled Boolean + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 14 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES + +## RELATED LINKS + +[Get-AzWebAppSlot](./Get-AzWebAppSlot.md) + +[New-AzWebAppSlot](./New-AzWebAppSlot.md) + +[Remove-AzWebAppSlot](./Remove-AzWebAppSlot.md) + +[Restart-AzWebAppSlot](./Restart-AzWebAppSlot.md) + +[Start-AzWebAppSlot](./Start-AzWebAppSlot.md) + +[Stop-AzWebAppSlot](./Stop-AzWebAppSlot.md) + +[Get-AzAppServicePlan](./Get-AzAppServicePlan.md) diff --git a/azps-10.1.0/Az.Websites/Set-AzWebAppSlotConfigName.md b/azps-10.1.0/Az.Websites/Set-AzWebAppSlotConfigName.md new file mode 100644 index 0000000000..ea27f0ef87 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Set-AzWebAppSlotConfigName.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +ms.assetid: 7DBF937E-2D01-4356-9A5F-C5A4CB6D1A10 +online version: https://learn.microsoft.com/powershell/module/az.websites/set-azwebappslotconfigname +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Set-AzWebAppSlotConfigName.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Set-AzWebAppSlotConfigName.md +--- + +# Set-AzWebAppSlotConfigName + +## SYNOPSIS +Set Web App Slot Config names + +## SYNTAX + +### S1 +``` +Set-AzWebAppSlotConfigName [[-AppSettingNames] <String[]>] [[-ConnectionStringNames] <String[]>] + [-RemoveAllAppSettingNames] [-RemoveAllConnectionStringNames] [-ResourceGroupName] <String> [-Name] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Set-AzWebAppSlotConfigName [[-AppSettingNames] <String[]>] [[-ConnectionStringNames] <String[]>] + [-RemoveAllAppSettingNames] [-RemoveAllConnectionStringNames] [-WebApp] <PSSite> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Set-AzWebAppSlotConfigName** cmdlet marks App Settings and Connection Strings as slot settings + +## EXAMPLES + +### Example 1 +```powershell +Set-AzWebAppSlotConfigName -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -RemoveAllAppSettingNames -RemoveAllConnectionStringNames +``` + +This command removes all app settings and connection strings for Web App ContosoWebApp associated with the resource group Default-Web-WestUS + +### Example 2 + +Set Web App Slot Config names. (autogenerated) + +<!-- Aladdin Generated Example --> + + +```powershell +Set-AzWebAppSlotConfigName -AppSettingNames <String[]> -Name 'ContosoWebApp' -ResourceGroupName 'Default-Web-WestUS' +``` + +## PARAMETERS + +### -AppSettingNames +App Settings Names String Array + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConnectionStringNames +Connection String Names String Array + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RemoveAllAppSettingNames +Remove All App Setting Names Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAllConnectionStringNames +Remove All Connection String Names Option + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Management.WebSites.Models.SlotConfigNamesResource + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Start-AzWebApp.md b/azps-10.1.0/Az.Websites/Start-AzWebApp.md new file mode 100644 index 0000000000..a09ea302a0 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Start-AzWebApp.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: D70A61D8-0C9A-4BDB-A546-37C32D25797C +online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Start-AzWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Start-AzWebApp.md +--- + +# Start-AzWebApp + +## SYNOPSIS +Starts an Azure Web App. + +## SYNTAX + +### S1 +``` +Start-AzWebApp [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### S2 +``` +Start-AzWebApp [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzWebApp** cmdlet starts an Azure Web App. + +## EXAMPLES + +### Example 1: Start a Web App +```powershell +Start-AzWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" +``` + +This command starts the Web App named ContosoWebApp that belongs to the resource group named Default-Web-WestUS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES + +## RELATED LINKS + +[Get-AzWebApp](./Get-AzWebApp.md) + +[New-AzWebApp](./New-AzWebApp.md) + +[Remove-AzWebApp](./Remove-AzWebApp.md) + +[Restart-AzWebApp](./Restart-AzWebApp.md) + +[Stop-AzWebApp](./Stop-AzWebApp.md) + + diff --git a/azps-10.1.0/Az.Websites/Start-AzWebAppContinuousWebJob.md b/azps-10.1.0/Az.Websites/Start-AzWebAppContinuousWebJob.md new file mode 100644 index 0000000000..0b61406a80 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Start-AzWebAppContinuousWebJob.md @@ -0,0 +1,319 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebappcontinuouswebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Start-AzWebAppContinuousWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Start-AzWebAppContinuousWebJob.md +--- + +# Start-AzWebAppContinuousWebJob + +## SYNOPSIS +Start a continuous web job for an app. + +## SYNTAX + +### Start (Default) +``` +Start-AzWebAppContinuousWebJob -AppName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzWebAppContinuousWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Start a continuous web job for an app. + +## EXAMPLES + +### Example 1: Start a continuous web job for an app +```powershell +Start-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 +``` + +This command starts a continuous web job for an app. + +### Example 2: Start a continuous web job for an app by pipeline +```powershell +Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 | Start-AzWebAppContinuousWebJob +``` + +This command starts a continuous web job for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Start-AzWebAppSlot.md b/azps-10.1.0/Az.Websites/Start-AzWebAppSlot.md new file mode 100644 index 0000000000..561420cf61 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Start-AzWebAppSlot.md @@ -0,0 +1,147 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 0FDDDEE1-CEAD-46DA-A7EB-EE477ED59749 +online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebappslot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Start-AzWebAppSlot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Start-AzWebAppSlot.md +--- + +# Start-AzWebAppSlot + +## SYNOPSIS +Starts an Azure Web App slot. + +## SYNTAX + +### S1 +``` +Start-AzWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Start-AzWebAppSlot [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Start-AzWebAppSlot** cmdlet starts an Azure Web App Slot. + +## EXAMPLES + +### Example 1 +```powershell +Start-AzWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" +``` + +This command starts the Slot named Slot001 pertaining to the Web App named ContosoWebApp that belongs to the resource group named Default-Web-WestUS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +WebApp Slot Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES + +## RELATED LINKS + +[Get-AzWebAppSlot](./Get-AzWebAppSlot.md) + +[New-AzWebAppSlot](./New-AzWebAppSlot.md) + +[Remove-AzWebAppSlot](./Remove-AzWebAppSlot.md) + +[Restart-AzWebAppSlot](./Restart-AzWebAppSlot.md) + +[Set-AzWebAppSlot](./Set-AzWebAppSlot.md) + +[Stop-AzWebAppSlot](./Stop-AzWebAppSlot.md) + +[Get-AzWebApp](./Get-AzWebApp.md) diff --git a/azps-10.1.0/Az.Websites/Start-AzWebAppSlotContinuousWebJob.md b/azps-10.1.0/Az.Websites/Start-AzWebAppSlotContinuousWebJob.md new file mode 100644 index 0000000000..7c972a2f92 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Start-AzWebAppSlotContinuousWebJob.md @@ -0,0 +1,335 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebappslotcontinuouswebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Start-AzWebAppSlotContinuousWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Start-AzWebAppSlotContinuousWebJob.md +--- + +# Start-AzWebAppSlotContinuousWebJob + +## SYNOPSIS +Start a continuous web job for a deployment slot. + +## SYNTAX + +### Start (Default) +``` +Start-AzWebAppSlotContinuousWebJob -AppName <String> -Name <String> -ResourceGroupName <String> + -SlotName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzWebAppSlotContinuousWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Start a continuous web job for a deployment slot. + +## EXAMPLES + +### Example 1: Start a continuous web job for a deployment slot +```powershell +Start-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-01 +``` + +This command starts a continuous web job for an app. + +### Example 2: Start a continuous web job for a deployment slot by pipeline +```powershell +Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-01 | Start-AzWebAppSlotContinuousWebJob +``` + +This command starts a continuous web job for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API deletes a deployment for the production slot. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Start-AzWebAppSlotTriggeredWebJob.md b/azps-10.1.0/Az.Websites/Start-AzWebAppSlotTriggeredWebJob.md new file mode 100644 index 0000000000..2dcf2ef549 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Start-AzWebAppSlotTriggeredWebJob.md @@ -0,0 +1,335 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebappslottriggeredwebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Start-AzWebAppSlotTriggeredWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Start-AzWebAppSlotTriggeredWebJob.md +--- + +# Start-AzWebAppSlotTriggeredWebJob + +## SYNOPSIS +Run a triggered web job for a deployment slot. + +## SYNTAX + +### Run (Default) +``` +Start-AzWebAppSlotTriggeredWebJob -AppName <String> -Name <String> -ResourceGroupName <String> + -SlotName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RunViaIdentity +``` +Start-AzWebAppSlotTriggeredWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Run a triggered web job for a deployment slot. + +## EXAMPLES + +### Example 1: Run a triggered web job for a deployment slot +```powershell +Start-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 +``` + +This command runs a triggered web job for a deployment slot. + +### Example 2: Run a triggered web job for a deployment slot by pipeline +```powershell +Get-AzWebAppSlotTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slottriggeredjob-03 | Start-AzWebAppSlotTriggeredWebJob +``` + +This command runs a triggered web job for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: RunViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API uses the production slot. + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Start-AzWebAppTriggeredWebJob.md b/azps-10.1.0/Az.Websites/Start-AzWebAppTriggeredWebJob.md new file mode 100644 index 0000000000..af8a72b7fd --- /dev/null +++ b/azps-10.1.0/Az.Websites/Start-AzWebAppTriggeredWebJob.md @@ -0,0 +1,319 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/start-azwebapptriggeredwebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Start-AzWebAppTriggeredWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Start-AzWebAppTriggeredWebJob.md +--- + +# Start-AzWebAppTriggeredWebJob + +## SYNOPSIS +Run a triggered web job for an app. + +## SYNTAX + +### Run (Default) +``` +Start-AzWebAppTriggeredWebJob -AppName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### RunViaIdentity +``` +Start-AzWebAppTriggeredWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Run a triggered web job for an app. + +## EXAMPLES + +### Example 1: Run a triggered web job for an app +```powershell +Start-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 +``` + +This command runs a triggered web job for an app. + +### Example 2: Run a triggered web job for an app by pipeline +```powershell +Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 | Start-AzWebAppTriggeredWebJob +``` + +This command runs a triggered web job for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: RunViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Run +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Stop-AzWebApp.md b/azps-10.1.0/Az.Websites/Stop-AzWebApp.md new file mode 100644 index 0000000000..b161be61fc --- /dev/null +++ b/azps-10.1.0/Az.Websites/Stop-AzWebApp.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: A12FFDB1-9849-4150-9716-068BE6EFC681 +online version: https://learn.microsoft.com/powershell/module/az.websites/stop-azwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Stop-AzWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Stop-AzWebApp.md +--- + +# Stop-AzWebApp + +## SYNOPSIS +Stops an Azure Web App. + +## SYNTAX + +### S1 +``` +Stop-AzWebApp [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] + [<CommonParameters>] +``` + +### S2 +``` +Stop-AzWebApp [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzWebApp** cmdlet stops an Azure Web App. + +## EXAMPLES + +### Example 1: Stop a Web App +```powershell +Stop-AzWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" +``` + +This command stops the Web App named ContosoWebApp that belongs to the resource group named Default-Web-WestUS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES + +## RELATED LINKS + +[Get-AzWebApp](./Get-AzWebApp.md) + +[New-AzWebApp](./New-AzWebApp.md) + +[Remove-AzWebApp](./Remove-AzWebApp.md) + +[Restart-AzWebApp](./Restart-AzWebApp.md) + +[Start-AzWebApp](./Start-AzWebApp.md) + + diff --git a/azps-10.1.0/Az.Websites/Stop-AzWebAppContinuousWebJob.md b/azps-10.1.0/Az.Websites/Stop-AzWebAppContinuousWebJob.md new file mode 100644 index 0000000000..6238b3486d --- /dev/null +++ b/azps-10.1.0/Az.Websites/Stop-AzWebAppContinuousWebJob.md @@ -0,0 +1,319 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/stop-azwebappcontinuouswebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Stop-AzWebAppContinuousWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Stop-AzWebAppContinuousWebJob.md +--- + +# Stop-AzWebAppContinuousWebJob + +## SYNOPSIS +Stop a continuous web job for an app. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzWebAppContinuousWebJob -AppName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzWebAppContinuousWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Stop a continuous web job for an app. + +## EXAMPLES + +### Example 1: Stop a continuous web job for an app +```powershell +Stop-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 +``` + +This command stops a continuous web job for an app. + +### Example 2: Stop a continuous web job for an app by pipeline +```powershell +Get-AzWebAppContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name continuousjob-01 | Stop-AzWebAppContinuousWebJob +``` + +This command stops a continuous web job for an app by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Stop-AzWebAppSlot.md b/azps-10.1.0/Az.Websites/Stop-AzWebAppSlot.md new file mode 100644 index 0000000000..ce370ed6a9 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Stop-AzWebAppSlot.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 86E0D477-DD32-49BD-82E7-1CF191E4F612 +online version: https://learn.microsoft.com/powershell/module/az.websites/stop-azwebappslot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Stop-AzWebAppSlot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Stop-AzWebAppSlot.md +--- + +# Stop-AzWebAppSlot + +## SYNOPSIS +Stops an Azure Web App slot. + +## SYNTAX + +### S1 +``` +Stop-AzWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +### S2 +``` +Stop-AzWebAppSlot [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] +``` + +## DESCRIPTION +The **Stop-AzWebAppSlot** cmdlet stops an Azure Web App Slot. + +## EXAMPLES + +### Example 1 +```powershell +Stop-AzWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" +``` + +This command stops the slot Slot001 pertaining to the Web App named ContosoWebApp that belongs to the resource group named Default-Web-WestUS. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Slot +WebApp Slot Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Stop-AzWebAppSlotContinuousWebJob.md b/azps-10.1.0/Az.Websites/Stop-AzWebAppSlotContinuousWebJob.md new file mode 100644 index 0000000000..1b84669664 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Stop-AzWebAppSlotContinuousWebJob.md @@ -0,0 +1,335 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/stop-azwebappslotcontinuouswebjob +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Stop-AzWebAppSlotContinuousWebJob.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Stop-AzWebAppSlotContinuousWebJob.md +--- + +# Stop-AzWebAppSlotContinuousWebJob + +## SYNOPSIS +Stop a continuous web job for a deployment slot. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzWebAppSlotContinuousWebJob -AppName <String> -Name <String> -ResourceGroupName <String> + -SlotName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### StopViaIdentity +``` +Stop-AzWebAppSlotContinuousWebJob -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Stop a continuous web job for a deployment slot. + +## EXAMPLES + +### Example 1: Stop a continuous web job for a deployment slot +```powershell +Stop-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-01 +``` + +This command stops a continuous web job for an app. + +### Example 2: Stop a continuous web job for a deployment slot by pipeline +```powershell +Get-AzWebAppSlotContinuousWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -SlotName slot01 -Name slotcontinuousjob-01 | Stop-AzWebAppSlotContinuousWebJob +``` + +This command stops a continuous web job for a deployment slot by pipeline. + +## PARAMETERS + +### -AppName +Site name. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of Web Job. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +Name of the deployment slot. +If a slot is not specified, the API deletes a deployment for the production slot. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Switch-AzWebAppSlot.md b/azps-10.1.0/Az.Websites/Switch-AzWebAppSlot.md new file mode 100644 index 0000000000..b68b2b4800 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Switch-AzWebAppSlot.md @@ -0,0 +1,216 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +ms.assetid: 258A4EA9-B82C-4664-8DCE-30D47A623868 +online version: https://learn.microsoft.com/powershell/module/az.websites/switch-azwebappslot +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Switch-AzWebAppSlot.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Switch-AzWebAppSlot.md +--- + +# Switch-AzWebAppSlot + +## SYNOPSIS +Swap two slots within a Web App + +## SYNTAX + +### S1 +``` +Switch-AzWebAppSlot [-SourceSlotName] <String> [[-DestinationSlotName] <String>] + [[-SwapWithPreviewAction] <SwapWithPreviewAction>] [[-PreserveVnet] <Boolean>] [-ResourceGroupName] <String> + [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### S2 +``` +Switch-AzWebAppSlot [-SourceSlotName] <String> [[-DestinationSlotName] <String>] + [[-SwapWithPreviewAction] <SwapWithPreviewAction>] [[-PreserveVnet] <Boolean>] [-WebApp] <PSSite> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Switch-AzWebAppSlot** cmdlet switches two slots associated with an Azure Web App. + +## EXAMPLES + +### Example 1 +```powershell +Switch-AzWebAppSlot -SourceSlotName "sourceslot" -DestinationSlotName "destinationslot" -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" +``` + +This command will switch slot "sourceslot" with slot "destinationslot" on the Web App ContosoWebApp in the resource group Default-Web-WestUS. + +> [!NOTE] +> Use "production" as the slot name when the either the source or destination slot is intended to be the production slot. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DestinationSlotName +Destination Slot Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PreserveVnet +Preserve Vnet Boolean + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: S1 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSlotName +Source Slot Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SwapWithPreviewAction +Swap With Preview Action + +```yaml +Type: System.Nullable`1[Microsoft.Azure.Commands.WebApps.Utilities.SwapWithPreviewAction] +Parameter Sets: (All) +Aliases: +Accepted values: ApplySlotConfig, CompleteSlotSwap, ResetSlotSwap + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebApp +WebApp Object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSSite +Parameter Sets: S2 +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### Microsoft.Azure.Commands.WebApps.Models.PSSite + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Test-AzStaticWebAppCustomDomain.md b/azps-10.1.0/Az.Websites/Test-AzStaticWebAppCustomDomain.md new file mode 100644 index 0000000000..5bdc042095 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Test-AzStaticWebAppCustomDomain.md @@ -0,0 +1,381 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/test-azstaticwebappcustomdomain +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Test-AzStaticWebAppCustomDomain.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Test-AzStaticWebAppCustomDomain.md +--- + +# Test-AzStaticWebAppCustomDomain + +## SYNOPSIS +Description for Validates a particular custom domain can be added to a static site. + +## SYNTAX + +### ValidateExpanded (Default) +``` +Test-AzStaticWebAppCustomDomain -DomainName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-Kind <String>] [-ValidationMethod <String>] [-DefaultProfile <PSObject>] [-AsJob] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] + [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] + [-Confirm] [<CommonParameters>] +``` + +### ValidateViaIdentityExpanded +``` +Test-AzStaticWebAppCustomDomain -InputObject <IWebsitesIdentity> [-Kind <String>] [-ValidationMethod <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-NoWait] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Validates a particular custom domain can be added to a static site. + +## EXAMPLES + +### Example 1: Validate a particular custom domain can be added to a static site +```powershell +Test-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName 'www01.azpstest.net' +``` + +This commnad validates a particular custom domain can be added to a static site + +### Example 2: Validate a particular custom domain can be added to a static site by pipeline +```powershell +Get-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName 'www01.azpstest.net' | Get-AzStaticWebAppCustomDomain +``` + +This commnad validates a particular custom domain can be added to a static site by pipeline. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainName +The custom domain to validate. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +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.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: ValidateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: ValidateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationMethod +Validation method for adding a custom domain + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md b/azps-10.1.0/Az.Websites/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md new file mode 100644 index 0000000000..9f7ce97305 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md @@ -0,0 +1,335 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/unregister-azstaticwebappbuilduserprovidedfunctionapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Unregister-AzStaticWebAppBuildUserProvidedFunctionApp.md +--- + +# Unregister-AzStaticWebAppBuildUserProvidedFunctionApp + +## SYNOPSIS +Description for Detach the user provided function app from the static site build + +## SYNTAX + +### Detach (Default) +``` +Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -EnvironmentName <String> -FunctionAppName <String> + -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DetachViaIdentity +``` +Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -InputObject <IWebsitesIdentity> + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Detach the user provided function app from the static site build + +## EXAMPLES + +### Example 1: Unregister the user provided function app from the static site build +```powershell +Unregister-AzStaticWebAppBuildUserProvidedFunctionApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' -EnvironmentName 'default' -FunctionAppName 'functionAppName01' +``` + +This command unregisters the user provided function app from the static site build. + +### Example 2: Unregister the user provided function app from the static site build by pipeline +```powershell +Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' -EnvironmentName 'default' -FunctionAppName 'functionAppName01' -FunctionAppResourceId 'functionAppId01' -FunctionAppRegion 'eastus' -Forced | Unregister-AzStaticWebAppBuildUserProvidedFunctionApp +``` + +This command unregisters the user provided function app from the static site build by pipeline. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnvironmentName +The stage site identifier. + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunctionAppName +Name of the function app registered with the static site build. + +```yaml +Type: System.String +Parameter Sets: Detach +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.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: DetachViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Unregister-AzStaticWebAppUserProvidedFunctionApp.md b/azps-10.1.0/Az.Websites/Unregister-AzStaticWebAppUserProvidedFunctionApp.md new file mode 100644 index 0000000000..b21208ff03 --- /dev/null +++ b/azps-10.1.0/Az.Websites/Unregister-AzStaticWebAppUserProvidedFunctionApp.md @@ -0,0 +1,320 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/unregister-azstaticwebappuserprovidedfunctionapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Unregister-AzStaticWebAppUserProvidedFunctionApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Unregister-AzStaticWebAppUserProvidedFunctionApp.md +--- + +# Unregister-AzStaticWebAppUserProvidedFunctionApp + +## SYNOPSIS +Description for Detach the user provided function app from the static site + +## SYNTAX + +### Detach (Default) +``` +Unregister-AzStaticWebAppUserProvidedFunctionApp -FunctionAppName <String> -Name <String> + -ResourceGroupName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### DetachViaIdentity +``` +Unregister-AzStaticWebAppUserProvidedFunctionApp -InputObject <IWebsitesIdentity> [-DefaultProfile <PSObject>] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-PassThru] + [-Proxy <Uri>] [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] + [<CommonParameters>] +``` + +## DESCRIPTION +Description for Detach the user provided function app from the static site + +## EXAMPLES + +### Example 1: Unregister the user provided function app from the static site +```powershell +Unregister-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' -FunctionAppName 'functionAppName01' +``` + +This command unregisters the user provided function app from the static site. + +### Example 2: Unregister the user provided function app from the static site by pipeline +```powershell +Register-AzStaticWebAppUserProvidedFunctionApp -ResourceGroupName $env.resourceGroup -Name $env.staticweb00 -FunctionAppName $env.functionAppName01 -FunctionAppResourceId $env.functionAppId01 -FunctionAppRegion $env.location -Forced | Unregister-AzStaticWebAppUserProvidedFunctionApp +``` + +This command unregisters the user provided function app from the static site by pipeline. + +## PARAMETERS + +### -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. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunctionAppName +Name of the function app registered with the static site. + +```yaml +Type: System.String +Parameter Sets: Detach +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.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: DetachViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: Detach +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Update-AzStaticWebApp.md b/azps-10.1.0/Az.Websites/Update-AzStaticWebApp.md new file mode 100644 index 0000000000..a96e6e048d --- /dev/null +++ b/azps-10.1.0/Az.Websites/Update-AzStaticWebApp.md @@ -0,0 +1,602 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/update-azstaticwebapp +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Update-AzStaticWebApp.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Update-AzStaticWebApp.md +--- + +# Update-AzStaticWebApp + +## SYNOPSIS +Description for Creates a new static site in an existing resource group, or updates an existing static site. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStaticWebApp -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-AllowConfigFileUpdate] [-ApiBuildCommand <String>] [-ApiLocation <String>] [-AppArtifactLocation <String>] + [-AppBuildCommand <String>] [-AppLocation <String>] [-Branch <String>] [-ForkRepositoryDescription <String>] + [-ForkRepositoryIsPrivate] [-ForkRepositoryName <String>] [-ForkRepositoryOwner <String>] + [-GithubActionSecretNameOverride <String>] [-Kind <String>] [-OutputLocation <String>] + [-RepositoryToken <String>] [-RepositoryUrl <String>] [-SkipGithubActionWorkflowGeneration] + [-StagingEnvironmentPolicy <StagingEnvironmentPolicy>] [-TemplateRepositoryUrl <String>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStaticWebApp -InputObject <IWebsitesIdentity> [-AllowConfigFileUpdate] [-ApiBuildCommand <String>] + [-ApiLocation <String>] [-AppArtifactLocation <String>] [-AppBuildCommand <String>] [-AppLocation <String>] + [-Branch <String>] [-ForkRepositoryDescription <String>] [-ForkRepositoryIsPrivate] + [-ForkRepositoryName <String>] [-ForkRepositoryOwner <String>] [-GithubActionSecretNameOverride <String>] + [-Kind <String>] [-OutputLocation <String>] [-RepositoryToken <String>] [-RepositoryUrl <String>] + [-SkipGithubActionWorkflowGeneration] [-StagingEnvironmentPolicy <StagingEnvironmentPolicy>] + [-TemplateRepositoryUrl <String>] [-DefaultProfile <PSObject>] [-Break] + [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Creates a new static site in an existing resource group, or updates an existing static site. + +## EXAMPLES + +### Example 1: Update a static site +```powershell +Update-AzStaticWebApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb00 Microsoft.Web/staticSites +``` + +This command updates a static site. + +### Example 2: Update a static site by pipeline +```powershell +Get-AzStaticWebApp -ResourceGroupName 'resourceGroup' -Name 'staticweb00' | Update-AzStaticWebApp +``` + +```output +Kind Location Name Type +---- -------- ---- ---- + Central US staticweb00 Microsoft.Web/staticSites +``` + +This command updates a static site by pipeline. + +## PARAMETERS + +### -AllowConfigFileUpdate +\<code\>false\</code\> if config file is locked for this static web app; otherwise, \<code\>true\</code\>. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiBuildCommand +A custom command to run during deployment of the Azure Functions API application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiLocation +The path to the api code within the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppArtifactLocation +Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppBuildCommand +A custom command to run during deployment of the static content application. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppLocation +The path to the app code within the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Branch +The target branch in the repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryDescription +Description of the newly generated repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryIsPrivate +Whether or not the newly generated repository is a private repository. +Defaults to false (i.e. +public). + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryName +Name of the newly generated repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForkRepositoryOwner +Owner of the newly generated repository. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GithubActionSecretNameOverride +Github Action secret name override. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +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.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site to create or update. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputLocation +The output path of the app after building. + +```yaml +Type: System.String +Parameter Sets: (All) +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 + +```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 +``` + +### -RepositoryToken +A user's github repository token. +This is used to setup the Github Actions workflow file and API secrets. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepositoryUrl +URL for the repository of the static site. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipGithubActionWorkflowGeneration +Skip Github Action workflow generation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StagingEnvironmentPolicy +State indicating whether staging environments are allowed or not allowed for a static web app. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.Support.StagingEnvironmentPolicy +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateRepositoryUrl +URL of the template repository. +The newly generated repository will be based on this one. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteArmResource + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Update-AzStaticWebAppUser.md b/azps-10.1.0/Az.Websites/Update-AzStaticWebAppUser.md new file mode 100644 index 0000000000..201b69aece --- /dev/null +++ b/azps-10.1.0/Az.Websites/Update-AzStaticWebAppUser.md @@ -0,0 +1,363 @@ +--- +external help file: Az.Websites-help.xml +Module Name: Az.Websites +online version: https://learn.microsoft.com/powershell/module/az.websites/update-azstaticwebappuser +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Update-AzStaticWebAppUser.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Update-AzStaticWebAppUser.md +--- + +# Update-AzStaticWebAppUser + +## SYNOPSIS +Description for Updates a user entry with the listed roles + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStaticWebAppUser -AuthProvider <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] -UserId <String> [-Kind <String>] [-Role <String>] [-DefaultProfile <PSObject>] + [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] + [-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStaticWebAppUser -InputObject <IWebsitesIdentity> [-Kind <String>] [-Role <String>] + [-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>] + [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +Description for Updates a user entry with the listed roles + +## EXAMPLES + +### Example 1: Update a user entry with the listed roles +```powershell +Update-AzStaticWebAppUser -ResourceGroupName azure-rg-test -Name staticweb-portal01 -Authprovider 'github' -Userid 'fa4eba85fa9f4a42b5300dc4c7bb45aa' -Role 'contributor' +``` + +```output +Kind Name Type +---- ---- ---- + fa4eba85fa9f4a42b5300dc4c7bb45aa Microsoft.Web/staticSites/users +``` + +This command updates a user entry with the listed roles. + +### Example 2: Update a user entry with the listed roles by pipeline +```powershell +Get-AzStaticWebAppUser -ResourceGroupName azure-rg-test -Name staticweb-portal01 -Authprovider 'all' | Update-AzStaticWebAppUser -Role 'contributor' +``` + +```output +Kind Name Type +---- ---- ---- + fa4eba85fa9f4a42b5300dc4c7bb45aa Microsoft.Web/staticSites/users + 8bcf2cef5f3c4c8e9a58386d62bba7c3 Microsoft.Web/staticSites/users +``` + +This command updates a user entry with the listed roles by pipeline. + +## PARAMETERS + +### -AuthProvider +The auth provider for this user. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Websites.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.Websites.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.Websites.Models.IWebsitesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Kind of resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the static site. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +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 +Name of the resource group to which the resource belongs. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The roles for the static site user, in free-form string format + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Your Azure subscription ID. +This is a GUID-formatted string (e.g. +00000000-0000-0000-0000-000000000000). + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +The user id of the user. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20201201.IStaticSiteUserArmResource + +## 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 <IWebsitesIdentity>`: Identity Parameter + - `[Authprovider <String>]`: The auth provider for the users. + - `[DomainName <String>]`: The custom domain name. + - `[EnvironmentName <String>]`: The stage site identifier. + - `[FunctionAppName <String>]`: Name of the function app registered with the static site build. + - `[Id <String>]`: Resource identity path + - `[JobHistoryId <String>]`: History ID. + - `[Location <String>]`: Location where you plan to create the static site. + - `[Name <String>]`: Name of the static site. + - `[PrivateEndpointConnectionName <String>]`: Name of the private endpoint connection. + - `[ResourceGroupName <String>]`: Name of the resource group to which the resource belongs. + - `[Slot <String>]`: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. + - `[SubscriptionId <String>]`: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). + - `[Userid <String>]`: The user id of the user. + - `[WebJobName <String>]`: Name of Web Job. + +## RELATED LINKS diff --git a/azps-10.1.0/Az.Websites/Update-AzWebAppAccessRestrictionConfig.md b/azps-10.1.0/Az.Websites/Update-AzWebAppAccessRestrictionConfig.md new file mode 100644 index 0000000000..d28c9e5dbe --- /dev/null +++ b/azps-10.1.0/Az.Websites/Update-AzWebAppAccessRestrictionConfig.md @@ -0,0 +1,203 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.WebSites +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Update-AzWebAppAccessRestrictionConfig.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Update-AzWebAppAccessRestrictionConfig.md +--- + +# Update-AzWebAppAccessRestrictionConfig + +## SYNOPSIS +Updates the inheritance of Main site Access Restiction config to SCM Site for an Azure Web App. + +## SYNTAX + +### InputValuesParameterSet (Default) +``` +Update-AzWebAppAccessRestrictionConfig [-ResourceGroupName] <String> [-Name] <String> + [-ScmSiteUseMainSiteRestrictionConfig] [-SlotName <String>] [-PassThru] + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +### InputObjectParameterSet +``` +Update-AzWebAppAccessRestrictionConfig [-PassThru] -InputObject <PSAccessRestrictionConfig> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzWebAppAccessRestrictionConfig** cmdlet updates Access Restriction config for an Azure Web App. + +## EXAMPLES + +### Example 1: Update a Web App SCM Site to use Access Restrictions from Main Site + +The following example updates a Web App named IpRule that belongs to the resource group MyResourceGroup to use access restriction config of main site on the scm site. + +<!-- Aladdin Generated Example --> + + +```powershell +Update-AzWebAppAccessRestrictionConfig -Name IpRule -ResourceGroupName MyResourceGroup -ScmSiteUseMainSiteRestrictionConfig +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The access restriction config object + +```yaml +Type: Microsoft.Azure.Commands.WebApps.Models.PSAccessRestrictionConfig +Parameter Sets: InputObjectParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +WebApp Name + +```yaml +Type: System.String +Parameter Sets: InputValuesParameterSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Return the access restriction config object. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Resource Group Name + +```yaml +Type: System.String +Parameter Sets: InputValuesParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ScmSiteUseMainSiteRestrictionConfig +Scm site inherits rules set on Main site. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: InputValuesParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SlotName +Deployment Slot name. + +```yaml +Type: System.String +Parameter Sets: InputValuesParameterSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### Microsoft.Azure.Commands.WebApps.Models.PSAccessRestrictionConfig + +## NOTES + +## RELATED LINKS + +[Get-AzWebAppAccessRestrictionConfig](./Get-AzWebAppAccessRestrictionConfig.md) + +[Add-AzWebAppAccessRestrictionRule](./Add-AzWebAppAccessRestrictionRule.md) + +[Remove-AzWebAppAccessRestrictionRule](./Remove-AzWebAppAccessRestrictionRule.md) diff --git a/azps-10.1.0/Az.Websites/Update-AzWebAppTrafficRouting.md b/azps-10.1.0/Az.Websites/Update-AzWebAppTrafficRouting.md new file mode 100644 index 0000000000..31a3993f7a --- /dev/null +++ b/azps-10.1.0/Az.Websites/Update-AzWebAppTrafficRouting.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Azure.PowerShell.Cmdlets.Websites.dll-Help.xml +Module Name: Az.Websites +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Update-AzWebAppTrafficRouting.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Websites/Websites/help/Update-AzWebAppTrafficRouting.md +--- + +# Update-AzWebAppTrafficRouting + +## SYNOPSIS +Update a routing Rule to the Slot. + +## SYNTAX + +``` +Update-AzWebAppTrafficRouting -ResourceGroupName <String> -WebAppName <String> -RoutingRule <Hashtable> + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] +``` + +## DESCRIPTION +The **Update-AzWebAppTrafficRouting** cmdlet updates the routing rule configuration for an Azure Web App Slot. + +## EXAMPLES + +### Example 1: Update a routing rule to transfer 15% of production traffice to Stg slot +```powershell +Update-AzWebAppTrafficRouting -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoSite" ` +-RoutingRule @{ActionHostName='XXXX.azurewebsites.net';ReroutePercentage=15;Name='Stg'} +``` + +This command updates a routing rule to transfer 15% of production traffic to Stg slot. + +### Example 2: Update a routing rule to transfer the production traffice to Stg slot ranges from 50% to 90% in incremental manner. +```powershell +Update-AzWebAppTrafficRouting -ResourceGroupName "Default-Web-WestUS" -WebAppName "ContosoSite" ` +-RoutingRule @{ActionHostName='XXXX.azurewebsites.net';ReroutePercentage=50;ChangeIntervalInMinutes=1;MinReroutePercentage=50;MaxReroutePercentage=90;Name='Stg';ChangeStep=10} +``` + +This command Updates a routing rule to transfer the production traffice to Stg slot ranges from 50% to 90% in incremental manner. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer +Parameter Sets: (All) +Aliases: AzContext, AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +ResourceGroupName + + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingRule +Web App RoutingRule. +Example: -RoutingRule @{ActionHostName=$slot.DefaultHostName ; ReroutePercentage=$ReroutePercentage ; Name=$slotName} + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebAppName +WebApp Name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Azure.Management.WebSites.Models.RampUpRule + +## NOTES + +## RELATED LINKS + +[Add-AzWebAppTrafficRouting](./Add-AzWebAppTrafficRouting.md) + +[Get-AzWebAppTrafficRouting](./Get-AzWebAppTrafficRouting.md) + +[Remove-AzWebAppTrafficRouting](./Remove-AzWebAppTrafficRouting.md) \ No newline at end of file diff --git a/azps-10.1.0/Az.WindowsIotServices/Az.WindowsIotServices.md b/azps-10.1.0/Az.WindowsIotServices/Az.WindowsIotServices.md new file mode 100644 index 0000000000..9663364140 --- /dev/null +++ b/azps-10.1.0/Az.WindowsIotServices/Az.WindowsIotServices.md @@ -0,0 +1,29 @@ +--- +Module Name: Az.WindowsIotServices +Module Guid: d5c7f2ce-fe23-49d5-a869-fb780e78a663 +Download Help Link: https://learn.microsoft.com/powershell/module/az.windowsiotservices +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/WindowsIotServices/help/Az.WindowsIotServices.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/WindowsIotServices/help/Az.WindowsIotServices.md +--- + +# Az.WindowsIotServices Module +## Description +Microsoft Azure PowerShell: WindowsIotServices cmdlets + +## Az.WindowsIotServices Cmdlets +### [Get-AzWindowsIotServicesDevice](Get-AzWindowsIotServicesDevice.md) +Get the non-security related metadata of a Windows IoT Device Service. + +### [New-AzWindowsIotServicesDevice](New-AzWindowsIotServicesDevice.md) +Create or update the metadata of a Windows IoT Device Service. +The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service. + +### [Remove-AzWindowsIotServicesDevice](Remove-AzWindowsIotServicesDevice.md) +Delete a Windows IoT Device Service. + +### [Update-AzWindowsIotServicesDevice](Update-AzWindowsIotServicesDevice.md) +Updates the metadata of a Windows IoT Device Service. +The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service. + diff --git a/azps-10.1.0/Az.WindowsIotServices/Get-AzWindowsIotServicesDevice.md b/azps-10.1.0/Az.WindowsIotServices/Get-AzWindowsIotServicesDevice.md new file mode 100644 index 0000000000..6bcda5f8aa --- /dev/null +++ b/azps-10.1.0/Az.WindowsIotServices/Get-AzWindowsIotServicesDevice.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.WindowsIotServices +online version: https://learn.microsoft.com/powershell/module/az.windowsiotservices/get-azwindowsiotservicesdevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/WindowsIotServices/help/Get-AzWindowsIotServicesDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/WindowsIotServices/help/Get-AzWindowsIotServicesDevice.md +--- + +# Get-AzWindowsIotServicesDevice + +## SYNOPSIS +Get the non-security related metadata of a Windows IoT Device Service. + +## SYNTAX + +### List1 (Default) +``` +Get-AzWindowsIotServicesDevice [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWindowsIotServicesDevice -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWindowsIotServicesDevice -InputObject <IWindowsIotServicesIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzWindowsIotServicesDevice -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Get the non-security related metadata of a Windows IoT Device Service. + +## EXAMPLES + +### Example 1: Get all Windows IoT services under a subscription +```powershell +Get-AzWindowsIotServicesDevice +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +West US wsi-t01 Microsoft.WindowsIoT/DeviceServices "5c006e63-0000-0700-0000-5faa37830000" +eastus wsi-t02 Microsoft.WindowsIoT/DeviceServices "5c006ad2-0000-0700-0000-5faa3e090000" +``` + +This command gets all Windows IoT services under a subscription. + +### Example 2: Get all Windows IoT services under a resource group +```powershell +Get-AzWindowsIotServicesDevice -ResourceGroupName azure-rg-test +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +West US wsi-t01 Microsoft.WindowsIoT/DeviceServices "5c006e63-0000-0700-0000-5faa37830000" +eastus wsi-t02 Microsoft.WindowsIoT/DeviceServices "5c006ad2-0000-0700-0000-5faa3e090000" +``` + +This command gets all Windows IoT services under a resource group. + +### Example 3: Get a Windows IoT service by name +```powershell +Get-AzWindowsIotServicesDevice -ResourceGroupName azure-rg-test -Name wsi-t01 +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +West US wsi-t01 Microsoft.WindowsIoT/DeviceServices "5c006e63-0000-0700-0000-5faa37830000" +``` + +This command gets a Windows IoT service by name. + +### Example 4: Get a Windows IoT service by object +```powershell +$wsi = New-AzWindowsIotServicesDevice -Name wsi-t01 -ResourceGroupName azure-rg-test -Location eastus -Quantity 10 -BillingDomainName 'microsoft.onmicrosoft.com' -AdminDomainName 'microsoft.onmicrosoft.com' +Get-AzWindowsIotServicesDevice -InputObject $wsi +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +West US wsi-t01 Microsoft.WindowsIoT/DeviceServices "5c006e63-0000-0700-0000-5faa37830000" +``` + +This command gets a Windows IoT service by object. + +### Example 5: Get a Windows IoT service by pipeline +```powershell +$wsi = New-AzWindowsIotServicesDevice -Name wsi-t01 -ResourceGroupName azure-rg-test -Location eastus -Quantity 10 -BillingDomainName 'microsoft.onmicrosoft.com' -AdminDomainName 'microsoft.onmicrosoft.com' | Get-AzWindowsIotServicesDevice +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +West US wsi-t01 Microsoft.WindowsIoT/DeviceServices "5c006e63-0000-0700-0000-5faa37830000" +``` + +This command gets a Windows IoT service by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WindowsIotServices.Models.IWindowsIotServicesIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Windows IoT Device Service. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the Windows IoT Device Service. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WindowsIotServices.Models.IWindowsIotServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WindowsIotServices.Models.Api20190601.IDeviceService + +## 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 `<IWindowsIotServicesIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the Windows IoT Device Service. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group that contains the Windows IoT Device Service. + - `[SubscriptionId <String>]`: The subscription identifier. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.WindowsIotServices/New-AzWindowsIotServicesDevice.md b/azps-10.1.0/Az.WindowsIotServices/New-AzWindowsIotServicesDevice.md new file mode 100644 index 0000000000..27d27a1ec5 --- /dev/null +++ b/azps-10.1.0/Az.WindowsIotServices/New-AzWindowsIotServicesDevice.md @@ -0,0 +1,273 @@ +--- +external help file: +Module Name: Az.WindowsIotServices +online version: https://learn.microsoft.com/powershell/module/az.windowsiotservices/new-azwindowsiotservicesdevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/WindowsIotServices/help/New-AzWindowsIotServicesDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/WindowsIotServices/help/New-AzWindowsIotServicesDevice.md +--- + +# New-AzWindowsIotServicesDevice + +## SYNOPSIS +Create or update the metadata of a Windows IoT Device Service. +The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service. + +## SYNTAX + +``` +New-AzWindowsIotServicesDevice -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IfMatch <String>] [-AdminDomainName <String>] [-BillingDomainName <String>] [-Etag <String>] + [-Location <String>] [-Note <String>] [-Quantity <Int64>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Create or update the metadata of a Windows IoT Device Service. +The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service. + +## EXAMPLES + +### Example 1: Create a new Windows IoT services +```powershell +New-AzWindowsIotServicesDevice -Name wsi-t03 -ResourceGroupName azure-rg-test -Location eastus -Quantity 10 -BillingDomainName 'microsoft.onmicrosoft.com' -AdminDomainName 'microsoft.onmicrosoft.com' +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +eastus wsi-t03 Microsoft.WindowsIoT/DeviceServices "6a00eee9-0000-0700-0000-5fab82870000" +``` + +This command creates a new Windows IoT services. + +## PARAMETERS + +### -AdminDomainName +Windows IoT Device Service OEM AAD domain + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingDomainName +Windows IoT Device Service ODM AAD domain + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +The Etag field is *not* required. +If it is provided in the response body, it must also be provided as a header per the normal ETag convention. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the Windows IoT Device Service. +Do not specify for creating a new Windows IoT Device Service. +Required to update an existing Windows IoT Device Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The Azure Region where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Windows IoT Device Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +Windows IoT Device Service notes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quantity +Windows IoT Device Service device allocation, + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the Windows IoT Device Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WindowsIotServices.Models.Api20190601.IDeviceService + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.WindowsIotServices/Remove-AzWindowsIotServicesDevice.md b/azps-10.1.0/Az.WindowsIotServices/Remove-AzWindowsIotServicesDevice.md new file mode 100644 index 0000000000..4434f22e5f --- /dev/null +++ b/azps-10.1.0/Az.WindowsIotServices/Remove-AzWindowsIotServicesDevice.md @@ -0,0 +1,187 @@ +--- +external help file: +Module Name: Az.WindowsIotServices +online version: https://learn.microsoft.com/powershell/module/az.windowsiotservices/remove-azwindowsiotservicesdevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/WindowsIotServices/help/Remove-AzWindowsIotServicesDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/WindowsIotServices/help/Remove-AzWindowsIotServicesDevice.md +--- + +# Remove-AzWindowsIotServicesDevice + +## SYNOPSIS +Delete a Windows IoT Device Service. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWindowsIotServicesDevice -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWindowsIotServicesDevice -InputObject <IWindowsIotServicesIdentity> [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Delete a Windows IoT Device Service. + +## EXAMPLES + +### Example 1: Remove a Windows IoT services by name +```powershell +Remove-AzWindowsIotServicesDevice -Name wsi-t03 -ResourceGroupName azure-rg-test + +``` + +This command removes a Windows IoT services by name. + +### Example 2: Remove a Windows IoT services by pipeline +```powershell +Get-AzWindowsIotServicesDevice -ResourceGroupName azure-rg-test -Name wsi-t01 | Remove-AzWindowsIotServicesDevice + + +``` + +This command removes a Windows IoT services by pipeline. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WindowsIotServices.Models.IWindowsIotServicesIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Windows IoT Device Service. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the Windows IoT Device Service. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WindowsIotServices.Models.IWindowsIotServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WindowsIotServices.Models.Api20190601.IDeviceService + +## 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 `<IWindowsIotServicesIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the Windows IoT Device Service. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group that contains the Windows IoT Device Service. + - `[SubscriptionId <String>]`: The subscription identifier. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.WindowsIotServices/Update-AzWindowsIotServicesDevice.md b/azps-10.1.0/Az.WindowsIotServices/Update-AzWindowsIotServicesDevice.md new file mode 100644 index 0000000000..9dc82278ce --- /dev/null +++ b/azps-10.1.0/Az.WindowsIotServices/Update-AzWindowsIotServicesDevice.md @@ -0,0 +1,323 @@ +--- +external help file: +Module Name: Az.WindowsIotServices +online version: https://learn.microsoft.com/powershell/module/az.windowsiotservices/update-azwindowsiotservicesdevice +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/WindowsIotServices/help/Update-AzWindowsIotServicesDevice.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/WindowsIotServices/help/Update-AzWindowsIotServicesDevice.md +--- + +# Update-AzWindowsIotServicesDevice + +## SYNOPSIS +Updates the metadata of a Windows IoT Device Service. +The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWindowsIotServicesDevice -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IfMatch <String>] [-AdminDomainName <String>] [-BillingDomainName <String>] [-Etag <String>] + [-Location <String>] [-Note <String>] [-Quantity <Int64>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWindowsIotServicesDevice -InputObject <IWindowsIotServicesIdentity> [-IfMatch <String>] + [-AdminDomainName <String>] [-BillingDomainName <String>] [-Etag <String>] [-Location <String>] + [-Note <String>] [-Quantity <Int64>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Updates the metadata of a Windows IoT Device Service. +The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service. + +## EXAMPLES + +### Example 1: Update a Windows IoT services by name +```powershell +Update-AzWindowsIotServicesDevice -Name wsi-t03 -ResourceGroupName azure-rg-test -Quantity 10 +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +eastus wsi-t03 Microsoft.WindowsIoT/DeviceServices "5d006a5c-0000-0700-0000-5faa46760000" +``` + +This command updates a Windows IoT services by name. + +### Example 2: Update a Windows IoT services by pipeline +```powershell +Get-AzWindowsIotServicesDevice -Name wsi-t03 -ResourceGroupName azure-rg-test | Update-AzWindowsIotServicesDevice -Quantity 100 -Tag @{'oper'='update'} +``` +```output +Location Name Type Etag +-------- ---- ---- ---- +West US wsi-t01 Microsoft.WindowsIoT/DeviceServices "5d005f5f-0000-0700-0000-5faa46ae0000" +``` + +This command updates a Windows IoT services by pipeline. + +## PARAMETERS + +### -AdminDomainName +Windows IoT Device Service OEM AAD domain + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BillingDomainName +Windows IoT Device Service ODM AAD domain + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +The Etag field is *not* required. +If it is provided in the response body, it must also be provided as a header per the normal ETag convention. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +ETag of the Windows IoT Device Service. +Do not specify for creating a brand new Windows IoT Device Service. +Required to update an existing Windows IoT Device Service. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.WindowsIotServices.Models.IWindowsIotServicesIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The Azure Region where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Windows IoT Device Service. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Note +Windows IoT Device Service notes. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quantity +Windows IoT Device Service device allocation, + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group that contains the Windows IoT Device Service. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription identifier. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WindowsIotServices.Models.IWindowsIotServicesIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.WindowsIotServices.Models.Api20190601.IDeviceService + +## 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 `<IWindowsIotServicesIdentity>`: Identity Parameter + - `[DeviceName <String>]`: The name of the Windows IoT Device Service. + - `[Id <String>]`: Resource identity path + - `[ResourceGroupName <String>]`: The name of the resource group that contains the Windows IoT Device Service. + - `[SubscriptionId <String>]`: The subscription identifier. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Az.Workloads.md b/azps-10.1.0/Az.Workloads/Az.Workloads.md new file mode 100644 index 0000000000..4f2a349fe3 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Az.Workloads.md @@ -0,0 +1,138 @@ +--- +Module Name: Az.Workloads +Module Guid: ee197d70-9add-4652-9b94-eab7bc0e93e1 +Download Help Link: https://learn.microsoft.com/powershell/module/az.workloads +Help Version: 1.0.0.0 +Locale: en-US +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Az.Workloads.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Az.Workloads.md +--- + +# Az.Workloads Module +## Description +Microsoft Azure PowerShell: Workloads cmdlets + +## Az.Workloads Cmdlets +### [Get-AzWorkloadsMonitor](Get-AzWorkloadsMonitor.md) +Gets properties of a SAP monitor for the specified subscription, resource group, and resource name. + +### [Get-AzWorkloadsProviderInstance](Get-AzWorkloadsProviderInstance.md) +Gets properties of a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. + +### [Get-AzWorkloadsSapApplicationInstance](Get-AzWorkloadsSapApplicationInstance.md) +Gets the SAP Application Server Instance corresponding to the Virtual Instance for SAP solutions resource. + +### [Get-AzWorkloadsSapCentralInstance](Get-AzWorkloadsSapCentralInstance.md) +Gets the SAP Central Services Instance resource. + +### [Get-AzWorkloadsSapDatabaseInstance](Get-AzWorkloadsSapDatabaseInstance.md) +Gets the SAP Database Instance resource. + +### [Get-AzWorkloadsSapLandscapeMonitor](Get-AzWorkloadsSapLandscapeMonitor.md) +Gets configuration values for Single Pane Of Glass for SAP monitor for the specified subscription, resource group, and resource name. + +### [Get-AzWorkloadsSapVirtualInstance](Get-AzWorkloadsSapVirtualInstance.md) +Gets a Virtual Instance for SAP solutions resource + +### [Invoke-AzWorkloadsSapDiskConfiguration](Invoke-AzWorkloadsSapDiskConfiguration.md) +Get the SAP Disk Configuration Layout prod/non-prod SAP System. + +### [Invoke-AzWorkloadsSapSizingRecommendation](Invoke-AzWorkloadsSapSizingRecommendation.md) +Get SAP sizing recommendations by providing input SAPS for application tier and memory required for database tier + +### [Invoke-AzWorkloadsSapSupportedSku](Invoke-AzWorkloadsSapSupportedSku.md) +Get a list of SAP supported SKUs for ASCS, Application and Database tier. + +### [New-AzWorkloadsMonitor](New-AzWorkloadsMonitor.md) +Creates a SAP monitor for the specified subscription, resource group, and resource name. + +### [New-AzWorkloadsProviderDB2InstanceObject](New-AzWorkloadsProviderDB2InstanceObject.md) +Create an in-memory object for DB2ProviderInstanceProperties. + +### [New-AzWorkloadsProviderHanaDbInstanceObject](New-AzWorkloadsProviderHanaDbInstanceObject.md) +Create an in-memory object for HanaDbProviderInstanceProperties. + +### [New-AzWorkloadsProviderInstance](New-AzWorkloadsProviderInstance.md) +Creates a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. + +### [New-AzWorkloadsProviderPrometheusHaClusterInstanceObject](New-AzWorkloadsProviderPrometheusHaClusterInstanceObject.md) +Create an in-memory object for PrometheusHaClusterProviderInstanceProperties. + +### [New-AzWorkloadsProviderPrometheusOSInstanceObject](New-AzWorkloadsProviderPrometheusOSInstanceObject.md) +Create an in-memory object for PrometheusOSProviderInstanceProperties. + +### [New-AzWorkloadsProviderSapNetWeaverInstanceObject](New-AzWorkloadsProviderSapNetWeaverInstanceObject.md) +Create an in-memory object for SapNetWeaverProviderInstanceProperties. + +### [New-AzWorkloadsProviderSqlServerInstanceObject](New-AzWorkloadsProviderSqlServerInstanceObject.md) +Create an in-memory object for MsSqlServerProviderInstanceProperties. + +### [New-AzWorkloadsSapLandscapeMonitor](New-AzWorkloadsSapLandscapeMonitor.md) +Creates a SAP Landscape Monitor Dashboard for the specified subscription, resource group, and resource name. + +### [New-AzWorkloadsSapLandscapeMonitorMetricThresholdsObject](New-AzWorkloadsSapLandscapeMonitorMetricThresholdsObject.md) +Create an in-memory object for SapLandscapeMonitorMetricThresholds. + +### [New-AzWorkloadsSapLandscapeMonitorSidMappingObject](New-AzWorkloadsSapLandscapeMonitorSidMappingObject.md) +Create an in-memory object for SapLandscapeMonitorSidMapping. + +### [New-AzWorkloadsSapVirtualInstance](New-AzWorkloadsSapVirtualInstance.md) +Creates a Virtual Instance for SAP solutions (VIS) resource + +### [Remove-AzWorkloadsMonitor](Remove-AzWorkloadsMonitor.md) +Deletes a SAP monitor with the specified subscription, resource group, and SAP monitor name. + +### [Remove-AzWorkloadsProviderInstance](Remove-AzWorkloadsProviderInstance.md) +Deletes a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. + +### [Remove-AzWorkloadsSapLandscapeMonitor](Remove-AzWorkloadsSapLandscapeMonitor.md) +Deletes a SAP Landscape Monitor Dashboard with the specified subscription, resource group, and SAP monitor name. + +### [Remove-AzWorkloadsSapVirtualInstance](Remove-AzWorkloadsSapVirtualInstance.md) +Deletes a Virtual Instance for SAP solutions resource and its child resources, that is the associated Central Services Instance, Application Server Instances and Database Instance. + +### [Start-AzWorkloadsSapApplicationInstance](Start-AzWorkloadsSapApplicationInstance.md) +Starts the SAP Application Server Instance. + +### [Start-AzWorkloadsSapCentralInstance](Start-AzWorkloadsSapCentralInstance.md) +Starts the SAP Central Services Instance. + +### [Start-AzWorkloadsSapDatabaseInstance](Start-AzWorkloadsSapDatabaseInstance.md) +Starts the database instance of the SAP system. + +### [Start-AzWorkloadsSapVirtualInstance](Start-AzWorkloadsSapVirtualInstance.md) +Starts the SAP application, that is the Central Services instance and Application server instances. + +### [Stop-AzWorkloadsSapApplicationInstance](Stop-AzWorkloadsSapApplicationInstance.md) +Stops the SAP Application Server Instance. + +### [Stop-AzWorkloadsSapCentralInstance](Stop-AzWorkloadsSapCentralInstance.md) +Stops the SAP Central Services Instance. + +### [Stop-AzWorkloadsSapDatabaseInstance](Stop-AzWorkloadsSapDatabaseInstance.md) +Stops the database instance of the SAP system. + +### [Stop-AzWorkloadsSapVirtualInstance](Stop-AzWorkloadsSapVirtualInstance.md) +Stops the SAP Application, that is the Application server instances and Central Services instance. + +### [Update-AzWorkloadsMonitor](Update-AzWorkloadsMonitor.md) +Patches the Tags field of a SAP monitor for the specified subscription, resource group, and SAP monitor name. + +### [Update-AzWorkloadsSapApplicationInstance](Update-AzWorkloadsSapApplicationInstance.md) +Puts the SAP Application Server Instance resource. + +### [Update-AzWorkloadsSapCentralInstance](Update-AzWorkloadsSapCentralInstance.md) +Updates the SAP Central Services Instance resource. + + +This can be used to update tags on the resource. + +### [Update-AzWorkloadsSapDatabaseInstance](Update-AzWorkloadsSapDatabaseInstance.md) +Updates the Database resource. + +### [Update-AzWorkloadsSapLandscapeMonitor](Update-AzWorkloadsSapLandscapeMonitor.md) +Patches the SAP Landscape Monitor Dashboard for the specified subscription, resource group, and SAP monitor name. + +### [Update-AzWorkloadsSapVirtualInstance](Update-AzWorkloadsSapVirtualInstance.md) +Updates a Virtual Instance for SAP solutions resource + diff --git a/azps-10.1.0/Az.Workloads/Get-AzWorkloadsMonitor.md b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsMonitor.md new file mode 100644 index 0000000000..8ea0d4a2bc --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsMonitor.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/get-azworkloadsmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsMonitor.md +--- + +# Get-AzWorkloadsMonitor + +## SYNOPSIS +Gets properties of a SAP monitor for the specified subscription, resource group, and resource name. + +## SYNTAX + +### List (Default) +``` +Get-AzWorkloadsMonitor [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWorkloadsMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWorkloadsMonitor -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### List1 +``` +Get-AzWorkloadsMonitor -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets properties of a SAP monitor for the specified subscription, resource group, and resource name. + +## EXAMPLES + +### Example 1: List all AMS Instances +```powershell +Get-AzWorkloadsMonitor +``` + +```output +Name ResourceGroupName ManagedResourceGroupConfigurationName Location ProvisioningState +---- ----------------- ------------------------------------- -------- ----------------- +ad-ams-inst ad-ams-rg ad-ams-mrg eastus2euap Deleting +ad-ams-tp ad-ams-rg sapmonrg-q2nti3 eastus2euap Succeeded +ad-ams ad-ams-rg sapmonrg-u2mtiw eastus Succeeded +suha-1606-ams2 suha-0802-rg1 mrg-15061 eastus2euap Failed +``` + +Lists all AMS Instances in the subscription + +### Example 2: List all AMS instances in a Resource Group +```powershell +Get-AzWorkloadsMonitor -ResourceGroupName ad-ams-rg +``` + +```output +Name ResourceGroupName ManagedResourceGroupConfigurationName Location ProvisioningState +---- ----------------- ------------------------------------- -------- ----------------- +ad-ams-inst ad-ams-rg ad-ams-mrg eastus2euap Deleting +ad-ams-tp ad-ams-rg sapmonrg-q2nti3 eastus2euap Succeeded +ad-ams ad-ams-rg sapmonrg-u2mtiw eastus Succeeded +``` + +List all AMS instances in a Resource Group + +### Example 3: Get Information about an AMS Instance +```powershell +Get-AzWorkloadsMonitor -ResourceGroupName ad-ams-rg -Name ad-ams +``` + +```output +Name ResourceGroupName ManagedResourceGroupConfigurationName Location ProvisioningState +---- ----------------- ------------------------------------- -------- ----------------- +ad-ams ad-ams-rg sapmonrg-u2mtiw eastus Succeeded +``` + +Gets information about a specific AMS instance in a resource group + +### Example 4: Get Information about an AMS Instance by Id +```powershell + Get-AzWorkloadsMonitor -InputObject '/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/suha-0802-rg1/providers/Microsoft.Workloads/monitors/suha-1606-ams2' +``` + +```output +Name ResourceGroupName ManagedResourceGroupConfigurationName Location ProvisioningState +---- ----------------- ------------------------------------- -------- ----------------- +suha-1606-ams2 suha-0802-rg1 mrg-15061 eastus2euap Failed + + +``` + +Get Information about an AMS Instance by ArmId + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.IMonitor + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Get-AzWorkloadsProviderInstance.md b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsProviderInstance.md new file mode 100644 index 0000000000..500c5a23ab --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsProviderInstance.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/get-azworkloadsproviderinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsProviderInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsProviderInstance.md +--- + +# Get-AzWorkloadsProviderInstance + +## SYNOPSIS +Gets properties of a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. + +## SYNTAX + +### List (Default) +``` +Get-AzWorkloadsProviderInstance -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWorkloadsProviderInstance -MonitorName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWorkloadsProviderInstance -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets properties of a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. + +## EXAMPLES + +### Example 1: List all providers in an AMS Instance +```powershell +Get-AzWorkloadsProviderInstance -ResourceGroupName ad-ams-rg -MonitorName ad-ams +``` + +```output +Name ResourceGroupName ProvisioningState IdentityType +---- ----------------- ----------------- ------------ +Hana-1-test ad-ams-rg Failed +hana-test-2 ad-ams-rg Succeeded +prov-1 ad-ams-rg Failed +hana-test ad-ams-rg Failed +SAP-NETWEAVER ad-ams-rg Failed +HA3-HANA-HighAvl ad-ams-rg Succeeded +lh-28022023-host ad-ams-rg Failed +as1-sysdb ad-ams-rg Succeeded +h2-test ad-ams-rg Failed +``` + +List all the providers created for an AMS Instance + +### Example 2: Get information about an AMS Provider +```powershell +Get-AzWorkloadsProviderInstance -ResourceGroupName ad-ams-rg -MonitorName ad-ams -Name hana-test-2 +``` + +```output +Name ResourceGroupName ProvisioningState IdentityType +---- ----------------- ----------------- ------------ +hana-test-2 ad-ams-rg Succeeded +``` + +Gets information about a specific AMS Provider + +### Example 3: Get information about an AMS Provider by Id +```powershell +Get-AzWorkloadsProviderInstance -InputObject "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/suha-0802-rg1/providers/Microsoft.Workloads/monitors/ams_mon/providerInstances/suha-db2-1" +``` + +```output + +Name ResourceGroupName ProvisioningState IdentityType +---- ----------------- ----------------- ------------ +suha-db2-1 suha-0802-rg1 Succeeded +``` + +Get information about an AMS Provider by ArmId + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the provider instance. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ProviderInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.IProviderInstance + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapApplicationInstance.md b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapApplicationInstance.md new file mode 100644 index 0000000000..071f66483e --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapApplicationInstance.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/get-azworkloadssapapplicationinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsSapApplicationInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsSapApplicationInstance.md +--- + +# Get-AzWorkloadsSapApplicationInstance + +## SYNOPSIS +Gets the SAP Application Server Instance corresponding to the Virtual Instance for SAP solutions resource. + +## SYNTAX + +### List (Default) +``` +Get-AzWorkloadsSapApplicationInstance -ResourceGroupName <String> -SapVirtualInstanceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWorkloadsSapApplicationInstance -Name <String> -ResourceGroupName <String> + -SapVirtualInstanceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWorkloadsSapApplicationInstance -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the SAP Application Server Instance corresponding to the Virtual Instance for SAP solutions resource. + +## EXAMPLES + +### Example 1: Get an overview of The App Server Instance(s) +```powershell +Get-AzWorkloadsSapApplicationInstance -ResourceGroupName DemoRGVIS -SapVirtualInstanceName DRT +``` + +```output +Name ResourceGroupName Health ProvisioningState Status Hostname Location +---- ----------------- ------ ----------------- ------ -------- -------- +app0 DemoRGVIS Healthy Succeeded Running drtvm eastus2euap +``` + +This command will help you get an overview, including health and status of all the App Server instances in the Virtual instance for SAP solutions + +### Example 2: Get an overview of The App Server Instance +```powershell +Get-AzWorkloadsSapApplicationInstance -ResourceGroupName DemoRGVIS -SapVirtualInstanceName DRT -Name app0 +``` + +```output +Name ResourceGroupName Health ProvisioningState Status Hostname Location +---- ----------------- ------ ----------------- ------ -------- -------- +app0 DemoRGVIS Healthy Succeeded Running drtvm eastus2euap +``` + +This command will help you get an overview, including health and status of a specific App Server instance in the Virtual instance for SAP solutions + +### Example 3: Get an overview of The App Server Instance +```powershell +Get-AzWorkloadsSapApplicationInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/DemoRGVIS/providers/Microsoft.Workloads/sapVirtualInstances/DRT/applicationInstances/app0 +``` + +```output +Name ResourceGroupName Health ProvisioningState Status Hostname Location +---- ----------------- ------ ----------------- ------ -------- -------- +app0 DemoRGVIS Healthy Succeeded Running drtvm eastus2euap +``` + +This command will help you get an overview, including health and status of a specific App Server instance in the Virtual instance for SAP solutions by using the Azure resource ID of the App server instance + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of SAP Application Server instance resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapVirtualInstanceName +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapApplicationServerInstance + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapCentralInstance.md b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapCentralInstance.md new file mode 100644 index 0000000000..2bb7b6fb77 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapCentralInstance.md @@ -0,0 +1,194 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/get-azworkloadssapcentralinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsSapCentralInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsSapCentralInstance.md +--- + +# Get-AzWorkloadsSapCentralInstance + +## SYNOPSIS +Gets the SAP Central Services Instance resource. + +## SYNTAX + +### List (Default) +``` +Get-AzWorkloadsSapCentralInstance -ResourceGroupName <String> -SapVirtualInstanceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWorkloadsSapCentralInstance -Name <String> -ResourceGroupName <String> -SapVirtualInstanceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWorkloadsSapCentralInstance -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the SAP Central Services Instance resource. + +## EXAMPLES + +### Example 1: Get an overview of The Central service Instance(s) +```powershell + Get-AzWorkloadsSapCentralInstance -ResourceGroupName DemoRGVIS -SapVirtualInstanceName DRT +``` + +```output +Name ResourceGroupName Health EnqueueServerPropertyHostname ProvisioningState Status Location +---- ----------------- ------ ----------------------------- ----------------- ------ -------- +cs0 DemoRGVIS Healthy drtvm Succeeded Running eastus2euap +``` + +This command will help you get an overview, including health and status of the Central service instance in a Virtual instance for SAP solutions + +### Example 2: Get an overview of The Central service Instance(s) +```powershell +Get-AzWorkloadsSapCentralInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/DemoRGVIS/providers/Microsoft.Workloads/sapVirtualInstances/DRT/centralInstances/cs0 +``` + +```output +Name ResourceGroupName Health EnqueueServerPropertyHostname ProvisioningState Status Location +---- ----------------- ------ ----------------------------- ----------------- ------ -------- +cs0 DemoRGVIS Healthy drtvm Succeeded Running eastus2euap +``` + +This command will help you get an overview, including health and status of a Central service instance in the Virtual instance for SAP solutions by using the Azure resource ID of the Central service instance + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapVirtualInstanceName +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapCentralServerInstance + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapDatabaseInstance.md b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapDatabaseInstance.md new file mode 100644 index 0000000000..031344aee8 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapDatabaseInstance.md @@ -0,0 +1,194 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/get-azworkloadssapdatabaseinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsSapDatabaseInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsSapDatabaseInstance.md +--- + +# Get-AzWorkloadsSapDatabaseInstance + +## SYNOPSIS +Gets the SAP Database Instance resource. + +## SYNTAX + +### List (Default) +``` +Get-AzWorkloadsSapDatabaseInstance -ResourceGroupName <String> -SapVirtualInstanceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### Get +``` +Get-AzWorkloadsSapDatabaseInstance -Name <String> -ResourceGroupName <String> -SapVirtualInstanceName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWorkloadsSapDatabaseInstance -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets the SAP Database Instance resource. + +## EXAMPLES + +### Example 1: Get an overview of the Database Instance(s) +```powershell +Get-AzWorkloadsSapDatabaseInstance -ResourceGroupName DemoRGVIS -SapVirtualInstanceName DRT +``` + +```output +Name ResourceGroupName ProvisioningState Location Status IPAddress DatabaseSid +---- ----------------- ----------------- -------- ------ --------- ----------- +db0 DemoRGVIS Succeeded eastus2euap Running 10.0.0.6 XRT +``` + +This command will help you get an overview, including health and status of a Database instance in the Virtual instance for SAP solutions + +### Example 2: Get an overview of the Database Instance(s) +```powershell +Get-AzWorkloadsSapDatabaseInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/DemoRGVIS/providers/Microsoft.Workloads/sapVirtualInstances/DRT/databaseInstances/db0 +``` + +```output +Name ResourceGroupName ProvisioningState Location Status IPAddress DatabaseSid +---- ----------------- ----------------- -------- ------ --------- ----------- +db0 DemoRGVIS Succeeded eastus2euap Running 10.0.0.6 XRT +``` + +This command will help you get an overview, including health and status of a Database instance in the Virtual instance for SAP solutions by using the Azure resource ID of the Database instance + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database resource name string modeled as parameter for auto generation to work correctly. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapVirtualInstanceName +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapDatabaseInstance + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapLandscapeMonitor.md b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapLandscapeMonitor.md new file mode 100644 index 0000000000..a9873ae62e --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapLandscapeMonitor.md @@ -0,0 +1,217 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/get-azworkloadssaplandscapemonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsSapLandscapeMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsSapLandscapeMonitor.md +--- + +# Get-AzWorkloadsSapLandscapeMonitor + +## SYNOPSIS +Gets configuration values for Single Pane Of Glass for SAP monitor for the specified subscription, resource group, and resource name. + +## SYNTAX + +### Get (Default) +``` +Get-AzWorkloadsSapLandscapeMonitor -MonitorName <String> -ResourceGroupName <String> + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWorkloadsSapLandscapeMonitor -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +## DESCRIPTION +Gets configuration values for Single Pane Of Glass for SAP monitor for the specified subscription, resource group, and resource name. + +## EXAMPLES + +### Example 1: Get information about a SAP landscape monitor +```powershell +Get-AzWorkloadsSapLandscapeMonitor -MonitorName suha-0202-ams9 -ResourceGroupName suha-0802-rg1 -SubscriptionId 49d64d54-e966-4c46-a868-1999802b762c +``` + +```output +GroupingLandscape : {{ + "name": "Prod", + "topSid": [ "SID1", "SID2" ] + }} +GroupingSapApplication : {{ + "name": "ERP1", + "topSid": [ "SID1", "SID2" ] + }} +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/suha-0802-rg1/providers/Microsoft. + Workloads/monitors/suha-0202-ams9/sapLandscapeMonitor/default +Name : default +ProvisioningState : Succeeded +ResourceGroupName : suha-0802-rg1 +SystemData : { + } +SystemDataCreatedAt : 06-04-2023 05:30:54 +SystemDataCreatedByType : User +SystemDataLastModifiedByType : User +TopMetricsThreshold : {{ + "name": "Instance Availability", + "green": 90, + "yellow": 75, + "red": 50 + }} +Type : microsoft.workloads/monitors/saplandscapemonitor +``` + +Gets information about a specific SAP landscape monitor + +### Example 2: Get information about a SAP landscape monitor by Id +```powershell +Get-AzWorkloadsSapLandscapeMonitor -InputObject "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/suha-0/providers/Microsoft.Workloads/monitors/suha-0202-ams9/sapLandscapeMonitor/default" +``` + +```output +GroupingLandscape : {{ + "name": "Prod", + "topSid": [ "SID1", "SID2" ] + }} +GroupingSapApplication : {{ + "name": "ERP1", + "topSid": [ "SID1", "SID2" ] + }} +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/suha-0802-rg1/providers/Microsoft. + Workloads/monitors/suha-0202-ams9/sapLandscapeMonitor/default +Name : default +ProvisioningState : Succeeded +ResourceGroupName : suha-0802-rg1 +SystemData : { + } +SystemDataCreatedAt : 06-04-2023 05:30:54 +SystemDataCreatedByType : User +SystemDataLastModifiedByType : User +TopMetricsThreshold : {{ + "name": "Instance Availability", + "green": 90, + "yellow": 75, + "red": 50 + }} +Type : microsoft.workloads/monitors/saplandscapemonitor +``` + +Gets information about a specific SAP landscape monitor by ArmId + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapLandscapeMonitor + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapVirtualInstance.md b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapVirtualInstance.md new file mode 100644 index 0000000000..540ebbf44e --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Get-AzWorkloadsSapVirtualInstance.md @@ -0,0 +1,200 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/get-azworkloadssapvirtualinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsSapVirtualInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Get-AzWorkloadsSapVirtualInstance.md +--- + +# Get-AzWorkloadsSapVirtualInstance + +## SYNOPSIS +Gets a Virtual Instance for SAP solutions resource + +## SYNTAX + +### List1 (Default) +``` +Get-AzWorkloadsSapVirtualInstance [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### Get +``` +Get-AzWorkloadsSapVirtualInstance -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +### GetViaIdentity +``` +Get-AzWorkloadsSapVirtualInstance -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] + [<CommonParameters>] +``` + +### List +``` +Get-AzWorkloadsSapVirtualInstance -ResourceGroupName <String> [-SubscriptionId <String[]>] + [-DefaultProfile <PSObject>] [<CommonParameters>] +``` + +## DESCRIPTION +Gets a Virtual Instance for SAP solutions resource + +## EXAMPLES + +### Example 1: Get a list of the Virtual Instance(s) for SAP solutions (VIS) +```powershell +Get-AzWorkloadsSapVirtualInstance +``` + +```output +Name ResourceGroupName Health Environment ProvisioningState SapProduct State Status Location +---- ----------------- ------ ----------- ----------------- ---------- ----- ------ -------- +DRT DemoRGVIS Healthy NonProd Succeeded S4HANA RegistrationComplete Running eastus2euap +DRT DemoRGVIS01 Healthy NonProd Succeeded S4HANA RegistrationComplete Running eastus2euap +DRT DemoRGVIS02 Healthy NonProd Succeeded S4HANA RegistrationComplete Running eastus2euap +``` + +This command will list all the Virtual instances for SAP solutions from your subscriptions along with their health, status, state and other parameters of the VIS + +### Example 2: Get an overview of any one Virtual Instance(s) for SAP solutions (VIS) +```powershell +Get-AzWorkloadsSapVirtualInstance -ResourceGroupName DemoRGVIS -Name DRT +``` + +```output +Name ResourceGroupName Health Environment ProvisioningState SapProduct State Status Location +---- ----------------- ------ ----------- ----------------- ---------- ----- ------ -------- +DRT DemoRGVIS Healthy NonProd Succeeded S4HANA RegistrationComplete Running eastus2euap +``` + +This command will list a specific Virtual instance for SAP solutions resource along with it's health, status, state and other parameters of the VIS + +### Example 3: Get an overview of the Virtual Instance(s) for SAP solutions (VIS) with resource ID +```powershell +Get-AzWorkloadsSapVirtualInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/DemoRGVIS/providers/Microsoft.Workloads/sapVirtualInstances/DRT +``` + +```output +Name ResourceGroupName Health Environment ProvisioningState SapProduct State Status Location +---- ----------------- ------ ----------- ----------------- ---------- ----- ------ -------- +DRT DemoRGVIS Healthy NonProd Succeeded S4HANA RegistrationComplete Running eastus2euap +``` + +This command will list a specific Virtual instance for SAP solutions resource along with it's health, status, state and other parameters of the VIS by using the Azure resource ID of the VIS + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SapVirtualInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapVirtualInstance + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Invoke-AzWorkloadsSapDiskConfiguration.md b/azps-10.1.0/Az.Workloads/Invoke-AzWorkloadsSapDiskConfiguration.md new file mode 100644 index 0000000000..99c7d83dd5 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Invoke-AzWorkloadsSapDiskConfiguration.md @@ -0,0 +1,292 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/invoke-azworkloadssapdiskconfiguration +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Invoke-AzWorkloadsSapDiskConfiguration.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Invoke-AzWorkloadsSapDiskConfiguration.md +--- + +# Invoke-AzWorkloadsSapDiskConfiguration + +## SYNOPSIS +Get the SAP Disk Configuration Layout prod/non-prod SAP System. + +## SYNTAX + +### SapExpanded (Default) +``` +Invoke-AzWorkloadsSapDiskConfiguration -Location <String> -AppLocation <String> + -DatabaseType <SapDatabaseType> -DbVMSku <String> -DeploymentType <SapDeploymentType> + -Environment <SapEnvironmentType> -SapProduct <SapProductType> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### SapViaIdentityExpanded +``` +Invoke-AzWorkloadsSapDiskConfiguration -InputObject <IWorkloadsIdentity> -AppLocation <String> + -DatabaseType <SapDatabaseType> -DbVMSku <String> -DeploymentType <SapDeploymentType> + -Environment <SapEnvironmentType> -SapProduct <SapProductType> [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Get the SAP Disk Configuration Layout prod/non-prod SAP System. + +## EXAMPLES + +### Example 1: Get the SAP Disk Configuration Layout for prod/non-prod SAP System +```powershell +Invoke-AzWorkloadsSapDiskConfiguration -Location eastus -AppLocation eastus -DatabaseType HANA -DbVMSku Standard_M32ts -DeploymentType SingleServer -Environment NonProd -SapProduct S4HANA +``` + +```output +Keys : {hana/data, hana/log, hana/shared, usr/sap...} +Values : {{ + "recommendedConfiguration": { + "sku": { + "name": "Premium_LRS" + }, + "count": 4, + "sizeGB": 128 + }, + "supportedConfigurations": [ + { + "sku": { + "name": "Premium_LRS" + }, + "sizeGB": 128, + "minimumSupportedDiskCount": 4, + "maximumSupportedDiskCount": 5, + "iopsReadWrite": 500, + "mbpsReadWrite": 100, + "diskTier": "P10" + } + ] + }} +``` + +This command will help you understand the default disk configuration that will b deployed for the SAP system for a selected deployment type. +You can customize this when you are deploying your SAP system from Azure Center for SAP solutions + +## PARAMETERS + +### -AppLocation +The geo-location where the SAP resources will be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseType +The database type. +Eg: HANA, DB2, etc + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapDatabaseType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbVMSku +The VM SKU for database instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentType +The deployment type. +Eg: SingleServer/ThreeTier + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapDeploymentType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Environment +Defines the environment type - Production/Non Production. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapEnvironmentType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: SapViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The name of Azure region. + +```yaml +Type: System.String +Parameter Sets: SapExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapProduct +Defines the SAP Product type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapProductType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SapExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapDiskConfigurationsResultVolumeConfigurations + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Invoke-AzWorkloadsSapSizingRecommendation.md b/azps-10.1.0/Az.Workloads/Invoke-AzWorkloadsSapSizingRecommendation.md new file mode 100644 index 0000000000..acb6f5dd53 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Invoke-AzWorkloadsSapSizingRecommendation.md @@ -0,0 +1,317 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/invoke-azworkloadssapsizingrecommendation +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Invoke-AzWorkloadsSapSizingRecommendation.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Invoke-AzWorkloadsSapSizingRecommendation.md +--- + +# Invoke-AzWorkloadsSapSizingRecommendation + +## SYNOPSIS +Get SAP sizing recommendations by providing input SAPS for application tier and memory required for database tier + +## SYNTAX + +### SapExpanded (Default) +``` +Invoke-AzWorkloadsSapSizingRecommendation -Location <String> -AppLocation <String> + -DatabaseType <SapDatabaseType> -DbMemory <Int64> -DeploymentType <SapDeploymentType> + -Environment <SapEnvironmentType> -Sap <Int64> -SapProduct <SapProductType> [-SubscriptionId <String>] + [-DbScaleMethod <SapDatabaseScaleMethod>] [-HighAvailabilityType <SapHighAvailabilityType>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### SapViaIdentityExpanded +``` +Invoke-AzWorkloadsSapSizingRecommendation -InputObject <IWorkloadsIdentity> -AppLocation <String> + -DatabaseType <SapDatabaseType> -DbMemory <Int64> -DeploymentType <SapDeploymentType> + -Environment <SapEnvironmentType> -Sap <Int64> -SapProduct <SapProductType> + [-DbScaleMethod <SapDatabaseScaleMethod>] [-HighAvailabilityType <SapHighAvailabilityType>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Get SAP sizing recommendations by providing input SAPS for application tier and memory required for database tier + +## EXAMPLES + +### Example 1: Get SAP sizing recommendations by providing SAPS for application tier and memory required for database tier +```powershell +Invoke-AzWorkloadsSapSizingRecommendation -Location eastus -AppLocation eastus -DatabaseType HANA -DbMemory 256 -DeploymentType SingleServer -Environment NonProd -SapProduct S4HANA -Sap 10000 -DbScaleMethod ScaleUp +``` + +```output +DeploymentType VMSku +-------------- ----- +SingleServer Standard_E32ds_v4 +``` + +The command will take input of the Deployment type, region, SAPS number and Database memory size requirement for the SAP system and help you understand the right size and count of Azure SKUs that you should use for the App server instance, Central service instance and Database instance while deploying your SAP system with Azure Center for SAP solutions. + +## PARAMETERS + +### -AppLocation +The geo-location where the resource is to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseType +The database type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapDatabaseType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbMemory +The database memory configuration. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbScaleMethod +The DB scale method. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapDatabaseScaleMethod +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentType +The deployment type. +Eg: SingleServer/ThreeTier + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapDeploymentType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Environment +Defines the environment type - Production/Non Production. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapEnvironmentType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityType +The high availability type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapHighAvailabilityType +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.Workloads.Models.IWorkloadsIdentity +Parameter Sets: SapViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The name of Azure region. + +```yaml +Type: System.String +Parameter Sets: SapExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sap +The SAP Application Performance Standard measurement. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapProduct +Defines the SAP Product type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapProductType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SapExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapDeploymentType + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Invoke-AzWorkloadsSapSupportedSku.md b/azps-10.1.0/Az.Workloads/Invoke-AzWorkloadsSapSupportedSku.md new file mode 100644 index 0000000000..997d5c59a2 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Invoke-AzWorkloadsSapSupportedSku.md @@ -0,0 +1,276 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/invoke-azworkloadssapsupportedsku +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Invoke-AzWorkloadsSapSupportedSku.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Invoke-AzWorkloadsSapSupportedSku.md +--- + +# Invoke-AzWorkloadsSapSupportedSku + +## SYNOPSIS +Get a list of SAP supported SKUs for ASCS, Application and Database tier. + +## SYNTAX + +### SapExpanded (Default) +``` +Invoke-AzWorkloadsSapSupportedSku -Location <String> -AppLocation <String> -DatabaseType <SapDatabaseType> + -DeploymentType <SapDeploymentType> -Environment <SapEnvironmentType> -SapProduct <SapProductType> + [-SubscriptionId <String>] [-HighAvailabilityType <SapHighAvailabilityType>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### SapViaIdentityExpanded +``` +Invoke-AzWorkloadsSapSupportedSku -InputObject <IWorkloadsIdentity> -AppLocation <String> + -DatabaseType <SapDatabaseType> -DeploymentType <SapDeploymentType> -Environment <SapEnvironmentType> + -SapProduct <SapProductType> [-HighAvailabilityType <SapHighAvailabilityType>] [-DefaultProfile <PSObject>] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Get a list of SAP supported SKUs for ASCS, Application and Database tier. + +## EXAMPLES + +### Example 1: Get SAP sizing recommendations by providing input SAPS for application tier and memory required for database tier +```powershell +Invoke-AzWorkloadsSapSupportedSku -Location eastus -AppLocation eastus -DatabaseType HANA -DeploymentType ThreeTier -Environment Prod -SapProduct S4HANA +``` + +```output +IsAppServerCertified IsDatabaseCertified VMSku +-------------------- ------------------- ----- +True False Standard_D16ds_v4 +True False Standard_D16ds_v5 +True False Standard_D32ds_v4 +True False Standard_D32ds_v5 +True False Standard_D48ds_v4 +True False Standard_D48ds_v5 +``` + +This command helps you understand the list of SAP certified Azure SKUs supported for the SAP deployment type you want to deploy and for the region in which you want to deploy the SAP system with Azure Center for SAP solutions + +## PARAMETERS + +### -AppLocation +The geo-location where the resource is to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseType +The database type. +Eg: HANA, DB2, etc + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapDatabaseType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentType +The deployment type. +Eg: SingleServer/ThreeTier + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapDeploymentType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Environment +Defines the environment type - Production/Non Production. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapEnvironmentType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityType +The high availability type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapHighAvailabilityType +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.Workloads.Models.IWorkloadsIdentity +Parameter Sets: SapViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The name of Azure region. + +```yaml +Type: System.String +Parameter Sets: SapExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapProduct +Defines the SAP Product type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapProductType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: SapExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapSupportedSku + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/New-AzWorkloadsMonitor.md b/azps-10.1.0/Az.Workloads/New-AzWorkloadsMonitor.md new file mode 100644 index 0000000000..7c61e72827 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/New-AzWorkloadsMonitor.md @@ -0,0 +1,336 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/new-azworkloadsmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsMonitor.md +--- + +# New-AzWorkloadsMonitor + +## SYNOPSIS +Creates a SAP monitor for the specified subscription, resource group, and resource name. + +## SYNTAX + +``` +New-AzWorkloadsMonitor -Name <String> -ResourceGroupName <String> -Location <String> + [-SubscriptionId <String>] [-AppLocation <String>] [-IdentityType <ManagedServiceIdentityType>] + [-LogAnalyticsWorkspaceArmId <String>] [-ManagedResourceGroupName <String>] [-MonitorSubnet <String>] + [-RoutingPreference <RoutingPreference>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] + [-ZoneRedundancyPreference <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a SAP monitor for the specified subscription, resource group, and resource name. + +## EXAMPLES + +### Example 1: Creates a SAP monitor for the specified subscription, resource group, and resource name +```powershell +New-AzWorkloadsMonitor -Name suha-160323-ams4 -ResourceGroupName suha-0802-rg1 -SubscriptionId 49d64d54-e966-4c46-a868-1999802b762c -Location eastus2euap -AppLocation eastus -ManagedResourceGroupName mrg-1603234 -MonitorSubnet /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/e2e-portal-wlmonitor-do-not-delete/providers/Microsoft.Network/virtualNetworks/vnetpeeringtest/subnets/snet-1603-3 -RoutingPreference RouteAll -ZoneRedundancyPreference Disabled +``` + +```output +Name ResourceGroupName ManagedResourceGroupConfigurationName Location ProvisioningState +---- ----------------- ------------------------------------- -------- ----------------- +suha-160323-ams4 suha-0802-rg1 mrg-1603234 eastus2euap Succeeded +``` + +This command creates a SAP monitor for the specified subscription, resource group, and resource name. + +## PARAMETERS + +### -AppLocation +The SAP monitor resources will be deployed in the SAP monitoring region. +The subnet region should be same as the SAP monitoring region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of manage identity + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogAnalyticsWorkspaceArmId +The ARM ID of the Log Analytics Workspace that is used for SAP monitoring. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedResourceGroupName +Managed resource group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorSubnet +The subnet which the SAP monitor will be deployed in + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingPreference +Sets the routing preference of the SAP monitor. +By default only RFC1918 traffic is routed to the customer VNET. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.RoutingPreference +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +User assigned identities dictionary + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZoneRedundancyPreference +Sets the preference for zone redundancy on resources created for the SAP monitor. +By default resources will be created which do not support zone redundancy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.IMonitor + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderDB2InstanceObject.md b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderDB2InstanceObject.md new file mode 100644 index 0000000000..cf103a812e --- /dev/null +++ b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderDB2InstanceObject.md @@ -0,0 +1,192 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/new-azworkloadsproviderdb2instanceobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderDB2InstanceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderDB2InstanceObject.md +--- + +# New-AzWorkloadsProviderDB2InstanceObject + +## SYNOPSIS +Create an in-memory object for DB2ProviderInstanceProperties. + +## SYNTAX + +``` +New-AzWorkloadsProviderDB2InstanceObject [-Hostname <String>] [-Name <String>] [-Password <String>] + [-PasswordUri <String>] [-Port <String>] [-SapSid <String>] [-SslCertificateUri <String>] + [-SslPreference <SslPreference>] [-Username <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for DB2ProviderInstanceProperties. + +## EXAMPLES + +### Example 1: Create an IBM Db2 Provider +```powershell +New-AzWorkloadsProviderDB2InstanceObject -Name Sample -Password '' -Port 25000 -Username db2admin -Hostname 10.1.21.4 -SapSid OPA -SslPreference Disabled +``` + +```output +ProviderType DbName DbPassword DbPasswordUri DbPort DbUsername Hostname SapSid SslCertificateUri SslPreference +------------ ------ ---------- ------------- ------ ---------- -------- ------ ----------------- ------------- +Db2 Sample 25000 db2admin 10.1.21.4 OPA Disabled +``` + +Create an IBM Db2 provider for an AMS Instance + +## PARAMETERS + +### -Hostname +Gets or sets the target virtual machine name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets the db2 database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Gets or sets the db2 database password. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordUri +Gets or sets the key vault URI to secret with the database password. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Gets or sets the db2 database sql port. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapSid +Gets or sets the SAP System Identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificateUri +Gets or sets the blob URI to SSL certificate for the DB2 Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslPreference +Gets or sets certificate preference if secure communication is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SslPreference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Username +Gets or sets the db2 database user name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.Db2ProviderInstanceProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderHanaDbInstanceObject.md b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderHanaDbInstanceObject.md new file mode 100644 index 0000000000..668a781cc1 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderHanaDbInstanceObject.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/new-azworkloadsproviderhanadbinstanceobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderHanaDbInstanceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderHanaDbInstanceObject.md +--- + +# New-AzWorkloadsProviderHanaDbInstanceObject + +## SYNOPSIS +Create an in-memory object for HanaDbProviderInstanceProperties. + +## SYNTAX + +``` +New-AzWorkloadsProviderHanaDbInstanceObject [-Hostname <String>] [-InstanceNumber <String>] [-Name <String>] + [-Password <String>] [-PasswordUri <String>] [-SapSid <String>] [-SqlPort <String>] + [-SslCertificateUri <String>] [-SslHostNameInCertificate <String>] [-SslPreference <SslPreference>] + [-Username <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for HanaDbProviderInstanceProperties. + +## EXAMPLES + +### Example 1: Create SAP HANA provider +```powershell +New-AzWorkloadsProviderHanaDbInstanceObject -Name SYSTEMDB -Password '' -Username SYSTEM -Hostname 10.0.81.4 -InstanceNumber 00 -SapSid X00 -SqlPort 1433 -SslPreference Disabled +``` + +```output +ProviderType DbName DbPassword DbPasswordUri DbUsername Hostname InstanceNumber SapSid SqlPort SslCertificateUri SslHostNameInCer + tificate +------------ ------ ---------- ------------- ---------- -------- -------------- ------ ------- ----------------- ---------------- +SapHana SYSTEMDB SYSTEM 10.0.81.4 00 X00 1433 +``` + +Create SAP HANA provider for an AMS instance + +## PARAMETERS + +### -Hostname +Gets or sets the target virtual machine size. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstanceNumber +Gets or sets the database instance number. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets the hana database name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Gets or sets the database password. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordUri +Gets or sets the key vault URI to secret with the database password. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapSid +Gets or sets the SAP System Identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlPort +Gets or sets the database sql port. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificateUri +Gets or sets the blob URI to SSL certificate for the DB. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslHostNameInCertificate +Gets or sets the hostname(s) in the SSL certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslPreference +Gets or sets certificate preference if secure communication is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SslPreference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Username +Gets or sets the database user name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.HanaDbProviderInstanceProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderInstance.md b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderInstance.md new file mode 100644 index 0000000000..0d4fc6b008 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderInstance.md @@ -0,0 +1,266 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/new-azworkloadsproviderinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderInstance.md +--- + +# New-AzWorkloadsProviderInstance + +## SYNOPSIS +Creates a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. + +## SYNTAX + +``` +New-AzWorkloadsProviderInstance -MonitorName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-IdentityType <ManagedServiceIdentityType>] + [-IdentityUserAssignedIdentity <Hashtable>] [-ProviderSetting <IProviderSpecificProperties>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. + +## EXAMPLES + +### Example 1: Create a new provider +```powershell +$providerSetting = New-AzWorkloadsProviderSqlServerInstanceObject -Password '<password>' -Port 1433 -Username '<username>' -Hostname 10.1.14.5 -SapSid X00 -SslPreference Disabled + $providerSetting.ProviderType | Should -Be "MsSqlServer" + +New-AzWorkloadsProviderInstance -MonitorName suha-0202-ams9 -Name sql-prov-1 -ResourceGroupName suha-0802-rg1 -SubscriptionId 49d64d54-e966-4c46-a868-1999802b762c -ProviderSetting $providerSetting +``` + +```output +Name ResourceGroupName ProvisioningState IdentityType +---- ----------------- ----------------- ------------ +sql-prov-1 suha-0802-rg1 Succeeded +``` + +Creates a new provider for a specific AMS instance + +### Example 2: Create a new provider by Id +```powershell +New-AzWorkloadsProviderInstance -MonitorName suha-160323-ams4 -Name suha-sql-3 -ResourceGroupName suha-0802-rg1 -SubscriptionId 49d64d54-e966-4c46-a868-1999802b762c -ProviderSetting '{"sslPreference":"Disabled","providerType":"MsSqlServer","hostname":"10.1.14.5","sapSid":"X00","dbPort":"1433","dbUsername":"","dbPassword":""}' +``` + +```output +Name ResourceGroupName ProvisioningState IdentityType +---- ----------------- ----------------- ------------ +suha-sql-3 suha-0802-rg1 Succeeded +``` + +Creates a new provider for a specific AMS instance by Arm Id + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of manage identity + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +User assigned identities dictionary + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the provider instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ProviderInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderSetting +Defines the provider specific properties. +To construct, see NOTES section for PROVIDERSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.IProviderSpecificProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.IProviderInstance + +## 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. + + +`PROVIDERSETTING <IProviderSpecificProperties>`: Defines the provider specific properties. + - `ProviderType <String>`: The provider type. For example, the value can be SapHana. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderPrometheusHaClusterInstanceObject.md b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderPrometheusHaClusterInstanceObject.md new file mode 100644 index 0000000000..c11a9c02f2 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderPrometheusHaClusterInstanceObject.md @@ -0,0 +1,147 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/new-azworkloadsproviderprometheushaclusterinstanceobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderPrometheusHaClusterInstanceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderPrometheusHaClusterInstanceObject.md +--- + +# New-AzWorkloadsProviderPrometheusHaClusterInstanceObject + +## SYNOPSIS +Create an in-memory object for PrometheusHaClusterProviderInstanceProperties. + +## SYNTAX + +``` +New-AzWorkloadsProviderPrometheusHaClusterInstanceObject [-ClusterName <String>] [-Hostname <String>] + [-PrometheusUrl <String>] [-Sid <String>] [-SslCertificateUri <String>] [-SslPreference <SslPreference>] + [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for PrometheusHaClusterProviderInstanceProperties. + +## EXAMPLES + +### Example 1: Create High Availability Pacemaker cluster provider +```powershell +New-AzWorkloadsProviderPrometheusHaClusterInstanceObject -ClusterName hacluster -Hostname h20dbvm0 -PrometheusUrl "http://10.0.92.5:964/metrics" -Sid X00 -SslPreference Disabled +``` + +```output +ProviderType ClusterName Hostname PrometheusUrl Sid SslCertificateUri SslPreference +------------ ----------- -------- ------------- --- ----------------- ------------- +PrometheusHaCluster hacluster h20dbvm0 http://10.0.92.5:964/metrics X00 Disabled +``` + +Create High Availability Pacemaker cluster for an AMS instance + +## PARAMETERS + +### -ClusterName +Gets or sets the clusterName. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Hostname +Gets or sets the target machine name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrometheusUrl +URL of the Node Exporter endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sid +Gets or sets the cluster sid. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificateUri +Gets or sets the blob URI to SSL certificate for the HA cluster exporter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslPreference +Gets or sets certificate preference if secure communication is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SslPreference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.PrometheusHaClusterProviderInstanceProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderPrometheusOSInstanceObject.md b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderPrometheusOSInstanceObject.md new file mode 100644 index 0000000000..aa503f882b --- /dev/null +++ b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderPrometheusOSInstanceObject.md @@ -0,0 +1,116 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/new-azworkloadsproviderprometheusosinstanceobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderPrometheusOSInstanceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderPrometheusOSInstanceObject.md +--- + +# New-AzWorkloadsProviderPrometheusOSInstanceObject + +## SYNOPSIS +Create an in-memory object for PrometheusOSProviderInstanceProperties. + +## SYNTAX + +``` +New-AzWorkloadsProviderPrometheusOSInstanceObject [-PrometheusUrl <String>] [-SapSid <String>] + [-SslCertificateUri <String>] [-SslPreference <SslPreference>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for PrometheusOSProviderInstanceProperties. + +## EXAMPLES + +### Example 1: Create Linux OS Provider +```powershell +New-AzWorkloadsProviderPrometheusOSInstanceObject -PrometheusUrl "http://10.1.0.4:9100/metrics" -SapSid X00 -SslPreference Disabled +``` + +```output +ProviderType PrometheusUrl SapSid SslCertificateUri SslPreference +------------ ------------- ------ ----------------- ------------- +PrometheusOS http://10.1.0.4:9100/metrics X00 Disabled +``` + +Create Linux Operating System provider for an AMS instance + +## PARAMETERS + +### -PrometheusUrl +URL of the Node Exporter endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapSid +Gets or sets the SAP System Identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificateUri +Gets or sets the blob URI to SSL certificate for the prometheus node exporter. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslPreference +Gets or sets certificate preference if secure communication is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SslPreference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.PrometheusOSProviderInstanceProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderSapNetWeaverInstanceObject.md b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderSapNetWeaverInstanceObject.md new file mode 100644 index 0000000000..eec37e1cd2 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderSapNetWeaverInstanceObject.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/new-azworkloadsprovidersapnetweaverinstanceobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderSapNetWeaverInstanceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderSapNetWeaverInstanceObject.md +--- + +# New-AzWorkloadsProviderSapNetWeaverInstanceObject + +## SYNOPSIS +Create an in-memory object for SapNetWeaverProviderInstanceProperties. + +## SYNTAX + +``` +New-AzWorkloadsProviderSapNetWeaverInstanceObject [-SapClientId <String>] [-SapHostFileEntry <String[]>] + [-SapHostname <String>] [-SapInstanceNr <String>] [-SapPassword <String>] [-SapPasswordUri <String>] + [-SapPortNumber <String>] [-SapSid <String>] [-SapUsername <String>] [-SslCertificateUri <String>] + [-SslPreference <SslPreference>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SapNetWeaverProviderInstanceProperties. + +## EXAMPLES + +### Example 1: Create SAP Netweaver Provider +```powershell +New-AzWorkloadsProviderSapNetWeaverInstanceObject -SapClientId 000 -SapHostFileEntry '["10.0.82.4 l13appvm0.ams.azure.com l13appvm0","10.0.82.5 l13ascsvm.ams.azure.com l13ascsvm"]' -SapHostname 10.0.82.4 -SapInstanceNr 00 -SapPassword Password@1234 -SapSid L13 -SapUsername AMSUSER -SslPreference Disabled +``` + +```output +ProviderType SapClientId SapHostFileEntry SapHostname +------------ ----------- ---------------- ----------- +SapNetWeaver 000 {["10.0.82.4 l13appvm0.ams.azure.com l13appvm0","10.0.82.5 l13ascsvm.ams.azure.com l13ascsvm"]} 10.0.82.4 +``` + +Create SAP Netweaver Provider for an AMS instance + +## PARAMETERS + +### -SapClientId +Gets or sets the SAP Client ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapHostFileEntry +Gets or sets the list of HostFile Entries. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapHostname +Gets or sets the target virtual machine IP Address/FQDN. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapInstanceNr +Gets or sets the instance number of SAP NetWeaver. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapPassword +Sets the SAP password. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapPasswordUri +Gets or sets the key vault URI to secret with the SAP password. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapPortNumber +Gets or sets the SAP HTTP port number. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapSid +Gets or sets the SAP System Identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapUsername +Gets or sets the SAP user name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificateUri +Gets or sets the blob URI to SSL certificate for the SAP system. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslPreference +Gets or sets certificate preference if secure communication is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SslPreference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.SapNetWeaverProviderInstanceProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderSqlServerInstanceObject.md b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderSqlServerInstanceObject.md new file mode 100644 index 0000000000..049f344cd1 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/New-AzWorkloadsProviderSqlServerInstanceObject.md @@ -0,0 +1,177 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/new-azworkloadsprovidersqlserverinstanceobject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderSqlServerInstanceObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsProviderSqlServerInstanceObject.md +--- + +# New-AzWorkloadsProviderSqlServerInstanceObject + +## SYNOPSIS +Create an in-memory object for MsSqlServerProviderInstanceProperties. + +## SYNTAX + +``` +New-AzWorkloadsProviderSqlServerInstanceObject [-Hostname <String>] [-Password <String>] + [-PasswordUri <String>] [-Port <String>] [-SapSid <String>] [-SslCertificateUri <String>] + [-SslPreference <SslPreference>] [-Username <String>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for MsSqlServerProviderInstanceProperties. + +## EXAMPLES + +### Example 1: Create Microsoft SQL server provider +```powershell +New-AzWorkloadsProviderSqlServerInstanceObject -Password 'Password@123' -Port 1433 -Username ams -Hostname 10.1.14.5 -SapSid X00 -SslPreference Disabled +``` + +```output +ProviderType DbPassword DbPasswordUri DbPort DbUsername Hostname SapSid SslCertificateUri SslPreference +------------ ---------- ------------- ------ ---------- -------- ------ ----------------- ------------- +MsSqlServer Password@123 1433 ams 10.1.14.5 X00 Disabled +``` + +Create Microsoft SQL server provider for an AMS instance + +## PARAMETERS + +### -Hostname +Gets or sets the SQL server host name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Gets or sets the database password. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordUri +Gets or sets the key vault URI to secret with the database password. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +Gets or sets the database sql port. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapSid +Gets or sets the SAP System Identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslCertificateUri +Gets or sets the blob URI to SSL certificate for the SQL Database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslPreference +Gets or sets certificate preference if secure communication is enabled. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SslPreference +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Username +Gets or sets the database user name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.MSSqlServerProviderInstanceProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/New-AzWorkloadsSapLandscapeMonitor.md b/azps-10.1.0/Az.Workloads/New-AzWorkloadsSapLandscapeMonitor.md new file mode 100644 index 0000000000..73977a5e3f --- /dev/null +++ b/azps-10.1.0/Az.Workloads/New-AzWorkloadsSapLandscapeMonitor.md @@ -0,0 +1,250 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/new-azworkloadssaplandscapemonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsSapLandscapeMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsSapLandscapeMonitor.md +--- + +# New-AzWorkloadsSapLandscapeMonitor + +## SYNOPSIS +Creates a SAP Landscape Monitor Dashboard for the specified subscription, resource group, and resource name. + +## SYNTAX + +``` +New-AzWorkloadsSapLandscapeMonitor -MonitorName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-GroupingLandscape <ISapLandscapeMonitorSidMapping[]>] + [-GroupingSapApplication <ISapLandscapeMonitorSidMapping[]>] + [-TopMetricsThreshold <ISapLandscapeMonitorMetricThresholds[]>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Creates a SAP Landscape Monitor Dashboard for the specified subscription, resource group, and resource name. + +## EXAMPLES + +### Example 1: Create a new SAP Landscape Monitor +```powershell +New-AzWorkloadsSapLandscapeMonitor -MonitorName suha-0202-ams9 -ResourceGroupName suha-0802-rg1 -SubscriptionId 49d64d54-e966-4c46-a868-1999802b762c -GroupingLandscape '{"name":"Prod","topSid":["SID1","SID2"]}' -GroupingSapApplication '{"name":"ERP1","topSid":["SID1","SID2"]}' -TopMetricsThreshold '{"name":"Instance Availability","green":90,"yellow":75,"red":50}' +``` + +```output +GroupingLandscape : {{ + "name": "Prod", + "topSid": [ "SID1", "SID2" ] + }} +GroupingSapApplication : {{ + "name": "ERP1", + "topSid": [ "SID1", "SID2" ] + }} +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/suha-0802-rg1/providers/Microsoft. + Workloads/monitors/suha-0202-ams9/sapLandscapeMonitor/default +Name : default +ProvisioningState : Succeeded +ResourceGroupName : suha-0802-rg1 +SystemData : { + "createdBy": "", + "createdByType": "User", + "createdAt": "2023-04-06T05:30:54.9427030Z", + "lastModifiedBy": "", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-04-06T05:31:18.7873209Z" + } +SystemDataCreatedAt : 06-04-2023 05:30:54 +SystemDataCreatedBy : +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 06-04-2023 05:31:18 +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : User +TopMetricsThreshold : {{ + "name": "Instance Availability", + "green": 90, + "yellow": 75, + "red": 50 + }} +Type : microsoft.workloads/monitors/saplandscapemonitor +``` + +Creates a new SAP landscape monitor + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupingLandscape +Gets or sets the list of landscape to SID mappings. +To construct, see NOTES section for GROUPINGLANDSCAPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapLandscapeMonitorSidMapping[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupingSapApplication +Gets or sets the list of Sap Applications to SID mappings. +To construct, see NOTES section for GROUPINGSAPAPPLICATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapLandscapeMonitorSidMapping[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopMetricsThreshold +Gets or sets the list Top Metric Thresholds for SAP Landscape Monitor Dashboard +To construct, see NOTES section for TOPMETRICSTHRESHOLD properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapLandscapeMonitorMetricThresholds[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapLandscapeMonitor + +## 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. + + +`GROUPINGLANDSCAPE <ISapLandscapeMonitorSidMapping[]>`: Gets or sets the list of landscape to SID mappings. + - `[Name <String>]`: Gets or sets the name of the grouping. + - `[TopSid <String[]>]`: Gets or sets the list of SID's. + +`GROUPINGSAPAPPLICATION <ISapLandscapeMonitorSidMapping[]>`: Gets or sets the list of Sap Applications to SID mappings. + - `[Name <String>]`: Gets or sets the name of the grouping. + - `[TopSid <String[]>]`: Gets or sets the list of SID's. + +`TOPMETRICSTHRESHOLD <ISapLandscapeMonitorMetricThresholds[]>`: Gets or sets the list Top Metric Thresholds for SAP Landscape Monitor Dashboard + - `[Green <Single?>]`: Gets or sets the threshold value for Green. + - `[Name <String>]`: Gets or sets the name of the threshold. + - `[Red <Single?>]`: Gets or sets the threshold value for Red. + - `[Yellow <Single?>]`: Gets or sets the threshold value for Yellow. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/New-AzWorkloadsSapLandscapeMonitorMetricThresholdsObject.md b/azps-10.1.0/Az.Workloads/New-AzWorkloadsSapLandscapeMonitorMetricThresholdsObject.md new file mode 100644 index 0000000000..ecb63437b4 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/New-AzWorkloadsSapLandscapeMonitorMetricThresholdsObject.md @@ -0,0 +1,117 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/Az.Workloads/new-AzWorkloadsSapLandscapeMonitorMetricThresholdsObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsSapLandscapeMonitorMetricThresholdsObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsSapLandscapeMonitorMetricThresholdsObject.md +--- + +# New-AzWorkloadsSapLandscapeMonitorMetricThresholdsObject + +## SYNOPSIS +Create an in-memory object for SapLandscapeMonitorMetricThresholds. + +## SYNTAX + +``` +New-AzWorkloadsSapLandscapeMonitorMetricThresholdsObject [-Green <Single>] [-Name <String>] [-Red <Single>] + [-Yellow <Single>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SapLandscapeMonitorMetricThresholds. + +## EXAMPLES + +### Example 1: Create a new Metrics Threshold for SAP Landscape Monitor +```powershell +New-AzWorkloadsSapLandscapeMonitorMetricThresholdsObject -Green 90 -Name X00 -Red 50 -Yellow 80 +``` + +```output +Green Name Red Yellow +----- ---- --- ------ +90 X00 50 80 + +``` + +Create a new Metrics Threshold object to be used for creating a SAP Landscape Monitor + +## PARAMETERS + +### -Green +Gets or sets the threshold value for Green. + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the threshold. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Red +Gets or sets the threshold value for Red. + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Yellow +Gets or sets the threshold value for Yellow. + +```yaml +Type: System.Single +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.SapLandscapeMonitorMetricThresholds + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/New-AzWorkloadsSapLandscapeMonitorSidMappingObject.md b/azps-10.1.0/Az.Workloads/New-AzWorkloadsSapLandscapeMonitorSidMappingObject.md new file mode 100644 index 0000000000..6d99c36c43 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/New-AzWorkloadsSapLandscapeMonitorSidMappingObject.md @@ -0,0 +1,85 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/Az.Workloads/new-AzWorkloadsSapLandscapeMonitorSidMappingObject +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsSapLandscapeMonitorSidMappingObject.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsSapLandscapeMonitorSidMappingObject.md +--- + +# New-AzWorkloadsSapLandscapeMonitorSidMappingObject + +## SYNOPSIS +Create an in-memory object for SapLandscapeMonitorSidMapping. + +## SYNTAX + +``` +New-AzWorkloadsSapLandscapeMonitorSidMappingObject [-Name <String>] [-TopSid <String[]>] [<CommonParameters>] +``` + +## DESCRIPTION +Create an in-memory object for SapLandscapeMonitorSidMapping. + +## EXAMPLES + +### Example 1: Create a new SID mapping for SAP Landscape Monitor +```powershell +New-AzWorkloadsSapLandscapeMonitorSidMappingObject -Name Prod -TopSid "{SID2,SID1}" +``` + +```output +Name TopSid +---- ------ +Prod {{SID2,SID1}} +``` + +Create a new Metrics Threshold object to be used for creating a SAP Landscape Monitor + +## PARAMETERS + +### -Name +Gets or sets the name of the grouping. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopSid +Gets or sets the list of SID's. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.SapLandscapeMonitorSidMapping + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/New-AzWorkloadsSapVirtualInstance.md b/azps-10.1.0/Az.Workloads/New-AzWorkloadsSapVirtualInstance.md new file mode 100644 index 0000000000..6061c5e230 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/New-AzWorkloadsSapVirtualInstance.md @@ -0,0 +1,401 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/new-azworkloadssapvirtualinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsSapVirtualInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/New-AzWorkloadsSapVirtualInstance.md +--- + +# New-AzWorkloadsSapVirtualInstance + +## SYNOPSIS +Creates a Virtual Instance for SAP solutions (VIS) resource + +## SYNTAX + +### CreateWithDiscovery (Default) +``` +New-AzWorkloadsSapVirtualInstance -Name <String> -ResourceGroupName <String> -CentralServerVmId <String> + -Environment <SapEnvironmentType> -Location <String> -SapProduct <SapProductType> [-SubscriptionId <String>] + [-IdentityType <ManagedServiceIdentityType>] [-ManagedResourceGroupName <String>] + [-ManagedRgStorageAccountName <String>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### CreateWithJsonTemplatePath +``` +New-AzWorkloadsSapVirtualInstance -Name <String> -ResourceGroupName <String> -Configuration <String> + -Environment <SapEnvironmentType> -Location <String> -SapProduct <SapProductType> [-SubscriptionId <String>] + [-IdentityType <ManagedServiceIdentityType>] [-ManagedResourceGroupName <String>] [-Tag <Hashtable>] + [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Creates a Virtual Instance for SAP solutions (VIS) resource + +## EXAMPLES + +### Example 1: Deploy infrastructure for a three-tier distributed SAP system using Virtual Instances for SAP solutions +```powershell +New-AzWorkloadsSapVirtualInstance -ResourceGroupName 'PowerShell-CLI-TestRG' -Name L46 -Location eastus -Environment 'NonProd' -SapProduct 'S4HANA' -Configuration .\CreatePayload.json -Tag @{k1 = "v1"; k2 = "v2"} -IdentityType 'UserAssigned' -ManagedResourceGroupName "L46-rg" -UserAssignedIdentity @{'/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourcegroups/SAP-E2ETest-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/E2E-RBAC-MSI'= @{}} +``` + +```output +Name ResourceGroupName Health Environment ProvisioningState SapProduct State Status Location +---- ----------------- ------ ----------- ----------------- ---------- ----- ------ -------- +L46 PowerShell-CLI-TestRG NonProd Succeeded S4HANA SoftwareInstallationPending eastus +``` + +In this example, you Deploy the infrastructure for a three tier distributed SAP system. +A sample json payload is a linked here: https://go.microsoft.com/fwlink/?linkid=2230236 + +### Example 2: Install SAP software on the infrastructure deployed for the three-tier distributed SAP system using Virtual Instances for SAP solutions +```powershell +New-AzWorkloadsSapVirtualInstance -ResourceGroupName 'PowerShell-CLI-TestRG' -Name L46 -Location eastus -Environment 'NonProd' -SapProduct 'S4HANA' -Configuration .\InstallPayload.json -Tag @{k1 = "v1"; k2 = "v2"} -IdentityType 'UserAssigned' -ManagedResourceGroupName "L46-rg" -UserAssignedIdentity @{'/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourcegroups/SAP-E2ETest-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/E2E-RBAC-MSI'= @{}} +``` + +```output +Name ResourceGroupName Health Environment ProvisioningState SapProduct State Status Location +---- ----------------- ------ ----------- ----------------- ---------- ----- ------ -------- +L46 PowerShell-CLI-TestRG NonProd Succeeded S4HANA RegistrationComplete eastus +``` + +In this example, you Install the SAP software on the deployed infrastructure for a three tier Non-High Availability distributed SAP system. +A sample json payload is a linked here:https://go.microsoft.com/fwlink/?linkid=2230167 + +### Example 3: Deploy infrastructure for a three-tier distributed Highly Available (HA) SAP system using Virtual Instances for SAP solutions +```powershell + New-AzWorkloadsSapVirtualInstance -ResourceGroupName 'PowerShell-CLI-TestRG' -Name SK1 -Location eastus -Environment 'NonProd' -SapProduct 'S4HANA' -Configuration .\CreatePayloadHACustomNames.json -IdentityType 'UserAssigned' -ManagedResourceGroupName "acss-mrg1" -UserAssignedIdentity @{'/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourcegroups/SAP-E2ETest-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/E2E-RBAC-MSI'= @{}} +``` + +```output +Name ResourceGroupName Health Environment ProvisioningState SapProduct State Status Location +---- ----------------- ------ ----------- ----------------- ---------- ----- ------ -------- +SK1 PowerShell-CLI-TestRG NonProd Succeeded S4HANA SoftwareInstallationPending eastus +``` + +In this example, you Deploy the infrastructure for a three tier distributed Highly Available (HA) SAP system. +A sample json payload to use in this command is linked here: https://go.microsoft.com/fwlink/?linkid=2230402 + +### Example 4: Install SAP software on the infrastructure deployed for the three-tier distributed Highly Available (HA) SAP system using Virtual Instances for SAP solutions +```powershell +New-AzWorkloadsSapVirtualInstance -ResourceGroupName 'PowerShell-CLI-TestRG' -Name SK1 -Location eastus -Environment 'NonProd' -SapProduct 'S4HANA' -Configuration .\CreatePayloadHACustomNamesInstall.json -IdentityType 'UserAssigned' -ManagedResourceGroupName "acss-mrg1" -UserAssignedIdentity @{'/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourcegroups/SAP-E2ETest-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/E2E-RBAC-MSI'= @{}} +``` + +```output +Name ResourceGroupName Health Environment ProvisioningState SapProduct State Status Location +---- ----------------- ------ ----------- ----------------- ---------- ----- ------ -------- +SK1 PowerShell-CLI-TestRG NonProd Succeeded S4HANA RegistrationComplete eastus +``` + +In this example, you Install the SAP software on the deployed infrastructure for a three tier distributed Highly Availabile SAP system with Transport directory and customized resource naming. +A sample json payload to use in this command is linked here: https://go.microsoft.com/fwlink/?linkid=2230340 + +### Example 5: Register an existing SAP system as a VIS +```powershell +New-AzWorkloadsSapVirtualInstance -ResourceGroupName 'TestRG' -Name L46 -Location eastus -Environment 'NonProd' -SapProduct 'S4HANA' -CentralServerVmId '/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourcegroups/powershell-cli-testrg/providers/microsoft.compute/virtualmachines/l46ascsvm' -Tag @{k1 = "v1"; k2 = "v2"} -ManagedResourceGroupName "L46-rg" -ManagedRgStorageAccountName 'acssstoragel46' -IdentityType 'UserAssigned' -UserAssignedIdentity @{'/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourcegroups/SAP-E2ETest-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/E2E-RBAC-MSI'= @{}} +``` + +```output +Name ResourceGroupName Health Environment ProvisioningState SapProduct State Status Location +---- ----------------- ------ ----------- ----------------- ---------- ----- ------ -------- +L46 PowerShell-CLI-TestRG NonProd Succeeded S4HANA RegistrationComplete eastus +``` + +Use the New-AzWorkloadsSapVirtualInstance cmdlet with the suggested input parameters to register an existing SAP system as a Virtual Instance for SAP solutions resource. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CentralServerVmId +The virtual machine ID of the Central Server + +```yaml +Type: System.String +Parameter Sets: CreateWithDiscovery +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Configuration +Configuration json path. + +```yaml +Type: System.String +Parameter Sets: CreateWithJsonTemplatePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Environment +Defines the environment type - Production/Non Production. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapEnvironmentType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of manage identity + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.ManagedServiceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedResourceGroupName +Managed resource group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedRgStorageAccountName +The custom storage account name for the storage account created by the service in the managed resource group created as part of VIS deployment. + +Refer to the storage account naming rules [here](https://learn.microsoft.com/azure/azure-resource-manager/management/resource-name-rules#microsoftstorage). + +If not provided, the service will create the storage account with a random name + +```yaml +Type: System.String +Parameter Sets: CreateWithDiscovery +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SapVirtualInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapProduct +Defines the SAP Product type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.SapProductType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +User assigned identities dictionary + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapVirtualInstance + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Remove-AzWorkloadsMonitor.md b/azps-10.1.0/Az.Workloads/Remove-AzWorkloadsMonitor.md new file mode 100644 index 0000000000..1a2c1672bb --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Remove-AzWorkloadsMonitor.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/remove-azworkloadsmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Remove-AzWorkloadsMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Remove-AzWorkloadsMonitor.md +--- + +# Remove-AzWorkloadsMonitor + +## SYNOPSIS +Deletes a SAP monitor with the specified subscription, resource group, and SAP monitor name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWorkloadsMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWorkloadsMonitor -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a SAP monitor with the specified subscription, resource group, and SAP monitor name. + +## EXAMPLES + +### Example 1: Delete a specific AMS +```powershell +Remove-AzWorkloadsMonitor -Name suha-050423-ams7 -ResourceGroupName suha-0802-rg1 -SubscriptionId 49d64d54-e966-4c46-a868-1999802b762c +``` + +```output +EndTime Name PercentComplete Resour + ceGrou + pName +------- ---- --------------- ------ + 2a2acaca-6dbb-4531-859e-5cc8bf6d66a0*223F4A00A95CA88C8A59BF9C0FAD97B67B40E41D4AF631069741A1BF6DDA8BFB +``` + +Delete a specific AMS + +### Example 2: Delete a specific AMS by Id +```powershell +Remove-AzWorkloadsMonitor -InputObject "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/suha-0802-rg1/providers/Microsoft.Workloads/monitors/suha-050423-ams7" +``` + +```output +EndTime Name PercentComplete Resour + ceGrou + pName +------- ---- --------------- ------ + 2a2acaca-6dbb-4531-859e-5cc8bf6d66a0*223F4A00A95CA88C8A59BF9C0FAD97B67B40E41D4AF631069741A1BF6DDA8BFB +``` + +Delete a specific AMS by Arm Id + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api30.IOperationStatusResult + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Remove-AzWorkloadsProviderInstance.md b/azps-10.1.0/Az.Workloads/Remove-AzWorkloadsProviderInstance.md new file mode 100644 index 0000000000..c6a473707f --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Remove-AzWorkloadsProviderInstance.md @@ -0,0 +1,265 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/remove-azworkloadsproviderinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Remove-AzWorkloadsProviderInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Remove-AzWorkloadsProviderInstance.md +--- + +# Remove-AzWorkloadsProviderInstance + +## SYNOPSIS +Deletes a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWorkloadsProviderInstance -MonitorName <String> -Name <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWorkloadsProviderInstance -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a provider instance for the specified subscription, resource group, SAP monitor name, and resource name. + +## EXAMPLES + +### Example 1: Delete a specific provider from AMS instance +```powershell +Remove-AzWorkloadsProviderInstance -MonitorName suha-160323-ams7 -Name suha-os-1 -ResourceGroupName suha-0802-rg1 -SubscriptionId 49d64d54-e966-4c46-a868-1999802b762c +``` + +```output +EndTime Name PercentComplete ResourceGroupName StartTime Status +------- ---- --------------- ----------------- --------- ------ +16-03-2023 11:48:08 034ff381-73dc-4273-8ed2-1ccd852a64a2*6E77053B6B98265D96E60B59AE83132A76A7B1EA2C160941AD1C81EFE679D721 16-03-2023 11:48:05 Succeeded +``` + +Delete a provider from specific AMS Instance + +### Example 2: Delete a specific provider from AMS instance by Id +```powershell +Remove-AzWorkloadsProviderInstance -InputObject "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/suha-0802-rg1/providers/Microsoft.Workloads/monitors/suha-160323-ams7/providerInstances/suha-os-1" +``` + +```output +EndTime Name PercentComplete ResourceGroupName StartTime Status +------- ---- --------------- ----------------- --------- ------ +16-03-2023 11:48:08 034ff381-73dc-4273-8ed2-1ccd852a64a2*6E77053B6B98265D96E60B59AE83132A76A7B1EA2C160941AD1C81EFE679D721 16-03-2023 11:48:05 Succeeded +``` + +Delete a provider from specific AMS Instance by Arm Id + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the provider instance. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ProviderInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api30.IOperationStatusResult + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Remove-AzWorkloadsSapLandscapeMonitor.md b/azps-10.1.0/Az.Workloads/Remove-AzWorkloadsSapLandscapeMonitor.md new file mode 100644 index 0000000000..b7a4e16ca5 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Remove-AzWorkloadsSapLandscapeMonitor.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/remove-azworkloadssaplandscapemonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Remove-AzWorkloadsSapLandscapeMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Remove-AzWorkloadsSapLandscapeMonitor.md +--- + +# Remove-AzWorkloadsSapLandscapeMonitor + +## SYNOPSIS +Deletes a SAP Landscape Monitor Dashboard with the specified subscription, resource group, and SAP monitor name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWorkloadsSapLandscapeMonitor -MonitorName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWorkloadsSapLandscapeMonitor -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a SAP Landscape Monitor Dashboard with the specified subscription, resource group, and SAP monitor name. + +## EXAMPLES + +### Example 1: Delete SAP Landscape Monitor +```powershell +Remove-AzWorkloadsSapLandscapeMonitor -MonitorName suha-160323-ams7 -ResourceGroupName suha-0802-rg1 -SubscriptionId 49d64d54-e966-4c46-a868-1999802b762c +``` + +Delete SAP Landscape Monitor for a specific AMS Instance + +### Example 2: Delete SAP Landscape Monitor by Id +```powershell +Remove-AzWorkloadsSapLandscapeMonitor -InputObject "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/suha-0802-rg1/providers/Microsoft.Workloads/monitors/suha-0202-ams9/sapLandscapeMonitor/default" +``` + +Delete SAP Landscape Monitor for a specific AMS Instance by ArmId + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +`INPUTOBJECT <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Remove-AzWorkloadsSapVirtualInstance.md b/azps-10.1.0/Az.Workloads/Remove-AzWorkloadsSapVirtualInstance.md new file mode 100644 index 0000000000..cecc562684 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Remove-AzWorkloadsSapVirtualInstance.md @@ -0,0 +1,279 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/remove-azworkloadssapvirtualinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Remove-AzWorkloadsSapVirtualInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Remove-AzWorkloadsSapVirtualInstance.md +--- + +# Remove-AzWorkloadsSapVirtualInstance + +## SYNOPSIS +Deletes a Virtual Instance for SAP solutions resource and its child resources, that is the associated Central Services Instance, Application Server Instances and Database Instance. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzWorkloadsSapVirtualInstance -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### DeleteViaIdentity +``` +Remove-AzWorkloadsSapVirtualInstance -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Deletes a Virtual Instance for SAP solutions resource and its child resources, that is the associated Central Services Instance, Application Server Instances and Database Instance. + +## EXAMPLES + +### Example 1: Remove a Virtual Instance for SAP solutions (VIS) +```powershell +Remove-AzWorkloadsSapVirtualInstance -Name X51 -ResourceGroupName X51Test +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/EASTUS/operationStatuses/1433bd12-7bb0-403d-a11c-31194d7bd4 + f2*619F4904A0186D89AC80F440FBACD91E1EBCEBE959C0A31F7160ABF29816CAF8 +Message : +Name : 1433bd12-7bb0-403d-a11c-31194d7bd4f2*619F4904A0186D89AC80F440FBACD91E1EBCEBE959C0A31F7160ABF29816CAF8 +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 14:50:32 +Status : Succeeded +Target : +``` + +Remove-AzWorkloadsSapVirtualInstance cmdlet deletes the VIS, associated child instances (ASCS, Application Instance and Database Instance) and Managed Resource Group. +This action doesnt delete the underlying physical Infrastructure resources such as Application resource group and underlying components such as Virtual Machines, Disks, etc. +Its required that customer deletes physical resources themselves. +Delete of a VIS is permanent action and cannot be reverted. +In this example, you can see that VIS can be deleted by passing the VIS name and Resource Group as inputs. + +### Example 2: Remove a Virtual Instance for SAP solutions (VIS) +```powershell +Remove-AzWorkloadsSapVirtualInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/X51Test/providers/Microsoft.Workloads/sapVirtualInstances/X51 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/EASTUS/operationStatuses/1433bd12-7bb0-403d-a11c-31194d7bd4 + f2*619F4904A0186D89AC80F440FBACD91E1EBCEBE959C0A31F7160ABF29816CAF8 +Message : +Name : 1433bd12-7bb0-403d-a11c-31194d7bd4f2*619F4904A0186D89AC80F440FBACD91E1EBCEBE959C0A31F7160ABF29816CAF8 +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 14:50:32 +Status : Succeeded +Target : +``` + +Remove-AzWorkloadsSapVirtualInstance cmdlet deletes the VIS, associated child instances (ASCS, Application Instance and Database Instance) and Managed Resource Group. +This action doesnt delete the underlying physical Infrastructure resources such as Application resource group and underlying components such as Virtual Machines, Disks, etc. +Its required that customer deletes physical resources themselves. +Delete of a VIS is permanent action and cannot be reverted. +In this example, you can see that VIS can be deleted by passing the Virtual Instance for SAP solutions (VIS) Azure resource ID as InputObject to the cmdlet. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SapVirtualInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api30.IOperationStatusResult + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Start-AzWorkloadsSapApplicationInstance.md b/azps-10.1.0/Az.Workloads/Start-AzWorkloadsSapApplicationInstance.md new file mode 100644 index 0000000000..f68b00fb33 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Start-AzWorkloadsSapApplicationInstance.md @@ -0,0 +1,276 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/start-azworkloadssapapplicationinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Start-AzWorkloadsSapApplicationInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Start-AzWorkloadsSapApplicationInstance.md +--- + +# Start-AzWorkloadsSapApplicationInstance + +## SYNOPSIS +Starts the SAP Application Server Instance. + +## SYNTAX + +### Start (Default) +``` +Start-AzWorkloadsSapApplicationInstance -Name <String> -ResourceGroupName <String> + -SapVirtualInstanceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzWorkloadsSapApplicationInstance -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Starts the SAP Application Server Instance. + +## EXAMPLES + +### Example 1: Start Application server instance of the SAP system +```powershell +Start-AzWorkloadsSapApplicationInstance -Name app0 -ResourceGroupName db0-vis-rg -SapVirtualInstanceName DB0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 08:21:31 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/58527855-a695-48a5-ac11-fbc + 74b836859*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Message : +Name : 58527855-a695-48a5-ac11-fbc74b836859*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 08:18:22 +Status : Succeeded +Target : +``` + +Start-AzWorkloadsSapApplicationInstance cmdlet starts the App server instance of the SAP system represented by the VIS. +Currently, start action is supported for ABAP stack. +In this example, you can see that instance can be started by passing the App server instance resource name, Resource Group name and VIS name as inputs. + +### Example 2: Start Application server instance of the SAP system +```powershell +Start-AzWorkloadsSapApplicationInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/db0-vis-rg/providers/Microsoft.Workloads/sapVirtualInstances/DB0/applicationInstances/app0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 09:11:00 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/651c6f1b-db7 + b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Message : +Name : 651c6f1b-db7b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 09:08:45 +Status : Succeeded +Target : +``` + +Start-AzWorkloadsSapApplicationInstance cmdlet starts the App server instance of the SAP system represented by the VIS. +Currently, start action is supported for ABAP stack. +In this example, you can see that instance can be started by passing the App server instance Azure resource ID as InputObject to the cmdlet. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of SAP Application Server instance resource. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapVirtualInstanceName +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api30.IOperationStatusResult + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Start-AzWorkloadsSapCentralInstance.md b/azps-10.1.0/Az.Workloads/Start-AzWorkloadsSapCentralInstance.md new file mode 100644 index 0000000000..825af6f082 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Start-AzWorkloadsSapCentralInstance.md @@ -0,0 +1,276 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/start-azworkloadssapcentralinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Start-AzWorkloadsSapCentralInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Start-AzWorkloadsSapCentralInstance.md +--- + +# Start-AzWorkloadsSapCentralInstance + +## SYNOPSIS +Starts the SAP Central Services Instance. + +## SYNTAX + +### Start (Default) +``` +Start-AzWorkloadsSapCentralInstance -Name <String> -ResourceGroupName <String> + -SapVirtualInstanceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzWorkloadsSapCentralInstance -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Starts the SAP Central Services Instance. + +## EXAMPLES + +### Example 1: Start Central services instance of the SAP system +```powershell +Start-AzWorkloadsSapCentralInstance -Name cs0 -ResourceGroupName db0-vis-rg -SapVirtualInstanceName DB0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 09:11:00 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/651c6f1b-db7 + b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Message : +Name : 651c6f1b-db7b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 09:08:45 +Status : Succeeded +Target : +``` + +Start-AzWorkloadsSapCentralInstance cmdlet starts the Central services instance of the SAP system represented by the VIS. +Currently, start action is supported for ABAP central services stack. +In this example, you can see that instance can be started by passing the Central services instance resource name, Resource Group name and VIS name as inputs. + +### Example 2: Start Central services instance of the SAP system +```powershell +Start-AzWorkloadsSapCentralInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/db0-vis-rg/providers/Microsoft.Workloads/sapVirtualInstances/DB0/centralInstances/cs0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 09:11:00 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/651c6f1b-db7 + b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Message : +Name : 651c6f1b-db7b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 09:08:45 +Status : Succeeded +Target : +``` + +Start-AzWorkloadsSapCentralInstance cmdlet starts the Central services instance of the SAP system represented by the VIS. +Currently, start action is supported for ABAP central services stack. +In this example, you can see that instance can be started by passing the Central services instance Azure resource ID as InputObject to the cmdlet. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapVirtualInstanceName +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api30.IOperationStatusResult + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Start-AzWorkloadsSapDatabaseInstance.md b/azps-10.1.0/Az.Workloads/Start-AzWorkloadsSapDatabaseInstance.md new file mode 100644 index 0000000000..1b85115a5e --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Start-AzWorkloadsSapDatabaseInstance.md @@ -0,0 +1,276 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/start-azworkloadssapdatabaseinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Start-AzWorkloadsSapDatabaseInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Start-AzWorkloadsSapDatabaseInstance.md +--- + +# Start-AzWorkloadsSapDatabaseInstance + +## SYNOPSIS +Starts the database instance of the SAP system. + +## SYNTAX + +### Start (Default) +``` +Start-AzWorkloadsSapDatabaseInstance -Name <String> -ResourceGroupName <String> + -SapVirtualInstanceName <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzWorkloadsSapDatabaseInstance -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Starts the database instance of the SAP system. + +## EXAMPLES + +### Example 1: Start Database instance of the SAP system +```powershell +Start-AzWorkloadsSapDatabaseInstance -Name db0 -ResourceGroupName db0-vis-rg -SapVirtualInstanceName DB0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 09:11:00 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/651c6f1b-db7 + b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Message : +Name : 651c6f1b-db7b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 09:08:45 +Status : Succeeded +Target : +``` + +Start-AzWorkloadsSapDatabaseInstance cmdlet starts the Database instance of the SAP system represented by the VIS. +Currently start action is supported for SAP HANA Database only. +In this example, you can see that database can be started by passing the DB instance resource name, ResourceGroupName and VIS name as inputs. + +### Example 2: Start Database instance of the SAP system +```powershell +Start-AzWorkloadsSapDatabaseInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/db0-vis-rg/providers/Microsoft.Workloads/sapVirtualInstances/DB0/databaseInstances/db0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 09:11:00 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/651c6f1b-db7 + b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Message : +Name : 651c6f1b-db7b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 09:08:45 +Status : Succeeded +Target : +``` + +Start-AzWorkloadsSapDatabaseInstance cmdlet starts the Database instance of the SAP system represented by the VIS. +Currently start action is supported for SAP HANA Database only. +In this example, you can see that database can be started by providing the DB instance Azure resource ID as InputObject to the cmdlet. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database resource name string modeled as parameter for auto generation to work correctly. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapVirtualInstanceName +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api30.IOperationStatusResult + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Start-AzWorkloadsSapVirtualInstance.md b/azps-10.1.0/Az.Workloads/Start-AzWorkloadsSapVirtualInstance.md new file mode 100644 index 0000000000..f8659350d9 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Start-AzWorkloadsSapVirtualInstance.md @@ -0,0 +1,258 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/start-azworkloadssapvirtualinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Start-AzWorkloadsSapVirtualInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Start-AzWorkloadsSapVirtualInstance.md +--- + +# Start-AzWorkloadsSapVirtualInstance + +## SYNOPSIS +Starts the SAP application, that is the Central Services instance and Application server instances. + +## SYNTAX + +### Start (Default) +``` +Start-AzWorkloadsSapVirtualInstance -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StartViaIdentity +``` +Start-AzWorkloadsSapVirtualInstance -InputObject <IWorkloadsIdentity> [-DefaultProfile <PSObject>] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Starts the SAP application, that is the Central Services instance and Application server instances. + +## EXAMPLES + +### Example 1: Start an SAP system +```powershell +Start-AzWorkloadsSapVirtualInstance -Name DB0 -ResourceGroupName db0-vis-rg +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 09:11:00 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/651c6f1b-db7 + b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Message : +Name : 651c6f1b-db7b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 09:08:45 +Status : Succeeded +Target : +``` + +Start-AzWorkloadsSapVirtualInstance cmdlet starts the SAP application tier, that is ASCS instance and App servers of the system. +In this example, you can see that system can be started by passing the VIS name and ResourceGroupName of the VIS as inputs. + +### Example 2: Start an SAP system +```powershell +Start-AzWorkloadsSapVirtualInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/db0-vis-rg/providers/Microsoft.Workloads/sapVirtualInstances/DB0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 09:11:00 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/651c6f1b-db7 + b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Message : +Name : 651c6f1b-db7b-46b2-ba9a-fb5ee67ec372*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 09:08:45 +Status : Succeeded +Target : +``` + +Start-AzWorkloadsSapVirtualInstance cmdlet starts the SAP application tier, that is ASCS instance and App servers of the system. +In this example, you can see that system can be started by providing the VIS Azure resource ID as InputObject to the cmdlet. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: SapVirtualInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api30.IOperationStatusResult + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Stop-AzWorkloadsSapApplicationInstance.md b/azps-10.1.0/Az.Workloads/Stop-AzWorkloadsSapApplicationInstance.md new file mode 100644 index 0000000000..6b270da3ff --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Stop-AzWorkloadsSapApplicationInstance.md @@ -0,0 +1,293 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/stop-azworkloadssapapplicationinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Stop-AzWorkloadsSapApplicationInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Stop-AzWorkloadsSapApplicationInstance.md +--- + +# Stop-AzWorkloadsSapApplicationInstance + +## SYNOPSIS +Stops the SAP Application Server Instance. + +## SYNTAX + +### StopExpanded (Default) +``` +Stop-AzWorkloadsSapApplicationInstance -Name <String> -ResourceGroupName <String> + -SapVirtualInstanceName <String> [-SubscriptionId <String>] [-SoftStopTimeoutSecond <Int64>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StopViaIdentityExpanded +``` +Stop-AzWorkloadsSapApplicationInstance -InputObject <IWorkloadsIdentity> [-SoftStopTimeoutSecond <Int64>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Stops the SAP Application Server Instance. + +## EXAMPLES + +### Example 1: Stop Application server instance of the SAP system +```powershell +Stop-AzWorkloadsSapApplicationInstance -Name app0 -ResourceGroupName db0-vis-rg -SapVirtualInstanceName DB0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 08:45:40 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/881d4ff9-1d38-4596-b215-28e + 77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Message : +Name : 881d4ff9-1d38-4596-b215-28e77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 08:43:32 +Status : Succeeded +Target : +``` + +Stop-AzWorkloadsSapApplicationInstance cmdlet stops the App server instance of the SAP system represented by the VIS. +Currently, stop action is supported for ABAP stack. +In this example, you can see that instance can be stopped by passing the App server instance resource name, Resource Group name and VIS name as inputs. + +### Example 2: Stop Application server instance of the SAP system +```powershell +Stop-AzWorkloadsSapApplicationInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/db0-vis-rg/providers/Microsoft.Workloads/sapVirtualInstances/DB0/applicationInstances/app0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 08:45:40 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/881d4ff9-1d38-4596-b215-28e + 77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Message : +Name : 881d4ff9-1d38-4596-b215-28e77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 08:43:32 +Status : Succeeded +Target : +``` + +Stop-AzWorkloadsSapApplicationInstance cmdlet stops the App server instance of the SAP system represented by the VIS. +Currently, stop action is supported for ABAP stack. +In this example, you can see that instance can be stopped by passing the App server instance Azure resource ID as InputObject to the cmdlet. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: StopViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of SAP Application Server instance resource. + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapVirtualInstanceName +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftStopTimeoutSecond +This parameter defines how long (in seconds) the soft shutdown waits until the RFC/HTTP clients no longer consider the server for calls with load balancing. +Value 0 means that the kernel does not wait, but goes directly into the next shutdown state, i.e. +hard stop. + +```yaml +Type: System.Int64 +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. + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api30.IOperationStatusResult + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Stop-AzWorkloadsSapCentralInstance.md b/azps-10.1.0/Az.Workloads/Stop-AzWorkloadsSapCentralInstance.md new file mode 100644 index 0000000000..eb70773b58 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Stop-AzWorkloadsSapCentralInstance.md @@ -0,0 +1,293 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/stop-azworkloadssapcentralinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Stop-AzWorkloadsSapCentralInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Stop-AzWorkloadsSapCentralInstance.md +--- + +# Stop-AzWorkloadsSapCentralInstance + +## SYNOPSIS +Stops the SAP Central Services Instance. + +## SYNTAX + +### StopExpanded (Default) +``` +Stop-AzWorkloadsSapCentralInstance -Name <String> -ResourceGroupName <String> -SapVirtualInstanceName <String> + [-SubscriptionId <String>] [-SoftStopTimeoutSecond <Int64>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StopViaIdentityExpanded +``` +Stop-AzWorkloadsSapCentralInstance -InputObject <IWorkloadsIdentity> [-SoftStopTimeoutSecond <Int64>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Stops the SAP Central Services Instance. + +## EXAMPLES + +### Example 1: Stop Central services instance of the SAP system +```powershell +Stop-AzWorkloadsSapCentralInstance -Name cs0 -ResourceGroupName db0-vis-rg -SapVirtualInstanceName DB0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 08:45:40 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/881d4ff9-1d38-4596-b215-28e + 77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Message : +Name : 881d4ff9-1d38-4596-b215-28e77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 08:43:32 +Status : Succeeded +Target : +``` + +Stop-AzWorkloadsSapCentralInstance cmdlet stops the Central services instance of the SAP system represented by the VIS. +Currently, stop action is supported for ABAP central services stack. +In this example, you can see that instance can be stopped by passing the Central services instance resource name, Resource Group name and VIS name as inputs. + +### Example 2: Stop Central services instance of the SAP system +```powershell +Stop-AzWorkloadsSapCentralInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/db0-vis-rg/providers/Microsoft.Workloads/sapVirtualInstances/DB0/centralInstances/cs0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 08:45:40 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/881d4ff9-1d38-4596-b215-28e + 77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Message : +Name : 881d4ff9-1d38-4596-b215-28e77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 08:43:32 +Status : Succeeded +Target : +``` + +Stop-AzWorkloadsSapCentralInstance cmdlet stops the Central services instance of the SAP system represented by the VIS. +Currently, stop action is supported for ABAP central services stack. +In this example, you can see that instance can be stopped by passing the Central services instance Azure resource ID as InputObject to the cmdlet. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: StopViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapVirtualInstanceName +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftStopTimeoutSecond +This parameter defines how long (in seconds) the soft shutdown waits until the RFC/HTTP clients no longer consider the server for calls with load balancing. +Value 0 means that the kernel does not wait, but goes directly into the next shutdown state, i.e. +hard stop. + +```yaml +Type: System.Int64 +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. + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api30.IOperationStatusResult + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Stop-AzWorkloadsSapDatabaseInstance.md b/azps-10.1.0/Az.Workloads/Stop-AzWorkloadsSapDatabaseInstance.md new file mode 100644 index 0000000000..b8c73ab5b6 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Stop-AzWorkloadsSapDatabaseInstance.md @@ -0,0 +1,293 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/stop-azworkloadssapdatabaseinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Stop-AzWorkloadsSapDatabaseInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Stop-AzWorkloadsSapDatabaseInstance.md +--- + +# Stop-AzWorkloadsSapDatabaseInstance + +## SYNOPSIS +Stops the database instance of the SAP system. + +## SYNTAX + +### StopExpanded (Default) +``` +Stop-AzWorkloadsSapDatabaseInstance -Name <String> -ResourceGroupName <String> + -SapVirtualInstanceName <String> [-SubscriptionId <String>] [-SoftStopTimeoutSecond <Int64>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### StopViaIdentityExpanded +``` +Stop-AzWorkloadsSapDatabaseInstance -InputObject <IWorkloadsIdentity> [-SoftStopTimeoutSecond <Int64>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Stops the database instance of the SAP system. + +## EXAMPLES + +### Example 1: Stop Database instance of the SAP system +```powershell +Stop-AzWorkloadsSapDatabaseInstance -Name db0 -ResourceGroupName db0-vis-rg -SapVirtualInstanceName DB0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 08:45:40 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/881d4ff9-1d38-4596-b215-28e + 77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Message : +Name : 881d4ff9-1d38-4596-b215-28e77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 08:43:32 +Status : Succeeded +Target : +``` + +Stop-AzWorkloadsSapDatabaseInstance cmdlet stops the Database instance of the SAP system represented by the VIS. +Currently stop action is supported for SAP HANA Database only. +In this example, you can see that database can be stopped by passing the DB instance resource name, ResourceGroupName and VIS name as inputs. + +### Example 2: Stop Database instance of the SAP system +```powershell +Stop-AzWorkloadsSapDatabaseInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/db0-vis-rg/providers/Microsoft.Workloads/sapVirtualInstances/DB0/databaseInstances/db0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 08:45:40 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/881d4ff9-1d38-4596-b215-28e + 77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Message : +Name : 881d4ff9-1d38-4596-b215-28e77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 08:43:32 +Status : Succeeded +Target : +``` + +Stop-AzWorkloadsSapDatabaseInstance cmdlet stops the Database instance of the SAP system represented by the VIS. +Currently stop action is supported for SAP HANA Database only. +In this example, you can see that database can be stopped by providing the DB instance Azure resource ID as InputObject to the cmdlet. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: StopViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database resource name string modeled as parameter for auto generation to work correctly. + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapVirtualInstanceName +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftStopTimeoutSecond +This parameter defines how long (in seconds) the soft shutdown waits until the RFC/HTTP clients no longer consider the server for calls with load balancing. +Value 0 means that the kernel does not wait, but goes directly into the next shutdown state, i.e. +hard stop. + +```yaml +Type: System.Int64 +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. + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api30.IOperationStatusResult + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Stop-AzWorkloadsSapVirtualInstance.md b/azps-10.1.0/Az.Workloads/Stop-AzWorkloadsSapVirtualInstance.md new file mode 100644 index 0000000000..95b081a6c1 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Stop-AzWorkloadsSapVirtualInstance.md @@ -0,0 +1,276 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/stop-azworkloadssapvirtualinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Stop-AzWorkloadsSapVirtualInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Stop-AzWorkloadsSapVirtualInstance.md +--- + +# Stop-AzWorkloadsSapVirtualInstance + +## SYNOPSIS +Stops the SAP Application, that is the Application server instances and Central Services instance. + +## SYNTAX + +### StopExpanded (Default) +``` +Stop-AzWorkloadsSapVirtualInstance -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-SoftStopTimeoutSecond <Int64>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +### StopViaIdentityExpanded +``` +Stop-AzWorkloadsSapVirtualInstance -InputObject <IWorkloadsIdentity> [-SoftStopTimeoutSecond <Int64>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Stops the SAP Application, that is the Application server instances and Central Services instance. + +## EXAMPLES + +### Example 1: Stop an SAP system +```powershell +Stop-AzWorkloadsSapVirtualInstance -Name DB0 -ResourceGroupName db0-vis-rg +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 09:04:37 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/7ff215e4-afb + 8-41fa-b281-0111da9a0cce*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Message : +Name : 7ff215e4-afb8-41fa-b281-0111da9a0cce*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 09:01:24 +Status : Succeeded +Target : +``` + +Stop-AzWorkloadsSapVirtualInstance cmdlet stops the SAP application tier, that is App servers and ASCS instances of the system. +In this example, you can see that system can be stopped by passing the VIS name and ResourceGroupName of the VIS as inputs. + +### Example 2: Stop an SAP system +```powershell +Stop-AzWorkloadsSapVirtualInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/db0-vis-rg/providers/Microsoft.Workloads/sapVirtualInstances/DB0 +``` + +```output +AdditionalInfo : +Code : +Detail : +EndTime : 15-03-2023 09:04:37 +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/7ff215e4-afb + 8-41fa-b281-0111da9a0cce*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Message : +Name : 7ff215e4-afb8-41fa-b281-0111da9a0cce*D9A8F8EF15D6E75CE64E8F442A39F1D7AF307793D262CE855530D335419055E3 +Operation : +PercentComplete : +ResourceGroupName : +StartTime : 15-03-2023 09:01:24 +Status : Succeeded +Target : +``` + +Stop-AzWorkloadsSapVirtualInstance cmdlet stops the SAP application tier, that is App servers and ASCS instances of the system. +In this example, you can see that system can be stopped by providing the VIS Azure resource ID as InputObject to the cmdlet. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: StopViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: SapVirtualInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftStopTimeoutSecond +This parameter defines how long (in seconds) the soft shutdown waits until the RFC/HTTP clients no longer consider the server for calls with load balancing. +Value 0 means that the kernel does not wait, but goes directly into the next shutdown state, i.e. +hard stop. + +```yaml +Type: System.Int64 +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. + +```yaml +Type: System.String +Parameter Sets: StopExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api30.IOperationStatusResult + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Update-AzWorkloadsMonitor.md b/azps-10.1.0/Az.Workloads/Update-AzWorkloadsMonitor.md new file mode 100644 index 0000000000..dcdffc8836 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Update-AzWorkloadsMonitor.md @@ -0,0 +1,252 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/update-azworkloadsmonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Update-AzWorkloadsMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Update-AzWorkloadsMonitor.md +--- + +# Update-AzWorkloadsMonitor + +## SYNOPSIS +Patches the Tags field of a SAP monitor for the specified subscription, resource group, and SAP monitor name. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWorkloadsMonitor -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IdentityType <ManagedServiceIdentityType>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWorkloadsMonitor -InputObject <IWorkloadsIdentity> [-IdentityType <ManagedServiceIdentityType>] + [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] + [<CommonParameters>] +``` + +## DESCRIPTION +Patches the Tags field of a SAP monitor for the specified subscription, resource group, and SAP monitor name. + +## EXAMPLES + +### Example 1: Update AMS Monitor Instance +```powershell +Update-AzWorkloadsMonitor -MonitorName suha-160323-ams7 -ResourceGroupName suha-0802-rg1 -SubscriptionId 49d64d54-e966-4c46-a868-1999802b762c -Tag @{name="tagValue"} +``` + +```output +Name ResourceGroupName ManagedResourceGroupConfigurationName Location ProvisioningState +---- ----------------- ------------------------------------- -------- ----------------- +suha-160323-ams7 suha-0802-rg1 mrg-16037 eastus2euap Succeeded +``` + +Update AMS Monitor Instance + +### Example 2: Update AMS Monitor Instance by Id +```powershell +Update-AzWorkloadsMonitor -InputObject "/subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/suha-0802-rg1/providers/Microsoft.Workloads/monitors/suha-160323-ams7" -Tag @{name="tagValue"} +``` + +```output + +Name ResourceGroupName ManagedResourceGroupConfigurationName Location ProvisioningState +---- ----------------- ------------------------------------- -------- ----------------- +suha-160323-ams7 suha-0802-rg1 mrg-16037 eastus2euap Succeeded +``` + +Update AMS Monitor Instance by Arm Id + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of manage identity + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.ManagedServiceIdentityType +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.Workloads.Models.IWorkloadsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: MonitorName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets the Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +User assigned identities dictionary + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.IMonitor + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapApplicationInstance.md b/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapApplicationInstance.md new file mode 100644 index 0000000000..94e884fec6 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapApplicationInstance.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/update-azworkloadssapapplicationinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Update-AzWorkloadsSapApplicationInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Update-AzWorkloadsSapApplicationInstance.md +--- + +# Update-AzWorkloadsSapApplicationInstance + +## SYNOPSIS +Puts the SAP Application Server Instance resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWorkloadsSapApplicationInstance -Name <String> -ResourceGroupName <String> + -SapVirtualInstanceName <String> [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWorkloadsSapApplicationInstance -InputObject <IWorkloadsIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Puts the SAP Application Server Instance resource. + +## EXAMPLES + +### Example 1: Add tags for an existing app server instance resource +```powershell +Update-AzWorkloadsSapApplicationInstance -Name app0 -ResourceGroupName db0-vis-rg -SapVirtualInstanceName DB0 -Tag @{ Test = "PS"; k2 = "v2"} +``` + +```output +Name ResourceGroupName Health ProvisioningState Status Hostname Location +---- ----------------- ------ ----------------- ------ -------- -------- +app0 db0-vis-rg Healthy Succeeded Running db0vm centraluseuap +``` + +This cmdlet adds new tag name, value pairs to the existing app server instance resource app0. +VIS name and Resource group name are the other input parameters. + +### Example 2: Add tags for an existing app server instance resource +```powershell +Update-AzWorkloadsSapApplicationInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/db0-vis-rg/providers/Microsoft.Workloads/sapVirtualInstances/DB0/applicationInstances/app0 -Tag @{ Test = "PS"; k2 = "v2"} +``` + +```output +Name ResourceGroupName Health ProvisioningState Status Hostname Location +---- ----------------- ------ ----------------- ------ -------- -------- +app0 db0-vis-rg Healthy Succeeded Running db0vm centraluseuap +``` + +This cmdlet adds new tag name, value pairs to the existing app server instance resource app0. +Here app instance Azure resource ID is used as the input parameter. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of SAP Application Server instance resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapVirtualInstanceName +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets the Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapApplicationServerInstance + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapCentralInstance.md b/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapCentralInstance.md new file mode 100644 index 0000000000..a0938c76fd --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapCentralInstance.md @@ -0,0 +1,273 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/update-azworkloadssapcentralinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Update-AzWorkloadsSapCentralInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Update-AzWorkloadsSapCentralInstance.md +--- + +# Update-AzWorkloadsSapCentralInstance + +## SYNOPSIS +Updates the SAP Central Services Instance resource. + + +This can be used to update tags on the resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWorkloadsSapCentralInstance -Name <String> -ResourceGroupName <String> + -SapVirtualInstanceName <String> [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWorkloadsSapCentralInstance -InputObject <IWorkloadsIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the SAP Central Services Instance resource. + + +This can be used to update tags on the resource. + +## EXAMPLES + +### Example 1: Add tags for an existing Central services instance resource +```powershell +Update-AzWorkloadsSapCentralInstance -Name cs0 -ResourceGroupName db0-vis-rg -SapVirtualInstanceName DB0 -Tag @{ Test = "PS"; k2 = "v2"} +``` + +```output +Name ResourceGroupName Health EnqueueServerPropertyHostname ProvisioningState Status Location +---- ----------------- ------ ----------------------------- ----------------- ------ -------- +cs0 db0-vis-rg Healthy db0vm Succeeded Running centraluseuap +``` + +This cmdlet adds new tag name, value pairs to the existing Central services instance resource cs0. +VIS name and Resource group name are the other input parameters. + +### Example 2: Add tags for an existing Central services instance resource +```powershell +Update-AzWorkloadsSapCentralInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/db0-vis-rg/providers/Microsoft.Workloads/sapVirtualInstances/DB0/centralInstances/cs0 -Tag @{ Test = "PS"; k2 = "v2"} +``` + +```output +Name ResourceGroupName Health EnqueueServerPropertyHostname ProvisioningState Status Location +---- ----------------- ------ ----------------------------- ----------------- ------ -------- +cs0 db0-vis-rg Healthy db0vm Succeeded Running centraluseuap +``` + +This cmdlet adds new tag name, value pairs to the existing Central services instance resource cs0. +Here Central services instance Azure resource ID is used as the input parameter. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapVirtualInstanceName +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets the Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapCentralServerInstance + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapDatabaseInstance.md b/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapDatabaseInstance.md new file mode 100644 index 0000000000..7bce2e9989 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapDatabaseInstance.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/update-azworkloadssapdatabaseinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Update-AzWorkloadsSapDatabaseInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Update-AzWorkloadsSapDatabaseInstance.md +--- + +# Update-AzWorkloadsSapDatabaseInstance + +## SYNOPSIS +Updates the Database resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWorkloadsSapDatabaseInstance -Name <String> -ResourceGroupName <String> + -SapVirtualInstanceName <String> [-SubscriptionId <String>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWorkloadsSapDatabaseInstance -InputObject <IWorkloadsIdentity> [-Tag <Hashtable>] + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates the Database resource. + +## EXAMPLES + +### Example 1: Add tags for an existing Database instance resource +```powershell +Update-AzWorkloadsSapDatabaseInstance -Name db0 -ResourceGroupName db0-vis-rg -SapVirtualInstanceName DB0 -Tag @{ Test = "PS"; k2 = "v2"} +``` + +```output +Name ResourceGroupName ProvisioningState Location Status IPAddress DatabaseSid +---- ----------------- ----------------- -------- ------ --------- ----------- +db0 db0-vis-rg Succeeded centraluseuap Running 172.31.5.4 MB0 +``` + +This cmdlet adds new tag name, value pairs to the existing Database instance resource db0. +VIS name and Resource group name are the other input parameters. + +### Example 2: Add tags for an existing Database instance resource +```powershell +Update-AzWorkloadsSapDatabaseInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/db0-vis-rg/providers/Microsoft.Workloads/sapVirtualInstances/DB0/databaseInstances/db0 -Tag @{ Test = "PS"; k2 = "v2"} +``` + +```output +Name ResourceGroupName ProvisioningState Location Status IPAddress DatabaseSid +---- ----------------- ----------------- -------- ------ --------- ----------- +db0 db0-vis-rg Succeeded centraluseuap Running 172.31.5.4 MB0 +``` + +This cmdlet adds new tag name, value pairs to the existing Database instance resource db0. +Here Database instance Azure resource ID is used as the input parameter. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Database resource name string modeled as parameter for auto generation to work correctly. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SapVirtualInstanceName +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets the Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapDatabaseInstance + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapLandscapeMonitor.md b/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapLandscapeMonitor.md new file mode 100644 index 0000000000..6acb6c5432 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapLandscapeMonitor.md @@ -0,0 +1,290 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/update-azworkloadssaplandscapemonitor +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Update-AzWorkloadsSapLandscapeMonitor.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Update-AzWorkloadsSapLandscapeMonitor.md +--- + +# Update-AzWorkloadsSapLandscapeMonitor + +## SYNOPSIS +Patches the SAP Landscape Monitor Dashboard for the specified subscription, resource group, and SAP monitor name. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWorkloadsSapLandscapeMonitor -MonitorName <String> -ResourceGroupName <String> + [-SubscriptionId <String>] [-GroupingLandscape <ISapLandscapeMonitorSidMapping[]>] + [-GroupingSapApplication <ISapLandscapeMonitorSidMapping[]>] + [-TopMetricsThreshold <ISapLandscapeMonitorMetricThresholds[]>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWorkloadsSapLandscapeMonitor -InputObject <IWorkloadsIdentity> + [-GroupingLandscape <ISapLandscapeMonitorSidMapping[]>] + [-GroupingSapApplication <ISapLandscapeMonitorSidMapping[]>] + [-TopMetricsThreshold <ISapLandscapeMonitorMetricThresholds[]>] [-DefaultProfile <PSObject>] [-Confirm] + [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Patches the SAP Landscape Monitor Dashboard for the specified subscription, resource group, and SAP monitor name. + +## EXAMPLES + +### Example 1: Update SAP Landscape Monitor +```powershell +New-AzWorkloadsSapLandscapeMonitor -MonitorName suha-0202-ams9 -ResourceGroupName suha-0802-rg1 -SubscriptionId 49d64d54-e966-4c46-a868-1999802b762c -GroupingLandscape '{"name":"Prod","topSid":["SID1","SID2"]}' -GroupingSapApplication '{"name":"ERP1","topSid":["SID1","SID2"]}' -TopMetricsThreshold '{"name":"Instance Availability","green":90,"yellow":75,"red":50}' +``` + +```output +GroupingLandscape : {{ + "name": "Prod", + "topSid": [ "SID1", "SID2" ] + }} +GroupingSapApplication : {{ + "name": "ERP1", + "topSid": [ "SID1", "SID2" ] + }} +Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/suha-0802-rg1/providers/Microsoft. + Workloads/monitors/suha-0202-ams9/sapLandscapeMonitor/default +Name : default +ProvisioningState : Succeeded +ResourceGroupName : suha-0802-rg1 +SystemData : { + "createdBy": "", + "createdByType": "User", + "createdAt": "2023-04-06T05:30:54.9427030Z", + "lastModifiedBy": "", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-04-06T05:31:18.7873209Z" + } +SystemDataCreatedAt : 06-04-2023 05:30:54 +SystemDataCreatedBy : +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 06-04-2023 05:31:18 +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : User +TopMetricsThreshold : {{ + "name": "Instance Availability", + "green": 90, + "yellow": 75, + "red": 50 + }} +Type : microsoft.workloads/monitors/saplandscapemonitor +``` + +Update the SAP landscape monitor for an AMS instance + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupingLandscape +Gets or sets the list of landscape to SID mappings. +To construct, see NOTES section for GROUPINGLANDSCAPE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapLandscapeMonitorSidMapping[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupingSapApplication +Gets or sets the list of Sap Applications to SID mappings. +To construct, see NOTES section for GROUPINGSAPAPPLICATION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapLandscapeMonitorSidMapping[] +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.Workloads.Models.IWorkloadsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Name of the SAP monitor resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopMetricsThreshold +Gets or sets the list Top Metric Thresholds for SAP Landscape Monitor Dashboard +To construct, see NOTES section for TOPMETRICSTHRESHOLD properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapLandscapeMonitorMetricThresholds[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapLandscapeMonitor + +## 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. + + +`GROUPINGLANDSCAPE <ISapLandscapeMonitorSidMapping[]>`: Gets or sets the list of landscape to SID mappings. + - `[Name <String>]`: Gets or sets the name of the grouping. + - `[TopSid <String[]>]`: Gets or sets the list of SID's. + +`GROUPINGSAPAPPLICATION <ISapLandscapeMonitorSidMapping[]>`: Gets or sets the list of Sap Applications to SID mappings. + - `[Name <String>]`: Gets or sets the name of the grouping. + - `[TopSid <String[]>]`: Gets or sets the list of SID's. + +`INPUTOBJECT <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +`TOPMETRICSTHRESHOLD <ISapLandscapeMonitorMetricThresholds[]>`: Gets or sets the list Top Metric Thresholds for SAP Landscape Monitor Dashboard + - `[Green <Single?>]`: Gets or sets the threshold value for Green. + - `[Name <String>]`: Gets or sets the name of the threshold. + - `[Red <Single?>]`: Gets or sets the threshold value for Red. + - `[Yellow <Single?>]`: Gets or sets the threshold value for Yellow. + +## RELATED LINKS + diff --git a/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapVirtualInstance.md b/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapVirtualInstance.md new file mode 100644 index 0000000000..aa1aa83c48 --- /dev/null +++ b/azps-10.1.0/Az.Workloads/Update-AzWorkloadsSapVirtualInstance.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Workloads +online version: https://learn.microsoft.com/powershell/module/az.workloads/update-azworkloadssapvirtualinstance +schema: 2.0.0 +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Update-AzWorkloadsSapVirtualInstance.md +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/Workloads/help/Update-AzWorkloadsSapVirtualInstance.md +--- + +# Update-AzWorkloadsSapVirtualInstance + +## SYNOPSIS +Updates a Virtual Instance for SAP solutions resource + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzWorkloadsSapVirtualInstance -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] + [-IdentityType <ManagedServiceIdentityType>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzWorkloadsSapVirtualInstance -InputObject <IWorkloadsIdentity> + [-IdentityType <ManagedServiceIdentityType>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] + [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>] +``` + +## DESCRIPTION +Updates a Virtual Instance for SAP solutions resource + +## EXAMPLES + +### Example 1: Add tags for an existing VIS resource +```powershell +Update-AzWorkloadsSapVirtualInstance -Name DB0 -ResourceGroupName db0-vis-rg -Tag @{ Test = "PS"; k2 = "v2"} +``` + +```output +Name ResourceGroupName Health Environment ProvisioningState SapProduct State Status Location +---- ----------------- ------ ----------- ----------------- ---------- ----- ------ -------- +DB0 db0-vis-rg Healthy NonProd Succeeded S4HANA RegistrationComplete Running centraluseuap +``` + +This cmdlet adds new tag name, value pairs to the existing VIS resource DB0. +VIS name and Resource group name are the other input parameters. + +### Example 2: Add tags for an existing VIS resource +```powershell +Update-AzWorkloadsSapVirtualInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/db0-vis-rg/providers/Microsoft.Workloads/sapVirtualInstances/DB0 -Tag @{ Test = "PS"; k2 = "v2"} +``` + +```output +Name ResourceGroupName Health Environment ProvisioningState SapProduct State Status Location +---- ----------------- ------ ----------- ----------------- ---------- ----- ------ -------- +DB0 db0-vis-rg Healthy NonProd Succeeded S4HANA RegistrationComplete Running centraluseuap +``` + +This cmdlet adds new tag name, value pairs to the existing VIS resource DB0. +Here VIS Azure resource ID is used as the input parameter. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of manage identity + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Workloads.Support.ManagedServiceIdentityType +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.Workloads.Models.IWorkloadsIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Virtual Instances for SAP solutions resource + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: SapVirtualInstanceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets the Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +User assigned identities dictionary + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.IWorkloadsIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Workloads.Models.Api20230401.ISapVirtualInstance + +## 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 <IWorkloadsIdentity>`: Identity Parameter + - `[ApplicationInstanceName <String>]`: The name of SAP Application Server instance resource. + - `[CentralInstanceName <String>]`: Central Services Instance resource name string modeled as parameter for auto generation to work correctly. + - `[DatabaseInstanceName <String>]`: Database resource name string modeled as parameter for auto generation to work correctly. + - `[Id <String>]`: Resource identity path + - `[Location <String>]`: The name of Azure region. + - `[MonitorName <String>]`: Name of the SAP monitor resource. + - `[ProviderInstanceName <String>]`: Name of the provider instance. + - `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive. + - `[SapVirtualInstanceName <String>]`: The name of the Virtual Instances for SAP solutions resource + - `[SubscriptionId <String>]`: The ID of the target subscription. + +## RELATED LINKS + diff --git a/docfx.json b/docfx.json index 6823cb2b9c..51c059a1de 100644 --- a/docfx.json +++ b/docfx.json @@ -1,6 +1,9 @@ { "build": { "content": [ + { "files": ["toc.yml"], "src": "azps-10.1.0", "version": "azps-10.1.0", "dest": "module/azure-powershell" }, + { "files": ["**/*.yml"], "src": "azps-10.1.0", "version": "azps-10.1.0", "exclude": ["docs-conceptual/**"], "dest": "module" }, + { "files": ["**/*.yml", "**/*.md"], "src": "docs-conceptual/azps-10.1.0", "version": "azps-10.1.0", "dest": "azure" }, { "files": ["toc.yml"], "src": "azps-10.0.0", "version": "azps-10.0.0", "dest": "module/azure-powershell" }, { "files": ["**/*.yml"], "src": "azps-10.0.0", "version": "azps-10.0.0", "exclude": ["docs-conceptual/**"], "dest": "module" }, @@ -84,12 +87,14 @@ { "files": ["**/*.md"], "src": "azureelasticdbjobsps-0.8.33", "version": "azureelasticdbjobsps-0.8.33" } ], "resource": [ + { "files": ["media/**"], "version": "azps-10.1.0" }, { "files": ["media/**"], "version": "azps-10.0.0" }, { "files": ["media/**"], "version": "azps-9.7.1" }, { "files": ["media/**"], "version": "azps-0.10.0" }, { "files": ["media/**"], "version": "azurermps-6.13.0" } ], "versions": { + "azps-10.1.0": { "dest": "azps-10.1.0" }, "azps-10.0.0": { "dest": "azps-10.0.0" }, "azps-9.7.1": { "dest": "azps-9.7.1" }, "azps-0.10.0": { "dest": "azps-0.10.0" }, @@ -527,6 +532,7 @@ "docs-conceptual/**/*.md": "conceptual" }, "ms.date": { + "azps-10.1.0/**/*.yml": "05/23/2023", "azps-10.0.0/**/*.yml": "05/23/2023", "azps-9.7.1/**/*.yml": "04/28/2023", "azps-0.10.0/**/*.yml": "4/14/2020", @@ -563,6 +569,7 @@ "docs-conceptual/azuredmps-*/**/*": "NOINDEX, NOFOLLOW" }, "feedback_system": { + "azps-10.1.0/**/*": "GitHub", "azps-10.0.0/**/*": "GitHub", "azps-9.7.1/**/*": "None", "azps-0.10.0/**/*": "None", diff --git a/docs-conceptual/azps-10.1.0/authenticate-azureps.md b/docs-conceptual/azps-10.1.0/authenticate-azureps.md new file mode 100644 index 0000000000..62477773de --- /dev/null +++ b/docs-conceptual/azps-10.1.0/authenticate-azureps.md @@ -0,0 +1,213 @@ +--- +description: How to sign in with Azure PowerShell as a user, service principal, or with managed identities for Azure resources. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Sign in with Azure PowerShell +--- + +# Sign in with Azure PowerShell + +Azure PowerShell supports several authentication methods. The easiest way to get started is with +[Azure Cloud Shell](/azure/cloud-shell/overview), which automatically logs you in. With a local +install, you can sign in interactively through your browser. When writing scripts for automation, +the recommended approach is to use a [service principal](create-azure-service-principal-azureps.md) +with the necessary permissions. When you restrict sign-in permissions as much as possible for your +use case, you help keep your Azure resources secure. + +Initially, you're signed into the first subscription Azure returns if you have access to more than +one subscription. Commands are run against this subscription by default. To change your active +subscription for a session, use the [Set-AzContext](/powershell/module/az.accounts/set-azcontext) +cmdlet. To change your active subscription and have it persist between sessions on the same system, +use the [Select-AzContext](/powershell/module/az.accounts/select-azcontext) cmdlet. + +> [!IMPORTANT] +> Your credentials are shared among multiple PowerShell sessions as long as you remain signed in. +> For more information, see [Azure PowerShell context objects](context-persistence.md). + +## Sign in interactively + +To sign in interactively, use the +[Connect-AzAccount](/powershell/module/az.accounts/connect-azaccount) cmdlet. + +```azurepowershell +Connect-AzAccount +``` + +This cmdlet presents an interactive browser based login prompt by default. + +Use the [Get-AzContext](/powershell/module/az.accounts/get-azcontext) cmdlet to store your tenant ID +in a variable to be used in the next two sections of this article. + +```azurepowershell-interactive +$tenantId = (Get-AzContext).Tenant.Id +``` + +## Device code authentication + +You can specify the `UseDeviceAuthentication` parameter to use device code authentication instead of +a browser control. + +```azurepowershell-interactive +Connect-AzAccount -UseDeviceAuthentication +``` + +## Sign in with a service principal + +Service principals are non-interactive Azure accounts. Like other user accounts, their permissions +are managed with Azure Active Directory. By granting a service principal only the permissions it +needs, your automation scripts stay secure. + +To learn how to create a service principal for use with Azure PowerShell, see +[Create an Azure service principal with Azure PowerShell](create-azure-service-principal-azureps.md). + +To sign in with a service principal, use the `ServicePrincipal` parameter of the `Connect-AzAccount` +cmdlet. You'll also need the service principal's application ID, sign-in credentials, and the tenant +ID associate with the service principal. How you sign in with a service principal depends on whether +it's configured for password-based or certificate-based authentication. + +### Password-based authentication + +Create a service principal to be used in the examples in this section. For more information on +creating service principals, see +[Create an Azure service principal with Azure PowerShell](/powershell/azure/create-azure-service-principal-azureps). + +```azurepowershell-interactive +$sp = New-AzADServicePrincipal -DisplayName ServicePrincipalName +``` + +> [!WARNING] +> The provided service principal secret is stored in the `AzureRmContext.json` file in your user +> profile (`$env:USERPROFILE\.Azure`). Ensure this directory has appropriate protections. + +To get the service principal's credentials as the appropriate object, use the +[Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) cmdlet. This +cmdlet presents a prompt for a username and password. Use the service principal's `applicationID` +for the username and convert its `secret` to plain text for the password. + +```azurepowershell-interactive +# Retrieve the plain text password for use with `Get-Credential` in the next command. +$sp.PasswordCredentials.SecretText + +$pscredential = Get-Credential -UserName $sp.AppId +Connect-AzAccount -ServicePrincipal -Credential $pscredential -Tenant $tenantId +``` + +For automation scenarios, you need to create credentials from a service principal's `AppId` and +`SecretText`: + +```azurepowershell-interactive +$SecureStringPwd = $sp.PasswordCredentials.SecretText | ConvertTo-SecureString -AsPlainText -Force +$pscredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $sp.AppId, $SecureStringPwd +Connect-AzAccount -ServicePrincipal -Credential $pscredential -Tenant $tenantId +``` + +Make sure that you use good password storage practices when automating service principal connections. + +### Certificate-based authentication + +Certificate-based authentication requires that Azure PowerShell can retrieve information from a +local certificate store based on a certificate thumbprint. + +```azurepowershell-interactive +Connect-AzAccount -ApplicationId $appId -Tenant $tenantId -CertificateThumbprint <thumbprint> +``` + +When using a service principal instead of a registered application, specify the **ServicePrincipal** +parameter and provide the service principal's Application ID as the value for the **ApplicationId** +parameter. + +```azurepowershell-interactive +Connect-AzAccount -ServicePrincipal -ApplicationId $servicePrincipalId -Tenant $tenantId -CertificateThumbprint <thumbprint> +``` + +In Windows PowerShell 5.1, the certificate store can be managed and inspected with the +[PKI](/powershell/module/pki) module. For PowerShell 7.x and later, the process is more complicated. +The following scripts show you how to import an existing certificate into the certificate store +accessible by PowerShell. + +#### Import a certificate in Windows PowerShell 5.1 + +```powershell-interactive +# Import a PFX +$credentials = Get-Credential -Message 'Provide PFX private key password' +Import-PfxCertificate -FilePath <path to certificate> -Password $credentials.Password -CertStoreLocation cert:\CurrentUser\My +``` + +#### Import a certificate in PowerShell 7.x and later + +```powershell-interactive +# Import a PFX +$storeName = [System.Security.Cryptography.X509Certificates.StoreName]::My +$storeLocation = [System.Security.Cryptography.X509Certificates.StoreLocation]::CurrentUser +$store = [System.Security.Cryptography.X509Certificates.X509Store]::new($storeName, $storeLocation) +$certPath = <path to certificate> +$credentials = Get-Credential -Message "Provide PFX private key password" +$flag = [System.Security.Cryptography.X509Certificates.X509KeyStorageFlags]::Exportable +$certificate = [System.Security.Cryptography.X509Certificates.X509Certificate2]::new($certPath, $credentials.Password, $flag) +$store.Open([System.Security.Cryptography.X509Certificates.OpenFlags]::ReadWrite) +$store.Add($Certificate) +$store.Close() +``` + +## Sign in using a managed identity + +Managed identities are a feature of Azure Active Directory. Managed identities are service +principals assigned to resources that run in Azure. You can use a managed identity service principal +for sign-in, and an app-only access token to access other resources. Managed identities are only +available on resources running in an Azure cloud. + +This example connects using the managed identity of the host environment. For example, if executed +on a VirtualMachine with an assigned Managed Service Identity, this allows the code to sign in using +that assigned identity. + +```azurepowershell-interactive + Connect-AzAccount -Identity +``` + +The following example connects using the Managed Service Identity of `myUserAssignedIdentity`. It +adds the user assigned identity to the virtual machine, then connects using the `ClientId` of the +user assigned identity. For more information, see +[Configure managed identities for Azure resources on an Azure VM](/azure/active-directory/managed-identities-azure-resources/qs-configure-powershell-windows-vm). + +```azurepowershell-interactive +$identity = Get-AzUserAssignedIdentity -ResourceGroupName 'myResourceGroup' -Name 'myUserAssignedIdentity' +Get-AzVM -ResourceGroupName contoso -Name testvm | Update-AzVM -IdentityType UserAssigned -IdentityId $identity.Id +Connect-AzAccount -Identity -AccountId $identity.ClientId # Run on the virtual machine + +Account SubscriptionName TenantId Environment +------- ---------------- -------- ----------- +yyyy-yyyy-yyyy-yyyy Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud +``` + +## Sign in with a non-default tenant or as a Cloud Solution Provider (CSP) + +If your account is associated with more than one tenant, sign-in requires the **Tenant** parameter +to be specified when connecting. This parameter works with any sign-in method. When logging in, this +parameter value can either be the Azure object ID of the tenant (Tenant ID) or the fully qualified +domain name of the tenant. + +If you're a [Cloud Solution Provider (CSP)](https://azure.microsoft.com/offers/ms-azr-0145p/), the +value for the **Tenant** parameter must be a tenant ID. + +```azurepowershell-interactive +Connect-AzAccount -Tenant '00000000-0000-0000-0000-000000000000' +``` + +## Sign in to another Cloud + +Azure cloud services offer environments compliant with regional data-handling laws. For accounts in +a regional cloud, set the environment when you sign in with the **Environment** parameter. This +parameter works with any sign-in method. For example, if your account is in Azure China 21Vianet: + +```azurepowershell-interactive +Connect-AzAccount -Environment AzureChinaCloud +``` + +The following command returns a list of available environments: + +```azurepowershell-interactive +Get-AzEnvironment | Select-Object -Property Name +``` diff --git a/docs-conceptual/azps-10.1.0/az-powershell-proxy.md b/docs-conceptual/azps-10.1.0/az-powershell-proxy.md new file mode 100644 index 0000000000..0506b4c93d --- /dev/null +++ b/docs-conceptual/azps-10.1.0/az-powershell-proxy.md @@ -0,0 +1,30 @@ +--- +description: How to use the Azure Az PowerShell module behind a proxy server +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Use the Az PowerShell module behind a proxy +--- + +# Use the Az PowerShell module behind a proxy + +If a proxy is necessary for HTTP request, the Azure PowerShell team recommends the following proxy +configuration for different platforms: + +| **Platform** | **Recommended Proxy Settings** | **Comment** | +| ----------------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| Windows PowerShell 5.1 | System proxy settings | Use the system proxy settings (internet options). | +| PowerShell 7 on Windows | System proxy settings | Proxy could be configured by setting both HTTP_PROXY and HTTPS_PROXY environment variables. | +| PowerShell 7 on macOS | System proxy settings | Proxy could be configured by setting both HTTP_PROXY and HTTPS_PROXY environment variables. | +| PowerShell 7 on Linux | Set both HTTP_PROXY and HTTPS_PROXY environment variables, plus optional NO_PROXY | The environment variables should be set before starting PowerShell, otherwise they may not be respected. | + +The environment variables used are: + +- HTTP_PROXY: the proxy server used on HTTP requests. +- HTTPS_PROXY: the proxy server used on HTTPS requests. +- NO_PROXY: a comma-separated list of hostnames that should be excluded from proxying. + +On systems where environment variables are case-sensitive, the variable names may be all lowercase +or all uppercase. The lowercase names are checked first. diff --git a/docs-conceptual/azps-10.1.0/az-predictor.md b/docs-conceptual/azps-10.1.0/az-predictor.md new file mode 100644 index 0000000000..c72cc5b41c --- /dev/null +++ b/docs-conceptual/azps-10.1.0/az-predictor.md @@ -0,0 +1,118 @@ +--- +description: Using Az Predictor for intelligent context-aware command completion in Azure PowerShell. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Intelligent context-aware command completion with Az Predictor +--- + +# Intelligent context-aware command completion with Az Predictor + +## Overview + +[Az Predictor](https://www.powershellgallery.com/packages/Az.Tools.Predictor/) is a PowerShell +module that helps you navigate the cmdlets and parameters of the +[Az PowerShell module](https://www.powershellgallery.com/packages/Az). It provides intelligent +context-aware suggestions for command completion when using Azure PowerShell. + +Az Predictor uses the +[subsystem plugin model](/powershell/scripting/learn/experimental-features#pssubsystempluginmodel) +available in PowerShell 7.2. This updated version requires +[PSReadLine 2.2.2](https://www.powershellgallery.com/packages/PSReadLine/2.2.2) or higher to display +suggestions. + +## Requirements + +Required configuration for Az Predictor: + +- [PowerShell 7.2](https://github.com/PowerShell/PowerShell/) or higher +- [PSReadline 2.2.2](https://github.com/PowerShell/PSReadLine/) or higher + +Install the latest version of PSReadLine: + +```powershell +Install-Module -Name PSReadline +``` + +## Getting started + +### Install Az Predictor + +Install the Az.Tools.Predictor PowerShell module + +```powershell +Install-Module -Name Az.Tools.Predictor +``` + +### Enable Az Predictor + +1. Enable Az Predictor for the current and future PowerShell sessions. + + ```powershell + Enable-AzPredictor -AllSession + ``` + +1. Set your preferred view for suggestions. + + Enable list view: + + ```powershell + Set-PSReadLineOption -PredictionViewStyle ListView + ``` + + Enable inline view: + + ```powershell + Set-PSReadLineOption -PredictionViewStyle InlineView + ``` + +> [!NOTE] +> You can switch between view modes with the <kbd>F2</kbd> key. + +## Uninstallation + +Once installed and enabled, Az Predictor is loaded in the PowerShell profile. +To uninstall the Az.Tools.Predictor module: + +1. Close **all** PowerShell sessions including VS Code. + +1. Launch a PowerShell session with no profile. + + ```powershell + pwsh -noprofile + ``` + +1. Uninstall Az Predictor + + ```powershell + Uninstall-Module -Name Az.Tools.Predictor -Force + ``` + +1. Close PowerShell + +## Privacy and data collection + +### Privacy + +Az predictor uses the previous two Az cmdlets to make suggestions and ignores any cmdlet that's not +part of the [Az PowerShell](https://www.powershellgallery.com/packages/Az) module. Only the names of +cmdlets and parameters are sent to our API to obtain the suggestion. Parameter values are discarded. +The resource group name and location used are kept locally and reused with subsequent cmdlets for +convenience but are never sent to the API. In the preview version, the module generates and sends +anonymized information about the current session used for predictions to the API. This information +is used to assess the quality of suggestions. + +### Data collection + +The current version of Az Predictor collects anonymized information about its usage to identify +common issues and improve the experience of future releases. Az Predictor doesn't collect any +private or personal data. + +For example, the usage data helps identify inaccurate suggestions and issues like interferences with +PSReadLine. While we appreciate the insights this data provides, we understand not everyone wants to +send usage data. You can disable data collection with the +[Disable-AzDataCollection](/powershell/module/az.accounts/disable-azdatacollection) +cmdlet. You can also read our +[privacy statement](https://go.microsoft.com/fwlink/?LinkID=528096&clcid=0x409) to learn more. diff --git a/docs-conceptual/azps-10.1.0/azps-msgraph-migration-changes.md b/docs-conceptual/azps-10.1.0/azps-msgraph-migration-changes.md new file mode 100644 index 0000000000..151dda8e1c --- /dev/null +++ b/docs-conceptual/azps-10.1.0/azps-msgraph-migration-changes.md @@ -0,0 +1,290 @@ +--- +description: This migration guide contains a list of Azure PowerShell changes for the Azure AD to Microsoft Graph migration in Az.Resources 5.1.0. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Azure AD to Microsoft Graph migration changes in Azure PowerShell +--- + +# Azure AD to Microsoft Graph migration changes in Azure PowerShell + +The `Az.Resources` PowerShell module version 5.1.0 of Azure PowerShell introduces changes to +the identity-related cmdlets. The cmdlets that rely on Azure AD Graph are transitioning to Microsoft +Graph. This change is occurring to ensure a smooth transition in light of the +[announcement of the retirement of Azure AD Graph](https://azure.microsoft.com/updates/update-your-apps-to-use-microsoft-graph-before-30-june-2022/). +For more information, see +[Azure AD to Microsoft Graph migration for Azure command line tools](https://techcommunity.microsoft.com/t5/azure-tools/azure-ad-to-microsoft-graph-migration-for-azure-command-line/ba-p/2836666). + +The following example installs the latest version of the `Az.Resources` Azure PowerShell module. + +```powershell +Install-Module -Name Az.Resources -Repository PSGallery -Scope CurrentUser +``` + +See the following information for a list of changes. + +## Application + +### Get-AzAdApplication + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory.PSADApplication` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication` + +- Parameter `IncludeTotalCount` is not supported and has been removed + +### New-AzAdApplication + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory.PSADApplication` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication` + +- Parameter `Password` has been removed, customized password is not supported anymore, server + assigns secret text when creation + +### Remove-AzAdApplication + +- Input type of parameter `InputObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADApplication` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication` + +### Update-AzAdApplication + +- Input type of parameter `InputObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADApplication` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication` + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory.PSADApplication` to + `System.Boolean` + +### Changes to Application Object + +- `ObjectId` has been replaced by `Id` + +- `HomePage` has been replaced by `HomepageUrl` in the `Web` element + +- `ApplicationId` has been replaced by `AppId` + +- `AvailableToOtherTenants` (boolean) has been replaced by `SignInAudience` (string with 4 values: + 'AzureADMyOrg', 'AzureADMultipleOrgs', 'AzureADandPersonalMicrosoftAccount', + 'PersonalMicrosoftAccount') + + - AzureADMultipleOrgs is equivalent to AvailableToOtherTenants:$true + + - AzureAdMyOrg is equivalent to AvailableToOtherTenants:$false or $null + +- `ApiPermissions` has been replaced by `RequiredResourceAccess` + +- `ReplyUrls` has been replaced by `RedirectUris ` in the `Web` element + +- `ObjectType` has been replaced by `OdataType` + +## Application Credential + +### Get-AzAdAppCredential + +- Input type of parameter `ApplicationObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADApplication` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication` + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory. PSADCredential` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphKeyCredential` + and `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordCredential` + +### New-AzAdAppCredential + +- Input type of parameter `ApplicationObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADApplication` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication` + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory. PSADCredential` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphKeyCredential` + and `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordCredential` + +- Parameter `Password` has been removed, customized password is not supported anymore, server will + assign secret text when creation + +### Remove-AzAdAppCredential + +- Input type of parameter `ApplicationObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADApplication` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication` + +### Changes to App Credential Object + +#### Password Credential +- `Password` has been replaced by `SecretText` + +#### Key Credential +- `CertValue` has been Removed + +## ServicePrincipal + +### Get-AzAdServicePrincipal + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal` + to `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal` + +- Parameter `IncludeTotalCount` is not supported and has been removed. + +### New-AzAdServicePrincipal + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal` + to `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal` + +- Parameter set `ApplicationWithoutCredentialParameterSet`, + `ApplicationWithPasswordPlainParameterSet`, `DisplayNameWithoutCredentialParameterSet`, + `DisplayNameWithPasswordPlainParameterSet` have been removed because those original parameter sets + were not functioning. + +- Role `contributor` is not assigned as default when parameter `-Role` is not provided due to + security consideration. + +- Parameter `SkipAssignment` has been removed. + +### Remove-AzAdServicePrincipal + +- Input type of parameter `ApplicationObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADApplication` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphApplication` + +- Input type of parameter `InputObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal` + +### Update-AzAdServicePrincipal + +- Input type of parameter `InputObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal` + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal` + to `System.Boolean` + +### Changes to Service Principal Object + +- `ApplicationId` has been replaced by `AppId` + +- `ObjectType` has been replaced by `OdataType` + +## ServicePrincipal Credential + +### Get-AzAdSpCredential + +- Input type of parameter `ServicePrincipalObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal` + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory. PSADCredential` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphKeyCredential` + and `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordCredential` + +### New-AzAdSpCredential + +- Input type of parameter `ServicePrincipalObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal` + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory. PSADCredential` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphKeyCredential` + and `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphPasswordCredential` + +### Remove-AzAdSpCredential + +- Input type of parameter `ServicePrincipalObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADServicePrincipal` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphServicePrincipal` + +### Changes to ServicePrincipal Credential Object + +#### Password Credential +- `Password` has been replaced by `SecretText` + +#### Key Credential +- `CertValue` has been Removed + +## User + +### Get-AzAdUser + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory.PSADUser` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphUser` + +- Parameter `IncludeTotalCount` is not supported and has been removed + +### New-AzAdUser + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory.PSADUser` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphUser` + +### Remove-AzAdUser + +- Input type of parameter `InputObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADUser` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphUser` + +### Update-AzAdUser + +- Input type of parameter `InputObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADUser` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphUser` + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory.PSADUser` to + `System.Boolean` + +### Changes to User Object + +- `ObjectType` has been replaced by `OdataType` + +- `ImmutableId` has been replaced by `OnpremisesImmutableId` + +## Group + +### Get-AzAdGroup + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory.PSADGroup` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup` + +- Parameter `IncludeTotalCount` is not supported and has been removed + +### New-AzAdGroup + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory.PSADGroup` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup` + +### Remove-AzAdGroup + +- Input type of parameter `InputObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADGroup` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup` + +### Changes of Group Object + +- `ObjectType` has been replaced by `OdataType` + +## Group member + +### Get-AzAdGroupMember + +- Output type has been changed from `Microsoft.Azure.Commands.ActiveDirectory.PSADObject` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphDirectoryObject` + +- Parameter `IncludeTotalCount` was removed + +- Input type of parameter `GroupObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADGroup` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup` + +[!INCLUDE [get-azadgroupmember-no-serviceprincipal-banner](../../includes/get-azadgroupmember-no-serviceprincipal-banner.md)] + +### Add-AzAdGroupMember + +- Input type of parameter `GroupObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADGroup` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup` + +### Remove-AzAdGroupMember + +- Input type of parameter `GroupObject` has been changed from + `Microsoft.Azure.Commands.ActiveDirectory.PSADGroup` to + `Microsoft.Azure.PowerShell.Cmdlets.Resources.MSGraph.Models.ApiV10.IMicrosoftGraphGroup` diff --git a/docs-conceptual/azps-10.1.0/azps-versioning-release-cadence.md b/docs-conceptual/azps-10.1.0/azps-versioning-release-cadence.md new file mode 100644 index 0000000000..23177a8654 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/azps-versioning-release-cadence.md @@ -0,0 +1,111 @@ +--- +description: This article contains Azure PowerShell versioning, release cadence, and breaking change information for the Az PowerShell module. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Azure PowerShell versioning, release cadence, and breaking changes +--- + +# Azure PowerShell versioning, release cadence, and breaking changes + +The Az PowerShell module is a rollup module containing more than 70 generally available (GA) or +stable service modules for managing Azure resources directly from PowerShell. + +## Versioning + +The Az PowerShell modules follow [Semantic Versioning](https://semver.org/) for version numbering. +Versions of Azure service modules fall into one of three categories: + +- Generally available. Modules version 1.0.0 and higher without _preview_ in the version. Adheres to + breaking change policy. +- Preview. Modules less than version 1.0.0. Don't adhere to breaking change policy. +- Feature preview. Modules version 1.0.0 and higher with _preview_ in the version. Don't adhere to + breaking change policy. + +There are two Az PowerShell rollup modules: + +- [Az](https://www.powershellgallery.com/packages/Az/). Installs all GA service modules for managing + Azure resources. +- [AzPreview](https://www.powershellgallery.com/packages/AzPreview/). Installs all GA and preview + modules for managing Azure resources. Doesn't include feature preview modules. + +The AzPreview module is always the same version and is released at the same time as the Az module. + +## Release cadence + +Planned updates to the Az PowerShell module are released on the first Tuesday of each month. These +12 planned updates per calendar year are in two categories: + +- Major versions. At most, two per calendar year introduce breaking changes. The first number in the + version number is updated. For example, version 6.6.0 to version 7.0.0. +- Minor versions. 10 per calendar year that don't introduce breaking changes. The second number in + the version number is updated. For example, version 7.0.0 to version 7.1.0. + +> [!WARNING] +> Before upgrading to a major breaking change version of the Az PowerShell module, you should +> [**review the migration guide**](https://aka.ms/azps-migration-latest). + +Unplanned patch versions may be released at any time to fix bugs. Patch versions don't introduce +breaking changes. The third number in the version number is updated. For example, version 6.2.0 to +version 6.2.1. + +## Breaking changes + +> [!IMPORTANT] +> Breaking changes may occur at any point for non-GA preview and feature preview modules. Non-GA +> modules aren't required to adhere to breaking change policies. + +### When do breaking changes occur + +We release two breaking change versions per year: + +- One in late spring +- One in the fall + +For information about upcoming breaking change releases, see [Azure PowerShell milestones](https://github.com/Azure/azure-powershell/milestones). + +### Types of breaking changes + +Various types of breaking changes can occur in cmdlets. For more information, see +[Breaking Change Definition](https://github.com/Azure/azure-powershell/blob/preview/documentation/breaking-changes/breaking-changes-definition.md). + +### List of breaking changes + +For detailed information about breaking changes in major releases of the Az PowerShell module, see +the following articles. + +- [AZ 10.0.0 breaking changes](migrate-az-10.0.0.md) +- [AZ 9.0.1 breaking changes](migrate-az-9.0.1.md) +- [Az 8.0.0 breaking changes](migrate-az-8.0.0.md) +- [Az 7.0.0 breaking changes](migrate-az-7.0.0.md) +- [Az 6.0.0 breaking changes](migrate-az-6.0.0.md) +- [Az 5.0.0 breaking changes](migrate-az-5.0.0.md) +- [Az 4.1.0 breaking changes](migrate-az-4.1.0.md) +- [Az 3.0.0 breaking changes](migrate-az-3.0.0.md) +- [Az 2.0.0 breaking changes](migrate-az-2.0.0.md) + +### Breaking change warning messages + +Breaking change warning messages allow Azure PowerShell cmdlet author's to communicate upcoming +breaking changes with end users. + +### Suppress breaking change warning messages + +To suppress breaking change warning messages, see +[How do I disable breaking change warning messages in Azure PowerShell?](/powershell/azure/faq#how-do-i-disable-breaking-change-warning-messages-in-azure-powershell-). + +For more information, see +[Breaking Changes Attribute Help](https://github.com/Azure/azure-powershell/blob/preview/documentation/breaking-changes/breaking-changes-attribute-help.md#supress-the-breaking-change-messages-at-runtime). + +## Provide feedback + +- For general feedback, use the [`Send-Feedback`](/powershell/module/azurerm.profile/send-feedback) cmdlet. +- For product issues, log an [issue in the azure-powershell GitHub repository](https://github.com/Azure/azure-powershell/issues). + +## Other resources + +- [Azure PowerShell modules](https://github.com/Azure/azure-powershell/blob/main/documentation/azure-powershell-modules.md). +- [Azure PowerShell Support Lifecycle](azureps-support-lifecycle.md) +- [Azure PowerShell releases demystified](https://techcommunity.microsoft.com/t5/azure-tools-blog/azure-powershell-releases-demystified/ba-p/1609863) diff --git a/docs-conceptual/azps-10.1.0/azureps-in-docker.md b/docs-conceptual/azps-10.1.0/azureps-in-docker.md new file mode 100644 index 0000000000..db7759e473 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/azureps-in-docker.md @@ -0,0 +1,95 @@ +--- +description: Learn how to run a Docker container hosting Azure PowerShell. Docker gets you started quickly with an isolated environment in which to run Azure PowerShell. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: How to run Azure PowerShell in a Docker container +--- + +# Using Azure PowerShell in a Docker container + +We publish Docker images with Azure PowerShell preinstalled. You can use Docker to run a standalone +Linux container with Azure PowerShell preinstalled. This article shows you how to use Azure +PowerShell in the Docker container. + +## Finding available images + +The released images require Docker 17.05 or newer. You must be able to run Docker without `sudo` or +local administrative rights. Follow Docker's official [instructions][install] to install Docker. + +The release containers derive from the official distribution image, install dependencies, and +install the Azure PowerShell module. + +The latest container image contains the latest version of PowerShell and the latest Azure PowerShell +modules supported with the Az PowerShell module. + +You can find a complete list of Azure PowerShell Docker images on our [Docker image][az image] page. + +## Using Azure PowerShell in a container + +The following steps show the Docker commands required to download the image and start an interactive +PowerShell session. + +# [amd64](#tab/amd64) + +1. Download the latest azure-powershell image. + + ```console + docker pull mcr.microsoft.com/azure-powershell + ``` + +1. Run the azure-powershell container in interactive mode: + + ```console + docker run -it mcr.microsoft.com/azure-powershell pwsh + ``` + +# [arm64](#tab/arm64) + +1. Download the latest azure-powershell image. + + ```console + docker pull mcr.microsoft.com/azure-powershell:mariner-2-arm64 + ``` + +1. Run the azure-powershell container in interactive mode: + + ```console + docker run -it mcr.microsoft.com/azure-powershell:mariner-2-arm64 pwsh + ``` + +--- + +For Windows Docker hosts, you must enable Docker file sharing to allow local drives on Windows to be +shared with Linux containers. For more information, see +[Get started with Docker for Windows][file-sharing]. + +### Remove the image when no longer needed + +The following command deletes the Docker container when you no longer need it. + +# [amd64](#tab/amd64) + +```console +docker rmi mcr.microsoft.com/azure-powershell +``` + +# [arm64](#tab/arm64) + +```console +docker rmi mcr.microsoft.com/azure-powershell:mariner-2-arm64 +``` + +--- + +## Next steps + +To learn more about the Azure PowerShell modules and their features, see +[Get Started with Azure PowerShell](get-started-azureps.md). + +<!-- link references --> +[install]: https://docs.docker.com/engine/installation/ +[az image]: https://hub.docker.com/_/microsoft-azure-powershell +[file-sharing]: https://docs.docker.com/docker-for-windows/#file-sharing diff --git a/docs-conceptual/azps-10.1.0/azureps-support-lifecycle.md b/docs-conceptual/azps-10.1.0/azureps-support-lifecycle.md new file mode 100644 index 0000000000..afb9a6c529 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/azureps-support-lifecycle.md @@ -0,0 +1,76 @@ +--- +description: Details about the support lifecycle of the Azure PowerShell modules +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Azure PowerShell support lifecycle +--- + +# Azure PowerShell Support Lifecycle + +## Az PowerShell modules + +The _"Az PowerShell modules"_ consist of the module named _"Az"_ and the dependent modules signed by +_"Microsoft Corporation"_. The Az PowerShell modules are identifiable by their names, that start +with _"Az."_. For the current list of Az PowerShell modules, see +[Azure PowerShell Modules](https://github.com/Azure/azure-powershell/blob/master/documentation/azure-powershell-modules.md). + +The Az PowerShell modules support lifecycle falls under the +[Azure SDK lifecycle policy](https://support.microsoft.com/help/18486). We support the last two +minor versions of the current major version and last minor version of the previous major version of +the Az PowerShell module. + +## Supported environments + +The following table identifies the supported platforms for the Az, AzureRM, and Azure PowerShell +modules. + +- The ![Supported][1] icon indicates supported version combinations of Azure PowerShell and + PowerShell. +- The ![Out of Support][4] icon indicates version combinations of Azure PowerShell and PowerShell + that are no longer supported. +- The ![Not Supported][3] icon indicates unsupported version combinations of Azure PowerShell and + PowerShell. + +| Azure PowerShell | PowerShell <br/> <= 7.1 | PowerShell <br/> >= 7.2 | Windows PowerShell <br/> 5.1 | +| ------------------------------ | :---------------------: | :---------------------: | :--------------------------: | +| ![Supported][1] Az 10.x | ![Not Supported][3] | ![Supported][1] | ![Supported][1] | +| ![Supported][1] Az 9.x | ![Not Supported][3] | ![Supported][1] | ![Supported][1] | +| ![Out of Support][4] <= Az 8.x | ![Out of Support][4] | ![Out of Support][4] | ![Out of Support][4] | +| ![Supported][1] AzureRM 6.13.2 | ![Not Supported][3] | ![Not Supported][3] | ![Supported][1] | +| ![Supported][1] Azure 5.3.1 | ![Not Supported][3] | ![Not Supported][3] | ![Supported][1] | + +> [!NOTE] +> PowerShell 6.2 reached its end of life as of September 4, 2020. The Az PowerShell modules are not +> supported on any version of PowerShell 6. + +### Information about CVE-2021-26701 + +The Az PowerShell modules use components affected by security advisory +[CVE-2021-26701](https://msrc.microsoft.com/update-guide/vulnerability/CVE-2021-26701) which has +been fixed in PowerShell 7.0.6 and 7.1.3. For more information, see +[Microsoft Security Advisory CVE-2021-26701: .NET Core Remote Code Execution Vulnerability](https://github.com/PowerShell/Announcements/issues/23). + +Starting with Az 6.0.0, PowerShell 7.0.6 or 7.1.3 or later is required. When the Az.Accounts module +is imported, the following non-blocking message is displayed if an unsupported version of PowerShell +is being used: _"This version of Az.Accounts is only supported on Windows PowerShell 5.1 and +PowerShell 7.0.6 or greater, open +[https://aka.ms/install-powershell](https://aka.ms/install-powershell) to learn how to upgrade. For +further information, go to [https://aka.ms/azpslifecyle](https://aka.ms/azpslifecycle)."_ + +## AzureRM PowerShell modules + +[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] + +To avoid service interruptions, [update your scripts](https://aka.ms/azpsmigrate) that use AzureRM +PowerShell modules to use Az PowerShell modules by February 29, 2024. To automatically update your +scripts, follow the +[quickstart guide](/powershell/azure/quickstart-migrate-azurerm-to-az-automatically). + +<!-- link references --> +[1]: ../../media/shared/check-mark-button_2705.svg +[2]: ../../media/shared/construction-sign_1f6a7.svg +[3]: ../../media/shared/cross-mark_274c.svg +[4]: ../../media/shared/large-yellow-circle_1f7e1.svg diff --git a/docs-conceptual/azps-10.1.0/azureps-vm-tutorial.yml b/docs-conceptual/azps-10.1.0/azureps-vm-tutorial.yml new file mode 100644 index 0000000000..c3f69001cd --- /dev/null +++ b/docs-conceptual/azps-10.1.0/azureps-vm-tutorial.yml @@ -0,0 +1,337 @@ +### YamlMime:Tutorial +title: Create virtual machines with the Azure PowerShell +metadata: + title: Create virtual machines with the Azure PowerShell + description: Get started with Azure PowerShell by creating virtual machines. + audience: Developer + level: Beginner + displayType: two-column + interactive: azurepowershell + ms.date: 06/30/2023 + ms.devlang: powershell + ms.custom: devx-track-azurepowershell + ms.service: azure-powershell + ms.topic: tutorial + clicktale: true +items: + - durationInMinutes: 1 + content: |- + In this tutorial, you learn all of the steps involved in setting up a virtual machine with + Azure PowerShell. The tutorial also covers output queries, Azure resource reuse, and + resource cleanup. + + This tutorial can be completed with the interactive experience offered through Azure Cloud + Shell, or you may [install Azure PowerShell](install-azure-powershell.md) locally. + + Use **ctrl-shift-v** (**cmd-shift-v** on macOS) to paste tutorial text into Azure Cloud + Shell. + + - durationInMinutes: 1 + title: Sign in + content: |- + If you're using a local install of the Azure PowerShell, you need to sign in before + performing any other steps. + + ```azurepowershell + Connect-AzAccount + ``` + + Complete the sign in process by following the steps displayed in your terminal. + + - durationInMinutes: 1 + title: Create a resource group + content: |- + In Azure, all resources are allocated in a resource management group. Resource groups + provide logical groupings of resources that make them easier to work with as a collection. + For this tutorial, all of the created resources go into a single group named + `TutorialResources`. + + ```azurepowershell-interactive + New-AzResourceGroup -Name TutorialResources -Location eastus + ``` + + ```Output + ResourceGroupName : TutorialResources + Location : eastus + ProvisioningState : Succeeded + Tags : + ResourceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TutorialResources + ``` + + - durationInMinutes: 1 + title: Create admin credentials for the VM + content: |- + Before you can create a new virtual machine, you must create a credential object containing + the username and password for the administrator account of the Windows VM. + + ```powershell-interactive + $cred = Get-Credential -Message "Enter a username and password for the virtual machine." + ``` + + Enter the username and password when prompted. The resulting credential object is passed as + a parameter in the next step. + + ```Output + Windows PowerShell credential request. + Enter a username and password for the virtual machine. + User: tutorAdmin + Password for user tutorAdmin: ********* + ``` + + - durationInMinutes: 4 + title: Create a virtual machine + content: |- + Virtual machines in Azure have a large number of dependencies. The Azure PowerShell creates + these resources for you based on the command-line arguments you specify. For readability, we + are using [PowerShell splatting](/powershell/module/microsoft.powershell.core/about/about_splatting) + to pass parameters to the Azure PowerShell cmdlets. + + Create a new virtual machine running Windows. + + ```azurepowershell-interactive + $vmParams = @{ + ResourceGroupName = 'TutorialResources' + Name = 'TutorialVM1' + Location = 'eastus' + ImageName = 'Win2016Datacenter' + PublicIpAddressName = 'tutorialPublicIp' + Credential = $cred + OpenPorts = 3389 + Size = 'Standard_D2s_v3' + } + $newVM1 = New-AzVM @vmParams + ``` + As the VM is created, you see the parameter values used and Azure resources being created. + PowerShell will display a progress bar as shown below. + + ```Output + Creating Azure resources + 39% \ + [ooooooooooooooooooooooooooooooooooo ] + + Creating TutorialVM1 virtual machine. + ``` + + Once the VM is ready, we can view the results in the Azure Portal or by inspecting the + `$newVM1` variable. + + ```azurepowershell-interactive + $newVM1 + ``` + + ```Output + ResourceGroupName : TutorialResources + Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TutorialResources/providers/Microsoft.Compute/virtualMachines/TutorialVM1 + VmId : 00000000-0000-0000-0000-000000000000 + Name : TutorialVM1 + Type : Microsoft.Compute/virtualMachines + Location : eastus + Tags : {} + HardwareProfile : {VmSize} + NetworkProfile : {NetworkInterfaces} + OSProfile : {ComputerName, AdminUsername, WindowsConfiguration, Secrets} + ProvisioningState : Succeeded + StorageProfile : {ImageReference, OsDisk, DataDisks} + ``` + + Property values listed inside of braces are nested objects. In the next step we will show you + how to view specific values in these nested objects. + + - durationInMinutes: 5 + title: Get VM information with queries + content: |- + Let's get some more detailed information from the VM we just created. In this example, we verify + the Name of the VM and the admin account we created. + + ```azurepowershell-interactive + $newVM1.OSProfile | Select-Object -Property ComputerName, AdminUserName + ``` + + ```Output + ComputerName AdminUsername + ------------ ------------- + TutorialVM1 tutorialAdmin + ``` + + We can use other Azure PowerShell commands to get specific information about the network + configuration. + + ```azurepowershell-interactive + $newVM1 | Get-AzNetworkInterface | + Select-Object -ExpandProperty IpConfigurations | + Select-Object -Property Name, PrivateIpAddress + ``` + + In this example we are using the PowerShell pipeline to send the \$newVM1 object to the + `Get-AzNetworkInterface` cmdlet. From the resulting network interface object we are + selecting the nested IpConfigurations object. From the IpConfigurations object we are + selecting the Name and PrivateIpAddress properties. + + ```Output + Name PrivateIpAddress + ---- ---------------- + TutorialVM1 192.168.1.4 + ``` + + To confirm that the VM is running, we need to connect via Remote Desktop. For that, we need + to know the Public IP address. + + ```azurepowershell-interactive + $publicIp = Get-AzPublicIpAddress -Name tutorialPublicIp -ResourceGroupName TutorialResources + + $publicIp | + Select-Object -Property Name, IpAddress, @{label='FQDN';expression={$_.DnsSettings.Fqdn}} + ``` + + In this example, we use the `Get-AzPublicIpAddress` and store the results in the `$publicIp` + variable. From this variable we are selecting properties and using an expression to retrieve + the nested Fqdn property. + + ```Output + Name IpAddress FQDN + ---- --------- ---- + tutorialPublicIp <PUBLIC_IP_ADDRESS> tutorialvm1-8a0999.eastus.cloudapp.azure.com + ``` + + From your local machine you can run the following command to connect to the VM over Remote + Desktop. + + ```powershell-interactive + mstsc.exe /v $publicIp.IpAddress + ``` + + For more information about querying for object properties, see + [Querying for Azure resources](./queries-azureps.md). + + - durationInMinutes: 4 + title: Creating a new VM on the existing subnet + content: |- + The second VM uses the existing subnet. + + ```azurepowershell-interactive + $vm2Params = @{ + ResourceGroupName = 'TutorialResources' + Name = 'TutorialVM2' + ImageName = 'Win2016Datacenter' + VirtualNetworkName = 'TutorialVM1' + SubnetName = 'TutorialVM1' + PublicIpAddressName = 'tutorialPublicIp2' + Credential = $cred + OpenPorts = 3389 + } + $newVM2 = New-AzVM @vm2Params + + $newVM2 + ``` + + ```Output + ResourceGroupName : TutorialResources + Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TutorialResources/providers/Microsoft.Compute/virtualMachines/TutorialVM2 + VmId : 00000000-0000-0000-0000-000000000000 + Name : TutorialVM2 + Type : Microsoft.Compute/virtualMachines + Location : eastus + Tags : {} + HardwareProfile : {VmSize} + NetworkProfile : {NetworkInterfaces} + OSProfile : {ComputerName, AdminUsername, WindowsConfiguration, Secrets} + ProvisioningState : Succeeded + StorageProfile : {ImageReference, OsDisk, DataDisks} + FullyQualifiedDomainName : tutorialvm2-dfa5af.eastus.cloudapp.azure.com + ``` + + You can skip a few steps to get the public IP address of the new VM since it's returned in + the FullyQualifiedDomainName property of the `$newVM2` object. Use the following command to + connect using Remote Desktop. + + ```powershell-interactive + mstsc.exe /v $newVM2.FullyQualifiedDomainName + ``` + + - durationInMinutes: 4 + title: Cleanup + content: |- + Now that the tutorial is complete, it's time to clean up the created resources. You can + delete individual resources with the `Remove-AzResource` command, but the safest way + to remove all resources in a resource group is delete the group using the + `Remove-AzResourceGroup` command. + + ```azurepowershell-interactive + $job = Remove-AzResourceGroup -Name TutorialResources -Force -AsJob + + $job + ``` + + ```Output + Id Name PSJobTypeName State HasMoreData Location Command + -- ---- ------------- ----- ----------- -------- ------- + 1 Long Running... AzureLongRun... Running True localhost Remove-AzResource... + ``` + + This command deletes the resources created during the tutorial, and is guaranteed to + deallocate them in the correct order. The `AsJob` parameter keeps PowerShell from blocking + while the deletion takes place. To wait until the deletion is complete, use the following + command: + + ```powershell-interactive + Wait-Job -Id $job.Id + ``` + + With cleanup completed, the tutorial is finished. Continue on for a summary of everything + you learned and links to resources that will help you with your next steps. + + - durationInMinutes: 1 + title: Summary + content: |- + + Congratulations! You learned how to create VMs with new or existing resources, used + expressions and other Azure PowerShell commands to capture data to be stored in shell + variables, and looked at some of the resources that get created for Azure VMs. + + Where you go from here depends on how you plan to use Azure PowerShell. There are a variety + of materials that go further in depth on the features covered in this tutorial. + + ### In-depth Azure PowerShell documentation + + You might want to take time to explore the complete + [Azure PowerShell documentation](/powershell/azure/) set. + + For more information about the commands used in this tutorial, see the following articles. + + - [New-AzResourceGroup](/powershell/module/Az.resources/new-Azresourcegroup) + - [Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) + - [New-AzVM](/powershell/module/Az.compute/new-Azvm) + - [Select-Object](/powershell/module/microsoft.powershell.utility/select-object) + - [Get-AzPublicIpAddress](/powershell/module/Az.network/get-AzPublicIpAddress) + - [Remove-AzResourceGroup](/powershell/module/Az.resources/Remove-AzResourceGroup) + - [Wait-Job](/powershell/module/microsoft.powershell.core/wait-job) + + There are also articles that go deeper into the features that were shown in the tutorial. + + - [PowerShell splatting](/powershell/module/microsoft.powershell.core/about/about_splatting) + - [Queries](queries-azureps.md) + - [Formatting](formatting-output.md) + - [Using PowerShell jobs](using-psjobs.md) + + ### Sample scripts + + If you want to get started right away with specific tasks, look at some sample scripts. + + - [Azure App Service](/azure/app-service-web/app-service-powershell-samples?toc=/powershell/azure/toc.json) + - [SQL Databases](/azure/sql-database/sql-database-powershell-samples?toc=/powershell/azure/toc.json) + - [Cosmos DB](/azure/cosmos-db/sql/powershell-samples?toc=/powershell/azure/toc.json) + - [Samples repo](https://github.com/Azure/azure-docs-powershell-samples) + + ### Feedback + + If you'd like to give feedback, suggestions, or ask questions, there are a number of ways + for you to get in touch. + + - `Send-Feedback` is a built-in command for Azure PowerShell that allows you to provide + free-form feedback to the team. + - File a feature request or a bug report in the + [Azure PowerShell repository](https://github.com/Azure/azure-powershell/issues). + - Ask a question or get clarification by filing an issue in the + [Azure PowerShell documentation repository](https://github.com/MicrosoftDocs/azure-docs-powershell/issues). + + We hope that you enjoy using Azure PowerShell! diff --git a/docs-conceptual/azps-10.1.0/command-line-tools-survey-guidance.md b/docs-conceptual/azps-10.1.0/command-line-tools-survey-guidance.md new file mode 100644 index 0000000000..f4101ec699 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/command-line-tools-survey-guidance.md @@ -0,0 +1,45 @@ +--- +description: This article contains guidance about the Azure command line tools survey. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Azure command line tools survey guidance +--- + +# Azure command line tools survey guidance + +When using Azure PowerShell, you may be invited to participate in a survey to tell us about your +experience. By responding to the survey, you help to identify common issues and areas for +improvement. Understanding your experiences and opinions helps to make future releases of Azure +command line tools better for you and others. + +## What data is collected + +The survey collects anonymized feedback about your satisfaction with Azure command line tools and +doesn't collect any private or personal data. + +While we appreciate the insights this data provides, we understand not everyone wants to be prompted +to complete a survey. You can disable being prompted to participate in surveys with the +`Update-AzConfig` cmdlet or via an environment variable. + +## Disable the survey + +In the following example, the `Update-AzConfig` cmdlet is used to disable the survey message. + +```azurepowershell-interactive +Update-AzConfig -DisplaySurveyMessage $false +``` + +You can also use the `$Env:AzSurveyMessage` environment variable to disable the survey message. + +```azurepowershell-interactive +Set-Item -Path Env:\AzSurveyMessage -Value $false +``` + +## Privacy statement + +Your privacy is important to us. +[Microsoft's Privacy Statement](https://privacy.microsoft.com/privacystatement) explains the +personal data Microsoft processes, how Microsoft processes it, and for what purposes. diff --git a/docs-conceptual/azps-10.1.0/configure-global-settings.md b/docs-conceptual/azps-10.1.0/configure-global-settings.md new file mode 100644 index 0000000000..03c999db76 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/configure-global-settings.md @@ -0,0 +1,121 @@ +--- +description: Configure Azure PowerShell global settings using centralized and granular AzConfig cmdlets +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Configure Azure PowerShell global settings +--- + +# Configure Azure PowerShell global settings + +Azure PowerShell supports several global settings like disabling breaking change warning messages. +Before Az PowerShell module version 9, there wasn't a centralized or granular way to configure +global settings for Azure PowerShell. + +## Centralized configuration + +The Az PowerShell module version 9 and higher includes cmdlets for managing the configuration of +global settings for Azure PowerShell. These `*-AzConfig` cmdlets are part of the Az.Accounts +PowerShell module: + +- [Get-AzConfig][get-azconfig] +- [Update-AzConfig][update-azconfig] +- [Export-AzConfig][export-azconfig] +- [Import-AzConfig][import-azconfig] +- [Clear-AzConfig][clear-azconfig] + +## Granular settings + +You can apply settings that are only effective in a particular scope. The valid values for the +**Scope** parameter are: + +- `Current User`. The default when applying a setting. +- `Process`. Setting is only applied to the current PowerShell session. +- `Default`. Readonly scope where the default value hasn't been changed. +- `Environment`. Readonly scope where the value has been configured via an environment variable. + +Besides scopes, you can apply the settings to all Az PowerShell modules or only a single module. +With the **AppliesTo** parameter, you can specify how broad you want the setting applied. The value +`Az` indicates the setting is applied to all modules available that are part of Azure PowerShell. + +To disable the breaking change warning message for cmdlets in the **Az.Compute** module, use the +`Update-AzConfig` cmdlet with the **DisplayBreakingChangeWarning** and **AppliesTo** parameters as +shown in the following example. + +```azurepowershell-interactive +Update-AzConfig -DisplayBreakingChangeWarning $false -AppliesTo Az.Compute +``` + +In this scenario, the breaking change warning message remains active for cmdlets in all Az +PowerShell modules except **Az.Compute**. + +## Default subscription + +By default, when you authenticate to Azure, all subscriptions that you can access are retrieved. The +first subscription that's returned by Azure is used unless you specify a subscription with +`Connect-AzAccount`. This behavior can be dangerous, for example if the first subscription returned +is a production environment. + +To configure your default subscription, you use the `Update-AzConfig` cmdlet with the +**DefaultSubscriptionForLogin** parameter as shown in the following example. + +```azurepowershell-interactive +Update-AzConfig -DefaultSubscriptionForLogin <Subscription ID or Name> +``` + +> [!NOTE] +> Not to be confused with **the subscription of the default context**, the +> **DefaultSubscriptionForLogin** configuration takes effect only when authenticating to Azure. + +## Azure region identification + +Azure customers can choose to deploy resources in many different regions. In some cases, customers +may be able to reduce costs by selecting nearby regions offering the same services. If a nearby +region is identified, a message will display the region to select for future deployments. + +### Disabling region recommendation message + +In the following example, the `Update-AzConfig` cmdlet is used to disable the region recommendation +message: + +```azurepowershell-interactive +Update-AzConfig -DisplayRegionIdentified $false +``` + +For more information about Azure regions, see +[choose the right Azure region for you](https://azure.microsoft.com/explore/global-infrastructure/geographies/#overview). + +## Replicating settings + +To replicate your settings from one environment to another, you use the `Export-AzConfig` cmdlet to +export the settings to a JSON file. + +```azurepowershell-interactive +Export-AzConfig -Path $HOME\AzConfig.json +``` + +To import your settings, use the `Import-AzConfig` cmdlet and reference the previously exported +JSON file. + +```azurepowershell-interactive +Import-AzConfig -Path $HOME\AzConfig.json +``` + +## Clearing configuration + +To reset the configuration setting of one or more Azure PowerShell global settings to the default, +use the `Clear-AzConfig` cmdlet. In the following example, the **DefaultSubscriptionForLogin** +setting is cleared. + +```azurepowershell-interactive +Clear-AzConfig -DefaultSubscriptionForLogin +``` + +<!-- link references --> +[get-azconfig]: /powershell/module/az.accounts/get-azconfig +[update-azconfig]:/powershell/module/az.accounts/update-azconfig +[export-azconfig]: /powershell/module/az.accounts/export-azconfig +[import-azconfig]: /powershell/module/az.accounts/import-azconfig +[clear-azconfig]: /powershell/module/az.accounts/clear-azconfig diff --git a/docs-conceptual/azps-10.1.0/context-persistence.md b/docs-conceptual/azps-10.1.0/context-persistence.md new file mode 100644 index 0000000000..db19130e39 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/context-persistence.md @@ -0,0 +1,217 @@ +--- +description: Learn how to reuse Azure credentials and other information across multiple PowerShell sessions. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Azure contexts and sign-in credentials +--- + +# Azure PowerShell context objects + +Azure PowerShell uses _Azure PowerShell context objects_ (Azure contexts) to hold subscription and +authentication information. If you have more than one subscription, Azure contexts let you select +the subscription to run Azure PowerShell cmdlets on. Azure contexts are also used to store sign-in +information across multiple PowerShell sessions and run background tasks. + +This article covers managing Azure contexts, not the management of subscriptions or accounts. If +you're looking to manage users, subscriptions, tenants, or other account information, see the +[Azure Active Directory](/azure/active-directory) documentation. To learn about using contexts for +running background or parallel tasks, see +[Run Azure PowerShell cmdlets in PowerShell Jobs](using-psjobs.md) after becoming familiar with +Azure contexts. + +## Overview of Azure context objects + +Azure contexts are PowerShell objects representing your active subscription to run commands against, +and the authentication information needed to connect to an Azure cloud. With Azure contexts, Azure +PowerShell doesn't need to reauthenticate your account each time you switch subscriptions. An Azure +context consists of: + +- The _account_ that was used to sign in to Azure with + [Connect-AzAccount](/powershell/module/az.accounts/connect-azaccount). Azure contexts treat users, + application IDs, and service principals the same from an account perspective. +- The active _subscription_, a service agreement with Microsoft to create and run Azure resources, + which are associated with a _tenant_. Tenants are often referred to as _organizations_ in + documentation or when working with Active Directory. +- A reference to a _token cache_, a stored authentication token for accessing an Azure cloud. Where + this token is stored and how long it persists for is determined by the + [context autosave settings](#save-azure-contexts-across-powershell-sessions). + +For more information on these terms, see +[Azure Active Directory Terminology](/azure/active-directory/fundamentals/active-directory-whatis#terminology). +Authentication tokens used by Azure contexts are the same as other stored tokens that are part of a +persistent session. + +When you sign in with `Connect-AzAccount`, at least one Azure context is created for your default +subscription. The object returned by `Connect-AzAccount` is the default Azure context used for the +rest of the PowerShell session. + +## Get Azure contexts + +Available Azure contexts are retrieved with the +[Get-AzContext](/powershell/module/az.accounts/get-azcontext) cmdlet. List the available contexts +with the **ListAvailable** parameter: + +```azurepowershell-interactive +Get-AzContext -ListAvailable +``` + +Or get a context by name: + +```azurepowershell-interactive +Get-AzContext -Name 'mycontext' +``` + +Context names may be different from the name of the associated subscription. + +> [!IMPORTANT] +> The available Azure contexts aren't always your available subscriptions. Azure contexts only +> represent locally stored information. You can get your subscriptions with the +> [Get-AzSubscription](/powershell/module/Az.Accounts/Get-AzSubscription) cmdlet. + +## Create a new Azure context from subscription information + +The [Set-AzContext](/powershell/module/Az.Accounts/Set-AzContext) cmdlet is used to both create new +Azure contexts and set them as the active context. The easiest way to create a new Azure context is +to use existing subscription information. The cmdlet is designed to take the output object from +`Get-AzSubscription` as a piped value and configure a new Azure context: + +```azurepowershell-interactive +Get-AzSubscription -SubscriptionName 'MySubscriptionName' | + Set-AzContext -Name 'MyContextName' +``` + +Or give the subscription name or ID and the tenant ID if necessary: + +```azurepowershell-interactive +Set-AzContext -Name 'MyContextName' -Subscription 'MySubscriptionName' -Tenant '00000000-0000-0000-0000-000000000000' +``` + +If the **Name** parameter is omitted, then the subscription's name and ID are used as the context name +in the format **Subscription Name (subscription-id)**. + +## Change the active Azure context + +Both `Set-AzContext` and [Select-AzContext](/powershell/module/az.accounts/set-azcontext) can be +used to change the active Azure context. As described in +[Create a new Azure context](#create-a-new-azure-context-from-subscription-information), +`Set-AzContext` creates a new Azure context for a subscription if one doesn't exist, and then +switches the active context to that one. + +`Select-AzContext` is meant to be used only with existing Azure contexts and works similarly to +using `Set-AzContext -Context`, but is designed for use with piping: + +```azurepowershell-interactive +Set-AzContext -Context $(Get-AzContext -Name 'mycontext') # Set a context with an inline Azure context object +Get-AzContext -Name 'mycontext' | Select-AzContext # Set a context with a piped Azure context object +``` + +Like many other account and context management commands in Azure PowerShell, `Set-AzContext` and +`Select-AzContext` support the **Scope** parameter so that you can control how long the context is +active. **Scope** lets you change a single session's active context without changing your default: + +```azurepowershell-interactive +Get-AzContext -Name 'mycontext' | Select-AzContext -Scope Process +``` + +To avoid switching contexts for a whole PowerShell session, Azure PowerShell commands with an +**AzContext** parameter can be run against a given context: + +```azurepowershell-interactive +$context = Get-AzContext -Name "mycontext" +New-AzVM -Name ExampleVM -AzContext $context +``` + +The other main use of contexts with Azure PowerShell cmdlets is to run background commands. To learn +more about running PowerShell Jobs using Azure PowerShell, see +[Run Azure PowerShell cmdlets in PowerShell Jobs](using-psjobs.md). + +## Save Azure contexts across PowerShell sessions + +By default, Azure contexts are saved for use between PowerShell sessions. You change this behavior +in the following ways: + +- Sign in using `-Scope Process` with `Connect-AzAccount`. + + ```azurepowershell + Connect-AzAccount -Scope Process + ``` + + The Azure context returned as part of this sign in is valid for the current session _only_ and + won't be saved automatically, regardless of the Azure PowerShell context autosave setting. +- Disable context autosave in Azure PowerShell with the + [Disable-AzContextAutosave](/powershell/module/az.accounts/disable-azcontextautosave) cmdlet. + Disabling context autosave doesn't clear any stored tokens. To learn how to clear stored Azure + context information, see + [Remove Azure contexts and credentials](#remove-azure-contexts-and-stored-credentials). +- Explicitly enable Azure context autosave can be enabled with the + [Enable-AzContextAutosave](/powershell/module/az.accounts/enable-azcontextautosave) cmdlet. With + autosave enabled, a user's contexts are stored locally for later PowerShell sessions. +- Manually save contexts with [Save-AzContext](/powershell/module/az.accounts/save-azcontext) to be + used in future PowerShell sessions, where they can be loaded with + [Import-AzContext](/powershell/module/az.accounts/import-azcontext): + + ```azurepowershell + Save-AzContext -Path current-context.json # Save the current context + Save-AzContext -Profile $profileObject -Path other-context.json # Save a context object + Import-AzContext -Path other-context.json # Load the context from a file and set it to the current context + ``` + +> [!WARNING] +> Disabling context autosave doesn't clear any stored context information that was saved. To remove +> stored information, use the [Clear-AzContext](/powershell/module/az.accounts/Clear-AzContext) +> cmdlet. For more on removing saved contexts, see +> [Remove contexts and credentials](#remove-azure-contexts-and-stored-credentials). + +Each of these commands supports the **Scope** parameter, which can take a value of `Process` to only +apply to the current running process. For example, to ensure that newly created contexts aren't +saved after exiting a PowerShell session: + +```azurepowershell-interactive +Disable-AzContextAutosave -Scope Process +$context2 = Set-AzContext -Subscription 'sub-id' -Tenant 'other-tenant' +``` + +Context information and tokens are stored in the `$env:USERPROFILE\.Azure` directory on Windows, and +on `$HOME/.Azure` on other platforms. Sensitive information such as subscription IDs and tenant IDs +may still be exposed in stored information, through logs, or saved contexts. To learn how to clear +stored information, see the +[Remove contexts and credentials](#remove-azure-contexts-and-stored-credentials) section. + +## Remove Azure contexts and stored credentials + +To clear Azure contexts and credentials: + +- Sign out of an account with + [Disconnect-AzAccount](/powershell/module/az.accounts/disconnect-azaccount). You can sign out of + any account either by account or context: + + ```azurepowershell-interactive + Disconnect-AzAccount # Disconnect active account + Disconnect-AzAccount -Username 'user@contoso.com' # Disconnect by account name + + Disconnect-AzAccount -ContextName 'subscription2' # Disconnect by context name + Disconnect-AzAccount -AzureContext $contextObject # Disconnect using context object information + ``` + + Disconnecting always removes stored authentication tokens and clears saved contexts associated + with the disconnected user or context. +- Use [Clear-AzContext](/powershell/module/az.accounts/Clear-AzContext). This cmdlet always removes + stored contexts, authentication tokens, and signs you out. +- Remove a context with [Remove-AzContext](/powershell/module/az.accounts/remove-azcontext): + + ```azurepowershell-interactive + Remove-AzContext -Name 'mycontext' # Remove by name + Get-AzContext -Name 'mycontext' | Remove-AzContext # Remove by piping Azure context object + ``` + + If you remove the active context, you'll be disconnected from Azure and need to reauthenticate + with `Connect-AzAccount`. + +## See also + +- [Run Azure PowerShell cmdlets in PowerShell Jobs](using-psjobs.md) +- [Azure Active Directory Terminology](/azure/active-directory/fundamentals/active-directory-whatis#terminology) +- [Az.Accounts reference documentation](/powershell/module/az.accounts) diff --git a/docs-conceptual/azps-10.1.0/create-azure-service-principal-azureps.md b/docs-conceptual/azps-10.1.0/create-azure-service-principal-azureps.md new file mode 100644 index 0000000000..526ed12355 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/create-azure-service-principal-azureps.md @@ -0,0 +1,253 @@ +--- +description: Learn how to create and use service principals with Azure PowerShell. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Use Azure service principals with Azure PowerShell +--- + +# Create an Azure service principal with Azure PowerShell + +Automated tools that use Azure services should always have restricted permissions. Instead of having +applications sign in as a fully privileged user, Azure offers service principals. + +An Azure service principal is an identity created for use with applications, hosted services, and +automated tools to access Azure resources. This access is restricted by the roles assigned to the +service principal, giving you control over which resources can be accessed and at which level. For +security reasons, it's always recommended to use service principals with automated tools rather than +allowing them to log in with a user identity. + +This article shows you the steps for creating, getting information about, and resetting a service +principal with Azure PowerShell. + +> [!WARNING] +> When you create a service principal using the +> [New-AzADServicePrincipal](/powershell/module/Az.Resources/New-AzADServicePrincipal) command, the +> output includes credentials that you must protect. As an alternative, consider using +> [managed identities](/azure/active-directory/managed-identities-azure-resources/overview) to avoid +> the need to use credentials. + +[!INCLUDE [azps-prerequisites-h2.md](../../includes/azps-prerequisites-h2.md)] + +## Create a service principal + +Create a service principal with the +[New-AzADServicePrincipal](/powershell/module/Az.Resources/New-AzADServicePrincipal) cmdlet. When +creating a service principal, you choose the type of sign-in authentication it uses. + +> [!IMPORTANT] +> Beginning with Az PowerShell module version 7.x, +> [New-AzADServicePrincipal](/powershell/module/Az.Resources/New-AzADServicePrincipal) no longer +> assigns the [Contributor](/azure/role-based-access-control/built-in-roles#contributor) role to the +> service principal by default. To assign a specific role to a service principal, see +> [Steps to add a role assignment](/azure/role-based-access-control/role-assignments-steps). + +> [!NOTE] +> If your account doesn't have permission to create a service principal, `New-AzADServicePrincipal` +> returns an error message containing "Insufficient privileges to complete the operation". Contact +> your Azure Active Directory admin to create a service principal. + +There are two types of authentication available for service principals: Password-based +authentication, and certificate-based authentication. + +### Password-based authentication + +> [!IMPORTANT] +> The default role for a password-based authentication service principal is **Contributor**. This +> role has full permissions to read and write to an Azure account. For information on managing role +> assignments, see +> [Manage service principal roles](#manage-service-principal-roles). + +Without any other authentication parameters, password-based authentication is used and a random +password created for you. If you want password-based authentication, this method is recommended. + +```azurepowershell-interactive +$sp = New-AzADServicePrincipal -DisplayName ServicePrincipalName +``` + +The returned object contains the `PasswordCredentials.SecretText` property containing the generated +password. Make sure that you store this value somewhere secure to authenticate with the service +principal. Its value _won't_ be displayed in the console output. If you lose the password, +[reset the service principal credentials](#reset-credentials). + +The following code allows you to export the secret: + +```azurepowershell-interactive +$sp.PasswordCredentials.SecretText +``` + +The object returned from `New-AzADServicePrincipal` contains the `Id` and `DisplayName` members, +either of which can be used for sign in with the service principal. + +> [!IMPORTANT] +> Signing in with a service principal requires the tenant ID which the service principal was created +> under. To get the active tenant when the service principal was created, run the following command +> _immediately after_ service principal creation: + +```azurepowershell-interactive +(Get-AzContext).Tenant.Id +``` + +### Certificate-based authentication + +> [!IMPORTANT] +> There is no default role assigned when creating a certificate-based authentication service +> principal. For information on managing role assignments, see +> [Manage service principal roles](#manage-service-principal-roles). + +Service principals using certificate-based authentication are created with the `CertValue` +parameter. This parameter takes a base64-encoded ASCII string of the public certificate. This is +represented by a PEM file, or a text-encoded CRT or CER. Binary encodings of the public certificate +aren't supported. These instructions assume that you already have a certificate available. + +```azurepowershell-interactive +$cert = <public certificate as base64-encoded string> +$sp = New-AzADServicePrincipal -DisplayName ServicePrincipalName -CertValue $cert +``` + +The object returned from `New-AzADServicePrincipal` contains the `Id` and `DisplayName` properties, +either of which can be used for sign in with the service principal. Clients which sign in with the +service principal also need access to the certificate's private key. + +> [!IMPORTANT] +> Signing in with a service principal requires the tenant ID which the service principal was created +> under. To get the active tenant when the service principal was created, run the following command +> _immediately after_ service principal creation: + +```azurepowershell-interactive +(Get-AzContext).Tenant.Id +``` + +## Get an existing service principal + +A list of service principals for the active tenant can be retrieved with +[Get-AzADServicePrincipal](/powershell/module/az.resources/get-azadserviceprincipal). By default +this command returns _all_ service principals in a tenant. For large organizations, it may take +a long time to return results. Instead, using one of the optional server-side filtering arguments is +recommended: + +- `DisplayNameBeginsWith` requests service principals that have a _prefix_ that match the provided + value. The display name of a service principal is the value set with `DisplayName` during + creation. +- `DisplayName` requests an _exact match_ of a service principal name. + +## Manage service principal roles + +Azure PowerShell has the following cmdlets to manage role assignments: + +- [Get-AzRoleAssignment](/powershell/module/az.resources/get-azroleassignment) +- [New-AzRoleAssignment](/powershell/module/az.resources/new-azroleassignment) +- [Remove-AzRoleAssignment](/powershell/module/az.resources/remove-azroleassignment) + +For more information on Role-Based Access Control (RBAC) and roles, see +[RBAC: Built-in roles](/azure/active-directory/role-based-access-built-in-roles). + +The following example adds the **Reader** role and removes the **Contributor** role: + +```azurepowershell-interactive +New-AzRoleAssignment -ApplicationId <service principal application ID> -RoleDefinitionName 'Reader' +Remove-AzRoleAssignment -ObjectId <service principal object ID> -RoleDefinitionName 'Contributor' +``` + +> [!IMPORTANT] +> Role assignment cmdlets don't take the service principal object ID. They take the associated +> application ID, which is generated at creation time. To get the application ID for a service +> principal, use `Get-AzADServicePrincipal`. + +> [!NOTE] +> If your account doesn't have permission to assign a role, you see an error message that your +> account "doesn't have authorization to perform action +> 'Microsoft.Authorization/roleAssignments/write'". Contact your Azure Active Directory admin to +> manage roles. + +Adding a role _doesn't_ restrict previously assigned permissions. When restricting a service +principal's permissions, the **Contributor** role should be removed. + +The changes can be verified by listing the assigned roles: + +```azurepowershell-interactive +Get-AzRoleAssignment -ServicePrincipalName ServicePrincipalName +``` + +## Sign in using a service principal + +Test the new service principal's credentials and permissions by signing in. To sign in with a +service principal, you need the `applicationId` value associated with it, and the tenant it's +created under. + +To sign in with a service principal using a password: + +```azurepowershell-interactive +# Use the application ID as the username, and the secret as password +$credentials = Get-Credential +Connect-AzAccount -ServicePrincipal -Credential $credentials -Tenant <tenant ID> +``` + +Certificate-based authentication requires that Azure PowerShell can retrieve information from a +local certificate store based on a certificate thumbprint. + +```azurepowershell-interactive +Connect-AzAccount -ServicePrincipal -Tenant <TenantId> -CertificateThumbprint <Thumbprint> -ApplicationId <ApplicationId> +``` + +For instructions on importing a certificate into a credential store accessible by PowerShell, see +[Sign in with Azure PowerShell](authenticate-azureps.md#sign-in-with-a-service-principal) + +## Reset credentials + +If you forget the credentials for a service principal, use +[New-AzADSpCredential](/powershell/module/az.resources/new-azadspcredential) to add a new credential +with a random password. This cmdlet doesn't support user-defined credentials when resetting the +password. + +> [!IMPORTANT] +> Before assigning any new credentials, you may want to remove existing credentials to prevent sign +> in with them. To do so, use the +> [Remove-AzADSpCredential](/powershell/module/az.resources/remove-azadspcredential) cmdlet: + +```azurepowershell-interactive +Remove-AzADSpCredential -DisplayName ServicePrincipalName +``` + +```azurepowershell-interactive +$newCredential = New-AzADSpCredential -ServicePrincipalName ServicePrincipalName +``` + +## Troubleshooting + +If you receive the error: _"New-AzADServicePrincipal: Another object with the same value for +property identifierUris already exists."_, verify that a service principal with the same name +doesn't already exist. + +```azurepowershell-interactive +Get-AzAdServicePrincipal -DisplayName ServicePrincipalName +``` + +If the existing service principal is no longer needed, you can remove it using the following +example. + +```azurepowershell-interactive +Remove-AzAdServicePrincipal -DisplayName ServicePrincipalName +``` + +This error can also occur when you've previously created a service principal for an Azure Active +Directory application. If you remove the service principal, the application is still available. This +application prevents you from creating another service principal with the same name. + +You can use the following example to verify that an Azure Active Directory application with the same +name doesn't exist: + +```azurepowershell-interactive +Get-AzADApplication -DisplayName ServicePrincipalName +``` + +If an application with the same name does exist and is no longer needed, it can be removed using the +following example. + +```azurepowershell-interactive +Remove-AzADApplication -DisplayName ServicePrincipalName +``` + +Otherwise, choose an alternate name for the new service principal that you're attempting to create. diff --git a/docs-conceptual/azps-10.1.0/faq.yml b/docs-conceptual/azps-10.1.0/faq.yml new file mode 100644 index 0000000000..7ea3faefc7 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/faq.yml @@ -0,0 +1,73 @@ +### YamlMime:FAQ +metadata: + title: Frequently Asked Questions (FAQ) + description: Frequently Asked Questions about Azure PowerShell. + ms.devlang: powershell + ms.topic: faq + ms.date: 06/30/2023 + ms.custom: devx-track-azurepowershell + ms.service: azure-powershell + +title: Frequently asked questions about Azure PowerShell +summary: | + +sections: + - name: Ignored + questions: + - question: | + What is Azure PowerShell? + answer: | + Azure PowerShell is a set of cmdlets that allows you to manage Azure resources directly with + PowerShell. In December 2018, the Az PowerShell module became generally available. It's now the + recommended PowerShell module for interacting with Azure. To learn more about the Az PowerShell + module, see + [Introducing the new Azure PowerShell Az module](/powershell/azure/new-azureps-module-az). + + - question: | + How do I disable breaking change warning messages in Azure PowerShell? + answer: | + To suppress the breaking change warning messages in Azure PowerShell, you'll need to set the + environment variable `SuppressAzurePowerShellBreakingChangeWarnings` to `true`. + + ```azurepowershell + Set-Item -Path Env:\SuppressAzurePowerShellBreakingChangeWarnings -Value $true + ``` + + - question: | + How do I disable the AzureRM retirement warning message in Azure PowerShell? + answer: | + To suppress the AzureRM retirement warning message in Azure PowerShell, you'll need to set the + environment variable `SuppressAzureRmModulesRetiringWarning` to `true`. + + ```azurepowershell-interactive + Set-Item -Path Env:\SuppressAzureRmModulesRetiringWarning -Value $true + ``` + + One disadvantage of the previous example is you'll need to run the command for each new PowerShell + session unless you add it to your PowerShell profile. + + To set the environment variable permanently, you can also use the following example. + + ```azurepowershell-interactive + [System.Environment]::SetEnvironmentVariable('SuppressAzureRmModulesRetiringWarning', 'true', [System.EnvironmentVariableTarget]::User) + ``` + + - question: | + How do I determine the max HTTP retry times in Azure PowerShell? + answer: | + For general HTTP response (except response status code is 429), Azure PowerShell uses the value defined in the `AZURE_PS_HTTP_MAX_RETRIES` environment variable. Its minimum value is 0. If not specified, Azure PowerShell uses the SDK default value. + + ```azurepowershell-interactive + [System.Environment]::SetEnvironmentVariable('AZURE_PS_HTTP_MAX_RETRIES ', 3, [System.EnvironmentVariableTarget]::User) + ``` + + If the HTTP response status code is 429, Azure PowerShell uses the value defined in the `AZURE_PS_HTTP_MAX_RETRIES_FOR_429` environment variable. Its minimum value is 1. The total retry times of status code 429 is (`AZURE_PS_HTTP_MAX_RETRIES` + 1) * `AZURE_PS_HTTP_MAX_RETRIES_FOR_429` - 1. If not specified, Azure PowerShell uses the SDK default value. + + ```azurepowershell-interactive + [System.Environment]::SetEnvironmentVariable('AZURE_PS_HTTP_MAX_RETRIES_FOR_429 ', 3, [System.EnvironmentVariableTarget]::User) + ``` + + + + + diff --git a/docs-conceptual/azps-10.1.0/formatting-output.md b/docs-conceptual/azps-10.1.0/formatting-output.md new file mode 100644 index 0000000000..439d6da1d7 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/formatting-output.md @@ -0,0 +1,349 @@ +--- +description: How to format cmdlet output for Azure PowerShell. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Format Azure PowerShell cmdlet output +--- + +# Format Azure PowerShell cmdlet output + +By default each Azure PowerShell cmdlet formats output to be easy to read. PowerShell allows you to +convert or format cmdlet output by piping to one of the following cmdlets: + +| Formatting | Conversion | +|-----------------|------------------| +| [Format-Custom](/powershell/module/microsoft.powershell.utility/format-custom) | [ConvertTo-Csv](/powershell/module/microsoft.powershell.utility/convertto-csv) | +| [Format-List](/powershell/module/microsoft.powershell.utility/format-list) | [ConvertTo-Html](/powershell/module/microsoft.powershell.utility/convertto-html) | +| [Format-Table](/powershell/module/microsoft.powershell.utility/format-table) | [ConvertTo-Json](/powershell/module/microsoft.powershell.utility/convertto-json) | +| [Format-Wide](/powershell/module/microsoft.powershell.utility/format-wide) | [ConvertTo-Xml](/powershell/module/microsoft.powershell.utility/convertto-xml) | + +Formatting is used for display in the PowerShell console, and conversion is used for generating data +to be consumed by other scripts or programs. + +## Table output format + +By default, Azure PowerShell cmdlets output in the table format. This format doesn't display all +information of the requested resource: + +```azurepowershell-interactive +Get-AzVM +``` + +```Output +ResourceGroupName Name Location VmSize OsType NIC ProvisioningState Zone +----------------- ---- -------- ------ ------ --- ----------------- ---- +QueryExample ExampleLinuxVM westus2 Basic_A0 Linux examplelinuxvm916 Succeeded +QueryExample RHELExample westus2 Standard_D2_v3 Linux rhelexample469 Succeeded +QueryExample WinExampleVM westus2 Standard_DS1_v2 Windows winexamplevm268 Succeeded +``` + +The amount of data displayed by `Format-Table` can be affected by the width of your PowerShell +session window. To restrict the output to specific properties and order them, property names can be +provided as arguments to `Format-Table`: + +```azurepowershell-interactive +Get-AzVM -ResourceGroupName QueryExample | + Format-Table -Property Name, ResourceGroupName, Location +``` + +```Output +Name ResourceGroupName Location +---- ----------------- -------- +ExampleLinuxVM QueryExample westus2 +RHELExample QueryExample westus2 +WinExampleVM QueryExample westus2 +``` + +## List output format + +List output format produces two columns, property names followed by the value. For complex objects, +the type of the object is displayed instead. + +```azurepowershell-interactive +Get-AzVM | Format-List +``` + +The following output has some fields removed. + +```Output +ResourceGroupName : QueryExample +Id : /subscriptions/.../resourceGroups/QueryExample/providers/Microsoft.Compute/virtualMachines/ExampleLinuxVM +VmId : ... +Name : ExampleLinuxVM +Type : Microsoft.Compute/virtualMachines +Location : westus2 +... +HardwareProfile : Microsoft.Azure.Management.Compute.Models.HardwareProfile +InstanceView : +NetworkProfile : Microsoft.Azure.Management.Compute.Models.NetworkProfile +OSProfile : Microsoft.Azure.Management.Compute.Models.OSProfile +... +StatusCode : OK + +ResourceGroupName : QueryExample +Id : /subscriptions/.../resourceGroups/QueryExample/providers/Microsoft.Compute/virtualMachines/RHELExample +VmId : ... +Name : RHELExample +Type : Microsoft.Compute/virtualMachines +Location : westus2 +... +``` + +Like `Format-Table`, property names can be provided to order and restrict the output: + +```azurepowershell-interactive +Get-AzVM | Format-List -Property ResourceGroupName, Name, Location +``` + +```Output +ResourceGroupName : QueryExample +Name : ExampleLinuxVM +Location : westus2 + +ResourceGroupName : QueryExample +Name : RHELExample +Location : westus2 + +ResourceGroupName : QueryExample +Name : WinExampleVM +Location : westus2 +``` + +## Wide output format + +Wide output format produces only one property name per query. Which property is displayed can be +controlled by giving a property as an argument. + +```azurepowershell-interactive +Get-AzVM | Format-Wide +``` + +```Output +ExampleLinuxVM RHELExample +WinExampleVM +``` + +```azurepowershell-interactive +Get-AzVM | Format-Wide -Property ResourceGroupName +``` + +```Output +QueryExample QueryExample +QueryExample +``` + +## Custom output format + +The `Custom-Format` output type is meant for formatting custom objects. Without any parameters, it +behaves like `Format-List` but displays the property names of custom classes. + +```azurepowershell-interactive +Get-AzVM | Format-Custom +``` + +The following output has some fields removed. + +```Output +ResourceGroupName : QueryExample +Id : /subscriptions/.../resourceGroups/QueryExample/providers/Microsoft.Compute/virtualMachines/ExampleLinuxVM +VmId : ... +Name : ExampleLinuxVM +Type : Microsoft.Compute/virtualMachines +Location : westus2 +Tags : {} +HardwareProfile : {VmSize} +NetworkProfile : {NetworkInterfaces} +OSProfile : {ComputerName, AdminUsername, LinuxConfiguration, Secrets, +AllowExtensionOperations} +ProvisioningState : Succeeded +StorageProfile : {ImageReference, OsDisk, DataDisks} +... +``` + +Giving property names as arguments to `Custom-Format` displays the property/value pairs for custom +objects set as values: + +```azurepowershell-interactive +Get-AzVM | Format-Custom -Property Name, ResourceGroupName, Location, OSProfile +``` + +The following output has some fields removed. + +```Output +class PSVirtualMachineList +{ + Name = ExampleLinuxVM + ResourceGroupName = QueryExample + Location = westus2 + OSProfile = + class OSProfile + { + ComputerName = ExampleLinuxVM + AdminUsername = ... + AdminPassword = + CustomData = + WindowsConfiguration = + LinuxConfiguration = + class LinuxConfiguration + { + DisablePasswordAuthentication = False + Ssh = + ProvisionVMAgent = True + } + Secrets = + [ + ] + + AllowExtensionOperations = True + } +} + +... + +class PSVirtualMachineList +{ + Name = WinExampleVM + ResourceGroupName = QueryExample + Location = westus2 + OSProfile = + class OSProfile + { + ComputerName = WinExampleVM + AdminUsername = ... + AdminPassword = + CustomData = + WindowsConfiguration = + class WindowsConfiguration + { + ProvisionVMAgent = True + EnableAutomaticUpdates = True + TimeZone = + AdditionalUnattendContent = + WinRM = + } + LinuxConfiguration = + Secrets = + [ + ] + + AllowExtensionOperations = True + } +} +``` + +## Conversion to other data formats + +The `ConvertTo-*` family of cmdlets allows for converting the results of Azure PowerShell cmdlets to +machine-readable formats. To get only some properties from the Azure PowerShell results, pipe to the +`Select-Object` cmdlet before performing the conversion. The following examples demonstrate the +different kinds of output that each conversion produces. + +### Conversion to CSV + +```azurepowershell-interactive +Get-AzVM | ConvertTo-CSV +``` + +```Output +#TYPE Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineList +"ResourceGroupName","Id","VmId","Name","Type","Location","LicenseType","Tags","AvailabilitySetReference","DiagnosticsProfile","Extensions","HardwareProfile","InstanceView","NetworkProfile","OSProfile","Plan","ProvisioningState","StorageProfile","DisplayHint","Identity","Zones","FullyQualifiedDomainName","AdditionalCapabilities","RequestId","StatusCode" +"QUERYEXAMPLE","/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Microsoft.Compute/virtualMachines/ExampleLinuxVM","...","ExampleLinuxVM","Microsoft.Compute/virtualMachines","westus2",,"System.Collections.Generic.Dictionary`2[System.String,System.String]",,,"System.Collections.Generic.List`1[Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension]","Microsoft.Azure.Management.Compute.Models.HardwareProfile",,"Microsoft.Azure.Management.Compute.Models.NetworkProfile","Microsoft.Azure.Management.Compute.Models.OSProfile",,"Succeeded","Microsoft.Azure.Management.Compute.Models.StorageProfile","Compact",,"System.Collections.Generic.List`1[System.String]",,,"...","OK" +"QUERYEXAMPLE","/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Microsoft.Compute/virtualMachines/RHELExample","...","RHELExample","Microsoft.Compute/virtualMachines","westus2",,"System.Collections.Generic.Dictionary`2[System.String,System.String]",,,"System.Collections.Generic.List`1[Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension]","Microsoft.Azure.Management.Compute.Models.HardwareProfile",,"Microsoft.Azure.Management.Compute.Models.NetworkProfile","Microsoft.Azure.Management.Compute.Models.OSProfile",,"Succeeded","Microsoft.Azure.Management.Compute.Models.StorageProfile","Compact",,"System.Collections.Generic.List`1[System.String]",,,"...","OK" +"QUERYEXAMPLE","/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Microsoft.Compute/virtualMachines/WinExampleVM","...","WinExampleVM","Microsoft.Compute/virtualMachines","westus2",,"System.Collections.Generic.Dictionary`2[System.String,System.String]",,,"System.Collections.Generic.List`1[Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension]","Microsoft.Azure.Management.Compute.Models.HardwareProfile",,"Microsoft.Azure.Management.Compute.Models.NetworkProfile","Microsoft.Azure.Management.Compute.Models.OSProfile",,"Succeeded","Microsoft.Azure.Management.Compute.Models.StorageProfile","Compact",,"System.Collections.Generic.List`1[System.String]",,,"...","OK" +``` + +### Conversion to JSON + +JSON output doesn't expand all properties by default. To change the depth of properties expanded, +use the `Depth` parameter. By default, the expansion depth is `2`. + +```azurepowershell-interactive +Get-AzVM | ConvertTo-JSON +``` + +The following output has some fields removed. + +```Output +[ + { + "ResourceGroupName": "QUERYEXAMPLE", + "Id": "/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Microsoft.Compute/virtualMachines/ExampleLinuxVM", + "VmId": "...", + "Name": "ExampleLinuxVM", + "Type": "Microsoft.Compute/virtualMachines", + "Location": "westus2", + ... + "OSProfile": { + "ComputerName": "ExampleLinuxVM", + "AdminUsername": "...", + "AdminPassword": null, + "CustomData": null, + "WindowsConfiguration": null, + "LinuxConfiguration": "Microsoft.Azure.Management.Compute.Models.LinuxConfiguration", + "Secrets": "", + "AllowExtensionOperations": true + }, + "Plan": null, + "ProvisioningState": "Succeeded", + "StorageProfile": { + "ImageReference": "Microsoft.Azure.Management.Compute.Models.ImageReference", + "OsDisk": "Microsoft.Azure.Management.Compute.Models.OSDisk", + "DataDisks": "" + }, + "DisplayHint": 0, + "Identity": null, + "Zones": [ + + ], + "FullyQualifiedDomainName": null, + "AdditionalCapabilities": null, + "RequestId": "...", + "StatusCode": 200 + }, + ... +] +``` + +### Conversion to XML + +The `ConvertTo-XML` cmdlet converts the Azure PowerShell response object into a pure XML object, +which can be handled like any other XML object within PowerShell. + +```azurepowershell-interactive +Get-AzVM | ConvertTo-XML +``` + +```Output +xml Objects +--- ------- +version="1.0" encoding="utf-8" Objects +``` + +### Conversion to HTML + +Converting an object to HTML produces output that's rendered as an HTML table. Rendering of the HTML +depends on your browser behavior for rendering tables which contain no width information. No custom +class objects are expanded. + +```azurepowershell-interactive +Get-AzVM | ConvertTo-HTML +``` + +```Output +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>HTML TABLE</title> +</head><body> +<table> +<colgroup><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/><col/></colgroup> +<tr><th>ResourceGroupName</th><th>Id</th><th>VmId</th><th>Name</th><th>Type</th><th>Location</th><th>LicenseType</th><th>Tags</th><th>AvailabilitySetReference</th><th>DiagnosticsProfile</th><th>Extensions</th><th>HardwareProfile</th><th>InstanceView</th><th>NetworkProfile</th><th>OSProfile</th><th>Plan</th><th>ProvisioningState</th><th>StorageProfile</th><th>DisplayHint</th><th>Identity</th><th>Zones</th><th>FullyQualifiedDomainName</th><th>AdditionalCapabilities</th><th>RequestId</th><th>StatusCode</th></tr> +<tr><td>QUERYEXAMPLE</td><td>/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Microsoft.Compute/virtualMachines/ExampleLinuxVM</td><td>...</td><td>ExampleLinuxVM</td><td>Microsoft.Compute/virtualMachines</td><td>westus2</td><td></td><td>System.Collections.Generic.Dictionary`2[System.String,System.String]</td><td></td><td></td><td>System.Collections.Generic.List`1[Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension]</td><td>Microsoft.Azure.Management.Compute.Models.HardwareProfile</td><td></td><td>Microsoft.Azure.Management.Compute.Models.NetworkProfile</td><td>Microsoft.Azure.Management.Compute.Models.OSProfile</td><td></td><td>Succeeded</td><td>Microsoft.Azure.Management.Compute.Models.StorageProfile</td><td>Compact</td><td></td><td>System.Collections.Generic.List`1[System.String]</td><td></td><td></td><td>...</td><td>OK</td></tr> +<tr><td>QUERYEXAMPLE</td><td>/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Microsoft.Compute/virtualMachines/RHELExample</td><td>...</td><td>RHELExample</td><td>Microsoft.Compute/virtualMachines</td><td>westus2</td><td></td><td>System.Collections.Generic.Dictionary`2[System.String,System.String]</td><td></td><td></td><td>System.Collections.Generic.List`1[Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension]</td><td>Microsoft.Azure.Management.Compute.Models.HardwareProfile</td><td></td><td>Microsoft.Azure.Management.Compute.Models.NetworkProfile</td><td>Microsoft.Azure.Management.Compute.Models.OSProfile</td><td></td><td>Succeeded</td><td>Microsoft.Azure.Management.Compute.Models.StorageProfile</td><td>Compact</td><td></td><td>System.Collections.Generic.List`1[System.String]</td><td></td><td></td><td>...</td><td>OK</td></tr> +<tr><td>QUERYEXAMPLE</td><td>/subscriptions/.../resourceGroups/QUERYEXAMPLE/providers/Microsoft.Compute/virtualMachines/WinExampleVM</td><td>...</td><td>WinExampleVM</td><td>Microsoft.Compute/virtualMachines</td><td>westus2</td><td></td><td>System.Collections.Generic.Dictionary`2[System.String,System.String]</td><td></td><td></td><td>System.Collections.Generic.List`1[Microsoft.Azure.Management.Compute.Models.VirtualMachineExtension]</td><td>Microsoft.Azure.Management.Compute.Models.HardwareProfile</td><td></td><td>Microsoft.Azure.Management.Compute.Models.NetworkProfile</td><td>Microsoft.Azure.Management.Compute.Models.OSProfile</td><td></td><td>Succeeded</td><td>Microsoft.Azure.Management.Compute.Models.StorageProfile</td><td>Compact</td><td></td><td>System.Collections.Generic.List`1[System.String]</td><td></td><td></td><td>...</td><td>OK</td></tr> +</table> +</body></html> +``` diff --git a/docs-conceptual/azps-10.1.0/get-started-azureps.md b/docs-conceptual/azps-10.1.0/get-started-azureps.md new file mode 100644 index 0000000000..f2544dd60b --- /dev/null +++ b/docs-conceptual/azps-10.1.0/get-started-azureps.md @@ -0,0 +1,136 @@ +--- +description: Get started with Azure PowerShell +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: get-started-article +title: Get started with Azure PowerShell +--- + +# Get started with Azure PowerShell + +Azure PowerShell is designed for managing and administering Azure resources from the command line. +Use Azure PowerShell when you want to build automated tools that use the Azure Resource Manager +model. Try it out in your browser with [Azure Cloud Shell](/azure/cloud-shell/overview), or install +on your local machine. + +This article helps you get started with Azure PowerShell and teaches the core concepts behind it. + +## Install or run in Azure Cloud Shell + +The easiest way to get started with Azure PowerShell is by trying it out in an Azure Cloud Shell +environment. To get up and running with Cloud Shell, see +[Quickstart for PowerShell in Azure Cloud Shell](/azure/cloud-shell/quickstart-powershell). Cloud +Shell runs PowerShell on a Linux container, so Windows-specific functionality isn't available. + +When you're ready to install Azure PowerShell on your local machine, follow the instructions in +[Install the Azure PowerShell module](install-azure-powershell.md). + +## Sign in to Azure + +Sign in interactively with the +[Connect-AzAccount](/powershell/module/az.accounts/connect-azaccount) cmdlet. Skip this step if you +use Cloud Shell. Your Azure Cloud Shell session is already authenticated for the environment, +subscription, and tenant that launched the Cloud Shell session. + +```azurepowershell +Connect-AzAccount +``` + +Azure cloud services offer environments compliant with regional data-handling laws. For accounts in +a regional cloud, use the `Environment` parameter to sign in. Get the name of the environment for +your region using the [Get-AzEnvironment](/powershell/module/Az.Accounts/Get-AzEnvironment) cmdlet. +For example, to sign in to Azure China 21Vianet: + +```azurepowershell-interactive +Connect-AzAccount -Environment AzureChinaCloud +``` + +Beginning with Az PowerShell module version 5.0.0, `Connect-AzAccount` presents an interactive +browser based login prompt by default. You can specify the `UseDeviceAuthentication` parameter to +receive a token string which was previously the default for PowerShell version 6 and higher. + +After signing in, you'll see information indicating which of your Azure subscriptions is active. If +you have multiple Azure subscriptions in your account and want to select a different one, get your +available subscriptions with +[Get-AzSubscription](/powershell/module/az.accounts/get-azsubscription) and use the +[Set-AzContext](/powershell/module/az.accounts/set-azcontext) cmdlet with your subscription ID. For +more information about managing your Azure subscriptions in Azure PowerShell, see +[Use multiple Azure subscriptions](manage-subscriptions-azureps.md). + +Once signed in, use the Azure PowerShell cmdlets to access and manage resources in your +subscription. To learn more about the sign-in process and authentication methods, see +[Sign in with Azure PowerShell](authenticate-azureps.md). + +## Find commands + +Azure PowerShell cmdlets follow a standard naming convention for PowerShell, `Verb-Noun`. The verb +describes the action (examples include `New`, `Get`, `Set`, `Remove`) and the noun describes the +resource type (examples include `AzVM`, `AzKeyVaultCertificate`, `AzFirewall`, +`AzVirtualNetworkGateway`). Nouns in Azure PowerShell always start with the prefix `Az`. For the +full list of standard verbs, see +[Approved verbs for PowerShell Commands](/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands). + +Knowing the nouns, verbs, and the Azure PowerShell modules available helps you find commands with +the [Get-Command](/powershell/module/microsoft.powershell.core/get-command) cmdlet. For example, to +find all VM-related commands that use the `Get` verb: + +```powershell-interactive +Get-Command -Verb Get -Noun AzVM* -Module Az.Compute +``` + +To help you find common commands, this table lists the resource type, corresponding Azure PowerShell +module, and noun prefix to use with `Get-Command`: + +| Resource type | Azure PowerShell module | Noun prefix | +| ----------------------------------------------------------------------- | ------------------------------------------------------------ | ------------------ | +| [Resource group](/azure/azure-resource-manager/resource-group-overview) | [Az.Resources](/powershell/module/az.resources#resources) | `AzResourceGroup` | +| [Virtual machines](/azure/virtual-machines) | [Az.Compute](/powershell/module/az.compute#virtual_machines) | `AzVM` | +| [Storage accounts](/azure/storage/common/storage-introduction) | [Az.Storage](/powershell/module/az.storage/) | `AzStorageAccount` | +| [Key Vault](/azure/key-vault/key-vault-whatis) | [Az.KeyVault](/powershell/module/az.keyvault) | `AzKeyVault` | +| [Web applications](/azure/app-service) | [Az.Websites](/powershell/module/az.websites) | `AzWebApp` | +| [SQL databases](/azure/sql-database) | [Az.Sql](/powershell/module/az.sql) | `AzSqlDatabase` | + +For a full list of the modules in Azure PowerShell, see the +[Azure PowerShell modules list](https://github.com/Azure/azure-powershell/blob/master/documentation/azure-powershell-modules.md) +hosted on GitHub. + +## Data Collection + +Azure PowerShell collects telemetry data by default. Microsoft aggregates collected data to identify +patterns of usage to identify common issues and to improve the experience of Azure PowerShell. +Microsoft Azure PowerShell does not collect any private or personal data. For example, the usage +data helps identify issues such as cmdlets with low success and helps prioritize our work. + +While we appreciate the insights this data provides, we also understand that not everyone wants to +send usage data. You can disable data collection with the +[`Disable-AzDataCollection`](/powershell/module/az.accounts/disable-azdatacollection) cmdlet. You +can also read our [privacy statement](https://privacy.microsoft.com/privacystatement) to learn more. + +## Learn Azure PowerShell basics with quickstarts and tutorials + +To get started with Azure PowerShell, try an in-depth tutorial for setting up virtual machines and +learning how to query them. + +> [!div class="nextstepaction"] +> [Create virtual machines with Azure PowerShell](azureps-vm-tutorial.yml) + +There are also Azure PowerShell quickstarts for other popular Azure services: + +* [Create a storage account](/azure/storage/common/storage-quickstart-create-account?tabs=azure-powershell) +* [Transfer objects to/from Azure Blob storage](/azure/storage/blobs/storage-quickstart-blobs-powershell) +* [Create and retrieve secrets from Azure Key Vault](/azure/key-vault/quick-create-powershell) +* [Create an Azure SQL database and firewall](/azure/sql-database/scripts/sql-database-create-and-configure-database-powershell) +* [Run a container in Azure Container Instances](/azure/container-instances/container-instances-quickstart-powershell) +* [Create a Virtual Machine Scale Set](/azure/virtual-machine-scale-sets/quick-create-powershell) +* [Create a standard load balancer](/azure/load-balancer/quickstart-create-standard-load-balancer-powershell) + +## Next steps + +* [Sign in with Azure PowerShell](authenticate-azureps.md) +* [Manage Azure subscriptions with Azure PowerShell](manage-subscriptions-azureps.md) +* [Create service principals with Azure PowerShell](create-azure-service-principal-azureps.md) +* Get help from the community: + * [Azure forum on MSDN](https://go.microsoft.com/fwlink/p/?LinkId=320212) + * [Stack Overflow](https://go.microsoft.com/fwlink/?LinkId=320213) diff --git a/docs-conceptual/azps-10.1.0/index.yml b/docs-conceptual/azps-10.1.0/index.yml new file mode 100644 index 0000000000..3e81c799ba --- /dev/null +++ b/docs-conceptual/azps-10.1.0/index.yml @@ -0,0 +1,157 @@ +###YamlMime:Landing + +title: Azure PowerShell Documentation +summary: | + Official product documentation for Azure PowerShell. Azure PowerShell is a collection of modules for managing Azure resources from PowerShell. + +metadata: + title: Azure PowerShell Documentation + description: Official product documentation for Azure PowerShell. Azure PowerShell is a collection of modules for managing Azure resources from PowerShell. + ms.topic: landing-page + author: mikefrobbins + ms.author: mirobb + ms.date: 06/30/2023 + ms.devlang: powershell + ms.custom: devx-track-azurepowershell + ms.service: azure-powershell +landingContent: + - title: About Azure PowerShell + linkLists: + - linkListType: overview + links: + - text: Get started + url: get-started-azureps.md + - text: What is Azure PowerShell? + url: what-is-azure-powershell.md + - text: Introducing the Az PowerShell module + url: new-azureps-module-az.md + - text: Support Lifecycle + url: azureps-support-lifecycle.md + - linkListType: learn + links: + - text: Automate Azure tasks from PowerShell + url: /training/modules/automate-azure-tasks-with-powershell/ + - text: Choose the best Azure command line tools for managing and provisioning your cloud infrastructure + url: /training/modules/azure-command-line-tools-intro/ + - title: Installation + linkLists: + - linkListType: download + links: + - text: Install + url: install-azure-powershell.md + - text: Install - Windows + url: install-azps-windows.md + - text: Install - Linux + url: install-azps-linux.md + - text: Install - macOS + url: install-azps-macos.md + - text: Run in Azure Cloud Shell + url: https://shell.azure.com + - text: Azure PowerShell in Docker + url: azureps-in-docker.md + - title: What's new + linkLists: + - linkListType: whats-new + links: + - text: Release notes + url: release-notes-azureps.md + - text: Az 10.0.0 migration guide + url: migrate-az-10.0.0.md + - text: Upcoming breaking changes + url: upcoming-breaking-changes.md + - title: Azure PowerShell Reference + linkLists: + - linkListType: reference + links: + - text: Cmdlet reference + url: /powershell/module/?view=azps-10.0.0 + - title: Identity and Authentication + linkLists: + - linkListType: whats-new + links: + - text: Azure AD to Microsoft Graph Migration changes + url: azps-msgraph-migration-changes.md + - linkListType: how-to-guide + links: + - text: Authentication methods + url: authenticate-azureps.md + - text: Create a service principal + url: create-azure-service-principal-azureps.md + - text: Credential Contexts + url: context-persistence.md + - title: Concepts + linkLists: + - linkListType: how-to-guide + links: + - text: Manage subscriptions + url: manage-subscriptions-azureps.md + - text: Manage Azure resources with Invoke-AzRestMethod + url: manage-azure-resources-invoke-azrestmethod.md + - text: Filter cmdlet results + url: queries-azureps.md + - text: Format output + url: formatting-output.md + - text: PowerShell jobs + url: using-psjobs.md + - linkListType: tutorial + links: + - text: Create virtual machines + url: azureps-vm-tutorial.yml + - title: Configuration + linkLists: + - linkListType: how-to-guide + links: + - text: Configure global settings + url: configure-global-settings.md + - text: Intelligent command completion + url: az-predictor.md + - text: Use the Az PowerShell module behind a proxy + url: az-powershell-proxy.md + - title: Deploy + linkLists: + - linkListType: deploy + links: + - text: Deploy resource manager templates + url: /azure/azure-resource-manager/templates/deploy-powershell?toc=/powershell/azure/toc.json + - text: Export resource manager templates + url: /azure/azure-resource-manager/management/manage-resources-powershell?toc=/powershell/azure/toc.json + - text: Deploy private resource manager templates + url: /azure/azure-resource-manager/templates/secure-template-with-sas-token?toc=/powershell/azure/toc.json + - title: Samples + linkLists: + - linkListType: sample + links: + - text: Azure App Service + url: /azure/app-service-web/app-service-powershell-samples?toc=/powershell/azure/toc.json + - text: SQL databases + url: /azure/sql-database/sql-database-powershell-samples?toc=/powershell/azure/toc.json + - text: Cosmos DB + url: /azure/cosmos-db/sql/powershell-samples?toc=/powershell/azure/toc.json + - text: Samples repo + url: /samples/browse/?terms=azure%20powershell + - title: Migrate from AzureRM + linkLists: + - linkListType: overview + links: + - text: Changes between AzureRM and Az + url: migrate-az-1.0.0.md + - linkListType: how-to-guide + links: + - text: Migration steps + url: migrate-from-azurerm-to-az.md + - linkListType: quickstart + links: + - text: Automatically migrate PowerShell scripts + url: quickstart-migrate-azurerm-to-az-automatically.md + - title: Help & Support + linkLists: + - linkListType: overview + links: + - text: Report product issues + url: https://github.com/Azure/azure-powershell/issues + - text: Troubleshoot + url: troubleshooting.md + - text: Follow Azure PowerShell on Twitter + url: https://twitter.com/azureposh + - text: Azure Tools Blog + url: https://techcommunity.microsoft.com/t5/azure-tools-blog/bg-p/AzureToolsBlog diff --git a/docs-conceptual/azps-10.1.0/install-azps-linux.md b/docs-conceptual/azps-10.1.0/install-azps-linux.md new file mode 100644 index 0000000000..eef169588d --- /dev/null +++ b/docs-conceptual/azps-10.1.0/install-azps-linux.md @@ -0,0 +1,82 @@ +--- +description: Learn how to install and run Azure PowerShell on Linux. You can install Azure PowerShell on Linux with one command. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Install Azure PowerShell on Linux +--- + + +# Install Azure PowerShell on Linux + +The Azure PowerShell Az module is a rollup module. Installing it downloads the generally available +Az PowerShell modules and makes their cmdlets available for use. + +This article explains how to install the Az PowerShell module on Linux. + +## Prerequisites + +- Install a supported version of [PowerShell version 7 or higher](/powershell/scripting/install/installing-powershell-on-linux) + +## Installation + +Open the Terminal or other shell host application and run `pwsh` to start PowerShell. + +Use the [Install-Module](/powershell/module/powershellget/install-module) cmdlet to install the Az +PowerShell module: + +```powershell +Install-Module -Name Az -Repository PSGallery -Force +``` + +## Update the Az PowerShell module + +Use [Update-Module](/powershell/module/powershellget/update-module) to update to the latest version +of the Az PowerShell module: + +```powershell +Update-Module -Name Az -Force +``` + +Updating the Az PowerShell module using `Update-Module` doesn't remove old versions of the Az +PowerShell module from your system. + +## Uninstallation + +To remove the Az PowerShell module from your system, see +[Uninstall the Azure PowerShell module](uninstall-az-ps.md). + +## Sign in + +To start managing your Azure resources with the Az PowerShell module, launch a PowerShell session +and run `Connect-AzAccount` to sign in to Azure: + +```azurepowershell +Connect-AzAccount +``` + +Use your Azure account login credentials to log into the browser window that opens. + +You'll need to repeat this step for every new PowerShell session you start. To learn how to persist +your Azure sign-in across PowerShell sessions, see +[Azure PowerShell context objects](/powershell/azure/context-persistence). + +## Troubleshooting + +For solutions to common installation issues with the Az PowerShell module, see +[Troubleshoot installation problems with the Azure Az PowerShell module](troubleshooting.md#installation). + +## Provide feedback + +To file an issue about the Az PowerShell module, see: +[file an issue on GitHub](https://github.com/Azure/azure-powershell/issues). + +To provide feedback from within a PowerShell session, use the +[Send-Feedback](/powershell/module/az.accounts/send-feedback) cmdlet. + +## Next Steps + +To learn more about managing your Azure resources with the Az PowerShell module, see +[Get Started with Azure PowerShell](get-started-azureps.md). diff --git a/docs-conceptual/azps-10.1.0/install-azps-macos.md b/docs-conceptual/azps-10.1.0/install-azps-macos.md new file mode 100644 index 0000000000..44830475db --- /dev/null +++ b/docs-conceptual/azps-10.1.0/install-azps-macos.md @@ -0,0 +1,83 @@ +--- +description: Learn how to install and run Azure PowerShell on macOS. You can install Azure PowerShell on macOS with one command. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Install Azure PowerShell on macOS +--- + +# Install Azure PowerShell on macOS + +This article explains how to install the Azure PowerShell Az module from +[the PowerShell Gallery](/powershell/scripting/gallery/overview) on macOS. + +The Az PowerShell module is a rollup module. Installing it downloads the generally available Az +PowerShell modules and makes their cmdlets available for use. + +## Prerequisites + +- Install a supported version of + [PowerShell version 7 or higher](/powershell/scripting/install/installing-powershell-on-macos) + +## Installation + +Open the Terminal or other shell host application and run `pwsh` to start PowerShell. + +Use the [Install-Module](/powershell/module/powershellget/install-module) cmdlet to install the Az +PowerShell module: + +```powershell +Install-Module -Name Az -Repository PSGallery -Force +``` + +## Update the Azure PowerShell module + +Use the [Update-Module](/powershell/module/powershellget/update-module) cmdlet to update to the +latest version of the Az PowerShell module. + +```powershell +Update-Module -Name Az -Force +``` + +Updating the Az PowerShell module using `Update-Module` doesn't remove old versions of the Az +PowerShell module from your system. + +## Uninstallation + +To remove the Az PowerShell module from your system, see +[Uninstall the Azure PowerShell module](uninstall-az-ps.md). + +## Sign in + +To start managing your Azure resources with the Az PowerShell module, launch a PowerShell session +and run `Connect-AzAccount` to sign in to Azure: + +```azurepowershell +Connect-AzAccount +``` + +Use your Azure account login credentials to log into the browser window that opens. + +You'll need to repeat this step for every new PowerShell session you start. To learn how to persist +your Azure sign-in across PowerShell sessions, see +[Azure PowerShell context objects](/powershell/azure/context-persistence). + +## Troubleshooting + +For solutions to common installation issues with the Az PowerShell module, see +[Troubleshoot installation problems with the Az PowerShell module](troubleshooting.md#installation). + +## Provide feedback + +To file an issue about the Az PowerShell module, see: +[file an issue on GitHub](https://github.com/Azure/azure-powershell/issues). + +To provide feedback from within a PowerShell session, use the +[Send-Feedback](/powershell/module/az.accounts/send-feedback) cmdlet. + +## Next steps + +To learn more about managing your Azure resources with the Az PowerShell module, see +[Get Started with Azure PowerShell](get-started-azureps.md). diff --git a/docs-conceptual/azps-10.1.0/install-azps-windows.md b/docs-conceptual/azps-10.1.0/install-azps-windows.md new file mode 100644 index 0000000000..ec6a80d0d3 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/install-azps-windows.md @@ -0,0 +1,209 @@ +--- +description: Learn how to install and run Azure PowerShell on Windows. You can install Azure PowerShell on Windows with one command. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Install Azure PowerShell on Windows | Microsoft Docs +zone_pivot_group_filename: azure/zone-pivot-groups.json +zone_pivot_groups: install-azps-windows +--- + +# Install Azure PowerShell on Windows + +The Azure PowerShell Az module is a rollup module. Installing the Az PowerShell module downloads the +generally available modules and makes their cmdlets available for use. + +The recommended installation method and PowerShell version for the Az PowerShell module: + +- Install from the PowerShell Gallery +- Use with PowerShell version 7 or higher + +::: zone pivot="windows-psgallery" + +This article explains how to install the Az PowerShell module on Windows from the +[PowerShell Gallery](/powershell/scripting/gallery/overview). + +## Prerequisites + +- Run the following command from PowerShell to determine your PowerShell version: + + ```powershell + $PSVersionTable.PSVersion + ``` + +- Determine if you have the AzureRM PowerShell module installed: + + ```powershell + Get-Module -Name AzureRM -ListAvailable + ``` + + > [!IMPORTANT] + > If you have the AzureRM PowerShell module installed, see + > [Az and AzureRM coexistence](troubleshooting.md#az-and-azurerm-coexistence) before proceeding. + +# [PowerShell 7](#tab/powershell) + +- Install a supported version of + [PowerShell version 7 or higher](/powershell/scripting/install/installing-powershell-on-windows) + +# [Windows PowerShell](#tab/windowspowershell) + +- Update to + [Windows PowerShell 5.1](/powershell/scripting/windows-powershell/install/installing-windows-powershell#upgrading-existing-windows-powershell) +- Install [.NET Framework 4.7.2 or later](/dotnet/framework/install) +- Update PowerShellGet + + Launch Windows PowerShell 5.1 elevated as an administrator and run the following command to + update PowerShellGet: + + ```powershell + Install-Module -Name PowerShellGet -Force + ``` + +--- + +- Set the PowerShell execution policy to remote signed or less restrictive + + - Check the PowerShell execution policy: + + ```powershell + Get-ExecutionPolicy -List + ``` + + - Set the PowerShell execution policy to remote signed: + + ```powershell + Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser + ``` + + For more information about execution policies, see + [about_Execution_Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). + +## Installation + +Use the [Install-Module](/powershell/module/powershellget/install-module) cmdlet to install the Az +PowerShell module: + +```powershell +Install-Module -Name Az -Repository PSGallery -Force +``` + +## Update the Az PowerShell module + +Use [Update-Module](/powershell/module/powershellget/update-module) to update to the latest version +of the Az PowerShell module: + +```powershell +Update-Module -Name Az -Force +``` + +Updating the Az PowerShell module using `Update-Module` doesn't remove old versions of the Az +PowerShell module from your system. + +## Uninstallation + +To remove the Az PowerShell module, see +[Uninstall the Azure PowerShell module](uninstall-az-ps.md). + +::: zone-end + +::: zone pivot="windows-msi" + +This article explains how to install the Az PowerShell module on Windows using an MSI installer. The +MSI installer is provided for environments where the PowerShell Gallery may be blocked by a +firewall, or an offline installer is needed. + +> [!IMPORTANT] +> The MSI installation option can only be used to install the Az PowerShell module for use with +> Windows PowerShell 5.1. + +## Prerequisites + +- Run the following command from PowerShell to determine your PowerShell version: + + ```powershell + $PSVersionTable.PSVersion + ``` + +- Determine if you have the AzureRM PowerShell module installed + + ```powershell + Get-Module -Name AzureRM -ListAvailable + ``` + + > [!IMPORTANT] + > If you have the AzureRM PowerShell module installed, see + > [Az and AzureRM coexistence](troubleshooting.md#az-and-azurerm-coexistence) before proceeding. + +- Update to + [Windows PowerShell 5.1](/powershell/scripting/windows-powershell/install/installing-windows-powershell#upgrading-existing-windows-powershell) +- Install [.NET Framework 4.7.2 or later](/dotnet/framework/install) + +- Set the PowerShell script execution to remote signed or less restrictive + + - Check the PowerShell execution policy: + + ```powershell + Get-ExecutionPolicy -List + ``` + + - Set the PowerShell execution policy to remote signed: + + ```powershell + Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser + ``` + + For more information about execution policies, see + [about_Execution_Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). + +## Installation and update + +The MSI package for Azure PowerShell is available from +[GitHub](https://github.com/Azure/azure-powershell/releases): + +1. Visit + [github.com/Azure/azure-powershell/releases](https://github.com/Azure/azure-powershell/releases) +1. Locate the most recent Az PowerShell module. They are listed chronologically with no name. For example, `9.5.0` +1. Scroll down to the end of the patch notes and click the arrow next to "Assets" to reveal the + MSI options. +1. Click on the Az-Cmdlets MSI of your choice to start the download + +The installer automatically removes older versions of the Az PowerShell module that were installed +using an MSI. The MSI package installs modules in `"${env:ProgramFiles}\WindowsPowerShell\Modules"` + +::: zone-end + +## Sign in + +To start managing your Azure resources with the Az PowerShell module, launch a PowerShell session +and run `Connect-AzAccount` to sign in to Azure: + +```azurepowershell +Connect-AzAccount +``` + +Use your Azure account login credentials to log into the browser window that opens. + +You'll need to repeat this step for every new PowerShell session you start. To learn how to persist +your Azure sign-in across PowerShell sessions, see +[Azure PowerShell context objects](context-persistence.md). + +## Troubleshooting + +For solutions to common installation issues with the Az PowerShell module, see +[Troubleshoot installation problems with the Azure Az PowerShell module](troubleshooting.md#installation). + +## Provide feedback + +To file an issue about the Az PowerShell module, see: +[file an issue on GitHub](https://github.com/Azure/azure-powershell/issues) + +To provide feedback from within a PowerShell session, use the +[Send-Feedback](/powershell/module/az.accounts/send-feedback) cmdlet. + +## Next Steps + +To learn more about managing your Azure resources with the Az PowerShell module, see +[Get Started with Azure PowerShell](get-started-azureps.md). diff --git a/docs-conceptual/azps-10.1.0/install-azure-powershell.md b/docs-conceptual/azps-10.1.0/install-azure-powershell.md new file mode 100644 index 0000000000..421b7026d3 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/install-azure-powershell.md @@ -0,0 +1,40 @@ +--- +description: Azure PowerShell is available to install for Windows, Linux, and macOS. It can also be run from Azure Cloud Shell and in a Docker container. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: How to install Azure PowerShell +--- + +# How to install Azure PowerShell + +The Azure PowerShell Az module is a rollup module. Installing the Az PowerShell module downloads the +generally available modules and makes their cmdlets available for use. + +## Install + +[!INCLUDE [current-version](../includes/current-version.md)] For information about the latest +release, see the [release notes](release-notes-azureps.md). + +- [Install on Windows](install-azps-windows.md) +- [Install on Linux](install-azps-linux.md) +- [Install on macOS](install-azps-macos.md) +- [Run in Azure Cloud Shell](https://shell.azure.com/) +- [Run in Docker container](azureps-in-docker.md) + +A supported version of +[PowerShell version 7 or higher](/powershell/scripting/install/installing-powershell-on-windows) is +the recommended version of PowerShell for use with the Az PowerShell module on all platforms +including Windows, Linux, and macOS. + +The Az PowerShell module is preinstalled in Azure [Cloud Shell](/azure/cloud-shell/overview) and in +[Docker images](azureps-in-docker.md). + +## See also + +- [What is Azure PowerShell](what-is-azure-powershell.md) +- [Get started with Azure PowerShell](get-started-azureps.md) +- [Versioning, release cadence, and breaking changes](azps-versioning-release-cadence.md) +- [Support Lifecycle](azureps-support-lifecycle.md) diff --git a/docs-conceptual/azps-10.1.0/manage-azure-resources-invoke-azrestmethod.md b/docs-conceptual/azps-10.1.0/manage-azure-resources-invoke-azrestmethod.md new file mode 100644 index 0000000000..d064bfc014 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/manage-azure-resources-invoke-azrestmethod.md @@ -0,0 +1,134 @@ +--- +description: How to use Azure PowerShell to manage resources with the Invoke-AzRestMethod cmdlet. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Manage Azure resources with Invoke-AzRestMethod +--- + +# Manage Azure resources with Invoke-AzRestMethod + +[Invoke-AzRestMethod](/powershell/module/az.accounts/invoke-azrestmethod) is an Azure PowerShell +cmdlet that was introduced in Az PowerShell module version 4.4.0. It allows you to make custom HTTP +requests to the Azure Resource Manager (ARM) endpoint using the Az context. + +This cmdlet is useful when you want to manage Azure services for features that aren't yet available +in the Az PowerShell module. + +## How to use Invoke-AzRestMethod + +As an example, you can allow access to Azure Container Registry (ACR) only for specific networks or +deny public access. As of Az PowerShell module version 4.5.0, that feature isn't available yet in +the [Az.ContainerRegistry PowerShell module](/powershell/module/Az.ContainerRegistry/). However, it +can be managed in the interim with `Invoke-AzRestMethod`. + +## Using Invoke-AzRestMethod with GET operations + +The following example demonstrates how to use the `Invoke-AzRestMethod` cmdlet with a GET operation: + +```azurepowershell-interactive +$getParams = @{ + ResourceGroupName = 'myresourcegroup' + ResourceProviderName = 'Microsoft.ContainerRegistry' + ResourceType = 'registries' + Name = 'myacr' + ApiVersion = '2019-12-01-preview' + Method = 'GET' +} +Invoke-AzRestMethod @getParams +``` + +To allow maximum flexibility, most of the parameters for `Invoke-AzRestMethod` are optional. +However, when you're managing resources within a resource group, you'll need to provide either the +full ID to the resource or parameters like resource group, resource provider, and resource type. + +The `ResourceType` and `Name` parameters can take multiple values when targeting resources that +require more than one name. For example, to manipulate a saved search in a Log Analytics workspace, +the parameters look like the following example: +`-ResourceType @('workspaces', 'savedsearches') -Name @('my-la', 'my-search')`. + +Using a mapping based on the position in the array, the cmdlet constructs the following resource: +`Id:'/workspaces/my-la/savedsearches/my-search'`. + +The `APIVersion` parameter allows you to use a specific API version, including preview ones. The +supported API versions for Azure Resource providers can be found in the +[azure-rest-api-specs](https://github.com/Azure/azure-rest-api-specs) GitHub repository. + +You can find the definition for the `2019-12-01-preview` ACR API version in the following location: +[azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/](https://github.com/Azure/azure-rest-api-specs/tree/master/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview). + +## Using Invoke-AzRestMethod with PATCH operations + +You can disable public access to the existing ACR named `myacr` in the `myresourcegroup` resource +group using the `Invoke-AzRestMethod` cmdlet. + +To disable the public network access, you need to make a **PATCH** call to the API that changes the +value of the `publicNetwokAccess` parameter as shown in the following example: + +```azurepowershell-interactive +$patchParams = @{ + ResourceGroupName = 'myresourcegroup' + Name = 'myacr' + ResourceProviderName = 'Microsoft.ContainerRegistry' + ResourceType = 'registries' + ApiVersion = '2019-12-01-preview' + Payload = '{ "properties": { + "publicNetworkAccess": "Disabled" + } }' + Method = 'PATCH' +} +Invoke-AzRestMethod @patchParams +``` + +The `Payload` property is a JSON string that shows the path of the property to be modified. + +All the parameters for this API are described in the **rest-api-spec** file associated with this API. +The specific definition for the publicNetworkAccess parameter can be found in the +[container registry JSON file](https://github.com/Azure/azure-rest-api-specs/blob/2a9da9a79d0a7b74089567ec4f0289f3e0f31bec/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-12-01-preview/containerregistry.json) +for the `2019-12-01-preview` API version. + +To only allow access to the registry from a specific IP address, the payload needs to be modified as +shown in the following example: + +```azurepowershell-interactive +$specificIpParams = @{ + ResourceGroupName = 'myresourcegroup' + Name = 'myacr' + ResourceProviderName = 'Microsoft.ContainerRegistry' + ResourceType = 'registries' + ApiVersion = '2019-12-01-preview' + Payload = '{ "properties": { + "networkRuleSet": { + "defaultAction": "Deny", + "ipRules": [ { + "action": "Allow", + "value": "24.22.123.123" + } ] + } + } }' + Method = 'PATCH' +} +Invoke-AzRestMethod @specificIpParams +``` + +## Comparison to Get-AzResource, New-AzResource, and Remove-AzResource + +The `*-AzResource` cmdlets allow you to customize the REST API call to Azure by specifying the +resource type, the API version, and the properties to be updated. However, the properties need to be +created first as a `PSObject`. This process adds an additional level of complexity and can become +complicated. + +`Invoke-AzRestMethod` offers a way to manage Azure resources. As shown in the previous example, you +can build a JSON string and use it to customize the REST API call without having to pre-create any +`PSObjects`. + +If you're already familiar with the `*-AzResource` cmdlets, you can continue using them. We've no +plans to stop supporting them. With `Invoke-AzRestMethod`, we've added a new cmdlet to your toolkit. + +## See Also + +- [Get-AzResource](/powershell/module/az.resources/get-azresource) +- [New-AzResource](/powershell/module/az.resources/new-azresource) +- [Remove-AzResource](/powershell/module/az.resources/remove-azresource) diff --git a/docs-conceptual/azps-10.1.0/manage-subscriptions-azureps.md b/docs-conceptual/azps-10.1.0/manage-subscriptions-azureps.md new file mode 100644 index 0000000000..6ce48f25b2 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/manage-subscriptions-azureps.md @@ -0,0 +1,56 @@ +--- +description: Manage Azure subscriptions with Azure PowerShell +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Manage Azure subscriptions with Azure PowerShell +--- + +# Use multiple Azure subscriptions + +Most Azure users only have a single subscription. However, if you are part of more than one +organization or your organization has divided up access to certain resources across groupings, you +may have multiple subscriptions within Azure. + +For detailed information on subscriptions, billing, and cost management, see the +[billing and cost management documentation](/azure/billing/). + +## Tenants, users, and subscriptions + +You might have some confusion over the difference between tenants, users, and subscriptions within +Azure. A _tenant_ is the Azure Active Directory entity that encompasses a whole organization. This +tenant has at least one _subscription_ and _user_. A user is an individual and is associated with +only one tenant, the organization that they belong to. Users are those accounts that sign in to +Azure to create, manage, and use resources. A user may have access to multiple _subscriptions_, +which are the agreements with Microsoft to use cloud services, including Azure. Every resource is +associated with a subscription. + +To learn more about the differences between tenants, users, and subscriptions, see the +[Azure cloud terminology dictionary](/azure/azure-glossary-cloud-terminology). To learn how to add a +new subscription to your Azure Active Directory tenant, see +[Associate or add an Azure subscription to your Azure Active Directory tenant](/azure/active-directory/active-directory-how-subscriptions-associated-directory). +To learn how to sign in to a specific tenant, see +[Sign in with Azure PowerShell](/powershell/azure/authenticate-azureps). + +## Change the active subscription + +In Azure PowerShell, accessing the resources for a subscription requires changing the subscription +associated with your current Azure session. This is done by modifying the active session context, +the information about which tenant, subscription, and user cmdlets should be run against. In order +to change subscriptions, you use the [Set-AzContext](/powershell/module/az.accounts/set-azcontext) +cmdlet to change the current context. + +The following example shows how to change the context in your current Azure session: + +```azurepowershell-interactive +Set-AzContext -Subscription <subscription name or id> +``` + +You can use the [Get-AzSubscription](/powershell/module/az.accounts/get-azsubscription) cmdlet to +retrieve a list of your Azure subscriptions. + +To learn more about Azure PowerShell contexts, including how to save them and switch between them +for working with multiple subscriptions, see +[Persist credentials with Azure PowerShell contexts](context-persistence.md). diff --git a/docs-conceptual/azps-10.1.0/migrate-az-1.0.0.md b/docs-conceptual/azps-10.1.0/migrate-az-1.0.0.md new file mode 100644 index 0000000000..cedaeb08d3 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/migrate-az-1.0.0.md @@ -0,0 +1,462 @@ +--- +description: This migration guide contains a list of breaking changes made to Azure PowerShell in the Az version 1 release. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: All changes from AzureRM to Azure PowerShell Az 1.0.0 +--- +# Breaking changes for Az 1.0.0 + +This document provides detailed information on the changes between AzureRM 6.x and the new Az +module, version 1.x and later. The table of contents will help guide you through a full migration +path, including module-specific changes that may affect your scripts. + +For general advice on getting started with a migration from AzureRM to Az, see [Start migration from +AzureRM to Az](migrate-from-azurerm-to-az.md). + +> [!IMPORTANT] +> There have been breaking changes between Az 1.0.0 and Az 2.0.0 as well. After following this guide +> for updating from AzureRM to Az, see the [Az 2.0.0 breaking changes](migrate-az-2.0.0.md) to find out +> if you need to make additional changes. + +## Table of Contents + +- [General breaking changes](#general-breaking-changes) + - [Cmdlet noun prefix changes](#cmdlet-noun-prefix-changes) + - [Module name changes](#module-name-changes) + - [Removed modules](#removed-modules) + - [Windows PowerShell 5.1 and .NET 4.7.2](#windows-powershell-51-and-net-472) + - [Temporary removal of user login using PSCredential](#temporary-removal-of-user-login-using-pscredential) + - [Default device code login instead of web browser prompt](#default-device-code-login-instead-of-web-browser-prompt) +- [Module breaking changes](#module-breaking-changes) + - [Az.ApiManagement (previously AzureRM.ApiManagement)](#azapimanagement-previously-azurermapimanagement) + - [Az.Billing (previously AzureRM.Billing, AzureRM.Consumption, and AzureRM.UsageAggregates)](#azbilling-previously-azurermbilling-azurermconsumption-and-azurermusageaggregates) + - [Az.CognitiveServices (previously AzureRM.CognitiveServices)](#azcognitiveservices-previously-azurermcognitiveservices) + - [Az.Compute (previously AzureRM.Compute)](#azcompute-previously-azurermcompute) + - [Az.DataFactory (previously AzureRM.DataFactories and AzureRM.DataFactoryV2)](#azdatafactory-previously-azurermdatafactories-and-azurermdatafactoryv2) + - [Az.DataLakeAnalytics (previously AzureRM.DataLakeAnalytics)](#azdatalakeanalytics-previously-azurermdatalakeanalytics) + - [Az.DataLakeStore (previously AzureRM.DataLakeStore)](#azdatalakestore-previously-azurermdatalakestore) + - [Az.KeyVault (previously AzureRM.KeyVault)](#azkeyvault-previously-azurermkeyvault) + - [Az.Media (previously AzureRM.Media)](#azmedia-previously-azurermmedia) + - [Az.Monitor (previously AzureRM.Insights)](#azmonitor-previously-azurerminsights) + - [Az.Network (previously AzureRM.Network)](#aznetwork-previously-azurermnetwork) + - [Az.OperationalInsights (previously AzureRM.OperationalInsights)](#azoperationalinsights-previously-azurermoperationalinsights) + - [Az.RecoveryServices (previously AzureRM.RecoveryServices, AzureRM.RecoveryServices.Backup, and AzureRM.RecoveryServices.SiteRecovery)](#azrecoveryservices-previously-azurermrecoveryservices-azurermrecoveryservicesbackup-and-azurermrecoveryservicessiterecovery) + - [Az.Resources (previously AzureRM.Resources)](#azresources-previously-azurermresources) + - [Az.ServiceFabric (previously AzureRM.ServiceFabric)](#azservicefabric-previously-azurermservicefabric) + - [Az.Sql (previously AzureRM.Sql)](#azsql-previously-azurermsql) + - [Az.Storage (previously Azure.Storage and AzureRM.Storage)](#azstorage-previously-azurestorage-and-azurermstorage) + - [Az.Websites (previously AzureRM.Websites)](#azwebsites-previously-azurermwebsites) + +## General breaking changes + +This section details the general breaking changes that are part of the redesign of the Az module. + +### Cmdlet Noun Prefix Changes + +In the AzureRM module, cmdlets used either `AzureRM` or `Azure` as a noun prefix. Az simplifies and normalizes cmdlet names, so that all cmdlets use 'Az' as their cmdlet noun prefix. For example: + +```azurepowershell-interactive +Get-AzureRMVM +Get-AzureKeyVaultSecret +``` + +Has changed to: + +```azurepowershell-interactive +Get-AzVM +Get-AzKeyVaultSecret +``` + +To make the transition to these new cmdlet names simpler, Az introduces two new cmdlets, [Enable-AzureRmAlias](/powershell/module/az.accounts/enable-azurermalias) and [Disable-AzureRmAlias](/powershell/module/az.accounts/disable-azurermalias). `Enable-AzureRmAlias` creates aliases for the older cmdlet names in AzureRM that map to the newer Az cmdlet names. Using the `-Scope` argument with `Enable-AzureRmAlias` allows you to choose where aliases are enabled. + +For example, the following script in AzureRM: + +```azurepowershell-interactive +#Requires -Modules AzureRM.Storage +Get-AzureRmStorageAccount | Get-AzureStorageContainer | Get-AzureStorageBlob +``` + +Can be run with minimal changes using `Enable-AzureRmAlias`: + +```azurepowershell-interactive +#Requires -Modules Az.Storage +Enable-AzureRmAlias -Scope Process +Get-AzureRmStorageAccount | Get-AzureStorageContainer | Get-AzureStorageBlob +``` + +Running `Enable-AzureRmAlias -Scope CurrentUser` will enable the aliases for all PowerShell sessions you open, so that after executing this cmdlet, a script like this would not need to be changed at all: + +```azurepowershell-interactive +Get-AzureRmStorageAccount | Get-AzureStorageContainer | Get-AzureStorageBlob +``` + +For complete details on the usage of the alias cmdlets, see the [Enable-AzureRmAlias reference](/powershell/module/az.accounts/enable-azurermalias). + +When you're ready to disable aliases, `Disable-AzureRmAlias` removes the created aliases. For complete details, +see the [Disable-AzureRmAlias reference](/powershell/module/az.accounts/disable-azurermalias). + +> [!IMPORTANT] +> When disabling aliases, make sure that they are disabled for _all_ scopes which had aliases enabled. + +### Module Name Changes + +The module names have changed from `AzureRM.*` to `Az.*`, except for the following modules: + +| AzureRM module | Az module | +|----------------|-----------| +| Azure.Storage | Az.Storage | +| Azure.AnalysisServices | Az.AnalysisServices | +| AzureRM.Profile | Az.Accounts | +| AzureRM.Insights | Az.Monitor | +| AzureRM.DataFactories | Az.DataFactory | +| AzureRM.DataFactoryV2 | Az.DataFactory | +| AzureRM.RecoveryServices.Backup | Az.RecoveryServices | +| AzureRM.RecoveryServices.SiteRecovery | Az.RecoveryServices | +| AzureRM.Tags | Az.Resources | +| AzureRM.MachineLearningCompute | Az.MachineLearning | +| AzureRM.UsageAggregates | Az.Billing | +| AzureRM.Consumption | Az.Billing | + +The changes in module names mean that any script that uses `#Requires` or `Import-Module` to load specific modules will need to be changed to use the new module instead. For modules where the cmdlet suffix has not changed, +this means that although the module name has changed, the suffix indicating the operation space has _not_. + +#### Migrating #Requires and Import-Module Statements + +Scripts that use `#Requires` or `Import-Module` to declare a dependency on AzureRM modules must be updated to use the new module names. For example: + +```azurepowershell-interactive +#Requires -Module AzureRM.Compute +``` + +Should be changed to: + +```azurepowershell-interactive +#Requires -Module Az.Compute +``` + +For `Import-Module`: + +```azurepowershell-interactive +Import-Module -Name AzureRM.Compute +``` + +Should be changed to: + +```azurepowershell-interactive +Import-Module -Name Az.Compute +``` + +### Migrating Fully-Qualified Cmdlet Invocations + +Scripts that use module-qualified cmdlet invocations, such as: + +```azurepowershell-interactive +AzureRM.Compute\Get-AzureRmVM +``` + +Must be changed to use the new module and cmdlet names: + +```azurepowershell-interactive +Az.Compute\Get-AzVM +``` + +### Migrating module manifest dependencies + +Modules that express dependencies on AzureRM modules through a module manifest (.psd1) file will need to updated the module names in their `RequiredModules` section: + +```powershell +RequiredModules = @(@{ModuleName="AzureRM.Profile"; ModuleVersion="5.8.2"}) +``` + +Must be changed to: + +```powershell +RequiredModules = @(@{ModuleName="Az.Profile"; ModuleVersion="1.0.0"}) +``` + +### Removed modules + +The following modules have been removed: + +- `AzureRM.Backup` +- `AzureRM.Compute.ManagedService` +- `AzureRM.Scheduler` + +The tools for these services are no longer actively supported. Customers are encouraged to move to alternative services as soon as it is convenient. + +### Windows PowerShell 5.1 and .NET 4.7.2 + +Using Az with PowerShell 5.1 for Windows requires the installation of .NET Framework 4.7.2. Using PowerShell +Core 6.x or later does not require .NET Framework. + +### Temporary removal of User login using PSCredential + +Due to changes in the authentication flow for .NET Standard, we are temporarily removing user login via PSCredential. This capability will be re-introduced in the 1/15/2019 release for PowerShell 5.1 for Windows. This is discussed in detail in [this GitHub issue.](https://github.com/Azure/azure-powershell/issues/7430) + +### Default device code login instead of web browser prompt + +Due to changes in the authentication flow for .NET Standard, we are using device login as the default login flow during interactive login. Web browser based login will be re-introduced for PowerShell 5.1 for Windows as the default in the 1/15/2019 release. At that time, users will be able to choose device login using a Switch parameter. + +## Module breaking changes + +This section details specific breaking changes for individual modules and cmdlets. + +### Az.ApiManagement (previously AzureRM.ApiManagement) + +- Removed the following cmdlets: + - New-AzureRmApiManagementHostnameConfiguration + - Set-AzureRmApiManagementHostnames + - Update-AzureRmApiManagementDeployment + - Import-AzureRmApiManagementHostnameCertificate + - Use **Set-AzApiManagement** cmdlet to set these properties instead +- Removed the following properties: + - Removed property `PortalHostnameConfiguration`, `ProxyHostnameConfiguration`, `ManagementHostnameConfiguration` and `ScmHostnameConfiguration` of type `PsApiManagementHostnameConfiguration` from `PsApiManagementContext`. Instead use `PortalCustomHostnameConfiguration`, `ProxyCustomHostnameConfiguration`, `ManagementCustomHostnameConfiguration` and `ScmCustomHostnameConfiguration` of type `PsApiManagementCustomHostNameConfiguration`. + - Removed property `StaticIPs` from PsApiManagementContext. The property has been split into `PublicIPAddresses` and `PrivateIPAddresses`. + - Removed required property `Location` from New-AzureApiManagementVirtualNetwork cmdlet. + +### Az.Billing (previously AzureRM.Billing, AzureRM.Consumption, and AzureRM.UsageAggregates) + +- The `InvoiceName` parameter was removed from the `Get-AzConsumptionUsageDetail` cmdlet. Scripts will need to use other identity parameters for the invoice. + +### Az.CognitiveServices (previously AzureRM.CognitiveServices) + +- Removed `GetSkusWithAccountParamSetName` parameter set from `Get-AzCognitiveServicesAccountSkus` cmdlet. You must get Skus by Account Type and Location, instead of using ResourceGroupName and Account Name. + +### Az.Compute (previously AzureRM.Compute) + +- `IdentityIds` are removed from `Identity` property in `PSVirtualMachine` and `PSVirtualMachineScaleSet` objects + Scripts should no longer use the value of this field to make processing decisions. +- The type of `InstanceView` property of `PSVirtualMachineScaleSetVM` object is changed from `VirtualMachineInstanceView` to `VirtualMachineScaleSetVMInstanceView` +- `AutoOSUpgradePolicy` and `AutomaticOSUpgrade` properties are removed from `UpgradePolicy` property +- The type of `Sku` property in `PSSnapshotUpdate` object is changed from `DiskSku` to `SnapshotSku` +- `VmScaleSetVMParameterSet` is removed from `Add-AzVMDataDisk` cmdlet, you can no longer add a data disk individually to a ScaleSet VM. + +### Az.DataFactory (previously AzureRM.DataFactories and AzureRM.DataFactoryV2) + +- The `GatewayName` parameter has become mandatory in the `New-AzDataFactoryEncryptValue` cmdlet +- Removed `New-AzDataFactoryGatewayKey` cmdlet +- Removed `LinkedServiceName` parameter from `Get-AzDataFactoryV2ActivityRun` cmdlet + Scripts should no longer use the value of this field to make processing decisions. + +### Az.DataLakeAnalytics (previously AzureRM.DataLakeAnalytics) + +- Removed deprecated cmdlets: `New-AzDataLakeAnalyticsCatalogSecret`, `Remove-AzDataLakeAnalyticsCatalogSecret`, and `Set-AzDataLakeAnalyticsCatalogSecret` + +### Az.DataLakeStore (previously AzureRM.DataLakeStore) + +- The following cmdlets have had the `Encoding` parameter changed from the type `FileSystemCmdletProviderEncoding` to `System.Text.Encoding`. This change removes the encoding values `String` and `Oem`. All the other prior encoding values remain. + - New-AzureRmDataLakeStoreItem + - Add-AzureRmDataLakeStoreItemContent + - Get-AzureRmDataLakeStoreItemContent +- Removed deprecated `Tags` property alias from `New-AzDataLakeStoreAccount` and `Set-AzDataLakeStoreAccount` cmdlets + + Scripts using + ```azurepowershell-interactive + New-AzureRMDataLakeStoreAccount -Tags @{TagName="TagValue"} + ``` + + Should be changed to + ```azurepowershell-interactive + New-AzDataLakeStoreAccount -Tag @{TagName="TagValue"} + ``` + +- Removed deprecated properties `Identity`, `EncryptionState`, `EncryptionProvisioningState`, `EncryptionConfig`, `FirewallState`, `FirewallRules`, `VirtualNetworkRules`, `TrustedIdProviderState`, `TrustedIdProviders`, `DefaultGroup`, `NewTier`, `CurrentTier`, `FirewallAllowAzureIps` from `PSDataLakeStoreAccountBasic` object. Any script that +uses the `PSDatalakeStoreAccount` returned from `Get-AzDataLakeStoreAccount` should not reference these properties. + +### Az.KeyVault (previously AzureRM.KeyVault) + +- The `PurgeDisabled` property was removed from the `PSKeyVaultKeyAttributes`, `PSKeyVaultKeyIdentityItem`, and `PSKeyVaultSecretAttributes` objects + Scripts should no longer reference the ```PurgeDisabled``` property to make processing decisions. + +### Az.Media (previously AzureRM.Media) + +- Remove deprecated `Tags` property alias from `New-AzMediaService` cmdlet + Scripts using + ```azurepowershell-interactive + New-AzureRMMediaService -Tags @{TagName="TagValue"} + ``` + + Should be changed to + ```azurepowershell-interactive + New-AzMediaService -Tag @{TagName="TagValue"} + ``` + +### Az.Monitor (previously AzureRM.Insights) + +- Removed plural names `Categories` and `Timegrains` parameter in favor of singular parameter names from `Set-AzDiagnosticSetting` cmdlet + Scripts using + ```azurepowershell-interactive + Set-AzureRmDiagnosticSetting -Timegrains PT1M -Categories Category1, Category2 + ``` + + Should be changed to + ```azurepowershell-interactive + Set-AzDiagnosticSetting -Timegrain PT1M -Category Category1, Category2 + ``` + +### Az.Network (previously AzureRM.Network) + +- Removed deprecated `ResourceId` parameter from `Get-AzServiceEndpointPolicyDefinition` cmdlet +- Removed deprecated `EnableVmProtection` property from `PSVirtualNetwork` object +- Removed deprecated `Set-AzVirtualNetworkGatewayVpnClientConfig` cmdlet + +Scripts should no longer make processing decisions based on the values fo these fields. + +### Az.OperationalInsights (previously AzureRM.OperationalInsights) + +- Default parameter set for `Get-AzOperationalInsightsDataSource` is removed, and `ByWorkspaceNameByKind` has become the default parameter set + + Scripts that listed data sources using + ```azurepowershell-interactive + Get-AzureRmOperationalInsightsDataSource + ``` + + Should be changed to specify a Kind + ```azurepowershell-interactive + Get-AzOperationalInsightsDataSource -Kind AzureActivityLog + ``` + +### Az.RecoveryServices (previously AzureRM.RecoveryServices, AzureRM.RecoveryServices.Backup, and AzureRM.RecoveryServices.SiteRecovery) + +- Removed `Encryption` parameter from `New/Set-AzRecoveryServicesAsrPolicy` cmdlet +- `TargetStorageAccountName` parameter is now mandatory for managed disk restores in `Restore-AzRecoveryServicesBackupItem` cmdlet +- Removed `StorageAccountName` and `StorageAccountResourceGroupName` parameters in `Restore-AzRecoveryServicesBackupItem` cmdlet +- Removed `Name`parameter in `Get-AzRecoveryServicesBackupContainer` cmdlet + +### Az.Resources (previously AzureRM.Resources) + +- Removed `Sku` parameter from `New/Set-AzPolicyAssignment` cmdlet +- Removed `Password` parameter from `New-AzADServicePrincipal` and `New-AzADSpCredential` cmdlet + Passwords are automatically generated, scripts that provided the password: + + ```azurepowershell-interactive + New-AzAdSpCredential -ObjectId 1f99cf81-0146-4f4e-beae-2007d0668476 -Password $secPassword + ``` + + Should be changed to retrieve the password from the output: + + ```azurepowershell-interactive + $credential = New-AzAdSpCredential -ObjectId 1f99cf81-0146-4f4e-beae-2007d0668476 + $secPassword = $credential.Secret + ``` + +### Az.ServiceFabric (previously AzureRM.ServiceFabric) + +- The following cmdlet return types have been changed: + - The property `ServiceTypeHealthPolicies` of type `ApplicationHealthPolicy` has been removed. + - The property `ApplicationHealthPolicies` of type `ClusterUpgradeDeltaHealthPolicy` has been removed. + - The property `OverrideUserUpgradePolicy` of type `ClusterUpgradePolicy` has been removed. + - These changes affect the following cmdlets: + - Add-AzServiceFabricClientCertificate + - Add-AzServiceFabricClusterCertificate + - Add-AzServiceFabricNode + - Add-AzServiceFabricNodeType + - Get-AzServiceFabricCluster + - Remove-AzServiceFabricClientCertificate + - Remove-AzServiceFabricClusterCertificate + - Remove-AzServiceFabricNode + - Remove-AzServiceFabricNodeType + - Remove-AzServiceFabricSetting + - Set-AzServiceFabricSetting + - Set-AzServiceFabricUpgradeType + - Update-AzServiceFabricDurability + - Update-AzServiceFabricReliability + +### Az.Sql (previously AzureRM.Sql) + +- Removed `State` and `ResourceId` parameters from `Set-AzSqlDatabaseBackupLongTermRetentionPolicy` cmdlet +- Removed deprecated cmdlets: `Get/Set-AzSqlServerBackupLongTermRetentionVault`, `Get/Start/Stop-AzSqlServerUpgrade`, `Get/Set-AzSqlDatabaseAuditingPolicy`, `Get/Set-AzSqlServerAuditingPolicy`, `Remove-AzSqlDatabaseAuditing`, `Remove-AzSqlServerAuditing` +- Removed deprecated parameter `Current` from `Get-AzSqlDatabaseBackupLongTermRetentionPolicy` cmdlet +- Removed deprecated parameter `DatabaseName` from `Get-AzSqlServerServiceObjective` cmdlet +- Removed deprecated parameter `PrivilegedLogin` from `Set-AzSqlDatabaseDataMaskingPolicy` cmdlet + +### Az.Storage (previously Azure.Storage and AzureRM.Storage) + +- To support creating an Oauth storage context with only the storage account name, the default parameter set has been changed to `OAuthParameterSet` + - Example: `$ctx = New-AzureStorageContext -StorageAccountName $accountName` +- The `Location` parameter has become mandatory in the `Get-AzStorageUsage` cmdlet +- The Storage API methods now use the Task-based Asynchronous Pattern (TAP), instead of synchronous API calls. The following examples demonstrate the new asynchronous commands: + +#### Blob Snapshot + +AzureRM: + +```azurepowershell-interactive +$b = Get-AzureStorageBlob -Container $containerName -Blob $blobName -Context $ctx +$b.ICloudBlob.Snapshot() +``` + +Az: + +```azurepowershell-interactive +$b = Get-AzStorageBlob -Container $containerName -Blob $blobName -Context $ctx +$task = $b.ICloudBlob.SnapshotAsync() +$task.Wait() +$snapshot = $task.Result +``` + +#### Share Snapshot + +AzureRM: + +```azurepowershell-interactive +$Share = Get-AzureStorageShare -Name $containerName -Context $ctx +$snapshot = $Share.Snapshot() +``` + +Az: + +```azurepowershell-interactive +$Share = Get-AzStorageShare -Name $containerName -Context $ctx +$task = $Share.SnapshotAsync() +$task.Wait() +$snapshot = $task.Result +``` + +#### Undelete soft-deleted blob + +AzureRM: + +```azurepowershell-interactive +$b = Get-AzureStorageBlob -Container $containerName -Blob $blobName -IncludeDeleted -Context $ctx +$b.ICloudBlob.Undelete() +``` + +Az: + +```azurepowershell-interactive +$b = Get-AzStorageBlob -Container $containerName -Blob $blobName -IncludeDeleted -Context $ctx +$task = $b.ICloudBlob.UndeleteAsync() +$task.Wait() +``` + +#### Set Blob Tier + +AzureRM: + +```azurepowershell-interactive +$blockBlob = Get-AzureStorageBlob -Container $containerName -Blob $blockBlobName -Context $ctx +$blockBlob.ICloudBlob.SetStandardBlobTier("hot") + +$pageBlob = Get-AzureStorageBlob -Container $containerName -Blob $pageBlobName -Context $ctx +$pageBlob.ICloudBlob.SetPremiumBlobTier("P4") +``` + +Az: + +```azurepowershell-interactive +$blockBlob = Get-AzStorageBlob -Container $containerName -Blob $blockBlobName -Context $ctx +$task = $blockBlob.ICloudBlob.SetStandardBlobTierAsync("hot") +$task.Wait() + +$pageBlob = Get-AzStorageBlob -Container $containerName -Blob $pageBlobName -Context $ctx +$task = $pageBlob.ICloudBlob.SetPremiumBlobTierAsync("P4") +$task.Wait() +``` + +### Az.Websites (previously AzureRM.Websites) + +- Removed deprecated properties from the `PSAppServicePlan`, `PSCertificate`, `PSCloningInfo`, and `PSSite` objects diff --git a/docs-conceptual/azps-10.1.0/migrate-az-10.0.0.md b/docs-conceptual/azps-10.1.0/migrate-az-10.0.0.md new file mode 100644 index 0000000000..0c98a535b4 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/migrate-az-10.0.0.md @@ -0,0 +1,1641 @@ +--- +description: This migration guide contains a list of breaking changes made to Azure PowerShell in the Az version 10.0.0 release. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Migration guide for Az 10.0.0 +--- + +# Migration Guide for Az 10.0.0 + +## Az.Cdn + +### `Update-AzFrontDoorCdnProfile` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Update-AzCdnProfile` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Update-AzCdnOriginGroup` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Update-AzCdnOrigin` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Update-AzCdnEndpoint` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Stop-AzCdnEndpoint` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Start-AzCdnEndpoint` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `New-AzFrontDoorCdnProfile` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `New-AzCdnProfile` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `New-AzCdnOriginGroup` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `New-AzCdnOrigin` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `New-AzCdnEndpoint` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `New-AzCdnCustomDomain` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Get-AzFrontDoorCdnProfile` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Get-AzCdnSubscriptionResourceUsage` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Get-AzCdnProfileResourceUsage` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Get-AzCdnProfile` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Get-AzCdnOriginGroup` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Get-AzCdnOrigin` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Get-AzCdnEndpointResourceUsage` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Get-AzCdnEndpoint` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Get-AzCdnCustomDomain` +- The output type is changed from 'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20210601.IProfile' to'Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20221101Preview.IProfile' without properties changed. + +### `Enable-AzCdnCustomDomainCustomHttps` +- The cmdlet 'Enable-AzCdnCustomDomainCustomHttps' no longer supports the parameter 'PassThru' and no alias was found for the original parameter name. + +#### Before +```powershell +$customDomainHttpsParameter = New-AzCdnManagedHttpsParametersObject -CertificateSourceParameterCertificateType Dedicated -CertificateSource Cdn -ProtocolType ServerNameIndication +Enable-AzCdnCustomDomainCustomHttps -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -CustomDomainName customdomain001 -CustomDomainHttpsParameter $customDomainHttpsParameter -PassThru + +Output: +True +``` +#### After +```powershell +$customDomainHttpsParameter = New-AzCdnManagedHttpsParametersObject -CertificateSourceParameterCertificateType Dedicated -CertificateSource Cdn -ProtocolType ServerNameIndication +Enable-AzCdnCustomDomainCustomHttps -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -CustomDomainName customdomain001 -CustomDomainHttpsParameter $customDomainHttpsParameter + +Output: +Null +``` + + +### `Disable-AzCdnCustomDomainCustomHttps` +- The cmdlet 'Disable-AzCdnCustomDomainCustomHttps' no longer supports the parameter 'PassThru' and no alias was found for the original parameter name. + +#### Before +```powershell +Disable-AzCdnCustomDomainCustomHttps -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -CustomDomainName customdomain001 -PassThru + +Output: +True +``` +#### After +```powershell +Disable-AzCdnCustomDomainCustomHttps -ResourceGroupName testps-rg-da16jm -ProfileName cdn001 -EndpointName endptest001 -CustomDomainName customdomain001 + +OutPut: +Null +``` + + +## Az.Compute + +### `Get-AzVM` +- The cmdlet 'Get-AzVM' no longer supports the parameter 'NextLink' and no alias was found for the original parameter name. + +#### Before +```powershell +Get-AzVM -NextLink $myUri +``` +#### After +```powershell +Get-AzVM -ResourceGroupName $rgname -Name $vmName +``` + + +## Az.ContainerRegistry + +### `Update-AzContainerRegistryWebhook` +- The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'WebhookUri' for parameter 'Uri'. +- The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'WebhookActions' for parameter 'Action'. +- The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'WebhookHeaders' for parameter 'Header'. +- The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'WebhookStatus' for parameter 'Status'. +- The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'WebhookScope' for parameter 'Scope'. +- The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Update-AzContainerRegistryWebhook' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Update-AzContainerRegistryWebhook -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry/webhooks/webhook001 -Uri http://www.bing.com -Action Delete,Push -Header @{SpecialHeader='headerVal'} -Tag @{Key='val'} -Status Enabled -Scope 'foo:*' +``` +#### After +```powershell +Update-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "webhook001" -Uri http://www.bing.com -Action Delete,Push -Header @{SpecialHeader='headerVal'} -Tag @{Key='val'} -Status Enabled -Scope 'foo:*' +``` + + +### `Update-AzContainerRegistryCredential` +- The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the alias 'RegistryName' for parameter 'Name'. +- The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry' for parameter 'Registry'. +- The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the type 'Microsoft.Azure.Management.ContainerRegistry.Models.PasswordName' for parameter 'PasswordName'. +- The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Update-AzContainerRegistryCredential' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Update-AzContainerRegistryCredential -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry -PasswordName password + +``` +#### After +```powershell +Update-AzContainerRegistryCredential -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -PasswordName Password +``` + + +### `Update-AzContainerRegistry` +- The cmdlet 'Update-AzContainerRegistry' no longer has output type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry'. +- The cmdlet 'Update-AzContainerRegistry' no longer supports the alias 'EnableAdmin' for parameter 'EnableAdminUser'. +- The cmdlet 'Update-AzContainerRegistry' no longer supports the parameter 'DisableAdminUser' and no alias was found for the original parameter name. +- The cmdlet 'Update-AzContainerRegistry' no longer supports the parameter 'StorageAccountName' and no alias was found for the original parameter name. +- The cmdlet 'Update-AzContainerRegistry' no longer supports the parameter 'NetworkRuleSet' and no alias was found for the original parameter name. +- The cmdlet 'Update-AzContainerRegistry' no longer supports the alias 'ContainerRegistrySku' for parameter 'Sku'. +- The cmdlet 'Update-AzContainerRegistry' no longer supports the alias 'RegistrySku' for parameter 'Sku'. +- The cmdlet 'Update-AzContainerRegistry' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Update-AzContainerRegistry' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Update-AzContainerRegistry' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Update-AzContainerRegistry' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Update-AzContainerRegistry -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry -EnableAdmin +``` +#### After +```powershell +Update-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "RegistryExample" -EnableAdminUser +``` + + +### `Test-AzContainerRegistryWebhook` +- The cmdlet 'Test-AzContainerRegistryWebhook' no longer has output type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryEventInfo'. +- The cmdlet 'Test-AzContainerRegistryWebhook' no longer supports the type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook' for parameter 'Webhook'. +- The cmdlet 'Test-AzContainerRegistryWebhook' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Test-AzContainerRegistryWebhook' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Test-AzContainerRegistryWebhook' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Test-AzContainerRegistryWebhook' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Test-AzContainerRegistryWebhook -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry/webhooks/webhook001 +``` +#### After +```powershell +Test-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "webhook001" +``` + + +### `Test-AzContainerRegistryNameAvailability` +- The cmdlet 'Test-AzContainerRegistryNameAvailability' no longer supports the alias 'ContainerRegistryName' for parameter 'Name'. +- The cmdlet 'Test-AzContainerRegistryNameAvailability' no longer supports the alias 'RegistryName' for parameter 'Name'. +- The cmdlet 'Test-AzContainerRegistryNameAvailability' no longer supports the alias 'ResourceName' for parameter 'Name'. +- The cmdlet 'Test-AzContainerRegistryNameAvailability' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Test-AzContainerRegistryNameAvailability' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Test-AzContainerRegistryNameAvailability' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Test-AzContainerRegistryNameAvailability -ContainerRegistryName 'SomeRegistryName' +``` +#### After +```powershell +Test-AzContainerRegistryNameAvailability -Name 'SomeRegistryName' +``` + + +### `Set-AzContainerRegistryNetworkRuleSet` +- The cmdlet 'Set-AzContainerRegistryNetworkRuleSet' has been removed and no alias was found for the original cmdlet name. + +### `Remove-AzContainerRegistryWebhook` +- The cmdlet 'Remove-AzContainerRegistryWebhook' no longer supports the parameter 'Webhook' and no alias was found for the original parameter name. +- The cmdlet 'Remove-AzContainerRegistryWebhook' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Remove-AzContainerRegistryWebhook' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzContainerRegistryWebhook' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzContainerRegistryWebhook' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Remove-AzContainerRegistryWebhook -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry/webhooks/webhook001 +``` +#### After +```powershell +Remove-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "webhook001" +``` + + +### `Remove-AzContainerRegistryReplication` +- The cmdlet 'Remove-AzContainerRegistryReplication' no longer supports the parameter 'Replication' and no alias was found for the original parameter name. +- The cmdlet 'Remove-AzContainerRegistryReplication' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Remove-AzContainerRegistryReplication' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzContainerRegistryReplication' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzContainerRegistryReplication' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Remove-AzContainerRegistryReplication -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry/replications/westus +``` +#### After +```powershell +Remove-AzContainerRegistryReplication -Name "NewReplication" -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" +``` + + +### `Remove-AzContainerRegistry` +- The cmdlet 'Remove-AzContainerRegistry' no longer supports the parameter 'Registry' and no alias was found for the original parameter name. +- The cmdlet 'Remove-AzContainerRegistry' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Remove-AzContainerRegistry' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzContainerRegistry' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzContainerRegistry' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Remove-AzContainerRegistry -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry +``` +#### After +```powershell +Remove-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" +``` + + +### `New-AzContainerRegistryWebhook` +- The cmdlet 'New-AzContainerRegistryWebhook' no longer has output type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook'. +- The cmdlet 'New-AzContainerRegistryWebhook' no longer supports the alias 'WebhookUri' for parameter 'Uri'. +- The cmdlet 'New-AzContainerRegistryWebhook' no longer supports the alias 'WebhookActions' for parameter 'Action'. +- The cmdlet 'New-AzContainerRegistryWebhook' no longer supports the alias 'WebhookHeaders' for parameter 'Header'. +- The cmdlet 'New-AzContainerRegistryWebhook' no longer supports the alias 'WebhookStatus' for parameter 'Status'. +- The cmdlet 'New-AzContainerRegistryWebhook' no longer supports the alias 'WebhookScope' for parameter 'Scope'. +- The cmdlet 'New-AzContainerRegistryWebhook' no longer supports the alias 'WebhookLocation' for parameter 'Location'. +- The cmdlet 'New-AzContainerRegistryWebhook' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'New-AzContainerRegistryWebhook' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzContainerRegistryWebhook' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzContainerRegistryWebhook' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +New-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "webhook001" -Uri http://www.bing.com -Action Delete,Push -Header @{SpecialHeader='headerVal'} -Tag @{Key="val"} -Location "east us" -Status WebhookStatus -WebhookScope "foo:*" +``` +#### After +```powershell +New-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "webhook001" -Uri http://www.bing.com -Action Delete,Push -Header @{SpecialHeader='headerVal'} -Tag @{Key="val"} -Location "east us" -Status Enabled -Scope "foo:*" +``` + + +### `New-AzContainerRegistryReplication` +- The cmdlet 'New-AzContainerRegistryReplication' no longer has output type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryReplication'. +- The cmdlet 'New-AzContainerRegistryReplication' no longer supports the type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry' for parameter 'Registry'. +- The cmdlet 'New-AzContainerRegistryReplication' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'New-AzContainerRegistryReplication' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzContainerRegistryReplication' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzContainerRegistryReplication' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +New-AzContainerRegistryReplication -Name replication001 -Location 'west us' -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry +``` +#### After +```powershell +New-AzContainerRegistryReplication -ResourceGroupName "MyResourceGroup" -RegistryName "MyRegistry" -Name replication001 -Location 'west us' +``` + + +### `New-AzContainerRegistryNetworkRule` +- The cmdlet 'New-AzContainerRegistryNetworkRule' has been removed and no alias was found for the original cmdlet name. + +### `New-AzContainerRegistry` +- The cmdlet 'New-AzContainerRegistry' no longer has output type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry'. +- The cmdlet 'New-AzContainerRegistry' no longer supports the alias 'ContainerRegistrySku' for parameter 'Sku'. +- The cmdlet 'New-AzContainerRegistry' no longer supports the alias 'RegistrySku' for parameter 'Sku'. +- The cmdlet 'New-AzContainerRegistry' no longer supports the alias 'EnableAdmin' for parameter 'EnableAdminUser'. +- The cmdlet 'New-AzContainerRegistry' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzContainerRegistry' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzContainerRegistry' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell + New-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "RegistryExample" -ContainerRegistrySku "Basic" -Location "west us" -EnableAdmin +``` +#### After +```powershell + New-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "RegistryExample" -Sku "Basic" -Location "west us" -EnableAdminUser +``` + + +### `Import-AzContainerRegistryImage` +- The cmdlet 'Import-AzContainerRegistryImage' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Import-AzContainerRegistryImage' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Import-AzContainerRegistryImage' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Get-AzContainerRegistryWebhookEvent` +- The cmdlet 'Get-AzContainerRegistryWebhookEvent' no longer has output type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhookEvent'. +- The cmdlet 'Get-AzContainerRegistryWebhookEvent' no longer supports the type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook' for parameter 'Webhook'. +- The cmdlet 'Get-AzContainerRegistryWebhookEvent' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Get-AzContainerRegistryWebhookEvent' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzContainerRegistryWebhookEvent' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzContainerRegistryWebhookEvent' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Get-AzContainerRegistryWebhookEvent -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry/webhooks/webhook001 +``` +#### After +```powershell +Get-AzContainerRegistryWebhookEvent -ResourceGroupName MyResourceGroup -RegistryName RegistryExample -WebhookName webhook001 +``` + + +### `Get-AzContainerRegistryWebhook` +- The cmdlet 'Get-AzContainerRegistryWebhook' no longer has output type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook'. +- The cmdlet 'Get-AzContainerRegistryWebhook' no longer supports the type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry' for parameter 'Registry'. +- The cmdlet 'Get-AzContainerRegistryWebhook' no longer supports the parameter 'IncludeConfiguration' and no alias was found for the original parameter name. +- The cmdlet 'Get-AzContainerRegistryWebhook' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Get-AzContainerRegistryWebhook' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzContainerRegistryWebhook' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzContainerRegistryWebhook' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Get-AzContainerRegistryWebhook -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry/webhooks/webhook001 +``` +#### After +```powershell +Get-AzContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" -Name "webhook001" +``` + + +### `Get-AzContainerRegistryUsage` +- The cmdlet 'Get-AzContainerRegistryUsage' no longer has output type 'Microsoft.Azure.Commands.ContainerRegistry.Models.PSRegistryUsage'. +- The cmdlet 'Get-AzContainerRegistryUsage' no longer supports the alias 'RegistryName' for parameter 'Name'. +- The cmdlet 'Get-AzContainerRegistryUsage' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzContainerRegistryUsage' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzContainerRegistryUsage' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Get-AzContainerRegistryUsage -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry +``` +#### After +```powershell +Get-AzContainerRegistryUsage -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" +``` + + +### `Get-AzContainerRegistryReplication` +- The cmdlet 'Get-AzContainerRegistryReplication' no longer has output type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryReplication'. +- The cmdlet 'Get-AzContainerRegistryReplication' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Get-AzContainerRegistryReplication' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzContainerRegistryReplication' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzContainerRegistryReplication' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Get-AzContainerRegistryReplication -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry/replications/westus +``` +#### After +```powershell + Get-AzContainerRegistryReplication -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" +``` + + +### `Get-AzContainerRegistryCredential` +- The cmdlet 'Get-AzContainerRegistryCredential' no longer supports the alias 'ContainerRegistryName' for parameter 'Name'. +- The cmdlet 'Get-AzContainerRegistryCredential' no longer supports the alias 'RegistryName' for parameter 'Name'. +- The cmdlet 'Get-AzContainerRegistryCredential' no longer supports the alias 'ResourceName' for parameter 'Name'. +- The cmdlet 'Get-AzContainerRegistryCredential' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Get-AzContainerRegistryCredential' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzContainerRegistryCredential' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzContainerRegistryCredential' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell + Get-AzContainerRegistryCredential -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry +``` +#### After +```powershell + Get-AzContainerRegistryCredential -ResourceGroupName "MyResourceGroup" -RegistryName "RegistryExample" +``` + + +### `Get-AzContainerRegistry` +- The cmdlet 'Get-AzContainerRegistry' no longer has output type 'Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry'. +- The cmdlet 'Get-AzContainerRegistry' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Get-AzContainerRegistry' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzContainerRegistry' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzContainerRegistry' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Get-AzContainerRegistry -ResourceId /subscriptions/{subscriptionID}/resourceGroups/MyResourceGroup/providers/Microsoft.ContainerRegistry/registries/MyRegistry +``` +#### After +```powershell +Get-AzContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" +``` + + +## Az.DataProtection + +### `Initialize-AzDataProtectionBackupInstance` +- The parameter 'BackupConfiguration' is changed from 'Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.KubernetesClusterBackupDatasourceParameters' to its base class type 'Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api202301.IBackupDatasourceParameters'. The usage remains unchanged. + +## Az.DesktopVirtualization + +### `Update-AzWvdScalingPlan` +- The cmdlet 'Update-AzWvdScalingPlan' no longer supports the parameter 'HostPoolType' and no alias was found for the original parameter name. + +#### Before +```powershell +Update-AzWvdScalingPlan ` + -ResourceGroupName ResourceGroupName ` + -Name 'scalingPlan1' ` + -Description 'Description' ` + -FriendlyName 'Friendly Name' ` + -HostPoolType 'Pooled' ` + -TimeZone '(UTC-08:00) Pacific Time (US & Canada)' ` + -Schedule @( + @{ + 'name' = 'Work Week'; + 'daysOfWeek' = @('Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'); + 'rampUpStartTime' = '1900-01-01T06:00:00Z'; + 'rampUpLoadBalancingAlgorithm' = 'BreadthFirst'; + 'rampUpMinimumHostsPct' = 20; + 'rampUpCapacityThresholdPct' = 20; + 'peakStartTime' = '1900-01-01T08:00:00Z'; + 'peakLoadBalancingAlgorithm' = 'DepthFirst'; + 'RampDownStartTime' = '1900-01-01T18:00:00Z'; + 'rampDownLoadBalancingAlgorithm' = 'BreadthFirst'; + 'rampDownMinimumHostsPct' = 20; + 'rampDownCapacityThresholdPct' = 20; + 'rampDownForceLogoffUser' = $true; + 'rampDownWaitTimeMinute' = 30; + 'rampDownNotificationMessage' = 'Log out now, please.'; + 'rampDownStopHostsWhen' = 'ZeroSessions'; + 'offPeakStartTime' = '1900-01-01T20:00:00Z'; + 'offPeakLoadBalancingAlgorithm' = 'DepthFirst'; + } + ) ` + -HostPoolReference @( + @{ + 'hostPoolArmPath' = '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName1'; + 'scalingPlanEnabled' = $false; + }, + @{ + 'hostPoolArmPath' = '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName2'; + 'scalingPlanEnabled' = $false; + } + + ) +``` +#### After +```powershell +Update-AzWvdScalingPlan ` + -ResourceGroupName ResourceGroupName ` + -Name 'scalingPlan1' ` + -Description 'Description' ` + -FriendlyName 'Friendly Name' ` + -TimeZone '(UTC-08:00) Pacific Time (US & Canada)' ` + -Schedule @( + @{ + 'name' = 'Work Week'; + 'daysOfWeek' = @('Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'); + 'rampUpStartTime' = '1900-01-01T06:00:00Z'; + 'rampUpLoadBalancingAlgorithm' = 'BreadthFirst'; + 'rampUpMinimumHostsPct' = 20; + 'rampUpCapacityThresholdPct' = 20; + 'peakStartTime' = '1900-01-01T08:00:00Z'; + 'peakLoadBalancingAlgorithm' = 'DepthFirst'; + 'RampDownStartTime' = '1900-01-01T18:00:00Z'; + 'rampDownLoadBalancingAlgorithm' = 'BreadthFirst'; + 'rampDownMinimumHostsPct' = 20; + 'rampDownCapacityThresholdPct' = 20; + 'rampDownForceLogoffUser' = $true; + 'rampDownWaitTimeMinute' = 30; + 'rampDownNotificationMessage' = 'Log out now, please.'; + 'rampDownStopHostsWhen' = 'ZeroSessions'; + 'offPeakStartTime' = '1900-01-01T20:00:00Z'; + 'offPeakLoadBalancingAlgorithm' = 'DepthFirst'; + } + ) ` + -HostPoolReference @( + @{ + 'hostPoolArmPath' = '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName1'; + 'scalingPlanEnabled' = $false; + }, + @{ + 'hostPoolArmPath' = '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName2'; + 'scalingPlanEnabled' = $false; + } + + ) +``` + + +### `General` +We upgraded the API version of the Az.DesktopVirtualization module from 2021-07-12 to 2022-09-09. It caused breaking changes as we include the version in the namespace of the models, for example, 'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210712.IHostPool'. If your script depends on the namespace, please replace "Api20210712" with "Api202209". + +### `New-AzWvdScalingPlan` +- The cmdlet 'New-AzWvdScalingPlan' no longer supports the type 'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Support.HostPoolType' for parameter 'HostPoolType'. + +#### Before +```powershell +New-AzWvdScalingPlan ` + -ResourceGroupName ResourceGroupName ` + -Name 'scalingPlan1' ` + -Location 'westcentralus' ` + -Description 'Description' ` + -FriendlyName 'Friendly Name' ` + -HostPoolType 'Pooled' ` + -TimeZone '(UTC-08:00) Pacific Time (US & Canada)' ` + -Schedule @( + @{ + 'name' = 'Work Week'; + 'daysOfWeek' = @('Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'); + 'rampUpStartTime' = '1900-01-01T06:00:00Z'; + 'rampUpLoadBalancingAlgorithm' = 'BreadthFirst'; + 'rampUpMinimumHostsPct' = 20; + 'rampUpCapacityThresholdPct' = 20; + 'peakStartTime' = '1900-01-01T08:00:00Z'; + 'peakLoadBalancingAlgorithm' = 'DepthFirst'; + 'RampDownStartTime' = '1900-01-01T18:00:00Z'; + 'rampDownLoadBalancingAlgorithm' = 'BreadthFirst'; + 'rampDownMinimumHostsPct' = 20; + 'rampDownCapacityThresholdPct' = 20; + 'rampDownForceLogoffUser' = $true; + 'rampDownWaitTimeMinute' = 30; + 'rampDownNotificationMessage' = 'Log out now, please.'; + 'rampDownStopHostsWhen' = 'ZeroSessions'; + 'offPeakStartTime' = '1900-01-01T20:00:00Z'; + 'offPeakLoadBalancingAlgorithm' = 'DepthFirst'; + } + ) ` + -HostPoolReference @( + @{ + 'hostPoolArmPath' = '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName'; + 'scalingPlanEnabled' = $false; + } + ) +``` +#### After +```powershell +New-AzWvdScalingPlan ` + -ResourceGroupName ResourceGroupName ` + -Name 'scalingPlan1' ` + -Location 'westcentralus' ` + -Description 'Description' ` + -FriendlyName 'Friendly Name' ` + -TimeZone '(UTC-08:00) Pacific Time (US & Canada)' ` + -Schedule @( + @{ + 'name' = 'Work Week'; + 'daysOfWeek' = @('Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'); + 'rampUpStartTime' = '1900-01-01T06:00:00Z'; + 'rampUpLoadBalancingAlgorithm' = 'BreadthFirst'; + 'rampUpMinimumHostsPct' = 20; + 'rampUpCapacityThresholdPct' = 20; + 'peakStartTime' = '1900-01-01T08:00:00Z'; + 'peakLoadBalancingAlgorithm' = 'DepthFirst'; + 'RampDownStartTime' = '1900-01-01T18:00:00Z'; + 'rampDownLoadBalancingAlgorithm' = 'BreadthFirst'; + 'rampDownMinimumHostsPct' = 20; + 'rampDownCapacityThresholdPct' = 20; + 'rampDownForceLogoffUser' = $true; + 'rampDownWaitTimeMinute' = 30; + 'rampDownNotificationMessage' = 'Log out now, please.'; + 'rampDownStopHostsWhen' = 'ZeroSessions'; + 'offPeakStartTime' = '1900-01-01T20:00:00Z'; + 'offPeakLoadBalancingAlgorithm' = 'DepthFirst'; + } + ) ` + -HostPoolReference @( + @{ + 'hostPoolArmPath' = '/subscriptions/SubscriptionId/resourceGroups/ResourceGroupName/providers/Microsoft.DesktopVirtualization/hostPools/HostPoolName'; + 'scalingPlanEnabled' = $false; + } + ) +``` + + +### `New-AzWvdHostPool` +- The cmdlet 'New-AzWvdHostPool' no longer supports the parameter 'MigrationRequestMigrationPath' and no alias was found for the original parameter name. +- The cmdlet 'New-AzWvdHostPool' no longer supports the parameter 'MigrationRequestOperation' and no alias was found for the original parameter name. + +#### Before +```powershell +New-AzWvdHostpool -hostpoolName hpName -location westus -resourceGroupName rgName -friendlyName "friendly" -description "des1" -hostPoolType Pooled -personalDesktopAssignmentType Automatic -customRdpProperty null -maxSessionLimit 999999 -loadBalancerType BreadthFirst -registrationInfo @{ + "expirationTime"= "2020-10-01T14:01:54.9571247Z", + "registrationTokenOperation":="Update" + } + -vmTemplate "{json:json}" + -ssoadfsAuthority "https://adfs" + -ssoClientId "client" + -ssoClientSecretKeyVaultPath "https://keyvault/secret" + -ssoSecretType "SharedKey” + -preferredAppGroupType Desktop + -startVMOnConnect $false + -migrationRequest @{ + "migrationPath"= "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation"= "Start" + } +``` +#### After +```powershell +New-AzWvdHostpool -hostpoolName hpName -location westus -resourceGroupName rgName -friendlyName "friendly" -description "des1" -hostPoolType Pooled -personalDesktopAssignmentType Automatic -customRdpProperty null -maxSessionLimit 999999 -loadBalancerType BreadthFirst -registrationInfo @{ + "expirationTime"= "2020-10-01T14:01:54.9571247Z", + "registrationTokenOperation":="Update" + } + -vmTemplate "{json:json}" + -ssoadfsAuthority https://adfs + -ssoClientId "client" + -ssoClientSecretKeyVaultPath https://keyvault/secret + -ssoSecretType "SharedKey” + -preferredAppGroupType Desktop + -startVMOnConnect $false + -agentUpdate @{ + "type"= "Scheduled", + "useSessionHostLocalTime"= $false, + "maintenanceWindowTimeZone"= "Alaskan Standard Time", + "maintenanceWindows"= “{json:json} + } +``` + + +### `New-AzWvdApplicationGroup` +- The cmdlet 'New-AzWvdApplicationGroup' no longer supports the parameter 'MigrationRequestMigrationPath' and no alias was found for the original parameter name. +- The cmdlet 'New-AzWvdApplicationGroup' no longer supports the parameter 'MigrationRequestOperation' and no alias was found for the original parameter name. + +#### Before +```powershell +New-AzWvdApplicationGroup -resourceGroupName “rgName” -applicationGroupName “appName” -applicationGroup @{"description"= "des1", + "friendlyName"= "friendly", + "hostPoolArmPath"= "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "applicationGroupType"= "RemoteApp", + "migrationRequest"= @{ + "migrationPath"="TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation"= "Start" + } + +``` +#### After +```powershell +New-AzWvdApplicationGroup -resourceGroupName -applicationGroupName -applicationGroup @{"description"= "des1", + "friendlyName"= "friendly", + "hostPoolArmPath"= "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "applicationGroupType"= "RemoteApp" +} +``` + + +## Az.EventHub + +### `Set-AzEventHubNamespace` +- The cmdlet 'Set-AzEventHubNamespace' has undergone several changes, including changes to the output type and default parameter set. +- The cmdlet no longer supports certain aliases and parameter types, including 'NamespaceName', 'System.String' for 'SkuName', and 'System.Nullable`1[System.Int32]' for 'SkuCapacity'. Additionally, the parameters 'MaximumThroughputUnits', 'EnableKafka', 'ClusterARMId', 'IdentityId', and 'EncryptionConfig' are no longer supported, and no aliases were found for the original parameter names. +- The cmdlet also no longer supports the 'IAzureContextContainer' type for the 'DefaultProfile' parameter, and the 'AzContext' and 'AzureRmContext' aliases for 'DefaultProfile' are no longer supported. Finally, several parameter sets, including '__AllParameterSets', 'NamespaceParameterSet', and 'AutoInflateParameterSet', have been removed. + +### `Set-AzEventHub` +- MessageRetentionInDays' has been deprecated and replaced by '-RetentionTimeInHours'. + +#### Before +```powershell +$eventhub = Get-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace +Set-AzEventHub -InputObject $eventhub -MessageRetentionInDays 3 +``` +#### After +```powershell +Set-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -ArchiveNameFormat "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" + -BlobContainer container -CaptureEnabled -DestinationName EventHubArchive.AzureBlockBlob -Encoding Avro -IntervalInSeconds 600 -SizeLimitInBytes 11000000 -SkipEmptyArchive -StorageAccountResourceId + "/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" +``` + + +### `Remove-AzEventHubVirtualNetworkRule` +- The cmdlet 'Remove-AzEventHubVirtualNetworkRule' has been removed. Please use 'Set-AzEventHubNetworkRuleSet'. + +#### Before +```powershell +Remove-AzEventHubVirtualNetworkRule -ResourceGroupName v-ajnavtest -Name Eventhub-Namespace1-2389 -SubnetId "/subscriptions/SubscriptionId/resourcegroups/ResourceGroup/v-ajnavtest/providers/Microsoft.Network/virtualNetworks/sbehvnettest1/subnets/sbdefault01" +``` +#### After +```powershell +$virtualNetworkRule1 = New-AzEventHubVirtualNetworkRuleConfig -SubnetId '/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default' +Set-AzEventHubNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -VirtualNetworkRule $virtualNetworkRule1 +``` + + +### `Remove-AzEventHubNetworkRuleSet` +- The cmdlet 'Remove-AzEventHubNetworkRuleSet' has been removed. Please use 'Set-AzEventHubNetworkRuleSet'. + +#### Before +```powershell +Remove-AzEventHubNetworkRuleSet -ResourceGroupName v-ajnavtest -Name Eventhub-Namespace1-1375 -PassThru +``` +#### After +```powershell +Set-AzEventHubNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -VirtualNetworkRule @() +``` + + +### `Remove-AzEventHubNamespace` +- The cmdlet 'Remove-AzEventHubNamespace' has undergone several changes, including type change for parameter 'InputObject' and 'DefaultProfile', but the usage remains the same, including piping. + +### `Remove-AzEventHubIPRule` +- The cmdlet 'Remove-AzEventHubIPRule' has been removed. Please use 'Set-AzEventHubNetworkRuleSet'. + +#### Before +```powershell +Remove-AzEventHubIPRule -ResourceGroupName v-ajnavtest -Name Eventhub-Namespace1-2389 -IpMask "11.22.33.44" +``` +#### After +```powershell +$ipRule1 = New-AzEventHubIPRuleConfig -IPMask 2.2.2.2 -Action Allow +$ipRule2 = New-AzEventHubIPRuleConfig -IPMask 3.3.3.3 -Action Allow +Set-AzEventHubNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -IPRule $ipRule1,$ipRule2 +``` + + +### `New-AzEventHubNamespace` +- The cmdlet 'New-AzEventHubNamespace' has undergone several changes, including changes to the output type and default parameter set. +- The cmdlet no longer supports certain aliases and parameter types, including 'NamespaceName', 'System.String' for 'SkuName', and 'System.Nullable`1[System.Int32]' for 'SkuCapacity'. Additionally, the parameters 'MaximumThroughputUnits', 'EnableKafka', 'ClusterARMId', 'IdentityId', and 'EncryptionConfig' are no longer supported, and no aliases were found for the original parameter names. +- The cmdlet also no longer supports the 'IAzureContextContainer' type for the 'DefaultProfile' parameter, and the 'AzContext' and 'AzureRmContext' aliases for 'DefaultProfile' are no longer supported. Finally, several parameter sets, including '__AllParameterSets', 'NamespaceParameterSet', and 'AutoInflateParameterSet', have been removed. + +### `New-AzEventHubEncryptionConfig` +- The cmdlet 'New-AzEventHubEncryptionConfig' has been replaced by 'New-AzEventHubKeyVaultPropertiesObject'. + +#### Before +```powershell +New-AzEventHubEncryptionConfig -KeyName key1 -KeyVaultUri https://myvaultname.vault.azure.net -UserAssignedIdentity '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName2' +``` +#### After +```powershell +$keyVaultProperty1 = New-AzEventHubKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$keyVaultProperty2 = New-AzEventHubKeyVaultPropertiesObject -KeyName key2 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" + +New-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity","/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" -KeyVaultProperty $keyVaultProperty1,$keyVaultProperty2 +``` + + +### `New-AzEventHub` +-MessageRetentionInDays' has been deprecated and replaced by '-RetentionTimeInHours'. + +#### Before +```powershell +New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -MessageRetentionInDays 6 -PartitionCount 5 +``` +#### After +```powershell +New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -RetentionTimeInHour 168 -PartitionCount 5 -CleanupPolicy Delete +``` + + +### `Get-AzEventHubNamespace` +- The output type and the properties has been changed. See the example for more information. + +#### Before +```powershell +Name : MyNamespaceName +Id : /subscriptions/{subscriptionId}/resourceGroups/Default-EventHub-WestCentralUS/providers/Microsoft.EventHub/namespaces/MyNamespaceName +ResourceGroupName : Default-EventHub-WestCentralUS +Location : West US +Sku : Name : Standard , Capacity : 1 , Tier : Standard +Tags : +ProvisioningState : Succeeded +Status : Active +CreatedAt : 5/24/2019 12:47:27 AM +UpdatedAt : 5/24/2019 12:48:14 AM +ServiceBusEndpoint : ######### +Enabled : True +KafkaEnabled : True +IsAutoInflateEnabled : True +MaximumThroughputUnits : 10 +``` +#### After +```powershell +AlternateName : +ClusterArmId : +CreatedAt : 11/17/2022 3:14:09 PM +DisableLocalAuth : True +EnableAutoInflate : True +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +IdentityType : +KafkaEnabled : True +KeySource : +KeyVaultProperty : +Location : South Central US +MaximumThroughputUnit : 0 +MetricId : 000000000000000:myNamespace +MinimumTlsVersion : 1.2 +Name : myNamespace +PrincipalId : 000000000000000000 +PrivateEndpointConnection : +ProvisioningState : Succeeded +PublicNetworkAccess : Enabled +RequireInfrastructureEncryption : +ResourceGroupName : myResourceGroup +ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/ +SkuCapacity : 1 +SkuName : Standard +SkuTier : Standard +Status : Active +Tag : { + } +TenantId : 00000000000 +Type : Microsoft.EventHub/Namespaces +UpdatedAt : 11/17/2022 3:21:19 PM +UserAssignedIdentity : { + } +ZoneRedundant : True +``` + + +### `Get-AzEventHub` +- The cmdlet 'Get-AzEventHub' no longer has output type 'Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEventhub'. +(Yeming: namespace changed, not considered a breaking change. should be removed) + +### `Add-AzEventHubVirtualNetworkRule` +- The cmdlet 'Add-AzEventHubVirtualNetworkRule' has been removed. Please use 'Set-AzEventHubNetworkRuleSet'. + +#### Before +```powershell +Add-AzEventHubVirtualNetworkRule -ResourceGroupName v-ajnavtest -Name Eventhub-Namespace1-2389 -SubnetId "/subscriptions/SubscriptionId/resourcegroups/ResourceGroup/v-ajnavtest/providers/Microsoft.Network/virtualNetworks/sbehvnettest1/subnets/sbdefault01" -IgnoreMissingVnetServiceEndpoint +``` +#### After +```powershell +$virtualNetworkRule1 = New-AzEventHubVirtualNetworkRuleConfig -SubnetId '/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default' +Set-AzEventHubNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -VirtualNetworkRule $virtualNetworkRule1 +``` + + +### `Add-AzEventHubIPRule` +- The cmdlet 'Add-AzEventHubIPRule' has been removed. Please use 'Set-AzEventHubNetworkRuleSet'. + +#### Before +```powershell +Add-AzEventHubIPRule -ResourceGroupName v-ajnavtest -Name Eventhub-Namespace1-2389 -IpMask "11.22.33.44" -Action Allow +``` +#### After +```powershell +$ipRule1 = New-AzEventHubIPRuleConfig -IPMask 2.2.2.2 -Action Allow +$ipRule2 = New-AzEventHubIPRuleConfig -IPMask 3.3.3.3 -Action Allow +Set-AzEventHubNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -IPRule $ipRule1,$ipRule2 +``` + + +## Az.HDInsight + +### `New-AzHDInsightCluster` +- The cmdlet 'New-AzHDInsightCluster' no longer supports the parameter 'RdpCredential' and no alias was found for the original parameter name. +- The cmdlet 'New-AzHDInsightCluster' no longer supports the parameter 'RdpAccessExpiry' and no alias was found for the original parameter name. + +#### Before +```powershell +Customer didn’t use the two parameters for a very long time. There is not old usage. +``` +#### After +```powershell +Don’t use the two parameters any more. +``` + + +## Az.Relay + +### `Test-AzRelayName` +- The cmdlet 'Test-AzRelayName' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Test-AzRelayName' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Test-AzRelayName' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Set-AzWcfRelay` +- The cmdlet 'Set-AzWcfRelay' no longer has output type 'Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes'. +- The cmdlet 'Set-AzWcfRelay' no longer supports the type 'Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes' for parameter 'InputObject'. +- The cmdlet 'Set-AzWcfRelay' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Set-AzWcfRelay' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Set-AzWcfRelay' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Set-AzRelayNamespace` +- The cmdlet 'Set-AzRelayNamespace' has been removed and no alias was found for the original cmdlet name. + +#### Before +```powershell +Set-AzRelayNamespace -ResourceGroupName Default-ServiceBus-WestUS -Name TestNameSpace-Relay1 -Tag @{Tag2="Tag2Value"} +``` +#### After +```powershell +Update-AzRelayNamespace -ResourceGroupName Default-ServiceBus-WestUS -Name TestNameSpace-Relay1 -Tag @{Tag2="Tag2Value"} +``` + + +### `Set-AzRelayNamespace` +- The cmdlet 'Set-AzRelayNamespace' has been removed and no alias was found for the original cmdlet name. + +#### Before +```powershell +$relayNamespace = new RelayNamespaceAttirbutesUpdateParameter() +Update-AzRelayNamespace -InputObject $relayNamespace -Tag @{'k'='v'} +``` +#### After +```powershell +$relayNamespace = Get-AzRelayNamespace -ResourceGroupName lucas-relay-rg -Name namespace-pwsh01 +Update-AzRelayNamespace -InputObject $relayNamespace -Tag @{'k'='v'} +``` + + +### `Set-AzRelayHybridConnection` +- The cmdlet 'Set-AzRelayHybridConnection' no longer has output type 'Microsoft.Azure.Commands.Relay.Models.PSHybridConnectionAttributes'. +- The cmdlet 'Set-AzRelayHybridConnection' no longer supports the type 'Microsoft.Azure.Commands.Relay.Models.PSHybridConnectionAttributes' for parameter 'InputObject'. +- The cmdlet 'Set-AzRelayHybridConnection' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Set-AzRelayHybridConnection' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Set-AzRelayHybridConnection' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Set-AzRelayAuthorizationRule` +- The cmdlet 'Set-AzRelayAuthorizationRule' no longer has output type 'Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes'. +The parameter set 'NamespaceAuthorizationRuleSet' for cmdlet 'Set-AzRelayAuthorizationRule' is no longer the default parameter set. +- The cmdlet 'Set-AzRelayAuthorizationRule' no longer supports the type 'Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes' for parameter 'InputObject'. +The element type for parameter 'Rights' has been changed from 'System.String' to 'Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.AccessRights'. +- The cmdlet 'Set-AzRelayAuthorizationRule' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Set-AzRelayAuthorizationRule' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Set-AzRelayAuthorizationRule' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Set-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -WcfRelay TestWCFRelay1 -Name AuthoRule1 -Rights "Send" +``` +#### After +```powershell +Set-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1 -Rights "Send" +``` + + +### `Set-AzRelayAuthorizationRule` +- The cmdlet 'Set-AzRelayAuthorizationRule' no longer has output type 'Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes'. +- The cmdlet 'Set-AzRelayAuthorizationRule' no longer supports the type 'Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes' for parameter 'InputObject'. +The element type for parameter 'Rights' has been changed from 'System.String' to 'Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.AccessRights'. +- The cmdlet 'Set-AzRelayAuthorizationRule' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Set-AzRelayAuthorizationRule' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Set-AzRelayAuthorizationRule' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +$GetHybirdAutho = Get-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1 +Set-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1 -InputObject $GetHybirdAutho -Rights {"Listen", "Send"} +``` +#### After +```powershell +$GetHybirdAutho = Get-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1 +$GetHybirdAutho.Rights.Add("Send") +Set-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1 -InputObject $GetHybirdAutho +``` + + +### `Remove-AzWcfRelay` +- The cmdlet 'Remove-AzWcfRelay' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzWcfRelay' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzWcfRelay' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Remove-AzRelayNamespace` +- The cmdlet 'Remove-AzRelayNamespace' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzRelayNamespace' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzRelayNamespace' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Remove-AzRelayHybridConnection` +- The cmdlet 'Remove-AzRelayHybridConnection' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzRelayHybridConnection' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzRelayHybridConnection' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Remove-AzRelayAuthorizationRule` +- The cmdlet 'Remove-AzRelayAuthorizationRule' no longer supports the parameter 'Force' and no alias was found for the original parameter name. +- The cmdlet 'Remove-AzRelayAuthorizationRule' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzRelayAuthorizationRule' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzRelayAuthorizationRule' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Remove-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -WcfRelay TestWcfRelay -Name AuthoRule1 +``` +#### After +```powershell +Remove-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWcfRelay -Name AuthoRule1 +``` + + +### `New-AzWcfRelay` +- The cmdlet 'New-AzWcfRelay' no longer has output type 'Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes'. +- The cmdlet 'New-AzWcfRelay' no longer supports the type 'Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes' for parameter 'InputObject'. +- The cmdlet 'New-AzWcfRelay' no longer supports the type 'System.String' for parameter 'WcfRelayType'. +- The cmdlet 'New-AzWcfRelay' no longer supports the type 'System.Nullable`1[System.Boolean]' for parameter 'RequiresClientAuthorization'. +- The cmdlet 'New-AzWcfRelay' no longer supports the type 'System.Nullable`1[System.Boolean]' for parameter 'RequiresTransportSecurity'. +- The cmdlet 'New-AzWcfRelay' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzWcfRelay' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzWcfRelay' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `New-AzRelayNamespace` +- The cmdlet 'New-AzRelayNamespace' no longer has output type 'Microsoft.Azure.Commands.Relay.Models.PSRelayNamespaceAttributes'. +- The cmdlet 'New-AzRelayNamespace' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzRelayNamespace' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzRelayNamespace' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `New-AzRelayKey` +- The cmdlet 'New-AzRelayKey' no longer supports the type 'System.String' for parameter 'RegenerateKey'. +- The cmdlet 'New-AzRelayKey' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzRelayKey' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzRelayKey' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKey PrimaryKey +``` +#### After +```powershell +New-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKey PrimaryKey +``` + + +### `New-AzRelayHybridConnection` +- The cmdlet 'New-AzRelayHybridConnection' no longer has output type 'Microsoft.Azure.Commands.Relay.Models.PSHybridConnectionAttributes'. +- The cmdlet 'New-AzRelayHybridConnection' no longer supports the type 'Microsoft.Azure.Commands.Relay.Models.PSHybridConnectionAttributes' for parameter 'InputObject'. +- The cmdlet 'New-AzRelayHybridConnection' no longer supports the type 'System.Nullable`1[System.Boolean]' for parameter 'RequiresClientAuthorization'. +- The cmdlet 'New-AzRelayHybridConnection' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzRelayHybridConnection' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzRelayHybridConnection' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `New-AzRelayAuthorizationRule` +- The cmdlet 'New-AzRelayAuthorizationRule' no longer has output type 'Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes'. +The element type for parameter 'Rights' has been changed from 'System.String' to 'Microsoft.Azure.PowerShell.Cmdlets.Relay.Support.AccessRights'. +- The cmdlet 'New-AzRelayAuthorizationRule' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzRelayAuthorizationRule' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzRelayAuthorizationRule' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +New-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -WcfRelay TestWCFRelay1 -Name AuthoRule1 -Rights "Listen" +``` +#### After +```powershell +New-AzRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1 -Rights "Listen" +``` + + +### `Get-AzWcfRelay` +- The cmdlet 'Get-AzWcfRelay' no longer has output type 'Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes'. +- The cmdlet 'Get-AzWcfRelay' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzWcfRelay' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzWcfRelay' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Get-AzRelayOperation` +- The cmdlet 'Get-AzRelayOperation' has been removed and no alias was found for the original cmdlet name. + +### `Get-AzRelayNamespace` +- The cmdlet 'Get-AzRelayNamespace' no longer has output type 'Microsoft.Azure.Commands.Relay.Models.PSRelayNamespaceAttributes'. +- The cmdlet 'Get-AzRelayNamespace' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzRelayNamespace' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzRelayNamespace' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Get-AzRelayKey` +- The cmdlet 'Get-AzRelayKey' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzRelayKey' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzRelayKey' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +Get-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -HybridConnection TestHybridConnection -Name AuthoRule1 +``` +#### After +```powershell +Get-AzRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1 +``` + + +### `Get-AzRelayHybridConnection` +- The cmdlet 'Get-AzRelayHybridConnection' no longer has output type 'Microsoft.Azure.Commands.Relay.Models.PSHybridConnectionAttributes'. +- The cmdlet 'Get-AzRelayHybridConnection' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzRelayHybridConnection' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzRelayHybridConnection' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Get-AzRelayAuthorizationRule` +- The cmdlet 'Get-AzRelayAuthorizationRule' no longer has output type 'Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes'. +- The cmdlet 'Get-AzRelayAuthorizationRule' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzRelayAuthorizationRule' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzRelayAuthorizationRule' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +## Az.ServiceBus + +### `Set-AzServiceBusNamespace` +- The cmdlet 'Set-AzServiceBusNamespace' has undergone several changes, including changes to the output type and default parameter set. +- The cmdlet no longer supports certain aliases and parameter types, including 'NamespaceName', 'System.String' for 'SkuName', and 'System.Nullable`1[System.Int32]' for 'SkuCapacity'. Additionally, the parameters 'MaximumThroughputUnits', 'EnableKafka', 'ClusterARMId', 'IdentityId', and 'EncryptionConfig' are no longer supported, and no aliases were found for the original parameter names. +- The cmdlet also no longer supports the 'IAzureContextContainer' type for the 'DefaultProfile' parameter, and the 'AzContext' and 'AzureRmContext' aliases for 'DefaultProfile' are no longer supported. + +### `Remove-AzServiceBusVirtualNetworkRule` +- The cmdlet 'Remove-AzServiceBusVirtualNetworkRule' has been removed. Use 'Set-AzServiceBusNetworkRuleSet' instead. + +#### Before +```powershell +Remove-AzServiceBusVirtualNetworkRule -ResourceGroupName v-ajnavtest -Name ServiceBus-Namespace1-2389 -SubnetId "/subscriptions/SubscriptionId/resourcegroups/ResourceGroup/v-ajnavtest/providers/Microsoft.Network/virtualNetworks/sbehvnettest1/subnets/sbdefault01" +``` +#### After +```powershell +$virtualNetworkRule1 = New-AzServiceBusVirtualNetworkRuleConfig -SubnetId /subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default +Set-AzServiceBusNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -IPRule $ipRule1,$ipRule2 -VirtualNetworkRule $virtualNetworkRule1,$virtualNetworkRule2,$virtualNetworkRule3 +``` + + +### `Remove-AzServiceBusNetworkRuleSet` +- The cmdlet 'Remove-AzServiceBusNetworkRuleSet' has been removed. Use 'Set-AzServiceBusNetworkRuleSet' instead. + +#### Before +```powershell +Remove-AzServiceBusNetworkRuleSet -ResourceGroupName v-ajnavtest -Name ServiceBus-Namespace1-1375 +``` +#### After +```powershell +Set-AzServiceBusNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -IPRule @() -VirtualNetworkRule @() +``` + + +### `Remove-AzServiceBusNamespace` +- The cmdlet 'Remove-AzServiceBusNamespace' no longer supports the alias 'ResourceGroup' for parameter 'ResourceGroupName'. + +#### Before +```powershell +Remove-AzServiceBusNamespace -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 +``` +#### After +```powershell +Remove-AzServiceBusNamespace -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName SB-Example1 +``` + + +### `Remove-AzServiceBusIPRule` +- The cmdlet 'Remove-AzServiceBusIPRule' has been removed. Use 'Set-AzServiceBusNetworkRuleSet' instead. + +#### Before +```powershell +Remove-AzServiceBusIPRule -ResourceGroupName v-ajnavtest -Name ServiceBus-Namespace1-2389 -IpMask "11.22.33.44" +``` +#### After +```powershell +Set-AzServiceBusNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -IPRule @() +``` + + +### `New-AzServiceBusNamespace` +- The cmdlet 'New-AzServiceBusNamespace' has undergone several changes. +- The cmdlet no longer supports certain aliases and parameter types, including 'NamespaceName', 'System.String' for 'SkuName', and 'System.Nullable`1[System.Int32]' for 'SkuCapacity'. Additionally, the parameters 'MaximumThroughputUnits', 'EnableKafka', 'ClusterARMId', 'IdentityId', and 'EncryptionConfig' are no longer supported, and no aliases were found for the original parameter names. +- The cmdlet also no longer supports the 'IAzureContextContainer' type for the 'DefaultProfile' parameter, and the 'AzContext' and 'AzureRmContext' aliases for 'DefaultProfile' are no longer supported. + +### `New-AzServiceBusGeoDRConfiguration` +- The cmdlet 'New-AzServiceBusGeoDRConfiguration' no longer supports the parameter 'PassThru' and no alias was found for the original parameter name. + +#### Before +```powershell +New-AzServiceBusGeoDRConfiguration -Name myAlias -ResourceGroupName myResourceGroup -NamespaceName myPrimaryNamespace -PartnerNamespace "/subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/mySecondaryNamespace" -PassThru +``` +#### After +```powershell +New-AzServiceBusGeoDRConfiguration -Name myAlias -ResourceGroupName myResourceGroup -NamespaceName myPrimaryNamespace -PartnerNamespace "/subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/mySecondaryNamespace" +``` + + +### `New-AzServiceBusEncryptionConfig` +- The cmdlet 'New-AzServiceBusEncryptionConfig' has been removed. Use 'New-AzServiceBusNamespace' and 'Set-AzServiceBusNamespace' to enable encryption. + +#### Before +```powershell +New-AzServiceBusEncryptionConfig -KeyName key1 -KeyVaultUri https://myvaultname.vault.azure.net -UserAssignedIdentity '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName2' +``` +#### After +```powershell +$id1 = "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$id2 = "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" +$keyVaultProperty1 = New-AzServiceBusKeyVaultPropertiesObject -KeyName key4 -KeyVaultUri https://testkeyvault.vault.azure.net/ -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$keyVaultProperty2 = New-AzServiceBusKeyVaultPropertiesObject -KeyName key5 -KeyVaultUri https://testkeyvault.vault.azure.net/ -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +New-AzServiceBusNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityID $id1,$id2 -KeyVaultProperty $keyVaultProperty1,$keyVaultProperty2 + +``` + + +### `Get-AzServiceBusOperation` +- The cmdlet 'Get-AzServiceBusOperation' has been removed. + +### `Get-AzServiceBusNamespace` +- The cmdlet 'Get-AzServiceBusNamespace' no longer supports the alias 'ResourceGroup' for parameter 'ResourceGroupName'. + +#### Before +```powershell +Get-AzServiceBusNamespace -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 +``` +#### After +```powershell +Get-AzServiceBusNamespace -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName SB-Example1 +``` + + +### `Add-AzServiceBusVirtualNetworkRule` +- The cmdlet 'Add-AzServiceBusVirtualNetworkRule' has been removed. Use 'Set-AzServiceBusNetworkRuleSet' instead. + +#### Before +```powershell +Add-AzServiceBusVirtualNetworkRule -ResourceGroupName v-ajnavtest -Name ServiceBus-Namespace1-2389 -SubnetId "/subscriptions/SubscriptionId/resourcegroups/ResourceGroup/v-ajnavtest/providers/Microsoft.Network/virtualNetworks/sbehvnettest1/subnets/sbdefault01" -IgnoreMissingVnetServiceEndpoint +``` +#### After +```powershell +$virtualNetworkRule1 = New-AzServiceBusVirtualNetworkRuleConfig -SubnetId /subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/default +Set-AzServiceBusNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -VirtualNetworkRule $virtualNetworkRule1 +``` + + +### `Add-AzServiceBusIPRule` +- The cmdlet 'Add-AzServiceBusIPRule' has been removed. Use 'Set-AzServiceBusNetworkRuleSet' instead. + +#### Before +```powershell +Add-AzServiceBusIPRule -ResourceGroupName v-ajnavtest -Name ServiceBus-Namespace1-2389 -IpMask "11.22.33.44" -Action Allow +``` +#### After +```powershell +$ipRule1 = New-AzServiceBusIPRuleConfig -IPMask 2.2.2.2 -Action Allow +$ipRule2 = New-AzServiceBusIPRuleConfig -IPMask 3.3.3.3 -Action Allow +Set-AzServiceBusNetworkRuleSet -ResourceGroupName myResourceGroup -NamespaceName myNamespace -IPRule $ipRule1,$ipRule2 +``` + + +## Az.SignalR + +### `Update-AzSignalRNetworkAcl` +- The property 'HostNamePrefix' of type 'Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource' has been removed. + +### `Update-AzSignalR` +- The property 'HostNamePrefix' of type 'Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource' has been removed. +- The property 'HostNamePrefix' of type 'Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource' has been removed. + +#### Before +```powershell +$hostNamePrefix = $(Update-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -UnitCount 5).HostNamePrefix +``` +#### After +```powershell +$hostNamePrefix = $(Update-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -UnitCount 5).Name +``` + + +### `Set-AzSignalRUpstream` +- The property 'HostNamePrefix' of type 'Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource' has been removed. + +### `Restart-AzSignalR` +- The property 'HostNamePrefix' of type 'Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource' has been removed. + +### `Remove-AzSignalR` +- The property 'HostNamePrefix' of type 'Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource' has been removed. + +### `New-AzSignalRKey` +- The property 'HostNamePrefix' of type 'Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource' has been removed. + +### `New-AzSignalR` +- The property 'HostNamePrefix' of type 'Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource' has been removed. + +#### Before +```powershell +$hostNamePrefix = $(New-AzSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr1 -Location eastus -Sku Standard_S1).HostNamePrefix +``` +#### After +```powershell +$hostNamePrefix = $(New-AzSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr1 -Location eastus -Sku Standard_S1).Name +``` + + +### `Get-AzSignalRKey` +- The property 'HostNamePrefix' of type 'Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource' has been removed. + +### `Get-AzSignalR` +- The property 'HostNamePrefix' of type 'Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource' has been removed. + +#### Before +```powershell +$hostNamePrefix = $(Get-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1).HostNamePrefix +``` +#### After +```powershell +$hostNamePrefix = $(Get-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1).Name +``` + + +## Az.SqlVirtualMachine + +### `Update-AzSqlVMGroup` +- The cmdlet 'Update-AzSqlVMGroup' no longer has output type 'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureSqlVMGroupModel'. +- The cmdlet 'Update-AzSqlVMGroup' no longer supports the type 'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureSqlVMGroupModel' for parameter 'InputObject'. +- The cmdlet 'Update-AzSqlVMGroup' no longer supports the alias 'SqlVMGroup' for parameter 'InputObject'. +- The cmdlet 'Update-AzSqlVMGroup' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Update-AzSqlVMGroup' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Update-AzSqlVMGroup' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Update-AzSqlVMGroup' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +$group = Get-AzSqlVMGroup -ResourceGroupName "ResourceGroup01" -Name "test-group" +Update-AzSqlVMGroup -SqlVMGroup $group -Tag @{'key'='value'} +``` +#### After +```powershell +$group = Get-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01' -Name 'sqlvmgroup01' +$group | Update-AzSqlVMGroup -Tag @{'key'='value'} +``` + + +### `Update-AzSqlVM` +- The cmdlet 'Update-AzSqlVM' no longer has output type 'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureSqlVMModel'. +- The cmdlet 'Update-AzSqlVM' no longer supports the type 'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureSqlVMModel' for parameter 'InputObject'. +- The cmdlet 'Update-AzSqlVM' no longer supports the alias 'SqlVM' for parameter 'InputObject'. +- The cmdlet 'Update-AzSqlVM' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Update-AzSqlVM' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Update-AzSqlVM' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Update-AzSqlVM' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Update-AzAvailabilityGroupListener` +- The cmdlet 'Update-AzAvailabilityGroupListener' has been removed and no alias was found for the original cmdlet name. + +### `Set-AzSqlVMConfigGroup` +- The cmdlet 'Set-AzSqlVMConfigGroup' has been removed and no alias was found for the original cmdlet name. + +### `Remove-AzSqlVMGroup` +- The cmdlet 'Remove-AzSqlVMGroup' has undergone changes and no longer supports certain parameters and output types. Specifically, the 'InputObject' parameter no longer supports the 'AzureSqlVMGroupModel' type or its 'SqlVMGroup' alias, and the 'ResourceId' parameter has been removed entirely. Additionally, the 'DefaultProfile' parameter no longer supports the 'IAzureContextContainer' type, and its aliases 'AzContext' and 'AzureRmContext'. + +#### Before +```powershell +$group = Get-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01' -Name 'sqlvmgroup01' +Remove-AzSqlVMGroup -SqlVMGroup $group +``` +#### After +```powershell +$group = Get-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01' -Name 'sqlvmgroup01' +$group | Remove-AzSqlVMGroup +``` + + +### `Remove-AzSqlVM` +- The cmdlet 'Remove-AzSqlVM' no longer has output type 'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureSqlVMModel'. +- The cmdlet 'Remove-AzSqlVM' no longer supports the type 'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureSqlVMModel' for parameter 'InputObject'. +- The cmdlet 'Remove-AzSqlVM' no longer supports the alias 'SqlVM' for parameter 'InputObject'. +- The cmdlet 'Remove-AzSqlVM' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Remove-AzSqlVM' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzSqlVM' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Remove-AzSqlVM' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +$sqlVM = Get-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' +Remove-AzSqlVM -SqlVM $sqlVM +``` +#### After +```powershell +$sqlVM = Get-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' +$sqlVM | Remove-AzSqlVM +``` + + +### `Remove-AzAvailabilityGroupListener` +- The cmdlet 'Remove-AzAvailabilityGroupListener' has undergone changes and some features have been removed. Specifically, the output type 'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureAvailabilityGroupListenerModel' is no longer supported. Additionally, the parameter 'InputObject' no longer supports this type. The 'ResourceId' and 'SqlVMGroupObject' parameters have also been removed without any alias found. The 'DefaultProfile' parameter no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' and its aliases 'AzContext' and 'AzureRmContext'. + +#### Before +```powershell +$SqlVmGroupObject = Get-AzSqlVMGroup -ResourceGroupName ResourceGroup01 -SqlVMGroupName SqlVmGroup01 +Remove-AzAvailabilityGroupListener -Name AgListener01 -SqlVMGroupObject $SqlVmGroupObject +``` +#### After +```powershell +Remove-AzAvailabilityGroupListener -ResourceGroupName 'ResourceGroup01' -SqlVMGroupName 'SqlVmGroup01' -Name 'AgListener01' +``` + + +### `New-AzSqlVMGroup` +- The cmdlet 'New-AzSqlVMGroup' no longer has output type 'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureSqlVMGroupModel'. +- The cmdlet 'New-AzSqlVMGroup' no longer supports the type 'System.String' for parameter 'Sku'. +- The cmdlet 'New-AzSqlVMGroup' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzSqlVMGroup' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzSqlVMGroup' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `New-AzSqlVMConfig` +- The cmdlet 'New-AzSqlVMConfig' has been removed and no alias was found for the original cmdlet name. + +#### Before +```powershell +$config = New-AzSqlVMConfig -LicenseType "PAYG" +New-AzSqlVM -ResourceGroupName "ResourceGroup01" -Name "vm" -SqlVM $config +``` +#### After +```powershell +New-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -Location 'eastus' -Sku 'Developer' -LicenseType 'PAYG' +``` + + +### `New-AzSqlVM` +- The cmdlet 'New-AzSqlVM' no longer has output type 'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureSqlVMModel'. +- The cmdlet 'New-AzSqlVM' no longer supports the parameter 'SqlVM' and no alias was found for the original parameter name. +- The cmdlet 'New-AzSqlVM' no longer supports the type 'System.String' for parameter 'LicenseType'. +- The cmdlet 'New-AzSqlVM' no longer supports the type 'System.String' for parameter 'Sku'. +- The cmdlet 'New-AzSqlVM' no longer supports the type 'System.String' for parameter 'SqlManagementType'. +- The cmdlet 'New-AzSqlVM' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzSqlVM' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzSqlVM' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +#### Before +```powershell +$config = New-AzSqlVMConfig -LicenseType "PAYG" +New-AzSqlVM -ResourceGroupName "ResourceGroup01" -Name "vm" -SqlVM $config +``` +#### After +```powershell +New-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -Location 'eastus' -Sku 'Developer' -LicenseType 'PAYG' +``` + + +### `New-AzAvailabilityGroupListener` +- The cmdlet 'New-AzAvailabilityGroupListener' no longer has output type 'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureAvailabilityGroupListenerModel'. +- The cmdlet 'New-AzAvailabilityGroupListener' no longer supports the type 'System.Nullable`1[System.Int32]' for parameter 'Port'. +- The cmdlet 'New-AzAvailabilityGroupListener' no longer supports the type 'System.Nullable`1[System.Int32]' for parameter 'ProbePort'. +- The cmdlet 'New-AzAvailabilityGroupListener' no longer supports the parameter 'SqlVMGroupObject' and no alias was found for the original parameter name. +- The cmdlet 'New-AzAvailabilityGroupListener' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzAvailabilityGroupListener' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'New-AzAvailabilityGroupListener' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Get-AzSqlVMGroup` +- The cmdlet 'Get-AzSqlVMGroup' no longer has output type 'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureSqlVMGroupModel'. +- The cmdlet 'Get-AzSqlVMGroup' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Get-AzSqlVMGroup' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzSqlVMGroup' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzSqlVMGroup' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Get-AzSqlVM` +- The cmdlet 'Get-AzSqlVM' no longer has output type 'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureSqlVMModel'. +- The cmdlet 'Get-AzSqlVM' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- The cmdlet 'Get-AzSqlVM' no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzSqlVM' no longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- The cmdlet 'Get-AzSqlVM' no longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. + +### `Get-AzAvailabilityGroupListener` +- The cmdlet 'Get-AzAvailabilityGroupListener' has been updated and some features have been removed. +- The cmdlet 'Get-AzAvailabilityGroupListener' no longer has output type 'Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model.AzureAvailabilityGroupListenerModel'. The 'ResourceId' and 'SqlVMGroupObject' parameters have been removed without any alias found. The 'DefaultProfile' parameter no longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' and its aliases 'AzContext' and 'AzureRmContext'. + +#### Before +```powershell +$SqlVmGroupObject = Get-AzSqlVMGroup -ResourceGroupName ResourceGroup01 -SqlVMGroupName SqlVmGroup01 +Get-AzAvailabilityGroupListener -Name AgListener01 -SqlVMGroupObject $SqlVmGroupObject +``` +#### After +```powershell +Get-AzAvailabilityGroupListener -ResourceGroupName 'ResourceGroup01' -SqlVMGroupName 'SqlVmGroup01' -Name 'AgListener01' +``` + + +## Az.StackHCI + +### `Unregister-AzStackHCI` +- The cmdlet 'Unregister-AzStackHCI' no longer supports the parameter 'GraphAccessToken' and no alias was found for the original parameter name. + +#### Before +```powershell +Customers had an option to pass GraphAccessToken parameter in Unregister-AzStackHCI, which used to be ignored by the cmdlet +``` +#### After +```powershell +Unregister-AzStackHCI won’t support GraphAccessToken as a parameter +``` + + +### `Test-AzStackHCIConnection` +- The cmdlet 'Test-AzStackHCIConnection' has been removed and no alias was found for the original cmdlet name. + +#### Before +```powershell +Customers used Test-AzStackHCIConnection for connectivity verification tests +``` +#### After +```powershell +Customers can use Invoke-AzStackHciConnectivityValidation from AzStackHCI.EnvironmentChecker module for enhanced connectivity verification tests +``` + + +### `Set-AzStackHCI` +- The cmdlet 'Set-AzStackHCI' no longer supports the parameter 'GraphAccessToken' and no alias was found for the original parameter name. + +#### Before +```powershell +Customers had an option to pass GraphAccessToken parameter in Set-AzStackHCI, which used to be ignored by the cmdlet +``` +#### After +```powershell +Set-AzStackHCI won’t support GraphAccessToken as a parameter +``` + + +### `Register-AzStackHCI` +- The cmdlet 'Register-AzStackHCI' no longer supports the parameter 'GraphAccessToken' and no alias was found for the original parameter name. +- The cmdlet 'Register-AzStackHCI' no longer supports the parameter 'EnableAzureArcServer' and no alias was found for the original parameter name. + +#### Before +```powershell +Customers had an option to pass GraphAccessToken parameter in Register-AzStackHCI, which used to be ignored by the cmdlet. Customers had an option to pass EnableAzureArcServer as true or false. Register-AzStackHCI used to fail for customers who passed EnableAzureArcServer as false. Customers used to get a confirmation prompt if they didn't pass the Region parameter in Register-AzStackHCI +``` +#### After +```powershell +Register-AzStackHCI won’t support GraphAccessToken and EnableAzureArcServer as parameters, and will make Region parameter as mandatory. +``` + +## Az.StorageSync + +### `Set-AzStorageSyncServerEndpoint` +- The cmdlet 'Set-AzStorageSyncServerEndpoint' no longer supports the alias 'RegisteredServer' for parameter 'InputObject'. + +#### Before +```powershell +Set-AzStorageSyncServerEndpoint -RegisteredServer $inputObject +``` +#### After +```powershell +Set-AzStorageSyncServerEndpoint -ServerEndpoint $inputObject +``` + + +## Az.Synapse + +### `Update-AzSynapseSparkPool` +- The cmdlet 'Update-AzSynapseSparkPool' no longer supports the parameter 'SparkConfigFilePath' and no alias was found for the original parameter name. + + +#### Before +```powershell +Update-AzSynapseSparkPool -WorkspaceName $wsname -Name $sparkpoolname -SparkConfigFilePath $path +``` +#### After +```powershell +Update-AzSynapseSparkPool -WorkspaceName $wsname -Name $sparkpoolname -SparkConfiguration $config +``` + + +### `New-AzSynapseSparkPool` +- The cmdlet 'New-AzSynapseSparkPool' no longer supports the parameter 'SparkConfigFilePath' and no alias was found for the original parameter name. + +#### Before +```powershell +New-AzSynapseSparkPool -WorkspaceName $wsname -Name $sparkpoolname -SparkConfigFilePath $path +``` +#### After +```powershell +New-AzSynapseSparkPool -WorkspaceName $wsname -Name $sparkpoolname -SparkConfiguration $config +``` + + +## Az.Websites + +### `New-AzWebAppContainerPSSession` +- The cmdlet 'New-AzWebAppContainerPSSession' has been removed and no alias was found for the original cmdlet name. + +#### Before +```powershell +Opens a remote PowerShell session into the windows container specified in a given site or slot and given resource group +``` +#### After +```powershell +N/A +``` + + +### `Enter-AzWebAppContainerPSSession` +- The cmdlet 'Enter-AzWebAppContainerPSSession' has been removed and no alias was found for the original cmdlet name. + +#### Before +```powershell +Create new remote PowerShell Session into the windows container specified in a given site or slot and given resource group +``` +#### After +```powershell +N/A +``` diff --git a/docs-conceptual/azps-10.1.0/migrate-az-2.0.0.md b/docs-conceptual/azps-10.1.0/migrate-az-2.0.0.md new file mode 100644 index 0000000000..e3ac300032 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/migrate-az-2.0.0.md @@ -0,0 +1,430 @@ +--- +description: This migration guide contains a list of breaking changes made to Azure PowerShell in the Az version 2.0 release. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Migration guide for Az 2.0.0 +--- +# Migration Guide for Az 2.0.0 + +This document describes the changes between the 1.0.0 and 2.0.0 versions of Az + +## Table of Contents +- [Module breaking changes](#module-breaking-changes) + - [Az.Compute](#azcompute) + - [Az.HDInsight](#azhdinsight) + - [Az.Storage](#azstorage) + +## Module breaking changes + +### Az.Compute + +- Removed `Managed` Parameter from `New-AzAvailabilitySet` and `Update-AzAvailabilitySet` cmdlets in favor of using ```Sku = Aligned``` + + #### Before + + ```powershell + Update-AzAvailabilitySet -Managed + ``` + + #### After + + ```powershell + Update-AzAvailabilitySet -Sku Aligned + ``` +- For consistency, removed `Image` parameter from 'ByName' and 'ByResourceId' parameter sets in `Update-AzImage` + + #### Before + + Note that the below code is functional, but the passed-in ImageName is not used, so removing this parameter has no functional impact. + + ```powershell + Update-AzImage -ResourceGroupName $Rg -ImageName $Name -Image $Image -Tag $tags + + Update-AzImage -ResourceId $Id -Image $Image -Tag $tags + ``` + + #### After + + ```powershell + Update-AzImage -ResourceGroupName $Rg -ImageName $Name -Tag $tags + + Update-AzImage -ResourceId $Id -Tag $tags + ``` + +- For consistency, removed `Name` parameter from 'ByObject' and 'ByResourceId' parameter sets in `Restart-AzVM` + + #### Before + + Note that the below code is functional, but the passed-in Name is not used, so removing this parameter has no functional impact. + ```powershell + Restart-AzVM -InputObject $VM -Name $Name + + Restart-AzVM -ResourceId $Id -Name $Name + ``` + + #### After + + ```powershell + Restart-AzVM -InputObject $VM + + Restart-AzVM -ResourceId $Id + ``` + +- For consistency, removed `Name` parameter from 'ByObject' and 'ByResourceId' parameter sets in `Start-AzVM` + + #### Before + + Note that the below code is functional, but the passed-in Name is not used, so removing this parameter has no functional impact. + + ```powershell + Start-AzVM -InputObject $VM -Name $Name + + Start-AzVM -ResourceId $Id -Name $Name + ``` + + #### After + + ```powershell + Start-AzVM -InputObject $VM + + Start-AzVM -ResourceId $Id + ``` + +- For consistency, removed `Name` parameter from 'ByObject' and 'ByResourceId' parameter sets in `Stop-AzVM` + + #### Before + + Note that the below code is functional, but the passed-in Name is not used, so removing this parameter has no functional impact. + + ```powershell + Stop-AzVM -InputObject $VM -Name $Name + + Stop-AzVM -ResourceId $Id -Name $Name + ``` + + #### After + + ```powershell + Stop-AzVM -InputObject $VM + + Stop-AzVM -ResourceId $Id + ``` + +- For consistency, removed `Name` parameter from 'ByObject' and 'ByResourceId' parameter sets in `Remove-AzVM` + + #### Before + + Note that the below code is functional, but the passed-in Name is not used, so removing this parameter has no functional impact. + + ```powershell + Remove-AzVM -InputObject $VM -Name $Name + + Remove-AzVM -ResourceId $Id -Name $Name + ``` + + #### After + + ```powershell + Remove-AzVM -InputObject $VM + + Remove-AzVM -ResourceId $Id + ``` + +- For consistency, removed `Name` parameter from 'ByObject' and 'ByResourceId' parameter sets in `Set-AzVM` + + #### Before + + Note that the below code is functional, but the passed-in Name is not used, so removing this parameter has no functional impact. + + ```powershell + Set-AzVM -InputObject $VM -Name $Name ... + + Set-AzVM -ResourceId $Id -Name $Name ... + ``` + + #### After + + ```powershell + Set-AzVM -InputObject $VM ... + + Set-AzVM -ResourceId $Id ... + ``` + +- For consistency, removed `Name` parameter from 'ByObject' and 'ByResourceId' parameter sets in `Save-AzVMImage` + + #### Before + Note that the below code is functional, but the passed-in Name is not used, so removing this parameter has no functional impact. + ```powershell + Save-AzVMImage -InputObject $VM -Name $Name ... + + Save-AzVMImage -ResourceId $Id -Name $Name ... + ``` + #### After + ```powershell + Save-AzVMImage -InputObject $VM ... + + Save-AzVMImage -ResourceId $Id ... + ``` + +- Added ProtectionPolicy property to encapsulate `ProtectFromScaleIn` property in `PSVirtualMachineScaleSetVM` + + #### Before + + ```powershell + $vmss = Get-AzVMssVM ... + $vmss.ProtectFromScaleIn = $true + + $vmss = Update-AzVMssVM ... + $vmss.ProtectFromScaleIn = $true + + $vmss = Remove-AzVMssVMDataDisk ... + $vmss.ProtectFromScaleIn = $true + ``` + + #### After + + ```powershell + $vmss = Get-AzVMssVM ... + $vmss.ProtectionPolicy.ProtectFromScaleIn = $true + + $vmss = Update-AzVMssVM ... + $vmss.ProtectionPolicy.ProtectFromScaleIn = $true + + $vmss = Remove-AzVMssVMDataDisk ... + $vmss.ProtectionPolicy.ProtectFromScaleIn = $true + + ``` + +- Added ```EncryptionSettingsCollection``` Property to enclose `EncryptionSettings` property in `PSDisk` + + #### Before + + ```powershell + $disk = New-AzDisk ... | Set-AzDiskDiskEncrytionKey ... + $disk.EncryptionSettings + + $disk = New-AzDisk ... | Set-AzDiskKeyEncrytionKey ... + $disk.EncryptionSettings + + $update = New-AzDiskUpdateConfig | Set-AzDiskUpdateDiskEncryptionKey ... + $update.EncryptionSettings + + $update = New-AzDiskUpdateConfig | Set-AzDiskUpdateKeyEncryptionKey ... + $update.EncryptionSettings + ``` + + #### After + + ```powershell + $disk = New-AzDisk ... | Set-AzDiskDiskEncrytionKey ... + $disk.EncryptionSettingsCollection.EncryptionSettings + + $disk = New-AzDisk ... | Set-AzDiskKeyEncrytionKey ... + $disk.EncryptionSettingsCollection.EncryptionSettings + + $update = New-AzDiskUpdateConfig | Set-AzDiskUpdateDiskEncryptionKey ... + $update.EncryptionSettingsCollection.EncryptionSettings + + $update = New-AzDiskUpdateConfig | Set-AzDiskUpdateKeyEncryptionKey ... + $update.EncryptionSettingsCollection.EncryptionSettings + ``` + +- Added ```EncryptionSettingsCollection``` Property to enclose `EncryptionSettings` property in `PSSnapshot` + + #### Before + + ```powershell + $snap = New-AzSnapshotConfig ... | Set-AzSnapshotDiskEncryptionKey ... + $snap.EncryptionSettings + + $snap = New-AzSnapshotConfig ... | Set-AzSnapshotKeyEncryptionKey ... + $snap.EncryptionSettings + + $update = New-AzSnapshotUpdateConfig ... | Set-AzSnapshotUpdateDiskEncryptionKey ... + $update.EncryptionSettings + + $update = New-AzSnapshotUpdateConfig ... | Set-AzSnapshotUpdateKeyEncryptionKey ... + $update.EncryptionSettings + ``` + + #### After + + ```powershell + $snap = New-AzSnapshotConfig ... | Set-AzSnapshotDiskEncryptionKey ... + $snap.EncryptionSettingsCollection.EncryptionSettings + + $snap = New-AzSnapshotConfig ... | Set-AzSnapshotKeyEncryptionKey ... + $snap.EncryptionSettingsCollection.EncryptionSettings + + $update = New-AzSnapshotUpdateConfig ... | Set-AzSnapshotUpdateDiskEncryptionKey ... + $update.EncryptionSettingsCollection.EncryptionSettings + + $update = New-AzSnapshotUpdateConfig ... | Set-AzSnapshotUpdateKeyEncryptionKey ... + $update.EncryptionSettingsCollection.EncryptionSettings + ``` + +- Removed `VirtualMachineProfile` property from `PSVirtualMachineScaleSet` + + #### Before + + ```powershell + $vmss = New-AzVMSSConfig ... + $vmss.VirtualMachineProfile.AdditionalCapabilities.UltraSSDEnabled = $true + ``` + + #### After + + ```powershell + $vmss = New-AzVMSSConfig ... + $vmss.AdditionalCapabilities.UltraSSDEnabled = $true + ``` + +- Cmdlet `Set-AzVMBootDiagnostic` removed alias to `Set-AzVMBootDiagnostics` + + #### Before + + Using deprecated alias + + ```powershell + Set-AzVMBootDiagnostics + ``` + + #### After + + ```powershell + Set-AzVMBootDIagnostic + ``` + +- Cmdlet `Export-AzLogAnalyticThrottledRequest` removed alias to `Export-AzLogAnalyticThrottledRequests` + + #### Before + + Using deprectaed alias + + ```powershell + Export-AzLogAnalyticThrottledRequests + ``` + + #### After + + ```powershell + Export-AzLogAnalyticThrottledRequest + ``` + +### Az.HDInsight + +- Removed the `Grant-AzHDInsightHttpServicesAccess` and `Revoke-AzHDInsightHttpServicesAccess` cmdlets. These are no longer necessary because HTTP access is always enabled on all HDInsight clusters. +- Added a new `Set-AzHDInsightGatewayCredential` cmdlet. Use this cmdlet to change the gateway HTTP username and password (replaces `Grant-AzHDInsightHttpServicesAccess`). +- Updated the `Get-AzHDInsightJobOutput` cmdlet to support granular role-based access to the storage key. + - Users with HDInsight Cluster Operator, Contributor, or Owner roles will not be affected. + - Users with only the Reader role will need to specify `DefaultStorageAccountKey` parameter explicitly. + +For more information about these role-based access changes, see [aka.ms/hdi-config-update](/azure/hdinsight/hdinsight-migrate-granular-access-cluster-configurations) + + #### Before + + ```powershell + Grant-AzHDInsightHttpServicesAccess -ClusterName $cluster -HttpCredential $credential + ``` + + #### After + + ```powershell + Set-AzHDInsightGatewayCredential -ClusterName $cluster -HttpCredential $credential + ``` + +### Users with only Reader role for cmdlet Get-AzHDInsightJobOutput + + #### Before + + ```powershell + Get-AzHDInsightJobOutput -ClusterName $clusterName -JobId $jobId + ``` + + #### After + + ```powershell + Get-AzHDInsightJobOutput -ClusterName $clusterName -JobId $jobId -DefaultStorageAccountKey $storageAccountKey + ``` + +### Az.Storage + +- Namespaces for types returned from Blob, Queue, and File cmdlets have changed their namespace from `Microsoft.WindowsAzure.Storage` to `Microsoft.Azure.Storage`. While this is not technically a breaking change according to the breaking change policy, it may require some changes in code that uses the methods from the Storage .Net SDK to interact with the objects returned from these cmdlets. + + #### Example 1: Add a message to a Queue (change CloudQueueMessage object namespace) + + Before: + + ```powershell + $queue = Get-AzStorageQueue –Name $queueName –Context $ctx + $queueMessage = New-Object -TypeName "Microsoft.WindowsAzure.Storage.Queue.CloudQueueMessage,$($queue.CloudQueue.GetType().Assembly.FullName)" -ArgumentList "This is message 1" + $queue.CloudQueue.AddMessageAsync($QueueMessage) + ``` + + After: + + ```powershell + $queue = Get-AzStorageQueue –Name $queueName –Context $ctx + $queueMessage = New-Object -TypeName "Microsoft.Azure.Storage.Queue.CloudQueueMessage,$($queue.CloudQueue.GetType().Assembly.FullName)" -ArgumentList "This is message 1" + $queue.CloudQueue.AddMessageAsync($QueueMessage) + ``` + + #### Example 2: Fetch Blob/File Attributes with AccessCondition (change AccessCondition object namespace) + + Before: + + ```powershell + $accessCondition= New-Object Microsoft.WindowsAzure.Storage.AccessCondition + + $blob = Get-AzureStorageBlob -Container $containerName -Blob $blobName + $blob.ICloudBlob.FetchAttributes($accessCondition) + + $file = Get-AzureStorageFile -ShareName $shareName -Path $filepath + $file.FetchAttributes($accessCondition) + ``` + + After: + + ```powershell + $accessCondition= New-Object Microsoft.Azure.Storage.AccessCondition + + $blob = Get-AzureStorageBlob -Container $containerName -Blob $blobName + $blob.ICloudBlob.FetchAttributes($accessCondition) + + $file = Get-AzureStorageFile -ShareName $shareName -Path $filepath + $file.FetchAttributes($accessCondition) + ``` + +- While not technically a breaking change, you will notice output differences in the Sku.Name property of Storage Accounts returned from `New/Get/Set-AzStorageAccount` changes are as follows. (After the change, output and input SkuName are aligned.) + - "StandardLRS" -> "Standard_LRS"; + - "StandardGRS" -> "Standard_GRS"; + - "StandardRAGRS" -> "Standard_RAGRS"; + - "StandardZRS" -> "Standard_ZRS"; + - "PremiumLRS" -> "Premium_LRS"; + +- The default service behavior when creating a storage account withous specifying a Kind has changed. In previous versions, when a storage account was created with no `Kind` specified, the Storage account Kind of `Storage` was used, in the new version `StorageV2` is the default `Kind` value. If you need to create a V1 Storage account with Kind 'Storage', add parameter '-Kind Storage' + + #### Example : Create a storage Account (Default Kind change) + + Before: + + ```powershell + PS c:\> New-AzStorageAccount -ResourceGroupName groupname -Name accountname -SkuName Standard_LRS -Location "westus" + + StorageAccountName ResourceGroupName Location SkuName Kind AccessTier CreationTime ProvisioningState EnableHttpsTrafficOnly + ------------------ ----------------- -------- ------- ---- ---------- ------------ ----------------- ---------------------- + accountname groupname westus StandardLRS Storage Hot 4/17/2018 10:34:32 AM Succeeded False + ``` + + After: + + ```powershell + PS c:\> New-AzStorageAccount -ResourceGroupName groupname -Name accountname -SkuName Standard_LRS -Location "westus" + + StorageAccountName ResourceGroupName Location SkuName Kind AccessTier CreationTime ProvisioningState EnableHttpsTrafficOnly + ------------------ ----------------- -------- ------- ---- ---------- ------------ ----------------- ---------------------- + accountname groupname westus Standard_LRS StorageV2 Hot 4/17/2018 10:34:32 AM Succeeded False + ``` diff --git a/docs-conceptual/azps-10.1.0/migrate-az-3.0.0.md b/docs-conceptual/azps-10.1.0/migrate-az-3.0.0.md new file mode 100644 index 0000000000..705e0aba1c --- /dev/null +++ b/docs-conceptual/azps-10.1.0/migrate-az-3.0.0.md @@ -0,0 +1,933 @@ +--- +description: This migration guide contains a list of breaking changes made to Azure PowerShell in the Az version 3.0 release. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Migration guide for Az 3.0.0 +--- +# Migration Guide for Az 3.0.0 + +This document describes the changes between the 2.0.0 and 3.0.0 versions of Az + +<!-- TOC --> + +- [Migration Guide for Az 3.0.0](#migration-guide-for-az-300) + - [Batch](#batch) + - [`Get-AzBatchNodeAgentSku`](#get-azbatchnodeagentsku) + - [Incompatibility with previous versions of `Az.Resources`](#previous-version-incompatibility-with-azresources-module) + - [Compute](#compute) + - [`New-AzDiskConfig`](#new-azdiskconfig) + - [HDInsight](#hdinsight) + - [`Get-AzHDInsightJobOutput`](#get-azhdinsightjoboutput) + - [`Add-AzHDInsightConfigValues`](#add-azhdinsightconfigvalues) + - [`Disable-AzHDInsightMonitoring`](#disable-azhdinsightmonitoring) + - [`Enable-AzHDInsightMonitoring`](#enable-azhdinsightmonitoring) + - [`Get-AzHDInsightMonitoring`](#get-azhdinsightmonitoring) + - [`Get-AzHDInsightProperty`](#get-azhdinsightproperty) + - [`Grant-AzHDInsightRdpServicesAccess`](#grant-azhdinsightrdpservicesaccess) + - [`Remove-AzHDInsightCluster`](#remove-azhdinsightcluster) + - [`Revoke-AzHDInsightRdpServicesAccess`](#revoke-azhdinsightrdpservicesaccess) + - [`Set-AzHDInsightGatewayCredential`](#set-azhdinsightgatewaycredential) + - [IotHub](#iothub) + - [`New-AzIotHubImportDevices`](#new-aziothubimportdevices) + - [`New-AzIotHubExportDevices`](#new-aziothubexportdevices) + - [`Add-AzIotHubEventHubConsumerGroup`](#add-aziothubeventhubconsumergroup) + - [`Get-AzIotHubEventHubConsumerGroup`](#get-aziothubeventhubconsumergroup) + - [`Remove-AzIotHubEventHubConsumerGroup`](#remove-aziothubeventhubconsumergroup) + - [`Set-AzIotHub`](#set-aziothub) + - [RecoveryServices](#recoveryservices) + - [`Edit-AzRecoveryServicesAsrRecoveryPlan`](#edit-azrecoveryservicesasrrecoveryplan) + - [`Get-AzRecoveryServicesAsrRecoveryPlan`](#get-azrecoveryservicesasrrecoveryplan) + - [`New-AzRecoveryServicesAsrReplicationProtectedItem`](#new-azrecoveryservicesasrreplicationprotecteditem) + - [Resources](#resources) + - [Incompatibility with previous versions of `Az.Batch`](#previous-version-incompatibility-with-azbatch-module) + - [ServiceFabric](#servicefabric) + - [`Add-ServiceFabricApplicationCertificate`](#add-servicefabricapplicationcertificate) + - [Sql](#sql) + - [`Get-AzSqlDatabaseSecureConnectionPolicy`](#get-azsqldatabasesecureconnectionpolicy) + - [`Get-AzSqlDatabaseIndexRecommendations`](#get-azsqldatabaseindexrecommendations) + - [`Get-AzSqlDatabaseRestorePoints`](#get-azsqldatabaserestorepoints) + - [`Get-AzSqlDatabaseAuditing`](#get-azsqldatabaseauditing) + - [`Set-AzSqlDatabaseAuditing`](#set-azsqldatabaseauditing) + - [`Get-AzSqlServerAuditing`](#get-azsqlserverauditing) + - [`Set-AzSqlServerAuditing`](#set-azsqlserverauditing) + - [`Get-AzSqlServerAdvancedThreatProtectionSettings`](#get-azsqlserveradvancedthreatprotectionsettings) + - [`Clear-AzSqlServerAdvancedThreatProtectionSettings`](#clear-azsqlserveradvancedthreatprotectionsettings) + - [`Update-AzSqlServerAdvancedThreatProtectionSettings`](#update-azsqlserveradvancedthreatprotectionsettings) + - [`Get-AzSqlDatabaseAdvancedThreatProtectionSettings`](#get-azsqldatabaseadvancedthreatprotectionsettings) + - [`Update-AzSqlDatabaseAdvancedThreatProtectionSettings`](#update-azsqldatabaseadvancedthreatprotectionsettings) + - [`Clear-AzSqlDatabaseAdvancedThreatProtectionSettings`](#clear-azsqldatabaseadvancedthreatprotectionsettings) + - [`Update-AzSqlDatabaseVulnerabilityAssessmentSettings`](#update-azsqldatabasevulnerabilityassessmentsettings) + - [`Get-AzSqlDatabaseVulnerabilityAssessmentSettings`](#get-azsqldatabasevulnerabilityassessmentsettings) + - [`Clear-AzSqlDatabaseVulnerabilityAssessmentSettings`](#clear-azsqldatabasevulnerabilityassessmentsettings) + - [`Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings`](#update-azsqlinstancedatabasevulnerabilityassessmentsettings) + - [`Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings`](#get-azsqlinstancedatabasevulnerabilityassessmentsettings) + - [`Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings`](#clear-azsqlinstancedatabasevulnerabilityassessmentsettings) + - [`Update-AzSqlInstanceVulnerabilityAssessmentSettings`](#update-azsqlinstancevulnerabilityassessmentsettings) + - [`Get-AzSqlInstanceVulnerabilityAssessmentSettings`](#get-azsqlinstancevulnerabilityassessmentsettings) + - [`Clear-AzSqlInstanceVulnerabilityAssessmentSettings`](#clear-azsqlinstancevulnerabilityassessmentsettings) + - [`Update-AzSqlServerVulnerabilityAssessmentSettings`](#update-azsqlservervulnerabilityassessmentsettings) + - [`Get-AzSqlServerVulnerabilityAssessmentSettings`](#get-azsqlservervulnerabilityassessmentsettings) + - [`Clear-AzSqlServerVulnerabilityAssessmentSettings`](#clear-azsqlservervulnerabilityassessmentsettings) + - [`Get-AzSqlServerAdvancedThreatProtectionPolicy`](#get-azsqlserveradvancedthreatprotectionpolicy) + - [`Get-AzSqlServerThreatDetectionPolicy`](#get-azsqlserverthreatdetectionpolicy) + - [`Remove-AzSqlServerThreatDetectionPolicy`](#remove-azsqlserverthreatdetectionpolicy) + - [`Set-AzSqlServerThreatDetectionPolicy`](#set-azsqlserverthreatdetectionpolicy) + - [`Get-AzSqlDatabaseThreatDetectionPolicy`](#get-azsqldatabasethreatdetectionpolicy) + - [`Set-AzSqlDatabaseThreatDetectionPolicy`](#set-azsqldatabasethreatdetectionpolicy) + - [`Remove-AzSqlDatabaseThreatDetectionPolicy`](#remove-azsqldatabasethreatdetectionpolicy) + +<!-- /TOC --> + + +## Batch + +### `Get-AzBatchNodeAgentSku` +- Removed `Get-AzBatchNodeAgentSku` and replaced it with `Get-AzBatchSupportedImage`. +- `Get-AzBatchSupportedImage` returns the same data as `Get-AzBatchNodeAgentSku` but in a more friendly format. +- New non-verified images are also now returned. Additional information about `Capabilities` and `BatchSupportEndOfLife` for each image is also included. + +#### Before +```powershell +$Context = Get-AzBatchAccountKeys -AccountName "ContosoBatchAccount" +Get-AzBatchNodeAgentSku -BatchContext $Context +``` + +#### After +```powershell +$Context = Get-AzBatchAccountKey -AccountName "ContosoBatchAccount" +Get-AzBatchSupportedImage -BatchContext $Context +``` +### Previous Version Incompatibility with Az.Resources Module +Version 2.0.1 of the ‘Az.Batch’ module is incompatible with earlier versions (version 1.7.0 or earlier) of the ‘Az.Resources’ module. This will result in being unable to import version 1.7.0 of the ‘Az.Resources’ module when version 2.0.1 of the ‘Az.Batch’ module is imported. To fix this issue, simply update the ‘Az.Resources’ module to version 1.7.1 or greater, or simply install the latest version of the ‘Az’ module. + +## Compute + +### `New-AzDiskConfig` +`UploadSizeInBytes` parameter is used instead of `DiskSizeGB` for `New-AzDiskConfig` when CreateOption is Upload + +#### Before +```powershell +$diskconfig = New-AzDiskConfig -Location 'Central US' -DiskSizeGB 1023 -SkuName Standard_LRS -OsType Windows -CreateOption Upload -DiskIOPSReadWrite 500 -DiskMBpsReadWrite 8 +``` + +#### After +```powershell +$diskconfig = New-AzDiskConfig -Location 'Central US' -UploadSizeInBytes 1023 * 1024 * 1024 * 1024 -SkuName Standard_LRS -OsType Windows -CreateOption Upload -DiskIOPSReadWrite 500 -DiskMBpsReadWrite 8 +``` + +## HDInsight + +### `Get-AzHDInsightJobOutput` +- Updated the `Get-AzHDInsightJobOutput` cmdlet to support granular role-based access to the storage key. +- Users with HDInsight Cluster Operator, Contributor, or Owner roles will not be affected. +- Users with only the Reader role will need to specify `DefaultStorageAccountKey` parameter explicitly. + +#### Before +```powershell +Get-AzHDInsightJobOutput -ClusterName $clusterName -JobId $jobId +``` + +#### After +```powershell +Get-AzHDInsightJobOutput -ClusterName $clusterName -JobId $jobId -DefaultStorageAccountKey $storageAccountKey +``` + +### `Add-AzHDInsightConfigValues` +Cmdlet `Add-AzHDInsightConfigValue` removed alias to `Add-AzHDInsightConfigValues`. + +#### Before +Using deprecated alias +```powershell +Add-AzHDInsightConfigValues +``` + +#### After +```powershell +Add-AzHDInsightConfigValue +``` + + +### `Disable-AzHDInsightMonitoring` +Added a new `Disable-AzHDInsightMonitoring` cmdlet. Use this cmdlet to disable monitoring in a HDInsight cluster (replaces `Disable-AzHDInsightOperationsManagementSuite` and `Disable-AzHDInsightOMS`). + +#### Before +```powershell +Disable-AzHDInsightOMS -Name testcluster +``` +```powershell +Disable-AzHDInsightOperationsManagementSuite -Name testcluster +``` + +#### After +```powershell +Disable-AzHDInsightMonitoring -Name testcluster +``` + + +### `Enable-AzHDInsightMonitoring` +Added a new `Enable-AzHDInsightMonitoring` cmdlet. Use this cmdlet to enable monitoring in a HDInsight cluster (replaces `Enable-AzHDInsightOperationsManagementSuite` and `Enable-AzHDInsightOMS`). + +#### Before +```powershell +Enable-AzHDInsightOMS Enable-AzHDInsightMonitoring -Name testcluster -WorkspaceId 1d364e89-bb71-4503-aa3d-a23535aea7bd -PrimaryKey <key for workspace 1d364e89-bb71-4503-aa3d-a23535aea7bd> +``` +```powershell +Enable-AzHDInsightOperationsManagementSuite Enable-AzHDInsightMonitoring -Name testcluster -WorkspaceId 1d364e89-bb71-4503-aa3d-a23535aea7bd -PrimaryKey <key for workspace 1d364e89-bb71-4503-aa3d-a23535aea7bd> +``` + +#### After +```powershell +Enable-AzHDInsightMonitoring Enable-AzHDInsightMonitoring -Name testcluster -WorkspaceId 1d364e89-bb71-4503-aa3d-a23535aea7bd -PrimaryKey <key for workspace 1d364e89-bb71-4503-aa3d-a23535aea7bd> +``` + +### `Get-AzHDInsightMonitoring` +Added a new `Get-AzHDInsightMonitoring` cmdlet. Use this cmdlet to get the status of monitoring installation in an Azure HDInsight cluster (replaces `Get-AzHDInsightOperationsManagementSuite` and `Get-AzHDInsightOMS`). + +#### Before +```powershell +Get-AzHDInsightOMS -Name testcluster +``` +```powershell +Get-AzHDInsightOperationsManagementSuite -Name testcluster +``` + +#### After +```powershell +Get-AzHDInsightMonitoring -Name testcluster +``` + +### `Get-AzHDInsightProperty` +Cmdlet `Get-HDInsightProperty` removed alias to `Get-AzHDInsightProperties`. + +#### Before +Using deprecated alias +```powershell +Get-AzHDInsightProperties -Location "East US 2" +``` + +#### After +```powershell +Get-AzHDInsightProperty -Location "East US 2" +``` + +### `Grant-AzHDInsightRdpServicesAccess` +Removed the `Grant-AzHDInsightRdpServicesAccess` and `Revoke-AzHDInsightRdpServicesAccess` cmdlets. These are no longer necessary because clusters using Windows OS type are not supported. Please create a cluster using Linux OS type instead. + +### `Remove-AzHDInsightCluster` +The output type of `Remove-AzHDInsightCluster` changed from `Microsoft.Azure.Management.HDInsight.Models.ClusterGetResponse` to `bool`. + +#### Before +```powershell +$cluster = Remove-AzHDInsightCluster -ClusterName "your-hadoop-001" +``` + +#### After +```powershell +Remove-AzHDInsightCluster -ClusterName "your-hadoop-001" -PassThru +True +``` + +### `Revoke-AzHDInsightRdpServicesAccess` +The cmdlet is deprecated. There is no replacement for it. + +### `Set-AzHDInsightGatewayCredential` +The output type of `Set-AzHDInsightGatewayCredential` changed from `HttpConnectivitySettings` to `AzureHDInsightGatewaySettings`. + + + +## IotHub + +### `New-AzIotHubImportDevices` +This alias is removed, please use `New-AzIotHubImportDevice` instead. + +#### Before +```powershell +New-AzIotHubImportDevices -ResourceGroupName "myresourcegroup" -Name "myiothub" -InputBlobContainerUri "https://mystorageaccount.blob.core.windows.net/mystoragecontainer?sv=2015-04-05&ss=bfqt&sr=c&srt=sco&sp=rwdl&se=2016-10-27T04:01:48Z&st=2016-10-26T20:01:48Z&spr=https&sig=QqpIhHsIMF8hNuFO%3D" -OutputBlobContainerUri "https://mystorageaccount.blob.core.windows.net/?sv=2015-04-05&ss=bfqt&sr=c&srt=sco&sp=rwdl&se=2016-10-27T04:01:48Z&st=2016-10-26T20:01:48Z&spr=https&sig=QqpIhHsIMF8hNuFO%3D" +``` + +#### After +```powershell +New-AzIotHubImportDevice -ResourceGroupName "myresourcegroup" -Name "myiothub" -InputBlobContainerUri "https://mystorageaccount.blob.core.windows.net/mystoragecontainer?sv=2015-04-05&ss=bfqt&sr=c&srt=sco&sp=rwdl&se=2016-10-27T04:01:48Z&st=2016-10-26T20:01:48Z&spr=https&sig=QqpIhHsIMF8hNuFO%3D" -OutputBlobContainerUri "https://mystorageaccount.blob.core.windows.net/?sv=2015-04-05&ss=bfqt&sr=c&srt=sco&sp=rwdl&se=2016-10-27T04:01:48Z&st=2016-10-26T20:01:48Z&spr=https&sig=QqpIhHsIMF8hNuFO%3D" +``` + +### `New-AzIotHubExportDevices` +This alias is removed, please use `New-AzIotHubExportDevice` instead. + +#### Before +```powershell +New-AzIotHubExportDevices -ResourceGroupName "myresourcegroup" -Name "myiothub" -ExportBlobContainerUri "https://mystorageaccount.blob.core.windows.net/mystoragecontainer?sv=2015-04-05&ss=bfqt&sr=c&srt=sco&sp=rwdl&se=2016-10-27T04:01:48Z&st=2016-10-26T20:01:48Z&spr=https&sig=QqpIhHsIMF8hNuFO%3D" -ExcludeKeys +``` + +#### After +```powershell +New-AzIotHubExportDevice -ResourceGroupName "myresourcegroup" -Name "myiothub" -ExportBlobContainerUri "https://mystorageaccount.blob.core.windows.net/mystoragecontainer?sv=2015-04-05&ss=bfqt&sr=c&srt=sco&sp=rwdl&se=2016-10-27T04:01:48Z&st=2016-10-26T20:01:48Z&spr=https&sig=QqpIhHsIMF8hNuFO%3D" -ExcludeKeys +``` + +### `Add-AzIotHubEventHubConsumerGroup` +Parameter `EventHubEndPointName` is deprecated without being replaced as IotHub comes with only one built-in endpoint("events") which could handle system and device messages. + +#### Before +```powershell +Add-AzIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubConsumerGroupName "myconsumergroup" -EventHubEndpointName "/EventHubEndpointName" +``` + +#### After +```powershell +Add-AzIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubConsumerGroupName "myconsumergroup" +``` + +### `Get-AzIotHubEventHubConsumerGroup` +Parameter `EventHubEndPointName` is deprecated without being replaced as IotHub comes with only one built-in endpoint("events") which could handle system and device messages. + +#### Before +```powershell +Get-AzIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName "/EventHubEndpointName" +``` + +#### After +```powershell +Get-AzIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" +``` + +### `Remove-AzIotHubEventHubConsumerGroup` +Parameter `EventHubEndPointName` is deprecated without being replaced as IotHub comes with only one built-in endpoint("events") which could handle system and device messages. + +#### Before +```powershell +Remove-AzIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubConsumerGroupName myconsumergroup -EventHubEndpointName "/EventHubEndpointName" +``` + +#### After +```powershell +Remove-AzIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubConsumerGroupName myconsumergroup +``` + +### `Set-AzIotHub` +Parameter `OperationsMonitoringProperties` is deprecated without being replaced as IotHub is no longer using built-in endpoint("operationsMonitoringEvents"). + + + +## RecoveryServices + +### `Edit-AzRecoveryServicesAsrRecoveryPlan` +`ASRRecoveryPlanGroup.ReplicationProtectedItems`, `ASRRecoveryPlanGroup.StartGroupActions` and `ASRRecoveryPlanGroup.EndGroupActions` is removed from output. + +### `Get-AzRecoveryServicesAsrRecoveryPlan` +`ASRRecoveryPlanGroup.ReplicationProtectedItems`, `ASRRecoveryPlanGroup.StartGroupActions` and `ASRRecoveryPlanGroup.EndGroupActions` is removed from output. + +### `New-AzRecoveryServicesAsrReplicationProtectedItem` +Parameter IncludeDiskId is changed to support directly writing to a managed disk in Azure Site Recovery. + +#### Before +```powershell +$job = New-AzRecoveryServicesAsrReplicationProtectedItem -RecoveryAzureStorageAccountId $recoveryAzureStorageAccountId -IncludeDiskId $includeDiskId -VMwareToAzure -Account $fabric.FabricSpecificDetails.RunAsAccounts[0] -RecoveryResourceGroupId $RecoveryResourceGroupId -RecoveryAzureNetworkId $RecoveryAzureNetworkId -name $name -ProcessServer $fabric.FabricSpecificDetails.ProcessServers[0] -ProtectableItem $protectableItem -ProtectionContainerMapping $pcm -RecoveryAzureSubnetName $RecoveryAzureSubnetName -RecoveryVmName $RecoveryVmName -LogStorageAccountId $LogStorageAccountId +``` + +#### After +```powershell +$disk1 = New-AzRecoveryServicesAsrInMageAzureV2DiskInput -DiskId $diskId -LogStorageAccountId $logStorageAccountId -DiskType $diskType +$disk2 = New-AzRecoveryServicesAsrInMageAzureV2DiskInput -DiskId $diskId2 -LogStorageAccountId $logStorageAccountId -DiskType $diskType2 +$job = New-AzRecoveryServicesAsrReplicationProtectedItem -VMwareToAzure -Account $fabric.FabricSpecificDetails.RunAsAccounts[0] -RecoveryResourceGroupId $RecoveryResourceGroupId -RecoveryAzureNetworkId $RecoveryAzureNetworkId -name $name -ProcessServer $fabric.FabricSpecificDetails.ProcessServers[0] -ProtectableItem $protectableItem -ProtectionContainerMapping $pcm -RecoveryAzureSubnetName $RecoveryAzureSubnetName -RecoveryVmName $RecoveryVmName -LogStorageAccountId $LogStorageAccountId -InMageAzureV2DiskInput $disk1,$disk2 +``` + +## Resources + +### Previous Version Incompatibility with Az.Batch Module +Version 1.7.1 of the ‘Az.Resources’ module is incompatible with earlier versions (version 1.1.2 or earlier) of the ‘Az.Batch’ module. This will result in being unable to import version 1.1.2 of the ‘Az.Batch’ module when version 1.7.1 of the ‘Az.Resources’ module is imported. To fix this issue, update the ‘Az.Batch’ module to version 2.0.1 or greater, or simply install the latest version of the ‘Az’ module. + +## ServiceFabric + +### `Add-ServiceFabricApplicationCertificate` +Removed `Add-ServiceFabricApplicationCertificate` as this scenario is covered by `Add-AzVmssSecret`. + +#### Before +```powershell +Add-AzServiceFabricApplicationCertificate -ResourceGroupName "Group1" -Name "Contoso01SFCluster" -SecretIdentifier "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" +``` + +#### After +```powershell +$Vault = Get-AzKeyVault -VaultName "ContosoVault" +$CertConfig = New-AzVmssVaultCertificateConfig -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" -CertificateStore "Certificates" +$VMSS = New-AzVmssConfig +Add-AzVmssSecret -VirtualMachineScaleSet $VMSS -SourceVaultId $Vault.ResourceId -VaultCertificate $CertConfig +``` + + +## Sql + +### `Get-AzSqlDatabaseSecureConnectionPolicy` +Note that secure connection is deprecated and so command is removed. Please use the SQL database blade in the Azure portal to view the connection strings + +### `Get-AzSqlDatabaseIndexRecommendations` +`Get-AzSqlDatabaseIndexRecommendations` alias is removed. Use `Get-AzSqlDatabaseIndexRecommendation` instead. + +### `Get-AzSqlDatabaseRestorePoints` +`Get-AzSqlDatabaseRestorePoints` alias is removed. Use `Get-AzSqlDatabaseRestorePoint` instead. + +### `Get-AzSqlDatabaseAuditing` +- The cmdlet `Get-AzSqlDatabaseAudit` is replacing this cmdlet. +- The output type is changing from the existing type :'Microsoft.Azure.Commands.Sql.Auditing.Model.DatabaseBlobAuditingSettingsModel' to the new type :'Microsoft.Azure.Commands.Sql.Auditing.Model.DatabaseAuditingSettingsModel', removing properties `AuditState` and `StorageAccountName`. and `StorageAccountSubscriptionId`. Scripts can retrieve storage account information from the new `StorageAccountResourceId` property. + +#### Before +```powershell +PS C:\> Get-AzSqlDatabaseAuditing -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +DatabaseName : database01 +AuditAction : {} +AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, + BATCH_COMPLETED_GROUP, ...} +ResourceGroupName : resourcegroup01 +ServerName : server01 +AuditState : Enabled +StorageAccountName : mystorage +StorageKeyType : Primary +RetentionInDays : 0 +StorageAccountSubscriptionId : 7fe3301d-31d3-4668-af5e-211a890ba6e3 +PredicateExpression : statement <> 'select 1' +``` + +#### After +```powershell +PS C:\> Get-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" +ServerName : server01 +DatabaseName : database01 +AuditAction : {} +ResourceGroupName : resourcegroup01 +AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, + BATCH_COMPLETED_GROUP, ...} +PredicateExpression : statement <> 'select 1' +BlobStorageTargetState : Enabled +StorageAccountResourceId : /subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage +StorageKeyType : Primary +RetentionInDays : 0 +EventHubTargetState : Enabled +EventHubName : eventHubName +EventHubAuthorizationRuleResourceId : EventHubAuthorizationRuleResourceId +LogAnalyticsTargetState : Enabled +WorkspaceResourceId : "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +### `Set-AzSqlDatabaseAuditing` +- The cmdlet `Set-AzSqlDatabaseAudit` is replacing this cmdlet. +- The output type is changing from the existing type :'Microsoft.Azure.Commands.Sql.Auditing.Model.DatabaseBlobAuditingSettingsModel' to the new type :'bool' + +#### Before +```powershell +Set-AzSqlDatabaseAuditing -State Enabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -StorageAccountName "Storage22" -DatabaseName "Database01" +``` + +#### After +```powershell +Set-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" +``` + +### `Get-AzSqlServerAuditing` +- The cmdlet `Get-AzSqlServerAudit` is replacing this cmdlet. +- The output type is changing from the existing type :'Microsoft.Azure.Commands.Sql.Auditing.Model.DatabaseBlobAuditingSettingsModel' to the new type :'Microsoft.Azure.Commands.Sql.Auditing.Model.ServerAuditingSettingsModel'. Properties `AuditState`, `StorageAccountName`, and `StorageAccountSubscriptionId` are removed. Scripts that use `StorageAccountName` and `StorageAccountSubscriptionId` proeprties can retrieve this information from the new `StorageAccountResourceId` property. + +#### Before +```powershell +PS C:\> Get-AzSqlServerAuditing -ResourceGroupName "resourcegroup01" -ServerName "server01" +AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, BATCH_COMPLETED_GROUP, ...} +ResourceGroupName : resourcegroup01 +ServerName : server01 +AuditState : Enabled +StorageAccountName : mystorage +StorageKeyType : Primary +RetentionInDays : 0 +StorageAccountSubscriptionId : 7fe3301d-31d3-4668-af5e-211a890ba6e3 +PredicateExpression : statement <> 'select 1' +``` + +#### After +```powershell +PS C:\> Get-AzSqlServerAudit -ResourceGroupName "resourcegroup01" -ServerName "server01" +ServerName : server01 +ResourceGroupName : resourcegroup01 +AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, BATCH_COMPLETED_GROUP, ...} +PredicateExpression : statement <> 'select 1' +BlobStorageTargetState : Enabled +StorageAccountResourceId : /subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage +StorageKeyType : Primary +RetentionInDays : 0 +EventHubTargetState : Enabled +EventHubName : eventHubName +EventHubAuthorizationRuleResourceId : EventHubAuthorizationRuleResourceId +LogAnalyticsTargetState : Enabled +WorkspaceResourceId : "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" +``` + +### `Set-AzSqlServerAuditing` +- The cmdlet `Set-AzSqlServerAudit` is replacing this cmdlet. +- The output type is changing from the existing type :'Microsoft.Azure.Commands.Sql.Auditing.Model.DatabaseBlobAuditingSettingsModel' to the new type :'bool' + +#### Before +```powershell +Set-AzSqlServerAuditing -State Enabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -StorageAccountName "Storage22" +``` + +#### After +```powershell +PS C:\> Set-AzSqlServerAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" +``` + +### `Get-AzSqlServerAdvancedThreatProtectionSettings` +Cmdlet `Get-AzSqlServerAdvancedThreatProtectionSettings` is replaced by `Get-AzSqlServerAdvancedThreatProtectionSetting` + +#### Before +```powershell +Get-AzSqlServerAdvancedThreatProtectionSettings -ResourceGroupName "ResourceGroup11" -ServerName "Server01" +``` + +#### After +```powershell +Get-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" +``` + +### `Clear-AzSqlServerAdvancedThreatProtectionSettings` +Cmdlet `Clear-AzSqlServerAdvancedThreatProtectionSettings` is replaced by `Clear-AzSqlServerAdvancedThreatProtectionSetting` + +#### Before +```powershell +Clear-AzSqlServerAdvancedThreatProtectionSettings -ResourceGroupName "ResourceGroup11" -ServerName "Server01" +``` + +#### After +```powershell +Clear-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" +``` + +### `Update-AzSqlServerAdvancedThreatProtectionSettings` +Cmdlet `Update-AzSqlServerAdvancedThreatProtectionSettings` is replaced by `Update-AzSqlServerAdvancedThreatProtectionSetting` + +#### Before +```powershell +Update-AzSqlServerAdvancedThreatProtectionSettings -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability","SQL_Injection" -StorageAccountName "mystorageAccount" +``` + +#### After +```powershell +Update-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability","SQL_Injection" -StorageAccountName "mystorageAccount" +``` + +### `Get-AzSqlDatabaseAdvancedThreatProtectionSettings` +Cmdlet `Get-AzSqlDatabaseAdvancedThreatProtectionSettings` is replaced by `Get-AzSqlDatabaseAdvancedThreatProtectionSetting` + +#### Before +```powershell +Get-AzSqlDatabaseAdvancedThreatProtectionSettings -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" +``` + +#### After +```powershell +Get-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" +``` + +### `Update-AzSqlDatabaseAdvancedThreatProtectionSettings` +Cmdlet `Update-AzSqlDatabaseAdvancedThreatProtectionSettings` is repleaced by `Update-AzSqlDatabaseAdvancedThreatProtectionSetting` + +#### Before +```powershell +Update-AzSqlDatabaseAdvancedThreatProtectionSettings -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability", "SQL_Injection" -StorageAccountName "mystorageAccount" +``` + +#### After +```powershell +Update-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability", "SQL_Injection" -StorageAccountName "mystorageAccount" +``` + +### `Clear-AzSqlDatabaseAdvancedThreatProtectionSettings` +Cmdlet `Clear-AzSqlDatabaseAdvancedThreatProtectionSettings` is repleaced by `Clear-AzSqlDatabaseAdvancedThreatProtectionSetting` + +#### Before +```powershell +Clear-AzSqlDatabaseAdvancedThreatProtectionSettings -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" +``` + +#### After +```powershell +Clear-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" +``` + +### `Update-AzSqlDatabaseVulnerabilityAssessmentSettings` +Cmdlet `Update-AzSqlDatabaseVulnerabilityAssessmentSettings` is repleaced by `Update-AzSqlDatabaseVulnerabilityAssessmentSetting` + +#### Before +```powershell +Update-AzSqlDatabaseVulnerabilityAssessmentSettings ` + -ResourceGroupName "ResourceGroup01"` + -ServerName "Server01"` + -DatabaseName "Database01" ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailSubscriptionAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +#### After +```powershell +Update-AzSqlDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01"` + -ServerName "Server01"` + -DatabaseName "Database01" ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailSubscriptionAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + + +### `Get-AzSqlDatabaseVulnerabilityAssessmentSettings` +Cmdlet `Get-AzSqlDatabaseVulnerabilityAssessmentSettings` is repleaced by `Get-AzSqlDatabaseVulnerabilityAssessmentSetting` + +#### Before +```powershell +Get-AzSqlDatabaseVulnerabilityAssessmentSettings ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +#### After +```powershell +Get-AzSqlDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +### `Clear-AzSqlDatabaseVulnerabilityAssessmentSettings` +Cmdlet `Clear-AzSqlDatabaseVulnerabilityAssessmentSettings` is repleaced by `Clear-AzSqlDatabaseVulnerabilityAssessmentSetting` + +#### Before +```powershell +Clear-AzSqlDatabaseVulnerabilityAssessmentSettings ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +#### After +```powershell +Clear-AzSqlDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +### `Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings` +Cmdlet `Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings` is repleaced by `Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting` + +#### Before +```powershell +Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailSubscriptionAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +#### After +```powershell +Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -DatabaseName "Database01" ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailSubscriptionAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +### `Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings` +Cmdlet `Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings` is repleaced by `Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting` + +#### Before +```powershell +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +#### After +```powershell +Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +### `Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings` +Cmdlet `Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings` is repleaced by `Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting` + +#### Before +```powershell +Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSettings ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +#### After +```powershell +Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +### `Update-AzSqlInstanceVulnerabilityAssessmentSettings` +Cmdlet `Update-AzSqlInstanceVulnerabilityAssessmentSettings` is repleaced by `Update-AzSqlInstanceVulnerabilityAssessmentSetting` + +#### Before +```powershell +Update-AzSqlInstanceVulnerabilityAssessmentSettings ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailSubscriptionAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +#### After +```powershell +Update-AzSqlInstanceVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -InstanceName "ManagedInstance01" ` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailSubscriptionAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +### `Get-AzSqlInstanceVulnerabilityAssessmentSettings` +Cmdlet `Get-AzSqlInstanceVulnerabilityAssessmentSettings` is repleaced by `Get-AzSqlInstanceVulnerabilityAssessmentSetting` + +#### Before +```powershell +Get-AzSqlInstanceVulnerabilityAssessmentSettings ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +#### After +```powershell +Get-AzSqlInstanceVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +### `Clear-AzSqlInstanceVulnerabilityAssessmentSettings` +Cmdlet `Clear-AzSqlInstanceVulnerabilityAssessmentSettings` is repleaced by `Clear-AzSqlInstanceVulnerabilityAssessmentSetting` + +#### Before +```powershell +Clear-AzSqlInstanceVulnerabilityAssessmentSettings ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +#### After +```powershell +Clear-AzSqlInstanceVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +### `Update-AzSqlServerVulnerabilityAssessmentSettings` +Cmdlet `Update-AzSqlServerVulnerabilityAssessmentSettings` is repleaced by `Update-AzSqlServerVulnerabilityAssessmentSetting` + +#### Before +```powershell +Update-AzSqlServerVulnerabilityAssessmentSettings ` + -ResourceGroupName "ResourceGroup01"` + -ServerName "Server01"` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailSubscriptionAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +#### After +```powershell +Update-AzSqlServerVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01"` + -ServerName "Server01"` + -StorageAccountName "mystorage" ` + -ScanResultsContainerName "vulnerability-assessment" ` + -RecurringScansInterval Weekly ` + -EmailSubscriptionAdmins $true ` + -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") +``` + +### `Get-AzSqlServerVulnerabilityAssessmentSettings` +Cmdlet `Get-AzSqlServerVulnerabilityAssessmentSettings` is repleaced by `Get-AzSqlServerVulnerabilityAssessmentSetting` + +#### Before +```powershell +Get-AzSqlServerVulnerabilityAssessmentSettings ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +#### After +```powershell +Get-AzSqlServerVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +### `Clear-AzSqlServerVulnerabilityAssessmentSettings` +Cmdlet `Clear-AzSqlServerVulnerabilityAssessmentSettings` is repleaced by `Clear-AzSqlServerVulnerabilityAssessmentSetting` + +#### Before +```powershell +Clear-AzSqlServerVulnerabilityAssessmentSettings ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +#### After +```powershell +Clear-AzSqlDatabaseVulnerabilityAssessmentSetting ` + -ResourceGroupName "ResourceGroup01" ` + -ServerName "Server01" ` + -DatabaseName "Database01" +``` + +### `Get-AzSqlServerAdvancedThreatProtectionPolicy` +Cmdlet `Get-AzSqlServerAdvancedThreatProtectionPolicy` is deleted and no cmdlet is repleaced it + +### `Get-AzSqlServerThreatDetectionPolicy` +Cmdlet `Get-AzSqlServerThreatDetectionPolicy` is repleaced by `Get-AzSqlServerThreatDetectionSetting` + +#### Before +```powershell +PS C:\> Get-AzSqlServerThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" +ResourceGroupName : ResourceGroup11 +ServerName : Server01 +ThreatDetectionState : Enabled +NotificationRecipientsEmails : admin@myCompany.com +StorageAccountName : mystorage +EmailAdmins : True +ExcludedDetectionTypes : {} +RetentionInDays : 0 +``` + +#### After +```powershell +PS C:\> Get-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" +ResourceGroupName : ResourceGroup11 +ServerName : Server01 +ThreatDetectionState : Enabled +NotificationRecipientsEmails : admin@myCompany.com +StorageAccountName : mystorage +EmailAdmins : True +ExcludedDetectionTypes : {} +RetentionInDays : 0 +``` + +### `Remove-AzSqlServerThreatDetectionPolicy` +Cmdlet `Remove-AzSqlServerThreatDetectionPolicy` is repleaced by `Clear-AzSqlServerAdvancedThreatProtectionSetting` + +#### Before +```powershell +Remove-AzSqlServerThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" +``` + +#### After +```powershell +Clear-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" +``` + +### `Set-AzSqlServerThreatDetectionPolicy` +Cmdlet `Set-AzSqlServerThreatDetectionPolicy` is repleaced by `Update-AzSqlServerAdvancedThreatProtectionSetting` + +#### Before +```powershell +Set-AzSqlServerThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability","SQL_Injection" -StorageAccountName "mystorageAccount" +``` + +#### After +```powershell +Update-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability","SQL_Injection" -StorageAccountName "mystorageAccount" +``` + +### `Get-AzSqlDatabaseThreatDetectionPolicy` +Cmdlet `Get-AzSqlDatabaseThreatDetectionPolicy` is repleaced by `Get-AzSqlDatabaseThreatDetectionSetting` + +#### Before +```powershell +PS C:\> Get-AzSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" +DatabaseName : Database01 +ResourceGroupName : ResourceGroup11 +ServerName : Server01 +ThreatDetectionState : Enabled +NotificationRecipientsEmails : admin@myCompany.com +StorageAccountName : mystorage +EmailAdmins : True +ExcludedDetectionTypes : {} +RetentionInDays : 0 +``` + +#### After +```powershell +PS C:\> Get-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" +DatabaseName : Database01 +ResourceGroupName : ResourceGroup11 +ServerName : Server01 +ThreatDetectionState : Enabled +NotificationRecipientsEmails : admin@myCompany.com +StorageAccountName : mystorage +EmailAdmins : True +ExcludedDetectionTypes : {} +RetentionInDays : 0 +``` + +### `Set-AzSqlDatabaseThreatDetectionPolicy` +Cmdlet `Set-AzSqlDatabaseThreatDetectionPolicy` is repleaced by `Update-AzSqlDatabaseAdvancedThreatProtectionSetting` + +#### Before +```powershell +Set-AzSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability", "SQL_Injection" -StorageAccountName "mystorageAccount" +``` + +#### After +```powershell +Update-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability", "SQL_Injection" -StorageAccountName "mystorageAccount" +``` + +### `Remove-AzSqlDatabaseThreatDetectionPolicy` +Cmdlet `Remove-AzSqlDatabaseThreatDetectionPolicy` is repleaced by `Clear-AzSqlDatabaseAdvancedThreatProtectionSetting` + +#### Before +```powershell +Remove-AzSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" +``` + +#### After +```powershell +Clear-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" +``` diff --git a/docs-conceptual/azps-10.1.0/migrate-az-4.1.0.md b/docs-conceptual/azps-10.1.0/migrate-az-4.1.0.md new file mode 100644 index 0000000000..5b2338982e --- /dev/null +++ b/docs-conceptual/azps-10.1.0/migrate-az-4.1.0.md @@ -0,0 +1,918 @@ +--- +description: This migration guide contains a list of breaking changes made to Azure PowerShell in the Az version 4.1.0 release. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Migration guide for Az 4.1.0 +--- + +# Migration Guide for Az 4.1.0 + +This document describes the changes between the 3.0.0 and 4.1.0 versions of Az. + +- [Migration Guide for Az 4.1.0](#migration-guide-for-az-410) + - [Az.ApiManagement](#azapimanagement) + - [`Add-AzApiManagementRegion`](#add-azapimanagementregion) + - [`New-AzApiManagement`](#new-azapimanagement) + - [`Set-AzApiManagement`](#set-azapimanagement) + - [`Get-AzApiManagementProperty`](#get-azapimanagementproperty) + - [`New-AzApiManagementProperty`](#new-azapimanagementproperty) + - [`Remove-AzApiManagementProperty`](#remove-azapimanagementproperty) + - [`Set-AzApiManagementProperty`](#set-azapimanagementproperty) + - [Az.Batch](#azbatch) + - [`Get-AzBatchApplication`, `New-AzBatchApplication`](#get-azbatchapplication-new-azbatchapplication) + - [`Get-AzBatchComputeNode`, `New-AzBatchPool`](#get-azbatchcomputenode-new-azbatchpool) + - [`Get-AzBatchApplicationPackage`, `New-AzBatchApplicationPackage`](#get-azbatchapplicationpackage-new-azbatchapplicationpackage) + - [Az.Compute](#azcompute) + - [`Remove-AzVmssDiagnosticsExtension`](#remove-azvmssdiagnosticsextension) + - [`Get-AzVMImage`](#get-azvmimage) + - [`New-AzVMConfig`](#new-azvmconfig) + - [`Update-AzVM`](#update-azvm) + - [`New-AzProximityPlacementGroup`](#new-azproximityplacementgroup) + - [`Remove-AzProximityPlacementGroup`](#remove-azproximityplacementgroup) + - [`Get-AzProximityPlacementGroup`](#get-azproximityplacementgroup) + - [`Add-AzVmssAdditionalUnattendContent`](#add-azvmssadditionalunattendcontent) + - [`Add-AzVmssDataDisk`](#add-azvmssdatadisk) + - [`Add-AzVmssExtension`](#add-azvmssextension) + - [`Add-AzVmssNetworkInterfaceConfiguration`](#add-azvmssnetworkinterfaceconfiguration) + - [`Add-AzVmssSecret`](#add-azvmsssecret) + - [`Add-AzVmssSshPublicKey`](#add-azvmsssshpublickey) + - [`Add-AzVmssWinRMListener`](#add-azvmsswinrmlistener) + - [`New-AzVmssConfig`](#new-azvmssconfig) + - [`Remove-AzVmssDataDisk`](#remove-azvmssdatadisk) + - [`Remove-AzVmssExtension`](#remove-azvmssextension) + - [`Remove-AzVmssNetworkInterfaceConfiguration`](#remove-azvmssnetworkinterfaceconfiguration) + - [`Set-AzVmssBootDiagnostic`](#set-azvmssbootdiagnostic) + - [`Set-AzVmssOsProfile`](#set-azvmssosprofile) + - [`Set-AzVmssRollingUpgradePolicy`](#set-azvmssrollingupgradepolicy) + - [`Set-AzVmssStorageProfile`](#set-azvmssstorageprofile) + - [`New-AzVmss`](#new-azvmss) + - [`Repair-AzVmssServiceFabricUpdateDomain`](#repair-azvmssservicefabricupdatedomain) + - [`Get-AzVmss`](#get-azvmss) + - [`Set-AzVmssOrchestrationServiceState`](#set-azvmssorchestrationservicestate) + - [`Update-AzVmss`](#update-azvmss) + - [`Add-AzVmssDiagnosticsExtension`](#add-azvmssdiagnosticsextension) + - [`Disable-AzVmssDiskEncryption`](#disable-azvmssdiskencryption) + - [Az.KeyVault](#azkeyvault) + - [`New-AzKeyVaultCertificateOrganizationDetail`](#new-azkeyvaultcertificateorganizationdetail) + - [`New-AzKeyVaultCertificateAdministratorDetail`](#new-azkeyvaultcertificateadministratordetail) + - [`New-AzKeyVault`](#new-azkeyvault) + - [Az.Monitor](#azmonitor) + - [`Add-AzLogProfile`](#add-azlogprofile) + - [`Get-AzLogProfile`](#get-azlogprofile) + - [`New-AzMetricAlertRuleV2Criteria`](#new-azmetricalertrulev2criteria) + - [Az.Network](#aznetwork) + - [`Get-AzNetworkWatcherConnectionMonitor`](#get-aznetworkwatcherconnectionmonitor) + - [`New-AzNetworkWatcherConnectionMonitorTestConfigurationObject`](#new-aznetworkwatcherconnectionmonitortestconfigurationobject) + - [Az.OperationalInsights](#azoperationalinsights) + - [`Get-AzOperationalInsightsDataSource`](#get-azoperationalinsightsdatasource) + - [`New-AzOperationalInsightsApplicationInsightsDataSource`](#new-azoperationalinsightsapplicationinsightsdatasource) + - [`New-AzOperationalInsightsAzureActivityLogDataSource`](#new-azoperationalinsightsazureactivitylogdatasource) + - [`New-AzOperationalInsightsCustomLogDataSource`](#new-azoperationalinsightscustomlogdatasource) + - [`New-AzOperationalInsightsLinuxPerformanceObjectDataSource`](#new-azoperationalinsightslinuxperformanceobjectdatasource) + - [`New-AzOperationalInsightsLinuxSyslogDataSource`](#new-azoperationalinsightslinuxsyslogdatasource) + - [`New-AzOperationalInsightsWindowsEventDataSource`](#new-azoperationalinsightswindowseventdatasource) + - [`New-AzOperationalInsightsWindowsPerformanceCounterDataSource`](#new-azoperationalinsightswindowsperformancecounterdatasource) + - [`Remove-AzOperationalInsightsDataSource`](#remove-azoperationalinsightsdatasource) + - [`Disable-AzOperationalInsightsIISLogCollection`](#disable-azoperationalinsightsiislogcollection) + - [`Disable-AzOperationalInsightsLinuxCustomLogCollection`](#disable-azoperationalinsightslinuxcustomlogcollection) + - [`Disable-AzOperationalInsightsLinuxPerformanceCollection`](#disable-azoperationalinsightslinuxperformancecollection) + - [`Disable-AzOperationalInsightsLinuxSyslogCollection`](#disable-azoperationalinsightslinuxsyslogcollection) + - [`Enable-AzOperationalInsightsIISLogCollection`](#enable-azoperationalinsightsiislogcollection) + - [`Enable-AzOperationalInsightsLinuxCustomLogCollection`](#enable-azoperationalinsightslinuxcustomlogcollection) + - [`Enable-AzOperationalInsightsLinuxPerformanceCollection`](#enable-azoperationalinsightslinuxperformancecollection) + - [`Enable-AzOperationalInsightsLinuxSyslogCollection`](#enable-azoperationalinsightslinuxsyslogcollection) + - [`Get-AzOperationalInsightsSavedSearch`](#get-azoperationalinsightssavedsearch) + - [`Get-AzOperationalInsightsSavedSearchResult`](#get-azoperationalinsightssavedsearchresult) + - [`Get-AzOperationalInsightsSearchResult`](#get-azoperationalinsightssearchresult) + - [`Get-AzOperationalInsightsStorageInsight`](#get-azoperationalinsightsstorageinsight) + - [`New-AzOperationalInsightsStorageInsight`](#new-azoperationalinsightsstorageinsight) + - [`Remove-AzOperationalInsightsStorageInsight`](#remove-azoperationalinsightsstorageinsight) + - [`Set-AzOperationalInsightsStorageInsight`](#set-azoperationalinsightsstorageinsight) + - [`Get-AzOperationalInsightsLinkTarget`](#get-azoperationalinsightslinktarget) + - [`Get-AzOperationalInsightsWorkspace`](#get-azoperationalinsightsworkspace) + - [`New-AzOperationalInsightsWorkspace`](#new-azoperationalinsightsworkspace) + - [`Set-AzOperationalInsightsWorkspace`](#set-azoperationalinsightsworkspace) + - [`Invoke-AzOperationalInsightsQuery`](#invoke-azoperationalinsightsquery) + - [Az.Resources](#azresources) + - [`Get-AzDeploymentScript`](#get-azdeploymentscript) + - [`Get-AzDeploymentScriptLog`](#get-azdeploymentscriptlog) + - [`Save-AzDeploymentScriptLog`](#save-azdeploymentscriptlog) + - [`Get-AzResourceLock, New-AzResourceLock, Remove-AzResourceLock, Set-AzResourceLock`](#get-azresourcelock-new-azresourcelock-remove-azresourcelock-set-azresourcelock) + - [`Get-AzPolicyAlias`](#get-azpolicyalias) + - [`New-AzPolicyAssignment`](#new-azpolicyassignment) + - [`Remove-AzDeploymentScript`](#remove-azdeploymentscript) + - [Az.Storage](#azstorage) + - [`Update-AzStorageAccountNetworkRuleSet`, `Get-AzStorageAccountNetworkRuleSet`](#update-azstorageaccountnetworkruleset-get-azstorageaccountnetworkruleset) + - [`New-AzStorageTable`, `Get-AzStorageTable`](#new-azstoragetable-get-azstoragetable) + - [`Get-AzStorageFile`, `Remove-AzStorageFile`, `Get-AzStorageFileContent`, `Set-AzStorageFileContent`, `Start-AzStorageFileCopy`](#get-azstoragefile-remove-azstoragefile-get-azstoragefilecontent-set-azstoragefilecontent-start-azstoragefilecopy) + - [`Get-AzStorageFile`, `New-AzStorageDirectory`, `Remove-AzStorageDirectory`](#get-azstoragefile-new-azstoragedirectory-remove-azstoragedirectory) + - [`Get-AzStorageShare`, `New-AzStorageShare`, `Remove-AzStorageShare`](#get-azstorageshare-new-azstorageshare-remove-azstorageshare) + - [`Set-AzStorageShareQuota`](#set-azstoragesharequota) + - [`Remove-AzStorageDirectory`](#remove-azstoragedirectory) + +## Az.ApiManagement + +### `Add-AzApiManagementRegion` + +The type of property `Type` of type +`Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementServiceIdentity` has changed from +`Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementServiceIdentityType` to +`System.String`. + +### `New-AzApiManagement` + +- The cmdlet `New-AzApiManagement` no longer supports the parameter `AssignIdentity` and no alias + was found for the original parameter name. +- The parameter set `__AllParameterSets` for cmdlet `New-AzApiManagement` has been removed. + +### `Set-AzApiManagement` + +- The cmdlet `Set-AzApiManagement` no longer supports the parameter `AssignIdentity` and no alias + was found for the original parameter name. +- The parameter set `__AllParameterSets` for cmdlet `Set-AzApiManagement` has been removed. + +### `Get-AzApiManagementProperty` + +The cmdlet `Get-AzApiManagementProperty` has been replaced by `Get-AzApiManagementNamedValue`. + +### `New-AzApiManagementProperty` + +The cmdlet `New-AzApiManagementProperty` has been replaced by `New-AzApiManagementNamedValue`. + +### `Remove-AzApiManagementProperty` + +The cmdlet `Remove-AzApiManagementProperty` has been replaced by `Remove-AzApiManagementNamedValue`. + +### `Set-AzApiManagementProperty` + +The cmdlet `Set-AzApiManagementProperty` has been replaced by `Set-AzApiManagementNamedValue`. + +## Az.Batch + +### `Get-AzBatchApplication`, `New-AzBatchApplication` + +The property `ApplicationPackages` of type `Microsoft.Azure.Commands.Batch.Models.PSApplication` has +been removed. + +### `Get-AzBatchComputeNode`, `New-AzBatchPool` + +The property `PublicIPs` of type `Microsoft.Azure.Commands.Batch.Models.PSNetworkConfiguration` has +been removed + +### `Get-AzBatchApplicationPackage`, `New-AzBatchApplicationPackage` + +The type of property `StorageUrlExpiry` of type +`Microsoft.Azure.Commands.Batch.Models.PSApplicationPackage` has changed from `System.DateTime` to +`System.DateTime?`. + +## Az.Compute + +### `Remove-AzVmssDiagnosticsExtension` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Get-AzVMImage` + +- The cmdlet `Get-AzVMImage` no longer supports the parameter `FilterExpression` and no alias was + found for the original parameter name. +- The parameter set `ListVMImage` for cmdlet `Get-AzVMImage` has been removed. + +### `New-AzVMConfig` + +- The cmdlet `New-AzVMConfig` no longer supports the parameter `AssignIdentity` and no alias was + found for the original parameter name. +- The parameter set `AssignIdentityParameterSet` for cmdlet `New-AzVMConfig` has been removed. + +### `Update-AzVM` + +- The cmdlet `Update-AzVM` no longer supports the parameter `AssignIdentity` and no alias was found + for the original parameter name. +- The parameter set `AssignIdentityParameterSet` for cmdlet `Update-AzVM` has been removed. + +### `New-AzProximityPlacementGroup` + +- The generic type for property `VirtualMachines`, `VirtualMachineScaleSets`, and `AvailabilitySets` + has been changed from + `System.Collections.Generic.IList1[Microsoft.Azure.Management.Compute.Models.SubResource]` to + `System.Collections.Generic.IList1[Microsoft.Azure.Management.Compute.Models.SubResourceWithColocationStatus]`. +- The property `VirtualMachinesColocationStatus`, `VirtualMachineScaleSetsColocationStatus`, and + `AvailabilitySetsColocationStatus` of type + `Microsoft.Azure.Commands.Compute.Automation.Models.PSProximityPlacementGroup` has been removed. + +#### Before + +```powershell +PS C:\> New-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName -Name $proximityPlacementGroupName -Location $location -Tag @{key1 = 'val1'} | Format-List + +ResourceGroupName : $resourceGroupName +ProximityPlacementGroupType : Standard +VirtualMachinesColocationStatus : {} +VirtualMachineScaleSetsColocationStatus : {} +AvailabilitySetsColocationStatus : {} +ColocationStatus : +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/$resourceGroupName/providers/Microsoft.Compute/proximityPlacementGroups/$proximityPlacementGroupName +Name : $proximityPlacementGroupName +Type : Microsoft.Compute/proximityPlacementGroups +Location : $location +Tags : {[key1, val1]} +VirtualMachines : {} +VirtualMachineScaleSets : {} +AvailabilitySets : {} +``` + +#### After + +```powershell +PS C:\> New-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName -Name $proximityPlacementGroupName -Location $location -Tag @{key1 = 'val1'} | Format-List + +ResourceGroupName : $resourceGroupName +ProximityPlacementGroupType : StandardColocationStatus : +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/$resourceGroupName/providers/Microsoft.Compute/proximityPlacementGroups/$proximityPlacementGroupName +Name : $proximityPlacementGroupName +Type : Microsoft.Compute/proximityPlacementGroups +Location : $location +Tags : {[key1, val1]} +VirtualMachines : {} +VirtualMachineScaleSets : {} +AvailabilitySets : {} +``` + +### `Remove-AzProximityPlacementGroup` + +- The generic type for property `VirtualMachines`, `VirtualMachineScaleSets`, and `AvailabilitySets` + has been changed from + `System.Collections.Generic.IList1[Microsoft.Azure.Management.Compute.Models.SubResource]` to + `System.Collections.Generic.IList1[Microsoft.Azure.Management.Compute.Models.SubResourceWithColocationStatus]`. +- The property `VirtualMachinesColocationStatus`, `VirtualMachineScaleSetsColocationStatus`, and + `AvailabilitySetsColocationStatus` of type + `Microsoft.Azure.Commands.Compute.Automation.Models.PSProximityPlacementGroup` has been removed. + +#### Before + +```powershell +PS C:\> Get-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName -Name $proximityPlacementGroupName | Remove-AzProximityPlacementGroup | Format-List + +ResourceGroupName : $resourceGroupName +ProximityPlacementGroupType : Standard +VirtualMachinesColocationStatus : {} +VirtualMachineScaleSetsColocationStatus : {} +AvailabilitySetsColocationStatus : {} +ColocationStatus : +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/$resourceGroupName/providers/Microsoft.Compute/proximityPlacementGroups/$proximityPlacementGroupName +Name : $proximityPlacementGroupName +Type : Microsoft.Compute/proximityPlacementGroups +Location : $location +Tags : {[key1, val1]} +VirtualMachines : {} +VirtualMachineScaleSets : {} +AvailabilitySets : {} +``` + +#### After + +```powershell +PS C:\> Get-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName -Name $proximityPlacementGroupName | Remove-AzProximityPlacementGroup | Format-List + +ResourceGroupName : $resourceGroupName +ProximityPlacementGroupType : StandardColocationStatus : +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/$resourceGroupName/providers/Microsoft.Compute/proximityPlacementGroups/$proximityPlacementGroupName +Name : $proximityPlacementGroupName +Type : Microsoft.Compute/proximityPlacementGroups +Location : $location +Tags : {[key1, val1]} +VirtualMachines : {} +VirtualMachineScaleSets : {} +AvailabilitySets : {} +``` + +### `Get-AzProximityPlacementGroup` + +- The generic type for property `VirtualMachines`, `VirtualMachineScaleSets`, and `AvailabilitySets` + has been changed from + `System.Collections.Generic.IList1[Microsoft.Azure.Management.Compute.Models.SubResource]` to + `System.Collections.Generic.IList1[Microsoft.Azure.Management.Compute.Models.SubResourceWithColocationStatus]`. +- The property `VirtualMachinesColocationStatus`, `VirtualMachineScaleSetsColocationStatus`, and + `AvailabilitySetsColocationStatus` of type + `Microsoft.Azure.Commands.Compute.Automation.Models.PSProximityPlacementGroup` has been removed. + +#### Before + +```powershell +PS C:\> Get-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName -Name $proximityPlacementGroupName | Format-List + +ResourceGroupName : $resourceGroupName +ProximityPlacementGroupType : Standard +VirtualMachinesColocationStatus : {} +VirtualMachineScaleSetsColocationStatus : {} +AvailabilitySetsColocationStatus : {} +ColocationStatus : +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/$resourceGroupName/providers/Microsoft.Compute/proximityPlacementGroups/$proximityPlacementGroupName +Name : $proximityPlacementGroupName +Type : Microsoft.Compute/proximityPlacementGroups +Location : $location +Tags : {[key1, val1]} +VirtualMachines : {} +VirtualMachineScaleSets : {} +AvailabilitySets : {} +``` + +#### After + +```powershell +PS C:\> Get-AzProximityPlacementGroup -ResourceGroupName $resourceGroupName -Name $proximityPlacementGroupName | Format-List + +ResourceGroupName : $resourceGroupName +ProximityPlacementGroupType : StandardColocationStatus : +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/$resourceGroupName/providers/Microsoft.Compute/proximityPlacementGroups/$proximityPlacementGroupName +Name : $proximityPlacementGroupName +Type : Microsoft.Compute/proximityPlacementGroups +Location : $location +Tags : {[key1, val1]} +VirtualMachines : {} +VirtualMachineScaleSets : {} +AvailabilitySets : {} +``` + +### `Add-AzVmssAdditionalUnattendContent` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Add-AzVmssDataDisk` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Add-AzVmssExtension` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Add-AzVmssNetworkInterfaceConfiguration` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Add-AzVmssSecret` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Add-AzVmssSshPublicKey` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Add-AzVmssWinRMListener` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `New-AzVmssConfig` + +- The type of property `AutomaticRepairsPolicy` of type + `Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from + `Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to + `Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. +- No longer supports the parameter `AutomaticRepairMaxInstanceRepairsPercent` and no alias was found for the original parameter name. +- No longer supports the parameter `AssignIdentity` and no alias was found for the original parameter name. +- The parameter set `__AllParameterSets` has been removed. +- The parameter set `ExplicitIdentityParameterSet` has been removed. +- The parameter set `AssignIdentityParameterSet` has been removed. + +### `Remove-AzVmssDataDisk` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Remove-AzVmssExtension` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Remove-AzVmssNetworkInterfaceConfiguration` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Set-AzVmssBootDiagnostic` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Set-AzVmssOsProfile` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Set-AzVmssRollingUpgradePolicy` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Set-AzVmssStorageProfile` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `New-AzVmss` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Repair-AzVmssServiceFabricUpdateDomain` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Get-AzVmss` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Set-AzVmssOrchestrationServiceState` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Update-AzVmss` + +- The type of property `AutomaticRepairsPolicy` of type + `Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from + `Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to + `Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. +- No longer supports the parameter `AutomaticRepairMaxInstanceRepairsPercent` and no alias was found + for the original parameter name. +- The parameter set `__AllParameterSets` has been removed. +- The parameter set `ExplicitIdentityParameterSet` has been removed. + +### `Add-AzVmssDiagnosticsExtension` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +### `Disable-AzVmssDiskEncryption` + +The type of property `AutomaticRepairsPolicy` of type +`Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet` has changed from +`Microsoft.Azure.Commands.Compute.Automation.Models.PSAutomaticRepairsPolicy` to +`Microsoft.Azure.Management.Compute.Models.AutomaticRepairsPolicy`. + +## Az.KeyVault + +### `New-AzKeyVaultCertificateOrganizationDetail` + +The alias `New-AzKeyVaultCertificateOrganizationDetails` is removed. Please use `New-AzKeyVaultCertificateOrganizationDetail`. + +#### Before + +```powershell +PS C:\> New-AzKeyVaultCertificateOrganizationDetails -AdministratorDetails $AdminDetails +``` + +#### After + +```powershell +PS C:\> New-AzKeyVaultCertificateOrganizationDetail -AdministratorDetails $AdminDetails +``` + +### `New-AzKeyVaultCertificateAdministratorDetail` + +The alias `New-AzKeyVaultCertificateAdministratorDetails` is removed. Please use `New-AzKeyVaultCertificateAdministratorDetail`. + +#### Before + +```powershell +PS C:\> $AdminDetails = New-AzKeyVaultCertificateAdministratorDetails -FirstName 'Patti' -LastName 'Fuller' -EmailAddress 'patti.fuller@contoso.com' -PhoneNumber '5553334444' +``` + +#### After + +```powershell +PS C:\> $AdminDetails = New-AzKeyVaultCertificateAdministratorDetail -FirstName 'Patti' -LastName 'Fuller' -EmailAddress 'patti.fuller@contoso.com' -PhoneNumber '5553334444' +``` + +### `New-AzKeyVault` + +`-EnableSoftDelete` is removed, as soft delete is enabled by default. Please use `-DisableSoftDelete` if you do not want this behavior. + +#### Before + +```powershell +PS C:\> New-AzKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -Location 'East US' -EnableSoftDelete +``` + +#### After + +```powershell +PS C:\> New-AzKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -Location 'East US' +``` + +## Az.Monitor + +### `Add-AzLogProfile` + +The type of property `RetentionPolicy` of type +`Microsoft.Azure.Commands.Insights.OutputClasses.PSLogProfile` has changed from +`Microsoft.Azure.Management.Monitor.Management.Models.RetentionPolicy` to +`Microsoft.Azure.Management.Monitor.Models.RetentionPolicy`. + +### `Get-AzLogProfile` + +The type of property `RetentionPolicy` of type +`Microsoft.Azure.Commands.Insights.OutputClasses.PSLogProfile` has changed from +`Microsoft.Azure.Management.Monitor.Management.Models.RetentionPolicy` to +`Microsoft.Azure.Management.Monitor.Models.RetentionPolicy`. + +### `New-AzMetricAlertRuleV2Criteria` + +The parameter set `__AllParameterSets` for cmdlet `New-AzMetricAlertRuleV2Criteria` has been removed. + +## Az.Network + +### `Get-AzNetworkWatcherConnectionMonitor` + +The generic type for property `RoundTripTimeMs` has been changed from +`System.Nullable1[System.Int32]` to `System.Nullable1[System.Double]`. + +### `New-AzNetworkWatcherConnectionMonitorTestConfigurationObject` + +The generic type for parameter `SuccessThresholdRoundTripTimeMs` has been changed from +`System.Nullable1[System.Int32]` to `System.Nullable1[System.Double]`. + +## Az.OperationalInsights + +### `Get-AzOperationalInsightsDataSource` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `New-AzOperationalInsightsApplicationInsightsDataSource` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `New-AzOperationalInsightsAzureActivityLogDataSource` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `New-AzOperationalInsightsCustomLogDataSource` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `New-AzOperationalInsightsLinuxPerformanceObjectDataSource` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `New-AzOperationalInsightsLinuxSyslogDataSource` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `New-AzOperationalInsightsWindowsEventDataSource` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `New-AzOperationalInsightsWindowsPerformanceCounterDataSource` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Remove-AzOperationalInsightsDataSource` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Disable-AzOperationalInsightsIISLogCollection` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Disable-AzOperationalInsightsLinuxCustomLogCollection` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Disable-AzOperationalInsightsLinuxPerformanceCollection` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Disable-AzOperationalInsightsLinuxSyslogCollection` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Enable-AzOperationalInsightsIISLogCollection` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Enable-AzOperationalInsightsLinuxCustomLogCollection` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Enable-AzOperationalInsightsLinuxPerformanceCollection` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Enable-AzOperationalInsightsLinuxSyslogCollection` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Get-AzOperationalInsightsSavedSearch` + +The property `Metadata` of type +`Microsoft.Azure.Commands.OperationalInsights.Models.PSSearchListSavedSearchResponse` has been +removed. + +### `Get-AzOperationalInsightsSavedSearchResult` + +The cmdlet `Get-AzOperationalInsightsSavedSearchResult` was not supported by SDK anymore and has been removed. + +### `Get-AzOperationalInsightsSearchResult` + +The cmdlet `Get-AzOperationalInsightsSearchResult` was not supported by SDK anymore and has been removed. + +### `Get-AzOperationalInsightsStorageInsight` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `New-AzOperationalInsightsStorageInsight` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Remove-AzOperationalInsightsStorageInsight` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Set-AzOperationalInsightsStorageInsight` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Get-AzOperationalInsightsLinkTarget` + +The cmdlet `Get-AzOperationalInsightsLinkTarget` was not supported by SDK anymore and has been removed. + +### `Get-AzOperationalInsightsWorkspace` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `New-AzOperationalInsightsWorkspace` + +- The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` + has been removed. +- The cmdlet `New-AzOperationalInsightsWorkspace` no longer supports the parameter `CustomerId` and + no alias was found for the original parameter name. +- The parameter set `__AllParameterSets` for cmdlet `New-AzOperationalInsightsWorkspace` has been + removed. + +### `Set-AzOperationalInsightsWorkspace` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +### `Invoke-AzOperationalInsightsQuery` + +The property `PortalUrl` of type `Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace` +has been removed. + +## Az.Resources + +### `Get-AzDeploymentScript` + +The type of property `Status` of type +`Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScript` has changed from +`Microsoft.Azure.Management.ResourceManager.Models.ScriptStatus` to +`Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsScriptStatus`. + +### `Get-AzDeploymentScriptLog` + +The type of property `Status` of type +`Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScript` has changed from +`Microsoft.Azure.Management.ResourceManager.Models.ScriptStatus` to +`Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsScriptStatus`. + +### `Save-AzDeploymentScriptLog` + +The type of property `Status` of type +`Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScript` has changed from +`Microsoft.Azure.Management.ResourceManager.Models.ScriptStatus` to +`Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsScriptStatus`. + +### `Get-AzResourceLock, New-AzResourceLock, Remove-AzResourceLock, Set-AzResourceLock` + +Parameter `TenantLevel` has been removed. + +### `Get-AzPolicyAlias` + +The generic type for property `Aliases` has been changed from +`System.Collections.Generic.IList1[Microsoft.Azure.Management.ResourceManager.Models.AliasType]` to +`System.Collections.Generic.IList1[Microsoft.Azure.Management.ResourceManager.Models.Alias]`. + +### `New-AzPolicyAssignment` + +- The cmdlet `New-AzPolicyAssignment` no longer supports the type + `System.Management.Automation.PSObject` for parameter `PolicyDefinition`. +- The cmdlet `New-AzPolicyAssignment` no longer supports the type + `System.Management.Automation.PSObject` for parameter `PolicySetDefinition`. + +### `Remove-AzDeploymentScript` + +The type of property `Status` of type +`Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsDeploymentScript` has changed from +`Microsoft.Azure.Management.ResourceManager.Models.ScriptStatus` to +`Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PsScriptStatus`. + +## Az.Storage + +### `Update-AzStorageAccountNetworkRuleSet`, `Get-AzStorageAccountNetworkRuleSet` + +Changed NetWorkRule DefaultAction value from: Allow = 1, Deny = 0, to: Allow = 0, Deny = 1. + +### `New-AzStorageTable`, `Get-AzStorageTable` + +Output object AzureStorageTable.CloudTable.ServiceClient have 2 properties removed: +ConnectionPolicy, ConsistencyLevel. + +### `Get-AzStorageFile`, `Remove-AzStorageFile`, `Get-AzStorageFileContent`, `Set-AzStorageFileContent`, `Start-AzStorageFileCopy` + +Change output type from CloudFile to AzureStorageFile, the original output will become child +property "CloudFile" of the new output + +#### Before + +```powershell +PS C:\> $file = Get-AzStorageFile -ShareName $shareName -Path testfile -Context $ctx + +PS C:\> Remove-AzStorageFile -File $file +``` + +#### After + +```powershell +PS C:\> $file = Get-AzStorageFile -ShareName $shareName -Path testfile -Context $ctx + +PS C:\> Remove-AzStorageFile -File $file.CloudFile +``` + +### `Get-AzStorageFile`, `New-AzStorageDirectory`, `Remove-AzStorageDirectory` + +Change output type from CloudFileDirectory to AzureStorageFileDirectory, the original output will +become child property "CloudFileDirectory" of the new output + +#### Before + +```powershell +PS C:\> $dir = Get-AzStorageFile -ShareName $shareName -Path testdir -Context $ctx + +PS C:\> Remove-AzStorageDirectory -Directory $dir +``` + +#### After + +```powershell +PS C:\> $dir = Get-AzStorageFile -ShareName $shareName -Path testdir -Context $ctx + +PS C:\> Remove-AzStorageDirectory -Directory $dir.CloudFileDirectory +``` + +### `Get-AzStorageShare`, `New-AzStorageShare`, `Remove-AzStorageShare` + +Change output type from FileShareProperties to AzureStorageFileShare, the original output will +become child property "CloudFileShare" of the new output + +#### Before + +```powershell +PS C:\> $share = Get-AzStorageShare -Name $shareName -Context $ctx + +PS C:\> Remove-AzStorageShare -Share $share +``` + +#### After + +```powershell +PS C:\> $share = Get-AzStorageShare -Name $shareName -Context $ctx + +PS C:\> Remove-AzStorageShare -Share $share.CloudFileShare +``` + +### `Set-AzStorageShareQuota` + +Change output type from FileShareProperties to AzureStorageFileShare, the original output will +become sub child property ""CloudFileShare.Properties"" of the new output + +#### Before + +```powershell +PS C:\> $shareProperties = Set-AzStorageShareQuota -Name $shareName -Quota 100 -Context $ctx + +PS C:\> $shareProperties + +ETag LastModified Quota +---- ------------ ----- +"0x8D7F5BC7789FC63" 5/11/2020 3:03:30 PM +00:00 100 +``` + +#### After + +```powershell +PS C:\> $share = Set-AzStorageShareQuota -Name $shareName -Quota 100 -Context $ctx + +PS C:\> $share + + File End Point: https://weiors1.file.core.windows.net/ + +Name QuotaGiB LastModified IsSnapshot SnapshotTime +---- -------- ------------ ---------- ------------ +weitest1 100 5/11/2020 3:03:30 PM +00:00 False + +PS C:\> $share.CloudFileShare.Properties + +ETag LastModified Quota +---- ------------ ----- +"0x8D7F5BC7789FC63" 5/11/2020 3:03:30 PM +00:00 100 +``` + +### `Remove-AzStorageDirectory` + +When removing sub File Directories with parent Directory object and -Path, Can't input -Path from +pipeline with type (string) match anymore. + +#### Before + +```powershell +PS C:\> $dir = Get-AzStorageFile -ShareName $shareName -Path testdir -Context $ctx + +PS C:\> @('dir1', 'dir2') | Remove-AzStorageDirectory -Directory $dir +``` + +#### After + +```powershell +PS C:\> $dir = Get-AzStorageFile -ShareName $shareName -Path testdir -Context $ctx + +PS C:\> $paths = @( + [PSCustomObject]@{ Path = 'dir1 } + [PSCustomObject]@{ Path = 'dir2' } +) + +PS C:\> $paths | Remove-AzStorageDirectory -Directory $dir.CloudFileDirectory +``` diff --git a/docs-conceptual/azps-10.1.0/migrate-az-5.0.0.md b/docs-conceptual/azps-10.1.0/migrate-az-5.0.0.md new file mode 100644 index 0000000000..612582882d --- /dev/null +++ b/docs-conceptual/azps-10.1.0/migrate-az-5.0.0.md @@ -0,0 +1,575 @@ +--- +description: This migration guide contains a list of breaking changes made to Azure PowerShell in the Az version 5.0.0 release. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Migration guide for Az 5.0.0 +--- + +# Migration Guide for Az 5.0.0 + +This document describes the changes between the 4.0.0 and 5.0.0 versions of Az. + +- [Migration Guide for Az 5.0.0](#migration-guide-for-az-500) + - [Az.Aks](#azaks) + - [New-AzAksCluster](#new-azakscluster) + - [Set-AzAksCluster](#set-azakscluster) + - [Az.ContainerRegistry](#azcontainerregistry) + - [New-AzContainerRegistry](#new-azcontainerregistry) + - [Az.Functions](#azfunctions) + - [Get-AzFunctionApp](#get-azfunctionapp) + - [New-AzFunctionApp](#new-azfunctionapp) + - [Az.KeyVault](#azkeyvault) + - [New-AzKeyVault](#new-azkeyvault) + - [Update-AzKeyVault](#update-azkeyvault) + - [Get-AzKeyVaultSecret](#get-azkeyvaultsecret) + - [Az.ManagedServices](#azmanagedservices) + - [Get-AzManagedServicesDefinition](#get-azmanagedservicesdefinition) + - [New-AzManagedServicesAssignment](#new-azmanagedservicesassignment) + - [Remove-AzManagedServicesAssignment](#remove-azmanagedservicesassignment) + - [Remove-AzManagedServicesDefinition](#remove-azmanagedservicesdefinition) + - [Az.ResourceManager](#azresourcemanager) + - [Get-AzManagementGroupDeployment](#get-azmanagementgroupdeployment) + - [Get-AzManagementGroupDeploymentOperation](#get-azmanagementgroupdeploymentoperation) + - [Get-AzDeployment](#get-azdeployment) + - [Get-AzDeploymentOperation](#get-azdeploymentoperation) + - [Get-AzDeploymentWhatIfResult](#get-azdeploymentwhatifresult) + - [Get-AzTenantDeployment](#get-aztenantdeployment) + - [Get-AzTenantDeploymentOperation](#get-aztenantdeploymentoperation) + - [New-AzManagementGroupDeployment](#new-azmanagementgroupdeployment) + - [New-AzDeployment](#new-azdeployment) + - [New-AzTenantDeployment](#new-aztenantdeployment) + - [Remove-AzManagementGroupDeployment](#remove-azmanagementgroupdeployment) + - [Remove-AzDeployment](#remove-azdeployment) + - [Remove-AzTenantDeployment](#remove-aztenantdeployment) + - [Save-AzManagementGroupDeploymentTemplate](#save-azmanagementgroupdeploymenttemplate) + - [Save-AzDeploymentTemplate](#save-azdeploymenttemplate) + - [Save-AzTenantDeploymentTemplate](#save-aztenantdeploymenttemplate) + - [Stop-AzManagementGroupDeployment](#stop-azmanagementgroupdeployment) + - [Stop-AzDeployment](#stop-azdeployment) + - [Stop-AzTenantDeployment](#stop-aztenantdeployment) + - [Test-AzManagementGroupDeployment](#test-azmanagementgroupdeployment) + - [Test-AzDeployment](#test-azdeployment) + - [Test-AzTenantDeployment](#test-aztenantdeployment) + - [Get-AzResourceGroupDeployment](#get-azresourcegroupdeployment) + - [Get-AzResourceGroupDeploymentOperation](#get-azresourcegroupdeploymentoperation) + - [Get-AzResourceGroupDeploymentWhatIfResult](#get-azresourcegroupdeploymentwhatifresult) + - [New-AzResourceGroupDeployment](#new-azresourcegroupdeployment) + - [Remove-AzResourceGroupDeployment](#remove-azresourcegroupdeployment) + - [Save-AzResourceGroupDeploymentTemplate](#save-azresourcegroupdeploymenttemplate) + - [Stop-AzResourceGroupDeployment](#stop-azresourcegroupdeployment) + - [Test-AzResourceGroupDeployment](#test-azresourcegroupdeployment) + - [Get-AzManagementGroupDeploymentWhatIfResult](#get-azmanagementgroupdeploymentwhatifresult) + - [Get-AzTenantDeploymentWhatIfResult](#get-aztenantdeploymentwhatifresult) + - [Az.Sql](#azsql) + - [Set-AzSqlServerActiveDirectoryAdministrator](#set-azsqlserveractivedirectoryadministrator) + - [Az.Synapse](#azsynapse) + - [New-AzSynapseSqlPool](#new-azsynapsesqlpool) + - [Update-AzSynapseSqlPool](#update-azsynapsesqlpool) + - [Az.Network](#aznetwork) + - [Approve-AzPrivateEndpointConnection](#approve-azprivateendpointconnection) + - [Deny-AzPrivateEndpointConnection](#deny-azprivateendpointconnection) + - [Get-AzPrivateEndpointConnection](#get-azprivateendpointconnection) + - [Remove-AzPrivateEndpointConnection](#remove-azprivateendpointconnection) + - [Set-AzPrivateEndpointConnection](#set-azprivateendpointconnection) + - [New-AzNetworkWatcherConnectionMonitorEndpointObject](#new-aznetworkwatcherconnectionmonitorendpointobject) + +## Az.Aks + +### New-AzAksCluster + +- No longer supports the parameter `NodeOsType` and no alias was found for the original parameter + name, it will always be `Linux`. +- No longer supports the alias `ClientIdAndSecret` for parameter `ServicePrincipalIdAndSecret`. +- The default value of `NodeVmSetType` is changed from `AvailabilitySet` to `VirtualMachineScaleSets`. +- The default value of `NetworkPlugin` is changed from `none` to `azure`. + +#### Before + +```powershell +New-AzAksCluster -ResourceGroupName myResourceGroup -Name myCluster -WindowsProfileAdminUserName azureuser -WindowsProfileAdminUserPassword $cred -NetworkPlugin azure -NodeOsType Linux -ClientIdAndSecret xxx +``` + +#### After + +```powershell +New-AzAksCluster -ResourceGroupName myResourceGroup -Name myCluster -WindowsProfileAdminUserName azureuser -WindowsProfileAdminUserPassword $cred -NodeVmSetType AvailabilitySet -ServicePrincipalIdAndSecret xxx +``` + +### Set-AzAksCluster + +No longer supports the alias `ClientIdAndSecret` for parameter `ServicePrincipalIdAndSecret`. + +#### Before + +```powershell +Get-AzAksCluster -ResourceGroupName xxx -Name xxx | Set-AzAksCluster -ClientIdAndSecret xxx +``` + +#### After + +```powershell +Get-AzAksCluster -ResourceGroupName xxx -Name xxx | Set-AzAksCluster -ServicePrincipalIdAndSecret xxx +``` + +## Az.ContainerRegistry + +### New-AzContainerRegistry + +No longer supports the parameter `StorageAccountName` and no alias was found for the original parameter name. + +#### Before + +```powershell +New-AzContainerRegistry -Name $name -ResourceGroupName $rg -Location $location -SKU Classic -StorageAccountName $storage +``` + +#### After + +`Classic` was deprecated and `StorageAccountName` was removed since it only works with Classic +Container Registry. + +## Az.Functions + +### Get-AzFunctionApp + +Removed `IncludeSlot` switch parameter from all but one parameter set of `Get-AzFunctionApp`. The +cmdlet now supports retrieving deployment slots in the results when `-IncludeSlot` is specified. +This functionality was broken in the previous cmdlet version. However, this is now fixed. + +### New-AzFunctionApp + +- Fixed `-DisableApplicationInsights` in `New-AzFunctionApp` so that no application insights project + is created when this option is specified. +- Removed support to create PowerShell 6.2 function apps since PowerShell 6.2 is EOL. The current + guidance for customers is to create PowerShell 7.0 function apps instead. +- Changed the default runtime version in Functions version 3 on Windows for PowerShell function apps + from 6.2 to 7.0 when the `RuntimeVersion` parameter is not specified. +- Changed the default runtime version in Functions version 3 on Windows and Linux for Node function + apps from 10 to 12 when the `RuntimeVersion` parameter is not specified. However, users can still + create Node 10 function apps by specifying `-Runtime Node` and `-RuntimeVersion 10`. Changed the + default runtime version in Functions version 3 on Linux for Python function apps from 3.7 to 3.8 + when the `RuntimeVersion` parameter is not specified. However, users can still create Python 3.7 + function apps by specifying `-Runtime Python` and `-RuntimeVersion 3.7`. + +#### Before + +```powershell +# Create a Node 10 function app on Linux +New-AzFunctionApp -ResourceGroupName $rd ` + -Name $functionAppName ` + -StorageAccountName $storageAccountName ` + -Location $location ` + -OSType Linux ` + -Runtime Node + +# Create a Node 10 function app on Windows +New-AzFunctionApp -ResourceGroupName $rd ` + -Name $functionAppName ` + -StorageAccountName $storageAccountName ` + -Location $location ` + -OSType Windows ` + -Runtime Node + +# Create a Python 3.7 function app on Linux +New-AzFunctionApp -ResourceGroupName $rd ` + -Name $functionAppName ` + -StorageAccountName $storageAccountName ` + -Location $location ` + -OSType Linux ` + -Runtime Python +``` + +#### After + +```powershell +# Create a Node 10 function app on Linux +New-AzFunctionApp -ResourceGroupName $rd ` + -Name $functionAppName ` + -StorageAccountName $storageAccountName ` + -Location $location ` + -OSType Linux ` + -Runtime Node ` + -RuntimeVersion 10 + +# Create a Node 10 function app on Windows +New-AzFunctionApp -ResourceGroupName $rd ` + -Name $functionAppName ` + -StorageAccountName $storageAccountName ` + -Location $location ` + -OSType Windows ` + -Runtime Node + +# Create a Python 3.7 function app on Linux +New-AzFunctionApp -ResourceGroupName $rd ` + -Name $functionAppName ` + -StorageAccountName $storageAccountName ` + -Location $location ` + -OSType Linux ` + -Runtime Python ` + -RuntimeVersion 3.7 +``` + +## Az.KeyVault + +### New-AzKeyVault + +No longer supports the parameter `DisableSoftDelete` and no alias was found for the original parameter name. + +#### Before + +```powershell +# Opt out soft delete while creating a key vault +New-AzKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -Location 'East US' -DisableSoftDelete +``` + +#### After + +The ability to update soft-delete setting is deprecated in Az.KeyVault 3.0.0. [Read more](/azure/key-vault/general/soft-delete-change) + +### Update-AzKeyVault + +No longer supports the parameter `EnableSoftDelete`, `SoftDeleteRetentionInDays`, and no alias was +found for the original parameter name. + +#### Before + +```powershell +Update-AzKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -EnableSoftDelete -SoftDeleteRetentionInDays 15 +``` + +#### After + +The ability to update soft-delete setting is deprecated in Az.KeyVault 3.0.0. [Read more](/azure/key-vault/general/soft-delete-change) + +### Get-AzKeyVaultSecret + +The property `SecretValueText` of type `Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecret` +has been removed. Either apply a `-AsPlainText` to the call to get the plain text secret, +or use `$secret.SecretValue` of type `SecureString` in your script. + +#### Before + +```powershell +$secret = Get-AzKeyVaultSecret -VaultName myVault -Name mySecret +$secretInPlainText = $secret.SecretValueText +``` + +#### After + +```powershell +$secretInPlainText = Get-AzKeyVaultSecret -VaultName myVault -Name mySecret -AsPlainText +``` + +## Az.ManagedServices + +### Get-AzManagedServicesDefinition + +No longer supports the parameter `ResourceId` and no alias was found for the original parameter name. + +#### Before + +```powershell +Get-AzManagedServicesDefinition -ResourceId xxx +``` + +#### After + +```powershell +Get-AzManagedServicesDefinition -Id xxx +``` + +### New-AzManagedServicesAssignment + +No longer supports the parameter `RegistrationDefinitionName`, `RegistrationDefinitionResourceId`, +and no alias was found for the original parameter name. + +#### Before + +```powershell +New-AzManagedServicesAssignment -RegistrationDefinitionName xxx -Scope xxx +``` + +#### After + +```powershell +New-AzManagedServicesAssignment -Scope xxx -RegistrationDefinition xxx +``` + +### Remove-AzManagedServicesAssignment + +No longer supports the parameter `Id`, `ResourceId`, and no alias was found for the original +parameter name. + +#### Before + +```powershell +Remove-AzManagedServicesAssignment -ResourceId xxx +``` + +#### After + +```powershell +Get-AzManagedServicesAssignment -Scope xxx | Remove-AzManagedServicesAssignment +``` + +### Remove-AzManagedServicesDefinition + +No longer supports the parameter `Id`, `ResourceId`, and no alias was found for the original +parameter name. + +#### Before + +```powershell +Remove-AzManagedServicesDefinition -ResourceId xxx +``` + +#### After + +```powershell +Get-AzManagedServicesDefinition -Scope xxx | Remove-AzManagedServicesDefinition +``` + +## Az.ResourceManager + +### Get-AzManagementGroupDeployment + +No longer supports the parameter `ApiVersion` and no alias was found for the original parameter name. + +#### Before + +```powershell +Get-AzManagementGroupDeployment -ManagementGroupId xxx -Name xxx -ApiVersion xxx +``` + +#### After + +```powershell +Get-AzManagementGroupDeployment -ManagementGroupId xxx -Name xxx +``` + +### Get-AzManagementGroupDeploymentOperation + +Same with `Get-AzManagementGroupDeployment`. + +### Get-AzDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Get-AzDeploymentOperation + +Same with `Get-AzManagementGroupDeployment`. + +### Get-AzDeploymentWhatIfResult + +Same with `Get-AzManagementGroupDeployment`. + +### Get-AzTenantDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Get-AzTenantDeploymentOperation + +Same with `Get-AzManagementGroupDeployment`. + +### New-AzManagementGroupDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### New-AzDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### New-AzTenantDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Remove-AzManagementGroupDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Remove-AzDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Remove-AzTenantDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Save-AzManagementGroupDeploymentTemplate + +Same with `Get-AzManagementGroupDeployment`. + +### Save-AzDeploymentTemplate + +Same with `Get-AzManagementGroupDeployment`. + +### Save-AzTenantDeploymentTemplate + +Same with `Get-AzManagementGroupDeployment`. + +### Stop-AzManagementGroupDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Stop-AzDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Stop-AzTenantDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Test-AzManagementGroupDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Test-AzDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Test-AzTenantDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Get-AzResourceGroupDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Get-AzResourceGroupDeploymentOperation + +Same with `Get-AzManagementGroupDeployment`. + +### Get-AzResourceGroupDeploymentWhatIfResult + +Same with `Get-AzManagementGroupDeployment`. + +### New-AzResourceGroupDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Remove-AzResourceGroupDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Save-AzResourceGroupDeploymentTemplate + +Same with `Get-AzManagementGroupDeployment`. + +### Stop-AzResourceGroupDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Test-AzResourceGroupDeployment + +Same with `Get-AzManagementGroupDeployment`. + +### Get-AzManagementGroupDeploymentWhatIfResult + +Same with `Get-AzManagementGroupDeployment`. + +### Get-AzTenantDeploymentWhatIfResult + +Same with `Get-AzManagementGroupDeployment`. + +## Az.Sql + +### Set-AzSqlServerActiveDirectoryAdministrator + +No longer supports the parameter `IsAzureADOnlyAuthentication` and no alias was found for the +original parameter name. + +#### Before + +```powershell +Set-AzSqlServerActiveDirectoryAdministrator -ResourceGroupName 'ResourceGroup01' -ServerName 'Server01' -DisplayName 'DBAs' -IsAzureADOnlyAuthentication +``` + +#### After + +```powershell +Set-AzSqlServerActiveDirectoryAdministrator -ResourceGroupName 'ResourceGroup01' -ServerName 'Server01' -DisplayName 'DBAs' +``` + +## Az.Synapse + +### New-AzSynapseSqlPool + +No longer supports the parameter `FromBackup`, `FromRestorePoint`, `BackupResourceGroupName`, +`BackupWorkspaceName`, `BackupSqlPoolName`, `BackupSqlPoolObject`, `BackupResourceId`, +`SourceResourceGroupName`, `SourceWorkspaceName`, `SourceSqlPoolName`, `SourceSqlPoolObject`, +`SourceResourceId`, `RestorePoint`, and no alias was found for the original parameter name. + +#### Before + +```powershell +New-AzSynapseSqlPool -FromBackup -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -BackupWorkspaceName ContosoWorkspace -BackupSqlPoolName ExistingContosoSqlPool +``` + +#### After + +```powershell +PS C:\> New-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -PerformanceLevel DW200c +``` + +### Update-AzSynapseSqlPool + +No longer supports the parameter `Suspend`, `Resume`, and no alias was found for the original +parameter name. + +## Az.Network + +### Approve-AzPrivateEndpointConnection + +No longer supports the parameter `PrivateLinkResourceType` and no alias was found for the original +parameter name. + +#### Before + +```powershell +Approve-AzPrivateEndpointConnection -ResourceGroupName xxx -ServiceName xxx -Name xxx -PrivateLinkResourceType 'Microsoft.Network/privateLinkServices' -Description xxx +``` + +#### After + +```powershell +Approve-AzPrivateEndpointConnection -ResourceGroupName xxx -ServiceName xxx -Name xxx -Description xxx +``` + +### Deny-AzPrivateEndpointConnection + +Same with `Approve-AzPrivateEndpointConnection`. + +### Get-AzPrivateEndpointConnection + +Same with `Approve-AzPrivateEndpointConnection`. + +### Remove-AzPrivateEndpointConnection + +Same with `Approve-AzPrivateEndpointConnection`. + +### Set-AzPrivateEndpointConnection + +Same with `Approve-AzPrivateEndpointConnection`. + +### New-AzNetworkWatcherConnectionMonitorEndpointObject + +No longer supports the parameter `FilterType`, `FilterItem`, and no alias was found for the original +parameter name. + +#### Before + +```powershell +$MySrcResourceId1 = '/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourceGroup/providers/Microsoft.OperationalInsights/workspaces/myworkspace' +$SrcEndpointFilterItem1 =New-AzNetworkWatcherConnectionMonitorEndpointFilterItemObject -Type 'AgentAddress' -Address 'WIN-P0HGNDO2S1B' +$SourceEndpointObject1 = New-AzNetworkWatcherConnectionMonitorEndPointObject -Name 'workspaceEndpoint' -ResourceId $MySrcResourceId1 -FilterType Include -FilterItem $SrcEndpointFilterItem1 +``` + +#### After + +```powershell +MySrcResourceId1 = '/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourceGroup/providers/Microsoft.OperationalInsights/workspaces/myworkspace' +$SourceEndpointObject1 = New-AzNetworkWatcherConnectionMonitorEndPointObject -Name 'workspaceEndpoint' -ResourceId $MySrcResourceId1 +``` diff --git a/docs-conceptual/azps-10.1.0/migrate-az-6.0.0.md b/docs-conceptual/azps-10.1.0/migrate-az-6.0.0.md new file mode 100644 index 0000000000..14f30d1ab8 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/migrate-az-6.0.0.md @@ -0,0 +1,446 @@ +--- +description: This migration guide contains a list of breaking changes made to Azure PowerShell in the Az version 6.0.0 release. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Migration guide for Az 6.0.0 +--- + +# Migration Guide for Az 6.0.0 + +This document describes the changes between the 5.0.0 and 6.0.0 versions of Az. + +- [Migration Guide for Az 6.0.0](#migration-guide-for-az-600) + - [Supported versions of PowerShell](#supported-versions-of-powershell) + - [Az.Accounts](#azaccounts) + - [`Connect-AzAccount`](#connect-azaccount) + - [Az.ContainerInstance](#azcontainerinstance) + - [`New-AzContainerGroup`](#new-azcontainergroup) + - [`Remove-AzContainerGroup`](#remove-azcontainergroup) + - [`Get-AzContainerGroup`](#get-azcontainergroup) + - [`Get-AzContainerInstanceLog`](#get-azcontainerinstancelog) + - [Az.DesktopVirtualization](#azdesktopvirtualization) + - [`New-AzWvdHostPool`](#new-azwvdhostpool) + - [`Expand-AzWvdMsixImage`](#expand-azwvdmsiximage) + - [`New-AzWvdMsixPackage`](#new-azwvdmsixpackage) + - [`Update-AzWvdHostPool`](#update-azwvdhostpool) + - [Az.StreamAnalytics](#azstreamanalytics) + - [`Get-AzStreamAnalyticsDefaultFunctionDefinition`](#get-azstreamanalyticsdefaultfunctiondefinition) + - [`New-AzStreamAnalyticsJob`](#new-azstreamanalyticsjob) + - [`New-AzStreamAnalyticsTransformation`](#new-azstreamanalyticstransformation) + - [Az.RecoveryServices](#azrecoveryservices) + - [`Set-AzRecoveryServicesBackupProperty`](#set-azrecoveryservicesbackupproperty) + - [`Get-AzRecoveryServicesBackupJobDetail`](#get-azrecoveryservicesbackupjobdetail) + - [Az.Storage](#azstorage) + - [`Remove-AzRmStorageShare`](#remove-azrmstorageshare) + - [Az.ServiceFabric](#azservicefabric) + - [`Add-AzServiceFabricClusterCertificate`](#add-azservicefabricclustercertificate) + - [`Get-AzServiceFabricManagedClusterService`](#get-azservicefabricmanagedclusterservice) + - [`New-AzServiceFabricManagedCluster`](#new-azservicefabricmanagedcluster) + - [`New-AzServiceFabricManagedClusterService`](#new-azservicefabricmanagedclusterservice) + - [`Remove-AzServiceFabricClusterCertificate`](#remove-azservicefabricclustercertificate) + - [`Remove-AzServiceFabricManagedClusterService`](#remove-azservicefabricmanagedclusterservice) + - [`Set-AzServiceFabricManagedCluster`](#set-azservicefabricmanagedcluster) + - [`Set-AzServiceFabricManagedClusterService`](#set-azservicefabricmanagedclusterservice) + +## Supported versions of PowerShell + +Due to [CVE-2021-26701](https://msrc.microsoft.com/update-guide/vulnerability/CVE-2021-26701) Az 6 is only supported on the following platforms: +- PowerShell 7.1: version 7.1.3 or above +- PowerShell 7.0: version 7.0.6 or above +- Windows PowerShell 5.1 + +For further details, refer to the [Azure PowerShell support lifecycle](https://aka.ms/azpslifecycle) + +## Az.Accounts + +### `Connect-AzAccount` + +Removed obsolete parameters ManagedServiceHostName, ManagedServicePort and ManagedServiceSecret. + +#### Before + +```powershell +Connect-AzAccount -Identity -ManagedServiceSecret $secret +``` +#### After + +```powershell +#To use customized MSI endpoint, please set environment variable MSI_ENDPOINT, e.g. "http://localhost:50342/oauth2/token"; to use customized MSI secret, please set environment variable MSI_SECRET. +Connect-AzAccount -Identity +``` +## Az.ContainerInstance + +### `New-AzContainerGroup` + +No longer supports the parameter `Image`, `RegistryCredential`, `AzureFileVolumeShareName`, `AzureFileVolumeAccountCredential`, `AzureFileVolumeMountPath`, `IdentityId`, `AssignIdentity`, `OsType`, `Cpu`, `MemoryInGB`, `IpAddressType`, `DnsNameLabel`, `Port`, `Command`, `EnvironmentVariable`, `RegistryServerDomain` and no alias was found for the original parameter name. + +#### Before + +```powershell +PS C:\> New-AzContainerGroup -ResourceGroupName demo -Name mycontainer -Image nginx -OsType Linux -IpAddressType Public -Port @(8000) + +ResourceGroupName : demo +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer +Name : mycontainer +Type : Microsoft.ContainerInstance/containerGroups +Location : westus +Tags : +ProvisioningState : Creating +Containers : {mycontainer} +ImageRegistryCredentials : +RestartPolicy : +IpAddress : 13.88.10.240 +Ports : {8000} +OsType : Linux +Volumes : +State : Running +Events : {} +``` + +#### After + +```powershell +PS C:\> $port1 = New-AzContainerInstancePortObject -Port 8000 -Protocol TCP +PS C:\> $port2 = New-AzContainerInstancePortObject -Port 8001 -Protocol TCP +PS C:\> $container = New-AzContainerInstanceObject -Name test-container -Image nginx -RequestCpu 1 -RequestMemoryInGb 1.5 -Port @($port1, $port2) +PS C:\> $containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -OsType Linux -RestartPolicy "Never" -IpAddressType Public + +Location Name Type +-------- ---- ---- +eastus test-cg Microsoft.ContainerInstance/containerGroups +``` +### `Remove-AzContainerGroup` + +The cmdlet 'Remove-AzContainerGroup' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. + +#### Before + +```powershell +PS C:\> Find-AzResource -ResourceGroupEquals MyResourceGroup -ResourceNameEquals MyContainer | Remove-AzContainerGroup +``` + +#### After + +```powershell +PS C:\> Remove-AzContainerGroup -Name test-cg -ResourceGroupName test-rg + +Location Name Type +-------- ---- ---- +eastus test-cg Microsoft.ContainerInstance/containerGroups +``` + +### `Get-AzContainerGroup` + +The cmdlet 'Get-AzContainerGroup' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. + +#### Before + +```powershell +PS C:\> Find-AzResource -ResourceGroupEquals demo -ResourceNameEquals mycontainer | Get-AzContainerGroup + +ResourceGroupName : demo +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer +Name : mycontainer +Type : Microsoft.ContainerInstance/containerGroups +Location : westus +Tags : +ProvisioningState : Succeeded +Containers : {mycontainer} +ImageRegistryCredentials : +RestartPolicy : +IpAddress : 13.88.10.240 +Ports : {8000} +OsType : Linux +Volumes : +State : Running +Events : {} +``` + +#### After + +```powershell +PS C:\> Get-AzContainerGroup + +Location Name Type +-------- ---- ---- +eastus bez-cg1 Microsoft.ContainerInstance/containerGroups +eastus bez-cg2 Microsoft.ContainerInstance/containerGroups +``` + +### `Get-AzContainerInstanceLog` + +The cmdlet 'Get-AzContainerInstanceLog' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +The cmdlet 'Get-AzContainerInstanceLog' no longer supports the parameter 'Name' and no alias was found for the original parameter name. + +#### Before + +```powershell +PS C:\> Get-AzContainerGroup -ResourceGroupName demo -Name mycontainer | Get-AzContainerInstanceLog + +Log line 1. +Log line 2. +Log line 3. +Log line 4. +``` + +#### After + +```powershell +PS C:\> Get-AzContainerInstanceLog -ContainerGroupName test-cg -ContainerName test-container -ResourceGroupName test-rg +``` + +## Az.DesktopVirtualization + +### `New-AzWvdHostPool` + +The cmdlet 'New-AzWvdHostPool' no longer supports the parameter 'SsoContext' and no alias was found for the original parameter name. + +### `Expand-AzWvdMsixImage` + +The cmdlet 'Expand-AzWvdMsixImage' no longer supports the type 'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.IMsixImageUri' for parameter 'MsixImageUri'. + +#### Before + +```powershell +$MsixImageUri = [Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.IMsixImageUri]::New() +Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name DesktopName | Expand-AzWvdMsixImage -MsixImageUri $MsixImageUri +``` + +#### After + +```powershell +$MsixImageUri = [Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210201Preview.IMsixImageUri]::New() +Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name DesktopName | Expand-AzWvdMsixImage -MsixImageUri $MsixImageUri +``` + +### `New-AzWvdMsixPackage` + +The element type for parameter 'PackageApplication' has been changed from 'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.IMsixPackageApplications' to 'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210201Preview.IMsixPackageApplications'. +The element type for parameter 'PackageDependency' has been changed from 'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.IMsixPackageDependencies' to 'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210201Preview.IMsixPackageDependencies'. + +#### Before + +```powershell +PS C:\> $apps = @([Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.IMsixPackageApplications]::New()) +PS C:\> $deps = @([Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.IMsixPackageDependencies]::New()) +PS C:\> New-AzWvdMsixPackage -FullName PackageFullName ` + -HostPoolName HostPoolName ` + -ResourceGroupName ResourceGroupName ` + -SubscriptionId SubscriptionId ` + -DisplayName displayname ` + -ImagePath imageURI ` + -IsActive:$false ` + -IsRegularRegistration:$false ` + -LastUpdated datelastupdated ` + -PackageApplication $apps ` + -PackageDependency $deps ` + -PackageFamilyName packagefamilyname ` + -PackageName packagename ` + -PackageRelativePath packagerelativepath ` + -Version packageversion ` +``` + +#### After + +```powershell +PS C:\> $apps = @([Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210201Preview.IMsixPackageApplications]::New()) +PS C:\> $deps = @([Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210201Preview.IMsixPackageDependencies]::New()) +PS C:\> New-AzWvdMsixPackage -FullName PackageFullName ` + -HostPoolName HostPoolName ` + -ResourceGroupName ResourceGroupName ` + -SubscriptionId SubscriptionId ` + -DisplayName displayname ` + -ImagePath imageURI ` + -IsActive:$false ` + -IsRegularRegistration:$false ` + -LastUpdated datelastupdated ` + -PackageApplication $apps ` + -PackageDependency $deps ` + -PackageFamilyName packagefamilyname ` + -PackageName packagename ` + -PackageRelativePath packagerelativepath ` + -Version packageversion ` +``` + +### `Update-AzWvdHostPool` + +The cmdlet 'Update-AzWvdHostPool' no longer supports the parameter 'SsoContext' and no alias was found for the original parameter name. + +## Az.StreamAnalytics + +### `Get-AzStreamAnalyticsDefaultFunctionDefinition` + +The cmdlet 'Get-AzStreamAnalyticsDefaultFunctionDefinition' no longer supports the parameter 'File' and no alias was found for the original parameter name. + +#### Before + +```powershell +Get-AzStreamAnalyticsDefaultFunctionDefinition -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamJob22" -File "C:\RetrieveDefaultDefinitionRequest.json" -Name "ScoreTweet" +``` + +#### After + +```powershell +Get-AzStreamAnalyticsDefaultFunctionDefinition -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name mlsfunction-01 -BindingType Microsoft.MachineLearningServices -Endpoint "http://875da830-4d5f-44f1-b221-718a5f26a21d.eastus.azurecontainer.io/score"-UdfType Scalar +Input is specified in flattened parameters instead from the input file. +``` + +### `New-AzStreamAnalyticsJob` + +The cmdlet 'New-AzStreamAnalyticsJob' no longer supports the parameter 'File' and no alias was found for the original parameter name. + +#### Before + +```powershell +New-AzStreamAnalyticsJob -ResourceGroupName "StreamAnalytics-Default-West-US" -File "C:\JobDefinition.json" +``` + +#### After + +```powershell +New-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-02-pwsh -Location westcentralus -SkuName Standard +Input is specified in flattened parameters instead from the input file. +``` + +### `New-AzStreamAnalyticsTransformation` + +The cmdlet 'New-AzStreamAnalyticsTransformation' no longer supports the parameter 'File' and no alias was found for the original parameter name. + +#### Before + +```powershell +New-AzStreamAnalyticsTransformation -ResourceGroupName "StreamAnalytics-Default-West-US" -File "C:\Transformation.json" -JobName "StreamingJob" -Name "StreamingJobTransform" +``` + +#### After + +```powershell +New-AzStreamAnalyticsTransformation -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name tranf-01 -StreamingUnit 6 -Query "Select Id, Name from input-01" +Input is specified in flattened parameters instead from the input file. +``` + +## Az.RecoveryServices + +### `Set-AzRecoveryServicesBackupProperty` + +Removed Set-AzRecoveryServicesBackupProperties plural alias, use Set-AzRecoveryServicesBackupProperty cmdlet name going forward + +### `Get-AzRecoveryServicesBackupJobDetail` + +Removed Get-AzRecoveryServicesBackupJobDetails plural alias, use Get-AzRecoveryServicesBackupJobDetail cmdlet name going forward + +#### Before + +```powershell +$jobDetails = Get-AzRecoveryServicesBackupJobDetails -VaultId $vault.ID -Job $job +$jobDetails2 = Get-AzRecoveryServicesBackupJobDetails -VaultId $vault.ID -JobId $job.JobId +``` + +#### After + +```powershell +$jobDetails = Get-AzRecoveryServicesBackupJobDetail -VaultId $vault.ID -Job $job +$jobDetails2 = Get-AzRecoveryServicesBackupJobDetail -VaultId $vault.ID -JobId $job.JobId +``` + +## Az.Storage + +### `Remove-AzRmStorageShare` + +The cmdlet 'Remove-AzRmStorageShare' can remove share with snapshots by default before; but after the change remove share with snapshots will fail by default, need add parameter "-Include Snapshots" to make remove success. + +#### Before + +```powershell +Remove-AzRmStorageShare -ResourceGroupName $resourceGroupName -StorageAccountName $accountName -Name $shareName +``` + +#### After + +```powershell +Remove-AzRmStorageShare -ResourceGroupName $resourceGroupName -StorageAccountName $accountName -Name $shareName -Force -Include Snapshots +``` + +## Az.ServiceFabric + +### `Add-AzServiceFabricClusterCertificate` + +this cmdlet has been removed completely. please follow instructions [here](/azure/service-fabric/service-fabric-cluster-security-update-certs-azure#add-a-secondary-certificate-using-azure-resource-manager) to add cluster certificates. + +### `Get-AzServiceFabricManagedClusterService` + +Change PSManagedService model to avoid using the properties parameter directly from sdk. Now all the properties are in the first level of the object. +And remove deprecated parameters InstanceCloseDelayDuration, DropSourceReplicaOnMove and ServiceDnsName + +#### Before + +```powershell +$service = Get-AzServiceFabricManagedClusterService -ResourceId $resourceId +$statelessService.Properties.ProvisioningState +``` + +#### After + +```powershell +$service = Get-AzServiceFabricManagedClusterService -ResourceId $resourceId +$statelessService.ProvisioningState +``` + +### `New-AzServiceFabricManagedCluster` + +Remove deprecated parameter ReverseProxyEndpointPort. + +### `New-AzServiceFabricManagedClusterService` + +Change PSManagedService model to avoid using the properties parameter directly from sdk. Now all the properties are in the first level of the object. +And remove deprecated parameters InstanceCloseDelayDuration, DropSourceReplicaOnMove and ServiceDnsName + +#### Before + +```powershell +$service = New-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName -Type $serviceTypeName -Stateless -InstanceCount -1 -PartitionSchemaSingleton +$statelessService.Properties.ProvisioningState +``` + +#### After + +```powershell +$service = New-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName -Type $serviceTypeName -Stateless -InstanceCount -1 -PartitionSchemaSingleton +$statelessService.ProvisioningState +``` + +### `Remove-AzServiceFabricClusterCertificate` + +this cmdlet has been removed completely. please follow instructions [here](/azure/service-fabric/service-fabric-cluster-security-update-certs-azure#remove-a-cluster-certificate-using-the-portal) to add cluster certificates. + +### `Remove-AzServiceFabricManagedClusterService` + +Change PSManagedService model to avoid using the properties parameter directly from sdk. Now all the properties are in the first level of the object. + +### `Set-AzServiceFabricManagedCluster` + +Remove deprecated parameter ReverseProxyEndpointPort. + +### `Set-AzServiceFabricManagedClusterService` + +Change PSManagedService model to avoid using the properties parameter directly from sdk. Now all the properties are in the first level of the object. +And remove deprecated parameters InstanceCloseDelayDuration, DropSourceReplicaOnMove and ServiceDnsName + +#### Before + +```powershell +$service = Get-AzServiceFabricManagedClusterService -ResourceId $resourceId +$statelessService.Properties.MinInstanceCount = 3 +service | Set-AzServiceFabricManagedClusterService +``` + +#### After + +```powershell +$service = Get-AzServiceFabricManagedClusterService -ResourceId $resourceId +$statelessService.MinInstanceCount = 3 +service | Set-AzServiceFabricManagedClusterService +``` diff --git a/docs-conceptual/azps-10.1.0/migrate-az-7.0.0.md b/docs-conceptual/azps-10.1.0/migrate-az-7.0.0.md new file mode 100644 index 0000000000..9503ee6cdf --- /dev/null +++ b/docs-conceptual/azps-10.1.0/migrate-az-7.0.0.md @@ -0,0 +1,441 @@ +--- +description: This migration guide contains a list of breaking changes made to Azure PowerShell in the Az version 7.0.0 release. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Migration guide for Az 7.0.0 +--- + +# Migration Guide for Az 7.0.0 + +## Az.Accounts + +### Context and account cmdlets + +Output of the following cmdlets have been changed: +- Get-AzContext +- Remove-AzContext +- Rename-AzContext +- Select-AzContext +- Connect-AzAccount +- Disconnect-AzAccount +- Import-AzContext +- Save-AzContext + +Removed `ServicePrincipalSecret` and `CertificatePassword` in `PSAzureRmAccount` + +#### Before +```powershell +PS C:\> $cred = Get-Credential +PS C:\> Connect-AzAccount -ServicePrincipal -Tenant 54826b22-xxxx-xxxx-xxxx-xxxxxxxxxxxxx -Credential $cred +PS C:\> (Get-AzContext).Account.ExtendedProperties + +Key Value +--- ----- +CertificatePath C:\certificate.pfx +CertificatePassword password**** +Tenants 54826b22-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +ServicePrincipalSecret 7QK7Q******************************** +Subscriptions 0b1f6471-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +``` +#### After +```powershell +PS C:\> $cred = Get-Credential +PS C:\> Connect-AzAccount -ServicePrincipal -Tenant 54826b22-xxxx-xxxx-xxxx-xxxxxxxxxxxxx -Credential $cred +PS C:\> (Get-AzContext).Account.ExtendedProperties + +Key Value +--- ----- +CertificatePath C:\certificate.pfx +Tenants 54826b22-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +Subscriptions 0b1f6471-xxxx-xxxx-xxxx-xxxxxxxxxxxxx +``` + + +## Az.Aks + +### `Get-AzAksVersion` +Property `Upgrades` in output changed to `Upgrade`. + +#### Before +```powershell +PS C:\> (Get-AzAksVersion -location eastus).Upgrades + +OrchestratorType OrchestratorVersion IsPreview +---------------- ------------------- --------- +Kubernetes 1.19.13 +Kubernetes 1.20.7 +Kubernetes 1.20.9 +Kubernetes 1.20.7 +Kubernetes 1.20.9 +Kubernetes 1.20.9 +Kubernetes 1.21.1 +Kubernetes 1.21.2 +Kubernetes 1.21.1 +Kubernetes 1.21.2 +Kubernetes 1.21.2 +Kubernetes 1.22.1 True +Kubernetes 1.22.2 True +Kubernetes 1.22.1 True +Kubernetes 1.22.2 True +Kubernetes 1.22.2 True +``` +#### After +```powershell +PS C:\> (Get-AzAksVersion -location eastus).Upgrade + +OrchestratorType OrchestratorVersion IsPreview +---------------- ------------------- --------- +Kubernetes 1.19.13 +Kubernetes 1.20.7 +Kubernetes 1.20.9 +Kubernetes 1.20.7 +Kubernetes 1.20.9 +Kubernetes 1.20.9 +Kubernetes 1.21.1 +Kubernetes 1.21.2 +Kubernetes 1.21.1 +Kubernetes 1.21.2 +Kubernetes 1.21.2 +Kubernetes 1.22.1 True +Kubernetes 1.22.2 True +Kubernetes 1.22.1 True +Kubernetes 1.22.2 True +Kubernetes 1.22.2 True +``` + + +## Az.ContainerInstance + +### `New-AzContainerGroup` +Removed parameter NetworkProfileId, added SubnetId as its alternative + +#### Before +```powershell +PS C:\> $containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -OsType Linux -NetworkProfileId "/subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}" +PS C:\> $containerGroup.NetworkProfileId + +/subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} +``` +#### After +```powershell +PS C:\> $container = New-AzContainerInstanceObject -Name test-container -Image nginx +PS C:\> $containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -OsType Linux -RestartPolicy "Never" -IpAddressType 'Private' -SubnetId @{"Id"="/subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"; "Name"="subnet"} +PS C:\> $containerGroup.SubnetId | fl + +Id : /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} +Name : subnet +``` + + +### `Invoke-AzContainerInstanceCommand` +Displayed command execution result as the cmdlet output by connecting websocket in backend + +#### Before +```powershell +PS C:\> $websocket = Invoke-AzContainerInstanceCommand -ContainerGroupName test-cg -ContainerName test-container -ResourceGroupName　test-rg -Command "echo hello" -TerminalSizeCol 12 -TerminalSizeRow 12 +PS C:\> $websocket + +Password WebSocketUri +-------- ------------ +****************** wss://bridge-linux-xx.eastus.management.azurecontainer.io/exec/caas-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/bridge-xxxxxxxxxxxxxxx?rows=12&cols=12api-version=2018-02-01-preview + +User needs connect websocket using password to fetch command execution result +``` +#### After +```powershell +PS C:\> Invoke-AzContainerInstanceCommand -ContainerGroupName test-cg -ContainerName test-container -ResourceGroupName　test-rg -Command "echo hello" + +hello +``` + + +## Az.Functions + +### `Update-AzFunctionApp, Update-AzFunctionAppPlan` +`Update-AzFunctionApp` will prompt for confirmation. This behavior can be bypassed by specifying `-Force`. + +#### Before +```powershell +Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -PlanName NewPlanName +``` +#### After +```powershell +Update-AzFunctionApp -Name MyUniqueFunctionAppName -ResourceGroupName MyResourceGroupName -PlanName NewPlanName -Force +``` + + +### `New-AzFunctionApp` +If `FunctionsVersion` parameter is not specified when executing the `New-AzFunctionApp` cmdlet, then the default Functions version will be set to `4`. + +``` +There is no change to the usage. +``` + +### `Remove-AzFunctionApp` +If this is the last app in the app service plan, then the plan will not be deleted. Before this release, the app plan will also be deleted. + +``` +There is no change to the usage. +``` + +## Az.HDInsight + +### `New-AzHDInsightCluster` +Changed the type of parameter "OSType" from `Microsoft.Azure.Management.HDInsight.Models.OSType` to `System.string` + +``` +There is no change to the usage. +``` + + +### `New-AzHDInsightCluster, New-AzHDInsightClusterConfig` +Changed the type of parameter "ClusterTier" from `Microsoft.Azure.Management.HDInsight.Models.ClusterTier` to `System.string` + +``` +There is no change to the usage. +``` + + +### `Set-AzHDInsightClusterDiskEncryptionKey, Set- AzHDInsightClusterSize` +The output type has changed from 'Microsoft.Azure.Management.HDInsight.Models.Cluster' to 'Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster'. + +``` +All properties remain the same, so there is no change to the usage. +``` + + + +### `Cluster cmdlets` +The type of property 'AssignedIdentity' has changed from 'Microsoft.Azure.Management.HDInsight.Models.ClusterIdentity' to 'Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightClusterIdentity'. + + +``` +All properties remain the same, so there is no change to the usage. +``` + + +### `Get-AzHDInsightProperties` +The generic type for output 'property VmSizes' has been changed from `System.Collections.Generic.IDictionary2[System.String,Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightVmSizesCapability]` to `System.Collections.Generic.IList1[System.String]`. + +#### Before +```powershell +PS C:\> $result = Get-AzHDInsightProperty -Location "South Central us" +PS C:\> $availableVmSizes = $result.VmSizes['iaas'].AvailableVmSizes +``` +#### After +```powershell +PS C:\> $result = Get-AzHDInsightProperty -Location "South Central us" +PS C:\> $availableVmSizes = $result.VmSizes +``` + + +## Az.KeyVault + +### `New-AzKeyVaultRoleDefinition, Get-AzKeyVaultRoleDefinition` +The following properties in `PSKeyVaultPermission` model are renamed: +- `AllowedActions` -> `Actions` +- `DeniedActions` -> `NotActions` +- `AllowedDataActions` -> `DataActions` +- `DeniedDataActions` -> `NotDataActions` + +#### Before +```powershell +PS C:\> $backupRole = Get-AzKeyVaultRoleDefinition -HsmName myHsm -RoleDefinitionName "Managed HSM Backup User" + +PS C:\> $backupRole.Permissions + +AllowedActions DeniedActions AllowedDataActions DeniedDataActions +-------------- ------------- ------------------ ----------------- +0 action(s) 0 action(s) 3 action(s) 0 action(s) + +PS C:\> $backupRole.Permissions.AllowedDataActions + +Microsoft.KeyVault/managedHsm/backup/start/action +Microsoft.KeyVault/managedHsm/backup/status/action +Microsoft.KeyVault/managedHsm/keys/backup/action +``` +#### After +```powershell +PS C:\> $backupRole = Get-AzKeyVaultRoleDefinition -HsmName myHsm -RoleDefinitionName "Managed HSM Backup User" + +PS C:\> $backupRole.Permissions + +Actions NotActions DataActions NotDataActions +------- ---------- ----------- -------------- +0 action(s) 0 action(s) 3 action(s) 0 action(s) + +PS C:\> $backupRole.Permissions.DataActions + +Microsoft.KeyVault/managedHsm/backup/start/action +Microsoft.KeyVault/managedHsm/backup/status/action +Microsoft.KeyVault/managedHsm/keys/backup/action +``` + + +## Az.ManagedServices + +### `New-AzManagedServicesDefinition` +The `-DisplayName` parameter was removed. + +#### Before +```powershell +PS C:\> New-AzManagedServicesDefinition -DisplayName "MyTestDefinition" -ManagedByTenantId 72f9acbf-86f1-41af-91ab-2d7ef011db47 -RoleDefinitionId acdd72a7-3385-48ef-bd42-f606fba81ae7 -PrincipalId 714160ec-87d5-42bb-8b17-287c0dd7417d +``` +#### After +```powershell +PS C:\> $permantAuth = New-AzManagedServicesAuthorizationObject -PrincipalId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -RoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -PrincipalIdDisplayName "Test user" -DelegatedRoleDefinitionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +PS C:\> New-AzManagedServicesDefinition -Name xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -RegistrationDefinitionName "Test definition" -ManagedByTenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Authorization $permantAuth -Description "Test definition desc" -Scope "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + + +## Az.Monitor + +### `Get-AzLog` + +The type of the properties 'EventName', 'Category', 'ResourceProviderName', 'OperationName', 'Status', 'SubStatus has changed from `Microsoft.Azure.Management.Monitor.Models.LocalizableString` to `System.String` + +#### Before +```powershell +PS C:\> $log = Get-AzLog -MaxRecord 1 +PS C:\> $eventName = $log.EventName.LocalizedValue +PS C:\> $category = $log.Category.LocalizedValue +PS C:\> $resourceProviderName = $log.ResourceProviderName.LocalizedValue +PS C:\> $operationName = $log.OperationName.LocalizedValue +PS C:\> $status = $log.Status.LocalizedValue +PS C:\> $subStatus = $log.SubStatus.LocalizedValue +``` +#### After +```powershell +PS C:\> $log = Get-AzLog -MaxRecord 1 +PS C:\> $eventName = $log.EventName +PS C:\> $category = $log.Category +PS C:\> $resourceProviderName = $log.ResourceProviderName +PS C:\> $operationName = $log.OperationName +PS C:\> $status = $log.Status +PS C:\> $subStatus = $log.SubStatus +``` + + +### `Get-AzMetric,Get-AzMetricDefinition` +The type of property 'Unit' has changed to `System.String` + +``` +There is no change to the usage. +``` + + + +### `New-AzMetricAlertRuleV2Criteria` +The type of property 'TimeAggregation' has changed to `System.String` + +``` +There is no change to the usage. +``` + + + +## Az.OperationalInsights + +### `Get-AzOperationalInsightsCluster` +Made "list" the default parameter set. + +#### Before +```powershell +There is no default parameter set. +``` +#### After +```powershell +Default parameter set is now "list", when providing resource group name - return all clusters for the given resource group. +``` + + +### `Update-AzOperationalInsightsCluster` +Made "UpdateByNameParameterSet" the default parameter set. + +#### Before +```powershell +There is no default parameter set. +``` +#### After +```powershell +Default parameter set is now "UpdateByNameParameterSet". +``` + + +## Az.RecoveryServices + +### `Get-AzRecoveryServicesBackupContainer` +Changed the BackupManagementType from MARS to MAB. Functionality remains same, this is to bring consistency across cmdlets. + +#### Before +```powershell +$containers = Get-AzRecoveryServicesBackupContainer -ContainerType Windows -BackupManagementType MARS -VaultId $vault.ID +``` +#### After +```powershell +$cont = Get-AzRecoveryServicesBackupContainer -ContainerType Windows -BackupManagementType MAB -VaultId $vault.ID +``` + + +### `Get-AzRecoveryServicesBackupItem` +Changed the BackupManagementType from MARS to MAB. Functionality remains same, this is to bring consistency across cmdlets + +#### Before +```powershell +Get-AzRecoveryServicesBackupItem -BackupManagementType MARS -VaultId $vault.ID -WorkloadType FileFolder +``` +#### After +```powershell +Get-AzRecoveryServicesBackupItem -BackupManagementType MAB -VaultId $vault.ID -WorkloadType FileFolder +``` + + +### `Get-AzRecoveryServicesBackupJob` +Changed the BackupManagementType from MARS to MAB. Functionality remains same, this is to bring consistency across cmdlets + +#### Before +```powershell +Get-AzRecoveryServicesBackupJob -BackupManagementType MARS -VaultId $vault.ID +``` +#### After +```powershell +Get-AzRecoveryServicesBackupJob -BackupManagementType MAB -VaultId $vault.ID +``` + + +## Az.Resources + +### `AzAD cmdlets` +Please refer to the [migration guide](/powershell/azure/azps-msgraph-migration-changes) of the Active Directory cmdlets. + +### `PolicyAssignment cmdlets` +The type of property 'Identity' of type 'Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment' has changed from 'System.Management.Automation.PSObject' to 'Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyIdentity'. + +#### Before +```powershell +PS C:\> $v = Get-AzPolicyAssignment -Id $someId +PS C:\> Write-Host $v.type, $v.principalId, $v.tenantId +``` +#### After +```powershell +PS C:\> $v = Get-AzPolicyAssignment -Id $someId +PS C:\> Write-Host $v.IdentityType, $v.PrincipalId, $v.TenantId, $v.UserAssignedIdentities +``` + + +## Az.Storage + +### `Get-AzRmStorageShare` +Parameter "Name" has been removed from parameter set "ShareResourceId", since name can be inferred from the resource ID. + +#### Before +```powershell +$StorageShare = Get-AzRmStorageShare -ResourceId "/subscriptions/..." -Name "MyStorageShare" +``` +#### After +```powershell +$StorageShare = Get-AzRmStorageShare -ResourceId "/subscriptions/..." +``` diff --git a/docs-conceptual/azps-10.1.0/migrate-az-8.0.0.md b/docs-conceptual/azps-10.1.0/migrate-az-8.0.0.md new file mode 100644 index 0000000000..3e25ad1270 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/migrate-az-8.0.0.md @@ -0,0 +1,300 @@ +--- +description: This migration guide contains a list of breaking changes made to Azure PowerShell in the Az version 8.0.0 release. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Migration guide for Az 8.0.0 +--- + +# Migration Guide for Az 8.0.0 +## Az.Aks + +### `Get-AzAks` +Alias `Get-AzAks` is removed. Please use `Get-AzAksCluster` instead. + +#### Before +```powershell +Get-AzAks -ResourceGroupName $resourceGroupName -Name $name +``` +#### After +```powershell +Get-AzAksCluster -ResourceGroupName $resourceGroupName -Name $name +``` + +### `New-AzAks` +Alias `New-AzAks` is removed. Please use `New-AzAksCluster` instead. + +#### Before +```powershell +New-AzAks -ResourceGroupName $resourceGroupName -Name $name -Location $location +``` +#### After +```powershell +New-AzAksCluster -ResourceGroupName $resourceGroupName -Name $name -Location $location +``` + +### `Set-AzAks` +Alias `Set-AzAks` is removed. Please use `Set-AzAksCluster` instead. + +#### Before +```powershell +Set-AzAks -ResourceGroupName $resourceGroupName -Name $name +``` +#### After +```powershell +Set-AzAksCluster -ResourceGroupName $resourceGroupName -Name $name +``` + +### `Remove-AzAks` +Alias `Remove-AzAks` is removed. Please use `Remove-AzAksCluster` instead. + +#### Before +```powershell +Remove-AzAks -ResourceGroupName $resourceGroupName -Name $name +``` +#### After +```powershell +Remove-AzAksCluster -ResourceGroupName $resourceGroupName -Name $name +``` + +## Az.Cdn + +### `New-AzCdnProfile` +Changed the type of parameter `Sku` to `SkuName` +Changed the type of parameter `ProfileName` to `Name` + +#### Before +```powershell +$profileSku = "Standard_Microsoft"; +$cdnProfileName = "profileNameXXXX"; +$resourceGroupName = "myresourcegroup" +New-AzCdnProfile -Sku $profileSku -ProfileName $cdnProfileName -ResourceGroupName $resourceGroupName -Location Global +``` +#### After +```powershell +$profileSku = "Standard_Microsoft"; +$cdnProfileName = "profileNameXXXX"; +$resourceGroupName = "myresourcegroup" +New-AzCdnProfile -SkuName $profileSku -Name $cdnProfileName -ResourceGroupName $resourceGroupName -Location Global +``` + +### `New-AzCdnEndpoint` +Changed parameter `EndpointName` to `Name` +Changed parameter `GeoFilters` to `GeoFilter` +Changed parameter `DefaultOriginGroup` to `DefaultOriginGroupId` +Merge parameters `OriginHostName`,`OriginId`,`OriginName`,`Priority`,`PrivateLinkApprovalMessage`,`PrivateLinkLocation`,`PrivateLinkResourceId`,`Weight`,`HttpPort`,`HttpsPort`into parameter `Origin` +Merge parameters `OriginGroupName`,`OriginGroupProbeIntervalInSeconds`,`OriginGroupProbePath`,`OriginGroupProbeProtocol`,`OriginGroupProbeRequestType`into parameter `OriginGroup` +Split parameter `DeliveryPolicy` in to parameters `DeliveryPolicyDescription`,`DeliveryPolicyRule` +Add parameters `SubscriptionId`,`UrlSigningKey`,`WebApplicationFirewallPolicyLinkId` +Delete parameter `CdnProfile ` + +#### Before +```powershell +New-AzCdnEndpoint -ResourceGroupName myresourcegroup -ProfileName mycdnprofile -Location westus -EndpointName myendpoint ` + -OriginName mystorage -OriginHostName mystorage.blob.core.windows.net ` + -OriginHostHeader mystorage.blob.core.windows.net -IsHttpAllowed $false +``` +#### After +```powershell +$origin = @{ + Name = "origin1" + HostName = "host1.hello.com" +}; +$location = "westus" + +$endpoint = New-AzCdnEndpoint -Name $endpointName -ResourceGroupName $ResourceGroupName -ProfileName $cdnProfileName -Location $location -Origin $origin +``` + +### `New-AzCdnDeliveryPolicy` +Delete command `New-AzCdnDeliveryPolicy`. Use `New-AzCdnDeliveryRuleObject` create rule object and used it in `New-AzCdnEndpoint` directly + + +### `New-AzCdnDeliveryRule` +Changed command name to `New-AzCdnDeliveryRuleObject` + +#### Before +```powershell +New-AzCdnDeliveryRule -Name "rule1" -Order 1 -Condition $cond1 -Action $action1 +``` +#### After +```powershell +$cond1 = New-AzCdnDeliveryRuleIsDeviceConditionObject -Name "IsDevice" -ParameterMatchValue "Desktop" +$action1 = New-AzCdnUrlRewriteActionObject -Name "UrlRewrite" -ParameterDestination "/def" -ParameterSourcePattern "/abc" -ParameterPreserveUnmatchedPath $true +$rule1 = New-AzCdnDeliveryRuleObject -Name "Rule1" -Action $action1,$action2 -Condition $cond1 -Order 1 +``` + +### `New-AzCdnCustomDomain` +Changed the type of parameter `CustomDomainName` to `Name` +Add parameter `SubscriptionId` +Delete parameter `CdnEndpoint` + +#### Before +```powershell +New-AzCdnCustomDomain -ResourceGroupName $resourceGroupName -ProfileName $cdnProfileName -EndpointName $endpointName -CustomDomainName $customDomainName -HostName $customDomainHostName +``` +#### After +```powershell +New-AzCdnCustomDomain -ResourceGroupName $resourceGroupName -ProfileName $cdnProfileName -EndpointName $endpointName -Name $customDomainName -HostName $customDomainHostName -SubscriptionId $subId +``` + +### `Set-AzCdnProfile` +Replaced by command `Update-AzCdnProfile` + +#### Before +```powershell +$profileObject = Get-AzCdnProfile -ResourceGroupName myresourcegroup -ProfileName mycdnprofile +$profileObject.Tags = @{"key"="value"} +Set-AzCdnProfile -CdnProfile $profileObject +``` + +#### After +```powershell +$profileSku = "Standard_Microsoft"; +$cdnProfileName = "profileNameXXXX"; +$resourceGroupName = "myresourcegroup" +New-AzCdnProfile -SkuName $profileSku -Name $cdnProfileName -ResourceGroupName $resourceGroupName -Location Global + +$tags = @{ + Tag1 = 11 + Tag2 = 22 +} +Update-AzCdnProfile -Name $cdnProfileName -ResourceGroupName $resourceGroupName -Tag $tags +``` + +### `Set-AzCdnEndpoint` +Replaced by command `Update-AzCdnEndpoint` +`DeliveryPolicyDescription` and `DeliveryPolicyRule` should be provided together when you want to update one of them. + +#### Before +```powershell +$endpointObject = Get-AzCdnEndpoint -ResourceGroupName myresourcegroup -ProfileName mycdnprofile -EndpointName myendpoint +$endpointObject.IsHttpAllowed = $false +Set-AzCdnEndpoint -CdnEndpoint $endpointObject +``` +#### After +```powershell +$tags = @{ + Tag1 = 11 + Tag2 = 22 +} + +//Update tags +Update-AzCdnEndpoint -Name $endpointName -ProfileName $cdnProfileName -ResourceGroupName $resourceGroupName -Tag $tags + +//Update DeliveryPolicyDescription or DeliveryPolicyRule +Update-AzCdnEndpoint -Name $endpointName -ProfileName $cdnProfileName -ResourceGroupName $resourceGroupName ` + -DeliveryPolicyDescription $descprption -DeliveryPolicyRule $rule +``` + +### `Set-AzCdnOriginGroup` +Replaced by command `Update-AzCdnOriginGroup` + +#### Before +```powershell +Set-AzCdnOriginGroup -ResourceGroupName $resourceGroupName -ProfileName $profileName -EndpointName $endpointName -OriginGroupName $originGroupName -OriginId $originIds -ProbeIntervalInSeconds $probeInterval +``` +#### After +```powershell +Update-AzCdnOriginGroup -EndpointName $endpointName -Name $originGroup.Name -ProfileName $cdnProfileName -ResourceGroupName $ResourceGroupName ` + -HealthProbeSetting $healthProbeParametersObject2 -Origin @(@{ Id = $originId }) + +``` + +### `Set-AzCdnOrigin` +Replaced by command `Update-AzCdnOrigin` + +#### Before +```powershell +Set-AzCdnOrigin -ResourceGroupName $resourceGroupName -ProfileName $cdnProfileName -EndpointName $endpointName ` + -OriginName $originName -HostName "mystorage2.blob.core.windows.net" +``` +#### After +```powershell +Update-AzCdnOrigin -ResourceGroupName $resourceGroupName -ProfileName $cdnProfileName -EndpointName $endpointName ` + -Name $originName -HostName "mystorage2.blob.core.windows.net" -HttpPort 456 -HttpsPort 789 +``` + +## Az.EventHub + +### `New-AzEventHubNamespace` +Parameter `Identity` is removed. +#### Before +```powershell +New-AzEventHubNamespace -ResourceGroupName myresourcegroup -Name MyNamespaceName -Location northeurope -SkuName Premium -IdentityType SystemAssigned -Identity +``` +#### After +```powershell +New-AzEventHubNamespace -ResourceGroupName myresourcegroup -Name MyNamespaceName -Location northeurope -SkuName Premium -IdentityType SystemAssigned +``` + +### `Set-AzEventHubNamespace` +Parameter `Identity` is removed. +#### Before +```powershell +Set-AzEventHubNamespace -ResourceGroupName myresourcegroup -Name MyNamespaceName -EncryptionConfig $ec1,$ec2 -Identity +``` +#### After +```powershell +Set-AzEventHubNamespace -ResourceGroupName myresourcegroup -Name MyNamespaceName -EncryptionConfig $ec1,$ec2 +``` + + +## Az.HealthcareApis + +### `Set-AzHealthcareApisService` +Combine New-AzHealthcareApisService and Set-AzHealthcareApisService into New-AzHealthcareApisService + +#### Before +```powershell +Set-AzHealthcareApisService -Name MyService -ResourceGroupName MyResourceGroup -CosmosOfferThroughput 500 +``` +#### After +```powershell +New-AzHealthcareApisService -Name MyService -ResourceGroupName MyResourceGroup -Location MyLocation -Kind fhir-R4 -CosmosOfferThroughput 500 +``` + + +### `Get-AzHealthcareApisService` +`-ResourceId` is removed + +#### Before +```powershell +Get-AzHealthcareApisService -ResourceId $ResourceId +``` +#### After +```powershell +Get-AzHealthcareApisService -ResourceGroupName $ResourceGroup -Name $Name +``` + + +### `Remove-AzHealthcareApisService` +`-ResourceId` is removed + +#### Before +```powershell +Remove-AzHealthcareApisService -ResourceId $ResourceId +``` +#### After +```powershell +Remove-AzHealthcareApisService -ResourceGroupName $ResourceGroup -Name $Name +``` + + +### `New-AzHealthcareApisService` +`-ManagedIdentity` is renamed to `-IdentityType` +`-FhirVersion` is removed and the desired content can be selected with the parameter `-Kind` +`-DisableCorsCredential` and `-AllowCorsCredential`: now uniformly named as `-AllowCorsCredential`, example: -AllowCorsCredential:$false or -AllowCorsCredential:$true +`-DisableSmartProxy` and `-EnableSmartProxy`: now uniformly named as `-EnableSmartProxy`, example: -EnableSmartProxy:$false or -EnableSmartProxy:$true + +#### Before +```powershell +New-AzHealthcareApisService -Name MyService -ResourceGroupName MyResourceGroup -Location MyLocation -FhirVersion fhir-R4 -CosmosOfferThroughput 500 -ManagedIdentity $IdentityType -DisableCorsCredential -DisableSmartProxy +``` +#### After +```powershell +New-AzHealthcareApisService -Name MyService -ResourceGroupName MyResourceGroup -Location MyLocation -Kind fhir-R4 -CosmosOfferThroughput 500 -IdentityType $IdentityType -AllowCorsCredential:$false -EnableSmartProxy:$false +``` + + diff --git a/docs-conceptual/azps-10.1.0/migrate-az-9.0.1-eventhub.md b/docs-conceptual/azps-10.1.0/migrate-az-9.0.1-eventhub.md new file mode 100644 index 0000000000..212383dc51 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/migrate-az-9.0.1-eventhub.md @@ -0,0 +1,351 @@ +--- +description: This migration guide contains a list of breaking changes made to the Az.EventHub module in the Azure PowerShell 9.0.1 release. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Migration Guide for latest Az.EventHub PowerShell Module +--- + +# Migration Guide for latest Az.EventHub PowerShell Module + +The `Az.EventHub` PowerShell module version 9.0.1 of Azure PowerShell that would be released in October introduces improvised cmdlets for public use. + +These changes are focused towards making the PowerShell use more productive and seamless for the end users. + +The following example installs the latest version of the `Az.Eventhub` Azure PowerShell module. + +```powershell +Install-Module -Name Az.EventHub -Repository PSGallery -Scope CurrentUser +``` + +## Major Changes: + +### Behavior of -InputObject: + +Until Module 8.3.0, -InputObject supports passing an in memory object to additional cmdlet in pipeline. Due to above design, updating resources becomes a multi step approach. + +With the new module release, -InputObject parameter set would be changing for a seamless experience. + +In contrast to earlier approach, -InputObject would now support object of corresponding input type as well as resource Id directly to the cmdlet. This would make cmdlet usage fairly easy and faster as compared to the old approach. + +Below example shows the difference in -InputObject Usage: + +### Before + +Below example shows how to update capture description on existing event hub with Module version 8.3.0 or older + +``` +$createdEventHub = Get-AzEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyCreatedEventHub +$createdEventHub.CaptureDescription = New-Object -TypeName Microsoft.Azure.Commands.EventHub.Models.PSCaptureDescriptionAttributes +$createdEventHub.CaptureDescription.Enabled = $true +$createdEventHub.CaptureDescription.IntervalInSeconds = 120 +$createdEventHub.CaptureDescription.Encoding = "Avro" +$createdEventHub.CaptureDescription.SizeLimitInBytes = 10485763 +$createdEventHub.CaptureDescription.Destination.Name = "EventHubArchive.AzureBlockBlob" +$createdEventHub.CaptureDescription.Destination.BlobContainer = "container" +$createdEventHub.CaptureDescription.Destination.ArchiveNameFormat = "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" +$createdEventHub.CaptureDescription.Destination.StorageAccountResourceId = "/subscriptions/{SubscriptionId}/resourceGroups/MyResourceGroupName/providers/Microsoft.ClassicStorage/storageAccounts/teststorage" +Set-AzEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -InputObject $createdEventHub +``` + +### After + +Below example shows how to update capture description on existing event hub with starting with / after Module version 9.0.1 + +``` +$eventhub = Get-AzEventHub -InputObject <ResourceID of event hub> + +Set-AzEventHub -InputObject $eventhub -CaptureEnabled -SizeLimitInBytes 10485763 -IntervalInSeconds 120 -Encoding Avro -DestinationName EventHubArchive.AzureBlockBlob -BlobContainer container -ArchiveNameFormat "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" -StorageAccountResourceId "/subscriptions/{SubscriptionId}/resourceGroups/MyResourceGroupName/providers/Microsoft.ClassicStorage/storageAccounts/teststorage" + +``` + +### Pipelining support + +- Accept pipeline Input for InputObject (InputObject pipelining) can be implemented in the following manner: + +``` +Get-AzEventHub -InputObject <ResourceId of the eventhub> | Set-AzEventHub -MessageRetentionInDays 6 +``` + +- Property pipelining would be disabled. In other words, none of the cmdlet parameters apart from `-InputObject` would accept pipeline input. +- `-InputObject` parameter would no longer support parameter aliasing. + +### Positional Binding + +- Positional binding is not supported. + +## Deprecation Announcements + +With new release,below cmdlets are marked to be deprecated: + +- Add-AzEventHubIPRule +- Add-AzEventHubVirtualNetworkRule +- Remove-AzEventHubIPRule +- Remove-AzEventHubVirtualNetworkRule +- Remove-AzEventHubNetworkRuleSet + +Use Set-AzEventHubNetworkRuleSet to add/remove IP or virtual network rules. + +## Changes to existing cmdlets + +Below list talks about the changes to existing cmdlets in detailed manner: + +## Application Groups + +### Get-AzEventHubApplicationGroup + +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubApplicationGroupAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IApplicationGroup`. + +### New-AzEventHubApplicationGroup + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubApplicationGroupAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IApplicationGroup`. +- `-ThrottlingPolicyConfig` would be renamed to `-Policy` and type would change from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubThrottlingPolicyConfigAttributes[]` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IApplicationGroupPolicy[]`. New-AzEventHubThrottlingPolicyConfig can still be used to construct this object. + +### Set-AzEventHubApplicationGroup + +- Input type of parameter `-InputObject` and Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubApplicationGroupAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IApplicationGroup`. +- `-ThrottlingPolicyConfig` would be renamed to `-Policy` and type would change from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubThrottlingPolicyConfigAttributes[]` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IApplicationGroupPolicy[]`. New-AzEventHubThrottlingPolicyConfig can still be used to construct this object. +- `-InputObject` parameter set would have a change in behaviour. Refer the [section](#behavior-of--inputobject) to know more. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### New-AzEventHubThrottlingPolicyConfig + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubThrottlingPolicyConfigAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IThrottlingPolicy`. + +### Remove-AzEventHubApplicationGroup + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubApplicationGroupAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IApplicationGroup`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +## Network Rule Sets + +### Set-AzEventHubNetworkRuleSet + +- Input type of parameter `-InputObject` and Output type has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSNetworkRuleSetAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.INetworkRuleSet`. +- Parameter `-IPRule` is changing type from `Microsoft.Azure.Commands.EventHub.Models.PSNWRuleSetIpRulesAttributes[]` to `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.INwRuleSetIPRules[]`. Please use `New-AzEventHubIPRuleConfig` cmdlet to construct an in-memory object which can be fed as input to `-IPRule`. +- Parameter `-VirtualNetworkRule` is changing type from `Microsoft.Azure.Commands.EventHub.Models.PSNWRuleSetVirtualNetworkRulesAttributes[]` to `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.INwRuleSetVirtualNetworkRules[]`. Please use `New-AzEventHubVirtualNetworkRuleConfig` cmdlet to construct an in-memory object which can then be fed as input to `-VirtualNetworkRule`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided to `-InputObject` parameter. +- `-InputObject` parameter set would have a change in behaviour. Refer the [section](#behavior-of--inputobject) to know more. + +### Get-AzEventHubNetworkRuleSet + +- Output type has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSNetworkRuleSetAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.INetworkRuleSet`. + +## Authorization Rules and SAS Keys + +### New-AzEventHubAuthorizationRule + +- Output type has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IAuthorizationRule`. + +### Set-AzEventHubAuthorizationRule + +- Input type of parameter `-InputObject` and Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IAuthorizationRule`. +- `-InputObject` parameter set would have a change in behaviour. Refer the [section](#behavior-of--inputobject) to know more. +- `-InputObject` parameter would no longer support alias `-AuthRuleObj`. + +### Get-AzEventHubAuthorizationRule + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IAuthorizationRule`. + +### New-AzEventHubKey + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSListKeysAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IAccessKeys`. +- Parameter `-ResourceGroupName` would no longer support alias `-ResourceGroup`. + +### Get-AzEventHubKey + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSListKeysAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IAccessKeys`. + +## Consumer Groups + +### New-AzEventHubConsumerGroup + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSConsumerGroupAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IConsumerGroup`. + +### Set-AzEventHubConsumerGroup + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSConsumerGroupAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IConsumerGroup`. +- `-InputObject` parameter set would have a change in behaviour. Refer the [section](#behavior-of--inputobject) to know more. + +### Get-AzEventHubConsumerGroup + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSConsumerGroupAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IConsumerGroup`. +- Parameter `-MaxCount` has been removed. Use `-Skip` and `-Top` pagination use case. + +### Remove-AzEventHubConsumerGroup + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSConsumerGroupAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IConsumerGroup`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +## Clusters + +### New-AzEventHubCluster + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubClusterAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ICluster`. +- `-ResourceId` would be removed as it is not supported for Creation operation and is available for use after resource is created. + +### Set-AzEventHubCluster + +- Input type of parameter `-InputObject` and Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubClusterAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ICluster`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. +- `-InputObject` parameter set would have a change in behaviour. Refer the [section](#behavior-of--inputobject) to know more. + +### Get-AzEventHubCluster + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubClusterAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ICluster`. + +### Remove-AzEventHubCluster + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubClusterAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ICluster`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + + +### Get-AzEventHubClustersAvailableRegion + + - Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models. +PSEventHubsAvailableCluster[]` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IAvailableCluster`. + +## EventHub + +### New-AzEventHub + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEventhub`. +- `-InputObject` would be removed as it is not supported for Creation operation and is available for use after resource is created. + +### Set-AzEventHub + +- Input type of parameter `-InputObject` and output type of the cmdlet have been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEventhub`. CaptureDescription class data members would be flattened and would directly be accessible as data members within Microsoft.`Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEventhub`. Please refer to example on top to know more. +- `-InputObject` parameter set would have a change in behaviour. Refer the [section](#behavior-of--inputobject) to know more. +- `-InputObject` parameter would no longer support alias `-EventHubObj`. + +### Remove-AzEventHub + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEventhub`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### Get-AzEventHub + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEventhub`. +- Parameter `-MaxCount` has been removed. Use `-Skip` and `-Top` for pagination use case. +- Parameter `-NamespaceObject` is being replaced by `-InputObject` of type `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEventhub`. + +## Private Endpoints + +### Approve-AzEventHubPrivateEndpointConnection + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubPrivateEndpointConnectionAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IPrivateEndpointConnection`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### Deny-AzEventHubPrivateEndpointConnection + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubPrivateEndpointConnectionAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IPrivateEndpointConnection`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### Remove-AzEventHubPrivateEndpointConnection + +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### Get-AzEventHubPrivateEndpointConnection + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubPrivateEndpointConnectionAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IPrivateEndpointConnection`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +## Private Links + +### Get-AzEventHubPrivateLink + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubPrivateLinkResourceAttributes[]` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IPrivateLinkResourcesListResult`. + +## Disaster Recovery Configs + +### Get-AzEventHubGeoDRConfiguration + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSNamespaceAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IArmDisasterRecovery`. +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSNamespaceAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IArmDisasterRecovery`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### New-AzEventHubGeoDRConfiguration + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IArmDisasterRecovery`. +- `-InputObject` and `-ResourceId` are not supported during resource creation, hence are being removed. + +### Remove-AzEventHubGeoDRConfiguration + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IArmDisasterRecovery`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### Set-AzEventHubGeoDRConfigurationBreakPair + +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IArmDisasterRecovery`. + +### Set-AzEventHubGeoDRConfigurationFailOver + +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IArmDisasterRecovery`. + +## Schema Groups + +### New-AzEventHubSchemaGroup + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubsSchemaRegistryAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ISchemaGroup`. + +### Get-AzEventHubSchemaGroup + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubsSchemaRegistryAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ISchemaGroup`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### Remove-AzEventHubSchemaGroup + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.EventHub.Models.PSEventHubsSchemaRegistryAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ISchemaGroup`. + +## CheckNameAvailability + +### Test-AzEventHubName + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.EventHub.Models. +PSCheckNameAvailabilityResultAttributes ` to + `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.ICheckNameAvailabilityResult`. diff --git a/docs-conceptual/azps-10.1.0/migrate-az-9.0.1-servicebus.md b/docs-conceptual/azps-10.1.0/migrate-az-9.0.1-servicebus.md new file mode 100644 index 0000000000..2351de5675 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/migrate-az-9.0.1-servicebus.md @@ -0,0 +1,353 @@ +--- +description: This migration guide contains a list of breaking changes made to the Az.ServiceBus module in the Azure PowerShell 9.0.1 release. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Migration Guide for latest Az.ServiceBus PowerShell Module +--- + +# Migration Guide for latest Az.ServiceBus PowerShell Module + +The `Az.ServiceBus` PowerShell module version 9.0.1 of Azure PowerShell that would be released in October introduces improvised cmdlets for public use. + +These changes are focused towards making the PowerShell use seamless for the end users. + +The following example installs the latest version of the `Az.ServiceBus` Azure PowerShell module. + +```powershell +Install-Module -Name Az.ServiceBus -Repository PSGallery -Scope CurrentUser +``` + +## Major Changes: + +### Behavior of -InputObject: + +Until Module 8.3.0, -InputObject supports passing an in memory object to additional cmdlet in pipeline. Due to above design, updating resources becomes a multi step approach. + +With the new module release, -InputObject parameter set would be changing for a seamless experience. + +In contrast to earlier approach, -InputObject would now support object of corresponding input type as well as resource Id directly to the cmdlet. This would make cmdlet usage fairly easy and faster as compared to the old approach. + +Below example shows the difference in -InputObject Usage: + +### Before + +Below example shows how to update queue properties on existing service bus namespace with Module version 8.3.0 or older + +``` +$QueueObj = Get-AzServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_example1 + +$QueueObj.ForwardTo = "q1" +$QueueObj.ForwardDeadLetteredMessagesTo = "q1" +$QueueObj.DefaultMessageTimeToLive = "P1YT3H11M2S" + +Set-AzServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_example1 -InputObject $QueueObj +``` + +### After + +Below example shows how to update queue properties starting with / after Module version 9.0.1 + +``` +$queue = Get-AzServiceBusQueue -InputObject <ResourceID of ServiceBus Queue> + +Set-AzServiceBusQueue -InputObject $queue -ForwardTo q1 -ForwardDeadLetteredMessagesTo q2 -DefaultMessageTimeToLive (New-Timespan -Days 365 -Hours 3 -Minutes 11 -Seconds 2) +``` + +- Input type of parameters `-DefaultMessageTimeToLive`, `-AutoDeleteOnIdle`, `-LockDuration`, `-DuplicateDetectionHistoryTimeWindow` has been changed from System.String to System.Timespan. Hence, ISO 8601 format for timespan can NO longer be fed as input to these parameters. Please use New-TimeSpan cmdlet object to construct Timespan variables as shown in the example above. Please refer [New-TimeSpan](/powershell/module/microsoft.powershell.utility/new-timespan) to know more about New-TimeSpan. + +### Pipelining support + +- Accept pipeline Input for InputObject (InputObject pipelining) can be implemented in the following manner: + +``` +Get-AzServiceBusQueue -InputObject <ResourceId of the queue> | Set-AzServiceBusQueue -MessageRetentionInDays 6 +``` + +- Property pipelining would be disabled. In other words, None of the cmdlet parameters apart from `-InputObject` would accept pipeline input. +- `-InputObject` parameter would no longer support parameter aliasing. + +### Positional Binding + +- Positional binding is not supported. + +## Deprecation Announcements + +With new release,below cmdlets are marked to be deprecated: + +- Add-AzServiceBusIPRule +- Add-AzServiceBusVirtualNetworkRule +- Remove-AzServiceBusIPRule +- Remove-AzServiceBusVirtualNetworkRule +- Remove-AzServiceBusNetworkRuleSet + +Use Set-AzServiceBusNetworkRuleSet to add/remove multiple IP/ virtual network rules. + +## Changes to existing Cmdlets + +## Network Rule Sets + +### Set-AzServiceBusNetworkRuleSet + +- Input type of parameter `-InputObject` and Output type of the cmdlet have been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSNetworkRuleSetAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.INetworkRuleSet`. +- Parameter `-IPRule` is changing type from `Microsoft.Azure.Commands.ServiceBus.Models.PSNWRuleSetIpRulesAttributes[]` to `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.INwRuleSetIPRules[]`.Please use `New-AzServiceBusIPRuleConfig` cmdlet to construct an in-memory object which can then be fed as input to `-IPRule`. +- Parameter `-VirtualNetworkRule` is changing type from `Microsoft.Azure.Commands.ServiceBus.Models.PSNWRuleSetVirtualNetworkRulesAttributes[]` to `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.INwRuleSetVirtualNetworkRules[]`.Please use `New-AzServiceBusVirtualNetworkRuleConfig` cmdlet to construct an in-memory object which can then be fed as input to `-VirtualNetworkRule`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided to `-InputObject` parameter. +- `-InputObject` parameter set would have a change in behaviour. Refer the [section](#behavior-of--inputobject) to know more. + +### Get-AzServiceBusNetworkRuleSet + +- Input type of parameter `-InputObject` and Output type of the cmdlet have been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSNetworkRuleSetAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.INetworkRuleSet`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided to `-InputObject` parameter. + +## Authorization Rules and SAS Keys + +### New-AzServiceBusAuthorizationRule + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbAuthorizationRule`. + +### Set-AzServiceBusAuthorizationRule + +- Input type of parameter `-InputObject` and Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbAuthorizationRule`. +- `-InputObject` parameter set would have a change in behaviour. Refer the [section](#behavior-of--inputobject) to know more. +- `-InputObject` parameter would no longer support alias `-AuthRuleObj`. + +### Get-AzServiceBusAuthorizationRule + +- Input type of parameter `-InputObject` and Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbAuthorizationRule`. + +### New-AzServiceBusKey + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSListKeysAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IAccessKeys`. + +### Get-AzServiceBusKey + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSListKeysAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IAccessKeys`. + +## Queue Entity + +### New-AzServiceBusQueue + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbQueue`. +- `-SizeInBytes` and `-MessageCount` are readonly parameters and are getting removed. +- Parameter `-EnableBatchedOperations` is renamed to `-EnableBatchedOperation`. +- Input type of parameters `-DefaultMessageTimeToLive`, `-AutoDeleteOnIdle`, `-LockDuration`, `-DuplicateDetectionHistoryTimeWindow` has been changed from System.String to System.Timespan. Hence, ISO 8601 format for timespan can NO longer be fed as input to these parameters. Please use New-TimeSpan cmdlet object to construct Timespan variables. Please refer [New-TimeSpan](/powershell/module/microsoft.powershell.utility/new-timespan) to know more about New-TimeSpan. + +### Set-AzServiceBusQueue + +- Input type of parameter `-InputObject` and of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbQueue`. +- `-InputObject` parameter set would have a change in behaviour. Refer the [section](#behavior-of--inputobject) to know more. +- `-InputObject` parameter would no longer support alias `-QueueObj`. + +### Remove-AzServiceBusQueue + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbQueue`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### Get-AzServiceBusQueue + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbQueue`. +- Parameter `-MaxCount` has been removed. Use `-Skip` and `-Top` for pagination use cases. + +## Topic Entity + +### Get-AzServiceBusTopic + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbTopic`. +- Parameter `-MaxCount` has been removed. Use `-Skip` and `-Top` for pagination use cases. +- Parameter `-ResourceGroupName` would no longer support alias `-ResourceGroup`. + +### Set-AzServiceBusTopic + +- Input type of parameter `-InputObject` and Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbTopic`. +- `-InputObject` parameter set would have a change in behaviour. Refer the [section](#behavior-of--inputobject) to know more. +- `-InputObject` parameter would no longer support alias `-TopicObj`. +- Parameter `-ResourceGroupName` would no longer support alias `-ResourceGroup`. + +### New-AzServiceBusTopic + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbTopic`. +- `-SizeInBytes` is readonly parameter and is getting removed. +- Parameter `-EnableBatchedOperations` would be renamed to `-EnableBatchedOperation`. +- Input type of parameters `-DefaultMessageTimeToLive`, `-AutoDeleteOnIdle`, `-DuplicateDetectionHistoryTimeWindow` has been changed from System.String to System.Timespan. Hence, ISO 8601 format for timespan can NO longer be fed as input to these parameters. Please use New-TimeSpan cmdlet object to construct Timespan variables. Please refer [New-TimeSpan](/powershell/module/microsoft.powershell.utility/new-timespan) to know more about New-TimeSpan. +- Parameter `-ResourceGroupName` would no longer support alias `-ResourceGroup`. + +### Remove-AzServiceBusTopic + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbTopic`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. +- Parameter `-ResourceGroupName` would no longer support alias `-ResourceGroup`. + +## Rule Entity + +### Get-AzServiceBusRule + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSRulesAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IRule`. +- Parameter `-MaxCount` has been removed. Use `-Skip` and `-Top` for pagination use cases. + +### Set-AzServiceBusRule + +- Input type of parameter `-InputObject` and Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSRulesAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IRule`. +- `-InputObject` parameter set would have a change in behaviour. Refer the [section](#behavior-of--inputobject) to know more. + +### New-AzServiceBusRule + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSRulesAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IRule`. +- Parameter `-RequiresPreprocessing` is being renamed to `-ActionRequiresPreprocessing`. + +### Remove-AzServiceBusRule + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSRulesAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IRule`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +## Subscription Entity + +### Get-AzServiceBusSubscription + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbSubscription`. +- Parameter `-MaxCount` has been removed. Use `-Skip` and `-Top` for pagination use cases. + +### New-AzServiceBusSubscription + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbSubscription`. +- Input type of parameters `-DefaultMessageTimeToLive`, `-AutoDeleteOnIdle`, `-LockDuration`, `-DuplicateDetectionHistoryTimeWindow` has been changed from System.String to System.Timespan. Hence, ISO 8601 format for timespan can NO longer be fed as input to these parameters. Please use New-TimeSpan cmdlet object to construct Timespan variables. Please refer [New-TimeSpan](/powershell/module/microsoft.powershell.utility/new-timespan) to know more about New-TimeSpan. + +### Set-AzServiceBusSubscription + +- Input type of parameter `-InputObject` and Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbSubscription`. +- `-InputObject` parameter set would have a change in behaviour. Refer the [section](#behavior-of--inputobject) to know more. +- `-InputObject` parameter would no longer support alias `-SubscriptionObj`. + +### Remove-AzServiceBusSubscription + +- Input type of parameter `-InputObject` and Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ISbSubscription`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +## Private Endpoints + +### Approve-AzServiceBusPrivateEndpointConnection + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusPrivateEndpointConnectionAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IPrivateEndpointConnection`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### Deny-AzServiceBusPrivateEndpointConnection + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusPrivateEndpointConnectionAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IPrivateEndpointConnection`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### Remove-AzServiceBusPrivateEndpointConnection + +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### Get-AzServiceBusPrivateEndpointConnection + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusPrivateEndpointConnectionAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IPrivateEndpointConnection`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +## Private Links + +### Get-AzServiceBusPrivateLink + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusPrivateLinkResourceAttributes[]` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IPrivateLinkResourcesListResult`. + +## Disaster Recovery Configs + +### Get-AzServiceBusGeoDRConfiguration + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSNamespaceAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IArmDisasterRecovery`. +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IArmDisasterRecovery`. +- `-Name` parameter would be removed from `-InputObject` parameter set. Henceforth,`-InputObject` must contain the ResourceId of Disaster Recovery Configuration alias. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### New-AzServiceBusGeoDRConfiguration + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IArmDisasterRecovery`. +- `-InputObject` and `-ResourceId` are not supported during resource creation, hence are being removed. + +### Remove-AzServiceBusGeoDRConfiguration + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IArmDisasterRecovery`. +- `-ResourceId` parameter would be deprecated. Henceforth, resource id can be provided as input to `-InputObject` parameter. + +### Set-AzServiceBusGeoDRConfigurationBreakPair + +- Parameter `-ResourceId` is being removed. Henceforth, resource id can be provided as input to `-InputObject`. +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IArmDisasterRecovery`. + +### Set-AzServiceBusGeoDRConfigurationFailOver + +- Parameter `-ResourceId` is being removed. Henceforth, resource id can be provided as input to `-InputObject`. +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IArmDisasterRecovery`. + +## Migration Configurations + +### Complete-AzServiceBusMigration + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IMigrationConfigProperties`. +- Parameter `-ResourceId` is being removed. Henceforth, resource id can be provided as input to `-InputObject`. + +### Get-AzServiceBusMigration + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusMigrationConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IMigrationConfigProperties`. +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusMigrationConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IMigrationConfigProperties`. + +### Start-AzServiceBusMigration + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusMigrationConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IMigrationConfigProperties`. + +### Remove-AzServiceBusMigration + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IMigrationConfigProperties`. + +### Stop-AzServiceBusMigration + +- Input type of parameter `-InputObject` has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.IMigrationConfigProperties`. +- Parameter `-ResourceId` is being removed. Henceforth, resource id can be provided as input to `-InputObject`. + +## CheckNameAvailability + +### Test-AzServiceBusName + +- Output type of the cmdlet has been changed from `Microsoft.Azure.Commands.ServiceBus.Models.PSCheckNameAvailabilityResultAttributes` to + `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api202201Preview.ICheckNameAvailabilityResult`. diff --git a/docs-conceptual/azps-10.1.0/migrate-az-9.0.1.md b/docs-conceptual/azps-10.1.0/migrate-az-9.0.1.md new file mode 100644 index 0000000000..ec20a3d9f6 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/migrate-az-9.0.1.md @@ -0,0 +1,1096 @@ +--- +description: This migration guide contains a list of breaking changes made to Azure PowerShell in the Az version 9.0.1 release. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Migration guide for Az 9.0.1 +--- + +# Migration Guide for Az 9.0.1 + +## Az.Advisor + +### `Set-AzAdvisorConfiguration` + +- No longer has output type 'Microsoft.Azure.Commands.Advisor.Cmdlets.Models.PsAzureAdvisorConfigurationData'. +- No longer supports the type 'System.Int32' for parameter 'LowCpuThreshold'. +- No longer supports the type 'Microsoft.Azure.Commands.Advisor.Cmdlets.Models.PsAzureAdvisorConfigurationData' for parameter 'InputObject'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'InputObjectRgExcludeParameterSet' is no longer the default parameter set. +- The parameter set 'InputObjectLowCpuExcludeParameterSet' has been removed. +- The parameter set 'InputObjectRgExcludeParameterSet' has been removed. + +### `Enable-AzAdvisorRecommendation` + +- No longer has output type 'Microsoft.Azure.Commands.Advisor.Cmdlets.Models.PsAzureAdvisorResourceRecommendationBase'. +- No longer supports the type 'Microsoft.Azure.Commands.Advisor.Cmdlets.Models.PsAzureAdvisorResourceRecommendationBase' for parameter 'InputObject'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'NameParameterSet' is no longer the default parameter set. +- The parameter set 'IdParameterSet' has been removed. +- The parameter set 'InputObjectParameterSet' has been removed. +- The parameter set 'NameParameterSet' has been removed. + +### `Disable-AzAdvisorRecommendation` + +- No longer has output type 'Microsoft.Azure.Commands.Advisor.Cmdlets.Models.PsAzureAdvisorSuppressionContract'. +- No longer supports the parameter 'Days' and no alias was found for the original parameter name. +- No longer supports the type 'Microsoft.Azure.Commands.Advisor.Cmdlets.Models.PsAzureAdvisorResourceRecommendationBase' for parameter 'InputObject'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'IdParameterSet' has been removed. +- The parameter set 'NameParameterSet' has been removed. +- The parameter set 'InputObjectParameterSet' has been removed. + +### `Get-AzAdvisorRecommendation` + +- No longer has output type 'Microsoft.Azure.Commands.Advisor.Cmdlets.Models.PsAzureAdvisorResourceRecommendationBase'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'NameParameterSet' is no longer the default parameter set. +- The parameter set 'IdParameterSet' has been removed. +- The parameter set 'NameParameterSet' has been removed. + +### `Get-AzAdvisorConfiguration` + +- No longer has output type 'Microsoft.Azure.Commands.Advisor.Cmdlets.Models.PsAzureAdvisorConfigurationData'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'RgParameterSet' has been removed. + +## Az.Aks + +### `Install-AzAksKubectl` + +Replaced by Install-AzAksCliTool + +#### Before + +```powershell +Install-AzAksKubectl +``` + +#### After + +```powershell +Install-AzAksCliTool +``` + +## Az.ApiManagement + +### `Get-AzApiManagement` + +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. + +### `Set-AzApiManagement` + +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. + +### `Restore-AzApiManagement` + +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. + +### `Get-AzApiManagementSsoToken` + +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. + +### `Update-AzApiManagementRegion` + +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. +- No longer supports the type 'PsApiManagementSku' for parameter 'Sku'. + +### `Backup-AzApiManagement` + +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. + +### `Add-AzApiManagementRegion` + +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. +- The type of property 'Sku' of type 'PsApiManagementRegion' has changed from 'PsApiManagementSku' to 'System.String'. +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. +- No longer supports the type 'System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku]' for parameter 'Sku'. + +### `New-AzApiManagement` + +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. +- No longer supports the type 'System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku]' for parameter 'Sku'. + +### `New-AzApiManagementRegion` + +- The type of property 'Sku' of type 'PsApiManagementRegion' has changed from 'PsApiManagementSku' to 'System.String'. + +### `Remove-AzApiManagementRegion` + +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. + +### `Get-AzApiManagementNetworkStatus` + +- The type of property 'Sku' of type 'PsApiManagement' has changed from 'PsApiManagementSku' to 'System.String'. + +## Az.Attestation + +### `Get-AzAttestation` + +- Replaced by 'Get-AzAttestationProvider'. + +#### Before + +```powershell +Get-AzAttestation -Name testprovider1 -ResourceGroupName test-rg +Get-AzAttestation -DefaultProvider +``` + +#### After + +```powershell +Get-AzAttestationProvider -Name testprovider1 -ResourceGroupName test-rg +Get-AzAttestationDefaultProvider +``` + +### `New-AzAttestation` + +- Replaced by 'New-AzAttestationProvider'. + +#### Before + +```powershell +New-AzAttestation -Name testprovider2 -ResourceGroupName test-rg -Location "East US" -PolicySignersCertificateFile .\cert1.pem +``` + +#### After + +```powershell +New-AzAttestationProvider -Name testprovider2 -ResourceGroupName test-rg -Location "East US" -PolicySigningCertificateKeyPath .\cert1.pem +``` + +### `Remove-AzAttestation` + +- Replaced by 'Remove-AzAttestationProvider'. + +#### Before + +```powershell +Remove-AzAttestation -Name testprovider -ResourceGroupName test-rg +``` + +#### After + +```powershell +Remove-AzAttestationProvider -Name testprovider -ResourceGroupName test-rg +``` + +## Az.EventHub + +### `Get-AzEventHubAuthorizationRule` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'. + +### `Get-AzEventHubKey` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'. + +### `New-AzEventHubAuthorizationRule` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'. + +### `New-AzEventHubKey` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup' + +### `Remove-AzEventHubAuthorizationRule` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been changed to 'EventHubName'. + +### `Set-AzEventHubAuthorizationRule` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup' + +### `Get-AzEventHubConsumerGroup` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup' + +### `New-AzEventHubConsumerGroup` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been changed to 'EventHubName'. + +### `Set-AzEventHubConsumerGroup` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup' + +### `Remove-AzEventHubConsumerGroup` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. The parameter 'EventHub' has been renamed to 'EventHubName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup' + +### `Get-AzEventHub` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `New-AzEventHub` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Set-AzEventHub` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Remove-AzEventHub` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Get-AzEventHubNetworkRuleSet` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Set-AzEventHubNetworkRuleSet` + +- Parameter 'Name' has been renamed to 'NamespaceName'. + +### `New-AzEventHubSchemaGroup` + +Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Remove-AzEventHubSchemaGroup` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Get-AzEventHubSchemaGroup` + +Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Get-AzEventHubGeoDRConfiguration` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Set-AzEventHubGeoDRConfigurationBreakPair` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Set-AzEventHubGeoDRConfigurationFailOver` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Remove-AzEventHubGeoDRConfiguration` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `New-AzEventHubGeoDRConfiguration` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Test-AzEventHubName` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +## Az.MarketplaceOrdering + +### `Get-AzMarketplaceTerms` + +Add OfferType parameter + +#### Before + +```powershell +Get-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" + +Publisher : microsoft-ads +Product : windows-data-science-vm +Plan : windows2016 +LicenseTextLink : <LicenseTextLink> +PrivacyPolicyLink : <PrivacyPolicyLink> +Signature : <Signature> +Accepted : True +RetrieveDatetime : <RetrieveDatetime> +``` + +#### After + +```powershell +Get-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" -OfferType 'virtualmachine' + +``` + +### `Set-AzMarketplaceTerms` + +Remove parameter 'Term' + +#### Before + +```powershell +$agreementTerms = Get-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" +Set-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" -Terms $agreementTerms -Accept +``` + +#### After + +```powershell +Set-AzMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" -Accept +``` + +## Az.Migrate + +### `New-AzMigrateReplicationVaultSetting` + +- Has been removed and no alias was found for the original cmdlet name. + +### `Get-AzMigrateReplicationVaultSetting` + +- Has been removed and no alias was found for the original cmdlet name. + +### `Get-AzMigrateReplicationProtectionIntent` + +- Has been removed and no alias was found for the original cmdlet name. + +### `Get-AzMigrateSupportedOperatingSystem` + +- Has been removed and no alias was found for the original cmdlet name. + +### `Get-AzMigrateReplicationEligibilityResult` + +- Has been removed and no alias was found for the original cmdlet name. + +### `New-AzMigrateReplicationProtectionIntent` + +- Has been removed and no alias was found for the original cmdlet name. + +## Az.Monitor + +### `Get-AzActivityLogAlert` + +- New API version with new set of input/output, please see cmdlet help for detail + +### `Remove-AzActivityLogAlert` + +- New API version with new set of input/output, please see cmdlet help for detail + +### `Set-AzActivityLogAlert` + +- Replaced by New-AzActivityLogAlert + +### `Disable-AzActivityLogAlert` + +- Replaced by Update-AzActivityLogAlert + +### `Enable-AzActivityLogAlert` + +- Replaced by Update-AzActivityLogAlert + +### `New-AzActionGroup` + +- Replaced by New-AzActivityLogAlertActionGroupObject + +### `Get-AzDiagnosticSettingCategory` + +- New API version with new set of input/output, please see cmdlet help for detail + +### `Get-AzDiagnosticSetting` + +- New API version with new set of input/output, please see cmdlet help for detail + +### `New-AzDiagnosticSetting` + +- New API version with new set of input/output, please see cmdlet help for detail + +### `Remove-AzDiagnosticSetting` + +- New API version with new set of input/output, please see cmdlet help for detail + +### `Set-AzDiagnosticSetting` + +- Replaced by New-AzDiagnosticSetting + +### `New-AzDiagnosticDetailSetting` + +- Replaced by New-AzDiagnosticSettingLogSettingsObject and New-AzDiagnosticSettingMetricSettingsObject + +### `Get-AzSubscriptionDiagnosticSettingCategory` + +- Replaced by Get-AzEventCategory + +### `Get-AzAutoscaleSetting` + +- New API version with new set of input/output, please see cmdlet help for detail + +### `Remove-AzAutoscaleSetting` + +- New API version with new set of input/output, please see cmdlet help for detail + +### `Add-AzAutoscaleSetting` + +- Replaced by New-AzAutoscaleSetting + +### `New-AzAutoscaleNotification` + +- Replaced by New-AzAutoscaleNotificationObject + +### `New-AzAutoscaleProfile` + +- Replaced by New-AzAutoscaleProfileObject + +### `New-AzAutoscaleRule` + +- Replaced by New-AzAutoscaleScaleRuleObject + +### `New-AzAutoscaleWebhook` + +- Replaced by New-AzAutoscaleWebhookNotificationObject + +### `Get-AzScheduledQueryRule` + +- New API version with new set of input/output, please see cmdlet help for detail + +### `New-AzScheduledQueryRuleAlertingAction` + +- Removed due to new API version + +### `New-AzScheduledQueryRuleAznActionGroup` + +- Removed due to new API version + +### `New-AzScheduledQueryRule` + +- New API version with new set of input/output, please see cmdlet help for detail + +### `New-AzScheduledQueryRuleLogMetricTrigger` + +- Removed due to new API version + +### `New-AzScheduledQueryRuleSchedule` + +- Removed due to new API version + +### `New-AzScheduledQueryRuleSource` + +- Removed due to new API version + +### `New-AzScheduledQueryRuleTriggerCondition` + +- Removed due to new API version + +### `Remove-AzScheduledQueryRule` + +- New API version with new set of input/output, please see cmdlet help for detail + +### `Set-AzScheduledQueryRule` + +- Removed and no replacement. + +### `Update-AzScheduledQueryRule` + +- New API version with new set of input/output, please see cmdlet help for detail + +## Az.Network + +### `New-AzFirewall` + +- The property 'IdentifyTopFatFlow' of type 'PSAzureFirewall' has been removed. +- The property 'publicIPAddresses' of type 'PSAzureFirewallHubIpAddresses' has been removed. +- No longer supports the parameter 'IdentifyTopFatFlow' and no alias was found for the original parameter name. +- The parameter set '__AllParameterSets' has been removed. +- The parameter set 'OldIpConfigurationParameterValues' has been removed. +- The parameter set 'IpConfigurationParameterValues' has been removed. + +### `New-AzFirewallHubIpAddress` + +- The property 'publicIPAddresses' of type 'PSAzureFirewallHubIpAddresses' has been removed. + +### `Set-AzFirewall` + +- The property 'IdentifyTopFatFlow' of type 'PSAzureFirewall' has been removed. + +### `New-AzNetworkManagerAddressPrefixItem` + +- A validate set has been added for parameter 'AddressPrefixType'. + +### `New-AzNetworkManagerSecurityAdminConfiguration` + +- The element type for parameter 'ApplyOnNetworkIntentPolicyBasedService' has been changed from 'System.String' to 'Microsoft.Azure.Commands.Network.NewAzNetworkManagerSecurityAdminConfigurationCommand.NetworkIntentPolicyBasedServiceType'. + +### `New-AzNetworkManager` + +- The element type for parameter 'NetworkManagerScopeAccess' has been changed from 'System.String' to 'Microsoft.Azure.Commands.Network.NewAzNetworkManagerCommand.NetworkManagerScopeAccessType'. + +### `Get-AzFirewall` + +- The property 'publicIPAddresses' of type 'PSAzureFirewallHubIpAddresses' has been removed. +- The property 'IdentifyTopFatFlow' of type 'PSAzureFirewall' has been removed. +- The property 'IdentifyTopFatFlow' of type 'PSAzureFirewall' has been removed. + +### `New-AzNetworkManagerConnectivityConfiguration` + +- A validate set has been added for parameter 'ConnectivityTopology'. + +### `Deploy-AzNetworkManagerCommit` + +- A validate set has been added for parameter 'CommitType'. + +### `New-AzNetworkManagerConnectivityGroupItem` + +- A validate set has been added for parameter 'GroupConnectivity'. + +### `New-AzNetworkManagerSecurityAdminRule` + +- A validate set has been added for parameter 'Protocol'. +- A validate set has been added for parameter 'Direction'. +- A validate set has been added for parameter 'Access'. + +## Az.RecoveryServices + +### `Get-AzRecoveryServicesBackupContainer` + +- No longer supports the parameter 'Status' and no alias was found for the original parameter name. +The parameter set '__AllParameterSets' has been removed. + +## Az.SecurityInsights + +### `Update-AzSentinelAlertRuleAction` + +- No longer has output type 'PSSentinelActionResponse'. +- No longer supports the parameter 'AlertRuleId' and no alias was found for the original parameter name. +- No longer supports the type 'PSSentinelActionResponse' for parameter 'InputObject'. +- No longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'ActionId' has been removed. +- The parameter set 'ResourceId' has been removed. + +### `New-AzSentinelIncidentOwner` + +- Has been removed and no alias was found for the original cmdlet name. + +### `New-AzSentinelIncidentComment` + +- No longer has output type 'PSSentinelIncidentComment'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set '__AllParameterSets' has been removed. + +### `Get-AzSentinelBookmark` + +- No longer has output type 'PSSentinelBookmark'. +- No longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'BookmarkId.' has been removed. +- The parameter set 'ResourceId' has been removed. + +### `Update-AzSentinelAlertRule` + +- No longer has output type 'PSSentinelAlertRule'. +- No longer supports the parameter 'AlertRuleId' and no alias was found for the original parameter name. +- No longer supports the type 'System.String' for parameter 'ProductFilter'. +- No longer supports the type 'System.Collections.Generic.IList`1[System.String]' for parameter 'DisplayNamesExcludeFilter'. +- No longer supports the type 'System.Collections.Generic.IList`1[System.String]' for parameter 'DisplayNamesFilter'. +- No longer supports the type 'System.Collections.Generic.IList`1[System.String]' for parameter 'SeveritiesFilter'. +- No longer supports the parameter 'SuppressionDisabled' and no alias was found for the original parameter name. +- No longer supports the type 'System.Nullable`1[System.TimeSpan]' for parameter 'QueryFrequency'. +- No longer supports the type 'System.Nullable`1[System.TimeSpan]' for parameter 'QueryPeriod'. +- No longer supports the type 'System.String' for parameter 'Severity'. +- No longer supports the type 'System.Collections.Generic.IList`1[System.String]' for parameter 'Tactic'. +- No longer supports the type 'Microsoft.Azure.Management.SecurityInsights.Models.TriggerOperator' for parameter 'TriggerOperator'. +- No longer supports the type 'System.Nullable`1[System.Int32]' for parameter 'TriggerThreshold'. +- No longer supports the type 'PSSentinelAlertRule' for parameter 'InputObject'. +- No longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'AlertRuleId' has been removed. +- The parameter set '__AllParameterSets' has been removed. +- The parameter set 'InputObject' has been removed. +- The parameter set 'ResourceId' has been removed. + +### `Get-AzSentinelIncidentComment` + +- No longer has output type 'PSSentinelIncidentComment'. +- No longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'ResourceId' has been removed. + +### `Get-AzSentinelAlertRuleAction` + +- No longer has output type 'PSSentinelActionResponse'. +- No longer supports the parameter 'AlertRuleId' and no alias was found for the original parameter name. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'AlertRuleId' has been removed. +- The parameter set 'ActionId' has been removed. + +### `Remove-AzSentinelIncident` + +- No longer supports the type 'PSSentinelIncident' for parameter 'InputObject'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'IncidentId' has been removed. + +### `New-AzSentinelBookmark` + +- No longer has output type 'PSSentinelBookmark'. +- No longer supports the parameter 'IncidentInfo' and no alias was found for the original parameter name. +- No longer supports the type 'System.Collections.Generic.IList`1[System.String]' for parameter 'Label'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'BookmarkId.' has been removed. +- The parameter set '__AllParameterSets' has been removed. + +### `Remove-AzSentinelAlertRule` + +- No longer has output type 'PSSentinelAlertRule'. +- No longer supports the parameter 'AlertRuleId' and no alias was found for the original parameter name. +- No longer supports the type 'PSSentinelAlertRule' for parameter 'InputObject'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'AlertRuleId' has been removed. + +### `Remove-AzSentinelAlertRuleAction` + +- No longer has output type 'PSSentinelActionResponse'. +- No longer supports the parameter 'AlertRuleId' and no alias was found for the original parameter name. +- No longer supports the type 'PSSentinelActionResponse' for parameter 'InputObject'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'ActionId' has been removed. + +### `Get-AzSentinelAlertRule` + +- No longer has output type 'PSSentinelAlertRule'. +- No longer supports the parameter 'AlertRuleId' and no alias was found for the original parameter name. +- No longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'AlertRuleId' has been removed. +- The parameter set 'ResourceId' has been removed. + +### `Update-AzSentinelDataConnector` + +- No longer has output type 'PSSentinelDataConnector'. +- No longer supports the parameter 'DataConnectorId' and no alias was found for the original parameter name. +- No longer supports the type 'PSSentinelDataConnector' for parameter 'InputObject'. +- No longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- No longer supports the parameter 'AwsRoleArn' and no alias was found for the original parameter name. +- No longer supports the parameter 'Logs' and no alias was found for the original parameter name. +- No longer supports the parameter 'DiscoveryLogs' and no alias was found for the original parameter name. +- No longer supports the parameter 'Indicators' and no alias was found for the original parameter name. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'DataConnectorId' has been removed. +- The parameter set 'InputObject' has been removed. +- The parameter set 'ResourceId' has been removed. +- The parameter set '__AllParameterSets' has been removed. + +### `Remove-AzSentinelBookmark` + +- No longer has output type 'PSSentinelBookmark'. +- No longer supports the type 'PSSentinelBookmark' for parameter 'InputObject'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'BookmarkId.' has been removed. + +### `New-AzSentinelIncident` + +- No longer has output type 'PSSentinelIncident'. +- No longer supports the parameter 'Classificaton' and no alias was found for the original parameter name. +- No longer supports the type 'System.String' for parameter 'ClassificationReason'. +- No longer supports the type 'System.Collections.Generic.IList`1[Microsoft.Azure.Commands.SecurityInsights.Models.Incidents.PSSentinelIncidentLabel]' for parameter 'Label'. +- No longer supports the parameter 'Owner' and no alias was found for the original parameter name. +- No longer supports the type 'System.String' for parameter 'Severity'. +- No longer supports the type 'System.String' for parameter 'Status'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'IncidentId' has been removed. +- The parameter set '__AllParameterSets' has been removed. + +### `New-AzSentinelAlertRuleAction` + +- No longer has output type 'PSSentinelActionResponse'. +- No longer supports the parameter 'AlertRuleId' and no alias was found for the original parameter name. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'ActionId' has been removed. +- The parameter set '__AllParameterSets' has been removed. + +### `Get-AzSentinelIncident` + +- No longer has output type 'PSSentinelIncident'. +- No longer supports the parameter 'OrderBy' and no alias was found for the original parameter name. +- No longer supports the parameter 'Max' and no alias was found for the original parameter name. +- No longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'WorkspaceScope' has been removed. +- The parameter set 'IncidentId' has been removed. +- The parameter set 'ResourceId' has been removed. + +### `Remove-AzSentinelDataConnector` + +- No longer has output type 'PSSentinelDataConnector'. +- No longer supports the type 'PSSentinelDataConnector' for parameter 'InputObject'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'DataConnectorId' has been removed. + +### `New-AzSentinelDataConnector` + +- No longer has output type 'PSSentinelDataConnector'. +- No longer supports the parameter 'DataConnectorId' and no alias was found for the original parameter name. +- No longer supports the parameter 'AzureActiveDirectory' and no alias was found for the original parameter name. +- No longer supports the parameter 'AzureAdvancedThreatProtection' and no alias was found for the original parameter name. +- No longer supports the parameter 'AzureSecurityCenter' and no alias was found for the original parameter name. +- No longer supports the parameter 'AmazonWebServicesCloudTrail' and no alias was found for the original parameter name. +- No longer supports the parameter 'MicrosoftCloudAppSecurity' and no alias was found for the original parameter name. +- No longer supports the parameter 'MicrosoftDefenderAdvancedThreatProtection' and no alias was found for the original parameter name. +- No longer supports the parameter 'Office365' and no alias was found for the original parameter name. +- No longer supports the parameter 'ThreatIntelligence' and no alias was found for the original parameter name. +- No longer supports the parameter 'AwsRoleArn' and no alias was found for the original parameter name. +- No longer supports the parameter 'Logs' and no alias was found for the original parameter name. +- No longer supports the parameter 'DiscoveryLogs' and no alias was found for the original parameter name. +- No longer supports the parameter 'Indicators' and no alias was found for the original parameter name. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'AzureActiveDirectory' has been removed. +- The parameter set 'AzureAdvancedThreatProtection' has been removed. +- The parameter set 'AzureSecurityCenter' has been removed. +- The parameter set 'AmazonWebServicesCloudTrail' has been removed. +- The parameter set 'MicrosoftCloudAppSecurity' has been removed. +- The parameter set 'MicrosoftDefenderAdvancedThreatProtection' has been removed. +- The parameter set 'Office365' has been removed. +- The parameter set 'ThreatIntelligence' has been removed. +- The parameter set '__AllParameterSets' has been removed. + +### `New-AzSentinelAlertRule` + +- No longer has output type 'PSSentinelAlertRule'. +- No longer supports the parameter 'Scheduled' and no alias was found for the original parameter name. +- No longer supports the parameter 'MicrosoftSecurityIncidentCreation' and no alias was found for the original parameter name. +- No longer supports the parameter 'Fusion' and no alias was found for the original parameter name. +- No longer supports the parameter 'AlertRuleId' and no alias was found for the original parameter name. +- No longer supports the type 'System.String' for parameter 'ProductFilter'. +- No longer supports the type 'System.Collections.Generic.IList`1[System.String]' for parameter 'DisplayNamesExcludeFilter'. +- No longer supports the type 'System.Collections.Generic.IList`1[System.String]' for parameter 'DisplayNamesFilter'. +- No longer supports the type 'System.Collections.Generic.IList`1[System.String]' for parameter 'SeveritiesFilter'. +- No longer supports the type 'System.Nullable`1[System.TimeSpan]' for parameter 'QueryFrequency'. +- No longer supports the type 'System.Nullable`1[System.TimeSpan]' for parameter 'QueryPeriod'. +- No longer supports the type 'System.String' for parameter 'Severity'. +- No longer supports the type 'System.Collections.Generic.IList`1[System.String]' for parameter 'Tactic'. +- No longer supports the type 'Microsoft.Azure.Management.SecurityInsights.Models.TriggerOperator' for parameter 'TriggerOperator'. +- No longer supports the type 'System.Nullable`1[System.Int32]' for parameter 'TriggerThreshold'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'FusionAlertRule' has been removed. +- The parameter set 'MicrosoftSecurityIncidentCreationRule' has been removed. +- The parameter set 'ScheduledAlertRule' has been removed. +- The parameter set '__AllParameterSets' has been removed. + +### `Get-AzSentinelAlertRuleTemplate` + +- No longer has output type 'PSSentinelAlertRuleTemplate'. +- No longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'AlertRuleTemplateId' has been removed. +- The parameter set 'ResourceId' has been removed. + +### `Update-AzSentinelIncident` + +- No longer has output type 'PSSentinelIncident'. +- No longer supports the parameter 'IncidentID' and no alias was found for the original parameter name. +- No longer supports the type 'PSSentinelIncident' for parameter 'InputObject'. +- No longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- No longer supports the type 'System.String' for parameter 'Classification'. +- No longer supports the type 'System.String' for parameter 'ClassificationReason'. +- No longer supports the type 'System.Collections.Generic.IList`1[Microsoft.Azure.Commands.SecurityInsights.Models.Incidents.PSSentinelIncidentLabel]' for parameter 'Label'. +- No longer supports the parameter 'Owner' and no alias was found for the original parameter name. +- No longer supports the type 'System.String' for parameter 'Severity'. +- No longer supports the type 'System.String' for parameter 'Status'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'IncidentId' has been removed. +- The parameter set 'InputObject' has been removed. +- The parameter set 'ResourceId' has been removed. +- The parameter set '__AllParameterSets' has been removed. + +### `Get-AzSentinelDataConnector` + +- No longer has output type 'PSSentinelDataConnector'. +- No longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'ResourceId' has been removed. + +### `Update-AzSentinelBookmark` + +- No longer has output type 'PSSentinelBookmark'. +- No longer supports the type 'PSSentinelBookmark' for parameter 'InputObject'. +- No longer supports the parameter 'ResourceId' and no alias was found for the original parameter name. +- No longer supports the parameter 'IncidentInfo' and no alias was found for the original parameter name. +- No longer supports the type 'System.Collections.Generic.IList`1[System.String]' for parameter 'Label'. +- No longer supports the type 'Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzContext' for parameter 'DefaultProfile'. +- No longer supports the alias 'AzureRmContext' for parameter 'DefaultProfile'. +- The parameter set 'BookmarkId.' has been removed. +- The parameter set 'InputObject' has been removed. +- The parameter set 'ResourceId' has been removed. +- The parameter set '__AllParameterSets' has been removed. + +## Az.ServiceBus + +### `Get-AzServiceBusAuthorizationRule` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Queue' has been renamed to 'QueueName'. Parameter 'Topic' has been renamed to 'TopicName'. + +### `Get-AzServiceBusKey` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Queue' has been renamed to 'QueueName'. Parameter 'Topic' has been renamed to 'TopicName'. + +### `New-AzServiceBusAuthorizationRule` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Queue' has been renamed to 'QueueName'. Parameter 'Topic' has been renamed to 'TopicName'. + +### `New-AzServiceBusKey` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Queue' has been renamed to 'QueueName'. Parameter 'Topic' has been renamed to 'TopicName'. + +### `Remove-AzServiceBusAuthorizationRule` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Queue' has been renamed to 'QueueName'. Parameter 'Topic' has been renamed to 'TopicName'. + +### `Set-AzServiceBusAuthorizationRule` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Queue' has been renamed to 'QueueName'. Parameter 'Topic' has been renamed to 'TopicName'. + +### `Test-AzServiceBusName` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Set-AzServiceBusGeoDRConfigurationBreakPair` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Stop-AzServiceBusMigration` + +- Parameter 'Name' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Get-AzServiceBusNetworkRuleSet` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Set-AzServiceBusNetworkRuleSet` + +- Parameter 'Name' has been replaced by 'NamespaceName'. + +### `Get-AzServiceBusQueue` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `New-AzServiceBusQueue` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Set-AzServiceBusQueue` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Remove-AzServiceBusQueue` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Get-AzServiceBusRule` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been renamed to 'TopicName'. Parameter 'Subscription' has been renamed to 'SubscriptionName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `New-AzServiceBusRule` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been renamed to 'TopicName'. Parameter 'Subscription' has been renamed to 'SubscriptionName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Set-AzServiceBusRule` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been renamed to 'TopicName'. Parameter 'Subscription' has been renamed to 'SubscriptionName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Remove-AzServiceBusRule` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been renamed to 'TopicName'. Parameter 'Subscription' has been renamed to 'SubscriptionName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Get-AzServiceBusTopic` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `New-AzServiceBusTopic` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Set-AzServiceBusTopic` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Remove-AzServiceBusTopic` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Get-AzServiceBusSubscription` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been removed to 'TopicName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `New-AzServiceBusSubscription` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been removed to 'TopicName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Set-AzServiceBusSubscription` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been removed to 'TopicName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Remove-AzServiceBusSubscription` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. Parameter 'Topic' has been removed to 'TopicName'. Parameter 'ResourceGroupName' would no longer support alias 'ResourceGroup'. + +### `Get-AzServiceBusGeoDRConfiguration` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Set-AzServiceBusGeoDRConfigurationFailOver` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `New-AzServiceBusGeoDRConfiguration` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Remove-AzServiceBusGeoDRConfiguration` + +- Parameter 'Namespace' has been renamed to 'NamespaceName'. + +### `Start-AzServiceBusMigration` + +- Parameter 'Name' has been replaced by 'NamespaceName'. + +### `Get-AzServiceBusMigration` + +- Parameter 'Name' has been replaced by 'NamespaceName'. + +### `Complete-AzServiceBusMigration` + +- Parameter 'Name' has been replaced by 'NamespaceName'. + +### `Remove-AzServiceBusMigration` + +- Parameter 'Name' has been replaced by 'NamespaceName'. + +## Az.Sql + +### `Update-AzSqlServerAdvancedThreatProtectionSetting` + +- No longer has output type 'Microsoft.Azure.Commands.Sql.ThreatDetection.Model.ServerThreatDetectionPolicyModel'. +- No longer supports the parameter 'NotificationRecipientsEmails' and no alias was found for the original parameter name. +- No longer supports the parameter 'EmailAdmins' and no alias was found for the original parameter name. +- No longer supports the parameter 'ExcludedDetectionType' and no alias was found for the original parameter name. +- No longer supports the parameter 'StorageAccountName' and no alias was found for the original parameter name. +- No longer supports the parameter 'RetentionInDays' and no alias was found for the original parameter name. +- The parameter set '__AllParameterSets' has been removed. + +### `Get-AzSqlServerAdvancedThreatProtectionSetting` + +- No longer has output type 'Microsoft.Azure.Commands.Sql.ThreatDetection.Model.ServerThreatDetectionPolicyModel'. + +### `Clear-AzSqlDatabaseAdvancedThreatProtectionSetting` + +- Has been removed and no alias was found for the original cmdlet name. + +### `Update-AzSqlDatabaseAdvancedThreatProtectionSetting` + +- No longer has output type 'Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel'. +- No longer supports the parameter 'NotificationRecipientsEmails' and no alias was found for the original parameter name. +- No longer supports the parameter 'EmailAdmins' and no alias was found for the original parameter name. +- No longer supports the parameter 'ExcludedDetectionType' and no alias was found for the original parameter name. +- No longer supports the parameter 'StorageAccountName' and no alias was found for the original parameter name. +- No longer supports the parameter 'RetentionInDays' and no alias was found for the original parameter name. +- The parameter set '__AllParameterSets' has been removed. + +### `Clear-AzSqlServerAdvancedThreatProtectionSetting` + +- Has been removed and no alias was found for the original cmdlet name. + +### `Disable-AzSqlServerAdvancedDataSecurity` + +- No longer supports the alias 'Disable-AzSqlServerAdvancedThreatProtection'. + +### `Get-AzSqlDatabaseAdvancedThreatProtectionSetting` + +- No longer has output type 'Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel'. + +### `Enable-AzSqlServerAdvancedDataSecurity` + +- No longer supports the alias 'Enable-AzSqlServerAdvancedThreatProtection'. + +## Az.Storage + +### `Get-AzStorageFileCopyState` + +- No longer has output type 'Microsoft.Azure.Storage.File.CopyState'. + +## Az.Synapse + +### `Get-AzSynapseLinkConnectionLinkTableStatus` + +- The type of property 'Properties' of type 'PSLinkConnectionResource' has changed from 'Azure.Analytics.Synapse.Artifacts.Models.LinkConnection' to 'PSLinkConnection'. + +### `Remove-AzSynapseLinkConnection` + +- The type of property 'Properties' of type 'PSLinkConnectionResource' has changed from 'Azure.Analytics.Synapse.Artifacts.Models.LinkConnection' to 'PSLinkConnection'. + +### `Update-AzSynapseLinkConnectionLandingZoneCredential` + +- The type of property 'Properties' of type 'PSLinkConnectionResource' has changed from 'Azure.Analytics.Synapse.Artifacts.Models.LinkConnection' to 'PSLinkConnection'. + +### `Get-AzSynapseLinkConnectionLinkTable` + +- The type of property 'Properties' of type 'PSLinkConnectionResource' has changed from 'Azure.Analytics.Synapse.Artifacts.Models.LinkConnection' to 'PSLinkConnection'. + +### `Stop-AzSynapseLinkConnection` + +- The type of property 'Properties' of type 'PSLinkConnectionResource' has changed from 'Azure.Analytics.Synapse.Artifacts.Models.LinkConnection' to 'PSLinkConnection'. + +### `Set-AzSynapseLinkConnection` + +- The type of property 'Properties' of type 'PSLinkConnectionResource' has changed from 'Azure.Analytics.Synapse.Artifacts.Models.LinkConnection' to 'PSLinkConnection'. + +### `Get-AzSynapseLinkConnection` + +- The type of property 'Properties' of type 'PSLinkConnectionResource' has changed from 'Azure.Analytics.Synapse.Artifacts.Models.LinkConnection' to 'PSLinkConnection'. + +### `Start-AzSynapseLinkConnection` + +- The type of property 'Properties' of type 'PSLinkConnectionResource' has changed from 'Azure.Analytics.Synapse.Artifacts.Models.LinkConnection' to 'PSLinkConnection'. + +### `Set-AzSynapseLinkConnectionLinkTable` + +- The type of property 'Properties' of type 'PSLinkConnectionResource' has changed from 'Azure.Analytics.Synapse.Artifacts.Models.LinkConnection' to 'PSLinkConnection'. diff --git a/docs-conceptual/azps-10.1.0/migrate-from-azurerm-to-az.md b/docs-conceptual/azps-10.1.0/migrate-from-azurerm-to-az.md new file mode 100644 index 0000000000..b4dd3813cc --- /dev/null +++ b/docs-conceptual/azps-10.1.0/migrate-from-azurerm-to-az.md @@ -0,0 +1,128 @@ +--- +description: Learn the steps and tools for migrating Azure PowerShell scripts from AzureRM to the new Az PowerShell module. +ms.custom: devx-track-azurepowershell, contperf-fy21q2 +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Migrate Azure PowerShell scripts from AzureRM to Az +--- + +# Migrate Azure PowerShell from AzureRM to Az + +All versions of the AzureRM PowerShell module are outdated. The [Az PowerShell +module](install-azure-powershell.md) is now the recommended PowerShell module for interacting with Azure. + +[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] + +## Why a new module? + +The biggest and most important change is that [PowerShell](/powershell/scripting/overview), being +based on the .NET Standard library, has been a cross-platform product since its introduction. + +Like the PowerShell language, we're committed to bringing Azure support to all platforms. Our +commitment meant that the Azure PowerShell modules needed to be updated to use .NET Standard and be +compatible with PowerShell Core. Rather than modifying the existing AzureRM module and introducing +complex changes to add this support, the Az module was created. + +Creating a new module also allowed our engineers to make the design, naming of cmdlets, and modules +consistent. All modules now start with the `Az.` prefix and cmdlets all use the `Verb-AzNoun` naming +convention. Previously, cmdlet names were longer and inconsistent. + +The number of modules were also reduced: Some modules that worked with the same services have been +combined. Management plane and data plane cmdlets for the same service are now contained within a +single module. For those of you who manually manage dependencies and imports, this consolidation +makes things much simpler. + +By making these important changes, the team has committed to making it easier than ever before and +on more platforms than previously possible to use Azure with PowerShell cmdlets. + +## Upgrading to Az PowerShell + +Scripts written for the AzureRM cmdlets won't automatically work with Az. To make the +transition easier, the +[AzureRM to Az migration toolkit](https://github.com/Azure/azure-powershell-migration) was +developed. No migration to a new command set is ever convenient, but this article will help you get +started on transitioning to the Az PowerShell module. To learn more about why the Az PowerShell +module was created, see [Introducing the new Azure PowerShell Az module](new-azureps-module-az.md). + +The new cmdlet names have been designed to be easy to learn. Instead of using `AzureRm` or `Azure` +in cmdlet names, use `Az`. For example, the old cmdlet `New-AzureRMVm` has become `New-AzVm`. +However, migration is more than becoming familiar with the new cmdlet names, though. There are +renamed modules, parameters, and other important changes. + +To see the full list of breaking changes between AzureRM and Az, see the +[full changes from AzureRM to Az](migrate-az-1.0.0.md). + +## Ensure existing scripts work with the latest AzureRM release + +Before taking any migration steps, determine what versions of AzureRM are installed on your system. +Doing so allows you to make sure scripts are already running on the latest release and let you know +what versions of AzureRM must be uninstalled. + +To determine what versions of AzureRM you have installed, run the following example: + +```powershell +Get-Module -Name AzureRM -ListAvailable -All +``` + +The **latest** available release of AzureRM is **6.13.2**. If you don't have this version installed, +your existing scripts may need additional modifications to work with the Az module beyond the scope +of what's described in this article and in the [breaking changes list](migrate-az-1.0.0.md). + +If your scripts don't work with AzureRM 6.13.2, update them according to the +[AzureRM 5.x to 6.x migration guide](/powershell/azure/azurerm/migration-guide.6.0.0). If you use an +earlier version of the AzureRM module, there are migration guides available for each major version. + +## Option 1 (recommended): Automatically migrate your PowerShell scripts + +This recommended option minimizes the effort required to migrate AzureRM scripts to Az. + +### Install the AzureRM to Az migration toolkit + +```powershell +Install-Module -Name Az.Tools.Migration +``` + +### Convert your scripts automatically + +With the AzureRM to Az migration toolkit, you can generate a plan to determine what changes will be +performed on your scripts before making any modifications to them and before installing the Az +PowerShell module. + +The [Automatically migrate PowerShell scripts from AzureRM to the Az PowerShell module](quickstart-migrate-azurerm-to-az-automatically.md) quickstart walks you through the entire process +of automatically updating your PowerShell scripts from AzureRM to the Az PowerShell module. + +## Option 2: Use compatibility mode with Enable-AzureRmAlias + +The Az module has a compatibility mode to help you use existing scripts while you update to the new +syntax. The [Enable-AzureRmAlias](/powershell/module/az.accounts/enable-azurermalias) cmdlet enables +a compatibility mode through aliases. This mode allows you to use existing scripts with minimal +modification while working towards a full migration to Az. By default, `Enable-AzureRmAlias` only +enables compatibility aliases for the current PowerShell session. Use its `Scope` parameter to +persist compatibility aliases across PowerShell sessions. For more information, see +[the Enable-AzureRmAlias reference documentation](/powershell/module/az.accounts/enable-azurermalias). + +> [!IMPORTANT] +> Even though the cmdlet names are aliased, there may still be new (or renamed) parameters or +> changed return values for the Az cmdlets. Don't expect enabling aliases to take care of the +> migration for you. See the [full breaking changes list](migrate-az-1.0.0.md) to find where your +> scripts may require updates. + +## Option 3: Migrate your scripts in Visual Studio Code with the Azure PowerShell extension + +### Install the Azure PowerShell extension for Visual Studio Code + +Install the [Azure PowerShell extension for VSCode](https://marketplace.visualstudio.com/items?itemName=azps-tools.azps-tools) + +### Convert your scripts manually + +1. Load your AzureRM script in VSCode +1. Start the migration by opening the command palette `Ctrl+Shift+P` and select `Migrate Azure PowerShell script` +1. Select source version `AzureRM` +1. Follow the recommended actions for each underlined command or parameter. + +## Next steps + +- [Uninstall AzureRM](uninstall-az-ps.md#uninstall-the-azurerm-module) +- [Install Azure PowerShell](install-azure-powershell.md) diff --git a/docs-conceptual/azps-10.1.0/new-azureps-module-az.md b/docs-conceptual/azps-10.1.0/new-azureps-module-az.md new file mode 100644 index 0000000000..d9a380ea6f --- /dev/null +++ b/docs-conceptual/azps-10.1.0/new-azureps-module-az.md @@ -0,0 +1,118 @@ +--- +description: Introducing the Az PowerShell module, recommended for interacting with Azure, and the replacement for the AzureRM PowerShell module. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Introducing the Azure Az PowerShell module +--- + +# Introducing the Azure Az PowerShell module + +## Overview + +The Az PowerShell module is a set of cmdlets for managing Azure resources directly from PowerShell. +PowerShell provides powerful features for automation that can be leveraged for managing your Azure +resources, for example in the context of a CI/CD pipeline. + +The Az PowerShell module is the replacement of AzureRM and is the recommended version to use for +interacting with Azure. + +[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] + +You can use the Az PowerShell module with one of the following methods: + +- [Install the Az PowerShell module via PowerShellGet](install-azure-powershell.md) (recommended option). +- [Install the Az PowerShell module with MSI](install-azure-powershell.md). +- [Use Azure Cloud Shell](/azure/cloud-shell/overview). +- [Use the Az PowerShell Docker container](azureps-in-docker.md). + +## Features + +The Az PowerShell module features the following benefits: + +- Security and stability + - Token cache encryption + - Prevention of man-in-the-middle attack type + - Support authentication with ADFS 2019 + - Username and password authentication in PowerShell 7 + - Support for features like continuous access evaluation +- Support for all Azure services + - All generally available Azure services have a corresponding supported PowerShell module + - Multiple bug fixes and API version upgrades since AzureRM +- New capabilities + - Support in Cloud Shell and cross-platform + - Can get and use access token to access Azure resources + - Cmdlet available for advanced REST operations with Azure resources + +> [!NOTE] +> PowerShell 7.0.6 LTS, PowerShell 7.1.3, or higher is the recommended version of PowerShell for +> use with the Azure Az PowerShell module on all platforms. + +The Az PowerShell module is based on the .NET Standard library and works with PowerShell 7 and later +on all platforms including Windows, Linux, and macOS. It's also compatible with Windows PowerShell +5.1. + +We're committed to bringing Azure support to all platforms and all Az PowerShell modules are +cross-platforms. + +## Upgrade your environment to Az + +To keep up with the latest Azure features in PowerShell, you should migrate to the Az module. If +you're not ready to install the Az module as a replacement for AzureRM, you have a couple of options +available to experiment with Az: + +- Use a `PowerShell` environment with [Azure Cloud Shell](/azure/cloud-shell/overview). Azure Cloud + Shell is a browser-based shell environment that comes with the Az module installed and + `Enable-AzureRM` compatibility aliases enabled. +- Keep the AzureRM module installed in Windows PowerShell 5.1 and install the Az module in + PowerShell 7 or later. Windows PowerShell 5.1 and PowerShell 7 and later use separate + collections of modules. Follow the instructions to install the + [latest version of PowerShell](/powershell/scripting/install/installing-powershell) and then + [install the Az module](install-azure-powershell.md) from PowerShell 7 or later. + +To upgrade from an existing AzureRM install: + +1. [Uninstall the Azure PowerShell AzureRM module](/powershell/azure/uninstall-az-ps#uninstall-the-azurerm-module) +1. [Install the Azure PowerShell Az module](install-azure-powershell.md) +1. **OPTIONAL**: Enable compatibility mode to add aliases for AzureRM cmdlets with + [Enable-AzureRMAlias](/powershell/module/az.accounts/enable-azurermalias) while you become + familiar with the new command set. For more information, see the next section or + [Start migration from AzureRM to Az](migrate-from-azurerm-to-az.md). + +## Migrate existing scripts from AzureRM to Az + +If your scripts are still based on the AzureRM module, we have several resources to help you with +the migration: + +- [Get started with migration from AzureRM to Az](migrate-from-azurerm-to-az.md) +- [Full list of breaking changes from AzureRM to Az 1.0.0](migrate-az-1.0.0.md) +- The [Enable-AzureRmAlias](/powershell/module/az.accounts/enable-azurermalias) cmdlet + +## Supportability + +Az is the most current PowerShell module for Azure. Issues or feature requests can be logged +directly on the [GitHub repository](https://github.com/Azure/azure-powershell), or via Microsoft +support if you have a support contract. Feature requests are implemented in the latest version of +Az. Critical issues are implemented on the last two versions of Az. + +Because Az PowerShell modules now have all the capabilities of AzureRM PowerShell modules and more, +we'll retire AzureRM PowerShell modules on February 29, 2024. + +To avoid service interruptions, [update your scripts](https://aka.ms/azpsmigrate) that use AzureRM +PowerShell modules to use Az PowerShell modules by February 29, 2024. To automatically update your +scripts, follow the +[quickstart guide](/powershell/azure/quickstart-migrate-azurerm-to-az-automatically). + +## Data collection + +Azure PowerShell collects telemetry data by default. Microsoft aggregates collected data to identify +patterns of usage to identify common issues and to improve the experience of Azure PowerShell. +Microsoft Azure PowerShell doesn't collect any private or personal data. For example, the usage +data helps identify issues such as cmdlets with low success and helps prioritize our work. + +While we appreciate the insights this data provides, we also understand that not everyone wants to +send usage data. You can disable data collection with the +[`Disable-AzDataCollection`](/powershell/module/az.accounts/disable-azdatacollection) cmdlet. You +can also read our [privacy statement](https://privacy.microsoft.com/privacystatement) to learn more. diff --git a/docs-conceptual/azps-10.1.0/queries-azureps.md b/docs-conceptual/azps-10.1.0/queries-azureps.md new file mode 100644 index 0000000000..883f241722 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/queries-azureps.md @@ -0,0 +1,135 @@ +--- +description: How to query for resources in Azure and format the results. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Query output of Azure PowerShell cmdlets +--- + +# Query output of Azure PowerShell + +The results of each Azure PowerShell cmdlet are an Azure PowerShell object. Even cmdlets that aren't +explicitly `Get-` operations might return a value that can be inspected, to give information about a +resource that was created or modified. While most cmdlets return a single object, some return an +array that should be iterated through. + +Usually, you query output from Azure PowerShell with the +[Select-Object](/powershell/module/Microsoft.PowerShell.Utility/Select-Object) cmdlet. Output can be +filtered with [Where-Object](/powershell/module/Microsoft.PowerShell.Core/Where-Object). + +## Select simple properties + +In the default table format, Azure PowerShell cmdlets don't display all their available properties. +You can get the full properties using the +[Format-List](/powershell/module/microsoft.powershell.utility/format-list) cmdlet, or by piping +output to `Select-Object -Property *`: + +```azurepowershell-interactive +Get-AzVM -Name TestVM -ResourceGroupName TestGroup | + Select-Object -Property * +``` + +```Output +ResourceGroupName : TESTGROUP +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TESTGROUP/providers/Micro + soft.Compute/virtualMachines/TestVM +VmId : 00000000-0000-0000-0000-000000000000 +Name : TestVM +Type : Microsoft.Compute/virtualMachines +Location : westus2 +LicenseType : +Tags : {} +AvailabilitySetReference : +DiagnosticsProfile : +Extensions : {} +HardwareProfile : Microsoft.Azure.Management.Compute.Models.HardwareProfile +InstanceView : +NetworkProfile : Microsoft.Azure.Management.Compute.Models.NetworkProfile +OSProfile : Microsoft.Azure.Management.Compute.Models.OSProfile +Plan : +ProvisioningState : Succeeded +StorageProfile : Microsoft.Azure.Management.Compute.Models.StorageProfile +DisplayHint : Compact +Identity : +Zones : {} +FullyQualifiedDomainName : +AdditionalCapabilities : +RequestId : 00000000-0000-0000-0000-000000000000 +StatusCode : OK +``` + +Once you know the names of the properties that you're interested in, you can use those property +names with `Select-Object` to get them directly: + +```azurepowershell-interactive +Get-AzVM -Name TestVM -ResourceGroupName TestGroup | + Select-Object -Property Name, VmId, ProvisioningState +``` + +```Output +Name VmId ProvisioningState +---- ---- ----------------- +TestVM 00000000-0000-0000-0000-000000000000 Succeeded +``` + +Output from using `Select-Object` is always formatted to display the requested information. To learn +about using formatting as part of querying cmdlet results, see +[Format Azure PowerShell cmdlet output](formatting-output.md). + +## Select nested properties + +Some properties in Azure PowerShell cmdlet output use nested objects, like the `StorageProfile` +property of `Get-AzVM` output. To get a value from a nested property, provide a display name and the +full path to the value you want to inspect as part of a dictionary argument to `Select-Object`: + +```azurepowershell-interactive +Get-AzVM -ResourceGroupName TestGroup | + Select-Object -Property Name, @{label='OSType'; expression={$_.StorageProfile.OSDisk.OSType}} +``` + +```Output +Name OSType +---- ------ +TestVM Linux +TestVM2 Linux +WinVM Windows +``` + +Each dictionary argument selects one property from the object. The property to extract must be part +of an expression. + +## Filter results + +The `Where-Object` cmdlet allows you to filter the result based on any property value, including +nested properties. The next example shows how to use `Where-Object` to find the Linux VMs in a +resource group. + +```azurepowershell-interactive +Get-AzVM -ResourceGroupName TestGroup | + Where-Object {$_.StorageProfile.OSDisk.OSType -eq 'Linux'} +``` + +```Output +ResourceGroupName Name Location VmSize OsType NIC ProvisioningState Zone +----------------- ---- -------- ------ ------ --- ----------------- ---- +TestGroup TestVM westus2 Standard_D2s_v3 Linux testvm299 Succeeded +TestGroup TestVM2 westus2 Standard_D2s_v3 Linux testvm2669 Succeeded +``` + +You can pipe the results of `Select-Object` and `Where-Object` to each other. For performance +purposes, it's always recommended to put the `Where-Object` operation before `Select-Object`: + +```azurepowershell-interactive +Get-AzVM -ResourceGroupName TestGroup | + Where-Object {$_.StorageProfile.OsDisk.OsType -eq 'Linux'} | + Select-Object -Property Name, VmID, ProvisioningState +``` + +```Output +Name VmId ProvisioningState +---- ---- ----------------- +TestVM 00000000-0000-0000-0000-000000000000 Succeeded +TestVM2 00000000-0000-0000-0000-000000000000 Succeeded +``` diff --git a/docs-conceptual/azps-10.1.0/quickstart-migrate-azurerm-to-az-automatically.md b/docs-conceptual/azps-10.1.0/quickstart-migrate-azurerm-to-az-automatically.md new file mode 100644 index 0000000000..51ad25eaf4 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/quickstart-migrate-azurerm-to-az-automatically.md @@ -0,0 +1,191 @@ +--- +author: mikefrobbins +description: Learn how to automatically migrate PowerShell scripts from AzureRM to the Az PowerShell module. +ms.author: mirobb +ms.custom: devx-track-azurepowershell, mode-api +ms.date: 06/30/2023 +ms.service: azure-powershell +ms.topic: quickstart +title: Automatically migrate PowerShell scripts from AzureRM to the Az PowerShell module +--- + +# Quickstart: Automatically migrate PowerShell scripts from AzureRM to the Az PowerShell module + +In this article, you'll learn how to use the Az.Tools.Migration PowerShell module to automatically +upgrade your PowerShell scripts and script modules from AzureRM to the Az PowerShell module. For +additional migration options, see +[Migrate Azure PowerShell from AzureRM to Az](/powershell/azure/migrate-from-azurerm-to-az). + +[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] + +## Requirements + +- Update your existing PowerShell scripts to the latest version of the + [AzureRM PowerShell module (6.13.1)](https://www.powershellgallery.com/packages/AzureRM/). +- Install the Az.Tools.Migration PowerShell module. + + ```powershell + Install-Module -Name Az.Tools.Migration + ``` + +## Step 1: Generate an upgrade plan + +You use the **`New-AzUpgradeModulePlan`** cmdlet to generate an upgrade plan for migrating your +scripts and modules to the Az PowerShell module. This cmdlet doesn’t make any changes to your +existing scripts. Use the **`FilePath`** parameter for targeting a specific script or the +**`DirectoryPath`** parameter for targeting all scripts in a specific folder. + +> [!NOTE] +> The **`New-AzUpgradeModulePlan`** cmdlet doesn't execute the plan, it only generates the upgrade steps. + +The following example generates a plan for all the scripts in the _`C:\Scripts`_ folder. The +**`OutVariable`** parameter is specified so the results are returned and simultaneously stored in a +variable named **`Plan`**. + +```powershell +# Generate an upgrade plan for all the scripts and module files in the specified folder and save it to a variable. +New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion 8.0.0 -DirectoryPath 'C:\Scripts' -OutVariable Plan +``` + +As shown in the following output, the upgrade plan details the specific file and offset points that +require changes when moving from AzureRM to the Az PowerShell cmdlets. + +```Output +Order Location UpgradeType PlanResult Original +----- -------- ----------- ---------- -------- +1 compute-create-dockerhost.ps1:59:24 CmdletParameter ReadyToUpgrade ExtensionName +2 compute-create-dockerhost.ps1:59:1 Cmdlet ReadyToUpgrade Set-AzureRmVM... +3 compute-create-dockerhost.ps1:54:1 Cmdlet ReadyToUpgrade New-AzureRmVM +4 compute-create-dockerhost.ps1:51:1 Cmdlet ReadyToUpgrade Add-AzureRmVM... +5 compute-create-dockerhost.ps1:47:1 Cmdlet ReadyToUpgrade Add-AzureRmVM... +6 compute-create-dockerhost.ps1:46:1 Cmdlet ReadyToUpgrade Set-AzureRmVM... +7 compute-create-dockerhost.ps1:45:1 Cmdlet ReadyToUpgrade Set-AzureRmVM... +8 compute-create-dockerhost.ps1:44:13 Cmdlet ReadyToUpgrade New-AzureRmVM... +9 compute-create-dockerhost.ps1:40:8 Cmdlet ReadyToUpgrade New-AzureRmNe... +10 compute-create-dockerhost.ps1:36:8 Cmdlet ReadyToUpgrade New-AzureRmNe... +11 compute-create-dockerhost.ps1:31:16 Cmdlet ReadyToUpgrade New-AzureRmNe... +12 compute-create-dockerhost.ps1:26:15 Cmdlet ReadyToUpgrade New-AzureRmNe... +13 compute-create-dockerhost.ps1:22:8 Cmdlet ReadyToUpgrade New-AzureRmPu... +14 compute-create-dockerhost.ps1:18:9 Cmdlet ReadyToUpgrade New-AzureRmVi... +15 compute-create-dockerhost.ps1:15:17 Cmdlet ReadyToUpgrade New-AzureRmVi... +16 compute-create-dockerhost.ps1:12:1 Cmdlet ReadyToUpgrade New-AzureRmRe... +17 compute-create-windowsvm-quick.ps1:18:3 CmdletParameter ReadyToUpgrade ImageName +18 compute-create-windowsvm-quick.ps1:14:1 Cmdlet ReadyToUpgrade New-AzureRmVM +19 compute-create-windowsvm-quick.ps1:11:1 Cmdlet ReadyToUpgrade New-AzureRmRe... +20 compute-create-wordpress-mysql.ps1:59:24 CmdletParameter ReadyToUpgrade ExtensionName +... +``` + +Before performing the upgrade, you need to view the results of the plan for problems. The following +example returns a list of scripts and the items in those scripts that will prevent them from being +upgraded automatically. + +```powershell +# Filter plan results to only warnings and errors +$Plan | Where-Object PlanResult -ne ReadyToUpgrade | Format-List +``` + +The items shown in the following output won't be upgraded automatically without manually correcting +the issues first. + +```Output +Order : 42 +UpgradeType : CmdletParameter +PlanResult : ErrorParameterNotFound +PlanSeverity : Error +PlanResultReason : Parameter was not found in Get-AzResource or it's aliases. +SourceCommand : CommandReference +SourceCommandParameter : CommandReferenceParameter +Location : devtestlab-add-marketplace-image-to-lab.ps1:14:74 +FullPath : C:\Scripts\devtestlab-add-marketplace-image-to-lab.ps1 +StartOffset : 556 +Original : ResourceNameEquals +Replacement : +``` + +## Step 2: Perform the upgrade + +> [!CAUTION] +> There is no undo operation. Always ensure that you have a backup copy of your PowerShell scripts +> and modules that you're attempting to upgrade. + +After you’re satisfied with the plan, the upgrade is performed with the +**`Invoke-AzUpgradeModulePlan`** cmdlet. Specify **`SaveChangesToNewFiles`** for the +**`FileEditMode`** parameter value to prevent changes from being made to your original scripts. When +using this mode, the upgrade is performed by creating a copy of each script targeted with +_`_az_upgraded`_ appended to the filenames. + +> [!WARNING] +> The **`Invoke-AzUpgradeModulePlan`** cmdlet is destructive when the +> **`-FileEditMode ModifyExistingFiles`** option is specified! It modifies your scripts and +> functions in place according to the module upgrade plan generated by the +> **`New-AzUpgradeModulePlan`** cmdlet. For the non-destructive option specify +> **`-FileEditMode SaveChangesToNewFiles`** instead. + +```powershell +# Execute the automatic upgrade plan and save the results to a variable. +Invoke-AzUpgradeModulePlan -Plan $Plan -FileEditMode SaveChangesToNewFiles -OutVariable Results +``` + +```Output +Order Location UpgradeType UpgradeResult Original +----- -------- ----------- ------------- -------- +1 compute-create-dockerhost.ps1:59:24 CmdletParameter UpgradeCompleted ExtensionName +2 compute-create-dockerhost.ps1:59:1 Cmdlet UpgradeCompleted Set-AzureRmVMExtens... +3 compute-create-dockerhost.ps1:54:1 Cmdlet UpgradeCompleted New-AzureRmVM +4 compute-create-dockerhost.ps1:51:1 Cmdlet UpgradeCompleted Add-AzureRmVMSshPub... +5 compute-create-dockerhost.ps1:47:1 Cmdlet UpgradeCompleted Add-AzureRmVMNetwor... +6 compute-create-dockerhost.ps1:46:1 Cmdlet UpgradeCompleted Set-AzureRmVMSource... +7 compute-create-dockerhost.ps1:45:1 Cmdlet UpgradeCompleted Set-AzureRmVMOperat... +8 compute-create-dockerhost.ps1:44:13 Cmdlet UpgradeCompleted New-AzureRmVMConfig +9 compute-create-dockerhost.ps1:40:8 Cmdlet UpgradeCompleted New-AzureRmNetworkI... +10 compute-create-dockerhost.ps1:36:8 Cmdlet UpgradeCompleted New-AzureRmNetworkS... +11 compute-create-dockerhost.ps1:31:16 Cmdlet UpgradeCompleted New-AzureRmNetworkS... +12 compute-create-dockerhost.ps1:26:15 Cmdlet UpgradeCompleted New-AzureRmNetworkS... +13 compute-create-dockerhost.ps1:22:8 Cmdlet UpgradeCompleted New-AzureRmPublicIp... +14 compute-create-dockerhost.ps1:18:9 Cmdlet UpgradeCompleted New-AzureRmVirtualN... +15 compute-create-dockerhost.ps1:15:17 Cmdlet UpgradeCompleted New-AzureRmVirtualN... +16 compute-create-dockerhost.ps1:12:1 Cmdlet UpgradeCompleted New-AzureRmResource... +17 compute-create-windowsvm-quick.ps1:18:3 CmdletParameter UpgradeCompleted ImageName +18 compute-create-windowsvm-quick.ps1:14:1 Cmdlet UpgradeCompleted New-AzureRmVM +19 compute-create-windowsvm-quick.ps1:11:1 Cmdlet UpgradeCompleted New-AzureRmResource... +20 compute-create-wordpress-mysql.ps1:59:24 CmdletParameter UpgradeCompleted ExtensionName +... +``` + +If any errors are returned, you can take a closer look at the error results with the following command: + +```powershell +# Filter results to show only errors +$Results | Where-Object UpgradeResult -ne UpgradeCompleted | Format-List +``` + +```Output +Order : 42 +UpgradeType : CmdletParameter +UpgradeResult : UnableToUpgrade +UpgradeSeverity : Error +UpgradeResultReason : Parameter was not found in Get-AzResource or it's aliases. +SourceCommand : CommandReference +SourceCommandParameter : CommandReferenceParameter +Location : devtestlab-add-marketplace-image-to-lab.ps1:14:74 +FullPath : C:\Scripts\devtestlab-add-marketplace-image-to-lab.ps1 +StartOffset : 556 +Original : ResourceNameEquals +Replacement : +``` + +## Limitations + +- File I/O operations use default encoding. Unusual file encoding situations may cause problems. +- AzureRM cmdlets passed as arguments to Pester unit test mock statements aren't detected. + +## How to report issues + +Report feedback and issues about the Az.Tools.Migration PowerShell module via +[a GitHub issue](https://github.com/Azure/azure-powershell-migration/issues) in the +`azure-powershell-migration` repository. + +## Next steps + +To learn more about the Az PowerShell module, see the [Azure PowerShell documentation](/powershell/azure/) diff --git a/docs-conceptual/azps-10.1.0/release-notes-azureps.md b/docs-conceptual/azps-10.1.0/release-notes-azureps.md new file mode 100644 index 0000000000..4783824544 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/release-notes-azureps.md @@ -0,0 +1,8080 @@ +--- +description: Learn about all of the latest updates to the Azure PowerShell modules. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Azure PowerShell release notes +--- +# Azure PowerShell release notes +## 10.1.0 - July 2023 +#### Az.Accounts 2.12.4 +* Changed 'gallery' property to be optional in ARM metadata of 'Set-AzEnvironment' and 'Add-AzEnvironment'[#22037]. + +#### Az.Aks 5.5.1 +* Fixed the issue of handling 'nextLink' in 'Set-AzAksCluster'. [#21846] +* Fixed the issue of parameter 'AcrNameToDetach' in 'Set-AzAksCluster' due to role assignment name is a guid. +* Added breaking change message for parameter 'DockerBridgeCidr' in 'New-AzAksCluster'. +* Supported the value 'AzureLinux' for parameter '-NodeOsSKU' in 'New-AzAksCluster' and parameter '-OsSKU' in 'New-AzAksNodePool'. +* Fixed the issue of '-DisableLocalAccount' for 'Set-AzAksCluster'. [#21835] + +#### Az.Billing 2.0.3 +* Fixed page continuation for Consumption PriceSheet cmdlet + +#### Az.Cdn 3.1.0 +* Upgraded API version to 2023-05-01 +* Fixed known issue for 'Update-AzCdnProfile', 'Update-AzFrontDoorCdnProfile', 'Remove-AzCdnProfile', 'Remove-AzCdnProfile' + +#### Az.CognitiveServices 1.14.0 +* Updated CognitiveServices PowerShell to use 2023-05-01 version. + +#### Az.Compute 6.1.0 +* Added useful examples to the 'New-AzVMConfig' help doc. +* Added new 'ResourceId' parameter to the 'Get-AzVmss' cmdlet. +* Added '-SecurityType', '-EnableSecureBoot' and '-EnableVtpm' parameters to 'New-AzVm','New-AzVmConfig', 'New-AzVmss', 'New-AzVmssConfig', 'Update-AzVm' and 'Update-AzVmss' cmdlets. +* Configured parameter flags '-EnableSecureBoot' and '-EnableVtpm' to default to True for TrustedLaunch and ConfidentialVM values for the '-SecurityType' parameter in 'New-AzVm','New-AzVmConfig', 'New-AzVmss', 'New-AzVmssConfig', 'Update-AzVm' and 'Update-AzVmss' cmdlets. +* Added a message to the user when they provide an outdated image alias to 'New-AzVM' via the '-Image' parameter or to 'New-AzVmss' via the '-ImageName' parameter. + The non-versioned image aliases were updated to versioned values in October 2023, and this message is to help urge customers to use the newer versioned image alias values. +* Changed the installation behavior for the 'GuestAttestation' extension in 'New-AzVM' and 'New-AzVmss' to set the property 'EnableAutomaticUpgrade' to true. +* Changed to 'Set-AzVMOperatingSystem' to correct unnecessary mandatory parameters. + +#### Az.CosmosDB 1.11.1 +* Locations showed in response included status, isSubscriptionRegionAccessAllowedForRegular and isSubscriptionRegionAccessAllowedForAz properties + +#### Az.Databricks 1.6.0 +* Added some parameters in the 'New-AzDatabricksWorkspace' and 'Update-AzDatabricksWorkspace'. + - 'ManagedDiskKeyVaultPropertiesKeyName' + - 'ManagedDiskKeyVaultPropertiesKeyVaultUri' + - 'ManagedDiskKeyVaultPropertiesKeyVersion' + - 'ManagedDiskRotationToLatestKeyVersionEnabled' + - 'ManagedServicesKeyVaultPropertiesKeyName' + - 'ManagedServicesKeyVaultPropertiesKeyVaultUri' + - 'ManagedServicesKeyVaultPropertiesKeyVersion' + - 'Authorization' + - 'UiDefinitionUri' +* Added some parameters in the 'Update-AzDatabricksVNetPeering'. + - 'DatabricksAddressSpacePrefix' + - 'DatabricksVirtualNetworkId' + - 'RemoteAddressSpacePrefix' + - 'RemoteVirtualNetworkId' + +#### Az.Migrate 2.2.0 +* Fixed key vault SPN Id coming as null for some users +* Added support for Windows Server OS upgrade while migrating the server to Azure using Azure Migrate +* Updated OsUpgradeVersion parameter for Azure Migrate + +#### Az.MySql 1.1.1 +* Fixed iops and high availability parameters issue + +#### Az.Network 6.1.0 +* Added new cmdlets to get Connection child resource of Network Virtual Appliance. + -'Get-AzNetworkVirtualApplianceConnection' +* Updated cmdlets to return connections in Network Virtual Appliance + -'Network Virtual Appliance' +* Allowed not to provide 'Rules' in 'PSApplicationGatewayFirewallPolicyManagedRuleGroupOverride', which would return an empty 'RuleID' to be passed to NRP. +* Added optional parameter 'AdminState' to Express Route Virtual Network Gateway +* Fixed bug that caused 'Remove-AzApplicationGatewayAutoscaleConfiguration' to always fails +* Added read-only property 'DefaultPredefinedSslPolicy' in PSApplicationGateway +* Updated cmdlet to added optional parameter 'DomainNameLabelScope' to Public Ip Address + - 'New-AzPublicIpAddress' +* Fixed bug where HubRoutingPreference didn't show up when running 'Get-AzRouteServer' +* Updated 'New-AzVirtualNetworkGateway' to remove validation for 'ExtendedLocation' parameter + +#### Az.RecoveryServices 6.5.0 +* Added CRR support for new regions malaysiasouth, chinanorth3, chinaeast3, jioindiacentral, jioindiawest. +* Regenerated CRR SDK. Fixed issues with SQL CRR. +* Fixed bug with rp expiry time, making 30 days expiry time for adhoc backup as default from client side. +* Added example to fetch pruned recovery points after modify policy. +* Fixed the documentation for suspend backups with immutability. + +#### Az.RedisCache 1.8.0 +* Upgraded API version to 2023-04-01 + +#### Az.Resources 6.8.0 +* Fixed the incorrect behavior of pagination for 'Get-AzTag' +* Updated API version to 2022-09-01 +* Added Deployment Stacks cmdlets +* Added support for dynamic parameters when deploying symbolic name templates. +* Fixed 'Set-AzPolicyExemption' parameter PolicyDefinitionReferenceId not accept empty array. +* Fixed 'Get-AzPolicyExemption' output not contain system data. + +#### Az.Sql 4.8.0 +* Added 'TryPlannedBeforeForcedFailover' parameter to 'Switch-AzSqlDatabaseFailoverGroup' +* Added new cmdlets for managed database move and copy operations + - 'Copy-AzSqlInstanceDatabase' + - 'Move-AzSqlInstanceDatabase' + - 'Complete-AzSqlInstanceDatabaseCopy' + - 'Stop-AzSqlInstanceDatabaseCopy' + - 'Complete-AzSqlInstanceDatabaseMove' + - 'Stop-AzSqlInstanceDatabaseMove' + - 'Get-AzSqlInstanceDatabaseMoveOperation' + - 'Get-AzSqlInstanceDatabaseCopyOperation' + +#### Az.Storage 5.8.0 +* Supported TierToCold and TierToHot in Storage account management policy + - 'Add-AzStorageAccountManagementPolicyAction' +* Supported Blob Tier Cold + - 'Copy-AzStorageBlob' + - 'Set-AzStorageBlobContent' + - 'Start-AzStorageBlobCopy' +* Migrated the following Azure Queue dataplane cmdlets from 'Microsoft.Azure.Storage.Queue' to 'Azure.Storage.Queue' + - 'New-AzStorageQueueSASToken' +* Added warning messages for an upcoming breaking change when creating SAS token + - 'New-AzStorageBlobSasToken' + - 'New-AzStorageContainerSasToken' + - 'New-AzStorageAccountSasToken' + - 'New-AzStorageContext' + - 'New-AzStorageFileSasToken' + - 'New-AzStorageShareSasToken' + - 'New-AzStorageQueueSasToken' + - 'New-AzStorageTableSasToken' + - 'New-AzDataLakeGen2SasToken' +* Added a warning message for an upcoming breaking change when creating a storage account + - 'New-AzStorageAccount' + +#### Az.StorageMover 1.0.1 +* Fixed the issue of System.Management.Automation.Internal.Host.InternalHost conflicting with system parameter System.Management.Automation.Internal.Host.InternalHost + +#### Az.Synapse 3.0.1 +* Fixed the issue for 'Start-AzSynapseTrigger/Stop-AzSynapseTrigger' to not throw exception when Request Status is 202 + +#### Az.TrafficManager 1.2.1 +Added a new API 'CheckTrafficManagerNameAvailabilityV2'. + +#### Az.Websites 3.0.1 +* Increased timeout for Publish-AzWebApp command +* Fixed Set-AzWebApp issue with 'Set-AzWebApp' when piping in Get-AzWebApp object [#21820] +* Added support for the PremiumMV3 tier to 'New-AzAppServicePlan' [#21933] + +### Thanks to our community contributors +* Bas Wijdenes (@baswijdenes), Update Get-AzAutomationJob.md (#21984) +* Sebastiaan Koning (@OneAndOnlySeabass), Fix a few typos in Get-AzMarketplaceTerms.md (#21945) +* Hiroshi Yoshioka (@hyoshioka0128) + * Typo "CosmosDB Account"→"Cosmos DB Account" (#22005) + * Typo "azure key vault"→"Azure Key Vault" (#22103) + +## 10.0.0 - June 2023 +#### Az.Accounts 2.12.3 +* Updated System.Security.Permissions to 4.7.0. + +#### Az.Aks 5.5.0 +* Fixed the issue of 'Enable-AzAksAddon' when there are no addons. [#21665] +* Added parameter '-EnableAHUB' for 'New-AzAksCluster' and 'Set-AzAksCluster' +* Added parameter '-WindowsProfileAdminUserPassword' for 'Set-AzAksCluster' + +#### Az.Billing 2.0.2 +* Fixed skip token for Consumption PriceSheet cmdlet + +#### Az.Cdn 3.0.0 +* Upgraded API version to 2022-11-01-preview +* Added support to migrate from Azure Front Door (classic) to Azure Front Door Standard and Premium. +* Added support for AFDX upgrade from Standard tier to Premium tier. + +#### Az.Compute 6.0.0 +* Added new switch parameter 'OSImageScheduledEventEnabled' and string parameter 'OSImageScheduledEventNotBeforeTimeoutInMinutes' to the cmdlets 'New-AzVmssConfig' and 'Update-AzVmss'. +* Fixed an issue that 'Add-AzVhd' throws 'FileNotFoundException' on Windows PowerShell. [#21321] +* Removed the 'NextLink' parameter and parameter set from the 'Get-AzVM' cmdlet. + +#### Az.ContainerRegistry 4.0.0 +* Updated module to autorest based + +#### Az.CosmosDB 1.11.0 +* Added support for Continuous 7 Days backup mode. +* Added new parameter 'EnablePartitionMerge' to 'Update-AzCosmosDBAccount' and 'New-AzCosmosDBAccount'. + +#### Az.Databricks 1.5.1 +* Fixed an issue that 'Update-AzDatabricksWorkspace' doesn't work as expected while enabling encryption. [#21324] + +#### Az.DataProtection 2.0.0 +* Added support for Blob Hardened recovery points (VaultStore). +* Added Cross Subscription Restore for 'AzureDisk', 'AzureDatabaseForPostgreSQL' and 'AzureBlob'. +* Added 'Get-AzDataProtectionOperationStatus' command for long running cmdlets async. + +#### Az.DesktopVirtualization 4.0.0 +* Upgraded API version to 2022-09-09 +* Added cmdlet: + - 'Get-AzWvdScalingPlanPooledSchedule' + - 'New-AzWvdScalingPlanPooledSchedule' + - 'Remove-AzWvdScalingPlanPooledSchedule' + - 'Update-AzWvdScalingPlanPooledSchedule' +* Added parameters 'pageSize', 'isDescending' and 'initialSkip' to: + - 'Get-AzWvdApplication' + - 'Get-AzWvdApplicationGroup' + - 'Get-AzWvdDesktop' + - 'Get-AzWvdHostPool' + - 'Get-AzWvdMsixPackage' + - 'Get-AzWvdScalingPlan' + - 'Get-AzWvdSessionHost' + - 'Get-AzWvdStartMenuItem' + - 'Get-AzWvdUserSession' + - 'Get-AzWvdWorkspace' +* Added parameters 'AgentUpdateMaintenanceWindow', 'AgentUpdateMaintenanceWindowTimeZone', 'AgentUpdateType', 'AgentUpdateUseSessionHostLocalTime' to: + - 'New-AzWvdHostPool' + - 'Update-AzWvdHostPool' +* Added parameter 'FriendlyName' to: + - 'New-AzWvdHostPool' + - 'Update-AzWvdHostPool' + - 'Update-AzWvdSessionHost' + +#### Az.EventHub 4.0.0 +* Aliased 'New-AzEventHubNamespace', 'Remove-AzEventHubNamespace', 'Set-AzEventHubNamespace', 'Get-AzEventHubNamespace' with 'New-AzEventHubNamespaceV2', 'Remove-AzEventHubNamespaceV2', 'Set-AzEventHubNamespaceV2', 'Get-AzEventHubNamespaceV2' respectively +* Replaced 'New-AzEventHubEncryptionConfig' by 'New-AzEventHubKeyVaultPropertiesObject' + +#### Az.Functions 4.0.7 +* Removed support to create v3 function apps (Functions v3 reached EOL on December, 2022) [#20838] +* Enabled using ARM API to get stacks information for function app creation [#14682][#20009] +* Added support to create dotnet-isolated function apps [#16349] +* Added support for custom handler function apps [#12542] + +#### Az.HDInsight 6.0.0 +* Breaking Change: + - Removed the parameter '-RdpAccessExpiry' which has been marked as deprecated for a long time from cmdlet 'New-AzHDInsightCluster' + - Removed the parameter '-RdpCredential' which has been marked as deprecated for a long time from cmdlet 'New-AzHDInsightCluster' + +#### Az.KeyVault 4.10.0 +* Added breaking change announcement for parameter 'SoftDeleteRetentionInDays' in 'New-AzKeyVaultManagedHsm'. The parameter 'SoftDeleteRetentionInDays' is becoming mandatory + - This change will take effect on version 6.0.0 +* Changed the encoding way from a string into byte array in 'Invoke-AzKeyVaultKeyOperation' from ASCII to UTF8. UTF8 is backward-compatible with ASCII. [#21269] +* Bug fix: Changed the decoding way from byte array into a string from system default encoding to UTF8 to match encoding way. [#21269] +* Added parameter 'PolicyPath' and 'PolicyObject' in 'Import-AzKeyVaultCertificate' to support custom policy [#20780] + +#### Az.MachineLearningServices 1.0.0 +* General availability for module Az.MachineLearningServices + +#### Az.Migrate 2.2.0 +* Added support for Windows Server OS upgrade while migrating the server to Azure using Azure Migrate +* Added fix for keyvault SPN Id coming as null for some users + +#### Az.Monitor 4.5.0 +* Added cmdlets for monitor workspace: + - 'Get-AzMonitorWorkspace' + - 'New-AzMonitorWorkspace' + - 'Update-AzMonitorWorkspace' + - 'Remove-AzMonitorWorkspace' + +#### Az.Network 6.0.0 +* Added new cmdlets for RouteMap child resource of VirtualHub. + -'Get-AzRouteMap' + -'New-AzRouteMapRuleCriterion' + -'New-AzRouteMapRuleActionParameter' + -'New-AzRouteMapRuleAction' + -'New-AzRouteMapRule' + -'New-AzRouteMap' + -'Set-AzRouteMap' + -'Remove-AzRouteMap' +* Updated cmdlets to add inbound/outbound route maps in routingConfiguration + -'New-AzRoutingConfiguration' +* Added the command 'New-AzFirewallPolicyApplicationRuleCustomHttpHeader' +* Added the method 'AddCustomHttpHeaderToInsert' to 'PSAzureFirewallPolicyApplicationRule' +* Added new cmdlets to support Rate Limiting Rule for Application Gateway WAF + - 'New-AzApplicationGatewayFirewallCustomRuleGroupByUserSession', + - 'New-AzApplicationGatewayFirewallCustomRuleGroupByVariable', + - Also updated cmdlet to add the property of 'RateLimitDuration', 'RateLimitThreshold' and 'GroupByUserSession' + - 'New-AzureApplicationGatewayFirewallCustomRule' +* Added support of 'AdditionalNic' Property in 'New-AzNetworkVirtualAppliance' +* Added the new cmdlet for supporting 'AdditionalNic' Property + - 'New-AzVirtualApplianceAdditionalNicProperty' +* Added new cmdlets to support Log Scrubbing Feature for Application Gateway WAF Firewall Policy + - 'New-AzApplicationGatewayFirewallPolicyLogScrubbingConfiguration', + - 'New-AzApplicationGatewayFirewallPolicyLogScrubbingRule', + - Also updated cmdlet to add the property of 'LogScrubbing' + - 'New-AzApplicationGatewayFirewallPolicySetting' +* Onboarded 'Microsoft.HardwareSecurityModules/cloudHsmClusters' to private link cmdlets +* Updated cmdlet to add the property of 'DisableRequestBodyEnforcement', 'RequestBodyInspectLimitInKB' and 'DisableFileUploadEnforcement' + - 'New-AzApplicationGatewayFirewallPolicySetting' +* Added optional property 'AuxiliarySku' to cmdlet 'New-AzNetworkInterface' to help choose performance on an 'AuxiliaryMode' enabled Network Interface. +* Added a new value 'AcceleratedConnections' for existing property 'AuxiliaryMode' for 'New-AzNetworkInterface' +* Added new cmdlets to get virtual hub effective routes and in/outbound routes + - 'Get-AzVHubEffectiveRoute' + - 'Get-AzVHubInboundRoute' + - 'Get-AzVHubOutboundRoute' + +#### Az.RedisEnterpriseCache 1.2.0 +* Upgraded API version to 2023-03-01-preview + +#### Az.Relay 2.0.0 +* Updated API version to 2021-11-01 + +#### Az.Resources 6.7.0 +* Added parameter '-CountVariable' for list operations, 'odataCount' can now be assigned to this variable [#20982] + - 'Get-AzADApplication' + - 'Get-AzADServicePrincipal' + - 'Get-AzADUser' + - 'Get-AzADGroup' +* Supported polymorphism for 'Get-AzADGroupMember', output of this cmdlet was now 'Application' 'ServicePrincipal', 'User' and 'Group' based on the 'odataType' [#19728] +* Added '-Force' parameter on 'Publish-AzBicepModule' for supporting overwriting existing modules. +* Fixed 'New-AzADApplication' when multiple redirect url types were provided. [#21108] +* Fixed 'Update-AzADServicePrincipal' when empty array passed for 'IdentifierUri' [#21345] +* Fixed an issue where location header was missing in the response from the service for 'New-AzManagedApplication'. +* Fixed 'Get-AzResourceGroup' ignored the subscription ID in '-Id' [#21725] + +#### Az.ServiceBus 3.0.0 +* Aliased 'New-AzServiceBusNamespace', 'Remove-AzServiceBusNamespace', 'Set-AzServiceBusNamespace', 'Get-AzServiceBusNamespace' with 'New-AzServiceBusNamespaceV2', 'Remove-AzServiceBusNamespaceV2', 'Set-AzServiceBusNamespaceV2', 'Get-AzServiceBusNamespaceV2' respectively. +* Replaced 'New-AzServiceBusEncryptionConfig' by 'New-AzServiceBusKeyVaultPropertiesObject' + +#### Az.ServiceFabric 3.2.0 +* Added new cmdlet 'Add-AzServiceFabricManagedClusterNetworkSecurityRule' to update network security rules in managed cluster resource + +#### Az.SignalR 2.0.0 +* Breaking change: + - Removed 'HostNamePrefix' property of output type 'PSSignalRResource' of following cmdlets: + - 'Get-AzSignalR' + - 'New-AzSignalR' + - 'Update-AzSignalR' + +#### Az.Sql 4.7.0 +* Added new cmdlets 'Get-AzSqlInstanceDatabaseLedgerDigestUpload', 'Disable-AzSqlInstanceDatabaseLedgerDigestUpload', and 'Enable-AzSqlInstanceDatabaseLedgerDigestUpload' +* Added 'EnableLedger' parameter to 'New-AzSqlInstanceDatabase' +* Added 'PreferredEnclaveType' parameter to 'NewAzureSqlElasticPool' and 'SetAzureSqlElasticPool' cmdlet + +#### Az.SqlVirtualMachine 2.0.0 +* Converted Az.SqlVirtualMachine to autorest-based module. + +#### Az.StackHCI 2.0.0 +* Made Region parameter mandatory in 'Register-AzStackHCI' cmdlet. +* Removed EnableAzureArcServer parameter from 'Register-AzStackHCI' cmdlet. +* Removed 'Test-AzStackHCIConnection' cmdlet. Customers can use 'Invoke-AzStackHciConnectivityValidation' from AzStackHCI.EnvironmentChecker module for enhanced connectivity verification tests. +* Added support for Managed Service identity (MSI) in Azure China Cloud. +* Added support for Mandatory extensions, for OS versions starting 23H2. +* Added parameter validations for 'Register-AzStackHCI' cmdlet. +* Improved Error logging in Registration and Unregistration. + +#### Az.Storage 5.7.0 +* Fixed issue of getting a single blob with leading slashes + - 'Get-AzStorageBlob' +* Supported setting CORS rules in management plane cmdlets + - 'Update-AzStorageBlobServiceProperty' + - 'Update-AzStorageFileServiceProperty' +* Fixed an issue of 'StorageAccountName' field in context object when the context is invalid + - 'New-AzStorageContext' +* Fixed an issue when a context does not have Credentials field +* Added '' to be a valid container name + +#### Az.StorageSync 2.0.0 +* Deprecated 'RegisteredServer' alias for InputObject parameter for Set-AzStorageSyncServerEndpoint + +#### Az.Synapse 3.0.0 +* Removed the unnecessary breaking change of parameter '-SparkConfigFilePath' for 'New-AzSynapseSparkPool' and 'Update-AzSynapseSparkPool' cmdlets + +#### Az.Websites 3.0.0 +* Removed 'New-AzWebAppContainerPSSession' and 'Enter-AzWebAppContainerPSSession' cmdlets + +### Thanks to our community contributors +* Gitanjali Verma (@gitanjali1993), Update Set-AzApplicationGatewayBackendAddressPool.md (#21458) +* Jeremiah Mathers (@jeremiahmathers), Update Set-AzApplicationGatewayConnectionDraining.md (#21601) +* Morris Janatzek (@morrisjdev), Added PackageAction `Set` for `Update-AzSynapseSparkPool` to support removing and adding packages in one action (#21579) +* Adam Myatt (@myatt83) + * Update Set-AzNetworkManagerSubscriptionConnection.md (#21621) + * Update Get-AzApiManagementAuthorizationServerClientSecret.md (#21619) +* Noah Koontz (@prototypicalpro) + * Regenerate help for Az.Network (#21533) + * feat: add autoscale support for virtual hub and update network formatting (#21518) +* Simon Wåhlin (@SimonWahlin), Add -Force parameter on Publish-AzBicepModule (#21713) +* Steve Matney (@stevematney), Fix typo in Update-AzWebAppTrafficRouting.md (#21667) + +## 9.7.1 - May 2023 +#### Az.Accounts 2.12.2 +* Fixed 'AzureSynapseAnalyticsEndpointResourceId' of 'USGovernment' environment. +* Updated Azure.Core to 1.31.0. +* Updated the reference of Azure PowerShell Common to 1.3.75-preview. + +#### Az.Aks 5.4.0 +* Added cmdlet 'New-AzAksMaintenanceConfiguration', 'Get-AzAksMaintenanceConfiguration', 'Remove-AzAksMaintenanceConfiguration', 'New-AzAksSnapshot', 'Get-AzAksSnapshot', 'Remove-AzAksSnapshot', 'Get-AzAksManagedClusterCommandResult', 'Get-AzAksManagedClusterOSOption', 'Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint', 'Invoke-AzAksAbortAgentPoolLatestOperation', 'Invoke-AzAksAbortManagedClusterLatestOperation', 'Invoke-AzAksRotateManagedClusterServiceAccountSigningKey', 'Start-AzAksManagedClusterCommand', 'New-AzAksTimeInWeekObject', 'New-AzAksTimeSpanObject'. +* Added parameter '-OutboundType' for 'New-AzAksCluster' +* Added parameter '-EnableOidcIssuer' for 'New-AzAksCluster' and 'Set-AzAksCluster' +* Added parameter '-NodePodSubnetID' for 'New-AzAksCluster', '-PodSubnetID' for 'New-AzAksNodePool' + +#### Az.Compute 5.7.1 +* Added a breaking change warning to the 'Get-AzVM' cmdlet to show that the 'NextLink' parameter and parameter set will be removed in June 2023. The parameter has been non-functional for a long time. +* Updated the breaking change warning in 'New-AzVM' and 'New-AzVmss' regarding using the new versioned image aliases to indicate that certain aliases will be removed next breaking change release. +* Updated the 'Get-AzVMRunCommand' to include the 'ProvisioningState' value. Fix [#21473] +* Updated Azure.Core to 1.31.0. + +#### Az.ContainerRegistry 3.0.4 +* Updated Azure.Core to 1.31.0. + +#### Az.CosmosDB 1.10.1 +* Updated Azure.Core to 1.31.0. + +#### Az.KeyVault 4.9.3 +* Added breaking changes for 'Invoke-AzKeyVaultKeyOperation'. The encoded/decoded way between string and bytes in 'Invoke-AzKeyVaultKeyOperation' will change to UTF8. + - This change will take effect on 5/23/2023 + - The change is expected to take effect from the version 5.0.0 +* Updated Azure.Core to 1.31.0. + +#### Az.LoadTesting 1.0.0 +* General availability of 'Az.LoadTesting' module + +#### Az.Network 5.7.0 +* Onboarded 'Microsoft.HardwareSecurityModules/cloudHsmClusters' to private link cmdlets +* Fixed the issue for 'Update-AzCustomIpPrefix' that 'NoInternetAdvertise' will should be set to false if not provided + +#### Az.PolicyInsights 1.6.1 +* Updated Azure.Core to 1.31.0. + +#### Az.PowerBIEmbedded 1.2.1 +* Added deprecate warning message for workspace collection cmdlets + +#### Az.RecoveryServices 6.4.0 +* Added support for updating CrossSubscriptionRestoreState of the vault +* Added Cross subscription restore support for workload type MSSQL + +#### Az.Resources 6.6.1 +* Added support for Azure resources deployment with parameters file using Bicep parameters syntax + +#### Az.Sql 4.6.0 +* Added new cmdlets for managing server configuration options + - 'Set-AzSqlServerConfigurationOption' + - 'Get-AzSqlServerConfigurationOption' + +#### Az.Storage 5.6.0 +* Supported rename file and directory + - 'Rename-AzStorageFile' + - 'Rename-AzStorageDirectory' +* Added a warning message for an upcoming breaking change when getting a single blob + - 'Get-AzStorageBlob' +* Fixed the issue of listing blobs with leading slashes + - 'Get-AzStorageBlob' +* Added support for sticky bit + - 'New-AzDataLakeGen2Item' + - 'New-AzDataLakeGen2ACLObject' + - 'Update-AzDataLakeGen2Item' +* Added warning messages for an upcoming cmdlet breaking change + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' +* Allowed to clear blob tags on a blob + - 'Set-AzStorageBlobTag' +* Updated Azure.Core to 1.31.0 + +#### Az.Synapse 2.3.1 +* Updated Azure.Core to 1.31.0. + +#### Az.Websites 2.15.0 +* Fixed Tag parameter issues with ASE for 'New-AzWebApp' + +### Thanks to our community contributors +* @geologyrocks + * Update IsCustom property on example role defintion (#21514) + * Fix Assignment/Definition typo in Output (#21442) + +## 9.6.0 - April 2023 +#### Az.Aks 5.3.2 +* Fixed the issue that system variable 'True' is undefined in 'Windows PowerShell'. +* Decoupled AutoMapper dependency, replaced with AdapterHelper. + +#### Az.Batch 3.4.0 +* Added new property 'Encryption' of type 'EncryptionProperties' to 'AccountCreateParameters'. + - Configures how customer data is encrypted inside the Batch account. + +#### Az.Billing 2.0.1 +* Fixed pagination for 'Get-AzConsumptionPriceSheet' cmdlet + +#### Az.CognitiveServices 1.13.1 +* Removed notice and attestation from 'New-AzCognitiveServicesAccount'. + +#### Az.Compute 5.7.0 +* Addressed bug in 'Remove-AzVmss' to throw error when '-InstanceId' is null. [#21162] +* Added '-CustomData', '-AdminPassword', and '-ExactVersion' parameters to 'Invoke-AzVMReimage'. +* Removed the image alias 'CoreOS' as the publisher CoreOS no longer has any images for Azure. + Updated the names of the 'openSUSE-Leap' and 'SLES' aliases to 'OpenSuseLeap154' and 'SuseSles15SP4' respectively. Updated these aliases to point to an image that actually exists. +* Added a breaking change warning to 'New-AzVM' and 'New-AzVmss' for future planned image alias removals due to the images reaching their End of Support date. +* Added new descriptive and versioned alias names for the Linux image aliases, including a new alias for the 'Kinvolk' publisher. + +#### Az.ContainerRegistry 3.0.3 +* Added breaking change attributes for cmdlets + +#### Az.CosmosDB 1.10.0 +* Introduced restorable apis support for Gremlin and Table, which includes: + - Added the apis for RestorableGremlinDatabases, RestorableGremlinGraphs, RestorableGremlinResources,RestorableTables, RestorableResources. + - Added RetrieveContinuousBackupInfo apis for Gremlin and Table which help in determining the restore point of time and the resources to restore. + - Added GremlinDatabasesToRestore and TablesToRestore field to provision and restore database account api. + - Added StartTime and EndTime support for listing restorable containers event feed. + +#### Az.DataProtection 1.2.0 +* Added support for AKS workload with Backup Vaults +* Added support for 'Set-AzDataProtectionMSIPermission' during restore with AKS workload + +#### Az.EventGrid 1.6.0 +* Added fix for DeliveryAttributeMapping +* Added validation for StorageQueueTtl + +#### Az.EventHub 3.2.3 +* Added upcoming breaking change notifications for Az.EventHub module. + +#### Az.Kusto 2.2.0 +* Added cmdlet 'Get-AzKustoSku' +* Added parameter 'CallerRole' for cmdlet 'AzKustoDatabase' and 'Update-AzKustoDatabase' +* Added support for new data connection kind 'CosmosDb' for cmdlet 'New-AzKustoDataConnection' and 'Update-AzKustoDataConnection' +* Added parameters 'DatabaseNameOverride' 'DatabaseNamePrefix' 'TableLevelSharingPropertyFunctionsToInclude' 'TableLevelSharingPropertyFunctionsToExclude' for cmdlet 'New-AzKustoAttachedDatabaseConfiguration' + +#### Az.Network 5.6.0 +* Updated 'New-AzLoadBalancer' and 'Set-AzLoadBalancer' to validate surface level parameters for global tier load balancers +* Added property 'AuthorizationStatus' to ExpressRouteCircuit +* Added property 'BillingType' to ExpressRoutePort +* Added support for connection flushing in network security group which when enabled, re-evaluates flows when rules are updated + - 'New-AzNetworkSecurityGroup' +* Added support for state in WAF Custom Rule +* Added 'New-AzGatewayCustomBgpIpConfigurationObject' command +* Updated 'New-AzVirtualNetworkGatewayConnection', 'Set-AzVirtualNetworkGatewayConnection' and 'New-AzVpnSiteLinkConnection' to support GatewayCustomBgpIpConfiguration. +* Updated 'Reset-AzVpnGateway' to support IpConfigurationId. +* Blocked some regions when creating/updating Basic Sku firewall +* Fixed bugs related to auto learn IP prefixes and Snat +* Updated multi-auth to be supported when both OpenVPN and IkeV2 protocols are used for VNG and VWAN VPN + +#### Az.Resources 6.6.0 +* Fixed an issue when running the 'New-AzManagementGroup' command where it tried to cast an async operation as a Management Group. [#21000] +* Fixed an issue when running 'Get-AzResourceGroup -Name 'some_name'', it ignores '-Location' if specified[#21225] + +#### Az.ServiceBus 2.2.1 +* Added upcoming breaking change notifications for Az.ServiceBus module. + +#### Az.Sql 4.5.0 +* Added a new cmdlet to refresh external governance status + - 'Invoke-AzSqlServerExternalGovernanceStatusRefresh' + +#### Az.SqlVirtualMachine 1.1.1 +* Added breaking change notification for cmdlets to be removed and parameters to be changed. + * Cmdlet 'New-AzSqlVMConfig' will be removed. + * Cmdlet 'Set-AzSqlVMConfigGroup' will be removed. + * Cmdlet 'Update-AzAvailabilityGroupListener' will be removed. + * Parameter 'SqlVM' will be removed from cmdlet 'New-AzSqlVM'. + * Parameter 'SqlVMGroupObject' will be removed from cmdlet 'Get-AzAvailabilityGroupListener' and 'Remove-AzAvailabilityGroupListener'. + * Parameter alias 'SqlVM' will be removed from 'InputObject' of cmdlet 'Remove-AzSqlVM'. + * Parameter alias 'SqlVMGroup' will be removed from 'InputObject' of cmdlet 'Update-AzSqlVMGroup' and 'Remove-AzSqlVMGroup'. +* Added breaking change notification for SqlManagementType + +#### Az.Storage 5.5.0 +* Supported create storage account with DnsEndpointType + - 'New-AzStorageAccount' +* Fixed file cmdlets potential context issue when the current context doesn't match with the credential of input Azure File object + - 'Close-AzStorageFileHandle' + - 'Get-AzStorageFile' + - 'Get-AzStorageFileContent' + - 'Get-AzStorageFileHandle' + - 'New-AzStorageDirectory' + - 'New-AzStorageFileSASToken' + - 'Remove-AzStorageDirectory' + - 'Remove-AzStorageFile' + - 'Remove-AzStorageShare' + - 'Set-AzStorageFileContent' + - 'Set-AzStorageShareQuota' + - 'Start-AzStorageFileCopy' + +#### Az.Websites 2.14.0 +* Fixed 'Edit-AzWebAppBackupConfiguration' to pass backup configuration enabled or not +* Added a new parameter '-SoftRestart' for 'Restart-AzWebApp' and 'Restart-AzWebApp' to perform a soft restart +* Updated 'Get-AzWebApp' and 'Get-AzWebAppSlot' to expose 'VirtualNetwork Integration Info' [#10665] +* Set default value for '-RepositoryUrl' of 'New-AzStaticWebApp' [#21202] + +### Thanks to our community contributors +* Allen TechWorld (@hachi1030-Allen), Bug - Invoke-AzCostManagementQuery cmdlet should handle null value in the response rows (#21180) +* Simon Angling (@sangling), Minor Spelling (#21165) +* Thomas Pike (@thwpike), Missing formatting for code block (#21130) + +## 9.5.0 - March 2023 +#### Az.Accounts 2.12.0 +* Fixed the issue that errors related to WAM are thrown when it is not enabled. [#20871] [#20824] +* Updated Azure.Core library to 1.28.0. +* Fixed an issue that the helper message about missing modules shows up at the wrong time. [#19228] +* Added a hint message for some resource creation cmdlets when there is another region which may reduce the costs. +* Supported environment initialization and auto-discovery with ArmMetadata of API version 2022-09-01. + +#### Az.Aks 5.3.1 +* Fixed the issue that Invoke-AzAksRunCommand will fail when the directory for parameter CommandContextAttachment contains sub-directories. [#20734] + +#### Az.Automanage 1.0.0 +* General availability for module Az.Automanage + +#### Az.Automation 1.9.1 +* Fixed bug: Runbooks Name Pattern failures. + +#### Az.CloudService 1.2.0 +* Upgraded the api version to 2022-09-04. +* Upgraded the api version of referenced network to 2022-07-01. + +#### Az.CognitiveServices 1.13.0 +* Updated CognitiveServices PowerShell to use 2022-12-01 version. +* Added new CognitiveServices CommitmentPlan and Association cmdlets. +* Added MultiRegionSetting support for CognitiveServices Account cmdlets. + +#### Az.Compute 5.5.0 +* Added breaking change message for 'New-AzVmss'. +* Added '-PerformancePlus' parameter to 'New-AzDiskConfig' +* Added 'MaxSurge' to Set-AzVmssRollingUpgradePolicyCommand +* Added support for 'latest' in 'Get-AzvmImage' '-Version' parameter +* Added 'CompletionPercent' property to PSDisk object. + +#### Az.ContainerInstance 3.2.0 +* Added 'priority' property to Container Group properties +* Added 'Confidential' sku type to Container Group Skus + +#### Az.ContainerRegistry 3.0.2 +* Updated Azure.Core to 1.28.0. + +#### Az.CosmosDB 1.9.1 +* Updated Azure.Core to 1.28.0. + +#### Az.Databricks 1.5.0 +* Upgraded API version to 2023-02-01 + +#### Az.DataFactory 1.16.13 +* Updated ADF .Net SDK version to 9.2.0 +* Added AzureBlobFS sasUri and sasToken properties in ADF +* Added AzureBlobStorage containerUri and authenticationType properties in ADF +* Added support copyComputeScale And pipelineExternalComputeScale in IntegrationRuntime + +#### Az.EventHub 3.2.2 +* Added breaking change description for parameter 'MessageRetentionInDays', which would be deprecated and would be replaced by 'RetentionTimeInHours' + +#### Az.FrontDoor 1.10.0 +* Fixed New-AzFrontDoorWafPolicy cmdlet to support adding Tags for the Azure Frontdoor waf policy + +#### Az.IotHub 2.7.5 +* Updated IoT Hub Management SDK to version 4.2.0 (api-version 2021-07-02) +* Fixed 'Get-AzIoTHub' to work with DigiCert hubs + +#### Az.KeyVault 4.9.2 +* Updated Azure.Core to 1.28.0. + +#### Az.ManagedServiceIdentity 1.1.1 +* Upgraded to API version 2023-01-31. +* Federated identity credentials GA version is available now. + +#### Az.Network 5.5.0 +* Updated cmdlets to add new property of 'Snat' in Azure Firewall Policy. + - 'New-AzFirewallPolicySnat' + - 'New-AzFirewallPolicy' + - 'Set-AzFirewallPolicy' +* Fixed a bug that reverts classic fw private ranges to default when doing get & set +* Onboarded 'Microsoft.Monitor/accounts' to private link cmdlets + +#### Az.PolicyInsights 1.6.0 +* Added support for policy attestations. + +#### Az.RecoveryServices 6.3.0 +* Supported using managed disks for replication for HyperV to Azure provider in Azure Site Recovery + +#### Az.Relay 1.0.4 +* Added breaking change message for cmdlets. + * 'Set-AzRelayNamespace' + * 'Get-AzRelayOperation' + +#### Az.Resources 6.5.3 +* Updated behavior of Get-AzPolicyDefinition which previously returned all definitions when -Id was provided with a nonexistent policy definition id. Fixed to correctly throw a 404 exception in this case. + +#### Az.Security 1.4.0 +* Updated Alerts cmdlets: + 'Get-AzSecurityAlert' + 'Set-AzSecurityAlert' +* Moving Security Contacts to be based on the latest API version '2020-01-01-preview' with backward compatibility support + +#### Az.ServiceBus 2.2.0 +* Upgraded API version to 2022-10-01-preview +* Fixed a bug for 'Set-AzServiceBusQueue' + +#### Az.ServiceFabric 3.1.1 +* Added support for Windows 2022 server vm image. + - This enables cluster operations with Windows 2022 server vm image + +#### Az.Sql 4.4.0 +* Fixed identity assignment in 'Set-AzSqlDatabase' cmdlet +* Added new parameters to 'New-AzSqlDatabase', 'Get-AzSqlDatabase', 'Set-AzSqlDatabase', 'New-AzSqlDatabaseCopy', 'New-AzSqlDatabaseSecondary' cmdlets + - AssignIdentity + - EncryptionProtector + - UserAssignedIdentityId + - KeyList + - KeysToRemove + - FederatedClientId +* Added 'ExpandKeyList' and 'KeysFilter' parameters to 'Get-AzSqlDatabaseGeoBackup' and 'Get-SqlDeletedDatabaseBackup' +* Added new cmdlets for Per DB CMK + - 'Revalidate-AzSqlDatabaseTransparentDataEncryptionProtector' + - 'Revert-AzSqlDatabaseTransparentDataEncryptionProtector' + - 'Revalidate-AzSqlServerTransparentDataEncryptionProtector' + - 'Revalidate-AzSqlInstanceTransparentDataEncryptionProtector' +* Added an optional parameter 'SecondaryType' to: + 'Set-AzSqlDatabaseInstanceFailoverGroup' + 'New-AzSqlDatabaseInstanceFailoverGroup' + +#### Az.StackHCI 1.4.3 +* Removed manual installation for Az.Accounts from Az.StackHCI. +* Removed verbose while importing modules. + +#### Az.Storage 5.4.1 +* Updated Azure.Core to 1.28.0. + +#### Az.StorageMover 1.0.0 +* General availability for module Az.StorageMover +* Updated StorageMover API version to 2023-03-01 + +#### Az.Synapse 2.3.0 +* Upgraded Azure.Analytics.Synapse.Artifacts to 1.0.0-preview.17 +* Updated 'New-AzSynapseSparkPool' and 'Update-AzSynapseSparkPool' to support for setting spark pool isolated compute by '-EnableIsolatedCompute' +* Updated 'New-AzSynapseSparkPool' and 'Update-AzSynapseSparkPool' to support for setting spark pool node size to 'XLarge', 'XXLarge', 'XXXLarge' + +#### Az.Websites 2.13.0 +* Added a new parameter '-CopyIdentity' for 'New-AzWebAppSlot' to copy the identity from the parent app to the slot. +* Updated 'New-AzWebAppSSLBinding' to support -WhatIf parameter + +### Thanks to our community contributors +* Brett Miller (@brettmillerb), Corrected syntax for ConfirmAction (#20902) +* Dave Neeley (@daveneeley), Clarify behavior of AcountEnabled and Password (#21006) +* Hiroshi Yoshioka (@hyoshioka0128), Typo "udpate"→"update" (#20810) +* @meenalsri + * Update New-AzSynapseRoleAssignment.md (#20905) + * Update Remove-AzSynapseRoleAssignment.md (#20906) + * Added note for scenario when an SPN role assignment is listed (#20907) +* @sushil490023, Update Reference to latest swagger for Runbook Cmdlets (#20803) + +## 9.4.0 - February 2023 +#### Az.Accounts 2.11.2 +* Supported Web Account Manager on ARM64-based Windows systems. Fixed an issue where 'Connect-AzAccount' failed with error 'Unable to load DLL 'msalruntime_arm64''. [#20700] +* Enabled credential to be found only by applicationId while tenant was not matched when accquire token. [#20484] +* When Az.Accounts ran in parallel, the waiters were allowed to wait infinitely to avoid throw exception in automation enviroment. [#20455] + +#### Az.Aks 5.3.0 +* Added parameter '-AadProfile' for 'New-AzAksCluster' and 'Set-AzAksCluster' +* Added parameter '-NodeHostGroupID' for 'New-AzAksCluster' and parameter '-HostGroupID' for 'New-AzAksNodePool' + +#### Az.ApplicationInsights 2.2.2 +* Added parameter validation for 'Get-AzApplicationInsights' [#20697] + +#### Az.Compute 5.4.0 +* Added '-SkipIdentity', '-PathUserIdentity', '-IsTest' parameter to 'Set-AzVMAEMExtension' +* Added 'ConsistencyMode' parameter to 'New-AzRestorePoint'. +* Updated the storage account type value in several locations from the outdated 'StandardLRS' to the current 'Standard_LRS'. +* Filled in missing parameter descriptions across multiple parameters and improved some existing parameter descriptions. +* Updated Compute PS to use the new .Net SDK version 59.0.0. This includes an approved breaking change for a non-functional feature. + - The type of the property 'Source' of type 'Microsoft.Azure.Management.Compute.Models.GalleryDataDiskImage', 'Microsoft.Azure.Management.Compute.Models.GalleryOSDiskImage', and 'Microsoft.Azure.Management.Compute.Models.GalleryImageVersionStorageProfile' has changed from 'Microsoft.Azure.Management.Compute.Models.GalleryArtifactVersionSource' to 'Microsoft.Azure.Management.Compute.Models.GalleryDiskImageSource'. +* Updated the broken 'UbuntuLTS' image alias to use its original sku version of '16.04-LTS' instead of the nonexistent image '20.04-LTS'. This fixes an issue introduced in the version 5.3.0 release. +* Updated Set-AzVMRunCommand and Set-AzVmssRunCommand ScriptLocalPath parameter set to work with Linux and with files that have comments. +* Added '-TargetExtendedLocation' parameter to 'New-AzGalleryImageVersion' and 'Update-AzGalleryImageVersion' +* Added '-AllowDeletionOfReplicatedLocation' to 'Update-AzGalleryImageVersion' + +#### Az.DataFactory 1.16.12 +* Updated ADF .Net SDK version to 9.0.0 + +#### Az.DataProtection 1.1.0 +* Added support for Immutable backup vaults +* Added Cross subscription restore flag for backup vaults +* Added Soft delete setting for backup vaults +* Fixed issue with Set-AzDataProtectionMSIPermission command +* Replaced Get-InstalledModule with Get-Module -ListAvailable +* Added New-AzDataProtectionSoftDeleteSettingObject command + +#### Az.EventHub 3.2.1 +* Fixed 'New-AzEventHubAuthorizationRuleSASToken' cmdlet which was returning wrong skn value + +#### Az.Monitor 4.4.1 +* Removed default value for time window for autoscale profile [#20660] + * 'Get-AzAutoscaleSetting' + * 'New-AzAutoscaleSetting' + +#### Az.Network 5.4.0 +* Fixed a bug that does not enable to set Perform SNAT to Always +* Fixed the incorrect type of '-TotalBytesPerSession' in 'New-AzNetworkWatcherPacketCapture' + +#### Az.RecoveryServices 6.2.0 +* Added support for enable/disable Public Network Access and PrivateEndpoints +* Added support for Immutable Vaults +* Added support for RetainRecoveryPointsAsPerPolicy in Disable-AzRecoveryServicesBackupProtection cmdlet. Now user can suspend backups and retain RPs as per policy +* Added List Recovery Point expiry time +* Added RecoveryServices, RecoveryServices.Backup, RecoveryServices.Backup.CrossRegionRestore management SDK +* Added support for non-UTC time zones with standard policy for workloadType IaasVM, MSSql, AzureFiles + +#### Az.RedisCache 1.7.1 +* Updated 'Get-AzRedisCacheLink' and 'New-AzRedisCacheLink' to print 'PrimaryHostName', 'GeoReplicatedPrimaryHostName', 'ServerRole', and 'LinkedRedisCacheLocation'. + +#### Az.Resources 6.5.2 +* Fixed query issue when objectId in assignment is empty for 'Get-DenyAssignment' +* Fixed an issue where running deployment cmdlets with '-WhatIf' throws exception when formatting results with nested array changes + +#### Az.Sql 4.3.0 +* Added an optional parameter 'HAReplicaCount' to 'Restore-AzSqlDatabase' +* Added new cmdlets for managed instance DTC + 'Get-AzSqlInstanceDtc' + 'Set-AzSqlInstanceDtc' +* Added 'TargetSubscriptionId' to 'Restore-AzSqlInstanceDatabase' in order to enable cross subscription restore +* Enabled support for UserAssignedManagedIdentity in Auditing +* Fixed WorkspaceResourceId parameter value in 'Set-AzSqlServerAudit' + +#### Az.StackHCI 1.4.2 +* Added Remote Support terms and conditions for HCI device types. +* Unified Resource Group support for both Azure Stack HCI and Arc for server resources. +* Enhanced error feedback and logging in the Register-AzStackHCI cmdlet. +* Bug fixes and improvements in Azure Arc for servers enablement in Register-AzStackHCI cmdlet. +* Improved parameter validations in the Register-AzStackHCI cmdlet. +* Enabled Managed System Identity (MSI) for Registration in Fairfax Cloud. +* Minor bug fixes and improvements. + +#### Az.Storage 5.4.0 +* Added a warning message for the upcoming breaking change when creating a Storage account + - 'New-AzStorageAccount' +* Removed the ValidateSet of StandardBlobTier parameter + - 'Copy-AzStorageBlob' + - 'Set-AzStorageBlobContent' + - 'Start-AzStorageBlobCopy' + +#### Az.TrafficManager 1.2.0 +* Added a new optional parameter 'AlwaysServe' for endpoints. + +### Thanks to our community contributors +* Arun Sabale (@Ar-Sa), Fix example 1 in Set-AzVirtualNetworkPeering.md (#20588) +* Hiroshi Yoshioka (@hyoshioka0128) + * Fixed typo "resouce group"→"resource group" (#20664) + * Typo "resouce group"→"resource group" (#20713) + +## 9.3.0 - January 2023 +#### Az.Accounts +* Supported Web Account Manager (WAM) as an opt-in interactive login experience. Enable it by 'Update-AzConfig -EnableLoginByWam True'. +* Optimized the mechanism for assembly loading. +* Enabled AzKeyStore with keyring in Linux. +* Fixed a typo in GetAzureRmContextAutosaveSetting.cs changing the cmdlet class name to GetAzureRmContextAutosaveSetting +* Removed survey on error message in 'Resolve-AzError'. [#20398] + +#### Az.Aks +* Added parameter '-EnableEncryptionAtHost' for 'New-AzAksCluster' and 'New-AzAksNodePool' +* Added parameter '-EnableUltraSSD' for 'New-AzAksCluster' and 'New-AzAksNodePool' +* Added parameter '-NodeKubeletConfig' for 'New-AzAksCluster', '-KubeletConfig' for 'New-AzAksNodePool' +* Added parameter '-NodeLinuxOSConfig' for 'New-AzAksCluster', '-LinuxOSConfig' and 'New-AzAksNodePool' +* Added parameter '-NodeMaxSurge' for 'New-AzAksCluster', '-MaxSurge' for 'New-AzAksNodePool' and 'Update-AzAksNodePool' +* Added parameter '-PPG' for 'New-AzAksCluster' and 'New-AzAksNodePool' +* Added parameter '-SpotMaxPrice' for 'New-AzAksNodePool' +* Added parameter '-EnableFIPS' for 'New-AzAksCluster' and 'New-AzAksNodePool' +* Added parameter '-AutoScalerProfile' for 'New-AzAksCluster' and 'Set-AzAksCluster' +* Added parameter '-GpuInstanceProfile' for 'New-AzAksCluster' and 'New-AzAksNodePool' +* Added parameter '-EnableUptimeSLA' for 'New-AzAksCluster' and 'Set-AzAksCluster' +* Added parameter '-EdgeZone' for 'New-AzAksCluster' + +#### Az.ApiManagement +* Updated description of ResourceId param 'New-AzApiManagementBackend' and 'Set-AzApiManagementBackend' cmdlet [#16868] + +#### Az.ApplicationInsights +* Enabled output object enumerating for 'Get-AzApplicationInsights' [#20225] + +#### Az.Automation +* Updated Example: Start-AzAutomationRunbook should pass ordered dictionary for parameters [#20408] + +#### Az.Batch +* Added new properties 'CurrentNodeCommunicationMode' (read only) and 'TargetCommunicationMode' of type 'NodeCommunicationMode' to 'PSCloudPool'. + - Valid values for 'NodeCommunicationMode': Default, Classic, Simplified + - When the 'PSCloudPool' is updated with a new 'TargetCommunicationMode' value, the Batch service will attempt to update the pool to the new value the next time the pool is resized down to zero compute nodes and back up. +* 'PSPrivateLinkServiceConnectionState''s 'ActionRequired' property required has been renamed to 'ActionsRequired'. The old property has been marked as obsolete, and now just returns the new property. This should not impact existing consumers. + +#### Az.Compute +* Removed the image 'Win2008R2SP1' from the list of available images and documentation. This image is no longer available on the backend so the client tools need to sync to that change. +* Fixed a bug for creating Linux VM's from SIG/Community Gallery Images +* Added 'ImageReferenceId' string parameter to the 'New-AzVmssConfig' cmdlet. This allows gallery image references to be added for the Confidential VM feature. +* Added 'SecurityEncryptionType' and 'SecureVMDiskEncryptionSet' string parameters to the 'Set-AzVmssStorageProfile' cmdlet for the Confidential VM feature. + +#### Az.ContainerRegistry +* Fixed bug in 'Get-AzContainerRegistryTag' to show correct tags [#20528] + +#### Az.Monitor +* Fixed bug for 'Remove-AzDataCollectionRuleAssociation' [#20207] +* Added support for test notifications cmdlets + * 'Test-AzActionGroup' +* Fixed start time parameter description of 'Get-AzActivityLog' [#20409] + +#### Az.Network +* Added samples for retrieving Private Link IP Configuration using 'New-AzApplicationGatewayPrivateLinkIpConfiguration' with fix [#20440] +* Added 'DdosProtectionPlan' property in 'AzPublicIpAddress' +* Updated mapping in 'AzPublicIpAddress' to always show/create DdosSettings +* Fixed a bug that added Ddos related properties when viewing PublicIpAddress and DdosProtectionPlan objects +* Fixed a Bug for Set-AzIpGroup cmdlet to support the '-WhatIf' parameter +* Fixed a Bug for 'Add-AzLoadBalancerFrontendIpConfig', 'Add-AzLoadBalancerProbeConfig', 'Add-AzLoadBalancerBackendAddressPoolConfig', 'Set-AzLoadBalancer', 'New-AzLoadBalancerRuleConfig', 'Remove-AzLoadBalancerInboundNatRuleConfig' cmdlets to support the '-WhatIf' parameter. [#20416] +* Fixed a bug for DestinationPortBehavior in 'Get-AzNetworkWatcherConnectionMonitor', 'New-AzNetworkWatcherConnectionMonitor' powershell command by adding this properties to get and set the DestinationPortBehavior information. [#15996] + +#### Az.RedisCache +* Added optional parameter 'PreferredDataArchiveAuthMethod' in 'Export-AzRedisCache' +* Added optional parameter 'PreferredDataArchiveAuthMethod' in 'Import-AzRedisCache' +* Added 4 additional properties for a geo replication link: 'PrimaryHostName', 'GeoReplicatedPrimaryHostName', 'ServerRole', and 'LinkedRedisCacheLocation'in 'Get-AzRedisCacheLink' and 'New-AzRedisCacheLink' + +#### Az.Resources +* Fixed issue introduced in previous fix for 'Set-AzPolicySetDefinition' InternalServerError when the initiative is too large [#20238], which will remove space in value. +* Fixed 'Get-AzRoleAssignment' BadRequest when scope is '/' [#20323] + +#### Az.SecurityInsights +* Fixed for 'Update-AzSentinelAlertRule' fails when using '-TriggerThreshold 0' [#20417] + +#### Az.Sql +* Added a parameter named 'UseIdentity' for 'Set-AzSqlServerAudit', 'Set-AzSqlDatabaseAudit', 'Set-AzSqlServerMSSupportAudit' +* Added 'IsManagedIdentityInUse' property to the output of 'Get-AzSqlServerMSSupportAudit' +* Added 'PreferredEnclaveType' parameter to 'New-AzSqlDatabase', 'Get-AzSqlDatabase' and 'Set-AzSqlDatabase' cmdlet + +#### Az.StackHCI +* Added support for arc extensions which depend on HCI cluster's IMDS endpoints. + +#### Az.Storage +* Return ListBlobProperties in blob list result + - 'Get-AzStorageBlob' +* Output AllowedCopyScope in get account result + - 'Get-AzStorageAccount' + +#### Az.Websites +* Fixed 'Import-AzWebAppKeyVaultCertificate' to use certificate naming convention same as portal [#19592] + +### Thanks to our community contributors +* Pavel Lyalyakin (@bahrep), New-AzDiskConfig.md: fixed a copy-pasto (#20514) +* Eugene Ogongo (@eugeneogongo), Update Images.json (#18654) +* Hiroshi Yoshioka (@hyoshioka0128), Typo "resouce"→"resource" (#20441) +* Paul Gledhill (@pmgledhill102), Spelling mistake 'Accpeted' (#20380) +* Cameron Sowder (@sowderca), Fixed typo in Get-AzContextAutosaveSetting class name: GetzureRmContextAutosaveSetting -> GetAzureRmContextAutosaveSetting (#20420) + +## 9.2.0 - December 2022 +#### Az.Accounts +* Enabled caching tokens when logging in with a client assertion. This fixed the incorrectly short lifespan of tokens. +* Upgraded target framework of Microsoft.Identity.Client to net461 [#20189] +* Stored 'ServicePrincipalSecret' and 'CertificatePassword' into 'AzKeyStore'. +* Updated the reference of Azure PowerShell Common to 1.3.67-preview. + +#### Az.Aks +* Bumped API version to 2022-09-01 +* Added parameter '-NodeOsSKU' for 'New-AzAksCluster' and parameter '-OsSKU' for 'New-AzAksNodePool' +* Added parameter '-Mode' for 'New-AzAksNodePool' and 'Update-AzAksNodePool' +* Added property '-NodeImageVersion' for the output of 'Get-AzAksNodePool'[#19893] +* Added parameter '-NodePoolLabel' for 'Set-AzAksCluster', '-NodeLabel' for 'New-AzAksNodePool' and 'Update-AzAksNodePool' +* Added parameter '-NodePoolTag' for 'New-AzAksCluster' and 'Set-AzAksCluster', '-Tag' for 'New-AzAksNodePool' and 'Update-AzAksNodePool' + +#### Az.ApplicationInsights +* Supported Workbook function. Below is the new cmdlet + * 'Get-AzApplicationInsightsMyWorkbook' + * 'Get-AzApplicationInsightsWorkbook' + * 'Get-AzApplicationInsightsWorkbookRevision' + * 'Get-AzApplicationInsightsWorkbookTemplate' + * 'New-AzApplicationInsightsMyWorkbook' + * 'New-AzApplicationInsightsWorkbook' + * 'New-AzApplicationInsightsWorkbookTemplate' + * 'New-AzApplicationInsightsWorkbookTemplateGalleryObject' + * 'Remove-AzApplicationInsightsMyWorkbook' + * 'Remove-AzApplicationInsightsWorkbook' + * 'Remove-AzApplicationInsightsWorkbookTemplate' + * 'Update-AzApplicationInsightsMyWorkbook' + * 'Update-AzApplicationInsightsWorkbook' + * 'Update-AzApplicationInsightsWorkbookTemplate' + +#### Az.Compute +* Fixed issue found for 'Set-AzVmssVMRunCommand' [#19985] +* Fixed 'Get-AzVm' cmdlet when parameter '-Status' is provided, return property 'OsName', 'OsVersion' and 'HyperVGeneration' +* Fixed 'New-AzVM' cmdlet when creating VM with bootdiagnostic storage causes exception 'Kind' cannot be null. + +#### Az.CosmosDB +* Added support for Cosmos DB Service related cmdlets. + +#### Az.DataFactory +* Updated ADF .Net SDK version to 8.0.0 + +#### Az.DataProtection +* Fixed spacing issues in Set-AzDataProtectionMSIPermission.ps1 + +#### Az.EventHub +* Added NamespaceV2 cmdlets for EventHub + +#### Az.KeyVault +* Fixed certificate export parameter issue in 'Add-AzKeyVaultKey' [#19623] +* Fixed CertificateString decoding issue in 'Import-AzKeyVaultCertificate' +* Shifted the location of key CVM release policy to GitHub [#19984] +* Added fallback logic (reading default CVM policy from a local copy) if fetching default CVM Policy from GitHub failed. + +#### Az.Monitor +* Fixed bug for 'New-AzActivityLogAlert' and 'Update-AzActivityLogAlert' [#19927] + +#### Az.Network +* Added optional parameters 'CustomBlockResponseStatusCode' and 'CustomBlockResponseBody' parameter to 'AzApplicationGatewayFirewallPolicySettings' +* Added a new cmdlet to get the application gateway waf manifest and rules + - 'Get-AzApplicationGatewayWafDynamicManifest' + +#### Az.RecoveryServices +* Added support for passing DiskEncryptionSetId for Cross region restore +* Fixed the pagination bug in 'Get-AzRecoveryServicesAsrProtectableItem' for the V2ARCM scenario. +* Fixed 'IncludeDiskId' property for 'New-ASRReplicationProtectedItem' cmdlet of H2A + +#### Az.Resources +* Added cmdlet 'Get-AzADOrganization' +* Fixed 'Set-AzPolicySetDefinition' InternalServerError when the initiative is too large [#20238] + +#### Az.ServiceBus +* Added NamespaceV2 cmdlets for ServiceBus. + +#### Az.SignalR +* Updated to API version 2022-08-01-preview + - Added support for custom domain. Added new cmdlets New-AzWebPubSubCustomCertificate, Get-AzWebPubSubCustomCertificate, Remove-AzWebPubSubCustomCertificate, New-AzWebPubSubCustomDomain, Get-AzWebPubSubCustomDomain, Remove-AzWebPubSubCustomDomain. + - Added support for event listeners in hub settings. Added new cmdlets New-AzWebPubSubEventHubEndpointObject, New-AzWebPubSubEventNameFilterObject. + +#### Az.StackHCI +* Enabled system-assigned identity on HCI cluster resource registration and repair registration flow. +* Added error message in the command Register-AzStackHCI if Arc is not enabled. +* Added default region confirmation prompt if the region is not mentioned in the command Register-AzStackHCI. +* Added general logging improvements. +* Added logic that skipping the Arc SPN permission check in Register-AzStackHCI if a customer doesn't have the required permissions to read Arc SPN credential. +* Added deprecation message for the command Test-AzStackHCIConnection. Customers can use Invoke-AzStackHciConnectivityValidation from the module AzStackHCI.EnvironmentChecker for connectivity verification tests. + +#### Az.Storage +* Supported MaxPageSize, Include, and Filter parameters for listing encryption scopes + - 'Get-AzStorageEncryptionScope' +* Supported excludePrefix, includeDeleted, and many new schema fields in Blob Inventory + - 'New-AzStorageBlobInventoryPolicyRule' + +#### Az.Synapse +* Added breaking change message for '-SparkConfigFilePath'. It will be deprecated around the middle of December. +* Updated 'New-AzSynapseSparkPool' and 'Update-AzSynapseSparkPool' to support for setting spark pool configuration artifact by '-SparkCongifuration'. '-SparkCongifuration' is an alternative of parameter '-SparkConfigFilePath'. + +#### Az.Websites +* Added Tag parameter for 'New-AzWebApp' and 'New-AzWebAppSlot' +* Fixed 'Set-AzWebApp' and 'Set-AZWebAppSlot' to rethrow exception when Service Principal/User doesn't have permission to list web app configuration. [#19942] + +### Thanks to our community contributors +* @Ajay1250, The example was using the wrong command (#20237) +* Hiroshi Yoshioka (@hyoshioka0128), Typo "resouce"→"resource" (#20321) +* Mats Estensen (@matsest), [Az.Tools.Installer]: Updates for a new minor/patch version (#20022) +* Matthew Burleigh (@mburleigh), fix typos (#20020) +* Mo Zaatar (@mzaatar), Change letter case in example of New-AzStorageBlobSASToken (#20018) +* @patchin404, Updates Enable-AzCdnCustomDomainCustomHttps Doc (#20165) +* Robin Malik (@robinmalik), Update New-AzADAppCredential.md (#20317) +* @SherrySahni, container name not supported with upper case (#20012) +* @sushil490023, Adding PS Cmdlets for Azure Automation Python3 operation (#19598) +* Thomas Pike (@thwpike), Typo Fix (#20087) + +## 9.1.0 - November 2022 +#### Az.Accounts +* Updated 'Get-AzSubscription' to retrieve subscription by Id rather than listed all the subscriptions from server if subscription Id is provided. [#19115] + +#### Az.CognitiveServices +* Updated CognitiveServices PowerShell to use 2022-10-01 version. + +#### Az.Compute +* Fixed EdgeZone does not pass to VM for 'New-AzVM' 'SimpleParameterSet' [#18978] +* Added 'ScriptFilePath' parameter set for 'Set-AzVMRunCommand' and 'Set-AzVmssVMRunCommand' to allow users to pass in the path of the file that has the run command script +* Added '-AsJob' optional parameter to 'Remove-AzVMExtension' cmdlet. +* Added '-EdgeZone' optional parameter for 'Get-AzComputeResourceSku' and 'New-AzSnapshotUpdateConfig' cmdlets. +* Added Disk Delete Optional parameters 'OsDisk Deletion Option' and 'Delete Option' to the 'Set-AzVmssStorageProfile' (OS Disk) and 'Add-AzVmssDataDisk' (Data Disk) +* Improved printed output for 'Get-AzComputeResourceSku' +* Updated 'Get-AzHost' cmdlet logic to return Host for '-ResourceId' parameterset. +* Added '-OSDiskSizeGB' optional parameter for 'Set-AzVmssStorageProfile'. +* Improved cmdlet description for 'Set-AzVM' and added examples. +* Updated property mapping for parameter 'Encryption' of 'New-AzGalleryImageVersion' +* Updated list format to display all VmssVmRunCommand properties for 'Get-AzVmssVmRunCommand' +* Updated 'Get-AzGallery', 'New-AzGallery', 'Update-AzGallery', 'Get-AzGalleryImageDefinition', 'Get-AzGalleryImageVersion', 'New-AzVm' and 'New-AzVmss' to support community galleries + +#### Az.Databricks +* Added 'RequiredNsgRule' parameter in the 'Update-AzDatabricksWorkspace'. + +#### Az.DataFactory +* Updated ADF .Net SDK version to 7.0.0 + +#### Az.DataProtection +* Fixed list parameter set for 'Get-AzDataProtectionBackupVault' + +#### Az.EventGrid +* Updated to use the 2022-06-15 API version. +* Added new features: + - Partner topics + - Partner topic event subscriptions + - Partner namespaces + - Partner namespace keys + - Partner configurations + - Partner registrations + - Verified partners + - Channels + +#### Az.EventHub +* Added readonly Status property in EventHub Namespace + +#### Az.Functions +* Added warning logs to detect Az context switching in Get-AzFunctionApp + +#### Az.KeyVault +* Bumped API version to 2022-07-01 +* Added 'Undo-AzKeyVaultManagedHsm' to recover deleted managed HSM + +#### Az.ManagedServiceIdentity +* Supported Create/Get/Update/Remove Federated Identity Credentials on a User Assigned Managed Identity + * 'Get-AzFederatedIdentityCredentials' + * 'New-AzFederatedIdentityCredentials' + * 'Remove-AzFederatedIdentityCredentials' + * 'Update-AzFederatedIdentityCredentials' +* Supported List Associated Resources on a User Assigned Managed Identity + * 'Get-AzUserAssignedIdentityAssociatedResource' + +#### Az.Migrate +* Added parameter 'CacheStorageAccountId' to 'Initialize-AzMigrateReplicationInfrastructure' +* Added support for OS Disk Swap and Test Migrate Subnet Selection + +#### Az.Network +* Added possible value 'LocalGateway' for parameter 'GatewayType' + - 'New-AzVirtualNetworkGateway' +* Exposed 'ExtendedLocation' and 'VNetExtendedLocationResourceId' for 'VirtualNetworkGateway' + - 'Get-AzVirtualNetworkGateway' +* Added new cmdlet to get firewall learned ip prefixes + * 'Get-AzFirewallLearnedIpPrefix' +* Fixed a bug that does not update firewall policy application, network and nat rules' descriptions even though description is provided via description parameter +* Updated 'New-AzIpConfigurationBgpPeeringAddressObject' to remove validate null or empty check for CustomAddress in Azure Virtual Network Gateway +* Updated 'New-AzVirtualNetworkGateway' to add validate null or empty check for CustomAddress in Azure Virtual Network Gateway +* Updated cmdlets to add new property of 'VirtualNetworkGatewayPolicyGroup' and 'VpnClientConnectionConfiguration' in Azure Virtual Network Gateway + * 'New-AzVirtualNetworkGateway' + * 'Set-AzVirtualNetworkGateway' +* Added new cmdlets to create + * 'New-AzVirtualNetworkGatewayPolicyGroup' + * 'New-AzVirtualNetworkGatewayPolicyGroupMember' + * 'New-AzVpnClientConnectionConfiguration' +* Added message in breaking change attribute to notify that load balancer sku default behavior will be changed + * 'New-AzLoadBalancer' +* Added cmdlet preview to notify customers to use default value or leave null for load balancer probe threshold property + * 'New-AzLoadBalancerProbeConfig' + * 'Set-AzLoadBalancerProbeConfig' + * 'Add-AzLoadBalancerProbeConfig' + +#### Az.RecoveryServices +* Added support for cross zonal restore for ZRS vaults for non-ZonePinned VM +* Fixed bug with Update-AzRecoveryServicesAsrProtectionContainerMapping +* Added new scenarios: EZ-to-AZ, EZ-to-AZ, EZ-to-EZ +* Removed 'VmName' from non A2A scenarios of 'New-AzRecoveryServicesAsrReplicationProtectedItem' as it is not applicable + +#### Az.Resources +* Fixed parameter 'Count' for + - Get-AzADApplication + - Get-AzADServicePrincipal + - Get-AzADUser +* Polished preview warning message for: + - Add-AzADGroupMember + - Get-AzADGroupMember + - Remove-AzADGroupMember +* Fixed a 'NullReferenceException' when deploying a JSON template using Bicep extensibility +* Added '-AsJob' to support running 'Register-AzResourceProvider' as a Job + +#### Az.Sql +* Added new cmdlets for CRUD operations on SQL server IPv6 Firewall rules + 'Get-AzSqlServerIpv6FirewallRule' + 'New-AzSqlServerIpv6FirewallRule' + 'Remove-AzSqlServerIpv6FirewallRule' + 'Set-AzSqlServerIpv6FirewallRule' +* StorageContainerSasToken parameter in the 'Start-AzSqlInstanceDatabaseLogReplay' cmdlet is now optional + +#### Az.StackHCI +* Supported WDAC compliant APIs +* Fixed module versions of dependent PS modules +* Updated Remote Support cmdlets to check device type between HCIv2 and AzureEdge + +#### Az.Storage +* Supported generate DataLakeGen2 Sas token with Encryption scope + - 'New-AzDataLakeGen2SasToken' +* Supported blob type conversions in sync blob copy + - 'Copy-AzStorageBlob' +* Supported create/upgrade storage account with Keyvault from another tenant and access Keyvault with FederatedClientId + * 'New-AzStorageAccount' + * 'Set-AzStorageAccount' +* Supported find blobs in a container with a blob tag filter sql expression + * 'Get-AzStorageBlobByTag' +* Migrated following Azure File dataplane cmdlets from 'Microsoft.Azure.Storage.File' to 'Azure.Storage.Files.Shares' + * 'Get-AzStorageFileHandle' + * 'Close-AzStorageFileHandle' + +#### Az.Websites +* Fixed 'Publish-AzWebApp' to use latest publish API when deploying war package [#19791] + +### Thanks to our community contributors +* @alekiv, Fix typo in Example 1 (#19727) +* Johan Vanneuville (@JohanVanneuville), Update New-AzGalleryApplicationVersion.md (#19858) +* Simon Bass (@nimsarr), Fix typos (#19912) +* @wooch82, Update New-AzApplicationInsightsContinuousExport.md (#19802) + +## 9.0.1 - October 2022 +#### Az.Accounts +* Upgraded Azure.Core to 1.25.0 and Azure.Identity to 1.6.1 +* Upgraded Microsoft.Identity.Client to 4.46.2 and Microsoft.Identity.Client.Extensions.Msal to 2.23.0 +* Upgraded Microsoft.ApplicationInsights to 2.13.1 +* [Breaking Change] Changed target framework of AuthenticationAssemblyLoadContext to netcoreapp3.1. +* [Breaking Change] Removed built-in environment of Azure Germany +* Supported tenant domain as input while using 'Connect-AzAccount' with parameter 'Tenant'. [#19471] +* Used the ArgumentCompleter attribute to replace the dynamic parameters of 'Get-AzContext'. [#18041] +* Fixed issue that module cannot be imported when required file is locked [#19624] + +#### Az.Advisor +* Bumped API version to 2020-01-01 + +#### Az.Aks +* [Breaking Change] Removed the alias 'Install-AzAksKubectl' of 'Install-AzAksCliTool'. + +#### Az.ApiManagement +* [Breaking Change] Changed the type of parameter 'Sku' from Enum to String in 'Add-AzApiManagementRegion', 'New-AzApiManagement' and 'Update-AzApiManagementRegion'. + +#### Az.Attestation +* [Breaking Change] Replaced 'New/Remove/Get-AzAttestation' with 'New/Remove/Get-AzAttestationProvider' +* Added 'Get-AzAttestationDefaultProvider' and 'Update-AzAttestationProvider' +* Upgraded API version from 2018-09-01-preview to 2020-10-01 + +#### Az.Automation +* Added cmdlets 'Remove-AzAutomationHybridRunbookWorker', 'Remove-AzAutomationHybridRunbookWorkerGroup', 'Set-AzAutomationHybridRunbookWorkerGroup', 'Get-AzAutomationHybridRunbookWorker', 'Get-AzAutomationHybridRunbookWorkerGroup', 'Move-AzAutomationHybridRunbookWorker', 'New-AzAutomationHybridRunbookWorker', 'New-AzAutomationHybridRunbookWorkerGroup' for Hybrid Runbook Worker group management. + +#### Az.Compute +* Added the 'TimeCreated' property to the Virtual Machine and Virtual Machine Scale Set models. +* Added Confidential VM functionality to multiple cmdlets. + * Added new parameter 'SecureVMDiskEncryptionSet' to cmdlet 'Set-AzDiskSecurityProfile'. + * Added new parameters 'SecureVMDiskEncryptionSet' and 'SecurityEncryptionType' to cmdlet 'Set-AzVMOSDisk'. +* Improved cmdlet descriptions and parameter descriptions for VM/VMSS creation. +* Added the 'BaseRegularPriorityCount' integer property to the following cmdlets: 'New-AzVmssConfig' and 'Update-AzVmssConfig' +* Added the 'RegularPriorityPercentage' integer property to the following cmdlets: 'New-AzVmssConfig' and 'Update-AzVmssConfig' +* Added Breaking Changes for Add-AzVMAdditionalUnattendContent and Get-AzGallery cmdlets +* Added '-DiskControllerType' property to the following cmdlets: 'New-AzVm', 'New-AzVmss', 'New-AzVmConfig', 'Set-AzVmssStorageProfile' + +#### Az.Databricks +* Upgraded API version to 2022-04-01-preview +* Modified description of 'EnableNoPublicIP' parameter in the 'New-AzDatabricksWorkspace'. [#14381] + +#### Az.DataFactory +* Updated ADF .Net SDK version to 6.4.0 + +#### Az.EventGrid +* Add remaining advanced filters + * StringNotContains + * StringNotBeginsWith + * StringNotEndsWith + * NumberInRange + * NumberNotInRange + * IsNullOrUndefined + * IsNotNull + +#### Az.EventHub +* Most cmdlets in Az.EventHub module have been migrated to a new format and would witness breaking changes. Please refer our migration guide https://go.microsoft.com/fwlink/?linkid=2204690 to know breaking changes in detail. + +#### Az.Functions +* Enabled support to create Node 18 Preview and Java 17 Preview function apps (fixes issues #19184 and #18925) +* Removed the logic that checks for AzureGermanCloud in the cloud endpoints (fixes issue #19667) +* Hided generated unused cmdlets (fixes #16666) + +#### Az.KeyVault +* Fixed the exception content swallowed issue when exception.Response is null [#19531] +* Added the existing parameters 'Exportable', 'Immutable', 'UseDefaultCVMPolicy', and 'ReleasePolicyPath' + to the parameter sets 'InteractiveCreate', 'InputObjectCreate', and 'ResourceIdCreate'. + +#### Az.MarketplaceOrdering +* Upgraded API version to 2021-01-01. + +#### Az.Migrate +* Updated ApiVersion to 2022-05-01 +* Added support for pause and resume + * 'Suspend-AzMigrateServerReplication' + * 'Resume-AzMigrateServerReplication' +* [Breaking Change] Removed unless cmdlets + * 'Get-AzMigrateReplicationEligibilityResult' + * 'Get-AzMigrateReplicationProtectionIntent' + * 'Get-AzMigrateReplicationVaultSetting' + * 'Get-AzMigrateSupportedOperatingSystem' + * 'New-AzMigrateReplicationProtectionIntent' + * 'New-AzMigrateReplicationVaultSetting' + +#### Az.Monitor +* [Breaking Change] Upgraded API version for ActivityLogAlert from 2017-04-01 to 2020-10-01, affected cmdlets: + * 'Get-AzActivityLogAlert' + * 'Remove-AzActivityLogAlert' + * 'Set-AzActivityLogAlert' replaced by 'New-AzActivityLogAlert' + * 'Disable-AzActivityLogAlert' replaced by 'Update-AzActivityLogAlert' + * 'Enable-AzActivityLogAlert' replaced by 'Update-AzActivityLogAlert' + * 'New-AzActionGroup' replaced by 'New-AzActivityLogAlertActionGroupObject' +* [Breaking Change] Upgraded API version for DiagnosticSetting from 2017-05-01-preview to 2021-05-01-preview + * 'Get-AzDiagnosticSettingCategory' + * 'Get-AzDiagnosticSetting' + * 'New-AzDiagnosticSetting' + * 'Remove-AzDiagnosticSetting' + * 'Set-AzDiagnosticSetting' replaced by 'New-AzDiagnosticSetting' + * 'New-AzDiagnosticDetailSetting' replaced by 'New-AzDiagnosticSettingLogSettingsObject' and 'New-AzDiagnosticSettingMetricSettingsObject' + * 'Get-AzSubscriptionDiagnosticSettingCategory' replaced by 'Get-AzEventCategory' +* [Breaking Change] Upgraded API version for Autoscale from 2015-04-01 to 2022-10-01 + * 'Get-AzAutoscaleSetting' + * 'Remove-AzAutoscaleSetting' + * 'Add-AzAutoscaleSetting' replaced by 'New-AzAutoscaleSetting' + * 'New-AzAutoscaleNotification' replaced by 'New-AzAutoscaleNotificationObject' + * 'New-AzAutoscaleProfile' replaced by 'New-AzAutoscaleProfileObject' + * 'New-AzAutoscaleRule' replaced by 'New-AzAutoscaleScaleRuleObject' + * 'New-AzAutoscaleWebhook' replaced by 'New-AzAutoscaleWebhookNotificationObject' +* [Breaking Change] Upgraded API version for ScheduledQueryRule from 2018-04-16 to 2021-08-01 + * 'Get-AzScheduledQueryRule' + * 'New-AzScheduledQueryRuleAlertingAction' + * 'New-AzScheduledQueryRuleAznActionGroup' + * 'New-AzScheduledQueryRule' + * 'New-AzScheduledQueryRuleLogMetricTrigger' + * 'New-AzScheduledQueryRuleSchedule' + * 'New-AzScheduledQueryRuleSource' + * 'New-AzScheduledQueryRuleTriggerCondition' + * 'Remove-AzScheduledQueryRule' + * 'Set-AzScheduledQueryRule' + * 'Update-AzScheduledQueryRule' + +#### Az.MySql +* Added 'PublicNetworkAccess' to 'Update-AzMySqlServer' [#19189] + +#### Az.Network +* Added a new endpoint switch 'AzureArcVM' in 'New-AzNetworkWatcherConnectionMonitor' +* Updated 'New-AzVirtualNetworkGatewayConnection' to support bypassing the ExpressRoute gateway when accessing private-links +* Updated 'Update-AzCustomIpPrefix' to support no-internet advertise CustomIpPrefix +* Updated 'New-AzNetworkInterface' to support create/update nic with DisableTcpStateTracking property +* Updated cmdlet to support specifying a VirtualRouterAsn on Virtual Hub + * 'New-AzVirtualHub' + * 'Update-AzVirtualHub' +* Updated cmdlet to support specifying an ASN on VPN Gateway + * 'New-AzVpnGateway' + * 'Update-AzVpnGateway' +* Updated 'New-AzRoutingConfiguration' to support bypassing NVA for spoke vNet traffic +* Updated 'Update-AzCustomIpPrefix' to support new parameters: Asn, Geo, ExpressRouteAdvertise +* Updated cmdlets to enable verification on client certificate revocation by using a new property VerifyClientRevocation in ApplicationGatewayClientAuthConfiguration + * 'New-AzApplicationGatewayClientAuthConfiguration' + * 'Set-AzApplicationGatewayClientAuthConfiguration' +* Updated 'New-AzCustomIpPrefix' to support IPv4 Parent/Child CustomIpPrefix creation. +* Added Uppercase Transform in New-AzApplicationGatewayFirewallCondition +* Added DdosProtectionMode parameter in New-AzPublicIpAddress +* Added ProbeThreshold parameter to Load Balancer Probe + * 'Add-AzLoadBalancerProbeConfig' + * 'New-AzLoadBalancerProbeConfig' + * 'Set-AzLoadBalancerProbeConfig' +* Updated 'New-AzApplicationGatewayFirewallPolicyManagedRuleOverride' to support specifying an action for a managed rule override in Application Gateway WAF Policy +* Added breaking change enum values/notification for the following network manager cmdlets + * 'Deploy-AzNetworkManagerCommit' + * 'New-AzNetworkManagerConnectivityConfiguration' + * 'New-AzNetworkManagerConnectivityGroupItem' + * 'New-AzNetworkManagerSecurityAdminRule' + * 'New-AzNetworkManagerSecurityAdminConfiguration' + * 'New-AzNetworkManagerAddressPrefixItem' + * 'New-AzNetworkManager' +* Added 'EnableUDPLogOptimization' parameter to 'New-AzFirewall' +* Fixed a bug that does not return HubIPAddresses and PrivateIPAddress during a Get-AzFirewall command +* Replaced 'IdentifyTopFatFlow' parameter with 'EnableFatFlowLogging' parameter to 'New-AzFirewall' +* Fixed a bug not able to add MSSQL application rules to an AZURE FIREWALL POLICY +* Onboard Project AzureML Registries to Private Link Common Cmdlets + +#### Az.RecoveryServices +* [Breaking Change] Added fix for Enable-AzRecoveryServicesBackupProtection cmdlet. Resolved the null reference issue by making policy a mandatory parameter. +* [Breaking Change] Removed status filter from Get-AzRecoveryServicesBackupContainer command +* Added SubTasks Duration for IaasVM job + +#### Az.Resources +* Fixed NullReferenceException issue in 'New-AzRoleAssignment' [#19793] + +#### Az.SecurityInsights +* Changed 'Az.SecurityInsights' to autorest-based module + +#### Az.ServiceBus +* Most cmdlets in Az.ServiceBus module have been migrated to a new format and would witness breaking changes. Please refer our migration guide https://go.microsoft.com/fwlink/?linkid=2204584 to know breaking changes in detail. + +#### Az.Sql +* Added new fields to the 'Get-AzSqlInstanceDatabaseLogReplay' cmdlet +* Improved error handling in the 'Stop-AzSqlInstanceDatabaseLogReplay' cmdlet +* Added StorageContainerIdentity parameter in the 'Start-AzSqlInstanceDatabaseLogReplay' cmdlet +* Removed the following cmdlets: 'Clear-AzSqlServerAdvancedThreatProtectionSetting' and 'Clear-AzSqlDatabaseAdvancedThreatProtectionSetting' +* Added the following cmdlets: 'Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting', 'Get-AzSqlInstanceAdvancedThreatProtectionSetting', 'Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting' and 'Update-AzSqlInstanceAdvancedThreatProtectionSetting' +* Removed the following aliases: 'Enable-AzSqlServerAdvancedThreatProtection', 'Disable-AzSqlServerAdvancedThreatProtection', 'Get-AzSqlServerThreatDetectionSetting', 'Remove-AzSqlServerThreatDetectionSetting', 'Set-AzSqlServerThreatDetectionSetting', 'Get-AzSqlDatabaseThreatDetectionSetting', 'Set-AzSqlDatabaseThreatDetectionSetting' and 'Remove-AzSqlDatabaseThreatDetectionSetting' +* Changed the returned object for the following cmdlets: 'Get-AzSqlServerAdvancedThreatProtectionSetting' and 'Get-AzSqlDatabaseAdvancedThreatProtectionSetting' +* Changed the parameters for the following cmdlets: 'Update-AzSqlServerAdvancedThreatProtectionSetting' and 'Update-AzSqlDatabaseAdvancedThreatProtectionSetting'. Only 'Enable' parameter is now supported. +* Changed endpoint used in SQL Server and SQL Instance from AD Graph to MS Graph + +#### Az.StackHCI +* Made GraphAccessToken parameter obsolete in Register-AzStackHCI, Unregister-AzStackHCI and Set-AzStackHCI cmdlets. This is because Az.StackHCI module does not depend on Azure AD anymore. +* Include API version for all Microsoft.AzStackHCI related AZ-Resource calls + +#### Az.Storage +* Migrated following Azure File dataplane cmdlets from 'Microsoft.Azure.Storage.File 11.2.2' to 'Azure.Storage.Files.Shares 12.10.0' + * 'Get-AzStorageFile' + * 'Get-AzStorageFileCopyState' + * 'Get-AzStorageShare' + * 'Get-AzStorageShareStoredAccessPolicy' + * 'New-AzStorageDirectory' + * 'New-AzStorageFileSasToken' + * 'New-AzStorageShare' + * 'New-AzStorageShareSasToken' + * 'New-AzStorageShareStoredAccessPolicy' + * 'Remove-AzStorageDirectory' + * 'Remove-AzStorageFile' + * 'Remove-AzStorageShare' + * 'Remove-AzStorageShareStoredAccessPolicy' + * 'Set-AzStorageShareQuota' + * 'Set-AzStorageShareStoredAccessPolicy' + * 'Start-AzStorageFileCopy' + * 'Stop-AzStorageFileCopy' +* Migrated Get/List blob to always use 'Azure.Storage.Blobs' + * 'Get-AzStorageBlob' +* Fix create file sas failure with file object pipeline + * 'New-AzStorageFileSasToken' + +#### Az.Synapse +* [Breaking Change] Updated models of Synapse Link for Azure Sql Database +* Updated 'New-AzSynapseWorkspace' and 'Update-AzSynapseWorkspace' to support for user assigned managed identity (UAMI) by '-UserAssignedIdentityAction' and '-UserAssignedIdentityId' +* Added EnablePublicNetworkAccess parameter to 'New-AzureSynapseWorkspace' and 'Update-AzSynapseWorkspace' + +### Thanks to our community contributors +* Aliaksei Venski (@AliakseiVenski), Update New-AzServiceBusAuthorizationRuleSASToken.md (#19521) +* Jason (@moo2u2), Fixed multiple hostnames param for app gateway http listener (#19451) +* Jan-Hendrik Peters [MSFT] (@nyanhp), [Connect-AzConnectedMachine] Fixes error with return value processing (#19542) +* @rahulbissa2727, PS changes for Uppercase Transform (#19546) + +## 8.3.0 - September 2022 +#### Az.Accounts +* Supported returning all subscriptions with specified name while using 'Get-AzSubscription' with parameter 'SubscriptionName'. [#19295] +* Fixed null reference exception when cmdlet uses AzureRestOperation [#18104] +* Updated survey message and settings + +#### Az.Aks +* Added support of 'FQDN' in 'Import-AzAksCredential' [#17711] +* Added hint when 'Import-AzAksCredential' meets bad formatted kubernetes configuration file [#16741] +* Added parameter '-NodeResourceGroup' for 'New-AzAksCluster'. [#19014] +* Added support for 'Auto Upgrade' in 'New-AzAksCluster' and 'Set-AzAksCluster'. +* Added support for 'Http Proxy' in 'New-AzAksCluster' and 'Set-AzAksCluster'. +* Added parameter 'DisableLocalAccount' and 'DiskEncryptionSetID' in 'New-AzAksCluster' and 'Set-AzAksCluster'. +* Added logic for installing 'kubelogin' in 'Install-AzAksKubectl'. + +#### Az.ApiManagement +* Added warning message for upcoming breaking change: changed the type of parameter Sku from Enum to String +* Supported GraphQL Specification Format + +#### Az.AppConfiguration +* Added cmdlets 'Get-AzAppConfigurationDeletedStore' and 'Clear-AzAppConfigurationDeletedStore' +* Updated ApiVersion to 2022-05-01. + +#### Az.Automation +* Fixed bug: Export-AzAutomationRunbook no longer adds extra '\' to file names [#11101] +* Fixed bug: Get-AzAutomationDscCompilationJobOutput returns complete summaries [#12322] +* Fixed bug: Get-AzAutomationDscNode [#10404] +* Fixed bug: Get-AzAutomationJob fails for some jobIds + +#### Az.Batch +* Fixed a bug wherein creating a new JobSchedule does not properly submit Output Files. + +#### Az.Compute +* Added Trusted Launch Generic Breaking Change warning for 'New-AzVM', 'New-AzDisk' and 'New-AzVMSS' cmdlets. +* 'Get-AzVMRunCommand' now shows all the properties of VMRunCommand in a list format. +* Added new Parameter '-PublicIpSku' to the 'NewAzVM' cmdlet with acceptable values : 'Basic' and 'Standard'. +* Added Generic Breaking Change PublicIpSku Warning and Overridden '-Zone' logic when '-PublicIpSku' is explicitly provided. +* Added Disk Delete Optional parameters 'OsDisk Deletion Option' and 'Delete Option' to the 'Set-AzVmssStorageProfile' (OS Disk) and 'Add-AzVmssDataDisk' (Data Disk) +* Improved printed output for 'Get-AzComputeResourceSku' +* Updated 'Update-AzVm' to give constructive error messages when empty variables are passed in parameters. [#15081] +* Added 'Zone' and 'IntentVMSizeList' optional parameters to the cmdlet 'New-AzProximityPlacementGroup'. +* Added parameters to Gallery cmdlets for Community Galleries +* For 'New-AzGalleryImageVersion', 'CVMEncryptionType' and 'CVMDiskEncryptionSetID' added as keys for parameter '-Target'. + +#### Az.DesktopVirtualization +* Corrected parameter description of '-Force' in 'Remove-AzWvdUserSession'. + +#### Az.EventGrid +* Updated to use the 2021-12-01 API version. +* Added new features: + - System topic + - System topic event subscription + - System topic event subscription delivery attributes +* Updated cmdlets: + - 'New-AzEventGridDomain': + - Add new optional parameters to support auto creation of topic with first subscription. + - Add new optional parameters to support auto deletion of topic with last subscription. + - Add optional parameters to support azure managed identity + - 'New-AzEventGridTopic'/'Update-AzEventGridTopic' : + - Add optional parameters to support azure managed identity + - 'New-AzEventGridSubscription '/'Update-AzEventGridSubscription ': + - Add new optional parameters to support advanced filtering on arrays. + - Add new optional parameters to support delivery attribute mapping. + - Add new optional parameters to support storage queue message ttl. + +#### Az.EventHub +* In the upcoming major breaking change release in October 2022, Az.EventHub would be migrating most cmdlets to a new format +for a better powershell experience and as a result would witness breaking changes. Please refer our migration guide to know more https://go.microsoft.com/fwlink/?linkid=2204690. + +#### Az.Functions +* Made PowerShell 7.2 the default when creating a PowerShell function app + +#### Az.KeyVault +* Fixed parameter validation logic of '-UseDefaultCVMPolicy' +* Added parameter 'ContentType' in 'Import-AzKeyVaultCertificate' to support importing pem via certificate string +* Allowed 'DnsName' in 'New-AzKeyVaultCertificatePolicy' to accept an empty list [#18954] + +#### Az.MarketplaceOrdering +* Added a warning message for an upcoming breaking change to 'Get-AzMarketplaceTerms'. + +#### Az.Monitor +* Added breaking change warning messages for + - 'ActivityLogAlert' + - 'DiagnosticSetting' + - 'ScheduledQueryRule' + - 'Autoscale' + +#### Az.Network +* Added breaking change notification for 'Get-AzFirewall', 'New-AzFirewall', 'Set-AzFirewall' and 'New-AzFirewallHubIpAddress' + +#### Az.OperationalInsights +* Added new cmdlets for Table resource: 'New-AzOperationalInsightsRestoreTable', 'New-AzOperationalInsightsSearchTable', 'New-AzOperationalInsightsTable','Remove-AzOperationalInsightsTable','Update-AzOperationalInsightsTable', 'Convert-AzOperationalInsightsMigrateTable' +* Added new property 'DefaultDataCollectionRuleResourceId' to 'Set-AzOperationalInsightsWorkspace' and to 'New-AzOperationalInsightsWorkspace' cmdlets + +#### Az.PolicyInsights +* Updated parameter documentation for Get-AzPolicyState + +#### Az.RecoveryServices +* Added support for Archive smart tiering for AzureVM and MSSQL workloads. + +#### Az.Resources +* Fixed bug '-Password' overwrite '-PasswordProfile' in 'New-AzADUser' [#19265] +* Exposed 'EmployeeOrgData' 'Manager' for 'Get-AzADUSer' [#18205] +* Exposed parameter '-Count' for 'Get-AzADUser' [#16874] + +#### Az.ServiceBus +* In the upcoming major breaking change release in October 2022, Az.ServiceBus would be migrating most cmdlets to a new format +for a better powershell experience and as a result would witness breaking changes. Please refer our migration guide to know more https://go.microsoft.com/fwlink/?linkid=2204584. +* Added -MinimumTlsVersion to New-AzServiceBusNamespace and Set-AzServiceBusNamespace + +#### Az.Storage +* Supported to create or update Storage account with Azure Files Active Directory Domain Service Kerberos Authentication + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' +* Supported create/upgrade storage account by enable sftp and enable localuser + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' +* Supported manage local user of a storage account + - 'Set-AzStorageLocalUser' + - 'Get-AzStorageLocalUser' + - 'Remove-AzStorageLocalUser' + - 'New-AzStorageLocalUserSshPassword' + - 'Get-AzStorageLocalUserKey' + - 'New-AzStorageLocalUserSshPublicKey' + - 'New-AzStorageLocalUserPermissionScope' +* Supported soft delete DataLake Gen2 item + - 'Get-AzDataLakeGen2DeletedItem' + - 'Restore-AzDataLakeGen2DeletedItem' + +#### Az.Synapse +* Updated 'New-AzSynapseSparkPool' and 'Update-AzSynapseSparkPool' to support for setting spark pool dynamic executor allocation by '-EnableDynamicExecutorAllocation' + +#### Az.Websites +* Fixed 'Import-AzWebAppKeyVaultCertificate' to use certificate naming convention same as Az-CLI + +#### Thanks to our community contributors +* Harshit Aggarwal (@harshit283), Onboard EnergyServices to PrivatelinkCommonCmdlets (#19271) +* Jarrad O'Brien (@jarrad-obrien), typo (#19153) +* sravani saluru (@sravanisaluru), Update Set-AzSynapseSqlPoolAuditSetting.md (#18839) + +## 8.2.0 - August 2022 +#### Az.Accounts +* Implemented 'SupportsShouldProcess' for 'Invoke-AzRestMethod' +* Supported giving suggestions if an Azure PowerShell command cannot be found, for example when there is a typo in command name. + +#### Az.Aks +* Removed the warning messages for MSGraph migration [#18856] + +#### Az.Compute +* Added parameters 'PackageFileName', 'ConfigFileName' for 'New-AzGalleryApplicationVersion' + +#### Az.ConfidentialLedger +* General availability of 'Az.ConfidentialLedger' + +#### Az.EventHub +* Added -MinimumTlsVersion to New-AzEventHubNamespace and Set-AzEventHubNamespace +* Added -SupportsScaling to New-AzEventHubCluster and Set-AzEventHubCluster to support self serve clusters +* Deprecation warning on a few parameters in cluster cmdlets that will be deprecated in the November major release + +#### Az.KeyVault +* Removed the warning messages for MSGraph migration [#18856] + +#### Az.Migrate +* Fixed a cross-subscription issue + +#### Az.Network +* Updated cmdlets to add new property of 'ExplicitProxy' in Azure Firewall Policy. + - 'New-AzFirewallPolicyExplicitProxy' + - 'New-AzFirewallPolicy' + - 'Set-AzFirewallPolicy' +* Added new cmdlets to create packet captures for Network Watcher: + - 'New-AzNetworkWatcherPacketCaptureV2' + - 'New-AzPacketCaptureScopeConfig' +* Added support for CustomV2 ssl policies for Application Gateway. + - Added 'CustomV2' to the validation set of 'PolicyType' + - Added 'TLSv1_3' to the validation set of 'MinProtocolVersion' + - Removed validation for null or empty cipher suites list since there can be empty cipher suites list for min protocol version of tls1.3 +* Network Watcher Feature Change: Added new paramenter i.e. AzureVMSS as source endpoint in ConnectionMonitor. + - 'New-AzNetworkWatcherConnectionMonitorEndpointObject' +* Added 'IdentifyTopFatFlow' parameter to 'AzureFirewall' + - 'New-AzFirewall' +* Enabled Azure Firewall forced tunneling by default (AzureFirewallManagementSubnet and ManagementPublicIpAddress are required) whenever basic sku firewall is created. + - 'New-AzFirewall' +* Fixed bug that causes an overflow due to incorrect SNAT private ranges IP validation. +* Added new cmdlets to create/manage L4(TCP/TLS) objects for ApplicationGateway: + - 'Get-AzApplicationGatewayListener' + - 'New-AzApplicationGatewayListener' + - 'Add-AzApplicationGatewayListener' + - 'Set-AzApplicationGatewayListener' + - 'Remove-AzApplicationGatewayListener' + - 'Get-AzApplicationGatewayBackendSetting' + - 'New-AzApplicationGatewayBackendSetting' + - 'Add-AzApplicationGatewayBackendSetting' + - 'Set-AzApplicationGatewayBackendSetting' + - 'Remove-AzApplicationGatewayBackendSetting' + - 'Get-AzApplicationGatewayRoutingRule' + - 'New-AzApplicationGatewayRoutingRule' + - 'Add-AzApplicationGatewayRoutingRule' + - 'Set-AzApplicationGatewayRoutingRule' + - 'Remove-AzApplicationGatewayRoutingRule' +* Updated cmdlet to add TCP/TLS Listener , BackendSetting , RoutingRule support for Application Gateway: + - 'New-AzApplicationGateway' +* Updated cmdlets to add TCP/TLS protocol support for Application gateway Health Probe configuration: + - 'Set-AzApplicationGatewayProbeConfig' + - 'Add-AzApplicationGatewayProbeConfig' + - 'New-AzApplicationGatewayProbeConfig' +* Updated cmdlets to add basic sku support on Azure Firewall and Azure Firewall Policy: + - 'New-AzFirewall' + - 'New-AzFirewallPolicy' + - 'Set-AzFirewallPolicy' +* Added new cmdlets to create/manage authorization objects for ExpressRoutePort: + - 'Add-AzExpressRoutePortAuthorization' + - 'Get-AzExpressRoutePortAuthorization' + - 'Remove-AzExpressRoutePortAuthorization' +* Added option parameter 'AuthorizationKey' to cmdlet 'New-AzExpressRouteCircuit' to allow creating ExpressRoute Circuit on a ExpressRoutePort with a different owner. +* Fixed bug that can't display CustomIpPrefix in PublicIpPrefix. +* Updated cmdlets to add new property of 'HubRoutingPreference' in VirtualHub and set property of 'PreferredRoutingGateway' deprecated . + - 'New-AzVirtualHub' + - 'Update-AzVirtualHub' +* Added optional parameter 'AuxiliaryMode' to cmdlet 'New-AzNetworkInterface' to enable this network interface as Sirius enabled. Allowed values are None(default) and MaxConnections. +* Multipool feature change: Updated cmdlets to add new optional property: 'ConfigurationPolicyGroups' object for associating policy groups. + - 'Update-AzVpnServerConfiguration' + - 'New-AzVpnServerConfiguration' +* Multipool feature change: Updated cmdlets to add new optional property: 'P2SConnectionConfiguration' object for specifying multiple Connection configurations. + - 'Update-AzP2sVpnGateway' + - 'New-AzP2sVpnGateway' +* Multipool feature change: Added new cmdlets to support CRUD of Configuration policy groups for VpnServerConfiguration. + - 'Get-AzVpnServerConfigurationPolicyGroup' + - 'New-AzVpnServerConfigurationPolicyGroup' + - 'Update-AzVpnServerConfigurationPolicyGroup' + - 'Remove-AzVpnServerConfigurationPolicyGroup' +* Added new cmdlets for RoutingIntent child resource of VirtualHub. + -'Add-AzRoutingPolicy' + -'Get-AzRoutingPolicy' + -'New-AzRoutingPolicy' + -'Remove-AzRoutingPolicy' + -'Set-AzRoutingPolicy' + -'Get-AzRoutingIntent' + -'New-AzRoutingIntent' + -'Remove-AzRoutingIntent' + -'Set-AzRoutingIntent' +* Updated cmdlets to add new option of 'HubRoutingPreference' in RouteServer. + - 'New-AzRouteServer' + - 'Update-AzRouteServer' +* Fixed bug that can't parse CustomIpPrefixParent parameter from swagger to powershell. +* Added 'Any' operator in New-AzApplicationGatewayFirewallCondition +* Made properties 'ApplicationSecurityGroups' and 'IpConfigurations' for 'PrivateEndpoint' updatable in the cmdlet 'Set-AzPrivateEndpoint' +* Onboarded Device Update for IoT Hub to Private Link Common Cmdlets + +#### Az.RedisEnterpriseCache +* Upgraded API version to 2022-01-01 + +#### Az.Resources +* Removed the warning messages for MSGraph migration [#18856] +* [Breaking Change] Renamed cmdlet from '{}-AzADAppFederatedIdentityCredential' to '{}-AzADAppFederatedCredential' +* [Breaking Change] Renamed '-Id' to '-FederatedCredentialId' for + - 'Get-AzADAppFederatedCredential' + - 'Remove-AzADAppFederatedCredential' + - 'Update-AzADAppFederatedCredential' +* Upgraded API version from Beta to 1.0 + +#### Az.Sql +* Removed the warning messages for MSGraph migration [#18856] +* Moved SQL Server and SQL Instance from ActiveDirectoryClient to MicrosoftGraphClient +* Supported cross-subscription Failover Group creation using 'PartnerSubscriptionId' parameter in 'New-AzSqlDatabaseFailoverGroup' cmdlet + +#### Az.Storage +* Added check for storage account sas token is secured with the storage account key. + - 'New-AzStorageAccountSASToken' +* Supported Management Policy rule filter BlobIndexMatch + - Added a new cmdlet 'New-AzStorageAccountManagementPolicyBlobIndexMatchObject' + - Added a new parameter 'BlobIndexMatch' in 'New-AzStorageAccountManagementPolicyFilter' + +#### Az.Synapse +* Set 'ResourceGroupName' as optional for 'Set-AzSynapseSqlAuditSetting' cmdlet +* Added LastCommitId parameter to 'New-AzureSynapseGitRepositoryConfig' +* Fixed the issue that update spark pool version fail by 'Update-AzSynapseSparkPool' + +#### Az.Websites +* Fixed 'Publish-AzWebapp' to handle relative paths properly [#18028] + +### Thanks to our community contributors +* Harish Karthic (@hkarthik7), Updated parameter name from `-Type` to `-SkuName` (#18882) +* Oscar de Groot (@odegroot), Fix "save as pfx" example (#19003) +* @shiftychris, Update New-AzApplicationGatewayFirewallPolicyManagedRuleSet.md (#18972) + +## 8.1.0 - July 2022 +#### Az.Accounts +* Supported exporting and importing configurations by 'Export-AzConfig' and 'Import-AzConfig'. +* Fixed an issue that Az.Accounts may fail to be imported in parallel PowerShell processes. [#18321] +* Fixed incorrect access token [#18105] +* Upgraded version of Microsoft.Identity.Client for .NET Framework. [#18495] +* Fixed an issue that Az.Accounts failed to be imported if multiple environment variables, which only differ by case, are set. [#18304] + +#### Az.Aks +* Added parameter 'CommandContextAttachmentZip' for 'Invoke-AzAksRunCommand'. [#17454] +* Added ManagedIdentity support for Aks[#15656]. +* Added property 'PowerState' for the output of 'Get-AzAksCluster'[#18271] +* Updated the logic of 'Set-AzAksCluster' for parameter 'NodeImageOnly'. +* Added parameter 'NodeImageOnly' for 'Update-AzAksNodePool'. +* Added parameter 'AvailabilityZone' for 'New-AzAksCluster'. [#18658] + +#### Az.ApplicationInsights +* Fixed parameters for Set-AzApplicationInsightsDailyCap [#18315] +* Fixed parameter 'DocumentType' for 'New-AzApplicationInsightsContinuousExport' and 'Set-AzApplicationInsightsContinuousExport' [#18350] +* Fixed parameter 'ResourceId' for 'Get-AzApplicationInsights' [#18707] + +#### Az.Compute +* Added image alias 'Win2022AzureEditionCore' +* Added the '-DisableIntegrityMonitoring' switch parameter to the 'New-AzVM' cmdlet. + Changed the default behavior for 'New-AzVM' and 'New-AzVmss' when these conditions are met: + 1) '-DisableIntegrityMonitoring' is not true. + 2) 'SecurityType' on the SecurityProfile is 'TrustedLaunch'. + 3) 'VTpmEnabled' on the SecurityProfile is true. + 4) 'SecureBootEnabled' on the SecurityProfile is true. + Now 'New-AzVM' will install the 'Guest Attestation' extension to the new VM when these conditions are met. + Now 'New-AzVmss' will install the 'Guest Attestation' extension to the new Vmss when these conditions are met and installed to all VM instances in the Vmss. +* Added '-UserAssignedIdentity' and '-FederatedClientId' to the following cmdlets: + - 'New-AzDiskEncryptionSetConfig' + - 'Update-AzDiskEncryptionSet' +* Added '-TreatFailureAsDeploymentFailure' to cmdlets 'Add-AzVmGalleryApplication' and 'Add-AzVmssGalleryApplication' +* Removed Exceptions for when SinglePlacementGroup is set to true in 'OrchestrationMode' + +#### Az.CosmosDB +* Added support for partition key and id paths to be part of client encryption policy. +* Fixed bug related to Update-AzCosmosDBSqlContainer command on containers with Client Encryption Policy. + +#### Az.DataFactory +* Updated ADF .Net SDK version to 6.3.0 + +#### Az.EventHub +* Added cmdlets for CRUD operations on EventHub Application Groups. The added cmdlets include, + -New-AzEventHubApplicationGroup + -Set-AzEventHubApplicationGroup + -Remove-AzEventHubApplicationGroup + -Get-AzEventHubApplicationGroup + -New-AzEventHubThrottlingPolicyConfig +* Get-AzEventHubNamespace returned a maximum of 100 namespaces for list by resource groups or list by subscriptions so far. From here onwards, for resource groups and subscriptions with over a 100 namespaces, the cmdlet will return all the namespaces. You will not see a change in the cmdlet behaviour if your resource groups or subscriptions have less than a 100 namespaces. +* Added cmdlets for manual approval of EventHubs Private Endpoint Connections. The added cmdlets include, + -Approve-AzEventHubPrivateEndpointConnection + -Deny-AzEventHubPrivateEndpointConnection + -Get-AzEventHubPrivateEndpointConnection + -Remove-AzEventHubPrivateEndpointConnection + -Get-AzEventHubPrivateLink + +#### Az.KeyVault +* Supported importing pem certificate by 'Import-AzKeyVaultCertificate' [#18494] +* Supported accepting rotation policy in a JSON file +* [Breaking Change] Changed parameter 'ExpiresIn' in 'Set-AzKeyVaultKeyRotationPolicy' from TimeSpan? to string. It must be an ISO 8601 duration like 'P30D' for 30 days. +* [Breaking Change] Changed output properties 'ExpiresIn', 'TimeAfterCreate' and 'TimeBeforeExpiry' of 'Set-AzKeyVaultKeyRotationPolicy' and 'Get-AzKeyVaultKeyRotationPolicy' from TimeSpan? to string. +* Supported creating/updating key with release policy in a Managed HSM +* Removed default value for 'EnabledForDeployment', 'EnabledForTemplateDeployment', 'EnabledForDiskEncryption' and 'EnableRbacAuthorization' during the process of key vault creation +* Changed default access policies for Key Vault secret, certificate and storage as 'All' + +#### Az.Network +* Added support for CustomV2 ssl policies for Application Gateway. + - Added 'CustomV2' to the validation set of 'PolicyType' + - Added 'TLSv1_3' to the validation set of 'MinProtocolVersion' + - Removed validation for null or empty cipher suites list since there can be empty cipher suites list for min protocol version of tls1.3 +* [Breaking Change] Changed default value of '-PrivateEndpointNetworkPoliciesFlag' to 'Disabled' in 'Add-AzVirtualNetworkSubnetConfig' and 'New-AzVirtualNetworkSubnetConfig' +* Fixed bugs that cannot parse virtual network encryption paramemters when updating exsiting vnet. + +#### Az.PowerBIEmbedded +* Updated SKU allowed values to support A7 and A8 + +#### Az.RecoveryServices +* Fixed delay in long running operations [#18567] + +#### Az.Resources +* Added feedback when deleting role assignments even if passthru is not used +* Fixed relative path failure in -AsJob scenario [#18084] +* Fixed logic of 'createtime' and 'ChangedTime' in 'Get-AzResource --ExpandProperties'. [#18206] +* Fixed role assignment latency for 'New-AzADServicePrincipal' [#16777] + +#### Az.ServiceBus +* Added cmdlets for manual approval of Service Bus Private Endpoint Connections. The added cmdlets include, + -Approve-AzServiceBusPrivateEndpointConnection + -Deny-AzServiceBusPrivateEndpointConnection + -Get-AzServiceBusPrivateEndpointConnection + -Remove-AzServiceBusPrivateEndpointConnection + -Get-AzServiceBusPrivateLink + +#### Az.ServiceFabric +* Fixed typo in verbose log message. +* Added Tag support for managed cluster create and update + +#### Az.Sql +* Added 'GeoZone' option to 'BackupStorageRedundancy' parameter to 'New-AzSqlDatabase', 'Set-AzSqlDatabase', 'New-AzSqlDatabaseCopy', 'New-AzSqlDatabaseSecondary', and 'Restore-AzSqlDatabase' to enable create, update, copy, geo secondary and PITR support for GeoZone hyperscale databases +* Added additional input validation to 'Stop-AzSqlInstanceDatabaseLogReplay' cmdlet to ensure the target database was created by log replay service +* Bug fix for cmdlet 'Restore-AzSqlDatabase'. The optional property 'Tags' was not working as expected +* Added isManagedIdentityInUse get parameter for 'Get-AzSqlServerAudit' and 'Get-AzSqlDatabaseAudit' +* Added new cmdlet 'Set-AzSqlInstanceDatabase' + +#### Az.StackHCI +* Added support to Stack HCI Cluster +* Added support to Stack HCI Extension +* Added support to Stack HCI Arc Settings + +#### Az.Storage +* Supported BaseBlob DaysAfterCreationGreaterThan in Management Policy + - 'Add-AzStorageAccountManagementPolicyAction' + +### Thanks to our community contributors +* @ayeshurun, Update SKU allowed values for PowerBI Embedded capacities (#18670) +* @JulianePadrao, [SQL] fix for deprecated term (#18620) +* @kaushik-ms, powershell changes for new ssl policies in appgw (#18287) +* Adrian Leonhard (@NaridaL), fix typo beging -> begin in 3 files (#18391) + +## 8.0.0 - May 2022 +#### Az.Accounts +* Added a preview feature allowing user to control the following configurations by using 'Get-AzConfig', 'Update-AzConfig' and 'Clear-AzConfig': + - 'DefaultSubscriptionForLogin': Subscription name or GUID. Sets the default context for Azure PowerShell when logging in without specifying a subscription. + - 'DisplayBreakingChangeWarning': Controls if warning messages for breaking changes are displayed or suppressed. + - 'EnableDataCollection': When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experience. +* Upgraded System.Reflection.DispatchProxy on Windows PowerShell [#17856] +* Upgraded Azure.Identity to 1.6.0 and Azure.Core to 1.24.0 + +#### Az.Aks +* Removed these aliases: + * 'Get-AzAks' + * 'New-AzAks' + * 'Set-AzAks' + * 'Remove-AzAks' + +#### Az.ApiManagement +* [Breaking change] Replaced parameter 'Sample' by 'Examples' in 'New-AzApiManagementOperation' and 'Set-AzApiManagementOperation' +* Updated APIM .Net SDK version to 8.0.0 / Api Version 2021-08-01 + +#### Az.ApplicationInsights +* Upgraded API version for ApplicationInsights component to 2020-02-02 +* Supported Log Analytics workspace-based component by 'New-AzApplicationInsights' and 'Update-AzApplicationInsights' + +#### Az.Cdn +* Upgraded API version to 2021-06-01 +* Removed deprecated cmdlets + - Disable-AzCdnCustomDomain + - Enable-AzCdnCustomDomain + - Get-AzCdnEdgeNodes + - Get-AzCdnProfileSsoUrl + - New-AzCdnDeliveryPolicy + - Set-AzFrontDoorCdnSecret +* Added new cmdlets + - Clear-AzFrontDoorCdnEndpointContent + - Get-AzFrontDoorCdnEndpointResourceUsage + - Get-AzFrontDoorCdnOriginGroupResourceUsage + - Get-AzFrontDoorCdnProfileResourceUsage + - Get-AzFrontDoorCdnRuleSetResourceUsage + - Test-AzFrontDoorCdnEndpointCustomDomain + - Test-AzFrontDoorCdnEndpointNameAvailability + - Test-AzFrontDoorCdnProfileHostNameAvailability + - Update-AzFrontDoorCdnCustomDomainValidationToken + - Update-AzFrontDoorCdnRule +* Renamed Set cmdlets to Update cmdlets +* Added 'Object' suffix to memory object creation cmdlets + +#### Az.Compute +* Edited 'New-AzVm' cmdlet internal logic to use the 'PlatformFaultDomain' value in the 'PSVirtualMachine' object passed to it in the new virtual machine. +* Added a new cmdlet named 'Restart-AzHost' to restart dedicated hosts. +* Added '-DataAccessAuthMode' parameter to the following cmdlets: + - 'New-AzDiskConfig' + - 'New-AzDiskUpdateConfig' + - 'New-AzSnapshotConfig' + - 'New-AzSnapshotUpdateConfig' +* Added '-Architecture' parameter to the following cmdlets: + - 'New-AzDiskConfig' + - 'New-AzDiskUpdateConfig' + - 'New-AzSnapshotConfig' + - 'New-AzSnapshotUpdateConfig' + - 'New-AzGalleryImageDefinition' +* Added '-InstanceView' parameter to 'Get-AzRestorePoint' +* Added parameter '-ScriptString' to 'Invoke-AzvmRunCommand' and 'Invoke-AzvmssRunCommand' +* Added parameter '-ScaleInPolicyForceDeletion' to 'Update-Azvmss' + +#### Az.ContainerRegistry +* Updated parameter types from bool to bool? for 'Update-AzContainerRegistryRepository' [#17857] + - 'ReadEnabled' + - 'ListEnabled' + - 'WriteEnabled' + - 'DeleteEnabled' + +#### Az.CosmosDB +* Introduced support for creating containers with Client Encryption Policy. The current supported version of Client Encryption Policy is 1. + +#### Az.DataFactory +* Updated ADF .Net SDK version to 6.1.0 +* Fixed Set-AzDataFactoryV2 -InputObject not correct with PublicNetworkAccess Parameter + +#### Az.EventHub +* Made 'IPRule' and 'VirtualNetworkRule' optional in 'Set-AzEventHubNetworkRuleSet'. +* Deprecated older MSI properties in 'Set-AzEventHubNamespace' and 'New-AzEventHubNamespace' + +#### Az.Functions +* Fixed an issue that New-AzFunctionApp cmdlet should write a warning message when setting default values for parameters that are not provided. + +#### Az.HealthcareApis +* Migrated module to generated codebase. +* Added cmdlets: + - New/Get/Update/Remove-AzHealthcareApisService + - New/Get/Update/Remove-AzHealthcareApisWorkspace + - New/Get/Update/Remove-AzHealthcareFhirService + - New/Get/Update/Remove-AzHealthcareDicomService + - New/Get/Update/Remove-AzHealthcareIoTConnector + - New/Get/Remove-AzHealthcareIotConnectorFhirDestination + - Get-AzHealthcareFhirDestination + +#### Az.KeyVault +* Added 'Rotate' into the list of permissions to keys [#17970] + +#### Az.ManagedServiceIdentity +* General availability of 'Az.ManagedServiceIdentity' + +#### Az.Network +* Supported 'Microsoft.Network/privateLinkServices' in 'Get-AzPrivateEndpointConnection' [#16984]. +* Provided friendly message if resource type is not supported for private endpoint connection features [#17091]. +* Added 'DisableIPsecProtection' to 'Virtual Network Gateway'. +* Added new cmdlets to create/manage authorization objects for ExpressRoutePort: + - 'Add-AzExpressRoutePortAuthorization' + - 'Get-AzExpressRoutePortAuthorization' + - 'Remove-AzExpressRoutePortAuthorization' +* Added option parameter 'AuthorizationKey' to cmdlet 'New-AzExpressRouteCircuit' to allow creating ExpressRoute Circuit on a ExpressRoutePort with a different owner. +* Fix bug that can't display CustomIpPrefix in PublicIpPrefix. +* Updated cmdlets to add new property of 'HubRoutingPreference' in VirtualHub and set property of 'PreferredRoutingGateway' deprecated . + - 'New-AzVirtualHub' + - 'Update-AzVirtualHub' +* Added optional parameter 'AuxiliaryMode' to cmdlet 'New-AzNetworkInterface' to enable this network interface as Sirius enabled. Allowed values are None(default) and MaxConnections. +* Multipool feature change: Updated cmdlets to add new optional property: 'ConfigurationPolicyGroups' object for associating policy groups. + - 'Update-AzVpnServerConfiguration' + - 'New-AzVpnServerConfiguration' +* Multipool feature change: Updated cmdlets to add new optional property: 'P2SConnectionConfiguration' object for specifying multiple Connection configurations. + - 'Update-AzP2sVpnGateway' + - 'New-AzP2sVpnGateway' +* Multipool feature change: Added new cmdlets to support CRUD of Configuration policy groups for VpnServerConfiguration. + - 'Get-AzVpnServerConfigurationPolicyGroup' + - 'New-AzVpnServerConfigurationPolicyGroup' + - 'Update-AzVpnServerConfigurationPolicyGroup' + - 'Remove-AzVpnServerConfigurationPolicyGroup' + +#### Az.RecoveryServices +* Added support for Multi-user authorization using Resource Guard for recovery services vault. +* Added support for cross subscription restore for recovery services vault, modified storage account to be fetched from target subscription. + +#### Az.Resources +* Added cmdlet for Application federated identity credential + - 'Get-AzADAppFederatedIdentityCredential' + - 'New-AzADAppFederatedIdentityCredential' + - 'Remove-AzADAppFederatedIdentityCredential' + - 'Update-AzADAppFederatedIdentityCredential' +* Upgraded and revised 'Get-AzLocation' cmdlet: + - Upgraded 'subscriptionClient' for 'Get-AzLocation'. Changed its apiVersion from 2016-01-01 to 2021-01-01.[#18002] + - Added all attributes of location info for 'Get-AzLocation', including 'pairedRegion' and so on. [#18045][#17536] + - Support ExtendedLocations by 'Get-AzLocation' [#18046] +* Added the following cmdlets to remain in parity with 2021-04-01 API version: + - 'New-AzHierarchySetting' + - 'Get-AzHierarchySetting' + - 'Update-AzHierarchySetting' + - 'Remove-AzHierarchySetting' + - 'Get-AzManagementGroupSubscription' + - 'Get-AzSubscriptionUnderManagementGroup' + - 'Start-AzTenantBackfill' + - 'Get-AzTenantBackfillStatus' + - 'Get-AzManagementGroupNameAvailability' + - 'Get-AzEntity' +* [Breaking Change] Renamed property `isSyncedFromOnPremis` to `isSyncedFromOnPremise` to align with API spec + +#### Az.Security +* Added new cmdlet: 'Get-AzSecuritySolution' +* Added Alerts Suppression Rules to cmdlets: + 'Get-AlertsSuppressionRule' + 'Remove-AlertsSuppressionRule' + 'Set-AlertsSuppressionRule' + 'New-AzAlertsSuppressionRuleScope' + +#### Az.ServiceBus +* Fixed miscellaneous network rule set typos across module. +* Add 'TrustedServiceAccessEnabled' to 'Set-AzServiceBusNetworkRuleSet' + +#### Az.Sql +* Added new cmdlet 'Get-AzSqlInstanceEndpointCertificate' +* Added parameter 'HighAvailabilityReplicaCount' to 'New-AzSqlElasticPool' and 'Set-AzSqlElasticPool' + +#### Az.Storage +* Supported generate Sas token for DataLakeGen2 + - 'New-AzDataLakeGen2SasToken' +* Showed OAuth token in debug log in debug build only + - 'New-AzStorageContext' +* Supported return more file properties when list Azure file + - 'Get-AzStorageFile' + +#### Az.Synapse +* Added support for Synapse Link for Azure Sql Database + - Added 'Get-AzSynapseLinkConnection' cmdlet + - Added 'Get-AzSynapseLinkConnectionDetailedStatus' cmdlet + - Added 'Set-AzSynapseLinkConnection' cmdlet + - Added 'Remove-AzSynapseLinkConnection' cmdlet + - Added 'Start-AzSynapseLinkConnection' cmdlet + - Added 'Stop-AzSynapseLinkConnection' cmdlet + - Added 'Set-AzSynapseLinkConnectionLinkTable' cmdlet + - Added 'Get-AzSynapseLinkConnectionLinkTable' cmdlet + - Added 'Get-AzSynapseLinkConnectionLinkTableStatus' cmdlet + - Added 'Update-AzSynapseLinkConnectionLandingZoneCredential' cmdlet +* Set 'UploadedTimestamp' when adding package to spark pool by 'Update-AzSynapseSparkPool' + +#### Az.Websites +* Updated 'Get-AzWebApp' and 'Get-AzWebAppSlot' to expose 'VirtualNetworkSubnetId' property [#18042] + +### Thanks to our community contributors +* @bb-froggy, Fixed dead link to the DCR Overview (#17998) +* Darryl van der Peijl (@DarrylvanderPeijl), Changing on-premise to on-premises (#17974) +* Hiroshi Yoshioka (@hyoshioka0128), Typo "Github Actions"→"GitHub Actions" (#18160) +* @misbamustaqim, Adding DisableIPsecProtection check(bool) to Virtual Network Gateway (#18029) +* Scott Tang (@scottwtang), Update documentation for Get-AzApiManagementSubscription cmdlet (#18027) +* @SnehaSudhirG, Update Get-AzAutomationScheduledRunbook.md (#18059) + +## 7.5.0 - April 2022 +#### Az.Accounts +* Upgraded Microsoft.Rest.ClientRuntime to 2.3.24 + +#### Az.Aks +* Updated the description of 'Force' in 'Invoke-AzAksRunCommand' [#17756] +* Fixed the issue that 'identity' cannot be piped into 'Set-AzAksCluster' [#17376] + +#### Az.ApiManagement +Added warning message for upcoming breaking change. + +#### Az.Batch +* Updated Az.Batch to use 'Microsoft.Azure.Batch' SDK version 15.3.0 + - Add ability to assign user-assigned managed identities to 'PSCloudPool'. These identities will be made available on each node in the pool, and can be used to access various resources. + - Added 'IdentityReference' property to the following models to support accessing resources via managed identity: + - 'PSAzureBlobFileSystemConfiguration' + - 'PSOutputFileBlobContainerDestination' + - 'PSContainerRegistry' + - 'PSResourceFile' + - 'PSUploadBatchServiceLogsConfiguration' + - Added new 'extensions' property to 'PSVirtualMachineConfiguration' on 'PSCloudPool' to specify virtual machine extensions for nodes + - Added the ability to specify availability zones using a new property 'NodePlacementConfiguration' on 'VirtualMachineConfiguration' + - Added new 'OSDisk' property to 'VirtualMachineConfiguration', which contains settings for the operating system disk of the Virtual Machine. + - The 'Placement' property on 'PSDiffDiskSettings' specifies the ephemeral disk placement for operating system disks for all VMs in the pool. Setting it to 'CacheDisk' will store the ephemeral OS disk on the VM cache. + - Added 'MaxParallelTasks' property on 'PSCloudJob' to control the maximum allowed tasks per job (defaults to -1, meaning unlimited). + - Added 'VirtualMachineInfo' property on 'PSComputeNode' which contains information about the current state of the virtual machine, including the exact version of the marketplace image the VM is using. + - Added 'RecurrenceInterval' property to 'PSSchedule' to control the interval between the start times of two successive job under a job schedule. + - Added a new 'Get-AzBatchComputeNodeExtension' command, which gets a specific extension by name, or a list of all extensions, for a given compute node. +* Updated Az.Batch'Microsoft.Azure.Management.Batch' SDK version 14.0.0. + - Added a new 'Get-AzBatchSupportedVirtualMachineSku' command, which gets the list of Batch-supported Virtual Machine VM sizes available at a given location. + - Added a new 'Get-AzBatchTaskSlotCount' command, which gets the number of task slots required by a given job. + - 'MaxTasksPerComputeNode' has been renamed to 'TaskSlotsPerNode', to match a change in functionality. + - 'MaxTasksPerComputeNode' will remain as an alias but will be removed in a coming update. + +#### Az.Cdn +* Added breaking change messages for all cmdlets in Az.CDN module + +#### Az.CognitiveServices +* Updated CognitiveServices PowerShell to use 2022-03-01 version. +* Added 'Get-AzCognitiveServicesAccountModel' cmdlet. + +#### Az.Compute +* Added '-ImageReferenceId' parameter to following cmdlets: 'New-AzVm', 'New-AzVmConfig', 'New-AzVmss', 'Set-AzVmssStorageProfile' +* Added functionality for cross-tenant image reference for VM, VMSS, Managed Disk, and Gallery Image Version creation. +* 'New-AzGallery' can take in '-Permission' parameter to set its sharingProfile property. +* 'Update-AzGallery' can update sharingProfile. +* 'Get-AzGallery' can take in '-Expand' parameter for expanded resource view. +* New parameter set for the following cmdlets to support Shared Image Gallery Direct Sharing + - Get-AzGallery + - Get-AzGalleryImageDefinition + - Get-AzGalleryImageVersion +* Updates and improvements to 'Add-AzVhd' + - Added '-DiskHyperVGeneration' and '-DiskOsType' parameters to the DirectUploadToManagedDisk parameter set for upload to more robust managed disk settings. + - Updated progress output functions so that it works with VHD files with '&' character in its name. + - Updated so that uploading dynamically sized VHD files are converted to fixed size during upload. + - Fixed a bug in uploading a differencing disk. + - Automatically delete converted/resized VHD files after upload. + - Fixed a bug that indicates '-ResourceGroupName' parameter as optional when it is actually mandatory. + +#### Az.ContainerInstance +* Supported empty directory volume and secret volume for creating container group [#17410] + +#### Az.DataFactory +* Updated ADF .Net SDK version to 6.0.0 + +#### Az.EventHub +* Deprecating older MSI related fields in New-AzEventHubNamespace and Set-AzEventHubNamespace + +#### Az.KeyVault +* Supported getting random number from managed HSM by 'Get-AzKeyVaultRandomNumber' +* Skipped subscription connection status validation for Az.KeyVault.Extension [#17712] +* Enabled public network access setting + +#### Az.Kusto +* Supported inline script resource (creation of script with content instead of sas token) +* Added managed identity support to EventGrid +* Added databaseRouting (Single/Multi) to all data connections +* Added PublicIPType to cluster + +#### Az.Network +* Fixed 'ArgumentNullException' in 'Add-AzureRmRouteConfig' when 'RouteTable.Routes' is null. + +#### Az.RecoveryServices +* Added support for multiple backups per day (hourly) Enhanced policy for workloadType AzureVM. + +#### Az.Resources +* Fixed redundant quotes in list pagination [#17667] +* Added cmdlet 'Update-AzADGroup' [#17514] +* Updated API version to beta for group member related cmdlet to allow service principal to be add, get and delete from group [#16698] +* Added parameter '-OwnedApplication' for 'Get-AzADApplication' to get applications owned by current user +* Added parameter '-Web' for 'Update-AzADApplication' [#16750] + +#### Az.Security +* Added new cmdlets for security Automations API + +#### Az.StackHCI +* Updated firewall rules for Attestation network to block all other traffic +* Updated cluster to ignore Attestation network + +#### Az.Storage +* Supported DaysAfterLastTierChangeGreaterThan in Management Policy + - 'Add-AzStorageAccountManagementPolicyAction' +* Fixed the issue that upload blob might fail on Linux [#17743] + - 'Set-AzStorageBlobContent' +* Supported AllowPermanentDelete when enable blob soft delete + - 'Enable-AzStorageBlobDeleteRetentionPolicy' +* Added breaking change warning message for upcoming cmdlet breaking change + - 'Get-AzStorageFile' + +#### Az.Synapse +* Added support for Synapse Azure Active Directory (Azure AD) only authentication + - Added 'Get-AzSynapseActiveDirectoryOnlyAuthentication' cmdlet + - Added 'Enable-AzSynapseActiveDirectoryOnlyAuthentication' cmdlet + - Added 'Disable-AzSynapseActiveDirectoryOnlyAuthentication' cmdlet + +#### Az.Websites +* Updated 'New-AzWebAppContainerPSSession' with CmdletDeprecation Attribute [#16646] +* Updated 'Restore-AzDeletedWebApp' to fix issue that prevents the cmdlet from working on hosts with a locale is anything different from 'en-US' + +### Thanks to our community contributors +* Aleksandar Nikolić (@alexandair), Fix the UniqueName property in the examples (#17826) +* @enevoj, Markup rendering issue? (#17732) +* @jeremytanyz, Update Set-AzStorageFileContent.md (#17805) +* Martin Bentancour (@mbentancour), Fix DateTime issue restoring deleted webapp (#16308) +* Preben Huybrechts (@pregress), Perform null check before accessing it (#16552) +* Ryan Buckman (@ryan-buckman), update example 1 command description to match the ApiRevision arg in code sample (#17741) + +## 7.4.0 - April 2022 +#### Az.Accounts +* Added 'SshCredentialFactory' to support get ssh credential of vm from msal. +* Fixed the bug of cmdlet fails when -DefaultProfile is set to service principal login context. [#16617] +* Fixed the issue that authorization does not work in Dogfood environment + +#### Az.AppConfiguration +* Added parameter 'PublicNetworkAccess' in 'New-AzAppConfigurationStore' and 'Update-AzAppConfigurationStore' + +#### Az.ApplicationInsights +* Added breaking change warnings for upcoming Az.ApplicationInsights 2.0.0 + +#### Az.Cdn +* Added breaking change messages for upcoming breaking change release of version 2.0.0 + +#### Az.Compute +* Updated 'New-AzVM' to create a new storage account for boot diagnostics if one does not exist. This will prevent the cmdlet from using a random storage account in the current subscription to use for boot diagnostics. +* Added 'AutomaticRepairAction' string parameter to the 'New-AzVmssConfig' and 'Update-AzVmss' cmdlets. +* Updated 'Get-AzVm' to include 'GetVirtualMachineById' parameter set. +* Edited the documentation for the cmdlet 'Set-AzVMADDomainExtension' to ensure the example is accurate. +* Improved description and examples for disk creation. +* Added new parameters to 'New-AzRestorePoint' and 'New-AzRestorePointCollection' for copying Restore Points and Restore Point Collections. +* Added 'Zone' and 'PlacementGroupId' Parameters to 'Repair-AzVmssServiceFabricUpdateDomain'. +* Edited 'New-AzVmss' logic to better check for null properties when the parameter 'OrchestrationMode' is used. + +#### Az.CosmosDB +* Introduced support for client encryption key resource management required for CosmosDB Client-Side Encryption by adding support for creating, updating and retrieving client encryption keys with following cmdlets: 'Get-AzCosmosDbClientEncryptionKey', 'New-AzCosmosDbClientEncryptionKey' and 'Update-AzCosmosDbClientEncryptionKey' + +#### Az.DataFactory +* Updated ADF .Net SDK version to 5.4.0 + +#### Az.Functions +* Exposed PowerShell 7.2 stack definition for function app creation in Functions V4 only + +#### Az.HDInsight +This release migrates Microsoft.Azure.Graph SDK to MicrosoftGraph SDK. + +#### Az.KeyVault +* Fixed a bug to continue visiting 'NextPageLink' when listing key vaults from ARM API + +#### Az.Network +* Added support for retrieving the state of packet capture even when the provisioning state of the packet capture was failure + - 'Get-AzNetworkWatcherPacketCapture' +* Added support for accepting Vnet, Subnet and NIC resources as the TargetResourceId for the following cmdlets + - 'Set-AzNetworkWatcherFlowLog' + - 'New-AzNetworkWatcherFlowLog' + +#### Az.OperationalInsights +* Removed capacity validation in new and update cluster cmdlets as validation exists on server side. +* Extended error message on base class for extended information. +* Bug fix - prevent exceptions while using StorageInsight cmdlets. +* Bug fix - when updating a cluster, it's SKU was set even if no value was passed. + +#### Az.PostgreSql +* Added parameter PublicNetworkAccess for PostgreSQL single server related cmdlets [#17263] + +#### Az.RecoveryServices +* Added support for Trusted VM backup and Enhanced policy for WorkloadType AzureVM. +* Added support for disabling hybrid backup security features in 'Set-AzRecoveryServicesVaultProperty' cmdlet. The feature can be re-enabled by setting 'DisableHybridBackupSecurityFeature' flag to False. + +#### Az.Resources +* Removed '-ApplicationId' from 'New-AzADServicePrincipal' 'SimpleParameterSet' [#17256] +* Added 'New-AzResourceManagementPrivateLink', and 'New-AzPrivateLinkAssociation' cmdlets +* Added authorization related cmdlets: + - 'Get-AzRoleAssignmentSchedule' + - 'Get-AzRoleAssignmentScheduleInstance' + - 'Get-AzRoleAssignmentScheduleRequest' + - 'Get-AzRoleEligibilitySchedule' + - 'Get-AzRoleEligibilityScheduleInstance' + - 'Get-AzRoleEligibilityScheduleRequest' + - 'Get-AzRoleEligibleChildResource' + - 'Get-AzRoleManagementPolicy' + - 'Get-AzRoleManagementPolicyAssignment' + - 'New-AzRoleAssignmentScheduleRequest' + - 'New-AzRoleEligibilityScheduleRequest' + - 'New-AzRoleManagementPolicyAssignment' + - 'Remove-AzRoleManagementPolicy' + - 'Remove-AzRoleManagementPolicyAssignment' + - 'Stop-AzRoleAssignmentScheduleRequest' + - 'Stop-AzRoleEligibilityScheduleRequest' + - 'Update-AzRoleManagementPolicy' +* Added 'Get-AzResourceManagementPrivateLink', 'Remove-AzResourceManagementPrivateLink', 'Get-AzResourceManagementPrivateLinkAssociation' and 'Remove-AzResourceManagementPrivateLinkAssociation' cmdlets + +#### Az.ServiceBus +* Fixed that 'New-AzServiceBusAuthorizationRuleSASToken' returns invalid token. [#12975] + +#### Az.ServiceFabric +* Added support for Ubuntu 20.04 vm image. + - This enables cluster operations with Ubuntu 20.04 vm image using AZ powershell. + +#### Az.Sql +* Added parameter 'ServicePrincipalType' to 'New-AzSqlInstance' and 'Set-AzSqlInstance' +* [Breaking change] Removed 'Get-AzSqlDatabaseTransparentDataEncryptionActivity' +* Added property 'CurrentBackupStorageRedundancy' and 'RequestedBackupStorageRedundancy' in the outputs of Managed Instance CRUD commands +* Added optional property 'Tag' to 'Restore-AzSqlDatabase' +* Added new cmdlets for managing Server Trust Certificates + - 'New-AzSqlInstanceServerTrustCertificate' + - 'Get-AzSqlInstanceServerTrustCertificate' + - 'Remove-AzSqlInstanceServerTrustCertificate' +* Added new cmdlets for managing Managed Instance Link + - 'New-AzSqlInstanceLink' + - 'Get-AzSqlInstanceLink' + - 'Remove-AzSqlInstanceLink' + - 'Set-AzSqlInstanceLink' +* Added support for DataWarehouse cross tenant and cross subscription restore operations to 'Restore-AzSqlDatabase' cmdlet + +#### Az.Storage +* Updated examples in reference documentation for 'Close-AzStorageFileHandle' +* Supported create storage context with customized blob, queue, file, table service endpoint + - 'New-AzStorageContext' +* Fixed copy blob failure on Premium Storage account, or account enabled hierarchical namespace + - 'Copy-AzStorageBlob' +* Supported create account SAS token, container SAS token, blob SAS token with EncryptionScope + - 'New-AzStorageAccountSASToken' + - 'New-AzStorageContainerSASToken' + - 'New-AzStorageBlobSASToken' +* Supported asynchronous blob copy run on new API version + - 'Start-AzStorageBlobCopy' +* Fixed IpRule examples in help + - 'Add-AzStorageAccountNetworkRule' + - 'Remove-AzStorageAccountNetworkRule' + - 'Update-AzStorageAccountNetworkRuleSet' + +#### Az.Synapse +* Upgraded Azure.Analytics.Synapse.Artifacts to 1.0.0-preview.14 +* Fixed the issue that following cmdlets only shows 100 entries + - 'Get-AzSynapseRoleAssignment' cmdlet + - 'Get-AzSynapsePipelineRun' cmdlet + - 'Get-AzSynapseTriggerRun' cmdlet + - 'Get-AzSynapseActivityRun' cmdlet +* Fixed the issue that there should be an error message when removing a dependency pipeline + +#### Az.Websites +* Fixed 'Set-AzWebAppSlot' to support MinTlsVersion version update [#17663] +* Fixed 'Set-AzAppServicePlan' to keep existing Tags when adding new Tags +* Fixed 'Set-AzWebApp','Set-AzWebAppSlot', 'Get-AzWebApp' and 'Get-AzWebAppSlot' to expose 'VnetRouteAllEnabled' property in 'SiteConfig' [#15663] +* Fixed 'Set-AzWebApp', 'Set-AzWebAppSlot', 'Get-AzWebApp' and 'Get-AzWebAppSlot' to expose 'HealthCheckPath' property in 'SiteConfig' [#16325] +* Fixed DateTime conversion issue caused by culture [#17253] +* Added support for the web job feature [#661] + - Get-AzWebAppContinuousWebJob + - Get-AzWebAppSlotContinuousWebJob + - Get-AzWebAppSlotTriggeredWebJob + - Get-AzWebAppSlotTriggeredWebJobHistory + - Get-AzWebAppSlotWebJob + - Get-AzWebAppTriggeredWebJob + - Get-AzWebAppTriggeredWebJobHistory + - Get-AzWebAppWebJob + - Remove-AzWebAppContinuousWebJob + - Remove-AzWebAppSlotContinuousWebJob + - Remove-AzWebAppSlotTriggeredWebJob + - Remove-AzWebAppTriggeredWebJob + - Start-AzWebAppContinuousWebJob + - Start-AzWebAppSlotContinuousWebJob + - Start-AzWebAppSlotTriggeredWebJob + - Start-AzWebAppTriggeredWebJob + - Stop-AzWebAppContinuousWebJob + - Stop-AzWebAppSlotContinuousWebJob + +### Thanks to our community contributors +* Axel B. Andersen (@Agazoth) + * Update Get-AzADUser.md (#17549) + * Added a new example (#17535) +* @davidslamb, Fix invalid SAS token from New-AzServiceBusAuthorizationRuleSASToken (#17349) +* elle (@elle24), Update Get-AzApplicationGatewayRequestRoutingRule.md (#17405) +* @enevoj, Update Get-AzDataCollectionRule.md (#17586) +* Felipe Guth de Freitas Bergstrom (@guthbergstrom), Update New-AzDatabricksWorkspace.md (#17472) +* @k0rtina, Update Set-AzConsumptionBudget.md (#17355) +* Kanika Gupta (@kangupt), Added example for New-AzVM +* Evgeniy Chuvikov (@snofe), Update Update-AzCosmosDBSqlDatabaseThroughput.md + +## 7.3.2 - March 2022 +#### Az.Accounts +* Changed target framework of AuthenticationAssemblyLoadContext to netcoreapp2.1 [#17428] + +#### Az.Compute +* Updated New-AzVM feature for 'vCPUsAvailable' and 'vCPUsPerCore' parameters. Cmdlets will not try to use the new 'VMCustomizationPreview' feature if the user does not have access to that feature. [#17370] + +## 7.3.0 - March 2022 +#### Az.Accounts +* Fixed the issue that authorization does not work in customized environment [#17157] +* Enabled Continue Access Evaluation for MSGraph +* Improved error message when login is blocked by AAD +* Improved error message when silent reauthentication failed +* Loaded System.Private.ServiceModel and System.ServiceModel.Primitives on Windows PowerShell [#17087] + +#### Az.Aks +* Updated the breaking change warning messages [#16805] + +#### Az.CloudService +* Fixed the issue of 'Get-AzCloudServiceNetworkInterface' and 'Get-AzCloudServicePublicIPAddress'. + +#### Az.Compute +* Upgraded Compute .NET SDK package reference to version 52.0.0 +* Updated 'New-AzSshKey' cmdlet to write file paths to generated keys to the Warning stream instead of the console. +* Added 'vCPUsAvailable' and 'vCPUsPerCore' integer parameters to the 'New-AzVm', 'New-AzVmConfig', and 'Update-AzVm' cmdlets. + +#### Az.ContainerInstance +* Fixed Identity Bug in ImageRegistryCredential + +#### Az.Databricks +* Upgraded API version to 2021-04-01-preview + +#### Az.DataFactory +* Updated ADF .Net SDK version to 5.2.0 + +#### Az.DataShare +* Added breaking change warning message due to update API version. + +#### Az.EventHub +* Added MSI properties to New-AzEventHubNamespace and Set-AzEventHubNamespace. Adding New-AzEventHubEncryptionConfig. + +#### Az.KeyVault +* 'New-AzKeyVaultManagedHsm': supported specifying how long a deleted managed hsm is retained by 'SoftDeleteRetentionInDays' and enabling purge protection by 'EnablePurgeProtection' +* 'Update-AzKeyVaultManagedHsm': supported enabling purge protection by 'EnablePurgeProtection' +* 'Get-AzKeyVaultManagedHsm': Supported getting or listing deleted managed HSM(s) +* 'Remove-AzKeyVaultManagedHsm': Supported purging a specified deleted managed HSM + +#### Az.Monitor +* Fixed an issue where users could not correctly ignore warning messages after setting environment variables [#17013] + +#### Az.Network +* Added new property 'SqlSetting' for Azure Firewall Policy cmdlets + - 'Get-AzFirewallPolicy' + - 'New-AzFirewallPolicy' + - 'Set-AzFirewallPolicy' +* Added new to create new 'SqlSetting' object for creating Azure Firewall Policy + - 'New-AzFirewallPolicySqlSetting' +* Added new cmdlet to support query Load Balancer inbound nat rule port mapping lists for backend addresses + - 'Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping' + - Also updated cmdlets to support inbound nat rule V2 configurations + - 'New-AzLoadBalancerInboundNatRuleConfig' + - 'Set-AzLoadBalancerInboundNatRuleConfig' + - 'Add-AzLoadBalancerInboundNatRuleConfig' + +#### Az.RecoveryServices +* Azure Backup added support for 'Create new virtual machine' and 'Replace existing virtual machine' experience for Managed VMs in Restore-AzRecoveryServicesBackupItem cmdlet. To perform a VM restore to AlternateLocation use TargetVMName, TargetVNetName, TargetVNetResourceGroup, TargetSubnetName parameters. To perform a restore to a VM in OriginalLocation, do not provide TargetResourceGroupName and RestoreAsUnmanagedDisks parameters, refer examples for more details. + +#### Az.Resources +* Fixed keycredential key format, from base64url to byte [#17131] +* Fixed add key credential overwrite existing one [#17088] +* Deleted parameter sets cannot be reached for 'New-AzADSericePrincipal' +* Marked 'ObjectType' as 'Unknown' if object is not found or current account has insufficient privileges to get object type for role assignment [#16981] +* Fixed that 'Get-AzRoleAssignment' shows empty RoleDefinitionName for custom roles when not specifying scope [#16991] +* Unified the returned 'RoleDefinitionId' in PSRoleAssignment to GUID [#16991] + +#### Az.ServiceBus +* Added identity and encryption properties to New-AzServiceBusNamespace and Set-AzServiceBusNamespace. +* Added New-AzServiceBusEncryptionConfig + +#### Az.Storage +* Supported download blob from managed disk account with Sas Uri and bearer token + - 'Get-AzStorageBlobContent' +* Supported create/upgrade storage account with ActiveDirectorySamAccountName and ActiveDirectoryAccountType + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' + +#### Az.StorageSync +* Migrated Azure AD features in Az.StorageSync to MSGraph APIs. The cmdlets will call MSGraph API according to input parameters: New-AzStorageSyncCloudEndpoint +* Changed default parameter set of Invoke-AzStorageSyncChangeDetection to use full share detection + +#### Az.Synapse +* Updated 'Update-AzSynapseSparkPool' to support new parameter [-ForceApplySetting] + +### Thanks to our community contributors +* Aleksandar Nikolić (@alexandair) + * Fix the StayProvisioned parameter (#17070) + * Fix a typo (#17069) +* Joel Greijer (@greijer), Clarified special case on TemplateParameterUri (#17004) +* Aman Sharma (@HarvestingClouds), Added Workload Type to the bullets to match the accepted values (#17041) +* @hsrivast, Hsrivastava/breaking change msg (#16985) +* Chris (@isjwuk), Update New-AzAutomationUpdateManagementAzureQuery.md (#16365) +* @MSakssharm, Returning error if insufficient user permissions are there for GetAgentRegistrationInfo (#16965) +* Emanuel Palm (@PalmEmanuel), New-AzSshKey should log to Warning stream instead of console (#16988) +* Pavel Safonov (@PSafonov), Fixed a typo in ManagedResourceGroupName parameter description (#17039) +* Michael Arnwine (@vsmike), Update New-AzApplicationGatewayRewriteRuleSet.md Description Text is incorrect (#17102) + +## 7.2.1 - February 2022 +#### Az.Resources +* Fixed `New-AzADServicePrincipal` not working [#17054] [#17040] + +## 7.2.0 - February 2022 +#### Az.Accounts +* Removed legacy assembly System.Private.ServiceModel and System.ServiceModel.Primitives [#16063] + +#### Az.Aks +* Fixed the typo in 'New-AzAksCluster' [#16733] + +#### Az.Compute +* Remove ProvisioningDetails property from PSRestorePoint object. +* Updated 'Set-AzVmExtension' cmdlet to properly display '-Name' and '-Location' parameters as mandatory. +* Edited 'New-AzVmssConfig' second example so it runs successfully by changing the Tag input to the correct format. +* Added 'Hibernate' parameter to 'Stop-AzVm' cmdlet. +* Added 'HibernationEnabled' parameter to 'New-AzVm', 'New-AzVmConfig', and 'Update-AzVm' cmdlets. +* Added 'EnableHotpatching' parameter to the 'Set-AzVmssOSProfile' cmdlet. +* Added 'ForceDeletion' parameter to Remove-AzVM and Remove-AzVMSS. + +#### Az.DataFactory +* Updated ADF .Net SDK version to 5.1.0 + +#### Az.EventHub +* Added public network access to the 'Set-AzEventHubNetworkRuleSet' set cmdlet +* Added 'New-AzEventHubSchemaGroup', 'Remove-AzEventHubSchemaGroup' and 'Get-AzEventHubSchemaGroup' in the eventhubs PS. + +#### Az.HealthcareApis +* HealthcareApis cmdlets will bump up API version which may introduce breaking change. Please contact us for more information. + +#### Az.KeyVault +* Improved the error message of Az.KeyVault.Extension [#16798] +* Added default access policies for Key Vault key as 'All but purge' +* Absorbed KeyOps from parameter when importing key from certificate on managed HSM [#16773] +* Fixed a bug when updating key operations on managed HSM [#16774] +* Fixed the issue when importing no-password certificate [#16742] + +#### Az.OperationalInsights +* Added logic to prevent exceptions while using 'StorageInsight' cmdlets. + +#### Az.PolicyInsights +* Added support for new remediation properties allowing the remediation of more resources with better control over the remediation rate and error handling +* Added support of fetching very large sets of results by internally using paginated API calls for policy states and policy events commands + +#### Az.RecoveryServices +* Reverted the configure backup per policy limit for VMs from 1000 to 100. This limit was previously relaxed but as Azure portal has a limit of 100 VMs per policy, we are reverting this limit. +* Added support for multiple backups per day for FileShares. +* Segregated some of the CRR and non-CRR flows based on the SDK update. +* Add EdgeZone parameter to Azure Site recovery service cmdlet 'New-AzRecoveryServicesAsrRecoveryPlan' + +#### Az.Resources +* Added proeprties 'onPremisesLastSyncDateTime', 'onPremisesSyncEnabled' to 'User' object [#16892] +* Added additional properties when creating request for 'New-AzADServicePrincipal' and 'Update-AzADServicePrincipal' [#16847] [#16841] +* Fixed 'DisplayName' and 'ApplicationId' for 'New-AzADAppCredential' [#16764] +* Enabled password reset for 'Update-AzADUser' [#16869] +* Updated parameter name 'EnableAccount' to 'AccountEnabled', and added alias 'EnableAccount' for 'Update-AzADUser' [#16753] [#16795] +* Fixed 'Set-AzPolicyAssignment' does not remove 'notScope' if empty [#15828] + +#### Az.ServiceBus +* Added support to Enable or Disable Public Network Access as optional parameter 'PublicNetworkAccess' to 'Set-AzServiceBusNetworkRuleSet' +* Fixed 'Set-AzServiceBusNamespace' with Tags + +#### Az.Sql +* Deprecation of Get-AzSqlDatabaseTransparentDataEncryptionActivity cmdlet +* Fixed cmdlets for Azure Active Directory Admin 'AzureSqlServerActiveDirectoryAdministratorAdapter' and 'AzureSqlInstanceActiveDirectoryAdministratorAdapter' migrate from 'AzureEnvironment.Endpoint.AzureEnvironment.Endpoint.Graph' to 'AzureEnvironment.ExtendedEndpoint.MicrosoftGraphUrl' + +#### Az.StackHCI +* Adding support cmdlet for Remote Support + - New cmdlets - Install-AzStackHCIRemoteSupport, Remove-AzStackHCIRemoteSupport, Enable-AzStackHCIRemoteSupport, Disable-AzStackHCIRemoteSupport, Get-AzStackHCIRemoteSupportAccess,Get-AzStackHCIRemoteSupportSessionHistory + +#### Az.Storage +* Fixed the issue that output number in console when update/copy blob sometimes [#16783] + - 'Set-AzStorageBlobContent' + - 'Copy-AzStorageBlob' +* Updated help file, added more description for the asynchronous blob copy. + - 'Start-AzStorageBlobCopy' + +#### Az.TrafficManager +* Added two new optional parameters 'MinChildEndpointsIPv4' and 'MinChildEndpointsIPv6' for nested endpoints + +#### Az.Websites +* Updated 'New-AzAppServicePlan' to create an app service plan with host environment id #16094 + +### Thanks to our community contributors +* @adriancuadrado, Update New-AzADServicePrincipal.md (#16896) +* Alan (@AlanFlorance), Update Get-AzDataLakeGen2ChildItem.md (#16292) +* @geologyrocks, Duplicated header (#16876) +* Hiroshi Yoshioka (@hyoshioka0128), Typo “Azure CosmosDB"→"Azure Cosmos DB” (#16561) +* Jean-Paul Smit (@jeanpaulsmit), The -Force option is not documented and not accepted as parameter (#16910) +* Kamil Konderak (@kamilkonderak), Fixed description for NodeOsDiskSize parameter (#16716) +* Muralidhar Ranganathan (@rmuralidhar), Mitigate Get-AzKeyVaultSecret: Invalid Parameter AsPlainText (#16730) +* Ørjan Landgraff (@theorjan), better PS example (#16748) +* @ahbleite, The switch option was not updated to reflect the new ParameterSetName values, therefore the $id is always null. (#16818) + +## 7.1.0 - January 2022 +#### Az.Accounts +* Copied 'ServicePrincipalSecret' and 'CertificatePassword' from Az.Accounts buildin profile to customer set profile. [#16617] +* Updated help message and help markdown for parameter 'Tenant' of the cmdlet 'Set-AzContext'. [#16515] +* Fixed the issue that Azure PowerShell could not work in a workflow. [#16408] +* Fixed the doubled Api Version in the URI of the underlying request issued by 'Invoke-AzRestMethod'. [#16615] + +#### Az.Aks +* Added support of 'load balancer' and 'api server access' in 'New-AzAksCluster' and 'Set-AzAksCluster'. [#16575] + +#### Az.Automation +* 'New-AzAutomationSchedule' allows defnining StartTime with offsets. +* Fixed bug: updated 'Set-AzAutomationModule' to use PUT call while updating modules with specific versions [#12552] + +#### Az.CognitiveServices +* Updated PowerShell to use 2021-10-01 version. +* Added CommitmentTier and CommitmentPlan cmdlets. +* Added Deployment cmdlets. +* Added 'New-AzCognitiveServicesObject' cmdlet for generating CommitmentPlan/Deployment objects. + +#### Az.Compute +* Updated 'UserData' parameter in VM and VMSS cmdlets to pipe by the Property Name to ensure piping scenarios occur correctly. +* Changed 'New-AzVM' cmdlet when using the SimpleParameterSet to not create a 'PublicIPAddress' when a 'PublicIPAddress' name is not provided. +* Added 'PlatformFaultDomain' parameter to cmdlets: 'New-AzVM' and 'New-AzVMConfig' +* Added '-Feature' parameter for 'New-AzGalleryImageDefinition' +* Added 'DiffDiskPlacement' string parameter to 'Set-AzVmOSDisk' and 'Set-AzVmssStorageProfile' cmdlets. + +#### Az.CosmosDB +* Exposed BackupPolicyMigrationState as a part of Get-AzCosmosDBAccount response. + - This shew the status of a backup policy migration state when an account was being converted from peroidic backup mode to continuous. + +#### Az.DataFactory +* Updated ADF .Net SDK version to 5.0.0 + +#### Az.Functions +* Removed preview from the PowerShell 7.0 stack on Linux + +#### Az.KeyVault +* Added cmdlets: 'Invoke-AzKeyVaultKeyRotation', 'Get-AzKeyVaultKeyRotationPolicy' and 'Set-AzKeyVaultKeyRotationPolicy' + +#### Az.MySql +* General availability of Az.MySql + +#### Az.Network +* Used case-insensitive comparison for ResourceId (Set/New-NetworkWatcherFlowLog) +* Added new properties 'ApplicationSecurityGroup', 'IpConfiguration' and 'CustomNetworkInterfaceName' for Private Endpoint cmdlets + - 'Get-AzPrivateEndpoint' + - 'New-AzPrivateEndpoint' +* Added new cmdlet to create new 'IpConfiguration' object for building Private Endpoint + - 'New-AzPrivateEndpointIpConfiguration' +* Added OrdinalIgnoreCase for string comparison of 'ResourceIdentifier' type for FlowLog cmdlets +* Fixed typo in error message of 'InvalidWorkspaceResourceId' + +#### Az.PostgreSql +* General availability of Az.PostgreSql + +#### Az.RedisCache +* Added 'IdentityType' and 'UserAssignedIdentity' parameter in 'New-AzRedisCache' and 'Set-AzRedisCache' cmdlets. + - It is used to assign and modify the Identity of Azure Cache for Redis. + +#### Az.ResourceMover +* Added support for Tags in azure resource mover +* Added support for SystemData in azure resource mover +* Released 2021-08-01 api-version + +#### Az.Resources +* Fixed incorrect alias for 'Get-AzADSpCredential' [#16592] +* Fixed 'ServicePrincipalName' and 'InputObject' parameters for 'Update-AzADServicePrincipal' [#16620] +* Fixed example for 'New-AzADAppCredential' [#16682] +* Added parameter 'Web' for 'New-AzADApplication' [#16659] +* Added secret text in response of 'New-AzADApplication' and 'New-AzADServicePrincipal' [#16659] +* Deserialized the 'Value' in 'DeploymentVariable' as object array if its type is Array [#16523] +* Fixed the usage of 'SignInName' in 'New-AzRoleAssignment' [#16627] +* Formatted the output format of 'DeploymentVariable' +* Remove 'isUser' operation filter from GetAzureProviderOperation Cmdlet + +#### Az.SignalR +* Fixed the bug of 'Update-AzSignalR' cmdlet that resets the resource states by mistake. + +#### Az.Sql +* Added 'ZoneRedundant' parameter to 'New-AzSqlDatabaseCopy', 'New-AzSqlDatabaseSecondary' and 'Restore-AzSqlDatabase' to enable zone redundant copy, geo secondary and PITR support for hyperscale databases + +#### Az.Storage +* Fixed the failure of sync copy blob with long destination blob name [#16628] + - 'Copy-AzStorageBlob' +* Supported AAD oauth storage context in storage table cmdlets. + - `Get-AzStorageCORSRule` + - `Get-AzStorageServiceLoggingProperty` + - `Get-AzStorageServiceMetricsProperty` + - `Get-AzStorageServiceProperty` + - `Get-AzStorageTable` + - `Get-AzStorageTableStoredAccessPolicy` + - `New-AzStorageTable` + - `New-AzStorageTableSASToken` + - `New-AzStorageTableStoredAccessPolicy` + - `Remove-AzStorageCORSRule` + - `Remove-AzStorageTableStoredAccessPolicy` + - `Set-AzStorageCORSRule` + - `Set-AzStorageServiceLoggingProperty` + - `Set-AzStorageServiceMetricsProperty` + - `Set-AzStorageServiceProperty` + - `Set-AzStorageTable` + - `Set-AzStorageTableStoredAccessPolicy` + +#### Az.Synapse +* General availability of Az.Synapse +* Migrated Azure AD features in Az.Synapse to MSGraph APIs. The cmdlets below called MSGraph API according to input parameters: + - 'New-AzSynapseRoleAssignment' cmdlet + - 'Get-AzSynapseRoleAssignment' cmdlet + - 'Remove-AzSynapseRoleAssignment' cmdlet + - 'Set-AzSynapseSqlActiveDirectoryAdministrator' cmdlet +* Added a default value for [-AutoPauseDelayInMinute] parameter of command 'New-AzSynapseSparkpool' and 'Update-AzSynapseSparkpool' + +### Thanks to our community contributors +* @adishiritwick, Updated Set-AzAutomationModule to use PUT call while updating modules with specific versions (#16505) +* @anuraj, Update the New-AzWebAppCertificate (#16634) +* @BrajaMS, Updated the example command with NodeType param (#16670) +* @geologyrocks, Principal typo (was princial) (#16699) +* Hen Itzhaki (@HenItzhaki), Added more example (#16424) +* Chris (@isjwuk), Formatting improvement (#15826) +* Jaromir Kaspar (@jaromirk), Added example for password credentials (#16600) +* Martin Falkus (@mfalkus), Fix a typo in Update Az-Tags doc where "Repalces" was specified instead of "Replaces" (#16541) +* Radoslav Gatev (@RadoslavGatev), [Az.Accounts] Fix the doubled Api Version in Uri of the request issued by Invoke-AzRestMethod (#16616) +* @Skuldo, Typo fix (#16585) +* Sujit Singh (@sujitks), Update Set-AzApplicationGatewayFirewallPolicy.md (#16583) +* @trudolf-msft, new example 4/workaround (#16437) + +## 7.0.0 - December 2021 +#### Az.Accounts +* Removed 'ServicePrincipalSecret' and 'CertificatePassword' in 'PSAzureRmAccount' [#15427] +* Added optional parameter 'MicrosoftGraphAccessToken' to 'Connect-AzAccount' +* Added optional parameters 'MicrosoftGraphEndpointResourceId', 'MicrosoftGraphUrl' to 'Add-AzEnvironment' and 'Set-AzEnvironment' +* Added '-AccountId' property to 'UserWithSubscriptionId' parameter set of 'Connect-AzAccount' which allows a user name to be pre-selected for interactive logins +* Added '-Uri' and '-ResourceId' to 'Invoke-AzRestMethod' +* Added Environment auto completer to the following cmdlets: Connect-AzAccount, Get-AzEnvironment, Set-AzEnvironment, and Remove-AzEnvironment [#15991] +* Added module name and version to User-Agent string [#16291] + +#### Az.Advisor +* Fixed the issue that 'Az.Advisor.psd1' was not signed [#16226] + +#### Az.Aks +* [Breaking Change] Updated parameter alias and output type of 'Get-AzAksVersion' +* Added 'Invoke-AzAksRunCommand' to support running a shell command (with kubectl, helm) on aks cluster. [#16104] +* Added support of 'EnableNodePublicIp' and 'NodePublicIPPrefixID' for 'New-AzAksCluster' and 'New-AzAksNodePool'. [#15656] +* Migrated the logic of creating service principal in 'New-AzAksCluster' from 'Azure Active Directory Graph' to 'Microsoft Graph'. +* Fixed the issue that 'Set-AzAksCluster' can't upgrade cluster when node pool version doesn't match cluster version. [#14583] +* Added 'ResourceGroupName' in 'PSKubernetesCluster'. [#15802] + +#### Az.ApplicationInsights +* Added WebTest function. Below is the new cmdlet + * 'Get-AzApplicationInsightsWebTest' + * 'New-AzApplicationInsightsWebTest' + * 'New-AzApplicationInsightsWebTestGeolocationObject' + * 'New-AzApplicationInsightsWebTestHeaderFieldObject' + * 'Remove-AzApplicationInsightsWebTest' + * 'Update-AzApplicationInsightsWebTestTag' + +#### Az.Automation +* Fixed example in reference doc for 'Remove-AzAutomationHybridWorkerGroup' +* Updated 'Set-AzAutomationModule' to use PUT call while updating modules with specific versions [#12552] + +#### Az.CloudService +* General availability of 'Az.CloudService' module + +#### Az.Compute +* Contains updates to the following powershell cmdlets + - 'SetAzVmssDiskEncryptionExtension' : Added extension parameters for the cmdlet to work with test extensions and parameter 'EncryptFormatAll' for Virtual Machine Scale Sets + - 'GetAzVmssVMDiskEncryptionStatus' : Modified the functionality of the cmdlet to properly display the encryption status of data disks of Virtual Machine Scale Sets + - 'SetAzDiskEncryptionExtension' : Fixed a bug in the cmdlet in the migrate scenario from 2pass to 1pass encryption +* Added 'Add-AzVhd' to convert VHD using Hyper-V +* Added 'UserData' parameter to VM and VMSS cmdlets +* Added string parameter 'PublicNetworkAccess' to DiskConfig and SnapshotConfig cmdlets +* Added boolean parameter 'AcceleratedNetwork' to DiskConfig and SnapshotConfig cmdlets +* Added 'CompletionPercent' property to the PSSnapshot model so it is visible to the user. + +#### Az.ContainerInstance +* Upgraded API version to 2021-09-01 + - [Breaking Change] Changed the type of parameter 'LogAnalyticWorkspaceResourceId' in 'New-AzContainerGroup' from Hashtable to String + - [Breaking Change] Removed parameter 'NetworkProfileId' in 'New-AzContainerGroup', added 'SubnetId' as its alternative + - [Breaking Change] Removed parameter 'ReadinessProbeHttpGetHttpHeadersName' and 'ReadinessProbeHttpGetHttpHeadersValue' in 'New-AzContainerInstanceObject', added 'ReadinessProbeHttpGetHttpHeader' as their alternative + - [Breaking Change] Removed parameter 'LivenessProbeHttpGetHttpHeadersName' and 'LivenessProbeHttpGetHttpHeadersValue' in 'New-AzContainerInstanceObject', added 'LivenessProbeHttpGetHttpHeader' as their alternative + - Added 'Zone' in 'New-AzContainerGroup', 'AcrIdentity' in 'New-AzContainerGroupImageRegistryCredentialObject' + - Changed 'Username' in 'New-AzContainerGroupImageRegistryCredentialObject' from mandatory to optional +* For 'Invoke-AzContainerInstanceCommand' + - [Breaking Change] Displayed command execution result as the cmdlet output by connecting websocket in backend [#15754] + - Added '-PassThru' to get last execution result when the command succeeds + - Changed 'TerminalSizeCol' and 'TerminalSizeRow' from mandatory to optional, set their default values by current PowerShell window size +* Added 'Restart-AzContainerGroup', 'Get-AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint' and 'New-AzContainerInstanceHttpHeaderObject' + +#### Az.CosmosDB +* Fixed when a warning about the value of AnalyticalStorageSchemaType is displayed when no value was given. +* Added support for managed Cassandra. + +#### Az.DataFactory +* Updated ADF .Net SDK version to 4.28.0 + +#### Az.EventHub +* Fixed the issue that 'New-AzEventHubKey' always generates a new primary key instead of a secondary key since version 1.9.0 [#16362] + +#### Az.Functions +* [Breaking change] 'Update-AzFunctionAppPlan' prompts for confirmation [#16490] +* [Breaking change] 'Remove-AzFunctionApp' does not delete ASP if it is the last app in the plan [#16487] +* [Breaking change] Set the 'FunctionsVersion' to 4 for FunctionApp creation [#16426] +* [Breaking change] 'Update-AzFunctionApp' prompts for confirmation [#14442] +* Fixed an error creating function with 'New-AzFunctionApp' on PowerShell 5.1 [#15430] +* Supported storage account SKU 'Standard_GZRS' [#14633] + +#### Az.HDInsight +* Added two parameters '-Zone' and '-PrivateLinkConfiguration' to cmdlet 'New-AzHDInsightCluster' + - Added parameter '-Zone' to cmdlet 'New-AzHDInsightCluster' to support to create cluster with availability zones feature + - Added parameter '-PrivateLinkConfiguration' to cmdlet 'New-AzHDInsightCluster' to support to add private link configuration when creating cluster with private link feature. +* Added cmdlet New-AzHDInsightIPConfiguration to create ip configuration object in memory. +* Added cmdlet New-AzHDInsightPrivateLinkConfiguration to create private link configuration object in memory. +* Fixed the output type in help doc of Set-AzHDInsightClusterDiskEncryptionKey cmdlet from 'Microsoft.Azure.Management.HDInsight.Models.Cluster' to 'Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster' to keep consistent with the real type of returned object. +* Breaking change: + - Changed the type of parameter 'OSType' from 'Microsoft.Azure.Management.HDInsight.Models.OSType' to 'System.string' in cmdlet 'New-AzHDInsightCluster'. + - Changed the type of parameter 'ClusterTier' from 'Microsoft.Azure.Management.HDInsight.Models.ClusterTier' to 'System.string' in cmdlets 'New-AzHDInsightCluster' and 'New-AzHDInsightClusterConfig'. + - Changed the type of property 'VmSizes' in class 'AzureHDInsightCapabilities' from `IDictionary<string, AzureHDInsightVmSizesCapability>` to `IList<string>`. + - Changed the type of property 'AssignedIdentity' in class 'AzureHDInsightCluster' from 'Microsoft.Azure.Management.HDInsight.Models.ClusterIdentity' to 'Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightClusterIdentity'. + +#### Az.KeyVault +* [Breaking Change] Renamed properties of 'PSKeyVaultPermission' type to follow the pattern of Azure RBAC. +* Migrated AAD Graph API to MSGraph API. +* Added a message to 'Set-AzKeyVaultAccessPolicy' stating that for the Permissions parameters, using the 'All' option will not include the 'Purge' permission. + +#### Az.ManagedServices +* [Breaking Change] Updated API version to 2020-02-01-preview + +#### Az.Monitor +* Added new properties EventName, Category, ResourceProviderName, OperationName, Status, SubStatus with type string as output for command Get-AzLog [#15833] +* Supported event hub receiver in action group [#16348] +* Added default parameter set 'GetByResourceGroup' for the command 'Get-AzAlertRule' [#16356] + +#### Az.Network +* Bugfix in PSAzureFirewallPolicyThreatIntelWhitelist for FirewallPolicy +* Added optional parameter '-IsSecuritySite' to the following cmdlet: + - 'New-AzVpnSite' +* Added support for new Match Variables in WAF Exclusions +* Onboard Virtual Network Encryption to Virtual Network Cmdlets +* Added support for NAT port range parameters in VPN NAT rule resources + - 'New-AzVpnGatewayNatRule.md' + - 'Update-AzVpnGatewayNatRule.md' + - 'New-AzVirtualNetworkGatewayNatRule.md' + - 'Update-AzVirtualNetworkGatewayNatRule.md' +* Added new cmdlets to support Per Rule Exclusions for Application Gateway WAF + - 'New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet' + - 'New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup' + - 'New-AzApplicationGatewayFirewallPolicyExclusionManagedRule' + - Also updated cmdlet to add the property for configuring ExclusionManagedRuleSet within Exclusions + - 'New-AzApplicationGatewayFirewallPolicyExclusion' +* Bug Fix in Application Gateway Trusted Client Certificate cmdlets to load the entire cert chain from file. + +#### Az.OperationalInsights +* Expanded DataSourceType with values 'Query', 'Alerts' for LinkedStorageAccount cmdlets +* [Breaking Change] rename 'StorageAccountId' to 'StorageAccountIds' + - 'New-AzOperationalInsightsLinkedStorageAccount' +* [Breaking Change] Returns 'PSSavedSearch' instead of 'HttpStatusCode' by 'New-AzOperationalInsightsComputerGroup' +* [Breaking Change] Returns 'PSCluster' instead of 'PSLinkedService' by 'Update-AzOperationalInsightsCluster' +* Expanded Sku with values 'capacityreservation', 'lacluster' for Workspace +* Added new properties:'SkuCapacity', 'ForceCmkForQuery', 'DisableLocalAuth' for Workspace +* Added new property: 'DailyQuotaGb'on'Set-AzOperationalInsightsWorkspace' +* Added new properties: 'ETag', 'Tag' for StorageInsight cmdlets +* Added new property 'StorageAccountResourceId' to cmdlet: + - 'Set-AzOperationalInsightsStorageInsight' +* Added SupportsShouldProcess attribute to cmdlet: + - 'Set-AzOperationalInsightsStorageInsight' +* Added new cmdlets to support Table, DataExport, WorkspaceShareKey, PurgeWorkspace, and AvailableServiceTier +* Added 'Error' property in the result of the 'Invoke-AzOperationalInsightsQuery' to retrieve partial error when running a query [#16378] + +#### Az.RecoveryServices +* Azure Backup updated validate sets for supported BackupManagementType in 'Get-AzRecoveryServicesBackupItem', 'Get-AzRecoveryServicesBackupContainer', Get-AzRecoveryServicesBackupJob cmdlets. +* Azure Backup added support for SAPHanaDatabase for 'Disable-AzRecoveryServicesBackupProtection', 'Unregister-AzRecoveryServicesBackupContainer', 'Get-AzRecoveryServicesBackupItem', 'Get-AzRecoveryServicesBackupContainer' cmdlets. +* Breaking Change: 'Get-AzRecoveryServicesBackupJob', 'Get-AzRecoveryServicesBackupContainer' and 'Get-AzRecoveryServicesBackupItem' commands will only support 'BackupManagementType MAB' instead of 'MARS'. +* Azure Site Recovery support for capacity reservation for Azure to Azure provider. + +#### Az.Resources +* Added 'Get-AzProviderPreviewFeature', 'Register-AzProviderPreviewFeature' and 'Unregister-AzProviderPreviewFeature' cmdlets. +* Fixed a bug when running Get-AzPolicyAlias with empty value of NamespaceMatch parameter [#16370] +* [Breaking change] Migrated from AAD Graph to Microsoft Graph +* [Breaking change] Changed the returned 'Id' in PSDenyAssignment from GUID string to fully qualified ID +* Allowed parameter 'Id' in 'Get-AzDenyAssignment' to accept fully qualified ID +* Added new cmdlet 'Publish-AzBicepModule' for publishing Bicep modules +* Added deprecation message for 'AssignIdentity' parameter in '*-AzPolicyAssignment' cmdlets. +* Added support for user assigned managed identities in policy assignments by adding 'IdentityType' and 'IdentityId' parameters to '*-AzPolicyAssignment' cmdlets. +* Updated policy cmdlets to use new api version 2021-06-01 that introduces support for user assigned managed identities in policy assignments. +* Narrowed API permission when get information about active directory object for *-AzRoleAssignment [#16054] + +#### Az.Sql +* Fixed FirewallRuleName wildcard filtering in 'Get-AzSqlServerFirewallRule' [#16199] +* Moved SQL Server and SQL Instance AAD from ActiveDirectoryClient to MicrosoftGraphClient + +#### Az.StackHCI +* Promoted Az.StackHCI to GA + +#### Az.Storage +* Fixed the failure of 'Get-AzStorageContainerStoredAccessPolicy' when permission is null [#15644] +* Supported create blob service Sas token or account Sas token with permission i + - 'New-AzStorageBlobSASToken' + - 'New-AzStorageContainerSASToken' + - 'New-AzStorageAccountSASToken' +* Fixed creating container SAS token failed from an access policy without expire time, and set SAS token expire time [#16266] + - 'New-AzStorageContainerSASToken' +* Removed parameter -Name from Get-AzRmStorageShare ShareResourceIdParameterSet + - 'Get-AzRmStorageShare' +* Supported create or migrate container to enable immutable Storage with versioning. + - 'New-AzRmStorageContainer' + - 'Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration' +* Supported set/remove immutability policy on a Storage blob. + - 'Set-AzStorageBlobImmutabilityPolicy' + - 'Remove-AzStorageBlobImmutabilityPolicy' +* Supported enable/disable legal hold on a Storage blob. + - 'Set-AzStorageBlobLegalHold' +* Supported create storage account with enable account level immutability with versioning, and create/update storage account with account level immutability policy. + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' + +#### Az.Websites +* Updated the Microsoft.Azure.Management.Websites SDK to 3.1.2 + +### Thanks to our community contributors +* Hiroshi Yoshioka (@hyoshioka0128), Fix typo "Azure CosmosDB"→"Azure Cosmos DB" (#16470) +* Chris (@isjwuk), Update New-AzAutomationSourceControl.md (#16366) +* Julian Hüppauff (@jhueppauff), [API Management] Fixed variable reference (#16525) +* @toswedlu, [CosmosDB] Changing the warning message for AnalyticalStorageSchemaType (#15723) + +## 6.6.0 - November 2021 +#### Az.Accounts +* Added new version of AAD service client using Microsoft Graph API + +#### Az.Aks +* Added support for new parameters 'NetworkPolicy', 'PodCidr', 'ServiceCidr', 'DnsServiceIP', 'DockerBridgeCidr', 'NodePoolLabel', 'AksCustomHeader' in 'New-AzAksCluster'. [#13795] +* Added warnings of upcoming breaking change of migrating to Microsoft Graph. +* Added support for changing the number of nodes in a node pool. [#12379] + +#### Az.ApiManagement +* Fixed a bug in 'Get-AzApiManagementTenantGitAccess' cmdlet. + +#### Az.Batch +* Removed assembly 'System.Text.Encodings.Web.dll' [#16062] + +#### Az.Compute +* Added cmdlets for adding VMGalleryApplication property to VM/VMSS + - New-AzVmGalleryApplication + - New-AzVmssGalleryApplication + - Add-AzVmGalleryApplication + - Add-AzVmssGalleryApplication + - Remove-AzVmGalleryApplication + - Remove-AzVmssGalleryApplication +* Added support for proxy and debug settings for VM Extension for SAP (AEM) +* Updated New-AzGalleryImageVersion to take in the 'Encryption' property correctly from '-TargetRegion' parameter. +* Updated Set-AzVmBootDiagnostic to default to managed storage account if not provided. +* Edited New-AzVmss defaulting behavior when 'OrchestrationMode' is set to Flexible. + - Removed NAT Pool. + - Removed UpgradePolicy. Throws an error if provided. + - SinglePlacementGroup must be false. Throws an error if true. + - Networking Profile's API version is 2020-11-01 or later. + - Networking Profile IP Configurations Primary property is set to true. + +#### Az.CosmosDB +* Introduced Get-AzCosmosDBMongoDBBackupInformation to retrieve latest backup information for MongoDB. +* Updated New-AzCosmosDBAccount, Update-AzCosmosDBAccount to accept BackupStorageRedundancy +* Introduced Get-AzCosmosDBLocation to list Azure CosmosDB Account and its locations properties. + +#### Az.DataFactory +* Added PublicNetworkAccess to Update_AzDataFactoryV2 Command +* Updated ADF .Net SDK version to 4.26.0 + +#### Az.DesktopVirtualization +* Upgraded api version to 2021-07-12. + +#### Az.EventHub +* Added support for Premium sku and namesapce and optional switch parameter 'DisableLocalAuth' to 'New-AzEventHubNamespace' and 'Set-AzEventHubNamespace' + +#### Az.Functions +* Set site config netFrameworkVersion for Windows V4 apps only +* Enabled function app creation for Functions V4 stacks [#15919] + +#### Az.IotHub +* Updated IoT Hub Management SDK to version 4.1.0 (api-version 2021-07-10) + +#### Az.KeyVault +* Added warning message of upcoming breaking change to 'New-AzKeyVaultRoleDefinition' and 'Get-AzKeyVaultRoleDefinition'. + - To comply with the syntax of 'New-AzRoleDefinition' and 'Get-AzRoleDefinition' we are going to rename some of the properties of 'PSKeyVaultPermission' model, which might affect these two cmdlets. +* Added warnings of upcoming breaking change of migrating to Microsoft Graph. + +#### Az.Migrate +* Added check for invalid IP address + +#### Az.OperationalInsights +* Fixed a bug in 'Set-AzOperationalInsightsLinkedService: when linked service does not exist, perform create(update) instead of failing' + +#### Az.RecoveryServices +* Azure Backup fixed issues with StorageConfig +* Azure Backup added NodesList and AutoProtectionPolicy to Get-AzRecoveryServicesBackupProtectableItem Cmdlets. +* Azure Backup fixed GetItemsForContainerParamSet to support fetching the MAB backup item. +* Azure Backup fixed Get-AzRecoveryServicesBackupContainer to support BackupManagementType MAB instead of MARS. +* Added breaking change warning: 'Get-AzRecoveryServicesBackupJob', 'Get-AzRecoveryServicesBackupContainer' and 'Get-AzRecoveryServicesBackupProtectableItem' commands will only support 'BackupManagementType MAB' instead of 'MARS' alias, changes will take effect from upcoming breaking release. +* Added support for ZRS disk type for Azure to Azure replication. +* Added Availability zone information in replicated protected item response for Azure to Azure replication. + +#### Az.RedisCache +* Created new examples in documentation of 'New-AzRedisCache' and 'Set-AzRedisCache'. + +#### Az.Resources +* Fixed a bug about the exitcode of Bicep [#16055] +* Added breaking change warnings for AAD cmdlets +* Added property 'UIFormDefinition' to Template Spec Versions, 'Export-AzTemplateSpec' will now include a Template Spec Version's UIFormDefinition (if any) as part of the export. +* Added error catching for role assignment creation fail while creating a Service Principal +* Performance improvement for Get-AzPolicyAlias when -NamespaceMatch matches a single RP namespace + +#### Az.Security +* Updated Security .NET SDK package reference to version 3.0.0 + +#### Az.ServiceBus +* Added support for ZoneRedundant and optional switch parameter 'DisableLocalAuth' to 'New-AzServiceBusNamespace' and 'Set-AzServiceBusNamespace' + +#### Az.SignalR +* Added Web PubSub cmdlets + - 'New-AzWebPubSub' + - 'Get-AzWebPubSub' + - 'Update-AzWebPubSub' + - 'Restart-AzWebPubSub' + - 'Remove-AzWebPubSub' + - 'New-AzWebPubSubHub' + - 'Get-AzWebPubSubHub' + - 'Remove-AzWebPubSubHub' + - 'New-AzWebPubSubKey' + - 'Get-AzWebPubSubKey' + - 'Get-AzWebPubSubSku' + - 'Get-AzWebPubSubUsage' + - 'Test-AzWebPubSubNameAvailability' + +### Thanks to our community contributors +* bgomezangulo (@beagam), Update Resume-AzNetAppFilesReplication.md (#16040) +* Jim McCormick (@eimajtrebor), Fixed typo (#16091) +* Lampson Nguyen (@lampson), Update Get-AzDataShare.md (#16015) +* @MaxMeng1985, Update Get-AzSynapseSqlPoolRestorePoint.md (#16138) +* Reggie Gibson (@regedit32), New-AzBotService: Fix AppSecret conversion to plaintext on Windows PowerShell (#16160) +* Mötz Jensen (@Splaxi), BusinessIdentities details doesn't match the current implementation (#16141) + + +## 6.5.0 - October 2021 +#### Az.Accounts +* Supported getting the access token for Microsoft Graph. +* Added AuthorizeRequestDelegate to allow service module to adjust token audience. +* Utilized [AssemblyLoadContext](/dotnet/api/system.runtime.loader.assemblyloadcontext) to resolve assembly conflict issues in PowerShell. +* Updated Azure.Core from 1.16.0 to 1.19.0. + +#### Az.Attestation +* General availability of 'Az.Attestation' module + +#### Az.Cdn +* Fixed null reference exception and typos in 'New-AzFrontDoorCdnRule' cmdlet + +#### Az.Compute +* Updated Compute .NET SDK package reference to version 49.1.0 +* Fixed a bug in 'Get-AzVM' that caused incorrect power status output. + +#### Az.DataFactory +* Added a DataFlowEnableQuickReuse argument for the 'Set-AzDataFactoryV2IntegrationRuntime' cmdlet to enable quick reuse of clusters in next pipeline activities. +* Updated ADF .Net SDK version to 4.25.0 +* Added a VNetInjectionMethod argument for the 'Set-AzDataFactoryV2IntegrationRuntime' cmdlet to support the express virtual network injection of Azure-SSIS Integration Runtime. + +#### Az.FrontDoor +* Allowed rule engine action creation without RouteConfigurationOverride for 'New-AzFrontDoorRulesEngineActionObject'. +* Fixed DynamicCompression parameter being ignored issue of 'New-AzFrontDoorRulesEngineActionObject'. + +#### Az.KeyVault +* Supported custom role definitions on managed HSM: + - Create via 'New-AzKeyVaultRoleDefinition', + - Delete via 'Remove-AzKeyVaultRoleDefinition', + - Filter all custom roles via 'Get-AzKeyVaultRoleDefinition -Custom'. +* Supported Encrypt/Decrypt/Wrap/Unwrap using keys [#15679] +* Enabled managing resources in other subscriptions without switching the context by adding `-Subscription <String>`. + +#### Az.Maintenance +* Added Guest patch maintenance support. + +#### Az.Network +* Support for Sku, ScaleUnits parameters of BastionHost resource. + - 'New-AzBastion' + - 'Set-AzBastion' +* Onboard Azure Resource Manager to Private Link Common Cmdlets +* Updated cmdlets to add properties to enable/disable BgpRouteTranslationForNat for VpnGateway. + - 'New-AzVpnGateway' + - 'Update-AzVpnGateway' +* Updated cmdlet to add property to disable InternetSecurity for P2SVpnGateway. + - 'New-AzP2sVpnGateway' +* Added new cmdlets for HubBgpConnection child resource of VirtualHub. + - 'Get-AzVirtualHubBgpConnection' + - 'New-AzVirtualHubBgpConnection' + - 'Update-AzVirtualHubBgpConnection' + - 'Remove-AzVirtualHubBgpConnection' +* Onboard Azure HDInsight to Private Link Common Cmdlets + +#### Az.RecoveryServices +* Azure Site Recovery bug fixes for VMware to Azure Reprotect, Update policy and Disable scenarios. +* Azure Backup added the support for UserAssigned MSI in RecoveryServices Vault. + +#### Az.Resources +* Added a clearer error message for a case in which TemplateUri do not accept bicep file. +* Fixed typos with ManagementGroups breaking change descriptions [#15819]. +* Fixed resource tags casing issue - resource tags casing not being preserved. +* Updated to Microsoft.Azure.Management.Authorization 2.13.0-preview. + +#### Az.Sql +* Fixed 'Get-AzSqlDatabaseImportExportStatus' to report the error encountered + +#### Az.Storage +* Upgraded Azure.Storage.Blobs to 12.10.0 +* Upgraded Azure.Storage.Files.Shares to 12.8.0 +* Upgraded Azure.Storage.Files.DataLake to 12.8.0 +* Upgraded Azure.Storage.Queues to 12.8.0 +* Supported upgrade storage account to enable HierarchicalNamespace + - 'Invoke-AzStorageAccountHierarchicalNamespaceUpgrade' + - 'Stop-AzStorageAccountHierarchicalNamespaceUpgrade' +* Supported AccessTierInferred, Tags in blob inventory policy schema + - 'New-AzStorageBlobInventoryPolicyRule' +* Supported create/update storage account with PublicNetworkAccess enabled/disabled + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' +* Supported create/update storage blob container with RootSquash + - 'New-AzRmStorageContainer' + - 'Update-AzRmStorageContainer' +* Supported AllowProtectedAppendWriteAll in set container Immutability Policy, and add container LegalHold + - 'Set-AzRmStorageContainerImmutabilityPolicy' + - 'Add-AzRmStorageContainerLegalHold' + +#### Az.StorageSync +* Fixed a bug where not all properties of PSSyncSessionStatus and PSSyncActivityStatus objects were being populated properly. +* This affected the 'Get-AzStorageSyncServerEndpoint' cmdlet when trying to access the following properties of the output: + - SyncStatus.UploadStatus + - SyncStatus.DownloadStatus + - SyncStatus.UploadActivity + - SyncStatus.DownloadActivity + +#### Az.Websites +* Updated 'Import-AzWebAppKeyVaultCertificate1' to set the default name with combination of keyvault name and cert name + +### Thanks to our community contributors +* @DSakura207, Use last PowerState instance in Statuses for power status (#15941) +* Yannic Graber (@grabery), Recode Example2 (#15808) +* @joelmforsyth, Fix multi-regional examples (#15918) +* Adam Coffman (@SysAdminforCoffee), Update Set-AzNetworkInterfaceIpConfig.md (#15846) +* Michael Howard (@x509cert), Reworded sentence to make it clear that a specific key version must be provided (#15886) + +## 6.4.0 - September 2021 +#### Az.Accounts +* Corrected the URLs to Azure Portal in the results of 'Get-AzEnvironment' and 'Get-AzContext'. [#15429] +* Made infrastructural changes to support overriding default subscription via a `-SubscriptionId <String>` parameter. + - [Az.Aks](/powershell/module/az.aks/get-azakscluster) is the first module that supports it. + +#### Az.Aks +* Made `-Subscription <String>` available in all Aks cmdlets. You can manage Aks resources in other subscriptions without switching the context. + +#### Az.ApiManagement +* Added new 'Sync-AzApiManagementKeyVaultSecret' cmdlet. +* Added new 'New-AzApiManagementKeyVaultObject' cmdlet. +* Added new optional [-useFromLocation] parameter to the 'Get-ApiManagementCache' 'New-ApiManagementCache''Update-ApiManagementCache' cmdlet. +* Updated cmdlet **New-AzApiManagement** to manage ApiManagement service + - Added support for the new 'Isolated' SKU + - Added support for managing Availability Zones using 'Zone' property + - Added support for Disabling Gateway in a Region using 'DisableGateway' property + - Added support for managing the minimum Api Version to allow for Control Plane using 'MinimalControlPlaneApiVersion' property. +* Updated cmdlet **New-AzApiManagementRegion** to manage ApiManagement service + - Added support for managing Availability Zones using 'Zone' property + - Added support for Disabling Gateway in a Region using 'DisableGateway' property +* Updated cmdlet **Add-AzApiManagementRegion** to manage ApiManagement service + - Added support for managing Availability Zones using 'Zone' property + - Added support for Disabling Gateway in a Region using 'DisableGateway' property +* Updated cmdlet **Update-AzApiManagementRegion** to manage ApiManagement service + - Added support for managing Availability Zones using 'Zone' property + - Added support for Disabling Gateway in a Region using 'DisableGateway' property +* Updated cmdlet **New-AzApiManagementCustomHostnameConfiguration** to manage Custom Hostname Configuration + - Added support for specifying 'IdentityClientId' to provide Managed Identity User Assigned ClientId to use with KeyVault + +#### Az.Automation +* Fixed bug: Closing in input file handle in Import-AzAutomationRunbook + +#### Az.Cdn +* Fixed mandatory parameters issue in 'Get-AzCdnEndpointResourceUsage' cmdlet + +#### Az.Compute +* Added new parameters '-LinuxConfigurationPatchMode', '-WindowsConfigurationPatchMode', and '-LinuxConfigurationProvisionVMAgent' to 'Set-AzVmssOSProfile' +* Added new parameters '-SshKeyName' and '-GenerateSshKey' to 'New-AzVM' to create a VM with SSH +* Fixed a bug in 'Add-AzVHD' on Linux that caused uploads to fail for certain destination URI +* Added new cmdlets for Restore Points and Restore Point Collection: + - 'New-AzRestorePoint' + - 'New-AzRestorePointCollection' + - 'Get-AzRestorePoint' + - 'Get-AzRestorePointCollection' + - 'Update-AzRestorePointCollection' + - 'Remove-AzRestorePoint' + - 'Remove-AzRestorePointCollection' +* Added new parameters '-EnableSpotRestore' and '-SpotRestoreTimeout' to 'New-AzVMSSConfig' to enable Spot Restore Policy +* Added new cmdlets: 'Update-AzCapacityReservationGroup' and 'Update-AzCapacityReservation' + +#### Az.CosmosDB +* Fixed a bug where the restore of deleted database accounts fail. + +#### Az.DataFactory +* Added a subnetId argument for the 'Set-AzDataFactoryV2IntegrationRuntime' cmdlet to support RBAC checking for VNet injection against the subnet resource ID instead of the VNet resource ID. +* Added the 'Get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint' cmdlet to provide a list of outbound network dependencies for SSIS integration runtime in Azure Data Factory that joins a virtual network. +* Added PublicNetworkAccess to Data Factory. +* Updated ADF .Net SDK version to 4.23.0 + +#### Az.KeyVault +* Supported adding EC keys in key vault [#15699] + +#### Az.Migrate +* Supported duplicate disk UUID in source disk. +* Supported subnets in same VNet for AVSet. +* Supported runAsAccount fetching for multiple Vcenters in same site. + +#### Az.Network +* Updated cmdlet to add 'Subnet' property for IP based load balancer backend address pool. + - 'New-AzLoadBalancerBackendAddressConfig' +* Updated cmdlet to add 'TunnelInterface' property for backend pool related operations. + - 'New-AzLoadBalancerBackendAddressPool' + - 'Set-AzLoadBalancerBackendAddressPool' + +#### Az.RecoveryServices +* Azure Site Recovery multi appliance support for VMware to Azure disaster recovery scenarios using RCM as the control plane. +* Azure Backup fixed targetPhysicalPath issue with SQL CRR +* Azure Backup fixed disable protection for SQL workload +* Azure Backup resolved bug in setting CMK properties in latest release +* Azure Backup removed special characters from register-azrecoveryservicesbackupcontainer command help text + +#### Az.Resources +* Use JsonExtensions to serialize deserialize JSON objects to ensure the use of custom serialization settings [#15552] +* Added support for 'Unsupported' and 'NoEffect' change types to deployment What-If cmdlets. + +#### Az.SecurityInsights +* Updated to 'Get-AzSentinelIncident' parameters + - Added '-Filter' to support OData filter + - Added '-OrderBy' to support OData ordering + - Added '-Max' to support retrieving more than the default of 1000 incidents. + +#### Az.Sql +* Changed the underlying implementation of 'Get-AzSqlDatabase' to support a paginated response from the server +* Added 'ZoneRedundant' parameter to 'New-AzSqlInstance' and 'Set-AzSqlInstance' to enable the creation and the update of zone - redundant instances. +* Added ZoneRedundant field to the model of the managed instance so that it displays information about zone - redundancy for instance that are returned by 'Get-AzSqlInstance'. +* Extended AuditActionGroups enum in server & database audit. Added DBCC_GROUP, DATABASE_OWNERSHIP_CHANGE_GROUP and DATABASE_CHANGE_GROUP. +* Added 'AsJob' flag to 'Remove-AzSqlInstance' +* Added 'SubnetId' parameter to 'Set-AzSqlInstance' to support the cross-subnet update SLO +* Upgraded to newest SDK version + +#### Az.Storage +* Supported get/set blob tags on a specific blob + - 'Get-AzStorageBlobTag' + - 'Set-AzStorageBlobTag' +* Supported create destination blob with specific blob tags while upload/copy Blob + - 'Set-AzStorageBlobContent' + - 'Start-AzStorageBlobCopy' +* Supported list blobs across containers with a blob tag filter sql expression + - 'Get-AzStorageBlobByTag' +* Supported list blobs inside a container and include Blob Tags + - 'Get-AzStorageBlob' +* Supported run blob operation with blob tag condition, and fail the cmdlet when blob tag condition not match + - 'Get-AzStorageBlob' + - 'Get-AzStorageBlobContent' + - 'Get-AzStorageBlobTag' + - 'Remove-AzStorageBlob' + - 'Set-AzStorageBlobContent' + - 'Set-AzStorageBlobTag' + - 'Start-AzStorageBlobCopy' + - 'Stop-AzStorageBlobCopy' +* Generate blob sas token with new API version + - 'New-AzStorageBlobSASToken' + - 'New-AzStorageContainerSASToken' + - 'New-AzStorageAccountSASToken' +* Fixed blob copy failure with OAuth credential when client and server has time difference [#15644] + - 'Copy-AzStorageBlob' +* Fixed remove Data Lake Gen2 item fail with readonly SAS token + - 'Remove-AzDataLakeGen2Item' +* Revised destination existing check in move Data Lake Gen2 item + - 'Move-AzDataLakeGen2Item' + +#### Az.StorageSync +* Added parameter sets to 'Invoke-AzStorageSyncChangeDetection' + - Can call the cmdlet without -DirectoryPath and -Path parameters to trigger change detection on an entire file share +* Added support for authoritative upload as part of New-AzStorageSyncServerEndpoint. +* Added cloud change enumeration status information in Cloud Endpoint object. +* Updated Server Endpoint object with various health properties +* Added 'ServerName' property in Server Endpoint and Registered Server objects to support showing the current FQDN of a server. + +#### Az.Websites +* Fixed 'Set-AzWebApp' to return a valid warning message when fails to add -Hostname #9316 +* Fixed 'Get-AzWebApp' to return CustomDomainVerificationId in the response. #9316 + +### Thanks to our community contributors +* Andrew Sears (@asears) + * Fix spelling of accountname (#15779) + * Fix Spelling, examples (#15780) +* @cawrites, Update New-AzDataMigrationService.md (#15646) +* @harpaul-gill, Adding support for pagination in Sql Get Databases (#15772) +* @jeepingben, Create mutex names that are safe for Linux (fixes #15653) (#15666) +* @LosManos, Docs: Parameter is ignored when listing secrets (#15788) +* Mats Estensen (@matsest), docs: add examples for Update-AzSubscription (#15748) +* Mauricio Arroyo (@mauricio-msft), Fix typo in cmdlet example (#15719) + +## 6.3.0 - August 2021 +#### Az.Accounts +* Disabled context auto saving when token cache persistence fails on Windows and macOS +* Added PowerShell version into telemetry record +* Upgraded Microsoft.ApplicationInsights from 2.4.0 to 2.12.0 +* Updated Azure.Core to 1.16.0 + +#### Az.Aks +* Added 'Start-AzAksCluster', 'Stop-AzAksCluster', 'Get-AzAksUpgradeProfile' and 'Get-AzAksNodePoolUpgradeProfile'. [#14194] +* Added property 'IdentityProfile' in the output of 'Get-AzAksCluster'. [#12546] + +#### Az.CognitiveServices +* [Breaking Change] Changed type of PSCognitiveServicesAccount.Identity.Type from IdentityType to ResourceIdentityType. +* [Breaking Change] Changed type of PSCognitiveServicesAccount.Sku.Tier from SkuTier to string. +* [Breaking Change] Removed ActionRequired from PrivateLinkServiceConnectionState. +* Updated PowerShell to use 2021-04-30 version. +* Added 'Undo-AzCognitiveServicesAccountRemoval' cmdlet. +* Added parameters '-RestrictOutboundNetworkAccess', '-AllowedFqdnList', '-DisableLocalAuth', '-KeyVaultIdentityClientId', '-IdentityType', '-UserAssignedIdentityId' to 'New-AzureCognitiveServicesAccount' and 'Set-AzureCognitiveServicesAccount'. +* Added parameters '-InRemovedState', '-Location' to 'Remove-AzureCognitiveServicesAccount' and 'Get-AzureCognitiveServicesAccount'. + +#### Az.Compute +* Fixed the warning in 'New-AzVM' cmdlet stating the sku of the VM is being defaulted even if a sku size is provided by the user. Now it only occurs when the user does not provide a sku size. +* Edited 'Set-AzVmOperatingSystem' cmdlet to no longer overwrite any existing EnableAutomaticUpdates value on the passed in virtual machine if it exists. +* Updated Compute module to use the latest .Net SDK version 48.0.0. +* Added new cmdlets for the Capacity Reservation Feature: + - 'New-AzCapacityReservationGroup' + - 'Remove-AzCapacityReservationGroup' + - 'Get-AzCapacityReservationGroup' + - 'New-AzCapacityReservation' + - 'Remove-AzCapacityReservation' + - 'Get-AzCapacityReservation' +* Added a new parameter '-CapacityReservationGroupId' to the following cmdlets: + - 'New-AzVm' + - 'New-AzVmConfig' + - 'New-AzVmss' + - 'New-AzVmssConfig' + - 'Update-AzVm' + - 'Update-AzVmss' + +#### Az.DataFactory +* Updated ADF .Net SDK version to 4.21.0 + +#### Az.Migrate +* Added SQL Server license type. +* Added CRN feature. +* Added resource tags feature. +* Updated to 2021-02-10 api version. + +#### Az.Monitor +* Added parameter 'ResourceGroupName' back for 'Add-AzAutoscaleSetting' parameter set 'AddAzureRmAutoscaleSettingUpdateParamGroup' and made it optional [#15491] + +#### Az.RecoveryServices +* Added Archive for V1 vaults. +* Added ProtectedItemsCount in Get-AzRecoveryServicesBackupProtectionPolicy. +* Azure site recovery bug fix for azure to azure in update vm properties. + +#### Az.RedisCache +* Added 'RedisVersion' parameter in 'New-AzRedisCache' and 'Set-AzRedisCache' + +#### Az.Resources +* Fixed bug with 'PSResource' where some constructors left 'SubscriptionId' property unassigned/null. [#10783] +* Added support for creating and updating Template Spec in Bicep file [#15313] +* Added '-ProceedIfNoChange' parameter to deployment create cmdlets. + +#### Az.ServiceFabric +* Fixed Managed and Classic Application models (Application, Cluster, Service) by updating constructor to take all new properties + - This solves piping related issues where piping the results directly from a Get cmdlet call into and Update or Set call remove some intentionally set properties + - Updated appropriate test files to cover the above mentioned cases + +#### Az.Sql +* Fixed identity logic in 'Set-AzSqlServer' and 'Set-AzSqlInstance' + +#### Az.Storage +* Supported Blob Last Access Time + - 'Enable-AzStorageBlobLastAccessTimeTracking' + - 'Disable-AzStorageBlobLastAccessTimeTracking' + - 'Add-AzStorageAccountManagementPolicyAction' +* Made 'Get-AzDataLakeGen2ChildItem' list all datalake gen2 items by default, instead of needing user to list chunk by chunk. +* Fixed BlobProperties is empty issue when using sas without prefix '?' [#15460] +* Fixed synchronously copy small blob failure [#15548] + - 'Copy-AzStorageBlob' + +#### Az.Websites +* Fixed 'Add-AzWebAppAccessRestrictionRule' failing when users does not have permissions to get Service Tag list #15316 and #14862 + +### Thanks to our community contributors +* Borys Generalov (@bgener), Update Get-AzPolicyState.md (#15455) +* Dean Mock (@deanmock), Update New-AzAutomationSchedule.md (#15371) +* John Bevan (@JohnLBevan), #10783 - Fix for Get-AzResource returning PSResource with null SubscriptionId (#15106) +* Michael Mejias Sanchez (@mikemej), Update - Update deployment (external VNET) (#15391) +* @mjsharma, Adding note for alternate commands (#15360) +* Ked Mardemootoo (@nocticdr), Fixed some typos for added clarity (#15428) +* Pascal Berger (@pascalberger), Fix parameter name in Sync-AzVirtualNetworkPeering examples (#15493) +* @rcabr, Doc fix in Get-AzStorageContainer (#15476) +* AAron (@S-AA-RON), Update New-AzNetworkSecurityGroup.md (#15512) +* 坂本ポテコ (@sakamoto-poteko), Update New-AzVMConfig.md (#15376) +* @Shawn-Yuen, Update Remove-AzDataLakeGen2Item.md (#15388) + +## 6.2.1 - July 2021 +#### Az.Accounts +* Fixed access error when subscripiton has no 'Tags' property [#15425]. + +## 6.2.0 - July 2021 +#### Az.Accounts +* Added Tags, AuthorizationSource to PSAzureSusbscripiton and added TenantType, DefaultDomain, TenantBrandingLogoUrl, CountryCode to PSAzureTenant [#15220] +* Upgraded subscription client to 2021-01-01 [#15220] +* Removed Interactive mode check in common lib +* Added endpoint of OperationalInsights to environment AzureChinaCloud [#15305] +* Printed auto generated modules' default logs to verbose stream + +#### Az.Aks +* Added parameter 'AvailabilityZone' for 'New-AzAksNodePool'. [#14505] + +#### Az.ApplicationInsights +* Added read only property 'ConnectionString' and 'ApplicationId' to applicationinsights component + +#### Az.Compute +* Added optional parameter '-OrchestrationMode' to 'New-AzVmss' and 'New-AzVmssConfig' +* Updated the following cmdlets to work when the resource uses a remote image source using AKS or Shared Image Gallery. + - 'Update-AzVm' + - 'Update-AzVmss' + - 'Update-AzGalleryImageVersion' +* Added parameters '-EnableCrossZoneUpgrade' and '-PrioritizeUnhealthyInstance' to the 'Set-AzVmssRollingUpgradePolicy' +* Added 'AssessmentMode' parameter to the 'Set-AzVMOperatingSystem' cmdlet. +* Fixed a bug in 'Add-AzVmssNetworkInterfaceConfiguration' +* Fixed IOPS and throughput check in 'Test-AzVMAEMExtension' +* Added new cmdlets for 2020-12-01 DiskRP API version + - New-AzDiskPurchasePlanConfig + - Set-AzDiskSecurityProfile +* Changed Cmdlets for 2020-12-01 DiskRP API version + - New-AzDiskConfig + - New-AzSnapshotConfig + - New-AzSnapshotUpdateConfig + - New-AzDiskUpdateConfig + - New-AzDiskEncryptionSetConfig + - Update-AzDiskEncryptionSet + +#### Az.CosmosDB +* This release introduces the cmdlets for the features of Continuous Backup(Point in time restore): + - Introduced support for creating accounts with continuous mode backup policy. + - Introduced support for Point in time restore for accounts with continuous mode backup policy. + - Introduced support to update the backup interval and backup retention for accounts with periodic mode backup policy. + - Introduced support to list the restorable resources in a live database account. + - Introduces support to specify analytical storage schema type on account creation/update. + - The following cmdlets are added: + - Restore-AzCosmosDBAccount, New-AzCosmosDBDatabaseToRestore, Get-AzCosmosDBRestorableDatabaseAccount, + - Get-AzCosmosDBSqlRestorableDatabase, Get-AzCosmosDBSqlRestorableContainer, Get-AzCosmosDBSqlRestorableResource, + - Get-AzCosmosDBMongoDBRestorableDatabase, Get-AzCosmosDBMongoDBRestorableCollection, Get-AzCosmosDBMongoDBRestorableResource. + +#### Az.DataFactory +* Added Customer Managed Key Encryption to DataFactory + +#### Az.Functions +* Added two additional app settings (WEBSITE_CONTENTSHARE and WEBSITE_CONTENTAZUREFILECONNECTIONSTRING) for Linux Consumption apps. [15124] +* Fixed bug with New-AzFunctionApp when created on Azure Gov. [13379] +* Added Az.Functions cmdlets need to support creating and copying app settings with empty values. [14511] + +#### Az.Monitor +* Fixed null reference bug for 'Get-AzMetric' when 'ResultType' set to 'Metadata' +* Fixed bug for 'Add-AzAutoscaleSetting' not able to pipe result from 'Get-AzAutoscaleSetting' [#13861] + +#### Az.Network +* Added public ip address as an optional parameter to create route server + - 'New-AzRouteServer' +* Updated cmdlets to enable specification of edge zone + - 'New-AzPublicIpPrefix' + - 'New-AzLoadBalancer' + - 'New-AzPrivateLinkService' + - 'New-AzPrivateEndpoint' +* Added support for viewing extended location of virtual network in the console + - 'New-AzVirtualNetwork' + - 'Get-AzVirtualNetwork' +* Added support for viewing extended location of public IP address in the console + - 'New-AzPublicIpAddress' + - 'Get-AzPublicIpAddress' + +#### Az.RecoveryServices +* Fixed Disable SQL AG AutoProtection. + +#### Az.Security +* General availability of Az.Security module +* Changed the name of Get-AzRegulatoryComplainceAssessment to Get-AzRegulatoryComplianceAssessment to fix typo + +#### Az.Sql +* Added 'RestrictOutboundNetworkAccess' parameter to following cmdlets + - 'New-AzSqlServer' + - 'Set-AzSqlServer' +* Added new cmdlets for CRUD operations on Allowed FQDNs of Outbound Firewall rules + 'Get-AzSqlServerOutboundFirewallRule' + 'New-AzSqlServerOutboundFirewallRule' + 'Remove-AzSqlServerOutboundFirewallRule' +* Fixed the identity logic for SystemAssigned,UserAssigned identities for New-AzSqlServer, New-AzSqlInstance +* Updated cmdlets for getting and updating SQL database's differential backup frequency + 'Get-AzSqlDatabaseBackupShortTermRetentionPolicy' + 'Set-AzSqlDatabaseBackupShortTermRetentionPolicy' +* Fixed Partial PUT issue for Azure Policy in 'Set-AzSqlServer' and 'Set-AzSqlInstance' + +#### Az.Storage +* Supported enable/disable Blob container soft delete + - 'Enable-AzStorageContainerDeleteRetentionPolicy' + - 'Disable-AzStorageContainerDeleteRetentionPolicy' +* Supported list deleted Blob containers + - 'Get-AzRmStorageContainer' + - 'Get-AzStorageContainer' +* Supported restore deleted Blob container + - 'Restore-AzStorageContainer' +* Supported secure SMB setting in File service properties + - 'Update-AzStorageFileServiceProperty' +* Supported create account with EnableNfsV3 + - 'New-AzStorageAccount' +* Supported input more copy blob parameters from pipeline [#15301] + - 'Start-AzStorageBlobCopy' + +#### Az.Websites +* Fixed 'Import-AzWebAppKeyVaultCertificate' to support ServerFarmId [#15091] +* Fixed 'Added an optional parameter to delete or keep Appservice plan when the last WebApp is removing from plan' + +### Thanks to our community contributors +* Mikey Bronowski (@MikeyBronowski) + * Update Get-AzSynapseTriggerRun.md (#15231) + * Update Get-AzSynapsePipelineRun.md by adding more examples covering more scenarios (#15232) +* @mjsharma, Adding note for alternate commands (#15359) +* @tomswedlund, Adding support for setting analytical storage schema type on account create/update for CosmosDB (#15362) +* @ylabade, Fix web app parameter name in examples (#15291) + + +## 6.1.0 - June 2021 +#### Az.Accounts +* Added cmdlet 'Open-AzSurveyLink' +* Supported certificate file as input parameter of Connect-AzAccount + +#### Az.Aks +* Fixed the issue that 'Set-AzAks' will fail in Automation Runbook. [#15006] + +#### Az.ApplicationInsights +* Fixed issue that 'ResourcegroupName' is missed when executing below cmdlets with 'InputObject' parameter [#14848] + * 'Get-AzApplicationInsightsLinkedStorageAccount' + * 'New-AzApplicationInsightsLinkedStorageAccount' + * 'Update-AzApplicationInsightsLinkedStorageAccount' + * 'Remove-AzApplicationInsightsLinkedStorageAccount' + +#### Az.Cdn +* Fixed profile missing issue in 'Remove-AzCdnProfile' cmdlet + +#### Az.Compute +* Updated Compute module to use the latest .Net SDK version 47.0.0. + +#### Az.ContainerInstance +* Removed the display of file share credential [#15224] + +#### Az.DataFactory +* Updated ADF .Net SDK version to 4.19.0 + +#### Az.EventHub +* Added functionality to accept input from pipeline for 'Get-AzEventHub' from 'Get-AzEventHubNamespace'. + +#### Az.HDInsight +* Support new azure monitor feature in HDInsight: + - Add cmdlet 'Get-AzHDInsightAzureMonitor' to allow customer to get the Azure Monitor status of HDInsight cluster. + - Add cmdlet 'Enable-AzHDInsightAzureMonitor' to allow customer to enable the Azure Monitor in HDInsight cluster. + - Add cmdlet 'Disable-AzHDInsightAzureMonitor' to allow customer to disable the Azure Monitor in HDInsight cluster. + +#### Az.KeyVault +* Removed duplicate list item in 'Get-AzKeyVault' [#15164] +* Added 'SecretManagement' tag to 'Az.KeyVault' module [#15173] + +#### Az.Network +* Updated cmdlets for route server for a more stable way to add IP configuration. +* Added support for getting a single private link resource. +* Added more detailed description about GroupId in 'New-AzPrivateLinkServiceConnection' +* Updated cmdlets to enable setting of PrivateRange on AzureFirewallPolicy. + - 'New-AzFirewallPolicy' + - 'Set-AzFirewallPolicy' +* Updated cmdlets to add NatRules in VirtualNetworkGateway and BgpRouteTranslationForNat. + - 'New-AzVirtualNetworkGateway' + - 'Set-AzVirtualNetworkGateway' +* Updated cmdlets to add EngressNatRules and EgressNatRules in VirtualNetworkGateway Connection. + - 'New-AzVirtualNetworkGatewayConnection' + - 'Set-AzVirtualNetworkGatewayConnection' +* Updated cmdlet to enable setting of FlowTimeout in VirtualNetwork. + - 'New-AzVirtualNetwork' +* Added cmdlets for Get/Create/Update/Delete VirtualNetworkGatewayNatRules. + - 'New-AzVirtualNetworkGatewayNatRule' + - 'Update-AzVirtualNetworkGatewayNatRule' + - 'Get-AzVirtualNetworkGatewayNatRule' + - 'Remove-AzVirtualNetworkGatewayNatRule' +* Added a new cmdlet for Sync on VirtualNetworkPeering + - 'Sync-AzVirtualNetworkPeering' +* Updated cmdlets to add new properties and redefined an existing property in the VirtualNetworkPeering + - 'Add-AzVirtualNetworkPeering' + - 'Get-AzVirtualNetworkPeering' +* Updated cmdlets to enable setting of PreferredRoutingGateway on VirtualHub. + - 'New-AzVirtualHub' + - 'Update-AzVirtualHub' +* Updated cmdlets to expose two read-only properties of client certificate. + - 'Get-AzApplicationGatewayTrustedClientCertificate' + +#### Az.RecoveryServices +* Added cross tenant DS Move. +* Removed restriction to fetch recovery points only for a 30 days time range. +* Enabled CRR for new regions. + +#### Az.Resources +* Allowed naming the deployment when testing deployments [#11497] + +#### Az.SignalR +* Changed to 'Allow' and 'Deny' parameters of 'Update-AzSignalRNetworkAcl' cmdlet: + - Accepted 'Trace' as a valid value. + - Accepted '@()' as empty collection to clear the list. +* Supported 'ResourceGroupCompleter' and 'ResourceNameCompleter' in the applicable cmdlets. +* Deprecated the 'HostNamePrefix' property of output type 'PSSignalRResource' of following cmdlets: + - 'Get-AzSignalR' + - 'New-AzSignalR' + - 'Update-AzSignalR' + +#### Az.Sql +* Added option to support short version of maintenance configuration id for Managed Instance in 'New-AzSqlInstance' and 'Set-AzSqlInstance' cmdlets +* Added HighAvailabilityReplicaCount to 'New-AzSqlDatabaseSecondary' +* Added External Administrator and AAD Only Properties to AzSqlServer and AzSqlInstance + - Added option to specify '-ExternalAdminName', '-ExternalAdminSid', '-EnableActiveDirectoryOnlyAuthentication' in 'New-AzSqlInstance' and 'Set-AzSqlInstance' cmdlets + - Added option to expand external administrators information using '-ExpandActiveDirectoryAdministrator' in 'Get-AzSqlServer' and 'Get-AzSqlInstance' cmdlets +* Fixed 'Set-AzSqlDatabase' to no longer default ReadScale to Disabled when not specified +* Fixed 'Set-AzSqlServer' and 'Set-AzSqlInstance' for partial PUT with only identity and null properties +* Added parameters related to UMI in 'New-AzSqlServer', 'New-AzSqlInstance', 'Set-AzSqlServer' and 'Set-AzSqlInstance' cmdlets. +* Added -AutoRotationEnabled parameter to following cmdlets: + - 'Set-AzSqlServerTransparentDataEncryptionProtector' + - 'Get-AzSqlServerTransparentDataEncryptionProtector' + - 'Set-AzSqlInstanceTransparentDataEncryptionProtector' + - 'Get-AzSqlInstanceTransparentDataEncryptionProtector' + +#### Az.Storage +* Supported create file share with NFS/SMB enabledEnabledProtocol and RootSquash, and update share with RootSquash + - 'New-AzRmStorageShare' + - 'Update-AzRmStorageShare' +* Supported enable Smb Multichannel on File service + - 'Update-AzStorageFileServiceProperty' +* Fixed copy inside same account issue by access source with anonymous credential, when copy Blob inside same account with Oauth credential +* Removed StorageFileDataSmbShareOwner from value set of parameter DefaultSharePermission in create/update storage account + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' + +#### Az.Websites +* Fixed issue that prevented removing rules by name and unique identifier in 'Remove-AzWebAppAccessRestrictionRule' +* Fixed issue that defaults AlwaysOn to false in 'Set-AzWebAppSlot' + +### Thanks to our community contributors +* Andy Roberts (@andyr8939), Removing unused TimeGrain variable from example (#15062) +* Ashley Roll (@AshleyRoll), Remove Write-Host leaking file share credentials (#15225) +* Kailash Mandal (@KaishM), Update New-AzPublicIpAddress.md (#15040) +* Olivier Miossec (@omiossec), Update Get-AzExpressRouteCircuitRouteTable.md (#15054) +* Scott (@S-T-S), Update Set-AzNetworkInterface.md (#15112) +* @sohaibMSFT, Application Gateway AutoScale Example (#15071) +* @Srihsu, Update Split-AzReservation.md (#15049) +* @srozemuller, typo in examples resourcegroup parameter (#15146) + + +## 6.0.0 - May 2021 +Az 6.0.0 (Az.Accounts 2.3.0) is only supported on Windows PowerShell 5.1, PowerShell 7.0 version 7.0.6 or greater and PowerShell 7.1 version 7.1.3 or greater, open https://aka.ms/install-powershell to learn how to upgrade. For further information, go to https://aka.ms/azpslifecycle. + +#### Az.Accounts +* Upgraded Azure.Identity to 1.4 and MSAL to 4.30.1 +* Removed obsolete parameters 'ManagedServiceHostName', 'ManagedServicePort' and 'ManagedServiceSecret' of cmdlet 'Connect-AzAccount', environment variables 'MSI_ENDPOINT' and 'MSI_SECRET' could be used instead +* Customize display format of PSAzureRmAccount to hide secret of service principal [#14208] +* Added optional parameter 'AuthScope' to 'Connect-AzAccount' to support enhanced authentication of data plane features +* Set retry times by environment variable [#14748] +* Supported subject name issuer authentication + +#### Az.Compute +* Added 'Invoke-AzVmInstallPatch' to support patch installation in VMs using PowerShell. +* Updated Compute module to use the latest .Net SDK version 46.0.0. +* Added optional parameter '-EdgeZone' to the following cmdlets: + - 'Get-AzVMImage + - 'Get-AzVMImageOffer' + - 'Get-AzVMImageSku' + - 'New-AzDiskConfig' + - 'New-AzImageConfig' + - 'New-AzSnapshotConfig' + - 'New-AzVM' + - 'New-AzVmssConfig' + - 'New-AzVMSS' + +#### Az.ContainerInstance +* Added new cmdlets: 'Start-AzContainerGroup', 'Stop-AzContainerGroup' [#10773], 'Invoke-AzContainerInstanceCommand' [#7648], 'Update-AzContainerGroup', 'Add-AzContainerInstanceOutput', 'Get-AzContainerInstanceCachedImage', 'Get-AzContainerInstanceCapability', 'Get-AzContainerInstanceUsage', 'New-AzContainerGroupImageRegistryCredentialObject', 'New-AzContainerGroupPortObject', 'New-AzContainerGroupVolumeObject', 'New-AzContainerInstanceEnvironmentVariableObject', 'New-AzContainerInstanceInitDefinitionObject', 'New-AzContainerInstanceObject', 'New-AzContainerInstancePortObject' and 'New-AzContainerInstanceVolumeMountObject' +* Supported Log Analytics parameters in 'New-AzContainerGroup' [#11117] +* Added support to specify network profile and the name of Azure File Share in 'New-AzContainerGroup' [#9993] [#12218] +* Added support to specify environment variables as SecureValue [#10110] [#10640] + +#### Az.ContainerRegistry +* Fixed username and password issue in 'Import-AzContainerRegistryImage' [#14971] +* Fixed data plane operations (repository, tag, manifest) failed cross registry in single Powershell session [#14849] + +#### Az.CosmosDB +* Introduced support for Sql data plane RBAC, allowing the creation, updating, removal, and retrieval of Role Definitions and Role Assignments + - The following cmdlets are added: + - Get-AzCosmosDBSqlRoleDefinition, Get-AzCosmosDBSqlRoleAssignment, + - New-AzCosmosDBSqlRoleDefinition, New-AzCosmosDBSqlRoleAssignment, + - Remove-AzCosmosDBSqlRoleDefinition, Remove-AzCosmosDBSqlRoleAssignment, + - Update-AzCosmosDBSqlRoleDefinition, Update-AzCosmosDBSqlRoleAssignment, + - New-AzCosmosDBSqlPermission + +#### Az.DesktopVirtualization +* Upgraded api version to 2021-02-01-preview. + +#### Az.Functions +* Added support in function app creation for Python 3.9 and Node 14 function apps +* Removed support in function app creation for V2, Python 3.6, Node 8, and Node 10 function apps +* Updated IdentityID parameter from string to string array in Update-AzFunctionApp. This is to be consistent with New-AzFunctionApp which has the same parameter as a string array +* Updated FullyQualifiedErrorId for an invalid Functions version from FunctionsVersionIsInvalid to FunctionsVersionNotSupported +* When creating a Node.js function app, if no runtime version is specified, the default runtime version is set to 14 instead of 12 + +#### Az.KeyVault +* Provided key size for RSA key [#14819] + +#### Az.Kusto +* Bumped API version to stable 2021-01-01 + +#### Az.Maintenance +* Bumped API version to stable 2021-05-01 + +#### Az.Migrate +* Fixed an issue in Initialize-AzMigrateReplicationInfrastructure.ps1 + +#### Az.Network +* Updated validation to allow passing zero value for saDataSizeKilobytes parameter + - 'New-AzureRmIpsecPolicy' +* Added optional parameter '-EdgeZone' to the following cmdlets: + - 'New-AzNetworkInterface' + - 'New-AzPublicIpAddress' + - 'New-AzVirtualNetwork' + +#### Az.RecoveryServices +* Fixed security issue with SQL restore, this is a necessary breaking change. TargetContainer becomes mandatory for Alternate Location Restore. +* Removed Set-AzRecoveryServicesBackupProperties cmdlet alias, Set-AzRecoveryServicesBackupProperty is supported. +* Removed Get-AzRecoveryServicesBackupJobDetails cmdlet alias, Get-AzRecoveryServicesBackupJobDetail is supported. +* Added support for cross subscription DS Move. +* Azure Site Recovery support for VMware to Azure disaster recovery scenarios using RCM as the control plane. + +#### Az.Resources +* Changed '-IdentifierUris' in 'New-AzADApplication' to optional parameter +* Removed generated 'DisplayName' of ADApplication created by 'New-AzADServicePrincipal' +* Updated SDK to 3.13.1-preview to use GA TemplateSpecs API version +* Added 'AdditionalProperties' to PSADUser and PSADGroup [#14568] +* Supported 'CustomKeyIdentifier' in 'New-AzADAppCredential' and 'Get-AzADAppCredential' [#11457], [#13723] +* Changed 'MainTemplate' to be shown by the default formatter for Template Spec Versions + +#### Az.SecurityInsights +* GA release for `Az.SecurityInsights` + +#### Az.ServiceFabric +* Removed deprecated cluster certificate commands: + - 'Add-AzServiceFabricClusterCertificate' + - 'Remove-AzServiceFabricClusterCertificate' +* Changed PSManagedService model to avoid using the properties parameter directly from sdk. +* Removed deprecated parameters for managed cmdlets: + - 'ReverseProxyEndpointPort' + - 'InstanceCloseDelayDuration' + - 'ServiceDnsName' + - 'InstanceCloseDelayDuration' + - 'DropSourceReplicaOnMove' +* Fixed 'Update-AzServiceFabricReliability' to update correctly the vm instance count of the primary node type on the cluster resource. + +#### Az.Sql +* Updated 'Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline' documentation to include example of define array of array with one inner array. +* Added cmdlet 'Copy-AzSqlDatabaseLongTermRetentionBackup' + - Copy LTR backups to different servers +* Added cmdlet 'Update-AzSqlDatabaseLongTermRetentionBackup' + - Update Backup Storage Redundancy values for LTR backups +* Added CurrentBackupStorageRedundancy, RequestedBackupStorageRedundancy to 'Get-AzSqlDatabase', 'New-AzSqlDatabase', 'Set-AzSqlDatabase', 'New-AzSqlDatabaseSecondary', 'Set-AzSqlDatabaseSecondary', 'New-AzSqlDatabaseCopy' + - Changed BackupStorageRedundancy value to CurrentBackupStorageRedundancy, RequestedBackupStorageRedundancy to reflect both the current value and what has been requested if a change was made + +#### Az.Storage +* Supported file share snapshot + - 'New-AzRmStorageShare' + - 'Get-AzRmStorageShare' + - 'Remove-AzRmStorageShare' +* Supported remove file share with it's snapshot (leased and not leased), by default remove file share will fail when share has snapshot + - 'Remove-AzRmStorageShare' +* Supported Set/Get/Remove blob inventory policy + - 'New-AzStorageBlobInventoryPolicyRule' + - 'Set-AzStorageBlobInventoryPolicy' + - 'Get-AzStorageBlobInventoryPolicy' + - 'Remove-AzStorageBlobInventoryPolicy' +* Supported DefaultSharePermission in create/update storage account + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' +* Supported AllowCrossTenantReplication in create/update storage account + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' +* Supported Set Object Replication Policy with SourceAccount/DestinationAccount as Storage account resource Id + - 'Set-AzStorageObjectReplicationPolicy' +* Supported set SasExpirationPeriod as TimeSpan.Zero + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount +* Make sure the correct account name is used when create account credential + - 'New-AzStorageContext' + +#### Az.StorageSync +* Deprecated 'Invoke-AzStorageSyncFileRecall' + - Customers should instead use 'Invoke-StorageSyncFileRecall', a cmdlet that is shipped with the Azure File Sync agent. +* Removed offline data transfer feature in 'New-AzStorageSyncServerEndpoint'. + +#### Az.StreamAnalytics +* Bumped API version to 2017-04-01-preview +* Added StreamAnalytics Cluster support + +#### Az.Websites +* updated 'Set-AzAppServicePlan' to keep existing Tags when adding new Tags +* Fixed 'Set-AzWebApp' to set the AppSettings +* updated 'Set-AzWebAppSlot' to set FtpsState +* Added support for StaticSites. + +### Thanks to our community contributors +* @corichte, Update New-AzVirutalNetworkGatewayConnection Ex 1 (#14858) +* Hiroshi Yoshioka (@hyoshioka0128) + * Typo "Azure SQL database"→"Azure SQL Database" (#14883) + * Typo "Azure SQL managed instance"→"Azure SQL Managed Instance" (#14891) + * Typo "Azure SQL managed instance"→"Azure SQL Managed Instance" (#14892) + * Typo "Azure SQL managed instance"→"Azure SQL Managed Instance" (#14902) + * Typo "Azure SQL managed instance"→"Azure SQL Managed Instance" (#14901) + * Typo "Azure SQL managed instance"→"Azure SQL Managed Instance" (#14900) + * Typo "Azure SQL managed instance"→"Azure SQL Managed Instance" (#14898) + * Typo "Azure SQL managed instance"→"Azure SQL Managed Instance" (#14899) +* Jay Zelos (@jzelos), Updated example 3 to use correct parameter (#14852) +* @StevePantol, Update New-AzVMwarePrivateCloud.md (#14996) + + +## 5.9.0 - May 2021 +#### Az.Aks +* Added support 'AcrNameToAttach' in 'Set-AzAksCluster'. [#14692] +* Added support 'AcrNameToDetach' in 'Set-AzAksCluster'. [#14693] +* Added 'Set-AzAksClusterCredential' to reset the ServicePrincipal of an existing AKS cluster. + +#### Az.Automation +* Added support for User Assigned Identities and PublicNetworkAccess flag + +#### Az.Cdn +* Added cmdlets to support new AFD Premium / Standard SKUs + +#### Az.Compute +* Updated the 'Set-AzVMDiskEncryptionExtension' cmdlet to support ADE extension migration from two pass (version with AAD input parameters) to single pass (version without AAD input parameters). + - Added a switch parameter '-Migrate' to trigger migration workflow. + - Added a switch parameter '-MigrationRecovery' to trigger recovery workflow for VMs experiencing failures after migration from two pass ADE. + +#### Az.DataFactory +* Added User Assigned Identities to Data Factory. +* Updated ADF .Net SDK version to 4.18.0 + +#### Az.FrontDoor +* Allowed Enable-AzFrontDoorCustomDomainHttps's SecretVersion parameter to be optional to support bring-your-own-certificate auto-rotation + +#### Az.KeyVault +* Fixed a bug for 'Get-AzKeyVaultSecret -IncludeVersions' when current version is disabled [#14740] +* Displayed error code and message when updating purged secret [#14800] + +#### Az.RecoveryServices +* Azure Site Recovery support for Multiple IP per NIC for Azure to Azure provider. +* Azure Site Recovery support for SqlServerLicenseType for VMware to Azure and HyperV to Azure providers. +* Azure Site Recovery support for Availability set for VMware to Azure and HyperV to Azure providers. +* Azure Site Recovery support for TargetVmSize for VMware to Azure and HyperV to Azure providers. +* Azure Site Recovery support for ResourceTagging for VMware to Azure and HyperV to Azure providers. +* Azure Site Recovery support for Virtual Machine Scale Set for Azure to Azure provider. +* Added support for restoring unmanaged disks vm as managed disks. + +#### Az.Resources +* Added parameter 'ObjectType' for 'New-AzRoleAssignment' + +#### Az.ServiceFabric +* Upgraded Managed Cluster commands to use Service Fabric Managed Cluster SDK version 1.0.0 which uses service fabric resource provider api-version 2021-05-01. +* 'New-AzServiceFabricManagedCluster' add parameters UpgradeCadence and ZonalResiliency. +* 'New-AzServiceFabricManagedNodeType' add parameters DiskType, VmUserAssignedIdentity, IsStateless and MultiplePlacementGroup. +* 'New-AzServiceFabricManagedClusterService' and 'Set-AzServiceFabricManagedClusterService' mark parameters for deprecation: InstanceCloseDelayDuration, DropSourceReplicaOnMove and ServiceDnsName. They are not supported. + +#### Az.ResourceMover +* General availability of 'Az.ResourceMover' module + +#### Az.Storage +* Supported create/update storage account with KeyExpirationPeriod and SasExpirationPeriod + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' +* Supported create/update storage account with keyvault encryption and access keyvault with user assigned identity + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' +* Supported EdgeZone in create storage account + - 'New-AzStorageAccount' +* Fixed an issue that delete immutable blob will prompt incorrect message. + - 'Remove-AzStorageAccount' +* Allowed update Storage Account KeyVault properties by cleanup Keyversion to enable key auto rotation [#14769] + - 'Set-AzStorageAccount' +* Added breaking change warning message for upcoming cmdlet breaking change + - 'Remove-AzRmStorageShare' + +### Thanks to our community contributors +* Thomas Lee (@doctordns), Update Get-AzEnvironment.md (#14704) +* Fabian (@FullByte), Example with wrong parameter (typo) (#14743) +* @gradinDotCom, Update Get-AzNetworkWatcherNextHop.md (#14813) +* Dr Greg Low (@greglow-sdu), Update Get-AzSqlServerDnsAlias.md (#14737) +* Prateek Singh (@PrateekKumarSingh) + * fixing a typo (#14779) + * fixing typo (#14773) +* Remco Eissing (@remcoeissing) + * Fixed typos in Restore-AzApiManagement (#14770) + * Example 2 to use New-AzPolicyExemption (#14716) +* @sharma224 + * User identity changes (#14803) + * Supporting Customer managed key (#14680) +* Yannick Dils (@yannickdils), Update Location explanation (#14719) + + +## 5.8.0 - April 2021 +#### Az.Accounts +* Fallback to first valid context if current default context key is 'Default' which is invalid + +#### Az.Automation +* Added support for Customer Managed Key Encryption with System Assigned Identity +* Fixed issue that disables the schedule for update deployment if schedule was re-created with same name + +#### Az.Compute +* Fixed a bug when 1 data disk attached to VMSS for Remove-AzVmssDataDisk [#13368] +* Added new cmdlets to support TrustedLaunch related cmdlets: + - 'Set-AzVmSecurityProfile' + - 'Set-AzVmUefi' + - 'Set-AzVmssSecurityProfile' + - 'Set-AzVmssUefi' +* Edited default value for Size parameter in New-AzVM cmdlet from Standard_DS1_v2 to Standard_D2s_v3. + +#### Az.ContainerRegistry +* Fixed bug in 'Get-AzContainerRegistryManifest' showing incorrect image name + +#### Az.HDInsight +* Supported getting default vmsize from backend if customer does not provide the related parameters: '-WorkerNodeSize', '-HeadNodeSize', '-ZookeeperNodeSize', '-EdgeNodeSize', '-KafkaManagementNodeSize'. + +#### Az.HealthcareApis +* Added support for Acr LoginServers + +#### Az.KeyVault +* Fixed a bug for 'Get-AzKeyVaultSecret -AsPlainText' if the secret is not found [#14645] + +#### Az.Migrate +* Nullref Bug fixed in get discovered server and initialize replication infrastructure commandlets. + +#### Az.Monitor +* Added cmdlet to get diagnostic setting categories for subscription + - 'Get-AzSubscriptionDiagnosticSettingCategory' +* Supported subscription diagnostic setting operations with new parameter: SubscriptionId + - 'Get-AzDiagnosticSetting' + - 'New-AzDiagnosticSetting' + - 'Remove-AzDiagnosticSetting' +* Supported 'AutoMitigate' parameter in metric alert rule properties. The flag indicates whether the alert should be auto resolved or not. + +#### Az.Resources +* Added upcoming breaking change warnings on below cmdlets, because the value of 'IdentifierUris' parameter will need verified domain. + - 'New-AzADApplication' + - 'Update-AzADApplication' + - 'New-AzADServicePrincipal' + - 'Update-AzADServicePrincipal' +* Ignored Bicep warning message in error stream if exitcode equals zero. + +#### Az.Sql +* Added cmdlet output breaking change warnings to the following: + - 'New-AzSqlDatabase' + - 'Get-AzSqlDatabase' + - 'Set-AzSqlDatabase' + - 'Remove-AzSqlDatabase' + - 'New-AzSqlDatabaseSecondary' + - 'Remove-AzSqlDatabaseSecondary' + - 'Get-AzSqlDatabaseReplicationLink' + - 'New-AzSqlDatabaseCopy' + - 'Set-AzSqlDatabaseSecondary' + +#### Az.Storage +* Fixed copy blob fail with source context as Oauth [#14662] + - 'Start-AzStorageBlobCopy' + +#### Az.StreamAnalytics +* Added upcoming breaking change warning message to all cmdlets because of upcoming changes on parameters. + +### Thanks to our community contributors +* Andrei Zhukouski (@BurgerZ), Fix typo (#14575) +* Mark Allison (@markallisongit), Update Invoke-AzSqlInstanceFailover.md (#14603) + + +## 5.7.0 - March 2021 +#### Az.Accounts +* Fixed incorrect warning message on Windows PowerShell [#14556] +* Set Azure Environment variable 'AzureKeyVaultServiceEndpointResourceId' according to the value of 'AzureKeyVaultDnsSuffix' when discovering environment + +#### Az.Automation +* Fixed the issue for starting Python3 runbooks with parameters + +#### Az.DataFactory +* Updated ADF .Net SDK version to 4.15.0 + +#### Az.EventHub +* Fixed that 'New-AzServiceBusAuthorizationRuleSASToken' returns invalid token. [#12975] + +#### Az.IotHub +* Updated IoT Hub Management SDK and models to version 3.0.0 (api-version 2020-03-01) + +#### Az.KeyVault +* Supported upcoming new API design for 'Export-AzKeyVaultSecurityDomain' +* Fixed several typos in cmdlet messages [#14341] + +#### Az.Network +* Added new cmdlets to replace old product name 'virtual router' with new name 'route server' in the future. + - 'Get-AzRouteServerPeerAdvertisedRoute' + - 'Get-AzRouteServerPeerAdvertisedRoute' + - Added deprecation attribute warning to the old cmdlets. +* Updated 'set-azExpressRouteGateway' to allow parameter -MinScaleUnits without specifying -MaxScaleUnits +* Updated cmdlets to enable setting of VpnLinkConnectionMode on VpnSiteLinkConnections. + - 'New-AzVpnSiteLinkConnection' + - 'Update-AzVpnConnection' +* Added new cmdlet to fetch IKE Security Associations for VPN Site Link Connections. + - 'Get-VpnSiteLinkConnectionIkeSa' +* Added new cmdlet to reset a Virtual Network Gateway Connection. + - 'Reset-AzVirtualNetworkGatewayConnection' +* Added new cmdlet to reset a Vpn Site Link Connection. + - 'Reset-VpnSiteLinkConnection' +* Updated cmdlets to enable setting an optional parameter -TrafficSelectorPolicies + - 'New-AzVpnConnection' + - 'Update-AzVpnConnection' +* Bug fix for update vpnServerConfiguration. +* Add scenarioTest for p2s multi auth VWAN. +* Added multi auth feature support for VNG + - 'Get-AzVpnClientConfiguration' + - 'New-AzVirtualNetworkGateway' + - 'Set-AzVirtualNetworkGateway' + +#### Az.RecoveryServices +* Added Cross Zonal Restore for managed virtual machines. + +#### Az.RedisEnterpriseCache +* GA version of Az.RedisEnterpriseCache + +#### Az.Resources +* Redirected bicep message to verbose stream +* Removed the logic of copying Bicep template file to temp folder. +* Add support of policy exemption resource type +* Fixed what-if functionality when using '-QueryString' parameter. +* Normalized '-QueryString' starting with '?' for scenarios involving dynamic parameters. + +#### Az.ServiceBus +* Fixed that 'New-AzServiceBusAuthorizationRuleSASToken' returns invalid token. [#12975] + +#### Az.ServiceFabric +* Added parameters 'VMImagePublisher', 'VMImageOffer', 'VMImageSku', 'VMImageVersion' to 'Add-AzServiceFabricNodeType' to facilitate easy alternate OS image creation for new node type. +* Added parameter 'IsPrimaryNodeType' to 'Add-AzServiceFabricNodeType' to be able to create an additional primary node type, for the purpose of transitioning the primary node type to another one in the case of OS migration. +* 'Add-AzServiceFabricNodeType' now correctly copies the LinuxDiagnostic extension. This was previously not working for Linux. +* 'Add-AzServiceFabricNodeType' now correctly copies the RDP/SSH load balancer inbound NAT port mapping to the new node type. +* Added template for 'UbuntuServer1804' for creating Ubuntu 18.04 clusters using 'New-AzServiceFabricCluster'. +* 'Remove-AzServiceFabricNodeType' was incorrectly blocking Bronze durability node types for removal, and this has been updated to only block when the Bronze durability level differs between the SF node type and VMSS setting. +* Added cmdlet 'Update-AzServiceFabricVmImage' to update the delivered SF runtime package type. This must be changed when migrating from Ubuntu 16 to 18. +* Added cmdlet 'Update-AzServiceFabricNodeType' to update the properties of a cluster node type. For now this is solely used to update whether the node type is primary via bool parameter '-IsPrimaryNodeType False'. +* 'Update-AzServiceFabricReliability' is now able to update reliability level when the cluster has more than one primary node type. To do this, the name of the node type is supplied via the new -NodeType parameter. +* Added new cmdlets for managed applications: + - 'New-AzServiceFabricManagedClusterApplication' + - 'Get-AzServiceFabricManagedClusterApplication' + - 'Set-AzServiceFabricManagedClusterApplication' + - 'Remove-AzServiceFabricManagedClusterApplication' + - 'New-AzServiceFabricManagedClusterApplicationType' + - 'Get-AzServiceFabricManagedClusterApplicationType' + - 'Set-AzServiceFabricManagedClusterApplicationType' + - 'Remove-AzServiceFabricManagedClusterApplicationType' + - 'New-AzServiceFabricManagedClusterApplicationTypeVersion' + - 'Get-AzServiceFabricManagedClusterApplicationTypeVersion' + - 'Set-AzServiceFabricManagedClusterApplicationTypeVersion' + - 'Remove-AzServiceFabricManagedClusterApplicationTypeVersion' + - 'New-AzServiceFabricManagedClusterService' + - 'Get-AzServiceFabricManagedClusterService' + - 'Set-AzServiceFabricManagedClusterService' + - 'Remove-AzServiceFabricManagedClusterService' +* Upgraded Managed Cluster commands to use Service Fabric Managed Cluster SDK version 1.0.0-beta.1 which uses service fabric resource provider api-version 2021-01-01-preview. + +#### Az.Sql +* Added cmdlet 'New-AzSqlServerTrustGroup' +* Added cmdlet 'Remove-AzSqlServerTrustGroup' +* Added cmdlet 'Get-AzSqlServerTrustGroup' + +#### Az.Storage +* Fixed an issue that list account from resource group won't use nextlink + - 'Get-AzStorageAccount' +* Supported ChangeFeedRetentionInDays when Enable ChangeFeed on Blob service + - 'Update-AzStorageBlobServiceProperty' + +#### Az.Websites +* Updated 'Add-AzWebAppAccessRestrictionRule' to allow all supported Service Tags and validate against Service Tag API. + +### Thanks to our community contributors +* Freddie Sackur (@fsackur), Fix invalid SAS token from New-AzServiceBusAuthorizationRuleSASToken and New-AzEventHubAuthorizationRuleSASToken (#14535) +* Serafín Martín (@infoTrainingym), Unkown parameter (#14515) +* João Carlos Ferra de Almeida (@Jalmeida1994), Update Get-AzAksNodePool.md (#14503) +* Liam Barnett (@liambarnett), Fixed 3 typos in the document (#14335) +* @sbojjawar-Msft, Update Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md (#14432) +* Yannick Dils (@yannickdils), Remove resource group from get-azloadbalancer this results in a region / zone update. (#14417) + + +## 5.6.0 - March 2021 +#### Az.Accounts +* Upgrade Azure.Identity to fix the issue that Connect-AzAccount fails when ADFS credential is used [#13560] + +#### Az.Automation +* Fixed the issue that string cannot be serialized correctly. [#14215] +* Added Support for Python3 Runbook Type + +#### Az.Compute +* Added parameter '-EnableHotpatching' to the 'Set-AzVMOperatingSystem' cmdlet for Windows machines. +* Added parameter '-PatchMode' to the Linux parameter sets in the cmdlet 'Set-AzVMOperatingSystem'. +* [Breaking Change] Breaking changes for users in the public preview for the VM Guest Patching feature. + - Removed property 'RebootStatus' from the 'Microsoft.Azure.Management.Compute.Models.LastPatchInstallationSummary' object. + - Removed property 'StartedBy' from the 'Microsoft.Azure.Management.Compute.Models.LastPatchInstallationSummary' object. + - Renamed property 'Kbid' to 'KbId' in the 'Microsoft.Azure.Management.Compute.Models.VirtualMachineSoftwarePatchProperties' object. + - Renamed property 'patches' to 'availablePatches' in the 'Microsoft.Azure.Management.Compute.Models.VirtualMachineAssessPatchesResult' object. + - Renamed object 'Microsoft.Azure.Management.Compute.Models.SoftwareUpdateRebootBehavior' to 'Microsoft.Azure.Management.Compute.Models.VMGuestPatchRebootBehavior'. + - Renamed object 'Microsoft.Azure.Management.Compute.Models.InGuestPatchMode' to 'Microsoft.Azure.Management.Compute.Models.WindowsVMGuestPatchMode'. +* [Breaking Change] Removed all 'ContainerService' cmdlets. The Container Service API was deprecated in January 2020. + - 'Add-AzContainerServiceAgentPoolProfile' + - 'Get-AzContainerService' + - 'New-AzContainerService' + - 'New-AzContainerServiceConfig' + - 'Remove-AzContainerService' + - 'Remove-AzContainerServiceAgentPoolProfile' + - 'Update-AzContainerService' + +#### Az.ContainerRegistry +* Fixed authentication for `Connect-AzContainerRegistry` + +#### Az.CosmosDB +* Introduced NetworkAclBypass and NetworkAclBypassResourceIds for Database Account cmdlets. +* Introduced ServerVersion parameter to Update-AzCosmosDBAccount. +* Introduced BackupInterval and BackupRetention for Database Account cmdlets + +#### Az.DataFactory +* Updated ADF .Net SDK version to 4.14.0 + +#### Az.Migrate +* Az.Migrate GA +* Incorporated Initialize-AzMigrateReplicationInfrastructure as a cmdlet in the Az.Migrate module, from the external script that is run currently today. +* Made some parameters of New-AzMigrateServerReplication, New-AzMigrateDiskMapping case insensitive. +* Added support for scale appliance change, to handle new V3 keys. + +#### Az.RecoveryServices +* Added null check for target storage account in FileShare restore. + +#### Az.Resources +* Added support for Azure resources deployment in Bicep language +* Fixed issues with TemplateSpec deployments in 'New-AzTenantDeployment' and 'New-AzManagementGroupDeployment' +* Added support for '-QueryString' parameter in 'Test-Az*Deployments' cmdlets +* Fixed issue with dynamic parameters when 'New-Az*Deployments' is used with '-QueryString' +* Added support for '-TemplateParameterObject' parameter while using '-TemplateSpecId' parameter in 'New-Az*Deployments' cmdlets +* Fixed the inaccurate error message received on trying to deploy a non-existent template spec + +#### Az.Storage +* Upgraded to Microsoft.Azure.Management.Storage 19.0.0, to support new API version 2021-01-01. +* Supported resource access rule in NetworkRuleSet + - 'Update-AzStorageAccountNetworkRuleSet' + - 'Add-AzStorageAccountNetworkRule' + - 'Remove-AzStorageAccountNetworkRule' +* Supported Blob version and Append Blob type in Management Policy + - 'Add-AzStorageAccountManagementPolicyAction' + - 'New-AzStorageAccountManagementPolicyFilter' + - 'Set-AzStorageAccountManagementPolicy' +* Supported create/update account with AllowSharedKeyAccess + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' +* Supported create Encryption Scope with RequireInfrastructureEncryption + - 'New-AzStorageEncryptionScope' +* Supported copy block blob synchronously, with encryption scope + - 'Copy-AzStorageBlob' +* Fixed issue that Get-AzStorageBlobContent use wrong directory separator char on Linux and MacOS [#14234] + +#### Az.Websites +* Introduced an option to give custom timeout for 'Publish-AzWebApp' +* Added support for App Service Environment + - 'New-AzAppServiceEnvironment' + - 'Remove-AzAppServiceEnvironment' + - 'Get-AzAppServiceEnvironment' + - 'New-AzAppServiceEnvironmentInboundServices' + +### Thanks to our community contributors +* @alunmj, Small spelling, formatting changes (#14155) +* @chakra146, Update Add-AzLoadBalancerInboundNatPoolConfig.md (#14231) +* Martin Ehrnst (@ehrnst), Fixed a typo in the cmdlet (#14112) +* Jan David Narkiewicz (@jdnark) + * Examples used New-AzAks which is legacy cmdlet and the alias for New-AzAksCluster. Changed examples to use New-AzAksCluster which is the cmdlet this documentation page targets. (#14088) + * Type fox: changed SshKeyVaule to SshKeyValue (#14087) +* Ivan Kulezic (@kukislav), Add sql mi maintenance configuration examples (#14216) +* @webguynj, Update Set-AzNetworkSecurityRuleConfig.md (#14176) +* Yannick Dils (@yannickdils), Added an additional cmdline to the example which applies the changes to the load balancer (#14185) + + +## 5.5.0 - February 2021 +#### Az.Accounts +* Tracked CloudError code in exception +* Raised 'ContextCleared' event when 'Clear-AzContext' was executed + +#### Az.Aks +* Refined error messages of cmdlet failure. +* Upgraded exception handling to use Azure PowerShell related exceptions. +* Fixed the issue that user could not use provided service principal to create Kubernetes cluster. [#13938] + +#### Az.Automation +* Fixed the issue of processing 'PSCustomObject' and 'Array'. + +#### Az.Compute +* Added parameter '-EnableAutomaticUpgrade' to 'Set-AzVmExtension' and 'Add-AzVmssExtension'. +* Removed FilterExpression parameter from 'Get-AzVMImage' cmdlet documentation. +* Added deprecation message to the ContainerService cmdlets: + - 'Add-AzureRmContainerServiceAgentPoolProfileCommand' + - 'Get-AzContainerService' + - 'New-AzContainerService' + - 'New-AzContainerServiceConfig' + - 'Remove-AzContainerService' + - 'Remove-AzContainerServiceAgentPoolProfile' + - 'Update-AzContainerService' +* Added parameter '-BurstingEnabled' to 'New-AzDiskConfig' and 'New-AzDiskUpdateConfig' +* Added '-GroupByApplicationId' and '-GroupByUserAgent' parameters to the 'Export-AzLogAnalyticThrottledRequest' and 'Export-AzLogAnalyticRequestRateByInterval' cmdlets. +* Added 'VMParameterSet' parameter set to 'Get-AzVMExtension' cmdlet. Added new parameter '-VM' to this parameter set. + +#### Az.ContainerRegistry +* Added cmdlets to supported repository, manifest, and tag operations: + - 'Get-AzContainerRegistryRepository' + - 'Update-AzContainerRegistryRepository' + - 'Remove-AzContainerRegistryRepository' + - 'Get-AzContainerRegistryManifest' + - 'Update-AzContainerRegistryManifest' + - 'Remove-AzContainerRegistryManifest' + - 'Get-AzContainerRegistryTag' + - 'Update-AzContainerRegistryTag' + - 'Remove-AzContainerRegistryTag' + +#### Az.Databricks +Supported -EnableNoPublicIP when creating a Databricks workspace + +#### Az.FrontDoor +* Added FrontDoorId to properties +* Added JSON Exclusions and RequestBodyCheck support to managed rules + +#### Az.HDInsight +* Added new parameter '-EnableComputeIsolation' and '-ComputeIsolationHostSku' to the cmdlet 'New-AzHDInsightCluster' to support compute isolation feature +* Added property 'ComputeIsolationProperties' and 'ConnectivityEndpoints' in the class AzureHDInsightCluster. + +#### Az.KeyVault +* Supported specifying key type and curve name when importing keys via a BYOK file + +#### Az.Network +* Added new cmdlets to replace old product name 'virtual router' with new name 'route server' in the future. + - 'New-AzRouteServer' + - 'Get-AzRouteServer' + - 'Remove-AzRouteServer' + - 'Update-AzRouteServer' + - 'Get-AzRouteServerPeer' + - 'Add-AzRouteServerPeer' + - 'Update-AzRouteServerPeer' + - 'Remove-AzRouteServerPeer' + - Added deprecation attribute warning to the old cmdlets. +* Bug fix in ExpressRouteLink MacSecConfig. Added new property 'SciState' to 'PSExpressRouteLinkMacSecConfig' +* Updated format list and format table views for Get-AzVirtualNetworkGatewayConnectionIkeSa + +#### Az.PolicyInsights +* Retracted changes made in powershell that increased request row limit. Removed incorrect statement of supporting paging + +#### Az.RecoveryServices +* modified policy validation limits as per backup service. +* Added Zone Redundancy for Recovery Service Vaults. +* Azure Site Recovery support for Proximity placement group for VMware to Azure and HyperV to Azure providers. +* Azure Site Recovery support for Availability zone for VMware to Azure and HyperV to Azure providers. +* Azure Site Recovery support for UseManagedDisk for HyperV to Azure provider + +#### Az.Resources +* Removed principal type on New-AzRoleAssignment and Set-AzRoleAssignment because current mapping was breaking certain scenarios + +#### Az.Sql +* Added MaintenanceConfigurationId to 'New-AzSqlDatabase', 'Set-AzSqlDatabase', 'New-AzSqlElasticPool' and 'Set-AzSqlElasticPool' +* Fixed regression in 'Set-AzSqlServerAudit' when PredicateExpression argument is provided + +#### Az.Storage +* Supported RoutingPreference settings in create/update Storage account + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' +* Upgraded Azure.Storage.Blobs to 12.8.0 +* Upgraded Azure.Storage.Files.Shares to 12.6.0 +* Upgraded Azure.Storage.Files.DataLake to 12.6.0 + +#### Az.Websites +* Added support for Importing a key vault certificate to WebApp. + +### Thanks to our community contributors +* @atul-ram, Update Set-AzEventHub.md (#13921) +* Christoph Bergmeister [MVP] (@bergmeister), Set-AzDataLakeGen2AclRecursive.md - Fix typo (directiry -> directory) (#14082) +* Alexander Schmidt (@devdeer-alex), Fixed broken link to contribution guidelines (#14009) +* @JiangYuchun, Update Get-AzApplicationGatewayAuthenticationCertificate.md (#13972) +* Sebastian Olsen (@Spacebjorn), Corrected example command (#13901) + + +## 5.4.0 - January 2021 +#### Az.Accounts +* Shown correct client request id on debug message [#13745] +* Added common Azure PowerShell exception type +* Supported storage API 2019-06-01 + +#### Az.Automation +* Fixed issue where description was not populated for update management schedules + +#### Az.CosmosDB +* General availability of 'Az.CosmosDB' module +* Restricting New-AzCosmosDBAccount cmdlet to make update calls to existing Database Accounts. +* Introducing AnalyticalStorageTTL in SqlContainer. + +#### Az.IotHub +* Fixed a regression regarding SAS token generation + +#### Az.KeyVault +* Fixed an issue in Secret Management module + +#### Az.LogicApp +* Fixed issue that 'Get-AzLogicAppTriggerHistory' and 'Get-AzLogicAppRunAction' only retrieving the first page of results [#9141] + +#### Az.Monitor +* Added cmdlets for data collection rules: + - 'Get-AzDataCollectionRule' + - 'New-AzDataCollectionRule' + - 'Set-AzDataCollectionRule' + - 'Update-AzDataCollectionRule' + - 'Remove-AzDataCollectionRule' +* Added cmdlets for data collection rules associations + - 'Get-AzDataCollectionRuleAssociation' + - 'New-AzDataCollectionRuleAssociation' + - 'Remove-AzDataCollectionRuleAssociation' + +#### Az.Network +* Added new cmdlets for CRUD of VpnGatewayNATRule. + - 'New-AzAzVpnGatewayNatRule' + - 'Update-AzAzVpnGatewayNatRule' + - 'Get-AzAzVpnGatewayNatRule' + - 'Remove-AzAzVpnGatewayNatRule' +* Updated cmdlets to set NATRule on VpnGateway resource and associate it with VpnSiteLinkConnection resource. + - 'New-AzVpnGateway' + - 'Update-AzVpnGateway' + - 'New-AzVpnSiteLinkConnection' +* Updated cmdlets to enable setting of ConnectionMode on Virtual Network Gateway Connections. + - 'New-AzVirtualNetworkGatewayConnection' + - 'Set-AzVirtualNetworkGatewayConnection' +* Updated 'New-AzFirewallPolicyApplicationRule' cmdlet: + - Added parameter TargetUrl + - Added parameter TerminateTLS +* Added new cmdlets for Azure Firewall Premium Features + - 'New-AzFirewallPolicyIntrusionDetection' + - 'New-AzFirewallPolicyIntrusionDetectionBypassTraffic' + - 'New-AzFirewallPolicyIntrusionDetectionSignatureOverride' +* Updated New-AzFirewallPolicy cmdlet: + - Added parameter -SkuTier + - Added parameter -Identity + - Added parameter -UserAssignedIdentityId + - Added parameter -IntrusionDetection + - Added parameter -TransportSecurityName + - Added parameter -TransportSecurityKeyVaultSecretId +* Added new cmdlet to fetch IKE Security Associations for Virtual Network Gateway Connections. + - 'Get-AzVirtualNetworkGatewayConnectionIkeSa' +* Added multiple Authentication support for p2sVpnGateway + - Updated New-AzVpnServerConfiguration and Update-AzVpnServerConfiguration to allow multiple authentication parameters to be set. +* Updated 'New-AzVpnGateway' and 'New-AzP2sVpnGateway' cmdlet: + - Added parameter EnableRoutingPreferenceInternetFlag + +#### Az.RecoveryServices +* Added Cross Region Restore feature. +* Blocked getting workload config when target item is an availability group. + +#### Az.Resources +* Added support for -QueryString parameter in New-Az*Deployments cmdlets + +#### Az.Sql +* Made 'Start-AzSqlInstanceDatabaseLogReplay' cmdlet synchronous, added -AsJob flag + +#### Az.Storage +* Fix ContinuationToken never null when list blob with -IncludeVersion + - 'Get-AzStorageBlob' + +#### Az.Websites +* Added support for App Service Managed certificates + - 'New-AzWebAppCertificate' + - 'Remove-AzWebAppCertificate' +* Fixed issue that causes Docker Password to be removed from appsettings in 'Set-AzWebApp' and 'Set-AzWebAppSlot' + +### Thanks to our community contributors +* Ivan Akcheurov (@ivanakcheurov), Update Set-AzSecurityWorkspaceSetting.md (#13877) +* @javiermarasco, Update example (#13837) +* @jhaprakash26, Update Set-AzVirtualNetwork.md (#13857) +* Michael Holmes (@MichaelHolmesWP), Update New-AzStorageTableStoredAccessPolicy.md (#13871) +* Michael James (@mikejwhat), Allow Get-AzLogicAppTriggerHistory and Get-AzLogicAppRunAction to return more than 30 results (#13846) +* @Willem-J-an, Fix bug causing Docker Password to be removed from appsettings in Set-AzWebApp(Slot) (#13866) + + +## 5.3.0 - December 2020 +#### Az.Accounts +* Fixed the issue that Http proxy is not respected in Windows PowerShell [#13647] +* Improved debug log of long running operations in generated modules + +#### Az.Automation +* Fixed issue that parameters of 'Start-AzAutomationRunbook' cannot convert PSObject wrapped string to JSON string [#13240] +* Fixed location completer for New-AzAutomationUpdateManagementAzureQuery cmdlet + +#### Az.Compute +* New parameter 'VM' in new parameter set 'VMParameterSet' added to 'Get-AzVMDscExtensionStatus' and 'Get-AzVMDscExtension' cmdlets. +* Edited 'New-AzSnapshot' cmdlet to check for existing snapshot with the same name in the same resource group. + - Throws an error if a duplicate snapshot exists. + +#### Az.Databricks +* Fixed an issue that may cause 'New-AzDatabricksVNetPeering' to return before it is fully provisioned (https://github.com/Azure/autorest.powershell/issues/610) + +#### Az.DataFactory +* Fixed the command 'Invoke-AzDataFactoryV2Pipeline' for SupportsShouldProcess issue + +#### Az.DesktopVirtualization +* Added StartVMOnConnect property to hostpool. + +#### Az.HDInsight +* Added properties: Fqdn and EffectiveDiskEncryptionKeyUrl in the class AzureHDInsightHostInfo. + +#### Az.KeyVault +* Added a new parameter '-AsPlainText' to 'Get-AzKeyVaultSecret' to directly return the secret in plain text [#13630] +* Supported selective restore a key from a managed HSM full backup [#13526] +* Fixed some minor issues [#13583] [#13584] +* Added missing return objects of 'Get-Secret' in SecretManagement module +* Fixed an issue that may cause vault to be created without default access policy [#13687] + +#### Az.Kusto +* Updated API version to 2020-09-18. + +#### Az.Network +* Fixed issue in remove peering and connection cmdlet for ExpressRouteCircuit scenario + - 'Remove-AzExpressRouteCircuitPeeringConfig' and 'Remove-AzExpressRouteCircuitConnectionConfig' + +#### Az.PolicyInsights +* Added support for returning paginated results for Get-AzPolicyState + +#### Az.RecoveryServices +* Enabled softdelete feature for SQL. +* Fixed SQL AG restore and removed the container name check. +* Changed container name format for Azure Files backup item. +* Added CMK feature support for Recovery services vault. + +#### Az.Resources +* Fixed a NullRef exception issue in 'New-AzureManagedApplication' and 'Set-AzureManagedApplication'. +* Updated Azure Resource Manager SDK to use latest DeploymentScripts GA api-version: 2020-10-01. + +#### Az.ServiceFabric +* Fixed 'Add-AzServiceFabricNodeType'. Added node type to service fabric cluster before creating virtual machine scale set. + +#### Az.Sql +* Fixed parameter description for 'InstanceFailoverGroup' command. +* Updated the logic in which schemaName, tableName and columnName are being extracted from the id of SQL Data Classification commands. +* Fixed Status and StatusMessage fields in 'Get-AzSqlDatabaseImportExportStatus' to conform to documentation +* Added Microsoft support operations (DevOps) auditing cmdlets: Get-AzSqlServerMSSupportAudit, Set-AzSqlServerMSSupportAudit, Remove-AzSqlServerMSSupportAudit + +#### Az.Storage +* Supported create/update/get/list EncryptionScope of a Storage account + - 'New-AzStorageEncryptionScope' + - 'Update-AzStorageEncryptionScope' + - 'Get-AzStorageEncryptionScope' +* Supported create container and upload blob with Encryption Scope setting + - 'New-AzRmStorageContainer' + - 'New-AzStorageContainer' + - 'Set-AzStorageBlobContent' + +### Thanks to our community contributors +* Andreas Wolter (@AndreasWolter), removed marketing language, better example filter (#13671) +* Tidjani Belmansour (@BelRarr), Update Get-AzBillingInvoice.md (#13634) +* David Klempfner (@DavidKlempfner) + * Fixed spelling mistake (#13677) + * Update PSMetricNoDetails.cs (#13676) +* @kilobyte97, bugfix for remove cmdlet to delete config (#13655) +* @kongou-ae, Update Set-AzFirewall.md (#13727) +* @MasterKuat, Fix swap between title and code in documentation (#13666) +* NickT (@nukeulis), Update Set-AzContext.md (#13702) +* @PaulHCode, Update Start-AzJitNetworkAccessPolicy.md - Fix the Example to display the proper cmdlet being demonstrated (#13713) +* Ryan Borstelmann (@ryanborMSFT), Removed Subscription ID (#13715) +* Shashikant Shakya (@shshakya), Update Set-AzSqlDatabase.md (#13674) +* Sebastian Olsen (@Spacebjorn), Update Get-AzRecoveryServicesBackupItem.md (#13719) + +## 5.2.0 - December 2020 +#### Az.Accounts +* Managed to parse ExpiresOn time from raw token if could not get from underlying library +* Improved warning message if Interactive authentication is unavailable + +#### Az.ApiManagement +* [Breaking change] 'New-AzApiManagementProduct' by default has no subscription limit. + +#### Az.Compute +* Edited Get-AzVm to filter by '-Name' prior to checking for throttling due to too many resources. +* New cmdlet 'Start-AzVmssRollingExtensionUpgrade'. + +#### Az.ContainerRegistry +* Supported parameter 'Name' for and value from pipeline input for 'Get-AzContainerRegistryUsage' [#13605] +* Polished exceptions for 'Connect-AzContainerRegistry' + +#### Az.DataFactory +* Updated ADF .Net SDK version to 4.13.0 + +#### Az.HealthcareApis +* Added support for customer managed keys + +#### Az.IotHub +* Fixed an issue of SAS token. + +#### Az.KeyVault +* Supported 'all' as an option when setting key vault access policies +* Supported new version of SecretManagement module [#13366] +* Supported ByteArray, String, PSCredential and Hashtable for 'SecretValue' in SecretManagementModule [#12190] +* [Breaking change] redesigned the API surface of cmdlets related to managed HSM. + +#### Az.Monitor +* Changed parameter 'Rule' of 'New-AzAutoscaleProfile' to accept empty list. [#12903] +* Added new cmdlets to support creating diagnostic settings more flexible: + * 'Get-AzDiagnosticSettingCategory' + * 'New-AzDiagnosticSetting' + * 'New-AzDiagnosticDetailSetting' + +#### Az.RecoveryServices +* Made help text and parameter set name changes to 'Restore-AzRecoveryServicesBackupItem' cmdlet. + +#### Az.Resources +* Added '-Tag' parameter support to 'Set-AzTemplateSpec' and 'New-AzTemplateSpec' +* Added Tag display support to default formatter for Template Specs + +#### Az.ServiceFabric +* Added example to 'Set-AzServiceFabricSetting' with SettingsSectionDescription param +* Updated application related cmdlets to call out that support is only for ARM deployed resources +* Marked for deprecation cluster cert cmdlets 'Add-AzureRmServiceFabricClusterCertificate' and 'Remove-AzureRmServiceFabricClusterCertificate' + +#### Az.Sql +* Added SecondaryType to the following: + - 'New-AzSqlDatabase' + - 'Set-AzSqlDatabase' + - 'New-AzSqlDatabaseSecondary' +* Added HighAvailabilityReplicaCount to the following: + - 'New-AzSqlDatabase' + - 'Set-AzSqlDatabase' +* Made ReadReplicaCount an alias of HighAvailabilityReplicaCount in the following: + - 'New-AzSqlDatabase' + - 'Set-AzSqlDatabase' + +#### Az.Storage +* Supported upload Azure File size up to 4 TiB + - 'Set-AzStorageFileContent' +* Upgraded Azure.Storage.Blobs to 12.7.0 +* Upgraded Azure.Storage.Files.Shares to 12.5.0 +* Upgraded Azure.Storage.Files.DataLake to 12.5.0 + +#### Az.StorageSync +* Added Sync tiering policy feature with download policy and local cache mode + +#### Az.Websites +* Prevent duplicate access restriction rules + +### Thanks to our community contributors +* Andrew Dawson (@dawsonar802), Update Get-AzKeyVaultCertificate.md - Get cert and save it as pfx section to work with PowerShell Core (#13557) +* @iviark, Healthcare APIs Powershell BYOK Updates (#13518) +* John Duckmanton (@johnduckmanton), Correct spelling of TagPatchOperation (#13508) +* Michael James (@mikejwhat) + * Get-AzLogicAppRunHistory Help Tidy (#13513) +* Richard de Zwart (@mountain65) + * Update Update-AzAppConfigurationStore.md (#13485) + * Update New-AzCosmosDBAccount.md (#13490) +* @SteppingRazor, New-AzApiManagementProduct: Change SubscriptionsLimit parameter default value to None (#13457) +* Steve Burkett (@SteveBurkettNZ), Fix Typo for WorkspaceResourceId parameter in example (#13589) + +## 5.1.0 - November 2020 +#### Az.Accounts +* Fixed an issue that TenantId may be not respected if using 'Connect-AzAccount -DeviceCode'[#13477] +* Added new cmdlet 'Get-AzAccessToken' +* Fixed an issue that error happens if user profile path is inaccessible +* Fixed an issue causing Write-Object error during Connect-AzAccount [#13419] +* Added parameter 'ContainerRegistryEndpointSuffix' to: 'Add-AzEnvironment', 'Set-AzEnvironment' +* Supported interrupting login by hitting <kbd>CTRL</kbd>+<kbd>C</kbd> +* Fixed an issue causing 'Connect-AzAccount -KeyVaultAccessToken' not working [#13127] +* Fixed null reference and method case insensitive in 'Invoke-AzRestMethod' + +#### Az.Aks +* Fixed the issue that user cannot use service principal to create a new Kubernetes cluster. [#13012] + +#### Az.AppConfiguration +* General availability of 'Az.AppConfiguration' module + +#### Az.DataFactory +* Improved error message of 'New-AzDataFactoryV2LinkedServiceEncryptedCredential' command + +#### Az.DataLakeStore +* Updated ADLS dataplane SDK to 1.2.4-alpha. Changes:https://github.com/Azure/azure-data-lake-store-net/blob/preview-alpha/CHANGELOG.md#version-124-alpha + +#### Az.DesktopVirtualization +* Added new MSIX Package cmdlets and updated Applications cmdlets. + +#### Az.EventHub +* Fixed Cluster commands for EventHub cluster without tags +* Updated help text for PartnerNamespace of AzEventHubGeoDRConfiguration commands + +#### Az.HDInsight +* Add parameters 'ResourceProviderConnection' and 'PrivateLink' to cmdlet 'New-AzHDInsightCluster' to support relay outbound and private link feature +* Add parameter 'AmbariDatabase' to cmdlet 'New-AzHDInsightCluster' to support custom Ambari database feature +* Add accept value 'AmbariDatabase' to the parameter 'MetastoreType' of the cmdlet 'Add-AzHDInsightMetastore' + +#### Az.IotHub +* Allowed tags in IoT Hub create cmdlet. + +#### Az.KeyVault +* Supported updating key vault tag + +#### Az.LogicApp +* Fixed for Get-AzLogicAppRunHistory only retrieving the first page of results + +#### Az.Network +* Updated below cmdlet + - 'New-AzLoadBalancerFrontendIpConfigCommand', 'Set-AzLoadBalancerFrontendIpConfigCommand', 'Add-AzLoadBalancerFrontendIpConfigCommand': + - Added PublicIpAddressPrefix property + - Added PublicIpAddressPrefixId property +* Added new properties to the following cmdlets to allow for global load balancing + - 'New-AzLoadBalancer': + - Added Sku Tier property + - 'New-AzPuplicIpAddress': + - Added Sku Tier property + - 'New-AzPublicIpPrefix': + - Added Sku Tier property + - 'New-AzLoadBalancerBackendAddressConfig': + - Added LoadBalancerFrontendIPConfigurationId property +* Updated planning to deprecate warnings for the following cmdlets + -'New-AzVirtualHubRoute' + -'New-AzVirtualHubRouteTable' + -'Add-AzVirtualHubRoute' + -'Add-AzVirtualHubRouteTable' + -'Get-AzVirtualHubRouteTable' + -'Remove-AzVirtualHubRouteTable' +* Added planning to deprecate warnings on the argument 'RouteTable' for the following cmdlets + -'New-AzVirtualHub' + -'Set-AzVirtualHub' + -'Update-AzVirtualHub' +* Made arguments '-MinScaleUnits' and '-MaxScaleUnits' optional in 'Set-AzExpressRouteGateway' +* Added new cmdlets to support Mutual Authentication and SSL Profiles on Application Gateway + - 'Get-AzApplicationGatewayClientAuthConfiguration' + - 'New-AzApplicationGatewayClientAuthConfiguration' + - 'Remove-AzApplicationGatewayClientAuthConfiguration' + - 'Set-AzApplicationGatewayClientAuthConfiguration' + - 'Add-AzApplicationGatewayTrustedClientCertificate' + - 'Get-AzApplicationGatewayTrustedClientCertificate' + - 'New-AzApplicationGatewayTrustedClientCertificate' + - 'Remove-AzApplicationGatewayTrustedClientCertificate' + - 'Set-AzApplicationGatewayTrustedClientCertificate' + - 'Add-AzApplicationGatewaySslProfile' + - 'Get-AzApplicationGatewaySslProfile' + - 'New-AzApplicationGatewaySslProfile' + - 'Remove-AzApplicationGatewaySslProfile' + - 'Set-AzApplicationGatewaySslProfile' + - 'Get-AzApplicationGatewaySslProfilePolicy' + - 'Remove-AzApplicationGatewaySslProfilePolicy' + - 'Set-AzApplicationGatewaySslProfilePolicy' + +#### Az.RecoveryServices +* Specifying policy BackupTime is in UTC. +* Modifying breaking change warning in Get-AzRecoveryServicesBackupJobDetails cmdlet. +* Updating sample script help text for Set-AzRecoveryServicesBackupProtectionPolicy cmdlet. + +#### Az.Resources +* Fixed an issue where What-If shows two resource group scopes with different casing +* Updated 'Export-AzResourceGroup' to use the SDK. +* Added culture info to parse methods + +#### Az.Sql +* Fixed issues where Set-AzSqlDatabaseAudit were not support Hyperscale database and database edition cannot be determined +* Added MaintenanceConfigurationId to 'New-AzSqlInstance' and 'Set-AzSqlInstance' +* Fixed a bug in GetAzureSqlDatabaseReplicationLink.cs where PartnerServerName parameter was being checked for by value instead of key + +#### Az.Websites +* Added support for new access restriction features: ServiceTag, multi-ip and http-headers + +### Thanks to our community contributors +* John Q. Martin (@johnmart82), Adding firewall prerequisite information (#13385) +* Manikandan Duraisamy (@madurais-msft), Corrected the PublicSubnetName argument (#13417) +* @mahortas, Update for -HostNames parameter values (#13349) +* @MariachiForHire, added supported TrafficAnalyticsInterval values (#13304) +* Michael James (@mikejwhat), Allow Get-AzLogicAppRunHistory to return more than 30 entries (#13393) +* Shashikant Shakya (@shshakya), Update Restore-AzSqlInstanceDatabase.md (#13404) + +## 5.0.0 - October 2020 +#### Az.Accounts +* [Breaking Change] Removed 'Get-AzProfile' and 'Select-AzProfile' +* Replaced Azure Directory Authentication Library with Microsoft Authentication Library(MSAL) + +#### Az.Aks +* [Breaking Change] Removed parameter alias 'ClientIdAndSecret' in 'New-AzAksCluster' and 'Set-AzAksCluster'. +* [Breaking Change] Changed the default value of 'NodeVmSetType' in 'New-AzAksCluster' from 'AvailabilitySet' to 'VirtualMachineScaleSets'. +* [Breaking Change] Changed the default value of 'NetworkPlugin' in 'New-AzAksCluster' from 'None' to 'azure'. +* [Breaking Change] Removed parameter 'NodeOsType' in 'New-AzAksCluster' as it supports only one value Linux. + +#### Az.Billing +* Added 'Get-AzBillingAccount' cmdlet +* Added 'Get-AzBillingProfile' cmdlet +* Added 'Get-AzInvoiceSection' cmdlet +* Added new parameters in 'Get-AzBillingInvoice' cmdlet +* Removed properties DownloadUrlExpiry, Type, BillingPeriodNames from the response of Get-AzBillingInvoice cmdlet + +#### Az.Cdn +* Added cmdlets to support multi-origin and private link functionality + +#### Az.CognitiveServices +* Updated SDK to 7.4.0-preview. + +#### Az.Compute +* Added '-VmssId' parameter to 'New-AzVm' +* Added 'PlatformFaultDomainCount' parameter to the 'New-AzVmss' cmdlet. +* New cmdlet 'Get-AzDiskEncryptionSetAssociatedResource' +* Added 'Tier' and 'LogicalSectorSize' optional parameters to the New-AzDiskConfig cmdlet. +* Added 'Tier', 'MaxSharesCount', 'DiskIOPSReadOnly', and 'DiskMBpsReadOnly' optional parameters to the 'New-AzDiskUpdateConfig' cmdlet. + +#### Az.ContainerRegistry +* [Breaking Change] Updates API version to 2019-05-01 +* [Breaking Change] Removed SKU 'Classic' and parameter 'StorageAccountName' from 'New-AzContainerRegistry' +* Added New cmdlets: 'Connect-AzContainerRegistry', 'Import-AzContainerRegistry', 'Get-AzContainerRegistryUsage', 'New-AzContainerRegistryNetworkRule', 'Set-AzContainerRegistryNetworkRule' +* Added new parameter 'NetworkRuleSet' to 'Update-AzContainerRegistry' + +#### Az.Databricks +* Fixed a bug that may cause updating databricks workspace without `-EncryptionKeyVersion` to fail. + +#### Az.DataFactory +* Updated ADF .Net SDK version to 4.12.0 +* Updated ADF encryption client SDK version to 4.14.7587.7 +* Added 'Stop-AzDataFactoryV2TriggerRun' and 'Invoke-AzDataFactoryV2TriggerRun' commands + +#### Az.DesktopVirtualization +* Require Location property for creating top level arm objects. + * Made `ApplicationGroupType` required for `New-AzWvdApplicationGroup`. + * Made `HostPoolArmPath` required for `New-AzWvdApplicationGroup`. + * Added `PreferredAppGroupType` for `New-AzWvdHostPool`. + +#### Az.Functions +* [Breaking Change] Removed 'IncludeSlot' switch parameter from all but one parameter set of 'Get-AzFunctionApp'. The cmdlet now supports retrieving deployment slots in the results when '-IncludeSlot' is specified. +* Updated 'New-AzFunctionApp': + - Fixed -DisableApplicationInsights so that no application insights project is created when this option is specified. [#12728] + - [Breaking Change] Removed support to create PowerShell 6.2 function apps. + - [Breaking Change] Changed the default runtime version in Functions version 3 on Windows for PowerShell function apps from 6.2 to 7.0 when the RuntimeVersion parameter is not specified. + - [Breaking Change] Changed the default runtime version in Functions version 3 on Windows and Linux for Node function apps from 10 to 12 when the RuntimeVersion parameter is not specified. + - [Breaking Change] Changed the default runtime version in Functions version 3 on Linux for Python function apps from 3.7 to 3.8 when the RuntimeVersion parameter is not specified. + +#### Az.HDInsight + * For New-AzHDInsightCluster cmdlet: + - Replaced parameter 'DefaultStorageAccountName' with 'StorageAccountResourceId' + - Replaced parameter 'DefaultStorageAccountKey' with 'StorageAccountKey' + - Replaced parameter 'DefaultStorageAccountType' with 'StorageAccountType' + - Removed parameter 'PublicNetworkAccessType' + - Removed parameter 'OutboundPublicNetworkAccessType' + - Added new parameters: 'StorageFileSystem' and 'StorageAccountManagedIdentity' to support ADLSGen2 + - Added new parameter 'EnableIDBroker' to Support HDInsight ID Broker + - Added new parameters: 'KafkaClientGroupId', 'KafkaClientGroupName' and 'KafkaManagementNodeSize' to support Kafka Rest Proxy + * For New-AzHDInsightClusterConfig cmdlet: + - Replaced parameter 'DefaultStorageAccountName' with 'StorageAccountResourceId' + - Replaced parameter 'DefaultStorageAccountKey' with 'StorageAccountKey' + - Replaced parameter 'DefaultStorageAccountType' with 'StorageAccountType' + - Removed parameter 'PublicNetworkAccessType' + - Removed parameter 'OutboundPublicNetworkAccessType' +* For Set-AzHDInsightDefaultStorage cmdlet: + - Replaced parameter 'StorageAccountName' with 'StorageAccountResourceId' +* For Add-AzHDInsightSecurityProfile cmdlet: + - Replaced parameter 'Domain' with 'DomainResourceId' + - Removed the mandatory requirement for parameter 'OrganizationalUnitDN' + +#### Az.KeyVault +* [Breaking Change] Deprecated parameter DisableSoftDelete in 'New-AzKeyVault' and EnableSoftDelete in 'Update-AzKeyVault' +* [Breaking Change] Removed attribute SecretValueText to avoid displaying SecretValue directly [#12266] +* Supported new resource type: managed HSM + - CRUD of managed HSM and cmdlets to operate keys on managed HSM + - Full HSM backup/restore, AES key creation, security domain backup/restore, RBAC + +#### Az.ManagedServices +* [Breaking Change] Updated parameters naming conventions and associated examples + +#### Az.Network +* [Breaking Change] Removed parameter 'HostedSubnet' and added 'Subnet' instead +* Added new cmdlets for Virtual Router Peer Routes + - 'Get-AzVirtualRouterPeerLearnedRoute' + - 'Get-AzVirtualRouterPeerAdvertisedRoute' +* Updated New-AzFirewall cmdlet: + - Added parameter '-SkuTier' + - Added parameter '-SkuName' and made Sku as Alias for this + - Removed parameter '-Sku' +* [Breaking Change] Made 'Connectionlink' argument mandatory in 'Start-AzVpnConnectionPacketCapture' and 'Stop-AzVpnConnectionPacketCapture' +* [Breaking Change] Updated 'New-AzNetworkWatcherConnectionMonitorEndPointObject' to remove parameter '-Filter' +* [Breaking Change] Replaced 'New-AzNetworkWatcherConnectionMonitorEndpointFilterItemObject' cmdlet with 'New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject' +* Updated 'New-AzNetworkWatcherConnectionMonitorEndPointObject' cmdlet: + - Added parameter '-Type' + - Added parameter '-CoverageLevel' + - Added parameter '-Scope' +* Updated 'New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject' cmdlet with new parameter '-DestinationPortBehavior' + +#### Az.RecoveryServices +* Fixing Workload Restore for contributor permissions. +* Added new parameter sets and validations for Restore-AzRecoveryServicesBackupItem cmdlet. + +#### Az.Resources +* Fixed parsing bug +* Updated ARM template What-If cmdlets to remove preview message from results +* Fixed an issue where template deployment cmdlets crash if '-WhatIf' is set at a higher scope [#13038] +* Fixed an issue where template deployment cmdlets does not preserve case for template parameters +* Added a default API version to be used in 'Export-AzResourceGroup' cmdlet +* Added cmdlets for Template Specs ('Get-AzTemplateSpec', 'Set-AzTemplateSpec', 'New-AzTemplateSpec', 'Remove-AzTemplateSpec', 'Export-AzTemplateSpec') +* Added support for deploying Template Specs using existing deployment cmdlets (via the new -TemplateSpecId parameter) +* Updated 'Get-AzResourceGroupDeploymentOperation' to use the SDK. +* Removed '-ApiVersion' parameter from '*-AzDeployment' cmdlets. + +#### Az.Sql +* Added DiffBackupIntervalInHours to 'Set-AzSqlDatabaseBackupShortTermRetentionPolicy' +* Fixed issue where New-AzSqlDatabaseExport fails if networkIsolation not specified [#13097] +* Fixed issue where New-AzSqlDatabaseExport and New-AzSqlDatabaseImport were not returning OperationStatusLink in the result object [#13097] +* Update Azure Paired Regions URL in Backup Storage Redundancy Warnings + +#### Az.Storage +* Removed obsolete property RestorePolicy.LastEnabledTime + - 'Enable-AzStorageBlobRestorePolicy' + - 'Disable-AzStorageBlobRestorePolicy' + - 'Get-AzStorageBlobServiceProperty' + - 'Update-AzStorageBlobServiceProperty' +* Change Type of DaysAfterModificationGreaterThan from int to int? + - 'Set-AzStorageAccountManagementPolicy' + - 'Get-AzStorageAccountManagementPolicy' + - 'Add-AzStorageAccountManagementPolicyAction' + - 'New-AzStorageAccountManagementPolicyRule' +* Supported create/update file share with access tier + - 'New-AzRmStorageShare' + - 'Update-AzRmStorageShare' +* Supported set/update/remove Acl recursively on Datalake Gen2 item + - 'Set-AzDataLakeGen2AclRecursive' + - 'Update-AzDataLakeGen2AclRecursive' + - 'Remove-AzDataLakeGen2AclRecursive' +* Supported Container access policy with new permission x,t + - 'New-AzStorageContainerStoredAccessPolicy' + - 'Set-AzStorageContainerStoredAccessPolicy' +* Changed the output of get/set Container access policy cmdlet, by change the child property Permission type from enum to String + - 'Get-AzStorageContainerStoredAccessPolicy' + - 'Set-AzStorageContainerStoredAccessPolicy' +* Fixed a sample script issue of set management policy with json + - 'Set-AzStorageAccountManagementPolicy' + +#### Az.Websites +* Added support for Premium V3 pricing tier +* Updated the WebSites SDK to 3.1.0 + +### Thanks to our community contributors +* @atul-ram, Update Get-AzDelegation.md (#13176) +* @dineshreddy007, Get the App Roles assigned correctly in case of Stack HCI registration using WAC token. (#13249) +* @kongou-ae, Update New-AzOffice365PolicyProperty.md (#13217) +* Lohith Chowdary Chilukuri (@Lochiluk), Update Set-AzApplicationGateway.md (#13150) +* Matthew Burleigh (@mburleigh) + * Add links to PowerShell cmdlets referenced in the document (#13203) + * Add links to PowerShell cmdlets referenced in the document (#13190) + * Add links to PowerShell cmdlets referenced in the document (#13189) + * add links to referenced cmdlets (#13137) + * Add links to PowerShell cmdlets referenced in the document (#13204) + * Add links to PowerShell cmdlets referenced in the document (#13205) + + +## 4.8.0 - October 2020 +#### Az.Accounts +* Fixed DateTime parse issue in common libraries [#13045] + +#### Az.CognitiveServices +* Added 'New-AzCognitiveServicesAccountApiProperty' cmdlet. +* Supported 'ApiProperty' parameter for 'New-AzCognitiveServicesAccount' and 'Set-AzCognitiveServicesAccount' + +#### Az.Compute +* Fixed issue in 'Update-ASRRecoveryPlan' by populating FailoverTypes +* Added the '-Top' and '-OrderBy' optional parameters to the 'Get-AzVmImage' cmdlet. + +#### Az.Databricks +* General availability of 'Az.Databricks' module +* Added support for virtual network peering + +#### Az.DataFactory +* Fixed typo in output messages + +#### Az.EventHub +* Added optional switch parameter 'TrustedServiceAccessEnabled' to 'Set-AzEventHubNetworkRuleSet' cmdlet + +#### Az.HDInsight +* Added warning message for planning to deprecate the parameters 'PublicNetworkAccessType' and 'OutboundPublicNetworkAccessType' +* Added warning message for planning to replace the parameter 'DefaultStorageAccountName' with 'StorageAccountResourceId' +* Added warning message for planning to replace the parameter 'DefaultStorageAccountKey' with 'StorageAccountKey' +* Added warning message for planning to replace the parameter 'DefaultStorageAccountType' with 'StorageAccountType' +* Added warning message for planning to replace the parameter 'DefaultStorageContainer' with 'StorageContainer' +* Added warning message for planning to replace the parameter 'DefaultStorageRootPath' with 'StorageRootPath' + +#### Az.IotHub +* Updated devices sdk. + +#### Az.KeyVault +* Provided the detailed date of removing property SecretValueText + +#### Az.ManagedServices +* Updated breaking change warnings on cmdlets of managed services assignment and definition + +#### Az.Monitor +* Fixed the bug that warning message cannot be suppressed. [#12889] +* Supported 'SkipMetricValidation' parameter in alert rule criteria. Allows creating an alert rule on a custom metric that isn't yet emitted, by causing the metric validation to be skipped. + +#### Az.Network +* Added Office365 Policy to VPNSite Resource + - 'New-AzO365PolicyProperty' + +#### Az.RecoveryServices +* Added container name validation for workload backup. + +#### Az.RedisCache +* Made 'New-AzRedisCache' and 'Set-AzRedisCache' cmdlets not fail because of permission issue related to registering Microsoft.Cache RP + +#### Az.Sql +* Added BackupStorageRedundancy to the following: + - 'Restore-AzureRmSqlDatabase' + - 'New-AzSqlDatabaseCopy' + - 'New-AzSqlDatabaseSecondary' +* Removed case sensitivity for BackupStorageRedundancy parameter for all SQL DB references +* Updated BackupStorageRedundancy warning message names + +#### Az.Storage +* Supported enable/disable/get share soft delete properties on file Service of a Storage account + - 'Update-AzStorageFileServiceProperty' + - 'Get-AzStorageFileServiceProperty' +* Supported list file shares include the deleted ones of a Storage account, and Get single file share usage + - 'Get-AzRmStorageShare' +* Supported restore a deleted file share + - 'Restore-AzRmStorageShare' +* Changed the cmdlets for modify blob service properties, won't get the original properties from server, but only set the modified properties to server. + - 'Enable-AzStorageBlobDeleteRetentionPolicy' + - 'Disable-AzStorageBlobDeleteRetentionPolicy' + - 'Enable-AzStorageBlobRestorePolicy' + - 'Disable-AzStorageBlobRestorePolicy' + - 'Update-AzStorageBlobServiceProperty' +* Fixed help issue for New-AzStorageAccount parameter -Kind default value [#12189] +* Fixed issue by add example to show how to set correct ContentType in blob upload [#12989] + +### Thanks to our community contributors +* @felickz, Clarify escaping special characters in Subject (#13028) +* Martin Zurita (@Gorgoras), Corrected some typos in messages. (#12999) +* @kingsleyAzure + * Add managed hsm uri in regex matching (#12912) + * Add Managed HSM support for SQL (#13073) +* @MasterKuat, Fixed complaint on Managed instance's system database for vulnerability assessment (#12971) + + +## 4.7.0 - September 2020 +#### Az.Accounts +* Formatted the upcoming breaking change messages +* Updated Azure.Core to 1.4.1 + +#### Az.Aks +* Added client side parameter validation logic for 'New-AzAksCluster', 'Set-AzAksCluster' and 'New-AzAksNodePool'. [#12372] +* Added support for add-ons in 'New-AzAksCluster'. [#11239] +* Added cmdlets 'Enable-AzAksAddOn' and 'Disable-AzAksAddOn' for add-ons. [#11239] +* Added parameter 'GenerateSshKey' for 'New-AzAksCluster'. [#12371] +* Updated api version to 2020-06-01. + +#### Az.CognitiveServices +* Showed additional legal terms for certain APIs. + +#### Az.Compute +* Added the '-EncryptionType' optional parameter to 'New-AzVmDiskEncryptionSetConfig' +* New cmdlets for new resource type: DiskAccess 'Get-AzDiskAccess', 'New-AzDiskAccess', 'Get-AzDiskAccess' +* Added optional parameters '-DiskAccessId' and '-NetworkAccessPolicy' to 'New-AzSnapshotConfig' +* Added optional parameters '-DiskAccessId' and '-NetworkAccessPolicy' to 'New-AzDiskConfig' +* Added 'PatchStatus' property to VirtualMachine Instance View +* Added 'VMHealth' property to the virtual machine's instance view, which is the returned object when 'Get-AzVm' is invoked with '-Status' +* Added 'AssignedHost' field to 'Get-AzVM' and 'Get-AzVmss' instance views. The field shows the resource id of the virtual machine instance +* Added optional parameter '-SupportAutomaticPlacement' to 'New-AzHostGroup' +* Added the '-HostGroupId' parameter to 'New-AzVm' and 'New-AzVmss' + +#### Az.DataFactory +* Updated ADF .Net SDK version to 4.11.0 + +#### Az.EventHub +* Added new Cluster cmdlets - 'New-AzEventHubCluster', 'Set-AzEventHubCluster', 'Get-AzEventHubCluster', 'Remove-AzEventHubCluster', 'Get-AzEventHubClustersAvailableRegions'. +* Fixed for issue #10722 : Fix for assigning only 'Listen' to AuthorizationRule rights. + +#### Az.Functions +* Removed the ability to create v2 Functions in regions that do not support it. +* Deprecated PowerShell 6.2. Added a warning for when a user creates a PowerShell 6.2 function app that advises them to create a PowerShell 7.0 function app instead. + +#### Az.HDInsight +* Supported creating cluster with Autoscale configuration + - Add new parameter 'AutoscaleConfiguration' to the cmdlet 'New-AzHDInsightCluster' +* Supported operating cluster's Autoscale configuration + - Add new cmdlet 'Get-AzHDInsihgtClusterAutoscaleConfiguration' + - Add new cmdlet 'New-AzHDInsihgtClusterAutoscaleConfiguration' + - Add new cmdlet 'Set-AzHDInsihgtClusterAutoscaleConfiguration' + - Add new cmdlet 'Remove-AzHDInsihgtClusterAutoscaleConfiguration' + - Add new cmdlet 'New-AzHDInsihgtClusterAutoscaleScheduleCondition' + +#### Az.KeyVault +* Added support for RBAC authorization [#10557] +* Enhanced error handling in 'Set-AzKeyVaultAccessPolicy' [#4007] + +#### Az.Kusto +* General availability of 'Az.Kusto' module + +#### Az.Network +* [Breaking Change] Updated below cmdlets to align resource virtual router and virtual hub + - 'New-AzVirtualRouter': + - Added -HostedSubnet parameter to support IP configuration child resource + - deleted -HostedGateway and -HostedGatewayId + - 'Get-AzVirtualRouter': + - Added subscription level parameter set + - 'Remove-AzVirtualRouter' + - 'Add-AzVirtualRouterPeer' + - 'Get-AzVirtualRouterPeer' + - 'Remove-AzVirtualRouterPeer' +* Added new cmdlet for Azure Express Route Port + - 'New-AzExpressRoutePortLOA' +* Added RemoteBgpCommunities property to the VirtualNetwork Peering Resource +* Modified the warning message for 'New-AzLoadBalancerFrontendIpConfig', 'New-AzPublicIpAddress' and 'New-AzPublicIpPrefix'. +* Added VpnGatewayIpConfigurations to 'Get-AzVpnGateway' output +* Fixed bug for 'Set-AzApplicationGatewaySslCertificate' [#9488] +* Added 'AllowActiveFTP' parameter to 'AzureFirewall' +* Updated below commands for feature: Enable internet security set/remove on VirtualWan P2SVpnGateway. +- Updated 'New-AzP2sVpnGateway': Added optional switch parameter 'EnableInternetSecurityFlag' for customers to set true to enable internet security on P2SVpnGateway, which will be applied for Point to site clients. +- Updated 'Update-AzP2sVpnGateway': Added optional switch parameters 'EnableInternetSecurityFlag' or 'DisableInternetSecurityFlag' for customers to set true/false to enable/disable internet security on P2SVpnGateway, which will be applied for Point to site clients. +* Added new cmdlet 'Reset-AzP2sVpnGateway' for customers to reset/reboot their VirtualWan P2SVpnGateway for troubleshooting. +* Added new cmdlet 'Reset-AzVpnGateway' for customers to reset/reboot their VirtualWan VpnGateway for troubleshooting. +* Updated 'Set-AzVirtualNetworkSubnetConfig' + - Set NSG and Route Table properties of subnet to null if explicitly set in parameters [#1548][#9718] + +#### Az.RecoveryServices +* Fixed the Delete State for workload Backup Items. + +#### Az.Resources +* Added missing check for Set-AzRoleAssignment +* Added breaking change attribute to 'SubscriptionId' parameter of 'Get-AzResourceGroupDeploymentOperation' +* Updated ARM template What-If cmdlets to show 'Ignore' resource changes last +* Fixed secure and array parameter serialization issues for deployment cmdlets [#12773] + +#### Az.ServiceFabric +* Added new cmdlets for managed clusters and node types: + - 'New-AzServiceFabricManagedCluster' + - 'Get-AzServiceFabricManagedCluster' + - 'Set-AzServiceFabricManagedCluster' + - 'Remove-AzServiceFabricManagedCluster' + - 'Add-AzServiceFabricManagedClusterClientCertificate' + - 'Remove-AzServiceFabricManagedClusterClientCertificate' + - 'New-AzServiceFabricManagedNodeType' + - 'Get-AzServiceFabricManagedNodeType' + - 'Set-AzServiceFabricManagedNodeType' + - 'Remove-AzServiceFabricManagedNodeType' + - 'Add-AzServiceFabricManagedNodeTypeVMExtension' + - 'Add-AzServiceFabricManagedNodeTypeVMSecret' + - 'Remove-AzServiceFabricManagedNodeTypeVMExtension' + - 'Restart-AzServiceFabricManagedNodeTyp' +* Upgraded Service Fabric SDK to version 1.2.0 which uses service fabric resource provider api-version 2020-03-01 for the current model and 2020-01-01-preview for managed clusters. + +#### Az.Sql +* Added BackupStorageRedundancy to 'New-AzSqlInstance' and 'Get-AzSqlInstance' +* Added cmdlet 'Get-AzSqlServerActiveDirectoryOnlyAuthentication' +* Added cmdlet 'Enable-AzSqlServerActiveDirectoryOnlyAuthentication' +* Added Force parameter to 'New-AzSqlInstance' +* Added cmdlets for Managed Database Log Replay service + - 'Start-AzSqlInstanceDatabaseLogReplay' + - 'Get-AzSqlInstanceDatabaseLogReplay' + - 'Complete-AzSqlInstanceDatabaseLogReplay' + - 'Stop-AzSqlInstanceDatabaseLogReplay' +* Added cmdlet 'Get-AzSqlInstanceActiveDirectoryOnlyAuthentication' +* Added cmdlet 'Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication' +* Added cmdlet 'Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication' +* Updated cmdlets 'New-AzSqlDatabaseImport' and 'New-AzSqlDatabaseExport' to support network isolation functionality +* Added cmdlet 'New-AzSqlDatabaseImportExisting' +* Updated Databases cmdlets to support backup storage type specification +* Added Force parameter to 'New-AzSqlDatabase' +* Added warning for BackupStorageRedundancy configuration in select regions in 'New-AzSqlDatabase' +* Updated ActiveDirectoryOnlyAuthentication cmdlets for server and instance to include ResourceId and InputObject + +#### Az.Storage +* Fixed upload blob fail by upgrade to Microsoft.Azure.Storage.DataMovement 2.0.0 [#12220] +* Supported Point In Time Restore + - 'Enable-AzStorageBlobRestorePolicy' + - 'Disable-AzStorageBlobRestorePolicy' + - 'New-AzStorageBlobRangeToRestore' + - 'Restore-AzStorageBlobRange' +* Supported get blob restore status of Storage account by run get-AzureRMStorageAccount with parameter -IncludeBlobRestoreStatus + - 'Get-AzureRMStorageAccount' +* Added breaking change warning message for upcoming cmdlet output change + - 'Get-AzStorageContainerStoredAccessPolicy' + - 'Set-AzStorageContainerStoredAccessPolicy' + - 'Set-AzStorageAccountManagementPolicy' + - 'Get-AzStorageAccountManagementPolicy' + - 'Add-AzStorageAccountManagementPolicyAction' + - 'New-AzStorageAccountManagementPolicyRule' +* Upgraded Microsoft.Azure.Cosmos.Table SDK to 1.0.8 + +### Thanks to our community contributors +* Thomas Van Laere (@ThomVanL), Add Dockerfile-alpine-3.10 (#12911) +* Lohith Chowdary Chilukuri (@Lochiluk), Update Remove-AzNetworkInterfaceIpConfig.md (#12807) +* Roberth Strand (@roberthstrand), Get-AzResourceGroup - New example, and cleanup (#12828) +* Ravi Mishra (@inmishrar), update Azure Web App runtime stack to DOTNETCORE (#12833) +* @jack-education, Updated Set-AzVirtualNetworkSubnetConfig to allow NSG and Route Table to be removed from subnet (#12351) +* @hagop-globanet, Update Add-AzApplicationGatewayCustomError.md (#12784) +* Joshua Van Daalen (@greenSacrifice) + * Update spelling of Property to Property (#12821) + * Update New-AzResourceLock.md examples (#12806) +* Eragon Riddle (@eragonriddle), Corrected parameter field name in the example (#12825) +* @rossifumax, Fix typo in New-AzConfigurationAssignment.md (#12701) + + +## 4.6.1 - August 2020 +#### Az.Compute +* Patched '-EncryptionAtHost' parameter in 'New-AzVm' to remove default value of false [#12776] + +## 4.6.0 - August 2020 +#### Az.Accounts +* Loaded all public cloud environments when discovery endpoint doesn't return default AzureCloud or other public environments [#12633] +* Exposed SubscriptionPolicies in 'Get-AzSubscription' [#12551] + +#### Az.Automation +* Added '-RunOn' parameters to 'Set-AzAutomationWebhook' to specify a Hybrid Worker Group + +#### Az.Compute +* Added '-EncryptionAtHost' parameter to 'New-AzVm', 'New-AzVmss', 'New-AzVMConfig', 'New-AzVmssConfig', 'Update-AzVM', and 'Update-AzVmss' +* Added 'SecurityProfile' to 'Get-AzVM' and 'Get-AzVmss' return object +* Added '-InstanceView' switch as optional parameter to 'Get-AzHostGroup' +* Added new cmdlet 'Invoke-AzVmPatchAssessment' + +#### Az.DataFactory +* Added missing properties to PSPipelineRun class. + +#### Az.HDInsight +* Supported creating cluster with encryption at host feature. + +#### Az.KeyVault +* Added warning messages for planning to disable soft delete +* Added warning messages for planning to remove attribute SecretValueText + +#### Az.Maintenance +* Added optional schedule related fields to 'New-AzMaintenanceConfiguration' +* Added new cmdlet for 'Get-AzMaintenancePublicConfiguration' + +#### Az.ManagedServices +* Added breaking change warnings on cmdlets of managed services assignment and definition + +#### Az.Monitor +* Extended the parameter set in 'Set-AzDiagnosticSetting' for separation of Logs and Metrics enablement [#12482] +* Fixed bug for 'Add-AzMetricAlertRuleV2' when getting metric alert from pipeline + +#### Az.Resources +* Updated 'Get-AzPolicyAlias' response to include information indicating whether the alias is modifiable by Azure Policy. +* Created new cmdlet 'Set-AzRoleAssignment' +* Added 'Get-AzDeploymentManagementGroupWhatIfResult' for getting ARM template What-If results at management Group scope +* Added 'Get-AzTenantWhatIfResult' new cmdlet for getting ARM template What-If results at tenant scope +* Overrode '-WhatIf' and '-Confirm' for 'New-AzManagementGroupDeployment' and 'New-AzTenantDeployment' to use ARM template What-If results +* Fixed the behaviors of '-WhatIf' and '-Confirm' for new deployment cmdlets so they comply with False and +* Fixed serialization error for '-TemplateObject' and 'TemplateParameterObject' [#1528] [#6292] +* Added breaking change attribute to 'Get-AzResourceGroupDeploymentOperation' for the upcoming output type change + +#### Az.SignalR +* Fixed 'Restart-AzSignalR' and 'Update-AzSignalR' help files errors +* Added cmdlets 'Update-AzSignalRNetworkAcl', 'Set-AzSignalRUpstream' + +#### Az.Storage +* Supported blob query acceleration + - 'Get-AzStorageBlobQueryResult' + - 'New-AzStorageBlobQueryConfig' +* Updated help file, added more description, and fixed typo + - 'Start-AzStorageBlobCopy' + - 'Get-AzDataLakeGen2Item' +* Fixed download blob fail when related sub directory not exist [#12592] + - 'Get-AzStorageBlobContent' +* Supported Set/Get/Remove Object Replication Policy on Storage accounts + - 'New-AzStorageObjectReplicationPolicyRule' + - 'Set-AzStorageObjectReplicationPolicy' + - 'Get-AzStorageObjectReplicationPolicy' + - 'Remove-AzStorageObjectReplicationPolicy' +* Supported enable/disable ChangeFeed on Blob Service of a Storage account + - 'Update-AzStorageBlobServiceProperty' + +## 4.5.0 - August 2020 +#### Az.Accounts +* Updated 'Connect-AzAccount' to accept parameter 'MaxContextPopulation' [#9865] +* Updated SubscriptionClient version to 2019-06-01 and display tenant domains [#9838] +* Supported home tenant and managedBy tenant information of subscription +* Corrected module name, version info in telemetry data +* Adjusted SqlDatabaseDnsSuffix and ServiceManagementUrl if environment metadata endpoint returns incompatible value + +#### Az.Aks +* Removed 'ClientIdAndSecret' to 'ServicePrincipalIdAndSecret' and set 'ClientIdAndSecret' as an alias [#12381]. +* Removed 'Get-AzAks'/'New-AzAks'/'Remove-AzAks'/'Set-AzAks' to 'Get-AzAksCluster'/'New-AzAksCluster'/'Remove-AzAksCluster'/'Set-AzAksCluster' and set the original ones as alias [#12373]. + +#### Az.ApiManagement +* Added new 'Add-AzApiManagementApiToGateway' cmdlet. +* Added new 'Get-AzApiManagementGateway' cmdlet. +* Added new 'Get-AzApiManagementGatewayHostnameConfiguration' cmdlet. +* Added new 'Get-AzApiManagementGatewayKey' cmdlet. +* Added new 'New-AzApiManagementGateway' cmdlet. +* Added new 'New-AzApiManagementGatewayHostnameConfiguration' cmdlet. +* Added new 'New-AzApiManagementResourceLocationObject' cmdlet. +* Added new 'Remove-AzApiManagementApiFromGateway' cmdlet. +* Added new 'Remove-AzApiManagementGateway' cmdlet. +* Added new 'Remove-AzApiManagementGatewayHostnameConfiguration' cmdlet. +* Added new 'Update-AzApiManagementGateway' cmdlet. +* Added new optional [-GatewayId] parameter to the 'Get-AzApiManagementApi' cmdlet. + +#### Az.CognitiveServices +* Used 'Deny' specifically as NetworkRules default action. + +#### Az.FrontDoor +* Fixed an issue where an exception is being thrown when Enum.Parse tries to coerce a null value to an Enabled or Disabled enum values [#12344] + +#### Az.HDInsight +* Supported creating cluster with encryption in transit feature. + - Add new parameter 'EncryptionInTransit' to the cmdlet 'New-AzHDInsightCluster' + - Add new parameter 'EncryptionInTransit' to the cmdlet 'New-AzHDInsightClusterConfig' +* Supported creating cluster with private link feature: + - Add new parameter 'PublicNetworkAccessType' and 'OutboundPublicNetworkAccessType' to the cmdlet 'New-AzHDInsightCluster' + - Add new parameter 'PublicNetworkAccessType' and 'OutboundPublicNetworkAccessType' to the cmdlet 'New-AzHDInsightClusterConfig' +* Returned virtual network information when calling 'New-AzHDInsightCluster' or 'Get-AzHDInsightCluster' + +#### Az.Network +* Added support for AddressPrefixType parameter to 'Remove-AzExpressRouteCircuitConnectionConfig' +* Added non-breaking changes: PeerAddressType functionality for Private Peering in 'Remove-AzExpressRouteCircutPeeringConfig'. +* Code changed to ignore case for AddressPrefixType and PeerAddressType parameter. +* Modified the warning message for 'New-AzLoadBalancerFrontendIpConfig', 'New-AzPublicIpAddress' and 'New-AzPublicIpPrefix'. + +#### Az.OperationalInsights +* Added '-ForceDelete' option for 'Remove-AzOperationalInsightsworkspace' +* Added new cmdlet 'Get-AzOperationalInsightsDeletedWorkspace' +* Added new cmdlet 'Restore-AzOperationalInsightsWorkspace' + +#### Az.RecoveryServices +* Improved the Azure Backup container/item discovery experience. + +#### Az.Resources +* Added properties 'Condition', 'ConditionVersion' and 'Description' to 'New-AzRoleAssignment' + - This included all the relevant changes to the data models + +#### Az.Sql +* Fixed potential server name case insensitive error in 'New-AzSqlServer' and 'Set-AzSqlServer' +* Fixed wrong database name returned on existing database error in 'New-AzSqlDatabaseSecondary' + +#### Az.Storage +* Supported create container/blob Sas token with new permission x,t + - 'New-AzStorageBlobSASToken' + - 'New-AzStorageContainerSASToken' +* Supported create account Sas token with new permission x,t,f + - 'New-AzStorageAccountSASToken' +* Supported get single file share usage + - 'Get-AzRmStorageShare' + +## 4.4.0 - July 2020 +#### Az.Accounts +* Added new cmdlet 'Invoke-AzRestMethod' +* Fixed an issue that may cause authentication errors in multi-process scenarios such as running multiple Azure PowerShell cmdlets using 'Start-Job' [#9448] + +#### Az.Aks +* Fixed bug 'Get-AzAks' doesn't get all clusters [#12296] + +#### Az.AnalysisServices +* Removed project reference to Authentication + +#### Az.Automation +* Fixed the issue that string with escape chars cannot be converted into json object. + +#### Az.Compute +* Added warning when using 'New-AzVmss' without 'latest' image version + +#### Az.DataFactory +* Added global parameters to Data Factory. + +#### Az.EventGrid +* Updated to use the 2020-06-01 API version. +* Added new features: + - Input mapping + - Event Delivery Schema + - Private Link + - Cloud Event V10 Schema + - Service Bus Topic As Destination + - Azure Function As Destination + - WebHook Batching + - Secure webhook (AAD support) + - IpFiltering +* Updated cmdlets: + - 'New-AzEventGridSubscription'/'Update-AzEventGridSubscription': + - Add new optional parameters to support webhook batching. + - Add new optional parameters to support secured webhook using AAD. + - Add new enum for EndpointType parameter to support azure function and service bus topic as new destinations. + - Add new optional parameter for delivery schema. + - 'New-AzEventGridTopic'/'Update-AzEventGridTopic' and 'New-AzEventGridDomain'/'Update-AzEventGridDomain': + - Add new optional parameters to support IpFiltering. + - 'New-AzEventGridTopic'/'New-AzEventGridDomain': + - Add new optional parameters to support Input mapping. + +#### Az.FrontDoor +* Updated module to use API 2020-05-01 +* Added Private link support for Storage, Keyvault and Web App Service resources + +#### Az.HDInsight +* Supported creating cluster with ADLSGen1/2 storage in national clouds. + +#### Az.Monitor +* Fixed bug for 'Get-AzDiagnosticSetting' when metrics or logs are null [#12272] + +#### Az.Network +* Fixed parameters swap in VWan HubVnet connection +* Added new cmdlets for Azure Network Virtual Appliance Sites + - 'Get-AzVirtualApplianceSite' + - 'New-AzVirtualApplianceSite' + - 'Remove-AzVirtualApplianceSite' + - 'Update-AzVirtualApplianceSite' + - 'New-AzOffice365PolicyProperty' +* Added new cmdlets for Azure Network Virtual Appliance + - 'Get-AzNetworkVirtualAppliance' + - 'New-AzNetworkVirtualAppliance' + - 'Remove-AzNetworkVirtualAppliance' + - 'Update-AzNetworkVirtualAppliance' + - 'Get-AzNetworkVirtualApplianceSku' + - 'New-AzVirtualApplianceSkuProperty' +* Onboarded Application Gateway to Private Link Common Cmdlets +* Onboarded StorageSync to Private Link Common Cmdlets +* Onboarded SignalR to Private Link Common Cmdlets + +#### Az.RecoveryServices +* Removed project reference to Authentication +* Azure Backup tuned cmdlets help text to be more accurate. +* Azure Backup added support for fetching MAB agent jobs using 'Get-AzRecoveryServicesBackupJob' cmdlet. + +#### Az.Resources +* Updated 'Save-AzResourceGroupDeploymentTemplate' to use the SDK. +* Added 'Unregister-AzResourceProvider' cmdlet. + +#### Az.Sql +* Added support for Service principal and guest users in Set-AzSqlInstanceActiveDirectoryAdministrator cmdlet' +* Fixed a bug in Data Classification cmdlets.' +* Added support for Azure SQL Managed Instance failover: 'Invoke-AzSqlInstanceFailover' + +#### Az.Storage +* Fixed the issue that UserAgent is not added for some data plane cmdlets. +* Supported create/update Storage account with MinimumTlsVersion and AllowBlobPublicAccess + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' +* Support enable/disable versioning on Blob Service of a Storage account + - 'Update-AzStorageBlobServiceProperty' +* Support list blobs with blob versions + - 'Get-AzStorageBlob' +* Support get/remove single blob snapshot or blob version + - 'Get-AzStorageBlob' + - 'Remove-AzStorageBlob' +* Support pipeline from blob object generated from Azure.Storage.Blobs V12 + - 'Get-AzStorageBlobContent' + - 'New-AzStorageBlobSASToken' + - 'Remove-AzStorageBlob' + - 'Set-AzStorageBlobContent' + - 'Start-AzStorageBlobCopy' + +#### Az.StorageSync +* Added a new version StorageSync SDK targeting ApiVersion 2020-03-01 +* Added Update Storage Sync Service cmdlet + - 'Set-AzStorageSyncService' +* Added IncomingTrafficPolicy and PrivateEndpointConnections to StorageSyncService cmdlets. + +#### Az.Websites +* Added support to perform operations for Slots not in the same resource group as the App Service Plan + +## 4.3.0 - June 2020 +#### Az.Accounts +* Supported discovering environment setting by default and adding environment via 'Add-AzEnvironment' +* Update preloaded assemblies [#12024], [#11976] +* Updated Azure.Core assembly +* Fixed an issue that may cause 'Connect-AzAccount' to fail in multi-threaded execution [#11201] + +#### Az.Aks +* Replaced usage of old [AccessProfile API](/rest/api/aks/managedclusters/getaccessprofile) with calls to [ListClusterAdmin](/rest/api/aks/managedclusters/listclusteradmincredentials) and [ListClusterUser](/rest/api/aks/managedclusters/listclusterusercredentials) APIs + +#### Az.Batch +* Updated Az.Batch to use 'Microsoft.Azure.Management.Batch' SDK version to 11.0.0 +* Added the ability to set the BatchAccount Identity in the 'New-AzBatchAccount' cmdlet + +#### Az.CognitiveServices +* Supported displaying account capabilities. +* Supported modifying PublicNetworkAccess. + +#### Az.Compute +* Added SimulateEviction parameter to Set-AzVM and Set-AzVmssVM cmdlets. +* Added 'Premium_LRS' to the argument completer of StorageAccountType parameter for New-AzGalleryImageVersion cmdlet. +* Added Substatuses to VMCustomScriptExtension [#11297] +* Added 'Delete' to the argument completer of EvictionPolicy parameter for New-AzVM and New-AzVMConfig cmdlets. +* Fixed name of new VM Extension for SAP + +#### Az.DataFactory +* Updated ADF .Net SDK version to 4.9.0 + +#### Az.EventHub +* Added Managed Identity parameters to 'New-AzEventHubNamespace' and 'Set-AzEventHubNamespace' cmdlets + +#### Az.Functions +* Added support to create PowerShell 7.0 and Java 11 function apps + +#### Az.HDInsight +* Supported listing hosts and restart specific hosts of the HDInsight cluster. + +#### Az.HealthcareApis +* Updated the SDK version to 1.1.0 +* Added support for Export settings and Managed Identity + +#### Az.Monitor +* Fixed input object parameter for 'Set-AzActivityLogAlert' +* Fixed 'InputObject' parameter for 'Set-AzActionGroup' [#10868] + +#### Az.Network +* Added support for AddressPrefixType parameter to 'Remove-AzExpressRouteCircuitConnectionConfig' +* Added new cmdlets for Azure FirewallPolicy + - 'New-AzFirewallPolicyDnsSetting' + - Support for Destination FQDN in Network Rules for Firewall Policy +* Added support for backend address pool operations + - 'New-AzLoadBalancerBackendAddressConfig' + - 'New-AzLoadBalancerBackendAddressPool' + - 'Set-AzLoadBalancerBackendAddressPool' + - 'Remove-AzLoadBalancerBackendAddressPool' + - 'Get-AzLoadBalancerBackendAddressPool' +* Added name validation for 'New-AzIpGroup' +* Added new cmdlets for Azure FirewallPolicy + - 'New-AzFirewallPolicyThreatIntelWhitelist' +* Updated below commands for feature: Custom dns servers set/remove on VirtualWan P2SVpnGateway. + - Updated New-AzP2sVpnGateway: Added optional parameter '-CustomDnsServer' for customers to specify their dns servers to set on P2SVpnGateway, which can be used by Point to site clients. + - Updated Update-AzP2sVpnGateway: Added optional parameter '-CustomDnsServer' for customers to specify their dns servers to set on P2SVpnGateway, which can be used by Point to site clients. +* Updated 'Update-AzVpnGateway' + - Added optional parameter '-BgpPeeringAddress' for customers to specify their custom bgps to set on VpnGateway. +* Added new cmdlet to support resetting the routing state of a VirtualHub resource: + - 'Reset-AzHubRouter' +* Updated below things based on recent swagger change for Firewall Policy + - Changes names for RuleGroup, RuleCollectionGroup and RuleType + - Added support for Firewall Policy NAT Rule Collections to support multiple NAT Rule Collection +* [Breaking Change] Added mandatory parameter 'SourceIpGroup' for 'New-AzFirewallPolicyApplicationRule' and 'New-AzFirewallPolicyNetworkRule'. +* [Breaking Change] Fixed 'New-AzFirewallPolicyApplicationRule', parameter 'SourceAddress' to be mandatory. +* [Breaking Change] Fixed 'New-AzFirewallPolicyApplicationRule', parameter 'SourceAddress' to be mandatory. +* [Breaking Change] Removed mandatory parameters: 'TranslatedAddress', 'TranslatedPort' for 'New-AzFirewallPolicyNatRuleCollection'. +* Added new cmdlets to support PrivateLink On Application Gateway + - 'New-AzApplicationGatewayPrivateLinkConfiguration' + - 'Get-AzApplicationGatewayPrivateLinkConfiguration' + - 'New-AzApplicationGatewayPrivateLinkConfiguration' + - 'Set-AzApplicationGatewayPrivateLinkConfiguration' + - 'Remove-AzApplicationGatewayPrivateLinkConfiguration' + - 'New-AzApplicationGatewayPrivateLinkIpConfiguration' +* Added new cmdlets for HubRouteTables child resource of VirtualHub. + - 'New-AzVHubRoute' + - 'New-AzVHubRouteTable' + - 'Get-AzVHubRouteTable' + - 'Update-AzVHubRouteTable' + - 'Remove-AzVHubRouteTable' +* Updated existing cmdlets to support optional RoutingConfiguration input parameter for custom routing in VirtualWan. + - 'New-AzExpressRouteConnection' + - 'Set-AzExpressRouteConnection' + - 'New-AzVirtualHubVnetConnection' + - 'Update-AzVirtualHubVnetConnection' + - 'New-AzVpnConnection' + - 'Update-AzVpnConnection' + - 'New-AzP2sVpnGateway' + - 'Update-AzP2sVpnGateway' + +#### Az.OperationalInsights +* Fixed bug PSWorkspace doesn't implement IOperationalInsightsWorkspace [#12135] +* Added 'pergb2018' to valid value set of parameter 'Sku' in 'Set-AzOperationalInsightsWorkspace' +* Added alias 'FunctionParameters' for parameter 'FunctionParameter' to + - 'New-AzOperationalInsightsSavedSearch' + - 'Set-AzOperationalInsightsSavedSearch' + +#### Az.RecoveryServices +* Azure Backup added support for fetching MAB items. +* Azure Site Recovery supports disk type 'StandardSSD_LRS' + +#### Az.Resources +* Added 'UsageLocation', 'GivenName', 'Surname', 'AccountEnabled', 'MailNickname', 'Mail' on 'PSADUser' [#10526] [#10497] +* Fixed issue that '-Mail' doesn't work on 'Get-AzADUser' [#11981] +* Added '-ExcludeChangeType' parameter to 'Get-AzDeploymentWhatIfResult' and 'Get-AzResourceGroupDeploymentWhatIfResult' +* Added '-WhatIfExcludeChangeType' parameter to 'New-AzDeployment' and 'New-AzResourceGroupDeployment' +* Updated 'Test-Az*Deployment' cmdlets to show better error messages +* Fixed help message for '-Name' parameter of deployment create and What-If cmdlets + +#### Az.Sql +* Added support for service principal for Set SQL Server Azure Active Directory Admin cmdlet +* Fixed sync issue in Data Classification cmdlets. +* Supported searching user by mail on 'Set-AzSqlServerActiveDirectoryAdministrator' [#12192] + +#### Az.Storage +* Supported create Storage account with RequireInfrastructureEncryption + - 'New-AzStorageAccount' +* Moved the logic of loading Azure.Core to Az.Accounts + +#### Az.Websites +* Added safeguard to delete created webapp if restore failed in 'Restore-AzDeletedWebApp' +* Added 'SourceWebApp.Location' for 'New-AzWebApp' and 'New-AzWebAppSlot' +* Fixed bug that prevented changing Container settings in 'Set-AzWebApp' and 'Set-AzWebAppSlot' +* Fixed bug to get SiteConfig when -Name is not given for Get-AzWebApp +* Added a support to create ASP for Linux Apps +* Added exceptions for clone across resource groups + +## 4.2.0 - June 2020 +#### Az.Accounts +* Fixed an issue that may cause Az to skip logs in Azure Automation or PowerShell jobs [#11492] + +#### Az.AnalysisServices +* Updated assembly version of data plane cmdlets + +#### Az.ApiManagement +* Updated assembly version of service management cmdlets + +#### Az.Billing +* Updated assembly version of consumption cmdlets + +#### Az.CognitiveServices +* Support PrivateEndpoint and PublicNetworkAccess control. + +#### Az.DataFactory +* Updated assembly version of data factory V2 cmdlets + +#### Az.DataShare +* General availability of ''Az.DataShare'' module + +#### Az.DesktopVirtualization +* General availability of ''Az.DesktopVirtualization'' module + +#### Az.OperationalInsights +* Upgraded SDK to 0.21.0 +* Added optional parameters to + - 'New-AzOperationalInsightsSavedSearch' + - 'Set-AzOperationalInsightsSavedSearch' + +#### Az.PolicyInsights +* Corrected example 3 for 'Start-AzPolicyComplianceScan' + +#### Az.PowerBIEmbedded +* Updated assembly version of PowerBI cmdlets + +#### Az.PrivateDns +* Corrected verbose output string formatting for Remove-AzPrivateDnsRecordSet + +#### Az.RecoveryServices +* Azure Site Recovery support for creating recovery plan for zone to zone replication from xml input. +* Updated assembly version of SiteRecovery and Backup cmdlets + +#### Az.Resources +* Added Tail parameter to Get-AzDeploymentScriptLog and Save-AzDeploymentScriptLog cmdlets +* Formatted Output property and show it on the Get-AzDeploymentScript cmdlet output +* Renamed -DeploymentScriptInputObject parameter to -DeploymentScriptObject +* Fixed missing file/target name in cmdlet messages. +* Updated assembly version of resource manager and tags cmdlets + +#### Az.Sql +* Added UsePrivateLinkConnection to 'New-AzSqlSyncGroup', 'Update-AzSqlSyncGroup', 'New-AzSqlSyncMember' and 'Update-AzSqlSyncMember' +* Added SyncMemberAzureDatabaseResourceId to 'New-AzSqlSyncMember' and 'Update-AzSqlSyncMember' +* Added Guest user lookup support to Set SQL Server Azure Active Directory Admin cmdlet + +#### Az.Storage +* Updated assembly version of data plane cmdlets + +## 4.1.0 - May 2020 +### Highlights since the last release +* Supported PowerShell versions: Windows PowerShell 5.1, PowerShell Core 6.2.4+, PowerShell 7 +* General availability of Az.Functions +* Az.ApiManagement, Az.Batch, Az.Compute, Az.KeyVault, Az.Monitor, Az.Network, Az.OperationalInsights, Az.Resources, and Az.Storage have major release + +#### Az.Accounts +* Updated 'Add-AzEnvironment' and 'Set-AzEnvironment' to accept parameters 'AzureSynapseAnalyticsEndpointResourceId' and 'AzureSynapseAnalyticsEndpointSuffix' +* Added Azure.Core related assemblies into Az.Accounts, supported PowerShell platforms include Windows PowerShell 5.1, PowerShell Core 6.2.4, PowerShell 7+ + +#### Az.Aks +* Upgraded API Version to 2019-10-01 +* Supported to create AKS using Windows container +* Provided new cmdlets: 'New-AzAksNodePool', 'Update-AzAksNodePool', 'Remove-AzAksNodePool', + 'Get-AzAksNodePool', 'Install-AzAksKubectl', 'Get-AzAksVersion' + +#### Az.ApiManagement +* 'New-AzApiManagement' and 'Set-AzApiManagement': [-AssignIdentity] parameter renamed as [-SystemAssignedIdentity] +* 'New-AzApiManagement' and 'Set-AzApiManagement': New parameter added: [`-UserAssignedIdentity <String[]>`] +* 'Get-AzApiManagementProperty': renamed as 'Get-AzApiManagementNamedValue'. PropertyId parameter renamed as NamedValueId. +* 'New-AzApiManagementProperty': renamed as 'New-AzApiManagementNamedValue'. PropertyId parameter renamed as NamedValueId. +* 'Set-AzApiManagementProperty': renamed as 'Set-AzApiManagementNamedValue'. PropertyId parameter renamed as NamedValueId. +* 'Remove-AzApiManagementProperty': renamed as 'Remove-AzApiManagementNamedValue'. PropertyId parameter renamed as NamedValueId. +* Added new 'Get-AzApiManagementAuthorizationServerClientSecret' cmdlet and 'Get-AzApiManagementAuthorizationServer' will not return client secret anymore. +* Added new 'Get-AzApiManagementNamedValueSecretValue' cmdlet and 'Get-AzApiManagementNamedValue' will not return secret value. +* Added new 'Get-AzApiManagementOpenIdConnectProviderClientSecret' cmdlet and 'Get-AzApiManagementOpenIdConnectProvider' will not return client secret anymore. +* Added new 'Get-AzApiManagementSubscriptionKey' cmdlet and 'Get-AzApiManagementSubscription' will not return subscription keys anymore. +* Added new 'Get-AzApiManagementTenantAccessSecret' cmdlet and 'Get-AzApiManagementTenantAccess' will not return keys anymore. +* Added new 'Get-AzApiManagementTenantGitAccessSecret' cmdlet and 'Get-AzApiManagementTenantGitAccess' will not return keys anymore. + +#### Az.ApplicationInsights +* Added Parameters: 'RetentionInDays' 'PublicNetworkAccessForIngestion' 'PublicNetworkAccessForQuery' for 'New-AzApplicationInsights' +* Created cmdlet 'Update-AzApplicationInsights' +* Created cmdlets for Linked Storage Account + +#### Az.Batch +* Updated Az.Batch to use 'Microsoft.Azure.Batch' SDK version 13.0.0 and 'Microsoft.Azure.Management.Batch' SDK version 9.0.0. +* Added the ability to select the kind of certificate being added using the new '-CertificateKind' parameter to 'New-AzBatchCertificate'. +* Removed 'ApplicationPackages' property from 'PSApplication' which was previously always ''. + - The specific packages inside of an application now can be retrieved using 'Get-AzBatchApplicationPackage'. For example: 'Get-AzBatchApplication -AccountName myaccount -ResourceGroupName myresourcegroup -ApplicationId myapplication'. +* When creating a pool using 'New-AzBatchPool', the 'VirtualMachineImageId' property of 'PSImageReference' can now only refer to a Shared Image Gallery image. +* When creating a pool using 'New-AzBatchPool', the pool can be provisioned without a public IP using the new 'PublicIPAddressConfiguration' property of 'PSNetworkConfiguration'. + - The 'PublicIPs' property of 'PSNetworkConfiguration' has moved in to 'PSPublicIPAddressConfiguration' as well. This property can only be specified if 'IPAddressProvisioningType' is 'UserManaged'. + +#### Az.Compute +* Added HostId parameter to 'Update-AzVM' cmdlet +* Updated Help documents for 'New-AzVMConfig', 'New-AzVmssConfig', 'Update-AzVmss', 'Set-AzVMOperatingSystem' and 'Set-AzVmssOsProfile' cmdlets. +* Breaking changes + - FilterExpression parameter is removed from 'Get-AzVMImage' cmdlet. + - AssignIdentity parameter is removed from 'New-AzVmssConfig', 'New-AzVMConfig' and 'Update-AzVM' cmdlets. + - AutomaticRepairMaxInstanceRepairsPercent is removed from 'New-AzVmssConfig' and 'Update-AzVmss' cmdlets. + - AvailabilitySetsColocationStatus, VirtualMachinesColocationStatus and VirtualMachineScaleSetsColocationStatus properties are removed from ProximityPlacementGroup. + - MaxInstanceRepairsPercent property is removed from AutomaticRepairsPolicy. + - The types of AvailabilitySets, VirtualMachines and VirtualMachineScaleSets are changed from `IList<SubResource>` to `IList<SubResourceWithColocationStatus>`. +* Description for 'Get-AzVM' cmdlet has been updated to better describe it. + +#### Az.DataFactory +* Supported CRUD of data flow runtime properties in Managed IR. + +#### Az.FrontDoor +* Added new cmdlets for creation, update, retreival, and deletion of Front Door Rules Engine object +* Added helper cmdlets for construction of Front Door Rules Engine object +* Added Rules Engine reference to Front Door Routing Rule object. +* Added Private Link parameters to Front Door Backend object + +#### Az.Functions +* General availability of ''Az.Functions'' module + +#### Az.HDInsight +* Supported Customer-managed key disk encryption. + +#### Az.HealthcareApis +* Access policies are no longer defaulted to the current principal + +#### Az.IotHub +* Added cmdlet to invoke a query in an IoT hub to retrieve information using a SQL-like language. +* Fix issue that 'Add-AzIotHubDevice' fails to create Edge Enabled Device without child devices [#11597] +* Added cmdlet to generate SAS token for Iot Hub, device or module. +* Added cmdlet to invoke configuration metrics query. +* Manage IoT Edge automatic deployment at scale. New cmdlets are: + - 'Add-AzIotHubDeployment' + - 'Get-AzIotHubDeployment' + - 'Remove-AzIotHubDeployment' + - 'Set-AzIotHubDeployment' +* Added cmdlet to invoke an IoT Edge deployment metrics query. +* Added cmdlet to apply the configuration content to the specified edge device. + +#### Az.KeyVault +* Removed two aliases: 'New-AzKeyVaultCertificateAdministratorDetails' and 'New-AzKeyVaultCertificateOrganizationDetails' +* Enabled soft delete by default when creating a key vault +* Network rules can be set to govern the accessibility from specific network locations when creating a key vault +* Added support to bring your own key (BYOK) + - 'Add-AzKeyVaultKey' supports generating a key exchange key + - 'Get-AzKeyVaultKey' supports downloading a public key in PEM format +* Updated the 'KeyOps' part of the help document of 'Add-AzKeyVaultKey' + +#### Az.Monitor +* Fixed bug for 'Set-AzDiagnosticSettings', retention policy won't apply to all categories [#11589] +* Supported WebTest availability criteria for metric alert V2 + - 'New-AzMetricAlertRuleV2Criteria': an option to create webtest availability criteria was added + - 'Add-AzMetricAlertRuleV2': supports the new webtest availability criteria +* Removed redundant definition for RetentionPolicy in PSLogProfile [#7608] +* Removed redundant properties difined in PSEventData [#11353] +* Renamed 'Get-AzLog' to 'Get-AzActivityLog' + +#### Az.Network +* Added breaking change attribute to notify that Zone default behaviour will be changed + - 'New-AzPublicIpAddress' + - 'New-AzPublicIpPrefix' + - 'New-AzLoadBalancerFrontendIpConfig' +* Added support for a new top level resource SecurityPartnerProvider + - New cmdlets added: + - New-AzSecurityPartnerProvider + - Remove-AzSecurityPartnerProvider + - Get-AzSecurityPartnerProvider + - Set-AzSecurityPartnerProvider +* Added 'RequiredZoneNames' on 'PSPrivateLinkResource' and 'GroupId' on 'PSPrivateEndpointConnection' +* Fixed incorrect type of SuccessThresholdRoundTripTimeMs parameter for New-AzNetworkWatcherConnectionMonitorTestConfigurationObject +* Updated VirtualWan cmdlets to set default value of AllowVnetToVnetTraffic argument to True. + - 'New-AzVirtualWan' + - 'Update-AzVirtualWan' +* Added new cmdlets to support DNS zone group for private endpoint + - 'New-AzPrivateDnsZoneConfig' + - 'Get-AzPrivateDnsZoneGroup' + - 'New-AzPrivateDnsZoneGroup' + - 'Set-AzPrivateDnsZoneGroup' + - 'Remove-AzPrivateDnsZoneGroup' +* Added 'DNSEnableProxy', 'DNSRequireProxyForNetworkRules' and 'DNSServers' parameters to 'AzureFirewall' +* Added 'EnableDnsProxy', 'DnsProxyNotRequiredForNetworkRule' and 'DnsServer' parameters to 'AzureFirewall' + - Updated cmdlet: + - New-AzFirewall + +#### Az.OperationalInsights +* Updated legacy code to apply new generated SDK +* Deleted cmdlets due to deprecated APIs + - 'Get-AzOperationalInsightsSavedSearchResult' (alias 'Get-AzOperationalInsightsSavedSearchResults') + - 'Get-AzOperationalInsightsSearchResult' (alias 'Get-AzOperationalInsightsSearchResults') + - 'Get-AzOperationalInsightsLinkTarget' (alias 'Get-AzOperationalInsightsLinkTargets') +* Added parameters for 'Set-AzOperationalInsightsWorkspace' and 'New-AzOperationalInsightsWorkspace' +* Created cmdlets for Linked Stoarge Account +* Created cmdlets for Clusters and Linked Service + +#### Az.RecoveryServices +* Azure Site Recovery added support for protecting proximity placement group virtual machines for Azure to Azure provider. +* Azure Site Recovery added support for zone to zone replication. +* Azure Backup Added Long term retention support for Azure FileShare Recovery Points. +* Azure Backup Added disk exclusion properties to 'Get-AzRecoveryServicesBackupItem' cmdlet output. +* Added private endpoint for Vault credential file for site recovery service. + +#### Az.Resources +* Added message warning about view delay when creating a new Role Definition +* Changed policy cmdlets to output strongly-typed objects +* Removed '-TenantLevel' parameter used for on the 'Get-AzResourceLock' cmdlet [#11335] +* Fixed 'Remove-AzResourceGroup -Id ResourceId'[#9882] +* Added new cmdlet for getting ARM template What-If results at resource group scope: 'Get-AzDeploymentResourceGroupWhatIfResult' +* Added new cmdlet for getting ARM template What-If results at subscription scope: 'Get-AzDeploymentWhatIfResult' + - Alias: 'Get-AzSubscriptionDeploymentWhatIf' +* Overrode '-WhatIf' and '-Confirm' parameters for 'New-AzDeployment' and 'New-AzResourceGroupDeployment' to use ARM template What-If results +* Added deprecation message for 'ApiVersion' parameter in deployment cmdlets +* Added capability to show improved error messages for deployment failures +* Added correlationId logging for deployment failures +* Added 'error' property to the deployment script output +* Updated nuget Microsoft.Azure.Management.ResourceManager to '3.7.1-preview' +* Removed specific test cases as Error property in DeploymentValidateResult has changed to readonly from nuget 3.7.1-preview +* Brought GenericResourceExpanded from SDK ResourceManager 3.7.1-preview +* Added tag support for all Get cmdlets for deployment, as well as + - 'New-AzDeployment' + - 'New-AzManagementGroupDeployment' + - 'New-AzResourceGroupDeployment' + - 'New-AzTenantDeployment' + +#### Az.ServiceFabric +* Fixed bug in add certificate using --SecretIdentifier that was getting the wrong certificate thumbprint + +#### Az.Sql +* Enhance performance of: + - 'Set-AzSqlDatabaseSensitivityClassification' + - 'Set-AzSqlInstanceDatabaseSensitivityClassification' + - 'Remove-AzSqlDatabaseSensitivityClassification' + - 'Remove-AzSqlInstanceDatabaseSensitivityClassification' + - 'Enable-AzSqlDatabaseSensitivityRecommendation' + - 'Enable-AzSqlInstanceDatabaseSensitivityRecommendation' + - 'Disable-AzSqlDatabaseSensitivityRecommendation' + - 'Disable-AzSqlInstanceDatabaseSensitivityRecommendation' +* Removed client-side validation of 'RetentionDays' parameter from cmdlet 'Set-AzSqlDatabaseBackupShortTermRetentionPolicy' +* Auditing to a storage account in Vnet, fixing a bug when creating a Storage Blob Data Contributor role. + +#### Az.Storage +* Added '-AsJob' to get/list account cmdlet 'Get-AzStorageAccount' +* Make KeyVersion to optional when update Storage account with KeyvaultEncryption, to support key auto-rotation + - 'Set-AzStorageAccount' +* Fixed remove Azure File Directory fail with pipeline + - 'Remove-AzStorageDirectory' +* Fixed [#9880]: Change NetWorkRule DefaultAction value defination to align with swagger. + - 'Update-AzStorageAccountNetworkRuleSet' + - 'Get-AzStorageAccountNetworkRuleSet' +* Fixed [#11624]: Skip duplicated rules when add NetworkRules, to avoid server failure + - 'Add-AzStorageAccountNetworkRule' +* Upgraded Microsoft.Azure.Cosmos.Table SDK to 1.0.7 +* Added a warning message to remind user to list again with ContinuationToken when only part items are returned in list DataLake Gen2 Items, + - 'Get-AzDataLakeGen2ChildItem' +* Supported to create or update Storage account with Azure Files Active Directory Domain Service Authentication + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' +* Supported to new or list Kerberos keys of Storage account + - 'New-AzStorageAccountKey' + - 'Get-AzStorageAccountKey' +* Supported failover Storage account + - 'Invoke-AzStorageAccountFailover' +* Updated help of 'Get-AzStorageBlobCopyState' +* Updated help of 'Get-AzStorageFileCopyState' and 'Start-AzStorageBlobCopy' +* Integrated Storage client library v12 to Queue and File cmdlets +* Changed output type from CloudFile to AzureStorageFile, the original output will become a child property of the new output + - 'Get-AzStorageFile' + - 'Remove-AzStorageFile' + - 'Get-AzStorageFileContent' + - 'Set-AzStorageFileContent' + - 'Start-AzStorageFileCopy' +* Changed output type from CloudFileDirectory to AzureStorageFileDirectory, the original output will become a child property of the new output + - 'New-AzStorageDirectory' + - 'Remove-AzStorageDirectory' +* Changed output type from CloudFileShare to AzureStorageFileShare, the original output will become a child property of the new output + - 'Get-AzStorageShare' + - 'New-AzStorageShare' + - 'Remove-AzStorageShare' +* Changed output type from FileShareProperties to AzureStorageFileShare, the original output will become a sub child property of the new output + - 'Set-AzStorageShareQuota' + +#### Az.TrafficManager +* Fixed incorrect profile name in 'DisableAzureTrafficManagerEndpoint' verbose output + +#### Az.Websites +* Fixed typo on help of 'Update-AzWebAppAccessRestrictionConfig'. + +## 3.8.0 - April 2020 +#### Az.Accounts +* Updated Azure PowerShell survey URL in 'Resolve-AzError' [#11507] + +#### Az.ApiManagement +* Added breaking change notice for Azure File cmdlets output change in a future release +* 'Set-AzApiManagementGroup' Updated documentation to specify the GroupId parameter + +#### Az.Cdn +* Fixed ChinaCDN related pricing SKU display + +#### Az.CognitiveServices +* Supported Identity, Encryption, UserOwnedStorage + +#### Az.Compute +* Added 'Set-AzVmssOrchestrationServiceState' cmdlet. +* 'Get-AzVmss' with -InstanceView shows OrchestrationService states. + +#### Az.IotHub +* Manage IoT device twin configuration, New cmdlets are: + - 'Get-AzIotHubDeviceTwin' + - 'Update-AzIotHubDeviceTwin' +* Added cmdlet to invoke direct method on a device in an Iot Hub. +* Manage IoT device module twin configuration, New cmdlets are: + - 'Get-AzIotHubModuleTwin' + - 'Update-AzIotHubModuleTwin' +* Manage IoT automatic device management configuration at scale. New cmdlets are: + - 'Add-AzIotHubConfiguration' + - 'Get-AzIotHubConfiguration' + - 'Remove-AzIotHubConfiguration' + - 'Set-AzIotHubConfiguration' +* Added cmdlet to invoke an edge module method in an Iot Hub. + +#### Az.KeyVault +* Added a new cmdlet 'Update-AzKeyVault' that can enable soft delete and purge protection on a vault +* Added support to Microsoft.PowerShell.SecretManagement [#11178] +* Fixed error in the examples of 'Remove-AzKeyVaultManagedStorageSasDefinition' [#11479] +* Added support to private endpoint + +#### Az.Maintenance +* Publishing release version of Maintenance cmdlets for GA + +#### Az.Monitor +* Added cmdlets for private link scope + - 'Get-AzInsightsPrivateLinkScope' + - 'Remove-AzInsightsPrivateLinkScope' + - 'New-AzInsightsPrivateLinkScope' + - 'Update-AzInsightsPrivateLinkScope' + - 'Get-AzInsightsPrivateLinkScopedResource' + - 'New-AzInsightsPrivateLinkScopedResource' + - 'Remove-AzInsightsPrivateLinkScopedResource' + +#### Az.Network +* Updated cmdlets to enable connection on private IP for Virtual Network Gateway. + - 'New-AzVirtualNetworkGateway' + - 'Set-AzVirtualNetworkGateway' + - 'New-AzVirtualNetworkGatewayConnection' + - 'Set-AzVirtualNetworkGatewayConnection' +* Updated cmdlets to enable FQDN based LocalNetworkGateways and VpnSites + - 'New-AzLocalNetworkGateway' + - 'New-AzVpnSiteLink' +* Added support for IPv6 address family in ExpressRouteCircuitConnectionConfig (Global Reach) + - Added 'Set-AzExpressRouteCircuitConnectionConfig' + - allows setting of all the existing properties including the IPv6CircuitConnectionProperties + - Updated 'Add-AzExpressRouteCircuitConnectionConfig' + - Added another optional parameter AddressPrefixType to specify the address family of address prefix +* Updated cmdlets to enable setting of DPD Timeout on Virtual Network Gateway Connections. + - New-AzVirtualNetworkGatewayConnection + - Set-AzVirtualNetworkGatewayConnection + +#### Az.PolicyInsights +* Added 'Start-AzPolicyComplianceScan' cmdlet for triggering policy compliance scans +* Added policy definition, set definition, and assignment versions to 'Get-AzPolicyState' output + +#### Az.ServiceFabric +* Improved code formatting and usability of 'New-AzServiceFabricCluster' examples + +#### Az.Sql +* Added cmdlets 'Get-AzSqlInstanceOperation' and 'Stop-AzSqlInstanceOperation' +* Supported auditing to a storage account in VNet. + +#### Az.Storage +* Added breaking change notice for Azure File cmdlets output change in a future release +* Supported new SkuName StandardGZRS, StandardRAGZRS when create/update Storage account + - 'New-AzStorageAccount' + - 'Set-AzStorageAccount' +* Supported DataLake Gen2 + - 'New-AzDataLakeGen2Item' + - 'Get-AzDataLakeGen2Item' + - 'Get-AzDataLakeGen2ChildItem' + - 'Move-AzDataLakeGen2Item' + - 'Set-AzDataLakeGen2ItemAclObject' + - 'Update-AzDataLakeGen2Item' + - 'Get-AzDataLakeGen2ItemContent' + - 'Remove-AzDataLakeGen2Item' + +## 0.10.0-preview - April 2020 +### General +* Az modules is now available in preview on Azure Stack Hub. This allows for cross-platform compatibility with Linux and macOs. Azure Stack Hub now supports PowerShell core with the Az modules, more information [here](https://aka.ms/az4AzureStack) +* Az modules support profile 2019-03-01-hybrid: + - Az.Billing + - Az.Compute + - Az.DataBoxEdge + - Az.EventHub + - Az.IotHub + - Az.KeyVault + - Az.Monitor + - Az.Network + - Az.Resources + - Az.Storage + - Az.Websites +* Three new PowerShell modules for az have been introduced that work with Azure Stack Hub, which are Az.Databox, Az.IotHub, and Az.EventHub +* Commands remain relatively the same, with minor changes such as changing AzureRM to Az +* Updated link to PowerShell documentation for Azure Stack Hub can be found [here](https://aka.ms/InstallASHPowerShell) + +#### Az.Accounts +* Upgrade from ADAL to MSAL + +## 3.7.0 - March 2020 +#### Az.Accounts +* Fixed 'Get-AzTenant'/'Get-AzDefault'/'Set-AzDefault' throw NullReferenceException when not login [#10292] + +#### Az.Compute +* Added the following parameters to 'New-AzDiskConfig' cmdlet: + - DiskIOPSReadOnly, DiskMBpsReadOnly, MaxSharesCount, GalleryImageReference +* Allowed Encryption property to Target parameter of 'New-AzGalleryImageVersion' cmdlet. +* Fixed tempDisk issue for 'Set-AzVmss' -Reimage and 'Invoke-AzVMReimage' cmdlets. [#11354] +* Added support to below cmdlets for new SAP Extension + - 'Set-AzVMAEMExtension' + - 'Get-AzVMAEMExtension' + - 'Remove-AzVMAEMExtension' + - 'Update-AzVMAEMExtension' +* Fixed errors in examples of help document +* Showed the exact string value for VM PowerState in the table format. +* 'New-AzVmssConfig': fixed serialization of AutomaticRepairs property when SinglePlacementGroup is disabled. [#11257] + +#### Az.DataFactory +* Updated ADF .Net SDK version to 4.8.0 +* Added optional parameters to 'Invoke-AzDataFactoryV2Pipeline' command to support rerun + +#### Az.DataLakeStore +* Added breaking change description for 'Export-AzDataLakeStoreItem' and 'Import-AzDataLakeStoreItem' +* Added option of Byte encoding for 'New-AzDataLakeStoreItem', 'Add-AzDAtaLakeStoreItemContent', and 'Get-AzDAtaLakeStoreItemContent' + +#### Az.HDInsight +* Supported specifying minimal supported TLS version when creating cluster. + +#### Az.IotHub +* Added support to manage distributed settings per-device. New Cmdlets are: + - 'Get-AzIotHubDistributedTracing' + - 'Set-AzIotHubDistributedTracing' + +#### Az.KeyVault +* Added breaking change attributes to 'New-AzKeyVault' + +#### Az.Monitor +* Updated documentation for 'New-AzScheduledQueryRuleLogMetricTrigger' + +#### Az.Network +* Updated cmdlets to allow cross-tenant VirtualHubVnetConnections + - 'New-AzVirtualHubVnetConnection' + - 'Update-AzVirtualHubVnetConnection' + - 'New-AzVirtualHub' + - 'Update-AzVirtualHub' +* Removed Sql Management SDK dependency +* Updated cmdlets to allow force firewallPolicy association + - 'New-AzApplicationGateway' + +#### Az.PolicyInsights +* Improved error messages + +#### Az.RecoveryServices +* Azure Site Recovery added support for doing reprotect and updated vm properties for Azure disk encrypted Virtual Machines. +* Added Azure Site Recovery VmwareToAzure properties DR monitoring +* Azure Backup added support for retrying policy update for failed items. +* Azure Backup Added support for disk exclusion settings during backup and restore. +* Azure Backup Added Support for Restoring Multiple files/folders in AzureFileShare +* Azure Backup Added support for User-specified Resourcegroup support while updating IaasVM Policy + +#### Az.Resources +* Fixed 'Get-AzResource -ResourceGroupName -Name -ExpandProperties -ResourceType' to use actual apiVersion of resources instead of default apiVersion [#11267] +* Added correlationId logging for error scenarios +* Small documentation change to 'Get-AzResourceLock'. Added example. +* Escaped single quote in parameter value of 'Get-AzADUser' [#11317] +* Added new cmdlets for Deployment Scripts ('Get-AzDeploymentScript', 'Get-AzDeploymentScriptLog', 'Save-AzDeploymentScriptLog', 'Remove-AzDeploymentScript') + +#### Az.Sql +* Added readable secondary parameter to 'Invoke-AzSqlDatabaseFailover' +* Added cmdlet 'Disable-AzSqlServerActiveDirectoryOnlyAuthentication' +* Saved sensitivity rank when classifying columns in the database. + +#### Az.Support +* General availability of 'Az.Support' module + +#### Az.Websites +* Added support for working with webapp Traffic Routing Rules via below new cmdlets + - 'Get-AzWebAppTrafficRouting' + - 'Update-AzWebAppTrafficRouting' + - 'Add-AzWebAppTrafficRouting' + - 'Remove-AzWebAppTrafficRouting' + +## 3.6.1 - March 2020 +#### Az.Accounts +* Open Azure PowerShell survey page in 'Send-Feedback' [#11020] +* Display Azure PowerShell survey URL in 'Resolve-Error' [#11021] +* Added Az version in UserAgent + +#### Az.ApiManagement +* Added support for retrieving and configuring Custom Domain on the DeveloperPortal Endpoint [#11007] +* 'Export-AzApiManagementApi' Added support for downloading Api Definition in Json format [#9987] +* 'Import-AzApiManagementApi' Added support for importing OpenApi 3.0 definition from Json document +* 'New-AzApiManagementIdentityProvider' and 'Set-AzApiManagementIdentityProvider' Added support for configuring 'Signin Tenant' for AAD B2C Provider [#9784] + +#### Az.DataLakeStore +* Added reference to System.Buffers explicitly in csproj and psd1. + +#### Az.IotHub +* Added support to manage devices in an Iot Hub. New Cmdlets are: + - 'Add-AzIotHubDevice' + - 'Get-AzIotHubDevice' + - 'Remove-AzIotHubDevice' + - 'Set-AzIotHubDevice' +* Added support to manage modules on a target Iot device in an Iot Hub. New Cmdlets are: + - 'Add-AzIotHubModule' + - 'Get-AzIotHubModule' + - 'Remove-AzIotHubModule' + - 'Set-AzIotHubModule' +* Added cmdlet to get the connection string of a target IoT device in an Iot Hub. +* Added cmdlet to get the connection string of a module on a target IoT device in an Iot Hub. +* Added support to get/set parent device of an IoT device. New Cmdlets are: + - 'Get-AzIotHubDeviceParent' + - 'Set-AzIotHubDeviceParent' +* Added support to manage device parent-child relationship. + +#### Az.Monitor +* Fixed output value for 'Get-AzMetricDefinition' [#9714] + +#### Az.Network +* Updated Sql Management SDK. +* Fixed a naming-difference issue in PrivateLinkServiceConnectionState class. + - Mapping the field ActionsRequired to ActionRequired. +* Added PublicNetworkAccess to 'New-AzSqlServer' and 'Set-AzSqlServer' + +#### Az.Resources +* Fixed for null reference bug in 'Get-AzRoleAssignment' +* Marked switch '-Force' and '-PassThru' optional in 'Remove-AzADGroup' [#10849] +* Fixed issue that 'MailNickname' doesn't return in 'Remove-AzADGroup' [#11167] +* Fixed issue that 'Remove-AzADGroup' pipe operation doesn't work [#11171] +* Fixed for null reference bug in GetAzureRoleAssignmentCommand +* Added breaking change attributes for upcoming changes to policy cmdlets +* Updated 'Get-AzResourceGroup' to perform resource group tag filtering on server-side +* Extended Tag cmdlets to accept -ResourceId + - Get-AzTag -ResourceId + - New-AzTag -ResourceId + - Remove-AzTag -ResourceId +* Added new Tag cmdlet + - Update-AzTag -ResourceId +* Brought ScopedDeployment from SDK 3.3.0 + +#### Az.Sql +* Added PublicNetworkAccess to 'New-AzSqlServer' and 'Set-AzSqlServer' +* Added support for Long Term Retention backup configuration for Managed Databases + - Get/Set LTR policy on a managed database + - Get LTR backup(s) by managed database, managed instance, or by location + - Remove an LTR backup + - Restore an LTR backup to create a new managed database +* Added MinimalTlsVersion to New-AzSqlServer and Set-AzSqlServer +* Added MinimalTlsVersion to New-AzSqlInstance and Set-AzSqlInstance +* Bumped SQL SDK version for Az.Network + +#### Az.Storage +* Supported AllowProtectedAppendWrite in ImmutabilityPolicy + - 'Set-AzRmStorageContainerImmutabilityPolicy' +* Added breaking change warning message for AzureStorageTable type change in a future release + - 'New-AzStorageTable' + - 'Get-AzStorageTable' + +#### Az.Websites +* Added Tag parameter for 'New-AzAppServicePlan' and 'Set-AzAppServicePlan' +* Stop cmdlet execution if an exception is thrown when adding a custom domain to a website +* Added support to perform operations for App Services not in the same resource group as the App Service Plan +* Applied access restriction to WebApp/Function in different resource groups +* Fixed issue to set custom hostnames for WebAppSlots + +## 3.5.0 - February 2020 +### Highlights since the last major release +* Updated client side telemetry. +* Az.IotHub added cmdlets to support to manage devices. +* Az.SqlVirtualMachine added cmdlets for Availability Group Listener. + +#### Az.Resource +* Fixed bug preventing correct tenant-level resource id generation. +* Fixed typo. + +#### Az.Accounts +* Added SubscriptionId, TenantId, and execution time into data of client side telemetry + +#### Az.Automation +* Fixed typo in Example 1 in reference documentation for 'New-AzAutomationSoftwareUpdateConfiguration' + +#### Az.CognitiveServices +* Updated SDK to 7.0 +* Improved error message when server responses empty body + +#### Az.Compute +* Allowed empty value for ProximityPlacementGroupId during update + +#### Az.FrontDoor +* Added cmdlet to get managed rule definitions that can be used in WAF + +#### Az.IotHub +* Added support to manage devices in an Iot Hub. New Cmdlets are: + - 'Add-AzIotHubDevice' + - 'Get-AzIotHubDevice' + - 'Remove-AzIotHubDevice' + - 'Set-AzIotHubDevice' + +#### Az.KeyVault +* Fixed duplicated text for Add-AzKeyVaultKey.md + +#### Az.Monitor +* Fixed description of the Get-AzLog cmdlet. +* A new parameter called ActionGroupId was added to 'New-AzMetricAlertRuleV2' command. + - The user can provide either ActionGroupId(string) or ActionGorup(ActivityLogAlertActionGroup). + +#### Az.Network +* Added one extra parameter note for parameter '-EnableProxyProtocol' for 'New-AzPrivateLinkService' cmdlet. +* Fixed FilterData example in Start-AzVirtualNetworkGatewayConnectionPacketCapture.md and Start-AzVirtualnetworkGatewayPacketCapture.md. +* Added Packet Capture example for capture all inner and outer packets in Start-AzVirtualNetworkGatewayConnectionPacketCapture.md and Start-AzVirtualnetworkGatewayPacketCapture.md. +* Supported Azure Firewall Policy on VNet Firewalls + - No new cmdlets are added. Relaxing the restriction for firewall policy on VNet firewalls + +#### Az.RecoveryServices +* Added Support for Restore-as-files for SQL Databases. + +#### Az.Resources +* Refactored template deployment cmdlets + - Added new cmdlets for managing deployments at management group: *-AzManagementGroupDeployment + - Added new cmdlets for managing deployments at tenant scope: *-AzTenantDeployment + - Refactored *-AzDeployment cmdlets to work specifically at subscription scope + - Created aliases *-AzSubscriptionDeployment for *-AzDeployment cmdlets +* Fixed 'Update-AzADApplication' when parameter 'AvailableToOtherTenants' is not set +* Removed ApplicationObjectWithoutCredentialParameterSet to avoid AmbiguousParameterSetException. +* Regenerated help files + +#### Az.Sql +* Added support for cross subscription point in time restore on Managed Instances. +* Added support for changing existing Sql Managed Instance hardware generation +* Fixed 'Update-AzSqlServerVulnerabilityAssessmentSetting' help examples: parameter/property output - EmailAdmins + +#### Az.SqlVirtualMachine +* Added cmdlets for Availability Group Listener + +#### Az.StorageSync +* Updated supported character sets in 'Invoke-AzStorageSyncCompatibilityCheck'. + +## 3.4.0 - February 2020 + +#### Az.CosmosDB +* Added cmdlets for Gremlin, MongoDB, Cassandra and Table APIs. +* Updated .NET SDK Version to 1.0.1 +* Added parameters ConflictResolutionPolicyMode, ConflictResolutionPolicyPath and ConflictResolutionPolicyPath in Set-AzCosmosDBSqlContainer. +* Added new cmdlets for Sql API : New-CosmosDBSqlSpatialSpec, New-CosmosDBSqlCompositePath, New-CosmosDBSqlIncludedPathIndex, New-CosmosDBSqlIncludedPath + +#### Az.Accounts +* Disable context auto saving when AzureRmContext.json not available +* Update the reference to Azure Powershell Common to 1.3.5-preview + +#### Az.ApiManagement +* **Get-AzApiManagementApiSchema** Fixed getting Open-Api Schema associated with an API + https://github.com/Azure/azure-powershell/issues/10626 +* **New-AzApiManagementProduct*** and **Set-AzApiManagementProduct** + - Fix documentation for https://github.com/Azure/azure-powershell/issues/10472 +* **Set-AzApiManagementApi** + Added example to show how to update the ServiceUrl using the cmdlet + +#### Az.Compute +* Limit the number of VM status to 100 to avoid throttling when Get-AzVM -Status is performed without VM name. +* Add Update-AzDiskEncryptionSet cmdlet +* Add EncryptionType and DiskEncryptionSetId parameters to the following cmdlets: + - New-AzDiskUpdateConfig, New-AzSnapshotUpdateConfig +* Add ColocationStatus parameter to Get-AzProximityPlacementGroup cmdlet. + +#### Az.DataFactory +* Update ADF .Net SDK version to 4.7.0 + +#### Az.DeploymentManager +* Adds LIST operations for resources +* Adds capability for performing operations on Health Check steps + +#### Az.HDInsight +* Fix document error of New-AzHDInsightCluster. + +#### Az.KeyVault +* Add Name alias to VaultName attribute to make Remove-AzureKeyVault consistent with New-AzureKeyVault. + +#### Az.Network +* New example added to Set-AzNetworkWatcherConfigFlowLog.md to demonstrate Traffic Analytics disable scenario. +* Add support for assigning management IP configuration to Azure Firewall - a dedicated subnet and Public IP that the firewall will use for its management traffic + - Updated New-AzFirewall cmdlet: + - Added parameter -ManagementPublicIpAddress (not mandatory) which accepts a Public IP Address object + - Added method SetManagementIpConfiguration on firewall object - requires a subnet and a Public IP address as input - subnet name must be 'AzureFirewallManagementSubnet' +* Corrected Get-AzNetworkSecurityGroup examples to show examples for NSG's instead of network interfaces. +* Fixed typo in New-AzVpnSite command that was preventing resource id completer from completing a parameter. +* Added support for Url Confiugration in Rewrite Rules Action Set in the Application Gateway + - New cmdlets added: + - New-AzApplicationGatewayRewriteRuleUrlConfiguration + - Cmdlets updated with optional parameter - UrlConfiguration + - New-AzApplicationGatewayRewriteRuleActionSet +* Add suppport for NetworkWatcher ConnectionMonitor version 2 resources + +#### Az.PolicyInsights +* Support evaluating compliance prior to determining what resource to remediate + - Add '-ResourceDiscoverMode' parameter to Start-AzPolicyRemediation +* Add Get-AzPolicyMetadata cmdlet for getting policy metadata resources +* Updated Get-AzPolicyState and Get-AzPolicyStateSummary for API version 2019-10-01 + +#### Az.RecoveryServices +* Azure Site Recovery support for removing a replicated disk. +* Azure Backup added support for adding tags while creating a Recovery Services Vault. + +#### Az.Resources +* Make -Scope optional in *-AzPolicyAssignment cmdlets with default to context subscription +* Add examples of creating ADServicePrincipal with password and key credential + +#### Az.Sql +Fix New-AzSqlDatabaseSecondary cmdlet to check for PartnerDatabaseName existence instead of DatabaseName existence. + +#### Az.Storage +* Support set Table/Queue Encryption Keytype in Create Storage Account + - New-AzStorageAccount +* Show RequestId when StorageException don't have ExtendedErrorInformation +* Fix the Example 6 of cmdlet Start-AzStorageBlobCopy + +#### Az.Websites +* Set-AzWebapp and Set-AzWebappSlot supports AlwaysOn, MinTls and FtpsState properties +* Fixing issue where setting HttpsOnly along with changing AppservicePlan at the same time using the single Set-AzWebApp Command, was resetting HttpsOnly to default value + +## 3.3.0 - January 2020 +#### Az.Accounts +* Updated Add-AzEnvironment and Set-AzEnvironment to accept parameters AzureAttestationServiceEndpointResourceId and AzureAttestationServiceEndpointSuffix + +#### Az.Cdn +* Display error response detail in New-AzCdnEndpoint cmdlet + +#### Az.Compute +* Fix Set-AzVMCustomScriptExtension cmdlet for a VM with managed OD disk which does not have OS profile. + +#### Az.ContainerInstance +* Fixed parameter names used by example of New-AzContainerGroup + +#### Az.DataBoxEdge +* Added cmdlet 'Get-AzDataBoxEdgeStorageContainer' + - Get the Edge Storage Container +* Added cmdlet 'New-AzDataBoxEdgeStorageContainer' + - Create new Edge Storage Container +* Added cmdlet 'Remove-AzDataBoxEdgeStorageContainer' + - Remove the Edge Storage Container +* Added cmdlet 'Invoke-AzDataBoxEdgeStorageContainer' + - Invoke action to refresh data on Edge Storage Container +* Added cmdlet 'Get-AzDataBoxEdgeStorageAccount' + - Get the Edge Storage Account +* Added cmdlet 'New-AzDataBoxEdgeStorageAccount' + - Create new Edge Storage Account +* Added cmdlet 'Remove-AzDataBoxEdgeStorageAccount' + - Remove the Edge Storage Account +* Invoke cmdlet 'Invoke-AzDataBoxEdgeShare' + - Invoke action to refresh data on share +* Added cmdlet 'Set-AzDataBoxEdgeStorageAccountCredential' + - Set the az databoxedge storage account credential + +#### Az.DataFactory +* Add AutoUpdateETA, LatestVersion, PushedVersion, TaskQueueId and VersionStatus properties for Get-AzDataFactoryV2IntegrationRuntime cmd +* Update ADF .Net SDK version to 4.6.0 +* Add parameter 'PublicIPs' for 'Set-AzDataFactoryV2IntegrationRuntime' cmd +to enable create Azure-SSIS IR with static public IP addresses. + +#### Az.DevTestLabs +* Remove the broken link in Get-AzDtlAllowedVMSizesPolicy.md + +#### Az.EventHub +* Fix for issue 10634 : Fix the null Object reference for remove eventhubnamespace + +#### Az.HDInsight +* Fix Invoke-AzHDInsightHiveJob.md error. + +#### Az.MachineLearning +* Removed below cmdlets because MachineLearningCompute is not available any longer + - Get-AzMlOpCluster + - Get-AzMlOpClusterKey + - New-AzMlOpCluster + - Remove-AzMlOpCluster + - Set-AzMlOpCluster + - Test-AzMlOpClusterSystemServicesUpdateAvailability + - Update-AzMlOpClusterSystemService + +#### Az.Network +* Upgrade dependency of Microsoft.Azure.Management.Sql from 1.36-preview to 1.37-preview + +#### Az.RecoveryServices +* Azure Site Recovery change support for managed disk vms encrypted at rest with customer managed leys for Azure to Azure provider. +* Azure Site Recovery support to input disk encryption Set Id as optional input at enabling protection for Vmware to Azure. +* Azure Site Recovery support to input disk encryption Set Id as optional input at disk level to enable protection for Vmware to Azure. +* Azure Site Recovery support to update replication protected item with disk encryption set Map for HyperV to Azure. + +#### Az.Resources +* Fix an error in help document of 'Remove-AzTag'. + +#### Az.Sql +* Fix vulnerability assessment set baseline cmdlets functionality to work on master db for azure database and limit it on managed instance system databases. +* Fix an error when creating SQL instance failover group + +#### Az.SqlVirtualMachine +* Add DR as a new valid License type + +#### Az.Storage +* Add breaking change warning message for DefaultAction Value change in a future release + - Update-AzStorageAccountNetworkRuleSet +* Support Get last sync time of Storage account by run get-AzStorageAccount with parameter -IncludeGeoReplicationStats + - Get-AzStorageAccount + +## 3.2.0 - December 2019 + +### General +* Update references in .psd1 to use relative path for all modules + +#### Az.Accounts +* Set correct UserAgent for client-side telemetry for Az 4.0 preview +* Display user friendly error message when context is null in Az 4.0 preview + +#### Az.Batch +* Fix issue #10602, where **New-AzBatchPool** did not properly send 'VirtualMachineConfiguration.ContainerConfiguration' or 'VirtualMachineConfiguration.DataDisks' to the server. + +#### Az.DataFactory +* Update ADF .Net SDK version to 4.5.0 + +#### Az.FrontDoor +* Added WAF managed rules exclusion support +* Add SocketAddr to auto-complete + +#### Az.HealthcareApis +* Exception Handling + +#### Az.KeyVault +* Fixed error accessing value that is potentially not set +* Elliptic Curve Cryptography Certificate Managment + - Added support to specify the Curve for Certificate Policies + +#### Az.Monitor +* Adding optional argument to the Add Diagnostic Settings command. A switch argument that if present indicates that the export to Log Analytics must be to a fixed schema (a.k.a. dedicated, data type) + +#### Az.Network +* Support for IpGroups in AzureFirewall Application,Nat & Network Rules. + +#### Az.RecoveryServices +* Added SoftDelete feature for VM and added tests for softdelete +* Azure Site Recovery support for Azure Disk Encryption One Pass for Azure to Azure. + +#### Az.Resources +* Fix an issue where template deployment fails to read a template parameter if its name conflicts with some built-in parameter name. +* Updated policy cmdlets to use new api version 2019-09-01 that introduces grouping support within policy set definitions. + +#### Az.Sql +* Upgraded storage creation in Vulnerability Assessment auto enablement to StorageV2 + +#### Az.Storage +* Support generate Blob/Constainer Idenity based SAS token with Storage Context based on Oauth authentication + - New-AzStorageContainerSASToken + - New-AzStorageBlobSASToken +* Support revoke Storage Account User Delegation Keys, so all Idenity SAS tokens are revoked + - Revoke-AzStorageAccountUserDelegationKeys +* Upgrade to Microsoft.Azure.Management.Storage 14.2.0, to support new API version 2019-06-01. +* Support Share QuotaGiB more than 5120 in Management plane File Share cmdlets, and add parameter alias 'Quota' to parameter 'QuotaGiB' + - New-AzRmStorageShare + - Update-AzRmStorageShare +* Add parameter alias 'QuotaGiB' to parameter 'Quota' + - Set-AzStorageShareQuota +* Fix the issue that Set-AzStorageContainerAcl can clean up the stored Access Policy + - Set-AzStorageContainerAcl + +## 3.1.0 - November 2019 +### Highlights since the last major release +* Az.DataBoxEdge 1.0.0 released +* Az.SqlVirtualMachine 1.0.0 released + +#### Az.Compute +* VM Reapply feature + - Add Reapply parameter to Set-AzVM cmdlet +* VM Scale Set AutomaticRepairs feature: + - Add EnableAutomaticRepair, AutomaticRepairGracePeriod, and AutomaticRepairMaxInstanceRepairsPercent parameters to the following cmdlets: + New-AzVmssConfig + Update-AzVmss +* Cross tenant gallery image support for New-AzVM +* Add 'Spot' to the argument completer of Priority parameter in New-AzVM, New-AzVMConfig and New-AzVmss cmdlets +* Add DiskIOPSReadWrite and DiskMBpsReadWrite parameters to Add-AzVmssDataDisk cmdlet +* Change SourceImageId parameter of New-AzGalleryImageVersion cmdlet to optional +* Add OSDiskImage and DataDiskImage parameters to New-AzGalleryImageVersion cmdlet +* Add HyperVGeneration parameter to New-AzGalleryImageDefinition cmdlet +* Add SkipExtensionsOnOverprovisionedVMs parameters to New-AzVmss, New-AzVmssConfig and Update-AzVmss cmdlets + +#### Az.DataBoxEdge +* Added cmdlet `Get-AzDataBoxEdgeOrder` + - Get the Order +* Added cmdlet `New-AzDataBoxEdgeOrder` + - Create new Order +* Added cmdlet `Remove-AzDataBoxEdgeOrder` + - Remove the Order +* Change in cmdlet `New-AzDataBoxEdgeShare` + - Now creates Local Share +* Added cmdlet `Set-AzDataBoxEdgeRole` + - Now IotRole can be mapped to Share +* Added cmdlet `Invoke-AzDataBoxEdgeDevice` + - Invoke scan update, download update, install updates on the device +* Added cmdlet `Get-AzDataBoxEdgeTrigger` + - Gets the information about Triggers +* Added cmdlet `New-AzDataBoxEdgeTrigger` + - Create new Triggers +* Added cmdlet `Remove-AzDataBoxEdgeTrigger` + - Remove the Triggers + +#### Az.DataFactory +* Update ADF .Net SDK version to 4.4.0 +* Add parameter 'ExpressCustomSetup' for 'Set-AzDataFactoryV2IntegrationRuntime' cmd to enable setup configurations and 3rd party components without custom setup script. + +#### Az.DataLakeStore +* Update documentation of Get-AzDataLakeStoreDeletedItem and Restore-AzDataLakeStoreDeletedItem + +#### Az.EventHub +* Fix for issue 10301 : Fix the SAS Token date format + +#### Az.FrontDoor +* Add MinimumTlsVersion parameter to Enable-AzFrontDoorCustomDomainHttps and New-AzFrontDoorFrontendEndpointObject +* Add HealthProbeMethod and EnabledState parameters to New-AzFrontDoorHealthProbeSettingObject +* Add new cmdlet to create BackendPoolsSettings objec to pass into creation/update of Front Door + - New-AzFrontDoorBackendPoolsSettingObject + +#### Az.Network +* Change 'Start-AzVirtualNetworkGatewayConnectionPacketCapture.md' and 'Start-AzVirtualnetworkGatewayPacketCapture.md' FilterData option examples. + +#### Az.PrivateDns +* Updated PrivateDns .net sdk to version 1.0.0 + +#### Az.RecoveryServices +* Azure Site Recovery support to select disk type at enabling protection. +* Azure Site Recovery bug fix for recovery plan action edit. +* Azure Backup SQL Restore support to accept filestream DBs. + +#### Az.RedisCache +* Added 'MinimumTlsVersion' parameter in 'New-AzRedisCache' and 'Set-AzRedisCache' cmdlets. Also, added 'MinimumTlsVersion' in the output of 'Get-AzRedisCache' cmdlet. +* Added validation on '-Size' parameter for 'Set-AzRedisCache' and 'New-AzRedisCache' cmdlets + +#### Az.Resources +- Updated policy cmdlets to use new api version 2019-06-01 that has new EnforcementMode property in policy assignment. +- Updated create policy definition help example +- Fix bug Remove-AZADServicePrincipal -ServicePrincipalName, throw null reference when service principal name not found. +- Fix bug New-AZADServicePrincipal, throw null reference when tenant doesn't have any subscription. +- Change New-AzAdServicePrincipal to add credentials only to associated application. + +#### Az.Sql +* Added support for database ReadReplicaCount. +* Fixed Set-AzSqlDatabase when zone redundancy not set + +## 3.0.0 - November 2019 +### General +* Az.PrivateDns 1.0.0 released + +#### Az.Accounts +* Add a deprecation message for 'Resolve-Error' alias. + +#### Az.Advisor +* Added new category 'Operational Excellence' to Get-AzAdvisorRecommendation cmdlet. + +#### Az.Batch +* Renamed `CoreQuota` on `BatchAccountContext` to `DedicatedCoreQuota`. There is also a new `LowPriorityCoreQuota`. + - This impacts **Get-AzBatchAccount**. +* **New-AzBatchTask** `-ResourceFile` parameter now takes a collection of `PSResourceFile` objects, which can be constructed using the new **New-AzBatchResourceFile** cmdlet. +* New **New-AzBatchResourceFile** cmdlet to help create `PSResourceFile` objects. These can be supplied to **New-AzBatchTask** on the `-ResourceFile` parameter. + - This supports two new kinds of resource file in addition to the existing `HttpUrl` way: + - `AutoStorageContainerName` based resource files download an entire auto-storage container to the Batch node. + - `StorageContainerUrl` based resource files download the container specified in the URL to the Batch node. +* Removed `ApplicationPackages` property of `PSApplication` returned by **Get-AzBatchApplication**. + - The specific packages inside of an application now can be retrieved using **Get-AzBatchApplicationPackage**. For example: `Get-AzBatchApplication -AccountName myaccount -ResourceGroupName myresourcegroup -ApplicationId myapplication`. +* Renamed `ApplicationId` to `ApplicationName` on **Get-AzBatchApplicationPackage**, **New-AzBatchApplicationPackage**, **Remove-AzBatchApplicationPackage**, **Get-AzBatchApplication**, **New-AzBatchApplication**, **Remove-AzBatchApplication**, and **Set-AzBatchApplication**. + - `ApplicationId` now is an alias of `ApplicationName`. +* Added new `PSWindowsUserConfiguration` property to `PSUserAccount`. +* Renamed `Version` to `Name` on `PSApplicationPackage`. +* Renamed `BlobSource` to `HttpUrl` on `PSResourceFile`. +* Removed `OSDisk` property from `PSVirtualMachineConfiguration`. +* Removed **Set-AzBatchPoolOSVersion**. This operation is no longer supported. +* Removed `TargetOSVersion` from `PSCloudServiceConfiguration`. +* Renamed `CurrentOSVersion` to `OSVersion` on `PSCloudServiceConfiguration`. +* Removed `DataEgressGiB` and `DataIngressGiB` from `PSPoolUsageMetrics`. +* Removed **Get-AzBatchNodeAgentSku** and replaced it with **Get-AzBatchSupportedImage**. + - **Get-AzBatchSupportedImage** returns the same data as **Get-AzBatchNodeAgentSku** but in a more friendly format. + - New non-verified images are also now returned. Additional information about `Capabilities` and `BatchSupportEndOfLife` for each image is also included. +* Added ability to mount remote file-systems on each node of a pool via the new `MountConfiguration` parameter of **New-AzBatchPool**. +* Now support network security rules blocking network access to a pool based on the source port of the traffic. This is done via the `SourcePortRanges` property on `PSNetworkSecurityGroupRule`. +* When running a container, Batch now supports executing the task in the container working directory or in the Batch task working directory. This is controlled by the `WorkingDirectory` property on `PSTaskContainerSettings`. +* Added ability to specify a collection of public IPs on `PSNetworkConfiguration` via the new `PublicIPs` property. This guarantees nodes in the Pool will have an IP from the list user provided IPs. +* When not specified, the default value of `WaitForSuccess` on `PSSTartTask` is now `$True` (was `$False`). +* When not specified, the default value of `Scope` on `PSAutoUserSpecification` is now `Pool` (was `Task` on Windows and `Pool` on Linux). + +#### Az.Cdn +* Introduced UrlRewriteAction and CacheKeyQueryStringAction to RulesEngine. +* Fixed several bugs like missing 'Selector' Input in New-AzDeliveryRuleCondition cmdlet. + +#### Az.Compute +* Disk Encryption Set feature + - New cmdlets: + New-AzDiskEncryptionSetConfig + New-AzDiskEncryptionSet + Get-AzDiskEncryptionSet + Remove-AzDiskEncryptionSet + - DiskEncryptionSetId parameter is added to the following cmdlets: + Set-AzImageOSDisk + Set-AzVMOSDisk + Set-AzVmssStorageProfile + Add-AzImageDataDisk + New-AzVMDataDisk + Set-AzVMDataDisk + Add-AzVMDataDisk + Add-AzVmssDataDisk + Add-AzVmssVMDataDisk + - DiskEncryptionSetId and EncryptionType parameters are added to the following cmdlets: + New-AzDiskConfig + New-AzSnapshotConfig +* Add PublicIPAddressVersion parameter to New-AzVmssIPConfig +* Move FileUris of custom script extension from public setting to protected setting +* Add ScaleInPolicy to New-AzVmss, New-AzVmssConfig and Update-AzVmss cmdlets +* Breaking changes + - UploadSizeInBytes parameter is used instead of DiskSizeGB for New-AzDiskConfig when CreateOption is Upload + - PublishingProfile.Source.ManagedImage.Id is replaced with StorageProfile.Source.Id in GalleryImageVersion object + +#### Az.DataFactory +* Update ADF .Net SDK version to 4.3.0 + +#### Az.DataLakeStore +* Update ADLS SDK version (https://github.com/Azure/azure-data-lake-store-net/blob/preview-alpha/CHANGELOG.md#version-123-alpha), brings following fixes +* Avoid throwing exception while unable to deserialize the creationtime of the trash or directory entry. +* Expose setting per request timeout in adlsclient +* Fix passing the original syncflag for badoffset recovery +* Fix EnumerateDirectory to retrieve continuation token once response is checked +* Fix Concat Bug + +#### Az.FrontDoor +* Fixed miscellaneous typos across module + +#### Az.HDInsight +* Fixed the bug that customer will get 'Not a valid Base-64 string' error when using Get-AzHDInsightCluster to get the cluster with ADLSGen1 storage. +* Add a parameter named 'ApplicationId' to three cmdlets Add-AzHDInsightClusterIdentity, New-AzHDInsightClusterConfig and New-AzHDInsightCluster so that customer can provide the service principal application id for accessing Azure Data Lake. +* Changed Microsoft.Azure.Management.HDInsight from 2.1.0 to 5.1.0 +* Removed five cmdlets: + - Get-AzHDInsightOMS + - Enable-AzHDInsightOMS + - Disable-AzHDInsightOMS + - Grant-AzHDInsightRdpServicesAccess + - Revoke-AzHDInsightRdpServicesAccess +* Added three cmdlets: + - Get-AzHDInsightMonitoring to replace Get-AzHDInsightOMS. + - Enable-AzHDInsightMonitoring to replace Enable-AzHDInsightOMS. + - Disable-AzHDInsightMonitoring to replace Disable-AzHDInsightOMS. +* Fixed cmdlet Get-AzHDInsightProperties to support get capabilities information from a specific location. +* Removed parameter sets('Spark1', 'Spark2') from Add-AzHDInsightConfigValue. +* Add examples to the help documents of cmdlet Add-AzHDInsightSecurityProfile. +* Changed output type of the following cmdlets: +* - Changed the output type of Get-AzHDInsightProperties from CapabilitiesResponse to AzureHDInsightCapabilities. +* - Changed the output type of Remove-AzHDInsightCluster from ClusterGetResponse to bool. +* - Changed the output type of Set-AzHDInsightGatewaySettings HttpConnectivitySettings to GatewaySettings. +* Added some scenario test cases. +* Remove some alias: 'Add-AzHDInsightConfigValues', 'Get-AzHDInsightProperties'. + +#### Az.IotHub +* Breaking changes: + - The cmdlet 'Add-AzIotHubEventHubConsumerGroup' no longer supports the parameter 'EventHubEndpointName' and no alias was found for the original parameter name. + - The parameter set '__AllParameterSets' for cmdlet 'Add-AzIotHubEventHubConsumerGroup' has been removed. + - The cmdlet 'Get-AzIotHubEventHubConsumerGroup' no longer supports the parameter 'EventHubEndpointName' and no alias was found for the original parameter name. + - The parameter set '__AllParameterSets' for cmdlet 'Get-AzIotHubEventHubConsumerGroup' has been removed. + - The property 'OperationsMonitoringProperties' of type 'Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubProperties' has been removed. + - The property 'OperationsMonitoringProperties' of type 'Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubInputProperties' has been removed. + - The cmdlet 'New-AzIotHubExportDevice' no longer supports the alias 'New-AzIotHubExportDevices'. + - The cmdlet 'New-AzIotHubImportDevice' no longer supports the alias 'New-AzIotHubImportDevices'. + - The cmdlet 'Remove-AzIotHubEventHubConsumerGroup' no longer supports the parameter 'EventHubEndpointName' and no alias was found for the original parameter name. + - The parameter set '__AllParameterSets' for cmdlet 'Remove-AzIotHubEventHubConsumerGroup' has been removed. + - The cmdlet 'Set-AzIotHub' no longer supports the parameter 'OperationsMonitoringProperties' and no alias was found for the original parameter name. + - The parameter set 'UpdateOperationsMonitoringProperties' for cmdlet 'Set-AzIotHub' has been removed. + +#### Az.RecoveryServices +* Azure Site Recovery support to configure networking resources like NSG, public IP and internal load balancers for Azure to Azure. +* Azure Site Recovery Support to write to managed disk for vMWare to Azure. +* Azure Site Recovery Support to NIC reduction for vMWare to Azure. +* Azure Site Recovery Support to accelerated networking for Azure to Azure. +* Azure Site Recovery Support to agent auto update for Azure to Azure. +* Azure Site Recovery Support to Standard SSD for Azure to Azure. +* Azure Site Recovery Support to Azure Disk Encryption two pass for Azure to Azure. +* Azure Site Recovery Support to protect newly added disk for Azure to Azure. +* Added SoftDelete feature for VM and added tests for softdelete + +#### Az.Resources +* Update dependency assembly Microsoft.Extensions.Caching.Memory from 1.1.1 to 2.2 + +#### Az.Network +* Change all cmdlets for PrivateEndpointConnection to support generic service provider. + - Updated cmdlet: + - Approve-AzPrivateEndpointConnection + - Deny-AzPrivateEndpointConnection + - Get-AzPrivateEndpointConnection + - Remove-AzPrivateEndpointConnection + - Set-AzPrivateEndpointConnection +* Add new cmdlet for PrivateLinkResource and it also support generic service provider. + - New cmdlet: + - Get-AzPrivateLinkResource +* Add new fields and parameter for the feature Proxy Protocol V2. + - Add property EnableProxyProtocol in PrivateLinkService + - Add property LinkIdentifier in PrivateEndpointConnection + - Updated New-AzPrivateLinkService to add a new optional parameter EnableProxyProtocol. +* Fix incorrect parameter description in 'New-AzApplicationGatewaySku' reference documentation +* New cmdlets to support the azure firewall policy +* Add support for child resource RouteTables of VirtualHub + - New cmdlets added: + - Add-AzVirtualHubRoute + - Add-AzVirtualHubRouteTable + - Get-AzVirtualHubRouteTable + - Remove-AzVirtualHubRouteTable + - Set-AzVirtualHub +* Add support for new properties Sku of VirtualHub and VirtualWANType of VirtualWan + - Cmdlets updated with optional parameters: + - New-AzVirtualHub : added parameter Sku + - Update-AzVirtualHub : added parameter Sku + - New-AzVirtualWan : added parameter VirtualWANType + - Update-AzVirtualWan : added parameter VirtualWANType +* Add support for EnableInternetSecurity property for HubVnetConnection, VpnConnection and ExpressRouteConnection + - New cmdlets added: + - Update-AzVirtualHubVnetConnection + - Cmdlets updated with optional parameters: + - New-AzVirtualHubVnetConnection : added parameter EnableInternetSecurity + - New-AzVpnConnection : added parameter EnableInternetSecurity + - Update-AzVpnConnection : added parameter EnableInternetSecurity + - New-AzExpressRouteConnection : added parameter EnableInternetSecurity + - Set-AzExpressRouteConnection : added parameter EnableInternetSecurity +* Add support for Configuring TopLevel WebApplicationFirewall Policy + - New cmdlets added: + - New-AzApplicationGatewayFirewallPolicySetting + - New-AzApplicationGatewayFirewallPolicyExclusion + - New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride + - New-AzApplicationGatewayFirewallPolicyManagedRuleOverride + - New-AzApplicationGatewayFirewallPolicyManagedRule + - New-AzApplicationGatewayFirewallPolicyManagedRuleSet + - Cmdlets updated with optional parameters: + - New-AzApplicationGatewayFirewallPolicy : added parameter PolicySetting, ManagedRule +* Added support for Geo-Match operator on CustomRule + - Added GeoMatch to the operator on the FirewallCondition +* Added support for perListener and perSite Firewall policy + - Cmdlets updated with optional parameters: + - New-AzApplicationGatewayHttpListener : added parameter FirewallPolicy, FirewallPolicyId + - New-AzApplicationGatewayPathRuleConfig : added parameter FirewallPolicy, FirewallPolicyId +* Fix required subnet with name AzureBastionSubnet in 'PSBastion' can be case insensitive +* Support for Destination FQDNs in Network Rules and Translated FQDN in NAT Rules for Azure Firewall +* Add support for top level resource RouteTables of IpGroup + - New cmdlets added: + - New-AzIpGroup + - Remove-AzIpGroup + - Get-AzIpGroup + - Set-AzIpGroup + +#### Az.ServiceFabric +* Remove Add-AzServiceFabricApplicationCertificate cmdlet as this scenario is covered by Add-AzVmssSecret. + +#### Az.Sql +* Added support for restore of dropped databases on Managed Instances. +* Deprecated from code old auditing cmdlets. +* Removed deprecated aliases: +* Get-AzSqlDatabaseIndexRecommendations (use Get-AzSqlDatabaseIndexRecommendation instead) +* Get-AzSqlDatabaseRestorePoints (use Get-AzSqlDatabaseRestorePoint instead) +* Remove Get-AzSqlDatabaseSecureConnectionPolicy cmdlet +* Remove aliases for deprecated Vulnerability Assessment Settings cmdlets +* Deprecate Advanced Threat Detection Settings cmdlets +* Adding cmdlets to Disable and enable sensitivity recommendations on columns in a database. + +#### Az.Storage +* Support enable Large File share when create or update Storage account + - New-AzStorageAccount + - Set-AzStorageAccount +* When close/get File handle, skip check the input path is File directory or File, to avoid failure with object in DeletePending status + - Get-AzStorageFileHandle + - Close-AzStorageFileHandle + +## 2.8.0 - October 2019 +### General +* Az.HealthcareApis 1.0.0 release + +#### Az.Accounts +* Update telemetry and url rewriting for generated modules, fix windows unit tests. + +#### Az.ApiManagement +* **Set-AzApiManagementApi** - Added support for Updating Api into ApiVersionSet + - Fix for issue https://github.com/Azure/azure-powershell/issues/10068 + +#### Az.Automation +* Fixed New-AzureAutomationSoftwareUpdateConfiguration cmdlet for Linux reboot setting parameter. + +#### Az.Batch +* **Get-AzBatchNodeAgentSku** is deprecated and will be replaced by **Get-AzBatchSupportImage** in version 2.0.0. + +#### Az.Compute +* Add Priority, EvictionPolicy, and MaxPrice parameters to New-AzVM and New-AzVmss cmdlets +* Fix warning message and help document for Add-AzVMAdditionalUnattendContent and Add-AzVMSshPublicKey cmdlets +* Fix -skipVmBackup exception for Linux VMs with managed disks for Set-AzVMDiskEncryptionExtension. +* Fix bug in update encryption settings in Set-AzVMDiskEncryptionExtension, two pass scenario. + +#### Az.DataFactory +* Adding CRUD commands for ADF V2 data flow: Set-AzDataFactoryV2DataFlow, Remove-AzDataFactoryV2DataFlow, and Get-AzDataFactoryV2DataFlow. +* Adding action commands for ADF V2 data flow debug Session: Start-AzDataFactoryV2DataFlowDebugSession, Get-AzDataFactoryV2DataFlowDebugSession, Add-AzDataFactoryV2DataFlowDebugSessionPackage, Invoke-AzDataFactoryV2DataFlowDebugSessionCommand and Stop-AzDataFactoryV2DataFlowDebugSession. +* Update ADF .Net SDK version to 4.2.0 + +#### Az.DataLakeStore +* Fix account validation so that accounts with '-' can be passed without domain + +#### Az.HealthcareApis +* Updated the powershell version to 1.0.0 +* Updated the SDK version to 1.0.2 +* Update in tests to refer to new SDK version +* Updated the output structure from nested to flattened. + +#### Az.IotHub +* Add new routing source: DigitalTwinChangeEvents +* Minor bug fix: Get-AzIothub not returning subscriptionId + +#### Az.Monitor +* New action group receivers added for action group + -ItsmReceiver + -VoiceReceiver + -ArmRoleReceiver + -AzureFunctionReceiver + -LogicAppReceiver + -AutomationRunbookReceiver + -AzureAppPushReceiver +* Use common alert schema enabled for the receivers. This is not applicable for SMS, Azure App push , ITSM and Voice recievers +* Webhooks now supports Azure active directory authentication . + +#### Az.Network +* Add new cmdlet Get-AzAvailableServiceAlias which can be called to get the aliases that can be used for Service Endpoint Policies. +* Added support for the adding traffic selectors to Virtual Network Gateway Connections + - New cmdlets added: + - New-AzureRmTrafficSelectorPolicy + - Cmdlets updated with optional parameter -TrafficSelectorPolicies + -New-AzVirtualNetworkGatewayConnection + -Set-AzVirtualNetworkGatewayConnection +* Add support for ESP and AH protocols in network security rule configurations + - Updated cmdlets: + - Add-AzNetworkSecurityRuleConfig + - New-AzNetworkSecurityRuleConfig + - Set-AzNetworkSecurityRuleConfig +* Improve handling of exceptions in Cortex cmdlets +* New Generations and SKUs for VirtualNetworkGateways + - Introduce new Generations for VirtualNetworkGateways. + - Introduce new high throughput SKUs for VirtualNetworkGateways. + +#### Az.RedisCache +* Updated 'Set-AzRedisCache' reference documentation to include missing values for '-Size' parameter + +#### Az.Sql +* Add support for setting Active Directory Administrator on Managed Instance + +#### Az.Storage +* Upgrade Storage Client Library to 11.1.0 +* List containers with Management plane API, will list with NextPageLink + - Get-AzRmStorageContainer +* List Storage accounts from subscription, will list with NextPageLink + - Get-AzStorageAccount + +#### Az.StorageSync +* Fix Issue 9810 in Reset-AzStorageSyncServerCertificate. + +#### Az.Websites +* Set-AzWebApp updating ASP of an app was failing + +## 2.7.0 - September 2019 +#### Az.ApiManagement +* Update '-Format' parameter description in 'Set-AzApiManagementPolicy' reference documentation +* Removed references of deprecated cmdlet 'Update-AzApiManagementDeployment' from reference documentation. Use 'Set-AzApiManagement' instead. + +#### Az.Automation +* Fixed example typo in reference documentation for 'Register-AzAutomationDscNode' +* Added clarification on OS restriction to Register-AzAutomationDSCNode +* Fixed Start-AzAutomationRunbook cmdlet Null reference exception for -Wait option. + +#### Az.Compute +* Add UploadSizeInBytes parameter tp New-AzDiskConfig +* Add Incremental parameter to New-AzSnapshotConfig +* Add a low priority virtual machine feature: + - MaxPrice, EvictionPolicy and Priority parameters are added to New-AzVMConfig. + - MaxPrice parameter is added to New-AzVmssConfig, Update-AzVM and Update-AzVmss cmdlets. +* Fix VM reference issue for Get-AzAvailabilitySet cmdlet when it lists all availability sets in the subscription. +* Fix the null exception for Get-AzRemoteDesktopFile. +* Fix VHD Seek method for end-relative position. +* Fix UltraSSD issue for New-AzVM and Update-AzVM. + +#### Az.DataFactory +* Adding 3 new commands for ADF V2 - Add-AzDataFactoryV2TriggerSubscription, Remove-AzDataFactoryV2TriggerSubscription, and Get-AzDataFactoryV2TriggerSubscriptionStatus +* Updated ADF .Net SDK version to 4.1.3 + +#### Az.HDInsight +* Call out breaking changes + +#### Az.IotHub +* Add support to invoke failover for an IotHub to the geo-paired disaster recovery region. +* Add support to manage message enrichment for an IotHub. New cmdlets are: + - Add-AzIotHubMessageEnrichment + - Get-AzIotHubMessageEnrichment + - Remove-AzIotHubMessageEnrichment + - Set-AzIotHubMessageEnrichment + +#### Az.Monitor +* Pointing to the most recent Monitor SDK, i.e. 0.24.1-preview + - Adds non-braking changes to the Metrics cmdlets, i.e. the Unit enumeration supports several new values. These are read-only cmdlets, so there would be no change in the input of the cmdlets. + - The api-version of the **ActionGroups** requests is now **2019-06-01**, before it was **2018-03-01**. The scenario tests have been updated to accommodate for this change. + - The constructors for the classes **EmailReceiver** and **WebhookReceiver** added one new mandatory argument, i.e. a Boolean value called **useCommonAlertSchema**. Currently, the value is fixed to **false** to hide this breaking change from the cmdlets. **NOTE**: this is a temporary change that must be validated by the Alerts team. + - The order of the arguments for the constructor of the class **Source** (related to the **ScheduledQueryRuleSource** class) changed from the previous SDK. This change required two unit tests to the be fixed: they compiled, but failed to pass the tests. + - The order of the arguments for the constructor of the class **AlertingAction** (related to the **ScheduledQueryRuleSource** class) changed from the previous SDK. This change required two unit tests to the be fixed: they compiled, but failed to pass the tests. +* Support Dynamic Threshold criteria for metric alert V2 + - New-AzMetricAlertRuleV2Criteria: now creats dynamic threshold criteria also + - Add-AzMetricAlertRuleV2: now accept dynamic threshold criteria also +* Improvements in Scheduled Query Rule cmdlets (SQR) + - Cmdlets will accept 'Location' paramater in both formats, either the location (e.g. eastus) or the location display name (e.g. East US) + - Illustrated 'Enabled' parameter in help files properly + - Added examples for 'ActionGroup' optional parameter + - Overall improved help files +* Fix bug in determining scope type for 'Set-AzActionRule' + +#### Az.Network +* Fix incorrect example in 'New-AzApplicationGateway' reference documentation +* Add note in 'Get-AzNetworkWatcherPacketCapture' reference documentation about retrieving all properties for a packet capture +* Fixed example in 'Test-AzNetworkWatcherIPFlow' reference documentation to correctly enumerate NICs +* Improved cloud exception parsing to display additional details if they are present +* Improved cloud exception parsing to handle additional type of SDK exception +* Fixed incorrect mapping of Security Rule models +* Added properties to network interface for private ip feature + - Added property 'PrivateEndpoint' as type of PSResourceId to PSNetworkInterface + - Added property 'PrivateLinkConnectionProperties' as type of PSIpConfigurationConnectivityInformation to PSNetworkInterfaceIPConfiguration + - Added new model class PSIpConfigurationConnectivityInformation +* Added new ApplicationRuleProtocolType 'mssql' for Azure Firewall resource +* MultiLink support in Virtual WAN + - New cmdlets + - New-AzVpnSiteLink + - New-AzVpnSiteLinkConnection + - Updated cmdlet: + - New-VpnSite + - Update-VpnSite + - New-VpnConnection + - Update-VpnConnection +* Fixed documents for some PowerShell examples to use Az cmdlets instead of AzureRM cmdlets + +#### Az.RecoveryServices +* Update AzureVMpolicy Object with ProtectedItemsCount Attribute +* Added Tests for VM policy and Original Storage Account Restore + +#### Az.Resources +* Fix bug where New-AzRoleAssignment could not be called without parameter Scope. + +#### Az.ServiceFabric +* Fixed typo in example for 'Update-AzServiceFabricReliability' reference documentation +* Adding new cmdlets to manage appliaction and services: + - New-AzServiceFabricApplication + - New-AzServiceFabricApplicationType + - New-AzServiceFabricApplicationTypeVersion + - New-AzServiceFabricService + - Update-AzServiceFabricApplication + - Get-AzServiceFabricApplication + - Get-AzServiceFabricApplicationType + - Get-AzServiceFabricApplicationTypeVersion + - Get-AzServiceFabricService + - Remove-AzServiceFabricApplication + - Remove-AzServiceFabricApplicationType + - Remove-AzServiceFabricApplicationTypeVersion + - Remove-AzServiceFabricServic +* Upgraded Service Fabric SDK to version 1.2.0 which uses service fabric resource provider api-version 2019-03-01. + +#### Az.SignalR +* Add Update, Restart, CheckNameAvailability, GetUsage Cmdlets + +#### Az.Sql +* Update example in reference documentation for 'Get-AzSqlElasticPool' +* Added vCore example to creating an elastic pool (New-AzSqlElasticPool). +* Remove the validation of EmailAddresses and the check that EmailAdmins is not false in case EmailAddresses is empty in Set-AzSqlServerAdvancedThreatProtectionPolicy and Set-AzSqlDatabaseAdvancedThreatProtectionPolicy +* Enabled removal of server/database auditing settings when multiple diagnostic settings that enable audit category exist. +* Fix email addresses validation in multiple Sql Vulnerability Assessment cmdlets (Update-AzSqlDatabaseVulnerabilityAssessmentSetting, Update-AzSqlServerVulnerabilityAssessmentSetting, Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting and Update-AzSqlInstanceVulnerabilityAssessmentSetting). + +#### Az.Storage +* Updated example in reference documentation for 'Get-AzStorageAccountKey' +* In upload/Downalod Azure File,support perserve the source File SMB properties (File Attributtes, File Creation Time, File Last Write Time) in the destination file + - Set-AzStorageFileContent + - Get-AzStorageFileContent +* Fix Upload block blob with properties/metadate fail on container enabled ImmutabilityPolicy. + - Set-AzStorageBlobContent +* Support manage Azure File shares with Management plane API + - New-AzRmStorageShare + - Get-AzRmStorageShare + - Update-AzRmStorageShare + - Remove-AzRmStorageShare + +#### Az.Websites +* Fixing issue where webapp Tags were getting deleted when migrating App to new ASPwhere webapp Tags were getting deleted when migrating App to new ASP +* Fixing the Publish-AzureWebapp to work across Linux and windows +* Update example in 'Get-AzWebAppPublishingProfile' reference documentation + +## 2.6.0 - August 2019 +#### General +* Fixed miscellaneous typos across numerous modules + +#### Az.Accounts +* Added support for user-assigned MSI in Azure Functions authentication (#9479) + +#### Az.Aks +* Fixed issue with output for 'Get-AzAks' ([#9847](https://github.com/Azure/azure-powershell/issues/9847)) + +#### Az.ApiManagement +* Fixed issue with whitespace in `productId`, `apiId`, `groupId`, `userId` ([#9351](https://github.com/Azure/azure-powershell/issues/9351)) +* **Get-AzApiManagementProduct** - Added support for querying products using API ([#9482](https://github.com/Azure/azure-powershell/issues/9482)) +* **New-AzApiManagementApiRevision** - Fixed issue where ApiRevisionDescription was not set when creating new API revision ([#9752](https://github.com/Azure/azure-powershell/issues/9752)) +* Fixed typo in model `PsApiManagementOAuth2AuthrozationServer` to `PsApiManagementOAuth2AuthorizationServer` + +#### Az.Batch +* Fixed typos in help message and documentation + +#### Az.Cdn +* Fixed a typo in CDN module conversion helper + +#### Az.Compute +* Added VmssId to **New-AzVMConfig** cmdlet +* Added `TerminateScheduledEvents` and `TerminateScheduledEventNotBeforeTimeoutInMinutes` parameters to **New-AzVmssConfig** and **Update-AzVmss** +* Added `HyperVGeneration` property to VM image object +* Added Host and HostGroup features + - New cmdlets: + - **New-AzHostGroup** + - **New-AzHost** + - **Get-AzHostGroup** + - **Get-AzHost** + - **Remove-AzHostGroup** + - **Remove-AzHost** + - Added `HostId` parameter to **New-AzVMConfig** and **New-AzVM** +* Updated example in **Invoke-AzVMRunCommand** documentation to use correct parameter name +* Updated `-VolumeType` description in **Set-AzVMDiskEncryptionExtension** and **Set-AzVmssDiskEncryptionExtension** reference documentation + +#### Az.DataFactory +* Fixed typos in **New-AzDataFactoryEncryptValue** documentation +* Updated ADF .Net SDK version to 4.1.2 +* Added parameters to **Set-AzureRmDataFactoryV2IntegrationRuntime** to enable Self-Hosted Integration Runtime as a proxy for SSIS Integration Runtime: + - `DataProxyIntegrationRuntimeName` + - `DataProxyStagingLinkedServiceName` + - `DataProxyStagingPath` +* Updated **PSTriggerRun** to show the triggered pipelines, message and properties, and **PSActivityRun** to show the activity type + +#### Az.DataLakeStore +* Fixed issue where **Get-DataLakeStoreDeletedItem** would hang on errors and remote exceptions + +#### Az.EventHub +* Fixed typo `VirtualNteworkRule` in Set-AzEventHubNetworkRuleSet ([#9658](https://github.com/azure/azure-powershell/issues/9658)) +* Fixed issue where Set-AzEventHubNamespace used PATCH instead of PUT ([#9558](https://github.com/azure/azure-powershell/issues/9558)) +* Added `EnableKafka` parameter to **Set-AzEventHubNamespace** cmdlet +* Fixed issue with creating rules with `Listen` rights ([#9786](https://github.com/azure/azure-powershell/issues/9786)) + +#### Az.MarketplaceOrdering +* Fixed documentation typos + +#### Az.Monitor +* Fixed incorrect parameter name in help documentation + +#### Az.Network +* Updated **New-AzPrivateLinkServiceIpConfig**: + - Deprecated the parameter `PublicIpAddress` since this is never used in the server side. + - Added optional parameter `Primary` that indicates if the current IP configuration is the primary one +* Improved handling of request error exception from SDK +* Fixed validation logic for Ipv6 IP Prefix to check for correct IPv6 prefix length +* Added parameter set to get by subnet resource id to **Get-AzVirtualNetworkSubnetConfig** +* Updated description of **Location** parameter for **AzNetworkServiceTag** + +#### Az.OperationalInsights +* Updated documentation for **New-AzOperationalInsightsLinuxSyslogDataSource**: + - Added example + - Updated description for `-Name` parameter +* Added an example for **New-AzOperationalInsightsWindowsEventDataSource** +* Changed the description of the `-Name` parameter for **New-AzOperationalInsightsWindowsEventDataSource** + +#### Az.RecoveryServices +* Updated documentation for **Get-AzRecoveryServicesBackupJobDetail** + +#### Az.Resources +* Added support for new API version 2019-05-10 for Microsoft.Resource + - Add support for 'copy.count = 0' for variables, resources and properties + - Resources with 'condition = false' or 'copy.count = 0' will be deleted in complete mode +* Added an example of assigning policy at the subscription level + +#### Az.ServiceBus +* Fixed typo `VirtualNetworkRule` parameter in **Set-AzServiceBusNetworkRuleSet** Fix for issue #9658 : Typo +* Fixed issue with creating `Listen`-only rules ([#9786](https://github.com/azure/azure-powershell/issues/9786)) +* Added new command **Test-AzServiceBusNameAvailability** to check the name availability for queue and topic + +#### Az.ServiceFabric +* Fixed NullReferenceException when a resource group has a VMSS not related to the service fabric cluster ([#8681](https://github.com/Azure/azure-powershell/issues/8681)) +* Fixed bug where cmdlets failed if virtualNetwork was in a different resource group than the cluster ([#8407](https://github.com/Azure/azure-powershell/issues/8407)) +* Deprecated **Add-AzServiceFabricApplicationCertificate** cmdlet + +#### Az.Sql +* Updated documentation for old Auditing cmdlets + +#### Az.Storage +* Updated help for **Close-AzStorageFileHandle** and **Get-AzStorageFileHandle**, added more scenarios to cmdlet examples and updated parameter descriptions +* Added support for `StandardBlobTier` in blob uploads and copies +* Added support for `Rehydrate` priority in blob copy + +#### Az.Websites +* Added clarification around `-AppSettings` parameter for **Set-AzWebApp** and **Set-AzWebAppSlot** + +## 2.5.0 - July 2019 +#### Az.Accounts +* Update common code to use latest version of ClientRuntime + +#### Az.ApplicationInsights +* Fix example typo in 'Remove-AzApplicationInsightsApiKey' documentation + +#### Az.Automation +* Fix typo in resource string + +#### Az.CognitiveServices +* Added NetworkRuleSet support. + +#### Az.Compute +* Add missing properties (ComputerName, OsName, OsVersion and HyperVGeneration) of VM instance view object. + +#### Az.ContainerRegistry +* Fix typo in Remove-AzContainerRegistryReplication for Replication parameter + - More information here https://github.com/Azure/azure-powershell/issues/9633 + +#### Az.DataFactory +* Updated ADF .Net SDK version to 4.1.0 +* Fix typo in documentation for 'Get-AzDataFactoryV2PipelineRun' + +#### Az.EventHub +* Added new cmmdlet added for generating SAS token : New-AzEventHubAuthorizationRuleSASToken +* added verification and error message for authorizationrules rights if only 'Manage' is assigned + +#### Az.KeyVault +* Added support to specify the KeySize for Certificate Policies + +#### Az.LogicApp +* Fix for Get-AzIntegrationAccountMap to list all map types + - Added new MapType parameter for filtering + +#### Az.ManagedServices +* Added support for api version 2019-06-01 (GA) + +#### Az.Network +* Add support for private endpoint and private link service + - New cmdlets + - Set-AzPrivateEndpoint + - Set-AzPrivateLinkService + - Approve-AzPrivateEndpointConnection + - Deny-AzPrivateEndpointConnection + - Get-AzPrivateEndpointConnection + - Remove-AzPrivateEndpointConnection + - Test-AzPrivateLinkServiceVisibility + - Get-AzAutoApprovedPrivateLinkService +* Updated below commands for feature: PrivateEndpointNetworkPolicies/PrivateLinkServiceNetworkPolicies flag on Subnet in Virtualnetwork + - Updated New-AzVirtualNetworkSubnetConfig/Set-AzVirtualNetworkSubnetConfig/Add-AzVirtualNetworkSubnetConfig + - Added optional parameter -PrivateEndpointNetworkPoliciesFlag to indicate that enable or disable apply network policies on pivate endpoint in this subnet. + - Added optional parameter -PrivateLinkServiceNetworkPoliciesFlag to indicate that enable or disable apply network policies on private link service in this subnet. +* AzPrivateLinkService's cmdlet parameter 'ServiceName' was renamed to 'Name' with an alias 'ServiceName' for backward compatibility +* Enable ICMP protocol for network security rule configurations + - Updated cmdlets + - Add-AzNetworkSecurityRuleConfig + - New-AzNetworkSecurityRuleConfig + - Set-AzNetworkSecurityRuleConfig +* Add ConnectionProtocolType (Ikev1/Ikev2) as a configurable parameter for New-AzVirtualNetworkGatewayConnection +* Add PrivateIpAddressVersion in LoadBalancerFrontendIpConfiguration + - Updated cmdlet: + - New-AzLoadBalancerFrontendIpConfig + - Add-AzLoadBalancerFrontendIpConfig + - Set-AzLoadBalancerFrontendIpConfig +* Application Gateway New-AzApplicationGatewayProbeConfig command update for supporting custom port in Probe + - Updated New-AzApplicationGatewayProbeConfig: Added optional parameter Port which is used for probing backend server. This parameter is applicable for Standard_V2 and WAF_V2 SKU. + +#### Az.OperationalInsights +* Updated default version for saved searches to be 1. +* Fixed custom log null regex handling + +#### Az.RecoveryServices +* Update 'Get-AzRecoveryServicesBackupJob.md' +* Update 'Get-AzRecoveryServicesBackupContainer.md' +* Update 'Get-AzRecoveryServicesVault.md' +* Update 'Wait-AzRecoveryServicesBackupJob.md' +* Update 'Set-AzRecoveryServicesVaultContext.md' +* Update 'Get-AzRecoveryServicesBackupItem.md' +* Update 'Get-AzRecoveryServicesBackupRecoveryPoint.md' +* Update 'Restore-AzRecoveryServicesBackupItem.md' +* Updated service call for Unregistering container for Azure File Share +* Update 'Set-AzRecoveryServicesAsrAlertSetting.md' + +#### Az.Resources +- Remove missing cmdlet referenced in 'New-AzResourceGroupDeployment' documentation +- Updated policy cmdlets to use new api version 2019-01-01 + +#### Az.ServiceBus +* Added new cmmdlet added for generating SAS token : New-AzServiceBusAuthorizationRuleSASToken +* added verification and error message for authorizationrules rights if only 'Manage' is assigned + +#### Az.Sql +* Fix missing examples for Set-AzSqlDatabaseSecondary cmdlet +* Fix set Vulnerability Assessment recurring scans without providing any email addresses +* Fix a small typo in a warining message. + +#### Az.Storage +* Update example in reference documentation for 'Get-AzStorageAccount' to use correct parameter name + +#### Az.StorageSync +* Adding Invoke-AzStorageSyncChangeDetection cmdlet. +* Fix Issue 9551 for honoring TierFilesOlderThanDays + +#### Az.Websites +* Fixing a bug where some SiteConfig properties were not returned by Get-AzWebApp and Set-AzWebApp +* Adds a new Location parameter to Get-AzDeletedWebApp and Restore-AzDeletedWebApp +* Fixes a bug with cloning web app slots using New-AzWebApp -IncludeSourceWebAppSlots + +## 2.4.0 - July 2019 +#### Az.Accounts +* Add support for profile cmdlets +* Add support for environments and data planes in generated cmdlets +* Fix bug where incorrect endpoint was being used in some cases for data plane cmdlets in Windows PowerShell + +#### Az.Advisor +* GA release of `Az.Advisor` +* This module is now included as a part of the roll-up `Az` module + +#### Az.ApiManagement +* Fix for issue https://github.com/Azure/azure-powershell/issues/8671 + - **Get-AzApiManagementSubscription** + - Added support for querying subscriptions by User and Product + - Added support for querying using Scope '/', '/apis', '/apis/echo-api' +* Fix for issue https://github.com/Azure/azure-powershell/issues/9307 and https://github.com/Azure/azure-powershell/issues/8432 + - **Import-AzApiManagementApi** + - Added support for specifiying 'ApiVersion' and 'ApiVersionSetId' when importing Apis + +#### Az.Automation +* Fixed Set-AzAutomationConnectionFieldValue cmdlet bug to handle string value. + +#### Az.Compute +* Add HyperVGeneration parameter to New-AzImageConfig + +#### Az.DataFactory +* Updating the output of get activity runs, get pipeline runs, and get trigger runs ADF cmdlets to support Select-Object pipe. + +#### Az.EventGrid +* Fix typo in 'New-AzEventGridSubscription' documentation + +#### Az.IotHub +* Add support to regenerate authorization policy keys. + +#### Az.Network +* Added 'RoutingPreference' to public ip tags +* Improve examples for 'Get-AzNetworkServiceTag' reference documentation + +#### Az.PolicyInsights +* Fix null reference issue in Get-AzPolicyState + - More information here: https://github.com/Azure/azure-powershell/issues/9446 + +#### Az.OperationalInsights +* Fixed CustomLog datasource model returned in Get-AzOperationalInsightsDataSource + +#### Az.RecoveryServices +* Fix for get-policy command for IaaSVMs + +#### Az.Resources + - Fix help text for `Get-AzPolicyState -Top` parameter + - Add client-side paging support for `Get-AzPolicyAlias` + - Add new parameters for `Set-AzPolicyAssignment`, `-PolicyParameters` and `-PolicyParametersObject` + - Handful of doc and example updates for Policy cmdlets + +#### Az.ServiceBus +* Fix for issue #4938 - New-AzServiceBusQueue returns BadRequest when setting MaxSizeInMegabytes + +#### Az.Sql +* Add Instance Failover Group cmdlets from preview release to public release +* Support Azure SQL Server\Database Auditing with new cmdlets. + - Set-AzSqlServerAudit + - Get-AzSqlServerAudit + - Remove-AzSqlServerAudit + - Set-AzSqlDatabaseAudit + - Get-AzSqlDatabaseAudit + - Remove-AzSqlDatabaseAudit +* Remove email constraints from Vulnerability Assessment settings + +#### Az.Storage +* Change 2 parameters '-IndexDocument' and '-ErrorDocument404Path' from required to optional in cmdlet: + - Enable-AzStorageStaticWebsite +* Update help of Get-AzStorageBlobContent by add an example +* Show more error information when cmdlet failed with StorageException +* Support create or update Storage account with Azure Files AAD DS Authentication + - New-AzStorageAccount + - Set-AzStorageAccount +* Support list or close file handles of a file share, file directory or a file + - Get-AzStorageFileHandle + - Close-AzStorageFileHandle + +#### Az.StorageSync +* This module is now included as a part of the roll-up `Az` module + +## 2.3.2 - June 2019 +#### Az.Accounts +* Fix bug with incorrect URL being used in some cases for Functions calls + - More information here: https://github.com/Azure/azure-powershell/issues/8983 +* Fix Issue with aliases from AzureRM to Az cmdlets + - Set-AzureRmVMBootDiagnostics -> Set-AzVMBootDiagnostic + - Export-AzureRMLogAnalyticThrottledRequests -> Export-AzLogAnalyticThrottledRequest + +#### Az.Compute +* New-AzVm and New-AzVmss simple parameter sets now accept the 'ProximityPlacementGroup' parameter. +* Fix typo in 'New-AzVM' reference documentation + +#### Az.Dns +* Fixed a typo in 'Set-AzDnsZone' help examples. + +#### Az.EventGrid +* Updated to use the 2019-06-01 API version. +* New cmdlets: + - New-AzEventGridDomain + - Creates a new Azure Event Grid Domain. + - Get-AzEventGridDomain + - Gets the details of an Event Grid Domain, or gets a list of all Event Grid Domains in the current Azure subscription. + - Remove-AzEventGridDomain + - Removes an Azure Event Grid Domain. + - New-AzEventGridDomainKey + - Regenerates the shared access key for an Azure Event Grid Domain. + - Get-AzEventGridDomainKey + - Gets the shared access keys used to publish events to an Event Grid Domain. + - New-AzEventGridDomainTopic: + - Creates a new Azure Event Grid Domain Topic. + - Get-AzEventGridDomainTopic + - Gets the details of an Event Grid Domain Topic, or gets a list of all Event Grid Domain Topics under specific Event Grid Domain in the current Azure + - Remove-AzEventGridDomainTopic: + - Removes an existing Azure Event Grid Domain Topic. +* Updated cmdlets: + - New-AzEventGridSubscription/Update-AzEventGridSubscription: + - Add new mandatory parameters to support piping for the new Event Grid Domain and Event Grid Domain Topic to allow creating new event subscription under these resources. + - Add new mandatory parameters for specifying the new Event Grid Domain name and/or Event Grid Domain Topic name to allow creating new event subscription under these resources. + - Add new Parameter sets for domains and domain topics to allow reusing existing parameters (e.g., EndPointType, SubjectBeginsWith, etc). + - Add new optional parameters for specifying: + - Event subscription expiration date, + - Advanced filtering parameters. + - Add new enum for servicebusqueue as destination. + - Disallow usage of 'All' in -IncludedEventType option and replace it with + - Get-AzEventGridTopic, Get-AzEventGridDomain, Get-AzEventGridDomainTopic, Get-AzEventGridSubscription: + - Add new optional parameters (Top, ODataQuery and NextLink) to support results pagination and filtering. + - Remove-AzEventGridSubscription + - Add new mandatory parameters to support piping for Event Grid Domain and Event Grid Domain Topic to allow removing existing event subscription under these resources. + - Add new mandatory parameters for specifying the Event Grid Domain name and/or Event Grid Domain Topic name to allow removing existing event subscription under these resources. + +#### Az.FrontDoor +* New-AzFrontDoorWafMatchConditionObject + - Add transforms support and new operator auto-complete value (RegEx) +* New-AzFrontDoorWafManagedRuleObject + - Add new auto-complete values + +#### Az.Network +* Add support for Virtual Network Gateway Resource + - New cmdlets + - Get-AzVirtualNetworkGatewayVpnClientConnectionHealth +* Add AvailablePrivateEndpointType + - New cmdlets + - Get-AzAvailablePrivateEndpointType +* Add PrivatePrivateLinkService + - New cmdlets + - Get-AzPrivateLinkService + - New-AzPrivateLinkService + - Remove-AzPrivateLinkService + - New-AzPrivateLinkServiceIpConfig + - Set-AzPrivateEndpointConnection +* Add PrivateEndpoint + - New cmdlets + - Get-AzPrivateEndpoint + - New-AzPrivateEndpoint + - Remove-AzPrivateEndpoint + - New-AzPrivateLinkServiceConnection +* Updated below commands for feature: UseLocalAzureIpAddress flag on VpnConnection + - Updated New-AzVpnConnection: Added optional parameter -UseLocalAzureIpAddress to indicate that local azure ip address should be used as source address while initiating connection. + - Updated Set-AzVpnConnection: Added optional parameter -UseLocalAzureIpAddress to indicate that local azure ip address should be used as source address while initiating connection. +* Added readonly field PeeredConnections in ExpressRoute peering. +* Added readonly field GlobalReachEnabled in ExpressRoute. +* Added breaking change attribute to call out deprecation of AllowGlobalReach field in ExpressRouteCircuit model +* Fixed Issue 8756 Error using TargetListenerID with AzApplicationGatewayRedirectConfiguration cmdlets +* Fixed bug in New-AzApplicationGatewayPathRuleConfig that prevented the rewrite ruleset from being set. +* Fixed displaying of VirtualNetworkTaps in NetworkInterfaceIpConfiguration +* Fixed Cortex Get cmdlets for list all part +* Fixed VirtualHub reference creation for ExpressRouteGateways, VpnGateway +* Added support for Availability Zones in AzureFirewall and NatGateway +* Added cmdlet Get-AzNetworkServiceTag +* Add support for multiple public IP addresses for Azure Firewall + - Updated New-AzFirewall cmdlet: + - Added parameter -PublicIpAddress which accepts one or more Public IP Address objects + - Added parameter -VirtualNetwork which accepts a Virtual Network object + - Added methods AddPublicIpAddress and RemovePublicIpAddress on firewall object - these accept a Public IP Address object as input + - Deprecated parameters -PublicIpName and -VirtualNetworkName +* Updated below commands for feature: Set VpnClient AAD authentication options to Virtual network gateway resource. + - Updated New-AzVirtualNetworkGateway: Added optional parameters AadTenantUri,AadAudienceId,AadIssuerUri to set VpnClient AAD authentication options on Gateway. + - Updated Set-AzVirtualNetworkGateway: Added optional parameter AadTenantUri,AadAudienceId,AadIssuerUri to set VpnClient AAD authentication options on Gateway. + - Updated Set-AzVirtualNetworkGateway: Added optional switch parameter RemoveAadAuthentication to remove VpnClient AAD authentication options from Gateway. + +#### Az.OperationalInsights +* Enable **pergb2018** pricing tier in 'New-AzOperationalInsightsWorkspace' command + +#### Az.Resources +* Support for additional Template Export options + - Add '-SkipResourceNameParameterization' parameter to Export-AzResourceGroup + - Add '-SkipAllParameterization' parameter to Export-AzResourceGroup + - Add '-Resource' parameter to Export-AzResourceGroup for exported resource filtering + +#### Az.ServiceFabric +* Fix add certificate ByExistingKeyVault getting the wrong thumbprint in some cases + +#### Az.Sql +* Fix Advanced Threat Protection storage endpoint suffix +* Fix Advanced Data Security enable overrides Advanced Threat Protection policy +* New Cmdlets for Management.Sql to allow customers to add TDE keys and set TDE protector for managed instances + - Add-AzSqlInstanceKeyVaultKey + - Get-AzSqlInstanceKeyVaultKey + - Remove-AzSqlInstanceKeyVaultKey + - Get-AzSqlInstanceTransparentDataEncryptionProtector + - Set-AzSqlInstanceTransparentDataEncryptionProtector + +#### Az.Storage +* Support Kind FileStorage and SkuName Premium_ZRS when create Storage account + - New-AzStorageAccount +* Clarified description of blob immutability cmdlet + - Remove-AzRmStorageContainerImmutabilityPolicy + +#### Az.Websites +* Optimizes Get-AzWebAppCertificate to filter by resource group on the server instead of the client +* Adds -UseDisasterRecovery switch parameter to Get-AzWebAppSnapshot + +## 2.2.0 - June 2019 +#### Az.Cdn +* Updated cmdlets to support rulesEngine feature based on API version 2019-04-15. + +#### Az.Compute +* Added `NoWait` parameter that starts the operation and returns immediately, before the operation is completed. + - Updated cmdlets: + Export-AzLogAnalyticRequestRateByInterval + Export-AzLogAnalyticThrottledRequest + Remove-AzVM + Remove-AzVMAccessExtension + Remove-AzVMAEMExtension + Remove-AzVMChefExtension + Remove-AzVMCustomScriptExtension + Remove-AzVMDiagnosticsExtension + Remove-AzVMDiskEncryptionExtension + Remove-AzVMDscExtension + Remove-AzVMSqlServerExtension + Restart-AzVM + Set-AzVM + Set-AzVMAccessExtension + Set-AzVMADDomainExtension + Set-AzVMAEMExtension + Set-AzVMBginfoExtension + Set-AzVMChefExtension + Set-AzVMCustomScriptExtension + Set-AzVMDiagnosticsExtension + Set-AzVMDscExtension + Set-AzVMExtension + Start-AzVM + Stop-AzVM + Update-AzVM + +#### Az.EventHub +* Fix for #9231 - Get-AzEventHubNamespace does not return tags +* Fix for #9230 - Get-AzEventHubNamespace returns ResourceGroup instead of ResourceGroupName + +#### Az.Network +* Update ResourceId and InputObject for Nat Gateway + - Add alias for ResourceId and InputObject + +#### Az.PolicyInsights +* Fix Null reference issue in Get-AzPolicyEvent + +#### Az.RecoveryServices +* IaaSVM policy minimum retention in days changed to 7 from 1 + +#### Az.ServiceBus +* Fix for issue #9182 - Get-AzServiceBusNamespace returns ResourceGroup instead of ResourceGroupName + +#### Az.ServiceFabric +* Fix typo in error message for 'Update-AzServiceFabricReliability' +* Fix missing character in Service Fabric cmdlines + +#### Az.Sql +* Add DnsZonePartner Parameter for New-AzureSqlInstance cmdlet to support AutoDr for Managed Instance. +* Deprecating Get-AzSqlDatabaseSecureConnectionPolicy cmdlet +* Rename Threat Detection cmdlets to Advanced Threat Protection +* New-AzSqlInstance -StorageSizeInGB and -LicenseType parameters are now optional. + +#### Az.Websites +* fixes the issue where using Set-AzWebApp and Set-AzWebAppSlot with -WebApp property was removing the tags + +## 2.1.0 - May 2019 +#### Az.ApiManagement +* Created new Cmdlets for managing diagnostics at the global and API Scope + - **Get-AzApiManagementDiagnostic** - Get the diagnostics configured a global or api Scope + - **New-AzApiManagementDiagnostic** - Create new diagnostics at the global scope or api Scope + - **New-AzApiManagementHttpMessageDiagnostic** - Create diagnostic setting for which Headers to log and the size of Body Bytes + - **New-AzApiManagementPipelineDiagnosticSetting** - Create Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. + - **New-AzApiManagementSamplingSetting** - Create Sampling Setting for the requests/response for a diagnostic + - **Remove-AzApiManagementDiagnostic** - Remove a diagnostic entity at global or api scope + - **Set-AzApiManagementDiagnostic** - Update a diagnostic Entity at global or api scope +* Created new Cmdlets for managing Cache in ApiManagement service + - **Get-AzApiManagementCache** - Get the details of the Cache specified by identifier or all caches + - **New-AzApiManagementCache** - Create a new 'default' Cache or Cache in a particular azure 'region' + - **Remove-AzApiManagementCache** - Remove a cache + - **Update-AzApiManagementCache** - Update a cache +* Created new Cmdlets for managing API Schema + - **New-AzApiManagementSchema** - Create a new Schema for an API + - **Get-AzApiManagementSchema** - Get the schemas configured in the API + - **Remove-AzApiManagementSchema** - Remove the schema configured in the API + - **Set-AzApiManagementSchema** - Update the schema configured in the API +* Created new Cmdlet for generating a User Token. + - **New-AzApiManagementUserToken** - Generate a new User Token valid for 8 hours by default.Token for the 'GIT' user can be generated using this cmdlet./ +* Created a new cmdlet to retrieving the Network Status + - **Get-AzApiManagementNetworkStatus** - Get the Network status connectivity of resources on which API Management service depends on. This is useful when deploying ApiManagement service into a Virtual Network and validing whether any of the dependencies are broken. +* Updated cmdlet **New-AzApiManagement** to manage ApiManagement service + - Added support for the new 'Consumption' SKU + - Added support to turn the 'EnableClientCertificate' flag on for 'Consumption' SKU + - The new cmdlet **New-AzApiManagementSslSetting** allows configuring 'TLS/SSL' setting on the 'Backend' and 'Frontend'. This can also be used to configure 'Ciphers' like '3DES' and 'ServerProtocols' like 'Http2' on the 'Frontend' of an ApiManagement service. + - Added support for configuring the 'DeveloperPortal' hostname on ApiManagement service. +* Updated cmdlets **Get-AzApiManagementSsoToken** to take 'PsApiManagement' object as input +* Updated the cmdlet to display Error Messages inline + - `PS D:\github\azure-powershell> Set-AzApiManagementPolicy -Context -PolicyFilePath C:\wrongpolicy.xml -ApiId httpbin` + - `Set-AzApiManagementPolicy :` + - `Error Code: ValidationError` + - `Error Message: One or more fields contain incorrect values:` + - `Error Details: [Code=ValidationError, Message=Error in element 'log-to-eventhub' on line 3, column 10: Logger not found, Target=log-to-eventhub]` +* Updated cmdlet **Export-AzApiManagementApi** to export APIs in 'OpenApi 3.0' format +* Updated cmdlet **Import-AzApiManagementApi** + - To import Api from 'OpenApi 3.0' document specification + - To override the 'PsApiManagementSchema' property specified in any ('Swagger', 'Wadl', 'Wsdl', 'OpenApi') document. + - To override the 'ServiceUrl' property specified in any document. +* Updated cmdlet **Get-AzApiManagementPolicy** to return policy in Non-Xml escaped 'format' using 'rawxml' +* Updated cmdlet **Set-AzApiManagementPolicy** to accept policy in Non-Xml escaped 'format' using 'rawxml' and Xml escaped using 'xml' +* Updated cmdlet **New-AzApiManagementApi** + - To configure API with 'OpenId' authorization server. + - To create an API in an 'ApiVersionSet' + - To clone an API using 'SourceApiId' and 'SourceApiRevision'. + - Ability to configure 'SubscriptionRequired' at the Api scope. +* Updated cmdlet **Set-AzApiManagementApi** + - To configure API with 'OpenId' authorization server. + - To updated an API into an 'ApiVersionSet' + - Ability to configure 'SubscriptionRequired' at the Api scope. +* Updated cmdlet **New-AzApiManagementRevision** + - To clone (copy tags, products, operations and policies) an existing revision using 'SourceApiRevision'. The new Revision assumes the 'ApiId' of the parent. + - To provide an 'ApiRevisionDescription' + - To override the 'ServiceUrl' when cloning an API. +* Updated cmdlet **New-AzApiManagementIdentityProvider** + - To configure 'AAD' or 'AADB2C' with an 'Authority' + - To setup 'SignupPolicy', 'SigninPolicy', 'ProfileEditingPolicy' and 'PasswordResetPolicy' +* Updated cmdlet **New-AzApiManagementSubscription** + - To account for the new SubscriptonModel using 'Scope' and 'UserId' + - To account for the old subscription model using 'ProductId' and 'UserId' + - Add support to enable 'AllowTracing' at the subscription level. +* Updated cmdlet **Set-AzApiManagementSubscription** + - To account for the new SubscriptonModel using 'Scope' and 'UserId' + - To account for the old subscription model using 'ProductId' and 'UserId' + - Add support to enable 'AllowTracing' at the subscription level. +* Updated following cmdlets to accept 'ResourceId' as input + - 'New-AzApiManagementContext' + - `New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/contoso` + - 'Get-AzApiManagementApiRelease' + - `Get-AzApiManagementApiRelease -ResourceId /subscriptions/subid/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/contoso/apis/echo-api/releases/releaseId` + - 'Get-AzApiManagementApiVersionSet' + - `Get-AzApiManagementApiVersionSet -ResourceId /subscriptions/subid/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/constoso/apiversionsets/pathversionset` + - 'Get-AzApiManagementAuthorizationServer' + - 'Get-AzApiManagementBackend' + - `Get-AzApiManagementBackend -ResourceId /subscriptions/subid/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/contoso/backends/servicefabric` + - 'Get-AzApiManagementCertificate' + - 'Remove-AzApiManagementApiVersionSet' + - 'Remove-AzApiManagementSubscription' + +#### Az.Automation +* Updated Get-AzAutomationJobOutputRecord to handle JSON and Text record values. + - Fix for issue https://github.com/Azure/azure-powershell/issues/7977 + - Fix for issue https://github.com/Azure/azure-powershell/issues/8600 +* Changed behavior for Start-AzAutomationDscCompilationJob to just start the job instead of waiting for its completion. + * Fix for issue https://github.com/Azure/azure-powershell/issues/8347 +* Fix for Get-AzAutomationDscNode when using -Name returns all node. Now it returns matching node only. + +#### Az.Compute +* Add ProtectFromScaleIn and ProtectFromScaleSetAction parameters to Update-AzVmssVM cmdlet. +* New-AzVM wimple parameter set now uses by default an available location if 'East US' is not supported + +#### Az.DataLakeStore +* Update the ADLS sdk to use httpclient, integrate dataplane testing with azure framework + +#### Az.Monitor +* Fixed incorrect parameter names in help examples + +#### Az.Network +* Add DisableBgpRoutePropagation flag to Effective Route Table output + - Updated cmdlet: + - Get-AzEffectiveRouteTable +* Fix double dash in New-AzApplicationGatewayTrustedRootCertificate documentation + +#### Az.Resources +* Add new cmdlet Get-AzDenyAssignment for retrieving deny assignments + +#### Az.Sql +* Rename Advanced Threat Protection cmdlets to Advanced Data Security and enable Vulnerability Assessment by default + +## 2.0.0 - May 2019 +#### Az.Accounts +* Update Authentication Library to fix ADFS issues with username/password auth + +#### Az.CognitiveServices +* Only display Bing disclaimer for Bing Search Services. +* Improve error when create account failed. + +#### Az.Compute +* Proximity placement group feature. + - The following new cmdlets are added: + New-AzProximityPlacementGroup + Get-AzProximityPlacementGroup + Remove-AzProximityPlacementGroup + - The new parameter, ProximityPlacementGroupId, is added to the following cmdlets: + New-AzAvailabilitySet + New-AzVMConfig + New-AzVmssConfig +* StorageAccountType parameter is added to New-AzGalleryImageVersion. +* TargetRegion of New-AzGalleryImageVersion can contain StorageAccountType. +* SkipShutdown switch parameter is added to Stop-AzVM and Stop-AzVmss +* Breaking changes + - Set-AzVMBootDiagnostics is changed to Set-AzVMBootDiagnostic. + - Export-AzLogAnalyticThrottledRequests is changed to Export-AzLogAnalyticThrottledRequests. + +#### Az.DeploymentManager +* First Generally Available release of Azure Deployment Manager cmdlets + +#### Az.Dns +* Automatic DNS NameServer Delegation + - Create DNS zone cmdlet accepts parent zone name as additional optional parameter. + - Adds NS records in the parent zone for newly created child zone. + +#### Az.FrontDoor +* First Generally Available Release of Azure FrontDoor cmdlets +* Rename WAF cmdlets to include 'Waf' + - `Get-AzFrontDoorFireWallPolicy --> Get-AzFrontDoorWafPolicy` + - `New-AzFrontDoorCustomRuleObject --> New-AzFrontDoorWafCustomRuleObject` + - `New-AzFrontDoorFireWallPolicy --> New-AzFrontDoorWafPolicy` + - `New-AzFrontDoorManagedRuleObject --> New-AzFrontDoorWafManagedRuleObject` + - `New-AzFrontDoorManagedRuleOverrideObject --> New-AzFrontDoorWafManagedRuleOverrideObject` + - `New-AzFrontDoorMatchConditionObject --> New-AzFrontDoorWafMatchConditionObject` + - `New-AzFrontDoorRuleGroupOverrideObject --> New-AzFrontDoorWafRuleGroupOverrideObject` + - `Remove-AzFrontDoorFireWallPolicy --> Remove-AzFrontDoorWafPolicy` + - `Update-AzFrontDoorFireWallPolicy --> Update-AzFrontDoorWafPolicy` +#### Az.HDInsight +* Removed two cmdlets: + - Grant-AzHDInsightHttpServicesAccess + - Revoke-AzHDInsightHttpServicesAccess +* Added a new cmdlet Set-AzHDInsightGatewayCredential to replace Grant-AzHDInsightHttpServicesAccess +* Update cmdlet Get-AzHDInsightJobOutput to distinguish reader role and hdinsight operator role: + - Users with reader role need to specify 'DefaultStorageAccountKey' parameter explicitly, otherwise error occurs. + - Users with hdinsight operator role will not be affected. + +#### Az.Monitor +* New cmdlets for SQR API (Scheduled Query Rule) + - New-AzScheduledQueryRuleAlertingAction + - New-AzScheduledQueryRuleAznsActionGroup + - New-AzScheduledQueryRuleLogMetricTrigger + - New-AzScheduledQueryRuleSchedule + - New-AzScheduledQueryRuleSource + - New-AzScheduledQueryRuleTriggerCondition + - New-AzScheduledQueryRule + - Get-AzScheduledQueryRule + - Set-AzScheduledQueryRule + - Update-AzScheduledQueryRule + - Remove-AzScheduledQueryRule + - [More](/rest/api/monitor/scheduledqueryrule-2021-08-01/scheduled-query-rules) information about SQR API + - Updated Az.Monitor.md to include cmdlets for GenV2(non classic) metric-based alert rule + +#### Az.Network +* Add support for Nat Gateway Resource + - New cmdlets + - New-AzNatGateway + - Get-AzNatGateway + - Set-AzNatGateway + - Remove-AzNatGateway + - Updated cmdlets + - New-AzureVirtualNetworkSubnetConfigCommand + - Add-AzureVirtualNetworkSubnetConfigCommand +* Updated below commands for feature: Custom routes set/remove on Brooklyn Gateway. + - Updated New-AzVirtualNetworkGateway: Added optional parameter -CustomRoute to set the address prefixes as custom routes to set on Gateway. + - Updated Set-AzVirtualNetworkGateway: Added optional parameter -CustomRoute to set the address prefixes as custom routes to set on Gateway. + +#### Az.PolicyInsights +* Support for querying policy evaluation details. + - Add '-Expand' parameter to Get-AzPolicyState. Support '-Expand PolicyEvaluationDetails'. + +#### Az.RecoveryServices +* Support for Cross subscription Azure to Azure site recovery. +* Marking upcoming breaking changes for Azure Site Recovery. +* Fix for Azure Site Recovery recovery plan end action plan. +* Fix for Azure Site Recovery Update network mapping for Azure to Azure. +* Fix for Azure Site Recovery update protection direction for Azure to Azure for managed disk. +* Other minor fixes. + +#### Az.Relay +* Fix typos in customer-facing messages + +#### Az.ServiceBus +* Added new cmdlets for NetworkRuleSet of Namespace + +#### Az.Storage +* Upgrade to Storage Client Library 10.0.1 (the namespace of all objects from this SDK change from 'Microsoft.WindowsAzure.Storage.*' to 'Microsoft.Azure.Storage.*') +* Upgrade to Microsoft.Azure.Management.Storage 11.0.0, to support new API version 2019-04-01. +* The default Storage account Kind in Create Storage account change from 'Storage' to 'StorageV2' + - New-AzStorageAccount +* Change the Storage account cmdlet output Sku.Name to be aligned with input SkuName by add '-', like 'StandardLRS' change to 'Standard_LRS' + - New-AzStorageAccount + - Get-AzStorageAccount + - Set-AzStorageAccount + +#### Az.Websites +* 'Kind' property will now be set for PSSite objects returned by Get-AzWebApp +* Get-AzWebApp*Metrics and Get-AzAppServicePlanMetrics marked deprecated + +## 1.8.0 - April 2019 +### Highlights since the last major release +* General availability of `Az` module +* For more information about the `Az` module, please visit the following: https://aka.ms/azps-announce +* Added Location, ResourceGroup, and ResourceName completers: https://azure.microsoft.com/blog/completers-in-azure-powershell/ +* Added wildcard support to Get cmdlets for Az.Compute and Az.Network +* Added interactive and username/password authentication for Windows PowerShell 5.1 only +* Added support for Python 2 runbooks in Az.Automation +* Az.LogicApp: New cmdlets for Integration Account Assemblies and Batch Configuration + +#### Az.Accounts +* Update Uninstall-AzureRm to correctly delete modules in Mac + +#### Az.Batch +* Updated cmdlets with plural nouns to singular, and deprecated plural names. + +#### Az.Cdn +* Updated cmdlets with plural nouns to singular, and deprecated plural names. + +#### Az.CognitiveServices +* Updated cmdlets with plural nouns to singular, and deprecated plural names. + +#### Az.Compute +* Fix issue with AEM installation if resource ids of disks had lowercase resourcegroups in resource id +* Updated cmdlets with plural nouns to singular, and deprecated plural names. +* Fix documentation for wildcards + +#### Az.DataFactory +* Add SsisProperties if NodeCount not null for managed integration runtime. + +#### Az.DataLakeStore +* Updated cmdlets with plural nouns to singular, and deprecated plural names. + +#### Az.EventGrid +* Updated the help text for endpoint to indicate that resources should be created before using the create/update event subscription cmdlets. + +#### Az.EventHub +* Added new cmdlets for NetworkRuleSet of Namespace + +#### Az.HDInsight +* Updated cmdlets with plural nouns to singular, and deprecated plural names. + +#### Az.IotHub +* Updated cmdlets with plural nouns to singular, and deprecated plural names. + +#### Az.KeyVault +* Updated cmdlets with plural nouns to singular, and deprecated plural names. +* Fix documentation for wildcards + +#### Az.MachineLearning +* Updated cmdlets with plural nouns to singular, and deprecated plural names. + +#### Az.Media +* Updated cmdlets with plural nouns to singular, and deprecated plural names. + +#### Az.Monitor + * New cmdlets for GenV2(non classic) metric-based alert rule + - New-AzMetricAlertRuleV2DimensionSelection + - New-AzMetricAlertRuleV2Criteria + - Remove-AzMetricAlertRuleV2 + - Get-AzMetricAlertRuleV2 + - Add-AzMetricAlertRuleV2 + * Updated Monitor SDK to version 0.22.0-preview + +#### Az.Network +* Updated cmdlets with plural nouns to singular, and deprecated plural names. +* Fix documentation for wildcards + +#### Az.NotificationHubs +* Updated cmdlets with plural nouns to singular, and deprecated plural names. + +#### Az.OperationalInsights +* Updated cmdlets with plural nouns to singular, and deprecated plural names. + +#### Az.PowerBIEmbedded +* Updated cmdlets with plural nouns to singular, and deprecated plural names. + +#### Az.RecoveryServices +* Updated cmdlets with plural nouns to singular, and deprecated plural names. +* Updated table format for SQL in azure VM +* Added alternate method to fetch location in AzureFileShare +* Updated ScheduleRunDays in SchedulePolicy object according to timezone + +#### Az.RedisCache +* Updated cmdlets with plural nouns to singular, and deprecated plural names. + +#### Az.Resources +* Fix documentation for wildcards + +#### Az.Sql +* Replace dependency on Monitor SDK with common code +* Updated cmdlets with plural nouns to singular, and deprecated plural names. +* Enhanced process of multiple columns classification. +* Include sku properties (sku name, family, capacity) in response from Get-AzSqlServerServiceObjective and format as table by default. +* Ability to Get-AzSqlServerServiceObjective by location without needing a preexisting server in the region. +* Support for time zone parameter in Managed Instance create. +* Fix documentation for wildcards + +#### Az.Websites +* fixes the Set-AzWebApp and Set-AzWebAppSlot to not remove the tags on execution +* Updated cmdlets with plural nouns to singular, and deprecated plural names. +* Updated the WebSites SDK. +* Removed the AdminSiteName property from PSAppServicePlan. + +## 1.7.0 - April 2019 +### Highlights since the last major release +* General availability of `Az` module +* For more information about the `Az` module, please visit the following: https://aka.ms/azps-announce +* Added Location, ResourceGroup, and ResourceName completers: https://azure.microsoft.com/blog/completers-in-azure-powershell/ +* Added wildcard support to Get cmdlets for Az.Compute and Az.Network +* Added interactive and username/password authentication for Windows PowerShell 5.1 only +* Added support for Python 2 runbooks in Az.Automation +* Az.LogicApp: New cmdlets for Integration Account Assemblies and Batch Configuration + +#### Az.Accounts +* Updated Add-AzEnvironment and Set-AzEnvironment to accept parameter AzureAnalysisServicesEndpointResourceId + +#### Az.AnalysisServices +* Using ServiceClient in dataplane cmdlets and removing the original authentication logic +* Making Add-AzureASAccount a wrapper of Connect-AzAccount to avoid a breaking change + +#### Az.Automation +* Fixed New-AzAutomationSoftwareUpdateConfiguration cmdlet bug for Inclusions. Now parameter IncludedKbNumber and IncludedPackageNameMask should work. +* Bug fix for azure automation update management dynamic group + +#### Az.Compute +* Add HyperVGeneration parameter to New-AzDiskConfig and New-AzSnapshotConfig +* Allow VM creation with galley image from other tenants. + +#### Az.ContainerInstance +* Fixed issue in the -Command parameter of New-AzContainerGroup which added a trailing empty argument + +#### Az.DataFactory +* Updated ADF .Net SDK version to 3.0.2 +* Updated Set-AzDataFactoryV2 cmdlet with extra parameters for RepoConfiguration related settings. + +#### Az.Resources +* Improve handling of providers for 'Get-AzResource' when providing '-ResourceId' or '-ResourceGroupName', '-Name' and '-ResourceType' parameters +* Improve error handling for for 'Test-AzDeployment' and 'Test-AzResourceGroupDeployment' + - Handle errors thrown outside of deployment validation and include them in output of command instead + - More information here: https://github.com/Azure/azure-powershell/issues/6856 +* Add '-IgnoreDynamicParameters' switch parameter to set of deployment cmdlets to skip prompt in script and job scenarios + - More information here: https://github.com/Azure/azure-powershell/issues/6856 + +#### Az.Sql +* Support Database Data Classification. + +#### Az.Storage +* Report detail error when create Storage context with parameter -UseConnectedAccount, but without login Azure account + - New-AzStorageContext +* Support Manage Blob Service Properties of a specified Storage account with Management plane API + - Update-AzStorageBlobServiceProperty + - Get-AzStorageBlobServiceProperty + - Enable-AzStorageBlobDeleteRetentionPolicy + - Disable-AzStorageBlobDeleteRetentionPolicy +* -AsJob support for Blob and file upload and download cmdlets + - Get-AzStorageBlobContent + - Set-AzStorageBlobContent + - Get-AzStorageFileContent + - Set-AzStorageFileContent + +## 1.6.0 - March 2019 +### Highlights since the last major release +* General availability of `Az` module +* For more information about the `Az` module, please visit the following: https://aka.ms/azps-announce +* Added Location, ResourceGroup, and ResourceName completers: https://azure.microsoft.com/blog/completers-in-azure-powershell/ +* Added wildcard support to Get cmdlets for Az.Compute and Az.Network +* Added interactive and username/password authentication for Windows PowerShell 5.1 only +* Added support for Python 2 runbooks in Az.Automation +* Az.LogicApp: New cmdlets for Integration Account Assemblies and Batch Configuration + +#### Az.Automation +* Azure automation update management change to support the following new features : + * Dynamic grouping + * Pre-Post script + * Reboot Setting + +#### Az.Compute +* Fix issue with path resolution in Get-AzVmBootDiagnosticsData +* Update Compute client library to 25.0.0. + +#### Az.KeyVault +* Added wildcard support to KeyVault cmdlets + +#### Az.Network +* Add Threat Intelligence support for Azure Firewall +* Add Application Gateway Firewall Policy top level resource and Custom Rules +* Add Alert action type for Azure Firewall Network and Application Rule Collections +* Added support for conditions in RewriteRules in the Application Gateway + - New cmdlets added: + - New-AzApplicationGatewayRewriteRuleCondition + - Cmdlets updated with optional parameter - RuleSequence and Condition + - New-AzApplicationGatewayRewriteRule + +#### Az.RecoveryServices +* Added SnapshotRetentionInDays in Azure VM policy to support Instant RP +* Added pipe support for unregister container + +#### Az.Resources +* Update wildcard support for Get-AzResource and Get-AzResourceGroup +* Update credentials used when making generic calls to ARM + +#### Az.Sql +* changed Threat Detection's cmdlets param (ExcludeDetectionType) from DetectionType to string[] to make it future proof when new DetectionTypes are added and to support autocomplete as well. +* Add Vulnerability Assessment cmdlets on Server and Managed Instance + +#### Az.Storage +* Support Get/Set/Remove Management Policy on a Storage account + - Set-AzStorageAccountManagementPolicy + - Get-AzStorageAccountManagementPolicy + - Remove-AzStorageAccountManagementPolicy + - Add-AzStorageAccountManagementPolicyAction + - New-AzStorageAccountManagementPolicyFilter + - New-AzStorageAccountManagementPolicyRule + +#### Az.Websites +* Fix ARM template bug that breaks cloning all slots using 'New-AzWebApp -IncludeSourceWebAppSlots' + +## 1.5.0 - March 2019 +### Highlights since the last major release +* General availability of `Az` module +* For more information about the `Az` module, please visit the following: https://aka.ms/azps-announce +* Added Location, ResourceGroup, and ResourceName completers: https://azure.microsoft.com/blog/completers-in-azure-powershell/ +* Added wildcard support to Get cmdlets for Az.Compute and Az.Network +* Added interactive and username/password authentication for Windows PowerShell 5.1 only +* Added support for Python 2 runbooks in Az.Automation +* Az.LogicApp: New cmdlets for Integration Account Assemblies and Batch Configuration + +#### Az.Accounts +* Add 'Register-AzModule' command to support AutoRest generated cmdlets +* Update examples for Connect-AzAccount + +#### Az.Automation +* Fixed issue when retreiving certain monthly schedules in several Azure Automation cmdlets +* Fix Get-AzAutomationDscNode returning just top 20 nodes. Now it returns all nodes + +#### Az.Cdn +* Added new Powershell cmdlets for Enable/Disable Custom Domain Https and deprecated the old ones + +#### Az.Compute +* Add wildcard support to Get cmdlets + +#### Az.DataFactory +* Updated ADF .Net SDK version to 3.0.1 + +#### Az.LogicApp +* Fix for ListWorkflows only retrieving the first page of results + +#### Az.Network +* Add wildcard support to Network cmdlets + +#### Az.RecoveryServices +* Added Sql server in Azure VM support +* SDK Update +* Removed VMappContainer check in Get-ProtectableItem +* Added Name and ServerName as parameters for Get-ProtectableItem + +#### Az.Resources +* Add `-TemplateObject` parameter to deployment cmdlets + - More information here: https://github.com/Azure/azure-powershell/issues/2933 +* Fix issue when piping the result of `Get-AzResource` to `Set-AzResource` + - More information here: https://github.com/Azure/azure-powershell/issues/8240 +* Fix issue with JSON data type change when running `Set-AzResource` + - More information here: https://github.com/Azure/azure-powershell/issues/7930 + +#### Az.Sql +* Updating AuditingEndpointsCommunicator. + - Fixing the behavior of an edge case while creating new diagnostic settings. + +#### Az.Storage +* Support Kind BlockBlobStorage when create Storage account + - New-AzStorageAccount + +## 1.4.0 - February 2019 +### Highlights since the last major release +* General availability of `Az` module +* For more information about the `Az` module, please visit the following: https://aka.ms/azps-announce +* Added Location, ResourceGroup, and ResourceName completers: https://azure.microsoft.com/blog/completers-in-azure-powershell/ +* Added interactive and username/password authentication for Windows PowerShell 5.1 only +* Added support for Python 2 runbooks in Az.Automation +* Az.LogicApp: New cmdlets for Integration Account Assemblies and Batch Configuration + +#### Az.AnalysisServices +* Deprecated AddAzureASAccount cmdlet + +#### Az.Automation +* Update help for Import-AzAutomationDscNodeConfiguration +* Added configuration name validation to Import-AzAutomationDscConfiguration cmdlet +* Improved error handling for Import-AzAutomationDscConfiguration cmdlet + +#### Az.CognitiveServices +* Added CustomSubdomainName as a new optional parameter for New-AzCognitiveServicesAccount which is used to specify subdomain for the resource. + +#### Az.Compute +* Fix issue with ID parameter sets +* Update Get-AzVMExtension to list all installed extension if Name parameter is not provided +* Add Tag and ResourceId parameters to Update-AzImage cmdlet +* Get-AzVmssVM without instance ID and with InstanceView can list VMSS VMs with instance view. + +#### Az.DataLakeStore +* Add cmdlets for ADL deleted item enumerate and restore + +#### Az.EventHub +* Added new boolean property SkipEmptyArchives to Skip Empty Archives in CaptureDescription class of Eventhub + +#### Az.KeyVault +* Fix tagging on Set-AzKeyVaultSecret + +#### Az.LogicApp +* Add in Basic sku for Integration Accounts +* Add in XSLT 2.0, XSLT 3.0 and Liquid Map Types +* New cmdlets for Integration Account Assemblies + - Get-AzIntegrationAccountAssembly + - New-AzIntegrationAccountAssembly + - Remove-AzIntegrationAccountAssembly + - Set-AzIntegrationAccountAssembly +* New cmdlets for Integration Account Batch Configuration + - Get-AzIntegrationAccountBatchConfiguration + - New-AzIntegrationAccountBatchConfiguration + - Remove-AzIntegrationAccountBatchConfiguration + - Set-AzIntegrationAccountBatchConfiguration +* Update Logic App SDK to version 4.1.0 + +#### Az.Monitor +* Update help for Get-AzMetric + +#### Az.Network +* Update help example for Add-AzApplicationGatewayCustomError + +#### Az.OperationalInsights +* Additional support for New and Get ApplicationInsights data source. + - Added new 'ApplicationInsights' kind to support Get specific and Get all ApplicationInsights data sources for given workspace. + - Added New-AzOperationalInsightsApplicationInsightsDataSource cmdlet for creating data source by given Application-Insights resource parameters: subscription Id, resourceGroupName and name. + +#### Az.Resources +* Fix for issue https://github.com/Azure/azure-powershell/issues/8166 +* Fix for issue https://github.com/Azure/azure-powershell/issues/8235 +* Fix for issue https://github.com/Azure/azure-powershell/issues/6219 +* Fix bug preventing repeat creation of KeyCredentials + +#### Az.Sql +* Add support for SQL DB Hyperscale tier +* Fixed bug where restore could fail due to setting unnecessary properties in restore request + +#### Az.Websites +* Correct example in Get-AzWebAppSlotMetrics + +## 1.3.0 - February 2019 +### Highlights since the last major release +* General availability of `Az` module +* For more information about the `Az` module, please visit the following: https://aka.ms/azps-announce +* Added Location, ResourceGroup, and ResourceName completers: https://azure.microsoft.com/blog/completers-in-azure-powershell/ +* Added interactive and username/password authentication for Windows PowerShell 5.1 only +* Added support for Python 2 runbooks in Az.Automation + +#### Az.Accounts +* Update to latest version of ClientRuntime + +#### Az.AnalysisServices +General availability for Az.AnalysisServices module. + +#### Az.Compute +* AEM extension: Add support for UltraSSD and P60,P70 and P80 disks +* Update help description for Set-AzVMBootDiagnostics +* Update help description and example for Update-AzImage + +#### Az.RecoveryServices +General availability for Az.RecoveryServices module. + +#### Az.Resources +* Fix tagging for resource groups + - More information here: https://github.com/Azure/azure-powershell/issues/8166 +* Fix issue where `Get-AzRoleAssignment` doesn't respect -ErrorAction + - More information here: https://github.com/Azure/azure-powershell/issues/8235 + +#### Az.Sql +* Add Get/Set AzSqlDatabaseBackupShortTermRetentionPolicy +* Fix issue where not being logged into Azure account would result in nullref exception when executing SQL cmdlets +* Fixed null ref exception in Get-AzSqlCapability + +## 1.2.1 - January 2019 +### Highlights since the last major release +* General availability of `Az` module +* For more information about the `Az` module, please visit the following: https://aka.ms/azps-announce +* Added Location, ResourceGroup, and ResourceName completers: https://azure.microsoft.com/blog/completers-in-azure-powershell/ +* Added interactive and username/password authentication for Windows PowerShell 5.1 only +* Added support for Python 2 runbooks in Az.Automation + +#### Az.Accounts +* Release with correct version of Authentication + +#### Az.AnalysisServices +* Release with updated Authentication dependency + +#### Az.RecoveryServices +* Release with updated Authentication dependency + + +## 1.2.0 - January 2019 +### Highlights since the last major release +* General availability of `Az` module +* For more information about the `Az` module, please visit the following: https://aka.ms/azps-announce +* Added Location, ResourceGroup, and ResourceName completers: https://azure.microsoft.com/blog/completers-in-azure-powershell/ +* Added interactive and username/password authentication for Windows PowerShell 5.1 only +* Added support for Python 2 runbooks in Az.Automation + +#### Az.Accounts +* Add interactive and username/password authentication for Windows PowerShell 5.1 only +* Update incorrect online help URLs +* Add warning message in PS Core for Uninstall-AzureRm + +#### Az.Aks +* Update incorrect online help URLs + +#### Az.Automation +* Added support for Python 2 runbooks +* Update incorrect online help URLs + +#### Az.Cdn +* Update incorrect online help URLs + +#### Az.Compute +* Add Invoke-AzVMReimage cmdlet +* Add TempDisk parameter to Set-AzVmss +* Fix the warning message of New-AzVM + +#### Az.ContainerRegistry +* Update incorrect online help URLs + +#### Az.DataFactory +* Updated ADF .Net SDK version to 3.0.0 + +#### Az.DataLakeStore +* Fix issue with ADLS endpoint when using MSI + - More information here: https://github.com/Azure/azure-powershell/issues/7462 +* Update incorrect online help URLs + +#### Az.IotHub +* Add Encoding format to Add-IotHubRoutingEndpoint cmdlet. + +#### Az.KeyVault +* Update incorrect online help URLs + +#### Az.Network +* Update incorrect online help URLs + +#### Az.Resources +* Fix incorrect examples in 'New-AzADAppCredential' and 'New-AzADSpCredential' reference documentation +* Fix issue where path for '-TemplateFile' parameter was not being resolved before executing resource group deployment cmdlets +* Az.Resources: Correct documentation for New-AzPolicyDefinition -Mode default value +* Az.Resources: Fix for issue https://github.com/Azure/azure-powershell/issues/7522 +* Az.Resources: Fix for issue https://github.com/Azure/azure-powershell/issues/5747 +* Fix formatting issue with 'PSResourceGroupDeployment' object + - More information here: https://github.com/Azure/azure-powershell/issues/2123 + +#### Az.ServiceFabric +* Rollback when a certificate is added to VMSS model but an exception is thrown this is to fix bug: https://github.com/Azure/service-fabric-issues/issues/932 +* Fix some error messages. +* Fix create cluster with default ARM template for New-AzServiceFabriCluster which was not working with migration to Az. +* Fix add cluster/application certificate to only add to VM Scale Sets that correspond to the cluster by checking cluster id in the extension. + +#### Az.SignalR +* Update incorrect online help URLs + +#### Az.Sql +* Update incorrect online help URLs +* Updated parameter description for LicenseType parameter with possible values +* Fix for updating managed instance identity not working when it is the only updated property +* Support for custom collation on managed instance + +#### Az.Storage +* Update incorrect online help URLs +* Give detail error message when get/set classic Logging/Metric on Premium Storage Account, since Premium Storage Account not supoort classic Logging/Metric. + - Get/Set-AzStorageServiceLoggingProperty + - Get/Set-AzStorageServiceMetricsProperty + +#### Az.TrafficManager +* Update incorrect online help URLs + +#### Az.Websites +* Update incorrect online help URLs +* Fixes 'New-AzWebAppSSLBinding' to upload the certificate to the correct resourcegroup+location if the app is hosted on an ASE. +* Fixes 'New-AzWebAppSSLBinding' to not overwrite the tags on binding an SSL certificate to an app + +## 1.1.0 - January 2019 +### Highlights since the last major release +* General availability of `Az` module +* For more information about the `Az` module, please visit the following: https://aka.ms/azps-announce +* Added Location, ResourceGroup, and ResourceName completers: https://azure.microsoft.com/blog/completers-in-azure-powershell/ + +#### Az.Accounts +* Add 'Local' Scope to Enable-AzureRmAlias + +#### Az.Compute +* Name is now optional in ID parameter set for Restart/Start/Stop/Remove/Set-AzVM and Save-AzVMImage +* Updated the description of ID in help files +* Fix backward compatibility issue with Az.Accounts module + +#### Az.DataLakeStore +* Update the sdk version of dataplane to 1.1.14 for SDK fixes. + - Fix handling of negative acesstime and modificationtime for getfilestatus and liststatus, Fix async cancellation token + +#### Az.EventGrid +* Updated to use the 2019-01-01 API version. +* Update the following cmdlets to support new scenario in 2019-01-01 API version + - New-AzEventGridSubscription: Add new optional parameters for specifying: + - Event Time-To-Live, + - Maximum number of delivery attempts for the events, + - Dead letter endpoint. + - Update-AzEventGridSubscription: Add new optional parameters for specifying: + - Event Time-To-Live, + - Maximum number of delivery attempts for the events, + - Dead letter endpoint. +* Add new enum values (namely, storageQueue and hybridConnection) for EndpointType option in New-AzEventGridSubscription and Update-AzEventGridSubscription cmdlets. +* Show warning message if creating or updating the event subscription is expected to entail manual action from user. + +#### Az.IotHub +* Updated to the latest version of the IotHub SDK + +#### Az.LogicApp +* Get-AzLogicApp lists all without specified Name + +#### Az.Resources +* Fix parameter set issue when providing '-ODataQuery' and '-ResourceId' parameters for 'Get-AzResource' + - More information here: https://github.com/Azure/azure-powershell/issues/7875 +* Fix handling of the -Custom parameter in New/Set-AzPolicyDefinition +* Fix typo in New-AzDeployment documentation +* Made '-MailNickname' parameter mandatory for 'New-AzADUser' + - More information here: https://github.com/Azure/azure-powershell/issues/8220 + +#### Az.SignalR +* Fix backward compatibility issue with Az.Accounts module + +#### Az.Sql +* Converted the Storage management client dependency to the common SDK implementation. + +#### Az.Storage +* Set the StorageAccountName of Storage context as the real Storage Account Name, when it's created with Sas Token, OAuth or Anonymous + - New-AzStorageContext +* Create Sas Token of Blob Snapshot Object with '-FullUri' parameter, fix the returned Uri to be the sanpshot Uri + - New-AzStorageBlobSASToken + +#### Az.Websites +* Fixed a date parsing bug in 'Get-AzDeletedWebApp' +* Fix backward compatibility issue with Az.Accounts module + +## Version 1.0.0 - December 2018 +### Highlights since the last major release +* General availability of `Az` module +* For more information about the `Az` module, please visit the following: https://aka.ms/azps-announce +* Added Location, ResourceGroup, and ResourceName completers: https://azure.microsoft.com/blog/completers-in-azure-powershell/ diff --git a/docs-conceptual/azps-10.1.0/toc.yml b/docs-conceptual/azps-10.1.0/toc.yml new file mode 100644 index 0000000000..f8addc33c4 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/toc.yml @@ -0,0 +1,165 @@ +- name: Azure PowerShell + href: index.yml +- name: Overview + items: + - name: What is Azure PowerShell? + href: what-is-azure-powershell.md + - name: Introducing the Az PowerShell module + href: new-azureps-module-az.md + displayName: intro, introduction, az + - name: Get started + href: get-started-azureps.md + displayName: sign in, signin, log in, login, find, feedback, intro, introduction + - name: Module versioning and release cadence + href: azps-versioning-release-cadence.md + - name: Support lifecycle + href: azureps-support-lifecycle.md +- name: Install + items: + - name: Install + href: install-azure-powershell.md + - name: Install - Windows + href: install-azps-windows.md + - name: Install - Linux + href: install-azps-linux.md + - name: Install - macOS + href: install-azps-macos.md + - name: Run in Azure Cloud Shell + href: https://shell.azure.com + - name: Azure PowerShell in Docker + href: azureps-in-docker.md + - name: Uninstall + href: uninstall-az-ps.md +- name: What's New + items: + - name: Release notes + href: release-notes-azureps.md + - name: Upcoming breaking changes + href: upcoming-breaking-changes.md +- name: How-to guides + items: + - name: Configuration + items: + - name: Configure global settings + href: configure-global-settings.md + - name: Intelligent command completion + href: az-predictor.md + - name: Use the Az PowerShell module behind a proxy + href: az-powershell-proxy.md + - name: Authentication and Identity + items: + - name: Authentication methods + href: authenticate-azureps.md + displayName: >- + sign in, signin, log in, login, credentials, msi, managed identity, + tenant, subscription, region, certificate, service principal, + authenticate + - name: Create a service principal + href: create-azure-service-principal-azureps.md + displayName: >- + automation, application, web app, script, certificate, sign in, + signin, log in, login, devops, dev ops, itpro, it pro, role, + aad, authentication, authenticate + - name: Credential contexts + href: context-persistence.md + displayName: >- + sign in, signin, log in, login, process, session, context, + persist, jobs, background, automation, scripting, task + - name: Concepts + items: + - name: Manage subscriptions + href: manage-subscriptions-azureps.md + displayName: tenant, user, sign in, signin, log in, login, authenticate, authentication, accounts + - name: Manage Azure resources with Invoke-AzRestMethod + href: manage-azure-resources-invoke-azrestmethod.md + - name: Filter cmdlet results + href: queries-azureps.md + displayName: filter, search, format, output, variable, scripting, array, dictionary, map, object + - name: Format output + href: formatting-output.md + displayName: object, table, yaml, json, xml, csv, html, list + - name: PowerShell jobs + href: using-psjobs.md + displayName: background, task, scripting, automation, context, process + - name: Deploy + items: + - name: Deploy Resource Manager templates + href: /azure/azure-resource-manager/templates/deploy-powershell?toc=/powershell/azure/toc.json + - name: Export Resource Manager templates + href: /azure/azure-resource-manager/management/manage-resources-powershell?toc=/powershell/azure/toc.json + - name: Deploy private Resource Manager templates + href: /azure/azure-resource-manager/templates/secure-template-with-sas-token?toc=/powershell/azure/toc.json +- name: Tutorials + items: + - name: Create Virtual Machines + href: azureps-vm-tutorial.yml + - name: Create a virtual network + href: /azure/virtual-network/quick-create-powershell?toc=/powershell/azure/toc.json + - name: Create a storage account + href: /azure/storage/common/storage-account-create?toc=/powershell/azure/toc.json&tabs=azure-powershell + - name: Configure a Log Analytics workspace in Azure Monitor + href: /azure/azure-monitor/logs/powershell-workspace-configuration?toc=/powershell/azure/toc.json + - name: Deploy an Azure Kubernetes Service (AKS) cluster + href: /azure/aks/tutorial-kubernetes-deploy-cluster?toc=/powershell/azure/toc.json&tabs=azure-powershell + - name: Create a private container registry + href: /azure/container-registry/container-registry-get-started-powershell?toc=/powershell/azure/toc.json + - name: Deploy a container instance in Azure + href: /azure/container-instances/container-instances-quickstart-powershell?toc=/powershell/azure/toc.json + - name: Set and retrieve a secret from Azure Key Vault + href: /azure/key-vault/secrets/quick-create-powershell?toc=/powershell/azure/toc.json +- name: Migration + items: + - name: Azure AD to Microsoft Graph Migration Guide + href: azps-msgraph-migration-changes.md + - name: Migrate from previous versions of Az + items: + - name: Az 10.0.0 Migration Guide + href: migrate-az-10.0.0.md + - name: Az 9.0.1 Migration Guide + href: migrate-az-9.0.1.md + - name: Az.EventHub Migration Guide + href: migrate-az-9.0.1-eventhub.md + - name: Az.ServiceBus Migration Guide + href: migrate-az-9.0.1-servicebus.md + - name: Az 8.0.0 Migration Guide + href: migrate-az-8.0.0.md + - name: Az 7.0.0 Migration Guide + href: migrate-az-7.0.0.md + - name: Az 6.0.0 Migration Guide + href: migrate-az-6.0.0.md + - name: Az 5.0.0 Migration Guide + href: migrate-az-5.0.0.md + - name: Az 4.1.0 Migration Guide + href: migrate-az-4.1.0.md + - name: Az 3.0.0 Migration Guide + href: migrate-az-3.0.0.md + - name: Az 2.0.0 Migration Guide + href: migrate-az-2.0.0.md + - name: Migrate from AzureRM + items: + - name: Changes between AzureRM and Az + href: migrate-az-1.0.0.md + displayName: breaking, cmdlet, module, names + - name: Migration steps + href: migrate-from-azurerm-to-az.md + displayName: migrate, azurerm, az + - name: Automatically migrate PowerShell scripts + href: quickstart-migrate-azurerm-to-az-automatically.md + displayName: automatically migrate, azurerm, az +- name: Samples + items: + - name: Azure App Service + href: /azure/app-service-web/app-service-powershell-samples?toc=/powershell/azure/toc.json + - name: SQL Databases + href: /azure/sql-database/sql-database-powershell-samples?toc=/powershell/azure/toc.json + - name: Cosmos DB + href: /azure/cosmos-db/sql/powershell-samples?toc=/powershell/azure/toc.json + displayName: database, nosql, mongodb, couchdb + - name: Samples repo + href: https://github.com/Azure/azure-docs-powershell-samples +- name: Survey Guidance + href: command-line-tools-survey-guidance.md +- name: Troubleshooting + href: troubleshooting.md +- name: Frequently Asked Questions + href: faq.yml diff --git a/docs-conceptual/azps-10.1.0/troubleshooting.md b/docs-conceptual/azps-10.1.0/troubleshooting.md new file mode 100644 index 0000000000..53f9e97c1e --- /dev/null +++ b/docs-conceptual/azps-10.1.0/troubleshooting.md @@ -0,0 +1,209 @@ +--- +description: Troubleshooting the Azure Az PowerShell module. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Troubleshooting the Azure Az PowerShell module +--- + +# Troubleshooting the Azure Az PowerShell module + +## Enable debug logging + +One of the first steps you should take in troubleshooting a problem with the Azure Az PowerShell +module is to enable debug logging. + +To enable debug logging on a per command basis, specify the **Debug** parameter. + +```azurepowershell-interactive +Get-AzResource -Name 'DoesNotExist' -Debug +``` + +To enable debug logging for an entire PowerShell session, you set the value of the +**DebugPreference** variable to `Continue`. + +```powershell-interactive +$DebugPreference = 'Continue' +``` + +## Installation + +This section contains a list of solutions to common problems when installing the Azure Az PowerShell +module. + +### Az and AzureRM coexistence + +> [!WARNING] +> We do not support having both the AzureRM and Az PowerShell modules installed in Windows +> PowerShell 5.1 at the same time. + +In a scenario where you need to install both the AzureRM and Az PowerShell module on the same +Windows system: + +- AzureRM must be installed only in the current user scope of Windows PowerShell 5.1. +- Install the Az PowerShell module in PowerShell 7.0.6 LTS, PowerShell 7.1.3, or higher. + +[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] + +#### Visual Studio + +Older versions of Visual Studio may install Azure PowerShell as part of the Azure development +workload, which installs the AzureRM module. Azure PowerShell can be removed using the Visual Studio +installer or by using "Uninstall" in Apps & features. If you have already installed PowerShell 7.x, +you may need to [manually install](install-azure-powershell.md) the Azure Az PowerShell module. + +### Proxy blocks connection + +If you get errors from `Install-Module` that the PowerShell Gallery is unreachable, you may be +behind a proxy. Different operating systems and network environment have different requirements for +configuring a system-wide proxy. Contact your system administrator for your proxy settings and how +to configure them for your environment. + +PowerShell itself may not be configured to use this proxy automatically. With PowerShell 5.1 and +later, configure the PowerShell session to use a proxy using the following commands: + +```powershell +$webClient = New-Object -TypeName System.Net.WebClient +$webClient.Proxy.Credentials = [System.Net.CredentialCache]::DefaultNetworkCredentials +``` + +If your operating system credentials are configured correctly, this configuration routes PowerShell +requests through the proxy. To have this setting persist between sessions, add the commands to your +[PowerShell profile](/powershell/module/microsoft.powershell.core/about/about_profiles). + +To install the package, your proxy needs to allow HTTPS connections to [www.powershellgallery.com](https://www.powershellgallery.com). + +## Object reference not set to an instance of an object + +The message "_object reference not set to an instance of an object_" means that you are referring to +an object that's null or an Azure resource that doesn't exist or that you don't have permissions to +access. + +```azurepowershell +$resourceId = '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/<resource-group-name>/providers/Microsoft.Web/sites/<webapp-name>/privateEndpointConnections/<endpoint-name>' +Get-AzPrivateEndpointConnection -ResourceId $resourceId +``` + +```Output +Get-AzPrivateEndpointConnection: Object reference not set to an instance of an object. +``` + +You can use the `Get-AzResource` cmdlet to verify that the specified Azure resource exists. + +```azurepowershell +Get-AzResource -ResourceId $resourceId +``` + +## Permission issues with AzAD cmdlets + +The Az PowerShell module uses the Microsoft Graph API. Administering or managing resources in Azure +with the Az PowerShell module requires the same permissions as performing the identical task from +Azure portal or any other Azure command-line tool. For specific questions about permissions see the +[Microsoft Graph permissions reference](/graph/permissions-reference). + +## Microsoft Graph query parameters + +AzAd cmdlets under Az.Resources now support [query parameters](/graph/query-parameters) and +[search query parameters](/graph/search-query-parameter). For details about the syntax, see the +previously referenced links. + +## Get-AzAdGroupMember doesn't return service principals + +Due to limitations with the current Graph API, service principals aren't returned by +[Get-AzAdGroupMember](/powershell/module/az.resources/get-azadgroupmember) in Az 7.x. As a +workaround, [Invoke-AzRestMethod](/powershell/module/az.accounts/invoke-azrestmethod) can be used +with the beta version of the Microsoft Graph API. + +The following example requires the Az PowerShell module. Replace `myGroupName` in the first line +with the name of your group. + +```azurepowershell-interactive +$Group = Get-AzADGroup -DisplayName myGroupName +((Invoke-AzRestMethod -Uri "https://graph.microsoft.com/beta/groups/$($Group.id)/members").Content | + ConvertFrom-Json).value | + Select-Object -Property DisplayName, Id, @{label='OdataType';expression={$_.'@odata.type'}} +``` + +## Command found but could not be loaded + +The following message is returned by PowerShell when you attempt to run any of the Az PowerShell commands. + +```Output +Connect-AzAccount: The 'Connect-AzAccount' command was found in the module 'Az.Accounts', but the module could not be loaded. For more information, run 'Import-Module Az.Accounts'. +``` + +This message occurs when you have both the Az and AzureRM PowerShell modules installed on the same +Windows-based system and they exist in the +[$env:PSModulePath](/powershell/module/microsoft.powershell.core/about/about_psmodulepath) for the +same version of PowerShell. + +> [!IMPORTANT] +> When AzureRM is installed in the `AllUsers` scope of Windows PowerShell, it's installed in a +> location that's part of the `$env:PSModulePath` for PowerShell 7. This isn't supported due to +> conflicts between the AzureRM and Az PowerShell modules. + +Both Az and AzureRM may coexist on the same Windows system, but only if AzureRM is installed in the +`CurrentUser` scope of Windows PowerShell and Az installed in PowerShell 7. For more information, see +[Install the Azure Az PowerShell module](/powershell/azure/install-az-ps). + +[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] + +## On MacOS, an error returns when KeyChain authorization fails + +When running Azure PowerShell on MacOS, you might encounter an error message while attempting to +sign in to your Azure account from a PowerShell session. + +```txt +DeviceCodeCredential authentication failed: Persistence check failed. Reason: KeyChain authorization/authentication failed. .Error code: -25293. OS error code -25293. +``` + +As a workaround for this issue, you can disable storing credentials between sessions by running the +following command. After making this change however, you need to run `Connect-AzAccount` each time +you start a new PowerShell session. + +```azurepowershell +Disable-AzContextAutosave +``` + +## Service Principal IdentifierUri verified domain error + +Error: _Values of identifierUris property must use a verified domain of the organization or its +subdomain_ is displayed when running `New-AzADServicePrincipal` or `New-AzADApplication`. + +Due to the Azure Active Directory breaking change requiring [AppId Uri in single tenant applications +to require use of default scheme or verified +domains](/azure/active-directory/develop/reference-breaking-changes#appid-uri-in-single-tenant-applications-will-require-use-of-default-scheme-or-verified-domains) +you must upgrade the [Az.Resources](https://www.powershellgallery.com/packages/Az.Resources) module +to version 4.1.0 or later to continue using `New-AzADServicePrincipal` or `New-AzADApplication` cmdlets. + +You can also upgrade to Az PowerShell module version 6.0 or greater. + +### Timeline + +The requirement went into effect October 15, 2021. + +### Impacted versions + +The following versions of Azure PowerShell are affected by the AzureAD breaking change: + +- Az.Resources PowerShell module version 3.5.1-preview or lesser. +- Az PowerShell module version 5.9.0 or lesser. + +If you are still encountering issues after upgrading, feel free to open an +[issue](https://github.com/Azure/azure-powershell/issues/new?assignees=&labels=needs-triage&template=az-module-bug-report.md&title=). + +### Workaround + +If you can't upgrade to the PowerShell modules described previously, you may follow those steps when +creating a service principal: + +- If needed, [add your custom domain name using Azure Active Directory portal](/azure/active-directory/fundamentals/add-custom-domain) +- Create an application with an accepted IdentifierUri +- Create a service principal referring this application + +## Other issues + +If you experience a product issue with Azure PowerShell not listed in this article or require +further assistance, [file an issue on GitHub](https://github.com/azure/azure-powershell/issues). diff --git a/docs-conceptual/azps-10.1.0/uninstall-az-ps.md b/docs-conceptual/azps-10.1.0/uninstall-az-ps.md new file mode 100644 index 0000000000..479712e9bc --- /dev/null +++ b/docs-conceptual/azps-10.1.0/uninstall-az-ps.md @@ -0,0 +1,132 @@ +--- +description: How to perform a complete uninstall of Azure PowerShell +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Uninstall Azure PowerShell +--- + +# How to uninstall Azure PowerShell modules + +This article explains how to uninstall Azure PowerShell, or completely remove it from your system. +If you've decided to completely uninstall Azure PowerShell and don't plan to reinstall it, give us +some feedback through the [Send-Feedback](/powershell/module/az.accounts/send-feedback) cmdlet. If +you encountered a bug, [file a GitHub issue](https://github.com/azure/azure-powershell/issues). + +## Uninstall the Az module + +If you have the Az module installed on your system and would like to uninstall it, there are +two options. Which method you follow depends on how you installed the Az module. If you're not +sure of your original installation method, follow the MSI steps for uninstalling first. + +### Option 1: Uninstall the Az PowerShell module from MSI + +If you installed Az PowerShell module using the MSI package, you must uninstall through the Windows +system rather than PowerShell. + +| Platform | Instructions | +| ------------------------ | ------------------------------------------------------ | +| Windows 10 | Start > Settings > Apps | +| Windows 7 </br>Windows 8 | Start > Control Panel > Programs > Uninstall a program | + +Once on this screen, you should see **Azure PowerShell** in the program listing. This is the app to +uninstall. If you don't see this program listed, then you installed through PowerShellGet and +should follow the instructions outlined in option 2. + +### Option 2: Uninstall the Az PowerShell module from PowerShellGet + +When the Az PowerShell module is installed, it installs numerous PowerShell modules for different +Azure services. All the modules begin with an Az prefix. + +> [!IMPORTANT] +> Run PowerShell elevated as an admin if any version of the Az PowerShell module is installed in the +> all users `$env:PSModulePath`. + +To uninstall the Az PowerShell module, you can use the +[Uninstall-Module](/powershell/module/powershellget/uninstall-module) cmdlet. However, +`Uninstall-Module` only uninstalls the modules specified for the **Name** parameter. To remove the Az +PowerShell module completely, you must uninstall each module individually. + +> [!NOTE] +> Uninstallation can be complicated if you have more than one version of the Az PowerShell module +> installed. Because of this complexity, we only support uninstalling all versions of the Az +> PowerShell module that are installed. + +First, you'll need a list of all the Az PowerShell module versions installed on your system. + +```powershell +Get-InstalledModule -Name Az -AllVersions -OutVariable AzVersions +``` + +You can use the following example to generate a list of all the Az PowerShell modules that need to +be uninstalled in addition to the Az module. + +```powershell +($AzVersions | + ForEach-Object { + Import-Clixml -Path (Join-Path -Path $_.InstalledLocation -ChildPath PSGetModuleInfo.xml) + }).Dependencies.Name | Sort-Object -Descending -Unique -OutVariable AzModules +``` + +Remove the Az modules from memory and then uninstall them. + +```powershell +$AzModules | + ForEach-Object { + Remove-Module -Name $_ -ErrorAction SilentlyContinue + Write-Output "Attempting to uninstall module: $_" + Uninstall-Module -Name $_ -AllVersions + } +``` + +The final step is to remove the Az PowerShell module. + +```powershell +Remove-Module -Name Az -ErrorAction SilentlyContinue +Uninstall-Module -Name Az -AllVersions +``` + +## Uninstall the AzureRM module + +If you have the Az module installed on your system and would like to uninstall AzureRM, there are +two options. Which method you follow depends on how you installed the AzureRM module. If you're not +sure of your original installation method, follow the MSI steps for uninstalling first. + +### Option 1: Uninstall the AzureRM PowerShell module from MSI + +If you installed the AzureRM PowerShell module using the MSI package, you must uninstall through the +Windows system rather than PowerShell. + +| Platform | Instructions | +| ------------------------ | ------------------------------------------------------ | +| Windows 10 | Start > Settings > Apps | +| Windows 7 </br>Windows 8 | Start > Control Panel > Programs > Uninstall a program | + +Once on this screen, you should see **Azure PowerShell** or **Microsoft Azure PowerShell - Month +Year** in the program listing. This is the app to uninstall. If you don't see this program listed, +then you installed through PowerShellGet, and should follow the next set of instructions. + +### Option 2: Uninstall the AzureRM PowerShell module from PowerShellGet + +If you installed AzureRM with PowerShellGet, then you can remove the modules with the +[Uninstall-AzureRM](/powershell/module/az.accounts/uninstall-azurerm) cmdlet, available as part of +the `Az.Accounts` module. + +To use `Uninstall-AzureRM` from the `Az.Accounts` module, you need to have the Az PowerShell module +installed. Having both the AzureRM and the Az modules installed at the same time isn't supported, +however the Az module can be used to immediately uninstall the AzureRM module. You can install the +Az module and bypass the AzureRM module warning with the following command if you don't have the Az +module installed already: + +```powershell +Install-Module -Name Az -AllowClobber -Scope CurrentUser +``` + +Once the Az module is installed, the following command removes _all_ AzureRM modules from your machine. It +requires administrator privileges. + +```powershell +Uninstall-AzureRm +``` diff --git a/docs-conceptual/azps-10.1.0/upcoming-breaking-changes.md b/docs-conceptual/azps-10.1.0/upcoming-breaking-changes.md new file mode 100644 index 0000000000..cc0c248679 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/upcoming-breaking-changes.md @@ -0,0 +1,13 @@ +--- +description: Learn about upcoming breaking changes to the Azure Az PowerShell module +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Upcoming breaking changes in Azure PowerShell +--- + +# Upcoming breaking changes in Azure PowerShell + +There is currently no planned breaking change for the next major release of Azure PowerShell - Az 11. \ No newline at end of file diff --git a/docs-conceptual/azps-10.1.0/using-psjobs.md b/docs-conceptual/azps-10.1.0/using-psjobs.md new file mode 100644 index 0000000000..bc5d3323ff --- /dev/null +++ b/docs-conceptual/azps-10.1.0/using-psjobs.md @@ -0,0 +1,94 @@ +--- +description: Learn how to run Azure PowerShell cmdlets in parallel or as background tasks, using -AsJob and Start-Job. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: conceptual +title: Run Azure PowerShell cmdlets in PowerShell Jobs +--- + +# Run Azure PowerShell cmdlets in PowerShell Jobs + +Azure PowerShell depends on connecting to an Azure cloud and waiting for responses, so most of these +cmdlets block your PowerShell session until they get a response from the cloud. PowerShell Jobs let +you run cmdlets in the background or do multiple tasks on Azure at once, from inside a single +PowerShell session. + +This article is a brief overview of how to run Azure PowerShell cmdlets as PowerShell Jobs and check +for completion. Running commands in Azure PowerShell requires the use of Azure PowerShell contexts, +which are covered in detail in [Azure contexts and sign-in credentials](context-persistence.md). To +learn more about PowerShell Jobs, see +[About PowerShell Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs). + +## Azure contexts with PowerShell jobs + +PowerShell Jobs are run as separate processes without an attached PowerShell session, so your Azure +credentials must be shared with them. Credentials are passed as Azure context objects, using one of +these methods: + +- Automatic context persistence. Context persistence is enabled by default and preserves your + sign-in information across multiple sessions. With context persistence enabled, the current Azure + context is passed to the new process: + + ```azurepowershell-interactive + Enable-AzContextAutosave # Enables context autosave if not already on + $vmadmin = Get-Credential + + Start-Job { + New-AzVM -Name MyVm -Credential $Using:vmadmin + } + ``` + +- Provide an Azure context object with any Azure PowerShell cmdlet that has an **AzContext** + parameter: + + ```azurepowershell-interactive + $context = Get-AzContext -Name 'mycontext' # Get an Azure context object + $vmadmin = Get-Credential + + $job = Start-Job { + New-AzVM -Name MyVm -AzContext $Using:context -Credential $Using:vmadmin + } + ``` + + If context persistence is disabled, the **AzContext** parameter is required. + +- Use the **AsJob** parameter provided by some Azure PowerShell cmdlets. This switch automatically + starts the cmdlet as a PowerShell Job, using the active Azure context: + + ```azurepowershell-interactive + $vmadmin = Get-Credential + $job = New-AzVM -Name MyVm -Credential $vmadmin -AsJob + ``` + + To see if a cmdlet supports **AsJob**, check its reference documentation. The **AsJob** parameter + doesn't require context autosave to be enabled. + +You can check the status of a running job with the +[Get-Job](/powershell/module/microsoft.powershell.core/get-job) cmdlet. To get the output from a job +so far, use the [Receive-Job](/powershell/module/microsoft.powershell.core/receive-job) cmdlet. + +To check an operation's progress remotely on Azure, use the `Get` cmdlets associated with the type +of resource being modified by the job: + +```azurepowershell-interactive +$vmadmin = Get-Credential +$context = Get-AzContext -Name 'mycontext' +$vmName = 'MyVm' + +$job = Start-Job { + New-AzVM -Name $Using:vmName -AzContext $Using:context -Credential $Using:vmadmin +} + +Get-Job -Id $job.Id +Get-AzVM -Name $vmName +``` + +## See Also + +- [Azure PowerShell contexts](context-persistence.md) +- [About PowerShell Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs) +- [Get-Job](/powershell/module/microsoft.powershell.core/get-job) +- [Receive-Job](/powershell/module/microsoft.powershell.core/receive-job) +- [The `Using:` scope modifier](/powershell/module/microsoft.powershell.core/about/about_scopes#the-using-scope-modifier) diff --git a/docs-conceptual/azps-10.1.0/what-is-azure-powershell.md b/docs-conceptual/azps-10.1.0/what-is-azure-powershell.md new file mode 100644 index 0000000000..f411f1a8f8 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/what-is-azure-powershell.md @@ -0,0 +1,92 @@ +--- +description: This article is an introduction to Azure PowerShell and its features. +ms.custom: devx-track-azurepowershell +ms.date: 06/30/2023 +ms.devlang: powershell +ms.service: azure-powershell +ms.topic: overview +title: What is Azure PowerShell +--- + +# What is Azure PowerShell? + +Azure PowerShell is a set of cmdlets for managing Azure resources directly from PowerShell. Azure +PowerShell is designed to make it easy to learn and get started with, but provides powerful features +for automation. + +## The Az PowerShell module + +> [!IMPORTANT] +> The Az PowerShell module is the recommended PowerShell module for managing Azure resources on all +> platforms. + +The Az PowerShell module is based on the .NET Standard, and works with PowerShell 7.0.6 LTS and +PowerShell 7.1.3 or higher on all platforms including Windows, Linux, and macOS. It's also +compatible with Windows PowerShell 5.1. + +> [!NOTE] +> PowerShell 7.0.6 LTS and PowerShell 7.1.3 or higher is the recommended version of PowerShell for +> use with the Az PowerShell module on all platforms. + +You can install the Az PowerShell module locally on Windows, Linux, and macOS. It can also be used +from a browser through [Azure Cloud Shell](/azure/cloud-shell/overview) or +[inside a Docker container](/powershell/azure/azureps-in-docker). For more information, see the +[Azure PowerShell documentation](/powershell/azure/). + +### Authentication + +Azure PowerShell supports several authentication methods. For detailed information about +authenticating to Azure from the Az PowerShell module, see +[Sign in with Azure PowerShell](/powershell/azure/authenticate-azureps). + +### Module Design + +The Az PowerShell module is a wrapper module for Azure service related PowerShell modules, usually +one module per Azure service such as `Az.Network` for Azure networking services and `Az.AKS` for +Azure Kubernetes Service. + +The cmdlets in the Az PowerShell module make REST calls to the Azure API. Breaking changes in the Az +PowerShell module are limited to twice a year. Many breaking changes at the API level are handled +within the cmdlets to prevent the perception of a breaking change. + +The Az PowerShell module contains cmdlets for performing both control plane and data plane +operations in Azure. You use the control plane to manage resources in your subscription. You use the +data plane to use capabilities exposed by your instance of a resource type. For more information, +see +[Azure control plane and data plane](/azure/azure-resource-manager/management/control-plane-and-data-plane). + +### Output Objects + +The cmdlets in the Az PowerShell module produce .NET objects. As with any PowerShell command that +produces output, the cmdlets in the Az PowerShell module can be piped to the +[Get-Member](/powershell/module/microsoft.powershell.utility/get-member) cmdlet to determine what +type of object is produced along with a list of the available properties and methods. For more +information, see [Query output of Azure PowerShell](/powershell/azure/queries-azureps) and +[Format Azure PowerShell cmdlet output](/powershell/azure/formatting-output). + +## Other modules + +The AzureAD and MSOnline PowerShell modules aren't part of the Az PowerShell module. For more +information about those modules, see the documentation for +[Azure Active Directory PowerShell for Graph](/powershell/azure/active-directory/overview). + +## Legacy Azure PowerShell modules + +### The AzureRM PowerShell module + +[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] + +The AzureRM PowerShell module is no longer recommended as deprecation has been announced, new +features are no longer being added, and it's not cross platform. For more information, see +[Overview of the AzureRM PowerShell module](/powershell/azure/azurerm/overview). + +### The Azure PowerShell module + +> [!IMPORTANT] +> The cmdlets in the Azure PowerShell module are for managing legacy Azure resources that use +> Service Management APIs. + +Some cmdlets in the Azure PowerShell module have been deprecated and others have been deprecated for +new customers with retirement announced for existing customers as noted on their corresponding +reference documentation pages. For more information, see +[Overview of the Azure PowerShell Service Management module](/powershell/azure/servicemanagement/overview) diff --git a/docs-conceptual/azps-10.1.0/zone-pivot-groups.yml b/docs-conceptual/azps-10.1.0/zone-pivot-groups.yml new file mode 100644 index 0000000000..53ec0a5969 --- /dev/null +++ b/docs-conceptual/azps-10.1.0/zone-pivot-groups.yml @@ -0,0 +1,10 @@ +# YamlMime:ZonePivotGroups +groups: +- id: install-azps-windows + title: Install Azure PowerShell on Windows + prompt: Choose an installation method + pivots: + - id: windows-psgallery + title: PowerShell Gallery + - id: windows-msi + title: MSI Installer diff --git a/mapping/az-groupMapping-10.1.0.json b/mapping/az-groupMapping-10.1.0.json new file mode 100644 index 0000000000..b91a1cd189 --- /dev/null +++ b/mapping/az-groupMapping-10.1.0.json @@ -0,0 +1,6201 @@ +{ + "Update-AzPrometheusRuleGroup": "Alerts Management", + "Get-AzAlert": "Alerts Management", + "Remove-AzPrometheusRuleGroup": "Alerts Management", + "Get-AzAlertObjectHistory": "Alerts Management", + "Update-AzAlertState": "Alerts Management", + "New-AzPrometheusRuleObject": "Alerts Management", + "Get-AzAlertProcessingRule": "Alerts Management", + "New-AzPrometheusRuleGroupActionObject": "Alerts Management", + "Update-AzAlertProcessingRule": "Alerts Management", + "Measure-AzAlertStatistic": "Alerts Management", + "Update-AzSmartGroupState": "Alerts Management", + "Remove-AzAlertProcessingRule": "Alerts Management", + "Get-AzPrometheusRuleGroup": "Alerts Management", + "New-AzPrometheusRuleGroup": "Alerts Management", + "Get-AzSmartGroupHistory": "Alerts Management", + "Set-AzAlertProcessingRule": "Alerts Management", + "Get-AzSmartGroup": "Alerts Management", + "Reset-AzRedisCache": "Redis Cache", + "Get-AzRedisCacheLink": "Redis Cache", + "Remove-AzRedisCachePatchSchedule": "Redis Cache", + "Export-AzRedisCache": "Redis Cache", + "Set-AzRedisCache": "Redis Cache", + "Get-AzRedisCache": "Redis Cache", + "New-AzRedisCacheFirewallRule": "Redis Cache", + "New-AzRedisCachePatchSchedule": "Redis Cache", + "New-AzRedisCacheKey": "Redis Cache", + "Get-AzRedisCacheKey": "Redis Cache", + "Import-AzRedisCache": "Redis Cache", + "Get-AzRedisCacheFirewallRule": "Redis Cache", + "Remove-AzRedisCacheLink": "Redis Cache", + "Remove-AzRedisCacheFirewallRule": "Redis Cache", + "New-AzRedisCacheLink": "Redis Cache", + "New-AzRedisCacheScheduleEntry": "Redis Cache", + "New-AzRedisCache": "Redis Cache", + "Set-AzRedisCacheDiagnostic": "Redis Cache", + "Remove-AzRedisCacheDiagnostic": "Redis Cache", + "Get-AzRedisCachePatchSchedule": "Redis Cache", + "Remove-AzRedisCache": "Redis Cache", + "New-AzEdgeOrderItem": "EdgeOrder", + "New-AzEdgeOrderShippingAddressObject": "EdgeOrder", + "New-AzEdgeOrderAddress": "EdgeOrder", + "Get-AzEdgeOrderProductFamily": "EdgeOrder", + "New-AzEdgeOrderHierarchyInformationObject": "EdgeOrder", + "Get-AzEdgeOrderProductFamilyMetadata": "EdgeOrder", + "New-AzEdgeOrderContactDetailsObject": "EdgeOrder", + "Remove-AzEdgeOrderItem": "EdgeOrder", + "New-AzEdgeOrderPreferencesObject": "EdgeOrder", + "Get-AzEdgeOrderItem": "EdgeOrder", + "Get-AzEdgeOrderAddress": "EdgeOrder", + "Invoke-AzEdgeOrderItemCancellation": "EdgeOrder", + "Invoke-AzEdgeOrderReturnOrderItem": "EdgeOrder", + "Get-AzEdgeOrderConfiguration": "EdgeOrder", + "New-AzEdgeOrderFilterablePropertyObject": "EdgeOrder", + "Update-AzEdgeOrderAddress": "EdgeOrder", + "Remove-AzEdgeOrderAddress": "EdgeOrder", + "New-AzEdgeOrderOrderItemDetailsObject": "EdgeOrder", + "Get-AzEdgeOrder": "EdgeOrder", + "Update-AzEdgeOrderItem": "EdgeOrder", + "New-AzFrontDoorWafRuleGroupOverrideObject": "Front Door", + "New-AzFrontDoor": "Front Door", + "New-AzFrontDoorLoadBalancingSettingObject": "Front Door", + "New-AzFrontDoorRulesEngineRuleObject": "Front Door", + "Disable-AzFrontDoorCustomDomainHttps": "Front Door", + "Get-AzFrontDoorFrontendEndpoint": "Front Door", + "New-AzFrontDoorWafManagedRuleExclusionObject": "Front Door", + "New-AzFrontDoorWafManagedRuleObject": "Front Door", + "New-AzFrontDoorRulesEngine": "Front Door", + "New-AzFrontDoorWafManagedRuleOverrideObject": "Front Door", + "Update-AzFrontDoorWafPolicy": "Front Door", + "New-AzFrontDoorRulesEngineMatchConditionObject": "Front Door", + "Remove-AzFrontDoorContent": "Front Door", + "Set-AzFrontDoorRulesEngine": "Front Door", + "Remove-AzFrontDoorRulesEngine": "Front Door", + "New-AzFrontDoorWafPolicy": "Front Door", + "New-AzFrontDoorBackendObject": "Front Door", + "New-AzFrontDoorHealthProbeSettingObject": "Front Door", + "Enable-AzFrontDoorCustomDomainHttps": "Front Door", + "New-AzFrontDoorFrontendEndpointObject": "Front Door", + "Set-AzFrontDoor": "Front Door", + "New-AzFrontDoorWafMatchConditionObject": "Front Door", + "New-AzFrontDoorBackendPoolsSettingObject": "Front Door", + "Get-AzFrontDoorRulesEngine": "Front Door", + "New-AzFrontDoorWafCustomRuleObject": "Front Door", + "New-AzFrontDoorBackendPoolObject": "Front Door", + "Get-AzFrontDoorWafPolicy": "Front Door", + "New-AzFrontDoorRoutingRuleObject": "Front Door", + "Remove-AzFrontDoor": "Front Door", + "New-AzFrontDoorHeaderActionObject": "Front Door", + "Get-AzFrontDoorWafManagedRuleSetDefinition": "Front Door", + "Get-AzFrontDoor": "Front Door", + "Remove-AzFrontDoorWafPolicy": "Front Door", + "New-AzFrontDoorRulesEngineActionObject": "Front Door", + "New-AzDeviceUpdateCheckNameAvailabilityRequestObject": "DeviceUpdate", + "New-AzDeviceUpdateAccount": "DeviceUpdate", + "Remove-AzDeviceUpdateInstance": "DeviceUpdate", + "Get-AzDeviceUpdateAccount": "DeviceUpdate", + "Test-AzDeviceUpdateNameAvailability": "DeviceUpdate", + "Remove-AzDeviceUpdateAccount": "DeviceUpdate", + "New-AzDeviceUpdateInstance": "DeviceUpdate", + "Get-AzDeviceUpdateInstance": "DeviceUpdate", + "Update-AzDeviceUpdateAccount": "DeviceUpdate", + "Update-AzDeviceUpdateInstance": "DeviceUpdate", + "Get-AzEventHubNamespace": "Event Hub", + "Remove-AzEventHubSchemaGroup": "Event Hub", + "Set-AzEventHubCluster": "Event Hub", + "New-AzEventHubConsumerGroup": "Event Hub", + "New-AzEventHubSchemaGroup": "Event Hub", + "Get-AzEventHubApplicationGroup": "Event Hub", + "Get-AzEventHubGeoDRConfiguration": "Event Hub", + "Get-AzEventHub": "Event Hub", + "Set-AzEventHubGeoDRConfigurationBreakPair": "Event Hub", + "Get-AzEventHubNetworkRuleSet": "Event Hub", + "New-AzEventHubGeoDRConfiguration": "Event Hub", + "New-AzEventHubNamespace": "Event Hub", + "Get-AzEventHubClusterNamespace": "Event Hub", + "New-AzEventHubAuthorizationRule": "Event Hub", + "Remove-AzEventHubApplicationGroup": "Event Hub", + "New-AzEventHubKeyVaultPropertiesObject": "Event Hub", + "Get-AzEventHubCluster": "Event Hub", + "New-AzEventHub": "Event Hub", + "Set-AzEventHubGeoDRConfigurationFailOver": "Event Hub", + "Set-AzEventHubNetworkRuleSet": "Event Hub", + "New-AzEventHubAuthorizationRuleSASToken": "Event Hub", + "Remove-AzEventHubGeoDRConfiguration": "Event Hub", + "Get-AzEventHubConsumerGroup": "Event Hub", + "New-AzEventHubIPRuleConfig": "Event Hub", + "Remove-AzEventHubPrivateEndpointConnection": "Event Hub", + "Set-AzEventHubConsumerGroup": "Event Hub", + "Deny-AzEventHubPrivateEndpointConnection": "Event Hub", + "Get-AzEventHubKey": "Event Hub", + "Remove-AzEventHubNamespace": "Event Hub", + "New-AzEventHubCluster": "Event Hub", + "Get-AzEventHubSchemaGroup": "Event Hub", + "Set-AzEventHub": "Event Hub", + "Set-AzEventHubAuthorizationRule": "Event Hub", + "Approve-AzEventHubPrivateEndpointConnection": "Event Hub", + "Set-AzEventHubApplicationGroup": "Event Hub", + "Get-AzEventHubPrivateEndpointConnection": "Event Hub", + "Get-AzEventHubAuthorizationRule": "Event Hub", + "Remove-AzEventHubConsumerGroup": "Event Hub", + "Test-AzEventHubName": "Event Hub", + "New-AzEventHubThrottlingPolicyConfig": "Event Hub", + "New-AzEventHubKey": "Event Hub", + "Get-AzEventHubClustersAvailableRegion": "Event Hub", + "Remove-AzEventHub": "Event Hub", + "New-AzEventHubVirtualNetworkRuleConfig": "Event Hub", + "Remove-AzEventHubCluster": "Event Hub", + "New-AzEventHubApplicationGroup": "Event Hub", + "Remove-AzEventHubAuthorizationRule": "Event Hub", + "Get-AzEventHubPrivateLink": "Event Hub", + "Set-AzEventHubNamespace": "Event Hub", + "Get-AzIotHubJob": "IotHub", + "Remove-AzIotHubConfiguration": "IotHub", + "Add-AzIotHubDeployment": "IotHub", + "Get-AzIotHubDeviceChildren": "IotHub", + "Get-AzIotHubDevice": "IotHub", + "Get-AzIotHubConnectionString": "IotHub", + "Set-AzIotHub": "IotHub", + "Add-AzIotHubDevice": "IotHub", + "Send-AzIotHubDevice2CloudMessage": "IotHub", + "Set-AzIotHubRoute": "IotHub", + "Add-AzIotHubMessageEnrichment": "IotHub", + "Add-AzIotHubDeviceChildren": "IotHub", + "Get-AzIotHubMessageEnrichment": "IotHub", + "New-AzIotHubKey": "IotHub", + "Add-AzIotHubModule": "IotHub", + "Invoke-AzIotHubDeviceMethod": "IotHub", + "Add-AzIotHubRoute": "IotHub", + "Get-AzIotHubDeployment": "IotHub", + "Remove-AzIotHubCertificate": "IotHub", + "Get-AzIotHub": "IotHub", + "Get-AzIotHubDeviceConnectionString": "IotHub", + "Add-AzIotHubCertificate": "IotHub", + "Set-AzIotHubDistributedTracing": "IotHub", + "Remove-AzIotHubEventHubConsumerGroup": "IotHub", + "Invoke-AzIotHubManualFailover": "IotHub", + "Get-AzIotHubDeviceTwin": "IotHub", + "Add-AzIotHubConfiguration": "IotHub", + "Set-AzIotHubDeployment": "IotHub", + "Get-AzIotHubRoute": "IotHub", + "Get-AzIotHubValidSku": "IotHub", + "Get-AzIotHubCertificateVerificationCode": "IotHub", + "Remove-AzIotHubKey": "IotHub", + "Get-AzIotHubModuleTwin": "IotHub", + "Remove-AzIotHubDevice": "IotHub", + "Set-AzIotHubDevice": "IotHub", + "Add-AzIotHubRoutingEndpoint": "IotHub", + "Get-AzIotHubConfiguration": "IotHub", + "Get-AzIotHubDistributedTracing": "IotHub", + "New-AzIotHubExportDevice": "IotHub", + "Get-AzIotHubModule": "IotHub", + "Set-AzIotHubDeviceParent": "IotHub", + "Get-AzIotHubRoutingEndpoint": "IotHub", + "New-AzIotHubSasToken": "IotHub", + "Get-AzIotHubKey": "IotHub", + "Set-AzIotHubModule": "IotHub", + "Get-AzIotHubRegistryStatistic": "IotHub", + "Set-AzIotHubMessageEnrichment": "IotHub", + "Invoke-AzIotHubDeploymentMetricsQuery": "IotHub", + "Get-AzIotHubEventHubConsumerGroup": "IotHub", + "Update-AzIotHubModuleTwin": "IotHub", + "Add-AzIotHubEventHubConsumerGroup": "IotHub", + "New-AzIotHubImportDevice": "IotHub", + "Get-AzIotHubCertificate": "IotHub", + "Get-AzIotHubDeviceParent": "IotHub", + "Add-AzIotHubKey": "IotHub", + "Get-AzIotHubQuotaMetric": "IotHub", + "Remove-AzIotHubMessageEnrichment": "IotHub", + "Remove-AzIotHubRoute": "IotHub", + "Remove-AzIotHubDeployment": "IotHub", + "Test-AzIotHubRoute": "IotHub", + "Invoke-AzIotHubQuery": "IotHub", + "Set-AzIotHubConfiguration": "IotHub", + "Remove-AzIotHubModule": "IotHub", + "Remove-AzIotHubDeviceChildren": "IotHub", + "New-AzIotHub": "IotHub", + "Get-AzIotHubModuleConnectionString": "IotHub", + "Invoke-AzIotHubModuleMethod": "IotHub", + "Remove-AzIotHubRoutingEndpoint": "IotHub", + "Remove-AzIotHub": "IotHub", + "Update-AzIotHub": "IotHub", + "Invoke-AzIotHubConfigurationMetricsQuery": "IotHub", + "Set-AzIotHubVerifiedCertificate": "IotHub", + "Update-AzIotHubDeviceTwin": "IotHub", + "Set-AzIotHubEdgeModule": "IotHub", + "Stop-AzMarketplaceTerms": "Marketplace Ordering", + "Get-AzMarketplaceTerms": "Marketplace Ordering", + "Set-AzMarketplaceTerms": "Marketplace Ordering", + "Invoke-AzMarketplaceSignTerms": "Marketplace Ordering", + "Get-AzLabServicesLabForVM": "Lab Services", + "Start-AzLabServicesUserVM": "Lab Services", + "Reset-AzLabServicesVMPassword": "Lab Services", + "Update-AzLabServicesQuota": "Lab Services", + "New-AzLabServicesLabPlan": "Lab Services", + "Add-AzLabServicesUserQuota": "Lab Services", + "Update-AzLabServicesVMReimage": "Lab Services", + "Get-AzLabServicesSchedule": "Lab Services", + "Get-AzLabServicesTemplateVM": "Lab Services", + "Update-AzLabServicesUser": "Lab Services", + "Update-AzLabServicesSchedule": "Lab Services", + "Start-AzLabServicesVM": "Lab Services", + "Remove-AzLabServicesLab": "Lab Services", + "New-AzLabServicesLab": "Lab Services", + "Get-AzLabServicesPlanImage": "Lab Services", + "Remove-AzLabServicesSchedule": "Lab Services", + "Get-AzLabServicesLab": "Lab Services", + "Sync-AzLabServicesLabUser": "Lab Services", + "Publish-AzLabServicesLab": "Lab Services", + "Remove-AzLabServicesUser": "Lab Services", + "Send-AzLabServicesUserInvite": "Lab Services", + "Update-AzLabServicesLab": "Lab Services", + "Get-AzLabServicesVM": "Lab Services", + "Stop-AzLabServicesVM": "Lab Services", + "Remove-AzLabServicesLabPlan": "Lab Services", + "Stop-AzLabServicesUserVM": "Lab Services", + "Update-AzLabServicesLabPlan": "Lab Services", + "New-AzLabServicesSchedule": "Lab Services", + "Save-AzLabServicesLabPlanImage": "Lab Services", + "New-AzLabServicesUser": "Lab Services", + "Update-AzLabServicesPlanImage": "Lab Services", + "Get-AzLabServicesUserVM": "Lab Services", + "Start-AzLabServicesVMRedeployment": "Lab Services", + "Get-AzLabServicesUser": "Lab Services", + "Get-AzLabServicesLabPlan": "Lab Services", + "Remove-AzVoiceServicesCommunicationsTestLine": "VoiceServices", + "Remove-AzVoiceServicesCommunicationsGateway": "VoiceServices", + "New-AzVoiceServicesCommunicationsGatewayServiceRegionObject": "VoiceServices", + "Update-AzVoiceServicesCommunicationsGateway": "VoiceServices", + "Update-AzVoiceServicesCommunicationsTestLine": "VoiceServices", + "New-AzVoiceServicesCommunicationsTestLine": "VoiceServices", + "New-AzVoiceServicesCommunicationsGateway": "VoiceServices", + "Get-AzVoiceServicesCommunicationsGateway": "VoiceServices", + "Test-AzVoiceServicesNameAvailability": "VoiceServices", + "Get-AzVoiceServicesCommunicationsTestLine": "VoiceServices", + "New-AzGrafanaMonitorWorkspaceIntegrationObject": "Dashboard", + "Get-AzGrafana": "Dashboard", + "Remove-AzGrafana": "Dashboard", + "New-AzGrafana": "Dashboard", + "Update-AzGrafana": "Dashboard", + "Get-AzEnrollmentAccount": "Billing", + "Get-AzConsumptionMarketplace": "Billing", + "Set-AzConsumptionBudget": "Billing", + "Get-AzConsumptionUsageDetail": "Billing", + "Get-AzConsumptionBudget": "Billing", + "Get-UsageAggregates": "Billing", + "New-AzConsumptionBudget": "Billing", + "Get-AzConsumptionPriceSheet": "Billing", + "Get-AzConsumptionReservationSummary": "Billing", + "Get-AzBillingInvoice": "Billing", + "Get-AzBillingProfile": "Billing", + "Get-AzInvoiceSection": "Billing", + "Get-AzBillingPeriod": "Billing", + "Get-AzConsumptionReservationDetail": "Billing", + "Remove-AzConsumptionBudget": "Billing", + "Get-AzBillingAccount": "Billing", + "Set-AzCurrentStorageAccount": "Storage", + "New-AzStorageBlobQueryConfig": "Storage", + "Set-AzStorageBlobTag": "Storage", + "Invoke-AzStorageAccountFailover": "Storage", + "Enable-AzStorageContainerDeleteRetentionPolicy": "Storage", + "Remove-AzStorageDirectory": "Storage", + "Remove-AzStorageShare": "Storage", + "Set-AzRmStorageContainerImmutabilityPolicy": "Storage", + "Stop-AzStorageFileCopy": "Storage", + "Move-AzDataLakeGen2Item": "Storage", + "Remove-AzStorageQueueStoredAccessPolicy": "Storage", + "Get-AzStorageCORSRule": "Storage", + "Restore-AzStorageBlobRange": "Storage", + "Get-AzDataLakeGen2ItemContent": "Storage", + "New-AzStorageShareStoredAccessPolicy": "Storage", + "Start-AzStorageFileCopy": "Storage", + "Set-AzStorageQueueStoredAccessPolicy": "Storage", + "Set-AzStorageBlobContent": "Storage", + "Get-AzStorageAccountManagementPolicy": "Storage", + "New-AzStorageAccountManagementPolicyBlobIndexMatchObject": "Storage", + "Set-AzStorageContainerAcl": "Storage", + "Remove-AzStorageCORSRule": "Storage", + "New-AzStorageBlobSASToken": "Storage", + "New-AzStorageBlobRangeToRestore": "Storage", + "Get-AzStorageBlobCopyState": "Storage", + "Remove-AzStorageAccountNetworkRule": "Storage", + "Get-AzStorageAccountNetworkRuleSet": "Storage", + "Get-AzStorageFileServiceProperty": "Storage", + "Remove-AzStorageQueue": "Storage", + "Invoke-AzRmStorageContainerImmutableStorageWithVersioningMigration": "Storage", + "Remove-AzStorageAccountManagementPolicy": "Storage", + "New-AzStorageLocalUserSshPublicKey": "Storage", + "Enable-AzStorageBlobLastAccessTimeTracking": "Storage", + "Remove-AzDataLakeGen2AclRecursive": "Storage", + "Get-AzStorageTable": "Storage", + "New-AzStorageShareSASToken": "Storage", + "Close-AzStorageFileHandle": "Storage", + "New-AzStorageAccountManagementPolicyRule": "Storage", + "Remove-AzStorageBlobInventoryPolicy": "Storage", + "New-AzStorageContainerStoredAccessPolicy": "Storage", + "Start-AzStorageBlobCopy": "Storage", + "New-AzDataLakeGen2SasToken": "Storage", + "Disable-AzStorageBlobRestorePolicy": "Storage", + "New-AzStorageAccountManagementPolicyFilter": "Storage", + "Get-AzStorageAccountNameAvailability": "Storage", + "Remove-AzRmStorageContainerLegalHold": "Storage", + "New-AzRmStorageShare": "Storage", + "Enable-AzStorageBlobDeleteRetentionPolicy": "Storage", + "Set-AzStorageAccount": "Storage", + "Enable-AzStorageStaticWebsite": "Storage", + "Set-AzStorageAccountManagementPolicy": "Storage", + "Get-AzStorageBlobByTag": "Storage", + "Get-AzStorageEncryptionScope": "Storage", + "New-AzStorageObjectReplicationPolicyRule": "Storage", + "Remove-AzStorageShareStoredAccessPolicy": "Storage", + "New-AzStorageAccountSASToken": "Storage", + "Add-AzStorageAccountNetworkRule": "Storage", + "New-AzStorageLocalUserSshPassword": "Storage", + "Get-AzDataLakeGen2DeletedItem": "Storage", + "Disable-AzStorageDeleteRetentionPolicy": "Storage", + "Rename-AzStorageDirectory": "Storage", + "Remove-AzDataLakeGen2Item": "Storage", + "Get-AzStorageContainer": "Storage", + "Get-AzStorageQueue": "Storage", + "Update-AzRmStorageShare": "Storage", + "Disable-AzStorageBlobDeleteRetentionPolicy": "Storage", + "Set-AzDataLakeGen2AclRecursive": "Storage", + "New-AzStorageAccountKey": "Storage", + "Set-AzStorageBlobImmutabilityPolicy": "Storage", + "Restore-AzStorageContainer": "Storage", + "Get-AzStorageBlobInventoryPolicy": "Storage", + "Get-AzStorageServiceMetricsProperty": "Storage", + "Remove-AzStorageFile": "Storage", + "New-AzStorageFileSASToken": "Storage", + "Update-AzStorageEncryptionScope": "Storage", + "Revoke-AzStorageAccountUserDelegationKeys": "Storage", + "Remove-AzStorageTableStoredAccessPolicy": "Storage", + "Get-AzStorageBlob": "Storage", + "Lock-AzRmStorageContainerImmutabilityPolicy": "Storage", + "Remove-AzStorageTable": "Storage", + "Set-AzStorageShareStoredAccessPolicy": "Storage", + "Get-AzRmStorageContainer": "Storage", + "Update-AzStorageServiceProperty": "Storage", + "New-AzRmStorageContainer": "Storage", + "New-AzStorageEncryptionScope": "Storage", + "Get-AzStorageObjectReplicationPolicy": "Storage", + "New-AzStorageQueue": "Storage", + "Set-AzStorageFileContent": "Storage", + "Update-AzStorageBlobServiceProperty": "Storage", + "Get-AzStorageTableStoredAccessPolicy": "Storage", + "Get-AzStorageShare": "Storage", + "Remove-AzStorageLocalUser": "Storage", + "Remove-AzStorageObjectReplicationPolicy": "Storage", + "New-AzStorageDirectory": "Storage", + "Get-AzStorageQueueStoredAccessPolicy": "Storage", + "New-AzStorageShare": "Storage", + "New-AzStorageQueueSASToken": "Storage", + "New-AzStorageContainerSASToken": "Storage", + "Remove-AzRmStorageContainer": "Storage", + "Update-AzStorageAccountNetworkRuleSet": "Storage", + "Get-AzStorageBlobServiceProperty": "Storage", + "Set-AzDataLakeGen2ItemAclObject": "Storage", + "Get-AzStorageAccount": "Storage", + "Set-AzStorageCORSRule": "Storage", + "Get-AzStorageBlobQueryResult": "Storage", + "Remove-AzStorageContainer": "Storage", + "New-AzStorageContext": "Storage", + "Remove-AzStorageBlobImmutabilityPolicy": "Storage", + "Set-AzStorageBlobLegalHold": "Storage", + "Add-AzStorageAccountManagementPolicyAction": "Storage", + "Enable-AzStorageBlobRestorePolicy": "Storage", + "Disable-AzStorageBlobLastAccessTimeTracking": "Storage", + "Set-AzStorageLocalUser": "Storage", + "Get-AzStorageFileHandle": "Storage", + "Get-AzRmStorageContainerImmutabilityPolicy": "Storage", + "Set-AzStorageBlobInventoryPolicy": "Storage", + "New-AzStorageTableStoredAccessPolicy": "Storage", + "Invoke-AzStorageAccountHierarchicalNamespaceUpgrade": "Storage", + "Disable-AzStorageContainerDeleteRetentionPolicy": "Storage", + "Remove-AzStorageBlob": "Storage", + "Get-AzRmStorageShare": "Storage", + "Get-AzStorageUsage": "Storage", + "Remove-AzRmStorageShare": "Storage", + "Stop-AzStorageBlobCopy": "Storage", + "New-AzStorageTableSASToken": "Storage", + "Update-AzDataLakeGen2Item": "Storage", + "New-AzStorageQueueStoredAccessPolicy": "Storage", + "New-AzStorageTable": "Storage", + "Set-AzStorageServiceLoggingProperty": "Storage", + "Get-AzStorageLocalUserKey": "Storage", + "Update-AzDataLakeGen2AclRecursive": "Storage", + "Start-AzStorageBlobIncrementalCopy": "Storage", + "Get-AzStorageFile": "Storage", + "New-AzStorageAccount": "Storage", + "Restore-AzRmStorageShare": "Storage", + "Get-AzStorageShareStoredAccessPolicy": "Storage", + "Set-AzStorageTableStoredAccessPolicy": "Storage", + "Get-AzDataLakeGen2ChildItem": "Storage", + "Get-AzStorageFileCopyState": "Storage", + "Set-AzStorageServiceMetricsProperty": "Storage", + "Get-AzStorageFileContent": "Storage", + "Set-AzStorageContainerStoredAccessPolicy": "Storage", + "Get-AzStorageBlobContent": "Storage", + "Get-AzDataLakeGen2Item": "Storage", + "Enable-AzStorageDeleteRetentionPolicy": "Storage", + "Get-AzStorageBlobTag": "Storage", + "New-AzStorageBlobInventoryPolicyRule": "Storage", + "Get-AzStorageAccountKey": "Storage", + "Remove-AzRmStorageContainerImmutabilityPolicy": "Storage", + "Get-AzStorageServiceProperty": "Storage", + "Get-AzStorageContainerStoredAccessPolicy": "Storage", + "Disable-AzStorageStaticWebsite": "Storage", + "Set-AzStorageShareQuota": "Storage", + "Update-AzStorageFileServiceProperty": "Storage", + "New-AzStorageLocalUserPermissionScope": "Storage", + "Copy-AzStorageBlob": "Storage", + "Restore-AzDataLakeGen2DeletedItem": "Storage", + "Rename-AzStorageFile": "Storage", + "New-AzDataLakeGen2Item": "Storage", + "Set-AzStorageObjectReplicationPolicy": "Storage", + "Add-AzRmStorageContainerLegalHold": "Storage", + "Get-AzStorageLocalUser": "Storage", + "Stop-AzStorageAccountHierarchicalNamespaceUpgrade": "Storage", + "Get-AzStorageServiceLoggingProperty": "Storage", + "Update-AzRmStorageContainer": "Storage", + "Remove-AzStorageAccount": "Storage", + "New-AzStorageContainer": "Storage", + "Remove-AzStorageContainerStoredAccessPolicy": "Storage", + "Update-AzContainerRegistryWebhook": "Container Registry", + "New-AzContainerRegistryIPRuleObject": "Container Registry", + "Remove-AzContainerRegistryAgentPool": "Container Registry", + "New-AzContainerRegistryImportPipeline": "Container Registry", + "Update-AzContainerRegistryAgentPool": "Container Registry", + "Get-AzContainerRegistryManifest": "Container Registry", + "Update-AzContainerRegistryTag": "Container Registry", + "Remove-AzContainerRegistryReplication": "Container Registry", + "Update-AzContainerRegistryManifest": "Container Registry", + "Get-AzContainerRegistryWebhookEvent": "Container Registry", + "Get-AzContainerRegistryToken": "Container Registry", + "New-AzContainerRegistryAgentPool": "Container Registry", + "New-AzContainerRegistryExportPipeline": "Container Registry", + "Remove-AzContainerRegistryManifest": "Container Registry", + "Get-AzContainerRegistryReplication": "Container Registry", + "Remove-AzContainerRegistryRepository": "Container Registry", + "New-AzContainerRegistryReplication": "Container Registry", + "Test-AzContainerRegistryWebhook": "Container Registry", + "Get-AzContainerRegistryAgentPool": "Container Registry", + "New-AzContainerRegistryToken": "Container Registry", + "Get-AzContainerRegistryUsage": "Container Registry", + "Remove-AzContainerRegistryExportPipeline": "Container Registry", + "Update-AzContainerRegistry": "Container Registry", + "Test-AzContainerRegistryNameAvailability": "Container Registry", + "Get-AzContainerRegistryCredential": "Container Registry", + "Get-AzContainerRegistryWebhookCallbackConfig": "Container Registry", + "Connect-AzContainerRegistry": "Container Registry", + "Remove-AzContainerRegistryScopeMap": "Container Registry", + "Remove-AzContainerRegistryToken": "Container Registry", + "New-AzContainerRegistry": "Container Registry", + "New-AzContainerRegistryScopeMap": "Container Registry", + "Get-AzContainerRegistryWebhook": "Container Registry", + "Get-AzContainerRegistryImportPipeline": "Container Registry", + "Update-AzContainerRegistryCredential": "Container Registry", + "Remove-AzContainerRegistry": "Container Registry", + "Get-AzContainerRegistryAgentPoolQueueStatus": "Container Registry", + "Update-AzContainerRegistryScopeMap": "Container Registry", + "Get-AzContainerRegistryRepository": "Container Registry", + "Update-AzContainerRegistryToken": "Container Registry", + "Remove-AzContainerRegistryWebhook": "Container Registry", + "Get-AzContainerRegistryExportPipeline": "Container Registry", + "Get-AzContainerRegistryTag": "Container Registry", + "Remove-AzContainerRegistryTag": "Container Registry", + "Import-AzContainerRegistryImage": "Container Registry", + "Get-AzContainerRegistryScopeMap": "Container Registry", + "New-AzContainerRegistryWebhook": "Container Registry", + "Remove-AzContainerRegistryImportPipeline": "Container Registry", + "Get-AzContainerRegistry": "Container Registry", + "Update-AzContainerRegistryRepository": "Container Registry", + "Get-AzRedisEnterpriseCacheOperationStatus": "Redis Enterprise", + "New-AzRedisEnterpriseCacheKey": "Redis Enterprise", + "Update-AzRedisEnterpriseCacheDatabase": "Redis Enterprise", + "Update-AzRedisEnterpriseCache": "Redis Enterprise", + "New-AzRedisEnterpriseCache": "Redis Enterprise", + "Remove-AzRedisEnterpriseCache": "Redis Enterprise", + "Import-AzRedisEnterpriseCache": "Redis Enterprise", + "New-AzRedisEnterpriseCacheDatabase": "Redis Enterprise", + "Remove-AzRedisEnterpriseCacheDatabase": "Redis Enterprise", + "Get-AzRedisEnterpriseCacheKey": "Redis Enterprise", + "Invoke-AzRedisEnterpriseCacheForceDatabaseUnlink": "Redis Enterprise", + "Invoke-AzRedisEnterpriseCacheDatabaseFlush": "Redis Enterprise", + "Get-AzRedisEnterpriseCache": "Redis Enterprise", + "Export-AzRedisEnterpriseCache": "Redis Enterprise", + "Get-AzRedisEnterpriseCacheDatabase": "Redis Enterprise", + "New-AzSqlVM": "Sql VM", + "New-AzAvailabilityGroupListener": "Sql VM", + "New-AzSqlVMGroup": "Sql VM", + "New-AzSqlVirtualMachineAgReplicaObject": "Sql VM", + "Get-AzSqlVM": "Sql VM", + "Invoke-AzSqlVMTroubleshoot": "Sql VM", + "Start-AzSqlVMAssessment": "Sql VM", + "Remove-AzSqlVM": "Sql VM", + "Remove-AzSqlVMGroup": "Sql VM", + "Update-AzSqlVMGroup": "Sql VM", + "Update-AzSqlVM": "Sql VM", + "Remove-AzAvailabilityGroupListener": "Sql VM", + "New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject": "Sql VM", + "Invoke-AzRedeploySqlVM": "Sql VM", + "Get-AzSqlVMGroup": "Sql VM", + "Get-AzAvailabilityGroupListener": "Sql VM", + "New-AzElasticSanVolume": "ElasticSan", + "Update-AzElasticSanVolume": "ElasticSan", + "Remove-AzElasticSanVolumeGroup": "ElasticSan", + "Add-AzElasticSanVolumeGroupNetworkRule": "ElasticSan", + "Update-AzElasticSanVolumeGroup": "ElasticSan", + "Get-AzElasticSanSkuList": "ElasticSan", + "Remove-AzElasticSanVolume": "ElasticSan", + "Remove-AzElasticSan": "ElasticSan", + "New-AzElasticSanVolumeGroup": "ElasticSan", + "Get-AzElasticSanVolumeGroup": "ElasticSan", + "Get-AzElasticSan": "ElasticSan", + "Update-AzElasticSan": "ElasticSan", + "New-AzElasticSanVirtualNetworkRuleObject": "ElasticSan", + "New-AzElasticSan": "ElasticSan", + "Remove-AzElasticSanVolumeGroupNetworkRule": "ElasticSan", + "Get-AzElasticSanVolume": "ElasticSan", + "Suspend-AzAutomationJob": "Automation", + "Stop-AzAutomationJob": "Automation", + "New-AzAutomationSourceControl": "Automation", + "Get-AzAutomationSourceControl": "Automation", + "Get-AzAutomationDscCompilationJobOutput": "Automation", + "Get-AzAutomationScheduledRunbook": "Automation", + "Move-AzAutomationHybridRunbookWorker": "Automation", + "Get-AzAutomationDscNode": "Automation", + "Unregister-AzAutomationDscNode": "Automation", + "Set-AzAutomationHybridRunbookWorkerGroup": "Automation", + "Set-AzAutomationAccount": "Automation", + "Remove-AzAutomationCredential": "Automation", + "Get-AzAutomationCredential": "Automation", + "Get-AzAutomationJobOutputRecord": "Automation", + "Get-AzAutomationJob": "Automation", + "Get-AzAutomationSoftwareUpdateMachineRun": "Automation", + "Unregister-AzAutomationScheduledRunbook": "Automation", + "Get-AzAutomationHybridRunbookWorker": "Automation", + "Set-AzAutomationRunbook": "Automation", + "Get-AzAutomationConnection": "Automation", + "Remove-AzAutomationRunbook": "Automation", + "Get-AzAutomationHybridWorkerGroup": "Automation", + "Export-AzAutomationDscConfiguration": "Automation", + "Remove-AzAutomationSchedule": "Automation", + "Get-AzAutomationPython3Package": "Automation", + "Stop-AzAutomationDscNodeConfigurationDeployment": "Automation", + "Import-AzAutomationDscNodeConfiguration": "Automation", + "Update-AzAutomationSourceControl": "Automation", + "Get-AzAutomationVariable": "Automation", + "Remove-AzAutomationDscConfiguration": "Automation", + "Remove-AzAutomationModule": "Automation", + "Set-AzAutomationDscNode": "Automation", + "Get-AzAutomationSourceControlSyncJobOutput": "Automation", + "New-AzAutomationSchedule": "Automation", + "New-AzAutomationSoftwareUpdateConfiguration": "Automation", + "Start-AzAutomationDscNodeConfigurationDeployment": "Automation", + "Get-AzAutomationSourceControlSyncJob": "Automation", + "Get-AzAutomationSoftwareUpdateConfiguration": "Automation", + "Remove-AzAutomationConnection": "Automation", + "Remove-AzAutomationCertificate": "Automation", + "Remove-AzAutomationHybridRunbookWorkerGroup": "Automation", + "New-AzAutomationAccount": "Automation", + "Remove-AzAutomationWebhook": "Automation", + "Get-AzAutomationDscNodeConfiguration": "Automation", + "New-AzAutomationCertificate": "Automation", + "Get-AzAutomationDscNodeConfigurationDeployment": "Automation", + "Remove-AzAutomationHybridRunbookWorker": "Automation", + "New-AzAutomationHybridRunbookWorkerGroup": "Automation", + "Export-AzAutomationDscNodeReportContent": "Automation", + "Import-AzAutomationRunbook": "Automation", + "Get-AzAutomationDscNodeConfigurationDeploymentSchedule": "Automation", + "Get-AzAutomationDscNodeReport": "Automation", + "Get-AzAutomationJobOutput": "Automation", + "Export-AzAutomationRunbook": "Automation", + "Set-AzAutomationCertificate": "Automation", + "Get-AzAutomationSchedule": "Automation", + "Set-AzAutomationConnectionFieldValue": "Automation", + "New-AzAutomationCredential": "Automation", + "Remove-AzAutomationPython3Package": "Automation", + "Register-AzAutomationScheduledRunbook": "Automation", + "Get-AzAutomationHybridRunbookWorkerGroup": "Automation", + "New-AzAutomationUpdateManagementAzureQuery": "Automation", + "Get-AzAutomationWebhook": "Automation", + "New-AzAutomationHybridRunbookWorker": "Automation", + "Remove-AzAutomationSourceControl": "Automation", + "New-AzAutomationRunbook": "Automation", + "Get-AzAutomationRunbook": "Automation", + "New-AzAutomationVariable": "Automation", + "Get-AzAutomationAccount": "Automation", + "New-AzAutomationPython3Package": "Automation", + "Get-AzAutomationSoftwareUpdateRun": "Automation", + "Start-AzAutomationRunbook": "Automation", + "Get-AzAutomationDscOnboardingMetaconfig": "Automation", + "Get-AzAutomationDscCompilationJob": "Automation", + "Remove-AzAutomationDscNodeConfiguration": "Automation", + "Get-AzAutomationRegistrationInfo": "Automation", + "New-AzAutomationConnection": "Automation", + "New-AzAutomationKey": "Automation", + "Set-AzAutomationCredential": "Automation", + "Resume-AzAutomationJob": "Automation", + "Remove-AzAutomationConnectionType": "Automation", + "Set-AzAutomationPython3Package": "Automation", + "Remove-AzAutomationAccount": "Automation", + "Set-AzAutomationVariable": "Automation", + "Set-AzAutomationSchedule": "Automation", + "New-AzAutomationWebhook": "Automation", + "Register-AzAutomationDscNode": "Automation", + "Start-AzAutomationDscCompilationJob": "Automation", + "Publish-AzAutomationRunbook": "Automation", + "Start-AzAutomationSourceControlSyncJob": "Automation", + "Import-AzAutomationDscConfiguration": "Automation", + "Set-AzAutomationModule": "Automation", + "Get-AzAutomationCertificate": "Automation", + "Get-AzAutomationModule": "Automation", + "Get-AzAutomationDscConfiguration": "Automation", + "Set-AzAutomationWebhook": "Automation", + "Remove-AzAutomationVariable": "Automation", + "Remove-AzAutomationHybridWorkerGroup": "Automation", + "New-AzAutomationModule": "Automation", + "Remove-AzAutomationSoftwareUpdateConfiguration": "Automation", + "Remove-AzDnsResolverOutboundEndpoint": "DNS", + "Remove-AzDnsResolver": "DNS", + "Update-AzDnsForwardingRulesetVirtualNetworkLink": "Virtual Network", + "New-AzDnsResolver": "DNS", + "New-AzDnsResolverTargetDnsServerObject": "DNS", + "Get-AzDnsForwardingRulesetForwardingRule": "DNS", + "Get-AzDnsResolverInboundEndpoint": "DNS", + "Remove-AzDnsForwardingRulesetForwardingRule": "DNS", + "Remove-AzDnsForwardingRuleset": "DNS", + "Update-AzDnsResolverOutboundEndpoint": "DNS", + "Update-AzDnsForwardingRuleset": "DNS", + "New-AzDnsForwardingRulesetVirtualNetworkLink": "Virtual Network", + "New-AzDnsResolverOutboundEndpoint": "DNS", + "Update-AzDnsResolverInboundEndpoint": "DNS", + "Remove-AzDnsForwardingRulesetVirtualNetworkLink": "Virtual Network", + "Get-AzDnsResolver": "DNS", + "Get-AzDnsForwardingRulesetVirtualNetworkLink": "Virtual Network", + "Get-AzDnsResolverOutboundEndpoint": "DNS", + "New-AzDnsForwardingRuleset": "DNS", + "New-AzDnsForwardingRulesetForwardingRule": "DNS", + "Update-AzDnsResolver": "DNS", + "New-AzDnsResolverIPConfigurationObject": "DNS", + "Get-AzDnsForwardingRuleset": "DNS", + "Update-AzDnsForwardingRulesetForwardingRule": "DNS", + "New-AzDnsResolverInboundEndpoint": "DNS", + "Remove-AzDnsResolverInboundEndpoint": "DNS", + "Get-AzCustomLocation": "CustomLocation", + "Remove-AzCustomLocation": "CustomLocation", + "Update-AzCustomLocation": "CustomLocation", + "New-AzCustomLocation": "CustomLocation", + "Get-AzCustomLocationEnabledResourceType": "CustomLocation", + "Remove-AzMonitorLogAnalyticsSolution": "Monitoring Solutions", + "Update-AzMonitorLogAnalyticsSolution": "Monitoring Solutions", + "New-AzMonitorLogAnalyticsSolution": "Monitoring Solutions", + "Get-AzMonitorLogAnalyticsSolution": "Monitoring Solutions", + "New-AzBillingBenefitsReservationOrderAlias": "BillingBenefits", + "New-AzBillingBenefitsSavingsPlanOrderAlias": "BillingBenefits", + "Get-AzBillingBenefitsSavingsPlan": "BillingBenefits", + "Get-AzBillingBenefitsSavingsPlanOrder": "BillingBenefits", + "Invoke-AzBillingBenefitsSavingsPlanPurchaseValidation": "BillingBenefits", + "Invoke-AzBillingBenefitsElevateSavingPlanOrder": "BillingBenefits", + "Get-AzBillingBenefitsSavingsPlanList": "BillingBenefits", + "Get-AzBillingBenefitsSavingsPlanOrderAlias": "BillingBenefits", + "Invoke-AzBillingBenefitsSavingsPlanUpdateValidation": "BillingBenefits", + "Get-AzBillingBenefitsReservationOrderAlias": "BillingBenefits", + "Update-AzBillingBenefitsSavingsPlan": "BillingBenefits", + "Get-AzVM": "Virtual Machines", + "Get-AzGalleryImageDefinition": "VM Images", + "New-AzHost": "Virtual Machines", + "Update-AzRestorePointCollection": "Virtual Machines", + "Get-AzVMCustomScriptExtension": "VM Extensions", + "Set-AzVM": "Virtual Machines", + "Set-AzVMOSDisk": "VM Disks", + "Get-AzVmssVM": "VM Scale Sets", + "Remove-AzVmssExtension": "VM Scale Sets", + "Remove-AzDiskEncryptionSet": "VM Disks", + "Add-AzVmssWinRMListener": "VM Scale Sets", + "Get-AzVMSize": "Virtual Machines", + "Set-AzSnapshotUpdateKeyEncryptionKey": "VM Snapshots", + "Update-AzVmssInstance": "VM Scale Sets", + "Remove-AzVmssGalleryApplication": "VM Scale Sets", + "Get-AzVmssRollingUpgrade": "VM Scale Sets", + "Get-AzSshKey": "Virtual Machines", + "Set-AzVmssRollingUpgradePolicy": "VM Scale Sets", + "Remove-AzVMSqlServerExtension": "VM Extensions", + "Add-AzVmssExtension": "VM Scale Sets", + "Start-AzVmssRollingOSUpgrade": "VM Scale Sets", + "Remove-AzGalleryApplication": "Virtual Machines", + "Get-AzRestorePoint": "Virtual Machines", + "Add-AzImageDataDisk": "VM Images", + "Restart-AzVM": "Virtual Machines", + "Remove-AzVM": "Virtual Machines", + "Remove-AzVMExtension": "VM Extensions", + "Get-AzAvailabilitySet": "Virtual Machines", + "Update-AzCapacityReservationGroup": "Virtual Machines", + "Update-AzVmss": "VM Scale Sets", + "Get-AzImage": "VM Images", + "Set-AzDiskUpdateDiskEncryptionKey": "VM Disks", + "Remove-AzVMNetworkInterface": "Virtual Machines", + "Get-AzVMChefExtension": "VM Extensions", + "New-AzVmssGalleryApplication": "VM Scale Sets", + "Add-AzVMDataDisk": "VM Disks", + "Update-AzSshKey": "Virtual Machines", + "Get-AzVMRunCommand": "Virtual Machines", + "New-AzAvailabilitySet": "Virtual Machines", + "New-AzGalleryApplicationVersion": "Virtual Machines", + "Start-AzVmssRollingExtensionUpgrade": "VM Scale Sets", + "Update-AzGalleryImageVersion": "VM Images", + "New-AzImageConfig": "VM Images", + "Remove-AzVMSecret": "Virtual Machines", + "Set-AzVMDiskEncryptionExtension": "VM Disks", + "Get-AzVmss": "VM Scale Sets", + "Get-AzVmssVMRunCommand": "VM Scale Sets", + "Remove-AzVMRunCommand": "Virtual Machines", + "New-AzVmGalleryApplication": "Virtual Machines", + "Grant-AzDiskAccess": "VM Disks", + "Set-AzVMDiagnosticsExtension": "VM Extensions", + "Add-AzVmssGalleryApplication": "VM Scale Sets", + "New-AzVMSqlServerAutoBackupConfig": "Virtual Machines", + "New-AzVmssVaultCertificateConfig": "VM Scale Sets", + "Add-AzVhd": "VM VHDs", + "New-AzVM": "Virtual Machines", + "Remove-AzCapacityReservation": "Virtual Machines", + "Save-AzVMImage": "VM Images", + "Remove-AzDiskAccess": "VM Disks", + "Remove-AzVmss": "VM Scale Sets", + "New-AzCapacityReservation": "Virtual Machines", + "Update-AzCapacityReservation": "Virtual Machines", + "Update-AzDiskEncryptionSet": "VM Disks", + "Set-AzVMAccessExtension": "VM Extensions", + "Invoke-AzVmssVMRunCommand": "VM Scale Sets", + "Update-AzAvailabilitySet": "Virtual Machines", + "New-AzSshKey": "Virtual Machines", + "Get-AzSnapshot": "VM Snapshots", + "New-AzSnapshot": "VM Snapshots", + "New-AzDiskEncryptionSetConfig": "VM Disks", + "Get-AzVMImageOffer": "VM Images", + "Get-AzGalleryApplicationVersion": "Virtual Machines", + "Get-AzVMExtensionImageType": "VM Images", + "New-AzVMSqlServerKeyVaultCredentialConfig": "Virtual Machines", + "Remove-AzVmssDataDisk": "VM Scale Sets", + "Set-AzVmssBootDiagnostic": "VM Scale Sets", + "Revoke-AzSnapshotAccess": "VM Snapshots", + "Get-AzVMDscExtension": "VM Extensions", + "New-AzProximityPlacementGroup": "Virtual Machines", + "Set-AzVMOperatingSystem": "Virtual Machines", + "Add-AzVmssDataDisk": "VM Scale Sets", + "Restart-AzVmss": "VM Scale Sets", + "Set-AzVMRunCommand": "Virtual Machines", + "New-AzVmssConfig": "VM Scale Sets", + "Add-AzVmssSshPublicKey": "VM Scale Sets", + "Set-AzVmssVM": "VM Scale Sets", + "Remove-AzVmssNetworkInterfaceConfiguration": "VM Scale Sets", + "New-AzImage": "VM Images", + "Set-AzImageOsDisk": "VM Images", + "Set-AzVmssVMRunCommand": "VM Scale Sets", + "Add-AzVmssSecret": "VM Scale Sets", + "New-AzDiskPurchasePlanConfig": "VM Disks", + "Grant-AzSnapshotAccess": "VM Snapshots", + "Start-AzVmss": "VM Scale Sets", + "Add-AzVMAdditionalUnattendContent": "Virtual Machines", + "Set-AzVmssOsProfile": "VM Scale Sets", + "Remove-AzVMDiskEncryptionExtension": "VM Disks", + "Update-AzVM": "Virtual Machines", + "Remove-AzGalleryApplicationVersion": "Virtual Machines", + "Get-AzGallery": "Virtual Machines", + "Get-AzVMImage": "VM Images", + "Set-AzDiskUpdateKeyEncryptionKey": "VM Disks", + "Invoke-AzVMRunCommand": "Virtual Machines", + "Stop-AzVmssRollingUpgrade": "VM Scale Sets", + "Add-AzVmssAdditionalUnattendContent": "VM Scale Sets", + "Get-AzVmssDiskEncryption": "VM Scale Sets", + "Add-AzVMSecret": "Virtual Machines", + "Test-AzVMAEMExtension": "VM Extensions", + "Set-AzVMExtension": "VM Extensions", + "Disable-AzVMDiskEncryption": "VM Disks", + "Set-AzSnapshotImageReference": "VM Snapshots", + "Remove-AzVMAEMExtension": "VM Extensions", + "Revoke-AzDiskAccess": "VM Disks", + "Get-AzVmssSku": "VM Scale Sets", + "Export-AzLogAnalyticThrottledRequest": "Virtual Machines", + "Set-AzVmssOrchestrationServiceState": "VM Scale Sets", + "Stop-AzVmss": "VM Scale Sets", + "Set-AzVMBginfoExtension": "VM Extensions", + "Get-AzRestorePointCollection": "Virtual Machines", + "Update-AzVmssVM": "VM Scale Sets", + "Get-AzVMAEMExtension": "VM Extensions", + "Remove-AzVMChefExtension": "VM Extensions", + "Set-AzVmss": "VM Scale Sets", + "Set-AzSnapshotUpdateDiskEncryptionKey": "VM Snapshots", + "Set-AzVMChefExtension": "VM Extensions", + "Remove-AzSnapshot": "VM Snapshots", + "Remove-AzAvailabilitySet": "Virtual Machines", + "Get-AzVMSqlServerExtension": "VM Extensions", + "Set-AzVMCustomScriptExtension": "VM Extensions", + "New-AzRestorePoint": "Virtual Machines", + "Set-AzVMSqlServerExtension": "VM Extensions", + "Repair-AzVmssServiceFabricUpdateDomain": "VM Scale Sets", + "Set-AzVmssDiskEncryptionExtension": "VM Scale Sets", + "New-AzVmss": "VM Scale Sets", + "New-AzDisk": "VM Disks", + "Set-AzDiskSecurityProfile": "VM Disks", + "New-AzDiskConfig": "VM Disks", + "Remove-AzVmssVMDataDisk": "VM Scale Sets", + "Set-AzDiskKeyEncryptionKey": "VM Disks", + "Get-AzDiskEncryptionSet": "VM Disks", + "Save-AzVhd": "VM VHDs", + "Remove-AzGallery": "Virtual Machines", + "Set-AzVMUefi": "Virtual Machines", + "Remove-AzVMCustomScriptExtension": "VM Extensions", + "Update-AzDisk": "VM Disks", + "Get-AzCapacityReservation": "Virtual Machines", + "Remove-AzGalleryImageDefinition": "VM Images", + "New-AzRestorePointCollection": "Virtual Machines", + "Get-AzDiskAccess": "VM Disks", + "Remove-AzHostGroup": "Virtual Machines", + "New-AzHostGroup": "Virtual Machines", + "Set-AzDiskImageReference": "VM Images", + "New-AzVMSqlServerAutoPatchingConfig": "Virtual Machines", + "New-AzVmssIpTagConfig": "VM Scale Sets", + "New-AzVmssIpConfig": "VM Scale Sets", + "Add-AzVMNetworkInterface": "Virtual Machines", + "Set-AzVMPlan": "Virtual Machines", + "Get-AzVMExtensionImage": "VM Images", + "Get-AzGalleryImageVersion": "VM Images", + "Get-AzHost": "Virtual Machines", + "Remove-AzVMAccessExtension": "VM Extensions", + "Update-AzSnapshot": "VM Snapshots", + "Get-AzCapacityReservationGroup": "Virtual Machines", + "Set-AzVMBootDiagnostic": "Virtual Machines", + "Get-AzRemoteDesktopFile": "Virtual Machines", + "Get-AzVMDiagnosticsExtension": "VM Extensions", + "Set-AzSnapshotDiskEncryptionKey": "VM Snapshots", + "ConvertTo-AzVMManagedDisk": "VM Disks", + "Get-AzVMADDomainExtension": "VM Extensions", + "Set-AzVMDscExtension": "VM Extensions", + "Remove-AzRestorePointCollection": "Virtual Machines", + "Remove-AzVmssVMRunCommand": "VM Scale Sets", + "Set-AzVmssStorageProfile": "VM Scale Sets", + "Invoke-AzVMInstallPatch": "Virtual Machines", + "Remove-AzVMBackup": "Virtual Machines", + "New-AzDiskEncryptionSet": "VM Disks", + "Remove-AzVmssRunCommand": "VM Scale Sets", + "Remove-AzVMDiagnosticsExtension": "VM Extensions", + "Remove-AzRestorePoint": "Virtual Machines", + "New-AzGalleryApplication": "Virtual Machines", + "Add-AzVmssNetworkInterfaceConfiguration": "VM Scale Sets", + "Set-AzVMSecurityProfile": "Virtual Machines", + "Restart-AzHost": "Virtual Machines", + "New-AzDiskUpdateConfig": "VM Disks", + "Set-AzVMADDomainExtension": "VM Extensions", + "Set-AzVmssSecurityProfile": "VM Scale Sets", + "Get-AzDisk": "VM Disks", + "Remove-AzImageDataDisk": "VM Images", + "New-AzVMConfig": "Virtual Machines", + "Remove-AzDisk": "VM Disks", + "Get-AzVMDscExtensionStatus": "VM Extensions", + "Update-AzImage": "VM Images", + "Set-AzVMSourceImage": "VM Images", + "Stop-AzVM": "Virtual Machines", + "Get-AzProximityPlacementGroup": "Virtual Machines", + "Invoke-AzVMReimage": "Virtual Machines", + "Get-AzVMBootDiagnosticsData": "Virtual Machines", + "New-AzSnapshotUpdateConfig": "VM Snapshots", + "Update-AzGalleryApplication": "Virtual Machines", + "Remove-AzVmssDiagnosticsExtension": "VM Scale Sets", + "Set-AzVmssUefi": "VM Scale Sets", + "Get-AzVMImagePublisher": "VM Images", + "Set-AzVMAEMExtension": "VM Extensions", + "Get-AzVMDiskEncryptionStatus": "VM Disks", + "Add-AzVmGalleryApplication": "Virtual Machines", + "Get-AzVmssVMDiskEncryption": "VM Scale Sets", + "Get-AzVMAccessExtension": "VM Extensions", + "Add-AzVmssVMDataDisk": "VM Scale Sets", + "Get-AzVMUsage": "Virtual Machines", + "Start-AzVM": "Virtual Machines", + "Remove-AzGalleryImageVersion": "VM Images", + "Get-AzDiskEncryptionSetAssociatedResource": "VM Disks", + "Get-AzComputeResourceSku": "Virtual Machines", + "Remove-AzImage": "VM Images", + "Update-AzGalleryApplicationVersion": "Virtual Machines", + "Remove-AzSshKey": "Virtual Machines", + "Disable-AzVmssDiskEncryption": "VM Scale Sets", + "Invoke-AzVMPatchAssessment": "Virtual Machines", + "Set-AzVMDataDisk": "VM Disks", + "Get-AzGalleryApplication": "Virtual Machines", + "Get-AzVMImageSku": "VM Images", + "New-AzDiskAccess": "VM Disks", + "Publish-AzVMDscConfiguration": "Virtual Machines", + "New-AzSnapshotConfig": "VM Snapshots", + "Remove-AzCapacityReservationGroup": "Virtual Machines", + "Get-AzVMRunCommandDocument": "Virtual Machines", + "New-AzGalleryImageVersion": "VM Images", + "Set-AzSnapshotKeyEncryptionKey": "VM Snapshots", + "Update-AzGalleryImageDefinition": "VM Images", + "Set-AzVMBackupExtension": "VM Extensions", + "Add-AzVMSshPublicKey": "Virtual Machines", + "Add-AzVmssRunCommand": "VM Scale Sets", + "Remove-AzProximityPlacementGroup": "Virtual Machines", + "New-AzVMDataDisk": "VM Disks", + "Remove-AzVmGalleryApplication": "Virtual Machines", + "Get-AzHostGroup": "Virtual Machines", + "Add-AzVmssDiagnosticsExtension": "VM Scale Sets", + "New-AzCapacityReservationGroup": "Virtual Machines", + "Remove-AzVMDscExtension": "VM Extensions", + "Update-AzGallery": "Virtual Machines", + "New-AzGallery": "Virtual Machines", + "Remove-AzHost": "Virtual Machines", + "Get-AzVMExtension": "VM Extensions", + "Export-AzLogAnalyticRequestRateByInterval": "Virtual Machines", + "Remove-AzVMDataDisk": "VM Disks", + "Set-AzDiskDiskEncryptionKey": "VM Disks", + "New-AzGalleryImageDefinition": "VM Images", + "Remove-AzPortalDashboard": "Portal", + "New-AzPortalDashboard": "Portal", + "Update-AzPortalDashboard": "Portal", + "Get-AzPortalDashboard": "Portal", + "Set-AzPortalDashboard": "Portal", + "New-AzContainerAppTrafficWeightObject": "Container Apps", + "Get-AzContainerAppRevision": "Container Apps", + "Remove-AzContainerAppManagedEnv": "Container Apps", + "Get-AzContainerAppManagedEnvCert": "Container Apps", + "New-AzContainerAppRegistryCredentialObject": "Container Apps", + "Disable-AzContainerAppRevision": "Container Apps", + "Remove-AzContainerApp": "Container Apps", + "Update-AzContainerApp": "Container Apps", + "New-AzContainerAppVolumeMountObject": "Container Apps", + "New-AzContainerAppIdentityProviderObject": "Container Apps", + "Remove-AzContainerAppAuthConfig": "Container Apps", + "Get-AzContainerAppManagedEnvDaprSecret": "Container Apps", + "New-AzContainerAppCustomDomainObject": "Container Apps", + "New-AzContainerAppEnvironmentVarObject": "Container Apps", + "Get-AzContainerApp": "Container Apps", + "New-AzContainerApp": "Container Apps", + "New-AzContainerAppManagedEnv": "Container Apps", + "New-AzContainerAppScaleRuleAuthObject": "Container Apps", + "Enable-AzContainerAppRevision": "Container Apps", + "New-AzContainerAppScaleRuleObject": "Container Apps", + "New-AzContainerAppSecretObject": "Container Apps", + "Remove-AzContainerAppManagedEnvDapr": "Container Apps", + "New-AzContainerAppDaprMetadataObject": "Container Apps", + "New-AzContainerAppTemplateObject": "Container Apps", + "Get-AzContainerAppManagedEnv": "Container Apps", + "Remove-AzContainerAppManagedEnvStorage": "Container Apps", + "New-AzContainerAppVolumeObject": "Container Apps", + "Update-AzContainerAppManagedEnvCert": "Container Apps", + "Get-AzContainerAppAuthConfig": "Container Apps", + "New-AzContainerAppProbeObject": "Container Apps", + "Get-AzContainerAppSecret": "Container Apps", + "Remove-AzContainerAppManagedEnvCert": "Container Apps", + "New-AzContainerAppManagedEnvStorage": "Container Apps", + "New-AzContainerAppManagedEnvDapr": "Container Apps", + "New-AzContainerAppManagedEnvCert": "Container Apps", + "New-AzContainerAppAuthConfig": "Container Apps", + "Get-AzContainerAppManagedEnvDapr": "Container Apps", + "Get-AzContainerAppManagedEnvStorage": "Container Apps", + "New-AzContainerAppProbeHeaderObject": "Container Apps", + "Restart-AzContainerAppRevision": "Container Apps", + "Update-AzStackHciCluster": "Stack HCI", + "Get-AzStackHciCluster": "Stack HCI", + "New-AzStackHciArcSetting": "Stack HCI", + "New-AzStackHciExtension": "Stack HCI", + "Get-AzStackHciExtension": "Stack HCI", + "Remove-AzStackHCIVMAttestation": "Stack HCI", + "Unregister-AzStackHCI": "Stack HCI", + "Add-AzStackHCIVMAttestation": "Stack HCI", + "Remove-AzStackHCIRemoteSupport": "Stack HCI", + "Register-AzStackHCI": "Stack HCI", + "New-AzStackHciCluster": "Stack HCI", + "Disable-AzStackHCIRemoteSupport": "Stack HCI", + "Install-AzStackHCIRemoteSupport": "Stack HCI", + "Remove-AzStackHciCluster": "Stack HCI", + "Get-AzStackHCIRemoteSupportSessionHistory": "Stack HCI", + "Remove-AzStackHciExtension": "Stack HCI", + "Remove-AzStackHciArcSetting": "Stack HCI", + "Disable-AzStackHCIAttestation": "Stack HCI", + "Enable-AzStackHCIRemoteSupport": "Stack HCI", + "Set-AzStackHCI": "Stack HCI", + "Get-AzStackHciArcSetting": "Stack HCI", + "Get-AzStackHCIVMAttestation": "Stack HCI", + "Enable-AzStackHCIAttestation": "Stack HCI", + "Get-AzStackHCIRemoteSupportAccess": "Stack HCI", + "Set-AzOperationalInsightsIntelligencePack": "Operational Insights", + "Remove-AzOperationalInsightsDataExport": "Operational Insights", + "Disable-AzOperationalInsightsLinuxCustomLogCollection": "Operational Insights", + "New-AzOperationalInsightsRestoreTable": "Operational Insights", + "Remove-AzOperationalInsightsLinkedService": "Operational Insights", + "Remove-AzOperationalInsightsLinkedStorageAccount": "Operational Insights", + "Update-AzOperationalInsightsWorkspaceSharedKey": "Operational Insights", + "Get-AzOperationalInsightsOperationStatus": "Operational Insights", + "Set-AzOperationalInsightsStorageInsight": "Operational Insights", + "New-AzOperationalInsightsTable": "Operational Insights", + "Disable-AzOperationalInsightsLinuxSyslogCollection": "Operational Insights", + "Get-AzOperationalInsightsLinkedService": "Operational Insights", + "New-AzOperationalInsightsLinuxSyslogDataSource": "Operational Insights", + "Get-AzOperationalInsightsStorageInsight": "Operational Insights", + "Get-AzOperationalInsightsCluster": "Operational Insights", + "Disable-AzOperationalInsightsLinuxPerformanceCollection": "Operational Insights", + "New-AzOperationalInsightsApplicationInsightsDataSource": "Operational Insights", + "Get-AzOperationalInsightsSchema": "Operational Insights", + "Invoke-AzOperationalInsightsQuery": "Operational Insights", + "Get-AzOperationalInsightsWorkspaceSharedKey": "Operational Insights", + "New-AzOperationalInsightsCustomLogDataSource": "Operational Insights", + "Disable-AzOperationalInsightsIISLogCollection": "Operational Insights", + "Set-AzOperationalInsightsDataSource": "Operational Insights", + "Restore-AzOperationalInsightsWorkspace": "Operational Insights", + "Remove-AzOperationalInsightsSavedSearch": "Operational Insights", + "Get-AzOperationalInsightsOperation": "Operational Insights", + "Remove-AzOperationalInsightsDataSource": "Operational Insights", + "Enable-AzOperationalInsightsLinuxCustomLogCollection": "Operational Insights", + "New-AzOperationalInsightsWorkspace": "Operational Insights", + "New-AzOperationalInsightsCluster": "Operational Insights", + "Set-AzOperationalInsightsLinkedService": "Operational Insights", + "Remove-AzOperationalInsightsCluster": "Operational Insights", + "New-AzOperationalInsightsStorageInsight": "Operational Insights", + "Get-AzOperationalInsightsWorkspace": "Operational Insights", + "Enable-AzOperationalInsightsLinuxPerformanceCollection": "Operational Insights", + "New-AzOperationalInsightsAzureActivityLogDataSource": "Operational Insights", + "Get-AzOperationalInsightsWorkspaceUsage": "Operational Insights", + "New-AzOperationalInsightsComputerGroup": "Operational Insights", + "Update-AzOperationalInsightsTable": "Operational Insights", + "New-AzOperationalInsightsSearchTable": "Operational Insights", + "New-AzOperationalInsightsLinkedStorageAccount": "Operational Insights", + "Get-AzOperationalInsightsDeletedWorkspace": "Operational Insights", + "New-AzOperationalInsightsWindowsEventDataSource": "Operational Insights", + "Set-AzOperationalInsightsLinkedStorageAccount": "Operational Insights", + "Set-AzOperationalInsightsWorkspace": "Operational Insights", + "Get-AzOperationalInsightsPurgeWorkspaceStatus": "Operational Insights", + "Set-AzOperationalInsightsSavedSearch": "Operational Insights", + "Update-AzOperationalInsightsDataExport": "Operational Insights", + "Get-AzOperationalInsightsSavedSearch": "Operational Insights", + "Get-AzOperationalInsightsAvailableServiceTier": "Operational Insights", + "Remove-AzOperationalInsightsStorageInsight": "Operational Insights", + "Get-AzOperationalInsightsDataSource": "Operational Insights", + "New-AzOperationalInsightsPurgeWorkspace": "Operational Insights", + "Get-AzOperationalInsightsTable": "Operational Insights", + "Invoke-AzOperationalInsightsMigrateTable": "Operational Insights", + "Remove-AzOperationalInsightsTable": "Operational Insights", + "Get-AzOperationalInsightsLinkedStorageAccount": "Operational Insights", + "New-AzOperationalInsightsSavedSearch": "Operational Insights", + "Remove-AzOperationalInsightsWorkspace": "Operational Insights", + "New-AzOperationalInsightsDataExport": "Operational Insights", + "Get-AzOperationalInsightsDataExport": "Operational Insights", + "New-AzOperationalInsightsLinuxPerformanceObjectDataSource": "Operational Insights", + "Enable-AzOperationalInsightsLinuxSyslogCollection": "Operational Insights", + "Update-AzOperationalInsightsCluster": "Operational Insights", + "Get-AzOperationalInsightsWorkspaceManagementGroup": "Operational Insights", + "New-AzOperationalInsightsWindowsPerformanceCounterDataSource": "Operational Insights", + "Get-AzOperationalInsightsIntelligencePack": "Operational Insights", + "Enable-AzOperationalInsightsIISLogCollection": "Operational Insights", + "Remove-AzManagedServicesAssignment": "Managed Services", + "Get-AzManagedServicesMarketplaceDefinition": "Managed Services", + "New-AzManagedServicesEligibleApproverObject": "Managed Services", + "Get-AzManagedServicesDefinition": "Managed Services", + "New-AzManagedServicesAuthorizationObject": "Managed Services", + "New-AzManagedServicesEligibleAuthorizationObject": "Managed Services", + "New-AzManagedServicesAssignment": "Managed Services", + "Get-AzManagedServicesAssignment": "Managed Services", + "Remove-AzManagedServicesDefinition": "Managed Services", + "New-AzManagedServicesDefinition": "Managed Services", + "Get-AzAttestationProvider": "Attestation", + "New-AzAttestationProvider": "Attestation", + "Update-AzAttestationProvider": "Attestation", + "Remove-AzAttestationProvider": "Attestation", + "Set-AzAttestationPolicy": "Attestation", + "Add-AzAttestationPolicySigner": "Attestation", + "Get-AzAttestationPolicy": "Attestation", + "Reset-AzAttestationPolicy": "Attestation", + "Get-AzAttestationPolicySigners": "Attestation", + "Remove-AzAttestationPolicySigner": "Attestation", + "Get-AzAttestationDefaultProvider": "Attestation", + "Get-AzPolicyAttestation": "Policy Insights", + "Stop-AzPolicyRemediation": "Policy Insights", + "New-AzPolicyAttestation": "Policy Insights", + "Start-AzPolicyRemediation": "Policy Insights", + "Get-AzPolicyRemediation": "Policy Insights", + "Start-AzPolicyComplianceScan": "Policy Insights", + "Get-AzPolicyMetadata": "Policy Insights", + "Remove-AzPolicyAttestation": "Policy Insights", + "Set-AzPolicyAttestation": "Policy Insights", + "Get-AzPolicyEvent": "Policy Insights", + "Get-AzPolicyStateSummary": "Policy Insights", + "Get-AzPolicyState": "Policy Insights", + "Remove-AzPolicyRemediation": "Policy Insights", + "New-AzKubernetesConfigurationFlux": "Kubernetes Configuration", + "Update-AzKubernetesConfigurationFlux": "Kubernetes Configuration", + "Get-AzKubernetesConfigFluxOperationStatus": "Kubernetes Configuration", + "Remove-AzKubernetesConfiguration": "Kubernetes Configuration", + "New-AzKubernetesExtension": "Kubernetes Configuration", + "Remove-AzKubernetesExtension": "Kubernetes Configuration", + "Get-AzKubernetesConfiguration": "Kubernetes Configuration", + "New-AzKubernetesConfiguration": "Kubernetes Configuration", + "Get-AzKubernetesConfigurationFlux": "Kubernetes Configuration", + "Remove-AzKubernetesConfigurationFlux": "Kubernetes Configuration", + "Get-AzKubernetesExtension": "Kubernetes Configuration", + "Update-AzKubernetesExtension": "Kubernetes Configuration", + "Update-AzHealthBot": "Health Bot", + "New-AzHealthBot": "Health Bot", + "Remove-AzHealthBot": "Health Bot", + "Get-AzHealthBot": "Health Bot", + "Remove-AzSearchQueryKey": "Search", + "Get-AzSearchQueryKey": "Search", + "Set-AzSearchService": "Search", + "Remove-AzSearchService": "Search", + "Get-AzSearchPrivateEndpointConnection": "Search", + "New-AzSearchService": "Search", + "Remove-AzSearchSharedPrivateLinkResource": "Search", + "Get-AzSearchPrivateLinkResource": "Search", + "Set-AzSearchPrivateEndpointConnection": "Search", + "Remove-AzSearchPrivateEndpointConnection": "Search", + "Set-AzSearchSharedPrivateLinkResource": "Search", + "New-AzSearchSharedPrivateLinkResource": "Search", + "Get-AzSearchSharedPrivateLinkResource": "Search", + "New-AzSearchAdminKey": "Search", + "New-AzSearchQueryKey": "Search", + "Get-AzSearchAdminKeyPair": "Search", + "Get-AzSearchService": "Search", + "Remove-AzMariaDbVirtualNetworkRule": "Database for MariaDB", + "Update-AzMariaDbServer": "Database for MariaDB", + "Get-AzMariaDbReplica": "Database for MariaDB", + "Get-AzMariaDbServer": "Database for MariaDB", + "New-AzMariaDbVirtualNetworkRule": "Database for MariaDB", + "Get-AzMariaDbConfiguration": "Database for MariaDB", + "Remove-AzMariaDbServer": "Database for MariaDB", + "Restore-AzMariaDbServer": "Database for MariaDB", + "Get-AzMariaDbVirtualNetworkRule": "Database for MariaDB", + "Get-AzMariaDbFirewallRule": "Database for MariaDB", + "Restart-AzMariaDbServer": "Database for MariaDB", + "Remove-AzMariaDbFirewallRule": "Database for MariaDB", + "Update-AzMariaDbVirtualNetworkRule": "Database for MariaDB", + "Update-AzMariaDbFirewallRule": "Database for MariaDB", + "Update-AzMariaDbConfiguration": "Database for MariaDB", + "Get-AzMariaDbConnectionString": "Database for MariaDB", + "New-AzMariaDbServer": "Database for MariaDB", + "New-AzMariaDbReplica": "Database for MariaDB", + "New-AzMariaDbFirewallRule": "Database for MariaDB", + "Get-AzMapsSubscriptionOperation": "Maps", + "New-AzMapsAccountKey": "Maps", + "Remove-AzMapsCreator": "Maps", + "Update-AzMapsCreator": "Maps", + "Get-AzMapsAccount": "Maps", + "New-AzMapsAccount": "Maps", + "Update-AzMapsAccount": "Maps", + "Remove-AzMapsAccount": "Maps", + "Get-AzMapsAccountKey": "Maps", + "Get-AzMapsCreator": "Maps", + "New-AzMapsCreator": "Maps", + "Remove-AzIoTDeviceProvisioningServiceCertificate": "DPS", + "Get-AzIoTDeviceProvisioningServiceEnrollmentGroup": "DPS", + "New-AzIoTDeviceProvisioningService": "DPS", + "Update-AzIoTDeviceProvisioningServiceAccessPolicy": "DPS", + "Get-AzIoTDeviceProvisioningService": "DPS", + "New-AzIoTDeviceProvisioningServiceCertificateVerificationCode": "DPS", + "Update-AzIoTDeviceProvisioningServiceLinkedHub": "DPS", + "Get-AzIoTDeviceProvisioningServiceRegistration": "DPS", + "Get-AzIoTDeviceProvisioningServiceLinkedHub": "DPS", + "Remove-AzIoTDeviceProvisioningServiceAccessPolicy": "DPS", + "Remove-AzIoTDeviceProvisioningService": "DPS", + "Get-AzIoTDeviceProvisioningServiceAccessPolicy": "DPS", + "Add-AzIoTDeviceProvisioningServiceCertificate": "DPS", + "Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup": "DPS", + "Update-AzIoTDeviceProvisioningService": "DPS", + "Set-AzIoTDeviceProvisioningServiceCertificate": "DPS", + "Remove-AzIoTDeviceProvisioningServiceRegistration": "DPS", + "Add-AzIoTDeviceProvisioningServiceLinkedHub": "DPS", + "Set-AzIoTDeviceProvisioningServiceEnrollment": "DPS", + "Get-AzIoTDeviceProvisioningServiceCertificate": "DPS", + "Add-AzIoTDeviceProvisioningServiceEnrollmentGroup": "DPS", + "Add-AzIoTDeviceProvisioningServiceAccessPolicy": "DPS", + "Set-AzIoTDeviceProvisioningServiceEnrollmentGroup": "DPS", + "Remove-AzIoTDeviceProvisioningServiceLinkedHub": "DPS", + "Remove-AzIoTDeviceProvisioningServiceEnrollment": "DPS", + "Get-AzIoTDeviceProvisioningServiceEnrollment": "DPS", + "Add-AzIoTDeviceProvisioningServiceEnrollment": "DPS", + "Update-AzStreamAnalyticsInput": "Stream Analytics", + "New-AzStreamAnalyticsTransformation": "Stream Analytics", + "Remove-AzStreamAnalyticsOutput": "Stream Analytics", + "Get-AzStreamAnalyticsOutput": "Stream Analytics", + "Update-AzStreamAnalyticsOutput": "Stream Analytics", + "Remove-AzStreamAnalyticsJob": "Stream Analytics", + "Test-AzStreamAnalyticsOutput": "Stream Analytics", + "Remove-AzStreamAnalyticsInput": "Stream Analytics", + "Start-AzStreamAnalyticsJob": "Stream Analytics", + "New-AzStreamAnalyticsCluster": "Stream Analytics", + "Remove-AzStreamAnalyticsFunction": "Stream Analytics", + "Remove-AzStreamAnalyticsCluster": "Stream Analytics", + "Get-AzStreamAnalyticsJob": "Stream Analytics", + "Stop-AzStreamAnalyticsJob": "Stream Analytics", + "New-AzStreamAnalyticsOutput": "Stream Analytics", + "Update-AzStreamAnalyticsFunction": "Stream Analytics", + "New-AzStreamAnalyticsJob": "Stream Analytics", + "Get-AzStreamAnalyticsDefaultFunctionDefinition": "Stream Analytics", + "New-AzStreamAnalyticsFunction": "Stream Analytics", + "Test-AzStreamAnalyticsInput": "Stream Analytics", + "Get-AzStreamAnalyticsCluster": "Stream Analytics", + "Get-AzStreamAnalyticsFunction": "Stream Analytics", + "Update-AzStreamAnalyticsTransformation": "Stream Analytics", + "Update-AzStreamAnalyticsCluster": "Stream Analytics", + "Get-AzStreamAnalyticsClusterStreamingJob": "Stream Analytics", + "Get-AzStreamAnalyticsInput": "Stream Analytics", + "Update-AzStreamAnalyticsJob": "Stream Analytics", + "New-AzStreamAnalyticsInput": "Stream Analytics", + "Test-AzStreamAnalyticsFunction": "Stream Analytics", + "Get-AzStreamAnalyticsTransformation": "Stream Analytics", + "Get-AzStreamAnalyticsQuota": "Stream Analytics", + "New-AzMediaService": "Media Services", + "New-AzMediaServiceStorageConfig": "Media Services", + "Get-AzMediaServiceNameAvailability": "Media Services", + "Set-AzMediaService": "Media Services", + "Set-AzMediaServiceKey": "Media Services", + "Remove-AzMediaService": "Media Services", + "Get-AzMediaServiceKey": "Media Services", + "Sync-AzMediaServiceStorageKey": "Media Services", + "Get-AzMediaService": "Media Services", + "Update-AzADDomainService": "Active Directory Domain Service", + "New-AzADDomainService": "Active Directory Domain Service", + "Remove-AzADDomainService": "Active Directory Domain Service", + "New-AzADDomainServiceReplicaSetObject": "Active Directory Domain Service", + "New-AzADDomainServiceForestTrustObject": "Active Directory Domain Service", + "Get-AzADDomainService": "Active Directory Domain Service", + "Remove-AzDnsZone": "DNS", + "New-AzDnsRecordConfig": "DNS", + "Remove-AzDnsRecordConfig": "DNS", + "New-AzDnsRecordSet": "DNS", + "Add-AzDnsRecordConfig": "DNS", + "Remove-AzDnsRecordSet": "DNS", + "Get-AzDnsZone": "DNS", + "Set-AzDnsRecordSet": "DNS", + "Get-AzDnsRecordSet": "DNS", + "New-AzDnsZone": "DNS", + "Set-AzDnsZone": "DNS", + "Get-AzDedicatedHsm": "Dedicated HSM", + "Remove-AzDedicatedHsm": "Dedicated HSM", + "Get-AzDedicatedHsmOutboundNetworkDependencyEndpoint": "Dedicated HSM", + "New-AzDedicatedHsm": "Dedicated HSM", + "Update-AzDedicatedHsm": "Dedicated HSM", + "Get-AzWvdScalingPlan": "DesktopVirtualization", + "Register-AzWvdApplicationGroup": "DesktopVirtualization", + "Unregister-AzWvdApplicationGroup": "DesktopVirtualization", + "New-AzWvdRegistrationInfo": "DesktopVirtualization", + "Get-AzWvdSessionHost": "DesktopVirtualization", + "Disconnect-AzWvdUserSession": "DesktopVirtualization", + "Remove-AzWvdScalingPlan": "DesktopVirtualization", + "New-AzWvdApplication": "DesktopVirtualization", + "Remove-AzWvdApplication": "DesktopVirtualization", + "New-AzWvdScalingPlan": "DesktopVirtualization", + "Update-AzWvdApplication": "DesktopVirtualization", + "New-AzWvdScalingPlanPooledSchedule": "DesktopVirtualization", + "Remove-AzWvdRegistrationInfo": "DesktopVirtualization", + "Update-AzWvdSessionHost": "DesktopVirtualization", + "Get-AzWvdMsixPackage": "DesktopVirtualization", + "Remove-AzWvdMsixPackage": "DesktopVirtualization", + "Remove-AzWvdUserSession": "DesktopVirtualization", + "Remove-AzWvdHostPool": "DesktopVirtualization", + "Get-AzWvdDesktop": "DesktopVirtualization", + "Get-AzWvdStartMenuItem": "DesktopVirtualization", + "Update-AzWvdApplicationGroup": "DesktopVirtualization", + "Update-AzWvdHostPool": "DesktopVirtualization", + "Get-AzWvdApplication": "DesktopVirtualization", + "New-AzWvdWorkspace": "DesktopVirtualization", + "New-AzWvdApplicationGroup": "DesktopVirtualization", + "Get-AzWvdApplicationGroup": "DesktopVirtualization", + "Remove-AzWvdApplicationGroup": "DesktopVirtualization", + "Get-AzWvdHostPoolRegistrationToken": "DesktopVirtualization", + "Send-AzWvdUserSessionMessage": "DesktopVirtualization", + "Get-AzWvdScalingPlanPooledSchedule": "DesktopVirtualization", + "Update-AzWvdScalingPlanPooledSchedule": "DesktopVirtualization", + "Get-AzWvdUserSession": "DesktopVirtualization", + "Get-AzWvdRegistrationInfo": "DesktopVirtualization", + "Update-AzWvdScalingPlan": "DesktopVirtualization", + "Remove-AzWvdSessionHost": "DesktopVirtualization", + "Update-AzWvdWorkspace": "DesktopVirtualization", + "Remove-AzWvdWorkspace": "DesktopVirtualization", + "Update-AzWvdMsixPackage": "DesktopVirtualization", + "New-AzWvdHostPool": "DesktopVirtualization", + "Remove-AzWvdScalingPlanPooledSchedule": "DesktopVirtualization", + "New-AzWvdMsixPackage": "DesktopVirtualization", + "Update-AzWvdDesktop": "DesktopVirtualization", + "Get-AzWvdHostPool": "DesktopVirtualization", + "Expand-AzWvdMsixImage": "DesktopVirtualization", + "Get-AzWvdWorkspace": "DesktopVirtualization", + "Get-AzSecurityCompliance": "Security", + "Remove-AzIotSecuritySolution": "Security", + "Get-AzSecurityPricing": "Security", + "Disable-AzIotSecurityAnalyticsAggregatedAlert": "Security", + "Get-AzAlertsSuppressionRule": "Security", + "New-AzDeviceSecurityGroupTimeWindowRuleObject": "Security", + "Confirm-AzSecurityAutomation": "Security", + "New-AzSecurityAutomationScopeObject": "Security", + "Get-AzSecuritySqlVulnerabilityAssessmentScanRecord": "Security", + "Set-AzSecurityPricing": "Security", + "Set-AzSecurityWorkspaceSetting": "Security", + "Remove-AzSecurityAssessment": "Security", + "Get-AzJitNetworkAccessPolicy": "Security", + "New-AzDeviceSecurityGroupAllowlistCustomAlertRuleObject": "Security", + "Set-AzAlertsSuppressionRule": "Security", + "New-AzSecurityAutomationRuleObject": "Security", + "Get-AzSecurityWorkspaceSetting": "Security", + "New-AzIotSecuritySolutionRecommendationConfigurationObject": "Security", + "Set-AzSecurityAssessment": "Security", + "Set-AzSqlInformationProtectionPolicy": "Security", + "Remove-AzSecurityWorkspaceSetting": "Security", + "Remove-AzSecurityAssessmentMetadata": "Security", + "New-AzDeviceSecurityGroupDenylistCustomAlertRuleObject": "Security", + "Set-AzSecurityAlert": "Security", + "Add-AzSecuritySqlVulnerabilityAssessmentBaseline": "Security", + "Get-AzSecuritySqlVulnerabilityAssessmentBaseline": "Security", + "Get-AzSecuritySecureScore": "Security", + "New-AzDeviceSecurityGroupThresholdCustomAlertRuleObject": "Security", + "Get-AzSecurityAdaptiveApplicationControl": "Security", + "Get-AzSecuritySubAssessment": "Security", + "Get-AzSecurityAlert": "Security", + "New-AzSecurityAutomationRuleSetObject": "Security", + "Remove-AzJitNetworkAccessPolicy": "Security", + "Get-AzSecurityAdaptiveApplicationControlGroup": "Security", + "Get-AzSecuritySolution": "Security", + "Get-AzSecurityAutoProvisioningSetting": "Security", + "Remove-AzAlertsSuppressionRule": "Security", + "Get-AzSecurityAssessment": "Security", + "Get-AzSecurityAdaptiveNetworkHardening": "Security", + "Start-AzJitNetworkAccessPolicy": "Security", + "Get-AzIotSecurityAnalyticsAggregatedAlert": "Security", + "Get-AzSecurityContact": "Security", + "Get-AzDeviceSecurityGroup": "Security", + "Get-AzRegulatoryComplianceStandard": "Security", + "Get-AzIotSecurityAnalyticsAggregatedRecommendation": "Security", + "Update-AzIotSecuritySolution": "Security", + "New-AzSecurityAutomationSourceObject": "Security", + "Remove-AzDeviceSecurityGroup": "Security", + "Get-AzIotSecurityAnalytics": "Security", + "Get-AzSecuritySqlVulnerabilityAssessmentScanResult": "Security", + "Set-AzSecurityAutoProvisioningSetting": "Security", + "Get-AzSecuritySecureScoreControlDefinition": "Security", + "Get-AzRegulatoryComplianceAssessment": "Security", + "Get-AzSecuritySolutionsReferenceData": "Security", + "Get-AzRegulatoryComplianceControl": "Security", + "Get-AzExternalSecuritySolution": "Security", + "Get-AzSecurityAdvancedThreatProtection": "Security", + "Get-AzSecuritySecureScoreControl": "Security", + "Set-AzDeviceSecurityGroup": "Security", + "Get-AzSecurityTopology": "Security", + "New-AzIotSecuritySolutionUserDefinedResourcesObject": "Security", + "Get-AzSecurityAssessmentMetadata": "Security", + "Set-AzSecuritySqlVulnerabilityAssessmentBaseline": "Security", + "Remove-AzSecuritySqlVulnerabilityAssessmentBaseline": "Security", + "Add-AzSecurityAdaptiveNetworkHardening": "Security", + "Remove-AzSecurityContact": "Security", + "Get-AzSecurityTask": "Security", + "Set-AzSecuritySetting": "Security", + "Disable-AzSecurityAdvancedThreatProtection": "Security", + "New-AzAlertsSuppressionRuleScope": "Security", + "Get-AzAllowedConnection": "Security", + "Get-AzIotSecuritySolution": "Security", + "Get-AzSqlInformationProtectionPolicy": "Security", + "Set-AzIotSecuritySolution": "Security", + "Get-AzSecuritySetting": "Security", + "New-AzSecurityAutomationActionObject": "Security", + "Get-AzDiscoveredSecuritySolution": "Security", + "Set-AzSecurityAssessmentMetadata": "Security", + "Set-AzSecurityContact": "Security", + "Get-AzSecurityLocation": "Security", + "Set-AzJitNetworkAccessPolicy": "Security", + "New-AzSecurityAutomation": "Security", + "Remove-AzSecurityAutomation": "Security", + "Get-AzSecurityAutomation": "Security", + "Enable-AzSecurityAdvancedThreatProtection": "Security", + "Get-AzDynatraceMonitorHost": "DynatraceObservability", + "Get-AzDynatraceMonitoredResource": "DynatraceObservability", + "Get-AzDynatraceMonitorLinkableEnv": "DynatraceObservability", + "Update-AzDynatraceMonitor": "DynatraceObservability", + "Update-AzDynatraceMonitorTagRule": "DynatraceObservability", + "Get-AzDynatraceMonitor": "DynatraceObservability", + "New-AzDynatraceMonitorFilteringTagObject": "DynatraceObservability", + "New-AzDynatraceMonitor": "DynatraceObservability", + "New-AzDynatraceMonitorTagRule": "DynatraceObservability", + "Remove-AzDynatraceMonitor": "DynatraceObservability", + "Get-AzDynatraceMonitorSSOConfig": "DynatraceObservability", + "Remove-AzDynatraceMonitorTagRule": "DynatraceObservability", + "New-AzDynatraceMonitorSSOConfig": "DynatraceObservability", + "Get-AzDynatraceMonitorVMHostPayload": "DynatraceObservability", + "Get-AzDynatraceMonitorAppService": "DynatraceObservability", + "Get-AzDynatraceMonitorTagRule": "DynatraceObservability", + "Get-AzDynatraceMonitorSSODetail": "DynatraceObservability", + "Get-AzMigrateSite": "Migrate", + "Start-AzMigrateServerMigration": "Migrate", + "New-AzMigrateReplicationProtectionContainerMapping": "Migrate", + "Get-AzMigrateProject": "Migrate", + "Restart-AzMigrateServerReplication": "Migrate", + "Register-AzMigrateProjectTool": "Migrate", + "Set-AzMigrateDiskMapping": "Migrate", + "Resume-AzMigrateServerReplication": "Migrate", + "Get-AzMigrateServerReplication": "Migrate", + "New-AzMigrateNicMapping": "Migrate", + "Get-AzMigrateReplicationPolicy": "Migrate", + "Start-AzMigrateTestMigrationCleanup": "Migrate", + "Remove-AzMigrateServerReplication": "Migrate", + "Get-AzMigrateReplicationFabric": "Migrate", + "Get-AzMigrateJob": "Migrate", + "Get-AzMigrateReplicationRecoveryServicesProvider": "Migrate", + "Get-AzMigrateSolution": "Migrate", + "Set-AzMigrateServerReplication": "Migrate", + "Get-AzMigrateRunAsAccount": "Migrate", + "Get-AzMigrateDiscoveredServer": "Migrate", + "New-AzMigrateDiskMapping": "Migrate", + "Remove-AzMigrateProject": "Migrate", + "New-AzMigrateProject": "Migrate", + "Suspend-AzMigrateServerReplication": "Migrate", + "New-AzMigrateServerReplication": "Migrate", + "Start-AzMigrateTestMigration": "Migrate", + "Initialize-AzMigrateReplicationInfrastructure": "Migrate", + "New-AzMigrateReplicationPolicy": "Migrate", + "Get-AzMigrateReplicationProtectionContainer": "Migrate", + "Get-AzMigrateReplicationProtectionContainerMapping": "Migrate", + "New-AzMigrateTestNicMapping": "Migrate", + "Update-AzWindowsIotServicesDevice": "WindowsIotServices", + "New-AzWindowsIotServicesDevice": "WindowsIotServices", + "Remove-AzWindowsIotServicesDevice": "WindowsIotServices", + "Get-AzWindowsIotServicesDevice": "WindowsIotServices", + "Get-AzDataShareSynchronizationSetting": "Data Share", + "Remove-AzDataShareSubscription": "Data Share", + "Remove-AzDataShareSynchronizationSetting": "Data Share", + "Remove-AzDataShare": "Data Share", + "Set-AzDataShare": "Data Share", + "Get-AzDataShareDataSetMapping": "Data Share", + "Get-AzDataShareAccount": "Data Share", + "Start-AzDataShareSubscriptionSynchronization": "Data Share", + "Revoke-AzDataShareSubscriptionAccess": "Data Share", + "New-AzDataShareInvitation": "Data Share", + "New-AzDataShare": "Data Share", + "Remove-AzDataShareAccount": "Data Share", + "Get-AzDataShareSubscriptionSynchronization": "Data Share", + "Remove-AzDataShareTrigger": "Data Share", + "Get-AzDataShare": "Data Share", + "New-AzDataShareDataSetMapping": "Data Share", + "New-AzDataShareSynchronizationSetting": "Data Share", + "Get-AzDataShareReceivedInvitation": "Data Share", + "Get-AzDataShareInvitation": "Data Share", + "Get-AzDataShareProviderShareSubscription": "Data Share", + "Get-AzDataShareDataSet": "Data Share", + "Get-AzDataShareSubscriptionSynchronizationDetail": "Data Share", + "Remove-AzDataShareDataSetMapping": "Data Share", + "Get-AzDataShareTrigger": "Data Share", + "Grant-AzDataShareSubscriptionAccess": "Data Share", + "Remove-AzDataShareDataSet": "Data Share", + "Get-AzDataShareSourceDataSet": "Data Share", + "New-AzDataShareAccount": "Data Share", + "Get-AzDataShareSynchronization": "Data Share", + "Stop-AzDataShareSubscriptionSynchronization": "Data Share", + "New-AzDataShareTrigger": "Data Share", + "Get-AzDataShareSynchronizationDetail": "Data Share", + "Get-AzDataShareSubscription": "Data Share", + "New-AzDataShareDataSet": "Data Share", + "New-AzDataShareSubscription": "Data Share", + "Remove-AzDataShareInvitation": "Data Share", + "Set-AzDeploymentManagerService": "Deployment Manager", + "Stop-AzDeploymentManagerRollout": "Deployment Manager", + "Remove-AzDeploymentManagerServiceTopology": "Deployment Manager", + "Get-AzDeploymentManagerServiceUnit": "Deployment Manager", + "New-AzDeploymentManagerArtifactSource": "Deployment Manager", + "New-AzDeploymentManagerServiceUnit": "Deployment Manager", + "Remove-AzDeploymentManagerServiceUnit": "Deployment Manager", + "New-AzDeploymentManagerServiceTopology": "Deployment Manager", + "Get-AzDeploymentManagerService": "Deployment Manager", + "Get-AzDeploymentManagerStep": "Deployment Manager", + "Remove-AzDeploymentManagerArtifactSource": "Deployment Manager", + "Get-AzDeploymentManagerRollout": "Deployment Manager", + "Set-AzDeploymentManagerArtifactSource": "Deployment Manager", + "Get-AzDeploymentManagerArtifactSource": "Deployment Manager", + "Remove-AzDeploymentManagerStep": "Deployment Manager", + "New-AzDeploymentManagerService": "Deployment Manager", + "Remove-AzDeploymentManagerService": "Deployment Manager", + "Get-AzDeploymentManagerServiceTopology": "Deployment Manager", + "Set-AzDeploymentManagerStep": "Deployment Manager", + "Set-AzDeploymentManagerServiceUnit": "Deployment Manager", + "Set-AzDeploymentManagerServiceTopology": "Deployment Manager", + "New-AzDeploymentManagerStep": "Deployment Manager", + "Restart-AzDeploymentManagerRollout": "Deployment Manager", + "Remove-AzDeploymentManagerRollout": "Deployment Manager", + "Get-AzConfluentMarketplaceAgreement": "Confluent", + "New-AzConfluentOrganization": "Confluent", + "Update-AzConfluentOrganization": "Confluent", + "Get-AzConfluentOrganization": "Confluent", + "Remove-AzConfluentOrganization": "Confluent", + "Enable-AzHDInsightAzureMonitor": "HDInsight", + "Remove-AzHDInsightCluster": "HDInsight", + "Get-AzHDInsightAzureMonitor": "HDInsight", + "New-AzHDInsightSqoopJobDefinition": "HDInsight", + "New-AzHDInsightClusterAutoscaleConfiguration": "HDInsight", + "Set-AzHDInsightClusterAutoscaleConfiguration": "HDInsight", + "Remove-AzHDInsightPersistedScriptAction": "HDInsight", + "Get-AzHDInsightClusterAutoscaleConfiguration": "HDInsight", + "Wait-AzHDInsightJob": "HDInsight", + "Get-AzHDInsightJobOutput": "HDInsight", + "Invoke-AzHDInsightHiveJob": "HDInsight", + "Set-AzHDInsightDefaultStorage": "HDInsight", + "Enable-AzHDInsightMonitoring": "HDInsight", + "Get-AzHDInsightPersistedScriptAction": "HDInsight", + "New-AzHDInsightPrivateLinkConfiguration": "HDInsight", + "Get-AzHDInsightProperty": "HDInsight", + "Set-AzHDInsightClusterDiskEncryptionKey": "HDInsight", + "New-AzHDInsightPigJobDefinition": "HDInsight", + "Add-AzHDInsightStorage": "HDInsight", + "Set-AzHDInsightGatewayCredential": "HDInsight", + "New-AzHDInsightMapReduceJobDefinition": "HDInsight", + "Add-AzHDInsightMetastore": "HDInsight", + "Start-AzHDInsightJob": "HDInsight", + "New-AzHDInsightCluster": "HDInsight", + "Set-AzHDInsightClusterSize": "HDInsight", + "Remove-AzHDInsightClusterAutoscaleConfiguration": "HDInsight", + "Add-AzHDInsightConfigValue": "HDInsight", + "Disable-AzHDInsightAzureMonitor": "HDInsight", + "Submit-AzHDInsightScriptAction": "HDInsight", + "New-AzHDInsightIPConfiguration": "HDInsight", + "New-AzHDInsightClusterConfig": "HDInsight", + "Get-AzHDInsightMonitoring": "HDInsight", + "Add-AzHDInsightSecurityProfile": "HDInsight", + "Use-AzHDInsightCluster": "HDInsight", + "Add-AzHDInsightComponentVersion": "HDInsight", + "Disable-AzHDInsightMonitoring": "HDInsight", + "Set-AzHDInsightPersistedScriptAction": "HDInsight", + "New-AzHDInsightHiveJobDefinition": "HDInsight", + "Get-AzHDInsightScriptActionHistory": "HDInsight", + "Add-AzHDInsightClusterIdentity": "HDInsight", + "New-AzHDInsightClusterAutoscaleScheduleCondition": "HDInsight", + "Add-AzHDInsightScriptAction": "HDInsight", + "Restart-AzHDInsightHost": "HDInsight", + "Stop-AzHDInsightJob": "HDInsight", + "New-AzHDInsightStreamingMapReduceJobDefinition": "HDInsight", + "Get-AzHDInsightJob": "HDInsight", + "Get-AzHDInsightCluster": "HDInsight", + "Get-AzHDInsightHost": "HDInsight", + "New-AzFluidRelayServerKey": "Fluid Relay", + "Get-AzFluidRelayServer": "Fluid Relay", + "Get-AzFluidRelayContainer": "Fluid Relay", + "New-AzFluidRelayServer": "Fluid Relay", + "Get-AzFluidRelayServerKey": "Fluid Relay", + "Update-AzFluidRelayServer": "Fluid Relay", + "Remove-AzFluidRelayContainer": "Fluid Relay", + "Remove-AzFluidRelayServer": "Fluid Relay", + "New-AzElasticMonitor": "Elastic", + "Get-AzElasticVMHost": "Elastic", + "Get-AzElasticDetailVMIngestion": "Elastic", + "Update-AzElasticVMCollection": "Elastic", + "New-AzElasticFilteringTagObject": "Elastic", + "Remove-AzElasticMonitor": "Elastic", + "Update-AzElasticMonitor": "Elastic", + "Get-AzElasticMonitor": "Elastic", + "Get-AzElasticDeploymentInfo": "Elastic", + "New-AzElasticTagRule": "Elastic", + "Get-AzElasticMonitoredResource": "Elastic", + "Get-AzElasticTagRule": "Elastic", + "Add-AzApiManagementProductToGroup": "API Management", + "Get-AzApiManagementGatewayKey": "API Management", + "Get-AzApiManagementApiSchema": "API Management", + "New-AzApiManagementBackendProxy": "API Management", + "Set-AzApiManagementApi": "API Management", + "Set-AzApiManagementOperation": "API Management", + "Remove-AzApiManagementOperation": "API Management", + "Set-AzApiManagementPolicy": "API Management", + "Get-AzApiManagementApi": "API Management", + "New-AzApiManagementHttpMessageDiagnostic": "API Management", + "New-AzApiManagementApiRelease": "API Management", + "Get-AzApiManagementNamedValueSecretValue": "API Management", + "Remove-AzApiManagementApiSchema": "API Management", + "Remove-AzApiManagementDiagnostic": "API Management", + "Remove-AzApiManagementRegion": "API Management", + "Add-AzApiManagementRegion": "API Management", + "Get-AzApiManagementGroup": "API Management", + "New-AzApiManagementPipelineDiagnosticSetting": "API Management", + "Get-AzApiManagementLogger": "API Management", + "Get-AzApiManagementIdentityProviderClientSecret": "API Management", + "New-AzApiManagementProduct": "API Management", + "Get-AzApiManagementApiRevision": "API Management", + "Get-AzApiManagementGateway": "API Management", + "Remove-AzApiManagementNamedValue": "API Management", + "New-AzApiManagementUser": "API Management", + "Add-AzApiManagementApiToGateway": "API Management", + "New-AzApiManagementDiagnostic": "API Management", + "New-AzApiManagementIdentityProvider": "API Management", + "New-AzApiManagementSamplingSetting": "API Management", + "Get-AzApiManagementSubscription": "API Management", + "Get-AzApiManagementDiagnostic": "API Management", + "Remove-AzApiManagementOpenIdConnectProvider": "API Management", + "New-AzApiManagementApiRevision": "API Management", + "Remove-AzApiManagementUserFromGroup": "API Management", + "Sync-AzApiManagementKeyVaultSecret": "API Management", + "Remove-AzApiManagementApiVersionSet": "API Management", + "New-AzApiManagementKeyVaultObject": "API Management", + "Remove-AzApiManagementUser": "API Management", + "Get-AzApiManagementApiRelease": "API Management", + "Set-AzApiManagementApiVersionSet": "API Management", + "Add-AzApiManagementApiToProduct": "API Management", + "Get-AzApiManagementUser": "API Management", + "Set-AzApiManagementIdentityProvider": "API Management", + "Get-AzApiManagementBackend": "API Management", + "Get-AzApiManagementIdentityProvider": "API Management", + "New-AzApiManagementApiSchema": "API Management", + "Get-AzApiManagementTenantGitAccess": "API Management", + "Backup-AzApiManagement": "API Management", + "New-AzApiManagementBackendServiceFabric": "API Management", + "Set-AzApiManagementSubscription": "API Management", + "Set-AzApiManagementAuthorizationServer": "API Management", + "New-AzApiManagementOpenIdConnectProvider": "API Management", + "Get-AzApiManagementNetworkStatus": "API Management", + "New-AzApiManagementGroup": "API Management", + "Get-AzApiManagementTenantGitAccessSecret": "API Management", + "New-AzApiManagementGatewayHostnameConfiguration": "API Management", + "Update-AzApiManagementRegion": "API Management", + "New-AzApiManagementVirtualNetwork": "API Management", + "New-AzApiManagementLogger": "API Management", + "Get-AzApiManagementAuthorizationServer": "API Management", + "Set-AzApiManagementCertificate": "API Management", + "Remove-AzApiManagementPolicy": "API Management", + "Set-AzApiManagementBackend": "API Management", + "New-AzApiManagementNamedValue": "API Management", + "Get-AzApiManagementCertificate": "API Management", + "Set-AzApiManagementDiagnostic": "API Management", + "Import-AzApiManagementApi": "API Management", + "Get-AzApiManagementOperation": "API Management", + "Export-AzApiManagementApi": "API Management", + "Get-AzApiManagementOpenIdConnectProviderClientSecret": "API Management", + "New-AzApiManagementGateway": "API Management", + "Remove-AzApiManagementCache": "API Management", + "Remove-AzApiManagementIdentityProvider": "API Management", + "Get-AzApiManagementTenantAccess": "API Management", + "Remove-AzApiManagementBackend": "API Management", + "Restore-AzApiManagement": "API Management", + "Get-AzApiManagementProduct": "API Management", + "Get-AzApiManagementSsoToken": "API Management", + "Get-AzApiManagementOpenIdConnectProvider": "API Management", + "New-AzApiManagementApiVersionSet": "API Management", + "Set-AzApiManagementLogger": "API Management", + "Save-AzApiManagementTenantGitConfiguration": "API Management", + "New-AzApiManagementBackendCredential": "API Management", + "Set-AzApiManagementProduct": "API Management", + "Remove-AzApiManagementApiRevision": "API Management", + "Get-AzApiManagementSubscriptionKey": "API Management", + "Publish-AzApiManagementTenantGitConfiguration": "API Management", + "New-AzApiManagementSystemCertificate": "API Management", + "Set-AzApiManagementTenantAccess": "API Management", + "Update-AzApiManagementGateway": "API Management", + "Get-AzApiManagementAuthorizationServerClientSecret": "API Management", + "Remove-AzApiManagementApi": "API Management", + "Remove-AzApiManagement": "API Management", + "Remove-AzApiManagementApiFromProduct": "API Management", + "Get-AzApiManagement": "API Management", + "New-AzApiManagementOperation": "API Management", + "Remove-AzApiManagementProductFromGroup": "API Management", + "Remove-AzApiManagementApiRelease": "API Management", + "Remove-AzApiManagementSubscription": "API Management", + "Set-AzApiManagementGroup": "API Management", + "Remove-AzApiManagementGateway": "API Management", + "Get-AzApiManagementCache": "API Management", + "Set-AzApiManagementApiRevision": "API Management", + "Get-AzApiManagementTenantAccessSecret": "API Management", + "Get-AzApiManagementApiVersionSet": "API Management", + "Set-AzApiManagementNamedValue": "API Management", + "New-AzApiManagementRegion": "API Management", + "Get-AzApiManagementTenantSyncState": "API Management", + "New-AzApiManagementAuthorizationServer": "API Management", + "Remove-AzApiManagementCertificate": "API Management", + "Set-AzApiManagementApiSchema": "API Management", + "Add-AzApiManagementUserToGroup": "API Management", + "Remove-AzApiManagementLogger": "API Management", + "Get-AzApiManagementNamedValue": "API Management", + "New-AzApiManagementSubscription": "API Management", + "Update-AzApiManagementApiRelease": "API Management", + "Remove-AzApiManagementAuthorizationServer": "API Management", + "Get-AzApiManagementPolicy": "API Management", + "New-AzApiManagementBackend": "API Management", + "New-AzApiManagementCertificate": "API Management", + "New-AzApiManagementUserToken": "API Management", + "New-AzApiManagementContext": "API Management", + "New-AzApiManagementResourceLocationObject": "API Management", + "Remove-AzApiManagementGatewayHostnameConfiguration": "API Management", + "Remove-AzApiManagementApiFromGateway": "API Management", + "New-AzApiManagementCache": "API Management", + "Set-AzApiManagementOpenIdConnectProvider": "API Management", + "New-AzApiManagementSslSetting": "API Management", + "Update-AzApiManagementCache": "API Management", + "New-AzApiManagementApi": "API Management", + "New-AzApiManagementCustomHostnameConfiguration": "API Management", + "Set-AzApiManagement": "API Management", + "Remove-AzApiManagementProduct": "API Management", + "Get-AzApiManagementGatewayHostnameConfiguration": "API Management", + "Remove-AzApiManagementGroup": "API Management", + "Set-AzApiManagementUser": "API Management", + "Get-AzApiManagementUserSsoUrl": "API Management", + "New-AzApiManagement": "API Management", + "New-AzDatabricksVNetPeering": "Databricks", + "Get-AzDatabricksVNetPeering": "Databricks", + "Get-AzDatabricksOutboundNetworkDependenciesEndpoint": "Databricks", + "New-AzDatabricksAccessConnector": "Databricks", + "Remove-AzDatabricksWorkspace": "Databricks", + "Get-AzDatabricksWorkspace": "Databricks", + "Remove-AzDatabricksVNetPeering": "Databricks", + "New-AzDatabricksWorkspaceProviderAuthorizationObject": "Databricks", + "Remove-AzDatabricksAccessConnector": "Databricks", + "New-AzDatabricksWorkspace": "Databricks", + "Get-AzDatabricksAccessConnector": "Databricks", + "Update-AzDatabricksVNetPeering": "Databricks", + "Update-AzDatabricksWorkspace": "Databricks", + "Update-AzDatabricksAccessConnector": "Databricks", + "Edit-AzDataProtectionPolicyTriggerClientObject": "Data Protection", + "Get-AzDataProtectionBackupVault": "Data Protection", + "Edit-AzDataProtectionPolicyRetentionRuleClientObject": "Data Protection", + "Resume-AzDataProtectionBackupInstanceProtection": "Data Protection", + "Update-AzDataProtectionBackupInstanceAssociatedPolicy": "Data Protection", + "Remove-AzDataProtectionBackupPolicy": "Data Protection", + "New-AzDataProtectionBackupInstance": "Data Protection", + "Initialize-AzDataProtectionRestoreRequest": "Data Protection", + "New-AzDataProtectionResourceGuard": "Data Protection", + "Remove-AzDataProtectionResourceGuard": "Data Protection", + "Get-AzDataProtectionResourceGuard": "Data Protection", + "Get-AzDataProtectionOperationStatus": "Data Protection", + "Get-AzDataProtectionOperation": "Data Protection", + "Get-AzDataProtectionPolicyTemplate": "Data Protection", + "Search-AzDataProtectionJobInAzGraph": "Data Protection", + "Get-AzDataProtectionBackupInstance": "Data Protection", + "Edit-AzDataProtectionPolicyTagClientObject": "Data Protection", + "Remove-AzDataProtectionBackupInstance": "Data Protection", + "Test-AzDataProtectionBackupInstanceReadiness": "Data Protection", + "New-AzDataProtectionBackupVaultStorageSettingObject": "Data Protection", + "New-AzDataProtectionRestoreConfigurationClientObject": "Data Protection", + "New-AzDataProtectionBackupPolicy": "Data Protection", + "New-AzDataProtectionBackupVault": "Data Protection", + "Get-AzDataProtectionJob": "Data Protection", + "Start-AzDataProtectionBackupInstanceRestore": "Data Protection", + "Backup-AzDataProtectionBackupInstanceAdhoc": "Data Protection", + "Test-AzDataProtectionBackupInstanceRestore": "Data Protection", + "Initialize-AzDataProtectionBackupInstance": "Data Protection", + "Sync-AzDataProtectionBackupInstance": "Data Protection", + "New-AzDataProtectionRetentionLifeCycleClientObject": "Data Protection", + "Find-AzDataProtectionRestorableTimeRange": "Data Protection", + "New-AzDataProtectionPolicyTagCriteriaClientObject": "Data Protection", + "Suspend-AzDataProtectionBackupInstanceBackup": "Data Protection", + "Stop-AzDataProtectionBackupInstanceProtection": "Data Protection", + "Remove-AzDataProtectionBackupVault": "Data Protection", + "Set-AzDataProtectionMSIPermission": "Data Protection", + "Update-AzDataProtectionBackupVault": "Data Protection", + "Update-AzDataProtectionResourceGuard": "Data Protection", + "Get-AzDataProtectionRecoveryPoint": "Data Protection", + "New-AzDataProtectionBackupConfigurationClientObject": "Data Protection", + "New-AzDataProtectionPolicyTriggerScheduleClientObject": "Data Protection", + "Search-AzDataProtectionBackupInstanceInAzGraph": "Data Protection", + "Get-AzDataProtectionBackupPolicy": "Data Protection", + "Set-AzApplicationGatewayAutoscaleConfiguration": "Application Gateway", + "New-AzFirewallApplicationRule": "Networking", + "Get-AzVirtualNetworkGatewaySupportedVpnDevice": "Virtual Network", + "Get-AzNetworkVirtualAppliance": "Networking", + "New-AzIpAllocation": "Networking", + "New-AzFirewallPolicyNetworkRule": "Networking", + "Get-AzApplicationGatewayAvailableWafRuleSet": "Application Gateway", + "Get-AzExpressRouteCrossConnectionArpTable": "ExpressRoute", + "New-AzPrivateLinkServiceConnection": "Networking", + "Remove-AzApplicationGatewayConnectionDraining": "Application Gateway", + "Remove-AzPrivateDnsZoneGroup": "DNS", + "Set-AzVirtualNetworkGatewayConnectionSharedKey": "Virtual Network", + "Remove-AzRouteTable": "Route", + "New-AzVirtualNetwork": "Virtual Network", + "Get-AzApplicationGatewayAutoscaleConfiguration": "Application Gateway", + "Remove-AzLoadBalancerFrontendIpConfig": "Load Balancer", + "New-AzP2sVpnGateway": "VPN", + "Remove-AzVpnServerConfigurationPolicyGroup": "VPN", + "New-AzNetworkManagerScope": "Networking", + "Remove-AzVirtualHubVnetConnection": "Networking", + "New-AzFirewall": "Networking", + "New-AzApplicationGatewayFirewallCustomRule": "Application Gateway", + "New-AzApplicationGatewayRewriteRuleCondition": "Application Gateway", + "Get-AzNetworkWatcherConnectionMonitor": "Network Watcher", + "Remove-AzRouteFilter": "Route", + "New-AzVirtualNetworkTap": "Virtual Network", + "Get-AzApplicationGatewayIdentity": "Application Gateway", + "Remove-AzVirtualNetworkGateway": "Virtual Network", + "New-AzApplicationGatewayListener": "Application Gateway", + "New-AzRouteFilter": "Route", + "New-AzNetworkWatcherConnectionMonitorTestGroupObject": "Network Watcher", + "New-AzNetworkWatcherConnectionMonitorObject": "Network Watcher", + "Get-AzLoadBalancerBackendAddressPool": "Load Balancer", + "New-AzApplicationGatewayBackendAddressPool": "Application Gateway", + "Set-AzRouteFilterRuleConfig": "Route", + "Get-AzNetworkInterfaceIpConfig": "Networking", + "New-AzNetworkProfile": "Networking", + "New-AzNetworkWatcher": "Network Watcher", + "Remove-AzApplicationGatewayFirewallPolicy": "Application Gateway", + "Get-AzApplicationGatewaySku": "Application Gateway", + "Get-AzNetworkUsage": "Networking", + "Add-AzApplicationGatewayBackendHttpSetting": "Application Gateway", + "Remove-AzApplicationGatewayCustomError": "Application Gateway", + "Test-AzNetworkWatcherIPFlow": "Network Watcher", + "Remove-AzExpressRouteCircuitPeeringConfig": "ExpressRoute", + "Get-AzRouteTable": "Route", + "Remove-AzApplicationGatewayTrustedRootCertificate": "Application Gateway", + "Remove-AzApplicationGatewayFrontendIPConfig": "Application Gateway", + "Stop-AzVirtualNetworkGatewayPacketCapture": "Virtual Network", + "Get-AzAvailableServiceAlias": "Networking", + "New-AzNetworkWatcherConnectionMonitorEndpointObject": "Network Watcher", + "Add-AzRouteFilterRuleConfig": "Route", + "Update-AzNetworkVirtualAppliance": "Networking", + "New-AzApplicationGatewayProbeConfig": "Application Gateway", + "New-AzRouteMapRuleActionParameter": "Route", + "Set-AzNetworkManagerConnectivityConfiguration": "Networking", + "Get-AzVirtualHubVnetConnection": "Networking", + "Set-AzLoadBalancer": "Load Balancer", + "New-AzApplicationGatewayPrivateLinkConfiguration": "Application Gateway", + "Remove-AzExpressRouteGateway": "ExpressRoute", + "Get-AzVirtualNetworkGatewayAdvertisedRoute": "Virtual Network", + "New-AzApplicationGatewaySslPolicy": "Application Gateway", + "Remove-AzCustomIpPrefix": "Networking", + "Set-AzBastion": "Networking", + "Get-AzApplicationGatewaySslProfile": "Application Gateway", + "Set-AzRoutingPolicy": "Networking", + "Update-AzVpnConnection": "VPN", + "Get-AzApplicationGatewayIPConfiguration": "Application Gateway", + "Remove-AzApplicationGatewayHttpListenerCustomError": "Application Gateway", + "Remove-AzServiceEndpointPolicy": "Networking", + "Set-AzVirtualNetworkPeering": "Virtual Network", + "Set-AzLocalNetworkGateway": "Networking", + "New-AzApplicationGatewayIPConfiguration": "Application Gateway", + "Set-AzApplicationGatewaySslProfile": "Application Gateway", + "New-AzApplicationGatewayUrlPathMapConfig": "Application Gateway", + "Set-AzApplicationGatewayUrlPathMapConfig": "Application Gateway", + "Approve-AzPrivateEndpointConnection": "Networking", + "Add-AzVpnClientRevokedCertificate": "VPN", + "Get-AzDdosProtectionPlan": "Networking", + "Set-AzPrivateEndpoint": "Networking", + "New-AzApplicationGatewayFirewallPolicyManagedRule": "Application Gateway", + "Remove-AzNetworkVirtualAppliance": "Networking", + "New-AzApplicationGatewayFirewallPolicyManagedRuleSet": "Application Gateway", + "New-AzNetworkManagerScopeConnection": "Networking", + "New-AzVHubRoute": "Route", + "Get-AzVpnClientConfiguration": "VPN", + "Get-AzNetworkVirtualApplianceSku": "Networking", + "Remove-AzBastion": "Networking", + "Get-AzVirtualNetworkSubnetConfig": "Virtual Network", + "Get-AzExpressRouteGateway": "ExpressRoute", + "Update-AzRouteServer": "Route", + "New-AzFirewallPolicyIntrusionDetectionBypassTraffic": "Networking", + "Remove-AzNetworkWatcherPacketCapture": "Network Watcher", + "New-AzApplicationGatewayCustomError": "Application Gateway", + "Add-AzApplicationGatewayBackendAddressPool": "Application Gateway", + "New-AzGatewayCustomBgpIpConfigurationObject": "Networking", + "Set-AzApplicationGatewayRoutingRule": "Application Gateway", + "New-AzVpnSite": "VPN", + "Reset-AzHubRouter": "Route", + "Get-AzApplicationGatewayRedirectConfiguration": "Application Gateway", + "Set-AzApplicationGatewayConnectionDraining": "Application Gateway", + "Remove-AzApplicationGatewayIdentity": "Application Gateway", + "Add-AzExpressRouteCircuitConnectionConfig": "ExpressRoute", + "Get-AzVirtualNetworkGatewayConnectionIkeSa": "Virtual Network", + "Set-AzServiceEndpointPolicy": "Networking", + "Set-AzVirtualNetworkGateway": "Virtual Network", + "New-AzFirewallPolicy": "Networking", + "New-AzPrivateLinkService": "Networking", + "Get-AzAvailablePrivateEndpointType": "Networking", + "Set-AzApplicationGatewaySslPolicy": "Application Gateway", + "Stop-AzVpnConnectionPacketCapture": "VPN", + "New-AzDelegation": "Networking", + "Get-AzApplicationGatewayListener": "Application Gateway", + "Remove-AzExpressRouteCircuit": "ExpressRoute", + "New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleGroup": "Application Gateway", + "Remove-AzVirtualHub": "Networking", + "New-AzApplicationGatewayRewriteRuleHeaderConfiguration": "Application Gateway", + "Get-AzNetworkWatcherReachabilityReport": "Network Watcher", + "Remove-AzPublicIpPrefix": "Networking", + "Get-AzApplicationGatewayFirewallPolicy": "Application Gateway", + "Remove-AzRoutingIntent": "Networking", + "New-AzApplicationGatewayRewriteRuleUrlConfiguration": "Application Gateway", + "Remove-AzApplicationGatewaySslProfilePolicy": "Application Gateway", + "New-AzNetworkManagerSecurityGroupItem": "Networking", + "Remove-AzNetworkManagerConnectivityConfiguration": "Networking", + "Remove-AzApplicationGatewayTrustedClientCertificate": "Application Gateway", + "Get-AzLoadBalancerRuleConfig": "Load Balancer", + "Update-AzVirtualHubVnetConnection": "Networking", + "Update-AzRouteServerPeer": "Route", + "New-AzLoadBalancerOutboundRuleConfig": "Load Balancer", + "Resize-AzVirtualNetworkGateway": "Virtual Network", + "Remove-AzIpAllocation": "Networking", + "Add-AzApplicationGatewayRedirectConfiguration": "Application Gateway", + "Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping": "Load Balancer", + "Get-AzVirtualWanVpnServerConfigurationVpnProfile": "VPN", + "Get-AzApplicationGatewayRequestRoutingRule": "Application Gateway", + "Get-AzVpnConnection": "VPN", + "Remove-AzNetworkSecurityRuleConfig": "Networking", + "Update-AzVirtualHubBgpConnection": "Networking", + "New-AzVirtualRouter": "Route", + "Remove-AzDdosProtectionPlan": "Networking", + "New-AzVirtualHubVnetConnection": "Networking", + "Add-AzApplicationGatewayFrontendIPConfig": "Application Gateway", + "Get-AzApplicationGatewayConnectionDraining": "Application Gateway", + "New-AzApplicationGatewayProbeHealthResponseMatch": "Application Gateway", + "Remove-AzVirtualNetwork": "Virtual Network", + "New-AzVpnSiteLinkConnection": "VPN", + "Get-AzIpAllocation": "Networking", + "Get-AzVirtualNetworkPeering": "Virtual Network", + "Set-AzNetworkInterfaceTapConfig": "Networking", + "New-AzApplicationGatewayFirewallCustomRuleGroupByVariable": "Application Gateway", + "Get-AzPrivateLinkService": "Networking", + "Add-AzNetworkInterfaceTapConfig": "Networking", + "New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject": "Network Watcher", + "New-AzFirewallPolicyDnsSetting": "DNS", + "New-AzApplicationGatewayFirewallPolicyLogScrubbingRule": "Application Gateway", + "Set-AzVirtualNetworkGatewayDefaultSite": "Virtual Network", + "Set-AzNetworkManager": "Networking", + "Get-AzVirtualRouter": "Route", + "Set-AzPrivateLinkService": "Networking", + "New-AzNetworkManagerConnectivityGroupItem": "Networking", + "Get-AzVirtualNetworkGatewayConnectionSharedKey": "Virtual Network", + "New-AzLoadBalancerInboundNatRuleConfig": "Load Balancer", + "New-AzApplicationGatewayFirewallCustomRuleGroupByUserSession": "Application Gateway", + "Get-AzExpressRouteCrossConnectionRouteTable": "ExpressRoute", + "Get-AzLoadBalancerProbeConfig": "Load Balancer", + "Remove-AzFirewallPolicyRuleCollectionGroup": "Networking", + "New-AzLoadBalancer": "Load Balancer", + "Set-AzVirtualHub": "Networking", + "New-AzFirewallPolicyNatRuleCollection": "Networking", + "Set-AzApplicationGatewayBackendSetting": "Application Gateway", + "Remove-AzApplicationGatewayRoutingRule": "Application Gateway", + "Set-AzPublicIpPrefix": "Networking", + "Get-AzP2sVpnGateway": "VPN", + "Add-AzApplicationGatewayProbeConfig": "Application Gateway", + "New-AzFirewallPolicyApplicationRule": "Networking", + "Get-AzExpressRouteCircuitRouteTable": "ExpressRoute", + "Add-AzApplicationGatewaySslCertificate": "Application Gateway", + "Reset-AzVpnSiteLinkConnection": "VPN", + "Get-AzVpnServerConfiguration": "VPN", + "Set-AzApplicationGatewaySslCertificate": "Application Gateway", + "Set-AzNetworkSecurityGroup": "Networking", + "Set-AzFirewallPolicyRuleCollectionGroup": "Networking", + "New-AzApplicationGatewayRequestRoutingRule": "Application Gateway", + "Add-AzApplicationGatewayTrustedClientCertificate": "Application Gateway", + "Get-AzLoadBalancerInboundNatPoolConfig": "Load Balancer", + "Get-AzExpressRouteCircuitAuthorization": "ExpressRoute", + "Get-AzNetworkManagerConnectivityConfiguration": "Networking", + "Set-AzNetworkSecurityRuleConfig": "Networking", + "New-AzRouteServer": "Route", + "Get-AzRouteServer": "Route", + "Remove-AzLocalNetworkGateway": "Networking", + "Set-AzLoadBalancerProbeConfig": "Load Balancer", + "New-AzApplicationGatewayTrustedClientCertificate": "Application Gateway", + "New-AzApplicationGatewayFrontendPort": "Application Gateway", + "New-AzNatGateway": "Networking", + "New-AzApplicationGatewayConnectionDraining": "Application Gateway", + "Invoke-AzNetworkWatcherNetworkConfigurationDiagnostic": "Network Watcher", + "Set-AzVirtualNetworkTap": "Virtual Network", + "New-AzFirewallPolicyFilterRuleCollection": "Networking", + "New-AzFirewallPolicyIntrusionDetectionSignatureOverride": "Networking", + "Remove-AzApplicationGateway": "Application Gateway", + "Get-AzApplicationGatewayRoutingRule": "Application Gateway", + "Get-AzApplicationGatewayBackendHttpSetting": "Application Gateway", + "Set-AzPublicIpAddress": "Networking", + "Get-AzNetworkManagerEffectiveConnectivityConfiguration": "Networking", + "Add-AzExpressRouteCircuitAuthorization": "ExpressRoute", + "New-AzNetworkManagerHub": "Networking", + "Get-AzLoadBalancerBackendAddressPoolConfig": "Load Balancer", + "Get-AzFirewallFqdnTag": "Networking", + "Get-AzFirewall": "Networking", + "New-AzApplicationGatewayWebApplicationFirewallConfiguration": "Application Gateway", + "New-AzApplicationGatewayFirewallExclusionConfig": "Application Gateway", + "Remove-AzPrivateEndpoint": "Networking", + "New-AzApplicationGatewayAutoscaleConfiguration": "Application Gateway", + "Get-AzNetworkSecurityGroup": "Networking", + "New-AzVpnSiteLink": "VPN", + "Set-AzNetworkManagerGroup": "Networking", + "Get-AzVirtualHub": "Networking", + "Remove-AzApplicationGatewayAutoscaleConfiguration": "Application Gateway", + "New-AzPublicIpAddress": "Networking", + "Get-AzServiceEndpointPolicy": "Networking", + "Get-AzVpnSiteLinkConnectionIkeSa": "VPN", + "New-AzPrivateLinkServiceIpConfig": "Networking", + "Get-AzRoutingPolicy": "Networking", + "New-AzVpnClientIpsecParameter": "VPN", + "New-AzFirewallPolicyThreatIntelWhitelist": "Networking", + "New-AzApplicationGatewaySslProfile": "Application Gateway", + "Stop-AzVpnGatewayPacketCapture": "VPN", + "Get-AzNetworkManagerManagementGroupConnection": "Networking", + "Get-AzAutoApprovedPrivateLinkService": "Networking", + "Stop-AzVirtualNetworkGatewayConnectionPacketCapture": "Virtual Network", + "New-AzFirewallPolicyExplicitProxy": "Networking", + "Start-AzVpnConnectionPacketCapture": "VPN", + "New-AzNetworkManagerSubscriptionConnection": "Networking", + "New-AzApplicationGatewayRedirectConfiguration": "Application Gateway", + "Remove-AzVpnClientRevokedCertificate": "VPN", + "Remove-AzLoadBalancer": "Load Balancer", + "Remove-AzApplicationGatewaySslCertificate": "Application Gateway", + "Add-AzVirtualNetworkGatewayIpConfig": "Virtual Network", + "Deploy-AzNetworkManagerCommit": "Networking", + "New-AzVHubRouteTable": "Route", + "Remove-AzExpressRoutePortAuthorization": "ExpressRoute", + "New-AzVirtualNetworkGateway": "Virtual Network", + "Get-AzApplicationGatewayFrontendPort": "Application Gateway", + "Update-AzVirtualRouterPeer": "Route", + "Remove-AzVirtualApplianceSite": "Networking", + "Get-AzFirewallPolicy": "Networking", + "New-AzVpnClientRevokedCertificate": "VPN", + "Update-AzVpnGateway": "VPN", + "Remove-AzVpnClientIpsecParameter": "VPN", + "Set-AzNetworkProfile": "Networking", + "Get-AzLoadBalancerInboundNatRuleConfig": "Load Balancer", + "Remove-AzVirtualRouter": "Route", + "Set-AzNetworkManagerSecurityAdminConfiguration": "Networking", + "Reset-AzP2sVpnGateway": "VPN", + "Get-AzApplicationSecurityGroup": "Networking", + "Set-AzApplicationGatewayRewriteRuleSet": "Application Gateway", + "Remove-AzVpnSite": "VPN", + "Get-AzVirtualNetworkAvailableEndpointService": "Virtual Network", + "Get-AzVpnGatewayNatRule": "VPN", + "New-AzFirewallPublicIpAddress": "Networking", + "Get-AzApplicationGatewayBackendAddressPool": "Application Gateway", + "New-AzVirtualNetworkGatewayPolicyGroupmember": "Virtual Network", + "Start-AzNetworkWatcherResourceTroubleshooting": "Network Watcher", + "Add-AzRoutingPolicy": "Networking", + "New-AzApplicationGatewayAuthenticationCertificate": "Application Gateway", + "Get-AzNetworkWatcherPacketCapture": "Network Watcher", + "Remove-AzApplicationGatewayHttpListener": "Application Gateway", + "Get-AzNetworkManagerSecurityAdminRule": "Networking", + "New-AzVpnGateway": "VPN", + "Get-AzSecurityPartnerProvider": "Networking", + "Set-AzApplicationGatewayIdentity": "Application Gateway", + "Update-AzCustomIpPrefix": "Networking", + "Set-AzApplicationGatewayTrustedClientCertificate": "Application Gateway", + "New-AzIpsecTrafficSelectorPolicy": "Networking", + "New-AzFirewallNetworkRule": "Networking", + "Remove-AzNetworkManagerSecurityAdminRuleCollection": "Networking", + "Add-AzNetworkInterfaceIpConfig": "Networking", + "Set-AzSecurityPartnerProvider": "Networking", + "Remove-AzLoadBalancerOutboundRuleConfig": "Load Balancer", + "Start-AzApplicationGateway": "Application Gateway", + "Add-AzApplicationGatewayRoutingRule": "Application Gateway", + "Get-AzVHubOutboundRoute": "Route", + "New-AzApplicationGatewayFirewallPolicyExclusionManagedRuleSet": "Application Gateway", + "Remove-AzVHubRouteTable": "Route", + "New-AzApplicationGatewayFrontendIPConfig": "Application Gateway", + "Get-AzPrivateLinkResource": "Networking", + "New-AzVpnClientRootCertificate": "VPN", + "Remove-AzNetworkManagerSecurityAdminConfiguration": "Networking", + "Remove-AzApplicationGatewayProbeConfig": "Application Gateway", + "Set-AzApplicationGatewayFrontendIPConfig": "Application Gateway", + "Set-AzNetworkWatcherConfigFlowLog": "Network Watcher", + "Remove-AzLoadBalancerBackendAddressPool": "Load Balancer", + "Get-AzApplicationGatewayHttpListenerCustomError": "Application Gateway", + "Remove-AzVpnGatewayNatRule": "VPN", + "New-AzFirewallPolicySnat": "Networking", + "New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject": "Network Watcher", + "New-AzNetworkWatcherNetworkConfigurationDiagnosticProfile": "Network Watcher", + "New-AzVpnServerConfigurationPolicyGroup": "VPN", + "New-AzContainerNicConfig": "Networking", + "New-AzNetworkInterfaceIpConfig": "Networking", + "Get-AzFirewallLearnedIpPrefix": "Networking", + "New-AzNetworkWatcherConnectionMonitorOutputObject": "Network Watcher", + "Add-AzVirtualHubRouteTable": "Route", + "Set-AzLoadBalancerOutboundRuleConfig": "Load Balancer", + "Get-AzNetworkServiceTag": "Networking", + "Add-AzVpnClientRootCertificate": "VPN", + "New-AzOffice365PolicyProperty": "Networking", + "Set-AzNetworkManagerSubscriptionConnection": "Networking", + "New-AzDdosProtectionPlan": "Networking", + "Set-AzNetworkWatcherConnectionMonitor": "Network Watcher", + "Get-AzVirtualNetworkGatewayVpnClientConnectionHealth": "Virtual Network", + "Set-AzApplicationGatewayHttpListener": "Application Gateway", + "Get-AzVirtualApplianceSite": "Networking", + "Add-AzApplicationGatewayIPConfiguration": "Application Gateway", + "Get-AzRouteServerPeerAdvertisedRoute": "Route", + "Remove-AzDelegation": "Networking", + "Get-AzVpnClientIpsecParameter": "VPN", + "New-AzRouteFilterRuleConfig": "Route", + "New-AzNetworkInterface": "Networking", + "Set-AzApplicationGatewayRequestRoutingRule": "Application Gateway", + "Get-AzVirtualNetworkGateway": "Virtual Network", + "Get-AzVirtualNetworkGatewayBGPPeerStatus": "Virtual Network", + "New-AzApplicationGatewayRewriteRule": "Application Gateway", + "New-AzNetworkManager": "Networking", + "Get-AzVirtualHubRouteTable": "Route", + "Remove-AzNetworkInterface": "Networking", + "Remove-AzApplicationGatewaySslProfile": "Application Gateway", + "Get-AzLoadBalancerFrontendIpConfig": "Load Balancer", + "New-AzNetworkManagerAddressPrefixItem": "Networking", + "Remove-AzNetworkWatcherFlowLog": "Network Watcher", + "Remove-AzNetworkInterfaceTapConfig": "Networking", + "Get-AzApplicationGatewayAvailableServerVariableAndHeader": "Application Gateway", + "Remove-AzNetworkSecurityGroup": "Networking", + "Get-AzExpressRoutePortIdentity": "ExpressRoute", + "Set-AzNatGateway": "Networking", + "Remove-AzNetworkManagerSecurityAdminRule": "Networking", + "Sync-AzVirtualNetworkPeering": "Virtual Network", + "Disconnect-AzP2SVpnGatewayVpnConnection": "VPN", + "Update-AzVpnSite": "VPN", + "Set-AzVpnClientIpsecParameter": "VPN", + "Get-AzExpressRoutePortAuthorization": "ExpressRoute", + "Add-AzVirtualNetworkSubnetConfig": "Virtual Network", + "Set-AzExpressRouteGateway": "ExpressRoute", + "Get-AzNetworkWatcherTroubleshootingResult": "Network Watcher", + "Get-AzNetworkManagerEffectiveSecurityAdminRule": "Networking", + "New-AzFirewallPolicyRuleCollectionGroup": "Networking", + "Get-AzVHubInboundRoute": "Route", + "Set-AzNetworkManagerSecurityAdminRuleCollection": "Networking", + "Get-AzVpnGateway": "VPN", + "Get-AzVpnClientPackage": "VPN", + "New-AzFirewallNatRule": "Networking", + "Update-AzVirtualHub": "Networking", + "Update-AzVirtualNetworkGatewayNatRule": "Virtual Network", + "Remove-AzExpressRouteCrossConnectionPeering": "ExpressRoute", + "Remove-AzRouteServerPeer": "Route", + "Remove-AzLoadBalancerProbeConfig": "Load Balancer", + "New-AzServiceEndpointPolicyDefinition": "Networking", + "Remove-AzVirtualNetworkPeering": "Virtual Network", + "New-AzNetworkManagerSecurityAdminRuleCollection": "Networking", + "Set-AzApplicationGatewayBackendAddressPool": "Application Gateway", + "Get-AzApplicationGatewayAuthenticationCertificate": "Application Gateway", + "Add-AzVirtualRouterPeer": "Route", + "New-AzFirewallPolicyNatRule": "Networking", + "Get-AzNetworkWatcherTopology": "Network Watcher", + "Set-AzExpressRouteCircuitConnectionConfig": "ExpressRoute", + "Get-AzExpressRouteCircuitStat": "ExpressRoute", + "New-AzIpsecPolicy": "Networking", + "Set-AzRouteConfig": "Route", + "New-AzApplicationGatewayRewriteRuleActionSet": "Application Gateway", + "Remove-AzNetworkManagerManagementGroupConnection": "Networking", + "Get-AzPrivateDnsZoneGroup": "DNS", + "New-AzApplicationGatewayFirewallPolicyExclusion": "Application Gateway", + "New-AzVirtualHubRoute": "Route", + "Add-AzApplicationGatewayCustomError": "Application Gateway", + "New-AzLoadBalancerBackendAddressConfig": "Load Balancer", + "Get-AzApplicationGatewaySslProfilePolicy": "Application Gateway", + "Remove-AzLoadBalancerInboundNatRuleConfig": "Load Balancer", + "Remove-AzApplicationGatewayRedirectConfiguration": "Application Gateway", + "Get-AzVirtualHubBgpConnection": "Networking", + "Add-AzLoadBalancerOutboundRuleConfig": "Load Balancer", + "Remove-AzExpressRouteConnection": "ExpressRoute", + "Get-AzFirewallPolicyRuleCollectionGroup": "Networking", + "Get-AzVirtualNetworkGatewayNatRule": "Virtual Network", + "Get-AzVirtualNetworkUsageList": "Virtual Network", + "Remove-AzApplicationGatewayBackendHttpSetting": "Application Gateway", + "Remove-AzLoadBalancerInboundNatPoolConfig": "Load Balancer", + "New-AzFirewallPolicyIntrusionDetection": "Networking", + "Add-AzServiceEndpointPolicyDefinition": "Networking", + "New-AzVirtualHub": "Networking", + "Set-AzApplicationGatewayAuthenticationCertificate": "Application Gateway", + "Get-AzRouteFilterRuleConfig": "Route", + "Get-AzApplicationGatewayBackendHealth": "Application Gateway", + "Set-AzNetworkManagerManagementGroupConnection": "Networking", + "Add-AzRouteServerPeer": "Route", + "Get-AzPrivateEndpoint": "Networking", + "Remove-AzApplicationGatewayPrivateLinkConfiguration": "Application Gateway", + "Get-AzApplicationGatewayPrivateLinkConfiguration": "Application Gateway", + "Remove-AzRouteServer": "Route", + "New-AzApplicationGatewayFirewallPolicyLogScrubbingConfiguration": "Application Gateway", + "Remove-AzVirtualNetworkGatewayIpConfig": "Virtual Network", + "Remove-AzRouteFilterRuleConfig": "Route", + "New-AzRouteMapRule": "Route", + "Get-AzVpnServerConfigurationPolicyGroup": "VPN", + "Get-AzNetworkWatcherFlowLogStatus": "Network Watcher", + "Remove-AzIpGroup": "Networking", + "Get-AzVirtualRouterPeerAdvertisedRoute": "Route", + "New-AzApplicationGatewayPathRuleConfig": "Application Gateway", + "Get-AzApplicationGatewayFrontendIPConfig": "Application Gateway", + "Add-AzLoadBalancerInboundNatPoolConfig": "Load Balancer", + "Set-AzApplicationGatewaySku": "Application Gateway", + "Get-AzExpressRoutePort": "ExpressRoute", + "Get-AzApplicationGatewaySslPolicy": "Application Gateway", + "Get-AzNetworkWatcherSecurityGroupView": "Network Watcher", + "New-AzVirtualWan": "Networking", + "Remove-AzExpressRoutePortIdentity": "ExpressRoute", + "Get-AzRoutingIntent": "Networking", + "Add-AzLoadBalancerFrontendIpConfig": "Load Balancer", + "Remove-AzP2sVpnGateway": "VPN", + "New-AzFirewallHubPublicIpAddress": "Networking", + "Remove-AzVirtualNetworkGatewayDefaultSite": "Virtual Network", + "New-AzLoadBalancerBackendAddressPoolTunnelInterfaceConfig": "Load Balancer", + "New-AzApplicationGatewayRoutingRule": "Application Gateway", + "New-AzNetworkManagerConnectivityConfiguration": "Networking", + "New-AzNetworkManagerSecurityAdminConfiguration": "Networking", + "New-AzNetworkWatcherConnectionMonitor": "Network Watcher", + "New-AzRoutingPolicy": "Networking", + "New-AzApplicationGateway": "Application Gateway", + "Set-AzNetworkInterface": "Networking", + "Add-AzApplicationGatewayAuthenticationCertificate": "Application Gateway", + "Get-AzApplicationGatewayCustomError": "Application Gateway", + "Set-AzApplicationGatewayCustomError": "Application Gateway", + "New-AzVirtualHubBgpConnection": "Networking", + "Reset-AzVirtualNetworkGateway": "Virtual Network", + "Set-AzFirewall": "Networking", + "Get-AzNetworkManagerSecurityAdminRuleCollection": "Networking", + "Get-AzVirtualWanVpnServerConfiguration": "VPN", + "New-AzVpnClientConfiguration": "VPN", + "Remove-AzVpnClientRootCertificate": "VPN", + "Get-AzVHubRouteTable": "Route", + "Remove-AzNetworkWatcherConnectionMonitor": "Network Watcher", + "Get-AzRouteMap": "Route", + "Set-AzPrivateEndpointConnection": "Networking", + "Set-AzLoadBalancerRuleConfig": "Load Balancer", + "Get-AzLoadBalancerOutboundRuleConfig": "Load Balancer", + "Set-AzNetworkManagerSecurityAdminRule": "Networking", + "Get-AzRouteConfig": "Route", + "Set-AzLoadBalancerBackendAddressPool": "Load Balancer", + "Set-AzNetworkManagerScopeConnection": "Networking", + "New-AzNetworkWatcherConnectionMonitorTestConfigurationObject": "Network Watcher", + "Remove-AzPublicIpAddress": "Networking", + "Get-AzVirtualNetworkTap": "Virtual Network", + "Stop-AzNetworkWatcherConnectionMonitor": "Network Watcher", + "New-AzVirtualNetworkGatewayPolicyGroup": "Virtual Network", + "New-AzApplicationGatewayHttpListener": "Application Gateway", + "Get-AzApplicationGatewayRewriteRuleSet": "Application Gateway", + "Get-AzApplicationGatewayAvailableSslOption": "Application Gateway", + "Get-AzNetworkInterfaceTapConfig": "Networking", + "Set-AzApplicationGatewayRedirectConfiguration": "Application Gateway", + "Remove-AzVirtualHubBgpConnection": "Networking", + "Get-AzNetworkManager": "Networking", + "Get-AzVpnClientRootCertificate": "VPN", + "Get-AzApplicationGatewaySslPredefinedPolicy": "Application Gateway", + "New-AzVirtualNetworkGatewayConnection": "Virtual Network", + "Add-AzApplicationGatewayPrivateLinkConfiguration": "Application Gateway", + "Get-AzNetworkVirtualApplianceConnection": "Networking", + "New-AzVirtualHubRouteTable": "Route", + "Get-AzVirtualNetworkGatewayConnection": "Virtual Network", + "New-AzApplicationGatewayFirewallMatchVariable": "Application Gateway", + "New-AzStaticRoute": "Route", + "Remove-AzFirewallPolicy": "Networking", + "New-AzApplicationGatewayFirewallDisabledRuleGroupConfig": "Application Gateway", + "New-AzExpressRoutePortLOA": "ExpressRoute", + "Get-AzDelegation": "Networking", + "Get-AzP2sVpnGatewayVpnProfile": "VPN", + "New-AzFirewallNatRuleCollection": "Networking", + "New-AzNetworkManagerGroup": "Networking", + "Add-AzApplicationGatewayListener": "Application Gateway", + "New-AzIpGroup": "Networking", + "Get-AzExpressRouteConnection": "ExpressRoute", + "Set-AzLoadBalancerFrontendIpConfig": "Load Balancer", + "Set-AzApplicationGatewayClientAuthConfiguration": "Application Gateway", + "New-AzApplicationGatewayBackendSetting": "Application Gateway", + "Test-AzPrivateLinkServiceVisibility": "Networking", + "Add-AzApplicationGatewaySslProfile": "Application Gateway", + "Remove-AzNetworkWatcher": "Network Watcher", + "Get-AzNetworkManagerStaticMember": "Networking", + "New-AzExpressRouteCircuit": "ExpressRoute", + "New-AzFirewallHubIpAddress": "Networking", + "Set-AzApplicationGatewaySslProfilePolicy": "Application Gateway", + "Add-AzApplicationGatewayUrlPathMapConfig": "Application Gateway", + "New-AzApplicationGatewayFirewallPolicySetting": "Application Gateway", + "Remove-AzExpressRouteCircuitConnectionConfig": "ExpressRoute", + "Set-AzLoadBalancerInboundNatRuleConfig": "Load Balancer", + "Get-AzVirtualWan": "Networking", + "Get-AzIpGroup": "Networking", + "New-AzExpressRoutePort": "ExpressRoute", + "Remove-AzApplicationGatewayClientAuthConfiguration": "Application Gateway", + "Get-AzPublicIpAddress": "Networking", + "Set-AzFirewallPolicy": "Networking", + "New-AzNetworkSecurityRuleConfig": "Networking", + "Get-AzExpressRouteServiceProvider": "ExpressRoute", + "New-AzLoadBalancerInboundNatPoolConfig": "Load Balancer", + "Get-AzNetworkWatcherNextHop": "Network Watcher", + "Remove-AzLoadBalancerBackendAddressPoolConfig": "Load Balancer", + "Remove-AzApplicationGatewayListener": "Application Gateway", + "Remove-AzNetworkProfile": "Networking", + "Reset-AzVirtualNetworkGatewayConnection": "Virtual Network", + "Set-AzIpAllocation": "Networking", + "New-AzApplicationGatewayPrivateLinkIpConfiguration": "Application Gateway", + "New-AzPrivateEndpoint": "Networking", + "Get-AzVirtualWanVpnConfiguration": "VPN", + "Get-AzNetworkWatcherReachabilityProvidersList": "Network Watcher", + "Stop-AzApplicationGateway": "Application Gateway", + "Get-AzNetworkWatcherConnectionMonitorReport": "Network Watcher", + "New-AzPublicIpTag": "Networking", + "Remove-AzApplicationGatewayBackendAddressPool": "Application Gateway", + "Set-AzExpressRouteConnection": "ExpressRoute", + "Remove-AzApplicationGatewayRewriteRuleSet": "Application Gateway", + "Set-AzApplicationGateway": "Application Gateway", + "Get-AzRouteServerPeerLearnedRoute": "Route", + "New-AzPacketCaptureFilterConfig": "Networking", + "Get-AzNatGateway": "Networking", + "New-AzApplicationGatewaySslCertificate": "Application Gateway", + "Set-AzApplicationGatewayListener": "Application Gateway", + "Set-AzRoutingIntent": "Networking", + "Stop-AzNetworkWatcherPacketCapture": "Network Watcher", + "Remove-AzVirtualNetworkGatewayConnection": "Virtual Network", + "Set-AzRouteFilter": "Route", + "Remove-AzSecurityPartnerProvider": "Networking", + "Set-AzApplicationGatewayFrontendPort": "Application Gateway", + "New-AzVpnServerConfiguration": "VPN", + "Add-AzApplicationGatewayHttpListenerCustomError": "Application Gateway", + "Remove-AzVpnServerConfiguration": "VPN", + "Get-AzExpressRouteCircuitRouteTableSummary": "ExpressRoute", + "Get-AzApplicationGatewayTrustedClientCertificate": "Application Gateway", + "Get-AzP2sVpnGatewayConnectionHealth": "VPN", + "New-AzApplicationGatewayRewriteRuleSet": "Application Gateway", + "Reset-AzVirtualNetworkGatewayConnectionSharedKey": "Virtual Network", + "New-AzFirewallPolicyApplicationRuleCustomHttpHeader": "Networking", + "Set-AzApplicationGatewayIPConfiguration": "Application Gateway", + "Remove-AzPrivateEndpointConnection": "Networking", + "New-AzPrivateDnsZoneGroup": "DNS", + "Get-AzEffectiveRouteTable": "Route", + "New-AzFirewallPolicySqlSetting": "Networking", + "New-AzExpressRouteCircuitPeeringConfig": "ExpressRoute", + "Start-AzVirtualnetworkGatewayPacketCapture": "Networking", + "Set-AzApplicationGatewayProbeConfig": "Application Gateway", + "New-AzExpressRouteConnection": "ExpressRoute", + "Get-AzVpnClientRevokedCertificate": "VPN", + "Remove-AzNetworkManagerStaticMember": "Networking", + "New-AzLoadBalancerBackendAddressPoolConfig": "Load Balancer", + "Start-AzVirtualNetworkGatewayConnectionPacketCapture": "Virtual Network", + "New-AzLoadBalancerProbeConfig": "Load Balancer", + "Get-AzNetworkManagerSubscriptionConnection": "Networking", + "New-AzApplicationGatewayTrustedRootCertificate": "Application Gateway", + "Get-AzAvailableServiceDelegation": "Networking", + "Add-AzApplicationGatewayBackendSetting": "Application Gateway", + "Remove-AzVirtualNetworkGatewayNatRule": "Virtual Network", + "Remove-AzNetworkManagerSubscriptionConnection": "Networking", + "Get-AzNetworkManagerActiveSecurityAdminRule": "Networking", + "Update-AzVirtualWan": "Networking", + "Remove-AzLoadBalancerRuleConfig": "Load Balancer", + "Remove-AzNetworkManagerGroup": "Networking", + "New-AzApplicationGatewaySku": "Application Gateway", + "New-AzPublicIpPrefix": "Networking", + "Get-AzEffectiveNetworkSecurityGroup": "Networking", + "New-AzFirewallThreatIntelWhitelist": "Networking", + "Update-AzVirtualApplianceSite": "Networking", + "Remove-AzVpnGateway": "VPN", + "Add-AzApplicationGatewayTrustedRootCertificate": "Application Gateway", + "Get-AzNetworkManagerActiveConnectivityConfiguration": "Networking", + "Add-AzApplicationGatewayRequestRoutingRule": "Application Gateway", + "Remove-AzApplicationGatewayFrontendPort": "Application Gateway", + "Set-AzPrivateDnsZoneGroup": "DNS", + "New-AzFirewallNetworkRuleCollection": "Networking", + "New-AzVpnClientIpsecPolicy": "VPN", + "New-AzApplicationGatewayIdentity": "Application Gateway", + "New-AzRouteMap": "Route", + "Add-AzExpressRouteCircuitPeeringConfig": "ExpressRoute", + "Get-AzNetworkSecurityRuleConfig": "Networking", + "Remove-AzNetworkInterfaceIpConfig": "Networking", + "Get-AzExpressRoutePortsLocation": "ExpressRoute", + "New-AzApplicationGatewayFirewallPolicyManagedRuleOverride": "Application Gateway", + "New-AzRoutingConfiguration": "Networking", + "Get-AzNetworkManagerScopeConnection": "Networking", + "Set-AzExpressRoutePort": "ExpressRoute", + "Remove-AzNetworkManager": "Networking", + "Get-AzApplicationGatewayHttpListener": "Application Gateway", + "Get-AzApplicationGatewayClientAuthConfiguration": "Application Gateway", + "Add-AzExpressRouteCrossConnectionPeering": "ExpressRoute", + "New-AzVirtualNetworkGatewayNatRule": "Virtual Network", + "New-AzApplicationGatewayFirewallPolicyExclusionManagedRule": "Application Gateway", + "Set-AzExpressRouteCrossConnection": "ExpressRoute", + "New-AzNetworkManagerSecurityAdminRule": "Networking", + "Get-AzNetworkProfile": "Networking", + "New-AzNetworkSecurityGroup": "Networking", + "Get-AzNetworkManagerDeploymentStatus": "Networking", + "Set-AzVirtualNetworkGatewayConnection": "Virtual Network", + "New-AzVirtualApplianceSite": "Networking", + "Get-AzLocalNetworkGateway": "Networking", + "Get-AzApplicationGatewayWafDynamicManifest": "Application Gateway", + "Deny-AzPrivateEndpointConnection": "Networking", + "Set-AzApplicationGatewayWebApplicationFirewallConfiguration": "Application Gateway", + "Get-AzServiceEndpointPolicyDefinition": "Networking", + "Test-AzNetworkWatcherConnectivity": "Network Watcher", + "Get-AzApplicationGatewayUrlPathMapConfig": "Application Gateway", + "Reset-AzVpnGateway": "VPN", + "Update-AzP2sVpnGateway": "VPN", + "Get-AzExpressRouteCircuitPeeringConfig": "ExpressRoute", + "Test-AzDnsAvailability": "DNS", + "New-AzVirtualNetworkSubnetConfig": "Virtual Network", + "Get-AzExpressRoutePortLinkConfig": "ExpressRoute", + "New-AzPrivateDnsZoneConfig": "DNS", + "Set-AzApplicationGatewayTrustedRootCertificate": "Application Gateway", + "Get-AzApplicationGatewayProbeConfig": "Application Gateway", + "Set-AzApplicationGatewayBackendHttpSetting": "Application Gateway", + "New-AzNetworkManagerManagementGroupConnection": "Networking", + "New-AzPacketCaptureScopeConfig": "Networking", + "Set-AzApplicationGatewayPrivateLinkConfiguration": "Application Gateway", + "New-AzApplicationSecurityGroup": "Networking", + "Remove-AzApplicationGatewaySslPolicy": "Application Gateway", + "Get-AzVirtualNetworkGatewayConnectionVpnDeviceConfigScript": "Virtual Network", + "New-AzApplicationGatewayBackendHttpSetting": "Application Gateway", + "New-AzLoadBalancerRuleConfig": "Load Balancer", + "New-AzNetworkWatcherFlowLog": "Network Watcher", + "Get-AzVirtualNetworkGatewayLearnedRoute": "Virtual Network", + "Add-AzVirtualNetworkPeering": "Virtual Network", + "Update-AzRouteMap": "Route", + "Remove-AzNatGateway": "Networking", + "Get-AzExpressRouteCircuit": "ExpressRoute", + "Add-AzLoadBalancerBackendAddressPoolConfig": "Load Balancer", + "Add-AzExpressRoutePortAuthorization": "ExpressRoute", + "Get-AzExpressRouteCircuitARPTable": "ExpressRoute", + "Get-AzLoadBalancer": "Load Balancer", + "Add-AzRouteConfig": "Route", + "New-AzNetworkVirtualAppliance": "Networking", + "New-AzIpConfigurationBgpPeeringAddressObject": "Networking", + "Start-AzNetworkWatcherConnectionMonitor": "Network Watcher", + "New-AzPrivateEndpointIpConfiguration": "Networking", + "Add-AzApplicationGatewayHttpListener": "Application Gateway", + "Add-AzLoadBalancerInboundNatRuleConfig": "Load Balancer", + "New-AzApplicationGatewayClientAuthConfiguration": "Application Gateway", + "Remove-AzVirtualWan": "Networking", + "Remove-AzVirtualNetworkSubnetConfig": "Virtual Network", + "New-AzApplicationGatewayFirewallPolicy": "Application Gateway", + "Add-AzLoadBalancerRuleConfig": "Load Balancer", + "Set-AzExpressRoutePortIdentity": "ExpressRoute", + "New-AzFirewallApplicationRuleCollection": "Networking", + "Get-AzNetworkWatcher": "Network Watcher", + "Set-AzLoadBalancerInboundNatPoolConfig": "Load Balancer", + "Update-AzVpnServerConfiguration": "VPN", + "Add-AzLoadBalancerProbeConfig": "Load Balancer", + "Remove-AzApplicationGatewayRequestRoutingRule": "Application Gateway", + "New-AzNetworkManagerStaticMember": "Networking", + "Disconnect-AzVirtualNetworkGatewayVpnConnection": "Virtual Network", + "New-AzNetworkWatcherProtocolConfiguration": "Network Watcher", + "Remove-AzPrivateLinkService": "Networking", + "Remove-AzApplicationGatewayUrlPathMapConfig": "Application Gateway", + "New-AzExpressRoutePortIdentity": "ExpressRoute", + "Update-AzVpnServerConfigurationPolicyGroup": "VPN", + "New-AzVpnClientConnectionConfiguration": "VPN", + "Remove-AzExpressRoutePort": "ExpressRoute", + "Remove-AzApplicationGatewayAuthenticationCertificate": "Application Gateway", + "Update-AzVHubRouteTable": "Route", + "Set-AzVirtualNetwork": "Virtual Network", + "New-AzCustomIpPrefix": "Networking", + "New-AzRouteConfig": "Route", + "New-AzVpnGatewayNatRule": "VPN", + "Set-AzIpGroup": "Networking", + "Set-AzServiceEndpointPolicyDefinition": "Networking", + "Start-AzVpnGatewayPacketCapture": "VPN", + "Remove-AzApplicationGatewayBackendSetting": "Application Gateway", + "Get-AzExpressRouteCrossConnectionPeering": "ExpressRoute", + "New-AzLocalNetworkGateway": "Networking", + "Update-AzVirtualRouter": "Route", + "Get-AzPublicIpPrefix": "Networking", + "Get-AzExpressRouteCrossConnection": "ExpressRoute", + "New-AzVirtualNetworkGatewayIpConfig": "Virtual Network", + "Get-AzExpressRouteCircuitConnectionConfig": "ExpressRoute", + "New-AzRadiusServer": "Networking", + "Get-AzApplicationGatewayTrustedRootCertificate": "Application Gateway", + "New-AzVirtualRouterAutoScaleConfiguration": "Route", + "Remove-AzApplicationGatewayIPConfiguration": "Application Gateway", + "Update-AzVpnGatewayNatRule": "VPN", + "Remove-AzVirtualNetworkTap": "Virtual Network", + "New-AzRouteMapRuleCriterion": "Route", + "New-AzRoutingIntent": "Networking", + "Remove-AzApplicationSecurityGroup": "Networking", + "Remove-AzExpressRouteCircuitAuthorization": "ExpressRoute", + "New-AzSecurityPartnerProvider": "Networking", + "Remove-AzFirewall": "Networking", + "New-AzO365PolicyProperty": "Networking", + "New-AzApplicationGatewayFirewallPolicyManagedRuleGroupOverride": "Application Gateway", + "Get-AzExpressRouteCrossConnectionRouteTableSummary": "ExpressRoute", + "Set-AzNetworkWatcherFlowLog": "Network Watcher", + "Get-AzP2sVpnGatewayDetailedConnectionHealth": "VPN", + "Set-AzApplicationGatewayHttpListenerCustomError": "Application Gateway", + "Remove-AzVirtualHubRouteTable": "Route", + "Get-AzApplicationGateway": "Application Gateway", + "New-AzVirtualApplianceAdditionalNicProperty": "Networking", + "Remove-AzRouteMap": "Route", + "Get-AzNetworkWatcherFlowLog": "Network Watcher", + "Set-AzNetworkInterfaceIpConfig": "Networking", + "Remove-AzVpnConnection": "VPN", + "Get-AzRouteServerPeer": "Route", + "Remove-AzNetworkManagerScopeConnection": "Networking", + "Remove-AzServiceEndpointPolicyDefinition": "Networking", + "Add-AzApplicationGatewayFrontendPort": "Application Gateway", + "New-AzApplicationGatewayFirewallCondition": "Application Gateway", + "New-AzRouteMapRuleAction": "Route", + "Get-AzVirtualNetwork": "Virtual Network", + "New-AzServiceEndpointPolicy": "Networking", + "New-AzLoadBalancerFrontendIpConfig": "Load Balancer", + "Add-AzDelegation": "Networking", + "New-AzRouteTable": "Route", + "Get-AzApplicationGatewaySslCertificate": "Application Gateway", + "Get-AzNetworkManagerSecurityAdminConfiguration": "Networking", + "Set-AzRouteTable": "Route", + "Get-AzBgpServiceCommunity": "Networking", + "New-AzVirtualApplianceSkuProperty": "Networking", + "New-AzLoadBalancerBackendAddressPool": "Load Balancer", + "New-AzVpnConnection": "VPN", + "Test-AzPrivateIPAddressAvailability": "Networking", + "Add-AzVirtualHubRoute": "Route", + "Move-AzExpressRouteCircuit": "ExpressRoute", + "Remove-AzRoutingPolicy": "Networking", + "Add-AzNetworkSecurityRuleConfig": "Networking", + "Get-AzNetworkManagerGroup": "Networking", + "New-AzBastion": "Networking", + "Set-AzExpressRouteCircuitPeeringConfig": "ExpressRoute", + "Get-AzApplicationGatewayWebApplicationFirewallConfiguration": "Application Gateway", + "Get-AzVpnSite": "VPN", + "Set-AzApplicationGatewayFirewallPolicy": "Application Gateway", + "New-AzNetworkWatcherPacketCapture": "Network Watcher", + "Remove-AzVirtualRouterPeer": "Route", + "Get-AzVHubEffectiveRoute": "Route", + "Set-AzExpressRouteCircuit": "ExpressRoute", + "Get-AzNetworkInterface": "Networking", + "New-AzNetworkWatcherPacketCaptureV2": "Network Watcher", + "Get-AzApplicationGatewayBackendSetting": "Application Gateway", + "Get-AzRouteFilter": "Route", + "New-AzExpressRouteGateway": "ExpressRoute", + "Remove-AzRouteConfig": "Route", + "New-AzExpressRouteCircuitAuthorization": "ExpressRoute", + "Get-AzVirtualRouterPeerLearnedRoute": "Route", + "Get-AzPrivateEndpointConnection": "Networking", + "Add-AzApplicationGatewayRewriteRuleSet": "Application Gateway", + "Get-AzBastion": "Networking", + "Set-AzVirtualNetworkSubnetConfig": "Virtual Network", + "Get-AzVirtualRouterPeer": "Route", + "New-AzContainerNicConfigIpConfig": "Networking", + "Get-AzCustomIpPrefix": "Networking", + "Get-AzMaintenancePublicConfiguration": "Maintenance", + "New-AzMaintenanceConfiguration": "Maintenance", + "Update-AzMaintenanceConfiguration": "Maintenance", + "Get-AzMaintenanceConfiguration": "Maintenance", + "Remove-AzMaintenanceConfiguration": "Maintenance", + "Remove-AzConfigurationAssignment": "Maintenance", + "New-AzConfigurationAssignment": "Maintenance", + "New-AzApplyUpdate": "Maintenance", + "Get-AzConfigurationAssignment": "Maintenance", + "Get-AzMaintenanceUpdate": "Maintenance", + "Get-AzApplyUpdate": "Maintenance", + "Get-AzMarketplacePrivateStore": "Marketplace", + "Get-AzMarketplaceQueryPrivateStoreOffer": "Marketplace", + "New-AzMarketplacePrivateStore": "Marketplace", + "Get-AzMarketplacePrivateStoreCollection": "Marketplace", + "Remove-AzMarketplacePrivateStoreCollectionOffer": "Marketplace", + "Get-AzMarketplaceCollectionToSubscriptionMapping": "Marketplace", + "Set-AzMarketplacePrivateStoreCollection": "Marketplace", + "Get-AzMarketplacePrivateStoreOffer": "Marketplace", + "Set-AzMarketplacePrivateStore": "Marketplace", + "Remove-AzMarketplacePrivateStoreOffer": "Marketplace", + "Set-AzMarketplaceBulkPrivateStoreCollectionAction": "Marketplace", + "Get-AzMarketplaceBillingPrivateStoreAccount": "Marketplace", + "Get-AzMarketplacePrivateStoreV1": "Marketplace", + "Set-AzMarketplacePrivateStoreOffer": "Marketplace", + "Get-AzMarketplacePrivateStoreCollectionOffer": "Marketplace", + "New-AzMarketplacePrivateStoreCollectionOffer": "Marketplace", + "Copy-AzMarketplacePrivateStoreCollectionOffer": "Marketplace", + "Remove-AzMarketplacePrivateStoreCollection": "Marketplace", + "New-AzMarketplacePrivateStoreCollection": "Marketplace", + "Set-AzMarketplacePrivateStoreCollectionOffer": "Marketplace", + "Set-AzDataBoxEdgeUser": "Data Box Edge", + "Remove-AzDataBoxEdgeUser": "Data Box Edge", + "New-AzDataBoxEdgeDevice": "Data Box Edge", + "New-AzDataBoxEdgeShare": "Data Box Edge", + "Get-AzDataBoxEdgeBandwidthSchedule": "Data Box Edge", + "Get-AzDataBoxEdgeStorageContainer": "Data Box Edge", + "Get-AzDataBoxEdgeRole": "Data Box Edge", + "Remove-AzDataBoxEdgeStorageContainer": "Data Box Edge", + "Get-AzDataBoxEdgeUser": "Data Box Edge", + "Get-AzDataBoxEdgeTrigger": "Data Box Edge", + "Invoke-AzDataBoxEdgeStorageContainer": "Data Box Edge", + "Remove-AzDataBoxEdgeShare": "Data Box Edge", + "Get-AzDataBoxEdgeOrder": "Data Box Edge", + "Get-AzDataBoxEdgeShare": "Data Box Edge", + "Invoke-AzDataBoxEdgeDevice": "Data Box Edge", + "New-AzDataBoxEdgeRole": "Data Box Edge", + "Remove-AzDataBoxEdgeStorageAccountCredential": "Data Box Edge", + "Get-AzDataBoxEdgeDevice": "Data Box Edge", + "Remove-AzDataBoxEdgeStorageAccount": "Data Box Edge", + "New-AzDataBoxEdgeStorageContainer": "Data Box Edge", + "Set-AzDataBoxEdgeShare": "Data Box Edge", + "New-AzDataBoxEdgeTrigger": "Data Box Edge", + "Set-AzDataBoxEdgeStorageAccountCredential": "Data Box Edge", + "Set-AzDataBoxEdgeBandwidthSchedule": "Data Box Edge", + "Get-AzDataBoxEdgeJob": "Data Box Edge", + "Invoke-AzDataBoxEdgeShare": "Data Box Edge", + "Remove-AzDataBoxEdgeDevice": "Data Box Edge", + "Get-AzDataBoxEdgeStorageAccountCredential": "Data Box Edge", + "Remove-AzDataBoxEdgeRole": "Data Box Edge", + "New-AzDataBoxEdgeUser": "Data Box Edge", + "New-AzDataBoxEdgeStorageAccount": "Data Box Edge", + "Get-AzDataBoxEdgeStorageAccount": "Data Box Edge", + "New-AzDataBoxEdgeOrder": "Data Box Edge", + "Remove-AzDataBoxEdgeOrder": "Data Box Edge", + "New-AzDataBoxEdgeStorageAccountCredential": "Data Box Edge", + "New-AzDataBoxEdgeBandwidthSchedule": "Data Box Edge", + "Remove-AzDataBoxEdgeBandwidthSchedule": "Data Box Edge", + "Set-AzDataBoxEdgeRole": "Data Box Edge", + "Remove-AzDataBoxEdgeTrigger": "Data Box Edge", + "Remove-AzWebPubSubCustomCertificate": "Web PubSub", + "New-AzWebPubSubKey": "Web PubSub", + "Get-AzWebPubSubKey": "Web PubSub", + "Update-AzWebPubSub": "Web PubSub", + "Test-AzSignalRName": "SignalR", + "Remove-AzWebPubSubHub": "Web PubSub", + "Get-AzSignalR": "SignalR", + "Remove-AzWebPubSubCustomDomain": "Web PubSub", + "Get-AzWebPubSubCustomDomain": "Web PubSub", + "Get-AzSignalRKey": "SignalR", + "New-AzWebPubSub": "Web PubSub", + "Remove-AzWebPubSub": "Web PubSub", + "New-AzSignalR": "SignalR", + "New-AzWebPubSubHub": "Web PubSub", + "Update-AzSignalRNetworkAcl": "SignalR", + "Get-AzWebPubSubSku": "Web PubSub", + "Get-AzWebPubSubUsage": "Web PubSub", + "Get-AzSignalRUsage": "SignalR", + "Get-AzWebPubSub": "Web PubSub", + "New-AzWebPubSubCustomDomain": "Web PubSub", + "New-AzWebPubSubEventNameFilterObject": "Web PubSub", + "Restart-AzSignalR": "SignalR", + "Set-AzSignalRUpstream": "SignalR", + "Restart-AzWebPubSub": "Web PubSub", + "New-AzSignalRKey": "SignalR", + "Get-AzWebPubSubHub": "Web PubSub", + "New-AzWebPubSubCustomCertificate": "Web PubSub", + "Test-AzWebPubSubNameAvailability": "Web PubSub", + "Update-AzSignalR": "SignalR", + "Remove-AzSignalR": "SignalR", + "Get-AzWebPubSubCustomCertificate": "Web PubSub", + "New-AzWebPubSubEventHubEndpointObject": "Web PubSub", + "New-AzSupportTicketCommunication": "Support", + "New-AzSupportTicket": "Support", + "Get-AzSupportService": "Support", + "Get-AzSupportProblemClassification": "Support", + "Update-AzSupportTicket": "Support", + "Get-AzSupportTicketCommunication": "Support", + "New-AzSupportContactProfileObject": "Support", + "Get-AzSupportTicket": "Support", + "Get-AzChangeAnalysis": "ChangeAnalysis", + "Get-AzCustomProviderAssociation": "Custom Resource Providers", + "New-AzCustomProvider": "Custom Resource Providers", + "Get-AzCustomProvider": "Custom Resource Providers", + "Remove-AzCustomProvider": "Custom Resource Providers", + "Remove-AzCustomProviderAssociation": "Custom Resource Providers", + "New-AzCustomProviderAssociation": "Custom Resource Providers", + "Update-AzCustomProvider": "Custom Resource Providers", + "New-AzDevSpacesController": "DevSpaces", + "Get-AzDevSpacesController": "DevSpaces", + "Remove-AzDevSpacesController": "DevSpaces", + "Update-AzDevSpacesController": "DevSpaces", + "Resume-AzNetAppFilesReplication": "NetApp Files", + "Get-AzNetAppFilesVolume": "NetApp Files", + "Remove-AzNetAppFilesBackup": "NetApp Files", + "Remove-AzNetAppFilesSnapshot": "NetApp Files", + "New-AzNetAppFilesBackup": "NetApp Files", + "Set-AzNetAppFilesPool": "NetApp Files", + "Get-AzNetAppFilesSnapshot": "NetApp Files", + "Update-AzNetAppFilesVolume": "NetApp Files", + "Update-AzNetAppFilesBackupPolicy": "NetApp Files", + "New-AzNetAppFilesBackupPolicy": "NetApp Files", + "Get-AzNetAppFilesSubvolumeMetadata": "NetApp Files", + "Update-AzNetAppFilesSnapshotPolicy": "NetApp Files", + "Update-AzNetAppFilesSubvolume": "NetApp Files", + "New-AzNetAppFilesActiveDirectory": "NetApp Files", + "Get-AzNetAppFilesVolumeQuotaRule": "NetApp Files", + "New-AzNetAppFilesExportPolicyObject": "NetApp Files", + "Get-AzNetAppFilesSubvolume": "NetApp Files", + "Get-AzNetAppFilesSnapshotPolicy": "NetApp Files", + "Remove-AzNetAppFilesVolumeGroup": "NetApp Files", + "Set-AzNetAppFilesVolumePool": "NetApp Files", + "Set-AzNetAppFilesBackupPolicy": "NetApp Files", + "Remove-AzNetAppFilesSubvolume": "NetApp Files", + "New-AzNetAppFilesSnapshot": "NetApp Files", + "Get-AzNetAppFilesVolumeRestoreStatus": "NetApp Files", + "New-AzNetAppFilesVolume": "NetApp Files", + "Get-AzNetAppFilesBackup": "NetApp Files", + "Restore-AzNetAppFilesSnapshotFile": "NetApp Files", + "Get-AzNetAppFilesReplicationStatus": "NetApp Files", + "New-AzNetAppFilesPool": "NetApp Files", + "Unlock-AzNetAppFilesVolumeFileLock": "NetApp Files", + "Remove-AzNetAppFilesPool": "NetApp Files", + "Set-AzNetAppFilesSnapshotPolicy": "NetApp Files", + "New-AzNetAppFilesVolumeGroup": "NetApp Files", + "Restore-AzNetAppFilesBackupFile": "NetApp Files", + "Update-AzNetAppFilesActiveDirectory": "NetApp Files", + "New-AzNetAppFilesSubvolume": "NetApp Files", + "Update-AzNetAppFilesAccountCredential": "NetApp Files", + "Update-AzNetAppFilesVolumeQuotaRule": "NetApp Files", + "New-AzNetAppFilesVolumeQuotaRule": "NetApp Files", + "Remove-AzNetAppFilesVolume": "NetApp Files", + "Restore-AzNetAppFilesReplication": "NetApp Files", + "Get-AzNetAppFilesVolumeReplication": "NetApp Files", + "Get-AzNetAppFilesVolumeBackupStatus": "NetApp Files", + "Suspend-AzNetAppFilesReplication": "NetApp Files", + "Get-AzNetAppFilesVolumeGroup": "NetApp Files", + "Remove-AzNetAppFilesVolumeQuotaRule": "NetApp Files", + "Get-AzNetAppFilesBackupPolicy": "NetApp Files", + "Reset-AzNetAppFilesVolumeCifsPassword": "NetApp Files", + "Initialize-AzNetAppFilesReplication": "NetApp Files", + "Get-AzNetAppFilesAccount": "NetApp Files", + "New-AzNetAppFilesAccount": "NetApp Files", + "Remove-AzNetAppFilesSnapshotPolicy": "NetApp Files", + "New-AzNetAppFilesSnapshotPolicy": "NetApp Files", + "New-AzNetAppFilesExportPolicyRuleObject": "NetApp Files", + "Update-AzNetAppFilesAccount": "NetApp Files", + "Get-AzNetAppFilesQuotaLimit": "NetApp Files", + "Restore-AzNetAppFilesVolume": "NetApp Files", + "Remove-AzNetAppFilesActiveDirectory": "NetApp Files", + "Update-AzNetAppFilesPool": "NetApp Files", + "Remove-AzNetAppFilesAccount": "NetApp Files", + "Get-AzNetAppFilesPool": "NetApp Files", + "Remove-AzNetAppFilesBackupPolicy": "NetApp Files", + "Approve-AzNetAppFilesReplication": "NetApp Files", + "Set-AzNetAppFilesAccount": "NetApp Files", + "Remove-AzNetAppFilesReplication": "NetApp Files", + "Get-AzNetAppFilesActiveDirectory": "NetApp Files", + "Update-AzNetAppFilesBackup": "NetApp Files", + "New-AzImageBuilderTemplateCustomizerObject": "Image Builder", + "Get-AzImageBuilderTemplateRunOutput": "Image Builder", + "Get-AzImageBuilderTemplate": "Image Builder", + "New-AzImageBuilderTemplateValidatorObject": "Image Builder", + "Remove-AzImageBuilderTemplate": "Image Builder", + "New-AzImageBuilderTemplateDistributorObject": "Image Builder", + "Start-AzImageBuilderTemplate": "Image Builder", + "New-AzImageBuilderTemplate": "Image Builder", + "New-AzImageBuilderTemplateSourceObject": "Image Builder", + "Stop-AzImageBuilderTemplate": "Image Builder", + "Get-AzSpringCloudAppDeployment": "Spring Cloud", + "Get-AzSpringCloudTestKey": "Spring Cloud", + "Get-AzSpringCloudConfigServer": "Spring Cloud", + "Update-AzSpringCloud": "Spring Cloud", + "Remove-AzSpringCloudConfigurationService": "Spring Cloud", + "Get-AzSpringCloudBuildServiceBuilder": "Spring Cloud", + "Remove-AzSpringCloudAppDeployment": "Spring Cloud", + "Get-AzSpringCloudApp": "Spring Cloud", + "Remove-AzSpringCloudBuildpackBinding": "Spring Cloud", + "Get-AzSpringCloudRegistry": "Spring Cloud", + "Update-AzSpringCloudAppCustomDomain": "Spring Cloud", + "Test-AzSpringCloudConfigServer": "Spring Cloud", + "Update-AzSpringCloudMonitoringSetting": "Spring Cloud", + "Update-AzSpringCloudAppBinding": "Spring Cloud", + "Remove-AzSpringCloudAppCustomDomain": "Spring Cloud", + "Deploy-AzSpringCloudApp": "Spring Cloud", + "Test-AzSpringCloudNameAvailability": "Spring Cloud", + "New-AzSpringCloudAppDeploymentSourceUploadedObject": "Spring Cloud", + "Get-AzSpringCloudAppCustomDomain": "Spring Cloud", + "Get-AzSpringCloudBuildServiceAgentPool": "Spring Cloud", + "Get-AzSpringCloudBuildService": "Spring Cloud", + "Get-AzSpringCloudRuntimeVersion": "Spring Cloud", + "New-AzSpringCloudBuildServiceAgentPool": "Spring Cloud", + "New-AzSpringCloudBuildServiceBuilder": "Spring Cloud", + "New-AzSpringCloudCertificate": "Spring Cloud", + "Remove-AzSpringCloud": "Spring Cloud", + "New-AzSpringCloudConfigurationServiceGitRepositoryObject": "Spring Cloud", + "New-AzSpringCloud": "Spring Cloud", + "New-AzSpringCloudKeyVaultCertificateObject": "Spring Cloud", + "New-AzSpringCloudAppDeployment": "Spring Cloud", + "Get-AzSpringCloudAppBinding": "Spring Cloud", + "New-AzSpringCloudAppDeploymentNetCoreZipUploadedObject": "Spring Cloud", + "New-AzSpringCloudAppBinding": "Spring Cloud", + "New-AzSpringCloudAppCustomDomain": "Spring Cloud", + "New-AzSpringCloudBuildpacksGroupObject": "Spring Cloud", + "Update-AzSpringCloudAppActiveDeployment": "Spring Cloud", + "Update-AzSpringCloudConfigServer": "Spring Cloud", + "Get-AzSpringCloudAppDeploymentLogFileUrl": "Spring Cloud", + "Test-AzSpringCloudAppCustomDomain": "Spring Cloud", + "Disable-AzSpringCloudTestEndpoint": "Spring Cloud", + "Update-AzSpringCloudAppDeployment": "Spring Cloud", + "Restart-AzSpringCloudAppDeployment": "Spring Cloud", + "Remove-AzSpringCloudCertificate": "Spring Cloud", + "Get-AzSpringCloudCertificate": "Spring Cloud", + "Start-AzSpringCloudAppDeploymentJfr": "Spring Cloud", + "New-AzSpringCloudAppDeploymentJarUploadedObject": "Spring Cloud", + "Start-AzSpringCloudAppDeployment": "Spring Cloud", + "New-AzSpringCloudConfigurationService": "Spring Cloud", + "Get-AzSpringCloudBuildServiceSupportedBuildpack": "Spring Cloud", + "Get-AzSpringCloudSku": "Spring Cloud", + "Get-AzSpringCloud": "Spring Cloud", + "Get-AzSpringCloudBuildServiceSupportedStack": "Spring Cloud", + "New-AzSpringCloudApp": "Spring Cloud", + "New-AzSpringCloudAppLoadedCertificateObject": "Spring Cloud", + "New-AzSpringCloudAppDeploymentBuildResultObject": "Spring Cloud", + "Remove-AzSpringCloudApp": "Spring Cloud", + "New-AzSpringCloudContentCertificateObject": "Spring Cloud", + "Get-AzSpringCloudBuildpackBinding": "Spring Cloud", + "New-AzSpringCloudTestKey": "Spring Cloud", + "New-AzSpringCloudBuildpackObject": "Spring Cloud", + "Enable-AzSpringCloudTestEndpoint": "Spring Cloud", + "Remove-AzSpringCloudBuildServiceBuilder": "Spring Cloud", + "New-AzSpringCloudGitPatternRepositoryObject": "Spring Cloud", + "Update-AzSpringCloudApp": "Spring Cloud", + "New-AzSpringCloudBuildpackBinding": "Spring Cloud", + "Get-AzSpringCloudMonitoringSetting": "Spring Cloud", + "Get-AzSpringCloudConfigurationService": "Spring Cloud", + "Remove-AzSpringCloudAppBinding": "Spring Cloud", + "Test-AzSpringCloudConfigurationService": "Spring Cloud", + "Stop-AzSpringCloudAppDeployment": "Spring Cloud", + "Test-AzMixedRealityNameAvailability": "Mixed Reality", + "New-AzMixedRealityRemoteRenderingAccountKey": "Mixed Reality", + "Get-AzMixedRealitySpatialAnchorsAccount": "Mixed Reality", + "New-AzMixedRealitySpatialAnchorsAccount": "Mixed Reality", + "Remove-AzMixedRealityRemoteRenderingAccount": "Mixed Reality", + "New-AzMixedRealitySpatialAnchorsAccountKey": "Mixed Reality", + "Get-AzMixedRealityObjectAnchorsAccount": "Mixed Reality", + "Remove-AzMixedRealityObjectAnchorsAccount": "Mixed Reality", + "New-AzMixedRealityObjectAnchorsAccountKey": "Mixed Reality", + "New-AzMixedRealityRemoteRenderingAccount": "Mixed Reality", + "Update-AzMixedRealityObjectAnchorsAccount": "Mixed Reality", + "Remove-AzMixedRealitySpatialAnchorsAccount": "Mixed Reality", + "Get-AzMixedRealityRemoteRenderingAccountKey": "Mixed Reality", + "Get-AzMixedRealityRemoteRenderingAccount": "Mixed Reality", + "New-AzMixedRealityObjectAnchorsAccount": "Mixed Reality", + "Update-AzMixedRealitySpatialAnchorsAccount": "Mixed Reality", + "Get-AzMixedRealitySpatialAnchorsAccountKey": "Mixed Reality", + "Update-AzMixedRealityRemoteRenderingAccount": "Mixed Reality", + "Get-AzMixedRealityObjectAnchorsAccountKey": "Mixed Reality", + "Undo-AzKeyVaultManagedHsmRemoval": "Key Vault", + "Undo-AzKeyVaultManagedStorageAccountRemoval": "Key Vault", + "Invoke-AzKeyVaultKeyRotation": "Key Vault", + "New-AzKeyVaultCertificatePolicy": "Key Vault", + "Remove-AzKeyVault": "Key Vault", + "Import-AzKeyVaultSecurityDomain": "Key Vault", + "Set-AzKeyVaultCertificatePolicy": "Key Vault", + "Update-AzKeyVaultKey": "Key Vault", + "Backup-AzKeyVaultKey": "Key Vault", + "Get-AzKeyVaultManagedStorageSasDefinition": "Key Vault", + "Update-AzKeyVaultSecret": "Key Vault", + "Remove-AzKeyVaultCertificate": "Key Vault", + "Remove-AzKeyVaultSecret": "Key Vault", + "Remove-AzKeyVaultRoleDefinition": "Key Vault", + "Get-AzKeyVaultCertificateIssuer": "Key Vault", + "New-AzKeyVaultCertificateAdministratorDetail": "Key Vault", + "Set-AzKeyVaultKeyRotationPolicy": "Key Vault", + "Set-AzKeyVaultAccessPolicy": "Key Vault", + "Remove-AzKeyVaultCertificateContact": "Key Vault", + "Undo-AzKeyVaultSecretRemoval": "Key Vault", + "Undo-AzKeyVaultKeyRemoval": "Key Vault", + "Import-AzKeyVaultCertificate": "Key Vault", + "Get-AzKeyVaultKeyRotationPolicy": "Key Vault", + "Update-AzKeyVault": "Key Vault", + "Backup-AzKeyVaultManagedStorageAccount": "Key Vault", + "Get-AzKeyVaultRandomNumber": "Key Vault", + "Undo-AzKeyVaultCertificateRemoval": "Key Vault", + "Get-AzKeyVaultRoleDefinition": "Key Vault", + "Stop-AzKeyVaultCertificateOperation": "Key Vault", + "Get-AzKeyVaultRoleAssignment": "Key Vault", + "Set-AzKeyVaultCertificateIssuer": "Key Vault", + "Restore-AzKeyVault": "Key Vault", + "Invoke-AzKeyVaultKeyOperation": "Key Vault", + "Remove-AzKeyVaultCertificateIssuer": "Key Vault", + "Set-AzKeyVaultSecret": "Key Vault", + "Export-AzKeyVaultSecurityDomain": "Key Vault", + "Get-AzKeyVaultCertificatePolicy": "Key Vault", + "New-AzKeyVaultRoleAssignment": "Key Vault", + "Backup-AzKeyVault": "Key Vault", + "New-AzKeyVault": "Key Vault", + "Get-AzKeyVaultManagedHsm": "Key Vault", + "Remove-AzKeyVaultAccessPolicy": "Key Vault", + "Update-AzKeyVaultCertificate": "Key Vault", + "New-AzKeyVaultRoleDefinition": "Key Vault", + "Remove-AzKeyVaultManagedStorageSasDefinition": "Key Vault", + "Get-AzKeyVaultCertificate": "Key Vault", + "New-AzKeyVaultCertificateOrganizationDetail": "Key Vault", + "Add-AzKeyVaultKey": "Key Vault", + "Get-AzKeyVaultManagedStorageAccount": "Key Vault", + "Restore-AzKeyVaultKey": "Key Vault", + "Remove-AzKeyVaultNetworkRule": "Key Vault", + "Add-AzKeyVaultNetworkRule": "Key Vault", + "Get-AzKeyVaultCertificateContact": "Key Vault", + "Update-AzKeyVaultNetworkRuleSet": "Key Vault", + "Set-AzKeyVaultManagedStorageSasDefinition": "Key Vault", + "New-AzKeyVaultNetworkRuleSetObject": "Key Vault", + "Restore-AzKeyVaultManagedStorageAccount": "Key Vault", + "Remove-AzKeyVaultManagedStorageAccount": "Key Vault", + "Get-AzKeyVaultCertificateOperation": "Key Vault", + "Get-AzKeyVaultKey": "Key Vault", + "Remove-AzKeyVaultRoleAssignment": "Key Vault", + "Restore-AzKeyVaultCertificate": "Key Vault", + "Update-AzKeyVaultManagedStorageAccount": "Key Vault", + "Restore-AzKeyVaultSecret": "Key Vault", + "Add-AzKeyVaultCertificate": "Key Vault", + "Add-AzKeyVaultCertificateContact": "Key Vault", + "Add-AzKeyVaultManagedStorageAccount": "Key Vault", + "Undo-AzKeyVaultRemoval": "Key Vault", + "Backup-AzKeyVaultSecret": "Key Vault", + "New-AzKeyVaultManagedHsm": "Key Vault", + "Remove-AzKeyVaultKey": "Key Vault", + "Update-AzKeyVaultManagedHsm": "Key Vault", + "Get-AzKeyVaultSecret": "Key Vault", + "Backup-AzKeyVaultCertificate": "Key Vault", + "Remove-AzKeyVaultManagedHsm": "Key Vault", + "Update-AzKeyVaultManagedStorageAccountKey": "Key Vault", + "Remove-AzKeyVaultCertificateOperation": "Key Vault", + "Get-AzKeyVault": "Key Vault", + "Undo-AzKeyVaultManagedStorageSasDefinitionRemoval": "Key Vault", + "Remove-AzServiceBusRule": "Service Bus", + "Set-AzServiceBusSubscription": "Service Bus", + "Get-AzServiceBusPrivateLink": "Service Bus", + "New-AzServiceBusTopic": "Service Bus", + "Remove-AzServiceBusTopic": "Service Bus", + "Complete-AzServiceBusMigration": "Service Bus", + "Remove-AzServiceBusPrivateEndpointConnection": "Service Bus", + "New-AzServiceBusKey": "Service Bus", + "Remove-AzServiceBusGeoDRConfiguration": "Service Bus", + "New-AzServiceBusVirtualNetworkRuleConfig": "Service Bus", + "New-AzServiceBusKeyVaultPropertiesObject": "Service Bus", + "Remove-AzServiceBusSubscription": "Service Bus", + "Get-AzServiceBusNetworkRuleSet": "Service Bus", + "Set-AzServiceBusGeoDRConfigurationBreakPair": "Service Bus", + "Get-AzServiceBusNamespace": "Service Bus", + "Deny-AzServiceBusPrivateEndpointConnection": "Service Bus", + "Test-AzServiceBusName": "Service Bus", + "Test-AzServiceBusNameAvailability": "Service Bus", + "Set-AzServiceBusGeoDRConfigurationFailOver": "Service Bus", + "Get-AzServiceBusRule": "Service Bus", + "Remove-AzServiceBusNamespace": "Service Bus", + "Set-AzServiceBusTopic": "Service Bus", + "New-AzServiceBusSubscription": "Service Bus", + "Start-AzServiceBusMigration": "Service Bus", + "New-AzServiceBusGeoDRConfiguration": "Service Bus", + "Stop-AzServiceBusMigration": "Service Bus", + "Set-AzServiceBusRule": "Service Bus", + "Set-AzServiceBusNamespace": "Service Bus", + "Get-AzServiceBusTopic": "Service Bus", + "Get-AzServiceBusPrivateEndpointConnection": "Service Bus", + "New-AzServiceBusNamespace": "Service Bus", + "New-AzServiceBusRule": "Service Bus", + "Get-AzServiceBusQueue": "Service Bus", + "Remove-AzServiceBusMigration": "Service Bus", + "Get-AzServiceBusKey": "Service Bus", + "New-AzServiceBusIPRuleConfig": "Service Bus", + "Remove-AzServiceBusQueue": "Service Bus", + "Get-AzServiceBusSubscription": "Service Bus", + "Set-AzServiceBusQueue": "Service Bus", + "New-AzServiceBusQueue": "Service Bus", + "New-AzServiceBusAuthorizationRule": "Service Bus", + "Set-AzServiceBusAuthorizationRule": "Service Bus", + "Get-AzServiceBusAuthorizationRule": "Service Bus", + "Get-AzServiceBusGeoDRConfiguration": "Service Bus", + "Approve-AzServiceBusPrivateEndpointConnection": "Service Bus", + "New-AzServiceBusAuthorizationRuleSASToken": "Service Bus", + "Remove-AzServiceBusAuthorizationRule": "Service Bus", + "Get-AzServiceBusMigration": "Service Bus", + "Set-AzServiceBusNetworkRuleSet": "Service Bus", + "Update-AzQuota": "Quota", + "New-AzQuotaLimitObject": "Quota", + "Get-AzQuotaRequestStatus": "Quota", + "Get-AzQuotaOperation": "Quota", + "New-AzQuota": "Quota", + "Get-AzQuotaUsage": "Quota", + "Get-AzQuota": "Quota", + "Get-AzRelayNamespace": "Relay", + "Get-AzWcfRelay": "Relay", + "Set-AzRelayAuthorizationRule": "Relay", + "Get-AzRelayKey": "Relay", + "Remove-AzRelayAuthorizationRule": "Relay", + "Remove-AzRelayHybridConnection": "Relay", + "New-AzRelayHybridConnection": "Relay", + "Remove-AzWcfRelay": "Relay", + "Get-AzRelayNamespaceNetworkRuleSet": "Relay", + "Update-AzRelayNamespace": "Relay", + "Test-AzRelayName": "Relay", + "New-AzRelayNetworkRuleSetIPRuleObject": "Relay", + "Remove-AzRelayNamespace": "Relay", + "Set-AzRelayHybridConnection": "Relay", + "New-AzRelayNamespace": "Relay", + "Get-AzRelayHybridConnection": "Relay", + "Set-AzWcfRelay": "Relay", + "New-AzWcfRelay": "Relay", + "Get-AzRelayAuthorizationRule": "Relay", + "New-AzRelayKey": "Relay", + "New-AzRelayAuthorizationRule": "Relay", + "Set-AzRelayNamespaceNetworkRuleSet": "Relay", + "New-AzGuestConfigurationAssignment": "Guest Configuration", + "Get-AzGuestConfigurationAssignmentReport": "Guest Configuration", + "Get-AzGuestConfigurationAssignment": "Guest Configuration", + "Remove-AzGuestConfigurationAssignment": "Guest Configuration", + "Invoke-AzContainerInstanceCommand": "Container Instances", + "New-AzContainerInstancePortObject": "Container Instances", + "Get-AzContainerInstanceLog": "Container Instances", + "Stop-AzContainerGroup": "Container Instances", + "New-AzContainerInstanceHttpHeaderObject": "Container Instances", + "Get-AzContainerInstanceCachedImage": "Container Instances", + "Add-AzContainerInstanceOutput": "Container Instances", + "Remove-AzContainerGroup": "Container Instances", + "Get-AzContainerInstanceUsage": "Container Instances", + "New-AzContainerGroupPortObject": "Container Instances", + "Get-AzContainerInstanceContainerGroupOutboundNetworkDependencyEndpoint": "Container Instances", + "Get-AzContainerInstanceCapability": "Container Instances", + "New-AzContainerInstanceObject": "Container Instances", + "New-AzContainerInstanceEnvironmentVariableObject": "Container Instances", + "New-AzContainerGroupImageRegistryCredentialObject": "Container Instances", + "Get-AzContainerGroup": "Container Instances", + "New-AzContainerGroupVolumeObject": "Container Instances", + "New-AzContainerInstanceVolumeMountObject": "Container Instances", + "New-AzContainerGroup": "Container Instances", + "Update-AzContainerGroup": "Container Instances", + "Start-AzContainerGroup": "Container Instances", + "Restart-AzContainerGroup": "Container Instances", + "New-AzContainerInstanceInitDefinitionObject": "Container Instances", + "Remove-AzContainerInstanceSubnetServiceAssociationLink": "Container Instances", + "Get-AzSentinelAlertRule": "Security Insights", + "Remove-AzSentinelIncidentRelation": "Security Insights", + "Remove-AzSentinelIncidentComment": "Security Insights", + "Remove-AzSentinelIncident": "Security Insights", + "New-AzSentinelDataConnector": "Security Insights", + "Get-AzSentinelIncident": "Security Insights", + "Remove-AzSentinelAlertRule": "Security Insights", + "Update-AzSentinelBookmark": "Security Insights", + "Update-AzSentinelAlertRuleAction": "Security Insights", + "Get-AzSentinelEntityActivity": "Security Insights", + "Update-AzSentinelBookmarkRelation": "Security Insights", + "Remove-AzSentinelBookmarkRelation": "Security Insights", + "Remove-AzSentinelBookmark": "Security Insights", + "New-AzSentinelBookmark": "Security Insights", + "New-AzSentinelIncidentRelation": "Security Insights", + "Remove-AzSentinelAutomationRule": "Security Insights", + "Get-AzSentinelEntityQuery": "Security Insights", + "Update-AzSentinelDataConnector": "Security Insights", + "New-AzSentinelAlertRuleAction": "Security Insights", + "Update-AzSentinelEntityQuery": "Security Insights", + "Update-AzSentinelAutomationRule": "Security Insights", + "New-AzSentinelBookmarkRelation": "Security Insights", + "Get-AzSentinelAlertRuleAction": "Security Insights", + "Remove-AzSentinelAlertRuleAction": "Security Insights", + "Update-AzSentinelSetting": "Security Insights", + "Get-AzSentinelEntityInsight": "Security Insights", + "Get-AzSentinelAutomationRule": "Security Insights", + "Get-AzSentinelMetadata": "Security Insights", + "Get-AzSentinelIncidentRelation": "Security Insights", + "New-AzSentinelIncident": "Security Insights", + "Get-AzSentinelIncidentAlert": "Security Insights", + "Get-AzSentinelBookmarkRelation": "Security Insights", + "Update-AzSentinelAlertRule": "Security Insights", + "New-AzSentinelAlertRule": "Security Insights", + "New-AzSentinelEntityQuery": "Security Insights", + "Remove-AzSentinelEntityQuery": "Security Insights", + "Get-AzSentinelThreatIntelligenceIndicator": "Security Insights", + "Get-AzSentinelSetting": "Security Insights", + "Get-AzSentinelEntityRelation": "Security Insights", + "Get-AzSentinelIncidentBookmark": "Security Insights", + "New-AzSentinelIncidentTeam": "Security Insights", + "Get-AzSentinelThreatIntelligenceIndicatorMetric": "Security Insights", + "Get-AzSentinelEntity": "Security Insights", + "Get-AzSentinelIncidentComment": "Security Insights", + "Get-AzSentinelBookmark": "Security Insights", + "Get-AzSentinelEntityTimeline": "Security Insights", + "Update-AzSentinelIncident": "Security Insights", + "Get-AzSentinelOnboardingState": "Security Insights", + "Get-AzSentinelEntityQueryTemplate": "Security Insights", + "Get-AzSentinelAlertRuleTemplate": "Security Insights", + "Invoke-AzSentinelThreatIntelligenceIndicatorQuery": "Security Insights", + "Remove-AzSentinelDataConnector": "Security Insights", + "New-AzSentinelAutomationRule": "Security Insights", + "Test-AzSentinelDataConnectorCheckRequirement": "Security Insights", + "Update-AzSentinelIncidentRelation": "Security Insights", + "Get-AzSentinelIncidentEntity": "Security Insights", + "Get-AzSentinelDataConnector": "Security Insights", + "New-AzSentinelIncidentComment": "Security Insights", + "Get-AzSentinelEnrichment": "Security Insights", + "New-AzSentinelOnboardingState": "Security Insights", + "Update-AzSentinelIncidentComment": "Security Insights", + "Remove-AzSentinelOnboardingState": "Security Insights", + "New-AzCloudServiceRoleProfilePropertiesObject": "Cloud Services", + "Get-AzCloudServiceInstanceView": "Cloud Services", + "Update-AzCloudService": "Cloud Services", + "Get-AzCloudServiceOSFamily": "Cloud Services", + "Invoke-AzCloudServiceReimage": "Cloud Services", + "Restart-AzCloudServiceRoleInstance": "Cloud Services", + "Invoke-AzCloudServiceRoleInstanceRebuild": "Cloud Services", + "New-AzCloudServiceRemoteDesktopExtensionObject": "Cloud Services", + "New-AzCloudServiceLoadBalancerFrontendIPConfigurationObject": "Cloud Services", + "New-AzCloudServiceExtensionObject": "Cloud Services", + "Remove-AzCloudService": "Cloud Services", + "Get-AzCloudServiceRoleInstance": "Cloud Services", + "Get-AzCloudServicePublicIPAddress": "Cloud Services", + "Get-AzCloudServiceRoleInstanceView": "Cloud Services", + "New-AzCloudServiceVaultSecretGroupObject": "Cloud Services", + "Set-AzCloudServiceUpdateDomain": "Cloud Services", + "Get-AzCloudServiceRoleInstanceRemoteDesktopFile": "Cloud Services", + "Remove-AzCloudServiceRoleInstance": "Cloud Services", + "Get-AzCloudServiceOSVersion": "Cloud Services", + "Get-AzCloudService": "Cloud Services", + "Start-AzCloudService": "Cloud Services", + "New-AzCloudServiceLoadBalancerConfigurationObject": "Cloud Services", + "New-AzCloudService": "Cloud Services", + "Restart-AzCloudService": "Cloud Services", + "Stop-AzCloudService": "Cloud Services", + "Get-AzCloudServiceNetworkInterface": "Cloud Services", + "Invoke-AzCloudServiceRebuild": "Cloud Services", + "New-AzCloudServiceDiagnosticsExtension": "Cloud Services", + "Switch-AzCloudService": "Cloud Services", + "Invoke-AzCloudServiceRoleInstanceReimage": "Cloud Services", + "Update-AzMobileNetworkPacketCoreControlPlane": "MobileNetwork", + "Trace-AzMobileNetworkCollectPacketCoreControlPlaneDiagnosticPackage": "MobileNetwork", + "New-AzMobileNetworkSimPolicy": "MobileNetwork", + "New-AzMobileNetworkPacketCoreDataPlane": "MobileNetwork", + "New-AzMobileNetworkService": "MobileNetwork", + "New-AzMobileNetwork": "MobileNetwork", + "New-AzMobileNetworkServiceDataFlowTemplateObject": "MobileNetwork", + "New-AzMobileNetworkSimGroup": "MobileNetwork", + "New-AzMobileNetworkPacketCoreControlPlane": "MobileNetwork", + "New-AzMobileNetworkAttachedDataNetwork": "MobileNetwork", + "New-AzMobileNetworkDataNetwork": "MobileNetwork", + "Get-AzMobileNetworkSim": "MobileNetwork", + "New-AzMobileNetworkSiteResourceIdObject": "MobileNetwork", + "Remove-AzMobileNetworkAttachedDataNetwork": "MobileNetwork", + "Remove-AzMobileNetworkPacketCoreControlPlane": "MobileNetwork", + "Deploy-AzMobileNetworkRollbackPacketCoreControlPlane": "MobileNetwork", + "Remove-AzMobileNetworkService": "MobileNetwork", + "Update-AzMobileNetworkSlice": "MobileNetwork", + "Update-AzMobileNetworkSite": "MobileNetwork", + "Remove-AzMobileNetworkSimGroup": "MobileNetwork", + "Update-AzMobileNetworkDataNetwork": "MobileNetwork", + "Get-AzMobileNetworkSite": "MobileNetwork", + "Remove-AzMobileNetworkSim": "MobileNetwork", + "New-AzMobileNetworkSimStaticIPPropertiesObject": "MobileNetwork", + "Remove-AzMobileNetworkPacketCoreDataPlane": "MobileNetwork", + "New-AzMobileNetworkSite": "MobileNetwork", + "New-AzMobileNetworkDataNetworkConfigurationObject": "MobileNetwork", + "Get-AzMobileNetworkPacketCoreControlPlane": "MobileNetwork", + "Remove-AzMobileNetwork": "MobileNetwork", + "New-AzMobileNetworkPccRuleConfigurationObject": "MobileNetwork", + "Remove-AzMobileNetworkSimPolicy": "MobileNetwork", + "New-AzMobileNetworkSlice": "MobileNetwork", + "Get-AzMobileNetworkDataNetwork": "MobileNetwork", + "Deploy-AzMobileNetworkReinstallPacketCoreControlPlane": "MobileNetwork", + "Update-AzMobileNetworkSimPolicy": "MobileNetwork", + "Update-AzMobileNetworkAttachedDataNetwork": "MobileNetwork", + "Update-AzMobileNetworkService": "MobileNetwork", + "New-AzMobileNetworkSliceConfigurationObject": "MobileNetwork", + "Get-AzMobileNetworkSimPolicy": "MobileNetwork", + "Update-AzMobileNetwork": "MobileNetwork", + "Remove-AzMobileNetworkSite": "MobileNetwork", + "Update-AzMobileNetworkPacketCoreDataPlane": "MobileNetwork", + "Get-AzMobileNetworkSimGroup": "MobileNetwork", + "Update-AzMobileNetworkSimGroup": "MobileNetwork", + "Get-AzMobileNetworkService": "MobileNetwork", + "Remove-AzMobileNetworkSlice": "MobileNetwork", + "Get-AzMobileNetworkPacketCoreControlPlaneVersion": "MobileNetwork", + "Get-AzMobileNetwork": "MobileNetwork", + "Get-AzMobileNetworkSlice": "MobileNetwork", + "Get-AzMobileNetworkAttachedDataNetwork": "MobileNetwork", + "Get-AzMobileNetworkPacketCoreDataPlane": "MobileNetwork", + "New-AzMobileNetworkSim": "MobileNetwork", + "New-AzMobileNetworkServiceResourceIdObject": "MobileNetwork", + "Remove-AzMobileNetworkDataNetwork": "MobileNetwork", + "Test-AzSelfHelpDiagnosticNameAvailability": "SelfHelp", + "New-AzSelfHelpDiagnostic": "SelfHelp", + "Get-AzSelfHelpDiscoverySolution": "SelfHelp", + "Get-AzSelfHelpDiagnostic": "SelfHelp", + "Update-AzLogzSubAccount": "Logz", + "New-AzLogzMonitor": "Logz", + "Remove-AzLogzSubAccount": "Logz", + "Invoke-AzLogzHostSubAccount": "Logz", + "Get-AzLogzSubAccount": "Logz", + "New-AzLogzFilteringTagObject": "Logz", + "Remove-AzLogzSubAccountTagRule": "Logz", + "New-AzLogzMonitorSSOConfiguration": "Logz", + "Get-AzLogzMonitoredResource": "Logz", + "Remove-AzLogzMonitor": "Logz", + "Get-AzLogzMonitorUserRole": "Logz", + "Get-AzLogzSubAccountTagRule": "Logz", + "Update-AzLogzSubAccountVMHost": "Logz", + "Get-AzLogzMonitorTagRule": "Logz", + "New-AzLogzSubAccount": "Logz", + "Get-AzLogzSubAccountVMHost": "Logz", + "Invoke-AzLogzHostMonitor": "Logz", + "New-AzLogzMonitorTagRule": "Logz", + "Update-AzLogzMonitor": "Logz", + "New-AzLogzVMResourcesObject": "Logz", + "Get-AzLogzMonitorSSOConfiguration": "Logz", + "Get-AzLogzMonitor": "Logz", + "Update-AzLogzMonitorVMHost": "Logz", + "New-AzLogzSubAccountTagRule": "Logz", + "Remove-AzLogzMonitorTagRule": "Logz", + "Get-AzLogzMonitorVMHost": "Logz", + "Save-AzContext": "Accounts", + "Export-AzConfig": "Accounts", + "Clear-AzContext": "Accounts", + "Enable-AzContextAutosave": "Accounts", + "Rename-AzContext": "Accounts", + "Get-AzAccessToken": "Accounts", + "Disable-AzContextAutosave": "Accounts", + "Get-AzConfig": "Accounts", + "Uninstall-AzureRm": "Accounts", + "Add-AzEnvironment": "Accounts", + "Update-AzConfig": "Accounts", + "Enable-AzDataCollection": "Accounts", + "Get-AzContextAutosaveSetting": "Accounts", + "Disable-AzureRmAlias": "Accounts", + "Get-AzEnvironment": "Accounts", + "Clear-AzConfig": "Accounts", + "Remove-AzEnvironment": "Accounts", + "Remove-AzContext": "Accounts", + "Set-AzEnvironment": "Accounts", + "Invoke-AzRestMethod": "Accounts", + "Disable-AzDataCollection": "Accounts", + "Import-AzContext": "Accounts", + "Open-AzSurveyLink": "Accounts", + "Set-AzContext": "Accounts", + "Clear-AzDefault": "Accounts", + "Get-AzSubscription": "Accounts", + "Import-AzConfig": "Accounts", + "Get-AzDefault": "Accounts", + "Send-Feedback": "Accounts", + "Register-AzModule": "Accounts", + "Resolve-AzError": "Accounts", + "Set-AzDefault": "Accounts", + "Get-AzTenant": "Accounts", + "Enable-AzureRmAlias": "Accounts", + "Connect-AzAccount": "Accounts", + "Get-AzContext": "Accounts", + "Disconnect-AzAccount": "Accounts", + "Select-AzContext": "Accounts", + "Update-AzAppConfigurationStore": "App Configuration", + "Clear-AzAppConfigurationDeletedStore": "App Configuration", + "New-AzAppConfigurationStoreKey": "App Configuration", + "New-AzAppConfigurationStore": "App Configuration", + "Test-AzAppConfigurationStoreNameAvailability": "App Configuration", + "Get-AzAppConfigurationStore": "App Configuration", + "Get-AzAppConfigurationDeletedStore": "App Configuration", + "Remove-AzAppConfigurationStore": "App Configuration", + "Get-AzAppConfigurationStoreKey": "App Configuration", + "Update-AzConnectedKubernetes": "Connected Kubernetes", + "Get-AzConnectedKubernetesUserCredential": "Connected Kubernetes", + "New-AzConnectedKubernetes": "Connected Kubernetes", + "Remove-AzConnectedKubernetes": "Connected Kubernetes", + "Get-AzConnectedKubernetes": "Connected Kubernetes", + "Restore-AzDataLakeStoreDeletedItem": "Data Lake Store", + "Export-AzDataLakeStoreChildItemProperty": "Data Lake Store", + "Export-AzDataLakeStoreItem": "Data Lake Store", + "Test-AzDataLakeStoreItem": "Data Lake Store", + "Remove-AzDataLakeStoreTrustedIdProvider": "Data Lake Store", + "Remove-AzDataLakeStoreAccount": "Data Lake Store", + "Add-AzDataLakeStoreTrustedIdProvider": "Data Lake Store", + "Remove-AzDataLakeStoreItem": "Data Lake Store", + "Get-AzDataLakeStoreItemOwner": "Data Lake Store", + "Test-AzDataLakeStoreAccount": "Data Lake Store", + "Set-AzDataLakeStoreItemAcl": "Data Lake Store", + "Set-AzDataLakeStoreAccount": "Data Lake Store", + "Add-AzDataLakeStoreVirtualNetworkRule": "Data Lake Store", + "Set-AzDataLakeStoreItemOwner": "Data Lake Store", + "Get-AzDataLakeStoreVirtualNetworkRule": "Data Lake Store", + "Join-AzDataLakeStoreItem": "Data Lake Store", + "Add-AzDataLakeStoreItemContent": "Data Lake Store", + "Get-AzDataLakeStoreItemContent": "Data Lake Store", + "Get-AzDataLakeStoreItem": "Data Lake Store", + "Set-AzDataLakeStoreItemExpiry": "Data Lake Store", + "Set-AzDataLakeStoreItemPermission": "Data Lake Store", + "Enable-AzDataLakeStoreKeyVault": "Data Lake Store", + "Get-AzDataLakeStoreDeletedItem": "Data Lake Store", + "Get-AzDataLakeStoreAccount": "Data Lake Store", + "Remove-AzDataLakeStoreItemAclEntry": "Data Lake Store", + "Set-AzDataLakeStoreItemAclEntry": "Data Lake Store", + "Get-AzDataLakeStoreItemAclEntry": "Data Lake Store", + "Set-AzDataLakeStoreFirewallRule": "Data Lake Store", + "Move-AzDataLakeStoreItem": "Data Lake Store", + "Add-AzDataLakeStoreFirewallRule": "Data Lake Store", + "Set-AzDataLakeStoreVirtualNetworkRule": "Data Lake Store", + "Set-AzDataLakeStoreTrustedIdProvider": "Data Lake Store", + "Import-AzDataLakeStoreItem": "Data Lake Store", + "New-AzDataLakeStoreAccount": "Data Lake Store", + "Remove-AzDataLakeStoreFirewallRule": "Data Lake Store", + "Get-AzDataLakeStoreTrustedIdProvider": "Data Lake Store", + "New-AzDataLakeStoreItem": "Data Lake Store", + "Remove-AzDataLakeStoreVirtualNetworkRule": "Data Lake Store", + "Get-AzDataLakeStoreItemPermission": "Data Lake Store", + "Get-AzDataLakeStoreFirewallRule": "Data Lake Store", + "Get-AzDataLakeStoreChildItemSummary": "Data Lake Store", + "Get-AzDataLakeStoreChildItem": "Data Lake Store", + "Remove-AzDataLakeStoreItemAcl": "Data Lake Store", + "Remove-AzResourceMoverMoveCollection": "Resource Mover", + "Get-AzResourceMoverMoveCollection": "Resource Mover", + "Invoke-AzResourceMoverCommit": "Resource Mover", + "Get-AzResourceMoverMoveResource": "Resource Mover", + "Add-AzResourceMoverMoveResource": "Resource Mover", + "Get-AzResourceMoverRequiredForResources": "Resource Mover", + "Remove-AzResourceMoverMoveResource": "Resource Mover", + "Invoke-AzResourceMoverBulkRemove": "Resource Mover", + "New-AzResourceMoverMoveCollection": "Resource Mover", + "Invoke-AzResourceMoverPrepare": "Resource Mover", + "Invoke-AzResourceMoverInitiateMove": "Resource Mover", + "Resolve-AzResourceMoverMoveCollectionDependency": "Resource Mover", + "Get-AzResourceMoverUnresolvedDependency": "Resource Mover", + "Invoke-AzResourceMoverDiscard": "Resource Mover", + "Set-AzIntegrationAccountReceivedIcn": "Logic Apps", + "New-AzIntegrationAccountMap": "Logic Apps", + "Set-AzIntegrationAccountAgreement": "Logic Apps", + "Remove-AzIntegrationAccountPartner": "Logic Apps", + "Get-AzIntegrationAccountCallbackUrl": "Logic Apps", + "Set-AzLogicApp": "Logic Apps", + "Set-AzIntegrationAccountMap": "Logic Apps", + "Remove-AzIntegrationAccountReceivedIcn": "Logic Apps", + "New-AzIntegrationAccountAssembly": "Logic Apps", + "Set-AzIntegrationAccountPartner": "Logic Apps", + "Get-AzLogicApp": "Logic Apps", + "Get-AzLogicAppTriggerHistory": "Logic Apps", + "Stop-AzLogicAppRun": "Logic Apps", + "Get-AzIntegrationAccountCertificate": "Logic Apps", + "New-AzIntegrationAccountBatchConfiguration": "Logic Apps", + "Set-AzIntegrationAccountAssembly": "Logic Apps", + "New-AzIntegrationAccountCertificate": "Logic Apps", + "Remove-AzIntegrationAccountAssembly": "Logic Apps", + "Get-AzIntegrationAccountPartner": "Logic Apps", + "Set-AzIntegrationAccountGeneratedIcn": "Logic Apps", + "Remove-AzIntegrationAccountAgreement": "Logic Apps", + "Remove-AzIntegrationAccountSchema": "Logic Apps", + "Get-AzIntegrationAccountGeneratedIcn": "Logic Apps", + "Get-AzLogicAppRunHistory": "Logic Apps", + "Start-AzLogicApp": "Logic Apps", + "Remove-AzIntegrationAccount": "Logic Apps", + "Set-AzIntegrationAccountSchema": "Logic Apps", + "Set-AzIntegrationAccount": "Logic Apps", + "New-AzIntegrationAccountAgreement": "Logic Apps", + "Get-AzLogicAppRunAction": "Logic Apps", + "Set-AzIntegrationAccountCertificate": "Logic Apps", + "Get-AzIntegrationAccountMap": "Logic Apps", + "Get-AzLogicAppTrigger": "Logic Apps", + "Remove-AzLogicApp": "Logic Apps", + "Get-AzLogicAppTriggerCallbackUrl": "Logic Apps", + "Get-AzIntegrationAccountSchema": "Logic Apps", + "New-AzIntegrationAccountSchema": "Logic Apps", + "New-AzIntegrationAccount": "Logic Apps", + "Get-AzIntegrationAccountAssembly": "Logic Apps", + "Get-AzIntegrationAccountBatchConfiguration": "Logic Apps", + "New-AzIntegrationAccountPartner": "Logic Apps", + "New-AzLogicApp": "Logic Apps", + "Remove-AzIntegrationAccountMap": "Logic Apps", + "Get-AzIntegrationAccountAgreement": "Logic Apps", + "Remove-AzIntegrationAccountBatchConfiguration": "Logic Apps", + "Get-AzIntegrationAccountReceivedIcn": "Logic Apps", + "Set-AzIntegrationAccountBatchConfiguration": "Logic Apps", + "Get-AzIntegrationAccount": "Logic Apps", + "Test-AzLogicApp": "Logic Apps", + "Get-AzLogicAppUpgradedDefinition": "Logic Apps", + "Remove-AzIntegrationAccountCertificate": "Logic Apps", + "Update-AzNetworkFunctionTrafficCollector": "NetworkFunction", + "Remove-AzNetworkFunctionTrafficCollector": "NetworkFunction", + "Get-AzNetworkFunctionCollectorPolicy": "NetworkFunction", + "Update-AzNetworkFunctionTrafficCollectorTag": "NetworkFunction", + "New-AzNetworkFunctionTrafficCollector": "NetworkFunction", + "New-AzNetworkFunctionCollectorPolicy": "NetworkFunction", + "Update-AzNetworkFunctionCollectorPolicy": "NetworkFunction", + "Remove-AzNetworkFunctionCollectorPolicy": "NetworkFunction", + "Update-AzNetworkFunctionCollectorPolicyTag": "NetworkFunction", + "Get-AzNetworkFunctionTrafficCollector": "NetworkFunction", + "Get-AzSqlServerVirtualNetworkRule": "SQL", + "Get-AzSqlInstanceDatabase": "SQL", + "Remove-AzSqlServerIpv6FirewallRule": "SQL", + "Start-AzSqlSyncGroupSync": "SQL", + "Switch-AzSqlDatabaseFailoverGroup": "SQL", + "Get-AzSqlElasticPoolRecommendation": "SQL", + "Remove-AzSqlServerCommunicationLink": "SQL", + "Get-AzSqlSyncAgentLinkedDatabase": "SQL", + "Get-AzSqlDatabaseExpanded": "SQL", + "Get-AzSqlSyncMember": "SQL", + "Get-AzSqlServerActiveDirectoryAdministrator": "SQL", + "Remove-AzSqlElasticJobStep": "SQL", + "Get-AzSqlDatabaseFailoverGroup": "SQL", + "New-AzSqlServerOutboundFirewallRule": "SQL", + "Disable-AzSqlServerActiveDirectoryOnlyAuthentication": "SQL", + "Remove-AzSqlServerDnsAlias": "SQL", + "Enable-AzSqlDatabaseSensitivityRecommendation": "SQL", + "Remove-AzSqlInstance": "SQL", + "Disable-AzSqlDatabaseSensitivityRecommendation": "SQL", + "Add-AzSqlInstanceKeyVaultKey": "SQL", + "Get-AzSqlDatabaseBackupShortTermRetentionPolicy": "SQL", + "Set-AzSqlElasticPoolAdvisorAutoExecuteStatus": "SQL", + "Get-AzSqlInstanceTransparentDataEncryptionProtector": "SQL", + "Clear-AzSqlServerVulnerabilityAssessmentSetting": "SQL", + "New-AzSqlElasticJobTargetGroup": "SQL", + "Get-AzSqlServerActiveDirectoryOnlyAuthentication": "SQL", + "New-AzSqlServerDisasterRecoveryConfiguration": "SQL", + "New-AzSqlServerVirtualNetworkRule": "SQL", + "Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting": "SQL", + "Remove-AzSqlServerMSSupportAudit": "SQL", + "Set-AzSqlDatabaseGeoBackupPolicy": "SQL", + "New-AzSqlSyncGroup": "SQL", + "Get-AzSqlElasticJobAgent": "SQL", + "Get-AzSqlElasticJob": "SQL", + "Set-AzSqlDatabaseBackupShortTermRetentionPolicy": "SQL", + "Set-AzSqlDatabaseSensitivityClassification": "SQL", + "New-AzSqlElasticJob": "SQL", + "Invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation": "SQL", + "Remove-AzSqlElasticJobAgent": "SQL", + "Get-AzSqlInstanceDatabaseMoveOperation": "SQL", + "Get-AzSqlInstanceAdvancedThreatProtectionSetting": "SQL", + "Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting": "SQL", + "Remove-AzSqlSyncMember": "SQL", + "Get-AzSqlInstanceDatabaseLongTermRetentionBackup": "SQL", + "Get-AzSqlSyncSchema": "SQL", + "Update-AzSqlInstanceVulnerabilityAssessmentSetting": "SQL", + "Set-AzSqlInstanceDatabaseSensitivityClassification": "SQL", + "Enable-AzSqlServerAdvancedDataSecurity": "SQL", + "Remove-AzSqlInstanceKeyVaultKey": "SQL", + "Get-AzSqlElasticJobCredential": "SQL", + "Get-AzSqlDatabaseImportExportStatus": "SQL", + "Get-AzSqlServerIpv6FirewallRule": "SQL", + "Get-AzSqlServerDnsAlias": "SQL", + "Get-AzSqlElasticJobExecution": "SQL", + "New-AzSqlInstancePool": "SQL", + "New-AzSqlServerDnsAlias": "SQL", + "Set-AzSqlElasticJobAgent": "SQL", + "Set-AzSqlInstance": "SQL", + "Get-AzSqlDatabaseReplicationLink": "SQL", + "Update-AzSqlSyncMember": "SQL", + "Get-AzSqlDatabaseDataMaskingPolicy": "SQL", + "Invoke-AzSqlServerExternalGovernanceStatusRefresh": "SQL", + "Invoke-AzSqlDatabaseFailover": "SQL", + "Get-AzSqlServerAdvancedThreatProtectionSetting": "SQL", + "Get-AzSqlDatabaseIndexRecommendation": "SQL", + "Get-AzSqlInstanceDatabaseSensitivityRecommendation": "SQL", + "Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline": "SQL", + "Remove-AzSqlDatabaseLongTermRetentionBackup": "SQL", + "Get-AzSqlInstanceLink": "SQL", + "Get-AzSqlServerTransparentDataEncryptionProtector": "SQL", + "Set-AzSqlDatabaseBackupLongTermRetentionPolicy": "SQL", + "Switch-AzSqlDatabaseInstanceFailoverGroup": "SQL", + "Remove-AzSqlSyncAgent": "SQL", + "Remove-AzSqlSyncGroup": "SQL", + "Remove-AzSqlInstanceActiveDirectoryAdministrator": "SQL", + "Get-AzSqlDatabase": "SQL", + "Get-AzSqlElasticJobStep": "SQL", + "Remove-AzSqlInstanceDatabaseSensitivityClassification": "SQL", + "Remove-AzSqlDatabaseSecondary": "SQL", + "Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation": "SQL", + "Update-AzSqlServerVulnerabilityAssessmentSetting": "SQL", + "New-AzSqlSyncMember": "SQL", + "Get-AzSqlElasticPoolActivity": "SQL", + "Stop-AzSqlDatabaseActivity": "SQL", + "Set-AzSqlDatabaseFailoverGroup": "SQL", + "Remove-AzSqlInstanceLink": "SQL", + "Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy": "SQL", + "Set-AzSqlDatabaseSecondary": "SQL", + "Get-AzSqlDeletedDatabaseBackup": "SQL", + "Remove-AzSqlInstancePool": "SQL", + "New-AzSqlServer": "SQL", + "New-AzSqlSyncAgent": "SQL", + "New-AzSqlDatabase": "SQL", + "Get-AzSqlDatabaseAdvisor": "SQL", + "Remove-AzSqlServerTrustGroup": "SQL", + "Set-AzSqlElasticPool": "SQL", + "Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline": "SQL", + "Get-AzSqlInstanceActiveDirectoryOnlyAuthentication": "SQL", + "Add-AzSqlElasticJobStep": "SQL", + "Stop-AzSqlDatabaseExecuteIndexRecommendation": "SQL", + "Get-AzSqlCapability": "SQL", + "Get-AzSqlElasticPoolRecommendedAction": "SQL", + "Set-AzSqlDatabaseAudit": "SQL", + "Get-AzSqlInstanceEndpointCertificate": "SQL", + "Set-AzSqlInstanceDtc": "SQL", + "Complete-AzSqlInstanceDatabaseCopy": "SQL", + "Stop-AzSqlInstanceOperation": "SQL", + "Add-AzSqlServerTransparentDataEncryptionCertificate": "SQL", + "New-AzSqlServerFirewallRule": "SQL", + "Convert-AzSqlDatabaseVulnerabilityAssessmentScan": "SQL", + "Stop-AzSqlInstanceDatabaseCopy": "SQL", + "Get-AzSqlServerTrustGroup": "SQL", + "Remove-AzSqlDatabaseSensitivityClassification": "SQL", + "Get-AzSqlServerRecommendedAction": "SQL", + "Get-AzSqlDatabaseBackupLongTermRetentionPolicy": "SQL", + "Get-AzSqlElasticPoolDatabase": "SQL", + "Enable-AzSqlInstanceDatabaseSensitivityRecommendation": "SQL", + "Enable-AzSqlInstanceAdvancedDataSecurity": "SQL", + "Set-AzSqlServerIpv6FirewallRule": "SQL", + "Get-AzSqlDatabaseInstanceFailoverGroup": "SQL", + "New-AzSqlServerTrustGroup": "SQL", + "Get-AzSqlDatabaseLongTermRetentionBackup": "SQL", + "Set-AzSqlDatabaseAdvisorAutoExecuteStatus": "SQL", + "Get-AzSqlElasticJobStepExecution": "SQL", + "New-AzSqlDatabaseInstanceFailoverGroup": "SQL", + "Remove-AzSqlDatabase": "SQL", + "Get-AzSqlDatabaseVulnerabilityAssessmentSetting": "SQL", + "Set-AzSqlServerMSSupportAudit": "SQL", + "Get-AzSqlServer": "SQL", + "Get-AzSqlDatabaseAudit": "SQL", + "New-AzSqlDatabaseCopy": "SQL", + "New-AzSqlDatabaseDataMaskingRule": "SQL", + "Set-AzSqlServerDisasterRecoveryConfiguration": "SQL", + "Get-AzSqlInstanceDatabaseLogReplay": "SQL", + "Get-AzSqlInstanceActiveDirectoryAdministrator": "SQL", + "Get-AzSqlElasticJobTargetExecution": "SQL", + "Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline": "SQL", + "Start-AzSqlDatabaseVulnerabilityAssessmentScan": "SQL", + "Remove-AzSqlDatabaseRestorePoint": "SQL", + "Set-AzSqlServerFirewallRule": "SQL", + "New-AzSqlServerIpv6FirewallRule": "SQL", + "Stop-AzSqlInstanceDatabaseLogReplay": "SQL", + "Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy": "SQL", + "Get-AzSqlSyncGroup": "SQL", + "Get-AzSqlInstancePoolUsage": "SQL", + "Update-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting": "SQL", + "New-AzSqlInstanceLink": "SQL", + "Set-AzSqlInstanceActiveDirectoryAdministrator": "SQL", + "Get-AzSqlServerServiceObjective": "SQL", + "Get-AzSqlDatabaseSensitivityRecommendation": "SQL", + "Get-AzSqlSyncAgent": "SQL", + "Complete-AzSqlInstanceDatabaseLogReplay": "SQL", + "Set-AzSqlServerDnsAlias": "SQL", + "Get-AzSqlServerAdvancedDataSecurityPolicy": "SQL", + "Get-AzSqlInstanceAdvancedDataSecurityPolicy": "SQL", + "Start-AzSqlElasticJob": "SQL", + "Remove-AzSqlInstanceDatabase": "SQL", + "Stop-AzSqlElasticJob": "SQL", + "Stop-AzSqlInstanceDatabaseMove": "SQL", + "Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan": "SQL", + "Set-AzSqlServerTransparentDataEncryptionProtector": "SQL", + "Clear-AzSqlDatabaseVulnerabilityAssessmentSetting": "SQL", + "Restore-AzSqlInstanceDatabase": "SQL", + "Add-AzSqlDatabaseToFailoverGroup": "SQL", + "Invoke-AzSqlElasticPoolFailover": "SQL", + "New-AzSqlDatabaseRestorePoint": "SQL", + "Get-AzSqlDeletedInstanceDatabaseBackup": "SQL", + "Set-AzSqlServerRecommendedActionState": "SQL", + "Set-AzSqlDatabaseTransparentDataEncryption": "SQL", + "Get-AzSqlInstanceOperation": "SQL", + "Get-AzSqlInstance": "SQL", + "Get-AzSqlDatabaseActivity": "SQL", + "Get-AzSqlDatabaseGeoBackup": "SQL", + "Suspend-AzSqlDatabase": "SQL", + "Remove-AzSqlElasticPool": "SQL", + "Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate": "SQL", + "Copy-AzSqlInstanceDatabase": "SQL", + "Remove-AzSqlDatabaseDataMaskingRule": "SQL", + "Get-AzSqlElasticPoolAdvisor": "SQL", + "Remove-AzSqlInstanceServerTrustCertificate": "SQL", + "Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy": "SQL", + "New-AzSqlElasticPool": "SQL", + "Set-AzSqlDatabaseRecommendedActionState": "SQL", + "Disable-AzSqlInstanceDatabaseSensitivityRecommendation": "SQL", + "Remove-AzSqlServerOutboundFirewallRule": "SQL", + "Get-AzSqlInstanceDatabaseCopyOperation": "SQL", + "Get-AzSqlServerOutboundFirewallRule": "SQL", + "Remove-AzSqlElasticJobTargetGroup": "SQL", + "Get-AzSqlDatabaseAdvancedThreatProtectionSetting": "SQL", + "Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting": "SQL", + "Get-AzSqlInstanceVulnerabilityAssessmentSetting": "SQL", + "Get-AzSqlInstancePool": "SQL", + "Set-AzSqlElasticJobStep": "SQL", + "Set-AzSqlDatabaseDataMaskingPolicy": "SQL", + "Set-AzSqlServerAdvisorAutoExecuteStatus": "SQL", + "Update-AzSqlSyncSchema": "SQL", + "Set-AzSqlInstanceTransparentDataEncryptionProtector": "SQL", + "Set-AzSqlInstancePool": "SQL", + "Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation": "SQL", + "Get-AzSqlServerCommunicationLink": "SQL", + "Get-AzSqlDatabaseRestorePoint": "SQL", + "Invoke-AzSqlInstanceFailover": "SQL", + "Get-AzSqlServerDisasterRecoveryConfigurationActivity": "SQL", + "Remove-AzSqlElasticJob": "SQL", + "Set-AzSqlServerActiveDirectoryAdministrator": "SQL", + "Remove-AzSqlElasticJobTarget": "SQL", + "Start-AzSqlInstanceDatabaseLogReplay": "SQL", + "Get-AzSqlDatabaseUpgradeHint": "SQL", + "New-AzSqlServerCommunicationLink": "SQL", + "Add-AzSqlElasticJobTarget": "SQL", + "Enable-AzSqlServerActiveDirectoryOnlyAuthentication": "SQL", + "Set-AzSqlInstanceDatabase": "SQL", + "Stop-AzSqlElasticPoolActivity": "SQL", + "Stop-AzSqlSyncGroupSync": "SQL", + "New-AzSqlSyncAgentKey": "SQL", + "Get-AzSqlDatabaseDataMaskingRule": "SQL", + "New-AzSqlInstance": "SQL", + "Get-AzSqlDatabaseGeoBackupPolicy": "SQL", + "Start-AzSqlDatabaseExecuteIndexRecommendation": "SQL", + "New-AzSqlDatabaseExport": "SQL", + "Remove-AzSqlServer": "SQL", + "Get-AzSqlElasticPool": "SQL", + "Set-AzSqlElasticJobCredential": "SQL", + "Get-AzSqlInstanceKeyVaultKey": "SQL", + "Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord": "SQL", + "Enable-AzSqlInstanceDatabaseLedgerDigestUpload": "SQL", + "Get-AzSqlInstanceDatabaseLedgerDigestUpload": "SQL", + "Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy": "SQL", + "Add-AzSqlServerKeyVaultKey": "SQL", + "Get-AzSqlServerKeyVaultKey": "SQL", + "Get-AzSqlServerUpgradeHint": "SQL", + "New-AzSqlDatabaseImport": "SQL", + "Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting": "SQL", + "Get-AzSqlServerDisasterRecoveryConfiguration": "SQL", + "New-AzSqlElasticJobCredential": "SQL", + "Set-AzSqlServerConfigurationOption": "SQL", + "Get-AzSqlDatabaseSensitivityClassification": "SQL", + "Remove-AzSqlVirtualCluster": "SQL", + "Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication": "SQL", + "Set-AzSqlDatabase": "SQL", + "Get-AzSqlDatabaseLedgerDigestUpload": "SQL", + "Set-AzSqlServer": "SQL", + "Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline": "SQL", + "Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan": "SQL", + "Get-AzSqlInstanceDtc": "SQL", + "Update-AzSqlSyncGroup": "SQL", + "Get-AzSqlInstanceDatabaseGeoBackup": "SQL", + "Update-AzSqlDatabaseAdvancedThreatProtectionSetting": "SQL", + "Get-AzSqlInstanceDatabaseSensitivityClassification": "SQL", + "Get-AzSqlDatabaseRecommendedAction": "SQL", + "Remove-AzSqlDatabaseFromFailoverGroup": "SQL", + "Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord": "SQL", + "Update-AzSqlDatabaseVulnerabilityAssessmentSetting": "SQL", + "New-AzSqlDatabaseSecondary": "SQL", + "Update-AzSqlDatabaseLongTermRetentionBackup": "SQL", + "Remove-AzSqlElasticJobCredential": "SQL", + "Remove-AzSqlServerAudit": "SQL", + "Get-AzSqlInstanceServerTrustCertificate": "SQL", + "Update-AzSqlInstanceLink": "SQL", + "Update-AzSqlInstanceAdvancedThreatProtectionSetting": "SQL", + "Get-AzSqlServerMSSupportAudit": "SQL", + "Get-AzSqlVirtualCluster": "SQL", + "Disable-AzSqlInstanceDatabaseLedgerDigestUpload": "SQL", + "Resume-AzSqlDatabase": "SQL", + "Get-AzSqlServerAdvisor": "SQL", + "Remove-AzSqlDatabaseInstanceFailoverGroup": "SQL", + "Get-AzSqlElasticJobTargetGroup": "SQL", + "Remove-AzSqlDatabaseAudit": "SQL", + "Clear-AzSqlInstanceVulnerabilityAssessmentSetting": "SQL", + "New-AzSqlDatabaseFailoverGroup": "SQL", + "Set-AzSqlServerVirtualNetworkRule": "SQL", + "Remove-AzSqlServerActiveDirectoryAdministrator": "SQL", + "Get-AzSqlServerAudit": "SQL", + "Restore-AzSqlDatabase": "SQL", + "Get-AzSqlSyncGroupLog": "SQL", + "Remove-AzSqlServerVirtualNetworkRule": "SQL", + "Remove-AzSqlInstanceDatabaseLongTermRetentionBackup": "SQL", + "Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline": "SQL", + "Remove-AzSqlDatabaseFailoverGroup": "SQL", + "Move-AzSqlInstanceDatabase": "SQL", + "Remove-AzSqlServerKeyVaultKey": "SQL", + "Get-AzSqlServerVulnerabilityAssessmentSetting": "SQL", + "Set-AzSqlElasticJob": "SQL", + "Get-AzSqlServerConfigurationOption": "SQL", + "Get-AzSqlServerFirewallRule": "SQL", + "Complete-AzSqlInstanceDatabaseMove": "SQL", + "Set-AzSqlDatabaseDataMaskingRule": "SQL", + "Set-AzSqlServerAudit": "SQL", + "Enable-AzSqlDatabaseLedgerDigestUpload": "SQL", + "New-AzSqlInstanceDatabase": "SQL", + "Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline": "SQL", + "Remove-AzSqlServerDisasterRecoveryConfiguration": "SQL", + "Disable-AzSqlServerAdvancedDataSecurity": "SQL", + "Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert": "SQL", + "Remove-AzSqlServerFirewallRule": "SQL", + "Disable-AzSqlDatabaseLedgerDigestUpload": "SQL", + "Set-AzSqlElasticPoolRecommendedActionState": "SQL", + "Update-AzSqlServerAdvancedThreatProtectionSetting": "SQL", + "New-AzSqlInstanceServerTrustCertificate": "SQL", + "Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication": "SQL", + "New-AzSqlElasticJobAgent": "SQL", + "Get-AzSqlDatabaseTransparentDataEncryption": "SQL", + "Copy-AzSqlDatabaseLongTermRetentionBackup": "SQL", + "Set-AzSqlDatabaseInstanceFailoverGroup": "SQL", + "Disable-AzSqlInstanceAdvancedDataSecurity": "SQL", + "New-AzProviderHubDefaultRollout": "ProviderHub", + "New-AzProviderHubResourceTypeRegistration": "ProviderHub", + "Get-AzProviderHubDefaultRollout": "ProviderHub", + "Remove-AzProviderHubResourceTypeRegistration": "ProviderHub", + "Get-AzProviderHubCustomRollout": "ProviderHub", + "Get-AzProviderHubSku": "ProviderHub", + "Get-AzProviderHubResourceTypeRegistration": "ProviderHub", + "Get-AzProviderHubProviderRegistration": "ProviderHub", + "Remove-AzProviderHubProviderRegistration": "ProviderHub", + "Remove-AzProviderHubDefaultRollout": "ProviderHub", + "New-AzProviderHubManifest": "ProviderHub", + "Remove-AzProviderHubSku": "ProviderHub", + "Remove-AzProviderHubNotificationRegistration": "ProviderHub", + "Get-AzProviderHubNotificationRegistration": "ProviderHub", + "New-AzProviderHubCustomRollout": "ProviderHub", + "New-AzProviderHubSku": "ProviderHub", + "Invoke-AzProviderHubManifestCheckin": "ProviderHub", + "New-AzProviderHubProviderRegistration": "ProviderHub", + "Stop-AzProviderHubDefaultRollout": "ProviderHub", + "New-AzProviderHubNotificationRegistration": "ProviderHub", + "Remove-AzHealthcareApisService": "HealthcareApis Service", + "Remove-AzHealthcareFhirService": "HealthcareApis Service", + "Remove-AzHealthcareApisWorkspace": "HealthcareApis Service", + "Get-AzHealthcareFhirDestination": "HealthcareApis Service", + "Get-AzHealthcareDicomService": "HealthcareApis Service", + "Remove-AzHealthcareIotConnectorFhirDestination": "HealthcareApis Service", + "New-AzHealthcareIotConnectorFhirDestination": "HealthcareApis Service", + "New-AzHealthcareIotConnector": "HealthcareApis Service", + "Update-AzHealthcareFhirService": "HealthcareApis Service", + "New-AzHealthcareFhirService": "HealthcareApis Service", + "New-AzHealthcareApisService": "HealthcareApis Service", + "Get-AzHealthcareIotConnectorFhirDestination": "HealthcareApis Service", + "Remove-AzHealthcareDicomService": "HealthcareApis Service", + "Remove-AzHealthcareIotConnector": "HealthcareApis Service", + "Test-AzHealthcareServiceNameAvailability": "HealthcareApis Service", + "Get-AzHealthcareFhirService": "HealthcareApis Service", + "Update-AzHealthcareApisService": "HealthcareApis Service", + "New-AzHealthcareApisWorkspace": "HealthcareApis Service", + "New-AzHealthcareDicomService": "HealthcareApis Service", + "Update-AzHealthcareApisWorkspace": "HealthcareApis Service", + "Update-AzHealthcareIotConnector": "HealthcareApis Service", + "Get-AzHealthcareApisWorkspace": "HealthcareApis Service", + "Update-AzHealthcareDicomService": "HealthcareApis Service", + "Get-AzHealthcareIotConnector": "HealthcareApis Service", + "Get-AzHealthcareApisService": "HealthcareApis Service", + "Resume-AzAnalysisServicesServer": "Analysis Services", + "Export-AzAnalysisServicesInstanceLog": "Analysis Services", + "Suspend-AzAnalysisServicesServer": "Analysis Services", + "Set-AzAnalysisServicesServer": "Analysis Services", + "Test-AzAnalysisServicesServer": "Analysis Services", + "Sync-AzAnalysisServicesInstance": "Analysis Services", + "New-AzAnalysisServicesServer": "Analysis Services", + "Add-AzAnalysisServicesAccount": "Analysis Services", + "Remove-AzAnalysisServicesServer": "Analysis Services", + "New-AzAnalysisServicesFirewallConfig": "Analysis Services", + "Get-AzAnalysisServicesServer": "Analysis Services", + "New-AzAnalysisServicesFirewallRule": "Analysis Services", + "Restart-AzAnalysisServicesInstance": "Analysis Services", + "Remove-AzPeeringRegisteredPrefix": "Peering", + "Get-AzPeeringConnectionMonitorTest": "Peering", + "New-AzPeeringExchangeConnectionObject": "Peering", + "New-AzPeeringCheckServiceProviderAvailabilityInputObject": "Peering", + "New-AzPeeringConnectionMonitorTest": "Peering", + "Remove-AzPeeringAsn": "Peering", + "New-AzPeeringRegisteredAsn": "Peering", + "Get-AzPeeringCdnPrefix": "Peering", + "Remove-AzPeeringService": "Peering", + "Get-AzPeeringService": "Peering", + "Get-AzPeeringLocation": "Peering", + "New-AzPeeringServicePrefix": "Peering", + "Get-AzPeeringReceivedRoute": "Peering", + "Get-AzPeeringRegisteredPrefix": "Peering", + "Get-AzPeeringAsn": "Peering", + "Get-AzPeeringServiceCountry": "Peering", + "New-AzPeeringRegisteredPrefix": "Peering", + "New-AzPeeringService": "Peering", + "Remove-AzPeering": "Peering", + "New-AzPeeringDirectConnectionObject": "Peering", + "Get-AzPeering": "Peering", + "Remove-AzPeeringRegisteredAsn": "Peering", + "Remove-AzPeeringServicePrefix": "Peering", + "Get-AzPeeringServiceLocation": "Peering", + "Get-AzPeeringRegisteredAsn": "Peering", + "New-AzPeeringContactDetailObject": "Peering", + "Get-AzPeeringLegacy": "Peering", + "Remove-AzPeeringConnectionMonitorTest": "Peering", + "Update-AzPeering": "Peering", + "Test-AzPeeringServiceProviderAvailability": "Peering", + "Test-AzPeeringRegisteredPrefix": "Peering", + "Get-AzPeeringServiceProvider": "Peering", + "New-AzPeering": "Peering", + "Initialize-AzPeeringServiceConnectionMonitor": "Peering", + "Update-AzPeeringService": "Peering", + "Get-AzPeeringServicePrefix": "Peering", + "Start-AzPeeringInvokeLookingGlass": "Peering", + "New-AzPeeringAsn": "Peering", + "Get-AzPeeringRpUnbilledPrefix": "Peering", + "New-AzOrbitalSpacecraft": "Orbital", + "New-AzOrbitalContactProfileLinkChannelObject": "Orbital", + "Get-AzOrbitalAvailableGroundStation": "Orbital", + "New-AzOrbitalSpacecraftContact": "Orbital", + "Get-AzOrbitalAvailableSpacecraftContact": "Orbital", + "Get-AzOrbitalContactProfile": "Orbital", + "Get-AzOrbitalSpacecraftContact": "Orbital", + "Update-AzOrbitalSpacecraft": "Orbital", + "New-AzOrbitalContactProfile": "Orbital", + "New-AzOrbitalSpacecraftLinkObject": "Orbital", + "Update-AzOrbitalContactProfile": "Orbital", + "New-AzOrbitalContactProfileLinkObject": "Orbital", + "Remove-AzOrbitalSpacecraft": "Orbital", + "Get-AzOrbitalSpacecraft": "Orbital", + "Remove-AzOrbitalSpacecraftContact": "Orbital", + "Remove-AzOrbitalContactProfile": "Orbital", + "New-AzMLWorkspaceModelContainer": "Machine Learning", + "New-AzMLWorkspaceSharedPrivateLinkResourceObject": "Machine Learning", + "New-AzMLWorkspaceKubernetesObject": "Machine Learning", + "Get-AzMLServiceQuota": "Machine Learning", + "New-AzMLWorkspaceComputeStartStopScheduleObject": "Machine Learning", + "Get-AzMLWorkspaceStorageAccountKey": "Machine Learning", + "New-AzMLWorkspaceOnlineEndpoint": "Machine Learning", + "New-AzMLWorkspaceDatastoreSasCredentialObject": "Machine Learning", + "Remove-AzMLWorkspaceBatchEndpoint": "Machine Learning", + "New-AzMLWorkspaceCodeVersion": "Machine Learning", + "New-AzMLWorkspaceUriFolderJobOutputObject": "Machine Learning", + "New-AzMLWorkspaceOnlineEndpointKey": "Machine Learning", + "Get-AzMLWorkspaceBatchDeployment": "Machine Learning", + "Update-AzMLWorkspaceCompute": "Machine Learning", + "New-AzMLWorkspaceConnection": "Machine Learning", + "New-AzMLWorkspaceMLFlowModelJobOutputObject": "Machine Learning", + "New-AzMLWorkspaceOnlineDeployment": "Machine Learning", + "Update-AzMLWorkspaceBatchEndpoint": "Machine Learning", + "Get-AzMLWorkspaceKey": "Machine Learning", + "New-AzMLWorkspaceMLTableJobInputObject": "Machine Learning", + "New-AzMLWorkspaceBatchEndpoint": "Machine Learning", + "New-AzMLWorkspaceQuotaPropertiesObject": "Machine Learning", + "New-AzMLWorkspaceDatastoreBlobObject": "Machine Learning", + "New-AzMLWorkspaceCompute": "Machine Learning", + "New-AzMLWorkspaceDataVersion": "Machine Learning", + "New-AzMLWorkspaceTritonModelJobInputObject": "Machine Learning", + "Invoke-AzMLWorkspaceNotebook": "Machine Learning", + "Get-AzMLWorkspaceCodeVersion": "Machine Learning", + "Get-AzMLWorkspaceNotebookKey": "Machine Learning", + "New-AzMLWorkspaceDataContainer": "Machine Learning", + "Get-AzMLWorkspaceEnvironmentContainer": "Machine Learning", + "New-AzMLWorkspaceSynapseSparkObject": "Machine Learning", + "Remove-AzMLWorkspaceModelVersion": "Machine Learning", + "New-AzMLWorkspaceBatchDeployment": "Machine Learning", + "New-AzMLWorkspaceUriFileJobInputObject": "Machine Learning", + "Get-AzMLWorkspaceOnlineDeploymentLog": "Machine Learning", + "Update-AzMLWorkspaceBatchDeployment": "Machine Learning", + "Remove-AzMLWorkspaceBatchDeployment": "Machine Learning", + "Update-AzMLWorkspaceOnlineEndpoint": "Machine Learning", + "Remove-AzMLWorkspaceComponentContainer": "Machine Learning", + "Get-AzMLServiceVMSize": "Machine Learning", + "New-AzMLWorkspacePipelineJobObject": "Machine Learning", + "Remove-AzMLWorkspaceEnvironmentVersion": "Machine Learning", + "Remove-AzMLWorkspaceModelContainer": "Machine Learning", + "New-AzMLWorkspaceCommandJobObject": "Machine Learning", + "Get-AzMLWorkspaceOnlineEndpointKey": "Machine Learning", + "Get-AzMLWorkspaceNotebookAccessToken": "Machine Learning", + "Get-AzMLWorkspaceDataContainer": "Machine Learning", + "New-AzMLWorkspaceDatastore": "Machine Learning", + "New-AzMLWorkspaceTritonModelJobOutputObject": "Machine Learning", + "New-AzMLWorkspaceDatastoreServicePrincipalCredentialObject": "Machine Learning", + "Remove-AzMLWorkspaceCodeVersion": "Machine Learning", + "New-AzMLWorkspaceEnvironmentVersion": "Machine Learning", + "Remove-AzMLWorkspaceCompute": "Machine Learning", + "Get-AzMLWorkspace": "Machine Learning", + "Remove-AzMLWorkspaceConnection": "Machine Learning", + "Remove-AzMLWorkspaceDataVersion": "Machine Learning", + "Get-AzMLWorkspaceFeature": "Machine Learning", + "Remove-AzMLWorkspaceEnvironmentContainer": "Machine Learning", + "New-AzMLWorkspaceComputeInstanceObject": "Machine Learning", + "New-AzMLWorkspaceJob": "Machine Learning", + "New-AzMLWorkspaceCustomModelJobOutputObject": "Machine Learning", + "Get-AzMLWorkspaceOnlineDeployment": "Machine Learning", + "Get-AzMLWorkspaceEnvironmentVersion": "Machine Learning", + "Get-AzMLWorkspaceOnlineDeploymentSku": "Machine Learning", + "Get-AzMLWorkspaceDatastoreSecret": "Machine Learning", + "Remove-AzMLWorkspaceDatastore": "Machine Learning", + "Remove-AzMLWorkspaceDataContainer": "Machine Learning", + "New-AzMLWorkspaceCustomModelJobInputObject": "Machine Learning", + "New-AzMLWorkspaceDatastoreNoneCredentialObject": "Machine Learning", + "Stop-AzMLWorkspaceCompute": "Machine Learning", + "Restart-AzMLWorkspaceCompute": "Machine Learning", + "Sync-AzMLWorkspaceKey": "Machine Learning", + "Get-AzMLWorkspaceConnection": "Machine Learning", + "Get-AzMLWorkspaceJob": "Machine Learning", + "New-AzMLWorkspaceLiteralJobInputObject": "Machine Learning", + "New-AzMLWorkspaceModelVersion": "Machine Learning", + "New-AzMLWorkspaceMLFlowModelJobInputObject": "Machine Learning", + "New-AzMLWorkspaceDatastoreCredentialObject": "Machine Learning", + "Remove-AzMLWorkspace": "Machine Learning", + "Get-AzMLWorkspaceComponentVersion": "Machine Learning", + "Get-AzMLWorkspaceDataVersion": "Machine Learning", + "New-AzMLWorkspaceHDInsightObject": "Machine Learning", + "Invoke-AzMLWorkspaceDiagnose": "Machine Learning", + "New-AzMLWorkspaceAksObject": "Machine Learning", + "Remove-AzMLWorkspaceOnlineEndpoint": "Machine Learning", + "Get-AzMLWorkspaceDatastore": "Machine Learning", + "Stop-AzMLWorkspaceJob": "Machine Learning", + "Get-AzMLWorkspaceComponentContainer": "Machine Learning", + "Remove-AzMLWorkspaceOnlineDeployment": "Machine Learning", + "New-AzMLWorkspaceDatastoreKeyCredentialObject": "Machine Learning", + "New-AzMLWorkspaceDatastoreDataLakeGen1Object": "Machine Learning", + "Start-AzMLWorkspaceCompute": "Machine Learning", + "Remove-AzMLWorkspaceComponentVersion": "Machine Learning", + "Get-AzMLWorkspaceBatchEndpoint": "Machine Learning", + "Remove-AzMLWorkspaceJob": "Machine Learning", + "Update-AzMLServiceQuota": "Machine Learning", + "New-AzMLWorkspaceUriFileJobOutputObject": "Machine Learning", + "Get-AzMLWorkspaceModelVersion": "Machine Learning", + "Get-AzMLWorkspaceModelContainer": "Machine Learning", + "Update-AzMLWorkspace": "Machine Learning", + "New-AzMLWorkspaceDatastoreDataLakeGen2Object": "Machine Learning", + "New-AzMLWorkspaceUriFolderJobInputObject": "Machine Learning", + "Get-AzMLWorkspaceOnlineEndpointToken": "Machine Learning", + "Update-AzMLWorkspaceOnlineDeployment": "Machine Learning", + "New-AzMLWorkspaceDataFactoryObject": "Machine Learning", + "New-AzMLWorkspace": "Machine Learning", + "Get-AzMLWorkspaceCompute": "Machine Learning", + "New-AzMLWorkspaceMLTableJobOutputObject": "Machine Learning", + "Get-AzMLWorkspaceComputeNode": "Machine Learning", + "New-AzMLWorkspaceAmlComputeObject": "Machine Learning", + "New-AzMLWorkspaceDataLakeAnalyticsObject": "Machine Learning", + "New-AzMLWorkspaceJobServiceObject": "Machine Learning", + "New-AzMLWorkspaceComponentContainer": "Machine Learning", + "Get-AzMLWorkspaceOnlineEndpoint": "Machine Learning", + "New-AzMLWorkspaceSweepJobObject": "Machine Learning", + "New-AzMLWorkspaceDatastoreFileObject": "Machine Learning", + "New-AzMLWorkspaceVirtualMachineObject": "Machine Learning", + "Get-AzMLWorkspaceComputeKey": "Machine Learning", + "New-AzMLWorkspaceDatabricksObject": "Machine Learning", + "Get-AzMLServiceUsage": "Machine Learning", + "New-AzMLWorkspaceComponentVersion": "Machine Learning", + "Get-AzMLWorkspaceOutboundNetworkDependencyEndpoint": "Machine Learning", + "Add-AzServiceFabricNodeType": "Service Fabric", + "Add-AzServiceFabricManagedNodeTypeVMExtension": "Service Fabric", + "Remove-AzServiceFabricApplication": "Service Fabric", + "New-AzServiceFabricManagedClusterApplicationType": "Service Fabric", + "Get-AzServiceFabricService": "Service Fabric", + "Update-AzServiceFabricNodeType": "Service Fabric", + "Add-AzServiceFabricManagedClusterNetworkSecurityRule": "Service Fabric", + "Remove-AzServiceFabricNodeType": "Service Fabric", + "New-AzServiceFabricManagedCluster": "Service Fabric", + "Remove-AzServiceFabricManagedNodeTypeVMExtension": "Service Fabric", + "Remove-AzServiceFabricManagedClusterApplicationTypeVersion": "Service Fabric", + "Get-AzServiceFabricManagedClusterService": "Service Fabric", + "Remove-AzServiceFabricManagedClusterService": "Service Fabric", + "Remove-AzServiceFabricManagedClusterApplication": "Service Fabric", + "Get-AzServiceFabricManagedClusterApplicationType": "Service Fabric", + "Get-AzServiceFabricManagedNodeType": "Service Fabric", + "New-AzServiceFabricApplication": "Service Fabric", + "Set-AzServiceFabricManagedClusterApplication": "Service Fabric", + "Add-AzServiceFabricManagedNodeTypeVMSecret": "Service Fabric", + "Remove-AzServiceFabricService": "Service Fabric", + "Update-AzServiceFabricReliability": "Service Fabric", + "Remove-AzServiceFabricClientCertificate": "Service Fabric", + "New-AzServiceFabricManagedClusterApplicationTypeVersion": "Service Fabric", + "Update-AzServiceFabricDurability": "Service Fabric", + "Set-AzServiceFabricManagedClusterApplicationType": "Service Fabric", + "Get-AzServiceFabricApplicationType": "Service Fabric", + "New-AzServiceFabricManagedClusterApplication": "Service Fabric", + "New-AzServiceFabricManagedClusterService": "Service Fabric", + "Remove-AzServiceFabricManagedClusterClientCertificate": "Service Fabric", + "Set-AzServiceFabricManagedNodeType": "Service Fabric", + "Set-AzServiceFabricSetting": "Service Fabric", + "Get-AzServiceFabricManagedClusterApplication": "Service Fabric", + "Remove-AzServiceFabricManagedClusterApplicationType": "Service Fabric", + "Get-AzServiceFabricManagedCluster": "Service Fabric", + "Remove-AzServiceFabricSetting": "Service Fabric", + "Update-AzServiceFabricVmImage": "Service Fabric", + "Set-AzServiceFabricManagedCluster": "Service Fabric", + "Add-AzServiceFabricClientCertificate": "Service Fabric", + "Add-AzServiceFabricManagedClusterClientCertificate": "Service Fabric", + "Get-AzServiceFabricApplicationTypeVersion": "Service Fabric", + "New-AzServiceFabricService": "Service Fabric", + "Remove-AzServiceFabricNode": "Service Fabric", + "Set-AzServiceFabricUpgradeType": "Service Fabric", + "New-AzServiceFabricCluster": "Service Fabric", + "Restart-AzServiceFabricManagedNodeType": "Service Fabric", + "New-AzServiceFabricApplicationType": "Service Fabric", + "Update-AzServiceFabricApplication": "Service Fabric", + "Remove-AzServiceFabricApplicationTypeVersion": "Service Fabric", + "Remove-AzServiceFabricManagedCluster": "Service Fabric", + "Set-AzServiceFabricManagedClusterApplicationTypeVersion": "Service Fabric", + "Remove-AzServiceFabricManagedNodeType": "Service Fabric", + "New-AzServiceFabricApplicationTypeVersion": "Service Fabric", + "Get-AzServiceFabricCluster": "Service Fabric", + "Set-AzServiceFabricManagedClusterService": "Service Fabric", + "Get-AzServiceFabricApplication": "Service Fabric", + "Remove-AzServiceFabricApplicationType": "Service Fabric", + "Get-AzServiceFabricManagedClusterApplicationTypeVersion": "Service Fabric", + "Add-AzServiceFabricNode": "Service Fabric", + "New-AzServiceFabricManagedNodeType": "Service Fabric", + "Get-AzEventCategory": "Monitor", + "New-AzActivityLogAlertAlertRuleLeafConditionObject": "Monitor", + "New-AzScheduledQueryRuleDimensionObject": "Monitor", + "New-AzActivityLogAlert": "Monitor", + "Remove-AzAutoscaleSetting": "Monitor", + "Get-AzDiagnosticSetting": "Monitor", + "Get-AzMetricDefinition": "Monitor", + "Get-AzScheduledQueryRule": "Monitor", + "Add-AzLogProfile": "Monitor", + "Remove-AzMonitorWorkspace": "Monitor", + "Get-AzMetric": "Monitor", + "Get-AzDiagnosticSettingCategory": "Monitor", + "Update-AzDataCollectionRule": "Monitor", + "Get-AzInsightsPrivateLinkScope": "Monitor", + "Get-AzActivityLog": "Monitor", + "New-AzDiagnosticSettingSubscriptionLogSettingsObject": "Monitor", + "Get-AzSubscriptionDiagnosticSetting": "Monitor", + "New-AzMonitorWorkspace": "Monitor", + "Remove-AzMetricAlertRuleV2": "Monitor", + "New-AzActivityLogAlertAlertRuleAnyOfOrLeafConditionObject": "Monitor", + "Remove-AzActivityLogAlert": "Monitor", + "New-AzActionGroupReceiver": "Monitor", + "New-AzAutoscaleWebhookNotificationObject": "Monitor", + "Update-AzAutoscaleSetting": "Monitor", + "Remove-AzDiagnosticSetting": "Monitor", + "Test-AzActionGroup": "Monitor", + "New-AzScheduledQueryRuleConditionObject": "Monitor", + "Get-AzMetricAlertRuleV2": "Monitor", + "New-AzMetricFilter": "Monitor", + "New-AzMetricAlertRuleV2Criteria": "Monitor", + "Update-AzMonitorWorkspace": "Monitor", + "Set-AzActionGroup": "Monitor", + "Get-AzAutoscaleSetting": "Monitor", + "Get-AzDataCollectionRuleAssociation": "Monitor", + "New-AzDataCollectionRule": "Monitor", + "New-AzActivityLogAlertActionGroupObject": "Monitor", + "New-AzInsightsPrivateLinkScopedResource": "Monitor", + "Get-AzAlertRule": "Monitor", + "New-AzAlertRuleEmail": "Monitor", + "New-AzDiagnosticSettingMetricSettingsObject": "Monitor", + "New-AzScheduledQueryRule": "Monitor", + "Update-AzInsightsPrivateLinkScope": "Monitor", + "New-AzInsightsPrivateLinkScope": "Monitor", + "Add-AzMetricAlertRuleV2": "Monitor", + "New-AzAutoscaleNotificationObject": "Monitor", + "Get-AzActionGroup": "Monitor", + "Get-AzMonitorWorkspace": "Monitor", + "Update-AzScheduledQueryRule": "Monitor", + "Remove-AzSubscriptionDiagnosticSetting": "Monitor", + "New-AzDataCollectionRuleAssociation": "Monitor", + "Add-AzWebtestAlertRule": "Monitor", + "Set-AzDataCollectionRule": "Monitor", + "Get-AzDataCollectionRule": "Monitor", + "New-AzSubscriptionDiagnosticSetting": "Monitor", + "New-AzAlertRuleWebhook": "Monitor", + "New-AzAutoscaleScaleRuleMetricDimensionObject": "Monitor", + "Get-AzAlertHistory": "Monitor", + "Remove-AzInsightsPrivateLinkScopedResource": "Monitor", + "Remove-AzDataCollectionRule": "Monitor", + "Get-AzAutoscalePredictiveMetric": "Monitor", + "New-AzMetricAlertRuleV2DimensionSelection": "Monitor", + "Get-AzActivityLogAlert": "Monitor", + "Remove-AzScheduledQueryRule": "Monitor", + "Update-AzActivityLogAlert": "Monitor", + "New-AzAutoscaleScaleRuleObject": "Monitor", + "Get-AzInsightsPrivateLinkScopedResource": "Monitor", + "Remove-AzAlertRule": "Monitor", + "Remove-AzInsightsPrivateLinkScope": "Monitor", + "Get-AzLogProfile": "Monitor", + "New-AzAutoscaleSetting": "Monitor", + "Add-AzMetricAlertRule": "Monitor", + "Remove-AzDataCollectionRuleAssociation": "Monitor", + "Remove-AzLogProfile": "Monitor", + "New-AzDiagnosticSetting": "Monitor", + "New-AzDiagnosticSettingLogSettingsObject": "Monitor", + "Get-AzAutoscaleHistory": "Monitor", + "New-AzAutoscaleProfileObject": "Monitor", + "Remove-AzActionGroup": "Monitor", + "Get-AzTimeSeriesInsightsEnvironment": "Time Series Insights", + "New-AzTimeSeriesInsightsEnvironment": "Time Series Insights", + "New-AzTimeSeriesInsightsEventSource": "Time Series Insights", + "Remove-AzTimeSeriesInsightsAccessPolicy": "Time Series Insights", + "Get-AzTimeSeriesInsightsAccessPolicy": "Time Series Insights", + "New-AzTimeSeriesInsightsAccessPolicy": "Time Series Insights", + "Get-AzTimeSeriesInsightsReferenceDataSet": "Time Series Insights", + "Update-AzTimeSeriesInsightsEventSource": "Time Series Insights", + "Update-AzTimeSeriesInsightsEnvironment": "Time Series Insights", + "New-AzTimeSeriesInsightsReferenceDataSet": "Time Series Insights", + "Update-AzTimeSeriesInsightsAccessPolicy": "Time Series Insights", + "Remove-AzTimeSeriesInsightsEventSource": "Time Series Insights", + "Remove-AzTimeSeriesInsightsEnvironment": "Time Series Insights", + "Remove-AzTimeSeriesInsightsReferenceDataSet": "Time Series Insights", + "Update-AzTimeSeriesInsightsReferenceDataSet": "Time Series Insights", + "Get-AzTimeSeriesInsightsEventSource": "Time Series Insights", + "Invoke-AzWorkloadsSapSizingRecommendation": "Workloads", + "New-AzWorkloadsSapLandscapeMonitorMetricThresholdsObject": "Workloads", + "Start-AzWorkloadsSapApplicationInstance": "Workloads", + "Invoke-AzWorkloadsSapDiskConfiguration": "Workloads", + "New-AzWorkloadsProviderDB2InstanceObject": "Workloads", + "Start-AzWorkloadsSapVirtualInstance": "Workloads", + "New-AzWorkloadsProviderSapNetWeaverInstanceObject": "Workloads", + "New-AzWorkloadsProviderPrometheusOSInstanceObject": "Workloads", + "Stop-AzWorkloadsSapCentralInstance": "Workloads", + "New-AzWorkloadsProviderSqlServerInstanceObject": "Workloads", + "Get-AzWorkloadsSapApplicationInstance": "Workloads", + "Update-AzWorkloadsSapCentralInstance": "Workloads", + "New-AzWorkloadsSapLandscapeMonitorSidMappingObject": "Workloads", + "Update-AzWorkloadsSapVirtualInstance": "Workloads", + "Get-AzWorkloadsProviderInstance": "Workloads", + "Remove-AzWorkloadsSapVirtualInstance": "Workloads", + "New-AzWorkloadsMonitor": "Workloads", + "New-AzWorkloadsSapVirtualInstance": "Workloads", + "Update-AzWorkloadsMonitor": "Workloads", + "Start-AzWorkloadsSapDatabaseInstance": "Workloads", + "New-AzWorkloadsProviderInstance": "Workloads", + "Get-AzWorkloadsMonitor": "Workloads", + "Remove-AzWorkloadsProviderInstance": "Workloads", + "Remove-AzWorkloadsMonitor": "Workloads", + "Invoke-AzWorkloadsSapSupportedSku": "Workloads", + "Get-AzWorkloadsSapLandscapeMonitor": "Workloads", + "Get-AzWorkloadsSapVirtualInstance": "Workloads", + "Update-AzWorkloadsSapLandscapeMonitor": "Workloads", + "Start-AzWorkloadsSapCentralInstance": "Workloads", + "New-AzWorkloadsProviderPrometheusHaClusterInstanceObject": "Workloads", + "Stop-AzWorkloadsSapVirtualInstance": "Workloads", + "New-AzWorkloadsProviderHanaDbInstanceObject": "Workloads", + "Get-AzWorkloadsSapDatabaseInstance": "Workloads", + "Update-AzWorkloadsSapDatabaseInstance": "Workloads", + "Stop-AzWorkloadsSapDatabaseInstance": "Workloads", + "Stop-AzWorkloadsSapApplicationInstance": "Workloads", + "Get-AzWorkloadsSapCentralInstance": "Workloads", + "Update-AzWorkloadsSapApplicationInstance": "Workloads", + "New-AzWorkloadsSapLandscapeMonitor": "Workloads", + "Remove-AzWorkloadsSapLandscapeMonitor": "Workloads", + "Get-AzBotService": "Bot Services", + "Initialize-AzBotServicePrepareDeploy": "Bot Services", + "Update-AzBotService": "Bot Services", + "New-AzBotServiceDirectLineKey": "Bot Services", + "Remove-AzBotService": "Bot Services", + "Publish-AzBotServiceApp": "Bot Services", + "New-AzBotService": "Bot Services", + "Get-AzBotServiceHostSetting": "Bot Services", + "Export-AzBotServiceApp": "Bot Services", + "New-AzCosmosDBMongoDBPrivilege": "Cosmos DB", + "Get-AzCosmosDBGremlinRestorableResource": "Cosmos DB", + "Get-AzCosmosDBGremlinDatabase": "Cosmos DB", + "New-AzCosmosDBSqlIndexingPolicy": "Cosmos DB", + "Update-AzCosmosDbClientEncryptionKey": "Cosmos DB", + "New-AzCosmosDBSqlIncludedPathIndex": "Cosmos DB", + "Invoke-AzCosmosDBMongoDBCollectionThroughputMigration": "Cosmos DB", + "New-AzCosmosDBSqlContainer": "Cosmos DB", + "Remove-AzCosmosDBSqlTrigger": "Cosmos DB", + "New-AzCosmosDBService": "Cosmos DB", + "Get-AzCosmosDBMongoDBCollectionThroughput": "Cosmos DB", + "Get-AzCosmosDBMongoDBRestorableResource": "Cosmos DB", + "Remove-AzCosmosDBAccount": "Cosmos DB", + "Invoke-AzCosmosDBCassandraTableThroughputMigration": "Cosmos DB", + "New-AzCosmosDBSqlStoredProcedure": "Cosmos DB", + "New-AzManagedCassandraCluster": "Cosmos DB", + "Update-AzCosmosDBGremlinDatabaseThroughput": "Cosmos DB", + "Get-AzCosmosDBAccountKey": "Cosmos DB", + "New-AzCosmosDBSqlConflictResolutionPolicy": "Cosmos DB", + "Update-AzCosmosDBSqlDatabase": "Cosmos DB", + "Get-AzCosmosDBSqlUserDefinedFunction": "Cosmos DB", + "Update-AzCosmosDBMongoDBDatabaseThroughput": "Cosmos DB", + "Get-AzCosmosDBCassandraKeyspace": "Cosmos DB", + "Remove-AzCosmosDBSqlRoleAssignment": "Cosmos DB", + "Get-AzCosmosDBSqlContainer": "Cosmos DB", + "Get-AzCosmosDBMongoDBRestorableDatabase": "Cosmos DB", + "New-AzCosmosDBSqlIncludedPath": "Cosmos DB", + "Get-AzCosmosDBTableThroughput": "Cosmos DB", + "Get-AzCosmosDBMongoDBDatabase": "Cosmos DB", + "New-AzCosmosDBGremlinGraph": "Cosmos DB", + "Update-AzCosmosDBGremlinGraph": "Cosmos DB", + "New-AzCosmosDBMongoDBIndex": "Cosmos DB", + "New-AzCosmosDBCassandraColumn": "Cosmos DB", + "Remove-AzCosmosDBSqlContainer": "Cosmos DB", + "Update-AzCosmosDBMongoDBUserDefinition": "Cosmos DB", + "New-AzCosmosDBVirtualNetworkRule": "Cosmos DB", + "Remove-AzCosmosDBSqlStoredProcedure": "Cosmos DB", + "Invoke-AzCosmosDBSqlDatabaseThroughputMigration": "Cosmos DB", + "Update-AzCosmosDBCassandraKeyspace": "Cosmos DB", + "Get-AzCosmosDBSqlDatabase": "Cosmos DB", + "Remove-AzCosmosDBCassandraTable": "Cosmos DB", + "Update-AzCosmosDBGremlinDatabase": "Cosmos DB", + "Update-AzCosmosDBCassandraTable": "Cosmos DB", + "Update-AzCosmosDBSqlContainer": "Cosmos DB", + "Update-AzManagedCassandraDataCenter": "Cosmos DB", + "Remove-AzCosmosDBSqlDatabase": "Cosmos DB", + "Update-AzCosmosDBSqlRoleAssignment": "Cosmos DB", + "Get-AzCosmosDBCassandraTableThroughput": "Cosmos DB", + "New-AzManagedCassandraDataCenter": "Cosmos DB", + "Remove-AzCosmosDBMongoDBCollection": "Cosmos DB", + "New-AzCosmosDBMongoDBRole": "Cosmos DB", + "Get-AzCosmosDBCassandraTable": "Cosmos DB", + "New-AzCosmosDbClientEncryptionKey": "Cosmos DB", + "Get-AzCosmosDBGremlinDatabaseThroughput": "Cosmos DB", + "Update-AzCosmosDBMongoDBRoleDefinition": "Cosmos DB", + "New-AzCosmosDBCassandraTable": "Cosmos DB", + "New-AzCosmosDBTableToRestore": "Cosmos DB", + "Get-AzCosmosDBSqlContainerBackupInformation": "Cosmos DB", + "Get-AzCosmosDBMongoDBRoleDefinition": "Cosmos DB", + "Get-AzManagedCassandraDataCenter": "Cosmos DB", + "New-AzCosmosDBGremlinDatabase": "Cosmos DB", + "New-AzCosmosDBSqlDatabase": "Cosmos DB", + "Get-AzCosmosDBMongoDBDatabaseThroughput": "Cosmos DB", + "Invoke-AzCosmosDBGremlinGraphThroughputMigration": "Cosmos DB", + "New-AzCosmosDBSqlSpatialSpec": "Cosmos DB", + "New-AzCosmosDBTable": "Cosmos DB", + "Remove-AzCosmosDBSqlUserDefinedFunction": "Cosmos DB", + "Get-AzCosmosDBMongoDBRestorableCollection": "Cosmos DB", + "Remove-AzCosmosDBSqlRoleDefinition": "Cosmos DB", + "Get-AzCosmosDBGremlinRestorableGraph": "Cosmos DB", + "New-AzCosmosDBCassandraClusterKey": "Cosmos DB", + "Get-AzCosmosDBAccount": "Cosmos DB", + "Update-AzManagedCassandraCluster": "Cosmos DB", + "Get-AzCosmosDBLocation": "Cosmos DB", + "Get-AzCosmosDBSqlContainerThroughput": "Cosmos DB", + "Update-AzCosmosDBSqlTrigger": "Cosmos DB", + "New-AzCosmosDBLocationObject": "Cosmos DB", + "Update-AzCosmosDBSqlRoleDefinition": "Cosmos DB", + "Update-AzCosmosDBCassandraKeyspaceThroughput": "Cosmos DB", + "Remove-AzCosmosDBMongoDBUserDefinition": "Cosmos DB", + "Invoke-AzCosmosDBTableThroughputMigration": "Cosmos DB", + "Update-AzCosmosDBSqlContainerThroughput": "Cosmos DB", + "Get-AzCosmosDBSqlTrigger": "Cosmos DB", + "Remove-AzCosmosDBCassandraKeyspace": "Cosmos DB", + "New-AzCosmosDBGremlinIncludedPath": "Cosmos DB", + "New-AzCosmosDBSqlRoleDefinition": "Cosmos DB", + "Remove-AzCosmosDBService": "Cosmos DB", + "New-AzCosmosDBCassandraSchema": "Cosmos DB", + "New-AzCosmosDBGremlinConflictResolutionPolicy": "Cosmos DB", + "Remove-AzManagedCassandraCluster": "Cosmos DB", + "Get-AzCosmosDBSqlRoleDefinition": "Cosmos DB", + "Get-AzCosmosDBSqlRestorableDatabase": "Cosmos DB", + "Remove-AzCosmosDBMongoDBDatabase": "Cosmos DB", + "New-AzCosmosDBMongoDBDatabase": "Cosmos DB", + "Update-AzCosmosDBCassandraTableThroughput": "Cosmos DB", + "Remove-AzCosmosDBTable": "Cosmos DB", + "Remove-AzManagedCassandraDataCenter": "Cosmos DB", + "Get-AzCosmosDBMongoDBCollectionBackupInformation": "Cosmos DB", + "Get-AzCosmosDbClientEncryptionKey": "Cosmos DB", + "Remove-AzCosmosDBMongoDBRoleDefinition": "Cosmos DB", + "New-AzCosmosDBGremlinIndexingPolicy": "Cosmos DB", + "Get-AzCosmosDBService": "Cosmos DB", + "Update-AzCosmosDBAccountFailoverPriority": "Cosmos DB", + "New-AzCosmosDBGremlinUniqueKeyPolicy": "Cosmos DB", + "New-AzCosmosDBGremlinSpatialSpec": "Cosmos DB", + "Update-AzCosmosDBGremlinGraphThroughput": "Cosmos DB", + "Get-AzCosmosDBTableRestorableResource": "Cosmos DB", + "Get-AzCosmosDBTableBackupInformation": "Cosmos DB", + "New-AzCosmosDBCassandraKeyspace": "Cosmos DB", + "New-AzCosmosDBSqlUniqueKey": "Cosmos DB", + "New-AzCosmosDBDatabaseToRestore": "Cosmos DB", + "Get-AzCosmosDBGremlinGraphBackupInformation": "Cosmos DB", + "Update-AzCosmosDBSqlDatabaseThroughput": "Cosmos DB", + "Update-AzCosmosDBMongoDBCollection": "Cosmos DB", + "Get-AzCosmosDBMongoDBUserDefinition": "Cosmos DB", + "New-AzCosmosDBMongoDBPrivilegeResource": "Cosmos DB", + "New-AzCosmosDBGremlinDatabaseToRestore": "Cosmos DB", + "New-AzCosmosDBMongoDBUserDefinition": "Cosmos DB", + "Get-AzCosmosDBTableRestorableTable": "Cosmos DB", + "Get-AzCosmosDBGremlinGraph": "Cosmos DB", + "Get-AzCosmosDBMongoDBCollection": "Cosmos DB", + "Get-AzCosmosDBSqlRestorableResource": "Cosmos DB", + "Update-AzCosmosDBMongoDBCollectionThroughput": "Cosmos DB", + "Get-AzCosmosDBGremlinRestorableDatabase": "Cosmos DB", + "New-AzCosmosDBSqlRoleAssignment": "Cosmos DB", + "Update-AzCosmosDBAccount": "Cosmos DB", + "Update-AzCosmosDBTable": "Cosmos DB", + "Get-AzCosmosDBSqlRoleAssignment": "Cosmos DB", + "Remove-AzCosmosDBGremlinGraph": "Cosmos DB", + "New-AzCosmosDBAccount": "Cosmos DB", + "Update-AzCosmosDBMongoDBDatabase": "Cosmos DB", + "New-AzCosmosDBGremlinCompositePath": "Cosmos DB", + "New-AzCosmosDBGremlinUniqueKey": "Cosmos DB", + "New-AzCosmosDBAccountKey": "Cosmos DB", + "Get-AzCosmosDBSqlStoredProcedure": "Cosmos DB", + "Restore-AzCosmosDBAccount": "Cosmos DB", + "Get-AzCosmosDBRestorableDatabaseAccount": "Cosmos DB", + "Update-AzCosmosDBAccountRegion": "Cosmos DB", + "Get-AzManagedCassandraCluster": "Cosmos DB", + "New-AzCosmosDBSqlUniqueKeyPolicy": "Cosmos DB", + "Update-AzCosmosDBSqlUserDefinedFunction": "Cosmos DB", + "Get-AzCosmosDBTable": "Cosmos DB", + "New-AzCosmosDBGremlinIncludedPathIndex": "Cosmos DB", + "Remove-AzCosmosDBGremlinDatabase": "Cosmos DB", + "New-AzCosmosDBSqlTrigger": "Cosmos DB", + "Get-AzCosmosDBSqlRestorableContainer": "Cosmos DB", + "New-AzCosmosDBSqlUserDefinedFunction": "Cosmos DB", + "New-AzCosmosDBSqlCompositePath": "Cosmos DB", + "New-AzCosmosDBMongoDBRoleDefinition": "Cosmos DB", + "Invoke-AzCosmosDBGremlinDatabaseThroughputMigration": "Cosmos DB", + "New-AzCosmosDBMongoDBCollection": "Cosmos DB", + "Invoke-AzCosmosDBSqlContainerThroughputMigration": "Cosmos DB", + "Get-AzCosmosDBGremlinGraphThroughput": "Cosmos DB", + "Get-AzCosmosDBSqlDatabaseThroughput": "Cosmos DB", + "Update-AzCosmosDBSqlStoredProcedure": "Cosmos DB", + "Update-AzCosmosDBTableThroughput": "Cosmos DB", + "Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration": "Cosmos DB", + "Get-AzCosmosDBCassandraKeyspaceThroughput": "Cosmos DB", + "Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration": "Cosmos DB", + "New-AzCosmosDBPermission": "Cosmos DB", + "Add-AzPrivateDnsRecordConfig": "Private DNS", + "Get-AzPrivateDnsRecordSet": "Private DNS", + "Remove-AzPrivateDnsRecordConfig": "Private DNS", + "Get-AzPrivateDnsZone": "Private DNS", + "New-AzPrivateDnsRecordSet": "Private DNS", + "Set-AzPrivateDnsRecordSet": "Private DNS", + "Set-AzPrivateDnsVirtualNetworkLink": "Private DNS", + "Remove-AzPrivateDnsVirtualNetworkLink": "Private DNS", + "New-AzPrivateDnsZone": "Private DNS", + "Remove-AzPrivateDnsRecordSet": "Private DNS", + "New-AzPrivateDnsVirtualNetworkLink": "Private DNS", + "Get-AzPrivateDnsVirtualNetworkLink": "Private DNS", + "Remove-AzPrivateDnsZone": "Private DNS", + "Set-AzPrivateDnsZone": "Private DNS", + "New-AzPrivateDnsRecordConfig": "Private DNS", + "New-AzStorageSyncServerEndpoint": "StorageSync", + "Get-AzStorageSyncServer": "StorageSync", + "Register-AzStorageSyncServer": "StorageSync", + "New-AzStorageSyncCloudEndpoint": "StorageSync", + "Get-AzStorageSyncGroup": "StorageSync", + "Remove-AzStorageSyncCloudEndpoint": "StorageSync", + "New-AzStorageSyncService": "StorageSync", + "New-AzStorageSyncGroup": "StorageSync", + "Get-AzStorageSyncCloudEndpoint": "StorageSync", + "Get-AzStorageSyncService": "StorageSync", + "Remove-AzStorageSyncServerEndpoint": "StorageSync", + "Set-AzStorageSyncService": "StorageSync", + "Invoke-AzStorageSyncChangeDetection": "StorageSync", + "Invoke-AzStorageSyncCompatibilityCheck": "StorageSync", + "Reset-AzStorageSyncServerCertificate": "StorageSync", + "Set-AzStorageSyncServerEndpoint": "StorageSync", + "Remove-AzStorageSyncService": "StorageSync", + "Get-AzStorageSyncServerEndpoint": "StorageSync", + "Remove-AzStorageSyncGroup": "StorageSync", + "Unregister-AzStorageSyncServer": "StorageSync", + "Set-AzRecoveryServicesVaultContext": "Recovery Services", + "New-AzRecoveryServicesAsrVMNicConfig": "Recovery Services", + "Get-AzRecoveryServicesBackupJob": "Recovery Services", + "New-AzRecoveryServicesAsrvCenter": "Recovery Services", + "Disable-AzRecoveryServicesBackupAutoProtection": "Recovery Services", + "Get-AzRecoveryServicesAsrFabric": "Recovery Services", + "Add-AzRecoveryServicesAsrReplicationProtectedItemDisk": "Recovery Services", + "Remove-AzRecoveryServicesAsrPolicy": "Recovery Services", + "Get-AzRecoveryServicesBackupRetentionPolicyObject": "Recovery Services", + "Get-AzRecoveryServicesBackupProperty": "Recovery Services", + "Update-AzRecoveryServicesAsrvCenter": "Recovery Services", + "Copy-AzRecoveryServicesVault": "Recovery Services", + "Initialize-AzRecoveryServicesDSMove": "Recovery Services", + "Get-AzRecoveryServicesAsrNetwork": "Recovery Services", + "New-AzRecoveryServicesAsrProtectableItem": "Recovery Services", + "Set-AzRecoveryServicesBackupProperty": "Recovery Services", + "Update-AzRecoveryServicesAsrPolicy": "Recovery Services", + "Set-AzRecoveryServicesResourceGuardMapping": "Recovery Services", + "Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup": "Recovery Services", + "Set-AzRecoveryServicesVaultProperty": "Recovery Services", + "Get-AzRecoveryServicesBackupRecoveryLogChain": "Recovery Services", + "Remove-AzRecoveryServicesAsrNetworkMapping": "Recovery Services", + "Get-AzRecoveryServicesAsrEvent": "Recovery Services", + "Start-AzRecoveryServicesAsrResynchronizeReplicationJob": "Recovery Services", + "Get-AzRecoveryServicesVaultSettingsFile": "Recovery Services", + "Get-AzRecoveryServicesAsrNetworkMapping": "Recovery Services", + "Get-AzRecoveryServicesAsrRecoveryPlan": "Recovery Services", + "Wait-AzRecoveryServicesBackupJob": "Recovery Services", + "Start-AzRecoveryServicesAsrSwitchProcessServerJob": "Recovery Services", + "New-AzRecoveryServicesAsrProtectionContainer": "Recovery Services", + "Get-AzRecoveryServicesBackupProtectionPolicy": "Recovery Services", + "Disable-AzRecoveryServicesBackupRPMountScript": "Recovery Services", + "Get-AzRecoveryServicesAsrPolicy": "Recovery Services", + "Start-AzRecoveryServicesAsrSwitchAppliance": "Recovery Services", + "Enable-AzRecoveryServicesBackupAutoProtection": "Recovery Services", + "Update-AzRecoveryServicesAsrProtectionDirection": "Recovery Services", + "Get-AzRecoveryServicesAsrStorageClassificationMapping": "Recovery Services", + "New-AzRecoveryServicesAsrReplicationProtectedItem": "Recovery Services", + "Remove-AzRecoveryServicesAsrStorageClassificationMapping": "Recovery Services", + "New-AzRecoveryServicesAsrInMageRcmDiskInput": "Recovery Services", + "Test-AzRecoveryServicesDSMove": "Recovery Services", + "Get-AzRecoveryServicesBackupSchedulePolicyObject": "Recovery Services", + "Remove-AzRecoveryServicesAsrProtectionContainerMapping": "Recovery Services", + "Start-AzRecoveryServicesAsrTestFailoverCleanupJob": "Recovery Services", + "New-AzRecoveryServicesAsrPolicy": "Recovery Services", + "New-AzRecoveryServicesAsrRecoveryPlan": "Recovery Services", + "New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig": "Recovery Services", + "Update-AzRecoveryServicesAsrRecoveryPlan": "Recovery Services", + "Set-AzRecoveryServicesAsrAlertSetting": "Recovery Services", + "Set-AzRecoveryServicesAsrVaultContext": "Recovery Services", + "Move-AzRecoveryServicesBackupRecoveryPoint": "Recovery Services", + "Import-AzRecoveryServicesAsrVaultSettingsFile": "Recovery Services", + "Get-AzRecoveryServicesAsrServicesProvider": "Recovery Services", + "Remove-AzRecoveryServicesAsrReplicationProtectedItem": "Recovery Services", + "Edit-AzRecoveryServicesAsrRecoveryPlan": "Recovery Services", + "Get-AzRecoveryServicesBackupContainer": "Recovery Services", + "Get-AzRecoveryServicesAsrProtectionContainer": "Recovery Services", + "Get-AzRecoveryServicesAsrRecoveryPoint": "Recovery Services", + "Get-AzRecoveryServicesAsrvCenter": "Recovery Services", + "Backup-AzRecoveryServicesBackupItem": "Recovery Services", + "Get-AzRecoveryServicesBackupStatus": "Recovery Services", + "Initialize-AzRecoveryServicesBackupProtectableItem": "Recovery Services", + "Disable-AzRecoveryServicesBackupProtection": "Recovery Services", + "Unregister-AzRecoveryServicesBackupContainer": "Recovery Services", + "Remove-AzRecoveryServicesAsrFabric": "Recovery Services", + "Remove-AzRecoveryServicesBackupProtectionPolicy": "Recovery Services", + "Remove-AzRecoveryServicesVault": "Recovery Services", + "Remove-AzRecoveryServicesAsrvCenter": "Recovery Services", + "New-AzRecoveryServicesVault": "Recovery Services", + "New-AzRecoveryServicesBackupProtectionPolicy": "Recovery Services", + "Get-AzRecoveryServicesVaultProperty": "Recovery Services", + "Enable-AzRecoveryServicesBackupProtection": "Recovery Services", + "Get-AzRecoveryServicesBackupItem": "Recovery Services", + "Get-AzRecoveryServicesAsrProtectableItem": "Recovery Services", + "Update-AzRecoveryServicesAsrMobilityService": "Recovery Services", + "Remove-AzRecoveryServicesAsrServicesProvider": "Recovery Services", + "Get-AzRecoveryServicesBackupJobDetail": "Recovery Services", + "Set-AzRecoveryServicesAsrReplicationProtectedItem": "Recovery Services", + "Stop-AzRecoveryServicesAsrJob": "Recovery Services", + "Remove-AzRecoveryServicesAsrProtectionContainer": "Recovery Services", + "Restore-AzRecoveryServicesBackupItem": "Recovery Services", + "Stop-AzRecoveryServicesBackupJob": "Recovery Services", + "Start-AzRecoveryServicesAsrUnplannedFailoverJob": "Recovery Services", + "Start-AzRecoveryServicesAsrTestFailoverJob": "Recovery Services", + "Get-AzRecoveryServicesBackupWorkloadRecoveryConfig": "Recovery Services", + "Get-AzRecoveryServicesVault": "Recovery Services", + "Restart-AzRecoveryServicesAsrJob": "Recovery Services", + "Resume-AzRecoveryServicesAsrJob": "Recovery Services", + "Get-AzRecoveryServicesAsrReplicationProtectedItem": "Recovery Services", + "Undo-AzRecoveryServicesBackupItemDeletion": "Recovery Services", + "Get-AzRecoveryServicesAsrStorageClassification": "Recovery Services", + "Get-AzRecoveryServicesBackupRPMountScript": "Recovery Services", + "Unregister-AzRecoveryServicesBackupManagementServer": "Recovery Services", + "Set-AzRecoveryServicesBackupProtectionPolicy": "Recovery Services", + "Update-AzRecoveryServicesAsrServicesProvider": "Recovery Services", + "New-AzRecoveryServicesAsrVMNicIPConfig": "Recovery Services", + "Register-AzRecoveryServicesBackupContainer": "Recovery Services", + "Get-AzRecoveryServicesAsrProtectionContainerMapping": "Recovery Services", + "New-AzRecoveryServicesAsrNetworkMapping": "Recovery Services", + "Get-AzRecoveryServicesBackupRecoveryPoint": "Recovery Services", + "Remove-AzRecoveryServicesAsrRecoveryPlan": "Recovery Services", + "Get-AzRecoveryServicesResourceGuardMapping": "Recovery Services", + "New-AzRecoveryServicesAsrStorageClassificationMapping": "Recovery Services", + "Get-AzRecoveryServicesBackupManagementServer": "Recovery Services", + "Update-AzRecoveryServicesAsrProtectionContainerMapping": "Recovery Services", + "Get-AzRecoveryServicesAsrAlertSetting": "Recovery Services", + "New-AzRecoveryServicesAsrProtectionContainerMapping": "Recovery Services", + "New-AzRecoveryServicesAsrInMageAzureV2DiskInput": "Recovery Services", + "Start-AzRecoveryServicesAsrApplyRecoveryPoint": "Recovery Services", + "New-AzRecoveryServicesAsrFabric": "Recovery Services", + "Get-AzRecoveryServicesAsrVaultContext": "Recovery Services", + "Start-AzRecoveryServicesAsrCommitFailoverJob": "Recovery Services", + "Remove-AzRecoveryServicesResourceGuardMapping": "Recovery Services", + "Update-AzRecoveryServicesVault": "Recovery Services", + "Update-AzRecoveryServicesAsrNetworkMapping": "Recovery Services", + "Start-AzRecoveryServicesAsrCancelFailoverJob": "Recovery Services", + "Get-AzRecoveryServicesBackupProtectableItem": "Recovery Services", + "Get-AzRecoveryServicesAsrJob": "Recovery Services", + "Start-AzRecoveryServicesAsrPlannedFailoverJob": "Recovery Services", + "Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk": "Recovery Services", + "Set-AzEventGridTopic": "Event Grid", + "New-AzEventGridPartnerRegistration": "Event Grid", + "Revoke-AzEventGridPartnerConfiguration": "Event Grid", + "New-AzEventGridPartnerNamespaceKey": "Event Grid", + "New-AzEventGridPartnerNamespace": "Event Grid", + "Get-AzEventGridPartnerTopic": "Event Grid", + "Get-AzEventGridPartnerConfiguration": "Event Grid", + "Remove-AzEventGridDomainTopic": "Event Grid", + "Get-AzEventGridSystemTopic": "Event Grid", + "Get-AzEventGridPartnerRegistration": "Event Grid", + "Remove-AzEventGridTopic": "Event Grid", + "Get-AzEventGridSubscription": "Event Grid", + "New-AzEventGridPartnerConfiguration": "Event Grid", + "New-AzEventGridDomainTopic": "Event Grid", + "Get-AzEventGridChannel": "Event Grid", + "Get-AzEventGridTopic": "Event Grid", + "Update-AzEventGridSystemTopic": "Event Grid", + "Remove-AzEventGridPartnerTopicEventSubscription": "Event Grid", + "New-AzEventGridDomain": "Event Grid", + "Get-AzEventGridDomain": "Event Grid", + "New-AzEventGridPartnerTopicEventSubscription": "Event Grid", + "Get-AzEventGridFullUrlForSystemTopicEventSubscription": "Event Grid", + "Get-AzEventGridVerifiedPartner": "Event Grid", + "Get-AzEventGridFullUrlForPartnerTopicEventSubscription": "Event Grid", + "New-AzEventGridSystemTopicEventSubscription": "Event Grid", + "New-AzEventGridDomainKey": "Event Grid", + "Get-AzEventGridPartnerTopicEventSubscriptionDeliveryAttribute": "Event Grid", + "New-AzEventGridPartnerTopic": "Event Grid", + "New-AzEventGridTopicKey": "Event Grid", + "New-AzEventGridSubscription": "Event Grid", + "Remove-AzEventGridPartnerRegistration": "Event Grid", + "Get-AzEventGridPartnerTopicEventSubscription": "Event Grid", + "Remove-AzEventGridPartnerTopic": "Event Grid", + "Get-AzEventGridTopicType": "Event Grid", + "New-AzEventGridSystemTopic": "Event Grid", + "Update-AzEventGridSubscription": "Event Grid", + "Get-AzEventGridSystemTopicEventSubscription": "Event Grid", + "Remove-AzEventGridPartnerNamespace": "Event Grid", + "Get-AzEventGridPartnerNamespace": "Event Grid", + "Update-AzEventGridPartnerTopicEventSubscription": "Event Grid", + "New-AzEventGridChannel": "Event Grid", + "Remove-AzEventGridSystemTopicEventSubscription": "Event Grid", + "Get-AzEventGridTopicKey": "Event Grid", + "Update-AzEventGridPartnerTopic": "Event Grid", + "Remove-AzEventGridSubscription": "Event Grid", + "Update-AzEventGridChannel": "Event Grid", + "Remove-AzEventGridSystemTopic": "Event Grid", + "Enable-AzEventGridPartnerTopic": "Event Grid", + "Get-AzEventGridDomainTopic": "Event Grid", + "Remove-AzEventGridDomain": "Event Grid", + "Remove-AzEventGridPartnerConfiguration": "Event Grid", + "Get-AzEventGridDomainKey": "Event Grid", + "Update-AzEventGridSystemTopicEventSubscription": "Event Grid", + "New-AzEventGridTopic": "Event Grid", + "Update-AzEventGridPartnerConfiguration": "Event Grid", + "Get-AzEventGridSystemTopicEventSubscriptionDeliveryAttribute": "Event Grid", + "Grant-AzEventGridPartnerConfiguration": "Event Grid", + "Get-AzEventGridPartnerNamespaceKey": "Event Grid", + "Remove-AzEventGridChannel": "Event Grid", + "Update-AzApplicationInsights": "Application Insights", + "New-AzApplicationInsightsWebTest": "Application Insights", + "New-AzApplicationInsightsApiKey": "Application Insights", + "New-AzApplicationInsightsMyWorkbook": "Application Insights", + "Get-AzApplicationInsightsWorkbookTemplate": "Application Insights", + "New-AzApplicationInsightsWorkbookTemplateGalleryObject": "Application Insights", + "Remove-AzApplicationInsightsWorkbookTemplate": "Application Insights", + "Get-AzApplicationInsightsWebTest": "Application Insights", + "Remove-AzApplicationInsightsLinkedStorageAccount": "Application Insights", + "Update-AzApplicationInsightsWorkbook": "Application Insights", + "Get-AzApplicationInsights": "Application Insights", + "Remove-AzApplicationInsightsWorkbook": "Application Insights", + "Remove-AzApplicationInsightsApiKey": "Application Insights", + "Set-AzApplicationInsightsContinuousExport": "Application Insights", + "New-AzApplicationInsights": "Application Insights", + "Get-AzApplicationInsightsContinuousExport": "Application Insights", + "New-AzApplicationInsightsWorkbook": "Application Insights", + "Get-AzApplicationInsightsApiKey": "Application Insights", + "Get-AzApplicationInsightsWorkbook": "Application Insights", + "New-AzApplicationInsightsLinkedStorageAccount": "Application Insights", + "Remove-AzApplicationInsightsMyWorkbook": "Application Insights", + "New-AzApplicationInsightsWebTestHeaderFieldObject": "Application Insights", + "Get-AzApplicationInsightsMyWorkbook": "Application Insights", + "New-AzApplicationInsightsContinuousExport": "Application Insights", + "Set-AzApplicationInsightsDailyCap": "Application Insights", + "Update-AzApplicationInsightsWorkbookTemplate": "Application Insights", + "Get-AzApplicationInsightsLinkedStorageAccount": "Application Insights", + "Remove-AzApplicationInsights": "Application Insights", + "New-AzApplicationInsightsWorkbookTemplate": "Application Insights", + "Update-AzApplicationInsightsWebTestTag": "Application Insights", + "Remove-AzApplicationInsightsWebTest": "Application Insights", + "Get-AzApplicationInsightsWorkbookRevision": "Application Insights", + "Update-AzApplicationInsightsMyWorkbook": "Application Insights", + "Remove-AzApplicationInsightsContinuousExport": "Application Insights", + "Update-AzApplicationInsightsLinkedStorageAccount": "Application Insights", + "Set-AzApplicationInsightsPricingPlan": "Application Insights", + "New-AzApplicationInsightsWebTestGeolocationObject": "Application Insights", + "Remove-AzResourceGraphQuery": "ResourceGraph", + "New-AzResourceGraphQuery": "ResourceGraph", + "Get-AzResourceGraphQuery": "ResourceGraph", + "Search-AzGraph": "ResourceGraph", + "Update-AzResourceGraphQuery": "ResourceGraph", + "Get-AzCommunicationServiceKey": "Communication Services", + "New-AzCommunicationService": "Communication Services", + "Remove-AzCommunicationService": "Communication Services", + "Get-AzCommunicationService": "Communication Services", + "Update-AzCommunicationService": "Communication Services", + "New-AzCommunicationServiceKey": "Communication Services", + "Set-AzCommunicationServiceNotificationHub": "Communication Services", + "Test-AzCommunicationServiceNameAvailability": "Communication Services", + "Get-AzManagementPartner": "Management Partner", + "Update-AzManagementPartner": "Management Partner", + "Remove-AzManagementPartner": "Management Partner", + "New-AzManagementPartner": "Management Partner", + "Get-AzAutomanageConfigProfile": "Automanage", + "Get-AzAutomanageBestPractice": "Automanage", + "New-AzAutomanageConfigProfileHciAssignment": "Automanage", + "Get-AzAutomanageHcrpReport": "Automanage", + "Get-AzAutomanageConfigProfileHcrpAssignment": "Automanage", + "New-AzAutomanageConfigProfileAssignment": "Automanage", + "New-AzAutomanageConfigProfile": "Automanage", + "Remove-AzAutomanageConfigProfileHciAssignment": "Automanage", + "New-AzAutomanageConfigProfileHcrpAssignment": "Automanage", + "Update-AzAutomanageConfigProfile": "Automanage", + "Get-AzAutomanageConfigProfileAssignment": "Automanage", + "Remove-AzAutomanageConfigProfileAssignment": "Automanage", + "Get-AzAutomanageHciReport": "Automanage", + "Remove-AzAutomanageConfigProfile": "Automanage", + "Get-AzAutomanageReport": "Automanage", + "Remove-AzAutomanageConfigProfileHcrpAssignment": "Automanage", + "Get-AzAutomanageConfigProfileHciAssignment": "Automanage", + "Set-AzDataFactorySliceStatus": "Data Factories", + "Get-AzDataFactoryV2ActivityRun": "Data Factories", + "New-AzDataFactoryLinkedService": "Data Factories", + "Start-AzDataFactoryV2Trigger": "Data Factories", + "Get-AzDataFactoryHub": "Data Factories", + "Start-AzDataFactoryV2DataFlowDebugSession": "Data Factories", + "Get-AzDataFactoryV2LinkedService": "Data Factories", + "Get-AzDataFactorySlice": "Data Factories", + "Remove-AzDataFactoryPipeline": "Data Factories", + "Get-AzDataFactoryV2TriggerRun": "Data Factories", + "Get-AzDataFactoryV2TriggerSubscriptionStatus": "Data Factories", + "Get-AzDataFactoryV2IntegrationRuntimeMetric": "Data Factories", + "Get-AzDataFactoryV2": "Data Factories", + "New-AzDataFactoryEncryptValue": "Data Factories", + "Remove-AzDataFactoryV2LinkedService": "Data Factories", + "Remove-AzDataFactoryV2TriggerSubscription": "Data Factories", + "Remove-AzDataFactoryHub": "Data Factories", + "Set-AzDataFactoryV2LinkedService": "Data Factories", + "Get-AzDataFactoryV2Dataset": "Data Factories", + "New-AzDataFactoryGateway": "Data Factories", + "Get-AzDataFactoryV2IntegrationRuntimeNode": "Data Factories", + "Remove-AzDataFactoryLinkedService": "Data Factories", + "Set-AzDataFactoryV2Pipeline": "Data Factories", + "Set-AzDataFactoryPipelineActivePeriod": "Data Factories", + "Get-AzDataFactoryGateway": "Data Factories", + "Get-AzDataFactoryGatewayAuthKey": "Data Factories", + "Remove-AzDataFactoryV2Dataset": "Data Factories", + "Set-AzDataFactoryGateway": "Data Factories", + "Remove-AzDataFactoryGateway": "Data Factories", + "Suspend-AzDataFactoryPipeline": "Data Factories", + "Invoke-AzDataFactoryV2Pipeline": "Data Factories", + "Invoke-AzDataFactoryV2TriggerRun": "Data Factories", + "Stop-AzDataFactoryV2Trigger": "Data Factories", + "Update-AzDataFactoryV2IntegrationRuntime": "Data Factories", + "New-AzDataFactoryDataset": "Data Factories", + "Get-AzDataFactoryV2DataFlow": "Data Factories", + "Get-AzDataFactory": "Data Factories", + "Get-AzDataFactoryV2DataFlowDebugSession": "Data Factories", + "Remove-AzDataFactoryV2IntegrationRuntimeNode": "Data Factories", + "Start-AzDataFactoryV2IntegrationRuntime": "Data Factories", + "Set-AzDataFactoryV2DataFlow": "Data Factories", + "Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade": "Data Factories", + "Remove-AzDataFactoryDataset": "Data Factories", + "Remove-AzDataFactoryV2IntegrationRuntime": "Data Factories", + "Remove-AzDataFactoryV2Trigger": "Data Factories", + "Remove-AzDataFactoryV2Pipeline": "Data Factories", + "Get-AzDataFactoryV2PipelineRun": "Data Factories", + "Get-AzDataFactoryDataset": "Data Factories", + "Get-AzDataFactoryActivityWindow": "Data Factories", + "Save-AzDataFactoryLog": "Data Factories", + "New-AzDataFactoryGatewayAuthKey": "Data Factories", + "Update-AzDataFactoryV2IntegrationRuntimeNode": "Data Factories", + "Stop-AzDataFactoryV2PipelineRun": "Data Factories", + "Remove-AzDataFactory": "Data Factories", + "Resume-AzDataFactoryPipeline": "Data Factories", + "Get-AzDataFactoryV2IntegrationRuntimeOutboundNetworkDependenciesEndpoint": "Data Factories", + "Remove-AzDataFactoryV2": "Data Factories", + "Get-AzDataFactoryRun": "Data Factories", + "Invoke-AzDataFactoryV2DataFlowDebugSessionCommand": "Data Factories", + "Sync-AzDataFactoryV2IntegrationRuntimeCredential": "Data Factories", + "Get-AzDataFactoryLinkedService": "Data Factories", + "New-AzDataFactoryV2LinkedServiceEncryptedCredential": "Data Factories", + "Add-AzDataFactoryV2TriggerSubscription": "Data Factories", + "Add-AzDataFactoryV2DataFlowDebugSessionPackage": "Data Factories", + "New-AzDataFactoryV2IntegrationRuntimeKey": "Data Factories", + "Set-AzDataFactoryV2Trigger": "Data Factories", + "Get-AzDataFactoryPipeline": "Data Factories", + "Set-AzDataFactoryV2IntegrationRuntime": "Data Factories", + "Stop-AzDataFactoryV2TriggerRun": "Data Factories", + "Get-AzDataFactoryV2IntegrationRuntime": "Data Factories", + "Remove-AzDataFactoryV2DataFlow": "Data Factories", + "Set-AzDataFactoryV2": "Data Factories", + "New-AzDataFactoryHub": "Data Factories", + "Get-AzDataFactoryV2IntegrationRuntimeKey": "Data Factories", + "New-AzDataFactory": "Data Factories", + "Stop-AzDataFactoryV2IntegrationRuntime": "Data Factories", + "Update-AzDataFactoryV2": "Data Factories", + "Set-AzDataFactoryV2Dataset": "Data Factories", + "Stop-AzDataFactoryV2DataFlowDebugSession": "Data Factories", + "Get-AzDataFactoryV2Pipeline": "Data Factories", + "Get-AzDataFactoryV2Trigger": "Data Factories", + "New-AzDataFactoryPipeline": "Data Factories", + "Remove-AzQumuloFileSystem": "Qumulo", + "New-AzQumuloFileSystem": "Qumulo", + "Update-AzQumuloFileSystem": "Qumulo", + "Get-AzQumuloFileSystem": "Qumulo", + "Stop-AzPostgreSqlFlexibleServer": "Database for PostgreSQL", + "Get-AzPostgreSqlFlexibleServerFirewallRule": "Database for PostgreSQL", + "Start-AzPostgreSqlFlexibleServer": "Database for PostgreSQL", + "New-AzPostgreSqlFlexibleServerFirewallRule": "Database for PostgreSQL", + "New-AzPostgreSqlFlexibleServerDatabase": "Database for PostgreSQL", + "Get-AzPostgreSqlVirtualNetworkRule": "Database for PostgreSQL", + "Remove-AzPostgreSqlFlexibleServer": "Database for PostgreSQL", + "Get-AzPostgreSqlFlexibleServerConfiguration": "Database for PostgreSQL", + "Update-AzPostgreSqlConfiguration": "Database for PostgreSQL", + "Get-AzPostgreSqlServer": "Database for PostgreSQL", + "Get-AzPostgreSqlFirewallRule": "Database for PostgreSQL", + "Get-AzPostgreSqlReplica": "Database for PostgreSQL", + "Update-AzPostgreSqlServer": "Database for PostgreSQL", + "Get-AzPostgreSqlFlexibleServerConnectionString": "Database for PostgreSQL", + "Get-AzPostgreSqlFlexibleServerLocationBasedCapability": "Database for PostgreSQL", + "Remove-AzPostgreSqlFirewallRule": "Database for PostgreSQL", + "Restart-AzPostgreSqlFlexibleServer": "Database for PostgreSQL", + "Update-AzPostgreSqlFlexibleServer": "Database for PostgreSQL", + "New-AzPostgreSqlFlexibleServer": "Database for PostgreSQL", + "Get-AzPostgreSqlConfiguration": "Database for PostgreSQL", + "Get-AzPostgreSqlConnectionString": "Database for PostgreSQL", + "Update-AzPostgreSqlVirtualNetworkRule": "Database for PostgreSQL", + "Update-AzPostgreSqlFlexibleServerFirewallRule": "Database for PostgreSQL", + "Restore-AzPostgreSqlServer": "Database for PostgreSQL", + "Update-AzPostgreSqlFirewallRule": "Database for PostgreSQL", + "Update-AzPostgreSqlFlexibleServerConfiguration": "Database for PostgreSQL", + "Remove-AzPostgreSqlFlexibleServerFirewallRule": "Database for PostgreSQL", + "Remove-AzPostgreSqlVirtualNetworkRule": "Database for PostgreSQL", + "Remove-AzPostgreSqlFlexibleServerDatabase": "Database for PostgreSQL", + "Restart-AzPostgreSqlServer": "Database for PostgreSQL", + "New-AzPostgreSqlServer": "Database for PostgreSQL", + "Test-AzPostgreSqlFlexibleServerConnect": "Database for PostgreSQL", + "Restore-AzPostgreSqlFlexibleServer": "Database for PostgreSQL", + "Remove-AzPostgreSqlServer": "Database for PostgreSQL", + "Get-AzPostgreSqlFlexibleServer": "Database for PostgreSQL", + "New-AzPostgreSqlVirtualNetworkRule": "Database for PostgreSQL", + "New-AzPostgreSqlReplica": "Database for PostgreSQL", + "Get-AzPostgreSqlFlexibleServerDatabase": "Database for PostgreSQL", + "New-AzPostgreSqlFirewallRule": "Database for PostgreSQL", + "Update-AzSubscription": "Subscription", + "New-AzSubscriptionAlias": "Subscription", + "Remove-AzSubscriptionAlias": "Subscription", + "Get-AzSubscriptionAlias": "Subscription", + "New-AzServiceLinkerConfluentSchemaRegistryObject": "ServiceLinker", + "New-AzServiceLinkerForWebApp": "ServiceLinker", + "New-AzServiceLinkerSystemAssignedIdentityAuthInfoObject": "ServiceLinker", + "Update-AzServiceLinkerForContainerApp": "ServiceLinker", + "New-AzServiceLinkerAzureResourceObject": "ServiceLinker", + "Get-AzServiceLinkerConfigurationForWebApp": "ServiceLinker", + "Remove-AzServiceLinkerForContainerApp": "ServiceLinker", + "Get-AzServiceLinkerConfigurationForContainerApp": "ServiceLinker", + "Get-AzServiceLinkerConfigurationName": "ServiceLinker", + "Remove-AzServiceLinkerForWebApp": "ServiceLinker", + "Update-AzServiceLinkerForWebApp": "ServiceLinker", + "Test-AzServiceLinkerForSpringCloud": "ServiceLinker", + "New-AzServiceLinkerConfluentBootstrapServerObject": "ServiceLinker", + "Test-AzServiceLinkerForContainerApp": "ServiceLinker", + "Get-AzServiceLinkerForWebApp": "ServiceLinker", + "Get-AzServiceLinkerForSpringCloud": "ServiceLinker", + "New-AzServiceLinkerUserAssignedIdentityAuthInfoObject": "ServiceLinker", + "New-AzServiceLinkerForContainerApp": "ServiceLinker", + "Get-AzServiceLinkerForContainerApp": "ServiceLinker", + "New-AzServiceLinkerSecretAuthInfoObject": "ServiceLinker", + "New-AzServiceLinkerServicePrincipalSecretAuthInfoObject": "ServiceLinker", + "Get-AzServiceLinkerConfigurationForSpringCloud": "ServiceLinker", + "Update-AzServiceLinkerForSpringCloud": "ServiceLinker", + "New-AzServiceLinkerForSpringCloud": "ServiceLinker", + "Test-AzServiceLinkerForWebApp": "ServiceLinker", + "Remove-AzServiceLinkerForSpringcloud": "ServiceLinker", + "Get-AzKustoClusterSku": "Kusto", + "New-AzKustoPrivateEndpointConnection": "Kusto", + "Get-AzKustoDatabasePrincipalAssignment": "Kusto", + "New-AzKustoDatabase": "Kusto", + "Get-AzKustoDatabasePrincipal": "Kusto", + "Update-AzKustoDataConnection": "Kusto", + "Invoke-AzKustoDataConnectionValidation": "Kusto", + "Test-AzKustoAttachedDatabaseConfigurationNameAvailability": "Kusto", + "Test-AzKustoClusterNameAvailability": "Kusto", + "Remove-AzKustoDatabasePrincipal": "Kusto", + "New-AzKustoScript": "Kusto", + "Get-AzKustoPrivateLinkResource": "Kusto", + "Get-AzKustoClusterFollowerDatabase": "Kusto", + "Test-AzKustoDatabasePrincipalAssignmentNameAvailability": "Kusto", + "New-AzKustoDataConnection": "Kusto", + "Update-AzKustoManagedPrivateEndpoint": "Kusto", + "Remove-AzKustoScript": "Kusto", + "New-AzKustoClusterPrincipalAssignment": "Kusto", + "Remove-AzKustoDatabase": "Kusto", + "Update-AzKustoCluster": "Kusto", + "Get-AzKustoSku": "Kusto", + "Update-AzKustoDatabase": "Kusto", + "Test-AzKustoManagedPrivateEndpointNameAvailability": "Kusto", + "Get-AzKustoOperationsResultLocation": "Kusto", + "New-AzKustoCluster": "Kusto", + "Add-AzKustoDatabasePrincipal": "Kusto", + "Get-AzKustoCluster": "Kusto", + "New-AzKustoManagedPrivateEndpoint": "Kusto", + "Get-AzKustoDataConnection": "Kusto", + "Get-AzKustoOperationsResult": "Kusto", + "Invoke-AzKustoDiagnoseClusterVirtualNetwork": "Kusto", + "Remove-AzKustoCluster": "Kusto", + "Remove-AzKustoDatabasePrincipalAssignment": "Kusto", + "Update-AzKustoScript": "Kusto", + "Remove-AzKustoDataConnection": "Kusto", + "New-AzKustoDatabasePrincipalAssignment": "Kusto", + "Stop-AzKustoCluster": "Kusto", + "Get-AzKustoManagedPrivateEndpoint": "Kusto", + "Get-AzKustoClusterOutboundNetworkDependencyEndpoint": "Kusto", + "Get-AzKustoPrivateEndpointConnection": "Kusto", + "Remove-AzKustoManagedPrivateEndpoint": "Kusto", + "New-AzKustoAttachedDatabaseConfiguration": "Kusto", + "Remove-AzKustoClusterLanguageExtension": "Kusto", + "Test-AzKustoClusterPrincipalAssignmentNameAvailability": "Kusto", + "Add-AzKustoClusterLanguageExtension": "Kusto", + "Test-AzKustoDataConnectionNameAvailability": "Kusto", + "Remove-AzKustoAttachedDatabaseConfiguration": "Kusto", + "Remove-AzKustoPrivateEndpointConnection": "Kusto", + "Test-AzKustoScriptNameAvailability": "Kusto", + "Get-AzKustoClusterPrincipalAssignment": "Kusto", + "Invoke-AzKustoDetachClusterFollowerDatabase": "Kusto", + "Test-AzKustoDatabaseNameAvailability": "Kusto", + "Remove-AzKustoClusterPrincipalAssignment": "Kusto", + "Get-AzKustoAttachedDatabaseConfiguration": "Kusto", + "Get-AzKustoClusterLanguageExtension": "Kusto", + "Get-AzKustoDatabase": "Kusto", + "Get-AzKustoScript": "Kusto", + "Start-AzKustoCluster": "Kusto", + "Remove-AzSapMonitorProviderInstance": "SAP HANA on Azure", + "New-AzSapMonitor": "SAP HANA on Azure", + "Get-AzSapMonitor": "SAP HANA on Azure", + "Update-AzSapMonitor": "SAP HANA on Azure", + "Get-AzSapMonitorProviderInstance": "SAP HANA on Azure", + "New-AzSapMonitorProviderInstance": "SAP HANA on Azure", + "Remove-AzSapMonitor": "SAP HANA on Azure", + "New-AzAppServiceEnvironment": "App Service", + "Remove-AzWebAppBackup": "App Service", + "Remove-AzWebAppCertificate": "App Service", + "Reset-AzWebAppPublishingProfile": "App Service", + "Reset-AzWebAppSlotPublishingProfile": "App Service", + "Get-AzWebAppTriggeredWebJob": "App Service", + "Import-AzWebAppKeyVaultCertificate": "App Service", + "Get-AzStaticWebAppFunctionAppSetting": "App Service", + "Get-AzWebAppBackupConfiguration": "App Service", + "Update-AzWebAppAccessRestrictionConfig": "App Service", + "New-AzStaticWebAppFunctionAppSetting": "App Service", + "New-AzWebAppCertificate": "App Service", + "New-AzWebAppSlot": "App Service", + "Get-AzStaticWebAppSetting": "App Service", + "Set-AzWebAppSlot": "App Service", + "Get-AzAppServicePlan": "App Service", + "Remove-AzWebAppAccessRestrictionRule": "App Service", + "New-AzStaticWebAppUserRoleInvitationLink": "App Service", + "Publish-AzWebApp": "App Service", + "Get-AzStaticWebAppSecret": "App Service", + "Get-AzWebAppSlotPublishingProfile": "App Service", + "New-AzWebAppAzureStoragePath": "App Service", + "Get-AzAppServiceEnvironment": "App Service", + "Restart-AzWebAppSlot": "App Service", + "Get-AzStaticWebApp": "App Service", + "Stop-AzWebApp": "App Service", + "Get-AzStaticWebAppBuildFunctionAppSetting": "App Service", + "Start-AzWebApp": "App Service", + "Remove-AzStaticWebAppUser": "App Service", + "Get-AzWebAppSnapshot": "App Service", + "Get-AzWebAppTriggeredWebJobHistory": "App Service", + "Get-AzStaticWebAppBuildAppSetting": "App Service", + "Get-AzWebAppSlotTriggeredWebJobHistory": "App Service", + "Remove-AzWebApp": "App Service", + "Add-AzWebAppAccessRestrictionRule": "App Service", + "Switch-AzWebAppSlot": "App Service", + "Add-AzWebAppTrafficRouting": "App Service", + "Remove-AzStaticWebAppCustomDomain": "App Service", + "Stop-AzWebAppSlot": "App Service", + "Remove-AzStaticWebApp": "App Service", + "Get-AzWebAppSlotWebJob": "App Service", + "Get-AzStaticWebAppCustomDomain": "App Service", + "Remove-AzStaticWebAppBuild": "App Service", + "Get-AzWebAppSlot": "App Service", + "Remove-AzWebAppSlotContinuousWebJob": "App Service", + "Get-AzWebAppCertificate": "App Service", + "Get-AzWebAppSlotConfigName": "App Service", + "Get-AzWebAppContinuousWebJob": "App Service", + "Stop-AzWebAppSlotContinuousWebJob": "App Service", + "Unregister-AzStaticWebAppBuildUserProvidedFunctionApp": "App Service", + "Remove-AzWebAppTrafficRouting": "App Service", + "Get-AzWebAppPublishingProfile": "App Service", + "Edit-AzWebAppBackupConfiguration": "App Service", + "Stop-AzWebAppContinuousWebJob": "App Service", + "Test-AzStaticWebAppCustomDomain": "App Service", + "Get-AzDeletedWebApp": "App Service", + "New-AzAppServicePlan": "App Service", + "Get-AzWebAppBackup": "App Service", + "Restore-AzDeletedWebApp": "App Service", + "Get-AzWebAppTrafficRouting": "App Service", + "New-AzStaticWebApp": "App Service", + "Reset-AzStaticWebAppApiKey": "App Service", + "Get-AzWebApp": "App Service", + "Start-AzWebAppSlot": "App Service", + "Remove-AzWebAppSlot": "App Service", + "New-AzStaticWebAppCustomDomain": "App Service", + "New-AzWebApp": "App Service", + "Get-AzStaticWebAppUserProvidedFunctionApp": "App Service", + "Remove-AzWebAppSSLBinding": "App Service", + "Get-AzStaticWebAppBuild": "App Service", + "Get-AzWebAppSSLBinding": "App Service", + "Set-AzWebAppSlotConfigName": "App Service", + "Update-AzStaticWebAppUser": "App Service", + "Update-AzWebAppTrafficRouting": "App Service", + "Get-AzWebAppBackupList": "App Service", + "Unregister-AzStaticWebAppUserProvidedFunctionApp": "App Service", + "Start-AzWebAppSlotTriggeredWebJob": "App Service", + "Remove-AzAppServiceEnvironment": "App Service", + "Set-AzAppServicePlan": "App Service", + "Get-AzStaticWebAppBuildFunction": "App Service", + "New-AzAppServiceEnvironmentInboundServices": "App Service", + "Remove-AzWebAppSlotTriggeredWebJob": "App Service", + "Remove-AzAppServicePlan": "App Service", + "Remove-AzWebAppContinuousWebJob": "App Service", + "New-AzWebAppDatabaseBackupSetting": "App Service", + "New-AzStaticWebAppSetting": "App Service", + "Get-AzWebAppSlotContinuousWebJob": "App Service", + "Restore-AzWebAppBackup": "App Service", + "New-AzWebAppBackup": "App Service", + "Get-AzStaticWebAppUser": "App Service", + "Set-AzWebApp": "App Service", + "Start-AzWebAppSlotContinuousWebJob": "App Service", + "Remove-AzStaticWebAppAttachedRepository": "App Service", + "Get-AzStaticWebAppFunction": "App Service", + "Get-AzWebAppAccessRestrictionConfig": "App Service", + "New-AzStaticWebAppBuildAppSetting": "App Service", + "Restart-AzWebApp": "App Service", + "Update-AzStaticWebApp": "App Service", + "Get-AzWebAppSlotTriggeredWebJob": "App Service", + "Remove-AzWebAppTriggeredWebJob": "App Service", + "Restore-AzWebAppSnapshot": "App Service", + "Get-AzWebAppWebJob": "App Service", + "Register-AzStaticWebAppUserProvidedFunctionApp": "App Service", + "New-AzStaticWebAppBuildFunctionAppSetting": "App Service", + "Get-AzWebAppContainerContinuousDeploymentUrl": "App Service", + "Start-AzWebAppTriggeredWebJob": "App Service", + "Start-AzWebAppContinuousWebJob": "App Service", + "New-AzWebAppSSLBinding": "App Service", + "Get-AzStaticWebAppConfiguredRole": "App Service", + "Get-AzSystemAssignedIdentity": "Managed Service Identity", + "New-AzUserAssignedIdentity": "Managed Service Identity", + "Get-AzUserAssignedIdentity": "Managed Service Identity", + "Update-AzFederatedIdentityCredentials": "Managed Service Identity", + "Get-AzUserAssignedIdentityAssociatedResource": "Managed Service Identity", + "Remove-AzUserAssignedIdentity": "Managed Service Identity", + "Get-AzFederatedIdentityCredentials": "Managed Service Identity", + "Update-AzUserAssignedIdentity": "Managed Service Identity", + "New-AzFederatedIdentityCredentials": "Managed Service Identity", + "Remove-AzFederatedIdentityCredentials": "Managed Service Identity", + "Set-AzDtlAllowedVMSizesPolicy": "DevTest Labs", + "Get-AzDtlAutoStartPolicy": "DevTest Labs", + "Get-AzDtlAllowedVMSizesPolicy": "DevTest Labs", + "Get-AzDtlVMsPerLabPolicy": "DevTest Labs", + "Get-AzDtlAutoShutdownPolicy": "DevTest Labs", + "Set-AzDtlVMsPerLabPolicy": "DevTest Labs", + "Set-AzDtlAutoStartPolicy": "DevTest Labs", + "Get-AzDtlVMsPerUserPolicy": "DevTest Labs", + "Set-AzDtlAutoShutdownPolicy": "DevTest Labs", + "Set-AzDtlVMsPerUserPolicy": "DevTest Labs", + "New-AzLoad": "LoadTesting", + "Update-AzLoad": "LoadTesting", + "Remove-AzLoad": "LoadTesting", + "Get-AzLoad": "LoadTesting", + "Get-AzADAppPermission": "Active Directory", + "Stop-AzTenantDeployment": "Resources", + "Set-AzManagementGroupDeploymentStack": "Resources", + "Get-AzDeploymentScript": "Resources", + "Update-AzManagementGroup": "Resources", + "Save-AzManagementGroupDeploymentTemplate": "Resources", + "Get-AzManagementGroupDeploymentStack": "Resources", + "Get-AzManagementGroupDeploymentWhatIfResult": "Resources", + "Get-AzRoleDefinition": "Resources", + "Update-AzTag": "Resources", + "Unregister-AzResourceProvider": "Resources", + "Get-AzResource": "Resources", + "Save-AzManagementGroupDeploymentStackTemplate": "Resources", + "Get-AzManagementGroupDeploymentOperation": "Resources", + "Get-AzResourceLock": "Resources", + "Get-AzDeployment": "Resources", + "Get-AzTemplateSpec": "Resources", + "New-AzManagementGroupSubscription": "Resources", + "Get-AzManagementGroup": "Resources", + "Get-AzDenyAssignment": "Resources", + "Register-AzProviderFeature": "Resources", + "Remove-AzADAppPermission": "Active Directory", + "Stop-AzResourceGroupDeployment": "Resources", + "Get-AzADAppFederatedCredential": "Active Directory", + "Register-AzResourceProvider": "Resources", + "Get-AzPolicyDefinition": "Policy", + "Stop-AzManagementGroupDeployment": "Resources", + "Remove-AzADUser": "Active Directory", + "Get-AzProviderOperation": "Resources", + "Save-AzSubscriptionDeploymentStackTemplate": "Resources", + "New-AzRoleEligibilityScheduleRequest": "Resources", + "Stop-AzRoleEligibilityScheduleRequest": "Resources", + "Get-AzADSpCredential": "Active Directory", + "New-AzADUser": "Active Directory", + "New-AzResourceGroup": "Resources", + "New-AzManagementGroupDeploymentStack": "Resources", + "Get-AzProviderFeature": "Resources", + "Get-AzManagedApplicationDefinition": "Managed Applications", + "Save-AzResourceGroupDeploymentTemplate": "Resources", + "Get-AzPolicyExemption": "Policy", + "New-AzResourceLock": "Resources", + "Get-AzADApplication": "Active Directory", + "Set-AzRoleAssignment": "Resources", + "Get-AzRoleEligibilitySchedule": "Resources", + "Save-AzResourceGroupDeploymentStackTemplate": "Resources", + "Remove-AzPolicyAssignment": "Policy", + "Update-AzADUser": "Active Directory", + "Get-AzSubscriptionDeploymentStack": "Resources", + "Set-AzManagedApplicationDefinition": "Managed Applications", + "New-AzRoleAssignmentScheduleRequest": "Resources", + "Remove-AzPrivateLinkAssociation": "Resources", + "Get-AzManagementGroupEntity": "Resources", + "New-AzADApplication": "Active Directory", + "Update-AzRoleManagementPolicy": "Policy", + "Set-AzResourceLock": "Resources", + "Get-AzManagedApplication": "Managed Applications", + "Set-AzResource": "Resources", + "Get-AzADUser": "Active Directory", + "Remove-AzTag": "Resources", + "Remove-AzADServicePrincipal": "Active Directory", + "New-AzManagementGroupDeployment": "Resources", + "Get-AzRoleEligibilityScheduleInstance": "Resources", + "New-AzManagementGroup": "Resources", + "Set-AzRoleDefinition": "Resources", + "Get-AzRoleEligibleChildResource": "Resources", + "Get-AzDeploymentWhatIfResult": "Resources", + "Save-AzDeploymentTemplate": "Resources", + "Test-AzTenantDeployment": "Resources", + "Remove-AzManagementGroupSubscription": "Resources", + "Remove-AzResourceLock": "Resources", + "Update-AzADServicePrincipal": "Active Directory", + "Remove-AzRoleManagementPolicyAssignment": "Policy", + "Get-AzDeploymentScriptLog": "Resources", + "Get-AzManagementGroupNameAvailability": "Resources", + "Get-AzADAppCredential": "Active Directory", + "Get-AzDeploymentOperation": "Resources", + "Update-AzADGroup": "Active Directory", + "Stop-AzDeployment": "Resources", + "Remove-AzResourceGroup": "Resources", + "Remove-AzManagedApplication": "Managed Applications", + "Remove-AzADSpCredential": "Active Directory", + "Get-AzPolicySetDefinition": "Policy", + "Remove-AzDeploymentScript": "Resources", + "New-AzRoleDefinition": "Resources", + "Get-AzResourceGroup": "Resources", + "Remove-AzResourceGroupDeploymentStack": "Resources", + "New-AzTenantDeployment": "Resources", + "Remove-AzDeployment": "Resources", + "New-AzPrivateLinkAssociation": "Resources", + "Get-AzTenantBackfillStatus": "Resources", + "Get-AzADGroupMember": "Active Directory", + "Register-AzProviderPreviewFeature": "Resources", + "Get-AzRoleAssignmentScheduleRequest": "Resources", + "Remove-AzResourceGroupDeployment": "Resources", + "New-AzPolicyAssignment": "Policy", + "Remove-AzTemplateSpec": "Resources", + "New-AzADAppFederatedCredential": "Active Directory", + "Remove-AzTenantDeployment": "Resources", + "Remove-AzRoleAssignment": "Resources", + "Move-AzResource": "Resources", + "Unregister-AzProviderPreviewFeature": "Resources", + "Test-AzManagementGroupDeployment": "Resources", + "New-AzManagementGroupHierarchySetting": "Resources", + "Remove-AzSubscriptionDeploymentStack": "Resources", + "Set-AzManagedApplication": "Managed Applications", + "New-AzResourceGroupDeploymentStack": "Resources", + "Get-AzRoleEligibilityScheduleRequest": "Resources", + "Remove-AzRoleDefinition": "Resources", + "New-AzResourceGroupDeployment": "Resources", + "Save-AzDeploymentScriptLog": "Resources", + "Update-AzADApplication": "Active Directory", + "Get-AzRoleAssignmentSchedule": "Resources", + "Update-AzManagementGroupHierarchySetting": "Resources", + "Get-AzResourceProvider": "Resources", + "Get-AzLocation": "Resources", + "Add-AzADAppPermission": "Active Directory", + "Get-AzRoleAssignment": "Resources", + "Set-AzResourceGroup": "Resources", + "Get-AzResourceGroupDeploymentOperation": "Resources", + "Update-AzADAppFederatedCredential": "Active Directory", + "Start-AzTenantBackfill": "Resources", + "Set-AzPolicyDefinition": "Policy", + "New-AzRoleManagementPolicyAssignment": "Policy", + "Save-AzTenantDeploymentTemplate": "Resources", + "Get-AzPolicyAlias": "Policy", + "New-AzTag": "Resources", + "Get-AzResourceGroupDeployment": "Resources", + "Set-AzPolicySetDefinition": "Policy", + "Export-AzResourceGroup": "Resources", + "Remove-AzManagementGroupDeploymentStack": "Resources", + "Remove-AzPolicySetDefinition": "Policy", + "Remove-AzResource": "Resources", + "Remove-AzManagementGroupDeployment": "Resources", + "New-AzResource": "Resources", + "Get-AzADOrganization": "Active Directory", + "Get-AzManagementGroupDeployment": "Resources", + "New-AzRoleAssignment": "Resources", + "Set-AzPolicyAssignment": "Policy", + "Get-AzManagementGroupHierarchySetting": "Resources", + "New-AzManagedApplication": "Managed Applications", + "New-AzResourceManagementPrivateLink": "Resources", + "Get-AzTenantDeploymentOperation": "Resources", + "Test-AzDeployment": "Resources", + "Set-AzTemplateSpec": "Resources", + "Get-AzResourceGroupDeploymentWhatIfResult": "Resources", + "Remove-AzADAppFederatedCredential": "Active Directory", + "New-AzADGroup": "Active Directory", + "Get-AzPolicyAssignment": "Policy", + "Test-AzResourceGroupDeployment": "Resources", + "Remove-AzManagedApplicationDefinition": "Managed Applications", + "New-AzSubscriptionDeploymentStack": "Resources", + "Remove-AzADGroup": "Active Directory", + "New-AzPolicySetDefinition": "Policy", + "Get-AzProviderPreviewFeature": "Resources", + "Get-AzRoleManagementPolicyAssignment": "Policy", + "Get-AzADGroup": "Active Directory", + "Get-AzPrivateLinkAssociation": "Resources", + "Remove-AzManagementGroup": "Resources", + "Set-AzSubscriptionDeploymentStack": "Resources", + "Remove-AzADApplication": "Active Directory", + "Stop-AzRoleAssignmentScheduleRequest": "Resources", + "Get-AzResourceManagementPrivateLink": "Resources", + "Add-AzADGroupMember": "Active Directory", + "Get-AzTenantDeploymentWhatIfResult": "Resources", + "Get-AzTag": "Resources", + "Export-AzTemplateSpec": "Resources", + "Get-AzTenantDeployment": "Resources", + "Remove-AzPolicyDefinition": "Policy", + "New-AzADSpCredential": "Active Directory", + "Invoke-AzResourceAction": "Resources", + "Remove-AzRoleManagementPolicy": "Policy", + "Remove-AzResourceManagementPrivateLink": "Resources", + "New-AzADServicePrincipal": "Active Directory", + "Remove-AzPolicyExemption": "Policy", + "New-AzManagedApplicationDefinition": "Managed Applications", + "Remove-AzManagementGroupHierarchySetting": "Resources", + "New-AzDeployment": "Resources", + "Remove-AzADGroupMember": "Active Directory", + "Set-AzResourceGroupDeploymentStack": "Resources", + "Get-AzRoleAssignmentScheduleInstance": "Resources", + "Get-AzRoleManagementPolicy": "Policy", + "Unregister-AzProviderFeature": "Resources", + "New-AzADAppCredential": "Active Directory", + "Set-AzPolicyExemption": "Policy", + "New-AzPolicyExemption": "Policy", + "Publish-AzBicepModule": "Resources", + "Get-AzManagementGroupSubscription": "Resources", + "Remove-AzADAppCredential": "Active Directory", + "New-AzPolicyDefinition": "Policy", + "Get-AzResourceGroupDeploymentStack": "Resources", + "New-AzTemplateSpec": "Resources", + "Get-AzADServicePrincipal": "Active Directory", + "New-AzConnectedMachineExtension": "Connected Machine", + "Remove-AzConnectedPrivateLinkScope": "Connected Machine", + "Get-AzConnectedPrivateLinkScope": "Connected Machine", + "Update-AzConnectedMachine": "Connected Machine", + "Get-AzConnectedMachine": "Connected Machine", + "New-AzConnectedPrivateLinkScope": "Connected Machine", + "Remove-AzConnectedMachineExtension": "Connected Machine", + "Connect-AzConnectedMachine": "Connected Machine", + "Set-AzConnectedMachineExtension": "Connected Machine", + "Get-AzConnectedMachineExtension": "Connected Machine", + "Remove-AzConnectedMachine": "Connected Machine", + "Update-AzConnectedExtension": "Connected Machine", + "Set-AzConnectedPrivateLinkScope": "Connected Machine", + "Update-AzConnectedPrivateLinkScopeTag": "Connected Machine", + "Update-AzConnectedMachineExtension": "Connected Machine", + "Restore-AzMySqlFlexibleServer": "Database for MySQL", + "New-AzMySqlFlexibleServerReplica": "Database for MySQL", + "Restore-AzMySqlServer": "Database for MySQL", + "New-AzMySqlFlexibleServerDatabase": "Database for MySQL", + "Remove-AzMySqlFlexibleServerDatabase": "Database for MySQL", + "Remove-AzMySqlFlexibleServer": "Database for MySQL", + "Remove-AzMySqlFlexibleServerFirewallRule": "Database for MySQL", + "New-AzMySqlServer": "Database for MySQL", + "Restart-AzMySqlServer": "Database for MySQL", + "Get-AzMySqlVirtualNetworkRule": "Database for MySQL", + "New-AzMySqlVirtualNetworkRule": "Database for MySQL", + "Update-AzMySqlVirtualNetworkRule": "Database for MySQL", + "Update-AzMySqlFlexibleServer": "Database for MySQL", + "Get-AzMySqlFlexibleServerConnectionString": "Database for MySQL", + "Get-AzMySqlReplica": "Database for MySQL", + "Get-AzMySqlFlexibleServerLocationBasedCapability": "Database for MySQL", + "Get-AzMySqlServer": "Database for MySQL", + "Get-AzMySqlFlexibleServerConfiguration": "Database for MySQL", + "Remove-AzMySqlFirewallRule": "Database for MySQL", + "Stop-AzMySqlFlexibleServer": "Database for MySQL", + "Update-AzMySqlFirewallRule": "Database for MySQL", + "Get-AzMySqlConnectionString": "Database for MySQL", + "Get-AzMySqlFirewallRule": "Database for MySQL", + "Get-AzMySqlFlexibleServerFirewallRule": "Database for MySQL", + "Update-AzMySqlServerConfigurationsList": "Database for MySQL", + "Restart-AzMySqlFlexibleServer": "Database for MySQL", + "Update-AzMySqlServer": "Database for MySQL", + "New-AzMySqlFlexibleServer": "Database for MySQL", + "Test-AzMySqlFlexibleServerConnect": "Database for MySQL", + "New-AzMySqlReplica": "Database for MySQL", + "New-AzMySqlFirewallRule": "Database for MySQL", + "Remove-AzMySqlVirtualNetworkRule": "Database for MySQL", + "Get-AzMySqlFlexibleServerReplica": "Database for MySQL", + "Get-AzMySqlConfiguration": "Database for MySQL", + "New-AzMySqlFlexibleServerFirewallRule": "Database for MySQL", + "Update-AzMySqlConfiguration": "Database for MySQL", + "Get-AzMySqlFlexibleServer": "Database for MySQL", + "Remove-AzMySqlServer": "Database for MySQL", + "Update-AzMySqlFlexibleServerFirewallRule": "Database for MySQL", + "Start-AzMySqlFlexibleServer": "Database for MySQL", + "Get-AzMySqlFlexibleServerDatabase": "Database for MySQL", + "Update-AzMySqlFlexibleServerConfiguration": "Database for MySQL", + "Export-AzSshConfig": "SSH", + "Enter-AzVM": "SSH", + "New-AzPurviewAzureSqlDatabaseManagedInstanceMsiScanObject": "Purview", + "New-AzPurviewAzureSynapseWorkspaceCredentialScanObject": "Purview", + "New-AzPurviewOracleDataSourceObject": "Purview", + "Get-AzPurviewAccount": "Purview", + "Get-AzPurviewDefaultAccount": "Purview", + "Test-AzPurviewAccountNameAvailability": "Purview", + "New-AzPurviewAzureStorageScanRulesetObject": "Purview", + "New-AzPurviewAdlsGen2DataSourceObject": "Purview", + "Invoke-AzPurviewTagClassificationRuleClassificationVersion": "Purview", + "Remove-AzPurviewKeyVaultConnection": "Purview", + "New-AzPurviewAzureSqlDatabaseMsiScanObject": "Purview", + "New-AzPurviewAmazonPostgreSqlDataSourceObject": "Purview", + "Add-AzPurviewAccountRootCollectionAdmin": "Purview", + "New-AzPurviewAzureFileServiceCredentialScanObject": "Purview", + "New-AzPurviewAzureStorageCredentialScanObject": "Purview", + "New-AzPurviewKeyVaultConnection": "Purview", + "New-AzPurviewAzureSqlDatabaseScanRulesetObject": "Purview", + "New-AzPurviewRegexClassificationRulePatternObject": "Purview", + "New-AzPurviewAmazonS3ScanRulesetObject": "Purview", + "New-AzPurviewAmazonSqlScanRulesetObject": "Purview", + "New-AzPurviewAmazonAccountDataSourceObject": "Purview", + "Remove-AzPurviewAccount": "Purview", + "New-AzPurviewClassificationRule": "Purview", + "Set-AzPurviewDefaultAccount": "Purview", + "New-AzPurviewAzureDataExplorerMsiScanObject": "Purview", + "New-AzPurviewAdlsGen1ScanRulesetObject": "Purview", + "New-AzPurviewAzureStorageDataSourceObject": "Purview", + "New-AzPurviewAdlsGen2MsiScanObject": "Purview", + "Get-AzPurviewSystemScanRuleset": "Purview", + "New-AzPurviewAzureCosmosDbDataSourceObject": "Purview", + "New-AzPurviewAzureDataExplorerCredentialScanObject": "Purview", + "Start-AzPurviewScanResultScan": "Purview", + "New-AzPurviewTeradataDataSourceObject": "Purview", + "New-AzPurviewAmazonS3CredentialScanObject": "Purview", + "New-AzPurviewAzureResourceGroupCredentialScanObject": "Purview", + "Remove-AzPurviewDefaultAccount": "Purview", + "Get-AzPurviewKeyVaultConnection": "Purview", + "New-AzPurviewAzurePostgreSqlScanRulesetObject": "Purview", + "New-AzPurviewSapS4HanaDataSourceObject": "Purview", + "New-AzPurviewAzureSubscriptionCredentialScanObject": "Purview", + "New-AzPurviewAzureSqlDatabaseManagedInstanceDataSourceObject": "Purview", + "New-AzPurviewAzureDataExplorerScanRulesetObject": "Purview", + "New-AzPurviewAzureSqlDataWarehouseMsiScanObject": "Purview", + "New-AzPurviewAmazonPostgreSqlScanRulesetObject": "Purview", + "New-AzPurviewScan": "Purview", + "New-AzPurviewAzureSynapseWorkspaceScanRulesetObject": "Purview", + "New-AzPurviewSqlServerDatabaseScanRulesetObject": "Purview", + "New-AzPurviewCustomClassificationRuleObject": "Purview", + "New-AzPurviewAzureSynapseWorkspaceDataSourceObject": "Purview", + "New-AzPurviewAzureKeyVaultObject": "Purview", + "New-AzPurviewAzurePostgreSqlDataSourceObject": "Purview", + "New-AzPurviewPowerBIDelegatedScanObject": "Purview", + "Remove-AzPurviewClassificationRule": "Purview", + "New-AzPurviewAzureSqlDatabaseManagedInstanceScanRulesetObject": "Purview", + "New-AzPurviewAzureSubscriptionDataSourceObject": "Purview", + "New-AzPurviewAmazonSqlCredentialScanObject": "Purview", + "New-AzPurviewAzureSynapseWorkspaceMsiScanObject": "Purview", + "New-AzPurviewAzureResourceGroupMsiScanObject": "Purview", + "New-AzPurviewSapS4HanaSapS4HanaCredentialScanObject": "Purview", + "Get-AzPurviewClassificationRuleVersion": "Purview", + "New-AzPurviewAzureSqlDatabaseManagedInstanceCredentialScanObject": "Purview", + "New-AzPurviewAmazonS3DataSourceObject": "Purview", + "Get-AzPurviewTrigger": "Purview", + "New-AzPurviewAdlsGen1CredentialScanObject": "Purview", + "New-AzPurviewAzureStorageMsiScanObject": "Purview", + "New-AzPurviewAzureSqlDatabaseDataSourceObject": "Purview", + "New-AzPurviewAdlsGen2CredentialScanObject": "Purview", + "New-AzPurviewAdlsGen2ScanRulesetObject": "Purview", + "New-AzPurviewAzurePostgreSqlCredentialScanObject": "Purview", + "New-AzPurviewAdlsGen1DataSourceObject": "Purview", + "New-AzPurviewDataSource": "Purview", + "Get-AzPurviewClassificationRule": "Purview", + "New-AzPurviewPowerBIMsiScanObject": "Purview", + "New-AzPurviewAmazonSqlDataSourceObject": "Purview", + "Remove-AzPurviewScanRuleset": "Purview", + "Get-AzPurviewSystemScanRulesetVersion": "Purview", + "Remove-AzPurviewScan": "Purview", + "Get-AzPurviewSystemScanRulesetLatest": "Purview", + "New-AzPurviewAzureSubscriptionMsiScanObject": "Purview", + "New-AzPurviewAzureMySqlCredentialScanObject": "Purview", + "Get-AzPurviewScanResultScanHistory": "Purview", + "New-AzPurviewFilter": "Purview", + "New-AzPurviewFilterObject": "Purview", + "New-AzPurviewSqlServerDatabaseDataSourceObject": "Purview", + "Get-AzPurviewScanRuleset": "Purview", + "New-AzPurviewAmazonPostgreSqlCredentialScanObject": "Purview", + "New-AzPurviewAdlsGen1MsiScanObject": "Purview", + "New-AzPurviewTrigger": "Purview", + "New-AzPurviewSapEccDataSourceObject": "Purview", + "New-AzPurviewPowerBIDataSourceObject": "Purview", + "Get-AzPurviewScan": "Purview", + "Remove-AzPurviewTrigger": "Purview", + "New-AzPurviewScanRuleset": "Purview", + "Remove-AzPurviewDataSource": "Purview", + "New-AzPurviewAzureMySqlScanRulesetObject": "Purview", + "New-AzPurviewAzureFileServiceDataSourceObject": "Purview", + "Stop-AzPurviewScanResultScan": "Purview", + "New-AzPurviewAccount": "Purview", + "New-AzPurviewAzureSqlDataWarehouseDataSourceObject": "Purview", + "New-AzPurviewAzureCosmosDbCredentialScanObject": "Purview", + "Get-AzPurviewFilter": "Purview", + "New-AzPurviewTriggerObject": "Purview", + "New-AzPurviewAzureSqlDatabaseCredentialScanObject": "Purview", + "New-AzPurviewAzureCosmosDbScanRulesetObject": "Purview", + "New-AzPurviewAmazonAccountCredentialScanObject": "Purview", + "New-AzPurviewSqlServerDatabaseCredentialScanObject": "Purview", + "New-AzPurviewAzureFileServiceScanRulesetObject": "Purview", + "Update-AzPurviewAccount": "Purview", + "New-AzPurviewAzureResourceGroupDataSourceObject": "Purview", + "Get-AzPurviewDataSource": "Purview", + "New-AzPurviewAzureMySqlDataSourceObject": "Purview", + "New-AzPurviewAzureDataExplorerDataSourceObject": "Purview", + "New-AzPurviewAzureSqlDataWarehouseScanRulesetObject": "Purview", + "Get-AzPurviewAccountKey": "Purview", + "New-AzPurviewAzureSqlDataWarehouseCredentialScanObject": "Purview", + "New-AzDataMigrationSqlService": "Data Migration", + "New-AzDataMigrationToSqlDb": "Data Migration", + "New-AzDataMigrationMongoDbCollectionSetting": "Data Migration", + "New-AzDataMigrationSqlServerSchema": "Data Migration", + "Invoke-AzDataMigrationCommand": "Data Migration", + "Get-AzDataMigrationSqlServiceIntegrationRuntimeMetric": "Data Migration", + "Remove-AzDataMigrationService": "Data Migration", + "Get-AzDataMigrationToSqlDb": "Data Migration", + "Get-AzDataMigrationProject": "Data Migration", + "Get-AzDataMigrationTask": "Data Migration", + "Stop-AzDataMigrationTask": "Data Migration", + "New-AzDataMigrationTdeCertificateMigration": "Data Migration", + "Get-AzDataMigrationAssessment": "Data Migration", + "Get-AzDataMigrationSqlServiceAuthKey": "Data Migration", + "Stop-AzDataMigrationToSqlManagedInstance": "Data Migration", + "New-AzDataMigrationLoginsMigration": "Data Migration", + "Get-AzDataMigrationSkuRecommendation": "Data Migration", + "Invoke-AzDataMigrationCutoverToSqlVM": "Data Migration", + "Stop-AzDataMigrationToSqlDb": "Data Migration", + "New-AzDataMigrationProject": "Data Migration", + "Get-AzDataMigrationService": "Data Migration", + "New-AzDataMigrationFileShare": "Data Migration", + "New-AzDataMigrationSqlServiceAuthKey": "Data Migration", + "Get-AzDataMigrationPerformanceDataCollection": "Data Migration", + "New-AzDataMigrationSyncSelectedDBObject": "Data Migration", + "New-AzDataMigrationConnectionInfo": "Data Migration", + "Remove-AzDataMigrationSqlService": "Data Migration", + "Stop-AzDataMigrationToSqlVM": "Data Migration", + "New-AzDataMigrationTask": "Data Migration", + "Get-AzDataMigrationToSqlVM": "Data Migration", + "New-AzDataMigrationDatabaseInfo": "Data Migration", + "Register-AzDataMigrationIntegrationRuntime": "Data Migration", + "Get-AzDataMigrationSqlServiceMigration": "Data Migration", + "Stop-AzDataMigrationService": "Data Migration", + "New-AzDataMigrationSelectedDBObject": "Data Migration", + "Get-AzDataMigrationToSqlManagedInstance": "Data Migration", + "Remove-AzDataMigrationSqlServiceNode": "Data Migration", + "Remove-AzDataMigrationToSqlDb": "Data Migration", + "Start-AzDataMigrationService": "Data Migration", + "Remove-AzDataMigrationTask": "Data Migration", + "Invoke-AzDataMigrationCutoverToSqlManagedInstance": "Data Migration", + "Update-AzDataMigrationSqlService": "Data Migration", + "Get-AzDataMigrationSqlService": "Data Migration", + "Remove-AzDataMigrationProject": "Data Migration", + "New-AzDataMigrationMongoDbDatabaseSetting": "Data Migration", + "New-AzDataMigrationToSqlVM": "Data Migration", + "New-AzDataMigrationAzureActiveDirectoryApp": "Data Migration", + "New-AzDataMigrationService": "Data Migration", + "New-AzDataMigrationToSqlManagedInstance": "Data Migration", + "Remove-AzIotCentralApp": "IotCentral", + "Get-AzIotCentralApp": "IotCentral", + "Set-AzIotCentralApp": "IotCentral", + "New-AzIotCentralApp": "IotCentral", + "Get-AzStorageMoverJobDefinition": "Storage Mover", + "Stop-AzStorageMoverJobDefinition": "Storage Mover", + "New-AzStorageMoverProject": "Storage Mover", + "Get-AzStorageMoverAgent": "Storage Mover", + "New-AzStorageMoverAzStorageContainerEndpoint": "Storage Mover", + "Get-AzStorageMoverJobRun": "Storage Mover", + "Get-AzStorageMoverEndpoint": "Storage Mover", + "Update-AzStorageMover": "Storage Mover", + "Update-AzStorageMoverJobDefinition": "Storage Mover", + "Remove-AzStorageMover": "Storage Mover", + "Update-AzStorageMoverNfsEndpoint": "Storage Mover", + "Update-AzStorageMoverProject": "Storage Mover", + "New-AzStorageMover": "Storage Mover", + "New-AzStorageMoverJobDefinition": "Storage Mover", + "Remove-AzStorageMoverJobDefinition": "Storage Mover", + "New-AzStorageMoverNfsEndpoint": "Storage Mover", + "Remove-AzStorageMoverEndpoint": "Storage Mover", + "Get-AzStorageMoverProject": "Storage Mover", + "Remove-AzStorageMoverProject": "Storage Mover", + "Start-AzStorageMoverJobDefinition": "Storage Mover", + "Update-AzStorageMoverAzStorageContainerEndpoint": "Storage Mover", + "Update-AzStorageMoverAgent": "Storage Mover", + "Unregister-AzStorageMoverAgent": "Storage Mover", + "Get-AzStorageMover": "Storage Mover", + "Get-AzBareMetal": "BareMetal", + "Update-AzBareMetal": "BareMetal", + "New-AzTrafficManagerEndpoint": "Traffic Manager", + "New-AzTrafficManagerProfile": "Traffic Manager", + "Remove-AzTrafficManagerExpectedStatusCodeRange": "Traffic Manager", + "Remove-AzTrafficManagerIpAddressRange": "Traffic Manager", + "Disable-AzTrafficManagerProfile": "Traffic Manager", + "Get-AzTrafficManagerEndpoint": "Traffic Manager", + "Remove-AzTrafficManagerCustomHeaderFromEndpoint": "Traffic Manager", + "Get-AzTrafficManagerProfile": "Traffic Manager", + "Remove-AzTrafficManagerProfile": "Traffic Manager", + "Add-AzTrafficManagerEndpointConfig": "Traffic Manager", + "Remove-AzTrafficManagerEndpointConfig": "Traffic Manager", + "Set-AzTrafficManagerEndpoint": "Traffic Manager", + "Enable-AzTrafficManagerEndpoint": "Traffic Manager", + "Add-AzTrafficManagerExpectedStatusCodeRange": "Traffic Manager", + "Add-AzTrafficManagerIpAddressRange": "Traffic Manager", + "Add-AzTrafficManagerCustomHeaderToEndpoint": "Traffic Manager", + "Disable-AzTrafficManagerEndpoint": "Traffic Manager", + "Remove-AzTrafficManagerEndpoint": "Traffic Manager", + "Enable-AzTrafficManagerProfile": "Traffic Manager", + "Add-AzTrafficManagerCustomHeaderToProfile": "Traffic Manager", + "Remove-AzTrafficManagerCustomHeaderFromProfile": "Traffic Manager", + "Set-AzTrafficManagerProfile": "Traffic Manager", + "Get-AzDiskPool": "DiskPool", + "Invoke-AzDiskPoolRedeployment": "DiskPool", + "Update-AzDiskPool": "DiskPool", + "Get-AzDiskPoolOutboundNetworkDependencyEndpoint": "DiskPool", + "Start-AzDiskPool": "DiskPool", + "Stop-AzDiskPool": "DiskPool", + "Get-AzDiskPoolZone": "DiskPool", + "Remove-AzDiskPool": "DiskPool", + "New-AzDiskPoolIscsiTarget": "DiskPool", + "Remove-AzDiskPoolIscsiTarget": "DiskPool", + "Update-AzDiskPoolIscsiTarget": "DiskPool", + "New-AzDiskPoolAclObject": "DiskPool", + "Get-AzDiskPoolResourceSku": "DiskPool", + "New-AzDiskPool": "DiskPool", + "New-AzDiskPoolIscsiLunObject": "DiskPool", + "Get-AzDiskPoolIscsiTarget": "DiskPool", + "Get-AzReservationOrderId": "Reservations", + "Merge-AzReservation": "Reservations", + "Get-AzReservationQuote": "Reservations", + "Update-AzReservation": "Reservations", + "New-AzReservation": "Reservations", + "Invoke-AzReservationCalculateRefund": "Reservations", + "Split-AzReservation": "Reservations", + "Invoke-AzReservationReturn": "Reservations", + "Get-AzReservationCatalog": "Reservations", + "Get-AzReservationHistory": "Reservations", + "Get-AzReservationOrder": "Reservations", + "Invoke-AzReservationExchange": "Reservations", + "Move-AzReservationDirectory": "Reservations", + "Invoke-AzReservationArchiveReservation": "Reservations", + "Invoke-AzReservationCalculateExchange": "Reservations", + "Get-AzReservation": "Reservations", + "Get-AzReservationAvailableScope": "Reservations", + "Invoke-AzReservationUnarchiveReservation": "Reservations", + "Get-AzDatadogTagRule": "Datadog", + "New-AzDatadogFilteringTagObject": "Datadog", + "Update-AzDatadogMonitor": "Datadog", + "Update-AzDatadogMonitorSetPasswordLink": "Datadog", + "Set-AzDatadogMonitorDefaultKey": "Datadog", + "Get-AzDatadogMonitorDefaultKey": "Datadog", + "New-AzDatadogTagRule": "Datadog", + "Get-AzDatadogMonitorMonitoredResource": "Datadog", + "Remove-AzDatadogMonitor": "Datadog", + "New-AzDatadogMonitor": "Datadog", + "Get-AzDatadogMonitorApiKey": "Datadog", + "New-AzDatadogMarketplaceAgreement": "Datadog", + "Get-AzDatadogMonitorHost": "Datadog", + "Get-AzDatadogMonitor": "Datadog", + "Get-AzDatadogMarketplaceAgreement": "Datadog", + "Get-AzDatadogMonitorLinkedResource": "Datadog", + "Get-AzDatadogSingleSignOnConfiguration": "Datadog", + "New-AzDatadogSingleSignOnConfiguration": "Datadog", + "New-AzNginxConfigurationFileObject": "Nginx", + "Get-AzNginxCertificate": "Nginx", + "New-AzNginxCertificate": "Nginx", + "New-AzNginxConfiguration": "Nginx", + "New-AzNginxPrivateIPAddressObject": "Nginx", + "New-AzNginxNetworkProfileObject": "Nginx", + "Update-AzNginxDeployment": "Nginx", + "Remove-AzNginxCertificate": "Nginx", + "Get-AzNginxDeployment": "Nginx", + "Remove-AzNginxConfiguration": "Nginx", + "New-AzNginxDeployment": "Nginx", + "Remove-AzNginxDeployment": "Nginx", + "New-AzNginxPublicIPAddressObject": "Nginx", + "Get-AzNginxConfiguration": "Nginx", + "New-AzFrontDoorCdnRuleClientPortConditionObject": "CDN", + "Get-AzCdnOriginGroup": "CDN", + "Get-AzFrontDoorCdnEndpoint": "CDN", + "Remove-AzCdnOrigin": "CDN", + "Update-AzFrontDoorCdnSecurityPolicy": "CDN", + "New-AzCdnDeliveryRuleUrlPathConditionObject": "CDN", + "New-AzCdnDeliveryRuleCacheKeyQueryStringActionObject": "CDN", + "Remove-AzFrontDoorCdnEndpoint": "CDN", + "New-AzCdnOriginGroup": "CDN", + "Test-AzFrontDoorCdnEndpointCustomDomain": "CDN", + "New-AzFrontDoorCdnRuleUrlFileExtensionConditionObject": "CDN", + "New-AzCdnHealthProbeParametersObject": "CDN", + "New-AzFrontDoorCdnProfile": "CDN", + "Test-AzCdnProbe": "CDN", + "Get-AzCdnProfile": "CDN", + "New-AzFrontDoorCdnRuleIsDeviceConditionObject": "CDN", + "Get-AzCdnEndpoint": "CDN", + "Get-AzCdnEndpointResourceUsage": "CDN", + "New-AzCdnDeliveryRuleRemoteAddressConditionObject": "CDN", + "New-AzFrontDoorCdnCustomDomainTlsSettingParametersObject": "CDN", + "Get-AzCdnProfileSupportedOptimizationType": "CDN", + "Update-AzCdnOrigin": "CDN", + "New-AzFrontDoorCdnRuleHttpVersionConditionObject": "CDN", + "Get-AzFrontDoorCdnSecurityPolicy": "CDN", + "New-AzCdnPurgeParametersObject": "CDN", + "New-AzFrontDoorCdnRuleUrlFileNameConditionObject": "CDN", + "Remove-AzCdnProfile": "CDN", + "Get-AzFrontDoorCdnProfile": "CDN", + "Update-AzFrontDoorCdnCustomDomain": "CDN", + "New-AzCdnLoadParametersObject": "CDN", + "New-AzFrontDoorCdnRuleHostNameConditionObject": "CDN", + "New-AzFrontDoorCdnPurgeParametersObject": "CDN", + "Remove-AzCdnEndpoint": "CDN", + "Remove-AzCdnOriginGroup": "CDN", + "New-AzFrontDoorCdnRuleRouteConfigurationOverrideActionObject": "CDN", + "New-AzFrontDoorCdnRuleUrlRewriteActionObject": "CDN", + "New-AzFrontDoorCdnRuleQueryStringConditionObject": "CDN", + "New-AzCdnDeliveryRuleRequestHeaderActionObject": "CDN", + "New-AzFrontDoorCdnRuleResponseHeaderActionObject": "CDN", + "Get-AzFrontDoorCdnOriginGroup": "CDN", + "Update-AzFrontDoorCdnEndpoint": "CDN", + "Import-AzCdnEndpointContent": "CDN", + "New-AzFrontDoorCdnRuleUrlPathConditionObject": "CDN", + "New-AzFrontDoorCdnRuleSslProtocolConditionObject": "CDN", + "Update-AzCdnProfile": "CDN", + "Get-AzCdnCustomDomain": "CDN", + "Update-AzFrontDoorCdnRule": "CDN", + "Update-AzFrontDoorCdnProfileSku": "CDN", + "New-AzCdnUrlSigningActionObject": "CDN", + "New-AzFrontDoorCdnMigrationWebApplicationFirewallMappingObject": "CDN", + "New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject": "CDN", + "New-AzCdnOrigin": "CDN", + "New-AzCdnCustomDomain": "CDN", + "New-AzCdnUrlRewriteActionObject": "CDN", + "New-AzFrontDoorCdnMigrationParametersObject": "CDN", + "Get-AzCdnSubscriptionResourceUsage": "CDN", + "Update-AzCdnEndpoint": "CDN", + "New-AzFrontDoorCdnRuleServerPortConditionObject": "CDN", + "Update-AzFrontDoorCdnProfile": "CDN", + "Remove-AzFrontDoorCdnCustomDomain": "CDN", + "New-AzCdnDeliveryRuleRequestUriConditionObject": "CDN", + "New-AzCdnDeliveryRuleQueryStringConditionObject": "CDN", + "New-AzFrontDoorCdnSecretFirstPartyManagedCertificateParametersObject": "CDN", + "Get-AzFrontDoorCdnOrigin": "CDN", + "Remove-AzFrontDoorCdnSecurityPolicy": "CDN", + "Get-AzFrontDoorCdnProfileResourceUsage": "CDN", + "New-AzCdnDeliveryRuleCookiesConditionObject": "CDN", + "New-AzCdnDeliveryRuleIsDeviceConditionObject": "CDN", + "Get-AzFrontDoorCdnCustomDomain": "CDN", + "New-AzCdnDeliveryRuleUrlFileExtensionConditionObject": "CDN", + "Test-AzFrontDoorCdnProfileHostNameAvailability": "CDN", + "Remove-AzFrontDoorCdnProfile": "CDN", + "New-AzFrontDoorCdnRuleRequestHeaderConditionObject": "CDN", + "New-AzFrontDoorCdnRuleRequestSchemeConditionObject": "CDN", + "New-AzFrontDoorCdnCustomDomain": "CDN", + "New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallParametersObject": "CDN", + "Start-AzFrontDoorCdnProfilePrepareMigration": "CDN", + "New-AzCdnDeliveryRuleRequestHeaderConditionObject": "CDN", + "Get-AzCdnProfileResourceUsage": "CDN", + "Stop-AzCdnEndpoint": "CDN", + "New-AzFrontDoorCdnRuleCookiesConditionObject": "CDN", + "Remove-AzCdnCustomDomain": "CDN", + "Stop-AzFrontDoorCdnProfileMigration": "CDN", + "New-AzCdnManagedHttpsParametersObject": "CDN", + "New-AzFrontDoorCdnRuleSet": "CDN", + "Get-AzFrontDoorCdnSecret": "CDN", + "New-AzFrontDoorCdnSecret": "CDN", + "Test-AzCdnNameAvailability": "CDN", + "New-AzCdnDeliveryRuleHttpVersionConditionObject": "CDN", + "New-AzFrontDoorCdnRulePostArgsConditionObject": "CDN", + "New-AzCdnDeliveryRuleResponseHeaderActionObject": "CDN", + "Enable-AzFrontDoorCdnProfileMigration": "CDN", + "New-AzCdnDeliveryRulePostArgsConditionObject": "CDN", + "New-AzFrontDoorCdnRuleRequestBodyConditionObject": "CDN", + "Get-AzFrontDoorCdnRuleSetResourceUsage": "CDN", + "Get-AzFrontDoorCdnEndpointResourceUsage": "CDN", + "Start-AzCdnEndpoint": "CDN", + "Remove-AzFrontDoorCdnRoute": "CDN", + "New-AzCdnResponseBasedOriginErrorDetectionParametersObject": "CDN", + "New-AzFrontDoorCdnSecretManagedCertificateParametersObject": "CDN", + "New-AzFrontDoorCdnResourceReferenceObject": "CDN", + "Update-AzFrontDoorCdnRoute": "CDN", + "New-AzFrontDoorCdnSecurityPolicy": "CDN", + "New-AzCdnUrlRedirectActionObject": "CDN", + "New-AzFrontDoorCdnSecretUrlSigningKeyParametersObject": "CDN", + "Get-AzFrontDoorCdnRule": "CDN", + "New-AzFrontDoorCdnProfileUpgradeParametersObject": "CDN", + "Update-AzFrontDoorCdnCustomDomainValidationToken": "CDN", + "Get-AzCdnOrigin": "CDN", + "New-AzCdnDeliveryRuleRequestBodyConditionObject": "CDN", + "New-AzCdnResourceReferenceObject": "CDN", + "New-AzFrontDoorCdnRuleUrlRedirectActionObject": "CDN", + "Remove-AzFrontDoorCdnRule": "CDN", + "New-AzCdnEndpoint": "CDN", + "New-AzFrontDoorCdnRuleRequestUriConditionObject": "CDN", + "New-AzCdnUserManagedHttpsParametersObject": "CDN", + "New-AzFrontDoorCdnRuleSocketAddrConditionObject": "CDN", + "New-AzFrontDoorCdnSecurityPolicyWebApplicationFirewallAssociationObject": "CDN", + "New-AzFrontDoorCdnRuleRemoteAddressConditionObject": "CDN", + "Test-AzFrontDoorCdnEndpointNameAvailability": "CDN", + "New-AzFrontDoorCdnRule": "CDN", + "New-AzFrontDoorCdnSecretCustomerCertificateParametersObject": "CDN", + "Disable-AzCdnCustomDomainCustomHttps": "CDN", + "New-AzFrontDoorCdnRuleRequestMethodConditionObject": "CDN", + "Update-AzCdnOriginGroup": "CDN", + "New-AzCdnOriginGroupOverrideActionObject": "CDN", + "Enable-AzCdnCustomDomainCustomHttps": "CDN", + "New-AzCdnDeliveryRuleRequestSchemeConditionObject": "CDN", + "New-AzFrontDoorCdnRoute": "CDN", + "Get-AzFrontDoorCdnOriginGroupResourceUsage": "CDN", + "Get-AzFrontDoorCdnRuleSet": "CDN", + "Update-AzFrontDoorCdnOriginGroup": "CDN", + "Get-AzCdnEdgeNode": "CDN", + "New-AzCdnDeliveryRuleUrlFileNameConditionObject": "CDN", + "New-AzFrontDoorCdnProfileChangeSkuWafMappingObject": "CDN", + "Remove-AzFrontDoorCdnRuleSet": "CDN", + "Clear-AzCdnEndpointContent": "CDN", + "Remove-AzFrontDoorCdnSecret": "CDN", + "Remove-AzFrontDoorCdnOriginGroup": "CDN", + "Remove-AzFrontDoorCdnOrigin": "CDN", + "New-AzCdnDeliveryRuleObject": "CDN", + "Test-AzFrontDoorCdnProfileMigration": "CDN", + "Get-AzFrontDoorCdnRoute": "CDN", + "New-AzCdnDeliveryRuleRequestMethodConditionObject": "CDN", + "New-AzFrontDoorCdnEndpoint": "CDN", + "Clear-AzFrontDoorCdnEndpointContent": "CDN", + "Test-AzCdnEndpointCustomDomain": "CDN", + "New-AzFrontDoorCdnRuleRequestHeaderActionObject": "CDN", + "Update-AzFrontDoorCdnOrigin": "CDN", + "New-AzCdnProfile": "CDN", + "New-AzFrontDoorCdnRuleUrlSigningActionObject": "CDN", + "New-AzFrontDoorCdnOrigin": "CDN", + "New-AzFrontDoorCdnOriginGroup": "CDN", + "New-AzCdnDeliveryRuleCacheExpirationActionObject": "CDN", + "New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject": "CDN", + "Remove-AzCognitiveServicesAccountDeployment": "Cognitive Services", + "Get-AzCognitiveServicesModel": "Cognitive Services", + "Remove-AzCognitiveServicesAccountCommitmentPlan": "Cognitive Services", + "Undo-AzCognitiveServicesAccountRemoval": "Cognitive Services", + "New-AzCognitiveServicesAccountCommitmentPlan": "Cognitive Services", + "Get-AzCognitiveServicesCommitmentPlanAssociation": "Cognitive Services", + "Remove-AzCognitiveServicesAccountNetworkRule": "Cognitive Services", + "New-AzCognitiveServicesAccountDeployment": "Cognitive Services", + "Get-AzCognitiveServicesCommitmentTier": "Cognitive Services", + "New-AzCognitiveServicesCommitmentPlan": "Cognitive Services", + "New-AzCognitiveServicesObject": "Cognitive Services", + "Get-AzCognitiveServicesAccountNetworkRuleSet": "Cognitive Services", + "Get-AzCognitiveServicesAccountSku": "Cognitive Services", + "Get-AzCognitiveServicesAccountKey": "Cognitive Services", + "Get-AzCognitiveServicesAccountModel": "Cognitive Services", + "Remove-AzCognitiveServicesAccount": "Cognitive Services", + "Update-AzCognitiveServicesAccountNetworkRuleSet": "Cognitive Services", + "Add-AzCognitiveServicesAccountNetworkRule": "Cognitive Services", + "Get-AzCognitiveServicesCommitmentPlan": "Cognitive Services", + "New-AzCognitiveServicesAccount": "Cognitive Services", + "New-AzCognitiveServicesCommitmentPlanAssociation": "Cognitive Services", + "Remove-AzCognitiveServicesCommitmentPlan": "Cognitive Services", + "New-AzCognitiveServicesAccountKey": "Cognitive Services", + "Get-AzCognitiveServicesAccountDeployment": "Cognitive Services", + "Get-AzCognitiveServicesAccount": "Cognitive Services", + "Get-AzCognitiveServicesUsage": "Cognitive Services", + "Remove-AzCognitiveServicesCommitmentPlanAssociation": "Cognitive Services", + "Get-AzCognitiveServicesAccountCommitmentPlan": "Cognitive Services", + "Get-AzCognitiveServicesAccountUsage": "Cognitive Services", + "New-AzCognitiveServicesAccountApiProperty": "Cognitive Services", + "Get-AzCognitiveServicesAccountType": "Cognitive Services", + "Set-AzCognitiveServicesAccount": "Cognitive Services", + "Update-AzMlCommitmentPlan": "ML Studio (Classic)", + "New-AzMlCommitmentPlan": "ML Studio (Classic)", + "Get-AzMlCommitmentPlanUsageHistory": "ML Studio (Classic)", + "Remove-AzMlCommitmentPlan": "ML Studio (Classic)", + "Get-AzMlWebService": "ML Studio (Classic)", + "New-AzMlWebService": "ML Studio (Classic)", + "Remove-AzMlWebService": "ML Studio (Classic)", + "Update-AzMlWebService": "ML Studio (Classic)", + "Import-AzMlWebService": "ML Studio (Classic)", + "Get-AzMlCommitmentAssociation": "ML Studio (Classic)", + "Get-AzMlCommitmentPlan": "ML Studio (Classic)", + "Export-AzMlWebService": "ML Studio (Classic)", + "Move-AzMlCommitmentAssociation": "ML Studio (Classic)", + "Get-AzMlWebServiceKey": "ML Studio (Classic)", + "Add-AzMlWebServiceRegionalProperty": "ML Studio (Classic)", + "Get-AzBlueprintArtifact": "Blueprint", + "Remove-AzBlueprintAssignment": "Blueprint", + "Import-AzBlueprintWithArtifact": "Blueprint", + "Export-AzBlueprintWithArtifact": "Blueprint", + "New-AzBlueprintAssignment": "Blueprint", + "Set-AzBlueprint": "Blueprint", + "New-AzBlueprintArtifact": "Blueprint", + "Set-AzBlueprintAssignment": "Blueprint", + "Get-AzBlueprintAssignment": "Blueprint", + "Set-AzBlueprintArtifact": "Blueprint", + "Get-AzBlueprint": "Blueprint", + "Publish-AzBlueprint": "Blueprint", + "New-AzBlueprint": "Blueprint", + "New-AzCostManagementExport": "Cost Management", + "Invoke-AzCostManagementExecuteExport": "Cost Management", + "New-AzCostManagementDetailReport": "Cost Management", + "Invoke-AzCostManagementReservationDetailReport": "Cost Management", + "Get-AzCostManagementExport": "Cost Management", + "Get-AzCostManagementExportExecutionHistory": "Cost Management", + "Invoke-AzCostManagementQuery": "Cost Management", + "Update-AzCostManagementExport": "Cost Management", + "New-AzCostManagementQueryFilterObject": "Cost Management", + "New-AzCostManagementQueryComparisonExpressionObject": "Cost Management", + "Remove-AzCostManagementExport": "Cost Management", + "Test-AzSynapseSqlPool": "Synapse Analytics", + "Get-AzSynapseKustoPoolDatabasePrincipalAssignment": "Synapse Analytics", + "Get-AzSynapseKustoPoolLanguageExtension": "Synapse Analytics", + "Set-AzSynapseSqlScript": "Synapse Analytics", + "Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline": "Synapse Analytics", + "New-AzSynapseKqlScript": "Synapse Analytics", + "Set-AzSynapseSqlPoolTransparentDataEncryption": "Synapse Analytics", + "Set-AzSynapseLinkConnectionLinkTable": "Synapse Analytics", + "Invoke-AzSynapsePipeline": "Synapse Analytics", + "Update-AzSynapseKustoPoolDataConnection": "Synapse Analytics", + "Set-AzSynapseSqlPoolAuditSetting": "Synapse Analytics", + "Set-AzSynapseDataset": "Synapse Analytics", + "Start-AzSynapseKustoPool": "Synapse Analytics", + "Remove-AzSynapseSqlPoolSensitivityClassification": "Synapse Analytics", + "Stop-AzSynapseSparkStatement": "Synapse Analytics", + "Reset-AzSynapseSqlPoolAuditSetting": "Synapse Analytics", + "Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord": "Synapse Analytics", + "Remove-AzSynapseSparkConfiguration": "Synapse Analytics", + "Update-AzSynapseSqlPool": "Synapse Analytics", + "Set-AzSynapseIntegrationRuntime": "Synapse Analytics", + "New-AzSynapseManagedVirtualNetworkConfig": "Synapse Analytics", + "New-AzSynapseKustoPoolPrincipalAssignment": "Synapse Analytics", + "Get-AzSynapseSqlPoolSensitivityClassification": "Synapse Analytics", + "Get-AzSynapsePipelineRun": "Synapse Analytics", + "Get-AzSynapseWorkspacePackage": "Synapse Analytics", + "Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan": "Synapse Analytics", + "Get-AzSynapseIntegrationRuntimeNode": "Synapse Analytics", + "Get-AzSynapseKustoPoolAttachedDatabaseConfiguration": "Synapse Analytics", + "Get-AzSynapseIntegrationRuntimeMetric": "Synapse Analytics", + "Remove-AzSynapseKustoPoolDatabase": "Synapse Analytics", + "Get-AzSynapseSqlAuditSetting": "Synapse Analytics", + "Get-AzSynapseSqlAdvancedDataSecurityPolicy": "Synapse Analytics", + "Get-AzSynapseSqlPoolTransparentDataEncryption": "Synapse Analytics", + "Export-AzSynapseKqlScript": "Synapse Analytics", + "Stop-AzSynapseLinkConnection": "Synapse Analytics", + "Stop-AzSynapseSparkJob": "Synapse Analytics", + "Get-AzSynapseSqlPoolGeoBackup": "Synapse Analytics", + "Remove-AzSynapseManagedPrivateEndpoint": "Synapse Analytics", + "Update-AzSynapseManagedVirtualNetworkConfig": "Synapse Analytics", + "Get-AzSynapseKustoPoolFollowerDatabase": "Synapse Analytics", + "Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration": "Synapse Analytics", + "New-AzSynapseIntegrationRuntimeKey": "Synapse Analytics", + "Submit-AzSynapseSparkJob": "Synapse Analytics", + "New-AzSynapseManagedPrivateEndpoint": "Synapse Analytics", + "New-AzSynapseRoleAssignment": "Synapse Analytics", + "Update-AzSynapseIntegrationRuntimeNode": "Synapse Analytics", + "Disable-AzSynapseSqlPoolSensitivityRecommendation": "Synapse Analytics", + "Get-AzSynapseTrigger": "Synapse Analytics", + "Get-AzSynapseKustoPoolDataConnection": "Synapse Analytics", + "Enable-AzSynapseSqlPoolSensitivityRecommendation": "Synapse Analytics", + "Get-AzSynapseActivityRun": "Synapse Analytics", + "Get-AzSynapsePipeline": "Synapse Analytics", + "Get-AzSynapseSqlAdvancedThreatProtectionSetting": "Synapse Analytics", + "Get-AzSynapseSparkSession": "Synapse Analytics", + "New-AzSynapseGitRepositoryConfig": "Synapse Analytics", + "New-AzSynapseKustoPoolDataConnection": "Synapse Analytics", + "Get-AzSynapseLinkConnectionLinkTable": "Synapse Analytics", + "Get-AzSynapseKustoPoolDatabase": "Synapse Analytics", + "Get-AzSynapseSqlPoolAuditSetting": "Synapse Analytics", + "Set-AzSynapseNotebook": "Synapse Analytics", + "Remove-AzSynapseKustoPoolDataConnection": "Synapse Analytics", + "Set-AzSynapseSqlActiveDirectoryAdministrator": "Synapse Analytics", + "Get-AzSynapseNotebook": "Synapse Analytics", + "New-AzSynapseKustoPoolDatabase": "Synapse Analytics", + "Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting": "Synapse Analytics", + "Get-AzSynapseSparkJobDefinition": "Synapse Analytics", + "Update-AzSynapseKustoPoolDatabase": "Synapse Analytics", + "Remove-AzSynapseRoleAssignment": "Synapse Analytics", + "Set-AzSynapsePipeline": "Synapse Analytics", + "Get-AzSynapseKustoPool": "Synapse Analytics", + "Get-AzSynapseIntegrationRuntimeKey": "Synapse Analytics", + "Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline": "Synapse Analytics", + "Get-AzSynapseLinkConnectionLinkTableStatus": "Synapse Analytics", + "Get-AzSynapseRoleAssignment": "Synapse Analytics", + "New-AzSynapseFirewallRule": "Synapse Analytics", + "Reset-AzSynapseSqlAuditSetting": "Synapse Analytics", + "Set-AzSynapseSqlPoolSensitivityClassification": "Synapse Analytics", + "Set-AzSynapseLinkedService": "Synapse Analytics", + "Get-AzSynapseSparkPool": "Synapse Analytics", + "Stop-AzSynapseIntegrationRuntime": "Synapse Analytics", + "Remove-AzSynapseWorkspaceKey": "Synapse Analytics", + "Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting": "Synapse Analytics", + "Reset-AzSynapseSqlAdvancedThreatProtectionSetting": "Synapse Analytics", + "Start-AzSynapseDataFlowDebugSession": "Synapse Analytics", + "Get-AzSynapseSqlActiveDirectoryAdministrator": "Synapse Analytics", + "Remove-AzSynapseSqlScript": "Synapse Analytics", + "Stop-AzSynapseKustoPool": "Synapse Analytics", + "New-AzSynapseKustoPoolDatabasePrincipalAssignment": "Synapse Analytics", + "Remove-AzSynapseSqlActiveDirectoryAdministrator": "Synapse Analytics", + "New-AzSynapseSqlDatabase": "Synapse Analytics", + "Enable-AzSynapseSqlAdvancedDataSecurity": "Synapse Analytics", + "Get-AzSynapseSparkJob": "Synapse Analytics", + "New-AzSynapseWorkspaceKey": "Synapse Analytics", + "New-AzSynapseSparkConfiguration": "Synapse Analytics", + "Remove-AzSynapseKustoPoolPrincipalAssignment": "Synapse Analytics", + "Resume-AzSynapseSqlPool": "Synapse Analytics", + "Test-AzSynapseWorkspace": "Synapse Analytics", + "Get-AzSynapseTriggerSubscriptionStatus": "Synapse Analytics", + "Get-AzSynapseFirewallRule": "Synapse Analytics", + "Set-AzSynapseSparkJobDefinition": "Synapse Analytics", + "Get-AzSynapseRoleScope": "Synapse Analytics", + "New-AzSynapseSparkPool": "Synapse Analytics", + "Remove-AzSynapseDataset": "Synapse Analytics", + "Wait-AzSynapseSparkJob": "Synapse Analytics", + "Update-AzSynapseKustoPool": "Synapse Analytics", + "Get-AzSynapseSqlPoolRestorePoint": "Synapse Analytics", + "Stop-AzSynapseTriggerRun": "Synapse Analytics", + "Get-AzSynapseTriggerRun": "Synapse Analytics", + "Start-AzSynapseLinkConnection": "Synapse Analytics", + "Start-AzSynapseTrigger": "Synapse Analytics", + "Invoke-AzSynapseTriggerRun": "Synapse Analytics", + "Get-AzSynapseSqlPoolSensitivityRecommendation": "Synapse Analytics", + "Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting": "Synapse Analytics", + "Remove-AzSynapseLinkedService": "Synapse Analytics", + "Start-AzSynapseSqlPoolVulnerabilityAssessmentScan": "Synapse Analytics", + "Get-AzSynapseIntegrationRuntime": "Synapse Analytics", + "Get-AzSynapseKustoPoolSku": "Synapse Analytics", + "Get-AzSynapseKqlScript": "Synapse Analytics", + "Get-AzSynapseKustoPoolPrincipalAssignment": "Synapse Analytics", + "Update-AzSynapseLinkConnectionLandingZoneCredential": "Synapse Analytics", + "Update-AzSynapseSqlVulnerabilityAssessmentSetting": "Synapse Analytics", + "Set-AzSynapseSqlAuditSetting": "Synapse Analytics", + "Remove-AzSynapseKqlScript": "Synapse Analytics", + "Get-AzSynapseLinkedService": "Synapse Analytics", + "Remove-AzSynapsePipeline": "Synapse Analytics", + "New-AzSynapseSqlPoolRestorePoint": "Synapse Analytics", + "Update-AzSynapseSparkPool": "Synapse Analytics", + "Remove-AzSynapseIntegrationRuntime": "Synapse Analytics", + "Get-AzSynapseRoleDefinition": "Synapse Analytics", + "Update-AzSynapseSqlAdvancedThreatProtectionSetting": "Synapse Analytics", + "Enable-AzSynapseWorkspace": "Synapse Analytics", + "Remove-AzSynapseTriggerSubscription": "Synapse Analytics", + "Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline": "Synapse Analytics", + "Remove-AzSynapseSparkJobDefinition": "Synapse Analytics", + "Reset-AzSynapseSparkSessionTimeout": "Synapse Analytics", + "Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting": "Synapse Analytics", + "Get-AzSynapseDataFlow": "Synapse Analytics", + "Remove-AzSynapseWorkspace": "Synapse Analytics", + "Get-AzSynapseManagedPrivateEndpoint": "Synapse Analytics", + "Get-AzSynapseSqlScript": "Synapse Analytics", + "New-AzSynapseWorkspace": "Synapse Analytics", + "Get-AzSynapseLinkConnectionDetailedStatus": "Synapse Analytics", + "Get-AzSynapseSqlDatabase": "Synapse Analytics", + "Add-AzSynapseDataFlowDebugSessionPackage": "Synapse Analytics", + "Get-AzSynapseDroppedSqlPool": "Synapse Analytics", + "Disable-AzSynapseActiveDirectoryOnlyAuthentication": "Synapse Analytics", + "New-AzSynapseKustoPoolAttachedDatabaseConfiguration": "Synapse Analytics", + "Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting": "Synapse Analytics", + "Remove-AzSynapseKustoPool": "Synapse Analytics", + "Invoke-AzSynapseIntegrationRuntimeUpgrade": "Synapse Analytics", + "Get-AzSynapseManagedIdentitySqlControlSetting": "Synapse Analytics", + "Remove-AzSynapseNotebook": "Synapse Analytics", + "Stop-AzSynapseDataFlowDebugSession": "Synapse Analytics", + "Get-AzSynapseWorkspaceKey": "Synapse Analytics", + "Restore-AzSynapseSqlPool": "Synapse Analytics", + "Get-AzSynapseWorkspace": "Synapse Analytics", + "New-AzSynapseSqlPool": "Synapse Analytics", + "New-AzSynapseLinkedServiceEncryptedCredential": "Synapse Analytics", + "Stop-AzSynapsePipelineRun": "Synapse Analytics", + "Start-AzSynapseIntegrationRuntime": "Synapse Analytics", + "Remove-AzSynapseTrigger": "Synapse Analytics", + "Reset-AzSynapseSqlVulnerabilityAssessmentSetting": "Synapse Analytics", + "Get-AzSynapseLinkConnection": "Synapse Analytics", + "Set-AzSynapseDataFlow": "Synapse Analytics", + "Remove-AzSynapseWorkspacePackage": "Synapse Analytics", + "Remove-AzSynapseKustoPoolDatabasePrincipalAssignment": "Synapse Analytics", + "Get-AzSynapseSparkConfiguration": "Synapse Analytics", + "Get-AzSynapseDataset": "Synapse Analytics", + "Sync-AzSynapseIntegrationRuntimeCredential": "Synapse Analytics", + "Remove-AzSynapseSqlPoolRestorePoint": "Synapse Analytics", + "Update-AzSynapseIntegrationRuntime": "Synapse Analytics", + "Add-AzSynapseKustoPoolLanguageExtension": "Synapse Analytics", + "Remove-AzSynapseSqlDatabase": "Synapse Analytics", + "Invoke-AzSynapseDataFlowDebugSessionCommand": "Synapse Analytics", + "Stop-AzSynapseSparkSession": "Synapse Analytics", + "Set-AzSynapseTrigger": "Synapse Analytics", + "Remove-AzSynapseFirewallRule": "Synapse Analytics", + "Disable-AzSynapseSqlAdvancedDataSecurity": "Synapse Analytics", + "Update-AzSynapseFirewallRule": "Synapse Analytics", + "Stop-AzSynapseTrigger": "Synapse Analytics", + "Test-AzSynapseSparkPool": "Synapse Analytics", + "Remove-AzSynapseLinkConnection": "Synapse Analytics", + "Remove-AzSynapseDataFlow": "Synapse Analytics", + "Enable-AzSynapseActiveDirectoryOnlyAuthentication": "Synapse Analytics", + "Start-AzSynapseSparkSession": "Synapse Analytics", + "Add-AzSynapseTriggerSubscription": "Synapse Analytics", + "Invoke-AzSynapseDetachKustoPoolFollowerDatabase": "Synapse Analytics", + "Suspend-AzSynapseSqlPool": "Synapse Analytics", + "Get-AzSynapseSqlVulnerabilityAssessmentSetting": "Synapse Analytics", + "Remove-AzSynapseIntegrationRuntimeNode": "Synapse Analytics", + "Set-AzSynapseLinkConnection": "Synapse Analytics", + "Export-AzSynapseNotebook": "Synapse Analytics", + "Test-AzSynapseSqlDatabase": "Synapse Analytics", + "Update-AzSynapseWorkspace": "Synapse Analytics", + "Set-AzSynapseManagedIdentitySqlControlSetting": "Synapse Analytics", + "Get-AzSynapseDataFlowDebugSession": "Synapse Analytics", + "Remove-AzSynapseSqlPool": "Synapse Analytics", + "Export-AzSynapseSparkConfiguration": "Synapse Analytics", + "Invoke-AzSynapseSparkStatement": "Synapse Analytics", + "Remove-AzSynapseKustoPoolLanguageExtension": "Synapse Analytics", + "Update-AzSynapseSqlDatabase": "Synapse Analytics", + "Export-AzSynapseSqlScript": "Synapse Analytics", + "Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting": "Synapse Analytics", + "New-AzSynapseWorkspacePackage": "Synapse Analytics", + "Get-AzSynapseSparkStatement": "Synapse Analytics", + "New-AzSynapseKustoPool": "Synapse Analytics", + "Remove-AzSynapseSparkPool": "Synapse Analytics", + "Get-AzSynapseSqlPool": "Synapse Analytics", + "Get-AzSynapseActiveDirectoryOnlyAuthentication": "Synapse Analytics", + "Get-AzFunctionAppPlan": "Functions", + "Remove-AzFunctionAppSetting": "Functions", + "Get-AzFunctionAppSetting": "Functions", + "Restart-AzFunctionApp": "Functions", + "Start-AzFunctionApp": "Functions", + "Remove-AzFunctionAppPlan": "Functions", + "New-AzFunctionAppPlan": "Functions", + "Update-AzFunctionApp": "Functions", + "Get-AzFunctionAppAvailableLocation": "Functions", + "Update-AzFunctionAppSetting": "Functions", + "Update-AzFunctionAppPlan": "Functions", + "New-AzFunctionApp": "Functions", + "Remove-AzFunctionApp": "Functions", + "Get-AzFunctionApp": "Functions", + "Stop-AzFunctionApp": "Functions", + "Remove-AzImportExport": "ImportExport", + "Get-AzImportExportLocation": "ImportExport", + "Get-AzImportExport": "ImportExport", + "New-AzImportExport": "ImportExport", + "Update-AzImportExport": "ImportExport", + "New-AzImportExportDriveListObject": "ImportExport", + "Get-AzImportExportBitLockerKey": "ImportExport", + "New-AzDataBoxDiskJobDetailsObject": "DataBox", + "New-AzDataBoxTransferConfigurationObject": "DataBox", + "New-AzDataBoxJob": "DataBox", + "Get-AzDataBoxJobCredential": "DataBox", + "New-AzDataBoxStorageAccountDetailsObject": "DataBox", + "New-AzDataBoxContactDetailsObject": "DataBox", + "Remove-AzDataBoxJob": "DataBox", + "New-AzDataBoxShippingAddressObject": "DataBox", + "New-AzDataBoxCustomerDiskJobDetailsObject": "DataBox", + "New-AzDataBoxHeavyJobDetailsObject": "DataBox", + "Stop-AzDataBoxJob": "DataBox", + "New-AzDataBoxManagedDiskDetailsObject": "DataBox", + "Get-AzDataBoxJob": "DataBox", + "New-AzDataBoxKeyEncryptionKeyObject": "DataBox", + "New-AzDataBoxJobDetailsObject": "DataBox", + "Update-AzDataBoxJob": "DataBox", + "Set-AzHpcCache": "HPCCache", + "Get-AzHpcCache": "HPCCache", + "New-AzHpcCacheStorageTarget": "HPCCache", + "Remove-AzHpcCacheStorageTarget": "HPCCache", + "Stop-AzHpcCache": "HPCCache", + "Set-AzHpcCacheStorageTarget": "HPCCache", + "New-AzHpcCache": "HPCCache", + "Get-AzHpcCacheStorageTarget": "HPCCache", + "Get-AzHpcCacheUsageModel": "HPCCache", + "Remove-AzHpcCache": "HPCCache", + "Start-AzHpcCache": "HPCCache", + "Update-AzHpcCache": "HPCCache", + "Get-AzHpcCacheSku": "HPCCache", + "Set-AzBatchAccount": "Batch", + "Enable-AzBatchAutoScale": "Batch", + "Get-AzBatchNodeFileContent": "Batch", + "Enable-AzBatchTask": "Batch", + "Get-AzBatchTask": "Batch", + "Set-AzBatchJob": "Batch", + "Start-AzBatchPoolResize": "Batch", + "Stop-AzBatchJob": "Batch", + "Start-AzBatchComputeNodeServiceLogUpload": "Batch", + "Remove-AzBatchComputeNode": "Batch", + "New-AzBatchAccount": "Batch", + "Set-AzBatchApplication": "Batch", + "Remove-AzBatchJobSchedule": "Batch", + "New-AzBatchComputeNodeUser": "Batch", + "New-AzBatchPool": "Batch", + "Get-AzBatchComputeNodeExtension": "Batch", + "Remove-AzBatchAccount": "Batch", + "New-AzBatchApplicationPackage": "Batch", + "Get-AzBatchTaskCount": "Batch", + "Get-AzBatchJobStatistic": "Batch", + "Get-AzBatchJob": "Batch", + "Get-AzBatchSupportedImage": "Batch", + "Get-AzBatchPoolNodeCount": "Batch", + "Remove-AzBatchPool": "Batch", + "Get-AzBatchLocationQuota": "Batch", + "New-AzBatchTask": "Batch", + "Get-AzBatchAccountKey": "Batch", + "Get-AzBatchRemoteDesktopProtocolFile": "Batch", + "Set-AzBatchComputeNodeUser": "Batch", + "Stop-AzBatchTask": "Batch", + "Disable-AzBatchComputeNodeScheduling": "Batch", + "Restart-AzBatchComputeNode": "Batch", + "Enable-AzBatchComputeNodeScheduling": "Batch", + "Set-AzBatchTask": "Batch", + "Stop-AzBatchJobSchedule": "Batch", + "Stop-AzBatchPoolResize": "Batch", + "Get-AzBatchSubtask": "Batch", + "Disable-AzBatchAutoScale": "Batch", + "Get-AzBatchPoolUsageMetric": "Batch", + "Get-AzBatchPool": "Batch", + "Get-AzBatchSupportedVirtualMachineSku": "Batch", + "Remove-AzBatchTask": "Batch", + "Get-AzBatchTaskSlotCount": "Batch", + "Get-AzBatchComputeNode": "Batch", + "Disable-AzBatchJob": "Batch", + "Remove-AzBatchNodeFile": "Batch", + "Get-AzBatchAccount": "Batch", + "New-AzBatchJobSchedule": "Batch", + "Remove-AzBatchComputeNodeUser": "Batch", + "Get-AzBatchPoolStatistic": "Batch", + "Remove-AzBatchCertificate": "Batch", + "Get-AzBatchApplicationPackage": "Batch", + "Get-AzBatchJobSchedule": "Batch", + "New-AzBatchResourceFile": "Batch", + "New-AzBatchAccountKey": "Batch", + "New-AzBatchCertificate": "Batch", + "Remove-AzBatchJob": "Batch", + "Reset-AzBatchComputeNode": "Batch", + "Get-AzBatchJobPreparationAndReleaseTaskStatus": "Batch", + "Remove-AzBatchApplicationPackage": "Batch", + "Enable-AzBatchJobSchedule": "Batch", + "Set-AzBatchJobSchedule": "Batch", + "New-AzBatchJob": "Batch", + "Test-AzBatchAutoScale": "Batch", + "New-AzBatchApplication": "Batch", + "Stop-AzBatchCertificateDeletion": "Batch", + "Enable-AzBatchJob": "Batch", + "Set-AzBatchPool": "Batch", + "Get-AzBatchNodeFile": "Batch", + "Get-AzBatchApplication": "Batch", + "Remove-AzBatchApplication": "Batch", + "Get-AzBatchCertificate": "Batch", + "Disable-AzBatchJobSchedule": "Batch", + "Get-AzBatchRemoteLoginSetting": "Batch", + "Get-AzArcResourceBridgeTelemetryConfig": "ArcResourceBridge", + "Remove-AzArcResourceBridge": "ArcResourceBridge", + "Get-AzArcResourceBridgeApplianceCredential": "ArcResourceBridge", + "Get-AzArcResourceBridgeCredential": "ArcResourceBridge", + "Update-AzArcResourceBridge": "ArcResourceBridge", + "Get-AzArcResourceBridge": "ArcResourceBridge", + "Get-AzArcResourceBridgeUpgradeGraph": "ArcResourceBridge", + "New-AzArcResourceBridge": "ArcResourceBridge", + "New-AzConnectedNetworkVendorSkuPreview": "ConnectedNetwork", + "Get-AzConnectedNetworkVendorFunctionRoleInstance": "ConnectedNetwork", + "Get-AzConnectedNetworkVendorSku": "ConnectedNetwork", + "Get-AzConnectedNetworkVendorFunction": "ConnectedNetwork", + "New-AzConnectedNetworkFunction": "ConnectedNetwork", + "Remove-AzConnectedNetworkVendorSkuPreview": "ConnectedNetwork", + "New-AzConnectedNetworkFunctionUserConfigurationObject": "ConnectedNetwork", + "Restart-AzConnectedNetworkVendorFunctionRoleInstance": "ConnectedNetwork", + "New-AzConnectedNetworkInterfaceObject": "ConnectedNetwork", + "Get-AzConnectedNetworkDevice": "ConnectedNetwork", + "Get-AzConnectedNetworkVendorSkuPreview": "ConnectedNetwork", + "New-AzConnectedNetworkAzureStackEdgeObject": "ConnectedNetwork", + "Get-AzConnectedNetworkFunctionVendor": "ConnectedNetwork", + "New-AzConnectedNetworkInterfaceIPConfigurationObject": "ConnectedNetwork", + "New-AzConnectedNetworkVendorFunction": "ConnectedNetwork", + "Get-AzConnectedNetworkFunction": "ConnectedNetwork", + "Remove-AzConnectedNetworkVendor": "ConnectedNetwork", + "Remove-AzConnectedNetworkDevice": "ConnectedNetwork", + "Start-AzConnectedNetworkVendorFunctionRoleInstance": "ConnectedNetwork", + "New-AzConnectedNetworkFunctionVendorConfigurationObject": "ConnectedNetwork", + "Get-AzConnectedNetworkDeviceRegistrationKey": "ConnectedNetwork", + "Get-AzConnectedNetworkVendor": "ConnectedNetwork", + "New-AzConnectedNetworkVendor": "ConnectedNetwork", + "New-AzConnectedNetworkDevice": "ConnectedNetwork", + "New-AzConnectedNetworkFunctionRoleConfigurationObject": "ConnectedNetwork", + "Update-AzConnectedNetworkDeviceTag": "ConnectedNetwork", + "Update-AzConnectedNetworkFunctionTag": "ConnectedNetwork", + "Remove-AzConnectedNetworkFunction": "ConnectedNetwork", + "Remove-AzConnectedNetworkVendorSku": "ConnectedNetwork", + "New-AzConnectedNetworkVendorSku": "ConnectedNetwork", + "Stop-AzConnectedNetworkVendorFunctionRoleInstance": "ConnectedNetwork", + "New-AzPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", + "Reset-AzPowerBIWorkspaceCollectionAccessKey": "Power BI Workspace Collections", + "Get-AzPowerBIWorkspace": "Power BI Workspace Collections", + "Remove-AzPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", + "Suspend-AzPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", + "Get-AzPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", + "Get-AzPowerBIWorkspaceCollectionAccessKey": "Power BI Workspace Collections", + "New-AzPowerBIWorkspaceCollection": "Power BI Workspace Collections", + "Get-AzPowerBIWorkspaceCollection": "Power BI Workspace Collections", + "Update-AzPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", + "Test-AzPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", + "Remove-AzPowerBIWorkspaceCollection": "Power BI Workspace Collections", + "Resume-AzPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", + "Enable-AzAdvisorRecommendation": "Advisor", + "Set-AzAdvisorConfiguration": "Advisor", + "Get-AzAdvisorConfiguration": "Advisor", + "Get-AzAdvisorRecommendation": "Advisor", + "Disable-AzAdvisorRecommendation": "Advisor", + "New-AzDataLakeAnalyticsCatalogCredential": "Data Lake Analytics", + "Add-AzDataLakeAnalyticsFirewallRule": "Data Lake Analytics", + "Get-AzDataLakeAnalyticsComputePolicy": "Data Lake Analytics", + "Get-AzDataLakeAnalyticsJob": "Data Lake Analytics", + "Get-AzDataLakeAnalyticsFirewallRule": "Data Lake Analytics", + "Get-AzDataLakeAnalyticsJobRecurrence": "Data Lake Analytics", + "Set-AzDataLakeAnalyticsDataSource": "Data Lake Analytics", + "Get-AzDataLakeAnalyticsCatalogItemAclEntry": "Data Lake Analytics", + "Get-AzDataLakeAnalyticsAccount": "Data Lake Analytics", + "Set-AzDataLakeAnalyticsCatalogItemAclEntry": "Data Lake Analytics", + "Add-AzDataLakeAnalyticsDataSource": "Data Lake Analytics", + "New-AzDataLakeAnalyticsComputePolicy": "Data Lake Analytics", + "Test-AzDataLakeAnalyticsCatalogItem": "Data Lake Analytics", + "Set-AzDataLakeAnalyticsFirewallRule": "Data Lake Analytics", + "Get-AzDataLakeAnalyticsCatalogItem": "Data Lake Analytics", + "Set-AzDataLakeAnalyticsCatalogCredential": "Data Lake Analytics", + "Remove-AzDataLakeAnalyticsFirewallRule": "Data Lake Analytics", + "Remove-AzDataLakeAnalyticsDataSource": "Data Lake Analytics", + "Wait-AzDataLakeAnalyticsJob": "Data Lake Analytics", + "New-AzDataLakeAnalyticsAccount": "Data Lake Analytics", + "Stop-AzDataLakeAnalyticsJob": "Data Lake Analytics", + "Get-AzDataLakeAnalyticsDataSource": "Data Lake Analytics", + "Remove-AzDataLakeAnalyticsCatalogItemAclEntry": "Data Lake Analytics", + "Get-AzDataLakeAnalyticsJobPipeline": "Data Lake Analytics", + "Submit-AzDataLakeAnalyticsJob": "Data Lake Analytics", + "Remove-AzDataLakeAnalyticsAccount": "Data Lake Analytics", + "Test-AzDataLakeAnalyticsAccount": "Data Lake Analytics", + "Remove-AzDataLakeAnalyticsCatalogCredential": "Data Lake Analytics", + "Remove-AzDataLakeAnalyticsComputePolicy": "Data Lake Analytics", + "Update-AzDataLakeAnalyticsComputePolicy": "Data Lake Analytics", + "Set-AzDataLakeAnalyticsAccount": "Data Lake Analytics", + "New-AzNotificationHub": "Notification Hubs", + "Remove-AzNotificationHub": "Notification Hubs", + "Remove-AzNotificationHubsNamespace": "Notification Hubs", + "Get-AzNotificationHubsNamespace": "Notification Hubs", + "Set-AzNotificationHubsNamespaceAuthorizationRule": "Notification Hubs", + "Set-AzNotificationHubsNamespace": "Notification Hubs", + "Get-AzNotificationHubPNSCredential": "Notification Hubs", + "Get-AzNotificationHub": "Notification Hubs", + "Get-AzNotificationHubListKey": "Notification Hubs", + "Set-AzNotificationHub": "Notification Hubs", + "Get-AzNotificationHubsNamespaceAuthorizationRule": "Notification Hubs", + "New-AzNotificationHubKey": "Notification Hubs", + "New-AzNotificationHubsNamespace": "Notification Hubs", + "Get-AzNotificationHubAuthorizationRule": "Notification Hubs", + "New-AzNotificationHubsNamespaceKey": "Notification Hubs", + "Remove-AzNotificationHubAuthorizationRule": "Notification Hubs", + "Remove-AzNotificationHubsNamespaceAuthorizationRule": "Notification Hubs", + "New-AzNotificationHubAuthorizationRule": "Notification Hubs", + "New-AzNotificationHubsNamespaceAuthorizationRule": "Notification Hubs", + "Get-AzNotificationHubsNamespaceListKey": "Notification Hubs", + "Set-AzNotificationHubAuthorizationRule": "Notification Hubs", + "Get-AzAksManagedClusterCommandResult": "Kubernetes Service", + "Remove-AzAksCluster": "Kubernetes Service", + "Remove-AzAksMaintenanceConfiguration": "Kubernetes Service", + "Get-AzAksManagedClusterOSOption": "Kubernetes Service", + "Start-AzAksCluster": "Kubernetes Service", + "Start-AzAksDashboard": "Kubernetes Service", + "Remove-AzAksNodePool": "Kubernetes Service", + "New-AzAksSnapshot": "Kubernetes Service", + "Import-AzAksCredential": "Kubernetes Service", + "Stop-AzAksDashboard": "Kubernetes Service", + "Get-AzAksUpgradeProfile": "Kubernetes Service", + "Get-AzAksMaintenanceConfiguration": "Kubernetes Service", + "New-AzAksTimeInWeekObject": "Kubernetes Service", + "Start-AzAksManagedClusterCommand": "Kubernetes Service", + "Invoke-AzAksAbortManagedClusterLatestOperation": "Kubernetes Service", + "Get-AzAksSnapshot": "Kubernetes Service", + "Set-AzAksClusterCredential": "Kubernetes Service", + "New-AzAksCluster": "Kubernetes Service", + "Disable-AzAksAddOn": "Kubernetes Service", + "New-AzAksNodePool": "Kubernetes Service", + "New-AzAksTimeSpanObject": "Kubernetes Service", + "Get-AzAksCluster": "Kubernetes Service", + "Invoke-AzAksAbortAgentPoolLatestOperation": "Kubernetes Service", + "Remove-AzAksSnapshot": "Kubernetes Service", + "Get-AzAksNodePoolUpgradeProfile": "Kubernetes Service", + "Stop-AzAksCluster": "Kubernetes Service", + "New-AzAksMaintenanceConfiguration": "Kubernetes Service", + "Invoke-AzAksRunCommand": "Kubernetes Service", + "Install-AzAksCliTool": "Kubernetes Service", + "Get-AzAksVersion": "Kubernetes Service", + "Enable-AzAksAddOn": "Kubernetes Service", + "Update-AzAksNodePool": "Kubernetes Service", + "Invoke-AzAksRotateManagedClusterServiceAccountSigningKey": "Kubernetes Service", + "Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint": "Kubernetes Service", + "Get-AzAksNodePool": "Kubernetes Service", + "Set-AzAksCluster": "Kubernetes Service", + "Get-AzDigitalTwinsPrivateLinkResource": "Digital Twins", + "Remove-AzDigitalTwinsInstance": "Digital Twins", + "Remove-AzDigitalTwinsEndpoint": "Digital Twins", + "New-AzDigitalTwinsTimeSeriesDatabaseConnection": "Digital Twins", + "Update-AzDigitalTwinsInstance": "Digital Twins", + "New-AzDigitalTwinsEndpoint": "Digital Twins", + "New-AzDigitalTwinsInstance": "Digital Twins", + "Test-AzDigitalTwinsInstanceNameAvailability": "Digital Twins", + "Get-AzDigitalTwinsInstance": "Digital Twins", + "Get-AzDigitalTwinsPrivateEndpointConnection": "Digital Twins", + "Remove-AzDigitalTwinsTimeSeriesDatabaseConnection": "Digital Twins", + "Get-AzDigitalTwinsTimeSeriesDatabaseConnection": "Digital Twins", + "Remove-AzDigitalTwinsPrivateEndpointConnection": "Digital Twins", + "New-AzDigitalTwinsPrivateEndpointConnection": "Digital Twins", + "Get-AzDigitalTwinsEndpoint": "Digital Twins", + "New-AzConfidentialLedgerCertBasedSecurityPrincipalObject": "Confidential Ledger", + "Get-AzConfidentialLedger": "Confidential Ledger", + "New-AzConfidentialLedgerAADBasedSecurityPrincipalObject": "Confidential Ledger", + "Test-AzConfidentialLedgerNameAvailability": "Confidential Ledger", + "Remove-AzConfidentialLedger": "Confidential Ledger", + "New-AzConfidentialLedger": "Confidential Ledger", + "Update-AzConfidentialLedger": "Confidential Ledger", + "Update-AzVMwareCluster": "VMware", + "New-AzVMwarePlacementPolicy": "VMware", + "Get-AzVMwareCloudLink": "VMware", + "Remove-AzVMwareDatastore": "VMware", + "New-AzVMwareAddon": "VMware", + "Remove-AzVMwarePlacementPolicy": "VMware", + "Remove-AzVMwareGlobalReachConnection": "VMware", + "Get-AzVMwarePrivateCloud": "VMware", + "New-AzVMwareScriptStringExecutionParameterObject": "VMware", + "Get-AzVMwareCluster": "VMware", + "New-AzVMwarePSCredentialExecutionParameterObject": "VMware", + "Get-AzVMwareAddon": "VMware", + "New-AzVMwarePrivateCloudNsxtPassword": "VMware", + "New-AzVMwarePrivateCloudVcenterPassword": "VMware", + "New-AzVMwareCluster": "VMware", + "Update-AzVMwarePrivateCloud": "VMware", + "Get-AzVMwarePlacementPolicy": "VMware", + "Get-AzVMwareDatastore": "VMware", + "Test-AzVMwareLocationTrialAvailability": "VMware", + "New-AzVMwareGlobalReachConnection": "VMware", + "New-AzVMwareCloudLink": "VMware", + "Get-AzVMwareGlobalReachConnection": "VMware", + "New-AzVMwareAddonVrPropertiesObject": "VMware", + "Get-AzVMwarePrivateCloudAdminCredential": "VMware", + "Remove-AzVMwarePrivateCloud": "VMware", + "New-AzVMwarePrivateCloud": "VMware", + "New-AzVMwareVMPlacementPolicyPropertiesObject": "VMware", + "Get-AzVMwareAuthorization": "VMware", + "New-AzVMwareScriptSecureStringExecutionParameterObject": "VMware", + "New-AzVMwareAddonSrmPropertiesObject": "VMware", + "Remove-AzVMwareCloudLink": "VMware", + "Remove-AzVMwareCluster": "VMware", + "New-AzVMwareVmHostPlacementPolicyPropertiesObject": "VMware", + "New-AzVMwareAuthorization": "VMware", + "Remove-AzVMwareAddon": "VMware", + "New-AzVMwareDatastore": "VMware", + "Update-AzVMwarePlacementPolicy": "VMware", + "Remove-AzVMwareAuthorization": "VMware", + "Get-AzVMwareVirtualMachine": "VMware", + "Test-AzVMwareLocationQuotaAvailability": "VMware" +} \ No newline at end of file diff --git a/mapping/monikerMapping.json b/mapping/monikerMapping.json index d8954ac697..b115e36b2c 100644 --- a/mapping/monikerMapping.json +++ b/mapping/monikerMapping.json @@ -1,4 +1,11 @@ { + "azps-10.1.0": { + "conceptualToc": "docs-conceptual/azps-10.1.0/toc.yml", + "conceptualTocUrl": "/powershell/azure/toc.json", + "packageRoot": "azps-10.1.0", + "referenceTocUrl": "/powershell/module/azure-powershell/toc.json", + "serviceMap": "mapping/az-groupMapping-10.1.0.json" + }, "azps-10.0.0": { "conceptualToc": "docs-conceptual/azps-10.0.0/toc.yml", "conceptualTocUrl": "/powershell/azure/toc.json",